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,
73 const u8 * old_address, const u8 * new_address);
75 /* Interface set rx mode callback. */
76 typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
77 (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
78 vnet_hw_interface_rx_mode mode);
80 /* Interface set l2 mode callback. */
81 typedef clib_error_t *(vnet_interface_set_l2_mode_function_t)
82 (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
87 VNET_FLOW_DEV_OP_ADD_FLOW,
88 VNET_FLOW_DEV_OP_DEL_FLOW,
89 VNET_FLOW_DEV_OP_GET_COUNTER,
90 VNET_FLOW_DEV_OP_RESET_COUNTER,
93 /* Interface flow opeations callback. */
94 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
95 vnet_flow_dev_op_t op,
96 u32 hw_if_index, u32 index,
97 uword * private_data);
99 typedef enum vnet_interface_function_priority_t_
101 VNET_ITF_FUNC_PRIORITY_LOW,
102 VNET_ITF_FUNC_PRIORITY_HIGH,
103 } vnet_interface_function_priority_t;
104 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
106 typedef struct _vnet_interface_function_list_elt
108 struct _vnet_interface_function_list_elt *next_interface_function;
109 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
110 } _vnet_interface_function_list_elt_t;
112 #ifndef CLIB_MARCH_VARIANT
113 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
115 static void __vnet_interface_function_init_##tag##_##f (void) \
116 __attribute__((__constructor__)) ; \
118 static void __vnet_interface_function_init_##tag##_##f (void) \
120 vnet_main_t * vnm = vnet_get_main(); \
121 static _vnet_interface_function_list_elt_t init_function; \
122 init_function.next_interface_function = vnm->tag##_functions[p]; \
123 vnm->tag##_functions[p] = &init_function; \
124 init_function.fp = (void *) &f; \
126 static void __vnet_interface_function_deinit_##tag##_##f (void) \
127 __attribute__((__destructor__)) ; \
129 static void __vnet_interface_function_deinit_##tag##_##f (void) \
131 vnet_main_t * vnm = vnet_get_main(); \
132 _vnet_interface_function_list_elt_t *next; \
133 if (vnm->tag##_functions[p]->fp == (void *) &f) \
135 vnm->tag##_functions[p] = \
136 vnm->tag##_functions[p]->next_interface_function; \
139 next = vnm->tag##_functions[p]; \
140 while (next->next_interface_function) \
142 if (next->next_interface_function->fp == (void *) &f) \
144 next->next_interface_function = \
145 next->next_interface_function->next_interface_function; \
148 next = next->next_interface_function; \
152 /* create unused pointer to silence compiler warnings and get whole
153 function optimized out */
154 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
155 static __clib_unused void * __clib_unused_##f = f;
158 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
159 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
161 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
162 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
163 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
164 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
165 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
166 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
167 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
168 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
169 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
170 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
171 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
172 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
173 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
174 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
176 /* A class of hardware interface devices. */
177 typedef struct _vnet_device_class
179 /* Index into main vector. */
182 /* Device name (e.g. "FOOBAR 1234a"). */
185 /* Function to call when hardware interface is added/deleted. */
186 vnet_interface_function_t *interface_add_del_function;
188 /* Function to bring device administratively up/down. */
189 vnet_interface_function_t *admin_up_down_function;
191 /* Function to call when sub-interface is added/deleted */
192 vnet_subif_add_del_function_t *subif_add_del_function;
194 /* Function to call interface rx mode is changed */
195 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
197 /* Function to call interface l2 mode is changed */
198 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
200 /* Redistribute flag changes/existence of this interface class. */
203 /* Transmit function. */
204 vlib_node_function_t *tx_function;
206 /* Transmit function candidate registration with priority */
207 vlib_node_fn_registration_t *tx_fn_registrations;
209 /* Error strings indexed by error code for this node. */
210 char **tx_function_error_strings;
212 /* Number of error codes used by this node. */
213 u32 tx_function_n_errors;
215 /* Renumber device name [only!] support, a control-plane kludge */
216 int (*name_renumber) (struct vnet_hw_interface_t * hi,
217 u32 new_dev_instance);
219 /* Interface flow offload operations */
220 vnet_flow_dev_ops_function_t *flow_ops_function;
222 /* Format device instance as name. */
223 format_function_t *format_device_name;
225 /* Parse function for device name. */
226 unformat_function_t *unformat_device_name;
228 /* Format device verbosely for this class. */
229 format_function_t *format_device;
231 /* Trace buffer format for TX function. */
232 format_function_t *format_tx_trace;
234 /* Format flow offload entry */
235 format_function_t *format_flow;
237 /* Function to clear hardware counters for device. */
238 void (*clear_counters) (u32 dev_class_instance);
240 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
244 /* Called when hardware class of an interface changes. */
245 void (*hw_class_change) (struct vnet_main_t * vnm,
246 u32 hw_if_index, u32 new_hw_class_index);
248 /* Called to redirect traffic from a specific interface instance */
249 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
250 u32 hw_if_index, u32 node_index);
252 /* Link-list of all device classes set up by constructors created below */
253 struct _vnet_device_class *next_class_registration;
255 /* Function to set mac address. */
256 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
257 } vnet_device_class_t;
259 #ifndef CLIB_MARCH_VARIANT
260 #define VNET_DEVICE_CLASS(x,...) \
261 __VA_ARGS__ vnet_device_class_t x; \
262 static void __vnet_add_device_class_registration_##x (void) \
263 __attribute__((__constructor__)) ; \
264 static void __vnet_add_device_class_registration_##x (void) \
266 vnet_main_t * vnm = vnet_get_main(); \
267 x.next_class_registration = vnm->device_class_registrations; \
268 vnm->device_class_registrations = &x; \
270 static void __vnet_rm_device_class_registration_##x (void) \
271 __attribute__((__destructor__)) ; \
272 static void __vnet_rm_device_class_registration_##x (void) \
274 vnet_main_t * vnm = vnet_get_main(); \
275 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
276 &x, next_class_registration); \
278 __VA_ARGS__ vnet_device_class_t x
280 /* create unused pointer to silence compiler warnings and get whole
281 function optimized out */
282 #define VNET_DEVICE_CLASS(x,...) \
283 static __clib_unused vnet_device_class_t __clib_unused_##x
286 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
287 uword CLIB_MARCH_SFX (devclass##_tx_fn)(); \
288 static vlib_node_fn_registration_t \
289 CLIB_MARCH_SFX(devclass##_tx_fn_registration) = \
290 { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), }; \
292 static void __clib_constructor \
293 CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void) \
295 extern vnet_device_class_t devclass; \
296 vlib_node_fn_registration_t *r; \
297 r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
298 r->priority = CLIB_MARCH_FN_PRIORITY(); \
299 r->next_registration = devclass.tx_fn_registrations; \
300 devclass.tx_fn_registrations = r; \
302 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
304 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
306 __attribute__ ((flatten)) \
307 __attribute__ ((target (tgt))) \
309 fn ## _ ## arch ( vlib_main_t * vm, \
310 vlib_node_runtime_t * node, \
311 vlib_frame_t * frame) \
312 { return fn (vm, node, frame); }
314 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
315 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
318 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
319 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
321 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
322 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
323 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
324 static void __attribute__((__constructor__)) \
325 __vlib_device_tx_function_multiarch_select_##dev (void) \
326 { dev.tx_function = fn ## _multiarch_select(); }
330 * Link Type: A description of the protocol of packets on the link.
331 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
332 * it maps to the GRE-proto, etc for other lnk types.
334 typedef enum vnet_link_t_
346 } __attribute__ ((packed)) vnet_link_t;
348 #define VNET_LINKS { \
349 [VNET_LINK_ETHERNET] = "ethernet", \
350 [VNET_LINK_IP4] = "ipv4", \
351 [VNET_LINK_IP6] = "ipv6", \
352 [VNET_LINK_MPLS] = "mpls", \
353 [VNET_LINK_ARP] = "arp", \
354 [VNET_LINK_NSH] = "nsh", \
357 #define FOR_EACH_VNET_LINK(_link) \
358 for (_link = VNET_LINK_IP4; \
359 _link <= VNET_LINK_NSH; \
363 * @brief Number of link types. Not part of the enum so it does not have to be included in
366 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
369 * @brief Convert a link to to an Ethertype
371 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
374 * @brief Attributes assignable to a HW interface Class.
376 typedef enum vnet_hw_interface_class_flags_t_
379 * @brief a point 2 point interface
381 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
382 } vnet_hw_interface_class_flags_t;
384 /* Layer-2 (e.g. Ethernet) interface class. */
385 typedef struct _vnet_hw_interface_class
387 /* Index into main vector. */
390 /* Class name (e.g. "Ethernet"). */
394 vnet_hw_interface_class_flags_t flags;
396 /* Function to call when hardware interface is added/deleted. */
397 vnet_interface_function_t *interface_add_del_function;
399 /* Function to bring interface administratively up/down. */
400 vnet_interface_function_t *admin_up_down_function;
402 /* Function to call when link state changes. */
403 vnet_interface_function_t *link_up_down_function;
405 /* Function to call when link MAC changes. */
406 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
408 /* Format function to display interface name. */
409 format_function_t *format_interface_name;
411 /* Format function to display interface address. */
412 format_function_t *format_address;
414 /* Format packet header for this interface class. */
415 format_function_t *format_header;
417 /* Format device verbosely for this class. */
418 format_function_t *format_device;
420 /* Parser for hardware (e.g. ethernet) address. */
421 unformat_function_t *unformat_hw_address;
423 /* Parser for packet header for e.g. rewrite string. */
424 unformat_function_t *unformat_header;
426 /* Builds a rewrite string for the interface to the destination
427 * for the payload/link type. */
428 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
430 vnet_link_t link_type, const void *dst_hw_address);
432 /* Update an adjacecny added by FIB (as opposed to via the
433 * neighbour resolution protocol). */
434 void (*update_adjacency) (struct vnet_main_t * vnm,
435 u32 sw_if_index, u32 adj_index);
437 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
441 /* Called when hw interface class is changed and old hardware instance
442 may want to be deleted. */
443 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
444 u32 old_class_index, u32 new_class_index);
446 /* List of hw interface classes, built by constructors */
447 struct _vnet_hw_interface_class *next_class_registration;
449 } vnet_hw_interface_class_t;
452 * @brief Return a complete, zero-length (aka dummy) rewrite
454 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
456 vnet_link_t link_type,
457 const void *dst_hw_address);
460 * @brief Default adjacency update function
462 extern void default_update_adjacency (struct vnet_main_t *vnm,
463 u32 sw_if_index, u32 adj_index);
465 #define VNET_HW_INTERFACE_CLASS(x,...) \
466 __VA_ARGS__ vnet_hw_interface_class_t x; \
467 static void __vnet_add_hw_interface_class_registration_##x (void) \
468 __attribute__((__constructor__)) ; \
469 static void __vnet_add_hw_interface_class_registration_##x (void) \
471 vnet_main_t * vnm = vnet_get_main(); \
472 x.next_class_registration = vnm->hw_interface_class_registrations; \
473 vnm->hw_interface_class_registrations = &x; \
475 static void __vnet_rm_hw_interface_class_registration_##x (void) \
476 __attribute__((__destructor__)) ; \
477 static void __vnet_rm_hw_interface_class_registration_##x (void) \
479 vnet_main_t * vnm = vnet_get_main(); \
480 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
481 &x, next_class_registration); \
483 __VA_ARGS__ vnet_hw_interface_class_t x
485 /* Hardware-interface. This corresponds to a physical wire
486 that packets flow over. */
487 typedef struct vnet_hw_interface_t
489 /* Interface name. */
493 /* Hardware link state is up. */
494 #define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
495 /* Hardware duplex state */
496 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
497 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
498 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
499 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
500 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
501 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
503 /* Hardware link speed */
504 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
505 #define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
506 #define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
507 #define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
508 #define VNET_HW_INTERFACE_FLAG_SPEED_2_5G (1 << 6)
509 #define VNET_HW_INTERFACE_FLAG_SPEED_5G (1 << 7)
510 #define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 8)
511 #define VNET_HW_INTERFACE_FLAG_SPEED_20G (1 << 9)
512 #define VNET_HW_INTERFACE_FLAG_SPEED_25G (1 << 10)
513 #define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 11)
514 #define VNET_HW_INTERFACE_FLAG_SPEED_50G (1 << 12)
515 #define VNET_HW_INTERFACE_FLAG_SPEED_56G (1 << 13)
516 #define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 14)
517 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
518 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
519 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
520 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
521 VNET_HW_INTERFACE_FLAG_SPEED_2_5G | \
522 VNET_HW_INTERFACE_FLAG_SPEED_5G | \
523 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
524 VNET_HW_INTERFACE_FLAG_SPEED_20G | \
525 VNET_HW_INTERFACE_FLAG_SPEED_25G | \
526 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
527 VNET_HW_INTERFACE_FLAG_SPEED_50G | \
528 VNET_HW_INTERFACE_FLAG_SPEED_56G | \
529 VNET_HW_INTERFACE_FLAG_SPEED_100G)
532 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE (1 << 16)
534 /* tx checksum offload */
535 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD (1 << 17)
537 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
538 address for this class (e.g. PPP). */
541 /* Interface is up as far as software is concerned. */
542 /* NAME.{output,tx} nodes for this interface. */
543 u32 output_node_index, tx_node_index;
545 /* (dev_class, dev_instance) uniquely identifies hw interface. */
549 /* (hw_class, hw_instance) uniquely identifies hw interface. */
553 /* Hardware index for this hardware interface. */
556 /* Software index for this hardware interface. */
559 /* Next index in interface-output node for this interface
560 used by node function vnet_per_buffer_interface_output() */
561 u32 output_node_next_index;
563 /* Maximum transmit rate for this interface in bits/sec. */
564 f64 max_rate_bits_per_sec;
566 /* Smallest packet size supported by this interface. */
567 u32 min_supported_packet_bytes;
569 /* Largest packet size supported by this interface. */
570 u32 max_supported_packet_bytes;
572 /* Smallest packet size for this interface. */
573 u32 min_packet_bytes;
575 /* Largest packet size for this interface. */
576 u32 max_packet_bytes;
578 /* Hash table mapping sub interface id to sw_if_index. */
579 uword *sub_interface_sw_if_index_by_id;
581 /* Count of number of L2 subinterfaces */
584 /* Bonded interface info -
585 0 - not a bonded interface nor a slave
586 ~0 - slave to a bonded interface
587 others - A bonded interface with a pointer to bitmap for all slaves */
589 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
590 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
593 u32 input_node_index;
595 /* input node cpu index by queue */
596 u32 *input_node_thread_index_by_queue;
598 /* vnet_hw_interface_rx_mode by queue */
599 u8 *rx_mode_by_queue;
600 vnet_hw_interface_rx_mode default_rx_mode;
602 /* device input device_and_queue runtime index */
603 uword *dq_runtime_index_by_queue;
605 } vnet_hw_interface_t;
607 extern vnet_device_class_t vnet_local_interface_device_class;
611 /* A hw interface. */
612 VNET_SW_INTERFACE_TYPE_HARDWARE,
614 /* A sub-interface. */
615 VNET_SW_INTERFACE_TYPE_SUB,
616 VNET_SW_INTERFACE_TYPE_P2P,
617 VNET_SW_INTERFACE_TYPE_PIPE,
618 } vnet_sw_interface_type_t;
623 * Subinterface ID. A number 0-N to uniquely identify
624 * this subinterface under the main (parent?) interface
628 /* Classification data. Used to associate packet header with subinterface. */
641 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
644 u16 outer_vlan_id_any:1;
645 u16 inner_vlan_id_any:1;
649 } vnet_sub_interface_t;
654 * Subinterface ID. A number 0-N to uniquely identify
655 * this subinterface under the main interface
660 } vnet_p2p_sub_interface_t;
664 /* THe BVI interface */
665 VNET_FLOOD_CLASS_BVI,
667 VNET_FLOOD_CLASS_NORMAL,
668 VNET_FLOOD_CLASS_TUNNEL_MASTER,
669 /* Does not flood when tunnel master is in the same L2 BD */
670 VNET_FLOOD_CLASS_TUNNEL_NORMAL,
671 /* Never flood to this type */
672 VNET_FLOOD_CLASS_NO_FLOOD,
673 } vnet_flood_class_t;
675 /* Per protocol MTU */
678 VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
679 VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
685 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
687 typedef enum vnet_sw_interface_flags_t_
689 /* Interface is "up" meaning adminstratively up.
690 Up in the sense of link state being up is maintained by hardware interface. */
691 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
693 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
694 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
696 VNET_SW_INTERFACE_FLAG_PROXY_ARP = (1 << 2),
698 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
700 VNET_SW_INTERFACE_FLAG_BOND_SLAVE = (1 << 4),
702 /* Interface does not appear in CLI/API */
703 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
705 /* Interface in ERROR state */
706 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
708 /* Interface has IP configured directed broadcast */
709 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
711 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
713 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
714 tunnel, etc. Configuration (e.g. IP address) gets attached to
715 software interface. */
718 vnet_sw_interface_type_t type:16;
720 vnet_sw_interface_flags_t flags;
722 /* Index for this interface. */
725 /* Software interface index of super-interface;
726 equal to sw_if_index if this interface is not a
730 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
731 u32 unnumbered_sw_if_index;
735 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
738 /* MTU for network layer (not including L2 headers) */
741 /* VNET_SW_INTERFACE_TYPE_SUB. */
742 vnet_sub_interface_t sub;
744 /* VNET_SW_INTERFACE_TYPE_P2P. */
745 vnet_p2p_sub_interface_t p2p;
747 vnet_flood_class_t flood_class;
748 } vnet_sw_interface_t;
752 /* Simple counters. */
753 VNET_INTERFACE_COUNTER_DROP = 0,
754 VNET_INTERFACE_COUNTER_PUNT = 1,
755 VNET_INTERFACE_COUNTER_IP4 = 2,
756 VNET_INTERFACE_COUNTER_IP6 = 3,
757 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
758 VNET_INTERFACE_COUNTER_RX_MISS = 5,
759 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
760 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
761 VNET_INTERFACE_COUNTER_MPLS = 8,
762 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
763 /* Combined counters. */
764 VNET_INTERFACE_COUNTER_RX = 0,
765 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
766 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
767 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
768 VNET_INTERFACE_COUNTER_TX = 4,
769 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
770 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
771 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
772 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
773 } vnet_interface_counter_type_t;
775 #define foreach_rx_combined_interface_counter(_x) \
776 for (_x = VNET_INTERFACE_COUNTER_RX; \
777 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
780 #define foreach_tx_combined_interface_counter(_x) \
781 for (_x = VNET_INTERFACE_COUNTER_TX; \
782 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
785 #define foreach_simple_interface_counter_name \
790 _(RX_NO_BUF, rx-no-buf, if) \
791 _(RX_MISS, rx-miss, if) \
792 _(RX_ERROR, rx-error, if) \
793 _(TX_ERROR, tx-error, if)
795 #define foreach_combined_interface_counter_name \
797 _(RX_UNICAST, rx-unicast, if) \
798 _(RX_MULTICAST, rx-multicast, if) \
799 _(RX_BROADCAST, rx-broadcast, if) \
801 _(TX_UNICAST, tx-unicast-miss, if) \
802 _(TX_MULTICAST, tx-multicast, if) \
803 _(TX_BROADCAST, tx-broadcast, if)
807 COLLECT_SIMPLE_STATS = 0,
808 COLLECT_DETAILED_STATS = 1,
809 } vnet_interface_stats_collection_mode_e;
811 extern int collect_detailed_interface_stats_flag;
814 collect_detailed_interface_stats (void)
816 return collect_detailed_interface_stats_flag;
819 void collect_detailed_interface_stats_flag_set (void);
820 void collect_detailed_interface_stats_flag_clear (void);
825 u32 output_node_index;
827 } vnet_hw_interface_nodes_t;
831 /* Hardware interfaces. */
832 vnet_hw_interface_t *hw_interfaces;
834 /* Hash table mapping HW interface name to index. */
835 uword *hw_interface_by_name;
837 /* Vectors if hardware interface classes and device classes. */
838 vnet_hw_interface_class_t *hw_interface_classes;
839 vnet_device_class_t *device_classes;
841 /* Hash table mapping name to hw interface/device class. */
842 uword *hw_interface_class_by_name;
843 uword *device_class_by_name;
845 /* Software interfaces. */
846 vnet_sw_interface_t *sw_interfaces;
848 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
849 uword *sw_if_index_by_sup_and_sub;
851 /* Software interface counters both simple and combined
852 packet and byte counters. */
853 volatile u32 *sw_if_counter_lock;
854 vlib_simple_counter_main_t *sw_if_counters;
855 vlib_combined_counter_main_t *combined_sw_if_counters;
857 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
859 /* pcap drop tracing */
860 int drop_pcap_enable;
861 pcap_main_t pcap_main;
863 u32 pcap_sw_if_index;
864 u32 pcap_pkts_to_capture;
865 uword *pcap_drop_filter_hash;
867 /* feature_arc_index */
868 u8 output_feature_arc_index;
869 } vnet_interface_main_t;
872 vnet_interface_counter_lock (vnet_interface_main_t * im)
874 if (im->sw_if_counter_lock)
875 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
880 vnet_interface_counter_unlock (vnet_interface_main_t * im)
882 if (im->sw_if_counter_lock)
883 *im->sw_if_counter_lock = 0;
886 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
888 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
890 #endif /* included_vnet_interface_h */
893 * fd.io coding-style-patch-verification: ON
896 * eval: (c-set-style "gnu")