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