Add support for transparent ethernet bridging to GRE
[vpp.git] / vnet / vnet / ethernet / node.c
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  * ethernet_node.c: ethernet packet processing
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39
40 #include <vlib/vlib.h>
41 #include <vnet/pg/pg.h>
42 #include <vnet/ethernet/ethernet.h>
43 #include <vppinfra/sparse_vec.h>
44 #include <vnet/l2/l2_bvi.h>
45
46
47 #define foreach_ethernet_input_next             \
48   _ (PUNT, "error-punt")                        \
49   _ (DROP, "error-drop")                        \
50   _ (LLC, "llc-input")
51
52 typedef enum
53 {
54 #define _(s,n) ETHERNET_INPUT_NEXT_##s,
55   foreach_ethernet_input_next
56 #undef _
57     ETHERNET_INPUT_N_NEXT,
58 } ethernet_input_next_t;
59
60 typedef struct
61 {
62   u8 packet_data[32];
63 } ethernet_input_trace_t;
64
65 static u8 *
66 format_ethernet_input_trace (u8 * s, va_list * va)
67 {
68   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
69   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
70   ethernet_input_trace_t *t = va_arg (*va, ethernet_input_trace_t *);
71
72   s = format (s, "%U", format_ethernet_header, t->packet_data);
73
74   return s;
75 }
76
77 vlib_node_registration_t ethernet_input_node;
78
79 typedef enum
80 {
81   ETHERNET_INPUT_VARIANT_ETHERNET,
82   ETHERNET_INPUT_VARIANT_ETHERNET_TYPE,
83   ETHERNET_INPUT_VARIANT_NOT_L2,
84 } ethernet_input_variant_t;
85
86
87 // Parse the ethernet header to extract vlan tags and innermost ethertype
88 static_always_inline void
89 parse_header (ethernet_input_variant_t variant,
90               vlib_buffer_t * b0,
91               u16 * type,
92               u16 * orig_type,
93               u16 * outer_id, u16 * inner_id, u32 * match_flags)
94 {
95   u8 vlan_count;
96
97   if (variant == ETHERNET_INPUT_VARIANT_ETHERNET
98       || variant == ETHERNET_INPUT_VARIANT_NOT_L2)
99     {
100       ethernet_header_t *e0;
101
102       e0 = (void *) (b0->data + b0->current_data);
103
104       vnet_buffer (b0)->ethernet.start_of_ethernet_header = b0->current_data;
105
106       vlib_buffer_advance (b0, sizeof (e0[0]));
107
108       *type = clib_net_to_host_u16 (e0->type);
109     }
110   else if (variant == ETHERNET_INPUT_VARIANT_ETHERNET_TYPE)
111     {
112       // here when prior node was LLC/SNAP processing
113       u16 *e0;
114
115       e0 = (void *) (b0->data + b0->current_data);
116
117       vlib_buffer_advance (b0, sizeof (e0[0]));
118
119       *type = clib_net_to_host_u16 (e0[0]);
120     }
121
122   // save for distinguishing between dot1q and dot1ad later
123   *orig_type = *type;
124
125   // default the tags to 0 (used if there is no corresponding tag)
126   *outer_id = 0;
127   *inner_id = 0;
128
129   *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_0_TAG;
130   vlan_count = 0;
131
132   // check for vlan encaps
133   if ((*type == ETHERNET_TYPE_VLAN) ||
134       (*type == ETHERNET_TYPE_DOT1AD) ||
135       (*type == ETHERNET_TYPE_VLAN_9100) ||
136       (*type == ETHERNET_TYPE_VLAN_9200))
137     {
138       ethernet_vlan_header_t *h0;
139       u16 tag;
140
141       *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_1_TAG;
142
143       h0 = (void *) (b0->data + b0->current_data);
144
145       tag = clib_net_to_host_u16 (h0->priority_cfi_and_id);
146
147       *outer_id = tag & 0xfff;
148
149       *type = clib_net_to_host_u16 (h0->type);
150
151       vlib_buffer_advance (b0, sizeof (h0[0]));
152       vlan_count = 1;
153
154       if (*type == ETHERNET_TYPE_VLAN)
155         {
156           // Double tagged packet
157           *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_2_TAG;
158
159           h0 = (void *) (b0->data + b0->current_data);
160
161           tag = clib_net_to_host_u16 (h0->priority_cfi_and_id);
162
163           *inner_id = tag & 0xfff;
164
165           *type = clib_net_to_host_u16 (h0->type);
166
167           vlib_buffer_advance (b0, sizeof (h0[0]));
168           vlan_count = 2;
169
170           if (*type == ETHERNET_TYPE_VLAN)
171             {
172               // More than double tagged packet
173               *match_flags = SUBINT_CONFIG_VALID | SUBINT_CONFIG_MATCH_3_TAG;
174               vlan_count = 3;   // "unknown" number, aka, 3-or-more
175             }
176         }
177     }
178   ethernet_buffer_set_vlan_count (b0, vlan_count);
179 }
180
181 // Determine the subinterface for this packet, given the result of the
182 // vlan table lookups and vlan header parsing. Check the most specific
183 // matches first.
184 static_always_inline void
185 identify_subint (vnet_hw_interface_t * hi,
186                  vlib_buffer_t * b0,
187                  u32 match_flags,
188                  main_intf_t * main_intf,
189                  vlan_intf_t * vlan_intf,
190                  qinq_intf_t * qinq_intf,
191                  u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
192 {
193   u32 matched;
194
195   matched = eth_identify_subint (hi, b0, match_flags,
196                                  main_intf, vlan_intf, qinq_intf,
197                                  new_sw_if_index, error0, is_l2);
198
199   if (matched)
200     {
201
202       // Perform L3 my-mac filter
203       // A unicast packet arriving on an L3 interface must have a dmac matching the interface mac.
204       // This is required for promiscuous mode, else we will forward packets we aren't supposed to.
205       if (!(*is_l2))
206         {
207           ethernet_header_t *e0;
208           e0 =
209             (void *) (b0->data +
210                       vnet_buffer (b0)->ethernet.start_of_ethernet_header);
211
212           if (!(ethernet_address_cast (e0->dst_address)))
213             {
214               if (!eth_mac_equal ((u8 *) e0, hi->hw_address))
215                 {
216                   *error0 = ETHERNET_ERROR_L3_MAC_MISMATCH;
217                 }
218             }
219         }
220
221       // Check for down subinterface
222       *error0 = (*new_sw_if_index) != ~0 ? (*error0) : ETHERNET_ERROR_DOWN;
223     }
224 }
225
226 static_always_inline void
227 determine_next_node (ethernet_main_t * em,
228                      ethernet_input_variant_t variant,
229                      u32 is_l20,
230                      u32 type0, vlib_buffer_t * b0, u8 * error0, u8 * next0)
231 {
232   if (PREDICT_FALSE (*error0 != ETHERNET_ERROR_NONE))
233     {
234       // some error occurred
235       *next0 = ETHERNET_INPUT_NEXT_DROP;
236     }
237   else if (is_l20)
238     {
239       *next0 = em->l2_next;
240       // record the L2 len and reset the buffer so the L2 header is preserved
241       u32 eth_start = vnet_buffer (b0)->ethernet.start_of_ethernet_header;
242       vnet_buffer (b0)->l2.l2_len = b0->current_data - eth_start;
243       vlib_buffer_advance (b0, -ethernet_buffer_header_size (b0));
244
245       // check for common IP/MPLS ethertypes
246     }
247   else if (type0 == ETHERNET_TYPE_IP4)
248     {
249       *next0 = em->l3_next.input_next_ip4;
250     }
251   else if (type0 == ETHERNET_TYPE_IP6)
252     {
253       *next0 = em->l3_next.input_next_ip6;
254     }
255   else if (type0 == ETHERNET_TYPE_MPLS_UNICAST)
256     {
257       *next0 = em->l3_next.input_next_mpls;
258
259     }
260   else if (em->redirect_l3)
261     {
262       // L3 Redirect is on, the cached common next nodes will be
263       // pointing to the redirect node, catch the uncommon types here
264       *next0 = em->redirect_l3_next;
265     }
266   else
267     {
268       // uncommon ethertype, check table
269       u32 i0;
270       i0 = sparse_vec_index (em->l3_next.input_next_by_type, type0);
271       *next0 = vec_elt (em->l3_next.input_next_by_type, i0);
272       *error0 =
273         i0 ==
274         SPARSE_VEC_INVALID_INDEX ? ETHERNET_ERROR_UNKNOWN_TYPE : *error0;
275
276       // The table is not populated with LLC values, so check that now.
277       // If variant is variant_ethernet then we came from LLC processing. Don't
278       // go back there; drop instead using by keeping the drop/bad table result.
279       if ((type0 < 0x600) && (variant == ETHERNET_INPUT_VARIANT_ETHERNET))
280         {
281           *next0 = ETHERNET_INPUT_NEXT_LLC;
282         }
283     }
284 }
285
286 static_always_inline uword
287 ethernet_input_inline (vlib_main_t * vm,
288                        vlib_node_runtime_t * node,
289                        vlib_frame_t * from_frame,
290                        ethernet_input_variant_t variant)
291 {
292   vnet_main_t *vnm = vnet_get_main ();
293   ethernet_main_t *em = &ethernet_main;
294   vlib_node_runtime_t *error_node;
295   u32 n_left_from, next_index, *from, *to_next;
296   u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
297   u32 cpu_index = os_get_cpu_number ();
298
299   if (variant != ETHERNET_INPUT_VARIANT_ETHERNET)
300     error_node = vlib_node_get_runtime (vm, ethernet_input_node.index);
301   else
302     error_node = node;
303
304   from = vlib_frame_vector_args (from_frame);
305   n_left_from = from_frame->n_vectors;
306
307   if (node->flags & VLIB_NODE_FLAG_TRACE)
308     vlib_trace_frame_buffers_only (vm, node,
309                                    from,
310                                    n_left_from,
311                                    sizeof (from[0]),
312                                    sizeof (ethernet_input_trace_t));
313
314   next_index = node->cached_next_index;
315   stats_sw_if_index = node->runtime_data[0];
316   stats_n_packets = stats_n_bytes = 0;
317
318   while (n_left_from > 0)
319     {
320       u32 n_left_to_next;
321
322       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
323
324       while (n_left_from >= 4 && n_left_to_next >= 2)
325         {
326           u32 bi0, bi1;
327           vlib_buffer_t *b0, *b1;
328           u8 next0, next1, error0, error1;
329           u16 type0, orig_type0, type1, orig_type1;
330           u16 outer_id0, inner_id0, outer_id1, inner_id1;
331           u32 match_flags0, match_flags1;
332           u32 old_sw_if_index0, new_sw_if_index0, len0, old_sw_if_index1,
333             new_sw_if_index1, len1;
334           vnet_hw_interface_t *hi0, *hi1;
335           main_intf_t *main_intf0, *main_intf1;
336           vlan_intf_t *vlan_intf0, *vlan_intf1;
337           qinq_intf_t *qinq_intf0, *qinq_intf1;
338           u32 is_l20, is_l21;
339
340           /* Prefetch next iteration. */
341           {
342             vlib_buffer_t *b2, *b3;
343
344             b2 = vlib_get_buffer (vm, from[2]);
345             b3 = vlib_get_buffer (vm, from[3]);
346
347             vlib_prefetch_buffer_header (b2, STORE);
348             vlib_prefetch_buffer_header (b3, STORE);
349
350             CLIB_PREFETCH (b2->data, sizeof (ethernet_header_t), LOAD);
351             CLIB_PREFETCH (b3->data, sizeof (ethernet_header_t), LOAD);
352           }
353
354           bi0 = from[0];
355           bi1 = from[1];
356           to_next[0] = bi0;
357           to_next[1] = bi1;
358           from += 2;
359           to_next += 2;
360           n_left_to_next -= 2;
361           n_left_from -= 2;
362
363           b0 = vlib_get_buffer (vm, bi0);
364           b1 = vlib_get_buffer (vm, bi1);
365
366           error0 = error1 = ETHERNET_ERROR_NONE;
367
368           parse_header (variant,
369                         b0,
370                         &type0,
371                         &orig_type0, &outer_id0, &inner_id0, &match_flags0);
372
373           parse_header (variant,
374                         b1,
375                         &type1,
376                         &orig_type1, &outer_id1, &inner_id1, &match_flags1);
377
378           old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
379           old_sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];
380
381           eth_vlan_table_lookups (em,
382                                   vnm,
383                                   old_sw_if_index0,
384                                   orig_type0,
385                                   outer_id0,
386                                   inner_id0,
387                                   &hi0,
388                                   &main_intf0, &vlan_intf0, &qinq_intf0);
389
390           eth_vlan_table_lookups (em,
391                                   vnm,
392                                   old_sw_if_index1,
393                                   orig_type1,
394                                   outer_id1,
395                                   inner_id1,
396                                   &hi1,
397                                   &main_intf1, &vlan_intf1, &qinq_intf1);
398
399           identify_subint (hi0,
400                            b0,
401                            match_flags0,
402                            main_intf0,
403                            vlan_intf0,
404                            qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
405
406           identify_subint (hi1,
407                            b1,
408                            match_flags1,
409                            main_intf1,
410                            vlan_intf1,
411                            qinq_intf1, &new_sw_if_index1, &error1, &is_l21);
412
413           // Save RX sw_if_index for later nodes
414           vnet_buffer (b0)->sw_if_index[VLIB_RX] =
415             error0 !=
416             ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
417           vnet_buffer (b1)->sw_if_index[VLIB_RX] =
418             error1 !=
419             ETHERNET_ERROR_NONE ? old_sw_if_index1 : new_sw_if_index1;
420
421           // Check if there is a stat to take (valid and non-main sw_if_index for pkt 0 or pkt 1)
422           if (((new_sw_if_index0 != ~0)
423                && (new_sw_if_index0 != old_sw_if_index0))
424               || ((new_sw_if_index1 != ~0)
425                   && (new_sw_if_index1 != old_sw_if_index1)))
426             {
427
428               len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
429                 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
430               len1 = vlib_buffer_length_in_chain (vm, b1) + b1->current_data
431                 - vnet_buffer (b1)->ethernet.start_of_ethernet_header;
432
433               stats_n_packets += 2;
434               stats_n_bytes += len0 + len1;
435
436               if (PREDICT_FALSE
437                   (!(new_sw_if_index0 == stats_sw_if_index
438                      && new_sw_if_index1 == stats_sw_if_index)))
439                 {
440                   stats_n_packets -= 2;
441                   stats_n_bytes -= len0 + len1;
442
443                   if (new_sw_if_index0 != old_sw_if_index0
444                       && new_sw_if_index0 != ~0)
445                     vlib_increment_combined_counter (vnm->
446                                                      interface_main.combined_sw_if_counters
447                                                      +
448                                                      VNET_INTERFACE_COUNTER_RX,
449                                                      cpu_index,
450                                                      new_sw_if_index0, 1,
451                                                      len0);
452                   if (new_sw_if_index1 != old_sw_if_index1
453                       && new_sw_if_index1 != ~0)
454                     vlib_increment_combined_counter (vnm->
455                                                      interface_main.combined_sw_if_counters
456                                                      +
457                                                      VNET_INTERFACE_COUNTER_RX,
458                                                      cpu_index,
459                                                      new_sw_if_index1, 1,
460                                                      len1);
461
462                   if (new_sw_if_index0 == new_sw_if_index1)
463                     {
464                       if (stats_n_packets > 0)
465                         {
466                           vlib_increment_combined_counter
467                             (vnm->interface_main.combined_sw_if_counters
468                              + VNET_INTERFACE_COUNTER_RX,
469                              cpu_index,
470                              stats_sw_if_index,
471                              stats_n_packets, stats_n_bytes);
472                           stats_n_packets = stats_n_bytes = 0;
473                         }
474                       stats_sw_if_index = new_sw_if_index0;
475                     }
476                 }
477             }
478
479           if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
480             is_l20 = is_l21 = 0;
481
482           determine_next_node (em, variant, is_l20, type0, b0, &error0,
483                                &next0);
484           determine_next_node (em, variant, is_l21, type1, b1, &error1,
485                                &next1);
486
487           b0->error = error_node->errors[error0];
488           b1->error = error_node->errors[error1];
489
490           // verify speculative enqueue
491           vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
492                                            n_left_to_next, bi0, bi1, next0,
493                                            next1);
494         }
495
496       while (n_left_from > 0 && n_left_to_next > 0)
497         {
498           u32 bi0;
499           vlib_buffer_t *b0;
500           u8 error0, next0;
501           u16 type0, orig_type0;
502           u16 outer_id0, inner_id0;
503           u32 match_flags0;
504           u32 old_sw_if_index0, new_sw_if_index0, len0;
505           vnet_hw_interface_t *hi0;
506           main_intf_t *main_intf0;
507           vlan_intf_t *vlan_intf0;
508           qinq_intf_t *qinq_intf0;
509           u32 is_l20;
510
511           // Prefetch next iteration
512           if (n_left_from > 1)
513             {
514               vlib_buffer_t *p2;
515
516               p2 = vlib_get_buffer (vm, from[1]);
517               vlib_prefetch_buffer_header (p2, STORE);
518               CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, LOAD);
519             }
520
521           bi0 = from[0];
522           to_next[0] = bi0;
523           from += 1;
524           to_next += 1;
525           n_left_from -= 1;
526           n_left_to_next -= 1;
527
528           b0 = vlib_get_buffer (vm, bi0);
529
530           error0 = ETHERNET_ERROR_NONE;
531
532           parse_header (variant,
533                         b0,
534                         &type0,
535                         &orig_type0, &outer_id0, &inner_id0, &match_flags0);
536
537           old_sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
538
539           eth_vlan_table_lookups (em,
540                                   vnm,
541                                   old_sw_if_index0,
542                                   orig_type0,
543                                   outer_id0,
544                                   inner_id0,
545                                   &hi0,
546                                   &main_intf0, &vlan_intf0, &qinq_intf0);
547
548           identify_subint (hi0,
549                            b0,
550                            match_flags0,
551                            main_intf0,
552                            vlan_intf0,
553                            qinq_intf0, &new_sw_if_index0, &error0, &is_l20);
554
555           // Save RX sw_if_index for later nodes
556           vnet_buffer (b0)->sw_if_index[VLIB_RX] =
557             error0 !=
558             ETHERNET_ERROR_NONE ? old_sw_if_index0 : new_sw_if_index0;
559
560           // Increment subinterface stats
561           // Note that interface-level counters have already been incremented
562           // prior to calling this function. Thus only subinterface counters
563           // are incremented here.
564           //
565           // Interface level counters include packets received on the main
566           // interface and all subinterfaces. Subinterface level counters
567           // include only those packets received on that subinterface
568           // Increment stats if the subint is valid and it is not the main intf
569           if ((new_sw_if_index0 != ~0)
570               && (new_sw_if_index0 != old_sw_if_index0))
571             {
572
573               len0 = vlib_buffer_length_in_chain (vm, b0) + b0->current_data
574                 - vnet_buffer (b0)->ethernet.start_of_ethernet_header;
575
576               stats_n_packets += 1;
577               stats_n_bytes += len0;
578
579               // Batch stat increments from the same subinterface so counters
580               // don't need to be incremented for every packet.
581               if (PREDICT_FALSE (new_sw_if_index0 != stats_sw_if_index))
582                 {
583                   stats_n_packets -= 1;
584                   stats_n_bytes -= len0;
585
586                   if (new_sw_if_index0 != ~0)
587                     vlib_increment_combined_counter
588                       (vnm->interface_main.combined_sw_if_counters
589                        + VNET_INTERFACE_COUNTER_RX,
590                        cpu_index, new_sw_if_index0, 1, len0);
591                   if (stats_n_packets > 0)
592                     {
593                       vlib_increment_combined_counter
594                         (vnm->interface_main.combined_sw_if_counters
595                          + VNET_INTERFACE_COUNTER_RX,
596                          cpu_index,
597                          stats_sw_if_index, stats_n_packets, stats_n_bytes);
598                       stats_n_packets = stats_n_bytes = 0;
599                     }
600                   stats_sw_if_index = new_sw_if_index0;
601                 }
602             }
603
604           if (variant == ETHERNET_INPUT_VARIANT_NOT_L2)
605             is_l20 = 0;
606
607           determine_next_node (em, variant, is_l20, type0, b0, &error0,
608                                &next0);
609
610           b0->error = error_node->errors[error0];
611
612           // verify speculative enqueue
613           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
614                                            to_next, n_left_to_next,
615                                            bi0, next0);
616         }
617
618       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
619     }
620
621   // Increment any remaining batched stats
622   if (stats_n_packets > 0)
623     {
624       vlib_increment_combined_counter
625         (vnm->interface_main.combined_sw_if_counters
626          + VNET_INTERFACE_COUNTER_RX,
627          cpu_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
628       node->runtime_data[0] = stats_sw_if_index;
629     }
630
631   return from_frame->n_vectors;
632 }
633
634 static uword
635 ethernet_input (vlib_main_t * vm,
636                 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
637 {
638   return ethernet_input_inline (vm, node, from_frame,
639                                 ETHERNET_INPUT_VARIANT_ETHERNET);
640 }
641
642 static uword
643 ethernet_input_type (vlib_main_t * vm,
644                      vlib_node_runtime_t * node, vlib_frame_t * from_frame)
645 {
646   return ethernet_input_inline (vm, node, from_frame,
647                                 ETHERNET_INPUT_VARIANT_ETHERNET_TYPE);
648 }
649
650 static uword
651 ethernet_input_not_l2 (vlib_main_t * vm,
652                        vlib_node_runtime_t * node, vlib_frame_t * from_frame)
653 {
654   return ethernet_input_inline (vm, node, from_frame,
655                                 ETHERNET_INPUT_VARIANT_NOT_L2);
656 }
657
658
659 // Return the subinterface config struct for the given sw_if_index
660 // Also return via parameter the appropriate match flags for the
661 // configured number of tags.
662 // On error (unsupported or not ethernet) return 0.
663 static subint_config_t *
664 ethernet_sw_interface_get_config (vnet_main_t * vnm,
665                                   u32 sw_if_index,
666                                   u32 * flags, u32 * unsupported)
667 {
668   ethernet_main_t *em = &ethernet_main;
669   vnet_hw_interface_t *hi;
670   vnet_sw_interface_t *si;
671   main_intf_t *main_intf;
672   vlan_table_t *vlan_table;
673   qinq_table_t *qinq_table;
674   subint_config_t *subint = 0;
675
676   hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
677
678   if (!hi || (hi->hw_class_index != ethernet_hw_interface_class.index))
679     {
680       *unsupported = 0;
681       goto done;                // non-ethernet interface
682     }
683
684   // ensure there's an entry for the main intf (shouldn't really be necessary)
685   vec_validate (em->main_intfs, hi->hw_if_index);
686   main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
687
688   // Locate the subint for the given ethernet config
689   si = vnet_get_sw_interface (vnm, sw_if_index);
690
691   if (si->sub.eth.flags.default_sub)
692     {
693       subint = &main_intf->default_subint;
694       *flags = SUBINT_CONFIG_MATCH_0_TAG |
695         SUBINT_CONFIG_MATCH_1_TAG |
696         SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
697     }
698   else if ((si->sub.eth.flags.no_tags) || (si->sub.eth.raw_flags == 0))
699     {
700       // if no flags are set then this is a main interface
701       // so treat as untagged
702       subint = &main_intf->untagged_subint;
703       *flags = SUBINT_CONFIG_MATCH_0_TAG;
704     }
705   else
706     {
707       // one or two tags
708       // first get the vlan table
709       if (si->sub.eth.flags.dot1ad)
710         {
711           if (main_intf->dot1ad_vlans == 0)
712             {
713               // Allocate a vlan table from the pool
714               pool_get (em->vlan_pool, vlan_table);
715               main_intf->dot1ad_vlans = vlan_table - em->vlan_pool;
716             }
717           else
718             {
719               // Get ptr to existing vlan table
720               vlan_table =
721                 vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
722             }
723         }
724       else
725         {                       // dot1q
726           if (main_intf->dot1q_vlans == 0)
727             {
728               // Allocate a vlan table from the pool
729               pool_get (em->vlan_pool, vlan_table);
730               main_intf->dot1q_vlans = vlan_table - em->vlan_pool;
731             }
732           else
733             {
734               // Get ptr to existing vlan table
735               vlan_table =
736                 vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
737             }
738         }
739
740       if (si->sub.eth.flags.one_tag)
741         {
742           *flags = si->sub.eth.flags.exact_match ?
743             SUBINT_CONFIG_MATCH_1_TAG :
744             (SUBINT_CONFIG_MATCH_1_TAG |
745              SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
746
747           if (si->sub.eth.flags.outer_vlan_id_any)
748             {
749               // not implemented yet
750               *unsupported = 1;
751               goto done;
752             }
753           else
754             {
755               // a single vlan, a common case
756               subint =
757                 &vlan_table->vlans[si->sub.eth.
758                                    outer_vlan_id].single_tag_subint;
759             }
760
761         }
762       else
763         {
764           // Two tags
765           *flags = si->sub.eth.flags.exact_match ?
766             SUBINT_CONFIG_MATCH_2_TAG :
767             (SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG);
768
769           if (si->sub.eth.flags.outer_vlan_id_any
770               && si->sub.eth.flags.inner_vlan_id_any)
771             {
772               // not implemented yet
773               *unsupported = 1;
774               goto done;
775             }
776
777           if (si->sub.eth.flags.inner_vlan_id_any)
778             {
779               // a specific outer and "any" inner
780               // don't need a qinq table for this
781               subint =
782                 &vlan_table->vlans[si->sub.eth.
783                                    outer_vlan_id].inner_any_subint;
784               if (si->sub.eth.flags.exact_match)
785                 {
786                   *flags = SUBINT_CONFIG_MATCH_2_TAG;
787                 }
788               else
789                 {
790                   *flags = SUBINT_CONFIG_MATCH_2_TAG |
791                     SUBINT_CONFIG_MATCH_3_TAG;
792                 }
793             }
794           else
795             {
796               // a specific outer + specifc innner vlan id, a common case
797
798               // get the qinq table
799               if (vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs == 0)
800                 {
801                   // Allocate a qinq table from the pool
802                   pool_get (em->qinq_pool, qinq_table);
803                   vlan_table->vlans[si->sub.eth.outer_vlan_id].qinqs =
804                     qinq_table - em->qinq_pool;
805                 }
806               else
807                 {
808                   // Get ptr to existing qinq table
809                   qinq_table =
810                     vec_elt_at_index (em->qinq_pool,
811                                       vlan_table->vlans[si->sub.
812                                                         eth.outer_vlan_id].
813                                       qinqs);
814                 }
815               subint = &qinq_table->vlans[si->sub.eth.inner_vlan_id].subint;
816             }
817         }
818     }
819
820 done:
821   return subint;
822 }
823
824 clib_error_t *
825 ethernet_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
826 {
827   subint_config_t *subint;
828   u32 dummy_flags;
829   u32 dummy_unsup;
830   clib_error_t *error = 0;
831
832   // Find the config for this subinterface
833   subint =
834     ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
835                                       &dummy_unsup);
836
837   if (subint == 0)
838     {
839       // not implemented yet or not ethernet
840       goto done;
841     }
842
843   subint->sw_if_index =
844     ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ? sw_if_index : ~0);
845
846 done:
847   return error;
848 }
849
850 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_sw_interface_up_down);
851
852
853 // Set the L2/L3 mode for the subinterface
854 void
855 ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index, u32 l2)
856 {
857   subint_config_t *subint;
858   u32 dummy_flags;
859   u32 dummy_unsup;
860   int is_port;
861   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
862
863   is_port = !(sw->type == VNET_SW_INTERFACE_TYPE_SUB);
864
865   // Find the config for this subinterface
866   subint =
867     ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
868                                       &dummy_unsup);
869
870   if (subint == 0)
871     {
872       // unimplemented or not ethernet
873       goto done;
874     }
875
876   // Double check that the config we found is for our interface (or the interface is down)
877   ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
878
879   if (l2)
880     {
881       subint->flags |= SUBINT_CONFIG_L2;
882       if (is_port)
883         subint->flags |=
884           SUBINT_CONFIG_MATCH_0_TAG | SUBINT_CONFIG_MATCH_1_TAG
885           | SUBINT_CONFIG_MATCH_2_TAG | SUBINT_CONFIG_MATCH_3_TAG;
886     }
887   else
888     {
889       subint->flags &= ~SUBINT_CONFIG_L2;
890       if (is_port)
891         subint->flags &=
892           ~(SUBINT_CONFIG_MATCH_1_TAG | SUBINT_CONFIG_MATCH_2_TAG
893             | SUBINT_CONFIG_MATCH_3_TAG);
894     }
895
896 done:
897   return;
898 }
899
900 /*
901  * Set the L2/L3 mode for the subinterface regardless of port
902  */
903 void
904 ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
905                                           u32 sw_if_index, u32 l2)
906 {
907   subint_config_t *subint;
908   u32 dummy_flags;
909   u32 dummy_unsup;
910
911   /* Find the config for this subinterface */
912   subint =
913     ethernet_sw_interface_get_config (vnm, sw_if_index, &dummy_flags,
914                                       &dummy_unsup);
915
916   if (subint == 0)
917     {
918       /* unimplemented or not ethernet */
919       goto done;
920     }
921
922   /*
923    * Double check that the config we found is for our interface (or the
924    * interface is down)
925    */
926   ASSERT ((subint->sw_if_index == sw_if_index) | (subint->sw_if_index == ~0));
927
928   if (l2)
929     {
930       subint->flags |= SUBINT_CONFIG_L2;
931     }
932   else
933     {
934       subint->flags &= ~SUBINT_CONFIG_L2;
935     }
936
937 done:
938   return;
939 }
940
941 static clib_error_t *
942 ethernet_sw_interface_add_del (vnet_main_t * vnm,
943                                u32 sw_if_index, u32 is_create)
944 {
945   clib_error_t *error = 0;
946   subint_config_t *subint;
947   u32 match_flags;
948   u32 unsupported = 0;
949
950   // Find the config for this subinterface
951   subint =
952     ethernet_sw_interface_get_config (vnm, sw_if_index, &match_flags,
953                                       &unsupported);
954
955   if (subint == 0)
956     {
957       // not implemented yet or not ethernet
958       if (unsupported)
959         {
960           // this is the NYI case
961           error = clib_error_return (0, "not implemented yet");
962         }
963       goto done;
964     }
965
966   if (!is_create)
967     {
968       subint->flags = 0;
969       return error;
970     }
971
972   // Initialize the subint
973   if (subint->flags & SUBINT_CONFIG_VALID)
974     {
975       // Error vlan already in use
976       error = clib_error_return (0, "vlan is already in use");
977     }
978   else
979     {
980       // Note that config is L3 by defaulty
981       subint->flags = SUBINT_CONFIG_VALID | match_flags;
982       subint->sw_if_index = ~0; // because interfaces are initially down
983     }
984
985 done:
986   return error;
987 }
988
989 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ethernet_sw_interface_add_del);
990
991 static char *ethernet_error_strings[] = {
992 #define ethernet_error(n,c,s) s,
993 #include "error.def"
994 #undef ethernet_error
995 };
996
997 /* *INDENT-OFF* */
998 VLIB_REGISTER_NODE (ethernet_input_node) = {
999   .function = ethernet_input,
1000   .name = "ethernet-input",
1001   /* Takes a vector of packets. */
1002   .vector_size = sizeof (u32),
1003   .n_errors = ETHERNET_N_ERROR,
1004   .error_strings = ethernet_error_strings,
1005   .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1006   .next_nodes = {
1007 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1008     foreach_ethernet_input_next
1009 #undef _
1010   },
1011   .format_buffer = format_ethernet_header_with_length,
1012   .format_trace = format_ethernet_input_trace,
1013   .unformat_buffer = unformat_ethernet_header,
1014 };
1015 /* *INDENT-ON* */
1016
1017 /* *INDENT-OFF* */
1018 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_node, ethernet_input)
1019 /* *INDENT-ON* */
1020
1021 /* *INDENT-OFF* */
1022 VLIB_REGISTER_NODE (ethernet_input_type_node, static) = {
1023   .function = ethernet_input_type,
1024   .name = "ethernet-input-type",
1025   /* Takes a vector of packets. */
1026   .vector_size = sizeof (u32),
1027   .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1028   .next_nodes = {
1029 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1030     foreach_ethernet_input_next
1031 #undef _
1032   },
1033 };
1034 /* *INDENT-ON* */
1035
1036 /* *INDENT-OFF* */
1037 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_type_node, ethernet_input_type)
1038 /* *INDENT-ON* */
1039
1040 /* *INDENT-OFF* */
1041 VLIB_REGISTER_NODE (ethernet_input_not_l2_node, static) = {
1042   .function = ethernet_input_not_l2,
1043   .name = "ethernet-input-not-l2",
1044   /* Takes a vector of packets. */
1045   .vector_size = sizeof (u32),
1046   .n_next_nodes = ETHERNET_INPUT_N_NEXT,
1047   .next_nodes = {
1048 #define _(s,n) [ETHERNET_INPUT_NEXT_##s] = n,
1049     foreach_ethernet_input_next
1050 #undef _
1051   },
1052 };
1053 /* *INDENT-ON* */
1054
1055
1056 /* *INDENT-OFF* */
1057 VLIB_NODE_FUNCTION_MULTIARCH (ethernet_input_not_l2_node,
1058                               ethernet_input_not_l2)
1059 /* *INDENT-ON* */
1060
1061
1062 void
1063 ethernet_set_rx_redirect (vnet_main_t * vnm,
1064                           vnet_hw_interface_t * hi, u32 enable)
1065 {
1066   // Insure all packets go to ethernet-input (i.e. untagged ipv4 packets
1067   // don't go directly to ip4-input)
1068   vnet_hw_interface_rx_redirect_to_node
1069     (vnm, hi->hw_if_index, enable ? ethernet_input_node.index : ~0);
1070 }
1071
1072
1073 /*
1074  * Initialization and registration for the next_by_ethernet structure
1075  */
1076
1077 clib_error_t *
1078 next_by_ethertype_init (next_by_ethertype_t * l3_next)
1079 {
1080   l3_next->input_next_by_type = sparse_vec_new
1081     ( /* elt bytes */ sizeof (l3_next->input_next_by_type[0]),
1082      /* bits in index */ BITS (((ethernet_header_t *) 0)->type));
1083
1084   vec_validate (l3_next->sparse_index_by_input_next_index,
1085                 ETHERNET_INPUT_NEXT_DROP);
1086   vec_validate (l3_next->sparse_index_by_input_next_index,
1087                 ETHERNET_INPUT_NEXT_PUNT);
1088   l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_DROP] =
1089     SPARSE_VEC_INVALID_INDEX;
1090   l3_next->sparse_index_by_input_next_index[ETHERNET_INPUT_NEXT_PUNT] =
1091     SPARSE_VEC_INVALID_INDEX;
1092
1093   /*
1094    * Make sure we don't wipe out an ethernet registration by mistake
1095    * Can happen if init function ordering constraints are missing.
1096    */
1097   if (CLIB_DEBUG > 0)
1098     {
1099       ethernet_main_t *em = &ethernet_main;
1100       ASSERT (em->next_by_ethertype_register_called == 0);
1101     }
1102
1103   return 0;
1104 }
1105
1106 // Add an ethertype -> next index mapping to the structure
1107 clib_error_t *
1108 next_by_ethertype_register (next_by_ethertype_t * l3_next,
1109                             u32 ethertype, u32 next_index)
1110 {
1111   u32 i;
1112   u16 *n;
1113   ethernet_main_t *em = &ethernet_main;
1114
1115   if (CLIB_DEBUG > 0)
1116     {
1117       ethernet_main_t *em = &ethernet_main;
1118       em->next_by_ethertype_register_called = 1;
1119     }
1120
1121   /* Setup ethernet type -> next index sparse vector mapping. */
1122   n = sparse_vec_validate (l3_next->input_next_by_type, ethertype);
1123   n[0] = next_index;
1124
1125   /* Rebuild next index -> sparse index inverse mapping when sparse vector
1126      is updated. */
1127   vec_validate (l3_next->sparse_index_by_input_next_index, next_index);
1128   for (i = 1; i < vec_len (l3_next->input_next_by_type); i++)
1129     l3_next->
1130       sparse_index_by_input_next_index[l3_next->input_next_by_type[i]] = i;
1131
1132   // do not allow the cached next index's to be updated if L3
1133   // redirect is enabled, as it will have overwritten them
1134   if (!em->redirect_l3)
1135     {
1136       // Cache common ethertypes directly
1137       if (ethertype == ETHERNET_TYPE_IP4)
1138         {
1139           l3_next->input_next_ip4 = next_index;
1140         }
1141       else if (ethertype == ETHERNET_TYPE_IP6)
1142         {
1143           l3_next->input_next_ip6 = next_index;
1144         }
1145       else if (ethertype == ETHERNET_TYPE_MPLS_UNICAST)
1146         {
1147           l3_next->input_next_mpls = next_index;
1148         }
1149     }
1150   return 0;
1151 }
1152
1153
1154 static clib_error_t *
1155 ethernet_input_init (vlib_main_t * vm)
1156 {
1157   ethernet_main_t *em = &ethernet_main;
1158   __attribute__ ((unused)) vlan_table_t *invalid_vlan_table;
1159   __attribute__ ((unused)) qinq_table_t *invalid_qinq_table;
1160
1161   ethernet_setup_node (vm, ethernet_input_node.index);
1162   ethernet_setup_node (vm, ethernet_input_type_node.index);
1163   ethernet_setup_node (vm, ethernet_input_not_l2_node.index);
1164
1165   next_by_ethertype_init (&em->l3_next);
1166
1167   // Initialize pools and vector for vlan parsing
1168   vec_validate (em->main_intfs, 10);    // 10 main interfaces
1169   pool_alloc (em->vlan_pool, 10);
1170   pool_alloc (em->qinq_pool, 1);
1171
1172   // The first vlan pool will always be reserved for an invalid table
1173   pool_get (em->vlan_pool, invalid_vlan_table); // first id = 0
1174   // The first qinq pool will always be reserved for an invalid table
1175   pool_get (em->qinq_pool, invalid_qinq_table); // first id = 0
1176
1177   return 0;
1178 }
1179
1180 VLIB_INIT_FUNCTION (ethernet_input_init);
1181
1182 void
1183 ethernet_register_input_type (vlib_main_t * vm,
1184                               ethernet_type_t type, u32 node_index)
1185 {
1186   ethernet_main_t *em = &ethernet_main;
1187   ethernet_type_info_t *ti;
1188   u32 i;
1189
1190   {
1191     clib_error_t *error = vlib_call_init_function (vm, ethernet_init);
1192     if (error)
1193       clib_error_report (error);
1194   }
1195
1196   ti = ethernet_get_type_info (em, type);
1197   ti->node_index = node_index;
1198   ti->next_index = vlib_node_add_next (vm,
1199                                        ethernet_input_node.index, node_index);
1200   i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1201   ASSERT (i == ti->next_index);
1202
1203   i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1204   ASSERT (i == ti->next_index);
1205
1206   // Add the L3 node for this ethertype to the next nodes structure
1207   next_by_ethertype_register (&em->l3_next, type, ti->next_index);
1208
1209   // Call the registration functions for other nodes that want a mapping
1210   l2bvi_register_input_type (vm, type, node_index);
1211 }
1212
1213 void
1214 ethernet_register_l2_input (vlib_main_t * vm, u32 node_index)
1215 {
1216   ethernet_main_t *em = &ethernet_main;
1217   u32 i;
1218
1219   em->l2_next =
1220     vlib_node_add_next (vm, ethernet_input_node.index, node_index);
1221
1222   /*
1223    * Even if we never use these arcs, we have to align the next indices...
1224    */
1225   i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1226
1227   ASSERT (i == em->l2_next);
1228
1229   i = vlib_node_add_next (vm, ethernet_input_not_l2_node.index, node_index);
1230   ASSERT (i == em->l2_next);
1231 }
1232
1233 // Register a next node for L3 redirect, and enable L3 redirect
1234 void
1235 ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index)
1236 {
1237   ethernet_main_t *em = &ethernet_main;
1238   u32 i;
1239
1240   em->redirect_l3 = 1;
1241   em->redirect_l3_next = vlib_node_add_next (vm,
1242                                              ethernet_input_node.index,
1243                                              node_index);
1244   /*
1245    * Change the cached next nodes to the redirect node
1246    */
1247   em->l3_next.input_next_ip4 = em->redirect_l3_next;
1248   em->l3_next.input_next_ip6 = em->redirect_l3_next;
1249   em->l3_next.input_next_mpls = em->redirect_l3_next;
1250
1251   /*
1252    * Even if we never use these arcs, we have to align the next indices...
1253    */
1254   i = vlib_node_add_next (vm, ethernet_input_type_node.index, node_index);
1255
1256   ASSERT (i == em->redirect_l3_next);
1257 }
1258
1259 /*
1260  * fd.io coding-style-patch-verification: ON
1261  *
1262  * Local Variables:
1263  * eval: (c-set-style "gnu")
1264  * End:
1265  */