src/vnet/dev/format.c

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