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_node.c: ethernet packet processing
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 #include <vlib/vlib.h>
41 #include <vnet/pg/pg.h>
42 #include <vnet/ethernet/ethernet.h>
43 #include <vppinfra/sparse_vec.h>
44 #include <vnet/l2/l2_bvi.h>
47 #define foreach_ethernet_input_next \
48 _ (PUNT, "error-punt") \
49 _ (DROP, "error-drop") \
54 #define _(s,n) ETHERNET_INPUT_NEXT_##s,
55 foreach_ethernet_input_next
57 ETHERNET_INPUT_N_NEXT,
58 } ethernet_input_next_t;
63 } ethernet_input_trace_t;
66 format_ethernet_input_trace (u8 * s, va_list * va)
68 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
69 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
70 ethernet_input_trace_t *t = va_arg (*va, ethernet_input_trace_t *);
72 s = format (s, "%U", format_ethernet_header, t->packet_data);
77 vlib_node_registration_t ethernet_input_node;
81 ETHERNET_INPUT_VARIANT_ETHERNET,
82 ETHERNET_INPUT_VARIANT_ETHERNET_TYPE,
83 ETHERNET_INPUT_VARIANT_NOT_L2,
84 } ethernet_input_variant_t;
87 // Parse the ethernet header to extract vlan tags and innermost ethertype
88 static_always_inline void
89 parse_header (ethernet_input_variant_t variant,
93 u16 * outer_id, u16 * inner_id, u32 * match_flags)
97 if (variant == ETHERNET_INPUT_VARIANT_ETHERNET
98 || variant == ETHERNET_INPUT_VARIANT_NOT_L2)
100 ethernet_header_t *e0;
102 e0 = (void *) (b0->data + b0->current_data);
104 vnet_buffer (b0)->ethernet.start_of_ethernet_header = b0->current_data;
106 vlib_buffer_advance (b0, sizeof (e0[0]));
108 *type = clib_net_to_host_u16 (e0->type);
110 else if (variant == ETHERNET_INPUT_VARIANT_ETHERNET_TYPE)
112 // here when prior node was LLC/SNAP processing
115 e0 = (void *) (b0->data + b0->current_data);
117 vlib_buffer_advance (b0, sizeof (e0[0]));
119 *type = clib_net_to_host_u16 (e0[0]);
122 // save for distinguishing between dot1q and dot1ad later
125 // default the tags to 0 (used if there is no corresponding tag)
129 *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_0_TAG;
132 // check for vlan encaps
133 if (ethernet_frame_is_tagged (*type))
135 ethernet_vlan_header_t *h0;
138 *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_1_TAG;
140 h0 = (void *) (b0->data + b0->current_data);
142 tag = clib_net_to_host_u16 (h0->priority_cfi_and_id);
144 *outer_id = tag & 0xfff;
146 *match_flags &= ~SUBINT_CONFIG_MATCH_1_TAG;
148 *type = clib_net_to_host_u16 (h0->type);
150 vlib_buffer_advance (b0, sizeof (h0[0]));
153 if (*type == ETHERNET_TYPE_VLAN)
155 // Double tagged packet
156 *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_2_TAG;
158 h0 = (void *) (b0->data + b0->current_data);
160 tag = clib_net_to_host_u16 (h0->priority_cfi_and_id);
162 *inner_id = tag & 0xfff;
164 *type = clib_net_to_host_u16 (h0->type);
166 vlib_buffer_advance (b0, sizeof (h0[0]));
168 if (*type == ETHERNET_TYPE_VLAN)
170 // More than double tagged packet
171 *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_3_TAG;
173 vlib_buffer_advance (b0, sizeof (h0[0]));
174 vlan_count = 3; // "unknown" number, aka, 3-or-more
178 ethernet_buffer_set_vlan_count (b0, vlan_count);
181 // Determine the subinterface for this packet, given the result of the
182 // vlan table lookups and vlan header parsing. Check the most specific
184 static_always_inline void
185 identify_subint (vnet_hw_interface_t * hi,
188 main_intf_t * main_intf,
189 vlan_intf_t * vlan_intf,
190 qinq_intf_t * qinq_intf,
191 u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
195 matched = eth_identify_subint (hi, b0, match_flags,
196 main_intf, vlan_intf, qinq_intf,
197 new_sw_if_index, error0, is_l2);
202 // Perform L3 my-mac filter
203 // A unicast packet arriving on an L3 interface must have a dmac matching the interface mac.
204 // This is required for promiscuous mode, else we will forward packets we aren't supposed to.
207 ethernet_header_t *e0;
210 vnet_buffer (b0)->ethernet.start_of_ethernet_header);
212 if (!(ethernet_address_cast (e0->dst_address)))
214 if (!eth_mac_equal ((u8 *) e0, hi->hw_address))
216 *error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
221 // Check for down subinterface
222 *error0 = (*new_sw_if_index) != ~0 ? (*error0) : ETHERNET_ERROR_DOWN;
226 static_always_inline void
227 determine_next_node (ethernet_main_t * em,
228 ethernet_input_variant_t variant,
230 u32 type0, vlib_buffer_t * b0, u8 * error0, u8 * next0)
232 if (PREDICT_FALSE (*error0 != ETHERNET_ERROR_NONE))
234 // some error occurred
235 *next0 = ETHERNET_INPUT_NEXT_DROP;
239 *next0 = em->l2_next;
240 // record the L2 len and reset the buffer so the L2 header is preserved
241 u32 eth_start = vnet_buffer (b0)->ethernet.start_of_ethernet_header;
242 vnet_buffer (b0)->l2.l2_len = b0->current_data - eth_start;
243 ASSERT (vnet_buffer (b0)->l2.l2_len ==
244 ethernet_buffer_header_size (b0));
245 vlib_buffer_advance (b0, -ethernet_buffer_header_size (b0));
247 // check for common IP/MPLS ethertypes
249 else if (type0 == ETHERNET_TYPE_IP4)
251 *next0 = em->l3_next.input_next_ip4;
253 else if (type0 == ETHERNET_TYPE_IP6)
255 *next0 = em->l3_next.input_next_ip6;
257 else if (type0 == ETHERNET_TYPE_MPLS)
259 *next0 = em->l3_next.input_next_mpls;
262 else if (em->redirect_l3)
264 // L3 Redirect is on, the cached common next nodes will be
265 // pointing to the redirect node, catch the uncommon types here
266 *next0 = em->redirect_l3_next;
270 // uncommon ethertype, check table
272 i0 = sparse_vec_index (em->l3_next.input_next_by_type, type0);
273 *next0 = vec_elt (em->l3_next.input_next_by_type, i0);
276 SPARSE_VEC_INVALID_INDEX ? ETHERNET_ERROR_UNKNOWN_TYPE : *error0;
278 // The table is not populated with LLC values, so check that now.
279 // If variant is variant_ethernet then we came from LLC processing. Don't
280 // go back there; drop instead using by keeping the drop/bad table result.
281 if ((type0 < 0x600) && (variant == ETHERNET_INPUT_VARIANT_ETHERNET))
283 *next0 = ETHERNET_INPUT_NEXT_LLC;
288 static_always_inline uword
289 ethernet_input_inline (vlib_main_t * vm,
290 vlib_node_runtime_t * node,
291 vlib_frame_t * from_frame,
292 ethernet_input_variant_t variant)
294 vnet_main_t *vnm = vnet_get_main ();
295 ethernet_main_t *em = ðernet_main;
296 vlib_node_runtime_t *error_node;
297 u32 n_left_from, next_index, *from, *to_next;
298 u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
299 u32 thread_index = vlib_get_thread_index ();
300 u32 cached_sw_if_index = ~0;
301 u32 cached_is_l2 = 0; /* shut up gcc */
302 vnet_hw_interface_t *hi = NULL; /* used for main interface only */
304 if (variant != ETHERNET_INPUT_VARIANT_ETHERNET)
305 error_node = vlib_node_get_runtime (vm, ethernet_input_node.index);
309 from = vlib_frame_vector_args (from_frame);
310 n_left_from = from_frame->n_vectors;
312 if (node->flags & VLIB_NODE_FLAG_TRACE)
313 vlib_trace_frame_buffers_only (vm, node,
317 sizeof (ethernet_input_trace_t));
319 next_index = node->cached_next_index;
320 stats_sw_if_index = node->runtime_data[0];
321 stats_n_packets = stats_n_bytes = 0;
323 while (n_left_from > 0)
327 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
329 while (n_left_from >= 4 && n_left_to_next >= 2)
332 vlib_buffer_t *b0, *b1;
333 u8 next0, next1, error0, error1;
334 u16 type0, orig_type0, type1, orig_type1;
335 u16 outer_id0, inner_id0, outer_id1, inner_id1;
336 u32 match_flags0, match_flags1;
337 u32 old_sw_if_index0, new_sw_if_index0, len0, old_sw_if_index1,
338 new_sw_if_index1, len1;
339 vnet_hw_interface_t *hi0, *hi1;
340 main_intf_t *main_intf0, *main_intf1;
341 vlan_intf_t *vlan_intf0, *vlan_intf1;
342 qinq_intf_t *qinq_intf0, *qinq_intf1;
344 ethernet_header_t *e0, *e1;
346 /* Prefetch next iteration. */
348 vlib_buffer_t *b2, *b3;
350 b2 = vlib_get_buffer (vm, from[2]);
351 b3 = vlib_get_buffer (vm, from[3]);
353 vlib_prefetch_buffer_header (b2, STORE);
354 vlib_prefetch_buffer_header (b3, STORE);
356 CLIB_PREFETCH (b2->data, sizeof (ethernet_header_t), LOAD);
357 CLIB_PREFETCH (b3->data, sizeof (ethernet_header_t), LOAD);
369 b0 = vlib_get_buffer (vm, bi0);
370 b1 = vlib_get_buffer (vm, bi1);
372 error0 = error1 = ETHERNET_ERROR_NONE;
373 e0 = vlib_buffer_get_current (b0);
374 type0 = clib_net_to_host_u16 (e0->type);
375 e1 = vlib_buffer_get_current (b1);
376 type1 = clib_net_to_host_u16 (e1->type);
378 /* Speed-path for the untagged case */
379 if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
380 && !ethernet_frame_is_tagged (type0)
381 && !ethernet_frame_is_tagged (type1)))
384 subint_config_t *subint0;
385 u32 sw_if_index0, sw_if_index1;
387 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
388 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
389 is_l20 = cached_is_l2;
391 /* This is probably wholly unnecessary */
392 if (PREDICT_FALSE (sw_if_index0 != sw_if_index1))
395 /* Now sw_if_index0 == sw_if_index1 */
396 if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
398 cached_sw_if_index = sw_if_index0;
399 hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
400 intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
401 subint0 = &intf0->untagged_subint;
402 cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
405 vnet_buffer (b0)->ethernet.start_of_ethernet_header =
407 vnet_buffer (b1)->ethernet.start_of_ethernet_header =
410 if (PREDICT_TRUE (is_l20 != 0))
413 vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
415 vnet_buffer (b1)->l2.l2_len = sizeof (ethernet_header_t);
419 if (!ethernet_address_cast (e0->dst_address) &&
420 (hi->hw_address != 0) &&
421 !eth_mac_equal ((u8 *) e0, hi->hw_address))
422 error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
423 if (!ethernet_address_cast (e1->dst_address) &&
424 (hi->hw_address != 0) &&
425 !eth_mac_equal ((u8 *) e1, hi->hw_address))
426 error1 = ETHERNET_ERROR_L3_MAC_MISMATCH;
427 determine_next_node (em, variant, 0, type0, b0,
429 vlib_buffer_advance (b0, sizeof (ethernet_header_t));
430 determine_next_node (em, variant, 0, type1, b1,
432 vlib_buffer_advance (b1, sizeof (ethernet_header_t));
437 /* Slow-path for the tagged case */
439 parse_header (variant,
442 &orig_type0, &outer_id0, &inner_id0, &match_flags0);
444 parse_header (variant,
447 &orig_type1, &outer_id1, &inner_id1, &match_flags1);
449 old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
450 old_sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
452 eth_vlan_table_lookups (em,
459 &main_intf0, &vlan_intf0, &qinq_intf0);
461 eth_vlan_table_lookups (em,
468 &main_intf1, &vlan_intf1, &qinq_intf1);
470 identify_subint (hi0,
475 qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
477 identify_subint (hi1,
482 qinq_intf1, &new_sw_if_index1, &error1, &is_l21);
484 // Save RX sw_if_index for later nodes
485 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
487 ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
488 vnet_buffer (b1)->sw_if_index[VLIB_RX] =
490 ETHERNET_ERROR_NONE ? old_sw_if_index1 : new_sw_if_index1;
492 // Check if there is a stat to take (valid and non-main sw_if_index for pkt 0 or pkt 1)
493 if (((new_sw_if_index0 != ~0)
494 && (new_sw_if_index0 != old_sw_if_index0))
495 || ((new_sw_if_index1 != ~0)
496 && (new_sw_if_index1 != old_sw_if_index1)))
499 len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
500 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
501 len1 = vlib_buffer_length_in_chain (vm, b1) + b1->current_data
502 - vnet_buffer (b1)->ethernet.start_of_ethernet_header;
504 stats_n_packets += 2;
505 stats_n_bytes += len0 + len1;
508 (!(new_sw_if_index0 == stats_sw_if_index
509 && new_sw_if_index1 == stats_sw_if_index)))
511 stats_n_packets -= 2;
512 stats_n_bytes -= len0 + len1;
514 if (new_sw_if_index0 != old_sw_if_index0
515 && new_sw_if_index0 != ~0)
516 vlib_increment_combined_counter (vnm->
517 interface_main.combined_sw_if_counters
519 VNET_INTERFACE_COUNTER_RX,
523 if (new_sw_if_index1 != old_sw_if_index1
524 && new_sw_if_index1 != ~0)
525 vlib_increment_combined_counter (vnm->
526 interface_main.combined_sw_if_counters
528 VNET_INTERFACE_COUNTER_RX,
533 if (new_sw_if_index0 == new_sw_if_index1)
535 if (stats_n_packets > 0)
537 vlib_increment_combined_counter
538 (vnm->interface_main.combined_sw_if_counters
539 + VNET_INTERFACE_COUNTER_RX,
542 stats_n_packets, stats_n_bytes);
543 stats_n_packets = stats_n_bytes = 0;
545 stats_sw_if_index = new_sw_if_index0;
550 if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
553 determine_next_node (em, variant, is_l20, type0, b0, &error0,
555 determine_next_node (em, variant, is_l21, type1, b1, &error1,
559 b0->error = error_node->errors[error0];
560 b1->error = error_node->errors[error1];
562 // verify speculative enqueue
563 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
564 n_left_to_next, bi0, bi1, next0,
568 while (n_left_from > 0 && n_left_to_next > 0)
573 u16 type0, orig_type0;
574 u16 outer_id0, inner_id0;
576 u32 old_sw_if_index0, new_sw_if_index0, len0;
577 vnet_hw_interface_t *hi0;
578 main_intf_t *main_intf0;
579 vlan_intf_t *vlan_intf0;
580 qinq_intf_t *qinq_intf0;
581 ethernet_header_t *e0;
584 // Prefetch next iteration
589 p2 = vlib_get_buffer (vm, from[1]);
590 vlib_prefetch_buffer_header (p2, STORE);
591 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, LOAD);
601 b0 = vlib_get_buffer (vm, bi0);
603 error0 = ETHERNET_ERROR_NONE;
604 e0 = vlib_buffer_get_current (b0);
605 type0 = clib_net_to_host_u16 (e0->type);
607 /* Speed-path for the untagged case */
608 if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
609 && !ethernet_frame_is_tagged (type0)))
612 subint_config_t *subint0;
615 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
616 is_l20 = cached_is_l2;
618 if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
620 cached_sw_if_index = sw_if_index0;
621 hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
622 intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
623 subint0 = &intf0->untagged_subint;
624 cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
627 vnet_buffer (b0)->ethernet.start_of_ethernet_header =
630 if (PREDICT_TRUE (is_l20 != 0))
633 vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
637 if (!ethernet_address_cast (e0->dst_address) &&
638 (hi->hw_address != 0) &&
639 !eth_mac_equal ((u8 *) e0, hi->hw_address))
640 error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
641 determine_next_node (em, variant, 0, type0, b0,
643 vlib_buffer_advance (b0, sizeof (ethernet_header_t));
648 /* Slow-path for the tagged case */
649 parse_header (variant,
652 &orig_type0, &outer_id0, &inner_id0, &match_flags0);
654 old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
656 eth_vlan_table_lookups (em,
663 &main_intf0, &vlan_intf0, &qinq_intf0);
665 identify_subint (hi0,
670 qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
672 // Save RX sw_if_index for later nodes
673 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
675 ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
677 // Increment subinterface stats
678 // Note that interface-level counters have already been incremented
679 // prior to calling this function. Thus only subinterface counters
680 // are incremented here.
682 // Interface level counters include packets received on the main
683 // interface and all subinterfaces. Subinterface level counters
684 // include only those packets received on that subinterface
685 // Increment stats if the subint is valid and it is not the main intf
686 if ((new_sw_if_index0 != ~0)
687 && (new_sw_if_index0 != old_sw_if_index0))
690 len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
691 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
693 stats_n_packets += 1;
694 stats_n_bytes += len0;
696 // Batch stat increments from the same subinterface so counters
697 // don't need to be incremented for every packet.
698 if (PREDICT_FALSE (new_sw_if_index0 != stats_sw_if_index))
700 stats_n_packets -= 1;
701 stats_n_bytes -= len0;
703 if (new_sw_if_index0 != ~0)
704 vlib_increment_combined_counter
705 (vnm->interface_main.combined_sw_if_counters
706 + VNET_INTERFACE_COUNTER_RX,
707 thread_index, new_sw_if_index0, 1, len0);
708 if (stats_n_packets > 0)
710 vlib_increment_combined_counter
711 (vnm->interface_main.combined_sw_if_counters
712 + VNET_INTERFACE_COUNTER_RX,
714 stats_sw_if_index, stats_n_packets, stats_n_bytes);
715 stats_n_packets = stats_n_bytes = 0;
717 stats_sw_if_index = new_sw_if_index0;
721 if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
724 determine_next_node (em, variant, is_l20, type0, b0, &error0,
728 b0->error = error_node->errors[error0];
730 // verify speculative enqueue
731 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
732 to_next, n_left_to_next,
736 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
739 // Increment any remaining batched stats
740 if (stats_n_packets > 0)
742 vlib_increment_combined_counter
743 (vnm->interface_main.combined_sw_if_counters
744 + VNET_INTERFACE_COUNTER_RX,
745 thread_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
746 node->runtime_data[0] = stats_sw_if_index;
749 return from_frame->n_vectors;
753 ethernet_input (vlib_main_t * vm,
754 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
756 return ethernet_input_inline (vm, node, from_frame,
757 ETHERNET_INPUT_VARIANT_ETHERNET);
761 ethernet_input_type (vlib_main_t * vm,
762 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
764 return ethernet_input_inline (vm, node, from_frame,
765 ETHERNET_INPUT_VARIANT_ETHERNET_TYPE);
769 ethernet_input_not_l2 (vlib_main_t * vm,
770 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
772 return ethernet_input_inline (vm, node, from_frame,
773 ETHERNET_INPUT_VARIANT_NOT_L2);
777 // Return the subinterface config struct for the given sw_if_index
778 // Also return via parameter the appropriate match flags for the
779 // configured number of tags.
780 // On error (unsupported or not ethernet) return 0.
781 static subint_config_t *
782 ethernet_sw_interface_get_config (vnet_main_t * vnm,
784 u32 * flags, u32 * unsupported)
786 ethernet_main_t *em = ðernet_main;
787 vnet_hw_interface_t *hi;
788 vnet_sw_interface_t *si;
789 main_intf_t *main_intf;
790 vlan_table_t *vlan_table;
791 qinq_table_t *qinq_table;
792 subint_config_t *subint = 0;
794 hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
796 if (!hi || (hi->hw_class_index != ethernet_hw_interface_class.index))
799 goto done; // non-ethernet interface
802 // ensure there's an entry for the main intf (shouldn't really be necessary)
803 vec_validate (em->main_intfs, hi->hw_if_index);
804 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
806 // Locate the subint for the given ethernet config
807 si = vnet_get_sw_interface (vnm, sw_if_index);
809 if (si->sub.eth.flags.default_sub)
811 subint = &main_intf->default_subint;
812 *flags = SUBINT_CONFIG_MATCH_0_TAG |
813 SUBINT_CONFIG_MATCH_1_TAG |
814 SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
816 else if ((si->sub.eth.flags.no_tags) || (si->sub.eth.raw_flags == 0))
818 // if no flags are set then this is a main interface
819 // so treat as untagged
820 subint = &main_intf->untagged_subint;
821 *flags = SUBINT_CONFIG_MATCH_0_TAG;
826 // first get the vlan table
827 if (si->sub.eth.flags.dot1ad)
829 if (main_intf->dot1ad_vlans == 0)
831 // Allocate a vlan table from the pool
832 pool_get (em->vlan_pool, vlan_table);
833 main_intf->dot1ad_vlans = vlan_table - em->vlan_pool;
837 // Get ptr to existing vlan table
839 vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
844 if (main_intf->dot1q_vlans == 0)
846 // Allocate a vlan table from the pool
847 pool_get (em->vlan_pool, vlan_table);
848 main_intf->dot1q_vlans = vlan_table - em->vlan_pool;
852 // Get ptr to existing vlan table
854 vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
858 if (si->sub.eth.flags.one_tag)
860 *flags = si->sub.eth.flags.exact_match ?
861 SUBINT_CONFIG_MATCH_1_TAG :
862 (SUBINT_CONFIG_MATCH_1_TAG |
863 SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
865 if (si->sub.eth.flags.outer_vlan_id_any)
867 // not implemented yet
873 // a single vlan, a common case
875 &vlan_table->vlans[si->sub.eth.
876 outer_vlan_id].single_tag_subint;
883 *flags = si->sub.eth.flags.exact_match ?
884 SUBINT_CONFIG_MATCH_2_TAG :
885 (SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
887 if (si->sub.eth.flags.outer_vlan_id_any
888 && si->sub.eth.flags.inner_vlan_id_any)
890 // not implemented yet
895 if (si->sub.eth.flags.inner_vlan_id_any)
897 // a specific outer and "any" inner
898 // don't need a qinq table for this
900 &vlan_table->vlans[si->sub.eth.
901 outer_vlan_id].inner_any_subint;
902 if (si->sub.eth.flags.exact_match)
904 *flags = SUBINT_CONFIG_MATCH_2_TAG;
908 *flags = SUBINT_CONFIG_MATCH_2_TAG |
909 SUBINT_CONFIG_MATCH_3_TAG;
914 // a specific outer + specifc innner vlan id, a common case
916 // get the qinq table
917 if (vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs == 0)
919 // Allocate a qinq table from the pool
920 pool_get (em->qinq_pool, qinq_table);
921 vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs =
922 qinq_table - em->qinq_pool;
926 // Get ptr to existing qinq table
928 vec_elt_at_index (em->qinq_pool,
929 vlan_table->vlans[si->sub.
933 subint = &qinq_table->vlans[si->sub.eth.inner_vlan_id].subint;
943 ethernet_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
945 subint_config_t *subint;
948 clib_error_t *error = 0;
950 // Find the config for this subinterface
952 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
957 // not implemented yet or not ethernet
961 subint->sw_if_index =
962 ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? sw_if_index : ~0);
968 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_sw_interface_up_down);
971 // Set the L2/L3 mode for the subinterface
973 ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index, u32 l2)
975 subint_config_t *subint;
979 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
981 is_port = !(sw->type == VNET_SW_INTERFACE_TYPE_SUB);
983 // Find the config for this subinterface
985 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
990 // unimplemented or not ethernet
994 // Double check that the config we found is for our interface (or the interface is down)
995 ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
999 subint->flags |= SUBINT_CONFIG_L2;
1002 SUBINT_CONFIG_MATCH_0_TAG | SUBINT_CONFIG_MATCH_1_TAG
1003 | SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
1007 subint->flags &= ~SUBINT_CONFIG_L2;
1010 ~(SUBINT_CONFIG_MATCH_1_TAG | SUBINT_CONFIG_MATCH_2_TAG
1011 | SUBINT_CONFIG_MATCH_3_TAG);
1019 * Set the L2/L3 mode for the subinterface regardless of port
1022 ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
1023 u32 sw_if_index, u32 l2)
1025 subint_config_t *subint;
1029 /* Find the config for this subinterface */
1031 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
1036 /* unimplemented or not ethernet */
1041 * Double check that the config we found is for our interface (or the
1042 * interface is down)
1044 ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
1048 subint->flags |= SUBINT_CONFIG_L2;
1052 subint->flags &= ~SUBINT_CONFIG_L2;
1059 static clib_error_t *
1060 ethernet_sw_interface_add_del (vnet_main_t * vnm,
1061 u32 sw_if_index, u32 is_create)
1063 clib_error_t *error = 0;
1064 subint_config_t *subint;
1066 u32 unsupported = 0;
1068 // Find the config for this subinterface
1070 ethernet_sw_interface_get_config (vnm, sw_if_index, &match_flags,
1075 // not implemented yet or not ethernet
1078 // this is the NYI case
1079 error = clib_error_return (0, "not implemented yet");
1090 // Initialize the subint
1091 if (subint->flags & SUBINT_CONFIG_VALID)
1093 // Error vlan already in use
1094 error = clib_error_return (0, "vlan is already in use");
1098 // Note that config is L3 by defaulty
1099 subint->flags = SUBINT_CONFIG_VALID | match_flags;
1100 subint->sw_if_index = ~0; // because interfaces are initially down
1107 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ethernet_sw_interface_add_del);
1109 static char *ethernet_error_strings[] = {
1110 #define ethernet_error(n,c,s) s,
1111 #include "error.def"
1112 #undef ethernet_error
1116 VLIB_REGISTER_NODE (ethernet_input_node) = {
1117 .function = ethernet_input,
1118 .name = "ethernet-input",
1119 /* Takes a vector of packets. */
1120 .vector_size = sizeof (u32),
1121 .n_errors = ETHERNET_N_ERROR,
1122 .error_strings = ethernet_error_strings,
1123 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1125 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1126 foreach_ethernet_input_next
1129 .format_buffer = format_ethernet_header_with_length,
1130 .format_trace = format_ethernet_input_trace,
1131 .unformat_buffer = unformat_ethernet_header,
1136 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_node, ethernet_input)
1140 VLIB_REGISTER_NODE (ethernet_input_type_node, static) = {
1141 .function = ethernet_input_type,
1142 .name = "ethernet-input-type",
1143 /* Takes a vector of packets. */
1144 .vector_size = sizeof (u32),
1145 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1147 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1148 foreach_ethernet_input_next
1155 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_type_node, ethernet_input_type)
1159 VLIB_REGISTER_NODE (ethernet_input_not_l2_node, static) = {
1160 .function = ethernet_input_not_l2,
1161 .name = "ethernet-input-not-l2",
1162 /* Takes a vector of packets. */
1163 .vector_size = sizeof (u32),
1164 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1166 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1167 foreach_ethernet_input_next
1175 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_not_l2_node,
1176 ethernet_input_not_l2)
1181 ethernet_set_rx_redirect (vnet_main_t * vnm,
1182 vnet_hw_interface_t * hi, u32 enable)
1184 // Insure all packets go to ethernet-input (i.e. untagged ipv4 packets
1185 // don't go directly to ip4-input)
1186 vnet_hw_interface_rx_redirect_to_node
1187 (vnm, hi->hw_if_index, enable ? ethernet_input_node.index : ~0);
1192 * Initialization and registration for the next_by_ethernet structure
1196 next_by_ethertype_init (next_by_ethertype_t * l3_next)
1198 l3_next->input_next_by_type = sparse_vec_new
1199 ( /* elt bytes */ sizeof (l3_next->input_next_by_type[0]),
1200 /* bits in index */ BITS (((ethernet_header_t *) 0)->type));
1202 vec_validate (l3_next->sparse_index_by_input_next_index,
1203 ETHERNET_INPUT_NEXT_DROP);
1204 vec_validate (l3_next->sparse_index_by_input_next_index,
1205 ETHERNET_INPUT_NEXT_PUNT);
1206 l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_DROP] =
1207 SPARSE_VEC_INVALID_INDEX;
1208 l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_PUNT] =
1209 SPARSE_VEC_INVALID_INDEX;
1212 * Make sure we don't wipe out an ethernet registration by mistake
1213 * Can happen if init function ordering constraints are missing.
1217 ethernet_main_t *em = ðernet_main;
1218 ASSERT (em->next_by_ethertype_register_called == 0);
1224 // Add an ethertype -> next index mapping to the structure
1226 next_by_ethertype_register (next_by_ethertype_t * l3_next,
1227 u32 ethertype, u32 next_index)
1231 ethernet_main_t *em = ðernet_main;
1235 ethernet_main_t *em = ðernet_main;
1236 em->next_by_ethertype_register_called = 1;
1239 /* Setup ethernet type -> next index sparse vector mapping. */
1240 n = sparse_vec_validate (l3_next->input_next_by_type, ethertype);
1243 /* Rebuild next index -> sparse index inverse mapping when sparse vector
1245 vec_validate (l3_next->sparse_index_by_input_next_index, next_index);
1246 for (i = 1; i < vec_len (l3_next->input_next_by_type); i++)
1248 sparse_index_by_input_next_index[l3_next->input_next_by_type[i]] = i;
1250 // do not allow the cached next index's to be updated if L3
1251 // redirect is enabled, as it will have overwritten them
1252 if (!em->redirect_l3)
1254 // Cache common ethertypes directly
1255 if (ethertype == ETHERNET_TYPE_IP4)
1257 l3_next->input_next_ip4 = next_index;
1259 else if (ethertype == ETHERNET_TYPE_IP6)
1261 l3_next->input_next_ip6 = next_index;
1263 else if (ethertype == ETHERNET_TYPE_MPLS)
1265 l3_next->input_next_mpls = next_index;
1272 static clib_error_t *
1273 ethernet_input_init (vlib_main_t * vm)
1275 ethernet_main_t *em = ðernet_main;
1276 __attribute__ ((unused)) vlan_table_t *invalid_vlan_table;
1277 __attribute__ ((unused)) qinq_table_t *invalid_qinq_table;
1279 ethernet_setup_node (vm, ethernet_input_node.index);
1280 ethernet_setup_node (vm, ethernet_input_type_node.index);
1281 ethernet_setup_node (vm, ethernet_input_not_l2_node.index);
1283 next_by_ethertype_init (&em->l3_next);
1285 // Initialize pools and vector for vlan parsing
1286 vec_validate (em->main_intfs, 10); // 10 main interfaces
1287 pool_alloc (em->vlan_pool, 10);
1288 pool_alloc (em->qinq_pool, 1);
1290 // The first vlan pool will always be reserved for an invalid table
1291 pool_get (em->vlan_pool, invalid_vlan_table); // first id = 0
1292 // The first qinq pool will always be reserved for an invalid table
1293 pool_get (em->qinq_pool, invalid_qinq_table); // first id = 0
1298 VLIB_INIT_FUNCTION (ethernet_input_init);
1301 ethernet_register_input_type (vlib_main_t * vm,
1302 ethernet_type_t type, u32 node_index)
1304 ethernet_main_t *em = ðernet_main;
1305 ethernet_type_info_t *ti;
1309 clib_error_t *error = vlib_call_init_function (vm, ethernet_init);
1311 clib_error_report (error);
1314 ti = ethernet_get_type_info (em, type);
1315 ti->node_index = node_index;
1316 ti->next_index = vlib_node_add_next (vm,
1317 ethernet_input_node.index, node_index);
1318 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1319 ASSERT (i == ti->next_index);
1321 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1322 ASSERT (i == ti->next_index);
1324 // Add the L3 node for this ethertype to the next nodes structure
1325 next_by_ethertype_register (&em->l3_next, type, ti->next_index);
1327 // Call the registration functions for other nodes that want a mapping
1328 l2bvi_register_input_type (vm, type, node_index);
1332 ethernet_register_l2_input (vlib_main_t * vm, u32 node_index)
1334 ethernet_main_t *em = ðernet_main;
1338 vlib_node_add_next (vm, ethernet_input_node.index, node_index);
1341 * Even if we never use these arcs, we have to align the next indices...
1343 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1345 ASSERT (i == em->l2_next);
1347 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1348 ASSERT (i == em->l2_next);
1351 // Register a next node for L3 redirect, and enable L3 redirect
1353 ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index)
1355 ethernet_main_t *em = ðernet_main;
1358 em->redirect_l3 = 1;
1359 em->redirect_l3_next = vlib_node_add_next (vm,
1360 ethernet_input_node.index,
1363 * Change the cached next nodes to the redirect node
1365 em->l3_next.input_next_ip4 = em->redirect_l3_next;
1366 em->l3_next.input_next_ip6 = em->redirect_l3_next;
1367 em->l3_next.input_next_mpls = em->redirect_l3_next;
1370 * Even if we never use these arcs, we have to align the next indices...
1372 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1374 ASSERT (i == em->redirect_l3_next);
1376 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1378 ASSERT (i == em->redirect_l3_next);
1382 * fd.io coding-style-patch-verification: ON
1385 * eval: (c-set-style "gnu")