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