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 struct _vnet_interface_function_list_elt
66 struct _vnet_interface_function_list_elt *next_interface_function;
67 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
68 } _vnet_interface_function_list_elt_t;
70 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
72 static void __vnet_interface_function_init_##tag##_##f (void) \
73 __attribute__((__constructor__)) ; \
75 static void __vnet_interface_function_init_##tag##_##f (void) \
77 vnet_main_t * vnm = vnet_get_main(); \
78 static _vnet_interface_function_list_elt_t init_function; \
79 init_function.next_interface_function = vnm->tag##_functions; \
80 vnm->tag##_functions = &init_function; \
81 init_function.fp = (void *) &f; \
84 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
85 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
86 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
87 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
88 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
89 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
90 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
91 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
93 /* A class of hardware interface devices. */
94 typedef struct _vnet_device_class
96 /* Index into main vector. */
99 /* Device name (e.g. "FOOBAR 1234a"). */
102 /* Function to call when hardware interface is added/deleted. */
103 vnet_interface_function_t *interface_add_del_function;
105 /* Function to bring device administratively up/down. */
106 vnet_interface_function_t *admin_up_down_function;
108 /* Function to call when sub-interface is added/deleted */
109 vnet_subif_add_del_function_t *subif_add_del_function;
111 /* Redistribute flag changes/existence of this interface class. */
114 /* Transmit function. */
115 vlib_node_function_t *tx_function;
117 /* Error strings indexed by error code for this node. */
118 char **tx_function_error_strings;
120 /* Number of error codes used by this node. */
121 u32 tx_function_n_errors;
123 /* Renumber device name [only!] support, a control-plane kludge */
124 int (*name_renumber) (struct vnet_hw_interface_t * hi,
125 u32 new_dev_instance);
127 /* Format device instance as name. */
128 format_function_t *format_device_name;
130 /* Parse function for device name. */
131 unformat_function_t *unformat_device_name;
133 /* Format device verbosely for this class. */
134 format_function_t *format_device;
136 /* Trace buffer format for TX function. */
137 format_function_t *format_tx_trace;
139 /* Function to clear hardware counters for device. */
140 void (*clear_counters) (u32 dev_class_instance);
142 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
146 /* Called when hardware class of an interface changes. */
147 void (*hw_class_change) (struct vnet_main_t * vnm,
148 u32 hw_if_index, u32 new_hw_class_index);
150 /* Called to redirect traffic from a specific interface instance */
151 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
152 u32 hw_if_index, u32 node_index);
154 /* Link-list of all device classes set up by constructors created below */
155 struct _vnet_device_class *next_class_registration;
157 /* Do not splice vnet_interface_output_node into TX path */
158 u8 no_flatten_output_chains;
160 /* Function to set mac address. */
161 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
162 } vnet_device_class_t;
164 #define VNET_DEVICE_CLASS(x,...) \
165 __VA_ARGS__ vnet_device_class_t x; \
166 static void __vnet_add_device_class_registration_##x (void) \
167 __attribute__((__constructor__)) ; \
168 static void __vnet_add_device_class_registration_##x (void) \
170 vnet_main_t * vnm = vnet_get_main(); \
171 x.next_class_registration = vnm->device_class_registrations; \
172 vnm->device_class_registrations = &x; \
174 __VA_ARGS__ vnet_device_class_t x
176 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
178 __attribute__ ((flatten)) \
179 __attribute__ ((target (tgt))) \
181 fn ## _ ## arch ( vlib_main_t * vm, \
182 vlib_node_runtime_t * node, \
183 vlib_frame_t * frame) \
184 { return fn (vm, node, frame); }
186 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
187 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
190 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
191 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
193 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
194 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
195 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
196 static void __attribute__((__constructor__)) \
197 __vlib_device_tx_function_multiarch_select_##dev (void) \
198 { dev.tx_function = fn ## _multiarch_select(); }
202 * Link Type: A description of the protocol of packets on the link.
203 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
204 * it maps to the GRE-proto, etc for other lnk types.
206 typedef enum vnet_link_t_
217 } __attribute__ ((packed)) vnet_link_t;
219 #define VNET_LINKS { \
220 [VNET_LINK_ETHERNET] = "ethernet", \
221 [VNET_LINK_IP4] = "ipv4", \
222 [VNET_LINK_IP6] = "ipv6", \
223 [VNET_LINK_MPLS] = "mpls", \
224 [VNET_LINK_ARP] = "arp", \
228 * @brief Number of link types. Not part of the enum so it does not have to be included in
231 #define VNET_LINK_NUM (VNET_LINK_ARP+1)
234 * @brief Convert a link to to an Ethertype
236 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
239 * @brief Attributes assignable to a HW interface Class.
241 typedef enum vnet_hw_interface_class_flags_t_
244 * @brief a point 2 point interface
246 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
247 } vnet_hw_interface_class_flags_t;
249 /* Layer-2 (e.g. Ethernet) interface class. */
250 typedef struct _vnet_hw_interface_class
252 /* Index into main vector. */
255 /* Class name (e.g. "Ethernet"). */
259 vnet_hw_interface_class_flags_t flags;
261 /* Function to call when hardware interface is added/deleted. */
262 vnet_interface_function_t *interface_add_del_function;
264 /* Function to bring interface administratively up/down. */
265 vnet_interface_function_t *admin_up_down_function;
267 /* Function to call when link state changes. */
268 vnet_interface_function_t *link_up_down_function;
270 /* Format function to display interface name. */
271 format_function_t *format_interface_name;
273 /* Format function to display interface address. */
274 format_function_t *format_address;
276 /* Format packet header for this interface class. */
277 format_function_t *format_header;
279 /* Format device verbosely for this class. */
280 format_function_t *format_device;
282 /* Parser for hardware (e.g. ethernet) address. */
283 unformat_function_t *unformat_hw_address;
285 /* Parser for packet header for e.g. rewrite string. */
286 unformat_function_t *unformat_header;
288 /* Builds a rewrite string for the interface to the destination
289 * for the payload/link type. */
290 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
292 vnet_link_t link_type, const void *dst_hw_address);
294 /* Update an adjacecny added by FIB (as opposed to via the
295 * neighbour resolution protocol). */
296 void (*update_adjacency) (struct vnet_main_t * vnm,
297 u32 sw_if_index, u32 adj_index);
299 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
303 /* Called when hw interface class is changed and old hardware instance
304 may want to be deleted. */
305 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
306 u32 old_class_index, u32 new_class_index);
308 /* List of hw interface classes, built by constructors */
309 struct _vnet_hw_interface_class *next_class_registration;
311 } vnet_hw_interface_class_t;
314 * @brief Return a complete, zero-length (aka dummy) rewrite
316 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
318 vnet_link_t link_type,
319 const void *dst_hw_address);
322 * @brief Default adjacency update function
324 extern void default_update_adjacency (struct vnet_main_t *vnm,
325 u32 sw_if_index, u32 adj_index);
327 #define VNET_HW_INTERFACE_CLASS(x,...) \
328 __VA_ARGS__ vnet_hw_interface_class_t x; \
329 static void __vnet_add_hw_interface_class_registration_##x (void) \
330 __attribute__((__constructor__)) ; \
331 static void __vnet_add_hw_interface_class_registration_##x (void) \
333 vnet_main_t * vnm = vnet_get_main(); \
334 x.next_class_registration = vnm->hw_interface_class_registrations; \
335 vnm->hw_interface_class_registrations = &x; \
337 __VA_ARGS__ vnet_hw_interface_class_t x
339 /* Hardware-interface. This corresponds to a physical wire
340 that packets flow over. */
341 typedef struct vnet_hw_interface_t
343 /* Interface name. */
347 /* Hardware link state is up. */
348 #define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
349 /* Hardware duplex state */
350 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
351 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
352 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
353 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
354 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
355 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
357 /* Hardware link speed */
358 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
359 #define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
360 #define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
361 #define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
362 #define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 6)
363 #define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 7)
364 #define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 8)
365 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
366 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
367 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
368 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
369 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
370 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
371 VNET_HW_INTERFACE_FLAG_SPEED_100G)
373 /* l2output node flags */
374 #define VNET_HW_INTERFACE_FLAG_L2OUTPUT_SHIFT 9
375 #define VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED (1 << 9)
377 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
378 address for this class (e.g. PPP). */
381 /* Interface is up as far as software is concerned. */
382 /* NAME.{output,tx} nodes for this interface. */
383 u32 output_node_index, tx_node_index;
385 /* (dev_class, dev_instance) uniquely identifies hw interface. */
389 /* (hw_class, hw_instance) uniquely identifies hw interface. */
393 /* Hardware index for this hardware interface. */
396 /* Software index for this hardware interface. */
399 /* Maximum transmit rate for this interface in bits/sec. */
400 f64 max_rate_bits_per_sec;
402 /* Smallest packet size supported by this interface. */
403 u32 min_supported_packet_bytes;
405 /* Largest packet size supported by this interface. */
406 u32 max_supported_packet_bytes;
408 /* Smallest packet size for this interface. */
409 u32 min_packet_bytes;
411 /* Largest packet size for this interface. */
412 u32 max_packet_bytes;
414 /* Number of extra bytes that go on the wire.
415 Packet length on wire
416 = max (length + per_packet_overhead_bytes, min_packet_bytes). */
417 u32 per_packet_overhead_bytes;
419 /* Receive and transmit layer 3 packet size limits (MRU/MTU). */
420 u32 max_l3_packet_bytes[VLIB_N_RX_TX];
422 /* Hash table mapping sub interface id to sw_if_index. */
423 uword *sub_interface_sw_if_index_by_id;
425 /* Count of number of L2 subinterfaces */
428 /* Bonded interface info -
429 0 - not a bonded interface nor a slave
430 ~0 - slave to a bonded interface
431 others - A bonded interface with a pointer to bitmap for all slaves */
433 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
434 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
436 } vnet_hw_interface_t;
438 extern vnet_device_class_t vnet_local_interface_device_class;
442 /* A hw interface. */
443 VNET_SW_INTERFACE_TYPE_HARDWARE,
445 /* A sub-interface. */
446 VNET_SW_INTERFACE_TYPE_SUB,
447 } vnet_sw_interface_type_t;
452 * Subinterface ID. A number 0-N to uniquely identify
453 * this subinterface under the main (parent?) interface
457 /* Classification data. Used to associate packet header with subinterface. */
470 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
473 u16 outer_vlan_id_any:1;
474 u16 inner_vlan_id_any:1;
478 } vnet_sub_interface_t;
480 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
481 tunnel, etc. Configuration (e.g. IP address) gets attached to
482 software interface. */
485 vnet_sw_interface_type_t type:16;
488 /* Interface is "up" meaning adminstratively up.
489 Up in the sense of link state being up is maintained by hardware interface. */
490 #define VNET_SW_INTERFACE_FLAG_ADMIN_UP (1 << 0)
492 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
493 #define VNET_SW_INTERFACE_FLAG_PUNT (1 << 1)
495 #define VNET_SW_INTERFACE_FLAG_PROXY_ARP (1 << 2)
497 #define VNET_SW_INTERFACE_FLAG_UNNUMBERED (1 << 3)
499 #define VNET_SW_INTERFACE_FLAG_BOND_SLAVE (1 << 4)
501 /* Index for this interface. */
504 /* Software interface index of super-interface;
505 equal to sw_if_index if this interface is not a
509 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
510 u32 unnumbered_sw_if_index;
516 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
519 /* VNET_SW_INTERFACE_TYPE_SUB. */
520 vnet_sub_interface_t sub;
522 } vnet_sw_interface_t;
526 /* Simple counters. */
527 VNET_INTERFACE_COUNTER_DROP = 0,
528 VNET_INTERFACE_COUNTER_PUNT = 1,
529 VNET_INTERFACE_COUNTER_IP4 = 2,
530 VNET_INTERFACE_COUNTER_IP6 = 3,
531 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
532 VNET_INTERFACE_COUNTER_RX_MISS = 5,
533 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
534 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
535 VNET_INTERFACE_COUNTER_MPLS = 8,
536 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
537 /* Combined counters. */
538 VNET_INTERFACE_COUNTER_RX = 0,
539 VNET_INTERFACE_COUNTER_TX = 1,
540 VNET_N_COMBINED_INTERFACE_COUNTER = 2,
541 } vnet_interface_counter_type_t;
545 u32 output_node_index;
547 } vnet_hw_interface_nodes_t;
551 /* Hardware interfaces. */
552 vnet_hw_interface_t *hw_interfaces;
554 /* Hash table mapping HW interface name to index. */
555 uword *hw_interface_by_name;
557 /* Vectors if hardware interface classes and device classes. */
558 vnet_hw_interface_class_t *hw_interface_classes;
559 vnet_device_class_t *device_classes;
561 /* Hash table mapping name to hw interface/device class. */
562 uword *hw_interface_class_by_name;
563 uword *device_class_by_name;
565 /* Software interfaces. */
566 vnet_sw_interface_t *sw_interfaces;
568 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
569 uword *sw_if_index_by_sup_and_sub;
571 /* Software interface counters both simple and combined
572 packet and byte counters. */
573 volatile u32 *sw_if_counter_lock;
574 vlib_simple_counter_main_t *sw_if_counters;
575 vlib_combined_counter_main_t *combined_sw_if_counters;
577 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
579 /* pcap drop tracing */
580 int drop_pcap_enable;
581 pcap_main_t pcap_main;
583 u32 pcap_sw_if_index;
584 u32 pcap_pkts_to_capture;
585 uword *pcap_drop_filter_hash;
587 } vnet_interface_main_t;
590 vnet_interface_counter_lock (vnet_interface_main_t * im)
592 if (im->sw_if_counter_lock)
593 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
598 vnet_interface_counter_unlock (vnet_interface_main_t * im)
600 if (im->sw_if_counter_lock)
601 *im->sw_if_counter_lock = 0;
604 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
606 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
608 #endif /* included_vnet_interface_h */
611 * fd.io coding-style-patch-verification: ON
614 * eval: (c-set-style "gnu")