Gitiles
Code Review Sign In
gerrit.nordix.org / fdio / vpp / 0a47c99aed8124d2f4c3be0d90e961b82a6b9914 / . / src / vnet / tcp / builtin_http_server.c
blob: f808400d63d85292294ef8eb8c58f5e9aecc72e2 [file] [log] [blame]
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]1/*
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:
6*
7* http://www.apache.org/licenses/LICENSE-2.0
8*
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.
14*/
15
16#include <vnet/vnet.h>
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]17#include <vnet/session/application.h>
18#include <vnet/session/application_interface.h>
19
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]20typedef enum
21{
22 EVENT_WAKEUP = 1,
23} http_process_event_t;
24
25typedef struct
26{
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]27 u64 session_handle;
28 u64 node_index;
29 u8 *data;
30} builtin_http_server_args;
31
32typedef struct
33{
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]34 u8 *rx_buf;
35 unix_shared_memory_queue_t **vpp_queue;
36 u64 byte_index;
37
38 uword *handler_by_get_request;
39
40 u32 *free_http_cli_process_node_indices;
41
42 /* Sever's event queue */
43 unix_shared_memory_queue_t *vl_input_queue;
44
45 /* API client handle */
46 u32 my_client_index;
47
48 u32 app_index;
49
50 /* process node index for evnt scheduling */
51 u32 node_index;
52 vlib_main_t *vlib_main;
53} http_server_main_t;
54
55http_server_main_t http_server_main;
56
57static void
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]58free_http_process (builtin_http_server_args * args)
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]59{
60 vlib_node_runtime_t *rt;
61 vlib_main_t *vm = &vlib_global_main;
62 http_server_main_t *hsm = &http_server_main;
63 vlib_node_t *n;
64 u32 node_index;
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]65 builtin_http_server_args **save_args;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]66
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]67 node_index = args->node_index;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]68 ASSERT (node_index != 0);
69
70 n = vlib_get_node (vm, node_index);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]71 rt = vlib_node_get_runtime (vm, n->index);
72 save_args = vlib_node_get_runtime_data (vm, n->index);
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]73
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]74 /* Reset process session pointer */
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]75 clib_mem_free (*save_args);
76 *save_args = 0;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]77
78 /* Turn off the process node */
79 vlib_node_set_state (vm, rt->node_index, VLIB_NODE_STATE_DISABLED);
80
81 /* add node index to the freelist */
82 vec_add1 (hsm->free_http_cli_process_node_indices, node_index);
83}
84
85static const char
86 *http_response = "HTTP/1.1 200 OK\r\n"
87 "Content-Type: text/html\r\n"
88 "Expires: Mon, 11 Jan 1970 10:10:10 GMT\r\n"
89 "Connection: close\r\n"
90 "Pragma: no-cache\r\n" "Content-Length: %d\r\n\r\n%s";
91
92static const char
93 *http_error_template = "HTTP/1.1 %s\r\n"
94 "Content-Type: text/html\r\n"
95 "Expires: Mon, 11 Jan 1970 10:10:10 GMT\r\n"
96 "Connection: close\r\n" "Pragma: no-cache\r\n" "Content-Length: 0\r\n\r\n";
97
98/* Header, including incantation to suppress favicon.ico requests */
99static const char
100 *html_header_template = "<html><head><title>%v</title>"
101 "</head><link rel=\"icon\" href=\"data:,\"><body><pre>";
102
103static const char *html_footer = "</pre></body></html>\r\n";
104
105static void
106http_cli_output (uword arg, u8 * buffer, uword buffer_bytes)
107{
108 u8 **output_vecp = (u8 **) arg;
109 u8 *output_vec;
110 u32 offset;
111
112 output_vec = *output_vecp;
113
114 offset = vec_len (output_vec);
115 vec_validate (output_vec, offset + buffer_bytes - 1);
116 clib_memcpy (output_vec + offset, buffer, buffer_bytes);
117
118 *output_vecp = output_vec;
119}
120
121void
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]122send_data (builtin_http_server_args * args, u8 * data)
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]123{
124 session_fifo_event_t evt;
125 u32 offset, bytes_to_send;
126 f64 delay = 10e-3;
127 http_server_main_t *hsm = &http_server_main;
128 vlib_main_t *vm = hsm->vlib_main;
129 f64 last_sent_timer = vlib_time_now (vm);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]130 stream_session_t *s;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]131
Florin Corascea194d2017-10-02 00:18:51 -0700[diff] [blame]132 s = session_get_from_handle (args->session_handle);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]133 ASSERT (s);
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]134 bytes_to_send = vec_len (data);
135 offset = 0;
136
137 while (bytes_to_send > 0)
138 {
139 int actual_transfer;
140
141 actual_transfer = svm_fifo_enqueue_nowait
142 (s->server_tx_fifo, bytes_to_send, data + offset);
143
144 /* Made any progress? */
145 if (actual_transfer <= 0)
146 {
147 vlib_process_suspend (vm, delay);
148 /* 10s deadman timer */
149 if (vlib_time_now (vm) > last_sent_timer + 10.0)
150 {
151 /* $$$$ FC: reset transport session here? */
152 break;
153 }
154 /* Exponential backoff, within reason */
155 if (delay < 1.0)
156 delay = delay * 2.0;
157 }
158 else
159 {
160 last_sent_timer = vlib_time_now (vm);
161 offset += actual_transfer;
162 bytes_to_send -= actual_transfer;
163
164 if (svm_fifo_set_event (s->server_tx_fifo))
165 {
166 /* Fabricate TX event, send to vpp */
167 evt.fifo = s->server_tx_fifo;
168 evt.event_type = FIFO_EVENT_APP_TX;
169 evt.event_id = 0;
170
171 unix_shared_memory_queue_add (hsm->vpp_queue[s->thread_index],
172 (u8 *) & evt,
173 0 /* do wait for mutex */ );
174 }
175 delay = 10e-3;
176 }
177 }
178}
179
180static void
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]181send_error (builtin_http_server_args * args, char *str)
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]182{
183 u8 *data;
184
185 data = format (0, http_error_template, str);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]186 send_data (args, data);
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]187 vec_free (data);
188}
189
190static uword
191http_cli_process (vlib_main_t * vm,
192 vlib_node_runtime_t * rt, vlib_frame_t * f)
193{
194 http_server_main_t *hsm = &http_server_main;
195 u8 *request = 0, *reply = 0;
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]196 builtin_http_server_args **save_args;
197 builtin_http_server_args *args;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]198 unformat_input_t input;
199 int i;
200 u8 *http = 0, *html = 0;
201
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]202 save_args = vlib_node_get_runtime_data (hsm->vlib_main, rt->node_index);
203 args = *save_args;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]204
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]205 request = (u8 *) (void *) (args->data);
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]206 if (vec_len (request) < 7)
207 {
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]208 send_error (args, "400 Bad Request");
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]209 goto out;
210 }
211
212 for (i = 0; i < vec_len (request) - 4; i++)
213 {
214 if (request[i] == 'G' &&
215 request[i + 1] == 'E' &&
216 request[i + 2] == 'T' && request[i + 3] == ' ')
217 goto found;
218 }
219bad_request:
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]220 send_error (args, "400 Bad Request");
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]221 goto out;
222
223found:
224 /* Lose "GET " */
225 vec_delete (request, i + 5, 0);
226
227 /* Replace slashes with spaces, stop at the end of the path */
228 i = 0;
229 while (1)
230 {
231 if (request[i] == '/')
232 request[i] = ' ';
233 else if (request[i] == ' ')
234 {
235 /* vlib_cli_input is vector-based, no need for a NULL */
236 _vec_len (request) = i;
237 break;
238 }
239 i++;
240 /* Should never happen */
241 if (i == vec_len (request))
242 goto bad_request;
243 }
244
245 /* Generate the html header */
246 html = format (0, html_header_template, request /* title */ );
247
248 /* Run the command */
249 unformat_init_vector (&input, request);
250 vlib_cli_input (vm, &input, http_cli_output, (uword) & reply);
251 unformat_free (&input);
252 request = 0;
253
254 /* Generate the html page */
255 html = format (html, "%v", reply);
256 html = format (html, html_footer);
257 /* And the http reply */
258 http = format (0, http_response, vec_len (html), html);
259
260 /* Send it */
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]261 send_data (args, http);
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]262
263out:
264 /* Cleanup */
265 vec_free (request);
266 vec_free (reply);
267 vec_free (html);
268 vec_free (http);
269
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]270 free_http_process (args);
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]271 return (0);
272}
273
274static void
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]275alloc_http_process (builtin_http_server_args * args)
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]276{
277 char *name;
278 vlib_node_t *n;
279 http_server_main_t *hsm = &http_server_main;
280 vlib_main_t *vm = hsm->vlib_main;
281 uword l = vec_len (hsm->free_http_cli_process_node_indices);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]282 builtin_http_server_args **save_args;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]283
284 if (vec_len (hsm->free_http_cli_process_node_indices) > 0)
285 {
286 n = vlib_get_node (vm, hsm->free_http_cli_process_node_indices[l - 1]);
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]287 vlib_node_set_state (vm, n->index, VLIB_NODE_STATE_POLLING);
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]288 _vec_len (hsm->free_http_cli_process_node_indices) = l - 1;
289 }
290 else
291 {
292 static vlib_node_registration_t r = {
293 .function = http_cli_process,
294 .type = VLIB_NODE_TYPE_PROCESS,
295 .process_log2_n_stack_bytes = 16,
296 .runtime_data_bytes = sizeof (void *),
297 };
298
299 name = (char *) format (0, "http-cli-%d", l);
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]300 r.name = name;
301 vlib_register_node (vm, &r);
302 vec_free (name);
303
304 n = vlib_get_node (vm, r.index);
305 }
306
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]307 /* Save the node index in the args. It won't be zero. */
308 args->node_index = n->index;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]309
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]310 /* Save the args (pointer) in the node runtime */
311 save_args = vlib_node_get_runtime_data (vm, n->index);
312 *save_args = args;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]313
314 vlib_start_process (vm, n->runtime_index);
315}
316
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]317static void
318alloc_http_process_callback (void *cb_args)
319{
320 alloc_http_process ((builtin_http_server_args *) cb_args);
321}
322
323static int
324http_server_rx_callback (stream_session_t * s)
325{
326 u32 max_dequeue;
327 int actual_transfer;
328 http_server_main_t *hsm = &http_server_main;
329 svm_fifo_t *rx_fifo;
330 builtin_http_server_args *args;
331
332 rx_fifo = s->server_rx_fifo;
333 max_dequeue = svm_fifo_max_dequeue (rx_fifo);
334 svm_fifo_unset_event (rx_fifo);
335 if (PREDICT_FALSE (max_dequeue == 0))
336 return 0;
337
338 vec_validate (hsm->rx_buf, max_dequeue - 1);
339 _vec_len (hsm->rx_buf) = max_dequeue;
340
341 actual_transfer = svm_fifo_dequeue_nowait (rx_fifo, max_dequeue,
342 hsm->rx_buf);
343 ASSERT (actual_transfer > 0);
344 _vec_len (hsm->rx_buf) = actual_transfer;
345
346 /* send the command to a new/recycled vlib process */
347 args = clib_mem_alloc (sizeof (*args));
348 args->data = vec_dup (hsm->rx_buf);
349 args->session_handle = stream_session_handle (s);
350
351 /* Send an RPC request via the thread-0 input node */
352 if (vlib_get_thread_index () != 0)
353 {
354 session_fifo_event_t evt;
355 evt.rpc_args.fp = alloc_http_process_callback;
356 evt.rpc_args.arg = args;
357 evt.event_type = FIFO_EVENT_RPC;
358 unix_shared_memory_queue_add
359 (session_manager_get_vpp_event_queue (0 /* main thread */ ),
360 (u8 *) & evt, 0 /* do wait for mutex */ );
361 }
362 else
363 alloc_http_process (args);
364 return 0;
365}
366
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]367static int
368builtin_session_accept_callback (stream_session_t * s)
369{
370 http_server_main_t *bsm = &http_server_main;
371
372 bsm->vpp_queue[s->thread_index] =
373 session_manager_get_vpp_event_queue (s->thread_index);
374 s->session_state = SESSION_STATE_READY;
375 bsm->byte_index = 0;
376 return 0;
377}
378
379static void
380builtin_session_disconnect_callback (stream_session_t * s)
381{
382 http_server_main_t *bsm = &http_server_main;
383 vnet_disconnect_args_t _a, *a = &_a;
384
385 a->handle = stream_session_handle (s);
386 a->app_index = bsm->app_index;
387 vnet_disconnect_session (a);
388}
389
390static void
391builtin_session_reset_callback (stream_session_t * s)
392{
393 clib_warning ("called.. ");
394
395 stream_session_cleanup (s);
396}
397
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]398static int
399builtin_session_connected_callback (u32 app_index, u32 api_context,
400 stream_session_t * s, u8 is_fail)
401{
402 clib_warning ("called...");
403 return -1;
404}
405
406static int
407builtin_add_segment_callback (u32 client_index,
408 const u8 * seg_name, u32 seg_size)
409{
410 clib_warning ("called...");
411 return -1;
412}
413
414static int
415builtin_redirect_connect_callback (u32 client_index, void *mp)
416{
417 clib_warning ("called...");
418 return -1;
419}
420
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]421static session_cb_vft_t builtin_session_cb_vft = {
422 .session_accept_callback = builtin_session_accept_callback,
423 .session_disconnect_callback = builtin_session_disconnect_callback,
424 .session_connected_callback = builtin_session_connected_callback,
425 .add_segment_callback = builtin_add_segment_callback,
426 .redirect_connect_callback = builtin_redirect_connect_callback,
427 .builtin_server_rx_callback = http_server_rx_callback,
428 .session_reset_callback = builtin_session_reset_callback
429};
430
431/* Abuse VPP's input queue */
432static int
433create_api_loopback (vlib_main_t * vm)
434{
435 http_server_main_t *hsm = &http_server_main;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]436 api_main_t *am = &api_main;
437 vl_shmem_hdr_t *shmem_hdr;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]438
439 shmem_hdr = am->shmem_hdr;
440 hsm->vl_input_queue = shmem_hdr->vl_input_queue;
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]441 hsm->my_client_index =
442 vl_api_memclnt_create_internal ("tcp_test_client", hsm->vl_input_queue);
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]443 return 0;
444}
445
446static int
447server_attach ()
448{
449 http_server_main_t *hsm = &http_server_main;
450 u8 segment_name[128];
451 u64 options[SESSION_OPTIONS_N_OPTIONS];
452 vnet_app_attach_args_t _a, *a = &_a;
453
454 memset (a, 0, sizeof (*a));
455 memset (options, 0, sizeof (options));
456
457 a->api_client_index = hsm->my_client_index;
458 a->session_cb_vft = &builtin_session_cb_vft;
459 a->options = options;
460 a->options[SESSION_OPTIONS_SEGMENT_SIZE] = 128 << 20;
461 a->options[SESSION_OPTIONS_RX_FIFO_SIZE] = 8 << 10;
462 a->options[SESSION_OPTIONS_TX_FIFO_SIZE] = 32 << 10;
463 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_BUILTIN_APP;
Dave Barach10d8cc62017-05-30 09:30:07 -0400[diff] [blame]464 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] = 16;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]465 a->segment_name = segment_name;
466 a->segment_name_length = ARRAY_LEN (segment_name);
467
468 if (vnet_application_attach (a))
469 {
470 clib_warning ("failed to attach server");
471 return -1;
472 }
473 hsm->app_index = a->app_index;
474 return 0;
475}
476
477static int
478server_listen ()
479{
480 http_server_main_t *hsm = &http_server_main;
481 vnet_bind_args_t _a, *a = &_a;
482 memset (a, 0, sizeof (*a));
483 a->app_index = hsm->app_index;
484 a->uri = "tcp://0.0.0.0/80";
485 return vnet_bind_uri (a);
486}
487
488static int
489server_create (vlib_main_t * vm)
490{
491 http_server_main_t *hsm = &http_server_main;
492 u32 num_threads;
493 vlib_thread_main_t *vtm = vlib_get_thread_main ();
494
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]495 ASSERT (hsm->my_client_index == (u32) ~ 0);
496 if (create_api_loopback (vm))
497 return -1;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]498
499 num_threads = 1 /* main thread */ + vtm->n_threads;
500 vec_validate (http_server_main.vpp_queue, num_threads - 1);
501
502 if (server_attach ())
503 {
504 clib_warning ("failed to attach server");
505 return -1;
506 }
507 if (server_listen ())
508 {
509 clib_warning ("failed to start listening");
510 return -1;
511 }
512 return 0;
513}
514
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]515static clib_error_t *
516server_create_command_fn (vlib_main_t * vm,
517 unformat_input_t * input, vlib_cli_command_t * cmd)
518{
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]519 http_server_main_t *hsm = &http_server_main;
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]520 int rv;
521
Florin Coras0e9c33b2017-08-14 22:33:41 -0700[diff] [blame]522 if (hsm->my_client_index != (u32) ~ 0)
523 return clib_error_return (0, "test http server is already running");
524
Dave Barach1015a1e2017-05-08 19:15:03 -0400[diff] [blame]525 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
526 rv = server_create (vm);
527 switch (rv)
528 {
529 case 0:
530 break;
531 default:
532 return clib_error_return (0, "server_create returned %d", rv);
533 }
534 return 0;
535}
536
537/* *INDENT-OFF* */
538VLIB_CLI_COMMAND (server_create_command, static) =
539{
540 .path = "test http server",
541 .short_help = "test http server",
542 .function = server_create_command_fn,
543};
544/* *INDENT-ON* */
545
546static clib_error_t *
547builtin_http_server_main_init (vlib_main_t * vm)
548{
549 http_server_main_t *hsm = &http_server_main;
550 hsm->my_client_index = ~0;
551 hsm->vlib_main = vm;
552
553 return 0;
554}
555
556VLIB_INIT_FUNCTION (builtin_http_server_main_init);
557
558/*
559* fd.io coding-style-patch-verification: ON
560*
561* Local Variables:
562* eval: (c-set-style "gnu")
563* End:
564*/