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 mtu callback. */
74 typedef clib_error_t *(vnet_interface_set_max_frame_size_function_t) (
75 struct vnet_main_t *vnm, struct vnet_hw_interface_t *hi, u32 mtu);
77 /* Interface set mac address callback. */
78 typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
79 (struct vnet_hw_interface_t * hi,
80 const u8 * old_address, const u8 * new_address);
82 /* Interface add/del additional mac address callback */
83 typedef clib_error_t *(vnet_interface_add_del_mac_address_function_t)
84 (struct vnet_hw_interface_t * hi, const u8 * address, u8 is_add);
86 /* Interface set rx mode callback. */
87 typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
88 (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
89 vnet_hw_if_rx_mode mode);
91 /* Interface set l2 mode callback. */
92 typedef clib_error_t *(vnet_interface_set_l2_mode_function_t)
93 (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
96 /* Interface to set rss queues of the interface */
97 typedef clib_error_t *(vnet_interface_rss_queues_set_t)
98 (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
99 clib_bitmap_t * bitmap);
103 VNET_FLOW_DEV_OP_ADD_FLOW,
104 VNET_FLOW_DEV_OP_DEL_FLOW,
105 VNET_FLOW_DEV_OP_GET_COUNTER,
106 VNET_FLOW_DEV_OP_RESET_COUNTER,
107 } vnet_flow_dev_op_t;
109 /* Interface flow operations callback. */
110 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
111 vnet_flow_dev_op_t op,
112 u32 hw_if_index, u32 index,
113 uword * private_data);
115 typedef enum vnet_interface_function_priority_t_
117 VNET_ITF_FUNC_PRIORITY_LOW,
118 VNET_ITF_FUNC_PRIORITY_HIGH,
119 } vnet_interface_function_priority_t;
120 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
122 typedef struct _vnet_interface_function_list_elt
124 struct _vnet_interface_function_list_elt *next_interface_function;
125 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
126 } _vnet_interface_function_list_elt_t;
128 #ifndef CLIB_MARCH_VARIANT
129 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
131 static void __vnet_interface_function_init_##tag##_##f (void) \
132 __attribute__((__constructor__)) ; \
134 static void __vnet_interface_function_init_##tag##_##f (void) \
136 vnet_main_t * vnm = vnet_get_main(); \
137 static _vnet_interface_function_list_elt_t init_function; \
138 init_function.next_interface_function = vnm->tag##_functions[p]; \
139 vnm->tag##_functions[p] = &init_function; \
140 init_function.fp = (void *) &f; \
142 static void __vnet_interface_function_deinit_##tag##_##f (void) \
143 __attribute__((__destructor__)) ; \
145 static void __vnet_interface_function_deinit_##tag##_##f (void) \
147 vnet_main_t * vnm = vnet_get_main(); \
148 _vnet_interface_function_list_elt_t *next; \
149 if (vnm->tag##_functions[p]->fp == f) \
151 vnm->tag##_functions[p] = \
152 vnm->tag##_functions[p]->next_interface_function; \
155 next = vnm->tag##_functions[p]; \
156 while (next->next_interface_function) \
158 if (next->next_interface_function->fp == f) \
160 next->next_interface_function = \
161 next->next_interface_function->next_interface_function; \
164 next = next->next_interface_function; \
168 /* create unused pointer to silence compiler warnings and get whole
169 function optimized out */
170 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
171 static __clib_unused void * __clib_unused_##f = f;
174 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
175 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
177 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
178 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
179 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
180 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
181 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
182 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
183 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
184 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
185 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
186 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
187 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION_PRIO(f,p) \
188 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_add_del,p)
189 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
190 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
191 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
192 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
195 * Tunnel description parameters
197 typedef int (*vnet_dev_class_ip_tunnel_desc_t) (u32 sw_if_index,
198 union ip46_address_t_ * src,
199 union ip46_address_t_ * dst,
202 /* A class of hardware interface devices. */
203 typedef struct _vnet_device_class
205 /* Index into main vector. */
208 /* Device name (e.g. "FOOBAR 1234a"). */
211 /* Function to call when hardware interface is added/deleted. */
212 vnet_interface_function_t *interface_add_del_function;
214 /* Function to bring device administratively up/down. */
215 vnet_interface_function_t *admin_up_down_function;
217 /* Function to call when sub-interface is added/deleted */
218 vnet_subif_add_del_function_t *subif_add_del_function;
220 /* Function to call interface rx mode is changed */
221 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
223 /* Function to call interface l2 mode is changed */
224 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
226 /* Redistribute flag changes/existence of this interface class. */
229 /* Transmit function. */
230 vlib_node_function_t *tx_function;
232 /* Transmit function candidate registration with priority */
233 vlib_node_fn_registration_t *tx_fn_registrations;
235 /* Error strings indexed by error code for this node. */
236 char **tx_function_error_strings;
237 vlib_error_desc_t *tx_function_error_counters;
239 /* Number of error codes used by this node. */
240 u32 tx_function_n_errors;
242 /* Renumber device name [only!] support, a control-plane kludge */
243 int (*name_renumber) (struct vnet_hw_interface_t * hi,
244 u32 new_dev_instance);
246 /* Interface flow offload operations */
247 vnet_flow_dev_ops_function_t *flow_ops_function;
249 /* Format device instance as name. */
250 format_function_t *format_device_name;
252 /* Parse function for device name. */
253 unformat_function_t *unformat_device_name;
255 /* Format device verbosely for this class. */
256 format_function_t *format_device;
258 /* Trace buffer format for TX function. */
259 format_function_t *format_tx_trace;
261 /* Format flow offload entry */
262 format_function_t *format_flow;
264 vnet_dev_class_ip_tunnel_desc_t ip_tun_desc;
266 /* Function to clear hardware counters for device. */
267 void (*clear_counters) (u32 dev_class_instance);
269 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
273 /* Called when hardware class of an interface changes. */
274 void (*hw_class_change) (struct vnet_main_t * vnm,
275 u32 hw_if_index, u32 new_hw_class_index);
277 /* Called to redirect traffic from a specific interface instance */
278 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
279 u32 hw_if_index, u32 node_index);
281 /* Link-list of all device classes set up by constructors created below */
282 struct _vnet_device_class *next_class_registration;
284 /* Function to set mac address. */
285 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
287 /* Function to add/delete additional MAC addresses */
288 vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
290 /* Interface to set rss queues of the interface */
291 vnet_interface_rss_queues_set_t *set_rss_queues_function;
293 } vnet_device_class_t;
295 u32 vnet_register_device_class (vlib_main_t *, vnet_device_class_t *);
297 #ifndef CLIB_MARCH_VARIANT
298 #define VNET_DEVICE_CLASS(x,...) \
299 __VA_ARGS__ vnet_device_class_t x; \
300 static void __vnet_add_device_class_registration_##x (void) \
301 __attribute__((__constructor__)) ; \
302 static void __vnet_add_device_class_registration_##x (void) \
304 vnet_main_t * vnm = vnet_get_main(); \
305 x.next_class_registration = vnm->device_class_registrations; \
306 vnm->device_class_registrations = &x; \
308 static void __vnet_rm_device_class_registration_##x (void) \
309 __attribute__((__destructor__)) ; \
310 static void __vnet_rm_device_class_registration_##x (void) \
312 vnet_main_t * vnm = vnet_get_main(); \
313 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
314 &x, next_class_registration); \
316 __VA_ARGS__ vnet_device_class_t x
318 /* create unused pointer to silence compiler warnings and get whole
319 function optimized out */
320 #define VNET_DEVICE_CLASS(x,...) \
321 static __clib_unused vnet_device_class_t __clib_unused_##x
324 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
325 uword CLIB_MARCH_SFX (devclass##_tx_fn) ( \
326 vlib_main_t *, vlib_node_runtime_t *, vlib_frame_t *); \
327 static vlib_node_fn_registration_t CLIB_MARCH_SFX ( \
328 devclass##_tx_fn_registration) = { \
329 .function = &CLIB_MARCH_SFX (devclass##_tx_fn), \
332 static void __clib_constructor CLIB_MARCH_SFX ( \
333 devclass##_tx_fn_multiarch_register) (void) \
335 extern vnet_device_class_t devclass; \
336 vlib_node_fn_registration_t *r; \
337 r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
338 r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE); \
339 r->next_registration = devclass.tx_fn_registrations; \
340 devclass.tx_fn_registrations = r; \
342 uword CLIB_MARCH_SFX (devclass##_tx_fn)
345 * Link Type: A description of the protocol of packets on the link.
346 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
347 * it maps to the GRE-proto, etc for other lnk types.
349 typedef enum vnet_link_t_
361 } __attribute__ ((packed)) vnet_link_t;
363 #define VNET_LINKS { \
364 [VNET_LINK_ETHERNET] = "ethernet", \
365 [VNET_LINK_IP4] = "ipv4", \
366 [VNET_LINK_IP6] = "ipv6", \
367 [VNET_LINK_MPLS] = "mpls", \
368 [VNET_LINK_ARP] = "arp", \
369 [VNET_LINK_NSH] = "nsh", \
372 #define FOR_EACH_VNET_LINK(_link) \
373 for (_link = VNET_LINK_IP4; \
374 _link <= VNET_LINK_NSH; \
377 #define FOR_EACH_VNET_IP_LINK(_link) \
378 for (_link = VNET_LINK_IP4; \
379 _link <= VNET_LINK_IP6; \
383 * @brief Number of link types. Not part of the enum so it does not have to be
384 * included in switch statements
386 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
387 #define VNET_N_LINKS VNET_LINK_NUM
390 * @brief Convert a link to to an Ethertype
392 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
395 * @brief Attributes assignable to a HW interface Class.
397 typedef enum vnet_hw_interface_class_flags_t_
400 * @brief a point 2 point interface
402 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
404 * @brief a non-broadcast multiple access interface
406 VNET_HW_INTERFACE_CLASS_FLAG_NBMA = (1 << 1),
407 } vnet_hw_interface_class_flags_t;
409 /* Layer-2 (e.g. Ethernet) interface class. */
410 typedef struct _vnet_hw_interface_class
412 /* Index into main vector. */
415 /* Class name (e.g. "Ethernet"). */
419 vnet_hw_interface_class_flags_t flags;
421 /* tx hash type for interfaces of this hw class */
422 vnet_hash_fn_type_t tx_hash_fn_type;
424 /* Function to call when hardware interface is added/deleted. */
425 vnet_interface_function_t *interface_add_del_function;
427 /* Function to bring interface administratively up/down. */
428 vnet_interface_function_t *admin_up_down_function;
430 /* Function to call when link state changes. */
431 vnet_interface_function_t *link_up_down_function;
433 /* Function to call when link MAC changes. */
434 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
436 /* Function to add/delete additional MAC addresses */
437 vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
439 /* Function to set max frame size. */
440 vnet_interface_set_max_frame_size_function_t *set_max_frame_size;
442 /* Format function to display interface name. */
443 format_function_t *format_interface_name;
445 /* Format function to display interface address. */
446 format_function_t *format_address;
448 /* Format packet header for this interface class. */
449 format_function_t *format_header;
451 /* Format device verbosely for this class. */
452 format_function_t *format_device;
454 /* Parser for hardware (e.g. ethernet) address. */
455 unformat_function_t *unformat_hw_address;
457 /* Parser for packet header for e.g. rewrite string. */
458 unformat_function_t *unformat_header;
460 /* Builds a rewrite string for the interface to the destination
461 * for the payload/link type. */
462 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
464 vnet_link_t link_type, const void *dst_hw_address);
466 /* Update an adjacency added by FIB (as opposed to via the
467 * neighbour resolution protocol). */
468 void (*update_adjacency) (struct vnet_main_t * vnm,
469 u32 sw_if_index, u32 adj_index);
471 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
475 /* Called when hw interface class is changed and old hardware instance
476 may want to be deleted. */
477 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
478 u32 old_class_index, u32 new_class_index);
480 /* List of hw interface classes, built by constructors */
481 struct _vnet_hw_interface_class *next_class_registration;
483 } vnet_hw_interface_class_t;
486 * @brief Return a complete, zero-length (aka placeholder) rewrite
488 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
490 vnet_link_t link_type,
491 const void *dst_hw_address);
494 * @brief Default adjacency update function
496 extern void default_update_adjacency (struct vnet_main_t *vnm,
497 u32 sw_if_index, u32 adj_index);
499 #define VNET_HW_INTERFACE_CLASS(x,...) \
500 __VA_ARGS__ vnet_hw_interface_class_t x; \
501 static void __vnet_add_hw_interface_class_registration_##x (void) \
502 __attribute__((__constructor__)) ; \
503 static void __vnet_add_hw_interface_class_registration_##x (void) \
505 vnet_main_t * vnm = vnet_get_main(); \
506 x.next_class_registration = vnm->hw_interface_class_registrations; \
507 vnm->hw_interface_class_registrations = &x; \
509 static void __vnet_rm_hw_interface_class_registration_##x (void) \
510 __attribute__((__destructor__)) ; \
511 static void __vnet_rm_hw_interface_class_registration_##x (void) \
513 vnet_main_t * vnm = vnet_get_main(); \
514 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
515 &x, next_class_registration); \
517 __VA_ARGS__ vnet_hw_interface_class_t x
519 typedef enum vnet_hw_interface_flags_t_
521 VNET_HW_INTERFACE_FLAG_NONE,
522 /* Hardware link state is up. */
523 VNET_HW_INTERFACE_FLAG_LINK_UP = (1 << 0),
524 /* Hardware duplex state */
525 VNET_HW_INTERFACE_FLAG_HALF_DUPLEX = (1 << 1),
526 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX = (1 << 2),
528 /* non-broadcast multiple access */
529 VNET_HW_INTERFACE_FLAG_NBMA = (1 << 19),
530 } vnet_hw_interface_flags_t;
532 #define foreach_vnet_hw_if_caps \
533 _ (0, TX_IP4_CKSUM, "ip4-csum-tx") \
534 _ (1, TX_TCP_CKSUM, "tcp-csum-tx") \
535 _ (2, TX_UDP_CKSUM, "udp-csum-tx") \
536 _ (3, TX_IP4_OUTER_CKSUM, "outer-ip4-csum-tx") \
537 _ (4, TX_UDP_OUTER_CKSUM, "outer-udp-csum-tx") \
538 _ (5, RX_IP4_CKSUM, "ip4-csum-rx") \
539 _ (6, RX_TCP_CKSUM, "tcp-csum-rx") \
540 _ (7, RX_UDP_CKSUM, "udp-csum-rx") \
541 _ (8, RX_IP4_OUTER_CKSUM, "outer-ip4-csum-rx") \
542 _ (9, RX_UDP_OUTER_CKSUM, "outer-udp-csum-rx") \
543 _ (10, TCP_GSO, "tcp-tso") \
544 _ (11, UDP_GSO, "udp-gso") \
545 _ (12, VXLAN_TNL_GSO, "vxlan-tnl-gso") \
546 _ (13, IPIP_TNL_GSO, "ipip-tnl-gso") \
547 _ (14, GENEVE_TNL_GSO, "geneve-tnl-gso") \
548 _ (15, GRE_TNL_GSO, "gre-tnl-gso") \
549 _ (16, UDP_TNL_GSO, "udp-tnl-gso") \
550 _ (17, IP_TNL_GSO, "ip-tnl-gso") \
551 _ (18, TCP_LRO, "tcp-lro") \
552 _ (30, INT_MODE, "int-mode") \
553 _ (31, MAC_FILTER, "mac-filter")
555 typedef enum vnet_hw_if_caps_t_
557 VNET_HW_INTERFACE_CAP_NONE,
558 #define _(bit, sfx, str) VNET_HW_IF_CAP_##sfx = (1 << (bit)),
559 foreach_vnet_hw_if_caps
564 #define VNET_HW_IF_CAP_L4_TX_CKSUM \
565 (VNET_HW_IF_CAP_TX_TCP_CKSUM | VNET_HW_IF_CAP_TX_UDP_CKSUM)
567 #define VNET_HW_IF_CAP_TX_CKSUM \
568 (VNET_HW_IF_CAP_TX_IP4_CKSUM | VNET_HW_IF_CAP_TX_TCP_CKSUM | \
569 VNET_HW_IF_CAP_TX_UDP_CKSUM)
571 #define VNET_HW_IF_CAP_TX_OUTER_CKSUM \
572 (VNET_HW_IF_CAP_TX_IP4_OUTER_CKSUM | VNET_HW_IF_CAP_TX_UDP_OUTER_CKSUM)
574 #define VNET_HW_IF_CAP_TX_CKSUM_MASK \
575 (VNET_HW_IF_CAP_TX_CKSUM | VNET_HW_IF_CAP_TX_OUTER_CKSUM)
577 #define VNET_HW_IF_CAP_L4_RX_CKSUM \
578 (VNET_HW_IF_CAP_RX_TCP_CKSUM | VNET_HW_IF_CAP_RX_UDP_CKSUM)
580 #define VNET_HW_IF_CAP_RX_CKSUM \
581 (VNET_HW_IF_CAP_RX_IP4_CKSUM | VNET_HW_IF_CAP_RX_TCP_CKSUM | \
582 VNET_HW_IF_CAP_RX_UDP_CKSUM)
584 #define VNET_HW_IF_CAP_TNL_GSO_MASK \
585 VNET_HW_IF_CAP_VXLAN_TNL_GSO | VNET_HW_IF_CAP_IPIP_TNL_GSO
587 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
588 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
589 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
590 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
591 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
595 /* hw interface index */
598 /* device instance */
601 /* index of thread pollling this queue */
604 /* file index of queue interrupt line */
607 /* hardware queue identifier */
611 vnet_hw_if_rx_mode mode : 8;
612 #define VNET_HW_IF_RXQ_THREAD_ANY ~0
613 #define VNET_HW_IF_RXQ_NO_RX_INTERRUPT ~0
614 } vnet_hw_if_rx_queue_t;
619 /* hw interface index */
622 /* hardware queue identifier */
625 /* bitmap of threads which use this queue */
626 clib_bitmap_t *threads;
627 } vnet_hw_if_tx_queue_t;
631 VNET_HW_IF_TX_FRAME_HINT_NOT_CHAINED = (1 << 0),
632 VNET_HW_IF_TX_FRAME_HINT_NO_GSO = (1 << 1),
633 VNET_HW_IF_TX_FRAME_HINT_NO_CKSUM_OFFLOAD = (1 << 2),
634 } vnet_hw_if_tx_frame_hint_t;
639 vnet_hw_if_tx_frame_hint_t hints : 16;
641 } vnet_hw_if_tx_frame_t;
645 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
646 vnet_hw_if_tx_frame_t *frame;
649 } vnet_hw_if_output_node_runtime_t;
651 /* Hardware-interface. This corresponds to a physical wire
652 that packets flow over. */
653 typedef struct vnet_hw_interface_t
655 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
657 vnet_hw_interface_flags_t flags;
659 /* capabilities flags */
660 vnet_hw_if_caps_t caps;
662 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
663 address for this class (e.g. PPP). */
666 /* Interface is up as far as software is concerned. */
667 /* NAME.{output,tx} nodes for this interface. */
668 u32 output_node_index, tx_node_index;
670 /* interface-output-arc-end node next index for tx node */
671 u32 if_out_arc_end_node_next_index;
673 /* (dev_class, dev_instance) uniquely identifies hw interface. */
677 /* (hw_class, hw_instance) uniquely identifies hw interface. */
681 /* Hardware index for this hardware interface. */
684 /* Software index for this hardware interface. */
687 /* per thread output-node runtimes */
688 vnet_hw_if_output_node_runtime_t *output_node_thread_runtimes;
690 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
692 /* Interface name. */
695 /* link speed in kbps */
698 /* Next index in interface-output node for this interface
699 used by node function vnet_per_buffer_interface_output() */
700 u32 output_node_next_index;
702 /* called when hw interface is using transmit side packet steering */
705 /* Maximum transmit rate for this interface in bits/sec. */
706 f64 max_rate_bits_per_sec;
708 /* Smallest packet size for this interface. */
711 /* Largest frame size for this interface. */
714 /* Layer 2 overhead */
717 /* Hash table mapping sub interface id to sw_if_index. */
718 uword *sub_interface_sw_if_index_by_id;
720 /* Count of number of L2 and L3 subinterfaces */
724 /* Bonded interface info -
725 0 - not a bonded interface nor a slave
726 ~0 - slave to a bonded interface
727 others - A bonded interface with a pointer to bitmap for all slaves */
729 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
730 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
733 u32 input_node_index;
735 vnet_hw_if_rx_mode default_rx_mode;
738 u32 *rx_queue_indices;
741 u32 *tx_queue_indices;
743 /* numa node that hardware device connects to */
746 /* rss queues bitmap */
747 clib_bitmap_t *rss_queues;
752 u32 trace_classify_table_index;
753 } vnet_hw_interface_t;
755 STATIC_ASSERT_OFFSET_OF (vnet_hw_interface_t, cacheline1,
756 CLIB_CACHE_LINE_BYTES);
762 } vnet_hw_if_rxq_poll_vector_t;
766 vnet_hw_if_rxq_poll_vector_t *rxq_vector_int;
767 vnet_hw_if_rxq_poll_vector_t *rxq_vector_poll;
768 void *rxq_interrupts;
769 } vnet_hw_if_rx_node_runtime_t;
771 extern vnet_device_class_t vnet_local_interface_device_class;
775 /* A hw interface. */
776 VNET_SW_INTERFACE_TYPE_HARDWARE,
778 /* A sub-interface. */
779 VNET_SW_INTERFACE_TYPE_SUB,
780 VNET_SW_INTERFACE_TYPE_P2P,
781 VNET_SW_INTERFACE_TYPE_PIPE,
782 } vnet_sw_interface_type_t;
787 * Subinterface ID. A number 0-N to uniquely identify
788 * this subinterface under the main (parent?) interface
792 /* Classification data. Used to associate packet header with subinterface. */
805 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
808 u16 outer_vlan_id_any:1;
809 u16 inner_vlan_id_any:1;
813 } vnet_sub_interface_t;
818 * Subinterface ID. A number 0-N to uniquely identify
819 * this subinterface under the main interface
824 } vnet_p2p_sub_interface_t;
828 /* THe BVI interface */
829 VNET_FLOOD_CLASS_BVI,
831 VNET_FLOOD_CLASS_NORMAL,
832 VNET_FLOOD_CLASS_TUNNEL_MASTER,
833 /* Does not flood when tunnel master is in the same L2 BD */
834 VNET_FLOOD_CLASS_TUNNEL_NORMAL,
835 /* Never flood to this type */
836 VNET_FLOOD_CLASS_NO_FLOOD,
837 } vnet_flood_class_t;
839 /* Per protocol MTU */
842 VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
843 VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
849 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
851 typedef enum vnet_sw_interface_flags_t_
853 VNET_SW_INTERFACE_FLAG_NONE = 0,
854 /* Interface is "up" meaning administratively up.
855 Up in the sense of link state being up is maintained by hardware interface. */
856 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
858 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
859 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
861 __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
863 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
865 __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
867 /* Interface does not appear in CLI/API */
868 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
870 /* Interface in ERROR state */
871 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
873 /* Interface has IP configured directed broadcast */
874 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
876 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
878 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
879 tunnel, etc. Configuration (e.g. IP address) gets attached to
880 software interface. */
883 vnet_sw_interface_type_t type:16;
885 vnet_sw_interface_flags_t flags;
887 /* Index for this interface. */
890 /* Software interface index of super-interface;
891 equal to sw_if_index if this interface is not a
895 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
896 u32 unnumbered_sw_if_index;
898 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
901 /* MTU for network layer (not including L2 headers) */
904 /* VNET_SW_INTERFACE_TYPE_SUB. */
905 vnet_sub_interface_t sub;
907 /* VNET_SW_INTERFACE_TYPE_P2P. */
908 vnet_p2p_sub_interface_t p2p;
910 vnet_flood_class_t flood_class;
911 } vnet_sw_interface_t;
915 /* Simple counters. */
916 VNET_INTERFACE_COUNTER_DROP = 0,
917 VNET_INTERFACE_COUNTER_PUNT = 1,
918 VNET_INTERFACE_COUNTER_IP4 = 2,
919 VNET_INTERFACE_COUNTER_IP6 = 3,
920 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
921 VNET_INTERFACE_COUNTER_RX_MISS = 5,
922 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
923 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
924 VNET_INTERFACE_COUNTER_MPLS = 8,
925 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
926 /* Combined counters. */
927 VNET_INTERFACE_COUNTER_RX = 0,
928 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
929 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
930 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
931 VNET_INTERFACE_COUNTER_TX = 4,
932 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
933 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
934 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
935 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
936 } vnet_interface_counter_type_t;
938 #define foreach_rx_combined_interface_counter(_x) \
939 for (_x = VNET_INTERFACE_COUNTER_RX; \
940 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
943 #define foreach_tx_combined_interface_counter(_x) \
944 for (_x = VNET_INTERFACE_COUNTER_TX; \
945 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
948 #define foreach_simple_interface_counter_name \
953 _(RX_NO_BUF, rx-no-buf, if) \
954 _(RX_MISS, rx-miss, if) \
955 _(RX_ERROR, rx-error, if) \
956 _(TX_ERROR, tx-error, if) \
959 #define foreach_combined_interface_counter_name \
961 _(RX_UNICAST, rx-unicast, if) \
962 _(RX_MULTICAST, rx-multicast, if) \
963 _(RX_BROADCAST, rx-broadcast, if) \
965 _(TX_UNICAST, tx-unicast, if) \
966 _(TX_MULTICAST, tx-multicast, if) \
967 _(TX_BROADCAST, tx-broadcast, if)
971 COLLECT_SIMPLE_STATS = 0,
972 COLLECT_DETAILED_STATS = 1,
973 } vnet_interface_stats_collection_mode_e;
975 extern int collect_detailed_interface_stats_flag;
978 collect_detailed_interface_stats (void)
980 return collect_detailed_interface_stats_flag;
983 void collect_detailed_interface_stats_flag_set (void);
984 void collect_detailed_interface_stats_flag_clear (void);
989 u32 output_node_index;
991 } vnet_hw_interface_nodes_t;
995 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
997 } vnet_interface_per_thread_data_t;
999 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
1004 /* Hardware interfaces. */
1005 vnet_hw_interface_t *hw_interfaces;
1007 /* Hardware interface RX queues */
1008 vnet_hw_if_rx_queue_t *hw_if_rx_queues;
1009 uword *rxq_index_by_hw_if_index_and_queue_id;
1011 /* Hardware interface TX queues */
1012 vnet_hw_if_tx_queue_t *hw_if_tx_queues;
1013 uword *txq_index_by_hw_if_index_and_queue_id;
1015 /* Hash table mapping HW interface name to index. */
1016 uword *hw_interface_by_name;
1018 /* Vectors if hardware interface classes and device classes. */
1019 vnet_hw_interface_class_t *hw_interface_classes;
1020 vnet_device_class_t *device_classes;
1022 /* Hash table mapping name to hw interface/device class. */
1023 uword *hw_interface_class_by_name;
1024 uword *device_class_by_name;
1026 /* Software interfaces. */
1027 vnet_sw_interface_t *sw_interfaces;
1029 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
1030 uword *sw_if_index_by_sup_and_sub;
1032 /* Software interface counters both simple and combined
1033 packet and byte counters. */
1034 clib_spinlock_t sw_if_counter_lock;
1035 vlib_simple_counter_main_t *sw_if_counters;
1036 vlib_combined_counter_main_t *combined_sw_if_counters;
1038 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
1042 * Only the drop filter hash lives here. See ../src/vlib/main.h for
1043 * the rest of the variables.
1045 uword *pcap_drop_filter_hash;
1047 /* Buffer metadata format helper functions */
1048 vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
1049 vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
1051 /* per-thread data */
1052 vnet_interface_per_thread_data_t *per_thread_data;
1054 /* feature_arc_index */
1055 u8 output_feature_arc_index;
1057 /* fast lookup tables */
1058 u32 *hw_if_index_by_sw_if_index;
1059 u16 *if_out_arc_end_next_index_by_sw_if_index;
1060 } vnet_interface_main_t;
1063 vnet_interface_counter_lock (vnet_interface_main_t * im)
1065 if (im->sw_if_counter_lock)
1066 clib_spinlock_lock (&im->sw_if_counter_lock);
1070 vnet_interface_counter_unlock (vnet_interface_main_t * im)
1072 if (im->sw_if_counter_lock)
1073 clib_spinlock_unlock (&im->sw_if_counter_lock);
1076 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
1078 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
1080 void vnet_register_format_buffer_opaque_helper
1081 (vnet_buffer_opquae_formatter_t fn);
1083 void vnet_register_format_buffer_opaque2_helper
1084 (vnet_buffer_opquae_formatter_t fn);
1091 u32 packets_to_capture;
1092 u32 max_bytes_per_pkt;
1096 u8 preallocate_data;
1100 vlib_error_t drop_err;
1101 } vnet_pcap_dispatch_trace_args_t;
1103 int vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t *);
1105 extern vlib_node_registration_t vnet_interface_output_node;
1106 extern vlib_node_registration_t vnet_interface_output_arc_end_node;
1108 #endif /* included_vnet_interface_h */
1111 * fd.io coding-style-patch-verification: ON
1114 * eval: (c-set-style "gnu")