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;
51 /* Interface up/down callback. */
52 typedef clib_error_t *(vnet_interface_function_t)
53 (struct vnet_main_t * vnm, u32 if_index, u32 flags);
55 /* Sub-interface add/del callback. */
56 typedef clib_error_t *(vnet_subif_add_del_function_t)
57 (struct vnet_main_t * vnm, u32 if_index,
58 struct vnet_sw_interface_t * template, int is_add);
60 /* Interface set mac address callback. */
61 typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
62 (struct vnet_hw_interface_t * hi, char *address);
64 typedef enum vnet_interface_function_priority_t_
66 VNET_ITF_FUNC_PRIORITY_LOW,
67 VNET_ITF_FUNC_PRIORITY_HIGH,
68 } vnet_interface_function_priority_t;
69 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
71 typedef struct _vnet_interface_function_list_elt
73 struct _vnet_interface_function_list_elt *next_interface_function;
74 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
75 } _vnet_interface_function_list_elt_t;
77 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
79 static void __vnet_interface_function_init_##tag##_##f (void) \
80 __attribute__((__constructor__)) ; \
82 static void __vnet_interface_function_init_##tag##_##f (void) \
84 vnet_main_t * vnm = vnet_get_main(); \
85 static _vnet_interface_function_list_elt_t init_function; \
86 init_function.next_interface_function = \
87 vnm->tag##_functions[VNET_ITF_FUNC_PRIORITY_LOW]; \
88 vnm->tag##_functions[VNET_ITF_FUNC_PRIORITY_LOW] = &init_function; \
89 init_function.fp = (void *) &f; \
92 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
94 static void __vnet_interface_function_init_##tag##_##f (void) \
95 __attribute__((__constructor__)) ; \
97 static void __vnet_interface_function_init_##tag##_##f (void) \
99 vnet_main_t * vnm = vnet_get_main(); \
100 static _vnet_interface_function_list_elt_t init_function; \
101 init_function.next_interface_function = vnm->tag##_functions[p]; \
102 vnm->tag##_functions[p] = &init_function; \
103 init_function.fp = (void *) &f; \
106 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
107 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
108 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
109 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
110 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
111 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
112 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
113 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
114 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
115 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
116 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
117 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
119 /* A class of hardware interface devices. */
120 typedef struct _vnet_device_class
122 /* Index into main vector. */
125 /* Device name (e.g. "FOOBAR 1234a"). */
128 /* Function to call when hardware interface is added/deleted. */
129 vnet_interface_function_t *interface_add_del_function;
131 /* Function to bring device administratively up/down. */
132 vnet_interface_function_t *admin_up_down_function;
134 /* Function to call when sub-interface is added/deleted */
135 vnet_subif_add_del_function_t *subif_add_del_function;
137 /* Redistribute flag changes/existence of this interface class. */
140 /* Transmit function. */
141 vlib_node_function_t *tx_function;
143 /* Error strings indexed by error code for this node. */
144 char **tx_function_error_strings;
146 /* Number of error codes used by this node. */
147 u32 tx_function_n_errors;
149 /* Renumber device name [only!] support, a control-plane kludge */
150 int (*name_renumber) (struct vnet_hw_interface_t * hi,
151 u32 new_dev_instance);
153 /* Format device instance as name. */
154 format_function_t *format_device_name;
156 /* Parse function for device name. */
157 unformat_function_t *unformat_device_name;
159 /* Format device verbosely for this class. */
160 format_function_t *format_device;
162 /* Trace buffer format for TX function. */
163 format_function_t *format_tx_trace;
165 /* Function to clear hardware counters for device. */
166 void (*clear_counters) (u32 dev_class_instance);
168 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
172 /* Called when hardware class of an interface changes. */
173 void (*hw_class_change) (struct vnet_main_t * vnm,
174 u32 hw_if_index, u32 new_hw_class_index);
176 /* Called to redirect traffic from a specific interface instance */
177 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
178 u32 hw_if_index, u32 node_index);
180 /* Link-list of all device classes set up by constructors created below */
181 struct _vnet_device_class *next_class_registration;
183 /* Splice vnet_interface_output_node into TX path */
184 u8 flatten_output_chains;
186 /* Function to set mac address. */
187 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
188 } vnet_device_class_t;
190 #define VNET_DEVICE_CLASS(x,...) \
191 __VA_ARGS__ vnet_device_class_t x; \
192 static void __vnet_add_device_class_registration_##x (void) \
193 __attribute__((__constructor__)) ; \
194 static void __vnet_add_device_class_registration_##x (void) \
196 vnet_main_t * vnm = vnet_get_main(); \
197 x.next_class_registration = vnm->device_class_registrations; \
198 vnm->device_class_registrations = &x; \
200 __VA_ARGS__ vnet_device_class_t x
202 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
204 __attribute__ ((flatten)) \
205 __attribute__ ((target (tgt))) \
207 fn ## _ ## arch ( vlib_main_t * vm, \
208 vlib_node_runtime_t * node, \
209 vlib_frame_t * frame) \
210 { return fn (vm, node, frame); }
212 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
213 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
216 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
217 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
219 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
220 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
221 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
222 static void __attribute__((__constructor__)) \
223 __vlib_device_tx_function_multiarch_select_##dev (void) \
224 { dev.tx_function = fn ## _multiarch_select(); }
228 * Link Type: A description of the protocol of packets on the link.
229 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
230 * it maps to the GRE-proto, etc for other lnk types.
232 typedef enum vnet_link_t_
244 } __attribute__ ((packed)) vnet_link_t;
246 #define VNET_LINKS { \
247 [VNET_LINK_ETHERNET] = "ethernet", \
248 [VNET_LINK_IP4] = "ipv4", \
249 [VNET_LINK_IP6] = "ipv6", \
250 [VNET_LINK_MPLS] = "mpls", \
251 [VNET_LINK_ARP] = "arp", \
252 [VNET_LINK_NSH] = "nsh", \
256 * @brief Number of link types. Not part of the enum so it does not have to be included in
259 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
262 * @brief Convert a link to to an Ethertype
264 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
267 * @brief Attributes assignable to a HW interface Class.
269 typedef enum vnet_hw_interface_class_flags_t_
272 * @brief a point 2 point interface
274 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
275 } vnet_hw_interface_class_flags_t;
277 /* Layer-2 (e.g. Ethernet) interface class. */
278 typedef struct _vnet_hw_interface_class
280 /* Index into main vector. */
283 /* Class name (e.g. "Ethernet"). */
287 vnet_hw_interface_class_flags_t flags;
289 /* Function to call when hardware interface is added/deleted. */
290 vnet_interface_function_t *interface_add_del_function;
292 /* Function to bring interface administratively up/down. */
293 vnet_interface_function_t *admin_up_down_function;
295 /* Function to call when link state changes. */
296 vnet_interface_function_t *link_up_down_function;
298 /* Function to call when link MAC changes. */
299 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
301 /* Format function to display interface name. */
302 format_function_t *format_interface_name;
304 /* Format function to display interface address. */
305 format_function_t *format_address;
307 /* Format packet header for this interface class. */
308 format_function_t *format_header;
310 /* Format device verbosely for this class. */
311 format_function_t *format_device;
313 /* Parser for hardware (e.g. ethernet) address. */
314 unformat_function_t *unformat_hw_address;
316 /* Parser for packet header for e.g. rewrite string. */
317 unformat_function_t *unformat_header;
319 /* Builds a rewrite string for the interface to the destination
320 * for the payload/link type. */
321 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
323 vnet_link_t link_type, const void *dst_hw_address);
325 /* Update an adjacecny added by FIB (as opposed to via the
326 * neighbour resolution protocol). */
327 void (*update_adjacency) (struct vnet_main_t * vnm,
328 u32 sw_if_index, u32 adj_index);
330 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
334 /* Called when hw interface class is changed and old hardware instance
335 may want to be deleted. */
336 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
337 u32 old_class_index, u32 new_class_index);
339 /* List of hw interface classes, built by constructors */
340 struct _vnet_hw_interface_class *next_class_registration;
342 } vnet_hw_interface_class_t;
345 * @brief Return a complete, zero-length (aka dummy) rewrite
347 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
349 vnet_link_t link_type,
350 const void *dst_hw_address);
353 * @brief Default adjacency update function
355 extern void default_update_adjacency (struct vnet_main_t *vnm,
356 u32 sw_if_index, u32 adj_index);
358 #define VNET_HW_INTERFACE_CLASS(x,...) \
359 __VA_ARGS__ vnet_hw_interface_class_t x; \
360 static void __vnet_add_hw_interface_class_registration_##x (void) \
361 __attribute__((__constructor__)) ; \
362 static void __vnet_add_hw_interface_class_registration_##x (void) \
364 vnet_main_t * vnm = vnet_get_main(); \
365 x.next_class_registration = vnm->hw_interface_class_registrations; \
366 vnm->hw_interface_class_registrations = &x; \
368 __VA_ARGS__ vnet_hw_interface_class_t x
370 /* Hardware-interface. This corresponds to a physical wire
371 that packets flow over. */
372 typedef struct vnet_hw_interface_t
374 /* Interface name. */
378 /* Hardware link state is up. */
379 #define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
380 /* Hardware duplex state */
381 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
382 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
383 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
384 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
385 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
386 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
388 /* Hardware link speed */
389 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
390 #define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
391 #define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
392 #define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
393 #define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 6)
394 #define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 7)
395 #define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 8)
396 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
397 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
398 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
399 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
400 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
401 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
402 VNET_HW_INTERFACE_FLAG_SPEED_100G)
404 /* l2output node flags */
405 #define VNET_HW_INTERFACE_FLAG_L2OUTPUT_SHIFT 9
406 #define VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED (1 << 9)
408 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
409 address for this class (e.g. PPP). */
412 /* Interface is up as far as software is concerned. */
413 /* NAME.{output,tx} nodes for this interface. */
414 u32 output_node_index, tx_node_index;
416 /* (dev_class, dev_instance) uniquely identifies hw interface. */
420 /* (hw_class, hw_instance) uniquely identifies hw interface. */
424 /* Hardware index for this hardware interface. */
427 /* Software index for this hardware interface. */
430 /* Maximum transmit rate for this interface in bits/sec. */
431 f64 max_rate_bits_per_sec;
433 /* Smallest packet size supported by this interface. */
434 u32 min_supported_packet_bytes;
436 /* Largest packet size supported by this interface. */
437 u32 max_supported_packet_bytes;
439 /* Smallest packet size for this interface. */
440 u32 min_packet_bytes;
442 /* Largest packet size for this interface. */
443 u32 max_packet_bytes;
445 /* Number of extra bytes that go on the wire.
446 Packet length on wire
447 = max (length + per_packet_overhead_bytes, min_packet_bytes). */
448 u32 per_packet_overhead_bytes;
450 /* Receive and transmit layer 3 packet size limits (MRU/MTU). */
451 u32 max_l3_packet_bytes[VLIB_N_RX_TX];
453 /* Hash table mapping sub interface id to sw_if_index. */
454 uword *sub_interface_sw_if_index_by_id;
456 /* Count of number of L2 subinterfaces */
459 /* Bonded interface info -
460 0 - not a bonded interface nor a slave
461 ~0 - slave to a bonded interface
462 others - A bonded interface with a pointer to bitmap for all slaves */
464 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
465 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
467 } vnet_hw_interface_t;
469 extern vnet_device_class_t vnet_local_interface_device_class;
473 /* A hw interface. */
474 VNET_SW_INTERFACE_TYPE_HARDWARE,
476 /* A sub-interface. */
477 VNET_SW_INTERFACE_TYPE_SUB,
478 } vnet_sw_interface_type_t;
483 * Subinterface ID. A number 0-N to uniquely identify
484 * this subinterface under the main (parent?) interface
488 /* Classification data. Used to associate packet header with subinterface. */
501 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
504 u16 outer_vlan_id_any:1;
505 u16 inner_vlan_id_any:1;
509 } vnet_sub_interface_t;
514 VNET_FLOOD_CLASS_NORMAL,
515 VNET_FLOOD_CLASS_TUNNEL_MASTER,
516 /* Does not flood when tunnel master is in the same L2 BD */
517 VNET_FLOOD_CLASS_TUNNEL_NORMAL
518 } vnet_flood_class_t;
520 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
521 tunnel, etc. Configuration (e.g. IP address) gets attached to
522 software interface. */
525 vnet_sw_interface_type_t type:16;
528 /* Interface is "up" meaning adminstratively up.
529 Up in the sense of link state being up is maintained by hardware interface. */
530 #define VNET_SW_INTERFACE_FLAG_ADMIN_UP (1 << 0)
532 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
533 #define VNET_SW_INTERFACE_FLAG_PUNT (1 << 1)
535 #define VNET_SW_INTERFACE_FLAG_PROXY_ARP (1 << 2)
537 #define VNET_SW_INTERFACE_FLAG_UNNUMBERED (1 << 3)
539 #define VNET_SW_INTERFACE_FLAG_BOND_SLAVE (1 << 4)
541 /* Interface does not appear in CLI/API */
542 #define VNET_SW_INTERFACE_FLAG_HIDDEN (1 << 5)
544 /* Index for this interface. */
547 /* Software interface index of super-interface;
548 equal to sw_if_index if this interface is not a
552 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
553 u32 unnumbered_sw_if_index;
559 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
562 /* VNET_SW_INTERFACE_TYPE_SUB. */
563 vnet_sub_interface_t sub;
566 vnet_flood_class_t flood_class;
567 } vnet_sw_interface_t;
571 /* Simple counters. */
572 VNET_INTERFACE_COUNTER_DROP = 0,
573 VNET_INTERFACE_COUNTER_PUNT = 1,
574 VNET_INTERFACE_COUNTER_IP4 = 2,
575 VNET_INTERFACE_COUNTER_IP6 = 3,
576 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
577 VNET_INTERFACE_COUNTER_RX_MISS = 5,
578 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
579 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
580 VNET_INTERFACE_COUNTER_MPLS = 8,
581 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
582 /* Combined counters. */
583 VNET_INTERFACE_COUNTER_RX = 0,
584 VNET_INTERFACE_COUNTER_TX = 1,
585 VNET_N_COMBINED_INTERFACE_COUNTER = 2,
586 } vnet_interface_counter_type_t;
590 u32 output_node_index;
592 } vnet_hw_interface_nodes_t;
596 /* Hardware interfaces. */
597 vnet_hw_interface_t *hw_interfaces;
599 /* Hash table mapping HW interface name to index. */
600 uword *hw_interface_by_name;
602 /* Vectors if hardware interface classes and device classes. */
603 vnet_hw_interface_class_t *hw_interface_classes;
604 vnet_device_class_t *device_classes;
606 /* Hash table mapping name to hw interface/device class. */
607 uword *hw_interface_class_by_name;
608 uword *device_class_by_name;
610 /* Software interfaces. */
611 vnet_sw_interface_t *sw_interfaces;
613 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
614 uword *sw_if_index_by_sup_and_sub;
616 /* Software interface counters both simple and combined
617 packet and byte counters. */
618 volatile u32 *sw_if_counter_lock;
619 vlib_simple_counter_main_t *sw_if_counters;
620 vlib_combined_counter_main_t *combined_sw_if_counters;
622 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
624 /* pcap drop tracing */
625 int drop_pcap_enable;
626 pcap_main_t pcap_main;
628 u32 pcap_sw_if_index;
629 u32 pcap_pkts_to_capture;
630 uword *pcap_drop_filter_hash;
632 /* feature_arc_index */
633 u8 output_feature_arc_index;
634 } vnet_interface_main_t;
637 vnet_interface_counter_lock (vnet_interface_main_t * im)
639 if (im->sw_if_counter_lock)
640 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
645 vnet_interface_counter_unlock (vnet_interface_main_t * im)
647 if (im->sw_if_counter_lock)
648 *im->sw_if_counter_lock = 0;
651 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
653 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
655 #endif /* included_vnet_interface_h */
658 * fd.io coding-style-patch-verification: ON
661 * eval: (c-set-style "gnu")