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