src/vpp/api/api_main.c

   1 #include "vat.h"
   2
   3 vat_main_t vat_main;
   4
   5 void
   6 vat_suspend (vlib_main_t * vm, f64 interval)
   7 {
   8   vlib_process_suspend (vm, interval);
   9 }
  10
  11 static u8 *
  12 format_api_error (u8 * s, va_list * args)
  13 {
  14   vat_main_t *vam = va_arg (*args, vat_main_t *);
  15   i32 error = va_arg (*args, u32);
  16   uword *p;
  17
  18   p = hash_get (vam->error_string_by_error_number, -error);
  19
  20   if (p)
  21     s = format (s, "%s", p[0]);
  22   else
  23     s = format (s, "%d", error);
  24   return s;
  25 }
  26
  27
  28 static void
  29 init_error_string_table (vat_main_t * vam)
  30 {
  31
  32   vam->error_string_by_error_number = hash_create (0, sizeof (uword));
  33
  34 #define _(n,v,s) hash_set (vam->error_string_by_error_number, -v, s);
  35   foreach_vnet_api_error;
  36 #undef _
  37
  38   hash_set (vam->error_string_by_error_number, 99, "Misc");
  39 }
  40
  41 static clib_error_t *
  42 api_main_init (vlib_main_t * vm)
  43 {
  44   vat_main_t *vam = &vat_main;
  45   int rv;
  46   int vat_plugin_init (vat_main_t * vam);
  47
  48   vam->vlib_main = vm;
  49   vam->my_client_index = (u32) ~ 0;
  50   /* Ensure that vam->inbuf is never NULL */
  51   vec_validate (vam->inbuf, 0);
  52   init_error_string_table (vam);
  53   rv = vat_plugin_init (vam);
  54   if (rv)
  55     clib_warning ("vat_plugin_init returned %d", rv);
  56   return 0;
  57 }
  58
  59 VLIB_INIT_FUNCTION (api_main_init);
  60
  61 void
  62 vat_plugin_hash_create (void)
  63 {
  64   vat_main_t *vam = &vat_main;
  65
  66   vam->sw_if_index_by_interface_name = hash_create_string (0, sizeof (uword));
  67   vam->function_by_name = hash_create_string (0, sizeof (uword));
  68   vam->help_by_name = hash_create_string (0, sizeof (uword));
  69 }
  70
  71 static clib_error_t *
  72 api_command_fn (vlib_main_t * vm,
  73                 unformat_input_t * input, vlib_cli_command_t * cmd)
  74 {
  75   vat_main_t *vam = &vat_main;
  76   unformat_input_t _input;
  77   uword c;
  78   u8 *cmdp, *argsp, *this_cmd;
  79   uword *p;
  80   u32 arg_len;
  81   int rv;
  82   int (*fp) (vat_main_t *);
  83   api_main_t *am = &api_main;
  84
  85   vam->vl_input_queue = am->shmem_hdr->vl_input_queue;
  86
  87   /* vec_validated in the init routine */
  88   _vec_len (vam->inbuf) = 0;
  89
  90   vam->input = &_input;
  91
  92   while (((c = unformat_get_input (input)) != '\n') &&
  93          (c != UNFORMAT_END_OF_INPUT))
  94     vec_add1 (vam->inbuf, c);
  95
  96   /* Null-terminate the command */
  97   vec_add1 (vam->inbuf, 0);
  98
  99   /* In case no args given */
 100   vec_add1 (vam->inbuf, 0);
 101
 102   /* Split input into cmd + args */
 103   this_cmd = cmdp = vam->inbuf;
 104
 105   /* Skip leading whitespace */
 106   while (cmdp < (this_cmd + vec_len (this_cmd)))
 107     {
 108       if (*cmdp == ' ' || *cmdp == '\t' || *cmdp == '\n')
 109         {
 110           cmdp++;
 111         }
 112       else
 113         break;
 114     }
 115
 116   argsp = cmdp;
 117
 118   /* Advance past the command */
 119   while (argsp < (this_cmd + vec_len (this_cmd)))
 120     {
 121       if (*argsp != ' ' && *argsp != '\t' && *argsp != '\n' && *argsp != 0)
 122         {
 123           argsp++;
 124         }
 125       else
 126         break;
 127     }
 128   /* NULL terminate the command */
 129   *argsp++ = 0;
 130
 131   /* No arguments? Ensure that argsp points to a proper (empty) string */
 132   if (argsp == (this_cmd + vec_len (this_cmd) - 1))
 133     argsp[0] = 0;
 134   else
 135     while (argsp < (this_cmd + vec_len (this_cmd)))
 136       {
 137         if (*argsp == ' ' || *argsp == '\t' || *argsp == '\n')
 138           {
 139             argsp++;
 140           }
 141         else
 142           break;
 143       }
 144
 145   /* Blank input line? */
 146   if (*cmdp == 0)
 147     return 0;
 148
 149   p = hash_get_mem (vam->function_by_name, cmdp);
 150   if (p == 0)
 151     {
 152       return clib_error_return (0, "'%s': function not found\n", cmdp);
 153     }
 154
 155   arg_len = strlen ((char *) argsp);
 156
 157   unformat_init_string (vam->input, (char *) argsp, arg_len);
 158   fp = (void *) p[0];
 159
 160   rv = (*fp) (vam);
 161
 162   if (rv < 0)
 163     {
 164       unformat_free (vam->input);
 165       return clib_error_return (0,
 166                                 "%s error: %U\n", cmdp,
 167                                 format_api_error, vam, rv);
 168
 169     }
 170   if (vam->regenerate_interface_table)
 171     {
 172       vam->regenerate_interface_table = 0;
 173       api_sw_interface_dump (vam);
 174     }
 175   unformat_free (vam->input);
 176   return 0;
 177 }
 178
 179 /* *INDENT-OFF* */
 180 VLIB_CLI_COMMAND (api_command, static) =
 181 {
 182   .path = "binary-api",
 183   .short_help = "binary-api [help] <name> [<args>]",
 184   .function = api_command_fn,
 185 };
 186 /* *INDENT-ON* */
 187
 188 void
 189 api_cli_output (void *notused, const char *fmt, ...)
 190 {
 191   va_list va;
 192   vat_main_t *vam = &vat_main;
 193   vlib_main_t *vm = vam->vlib_main;
 194   vlib_process_t *cp = vlib_get_current_process (vm);
 195   u8 *s;
 196
 197   va_start (va, fmt);
 198   s = va_format (0, fmt, &va);
 199   va_end (va);
 200
 201   /* Terminate with \n if not present. */
 202   if (vec_len (s) > 0 && s[vec_len (s) - 1] != '\n')
 203     vec_add1 (s, '\n');
 204
 205   if ((!cp) || (!cp->output_function))
 206     fformat (stdout, "%v", s);
 207   else
 208     cp->output_function (cp->output_function_arg, s, vec_len (s));
 209
 210   vec_free (s);
 211 }
 212
 213 u16
 214 vl_client_get_first_plugin_msg_id (const char *plugin_name)
 215 {
 216   api_main_t *am = &api_main;
 217   vl_api_msg_range_t *rp;
 218   uword *p;
 219
 220   p = hash_get_mem (am->msg_range_by_name, plugin_name);
 221   if (p == 0)
 222     return ~0;
 223
 224   rp = vec_elt_at_index (am->msg_ranges, p[0]);
 225
 226   return (rp->first_msg_id);
 227 }
 228
 229 uword
 230 unformat_sw_if_index (unformat_input_t * input, va_list * args)
 231 {
 232   u32 *result = va_arg (*args, u32 *);
 233   vnet_main_t *vnm = vnet_get_main ();
 234   u32 sw_if_index = ~0;
 235
 236   if (unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
 237     {
 238       *result = sw_if_index;
 239       return 1;
 240     }
 241   return 0;
 242 }
 243
 244 /*
 245  * fd.io coding-style-patch-verification: ON
 246  *
 247  * Local Variables:
 248  * eval: (c-set-style "gnu")
 249  * End:
 250  */