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 * ethernet.h: types/functions for ethernet.
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_ethernet_h
41 #define included_ethernet_h
43 #include <vnet/vnet.h>
44 #include <vnet/ethernet/packet.h>
45 #include <vnet/pg/pg.h>
46 #include <vnet/feature/feature.h>
49 ethernet_mac_address_u64 (u8 * a)
51 return (((u64) a[0] << (u64) (5 * 8))
52 | ((u64) a[1] << (u64) (4 * 8))
53 | ((u64) a[2] << (u64) (3 * 8))
54 | ((u64) a[3] << (u64) (2 * 8))
55 | ((u64) a[4] << (u64) (1 * 8)) | ((u64) a[5] << (u64) (0 * 8)));
59 ethernet_mac_address_is_multicast_u64 (u64 a)
61 return (a & (1ULL << (5 * 8))) != 0;
65 ethernet_mac_address_is_zero (u8 * mac)
67 return ((*((u32 *) mac) == 0) && (*((u16 *) (mac + 4)) == 0));
70 #ifdef CLIB_HAVE_VEC128
71 static const u16x8 tagged_ethertypes = {
72 (u16) ETHERNET_TYPE_VLAN,
73 (u16) ETHERNET_TYPE_DOT1AD,
74 (u16) ETHERNET_TYPE_VLAN_9100,
75 (u16) ETHERNET_TYPE_VLAN_9200,
76 /* duplicate last one to fill register */
77 (u16) ETHERNET_TYPE_VLAN_9200,
78 (u16) ETHERNET_TYPE_VLAN_9200,
79 (u16) ETHERNET_TYPE_VLAN_9200,
80 (u16) ETHERNET_TYPE_VLAN_9200
84 static_always_inline int
85 ethernet_frame_is_tagged (u16 type)
87 #ifdef CLIB_HAVE_VEC128
88 return !u16x8_is_all_zero (tagged_ethertypes == u16x8_splat (type));
90 if ((type == ETHERNET_TYPE_VLAN) ||
91 (type == ETHERNET_TYPE_DOT1AD) ||
92 (type == ETHERNET_TYPE_VLAN_9100) || (type == ETHERNET_TYPE_VLAN_9200))
98 static_always_inline int
99 ethernet_frame_is_any_tagged_x2 (u16 type0, u16 type1)
101 #ifdef CLIB_HAVE_VEC128
102 u16x8 r0 = (tagged_ethertypes == u16x8_splat (type0));
103 u16x8 r1 = (tagged_ethertypes == u16x8_splat (type1));
104 return !u16x8_is_all_zero (r0 | r1);
106 return ethernet_frame_is_tagged (type0) || ethernet_frame_is_tagged (type1);
110 static_always_inline int
111 ethernet_frame_is_any_tagged_x4 (u16 type0, u16 type1, u16 type2, u16 type3)
113 #ifdef CLIB_HAVE_VEC128
114 u16x8 r0 = (tagged_ethertypes == u16x8_splat (type0));
115 u16x8 r1 = (tagged_ethertypes == u16x8_splat (type1));
116 u16x8 r2 = (tagged_ethertypes == u16x8_splat (type2));
117 u16x8 r3 = (tagged_ethertypes == u16x8_splat (type3));
118 return !u16x8_is_all_zero (r0 | r1 | r2 | r3);
120 return ethernet_frame_is_tagged (type0) || ethernet_frame_is_tagged (type1)
121 || ethernet_frame_is_tagged (type2) || ethernet_frame_is_tagged (type3);
125 /* Max. sized ethernet/vlan header for parsing. */
128 ethernet_header_t ethernet;
130 /* Allow up to 2 stacked vlan headers. */
131 ethernet_vlan_header_t vlan[2];
132 } ethernet_max_header_t;
134 struct vnet_hw_interface_t;
135 /* Ethernet flag change callback. */
136 typedef u32 (ethernet_flag_change_function_t)
137 (vnet_main_t * vnm, struct vnet_hw_interface_t * hi, u32 flags);
139 #define ETHERNET_MIN_PACKET_BYTES 64
140 #define ETHERNET_MAX_PACKET_BYTES 9216
142 /* Ethernet interface instance. */
143 typedef struct ethernet_interface
146 /* Accept all packets (promiscuous mode). */
147 #define ETHERNET_INTERFACE_FLAG_ACCEPT_ALL (1 << 0)
148 #define ETHERNET_INTERFACE_FLAG_CONFIG_PROMISC(flags) \
149 (((flags) & ~ETHERNET_INTERFACE_FLAG_ACCEPT_ALL) == 0)
151 /* Change MTU on interface from hw interface structure */
152 #define ETHERNET_INTERFACE_FLAG_MTU (1 << 1)
153 #define ETHERNET_INTERFACE_FLAG_CONFIG_MTU(flags) \
154 ((flags) & ETHERNET_INTERFACE_FLAG_MTU)
156 /* Callback, e.g. to turn on/off promiscuous mode */
157 ethernet_flag_change_function_t *flag_change;
161 /* Ethernet (MAC) address for this interface. */
163 } ethernet_interface_t;
165 extern vnet_hw_interface_class_t ethernet_hw_interface_class;
169 /* Name (a c string). */
172 /* Ethernet type in host byte order. */
173 ethernet_type_t type;
175 /* Node which handles this type. */
178 /* Next index for this type. */
180 } ethernet_type_info_t;
184 #define ethernet_error(n,c,s) ETHERNET_ERROR_##n,
185 #include <vnet/ethernet/error.def>
186 #undef ethernet_error
191 // Structs used when parsing packet to find sw_if_index
197 // config entry is-valid flag
198 // exact match flags (valid if packet has 0/1/2/3 tags)
199 // L2 vs L3 forwarding mode
200 #define SUBINT_CONFIG_MATCH_0_TAG (1<<0)
201 #define SUBINT_CONFIG_MATCH_1_TAG (1<<1)
202 #define SUBINT_CONFIG_MATCH_2_TAG (1<<2)
203 #define SUBINT_CONFIG_MATCH_3_TAG (1<<3)
204 #define SUBINT_CONFIG_VALID (1<<4)
205 #define SUBINT_CONFIG_L2 (1<<5)
206 #define SUBINT_CONFIG_P2P (1<<6)
211 eth_create_valid_subint_match_flags (u32 num_tags)
213 return SUBINT_CONFIG_VALID | (1 << num_tags);
219 subint_config_t untagged_subint;
220 subint_config_t default_subint;
221 u16 dot1q_vlans; // pool id for vlan table
222 u16 dot1ad_vlans; // pool id for vlan table
227 subint_config_t single_tag_subint;
228 subint_config_t inner_any_subint;
229 u32 qinqs; // pool id for qinq table
234 vlan_intf_t vlans[ETHERNET_N_VLAN];
239 subint_config_t subint;
244 qinq_intf_t vlans[ETHERNET_N_VLAN];
247 // Structure mapping to a next index based on ethertype.
248 // Common ethertypes are stored explicitly, others are
249 // stored in a sparse table.
252 /* Sparse vector mapping ethernet type in network byte order
254 u16 *input_next_by_type;
255 u32 *sparse_index_by_input_next_index;
257 /* cached next indexes for common ethertypes */
261 } next_by_ethertype_t;
265 vlib_main_t *vlib_main;
267 /* next node index for the L3 input node of each ethertype */
268 next_by_ethertype_t l3_next;
270 /* next node index for L2 interfaces */
273 /* flag and next node index for L3 redirect */
275 u32 redirect_l3_next;
277 /* Pool of ethernet interface instances. */
278 ethernet_interface_t *interfaces;
280 ethernet_type_info_t *type_infos;
282 /* Hash tables mapping name/type to type info index. */
283 uword *type_info_by_name, *type_info_by_type;
285 // The root of the vlan parsing tables. A vector with one element
286 // for each main interface, indexed by hw_if_index.
287 main_intf_t *main_intfs;
289 // Pool of vlan tables
290 vlan_table_t *vlan_pool;
292 // Pool of qinq tables;
293 qinq_table_t *qinq_pool;
295 /* Set to one to use AB.CD.EF instead of A:B:C:D:E:F as ethernet format. */
296 int format_ethernet_address_16bit;
298 /* debug: make sure we don't wipe out an ethernet registration by mistake */
299 u8 next_by_ethertype_register_called;
301 /* Feature arc index */
302 u8 output_feature_arc_index;
304 /* Allocated loopback instances */
305 uword *bm_loopback_instances;
308 extern ethernet_main_t ethernet_main;
310 always_inline ethernet_type_info_t *
311 ethernet_get_type_info (ethernet_main_t * em, ethernet_type_t type)
313 uword *p = hash_get (em->type_info_by_type, type);
314 return p ? vec_elt_at_index (em->type_infos, p[0]) : 0;
317 ethernet_interface_t *ethernet_get_interface (ethernet_main_t * em,
320 clib_error_t *ethernet_register_interface (vnet_main_t * vnm,
324 u32 * hw_if_index_return,
325 ethernet_flag_change_function_t
328 void ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index);
330 /* Register given node index to take input for given ethernet type. */
332 ethernet_register_input_type (vlib_main_t * vm,
333 ethernet_type_t type, u32 node_index);
335 /* Register given node index to take input for packet from L2 interfaces. */
336 void ethernet_register_l2_input (vlib_main_t * vm, u32 node_index);
338 /* Register given node index to take redirected L3 traffic, and enable L3 redirect */
339 void ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index);
341 /* Formats ethernet address X:X:X:X:X:X */
342 u8 *format_ethernet_address (u8 * s, va_list * args);
343 u8 *format_ethernet_type (u8 * s, va_list * args);
344 u8 *format_ethernet_vlan_tci (u8 * s, va_list * va);
345 u8 *format_ethernet_header (u8 * s, va_list * args);
346 u8 *format_ethernet_header_with_length (u8 * s, va_list * args);
348 /* Parse ethernet address in either X:X:X:X:X:X unix or X.X.X cisco format. */
349 uword unformat_ethernet_address (unformat_input_t * input, va_list * args);
351 /* Parse ethernet type as 0xXXXX or type name from ethernet/types.def.
352 In either host or network byte order. */
354 unformat_ethernet_type_host_byte_order (unformat_input_t * input,
357 unformat_ethernet_type_net_byte_order (unformat_input_t * input,
360 /* Parse ethernet header. */
361 uword unformat_ethernet_header (unformat_input_t * input, va_list * args);
363 /* Parse ethernet interface name; return hw_if_index. */
364 uword unformat_ethernet_interface (unformat_input_t * input, va_list * args);
366 uword unformat_pg_ethernet_header (unformat_input_t * input, va_list * args);
369 ethernet_setup_node (vlib_main_t * vm, u32 node_index)
371 vlib_node_t *n = vlib_get_node (vm, node_index);
372 pg_node_t *pn = pg_get_node (node_index);
374 n->format_buffer = format_ethernet_header_with_length;
375 n->unformat_buffer = unformat_ethernet_header;
376 pn->unformat_edit = unformat_pg_ethernet_header;
379 always_inline ethernet_header_t *
380 ethernet_buffer_get_header (vlib_buffer_t * b)
382 return (void *) (b->data + vnet_buffer (b)->l2_hdr_offset);
385 /** Returns the number of VLAN headers in the current Ethernet frame in the
386 * buffer. Returns 0, 1, 2 for the known header count. The value 3 indicates
387 * the number of headers is not known.
389 #define ethernet_buffer_get_vlan_count(b) ( \
390 ((b)->flags & VNET_BUFFER_FLAGS_VLAN_BITS) >> VNET_BUFFER_F_LOG2_VLAN_1_DEEP \
393 /** Sets the number of VLAN headers in the current Ethernet frame in the
394 * buffer. Values 0, 1, 2 indicate the header count. The value 3 indicates
395 * the number of headers is not known.
397 #define ethernet_buffer_set_vlan_count(b, v) ( \
398 (b)->flags = ((b)->flags & ~VNET_BUFFER_FLAGS_VLAN_BITS) | \
399 (((v) << VNET_BUFFER_F_LOG2_VLAN_1_DEEP) & VNET_BUFFER_FLAGS_VLAN_BITS) \
402 /** Adjusts the vlan count by the delta in 'v' */
403 #define ethernet_buffer_adjust_vlan_count(b, v) ( \
404 ethernet_buffer_set_vlan_count(b, \
405 (word)ethernet_buffer_get_vlan_count(b) + (word)(v)) \
408 /** Adjusts the vlan count by the header size byte delta in 'v' */
409 #define ethernet_buffer_adjust_vlan_count_by_bytes(b, v) ( \
410 (b)->flags = ((b)->flags & ~VNET_BUFFER_FLAGS_VLAN_BITS) | (( \
411 ((b)->flags & VNET_BUFFER_FLAGS_VLAN_BITS) + \
412 ((v) << (VNET_BUFFER_F_LOG2_VLAN_1_DEEP - 2)) \
413 ) & VNET_BUFFER_FLAGS_VLAN_BITS) \
417 * Determine the size of the Ethernet headers of the current frame in
418 * the buffer. This uses the VLAN depth flags that are set by
419 * ethernet-input. Because these flags are stored in the vlib_buffer_t
420 * "flags" field this count is valid regardless of the node so long as it's
421 * checked downstream of ethernet-input; That is, the value is not stored in
424 #define ethernet_buffer_header_size(b) ( \
425 ethernet_buffer_get_vlan_count((b)) * sizeof(ethernet_vlan_header_t) + \
426 sizeof(ethernet_header_t) \
429 ethernet_main_t *ethernet_get_main (vlib_main_t * vm);
430 u32 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags);
431 void ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index,
433 void ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
434 u32 sw_if_index, u32 l2);
435 void ethernet_set_rx_redirect (vnet_main_t * vnm, vnet_hw_interface_t * hi,
439 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
440 u32 sw_if_index, void *a_arg,
441 int is_static, int is_no_fib_entry);
444 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
445 u32 sw_if_index, void *a_arg);
447 int vnet_proxy_arp_fib_reset (u32 fib_id);
449 clib_error_t *next_by_ethertype_init (next_by_ethertype_t * l3_next);
450 clib_error_t *next_by_ethertype_register (next_by_ethertype_t * l3_next,
451 u32 ethertype, u32 next_index);
453 int vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address,
454 u8 is_specified, u32 user_instance);
455 int vnet_delete_loopback_interface (u32 sw_if_index);
456 int vnet_delete_sub_interface (u32 sw_if_index);
458 // Perform ethernet subinterface classification table lookups given
459 // the ports's sw_if_index and fields extracted from the ethernet header.
460 // The resulting tables are used by identify_subint().
462 eth_vlan_table_lookups (ethernet_main_t * em,
464 u32 port_sw_if_index0,
468 vnet_hw_interface_t ** hi,
469 main_intf_t ** main_intf,
470 vlan_intf_t ** vlan_intf, qinq_intf_t ** qinq_intf)
472 vlan_table_t *vlan_table;
473 qinq_table_t *qinq_table;
476 // Read the main, vlan, and qinq interface table entries
477 // TODO: Consider if/how to prefetch tables. Also consider
478 // single-entry cache to skip table lookups and identify_subint()
480 *hi = vnet_get_sup_hw_interface (vnm, port_sw_if_index0);
481 *main_intf = vec_elt_at_index (em->main_intfs, (*hi)->hw_if_index);
483 // Always read the vlan and qinq tables, even if there are not that
484 // many tags on the packet. This makes the lookups and comparisons
485 // easier (and less branchy).
486 vlan_table_id = (first_ethertype == ETHERNET_TYPE_DOT1AD) ?
487 (*main_intf)->dot1ad_vlans : (*main_intf)->dot1q_vlans;
488 vlan_table = vec_elt_at_index (em->vlan_pool, vlan_table_id);
489 *vlan_intf = &vlan_table->vlans[outer_id];
491 qinq_table = vec_elt_at_index (em->qinq_pool, (*vlan_intf)->qinqs);
492 *qinq_intf = &qinq_table->vlans[inner_id];
496 // Determine the subinterface for this packet, given the result of the
497 // vlan table lookups and vlan header parsing. Check the most specific
499 // Returns 1 if a matching subinterface was found, otherwise returns 0.
501 eth_identify_subint (vnet_hw_interface_t * hi,
504 main_intf_t * main_intf,
505 vlan_intf_t * vlan_intf,
506 qinq_intf_t * qinq_intf,
507 u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
509 subint_config_t *subint;
511 // Each comparison is checking both the valid flag and the number of tags
512 // (incorporating exact-match/non-exact-match).
514 // check for specific double tag
515 subint = &qinq_intf->subint;
516 if ((subint->flags & match_flags) == match_flags)
519 // check for specific outer and 'any' inner
520 subint = &vlan_intf->inner_any_subint;
521 if ((subint->flags & match_flags) == match_flags)
524 // check for specific single tag
525 subint = &vlan_intf->single_tag_subint;
526 if ((subint->flags & match_flags) == match_flags)
529 // check for untagged interface
530 subint = &main_intf->untagged_subint;
531 if ((subint->flags & match_flags) == match_flags)
534 // check for default interface
535 subint = &main_intf->default_subint;
536 if ((subint->flags & match_flags) == match_flags)
539 // No matching subinterface
540 *new_sw_if_index = ~0;
541 *error0 = ETHERNET_ERROR_UNKNOWN_VLAN;
546 *new_sw_if_index = subint->sw_if_index;
547 *is_l2 = subint->flags & SUBINT_CONFIG_L2;
551 // Compare two ethernet macs. Return 1 if they are the same, 0 if different
553 eth_mac_equal (u8 * mac1, u8 * mac2)
555 return (*((u32 *) (mac1 + 0)) == *((u32 *) (mac2 + 0)) &&
556 *((u32 *) (mac1 + 2)) == *((u32 *) (mac2 + 2)));
560 always_inline ethernet_main_t *
561 vnet_get_ethernet_main (void)
563 return ðernet_main;
566 void vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
569 uword type_opaque, uword data);
572 int vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
578 uword data, int is_add);
580 void wc_arp_set_publisher_node (uword inode_index, uword event_type);
582 void ethernet_arp_change_mac (u32 sw_if_index);
583 void ethernet_ndp_change_mac (u32 sw_if_index);
585 void arp_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai);
587 void ethernet_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai);
588 u8 *ethernet_build_rewrite (vnet_main_t * vnm,
590 vnet_link_t link_type, const void *dst_address);
591 const u8 *ethernet_ip4_mcast_dst_addr (void);
592 const u8 *ethernet_ip6_mcast_dst_addr (void);
594 extern vlib_node_registration_t ethernet_input_node;
603 #endif /* included_ethernet_h */
606 * fd.io coding-style-patch-verification: ON
609 * eval: (c-set-style "gnu")