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:
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.
22 #include <vlibapi/api_helper_macros.h>
25 vat_suspend (vlib_main_t * vm, f64 interval)
27 /* do nothing in the standalone version, just return */
31 connect_to_vpe (char *name)
33 vat_main_t *vam = &vat_main;
34 api_main_t *am = vlibapi_get_main ();
36 if (vl_client_connect_to_vlib ("/vpe-api", name, 32) < 0)
39 vam->vl_input_queue = am->shmem_hdr->vl_input_queue;
40 vam->my_client_index = am->my_client_index;
47 vlib_global_main_t vlib_global_main;
50 vlib_cli_output (struct vlib_main_t *vm, char *fmt, ...)
56 format_api_error (u8 * s, va_list * args)
58 vat_main_t *vam = va_arg (*args, vat_main_t *);
59 i32 error = va_arg (*args, u32);
62 p = hash_get (vam->error_string_by_error_number, -error);
65 s = format (s, "%s", p[0]);
67 s = format (s, "%d", error);
72 do_one_file (vat_main_t * vam)
75 int (*fp) (vat_main_t * vam);
77 unformat_input_t _input;
84 /* Used by the "quit" command handler */
85 if (setjmp (vam->jump_buf) != 0)
88 vam->jump_buf_set = 1;
92 if (vam->ifp == stdin)
94 if (vam->exec_mode == 0)
95 rv = write (1, "vat# ", 5);
97 rv = write (1, "exec# ", 6);
100 _vec_len (vam->inbuf) = 4096;
103 fgets ((char *) vam->inbuf, vec_len (vam->inbuf), vam->ifp) == 0)
106 vam->input_line_number++;
111 (u8 *) clib_macro_eval (&vam->macro_main, (i8 *) vam->inbuf,
116 if (vam->exec_mode == 0)
118 /* Split input into cmd + args */
121 while (cmdp < (this_cmd + vec_len (this_cmd)))
123 if (*cmdp == ' ' || *cmdp == '\t' || *cmdp == '\n')
131 while (argsp < (this_cmd + vec_len (this_cmd)))
133 if (*argsp != ' ' && *argsp != '\t' && *argsp != '\n')
141 while (argsp < (this_cmd + vec_len (this_cmd)))
143 if (*argsp == ' ' || *argsp == '\t' || *argsp == '\n')
152 /* Blank input line? */
156 p = hash_get_mem (vam->function_by_name, cmdp);
159 errmsg ("'%s': function not found\n", cmdp);
163 arg_len = strlen ((char *) argsp);
165 unformat_init_string (vam->input, (char *) argsp, arg_len);
170 unformat_init_string (vam->input, (char *) this_cmd,
171 strlen ((char *) this_cmd));
178 errmsg ("%s error: %U\n", cmdp, format_api_error, vam, rv);
179 unformat_free (vam->input);
181 if (vam->regenerate_interface_table)
183 vam->regenerate_interface_table = 0;
184 api_sw_interface_dump (vam);
187 /* Hack to pick up new client index after memfd_segment_create pivot */
188 if (vam->client_index_invalid)
190 vat_main_t *vam = &vat_main;
191 api_main_t *am = vlibapi_get_main ();
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;
201 init_error_string_table (vat_main_t * vam)
204 vam->error_string_by_error_number = hash_create (0, sizeof (uword));
206 #define _(n,v,s) hash_set (vam->error_string_by_error_number, -v, s);
207 foreach_vnet_api_error;
210 hash_set (vam->error_string_by_error_number, 99, "Misc");
214 eval_current_file (clib_macro_main_t * mm, i32 complain)
216 vat_main_t *vam = &vat_main;
217 return ((i8 *) format (0, "%s%c", vam->current_file, 0));
221 eval_current_line (clib_macro_main_t * mm, i32 complain)
223 vat_main_t *vam = &vat_main;
224 return ((i8 *) format (0, "%d%c", vam->input_line_number, 0));
228 signal_handler (int signum, siginfo_t * si, ucontext_t * uc)
230 vat_main_t *vam = &vat_main;
234 /* these (caught) signals cause the application to exit */
237 if (vam->jump_buf_set)
243 /* FALLTHROUGH on purpose */
253 setup_signal_handlers (void)
258 for (i = 1; i < 32; i++)
260 clib_memset (&sa, 0, sizeof (sa));
261 sa.sa_sigaction = (void *) signal_handler;
262 sa.sa_flags = SA_SIGINFO;
266 /* these signals take the default action */
275 /* ignore SIGPIPE, SIGCHLD */
279 sa.sa_sigaction = (void *) SIG_IGN;
282 /* catch and handle all other signals */
287 if (sigaction (i, &sa, 0) < 0)
288 clib_unix_warning ("sigaction %U", format_signal, i);
293 vat_find_plugin_path ()
295 char *p, path[PATH_MAX];
299 /* find executable path */
300 if ((rv = readlink ("/proc/self/exe", path, PATH_MAX - 1)) == -1)
303 /* readlink doesn't provide null termination */
307 if ((p = strrchr (path, '/')) == 0)
312 if ((p = strrchr (path, '/')) == 0)
316 s = format (0, "%s/lib/" CLIB_TARGET_TRIPLET "/vpp_api_test_plugins:"
317 "%s/lib/vpp_api_test_plugins", path, path);
319 vat_plugin_path = (char *) s;
325 vat_registered_features_t *f;
326 vat_main_t *vam = &vat_main;
329 f = vam->feature_function_registrations;
333 error = f->function (vam);
336 clib_warning ("INIT FAILED");
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)
347 vlib_global_main_t *vgm = vlib_get_global_main ();
348 clib_error_t *error = 0;
349 _vlib_init_function_list_elt_t *i;
351 ASSERT (is_global == 1);
354 /* Not worth copying the topological sort code */
355 if (do_sort && (error = vlib_sort_init_exit_functions (headp)))
362 if (call_once && !hash_get (vgm->init_functions_called, i->f))
365 hash_set1 (vgm->init_functions_called, i->f);
370 i = i->next_init_function;
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)
380 return call_init_exit_functions_internal (vm, headp, call_once,
381 1 /* do_sort */, is_global);
385 main (int argc, char **argv)
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;
401 clib_mem_init_thread_safe (0, 128 << 20);
403 vm = vlib_get_first_main ();
405 clib_macro_init (&vam->macro_main);
406 clib_macro_add_builtin (&vam->macro_main, "current_file",
408 clib_macro_add_builtin (&vam->macro_main, "current_line",
411 init_error_string_table (vam);
412 vec_validate (vam->cmd_reply, 0);
413 vec_reset_length (vam->cmd_reply);
415 vat_find_plugin_path ();
417 unformat_init_command_line (a, argv);
419 while (unformat_check_input (a) != UNFORMAT_END_OF_INPUT)
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))
425 else if (unformat (a, "script"))
427 else if (unformat (a, "json"))
429 else if (unformat (a, "socket-name %s", &vam->socket_name))
431 else if (unformat (a, "default-socket"))
433 vam->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0);
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))
442 vl_set_memory_root_path ((char *) chroot_prefix);
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",
457 vam->ofp = fopen ((char *) output_file, "w");
461 if (vam->ofp == NULL)
463 fformat (stderr, "Couldn't open output file %s\n",
464 output_file ? (char *) output_file : "stdout");
468 clib_time_init (&vam->clib_time);
470 vat_api_hookup (vam);
471 vat_plugin_api_reference ();
473 setup_signal_handlers ();
475 if (vam->socket_name && vat_socket_connect (vam))
476 fformat (stderr, "WARNING: socket connection failed");
478 if ((!vam->socket_client_main || vam->socket_client_main->socket_fd == 0)
479 && connect_to_vpe ("vpp_api_test") < 0)
482 fformat (stderr, "Couldn't connect to vpe, exiting...\n");
486 vam->json_output = json_output;
489 api_sw_interface_dump (vam);
491 vec_validate (vam->inbuf, 4096);
495 vam->current_file = (u8 *) "plugin-init";
496 vat_plugin_init (vam);
498 /* Set up the init function hash table */
499 vgm->init_functions_called = hash_create (0, 0);
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*/);
506 clib_error_report (error);
509 vlib_call_init_exit_functions (vm, &vgm->api_init_function_registrations,
510 1 /* call_once */, 1 /* is_global */);
513 clib_error_report (error);
515 for (i = 0; i < vec_len (input_files); i++)
517 vam->ifp = fopen ((char *) input_files[i], "r");
518 if (vam->ifp == NULL)
520 fformat (stderr, "Couldn't open input file %s\n", input_files[i]);
523 vam->current_file = input_files[i];
524 vam->input_line_number = 0;
536 vam->current_file = (u8 *) "interactive";
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.
546 timeout = vat_time_now (vam) + 2.0;
547 while (vam->result_ready == 0 && vat_time_now (vam) < timeout)
550 if (vat_time_now (vam) > timeout)
551 clib_warning ("BUG: message reply spin-wait timeout");
553 vl_client_disconnect_from_vlib ();
558 * fd.io coding-style-patch-verification: ON
561 * eval: (c-set-style "gnu")