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 <vnet/ethernet/p2p_ethernet.h>
44 #include <vppinfra/sparse_vec.h>
45 #include <vnet/l2/l2_bvi.h>
48 #define foreach_ethernet_input_next \
49 _ (PUNT, "error-punt") \
50 _ (DROP, "error-drop") \
55 #define _(s,n) ETHERNET_INPUT_NEXT_##s,
56 foreach_ethernet_input_next
58 ETHERNET_INPUT_N_NEXT,
59 } ethernet_input_next_t;
64 } ethernet_input_trace_t;
67 format_ethernet_input_trace (u8 * s, va_list * va)
69 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
70 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
71 ethernet_input_trace_t *t = va_arg (*va, ethernet_input_trace_t *);
73 s = format (s, "%U", format_ethernet_header, t->packet_data);
78 vlib_node_registration_t ethernet_input_node;
82 ETHERNET_INPUT_VARIANT_ETHERNET,
83 ETHERNET_INPUT_VARIANT_ETHERNET_TYPE,
84 ETHERNET_INPUT_VARIANT_NOT_L2,
85 } ethernet_input_variant_t;
88 // Parse the ethernet header to extract vlan tags and innermost ethertype
89 static_always_inline void
90 parse_header (ethernet_input_variant_t variant,
94 u16 * outer_id, u16 * inner_id, u32 * match_flags)
98 if (variant == ETHERNET_INPUT_VARIANT_ETHERNET
99 || variant == ETHERNET_INPUT_VARIANT_NOT_L2)
101 ethernet_header_t *e0;
103 e0 = (void *) (b0->data + b0->current_data);
105 vnet_buffer (b0)->l2_hdr_offset = b0->current_data;
107 vlib_buffer_advance (b0, sizeof (e0[0]));
109 *type = clib_net_to_host_u16 (e0->type);
111 else if (variant == ETHERNET_INPUT_VARIANT_ETHERNET_TYPE)
113 // here when prior node was LLC/SNAP processing
116 e0 = (void *) (b0->data + b0->current_data);
118 vlib_buffer_advance (b0, sizeof (e0[0]));
120 *type = clib_net_to_host_u16 (e0[0]);
123 // save for distinguishing between dot1q and dot1ad later
126 // default the tags to 0 (used if there is no corresponding tag)
130 *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_0_TAG;
133 // check for vlan encaps
134 if (ethernet_frame_is_tagged (*type))
136 ethernet_vlan_header_t *h0;
139 *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_1_TAG;
141 h0 = (void *) (b0->data + b0->current_data);
143 tag = clib_net_to_host_u16 (h0->priority_cfi_and_id);
145 *outer_id = tag & 0xfff;
147 *match_flags &= ~SUBINT_CONFIG_MATCH_1_TAG;
149 *type = clib_net_to_host_u16 (h0->type);
151 vlib_buffer_advance (b0, sizeof (h0[0]));
154 if (*type == ETHERNET_TYPE_VLAN)
156 // Double tagged packet
157 *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_2_TAG;
159 h0 = (void *) (b0->data + b0->current_data);
161 tag = clib_net_to_host_u16 (h0->priority_cfi_and_id);
163 *inner_id = tag & 0xfff;
165 *type = clib_net_to_host_u16 (h0->type);
167 vlib_buffer_advance (b0, sizeof (h0[0]));
169 if (*type == ETHERNET_TYPE_VLAN)
171 // More than double tagged packet
172 *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_3_TAG;
174 vlib_buffer_advance (b0, sizeof (h0[0]));
175 vlan_count = 3; // "unknown" number, aka, 3-or-more
179 ethernet_buffer_set_vlan_count (b0, vlan_count);
182 // Determine the subinterface for this packet, given the result of the
183 // vlan table lookups and vlan header parsing. Check the most specific
185 static_always_inline void
186 identify_subint (vnet_hw_interface_t * hi,
189 main_intf_t * main_intf,
190 vlan_intf_t * vlan_intf,
191 qinq_intf_t * qinq_intf,
192 u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
196 matched = eth_identify_subint (hi, b0, match_flags,
197 main_intf, vlan_intf, qinq_intf,
198 new_sw_if_index, error0, is_l2);
203 // Perform L3 my-mac filter
204 // A unicast packet arriving on an L3 interface must have a dmac matching the interface mac.
205 // This is required for promiscuous mode, else we will forward packets we aren't supposed to.
208 ethernet_header_t *e0;
209 e0 = (void *) (b0->data + vnet_buffer (b0)->l2_hdr_offset);
211 if (!(ethernet_address_cast (e0->dst_address)))
213 if (!eth_mac_equal ((u8 *) e0, hi->hw_address))
215 *error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
220 // Check for down subinterface
221 *error0 = (*new_sw_if_index) != ~0 ? (*error0) : ETHERNET_ERROR_DOWN;
225 static_always_inline void
226 determine_next_node (ethernet_main_t * em,
227 ethernet_input_variant_t variant,
229 u32 type0, vlib_buffer_t * b0, u8 * error0, u8 * next0)
231 if (PREDICT_FALSE (*error0 != ETHERNET_ERROR_NONE))
233 // some error occurred
234 *next0 = ETHERNET_INPUT_NEXT_DROP;
238 *next0 = em->l2_next;
239 // record the L2 len and reset the buffer so the L2 header is preserved
240 u32 eth_start = vnet_buffer (b0)->l2_hdr_offset;
241 vnet_buffer (b0)->l2.l2_len = b0->current_data - eth_start;
242 ASSERT (vnet_buffer (b0)->l2.l2_len ==
243 ethernet_buffer_header_size (b0));
244 vlib_buffer_advance (b0, -ethernet_buffer_header_size (b0));
246 // check for common IP/MPLS ethertypes
248 else if (type0 == ETHERNET_TYPE_IP4)
250 *next0 = em->l3_next.input_next_ip4;
252 else if (type0 == ETHERNET_TYPE_IP6)
254 *next0 = em->l3_next.input_next_ip6;
256 else if (type0 == ETHERNET_TYPE_MPLS)
258 *next0 = em->l3_next.input_next_mpls;
261 else if (em->redirect_l3)
263 // L3 Redirect is on, the cached common next nodes will be
264 // pointing to the redirect node, catch the uncommon types here
265 *next0 = em->redirect_l3_next;
269 // uncommon ethertype, check table
271 i0 = sparse_vec_index (em->l3_next.input_next_by_type, type0);
272 *next0 = vec_elt (em->l3_next.input_next_by_type, i0);
275 SPARSE_VEC_INVALID_INDEX ? ETHERNET_ERROR_UNKNOWN_TYPE : *error0;
277 // The table is not populated with LLC values, so check that now.
278 // If variant is variant_ethernet then we came from LLC processing. Don't
279 // go back there; drop instead using by keeping the drop/bad table result.
280 if ((type0 < 0x600) && (variant == ETHERNET_INPUT_VARIANT_ETHERNET))
282 *next0 = ETHERNET_INPUT_NEXT_LLC;
287 static_always_inline int
288 ethernet_frame_is_any_tagged (u16 type0, u16 type1)
291 const __m128i ethertype_mask = _mm_set_epi16 (ETHERNET_TYPE_VLAN,
292 ETHERNET_TYPE_DOT1AD,
293 ETHERNET_TYPE_VLAN_9100,
294 ETHERNET_TYPE_VLAN_9200,
295 /* duplicate for type1 */
297 ETHERNET_TYPE_DOT1AD,
298 ETHERNET_TYPE_VLAN_9100,
299 ETHERNET_TYPE_VLAN_9200);
302 _mm_set_epi16 (type0, type0, type0, type0, type1, type1, type1, type1);
303 r = _mm_cmpeq_epi16 (ethertype_mask, r);
304 return !_mm_test_all_zeros (r, r);
306 return ethernet_frame_is_tagged (type0) || ethernet_frame_is_tagged (type1);
310 static_always_inline uword
311 ethernet_input_inline (vlib_main_t * vm,
312 vlib_node_runtime_t * node,
313 vlib_frame_t * from_frame,
314 ethernet_input_variant_t variant)
316 vnet_main_t *vnm = vnet_get_main ();
317 ethernet_main_t *em = ðernet_main;
318 vlib_node_runtime_t *error_node;
319 u32 n_left_from, next_index, *from, *to_next;
320 u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
321 u32 thread_index = vlib_get_thread_index ();
322 u32 cached_sw_if_index = ~0;
323 u32 cached_is_l2 = 0; /* shut up gcc */
324 vnet_hw_interface_t *hi = NULL; /* used for main interface only */
326 if (variant != ETHERNET_INPUT_VARIANT_ETHERNET)
327 error_node = vlib_node_get_runtime (vm, ethernet_input_node.index);
331 from = vlib_frame_vector_args (from_frame);
332 n_left_from = from_frame->n_vectors;
334 if (node->flags & VLIB_NODE_FLAG_TRACE)
335 vlib_trace_frame_buffers_only (vm, node,
339 sizeof (ethernet_input_trace_t));
341 next_index = node->cached_next_index;
342 stats_sw_if_index = node->runtime_data[0];
343 stats_n_packets = stats_n_bytes = 0;
345 while (n_left_from > 0)
349 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
351 while (n_left_from >= 4 && n_left_to_next >= 2)
354 vlib_buffer_t *b0, *b1;
355 u8 next0, next1, error0, error1;
356 u16 type0, orig_type0, type1, orig_type1;
357 u16 outer_id0, inner_id0, outer_id1, inner_id1;
358 u32 match_flags0, match_flags1;
359 u32 old_sw_if_index0, new_sw_if_index0, len0, old_sw_if_index1,
360 new_sw_if_index1, len1;
361 vnet_hw_interface_t *hi0, *hi1;
362 main_intf_t *main_intf0, *main_intf1;
363 vlan_intf_t *vlan_intf0, *vlan_intf1;
364 qinq_intf_t *qinq_intf0, *qinq_intf1;
366 ethernet_header_t *e0, *e1;
368 /* Prefetch next iteration. */
370 vlib_buffer_t *b2, *b3;
372 b2 = vlib_get_buffer (vm, from[2]);
373 b3 = vlib_get_buffer (vm, from[3]);
375 vlib_prefetch_buffer_header (b2, STORE);
376 vlib_prefetch_buffer_header (b3, STORE);
378 CLIB_PREFETCH (b2->data, sizeof (ethernet_header_t), LOAD);
379 CLIB_PREFETCH (b3->data, sizeof (ethernet_header_t), LOAD);
391 b0 = vlib_get_buffer (vm, bi0);
392 b1 = vlib_get_buffer (vm, bi1);
394 error0 = error1 = ETHERNET_ERROR_NONE;
395 e0 = vlib_buffer_get_current (b0);
396 type0 = clib_net_to_host_u16 (e0->type);
397 e1 = vlib_buffer_get_current (b1);
398 type1 = clib_net_to_host_u16 (e1->type);
400 /* Speed-path for the untagged case */
401 if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
402 && !ethernet_frame_is_any_tagged (type0, type1)))
405 subint_config_t *subint0;
406 u32 sw_if_index0, sw_if_index1;
408 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
409 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
410 is_l20 = cached_is_l2;
412 /* This is probably wholly unnecessary */
413 if (PREDICT_FALSE (sw_if_index0 != sw_if_index1))
416 /* Now sw_if_index0 == sw_if_index1 */
417 if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
419 cached_sw_if_index = sw_if_index0;
420 hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
421 intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
422 subint0 = &intf0->untagged_subint;
423 cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
426 vnet_buffer (b0)->l2_hdr_offset = b0->current_data;
427 vnet_buffer (b1)->l2_hdr_offset = b1->current_data;
429 if (PREDICT_TRUE (is_l20 != 0))
432 vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
434 vnet_buffer (b1)->l2.l2_len = sizeof (ethernet_header_t);
438 if (!ethernet_address_cast (e0->dst_address) &&
439 (hi->hw_address != 0) &&
440 !eth_mac_equal ((u8 *) e0, hi->hw_address))
441 error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
442 if (!ethernet_address_cast (e1->dst_address) &&
443 (hi->hw_address != 0) &&
444 !eth_mac_equal ((u8 *) e1, hi->hw_address))
445 error1 = ETHERNET_ERROR_L3_MAC_MISMATCH;
446 determine_next_node (em, variant, 0, type0, b0,
448 vlib_buffer_advance (b0, sizeof (ethernet_header_t));
449 determine_next_node (em, variant, 0, type1, b1,
451 vlib_buffer_advance (b1, sizeof (ethernet_header_t));
456 /* Slow-path for the tagged case */
458 parse_header (variant,
461 &orig_type0, &outer_id0, &inner_id0, &match_flags0);
463 parse_header (variant,
466 &orig_type1, &outer_id1, &inner_id1, &match_flags1);
468 old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
469 old_sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
471 eth_vlan_table_lookups (em,
478 &main_intf0, &vlan_intf0, &qinq_intf0);
480 eth_vlan_table_lookups (em,
487 &main_intf1, &vlan_intf1, &qinq_intf1);
489 identify_subint (hi0,
494 qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
496 identify_subint (hi1,
501 qinq_intf1, &new_sw_if_index1, &error1, &is_l21);
503 // Save RX sw_if_index for later nodes
504 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
506 ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
507 vnet_buffer (b1)->sw_if_index[VLIB_RX] =
509 ETHERNET_ERROR_NONE ? old_sw_if_index1 : new_sw_if_index1;
511 // Check if there is a stat to take (valid and non-main sw_if_index for pkt 0 or pkt 1)
512 if (((new_sw_if_index0 != ~0)
513 && (new_sw_if_index0 != old_sw_if_index0))
514 || ((new_sw_if_index1 != ~0)
515 && (new_sw_if_index1 != old_sw_if_index1)))
518 len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
519 - vnet_buffer (b0)->l2_hdr_offset;
520 len1 = vlib_buffer_length_in_chain (vm, b1) + b1->current_data
521 - vnet_buffer (b1)->l2_hdr_offset;
523 stats_n_packets += 2;
524 stats_n_bytes += len0 + len1;
527 (!(new_sw_if_index0 == stats_sw_if_index
528 && new_sw_if_index1 == stats_sw_if_index)))
530 stats_n_packets -= 2;
531 stats_n_bytes -= len0 + len1;
533 if (new_sw_if_index0 != old_sw_if_index0
534 && new_sw_if_index0 != ~0)
535 vlib_increment_combined_counter (vnm->
536 interface_main.combined_sw_if_counters
538 VNET_INTERFACE_COUNTER_RX,
542 if (new_sw_if_index1 != old_sw_if_index1
543 && new_sw_if_index1 != ~0)
544 vlib_increment_combined_counter (vnm->
545 interface_main.combined_sw_if_counters
547 VNET_INTERFACE_COUNTER_RX,
552 if (new_sw_if_index0 == new_sw_if_index1)
554 if (stats_n_packets > 0)
556 vlib_increment_combined_counter
557 (vnm->interface_main.combined_sw_if_counters
558 + VNET_INTERFACE_COUNTER_RX,
561 stats_n_packets, stats_n_bytes);
562 stats_n_packets = stats_n_bytes = 0;
564 stats_sw_if_index = new_sw_if_index0;
569 if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
572 determine_next_node (em, variant, is_l20, type0, b0, &error0,
574 determine_next_node (em, variant, is_l21, type1, b1, &error1,
578 b0->error = error_node->errors[error0];
579 b1->error = error_node->errors[error1];
581 // verify speculative enqueue
582 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
583 n_left_to_next, bi0, bi1, next0,
587 while (n_left_from > 0 && n_left_to_next > 0)
592 u16 type0, orig_type0;
593 u16 outer_id0, inner_id0;
595 u32 old_sw_if_index0, new_sw_if_index0, len0;
596 vnet_hw_interface_t *hi0;
597 main_intf_t *main_intf0;
598 vlan_intf_t *vlan_intf0;
599 qinq_intf_t *qinq_intf0;
600 ethernet_header_t *e0;
603 // Prefetch next iteration
608 p2 = vlib_get_buffer (vm, from[1]);
609 vlib_prefetch_buffer_header (p2, STORE);
610 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, LOAD);
620 b0 = vlib_get_buffer (vm, bi0);
622 error0 = ETHERNET_ERROR_NONE;
623 e0 = vlib_buffer_get_current (b0);
624 type0 = clib_net_to_host_u16 (e0->type);
626 /* Speed-path for the untagged case */
627 if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
628 && !ethernet_frame_is_tagged (type0)))
631 subint_config_t *subint0;
634 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
635 is_l20 = cached_is_l2;
637 if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
639 cached_sw_if_index = sw_if_index0;
640 hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
641 intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
642 subint0 = &intf0->untagged_subint;
643 cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
646 vnet_buffer (b0)->l2_hdr_offset = b0->current_data;
648 if (PREDICT_TRUE (is_l20 != 0))
651 vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
655 if (!ethernet_address_cast (e0->dst_address) &&
656 (hi->hw_address != 0) &&
657 !eth_mac_equal ((u8 *) e0, hi->hw_address))
658 error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
659 determine_next_node (em, variant, 0, type0, b0,
661 vlib_buffer_advance (b0, sizeof (ethernet_header_t));
666 /* Slow-path for the tagged case */
667 parse_header (variant,
670 &orig_type0, &outer_id0, &inner_id0, &match_flags0);
672 old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
674 eth_vlan_table_lookups (em,
681 &main_intf0, &vlan_intf0, &qinq_intf0);
683 identify_subint (hi0,
688 qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
690 // Save RX sw_if_index for later nodes
691 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
693 ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
695 // Increment subinterface stats
696 // Note that interface-level counters have already been incremented
697 // prior to calling this function. Thus only subinterface counters
698 // are incremented here.
700 // Interface level counters include packets received on the main
701 // interface and all subinterfaces. Subinterface level counters
702 // include only those packets received on that subinterface
703 // Increment stats if the subint is valid and it is not the main intf
704 if ((new_sw_if_index0 != ~0)
705 && (new_sw_if_index0 != old_sw_if_index0))
708 len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
709 - vnet_buffer (b0)->l2_hdr_offset;
711 stats_n_packets += 1;
712 stats_n_bytes += len0;
714 // Batch stat increments from the same subinterface so counters
715 // don't need to be incremented for every packet.
716 if (PREDICT_FALSE (new_sw_if_index0 != stats_sw_if_index))
718 stats_n_packets -= 1;
719 stats_n_bytes -= len0;
721 if (new_sw_if_index0 != ~0)
722 vlib_increment_combined_counter
723 (vnm->interface_main.combined_sw_if_counters
724 + VNET_INTERFACE_COUNTER_RX,
725 thread_index, new_sw_if_index0, 1, len0);
726 if (stats_n_packets > 0)
728 vlib_increment_combined_counter
729 (vnm->interface_main.combined_sw_if_counters
730 + VNET_INTERFACE_COUNTER_RX,
732 stats_sw_if_index, stats_n_packets, stats_n_bytes);
733 stats_n_packets = stats_n_bytes = 0;
735 stats_sw_if_index = new_sw_if_index0;
739 if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
742 determine_next_node (em, variant, is_l20, type0, b0, &error0,
746 b0->error = error_node->errors[error0];
748 // verify speculative enqueue
749 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
750 to_next, n_left_to_next,
754 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
757 // Increment any remaining batched stats
758 if (stats_n_packets > 0)
760 vlib_increment_combined_counter
761 (vnm->interface_main.combined_sw_if_counters
762 + VNET_INTERFACE_COUNTER_RX,
763 thread_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
764 node->runtime_data[0] = stats_sw_if_index;
767 return from_frame->n_vectors;
771 ethernet_input (vlib_main_t * vm,
772 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
774 return ethernet_input_inline (vm, node, from_frame,
775 ETHERNET_INPUT_VARIANT_ETHERNET);
779 ethernet_input_type (vlib_main_t * vm,
780 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
782 return ethernet_input_inline (vm, node, from_frame,
783 ETHERNET_INPUT_VARIANT_ETHERNET_TYPE);
787 ethernet_input_not_l2 (vlib_main_t * vm,
788 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
790 return ethernet_input_inline (vm, node, from_frame,
791 ETHERNET_INPUT_VARIANT_NOT_L2);
795 // Return the subinterface config struct for the given sw_if_index
796 // Also return via parameter the appropriate match flags for the
797 // configured number of tags.
798 // On error (unsupported or not ethernet) return 0.
799 static subint_config_t *
800 ethernet_sw_interface_get_config (vnet_main_t * vnm,
802 u32 * flags, u32 * unsupported)
804 ethernet_main_t *em = ðernet_main;
805 vnet_hw_interface_t *hi;
806 vnet_sw_interface_t *si;
807 main_intf_t *main_intf;
808 vlan_table_t *vlan_table;
809 qinq_table_t *qinq_table;
810 subint_config_t *subint = 0;
812 hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
814 if (!hi || (hi->hw_class_index != ethernet_hw_interface_class.index))
817 goto done; // non-ethernet interface
820 // ensure there's an entry for the main intf (shouldn't really be necessary)
821 vec_validate (em->main_intfs, hi->hw_if_index);
822 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
824 // Locate the subint for the given ethernet config
825 si = vnet_get_sw_interface (vnm, sw_if_index);
827 if (si->type == VNET_SW_INTERFACE_TYPE_P2P)
829 p2p_ethernet_main_t *p2pm = &p2p_main;
830 u32 p2pe_sw_if_index =
831 p2p_ethernet_lookup (hi->hw_if_index, si->p2p.client_mac);
832 if (p2pe_sw_if_index == ~0)
834 pool_get (p2pm->p2p_subif_pool, subint);
835 si->p2p.pool_index = subint - p2pm->p2p_subif_pool;
838 subint = vec_elt_at_index (p2pm->p2p_subif_pool, si->p2p.pool_index);
839 *flags = SUBINT_CONFIG_P2P;
841 else if (si->sub.eth.flags.default_sub)
843 subint = &main_intf->default_subint;
844 *flags = SUBINT_CONFIG_MATCH_0_TAG |
845 SUBINT_CONFIG_MATCH_1_TAG |
846 SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
848 else if ((si->sub.eth.flags.no_tags) || (si->sub.eth.raw_flags == 0))
850 // if no flags are set then this is a main interface
851 // so treat as untagged
852 subint = &main_intf->untagged_subint;
853 *flags = SUBINT_CONFIG_MATCH_0_TAG;
858 // first get the vlan table
859 if (si->sub.eth.flags.dot1ad)
861 if (main_intf->dot1ad_vlans == 0)
863 // Allocate a vlan table from the pool
864 pool_get (em->vlan_pool, vlan_table);
865 main_intf->dot1ad_vlans = vlan_table - em->vlan_pool;
869 // Get ptr to existing vlan table
871 vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
876 if (main_intf->dot1q_vlans == 0)
878 // Allocate a vlan table from the pool
879 pool_get (em->vlan_pool, vlan_table);
880 main_intf->dot1q_vlans = vlan_table - em->vlan_pool;
884 // Get ptr to existing vlan table
886 vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
890 if (si->sub.eth.flags.one_tag)
892 *flags = si->sub.eth.flags.exact_match ?
893 SUBINT_CONFIG_MATCH_1_TAG :
894 (SUBINT_CONFIG_MATCH_1_TAG |
895 SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
897 if (si->sub.eth.flags.outer_vlan_id_any)
899 // not implemented yet
905 // a single vlan, a common case
907 &vlan_table->vlans[si->sub.eth.
908 outer_vlan_id].single_tag_subint;
915 *flags = si->sub.eth.flags.exact_match ?
916 SUBINT_CONFIG_MATCH_2_TAG :
917 (SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
919 if (si->sub.eth.flags.outer_vlan_id_any
920 && si->sub.eth.flags.inner_vlan_id_any)
922 // not implemented yet
927 if (si->sub.eth.flags.inner_vlan_id_any)
929 // a specific outer and "any" inner
930 // don't need a qinq table for this
932 &vlan_table->vlans[si->sub.eth.
933 outer_vlan_id].inner_any_subint;
934 if (si->sub.eth.flags.exact_match)
936 *flags = SUBINT_CONFIG_MATCH_2_TAG;
940 *flags = SUBINT_CONFIG_MATCH_2_TAG |
941 SUBINT_CONFIG_MATCH_3_TAG;
946 // a specific outer + specifc innner vlan id, a common case
948 // get the qinq table
949 if (vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs == 0)
951 // Allocate a qinq table from the pool
952 pool_get (em->qinq_pool, qinq_table);
953 vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs =
954 qinq_table - em->qinq_pool;
958 // Get ptr to existing qinq table
960 vec_elt_at_index (em->qinq_pool,
961 vlan_table->vlans[si->sub.
965 subint = &qinq_table->vlans[si->sub.eth.inner_vlan_id].subint;
975 ethernet_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
977 subint_config_t *subint;
980 clib_error_t *error = 0;
982 // Find the config for this subinterface
984 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
989 // not implemented yet or not ethernet
993 subint->sw_if_index =
994 ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? sw_if_index : ~0);
1000 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_sw_interface_up_down);
1003 // Set the L2/L3 mode for the subinterface
1005 ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index, u32 l2)
1007 subint_config_t *subint;
1011 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
1013 is_port = !(sw->type == VNET_SW_INTERFACE_TYPE_SUB);
1015 // Find the config for this subinterface
1017 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
1022 // unimplemented or not ethernet
1026 // Double check that the config we found is for our interface (or the interface is down)
1027 ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
1031 subint->flags |= SUBINT_CONFIG_L2;
1034 SUBINT_CONFIG_MATCH_0_TAG | SUBINT_CONFIG_MATCH_1_TAG
1035 | SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
1039 subint->flags &= ~SUBINT_CONFIG_L2;
1042 ~(SUBINT_CONFIG_MATCH_1_TAG | SUBINT_CONFIG_MATCH_2_TAG
1043 | SUBINT_CONFIG_MATCH_3_TAG);
1051 * Set the L2/L3 mode for the subinterface regardless of port
1054 ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
1055 u32 sw_if_index, u32 l2)
1057 subint_config_t *subint;
1061 /* Find the config for this subinterface */
1063 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
1068 /* unimplemented or not ethernet */
1073 * Double check that the config we found is for our interface (or the
1074 * interface is down)
1076 ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
1080 subint->flags |= SUBINT_CONFIG_L2;
1084 subint->flags &= ~SUBINT_CONFIG_L2;
1091 static clib_error_t *
1092 ethernet_sw_interface_add_del (vnet_main_t * vnm,
1093 u32 sw_if_index, u32 is_create)
1095 clib_error_t *error = 0;
1096 subint_config_t *subint;
1098 u32 unsupported = 0;
1100 // Find the config for this subinterface
1102 ethernet_sw_interface_get_config (vnm, sw_if_index, &match_flags,
1107 // not implemented yet or not ethernet
1110 // this is the NYI case
1111 error = clib_error_return (0, "not implemented yet");
1122 // Initialize the subint
1123 if (subint->flags & SUBINT_CONFIG_VALID)
1125 // Error vlan already in use
1126 error = clib_error_return (0, "vlan is already in use");
1130 // Note that config is L3 by defaulty
1131 subint->flags = SUBINT_CONFIG_VALID | match_flags;
1132 subint->sw_if_index = ~0; // because interfaces are initially down
1139 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ethernet_sw_interface_add_del);
1141 static char *ethernet_error_strings[] = {
1142 #define ethernet_error(n,c,s) s,
1143 #include "error.def"
1144 #undef ethernet_error
1148 VLIB_REGISTER_NODE (ethernet_input_node) = {
1149 .function = ethernet_input,
1150 .name = "ethernet-input",
1151 /* Takes a vector of packets. */
1152 .vector_size = sizeof (u32),
1153 .n_errors = ETHERNET_N_ERROR,
1154 .error_strings = ethernet_error_strings,
1155 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1157 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1158 foreach_ethernet_input_next
1161 .format_buffer = format_ethernet_header_with_length,
1162 .format_trace = format_ethernet_input_trace,
1163 .unformat_buffer = unformat_ethernet_header,
1168 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_node, ethernet_input)
1172 VLIB_REGISTER_NODE (ethernet_input_type_node, static) = {
1173 .function = ethernet_input_type,
1174 .name = "ethernet-input-type",
1175 /* Takes a vector of packets. */
1176 .vector_size = sizeof (u32),
1177 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1179 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1180 foreach_ethernet_input_next
1187 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_type_node, ethernet_input_type)
1191 VLIB_REGISTER_NODE (ethernet_input_not_l2_node, static) = {
1192 .function = ethernet_input_not_l2,
1193 .name = "ethernet-input-not-l2",
1194 /* Takes a vector of packets. */
1195 .vector_size = sizeof (u32),
1196 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1198 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1199 foreach_ethernet_input_next
1207 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_not_l2_node,
1208 ethernet_input_not_l2)
1213 ethernet_set_rx_redirect (vnet_main_t * vnm,
1214 vnet_hw_interface_t * hi, u32 enable)
1216 // Insure all packets go to ethernet-input (i.e. untagged ipv4 packets
1217 // don't go directly to ip4-input)
1218 vnet_hw_interface_rx_redirect_to_node
1219 (vnm, hi->hw_if_index, enable ? ethernet_input_node.index : ~0);
1224 * Initialization and registration for the next_by_ethernet structure
1228 next_by_ethertype_init (next_by_ethertype_t * l3_next)
1230 l3_next->input_next_by_type = sparse_vec_new
1231 ( /* elt bytes */ sizeof (l3_next->input_next_by_type[0]),
1232 /* bits in index */ BITS (((ethernet_header_t *) 0)->type));
1234 vec_validate (l3_next->sparse_index_by_input_next_index,
1235 ETHERNET_INPUT_NEXT_DROP);
1236 vec_validate (l3_next->sparse_index_by_input_next_index,
1237 ETHERNET_INPUT_NEXT_PUNT);
1238 l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_DROP] =
1239 SPARSE_VEC_INVALID_INDEX;
1240 l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_PUNT] =
1241 SPARSE_VEC_INVALID_INDEX;
1244 * Make sure we don't wipe out an ethernet registration by mistake
1245 * Can happen if init function ordering constraints are missing.
1249 ethernet_main_t *em = ðernet_main;
1250 ASSERT (em->next_by_ethertype_register_called == 0);
1256 // Add an ethertype -> next index mapping to the structure
1258 next_by_ethertype_register (next_by_ethertype_t * l3_next,
1259 u32 ethertype, u32 next_index)
1263 ethernet_main_t *em = ðernet_main;
1267 ethernet_main_t *em = ðernet_main;
1268 em->next_by_ethertype_register_called = 1;
1271 /* Setup ethernet type -> next index sparse vector mapping. */
1272 n = sparse_vec_validate (l3_next->input_next_by_type, ethertype);
1275 /* Rebuild next index -> sparse index inverse mapping when sparse vector
1277 vec_validate (l3_next->sparse_index_by_input_next_index, next_index);
1278 for (i = 1; i < vec_len (l3_next->input_next_by_type); i++)
1280 sparse_index_by_input_next_index[l3_next->input_next_by_type[i]] = i;
1282 // do not allow the cached next index's to be updated if L3
1283 // redirect is enabled, as it will have overwritten them
1284 if (!em->redirect_l3)
1286 // Cache common ethertypes directly
1287 if (ethertype == ETHERNET_TYPE_IP4)
1289 l3_next->input_next_ip4 = next_index;
1291 else if (ethertype == ETHERNET_TYPE_IP6)
1293 l3_next->input_next_ip6 = next_index;
1295 else if (ethertype == ETHERNET_TYPE_MPLS)
1297 l3_next->input_next_mpls = next_index;
1304 static clib_error_t *
1305 ethernet_input_init (vlib_main_t * vm)
1307 ethernet_main_t *em = ðernet_main;
1308 __attribute__ ((unused)) vlan_table_t *invalid_vlan_table;
1309 __attribute__ ((unused)) qinq_table_t *invalid_qinq_table;
1311 ethernet_setup_node (vm, ethernet_input_node.index);
1312 ethernet_setup_node (vm, ethernet_input_type_node.index);
1313 ethernet_setup_node (vm, ethernet_input_not_l2_node.index);
1315 next_by_ethertype_init (&em->l3_next);
1317 // Initialize pools and vector for vlan parsing
1318 vec_validate (em->main_intfs, 10); // 10 main interfaces
1319 pool_alloc (em->vlan_pool, 10);
1320 pool_alloc (em->qinq_pool, 1);
1322 // The first vlan pool will always be reserved for an invalid table
1323 pool_get (em->vlan_pool, invalid_vlan_table); // first id = 0
1324 // The first qinq pool will always be reserved for an invalid table
1325 pool_get (em->qinq_pool, invalid_qinq_table); // first id = 0
1330 VLIB_INIT_FUNCTION (ethernet_input_init);
1333 ethernet_register_input_type (vlib_main_t * vm,
1334 ethernet_type_t type, u32 node_index)
1336 ethernet_main_t *em = ðernet_main;
1337 ethernet_type_info_t *ti;
1341 clib_error_t *error = vlib_call_init_function (vm, ethernet_init);
1343 clib_error_report (error);
1346 ti = ethernet_get_type_info (em, type);
1347 ti->node_index = node_index;
1348 ti->next_index = vlib_node_add_next (vm,
1349 ethernet_input_node.index, node_index);
1350 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1351 ASSERT (i == ti->next_index);
1353 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1354 ASSERT (i == ti->next_index);
1356 // Add the L3 node for this ethertype to the next nodes structure
1357 next_by_ethertype_register (&em->l3_next, type, ti->next_index);
1359 // Call the registration functions for other nodes that want a mapping
1360 l2bvi_register_input_type (vm, type, node_index);
1364 ethernet_register_l2_input (vlib_main_t * vm, u32 node_index)
1366 ethernet_main_t *em = ðernet_main;
1370 vlib_node_add_next (vm, ethernet_input_node.index, node_index);
1373 * Even if we never use these arcs, we have to align the next indices...
1375 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1377 ASSERT (i == em->l2_next);
1379 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1380 ASSERT (i == em->l2_next);
1383 // Register a next node for L3 redirect, and enable L3 redirect
1385 ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index)
1387 ethernet_main_t *em = ðernet_main;
1390 em->redirect_l3 = 1;
1391 em->redirect_l3_next = vlib_node_add_next (vm,
1392 ethernet_input_node.index,
1395 * Change the cached next nodes to the redirect node
1397 em->l3_next.input_next_ip4 = em->redirect_l3_next;
1398 em->l3_next.input_next_ip6 = em->redirect_l3_next;
1399 em->l3_next.input_next_mpls = em->redirect_l3_next;
1402 * Even if we never use these arcs, we have to align the next indices...
1404 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1406 ASSERT (i == em->redirect_l3_next);
1408 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1410 ASSERT (i == em->redirect_l3_next);
1414 * fd.io coding-style-patch-verification: ON
1417 * eval: (c-set-style "gnu")