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_link_speed (u8 * s, va_list * args)
  82 {
  83   u32 link_speed = va_arg (*args, u32);
  84
  85   if (link_speed == 0)
  86     return format (s, "unknown");
  87
  88   if (link_speed >= 1000000)
  89     return format (s, "%f Gbps", (f64) link_speed / 1000000);
  90
  91   if (link_speed >= 1000)
  92     return format (s, "%f Mbps", (f64) link_speed / 1000);
  93
  94   return format (s, "%u Kbps", link_speed);
  95 }
  96
  97
  98 u8 *
  99 format_vnet_hw_interface (u8 * s, va_list * args)
 100 {
 101   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 102   vnet_hw_interface_t *hi = va_arg (*args, vnet_hw_interface_t *);
 103   vnet_hw_interface_class_t *hw_class;
 104   vnet_device_class_t *dev_class;
 105   int verbose = va_arg (*args, int);
 106   u32 indent;
 107
 108   if (!hi)
 109     return format (s, "%=32s%=6s%=8s%s", "Name", "Idx", "Link", "Hardware");
 110
 111   indent = format_get_indent (s);
 112
 113   s = format (s, "%-32v%=6d", hi->name, hi->hw_if_index);
 114
 115   if (hi->bond_info == VNET_HW_INTERFACE_BOND_INFO_SLAVE)
 116     s = format (s, "%=8s", "slave");
 117   else
 118     s = format (s, "%=8s",
 119                 hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP ? "up" : "down");
 120
 121   hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
 122   dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 123
 124   if (hi->bond_info && (hi->bond_info != VNET_HW_INTERFACE_BOND_INFO_SLAVE))
 125     {
 126       int hw_idx;
 127       s = format (s, "Slave-Idx:");
 128       clib_bitmap_foreach (hw_idx, hi->bond_info, s =
 129                            format (s, " %d", hw_idx));
 130     }
 131   else if (dev_class->format_device_name)
 132     s = format (s, "%U", dev_class->format_device_name, hi->dev_instance);
 133   else
 134     s = format (s, "%s%d", dev_class->name, hi->dev_instance);
 135
 136   s = format (s, "\n%ULink speed: %U", format_white_space, indent + 2,
 137               format_vnet_hw_interface_link_speed, hi->link_speed);
 138
 139   if (verbose)
 140     {
 141       if (hw_class->format_device)
 142         s = format (s, "\n%U%U",
 143                     format_white_space, indent + 2,
 144                     hw_class->format_device, hi->hw_if_index, verbose);
 145       else
 146         {
 147           s = format (s, "\n%U%s",
 148                       format_white_space, indent + 2, hw_class->name);
 149           if (hw_class->format_address && vec_len (hi->hw_address) > 0)
 150             s =
 151               format (s, " address %U", hw_class->format_address,
 152                       hi->hw_address);
 153         }
 154
 155       if (dev_class->format_device)
 156         s = format (s, "\n%U%U",
 157                     format_white_space, indent + 2,
 158                     dev_class->format_device, hi->dev_instance, verbose);
 159     }
 160
 161   return s;
 162 }
 163
 164 u8 *
 165 format_vnet_sw_interface_name (u8 * s, va_list * args)
 166 {
 167   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 168   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
 169   vnet_sw_interface_t *si_sup =
 170     vnet_get_sup_sw_interface (vnm, si->sw_if_index);
 171   vnet_hw_interface_t *hi_sup;
 172
 173   ASSERT (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
 174   hi_sup = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
 175
 176   s = format (s, "%v", hi_sup->name);
 177
 178   if (si->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
 179     s = format (s, ".%d", si->sub.id);
 180
 181   return s;
 182 }
 183
 184 u8 *
 185 format_vnet_sw_if_index_name (u8 * s, va_list * args)
 186 {
 187   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 188   u32 sw_if_index = va_arg (*args, u32);
 189   vnet_sw_interface_t *si;
 190
 191   si = vnet_get_sw_interface_safe (vnm, sw_if_index);
 192
 193   if (NULL == si)
 194     {
 195       return format (s, "DELETED");
 196     }
 197   return format (s, "%U", format_vnet_sw_interface_name, vnm, si);
 198 }
 199
 200 u8 *
 201 format_vnet_hw_if_index_name (u8 * s, va_list * args)
 202 {
 203   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 204   u32 hw_if_index = va_arg (*args, u32);
 205   vnet_hw_interface_t *hi;
 206
 207   hi = vnet_get_hw_interface (vnm, hw_if_index);
 208
 209   if (hi == 0)
 210     return format (s, "DELETED");
 211
 212   return format (s, "%v", hi->name);
 213 }
 214
 215 u8 *
 216 format_vnet_sw_interface_cntrs (u8 * s, vnet_interface_main_t * im,
 217                                 vnet_sw_interface_t * si)
 218 {
 219   u32 indent, n_printed;
 220   int i, j, n_counters;
 221   static vnet_main_t **my_vnet_mains;
 222
 223   vec_reset_length (my_vnet_mains);
 224
 225   indent = format_get_indent (s);
 226   n_printed = 0;
 227
 228   {
 229     vlib_combined_counter_main_t *cm;
 230     vlib_counter_t v, vtotal;
 231     u8 *n = 0;
 232
 233     for (i = 0; i < vec_len (vnet_mains); i++)
 234       {
 235         if (vnet_mains[i])
 236           vec_add1 (my_vnet_mains, vnet_mains[i]);
 237       }
 238
 239     if (vec_len (my_vnet_mains) == 0)
 240       vec_add1 (my_vnet_mains, &vnet_main);
 241
 242     /* Each vnet_main_t has its own copy of the interface counters */
 243     n_counters = vec_len (im->combined_sw_if_counters);
 244
 245     /* rx, tx counters... */
 246     for (j = 0; j < n_counters; j++)
 247       {
 248         vtotal.packets = 0;
 249         vtotal.bytes = 0;
 250
 251         for (i = 0; i < vec_len (my_vnet_mains); i++)
 252           {
 253             im = &my_vnet_mains[i]->interface_main;
 254             cm = im->combined_sw_if_counters + j;
 255             vlib_get_combined_counter (cm, si->sw_if_index, &v);
 256             vtotal.packets += v.packets;
 257             vtotal.bytes += v.bytes;
 258           }
 259
 260         /* Only display non-zero counters. */
 261         if (vtotal.packets == 0)
 262           continue;
 263
 264         if (n_printed > 0)
 265           s = format (s, "\n%U", format_white_space, indent);
 266         n_printed += 2;
 267
 268         if (n)
 269           _vec_len (n) = 0;
 270         n = format (n, "%s packets", cm->name);
 271         s = format (s, "%-16v%16Ld", n, vtotal.packets);
 272
 273         _vec_len (n) = 0;
 274         n = format (n, "%s bytes", cm->name);
 275         s = format (s, "\n%U%-16v%16Ld",
 276                     format_white_space, indent, n, vtotal.bytes);
 277       }
 278     vec_free (n);
 279   }
 280
 281   {
 282     vlib_simple_counter_main_t *cm;
 283     u64 v, vtotal;
 284
 285     n_counters = vec_len (im->sw_if_counters);
 286
 287     for (j = 0; j < n_counters; j++)
 288       {
 289         vtotal = 0;
 290
 291         for (i = 0; i < vec_len (my_vnet_mains); i++)
 292           {
 293             im = &my_vnet_mains[i]->interface_main;
 294             cm = im->sw_if_counters + j;
 295
 296             v = vlib_get_simple_counter (cm, si->sw_if_index);
 297             vtotal += v;
 298           }
 299
 300         /* Only display non-zero counters. */
 301         if (vtotal == 0)
 302           continue;
 303
 304         if (n_printed > 0)
 305           s = format (s, "\n%U", format_white_space, indent);
 306         n_printed += 1;
 307
 308         s = format (s, "%-16s%16Ld", cm->name, vtotal);
 309       }
 310   }
 311
 312   return s;
 313 }
 314
 315 static u8 *
 316 format_vnet_sw_interface_mtu (u8 * s, va_list * args)
 317 {
 318   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
 319
 320   return format (s, "%d/%d/%d/%d", si->mtu[VNET_MTU_L3],
 321                  si->mtu[VNET_MTU_IP4],
 322                  si->mtu[VNET_MTU_IP6], si->mtu[VNET_MTU_MPLS]);
 323 }
 324
 325 u8 *
 326 format_vnet_sw_interface (u8 * s, va_list * args)
 327 {
 328   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 329   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
 330   vnet_interface_main_t *im = &vnm->interface_main;
 331
 332   if (!si)
 333     return format (s, "%=32s%=5s%=10s%=21s%=16s%=16s",
 334                    "Name", "Idx", "State", "MTU (L3/IP4/IP6/MPLS)", "Counter",
 335                    "Count");
 336
 337   s = format (s, "%-32U%=5d%=10U%=21U",
 338               format_vnet_sw_interface_name, vnm, si, si->sw_if_index,
 339               format_vnet_sw_interface_flags, si->flags,
 340               format_vnet_sw_interface_mtu, si);
 341
 342   s = format_vnet_sw_interface_cntrs (s, im, si);
 343
 344   return s;
 345 }
 346
 347 u8 *
 348 format_vnet_sw_interface_name_override (u8 * s, va_list * args)
 349 {
 350   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 351   vnet_sw_interface_t *si = va_arg (*args, vnet_sw_interface_t *);
 352   /* caller supplied display name for this interface */
 353   u8 *name = va_arg (*args, u8 *);
 354   vnet_interface_main_t *im = &vnm->interface_main;
 355
 356
 357   if (!si)
 358     return format (s, "%=32s%=5s%=16s%=16s%=16s",
 359                    "Name", "Idx", "State", "Counter", "Count");
 360
 361   s = format (s, "%-32v%=5d%=16U",
 362               name, si->sw_if_index,
 363               format_vnet_sw_interface_flags, si->flags);
 364
 365   s = format_vnet_sw_interface_cntrs (s, im, si);
 366
 367   return s;
 368 }
 369
 370 uword
 371 unformat_vnet_hw_interface (unformat_input_t * input, va_list * args)
 372 {
 373   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 374   u32 *hw_if_index = va_arg (*args, u32 *);
 375   vnet_interface_main_t *im = &vnm->interface_main;
 376   vnet_device_class_t *c;
 377
 378   /* Try per device class functions first. */
 379   vec_foreach (c, im->device_classes)
 380   {
 381     if (c->unformat_device_name
 382         && unformat_user (input, c->unformat_device_name, hw_if_index))
 383       return 1;
 384   }
 385
 386   return unformat_user (input, unformat_hash_vec_string,
 387                         im->hw_interface_by_name, hw_if_index);
 388 }
 389
 390 uword
 391 unformat_vnet_sw_interface (unformat_input_t * input, va_list * args)
 392 {
 393   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 394   u32 *result = va_arg (*args, u32 *);
 395   vnet_hw_interface_t *hi;
 396   u32 hw_if_index, id, id_specified;
 397   u32 sw_if_index;
 398   u8 *if_name = 0;
 399   uword *p, error = 0;
 400
 401   id = ~0;
 402   if (unformat (input, "%_%v.%d%_", &if_name, &id)
 403       && ((p = hash_get (vnm->interface_main.hw_interface_by_name, if_name))))
 404     {
 405       hw_if_index = p[0];
 406       id_specified = 1;
 407     }
 408   else
 409     if (unformat (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
 410     id_specified = 0;
 411   else
 412     goto done;
 413
 414   hi = vnet_get_hw_interface (vnm, hw_if_index);
 415   if (!id_specified)
 416     {
 417       sw_if_index = hi->sw_if_index;
 418     }
 419   else
 420     {
 421       if (!(p = hash_get (hi->sub_interface_sw_if_index_by_id, id)))
 422         goto done;
 423       sw_if_index = p[0];
 424     }
 425   if (!vnet_sw_interface_is_api_visible (vnm, sw_if_index))
 426     goto done;
 427   *result = sw_if_index;
 428   error = 1;
 429 done:
 430   vec_free (if_name);
 431   return error;
 432 }
 433
 434 uword
 435 unformat_vnet_sw_interface_flags (unformat_input_t * input, va_list * args)
 436 {
 437   u32 *result = va_arg (*args, u32 *);
 438   u32 flags = 0;
 439
 440   if (unformat (input, "up"))
 441     flags |= VNET_SW_INTERFACE_FLAG_ADMIN_UP;
 442   else if (unformat (input, "down"))
 443     flags &= ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
 444   else if (unformat (input, "punt"))
 445     flags |= VNET_SW_INTERFACE_FLAG_PUNT;
 446   else if (unformat (input, "enable"))
 447     flags &= ~VNET_SW_INTERFACE_FLAG_PUNT;
 448   else
 449     return 0;
 450
 451   *result = flags;
 452   return 1;
 453 }
 454
 455 uword
 456 unformat_vnet_hw_interface_flags (unformat_input_t * input, va_list * args)
 457 {
 458   u32 *result = va_arg (*args, u32 *);
 459   u32 flags = 0;
 460
 461   if (unformat (input, "up"))
 462     flags |= VNET_HW_INTERFACE_FLAG_LINK_UP;
 463   else if (unformat (input, "down"))
 464     flags &= ~VNET_HW_INTERFACE_FLAG_LINK_UP;
 465   else
 466     return 0;
 467
 468   *result = flags;
 469   return 1;
 470 }
 471
 472 /*
 473  * fd.io coding-style-patch-verification: ON
 474  *
 475  * Local Variables:
 476  * eval: (c-set-style "gnu")
 477  * End:
 478  */