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(f,tag)                            \
  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 =                                \
 102    vnm->tag##_functions[VNET_ITF_FUNC_PRIORITY_LOW];                    \
 103  vnm->tag##_functions[VNET_ITF_FUNC_PRIORITY_LOW] = &init_function;     \
 104  init_function.fp = (void *) &f;                                        \
 105 }
 106
 107 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p)                    \
 108                                                                         \
 109 static void __vnet_interface_function_init_##tag##_##f (void)           \
 110     __attribute__((__constructor__)) ;                                  \
 111                                                                         \
 112 static void __vnet_interface_function_init_##tag##_##f (void)           \
 113 {                                                                       \
 114  vnet_main_t * vnm = vnet_get_main();                                   \
 115  static _vnet_interface_function_list_elt_t init_function;              \
 116  init_function.next_interface_function = vnm->tag##_functions[p];       \
 117  vnm->tag##_functions[p] = &init_function;                              \
 118  init_function.fp = (void *) &f;                                        \
 119 }
 120
 121 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f)                   \
 122   _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
 123 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f)              \
 124   _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
 125 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p)        \
 126   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
 127 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f)                   \
 128   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
 129 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f)             \
 130   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
 131 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p)      \
 132   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
 133
 134 /* A class of hardware interface devices. */
 135 typedef struct _vnet_device_class
 136 {
 137   /* Index into main vector. */
 138   u32 index;
 139
 140   /* Device name (e.g. "FOOBAR 1234a"). */
 141   char *name;
 142
 143   /* Function to call when hardware interface is added/deleted. */
 144   vnet_interface_function_t *interface_add_del_function;
 145
 146   /* Function to bring device administratively up/down. */
 147   vnet_interface_function_t *admin_up_down_function;
 148
 149   /* Function to call when sub-interface is added/deleted */
 150   vnet_subif_add_del_function_t *subif_add_del_function;
 151
 152   /* Function to call interface rx mode is changed */
 153   vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
 154
 155   /* Redistribute flag changes/existence of this interface class. */
 156   u32 redistribute;
 157
 158   /* Transmit function. */
 159   vlib_node_function_t *tx_function;
 160
 161   /* Error strings indexed by error code for this node. */
 162   char **tx_function_error_strings;
 163
 164   /* Number of error codes used by this node. */
 165   u32 tx_function_n_errors;
 166
 167   /* Renumber device name [only!] support, a control-plane kludge */
 168   int (*name_renumber) (struct vnet_hw_interface_t * hi,
 169                         u32 new_dev_instance);
 170
 171   /* Format device instance as name. */
 172   format_function_t *format_device_name;
 173
 174   /* Parse function for device name. */
 175   unformat_function_t *unformat_device_name;
 176
 177   /* Format device verbosely for this class. */
 178   format_function_t *format_device;
 179
 180   /* Trace buffer format for TX function. */
 181   format_function_t *format_tx_trace;
 182
 183   /* Function to clear hardware counters for device. */
 184   void (*clear_counters) (u32 dev_class_instance);
 185
 186     uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
 187                                            u32 hw_if_index,
 188                                            u32 hw_class_index);
 189
 190   /* Called when hardware class of an interface changes. */
 191   void (*hw_class_change) (struct vnet_main_t * vnm,
 192                            u32 hw_if_index, u32 new_hw_class_index);
 193
 194   /* Called to redirect traffic from a specific interface instance */
 195   void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
 196                                u32 hw_if_index, u32 node_index);
 197
 198   /* Link-list of all device classes set up by constructors created below */
 199   struct _vnet_device_class *next_class_registration;
 200
 201   /* Function to set mac address. */
 202   vnet_interface_set_mac_address_function_t *mac_addr_change_function;
 203 } vnet_device_class_t;
 204
 205 #define VNET_DEVICE_CLASS(x,...)                                        \
 206   __VA_ARGS__ vnet_device_class_t x;                                    \
 207 static void __vnet_add_device_class_registration_##x (void)             \
 208     __attribute__((__constructor__)) ;                                  \
 209 static void __vnet_add_device_class_registration_##x (void)             \
 210 {                                                                       \
 211     vnet_main_t * vnm = vnet_get_main();                                \
 212     x.next_class_registration = vnm->device_class_registrations;        \
 213     vnm->device_class_registrations = &x;                               \
 214 }                                                                       \
 215 __VA_ARGS__ vnet_device_class_t x
 216
 217 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt)           \
 218   uword                                                                 \
 219   __attribute__ ((flatten))                                             \
 220   __attribute__ ((target (tgt)))                                        \
 221   CLIB_CPU_OPTIMIZED                                                    \
 222   fn ## _ ## arch ( vlib_main_t * vm,                                   \
 223                    vlib_node_runtime_t * node,                          \
 224                    vlib_frame_t * frame)                                \
 225   { return fn (vm, node, frame); }
 226
 227 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn)                     \
 228   foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
 229
 230 #if CLIB_DEBUG > 0
 231 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
 232 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
 233 #else
 234 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)                      \
 235   VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn)                           \
 236   CLIB_MULTIARCH_SELECT_FN(fn, static inline)                           \
 237   static void __attribute__((__constructor__))                          \
 238   __vlib_device_tx_function_multiarch_select_##dev (void)               \
 239   { dev.tx_function = fn ## _multiarch_select(); }
 240 #endif
 241
 242 /**
 243  * Link Type: A description of the protocol of packets on the link.
 244  * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
 245  * it maps to the GRE-proto, etc for other lnk types.
 246  */
 247 typedef enum vnet_link_t_
 248 {
 249 #if CLIB_DEBUG > 0
 250   VNET_LINK_IP4 = 1,
 251 #else
 252   VNET_LINK_IP4 = 0,
 253 #endif
 254   VNET_LINK_IP6,
 255   VNET_LINK_MPLS,
 256   VNET_LINK_ETHERNET,
 257   VNET_LINK_ARP,
 258   VNET_LINK_NSH,
 259 } __attribute__ ((packed)) vnet_link_t;
 260
 261 #define VNET_LINKS {                   \
 262     [VNET_LINK_ETHERNET] = "ethernet", \
 263     [VNET_LINK_IP4] = "ipv4",          \
 264     [VNET_LINK_IP6] = "ipv6",          \
 265     [VNET_LINK_MPLS] = "mpls",         \
 266     [VNET_LINK_ARP] = "arp",           \
 267     [VNET_LINK_NSH] = "nsh",           \
 268 }
 269
 270 /**
 271  * @brief Number of link types. Not part of the enum so it does not have to be included in
 272  * switch statements
 273  */
 274 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
 275
 276 /**
 277  * @brief Convert a link to to an Ethertype
 278  */
 279 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
 280
 281 /**
 282  * @brief Attributes assignable to a HW interface Class.
 283  */
 284 typedef enum vnet_hw_interface_class_flags_t_
 285 {
 286   /**
 287    * @brief a point 2 point interface
 288    */
 289   VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
 290 } vnet_hw_interface_class_flags_t;
 291
 292 /* Layer-2 (e.g. Ethernet) interface class. */
 293 typedef struct _vnet_hw_interface_class
 294 {
 295   /* Index into main vector. */
 296   u32 index;
 297
 298   /* Class name (e.g. "Ethernet"). */
 299   char *name;
 300
 301   /* Flags */
 302   vnet_hw_interface_class_flags_t flags;
 303
 304   /* Function to call when hardware interface is added/deleted. */
 305   vnet_interface_function_t *interface_add_del_function;
 306
 307   /* Function to bring interface administratively up/down. */
 308   vnet_interface_function_t *admin_up_down_function;
 309
 310   /* Function to call when link state changes. */
 311   vnet_interface_function_t *link_up_down_function;
 312
 313   /* Function to call when link MAC changes. */
 314   vnet_interface_set_mac_address_function_t *mac_addr_change_function;
 315
 316   /* Format function to display interface name. */
 317   format_function_t *format_interface_name;
 318
 319   /* Format function to display interface address. */
 320   format_function_t *format_address;
 321
 322   /* Format packet header for this interface class. */
 323   format_function_t *format_header;
 324
 325   /* Format device verbosely for this class. */
 326   format_function_t *format_device;
 327
 328   /* Parser for hardware (e.g. ethernet) address. */
 329   unformat_function_t *unformat_hw_address;
 330
 331   /* Parser for packet header for e.g. rewrite string. */
 332   unformat_function_t *unformat_header;
 333
 334   /* Builds a rewrite string for the interface to the destination
 335    * for the payload/link type. */
 336   u8 *(*build_rewrite) (struct vnet_main_t * vnm,
 337                         u32 sw_if_index,
 338                         vnet_link_t link_type, const void *dst_hw_address);
 339
 340   /* Update an adjacecny added by FIB (as opposed to via the
 341    * neighbour resolution protocol). */
 342   void (*update_adjacency) (struct vnet_main_t * vnm,
 343                             u32 sw_if_index, u32 adj_index);
 344
 345     uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
 346                                            u32 hw_if_index,
 347                                            u32 hw_class_index);
 348
 349   /* Called when hw interface class is changed and old hardware instance
 350      may want to be deleted. */
 351   void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
 352                            u32 old_class_index, u32 new_class_index);
 353
 354   /* List of hw interface classes, built by constructors */
 355   struct _vnet_hw_interface_class *next_class_registration;
 356
 357 } vnet_hw_interface_class_t;
 358
 359 /**
 360  * @brief Return a complete, zero-length (aka dummy) rewrite
 361  */
 362 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
 363                                   u32 sw_if_index,
 364                                   vnet_link_t link_type,
 365                                   const void *dst_hw_address);
 366
 367 /**
 368  * @brief Default adjacency update function
 369  */
 370 extern void default_update_adjacency (struct vnet_main_t *vnm,
 371                                       u32 sw_if_index, u32 adj_index);
 372
 373 #define VNET_HW_INTERFACE_CLASS(x,...)                                  \
 374   __VA_ARGS__ vnet_hw_interface_class_t x;                              \
 375 static void __vnet_add_hw_interface_class_registration_##x (void)       \
 376     __attribute__((__constructor__)) ;                                  \
 377 static void __vnet_add_hw_interface_class_registration_##x (void)       \
 378 {                                                                       \
 379     vnet_main_t * vnm = vnet_get_main();                                \
 380     x.next_class_registration = vnm->hw_interface_class_registrations;  \
 381     vnm->hw_interface_class_registrations = &x;                         \
 382 }                                                                       \
 383 __VA_ARGS__ vnet_hw_interface_class_t x
 384
 385 /* Hardware-interface.  This corresponds to a physical wire
 386    that packets flow over. */
 387 typedef struct vnet_hw_interface_t
 388 {
 389   /* Interface name. */
 390   u8 *name;
 391
 392   u32 flags;
 393   /* Hardware link state is up. */
 394 #define VNET_HW_INTERFACE_FLAG_LINK_UP          (1 << 0)
 395   /* Hardware duplex state */
 396 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT     1
 397 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX      (1 << 1)
 398 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX      (1 << 2)
 399 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK      \
 400   (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX |         \
 401    VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
 402
 403   /* Hardware link speed */
 404 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT      3
 405 #define VNET_HW_INTERFACE_FLAG_SPEED_10M        (1 << 3)
 406 #define VNET_HW_INTERFACE_FLAG_SPEED_100M       (1 << 4)
 407 #define VNET_HW_INTERFACE_FLAG_SPEED_1G         (1 << 5)
 408 #define VNET_HW_INTERFACE_FLAG_SPEED_10G        (1 << 6)
 409 #define VNET_HW_INTERFACE_FLAG_SPEED_40G        (1 << 7)
 410 #define VNET_HW_INTERFACE_FLAG_SPEED_100G       (1 << 8)
 411 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK       \
 412   (VNET_HW_INTERFACE_FLAG_SPEED_10M |           \
 413    VNET_HW_INTERFACE_FLAG_SPEED_100M |          \
 414    VNET_HW_INTERFACE_FLAG_SPEED_1G |            \
 415    VNET_HW_INTERFACE_FLAG_SPEED_10G |           \
 416    VNET_HW_INTERFACE_FLAG_SPEED_40G |           \
 417    VNET_HW_INTERFACE_FLAG_SPEED_100G)
 418
 419   /* rx mode flags */
 420 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE (1 << 10)
 421
 422   /* tx checksum offload */
 423 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD (1 << 11)
 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_N_COMBINED_INTERFACE_COUNTER = 2,
 638 } vnet_interface_counter_type_t;
 639
 640 typedef struct
 641 {
 642   u32 output_node_index;
 643   u32 tx_node_index;
 644 } vnet_hw_interface_nodes_t;
 645
 646 typedef struct
 647 {
 648   /* Hardware interfaces. */
 649   vnet_hw_interface_t *hw_interfaces;
 650
 651   /* Hash table mapping HW interface name to index. */
 652   uword *hw_interface_by_name;
 653
 654   /* Vectors if hardware interface classes and device classes. */
 655   vnet_hw_interface_class_t *hw_interface_classes;
 656   vnet_device_class_t *device_classes;
 657
 658   /* Hash table mapping name to hw interface/device class. */
 659   uword *hw_interface_class_by_name;
 660   uword *device_class_by_name;
 661
 662   /* Software interfaces. */
 663   vnet_sw_interface_t *sw_interfaces;
 664
 665   /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
 666   uword *sw_if_index_by_sup_and_sub;
 667
 668   /* Software interface counters both simple and combined
 669      packet and byte counters. */
 670   volatile u32 *sw_if_counter_lock;
 671   vlib_simple_counter_main_t *sw_if_counters;
 672   vlib_combined_counter_main_t *combined_sw_if_counters;
 673
 674   vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
 675
 676   /* pcap drop tracing */
 677   int drop_pcap_enable;
 678   pcap_main_t pcap_main;
 679   u8 *pcap_filename;
 680   u32 pcap_sw_if_index;
 681   u32 pcap_pkts_to_capture;
 682   uword *pcap_drop_filter_hash;
 683
 684   /* feature_arc_index */
 685   u8 output_feature_arc_index;
 686 } vnet_interface_main_t;
 687
 688 static inline void
 689 vnet_interface_counter_lock (vnet_interface_main_t * im)
 690 {
 691   if (im->sw_if_counter_lock)
 692     while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
 693       /* zzzz */ ;
 694 }
 695
 696 static inline void
 697 vnet_interface_counter_unlock (vnet_interface_main_t * im)
 698 {
 699   if (im->sw_if_counter_lock)
 700     *im->sw_if_counter_lock = 0;
 701 }
 702
 703 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
 704
 705 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
 706
 707 #endif /* included_vnet_interface_h */
 708
 709 /*
 710  * fd.io coding-style-patch-verification: ON
 711  *
 712  * Local Variables:
 713  * eval: (c-set-style "gnu")
 714  * End:
 715  */