misc: Purge unused pg includes
[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/ethernet/ethernet.h>
21 #include <vnet/ethernet/packet.h>
22 #include <vnet/ip/ip_packet.h>
23 #include <vnet/ip/ip4_packet.h>
24 #include <vnet/ip/ip6_packet.h>
25 #include <vnet/fib/fib_node.h>
26 #include <vnet/ethernet/arp_packet.h>
27 #include <vlib/cli.h>
28 #include <vnet/l2/l2_input.h>
29 #include <vnet/l2/l2_output.h>
30 #include <vnet/l2/feat_bitmap.h>
31 #include <vnet/l2/l2_bvi.h>
32 #include <vnet/l2/l2_fib.h>
33 #include <vnet/l2/l2_bd.h>
34
35 #include <vppinfra/error.h>
36 #include <vppinfra/hash.h>
37 #include <vppinfra/cache.h>
38
39 /**
40  * @file
41  * @brief Interface Input Mode (Layer 2 Cross-Connect or Bridge / Layer 3).
42  *
43  * This file contains the CLI Commands that modify the input mode of an
44  * interface. For interfaces in a Layer 2 cross-connect, all packets
45  * received on one interface will be transmitted to the other. For
46  * interfaces in a bridge-domain, packets will be forwarded to other
47  * interfaces in the same bridge-domain based on destination mac address.
48  * For interfaces in Layer 3 mode, the packets will be routed.
49  */
50
51 #ifndef CLIB_MARCH_VARIANT
52
53 /* Feature graph node names */
54 static char *l2input_feat_names[] = {
55 #define _(sym,name) name,
56   foreach_l2input_feat
57 #undef _
58 };
59
60 char **
61 l2input_get_feat_names (void)
62 {
63   return l2input_feat_names;
64 }
65
66 u8 *
67 format_l2_input_features (u8 * s, va_list * args)
68 {
69   static char *display_names[] = {
70 #define _(sym,name) #sym,
71     foreach_l2input_feat
72 #undef _
73   };
74   u32 feature_bitmap = va_arg (*args, u32);
75   u32 verbose = va_arg (*args, u32);
76
77   if (feature_bitmap == 0)
78     {
79       s = format (s, "  none configured");
80       return s;
81     }
82
83   feature_bitmap &= ~L2INPUT_FEAT_DROP; /* Not a feature */
84   int i;
85   for (i = L2INPUT_N_FEAT - 1; i >= 0; i--)
86     {
87       if (feature_bitmap & (1 << i))
88         {
89           if (verbose)
90             s = format (s, "%17s (%s)\n",
91                         display_names[i], l2input_feat_names[i]);
92           else
93             s = format (s, "%s ", l2input_feat_names[i]);
94         }
95     }
96   return s;
97 }
98 #endif /* CLIB_MARCH_VARIANT */
99
100 typedef struct
101 {
102   /* per-pkt trace data */
103   u8 dst_and_src[12];
104   u32 next_index;
105   u32 sw_if_index;
106 } l2input_trace_t;
107
108 /* packet trace format function */
109 static u8 *
110 format_l2input_trace (u8 * s, va_list * args)
111 {
112   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
113   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
114   l2input_trace_t *t = va_arg (*args, l2input_trace_t *);
115
116   s = format (s, "l2-input: sw_if_index %d dst %U src %U",
117               t->sw_if_index,
118               format_ethernet_address, t->dst_and_src,
119               format_ethernet_address, t->dst_and_src + 6);
120   return s;
121 }
122
123 extern l2input_main_t l2input_main;
124
125 #ifndef CLIB_MARCH_VARIANT
126 l2input_main_t l2input_main;
127 #endif /* CLIB_MARCH_VARIANT */
128
129 #define foreach_l2input_error                   \
130 _(L2INPUT,     "L2 input packets")              \
131 _(DROP,        "L2 input drops")
132
133 typedef enum
134 {
135 #define _(sym,str) L2INPUT_ERROR_##sym,
136   foreach_l2input_error
137 #undef _
138     L2INPUT_N_ERROR,
139 } l2input_error_t;
140
141 static char *l2input_error_strings[] = {
142 #define _(sym,string) string,
143   foreach_l2input_error
144 #undef _
145 };
146
147 typedef enum
148 {                               /*  */
149   L2INPUT_NEXT_LEARN,
150   L2INPUT_NEXT_FWD,
151   L2INPUT_NEXT_DROP,
152   L2INPUT_N_NEXT,
153 } l2input_next_t;
154
155
156 static_always_inline void
157 classify_and_dispatch (l2input_main_t * msm, vlib_buffer_t * b0, u32 * next0)
158 {
159   /*
160    * Load L2 input feature struct
161    * Load bridge domain struct
162    * Parse ethernet header to determine unicast/mcast/broadcast
163    * take L2 input stat
164    * classify packet as IP/UDP/TCP, control, other
165    * mask feature bitmap
166    * go to first node in bitmap
167    * Later: optimize VTM
168    *
169    * For L2XC,
170    *   set tx sw-if-handle
171    */
172
173   u32 feat_mask = ~0;
174   u32 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
175   ethernet_header_t *h0 = vlib_buffer_get_current (b0);
176
177   /* Get config for the input interface */
178   l2_input_config_t *config = vec_elt_at_index (msm->configs, sw_if_index0);
179
180   /* Save split horizon group */
181   vnet_buffer (b0)->l2.shg = config->shg;
182
183   /* determine layer2 kind for stat and mask */
184   if (PREDICT_FALSE (ethernet_address_cast (h0->dst_address)))
185     {
186       u8 *l3h0 = (u8 *) h0 + vnet_buffer (b0)->l2.l2_len;
187
188 #define get_u16(addr) ( *((u16 *)(addr)) )
189       u16 ethertype = clib_net_to_host_u16 (get_u16 (l3h0 - 2));
190       u8 protocol = ((ip6_header_t *) l3h0)->protocol;
191
192       /* Disable bridge forwarding (flooding will execute instead if not xconnect) */
193       feat_mask &= ~(L2INPUT_FEAT_FWD |
194                      L2INPUT_FEAT_UU_FLOOD |
195                      L2INPUT_FEAT_UU_FWD | L2INPUT_FEAT_GBP_FWD);
196
197       if (ethertype != ETHERNET_TYPE_ARP)
198         feat_mask &= ~(L2INPUT_FEAT_ARP_UFWD);
199
200       /* Disable ARP-term for non-ARP and non-ICMP6 packet */
201       if (ethertype != ETHERNET_TYPE_ARP &&
202           (ethertype != ETHERNET_TYPE_IP6 || protocol != IP_PROTOCOL_ICMP6))
203         feat_mask &= ~(L2INPUT_FEAT_ARP_TERM);
204       /*
205        * For packet from BVI - set SHG of ARP request or ICMPv6 neighbor
206        * solicitation packet from BVI to 0 so it can also flood to VXLAN
207        * tunnels or other ports with the same SHG as that of the BVI.
208        */
209       else if (PREDICT_FALSE (vnet_buffer (b0)->sw_if_index[VLIB_TX] ==
210                               L2INPUT_BVI))
211         {
212           if (ethertype == ETHERNET_TYPE_ARP)
213             {
214               ethernet_arp_header_t *arp0 = (ethernet_arp_header_t *) l3h0;
215               if (arp0->opcode ==
216                   clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request))
217                 vnet_buffer (b0)->l2.shg = 0;
218             }
219           else                  /* must be ICMPv6 */
220             {
221               ip6_header_t *iph0 = (ip6_header_t *) l3h0;
222               icmp6_neighbor_solicitation_or_advertisement_header_t *ndh0;
223               ndh0 = ip6_next_header (iph0);
224               if (ndh0->icmp.type == ICMP6_neighbor_solicitation)
225                 vnet_buffer (b0)->l2.shg = 0;
226             }
227         }
228     }
229   else
230     {
231       /*
232        * For packet from BVI - set SHG of unicast packet from BVI to 0 so it
233        * is not dropped on output to VXLAN tunnels or other ports with the
234        * same SHG as that of the BVI.
235        */
236       if (PREDICT_FALSE (vnet_buffer (b0)->sw_if_index[VLIB_TX] ==
237                          L2INPUT_BVI))
238         vnet_buffer (b0)->l2.shg = 0;
239     }
240
241
242   if (config->bridge)
243     {
244       /* Do bridge-domain processing */
245       u16 bd_index0 = config->bd_index;
246       /* save BD ID for next feature graph nodes */
247       vnet_buffer (b0)->l2.bd_index = bd_index0;
248
249       /* Get config for the bridge domain interface */
250       l2_bridge_domain_t *bd_config =
251         vec_elt_at_index (msm->bd_configs, bd_index0);
252
253       /* Save bridge domain and interface seq_num */
254       /* *INDENT-OFF* */
255       l2fib_seq_num_t sn = {
256         .swif = *l2fib_swif_seq_num(sw_if_index0),
257         .bd = bd_config->seq_num,
258       };
259       /* *INDENT-ON* */
260       vnet_buffer (b0)->l2.l2fib_sn = sn.as_u16;;
261       vnet_buffer (b0)->l2.bd_age = bd_config->mac_age;
262
263       /*
264        * Process bridge domain feature enables.
265        * To perform learning/flooding/forwarding, the corresponding bit
266        * must be enabled in both the input interface config and in the
267        * bridge domain config. In the bd_bitmap, bits for features other
268        * than learning/flooding/forwarding should always be set.
269        */
270       feat_mask = feat_mask & bd_config->feature_bitmap;
271     }
272   else if (config->xconnect)
273     {
274       /* Set the output interface */
275       vnet_buffer (b0)->sw_if_index[VLIB_TX] = config->output_sw_if_index;
276     }
277   else
278     feat_mask = L2INPUT_FEAT_DROP;
279
280   /* mask out features from bitmap using packet type and bd config */
281   u32 feature_bitmap = config->feature_bitmap & feat_mask;
282
283   /* save for next feature graph nodes */
284   vnet_buffer (b0)->l2.feature_bitmap = feature_bitmap;
285
286   /* Determine the next node */
287   *next0 = feat_bitmap_get_next_node_index (msm->feat_next_node_index,
288                                             feature_bitmap);
289 }
290
291 static_always_inline uword
292 l2input_node_inline (vlib_main_t * vm,
293                      vlib_node_runtime_t * node, vlib_frame_t * frame,
294                      int do_trace)
295 {
296   u32 n_left_from, *from, *to_next;
297   l2input_next_t next_index;
298   l2input_main_t *msm = &l2input_main;
299   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
300
301   from = vlib_frame_vector_args (frame);
302   n_left_from = frame->n_vectors;       /* number of packets to process */
303   next_index = node->cached_next_index;
304   vlib_get_buffers (vm, from, bufs, n_left_from);
305
306   while (n_left_from > 0)
307     {
308       u32 n_left_to_next;
309
310       /* get space to enqueue frame to graph node "next_index" */
311       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
312
313       while (n_left_from >= 8 && n_left_to_next >= 4)
314         {
315           u32 next0, next1, next2, next3;
316           u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
317
318           /* Prefetch next iteration. */
319           {
320
321             /* Prefetch the buffer header and packet for the N+2 loop iteration */
322             vlib_prefetch_buffer_header (b[4], LOAD);
323             vlib_prefetch_buffer_header (b[5], LOAD);
324             vlib_prefetch_buffer_header (b[6], LOAD);
325             vlib_prefetch_buffer_header (b[7], LOAD);
326
327             CLIB_PREFETCH (b[4]->data, CLIB_CACHE_LINE_BYTES, STORE);
328             CLIB_PREFETCH (b[5]->data, CLIB_CACHE_LINE_BYTES, STORE);
329             CLIB_PREFETCH (b[6]->data, CLIB_CACHE_LINE_BYTES, STORE);
330             CLIB_PREFETCH (b[7]->data, CLIB_CACHE_LINE_BYTES, STORE);
331
332             /*
333              * Don't bother prefetching the bridge-domain config (which
334              * depends on the input config above). Only a small number of
335              * bridge domains are expected. Plus the structure is small
336              * and several fit in a cache line.
337              */
338           }
339
340           /* speculatively enqueue b0 and b1 to the current next frame */
341           /* bi is "buffer index", b is pointer to the buffer */
342
343           if (do_trace)
344             {
345               /* RX interface handles */
346               sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
347               sw_if_index1 = vnet_buffer (b[1])->sw_if_index[VLIB_RX];
348               sw_if_index2 = vnet_buffer (b[2])->sw_if_index[VLIB_RX];
349               sw_if_index3 = vnet_buffer (b[3])->sw_if_index[VLIB_RX];
350
351               if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
352                 {
353                   ethernet_header_t *h0 = vlib_buffer_get_current (b[0]);
354                   l2input_trace_t *t =
355                     vlib_add_trace (vm, node, b[0], sizeof (*t));
356                   t->sw_if_index = sw_if_index0;
357                   clib_memcpy_fast (t->dst_and_src, h0->dst_address,
358                                     sizeof (h0->dst_address) +
359                                     sizeof (h0->src_address));
360                 }
361               if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
362                 {
363                   ethernet_header_t *h1 = vlib_buffer_get_current (b[1]);
364                   l2input_trace_t *t =
365                     vlib_add_trace (vm, node, b[1], sizeof (*t));
366                   t->sw_if_index = sw_if_index1;
367                   clib_memcpy_fast (t->dst_and_src, h1->dst_address,
368                                     sizeof (h1->dst_address) +
369                                     sizeof (h1->src_address));
370                 }
371               if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
372                 {
373                   ethernet_header_t *h2 = vlib_buffer_get_current (b[2]);
374                   l2input_trace_t *t =
375                     vlib_add_trace (vm, node, b[2], sizeof (*t));
376                   t->sw_if_index = sw_if_index2;
377                   clib_memcpy_fast (t->dst_and_src, h2->dst_address,
378                                     sizeof (h2->dst_address) +
379                                     sizeof (h2->src_address));
380                 }
381               if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
382                 {
383                   ethernet_header_t *h3 = vlib_buffer_get_current (b[3]);
384                   l2input_trace_t *t =
385                     vlib_add_trace (vm, node, b[3], sizeof (*t));
386                   t->sw_if_index = sw_if_index3;
387                   clib_memcpy_fast (t->dst_and_src, h3->dst_address,
388                                     sizeof (h3->dst_address) +
389                                     sizeof (h3->src_address));
390                 }
391             }
392
393           classify_and_dispatch (msm, b[0], &next0);
394           classify_and_dispatch (msm, b[1], &next1);
395           //show the better performance when clib_memcpy_fast is put here.
396           clib_memcpy_fast (to_next, from, sizeof (from[0]) * 4);
397           to_next += 4;
398           classify_and_dispatch (msm, b[2], &next2);
399           classify_and_dispatch (msm, b[3], &next3);
400           b += 4;
401           n_left_from -= 4;
402           n_left_to_next -= 4;
403
404           /* verify speculative enqueues, maybe switch current next frame */
405           /* if next0==next1==next_index then nothing special needs to be done */
406           vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
407                                            to_next, n_left_to_next,
408                                            from[0], from[1], from[2], from[3],
409                                            next0, next1, next2, next3);
410           from += 4;
411         }
412
413       while (n_left_from > 0 && n_left_to_next > 0)
414         {
415           u32 next0;
416           u32 sw_if_index0;
417
418           /* speculatively enqueue b0 to the current next frame */
419
420           if (do_trace && PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
421             {
422               ethernet_header_t *h0 = vlib_buffer_get_current (b[0]);
423               l2input_trace_t *t =
424                 vlib_add_trace (vm, node, b[0], sizeof (*t));
425               sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
426               t->sw_if_index = sw_if_index0;
427               clib_memcpy_fast (t->dst_and_src, h0->dst_address,
428                                 sizeof (h0->dst_address) +
429                                 sizeof (h0->src_address));
430             }
431
432           classify_and_dispatch (msm, b[0], &next0);
433           b += 1;
434           to_next[0] = from[0];
435           to_next += 1;
436           n_left_from -= 1;
437           n_left_to_next -= 1;
438
439           /* verify speculative enqueue, maybe switch current next frame */
440           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
441                                            to_next, n_left_to_next,
442                                            from[0], next0);
443           from += 1;
444         }
445
446       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
447     }
448
449   vlib_node_increment_counter (vm, l2input_node.index,
450                                L2INPUT_ERROR_L2INPUT, frame->n_vectors);
451
452   return frame->n_vectors;
453 }
454
455 VLIB_NODE_FN (l2input_node) (vlib_main_t * vm,
456                              vlib_node_runtime_t * node, vlib_frame_t * frame)
457 {
458   if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
459     return l2input_node_inline (vm, node, frame, 1 /* do_trace */ );
460   return l2input_node_inline (vm, node, frame, 0 /* do_trace */ );
461 }
462
463 /* *INDENT-OFF* */
464 VLIB_REGISTER_NODE (l2input_node) = {
465   .name = "l2-input",
466   .vector_size = sizeof (u32),
467   .format_trace = format_l2input_trace,
468   .format_buffer = format_ethernet_header_with_length,
469   .type = VLIB_NODE_TYPE_INTERNAL,
470
471   .n_errors = ARRAY_LEN(l2input_error_strings),
472   .error_strings = l2input_error_strings,
473
474   .n_next_nodes = L2INPUT_N_NEXT,
475
476   /* edit / add dispositions here */
477   .next_nodes = {
478        [L2INPUT_NEXT_LEARN] = "l2-learn",
479        [L2INPUT_NEXT_FWD]   = "l2-fwd",
480        [L2INPUT_NEXT_DROP]  = "error-drop",
481   },
482 };
483 /* *INDENT-ON* */
484
485 #ifndef CLIB_MARCH_VARIANT
486 clib_error_t *
487 l2input_init (vlib_main_t * vm)
488 {
489   l2input_main_t *mp = &l2input_main;
490
491   mp->vlib_main = vm;
492   mp->vnet_main = vnet_get_main ();
493
494   /* Get packets RX'd from L2 interfaces */
495   ethernet_register_l2_input (vm, l2input_node.index);
496
497   /* Create the config vector */
498   vec_validate (mp->configs, 100);
499   /* create 100 sw interface entries and zero them */
500
501   /* Initialize the feature next-node indexes */
502   feat_bitmap_init_next_nodes (vm,
503                                l2input_node.index,
504                                L2INPUT_N_FEAT,
505                                l2input_get_feat_names (),
506                                mp->feat_next_node_index);
507
508   return 0;
509 }
510
511 VLIB_INIT_FUNCTION (l2input_init);
512
513
514 /** Get a pointer to the config for the given interface. */
515 l2_input_config_t *
516 l2input_intf_config (u32 sw_if_index)
517 {
518   l2input_main_t *mp = &l2input_main;
519
520   vec_validate (mp->configs, sw_if_index);
521   return vec_elt_at_index (mp->configs, sw_if_index);
522 }
523
524 /** Enable (or disable) the feature in the bitmap for the given interface. */
525 u32
526 l2input_intf_bitmap_enable (u32 sw_if_index,
527                             l2input_feat_masks_t feature_bitmap, u32 enable)
528 {
529   l2_input_config_t *config = l2input_intf_config (sw_if_index);
530
531   if (enable)
532     config->feature_bitmap |= feature_bitmap;
533   else
534     config->feature_bitmap &= ~feature_bitmap;
535
536   return config->feature_bitmap;
537 }
538
539 u32
540 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value)
541 {
542   l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);;
543   bd_validate (bd_config);
544   bd_config->feature_bitmap =
545     (bd_config->feature_bitmap & ~feat_mask) | feat_value;
546   return bd_config->feature_bitmap;
547 }
548
549 void
550 l2input_interface_mac_change (u32 sw_if_index,
551                               const u8 * old_address, const u8 * new_address)
552 {
553   /* check if the sw_if_index passed is a BVI in a BD */
554   l2_input_config_t *intf_config;
555
556   intf_config = l2input_intf_config (sw_if_index);
557
558   if (intf_config->bridge && intf_config->bvi)
559     {
560       /* delete and re-add l2fib entry for the bvi interface */
561       l2fib_del_entry (old_address, intf_config->bd_index, sw_if_index);
562       l2fib_add_entry (new_address,
563                        intf_config->bd_index,
564                        sw_if_index,
565                        L2FIB_ENTRY_RESULT_FLAG_BVI |
566                        L2FIB_ENTRY_RESULT_FLAG_STATIC);
567     }
568 }
569
570 /**
571  * Set the subinterface to run in l2 or l3 mode.
572  * For L3 mode, just the sw_if_index is specified.
573  * For bridged mode, the bd id and bvi flag are also specified.
574  * For xconnect mode, the peer sw_if_index is also specified.
575  * Return 0 if ok, or non-0 if there was an error.
576  */
577
578 u32
579 set_int_l2_mode (vlib_main_t * vm, vnet_main_t * vnet_main,     /*           */
580                  u32 mode,      /* One of L2 modes or back to L3 mode        */
581                  u32 sw_if_index,       /* sw interface index                */
582                  u32 bd_index,  /* for bridged interface                     */
583                  l2_bd_port_type_t port_type,   /* port_type */
584                  u32 shg,       /* the bridged interface split horizon group */
585                  u32 xc_sw_if_index)    /* peer interface for xconnect       */
586 {
587   l2input_main_t *mp = &l2input_main;
588   l2output_main_t *l2om = &l2output_main;
589   vnet_main_t *vnm = vnet_get_main ();
590   vnet_hw_interface_t *hi;
591   l2_output_config_t *out_config;
592   l2_input_config_t *config;
593   l2_bridge_domain_t *bd_config;
594   i32 l2_if_adjust = 0;
595   vnet_device_class_t *dev_class;
596
597   hi = vnet_get_sup_hw_interface (vnet_main, sw_if_index);
598   config = l2input_intf_config (sw_if_index);
599
600   if (l2fib_main.mac_table_initialized == 0)
601     l2fib_table_init ();
602
603   if (config->bridge)
604     {
605       /* Interface is already in bridge mode. Undo the existing config. */
606       bd_config = vec_elt_at_index (mp->bd_configs, config->bd_index);
607
608       /* remove interface from flood vector */
609       bd_remove_member (bd_config, sw_if_index);
610
611       /* undo any BVI-related config */
612       if (bd_config->bvi_sw_if_index == sw_if_index)
613         {
614           vnet_sw_interface_t *si;
615
616           bd_config->bvi_sw_if_index = ~0;
617           config->bvi = 0;
618
619           /* delete the l2fib entry for the bvi interface */
620           l2fib_del_entry (hi->hw_address, config->bd_index, sw_if_index);
621
622           /* since this is a no longer BVI interface do not to flood to it */
623           si = vnet_get_sw_interface (vnm, sw_if_index);
624           si->flood_class = VNET_FLOOD_CLASS_NO_FLOOD;
625         }
626       if (bd_config->uu_fwd_sw_if_index == sw_if_index)
627         {
628           bd_config->uu_fwd_sw_if_index = ~0;
629           bd_config->feature_bitmap &= ~L2INPUT_FEAT_UU_FWD;
630         }
631
632       /* Clear MACs learned on the interface */
633       if ((config->feature_bitmap & L2INPUT_FEAT_LEARN) ||
634           (bd_config->feature_bitmap & L2INPUT_FEAT_LEARN))
635         l2fib_flush_int_mac (vm, sw_if_index);
636
637       l2_if_adjust--;
638     }
639   else if (config->xconnect)
640     {
641       l2_if_adjust--;
642     }
643
644   /* Make sure vector is big enough */
645   vec_validate_init_empty (l2om->output_node_index_vec, sw_if_index,
646                            L2OUTPUT_NEXT_DROP);
647
648   /* Initialize the l2-input configuration for the interface */
649   if (mode == MODE_L3)
650     {
651       /* Set L2 config to BD index 0 so that if any packet accidentally
652        * came in on L2 path, it will be dropped in BD 0 */
653       config->xconnect = 0;
654       config->bridge = 0;
655       config->shg = 0;
656       config->bd_index = 0;
657       config->feature_bitmap = L2INPUT_FEAT_DROP;
658
659       /* Clear L2 output config */
660       out_config = l2output_intf_config (sw_if_index);
661       clib_memset (out_config, 0, sizeof (l2_output_config_t));
662
663       /* Make sure any L2-output packet to this interface now in L3 mode is
664        * dropped. This may happen if L2 FIB MAC entry is stale */
665       l2om->output_node_index_vec[sw_if_index] = L2OUTPUT_NEXT_BAD_INTF;
666     }
667   else
668     {
669       /* Add or update l2-output node next-arc and output_node_index_vec table
670        * for the interface */
671       l2output_create_output_node_mapping (vm, vnet_main, sw_if_index);
672
673       if (mode == MODE_L2_BRIDGE)
674         {
675           u8 member_flags;
676
677           /*
678            * Remove a check that the interface must be an Ethernet.
679            * Specifically so we can bridge to L3 tunnel interfaces.
680            * Here's the check:
681            * if (hi->hw_class_index != ethernet_hw_interface_class.index)
682            *
683            */
684           if (!hi)
685             return MODE_ERROR_ETH;      /* non-ethernet */
686
687           config->xconnect = 0;
688           config->bridge = 1;
689           config->bd_index = bd_index;
690           *l2fib_valid_swif_seq_num (sw_if_index) += 1;
691
692           /*
693            * Enable forwarding, flooding, learning and ARP termination by default
694            * (note that ARP term is disabled on BD feature bitmap by default)
695            */
696           config->feature_bitmap |= (L2INPUT_FEAT_FWD |
697                                      L2INPUT_FEAT_UU_FLOOD |
698                                      L2INPUT_FEAT_UU_FWD |
699                                      L2INPUT_FEAT_FLOOD |
700                                      L2INPUT_FEAT_LEARN |
701                                      L2INPUT_FEAT_ARP_UFWD |
702                                      L2INPUT_FEAT_ARP_TERM);
703
704           /* Make sure last-chance drop is configured */
705           config->feature_bitmap |= L2INPUT_FEAT_DROP;
706
707           /* Make sure xconnect is disabled */
708           config->feature_bitmap &= ~L2INPUT_FEAT_XCONNECT;
709
710           /* Set up bridge domain */
711           bd_config = l2input_bd_config (bd_index);
712           bd_validate (bd_config);
713
714           /* TODO: think: add l2fib entry even for non-bvi interface? */
715
716           /* Do BVI interface initializations */
717           if (L2_BD_PORT_TYPE_BVI == port_type)
718             {
719               vnet_sw_interface_t *si;
720
721               /* ensure BD has no bvi interface (or replace that one with this??) */
722               if (bd_config->bvi_sw_if_index != ~0)
723                 {
724                   return MODE_ERROR_BVI_DEF;    /* bd already has a bvi interface */
725                 }
726               bd_config->bvi_sw_if_index = sw_if_index;
727               config->bvi = 1;
728
729               /* create the l2fib entry for the bvi interface */
730               l2fib_add_entry (hi->hw_address, bd_index, sw_if_index,
731                                L2FIB_ENTRY_RESULT_FLAG_BVI |
732                                L2FIB_ENTRY_RESULT_FLAG_STATIC);
733
734               /* Disable learning by default. no use since l2fib entry is static. */
735               config->feature_bitmap &= ~L2INPUT_FEAT_LEARN;
736
737               /* since this is a BVI interface we want to flood to it */
738               si = vnet_get_sw_interface (vnm, sw_if_index);
739               si->flood_class = VNET_FLOOD_CLASS_BVI;
740               member_flags = L2_FLOOD_MEMBER_BVI;
741             }
742           else if (L2_BD_PORT_TYPE_UU_FWD == port_type)
743             {
744               bd_config->uu_fwd_sw_if_index = sw_if_index;
745               bd_config->feature_bitmap |= L2INPUT_FEAT_UU_FWD;
746             }
747           else
748             {
749               member_flags = L2_FLOOD_MEMBER_NORMAL;
750             }
751
752           if (L2_BD_PORT_TYPE_NORMAL == port_type ||
753               L2_BD_PORT_TYPE_BVI == port_type)
754             {
755               /* Add interface to bridge-domain flood vector */
756               l2_flood_member_t member = {
757                 .sw_if_index = sw_if_index,
758                 .flags = member_flags,
759                 .shg = shg,
760               };
761               bd_add_member (bd_config, &member);
762             }
763         }
764       else if (mode == MODE_L2_XC)
765         {
766           config->xconnect = 1;
767           config->bridge = 0;
768           config->output_sw_if_index = xc_sw_if_index;
769
770           /* Make sure last-chance drop is configured */
771           config->feature_bitmap |= L2INPUT_FEAT_DROP;
772
773           /* Make sure bridging features are disabled */
774           config->feature_bitmap &=
775             ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
776
777           config->feature_bitmap |= L2INPUT_FEAT_XCONNECT;
778           shg = 0;              /* not used in xconnect */
779         }
780       else if (mode == MODE_L2_CLASSIFY)
781         {
782           config->xconnect = 1;
783           config->bridge = 0;
784           config->output_sw_if_index = xc_sw_if_index;
785
786           /* Make sure last-chance drop is configured */
787           config->feature_bitmap |=
788             L2INPUT_FEAT_DROP | L2INPUT_FEAT_INPUT_CLASSIFY;
789
790           /* Make sure bridging features are disabled */
791           config->feature_bitmap &=
792             ~(L2INPUT_FEAT_LEARN | L2INPUT_FEAT_FWD | L2INPUT_FEAT_FLOOD);
793           shg = 0;              /* not used in xconnect */
794         }
795
796       /* set up split-horizon group and set output feature bit */
797       config->shg = shg;
798       out_config = l2output_intf_config (sw_if_index);
799       out_config->shg = shg;
800       out_config->feature_bitmap |= L2OUTPUT_FEAT_OUTPUT;
801
802       /*
803        * Test: remove this when non-IP features can be configured.
804        * Enable a non-IP feature to test IP feature masking
805        * config->feature_bitmap |= L2INPUT_FEAT_CTRL_PKT;
806        */
807
808       l2_if_adjust++;
809     }
810
811   /* Adjust count of L2 interfaces */
812   hi->l2_if_count += l2_if_adjust;
813
814   if (hi->hw_class_index == ethernet_hw_interface_class.index)
815     {
816       if ((hi->l2_if_count == 1) && (l2_if_adjust == 1))
817         {
818           /* Just added first L2 interface on this port
819            * Set promiscuous mode on the l2 interface */
820           ethernet_set_flags (vnet_main, hi->hw_if_index,
821                               ETHERNET_INTERFACE_FLAG_ACCEPT_ALL);
822         }
823       else if ((hi->l2_if_count == 0) && (l2_if_adjust == -1))
824         {
825           /* Just removed only L2 subinterface on this port
826            * Disable promiscuous mode on the l2 interface */
827           ethernet_set_flags (vnet_main, hi->hw_if_index,
828                               /*ETHERNET_INTERFACE_FLAG_DEFAULT_L3 */ 0);
829
830         }
831     }
832
833   /* Set up the L2/L3 flag in the interface parsing tables */
834   ethernet_sw_interface_set_l2_mode (vnm, sw_if_index, (mode != MODE_L3));
835
836   dev_class = vnet_get_device_class (vnet_main, hi->dev_class_index);
837   if (dev_class->set_l2_mode_function)
838     {
839       dev_class->set_l2_mode_function (vnet_main, hi, l2_if_adjust);
840     }
841
842   return 0;
843 }
844 #endif /* CLIB_MARCH_VARIANT */
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 #ifndef CLIB_MARCH_VARIANT
1208 clib_error_t *
1209 l2_init (vlib_main_t * vm)
1210 {
1211   clib_error_t *error;
1212
1213 #define _(a) do {                                                       \
1214   if ((error = vlib_call_init_function (vm, a))) return error; }        \
1215 while (0);
1216   foreach_l2_init_function;
1217 #undef _
1218   return 0;
1219 }
1220
1221 VLIB_INIT_FUNCTION (l2_init);
1222 #endif /* CLIB_MARCH_VARIANT */
1223
1224 /*
1225  * fd.io coding-style-patch-verification: ON
1226  *
1227  * Local Variables:
1228  * eval: (c-set-style "gnu")
1229  * End:
1230  */