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>
49 struct vnet_hw_interface_t;
50 struct vnet_sw_interface_t;
51 union ip46_address_t_;
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,
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);
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);
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);
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);
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);
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,
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);
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;
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);
110 typedef enum vnet_interface_function_priority_t_
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)
117 typedef struct _vnet_interface_function_list_elt
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;
123 #ifndef CLIB_MARCH_VARIANT
124 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
126 static void __vnet_interface_function_init_##tag##_##f (void) \
127 __attribute__((__constructor__)) ; \
129 static void __vnet_interface_function_init_##tag##_##f (void) \
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; \
137 static void __vnet_interface_function_deinit_##tag##_##f (void) \
138 __attribute__((__destructor__)) ; \
140 static void __vnet_interface_function_deinit_##tag##_##f (void) \
142 vnet_main_t * vnm = vnet_get_main(); \
143 _vnet_interface_function_list_elt_t *next; \
144 if (vnm->tag##_functions[p]->fp == f) \
146 vnm->tag##_functions[p] = \
147 vnm->tag##_functions[p]->next_interface_function; \
150 next = vnm->tag##_functions[p]; \
151 while (next->next_interface_function) \
153 if (next->next_interface_function->fp == f) \
155 next->next_interface_function = \
156 next->next_interface_function->next_interface_function; \
159 next = next->next_interface_function; \
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;
169 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
170 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
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)
190 * Tunnel description parameters
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,
197 /* A class of hardware interface devices. */
198 typedef struct _vnet_device_class
200 /* Index into main vector. */
203 /* Device name (e.g. "FOOBAR 1234a"). */
206 /* Function to call when hardware interface is added/deleted. */
207 vnet_interface_function_t *interface_add_del_function;
209 /* Function to bring device administratively up/down. */
210 vnet_interface_function_t *admin_up_down_function;
212 /* Function to call when sub-interface is added/deleted */
213 vnet_subif_add_del_function_t *subif_add_del_function;
215 /* Function to call interface rx mode is changed */
216 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
218 /* Function to call interface l2 mode is changed */
219 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
221 /* Redistribute flag changes/existence of this interface class. */
224 /* Transmit function. */
225 vlib_node_function_t *tx_function;
227 /* Transmit function candidate registration with priority */
228 vlib_node_fn_registration_t *tx_fn_registrations;
230 /* Error strings indexed by error code for this node. */
231 char **tx_function_error_strings;
233 /* Number of error codes used by this node. */
234 u32 tx_function_n_errors;
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);
240 /* Interface flow offload operations */
241 vnet_flow_dev_ops_function_t *flow_ops_function;
243 /* Format device instance as name. */
244 format_function_t *format_device_name;
246 /* Parse function for device name. */
247 unformat_function_t *unformat_device_name;
249 /* Format device verbosely for this class. */
250 format_function_t *format_device;
252 /* Trace buffer format for TX function. */
253 format_function_t *format_tx_trace;
255 /* Format flow offload entry */
256 format_function_t *format_flow;
258 vnet_dev_class_ip_tunnel_desc_t ip_tun_desc;
260 /* Function to clear hardware counters for device. */
261 void (*clear_counters) (u32 dev_class_instance);
263 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
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);
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);
275 /* Link-list of all device classes set up by constructors created below */
276 struct _vnet_device_class *next_class_registration;
278 /* Function to set mac address. */
279 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
281 /* Function to add/delete additional MAC addresses */
282 vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
284 /* Interface to set rss queues of the interface */
285 vnet_interface_rss_queues_set_t *set_rss_queues_function;
287 } vnet_device_class_t;
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) \
296 vnet_main_t * vnm = vnet_get_main(); \
297 x.next_class_registration = vnm->device_class_registrations; \
298 vnm->device_class_registrations = &x; \
300 static void __vnet_rm_device_class_registration_##x (void) \
301 __attribute__((__destructor__)) ; \
302 static void __vnet_rm_device_class_registration_##x (void) \
304 vnet_main_t * vnm = vnet_get_main(); \
305 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
306 &x, next_class_registration); \
308 __VA_ARGS__ vnet_device_class_t x
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
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), \
323 static void __clib_constructor CLIB_MARCH_SFX ( \
324 devclass##_tx_fn_multiarch_register) (void) \
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; \
333 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
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.
340 typedef enum vnet_link_t_
352 } __attribute__ ((packed)) vnet_link_t;
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", \
363 #define FOR_EACH_VNET_LINK(_link) \
364 for (_link = VNET_LINK_IP4; \
365 _link <= VNET_LINK_NSH; \
368 #define FOR_EACH_VNET_IP_LINK(_link) \
369 for (_link = VNET_LINK_IP4; \
370 _link <= VNET_LINK_IP6; \
374 * @brief Number of link types. Not part of the enum so it does not have to be
375 * included in switch statements
377 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
378 #define VNET_N_LINKS VNET_LINK_NUM
381 * @brief Convert a link to to an Ethertype
383 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
386 * @brief Attributes assignable to a HW interface Class.
388 typedef enum vnet_hw_interface_class_flags_t_
391 * @brief a point 2 point interface
393 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
395 * @brief a non-broadcast multiple access interface
397 VNET_HW_INTERFACE_CLASS_FLAG_NBMA = (1 << 1),
398 } vnet_hw_interface_class_flags_t;
400 /* Layer-2 (e.g. Ethernet) interface class. */
401 typedef struct _vnet_hw_interface_class
403 /* Index into main vector. */
406 /* Class name (e.g. "Ethernet"). */
410 vnet_hw_interface_class_flags_t flags;
412 /* Function to call when hardware interface is added/deleted. */
413 vnet_interface_function_t *interface_add_del_function;
415 /* Function to bring interface administratively up/down. */
416 vnet_interface_function_t *admin_up_down_function;
418 /* Function to call when link state changes. */
419 vnet_interface_function_t *link_up_down_function;
421 /* Function to call when link MAC changes. */
422 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
424 /* Function to add/delete additional MAC addresses */
425 vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
427 /* Format function to display interface name. */
428 format_function_t *format_interface_name;
430 /* Format function to display interface address. */
431 format_function_t *format_address;
433 /* Format packet header for this interface class. */
434 format_function_t *format_header;
436 /* Format device verbosely for this class. */
437 format_function_t *format_device;
439 /* Parser for hardware (e.g. ethernet) address. */
440 unformat_function_t *unformat_hw_address;
442 /* Parser for packet header for e.g. rewrite string. */
443 unformat_function_t *unformat_header;
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,
449 vnet_link_t link_type, const void *dst_hw_address);
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);
456 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
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);
465 /* List of hw interface classes, built by constructors */
466 struct _vnet_hw_interface_class *next_class_registration;
468 } vnet_hw_interface_class_t;
471 * @brief Return a complete, zero-length (aka placeholder) rewrite
473 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
475 vnet_link_t link_type,
476 const void *dst_hw_address);
479 * @brief Default adjacency update function
481 extern void default_update_adjacency (struct vnet_main_t *vnm,
482 u32 sw_if_index, u32 adj_index);
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) \
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; \
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) \
498 vnet_main_t * vnm = vnet_get_main(); \
499 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
500 &x, next_class_registration); \
502 __VA_ARGS__ vnet_hw_interface_class_t x
504 typedef enum vnet_hw_interface_flags_t_
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),
513 /* non-broadcast multiple access */
514 VNET_HW_INTERFACE_FLAG_NBMA = (1 << 19),
515 } vnet_hw_interface_flags_t;
517 typedef enum vnet_hw_interface_capabilities_t_
519 VNET_HW_INTERFACE_CAP_NONE,
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),
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),
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),
546 VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_LRO = (1 << 18),
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;
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)
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)
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)
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)
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)
580 /* hw interface index */
583 /* device instance */
586 /* index of thread pollling this queue */
589 /* file index of queue interrupt line */
592 /* hardware queue identifier */
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;
601 /* Hardware-interface. This corresponds to a physical wire
602 that packets flow over. */
603 typedef struct vnet_hw_interface_t
605 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
606 /* Interface name. */
610 vnet_hw_interface_flags_t flags;
612 /* capabilities flags */
613 vnet_hw_interface_capabilities_t caps;
615 /* link speed in kbps */
618 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
619 address for this class (e.g. PPP). */
622 /* Interface is up as far as software is concerned. */
623 /* NAME.{output,tx} nodes for this interface. */
624 u32 output_node_index, tx_node_index;
626 /* (dev_class, dev_instance) uniquely identifies hw interface. */
630 /* (hw_class, hw_instance) uniquely identifies hw interface. */
634 /* Hardware index for this hardware interface. */
637 /* Software index for this hardware interface. */
640 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
642 /* Next index in interface-output node for this interface
643 used by node function vnet_per_buffer_interface_output() */
644 u32 output_node_next_index;
646 /* Maximum transmit rate for this interface in bits/sec. */
647 f64 max_rate_bits_per_sec;
649 /* Smallest packet size supported by this interface. */
650 u32 min_supported_packet_bytes;
652 /* Largest packet size supported by this interface. */
653 u32 max_supported_packet_bytes;
655 /* Smallest packet size for this interface. */
656 u32 min_packet_bytes;
658 /* Largest packet size for this interface. */
659 u32 max_packet_bytes;
661 /* Hash table mapping sub interface id to sw_if_index. */
662 uword *sub_interface_sw_if_index_by_id;
664 /* Count of number of L2 and L3 subinterfaces */
668 /* Bonded interface info -
669 0 - not a bonded interface nor a slave
670 ~0 - slave to a bonded interface
671 others - A bonded interface with a pointer to bitmap for all slaves */
673 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
674 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
677 u32 input_node_index;
679 /* input node cpu index by queue */
680 u32 *input_node_thread_index_by_queue;
682 vnet_hw_if_rx_mode default_rx_mode;
685 u32 *rx_queue_indices;
687 /* numa node that hardware device connects to */
690 /* rss queues bitmap */
691 clib_bitmap_t *rss_queues;
696 u32 trace_classify_table_index;
697 } vnet_hw_interface_t;
699 STATIC_ASSERT_OFFSET_OF (vnet_hw_interface_t, cacheline1,
700 CLIB_CACHE_LINE_BYTES);
706 } vnet_hw_if_rxq_poll_vector_t;
710 vnet_hw_if_rxq_poll_vector_t *rxq_poll_vector;
711 void *rxq_interrupts;
712 } vnet_hw_if_rx_node_runtime_t;
714 extern vnet_device_class_t vnet_local_interface_device_class;
718 /* A hw interface. */
719 VNET_SW_INTERFACE_TYPE_HARDWARE,
721 /* A sub-interface. */
722 VNET_SW_INTERFACE_TYPE_SUB,
723 VNET_SW_INTERFACE_TYPE_P2P,
724 VNET_SW_INTERFACE_TYPE_PIPE,
725 } vnet_sw_interface_type_t;
730 * Subinterface ID. A number 0-N to uniquely identify
731 * this subinterface under the main (parent?) interface
735 /* Classification data. Used to associate packet header with subinterface. */
748 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
751 u16 outer_vlan_id_any:1;
752 u16 inner_vlan_id_any:1;
756 } vnet_sub_interface_t;
761 * Subinterface ID. A number 0-N to uniquely identify
762 * this subinterface under the main interface
767 } vnet_p2p_sub_interface_t;
771 /* THe BVI interface */
772 VNET_FLOOD_CLASS_BVI,
774 VNET_FLOOD_CLASS_NORMAL,
775 VNET_FLOOD_CLASS_TUNNEL_MASTER,
776 /* Does not flood when tunnel master is in the same L2 BD */
777 VNET_FLOOD_CLASS_TUNNEL_NORMAL,
778 /* Never flood to this type */
779 VNET_FLOOD_CLASS_NO_FLOOD,
780 } vnet_flood_class_t;
782 /* Per protocol MTU */
785 VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
786 VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
792 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
794 typedef enum vnet_sw_interface_flags_t_
796 VNET_SW_INTERFACE_FLAG_NONE = 0,
797 /* Interface is "up" meaning administratively up.
798 Up in the sense of link state being up is maintained by hardware interface. */
799 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
801 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
802 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
804 __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
806 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
808 __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
810 /* Interface does not appear in CLI/API */
811 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
813 /* Interface in ERROR state */
814 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
816 /* Interface has IP configured directed broadcast */
817 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
819 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
821 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
822 tunnel, etc. Configuration (e.g. IP address) gets attached to
823 software interface. */
826 vnet_sw_interface_type_t type:16;
828 vnet_sw_interface_flags_t flags;
830 /* Index for this interface. */
833 /* Software interface index of super-interface;
834 equal to sw_if_index if this interface is not a
838 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
839 u32 unnumbered_sw_if_index;
841 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
844 /* MTU for network layer (not including L2 headers) */
847 /* VNET_SW_INTERFACE_TYPE_SUB. */
848 vnet_sub_interface_t sub;
850 /* VNET_SW_INTERFACE_TYPE_P2P. */
851 vnet_p2p_sub_interface_t p2p;
853 vnet_flood_class_t flood_class;
854 } vnet_sw_interface_t;
858 /* Simple counters. */
859 VNET_INTERFACE_COUNTER_DROP = 0,
860 VNET_INTERFACE_COUNTER_PUNT = 1,
861 VNET_INTERFACE_COUNTER_IP4 = 2,
862 VNET_INTERFACE_COUNTER_IP6 = 3,
863 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
864 VNET_INTERFACE_COUNTER_RX_MISS = 5,
865 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
866 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
867 VNET_INTERFACE_COUNTER_MPLS = 8,
868 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
869 /* Combined counters. */
870 VNET_INTERFACE_COUNTER_RX = 0,
871 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
872 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
873 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
874 VNET_INTERFACE_COUNTER_TX = 4,
875 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
876 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
877 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
878 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
879 } vnet_interface_counter_type_t;
881 #define foreach_rx_combined_interface_counter(_x) \
882 for (_x = VNET_INTERFACE_COUNTER_RX; \
883 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
886 #define foreach_tx_combined_interface_counter(_x) \
887 for (_x = VNET_INTERFACE_COUNTER_TX; \
888 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
891 #define foreach_simple_interface_counter_name \
896 _(RX_NO_BUF, rx-no-buf, if) \
897 _(RX_MISS, rx-miss, if) \
898 _(RX_ERROR, rx-error, if) \
899 _(TX_ERROR, tx-error, if) \
902 #define foreach_combined_interface_counter_name \
904 _(RX_UNICAST, rx-unicast, if) \
905 _(RX_MULTICAST, rx-multicast, if) \
906 _(RX_BROADCAST, rx-broadcast, if) \
908 _(TX_UNICAST, tx-unicast, if) \
909 _(TX_MULTICAST, tx-multicast, if) \
910 _(TX_BROADCAST, tx-broadcast, if)
914 COLLECT_SIMPLE_STATS = 0,
915 COLLECT_DETAILED_STATS = 1,
916 } vnet_interface_stats_collection_mode_e;
918 extern int collect_detailed_interface_stats_flag;
921 collect_detailed_interface_stats (void)
923 return collect_detailed_interface_stats_flag;
926 void collect_detailed_interface_stats_flag_set (void);
927 void collect_detailed_interface_stats_flag_clear (void);
932 u32 output_node_index;
934 } vnet_hw_interface_nodes_t;
938 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
940 } vnet_interface_per_thread_data_t;
942 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
947 /* Hardware interfaces. */
948 vnet_hw_interface_t *hw_interfaces;
950 /* Hardware interface RX queues */
951 vnet_hw_if_rx_queue_t *hw_if_rx_queues;
952 uword *rxq_index_by_hw_if_index_and_queue_id;
954 /* Hash table mapping HW interface name to index. */
955 uword *hw_interface_by_name;
957 /* Vectors if hardware interface classes and device classes. */
958 vnet_hw_interface_class_t *hw_interface_classes;
959 vnet_device_class_t *device_classes;
961 /* Hash table mapping name to hw interface/device class. */
962 uword *hw_interface_class_by_name;
963 uword *device_class_by_name;
965 /* Software interfaces. */
966 vnet_sw_interface_t *sw_interfaces;
968 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
969 uword *sw_if_index_by_sup_and_sub;
971 /* Software interface counters both simple and combined
972 packet and byte counters. */
973 clib_spinlock_t sw_if_counter_lock;
974 vlib_simple_counter_main_t *sw_if_counters;
975 vlib_combined_counter_main_t *combined_sw_if_counters;
977 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
981 * Only the drop filter hash lives here. See ../src/vlib/main.h for
982 * the rest of the variables.
984 uword *pcap_drop_filter_hash;
986 /* Buffer metadata format helper functions */
987 vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
988 vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
990 /* per-thread data */
991 vnet_interface_per_thread_data_t *per_thread_data;
993 /* feature_arc_index */
994 u8 output_feature_arc_index;
995 } vnet_interface_main_t;
998 vnet_interface_counter_lock (vnet_interface_main_t * im)
1000 if (im->sw_if_counter_lock)
1001 clib_spinlock_lock (&im->sw_if_counter_lock);
1005 vnet_interface_counter_unlock (vnet_interface_main_t * im)
1007 if (im->sw_if_counter_lock)
1008 clib_spinlock_unlock (&im->sw_if_counter_lock);
1011 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
1013 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
1015 void vnet_register_format_buffer_opaque_helper
1016 (vnet_buffer_opquae_formatter_t fn);
1018 void vnet_register_format_buffer_opaque2_helper
1019 (vnet_buffer_opquae_formatter_t fn);
1026 u32 packets_to_capture;
1027 u32 max_bytes_per_pkt;
1031 u8 preallocate_data;
1035 } vnet_pcap_dispatch_trace_args_t;
1037 int vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t *);
1039 extern vlib_node_registration_t vnet_interface_output_node;
1041 #endif /* included_vnet_interface_h */
1044 * fd.io coding-style-patch-verification: ON
1047 * eval: (c-set-style "gnu")