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>
48 ethernet_mac_address_u64 (u8 * a)
49 { return (((u64) a[0] << (u64) (5*8))
50 | ((u64) a[1] << (u64) (4*8))
51 | ((u64) a[2] << (u64) (3*8))
52 | ((u64) a[3] << (u64) (2*8))
53 | ((u64) a[4] << (u64) (1*8))
54 | ((u64) a[5] << (u64) (0*8))); }
56 static inline int ethernet_mac_address_is_multicast_u64 (u64 a)
58 return (a & (1ULL<<(5*8))) != 0;
61 /* Max. sized ethernet/vlan header for parsing. */
63 ethernet_header_t ethernet;
65 /* Allow up to 2 stacked vlan headers. */
66 ethernet_vlan_header_t vlan[2];
67 } ethernet_max_header_t;
69 struct vnet_hw_interface_t;
70 /* Ethernet flag change callback. */
71 typedef u32 (ethernet_flag_change_function_t)
72 (vnet_main_t * vnm, struct vnet_hw_interface_t * hi, u32 flags);
74 #define ETHERNET_MIN_PACKET_BYTES 64
75 #define ETHERNET_MAX_PACKET_BYTES 9216
77 /* Ethernet interface instance. */
78 typedef struct ethernet_interface {
80 /* Accept all packets (promiscuous mode). */
81 #define ETHERNET_INTERFACE_FLAG_ACCEPT_ALL (1 << 0)
82 #define ETHERNET_INTERFACE_FLAG_CONFIG_PROMISC(flags) \
83 (((flags) & ~ETHERNET_INTERFACE_FLAG_ACCEPT_ALL) == 0)
85 /* Change MTU on interface from hw interface structure */
86 #define ETHERNET_INTERFACE_FLAG_MTU (1 << 1)
87 #define ETHERNET_INTERFACE_FLAG_CONFIG_MTU(flags) \
88 ((flags) & ETHERNET_INTERFACE_FLAG_MTU)
90 /* Callback, e.g. to turn on/off promiscuous mode */
91 ethernet_flag_change_function_t * flag_change;
95 /* Ethernet (MAC) address for this interface. */
97 } ethernet_interface_t;
99 extern vnet_hw_interface_class_t ethernet_hw_interface_class;
102 /* Name (a c string). */
105 /* Ethernet type in host byte order. */
106 ethernet_type_t type;
108 /* Node which handles this type. */
111 /* Next index for this type. */
113 } ethernet_type_info_t;
116 #define ethernet_error(n,c,s) ETHERNET_ERROR_##n,
117 #include <vnet/ethernet/error.def>
118 #undef ethernet_error
123 // Structs used when parsing packet to find sw_if_index
128 // config entry is-valid flag
129 // exact match flags (valid if packet has 0/1/2/3 tags)
130 // L2 vs L3 forwarding mode
131 #define SUBINT_CONFIG_MATCH_0_TAG (1<<0)
132 #define SUBINT_CONFIG_MATCH_1_TAG (1<<1)
133 #define SUBINT_CONFIG_MATCH_2_TAG (1<<2)
134 #define SUBINT_CONFIG_MATCH_3_TAG (1<<3)
135 #define SUBINT_CONFIG_VALID (1<<4)
136 #define SUBINT_CONFIG_L2 (1<<5)
141 eth_create_valid_subint_match_flags (u32 num_tags) {
142 return SUBINT_CONFIG_VALID | (1 << num_tags);
147 subint_config_t untagged_subint;
148 subint_config_t default_subint;
149 u16 dot1q_vlans; // pool id for vlan table
150 u16 dot1ad_vlans; // pool id for vlan table
154 subint_config_t single_tag_subint;
155 subint_config_t inner_any_subint;
156 u32 qinqs; // pool id for qinq table
160 vlan_intf_t vlans[ETHERNET_N_VLAN];
164 subint_config_t subint;
168 qinq_intf_t vlans[ETHERNET_N_VLAN];
171 // Structure mapping to a next index based on ethertype.
172 // Common ethertypes are stored explicitly, others are
173 // stored in a sparse table.
175 /* Sparse vector mapping ethernet type in network byte order
177 u16 * input_next_by_type;
178 u32 * sparse_index_by_input_next_index;
180 /* cached next indexes for common ethertypes */
184 } next_by_ethertype_t;
188 vlib_main_t * vlib_main;
190 /* next node index for the L3 input node of each ethertype */
191 next_by_ethertype_t l3_next;
193 /* next node index for L2 interfaces */
196 /* flag and next node index for L3 redirect */
198 u32 redirect_l3_next;
200 /* Pool of ethernet interface instances. */
201 ethernet_interface_t * interfaces;
203 ethernet_type_info_t * type_infos;
205 /* Hash tables mapping name/type to type info index. */
206 uword * type_info_by_name, * type_info_by_type;
208 // The root of the vlan parsing tables. A vector with one element
209 // for each main interface, indexed by hw_if_index.
210 main_intf_t * main_intfs;
212 // Pool of vlan tables
213 vlan_table_t * vlan_pool;
215 // Pool of qinq tables;
216 qinq_table_t * qinq_pool;
218 /* Set to one to use AB.CD.EF instead of A:B:C:D:E:F as ethernet format. */
219 int format_ethernet_address_16bit;
221 /* debug: make sure we don't wipe out an ethernet registration by mistake */
222 u8 next_by_ethertype_register_called;
226 ethernet_main_t ethernet_main;
228 always_inline ethernet_type_info_t *
229 ethernet_get_type_info (ethernet_main_t * em, ethernet_type_t type)
231 uword * p = hash_get (em->type_info_by_type, type);
232 return p ? vec_elt_at_index (em->type_infos, p[0]) : 0;
235 ethernet_interface_t *
236 ethernet_get_interface (ethernet_main_t * em, u32 hw_if_index);
239 ethernet_register_interface (vnet_main_t * vnm,
243 u32 * hw_if_index_return,
244 ethernet_flag_change_function_t flag_change);
246 void ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index);
248 /* Register given node index to take input for given ethernet type. */
250 ethernet_register_input_type (vlib_main_t * vm,
251 ethernet_type_t type,
254 /* Register given node index to take input for packet from L2 interfaces. */
256 ethernet_register_l2_input (vlib_main_t * vm,
259 /* Register given node index to take redirected L3 traffic, and enable L3 redirect */
261 ethernet_register_l3_redirect (vlib_main_t * vm,
264 /* Formats ethernet address X:X:X:X:X:X */
265 u8 * format_ethernet_address (u8 * s, va_list * args);
266 u8 * format_ethernet_type (u8 * s, va_list * args);
267 u8 * format_ethernet_vlan_tci (u8 * s, va_list * va);
268 u8 * format_ethernet_header (u8 * s, va_list * args);
269 u8 * format_ethernet_header_with_length (u8 * s, va_list * args);
271 /* Parse ethernet address in either X:X:X:X:X:X unix or X.X.X cisco format. */
273 unformat_ethernet_address (unformat_input_t * input, va_list * args);
275 /* Parse ethernet type as 0xXXXX or type name from ethernet/types.def.
276 In either host or network byte order. */
278 unformat_ethernet_type_host_byte_order (unformat_input_t * input,
281 unformat_ethernet_type_net_byte_order (unformat_input_t * input,
284 /* Parse ethernet header. */
286 unformat_ethernet_header (unformat_input_t * input, va_list * args);
288 /* Parse ethernet interface name; return hw_if_index. */
289 uword unformat_ethernet_interface (unformat_input_t * input, va_list * args);
291 uword unformat_pg_ethernet_header (unformat_input_t * input, va_list * args);
294 ethernet_setup_node (vlib_main_t * vm, u32 node_index)
296 vlib_node_t * n = vlib_get_node (vm, node_index);
297 pg_node_t * pn = pg_get_node (node_index);
299 n->format_buffer = format_ethernet_header_with_length;
300 n->unformat_buffer = unformat_ethernet_header;
301 pn->unformat_edit = unformat_pg_ethernet_header;
304 always_inline ethernet_header_t *
305 ethernet_buffer_get_header (vlib_buffer_t * b)
309 + vnet_buffer (b)->ethernet.start_of_ethernet_header);
312 /** Returns the number of VLAN headers in the current Ethernet frame in the
313 * buffer. Returns 0, 1, 2 for the known header count. The value 3 indicates
314 * the number of headers is not known.
316 #define ethernet_buffer_get_vlan_count(b) ( \
317 ((b)->flags & ETH_BUFFER_VLAN_BITS) >> LOG2_ETH_BUFFER_VLAN_1_DEEP \
320 /** Sets the number of VLAN headers in the current Ethernet frame in the
321 * buffer. Values 0, 1, 2 indicate the header count. The value 3 indicates
322 * the number of headers is not known.
324 #define ethernet_buffer_set_vlan_count(b, v) ( \
325 (b)->flags = ((b)->flags & ~ETH_BUFFER_VLAN_BITS) | \
326 (((v) << LOG2_ETH_BUFFER_VLAN_1_DEEP) & ETH_BUFFER_VLAN_BITS) \
329 /** Adjusts the vlan count by the delta in 'v' */
330 #define ethernet_buffer_adjust_vlan_count(b, v) ( \
331 ethernet_buffer_set_vlan_count(b, \
332 (word)ethernet_buffer_get_vlan_count(b) + (word)(v)) \
335 /** Adjusts the vlan count by the header size byte delta in 'v' */
336 #define ethernet_buffer_adjust_vlan_count_by_bytes(b, v) ( \
337 (b)->flags = ((b)->flags & ~ETH_BUFFER_VLAN_BITS) | (( \
338 ((b)->flags & ETH_BUFFER_VLAN_BITS) + \
339 ((v) << (LOG2_ETH_BUFFER_VLAN_1_DEEP - 2)) \
340 ) & ETH_BUFFER_VLAN_BITS) \
344 * Determine the size of the Ethernet headers of the current frame in
345 * the buffer. This uses the VLAN depth flags that are set by
346 * ethernet-input. Because these flags are stored in the vlib_buffer_t
347 * "flags" field this count is valid regardless of the node so long as it's
348 * checked downstream of ethernet-input; That is, the value is not stored in
351 #define ethernet_buffer_header_size(b) ( \
352 ethernet_buffer_get_vlan_count((b)) * sizeof(ethernet_vlan_header_t) + \
353 sizeof(ethernet_header_t) \
356 ethernet_main_t * ethernet_get_main (vlib_main_t * vm);
357 u32 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags);
358 void ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index, u32 l2);
359 void ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm, u32 sw_if_index, u32 l2);
360 void ethernet_set_rx_redirect (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 enable);
363 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
370 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
371 u32 sw_if_index, u32 fib_index,
374 int vnet_proxy_arp_fib_reset (u32 fib_id);
376 clib_error_t * next_by_ethertype_init (next_by_ethertype_t * l3_next);
377 clib_error_t * next_by_ethertype_register (next_by_ethertype_t * l3_next,
381 int vnet_create_loopback_interface (u32 * sw_if_indexp, u8 *mac_address);
382 int vnet_delete_loopback_interface (u32 sw_if_index);
384 // Perform ethernet subinterface classification table lookups given
385 // the ports's sw_if_index and fields extracted from the ethernet header.
386 // The resulting tables are used by identify_subint().
388 eth_vlan_table_lookups (ethernet_main_t *em,
390 u32 port_sw_if_index0,
394 vnet_hw_interface_t ** hi,
395 main_intf_t **main_intf,
396 vlan_intf_t **vlan_intf,
397 qinq_intf_t **qinq_intf)
399 vlan_table_t *vlan_table;
400 qinq_table_t *qinq_table;
403 // Read the main, vlan, and qinq interface table entries
404 // TODO: Consider if/how to prefetch tables. Also consider
405 // single-entry cache to skip table lookups and identify_subint()
407 *hi = vnet_get_sup_hw_interface (vnm, port_sw_if_index0);
408 *main_intf = vec_elt_at_index (em->main_intfs, (*hi)->hw_if_index);
410 // Always read the vlan and qinq tables, even if there are not that
411 // many tags on the packet. This makes the lookups and comparisons
412 // easier (and less branchy).
413 vlan_table_id = (first_ethertype == ETHERNET_TYPE_DOT1AD) ?
414 (*main_intf)->dot1ad_vlans :
415 (*main_intf)->dot1q_vlans;
416 vlan_table = vec_elt_at_index (em->vlan_pool, vlan_table_id);
417 *vlan_intf = &vlan_table->vlans[outer_id];
419 qinq_table = vec_elt_at_index (em->qinq_pool, (*vlan_intf)->qinqs);
420 *qinq_intf = &qinq_table->vlans[inner_id];
424 // Determine the subinterface for this packet, given the result of the
425 // vlan table lookups and vlan header parsing. Check the most specific
427 // Returns 1 if a matching subinterface was found, otherwise returns 0.
429 eth_identify_subint (vnet_hw_interface_t * hi,
432 main_intf_t * main_intf,
433 vlan_intf_t * vlan_intf,
434 qinq_intf_t * qinq_intf,
435 u32 * new_sw_if_index,
439 subint_config_t * subint;
441 // Each comparison is checking both the valid flag and the number of tags
442 // (incorporating exact-match/non-exact-match).
444 // check for specific double tag
445 subint = &qinq_intf->subint;
446 if ((subint->flags & match_flags) == match_flags) goto matched;
448 // check for specific outer and 'any' inner
449 subint = &vlan_intf->inner_any_subint;
450 if ((subint->flags & match_flags) == match_flags) goto matched;
452 // check for specific single tag
453 subint = &vlan_intf->single_tag_subint;
454 if ((subint->flags & match_flags) == match_flags) goto matched;
456 // check for untagged interface
457 subint = &main_intf->untagged_subint;
458 if ((subint->flags & match_flags) == match_flags) goto matched;
460 // check for default interface
461 subint = &main_intf->default_subint;
462 if ((subint->flags & match_flags) == match_flags) goto matched;
464 // No matching subinterface
465 *new_sw_if_index = ~0;
466 *error0 = ETHERNET_ERROR_UNKNOWN_VLAN;
471 *new_sw_if_index = subint->sw_if_index;
472 *is_l2 = subint->flags & SUBINT_CONFIG_L2;
476 // Compare two ethernet macs. Return 1 if they are the same, 0 if different
478 eth_mac_equal (u8 * mac1, u8 * mac2) {
479 return (*((u32 *)(mac1+0)) == *((u32 *)(mac2+0)) &&
480 *((u32 *)(mac1+2)) == *((u32 *)(mac2+2)));
484 always_inline ethernet_main_t *
485 vnet_get_ethernet_main (void)
487 return ðernet_main;
490 void vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
497 int vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
498 void * data_callback,
503 uword data, int is_add);
505 u32 vnet_arp_glean_add(u32 fib_index, void * next_hop_arg);
507 extern vlib_node_registration_t ethernet_input_node;
509 #endif /* included_ethernet_h */