2 *------------------------------------------------------------------
3 * Copyright (c) 2018 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
20 #include <sys/types.h>
23 #include <vlibapi/api.h>
24 #include <vlibmemory/api.h>
27 vl_api_show_histogram_command (vlib_main_t * vm,
28 unformat_input_t * input,
29 vlib_cli_command_t * cli_cmd)
34 for (i = 0; i < SLEEP_N_BUCKETS; i++)
36 total_counts += vector_rate_histogram[i];
39 if (total_counts == 0)
41 vlib_cli_output (vm, "No control-plane activity.");
48 percent = ((f64) vector_rate_histogram[SLEEP_##n##_US]) \
49 / (f64) total_counts; \
51 vlib_cli_output (vm, "Sleep %3d us: %llu, %.2f%%",n, \
52 vector_rate_histogram[SLEEP_##n##_US], \
55 foreach_histogram_bucket;
62 * Display the binary api sleep-time histogram
65 VLIB_CLI_COMMAND (cli_show_api_histogram_command, static) =
67 .path = "show api histogram",
68 .short_help = "show api histogram",
69 .function = vl_api_show_histogram_command,
74 vl_api_clear_histogram_command (vlib_main_t * vm,
75 unformat_input_t * input,
76 vlib_cli_command_t * cli_cmd)
80 for (i = 0; i < SLEEP_N_BUCKETS; i++)
81 vector_rate_histogram[i] = 0;
86 * Clear the binary api sleep-time histogram
89 VLIB_CLI_COMMAND (cli_clear_api_histogram_command, static) =
91 .path = "clear api histogram",
92 .short_help = "clear api histogram",
93 .function = vl_api_clear_histogram_command,
98 vl_api_client_command (vlib_main_t * vm,
99 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
101 vl_api_registration_t **regpp, *regp;
104 api_main_t *am = vlibapi_get_main ();
105 u32 *confused_indices = 0;
107 if (!pool_elts (am->vl_clients))
109 vlib_cli_output (vm, "Shared memory clients");
110 vlib_cli_output (vm, "%20s %8s %14s %18s %s",
111 "Name", "PID", "Queue Length", "Queue VA", "Health");
114 pool_foreach (regpp, am->vl_clients,
120 if (regp->unanswered_pings > 0)
121 health = "questionable";
125 q = regp->vl_input_queue;
127 vlib_cli_output (vm, "%20s %8d %14d 0x%016llx %s\n",
128 regp->name, q->consumer_pid, q->cursize,
133 clib_warning ("NULL client registration index %d",
134 regpp - am->vl_clients);
135 vec_add1 (confused_indices, regpp - am->vl_clients);
140 /* This should "never happen," but if it does, fix it... */
141 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
144 for (i = 0; i < vec_len (confused_indices); i++)
146 pool_put_index (am->vl_clients, confused_indices[i]);
149 vec_free (confused_indices);
151 if (am->missing_clients)
152 vlib_cli_output (vm, "%u messages with missing clients",
153 am->missing_clients);
155 vl_sock_api_dump_clients (vm, am);
160 static clib_error_t *
161 vl_api_status_command (vlib_main_t * vm,
162 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
164 api_main_t *am = vlibapi_get_main ();
166 /* check if rx_trace and tx_trace are not null pointers */
167 if (am->rx_trace == 0)
169 vlib_cli_output (vm, "RX Trace disabled\n");
173 if (am->rx_trace->enabled == 0)
174 vlib_cli_output (vm, "RX Trace disabled\n");
176 vlib_cli_output (vm, "RX Trace enabled\n");
179 if (am->tx_trace == 0)
181 vlib_cli_output (vm, "TX Trace disabled\n");
185 if (am->tx_trace->enabled == 0)
186 vlib_cli_output (vm, "TX Trace disabled\n");
188 vlib_cli_output (vm, "TX Trace enabled\n");
195 VLIB_CLI_COMMAND (cli_show_api_command, static) =
198 .short_help = "Show API information",
203 * Display current api client connections
206 VLIB_CLI_COMMAND (cli_show_api_clients_command, static) =
208 .path = "show api clients",
209 .short_help = "Client information",
210 .function = vl_api_client_command,
215 * Display the current api message tracing status
218 VLIB_CLI_COMMAND (cli_show_api_status_command, static) =
220 .path = "show api trace-status",
221 .short_help = "Display API trace status",
222 .function = vl_api_status_command,
226 static clib_error_t *
227 vl_api_message_table_command (vlib_main_t * vm,
228 unformat_input_t * input,
229 vlib_cli_command_t * cli_cmd)
231 api_main_t *am = vlibapi_get_main ();
235 if (unformat (input, "verbose"))
240 vlib_cli_output (vm, "%-4s %s", "ID", "Name");
242 vlib_cli_output (vm, "%-4s %-40s %6s %7s", "ID", "Name", "Bounce",
245 for (i = 1; i < vec_len (am->msg_names); i++)
249 vlib_cli_output (vm, "%-4d %s", i,
250 am->msg_names[i] ? am->msg_names[i] :
255 vlib_cli_output (vm, "%-4d %-40s %6d %7d", i,
256 am->msg_names[i] ? am->msg_names[i] :
257 " [no handler]", am->message_bounce[i],
266 * Display the current api message decode tables
269 VLIB_CLI_COMMAND (cli_show_api_message_table_command, static) =
271 .path = "show api message-table",
272 .short_help = "Message Table",
273 .function = vl_api_message_table_command,
278 range_compare (vl_api_msg_range_t * a0, vl_api_msg_range_t * a1)
280 int len0, len1, clen;
282 len0 = vec_len (a0->name);
283 len1 = vec_len (a1->name);
284 clen = len0 < len1 ? len0 : len1;
285 return (strncmp ((char *) a0->name, (char *) a1->name, clen));
289 format_api_msg_range (u8 * s, va_list * args)
291 vl_api_msg_range_t *rp = va_arg (*args, vl_api_msg_range_t *);
294 s = format (s, "%-50s%9s%9s", "Name", "First-ID", "Last-ID");
296 s = format (s, "%-50s%9d%9d", rp->name, rp->first_msg_id,
302 static clib_error_t *
303 vl_api_show_plugin_command (vlib_main_t * vm,
304 unformat_input_t * input,
305 vlib_cli_command_t * cli_cmd)
307 api_main_t *am = vlibapi_get_main ();
308 vl_api_msg_range_t *rp = 0;
311 if (vec_len (am->msg_ranges) == 0)
313 vlib_cli_output (vm, "No plugin API message ranges configured...");
317 rp = vec_dup (am->msg_ranges);
319 vec_sort_with_function (rp, range_compare);
321 vlib_cli_output (vm, "Plugin API message ID ranges...\n");
322 vlib_cli_output (vm, "%U", format_api_msg_range, 0 /* header */ );
324 for (i = 0; i < vec_len (rp); i++)
325 vlib_cli_output (vm, "%U", format_api_msg_range, rp + i);
333 * Display the plugin binary API message range table
336 VLIB_CLI_COMMAND (cli_show_api_plugin_command, static) =
338 .path = "show api plugin",
339 .short_help = "show api plugin",
340 .function = vl_api_show_plugin_command,
353 format_vl_msg_api_trace_status (u8 * s, va_list * args)
355 api_main_t *am = va_arg (*args, api_main_t *);
356 vl_api_trace_which_t which = va_arg (*args, vl_api_trace_which_t);
362 case VL_API_TRACE_TX:
364 trace_name = "TX trace";
367 case VL_API_TRACE_RX:
369 trace_name = "RX trace";
378 s = format (s, "%s: not yet configured.\n", trace_name);
382 s = format (s, "%s: used %d of %d items, %s enabled, %s wrapped\n",
383 trace_name, vec_len (tp->traces), tp->nitems,
384 tp->enabled ? "is" : "is not", tp->wrapped ? "has" : "has not");
388 void vl_msg_api_custom_dump_configure (api_main_t * am)
389 __attribute__ ((weak));
391 vl_msg_api_custom_dump_configure (api_main_t * am)
396 vl_msg_api_process_file (vlib_main_t * vm, u8 * filename,
397 u32 first_index, u32 last_index,
398 vl_api_replay_t which)
400 vl_api_trace_file_header_t *hp;
405 api_main_t *am = vlibapi_get_main ();
407 u32 nitems, nitems_msgtbl;
408 void **saved_print_handlers = 0;
410 fd = open ((char *) filename, O_RDONLY);
414 vlib_cli_output (vm, "Couldn't open %s\n", filename);
418 if (fstat (fd, &statb) < 0)
420 vlib_cli_output (vm, "Couldn't stat %s\n", filename);
425 if (!(statb.st_mode & S_IFREG) || (statb.st_size < sizeof (*hp)))
427 vlib_cli_output (vm, "File not plausible: %s\n", filename);
432 file_size = statb.st_size;
433 file_size = (file_size + 4095) & ~(4096);
435 hp = mmap (0, file_size, PROT_READ, MAP_PRIVATE, fd, 0);
437 if (hp == (vl_api_trace_file_header_t *) MAP_FAILED)
439 vlib_cli_output (vm, "mmap failed: %s\n", filename);
445 nitems = ntohl (hp->nitems);
447 if (last_index == (u32) ~ 0)
449 last_index = nitems - 1;
452 if (first_index >= nitems || last_index >= nitems)
454 vlib_cli_output (vm, "Range (%d, %d) outside file range (0, %d)\n",
455 first_index, last_index, nitems - 1);
456 munmap (hp, file_size);
461 "Note: wrapped/incomplete trace, results may vary\n");
463 if (which == CUSTOM_DUMP)
465 saved_print_handlers = (void **) vec_dup (am->msg_print_handlers);
466 vl_msg_api_custom_dump_configure (am);
468 msg = (u8 *) (hp + 1);
471 serialize_main_t _sm, *sm = &_sm;
472 u32 msgtbl_size = ntohl (hp->msgtbl_size);
475 unserialize_open_data (sm, msg, msgtbl_size);
476 unserialize_integer (sm, &nitems_msgtbl, sizeof (u32));
478 for (i = 0; i < nitems_msgtbl; i++)
480 u16 msg_index = unserialize_likely_small_unsigned_integer (sm);
481 unserialize_cstring (sm, (char **) &name_and_crc);
482 u16 msg_index2 = vl_msg_api_get_msg_index (name_and_crc);
483 vec_validate (msgid_vec, msg_index);
484 msgid_vec[msg_index] = msg_index2;
489 for (i = 0; i < first_index; i++)
495 size = clib_host_to_net_u32 (*(u32 *) msg);
498 msg_id = ntohs (*((u16 *) msg));
499 if (msg_id < vec_len (msgid_vec))
500 msg_id = msgid_vec[msg_id];
501 cfgp = am->api_trace_cfg + msg_id;
504 vlib_cli_output (vm, "Ugh: msg id %d no trace config\n", msg_id);
505 munmap (hp, file_size);
512 am->replay_in_progress = 1;
514 for (; i <= last_index; i++)
521 vlib_cli_output (vm, "---------- trace %d -----------\n", i);
523 size = clib_host_to_net_u32 (*(u32 *) msg);
526 msg_id = ntohs (*((u16 *) msg));
527 if (msg_id < vec_len (msgid_vec))
529 msg_id = msgid_vec[msg_id];
532 cfgp = am->api_trace_cfg + msg_id;
535 vlib_cli_output (vm, "Ugh: msg id %d no trace config\n", msg_id);
536 munmap (hp, file_size);
538 am->replay_in_progress = 0;
542 /* Copy the buffer (from the read-only mmap'ed file) */
543 vec_validate (tmpbuf, size - 1 + sizeof (uword));
544 clib_memcpy (tmpbuf + sizeof (uword), msg, size);
545 clib_memset (tmpbuf, 0xf, sizeof (uword));
548 * Endian swap if needed. All msg data is supposed to be in
549 * network byte order.
551 if (((which == DUMP || which == CUSTOM_DUMP)
552 && clib_arch_is_little_endian))
554 void (*endian_fp) (void *);
555 if (msg_id >= vec_len (am->msg_endian_handlers)
556 || (am->msg_endian_handlers[msg_id] == 0))
558 vlib_cli_output (vm, "Ugh: msg id %d no endian swap\n", msg_id);
559 munmap (hp, file_size);
561 am->replay_in_progress = 0;
564 endian_fp = am->msg_endian_handlers[msg_id];
565 (*endian_fp) (tmpbuf + sizeof (uword));
568 /* msg_id always in network byte order */
569 if (clib_arch_is_little_endian)
571 u16 *msg_idp = (u16 *) (tmpbuf + sizeof (uword));
579 if (msg_id < vec_len (am->msg_print_handlers) &&
580 am->msg_print_handlers[msg_id])
582 u8 *(*print_fp) (void *, void *);
584 print_fp = (void *) am->msg_print_handlers[msg_id];
585 (*print_fp) (tmpbuf + sizeof (uword), vm);
589 vlib_cli_output (vm, "Skipping msg id %d: no print fcn\n",
596 if (msg_id < vec_len (am->msg_print_handlers) &&
597 am->msg_print_handlers[msg_id])
601 u8 *(*print_fp) (void *, void *);
603 print_fp = (void *) am->msg_print_handlers[msg_id];
605 vlib_cli_output (vm, "/*");
607 (*print_fp) (tmpbuf + sizeof (uword), vm);
608 vlib_cli_output (vm, "*/\n");
610 s = format (0, "static u8 * vl_api_%s_%d[%d] = {",
611 am->msg_names[msg_id], i,
612 am->api_trace_cfg[msg_id].size);
614 for (j = 0; j < am->api_trace_cfg[msg_id].size; j++)
617 s = format (s, "\n ");
618 s = format (s, "0x%02x,", tmpbuf[sizeof (uword) + j]);
620 s = format (s, "\n};\n%c", 0);
621 vlib_cli_output (vm, (char *) s);
627 if (msg_id < vec_len (am->msg_print_handlers) &&
628 am->msg_print_handlers[msg_id] && cfgp->replay_enable)
630 void (*handler) (void *, vlib_main_t *);
632 handler = (void *) am->msg_handlers[msg_id];
634 if (!am->is_mp_safe[msg_id])
635 vl_msg_api_barrier_sync ();
636 (*handler) (tmpbuf + sizeof (uword), vm);
637 if (!am->is_mp_safe[msg_id])
638 vl_msg_api_barrier_release ();
642 if (cfgp->replay_enable)
643 vlib_cli_output (vm, "Skipping msg id %d: no handler\n",
650 _vec_len (tmpbuf) = 0;
654 if (saved_print_handlers)
656 clib_memcpy (am->msg_print_handlers, saved_print_handlers,
657 vec_len (am->msg_print_handlers) * sizeof (void *));
658 vec_free (saved_print_handlers);
661 munmap (hp, file_size);
663 am->replay_in_progress = 0;
666 static clib_error_t *
667 api_trace_command_fn (vlib_main_t * vm,
668 unformat_input_t * input, vlib_cli_command_t * cmd)
670 u32 nitems = 256 << 10;
671 api_main_t *am = vlibapi_get_main ();
672 vl_api_trace_which_t which = VL_API_TRACE_RX;
674 u8 *chroot_filename = 0;
676 u32 last = (u32) ~ 0;
680 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
682 if (unformat (input, "on") || unformat (input, "enable"))
684 if (unformat (input, "nitems %d", &nitems))
686 vl_msg_api_trace_configure (am, which, nitems);
687 vl_msg_api_trace_onoff (am, which, 1 /* on */ );
689 else if (unformat (input, "off"))
691 vl_msg_api_trace_onoff (am, which, 0);
693 else if (unformat (input, "save %s", &filename))
695 if (strstr ((char *) filename, "..")
696 || index ((char *) filename, '/'))
698 vlib_cli_output (vm, "illegal characters in filename '%s'",
703 chroot_filename = format (0, "/tmp/%s%c", filename, 0);
707 fp = fopen ((char *) chroot_filename, "w");
710 vlib_cli_output (vm, "Couldn't create %s\n", chroot_filename);
713 rv = vl_msg_api_trace_save (am, which, fp);
716 vlib_cli_output (vm, "API Trace data not present\n");
718 vlib_cli_output (vm, "File for writing is closed\n");
720 vlib_cli_output (vm, "Error while writing header to file\n");
722 vlib_cli_output (vm, "Error while writing trace to file\n");
725 "Error while writing end of buffer trace to file\n");
728 "Error while writing start of buffer trace to file\n");
730 vlib_cli_output (vm, "Unknown error while saving: %d", rv);
732 vlib_cli_output (vm, "API trace saved to %s\n", chroot_filename);
735 else if (unformat (input, "dump %s", &filename))
737 vl_msg_api_process_file (vm, filename, first, last, DUMP);
739 else if (unformat (input, "custom-dump %s", &filename))
741 vl_msg_api_process_file (vm, filename, first, last, CUSTOM_DUMP);
743 else if (unformat (input, "replay %s", &filename))
745 vl_msg_api_process_file (vm, filename, first, last, REPLAY);
747 else if (unformat (input, "initializers %s", &filename))
749 vl_msg_api_process_file (vm, filename, first, last, INITIALIZERS);
751 else if (unformat (input, "tx"))
753 which = VL_API_TRACE_TX;
755 else if (unformat (input, "first %d", &first))
759 else if (unformat (input, "last %d", &last))
763 else if (unformat (input, "status"))
765 vlib_cli_output (vm, "%U", format_vl_msg_api_trace_status,
768 else if (unformat (input, "free"))
770 vl_msg_api_trace_onoff (am, which, 0);
771 vl_msg_api_trace_free (am, which);
773 else if (unformat (input, "post-mortem-on"))
774 vl_msg_api_post_mortem_dump_enable_disable (1 /* enable */ );
775 else if (unformat (input, "post-mortem-off"))
776 vl_msg_api_post_mortem_dump_enable_disable (0 /* enable */ );
778 return clib_error_return (0, "unknown input `%U'",
779 format_unformat_error, input);
783 vec_free (chroot_filename);
788 * Display, replay, or save a binary API trace
792 VLIB_CLI_COMMAND (api_trace_command, static) =
795 .short_help = "api trace [on|off][first <n>][last <n>][status][free]"
796 "[post-mortem-on][dump|custom-dump|save|replay <file>]",
797 .function = api_trace_command_fn,
801 static clib_error_t *
802 vl_api_trace_command (vlib_main_t * vm,
803 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
806 vl_api_trace_which_t which = VL_API_TRACE_RX;
807 api_main_t *am = vlibapi_get_main ();
809 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
811 if (unformat (input, "rx nitems %u", &nitems) || unformat (input, "rx"))
813 else if (unformat (input, "tx nitems %u", &nitems)
814 || unformat (input, "tx"))
816 which = VL_API_TRACE_RX;
819 else if (unformat (input, "on rx"))
821 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 1);
823 else if (unformat (input, "on tx"))
825 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 1);
827 else if (unformat (input, "on"))
829 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 1);
831 else if (unformat (input, "off"))
833 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 0);
834 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 0);
836 else if (unformat (input, "free"))
838 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 0);
839 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 0);
840 vl_msg_api_trace_free (am, VL_API_TRACE_RX);
841 vl_msg_api_trace_free (am, VL_API_TRACE_TX);
843 else if (unformat (input, "debug on"))
845 am->msg_print_flag = 1;
847 else if (unformat (input, "debug off"))
849 am->msg_print_flag = 0;
852 return clib_error_return (0, "unknown input `%U'",
853 format_unformat_error, input);
858 if (vl_msg_api_trace_configure (am, which, nitems))
860 vlib_cli_output (vm, "warning: trace configure error (%d, %d)",
868 * Control the binary API trace mechanism
871 VLIB_CLI_COMMAND (trace, static) =
873 .path = "set api-trace",
874 .short_help = "API trace [on][on tx][on rx][off][free][debug on][debug off]",
875 .function = vl_api_trace_command,
879 static clib_error_t *
880 api_trace_config_fn (vlib_main_t * vm, unformat_input_t * input)
882 u32 nitems = 256 << 10;
883 vl_api_trace_which_t which = VL_API_TRACE_RX;
884 api_main_t *am = vlibapi_get_main ();
886 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
888 if (unformat (input, "on") || unformat (input, "enable"))
890 if (unformat (input, "nitems %d", &nitems))
892 vl_msg_api_trace_configure (am, which, nitems);
893 vl_msg_api_trace_onoff (am, which, 1 /* on */ );
894 vl_msg_api_post_mortem_dump_enable_disable (1 /* enable */ );
896 else if (unformat (input, "save-api-table %s",
897 &am->save_msg_table_filename))
900 return clib_error_return (0, "unknown input `%U'",
901 format_unformat_error, input);
907 * This module has three configuration parameters:
908 * "on" or "enable" - enables binary api tracing
909 * "nitems <nnn>" - sets the size of the circular buffer to <nnn>
910 * "save-api-table <filename>" - dumps the API message table to /tmp/<filename>
912 VLIB_CONFIG_FUNCTION (api_trace_config_fn, "api-trace");
914 static clib_error_t *
915 api_queue_config_fn (vlib_main_t * vm, unformat_input_t * input)
917 api_main_t *am = vlibapi_get_main ();
920 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
922 if (unformat (input, "length %d", &nitems) ||
923 (unformat (input, "len %d", &nitems)))
926 am->vlib_input_queue_length = nitems;
928 clib_warning ("vlib input queue length %d too small, ignored",
932 return clib_error_return (0, "unknown input `%U'",
933 format_unformat_error, input);
938 VLIB_CONFIG_FUNCTION (api_queue_config_fn, "api-queue");
941 extract_name (u8 * s)
947 while (vec_len (rv) && rv[vec_len (rv)] != '_')
950 rv[vec_len (rv)] = 0;
963 for (i = vec_len (rv) - 1; i >= 0; i--)
967 vec_delete (rv, i + 1, 0);
981 } msg_table_unserialize_t;
984 table_id_cmp (void *a1, void *a2)
986 msg_table_unserialize_t *n1 = a1;
987 msg_table_unserialize_t *n2 = a2;
989 return (n1->msg_index - n2->msg_index);
993 table_name_and_crc_cmp (void *a1, void *a2)
995 msg_table_unserialize_t *n1 = a1;
996 msg_table_unserialize_t *n2 = a2;
998 return strcmp ((char *) n1->name_and_crc, (char *) n2->name_and_crc);
1001 static clib_error_t *
1002 dump_api_table_file_command_fn (vlib_main_t * vm,
1003 unformat_input_t * input,
1004 vlib_cli_command_t * cmd)
1007 api_main_t *am = vlibapi_get_main ();
1008 serialize_main_t _sm, *sm = &_sm;
1009 clib_error_t *error;
1013 int compare_current = 0;
1014 int numeric_sort = 0;
1015 msg_table_unserialize_t *table = 0, *item;
1017 u32 ndifferences = 0;
1019 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1021 if (unformat (input, "file %s", &filename))
1023 else if (unformat (input, "compare-current")
1024 || unformat (input, "compare"))
1025 compare_current = 1;
1026 else if (unformat (input, "numeric"))
1029 return clib_error_return (0, "unknown input `%U'",
1030 format_unformat_error, input);
1033 if (numeric_sort && compare_current)
1034 return clib_error_return
1035 (0, "Comparison and numeric sorting are incompatible");
1038 return clib_error_return (0, "File not specified");
1040 /* Load the serialized message table from the table dump */
1042 error = unserialize_open_clib_file (sm, (char *) filename);
1047 unserialize_integer (sm, &nmsgs, sizeof (u32));
1049 for (i = 0; i < nmsgs; i++)
1051 msg_index = unserialize_likely_small_unsigned_integer (sm);
1052 unserialize_cstring (sm, (char **) &name_and_crc);
1053 vec_add2 (table, item, 1);
1054 item->msg_index = msg_index;
1055 item->name_and_crc = name_and_crc;
1056 item->name = extract_name (name_and_crc);
1057 item->crc = extract_crc (name_and_crc);
1058 item->which = 0; /* file */
1060 unserialize_close (sm);
1062 /* Compare with the current image? */
1063 if (compare_current)
1065 /* Append the current message table */
1066 u8 *tblv = vl_api_serialize_message_table (am, 0);
1068 serialize_open_vector (sm, tblv);
1069 unserialize_integer (sm, &nmsgs, sizeof (u32));
1071 for (i = 0; i < nmsgs; i++)
1073 msg_index = unserialize_likely_small_unsigned_integer (sm);
1074 unserialize_cstring (sm, (char **) &name_and_crc);
1076 vec_add2 (table, item, 1);
1077 item->msg_index = msg_index;
1078 item->name_and_crc = name_and_crc;
1079 item->name = extract_name (name_and_crc);
1080 item->crc = extract_crc (name_and_crc);
1081 item->which = 1; /* current_image */
1086 /* Sort the table. */
1088 vec_sort_with_function (table, table_id_cmp);
1090 vec_sort_with_function (table, table_name_and_crc_cmp);
1092 if (compare_current)
1098 * In this case, the recovered table will have two entries per
1099 * API message. So, if entries i and i+1 match, the message definitions
1100 * are identical. Otherwise, the crc is different, or a message is
1101 * present in only one of the tables.
1103 vlib_cli_output (vm, "%-60s | %s", "Message Name", "Result");
1104 vec_validate_init_empty (dashes, 60, '-');
1105 vec_terminate_c_string (dashes);
1106 vlib_cli_output (vm, "%60s-|-%s", dashes, "-----------------");
1108 for (i = 0; i < vec_len (table);)
1110 /* Last message lonely? */
1111 if (i == vec_len (table) - 1)
1117 /* Identical pair? */
1119 ((char *) table[i].name_and_crc,
1120 (char *) table[i + 1].name_and_crc,
1121 vec_len (table[i].name_and_crc)))
1129 /* Only in one of two tables? */
1130 if (i + 1 == vec_len (table)
1131 || strcmp ((char *) table[i].name, (char *) table[i + 1].name))
1134 vlib_cli_output (vm, "%-60s | only in %s",
1135 table[i].name, table[i].which ?
1140 /* In both tables, but with different signatures */
1141 vlib_cli_output (vm, "%-60s | definition changed", table[i].name);
1144 if (ndifferences == 0)
1145 vlib_cli_output (vm, "No api message signature differences found.");
1147 vlib_cli_output (vm, "\nFound %u api message signature differences",
1152 /* Dump the table, sorted as shown above */
1153 vlib_cli_output (vm, "%=60s %=8s %=10s", "Message name", "MsgID", "CRC");
1155 for (i = 0; i < vec_len (table); i++)
1158 vlib_cli_output (vm, "%-60s %8u %10s", item->name,
1159 item->msg_index, item->crc);
1163 for (i = 0; i < vec_len (table); i++)
1165 vec_free (table[i].name_and_crc);
1166 vec_free (table[i].name);
1167 vec_free (table[i].crc);
1176 * Displays a serialized API message decode table, sorted by message name
1179 * @cliexstart{show api dump file <filename>}
1180 * Message name MsgID CRC
1181 * accept_session 407 8e2a127e
1182 * accept_session_reply 408 67d8c22a
1183 * add_node_next 549 e4202993
1184 * add_node_next_reply 550 e89d6eed
1190 * Compares a serialized API message decode table with the current image
1193 * @cliexstart{show api dump file <filename> compare}
1194 * ip_add_del_route definition changed
1195 * ip_table_add_del definition changed
1196 * l2_macs_event only in image
1197 * vnet_ip4_fib_counters only in file
1198 * vnet_ip4_nbr_counters only in file
1203 * Display a serialized API message decode table, compare a saved
1204 * decode table with the current image, to establish API differences.
1208 VLIB_CLI_COMMAND (dump_api_table_file, static) =
1210 .path = "show api dump",
1211 .short_help = "show api dump file <filename> [numeric | compare-current]",
1212 .function = dump_api_table_file_command_fn,
1217 * fd.io coding-style-patch-verification: ON
1220 * eval: (c-set-style "gnu")