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 struct 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 == (void *) &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 == (void *) &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)
177 /* A class of hardware interface devices. */
178 typedef struct _vnet_device_class
180 /* Index into main vector. */
183 /* Device name (e.g. "FOOBAR 1234a"). */
186 /* Function to call when hardware interface is added/deleted. */
187 vnet_interface_function_t *interface_add_del_function;
189 /* Function to bring device administratively up/down. */
190 vnet_interface_function_t *admin_up_down_function;
192 /* Function to call when sub-interface is added/deleted */
193 vnet_subif_add_del_function_t *subif_add_del_function;
195 /* Function to call interface rx mode is changed */
196 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
198 /* Function to call interface l2 mode is changed */
199 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
201 /* Redistribute flag changes/existence of this interface class. */
204 /* Transmit function. */
205 vlib_node_function_t *tx_function;
207 /* Transmit function candidate registration with priority */
208 vlib_node_fn_registration_t *tx_fn_registrations;
210 /* Error strings indexed by error code for this node. */
211 char **tx_function_error_strings;
213 /* Number of error codes used by this node. */
214 u32 tx_function_n_errors;
216 /* Renumber device name [only!] support, a control-plane kludge */
217 int (*name_renumber) (struct vnet_hw_interface_t * hi,
218 u32 new_dev_instance);
220 /* Interface flow offload operations */
221 vnet_flow_dev_ops_function_t *flow_ops_function;
223 /* Format device instance as name. */
224 format_function_t *format_device_name;
226 /* Parse function for device name. */
227 unformat_function_t *unformat_device_name;
229 /* Format device verbosely for this class. */
230 format_function_t *format_device;
232 /* Trace buffer format for TX function. */
233 format_function_t *format_tx_trace;
235 /* Format flow offload entry */
236 format_function_t *format_flow;
238 /* Function to clear hardware counters for device. */
239 void (*clear_counters) (u32 dev_class_instance);
241 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
245 /* Called when hardware class of an interface changes. */
246 void (*hw_class_change) (struct vnet_main_t * vnm,
247 u32 hw_if_index, u32 new_hw_class_index);
249 /* Called to redirect traffic from a specific interface instance */
250 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
251 u32 hw_if_index, u32 node_index);
253 /* Link-list of all device classes set up by constructors created below */
254 struct _vnet_device_class *next_class_registration;
256 /* Function to set mac address. */
257 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
258 } vnet_device_class_t;
260 #ifndef CLIB_MARCH_VARIANT
261 #define VNET_DEVICE_CLASS(x,...) \
262 __VA_ARGS__ vnet_device_class_t x; \
263 static void __vnet_add_device_class_registration_##x (void) \
264 __attribute__((__constructor__)) ; \
265 static void __vnet_add_device_class_registration_##x (void) \
267 vnet_main_t * vnm = vnet_get_main(); \
268 x.next_class_registration = vnm->device_class_registrations; \
269 vnm->device_class_registrations = &x; \
271 static void __vnet_rm_device_class_registration_##x (void) \
272 __attribute__((__destructor__)) ; \
273 static void __vnet_rm_device_class_registration_##x (void) \
275 vnet_main_t * vnm = vnet_get_main(); \
276 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
277 &x, next_class_registration); \
279 __VA_ARGS__ vnet_device_class_t x
281 /* create unused pointer to silence compiler warnings and get whole
282 function optimized out */
283 #define VNET_DEVICE_CLASS(x,...) \
284 static __clib_unused vnet_device_class_t __clib_unused_##x
287 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
288 uword CLIB_MARCH_SFX (devclass##_tx_fn)(); \
289 static vlib_node_fn_registration_t \
290 CLIB_MARCH_SFX(devclass##_tx_fn_registration) = \
291 { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), }; \
293 static void __clib_constructor \
294 CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void) \
296 extern vnet_device_class_t devclass; \
297 vlib_node_fn_registration_t *r; \
298 r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
299 r->priority = CLIB_MARCH_FN_PRIORITY(); \
300 r->next_registration = devclass.tx_fn_registrations; \
301 devclass.tx_fn_registrations = r; \
303 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
305 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
307 __attribute__ ((flatten)) \
308 __attribute__ ((target (tgt))) \
310 fn ## _ ## arch ( vlib_main_t * vm, \
311 vlib_node_runtime_t * node, \
312 vlib_frame_t * frame) \
313 { return fn (vm, node, frame); }
315 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
316 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
319 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
320 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
322 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
323 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
324 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
325 static void __attribute__((__constructor__)) \
326 __vlib_device_tx_function_multiarch_select_##dev (void) \
327 { dev.tx_function = fn ## _multiarch_select(); }
331 * Link Type: A description of the protocol of packets on the link.
332 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
333 * it maps to the GRE-proto, etc for other lnk types.
335 typedef enum vnet_link_t_
347 } __attribute__ ((packed)) vnet_link_t;
349 #define VNET_LINKS { \
350 [VNET_LINK_ETHERNET] = "ethernet", \
351 [VNET_LINK_IP4] = "ipv4", \
352 [VNET_LINK_IP6] = "ipv6", \
353 [VNET_LINK_MPLS] = "mpls", \
354 [VNET_LINK_ARP] = "arp", \
355 [VNET_LINK_NSH] = "nsh", \
358 #define FOR_EACH_VNET_LINK(_link) \
359 for (_link = VNET_LINK_IP4; \
360 _link <= VNET_LINK_NSH; \
364 * @brief Number of link types. Not part of the enum so it does not have to be included in
367 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
370 * @brief Convert a link to to an Ethertype
372 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
375 * @brief Attributes assignable to a HW interface Class.
377 typedef enum vnet_hw_interface_class_flags_t_
380 * @brief a point 2 point interface
382 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
383 } vnet_hw_interface_class_flags_t;
385 /* Layer-2 (e.g. Ethernet) interface class. */
386 typedef struct _vnet_hw_interface_class
388 /* Index into main vector. */
391 /* Class name (e.g. "Ethernet"). */
395 vnet_hw_interface_class_flags_t flags;
397 /* Function to call when hardware interface is added/deleted. */
398 vnet_interface_function_t *interface_add_del_function;
400 /* Function to bring interface administratively up/down. */
401 vnet_interface_function_t *admin_up_down_function;
403 /* Function to call when link state changes. */
404 vnet_interface_function_t *link_up_down_function;
406 /* Function to call when link MAC changes. */
407 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
409 /* Format function to display interface name. */
410 format_function_t *format_interface_name;
412 /* Format function to display interface address. */
413 format_function_t *format_address;
415 /* Format packet header for this interface class. */
416 format_function_t *format_header;
418 /* Format device verbosely for this class. */
419 format_function_t *format_device;
421 /* Parser for hardware (e.g. ethernet) address. */
422 unformat_function_t *unformat_hw_address;
424 /* Parser for packet header for e.g. rewrite string. */
425 unformat_function_t *unformat_header;
427 /* Builds a rewrite string for the interface to the destination
428 * for the payload/link type. */
429 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
431 vnet_link_t link_type, const void *dst_hw_address);
433 /* Update an adjacency added by FIB (as opposed to via the
434 * neighbour resolution protocol). */
435 void (*update_adjacency) (struct vnet_main_t * vnm,
436 u32 sw_if_index, u32 adj_index);
438 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
442 /* Called when hw interface class is changed and old hardware instance
443 may want to be deleted. */
444 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
445 u32 old_class_index, u32 new_class_index);
447 /* List of hw interface classes, built by constructors */
448 struct _vnet_hw_interface_class *next_class_registration;
450 } vnet_hw_interface_class_t;
453 * @brief Return a complete, zero-length (aka dummy) rewrite
455 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
457 vnet_link_t link_type,
458 const void *dst_hw_address);
461 * @brief Default adjacency update function
463 extern void default_update_adjacency (struct vnet_main_t *vnm,
464 u32 sw_if_index, u32 adj_index);
466 #define VNET_HW_INTERFACE_CLASS(x,...) \
467 __VA_ARGS__ vnet_hw_interface_class_t x; \
468 static void __vnet_add_hw_interface_class_registration_##x (void) \
469 __attribute__((__constructor__)) ; \
470 static void __vnet_add_hw_interface_class_registration_##x (void) \
472 vnet_main_t * vnm = vnet_get_main(); \
473 x.next_class_registration = vnm->hw_interface_class_registrations; \
474 vnm->hw_interface_class_registrations = &x; \
476 static void __vnet_rm_hw_interface_class_registration_##x (void) \
477 __attribute__((__destructor__)) ; \
478 static void __vnet_rm_hw_interface_class_registration_##x (void) \
480 vnet_main_t * vnm = vnet_get_main(); \
481 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
482 &x, next_class_registration); \
484 __VA_ARGS__ vnet_hw_interface_class_t x
486 typedef enum vnet_hw_interface_flags_t_
488 VNET_HW_INTERFACE_FLAG_NONE,
489 /* Hardware link state is up. */
490 VNET_HW_INTERFACE_FLAG_LINK_UP = (1 << 0),
491 /* Hardware duplex state */
492 VNET_HW_INTERFACE_FLAG_HALF_DUPLEX = (1 << 1),
493 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX = (1 << 2),
496 VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE = (1 << 16),
498 /* tx checksum offload */
499 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD = (1 << 17),
500 } vnet_hw_interface_flags_t;
502 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
503 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
504 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
505 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
506 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
508 /* Hardware-interface. This corresponds to a physical wire
509 that packets flow over. */
510 typedef struct vnet_hw_interface_t
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 } vnet_hw_interface_t;
592 extern vnet_device_class_t vnet_local_interface_device_class;
596 /* A hw interface. */
597 VNET_SW_INTERFACE_TYPE_HARDWARE,
599 /* A sub-interface. */
600 VNET_SW_INTERFACE_TYPE_SUB,
601 VNET_SW_INTERFACE_TYPE_P2P,
602 VNET_SW_INTERFACE_TYPE_PIPE,
603 } vnet_sw_interface_type_t;
608 * Subinterface ID. A number 0-N to uniquely identify
609 * this subinterface under the main (parent?) interface
613 /* Classification data. Used to associate packet header with subinterface. */
626 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
629 u16 outer_vlan_id_any:1;
630 u16 inner_vlan_id_any:1;
634 } vnet_sub_interface_t;
639 * Subinterface ID. A number 0-N to uniquely identify
640 * this subinterface under the main interface
645 } vnet_p2p_sub_interface_t;
649 /* THe BVI interface */
650 VNET_FLOOD_CLASS_BVI,
652 VNET_FLOOD_CLASS_NORMAL,
653 VNET_FLOOD_CLASS_TUNNEL_MASTER,
654 /* Does not flood when tunnel master is in the same L2 BD */
655 VNET_FLOOD_CLASS_TUNNEL_NORMAL,
656 /* Never flood to this type */
657 VNET_FLOOD_CLASS_NO_FLOOD,
658 } vnet_flood_class_t;
660 /* Per protocol MTU */
663 VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
664 VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
670 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
672 typedef enum vnet_sw_interface_flags_t_
674 VNET_SW_INTERFACE_FLAG_NONE = 0,
675 /* Interface is "up" meaning administratively up.
676 Up in the sense of link state being up is maintained by hardware interface. */
677 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
679 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
680 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
682 VNET_SW_INTERFACE_FLAG_PROXY_ARP = (1 << 2),
684 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
686 VNET_SW_INTERFACE_FLAG_BOND_SLAVE = (1 << 4),
688 /* Interface does not appear in CLI/API */
689 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
691 /* Interface in ERROR state */
692 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
694 /* Interface has IP configured directed broadcast */
695 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
697 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
699 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
700 tunnel, etc. Configuration (e.g. IP address) gets attached to
701 software interface. */
704 vnet_sw_interface_type_t type:16;
706 vnet_sw_interface_flags_t flags;
708 /* Index for this interface. */
711 /* Software interface index of super-interface;
712 equal to sw_if_index if this interface is not a
716 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
717 u32 unnumbered_sw_if_index;
719 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
722 /* MTU for network layer (not including L2 headers) */
725 /* VNET_SW_INTERFACE_TYPE_SUB. */
726 vnet_sub_interface_t sub;
728 /* VNET_SW_INTERFACE_TYPE_P2P. */
729 vnet_p2p_sub_interface_t p2p;
731 vnet_flood_class_t flood_class;
732 } vnet_sw_interface_t;
736 /* Simple counters. */
737 VNET_INTERFACE_COUNTER_DROP = 0,
738 VNET_INTERFACE_COUNTER_PUNT = 1,
739 VNET_INTERFACE_COUNTER_IP4 = 2,
740 VNET_INTERFACE_COUNTER_IP6 = 3,
741 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
742 VNET_INTERFACE_COUNTER_RX_MISS = 5,
743 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
744 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
745 VNET_INTERFACE_COUNTER_MPLS = 8,
746 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
747 /* Combined counters. */
748 VNET_INTERFACE_COUNTER_RX = 0,
749 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
750 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
751 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
752 VNET_INTERFACE_COUNTER_TX = 4,
753 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
754 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
755 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
756 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
757 } vnet_interface_counter_type_t;
759 #define foreach_rx_combined_interface_counter(_x) \
760 for (_x = VNET_INTERFACE_COUNTER_RX; \
761 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
764 #define foreach_tx_combined_interface_counter(_x) \
765 for (_x = VNET_INTERFACE_COUNTER_TX; \
766 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
769 #define foreach_simple_interface_counter_name \
774 _(RX_NO_BUF, rx-no-buf, if) \
775 _(RX_MISS, rx-miss, if) \
776 _(RX_ERROR, rx-error, if) \
777 _(TX_ERROR, tx-error, if)
779 #define foreach_combined_interface_counter_name \
781 _(RX_UNICAST, rx-unicast, if) \
782 _(RX_MULTICAST, rx-multicast, if) \
783 _(RX_BROADCAST, rx-broadcast, if) \
785 _(TX_UNICAST, tx-unicast-miss, if) \
786 _(TX_MULTICAST, tx-multicast, if) \
787 _(TX_BROADCAST, tx-broadcast, if)
791 COLLECT_SIMPLE_STATS = 0,
792 COLLECT_DETAILED_STATS = 1,
793 } vnet_interface_stats_collection_mode_e;
795 extern int collect_detailed_interface_stats_flag;
798 collect_detailed_interface_stats (void)
800 return collect_detailed_interface_stats_flag;
803 void collect_detailed_interface_stats_flag_set (void);
804 void collect_detailed_interface_stats_flag_clear (void);
809 u32 output_node_index;
811 } vnet_hw_interface_nodes_t;
815 /* Hardware interfaces. */
816 vnet_hw_interface_t *hw_interfaces;
818 /* Hash table mapping HW interface name to index. */
819 uword *hw_interface_by_name;
821 /* Vectors if hardware interface classes and device classes. */
822 vnet_hw_interface_class_t *hw_interface_classes;
823 vnet_device_class_t *device_classes;
825 /* Hash table mapping name to hw interface/device class. */
826 uword *hw_interface_class_by_name;
827 uword *device_class_by_name;
829 /* Software interfaces. */
830 vnet_sw_interface_t *sw_interfaces;
832 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
833 uword *sw_if_index_by_sup_and_sub;
835 /* Software interface counters both simple and combined
836 packet and byte counters. */
837 volatile u32 *sw_if_counter_lock;
838 vlib_simple_counter_main_t *sw_if_counters;
839 vlib_combined_counter_main_t *combined_sw_if_counters;
841 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
843 /* pcap drop tracing */
844 int drop_pcap_enable;
845 pcap_main_t pcap_main;
847 u32 pcap_sw_if_index;
848 u32 pcap_pkts_to_capture;
849 uword *pcap_drop_filter_hash;
851 /* feature_arc_index */
852 u8 output_feature_arc_index;
853 } vnet_interface_main_t;
856 vnet_interface_counter_lock (vnet_interface_main_t * im)
858 if (im->sw_if_counter_lock)
859 while (clib_atomic_test_and_set (im->sw_if_counter_lock))
864 vnet_interface_counter_unlock (vnet_interface_main_t * im)
866 if (im->sw_if_counter_lock)
867 clib_atomic_release (im->sw_if_counter_lock);
870 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
872 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
874 #endif /* included_vnet_interface_h */
877 * fd.io coding-style-patch-verification: ON
880 * eval: (c-set-style "gnu")