src/vnet/interface_format.c

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15 /*
  16  * interface_format.c: interface formatting
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #include <vnet/vnet.h>
  41 #include <vppinfra/bitmap.h>
  42
  43 u8 *
  44 format_vnet_sw_interface_flags (u8 * s, va_list * args)
  45 {
  46   u32 flags = va_arg (*args, u32);
  47
  48   if (flags & VNET_SW_INTERFACE_FLAG_ERROR)
  49     s = format (s, "error");
  50   else if (flags & VNET_SW_INTERFACE_FLAG_BOND_SLAVE)
  51     s = format (s, "bond-slave");
  52   else
  53     {
  54       s = format (s, "%s",
  55                   (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? "up" : "down");
  56       if (flags & VNET_SW_INTERFACE_FLAG_PUNT)
  57         s = format (s, "/punt");
  58     }
  59
  60   return s;
  61 }
  62
  63 u8 *
  64 format_vnet_hw_interface_rx_mode (u8 * s, va_list * args)
  65 {
  66   vnet_hw_interface_rx_mode mode = va_arg (*args, vnet_hw_interface_rx_mode);
  67
  68   if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
  69     return format (s, "polling");
  70
  71   if (mode == VNET_HW_INTERFACE_RX_MODE_INTERRUPT)
  72     return format (s, "interrupt");
  73
  74   if (mode == VNET_HW_INTERFACE_RX_MODE_ADAPTIVE)
  75     return format (s, "adaptive");
  76
  77   return format (s, "unknown");
  78 }
  79
  80 u8 *
  81 format_vnet_hw_interface (u8 * s, va_list * args)
  82 {
  83   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
  84   vnet_hw_interface_t *hi = va_arg (*args, vnet_hw_interface_t *);
  85   vnet_hw_interface_class_t *hw_class;
  86   vnet_device_class_t *dev_class;
  87   int verbose = va_arg (*args, int);
  88   uword indent;
  89
  90   if (!hi)
  91     return format (s, "%=32s%=6s%=8s%s", "Name", "Idx", "Link", "Hardware");
  92
  93   indent = format_get_indent (s);
  94
  95   s = format (s, "%-32v%=6d", hi->name, hi->hw_if_index);
  96
  97   if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
  98     s = format (s, "%=8s", "slave");
  99   else
 100     s = format (s, "%=8s",
 101                 hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP ? "up" : "down");
 102
 103   hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
 104   dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 105
 106   if (hi->bond_info && (hi->bond_info != VNET_HW_INTERFACE_BOND_INFO_SLAVE))
 107     {
 108       int hw_idx;
 109       s = format (s, "Slave-Idx:");
 110       clib_bitmap_foreach (hw_idx, hi->bond_info, s =
 111                            format (s, " %d", hw_idx));
 112     }
 113   else if (dev_class->format_device_name)
 114     s = format (s, "%U", dev_class->format_device_name, hi->dev_instance);
 115   else
 116     s = format (s, "%s%d", dev_class->name, hi->dev_instance);
 117
 118   if (verbose)
 119     {
 120       if (hw_class->format_device)
 121         s = format (s, "\n%U%U",
 122                     format_white_space, indent + 2,
 123                     hw_class->format_device, hi->hw_if_index, verbose);
 124       else
 125         {
 126           s = format (s, "\n%U%s",
 127                       format_white_space, indent + 2, hw_class->name);
 128           if (hw_class->format_address && vec_len (hi->hw_address) > 0)
 129             s =
 130               format (s, " address %U", hw_class->format_address,
 131                       hi->hw_address);
 132         }
 133
 134       if (dev_class->format_device)
 135         s = format (s, "\n%U%U",
 136                     format_white_space, indent + 2,
 137                     dev_class->format_device, hi->dev_instance, verbose);
 138     }
 139
 140   return s;
 141 }
 142
 143 u8 *
 144 format_vnet_sw_interface_name (u8 * s, va_list * args)
 145 {
 146   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 147   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
 148   vnet_sw_interface_t *si_sup =
 149     vnet_get_sup_sw_interface (vnm, si->sw_if_index);
 150   vnet_hw_interface_t *hi_sup;
 151
 152   ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
 153   hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
 154
 155   s = format (s, "%v", hi_sup->name);
 156
 157   if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
 158     s = format (s, ".%d", si->sub.id);
 159
 160   return s;
 161 }
 162
 163 u8 *
 164 format_vnet_sw_if_index_name (u8 * s, va_list * args)
 165 {
 166   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 167   u32 sw_if_index = va_arg (*args, u32);
 168   return format (s, "%U",
 169                  format_vnet_sw_interface_name, vnm,
 170                  vnet_get_sw_interface (vnm, sw_if_index));
 171 }
 172
 173 u8 *
 174 format_vnet_sw_interface_cntrs (u8 * s, vnet_interface_main_t * im,
 175                                 vnet_sw_interface_t * si)
 176 {
 177   uword indent, n_printed;
 178   int i, j, n_counters;
 179   static vnet_main_t **my_vnet_mains;
 180
 181   vec_reset_length (my_vnet_mains);
 182
 183   indent = format_get_indent (s);
 184   n_printed = 0;
 185
 186   {
 187     vlib_combined_counter_main_t *cm;
 188     vlib_counter_t v, vtotal;
 189     u8 *n = 0;
 190
 191     for (i = 0; i < vec_len (vnet_mains); i++)
 192       {
 193         if (vnet_mains[i])
 194           vec_add1 (my_vnet_mains, vnet_mains[i]);
 195       }
 196
 197     if (vec_len (my_vnet_mains) == 0)
 198       vec_add1 (my_vnet_mains, &vnet_main);
 199
 200     /* Each vnet_main_t has its own copy of the interface counters */
 201     n_counters = vec_len (im->combined_sw_if_counters);
 202
 203     /* rx, tx counters... */
 204     for (j = 0; j < n_counters; j++)
 205       {
 206         vtotal.packets = 0;
 207         vtotal.bytes = 0;
 208
 209         for (i = 0; i < vec_len (my_vnet_mains); i++)
 210           {
 211             im = &my_vnet_mains[i]->interface_main;
 212             cm = im->combined_sw_if_counters + j;
 213             vlib_get_combined_counter (cm, si->sw_if_index, &v);
 214             vtotal.packets += v.packets;
 215             vtotal.bytes += v.bytes;
 216           }
 217
 218         /* Only display non-zero counters. */
 219         if (vtotal.packets == 0)
 220           continue;
 221
 222         if (n_printed > 0)
 223           s = format (s, "\n%U", format_white_space, indent);
 224         n_printed += 2;
 225
 226         if (n)
 227           _vec_len (n) = 0;
 228         n = format (n, "%s packets", cm->name);
 229         s = format (s, "%-16v%16Ld", n, vtotal.packets);
 230
 231         _vec_len (n) = 0;
 232         n = format (n, "%s bytes", cm->name);
 233         s = format (s, "\n%U%-16v%16Ld",
 234                     format_white_space, indent, n, vtotal.bytes);
 235       }
 236     vec_free (n);
 237   }
 238
 239   {
 240     vlib_simple_counter_main_t *cm;
 241     u64 v, vtotal;
 242
 243     n_counters = vec_len (im->sw_if_counters);
 244
 245     for (j = 0; j < n_counters; j++)
 246       {
 247         vtotal = 0;
 248
 249         for (i = 0; i < vec_len (my_vnet_mains); i++)
 250           {
 251             im = &my_vnet_mains[i]->interface_main;
 252             cm = im->sw_if_counters + j;
 253
 254             v = vlib_get_simple_counter (cm, si->sw_if_index);
 255             vtotal += v;
 256           }
 257
 258         /* Only display non-zero counters. */
 259         if (vtotal == 0)
 260           continue;
 261
 262         if (n_printed > 0)
 263           s = format (s, "\n%U", format_white_space, indent);
 264         n_printed += 1;
 265
 266         s = format (s, "%-16s%16Ld", cm->name, vtotal);
 267       }
 268   }
 269
 270   return s;
 271 }
 272
 273 u8 *
 274 format_vnet_sw_interface (u8 * s, va_list * args)
 275 {
 276   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 277   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
 278   vnet_interface_main_t *im = &vnm->interface_main;
 279
 280   if (!si)
 281     return format (s, "%=32s%=5s%=16s%=16s%=16s",
 282                    "Name", "Idx", "State", "Counter", "Count");
 283
 284   s = format (s, "%-32U%=5d%=16U",
 285               format_vnet_sw_interface_name, vnm, si, si->sw_if_index,
 286               format_vnet_sw_interface_flags, si->flags);
 287
 288   s = format_vnet_sw_interface_cntrs (s, im, si);
 289
 290   return s;
 291 }
 292
 293 u8 *
 294 format_vnet_sw_interface_name_override (u8 * s, va_list * args)
 295 {
 296   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 297   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
 298   /* caller supplied display name for this interface */
 299   u8 *name = va_arg (*args, u8 *);
 300   vnet_interface_main_t *im = &vnm->interface_main;
 301
 302
 303   if (!si)
 304     return format (s, "%=32s%=5s%=16s%=16s%=16s",
 305                    "Name", "Idx", "State", "Counter", "Count");
 306
 307   s = format (s, "%-32v%=5d%=16U",
 308               name, si->sw_if_index,
 309               format_vnet_sw_interface_flags, si->flags);
 310
 311   s = format_vnet_sw_interface_cntrs (s, im, si);
 312
 313   return s;
 314 }
 315
 316 uword
 317 unformat_vnet_hw_interface (unformat_input_t * input, va_list * args)
 318 {
 319   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 320   u32 *hw_if_index = va_arg (*args, u32 *);
 321   vnet_interface_main_t *im = &vnm->interface_main;
 322   vnet_device_class_t *c;
 323
 324   /* Try per device class functions first. */
 325   vec_foreach (c, im->device_classes)
 326   {
 327     if (c->unformat_device_name
 328         && unformat_user (input, c->unformat_device_name, hw_if_index))
 329       return 1;
 330   }
 331
 332   return unformat_user (input, unformat_hash_vec_string,
 333                         im->hw_interface_by_name, hw_if_index);
 334 }
 335
 336 uword
 337 unformat_vnet_sw_interface (unformat_input_t * input, va_list * args)
 338 {
 339   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 340   u32 *result = va_arg (*args, u32 *);
 341   vnet_hw_interface_t *hi;
 342   u32 hw_if_index, id, id_specified;
 343   u32 sw_if_index;
 344   u8 *if_name = 0;
 345   uword *p, error = 0;
 346
 347   id = ~0;
 348   if (unformat (input, "%_%v.%d%_", &if_name, &id)
 349       && ((p = hash_get (vnm->interface_main.hw_interface_by_name, if_name))))
 350     {
 351       hw_if_index = p[0];
 352       id_specified = 1;
 353     }
 354   else
 355     if (unformat (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
 356     id_specified = 0;
 357   else
 358     goto done;
 359
 360   hi = vnet_get_hw_interface (vnm, hw_if_index);
 361   if (!id_specified)
 362     {
 363       sw_if_index = hi->sw_if_index;
 364     }
 365   else
 366     {
 367       if (!(p = hash_get (hi->sub_interface_sw_if_index_by_id, id)))
 368         goto done;
 369       sw_if_index = p[0];
 370     }
 371   if (!vnet_sw_interface_is_api_visible (vnm, sw_if_index))
 372     goto done;
 373   *result = sw_if_index;
 374   error = 1;
 375 done:
 376   vec_free (if_name);
 377   return error;
 378 }
 379
 380 uword
 381 unformat_vnet_sw_interface_flags (unformat_input_t * input, va_list * args)
 382 {
 383   u32 *result = va_arg (*args, u32 *);
 384   u32 flags = 0;
 385
 386   if (unformat (input, "up"))
 387     flags |= VNET_SW_INTERFACE_FLAG_ADMIN_UP;
 388   else if (unformat (input, "down"))
 389     flags &= ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
 390   else if (unformat (input, "punt"))
 391     flags |= VNET_SW_INTERFACE_FLAG_PUNT;
 392   else if (unformat (input, "enable"))
 393     flags &= ~VNET_SW_INTERFACE_FLAG_PUNT;
 394   else
 395     return 0;
 396
 397   *result = flags;
 398   return 1;
 399 }
 400
 401 uword
 402 unformat_vnet_hw_interface_flags (unformat_input_t * input, va_list * args)
 403 {
 404   u32 *result = va_arg (*args, u32 *);
 405   u32 flags = 0;
 406
 407   if (unformat (input, "up"))
 408     flags |= VNET_HW_INTERFACE_FLAG_LINK_UP;
 409   else if (unformat (input, "down"))
 410     flags &= ~VNET_HW_INTERFACE_FLAG_LINK_UP;
 411   else
 412     return 0;
 413
 414   *result = flags;
 415   return 1;
 416 }
 417
 418 /*
 419  * fd.io coding-style-patch-verification: ON
 420  *
 421  * Local Variables:
 422  * eval: (c-set-style "gnu")
 423  * End:
 424  */