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 CLIB_MARCH_SFX (                         \
 319     devclass##_tx_fn_registration) = {                                        \
 320     .function = &CLIB_MARCH_SFX (devclass##_tx_fn),                           \
 321   };                                                                          \
 322                                                                               \
 323   static void __clib_constructor CLIB_MARCH_SFX (                             \
 324     devclass##_tx_fn_multiarch_register) (void)                               \
 325   {                                                                           \
 326     extern vnet_device_class_t devclass;                                      \
 327     vlib_node_fn_registration_t *r;                                           \
 328     r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration);                      \
 329     r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE);              \
 330     r->next_registration = devclass.tx_fn_registrations;                      \
 331     devclass.tx_fn_registrations = r;                                         \
 332   }                                                                           \
 333   uword CLIB_MARCH_SFX (devclass##_tx_fn)
 334
 335 /**
 336  * Link Type: A description of the protocol of packets on the link.
 337  * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
 338  * it maps to the GRE-proto, etc for other lnk types.
 339  */
 340 typedef enum vnet_link_t_
 341 {
 342 #if CLIB_DEBUG > 0
 343   VNET_LINK_IP4 = 1,
 344 #else
 345   VNET_LINK_IP4 = 0,
 346 #endif
 347   VNET_LINK_IP6,
 348   VNET_LINK_MPLS,
 349   VNET_LINK_ETHERNET,
 350   VNET_LINK_ARP,
 351   VNET_LINK_NSH,
 352 } __attribute__ ((packed)) vnet_link_t;
 353
 354 #define VNET_LINKS {                   \
 355     [VNET_LINK_ETHERNET] = "ethernet", \
 356     [VNET_LINK_IP4] = "ipv4",          \
 357     [VNET_LINK_IP6] = "ipv6",          \
 358     [VNET_LINK_MPLS] = "mpls",         \
 359     [VNET_LINK_ARP] = "arp",           \
 360     [VNET_LINK_NSH] = "nsh",           \
 361 }
 362
 363 #define FOR_EACH_VNET_LINK(_link)    \
 364   for (_link = VNET_LINK_IP4;        \
 365        _link <= VNET_LINK_NSH;       \
 366        _link++)
 367
 368 #define FOR_EACH_VNET_IP_LINK(_link)    \
 369   for (_link = VNET_LINK_IP4;           \
 370        _link <= VNET_LINK_IP6;          \
 371        _link++)
 372
 373 /**
 374  * @brief Number of link types. Not part of the enum so it does not have to be
 375  * included in switch statements
 376  */
 377 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
 378 #define VNET_N_LINKS VNET_LINK_NUM
 379
 380 /**
 381  * @brief Convert a link to to an Ethertype
 382  */
 383 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
 384
 385 /**
 386  * @brief Attributes assignable to a HW interface Class.
 387  */
 388 typedef enum vnet_hw_interface_class_flags_t_
 389 {
 390   /**
 391    * @brief a point 2 point interface
 392    */
 393   VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
 394   /**
 395    * @brief a non-broadcast multiple access interface
 396    */
 397   VNET_HW_INTERFACE_CLASS_FLAG_NBMA = (1 << 1),
 398 } vnet_hw_interface_class_flags_t;
 399
 400 /* Layer-2 (e.g. Ethernet) interface class. */
 401 typedef struct _vnet_hw_interface_class
 402 {
 403   /* Index into main vector. */
 404   u32 index;
 405
 406   /* Class name (e.g. "Ethernet"). */
 407   char *name;
 408
 409   /* Flags */
 410   vnet_hw_interface_class_flags_t flags;
 411
 412   /* Function to call when hardware interface is added/deleted. */
 413   vnet_interface_function_t *interface_add_del_function;
 414
 415   /* Function to bring interface administratively up/down. */
 416   vnet_interface_function_t *admin_up_down_function;
 417
 418   /* Function to call when link state changes. */
 419   vnet_interface_function_t *link_up_down_function;
 420
 421   /* Function to call when link MAC changes. */
 422   vnet_interface_set_mac_address_function_t *mac_addr_change_function;
 423
 424   /* Function to add/delete additional MAC addresses */
 425   vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
 426
 427   /* Format function to display interface name. */
 428   format_function_t *format_interface_name;
 429
 430   /* Format function to display interface address. */
 431   format_function_t *format_address;
 432
 433   /* Format packet header for this interface class. */
 434   format_function_t *format_header;
 435
 436   /* Format device verbosely for this class. */
 437   format_function_t *format_device;
 438
 439   /* Parser for hardware (e.g. ethernet) address. */
 440   unformat_function_t *unformat_hw_address;
 441
 442   /* Parser for packet header for e.g. rewrite string. */
 443   unformat_function_t *unformat_header;
 444
 445   /* Builds a rewrite string for the interface to the destination
 446    * for the payload/link type. */
 447   u8 *(*build_rewrite) (struct vnet_main_t * vnm,
 448                         u32 sw_if_index,
 449                         vnet_link_t link_type, const void *dst_hw_address);
 450
 451   /* Update an adjacency added by FIB (as opposed to via the
 452    * neighbour resolution protocol). */
 453   void (*update_adjacency) (struct vnet_main_t * vnm,
 454                             u32 sw_if_index, u32 adj_index);
 455
 456     uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
 457                                            u32 hw_if_index,
 458                                            u32 hw_class_index);
 459
 460   /* Called when hw interface class is changed and old hardware instance
 461      may want to be deleted. */
 462   void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
 463                            u32 old_class_index, u32 new_class_index);
 464
 465   /* List of hw interface classes, built by constructors */
 466   struct _vnet_hw_interface_class *next_class_registration;
 467
 468 } vnet_hw_interface_class_t;
 469
 470 /**
 471  * @brief Return a complete, zero-length (aka placeholder) rewrite
 472  */
 473 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
 474                                   u32 sw_if_index,
 475                                   vnet_link_t link_type,
 476                                   const void *dst_hw_address);
 477
 478 /**
 479  * @brief Default adjacency update function
 480  */
 481 extern void default_update_adjacency (struct vnet_main_t *vnm,
 482                                       u32 sw_if_index, u32 adj_index);
 483
 484 #define VNET_HW_INTERFACE_CLASS(x,...)                                  \
 485   __VA_ARGS__ vnet_hw_interface_class_t x;                              \
 486 static void __vnet_add_hw_interface_class_registration_##x (void)       \
 487     __attribute__((__constructor__)) ;                                  \
 488 static void __vnet_add_hw_interface_class_registration_##x (void)       \
 489 {                                                                       \
 490     vnet_main_t * vnm = vnet_get_main();                                \
 491     x.next_class_registration = vnm->hw_interface_class_registrations;  \
 492     vnm->hw_interface_class_registrations = &x;                         \
 493 }                                                                       \
 494 static void __vnet_rm_hw_interface_class_registration_##x (void)        \
 495     __attribute__((__destructor__)) ;                                   \
 496 static void __vnet_rm_hw_interface_class_registration_##x (void)        \
 497 {                                                                       \
 498     vnet_main_t * vnm = vnet_get_main();                                \
 499     VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
 500                                   &x, next_class_registration);         \
 501 }                                                                       \
 502 __VA_ARGS__ vnet_hw_interface_class_t x
 503
 504 typedef enum vnet_hw_interface_flags_t_
 505 {
 506   VNET_HW_INTERFACE_FLAG_NONE,
 507   /* Hardware link state is up. */
 508   VNET_HW_INTERFACE_FLAG_LINK_UP = (1 << 0),
 509   /* Hardware duplex state */
 510   VNET_HW_INTERFACE_FLAG_HALF_DUPLEX = (1 << 1),
 511   VNET_HW_INTERFACE_FLAG_FULL_DUPLEX = (1 << 2),
 512
 513   /* non-broadcast multiple access */
 514   VNET_HW_INTERFACE_FLAG_NBMA = (1 << 19),
 515 } vnet_hw_interface_flags_t;
 516
 517 typedef enum vnet_hw_interface_capabilities_t_
 518 {
 519   VNET_HW_INTERFACE_CAP_NONE,
 520
 521   /* tx checksum offload */
 522   VNET_HW_INTERFACE_CAP_SUPPORTS_TX_IP4_CKSUM = (1 << 0),
 523   VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM = (1 << 1),
 524   VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM = (1 << 2),
 525   VNET_HW_INTERFACE_CAP_SUPPORTS_TX_IP4_OUTER_CKSUM = (1 << 3),
 526   VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_OUTER_CKSUM = (1 << 4),
 527
 528   /* rx checksum offload */
 529   VNET_HW_INTERFACE_CAP_SUPPORTS_RX_IP4_CKSUM = (1 << 5),
 530   VNET_HW_INTERFACE_CAP_SUPPORTS_RX_UDP_CKSUM = (1 << 6),
 531   VNET_HW_INTERFACE_CAP_SUPPORTS_RX_TCP_CKSUM = (1 << 7),
 532   VNET_HW_INTERFACE_CAP_SUPPORTS_RX_IP4_OUTER_CKSUM = (1 << 8),
 533   VNET_HW_INTERFACE_CAP_SUPPORTS_RX_UDP_OUTER_CKSUM = (1 << 9),
 534
 535   /* gso */
 536   VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO = (1 << 10),
 537   VNET_HW_INTERFACE_CAP_SUPPORTS_UDP_GSO = (1 << 11),
 538   VNET_HW_INTERFACE_CAP_SUPPORTS_VXLAN_TNL_GSO = (1 << 12),
 539   VNET_HW_INTERFACE_CAP_SUPPORTS_IPIP_TNL_GSO = (1 << 13),
 540   VNET_HW_INTERFACE_CAP_SUPPORTS_GENEVE_TNL_GSO = (1 << 14),
 541   VNET_HW_INTERFACE_CAP_SUPPORTS_GRE_TNL_GSO = (1 << 15),
 542   VNET_HW_INTERFACE_CAP_SUPPORTS_UDP_TNL_GSO = (1 << 16),
 543   VNET_HW_INTERFACE_CAP_SUPPORTS_IP_TNL_GSO = (1 << 17),
 544
 545   /* lro */
 546   VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_LRO = (1 << 18),
 547
 548   /* rx mode */
 549   VNET_HW_INTERFACE_CAP_SUPPORTS_INT_MODE = (1 << 30),
 550   /* hw/driver can switch between l2-promisc and l3-dmac-filter modes */
 551   VNET_HW_INTERFACE_CAP_SUPPORTS_MAC_FILTER = (1 << 31),
 552 } vnet_hw_interface_capabilities_t;
 553
 554 #define VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM                            \
 555   (VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM |                              \
 556    VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM)
 557
 558 #define VNET_HW_INTERFACE_CAP_SUPPORTS_TX_CKSUM                               \
 559   (VNET_HW_INTERFACE_CAP_SUPPORTS_TX_IP4_CKSUM |                              \
 560    VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM |                              \
 561    VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM)
 562
 563 #define VNET_HW_INTERFACE_CAP_SUPPORTS_L4_RX_CKSUM                            \
 564   (VNET_HW_INTERFACE_CAP_SUPPORTS_RX_TCP_CKSUM |                              \
 565    VNET_HW_INTERFACE_CAP_SUPPORTS_RX_UDP_CKSUM)
 566
 567 #define VNET_HW_INTERFACE_CAP_SUPPORTS_RX_CKSUM                               \
 568   (VNET_HW_INTERFACE_CAP_SUPPORTS_RX_IP4_CKSUM |                              \
 569    VNET_HW_INTERFACE_CAP_SUPPORTS_RX_TCP_CKSUM |                              \
 570    VNET_HW_INTERFACE_CAP_SUPPORTS_RX_UDP_CKSUM)
 571
 572 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
 573 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT  3
 574 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK      \
 575   (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX |         \
 576    VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
 577
 578 typedef struct
 579 {
 580   /* hw interface index */
 581   u32 hw_if_index;
 582
 583   /* device instance */
 584   u32 dev_instance;
 585
 586   /* index of thread pollling this queue */
 587   u32 thread_index;
 588
 589   /* file index of queue interrupt line */
 590   u32 file_index;
 591
 592   /* hardware queue identifier */
 593   u32 queue_id;
 594
 595   /* mode */
 596   vnet_hw_if_rx_mode mode : 8;
 597 #define VNET_HW_IF_RXQ_THREAD_ANY      ~0
 598 #define VNET_HW_IF_RXQ_NO_RX_INTERRUPT ~0
 599 } vnet_hw_if_rx_queue_t;
 600
 601 /* Hardware-interface.  This corresponds to a physical wire
 602    that packets flow over. */
 603 typedef struct vnet_hw_interface_t
 604 {
 605   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 606   /* flags */
 607   vnet_hw_interface_flags_t flags;
 608
 609   /* capabilities flags */
 610   vnet_hw_interface_capabilities_t caps;
 611
 612   /* Hardware address as vector.  Zero (e.g. zero-length vector) if no
 613      address for this class (e.g. PPP). */
 614   u8 *hw_address;
 615
 616   /* Interface is up as far as software is concerned. */
 617   /* NAME.{output,tx} nodes for this interface. */
 618   u32 output_node_index, tx_node_index;
 619
 620   /* interface-output-arc-end node next index for tx node */
 621   u32 if_out_arc_end_node_next_index;
 622
 623   /* (dev_class, dev_instance) uniquely identifies hw interface. */
 624   u32 dev_class_index;
 625   u32 dev_instance;
 626
 627   /* (hw_class, hw_instance) uniquely identifies hw interface. */
 628   u32 hw_class_index;
 629   u32 hw_instance;
 630
 631   /* Hardware index for this hardware interface. */
 632   u32 hw_if_index;
 633
 634   /* Software index for this hardware interface. */
 635   u32 sw_if_index;
 636
 637   CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 638
 639   /* Interface name. */
 640   u8 *name;
 641
 642   /* link speed in kbps */
 643   u32 link_speed;
 644
 645   /* Next index in interface-output node for this interface
 646      used by node function vnet_per_buffer_interface_output() */
 647   u32 output_node_next_index;
 648
 649   /* Maximum transmit rate for this interface in bits/sec. */
 650   f64 max_rate_bits_per_sec;
 651
 652   /* Smallest packet size supported by this interface. */
 653   u32 min_supported_packet_bytes;
 654
 655   /* Largest packet size supported by this interface. */
 656   u32 max_supported_packet_bytes;
 657
 658   /* Smallest packet size for this interface. */
 659   u32 min_packet_bytes;
 660
 661   /* Largest packet size for this interface. */
 662   u32 max_packet_bytes;
 663
 664   /* Hash table mapping sub interface id to sw_if_index. */
 665   uword *sub_interface_sw_if_index_by_id;
 666
 667   /* Count of number of L2 and L3 subinterfaces */
 668   u32 l2_if_count;
 669   u32 l3_if_count;
 670
 671   /* Bonded interface info -
 672      0       - not a bonded interface nor a slave
 673      ~0      - slave to a bonded interface
 674      others  - A bonded interface with a pointer to bitmap for all slaves */
 675   uword *bond_info;
 676 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
 677 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
 678
 679   /* Input node */
 680   u32 input_node_index;
 681
 682   /* input node cpu index by queue */
 683   u32 *input_node_thread_index_by_queue;
 684
 685   vnet_hw_if_rx_mode default_rx_mode;
 686
 687   /* rx queues */
 688   u32 *rx_queue_indices;
 689
 690   /* numa node that hardware device connects to */
 691   u8 numa_node;
 692
 693   /* rss queues bitmap */
 694   clib_bitmap_t *rss_queues;
 695
 696   /* trace */
 697   i32 n_trace;
 698
 699   u32 trace_classify_table_index;
 700 } vnet_hw_interface_t;
 701
 702 STATIC_ASSERT_OFFSET_OF (vnet_hw_interface_t, cacheline1,
 703                          CLIB_CACHE_LINE_BYTES);
 704
 705 typedef struct
 706 {
 707   u32 dev_instance;
 708   u32 queue_id;
 709 } vnet_hw_if_rxq_poll_vector_t;
 710
 711 typedef struct
 712 {
 713   vnet_hw_if_rxq_poll_vector_t *rxq_poll_vector;
 714   void *rxq_interrupts;
 715 } vnet_hw_if_rx_node_runtime_t;
 716
 717 extern vnet_device_class_t vnet_local_interface_device_class;
 718
 719 typedef enum
 720 {
 721   /* A hw interface. */
 722   VNET_SW_INTERFACE_TYPE_HARDWARE,
 723
 724   /* A sub-interface. */
 725   VNET_SW_INTERFACE_TYPE_SUB,
 726   VNET_SW_INTERFACE_TYPE_P2P,
 727   VNET_SW_INTERFACE_TYPE_PIPE,
 728 } vnet_sw_interface_type_t;
 729
 730 typedef struct
 731 {
 732   /*
 733    * Subinterface ID. A number 0-N to uniquely identify
 734    * this subinterface under the main (parent?) interface
 735    */
 736   u32 id;
 737
 738   /* Classification data. Used to associate packet header with subinterface. */
 739   struct
 740   {
 741     u16 outer_vlan_id;
 742     u16 inner_vlan_id;
 743     union
 744     {
 745       u16 raw_flags;
 746       struct
 747       {
 748         u16 no_tags:1;
 749         u16 one_tag:1;
 750         u16 two_tags:1;
 751         u16 dot1ad:1;           /* 0 = dot1q, 1=dot1ad */
 752         u16 exact_match:1;
 753         u16 default_sub:1;
 754         u16 outer_vlan_id_any:1;
 755         u16 inner_vlan_id_any:1;
 756       } flags;
 757     };
 758   } eth;
 759 } vnet_sub_interface_t;
 760
 761 typedef struct
 762 {
 763   /*
 764    * Subinterface ID. A number 0-N to uniquely identify
 765    * this subinterface under the main interface
 766    */
 767   u32 id;
 768   u32 pool_index;
 769   u8 client_mac[6];
 770 } vnet_p2p_sub_interface_t;
 771
 772 typedef enum
 773 {
 774   /* THe BVI interface */
 775   VNET_FLOOD_CLASS_BVI,
 776   /* Always flood */
 777   VNET_FLOOD_CLASS_NORMAL,
 778   VNET_FLOOD_CLASS_TUNNEL_MASTER,
 779   /* Does not flood when tunnel master is in the same L2 BD */
 780   VNET_FLOOD_CLASS_TUNNEL_NORMAL,
 781   /* Never flood to this type */
 782   VNET_FLOOD_CLASS_NO_FLOOD,
 783 } vnet_flood_class_t;
 784
 785 /* Per protocol MTU */
 786 typedef enum
 787 {
 788   VNET_MTU_L3,                  /* Default payload MTU (without L2 headers) */
 789   VNET_MTU_IP4,                 /* Per-protocol MTUs overriding default */
 790   VNET_MTU_IP6,
 791   VNET_MTU_MPLS,
 792   VNET_N_MTU
 793 } vnet_mtu_t;
 794
 795 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
 796
 797 typedef enum vnet_sw_interface_flags_t_
 798 {
 799   VNET_SW_INTERFACE_FLAG_NONE = 0,
 800   /* Interface is "up" meaning administratively up.
 801      Up in the sense of link state being up is maintained by hardware interface. */
 802   VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
 803
 804   /* Interface is disabled for forwarding: punt all traffic to slow-path. */
 805   VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
 806
 807   __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
 808
 809   VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
 810
 811   __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
 812
 813   /* Interface does not appear in CLI/API */
 814   VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
 815
 816   /* Interface in ERROR state */
 817   VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
 818
 819   /* Interface has IP configured directed broadcast */
 820   VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
 821
 822 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
 823
 824 /* Software-interface.  This corresponds to a Ethernet VLAN, ATM vc, a
 825    tunnel, etc.  Configuration (e.g. IP address) gets attached to
 826    software interface. */
 827 typedef struct
 828 {
 829   vnet_sw_interface_type_t type:16;
 830
 831   vnet_sw_interface_flags_t flags;
 832
 833   /* Index for this interface. */
 834   u32 sw_if_index;
 835
 836   /* Software interface index of super-interface;
 837      equal to sw_if_index if this interface is not a
 838      sub-interface. */
 839   u32 sup_sw_if_index;
 840
 841   /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
 842   u32 unnumbered_sw_if_index;
 843
 844   /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
 845   u32 hw_if_index;
 846
 847   /* MTU for network layer (not including L2 headers) */
 848   u32 mtu[VNET_N_MTU];
 849
 850   /* VNET_SW_INTERFACE_TYPE_SUB. */
 851   vnet_sub_interface_t sub;
 852
 853   /* VNET_SW_INTERFACE_TYPE_P2P. */
 854   vnet_p2p_sub_interface_t p2p;
 855
 856   vnet_flood_class_t flood_class;
 857 } vnet_sw_interface_t;
 858
 859 typedef enum
 860 {
 861   /* Simple counters. */
 862   VNET_INTERFACE_COUNTER_DROP = 0,
 863   VNET_INTERFACE_COUNTER_PUNT = 1,
 864   VNET_INTERFACE_COUNTER_IP4 = 2,
 865   VNET_INTERFACE_COUNTER_IP6 = 3,
 866   VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
 867   VNET_INTERFACE_COUNTER_RX_MISS = 5,
 868   VNET_INTERFACE_COUNTER_RX_ERROR = 6,
 869   VNET_INTERFACE_COUNTER_TX_ERROR = 7,
 870   VNET_INTERFACE_COUNTER_MPLS = 8,
 871   VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
 872   /* Combined counters. */
 873   VNET_INTERFACE_COUNTER_RX = 0,
 874   VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
 875   VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
 876   VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
 877   VNET_INTERFACE_COUNTER_TX = 4,
 878   VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
 879   VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
 880   VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
 881   VNET_N_COMBINED_INTERFACE_COUNTER = 8,
 882 } vnet_interface_counter_type_t;
 883
 884 #define foreach_rx_combined_interface_counter(_x)               \
 885   for (_x = VNET_INTERFACE_COUNTER_RX;                          \
 886        _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST;               \
 887        _x++)
 888
 889 #define foreach_tx_combined_interface_counter(_x)               \
 890   for (_x = VNET_INTERFACE_COUNTER_TX;                          \
 891        _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST;               \
 892        _x++)
 893
 894 #define foreach_simple_interface_counter_name   \
 895   _(DROP, drops, if)                            \
 896   _(PUNT, punt, if)                             \
 897   _(IP4, ip4, if)                               \
 898   _(IP6, ip6, if)                               \
 899   _(RX_NO_BUF, rx-no-buf, if)                   \
 900   _(RX_MISS, rx-miss, if)                       \
 901   _(RX_ERROR, rx-error, if)                     \
 902   _(TX_ERROR, tx-error, if)         \
 903   _(MPLS, mpls, if)
 904
 905 #define foreach_combined_interface_counter_name \
 906   _(RX, rx, if)                                 \
 907   _(RX_UNICAST, rx-unicast, if)                 \
 908   _(RX_MULTICAST, rx-multicast, if)             \
 909   _(RX_BROADCAST, rx-broadcast, if)             \
 910   _(TX, tx, if)                                 \
 911   _(TX_UNICAST, tx-unicast, if)                 \
 912   _(TX_MULTICAST, tx-multicast, if)             \
 913   _(TX_BROADCAST, tx-broadcast, if)
 914
 915 typedef enum
 916 {
 917   COLLECT_SIMPLE_STATS = 0,
 918   COLLECT_DETAILED_STATS = 1,
 919 } vnet_interface_stats_collection_mode_e;
 920
 921 extern int collect_detailed_interface_stats_flag;
 922
 923 static inline int
 924 collect_detailed_interface_stats (void)
 925 {
 926   return collect_detailed_interface_stats_flag;
 927 }
 928
 929 void collect_detailed_interface_stats_flag_set (void);
 930 void collect_detailed_interface_stats_flag_clear (void);
 931
 932
 933 typedef struct
 934 {
 935   u32 output_node_index;
 936   u32 tx_node_index;
 937 } vnet_hw_interface_nodes_t;
 938
 939 typedef struct
 940 {
 941   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 942   u32 *split_buffers;
 943 } vnet_interface_per_thread_data_t;
 944
 945 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
 946                                                u8 * s);
 947
 948 typedef struct
 949 {
 950   /* Hardware interfaces. */
 951   vnet_hw_interface_t *hw_interfaces;
 952
 953   /* Hardware interface RX queues */
 954   vnet_hw_if_rx_queue_t *hw_if_rx_queues;
 955   uword *rxq_index_by_hw_if_index_and_queue_id;
 956
 957   /* Hash table mapping HW interface name to index. */
 958   uword *hw_interface_by_name;
 959
 960   /* Vectors if hardware interface classes and device classes. */
 961   vnet_hw_interface_class_t *hw_interface_classes;
 962   vnet_device_class_t *device_classes;
 963
 964   /* Hash table mapping name to hw interface/device class. */
 965   uword *hw_interface_class_by_name;
 966   uword *device_class_by_name;
 967
 968   /* Software interfaces. */
 969   vnet_sw_interface_t *sw_interfaces;
 970
 971   /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
 972   uword *sw_if_index_by_sup_and_sub;
 973
 974   /* Software interface counters both simple and combined
 975      packet and byte counters. */
 976   clib_spinlock_t sw_if_counter_lock;
 977   vlib_simple_counter_main_t *sw_if_counters;
 978   vlib_combined_counter_main_t *combined_sw_if_counters;
 979
 980   vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
 981
 982   /*
 983    * pcap drop tracing
 984    * Only the drop filter hash lives here. See ../src/vlib/main.h for
 985    * the rest of the variables.
 986    */
 987   uword *pcap_drop_filter_hash;
 988
 989   /* Buffer metadata format helper functions */
 990   vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
 991   vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
 992
 993   /* per-thread data */
 994   vnet_interface_per_thread_data_t *per_thread_data;
 995
 996   /* feature_arc_index */
 997   u8 output_feature_arc_index;
 998
 999   /* fast lookup tables */
1000   u32 *hw_if_index_by_sw_if_index;
1001   u16 *if_out_arc_end_next_index_by_sw_if_index;
1002 } vnet_interface_main_t;
1003
1004 static inline void
1005 vnet_interface_counter_lock (vnet_interface_main_t * im)
1006 {
1007   if (im->sw_if_counter_lock)
1008     clib_spinlock_lock (&im->sw_if_counter_lock);
1009 }
1010
1011 static inline void
1012 vnet_interface_counter_unlock (vnet_interface_main_t * im)
1013 {
1014   if (im->sw_if_counter_lock)
1015     clib_spinlock_unlock (&im->sw_if_counter_lock);
1016 }
1017
1018 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
1019
1020 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
1021
1022 void vnet_register_format_buffer_opaque_helper
1023   (vnet_buffer_opquae_formatter_t fn);
1024
1025 void vnet_register_format_buffer_opaque2_helper
1026   (vnet_buffer_opquae_formatter_t fn);
1027
1028 typedef struct
1029 {
1030   u8 *filename;
1031   int enable;
1032   int status;
1033   u32 packets_to_capture;
1034   u32 max_bytes_per_pkt;
1035   u8 rx_enable;
1036   u8 tx_enable;
1037   u8 drop_enable;
1038   u8 preallocate_data;
1039   u8 free_data;
1040   u32 sw_if_index;
1041   int filter;
1042   vlib_error_t drop_err;
1043 } vnet_pcap_dispatch_trace_args_t;
1044
1045 int vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t *);
1046
1047 extern vlib_node_registration_t vnet_interface_output_node;
1048 extern vlib_node_registration_t vnet_interface_output_arc_end_node;
1049
1050 #endif /* included_vnet_interface_h */
1051
1052 /*
1053  * fd.io coding-style-patch-verification: ON
1054  *
1055  * Local Variables:
1056  * eval: (c-set-style "gnu")
1057  * End:
1058  */