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 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_interface_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,
93 VNET_FLOW_DEV_OP_ADD_FLOW,
94 VNET_FLOW_DEV_OP_DEL_FLOW,
95 VNET_FLOW_DEV_OP_GET_COUNTER,
96 VNET_FLOW_DEV_OP_RESET_COUNTER,
99 /* Interface flow operations callback. */
100 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
101 vnet_flow_dev_op_t op,
102 u32 hw_if_index, u32 index,
103 uword * private_data);
105 typedef enum vnet_interface_function_priority_t_
107 VNET_ITF_FUNC_PRIORITY_LOW,
108 VNET_ITF_FUNC_PRIORITY_HIGH,
109 } vnet_interface_function_priority_t;
110 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
112 typedef struct _vnet_interface_function_list_elt
114 struct _vnet_interface_function_list_elt *next_interface_function;
115 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
116 } _vnet_interface_function_list_elt_t;
118 #ifndef CLIB_MARCH_VARIANT
119 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
121 static void __vnet_interface_function_init_##tag##_##f (void) \
122 __attribute__((__constructor__)) ; \
124 static void __vnet_interface_function_init_##tag##_##f (void) \
126 vnet_main_t * vnm = vnet_get_main(); \
127 static _vnet_interface_function_list_elt_t init_function; \
128 init_function.next_interface_function = vnm->tag##_functions[p]; \
129 vnm->tag##_functions[p] = &init_function; \
130 init_function.fp = (void *) &f; \
132 static void __vnet_interface_function_deinit_##tag##_##f (void) \
133 __attribute__((__destructor__)) ; \
135 static void __vnet_interface_function_deinit_##tag##_##f (void) \
137 vnet_main_t * vnm = vnet_get_main(); \
138 _vnet_interface_function_list_elt_t *next; \
139 if (vnm->tag##_functions[p]->fp == f) \
141 vnm->tag##_functions[p] = \
142 vnm->tag##_functions[p]->next_interface_function; \
145 next = vnm->tag##_functions[p]; \
146 while (next->next_interface_function) \
148 if (next->next_interface_function->fp == f) \
150 next->next_interface_function = \
151 next->next_interface_function->next_interface_function; \
154 next = next->next_interface_function; \
158 /* create unused pointer to silence compiler warnings and get whole
159 function optimized out */
160 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
161 static __clib_unused void * __clib_unused_##f = f;
164 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
165 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
167 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
168 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
169 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
170 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
171 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
172 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
173 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
174 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
175 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
176 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
177 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
178 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
179 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
180 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
183 * Tunnel description parameters
185 typedef int (*vnet_dev_class_ip_tunnel_desc_t) (u32 sw_if_index,
186 union ip46_address_t_ * src,
187 union ip46_address_t_ * dst,
190 /* A class of hardware interface devices. */
191 typedef struct _vnet_device_class
193 /* Index into main vector. */
196 /* Device name (e.g. "FOOBAR 1234a"). */
199 /* Function to call when hardware interface is added/deleted. */
200 vnet_interface_function_t *interface_add_del_function;
202 /* Function to bring device administratively up/down. */
203 vnet_interface_function_t *admin_up_down_function;
205 /* Function to call when sub-interface is added/deleted */
206 vnet_subif_add_del_function_t *subif_add_del_function;
208 /* Function to call interface rx mode is changed */
209 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
211 /* Function to call interface l2 mode is changed */
212 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
214 /* Redistribute flag changes/existence of this interface class. */
217 /* Transmit function. */
218 vlib_node_function_t *tx_function;
220 /* Transmit function candidate registration with priority */
221 vlib_node_fn_registration_t *tx_fn_registrations;
223 /* Error strings indexed by error code for this node. */
224 char **tx_function_error_strings;
226 /* Number of error codes used by this node. */
227 u32 tx_function_n_errors;
229 /* Renumber device name [only!] support, a control-plane kludge */
230 int (*name_renumber) (struct vnet_hw_interface_t * hi,
231 u32 new_dev_instance);
233 /* Interface flow offload operations */
234 vnet_flow_dev_ops_function_t *flow_ops_function;
236 /* Format device instance as name. */
237 format_function_t *format_device_name;
239 /* Parse function for device name. */
240 unformat_function_t *unformat_device_name;
242 /* Format device verbosely for this class. */
243 format_function_t *format_device;
245 /* Trace buffer format for TX function. */
246 format_function_t *format_tx_trace;
248 /* Format flow offload entry */
249 format_function_t *format_flow;
251 vnet_dev_class_ip_tunnel_desc_t ip_tun_desc;
253 /* Function to clear hardware counters for device. */
254 void (*clear_counters) (u32 dev_class_instance);
256 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
260 /* Called when hardware class of an interface changes. */
261 void (*hw_class_change) (struct vnet_main_t * vnm,
262 u32 hw_if_index, u32 new_hw_class_index);
264 /* Called to redirect traffic from a specific interface instance */
265 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
266 u32 hw_if_index, u32 node_index);
268 /* Link-list of all device classes set up by constructors created below */
269 struct _vnet_device_class *next_class_registration;
271 /* Function to set mac address. */
272 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
274 /* Function to add/delete additional MAC addresses */
275 vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
276 } vnet_device_class_t;
278 #ifndef CLIB_MARCH_VARIANT
279 #define VNET_DEVICE_CLASS(x,...) \
280 __VA_ARGS__ vnet_device_class_t x; \
281 static void __vnet_add_device_class_registration_##x (void) \
282 __attribute__((__constructor__)) ; \
283 static void __vnet_add_device_class_registration_##x (void) \
285 vnet_main_t * vnm = vnet_get_main(); \
286 x.next_class_registration = vnm->device_class_registrations; \
287 vnm->device_class_registrations = &x; \
289 static void __vnet_rm_device_class_registration_##x (void) \
290 __attribute__((__destructor__)) ; \
291 static void __vnet_rm_device_class_registration_##x (void) \
293 vnet_main_t * vnm = vnet_get_main(); \
294 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
295 &x, next_class_registration); \
297 __VA_ARGS__ vnet_device_class_t x
299 /* create unused pointer to silence compiler warnings and get whole
300 function optimized out */
301 #define VNET_DEVICE_CLASS(x,...) \
302 static __clib_unused vnet_device_class_t __clib_unused_##x
305 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
306 uword CLIB_MARCH_SFX (devclass##_tx_fn)(); \
307 static vlib_node_fn_registration_t \
308 CLIB_MARCH_SFX(devclass##_tx_fn_registration) = \
309 { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), }; \
311 static void __clib_constructor \
312 CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void) \
314 extern vnet_device_class_t devclass; \
315 vlib_node_fn_registration_t *r; \
316 r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
317 r->priority = CLIB_MARCH_FN_PRIORITY(); \
318 r->next_registration = devclass.tx_fn_registrations; \
319 devclass.tx_fn_registrations = r; \
321 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
324 * Link Type: A description of the protocol of packets on the link.
325 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
326 * it maps to the GRE-proto, etc for other lnk types.
328 typedef enum vnet_link_t_
340 } __attribute__ ((packed)) vnet_link_t;
342 #define VNET_LINKS { \
343 [VNET_LINK_ETHERNET] = "ethernet", \
344 [VNET_LINK_IP4] = "ipv4", \
345 [VNET_LINK_IP6] = "ipv6", \
346 [VNET_LINK_MPLS] = "mpls", \
347 [VNET_LINK_ARP] = "arp", \
348 [VNET_LINK_NSH] = "nsh", \
351 #define FOR_EACH_VNET_LINK(_link) \
352 for (_link = VNET_LINK_IP4; \
353 _link <= VNET_LINK_NSH; \
357 * @brief Number of link types. Not part of the enum so it does not have to be included in
360 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
363 * @brief Convert a link to to an Ethertype
365 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
368 * @brief Attributes assignable to a HW interface Class.
370 typedef enum vnet_hw_interface_class_flags_t_
373 * @brief a point 2 point interface
375 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
376 } vnet_hw_interface_class_flags_t;
378 /* Layer-2 (e.g. Ethernet) interface class. */
379 typedef struct _vnet_hw_interface_class
381 /* Index into main vector. */
384 /* Class name (e.g. "Ethernet"). */
388 vnet_hw_interface_class_flags_t flags;
390 /* Function to call when hardware interface is added/deleted. */
391 vnet_interface_function_t *interface_add_del_function;
393 /* Function to bring interface administratively up/down. */
394 vnet_interface_function_t *admin_up_down_function;
396 /* Function to call when link state changes. */
397 vnet_interface_function_t *link_up_down_function;
399 /* Function to call when link MAC changes. */
400 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
402 /* Function to add/delete additional MAC addresses */
403 vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
405 /* Format function to display interface name. */
406 format_function_t *format_interface_name;
408 /* Format function to display interface address. */
409 format_function_t *format_address;
411 /* Format packet header for this interface class. */
412 format_function_t *format_header;
414 /* Format device verbosely for this class. */
415 format_function_t *format_device;
417 /* Parser for hardware (e.g. ethernet) address. */
418 unformat_function_t *unformat_hw_address;
420 /* Parser for packet header for e.g. rewrite string. */
421 unformat_function_t *unformat_header;
423 /* Builds a rewrite string for the interface to the destination
424 * for the payload/link type. */
425 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
427 vnet_link_t link_type, const void *dst_hw_address);
429 /* Update an adjacency added by FIB (as opposed to via the
430 * neighbour resolution protocol). */
431 void (*update_adjacency) (struct vnet_main_t * vnm,
432 u32 sw_if_index, u32 adj_index);
434 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
438 /* Called when hw interface class is changed and old hardware instance
439 may want to be deleted. */
440 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
441 u32 old_class_index, u32 new_class_index);
443 /* List of hw interface classes, built by constructors */
444 struct _vnet_hw_interface_class *next_class_registration;
446 } vnet_hw_interface_class_t;
449 * @brief Return a complete, zero-length (aka dummy) rewrite
451 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
453 vnet_link_t link_type,
454 const void *dst_hw_address);
457 * @brief Default adjacency update function
459 extern void default_update_adjacency (struct vnet_main_t *vnm,
460 u32 sw_if_index, u32 adj_index);
462 #define VNET_HW_INTERFACE_CLASS(x,...) \
463 __VA_ARGS__ vnet_hw_interface_class_t x; \
464 static void __vnet_add_hw_interface_class_registration_##x (void) \
465 __attribute__((__constructor__)) ; \
466 static void __vnet_add_hw_interface_class_registration_##x (void) \
468 vnet_main_t * vnm = vnet_get_main(); \
469 x.next_class_registration = vnm->hw_interface_class_registrations; \
470 vnm->hw_interface_class_registrations = &x; \
472 static void __vnet_rm_hw_interface_class_registration_##x (void) \
473 __attribute__((__destructor__)) ; \
474 static void __vnet_rm_hw_interface_class_registration_##x (void) \
476 vnet_main_t * vnm = vnet_get_main(); \
477 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
478 &x, next_class_registration); \
480 __VA_ARGS__ vnet_hw_interface_class_t x
482 typedef enum vnet_hw_interface_flags_t_
484 VNET_HW_INTERFACE_FLAG_NONE,
485 /* Hardware link state is up. */
486 VNET_HW_INTERFACE_FLAG_LINK_UP = (1 << 0),
487 /* Hardware duplex state */
488 VNET_HW_INTERFACE_FLAG_HALF_DUPLEX = (1 << 1),
489 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX = (1 << 2),
492 VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE = (1 << 16),
494 /* tx checksum offload */
495 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD = (1 << 17),
498 VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO = (1 << 18),
499 } vnet_hw_interface_flags_t;
501 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
502 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
503 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
504 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
505 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
507 /* Hardware-interface. This corresponds to a physical wire
508 that packets flow over. */
509 typedef struct vnet_hw_interface_t
511 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
512 /* Interface name. */
516 vnet_hw_interface_flags_t flags;
519 /* link speed in kbps */
522 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
523 address for this class (e.g. PPP). */
526 /* Interface is up as far as software is concerned. */
527 /* NAME.{output,tx} nodes for this interface. */
528 u32 output_node_index, tx_node_index;
530 /* (dev_class, dev_instance) uniquely identifies hw interface. */
534 /* (hw_class, hw_instance) uniquely identifies hw interface. */
538 /* Hardware index for this hardware interface. */
541 /* Software index for this hardware interface. */
544 /* Next index in interface-output node for this interface
545 used by node function vnet_per_buffer_interface_output() */
546 u32 output_node_next_index;
548 /* Maximum transmit rate for this interface in bits/sec. */
549 f64 max_rate_bits_per_sec;
551 /* Smallest packet size supported by this interface. */
552 u32 min_supported_packet_bytes;
554 /* Largest packet size supported by this interface. */
555 u32 max_supported_packet_bytes;
557 /* Smallest packet size for this interface. */
558 u32 min_packet_bytes;
560 /* Largest packet size for this interface. */
561 u32 max_packet_bytes;
563 /* Hash table mapping sub interface id to sw_if_index. */
564 uword *sub_interface_sw_if_index_by_id;
566 /* Count of number of L2 subinterfaces */
569 /* Bonded interface info -
570 0 - not a bonded interface nor a slave
571 ~0 - slave to a bonded interface
572 others - A bonded interface with a pointer to bitmap for all slaves */
574 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
575 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
578 u32 input_node_index;
580 /* input node cpu index by queue */
581 u32 *input_node_thread_index_by_queue;
583 /* vnet_hw_interface_rx_mode by queue */
584 u8 *rx_mode_by_queue;
585 vnet_hw_interface_rx_mode default_rx_mode;
587 /* device input device_and_queue runtime index */
588 uword *dq_runtime_index_by_queue;
590 /* numa node that hardware device connects to */
596 u32 trace_classify_table_index;
597 } vnet_hw_interface_t;
599 extern vnet_device_class_t vnet_local_interface_device_class;
603 /* A hw interface. */
604 VNET_SW_INTERFACE_TYPE_HARDWARE,
606 /* A sub-interface. */
607 VNET_SW_INTERFACE_TYPE_SUB,
608 VNET_SW_INTERFACE_TYPE_P2P,
609 VNET_SW_INTERFACE_TYPE_PIPE,
610 } vnet_sw_interface_type_t;
615 * Subinterface ID. A number 0-N to uniquely identify
616 * this subinterface under the main (parent?) interface
620 /* Classification data. Used to associate packet header with subinterface. */
633 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
636 u16 outer_vlan_id_any:1;
637 u16 inner_vlan_id_any:1;
641 } vnet_sub_interface_t;
646 * Subinterface ID. A number 0-N to uniquely identify
647 * this subinterface under the main interface
652 } vnet_p2p_sub_interface_t;
656 /* THe BVI interface */
657 VNET_FLOOD_CLASS_BVI,
659 VNET_FLOOD_CLASS_NORMAL,
660 VNET_FLOOD_CLASS_TUNNEL_MASTER,
661 /* Does not flood when tunnel master is in the same L2 BD */
662 VNET_FLOOD_CLASS_TUNNEL_NORMAL,
663 /* Never flood to this type */
664 VNET_FLOOD_CLASS_NO_FLOOD,
665 } vnet_flood_class_t;
667 /* Per protocol MTU */
670 VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
671 VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
677 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
679 typedef enum vnet_sw_interface_flags_t_
681 VNET_SW_INTERFACE_FLAG_NONE = 0,
682 /* Interface is "up" meaning administratively up.
683 Up in the sense of link state being up is maintained by hardware interface. */
684 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
686 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
687 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
689 __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
691 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
693 __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
695 /* Interface does not appear in CLI/API */
696 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
698 /* Interface in ERROR state */
699 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
701 /* Interface has IP configured directed broadcast */
702 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
704 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
706 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
707 tunnel, etc. Configuration (e.g. IP address) gets attached to
708 software interface. */
711 vnet_sw_interface_type_t type:16;
713 vnet_sw_interface_flags_t flags;
715 /* Index for this interface. */
718 /* Software interface index of super-interface;
719 equal to sw_if_index if this interface is not a
723 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
724 u32 unnumbered_sw_if_index;
726 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
729 /* MTU for network layer (not including L2 headers) */
732 /* VNET_SW_INTERFACE_TYPE_SUB. */
733 vnet_sub_interface_t sub;
735 /* VNET_SW_INTERFACE_TYPE_P2P. */
736 vnet_p2p_sub_interface_t p2p;
738 vnet_flood_class_t flood_class;
739 } vnet_sw_interface_t;
743 /* Simple counters. */
744 VNET_INTERFACE_COUNTER_DROP = 0,
745 VNET_INTERFACE_COUNTER_PUNT = 1,
746 VNET_INTERFACE_COUNTER_IP4 = 2,
747 VNET_INTERFACE_COUNTER_IP6 = 3,
748 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
749 VNET_INTERFACE_COUNTER_RX_MISS = 5,
750 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
751 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
752 VNET_INTERFACE_COUNTER_MPLS = 8,
753 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
754 /* Combined counters. */
755 VNET_INTERFACE_COUNTER_RX = 0,
756 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
757 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
758 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
759 VNET_INTERFACE_COUNTER_TX = 4,
760 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
761 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
762 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
763 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
764 } vnet_interface_counter_type_t;
766 #define foreach_rx_combined_interface_counter(_x) \
767 for (_x = VNET_INTERFACE_COUNTER_RX; \
768 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
771 #define foreach_tx_combined_interface_counter(_x) \
772 for (_x = VNET_INTERFACE_COUNTER_TX; \
773 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
776 #define foreach_simple_interface_counter_name \
781 _(RX_NO_BUF, rx-no-buf, if) \
782 _(RX_MISS, rx-miss, if) \
783 _(RX_ERROR, rx-error, if) \
784 _(TX_ERROR, tx-error, if) \
787 #define foreach_combined_interface_counter_name \
789 _(RX_UNICAST, rx-unicast, if) \
790 _(RX_MULTICAST, rx-multicast, if) \
791 _(RX_BROADCAST, rx-broadcast, if) \
793 _(TX_UNICAST, tx-unicast, if) \
794 _(TX_MULTICAST, tx-multicast, if) \
795 _(TX_BROADCAST, tx-broadcast, if)
799 COLLECT_SIMPLE_STATS = 0,
800 COLLECT_DETAILED_STATS = 1,
801 } vnet_interface_stats_collection_mode_e;
803 extern int collect_detailed_interface_stats_flag;
806 collect_detailed_interface_stats (void)
808 return collect_detailed_interface_stats_flag;
811 void collect_detailed_interface_stats_flag_set (void);
812 void collect_detailed_interface_stats_flag_clear (void);
817 u32 output_node_index;
819 } vnet_hw_interface_nodes_t;
823 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
825 } vnet_interface_per_thread_data_t;
827 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
832 /* Hardware interfaces. */
833 vnet_hw_interface_t *hw_interfaces;
835 /* Hash table mapping HW interface name to index. */
836 uword *hw_interface_by_name;
838 /* Vectors if hardware interface classes and device classes. */
839 vnet_hw_interface_class_t *hw_interface_classes;
840 vnet_device_class_t *device_classes;
842 /* Hash table mapping name to hw interface/device class. */
843 uword *hw_interface_class_by_name;
844 uword *device_class_by_name;
846 /* Software interfaces. */
847 vnet_sw_interface_t *sw_interfaces;
849 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
850 uword *sw_if_index_by_sup_and_sub;
852 /* Software interface counters both simple and combined
853 packet and byte counters. */
854 clib_spinlock_t sw_if_counter_lock;
855 vlib_simple_counter_main_t *sw_if_counters;
856 vlib_combined_counter_main_t *combined_sw_if_counters;
858 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
862 * Only the drop filter hash lives here. See ../src/vlib/main.h for
863 * the rest of the variables.
865 uword *pcap_drop_filter_hash;
867 /* Buffer metadata format helper functions */
868 vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
869 vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
871 /* per-thread data */
872 vnet_interface_per_thread_data_t *per_thread_data;
874 /* enable GSO processing in packet path if this count is > 0 */
875 u32 gso_interface_count;
877 /* feature_arc_index */
878 u8 output_feature_arc_index;
879 } vnet_interface_main_t;
882 vnet_interface_counter_lock (vnet_interface_main_t * im)
884 if (im->sw_if_counter_lock)
885 clib_spinlock_lock (&im->sw_if_counter_lock);
889 vnet_interface_counter_unlock (vnet_interface_main_t * im)
891 if (im->sw_if_counter_lock)
892 clib_spinlock_unlock (&im->sw_if_counter_lock);
895 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
897 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
899 uword vnet_interface_output_node (vlib_main_t * vm,
900 vlib_node_runtime_t * node,
901 vlib_frame_t * frame);
903 void vnet_register_format_buffer_opaque_helper
904 (vnet_buffer_opquae_formatter_t fn);
906 void vnet_register_format_buffer_opaque2_helper
907 (vnet_buffer_opquae_formatter_t fn);
914 u32 packets_to_capture;
915 u32 max_bytes_per_pkt;
921 } vnet_pcap_dispatch_trace_args_t;
923 int vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t *);
925 #endif /* included_vnet_interface_h */
928 * fd.io coding-style-patch-verification: ON
931 * eval: (c-set-style "gnu")