2 * Copyright (c) 2015-2019 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>
19 #include <vnet/session/session.h>
24 } http_process_event_t;
36 HTTP_STATE_ESTABLISHED,
38 } http_session_state_t;
41 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
42 #define _(type, name) type name;
43 foreach_app_session_field
47 u32 vpp_session_index;
48 u64 vpp_session_handle;
53 http_session_t **sessions;
54 clib_rwlock_t sessions_lock;
55 u32 **session_to_http_session;
57 svm_msg_q_t **vpp_queue;
59 uword *handler_by_get_request;
61 u32 *free_http_cli_process_node_indices;
63 /* Sever's event queue */
64 svm_queue_t *vl_input_queue;
66 /* API client handle */
71 /* process node index for evnt scheduling */
75 u32 private_segment_size;
79 vlib_main_t *vlib_main;
82 http_server_main_t http_server_main;
85 http_server_sessions_reader_lock (void)
87 clib_rwlock_reader_lock (&http_server_main.sessions_lock);
91 http_server_sessions_reader_unlock (void)
93 clib_rwlock_reader_unlock (&http_server_main.sessions_lock);
97 http_server_sessions_writer_lock (void)
99 clib_rwlock_writer_lock (&http_server_main.sessions_lock);
103 http_server_sessions_writer_unlock (void)
105 clib_rwlock_writer_unlock (&http_server_main.sessions_lock);
109 http_server_session_lookup_add (u32 thread_index, u32 s_index, u32 hs_index)
111 http_server_main_t *hsm = &http_server_main;
112 vec_validate (hsm->session_to_http_session[thread_index], s_index);
113 hsm->session_to_http_session[thread_index][s_index] = hs_index;
117 http_server_session_lookup_del (u32 thread_index, u32 s_index)
119 http_server_main_t *hsm = &http_server_main;
120 hsm->session_to_http_session[thread_index][s_index] = ~0;
123 static http_session_t *
124 http_server_session_lookup (u32 thread_index, u32 s_index)
126 http_server_main_t *hsm = &http_server_main;
129 if (s_index < vec_len (hsm->session_to_http_session[thread_index]))
131 hs_index = hsm->session_to_http_session[thread_index][s_index];
132 if (hs_index < vec_len (hsm->sessions[thread_index]))
133 return &hsm->sessions[thread_index][hs_index];
138 static http_session_t *
139 http_server_session_alloc (u32 thread_index)
141 http_server_main_t *hsm = &http_server_main;
143 pool_get (hsm->sessions[thread_index], hs);
144 memset (hs, 0, sizeof (*hs));
145 hs->session_index = hs - hsm->sessions[thread_index];
146 hs->thread_index = thread_index;
150 static http_session_t *
151 http_server_session_get (u32 thread_index, u32 hs_index)
153 http_server_main_t *hsm = &http_server_main;
154 return pool_elt_at_index (hsm->sessions[thread_index], hs_index);
158 http_server_session_free (http_session_t * hs)
160 http_server_main_t *hsm = &http_server_main;
161 pool_put (hsm->sessions[hs->thread_index], hs);
163 memset (hs, 0xfa, sizeof (*hs));
167 http_server_session_cleanup (http_session_t * hs)
171 http_server_session_lookup_del (hs->thread_index, hs->vpp_session_index);
172 vec_free (hs->rx_buf);
173 http_server_session_free (hs);
177 http_process_free (http_server_args * args)
179 vlib_node_runtime_t *rt;
180 vlib_main_t *vm = &vlib_global_main;
181 http_server_main_t *hsm = &http_server_main;
184 http_server_args **save_args;
186 node_index = args->node_index;
187 ASSERT (node_index != 0);
189 n = vlib_get_node (vm, node_index);
190 rt = vlib_node_get_runtime (vm, n->index);
191 save_args = vlib_node_get_runtime_data (vm, n->index);
193 /* Reset process session pointer */
194 clib_mem_free (*save_args);
197 /* Turn off the process node */
198 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
200 /* add node index to the freelist */
201 vec_add1 (hsm->free_http_cli_process_node_indices, node_index);
205 static const char *http_ok =
206 "HTTP/1.1 200 OK\r\n";
208 static const char *http_response =
209 "Content-Type: text/html\r\n"
210 "Expires: Mon, 11 Jan 1970 10:10:10 GMT\r\n"
211 "Connection: close \r\n"
212 "Pragma: no-cache\r\n"
213 "Content-Length: %d\r\n\r\n%s";
215 static const char *http_error_template =
217 "Content-Type: text/html\r\n"
218 "Expires: Mon, 11 Jan 1970 10:10:10 GMT\r\n"
219 "Connection: close\r\n"
220 "Pragma: no-cache\r\n"
221 "Content-Length: 0\r\n\r\n";
223 /* Header, including incantation to suppress favicon.ico requests */
224 static const char *html_header_template =
225 "<html><head><title>%v</title></head>"
226 "<link rel=\"icon\" href=\"data:,\">"
229 static const char *html_footer =
230 "</pre></body></html>\r\n";
232 static const char *html_header_static =
233 "<html><head><title>static reply</title></head>"
234 "<link rel=\"icon\" href=\"data:,\">"
235 "<body><pre>hello</pre></body></html>\r\n";
238 static u8 *static_http;
239 static u8 *static_ok;
242 http_cli_output (uword arg, u8 * buffer, uword buffer_bytes)
244 u8 **output_vecp = (u8 **) arg;
248 output_vec = *output_vecp;
250 offset = vec_len (output_vec);
251 vec_validate (output_vec, offset + buffer_bytes - 1);
252 clib_memcpy_fast (output_vec + offset, buffer, buffer_bytes);
254 *output_vecp = output_vec;
258 send_data (http_session_t * hs, u8 * data)
260 http_server_main_t *hsm = &http_server_main;
261 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
262 vlib_main_t *vm = vlib_get_main ();
263 f64 last_sent_timer = vlib_time_now (vm);
264 u32 offset, bytes_to_send;
267 bytes_to_send = vec_len (data);
270 while (bytes_to_send > 0)
274 actual_transfer = svm_fifo_enqueue_nowait
275 (hs->tx_fifo, bytes_to_send, data + offset);
277 /* Made any progress? */
278 if (actual_transfer <= 0)
280 http_server_sessions_reader_unlock ();
281 vlib_process_suspend (vm, delay);
282 http_server_sessions_reader_lock ();
284 /* 10s deadman timer */
285 if (vlib_time_now (vm) > last_sent_timer + 10.0)
287 a->handle = hs->vpp_session_handle;
288 a->app_index = hsm->app_index;
289 vnet_disconnect_session (a);
292 /* Exponential backoff, within reason */
298 last_sent_timer = vlib_time_now (vm);
299 offset += actual_transfer;
300 bytes_to_send -= actual_transfer;
302 if (svm_fifo_set_event (hs->tx_fifo))
303 session_send_io_evt_to_thread (hs->tx_fifo,
304 SESSION_IO_EVT_TX_FLUSH);
311 send_error (http_session_t * hs, char *str)
315 data = format (0, http_error_template, str);
316 send_data (hs, data);
321 http_cli_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
324 u8 *request = 0, *reply = 0, *http = 0, *html = 0;
325 http_server_main_t *hsm = &http_server_main;
326 http_server_args **save_args;
327 http_server_args *args;
328 unformat_input_t input;
332 save_args = vlib_node_get_runtime_data (hsm->vlib_main, rt->node_index);
335 http_server_sessions_reader_lock ();
337 hs = http_server_session_get (args->thread_index, args->hs_index);
340 request = hs->rx_buf;
341 if (vec_len (request) < 7)
343 send_error (hs, "400 Bad Request");
347 for (i = 0; i < vec_len (request) - 4; i++)
349 if (request[i] == 'G' &&
350 request[i + 1] == 'E' &&
351 request[i + 2] == 'T' && request[i + 3] == ' ')
355 send_error (hs, "400 Bad Request");
360 vec_delete (request, i + 5, 0);
362 /* Replace slashes with spaces, stop at the end of the path */
366 if (request[i] == '/')
368 else if (request[i] == ' ')
370 /* vlib_cli_input is vector-based, no need for a NULL */
371 _vec_len (request) = i;
375 /* Should never happen */
376 if (i == vec_len (request))
380 /* Generate the html header */
381 html = format (0, html_header_template, request /* title */ );
383 /* Run the command */
384 unformat_init_vector (&input, vec_dup (request));
385 vlib_cli_input (vm, &input, http_cli_output, (uword) & reply);
386 unformat_free (&input);
389 /* Generate the html page */
390 html = format (html, "%v", reply);
391 html = format (html, html_footer);
392 /* And the http reply */
393 http = format (0, http_ok, vec_len (http_ok));
394 http = format (http, http_response, vec_len (html), html);
397 send_data (hs, http);
401 http_server_sessions_reader_unlock ();
406 http_process_free (args);
411 alloc_http_process (http_server_args * args)
415 http_server_main_t *hsm = &http_server_main;
416 vlib_main_t *vm = hsm->vlib_main;
417 uword l = vec_len (hsm->free_http_cli_process_node_indices);
418 http_server_args **save_args;
420 if (vec_len (hsm->free_http_cli_process_node_indices) > 0)
422 n = vlib_get_node (vm, hsm->free_http_cli_process_node_indices[l - 1]);
423 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
424 _vec_len (hsm->free_http_cli_process_node_indices) = l - 1;
428 static vlib_node_registration_t r = {
429 .function = http_cli_process,
430 .type = VLIB_NODE_TYPE_PROCESS,
431 .process_log2_n_stack_bytes = 16,
432 .runtime_data_bytes = sizeof (void *),
435 name = (char *) format (0, "http-cli-%d", l);
437 vlib_register_node (vm, &r);
440 n = vlib_get_node (vm, r.index);
443 /* Save the node index in the args. It won't be zero. */
444 args->node_index = n->index;
446 /* Save the args (pointer) in the node runtime */
447 save_args = vlib_node_get_runtime_data (vm, n->index);
448 *save_args = clib_mem_alloc (sizeof (*args));
449 clib_memcpy_fast (*save_args, args, sizeof (*args));
451 vlib_start_process (vm, n->runtime_index);
455 alloc_http_process_callback (void *cb_args)
457 alloc_http_process ((http_server_args *) cb_args);
461 session_rx_request (http_session_t * hs)
463 u32 max_dequeue, cursize;
466 cursize = vec_len (hs->rx_buf);
467 max_dequeue = svm_fifo_max_dequeue (hs->rx_fifo);
468 if (PREDICT_FALSE (max_dequeue == 0))
471 vec_validate (hs->rx_buf, cursize + max_dequeue - 1);
472 n_read = app_recv_stream_raw (hs->rx_fifo, hs->rx_buf + cursize,
473 max_dequeue, 0, 0 /* peek */ );
474 ASSERT (n_read == max_dequeue);
475 if (svm_fifo_is_empty (hs->rx_fifo))
476 svm_fifo_unset_event (hs->rx_fifo);
478 _vec_len (hs->rx_buf) = cursize + n_read;
483 http_server_rx_callback (session_t * s)
485 http_server_args args;
489 http_server_sessions_reader_lock ();
491 hs = http_server_session_lookup (s->thread_index, s->session_index);
492 if (!hs || hs->session_state != HTTP_STATE_ESTABLISHED)
495 rv = session_rx_request (hs);
499 /* send the command to a new/recycled vlib process */
500 args.hs_index = hs->session_index;
501 args.thread_index = hs->thread_index;
503 http_server_sessions_reader_unlock ();
505 /* Send RPC request to main thread */
506 if (vlib_get_thread_index () != 0)
507 vlib_rpc_call_main_thread (alloc_http_process_callback, (u8 *) & args,
510 alloc_http_process (&args);
515 http_server_rx_callback_static (session_t * s)
517 http_server_main_t *hsm = &http_server_main;
518 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
524 hs = http_server_session_lookup (s->thread_index, s->session_index);
525 if (!hs || hs->session_state == HTTP_STATE_CLOSED)
528 /* ok 200 was sent */
529 if (hs->session_state == HTTP_STATE_OK_SENT)
532 rv = session_rx_request (hs);
536 request = hs->rx_buf;
537 request_len = vec_len (request);
538 if (vec_len (request) < 7)
540 send_error (hs, "400 Bad Request");
544 for (i = 0; i < request_len - 4; i++)
546 if (request[i] == 'G' &&
547 request[i + 1] == 'E' &&
548 request[i + 2] == 'T' && request[i + 3] == ' ')
551 send_error (hs, "400 Bad Request");
556 /* check for the end sequence: /r/n/r/n */
557 if (request[request_len - 1] != 0xa || request[request_len - 3] != 0xa
558 || request[request_len - 2] != 0xd || request[request_len - 4] != 0xd)
561 /* send 200 OK first */
562 send_data (hs, static_ok);
563 hs->session_state = HTTP_STATE_OK_SENT;
567 send_data (hs, static_http);
568 http_server_session_cleanup (hs);
571 a->handle = session_handle (s);
572 a->app_index = hsm->app_index;
573 vnet_disconnect_session (a);
577 (void) svm_fifo_set_event (hs->rx_fifo);
578 session_send_io_evt_to_thread (hs->rx_fifo, SESSION_IO_EVT_BUILTIN_RX);
586 http_server_session_accept_callback (session_t * s)
588 http_server_main_t *hsm = &http_server_main;
591 hsm->vpp_queue[s->thread_index] =
592 session_main_get_vpp_event_queue (s->thread_index);
595 http_server_sessions_writer_lock ();
597 hs = http_server_session_alloc (s->thread_index);
598 http_server_session_lookup_add (s->thread_index, s->session_index,
600 hs->rx_fifo = s->rx_fifo;
601 hs->tx_fifo = s->tx_fifo;
602 hs->vpp_session_index = s->session_index;
603 hs->vpp_session_handle = session_handle (s);
604 hs->session_state = HTTP_STATE_ESTABLISHED;
607 http_server_sessions_writer_unlock ();
609 s->session_state = SESSION_STATE_READY;
614 http_server_session_disconnect_callback (session_t * s)
616 http_server_main_t *hsm = &http_server_main;
617 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
621 http_server_sessions_writer_lock ();
623 hs = http_server_session_lookup (s->thread_index, s->session_index);
624 http_server_session_cleanup (hs);
627 http_server_sessions_writer_unlock ();
629 a->handle = session_handle (s);
630 a->app_index = hsm->app_index;
631 vnet_disconnect_session (a);
635 http_server_session_reset_callback (session_t * s)
637 http_server_main_t *hsm = &http_server_main;
638 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
642 http_server_sessions_writer_lock ();
644 hs = http_server_session_lookup (s->thread_index, s->session_index);
645 http_server_session_cleanup (hs);
648 http_server_sessions_writer_unlock ();
650 a->handle = session_handle (s);
651 a->app_index = hsm->app_index;
652 vnet_disconnect_session (a);
656 http_server_session_connected_callback (u32 app_index, u32 api_context,
657 session_t * s, u8 is_fail)
659 clib_warning ("called...");
664 http_server_add_segment_callback (u32 client_index, u64 segment_handle)
666 clib_warning ("called...");
670 static session_cb_vft_t http_server_session_cb_vft = {
671 .session_accept_callback = http_server_session_accept_callback,
672 .session_disconnect_callback = http_server_session_disconnect_callback,
673 .session_connected_callback = http_server_session_connected_callback,
674 .add_segment_callback = http_server_add_segment_callback,
675 .builtin_app_rx_callback = http_server_rx_callback,
676 .session_reset_callback = http_server_session_reset_callback
680 http_server_attach ()
682 vnet_app_add_tls_cert_args_t _a_cert, *a_cert = &_a_cert;
683 vnet_app_add_tls_key_args_t _a_key, *a_key = &_a_key;
684 http_server_main_t *hsm = &http_server_main;
685 u64 options[APP_OPTIONS_N_OPTIONS];
686 vnet_app_attach_args_t _a, *a = &_a;
687 u32 segment_size = 128 << 20;
689 clib_memset (a, 0, sizeof (*a));
690 clib_memset (options, 0, sizeof (options));
692 if (hsm->private_segment_size)
693 segment_size = hsm->private_segment_size;
695 a->api_client_index = ~0;
696 a->name = format (0, "test_http_server");
697 a->session_cb_vft = &http_server_session_cb_vft;
698 a->options = options;
699 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
700 a->options[APP_OPTIONS_RX_FIFO_SIZE] =
701 hsm->fifo_size ? hsm->fifo_size : 8 << 10;
702 a->options[APP_OPTIONS_TX_FIFO_SIZE] =
703 hsm->fifo_size ? hsm->fifo_size : 32 << 10;
704 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
705 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = hsm->prealloc_fifos;
707 if (vnet_application_attach (a))
710 clib_warning ("failed to attach server");
714 hsm->app_index = a->app_index;
716 clib_memset (a_cert, 0, sizeof (*a_cert));
717 a_cert->app_index = a->app_index;
718 vec_validate (a_cert->cert, test_srv_crt_rsa_len);
719 clib_memcpy_fast (a_cert->cert, test_srv_crt_rsa, test_srv_crt_rsa_len);
720 vnet_app_add_tls_cert (a_cert);
722 clib_memset (a_key, 0, sizeof (*a_key));
723 a_key->app_index = a->app_index;
724 vec_validate (a_key->key, test_srv_key_rsa_len);
725 clib_memcpy_fast (a_key->key, test_srv_key_rsa, test_srv_key_rsa_len);
726 vnet_app_add_tls_key (a_key);
732 http_server_listen ()
734 http_server_main_t *hsm = &http_server_main;
735 vnet_listen_args_t _a, *a = &_a;
736 clib_memset (a, 0, sizeof (*a));
737 a->app_index = hsm->app_index;
738 a->uri = "tcp://0.0.0.0/80";
740 a->uri = (char *) hsm->uri;
741 return vnet_bind_uri (a);
745 http_server_create (vlib_main_t * vm)
747 vlib_thread_main_t *vtm = vlib_get_thread_main ();
748 http_server_main_t *hsm = &http_server_main;
751 num_threads = 1 /* main thread */ + vtm->n_threads;
752 vec_validate (hsm->vpp_queue, num_threads - 1);
753 vec_validate (hsm->sessions, num_threads - 1);
754 vec_validate (hsm->session_to_http_session, num_threads - 1);
756 clib_rwlock_init (&hsm->sessions_lock);
758 if (http_server_attach ())
760 clib_warning ("failed to attach server");
763 if (http_server_listen ())
765 clib_warning ("failed to start listening");
771 static clib_error_t *
772 http_server_create_command_fn (vlib_main_t * vm,
773 unformat_input_t * input,
774 vlib_cli_command_t * cmd)
776 http_server_main_t *hsm = &http_server_main;
777 unformat_input_t _line_input, *line_input = &_line_input;
782 hsm->prealloc_fifos = 0;
783 hsm->private_segment_size = 0;
787 /* Get a line of input. */
788 if (!unformat_user (input, unformat_line_input, line_input))
791 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
793 if (unformat (line_input, "static"))
796 if (unformat (line_input, "prealloc-fifos %d", &hsm->prealloc_fifos))
798 else if (unformat (line_input, "private-segment-size %U",
799 unformat_memory_size, &seg_size))
801 if (seg_size >= 0x100000000ULL)
803 vlib_cli_output (vm, "private segment size %llu, too large",
807 hsm->private_segment_size = seg_size;
809 else if (unformat (line_input, "fifo-size %d", &hsm->fifo_size))
810 hsm->fifo_size <<= 10;
811 else if (unformat (line_input, "uri %s", &hsm->uri))
814 return clib_error_return (0, "unknown input `%U'",
815 format_unformat_error, line_input);
817 unformat_free (line_input);
821 if (hsm->my_client_index != (u32) ~ 0)
822 return clib_error_return (0, "test http server is already running");
824 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
828 http_server_session_cb_vft.builtin_app_rx_callback =
829 http_server_rx_callback_static;
830 html = format (0, html_header_static);
831 static_http = format (0, http_response, vec_len (html), html);
832 static_ok = format (0, http_ok);
834 rv = http_server_create (vm);
840 return clib_error_return (0, "server_create returned %d", rv);
846 VLIB_CLI_COMMAND (http_server_create_command, static) =
848 .path = "test http server",
849 .short_help = "test http server",
850 .function = http_server_create_command_fn,
854 static clib_error_t *
855 http_server_main_init (vlib_main_t * vm)
857 http_server_main_t *hsm = &http_server_main;
859 hsm->my_client_index = ~0;
864 VLIB_INIT_FUNCTION (http_server_main_init);
867 * fd.io coding-style-patch-verification: ON
870 * eval: (c-set-style "gnu")