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>
27 #include <vnet/l2/l2_input.h>
28 #include <vnet/l2/l2_output.h>
29 #include <vnet/l2/feat_bitmap.h>
30 #include <vnet/l2/l2_bvi.h>
31 #include <vnet/l2/l2_fib.h>
33 #include <vppinfra/error.h>
34 #include <vppinfra/hash.h>
35 #include <vppinfra/cache.h>
39 * @brief Interface Input Mode (Layer 2 Cross-Connect or Bridge / Layer 3).
41 * This file contains the CLI Commands that modify the input mode of an
42 * interface. For interfaces in a Layer 2 cross-connect, all packets
43 * received on one interface will be transmitted to the other. For
44 * interfaces in a bridge-domain, packets will be forwarded to other
45 * interfaces in the same bridge-domain based on destination mac address.
46 * For interfaces in Layer 3 mode, the packets will be routed.
49 /* Feature graph node names */
50 static char *l2input_feat_names[] = {
51 #define _(sym,name) name,
57 l2input_get_feat_names (void)
59 return l2input_feat_names;
65 /* per-pkt trace data */
72 /* packet trace format function */
74 format_l2input_trace (u8 * s, va_list * args)
76 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
77 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
78 l2input_trace_t *t = va_arg (*args, l2input_trace_t *);
80 s = format (s, "l2-input: sw_if_index %d dst %U src %U",
82 format_ethernet_address, t->dst,
83 format_ethernet_address, t->src);
87 l2input_main_t l2input_main;
89 #define foreach_l2input_error \
90 _(L2INPUT, "L2 input packets") \
91 _(DROP, "L2 input drops")
95 #define _(sym,str) L2INPUT_ERROR_##sym,
101 static char *l2input_error_strings[] = {
102 #define _(sym,string) string,
103 foreach_l2input_error
116 static_always_inline void
117 classify_and_dispatch (vlib_main_t * vm,
118 vlib_node_runtime_t * node,
120 l2input_main_t * msm, vlib_buffer_t * b0, u32 * next0)
123 * Load L2 input feature struct
124 * Load bridge domain struct
125 * Parse ethernet header to determine unicast/mcast/broadcast
127 * classify packet as IP/UDP/TCP, control, other
128 * mask feature bitmap
129 * go to first node in bitmap
130 * Later: optimize VTM
133 * set tx sw-if-handle
138 l2_input_config_t *config;
139 l2_bridge_domain_t *bd_config;
143 ethernet_header_t *h0;
147 #define get_u16(addr) ( *((u16 *)(addr)) )
149 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
151 h0 = vlib_buffer_get_current (b0);
152 l3h0 = (u8 *) h0 + vnet_buffer (b0)->l2.l2_len;
154 ethertype = clib_net_to_host_u16 (get_u16 (l3h0 - 2));
157 /* Get config for the input interface */
158 config = vec_elt_at_index (msm->configs, sw_if_index0);
160 /* Save split horizon group */
161 vnet_buffer (b0)->l2.shg = config->shg;
163 /* determine layer2 kind for stat and mask */
164 if (PREDICT_FALSE (ethernet_address_cast (h0->dst_address)))
166 protocol = ((ip6_header_t *) l3h0)->protocol;
168 /* Disable bridge forwarding (flooding will execute instead if not xconnect) */
169 feat_mask &= ~(L2INPUT_FEAT_FWD | L2INPUT_FEAT_UU_FLOOD);
171 /* Disable ARP-term for non-ARP and non-ICMP6 packet */
172 if (ethertype != ETHERNET_TYPE_ARP &&
173 (ethertype != ETHERNET_TYPE_IP6 || protocol != IP_PROTOCOL_ICMP6))
174 feat_mask &= ~(L2INPUT_FEAT_ARP_TERM);
179 * Check for from-BVI processing - set SHG of unicast packets from BVI
180 * to 0 so it is not dropped for VXLAN tunnels or other ports with the
181 * same SHG as that of the BVI.
183 if (PREDICT_FALSE (vnet_buffer (b0)->sw_if_index[VLIB_TX] ==
185 vnet_buffer (b0)->l2.shg = 0;
189 if (config->xconnect)
191 /* Set the output interface */
192 vnet_buffer (b0)->sw_if_index[VLIB_TX] = config->output_sw_if_index;
196 /* Do bridge-domain processing */
197 bd_index0 = config->bd_index;
198 /* save BD ID for next feature graph nodes */
199 vnet_buffer (b0)->l2.bd_index = bd_index0;
201 /* Get config for the bridge domain interface */
202 bd_config = vec_elt_at_index (msm->bd_configs, bd_index0);
205 * Process bridge domain feature enables.
206 * To perform learning/flooding/forwarding, the corresponding bit
207 * must be enabled in both the input interface config and in the
208 * bridge domain config. In the bd_bitmap, bits for features other
209 * than learning/flooding/forwarding should always be set.
211 feat_mask = feat_mask & bd_config->feature_bitmap;
214 /* mask out features from bitmap using packet type and bd config */
215 feature_bitmap = config->feature_bitmap & feat_mask;
217 /* save for next feature graph nodes */
218 vnet_buffer (b0)->l2.feature_bitmap = feature_bitmap;
220 /* Determine the next node */
221 *next0 = feat_bitmap_get_next_node_index (msm->feat_next_node_index,
225 static_always_inline uword
226 l2input_node_inline (vlib_main_t * vm,
227 vlib_node_runtime_t * node, vlib_frame_t * frame,
230 u32 n_left_from, *from, *to_next;
231 l2input_next_t next_index;
232 l2input_main_t *msm = &l2input_main;
233 u32 cpu_index = os_get_cpu_number ();
235 from = vlib_frame_vector_args (frame);
236 n_left_from = frame->n_vectors; /* number of packets to process */
237 next_index = node->cached_next_index;
239 while (n_left_from > 0)
243 /* get space to enqueue frame to graph node "next_index" */
244 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
246 while (n_left_from >= 8 && n_left_to_next >= 4)
248 u32 bi0, bi1, bi2, bi3;
249 vlib_buffer_t *b0, *b1, *b2, *b3;
250 u32 next0, next1, next2, next3;
251 u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
253 /* Prefetch next iteration. */
255 vlib_buffer_t *p4, *p5, *p6, *p7;
257 p4 = vlib_get_buffer (vm, from[4]);
258 p5 = vlib_get_buffer (vm, from[5]);
259 p6 = vlib_get_buffer (vm, from[6]);
260 p7 = vlib_get_buffer (vm, from[7]);
262 /* Prefetch the buffer header and packet for the N+2 loop iteration */
263 vlib_prefetch_buffer_header (p4, LOAD);
264 vlib_prefetch_buffer_header (p5, LOAD);
265 vlib_prefetch_buffer_header (p6, LOAD);
266 vlib_prefetch_buffer_header (p7, LOAD);
268 CLIB_PREFETCH (p4->data, CLIB_CACHE_LINE_BYTES, STORE);
269 CLIB_PREFETCH (p5->data, CLIB_CACHE_LINE_BYTES, STORE);
270 CLIB_PREFETCH (p6->data, CLIB_CACHE_LINE_BYTES, STORE);
271 CLIB_PREFETCH (p7->data, CLIB_CACHE_LINE_BYTES, STORE);
274 * Don't bother prefetching the bridge-domain config (which
275 * depends on the input config above). Only a small number of
276 * bridge domains are expected. Plus the structure is small
277 * and several fit in a cache line.
281 /* speculatively enqueue b0 and b1 to the current next frame */
282 /* bi is "buffer index", b is pointer to the buffer */
283 to_next[0] = bi0 = from[0];
284 to_next[1] = bi1 = from[1];
285 to_next[2] = bi2 = from[2];
286 to_next[3] = bi3 = from[3];
292 b0 = vlib_get_buffer (vm, bi0);
293 b1 = vlib_get_buffer (vm, bi1);
294 b2 = vlib_get_buffer (vm, bi2);
295 b3 = vlib_get_buffer (vm, bi3);
299 /* RX interface handles */
300 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
301 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
302 sw_if_index2 = vnet_buffer (b2)->sw_if_index[VLIB_RX];
303 sw_if_index3 = vnet_buffer (b3)->sw_if_index[VLIB_RX];
305 if (b0->flags & VLIB_BUFFER_IS_TRACED)
307 ethernet_header_t *h0 = vlib_buffer_get_current (b0);
309 vlib_add_trace (vm, node, b0, sizeof (*t));
310 t->sw_if_index = sw_if_index0;
311 clib_memcpy (t->src, h0->src_address, 6);
312 clib_memcpy (t->dst, h0->dst_address, 6);
314 if (b1->flags & VLIB_BUFFER_IS_TRACED)
316 ethernet_header_t *h1 = vlib_buffer_get_current (b1);
318 vlib_add_trace (vm, node, b1, sizeof (*t));
319 t->sw_if_index = sw_if_index1;
320 clib_memcpy (t->src, h1->src_address, 6);
321 clib_memcpy (t->dst, h1->dst_address, 6);
323 if (b2->flags & VLIB_BUFFER_IS_TRACED)
325 ethernet_header_t *h2 = vlib_buffer_get_current (b2);
327 vlib_add_trace (vm, node, b2, sizeof (*t));
328 t->sw_if_index = sw_if_index2;
329 clib_memcpy (t->src, h2->src_address, 6);
330 clib_memcpy (t->dst, h2->dst_address, 6);
332 if (b3->flags & VLIB_BUFFER_IS_TRACED)
334 ethernet_header_t *h3 = vlib_buffer_get_current (b3);
336 vlib_add_trace (vm, node, b3, sizeof (*t));
337 t->sw_if_index = sw_if_index3;
338 clib_memcpy (t->src, h3->src_address, 6);
339 clib_memcpy (t->dst, h3->dst_address, 6);
343 vlib_node_increment_counter (vm, l2input_node.index,
344 L2INPUT_ERROR_L2INPUT, 4);
346 classify_and_dispatch (vm, node, cpu_index, msm, b0, &next0);
347 classify_and_dispatch (vm, node, cpu_index, msm, b1, &next1);
348 classify_and_dispatch (vm, node, cpu_index, msm, b2, &next2);
349 classify_and_dispatch (vm, node, cpu_index, msm, b3, &next3);
351 /* verify speculative enqueues, maybe switch current next frame */
352 /* if next0==next1==next_index then nothing special needs to be done */
353 vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
354 to_next, n_left_to_next,
356 next0, next1, next2, next3);
359 while (n_left_from > 0 && n_left_to_next > 0)
366 /* speculatively enqueue b0 to the current next frame */
374 b0 = vlib_get_buffer (vm, bi0);
376 if (do_trace && PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
378 ethernet_header_t *h0 = vlib_buffer_get_current (b0);
379 l2input_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
380 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
381 t->sw_if_index = sw_if_index0;
382 clib_memcpy (t->src, h0->src_address, 6);
383 clib_memcpy (t->dst, h0->dst_address, 6);
386 vlib_node_increment_counter (vm, l2input_node.index,
387 L2INPUT_ERROR_L2INPUT, 1);
389 classify_and_dispatch (vm, node, cpu_index, msm, b0, &next0);
391 /* verify speculative enqueue, maybe switch current next frame */
392 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
393 to_next, n_left_to_next,
397 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
400 return frame->n_vectors;
404 l2input_node_fn (vlib_main_t * vm,
405 vlib_node_runtime_t * node, vlib_frame_t * frame)
407 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
408 return l2input_node_inline (vm, node, frame, 1 /* do_trace */ );
409 return l2input_node_inline (vm, node, frame, 0 /* do_trace */ );
413 VLIB_REGISTER_NODE (l2input_node) = {
414 .function = l2input_node_fn,
416 .vector_size = sizeof (u32),
417 .format_trace = format_l2input_trace,
418 .format_buffer = format_ethernet_header_with_length,
419 .type = VLIB_NODE_TYPE_INTERNAL,
421 .n_errors = ARRAY_LEN(l2input_error_strings),
422 .error_strings = l2input_error_strings,
424 .n_next_nodes = L2INPUT_N_NEXT,
426 /* edit / add dispositions here */
428 [L2INPUT_NEXT_LEARN] = "l2-learn",
429 [L2INPUT_NEXT_FWD] = "l2-fwd",
430 [L2INPUT_NEXT_DROP] = "error-drop",
435 VLIB_NODE_FUNCTION_MULTIARCH (l2input_node, l2input_node_fn)
436 clib_error_t *l2input_init (vlib_main_t * vm)
438 l2input_main_t *mp = &l2input_main;
441 mp->vnet_main = vnet_get_main ();
443 /* Get packets RX'd from L2 interfaces */
444 ethernet_register_l2_input (vm, l2input_node.index);
446 /* Create the config vector */
447 vec_validate (mp->configs, 100);
448 /* create 100 sw interface entries and zero them */
450 /* Initialize the feature next-node indexes */
451 feat_bitmap_init_next_nodes (vm,
454 l2input_get_feat_names (),
455 mp->feat_next_node_index);
460 VLIB_INIT_FUNCTION (l2input_init);
463 /** Get a pointer to the config for the given interface. */
465 l2input_intf_config (u32 sw_if_index)
467 l2input_main_t *mp = &l2input_main;
469 vec_validate (mp->configs, sw_if_index);
470 return vec_elt_at_index (mp->configs, sw_if_index);
473 /** Enable (or disable) the feature in the bitmap for the given interface. */
475 l2input_intf_bitmap_enable (u32 sw_if_index, u32 feature_bitmap, u32 enable)
477 l2input_main_t *mp = &l2input_main;
478 l2_input_config_t *config;
480 vec_validate (mp->configs, sw_if_index);
481 config = vec_elt_at_index (mp->configs, sw_if_index);
485 config->feature_bitmap |= feature_bitmap;
489 config->feature_bitmap &= ~feature_bitmap;
492 return config->feature_bitmap;
496 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value)
498 l2_bridge_domain_t *bd_config;
499 vec_validate (l2input_main.bd_configs, bd_index);
500 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
501 bd_validate (bd_config);
502 bd_config->feature_bitmap =
503 (bd_config->feature_bitmap & ~feat_mask) | feat_value;
504 return bd_config->feature_bitmap;
508 * Set the subinterface to run in l2 or l3 mode.
509 * For L3 mode, just the sw_if_index is specified.
510 * For bridged mode, the bd id and bvi flag are also specified.
511 * For xconnect mode, the peer sw_if_index is also specified.
512 * Return 0 if ok, or non-0 if there was an error.
516 set_int_l2_mode (vlib_main_t * vm, vnet_main_t * vnet_main, u32 mode, u32 sw_if_index, u32 bd_index, /* for bridged interface */
517 u32 bvi, /* the bridged interface is the BVI */
518 u32 shg, /* the bridged interface's split horizon group */
519 u32 xc_sw_if_index) /* peer interface for xconnect */
521 l2input_main_t *mp = &l2input_main;
522 l2output_main_t *l2om = &l2output_main;
523 vnet_main_t *vnm = vnet_get_main ();
524 vnet_hw_interface_t *hi;
525 l2_output_config_t *out_config;
526 l2_input_config_t *config;
527 l2_bridge_domain_t *bd_config;
528 l2_flood_member_t member;
530 i32 l2_if_adjust = 0;
533 hi = vnet_get_sup_hw_interface (vnet_main, sw_if_index);
534 config = l2input_intf_config (sw_if_index);
538 /* Interface is already in bridge mode. Undo the existing config. */
539 bd_config = vec_elt_at_index (mp->bd_configs, config->bd_index);
541 /* remove interface from flood vector */
542 bd_remove_member (bd_config, sw_if_index);
544 /* undo any BVI-related config */
545 if (bd_config->bvi_sw_if_index == sw_if_index)
547 bd_config->bvi_sw_if_index = ~0;
550 /* delete the l2fib entry for the bvi interface */
551 mac = *((u64 *) hi->hw_address);
552 l2fib_del_entry (mac, config->bd_index);
554 /* Make loop output node send packet back to ethernet-input node */
556 vlib_node_add_named_next_with_slot (vm, hi->tx_node_index,
558 VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
559 ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
563 else if (config->xconnect)
569 * Directs the l2 output path to work out the interface
570 * output next-arc itself. Needed when recycling a sw_if_index.
572 vec_validate_init_empty (l2om->next_nodes.output_node_index_vec,
574 l2om->next_nodes.output_node_index_vec[sw_if_index] = ~0;
576 /* Initialize the l2-input configuration for the interface */
579 /* Set L2 config to BD index 0 so that if any packet accidentally
580 * came in on L2 path, it will be dropped in BD 0 */
581 config->xconnect = 0;
584 config->bd_index = 0;
585 config->feature_bitmap = L2INPUT_FEAT_DROP;
587 /* Make sure any L2-output packet to this interface now in L3 mode is
588 * dropped. This may happen if L2 FIB MAC entry is stale */
589 l2om->next_nodes.output_node_index_vec[sw_if_index] =
590 L2OUTPUT_NEXT_BAD_INTF;
592 else if (mode == MODE_L2_CLASSIFY)
594 config->xconnect = 1;
596 config->output_sw_if_index = xc_sw_if_index;
598 /* Make sure last-chance drop is configured */
599 config->feature_bitmap |=
600 L2INPUT_FEAT_DROP | L2INPUT_FEAT_INPUT_CLASSIFY;
602 /* Make sure bridging features are disabled */
603 config->feature_bitmap &=
604 ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
605 shg = 0; /* not used in xconnect */
607 /* Insure all packets go to ethernet-input */
608 ethernet_set_rx_redirect (vnet_main, hi, 1);
613 if (mode == MODE_L2_BRIDGE)
616 * Remove a check that the interface must be an Ethernet.
617 * Specifically so we can bridge to L3 tunnel interfaces.
619 * if (hi->hw_class_index != ethernet_hw_interface_class.index)
623 return MODE_ERROR_ETH; /* non-ethernet */
625 config->xconnect = 0;
627 config->bd_index = bd_index;
630 * Enable forwarding, flooding, learning and ARP termination by default
631 * (note that ARP term is disabled on BD feature bitmap by default)
633 config->feature_bitmap |= L2INPUT_FEAT_FWD | L2INPUT_FEAT_UU_FLOOD |
634 L2INPUT_FEAT_FLOOD | L2INPUT_FEAT_LEARN | L2INPUT_FEAT_ARP_TERM;
636 /* Make sure last-chance drop is configured */
637 config->feature_bitmap |= L2INPUT_FEAT_DROP;
639 /* Make sure xconnect is disabled */
640 config->feature_bitmap &= ~L2INPUT_FEAT_XCONNECT;
642 /* Set up bridge domain */
643 vec_validate (mp->bd_configs, bd_index);
644 bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
645 bd_validate (bd_config);
647 /* TODO: think: add l2fib entry even for non-bvi interface? */
649 /* Do BVI interface initializations */
652 /* ensure BD has no bvi interface (or replace that one with this??) */
653 if (bd_config->bvi_sw_if_index != ~0)
655 return MODE_ERROR_BVI_DEF; /* bd already has a bvi interface */
657 bd_config->bvi_sw_if_index = sw_if_index;
660 /* create the l2fib entry for the bvi interface */
661 mac = *((u64 *) hi->hw_address);
662 l2fib_add_entry (mac, bd_index, sw_if_index, 1, 0, 1); /* static + bvi */
664 /* Disable learning by default. no use since l2fib entry is static. */
665 config->feature_bitmap &= ~L2INPUT_FEAT_LEARN;
667 /* Make loop output node send packet to l2-input node */
669 vlib_node_add_named_next_with_slot (vm, hi->tx_node_index,
671 VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
672 ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
675 /* Add interface to bridge-domain flood vector */
676 member.sw_if_index = sw_if_index;
677 member.flags = bvi ? L2_FLOOD_MEMBER_BVI : L2_FLOOD_MEMBER_NORMAL;
679 bd_add_member (bd_config, &member);
684 config->xconnect = 1;
686 config->output_sw_if_index = xc_sw_if_index;
688 /* Make sure last-chance drop is configured */
689 config->feature_bitmap |= L2INPUT_FEAT_DROP;
691 /* Make sure bridging features are disabled */
692 config->feature_bitmap &=
693 ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
695 config->feature_bitmap |= L2INPUT_FEAT_XCONNECT;
696 shg = 0; /* not used in xconnect */
699 /* set up split-horizon group */
701 out_config = l2output_intf_config (sw_if_index);
702 out_config->shg = shg;
705 * Test: remove this when non-IP features can be configured.
706 * Enable a non-IP feature to test IP feature masking
707 * config->feature_bitmap |= L2INPUT_FEAT_CTRL_PKT;
713 /* Adjust count of L2 interfaces */
714 hi->l2_if_count += l2_if_adjust;
716 if (hi->hw_class_index == ethernet_hw_interface_class.index)
718 if ((hi->l2_if_count == 1) && (l2_if_adjust == 1))
720 /* Just added first L2 interface on this port */
722 /* Set promiscuous mode on the l2 interface */
723 ethernet_set_flags (vnet_main, hi->hw_if_index,
724 ETHERNET_INTERFACE_FLAG_ACCEPT_ALL);
726 /* ensure all packets go to ethernet-input */
727 ethernet_set_rx_redirect (vnet_main, hi, 1);
730 else if ((hi->l2_if_count == 0) && (l2_if_adjust == -1))
732 /* Just removed only L2 subinterface on this port */
734 /* Disable promiscuous mode on the l2 interface */
735 ethernet_set_flags (vnet_main, hi->hw_if_index, 0);
737 /* Allow ip packets to go directly to ip4-input etc */
738 ethernet_set_rx_redirect (vnet_main, hi, 0);
742 /* Set up the L2/L3 flag in the interface parsing tables */
743 ethernet_sw_interface_set_l2_mode (vnm, sw_if_index, (mode != MODE_L3));
749 * Set subinterface in bridging mode with a bridge-domain ID.
751 * set interface l2 bridge <interface> <bd> [bvi] [split-horizon-group]
753 static clib_error_t *
754 int_l2_bridge (vlib_main_t * vm,
755 unformat_input_t * input, vlib_cli_command_t * cmd)
757 vnet_main_t *vnm = vnet_get_main ();
758 clib_error_t *error = 0;
765 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
767 error = clib_error_return (0, "unknown interface `%U'",
768 format_unformat_error, input);
772 if (!unformat (input, "%d", &bd_id))
774 error = clib_error_return (0, "expected bridge domain ID `%U'",
775 format_unformat_error, input);
779 bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
782 bvi = unformat (input, "bvi");
784 /* optional split horizon group */
786 (void) unformat (input, "%d", &shg);
788 /* set the interface mode */
790 set_int_l2_mode (vm, vnm, MODE_L2_BRIDGE, sw_if_index, bd_index, bvi,
793 if (rc == MODE_ERROR_ETH)
795 error = clib_error_return (0, "bridged interface must be ethernet",
796 format_unformat_error, input);
798 else if (rc == MODE_ERROR_BVI_DEF)
801 clib_error_return (0, "bridge-domain already has a bvi interface",
802 format_unformat_error, input);
806 error = clib_error_return (0, "invalid configuration for interface",
807 format_unformat_error, input);
817 * Use this command put an interface into Layer 2 bridge domain. If a
818 * bridge-domain with the provided bridge-domain-id does not exist, it
819 * will be created. Interfaces in a bridge-domain forward packets to
820 * other interfaces in the same bridge-domain based on destination mac
821 * address. To remove an interface from a the Layer 2 bridge domain,
822 * put the interface in a different mode, for example Layer 3 mode.
824 * Optionally, an interface can be added to a Layer 2 bridge-domain as
825 * a Bridged Virtual Interface (bvi). Only one interface in a Layer 2
826 * bridge-domain can be a bvi.
828 * Optionally, a split-horizon group can also be specified. This defaults
829 * to 0 if not specified.
832 * Example of how to configure a Layer 2 bridge-domain with three
833 * interfaces (where 200 is the bridge-domain-id):
834 * @cliexcmd{set interface l2 bridge GigabitEthernet0/8/0.200 200}
835 * This interface is added a BVI interface:
836 * @cliexcmd{set interface l2 bridge GigabitEthernet0/9/0.200 200 bvi}
837 * This interface also has a split-horizon group of 1 specified:
838 * @cliexcmd{set interface l2 bridge GigabitEthernet0/a/0.200 200 1}
839 * Example of how to remove an interface from a Layer2 bridge-domain:
840 * @cliexcmd{set interface l3 GigabitEthernet0/a/0.200}
843 VLIB_CLI_COMMAND (int_l2_bridge_cli, static) = {
844 .path = "set interface l2 bridge",
845 .short_help = "set interface l2 bridge <interface> <bridge-domain-id> [bvi] [shg]",
846 .function = int_l2_bridge,
851 * Set subinterface in xconnect mode with another interface.
853 * set interface l2 xconnect <interface> <peer interface>
855 static clib_error_t *
856 int_l2_xc (vlib_main_t * vm,
857 unformat_input_t * input, vlib_cli_command_t * cmd)
859 vnet_main_t *vnm = vnet_get_main ();
860 clib_error_t *error = 0;
864 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
866 error = clib_error_return (0, "unknown interface `%U'",
867 format_unformat_error, input);
872 (input, unformat_vnet_sw_interface, vnm, &xc_sw_if_index))
874 error = clib_error_return (0, "unknown peer interface `%U'",
875 format_unformat_error, input);
879 /* set the interface mode */
881 (vm, vnm, MODE_L2_XC, sw_if_index, 0, 0, 0, xc_sw_if_index))
883 error = clib_error_return (0, "invalid configuration for interface",
884 format_unformat_error, input);
893 * Use this command put an interface into Layer 2 cross-connect mode.
894 * Both interfaces must be in this mode for bi-directioal traffic. All
895 * packets received on one interface will be transmitted to the other.
896 * To remove the Layer 2 cross-connect, put the interface in a different
897 * mode, for example Layer 3 mode.
900 * Example of how to configure a Layer2 cross-connect between two interfaces:
901 * @cliexcmd{set interface l2 xconnect GigabitEthernet0/8/0.300 GigabitEthernet0/9/0.300}
902 * @cliexcmd{set interface l2 xconnect GigabitEthernet0/9/0.300 GigabitEthernet0/8/0.300}
903 * Example of how to remove a Layer2 cross-connect:
904 * @cliexcmd{set interface l3 GigabitEthernet0/8/0.300}
905 * @cliexcmd{set interface l3 GigabitEthernet0/9/0.300}
908 VLIB_CLI_COMMAND (int_l2_xc_cli, static) = {
909 .path = "set interface l2 xconnect",
910 .short_help = "set interface l2 xconnect <interface> <peer interface>",
911 .function = int_l2_xc,
916 * Set subinterface in L3 mode.
918 * set interface l3 <interface>
920 static clib_error_t *
921 int_l3 (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
923 vnet_main_t *vnm = vnet_get_main ();
924 clib_error_t *error = 0;
927 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
929 error = clib_error_return (0, "unknown interface `%U'",
930 format_unformat_error, input);
934 /* set the interface mode */
935 if (set_int_l2_mode (vm, vnm, MODE_L3, sw_if_index, 0, 0, 0, 0))
937 error = clib_error_return (0, "invalid configuration for interface",
938 format_unformat_error, input);
947 * Modify the packet processing mode of the interface to Layer 3, which
948 * implies packets will be routed. This is the default mode of an interface.
949 * Use this command to remove an interface from a Layer 2 cross-connect or a
953 * Example of how to set the mode of an interface to Layer 3:
954 * @cliexcmd{set interface l3 GigabitEthernet0/8/0.200}
957 VLIB_CLI_COMMAND (int_l3_cli, static) = {
958 .path = "set interface l3",
959 .short_help = "set interface l3 <interface>",
965 * Show interface mode.
967 * show mode [<if-name1> <if-name2> ...]
969 static clib_error_t *
970 show_int_mode (vlib_main_t * vm,
971 unformat_input_t * input, vlib_cli_command_t * cmd)
973 vnet_main_t *vnm = vnet_get_main ();
974 clib_error_t *error = 0;
977 vnet_interface_main_t *im = &vnm->interface_main;
978 vnet_sw_interface_t *si, *sis = 0;
979 l2input_main_t *mp = &l2input_main;
980 l2_input_config_t *config;
982 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
986 /* See if user wants to show specific interface */
988 (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
990 si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
991 vec_add1 (sis, si[0]);
995 error = clib_error_return (0, "unknown input `%U'",
996 format_unformat_error, input);
1002 if (vec_len (sis) == 0) /* Get all interfaces */
1004 /* Gather interfaces. */
1005 sis = vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
1008 pool_foreach (si, im->sw_interfaces, ({ vec_add1 (sis, si[0]); }));
1012 vec_foreach (si, sis)
1014 vec_validate (mp->configs, si->sw_if_index);
1015 config = vec_elt_at_index (mp->configs, si->sw_if_index);
1020 bd_id = l2input_main.bd_configs[config->bd_index].bd_id;
1022 args = format (0, "bd_id %d%s%d", bd_id,
1023 config->bvi ? " bvi shg " : " shg ", config->shg);
1025 else if (config->xconnect)
1027 mode = "l2 xconnect";
1028 args = format (0, "%U",
1029 format_vnet_sw_if_index_name,
1030 vnm, config->output_sw_if_index);
1035 args = format (0, " ");
1037 vlib_cli_output (vm, "%s %U %v\n",
1039 format_vnet_sw_if_index_name,
1040 vnm, si->sw_if_index, args);
1051 * Show the packet processing mode (Layer2 xcross-onnect, Layer 2 bridge,
1052 * Layer 3 routed) of all interfaces and sub-interfaces, or limit the
1053 * output to just the provided list of interfaces and sub-interfaces.
1054 * The output shows the mode, the interface, and if the interface is
1055 * a member of a bridge, the bridge-domain-id and the split horizen group (shg).
1058 * Example of displaying the mode of all interfaces:
1059 * @cliexstart{show mode}
1061 * l3 GigabitEthernet0/8/0
1062 * l3 GigabitEthernet0/9/0
1063 * l3 GigabitEthernet0/a/0
1064 * l2 bridge GigabitEthernet0/8/0.200 bd_id 200 shg 0
1065 * l2 bridge GigabitEthernet0/9/0.200 bd_id 200 shg 0
1066 * l2 bridge GigabitEthernet0/a/0.200 bd_id 200 shg 0
1067 * l2 xconnect GigabitEthernet0/8/0.300 GigabitEthernet0/9/0.300
1068 * l2 xconnect GigabitEthernet0/9/0.300 GigabitEthernet0/8/0.300
1070 * Example of displaying the mode of a seleted list of interfaces:
1071 * @cliexstart{show mode GigabitEthernet0/8/0 GigabitEthernet0/8/0.200}
1072 * l3 GigabitEthernet0/8/0
1073 * l2 bridge GigabitEthernet0/8/0.200 bd_id 200 shg 0
1077 VLIB_CLI_COMMAND (show_l2_mode, static) = {
1078 .path = "show mode",
1079 .short_help = "show mode [<if-name1> <if-name2> ...]",
1080 .function = show_int_mode,
1084 #define foreach_l2_init_function \
1085 _(feat_bitmap_drop_init) \
1087 _(l2_input_classify_init) \
1094 _(l2_efp_filter_init) \
1103 l2_init (vlib_main_t * vm)
1105 clib_error_t *error;
1108 if ((error = vlib_call_init_function (vm, a))) return error; } \
1110 foreach_l2_init_function;
1115 VLIB_INIT_FUNCTION (l2_init);
1118 * fd.io coding-style-patch-verification: ON
1121 * eval: (c-set-style "gnu")