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 *type = clib_net_to_host_u16 (h0->type);
148 vlib_buffer_advance (b0, sizeof (h0[0]));
151 if (*type == ETHERNET_TYPE_VLAN)
153 // Double tagged packet
154 *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_2_TAG;
156 h0 = (void *) (b0->data + b0->current_data);
158 tag = clib_net_to_host_u16 (h0->priority_cfi_and_id);
160 *inner_id = tag & 0xfff;
162 *type = clib_net_to_host_u16 (h0->type);
164 vlib_buffer_advance (b0, sizeof (h0[0]));
167 if (*type == ETHERNET_TYPE_VLAN)
169 // More than double tagged packet
170 *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_3_TAG;
171 vlan_count = 3; // "unknown" number, aka, 3-or-more
175 ethernet_buffer_set_vlan_count (b0, vlan_count);
178 // Determine the subinterface for this packet, given the result of the
179 // vlan table lookups and vlan header parsing. Check the most specific
181 static_always_inline void
182 identify_subint (vnet_hw_interface_t * hi,
185 main_intf_t * main_intf,
186 vlan_intf_t * vlan_intf,
187 qinq_intf_t * qinq_intf,
188 u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
192 matched = eth_identify_subint (hi, b0, match_flags,
193 main_intf, vlan_intf, qinq_intf,
194 new_sw_if_index, error0, is_l2);
199 // Perform L3 my-mac filter
200 // A unicast packet arriving on an L3 interface must have a dmac matching the interface mac.
201 // This is required for promiscuous mode, else we will forward packets we aren't supposed to.
204 ethernet_header_t *e0;
207 vnet_buffer (b0)->ethernet.start_of_ethernet_header);
209 if (!(ethernet_address_cast (e0->dst_address)))
211 if (!eth_mac_equal ((u8 *) e0, hi->hw_address))
213 *error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
218 // Check for down subinterface
219 *error0 = (*new_sw_if_index) != ~0 ? (*error0) : ETHERNET_ERROR_DOWN;
223 static_always_inline void
224 determine_next_node (ethernet_main_t * em,
225 ethernet_input_variant_t variant,
227 u32 type0, vlib_buffer_t * b0, u8 * error0, u8 * next0)
229 if (PREDICT_FALSE (*error0 != ETHERNET_ERROR_NONE))
231 // some error occurred
232 *next0 = ETHERNET_INPUT_NEXT_DROP;
236 *next0 = em->l2_next;
237 // record the L2 len and reset the buffer so the L2 header is preserved
238 u32 eth_start = vnet_buffer (b0)->ethernet.start_of_ethernet_header;
239 vnet_buffer (b0)->l2.l2_len = b0->current_data - eth_start;
240 vlib_buffer_advance (b0, -ethernet_buffer_header_size (b0));
242 // check for common IP/MPLS ethertypes
244 else if (type0 == ETHERNET_TYPE_IP4)
246 *next0 = em->l3_next.input_next_ip4;
248 else if (type0 == ETHERNET_TYPE_IP6)
250 *next0 = em->l3_next.input_next_ip6;
252 else if (type0 == ETHERNET_TYPE_MPLS_UNICAST)
254 *next0 = em->l3_next.input_next_mpls;
257 else if (em->redirect_l3)
259 // L3 Redirect is on, the cached common next nodes will be
260 // pointing to the redirect node, catch the uncommon types here
261 *next0 = em->redirect_l3_next;
265 // uncommon ethertype, check table
267 i0 = sparse_vec_index (em->l3_next.input_next_by_type, type0);
268 *next0 = vec_elt (em->l3_next.input_next_by_type, i0);
271 SPARSE_VEC_INVALID_INDEX ? ETHERNET_ERROR_UNKNOWN_TYPE : *error0;
273 // The table is not populated with LLC values, so check that now.
274 // If variant is variant_ethernet then we came from LLC processing. Don't
275 // go back there; drop instead using by keeping the drop/bad table result.
276 if ((type0 < 0x600) && (variant == ETHERNET_INPUT_VARIANT_ETHERNET))
278 *next0 = ETHERNET_INPUT_NEXT_LLC;
283 static_always_inline uword
284 ethernet_input_inline (vlib_main_t * vm,
285 vlib_node_runtime_t * node,
286 vlib_frame_t * from_frame,
287 ethernet_input_variant_t variant)
289 vnet_main_t *vnm = vnet_get_main ();
290 ethernet_main_t *em = ðernet_main;
291 vlib_node_runtime_t *error_node;
292 u32 n_left_from, next_index, *from, *to_next;
293 u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
294 u32 cpu_index = os_get_cpu_number ();
295 u32 cached_sw_if_index = ~0;
296 u32 cached_is_l2 = 0; /* shut up gcc */
297 vnet_hw_interface_t *hi = NULL; /* used for main interface only */
299 if (variant != ETHERNET_INPUT_VARIANT_ETHERNET)
300 error_node = vlib_node_get_runtime (vm, ethernet_input_node.index);
304 from = vlib_frame_vector_args (from_frame);
305 n_left_from = from_frame->n_vectors;
307 if (node->flags & VLIB_NODE_FLAG_TRACE)
308 vlib_trace_frame_buffers_only (vm, node,
312 sizeof (ethernet_input_trace_t));
314 next_index = node->cached_next_index;
315 stats_sw_if_index = node->runtime_data[0];
316 stats_n_packets = stats_n_bytes = 0;
318 while (n_left_from > 0)
322 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
324 while (n_left_from >= 4 && n_left_to_next >= 2)
327 vlib_buffer_t *b0, *b1;
328 u8 next0, next1, error0, error1;
329 u16 type0, orig_type0, type1, orig_type1;
330 u16 outer_id0, inner_id0, outer_id1, inner_id1;
331 u32 match_flags0, match_flags1;
332 u32 old_sw_if_index0, new_sw_if_index0, len0, old_sw_if_index1,
333 new_sw_if_index1, len1;
334 vnet_hw_interface_t *hi0, *hi1;
335 main_intf_t *main_intf0, *main_intf1;
336 vlan_intf_t *vlan_intf0, *vlan_intf1;
337 qinq_intf_t *qinq_intf0, *qinq_intf1;
339 ethernet_header_t *e0, *e1;
341 /* Prefetch next iteration. */
343 vlib_buffer_t *b2, *b3;
345 b2 = vlib_get_buffer (vm, from[2]);
346 b3 = vlib_get_buffer (vm, from[3]);
348 vlib_prefetch_buffer_header (b2, STORE);
349 vlib_prefetch_buffer_header (b3, STORE);
351 CLIB_PREFETCH (b2->data, sizeof (ethernet_header_t), LOAD);
352 CLIB_PREFETCH (b3->data, sizeof (ethernet_header_t), LOAD);
364 b0 = vlib_get_buffer (vm, bi0);
365 b1 = vlib_get_buffer (vm, bi1);
367 error0 = error1 = ETHERNET_ERROR_NONE;
368 e0 = vlib_buffer_get_current (b0);
369 type0 = clib_net_to_host_u16 (e0->type);
370 e1 = vlib_buffer_get_current (b1);
371 type1 = clib_net_to_host_u16 (e1->type);
373 /* Speed-path for the untagged case */
374 if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
375 && !ethernet_frame_is_tagged (type0)
376 && !ethernet_frame_is_tagged (type1)))
379 subint_config_t *subint0;
380 u32 sw_if_index0, sw_if_index1;
382 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
383 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
384 is_l20 = cached_is_l2;
386 /* This is probably wholly unnecessary */
387 if (PREDICT_FALSE (sw_if_index0 != sw_if_index1))
390 /* Now sw_if_index0 == sw_if_index1 */
391 if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
393 cached_sw_if_index = sw_if_index0;
394 hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
395 intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
396 subint0 = &intf0->untagged_subint;
397 cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
400 vnet_buffer (b0)->ethernet.start_of_ethernet_header =
402 vnet_buffer (b1)->ethernet.start_of_ethernet_header =
405 if (PREDICT_TRUE (is_l20 != 0))
408 vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
410 vnet_buffer (b1)->l2.l2_len = sizeof (ethernet_header_t);
414 if (!ethernet_address_cast (e0->dst_address) &&
415 !eth_mac_equal ((u8 *) e0, hi->hw_address))
416 error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
417 if (!ethernet_address_cast (e1->dst_address) &&
418 !eth_mac_equal ((u8 *) e1, hi->hw_address))
419 error1 = ETHERNET_ERROR_L3_MAC_MISMATCH;
420 determine_next_node (em, variant, 0, type0, b0,
422 vlib_buffer_advance (b0, sizeof (ethernet_header_t));
423 determine_next_node (em, variant, 0, type1, b1,
425 vlib_buffer_advance (b1, sizeof (ethernet_header_t));
430 /* Slow-path for the tagged case */
432 parse_header (variant,
435 &orig_type0, &outer_id0, &inner_id0, &match_flags0);
437 parse_header (variant,
440 &orig_type1, &outer_id1, &inner_id1, &match_flags1);
442 old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
443 old_sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
445 eth_vlan_table_lookups (em,
452 &main_intf0, &vlan_intf0, &qinq_intf0);
454 eth_vlan_table_lookups (em,
461 &main_intf1, &vlan_intf1, &qinq_intf1);
463 identify_subint (hi0,
468 qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
470 identify_subint (hi1,
475 qinq_intf1, &new_sw_if_index1, &error1, &is_l21);
477 // Save RX sw_if_index for later nodes
478 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
480 ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
481 vnet_buffer (b1)->sw_if_index[VLIB_RX] =
483 ETHERNET_ERROR_NONE ? old_sw_if_index1 : new_sw_if_index1;
485 // Check if there is a stat to take (valid and non-main sw_if_index for pkt 0 or pkt 1)
486 if (((new_sw_if_index0 != ~0)
487 && (new_sw_if_index0 != old_sw_if_index0))
488 || ((new_sw_if_index1 != ~0)
489 && (new_sw_if_index1 != old_sw_if_index1)))
492 len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
493 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
494 len1 = vlib_buffer_length_in_chain (vm, b1) + b1->current_data
495 - vnet_buffer (b1)->ethernet.start_of_ethernet_header;
497 stats_n_packets += 2;
498 stats_n_bytes += len0 + len1;
501 (!(new_sw_if_index0 == stats_sw_if_index
502 && new_sw_if_index1 == stats_sw_if_index)))
504 stats_n_packets -= 2;
505 stats_n_bytes -= len0 + len1;
507 if (new_sw_if_index0 != old_sw_if_index0
508 && new_sw_if_index0 != ~0)
509 vlib_increment_combined_counter (vnm->
510 interface_main.combined_sw_if_counters
512 VNET_INTERFACE_COUNTER_RX,
516 if (new_sw_if_index1 != old_sw_if_index1
517 && new_sw_if_index1 != ~0)
518 vlib_increment_combined_counter (vnm->
519 interface_main.combined_sw_if_counters
521 VNET_INTERFACE_COUNTER_RX,
526 if (new_sw_if_index0 == new_sw_if_index1)
528 if (stats_n_packets > 0)
530 vlib_increment_combined_counter
531 (vnm->interface_main.combined_sw_if_counters
532 + VNET_INTERFACE_COUNTER_RX,
535 stats_n_packets, stats_n_bytes);
536 stats_n_packets = stats_n_bytes = 0;
538 stats_sw_if_index = new_sw_if_index0;
543 if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
546 determine_next_node (em, variant, is_l20, type0, b0, &error0,
548 determine_next_node (em, variant, is_l21, type1, b1, &error1,
552 b0->error = error_node->errors[error0];
553 b1->error = error_node->errors[error1];
555 // verify speculative enqueue
556 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
557 n_left_to_next, bi0, bi1, next0,
561 while (n_left_from > 0 && n_left_to_next > 0)
566 u16 type0, orig_type0;
567 u16 outer_id0, inner_id0;
569 u32 old_sw_if_index0, new_sw_if_index0, len0;
570 vnet_hw_interface_t *hi0;
571 main_intf_t *main_intf0;
572 vlan_intf_t *vlan_intf0;
573 qinq_intf_t *qinq_intf0;
574 ethernet_header_t *e0;
577 // Prefetch next iteration
582 p2 = vlib_get_buffer (vm, from[1]);
583 vlib_prefetch_buffer_header (p2, STORE);
584 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, LOAD);
594 b0 = vlib_get_buffer (vm, bi0);
596 error0 = ETHERNET_ERROR_NONE;
597 e0 = vlib_buffer_get_current (b0);
598 type0 = clib_net_to_host_u16 (e0->type);
600 /* Speed-path for the untagged case */
601 if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
602 && !ethernet_frame_is_tagged (type0)))
605 subint_config_t *subint0;
608 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
609 is_l20 = cached_is_l2;
611 if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
613 cached_sw_if_index = sw_if_index0;
614 hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
615 intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
616 subint0 = &intf0->untagged_subint;
617 cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
620 vnet_buffer (b0)->ethernet.start_of_ethernet_header =
623 if (PREDICT_TRUE (is_l20 != 0))
626 vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
630 if (!ethernet_address_cast (e0->dst_address) &&
631 !eth_mac_equal ((u8 *) e0, hi->hw_address))
632 error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
633 determine_next_node (em, variant, 0, type0, b0,
635 vlib_buffer_advance (b0, sizeof (ethernet_header_t));
640 /* Slow-path for the tagged case */
641 parse_header (variant,
644 &orig_type0, &outer_id0, &inner_id0, &match_flags0);
646 old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
648 eth_vlan_table_lookups (em,
655 &main_intf0, &vlan_intf0, &qinq_intf0);
657 identify_subint (hi0,
662 qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
664 // Save RX sw_if_index for later nodes
665 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
667 ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
669 // Increment subinterface stats
670 // Note that interface-level counters have already been incremented
671 // prior to calling this function. Thus only subinterface counters
672 // are incremented here.
674 // Interface level counters include packets received on the main
675 // interface and all subinterfaces. Subinterface level counters
676 // include only those packets received on that subinterface
677 // Increment stats if the subint is valid and it is not the main intf
678 if ((new_sw_if_index0 != ~0)
679 && (new_sw_if_index0 != old_sw_if_index0))
682 len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
683 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
685 stats_n_packets += 1;
686 stats_n_bytes += len0;
688 // Batch stat increments from the same subinterface so counters
689 // don't need to be incremented for every packet.
690 if (PREDICT_FALSE (new_sw_if_index0 != stats_sw_if_index))
692 stats_n_packets -= 1;
693 stats_n_bytes -= len0;
695 if (new_sw_if_index0 != ~0)
696 vlib_increment_combined_counter
697 (vnm->interface_main.combined_sw_if_counters
698 + VNET_INTERFACE_COUNTER_RX,
699 cpu_index, new_sw_if_index0, 1, len0);
700 if (stats_n_packets > 0)
702 vlib_increment_combined_counter
703 (vnm->interface_main.combined_sw_if_counters
704 + VNET_INTERFACE_COUNTER_RX,
706 stats_sw_if_index, stats_n_packets, stats_n_bytes);
707 stats_n_packets = stats_n_bytes = 0;
709 stats_sw_if_index = new_sw_if_index0;
713 if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
716 determine_next_node (em, variant, is_l20, type0, b0, &error0,
720 b0->error = error_node->errors[error0];
722 // verify speculative enqueue
723 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
724 to_next, n_left_to_next,
728 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
731 // Increment any remaining batched stats
732 if (stats_n_packets > 0)
734 vlib_increment_combined_counter
735 (vnm->interface_main.combined_sw_if_counters
736 + VNET_INTERFACE_COUNTER_RX,
737 cpu_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
738 node->runtime_data[0] = stats_sw_if_index;
741 return from_frame->n_vectors;
745 ethernet_input (vlib_main_t * vm,
746 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
748 return ethernet_input_inline (vm, node, from_frame,
749 ETHERNET_INPUT_VARIANT_ETHERNET);
753 ethernet_input_type (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_TYPE);
761 ethernet_input_not_l2 (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_NOT_L2);
769 // Return the subinterface config struct for the given sw_if_index
770 // Also return via parameter the appropriate match flags for the
771 // configured number of tags.
772 // On error (unsupported or not ethernet) return 0.
773 static subint_config_t *
774 ethernet_sw_interface_get_config (vnet_main_t * vnm,
776 u32 * flags, u32 * unsupported)
778 ethernet_main_t *em = ðernet_main;
779 vnet_hw_interface_t *hi;
780 vnet_sw_interface_t *si;
781 main_intf_t *main_intf;
782 vlan_table_t *vlan_table;
783 qinq_table_t *qinq_table;
784 subint_config_t *subint = 0;
786 hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
788 if (!hi || (hi->hw_class_index != ethernet_hw_interface_class.index))
791 goto done; // non-ethernet interface
794 // ensure there's an entry for the main intf (shouldn't really be necessary)
795 vec_validate (em->main_intfs, hi->hw_if_index);
796 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
798 // Locate the subint for the given ethernet config
799 si = vnet_get_sw_interface (vnm, sw_if_index);
801 if (si->sub.eth.flags.default_sub)
803 subint = &main_intf->default_subint;
804 *flags = SUBINT_CONFIG_MATCH_0_TAG |
805 SUBINT_CONFIG_MATCH_1_TAG |
806 SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
808 else if ((si->sub.eth.flags.no_tags) || (si->sub.eth.raw_flags == 0))
810 // if no flags are set then this is a main interface
811 // so treat as untagged
812 subint = &main_intf->untagged_subint;
813 *flags = SUBINT_CONFIG_MATCH_0_TAG;
818 // first get the vlan table
819 if (si->sub.eth.flags.dot1ad)
821 if (main_intf->dot1ad_vlans == 0)
823 // Allocate a vlan table from the pool
824 pool_get (em->vlan_pool, vlan_table);
825 main_intf->dot1ad_vlans = vlan_table - em->vlan_pool;
829 // Get ptr to existing vlan table
831 vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
836 if (main_intf->dot1q_vlans == 0)
838 // Allocate a vlan table from the pool
839 pool_get (em->vlan_pool, vlan_table);
840 main_intf->dot1q_vlans = vlan_table - em->vlan_pool;
844 // Get ptr to existing vlan table
846 vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
850 if (si->sub.eth.flags.one_tag)
852 *flags = si->sub.eth.flags.exact_match ?
853 SUBINT_CONFIG_MATCH_1_TAG :
854 (SUBINT_CONFIG_MATCH_1_TAG |
855 SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
857 if (si->sub.eth.flags.outer_vlan_id_any)
859 // not implemented yet
865 // a single vlan, a common case
867 &vlan_table->vlans[si->sub.eth.
868 outer_vlan_id].single_tag_subint;
875 *flags = si->sub.eth.flags.exact_match ?
876 SUBINT_CONFIG_MATCH_2_TAG :
877 (SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
879 if (si->sub.eth.flags.outer_vlan_id_any
880 && si->sub.eth.flags.inner_vlan_id_any)
882 // not implemented yet
887 if (si->sub.eth.flags.inner_vlan_id_any)
889 // a specific outer and "any" inner
890 // don't need a qinq table for this
892 &vlan_table->vlans[si->sub.eth.
893 outer_vlan_id].inner_any_subint;
894 if (si->sub.eth.flags.exact_match)
896 *flags = SUBINT_CONFIG_MATCH_2_TAG;
900 *flags = SUBINT_CONFIG_MATCH_2_TAG |
901 SUBINT_CONFIG_MATCH_3_TAG;
906 // a specific outer + specifc innner vlan id, a common case
908 // get the qinq table
909 if (vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs == 0)
911 // Allocate a qinq table from the pool
912 pool_get (em->qinq_pool, qinq_table);
913 vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs =
914 qinq_table - em->qinq_pool;
918 // Get ptr to existing qinq table
920 vec_elt_at_index (em->qinq_pool,
921 vlan_table->vlans[si->sub.
925 subint = &qinq_table->vlans[si->sub.eth.inner_vlan_id].subint;
935 ethernet_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
937 subint_config_t *subint;
940 clib_error_t *error = 0;
942 // Find the config for this subinterface
944 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
949 // not implemented yet or not ethernet
953 subint->sw_if_index =
954 ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? sw_if_index : ~0);
960 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_sw_interface_up_down);
963 // Set the L2/L3 mode for the subinterface
965 ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index, u32 l2)
967 subint_config_t *subint;
971 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
973 is_port = !(sw->type == VNET_SW_INTERFACE_TYPE_SUB);
975 // Find the config for this subinterface
977 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
982 // unimplemented or not ethernet
986 // Double check that the config we found is for our interface (or the interface is down)
987 ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
991 subint->flags |= SUBINT_CONFIG_L2;
994 SUBINT_CONFIG_MATCH_0_TAG | SUBINT_CONFIG_MATCH_1_TAG
995 | SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
999 subint->flags &= ~SUBINT_CONFIG_L2;
1002 ~(SUBINT_CONFIG_MATCH_1_TAG | SUBINT_CONFIG_MATCH_2_TAG
1003 | SUBINT_CONFIG_MATCH_3_TAG);
1011 * Set the L2/L3 mode for the subinterface regardless of port
1014 ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
1015 u32 sw_if_index, u32 l2)
1017 subint_config_t *subint;
1021 /* Find the config for this subinterface */
1023 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
1028 /* unimplemented or not ethernet */
1033 * Double check that the config we found is for our interface (or the
1034 * interface is down)
1036 ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
1040 subint->flags |= SUBINT_CONFIG_L2;
1044 subint->flags &= ~SUBINT_CONFIG_L2;
1051 static clib_error_t *
1052 ethernet_sw_interface_add_del (vnet_main_t * vnm,
1053 u32 sw_if_index, u32 is_create)
1055 clib_error_t *error = 0;
1056 subint_config_t *subint;
1058 u32 unsupported = 0;
1060 // Find the config for this subinterface
1062 ethernet_sw_interface_get_config (vnm, sw_if_index, &match_flags,
1067 // not implemented yet or not ethernet
1070 // this is the NYI case
1071 error = clib_error_return (0, "not implemented yet");
1082 // Initialize the subint
1083 if (subint->flags & SUBINT_CONFIG_VALID)
1085 // Error vlan already in use
1086 error = clib_error_return (0, "vlan is already in use");
1090 // Note that config is L3 by defaulty
1091 subint->flags = SUBINT_CONFIG_VALID | match_flags;
1092 subint->sw_if_index = ~0; // because interfaces are initially down
1099 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ethernet_sw_interface_add_del);
1101 static char *ethernet_error_strings[] = {
1102 #define ethernet_error(n,c,s) s,
1103 #include "error.def"
1104 #undef ethernet_error
1108 VLIB_REGISTER_NODE (ethernet_input_node) = {
1109 .function = ethernet_input,
1110 .name = "ethernet-input",
1111 /* Takes a vector of packets. */
1112 .vector_size = sizeof (u32),
1113 .n_errors = ETHERNET_N_ERROR,
1114 .error_strings = ethernet_error_strings,
1115 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1117 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1118 foreach_ethernet_input_next
1121 .format_buffer = format_ethernet_header_with_length,
1122 .format_trace = format_ethernet_input_trace,
1123 .unformat_buffer = unformat_ethernet_header,
1128 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_node, ethernet_input)
1132 VLIB_REGISTER_NODE (ethernet_input_type_node, static) = {
1133 .function = ethernet_input_type,
1134 .name = "ethernet-input-type",
1135 /* Takes a vector of packets. */
1136 .vector_size = sizeof (u32),
1137 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1139 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1140 foreach_ethernet_input_next
1147 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_type_node, ethernet_input_type)
1151 VLIB_REGISTER_NODE (ethernet_input_not_l2_node, static) = {
1152 .function = ethernet_input_not_l2,
1153 .name = "ethernet-input-not-l2",
1154 /* Takes a vector of packets. */
1155 .vector_size = sizeof (u32),
1156 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1158 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1159 foreach_ethernet_input_next
1167 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_not_l2_node,
1168 ethernet_input_not_l2)
1173 ethernet_set_rx_redirect (vnet_main_t * vnm,
1174 vnet_hw_interface_t * hi, u32 enable)
1176 // Insure all packets go to ethernet-input (i.e. untagged ipv4 packets
1177 // don't go directly to ip4-input)
1178 vnet_hw_interface_rx_redirect_to_node
1179 (vnm, hi->hw_if_index, enable ? ethernet_input_node.index : ~0);
1184 * Initialization and registration for the next_by_ethernet structure
1188 next_by_ethertype_init (next_by_ethertype_t * l3_next)
1190 l3_next->input_next_by_type = sparse_vec_new
1191 ( /* elt bytes */ sizeof (l3_next->input_next_by_type[0]),
1192 /* bits in index */ BITS (((ethernet_header_t *) 0)->type));
1194 vec_validate (l3_next->sparse_index_by_input_next_index,
1195 ETHERNET_INPUT_NEXT_DROP);
1196 vec_validate (l3_next->sparse_index_by_input_next_index,
1197 ETHERNET_INPUT_NEXT_PUNT);
1198 l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_DROP] =
1199 SPARSE_VEC_INVALID_INDEX;
1200 l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_PUNT] =
1201 SPARSE_VEC_INVALID_INDEX;
1204 * Make sure we don't wipe out an ethernet registration by mistake
1205 * Can happen if init function ordering constraints are missing.
1209 ethernet_main_t *em = ðernet_main;
1210 ASSERT (em->next_by_ethertype_register_called == 0);
1216 // Add an ethertype -> next index mapping to the structure
1218 next_by_ethertype_register (next_by_ethertype_t * l3_next,
1219 u32 ethertype, u32 next_index)
1223 ethernet_main_t *em = ðernet_main;
1227 ethernet_main_t *em = ðernet_main;
1228 em->next_by_ethertype_register_called = 1;
1231 /* Setup ethernet type -> next index sparse vector mapping. */
1232 n = sparse_vec_validate (l3_next->input_next_by_type, ethertype);
1235 /* Rebuild next index -> sparse index inverse mapping when sparse vector
1237 vec_validate (l3_next->sparse_index_by_input_next_index, next_index);
1238 for (i = 1; i < vec_len (l3_next->input_next_by_type); i++)
1240 sparse_index_by_input_next_index[l3_next->input_next_by_type[i]] = i;
1242 // do not allow the cached next index's to be updated if L3
1243 // redirect is enabled, as it will have overwritten them
1244 if (!em->redirect_l3)
1246 // Cache common ethertypes directly
1247 if (ethertype == ETHERNET_TYPE_IP4)
1249 l3_next->input_next_ip4 = next_index;
1251 else if (ethertype == ETHERNET_TYPE_IP6)
1253 l3_next->input_next_ip6 = next_index;
1255 else if (ethertype == ETHERNET_TYPE_MPLS_UNICAST)
1257 l3_next->input_next_mpls = next_index;
1264 static clib_error_t *
1265 ethernet_input_init (vlib_main_t * vm)
1267 ethernet_main_t *em = ðernet_main;
1268 __attribute__ ((unused)) vlan_table_t *invalid_vlan_table;
1269 __attribute__ ((unused)) qinq_table_t *invalid_qinq_table;
1271 ethernet_setup_node (vm, ethernet_input_node.index);
1272 ethernet_setup_node (vm, ethernet_input_type_node.index);
1273 ethernet_setup_node (vm, ethernet_input_not_l2_node.index);
1275 next_by_ethertype_init (&em->l3_next);
1277 // Initialize pools and vector for vlan parsing
1278 vec_validate (em->main_intfs, 10); // 10 main interfaces
1279 pool_alloc (em->vlan_pool, 10);
1280 pool_alloc (em->qinq_pool, 1);
1282 // The first vlan pool will always be reserved for an invalid table
1283 pool_get (em->vlan_pool, invalid_vlan_table); // first id = 0
1284 // The first qinq pool will always be reserved for an invalid table
1285 pool_get (em->qinq_pool, invalid_qinq_table); // first id = 0
1290 VLIB_INIT_FUNCTION (ethernet_input_init);
1293 ethernet_register_input_type (vlib_main_t * vm,
1294 ethernet_type_t type, u32 node_index)
1296 ethernet_main_t *em = ðernet_main;
1297 ethernet_type_info_t *ti;
1301 clib_error_t *error = vlib_call_init_function (vm, ethernet_init);
1303 clib_error_report (error);
1306 ti = ethernet_get_type_info (em, type);
1307 ti->node_index = node_index;
1308 ti->next_index = vlib_node_add_next (vm,
1309 ethernet_input_node.index, node_index);
1310 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1311 ASSERT (i == ti->next_index);
1313 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1314 ASSERT (i == ti->next_index);
1316 // Add the L3 node for this ethertype to the next nodes structure
1317 next_by_ethertype_register (&em->l3_next, type, ti->next_index);
1319 // Call the registration functions for other nodes that want a mapping
1320 l2bvi_register_input_type (vm, type, node_index);
1324 ethernet_register_l2_input (vlib_main_t * vm, u32 node_index)
1326 ethernet_main_t *em = ðernet_main;
1330 vlib_node_add_next (vm, ethernet_input_node.index, node_index);
1333 * Even if we never use these arcs, we have to align the next indices...
1335 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1337 ASSERT (i == em->l2_next);
1339 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1340 ASSERT (i == em->l2_next);
1343 // Register a next node for L3 redirect, and enable L3 redirect
1345 ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index)
1347 ethernet_main_t *em = ðernet_main;
1350 em->redirect_l3 = 1;
1351 em->redirect_l3_next = vlib_node_add_next (vm,
1352 ethernet_input_node.index,
1355 * Change the cached next nodes to the redirect node
1357 em->l3_next.input_next_ip4 = em->redirect_l3_next;
1358 em->l3_next.input_next_ip6 = em->redirect_l3_next;
1359 em->l3_next.input_next_mpls = em->redirect_l3_next;
1362 * Even if we never use these arcs, we have to align the next indices...
1364 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1366 ASSERT (i == em->redirect_l3_next);
1368 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1370 ASSERT (i == em->redirect_l3_next);
1374 * fd.io coding-style-patch-verification: ON
1377 * eval: (c-set-style "gnu")