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 int
289 ethernet_frame_is_any_tagged (u16 type0, u16 type1)
292 const __m128i ethertype_mask = _mm_set_epi16 (ETHERNET_TYPE_VLAN,
293 ETHERNET_TYPE_DOT1AD,
294 ETHERNET_TYPE_VLAN_9100,
295 ETHERNET_TYPE_VLAN_9200,
296 /* duplicate for type1 */
298 ETHERNET_TYPE_DOT1AD,
299 ETHERNET_TYPE_VLAN_9100,
300 ETHERNET_TYPE_VLAN_9200);
303 _mm_set_epi16 (type0, type0, type0, type0, type1, type1, type1, type1);
304 r = _mm_cmpeq_epi16 (ethertype_mask, r);
305 return !_mm_test_all_zeros (r, r);
307 return ethernet_frame_is_tagged (type0) || ethernet_frame_istagged (type1);
311 static_always_inline uword
312 ethernet_input_inline (vlib_main_t * vm,
313 vlib_node_runtime_t * node,
314 vlib_frame_t * from_frame,
315 ethernet_input_variant_t variant)
317 vnet_main_t *vnm = vnet_get_main ();
318 ethernet_main_t *em = ðernet_main;
319 vlib_node_runtime_t *error_node;
320 u32 n_left_from, next_index, *from, *to_next;
321 u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
322 u32 thread_index = vlib_get_thread_index ();
323 u32 cached_sw_if_index = ~0;
324 u32 cached_is_l2 = 0; /* shut up gcc */
325 vnet_hw_interface_t *hi = NULL; /* used for main interface only */
327 if (variant != ETHERNET_INPUT_VARIANT_ETHERNET)
328 error_node = vlib_node_get_runtime (vm, ethernet_input_node.index);
332 from = vlib_frame_vector_args (from_frame);
333 n_left_from = from_frame->n_vectors;
335 if (node->flags & VLIB_NODE_FLAG_TRACE)
336 vlib_trace_frame_buffers_only (vm, node,
340 sizeof (ethernet_input_trace_t));
342 next_index = node->cached_next_index;
343 stats_sw_if_index = node->runtime_data[0];
344 stats_n_packets = stats_n_bytes = 0;
346 while (n_left_from > 0)
350 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
352 while (n_left_from >= 4 && n_left_to_next >= 2)
355 vlib_buffer_t *b0, *b1;
356 u8 next0, next1, error0, error1;
357 u16 type0, orig_type0, type1, orig_type1;
358 u16 outer_id0, inner_id0, outer_id1, inner_id1;
359 u32 match_flags0, match_flags1;
360 u32 old_sw_if_index0, new_sw_if_index0, len0, old_sw_if_index1,
361 new_sw_if_index1, len1;
362 vnet_hw_interface_t *hi0, *hi1;
363 main_intf_t *main_intf0, *main_intf1;
364 vlan_intf_t *vlan_intf0, *vlan_intf1;
365 qinq_intf_t *qinq_intf0, *qinq_intf1;
367 ethernet_header_t *e0, *e1;
369 /* Prefetch next iteration. */
371 vlib_buffer_t *b2, *b3;
373 b2 = vlib_get_buffer (vm, from[2]);
374 b3 = vlib_get_buffer (vm, from[3]);
376 vlib_prefetch_buffer_header (b2, STORE);
377 vlib_prefetch_buffer_header (b3, STORE);
379 CLIB_PREFETCH (b2->data, sizeof (ethernet_header_t), LOAD);
380 CLIB_PREFETCH (b3->data, sizeof (ethernet_header_t), LOAD);
392 b0 = vlib_get_buffer (vm, bi0);
393 b1 = vlib_get_buffer (vm, bi1);
395 error0 = error1 = ETHERNET_ERROR_NONE;
396 e0 = vlib_buffer_get_current (b0);
397 type0 = clib_net_to_host_u16 (e0->type);
398 e1 = vlib_buffer_get_current (b1);
399 type1 = clib_net_to_host_u16 (e1->type);
401 /* Speed-path for the untagged case */
402 if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
403 && !ethernet_frame_is_any_tagged (type0, type1)))
406 subint_config_t *subint0;
407 u32 sw_if_index0, sw_if_index1;
409 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
410 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
411 is_l20 = cached_is_l2;
413 /* This is probably wholly unnecessary */
414 if (PREDICT_FALSE (sw_if_index0 != sw_if_index1))
417 /* Now sw_if_index0 == sw_if_index1 */
418 if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
420 cached_sw_if_index = sw_if_index0;
421 hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
422 intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
423 subint0 = &intf0->untagged_subint;
424 cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
427 vnet_buffer (b0)->ethernet.start_of_ethernet_header =
429 vnet_buffer (b1)->ethernet.start_of_ethernet_header =
432 if (PREDICT_TRUE (is_l20 != 0))
435 vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
437 vnet_buffer (b1)->l2.l2_len = sizeof (ethernet_header_t);
441 if (!ethernet_address_cast (e0->dst_address) &&
442 (hi->hw_address != 0) &&
443 !eth_mac_equal ((u8 *) e0, hi->hw_address))
444 error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
445 if (!ethernet_address_cast (e1->dst_address) &&
446 (hi->hw_address != 0) &&
447 !eth_mac_equal ((u8 *) e1, hi->hw_address))
448 error1 = ETHERNET_ERROR_L3_MAC_MISMATCH;
449 determine_next_node (em, variant, 0, type0, b0,
451 vlib_buffer_advance (b0, sizeof (ethernet_header_t));
452 determine_next_node (em, variant, 0, type1, b1,
454 vlib_buffer_advance (b1, sizeof (ethernet_header_t));
459 /* Slow-path for the tagged case */
461 parse_header (variant,
464 &orig_type0, &outer_id0, &inner_id0, &match_flags0);
466 parse_header (variant,
469 &orig_type1, &outer_id1, &inner_id1, &match_flags1);
471 old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
472 old_sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
474 eth_vlan_table_lookups (em,
481 &main_intf0, &vlan_intf0, &qinq_intf0);
483 eth_vlan_table_lookups (em,
490 &main_intf1, &vlan_intf1, &qinq_intf1);
492 identify_subint (hi0,
497 qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
499 identify_subint (hi1,
504 qinq_intf1, &new_sw_if_index1, &error1, &is_l21);
506 // Save RX sw_if_index for later nodes
507 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
509 ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
510 vnet_buffer (b1)->sw_if_index[VLIB_RX] =
512 ETHERNET_ERROR_NONE ? old_sw_if_index1 : new_sw_if_index1;
514 // Check if there is a stat to take (valid and non-main sw_if_index for pkt 0 or pkt 1)
515 if (((new_sw_if_index0 != ~0)
516 && (new_sw_if_index0 != old_sw_if_index0))
517 || ((new_sw_if_index1 != ~0)
518 && (new_sw_if_index1 != old_sw_if_index1)))
521 len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
522 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
523 len1 = vlib_buffer_length_in_chain (vm, b1) + b1->current_data
524 - vnet_buffer (b1)->ethernet.start_of_ethernet_header;
526 stats_n_packets += 2;
527 stats_n_bytes += len0 + len1;
530 (!(new_sw_if_index0 == stats_sw_if_index
531 && new_sw_if_index1 == stats_sw_if_index)))
533 stats_n_packets -= 2;
534 stats_n_bytes -= len0 + len1;
536 if (new_sw_if_index0 != old_sw_if_index0
537 && new_sw_if_index0 != ~0)
538 vlib_increment_combined_counter (vnm->
539 interface_main.combined_sw_if_counters
541 VNET_INTERFACE_COUNTER_RX,
545 if (new_sw_if_index1 != old_sw_if_index1
546 && new_sw_if_index1 != ~0)
547 vlib_increment_combined_counter (vnm->
548 interface_main.combined_sw_if_counters
550 VNET_INTERFACE_COUNTER_RX,
555 if (new_sw_if_index0 == new_sw_if_index1)
557 if (stats_n_packets > 0)
559 vlib_increment_combined_counter
560 (vnm->interface_main.combined_sw_if_counters
561 + VNET_INTERFACE_COUNTER_RX,
564 stats_n_packets, stats_n_bytes);
565 stats_n_packets = stats_n_bytes = 0;
567 stats_sw_if_index = new_sw_if_index0;
572 if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
575 determine_next_node (em, variant, is_l20, type0, b0, &error0,
577 determine_next_node (em, variant, is_l21, type1, b1, &error1,
581 b0->error = error_node->errors[error0];
582 b1->error = error_node->errors[error1];
584 // verify speculative enqueue
585 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
586 n_left_to_next, bi0, bi1, next0,
590 while (n_left_from > 0 && n_left_to_next > 0)
595 u16 type0, orig_type0;
596 u16 outer_id0, inner_id0;
598 u32 old_sw_if_index0, new_sw_if_index0, len0;
599 vnet_hw_interface_t *hi0;
600 main_intf_t *main_intf0;
601 vlan_intf_t *vlan_intf0;
602 qinq_intf_t *qinq_intf0;
603 ethernet_header_t *e0;
606 // Prefetch next iteration
611 p2 = vlib_get_buffer (vm, from[1]);
612 vlib_prefetch_buffer_header (p2, STORE);
613 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, LOAD);
623 b0 = vlib_get_buffer (vm, bi0);
625 error0 = ETHERNET_ERROR_NONE;
626 e0 = vlib_buffer_get_current (b0);
627 type0 = clib_net_to_host_u16 (e0->type);
629 /* Speed-path for the untagged case */
630 if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
631 && !ethernet_frame_is_tagged (type0)))
634 subint_config_t *subint0;
637 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
638 is_l20 = cached_is_l2;
640 if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
642 cached_sw_if_index = sw_if_index0;
643 hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
644 intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
645 subint0 = &intf0->untagged_subint;
646 cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
649 vnet_buffer (b0)->ethernet.start_of_ethernet_header =
652 if (PREDICT_TRUE (is_l20 != 0))
655 vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
659 if (!ethernet_address_cast (e0->dst_address) &&
660 (hi->hw_address != 0) &&
661 !eth_mac_equal ((u8 *) e0, hi->hw_address))
662 error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
663 determine_next_node (em, variant, 0, type0, b0,
665 vlib_buffer_advance (b0, sizeof (ethernet_header_t));
670 /* Slow-path for the tagged case */
671 parse_header (variant,
674 &orig_type0, &outer_id0, &inner_id0, &match_flags0);
676 old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
678 eth_vlan_table_lookups (em,
685 &main_intf0, &vlan_intf0, &qinq_intf0);
687 identify_subint (hi0,
692 qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
694 // Save RX sw_if_index for later nodes
695 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
697 ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
699 // Increment subinterface stats
700 // Note that interface-level counters have already been incremented
701 // prior to calling this function. Thus only subinterface counters
702 // are incremented here.
704 // Interface level counters include packets received on the main
705 // interface and all subinterfaces. Subinterface level counters
706 // include only those packets received on that subinterface
707 // Increment stats if the subint is valid and it is not the main intf
708 if ((new_sw_if_index0 != ~0)
709 && (new_sw_if_index0 != old_sw_if_index0))
712 len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
713 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
715 stats_n_packets += 1;
716 stats_n_bytes += len0;
718 // Batch stat increments from the same subinterface so counters
719 // don't need to be incremented for every packet.
720 if (PREDICT_FALSE (new_sw_if_index0 != stats_sw_if_index))
722 stats_n_packets -= 1;
723 stats_n_bytes -= len0;
725 if (new_sw_if_index0 != ~0)
726 vlib_increment_combined_counter
727 (vnm->interface_main.combined_sw_if_counters
728 + VNET_INTERFACE_COUNTER_RX,
729 thread_index, new_sw_if_index0, 1, len0);
730 if (stats_n_packets > 0)
732 vlib_increment_combined_counter
733 (vnm->interface_main.combined_sw_if_counters
734 + VNET_INTERFACE_COUNTER_RX,
736 stats_sw_if_index, stats_n_packets, stats_n_bytes);
737 stats_n_packets = stats_n_bytes = 0;
739 stats_sw_if_index = new_sw_if_index0;
743 if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
746 determine_next_node (em, variant, is_l20, type0, b0, &error0,
750 b0->error = error_node->errors[error0];
752 // verify speculative enqueue
753 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
754 to_next, n_left_to_next,
758 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
761 // Increment any remaining batched stats
762 if (stats_n_packets > 0)
764 vlib_increment_combined_counter
765 (vnm->interface_main.combined_sw_if_counters
766 + VNET_INTERFACE_COUNTER_RX,
767 thread_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
768 node->runtime_data[0] = stats_sw_if_index;
771 return from_frame->n_vectors;
775 ethernet_input (vlib_main_t * vm,
776 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
778 return ethernet_input_inline (vm, node, from_frame,
779 ETHERNET_INPUT_VARIANT_ETHERNET);
783 ethernet_input_type (vlib_main_t * vm,
784 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
786 return ethernet_input_inline (vm, node, from_frame,
787 ETHERNET_INPUT_VARIANT_ETHERNET_TYPE);
791 ethernet_input_not_l2 (vlib_main_t * vm,
792 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
794 return ethernet_input_inline (vm, node, from_frame,
795 ETHERNET_INPUT_VARIANT_NOT_L2);
799 // Return the subinterface config struct for the given sw_if_index
800 // Also return via parameter the appropriate match flags for the
801 // configured number of tags.
802 // On error (unsupported or not ethernet) return 0.
803 static subint_config_t *
804 ethernet_sw_interface_get_config (vnet_main_t * vnm,
806 u32 * flags, u32 * unsupported)
808 ethernet_main_t *em = ðernet_main;
809 vnet_hw_interface_t *hi;
810 vnet_sw_interface_t *si;
811 main_intf_t *main_intf;
812 vlan_table_t *vlan_table;
813 qinq_table_t *qinq_table;
814 subint_config_t *subint = 0;
816 hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
818 if (!hi || (hi->hw_class_index != ethernet_hw_interface_class.index))
821 goto done; // non-ethernet interface
824 // ensure there's an entry for the main intf (shouldn't really be necessary)
825 vec_validate (em->main_intfs, hi->hw_if_index);
826 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
828 // Locate the subint for the given ethernet config
829 si = vnet_get_sw_interface (vnm, sw_if_index);
831 if (si->sub.eth.flags.default_sub)
833 subint = &main_intf->default_subint;
834 *flags = SUBINT_CONFIG_MATCH_0_TAG |
835 SUBINT_CONFIG_MATCH_1_TAG |
836 SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
838 else if ((si->sub.eth.flags.no_tags) || (si->sub.eth.raw_flags == 0))
840 // if no flags are set then this is a main interface
841 // so treat as untagged
842 subint = &main_intf->untagged_subint;
843 *flags = SUBINT_CONFIG_MATCH_0_TAG;
848 // first get the vlan table
849 if (si->sub.eth.flags.dot1ad)
851 if (main_intf->dot1ad_vlans == 0)
853 // Allocate a vlan table from the pool
854 pool_get (em->vlan_pool, vlan_table);
855 main_intf->dot1ad_vlans = vlan_table - em->vlan_pool;
859 // Get ptr to existing vlan table
861 vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
866 if (main_intf->dot1q_vlans == 0)
868 // Allocate a vlan table from the pool
869 pool_get (em->vlan_pool, vlan_table);
870 main_intf->dot1q_vlans = vlan_table - em->vlan_pool;
874 // Get ptr to existing vlan table
876 vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
880 if (si->sub.eth.flags.one_tag)
882 *flags = si->sub.eth.flags.exact_match ?
883 SUBINT_CONFIG_MATCH_1_TAG :
884 (SUBINT_CONFIG_MATCH_1_TAG |
885 SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
887 if (si->sub.eth.flags.outer_vlan_id_any)
889 // not implemented yet
895 // a single vlan, a common case
897 &vlan_table->vlans[si->sub.eth.
898 outer_vlan_id].single_tag_subint;
905 *flags = si->sub.eth.flags.exact_match ?
906 SUBINT_CONFIG_MATCH_2_TAG :
907 (SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
909 if (si->sub.eth.flags.outer_vlan_id_any
910 && si->sub.eth.flags.inner_vlan_id_any)
912 // not implemented yet
917 if (si->sub.eth.flags.inner_vlan_id_any)
919 // a specific outer and "any" inner
920 // don't need a qinq table for this
922 &vlan_table->vlans[si->sub.eth.
923 outer_vlan_id].inner_any_subint;
924 if (si->sub.eth.flags.exact_match)
926 *flags = SUBINT_CONFIG_MATCH_2_TAG;
930 *flags = SUBINT_CONFIG_MATCH_2_TAG |
931 SUBINT_CONFIG_MATCH_3_TAG;
936 // a specific outer + specifc innner vlan id, a common case
938 // get the qinq table
939 if (vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs == 0)
941 // Allocate a qinq table from the pool
942 pool_get (em->qinq_pool, qinq_table);
943 vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs =
944 qinq_table - em->qinq_pool;
948 // Get ptr to existing qinq table
950 vec_elt_at_index (em->qinq_pool,
951 vlan_table->vlans[si->sub.
955 subint = &qinq_table->vlans[si->sub.eth.inner_vlan_id].subint;
965 ethernet_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
967 subint_config_t *subint;
970 clib_error_t *error = 0;
972 // Find the config for this subinterface
974 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
979 // not implemented yet or not ethernet
983 subint->sw_if_index =
984 ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? sw_if_index : ~0);
990 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_sw_interface_up_down);
993 // Set the L2/L3 mode for the subinterface
995 ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index, u32 l2)
997 subint_config_t *subint;
1001 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
1003 is_port = !(sw->type == VNET_SW_INTERFACE_TYPE_SUB);
1005 // Find the config for this subinterface
1007 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
1012 // unimplemented or not ethernet
1016 // Double check that the config we found is for our interface (or the interface is down)
1017 ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
1021 subint->flags |= SUBINT_CONFIG_L2;
1024 SUBINT_CONFIG_MATCH_0_TAG | SUBINT_CONFIG_MATCH_1_TAG
1025 | SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
1029 subint->flags &= ~SUBINT_CONFIG_L2;
1032 ~(SUBINT_CONFIG_MATCH_1_TAG | SUBINT_CONFIG_MATCH_2_TAG
1033 | SUBINT_CONFIG_MATCH_3_TAG);
1041 * Set the L2/L3 mode for the subinterface regardless of port
1044 ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
1045 u32 sw_if_index, u32 l2)
1047 subint_config_t *subint;
1051 /* Find the config for this subinterface */
1053 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
1058 /* unimplemented or not ethernet */
1063 * Double check that the config we found is for our interface (or the
1064 * interface is down)
1066 ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
1070 subint->flags |= SUBINT_CONFIG_L2;
1074 subint->flags &= ~SUBINT_CONFIG_L2;
1081 static clib_error_t *
1082 ethernet_sw_interface_add_del (vnet_main_t * vnm,
1083 u32 sw_if_index, u32 is_create)
1085 clib_error_t *error = 0;
1086 subint_config_t *subint;
1088 u32 unsupported = 0;
1090 // Find the config for this subinterface
1092 ethernet_sw_interface_get_config (vnm, sw_if_index, &match_flags,
1097 // not implemented yet or not ethernet
1100 // this is the NYI case
1101 error = clib_error_return (0, "not implemented yet");
1112 // Initialize the subint
1113 if (subint->flags & SUBINT_CONFIG_VALID)
1115 // Error vlan already in use
1116 error = clib_error_return (0, "vlan is already in use");
1120 // Note that config is L3 by defaulty
1121 subint->flags = SUBINT_CONFIG_VALID | match_flags;
1122 subint->sw_if_index = ~0; // because interfaces are initially down
1129 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ethernet_sw_interface_add_del);
1131 static char *ethernet_error_strings[] = {
1132 #define ethernet_error(n,c,s) s,
1133 #include "error.def"
1134 #undef ethernet_error
1138 VLIB_REGISTER_NODE (ethernet_input_node) = {
1139 .function = ethernet_input,
1140 .name = "ethernet-input",
1141 /* Takes a vector of packets. */
1142 .vector_size = sizeof (u32),
1143 .n_errors = ETHERNET_N_ERROR,
1144 .error_strings = ethernet_error_strings,
1145 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1147 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1148 foreach_ethernet_input_next
1151 .format_buffer = format_ethernet_header_with_length,
1152 .format_trace = format_ethernet_input_trace,
1153 .unformat_buffer = unformat_ethernet_header,
1158 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_node, ethernet_input)
1162 VLIB_REGISTER_NODE (ethernet_input_type_node, static) = {
1163 .function = ethernet_input_type,
1164 .name = "ethernet-input-type",
1165 /* Takes a vector of packets. */
1166 .vector_size = sizeof (u32),
1167 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1169 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1170 foreach_ethernet_input_next
1177 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_type_node, ethernet_input_type)
1181 VLIB_REGISTER_NODE (ethernet_input_not_l2_node, static) = {
1182 .function = ethernet_input_not_l2,
1183 .name = "ethernet-input-not-l2",
1184 /* Takes a vector of packets. */
1185 .vector_size = sizeof (u32),
1186 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1188 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1189 foreach_ethernet_input_next
1197 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_not_l2_node,
1198 ethernet_input_not_l2)
1203 ethernet_set_rx_redirect (vnet_main_t * vnm,
1204 vnet_hw_interface_t * hi, u32 enable)
1206 // Insure all packets go to ethernet-input (i.e. untagged ipv4 packets
1207 // don't go directly to ip4-input)
1208 vnet_hw_interface_rx_redirect_to_node
1209 (vnm, hi->hw_if_index, enable ? ethernet_input_node.index : ~0);
1214 * Initialization and registration for the next_by_ethernet structure
1218 next_by_ethertype_init (next_by_ethertype_t * l3_next)
1220 l3_next->input_next_by_type = sparse_vec_new
1221 ( /* elt bytes */ sizeof (l3_next->input_next_by_type[0]),
1222 /* bits in index */ BITS (((ethernet_header_t *) 0)->type));
1224 vec_validate (l3_next->sparse_index_by_input_next_index,
1225 ETHERNET_INPUT_NEXT_DROP);
1226 vec_validate (l3_next->sparse_index_by_input_next_index,
1227 ETHERNET_INPUT_NEXT_PUNT);
1228 l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_DROP] =
1229 SPARSE_VEC_INVALID_INDEX;
1230 l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_PUNT] =
1231 SPARSE_VEC_INVALID_INDEX;
1234 * Make sure we don't wipe out an ethernet registration by mistake
1235 * Can happen if init function ordering constraints are missing.
1239 ethernet_main_t *em = ðernet_main;
1240 ASSERT (em->next_by_ethertype_register_called == 0);
1246 // Add an ethertype -> next index mapping to the structure
1248 next_by_ethertype_register (next_by_ethertype_t * l3_next,
1249 u32 ethertype, u32 next_index)
1253 ethernet_main_t *em = ðernet_main;
1257 ethernet_main_t *em = ðernet_main;
1258 em->next_by_ethertype_register_called = 1;
1261 /* Setup ethernet type -> next index sparse vector mapping. */
1262 n = sparse_vec_validate (l3_next->input_next_by_type, ethertype);
1265 /* Rebuild next index -> sparse index inverse mapping when sparse vector
1267 vec_validate (l3_next->sparse_index_by_input_next_index, next_index);
1268 for (i = 1; i < vec_len (l3_next->input_next_by_type); i++)
1270 sparse_index_by_input_next_index[l3_next->input_next_by_type[i]] = i;
1272 // do not allow the cached next index's to be updated if L3
1273 // redirect is enabled, as it will have overwritten them
1274 if (!em->redirect_l3)
1276 // Cache common ethertypes directly
1277 if (ethertype == ETHERNET_TYPE_IP4)
1279 l3_next->input_next_ip4 = next_index;
1281 else if (ethertype == ETHERNET_TYPE_IP6)
1283 l3_next->input_next_ip6 = next_index;
1285 else if (ethertype == ETHERNET_TYPE_MPLS)
1287 l3_next->input_next_mpls = next_index;
1294 static clib_error_t *
1295 ethernet_input_init (vlib_main_t * vm)
1297 ethernet_main_t *em = ðernet_main;
1298 __attribute__ ((unused)) vlan_table_t *invalid_vlan_table;
1299 __attribute__ ((unused)) qinq_table_t *invalid_qinq_table;
1301 ethernet_setup_node (vm, ethernet_input_node.index);
1302 ethernet_setup_node (vm, ethernet_input_type_node.index);
1303 ethernet_setup_node (vm, ethernet_input_not_l2_node.index);
1305 next_by_ethertype_init (&em->l3_next);
1307 // Initialize pools and vector for vlan parsing
1308 vec_validate (em->main_intfs, 10); // 10 main interfaces
1309 pool_alloc (em->vlan_pool, 10);
1310 pool_alloc (em->qinq_pool, 1);
1312 // The first vlan pool will always be reserved for an invalid table
1313 pool_get (em->vlan_pool, invalid_vlan_table); // first id = 0
1314 // The first qinq pool will always be reserved for an invalid table
1315 pool_get (em->qinq_pool, invalid_qinq_table); // first id = 0
1320 VLIB_INIT_FUNCTION (ethernet_input_init);
1323 ethernet_register_input_type (vlib_main_t * vm,
1324 ethernet_type_t type, u32 node_index)
1326 ethernet_main_t *em = ðernet_main;
1327 ethernet_type_info_t *ti;
1331 clib_error_t *error = vlib_call_init_function (vm, ethernet_init);
1333 clib_error_report (error);
1336 ti = ethernet_get_type_info (em, type);
1337 ti->node_index = node_index;
1338 ti->next_index = vlib_node_add_next (vm,
1339 ethernet_input_node.index, node_index);
1340 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1341 ASSERT (i == ti->next_index);
1343 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1344 ASSERT (i == ti->next_index);
1346 // Add the L3 node for this ethertype to the next nodes structure
1347 next_by_ethertype_register (&em->l3_next, type, ti->next_index);
1349 // Call the registration functions for other nodes that want a mapping
1350 l2bvi_register_input_type (vm, type, node_index);
1354 ethernet_register_l2_input (vlib_main_t * vm, u32 node_index)
1356 ethernet_main_t *em = ðernet_main;
1360 vlib_node_add_next (vm, ethernet_input_node.index, node_index);
1363 * Even if we never use these arcs, we have to align the next indices...
1365 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1367 ASSERT (i == em->l2_next);
1369 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1370 ASSERT (i == em->l2_next);
1373 // Register a next node for L3 redirect, and enable L3 redirect
1375 ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index)
1377 ethernet_main_t *em = ðernet_main;
1380 em->redirect_l3 = 1;
1381 em->redirect_l3_next = vlib_node_add_next (vm,
1382 ethernet_input_node.index,
1385 * Change the cached next nodes to the redirect node
1387 em->l3_next.input_next_ip4 = em->redirect_l3_next;
1388 em->l3_next.input_next_ip6 = em->redirect_l3_next;
1389 em->l3_next.input_next_mpls = em->redirect_l3_next;
1392 * Even if we never use these arcs, we have to align the next indices...
1394 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1396 ASSERT (i == em->redirect_l3_next);
1398 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1400 ASSERT (i == em->redirect_l3_next);
1404 * fd.io coding-style-patch-verification: ON
1407 * eval: (c-set-style "gnu")