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