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