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