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