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