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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * interface.h: VNET interfaces/sub-interfaces
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_vnet_interface_h
41 #define included_vnet_interface_h
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>
50 struct vnet_hw_interface_t;
51 struct vnet_sw_interface_t;
52 union ip46_address_t_;
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,
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);
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);
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);
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);
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);
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,
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);
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;
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);
111 typedef enum vnet_interface_function_priority_t_
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)
118 typedef struct _vnet_interface_function_list_elt
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;
124 #ifndef CLIB_MARCH_VARIANT
125 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
127 static void __vnet_interface_function_init_##tag##_##f (void) \
128 __attribute__((__constructor__)) ; \
130 static void __vnet_interface_function_init_##tag##_##f (void) \
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; \
138 static void __vnet_interface_function_deinit_##tag##_##f (void) \
139 __attribute__((__destructor__)) ; \
141 static void __vnet_interface_function_deinit_##tag##_##f (void) \
143 vnet_main_t * vnm = vnet_get_main(); \
144 _vnet_interface_function_list_elt_t *next; \
145 if (vnm->tag##_functions[p]->fp == f) \
147 vnm->tag##_functions[p] = \
148 vnm->tag##_functions[p]->next_interface_function; \
151 next = vnm->tag##_functions[p]; \
152 while (next->next_interface_function) \
154 if (next->next_interface_function->fp == f) \
156 next->next_interface_function = \
157 next->next_interface_function->next_interface_function; \
160 next = next->next_interface_function; \
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;
170 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
171 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
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)
191 * Tunnel description parameters
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,
198 /* A class of hardware interface devices. */
199 typedef struct _vnet_device_class
201 /* Index into main vector. */
204 /* Device name (e.g. "FOOBAR 1234a"). */
207 /* Function to call when hardware interface is added/deleted. */
208 vnet_interface_function_t *interface_add_del_function;
210 /* Function to bring device administratively up/down. */
211 vnet_interface_function_t *admin_up_down_function;
213 /* Function to call when sub-interface is added/deleted */
214 vnet_subif_add_del_function_t *subif_add_del_function;
216 /* Function to call interface rx mode is changed */
217 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
219 /* Function to call interface l2 mode is changed */
220 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
222 /* Redistribute flag changes/existence of this interface class. */
225 /* Transmit function. */
226 vlib_node_function_t *tx_function;
228 /* Transmit function candidate registration with priority */
229 vlib_node_fn_registration_t *tx_fn_registrations;
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;
235 /* Number of error codes used by this node. */
236 u32 tx_function_n_errors;
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);
242 /* Interface flow offload operations */
243 vnet_flow_dev_ops_function_t *flow_ops_function;
245 /* Format device instance as name. */
246 format_function_t *format_device_name;
248 /* Parse function for device name. */
249 unformat_function_t *unformat_device_name;
251 /* Format device verbosely for this class. */
252 format_function_t *format_device;
254 /* Trace buffer format for TX function. */
255 format_function_t *format_tx_trace;
257 /* Format flow offload entry */
258 format_function_t *format_flow;
260 vnet_dev_class_ip_tunnel_desc_t ip_tun_desc;
262 /* Function to clear hardware counters for device. */
263 void (*clear_counters) (u32 dev_class_instance);
265 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
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);
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);
277 /* Link-list of all device classes set up by constructors created below */
278 struct _vnet_device_class *next_class_registration;
280 /* Function to set mac address. */
281 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
283 /* Function to add/delete additional MAC addresses */
284 vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
286 /* Interface to set rss queues of the interface */
287 vnet_interface_rss_queues_set_t *set_rss_queues_function;
289 } vnet_device_class_t;
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) \
298 vnet_main_t * vnm = vnet_get_main(); \
299 x.next_class_registration = vnm->device_class_registrations; \
300 vnm->device_class_registrations = &x; \
302 static void __vnet_rm_device_class_registration_##x (void) \
303 __attribute__((__destructor__)) ; \
304 static void __vnet_rm_device_class_registration_##x (void) \
306 vnet_main_t * vnm = vnet_get_main(); \
307 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
308 &x, next_class_registration); \
310 __VA_ARGS__ vnet_device_class_t x
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
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), \
325 static void __clib_constructor CLIB_MARCH_SFX ( \
326 devclass##_tx_fn_multiarch_register) (void) \
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; \
335 uword CLIB_MARCH_SFX (devclass##_tx_fn)
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.
342 typedef enum vnet_link_t_
354 } __attribute__ ((packed)) vnet_link_t;
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", \
365 #define FOR_EACH_VNET_LINK(_link) \
366 for (_link = VNET_LINK_IP4; \
367 _link <= VNET_LINK_NSH; \
370 #define FOR_EACH_VNET_IP_LINK(_link) \
371 for (_link = VNET_LINK_IP4; \
372 _link <= VNET_LINK_IP6; \
376 * @brief Number of link types. Not part of the enum so it does not have to be
377 * included in switch statements
379 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
380 #define VNET_N_LINKS VNET_LINK_NUM
383 * @brief Convert a link to to an Ethertype
385 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
388 * @brief Attributes assignable to a HW interface Class.
390 typedef enum vnet_hw_interface_class_flags_t_
393 * @brief a point 2 point interface
395 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
397 * @brief a non-broadcast multiple access interface
399 VNET_HW_INTERFACE_CLASS_FLAG_NBMA = (1 << 1),
400 } vnet_hw_interface_class_flags_t;
402 /* Layer-2 (e.g. Ethernet) interface class. */
403 typedef struct _vnet_hw_interface_class
405 /* Index into main vector. */
408 /* Class name (e.g. "Ethernet"). */
412 vnet_hw_interface_class_flags_t flags;
414 /* tx hash type for interfaces of this hw class */
415 vnet_hash_fn_type_t tx_hash_fn_type;
417 /* Function to call when hardware interface is added/deleted. */
418 vnet_interface_function_t *interface_add_del_function;
420 /* Function to bring interface administratively up/down. */
421 vnet_interface_function_t *admin_up_down_function;
423 /* Function to call when link state changes. */
424 vnet_interface_function_t *link_up_down_function;
426 /* Function to call when link MAC changes. */
427 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
429 /* Function to add/delete additional MAC addresses */
430 vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
432 /* Format function to display interface name. */
433 format_function_t *format_interface_name;
435 /* Format function to display interface address. */
436 format_function_t *format_address;
438 /* Format packet header for this interface class. */
439 format_function_t *format_header;
441 /* Format device verbosely for this class. */
442 format_function_t *format_device;
444 /* Parser for hardware (e.g. ethernet) address. */
445 unformat_function_t *unformat_hw_address;
447 /* Parser for packet header for e.g. rewrite string. */
448 unformat_function_t *unformat_header;
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,
454 vnet_link_t link_type, const void *dst_hw_address);
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);
461 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
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);
470 /* List of hw interface classes, built by constructors */
471 struct _vnet_hw_interface_class *next_class_registration;
473 } vnet_hw_interface_class_t;
476 * @brief Return a complete, zero-length (aka placeholder) rewrite
478 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
480 vnet_link_t link_type,
481 const void *dst_hw_address);
484 * @brief Default adjacency update function
486 extern void default_update_adjacency (struct vnet_main_t *vnm,
487 u32 sw_if_index, u32 adj_index);
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) \
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; \
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) \
503 vnet_main_t * vnm = vnet_get_main(); \
504 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
505 &x, next_class_registration); \
507 __VA_ARGS__ vnet_hw_interface_class_t x
509 typedef enum vnet_hw_interface_flags_t_
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),
518 /* non-broadcast multiple access */
519 VNET_HW_INTERFACE_FLAG_NBMA = (1 << 19),
520 } vnet_hw_interface_flags_t;
522 typedef enum vnet_hw_interface_capabilities_t_
524 VNET_HW_INTERFACE_CAP_NONE,
526 /* tx checksum offload */
527 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_IP4_CKSUM = (1 << 0),
528 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM = (1 << 1),
529 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM = (1 << 2),
530 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_IP4_OUTER_CKSUM = (1 << 3),
531 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_OUTER_CKSUM = (1 << 4),
533 /* rx checksum offload */
534 VNET_HW_INTERFACE_CAP_SUPPORTS_RX_IP4_CKSUM = (1 << 5),
535 VNET_HW_INTERFACE_CAP_SUPPORTS_RX_UDP_CKSUM = (1 << 6),
536 VNET_HW_INTERFACE_CAP_SUPPORTS_RX_TCP_CKSUM = (1 << 7),
537 VNET_HW_INTERFACE_CAP_SUPPORTS_RX_IP4_OUTER_CKSUM = (1 << 8),
538 VNET_HW_INTERFACE_CAP_SUPPORTS_RX_UDP_OUTER_CKSUM = (1 << 9),
541 VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO = (1 << 10),
542 VNET_HW_INTERFACE_CAP_SUPPORTS_UDP_GSO = (1 << 11),
543 VNET_HW_INTERFACE_CAP_SUPPORTS_VXLAN_TNL_GSO = (1 << 12),
544 VNET_HW_INTERFACE_CAP_SUPPORTS_IPIP_TNL_GSO = (1 << 13),
545 VNET_HW_INTERFACE_CAP_SUPPORTS_GENEVE_TNL_GSO = (1 << 14),
546 VNET_HW_INTERFACE_CAP_SUPPORTS_GRE_TNL_GSO = (1 << 15),
547 VNET_HW_INTERFACE_CAP_SUPPORTS_UDP_TNL_GSO = (1 << 16),
548 VNET_HW_INTERFACE_CAP_SUPPORTS_IP_TNL_GSO = (1 << 17),
551 VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_LRO = (1 << 18),
554 VNET_HW_INTERFACE_CAP_SUPPORTS_INT_MODE = (1 << 30),
555 /* hw/driver can switch between l2-promisc and l3-dmac-filter modes */
556 VNET_HW_INTERFACE_CAP_SUPPORTS_MAC_FILTER = (1 << 31),
557 } vnet_hw_interface_capabilities_t;
559 #define VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM \
560 (VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM | \
561 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM)
563 #define VNET_HW_INTERFACE_CAP_SUPPORTS_TX_CKSUM \
564 (VNET_HW_INTERFACE_CAP_SUPPORTS_TX_IP4_CKSUM | \
565 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM | \
566 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM)
568 #define VNET_HW_INTERFACE_CAP_SUPPORTS_TX_OUTER_CKSUM \
569 (VNET_HW_INTERFACE_CAP_SUPPORTS_TX_IP4_OUTER_CKSUM | \
570 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_OUTER_CKSUM)
572 #define VNET_HW_INTERFACE_CAP_SUPPORTS_TX_CKSUM_MASK \
573 (VNET_HW_INTERFACE_CAP_SUPPORTS_TX_CKSUM | \
574 VNET_HW_INTERFACE_CAP_SUPPORTS_TX_OUTER_CKSUM)
576 #define VNET_HW_INTERFACE_CAP_SUPPORTS_L4_RX_CKSUM \
577 (VNET_HW_INTERFACE_CAP_SUPPORTS_RX_TCP_CKSUM | \
578 VNET_HW_INTERFACE_CAP_SUPPORTS_RX_UDP_CKSUM)
580 #define VNET_HW_INTERFACE_CAP_SUPPORTS_RX_CKSUM \
581 (VNET_HW_INTERFACE_CAP_SUPPORTS_RX_IP4_CKSUM | \
582 VNET_HW_INTERFACE_CAP_SUPPORTS_RX_TCP_CKSUM | \
583 VNET_HW_INTERFACE_CAP_SUPPORTS_RX_UDP_CKSUM)
585 #define VNET_HW_INTERFACE_CAP_SUPPORTS_TNL_GSO_MASK \
586 VNET_HW_INTERFACE_CAP_SUPPORTS_VXLAN_TNL_GSO | \
587 VNET_HW_INTERFACE_CAP_SUPPORTS_IPIP_TNL_GSO
589 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
590 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
591 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
592 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
593 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
597 /* hw interface index */
600 /* device instance */
603 /* index of thread pollling this queue */
606 /* file index of queue interrupt line */
609 /* hardware queue identifier */
613 vnet_hw_if_rx_mode mode : 8;
614 #define VNET_HW_IF_RXQ_THREAD_ANY ~0
615 #define VNET_HW_IF_RXQ_NO_RX_INTERRUPT ~0
616 } vnet_hw_if_rx_queue_t;
621 /* hw interface index */
624 /* hardware queue identifier */
627 /* bitmap of threads which use this queue */
628 clib_bitmap_t *threads;
629 } vnet_hw_if_tx_queue_t;
633 VNET_HW_IF_TX_FRAME_HINT_NOT_CHAINED = (1 << 0),
634 VNET_HW_IF_TX_FRAME_HINT_NO_GSO = (1 << 1),
635 VNET_HW_IF_TX_FRAME_HINT_NO_CKSUM_OFFLOAD = (1 << 2),
636 } vnet_hw_if_tx_frame_hint_t;
641 vnet_hw_if_tx_frame_hint_t hints : 16;
643 } vnet_hw_if_tx_frame_t;
647 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
648 vnet_hw_if_tx_frame_t *frame;
651 } vnet_hw_if_output_node_runtime_t;
653 /* Hardware-interface. This corresponds to a physical wire
654 that packets flow over. */
655 typedef struct vnet_hw_interface_t
657 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
659 vnet_hw_interface_flags_t flags;
661 /* capabilities flags */
662 vnet_hw_interface_capabilities_t caps;
664 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
665 address for this class (e.g. PPP). */
668 /* Interface is up as far as software is concerned. */
669 /* NAME.{output,tx} nodes for this interface. */
670 u32 output_node_index, tx_node_index;
672 /* interface-output-arc-end node next index for tx node */
673 u32 if_out_arc_end_node_next_index;
675 /* (dev_class, dev_instance) uniquely identifies hw interface. */
679 /* (hw_class, hw_instance) uniquely identifies hw interface. */
683 /* Hardware index for this hardware interface. */
686 /* Software index for this hardware interface. */
689 /* per thread output-node runtimes */
690 vnet_hw_if_output_node_runtime_t *output_node_thread_runtimes;
692 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
694 /* Interface name. */
697 /* link speed in kbps */
700 /* Next index in interface-output node for this interface
701 used by node function vnet_per_buffer_interface_output() */
702 u32 output_node_next_index;
704 /* called when hw interface is using transmit side packet steering */
707 /* Maximum transmit rate for this interface in bits/sec. */
708 f64 max_rate_bits_per_sec;
710 /* Smallest packet size supported by this interface. */
711 u32 min_supported_packet_bytes;
713 /* Largest packet size supported by this interface. */
714 u32 max_supported_packet_bytes;
716 /* Smallest packet size for this interface. */
717 u32 min_packet_bytes;
719 /* Largest packet size for this interface. */
720 u32 max_packet_bytes;
722 /* Hash table mapping sub interface id to sw_if_index. */
723 uword *sub_interface_sw_if_index_by_id;
725 /* Count of number of L2 and L3 subinterfaces */
729 /* Bonded interface info -
730 0 - not a bonded interface nor a slave
731 ~0 - slave to a bonded interface
732 others - A bonded interface with a pointer to bitmap for all slaves */
734 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
735 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
738 u32 input_node_index;
740 vnet_hw_if_rx_mode default_rx_mode;
743 u32 *rx_queue_indices;
746 u32 *tx_queue_indices;
748 /* numa node that hardware device connects to */
751 /* rss queues bitmap */
752 clib_bitmap_t *rss_queues;
757 u32 trace_classify_table_index;
758 } vnet_hw_interface_t;
760 STATIC_ASSERT_OFFSET_OF (vnet_hw_interface_t, cacheline1,
761 CLIB_CACHE_LINE_BYTES);
767 } vnet_hw_if_rxq_poll_vector_t;
771 vnet_hw_if_rxq_poll_vector_t *rxq_vector_int;
772 vnet_hw_if_rxq_poll_vector_t *rxq_vector_poll;
773 void *rxq_interrupts;
774 } vnet_hw_if_rx_node_runtime_t;
776 extern vnet_device_class_t vnet_local_interface_device_class;
780 /* A hw interface. */
781 VNET_SW_INTERFACE_TYPE_HARDWARE,
783 /* A sub-interface. */
784 VNET_SW_INTERFACE_TYPE_SUB,
785 VNET_SW_INTERFACE_TYPE_P2P,
786 VNET_SW_INTERFACE_TYPE_PIPE,
787 } vnet_sw_interface_type_t;
792 * Subinterface ID. A number 0-N to uniquely identify
793 * this subinterface under the main (parent?) interface
797 /* Classification data. Used to associate packet header with subinterface. */
810 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
813 u16 outer_vlan_id_any:1;
814 u16 inner_vlan_id_any:1;
818 } vnet_sub_interface_t;
823 * Subinterface ID. A number 0-N to uniquely identify
824 * this subinterface under the main interface
829 } vnet_p2p_sub_interface_t;
833 /* THe BVI interface */
834 VNET_FLOOD_CLASS_BVI,
836 VNET_FLOOD_CLASS_NORMAL,
837 VNET_FLOOD_CLASS_TUNNEL_MASTER,
838 /* Does not flood when tunnel master is in the same L2 BD */
839 VNET_FLOOD_CLASS_TUNNEL_NORMAL,
840 /* Never flood to this type */
841 VNET_FLOOD_CLASS_NO_FLOOD,
842 } vnet_flood_class_t;
844 /* Per protocol MTU */
847 VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
848 VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
854 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
856 typedef enum vnet_sw_interface_flags_t_
858 VNET_SW_INTERFACE_FLAG_NONE = 0,
859 /* Interface is "up" meaning administratively up.
860 Up in the sense of link state being up is maintained by hardware interface. */
861 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
863 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
864 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
866 __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
868 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
870 __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
872 /* Interface does not appear in CLI/API */
873 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
875 /* Interface in ERROR state */
876 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
878 /* Interface has IP configured directed broadcast */
879 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
881 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
883 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
884 tunnel, etc. Configuration (e.g. IP address) gets attached to
885 software interface. */
888 vnet_sw_interface_type_t type:16;
890 vnet_sw_interface_flags_t flags;
892 /* Index for this interface. */
895 /* Software interface index of super-interface;
896 equal to sw_if_index if this interface is not a
900 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
901 u32 unnumbered_sw_if_index;
903 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
906 /* MTU for network layer (not including L2 headers) */
909 /* VNET_SW_INTERFACE_TYPE_SUB. */
910 vnet_sub_interface_t sub;
912 /* VNET_SW_INTERFACE_TYPE_P2P. */
913 vnet_p2p_sub_interface_t p2p;
915 vnet_flood_class_t flood_class;
916 } vnet_sw_interface_t;
920 /* Simple counters. */
921 VNET_INTERFACE_COUNTER_DROP = 0,
922 VNET_INTERFACE_COUNTER_PUNT = 1,
923 VNET_INTERFACE_COUNTER_IP4 = 2,
924 VNET_INTERFACE_COUNTER_IP6 = 3,
925 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
926 VNET_INTERFACE_COUNTER_RX_MISS = 5,
927 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
928 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
929 VNET_INTERFACE_COUNTER_MPLS = 8,
930 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
931 /* Combined counters. */
932 VNET_INTERFACE_COUNTER_RX = 0,
933 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
934 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
935 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
936 VNET_INTERFACE_COUNTER_TX = 4,
937 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
938 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
939 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
940 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
941 } vnet_interface_counter_type_t;
943 #define foreach_rx_combined_interface_counter(_x) \
944 for (_x = VNET_INTERFACE_COUNTER_RX; \
945 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
948 #define foreach_tx_combined_interface_counter(_x) \
949 for (_x = VNET_INTERFACE_COUNTER_TX; \
950 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
953 #define foreach_simple_interface_counter_name \
958 _(RX_NO_BUF, rx-no-buf, if) \
959 _(RX_MISS, rx-miss, if) \
960 _(RX_ERROR, rx-error, if) \
961 _(TX_ERROR, tx-error, if) \
964 #define foreach_combined_interface_counter_name \
966 _(RX_UNICAST, rx-unicast, if) \
967 _(RX_MULTICAST, rx-multicast, if) \
968 _(RX_BROADCAST, rx-broadcast, if) \
970 _(TX_UNICAST, tx-unicast, if) \
971 _(TX_MULTICAST, tx-multicast, if) \
972 _(TX_BROADCAST, tx-broadcast, if)
976 COLLECT_SIMPLE_STATS = 0,
977 COLLECT_DETAILED_STATS = 1,
978 } vnet_interface_stats_collection_mode_e;
980 extern int collect_detailed_interface_stats_flag;
983 collect_detailed_interface_stats (void)
985 return collect_detailed_interface_stats_flag;
988 void collect_detailed_interface_stats_flag_set (void);
989 void collect_detailed_interface_stats_flag_clear (void);
994 u32 output_node_index;
996 } vnet_hw_interface_nodes_t;
1000 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
1002 } vnet_interface_per_thread_data_t;
1004 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
1009 /* Hardware interfaces. */
1010 vnet_hw_interface_t *hw_interfaces;
1012 /* Hardware interface RX queues */
1013 vnet_hw_if_rx_queue_t *hw_if_rx_queues;
1014 uword *rxq_index_by_hw_if_index_and_queue_id;
1016 /* Hardware interface TX queues */
1017 vnet_hw_if_tx_queue_t *hw_if_tx_queues;
1018 uword *txq_index_by_hw_if_index_and_queue_id;
1020 /* Hash table mapping HW interface name to index. */
1021 uword *hw_interface_by_name;
1023 /* Vectors if hardware interface classes and device classes. */
1024 vnet_hw_interface_class_t *hw_interface_classes;
1025 vnet_device_class_t *device_classes;
1027 /* Hash table mapping name to hw interface/device class. */
1028 uword *hw_interface_class_by_name;
1029 uword *device_class_by_name;
1031 /* Software interfaces. */
1032 vnet_sw_interface_t *sw_interfaces;
1034 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
1035 uword *sw_if_index_by_sup_and_sub;
1037 /* Software interface counters both simple and combined
1038 packet and byte counters. */
1039 clib_spinlock_t sw_if_counter_lock;
1040 vlib_simple_counter_main_t *sw_if_counters;
1041 vlib_combined_counter_main_t *combined_sw_if_counters;
1043 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
1047 * Only the drop filter hash lives here. See ../src/vlib/main.h for
1048 * the rest of the variables.
1050 uword *pcap_drop_filter_hash;
1052 /* Buffer metadata format helper functions */
1053 vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
1054 vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
1056 /* per-thread data */
1057 vnet_interface_per_thread_data_t *per_thread_data;
1059 /* feature_arc_index */
1060 u8 output_feature_arc_index;
1062 /* fast lookup tables */
1063 u32 *hw_if_index_by_sw_if_index;
1064 u16 *if_out_arc_end_next_index_by_sw_if_index;
1065 } vnet_interface_main_t;
1068 vnet_interface_counter_lock (vnet_interface_main_t * im)
1070 if (im->sw_if_counter_lock)
1071 clib_spinlock_lock (&im->sw_if_counter_lock);
1075 vnet_interface_counter_unlock (vnet_interface_main_t * im)
1077 if (im->sw_if_counter_lock)
1078 clib_spinlock_unlock (&im->sw_if_counter_lock);
1081 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
1083 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
1085 void vnet_register_format_buffer_opaque_helper
1086 (vnet_buffer_opquae_formatter_t fn);
1088 void vnet_register_format_buffer_opaque2_helper
1089 (vnet_buffer_opquae_formatter_t fn);
1096 u32 packets_to_capture;
1097 u32 max_bytes_per_pkt;
1101 u8 preallocate_data;
1105 vlib_error_t drop_err;
1106 } vnet_pcap_dispatch_trace_args_t;
1108 int vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t *);
1110 extern vlib_node_registration_t vnet_interface_output_node;
1111 extern vlib_node_registration_t vnet_interface_output_arc_end_node;
1113 #endif /* included_vnet_interface_h */
1116 * fd.io coding-style-patch-verification: ON
1119 * eval: (c-set-style "gnu")