src/vat/main.c

   1 /*
   2  * Copyright (c) 2015 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 #include "vat.h"
  16 #include "plugin.h"
  17 #include <signal.h>
  18 #include <limits.h>
  19
  20 vat_main_t vat_main;
  21
  22 #include <vlibapi/api_helper_macros.h>
  23
  24 void
  25 vat_suspend (vlib_main_t * vm, f64 interval)
  26 {
  27   /* do nothing in the standalone version, just return */
  28 }
  29
  30 int
  31 connect_to_vpe (char *name)
  32 {
  33   vat_main_t *vam = &vat_main;
  34   api_main_t *am = vlibapi_get_main ();
  35
  36   if (vl_client_connect_to_vlib ("/vpe-api", name, 32) < 0)
  37     return -1;
  38
  39   vam->vl_input_queue = am->shmem_hdr->vl_input_queue;
  40   vam->my_client_index = am->my_client_index;
  41
  42   return 0;
  43 }
  44
  45 /* *INDENT-OFF* */
  46
  47 vlib_global_main_t vlib_global_main;
  48
  49 void
  50 vlib_cli_output (struct vlib_main_t *vm, char *fmt, ...)
  51 {
  52   clib_warning ("BUG");
  53 }
  54
  55 static u8 *
  56 format_api_error (u8 * s, va_list * args)
  57 {
  58   vat_main_t *vam = va_arg (*args, vat_main_t *);
  59   i32 error = va_arg (*args, u32);
  60   uword *p;
  61
  62   p = hash_get (vam->error_string_by_error_number, -error);
  63
  64   if (p)
  65     s = format (s, "%s", p[0]);
  66   else
  67     s = format (s, "%d", error);
  68   return s;
  69 }
  70
  71 void
  72 do_one_file (vat_main_t * vam)
  73 {
  74   int rv;
  75   int (*fp) (vat_main_t * vam);
  76   int arg_len;
  77   unformat_input_t _input;
  78   u8 *cmdp, *argsp;
  79   uword *p;
  80   u8 *this_cmd = 0;
  81
  82   vam->input = &_input;
  83
  84   /* Used by the "quit" command handler */
  85   if (setjmp (vam->jump_buf) != 0)
  86     return;
  87
  88   vam->jump_buf_set = 1;
  89
  90   while (1)
  91     {
  92       if (vam->ifp == stdin)
  93         {
  94           if (vam->exec_mode == 0)
  95             rv = write (1, "vat# ", 5);
  96           else
  97             rv = write (1, "exec# ", 6);
  98         }
  99
 100       _vec_len (vam->inbuf) = 4096;
 101
 102       if (vam->do_exit ||
 103           fgets ((char *) vam->inbuf, vec_len (vam->inbuf), vam->ifp) == 0)
 104         break;
 105
 106       vam->input_line_number++;
 107
 108       vec_free (this_cmd);
 109
 110       this_cmd =
 111         (u8 *) clib_macro_eval (&vam->macro_main, (i8 *) vam->inbuf,
 112                                 1 /* complain */ ,
 113                                 0 /* level */ ,
 114                                 8 /* max_level */ );
 115
 116       if (vam->exec_mode == 0)
 117         {
 118           /* Split input into cmd + args */
 119           cmdp = this_cmd;
 120
 121           while (cmdp < (this_cmd + vec_len (this_cmd)))
 122             {
 123               if (*cmdp == ' ' || *cmdp == '\t' || *cmdp == '\n')
 124                 {
 125                   cmdp++;
 126                 }
 127               else
 128                 break;
 129             }
 130           argsp = cmdp;
 131           while (argsp < (this_cmd + vec_len (this_cmd)))
 132             {
 133               if (*argsp != ' ' && *argsp != '\t' && *argsp != '\n')
 134                 {
 135                   argsp++;
 136                 }
 137               else
 138                 break;
 139             }
 140           *argsp++ = 0;
 141           while (argsp < (this_cmd + vec_len (this_cmd)))
 142             {
 143               if (*argsp == ' ' || *argsp == '\t' || *argsp == '\n')
 144                 {
 145                   argsp++;
 146                 }
 147               else
 148                 break;
 149             }
 150
 151
 152           /* Blank input line? */
 153           if (*cmdp == 0)
 154             continue;
 155
 156           p = hash_get_mem (vam->function_by_name, cmdp);
 157           if (p == 0)
 158             {
 159               errmsg ("'%s': function not found\n", cmdp);
 160               continue;
 161             }
 162
 163           arg_len = strlen ((char *) argsp);
 164
 165           unformat_init_string (vam->input, (char *) argsp, arg_len);
 166           fp = (void *) p[0];
 167         }
 168       else
 169         {
 170           unformat_init_string (vam->input, (char *) this_cmd,
 171                                 strlen ((char *) this_cmd));
 172           cmdp = this_cmd;
 173           fp = exec;
 174         }
 175
 176       rv = (*fp) (vam);
 177       if (rv < 0)
 178         errmsg ("%s error: %U\n", cmdp, format_api_error, vam, rv);
 179       unformat_free (vam->input);
 180
 181       if (vam->regenerate_interface_table)
 182         {
 183           vam->regenerate_interface_table = 0;
 184           api_sw_interface_dump (vam);
 185         }
 186
 187       /* Hack to pick up new client index after memfd_segment_create pivot */
 188       if (vam->client_index_invalid)
 189         {
 190           vat_main_t *vam = &vat_main;
 191           api_main_t *am = vlibapi_get_main ();
 192
 193           vam->vl_input_queue = am->shmem_hdr->vl_input_queue;
 194           vam->my_client_index = am->my_client_index;
 195           vam->client_index_invalid = 0;
 196         }
 197     }
 198 }
 199
 200 static void
 201 init_error_string_table (vat_main_t * vam)
 202 {
 203
 204   vam->error_string_by_error_number = hash_create (0, sizeof (uword));
 205
 206 #define _(n,v,s) hash_set (vam->error_string_by_error_number, -v, s);
 207   foreach_vnet_api_error;
 208 #undef _
 209
 210   hash_set (vam->error_string_by_error_number, 99, "Misc");
 211 }
 212
 213 static i8 *
 214 eval_current_file (clib_macro_main_t * mm, i32 complain)
 215 {
 216   vat_main_t *vam = &vat_main;
 217   return ((i8 *) format (0, "%s%c", vam->current_file, 0));
 218 }
 219
 220 static i8 *
 221 eval_current_line (clib_macro_main_t * mm, i32 complain)
 222 {
 223   vat_main_t *vam = &vat_main;
 224   return ((i8 *) format (0, "%d%c", vam->input_line_number, 0));
 225 }
 226
 227 static void
 228 signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
 229 {
 230   vat_main_t *vam = &vat_main;
 231
 232   switch (signum)
 233     {
 234       /* these (caught) signals cause the application to exit */
 235     case SIGINT:
 236     case SIGTERM:
 237       if (vam->jump_buf_set)
 238         {
 239           vam->do_exit = 1;
 240           return;
 241         }
 242
 243       /* FALLTHROUGH on purpose */
 244
 245     default:
 246       break;
 247     }
 248
 249   _exit (1);
 250 }
 251
 252 static void
 253 setup_signal_handlers (void)
 254 {
 255   uword i;
 256   struct sigaction sa;
 257
 258   for (i = 1; i < 32; i++)
 259     {
 260       clib_memset (&sa, 0, sizeof (sa));
 261       sa.sa_sigaction = (void *) signal_handler;
 262       sa.sa_flags = SA_SIGINFO;
 263
 264       switch (i)
 265         {
 266           /* these signals take the default action */
 267         case SIGABRT:
 268         case SIGKILL:
 269         case SIGSTOP:
 270         case SIGUSR1:
 271         case SIGUSR2:
 272         case SIGPROF:
 273           continue;
 274
 275           /* ignore SIGPIPE, SIGCHLD */
 276         case SIGPIPE:
 277         case SIGCHLD:
 278         case SIGWINCH:
 279           sa.sa_sigaction = (void *) SIG_IGN;
 280           break;
 281
 282           /* catch and handle all other signals */
 283         default:
 284           break;
 285         }
 286
 287       if (sigaction (i, &sa, 0) < 0)
 288         clib_unix_warning ("sigaction %U", format_signal, i);
 289     }
 290 }
 291
 292 static void
 293 vat_find_plugin_path ()
 294 {
 295   char *p, path[PATH_MAX];
 296   int rv;
 297   u8 *s;
 298
 299   /* find executable path */
 300   if ((rv = readlink ("/proc/self/exe", path, PATH_MAX - 1)) == -1)
 301     return;
 302
 303   /* readlink doesn't provide null termination */
 304   path[rv] = 0;
 305
 306   /* strip filename */
 307   if ((p = strrchr (path, '/')) == 0)
 308     return;
 309   *p = 0;
 310
 311   /* strip bin/ */
 312   if ((p = strrchr (path, '/')) == 0)
 313     return;
 314   *p = 0;
 315
 316   s = format (0, "%s/lib/" CLIB_TARGET_TRIPLET "/vpp_api_test_plugins:"
 317               "%s/lib/vpp_api_test_plugins", path, path);
 318   vec_add1 (s, 0);
 319   vat_plugin_path = (char *) s;
 320 }
 321
 322 static void
 323 load_features (void)
 324 {
 325   vat_registered_features_t *f;
 326   vat_main_t *vam = &vat_main;
 327   clib_error_t *error;
 328
 329   f = vam->feature_function_registrations;
 330
 331   while (f)
 332     {
 333       error = f->function (vam);
 334       if (error)
 335         {
 336           clib_warning ("INIT FAILED");
 337         }
 338       f = f->next;
 339     }
 340 }
 341
 342 static inline clib_error_t *
 343 call_init_exit_functions_internal (vlib_main_t *vm,
 344                                    _vlib_init_function_list_elt_t **headp,
 345                                    int call_once, int do_sort, int is_global)
 346 {
 347   vlib_global_main_t *vgm = vlib_get_global_main ();
 348   clib_error_t *error = 0;
 349   _vlib_init_function_list_elt_t *i;
 350
 351   ASSERT (is_global == 1);
 352
 353 #if 0
 354   /* Not worth copying the topological sort code */
 355   if (do_sort && (error = vlib_sort_init_exit_functions (headp)))
 356     return (error);
 357 #endif
 358
 359   i = *headp;
 360   while (i)
 361     {
 362       if (call_once && !hash_get (vgm->init_functions_called, i->f))
 363         {
 364           if (call_once)
 365             hash_set1 (vgm->init_functions_called, i->f);
 366           error = i->f (vm);
 367           if (error)
 368             return error;
 369         }
 370       i = i->next_init_function;
 371     }
 372   return error;
 373 }
 374
 375 clib_error_t *
 376 vlib_call_init_exit_functions (vlib_main_t *vm,
 377                                _vlib_init_function_list_elt_t **headp,
 378                                int call_once, int is_global)
 379 {
 380   return call_init_exit_functions_internal (vm, headp, call_once,
 381                                             1 /* do_sort */, is_global);
 382 }
 383
 384 int
 385 main (int argc, char **argv)
 386 {
 387   vlib_global_main_t *vgm = vlib_get_global_main ();
 388   vat_main_t *vam = &vat_main;
 389   unformat_input_t _argv, *a = &_argv;
 390   u8 **input_files = 0;
 391   u8 *output_file = 0;
 392   u8 *chroot_prefix;
 393   u8 *this_input_file;
 394   u8 interactive = 1;
 395   u8 json_output = 0;
 396   int i;
 397   f64 timeout;
 398   clib_error_t *error;
 399   vlib_main_t *vm;
 400
 401   clib_mem_init_thread_safe (0, 128 << 20);
 402   vlib_main_init ();
 403   vm = vlib_get_first_main ();
 404
 405   clib_macro_init (&vam->macro_main);
 406   clib_macro_add_builtin (&vam->macro_main, "current_file",
 407                           eval_current_file);
 408   clib_macro_add_builtin (&vam->macro_main, "current_line",
 409                           eval_current_line);
 410
 411   init_error_string_table (vam);
 412   vec_validate (vam->cmd_reply, 0);
 413   vec_reset_length (vam->cmd_reply);
 414
 415   vat_find_plugin_path ();
 416
 417   unformat_init_command_line (a, argv);
 418
 419   while (unformat_check_input (a) != UNFORMAT_END_OF_INPUT)
 420     {
 421       if (unformat (a, "in %s", &this_input_file))
 422         vec_add1 (input_files, this_input_file);
 423       else if (unformat (a, "out %s", &output_file))
 424         ;
 425       else if (unformat (a, "script"))
 426         interactive = 0;
 427       else if (unformat (a, "json"))
 428         json_output = 1;
 429       else if (unformat (a, "socket-name %s", &vam->socket_name))
 430         ;
 431       else if (unformat (a, "default-socket"))
 432         {
 433           vam->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
 434         }
 435       else if (unformat (a, "plugin_path %s", (u8 *) & vat_plugin_path))
 436         vec_add1 (vat_plugin_path, 0);
 437       else if (unformat (a, "plugin_name_filter %s",
 438                          (u8 *) & vat_plugin_name_filter))
 439         vec_add1 (vat_plugin_name_filter, 0);
 440       else if (unformat (a, "chroot prefix %s", &chroot_prefix))
 441         {
 442           vl_set_memory_root_path ((char *) chroot_prefix);
 443         }
 444       else
 445         {
 446           fformat
 447             (stderr,
 448              "%s: usage [in <f1> ... in <fn>] [out <fn>] [script] [json]\n"
 449              "[plugin_path <path>][default-socket][socket-name <name>]\n"
 450              "[plugin_name_filter <filter>][chroot prefix <path>]\n",
 451              argv[0]);
 452           exit (1);
 453         }
 454     }
 455
 456   if (output_file)
 457     vam->ofp = fopen ((char *) output_file, "w");
 458   else
 459     vam->ofp = stdout;
 460
 461   if (vam->ofp == NULL)
 462     {
 463       fformat (stderr, "Couldn't open output file %s\n",
 464                output_file ? (char *) output_file : "stdout");
 465       exit (1);
 466     }
 467
 468   clib_time_init (&vam->clib_time);
 469
 470   vat_api_hookup (vam);
 471   vat_plugin_api_reference ();
 472
 473   setup_signal_handlers ();
 474
 475   if (vam->socket_name && vat_socket_connect (vam))
 476     fformat (stderr, "WARNING: socket connection failed");
 477
 478   if ((!vam->socket_client_main || vam->socket_client_main->socket_fd == 0)
 479       && connect_to_vpe ("vpp_api_test") < 0)
 480     {
 481       svm_region_exit ();
 482       fformat (stderr, "Couldn't connect to vpe, exiting...\n");
 483       exit (1);
 484     }
 485
 486   vam->json_output = json_output;
 487
 488   if (!json_output)
 489     api_sw_interface_dump (vam);
 490
 491   vec_validate (vam->inbuf, 4096);
 492
 493   load_features ();
 494
 495   vam->current_file = (u8 *) "plugin-init";
 496   vat_plugin_init (vam);
 497
 498   /* Set up the init function hash table */
 499   vgm->init_functions_called = hash_create (0, 0);
 500
 501   /* Execute plugin init and api_init functions */
 502   error = vlib_call_init_exit_functions (vm, &vgm->init_function_registrations,
 503                                          1 /* call once */, 1 /* is_global*/);
 504
 505   if (error)
 506     clib_error_report (error);
 507
 508   error =
 509     vlib_call_init_exit_functions (vm, &vgm->api_init_function_registrations,
 510                                    1 /* call_once */, 1 /* is_global */);
 511
 512   if (error)
 513     clib_error_report (error);
 514
 515   for (i = 0; i < vec_len (input_files); i++)
 516     {
 517       vam->ifp = fopen ((char *) input_files[i], "r");
 518       if (vam->ifp == NULL)
 519         {
 520           fformat (stderr, "Couldn't open input file %s\n", input_files[i]);
 521           continue;
 522         }
 523       vam->current_file = input_files[i];
 524       vam->input_line_number = 0;
 525       do_one_file (vam);
 526       fclose (vam->ifp);
 527     }
 528
 529   if (output_file)
 530     fclose (vam->ofp);
 531
 532   if (interactive)
 533     {
 534       vam->ifp = stdin;
 535       vam->ofp = stdout;
 536       vam->current_file = (u8 *) "interactive";
 537       do_one_file (vam);
 538       fclose (vam->ifp);
 539     }
 540
 541   /*
 542    * Particularly when running a script, don't be in a hurry to leave.
 543    * A reply message queued to this process will end up constipating
 544    * the allocation rings.
 545    */
 546   timeout = vat_time_now (vam) + 2.0;
 547   while (vam->result_ready == 0 && vat_time_now (vam) < timeout)
 548     ;
 549
 550   if (vat_time_now (vam) > timeout)
 551     clib_warning ("BUG: message reply spin-wait timeout");
 552
 553   vl_client_disconnect_from_vlib ();
 554   exit (0);
 555 }
 556
 557 /*
 558  * fd.io coding-style-patch-verification: ON
 559  *
 560  * Local Variables:
 561  * eval: (c-set-style "gnu")
 562  * End:
 563  */