src/vnet/interface.h

   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.h: VNET interfaces/sub-interfaces
  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 #ifndef included_vnet_interface_h
  41 #define included_vnet_interface_h
  42
  43 #include <vlib/vlib.h>
  44 #include <vppinfra/pcap.h>
  45 #include <vnet/l3_types.h>
  46 #include <vppinfra/lock.h>
  47
  48 struct vnet_main_t;
  49 struct vnet_hw_interface_t;
  50 struct vnet_sw_interface_t;
  51 union ip46_address_t_;
  52
  53 typedef enum
  54 {
  55   VNET_HW_INTERFACE_RX_MODE_UNKNOWN,
  56   VNET_HW_INTERFACE_RX_MODE_POLLING,
  57   VNET_HW_INTERFACE_RX_MODE_INTERRUPT,
  58   VNET_HW_INTERFACE_RX_MODE_ADAPTIVE,
  59   VNET_HW_INTERFACE_RX_MODE_DEFAULT,
  60   VNET_HW_INTERFACE_NUM_RX_MODES,
  61 } vnet_hw_interface_rx_mode;
  62
  63 /* Interface up/down callback. */
  64 typedef clib_error_t *(vnet_interface_function_t)
  65   (struct vnet_main_t * vnm, u32 if_index, u32 flags);
  66
  67 /* Sub-interface add/del callback. */
  68 typedef clib_error_t *(vnet_subif_add_del_function_t)
  69   (struct vnet_main_t * vnm, u32 if_index,
  70    struct vnet_sw_interface_t * template, int is_add);
  71
  72 /* Interface set mac address callback. */
  73 typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
  74   (struct vnet_hw_interface_t * hi,
  75    const u8 * old_address, const u8 * new_address);
  76
  77 /* Interface add/del additional mac address callback */
  78 typedef clib_error_t *(vnet_interface_add_del_mac_address_function_t)
  79   (struct vnet_hw_interface_t * hi, const u8 * address, u8 is_add);
  80
  81 /* Interface set rx mode callback. */
  82 typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
  83   (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
  84    vnet_hw_interface_rx_mode mode);
  85
  86 /* Interface set l2 mode callback. */
  87 typedef clib_error_t *(vnet_interface_set_l2_mode_function_t)
  88   (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
  89    i32 l2_if_adjust);
  90
  91 typedef enum
  92 {
  93   VNET_FLOW_DEV_OP_ADD_FLOW,
  94   VNET_FLOW_DEV_OP_DEL_FLOW,
  95   VNET_FLOW_DEV_OP_GET_COUNTER,
  96   VNET_FLOW_DEV_OP_RESET_COUNTER,
  97 } vnet_flow_dev_op_t;
  98
  99 /* Interface flow operations callback. */
 100 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
 101                                             vnet_flow_dev_op_t op,
 102                                             u32 hw_if_index, u32 index,
 103                                             uword * private_data);
 104
 105 typedef enum vnet_interface_function_priority_t_
 106 {
 107   VNET_ITF_FUNC_PRIORITY_LOW,
 108   VNET_ITF_FUNC_PRIORITY_HIGH,
 109 } vnet_interface_function_priority_t;
 110 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
 111
 112 typedef struct _vnet_interface_function_list_elt
 113 {
 114   struct _vnet_interface_function_list_elt *next_interface_function;
 115   clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
 116 } _vnet_interface_function_list_elt_t;
 117
 118 #ifndef CLIB_MARCH_VARIANT
 119 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p)                    \
 120                                                                         \
 121 static void __vnet_interface_function_init_##tag##_##f (void)           \
 122     __attribute__((__constructor__)) ;                                  \
 123                                                                         \
 124 static void __vnet_interface_function_init_##tag##_##f (void)           \
 125 {                                                                       \
 126  vnet_main_t * vnm = vnet_get_main();                                   \
 127  static _vnet_interface_function_list_elt_t init_function;              \
 128  init_function.next_interface_function = vnm->tag##_functions[p];       \
 129  vnm->tag##_functions[p] = &init_function;                              \
 130  init_function.fp = (void *) &f;                                        \
 131 }                                                                       \
 132 static void __vnet_interface_function_deinit_##tag##_##f (void)         \
 133     __attribute__((__destructor__)) ;                                   \
 134                                                                         \
 135 static void __vnet_interface_function_deinit_##tag##_##f (void)         \
 136 {                                                                       \
 137  vnet_main_t * vnm = vnet_get_main();                                   \
 138  _vnet_interface_function_list_elt_t *next;                             \
 139  if (vnm->tag##_functions[p]->fp == f)                                  \
 140     {                                                                   \
 141       vnm->tag##_functions[p] =                                         \
 142         vnm->tag##_functions[p]->next_interface_function;               \
 143       return;                                                           \
 144     }                                                                   \
 145   next = vnm->tag##_functions[p];                                       \
 146   while (next->next_interface_function)                                 \
 147     {                                                                   \
 148       if (next->next_interface_function->fp == f)                       \
 149         {                                                               \
 150           next->next_interface_function =                               \
 151             next->next_interface_function->next_interface_function;     \
 152           return;                                                       \
 153         }                                                               \
 154       next = next->next_interface_function;                             \
 155     }                                                                   \
 156 }
 157 #else
 158 /* create unused pointer to silence compiler warnings and get whole
 159    function optimized out */
 160 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p)                    \
 161 static __clib_unused void * __clib_unused_##f = f;
 162 #endif
 163
 164 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag)                            \
 165   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
 166
 167 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f)                   \
 168   _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
 169 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f)              \
 170   _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
 171 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p)       \
 172   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
 173 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f)                \
 174   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
 175 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f)                   \
 176   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
 177 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f)             \
 178   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
 179 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p)      \
 180   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
 181
 182 /**
 183  * Tunnel description parameters
 184  */
 185 typedef int (*vnet_dev_class_ip_tunnel_desc_t) (u32 sw_if_index,
 186                                                 union ip46_address_t_ * src,
 187                                                 union ip46_address_t_ * dst,
 188                                                 u8 * is_l2);
 189
 190 /* A class of hardware interface devices. */
 191 typedef struct _vnet_device_class
 192 {
 193   /* Index into main vector. */
 194   u32 index;
 195
 196   /* Device name (e.g. "FOOBAR 1234a"). */
 197   char *name;
 198
 199   /* Function to call when hardware interface is added/deleted. */
 200   vnet_interface_function_t *interface_add_del_function;
 201
 202   /* Function to bring device administratively up/down. */
 203   vnet_interface_function_t *admin_up_down_function;
 204
 205   /* Function to call when sub-interface is added/deleted */
 206   vnet_subif_add_del_function_t *subif_add_del_function;
 207
 208   /* Function to call interface rx mode is changed */
 209   vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
 210
 211   /* Function to call interface l2 mode is changed */
 212   vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
 213
 214   /* Redistribute flag changes/existence of this interface class. */
 215   u32 redistribute;
 216
 217   /* Transmit function. */
 218   vlib_node_function_t *tx_function;
 219
 220   /* Transmit function candidate registration with priority */
 221   vlib_node_fn_registration_t *tx_fn_registrations;
 222
 223   /* Error strings indexed by error code for this node. */
 224   char **tx_function_error_strings;
 225
 226   /* Number of error codes used by this node. */
 227   u32 tx_function_n_errors;
 228
 229   /* Renumber device name [only!] support, a control-plane kludge */
 230   int (*name_renumber) (struct vnet_hw_interface_t * hi,
 231                         u32 new_dev_instance);
 232
 233   /* Interface flow offload operations */
 234   vnet_flow_dev_ops_function_t *flow_ops_function;
 235
 236   /* Format device instance as name. */
 237   format_function_t *format_device_name;
 238
 239   /* Parse function for device name. */
 240   unformat_function_t *unformat_device_name;
 241
 242   /* Format device verbosely for this class. */
 243   format_function_t *format_device;
 244
 245   /* Trace buffer format for TX function. */
 246   format_function_t *format_tx_trace;
 247
 248   /* Format flow offload entry */
 249   format_function_t *format_flow;
 250
 251   vnet_dev_class_ip_tunnel_desc_t ip_tun_desc;
 252
 253   /* Function to clear hardware counters for device. */
 254   void (*clear_counters) (u32 dev_class_instance);
 255
 256     uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
 257                                            u32 hw_if_index,
 258                                            u32 hw_class_index);
 259
 260   /* Called when hardware class of an interface changes. */
 261   void (*hw_class_change) (struct vnet_main_t * vnm,
 262                            u32 hw_if_index, u32 new_hw_class_index);
 263
 264   /* Called to redirect traffic from a specific interface instance */
 265   void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
 266                                u32 hw_if_index, u32 node_index);
 267
 268   /* Link-list of all device classes set up by constructors created below */
 269   struct _vnet_device_class *next_class_registration;
 270
 271   /* Function to set mac address. */
 272   vnet_interface_set_mac_address_function_t *mac_addr_change_function;
 273
 274   /* Function to add/delete additional MAC addresses */
 275   vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
 276 } vnet_device_class_t;
 277
 278 #ifndef CLIB_MARCH_VARIANT
 279 #define VNET_DEVICE_CLASS(x,...)                                        \
 280   __VA_ARGS__ vnet_device_class_t x;                                    \
 281 static void __vnet_add_device_class_registration_##x (void)             \
 282     __attribute__((__constructor__)) ;                                  \
 283 static void __vnet_add_device_class_registration_##x (void)             \
 284 {                                                                       \
 285     vnet_main_t * vnm = vnet_get_main();                                \
 286     x.next_class_registration = vnm->device_class_registrations;        \
 287     vnm->device_class_registrations = &x;                               \
 288 }                                                                       \
 289 static void __vnet_rm_device_class_registration_##x (void)              \
 290     __attribute__((__destructor__)) ;                                   \
 291 static void __vnet_rm_device_class_registration_##x (void)              \
 292 {                                                                       \
 293     vnet_main_t * vnm = vnet_get_main();                                \
 294     VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations,      \
 295                                   &x, next_class_registration);         \
 296 }                                                                       \
 297 __VA_ARGS__ vnet_device_class_t x
 298 #else
 299 /* create unused pointer to silence compiler warnings and get whole
 300    function optimized out */
 301 #define VNET_DEVICE_CLASS(x,...)                                        \
 302 static __clib_unused vnet_device_class_t __clib_unused_##x
 303 #endif
 304
 305 #define VNET_DEVICE_CLASS_TX_FN(devclass)                               \
 306 uword CLIB_MARCH_SFX (devclass##_tx_fn)();                              \
 307 static vlib_node_fn_registration_t                                      \
 308   CLIB_MARCH_SFX(devclass##_tx_fn_registration) =                       \
 309   { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), };                  \
 310                                                                         \
 311 static void __clib_constructor                                          \
 312 CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void)             \
 313 {                                                                       \
 314   extern vnet_device_class_t devclass;                                  \
 315   vlib_node_fn_registration_t *r;                                       \
 316   r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration);                  \
 317   r->priority = CLIB_MARCH_FN_PRIORITY();                               \
 318   r->next_registration = devclass.tx_fn_registrations;                  \
 319   devclass.tx_fn_registrations = r;                                     \
 320 }                                                                       \
 321 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
 322
 323 /**
 324  * Link Type: A description of the protocol of packets on the link.
 325  * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
 326  * it maps to the GRE-proto, etc for other lnk types.
 327  */
 328 typedef enum vnet_link_t_
 329 {
 330 #if CLIB_DEBUG > 0
 331   VNET_LINK_IP4 = 1,
 332 #else
 333   VNET_LINK_IP4 = 0,
 334 #endif
 335   VNET_LINK_IP6,
 336   VNET_LINK_MPLS,
 337   VNET_LINK_ETHERNET,
 338   VNET_LINK_ARP,
 339   VNET_LINK_NSH,
 340 } __attribute__ ((packed)) vnet_link_t;
 341
 342 #define VNET_LINKS {                   \
 343     [VNET_LINK_ETHERNET] = "ethernet", \
 344     [VNET_LINK_IP4] = "ipv4",          \
 345     [VNET_LINK_IP6] = "ipv6",          \
 346     [VNET_LINK_MPLS] = "mpls",         \
 347     [VNET_LINK_ARP] = "arp",           \
 348     [VNET_LINK_NSH] = "nsh",           \
 349 }
 350
 351 #define FOR_EACH_VNET_LINK(_link)    \
 352   for (_link = VNET_LINK_IP4;        \
 353        _link <= VNET_LINK_NSH;       \
 354        _link++)
 355
 356 /**
 357  * @brief Number of link types. Not part of the enum so it does not have to be included in
 358  * switch statements
 359  */
 360 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
 361
 362 /**
 363  * @brief Convert a link to to an Ethertype
 364  */
 365 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
 366
 367 /**
 368  * @brief Attributes assignable to a HW interface Class.
 369  */
 370 typedef enum vnet_hw_interface_class_flags_t_
 371 {
 372   /**
 373    * @brief a point 2 point interface
 374    */
 375   VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
 376   /**
 377    * @brief a non-broadcast multiple access interface
 378    */
 379   VNET_HW_INTERFACE_CLASS_FLAG_NBMA = (1 << 1),
 380 } vnet_hw_interface_class_flags_t;
 381
 382 /* Layer-2 (e.g. Ethernet) interface class. */
 383 typedef struct _vnet_hw_interface_class
 384 {
 385   /* Index into main vector. */
 386   u32 index;
 387
 388   /* Class name (e.g. "Ethernet"). */
 389   char *name;
 390
 391   /* Flags */
 392   vnet_hw_interface_class_flags_t flags;
 393
 394   /* Function to call when hardware interface is added/deleted. */
 395   vnet_interface_function_t *interface_add_del_function;
 396
 397   /* Function to bring interface administratively up/down. */
 398   vnet_interface_function_t *admin_up_down_function;
 399
 400   /* Function to call when link state changes. */
 401   vnet_interface_function_t *link_up_down_function;
 402
 403   /* Function to call when link MAC changes. */
 404   vnet_interface_set_mac_address_function_t *mac_addr_change_function;
 405
 406   /* Function to add/delete additional MAC addresses */
 407   vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
 408
 409   /* Format function to display interface name. */
 410   format_function_t *format_interface_name;
 411
 412   /* Format function to display interface address. */
 413   format_function_t *format_address;
 414
 415   /* Format packet header for this interface class. */
 416   format_function_t *format_header;
 417
 418   /* Format device verbosely for this class. */
 419   format_function_t *format_device;
 420
 421   /* Parser for hardware (e.g. ethernet) address. */
 422   unformat_function_t *unformat_hw_address;
 423
 424   /* Parser for packet header for e.g. rewrite string. */
 425   unformat_function_t *unformat_header;
 426
 427   /* Builds a rewrite string for the interface to the destination
 428    * for the payload/link type. */
 429   u8 *(*build_rewrite) (struct vnet_main_t * vnm,
 430                         u32 sw_if_index,
 431                         vnet_link_t link_type, const void *dst_hw_address);
 432
 433   /* Update an adjacency added by FIB (as opposed to via the
 434    * neighbour resolution protocol). */
 435   void (*update_adjacency) (struct vnet_main_t * vnm,
 436                             u32 sw_if_index, u32 adj_index);
 437
 438     uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
 439                                            u32 hw_if_index,
 440                                            u32 hw_class_index);
 441
 442   /* Called when hw interface class is changed and old hardware instance
 443      may want to be deleted. */
 444   void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
 445                            u32 old_class_index, u32 new_class_index);
 446
 447   /* List of hw interface classes, built by constructors */
 448   struct _vnet_hw_interface_class *next_class_registration;
 449
 450 } vnet_hw_interface_class_t;
 451
 452 /**
 453  * @brief Return a complete, zero-length (aka dummy) rewrite
 454  */
 455 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
 456                                   u32 sw_if_index,
 457                                   vnet_link_t link_type,
 458                                   const void *dst_hw_address);
 459
 460 /**
 461  * @brief Default adjacency update function
 462  */
 463 extern void default_update_adjacency (struct vnet_main_t *vnm,
 464                                       u32 sw_if_index, u32 adj_index);
 465
 466 #define VNET_HW_INTERFACE_CLASS(x,...)                                  \
 467   __VA_ARGS__ vnet_hw_interface_class_t x;                              \
 468 static void __vnet_add_hw_interface_class_registration_##x (void)       \
 469     __attribute__((__constructor__)) ;                                  \
 470 static void __vnet_add_hw_interface_class_registration_##x (void)       \
 471 {                                                                       \
 472     vnet_main_t * vnm = vnet_get_main();                                \
 473     x.next_class_registration = vnm->hw_interface_class_registrations;  \
 474     vnm->hw_interface_class_registrations = &x;                         \
 475 }                                                                       \
 476 static void __vnet_rm_hw_interface_class_registration_##x (void)        \
 477     __attribute__((__destructor__)) ;                                   \
 478 static void __vnet_rm_hw_interface_class_registration_##x (void)        \
 479 {                                                                       \
 480     vnet_main_t * vnm = vnet_get_main();                                \
 481     VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
 482                                   &x, next_class_registration);         \
 483 }                                                                       \
 484 __VA_ARGS__ vnet_hw_interface_class_t x
 485
 486 typedef enum vnet_hw_interface_flags_t_
 487 {
 488   VNET_HW_INTERFACE_FLAG_NONE,
 489   /* Hardware link state is up. */
 490   VNET_HW_INTERFACE_FLAG_LINK_UP = (1 << 0),
 491   /* Hardware duplex state */
 492   VNET_HW_INTERFACE_FLAG_HALF_DUPLEX = (1 << 1),
 493   VNET_HW_INTERFACE_FLAG_FULL_DUPLEX = (1 << 2),
 494
 495   /* rx mode flags */
 496   VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE = (1 << 16),
 497
 498   /* tx checksum offload */
 499   VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD = (1 << 17),
 500
 501   /* gso */
 502   VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO = (1 << 18),
 503
 504   /* non-broadcast multiple access */
 505   VNET_HW_INTERFACE_FLAG_NBMA = (1 << 19),
 506 } vnet_hw_interface_flags_t;
 507
 508 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
 509 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT  3
 510 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK      \
 511   (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX |         \
 512    VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
 513
 514 /* Hardware-interface.  This corresponds to a physical wire
 515    that packets flow over. */
 516 typedef struct vnet_hw_interface_t
 517 {
 518   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 519   /* Interface name. */
 520   u8 *name;
 521
 522   /* flags */
 523   vnet_hw_interface_flags_t flags;
 524
 525
 526   /* link speed in kbps */
 527   u32 link_speed;
 528
 529   /* Hardware address as vector.  Zero (e.g. zero-length vector) if no
 530      address for this class (e.g. PPP). */
 531   u8 *hw_address;
 532
 533   /* Interface is up as far as software is concerned. */
 534   /* NAME.{output,tx} nodes for this interface. */
 535   u32 output_node_index, tx_node_index;
 536
 537   /* (dev_class, dev_instance) uniquely identifies hw interface. */
 538   u32 dev_class_index;
 539   u32 dev_instance;
 540
 541   /* (hw_class, hw_instance) uniquely identifies hw interface. */
 542   u32 hw_class_index;
 543   u32 hw_instance;
 544
 545   /* Hardware index for this hardware interface. */
 546   u32 hw_if_index;
 547
 548   /* Software index for this hardware interface. */
 549   u32 sw_if_index;
 550
 551   /* Next index in interface-output node for this interface
 552      used by node function vnet_per_buffer_interface_output() */
 553   u32 output_node_next_index;
 554
 555   /* Maximum transmit rate for this interface in bits/sec. */
 556   f64 max_rate_bits_per_sec;
 557
 558   /* Smallest packet size supported by this interface. */
 559   u32 min_supported_packet_bytes;
 560
 561   /* Largest packet size supported by this interface. */
 562   u32 max_supported_packet_bytes;
 563
 564   /* Smallest packet size for this interface. */
 565   u32 min_packet_bytes;
 566
 567   /* Largest packet size for this interface. */
 568   u32 max_packet_bytes;
 569
 570   /* Hash table mapping sub interface id to sw_if_index. */
 571   uword *sub_interface_sw_if_index_by_id;
 572
 573   /* Count of number of L2 subinterfaces */
 574   u32 l2_if_count;
 575
 576   /* Bonded interface info -
 577      0       - not a bonded interface nor a slave
 578      ~0      - slave to a bonded interface
 579      others  - A bonded interface with a pointer to bitmap for all slaves */
 580   uword *bond_info;
 581 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
 582 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
 583
 584   /* Input node */
 585   u32 input_node_index;
 586
 587   /* input node cpu index by queue */
 588   u32 *input_node_thread_index_by_queue;
 589
 590   /* vnet_hw_interface_rx_mode by queue */
 591   u8 *rx_mode_by_queue;
 592   vnet_hw_interface_rx_mode default_rx_mode;
 593
 594   /* device input device_and_queue runtime index */
 595   uword *dq_runtime_index_by_queue;
 596
 597   /* numa node that hardware device connects to */
 598   u8 numa_node;
 599
 600   /* trace */
 601   i32 n_trace;
 602
 603   u32 trace_classify_table_index;
 604 } vnet_hw_interface_t;
 605
 606 extern vnet_device_class_t vnet_local_interface_device_class;
 607
 608 typedef enum
 609 {
 610   /* A hw interface. */
 611   VNET_SW_INTERFACE_TYPE_HARDWARE,
 612
 613   /* A sub-interface. */
 614   VNET_SW_INTERFACE_TYPE_SUB,
 615   VNET_SW_INTERFACE_TYPE_P2P,
 616   VNET_SW_INTERFACE_TYPE_PIPE,
 617 } vnet_sw_interface_type_t;
 618
 619 typedef struct
 620 {
 621   /*
 622    * Subinterface ID. A number 0-N to uniquely identify
 623    * this subinterface under the main (parent?) interface
 624    */
 625   u32 id;
 626
 627   /* Classification data. Used to associate packet header with subinterface. */
 628   struct
 629   {
 630     u16 outer_vlan_id;
 631     u16 inner_vlan_id;
 632     union
 633     {
 634       u16 raw_flags;
 635       struct
 636       {
 637         u16 no_tags:1;
 638         u16 one_tag:1;
 639         u16 two_tags:1;
 640         u16 dot1ad:1;           /* 0 = dot1q, 1=dot1ad */
 641         u16 exact_match:1;
 642         u16 default_sub:1;
 643         u16 outer_vlan_id_any:1;
 644         u16 inner_vlan_id_any:1;
 645       } flags;
 646     };
 647   } eth;
 648 } vnet_sub_interface_t;
 649
 650 typedef struct
 651 {
 652   /*
 653    * Subinterface ID. A number 0-N to uniquely identify
 654    * this subinterface under the main interface
 655    */
 656   u32 id;
 657   u32 pool_index;
 658   u8 client_mac[6];
 659 } vnet_p2p_sub_interface_t;
 660
 661 typedef enum
 662 {
 663   /* THe BVI interface */
 664   VNET_FLOOD_CLASS_BVI,
 665   /* Always flood */
 666   VNET_FLOOD_CLASS_NORMAL,
 667   VNET_FLOOD_CLASS_TUNNEL_MASTER,
 668   /* Does not flood when tunnel master is in the same L2 BD */
 669   VNET_FLOOD_CLASS_TUNNEL_NORMAL,
 670   /* Never flood to this type */
 671   VNET_FLOOD_CLASS_NO_FLOOD,
 672 } vnet_flood_class_t;
 673
 674 /* Per protocol MTU */
 675 typedef enum
 676 {
 677   VNET_MTU_L3,                  /* Default payload MTU (without L2 headers) */
 678   VNET_MTU_IP4,                 /* Per-protocol MTUs overriding default */
 679   VNET_MTU_IP6,
 680   VNET_MTU_MPLS,
 681   VNET_N_MTU
 682 } vnet_mtu_t;
 683
 684 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
 685
 686 typedef enum vnet_sw_interface_flags_t_
 687 {
 688   VNET_SW_INTERFACE_FLAG_NONE = 0,
 689   /* Interface is "up" meaning administratively up.
 690      Up in the sense of link state being up is maintained by hardware interface. */
 691   VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
 692
 693   /* Interface is disabled for forwarding: punt all traffic to slow-path. */
 694   VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
 695
 696   __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
 697
 698   VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
 699
 700   __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
 701
 702   /* Interface does not appear in CLI/API */
 703   VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
 704
 705   /* Interface in ERROR state */
 706   VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
 707
 708   /* Interface has IP configured directed broadcast */
 709   VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
 710
 711 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
 712
 713 /* Software-interface.  This corresponds to a Ethernet VLAN, ATM vc, a
 714    tunnel, etc.  Configuration (e.g. IP address) gets attached to
 715    software interface. */
 716 typedef struct
 717 {
 718   vnet_sw_interface_type_t type:16;
 719
 720   vnet_sw_interface_flags_t flags;
 721
 722   /* Index for this interface. */
 723   u32 sw_if_index;
 724
 725   /* Software interface index of super-interface;
 726      equal to sw_if_index if this interface is not a
 727      sub-interface. */
 728   u32 sup_sw_if_index;
 729
 730   /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
 731   u32 unnumbered_sw_if_index;
 732
 733   /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
 734   u32 hw_if_index;
 735
 736   /* MTU for network layer (not including L2 headers) */
 737   u32 mtu[VNET_N_MTU];
 738
 739   /* VNET_SW_INTERFACE_TYPE_SUB. */
 740   vnet_sub_interface_t sub;
 741
 742   /* VNET_SW_INTERFACE_TYPE_P2P. */
 743   vnet_p2p_sub_interface_t p2p;
 744
 745   vnet_flood_class_t flood_class;
 746 } vnet_sw_interface_t;
 747
 748 typedef enum
 749 {
 750   /* Simple counters. */
 751   VNET_INTERFACE_COUNTER_DROP = 0,
 752   VNET_INTERFACE_COUNTER_PUNT = 1,
 753   VNET_INTERFACE_COUNTER_IP4 = 2,
 754   VNET_INTERFACE_COUNTER_IP6 = 3,
 755   VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
 756   VNET_INTERFACE_COUNTER_RX_MISS = 5,
 757   VNET_INTERFACE_COUNTER_RX_ERROR = 6,
 758   VNET_INTERFACE_COUNTER_TX_ERROR = 7,
 759   VNET_INTERFACE_COUNTER_MPLS = 8,
 760   VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
 761   /* Combined counters. */
 762   VNET_INTERFACE_COUNTER_RX = 0,
 763   VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
 764   VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
 765   VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
 766   VNET_INTERFACE_COUNTER_TX = 4,
 767   VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
 768   VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
 769   VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
 770   VNET_N_COMBINED_INTERFACE_COUNTER = 8,
 771 } vnet_interface_counter_type_t;
 772
 773 #define foreach_rx_combined_interface_counter(_x)               \
 774   for (_x = VNET_INTERFACE_COUNTER_RX;                          \
 775        _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST;               \
 776        _x++)
 777
 778 #define foreach_tx_combined_interface_counter(_x)               \
 779   for (_x = VNET_INTERFACE_COUNTER_TX;                          \
 780        _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST;               \
 781        _x++)
 782
 783 #define foreach_simple_interface_counter_name   \
 784   _(DROP, drops, if)                            \
 785   _(PUNT, punt, if)                             \
 786   _(IP4, ip4, if)                               \
 787   _(IP6, ip6, if)                               \
 788   _(RX_NO_BUF, rx-no-buf, if)                   \
 789   _(RX_MISS, rx-miss, if)                       \
 790   _(RX_ERROR, rx-error, if)                     \
 791   _(TX_ERROR, tx-error, if)         \
 792   _(MPLS, mpls, if)
 793
 794 #define foreach_combined_interface_counter_name \
 795   _(RX, rx, if)                                 \
 796   _(RX_UNICAST, rx-unicast, if)                 \
 797   _(RX_MULTICAST, rx-multicast, if)             \
 798   _(RX_BROADCAST, rx-broadcast, if)             \
 799   _(TX, tx, if)                                 \
 800   _(TX_UNICAST, tx-unicast, if)                 \
 801   _(TX_MULTICAST, tx-multicast, if)             \
 802   _(TX_BROADCAST, tx-broadcast, if)
 803
 804 typedef enum
 805 {
 806   COLLECT_SIMPLE_STATS = 0,
 807   COLLECT_DETAILED_STATS = 1,
 808 } vnet_interface_stats_collection_mode_e;
 809
 810 extern int collect_detailed_interface_stats_flag;
 811
 812 static inline int
 813 collect_detailed_interface_stats (void)
 814 {
 815   return collect_detailed_interface_stats_flag;
 816 }
 817
 818 void collect_detailed_interface_stats_flag_set (void);
 819 void collect_detailed_interface_stats_flag_clear (void);
 820
 821
 822 typedef struct
 823 {
 824   u32 output_node_index;
 825   u32 tx_node_index;
 826 } vnet_hw_interface_nodes_t;
 827
 828 typedef struct
 829 {
 830   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 831   u32 *split_buffers;
 832 } vnet_interface_per_thread_data_t;
 833
 834 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
 835                                                u8 * s);
 836
 837 typedef struct
 838 {
 839   /* Hardware interfaces. */
 840   vnet_hw_interface_t *hw_interfaces;
 841
 842   /* Hash table mapping HW interface name to index. */
 843   uword *hw_interface_by_name;
 844
 845   /* Vectors if hardware interface classes and device classes. */
 846   vnet_hw_interface_class_t *hw_interface_classes;
 847   vnet_device_class_t *device_classes;
 848
 849   /* Hash table mapping name to hw interface/device class. */
 850   uword *hw_interface_class_by_name;
 851   uword *device_class_by_name;
 852
 853   /* Software interfaces. */
 854   vnet_sw_interface_t *sw_interfaces;
 855
 856   /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
 857   uword *sw_if_index_by_sup_and_sub;
 858
 859   /* Software interface counters both simple and combined
 860      packet and byte counters. */
 861   clib_spinlock_t sw_if_counter_lock;
 862   vlib_simple_counter_main_t *sw_if_counters;
 863   vlib_combined_counter_main_t *combined_sw_if_counters;
 864
 865   vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
 866
 867   /*
 868    * pcap drop tracing
 869    * Only the drop filter hash lives here. See ../src/vlib/main.h for
 870    * the rest of the variables.
 871    */
 872   uword *pcap_drop_filter_hash;
 873
 874   /* Buffer metadata format helper functions */
 875   vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
 876   vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
 877
 878   /* per-thread data */
 879   vnet_interface_per_thread_data_t *per_thread_data;
 880
 881   /* feature_arc_index */
 882   u8 output_feature_arc_index;
 883 } vnet_interface_main_t;
 884
 885 static inline void
 886 vnet_interface_counter_lock (vnet_interface_main_t * im)
 887 {
 888   if (im->sw_if_counter_lock)
 889     clib_spinlock_lock (&im->sw_if_counter_lock);
 890 }
 891
 892 static inline void
 893 vnet_interface_counter_unlock (vnet_interface_main_t * im)
 894 {
 895   if (im->sw_if_counter_lock)
 896     clib_spinlock_unlock (&im->sw_if_counter_lock);
 897 }
 898
 899 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
 900
 901 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
 902
 903 uword vnet_interface_output_node (vlib_main_t * vm,
 904                                   vlib_node_runtime_t * node,
 905                                   vlib_frame_t * frame);
 906
 907 void vnet_register_format_buffer_opaque_helper
 908   (vnet_buffer_opquae_formatter_t fn);
 909
 910 void vnet_register_format_buffer_opaque2_helper
 911   (vnet_buffer_opquae_formatter_t fn);
 912
 913 typedef struct
 914 {
 915   u8 *filename;
 916   int enable;
 917   int status;
 918   u32 packets_to_capture;
 919   u32 max_bytes_per_pkt;
 920   u8 rx_enable;
 921   u8 tx_enable;
 922   u8 drop_enable;
 923   u32 sw_if_index;
 924   int filter;
 925 } vnet_pcap_dispatch_trace_args_t;
 926
 927 int vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t *);
 928
 929 #endif /* included_vnet_interface_h */
 930
 931 /*
 932  * fd.io coding-style-patch-verification: ON
 933  *
 934  * Local Variables:
 935  * eval: (c-set-style "gnu")
 936  * End:
 937  */