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 vlib_process_suspend (vm, delay);
281 /* 10s deadman timer */
282 if (vlib_time_now (vm) > last_sent_timer + 10.0)
284 a->handle = hs->vpp_session_handle;
285 a->app_index = hsm->app_index;
286 vnet_disconnect_session (a);
289 /* Exponential backoff, within reason */
295 last_sent_timer = vlib_time_now (vm);
296 offset += actual_transfer;
297 bytes_to_send -= actual_transfer;
299 if (svm_fifo_set_event (hs->tx_fifo))
300 session_send_io_evt_to_thread (hs->tx_fifo,
301 SESSION_IO_EVT_TX_FLUSH);
308 send_error (http_session_t * hs, char *str)
312 data = format (0, http_error_template, str);
313 send_data (hs, data);
318 http_cli_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
321 u8 *request = 0, *reply = 0, *http = 0, *html = 0;
322 http_server_main_t *hsm = &http_server_main;
323 http_server_args **save_args;
324 http_server_args *args;
325 unformat_input_t input;
329 save_args = vlib_node_get_runtime_data (hsm->vlib_main, rt->node_index);
332 http_server_sessions_reader_lock ();
334 hs = http_server_session_get (args->thread_index, args->hs_index);
337 request = hs->rx_buf;
338 if (vec_len (request) < 7)
340 send_error (hs, "400 Bad Request");
344 for (i = 0; i < vec_len (request) - 4; i++)
346 if (request[i] == 'G' &&
347 request[i + 1] == 'E' &&
348 request[i + 2] == 'T' && request[i + 3] == ' ')
352 send_error (hs, "400 Bad Request");
357 vec_delete (request, i + 5, 0);
359 /* Replace slashes with spaces, stop at the end of the path */
363 if (request[i] == '/')
365 else if (request[i] == ' ')
367 /* vlib_cli_input is vector-based, no need for a NULL */
368 _vec_len (request) = i;
372 /* Should never happen */
373 if (i == vec_len (request))
377 /* Generate the html header */
378 html = format (0, html_header_template, request /* title */ );
380 /* Run the command */
381 unformat_init_vector (&input, vec_dup (request));
382 vlib_cli_input (vm, &input, http_cli_output, (uword) & reply);
383 unformat_free (&input);
386 /* Generate the html page */
387 html = format (html, "%v", reply);
388 html = format (html, html_footer);
389 /* And the http reply */
390 http = format (0, http_ok, vec_len (http_ok));
391 http = format (http, http_response, vec_len (html), html);
394 send_data (hs, http);
398 http_server_sessions_reader_unlock ();
403 http_process_free (args);
408 alloc_http_process (http_server_args * args)
412 http_server_main_t *hsm = &http_server_main;
413 vlib_main_t *vm = hsm->vlib_main;
414 uword l = vec_len (hsm->free_http_cli_process_node_indices);
415 http_server_args **save_args;
417 if (vec_len (hsm->free_http_cli_process_node_indices) > 0)
419 n = vlib_get_node (vm, hsm->free_http_cli_process_node_indices[l - 1]);
420 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
421 _vec_len (hsm->free_http_cli_process_node_indices) = l - 1;
425 static vlib_node_registration_t r = {
426 .function = http_cli_process,
427 .type = VLIB_NODE_TYPE_PROCESS,
428 .process_log2_n_stack_bytes = 16,
429 .runtime_data_bytes = sizeof (void *),
432 name = (char *) format (0, "http-cli-%d", l);
434 vlib_register_node (vm, &r);
437 n = vlib_get_node (vm, r.index);
440 /* Save the node index in the args. It won't be zero. */
441 args->node_index = n->index;
443 /* Save the args (pointer) in the node runtime */
444 save_args = vlib_node_get_runtime_data (vm, n->index);
447 vlib_start_process (vm, n->runtime_index);
451 alloc_http_process_callback (void *cb_args)
453 alloc_http_process ((http_server_args *) cb_args);
457 session_rx_request (http_session_t * hs)
459 u32 max_dequeue, cursize;
462 cursize = vec_len (hs->rx_buf);
463 max_dequeue = svm_fifo_max_dequeue (hs->rx_fifo);
464 if (PREDICT_FALSE (max_dequeue == 0))
467 vec_validate (hs->rx_buf, cursize + max_dequeue - 1);
468 n_read = app_recv_stream_raw (hs->rx_fifo, hs->rx_buf + cursize,
469 max_dequeue, 0, 0 /* peek */ );
470 ASSERT (n_read == max_dequeue);
471 if (svm_fifo_is_empty (hs->rx_fifo))
472 svm_fifo_unset_event (hs->rx_fifo);
474 _vec_len (hs->rx_buf) = cursize + n_read;
479 http_server_rx_callback (session_t * s)
481 http_server_args *args;
485 http_server_sessions_reader_lock ();
487 hs = http_server_session_lookup (s->thread_index, s->session_index);
488 if (!hs || hs->session_state != HTTP_STATE_ESTABLISHED)
491 rv = session_rx_request (hs);
495 /* send the command to a new/recycled vlib process */
496 args = clib_mem_alloc (sizeof (*args));
497 args->hs_index = hs->session_index;
498 args->thread_index = hs->thread_index;
500 http_server_sessions_reader_unlock ();
502 /* Send an RPC request via the thread-0 input node */
503 if (vlib_get_thread_index () != 0)
504 session_send_rpc_evt_to_thread (0, alloc_http_process_callback, args);
506 alloc_http_process (args);
511 http_server_rx_callback_static (session_t * s)
513 http_server_main_t *hsm = &http_server_main;
514 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
520 hs = http_server_session_lookup (s->thread_index, s->session_index);
521 if (!hs || hs->session_state == HTTP_STATE_CLOSED)
524 /* ok 200 was sent */
525 if (hs->session_state == HTTP_STATE_OK_SENT)
528 rv = session_rx_request (hs);
532 request = hs->rx_buf;
533 request_len = vec_len (request);
534 if (vec_len (request) < 7)
536 send_error (hs, "400 Bad Request");
540 for (i = 0; i < request_len - 4; i++)
542 if (request[i] == 'G' &&
543 request[i + 1] == 'E' &&
544 request[i + 2] == 'T' && request[i + 3] == ' ')
547 send_error (hs, "400 Bad Request");
552 /* check for the end sequence: /r/n/r/n */
553 if (request[request_len - 1] != 0xa || request[request_len - 3] != 0xa
554 || request[request_len - 2] != 0xd || request[request_len - 4] != 0xd)
557 /* send 200 OK first */
558 send_data (hs, static_ok);
559 hs->session_state = HTTP_STATE_OK_SENT;
563 send_data (hs, static_http);
564 http_server_session_cleanup (hs);
567 a->handle = session_handle (s);
568 a->app_index = hsm->app_index;
569 vnet_disconnect_session (a);
573 (void) svm_fifo_set_event (hs->rx_fifo);
574 session_send_io_evt_to_thread (hs->rx_fifo, FIFO_EVENT_BUILTIN_RX);
582 http_server_session_accept_callback (session_t * s)
584 http_server_main_t *hsm = &http_server_main;
587 hsm->vpp_queue[s->thread_index] =
588 session_manager_get_vpp_event_queue (s->thread_index);
591 http_server_sessions_writer_lock ();
593 hs = http_server_session_alloc (s->thread_index);
594 http_server_session_lookup_add (s->thread_index, s->session_index,
596 hs->rx_fifo = s->rx_fifo;
597 hs->tx_fifo = s->tx_fifo;
598 hs->vpp_session_index = s->session_index;
599 hs->vpp_session_handle = session_handle (s);
600 hs->session_state = HTTP_STATE_ESTABLISHED;
603 http_server_sessions_writer_unlock ();
605 s->session_state = SESSION_STATE_READY;
610 http_server_session_disconnect_callback (session_t * s)
612 http_server_main_t *hsm = &http_server_main;
613 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
617 http_server_sessions_writer_lock ();
619 hs = http_server_session_lookup (s->thread_index, s->session_index);
620 http_server_session_cleanup (hs);
623 http_server_sessions_writer_unlock ();
625 a->handle = session_handle (s);
626 a->app_index = hsm->app_index;
627 vnet_disconnect_session (a);
631 http_server_session_reset_callback (session_t * s)
633 http_server_main_t *hsm = &http_server_main;
634 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
638 http_server_sessions_writer_lock ();
640 hs = http_server_session_lookup (s->thread_index, s->session_index);
641 http_server_session_cleanup (hs);
644 http_server_sessions_writer_unlock ();
646 a->handle = session_handle (s);
647 a->app_index = hsm->app_index;
648 vnet_disconnect_session (a);
652 http_server_session_connected_callback (u32 app_index, u32 api_context,
653 session_t * s, u8 is_fail)
655 clib_warning ("called...");
660 http_server_add_segment_callback (u32 client_index, u64 segment_handle)
662 clib_warning ("called...");
666 static session_cb_vft_t http_server_session_cb_vft = {
667 .session_accept_callback = http_server_session_accept_callback,
668 .session_disconnect_callback = http_server_session_disconnect_callback,
669 .session_connected_callback = http_server_session_connected_callback,
670 .add_segment_callback = http_server_add_segment_callback,
671 .builtin_app_rx_callback = http_server_rx_callback,
672 .session_reset_callback = http_server_session_reset_callback
676 http_server_attach ()
678 vnet_app_add_tls_cert_args_t _a_cert, *a_cert = &_a_cert;
679 vnet_app_add_tls_key_args_t _a_key, *a_key = &_a_key;
680 http_server_main_t *hsm = &http_server_main;
681 u64 options[APP_OPTIONS_N_OPTIONS];
682 vnet_app_attach_args_t _a, *a = &_a;
683 u32 segment_size = 128 << 20;
685 clib_memset (a, 0, sizeof (*a));
686 clib_memset (options, 0, sizeof (options));
688 if (hsm->private_segment_size)
689 segment_size = hsm->private_segment_size;
691 a->api_client_index = ~0;
692 a->name = format (0, "test_http_server");
693 a->session_cb_vft = &http_server_session_cb_vft;
694 a->options = options;
695 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
696 a->options[APP_OPTIONS_RX_FIFO_SIZE] =
697 hsm->fifo_size ? hsm->fifo_size : 8 << 10;
698 a->options[APP_OPTIONS_TX_FIFO_SIZE] =
699 hsm->fifo_size ? hsm->fifo_size : 32 << 10;
700 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
701 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = hsm->prealloc_fifos;
703 if (vnet_application_attach (a))
706 clib_warning ("failed to attach server");
710 hsm->app_index = a->app_index;
712 clib_memset (a_cert, 0, sizeof (*a_cert));
713 a_cert->app_index = a->app_index;
714 vec_validate (a_cert->cert, test_srv_crt_rsa_len);
715 clib_memcpy_fast (a_cert->cert, test_srv_crt_rsa, test_srv_crt_rsa_len);
716 vnet_app_add_tls_cert (a_cert);
718 clib_memset (a_key, 0, sizeof (*a_key));
719 a_key->app_index = a->app_index;
720 vec_validate (a_key->key, test_srv_key_rsa_len);
721 clib_memcpy_fast (a_key->key, test_srv_key_rsa, test_srv_key_rsa_len);
722 vnet_app_add_tls_key (a_key);
728 http_server_listen ()
730 http_server_main_t *hsm = &http_server_main;
731 vnet_listen_args_t _a, *a = &_a;
732 clib_memset (a, 0, sizeof (*a));
733 a->app_index = hsm->app_index;
734 a->uri = "tcp://0.0.0.0/80";
736 a->uri = (char *) hsm->uri;
737 return vnet_bind_uri (a);
741 http_server_create (vlib_main_t * vm)
743 vlib_thread_main_t *vtm = vlib_get_thread_main ();
744 http_server_main_t *hsm = &http_server_main;
747 num_threads = 1 /* main thread */ + vtm->n_threads;
748 vec_validate (hsm->vpp_queue, num_threads - 1);
749 vec_validate (hsm->sessions, num_threads - 1);
750 vec_validate (hsm->session_to_http_session, num_threads - 1);
752 clib_rwlock_init (&hsm->sessions_lock);
754 if (http_server_attach ())
756 clib_warning ("failed to attach server");
759 if (http_server_listen ())
761 clib_warning ("failed to start listening");
767 static clib_error_t *
768 http_server_create_command_fn (vlib_main_t * vm,
769 unformat_input_t * input,
770 vlib_cli_command_t * cmd)
772 http_server_main_t *hsm = &http_server_main;
777 hsm->prealloc_fifos = 0;
778 hsm->private_segment_size = 0;
781 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
783 if (unformat (input, "static"))
785 else if (unformat (input, "prealloc-fifos %d", &hsm->prealloc_fifos))
787 else if (unformat (input, "private-segment-size %U",
788 unformat_memory_size, &seg_size))
790 if (seg_size >= 0x100000000ULL)
792 vlib_cli_output (vm, "private segment size %llu, too large",
796 hsm->private_segment_size = seg_size;
798 else if (unformat (input, "fifo-size %d", &hsm->fifo_size))
799 hsm->fifo_size <<= 10;
800 else if (unformat (input, "uri %s", &hsm->uri))
803 return clib_error_return (0, "unknown input `%U'",
804 format_unformat_error, input);
806 if (hsm->my_client_index != (u32) ~ 0)
807 return clib_error_return (0, "test http server is already running");
809 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
813 http_server_session_cb_vft.builtin_app_rx_callback =
814 http_server_rx_callback_static;
815 html = format (0, html_header_static);
816 static_http = format (0, http_response, vec_len (html), html);
817 static_ok = format (0, http_ok);
819 rv = http_server_create (vm);
825 return clib_error_return (0, "server_create returned %d", rv);
831 VLIB_CLI_COMMAND (http_server_create_command, static) =
833 .path = "test http server",
834 .short_help = "test http server",
835 .function = http_server_create_command_fn,
839 static clib_error_t *
840 http_server_main_init (vlib_main_t * vm)
842 http_server_main_t *hsm = &http_server_main;
844 hsm->my_client_index = ~0;
849 VLIB_INIT_FUNCTION (http_server_main_init);
852 * fd.io coding-style-patch-verification: ON
855 * eval: (c-set-style "gnu")