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;
220 * @brief Convert a link to to an Ethertype
222 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
225 * @brief Attributes assignable to a HW interface Class.
227 typedef enum vnet_hw_interface_class_flags_t_
230 * @brief a point 2 point interface
232 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
233 } vnet_hw_interface_class_flags_t;
235 /* Layer-2 (e.g. Ethernet) interface class. */
236 typedef struct _vnet_hw_interface_class
238 /* Index into main vector. */
241 /* Class name (e.g. "Ethernet"). */
245 vnet_hw_interface_class_flags_t flags;
247 /* Function to call when hardware interface is added/deleted. */
248 vnet_interface_function_t *interface_add_del_function;
250 /* Function to bring interface administratively up/down. */
251 vnet_interface_function_t *admin_up_down_function;
253 /* Function to call when link state changes. */
254 vnet_interface_function_t *link_up_down_function;
256 /* Format function to display interface name. */
257 format_function_t *format_interface_name;
259 /* Format function to display interface address. */
260 format_function_t *format_address;
262 /* Format packet header for this interface class. */
263 format_function_t *format_header;
265 /* Format device verbosely for this class. */
266 format_function_t *format_device;
268 /* Parser for hardware (e.g. ethernet) address. */
269 unformat_function_t *unformat_hw_address;
271 /* Parser for packet header for e.g. rewrite string. */
272 unformat_function_t *unformat_header;
274 /* Builds a rewrite string for the interface to the destination
275 * for the payload/link type. */
276 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
278 vnet_link_t link_type, const void *dst_hw_address);
280 /* Update an adjacecny added by FIB (as opposed to via the
281 * neighbour resolution protocol). */
282 void (*update_adjacency) (struct vnet_main_t * vnm,
283 u32 sw_if_index, u32 adj_index);
285 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
289 /* Called when hw interface class is changed and old hardware instance
290 may want to be deleted. */
291 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
292 u32 old_class_index, u32 new_class_index);
294 /* List of hw interface classes, built by constructors */
295 struct _vnet_hw_interface_class *next_class_registration;
297 } vnet_hw_interface_class_t;
300 * @brief Return a complete, zero-length (aka dummy) rewrite
302 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
304 vnet_link_t link_type,
305 const void *dst_hw_address);
308 * @brief Default adjacency update function
310 extern void default_update_adjacency (struct vnet_main_t *vnm,
311 u32 sw_if_index, u32 adj_index);
313 #define VNET_HW_INTERFACE_CLASS(x,...) \
314 __VA_ARGS__ vnet_hw_interface_class_t x; \
315 static void __vnet_add_hw_interface_class_registration_##x (void) \
316 __attribute__((__constructor__)) ; \
317 static void __vnet_add_hw_interface_class_registration_##x (void) \
319 vnet_main_t * vnm = vnet_get_main(); \
320 x.next_class_registration = vnm->hw_interface_class_registrations; \
321 vnm->hw_interface_class_registrations = &x; \
323 __VA_ARGS__ vnet_hw_interface_class_t x
325 /* Hardware-interface. This corresponds to a physical wire
326 that packets flow over. */
327 typedef struct vnet_hw_interface_t
329 /* Interface name. */
333 /* Hardware link state is up. */
334 #define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
335 /* Hardware duplex state */
336 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
337 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
338 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
339 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
340 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
341 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
343 /* Hardware link speed */
344 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
345 #define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
346 #define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
347 #define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
348 #define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 6)
349 #define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 7)
350 #define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 8)
351 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
352 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
353 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
354 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
355 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
356 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
357 VNET_HW_INTERFACE_FLAG_SPEED_100G)
359 /* l2output node flags */
360 #define VNET_HW_INTERFACE_FLAG_L2OUTPUT_SHIFT 9
361 #define VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED (1 << 9)
363 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
364 address for this class (e.g. PPP). */
367 /* Interface is up as far as software is concerned. */
368 /* NAME.{output,tx} nodes for this interface. */
369 u32 output_node_index, tx_node_index;
371 /* (dev_class, dev_instance) uniquely identifies hw interface. */
375 /* (hw_class, hw_instance) uniquely identifies hw interface. */
379 /* Hardware index for this hardware interface. */
382 /* Software index for this hardware interface. */
385 /* Maximum transmit rate for this interface in bits/sec. */
386 f64 max_rate_bits_per_sec;
388 /* Smallest packet size supported by this interface. */
389 u32 min_supported_packet_bytes;
391 /* Largest packet size supported by this interface. */
392 u32 max_supported_packet_bytes;
394 /* Smallest packet size for this interface. */
395 u32 min_packet_bytes;
397 /* Largest packet size for this interface. */
398 u32 max_packet_bytes;
400 /* Number of extra bytes that go on the wire.
401 Packet length on wire
402 = max (length + per_packet_overhead_bytes, min_packet_bytes). */
403 u32 per_packet_overhead_bytes;
405 /* Receive and transmit layer 3 packet size limits (MRU/MTU). */
406 u32 max_l3_packet_bytes[VLIB_N_RX_TX];
408 /* Hash table mapping sub interface id to sw_if_index. */
409 uword *sub_interface_sw_if_index_by_id;
411 /* Count of number of L2 subinterfaces */
414 /* Bonded interface info -
415 0 - not a bonded interface nor a slave
416 ~0 - slave to a bonded interface
417 others - A bonded interface with a pointer to bitmap for all slaves */
419 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
420 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
422 } vnet_hw_interface_t;
424 extern vnet_device_class_t vnet_local_interface_device_class;
428 /* A hw interface. */
429 VNET_SW_INTERFACE_TYPE_HARDWARE,
431 /* A sub-interface. */
432 VNET_SW_INTERFACE_TYPE_SUB,
433 } vnet_sw_interface_type_t;
438 * Subinterface ID. A number 0-N to uniquely identify
439 * this subinterface under the main (parent?) interface
443 /* Classification data. Used to associate packet header with subinterface. */
456 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
459 u16 outer_vlan_id_any:1;
460 u16 inner_vlan_id_any:1;
464 } vnet_sub_interface_t;
466 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
467 tunnel, etc. Configuration (e.g. IP address) gets attached to
468 software interface. */
471 vnet_sw_interface_type_t type:16;
474 /* Interface is "up" meaning adminstratively up.
475 Up in the sense of link state being up is maintained by hardware interface. */
476 #define VNET_SW_INTERFACE_FLAG_ADMIN_UP (1 << 0)
478 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
479 #define VNET_SW_INTERFACE_FLAG_PUNT (1 << 1)
481 #define VNET_SW_INTERFACE_FLAG_PROXY_ARP (1 << 2)
483 #define VNET_SW_INTERFACE_FLAG_UNNUMBERED (1 << 3)
485 #define VNET_SW_INTERFACE_FLAG_BOND_SLAVE (1 << 4)
487 /* Index for this interface. */
490 /* Software interface index of super-interface;
491 equal to sw_if_index if this interface is not a
495 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
496 u32 unnumbered_sw_if_index;
500 u32 output_feature_bitmap;
504 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
507 /* VNET_SW_INTERFACE_TYPE_SUB. */
508 vnet_sub_interface_t sub;
510 } vnet_sw_interface_t;
514 /* Simple counters. */
515 VNET_INTERFACE_COUNTER_DROP = 0,
516 VNET_INTERFACE_COUNTER_PUNT = 1,
517 VNET_INTERFACE_COUNTER_IP4 = 2,
518 VNET_INTERFACE_COUNTER_IP6 = 3,
519 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
520 VNET_INTERFACE_COUNTER_RX_MISS = 5,
521 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
522 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
523 VNET_INTERFACE_COUNTER_MPLS = 8,
524 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
525 /* Combined counters. */
526 VNET_INTERFACE_COUNTER_RX = 0,
527 VNET_INTERFACE_COUNTER_TX = 1,
528 VNET_N_COMBINED_INTERFACE_COUNTER = 2,
529 } vnet_interface_counter_type_t;
533 u32 output_node_index;
535 } vnet_hw_interface_nodes_t;
539 /* Hardware interfaces. */
540 vnet_hw_interface_t *hw_interfaces;
542 /* Hash table mapping HW interface name to index. */
543 uword *hw_interface_by_name;
545 /* Vectors if hardware interface classes and device classes. */
546 vnet_hw_interface_class_t *hw_interface_classes;
547 vnet_device_class_t *device_classes;
549 /* Hash table mapping name to hw interface/device class. */
550 uword *hw_interface_class_by_name;
551 uword *device_class_by_name;
553 /* Software interfaces. */
554 vnet_sw_interface_t *sw_interfaces;
556 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
557 uword *sw_if_index_by_sup_and_sub;
559 /* Software interface counters both simple and combined
560 packet and byte counters. */
561 volatile u32 *sw_if_counter_lock;
562 vlib_simple_counter_main_t *sw_if_counters;
563 vlib_combined_counter_main_t *combined_sw_if_counters;
565 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
567 /* pcap drop tracing */
568 int drop_pcap_enable;
569 pcap_main_t pcap_main;
571 u32 pcap_sw_if_index;
572 u32 pcap_pkts_to_capture;
573 uword *pcap_drop_filter_hash;
575 } vnet_interface_main_t;
578 vnet_interface_counter_lock (vnet_interface_main_t * im)
580 if (im->sw_if_counter_lock)
581 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
586 vnet_interface_counter_unlock (vnet_interface_main_t * im)
588 if (im->sw_if_counter_lock)
589 *im->sw_if_counter_lock = 0;
592 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
594 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
601 #define foreach_intf_output_feat \
602 _(IPSEC, "ipsec-output")
604 /* Feature bitmap positions */
607 #define _(sym,str) INTF_OUTPUT_FEAT_##sym,
608 foreach_intf_output_feat
611 } intf_output_feat_t;
613 /* flag that we are done with feature path */
614 #define INTF_OUTPUT_FEAT_DONE INTF_OUTPUT_N_FEAT
616 int vnet_interface_add_del_feature (struct vnet_main_t *vnm, vlib_main_t * vm,
618 intf_output_feat_t feature, int is_add);
620 #endif /* included_vnet_interface_h */
623 * fd.io coding-style-patch-verification: ON
626 * eval: (c-set-style "gnu")