2 * l2_input.c : layer 2 input packet processing
4 * Copyright (c) 2013 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vlib/vlib.h>
19 #include <vnet/vnet.h>
20 #include <vnet/pg/pg.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <vnet/ethernet/packet.h>
23 #include <vnet/ip/ip_packet.h>
24 #include <vnet/ip/ip4_packet.h>
25 #include <vnet/ip/ip6_packet.h>
26 #include <vnet/fib/fib_node.h>
27 #include <vnet/ethernet/arp_packet.h>
29 #include <vnet/l2/l2_input.h>
30 #include <vnet/l2/l2_output.h>
31 #include <vnet/l2/feat_bitmap.h>
32 #include <vnet/l2/l2_bvi.h>
33 #include <vnet/l2/l2_fib.h>
34 #include <vnet/l2/l2_bd.h>
36 #include <vppinfra/error.h>
37 #include <vppinfra/hash.h>
38 #include <vppinfra/cache.h>
42 * @brief Interface Input Mode (Layer 2 Cross-Connect or Bridge / Layer 3).
44 * This file contains the CLI Commands that modify the input mode of an
45 * interface. For interfaces in a Layer 2 cross-connect, all packets
46 * received on one interface will be transmitted to the other. For
47 * interfaces in a bridge-domain, packets will be forwarded to other
48 * interfaces in the same bridge-domain based on destination mac address.
49 * For interfaces in Layer 3 mode, the packets will be routed.
52 #ifndef CLIB_MARCH_VARIANT
54 /* Feature graph node names */
55 static char *l2input_feat_names[] = {
56 #define _(sym,name) name,
62 l2input_get_feat_names (void)
64 return l2input_feat_names;
68 format_l2_input_features (u8 * s, va_list * args)
70 static char *display_names[] = {
71 #define _(sym,name) #sym,
75 u32 feature_bitmap = va_arg (*args, u32);
76 u32 verbose = va_arg (*args, u32);
78 if (feature_bitmap == 0)
80 s = format (s, " none configured");
84 feature_bitmap &= ~L2INPUT_FEAT_DROP; /* Not a feature */
86 for (i = L2INPUT_N_FEAT - 1; i >= 0; i--)
88 if (feature_bitmap & (1 << i))
91 s = format (s, "%17s (%s)\n",
92 display_names[i], l2input_feat_names[i]);
94 s = format (s, "%s ", l2input_feat_names[i]);
99 #endif /* CLIB_MARCH_VARIANT */
103 /* per-pkt trace data */
110 /* packet trace format function */
112 format_l2input_trace (u8 * s, va_list * args)
114 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
115 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
116 l2input_trace_t *t = va_arg (*args, l2input_trace_t *);
118 s = format (s, "l2-input: sw_if_index %d dst %U src %U",
120 format_ethernet_address, t->dst,
121 format_ethernet_address, t->src);
125 extern l2input_main_t l2input_main;
127 #ifndef CLIB_MARCH_VARIANT
128 l2input_main_t l2input_main;
129 #endif /* CLIB_MARCH_VARIANT */
131 #define foreach_l2input_error \
132 _(L2INPUT, "L2 input packets") \
133 _(DROP, "L2 input drops")
137 #define _(sym,str) L2INPUT_ERROR_##sym,
138 foreach_l2input_error
143 static char *l2input_error_strings[] = {
144 #define _(sym,string) string,
145 foreach_l2input_error
158 static_always_inline void
159 classify_and_dispatch (l2input_main_t * msm, vlib_buffer_t * b0, u32 * next0)
162 * Load L2 input feature struct
163 * Load bridge domain struct
164 * Parse ethernet header to determine unicast/mcast/broadcast
166 * classify packet as IP/UDP/TCP, control, other
167 * mask feature bitmap
168 * go to first node in bitmap
169 * Later: optimize VTM
172 * set tx sw-if-handle
176 u32 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
177 ethernet_header_t *h0 = vlib_buffer_get_current (b0);
179 /* Get config for the input interface */
180 l2_input_config_t *config = vec_elt_at_index (msm->configs, sw_if_index0);
182 /* Save split horizon group */
183 vnet_buffer (b0)->l2.shg = config->shg;
185 /* determine layer2 kind for stat and mask */
186 if (PREDICT_FALSE (ethernet_address_cast (h0->dst_address)))
188 u8 *l3h0 = (u8 *) h0 + vnet_buffer (b0)->l2.l2_len;
190 #define get_u16(addr) ( *((u16 *)(addr)) )
191 u16 ethertype = clib_net_to_host_u16 (get_u16 (l3h0 - 2));
192 u8 protocol = ((ip6_header_t *) l3h0)->protocol;
194 /* Disable bridge forwarding (flooding will execute instead if not xconnect) */
195 feat_mask &= ~(L2INPUT_FEAT_FWD |
196 L2INPUT_FEAT_UU_FLOOD |
197 L2INPUT_FEAT_UU_FWD | L2INPUT_FEAT_GBP_FWD);
199 if (ethertype != ETHERNET_TYPE_ARP)
200 feat_mask &= ~(L2INPUT_FEAT_ARP_UFWD);
202 /* Disable ARP-term for non-ARP and non-ICMP6 packet */
203 if (ethertype != ETHERNET_TYPE_ARP &&
204 (ethertype != ETHERNET_TYPE_IP6 || protocol != IP_PROTOCOL_ICMP6))
205 feat_mask &= ~(L2INPUT_FEAT_ARP_TERM);
207 * For packet from BVI - set SHG of ARP request or ICMPv6 neighbor
208 * solicitation packet from BVI to 0 so it can also flood to VXLAN
209 * tunnels or other ports with the same SHG as that of the BVI.
211 else if (PREDICT_FALSE (vnet_buffer (b0)->sw_if_index[VLIB_TX] ==
214 if (ethertype == ETHERNET_TYPE_ARP)
216 ethernet_arp_header_t *arp0 = (ethernet_arp_header_t *) l3h0;
218 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request))
219 vnet_buffer (b0)->l2.shg = 0;
221 else /* must be ICMPv6 */
223 ip6_header_t *iph0 = (ip6_header_t *) l3h0;
224 icmp6_neighbor_solicitation_or_advertisement_header_t *ndh0;
225 ndh0 = ip6_next_header (iph0);
226 if (ndh0->icmp.type == ICMP6_neighbor_solicitation)
227 vnet_buffer (b0)->l2.shg = 0;
234 * For packet from BVI - set SHG of unicast packet from BVI to 0 so it
235 * is not dropped on output to VXLAN tunnels or other ports with the
236 * same SHG as that of the BVI.
238 if (PREDICT_FALSE (vnet_buffer (b0)->sw_if_index[VLIB_TX] ==
240 vnet_buffer (b0)->l2.shg = 0;
246 /* Do bridge-domain processing */
247 u16 bd_index0 = config->bd_index;
248 /* save BD ID for next feature graph nodes */
249 vnet_buffer (b0)->l2.bd_index = bd_index0;
251 /* Get config for the bridge domain interface */
252 l2_bridge_domain_t *bd_config =
253 vec_elt_at_index (msm->bd_configs, bd_index0);
255 /* Save bridge domain and interface seq_num */
257 l2fib_seq_num_t sn = {
258 .swif = *l2fib_swif_seq_num(sw_if_index0),
259 .bd = bd_config->seq_num,
262 vnet_buffer (b0)->l2.l2fib_sn = sn.as_u16;;
263 vnet_buffer (b0)->l2.bd_age = bd_config->mac_age;
266 * Process bridge domain feature enables.
267 * To perform learning/flooding/forwarding, the corresponding bit
268 * must be enabled in both the input interface config and in the
269 * bridge domain config. In the bd_bitmap, bits for features other
270 * than learning/flooding/forwarding should always be set.
272 feat_mask = feat_mask & bd_config->feature_bitmap;
274 else if (config->xconnect)
276 /* Set the output interface */
277 vnet_buffer (b0)->sw_if_index[VLIB_TX] = config->output_sw_if_index;
280 feat_mask = L2INPUT_FEAT_DROP;
282 /* mask out features from bitmap using packet type and bd config */
283 u32 feature_bitmap = config->feature_bitmap & feat_mask;
285 /* save for next feature graph nodes */
286 vnet_buffer (b0)->l2.feature_bitmap = feature_bitmap;
288 /* Determine the next node */
289 *next0 = feat_bitmap_get_next_node_index (msm->feat_next_node_index,
293 static_always_inline uword
294 l2input_node_inline (vlib_main_t * vm,
295 vlib_node_runtime_t * node, vlib_frame_t * frame,
298 u32 n_left_from, *from, *to_next;
299 l2input_next_t next_index;
300 l2input_main_t *msm = &l2input_main;
302 from = vlib_frame_vector_args (frame);
303 n_left_from = frame->n_vectors; /* number of packets to process */
304 next_index = node->cached_next_index;
306 while (n_left_from > 0)
310 /* get space to enqueue frame to graph node "next_index" */
311 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
313 while (n_left_from >= 8 && n_left_to_next >= 4)
315 u32 bi0, bi1, bi2, bi3;
316 vlib_buffer_t *b0, *b1, *b2, *b3;
317 u32 next0, next1, next2, next3;
318 u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
320 /* Prefetch next iteration. */
322 vlib_buffer_t *p4, *p5, *p6, *p7;
324 p4 = vlib_get_buffer (vm, from[4]);
325 p5 = vlib_get_buffer (vm, from[5]);
326 p6 = vlib_get_buffer (vm, from[6]);
327 p7 = vlib_get_buffer (vm, from[7]);
329 /* Prefetch the buffer header and packet for the N+2 loop iteration */
330 vlib_prefetch_buffer_header (p4, LOAD);
331 vlib_prefetch_buffer_header (p5, LOAD);
332 vlib_prefetch_buffer_header (p6, LOAD);
333 vlib_prefetch_buffer_header (p7, LOAD);
335 CLIB_PREFETCH (p4->data, CLIB_CACHE_LINE_BYTES, STORE);
336 CLIB_PREFETCH (p5->data, CLIB_CACHE_LINE_BYTES, STORE);
337 CLIB_PREFETCH (p6->data, CLIB_CACHE_LINE_BYTES, STORE);
338 CLIB_PREFETCH (p7->data, CLIB_CACHE_LINE_BYTES, STORE);
341 * Don't bother prefetching the bridge-domain config (which
342 * depends on the input config above). Only a small number of
343 * bridge domains are expected. Plus the structure is small
344 * and several fit in a cache line.
348 /* speculatively enqueue b0 and b1 to the current next frame */
349 /* bi is "buffer index", b is pointer to the buffer */
350 to_next[0] = bi0 = from[0];
351 to_next[1] = bi1 = from[1];
352 to_next[2] = bi2 = from[2];
353 to_next[3] = bi3 = from[3];
359 b0 = vlib_get_buffer (vm, bi0);
360 b1 = vlib_get_buffer (vm, bi1);
361 b2 = vlib_get_buffer (vm, bi2);
362 b3 = vlib_get_buffer (vm, bi3);
366 /* RX interface handles */
367 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
368 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
369 sw_if_index2 = vnet_buffer (b2)->sw_if_index[VLIB_RX];
370 sw_if_index3 = vnet_buffer (b3)->sw_if_index[VLIB_RX];
372 if (b0->flags & VLIB_BUFFER_IS_TRACED)
374 ethernet_header_t *h0 = vlib_buffer_get_current (b0);
376 vlib_add_trace (vm, node, b0, sizeof (*t));
377 t->sw_if_index = sw_if_index0;
378 clib_memcpy_fast (t->src, h0->src_address, 6);
379 clib_memcpy_fast (t->dst, h0->dst_address, 6);
381 if (b1->flags & VLIB_BUFFER_IS_TRACED)
383 ethernet_header_t *h1 = vlib_buffer_get_current (b1);
385 vlib_add_trace (vm, node, b1, sizeof (*t));
386 t->sw_if_index = sw_if_index1;
387 clib_memcpy_fast (t->src, h1->src_address, 6);
388 clib_memcpy_fast (t->dst, h1->dst_address, 6);
390 if (b2->flags & VLIB_BUFFER_IS_TRACED)
392 ethernet_header_t *h2 = vlib_buffer_get_current (b2);
394 vlib_add_trace (vm, node, b2, sizeof (*t));
395 t->sw_if_index = sw_if_index2;
396 clib_memcpy_fast (t->src, h2->src_address, 6);
397 clib_memcpy_fast (t->dst, h2->dst_address, 6);
399 if (b3->flags & VLIB_BUFFER_IS_TRACED)
401 ethernet_header_t *h3 = vlib_buffer_get_current (b3);
403 vlib_add_trace (vm, node, b3, sizeof (*t));
404 t->sw_if_index = sw_if_index3;
405 clib_memcpy_fast (t->src, h3->src_address, 6);
406 clib_memcpy_fast (t->dst, h3->dst_address, 6);
410 classify_and_dispatch (msm, b0, &next0);
411 classify_and_dispatch (msm, b1, &next1);
412 classify_and_dispatch (msm, b2, &next2);
413 classify_and_dispatch (msm, b3, &next3);
415 /* verify speculative enqueues, maybe switch current next frame */
416 /* if next0==next1==next_index then nothing special needs to be done */
417 vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
418 to_next, n_left_to_next,
420 next0, next1, next2, next3);
423 while (n_left_from > 0 && n_left_to_next > 0)
430 /* speculatively enqueue b0 to the current next frame */
438 b0 = vlib_get_buffer (vm, bi0);
440 if (do_trace && PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
442 ethernet_header_t *h0 = vlib_buffer_get_current (b0);
443 l2input_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
444 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
445 t->sw_if_index = sw_if_index0;
446 clib_memcpy_fast (t->src, h0->src_address, 6);
447 clib_memcpy_fast (t->dst, h0->dst_address, 6);
450 classify_and_dispatch (msm, b0, &next0);
452 /* verify speculative enqueue, maybe switch current next frame */
453 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
454 to_next, n_left_to_next,
458 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
461 vlib_node_increment_counter (vm, l2input_node.index,
462 L2INPUT_ERROR_L2INPUT, frame->n_vectors);
464 return frame->n_vectors;
467 VLIB_NODE_FN (l2input_node) (vlib_main_t * vm,
468 vlib_node_runtime_t * node, vlib_frame_t * frame)
470 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
471 return l2input_node_inline (vm, node, frame, 1 /* do_trace */ );
472 return l2input_node_inline (vm, node, frame, 0 /* do_trace */ );
476 VLIB_REGISTER_NODE (l2input_node) = {
478 .vector_size = sizeof (u32),
479 .format_trace = format_l2input_trace,
480 .format_buffer = format_ethernet_header_with_length,
481 .type = VLIB_NODE_TYPE_INTERNAL,
483 .n_errors = ARRAY_LEN(l2input_error_strings),
484 .error_strings = l2input_error_strings,
486 .n_next_nodes = L2INPUT_N_NEXT,
488 /* edit / add dispositions here */
490 [L2INPUT_NEXT_LEARN] = "l2-learn",
491 [L2INPUT_NEXT_FWD] = "l2-fwd",
492 [L2INPUT_NEXT_DROP] = "error-drop",
497 #ifndef CLIB_MARCH_VARIANT
499 l2input_init (vlib_main_t * vm)
501 l2input_main_t *mp = &l2input_main;
504 mp->vnet_main = vnet_get_main ();
506 /* Get packets RX'd from L2 interfaces */
507 ethernet_register_l2_input (vm, l2input_node.index);
509 /* Create the config vector */
510 vec_validate (mp->configs, 100);
511 /* create 100 sw interface entries and zero them */
513 /* Initialize the feature next-node indexes */
514 feat_bitmap_init_next_nodes (vm,
517 l2input_get_feat_names (),
518 mp->feat_next_node_index);
523 VLIB_INIT_FUNCTION (l2input_init);
526 /** Get a pointer to the config for the given interface. */
528 l2input_intf_config (u32 sw_if_index)
530 l2input_main_t *mp = &l2input_main;
532 vec_validate (mp->configs, sw_if_index);
533 return vec_elt_at_index (mp->configs, sw_if_index);
536 /** Enable (or disable) the feature in the bitmap for the given interface. */
538 l2input_intf_bitmap_enable (u32 sw_if_index,
539 l2input_feat_masks_t feature_bitmap, u32 enable)
541 l2_input_config_t *config = l2input_intf_config (sw_if_index);
544 config->feature_bitmap |= feature_bitmap;
546 config->feature_bitmap &= ~feature_bitmap;
548 return config->feature_bitmap;
552 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value)
554 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);;
555 bd_validate (bd_config);
556 bd_config->feature_bitmap =
557 (bd_config->feature_bitmap & ~feat_mask) | feat_value;
558 return bd_config->feature_bitmap;
562 l2input_interface_mac_change (u32 sw_if_index,
563 const u8 * old_address, const u8 * new_address)
565 /* check if the sw_if_index passed is a BVI in a BD */
566 l2_input_config_t *intf_config;
568 intf_config = l2input_intf_config (sw_if_index);
570 if (intf_config->bridge && intf_config->bvi)
572 /* delete and re-add l2fib entry for the bvi interface */
573 l2fib_del_entry (old_address, intf_config->bd_index, sw_if_index);
574 l2fib_add_entry (new_address,
575 intf_config->bd_index,
577 L2FIB_ENTRY_RESULT_FLAG_BVI |
578 L2FIB_ENTRY_RESULT_FLAG_STATIC);
583 * Set the subinterface to run in l2 or l3 mode.
584 * For L3 mode, just the sw_if_index is specified.
585 * For bridged mode, the bd id and bvi flag are also specified.
586 * For xconnect mode, the peer sw_if_index is also specified.
587 * Return 0 if ok, or non-0 if there was an error.
591 set_int_l2_mode (vlib_main_t * vm, vnet_main_t * vnet_main, /* */
592 u32 mode, /* One of L2 modes or back to L3 mode */
593 u32 sw_if_index, /* sw interface index */
594 u32 bd_index, /* for bridged interface */
595 l2_bd_port_type_t port_type, /* port_type */
596 u32 shg, /* the bridged interface split horizon group */
597 u32 xc_sw_if_index) /* peer interface for xconnect */
599 l2input_main_t *mp = &l2input_main;
600 l2output_main_t *l2om = &l2output_main;
601 vnet_main_t *vnm = vnet_get_main ();
602 vnet_hw_interface_t *hi;
603 l2_output_config_t *out_config;
604 l2_input_config_t *config;
605 l2_bridge_domain_t *bd_config;
606 i32 l2_if_adjust = 0;
607 vnet_device_class_t *dev_class;
609 hi = vnet_get_sup_hw_interface (vnet_main, sw_if_index);
610 config = l2input_intf_config (sw_if_index);
614 /* Interface is already in bridge mode. Undo the existing config. */
615 bd_config = vec_elt_at_index (mp->bd_configs, config->bd_index);
617 /* remove interface from flood vector */
618 bd_remove_member (bd_config, sw_if_index);
620 /* undo any BVI-related config */
621 if (bd_config->bvi_sw_if_index == sw_if_index)
623 vnet_sw_interface_t *si;
625 bd_config->bvi_sw_if_index = ~0;
628 /* delete the l2fib entry for the bvi interface */
629 l2fib_del_entry (hi->hw_address, config->bd_index, sw_if_index);
631 /* since this is a no longer BVI interface do not to flood to it */
632 si = vnet_get_sw_interface (vnm, sw_if_index);
633 si->flood_class = VNET_FLOOD_CLASS_NO_FLOOD;
635 if (bd_config->uu_fwd_sw_if_index == sw_if_index)
637 bd_config->uu_fwd_sw_if_index = ~0;
638 bd_config->feature_bitmap &= ~L2INPUT_FEAT_UU_FWD;
641 /* Clear MACs learned on the interface */
642 if ((config->feature_bitmap & L2INPUT_FEAT_LEARN) ||
643 (bd_config->feature_bitmap & L2INPUT_FEAT_LEARN))
644 l2fib_flush_int_mac (vm, sw_if_index);
648 else if (config->xconnect)
653 /* Make sure vector is big enough */
654 vec_validate_init_empty (l2om->output_node_index_vec, sw_if_index,
657 /* Initialize the l2-input configuration for the interface */
660 /* Set L2 config to BD index 0 so that if any packet accidentally
661 * came in on L2 path, it will be dropped in BD 0 */
662 config->xconnect = 0;
665 config->bd_index = 0;
666 config->feature_bitmap = L2INPUT_FEAT_DROP;
668 /* Clear L2 output config */
669 out_config = l2output_intf_config (sw_if_index);
670 clib_memset (out_config, 0, sizeof (l2_output_config_t));
672 /* Make sure any L2-output packet to this interface now in L3 mode is
673 * dropped. This may happen if L2 FIB MAC entry is stale */
674 l2om->output_node_index_vec[sw_if_index] = L2OUTPUT_NEXT_BAD_INTF;
678 /* Add or update l2-output node next-arc and output_node_index_vec table
679 * for the interface */
680 l2output_create_output_node_mapping (vm, vnet_main, sw_if_index);
682 if (mode == MODE_L2_BRIDGE)
687 * Remove a check that the interface must be an Ethernet.
688 * Specifically so we can bridge to L3 tunnel interfaces.
690 * if (hi->hw_class_index != ethernet_hw_interface_class.index)
694 return MODE_ERROR_ETH; /* non-ethernet */
696 config->xconnect = 0;
698 config->bd_index = bd_index;
699 *l2fib_valid_swif_seq_num (sw_if_index) += 1;
702 * Enable forwarding, flooding, learning and ARP termination by default
703 * (note that ARP term is disabled on BD feature bitmap by default)
705 config->feature_bitmap |= (L2INPUT_FEAT_FWD |
706 L2INPUT_FEAT_UU_FLOOD |
707 L2INPUT_FEAT_UU_FWD |
710 L2INPUT_FEAT_ARP_UFWD |
711 L2INPUT_FEAT_ARP_TERM);
713 /* Make sure last-chance drop is configured */
714 config->feature_bitmap |= L2INPUT_FEAT_DROP;
716 /* Make sure xconnect is disabled */
717 config->feature_bitmap &= ~L2INPUT_FEAT_XCONNECT;
719 /* Set up bridge domain */
720 bd_config = l2input_bd_config (bd_index);
721 bd_validate (bd_config);
723 /* TODO: think: add l2fib entry even for non-bvi interface? */
725 /* Do BVI interface initializations */
726 if (L2_BD_PORT_TYPE_BVI == port_type)
728 vnet_sw_interface_t *si;
730 /* ensure BD has no bvi interface (or replace that one with this??) */
731 if (bd_config->bvi_sw_if_index != ~0)
733 return MODE_ERROR_BVI_DEF; /* bd already has a bvi interface */
735 bd_config->bvi_sw_if_index = sw_if_index;
738 /* create the l2fib entry for the bvi interface */
739 l2fib_add_entry (hi->hw_address, bd_index, sw_if_index,
740 L2FIB_ENTRY_RESULT_FLAG_BVI |
741 L2FIB_ENTRY_RESULT_FLAG_STATIC);
743 /* Disable learning by default. no use since l2fib entry is static. */
744 config->feature_bitmap &= ~L2INPUT_FEAT_LEARN;
746 /* since this is a BVI interface we want to flood to it */
747 si = vnet_get_sw_interface (vnm, sw_if_index);
748 si->flood_class = VNET_FLOOD_CLASS_BVI;
749 member_flags = L2_FLOOD_MEMBER_BVI;
751 else if (L2_BD_PORT_TYPE_UU_FWD == port_type)
753 bd_config->uu_fwd_sw_if_index = sw_if_index;
754 bd_config->feature_bitmap |= L2INPUT_FEAT_UU_FWD;
758 member_flags = L2_FLOOD_MEMBER_NORMAL;
761 if (L2_BD_PORT_TYPE_NORMAL == port_type ||
762 L2_BD_PORT_TYPE_BVI == port_type)
764 /* Add interface to bridge-domain flood vector */
765 l2_flood_member_t member = {
766 .sw_if_index = sw_if_index,
767 .flags = member_flags,
770 bd_add_member (bd_config, &member);
773 else if (mode == MODE_L2_XC)
775 config->xconnect = 1;
777 config->output_sw_if_index = xc_sw_if_index;
779 /* Make sure last-chance drop is configured */
780 config->feature_bitmap |= L2INPUT_FEAT_DROP;
782 /* Make sure bridging features are disabled */
783 config->feature_bitmap &=
784 ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
786 config->feature_bitmap |= L2INPUT_FEAT_XCONNECT;
787 shg = 0; /* not used in xconnect */
789 else if (mode == MODE_L2_CLASSIFY)
791 config->xconnect = 1;
793 config->output_sw_if_index = xc_sw_if_index;
795 /* Make sure last-chance drop is configured */
796 config->feature_bitmap |=
797 L2INPUT_FEAT_DROP | L2INPUT_FEAT_INPUT_CLASSIFY;
799 /* Make sure bridging features are disabled */
800 config->feature_bitmap &=
801 ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
802 shg = 0; /* not used in xconnect */
804 /* Insure all packets go to ethernet-input */
805 ethernet_set_rx_redirect (vnet_main, hi, 1);
808 /* set up split-horizon group and set output feature bit */
810 out_config = l2output_intf_config (sw_if_index);
811 out_config->shg = shg;
812 out_config->feature_bitmap |= L2OUTPUT_FEAT_OUTPUT;
815 * Test: remove this when non-IP features can be configured.
816 * Enable a non-IP feature to test IP feature masking
817 * config->feature_bitmap |= L2INPUT_FEAT_CTRL_PKT;
823 /* Adjust count of L2 interfaces */
824 hi->l2_if_count += l2_if_adjust;
826 if (hi->hw_class_index == ethernet_hw_interface_class.index)
828 if ((hi->l2_if_count == 1) && (l2_if_adjust == 1))
830 /* Just added first L2 interface on this port */
832 /* Set promiscuous mode on the l2 interface */
833 ethernet_set_flags (vnet_main, hi->hw_if_index,
834 ETHERNET_INTERFACE_FLAG_ACCEPT_ALL);
836 /* ensure all packets go to ethernet-input */
837 ethernet_set_rx_redirect (vnet_main, hi, 1);
840 else if ((hi->l2_if_count == 0) && (l2_if_adjust == -1))
842 /* Just removed only L2 subinterface on this port */
844 /* Disable promiscuous mode on the l2 interface */
845 ethernet_set_flags (vnet_main, hi->hw_if_index, 0);
847 /* Allow ip packets to go directly to ip4-input etc */
848 ethernet_set_rx_redirect (vnet_main, hi, 0);
852 /* Set up the L2/L3 flag in the interface parsing tables */
853 ethernet_sw_interface_set_l2_mode (vnm, sw_if_index, (mode != MODE_L3));
855 dev_class = vnet_get_device_class (vnet_main, hi->dev_class_index);
856 if (dev_class->set_l2_mode_function)
858 dev_class->set_l2_mode_function (vnet_main, hi, l2_if_adjust);
863 #endif /* CLIB_MARCH_VARIANT */
866 * Set subinterface in bridging mode with a bridge-domain ID.
868 * set interface l2 bridge <interface> <bd> [bvi] [split-horizon-group]
870 static clib_error_t *
871 int_l2_bridge (vlib_main_t * vm,
872 unformat_input_t * input, vlib_cli_command_t * cmd)
874 vnet_main_t *vnm = vnet_get_main ();
875 l2_bd_port_type_t port_type;
876 clib_error_t *error = 0;
882 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
884 error = clib_error_return (0, "unknown interface `%U'",
885 format_unformat_error, input);
889 if (!unformat (input, "%d", &bd_id))
891 error = clib_error_return (0, "expected bridge domain ID `%U'",
892 format_unformat_error, input);
896 if (bd_id > L2_BD_ID_MAX)
898 error = clib_error_return (0, "bridge domain ID exceed 16M limit",
899 format_unformat_error, input);
902 bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
905 port_type = L2_BD_PORT_TYPE_NORMAL;
906 if (unformat (input, "bvi"))
907 port_type = L2_BD_PORT_TYPE_BVI;
908 if (unformat (input, "uu-fwd"))
909 port_type = L2_BD_PORT_TYPE_UU_FWD;
911 /* optional split horizon group */
913 (void) unformat (input, "%d", &shg);
915 /* set the interface mode */
917 set_int_l2_mode (vm, vnm, MODE_L2_BRIDGE, sw_if_index, bd_index,
920 if (rc == MODE_ERROR_ETH)
922 error = clib_error_return (0, "bridged interface must be ethernet",
923 format_unformat_error, input);
925 else if (rc == MODE_ERROR_BVI_DEF)
928 clib_error_return (0, "bridge-domain already has a bvi interface",
929 format_unformat_error, input);
933 error = clib_error_return (0, "invalid configuration for interface",
934 format_unformat_error, input);
944 * Use this command put an interface into Layer 2 bridge domain. If a
945 * bridge-domain with the provided bridge-domain-id does not exist, it
946 * will be created. Interfaces in a bridge-domain forward packets to
947 * other interfaces in the same bridge-domain based on destination mac
948 * address. To remove an interface from a the Layer 2 bridge domain,
949 * put the interface in a different mode, for example Layer 3 mode.
951 * Optionally, an interface can be added to a Layer 2 bridge-domain as
952 * a Bridged Virtual Interface (bvi). Only one interface in a Layer 2
953 * bridge-domain can be a bvi.
955 * Optionally, a split-horizon group can also be specified. This defaults
956 * to 0 if not specified.
959 * Example of how to configure a Layer 2 bridge-domain with three
960 * interfaces (where 200 is the bridge-domain-id):
961 * @cliexcmd{set interface l2 bridge GigabitEthernet0/8/0.200 200}
962 * This interface is added a BVI interface:
963 * @cliexcmd{set interface l2 bridge GigabitEthernet0/9/0.200 200 bvi}
964 * This interface also has a split-horizon group of 1 specified:
965 * @cliexcmd{set interface l2 bridge GigabitEthernet0/a/0.200 200 1}
966 * Example of how to remove an interface from a Layer2 bridge-domain:
967 * @cliexcmd{set interface l3 GigabitEthernet0/a/0.200}
970 VLIB_CLI_COMMAND (int_l2_bridge_cli, static) = {
971 .path = "set interface l2 bridge",
972 .short_help = "set interface l2 bridge <interface> <bridge-domain-id> [bvi|uu-fwd] [shg]",
973 .function = int_l2_bridge,
978 * Set subinterface in xconnect mode with another interface.
980 * set interface l2 xconnect <interface> <peer interface>
982 static clib_error_t *
983 int_l2_xc (vlib_main_t * vm,
984 unformat_input_t * input, vlib_cli_command_t * cmd)
986 vnet_main_t *vnm = vnet_get_main ();
987 clib_error_t *error = 0;
991 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
993 error = clib_error_return (0, "unknown interface `%U'",
994 format_unformat_error, input);
999 (input, unformat_vnet_sw_interface, vnm, &xc_sw_if_index))
1001 error = clib_error_return (0, "unknown peer interface `%U'",
1002 format_unformat_error, input);
1006 /* set the interface mode */
1008 (vm, vnm, MODE_L2_XC, sw_if_index, 0, L2_BD_PORT_TYPE_NORMAL,
1011 error = clib_error_return (0, "invalid configuration for interface",
1012 format_unformat_error, input);
1021 * Use this command put an interface into Layer 2 cross-connect mode.
1022 * Both interfaces must be in this mode for bi-directional traffic. All
1023 * packets received on one interface will be transmitted to the other.
1024 * To remove the Layer 2 cross-connect, put the interface in a different
1025 * mode, for example Layer 3 mode.
1028 * Example of how to configure a Layer2 cross-connect between two interfaces:
1029 * @cliexcmd{set interface l2 xconnect GigabitEthernet0/8/0.300 GigabitEthernet0/9/0.300}
1030 * @cliexcmd{set interface l2 xconnect GigabitEthernet0/9/0.300 GigabitEthernet0/8/0.300}
1031 * Example of how to remove a Layer2 cross-connect:
1032 * @cliexcmd{set interface l3 GigabitEthernet0/8/0.300}
1033 * @cliexcmd{set interface l3 GigabitEthernet0/9/0.300}
1036 VLIB_CLI_COMMAND (int_l2_xc_cli, static) = {
1037 .path = "set interface l2 xconnect",
1038 .short_help = "set interface l2 xconnect <interface> <peer interface>",
1039 .function = int_l2_xc,
1044 * Set subinterface in L3 mode.
1045 * The CLI format is:
1046 * set interface l3 <interface>
1048 static clib_error_t *
1049 int_l3 (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1051 vnet_main_t *vnm = vnet_get_main ();
1052 clib_error_t *error = 0;
1055 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1057 error = clib_error_return (0, "unknown interface `%U'",
1058 format_unformat_error, input);
1062 /* set the interface mode */
1063 if (set_int_l2_mode (vm, vnm, MODE_L3, sw_if_index, 0,
1064 L2_BD_PORT_TYPE_NORMAL, 0, 0))
1066 error = clib_error_return (0, "invalid configuration for interface",
1067 format_unformat_error, input);
1076 * Modify the packet processing mode of the interface to Layer 3, which
1077 * implies packets will be routed. This is the default mode of an interface.
1078 * Use this command to remove an interface from a Layer 2 cross-connect or a
1082 * Example of how to set the mode of an interface to Layer 3:
1083 * @cliexcmd{set interface l3 GigabitEthernet0/8/0.200}
1086 VLIB_CLI_COMMAND (int_l3_cli, static) = {
1087 .path = "set interface l3",
1088 .short_help = "set interface l3 <interface>",
1094 * Show interface mode.
1095 * The CLI format is:
1096 * show mode [<if-name1> <if-name2> ...]
1098 static clib_error_t *
1099 show_int_mode (vlib_main_t * vm,
1100 unformat_input_t * input, vlib_cli_command_t * cmd)
1102 vnet_main_t *vnm = vnet_get_main ();
1103 clib_error_t *error = 0;
1106 vnet_interface_main_t *im = &vnm->interface_main;
1108 vnet_sw_interface_t *si, *sis = 0;
1109 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1113 /* See if user wants to show specific interface */
1115 (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1117 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
1118 vec_add1 (sis, si[0]);
1122 error = clib_error_return (0, "unknown input `%U'",
1123 format_unformat_error, input);
1128 if (vec_len (sis) == 0) /* Get all interfaces */
1130 /* Gather interfaces. */
1131 sis = vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
1134 pool_foreach (si, im->sw_interfaces, ({ vec_add1 (sis, si[0]); }));
1138 vec_foreach (si, sis)
1140 l2_input_config_t *config = l2input_intf_config (si->sw_if_index);
1145 bd_id = l2input_main.bd_configs[config->bd_index].bd_id;
1147 args = format (0, "bd_id %d%s%d", bd_id,
1148 config->bvi ? " bvi shg " : " shg ", config->shg);
1150 else if (config->xconnect)
1152 mode = "l2 xconnect";
1153 args = format (0, "%U",
1154 format_vnet_sw_if_index_name,
1155 vnm, config->output_sw_if_index);
1160 args = format (0, " ");
1162 vlib_cli_output (vm, "%s %U %v\n",
1164 format_vnet_sw_if_index_name,
1165 vnm, si->sw_if_index, args);
1176 * Show the packet processing mode (Layer2 cross-connect, Layer 2 bridge,
1177 * Layer 3 routed) of all interfaces and sub-interfaces, or limit the
1178 * output to just the provided list of interfaces and sub-interfaces.
1179 * The output shows the mode, the interface, and if the interface is
1180 * a member of a bridge, the bridge-domain-id and the split horizon group (shg).
1183 * Example of displaying the mode of all interfaces:
1184 * @cliexstart{show mode}
1186 * l3 GigabitEthernet0/8/0
1187 * l3 GigabitEthernet0/9/0
1188 * l3 GigabitEthernet0/a/0
1189 * l2 bridge GigabitEthernet0/8/0.200 bd_id 200 shg 0
1190 * l2 bridge GigabitEthernet0/9/0.200 bd_id 200 shg 0
1191 * l2 bridge GigabitEthernet0/a/0.200 bd_id 200 shg 0
1192 * l2 xconnect GigabitEthernet0/8/0.300 GigabitEthernet0/9/0.300
1193 * l2 xconnect GigabitEthernet0/9/0.300 GigabitEthernet0/8/0.300
1195 * Example of displaying the mode of a selected list of interfaces:
1196 * @cliexstart{show mode GigabitEthernet0/8/0 GigabitEthernet0/8/0.200}
1197 * l3 GigabitEthernet0/8/0
1198 * l2 bridge GigabitEthernet0/8/0.200 bd_id 200 shg 0
1202 VLIB_CLI_COMMAND (show_l2_mode, static) = {
1203 .path = "show mode",
1204 .short_help = "show mode [<if-name1> <if-name2> ...]",
1205 .function = show_int_mode,
1209 #define foreach_l2_init_function \
1210 _(feat_bitmap_drop_init) \
1212 _(l2_input_classify_init) \
1215 _(l2_in_out_acl_init) \
1219 _(l2_efp_filter_init) \
1226 #ifndef CLIB_MARCH_VARIANT
1228 l2_init (vlib_main_t * vm)
1230 clib_error_t *error;
1233 if ((error = vlib_call_init_function (vm, a))) return error; } \
1235 foreach_l2_init_function;
1240 VLIB_INIT_FUNCTION (l2_init);
1241 #endif /* CLIB_MARCH_VARIANT */
1244 * fd.io coding-style-patch-verification: ON
1247 * eval: (c-set-style "gnu")