src/vnet/tcp/builtin_http_server.c

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