MTU: Software interface / Per-protocol MTU support
[vpp.git] / src / 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 #include <vnet/adj/adj.h>
46
47 /**
48  * @file
49  * @brief Loopback Interfaces.
50  *
51  * This file contains code to manage loopback interfaces.
52  */
53
54 const u8 *
55 ethernet_ip4_mcast_dst_addr (void)
56 {
57   const static u8 ethernet_mcast_dst_mac[] = {
58     0x1, 0x0, 0x5e, 0x0, 0x0, 0x0,
59   };
60
61   return (ethernet_mcast_dst_mac);
62 }
63
64 const u8 *
65 ethernet_ip6_mcast_dst_addr (void)
66 {
67   const static u8 ethernet_mcast_dst_mac[] = {
68     0x33, 0x33, 0x00, 0x0, 0x0, 0x0,
69   };
70
71   return (ethernet_mcast_dst_mac);
72 }
73
74 /**
75  * @brief build a rewrite string to use for sending packets of type 'link_type'
76  * to 'dst_address'
77  */
78 u8 *
79 ethernet_build_rewrite (vnet_main_t * vnm,
80                         u32 sw_if_index,
81                         vnet_link_t link_type, const void *dst_address)
82 {
83   vnet_sw_interface_t *sub_sw = vnet_get_sw_interface (vnm, sw_if_index);
84   vnet_sw_interface_t *sup_sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
85   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
86   ethernet_main_t *em = &ethernet_main;
87   ethernet_interface_t *ei;
88   ethernet_header_t *h;
89   ethernet_type_t type;
90   uword n_bytes = sizeof (h[0]);
91   u8 *rewrite = NULL;
92   u8 is_p2p = 0;
93
94   if (sub_sw->type == VNET_SW_INTERFACE_TYPE_P2P)
95     is_p2p = 1;
96   if (sub_sw != sup_sw)
97     {
98       if (sub_sw->sub.eth.flags.one_tag)
99         {
100           n_bytes += sizeof (ethernet_vlan_header_t);
101         }
102       else if (sub_sw->sub.eth.flags.two_tags)
103         {
104           n_bytes += 2 * (sizeof (ethernet_vlan_header_t));
105         }
106       else if (PREDICT_FALSE (is_p2p))
107         {
108           n_bytes = sizeof (ethernet_header_t);
109         }
110       if (PREDICT_FALSE (!is_p2p))
111         {
112           // Check for encaps that are not supported for L3 interfaces
113           if (!(sub_sw->sub.eth.flags.exact_match) ||
114               (sub_sw->sub.eth.flags.default_sub) ||
115               (sub_sw->sub.eth.flags.outer_vlan_id_any) ||
116               (sub_sw->sub.eth.flags.inner_vlan_id_any))
117             {
118               return 0;
119             }
120         }
121       else
122         {
123           n_bytes = sizeof (ethernet_header_t);
124         }
125     }
126
127   switch (link_type)
128     {
129 #define _(a,b) case VNET_LINK_##a: type = ETHERNET_TYPE_##b; break
130       _(IP4, IP4);
131       _(IP6, IP6);
132       _(MPLS, MPLS);
133       _(ARP, ARP);
134 #undef _
135     default:
136       return NULL;
137     }
138
139   vec_validate (rewrite, n_bytes - 1);
140   h = (ethernet_header_t *) rewrite;
141   ei = pool_elt_at_index (em->interfaces, hw->hw_instance);
142   clib_memcpy (h->src_address, ei->address, sizeof (h->src_address));
143   if (is_p2p)
144     {
145       clib_memcpy (h->dst_address, sub_sw->p2p.client_mac,
146                    sizeof (h->dst_address));
147     }
148   else
149     {
150       if (dst_address)
151         clib_memcpy (h->dst_address, dst_address, sizeof (h->dst_address));
152       else
153         memset (h->dst_address, ~0, sizeof (h->dst_address));   /* broadcast */
154     }
155
156   if (PREDICT_FALSE (!is_p2p) && sub_sw->sub.eth.flags.one_tag)
157     {
158       ethernet_vlan_header_t *outer = (void *) (h + 1);
159
160       h->type = sub_sw->sub.eth.flags.dot1ad ?
161         clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
162         clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
163       outer->priority_cfi_and_id =
164         clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
165       outer->type = clib_host_to_net_u16 (type);
166
167     }
168   else if (PREDICT_FALSE (!is_p2p) && sub_sw->sub.eth.flags.two_tags)
169     {
170       ethernet_vlan_header_t *outer = (void *) (h + 1);
171       ethernet_vlan_header_t *inner = (void *) (outer + 1);
172
173       h->type = sub_sw->sub.eth.flags.dot1ad ?
174         clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
175         clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
176       outer->priority_cfi_and_id =
177         clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
178       outer->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
179       inner->priority_cfi_and_id =
180         clib_host_to_net_u16 (sub_sw->sub.eth.inner_vlan_id);
181       inner->type = clib_host_to_net_u16 (type);
182
183     }
184   else
185     {
186       h->type = clib_host_to_net_u16 (type);
187     }
188
189   return (rewrite);
190 }
191
192 void
193 ethernet_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
194 {
195   ip_adjacency_t *adj;
196
197   adj = adj_get (ai);
198
199   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
200   if (si->type == VNET_SW_INTERFACE_TYPE_P2P)
201     {
202       default_update_adjacency (vnm, sw_if_index, ai);
203     }
204   else if (FIB_PROTOCOL_IP4 == adj->ia_nh_proto)
205     {
206       arp_update_adjacency (vnm, sw_if_index, ai);
207     }
208   else if (FIB_PROTOCOL_IP6 == adj->ia_nh_proto)
209     {
210       ip6_ethernet_update_adjacency (vnm, sw_if_index, ai);
211     }
212   else
213     {
214       ASSERT (0);
215     }
216 }
217
218 static clib_error_t *
219 ethernet_mac_change (vnet_hw_interface_t * hi, char *mac_address)
220 {
221   ethernet_interface_t *ei;
222   ethernet_main_t *em;
223
224   em = &ethernet_main;
225   ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
226
227   vec_validate (hi->hw_address,
228                 STRUCT_SIZE_OF (ethernet_header_t, src_address) - 1);
229   clib_memcpy (hi->hw_address, mac_address, vec_len (hi->hw_address));
230
231   clib_memcpy (ei->address, (u8 *) mac_address, sizeof (ei->address));
232   ethernet_arp_change_mac (hi->sw_if_index);
233   ethernet_ndp_change_mac (hi->sw_if_index);
234
235   return (NULL);
236 }
237
238 /* *INDENT-OFF* */
239 VNET_HW_INTERFACE_CLASS (ethernet_hw_interface_class) = {
240   .name = "Ethernet",
241   .format_address = format_ethernet_address,
242   .format_header = format_ethernet_header_with_length,
243   .unformat_hw_address = unformat_ethernet_address,
244   .unformat_header = unformat_ethernet_header,
245   .build_rewrite = ethernet_build_rewrite,
246   .update_adjacency = ethernet_update_adjacency,
247   .mac_addr_change_function = ethernet_mac_change,
248 };
249 /* *INDENT-ON* */
250
251 uword
252 unformat_ethernet_interface (unformat_input_t * input, va_list * args)
253 {
254   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
255   u32 *result = va_arg (*args, u32 *);
256   u32 hw_if_index;
257   ethernet_main_t *em = &ethernet_main;
258   ethernet_interface_t *eif;
259
260   if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
261     return 0;
262
263   eif = ethernet_get_interface (em, hw_if_index);
264   if (eif)
265     {
266       *result = hw_if_index;
267       return 1;
268     }
269   return 0;
270 }
271
272 clib_error_t *
273 ethernet_register_interface (vnet_main_t * vnm,
274                              u32 dev_class_index,
275                              u32 dev_instance,
276                              u8 * address,
277                              u32 * hw_if_index_return,
278                              ethernet_flag_change_function_t flag_change)
279 {
280   ethernet_main_t *em = &ethernet_main;
281   ethernet_interface_t *ei;
282   vnet_hw_interface_t *hi;
283   clib_error_t *error = 0;
284   u32 hw_if_index;
285
286   pool_get (em->interfaces, ei);
287   ei->flag_change = flag_change;
288
289   hw_if_index = vnet_register_interface
290     (vnm,
291      dev_class_index, dev_instance,
292      ethernet_hw_interface_class.index, ei - em->interfaces);
293   *hw_if_index_return = hw_if_index;
294
295   hi = vnet_get_hw_interface (vnm, hw_if_index);
296
297   ethernet_setup_node (vnm->vlib_main, hi->output_node_index);
298
299   hi->min_packet_bytes = hi->min_supported_packet_bytes =
300     ETHERNET_MIN_PACKET_BYTES;
301   hi->max_packet_bytes = hi->max_supported_packet_bytes =
302     ETHERNET_MAX_PACKET_BYTES;
303
304   /* Standard default ethernet MTU. */
305   vnet_sw_interface_set_mtu (vnm, hi->sw_if_index, 9000);
306
307   clib_memcpy (ei->address, address, sizeof (ei->address));
308   vec_add (hi->hw_address, address, sizeof (ei->address));
309
310   if (error)
311     {
312       pool_put (em->interfaces, ei);
313       return error;
314     }
315   return error;
316 }
317
318 void
319 ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index)
320 {
321   ethernet_main_t *em = &ethernet_main;
322   ethernet_interface_t *ei;
323   vnet_hw_interface_t *hi;
324   main_intf_t *main_intf;
325   vlan_table_t *vlan_table;
326   u32 idx;
327
328   hi = vnet_get_hw_interface (vnm, hw_if_index);
329   ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
330
331   /* Delete vlan mapping table for dot1q and dot1ad. */
332   main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
333   if (main_intf->dot1q_vlans)
334     {
335       vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
336       for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
337         {
338           if (vlan_table->vlans[idx].qinqs)
339             {
340               pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
341             }
342         }
343       pool_put_index (em->vlan_pool, main_intf->dot1q_vlans);
344       main_intf->dot1q_vlans = 0;
345     }
346   if (main_intf->dot1ad_vlans)
347     {
348       vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
349       for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
350         {
351           if (vlan_table->vlans[idx].qinqs)
352             {
353               pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
354             }
355         }
356       pool_put_index (em->vlan_pool, main_intf->dot1ad_vlans);
357       main_intf->dot1ad_vlans = 0;
358     }
359
360   vnet_delete_hw_interface (vnm, hw_if_index);
361   pool_put (em->interfaces, ei);
362 }
363
364 u32
365 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
366 {
367   ethernet_main_t *em = &ethernet_main;
368   vnet_hw_interface_t *hi;
369   ethernet_interface_t *ei;
370
371   hi = vnet_get_hw_interface (vnm, hw_if_index);
372
373   ASSERT (hi->hw_class_index == ethernet_hw_interface_class.index);
374
375   ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
376   if (ei->flag_change)
377     return ei->flag_change (vnm, hi, flags);
378   return (u32) ~ 0;
379 }
380
381 /* Echo packets back to ethernet/l2-input. */
382 static uword
383 simulated_ethernet_interface_tx (vlib_main_t * vm,
384                                  vlib_node_runtime_t * node,
385                                  vlib_frame_t * frame)
386 {
387   u32 n_left_from, n_left_to_next, n_copy, *from, *to_next;
388   u32 next_index = VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT;
389   u32 i, next_node_index, bvi_flag, sw_if_index;
390   u32 n_pkts = 0, n_bytes = 0;
391   u32 thread_index = vm->thread_index;
392   vnet_main_t *vnm = vnet_get_main ();
393   vnet_interface_main_t *im = &vnm->interface_main;
394   vlib_node_main_t *nm = &vm->node_main;
395   vlib_node_t *loop_node;
396   vlib_buffer_t *b;
397
398   // check tx node index, it is ethernet-input on loopback create
399   // but can be changed to l2-input if loopback is configured as
400   // BVI of a BD (Bridge Domain).
401   loop_node = vec_elt (nm->nodes, node->node_index);
402   next_node_index = loop_node->next_nodes[next_index];
403   bvi_flag = (next_node_index == l2input_node.index) ? 1 : 0;
404
405   n_left_from = frame->n_vectors;
406   from = vlib_frame_args (frame);
407
408   while (n_left_from > 0)
409     {
410       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
411
412       n_copy = clib_min (n_left_from, n_left_to_next);
413
414       clib_memcpy (to_next, from, n_copy * sizeof (from[0]));
415       n_left_to_next -= n_copy;
416       n_left_from -= n_copy;
417       i = 0;
418       b = vlib_get_buffer (vm, from[i]);
419       sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
420       while (1)
421         {
422           // Set up RX and TX indices as if received from a real driver
423           // unless loopback is used as a BVI. For BVI case, leave TX index
424           // and update l2_len in packet as required for l2 forwarding path
425           vnet_buffer (b)->sw_if_index[VLIB_RX] = sw_if_index;
426           if (bvi_flag)
427             {
428               vnet_update_l2_len (b);
429               vnet_buffer (b)->sw_if_index[VLIB_TX] = L2INPUT_BVI;
430             }
431           else
432             vnet_buffer (b)->sw_if_index[VLIB_TX] = (u32) ~ 0;
433
434           i++;
435           n_pkts++;
436           n_bytes += vlib_buffer_length_in_chain (vm, b);
437
438           if (i < n_copy)
439             b = vlib_get_buffer (vm, from[i]);
440           else
441             break;
442         }
443       from += n_copy;
444
445       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
446
447       /* increment TX interface stat */
448       vlib_increment_combined_counter (im->combined_sw_if_counters +
449                                        VNET_INTERFACE_COUNTER_TX,
450                                        thread_index, sw_if_index, n_pkts,
451                                        n_bytes);
452     }
453
454   return n_left_from;
455 }
456
457 static u8 *
458 format_simulated_ethernet_name (u8 * s, va_list * args)
459 {
460   u32 dev_instance = va_arg (*args, u32);
461   return format (s, "loop%d", dev_instance);
462 }
463
464 static clib_error_t *
465 simulated_ethernet_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
466                                   u32 flags)
467 {
468   u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
469     VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
470   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
471   return 0;
472 }
473
474 /* *INDENT-OFF* */
475 VNET_DEVICE_CLASS (ethernet_simulated_device_class) = {
476   .name = "Loopback",
477   .format_device_name = format_simulated_ethernet_name,
478   .tx_function = simulated_ethernet_interface_tx,
479   .admin_up_down_function = simulated_ethernet_admin_up_down,
480 };
481 /* *INDENT-ON* */
482
483
484 /*
485  * Maintain a bitmap of allocated loopback instance numbers.
486  */
487 #define LOOPBACK_MAX_INSTANCE           (16 * 1024)
488
489 static u32
490 loopback_instance_alloc (u8 is_specified, u32 want)
491 {
492   ethernet_main_t *em = &ethernet_main;
493
494   /*
495    * Check for dynamically allocaetd instance number.
496    */
497   if (!is_specified)
498     {
499       u32 bit;
500
501       bit = clib_bitmap_first_clear (em->bm_loopback_instances);
502       if (bit >= LOOPBACK_MAX_INSTANCE)
503         {
504           return ~0;
505         }
506       em->bm_loopback_instances = clib_bitmap_set (em->bm_loopback_instances,
507                                                    bit, 1);
508       return bit;
509     }
510
511   /*
512    * In range?
513    */
514   if (want >= LOOPBACK_MAX_INSTANCE)
515     {
516       return ~0;
517     }
518
519   /*
520    * Already in use?
521    */
522   if (clib_bitmap_get (em->bm_loopback_instances, want))
523     {
524       return ~0;
525     }
526
527   /*
528    * Grant allocation request.
529    */
530   em->bm_loopback_instances = clib_bitmap_set (em->bm_loopback_instances,
531                                                want, 1);
532
533   return want;
534 }
535
536 static int
537 loopback_instance_free (u32 instance)
538 {
539   ethernet_main_t *em = &ethernet_main;
540
541   if (instance >= LOOPBACK_MAX_INSTANCE)
542     {
543       return -1;
544     }
545
546   if (clib_bitmap_get (em->bm_loopback_instances, instance) == 0)
547     {
548       return -1;
549     }
550
551   em->bm_loopback_instances = clib_bitmap_set (em->bm_loopback_instances,
552                                                instance, 0);
553   return 0;
554 }
555
556 int
557 vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address,
558                                 u8 is_specified, u32 user_instance)
559 {
560   vnet_main_t *vnm = vnet_get_main ();
561   vlib_main_t *vm = vlib_get_main ();
562   clib_error_t *error;
563   u32 instance;
564   u8 address[6];
565   u32 hw_if_index;
566   vnet_hw_interface_t *hw_if;
567   u32 slot;
568   int rv = 0;
569
570   ASSERT (sw_if_indexp);
571
572   *sw_if_indexp = (u32) ~ 0;
573
574   memset (address, 0, sizeof (address));
575
576   /*
577    * Allocate a loopback instance.  Either select on dynamically
578    * or try to use the desired user_instance number.
579    */
580   instance = loopback_instance_alloc (is_specified, user_instance);
581   if (instance == ~0)
582     {
583       return VNET_API_ERROR_INVALID_REGISTRATION;
584     }
585
586   /*
587    * Default MAC address (dead:0000:0000 + instance) is allocated
588    * if zero mac_address is configured. Otherwise, user-configurable MAC
589    * address is programmed on the loopback interface.
590    */
591   if (memcmp (address, mac_address, sizeof (address)))
592     clib_memcpy (address, mac_address, sizeof (address));
593   else
594     {
595       address[0] = 0xde;
596       address[1] = 0xad;
597       address[5] = instance;
598     }
599
600   error = ethernet_register_interface
601     (vnm,
602      ethernet_simulated_device_class.index, instance, address, &hw_if_index,
603      /* flag change */ 0);
604
605   if (error)
606     {
607       rv = VNET_API_ERROR_INVALID_REGISTRATION;
608       clib_error_report (error);
609       return rv;
610     }
611
612   hw_if = vnet_get_hw_interface (vnm, hw_if_index);
613   slot = vlib_node_add_named_next_with_slot
614     (vm, hw_if->tx_node_index,
615      "ethernet-input", VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
616   ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
617
618   {
619     vnet_sw_interface_t *si = vnet_get_hw_sw_interface (vnm, hw_if_index);
620     *sw_if_indexp = si->sw_if_index;
621
622     /* By default don't flood to loopbacks, as packets just keep
623      * coming back ... If this loopback becomes a BVI, we'll change it */
624     si->flood_class = VNET_FLOOD_CLASS_NO_FLOOD;
625   }
626
627   return 0;
628 }
629
630 static clib_error_t *
631 create_simulated_ethernet_interfaces (vlib_main_t * vm,
632                                       unformat_input_t * input,
633                                       vlib_cli_command_t * cmd)
634 {
635   int rv;
636   u32 sw_if_index;
637   u8 mac_address[6];
638   u8 is_specified = 0;
639   u32 user_instance = 0;
640
641   memset (mac_address, 0, sizeof (mac_address));
642
643   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
644     {
645       if (unformat (input, "mac %U", unformat_ethernet_address, mac_address))
646         ;
647       if (unformat (input, "instance %d", &user_instance))
648         is_specified = 1;
649       else
650         break;
651     }
652
653   rv = vnet_create_loopback_interface (&sw_if_index, mac_address,
654                                        is_specified, user_instance);
655
656   if (rv)
657     return clib_error_return (0, "vnet_create_loopback_interface failed");
658
659   vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
660                    sw_if_index);
661   return 0;
662 }
663
664 /*?
665  * Create a loopback interface. Optionally, a MAC Address can be
666  * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
667  *
668  * @cliexpar
669  * The following two command syntaxes are equivalent:
670  * @cliexcmd{loopback create-interface [mac <mac-addr>] [instance <instance>]}
671  * @cliexcmd{create loopback interface [mac <mac-addr>] [instance <instance>]}
672  * Example of how to create a loopback interface:
673  * @cliexcmd{loopback create-interface}
674 ?*/
675 /* *INDENT-OFF* */
676 VLIB_CLI_COMMAND (create_simulated_ethernet_interface_command, static) = {
677   .path = "loopback create-interface",
678   .short_help = "loopback create-interface [mac <mac-addr>] [instance <instance>]",
679   .function = create_simulated_ethernet_interfaces,
680 };
681 /* *INDENT-ON* */
682
683 /*?
684  * Create a loopback interface. Optionally, a MAC Address can be
685  * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
686  *
687  * @cliexpar
688  * The following two command syntaxes are equivalent:
689  * @cliexcmd{loopback create-interface [mac <mac-addr>] [instance <instance>]}
690  * @cliexcmd{create loopback interface [mac <mac-addr>] [instance <instance>]}
691  * Example of how to create a loopback interface:
692  * @cliexcmd{create loopback interface}
693 ?*/
694 /* *INDENT-OFF* */
695 VLIB_CLI_COMMAND (create_loopback_interface_command, static) = {
696   .path = "create loopback interface",
697   .short_help = "create loopback interface [mac <mac-addr>] [instance <instance>]",
698   .function = create_simulated_ethernet_interfaces,
699 };
700 /* *INDENT-ON* */
701
702 ethernet_interface_t *
703 ethernet_get_interface (ethernet_main_t * em, u32 hw_if_index)
704 {
705   vnet_hw_interface_t *i =
706     vnet_get_hw_interface (vnet_get_main (), hw_if_index);
707   return (i->hw_class_index ==
708           ethernet_hw_interface_class.
709           index ? pool_elt_at_index (em->interfaces, i->hw_instance) : 0);
710 }
711
712 int
713 vnet_delete_loopback_interface (u32 sw_if_index)
714 {
715   vnet_main_t *vnm = vnet_get_main ();
716   vnet_sw_interface_t *si;
717   u32 hw_if_index;
718   vnet_hw_interface_t *hw;
719   u32 instance;
720
721   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
722     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
723
724   si = vnet_get_sw_interface (vnm, sw_if_index);
725   hw_if_index = si->hw_if_index;
726   hw = vnet_get_hw_interface (vnm, hw_if_index);
727   instance = hw->dev_instance;
728
729   if (loopback_instance_free (instance) < 0)
730     {
731       return VNET_API_ERROR_INVALID_SW_IF_INDEX;
732     }
733
734   ethernet_delete_interface (vnm, hw_if_index);
735
736   return 0;
737 }
738
739 int
740 vnet_delete_sub_interface (u32 sw_if_index)
741 {
742   vnet_main_t *vnm = vnet_get_main ();
743   vnet_sw_interface_t *si;
744   int rv = 0;
745
746   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
747     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
748
749   si = vnet_get_sw_interface (vnm, sw_if_index);
750   if (si->type == VNET_SW_INTERFACE_TYPE_SUB ||
751       si->type == VNET_SW_INTERFACE_TYPE_P2P)
752     {
753       vnet_interface_main_t *im = &vnm->interface_main;
754       vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
755       u64 sup_and_sub_key =
756         ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
757       hash_unset_mem_free (&im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
758       hash_unset (hi->sub_interface_sw_if_index_by_id, si->sub.id);
759       vnet_delete_sw_interface (vnm, sw_if_index);
760     }
761   else
762     rv = VNET_API_ERROR_INVALID_SUB_SW_IF_INDEX;
763
764   return rv;
765 }
766
767 static clib_error_t *
768 delete_simulated_ethernet_interfaces (vlib_main_t * vm,
769                                       unformat_input_t * input,
770                                       vlib_cli_command_t * cmd)
771 {
772   int rv;
773   u32 sw_if_index = ~0;
774   vnet_main_t *vnm = vnet_get_main ();
775
776   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
777     {
778       if (unformat (input, "intfc %U",
779                     unformat_vnet_sw_interface, vnm, &sw_if_index))
780         ;
781       else
782         break;
783     }
784
785   if (sw_if_index == ~0)
786     return clib_error_return (0, "interface not specified");
787
788   rv = vnet_delete_loopback_interface (sw_if_index);
789
790   if (rv)
791     return clib_error_return (0, "vnet_delete_loopback_interface failed");
792
793   return 0;
794 }
795
796 static clib_error_t *
797 delete_sub_interface (vlib_main_t * vm,
798                       unformat_input_t * input, vlib_cli_command_t * cmd)
799 {
800   int rv = 0;
801   u32 sw_if_index = ~0;
802   vnet_main_t *vnm = vnet_get_main ();
803
804   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
805     {
806       if (unformat
807           (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
808         ;
809       else
810         break;
811     }
812   if (sw_if_index == ~0)
813     return clib_error_return (0, "interface doesn't exist");
814
815   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
816     rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
817   else
818     rv = vnet_delete_sub_interface (sw_if_index);
819   if (rv)
820     return clib_error_return (0, "delete_subinterface_interface failed");
821   return 0;
822 }
823
824 /*?
825  * Delete a loopback interface.
826  *
827  * @cliexpar
828  * The following two command syntaxes are equivalent:
829  * @cliexcmd{loopback delete-interface intfc <interface>}
830  * @cliexcmd{delete loopback interface intfc <interface>}
831  * Example of how to delete a loopback interface:
832  * @cliexcmd{loopback delete-interface intfc loop0}
833 ?*/
834 /* *INDENT-OFF* */
835 VLIB_CLI_COMMAND (delete_simulated_ethernet_interface_command, static) = {
836   .path = "loopback delete-interface",
837   .short_help = "loopback delete-interface intfc <interface>",
838   .function = delete_simulated_ethernet_interfaces,
839 };
840 /* *INDENT-ON* */
841
842 /*?
843  * Delete a loopback interface.
844  *
845  * @cliexpar
846  * The following two command syntaxes are equivalent:
847  * @cliexcmd{loopback delete-interface intfc <interface>}
848  * @cliexcmd{delete loopback interface intfc <interface>}
849  * Example of how to delete a loopback interface:
850  * @cliexcmd{delete loopback interface intfc loop0}
851 ?*/
852 /* *INDENT-OFF* */
853 VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = {
854   .path = "delete loopback interface",
855   .short_help = "delete loopback interface intfc <interface>",
856   .function = delete_simulated_ethernet_interfaces,
857 };
858 /* *INDENT-ON* */
859
860 /*?
861  * Delete a sub-interface.
862  *
863  * @cliexpar
864  * Example of how to delete a sub-interface:
865  * @cliexcmd{delete sub-interface GigabitEthernet0/8/0.200}
866 ?*/
867 /* *INDENT-OFF* */
868 VLIB_CLI_COMMAND (delete_sub_interface_command, static) = {
869   .path = "delete sub-interface",
870   .short_help = "delete sub-interface <interface>",
871   .function = delete_sub_interface,
872 };
873 /* *INDENT-ON* */
874
875 /*
876  * fd.io coding-style-patch-verification: ON
877  *
878  * Local Variables:
879  * eval: (c-set-style "gnu")
880  * End:
881  */