src/vnet/dev/format.c

   1 /* SPDX-License-Identifier: Apache-2.0
   2  * Copyright (c) 2023 Cisco Systems, Inc.
   3  */
   4
   5 #include <vnet/vnet.h>
   6 #include <vnet/dev/dev.h>
   7 #include <vnet/dev/counters.h>
   8 #include <vnet/ethernet/ethernet.h>
   9
  10 u8 *
  11 format_vnet_dev_rv (u8 *s, va_list *args)
  12 {
  13   vnet_dev_rv_t rv = va_arg (*args, vnet_dev_rv_t);
  14   u32 index = -rv;
  15
  16   char *strings[] = { [0] = "OK",
  17 #define _(n, d) [-VNET_DEV_ERR_##n] = d,
  18                       foreach_vnet_dev_rv_type
  19 #undef _
  20   };
  21
  22   if (index >= ARRAY_LEN (strings))
  23     return format (s, "unknown return value (%d)", rv);
  24   return format (s, "%s", strings[index]);
  25 }
  26
  27 u8 *
  28 format_vnet_dev_addr (u8 *s, va_list *args)
  29 {
  30   vnet_dev_main_t *dm = &vnet_dev_main;
  31   vnet_dev_t *dev = va_arg (*args, vnet_dev_t *);
  32   vnet_dev_bus_t *bus;
  33
  34   if (dev == 0)
  35     return 0;
  36
  37   bus = pool_elt_at_index (dm->buses, dev->bus_index);
  38   s = format (s, "%U", bus->ops.format_device_addr, dev);
  39
  40   return s;
  41 }
  42
  43 u8 *
  44 format_vnet_dev_interface_name (u8 *s, va_list *args)
  45 {
  46   u32 i = va_arg (*args, u32);
  47   vnet_dev_port_t *port = vnet_dev_get_port_from_dev_instance (i);
  48
  49   return format (s, "%s", port->intf.name);
  50 }
  51
  52 u8 *
  53 format_vnet_dev_info (u8 *s, va_list *args)
  54 {
  55   vnet_dev_format_args_t *a = va_arg (*args, vnet_dev_format_args_t *);
  56   vlib_main_t *vm = vlib_get_main ();
  57   vnet_dev_main_t *dm = &vnet_dev_main;
  58   vnet_dev_t *dev = va_arg (*args, vnet_dev_t *);
  59   vnet_dev_driver_t *dr = pool_elt_at_index (dm->drivers, dev->driver_index);
  60   vnet_dev_bus_t *bus = pool_elt_at_index (dm->buses, dev->bus_index);
  61
  62   u32 indent = format_get_indent (s);
  63   s = format (s, "Driver is '%s', bus is '%s'", dr->registration->name,
  64               bus->registration->name);
  65
  66   if (dev->description)
  67     s = format (s, ", description is '%v'", dev->description);
  68
  69   if (bus->ops.format_device_info)
  70     s = format (s, "\n%U%U", format_white_space, indent,
  71                 bus->ops.format_device_info, a, dev);
  72
  73   s = format (s, "\n%UAssigned process node is '%U'", format_white_space,
  74               indent, format_vlib_node_name, vm, dev->process_node_index);
  75   if (dev->args)
  76     s = format (s, "\n%UDevice Specific Arguments:\n%U%U", format_white_space,
  77                 indent, format_white_space, indent + 2, format_vnet_dev_args,
  78                 dev->args);
  79   if (dev->ops.format_info)
  80     s =
  81       format (s, "\n%UDevice Specific Info:\n%U%U", format_white_space, indent,
  82               format_white_space, indent + 2, dev->ops.format_info, a, dev);
  83   return s;
  84 }
  85
  86 u8 *
  87 format_vnet_dev_hw_addr (u8 *s, va_list *args)
  88 {
  89   vnet_dev_hw_addr_t *addr = va_arg (*args, vnet_dev_hw_addr_t *);
  90   return format (s, "%U", format_ethernet_address, addr->eth_mac);
  91 }
  92
  93 u8 *
  94 format_vnet_dev_port_info (u8 *s, va_list *args)
  95 {
  96   vnet_dev_format_args_t *a = va_arg (*args, vnet_dev_format_args_t *);
  97   vlib_main_t *vm = vlib_get_main ();
  98   vnet_main_t *vnm = vnet_get_main ();
  99   vnet_dev_port_t *port = va_arg (*args, vnet_dev_port_t *);
 100
 101   u32 indent = format_get_indent (s);
 102
 103   s = format (s, "Hardware Address is %U", format_vnet_dev_hw_addr,
 104               &port->attr.hw_addr);
 105   s = format (s, ", %u RX queues (max %u), %u TX queues (max %u)",
 106               pool_elts (port->rx_queues), port->attr.max_rx_queues,
 107               pool_elts (port->tx_queues), port->attr.max_tx_queues);
 108   if (pool_elts (port->secondary_hw_addr))
 109     {
 110       u32 i = 0;
 111       vnet_dev_hw_addr_t *a;
 112       s = format (s, "\n%USecondary Hardware Address%s:", format_white_space,
 113                   indent,
 114                   pool_elts (port->secondary_hw_addr) > 1 ? "es are" : " is");
 115       pool_foreach (a, port->secondary_hw_addr)
 116         {
 117           if (i++ % 6 == 0)
 118             s = format (s, "\n%U", format_white_space, indent + 1);
 119           s = format (s, " %U", format_vnet_dev_hw_addr, a);
 120         }
 121     }
 122   s = format (s, "\n%UMax RX frame size is %u (max supported %u)",
 123               format_white_space, indent, port->max_rx_frame_size,
 124               port->attr.max_supported_rx_frame_size);
 125   s = format (s, "\n%UCaps: %U", format_white_space, indent,
 126               format_vnet_dev_port_caps, &port->attr.caps);
 127   s = format (s, "\n%URX Offloads: %U", format_white_space, indent,
 128               format_vnet_dev_port_rx_offloads, &port->attr.rx_offloads);
 129   s = format (s, "\n%UTX Offloads: %U", format_white_space, indent,
 130               format_vnet_dev_port_tx_offloads, &port->attr.tx_offloads);
 131   if (port->port_ops.format_status)
 132     s = format (s, "\n%UDevice Specific Port Status:\n%U%U",
 133                 format_white_space, indent, format_white_space, indent + 2,
 134                 port->port_ops.format_status, a, port);
 135   if (port->args)
 136     s = format (s, "\n%UDevice Specific Port Arguments:\n%U%U",
 137                 format_white_space, indent, format_white_space, indent + 2,
 138                 format_vnet_dev_args, port->args);
 139
 140   s = format (s, "\n%UInterface ", format_white_space, indent);
 141   if (port->interface_created)
 142     {
 143       s = format (s, "assigned, interface name is '%U', RX node is '%U'",
 144                   format_vnet_sw_if_index_name, vnm, port->intf.sw_if_index,
 145                   format_vlib_node_name, vm, port->intf.rx_node_index);
 146     }
 147   else
 148     s = format (s, "not assigned");
 149   return s;
 150 }
 151
 152 u8 *
 153 format_vnet_dev_rx_queue_info (u8 *s, va_list *args)
 154 {
 155   vnet_dev_format_args_t __clib_unused *a =
 156     va_arg (*args, vnet_dev_format_args_t *);
 157   vnet_dev_rx_queue_t *rxq = va_arg (*args, vnet_dev_rx_queue_t *);
 158   u32 indent = format_get_indent (s);
 159
 160   s = format (s, "Size is %u, buffer pool index is %u", rxq->size,
 161               vnet_dev_get_rx_queue_buffer_pool_index (rxq));
 162   s = format (s, "\n%UPolling thread is %u, %sabled, %sstarted, %s mode",
 163               format_white_space, indent, rxq->rx_thread_index,
 164               rxq->enabled ? "en" : "dis", rxq->started ? "" : "not-",
 165               rxq->interrupt_mode ? "interrupt" : "polling");
 166
 167   return s;
 168 }
 169
 170 u8 *
 171 format_vnet_dev_tx_queue_info (u8 *s, va_list *args)
 172 {
 173   vnet_dev_format_args_t __clib_unused *a =
 174     va_arg (*args, vnet_dev_format_args_t *);
 175   vnet_dev_tx_queue_t *txq = va_arg (*args, vnet_dev_tx_queue_t *);
 176   u32 indent = format_get_indent (s);
 177   u32 n;
 178
 179   s = format (s, "Size is %u", txq->size);
 180   s = format (s, "\n%U", format_white_space, indent);
 181   n = clib_bitmap_count_set_bits (txq->assigned_threads);
 182   if (n == 0)
 183     s = format (s, "Not used by any thread");
 184   else
 185     s = format (s, "Used by thread%s %U", n > 1 ? "s" : "", format_bitmap_list,
 186                 txq->assigned_threads);
 187
 188   return s;
 189 }
 190
 191 u8 *
 192 format_vnet_dev_interface_info (u8 *s, va_list *args)
 193 {
 194   u32 i = va_arg (*args, u32);
 195   vnet_dev_format_args_t fa = {}, *a = &fa;
 196   vnet_dev_port_t *port = vnet_dev_get_port_from_dev_instance (i);
 197   vnet_dev_t *dev = port->dev;
 198   u32 indent = format_get_indent (s);
 199
 200   s = format (s, "Device:");
 201   s = format (s, "\n%U%U", format_white_space, indent + 2,
 202               format_vnet_dev_info, a, dev);
 203
 204   s = format (s, "\n%UPort %u:", format_white_space, indent, port->port_id);
 205   s = format (s, "\n%U%U", format_white_space, indent + 2,
 206               format_vnet_dev_port_info, a, port);
 207
 208   foreach_vnet_dev_port_rx_queue (q, port)
 209     {
 210       s = format (s, "\n%URX queue %u:", format_white_space, indent + 2,
 211                   q->queue_id);
 212       s = format (s, "\n%U%U", format_white_space, indent + 4,
 213                   format_vnet_dev_rx_queue_info, a, q);
 214     }
 215
 216   foreach_vnet_dev_port_tx_queue (q, port)
 217     {
 218       s = format (s, "\n%UTX queue %u:", format_white_space, indent + 2,
 219                   q->queue_id);
 220       s = format (s, "\n%U%U", format_white_space, indent + 4,
 221                   format_vnet_dev_tx_queue_info, a, q);
 222     }
 223   return s;
 224 }
 225
 226 static u64
 227 unformat_flags (unformat_input_t *input, char *names[], u64 val[], u32 n_flags)
 228 {
 229   u64 rv = 0;
 230   uword c = 0;
 231   u8 *s = 0;
 232
 233   while ((c = unformat_get_input (input)) != UNFORMAT_END_OF_INPUT)
 234     {
 235       switch (c)
 236         {
 237         case 'a' ... 'z':
 238           c -= 'a' - 'A';
 239         case '0' ... '9':
 240         case 'A' ... 'Z':
 241           vec_add1 (s, c);
 242           break;
 243         case '-':
 244           vec_add1 (s, '_');
 245           break;
 246         case ',':
 247           vec_add1 (s, 0);
 248           break;
 249         default:
 250           goto end_of_string;
 251         }
 252     }
 253 end_of_string:
 254
 255   if (s == 0)
 256     return 0;
 257
 258   vec_add1 (s, 0);
 259
 260   for (u8 *p = s, *end = vec_end (s); p < end; p += strlen ((char *) p) + 1)
 261     {
 262       for (c = 0; c < n_flags; c++)
 263         if (strcmp (names[c], (char *) p) == 0)
 264           {
 265             rv |= val[c];
 266             break;
 267           }
 268       if (c == n_flags)
 269         goto done;
 270     }
 271
 272 done:
 273   vec_free (s);
 274   return rv;
 275 }
 276
 277 uword
 278 unformat_vnet_dev_flags (unformat_input_t *input, va_list *args)
 279 {
 280   vnet_dev_flags_t *fp = va_arg (*args, vnet_dev_flags_t *);
 281   u64 val;
 282
 283   char *names[] = {
 284 #define _(b, n, d) #n,
 285     foreach_vnet_dev_flag
 286 #undef _
 287   };
 288   u64 vals[] = {
 289 #define _(b, n, d) 1ull << (b)
 290     foreach_vnet_dev_flag
 291 #undef _
 292   };
 293
 294   val = unformat_flags (input, names, vals, ARRAY_LEN (names));
 295
 296   if (!val)
 297     return 0;
 298
 299   fp->n = val;
 300   return 1;
 301 }
 302
 303 uword
 304 unformat_vnet_dev_port_flags (unformat_input_t *input, va_list *args)
 305 {
 306   vnet_dev_port_flags_t *fp = va_arg (*args, vnet_dev_port_flags_t *);
 307   u64 val;
 308
 309   char *flag_names[] = {
 310 #define _(b, n, d) #n,
 311     foreach_vnet_dev_port_flag
 312 #undef _
 313   };
 314   u64 flag_values[] = {
 315 #define _(b, n, d) 1ull << (b)
 316     foreach_vnet_dev_port_flag
 317 #undef _
 318   };
 319
 320   val =
 321     unformat_flags (input, flag_names, flag_values, ARRAY_LEN (flag_names));
 322
 323   if (!val)
 324     return 0;
 325
 326   fp->n = val;
 327   return 1;
 328 }
 329
 330 static u8 *
 331 format_flags (u8 *s, u64 val, char *flag_names[], u64 flag_values[],
 332               u32 n_flags)
 333 {
 334   u32 n = 0;
 335   for (int i = 0; i < n_flags; i++)
 336     {
 337       if ((val & flag_values[i]) == 0)
 338         continue;
 339
 340       if (n++)
 341         vec_add1 (s, ' ');
 342
 343       for (char *c = flag_names[i]; c[0] != 0; c++)
 344         {
 345           switch (c[0])
 346             {
 347             case 'A' ... 'Z':
 348               vec_add1 (s, c[0] + 'a' - 'A');
 349               break;
 350             case '_':
 351               vec_add1 (s, '-');
 352               break;
 353             default:
 354               vec_add1 (s, c[0]);
 355             }
 356         }
 357     }
 358
 359   return s;
 360 }
 361
 362 u8 *
 363 format_vnet_dev_flags (u8 *s, va_list *args)
 364 {
 365   vnet_dev_flags_t *fp = va_arg (*args, vnet_dev_flags_t *);
 366   char *flag_names[] = {
 367 #define _(b, n, d) #n,
 368     foreach_vnet_dev_flag
 369 #undef _
 370   };
 371   u64 flag_values[] = {
 372 #define _(b, n, d) 1ull << (b)
 373     foreach_vnet_dev_flag
 374 #undef _
 375   };
 376
 377   return format_flags (s, fp->n, flag_names, flag_values,
 378                        ARRAY_LEN (flag_names));
 379 }
 380
 381 u8 *
 382 format_vnet_dev_port_flags (u8 *s, va_list *args)
 383 {
 384   vnet_dev_port_flags_t *fp = va_arg (*args, vnet_dev_port_flags_t *);
 385   char *flag_names[] = {
 386 #define _(b, n, d) #n,
 387     foreach_vnet_dev_port_flag
 388 #undef _
 389   };
 390   u64 flag_values[] = {
 391 #define _(b, n, d) 1ull << (b)
 392     foreach_vnet_dev_port_flag
 393 #undef _
 394   };
 395
 396   return format_flags (s, fp->n, flag_names, flag_values,
 397                        ARRAY_LEN (flag_names));
 398 }
 399
 400 u8 *
 401 format_vnet_dev_log (u8 *s, va_list *args)
 402 {
 403   vnet_dev_t *dev = va_arg (*args, vnet_dev_t *);
 404   char *func = va_arg (*args, char *);
 405
 406   if (dev)
 407     s = format (s, "%U", format_vnet_dev_addr, dev);
 408   if (dev && func)
 409     vec_add1 (s, ' ');
 410   if (func)
 411     s = format (s, "%s", func);
 412   vec_add1 (s, ':');
 413   vec_add1 (s, ' ');
 414   return s;
 415 }
 416
 417 u8 *
 418 format_vnet_dev_port_caps (u8 *s, va_list *args)
 419 {
 420   vnet_dev_port_caps_t *c = va_arg (*args, vnet_dev_port_caps_t *);
 421   u32 line = 0;
 422
 423   if (c->as_number == 0)
 424     return s;
 425
 426 #define _(n)                                                                  \
 427   if (c->n)                                                                   \
 428     {                                                                         \
 429       if (line++)                                                             \
 430         vec_add1 (s, ' ');                                                    \
 431       for (char *str = #n; *str; str++)                                       \
 432         vec_add1 (s, *str == '_' ? '-' : *str);                               \
 433     }
 434   foreach_vnet_dev_port_caps;
 435 #undef _
 436
 437   return s;
 438 }
 439
 440 u8 *
 441 format_vnet_dev_port_rx_offloads (u8 *s, va_list *args)
 442 {
 443   vnet_dev_port_rx_offloads_t *c =
 444     va_arg (*args, vnet_dev_port_rx_offloads_t *);
 445   u32 line = 0;
 446
 447   if (c->as_number == 0)
 448     return s;
 449
 450 #define _(n)                                                                  \
 451   if (c->n)                                                                   \
 452     {                                                                         \
 453       if (line++)                                                             \
 454         vec_add1 (s, ' ');                                                    \
 455       for (char *str = #n; *str; str++)                                       \
 456         vec_add1 (s, *str == '_' ? '-' : *str);                               \
 457     }
 458   foreach_vnet_dev_port_rx_offloads;
 459 #undef _
 460
 461   return s;
 462 }
 463
 464 u8 *
 465 format_vnet_dev_port_tx_offloads (u8 *s, va_list *args)
 466 {
 467   vnet_dev_port_tx_offloads_t *c =
 468     va_arg (*args, vnet_dev_port_tx_offloads_t *);
 469   u32 line = 0;
 470
 471   if (c->as_number == 0)
 472     return s;
 473
 474 #define _(n)                                                                  \
 475   if (c->n)                                                                   \
 476     {                                                                         \
 477       if (line++)                                                             \
 478         vec_add1 (s, ' ');                                                    \
 479       for (char *str = #n; *str; str++)                                       \
 480         vec_add1 (s, *str == '_' ? '-' : *str);                               \
 481     }
 482   foreach_vnet_dev_port_tx_offloads;
 483 #undef _
 484
 485   return s;
 486 }