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/feature/feature.h>
48 /* ethernet-input frame flags and scalar data */
50 /* all packets in frame share same sw_if_index */
51 #define ETH_INPUT_FRAME_F_SINGLE_SW_IF_IDX (1 << 0)
53 /* all ip4 packets in frame have correct ip4 checksum */
54 #define ETH_INPUT_FRAME_F_IP4_CKSUM_OK (1 << 1)
60 } ethernet_input_frame_t;
62 #ifdef CLIB_HAVE_VEC128
63 static const u16x8 tagged_ethertypes = {
64 (u16) ETHERNET_TYPE_VLAN,
65 (u16) ETHERNET_TYPE_DOT1AD,
66 (u16) ETHERNET_TYPE_VLAN_9100,
67 (u16) ETHERNET_TYPE_VLAN_9200,
68 /* duplicate last one to fill register */
69 (u16) ETHERNET_TYPE_VLAN_9200,
70 (u16) ETHERNET_TYPE_VLAN_9200,
71 (u16) ETHERNET_TYPE_VLAN_9200,
72 (u16) ETHERNET_TYPE_VLAN_9200
76 static_always_inline int
77 ethernet_frame_is_tagged (u16 type)
79 #ifdef CLIB_HAVE_VEC128
80 return !u16x8_is_all_zero (tagged_ethertypes == u16x8_splat (type));
82 if ((type == ETHERNET_TYPE_VLAN) ||
83 (type == ETHERNET_TYPE_DOT1AD) ||
84 (type == ETHERNET_TYPE_VLAN_9100) || (type == ETHERNET_TYPE_VLAN_9200))
90 static_always_inline int
91 ethernet_frame_is_any_tagged_x2 (u16 type0, u16 type1)
93 #ifdef CLIB_HAVE_VEC128
94 u16x8 r0 = (tagged_ethertypes == u16x8_splat (type0));
95 u16x8 r1 = (tagged_ethertypes == u16x8_splat (type1));
96 return !u16x8_is_all_zero (r0 | r1);
98 return ethernet_frame_is_tagged (type0) || ethernet_frame_is_tagged (type1);
102 static_always_inline int
103 ethernet_frame_is_any_tagged_x4 (u16 type0, u16 type1, u16 type2, u16 type3)
105 #ifdef CLIB_HAVE_VEC128
106 u16x8 r0 = (tagged_ethertypes == u16x8_splat (type0));
107 u16x8 r1 = (tagged_ethertypes == u16x8_splat (type1));
108 u16x8 r2 = (tagged_ethertypes == u16x8_splat (type2));
109 u16x8 r3 = (tagged_ethertypes == u16x8_splat (type3));
110 return !u16x8_is_all_zero (r0 | r1 | r2 | r3);
112 return ethernet_frame_is_tagged (type0) || ethernet_frame_is_tagged (type1)
113 || ethernet_frame_is_tagged (type2) || ethernet_frame_is_tagged (type3);
117 /* Max. sized ethernet/vlan header for parsing. */
120 ethernet_header_t ethernet;
122 /* Allow up to 2 stacked vlan headers. */
123 ethernet_vlan_header_t vlan[2];
124 } ethernet_max_header_t;
126 struct vnet_hw_interface_t;
127 /* Ethernet flag change callback. */
128 typedef u32 (ethernet_flag_change_function_t)
129 (vnet_main_t * vnm, struct vnet_hw_interface_t * hi, u32 flags);
133 /* ethernet interface flags change */
134 ethernet_flag_change_function_t *flag_change;
136 /* set Max Frame Size callback */
137 vnet_interface_set_max_frame_size_function_t *set_max_frame_size;
138 } vnet_eth_if_callbacks_t;
140 #define ETHERNET_MIN_PACKET_BYTES 64
141 #define ETHERNET_MAX_PACKET_BYTES 9216
143 /* ethernet dataplane loads mac address as u64 for efficiency */
144 typedef union ethernet_interface_address
152 } ethernet_interface_address_t;
154 /* Ethernet interface instance. */
155 typedef struct ethernet_interface
159 /* Top 16 bits for status and bottom 16 bits for set operation */
160 #define ETHERNET_INTERFACE_FLAGS_STATUS_MASK (0xffff0000)
161 #define ETHERNET_INTERFACE_FLAGS_SET_OPN_MASK (0x0000ffff)
163 /* Interface driver/hw is in L3/non-promiscuous mode so packet DMAC
164 would already be filtered */
165 #define ETHERNET_INTERFACE_FLAG_STATUS_L3 (1 << 16)
167 /* Set interface to default L3 mode */
168 #define ETHERNET_INTERFACE_FLAG_DEFAULT_L3 0
170 /* Set interface to accept all packets (promiscuous mode). */
171 #define ETHERNET_INTERFACE_FLAG_ACCEPT_ALL 1
173 /* Callback, e.g. to turn on/off promiscuous mode */
174 vnet_eth_if_callbacks_t cb;
178 /* Ethernet (MAC) address for this interface. */
179 ethernet_interface_address_t address;
181 /* Secondary MAC addresses for this interface */
182 ethernet_interface_address_t *secondary_addrs;
183 } ethernet_interface_t;
185 extern vnet_hw_interface_class_t ethernet_hw_interface_class;
189 /* Name (a c string). */
192 /* Ethernet type in host byte order. */
193 ethernet_type_t type;
195 /* Node which handles this type. */
198 /* Next index for this type. */
200 } ethernet_type_info_t;
204 #define ethernet_error(n,c,s) ETHERNET_ERROR_##n,
205 #include <vnet/ethernet/error.def>
206 #undef ethernet_error
211 // Structs used when parsing packet to find sw_if_index
217 // config entry is-valid flag
218 // exact match flags (valid if packet has 0/1/2/3 tags)
219 // L2 vs L3 forwarding mode
220 #define SUBINT_CONFIG_MATCH_0_TAG (1<<0)
221 #define SUBINT_CONFIG_MATCH_1_TAG (1<<1)
222 #define SUBINT_CONFIG_MATCH_2_TAG (1<<2)
223 #define SUBINT_CONFIG_MATCH_3_TAG (1<<3)
224 #define SUBINT_CONFIG_VALID (1<<4)
225 #define SUBINT_CONFIG_L2 (1<<5)
226 #define SUBINT_CONFIG_P2P (1<<6)
231 eth_create_valid_subint_match_flags (u32 num_tags)
233 return SUBINT_CONFIG_VALID | (1 << num_tags);
239 subint_config_t untagged_subint;
240 subint_config_t default_subint;
241 u16 dot1q_vlans; // pool id for vlan table
242 u16 dot1ad_vlans; // pool id for vlan table
247 subint_config_t single_tag_subint;
248 subint_config_t inner_any_subint;
249 u32 qinqs; // pool id for qinq table
254 vlan_intf_t vlans[ETHERNET_N_VLAN];
259 subint_config_t subint;
264 qinq_intf_t vlans[ETHERNET_N_VLAN];
267 // Structure mapping to a next index based on ethertype.
268 // Common ethertypes are stored explicitly, others are
269 // stored in a sparse table.
272 /* Sparse vector mapping ethernet type in network byte order
274 u16 *input_next_by_type;
275 u32 *sparse_index_by_input_next_index;
277 /* cached next indexes for common ethertypes */
281 } next_by_ethertype_t;
283 struct ethernet_main_t_;
285 typedef void (ethernet_address_change_function_t)
286 (struct ethernet_main_t_ * im, u32 sw_if_index, uword opaque);
290 ethernet_address_change_function_t *function;
291 uword function_opaque;
292 } ethernet_address_change_ctx_t;
294 typedef struct ethernet_main_t_
296 vlib_main_t *vlib_main;
298 /* next node index for the L3 input node of each ethertype */
299 next_by_ethertype_t l3_next;
301 /* next node index for L2 interfaces */
304 /* flag and next node index for L3 redirect */
306 u32 redirect_l3_next;
308 /* Pool of ethernet interface instances. */
309 ethernet_interface_t *interfaces;
311 ethernet_type_info_t *type_infos;
313 /* Hash tables mapping name/type to type info index. */
314 uword *type_info_by_name, *type_info_by_type;
316 // The root of the vlan parsing tables. A vector with one element
317 // for each main interface, indexed by hw_if_index.
318 main_intf_t *main_intfs;
320 // Pool of vlan tables
321 vlan_table_t *vlan_pool;
323 // Pool of qinq tables;
324 qinq_table_t *qinq_pool;
326 /* Set to one to use AB.CD.EF instead of A:B:C:D:E:F as ethernet format. */
327 int format_ethernet_address_16bit;
329 /* debug: make sure we don't wipe out an ethernet registration by mistake */
330 u8 next_by_ethertype_register_called;
332 /* Feature arc index */
333 u8 output_feature_arc_index;
335 /* Allocated loopback instances */
336 uword *bm_loopback_instances;
338 /** Functions to call when interface hw address changes. */
339 ethernet_address_change_ctx_t *address_change_callbacks;
341 /** Default interface MTU */
346 extern ethernet_main_t ethernet_main;
348 always_inline ethernet_type_info_t *
349 ethernet_get_type_info (ethernet_main_t * em, ethernet_type_t type)
351 uword *p = hash_get (em->type_info_by_type, type);
352 return p ? vec_elt_at_index (em->type_infos, p[0]) : 0;
355 ethernet_interface_t *ethernet_get_interface (ethernet_main_t * em,
357 mac_address_t *ethernet_interface_add_del_address (ethernet_main_t * em,
362 void ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index);
364 /* Register given node index to take input for given ethernet type. */
366 ethernet_register_input_type (vlib_main_t * vm,
367 ethernet_type_t type, u32 node_index);
369 /* Register given node index to take input for packet from L2 interfaces. */
370 void ethernet_register_l2_input (vlib_main_t * vm, u32 node_index);
372 /* Register given node index to take redirected L3 traffic, and enable L3 redirect */
373 void ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index);
375 /* Formats ethernet address X:X:X:X:X:X */
376 u8 *format_mac_address (u8 * s, va_list * args);
377 u8 *format_ethernet_address (u8 * s, va_list * args);
378 u8 *format_ethernet_type (u8 * s, va_list * args);
379 u8 *format_ethernet_vlan_tci (u8 * s, va_list * va);
380 u8 *format_ethernet_header (u8 * s, va_list * args);
381 u8 *format_ethernet_header_with_length (u8 * s, va_list * args);
383 /* Parse ethernet address in either X:X:X:X:X:X unix or X.X.X cisco format. */
384 uword unformat_ethernet_address (unformat_input_t * input, va_list * args);
385 uword unformat_mac_address (unformat_input_t * input, va_list * args);
387 /* Parse ethernet type as 0xXXXX or type name from ethernet/types.def.
388 In either host or network byte order. */
390 unformat_ethernet_type_host_byte_order (unformat_input_t * input,
393 unformat_ethernet_type_net_byte_order (unformat_input_t * input,
396 /* Parse ethernet header. */
397 uword unformat_ethernet_header (unformat_input_t * input, va_list * args);
399 /* Parse ethernet interface name; return hw_if_index. */
400 uword unformat_ethernet_interface (unformat_input_t * input, va_list * args);
402 uword unformat_pg_ethernet_header (unformat_input_t * input, va_list * args);
404 void ethernet_setup_node (vlib_main_t *vm, u32 node_index);
406 always_inline ethernet_header_t *
407 ethernet_buffer_get_header (vlib_buffer_t * b)
409 return (void *) (b->data + vnet_buffer (b)->l2_hdr_offset);
412 /** Returns the number of VLAN headers in the current Ethernet frame in the
413 * buffer. Returns 0, 1, 2 for the known header count. The value 3 indicates
414 * the number of headers is not known.
416 #define ethernet_buffer_get_vlan_count(b) ( \
417 ((b)->flags & VNET_BUFFER_FLAGS_VLAN_BITS) >> VNET_BUFFER_F_LOG2_VLAN_1_DEEP \
420 /** Sets the number of VLAN headers in the current Ethernet frame in the
421 * buffer. Values 0, 1, 2 indicate the header count. The value 3 indicates
422 * the number of headers is not known.
424 #define ethernet_buffer_set_vlan_count(b, v) ( \
425 (b)->flags = ((b)->flags & ~VNET_BUFFER_FLAGS_VLAN_BITS) | \
426 (((v) << VNET_BUFFER_F_LOG2_VLAN_1_DEEP) & VNET_BUFFER_FLAGS_VLAN_BITS) \
429 /** Adjusts the vlan count by the delta in 'v' */
430 #define ethernet_buffer_adjust_vlan_count(b, v) ( \
431 ethernet_buffer_set_vlan_count(b, \
432 (word)ethernet_buffer_get_vlan_count(b) + (word)(v)) \
435 /** Adjusts the vlan count by the header size byte delta in 'v' */
436 #define ethernet_buffer_adjust_vlan_count_by_bytes(b, v) ( \
437 (b)->flags = ((b)->flags & ~VNET_BUFFER_FLAGS_VLAN_BITS) | (( \
438 ((b)->flags & VNET_BUFFER_FLAGS_VLAN_BITS) + \
439 ((v) << (VNET_BUFFER_F_LOG2_VLAN_1_DEEP - 2)) \
440 ) & VNET_BUFFER_FLAGS_VLAN_BITS) \
444 * Determine the size of the Ethernet headers of the current frame in
445 * the buffer. This uses the VLAN depth flags that are set by
446 * ethernet-input. Because these flags are stored in the vlib_buffer_t
447 * "flags" field this count is valid regardless of the node so long as it's
448 * checked downstream of ethernet-input; That is, the value is not stored in
451 #define ethernet_buffer_header_size(b) ( \
452 ethernet_buffer_get_vlan_count((b)) * sizeof(ethernet_vlan_header_t) + \
453 sizeof(ethernet_header_t) \
456 ethernet_main_t *ethernet_get_main (vlib_main_t * vm);
457 u32 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags);
458 void ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index,
460 void ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
461 u32 sw_if_index, u32 l2);
462 void ethernet_set_rx_redirect (vnet_main_t * vnm, vnet_hw_interface_t * hi,
465 clib_error_t *next_by_ethertype_init (next_by_ethertype_t * l3_next);
466 clib_error_t *next_by_ethertype_register (next_by_ethertype_t * l3_next,
467 u32 ethertype, u32 next_index);
469 int vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address,
470 u8 is_specified, u32 user_instance);
471 int vnet_delete_loopback_interface (u32 sw_if_index);
472 int vnet_create_sub_interface (u32 sw_if_index, u32 id,
473 u32 flags, u16 inner_vlan_id,
474 u16 outer_vlan_id, u32 * sub_sw_if_index);
475 int vnet_delete_sub_interface (u32 sw_if_index);
477 // Perform ethernet subinterface classification table lookups given
478 // the ports's sw_if_index and fields extracted from the ethernet header.
479 // The resulting tables are used by identify_subint().
481 eth_vlan_table_lookups (ethernet_main_t * em,
483 u32 port_sw_if_index0,
487 vnet_hw_interface_t ** hi,
488 main_intf_t ** main_intf,
489 vlan_intf_t ** vlan_intf, qinq_intf_t ** qinq_intf)
491 vlan_table_t *vlan_table;
492 qinq_table_t *qinq_table;
495 // Read the main, vlan, and qinq interface table entries
496 // TODO: Consider if/how to prefetch tables. Also consider
497 // single-entry cache to skip table lookups and identify_subint()
499 *hi = vnet_get_sup_hw_interface (vnm, port_sw_if_index0);
500 *main_intf = vec_elt_at_index (em->main_intfs, (*hi)->hw_if_index);
502 // Always read the vlan and qinq tables, even if there are not that
503 // many tags on the packet. This makes the lookups and comparisons
504 // easier (and less branchy).
505 vlan_table_id = (first_ethertype == ETHERNET_TYPE_DOT1AD) ?
506 (*main_intf)->dot1ad_vlans : (*main_intf)->dot1q_vlans;
507 vlan_table = vec_elt_at_index (em->vlan_pool, vlan_table_id);
508 *vlan_intf = &vlan_table->vlans[outer_id];
510 qinq_table = vec_elt_at_index (em->qinq_pool, (*vlan_intf)->qinqs);
511 *qinq_intf = &qinq_table->vlans[inner_id];
515 // Determine the subinterface for this packet, given the result of the
516 // vlan table lookups and vlan header parsing. Check the most specific
518 // Returns 1 if a matching subinterface was found, otherwise returns 0.
520 eth_identify_subint (vnet_hw_interface_t * hi,
522 main_intf_t * main_intf,
523 vlan_intf_t * vlan_intf,
524 qinq_intf_t * qinq_intf,
525 u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
527 subint_config_t *subint;
529 // Each comparison is checking both the valid flag and the number of tags
530 // (incorporating exact-match/non-exact-match).
532 // check for specific double tag
533 subint = &qinq_intf->subint;
534 if ((subint->flags & match_flags) == match_flags)
537 // check for specific outer and 'any' inner
538 subint = &vlan_intf->inner_any_subint;
539 if ((subint->flags & match_flags) == match_flags)
542 // check for specific single tag
543 subint = &vlan_intf->single_tag_subint;
544 if ((subint->flags & match_flags) == match_flags)
547 // check for default interface
548 subint = &main_intf->default_subint;
549 if ((subint->flags & match_flags) == match_flags)
552 // check for untagged interface
553 subint = &main_intf->untagged_subint;
554 if ((subint->flags & match_flags) == match_flags)
557 // No matching subinterface
558 *new_sw_if_index = ~0;
559 *error0 = ETHERNET_ERROR_UNKNOWN_VLAN;
564 *new_sw_if_index = subint->sw_if_index;
565 *is_l2 = subint->flags & SUBINT_CONFIG_L2;
569 always_inline ethernet_main_t *
570 vnet_get_ethernet_main (void)
572 return ðernet_main;
581 vnet_eth_if_callbacks_t cb;
583 } vnet_eth_interface_registration_t;
585 u32 vnet_eth_register_interface (vnet_main_t *vnm,
586 vnet_eth_interface_registration_t *r);
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 void ethernet_input_init (vlib_main_t * vm, ethernet_main_t * em);
593 extern vlib_node_registration_t ethernet_input_node;
595 #endif /* included_ethernet_h */
598 * fd.io coding-style-patch-verification: ON
601 * eval: (c-set-style "gnu")