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 <vnet/unix/pcap.h>
44 #include <vnet/l3_types.h>
47 struct vnet_hw_interface_t;
48 struct vnet_sw_interface_t;
49 struct ip46_address_t;
53 VNET_HW_INTERFACE_RX_MODE_UNKNOWN,
54 VNET_HW_INTERFACE_RX_MODE_POLLING,
55 VNET_HW_INTERFACE_RX_MODE_INTERRUPT,
56 VNET_HW_INTERFACE_RX_MODE_ADAPTIVE,
57 VNET_HW_INTERFACE_RX_MODE_DEFAULT,
58 VNET_HW_INTERFACE_NUM_RX_MODES,
59 } vnet_hw_interface_rx_mode;
61 /* Interface up/down callback. */
62 typedef clib_error_t *(vnet_interface_function_t)
63 (struct vnet_main_t * vnm, u32 if_index, u32 flags);
65 /* Sub-interface add/del callback. */
66 typedef clib_error_t *(vnet_subif_add_del_function_t)
67 (struct vnet_main_t * vnm, u32 if_index,
68 struct vnet_sw_interface_t * template, int is_add);
70 /* Interface set mac address callback. */
71 typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
72 (struct vnet_hw_interface_t * hi, char *address);
74 /* Interface set rx mode callback. */
75 typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
76 (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
77 vnet_hw_interface_rx_mode mode);
79 /* Interface set l2 mode callback. */
80 typedef clib_error_t *(vnet_interface_set_l2_mode_function_t)
81 (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
86 VNET_FLOW_DEV_OP_ADD_FLOW,
87 VNET_FLOW_DEV_OP_DEL_FLOW,
88 VNET_FLOW_DEV_OP_GET_COUNTER,
89 VNET_FLOW_DEV_OP_RESET_COUNTER,
92 /* Interface flow opeations callback. */
93 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
94 vnet_flow_dev_op_t op,
95 u32 hw_if_index, u32 index,
96 uword * private_data);
98 typedef enum vnet_interface_function_priority_t_
100 VNET_ITF_FUNC_PRIORITY_LOW,
101 VNET_ITF_FUNC_PRIORITY_HIGH,
102 } vnet_interface_function_priority_t;
103 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
105 typedef struct _vnet_interface_function_list_elt
107 struct _vnet_interface_function_list_elt *next_interface_function;
108 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
109 } _vnet_interface_function_list_elt_t;
111 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
113 static void __vnet_interface_function_init_##tag##_##f (void) \
114 __attribute__((__constructor__)) ; \
116 static void __vnet_interface_function_init_##tag##_##f (void) \
118 vnet_main_t * vnm = vnet_get_main(); \
119 static _vnet_interface_function_list_elt_t init_function; \
120 init_function.next_interface_function = vnm->tag##_functions[p]; \
121 vnm->tag##_functions[p] = &init_function; \
122 init_function.fp = (void *) &f; \
124 static void __vnet_interface_function_deinit_##tag##_##f (void) \
125 __attribute__((__destructor__)) ; \
127 static void __vnet_interface_function_deinit_##tag##_##f (void) \
129 vnet_main_t * vnm = vnet_get_main(); \
130 _vnet_interface_function_list_elt_t *next; \
131 if (vnm->tag##_functions[p]->fp == (void *) &f) \
133 vnm->tag##_functions[p] = \
134 vnm->tag##_functions[p]->next_interface_function; \
137 next = vnm->tag##_functions[p]; \
138 while (next->next_interface_function) \
140 if (next->next_interface_function->fp == (void *) &f) \
142 next->next_interface_function = \
143 next->next_interface_function->next_interface_function; \
146 next = next->next_interface_function; \
150 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
151 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
153 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
154 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
155 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
156 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
157 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
158 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
159 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
160 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
161 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
162 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
163 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
164 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
165 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
166 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
168 /* A class of hardware interface devices. */
169 typedef struct _vnet_device_class
171 /* Index into main vector. */
174 /* Device name (e.g. "FOOBAR 1234a"). */
177 /* Function to call when hardware interface is added/deleted. */
178 vnet_interface_function_t *interface_add_del_function;
180 /* Function to bring device administratively up/down. */
181 vnet_interface_function_t *admin_up_down_function;
183 /* Function to call when sub-interface is added/deleted */
184 vnet_subif_add_del_function_t *subif_add_del_function;
186 /* Function to call interface rx mode is changed */
187 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
189 /* Function to call interface l2 mode is changed */
190 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
192 /* Redistribute flag changes/existence of this interface class. */
195 /* Transmit function. */
196 vlib_node_function_t *tx_function;
198 /* Transmit function candidate registration with priority */
199 vlib_node_fn_registration_t *tx_fn_registrations;
201 /* Error strings indexed by error code for this node. */
202 char **tx_function_error_strings;
204 /* Number of error codes used by this node. */
205 u32 tx_function_n_errors;
207 /* Renumber device name [only!] support, a control-plane kludge */
208 int (*name_renumber) (struct vnet_hw_interface_t * hi,
209 u32 new_dev_instance);
211 /* Interface flow offload operations */
212 vnet_flow_dev_ops_function_t *flow_ops_function;
214 /* Format device instance as name. */
215 format_function_t *format_device_name;
217 /* Parse function for device name. */
218 unformat_function_t *unformat_device_name;
220 /* Format device verbosely for this class. */
221 format_function_t *format_device;
223 /* Trace buffer format for TX function. */
224 format_function_t *format_tx_trace;
226 /* Format flow offload entry */
227 format_function_t *format_flow;
229 /* Function to clear hardware counters for device. */
230 void (*clear_counters) (u32 dev_class_instance);
232 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
236 /* Called when hardware class of an interface changes. */
237 void (*hw_class_change) (struct vnet_main_t * vnm,
238 u32 hw_if_index, u32 new_hw_class_index);
240 /* Called to redirect traffic from a specific interface instance */
241 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
242 u32 hw_if_index, u32 node_index);
244 /* Link-list of all device classes set up by constructors created below */
245 struct _vnet_device_class *next_class_registration;
247 /* Function to set mac address. */
248 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
249 } vnet_device_class_t;
251 #define VNET_DEVICE_CLASS(x,...) \
252 __VA_ARGS__ vnet_device_class_t x; \
253 static void __vnet_add_device_class_registration_##x (void) \
254 __attribute__((__constructor__)) ; \
255 static void __vnet_add_device_class_registration_##x (void) \
257 vnet_main_t * vnm = vnet_get_main(); \
258 x.next_class_registration = vnm->device_class_registrations; \
259 vnm->device_class_registrations = &x; \
261 static void __vnet_rm_device_class_registration_##x (void) \
262 __attribute__((__destructor__)) ; \
263 static void __vnet_rm_device_class_registration_##x (void) \
265 vnet_main_t * vnm = vnet_get_main(); \
266 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
267 &x, next_class_registration); \
269 __VA_ARGS__ vnet_device_class_t x
271 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
272 uword CLIB_MARCH_SFX (devclass##_tx_fn)(); \
273 static vlib_node_fn_registration_t \
274 CLIB_MARCH_SFX(devclass##_tx_fn_registration) = \
275 { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), }; \
277 static void __clib_constructor \
278 CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void) \
280 extern vnet_device_class_t devclass; \
281 vlib_node_fn_registration_t *r; \
282 r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
283 r->priority = CLIB_MARCH_FN_PRIORITY(); \
284 r->next_registration = devclass.tx_fn_registrations; \
285 devclass.tx_fn_registrations = r; \
287 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
289 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
291 __attribute__ ((flatten)) \
292 __attribute__ ((target (tgt))) \
294 fn ## _ ## arch ( vlib_main_t * vm, \
295 vlib_node_runtime_t * node, \
296 vlib_frame_t * frame) \
297 { return fn (vm, node, frame); }
299 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
300 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
303 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
304 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
306 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
307 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
308 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
309 static void __attribute__((__constructor__)) \
310 __vlib_device_tx_function_multiarch_select_##dev (void) \
311 { dev.tx_function = fn ## _multiarch_select(); }
315 * Link Type: A description of the protocol of packets on the link.
316 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
317 * it maps to the GRE-proto, etc for other lnk types.
319 typedef enum vnet_link_t_
331 } __attribute__ ((packed)) vnet_link_t;
333 #define VNET_LINKS { \
334 [VNET_LINK_ETHERNET] = "ethernet", \
335 [VNET_LINK_IP4] = "ipv4", \
336 [VNET_LINK_IP6] = "ipv6", \
337 [VNET_LINK_MPLS] = "mpls", \
338 [VNET_LINK_ARP] = "arp", \
339 [VNET_LINK_NSH] = "nsh", \
342 #define FOR_EACH_VNET_LINK(_link) \
343 for (_link = VNET_LINK_IP4; \
344 _link <= VNET_LINK_NSH; \
348 * @brief Number of link types. Not part of the enum so it does not have to be included in
351 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
354 * @brief Convert a link to to an Ethertype
356 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
359 * @brief Attributes assignable to a HW interface Class.
361 typedef enum vnet_hw_interface_class_flags_t_
364 * @brief a point 2 point interface
366 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
367 } vnet_hw_interface_class_flags_t;
369 /* Layer-2 (e.g. Ethernet) interface class. */
370 typedef struct _vnet_hw_interface_class
372 /* Index into main vector. */
375 /* Class name (e.g. "Ethernet"). */
379 vnet_hw_interface_class_flags_t flags;
381 /* Function to call when hardware interface is added/deleted. */
382 vnet_interface_function_t *interface_add_del_function;
384 /* Function to bring interface administratively up/down. */
385 vnet_interface_function_t *admin_up_down_function;
387 /* Function to call when link state changes. */
388 vnet_interface_function_t *link_up_down_function;
390 /* Function to call when link MAC changes. */
391 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
393 /* Format function to display interface name. */
394 format_function_t *format_interface_name;
396 /* Format function to display interface address. */
397 format_function_t *format_address;
399 /* Format packet header for this interface class. */
400 format_function_t *format_header;
402 /* Format device verbosely for this class. */
403 format_function_t *format_device;
405 /* Parser for hardware (e.g. ethernet) address. */
406 unformat_function_t *unformat_hw_address;
408 /* Parser for packet header for e.g. rewrite string. */
409 unformat_function_t *unformat_header;
411 /* Builds a rewrite string for the interface to the destination
412 * for the payload/link type. */
413 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
415 vnet_link_t link_type, const void *dst_hw_address);
417 /* Update an adjacecny added by FIB (as opposed to via the
418 * neighbour resolution protocol). */
419 void (*update_adjacency) (struct vnet_main_t * vnm,
420 u32 sw_if_index, u32 adj_index);
422 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
426 /* Called when hw interface class is changed and old hardware instance
427 may want to be deleted. */
428 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
429 u32 old_class_index, u32 new_class_index);
431 /* List of hw interface classes, built by constructors */
432 struct _vnet_hw_interface_class *next_class_registration;
434 } vnet_hw_interface_class_t;
437 * @brief Return a complete, zero-length (aka dummy) rewrite
439 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
441 vnet_link_t link_type,
442 const void *dst_hw_address);
445 * @brief Default adjacency update function
447 extern void default_update_adjacency (struct vnet_main_t *vnm,
448 u32 sw_if_index, u32 adj_index);
450 #define VNET_HW_INTERFACE_CLASS(x,...) \
451 __VA_ARGS__ vnet_hw_interface_class_t x; \
452 static void __vnet_add_hw_interface_class_registration_##x (void) \
453 __attribute__((__constructor__)) ; \
454 static void __vnet_add_hw_interface_class_registration_##x (void) \
456 vnet_main_t * vnm = vnet_get_main(); \
457 x.next_class_registration = vnm->hw_interface_class_registrations; \
458 vnm->hw_interface_class_registrations = &x; \
460 static void __vnet_rm_hw_interface_class_registration_##x (void) \
461 __attribute__((__destructor__)) ; \
462 static void __vnet_rm_hw_interface_class_registration_##x (void) \
464 vnet_main_t * vnm = vnet_get_main(); \
465 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
466 &x, next_class_registration); \
468 __VA_ARGS__ vnet_hw_interface_class_t x
470 /* Hardware-interface. This corresponds to a physical wire
471 that packets flow over. */
472 typedef struct vnet_hw_interface_t
474 /* Interface name. */
478 /* Hardware link state is up. */
479 #define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
480 /* Hardware duplex state */
481 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
482 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
483 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
484 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
485 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
486 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
488 /* Hardware link speed */
489 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
490 #define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
491 #define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
492 #define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
493 #define VNET_HW_INTERFACE_FLAG_SPEED_2_5G (1 << 6)
494 #define VNET_HW_INTERFACE_FLAG_SPEED_5G (1 << 7)
495 #define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 8)
496 #define VNET_HW_INTERFACE_FLAG_SPEED_20G (1 << 9)
497 #define VNET_HW_INTERFACE_FLAG_SPEED_25G (1 << 10)
498 #define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 11)
499 #define VNET_HW_INTERFACE_FLAG_SPEED_50G (1 << 12)
500 #define VNET_HW_INTERFACE_FLAG_SPEED_56G (1 << 13)
501 #define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 14)
502 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
503 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
504 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
505 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
506 VNET_HW_INTERFACE_FLAG_SPEED_2_5G | \
507 VNET_HW_INTERFACE_FLAG_SPEED_5G | \
508 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
509 VNET_HW_INTERFACE_FLAG_SPEED_20G | \
510 VNET_HW_INTERFACE_FLAG_SPEED_25G | \
511 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
512 VNET_HW_INTERFACE_FLAG_SPEED_50G | \
513 VNET_HW_INTERFACE_FLAG_SPEED_56G | \
514 VNET_HW_INTERFACE_FLAG_SPEED_100G)
517 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE (1 << 16)
519 /* tx checksum offload */
520 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD (1 << 17)
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 /* Interface is "up" meaning adminstratively up.
675 Up in the sense of link state being up is maintained by hardware interface. */
676 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
678 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
679 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
681 VNET_SW_INTERFACE_FLAG_PROXY_ARP = (1 << 2),
683 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
685 VNET_SW_INTERFACE_FLAG_BOND_SLAVE = (1 << 4),
687 /* Interface does not appear in CLI/API */
688 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
690 /* Interface in ERROR state */
691 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
693 /* Interface has IP configured directed broadcast */
694 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
696 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
698 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
699 tunnel, etc. Configuration (e.g. IP address) gets attached to
700 software interface. */
703 vnet_sw_interface_type_t type:16;
705 vnet_sw_interface_flags_t flags;
707 /* Index for this interface. */
710 /* Software interface index of super-interface;
711 equal to sw_if_index if this interface is not a
715 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
716 u32 unnumbered_sw_if_index;
720 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
723 /* MTU for network layer (not including L2 headers) */
726 /* VNET_SW_INTERFACE_TYPE_SUB. */
727 vnet_sub_interface_t sub;
729 /* VNET_SW_INTERFACE_TYPE_P2P. */
730 vnet_p2p_sub_interface_t p2p;
732 vnet_flood_class_t flood_class;
733 } vnet_sw_interface_t;
737 /* Simple counters. */
738 VNET_INTERFACE_COUNTER_DROP = 0,
739 VNET_INTERFACE_COUNTER_PUNT = 1,
740 VNET_INTERFACE_COUNTER_IP4 = 2,
741 VNET_INTERFACE_COUNTER_IP6 = 3,
742 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
743 VNET_INTERFACE_COUNTER_RX_MISS = 5,
744 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
745 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
746 VNET_INTERFACE_COUNTER_MPLS = 8,
747 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
748 /* Combined counters. */
749 VNET_INTERFACE_COUNTER_RX = 0,
750 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
751 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
752 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
753 VNET_INTERFACE_COUNTER_TX = 4,
754 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
755 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
756 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
757 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
758 } vnet_interface_counter_type_t;
760 #define foreach_rx_combined_interface_counter(_x) \
761 for (_x = VNET_INTERFACE_COUNTER_RX; \
762 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
765 #define foreach_tx_combined_interface_counter(_x) \
766 for (_x = VNET_INTERFACE_COUNTER_TX; \
767 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
770 #define foreach_simple_interface_counter_name \
775 _(RX_NO_BUF, rx-no-buf, if) \
776 _(RX_MISS, rx-miss, if) \
777 _(RX_ERROR, rx-error, if) \
778 _(TX_ERROR, tx-error, if)
780 #define foreach_combined_interface_counter_name \
782 _(RX_UNICAST, rx-unicast, if) \
783 _(RX_MULTICAST, rx-multicast, if) \
784 _(RX_BROADCAST, rx-broadcast, if) \
786 _(TX_UNICAST, tx-unicast-miss, if) \
787 _(TX_MULTICAST, tx-multicast, if) \
788 _(TX_BROADCAST, tx-broadcast, if)
792 COLLECT_SIMPLE_STATS = 0,
793 COLLECT_DETAILED_STATS = 1,
794 } vnet_interface_stats_collection_mode_e;
796 extern int collect_detailed_interface_stats_flag;
799 collect_detailed_interface_stats (void)
801 return collect_detailed_interface_stats_flag;
804 void collect_detailed_interface_stats_flag_set (void);
805 void collect_detailed_interface_stats_flag_clear (void);
810 u32 output_node_index;
812 } vnet_hw_interface_nodes_t;
816 /* Hardware interfaces. */
817 vnet_hw_interface_t *hw_interfaces;
819 /* Hash table mapping HW interface name to index. */
820 uword *hw_interface_by_name;
822 /* Vectors if hardware interface classes and device classes. */
823 vnet_hw_interface_class_t *hw_interface_classes;
824 vnet_device_class_t *device_classes;
826 /* Hash table mapping name to hw interface/device class. */
827 uword *hw_interface_class_by_name;
828 uword *device_class_by_name;
830 /* Software interfaces. */
831 vnet_sw_interface_t *sw_interfaces;
833 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
834 uword *sw_if_index_by_sup_and_sub;
836 /* Software interface counters both simple and combined
837 packet and byte counters. */
838 volatile u32 *sw_if_counter_lock;
839 vlib_simple_counter_main_t *sw_if_counters;
840 vlib_combined_counter_main_t *combined_sw_if_counters;
842 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
844 /* pcap drop tracing */
845 int drop_pcap_enable;
846 pcap_main_t pcap_main;
848 u32 pcap_sw_if_index;
849 u32 pcap_pkts_to_capture;
850 uword *pcap_drop_filter_hash;
852 /* feature_arc_index */
853 u8 output_feature_arc_index;
854 } vnet_interface_main_t;
857 vnet_interface_counter_lock (vnet_interface_main_t * im)
859 if (im->sw_if_counter_lock)
860 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
865 vnet_interface_counter_unlock (vnet_interface_main_t * im)
867 if (im->sw_if_counter_lock)
868 *im->sw_if_counter_lock = 0;
871 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
873 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
875 #endif /* included_vnet_interface_h */
878 * fd.io coding-style-patch-verification: ON
881 * eval: (c-set-style "gnu")