a104ec9eebb2813302b544871e6adbc384ee4c91
[vpp.git] / vnet / vnet / l2 / l2_input.c
1 /*
2  * l2_input.c : layer 2 input packet processing
3  *
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:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17
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 <vlib/cli.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>
32
33 #include <vppinfra/error.h>
34 #include <vppinfra/hash.h>
35 #include <vppinfra/cache.h>
36
37 /**
38  * @file
39  * @brief Interface Input Mode (Layer 2 Cross-Connect or Bridge / Layer 3).
40  *
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.
47  */
48
49 /* Feature graph node names */
50 static char *l2input_feat_names[] = {
51 #define _(sym,name) name,
52   foreach_l2input_feat
53 #undef _
54 };
55
56 char **
57 l2input_get_feat_names (void)
58 {
59   return l2input_feat_names;
60 }
61
62
63 typedef struct
64 {
65   /* per-pkt trace data */
66   u8 src[6];
67   u8 dst[6];
68   u32 next_index;
69   u32 sw_if_index;
70 } l2input_trace_t;
71
72 /* packet trace format function */
73 static u8 *
74 format_l2input_trace (u8 * s, va_list * args)
75 {
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 *);
79
80   s = format (s, "l2-input: sw_if_index %d dst %U src %U",
81               t->sw_if_index,
82               format_ethernet_address, t->dst,
83               format_ethernet_address, t->src);
84   return s;
85 }
86
87 l2input_main_t l2input_main;
88
89 #define foreach_l2input_error                   \
90 _(L2INPUT,     "L2 input packets")              \
91 _(DROP,        "L2 input drops")
92
93 typedef enum
94 {
95 #define _(sym,str) L2INPUT_ERROR_##sym,
96   foreach_l2input_error
97 #undef _
98     L2INPUT_N_ERROR,
99 } l2input_error_t;
100
101 static char *l2input_error_strings[] = {
102 #define _(sym,string) string,
103   foreach_l2input_error
104 #undef _
105 };
106
107 typedef enum
108 {                               /*  */
109   L2INPUT_NEXT_LEARN,
110   L2INPUT_NEXT_FWD,
111   L2INPUT_NEXT_DROP,
112   L2INPUT_N_NEXT,
113 } l2input_next_t;
114
115
116 static_always_inline void
117 classify_and_dispatch (vlib_main_t * vm,
118                        vlib_node_runtime_t * node,
119                        u32 cpu_index,
120                        l2input_main_t * msm, vlib_buffer_t * b0, u32 * next0)
121 {
122   /*
123    * Load L2 input feature struct
124    * Load bridge domain struct
125    * Parse ethernet header to determine unicast/mcast/broadcast
126    * take L2 input stat
127    * classify packet as IP/UDP/TCP, control, other
128    * mask feature bitmap
129    * go to first node in bitmap
130    * Later: optimize VTM
131    *
132    * For L2XC,
133    *   set tx sw-if-handle
134    */
135
136   u16 ethertype;
137   u8 protocol;
138   l2_input_config_t *config;
139   l2_bridge_domain_t *bd_config;
140   u16 bd_index0;
141   u32 feature_bitmap;
142   u32 feat_mask;
143   ethernet_header_t *h0;
144   u8 *l3h0;
145   u32 sw_if_index0;
146
147 #define get_u16(addr) ( *((u16 *)(addr)) )
148
149   sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
150
151   h0 = vlib_buffer_get_current (b0);
152   l3h0 = (u8 *) h0 + vnet_buffer (b0)->l2.l2_len;
153
154   ethertype = clib_net_to_host_u16 (get_u16 (l3h0 - 2));
155   feat_mask = ~0;
156
157   /* Get config for the input interface */
158   config = vec_elt_at_index (msm->configs, sw_if_index0);
159
160   /* Save split horizon group */
161   vnet_buffer (b0)->l2.shg = config->shg;
162
163   /* determine layer2 kind for stat and mask */
164   if (PREDICT_FALSE (ethernet_address_cast (h0->dst_address)))
165     {
166       protocol = ((ip6_header_t *) l3h0)->protocol;
167
168       /* Disable bridge forwarding (flooding will execute instead if not xconnect) */
169       feat_mask &= ~(L2INPUT_FEAT_FWD | L2INPUT_FEAT_UU_FLOOD);
170
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);
175     }
176   else
177     {
178       /*
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.
182        */
183       if (PREDICT_FALSE (vnet_buffer (b0)->sw_if_index[VLIB_TX] ==
184                          L2INPUT_BVI))
185         vnet_buffer (b0)->l2.shg = 0;
186     }
187
188
189   if (config->xconnect)
190     {
191       /* Set the output interface */
192       vnet_buffer (b0)->sw_if_index[VLIB_TX] = config->output_sw_if_index;
193     }
194   else
195     {
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;
200
201       /* Get config for the bridge domain interface */
202       bd_config = vec_elt_at_index (msm->bd_configs, bd_index0);
203
204       /*
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.
210        */
211       feat_mask = feat_mask & bd_config->feature_bitmap;
212     }
213
214   /* mask out features from bitmap using packet type and bd config */
215   feature_bitmap = config->feature_bitmap & feat_mask;
216
217   /* save for next feature graph nodes */
218   vnet_buffer (b0)->l2.feature_bitmap = feature_bitmap;
219
220   /* Determine the next node */
221   *next0 = feat_bitmap_get_next_node_index (msm->feat_next_node_index,
222                                             feature_bitmap);
223 }
224
225
226 static uword
227 l2input_node_fn (vlib_main_t * vm,
228                  vlib_node_runtime_t * node, vlib_frame_t * frame)
229 {
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 ();
234
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;
238
239   while (n_left_from > 0)
240     {
241       u32 n_left_to_next;
242
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);
245
246       while (n_left_from >= 8 && n_left_to_next >= 4)
247         {
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;
252
253           /* Prefetch next iteration. */
254           {
255             vlib_buffer_t *p4, *p5, *p6, *p7;
256
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]);
261
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);
267
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);
272
273             /*
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.
278              */
279           }
280
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];
287           from += 4;
288           to_next += 4;
289           n_left_from -= 4;
290           n_left_to_next -= 4;
291
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);
296
297           if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
298             {
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];
304
305               if (b0->flags & VLIB_BUFFER_IS_TRACED)
306                 {
307                   ethernet_header_t *h0 = vlib_buffer_get_current (b0);
308                   l2input_trace_t *t =
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);
313                 }
314               if (b1->flags & VLIB_BUFFER_IS_TRACED)
315                 {
316                   ethernet_header_t *h1 = vlib_buffer_get_current (b1);
317                   l2input_trace_t *t =
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);
322                 }
323               if (b2->flags & VLIB_BUFFER_IS_TRACED)
324                 {
325                   ethernet_header_t *h2 = vlib_buffer_get_current (b2);
326                   l2input_trace_t *t =
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);
331                 }
332               if (b3->flags & VLIB_BUFFER_IS_TRACED)
333                 {
334                   ethernet_header_t *h3 = vlib_buffer_get_current (b3);
335                   l2input_trace_t *t =
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);
340                 }
341             }
342
343           vlib_node_increment_counter (vm, l2input_node.index,
344                                        L2INPUT_ERROR_L2INPUT, 4);
345
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);
350
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,
355                                            bi0, bi1, bi2, bi3,
356                                            next0, next1, next2, next3);
357         }
358
359       while (n_left_from > 0 && n_left_to_next > 0)
360         {
361           u32 bi0;
362           vlib_buffer_t *b0;
363           u32 next0;
364           u32 sw_if_index0;
365
366           /* speculatively enqueue b0 to the current next frame */
367           bi0 = from[0];
368           to_next[0] = bi0;
369           from += 1;
370           to_next += 1;
371           n_left_from -= 1;
372           n_left_to_next -= 1;
373
374           b0 = vlib_get_buffer (vm, bi0);
375
376           if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
377                              && (b0->flags & VLIB_BUFFER_IS_TRACED)))
378             {
379               ethernet_header_t *h0 = vlib_buffer_get_current (b0);
380               l2input_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
381               sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
382               t->sw_if_index = sw_if_index0;
383               clib_memcpy (t->src, h0->src_address, 6);
384               clib_memcpy (t->dst, h0->dst_address, 6);
385             }
386
387           vlib_node_increment_counter (vm, l2input_node.index,
388                                        L2INPUT_ERROR_L2INPUT, 1);
389
390           classify_and_dispatch (vm, node, cpu_index, msm, b0, &next0);
391
392           /* verify speculative enqueue, maybe switch current next frame */
393           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
394                                            to_next, n_left_to_next,
395                                            bi0, next0);
396         }
397
398       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
399     }
400
401   return frame->n_vectors;
402 }
403
404
405 /* *INDENT-OFF* */
406 VLIB_REGISTER_NODE (l2input_node) = {
407   .function = l2input_node_fn,
408   .name = "l2-input",
409   .vector_size = sizeof (u32),
410   .format_trace = format_l2input_trace,
411   .format_buffer = format_ethernet_header_with_length,
412   .type = VLIB_NODE_TYPE_INTERNAL,
413
414   .n_errors = ARRAY_LEN(l2input_error_strings),
415   .error_strings = l2input_error_strings,
416
417   .n_next_nodes = L2INPUT_N_NEXT,
418
419   /* edit / add dispositions here */
420   .next_nodes = {
421        [L2INPUT_NEXT_LEARN] = "l2-learn",
422        [L2INPUT_NEXT_FWD]   = "l2-fwd",
423        [L2INPUT_NEXT_DROP]  = "error-drop",
424   },
425 };
426 /* *INDENT-ON* */
427
428 VLIB_NODE_FUNCTION_MULTIARCH (l2input_node, l2input_node_fn)
429      clib_error_t *l2input_init (vlib_main_t * vm)
430 {
431   l2input_main_t *mp = &l2input_main;
432
433   mp->vlib_main = vm;
434   mp->vnet_main = vnet_get_main ();
435
436   /* Get packets RX'd from L2 interfaces */
437   ethernet_register_l2_input (vm, l2input_node.index);
438
439   /* Create the config vector */
440   vec_validate (mp->configs, 100);
441   /* create 100 sw interface entries and zero them */
442
443   /* Initialize the feature next-node indexes */
444   feat_bitmap_init_next_nodes (vm,
445                                l2input_node.index,
446                                L2INPUT_N_FEAT,
447                                l2input_get_feat_names (),
448                                mp->feat_next_node_index);
449
450   return 0;
451 }
452
453 VLIB_INIT_FUNCTION (l2input_init);
454
455
456 /** Get a pointer to the config for the given interface. */
457 l2_input_config_t *
458 l2input_intf_config (u32 sw_if_index)
459 {
460   l2input_main_t *mp = &l2input_main;
461
462   vec_validate (mp->configs, sw_if_index);
463   return vec_elt_at_index (mp->configs, sw_if_index);
464 }
465
466 /** Enable (or disable) the feature in the bitmap for the given interface. */
467 u32
468 l2input_intf_bitmap_enable (u32 sw_if_index, u32 feature_bitmap, u32 enable)
469 {
470   l2input_main_t *mp = &l2input_main;
471   l2_input_config_t *config;
472
473   vec_validate (mp->configs, sw_if_index);
474   config = vec_elt_at_index (mp->configs, sw_if_index);
475
476   if (enable)
477     {
478       config->feature_bitmap |= feature_bitmap;
479     }
480   else
481     {
482       config->feature_bitmap &= ~feature_bitmap;
483     }
484
485   return config->feature_bitmap;
486 }
487
488 u32
489 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value)
490 {
491   l2_bridge_domain_t *bd_config;
492   vec_validate (l2input_main.bd_configs, bd_index);
493   bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
494   bd_validate (bd_config);
495   bd_config->feature_bitmap =
496     (bd_config->feature_bitmap & ~feat_mask) | feat_value;
497   return bd_config->feature_bitmap;
498 }
499
500 /**
501  * Set the subinterface to run in l2 or l3 mode.
502  * For L3 mode, just the sw_if_index is specified.
503  * For bridged mode, the bd id and bvi flag are also specified.
504  * For xconnect mode, the peer sw_if_index is also specified.
505  * Return 0 if ok, or non-0 if there was an error.
506  */
507
508 u32
509 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 */
510                  u32 bvi,       /* the bridged interface is the BVI */
511                  u32 shg,       /* the bridged interface's split horizon group */
512                  u32 xc_sw_if_index)    /* peer interface for xconnect */
513 {
514   l2input_main_t *mp = &l2input_main;
515   l2output_main_t *l2om = &l2output_main;
516   vnet_main_t *vnm = vnet_get_main ();
517   vnet_hw_interface_t *hi;
518   l2_output_config_t *out_config;
519   l2_input_config_t *config;
520   l2_bridge_domain_t *bd_config;
521   l2_flood_member_t member;
522   u64 mac;
523   i32 l2_if_adjust = 0;
524   u32 slot;
525
526   hi = vnet_get_sup_hw_interface (vnet_main, sw_if_index);
527   config = l2input_intf_config (sw_if_index);
528
529   if (config->bridge)
530     {
531       /* Interface is already in bridge mode. Undo the existing config. */
532       bd_config = vec_elt_at_index (mp->bd_configs, config->bd_index);
533
534       /* remove interface from flood vector */
535       bd_remove_member (bd_config, sw_if_index);
536
537       /* undo any BVI-related config */
538       if (bd_config->bvi_sw_if_index == sw_if_index)
539         {
540           bd_config->bvi_sw_if_index = ~0;
541           config->bvi = 0;
542
543           /* delete the l2fib entry for the bvi interface */
544           mac = *((u64 *) hi->hw_address);
545           l2fib_del_entry (mac, config->bd_index);
546
547           /* Make loop output node send packet back to ethernet-input node */
548           slot =
549             vlib_node_add_named_next_with_slot (vm, hi->tx_node_index,
550                                                 "ethernet-input",
551                                                 VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
552           ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
553         }
554       l2_if_adjust--;
555     }
556   else if (config->xconnect)
557     {
558       l2_if_adjust--;
559     }
560
561   /*
562    * Directs the l2 output path to work out the interface
563    * output next-arc itself. Needed when recycling a sw_if_index.
564    */
565   vec_validate_init_empty (l2om->next_nodes.output_node_index_vec,
566                            sw_if_index, ~0);
567   l2om->next_nodes.output_node_index_vec[sw_if_index] = ~0;
568
569   /* Initialize the l2-input configuration for the interface */
570   if (mode == MODE_L3)
571     {
572       /* Set L2 config to BD index 0 so that if any packet accidentally
573        * came in on L2 path, it will be dropped in BD 0 */
574       config->xconnect = 0;
575       config->bridge = 0;
576       config->shg = 0;
577       config->bd_index = 0;
578       config->feature_bitmap = L2INPUT_FEAT_DROP;
579
580       /* Make sure any L2-output packet to this interface now in L3 mode is
581        * dropped. This may happen if L2 FIB MAC entry is stale */
582       l2om->next_nodes.output_node_index_vec[sw_if_index] =
583         L2OUTPUT_NEXT_BAD_INTF;
584     }
585   else if (mode == MODE_L2_CLASSIFY)
586     {
587       config->xconnect = 1;
588       config->bridge = 0;
589       config->output_sw_if_index = xc_sw_if_index;
590
591       /* Make sure last-chance drop is configured */
592       config->feature_bitmap |=
593         L2INPUT_FEAT_DROP | L2INPUT_FEAT_INPUT_CLASSIFY;
594
595       /* Make sure bridging features are disabled */
596       config->feature_bitmap &=
597         ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
598       shg = 0;                  /* not used in xconnect */
599
600       /* Insure all packets go to ethernet-input */
601       ethernet_set_rx_redirect (vnet_main, hi, 1);
602     }
603   else
604     {
605
606       if (mode == MODE_L2_BRIDGE)
607         {
608           /*
609            * Remove a check that the interface must be an Ethernet.
610            * Specifically so we can bridge to L3 tunnel interfaces.
611            * Here's the check:
612            * if (hi->hw_class_index != ethernet_hw_interface_class.index)
613            *
614            */
615           if (!hi)
616             return MODE_ERROR_ETH;      /* non-ethernet */
617
618           config->xconnect = 0;
619           config->bridge = 1;
620           config->bd_index = bd_index;
621
622           /*
623            * Enable forwarding, flooding, learning and ARP termination by default
624            * (note that ARP term is disabled on BD feature bitmap by default)
625            */
626           config->feature_bitmap |= L2INPUT_FEAT_FWD | L2INPUT_FEAT_UU_FLOOD |
627             L2INPUT_FEAT_FLOOD | L2INPUT_FEAT_LEARN | L2INPUT_FEAT_ARP_TERM;
628
629           /* Make sure last-chance drop is configured */
630           config->feature_bitmap |= L2INPUT_FEAT_DROP;
631
632           /* Make sure xconnect is disabled */
633           config->feature_bitmap &= ~L2INPUT_FEAT_XCONNECT;
634
635           /* Set up bridge domain */
636           vec_validate (mp->bd_configs, bd_index);
637           bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
638           bd_validate (bd_config);
639
640           /* TODO: think: add l2fib entry even for non-bvi interface? */
641
642           /* Do BVI interface initializations */
643           if (bvi)
644             {
645               /* ensure BD has no bvi interface (or replace that one with this??) */
646               if (bd_config->bvi_sw_if_index != ~0)
647                 {
648                   return MODE_ERROR_BVI_DEF;    /* bd already has a bvi interface */
649                 }
650               bd_config->bvi_sw_if_index = sw_if_index;
651               config->bvi = 1;
652
653               /* create the l2fib entry for the bvi interface */
654               mac = *((u64 *) hi->hw_address);
655               l2fib_add_entry (mac, bd_index, sw_if_index, 1, 0, 1);    /* static + bvi */
656
657               /* Disable learning by default. no use since l2fib entry is static. */
658               config->feature_bitmap &= ~L2INPUT_FEAT_LEARN;
659
660               /* Make loop output node send packet to l2-input node */
661               slot =
662                 vlib_node_add_named_next_with_slot (vm, hi->tx_node_index,
663                                                     "l2-input",
664                                                     VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
665               ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
666             }
667
668           /* Add interface to bridge-domain flood vector */
669           member.sw_if_index = sw_if_index;
670           member.flags = bvi ? L2_FLOOD_MEMBER_BVI : L2_FLOOD_MEMBER_NORMAL;
671           member.shg = shg;
672           bd_add_member (bd_config, &member);
673
674         }
675       else
676         {
677           config->xconnect = 1;
678           config->bridge = 0;
679           config->output_sw_if_index = xc_sw_if_index;
680
681           /* Make sure last-chance drop is configured */
682           config->feature_bitmap |= L2INPUT_FEAT_DROP;
683
684           /* Make sure bridging features are disabled */
685           config->feature_bitmap &=
686             ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
687
688           config->feature_bitmap |= L2INPUT_FEAT_XCONNECT;
689           shg = 0;              /* not used in xconnect */
690         }
691
692       /* set up split-horizon group */
693       config->shg = shg;
694       out_config = l2output_intf_config (sw_if_index);
695       out_config->shg = shg;
696
697       /*
698        * Test: remove this when non-IP features can be configured.
699        * Enable a non-IP feature to test IP feature masking
700        * config->feature_bitmap |= L2INPUT_FEAT_CTRL_PKT;
701        */
702
703       l2_if_adjust++;
704     }
705
706   /* Adjust count of L2 interfaces */
707   hi->l2_if_count += l2_if_adjust;
708
709   if (hi->hw_class_index == ethernet_hw_interface_class.index)
710     {
711       if ((hi->l2_if_count == 1) && (l2_if_adjust == 1))
712         {
713           /* Just added first L2 interface on this port */
714
715           /* Set promiscuous mode on the l2 interface */
716           ethernet_set_flags (vnet_main, hi->hw_if_index,
717                               ETHERNET_INTERFACE_FLAG_ACCEPT_ALL);
718
719           /* ensure all packets go to ethernet-input */
720           ethernet_set_rx_redirect (vnet_main, hi, 1);
721
722         }
723       else if ((hi->l2_if_count == 0) && (l2_if_adjust == -1))
724         {
725           /* Just removed only L2 subinterface on this port */
726
727           /* Disable promiscuous mode on the l2 interface */
728           ethernet_set_flags (vnet_main, hi->hw_if_index, 0);
729
730           /* Allow ip packets to go directly to ip4-input etc */
731           ethernet_set_rx_redirect (vnet_main, hi, 0);
732         }
733     }
734
735   /* Set up the L2/L3 flag in the interface parsing tables */
736   ethernet_sw_interface_set_l2_mode (vnm, sw_if_index, (mode != MODE_L3));
737
738   return 0;
739 }
740
741 /**
742  * Set subinterface in bridging mode with a bridge-domain ID.
743  * The CLI format is:
744  *   set interface l2 bridge <interface> <bd> [bvi] [split-horizon-group]
745  */
746 static clib_error_t *
747 int_l2_bridge (vlib_main_t * vm,
748                unformat_input_t * input, vlib_cli_command_t * cmd)
749 {
750   vnet_main_t *vnm = vnet_get_main ();
751   clib_error_t *error = 0;
752   u32 bd_index, bd_id;
753   u32 sw_if_index;
754   u32 bvi;
755   u32 rc;
756   u32 shg;
757
758   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
759     {
760       error = clib_error_return (0, "unknown interface `%U'",
761                                  format_unformat_error, input);
762       goto done;
763     }
764
765   if (!unformat (input, "%d", &bd_id))
766     {
767       error = clib_error_return (0, "expected bridge domain ID `%U'",
768                                  format_unformat_error, input);
769       goto done;
770     }
771
772   bd_index = bd_find_or_add_bd_index (&bd_main, bd_id);
773
774   /* optional bvi  */
775   bvi = unformat (input, "bvi");
776
777   /* optional split horizon group */
778   shg = 0;
779   (void) unformat (input, "%d", &shg);
780
781   /* set the interface mode */
782   if ((rc =
783        set_int_l2_mode (vm, vnm, MODE_L2_BRIDGE, sw_if_index, bd_index, bvi,
784                         shg, 0)))
785     {
786       if (rc == MODE_ERROR_ETH)
787         {
788           error = clib_error_return (0, "bridged interface must be ethernet",
789                                      format_unformat_error, input);
790         }
791       else if (rc == MODE_ERROR_BVI_DEF)
792         {
793           error =
794             clib_error_return (0, "bridge-domain already has a bvi interface",
795                                format_unformat_error, input);
796         }
797       else
798         {
799           error = clib_error_return (0, "invalid configuration for interface",
800                                      format_unformat_error, input);
801         }
802       goto done;
803     }
804
805 done:
806   return error;
807 }
808
809 /*?
810  * Use this command put an interface into Layer 2 bridge domain. If a
811  * bridge-domain with the provided bridge-domain-id does not exist, it
812  * will be created. Interfaces in a bridge-domain forward packets to
813  * other interfaces in the same bridge-domain based on destination mac
814  * address. To remove an interface from a the Layer 2 bridge domain,
815  * put the interface in a different mode, for example Layer 3 mode.
816  *
817  * Optionally, an interface can be added to a Layer 2 bridge-domain as
818  * a Bridged Virtual Interface (bvi). Only one interface in a Layer 2
819  * bridge-domain can be a bvi.
820  *
821  * Optionally, a split-horizon group can also be specified. This defaults
822  * to 0 if not specified.
823  *
824  * @cliexpar
825  * Example of how to configure a Layer 2 bridge-domain with three
826  * interfaces (where 200 is the bridge-domain-id):
827  * @cliexcmd{set interface l2 bridge GigabitEthernet0/8/0.200 200}
828  * This interface is added a BVI interface:
829  * @cliexcmd{set interface l2 bridge GigabitEthernet0/9/0.200 200 bvi}
830  * This interface also has a split-horizon group of 1 specified:
831  * @cliexcmd{set interface l2 bridge GigabitEthernet0/a/0.200 200 1}
832  * Example of how to remove an interface from a Layer2 bridge-domain:
833  * @cliexcmd{set interface l3 GigabitEthernet0/a/0.200}
834 ?*/
835 /* *INDENT-OFF* */
836 VLIB_CLI_COMMAND (int_l2_bridge_cli, static) = {
837   .path = "set interface l2 bridge",
838   .short_help = "set interface l2 bridge <interface> <bridge-domain-id> [bvi] [shg]",
839   .function = int_l2_bridge,
840 };
841 /* *INDENT-ON* */
842
843 /**
844  * Set subinterface in xconnect mode with another interface.
845  * The CLI format is:
846  *   set interface l2 xconnect <interface> <peer interface>
847  */
848 static clib_error_t *
849 int_l2_xc (vlib_main_t * vm,
850            unformat_input_t * input, vlib_cli_command_t * cmd)
851 {
852   vnet_main_t *vnm = vnet_get_main ();
853   clib_error_t *error = 0;
854   u32 sw_if_index;
855   u32 xc_sw_if_index;
856
857   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
858     {
859       error = clib_error_return (0, "unknown interface `%U'",
860                                  format_unformat_error, input);
861       goto done;
862     }
863
864   if (!unformat_user
865       (input, unformat_vnet_sw_interface, vnm, &xc_sw_if_index))
866     {
867       error = clib_error_return (0, "unknown peer interface `%U'",
868                                  format_unformat_error, input);
869       goto done;
870     }
871
872   /* set the interface mode */
873   if (set_int_l2_mode
874       (vm, vnm, MODE_L2_XC, sw_if_index, 0, 0, 0, xc_sw_if_index))
875     {
876       error = clib_error_return (0, "invalid configuration for interface",
877                                  format_unformat_error, input);
878       goto done;
879     }
880
881 done:
882   return error;
883 }
884
885 /*?
886  * Use this command put an interface into Layer 2 cross-connect mode.
887  * Both interfaces must be in this mode for bi-directioal traffic. All
888  * packets received on one interface will be transmitted to the other.
889  * To remove the Layer 2 cross-connect, put the interface in a different
890  * mode, for example Layer 3 mode.
891  *
892  * @cliexpar
893  * Example of how to configure a Layer2 cross-connect between two interfaces:
894  * @cliexcmd{set interface l2 xconnect GigabitEthernet0/8/0.300 GigabitEthernet0/9/0.300}
895  * @cliexcmd{set interface l2 xconnect GigabitEthernet0/9/0.300 GigabitEthernet0/8/0.300}
896  * Example of how to remove a Layer2 cross-connect:
897  * @cliexcmd{set interface l3 GigabitEthernet0/8/0.300}
898  * @cliexcmd{set interface l3 GigabitEthernet0/9/0.300}
899 ?*/
900 /* *INDENT-OFF* */
901 VLIB_CLI_COMMAND (int_l2_xc_cli, static) = {
902   .path = "set interface l2 xconnect",
903   .short_help = "set interface l2 xconnect <interface> <peer interface>",
904   .function = int_l2_xc,
905 };
906 /* *INDENT-ON* */
907
908 /**
909  * Set subinterface in L3 mode.
910  * The CLI format is:
911  *   set interface l3 <interface>
912  */
913 static clib_error_t *
914 int_l3 (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
915 {
916   vnet_main_t *vnm = vnet_get_main ();
917   clib_error_t *error = 0;
918   u32 sw_if_index;
919
920   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
921     {
922       error = clib_error_return (0, "unknown interface `%U'",
923                                  format_unformat_error, input);
924       goto done;
925     }
926
927   /* set the interface mode */
928   if (set_int_l2_mode (vm, vnm, MODE_L3, sw_if_index, 0, 0, 0, 0))
929     {
930       error = clib_error_return (0, "invalid configuration for interface",
931                                  format_unformat_error, input);
932       goto done;
933     }
934
935 done:
936   return error;
937 }
938
939 /*?
940  * Modify the packet processing mode of the interface to Layer 3, which
941  * implies packets will be routed. This is the default mode of an interface.
942  * Use this command to remove an interface from a Layer 2 cross-connect or a
943  * Layer 2 bridge.
944  *
945  * @cliexpar
946  * Example of how to set the mode of an interface to Layer 3:
947  * @cliexcmd{set interface l3 GigabitEthernet0/8/0.200}
948 ?*/
949 /* *INDENT-OFF* */
950      VLIB_CLI_COMMAND (int_l3_cli, static) = {
951   .path = "set interface l3",
952   .short_help = "set interface l3 <interface>",
953   .function = int_l3,
954 };
955 /* *INDENT-ON* */
956
957 /**
958  * Show interface mode.
959  * The CLI format is:
960  *    show mode [<if-name1> <if-name2> ...]
961  */
962 static clib_error_t *
963 show_int_mode (vlib_main_t * vm,
964                unformat_input_t * input, vlib_cli_command_t * cmd)
965 {
966   vnet_main_t *vnm = vnet_get_main ();
967   clib_error_t *error = 0;
968   char *mode;
969   u8 *args;
970   vnet_interface_main_t *im = &vnm->interface_main;
971   vnet_sw_interface_t *si, *sis = 0;
972   l2input_main_t *mp = &l2input_main;
973   l2_input_config_t *config;
974
975   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
976     {
977       u32 sw_if_index;
978
979       /* See if user wants to show specific interface */
980       if (unformat
981           (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
982         {
983           si = pool_elt_at_index (im->sw_interfaces, sw_if_index);
984           vec_add1 (sis, si[0]);
985         }
986       else
987         {
988           error = clib_error_return (0, "unknown input `%U'",
989                                      format_unformat_error, input);
990           goto done;
991         }
992
993     }
994
995   if (vec_len (sis) == 0)       /* Get all interfaces */
996     {
997       /* Gather interfaces. */
998       sis = vec_new (vnet_sw_interface_t, pool_elts (im->sw_interfaces));
999       _vec_len (sis) = 0;
1000       /* *INDENT-OFF* */
1001       pool_foreach (si, im->sw_interfaces, ({ vec_add1 (sis, si[0]); }));
1002       /* *INDENT-ON* */
1003     }
1004
1005   vec_foreach (si, sis)
1006   {
1007     vec_validate (mp->configs, si->sw_if_index);
1008     config = vec_elt_at_index (mp->configs, si->sw_if_index);
1009     if (config->bridge)
1010       {
1011         u32 bd_id;
1012         mode = "l2 bridge";
1013         bd_id = l2input_main.bd_configs[config->bd_index].bd_id;
1014
1015         args = format (0, "bd_id %d%s%d", bd_id,
1016                        config->bvi ? " bvi shg " : " shg ", config->shg);
1017       }
1018     else if (config->xconnect)
1019       {
1020         mode = "l2 xconnect";
1021         args = format (0, "%U",
1022                        format_vnet_sw_if_index_name,
1023                        vnm, config->output_sw_if_index);
1024       }
1025     else
1026       {
1027         mode = "l3";
1028         args = format (0, " ");
1029       }
1030     vlib_cli_output (vm, "%s %U %v\n",
1031                      mode,
1032                      format_vnet_sw_if_index_name,
1033                      vnm, si->sw_if_index, args);
1034     vec_free (args);
1035   }
1036
1037 done:
1038   vec_free (sis);
1039
1040   return error;
1041 }
1042
1043 /*?
1044  * Show the packet processing mode (Layer2 xcross-onnect, Layer 2 bridge,
1045  * Layer 3 routed) of all interfaces and sub-interfaces, or limit the
1046  * output to just the provided list of interfaces and sub-interfaces.
1047  * The output shows the mode, the interface, and if the interface is
1048  * a member of a bridge, the bridge-domain-id and the split horizen group (shg).
1049  *
1050  * @cliexpar
1051  * Example of displaying the mode of all interfaces:
1052  * @cliexstart{show mode}
1053  * l3 local0
1054  * l3 GigabitEthernet0/8/0
1055  * l3 GigabitEthernet0/9/0
1056  * l3 GigabitEthernet0/a/0
1057  * l2 bridge GigabitEthernet0/8/0.200 bd_id 200 shg 0
1058  * l2 bridge GigabitEthernet0/9/0.200 bd_id 200 shg 0
1059  * l2 bridge GigabitEthernet0/a/0.200 bd_id 200 shg 0
1060  * l2 xconnect GigabitEthernet0/8/0.300 GigabitEthernet0/9/0.300
1061  * l2 xconnect GigabitEthernet0/9/0.300 GigabitEthernet0/8/0.300
1062  * @cliexend
1063  * Example of displaying the mode of a seleted list of interfaces:
1064  * @cliexstart{show mode GigabitEthernet0/8/0 GigabitEthernet0/8/0.200}
1065  * l3 GigabitEthernet0/8/0
1066  * l2 bridge GigabitEthernet0/8/0.200 bd_id 200 shg 0
1067  * @cliexend
1068 ?*/
1069 /* *INDENT-OFF* */
1070 VLIB_CLI_COMMAND (show_l2_mode, static) = {
1071   .path = "show mode",
1072   .short_help = "show mode [<if-name1> <if-name2> ...]",
1073   .function = show_int_mode,
1074 };
1075 /* *INDENT-ON* */
1076
1077 #define foreach_l2_init_function                \
1078 _(feat_bitmap_drop_init)                        \
1079 _(l2fib_init)                                   \
1080 _(l2_input_classify_init)                             \
1081 _(l2bd_init)                                    \
1082 _(l2fwd_init)                                   \
1083 _(l2_inacl_init)                                \
1084 _(l2input_init)                                 \
1085 _(l2_vtr_init)                                  \
1086 _(l2_invtr_init)                                \
1087 _(l2_efp_filter_init)                           \
1088 _(l2learn_init)                                 \
1089 _(l2flood_init)                                 \
1090 _(l2_outacl_init)                               \
1091 _(l2output_init)                                \
1092 _(l2_patch_init)                                \
1093 _(l2_xcrw_init)
1094
1095 clib_error_t *
1096 l2_init (vlib_main_t * vm)
1097 {
1098   clib_error_t *error;
1099
1100 #define _(a) do {                                                       \
1101   if ((error = vlib_call_init_function (vm, a))) return error; }        \
1102 while (0);
1103   foreach_l2_init_function;
1104 #undef _
1105   return 0;
1106 }
1107
1108 VLIB_INIT_FUNCTION (l2_init);
1109
1110 /*
1111  * fd.io coding-style-patch-verification: ON
1112  *
1113  * Local Variables:
1114  * eval: (c-set-style "gnu")
1115  * End:
1116  */