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