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