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