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/ethernet/mac_address.h>
46 #include <vnet/pg/pg.h>
47 #include <vnet/feature/feature.h>
49 /* ethernet-input frame flags and scalar data */
51 /* all packets in frame share same sw_if_index */
52 #define ETH_INPUT_FRAME_F_SINGLE_SW_IF_IDX (1 << 0)
54 /* all ip4 packets in frame have correct ip4 checksum */
55 #define ETH_INPUT_FRAME_F_IP4_CKSUM_OK (1 << 1)
61 } ethernet_input_frame_t;
63 #ifdef CLIB_HAVE_VEC128
64 static const u16x8 tagged_ethertypes = {
65 (u16) ETHERNET_TYPE_VLAN,
66 (u16) ETHERNET_TYPE_DOT1AD,
67 (u16) ETHERNET_TYPE_VLAN_9100,
68 (u16) ETHERNET_TYPE_VLAN_9200,
69 /* duplicate last one to fill register */
70 (u16) ETHERNET_TYPE_VLAN_9200,
71 (u16) ETHERNET_TYPE_VLAN_9200,
72 (u16) ETHERNET_TYPE_VLAN_9200,
73 (u16) ETHERNET_TYPE_VLAN_9200
77 static_always_inline int
78 ethernet_frame_is_tagged (u16 type)
80 #ifdef CLIB_HAVE_VEC128
81 return !u16x8_is_all_zero (tagged_ethertypes == u16x8_splat (type));
83 if ((type == ETHERNET_TYPE_VLAN) ||
84 (type == ETHERNET_TYPE_DOT1AD) ||
85 (type == ETHERNET_TYPE_VLAN_9100) || (type == ETHERNET_TYPE_VLAN_9200))
91 static_always_inline int
92 ethernet_frame_is_any_tagged_x2 (u16 type0, u16 type1)
94 #ifdef CLIB_HAVE_VEC128
95 u16x8 r0 = (tagged_ethertypes == u16x8_splat (type0));
96 u16x8 r1 = (tagged_ethertypes == u16x8_splat (type1));
97 return !u16x8_is_all_zero (r0 | r1);
99 return ethernet_frame_is_tagged (type0) || ethernet_frame_is_tagged (type1);
103 static_always_inline int
104 ethernet_frame_is_any_tagged_x4 (u16 type0, u16 type1, u16 type2, u16 type3)
106 #ifdef CLIB_HAVE_VEC128
107 u16x8 r0 = (tagged_ethertypes == u16x8_splat (type0));
108 u16x8 r1 = (tagged_ethertypes == u16x8_splat (type1));
109 u16x8 r2 = (tagged_ethertypes == u16x8_splat (type2));
110 u16x8 r3 = (tagged_ethertypes == u16x8_splat (type3));
111 return !u16x8_is_all_zero (r0 | r1 | r2 | r3);
113 return ethernet_frame_is_tagged (type0) || ethernet_frame_is_tagged (type1)
114 || ethernet_frame_is_tagged (type2) || ethernet_frame_is_tagged (type3);
118 /* Max. sized ethernet/vlan header for parsing. */
121 ethernet_header_t ethernet;
123 /* Allow up to 2 stacked vlan headers. */
124 ethernet_vlan_header_t vlan[2];
125 } ethernet_max_header_t;
127 struct vnet_hw_interface_t;
128 /* Ethernet flag change callback. */
129 typedef u32 (ethernet_flag_change_function_t)
130 (vnet_main_t * vnm, struct vnet_hw_interface_t * hi, u32 flags);
132 #define ETHERNET_MIN_PACKET_BYTES 64
133 #define ETHERNET_MAX_PACKET_BYTES 9216
135 /* Ethernet interface instance. */
136 typedef struct ethernet_interface
140 /* Accept all packets (promiscuous mode). */
141 #define ETHERNET_INTERFACE_FLAG_ACCEPT_ALL (1 << 0)
142 #define ETHERNET_INTERFACE_FLAG_CONFIG_PROMISC(flags) \
143 (((flags) & ~ETHERNET_INTERFACE_FLAG_ACCEPT_ALL) == 0)
145 /* Change MTU on interface from hw interface structure */
146 #define ETHERNET_INTERFACE_FLAG_MTU (1 << 1)
147 #define ETHERNET_INTERFACE_FLAG_CONFIG_MTU(flags) \
148 ((flags) & ETHERNET_INTERFACE_FLAG_MTU)
150 /* Callback, e.g. to turn on/off promiscuous mode */
151 ethernet_flag_change_function_t *flag_change;
155 /* Ethernet (MAC) address for this interface. */
158 /* Secondary MAC addresses for this interface */
159 mac_address_t *secondary_addrs;
160 } ethernet_interface_t;
162 extern vnet_hw_interface_class_t ethernet_hw_interface_class;
166 /* Name (a c string). */
169 /* Ethernet type in host byte order. */
170 ethernet_type_t type;
172 /* Node which handles this type. */
175 /* Next index for this type. */
177 } ethernet_type_info_t;
181 #define ethernet_error(n,c,s) ETHERNET_ERROR_##n,
182 #include <vnet/ethernet/error.def>
183 #undef ethernet_error
188 // Structs used when parsing packet to find sw_if_index
194 // config entry is-valid flag
195 // exact match flags (valid if packet has 0/1/2/3 tags)
196 // L2 vs L3 forwarding mode
197 #define SUBINT_CONFIG_MATCH_0_TAG (1<<0)
198 #define SUBINT_CONFIG_MATCH_1_TAG (1<<1)
199 #define SUBINT_CONFIG_MATCH_2_TAG (1<<2)
200 #define SUBINT_CONFIG_MATCH_3_TAG (1<<3)
201 #define SUBINT_CONFIG_VALID (1<<4)
202 #define SUBINT_CONFIG_L2 (1<<5)
203 #define SUBINT_CONFIG_P2P (1<<6)
208 eth_create_valid_subint_match_flags (u32 num_tags)
210 return SUBINT_CONFIG_VALID | (1 << num_tags);
216 subint_config_t untagged_subint;
217 subint_config_t default_subint;
218 u16 dot1q_vlans; // pool id for vlan table
219 u16 dot1ad_vlans; // pool id for vlan table
224 subint_config_t single_tag_subint;
225 subint_config_t inner_any_subint;
226 u32 qinqs; // pool id for qinq table
231 vlan_intf_t vlans[ETHERNET_N_VLAN];
236 subint_config_t subint;
241 qinq_intf_t vlans[ETHERNET_N_VLAN];
244 // Structure mapping to a next index based on ethertype.
245 // Common ethertypes are stored explicitly, others are
246 // stored in a sparse table.
249 /* Sparse vector mapping ethernet type in network byte order
251 u16 *input_next_by_type;
252 u32 *sparse_index_by_input_next_index;
254 /* cached next indexes for common ethertypes */
258 } next_by_ethertype_t;
260 struct ethernet_main_t_;
262 typedef void (ethernet_address_change_function_t)
263 (struct ethernet_main_t_ * im, u32 sw_if_index, uword opaque);
267 ethernet_address_change_function_t *function;
268 uword function_opaque;
269 } ethernet_address_change_ctx_t;
271 typedef struct ethernet_main_t_
273 vlib_main_t *vlib_main;
275 /* next node index for the L3 input node of each ethertype */
276 next_by_ethertype_t l3_next;
278 /* next node index for L2 interfaces */
281 /* flag and next node index for L3 redirect */
283 u32 redirect_l3_next;
285 /* Pool of ethernet interface instances. */
286 ethernet_interface_t *interfaces;
288 ethernet_type_info_t *type_infos;
290 /* Hash tables mapping name/type to type info index. */
291 uword *type_info_by_name, *type_info_by_type;
293 // The root of the vlan parsing tables. A vector with one element
294 // for each main interface, indexed by hw_if_index.
295 main_intf_t *main_intfs;
297 // Pool of vlan tables
298 vlan_table_t *vlan_pool;
300 // Pool of qinq tables;
301 qinq_table_t *qinq_pool;
303 /* Set to one to use AB.CD.EF instead of A:B:C:D:E:F as ethernet format. */
304 int format_ethernet_address_16bit;
306 /* debug: make sure we don't wipe out an ethernet registration by mistake */
307 u8 next_by_ethertype_register_called;
309 /* Feature arc index */
310 u8 output_feature_arc_index;
312 /* Allocated loopback instances */
313 uword *bm_loopback_instances;
315 /** Functions to call when interface hw address changes. */
316 ethernet_address_change_ctx_t *address_change_callbacks;
320 extern ethernet_main_t ethernet_main;
322 always_inline ethernet_type_info_t *
323 ethernet_get_type_info (ethernet_main_t * em, ethernet_type_t type)
325 uword *p = hash_get (em->type_info_by_type, type);
326 return p ? vec_elt_at_index (em->type_infos, p[0]) : 0;
329 ethernet_interface_t *ethernet_get_interface (ethernet_main_t * em,
331 mac_address_t *ethernet_interface_add_del_address (ethernet_main_t * em,
336 clib_error_t *ethernet_register_interface (vnet_main_t * vnm,
340 u32 * hw_if_index_return,
341 ethernet_flag_change_function_t
344 void ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index);
346 /* Register given node index to take input for given ethernet type. */
348 ethernet_register_input_type (vlib_main_t * vm,
349 ethernet_type_t type, u32 node_index);
351 /* Register given node index to take input for packet from L2 interfaces. */
352 void ethernet_register_l2_input (vlib_main_t * vm, u32 node_index);
354 /* Register given node index to take redirected L3 traffic, and enable L3 redirect */
355 void ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index);
357 /* Formats ethernet address X:X:X:X:X:X */
358 u8 *format_mac_address (u8 * s, va_list * args);
359 u8 *format_ethernet_address (u8 * s, va_list * args);
360 u8 *format_ethernet_type (u8 * s, va_list * args);
361 u8 *format_ethernet_vlan_tci (u8 * s, va_list * va);
362 u8 *format_ethernet_header (u8 * s, va_list * args);
363 u8 *format_ethernet_header_with_length (u8 * s, va_list * args);
365 /* Parse ethernet address in either X:X:X:X:X:X unix or X.X.X cisco format. */
366 uword unformat_ethernet_address (unformat_input_t * input, va_list * args);
367 uword unformat_mac_address (unformat_input_t * input, va_list * args);
369 /* Parse ethernet type as 0xXXXX or type name from ethernet/types.def.
370 In either host or network byte order. */
372 unformat_ethernet_type_host_byte_order (unformat_input_t * input,
375 unformat_ethernet_type_net_byte_order (unformat_input_t * input,
378 /* Parse ethernet header. */
379 uword unformat_ethernet_header (unformat_input_t * input, va_list * args);
381 /* Parse ethernet interface name; return hw_if_index. */
382 uword unformat_ethernet_interface (unformat_input_t * input, va_list * args);
384 uword unformat_pg_ethernet_header (unformat_input_t * input, va_list * args);
387 ethernet_setup_node (vlib_main_t * vm, u32 node_index)
389 vlib_node_t *n = vlib_get_node (vm, node_index);
390 pg_node_t *pn = pg_get_node (node_index);
392 n->format_buffer = format_ethernet_header_with_length;
393 n->unformat_buffer = unformat_ethernet_header;
394 pn->unformat_edit = unformat_pg_ethernet_header;
397 always_inline ethernet_header_t *
398 ethernet_buffer_get_header (vlib_buffer_t * b)
400 return (void *) (b->data + vnet_buffer (b)->l2_hdr_offset);
403 /** Returns the number of VLAN headers in the current Ethernet frame in the
404 * buffer. Returns 0, 1, 2 for the known header count. The value 3 indicates
405 * the number of headers is not known.
407 #define ethernet_buffer_get_vlan_count(b) ( \
408 ((b)->flags & VNET_BUFFER_FLAGS_VLAN_BITS) >> VNET_BUFFER_F_LOG2_VLAN_1_DEEP \
411 /** Sets the number of VLAN headers in the current Ethernet frame in the
412 * buffer. Values 0, 1, 2 indicate the header count. The value 3 indicates
413 * the number of headers is not known.
415 #define ethernet_buffer_set_vlan_count(b, v) ( \
416 (b)->flags = ((b)->flags & ~VNET_BUFFER_FLAGS_VLAN_BITS) | \
417 (((v) << VNET_BUFFER_F_LOG2_VLAN_1_DEEP) & VNET_BUFFER_FLAGS_VLAN_BITS) \
420 /** Adjusts the vlan count by the delta in 'v' */
421 #define ethernet_buffer_adjust_vlan_count(b, v) ( \
422 ethernet_buffer_set_vlan_count(b, \
423 (word)ethernet_buffer_get_vlan_count(b) + (word)(v)) \
426 /** Adjusts the vlan count by the header size byte delta in 'v' */
427 #define ethernet_buffer_adjust_vlan_count_by_bytes(b, v) ( \
428 (b)->flags = ((b)->flags & ~VNET_BUFFER_FLAGS_VLAN_BITS) | (( \
429 ((b)->flags & VNET_BUFFER_FLAGS_VLAN_BITS) + \
430 ((v) << (VNET_BUFFER_F_LOG2_VLAN_1_DEEP - 2)) \
431 ) & VNET_BUFFER_FLAGS_VLAN_BITS) \
435 * Determine the size of the Ethernet headers of the current frame in
436 * the buffer. This uses the VLAN depth flags that are set by
437 * ethernet-input. Because these flags are stored in the vlib_buffer_t
438 * "flags" field this count is valid regardless of the node so long as it's
439 * checked downstream of ethernet-input; That is, the value is not stored in
442 #define ethernet_buffer_header_size(b) ( \
443 ethernet_buffer_get_vlan_count((b)) * sizeof(ethernet_vlan_header_t) + \
444 sizeof(ethernet_header_t) \
447 ethernet_main_t *ethernet_get_main (vlib_main_t * vm);
448 u32 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags);
449 void ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index,
451 void ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
452 u32 sw_if_index, u32 l2);
453 void ethernet_set_rx_redirect (vnet_main_t * vnm, vnet_hw_interface_t * hi,
456 clib_error_t *next_by_ethertype_init (next_by_ethertype_t * l3_next);
457 clib_error_t *next_by_ethertype_register (next_by_ethertype_t * l3_next,
458 u32 ethertype, u32 next_index);
460 int vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address,
461 u8 is_specified, u32 user_instance);
462 int vnet_delete_loopback_interface (u32 sw_if_index);
463 int vnet_create_sub_interface (u32 sw_if_index, u32 id,
464 u32 flags, u16 inner_vlan_id,
465 u16 outer_vlan_id, u32 * sub_sw_if_index);
466 int vnet_delete_sub_interface (u32 sw_if_index);
468 // Perform ethernet subinterface classification table lookups given
469 // the ports's sw_if_index and fields extracted from the ethernet header.
470 // The resulting tables are used by identify_subint().
472 eth_vlan_table_lookups (ethernet_main_t * em,
474 u32 port_sw_if_index0,
478 vnet_hw_interface_t ** hi,
479 main_intf_t ** main_intf,
480 vlan_intf_t ** vlan_intf, qinq_intf_t ** qinq_intf)
482 vlan_table_t *vlan_table;
483 qinq_table_t *qinq_table;
486 // Read the main, vlan, and qinq interface table entries
487 // TODO: Consider if/how to prefetch tables. Also consider
488 // single-entry cache to skip table lookups and identify_subint()
490 *hi = vnet_get_sup_hw_interface (vnm, port_sw_if_index0);
491 *main_intf = vec_elt_at_index (em->main_intfs, (*hi)->hw_if_index);
493 // Always read the vlan and qinq tables, even if there are not that
494 // many tags on the packet. This makes the lookups and comparisons
495 // easier (and less branchy).
496 vlan_table_id = (first_ethertype == ETHERNET_TYPE_DOT1AD) ?
497 (*main_intf)->dot1ad_vlans : (*main_intf)->dot1q_vlans;
498 vlan_table = vec_elt_at_index (em->vlan_pool, vlan_table_id);
499 *vlan_intf = &vlan_table->vlans[outer_id];
501 qinq_table = vec_elt_at_index (em->qinq_pool, (*vlan_intf)->qinqs);
502 *qinq_intf = &qinq_table->vlans[inner_id];
506 // Determine the subinterface for this packet, given the result of the
507 // vlan table lookups and vlan header parsing. Check the most specific
509 // Returns 1 if a matching subinterface was found, otherwise returns 0.
511 eth_identify_subint (vnet_hw_interface_t * hi,
513 main_intf_t * main_intf,
514 vlan_intf_t * vlan_intf,
515 qinq_intf_t * qinq_intf,
516 u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
518 subint_config_t *subint;
520 // Each comparison is checking both the valid flag and the number of tags
521 // (incorporating exact-match/non-exact-match).
523 // check for specific double tag
524 subint = &qinq_intf->subint;
525 if ((subint->flags & match_flags) == match_flags)
528 // check for specific outer and 'any' inner
529 subint = &vlan_intf->inner_any_subint;
530 if ((subint->flags & match_flags) == match_flags)
533 // check for specific single tag
534 subint = &vlan_intf->single_tag_subint;
535 if ((subint->flags & match_flags) == match_flags)
538 // check for default interface
539 subint = &main_intf->default_subint;
540 if ((subint->flags & match_flags) == match_flags)
543 // check for untagged interface
544 subint = &main_intf->untagged_subint;
545 if ((subint->flags & match_flags) == match_flags)
548 // No matching subinterface
549 *new_sw_if_index = ~0;
550 *error0 = ETHERNET_ERROR_UNKNOWN_VLAN;
555 *new_sw_if_index = subint->sw_if_index;
556 *is_l2 = subint->flags & SUBINT_CONFIG_L2;
560 always_inline ethernet_main_t *
561 vnet_get_ethernet_main (void)
563 return ðernet_main;
566 void ethernet_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai);
567 u8 *ethernet_build_rewrite (vnet_main_t * vnm,
569 vnet_link_t link_type, const void *dst_address);
570 void ethernet_input_init (vlib_main_t * vm, ethernet_main_t * em);
572 extern vlib_node_registration_t ethernet_input_node;
574 #endif /* included_ethernet_h */
577 * fd.io coding-style-patch-verification: ON
580 * eval: (c-set-style "gnu")