VPP-240: delete subinterface
[vpp.git] / vnet / vnet / ethernet / interface.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_interface.c: ethernet interfaces
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 <vnet/vnet.h>
41 #include <vnet/ip/ip.h>
42 #include <vnet/pg/pg.h>
43 #include <vnet/ethernet/ethernet.h>
44 #include <vnet/l2/l2_input.h>
45
46 static uword
47 ethernet_set_rewrite (vnet_main_t * vnm,
48                       u32 sw_if_index,
49                       u32 l3_type,
50                       void *dst_address,
51                       void *rewrite, uword max_rewrite_bytes)
52 {
53   vnet_sw_interface_t *sub_sw = vnet_get_sw_interface (vnm, sw_if_index);
54   vnet_sw_interface_t *sup_sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
55   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
56   ethernet_main_t *em = &ethernet_main;
57   ethernet_interface_t *ei;
58   ethernet_header_t *h = rewrite;
59   ethernet_type_t type;
60   uword n_bytes = sizeof (h[0]);
61
62   if (sub_sw != sup_sw)
63     {
64       if (sub_sw->sub.eth.flags.one_tag)
65         {
66           n_bytes += sizeof (ethernet_vlan_header_t);
67         }
68       else if (sub_sw->sub.eth.flags.two_tags)
69         {
70           n_bytes += 2 * (sizeof (ethernet_vlan_header_t));
71         }
72       // Check for encaps that are not supported for L3 interfaces
73       if (!(sub_sw->sub.eth.flags.exact_match) ||
74           (sub_sw->sub.eth.flags.default_sub) ||
75           (sub_sw->sub.eth.flags.outer_vlan_id_any) ||
76           (sub_sw->sub.eth.flags.inner_vlan_id_any))
77         {
78           return 0;
79         }
80     }
81
82   if (n_bytes > max_rewrite_bytes)
83     return 0;
84
85   switch (l3_type)
86     {
87 #define _(a,b) case VNET_L3_PACKET_TYPE_##a: type = ETHERNET_TYPE_##b; break
88       _(IP4, IP4);
89       _(IP6, IP6);
90       _(MPLS_UNICAST, MPLS_UNICAST);
91       _(MPLS_MULTICAST, MPLS_MULTICAST);
92       _(ARP, ARP);
93 #undef _
94     default:
95       return 0;
96     }
97
98   ei = pool_elt_at_index (em->interfaces, hw->hw_instance);
99   clib_memcpy (h->src_address, ei->address, sizeof (h->src_address));
100   if (dst_address)
101     clib_memcpy (h->dst_address, dst_address, sizeof (h->dst_address));
102   else
103     memset (h->dst_address, ~0, sizeof (h->dst_address));       /* broadcast */
104
105   if (sub_sw->sub.eth.flags.one_tag)
106     {
107       ethernet_vlan_header_t *outer = (void *) (h + 1);
108
109       h->type = sub_sw->sub.eth.flags.dot1ad ?
110         clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
111         clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
112       outer->priority_cfi_and_id =
113         clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
114       outer->type = clib_host_to_net_u16 (type);
115
116     }
117   else if (sub_sw->sub.eth.flags.two_tags)
118     {
119       ethernet_vlan_header_t *outer = (void *) (h + 1);
120       ethernet_vlan_header_t *inner = (void *) (outer + 1);
121
122       h->type = sub_sw->sub.eth.flags.dot1ad ?
123         clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
124         clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
125       outer->priority_cfi_and_id =
126         clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
127       outer->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
128       inner->priority_cfi_and_id =
129         clib_host_to_net_u16 (sub_sw->sub.eth.inner_vlan_id);
130       inner->type = clib_host_to_net_u16 (type);
131
132     }
133   else
134     {
135       h->type = clib_host_to_net_u16 (type);
136     }
137
138   return n_bytes;
139 }
140
141 /* *INDENT-OFF* */
142 VNET_HW_INTERFACE_CLASS (ethernet_hw_interface_class) = {
143   .name = "Ethernet",
144   .format_address = format_ethernet_address,
145   .format_header = format_ethernet_header_with_length,
146   .unformat_hw_address = unformat_ethernet_address,
147   .unformat_header = unformat_ethernet_header,
148   .set_rewrite = ethernet_set_rewrite,
149 };
150 /* *INDENT-ON* */
151
152 uword
153 unformat_ethernet_interface (unformat_input_t * input, va_list * args)
154 {
155   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
156   u32 *result = va_arg (*args, u32 *);
157   u32 hw_if_index;
158   ethernet_main_t *em = &ethernet_main;
159   ethernet_interface_t *eif;
160
161   if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
162     return 0;
163
164   eif = ethernet_get_interface (em, hw_if_index);
165   if (eif)
166     {
167       *result = hw_if_index;
168       return 1;
169     }
170   return 0;
171 }
172
173 clib_error_t *
174 ethernet_register_interface (vnet_main_t * vnm,
175                              u32 dev_class_index,
176                              u32 dev_instance,
177                              u8 * address,
178                              u32 * hw_if_index_return,
179                              ethernet_flag_change_function_t flag_change)
180 {
181   ethernet_main_t *em = &ethernet_main;
182   ethernet_interface_t *ei;
183   vnet_hw_interface_t *hi;
184   clib_error_t *error = 0;
185   u32 hw_if_index;
186
187   pool_get (em->interfaces, ei);
188   ei->flag_change = flag_change;
189
190   hw_if_index = vnet_register_interface
191     (vnm,
192      dev_class_index, dev_instance,
193      ethernet_hw_interface_class.index, ei - em->interfaces);
194   *hw_if_index_return = hw_if_index;
195
196   hi = vnet_get_hw_interface (vnm, hw_if_index);
197
198   ethernet_setup_node (vnm->vlib_main, hi->output_node_index);
199
200   hi->min_packet_bytes = hi->min_supported_packet_bytes =
201     ETHERNET_MIN_PACKET_BYTES;
202   hi->max_packet_bytes = hi->max_supported_packet_bytes =
203     ETHERNET_MAX_PACKET_BYTES;
204   hi->per_packet_overhead_bytes =
205     /* preamble */ 8 + /* inter frame gap */ 12;
206
207   /* Standard default ethernet MTU. */
208   hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 9000;
209
210   clib_memcpy (ei->address, address, sizeof (ei->address));
211   vec_free (hi->hw_address);
212   vec_add (hi->hw_address, address, sizeof (ei->address));
213
214   if (error)
215     {
216       pool_put (em->interfaces, ei);
217       return error;
218     }
219   return error;
220 }
221
222 void
223 ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index)
224 {
225   ethernet_main_t *em = &ethernet_main;
226   ethernet_interface_t *ei;
227   vnet_hw_interface_t *hi;
228   main_intf_t *main_intf;
229   vlan_table_t *vlan_table;
230   u32 idx;
231
232   hi = vnet_get_hw_interface (vnm, hw_if_index);
233   ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
234
235   /* Delete vlan mapping table for dot1q and dot1ad. */
236   main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
237   if (main_intf->dot1q_vlans)
238     {
239       vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
240       for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
241         {
242           if (vlan_table->vlans[idx].qinqs)
243             {
244               pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
245             }
246         }
247       pool_put_index (em->vlan_pool, main_intf->dot1q_vlans);
248     }
249   if (main_intf->dot1ad_vlans)
250     {
251       vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
252       for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
253         {
254           if (vlan_table->vlans[idx].qinqs)
255             {
256               pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
257             }
258         }
259       pool_put_index (em->vlan_pool, main_intf->dot1ad_vlans);
260     }
261
262   vnet_delete_hw_interface (vnm, hw_if_index);
263   pool_put (em->interfaces, ei);
264 }
265
266 u32
267 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
268 {
269   ethernet_main_t *em = &ethernet_main;
270   vnet_hw_interface_t *hi;
271   ethernet_interface_t *ei;
272
273   hi = vnet_get_hw_interface (vnm, hw_if_index);
274
275   ASSERT (hi->hw_class_index == ethernet_hw_interface_class.index);
276
277   ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
278   if (ei->flag_change)
279     return ei->flag_change (vnm, hi, flags);
280   return (u32) ~ 0;
281 }
282
283 /* Echo packets back to ethernet/l2-input. */
284 static uword
285 simulated_ethernet_interface_tx (vlib_main_t * vm,
286                                  vlib_node_runtime_t * node,
287                                  vlib_frame_t * frame)
288 {
289   u32 n_left_from, n_left_to_next, n_copy, *from, *to_next;
290   u32 next_index = VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT;
291   u32 i, next_node_index, bvi_flag, sw_if_index;
292   u32 n_pkts = 0, n_bytes = 0;
293   u32 cpu_index = vm->cpu_index;
294   vnet_main_t *vnm = vnet_get_main ();
295   vnet_interface_main_t *im = &vnm->interface_main;
296   vlib_node_main_t *nm = &vm->node_main;
297   vlib_node_t *loop_node;
298   vlib_buffer_t *b;
299
300   // check tx node index, it is ethernet-input on loopback create
301   // but can be changed to l2-input if loopback is configured as
302   // BVI of a BD (Bridge Domain).
303   loop_node = vec_elt (nm->nodes, node->node_index);
304   next_node_index = loop_node->next_nodes[next_index];
305   bvi_flag = (next_node_index == l2input_node.index) ? 1 : 0;
306
307   n_left_from = frame->n_vectors;
308   from = vlib_frame_args (frame);
309
310   while (n_left_from > 0)
311     {
312       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
313
314       n_copy = clib_min (n_left_from, n_left_to_next);
315
316       clib_memcpy (to_next, from, n_copy * sizeof (from[0]));
317       n_left_to_next -= n_copy;
318       n_left_from -= n_copy;
319       i = 0;
320       b = vlib_get_buffer (vm, from[i]);
321       sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
322       while (1)
323         {
324           // Set up RX and TX indices as if received from a real driver
325           // unless loopback is used as a BVI. For BVI case, leave TX index
326           // and update l2_len in packet as required for l2 forwarding path
327           vnet_buffer (b)->sw_if_index[VLIB_RX] = sw_if_index;
328           if (bvi_flag)
329             vnet_update_l2_len (b);
330           else
331             vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32) ~ 0;
332
333           i++;
334           n_pkts++;
335           n_bytes += vlib_buffer_length_in_chain (vm, b);
336
337           if (i < n_copy)
338             b = vlib_get_buffer (vm, from[i]);
339           else
340             break;
341         }
342
343       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
344
345       /* increment TX interface stat */
346       vlib_increment_combined_counter (im->combined_sw_if_counters +
347                                        VNET_INTERFACE_COUNTER_TX, cpu_index,
348                                        sw_if_index, n_pkts, n_bytes);
349     }
350
351   return n_left_from;
352 }
353
354 static u8 *
355 format_simulated_ethernet_name (u8 * s, va_list * args)
356 {
357   u32 dev_instance = va_arg (*args, u32);
358   return format (s, "loop%d", dev_instance);
359 }
360
361 static clib_error_t *
362 simulated_ethernet_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
363                                   u32 flags)
364 {
365   u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
366     VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
367   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
368   return 0;
369 }
370
371 /* *INDENT-OFF* */
372 VNET_DEVICE_CLASS (ethernet_simulated_device_class) = {
373   .name = "Loopback",
374   .format_device_name = format_simulated_ethernet_name,
375   .tx_function = simulated_ethernet_interface_tx,
376   .admin_up_down_function = simulated_ethernet_admin_up_down,
377   .no_flatten_output_chains = 1,
378 };
379 /* *INDENT-ON* */
380
381 int
382 vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address)
383 {
384   vnet_main_t *vnm = vnet_get_main ();
385   vlib_main_t *vm = vlib_get_main ();
386   clib_error_t *error;
387   static u32 instance;
388   u8 address[6];
389   u32 hw_if_index;
390   vnet_hw_interface_t *hw_if;
391   u32 slot;
392   int rv = 0;
393
394   ASSERT (sw_if_indexp);
395
396   *sw_if_indexp = (u32) ~ 0;
397
398   memset (address, 0, sizeof (address));
399
400   /*
401    * Default MAC address (dead:0000:0000 + instance) is allocated
402    * if zero mac_address is configured. Otherwise, user-configurable MAC
403    * address is programmed on the loopback interface.
404    */
405   if (memcmp (address, mac_address, sizeof (address)))
406     clib_memcpy (address, mac_address, sizeof (address));
407   else
408     {
409       address[0] = 0xde;
410       address[1] = 0xad;
411       address[5] = instance;
412     }
413
414   error = ethernet_register_interface
415     (vnm,
416      ethernet_simulated_device_class.index, instance++, address, &hw_if_index,
417      /* flag change */ 0);
418
419   if (error)
420     {
421       rv = VNET_API_ERROR_INVALID_REGISTRATION;
422       clib_error_report (error);
423       return rv;
424     }
425
426   hw_if = vnet_get_hw_interface (vnm, hw_if_index);
427   slot = vlib_node_add_named_next_with_slot
428     (vm, hw_if->tx_node_index,
429      "ethernet-input", VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
430   ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
431
432   {
433     vnet_sw_interface_t *si = vnet_get_hw_sw_interface (vnm, hw_if_index);
434     *sw_if_indexp = si->sw_if_index;
435   }
436
437   return 0;
438 }
439
440 static clib_error_t *
441 create_simulated_ethernet_interfaces (vlib_main_t * vm,
442                                       unformat_input_t * input,
443                                       vlib_cli_command_t * cmd)
444 {
445   int rv;
446   u32 sw_if_index;
447   u8 mac_address[6];
448
449   memset (mac_address, 0, sizeof (mac_address));
450
451   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
452     {
453       if (unformat (input, "mac %U", unformat_ethernet_address, mac_address))
454         ;
455       else
456         break;
457     }
458
459   rv = vnet_create_loopback_interface (&sw_if_index, mac_address);
460
461   if (rv)
462     return clib_error_return (0, "vnet_create_loopback_interface failed");
463
464   vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
465                    sw_if_index);
466   return 0;
467 }
468
469 /* *INDENT-OFF* */
470 VLIB_CLI_COMMAND (create_simulated_ethernet_interface_command, static) = {
471   .path = "loopback create-interface",
472   .short_help = "Create Loopback ethernet interface [mac <mac-addr>]",
473   .function = create_simulated_ethernet_interfaces,
474 };
475 /* *INDENT-ON* */
476
477 /* *INDENT-OFF* */
478 VLIB_CLI_COMMAND (create_loopback_interface_command, static) = {
479   .path = "create loopback interface",
480   .short_help = "create loopback interface [mac <mac-addr>]",
481   .function = create_simulated_ethernet_interfaces,
482 };
483 /* *INDENT-ON* */
484
485 ethernet_interface_t *
486 ethernet_get_interface (ethernet_main_t * em, u32 hw_if_index)
487 {
488   vnet_hw_interface_t *i =
489     vnet_get_hw_interface (vnet_get_main (), hw_if_index);
490   return (i->hw_class_index ==
491           ethernet_hw_interface_class.
492           index ? pool_elt_at_index (em->interfaces, i->hw_instance) : 0);
493 }
494
495 int
496 vnet_delete_loopback_interface (u32 sw_if_index)
497 {
498   vnet_main_t *vnm = vnet_get_main ();
499   vnet_sw_interface_t *si;
500
501   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
502     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
503
504   si = vnet_get_sw_interface (vnm, sw_if_index);
505   ethernet_delete_interface (vnm, si->hw_if_index);
506
507   return 0;
508 }
509
510 int
511 vnet_delete_sub_interface (u32 sw_if_index)
512 {
513   vnet_main_t *vnm = vnet_get_main ();
514   int rv = 0;
515
516   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
517     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
518
519
520   vnet_interface_main_t *im = &vnm->interface_main;
521   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
522
523   if (si->type == VNET_SW_INTERFACE_TYPE_SUB)
524     {
525       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
526       u64 sup_and_sub_key =
527         ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
528
529       hash_unset_mem (im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
530       vnet_delete_sw_interface (vnm, sw_if_index);
531     }
532   else
533     {
534       rv = VNET_API_ERROR_INVALID_SUB_SW_IF_INDEX;
535     }
536   return rv;
537 }
538
539 static clib_error_t *
540 delete_simulated_ethernet_interfaces (vlib_main_t * vm,
541                                       unformat_input_t * input,
542                                       vlib_cli_command_t * cmd)
543 {
544   int rv;
545   u32 sw_if_index = ~0;
546   vnet_main_t *vnm = vnet_get_main ();
547
548   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
549     {
550       if (unformat (input, "intfc %U",
551                     unformat_vnet_sw_interface, vnm, &sw_if_index))
552         ;
553       else
554         break;
555     }
556
557   if (sw_if_index == ~0)
558     return clib_error_return (0, "interface not specified");
559
560   rv = vnet_delete_loopback_interface (sw_if_index);
561
562   if (rv)
563     return clib_error_return (0, "vnet_delete_loopback_interface failed");
564
565   return 0;
566 }
567
568 static clib_error_t *
569 delete_sub_interface (vlib_main_t * vm,
570                       unformat_input_t * input, vlib_cli_command_t * cmd)
571 {
572   int rv = 0;
573   u32 sw_if_index = ~0;
574   vnet_main_t *vnm = vnet_get_main ();
575
576   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
577     {
578       if (unformat
579           (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
580         ;
581       else
582         break;
583     }
584   if (sw_if_index == ~0)
585     return clib_error_return (0, "interface doesn't exist");
586
587   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
588     rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
589   else
590     rv = vnet_delete_sub_interface (sw_if_index);
591   if (rv)
592     return clib_error_return (0, "delete_subinterface_interface failed");
593   return 0;
594 }
595
596 /* *INDENT-OFF* */
597 VLIB_CLI_COMMAND (delete_simulated_ethernet_interface_command, static) = {
598   .path = "loopback delete-interface",
599   .short_help = "Delete Loopback ethernet interface intfc <interface>",
600   .function = delete_simulated_ethernet_interfaces,
601 };
602 /* *INDENT-ON* */
603
604 /* *INDENT-OFF* */
605 VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = {
606   .path = "delete loopback interface",
607   .short_help = "delete loopback interface intfc <interface>",
608   .function = delete_simulated_ethernet_interfaces,
609 };
610 /* *INDENT-ON* */
611
612 /* *INDENT-OFF* */
613 VLIB_CLI_COMMAND (delete_sub_interface_command, static) = {
614   .path = "delete sub-interface",
615   .short_help = "delete sub-interface <interface>",
616   .function = delete_sub_interface,
617 };
618 /* *INDENT-ON* */
619
620 /*
621  * fd.io coding-style-patch-verification: ON
622  *
623  * Local Variables:
624  * eval: (c-set-style "gnu")
625  * End:
626  */