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