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 static_always_inline int
71 ethernet_frame_is_tagged (u16 type)
74 const __m128i ethertype_mask = _mm_set_epi16 (ETHERNET_TYPE_VLAN,
76 ETHERNET_TYPE_VLAN_9100,
77 ETHERNET_TYPE_VLAN_9200,
78 /* duplicate last one to
80 ETHERNET_TYPE_VLAN_9200,
81 ETHERNET_TYPE_VLAN_9200,
82 ETHERNET_TYPE_VLAN_9200,
83 ETHERNET_TYPE_VLAN_9200);
85 __m128i r = _mm_set1_epi16 (type);
86 r = _mm_cmpeq_epi16 (ethertype_mask, r);
87 return !_mm_test_all_zeros (r, r);
89 if ((type == ETHERNET_TYPE_VLAN) ||
90 (type == ETHERNET_TYPE_DOT1AD) ||
91 (type == ETHERNET_TYPE_VLAN_9100) || (type == ETHERNET_TYPE_VLAN_9200))
97 /* Max. sized ethernet/vlan header for parsing. */
100 ethernet_header_t ethernet;
102 /* Allow up to 2 stacked vlan headers. */
103 ethernet_vlan_header_t vlan[2];
104 } ethernet_max_header_t;
106 struct vnet_hw_interface_t;
107 /* Ethernet flag change callback. */
108 typedef u32 (ethernet_flag_change_function_t)
109 (vnet_main_t * vnm, struct vnet_hw_interface_t * hi, u32 flags);
111 #define ETHERNET_MIN_PACKET_BYTES 64
112 #define ETHERNET_MAX_PACKET_BYTES 9216
114 /* Ethernet interface instance. */
115 typedef struct ethernet_interface
118 /* Accept all packets (promiscuous mode). */
119 #define ETHERNET_INTERFACE_FLAG_ACCEPT_ALL (1 << 0)
120 #define ETHERNET_INTERFACE_FLAG_CONFIG_PROMISC(flags) \
121 (((flags) & ~ETHERNET_INTERFACE_FLAG_ACCEPT_ALL) == 0)
123 /* Change MTU on interface from hw interface structure */
124 #define ETHERNET_INTERFACE_FLAG_MTU (1 << 1)
125 #define ETHERNET_INTERFACE_FLAG_CONFIG_MTU(flags) \
126 ((flags) & ETHERNET_INTERFACE_FLAG_MTU)
128 /* Callback, e.g. to turn on/off promiscuous mode */
129 ethernet_flag_change_function_t *flag_change;
133 /* Ethernet (MAC) address for this interface. */
135 } ethernet_interface_t;
137 extern vnet_hw_interface_class_t ethernet_hw_interface_class;
141 /* Name (a c string). */
144 /* Ethernet type in host byte order. */
145 ethernet_type_t type;
147 /* Node which handles this type. */
150 /* Next index for this type. */
152 } ethernet_type_info_t;
156 #define ethernet_error(n,c,s) ETHERNET_ERROR_##n,
157 #include <vnet/ethernet/error.def>
158 #undef ethernet_error
163 // Structs used when parsing packet to find sw_if_index
169 // config entry is-valid flag
170 // exact match flags (valid if packet has 0/1/2/3 tags)
171 // L2 vs L3 forwarding mode
172 #define SUBINT_CONFIG_MATCH_0_TAG (1<<0)
173 #define SUBINT_CONFIG_MATCH_1_TAG (1<<1)
174 #define SUBINT_CONFIG_MATCH_2_TAG (1<<2)
175 #define SUBINT_CONFIG_MATCH_3_TAG (1<<3)
176 #define SUBINT_CONFIG_VALID (1<<4)
177 #define SUBINT_CONFIG_L2 (1<<5)
178 #define SUBINT_CONFIG_P2P (1<<6)
183 eth_create_valid_subint_match_flags (u32 num_tags)
185 return SUBINT_CONFIG_VALID | (1 << num_tags);
191 subint_config_t untagged_subint;
192 subint_config_t default_subint;
193 u16 dot1q_vlans; // pool id for vlan table
194 u16 dot1ad_vlans; // pool id for vlan table
199 subint_config_t single_tag_subint;
200 subint_config_t inner_any_subint;
201 u32 qinqs; // pool id for qinq table
206 vlan_intf_t vlans[ETHERNET_N_VLAN];
211 subint_config_t subint;
216 qinq_intf_t vlans[ETHERNET_N_VLAN];
219 // Structure mapping to a next index based on ethertype.
220 // Common ethertypes are stored explicitly, others are
221 // stored in a sparse table.
224 /* Sparse vector mapping ethernet type in network byte order
226 u16 *input_next_by_type;
227 u32 *sparse_index_by_input_next_index;
229 /* cached next indexes for common ethertypes */
233 } next_by_ethertype_t;
237 vlib_main_t *vlib_main;
239 /* next node index for the L3 input node of each ethertype */
240 next_by_ethertype_t l3_next;
242 /* next node index for L2 interfaces */
245 /* flag and next node index for L3 redirect */
247 u32 redirect_l3_next;
249 /* Pool of ethernet interface instances. */
250 ethernet_interface_t *interfaces;
252 ethernet_type_info_t *type_infos;
254 /* Hash tables mapping name/type to type info index. */
255 uword *type_info_by_name, *type_info_by_type;
257 // The root of the vlan parsing tables. A vector with one element
258 // for each main interface, indexed by hw_if_index.
259 main_intf_t *main_intfs;
261 // Pool of vlan tables
262 vlan_table_t *vlan_pool;
264 // Pool of qinq tables;
265 qinq_table_t *qinq_pool;
267 /* Set to one to use AB.CD.EF instead of A:B:C:D:E:F as ethernet format. */
268 int format_ethernet_address_16bit;
270 /* debug: make sure we don't wipe out an ethernet registration by mistake */
271 u8 next_by_ethertype_register_called;
273 /* Feature arc index */
274 u8 output_feature_arc_index;
276 /* Allocated loopback instances */
277 uword *bm_loopback_instances;
280 extern ethernet_main_t ethernet_main;
282 always_inline ethernet_type_info_t *
283 ethernet_get_type_info (ethernet_main_t * em, ethernet_type_t type)
285 uword *p = hash_get (em->type_info_by_type, type);
286 return p ? vec_elt_at_index (em->type_infos, p[0]) : 0;
289 ethernet_interface_t *ethernet_get_interface (ethernet_main_t * em,
292 clib_error_t *ethernet_register_interface (vnet_main_t * vnm,
296 u32 * hw_if_index_return,
297 ethernet_flag_change_function_t
300 void ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index);
302 /* Register given node index to take input for given ethernet type. */
304 ethernet_register_input_type (vlib_main_t * vm,
305 ethernet_type_t type, u32 node_index);
307 /* Register given node index to take input for packet from L2 interfaces. */
308 void ethernet_register_l2_input (vlib_main_t * vm, u32 node_index);
310 /* Register given node index to take redirected L3 traffic, and enable L3 redirect */
311 void ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index);
313 /* Formats ethernet address X:X:X:X:X:X */
314 u8 *format_ethernet_address (u8 * s, va_list * args);
315 u8 *format_ethernet_type (u8 * s, va_list * args);
316 u8 *format_ethernet_vlan_tci (u8 * s, va_list * va);
317 u8 *format_ethernet_header (u8 * s, va_list * args);
318 u8 *format_ethernet_header_with_length (u8 * s, va_list * args);
320 /* Parse ethernet address in either X:X:X:X:X:X unix or X.X.X cisco format. */
321 uword unformat_ethernet_address (unformat_input_t * input, va_list * args);
323 /* Parse ethernet type as 0xXXXX or type name from ethernet/types.def.
324 In either host or network byte order. */
326 unformat_ethernet_type_host_byte_order (unformat_input_t * input,
329 unformat_ethernet_type_net_byte_order (unformat_input_t * input,
332 /* Parse ethernet header. */
333 uword unformat_ethernet_header (unformat_input_t * input, va_list * args);
335 /* Parse ethernet interface name; return hw_if_index. */
336 uword unformat_ethernet_interface (unformat_input_t * input, va_list * args);
338 uword unformat_pg_ethernet_header (unformat_input_t * input, va_list * args);
341 ethernet_setup_node (vlib_main_t * vm, u32 node_index)
343 vlib_node_t *n = vlib_get_node (vm, node_index);
344 pg_node_t *pn = pg_get_node (node_index);
346 n->format_buffer = format_ethernet_header_with_length;
347 n->unformat_buffer = unformat_ethernet_header;
348 pn->unformat_edit = unformat_pg_ethernet_header;
351 always_inline ethernet_header_t *
352 ethernet_buffer_get_header (vlib_buffer_t * b)
354 return (void *) (b->data + vnet_buffer (b)->l2_hdr_offset);
357 /** Returns the number of VLAN headers in the current Ethernet frame in the
358 * buffer. Returns 0, 1, 2 for the known header count. The value 3 indicates
359 * the number of headers is not known.
361 #define ethernet_buffer_get_vlan_count(b) ( \
362 ((b)->flags & VNET_BUFFER_FLAGS_VLAN_BITS) >> VNET_BUFFER_F_LOG2_VLAN_1_DEEP \
365 /** Sets the number of VLAN headers in the current Ethernet frame in the
366 * buffer. Values 0, 1, 2 indicate the header count. The value 3 indicates
367 * the number of headers is not known.
369 #define ethernet_buffer_set_vlan_count(b, v) ( \
370 (b)->flags = ((b)->flags & ~VNET_BUFFER_FLAGS_VLAN_BITS) | \
371 (((v) << VNET_BUFFER_F_LOG2_VLAN_1_DEEP) & VNET_BUFFER_FLAGS_VLAN_BITS) \
374 /** Adjusts the vlan count by the delta in 'v' */
375 #define ethernet_buffer_adjust_vlan_count(b, v) ( \
376 ethernet_buffer_set_vlan_count(b, \
377 (word)ethernet_buffer_get_vlan_count(b) + (word)(v)) \
380 /** Adjusts the vlan count by the header size byte delta in 'v' */
381 #define ethernet_buffer_adjust_vlan_count_by_bytes(b, v) ( \
382 (b)->flags = ((b)->flags & ~VNET_BUFFER_FLAGS_VLAN_BITS) | (( \
383 ((b)->flags & VNET_BUFFER_FLAGS_VLAN_BITS) + \
384 ((v) << (VNET_BUFFER_F_LOG2_VLAN_1_DEEP - 2)) \
385 ) & VNET_BUFFER_FLAGS_VLAN_BITS) \
389 * Determine the size of the Ethernet headers of the current frame in
390 * the buffer. This uses the VLAN depth flags that are set by
391 * ethernet-input. Because these flags are stored in the vlib_buffer_t
392 * "flags" field this count is valid regardless of the node so long as it's
393 * checked downstream of ethernet-input; That is, the value is not stored in
396 #define ethernet_buffer_header_size(b) ( \
397 ethernet_buffer_get_vlan_count((b)) * sizeof(ethernet_vlan_header_t) + \
398 sizeof(ethernet_header_t) \
401 ethernet_main_t *ethernet_get_main (vlib_main_t * vm);
402 u32 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags);
403 void ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index,
405 void ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
406 u32 sw_if_index, u32 l2);
407 void ethernet_set_rx_redirect (vnet_main_t * vnm, vnet_hw_interface_t * hi,
411 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
412 u32 sw_if_index, void *a_arg,
413 int is_static, int is_no_fib_entry);
416 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
417 u32 sw_if_index, void *a_arg);
419 int vnet_proxy_arp_fib_reset (u32 fib_id);
421 clib_error_t *next_by_ethertype_init (next_by_ethertype_t * l3_next);
422 clib_error_t *next_by_ethertype_register (next_by_ethertype_t * l3_next,
423 u32 ethertype, u32 next_index);
425 int vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address,
426 u8 is_specified, u32 user_instance);
427 int vnet_delete_loopback_interface (u32 sw_if_index);
428 int vnet_delete_sub_interface (u32 sw_if_index);
430 // Perform ethernet subinterface classification table lookups given
431 // the ports's sw_if_index and fields extracted from the ethernet header.
432 // The resulting tables are used by identify_subint().
434 eth_vlan_table_lookups (ethernet_main_t * em,
436 u32 port_sw_if_index0,
440 vnet_hw_interface_t ** hi,
441 main_intf_t ** main_intf,
442 vlan_intf_t ** vlan_intf, qinq_intf_t ** qinq_intf)
444 vlan_table_t *vlan_table;
445 qinq_table_t *qinq_table;
448 // Read the main, vlan, and qinq interface table entries
449 // TODO: Consider if/how to prefetch tables. Also consider
450 // single-entry cache to skip table lookups and identify_subint()
452 *hi = vnet_get_sup_hw_interface (vnm, port_sw_if_index0);
453 *main_intf = vec_elt_at_index (em->main_intfs, (*hi)->hw_if_index);
455 // Always read the vlan and qinq tables, even if there are not that
456 // many tags on the packet. This makes the lookups and comparisons
457 // easier (and less branchy).
458 vlan_table_id = (first_ethertype == ETHERNET_TYPE_DOT1AD) ?
459 (*main_intf)->dot1ad_vlans : (*main_intf)->dot1q_vlans;
460 vlan_table = vec_elt_at_index (em->vlan_pool, vlan_table_id);
461 *vlan_intf = &vlan_table->vlans[outer_id];
463 qinq_table = vec_elt_at_index (em->qinq_pool, (*vlan_intf)->qinqs);
464 *qinq_intf = &qinq_table->vlans[inner_id];
468 // Determine the subinterface for this packet, given the result of the
469 // vlan table lookups and vlan header parsing. Check the most specific
471 // Returns 1 if a matching subinterface was found, otherwise returns 0.
473 eth_identify_subint (vnet_hw_interface_t * hi,
476 main_intf_t * main_intf,
477 vlan_intf_t * vlan_intf,
478 qinq_intf_t * qinq_intf,
479 u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
481 subint_config_t *subint;
483 // Each comparison is checking both the valid flag and the number of tags
484 // (incorporating exact-match/non-exact-match).
486 // check for specific double tag
487 subint = &qinq_intf->subint;
488 if ((subint->flags & match_flags) == match_flags)
491 // check for specific outer and 'any' inner
492 subint = &vlan_intf->inner_any_subint;
493 if ((subint->flags & match_flags) == match_flags)
496 // check for specific single tag
497 subint = &vlan_intf->single_tag_subint;
498 if ((subint->flags & match_flags) == match_flags)
501 // check for untagged interface
502 subint = &main_intf->untagged_subint;
503 if ((subint->flags & match_flags) == match_flags)
506 // check for default interface
507 subint = &main_intf->default_subint;
508 if ((subint->flags & match_flags) == match_flags)
511 // No matching subinterface
512 *new_sw_if_index = ~0;
513 *error0 = ETHERNET_ERROR_UNKNOWN_VLAN;
518 *new_sw_if_index = subint->sw_if_index;
519 *is_l2 = subint->flags & SUBINT_CONFIG_L2;
523 // Compare two ethernet macs. Return 1 if they are the same, 0 if different
525 eth_mac_equal (u8 * mac1, u8 * mac2)
527 return (*((u32 *) (mac1 + 0)) == *((u32 *) (mac2 + 0)) &&
528 *((u32 *) (mac1 + 2)) == *((u32 *) (mac2 + 2)));
532 always_inline ethernet_main_t *
533 vnet_get_ethernet_main (void)
535 return ðernet_main;
538 void vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
541 uword type_opaque, uword data);
544 int vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
550 uword data, int is_add);
552 void wc_arp_set_publisher_node (uword inode_index, uword event_type);
554 void ethernet_arp_change_mac (u32 sw_if_index);
555 void ethernet_ndp_change_mac (u32 sw_if_index);
557 void arp_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai);
559 void ethernet_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai);
560 u8 *ethernet_build_rewrite (vnet_main_t * vnm,
562 vnet_link_t link_type, const void *dst_address);
563 const u8 *ethernet_ip4_mcast_dst_addr (void);
564 const u8 *ethernet_ip6_mcast_dst_addr (void);
566 extern vlib_node_registration_t ethernet_input_node;
575 #endif /* included_ethernet_h */
578 * fd.io coding-style-patch-verification: ON
581 * eval: (c-set-style "gnu")