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