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