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       (sub_sw->type == VNET_SW_INTERFACE_TYPE_PIPE))
  96     is_p2p = 1;
  97   if (sub_sw != sup_sw)
  98     {
  99       if (sub_sw->sub.eth.flags.one_tag)
 100         {
 101           n_bytes += sizeof (ethernet_vlan_header_t);
 102         }
 103       else if (sub_sw->sub.eth.flags.two_tags)
 104         {
 105           n_bytes += 2 * (sizeof (ethernet_vlan_header_t));
 106         }
 107       else if (PREDICT_FALSE (is_p2p))
 108         {
 109           n_bytes = sizeof (ethernet_header_t);
 110         }
 111       if (PREDICT_FALSE (!is_p2p))
 112         {
 113           // Check for encaps that are not supported for L3 interfaces
 114           if (!(sub_sw->sub.eth.flags.exact_match) ||
 115               (sub_sw->sub.eth.flags.default_sub) ||
 116               (sub_sw->sub.eth.flags.outer_vlan_id_any) ||
 117               (sub_sw->sub.eth.flags.inner_vlan_id_any))
 118             {
 119               return 0;
 120             }
 121         }
 122       else
 123         {
 124           n_bytes = sizeof (ethernet_header_t);
 125         }
 126     }
 127
 128   switch (link_type)
 129     {
 130 #define _(a,b) case VNET_LINK_##a: type = ETHERNET_TYPE_##b; break
 131       _(IP4, IP4);
 132       _(IP6, IP6);
 133       _(MPLS, MPLS);
 134       _(ARP, ARP);
 135 #undef _
 136     default:
 137       return NULL;
 138     }
 139
 140   vec_validate (rewrite, n_bytes - 1);
 141   h = (ethernet_header_t *) rewrite;
 142   ei = pool_elt_at_index (em->interfaces, hw->hw_instance);
 143   clib_memcpy (h->src_address, ei->address, sizeof (h->src_address));
 144   if (is_p2p)
 145     {
 146       clib_memcpy (h->dst_address, sub_sw->p2p.client_mac,
 147                    sizeof (h->dst_address));
 148     }
 149   else
 150     {
 151       if (dst_address)
 152         clib_memcpy (h->dst_address, dst_address, sizeof (h->dst_address));
 153       else
 154         memset (h->dst_address, ~0, sizeof (h->dst_address));   /* broadcast */
 155     }
 156
 157   if (PREDICT_FALSE (!is_p2p) && sub_sw->sub.eth.flags.one_tag)
 158     {
 159       ethernet_vlan_header_t *outer = (void *) (h + 1);
 160
 161       h->type = sub_sw->sub.eth.flags.dot1ad ?
 162         clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
 163         clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
 164       outer->priority_cfi_and_id =
 165         clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
 166       outer->type = clib_host_to_net_u16 (type);
 167
 168     }
 169   else if (PREDICT_FALSE (!is_p2p) && sub_sw->sub.eth.flags.two_tags)
 170     {
 171       ethernet_vlan_header_t *outer = (void *) (h + 1);
 172       ethernet_vlan_header_t *inner = (void *) (outer + 1);
 173
 174       h->type = sub_sw->sub.eth.flags.dot1ad ?
 175         clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
 176         clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
 177       outer->priority_cfi_and_id =
 178         clib_host_to_net_u16 (sub_sw->sub.eth.outer_vlan_id);
 179       outer->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
 180       inner->priority_cfi_and_id =
 181         clib_host_to_net_u16 (sub_sw->sub.eth.inner_vlan_id);
 182       inner->type = clib_host_to_net_u16 (type);
 183
 184     }
 185   else
 186     {
 187       h->type = clib_host_to_net_u16 (type);
 188     }
 189
 190   return (rewrite);
 191 }
 192
 193 void
 194 ethernet_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
 195 {
 196   ip_adjacency_t *adj;
 197
 198   adj = adj_get (ai);
 199
 200   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
 201   if ((si->type == VNET_SW_INTERFACE_TYPE_P2P) ||
 202       (si->type == VNET_SW_INTERFACE_TYPE_PIPE))
 203     {
 204       default_update_adjacency (vnm, sw_if_index, ai);
 205     }
 206   else if (FIB_PROTOCOL_IP4 == adj->ia_nh_proto)
 207     {
 208       arp_update_adjacency (vnm, sw_if_index, ai);
 209     }
 210   else if (FIB_PROTOCOL_IP6 == adj->ia_nh_proto)
 211     {
 212       ip6_ethernet_update_adjacency (vnm, sw_if_index, ai);
 213     }
 214   else
 215     {
 216       ASSERT (0);
 217     }
 218 }
 219
 220 static clib_error_t *
 221 ethernet_mac_change (vnet_hw_interface_t * hi, char *mac_address)
 222 {
 223   ethernet_interface_t *ei;
 224   ethernet_main_t *em;
 225
 226   em = &ethernet_main;
 227   ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
 228
 229   vec_validate (hi->hw_address,
 230                 STRUCT_SIZE_OF (ethernet_header_t, src_address) - 1);
 231   clib_memcpy (hi->hw_address, mac_address, vec_len (hi->hw_address));
 232
 233   clib_memcpy (ei->address, (u8 *) mac_address, sizeof (ei->address));
 234   ethernet_arp_change_mac (hi->sw_if_index);
 235   ethernet_ndp_change_mac (hi->sw_if_index);
 236
 237   return (NULL);
 238 }
 239
 240 /* *INDENT-OFF* */
 241 VNET_HW_INTERFACE_CLASS (ethernet_hw_interface_class) = {
 242   .name = "Ethernet",
 243   .format_address = format_ethernet_address,
 244   .format_header = format_ethernet_header_with_length,
 245   .unformat_hw_address = unformat_ethernet_address,
 246   .unformat_header = unformat_ethernet_header,
 247   .build_rewrite = ethernet_build_rewrite,
 248   .update_adjacency = ethernet_update_adjacency,
 249   .mac_addr_change_function = ethernet_mac_change,
 250 };
 251 /* *INDENT-ON* */
 252
 253 uword
 254 unformat_ethernet_interface (unformat_input_t * input, va_list * args)
 255 {
 256   vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
 257   u32 *result = va_arg (*args, u32 *);
 258   u32 hw_if_index;
 259   ethernet_main_t *em = &ethernet_main;
 260   ethernet_interface_t *eif;
 261
 262   if (!unformat_user (input, unformat_vnet_hw_interface, vnm, &hw_if_index))
 263     return 0;
 264
 265   eif = ethernet_get_interface (em, hw_if_index);
 266   if (eif)
 267     {
 268       *result = hw_if_index;
 269       return 1;
 270     }
 271   return 0;
 272 }
 273
 274 clib_error_t *
 275 ethernet_register_interface (vnet_main_t * vnm,
 276                              u32 dev_class_index,
 277                              u32 dev_instance,
 278                              u8 * address,
 279                              u32 * hw_if_index_return,
 280                              ethernet_flag_change_function_t flag_change)
 281 {
 282   ethernet_main_t *em = &ethernet_main;
 283   ethernet_interface_t *ei;
 284   vnet_hw_interface_t *hi;
 285   clib_error_t *error = 0;
 286   u32 hw_if_index;
 287
 288   pool_get (em->interfaces, ei);
 289   ei->flag_change = flag_change;
 290
 291   hw_if_index = vnet_register_interface
 292     (vnm,
 293      dev_class_index, dev_instance,
 294      ethernet_hw_interface_class.index, ei - em->interfaces);
 295   *hw_if_index_return = hw_if_index;
 296
 297   hi = vnet_get_hw_interface (vnm, hw_if_index);
 298
 299   ethernet_setup_node (vnm->vlib_main, hi->output_node_index);
 300
 301   hi->min_packet_bytes = hi->min_supported_packet_bytes =
 302     ETHERNET_MIN_PACKET_BYTES;
 303   hi->max_packet_bytes = hi->max_supported_packet_bytes =
 304     ETHERNET_MAX_PACKET_BYTES;
 305
 306   /* Standard default ethernet MTU. */
 307   vnet_sw_interface_set_mtu (vnm, hi->sw_if_index, 9000);
 308
 309   clib_memcpy (ei->address, address, sizeof (ei->address));
 310   vec_add (hi->hw_address, address, sizeof (ei->address));
 311
 312   if (error)
 313     {
 314       pool_put (em->interfaces, ei);
 315       return error;
 316     }
 317   return error;
 318 }
 319
 320 void
 321 ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index)
 322 {
 323   ethernet_main_t *em = &ethernet_main;
 324   ethernet_interface_t *ei;
 325   vnet_hw_interface_t *hi;
 326   main_intf_t *main_intf;
 327   vlan_table_t *vlan_table;
 328   u32 idx;
 329
 330   hi = vnet_get_hw_interface (vnm, hw_if_index);
 331   ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
 332
 333   /* Delete vlan mapping table for dot1q and dot1ad. */
 334   main_intf = vec_elt_at_index (em->main_intfs, hi->hw_if_index);
 335   if (main_intf->dot1q_vlans)
 336     {
 337       vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1q_vlans);
 338       for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
 339         {
 340           if (vlan_table->vlans[idx].qinqs)
 341             {
 342               pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
 343             }
 344         }
 345       pool_put_index (em->vlan_pool, main_intf->dot1q_vlans);
 346       main_intf->dot1q_vlans = 0;
 347     }
 348   if (main_intf->dot1ad_vlans)
 349     {
 350       vlan_table = vec_elt_at_index (em->vlan_pool, main_intf->dot1ad_vlans);
 351       for (idx = 0; idx < ETHERNET_N_VLAN; idx++)
 352         {
 353           if (vlan_table->vlans[idx].qinqs)
 354             {
 355               pool_put_index (em->qinq_pool, vlan_table->vlans[idx].qinqs);
 356             }
 357         }
 358       pool_put_index (em->vlan_pool, main_intf->dot1ad_vlans);
 359       main_intf->dot1ad_vlans = 0;
 360     }
 361
 362   vnet_delete_hw_interface (vnm, hw_if_index);
 363   pool_put (em->interfaces, ei);
 364 }
 365
 366 u32
 367 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 368 {
 369   ethernet_main_t *em = &ethernet_main;
 370   vnet_hw_interface_t *hi;
 371   ethernet_interface_t *ei;
 372
 373   hi = vnet_get_hw_interface (vnm, hw_if_index);
 374
 375   ASSERT (hi->hw_class_index == ethernet_hw_interface_class.index);
 376
 377   ei = pool_elt_at_index (em->interfaces, hi->hw_instance);
 378   if (ei->flag_change)
 379     return ei->flag_change (vnm, hi, flags);
 380   return (u32) ~ 0;
 381 }
 382
 383 /**
 384  * Echo packets back to ethernet/l2-input.
 385  *
 386  * This node is "special." We know, for example, that
 387  * all of the vnet_buffer (bX)->sw_if_index[VLIB_TX] values
 388  * [had better!] match.
 389  *
 390  * Please do not copy the code first and ask questions later.
 391  *
 392  * "These are not the droids we're looking.
 393  *  You can go about your business.
 394  *  Move along..."
 395  */
 396 static uword
 397 simulated_ethernet_interface_tx (vlib_main_t * vm,
 398                                  vlib_node_runtime_t *
 399                                  node, vlib_frame_t * frame)
 400 {
 401   u32 n_left_from, n_left_to_next, *from, *to_next;
 402   u32 next_index;
 403   u32 n_bytes = 0;
 404   u32 thread_index = vm->thread_index;
 405   vnet_main_t *vnm = vnet_get_main ();
 406   vnet_interface_main_t *im = &vnm->interface_main;
 407   u32 new_tx_sw_if_index, sw_if_index_all;
 408   vlib_buffer_t *b0, *b1, *b2, *b3;
 409   u32 bi0, bi1, bi2, bi3;
 410   u32 next_all;
 411   l2_input_config_t *config;
 412
 413   n_left_from = frame->n_vectors;
 414   from = vlib_frame_args (frame);
 415
 416   /*
 417    * Work out where all of the packets are going.
 418    */
 419
 420   bi0 = from[0];
 421   b0 = vlib_get_buffer (vm, bi0);
 422   sw_if_index_all = vnet_buffer (b0)->sw_if_index[VLIB_TX];
 423
 424   /*
 425    * Look at the L2 config for the interface to decide which
 426    * graph arc to use. If the interface is bridged, send pkts
 427    * to l2-input. Otherwise, to ethernet-input
 428    */
 429   config = l2input_intf_config (sw_if_index_all);
 430   next_all =
 431     config->bridge ? VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT :
 432     VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT;
 433
 434   /*
 435    * If the interface is a BVI, set the tx sw_if_index to the
 436    * L2 path's special value.
 437    * Otherwise, set it to ~0, to be reset later by the L3 path
 438    */
 439   if (config->bvi)
 440     new_tx_sw_if_index = L2INPUT_BVI;
 441   else
 442     new_tx_sw_if_index = ~0;
 443
 444   /* Get the right next frame... */
 445   next_index = next_all;
 446
 447   /*
 448    * Use a quad-single loop, in case we have to impedance-match a
 449    * full frame into a non-empty next frame or some such.
 450    */
 451
 452   while (n_left_from > 0)
 453     {
 454       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 455
 456       while (n_left_from >= 4 && n_left_to_next >= 4)
 457         {
 458           /* Prefetch next iteration. */
 459           if (PREDICT_TRUE (n_left_from >= 8))
 460             {
 461               vlib_buffer_t *p4, *p5, *p6, *p7;
 462
 463               p4 = vlib_get_buffer (vm, from[4]);
 464               p5 = vlib_get_buffer (vm, from[5]);
 465               p6 = vlib_get_buffer (vm, from[6]);
 466               p7 = vlib_get_buffer (vm, from[7]);
 467
 468               vlib_prefetch_buffer_header (p4, STORE);
 469               vlib_prefetch_buffer_header (p5, STORE);
 470               vlib_prefetch_buffer_header (p6, STORE);
 471               vlib_prefetch_buffer_header (p7, STORE);
 472             }
 473           to_next[0] = bi0 = from[0];
 474           to_next[1] = bi1 = from[1];
 475           to_next[2] = bi2 = from[2];
 476           to_next[3] = bi3 = from[3];
 477           from += 4;
 478           to_next += 4;
 479           n_left_from -= 4;
 480           n_left_to_next -= 4;
 481
 482           b0 = vlib_get_buffer (vm, bi0);
 483           b1 = vlib_get_buffer (vm, bi1);
 484           b2 = vlib_get_buffer (vm, bi2);
 485           b3 = vlib_get_buffer (vm, bi3);
 486
 487           /* This "should never happen," of course... */
 488           if (CLIB_DEBUG > 0)
 489             {
 490               u32 cache_not_ok;
 491               u32 sw_if_index0, sw_if_index1, sw_if_index2, sw_if_index3;
 492               sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
 493               sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_TX];
 494               sw_if_index2 = vnet_buffer (b2)->sw_if_index[VLIB_TX];
 495               sw_if_index3 = vnet_buffer (b3)->sw_if_index[VLIB_TX];
 496
 497               cache_not_ok = (sw_if_index0 ^ sw_if_index1)
 498                 ^ (sw_if_index2 ^ sw_if_index3);
 499               cache_not_ok += sw_if_index0 ^ sw_if_index_all;
 500               ASSERT (cache_not_ok == 0);
 501             }
 502
 503           vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index_all;
 504           vnet_buffer (b1)->sw_if_index[VLIB_RX] = sw_if_index_all;
 505           vnet_buffer (b2)->sw_if_index[VLIB_RX] = sw_if_index_all;
 506           vnet_buffer (b3)->sw_if_index[VLIB_RX] = sw_if_index_all;
 507
 508           vnet_buffer (b0)->sw_if_index[VLIB_TX] = new_tx_sw_if_index;
 509           vnet_buffer (b1)->sw_if_index[VLIB_TX] = new_tx_sw_if_index;
 510           vnet_buffer (b2)->sw_if_index[VLIB_TX] = new_tx_sw_if_index;
 511           vnet_buffer (b3)->sw_if_index[VLIB_TX] = new_tx_sw_if_index;
 512
 513           /* Update l2 lengths if necessary */
 514           if (next_all == VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT)
 515             {
 516               vnet_update_l2_len (b0);
 517               vnet_update_l2_len (b1);
 518               vnet_update_l2_len (b2);
 519               vnet_update_l2_len (b3);
 520             }
 521
 522           /* Byte accounting */
 523           n_bytes += vlib_buffer_length_in_chain (vm, b0);
 524           n_bytes += vlib_buffer_length_in_chain (vm, b1);
 525           n_bytes += vlib_buffer_length_in_chain (vm, b2);
 526           n_bytes += vlib_buffer_length_in_chain (vm, b3);
 527
 528           /* This *should* be a noop every time... */
 529           vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
 530                                            to_next, n_left_to_next,
 531                                            bi0, bi1, bi2, bi3,
 532                                            next_all, next_all,
 533                                            next_all, next_all);
 534         }
 535
 536       while (n_left_from > 0 && n_left_to_next > 0)
 537         {
 538           bi0 = from[0];
 539           to_next[0] = bi0;
 540           from += 1;
 541           to_next += 1;
 542           n_left_from -= 1;
 543           n_left_to_next -= 1;
 544
 545           b0 = vlib_get_buffer (vm, bi0);
 546           if (CLIB_DEBUG > 0)
 547             {
 548               u32 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
 549               ASSERT (sw_if_index0 == sw_if_index_all);
 550             }
 551
 552           vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index_all;
 553           vnet_buffer (b0)->sw_if_index[VLIB_TX] = new_tx_sw_if_index;
 554           if (next_all == VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT)
 555             vnet_update_l2_len (b0);
 556
 557           n_bytes += vlib_buffer_length_in_chain (vm, b0);
 558
 559           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 560                                            to_next, n_left_to_next,
 561                                            bi0, next_all);
 562         }
 563       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 564     }
 565
 566   /* increment TX interface stat */
 567   vlib_increment_combined_counter (im->combined_sw_if_counters +
 568                                    VNET_INTERFACE_COUNTER_TX,
 569                                    thread_index, sw_if_index_all,
 570                                    frame->n_vectors, n_bytes);
 571
 572   return frame->n_vectors;
 573 }
 574
 575 static u8 *
 576 format_simulated_ethernet_name (u8 * s, va_list * args)
 577 {
 578   u32 dev_instance = va_arg (*args, u32);
 579   return format (s, "loop%d", dev_instance);
 580 }
 581
 582 static clib_error_t *
 583 simulated_ethernet_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
 584                                   u32 flags)
 585 {
 586   u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
 587     VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
 588   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
 589   return 0;
 590 }
 591
 592 /* *INDENT-OFF* */
 593 VNET_DEVICE_CLASS (ethernet_simulated_device_class) = {
 594   .name = "Loopback",
 595   .format_device_name = format_simulated_ethernet_name,
 596   .tx_function = simulated_ethernet_interface_tx,
 597   .admin_up_down_function = simulated_ethernet_admin_up_down,
 598 };
 599 /* *INDENT-ON* */
 600
 601 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (ethernet_simulated_device_class,
 602                                    simulated_ethernet_interface_tx);
 603
 604 /*
 605  * Maintain a bitmap of allocated loopback instance numbers.
 606  */
 607 #define LOOPBACK_MAX_INSTANCE           (16 * 1024)
 608
 609 static u32
 610 loopback_instance_alloc (u8 is_specified, u32 want)
 611 {
 612   ethernet_main_t *em = &ethernet_main;
 613
 614   /*
 615    * Check for dynamically allocaetd instance number.
 616    */
 617   if (!is_specified)
 618     {
 619       u32 bit;
 620
 621       bit = clib_bitmap_first_clear (em->bm_loopback_instances);
 622       if (bit >= LOOPBACK_MAX_INSTANCE)
 623         {
 624           return ~0;
 625         }
 626       em->bm_loopback_instances = clib_bitmap_set (em->bm_loopback_instances,
 627                                                    bit, 1);
 628       return bit;
 629     }
 630
 631   /*
 632    * In range?
 633    */
 634   if (want >= LOOPBACK_MAX_INSTANCE)
 635     {
 636       return ~0;
 637     }
 638
 639   /*
 640    * Already in use?
 641    */
 642   if (clib_bitmap_get (em->bm_loopback_instances, want))
 643     {
 644       return ~0;
 645     }
 646
 647   /*
 648    * Grant allocation request.
 649    */
 650   em->bm_loopback_instances = clib_bitmap_set (em->bm_loopback_instances,
 651                                                want, 1);
 652
 653   return want;
 654 }
 655
 656 static int
 657 loopback_instance_free (u32 instance)
 658 {
 659   ethernet_main_t *em = &ethernet_main;
 660
 661   if (instance >= LOOPBACK_MAX_INSTANCE)
 662     {
 663       return -1;
 664     }
 665
 666   if (clib_bitmap_get (em->bm_loopback_instances, instance) == 0)
 667     {
 668       return -1;
 669     }
 670
 671   em->bm_loopback_instances = clib_bitmap_set (em->bm_loopback_instances,
 672                                                instance, 0);
 673   return 0;
 674 }
 675
 676 int
 677 vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address,
 678                                 u8 is_specified, u32 user_instance)
 679 {
 680   vnet_main_t *vnm = vnet_get_main ();
 681   vlib_main_t *vm = vlib_get_main ();
 682   clib_error_t *error;
 683   u32 instance;
 684   u8 address[6];
 685   u32 hw_if_index;
 686   vnet_hw_interface_t *hw_if;
 687   u32 slot;
 688   int rv = 0;
 689
 690   ASSERT (sw_if_indexp);
 691
 692   *sw_if_indexp = (u32) ~ 0;
 693
 694   memset (address, 0, sizeof (address));
 695
 696   /*
 697    * Allocate a loopback instance.  Either select on dynamically
 698    * or try to use the desired user_instance number.
 699    */
 700   instance = loopback_instance_alloc (is_specified, user_instance);
 701   if (instance == ~0)
 702     {
 703       return VNET_API_ERROR_INVALID_REGISTRATION;
 704     }
 705
 706   /*
 707    * Default MAC address (dead:0000:0000 + instance) is allocated
 708    * if zero mac_address is configured. Otherwise, user-configurable MAC
 709    * address is programmed on the loopback interface.
 710    */
 711   if (memcmp (address, mac_address, sizeof (address)))
 712     clib_memcpy (address, mac_address, sizeof (address));
 713   else
 714     {
 715       address[0] = 0xde;
 716       address[1] = 0xad;
 717       address[5] = instance;
 718     }
 719
 720   error = ethernet_register_interface
 721     (vnm,
 722      ethernet_simulated_device_class.index, instance, address, &hw_if_index,
 723      /* flag change */ 0);
 724
 725   if (error)
 726     {
 727       rv = VNET_API_ERROR_INVALID_REGISTRATION;
 728       clib_error_report (error);
 729       return rv;
 730     }
 731
 732   hw_if = vnet_get_hw_interface (vnm, hw_if_index);
 733   slot = vlib_node_add_named_next_with_slot
 734     (vm, hw_if->tx_node_index,
 735      "ethernet-input", VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
 736   ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT);
 737
 738   slot = vlib_node_add_named_next_with_slot
 739     (vm, hw_if->tx_node_index,
 740      "l2-input", VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT);
 741   ASSERT (slot == VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT);
 742
 743   {
 744     vnet_sw_interface_t *si = vnet_get_hw_sw_interface (vnm, hw_if_index);
 745     *sw_if_indexp = si->sw_if_index;
 746
 747     /* By default don't flood to loopbacks, as packets just keep
 748      * coming back ... If this loopback becomes a BVI, we'll change it */
 749     si->flood_class = VNET_FLOOD_CLASS_NO_FLOOD;
 750   }
 751
 752   return 0;
 753 }
 754
 755 static clib_error_t *
 756 create_simulated_ethernet_interfaces (vlib_main_t * vm,
 757                                       unformat_input_t * input,
 758                                       vlib_cli_command_t * cmd)
 759 {
 760   int rv;
 761   u32 sw_if_index;
 762   u8 mac_address[6];
 763   u8 is_specified = 0;
 764   u32 user_instance = 0;
 765
 766   memset (mac_address, 0, sizeof (mac_address));
 767
 768   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 769     {
 770       if (unformat (input, "mac %U", unformat_ethernet_address, mac_address))
 771         ;
 772       if (unformat (input, "instance %d", &user_instance))
 773         is_specified = 1;
 774       else
 775         break;
 776     }
 777
 778   rv = vnet_create_loopback_interface (&sw_if_index, mac_address,
 779                                        is_specified, user_instance);
 780
 781   if (rv)
 782     return clib_error_return (0, "vnet_create_loopback_interface failed");
 783
 784   vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
 785                    sw_if_index);
 786   return 0;
 787 }
 788
 789 /*?
 790  * Create a loopback interface. Optionally, a MAC Address can be
 791  * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
 792  *
 793  * @cliexpar
 794  * The following two command syntaxes are equivalent:
 795  * @cliexcmd{loopback create-interface [mac <mac-addr>] [instance <instance>]}
 796  * @cliexcmd{create loopback interface [mac <mac-addr>] [instance <instance>]}
 797  * Example of how to create a loopback interface:
 798  * @cliexcmd{loopback create-interface}
 799 ?*/
 800 /* *INDENT-OFF* */
 801 VLIB_CLI_COMMAND (create_simulated_ethernet_interface_command, static) = {
 802   .path = "loopback create-interface",
 803   .short_help = "loopback create-interface [mac <mac-addr>] [instance <instance>]",
 804   .function = create_simulated_ethernet_interfaces,
 805 };
 806 /* *INDENT-ON* */
 807
 808 /*?
 809  * Create a loopback interface. Optionally, a MAC Address can be
 810  * provided. If not provided, de:ad:00:00:00:<loopId> will be used.
 811  *
 812  * @cliexpar
 813  * The following two command syntaxes are equivalent:
 814  * @cliexcmd{loopback create-interface [mac <mac-addr>] [instance <instance>]}
 815  * @cliexcmd{create loopback interface [mac <mac-addr>] [instance <instance>]}
 816  * Example of how to create a loopback interface:
 817  * @cliexcmd{create loopback interface}
 818 ?*/
 819 /* *INDENT-OFF* */
 820 VLIB_CLI_COMMAND (create_loopback_interface_command, static) = {
 821   .path = "create loopback interface",
 822   .short_help = "create loopback interface [mac <mac-addr>] [instance <instance>]",
 823   .function = create_simulated_ethernet_interfaces,
 824 };
 825 /* *INDENT-ON* */
 826
 827 ethernet_interface_t *
 828 ethernet_get_interface (ethernet_main_t * em, u32 hw_if_index)
 829 {
 830   vnet_hw_interface_t *i =
 831     vnet_get_hw_interface (vnet_get_main (), hw_if_index);
 832   return (i->hw_class_index ==
 833           ethernet_hw_interface_class.
 834           index ? pool_elt_at_index (em->interfaces, i->hw_instance) : 0);
 835 }
 836
 837 int
 838 vnet_delete_loopback_interface (u32 sw_if_index)
 839 {
 840   vnet_main_t *vnm = vnet_get_main ();
 841
 842   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
 843     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 844
 845   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 846   if (hw == 0 || hw->dev_class_index != ethernet_simulated_device_class.index)
 847     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 848
 849   if (loopback_instance_free (hw->dev_instance) < 0)
 850     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 851
 852   ethernet_delete_interface (vnm, hw->hw_if_index);
 853
 854   return 0;
 855 }
 856
 857 int
 858 vnet_delete_sub_interface (u32 sw_if_index)
 859 {
 860   vnet_main_t *vnm = vnet_get_main ();
 861   vnet_sw_interface_t *si;
 862   int rv = 0;
 863
 864   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
 865     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 866
 867   si = vnet_get_sw_interface (vnm, sw_if_index);
 868   if (si->type == VNET_SW_INTERFACE_TYPE_SUB ||
 869       si->type == VNET_SW_INTERFACE_TYPE_PIPE ||
 870       si->type == VNET_SW_INTERFACE_TYPE_P2P)
 871     {
 872       vnet_interface_main_t *im = &vnm->interface_main;
 873       vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
 874       u64 sup_and_sub_key =
 875         ((u64) (si->sup_sw_if_index) << 32) | (u64) si->sub.id;
 876       hash_unset_mem_free (&im->sw_if_index_by_sup_and_sub, &sup_and_sub_key);
 877       hash_unset (hi->sub_interface_sw_if_index_by_id, si->sub.id);
 878       vnet_delete_sw_interface (vnm, sw_if_index);
 879     }
 880   else
 881     rv = VNET_API_ERROR_INVALID_SUB_SW_IF_INDEX;
 882
 883   return rv;
 884 }
 885
 886 static clib_error_t *
 887 delete_simulated_ethernet_interfaces (vlib_main_t * vm,
 888                                       unformat_input_t * input,
 889                                       vlib_cli_command_t * cmd)
 890 {
 891   int rv;
 892   u32 sw_if_index = ~0;
 893   vnet_main_t *vnm = vnet_get_main ();
 894
 895   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 896     {
 897       if (unformat (input, "intfc %U",
 898                     unformat_vnet_sw_interface, vnm, &sw_if_index))
 899         ;
 900       else
 901         break;
 902     }
 903
 904   if (sw_if_index == ~0)
 905     return clib_error_return (0, "interface not specified");
 906
 907   rv = vnet_delete_loopback_interface (sw_if_index);
 908
 909   if (rv)
 910     return clib_error_return (0, "vnet_delete_loopback_interface failed");
 911
 912   return 0;
 913 }
 914
 915 static clib_error_t *
 916 delete_sub_interface (vlib_main_t * vm,
 917                       unformat_input_t * input, vlib_cli_command_t * cmd)
 918 {
 919   int rv = 0;
 920   u32 sw_if_index = ~0;
 921   vnet_main_t *vnm = vnet_get_main ();
 922
 923   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 924     {
 925       if (unformat
 926           (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
 927         ;
 928       else
 929         break;
 930     }
 931   if (sw_if_index == ~0)
 932     return clib_error_return (0, "interface doesn't exist");
 933
 934   if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
 935     rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
 936   else
 937     rv = vnet_delete_sub_interface (sw_if_index);
 938   if (rv)
 939     return clib_error_return (0, "delete_subinterface_interface failed");
 940   return 0;
 941 }
 942
 943 /*?
 944  * Delete a loopback interface.
 945  *
 946  * @cliexpar
 947  * The following two command syntaxes are equivalent:
 948  * @cliexcmd{loopback delete-interface intfc <interface>}
 949  * @cliexcmd{delete loopback interface intfc <interface>}
 950  * Example of how to delete a loopback interface:
 951  * @cliexcmd{loopback delete-interface intfc loop0}
 952 ?*/
 953 /* *INDENT-OFF* */
 954 VLIB_CLI_COMMAND (delete_simulated_ethernet_interface_command, static) = {
 955   .path = "loopback delete-interface",
 956   .short_help = "loopback delete-interface intfc <interface>",
 957   .function = delete_simulated_ethernet_interfaces,
 958 };
 959 /* *INDENT-ON* */
 960
 961 /*?
 962  * Delete a loopback interface.
 963  *
 964  * @cliexpar
 965  * The following two command syntaxes are equivalent:
 966  * @cliexcmd{loopback delete-interface intfc <interface>}
 967  * @cliexcmd{delete loopback interface intfc <interface>}
 968  * Example of how to delete a loopback interface:
 969  * @cliexcmd{delete loopback interface intfc loop0}
 970 ?*/
 971 /* *INDENT-OFF* */
 972 VLIB_CLI_COMMAND (delete_loopback_interface_command, static) = {
 973   .path = "delete loopback interface",
 974   .short_help = "delete loopback interface intfc <interface>",
 975   .function = delete_simulated_ethernet_interfaces,
 976 };
 977 /* *INDENT-ON* */
 978
 979 /*?
 980  * Delete a sub-interface.
 981  *
 982  * @cliexpar
 983  * Example of how to delete a sub-interface:
 984  * @cliexcmd{delete sub-interface GigabitEthernet0/8/0.200}
 985 ?*/
 986 /* *INDENT-OFF* */
 987 VLIB_CLI_COMMAND (delete_sub_interface_command, static) = {
 988   .path = "delete sub-interface",
 989   .short_help = "delete sub-interface <interface>",
 990   .function = delete_sub_interface,
 991 };
 992 /* *INDENT-ON* */
 993
 994 /*
 995  * fd.io coding-style-patch-verification: ON
 996  *
 997  * Local Variables:
 998  * eval: (c-set-style "gnu")
 999  * End:
1000  */