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)
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 thread_index = vlib_get_thread_index ();
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 (hi->hw_address != 0) &&
416 !eth_mac_equal ((u8 *) e0, hi->hw_address))
417 error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
418 if (!ethernet_address_cast (e1->dst_address) &&
419 (hi->hw_address != 0) &&
420 !eth_mac_equal ((u8 *) e1, hi->hw_address))
421 error1 = ETHERNET_ERROR_L3_MAC_MISMATCH;
422 determine_next_node (em, variant, 0, type0, b0,
424 vlib_buffer_advance (b0, sizeof (ethernet_header_t));
425 determine_next_node (em, variant, 0, type1, b1,
427 vlib_buffer_advance (b1, sizeof (ethernet_header_t));
432 /* Slow-path for the tagged case */
434 parse_header (variant,
437 &orig_type0, &outer_id0, &inner_id0, &match_flags0);
439 parse_header (variant,
442 &orig_type1, &outer_id1, &inner_id1, &match_flags1);
444 old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
445 old_sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
447 eth_vlan_table_lookups (em,
454 &main_intf0, &vlan_intf0, &qinq_intf0);
456 eth_vlan_table_lookups (em,
463 &main_intf1, &vlan_intf1, &qinq_intf1);
465 identify_subint (hi0,
470 qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
472 identify_subint (hi1,
477 qinq_intf1, &new_sw_if_index1, &error1, &is_l21);
479 // Save RX sw_if_index for later nodes
480 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
482 ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
483 vnet_buffer (b1)->sw_if_index[VLIB_RX] =
485 ETHERNET_ERROR_NONE ? old_sw_if_index1 : new_sw_if_index1;
487 // Check if there is a stat to take (valid and non-main sw_if_index for pkt 0 or pkt 1)
488 if (((new_sw_if_index0 != ~0)
489 && (new_sw_if_index0 != old_sw_if_index0))
490 || ((new_sw_if_index1 != ~0)
491 && (new_sw_if_index1 != old_sw_if_index1)))
494 len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
495 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
496 len1 = vlib_buffer_length_in_chain (vm, b1) + b1->current_data
497 - vnet_buffer (b1)->ethernet.start_of_ethernet_header;
499 stats_n_packets += 2;
500 stats_n_bytes += len0 + len1;
503 (!(new_sw_if_index0 == stats_sw_if_index
504 && new_sw_if_index1 == stats_sw_if_index)))
506 stats_n_packets -= 2;
507 stats_n_bytes -= len0 + len1;
509 if (new_sw_if_index0 != old_sw_if_index0
510 && new_sw_if_index0 != ~0)
511 vlib_increment_combined_counter (vnm->
512 interface_main.combined_sw_if_counters
514 VNET_INTERFACE_COUNTER_RX,
518 if (new_sw_if_index1 != old_sw_if_index1
519 && new_sw_if_index1 != ~0)
520 vlib_increment_combined_counter (vnm->
521 interface_main.combined_sw_if_counters
523 VNET_INTERFACE_COUNTER_RX,
528 if (new_sw_if_index0 == new_sw_if_index1)
530 if (stats_n_packets > 0)
532 vlib_increment_combined_counter
533 (vnm->interface_main.combined_sw_if_counters
534 + VNET_INTERFACE_COUNTER_RX,
537 stats_n_packets, stats_n_bytes);
538 stats_n_packets = stats_n_bytes = 0;
540 stats_sw_if_index = new_sw_if_index0;
545 if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
548 determine_next_node (em, variant, is_l20, type0, b0, &error0,
550 determine_next_node (em, variant, is_l21, type1, b1, &error1,
554 b0->error = error_node->errors[error0];
555 b1->error = error_node->errors[error1];
557 // verify speculative enqueue
558 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
559 n_left_to_next, bi0, bi1, next0,
563 while (n_left_from > 0 && n_left_to_next > 0)
568 u16 type0, orig_type0;
569 u16 outer_id0, inner_id0;
571 u32 old_sw_if_index0, new_sw_if_index0, len0;
572 vnet_hw_interface_t *hi0;
573 main_intf_t *main_intf0;
574 vlan_intf_t *vlan_intf0;
575 qinq_intf_t *qinq_intf0;
576 ethernet_header_t *e0;
579 // Prefetch next iteration
584 p2 = vlib_get_buffer (vm, from[1]);
585 vlib_prefetch_buffer_header (p2, STORE);
586 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, LOAD);
596 b0 = vlib_get_buffer (vm, bi0);
598 error0 = ETHERNET_ERROR_NONE;
599 e0 = vlib_buffer_get_current (b0);
600 type0 = clib_net_to_host_u16 (e0->type);
602 /* Speed-path for the untagged case */
603 if (PREDICT_TRUE (variant == ETHERNET_INPUT_VARIANT_ETHERNET
604 && !ethernet_frame_is_tagged (type0)))
607 subint_config_t *subint0;
610 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
611 is_l20 = cached_is_l2;
613 if (PREDICT_FALSE (cached_sw_if_index != sw_if_index0))
615 cached_sw_if_index = sw_if_index0;
616 hi = vnet_get_sup_hw_interface (vnm, sw_if_index0);
617 intf0 = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
618 subint0 = &intf0->untagged_subint;
619 cached_is_l2 = is_l20 = subint0->flags & SUBINT_CONFIG_L2;
622 vnet_buffer (b0)->ethernet.start_of_ethernet_header =
625 if (PREDICT_TRUE (is_l20 != 0))
628 vnet_buffer (b0)->l2.l2_len = sizeof (ethernet_header_t);
632 if (!ethernet_address_cast (e0->dst_address) &&
633 (hi->hw_address != 0) &&
634 !eth_mac_equal ((u8 *) e0, hi->hw_address))
635 error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
636 determine_next_node (em, variant, 0, type0, b0,
638 vlib_buffer_advance (b0, sizeof (ethernet_header_t));
643 /* Slow-path for the tagged case */
644 parse_header (variant,
647 &orig_type0, &outer_id0, &inner_id0, &match_flags0);
649 old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
651 eth_vlan_table_lookups (em,
658 &main_intf0, &vlan_intf0, &qinq_intf0);
660 identify_subint (hi0,
665 qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
667 // Save RX sw_if_index for later nodes
668 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
670 ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
672 // Increment subinterface stats
673 // Note that interface-level counters have already been incremented
674 // prior to calling this function. Thus only subinterface counters
675 // are incremented here.
677 // Interface level counters include packets received on the main
678 // interface and all subinterfaces. Subinterface level counters
679 // include only those packets received on that subinterface
680 // Increment stats if the subint is valid and it is not the main intf
681 if ((new_sw_if_index0 != ~0)
682 && (new_sw_if_index0 != old_sw_if_index0))
685 len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
686 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
688 stats_n_packets += 1;
689 stats_n_bytes += len0;
691 // Batch stat increments from the same subinterface so counters
692 // don't need to be incremented for every packet.
693 if (PREDICT_FALSE (new_sw_if_index0 != stats_sw_if_index))
695 stats_n_packets -= 1;
696 stats_n_bytes -= len0;
698 if (new_sw_if_index0 != ~0)
699 vlib_increment_combined_counter
700 (vnm->interface_main.combined_sw_if_counters
701 + VNET_INTERFACE_COUNTER_RX,
702 thread_index, new_sw_if_index0, 1, len0);
703 if (stats_n_packets > 0)
705 vlib_increment_combined_counter
706 (vnm->interface_main.combined_sw_if_counters
707 + VNET_INTERFACE_COUNTER_RX,
709 stats_sw_if_index, stats_n_packets, stats_n_bytes);
710 stats_n_packets = stats_n_bytes = 0;
712 stats_sw_if_index = new_sw_if_index0;
716 if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
719 determine_next_node (em, variant, is_l20, type0, b0, &error0,
723 b0->error = error_node->errors[error0];
725 // verify speculative enqueue
726 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
727 to_next, n_left_to_next,
731 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
734 // Increment any remaining batched stats
735 if (stats_n_packets > 0)
737 vlib_increment_combined_counter
738 (vnm->interface_main.combined_sw_if_counters
739 + VNET_INTERFACE_COUNTER_RX,
740 thread_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
741 node->runtime_data[0] = stats_sw_if_index;
744 return from_frame->n_vectors;
748 ethernet_input (vlib_main_t * vm,
749 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
751 return ethernet_input_inline (vm, node, from_frame,
752 ETHERNET_INPUT_VARIANT_ETHERNET);
756 ethernet_input_type (vlib_main_t * vm,
757 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
759 return ethernet_input_inline (vm, node, from_frame,
760 ETHERNET_INPUT_VARIANT_ETHERNET_TYPE);
764 ethernet_input_not_l2 (vlib_main_t * vm,
765 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
767 return ethernet_input_inline (vm, node, from_frame,
768 ETHERNET_INPUT_VARIANT_NOT_L2);
772 // Return the subinterface config struct for the given sw_if_index
773 // Also return via parameter the appropriate match flags for the
774 // configured number of tags.
775 // On error (unsupported or not ethernet) return 0.
776 static subint_config_t *
777 ethernet_sw_interface_get_config (vnet_main_t * vnm,
779 u32 * flags, u32 * unsupported)
781 ethernet_main_t *em = ðernet_main;
782 vnet_hw_interface_t *hi;
783 vnet_sw_interface_t *si;
784 main_intf_t *main_intf;
785 vlan_table_t *vlan_table;
786 qinq_table_t *qinq_table;
787 subint_config_t *subint = 0;
789 hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
791 if (!hi || (hi->hw_class_index != ethernet_hw_interface_class.index))
794 goto done; // non-ethernet interface
797 // ensure there's an entry for the main intf (shouldn't really be necessary)
798 vec_validate (em->main_intfs, hi->hw_if_index);
799 main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
801 // Locate the subint for the given ethernet config
802 si = vnet_get_sw_interface (vnm, sw_if_index);
804 if (si->sub.eth.flags.default_sub)
806 subint = &main_intf->default_subint;
807 *flags = SUBINT_CONFIG_MATCH_0_TAG |
808 SUBINT_CONFIG_MATCH_1_TAG |
809 SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
811 else if ((si->sub.eth.flags.no_tags) || (si->sub.eth.raw_flags == 0))
813 // if no flags are set then this is a main interface
814 // so treat as untagged
815 subint = &main_intf->untagged_subint;
816 *flags = SUBINT_CONFIG_MATCH_0_TAG;
821 // first get the vlan table
822 if (si->sub.eth.flags.dot1ad)
824 if (main_intf->dot1ad_vlans == 0)
826 // Allocate a vlan table from the pool
827 pool_get (em->vlan_pool, vlan_table);
828 main_intf->dot1ad_vlans = vlan_table - em->vlan_pool;
832 // Get ptr to existing vlan table
834 vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
839 if (main_intf->dot1q_vlans == 0)
841 // Allocate a vlan table from the pool
842 pool_get (em->vlan_pool, vlan_table);
843 main_intf->dot1q_vlans = vlan_table - em->vlan_pool;
847 // Get ptr to existing vlan table
849 vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
853 if (si->sub.eth.flags.one_tag)
855 *flags = si->sub.eth.flags.exact_match ?
856 SUBINT_CONFIG_MATCH_1_TAG :
857 (SUBINT_CONFIG_MATCH_1_TAG |
858 SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
860 if (si->sub.eth.flags.outer_vlan_id_any)
862 // not implemented yet
868 // a single vlan, a common case
870 &vlan_table->vlans[si->sub.eth.
871 outer_vlan_id].single_tag_subint;
878 *flags = si->sub.eth.flags.exact_match ?
879 SUBINT_CONFIG_MATCH_2_TAG :
880 (SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
882 if (si->sub.eth.flags.outer_vlan_id_any
883 && si->sub.eth.flags.inner_vlan_id_any)
885 // not implemented yet
890 if (si->sub.eth.flags.inner_vlan_id_any)
892 // a specific outer and "any" inner
893 // don't need a qinq table for this
895 &vlan_table->vlans[si->sub.eth.
896 outer_vlan_id].inner_any_subint;
897 if (si->sub.eth.flags.exact_match)
899 *flags = SUBINT_CONFIG_MATCH_2_TAG;
903 *flags = SUBINT_CONFIG_MATCH_2_TAG |
904 SUBINT_CONFIG_MATCH_3_TAG;
909 // a specific outer + specifc innner vlan id, a common case
911 // get the qinq table
912 if (vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs == 0)
914 // Allocate a qinq table from the pool
915 pool_get (em->qinq_pool, qinq_table);
916 vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs =
917 qinq_table - em->qinq_pool;
921 // Get ptr to existing qinq table
923 vec_elt_at_index (em->qinq_pool,
924 vlan_table->vlans[si->sub.
928 subint = &qinq_table->vlans[si->sub.eth.inner_vlan_id].subint;
938 ethernet_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
940 subint_config_t *subint;
943 clib_error_t *error = 0;
945 // Find the config for this subinterface
947 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
952 // not implemented yet or not ethernet
956 subint->sw_if_index =
957 ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? sw_if_index : ~0);
963 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_sw_interface_up_down);
966 // Set the L2/L3 mode for the subinterface
968 ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index, u32 l2)
970 subint_config_t *subint;
974 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
976 is_port = !(sw->type == VNET_SW_INTERFACE_TYPE_SUB);
978 // Find the config for this subinterface
980 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
985 // unimplemented or not ethernet
989 // Double check that the config we found is for our interface (or the interface is down)
990 ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
994 subint->flags |= SUBINT_CONFIG_L2;
997 SUBINT_CONFIG_MATCH_0_TAG | SUBINT_CONFIG_MATCH_1_TAG
998 | SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
1002 subint->flags &= ~SUBINT_CONFIG_L2;
1005 ~(SUBINT_CONFIG_MATCH_1_TAG | SUBINT_CONFIG_MATCH_2_TAG
1006 | SUBINT_CONFIG_MATCH_3_TAG);
1014 * Set the L2/L3 mode for the subinterface regardless of port
1017 ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
1018 u32 sw_if_index, u32 l2)
1020 subint_config_t *subint;
1024 /* Find the config for this subinterface */
1026 ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
1031 /* unimplemented or not ethernet */
1036 * Double check that the config we found is for our interface (or the
1037 * interface is down)
1039 ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
1043 subint->flags |= SUBINT_CONFIG_L2;
1047 subint->flags &= ~SUBINT_CONFIG_L2;
1054 static clib_error_t *
1055 ethernet_sw_interface_add_del (vnet_main_t * vnm,
1056 u32 sw_if_index, u32 is_create)
1058 clib_error_t *error = 0;
1059 subint_config_t *subint;
1061 u32 unsupported = 0;
1063 // Find the config for this subinterface
1065 ethernet_sw_interface_get_config (vnm, sw_if_index, &match_flags,
1070 // not implemented yet or not ethernet
1073 // this is the NYI case
1074 error = clib_error_return (0, "not implemented yet");
1085 // Initialize the subint
1086 if (subint->flags & SUBINT_CONFIG_VALID)
1088 // Error vlan already in use
1089 error = clib_error_return (0, "vlan is already in use");
1093 // Note that config is L3 by defaulty
1094 subint->flags = SUBINT_CONFIG_VALID | match_flags;
1095 subint->sw_if_index = ~0; // because interfaces are initially down
1102 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ethernet_sw_interface_add_del);
1104 static char *ethernet_error_strings[] = {
1105 #define ethernet_error(n,c,s) s,
1106 #include "error.def"
1107 #undef ethernet_error
1111 VLIB_REGISTER_NODE (ethernet_input_node) = {
1112 .function = ethernet_input,
1113 .name = "ethernet-input",
1114 /* Takes a vector of packets. */
1115 .vector_size = sizeof (u32),
1116 .n_errors = ETHERNET_N_ERROR,
1117 .error_strings = ethernet_error_strings,
1118 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1120 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1121 foreach_ethernet_input_next
1124 .format_buffer = format_ethernet_header_with_length,
1125 .format_trace = format_ethernet_input_trace,
1126 .unformat_buffer = unformat_ethernet_header,
1131 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_node, ethernet_input)
1135 VLIB_REGISTER_NODE (ethernet_input_type_node, static) = {
1136 .function = ethernet_input_type,
1137 .name = "ethernet-input-type",
1138 /* Takes a vector of packets. */
1139 .vector_size = sizeof (u32),
1140 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1142 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1143 foreach_ethernet_input_next
1150 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_type_node, ethernet_input_type)
1154 VLIB_REGISTER_NODE (ethernet_input_not_l2_node, static) = {
1155 .function = ethernet_input_not_l2,
1156 .name = "ethernet-input-not-l2",
1157 /* Takes a vector of packets. */
1158 .vector_size = sizeof (u32),
1159 .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1161 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1162 foreach_ethernet_input_next
1170 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_not_l2_node,
1171 ethernet_input_not_l2)
1176 ethernet_set_rx_redirect (vnet_main_t * vnm,
1177 vnet_hw_interface_t * hi, u32 enable)
1179 // Insure all packets go to ethernet-input (i.e. untagged ipv4 packets
1180 // don't go directly to ip4-input)
1181 vnet_hw_interface_rx_redirect_to_node
1182 (vnm, hi->hw_if_index, enable ? ethernet_input_node.index : ~0);
1187 * Initialization and registration for the next_by_ethernet structure
1191 next_by_ethertype_init (next_by_ethertype_t * l3_next)
1193 l3_next->input_next_by_type = sparse_vec_new
1194 ( /* elt bytes */ sizeof (l3_next->input_next_by_type[0]),
1195 /* bits in index */ BITS (((ethernet_header_t *) 0)->type));
1197 vec_validate (l3_next->sparse_index_by_input_next_index,
1198 ETHERNET_INPUT_NEXT_DROP);
1199 vec_validate (l3_next->sparse_index_by_input_next_index,
1200 ETHERNET_INPUT_NEXT_PUNT);
1201 l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_DROP] =
1202 SPARSE_VEC_INVALID_INDEX;
1203 l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_PUNT] =
1204 SPARSE_VEC_INVALID_INDEX;
1207 * Make sure we don't wipe out an ethernet registration by mistake
1208 * Can happen if init function ordering constraints are missing.
1212 ethernet_main_t *em = ðernet_main;
1213 ASSERT (em->next_by_ethertype_register_called == 0);
1219 // Add an ethertype -> next index mapping to the structure
1221 next_by_ethertype_register (next_by_ethertype_t * l3_next,
1222 u32 ethertype, u32 next_index)
1226 ethernet_main_t *em = ðernet_main;
1230 ethernet_main_t *em = ðernet_main;
1231 em->next_by_ethertype_register_called = 1;
1234 /* Setup ethernet type -> next index sparse vector mapping. */
1235 n = sparse_vec_validate (l3_next->input_next_by_type, ethertype);
1238 /* Rebuild next index -> sparse index inverse mapping when sparse vector
1240 vec_validate (l3_next->sparse_index_by_input_next_index, next_index);
1241 for (i = 1; i < vec_len (l3_next->input_next_by_type); i++)
1243 sparse_index_by_input_next_index[l3_next->input_next_by_type[i]] = i;
1245 // do not allow the cached next index's to be updated if L3
1246 // redirect is enabled, as it will have overwritten them
1247 if (!em->redirect_l3)
1249 // Cache common ethertypes directly
1250 if (ethertype == ETHERNET_TYPE_IP4)
1252 l3_next->input_next_ip4 = next_index;
1254 else if (ethertype == ETHERNET_TYPE_IP6)
1256 l3_next->input_next_ip6 = next_index;
1258 else if (ethertype == ETHERNET_TYPE_MPLS)
1260 l3_next->input_next_mpls = next_index;
1267 static clib_error_t *
1268 ethernet_input_init (vlib_main_t * vm)
1270 ethernet_main_t *em = ðernet_main;
1271 __attribute__ ((unused)) vlan_table_t *invalid_vlan_table;
1272 __attribute__ ((unused)) qinq_table_t *invalid_qinq_table;
1274 ethernet_setup_node (vm, ethernet_input_node.index);
1275 ethernet_setup_node (vm, ethernet_input_type_node.index);
1276 ethernet_setup_node (vm, ethernet_input_not_l2_node.index);
1278 next_by_ethertype_init (&em->l3_next);
1280 // Initialize pools and vector for vlan parsing
1281 vec_validate (em->main_intfs, 10); // 10 main interfaces
1282 pool_alloc (em->vlan_pool, 10);
1283 pool_alloc (em->qinq_pool, 1);
1285 // The first vlan pool will always be reserved for an invalid table
1286 pool_get (em->vlan_pool, invalid_vlan_table); // first id = 0
1287 // The first qinq pool will always be reserved for an invalid table
1288 pool_get (em->qinq_pool, invalid_qinq_table); // first id = 0
1293 VLIB_INIT_FUNCTION (ethernet_input_init);
1296 ethernet_register_input_type (vlib_main_t * vm,
1297 ethernet_type_t type, u32 node_index)
1299 ethernet_main_t *em = ðernet_main;
1300 ethernet_type_info_t *ti;
1304 clib_error_t *error = vlib_call_init_function (vm, ethernet_init);
1306 clib_error_report (error);
1309 ti = ethernet_get_type_info (em, type);
1310 ti->node_index = node_index;
1311 ti->next_index = vlib_node_add_next (vm,
1312 ethernet_input_node.index, node_index);
1313 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1314 ASSERT (i == ti->next_index);
1316 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1317 ASSERT (i == ti->next_index);
1319 // Add the L3 node for this ethertype to the next nodes structure
1320 next_by_ethertype_register (&em->l3_next, type, ti->next_index);
1322 // Call the registration functions for other nodes that want a mapping
1323 l2bvi_register_input_type (vm, type, node_index);
1327 ethernet_register_l2_input (vlib_main_t * vm, u32 node_index)
1329 ethernet_main_t *em = ðernet_main;
1333 vlib_node_add_next (vm, ethernet_input_node.index, node_index);
1336 * Even if we never use these arcs, we have to align the next indices...
1338 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1340 ASSERT (i == em->l2_next);
1342 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1343 ASSERT (i == em->l2_next);
1346 // Register a next node for L3 redirect, and enable L3 redirect
1348 ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index)
1350 ethernet_main_t *em = ðernet_main;
1353 em->redirect_l3 = 1;
1354 em->redirect_l3_next = vlib_node_add_next (vm,
1355 ethernet_input_node.index,
1358 * Change the cached next nodes to the redirect node
1360 em->l3_next.input_next_ip4 = em->redirect_l3_next;
1361 em->l3_next.input_next_ip6 = em->redirect_l3_next;
1362 em->l3_next.input_next_mpls = em->redirect_l3_next;
1365 * Even if we never use these arcs, we have to align the next indices...
1367 i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1369 ASSERT (i == em->redirect_l3_next);
1371 i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1373 ASSERT (i == em->redirect_l3_next);
1377 * fd.io coding-style-patch-verification: ON
1380 * eval: (c-set-style "gnu")