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_INTERFACE_RX_MODE_UNKNOWN,
56 VNET_HW_INTERFACE_RX_MODE_POLLING,
57 VNET_HW_INTERFACE_RX_MODE_INTERRUPT,
58 VNET_HW_INTERFACE_RX_MODE_ADAPTIVE,
59 VNET_HW_INTERFACE_RX_MODE_DEFAULT,
60 VNET_HW_INTERFACE_NUM_RX_MODES,
61 } vnet_hw_interface_rx_mode;
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 set rx mode callback. */
78 typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
79 (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
80 vnet_hw_interface_rx_mode mode);
82 /* Interface set l2 mode callback. */
83 typedef clib_error_t *(vnet_interface_set_l2_mode_function_t)
84 (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
89 VNET_FLOW_DEV_OP_ADD_FLOW,
90 VNET_FLOW_DEV_OP_DEL_FLOW,
91 VNET_FLOW_DEV_OP_GET_COUNTER,
92 VNET_FLOW_DEV_OP_RESET_COUNTER,
95 /* Interface flow operations callback. */
96 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
97 vnet_flow_dev_op_t op,
98 u32 hw_if_index, u32 index,
99 uword * private_data);
101 typedef enum vnet_interface_function_priority_t_
103 VNET_ITF_FUNC_PRIORITY_LOW,
104 VNET_ITF_FUNC_PRIORITY_HIGH,
105 } vnet_interface_function_priority_t;
106 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
108 typedef struct _vnet_interface_function_list_elt
110 struct _vnet_interface_function_list_elt *next_interface_function;
111 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
112 } _vnet_interface_function_list_elt_t;
114 #ifndef CLIB_MARCH_VARIANT
115 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
117 static void __vnet_interface_function_init_##tag##_##f (void) \
118 __attribute__((__constructor__)) ; \
120 static void __vnet_interface_function_init_##tag##_##f (void) \
122 vnet_main_t * vnm = vnet_get_main(); \
123 static _vnet_interface_function_list_elt_t init_function; \
124 init_function.next_interface_function = vnm->tag##_functions[p]; \
125 vnm->tag##_functions[p] = &init_function; \
126 init_function.fp = (void *) &f; \
128 static void __vnet_interface_function_deinit_##tag##_##f (void) \
129 __attribute__((__destructor__)) ; \
131 static void __vnet_interface_function_deinit_##tag##_##f (void) \
133 vnet_main_t * vnm = vnet_get_main(); \
134 _vnet_interface_function_list_elt_t *next; \
135 if (vnm->tag##_functions[p]->fp == f) \
137 vnm->tag##_functions[p] = \
138 vnm->tag##_functions[p]->next_interface_function; \
141 next = vnm->tag##_functions[p]; \
142 while (next->next_interface_function) \
144 if (next->next_interface_function->fp == f) \
146 next->next_interface_function = \
147 next->next_interface_function->next_interface_function; \
150 next = next->next_interface_function; \
154 /* create unused pointer to silence compiler warnings and get whole
155 function optimized out */
156 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
157 static __clib_unused void * __clib_unused_##f = f;
160 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
161 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
163 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
164 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
165 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
166 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
167 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
168 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
169 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
170 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
171 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
172 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
173 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
174 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
175 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
176 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
179 * Tunnel description parameters
181 typedef int (*vnet_dev_class_ip_tunnel_desc_t) (u32 sw_if_index,
182 union ip46_address_t_ * src,
183 union ip46_address_t_ * dst,
186 /* A class of hardware interface devices. */
187 typedef struct _vnet_device_class
189 /* Index into main vector. */
192 /* Device name (e.g. "FOOBAR 1234a"). */
195 /* Function to call when hardware interface is added/deleted. */
196 vnet_interface_function_t *interface_add_del_function;
198 /* Function to bring device administratively up/down. */
199 vnet_interface_function_t *admin_up_down_function;
201 /* Function to call when sub-interface is added/deleted */
202 vnet_subif_add_del_function_t *subif_add_del_function;
204 /* Function to call interface rx mode is changed */
205 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
207 /* Function to call interface l2 mode is changed */
208 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
210 /* Redistribute flag changes/existence of this interface class. */
213 /* Transmit function. */
214 vlib_node_function_t *tx_function;
216 /* Transmit function candidate registration with priority */
217 vlib_node_fn_registration_t *tx_fn_registrations;
219 /* Error strings indexed by error code for this node. */
220 char **tx_function_error_strings;
222 /* Number of error codes used by this node. */
223 u32 tx_function_n_errors;
225 /* Renumber device name [only!] support, a control-plane kludge */
226 int (*name_renumber) (struct vnet_hw_interface_t * hi,
227 u32 new_dev_instance);
229 /* Interface flow offload operations */
230 vnet_flow_dev_ops_function_t *flow_ops_function;
232 /* Format device instance as name. */
233 format_function_t *format_device_name;
235 /* Parse function for device name. */
236 unformat_function_t *unformat_device_name;
238 /* Format device verbosely for this class. */
239 format_function_t *format_device;
241 /* Trace buffer format for TX function. */
242 format_function_t *format_tx_trace;
244 /* Format flow offload entry */
245 format_function_t *format_flow;
247 vnet_dev_class_ip_tunnel_desc_t ip_tun_desc;
249 /* Function to clear hardware counters for device. */
250 void (*clear_counters) (u32 dev_class_instance);
252 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
256 /* Called when hardware class of an interface changes. */
257 void (*hw_class_change) (struct vnet_main_t * vnm,
258 u32 hw_if_index, u32 new_hw_class_index);
260 /* Called to redirect traffic from a specific interface instance */
261 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
262 u32 hw_if_index, u32 node_index);
264 /* Link-list of all device classes set up by constructors created below */
265 struct _vnet_device_class *next_class_registration;
267 /* Function to set mac address. */
268 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
269 } vnet_device_class_t;
271 #ifndef CLIB_MARCH_VARIANT
272 #define VNET_DEVICE_CLASS(x,...) \
273 __VA_ARGS__ vnet_device_class_t x; \
274 static void __vnet_add_device_class_registration_##x (void) \
275 __attribute__((__constructor__)) ; \
276 static void __vnet_add_device_class_registration_##x (void) \
278 vnet_main_t * vnm = vnet_get_main(); \
279 x.next_class_registration = vnm->device_class_registrations; \
280 vnm->device_class_registrations = &x; \
282 static void __vnet_rm_device_class_registration_##x (void) \
283 __attribute__((__destructor__)) ; \
284 static void __vnet_rm_device_class_registration_##x (void) \
286 vnet_main_t * vnm = vnet_get_main(); \
287 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
288 &x, next_class_registration); \
290 __VA_ARGS__ vnet_device_class_t x
292 /* create unused pointer to silence compiler warnings and get whole
293 function optimized out */
294 #define VNET_DEVICE_CLASS(x,...) \
295 static __clib_unused vnet_device_class_t __clib_unused_##x
298 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
299 uword CLIB_MARCH_SFX (devclass##_tx_fn)(); \
300 static vlib_node_fn_registration_t \
301 CLIB_MARCH_SFX(devclass##_tx_fn_registration) = \
302 { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), }; \
304 static void __clib_constructor \
305 CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void) \
307 extern vnet_device_class_t devclass; \
308 vlib_node_fn_registration_t *r; \
309 r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
310 r->priority = CLIB_MARCH_FN_PRIORITY(); \
311 r->next_registration = devclass.tx_fn_registrations; \
312 devclass.tx_fn_registrations = r; \
314 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
317 * Link Type: A description of the protocol of packets on the link.
318 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
319 * it maps to the GRE-proto, etc for other lnk types.
321 typedef enum vnet_link_t_
333 } __attribute__ ((packed)) vnet_link_t;
335 #define VNET_LINKS { \
336 [VNET_LINK_ETHERNET] = "ethernet", \
337 [VNET_LINK_IP4] = "ipv4", \
338 [VNET_LINK_IP6] = "ipv6", \
339 [VNET_LINK_MPLS] = "mpls", \
340 [VNET_LINK_ARP] = "arp", \
341 [VNET_LINK_NSH] = "nsh", \
344 #define FOR_EACH_VNET_LINK(_link) \
345 for (_link = VNET_LINK_IP4; \
346 _link <= VNET_LINK_NSH; \
350 * @brief Number of link types. Not part of the enum so it does not have to be included in
353 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
356 * @brief Convert a link to to an Ethertype
358 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
361 * @brief Attributes assignable to a HW interface Class.
363 typedef enum vnet_hw_interface_class_flags_t_
366 * @brief a point 2 point interface
368 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
369 } vnet_hw_interface_class_flags_t;
371 /* Layer-2 (e.g. Ethernet) interface class. */
372 typedef struct _vnet_hw_interface_class
374 /* Index into main vector. */
377 /* Class name (e.g. "Ethernet"). */
381 vnet_hw_interface_class_flags_t flags;
383 /* Function to call when hardware interface is added/deleted. */
384 vnet_interface_function_t *interface_add_del_function;
386 /* Function to bring interface administratively up/down. */
387 vnet_interface_function_t *admin_up_down_function;
389 /* Function to call when link state changes. */
390 vnet_interface_function_t *link_up_down_function;
392 /* Function to call when link MAC changes. */
393 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
395 /* Format function to display interface name. */
396 format_function_t *format_interface_name;
398 /* Format function to display interface address. */
399 format_function_t *format_address;
401 /* Format packet header for this interface class. */
402 format_function_t *format_header;
404 /* Format device verbosely for this class. */
405 format_function_t *format_device;
407 /* Parser for hardware (e.g. ethernet) address. */
408 unformat_function_t *unformat_hw_address;
410 /* Parser for packet header for e.g. rewrite string. */
411 unformat_function_t *unformat_header;
413 /* Builds a rewrite string for the interface to the destination
414 * for the payload/link type. */
415 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
417 vnet_link_t link_type, const void *dst_hw_address);
419 /* Update an adjacency added by FIB (as opposed to via the
420 * neighbour resolution protocol). */
421 void (*update_adjacency) (struct vnet_main_t * vnm,
422 u32 sw_if_index, u32 adj_index);
424 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
428 /* Called when hw interface class is changed and old hardware instance
429 may want to be deleted. */
430 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
431 u32 old_class_index, u32 new_class_index);
433 /* List of hw interface classes, built by constructors */
434 struct _vnet_hw_interface_class *next_class_registration;
436 } vnet_hw_interface_class_t;
439 * @brief Return a complete, zero-length (aka dummy) rewrite
441 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
443 vnet_link_t link_type,
444 const void *dst_hw_address);
447 * @brief Default adjacency update function
449 extern void default_update_adjacency (struct vnet_main_t *vnm,
450 u32 sw_if_index, u32 adj_index);
452 #define VNET_HW_INTERFACE_CLASS(x,...) \
453 __VA_ARGS__ vnet_hw_interface_class_t x; \
454 static void __vnet_add_hw_interface_class_registration_##x (void) \
455 __attribute__((__constructor__)) ; \
456 static void __vnet_add_hw_interface_class_registration_##x (void) \
458 vnet_main_t * vnm = vnet_get_main(); \
459 x.next_class_registration = vnm->hw_interface_class_registrations; \
460 vnm->hw_interface_class_registrations = &x; \
462 static void __vnet_rm_hw_interface_class_registration_##x (void) \
463 __attribute__((__destructor__)) ; \
464 static void __vnet_rm_hw_interface_class_registration_##x (void) \
466 vnet_main_t * vnm = vnet_get_main(); \
467 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
468 &x, next_class_registration); \
470 __VA_ARGS__ vnet_hw_interface_class_t x
472 typedef enum vnet_hw_interface_flags_t_
474 VNET_HW_INTERFACE_FLAG_NONE,
475 /* Hardware link state is up. */
476 VNET_HW_INTERFACE_FLAG_LINK_UP = (1 << 0),
477 /* Hardware duplex state */
478 VNET_HW_INTERFACE_FLAG_HALF_DUPLEX = (1 << 1),
479 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX = (1 << 2),
482 VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE = (1 << 16),
484 /* tx checksum offload */
485 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD = (1 << 17),
488 VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO = (1 << 18),
489 } vnet_hw_interface_flags_t;
491 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
492 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
493 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
494 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
495 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
497 /* Hardware-interface. This corresponds to a physical wire
498 that packets flow over. */
499 typedef struct vnet_hw_interface_t
501 /* Interface name. */
505 vnet_hw_interface_flags_t flags;
508 /* link speed in kbps */
511 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
512 address for this class (e.g. PPP). */
515 /* Interface is up as far as software is concerned. */
516 /* NAME.{output,tx} nodes for this interface. */
517 u32 output_node_index, tx_node_index;
519 /* (dev_class, dev_instance) uniquely identifies hw interface. */
523 /* (hw_class, hw_instance) uniquely identifies hw interface. */
527 /* Hardware index for this hardware interface. */
530 /* Software index for this hardware interface. */
533 /* Next index in interface-output node for this interface
534 used by node function vnet_per_buffer_interface_output() */
535 u32 output_node_next_index;
537 /* Maximum transmit rate for this interface in bits/sec. */
538 f64 max_rate_bits_per_sec;
540 /* Smallest packet size supported by this interface. */
541 u32 min_supported_packet_bytes;
543 /* Largest packet size supported by this interface. */
544 u32 max_supported_packet_bytes;
546 /* Smallest packet size for this interface. */
547 u32 min_packet_bytes;
549 /* Largest packet size for this interface. */
550 u32 max_packet_bytes;
552 /* Hash table mapping sub interface id to sw_if_index. */
553 uword *sub_interface_sw_if_index_by_id;
555 /* Count of number of L2 subinterfaces */
558 /* Bonded interface info -
559 0 - not a bonded interface nor a slave
560 ~0 - slave to a bonded interface
561 others - A bonded interface with a pointer to bitmap for all slaves */
563 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
564 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
567 u32 input_node_index;
569 /* input node cpu index by queue */
570 u32 *input_node_thread_index_by_queue;
572 /* vnet_hw_interface_rx_mode by queue */
573 u8 *rx_mode_by_queue;
574 vnet_hw_interface_rx_mode default_rx_mode;
576 /* device input device_and_queue runtime index */
577 uword *dq_runtime_index_by_queue;
579 /* numa node that hardware device connects to */
583 } vnet_hw_interface_t;
585 extern vnet_device_class_t vnet_local_interface_device_class;
589 /* A hw interface. */
590 VNET_SW_INTERFACE_TYPE_HARDWARE,
592 /* A sub-interface. */
593 VNET_SW_INTERFACE_TYPE_SUB,
594 VNET_SW_INTERFACE_TYPE_P2P,
595 VNET_SW_INTERFACE_TYPE_PIPE,
596 } vnet_sw_interface_type_t;
601 * Subinterface ID. A number 0-N to uniquely identify
602 * this subinterface under the main (parent?) interface
606 /* Classification data. Used to associate packet header with subinterface. */
619 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
622 u16 outer_vlan_id_any:1;
623 u16 inner_vlan_id_any:1;
627 } vnet_sub_interface_t;
632 * Subinterface ID. A number 0-N to uniquely identify
633 * this subinterface under the main interface
638 } vnet_p2p_sub_interface_t;
642 /* THe BVI interface */
643 VNET_FLOOD_CLASS_BVI,
645 VNET_FLOOD_CLASS_NORMAL,
646 VNET_FLOOD_CLASS_TUNNEL_MASTER,
647 /* Does not flood when tunnel master is in the same L2 BD */
648 VNET_FLOOD_CLASS_TUNNEL_NORMAL,
649 /* Never flood to this type */
650 VNET_FLOOD_CLASS_NO_FLOOD,
651 } vnet_flood_class_t;
653 /* Per protocol MTU */
656 VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
657 VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
663 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
665 typedef enum vnet_sw_interface_flags_t_
667 VNET_SW_INTERFACE_FLAG_NONE = 0,
668 /* Interface is "up" meaning administratively up.
669 Up in the sense of link state being up is maintained by hardware interface. */
670 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
672 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
673 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
675 __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
677 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
679 VNET_SW_INTERFACE_FLAG_BOND_SLAVE = (1 << 4),
681 /* Interface does not appear in CLI/API */
682 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
684 /* Interface in ERROR state */
685 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
687 /* Interface has IP configured directed broadcast */
688 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
690 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
692 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
693 tunnel, etc. Configuration (e.g. IP address) gets attached to
694 software interface. */
697 vnet_sw_interface_type_t type:16;
699 vnet_sw_interface_flags_t flags;
701 /* Index for this interface. */
704 /* Software interface index of super-interface;
705 equal to sw_if_index if this interface is not a
709 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
710 u32 unnumbered_sw_if_index;
712 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
715 /* MTU for network layer (not including L2 headers) */
718 /* VNET_SW_INTERFACE_TYPE_SUB. */
719 vnet_sub_interface_t sub;
721 /* VNET_SW_INTERFACE_TYPE_P2P. */
722 vnet_p2p_sub_interface_t p2p;
724 vnet_flood_class_t flood_class;
725 } vnet_sw_interface_t;
729 /* Simple counters. */
730 VNET_INTERFACE_COUNTER_DROP = 0,
731 VNET_INTERFACE_COUNTER_PUNT = 1,
732 VNET_INTERFACE_COUNTER_IP4 = 2,
733 VNET_INTERFACE_COUNTER_IP6 = 3,
734 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
735 VNET_INTERFACE_COUNTER_RX_MISS = 5,
736 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
737 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
738 VNET_INTERFACE_COUNTER_MPLS = 8,
739 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
740 /* Combined counters. */
741 VNET_INTERFACE_COUNTER_RX = 0,
742 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
743 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
744 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
745 VNET_INTERFACE_COUNTER_TX = 4,
746 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
747 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
748 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
749 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
750 } vnet_interface_counter_type_t;
752 #define foreach_rx_combined_interface_counter(_x) \
753 for (_x = VNET_INTERFACE_COUNTER_RX; \
754 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
757 #define foreach_tx_combined_interface_counter(_x) \
758 for (_x = VNET_INTERFACE_COUNTER_TX; \
759 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
762 #define foreach_simple_interface_counter_name \
767 _(RX_NO_BUF, rx-no-buf, if) \
768 _(RX_MISS, rx-miss, if) \
769 _(RX_ERROR, rx-error, if) \
770 _(TX_ERROR, tx-error, if) \
773 #define foreach_combined_interface_counter_name \
775 _(RX_UNICAST, rx-unicast, if) \
776 _(RX_MULTICAST, rx-multicast, if) \
777 _(RX_BROADCAST, rx-broadcast, if) \
779 _(TX_UNICAST, tx-unicast, if) \
780 _(TX_MULTICAST, tx-multicast, if) \
781 _(TX_BROADCAST, tx-broadcast, if)
785 COLLECT_SIMPLE_STATS = 0,
786 COLLECT_DETAILED_STATS = 1,
787 } vnet_interface_stats_collection_mode_e;
789 extern int collect_detailed_interface_stats_flag;
792 collect_detailed_interface_stats (void)
794 return collect_detailed_interface_stats_flag;
797 void collect_detailed_interface_stats_flag_set (void);
798 void collect_detailed_interface_stats_flag_clear (void);
803 u32 output_node_index;
805 } vnet_hw_interface_nodes_t;
809 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
811 } vnet_interface_per_thread_data_t;
813 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
818 /* Hardware interfaces. */
819 vnet_hw_interface_t *hw_interfaces;
821 /* Hash table mapping HW interface name to index. */
822 uword *hw_interface_by_name;
824 /* Vectors if hardware interface classes and device classes. */
825 vnet_hw_interface_class_t *hw_interface_classes;
826 vnet_device_class_t *device_classes;
828 /* Hash table mapping name to hw interface/device class. */
829 uword *hw_interface_class_by_name;
830 uword *device_class_by_name;
832 /* Software interfaces. */
833 vnet_sw_interface_t *sw_interfaces;
835 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
836 uword *sw_if_index_by_sup_and_sub;
838 /* Software interface counters both simple and combined
839 packet and byte counters. */
840 clib_spinlock_t sw_if_counter_lock;
841 vlib_simple_counter_main_t *sw_if_counters;
842 vlib_combined_counter_main_t *combined_sw_if_counters;
844 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
846 /* pcap drop tracing */
847 int drop_pcap_enable;
848 pcap_main_t pcap_main;
850 u32 pcap_sw_if_index;
851 u32 pcap_pkts_to_capture;
852 uword *pcap_drop_filter_hash;
854 /* Buffer metadata format helper functions */
855 vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
856 vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
858 /* per-thread data */
859 vnet_interface_per_thread_data_t *per_thread_data;
861 /* enable GSO processing in packet path if this count is > 0 */
862 u32 gso_interface_count;
864 /* feature_arc_index */
865 u8 output_feature_arc_index;
866 } vnet_interface_main_t;
869 vnet_interface_counter_lock (vnet_interface_main_t * im)
871 if (im->sw_if_counter_lock)
872 clib_spinlock_lock (&im->sw_if_counter_lock);
876 vnet_interface_counter_unlock (vnet_interface_main_t * im)
878 if (im->sw_if_counter_lock)
879 clib_spinlock_unlock (&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")