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 #ifndef CLIB_MARCH_VARIANT
112 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
114 static void __vnet_interface_function_init_##tag##_##f (void) \
115 __attribute__((__constructor__)) ; \
117 static void __vnet_interface_function_init_##tag##_##f (void) \
119 vnet_main_t * vnm = vnet_get_main(); \
120 static _vnet_interface_function_list_elt_t init_function; \
121 init_function.next_interface_function = vnm->tag##_functions[p]; \
122 vnm->tag##_functions[p] = &init_function; \
123 init_function.fp = (void *) &f; \
125 static void __vnet_interface_function_deinit_##tag##_##f (void) \
126 __attribute__((__destructor__)) ; \
128 static void __vnet_interface_function_deinit_##tag##_##f (void) \
130 vnet_main_t * vnm = vnet_get_main(); \
131 _vnet_interface_function_list_elt_t *next; \
132 if (vnm->tag##_functions[p]->fp == (void *) &f) \
134 vnm->tag##_functions[p] = \
135 vnm->tag##_functions[p]->next_interface_function; \
138 next = vnm->tag##_functions[p]; \
139 while (next->next_interface_function) \
141 if (next->next_interface_function->fp == (void *) &f) \
143 next->next_interface_function = \
144 next->next_interface_function->next_interface_function; \
147 next = next->next_interface_function; \
151 /* create unused pointer to silence compiler warnings and get whole
152 function optimized out */
153 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
154 static __clib_unused void * __clib_unused_##f = f;
157 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
158 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
160 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
161 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
162 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
163 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
164 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
165 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
166 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
167 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
168 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
169 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
170 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
171 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
172 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
173 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
175 /* A class of hardware interface devices. */
176 typedef struct _vnet_device_class
178 /* Index into main vector. */
181 /* Device name (e.g. "FOOBAR 1234a"). */
184 /* Function to call when hardware interface is added/deleted. */
185 vnet_interface_function_t *interface_add_del_function;
187 /* Function to bring device administratively up/down. */
188 vnet_interface_function_t *admin_up_down_function;
190 /* Function to call when sub-interface is added/deleted */
191 vnet_subif_add_del_function_t *subif_add_del_function;
193 /* Function to call interface rx mode is changed */
194 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
196 /* Function to call interface l2 mode is changed */
197 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
199 /* Redistribute flag changes/existence of this interface class. */
202 /* Transmit function. */
203 vlib_node_function_t *tx_function;
205 /* Transmit function candidate registration with priority */
206 vlib_node_fn_registration_t *tx_fn_registrations;
208 /* Error strings indexed by error code for this node. */
209 char **tx_function_error_strings;
211 /* Number of error codes used by this node. */
212 u32 tx_function_n_errors;
214 /* Renumber device name [only!] support, a control-plane kludge */
215 int (*name_renumber) (struct vnet_hw_interface_t * hi,
216 u32 new_dev_instance);
218 /* Interface flow offload operations */
219 vnet_flow_dev_ops_function_t *flow_ops_function;
221 /* Format device instance as name. */
222 format_function_t *format_device_name;
224 /* Parse function for device name. */
225 unformat_function_t *unformat_device_name;
227 /* Format device verbosely for this class. */
228 format_function_t *format_device;
230 /* Trace buffer format for TX function. */
231 format_function_t *format_tx_trace;
233 /* Format flow offload entry */
234 format_function_t *format_flow;
236 /* Function to clear hardware counters for device. */
237 void (*clear_counters) (u32 dev_class_instance);
239 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
243 /* Called when hardware class of an interface changes. */
244 void (*hw_class_change) (struct vnet_main_t * vnm,
245 u32 hw_if_index, u32 new_hw_class_index);
247 /* Called to redirect traffic from a specific interface instance */
248 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
249 u32 hw_if_index, u32 node_index);
251 /* Link-list of all device classes set up by constructors created below */
252 struct _vnet_device_class *next_class_registration;
254 /* Function to set mac address. */
255 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
256 } vnet_device_class_t;
258 #ifndef CLIB_MARCH_VARIANT
259 #define VNET_DEVICE_CLASS(x,...) \
260 __VA_ARGS__ vnet_device_class_t x; \
261 static void __vnet_add_device_class_registration_##x (void) \
262 __attribute__((__constructor__)) ; \
263 static void __vnet_add_device_class_registration_##x (void) \
265 vnet_main_t * vnm = vnet_get_main(); \
266 x.next_class_registration = vnm->device_class_registrations; \
267 vnm->device_class_registrations = &x; \
269 static void __vnet_rm_device_class_registration_##x (void) \
270 __attribute__((__destructor__)) ; \
271 static void __vnet_rm_device_class_registration_##x (void) \
273 vnet_main_t * vnm = vnet_get_main(); \
274 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
275 &x, next_class_registration); \
277 __VA_ARGS__ vnet_device_class_t x
279 /* create unused pointer to silence compiler warnings and get whole
280 function optimized out */
281 #define VNET_DEVICE_CLASS(x,...) \
282 static __clib_unused vnet_device_class_t __clib_unused_##x
285 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
286 uword CLIB_MARCH_SFX (devclass##_tx_fn)(); \
287 static vlib_node_fn_registration_t \
288 CLIB_MARCH_SFX(devclass##_tx_fn_registration) = \
289 { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), }; \
291 static void __clib_constructor \
292 CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void) \
294 extern vnet_device_class_t devclass; \
295 vlib_node_fn_registration_t *r; \
296 r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
297 r->priority = CLIB_MARCH_FN_PRIORITY(); \
298 r->next_registration = devclass.tx_fn_registrations; \
299 devclass.tx_fn_registrations = r; \
301 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
303 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
305 __attribute__ ((flatten)) \
306 __attribute__ ((target (tgt))) \
308 fn ## _ ## arch ( vlib_main_t * vm, \
309 vlib_node_runtime_t * node, \
310 vlib_frame_t * frame) \
311 { return fn (vm, node, frame); }
313 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
314 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
317 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
318 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
320 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
321 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
322 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
323 static void __attribute__((__constructor__)) \
324 __vlib_device_tx_function_multiarch_select_##dev (void) \
325 { dev.tx_function = fn ## _multiarch_select(); }
329 * Link Type: A description of the protocol of packets on the link.
330 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
331 * it maps to the GRE-proto, etc for other lnk types.
333 typedef enum vnet_link_t_
345 } __attribute__ ((packed)) vnet_link_t;
347 #define VNET_LINKS { \
348 [VNET_LINK_ETHERNET] = "ethernet", \
349 [VNET_LINK_IP4] = "ipv4", \
350 [VNET_LINK_IP6] = "ipv6", \
351 [VNET_LINK_MPLS] = "mpls", \
352 [VNET_LINK_ARP] = "arp", \
353 [VNET_LINK_NSH] = "nsh", \
356 #define FOR_EACH_VNET_LINK(_link) \
357 for (_link = VNET_LINK_IP4; \
358 _link <= VNET_LINK_NSH; \
362 * @brief Number of link types. Not part of the enum so it does not have to be included in
365 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
368 * @brief Convert a link to to an Ethertype
370 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
373 * @brief Attributes assignable to a HW interface Class.
375 typedef enum vnet_hw_interface_class_flags_t_
378 * @brief a point 2 point interface
380 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
381 } vnet_hw_interface_class_flags_t;
383 /* Layer-2 (e.g. Ethernet) interface class. */
384 typedef struct _vnet_hw_interface_class
386 /* Index into main vector. */
389 /* Class name (e.g. "Ethernet"). */
393 vnet_hw_interface_class_flags_t flags;
395 /* Function to call when hardware interface is added/deleted. */
396 vnet_interface_function_t *interface_add_del_function;
398 /* Function to bring interface administratively up/down. */
399 vnet_interface_function_t *admin_up_down_function;
401 /* Function to call when link state changes. */
402 vnet_interface_function_t *link_up_down_function;
404 /* Function to call when link MAC changes. */
405 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
407 /* Format function to display interface name. */
408 format_function_t *format_interface_name;
410 /* Format function to display interface address. */
411 format_function_t *format_address;
413 /* Format packet header for this interface class. */
414 format_function_t *format_header;
416 /* Format device verbosely for this class. */
417 format_function_t *format_device;
419 /* Parser for hardware (e.g. ethernet) address. */
420 unformat_function_t *unformat_hw_address;
422 /* Parser for packet header for e.g. rewrite string. */
423 unformat_function_t *unformat_header;
425 /* Builds a rewrite string for the interface to the destination
426 * for the payload/link type. */
427 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
429 vnet_link_t link_type, const void *dst_hw_address);
431 /* Update an adjacecny added by FIB (as opposed to via the
432 * neighbour resolution protocol). */
433 void (*update_adjacency) (struct vnet_main_t * vnm,
434 u32 sw_if_index, u32 adj_index);
436 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
440 /* Called when hw interface class is changed and old hardware instance
441 may want to be deleted. */
442 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
443 u32 old_class_index, u32 new_class_index);
445 /* List of hw interface classes, built by constructors */
446 struct _vnet_hw_interface_class *next_class_registration;
448 } vnet_hw_interface_class_t;
451 * @brief Return a complete, zero-length (aka dummy) rewrite
453 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
455 vnet_link_t link_type,
456 const void *dst_hw_address);
459 * @brief Default adjacency update function
461 extern void default_update_adjacency (struct vnet_main_t *vnm,
462 u32 sw_if_index, u32 adj_index);
464 #define VNET_HW_INTERFACE_CLASS(x,...) \
465 __VA_ARGS__ vnet_hw_interface_class_t x; \
466 static void __vnet_add_hw_interface_class_registration_##x (void) \
467 __attribute__((__constructor__)) ; \
468 static void __vnet_add_hw_interface_class_registration_##x (void) \
470 vnet_main_t * vnm = vnet_get_main(); \
471 x.next_class_registration = vnm->hw_interface_class_registrations; \
472 vnm->hw_interface_class_registrations = &x; \
474 static void __vnet_rm_hw_interface_class_registration_##x (void) \
475 __attribute__((__destructor__)) ; \
476 static void __vnet_rm_hw_interface_class_registration_##x (void) \
478 vnet_main_t * vnm = vnet_get_main(); \
479 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
480 &x, next_class_registration); \
482 __VA_ARGS__ vnet_hw_interface_class_t x
484 /* Hardware-interface. This corresponds to a physical wire
485 that packets flow over. */
486 typedef struct vnet_hw_interface_t
488 /* Interface name. */
492 /* Hardware link state is up. */
493 #define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
494 /* Hardware duplex state */
495 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
496 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
497 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
498 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
499 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
500 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
502 /* Hardware link speed */
503 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
504 #define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
505 #define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
506 #define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
507 #define VNET_HW_INTERFACE_FLAG_SPEED_2_5G (1 << 6)
508 #define VNET_HW_INTERFACE_FLAG_SPEED_5G (1 << 7)
509 #define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 8)
510 #define VNET_HW_INTERFACE_FLAG_SPEED_20G (1 << 9)
511 #define VNET_HW_INTERFACE_FLAG_SPEED_25G (1 << 10)
512 #define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 11)
513 #define VNET_HW_INTERFACE_FLAG_SPEED_50G (1 << 12)
514 #define VNET_HW_INTERFACE_FLAG_SPEED_56G (1 << 13)
515 #define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 14)
516 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
517 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
518 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
519 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
520 VNET_HW_INTERFACE_FLAG_SPEED_2_5G | \
521 VNET_HW_INTERFACE_FLAG_SPEED_5G | \
522 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
523 VNET_HW_INTERFACE_FLAG_SPEED_20G | \
524 VNET_HW_INTERFACE_FLAG_SPEED_25G | \
525 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
526 VNET_HW_INTERFACE_FLAG_SPEED_50G | \
527 VNET_HW_INTERFACE_FLAG_SPEED_56G | \
528 VNET_HW_INTERFACE_FLAG_SPEED_100G)
531 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE (1 << 16)
533 /* tx checksum offload */
534 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD (1 << 17)
536 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
537 address for this class (e.g. PPP). */
540 /* Interface is up as far as software is concerned. */
541 /* NAME.{output,tx} nodes for this interface. */
542 u32 output_node_index, tx_node_index;
544 /* (dev_class, dev_instance) uniquely identifies hw interface. */
548 /* (hw_class, hw_instance) uniquely identifies hw interface. */
552 /* Hardware index for this hardware interface. */
555 /* Software index for this hardware interface. */
558 /* Next index in interface-output node for this interface
559 used by node function vnet_per_buffer_interface_output() */
560 u32 output_node_next_index;
562 /* Maximum transmit rate for this interface in bits/sec. */
563 f64 max_rate_bits_per_sec;
565 /* Smallest packet size supported by this interface. */
566 u32 min_supported_packet_bytes;
568 /* Largest packet size supported by this interface. */
569 u32 max_supported_packet_bytes;
571 /* Smallest packet size for this interface. */
572 u32 min_packet_bytes;
574 /* Largest packet size for this interface. */
575 u32 max_packet_bytes;
577 /* Hash table mapping sub interface id to sw_if_index. */
578 uword *sub_interface_sw_if_index_by_id;
580 /* Count of number of L2 subinterfaces */
583 /* Bonded interface info -
584 0 - not a bonded interface nor a slave
585 ~0 - slave to a bonded interface
586 others - A bonded interface with a pointer to bitmap for all slaves */
588 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
589 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
592 u32 input_node_index;
594 /* input node cpu index by queue */
595 u32 *input_node_thread_index_by_queue;
597 /* vnet_hw_interface_rx_mode by queue */
598 u8 *rx_mode_by_queue;
599 vnet_hw_interface_rx_mode default_rx_mode;
601 /* device input device_and_queue runtime index */
602 uword *dq_runtime_index_by_queue;
604 } vnet_hw_interface_t;
606 extern vnet_device_class_t vnet_local_interface_device_class;
610 /* A hw interface. */
611 VNET_SW_INTERFACE_TYPE_HARDWARE,
613 /* A sub-interface. */
614 VNET_SW_INTERFACE_TYPE_SUB,
615 VNET_SW_INTERFACE_TYPE_P2P,
616 VNET_SW_INTERFACE_TYPE_PIPE,
617 } vnet_sw_interface_type_t;
622 * Subinterface ID. A number 0-N to uniquely identify
623 * this subinterface under the main (parent?) interface
627 /* Classification data. Used to associate packet header with subinterface. */
640 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
643 u16 outer_vlan_id_any:1;
644 u16 inner_vlan_id_any:1;
648 } vnet_sub_interface_t;
653 * Subinterface ID. A number 0-N to uniquely identify
654 * this subinterface under the main interface
659 } vnet_p2p_sub_interface_t;
663 /* THe BVI interface */
664 VNET_FLOOD_CLASS_BVI,
666 VNET_FLOOD_CLASS_NORMAL,
667 VNET_FLOOD_CLASS_TUNNEL_MASTER,
668 /* Does not flood when tunnel master is in the same L2 BD */
669 VNET_FLOOD_CLASS_TUNNEL_NORMAL,
670 /* Never flood to this type */
671 VNET_FLOOD_CLASS_NO_FLOOD,
672 } vnet_flood_class_t;
674 /* Per protocol MTU */
677 VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
678 VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
684 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
686 typedef enum vnet_sw_interface_flags_t_
688 /* Interface is "up" meaning adminstratively up.
689 Up in the sense of link state being up is maintained by hardware interface. */
690 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
692 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
693 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
695 VNET_SW_INTERFACE_FLAG_PROXY_ARP = (1 << 2),
697 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
699 VNET_SW_INTERFACE_FLAG_BOND_SLAVE = (1 << 4),
701 /* Interface does not appear in CLI/API */
702 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
704 /* Interface in ERROR state */
705 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
707 /* Interface has IP configured directed broadcast */
708 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
710 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
712 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
713 tunnel, etc. Configuration (e.g. IP address) gets attached to
714 software interface. */
717 vnet_sw_interface_type_t type:16;
719 vnet_sw_interface_flags_t flags;
721 /* Index for this interface. */
724 /* Software interface index of super-interface;
725 equal to sw_if_index if this interface is not a
729 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
730 u32 unnumbered_sw_if_index;
734 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
737 /* MTU for network layer (not including L2 headers) */
740 /* VNET_SW_INTERFACE_TYPE_SUB. */
741 vnet_sub_interface_t sub;
743 /* VNET_SW_INTERFACE_TYPE_P2P. */
744 vnet_p2p_sub_interface_t p2p;
746 vnet_flood_class_t flood_class;
747 } vnet_sw_interface_t;
751 /* Simple counters. */
752 VNET_INTERFACE_COUNTER_DROP = 0,
753 VNET_INTERFACE_COUNTER_PUNT = 1,
754 VNET_INTERFACE_COUNTER_IP4 = 2,
755 VNET_INTERFACE_COUNTER_IP6 = 3,
756 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
757 VNET_INTERFACE_COUNTER_RX_MISS = 5,
758 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
759 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
760 VNET_INTERFACE_COUNTER_MPLS = 8,
761 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
762 /* Combined counters. */
763 VNET_INTERFACE_COUNTER_RX = 0,
764 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
765 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
766 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
767 VNET_INTERFACE_COUNTER_TX = 4,
768 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
769 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
770 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
771 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
772 } vnet_interface_counter_type_t;
774 #define foreach_rx_combined_interface_counter(_x) \
775 for (_x = VNET_INTERFACE_COUNTER_RX; \
776 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
779 #define foreach_tx_combined_interface_counter(_x) \
780 for (_x = VNET_INTERFACE_COUNTER_TX; \
781 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
784 #define foreach_simple_interface_counter_name \
789 _(RX_NO_BUF, rx-no-buf, if) \
790 _(RX_MISS, rx-miss, if) \
791 _(RX_ERROR, rx-error, if) \
792 _(TX_ERROR, tx-error, if)
794 #define foreach_combined_interface_counter_name \
796 _(RX_UNICAST, rx-unicast, if) \
797 _(RX_MULTICAST, rx-multicast, if) \
798 _(RX_BROADCAST, rx-broadcast, if) \
800 _(TX_UNICAST, tx-unicast-miss, if) \
801 _(TX_MULTICAST, tx-multicast, if) \
802 _(TX_BROADCAST, tx-broadcast, if)
806 COLLECT_SIMPLE_STATS = 0,
807 COLLECT_DETAILED_STATS = 1,
808 } vnet_interface_stats_collection_mode_e;
810 extern int collect_detailed_interface_stats_flag;
813 collect_detailed_interface_stats (void)
815 return collect_detailed_interface_stats_flag;
818 void collect_detailed_interface_stats_flag_set (void);
819 void collect_detailed_interface_stats_flag_clear (void);
824 u32 output_node_index;
826 } vnet_hw_interface_nodes_t;
830 /* Hardware interfaces. */
831 vnet_hw_interface_t *hw_interfaces;
833 /* Hash table mapping HW interface name to index. */
834 uword *hw_interface_by_name;
836 /* Vectors if hardware interface classes and device classes. */
837 vnet_hw_interface_class_t *hw_interface_classes;
838 vnet_device_class_t *device_classes;
840 /* Hash table mapping name to hw interface/device class. */
841 uword *hw_interface_class_by_name;
842 uword *device_class_by_name;
844 /* Software interfaces. */
845 vnet_sw_interface_t *sw_interfaces;
847 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
848 uword *sw_if_index_by_sup_and_sub;
850 /* Software interface counters both simple and combined
851 packet and byte counters. */
852 volatile u32 *sw_if_counter_lock;
853 vlib_simple_counter_main_t *sw_if_counters;
854 vlib_combined_counter_main_t *combined_sw_if_counters;
856 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
858 /* pcap drop tracing */
859 int drop_pcap_enable;
860 pcap_main_t pcap_main;
862 u32 pcap_sw_if_index;
863 u32 pcap_pkts_to_capture;
864 uword *pcap_drop_filter_hash;
866 /* feature_arc_index */
867 u8 output_feature_arc_index;
868 } vnet_interface_main_t;
871 vnet_interface_counter_lock (vnet_interface_main_t * im)
873 if (im->sw_if_counter_lock)
874 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
879 vnet_interface_counter_unlock (vnet_interface_main_t * im)
881 if (im->sw_if_counter_lock)
882 *im->sw_if_counter_lock = 0;
885 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
887 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
889 #endif /* included_vnet_interface_h */
892 * fd.io coding-style-patch-verification: ON
895 * eval: (c-set-style "gnu")