2 * Copyright (c) 2015-2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/vnet.h>
17 #include <vnet/session/application.h>
18 #include <vnet/session/application_interface.h>
23 } http_process_event_t;
35 svm_queue_t **vpp_queue;
38 uword *handler_by_get_request;
40 u32 *free_http_cli_process_node_indices;
42 /* Sever's event queue */
43 svm_queue_t *vl_input_queue;
45 /* API client handle */
50 /* process node index for evnt scheduling */
54 u32 private_segment_size;
56 vlib_main_t *vlib_main;
59 http_server_main_t http_server_main;
62 free_http_process (http_server_args * args)
64 vlib_node_runtime_t *rt;
65 vlib_main_t *vm = &vlib_global_main;
66 http_server_main_t *hsm = &http_server_main;
69 http_server_args **save_args;
71 node_index = args->node_index;
72 ASSERT (node_index != 0);
74 n = vlib_get_node (vm, node_index);
75 rt = vlib_node_get_runtime (vm, n->index);
76 save_args = vlib_node_get_runtime_data (vm, n->index);
78 /* Reset process session pointer */
79 clib_mem_free (*save_args);
82 /* Turn off the process node */
83 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
85 /* add node index to the freelist */
86 vec_add1 (hsm->free_http_cli_process_node_indices, node_index);
90 *http_response = "HTTP/1.1 200 OK\r\n"
91 "Content-Type: text/html\r\n"
92 "Expires: Mon, 11 Jan 1970 10:10:10 GMT\r\n"
93 "Connection: close\r\n"
94 "Pragma: no-cache\r\n" "Content-Length: %d\r\n\r\n%s";
97 *http_error_template = "HTTP/1.1 %s\r\n"
98 "Content-Type: text/html\r\n"
99 "Expires: Mon, 11 Jan 1970 10:10:10 GMT\r\n"
100 "Connection: close\r\n" "Pragma: no-cache\r\n" "Content-Length: 0\r\n\r\n";
102 /* Header, including incantation to suppress favicon.ico requests */
104 *html_header_template = "<html><head><title>%v</title>"
105 "</head><link rel=\"icon\" href=\"data:,\"><body><pre>";
107 static const char *html_footer = "</pre></body></html>\r\n";
110 *html_header_static = "<html><head><title>static reply</title></head>"
111 "<link rel=\"icon\" href=\"data:,\"><body><pre>hello</pre></body>"
114 static u8 *static_http;
117 http_cli_output (uword arg, u8 * buffer, uword buffer_bytes)
119 u8 **output_vecp = (u8 **) arg;
123 output_vec = *output_vecp;
125 offset = vec_len (output_vec);
126 vec_validate (output_vec, offset + buffer_bytes - 1);
127 clib_memcpy (output_vec + offset, buffer, buffer_bytes);
129 *output_vecp = output_vec;
133 send_data (stream_session_t * s, u8 * data)
135 session_fifo_event_t evt;
136 u32 offset, bytes_to_send;
138 http_server_main_t *hsm = &http_server_main;
139 vlib_main_t *vm = hsm->vlib_main;
140 f64 last_sent_timer = vlib_time_now (vm);
142 bytes_to_send = vec_len (data);
145 while (bytes_to_send > 0)
149 actual_transfer = svm_fifo_enqueue_nowait
150 (s->server_tx_fifo, bytes_to_send, data + offset);
152 /* Made any progress? */
153 if (actual_transfer <= 0)
155 vlib_process_suspend (vm, delay);
156 /* 10s deadman timer */
157 if (vlib_time_now (vm) > last_sent_timer + 10.0)
159 /* $$$$ FC: reset transport session here? */
162 /* Exponential backoff, within reason */
168 last_sent_timer = vlib_time_now (vm);
169 offset += actual_transfer;
170 bytes_to_send -= actual_transfer;
172 if (svm_fifo_set_event (s->server_tx_fifo))
174 /* Fabricate TX event, send to vpp */
175 evt.fifo = s->server_tx_fifo;
176 evt.event_type = FIFO_EVENT_APP_TX;
178 svm_queue_add (hsm->vpp_queue[s->thread_index],
179 (u8 *) & evt, 0 /* do wait for mutex */ );
187 send_error (stream_session_t * s, char *str)
191 data = format (0, http_error_template, str);
197 http_cli_process (vlib_main_t * vm,
198 vlib_node_runtime_t * rt, vlib_frame_t * f)
200 http_server_main_t *hsm = &http_server_main;
201 u8 *request = 0, *reply = 0;
202 http_server_args **save_args;
203 http_server_args *args;
205 unformat_input_t input;
207 u8 *http = 0, *html = 0;
209 save_args = vlib_node_get_runtime_data (hsm->vlib_main, rt->node_index);
211 s = session_get_from_handle (args->session_handle);
214 request = (u8 *) (void *) (args->data);
215 if (vec_len (request) < 7)
217 send_error (s, "400 Bad Request");
221 for (i = 0; i < vec_len (request) - 4; i++)
223 if (request[i] == 'G' &&
224 request[i + 1] == 'E' &&
225 request[i + 2] == 'T' && request[i + 3] == ' ')
229 send_error (s, "400 Bad Request");
234 vec_delete (request, i + 5, 0);
236 /* Replace slashes with spaces, stop at the end of the path */
240 if (request[i] == '/')
242 else if (request[i] == ' ')
244 /* vlib_cli_input is vector-based, no need for a NULL */
245 _vec_len (request) = i;
249 /* Should never happen */
250 if (i == vec_len (request))
254 /* Generate the html header */
255 html = format (0, html_header_template, request /* title */ );
257 /* Run the command */
258 unformat_init_vector (&input, request);
259 vlib_cli_input (vm, &input, http_cli_output, (uword) & reply);
260 unformat_free (&input);
263 /* Generate the html page */
264 html = format (html, "%v", reply);
265 html = format (html, html_footer);
266 /* And the http reply */
267 http = format (0, http_response, vec_len (html), html);
279 free_http_process (args);
284 alloc_http_process (http_server_args * args)
288 http_server_main_t *hsm = &http_server_main;
289 vlib_main_t *vm = hsm->vlib_main;
290 uword l = vec_len (hsm->free_http_cli_process_node_indices);
291 http_server_args **save_args;
293 if (vec_len (hsm->free_http_cli_process_node_indices) > 0)
295 n = vlib_get_node (vm, hsm->free_http_cli_process_node_indices[l - 1]);
296 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
297 _vec_len (hsm->free_http_cli_process_node_indices) = l - 1;
301 static vlib_node_registration_t r = {
302 .function = http_cli_process,
303 .type = VLIB_NODE_TYPE_PROCESS,
304 .process_log2_n_stack_bytes = 16,
305 .runtime_data_bytes = sizeof (void *),
308 name = (char *) format (0, "http-cli-%d", l);
310 vlib_register_node (vm, &r);
313 n = vlib_get_node (vm, r.index);
316 /* Save the node index in the args. It won't be zero. */
317 args->node_index = n->index;
319 /* Save the args (pointer) in the node runtime */
320 save_args = vlib_node_get_runtime_data (vm, n->index);
323 vlib_start_process (vm, n->runtime_index);
327 alloc_http_process_callback (void *cb_args)
329 alloc_http_process ((http_server_args *) cb_args);
333 session_rx_request (stream_session_t * s)
335 http_server_main_t *hsm = &http_server_main;
340 rx_fifo = s->server_rx_fifo;
341 max_dequeue = svm_fifo_max_dequeue (rx_fifo);
342 svm_fifo_unset_event (rx_fifo);
343 if (PREDICT_FALSE (max_dequeue == 0))
346 vec_validate (hsm->rx_buf[s->thread_index], max_dequeue - 1);
347 _vec_len (hsm->rx_buf[s->thread_index]) = max_dequeue;
349 actual_transfer = svm_fifo_dequeue_nowait (rx_fifo, max_dequeue,
350 hsm->rx_buf[s->thread_index]);
351 ASSERT (actual_transfer > 0);
352 _vec_len (hsm->rx_buf[s->thread_index]) = actual_transfer;
357 http_server_rx_callback (stream_session_t * s)
359 http_server_main_t *hsm = &http_server_main;
360 http_server_args *args;
363 rv = session_rx_request (s);
367 /* send the command to a new/recycled vlib process */
368 args = clib_mem_alloc (sizeof (*args));
369 args->data = vec_dup (hsm->rx_buf[s->thread_index]);
370 args->session_handle = session_handle (s);
372 /* Send an RPC request via the thread-0 input node */
373 if (vlib_get_thread_index () != 0)
375 session_fifo_event_t evt;
376 evt.rpc_args.fp = alloc_http_process_callback;
377 evt.rpc_args.arg = args;
378 evt.event_type = FIFO_EVENT_RPC;
380 (session_manager_get_vpp_event_queue (0 /* main thread */ ),
381 (u8 *) & evt, 0 /* do wait for mutex */ );
384 alloc_http_process (args);
389 http_server_rx_callback_static (stream_session_t * s)
391 http_server_main_t *hsm = &http_server_main;
396 rv = session_rx_request (s);
400 request = hsm->rx_buf[s->thread_index];
401 if (vec_len (request) < 7)
403 send_error (s, "400 Bad Request");
407 for (i = 0; i < vec_len (request) - 4; i++)
409 if (request[i] == 'G' &&
410 request[i + 1] == 'E' &&
411 request[i + 2] == 'T' && request[i + 3] == ' ')
414 send_error (s, "400 Bad Request");
420 send_data (s, static_http);
425 hsm->rx_buf[s->thread_index] = request;
430 http_server_session_accept_callback (stream_session_t * s)
432 http_server_main_t *bsm = &http_server_main;
434 bsm->vpp_queue[s->thread_index] =
435 session_manager_get_vpp_event_queue (s->thread_index);
436 s->session_state = SESSION_STATE_READY;
442 http_server_session_disconnect_callback (stream_session_t * s)
444 http_server_main_t *bsm = &http_server_main;
445 vnet_disconnect_args_t _a, *a = &_a;
447 a->handle = session_handle (s);
448 a->app_index = bsm->app_index;
449 vnet_disconnect_session (a);
453 http_server_session_reset_callback (stream_session_t * s)
455 clib_warning ("called.. ");
456 stream_session_cleanup (s);
460 http_server_session_connected_callback (u32 app_index, u32 api_context,
461 stream_session_t * s, u8 is_fail)
463 clib_warning ("called...");
468 http_server_add_segment_callback (u32 client_index, const ssvm_private_t * sp)
470 clib_warning ("called...");
474 static session_cb_vft_t http_server_session_cb_vft = {
475 .session_accept_callback = http_server_session_accept_callback,
476 .session_disconnect_callback = http_server_session_disconnect_callback,
477 .session_connected_callback = http_server_session_connected_callback,
478 .add_segment_callback = http_server_add_segment_callback,
479 .builtin_server_rx_callback = http_server_rx_callback,
480 .session_reset_callback = http_server_session_reset_callback
483 /* Abuse VPP's input queue */
485 create_api_loopback (vlib_main_t * vm)
487 http_server_main_t *hsm = &http_server_main;
488 api_main_t *am = &api_main;
489 vl_shmem_hdr_t *shmem_hdr;
491 shmem_hdr = am->shmem_hdr;
492 hsm->vl_input_queue = shmem_hdr->vl_input_queue;
493 hsm->my_client_index =
494 vl_api_memclnt_create_internal ("http_server", hsm->vl_input_queue);
501 http_server_main_t *hsm = &http_server_main;
502 u64 options[APP_OPTIONS_N_OPTIONS];
503 vnet_app_attach_args_t _a, *a = &_a;
504 u32 segment_size = 128 << 20;
506 memset (a, 0, sizeof (*a));
507 memset (options, 0, sizeof (options));
509 if (hsm->private_segment_size)
510 segment_size = hsm->private_segment_size;
512 a->api_client_index = hsm->my_client_index;
513 a->session_cb_vft = &http_server_session_cb_vft;
514 a->options = options;
515 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
516 a->options[APP_OPTIONS_RX_FIFO_SIZE] =
517 hsm->fifo_size ? hsm->fifo_size : 8 << 10;
518 a->options[APP_OPTIONS_TX_FIFO_SIZE] =
519 hsm->fifo_size ? hsm->fifo_size : 32 << 10;
520 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
521 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = hsm->prealloc_fifos;
523 if (vnet_application_attach (a))
525 clib_warning ("failed to attach server");
528 hsm->app_index = a->app_index;
533 http_server_listen ()
535 http_server_main_t *hsm = &http_server_main;
536 vnet_bind_args_t _a, *a = &_a;
537 memset (a, 0, sizeof (*a));
538 a->app_index = hsm->app_index;
539 a->uri = "tcp://0.0.0.0/80";
540 return vnet_bind_uri (a);
544 http_server_create (vlib_main_t * vm)
546 http_server_main_t *hsm = &http_server_main;
548 vlib_thread_main_t *vtm = vlib_get_thread_main ();
550 ASSERT (hsm->my_client_index == (u32) ~ 0);
551 if (create_api_loopback (vm))
554 num_threads = 1 /* main thread */ + vtm->n_threads;
555 vec_validate (http_server_main.vpp_queue, num_threads - 1);
557 if (server_attach ())
559 clib_warning ("failed to attach server");
562 if (http_server_listen ())
564 clib_warning ("failed to start listening");
570 static clib_error_t *
571 http_server_create_command_fn (vlib_main_t * vm,
572 unformat_input_t * input,
573 vlib_cli_command_t * cmd)
575 http_server_main_t *hsm = &http_server_main;
576 int rv, is_static = 0;
580 hsm->prealloc_fifos = 0;
581 hsm->private_segment_size = 0;
583 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
585 if (unformat (input, "static"))
587 else if (unformat (input, "prealloc-fifos %d", &hsm->prealloc_fifos))
589 else if (unformat (input, "private-segment-size %U",
590 unformat_memory_size, &seg_size))
592 if (seg_size >= 0x100000000ULL)
594 vlib_cli_output (vm, "private segment size %llu, too large",
598 hsm->private_segment_size = seg_size;
600 else if (unformat (input, "fifo-size %d", &hsm->fifo_size))
601 hsm->fifo_size <<= 10;
603 return clib_error_return (0, "unknown input `%U'",
604 format_unformat_error, input);
606 if (hsm->my_client_index != (u32) ~ 0)
607 return clib_error_return (0, "test http server is already running");
609 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
613 http_server_session_cb_vft.builtin_server_rx_callback =
614 http_server_rx_callback_static;
615 html = format (0, html_header_static);
616 static_http = format (0, http_response, vec_len (html), html);
618 rv = http_server_create (vm);
624 return clib_error_return (0, "server_create returned %d", rv);
630 VLIB_CLI_COMMAND (http_server_create_command, static) =
632 .path = "test http server",
633 .short_help = "test http server",
634 .function = http_server_create_command_fn,
638 static clib_error_t *
639 http_server_main_init (vlib_main_t * vm)
641 http_server_main_t *hsm = &http_server_main;
642 vlib_thread_main_t *vtm = vlib_get_thread_main ();
645 hsm->my_client_index = ~0;
647 num_threads = 1 /* main thread */ + vtm->n_threads;
648 vec_validate (hsm->rx_buf, num_threads - 1);
652 VLIB_INIT_FUNCTION (http_server_main_init);
655 * fd.io coding-style-patch-verification: ON
658 * eval: (c-set-style "gnu")