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>
48 struct vnet_hw_interface_t;
49 struct vnet_sw_interface_t;
50 union ip46_address_t_;
54 VNET_HW_INTERFACE_RX_MODE_UNKNOWN,
55 VNET_HW_INTERFACE_RX_MODE_POLLING,
56 VNET_HW_INTERFACE_RX_MODE_INTERRUPT,
57 VNET_HW_INTERFACE_RX_MODE_ADAPTIVE,
58 VNET_HW_INTERFACE_RX_MODE_DEFAULT,
59 VNET_HW_INTERFACE_NUM_RX_MODES,
60 } vnet_hw_interface_rx_mode;
62 /* Interface up/down callback. */
63 typedef clib_error_t *(vnet_interface_function_t)
64 (struct vnet_main_t * vnm, u32 if_index, u32 flags);
66 /* Sub-interface add/del callback. */
67 typedef clib_error_t *(vnet_subif_add_del_function_t)
68 (struct vnet_main_t * vnm, u32 if_index,
69 struct vnet_sw_interface_t * template, int is_add);
71 /* Interface set mac address callback. */
72 typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
73 (struct vnet_hw_interface_t * hi,
74 const u8 * old_address, const u8 * new_address);
76 /* Interface set rx mode callback. */
77 typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
78 (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
79 vnet_hw_interface_rx_mode mode);
81 /* Interface set l2 mode callback. */
82 typedef clib_error_t *(vnet_interface_set_l2_mode_function_t)
83 (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
88 VNET_FLOW_DEV_OP_ADD_FLOW,
89 VNET_FLOW_DEV_OP_DEL_FLOW,
90 VNET_FLOW_DEV_OP_GET_COUNTER,
91 VNET_FLOW_DEV_OP_RESET_COUNTER,
94 /* Interface flow operations callback. */
95 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
96 vnet_flow_dev_op_t op,
97 u32 hw_if_index, u32 index,
98 uword * private_data);
100 typedef enum vnet_interface_function_priority_t_
102 VNET_ITF_FUNC_PRIORITY_LOW,
103 VNET_ITF_FUNC_PRIORITY_HIGH,
104 } vnet_interface_function_priority_t;
105 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
107 typedef struct _vnet_interface_function_list_elt
109 struct _vnet_interface_function_list_elt *next_interface_function;
110 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
111 } _vnet_interface_function_list_elt_t;
113 #ifndef CLIB_MARCH_VARIANT
114 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
116 static void __vnet_interface_function_init_##tag##_##f (void) \
117 __attribute__((__constructor__)) ; \
119 static void __vnet_interface_function_init_##tag##_##f (void) \
121 vnet_main_t * vnm = vnet_get_main(); \
122 static _vnet_interface_function_list_elt_t init_function; \
123 init_function.next_interface_function = vnm->tag##_functions[p]; \
124 vnm->tag##_functions[p] = &init_function; \
125 init_function.fp = (void *) &f; \
127 static void __vnet_interface_function_deinit_##tag##_##f (void) \
128 __attribute__((__destructor__)) ; \
130 static void __vnet_interface_function_deinit_##tag##_##f (void) \
132 vnet_main_t * vnm = vnet_get_main(); \
133 _vnet_interface_function_list_elt_t *next; \
134 if (vnm->tag##_functions[p]->fp == f) \
136 vnm->tag##_functions[p] = \
137 vnm->tag##_functions[p]->next_interface_function; \
140 next = vnm->tag##_functions[p]; \
141 while (next->next_interface_function) \
143 if (next->next_interface_function->fp == f) \
145 next->next_interface_function = \
146 next->next_interface_function->next_interface_function; \
149 next = next->next_interface_function; \
153 /* create unused pointer to silence compiler warnings and get whole
154 function optimized out */
155 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
156 static __clib_unused void * __clib_unused_##f = f;
159 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
160 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
162 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
163 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
164 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
165 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
166 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
167 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
168 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
169 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
170 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
171 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
172 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
173 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
174 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
175 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
178 * Tunnel description parameters
180 typedef int (*vnet_dev_class_ip_tunnel_desc_t) (u32 sw_if_index,
181 union ip46_address_t_ * src,
182 union ip46_address_t_ * dst,
185 /* A class of hardware interface devices. */
186 typedef struct _vnet_device_class
188 /* Index into main vector. */
191 /* Device name (e.g. "FOOBAR 1234a"). */
194 /* Function to call when hardware interface is added/deleted. */
195 vnet_interface_function_t *interface_add_del_function;
197 /* Function to bring device administratively up/down. */
198 vnet_interface_function_t *admin_up_down_function;
200 /* Function to call when sub-interface is added/deleted */
201 vnet_subif_add_del_function_t *subif_add_del_function;
203 /* Function to call interface rx mode is changed */
204 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
206 /* Function to call interface l2 mode is changed */
207 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
209 /* Redistribute flag changes/existence of this interface class. */
212 /* Transmit function. */
213 vlib_node_function_t *tx_function;
215 /* Transmit function candidate registration with priority */
216 vlib_node_fn_registration_t *tx_fn_registrations;
218 /* Error strings indexed by error code for this node. */
219 char **tx_function_error_strings;
221 /* Number of error codes used by this node. */
222 u32 tx_function_n_errors;
224 /* Renumber device name [only!] support, a control-plane kludge */
225 int (*name_renumber) (struct vnet_hw_interface_t * hi,
226 u32 new_dev_instance);
228 /* Interface flow offload operations */
229 vnet_flow_dev_ops_function_t *flow_ops_function;
231 /* Format device instance as name. */
232 format_function_t *format_device_name;
234 /* Parse function for device name. */
235 unformat_function_t *unformat_device_name;
237 /* Format device verbosely for this class. */
238 format_function_t *format_device;
240 /* Trace buffer format for TX function. */
241 format_function_t *format_tx_trace;
243 /* Format flow offload entry */
244 format_function_t *format_flow;
246 vnet_dev_class_ip_tunnel_desc_t ip_tun_desc;
248 /* Function to clear hardware counters for device. */
249 void (*clear_counters) (u32 dev_class_instance);
251 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
255 /* Called when hardware class of an interface changes. */
256 void (*hw_class_change) (struct vnet_main_t * vnm,
257 u32 hw_if_index, u32 new_hw_class_index);
259 /* Called to redirect traffic from a specific interface instance */
260 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
261 u32 hw_if_index, u32 node_index);
263 /* Link-list of all device classes set up by constructors created below */
264 struct _vnet_device_class *next_class_registration;
266 /* Function to set mac address. */
267 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
268 } vnet_device_class_t;
270 #ifndef CLIB_MARCH_VARIANT
271 #define VNET_DEVICE_CLASS(x,...) \
272 __VA_ARGS__ vnet_device_class_t x; \
273 static void __vnet_add_device_class_registration_##x (void) \
274 __attribute__((__constructor__)) ; \
275 static void __vnet_add_device_class_registration_##x (void) \
277 vnet_main_t * vnm = vnet_get_main(); \
278 x.next_class_registration = vnm->device_class_registrations; \
279 vnm->device_class_registrations = &x; \
281 static void __vnet_rm_device_class_registration_##x (void) \
282 __attribute__((__destructor__)) ; \
283 static void __vnet_rm_device_class_registration_##x (void) \
285 vnet_main_t * vnm = vnet_get_main(); \
286 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
287 &x, next_class_registration); \
289 __VA_ARGS__ vnet_device_class_t x
291 /* create unused pointer to silence compiler warnings and get whole
292 function optimized out */
293 #define VNET_DEVICE_CLASS(x,...) \
294 static __clib_unused vnet_device_class_t __clib_unused_##x
297 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
298 uword CLIB_MARCH_SFX (devclass##_tx_fn)(); \
299 static vlib_node_fn_registration_t \
300 CLIB_MARCH_SFX(devclass##_tx_fn_registration) = \
301 { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), }; \
303 static void __clib_constructor \
304 CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void) \
306 extern vnet_device_class_t devclass; \
307 vlib_node_fn_registration_t *r; \
308 r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
309 r->priority = CLIB_MARCH_FN_PRIORITY(); \
310 r->next_registration = devclass.tx_fn_registrations; \
311 devclass.tx_fn_registrations = r; \
313 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
316 * Link Type: A description of the protocol of packets on the link.
317 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
318 * it maps to the GRE-proto, etc for other lnk types.
320 typedef enum vnet_link_t_
332 } __attribute__ ((packed)) vnet_link_t;
334 #define VNET_LINKS { \
335 [VNET_LINK_ETHERNET] = "ethernet", \
336 [VNET_LINK_IP4] = "ipv4", \
337 [VNET_LINK_IP6] = "ipv6", \
338 [VNET_LINK_MPLS] = "mpls", \
339 [VNET_LINK_ARP] = "arp", \
340 [VNET_LINK_NSH] = "nsh", \
343 #define FOR_EACH_VNET_LINK(_link) \
344 for (_link = VNET_LINK_IP4; \
345 _link <= VNET_LINK_NSH; \
349 * @brief Number of link types. Not part of the enum so it does not have to be included in
352 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
355 * @brief Convert a link to to an Ethertype
357 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
360 * @brief Attributes assignable to a HW interface Class.
362 typedef enum vnet_hw_interface_class_flags_t_
365 * @brief a point 2 point interface
367 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
368 } vnet_hw_interface_class_flags_t;
370 /* Layer-2 (e.g. Ethernet) interface class. */
371 typedef struct _vnet_hw_interface_class
373 /* Index into main vector. */
376 /* Class name (e.g. "Ethernet"). */
380 vnet_hw_interface_class_flags_t flags;
382 /* Function to call when hardware interface is added/deleted. */
383 vnet_interface_function_t *interface_add_del_function;
385 /* Function to bring interface administratively up/down. */
386 vnet_interface_function_t *admin_up_down_function;
388 /* Function to call when link state changes. */
389 vnet_interface_function_t *link_up_down_function;
391 /* Function to call when link MAC changes. */
392 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
394 /* Format function to display interface name. */
395 format_function_t *format_interface_name;
397 /* Format function to display interface address. */
398 format_function_t *format_address;
400 /* Format packet header for this interface class. */
401 format_function_t *format_header;
403 /* Format device verbosely for this class. */
404 format_function_t *format_device;
406 /* Parser for hardware (e.g. ethernet) address. */
407 unformat_function_t *unformat_hw_address;
409 /* Parser for packet header for e.g. rewrite string. */
410 unformat_function_t *unformat_header;
412 /* Builds a rewrite string for the interface to the destination
413 * for the payload/link type. */
414 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
416 vnet_link_t link_type, const void *dst_hw_address);
418 /* Update an adjacency added by FIB (as opposed to via the
419 * neighbour resolution protocol). */
420 void (*update_adjacency) (struct vnet_main_t * vnm,
421 u32 sw_if_index, u32 adj_index);
423 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
427 /* Called when hw interface class is changed and old hardware instance
428 may want to be deleted. */
429 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
430 u32 old_class_index, u32 new_class_index);
432 /* List of hw interface classes, built by constructors */
433 struct _vnet_hw_interface_class *next_class_registration;
435 } vnet_hw_interface_class_t;
438 * @brief Return a complete, zero-length (aka dummy) rewrite
440 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
442 vnet_link_t link_type,
443 const void *dst_hw_address);
446 * @brief Default adjacency update function
448 extern void default_update_adjacency (struct vnet_main_t *vnm,
449 u32 sw_if_index, u32 adj_index);
451 #define VNET_HW_INTERFACE_CLASS(x,...) \
452 __VA_ARGS__ vnet_hw_interface_class_t x; \
453 static void __vnet_add_hw_interface_class_registration_##x (void) \
454 __attribute__((__constructor__)) ; \
455 static void __vnet_add_hw_interface_class_registration_##x (void) \
457 vnet_main_t * vnm = vnet_get_main(); \
458 x.next_class_registration = vnm->hw_interface_class_registrations; \
459 vnm->hw_interface_class_registrations = &x; \
461 static void __vnet_rm_hw_interface_class_registration_##x (void) \
462 __attribute__((__destructor__)) ; \
463 static void __vnet_rm_hw_interface_class_registration_##x (void) \
465 vnet_main_t * vnm = vnet_get_main(); \
466 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
467 &x, next_class_registration); \
469 __VA_ARGS__ vnet_hw_interface_class_t x
471 typedef enum vnet_hw_interface_flags_t_
473 VNET_HW_INTERFACE_FLAG_NONE,
474 /* Hardware link state is up. */
475 VNET_HW_INTERFACE_FLAG_LINK_UP = (1 << 0),
476 /* Hardware duplex state */
477 VNET_HW_INTERFACE_FLAG_HALF_DUPLEX = (1 << 1),
478 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX = (1 << 2),
481 VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE = (1 << 16),
483 /* tx checksum offload */
484 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD = (1 << 17),
487 VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO = (1 << 18),
488 } vnet_hw_interface_flags_t;
490 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
491 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
492 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
493 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
494 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
496 /* Hardware-interface. This corresponds to a physical wire
497 that packets flow over. */
498 typedef struct vnet_hw_interface_t
500 /* Interface name. */
504 vnet_hw_interface_flags_t flags;
507 /* link speed in kbps */
510 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
511 address for this class (e.g. PPP). */
514 /* Interface is up as far as software is concerned. */
515 /* NAME.{output,tx} nodes for this interface. */
516 u32 output_node_index, tx_node_index;
518 /* (dev_class, dev_instance) uniquely identifies hw interface. */
522 /* (hw_class, hw_instance) uniquely identifies hw interface. */
526 /* Hardware index for this hardware interface. */
529 /* Software index for this hardware interface. */
532 /* Next index in interface-output node for this interface
533 used by node function vnet_per_buffer_interface_output() */
534 u32 output_node_next_index;
536 /* Maximum transmit rate for this interface in bits/sec. */
537 f64 max_rate_bits_per_sec;
539 /* Smallest packet size supported by this interface. */
540 u32 min_supported_packet_bytes;
542 /* Largest packet size supported by this interface. */
543 u32 max_supported_packet_bytes;
545 /* Smallest packet size for this interface. */
546 u32 min_packet_bytes;
548 /* Largest packet size for this interface. */
549 u32 max_packet_bytes;
551 /* Hash table mapping sub interface id to sw_if_index. */
552 uword *sub_interface_sw_if_index_by_id;
554 /* Count of number of L2 subinterfaces */
557 /* Bonded interface info -
558 0 - not a bonded interface nor a slave
559 ~0 - slave to a bonded interface
560 others - A bonded interface with a pointer to bitmap for all slaves */
562 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
563 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
566 u32 input_node_index;
568 /* input node cpu index by queue */
569 u32 *input_node_thread_index_by_queue;
571 /* vnet_hw_interface_rx_mode by queue */
572 u8 *rx_mode_by_queue;
573 vnet_hw_interface_rx_mode default_rx_mode;
575 /* device input device_and_queue runtime index */
576 uword *dq_runtime_index_by_queue;
578 /* numa node that hardware device connects to */
582 } vnet_hw_interface_t;
584 extern vnet_device_class_t vnet_local_interface_device_class;
588 /* A hw interface. */
589 VNET_SW_INTERFACE_TYPE_HARDWARE,
591 /* A sub-interface. */
592 VNET_SW_INTERFACE_TYPE_SUB,
593 VNET_SW_INTERFACE_TYPE_P2P,
594 VNET_SW_INTERFACE_TYPE_PIPE,
595 } vnet_sw_interface_type_t;
600 * Subinterface ID. A number 0-N to uniquely identify
601 * this subinterface under the main (parent?) interface
605 /* Classification data. Used to associate packet header with subinterface. */
618 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
621 u16 outer_vlan_id_any:1;
622 u16 inner_vlan_id_any:1;
626 } vnet_sub_interface_t;
631 * Subinterface ID. A number 0-N to uniquely identify
632 * this subinterface under the main interface
637 } vnet_p2p_sub_interface_t;
641 /* THe BVI interface */
642 VNET_FLOOD_CLASS_BVI,
644 VNET_FLOOD_CLASS_NORMAL,
645 VNET_FLOOD_CLASS_TUNNEL_MASTER,
646 /* Does not flood when tunnel master is in the same L2 BD */
647 VNET_FLOOD_CLASS_TUNNEL_NORMAL,
648 /* Never flood to this type */
649 VNET_FLOOD_CLASS_NO_FLOOD,
650 } vnet_flood_class_t;
652 /* Per protocol MTU */
655 VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
656 VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
662 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
664 typedef enum vnet_sw_interface_flags_t_
666 VNET_SW_INTERFACE_FLAG_NONE = 0,
667 /* Interface is "up" meaning administratively up.
668 Up in the sense of link state being up is maintained by hardware interface. */
669 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
671 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
672 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
674 __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
676 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
678 VNET_SW_INTERFACE_FLAG_BOND_SLAVE = (1 << 4),
680 /* Interface does not appear in CLI/API */
681 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
683 /* Interface in ERROR state */
684 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
686 /* Interface has IP configured directed broadcast */
687 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
689 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
691 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
692 tunnel, etc. Configuration (e.g. IP address) gets attached to
693 software interface. */
696 vnet_sw_interface_type_t type:16;
698 vnet_sw_interface_flags_t flags;
700 /* Index for this interface. */
703 /* Software interface index of super-interface;
704 equal to sw_if_index if this interface is not a
708 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
709 u32 unnumbered_sw_if_index;
711 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
714 /* MTU for network layer (not including L2 headers) */
717 /* VNET_SW_INTERFACE_TYPE_SUB. */
718 vnet_sub_interface_t sub;
720 /* VNET_SW_INTERFACE_TYPE_P2P. */
721 vnet_p2p_sub_interface_t p2p;
723 vnet_flood_class_t flood_class;
724 } vnet_sw_interface_t;
728 /* Simple counters. */
729 VNET_INTERFACE_COUNTER_DROP = 0,
730 VNET_INTERFACE_COUNTER_PUNT = 1,
731 VNET_INTERFACE_COUNTER_IP4 = 2,
732 VNET_INTERFACE_COUNTER_IP6 = 3,
733 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
734 VNET_INTERFACE_COUNTER_RX_MISS = 5,
735 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
736 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
737 VNET_INTERFACE_COUNTER_MPLS = 8,
738 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
739 /* Combined counters. */
740 VNET_INTERFACE_COUNTER_RX = 0,
741 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
742 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
743 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
744 VNET_INTERFACE_COUNTER_TX = 4,
745 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
746 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
747 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
748 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
749 } vnet_interface_counter_type_t;
751 #define foreach_rx_combined_interface_counter(_x) \
752 for (_x = VNET_INTERFACE_COUNTER_RX; \
753 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
756 #define foreach_tx_combined_interface_counter(_x) \
757 for (_x = VNET_INTERFACE_COUNTER_TX; \
758 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
761 #define foreach_simple_interface_counter_name \
766 _(RX_NO_BUF, rx-no-buf, if) \
767 _(RX_MISS, rx-miss, if) \
768 _(RX_ERROR, rx-error, if) \
769 _(TX_ERROR, tx-error, if) \
772 #define foreach_combined_interface_counter_name \
774 _(RX_UNICAST, rx-unicast, if) \
775 _(RX_MULTICAST, rx-multicast, if) \
776 _(RX_BROADCAST, rx-broadcast, if) \
778 _(TX_UNICAST, tx-unicast, if) \
779 _(TX_MULTICAST, tx-multicast, if) \
780 _(TX_BROADCAST, tx-broadcast, if)
784 COLLECT_SIMPLE_STATS = 0,
785 COLLECT_DETAILED_STATS = 1,
786 } vnet_interface_stats_collection_mode_e;
788 extern int collect_detailed_interface_stats_flag;
791 collect_detailed_interface_stats (void)
793 return collect_detailed_interface_stats_flag;
796 void collect_detailed_interface_stats_flag_set (void);
797 void collect_detailed_interface_stats_flag_clear (void);
802 u32 output_node_index;
804 } vnet_hw_interface_nodes_t;
808 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
810 } vnet_interface_per_thread_data_t;
812 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
817 /* Hardware interfaces. */
818 vnet_hw_interface_t *hw_interfaces;
820 /* Hash table mapping HW interface name to index. */
821 uword *hw_interface_by_name;
823 /* Vectors if hardware interface classes and device classes. */
824 vnet_hw_interface_class_t *hw_interface_classes;
825 vnet_device_class_t *device_classes;
827 /* Hash table mapping name to hw interface/device class. */
828 uword *hw_interface_class_by_name;
829 uword *device_class_by_name;
831 /* Software interfaces. */
832 vnet_sw_interface_t *sw_interfaces;
834 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
835 uword *sw_if_index_by_sup_and_sub;
837 /* Software interface counters both simple and combined
838 packet and byte counters. */
839 volatile u32 *sw_if_counter_lock;
840 vlib_simple_counter_main_t *sw_if_counters;
841 vlib_combined_counter_main_t *combined_sw_if_counters;
843 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
845 /* pcap drop tracing */
846 int drop_pcap_enable;
847 pcap_main_t pcap_main;
849 u32 pcap_sw_if_index;
850 u32 pcap_pkts_to_capture;
851 uword *pcap_drop_filter_hash;
853 /* Buffer metadata format helper functions */
854 vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
855 vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
857 /* per-thread data */
858 vnet_interface_per_thread_data_t *per_thread_data;
860 /* enable GSO processing in packet path if this count is > 0 */
861 u32 gso_interface_count;
863 /* feature_arc_index */
864 u8 output_feature_arc_index;
865 } vnet_interface_main_t;
868 vnet_interface_counter_lock (vnet_interface_main_t * im)
870 if (im->sw_if_counter_lock)
871 while (clib_atomic_test_and_set (im->sw_if_counter_lock))
876 vnet_interface_counter_unlock (vnet_interface_main_t * im)
878 if (im->sw_if_counter_lock)
879 clib_atomic_release (im->sw_if_counter_lock);
882 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
884 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
886 uword vnet_interface_output_node (vlib_main_t * vm,
887 vlib_node_runtime_t * node,
888 vlib_frame_t * frame);
890 void vnet_register_format_buffer_opaque_helper
891 (vnet_buffer_opquae_formatter_t fn);
893 void vnet_register_format_buffer_opaque2_helper
894 (vnet_buffer_opquae_formatter_t fn);
896 #endif /* included_vnet_interface_h */
899 * fd.io coding-style-patch-verification: ON
902 * eval: (c-set-style "gnu")