vnet/vnet/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  * interface.c: VNET interfaces/sub-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/plugin/plugin.h>
  42
  43 #define VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE (1 << 0)
  44 #define VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE (1 << 1)
  45
  46 static clib_error_t *
  47 vnet_hw_interface_set_flags_helper (vnet_main_t * vnm, u32 hw_if_index, u32 flags,
  48                                     u32 helper_flags);
  49
  50 static clib_error_t *
  51 vnet_sw_interface_set_flags_helper (vnet_main_t * vnm, u32 sw_if_index, u32 flags,
  52                                     u32 helper_flags);
  53
  54 static clib_error_t *
  55 vnet_hw_interface_set_class_helper (vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index, u32 redistribute);
  56
  57 typedef struct {
  58   /* Either sw or hw interface index. */
  59   u32 sw_hw_if_index;
  60
  61   /* Flags. */
  62   u32 flags;
  63 } vnet_sw_hw_interface_state_t;
  64
  65 static void serialize_vec_vnet_sw_hw_interface_state (serialize_main_t * m, va_list * va)
  66 {
  67     vnet_sw_hw_interface_state_t * s = va_arg (*va, vnet_sw_hw_interface_state_t *);
  68     u32 n = va_arg (*va, u32);
  69     u32 i;
  70     for (i = 0; i < n; i++) {
  71         serialize_integer (m, s[i].sw_hw_if_index, sizeof (s[i].sw_hw_if_index));
  72         serialize_integer (m, s[i].flags, sizeof (s[i].flags));
  73     }
  74 }
  75
  76 static void unserialize_vec_vnet_sw_hw_interface_state (serialize_main_t * m, va_list * va)
  77 {
  78     vnet_sw_hw_interface_state_t * s = va_arg (*va, vnet_sw_hw_interface_state_t *);
  79     u32 n = va_arg (*va, u32);
  80     u32 i;
  81     for (i = 0; i < n; i++) {
  82         unserialize_integer (m, &s[i].sw_hw_if_index, sizeof (s[i].sw_hw_if_index));
  83         unserialize_integer (m, &s[i].flags, sizeof (s[i].flags));
  84     }
  85 }
  86
  87 static void serialize_vnet_sw_hw_interface_set_flags (serialize_main_t * m, va_list * va)
  88 {
  89   vnet_sw_hw_interface_state_t * s = va_arg (*va, vnet_sw_hw_interface_state_t *);
  90   serialize (m, serialize_vec_vnet_sw_hw_interface_state, s, 1);
  91 }
  92
  93 static void unserialize_vnet_sw_interface_set_flags (serialize_main_t * m, va_list * va)
  94 {
  95   CLIB_UNUSED (mc_main_t * mc) = va_arg (*va, mc_main_t *);
  96   vnet_sw_hw_interface_state_t s;
  97
  98   unserialize (m, unserialize_vec_vnet_sw_hw_interface_state, &s, 1);
  99
 100   vnet_sw_interface_set_flags_helper
 101     (vnet_get_main(), s.sw_hw_if_index, s.flags,
 102      /* helper_flags no redistribution */ 0);
 103 }
 104
 105 static void unserialize_vnet_hw_interface_set_flags (serialize_main_t * m, va_list * va)
 106 {
 107   CLIB_UNUSED (mc_main_t * mc) = va_arg (*va, mc_main_t *);
 108   vnet_sw_hw_interface_state_t s;
 109
 110   unserialize (m, unserialize_vec_vnet_sw_hw_interface_state, &s, 1);
 111
 112   vnet_hw_interface_set_flags_helper
 113     (vnet_get_main(), s.sw_hw_if_index, s.flags,
 114      /* helper_flags no redistribution */ 0);
 115 }
 116
 117 MC_SERIALIZE_MSG (vnet_sw_interface_set_flags_msg, static) = {
 118   .name = "vnet_sw_interface_set_flags",
 119   .serialize = serialize_vnet_sw_hw_interface_set_flags,
 120   .unserialize = unserialize_vnet_sw_interface_set_flags,
 121 };
 122
 123 MC_SERIALIZE_MSG (vnet_hw_interface_set_flags_msg, static) = {
 124   .name = "vnet_hw_interface_set_flags",
 125   .serialize = serialize_vnet_sw_hw_interface_set_flags,
 126   .unserialize = unserialize_vnet_hw_interface_set_flags,
 127 };
 128
 129 void serialize_vnet_interface_state (serialize_main_t * m, va_list * va)
 130 {
 131   vnet_main_t * vnm = va_arg (*va, vnet_main_t *);
 132   vnet_sw_hw_interface_state_t * sts = 0, * st;
 133   vnet_sw_interface_t * sif;
 134   vnet_hw_interface_t * hif;
 135   vnet_interface_main_t * im = &vnm->interface_main;
 136
 137   /* Serialize hardware interface classes since they may have changed.
 138      Must do this before sending up/down flags. */
 139   pool_foreach (hif, im->hw_interfaces, ({
 140     vnet_hw_interface_class_t * hw_class = vnet_get_hw_interface_class (vnm, hif->hw_class_index);
 141     serialize_cstring (m, hw_class->name);
 142   }));
 143
 144   /* Send sw/hw interface state when non-zero. */
 145   pool_foreach (sif, im->sw_interfaces, ({
 146     if (sif->flags != 0)
 147       {
 148         vec_add2 (sts, st, 1);
 149         st->sw_hw_if_index = sif->sw_if_index;
 150         st->flags = sif->flags;
 151       }
 152   }));
 153
 154   vec_serialize (m, sts, serialize_vec_vnet_sw_hw_interface_state);
 155
 156   if (sts)
 157     _vec_len (sts) = 0;
 158
 159   pool_foreach (hif, im->hw_interfaces, ({
 160     if (hif->flags != 0)
 161       {
 162         vec_add2 (sts, st, 1);
 163         st->sw_hw_if_index = hif->hw_if_index;
 164         st->flags = hif->flags;
 165       }
 166   }));
 167
 168   vec_serialize (m, sts, serialize_vec_vnet_sw_hw_interface_state);
 169
 170   vec_free (sts);
 171 }
 172
 173 void unserialize_vnet_interface_state (serialize_main_t * m, va_list * va)
 174 {
 175   vnet_main_t * vnm = va_arg (*va, vnet_main_t *);
 176   vnet_sw_hw_interface_state_t * sts = 0, * st;
 177
 178   /* First set interface hardware class. */
 179   {
 180     vnet_interface_main_t * im = &vnm->interface_main;
 181     vnet_hw_interface_t * hif;
 182     char * class_name;
 183     uword * p;
 184     clib_error_t * error;
 185
 186     pool_foreach (hif, im->hw_interfaces, ({
 187       unserialize_cstring (m, &class_name);
 188       p = hash_get_mem (im->hw_interface_class_by_name, class_name);
 189       ASSERT (p != 0);
 190       error = vnet_hw_interface_set_class_helper (vnm, hif->hw_if_index, p[0], /* redistribute */ 0);
 191       if (error)
 192         clib_error_report (error);
 193       vec_free (class_name);
 194     }));
 195   }
 196
 197   vec_unserialize (m, &sts, unserialize_vec_vnet_sw_hw_interface_state);
 198   vec_foreach (st, sts)
 199     vnet_sw_interface_set_flags_helper (vnm, st->sw_hw_if_index, st->flags,
 200                                         /* no distribute */ 0);
 201   vec_free (sts);
 202
 203   vec_unserialize (m, &sts, unserialize_vec_vnet_sw_hw_interface_state);
 204   vec_foreach (st, sts)
 205     vnet_hw_interface_set_flags_helper (vnm, st->sw_hw_if_index, st->flags,
 206                                         /* no distribute */ 0);
 207   vec_free (sts);
 208 }
 209
 210 static clib_error_t *
 211 call_elf_section_interface_callbacks (vnet_main_t * vnm, u32 if_index,
 212                                       u32 flags,
 213                                       _vnet_interface_function_list_elt_t *elt)
 214 {
 215   clib_error_t * error = 0;
 216
 217   while (elt)
 218     {
 219       error = elt->fp(vnm, if_index, flags);
 220       if (error)
 221         return error;
 222       elt = elt->next_interface_function;
 223     }
 224   return error;
 225 }
 226
 227 static clib_error_t *
 228 call_hw_interface_add_del_callbacks (vnet_main_t * vnm, u32 hw_if_index, u32 is_create)
 229 {
 230   vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
 231   vnet_hw_interface_class_t * hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
 232   vnet_device_class_t * dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 233   clib_error_t * error = 0;
 234
 235   if (hw_class->interface_add_del_function
 236       && (error = hw_class->interface_add_del_function (vnm, hw_if_index, is_create)))
 237     return error;
 238
 239   if (dev_class->interface_add_del_function
 240       && (error = dev_class->interface_add_del_function (vnm, hw_if_index, is_create)))
 241     return error;
 242
 243   error = call_elf_section_interface_callbacks
 244     (vnm, hw_if_index, is_create, vnm->hw_interface_add_del_functions);
 245
 246   return error;
 247 }
 248
 249 static clib_error_t *
 250 call_sw_interface_add_del_callbacks (vnet_main_t * vnm, u32 sw_if_index, u32 is_create)
 251 {
 252   return call_elf_section_interface_callbacks
 253     (vnm, sw_if_index, is_create, vnm->sw_interface_add_del_functions);
 254 }
 255
 256 #define VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE (1 << 0)
 257 #define VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE (1 << 1)
 258
 259 static clib_error_t *
 260 vnet_hw_interface_set_flags_helper (vnet_main_t * vnm, u32 hw_if_index, u32 flags,
 261                                     u32 helper_flags)
 262 {
 263   vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
 264   vnet_hw_interface_class_t * hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
 265   vnet_device_class_t * dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 266   vlib_main_t * vm = vnm->vlib_main;
 267   u32 mask;
 268   clib_error_t * error = 0;
 269   u32 is_create = (helper_flags & VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE) != 0;
 270
 271   mask = (VNET_HW_INTERFACE_FLAG_LINK_UP | VNET_HW_INTERFACE_FLAG_DUPLEX_MASK |
 272           VNET_HW_INTERFACE_FLAG_SPEED_MASK);
 273   flags &= mask;
 274
 275   /* Call hardware interface add/del callbacks. */
 276   if (is_create)
 277     call_hw_interface_add_del_callbacks (vnm, hw_if_index, is_create);
 278
 279   /* Already in the desired state? */
 280   if (! is_create && (hi->flags & mask) == flags)
 281     goto done;
 282
 283   /* Some interface classes do not redistribute (e.g. are local). */
 284   if (! dev_class->redistribute)
 285     helper_flags &= ~ VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE;
 286
 287   if (vm->mc_main
 288       && (helper_flags & VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE))
 289     {
 290       vnet_sw_hw_interface_state_t s;
 291       s.sw_hw_if_index = hw_if_index;
 292       s.flags = flags;
 293       mc_serialize (vm->mc_main, &vnet_hw_interface_set_flags_msg, &s);
 294     }
 295
 296   if ((hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) !=
 297       (flags & VNET_HW_INTERFACE_FLAG_LINK_UP))
 298     {
 299       /* Do hardware class (e.g. ethernet). */
 300       if (hw_class->link_up_down_function
 301           && (error = hw_class->link_up_down_function (vnm, hw_if_index,
 302                                                        flags)))
 303         goto done;
 304
 305       error = call_elf_section_interface_callbacks
 306         (vnm, hw_if_index, is_create, vnm->hw_interface_link_up_down_functions);
 307
 308       if (error)
 309         goto done;
 310     }
 311
 312   hi->flags &= ~mask;
 313   hi->flags |= flags;
 314
 315  done:
 316   return error;
 317 }
 318
 319 static clib_error_t *
 320 vnet_sw_interface_set_flags_helper (vnet_main_t * vnm, u32 sw_if_index, u32 flags,
 321                                     u32 helper_flags)
 322 {
 323   vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
 324   vlib_main_t * vm = vnm->vlib_main;
 325   u32 mask;
 326   clib_error_t * error = 0;
 327   u32 is_create = (helper_flags & VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE) != 0;
 328   u32 old_flags;
 329
 330   mask = VNET_SW_INTERFACE_FLAG_ADMIN_UP | VNET_SW_INTERFACE_FLAG_PUNT;
 331   flags &= mask;
 332
 333   if (is_create)
 334     {
 335       error = call_sw_interface_add_del_callbacks (vnm, sw_if_index, is_create);
 336       if (error)
 337         goto done;
 338
 339       if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 340         {
 341           /* Notify everyone when the interface is created as admin up */
 342           error = call_elf_section_interface_callbacks (vnm, sw_if_index,
 343                       flags, vnm->sw_interface_admin_up_down_functions);
 344           if (error)
 345             goto done;
 346         }
 347     }
 348   else
 349     {
 350       vnet_sw_interface_t * si_sup = si;
 351
 352       /* Check that super interface is in correct state. */
 353       if (si->type == VNET_SW_INTERFACE_TYPE_SUB)
 354         {
 355           si_sup = vnet_get_sw_interface (vnm, si->sup_sw_if_index);
 356
 357           if (flags != (si_sup->flags & mask))
 358             {
 359               error = clib_error_return (0, "super-interface %U must be %U",
 360                                          format_vnet_sw_interface_name, vnm, si_sup,
 361                                          format_vnet_sw_interface_flags, flags);
 362               goto done;
 363             }
 364         }
 365
 366       /* Donot change state for slave link of bonded interfaces */
 367       if (si->flags & VNET_SW_INTERFACE_FLAG_BOND_SLAVE)
 368         {
 369           error = clib_error_return
 370               (0, "not allowed as %U belong to a BondEthernet interface",
 371                format_vnet_sw_interface_name, vnm, si);
 372           goto done;
 373         }
 374
 375       /* Already in the desired state? */
 376       if ((si->flags & mask) == flags)
 377         goto done;
 378
 379       /* Sub-interfaces of hardware interfaces that do no redistribute,
 380          do not redistribute themselves. */
 381       if (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
 382         {
 383           vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
 384           vnet_device_class_t * dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 385           if (! dev_class->redistribute)
 386             helper_flags &= ~ VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE;
 387         }
 388
 389       if (vm->mc_main
 390           && (helper_flags & VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE))
 391         {
 392           vnet_sw_hw_interface_state_t s;
 393           s.sw_hw_if_index = sw_if_index;
 394           s.flags = flags;
 395           mc_serialize (vm->mc_main, &vnet_sw_interface_set_flags_msg, &s);
 396         }
 397
 398       error = call_elf_section_interface_callbacks
 399         (vnm, sw_if_index, flags, vnm->sw_interface_admin_up_down_functions);
 400
 401       if (error)
 402         goto done;
 403
 404       if (si->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
 405         {
 406           vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, si->hw_if_index);
 407           vnet_hw_interface_class_t * hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
 408           vnet_device_class_t * dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 409
 410           /* save the si admin up flag */
 411           old_flags = si->flags;
 412
 413           /* update si admin up flag in advance if we are going admin down */
 414           if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
 415               si->flags &=  ~VNET_SW_INTERFACE_FLAG_ADMIN_UP;
 416
 417           if (dev_class->admin_up_down_function
 418               && (error = dev_class->admin_up_down_function(vnm,
 419                                                             si->hw_if_index,
 420                                                             flags)))
 421             {
 422               /* restore si admin up flag to it's original state on errors */
 423               si->flags =  old_flags;
 424               goto done;
 425             }
 426
 427           if (hw_class->admin_up_down_function
 428               && (error = hw_class->admin_up_down_function(vnm,
 429                                                            si->hw_if_index,
 430                                                            flags)))
 431             {
 432               /* restore si admin up flag to it's original state on errors */
 433               si->flags =  old_flags;
 434               goto done;
 435             }
 436
 437           /* Admin down implies link down. */
 438           if (! (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 439               && (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP))
 440             vnet_hw_interface_set_flags_helper (vnm, si->hw_if_index,
 441                                                 hi->flags &~ VNET_HW_INTERFACE_FLAG_LINK_UP,
 442                                                 helper_flags);
 443         }
 444     }
 445
 446   si->flags &= ~mask;
 447   si->flags |= flags;
 448
 449  done:
 450   return error;
 451 }
 452
 453 clib_error_t *
 454 vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 455 {
 456   return vnet_hw_interface_set_flags_helper
 457     (vnm, hw_if_index, flags,
 458      VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE);
 459 }
 460
 461 clib_error_t *
 462 vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
 463 {
 464   return vnet_sw_interface_set_flags_helper
 465     (vnm, sw_if_index, flags,
 466      VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE);
 467 }
 468
 469 static u32
 470 vnet_create_sw_interface_no_callbacks (vnet_main_t * vnm, vnet_sw_interface_t * template)
 471 {
 472   vnet_interface_main_t * im = &vnm->interface_main;
 473   vnet_sw_interface_t * sw;
 474   u32 sw_if_index;
 475
 476   pool_get (im->sw_interfaces, sw);
 477   sw_if_index = sw - im->sw_interfaces;
 478
 479   sw[0] = template[0];
 480
 481   sw->flags = 0;
 482   sw->sw_if_index = sw_if_index;
 483   if (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
 484     sw->sup_sw_if_index = sw->sw_if_index;
 485
 486   /* Allocate counters for this interface. */
 487   {
 488     u32 i;
 489
 490     vnet_interface_counter_lock(im);
 491
 492     for (i = 0; i < vec_len (im->sw_if_counters); i++)
 493       {
 494         vlib_validate_simple_counter (&im->sw_if_counters[i], sw_if_index);
 495         vlib_zero_simple_counter (&im->sw_if_counters[i], sw_if_index);
 496       }
 497
 498     for (i = 0; i < vec_len (im->combined_sw_if_counters); i++)
 499       {
 500         vlib_validate_combined_counter (&im->combined_sw_if_counters[i],
 501                                         sw_if_index);
 502         vlib_zero_combined_counter (&im->combined_sw_if_counters[i],
 503                                     sw_if_index);
 504       }
 505
 506     vnet_interface_counter_unlock(im);
 507   }
 508
 509   return sw_if_index;
 510 }
 511
 512 clib_error_t *
 513 vnet_create_sw_interface (vnet_main_t * vnm, vnet_sw_interface_t * template, u32 * sw_if_index)
 514 {
 515   clib_error_t * error;
 516   vnet_hw_interface_t * hi;
 517   vnet_device_class_t * dev_class;
 518
 519   hi = vnet_get_sup_hw_interface (vnm, template->sup_sw_if_index);
 520   dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 521
 522   if (template->type == VNET_SW_INTERFACE_TYPE_SUB &&
 523       dev_class->subif_add_del_function) {
 524         error = dev_class->subif_add_del_function (vnm, hi->hw_if_index,
 525                                                    (struct vnet_sw_interface_t *) template, 1);
 526         if (error)
 527           return error;
 528   }
 529
 530   *sw_if_index = vnet_create_sw_interface_no_callbacks (vnm, template);
 531   error = vnet_sw_interface_set_flags_helper
 532     (vnm, *sw_if_index, template->flags,
 533      VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
 534
 535   if (error) {
 536     // undo the work done by vnet_create_sw_interface_no_callbacks()
 537     vnet_interface_main_t * im = &vnm->interface_main;
 538     vnet_sw_interface_t * sw = pool_elt_at_index (im->sw_interfaces, *sw_if_index);
 539     pool_put (im->sw_interfaces, sw);
 540   }
 541
 542   return error;
 543 }
 544
 545 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
 546 {
 547   vnet_interface_main_t * im = &vnm->interface_main;
 548   vnet_sw_interface_t * sw = pool_elt_at_index (im->sw_interfaces, sw_if_index);
 549
 550   /* Bring down interface in case it is up. */
 551   if (sw->flags != 0)
 552     vnet_sw_interface_set_flags (vnm, sw_if_index, /* flags */ 0);
 553
 554   call_sw_interface_add_del_callbacks (vnm, sw_if_index, /* is_create */ 0);
 555
 556   pool_put (im->sw_interfaces, sw);
 557 }
 558
 559 static void setup_tx_node (vlib_main_t * vm,
 560                            u32 node_index,
 561                            vnet_device_class_t * dev_class)
 562 {
 563   vlib_node_t * n = vlib_get_node (vm, node_index);
 564
 565   n->function = dev_class->tx_function;
 566   n->format_trace = dev_class->format_tx_trace;
 567   vlib_register_errors (vm, node_index,
 568                         dev_class->tx_function_n_errors,
 569                         dev_class->tx_function_error_strings);
 570 }
 571
 572 static void setup_output_node (vlib_main_t * vm,
 573                                u32 node_index,
 574                                vnet_hw_interface_class_t * hw_class)
 575 {
 576   vlib_node_t * n = vlib_get_node (vm, node_index);
 577   n->format_buffer = hw_class->format_header;
 578   n->unformat_buffer = hw_class->unformat_header;
 579 }
 580
 581 /* Register an interface instance. */
 582 u32
 583 vnet_register_interface (vnet_main_t * vnm,
 584                          u32 dev_class_index,
 585                          u32 dev_instance,
 586                          u32 hw_class_index,
 587                          u32 hw_instance)
 588 {
 589   vnet_interface_main_t * im = &vnm->interface_main;
 590   vnet_hw_interface_t * hw;
 591   vnet_device_class_t * dev_class = vnet_get_device_class (vnm, dev_class_index);
 592   vnet_hw_interface_class_t * hw_class = vnet_get_hw_interface_class (vnm, hw_class_index);
 593   vlib_main_t * vm = vnm->vlib_main;
 594   u32 hw_index;
 595   char * tx_node_name, * output_node_name;
 596
 597   pool_get (im->hw_interfaces, hw);
 598
 599   hw_index = hw - im->hw_interfaces;
 600   hw->hw_if_index = hw_index;
 601
 602   if (dev_class->format_device_name)
 603     hw->name = format (0, "%U",
 604                        dev_class->format_device_name, dev_instance);
 605   else if (hw_class->format_interface_name)
 606     hw->name = format (0, "%U", hw_class->format_interface_name,
 607                        dev_instance);
 608   else
 609     hw->name = format (0, "%s%x", hw_class->name, dev_instance);
 610
 611   if (! im->hw_interface_by_name)
 612     im->hw_interface_by_name = hash_create_vec (/* size */ 0,
 613                                                 sizeof (hw->name[0]),
 614                                                 sizeof (uword));
 615
 616   hash_set_mem (im->hw_interface_by_name, hw->name, hw_index);
 617
 618   /* Make hardware interface point to software interface. */
 619   {
 620     vnet_sw_interface_t sw;
 621
 622     memset (&sw, 0, sizeof (sw));
 623     sw.type = VNET_SW_INTERFACE_TYPE_HARDWARE;
 624     sw.hw_if_index = hw_index;
 625     hw->sw_if_index = vnet_create_sw_interface_no_callbacks (vnm, &sw);
 626   }
 627
 628   hw->dev_class_index = dev_class_index;
 629   hw->dev_instance = dev_instance;
 630   hw->hw_class_index = hw_class_index;
 631   hw->hw_instance = hw_instance;
 632
 633   hw->max_rate_bits_per_sec = 0;
 634   hw->min_packet_bytes = 0;
 635   hw->per_packet_overhead_bytes = 0;
 636   hw->max_l3_packet_bytes[VLIB_RX] = ~0;
 637   hw->max_l3_packet_bytes[VLIB_TX] = ~0;
 638
 639   tx_node_name = (char *) format (0, "%v-tx", hw->name);
 640   output_node_name = (char *) format (0, "%v-output", hw->name);
 641
 642   /* If we have previously deleted interface nodes, re-use them. */
 643   if (vec_len (im->deleted_hw_interface_nodes) > 0)
 644     {
 645       vnet_hw_interface_nodes_t * hn;
 646       vnet_interface_output_runtime_t * rt;
 647
 648       hn = vec_end (im->deleted_hw_interface_nodes) - 1;
 649
 650       hw->tx_node_index = hn->tx_node_index;
 651       hw->output_node_index = hn->output_node_index;
 652
 653       vlib_node_rename (vm, hw->tx_node_index, "%v", tx_node_name);
 654       vlib_node_rename (vm, hw->output_node_index, "%v", output_node_name);
 655
 656       rt = vlib_node_get_runtime_data (vm, hw->output_node_index);
 657       ASSERT (rt->is_deleted == 1);
 658       rt->is_deleted = 0;
 659       rt->hw_if_index = hw_index;
 660       rt->sw_if_index = hw->sw_if_index;
 661       rt->dev_instance = hw->dev_instance;
 662
 663       rt = vlib_node_get_runtime_data (vm, hw->tx_node_index);
 664       rt->hw_if_index = hw_index;
 665       rt->sw_if_index = hw->sw_if_index;
 666       rt->dev_instance = hw->dev_instance;
 667
 668       vlib_worker_thread_node_runtime_update();
 669       _vec_len (im->deleted_hw_interface_nodes) -= 1;
 670     }
 671   else
 672     {
 673       vlib_node_registration_t r;
 674       vnet_interface_output_runtime_t rt = {
 675         .hw_if_index = hw_index,
 676         .sw_if_index = hw->sw_if_index,
 677         .dev_instance = hw->dev_instance,
 678         .is_deleted = 0,
 679       };
 680
 681       memset (&r, 0, sizeof (r));
 682       r.type = VLIB_NODE_TYPE_INTERNAL;
 683       r.runtime_data = &rt;
 684       r.runtime_data_bytes = sizeof (rt);
 685       r.scalar_size = 0;
 686       r.vector_size = sizeof (u32);
 687
 688       r.flags = VLIB_NODE_FLAG_IS_OUTPUT;
 689       r.name = tx_node_name;
 690       r.function = dev_class->tx_function;
 691
 692       hw->tx_node_index = vlib_register_node (vm, &r);
 693
 694       vlib_node_add_named_next_with_slot (vm, hw->tx_node_index,
 695                                           "error-drop",
 696                                           VNET_INTERFACE_TX_NEXT_DROP);
 697
 698       r.flags = 0;
 699       r.name = output_node_name;
 700       r.function =  dev_class->no_flatten_output_chains ?
 701           vnet_interface_output_node_no_flatten_multiarch_select() :
 702           vnet_interface_output_node_multiarch_select() ;
 703       r.format_trace = format_vnet_interface_output_trace;
 704
 705       {
 706         static char * e[] = {
 707           "interface is down",
 708           "interface is deleted",
 709         };
 710
 711         r.n_errors = ARRAY_LEN (e);
 712         r.error_strings = e;
 713       }
 714
 715       hw->output_node_index = vlib_register_node (vm, &r);
 716
 717 #define _(sym,str) vlib_node_add_named_next_with_slot (vm, \
 718                      hw->output_node_index, str,           \
 719                      VNET_INTERFACE_OUTPUT_NEXT_##sym);
 720       foreach_intf_output_feat
 721 #undef _
 722
 723       vlib_node_add_named_next_with_slot (vm, hw->output_node_index,
 724                                           "error-drop",
 725                                           VNET_INTERFACE_OUTPUT_NEXT_DROP);
 726       vlib_node_add_next_with_slot (vm, hw->output_node_index,
 727                                     hw->tx_node_index,
 728                                     VNET_INTERFACE_OUTPUT_NEXT_TX);
 729     }
 730
 731   setup_output_node (vm, hw->output_node_index, hw_class);
 732   setup_tx_node (vm, hw->tx_node_index, dev_class);
 733
 734   /* Call all up/down callbacks with zero flags when interface is created. */
 735   vnet_sw_interface_set_flags_helper
 736     (vnm, hw->sw_if_index, /* flags */ 0,
 737      VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
 738   vnet_hw_interface_set_flags_helper
 739     (vnm, hw_index, /* flags */ 0,
 740      VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
 741
 742   return hw_index;
 743 }
 744
 745 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index)
 746 {
 747   vnet_interface_main_t * im = &vnm->interface_main;
 748   vnet_hw_interface_t * hw = vnet_get_hw_interface (vnm, hw_if_index);
 749   vlib_main_t * vm = vnm->vlib_main;
 750
 751   /* If it is up, mark it down. */
 752   if (hw->flags != 0)
 753     vnet_hw_interface_set_flags (vnm, hw_if_index, /* flags */ 0);
 754
 755   /* Call delete callbacks. */
 756   call_hw_interface_add_del_callbacks (vnm, hw_if_index, /* is_create */ 0);
 757
 758   /* Delete software interface corresponding to hardware interface. */
 759   vnet_delete_sw_interface (vnm, hw->sw_if_index);
 760
 761   /* Delete any sub-interfaces. */
 762   {
 763     u32 id, sw_if_index;
 764     hash_foreach (id, sw_if_index, hw->sub_interface_sw_if_index_by_id, ({
 765       vnet_delete_sw_interface (vnm, sw_if_index);
 766     }));
 767   }
 768
 769   {
 770     vnet_hw_interface_nodes_t * dn;
 771     vnet_interface_output_runtime_t * rt = vlib_node_get_runtime_data (vm, hw->output_node_index);
 772
 773     /* Mark node runtime as deleted so output node (if called) will drop packets. */
 774     rt->is_deleted = 1;
 775
 776     vlib_node_rename (vm, hw->output_node_index, "interface-%d-output-deleted", hw_if_index);
 777     vlib_node_rename (vm, hw->tx_node_index, "interface-%d-tx-deleted", hw_if_index);
 778     vec_add2 (im->deleted_hw_interface_nodes, dn, 1);
 779     dn->tx_node_index = hw->tx_node_index;
 780     dn->output_node_index = hw->output_node_index;
 781   }
 782
 783   hash_unset_mem (im->hw_interface_by_name, hw->name);
 784   vec_free (hw->name);
 785
 786   pool_put (im->hw_interfaces, hw);
 787 }
 788
 789 static void serialize_vnet_hw_interface_set_class (serialize_main_t * m, va_list * va)
 790 {
 791   u32 hw_if_index = va_arg (*va, u32);
 792   char * hw_class_name = va_arg (*va, char *);
 793   serialize_integer (m, hw_if_index, sizeof (hw_if_index));
 794   serialize_cstring (m, hw_class_name);
 795 }
 796
 797 static void unserialize_vnet_hw_interface_set_class (serialize_main_t * m, va_list * va)
 798 {
 799   CLIB_UNUSED (mc_main_t * mc) = va_arg (*va, mc_main_t *);
 800   vnet_main_t * vnm = vnet_get_main();
 801   u32 hw_if_index;
 802   char * hw_class_name;
 803   uword * p;
 804   clib_error_t * error;
 805
 806   unserialize_integer (m, &hw_if_index, sizeof (hw_if_index));
 807   unserialize_cstring (m, &hw_class_name);
 808   p = hash_get (vnm->interface_main.hw_interface_class_by_name, hw_class_name);
 809   ASSERT (p != 0);
 810   error = vnet_hw_interface_set_class_helper (vnm, hw_if_index, p[0], /* redistribute */ 0);
 811   if (error)
 812     clib_error_report (error);
 813 }
 814
 815 MC_SERIALIZE_MSG (vnet_hw_interface_set_class_msg, static) = {
 816   .name = "vnet_hw_interface_set_class",
 817   .serialize = serialize_vnet_hw_interface_set_class,
 818   .unserialize = unserialize_vnet_hw_interface_set_class,
 819 };
 820
 821 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index, u32 hw_instance)
 822 {
 823   vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
 824   vnet_hw_interface_class_t * hc = vnet_get_hw_interface_class (vnm, hw_class_index);
 825
 826   hi->hw_class_index = hw_class_index;
 827   hi->hw_instance = hw_instance;
 828   setup_output_node (vnm->vlib_main, hi->output_node_index, hc);
 829 }
 830
 831 static clib_error_t *
 832 vnet_hw_interface_set_class_helper (vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index, u32 redistribute)
 833 {
 834   vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
 835   vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, hi->sw_if_index);
 836   vnet_hw_interface_class_t * old_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
 837   vnet_hw_interface_class_t * new_class = vnet_get_hw_interface_class (vnm, hw_class_index);
 838   vnet_device_class_t * dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 839   clib_error_t * error = 0;
 840
 841   /* New class equals old class?  Nothing to do. */
 842   if (hi->hw_class_index == hw_class_index)
 843     return 0;
 844
 845   /* No need (and incorrect since admin up flag may be set) to do error checking when
 846      receiving unserialize message. */
 847   if (redistribute)
 848     {
 849       if (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 850         return clib_error_return (0, "%v must be admin down to change class from %s to %s",
 851                                   hi->name, old_class->name, new_class->name);
 852
 853       /* Make sure interface supports given class. */
 854       if ((new_class->is_valid_class_for_interface
 855            && ! new_class->is_valid_class_for_interface (vnm, hw_if_index, hw_class_index))
 856           || (dev_class ->is_valid_class_for_interface
 857               && ! dev_class->is_valid_class_for_interface (vnm, hw_if_index, hw_class_index)))
 858         return clib_error_return (0, "%v class cannot be changed from %s to %s",
 859                                   hi->name, old_class->name, new_class->name);
 860
 861       if (vnm->vlib_main->mc_main)
 862         {
 863           mc_serialize (vnm->vlib_main->mc_main, &vnet_hw_interface_set_class_msg, hw_if_index, new_class->name);
 864           return 0;
 865         }
 866     }
 867
 868   if (old_class->hw_class_change)
 869     old_class->hw_class_change (vnm, hw_if_index, old_class->index, new_class->index);
 870
 871   vnet_hw_interface_init_for_class (vnm, hw_if_index, new_class->index, /* instance */ ~0);
 872
 873   if (new_class->hw_class_change)
 874     new_class->hw_class_change (vnm, hw_if_index, old_class->index, new_class->index);
 875
 876   if (dev_class->hw_class_change)
 877     dev_class->hw_class_change (vnm, hw_if_index, new_class->index);
 878
 879   return error;
 880 }
 881
 882 clib_error_t *
 883 vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index)
 884 { return vnet_hw_interface_set_class_helper (vnm, hw_if_index, hw_class_index, /* redistribute */ 1); }
 885
 886 static int
 887 vnet_hw_interface_rx_redirect_to_node_helper (vnet_main_t * vnm,
 888                                               u32 hw_if_index,
 889                                               u32 node_index,
 890                                               u32 redistribute)
 891 {
 892   vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
 893   vnet_device_class_t * dev_class = vnet_get_device_class
 894     (vnm, hi->dev_class_index);
 895
 896   if (redistribute)
 897     {
 898       /* $$$$ fixme someday maybe */
 899       ASSERT(vnm->vlib_main->mc_main == 0);
 900     }
 901   if (dev_class->rx_redirect_to_node)
 902     {
 903       dev_class->rx_redirect_to_node (vnm, hw_if_index, node_index);
 904       return 0;
 905     }
 906
 907   return VNET_API_ERROR_UNIMPLEMENTED;
 908 }
 909
 910 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
 911                                        u32 node_index)
 912 { return vnet_hw_interface_rx_redirect_to_node_helper (vnm, hw_if_index,
 913                                                        node_index,
 914                                                        1 /* redistribute */); }
 915
 916 word
 917 vnet_sw_interface_compare (vnet_main_t * vnm,
 918                            uword sw_if_index0, uword sw_if_index1)
 919 {
 920   vnet_sw_interface_t * sup0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
 921   vnet_sw_interface_t * sup1 = vnet_get_sup_sw_interface (vnm, sw_if_index1);
 922   vnet_hw_interface_t * h0 = vnet_get_hw_interface (vnm, sup0->hw_if_index);
 923   vnet_hw_interface_t * h1 = vnet_get_hw_interface (vnm, sup1->hw_if_index);
 924
 925   if (h0 != h1)
 926     return vec_cmp (h0->name, h1->name);
 927   return (word) h0->hw_instance - (word) h1->hw_instance;
 928 }
 929
 930 word
 931 vnet_hw_interface_compare (vnet_main_t * vnm,
 932                            uword hw_if_index0, uword hw_if_index1)
 933 {
 934   vnet_hw_interface_t * h0 = vnet_get_hw_interface (vnm, hw_if_index0);
 935   vnet_hw_interface_t * h1 = vnet_get_hw_interface (vnm, hw_if_index1);
 936
 937   if (h0 != h1)
 938     return vec_cmp (h0->name, h1->name);
 939   return (word) h0->hw_instance - (word) h1->hw_instance;
 940 }
 941
 942 clib_error_t *
 943 vnet_interface_init (vlib_main_t * vm)
 944 {
 945   vnet_main_t * vnm = vnet_get_main();
 946   vnet_interface_main_t * im = &vnm->interface_main;
 947   vlib_buffer_t * b = 0;
 948   vnet_buffer_opaque_t * o = 0;
 949
 950   /*
 951    * Keep people from shooting themselves in the foot.
 952    */
 953   if (sizeof(b->opaque) != sizeof (vnet_buffer_opaque_t))
 954     {
 955 #define _(a) if (sizeof(o->a) > sizeof (o->unused))                     \
 956       clib_warning                                                      \
 957         ("FATAL: size of opaque union subtype %s is %d (max %d)",       \
 958          #a, sizeof(o->a), sizeof (o->unused));
 959     foreach_buffer_opaque_union_subtype;
 960 #undef _
 961
 962      return clib_error_return
 963            (0, "FATAL: size of vlib buffer opaque %d, size of vnet opaque %d",
 964            sizeof(b->opaque), sizeof (vnet_buffer_opaque_t));
 965     }
 966
 967   im->sw_if_counter_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
 968                                                    CLIB_CACHE_LINE_BYTES);
 969   im->sw_if_counter_lock[0] = 1; /* should be no need */
 970
 971   vec_validate (im->sw_if_counters,
 972                 VNET_N_SIMPLE_INTERFACE_COUNTER - 1);
 973   im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP].name = "drops";
 974   im->sw_if_counters[VNET_INTERFACE_COUNTER_PUNT].name = "punts";
 975   im->sw_if_counters[VNET_INTERFACE_COUNTER_IP4].name  = "ip4";
 976   im->sw_if_counters[VNET_INTERFACE_COUNTER_IP6].name  = "ip6";
 977   im->sw_if_counters[VNET_INTERFACE_COUNTER_RX_NO_BUF].name = "rx-no-buf";
 978   im->sw_if_counters[VNET_INTERFACE_COUNTER_RX_MISS].name = "rx-miss";
 979   im->sw_if_counters[VNET_INTERFACE_COUNTER_RX_ERROR].name = "rx-error";
 980   im->sw_if_counters[VNET_INTERFACE_COUNTER_TX_ERROR].name = "tx-error";
 981
 982   vec_validate (im->combined_sw_if_counters,
 983                 VNET_N_COMBINED_INTERFACE_COUNTER - 1);
 984   im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX].name = "rx";
 985   im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX].name = "tx";
 986
 987   im->sw_if_counter_lock[0] = 0;
 988
 989   im->device_class_by_name = hash_create_string (/* size */ 0,
 990                                                  sizeof (uword));
 991   {
 992     vnet_device_class_t * c;
 993
 994     c = vnm->device_class_registrations;
 995
 996     while (c)
 997       {
 998         c->index = vec_len (im->device_classes);
 999         hash_set_mem (im->device_class_by_name, c->name, c->index);
1000         vec_add1 (im->device_classes, c[0]);
1001         c = c->next_class_registration;
1002       }
1003   }
1004
1005   im->hw_interface_class_by_name = hash_create_string (/* size */ 0,
1006                                                        sizeof (uword));
1007
1008   im->sw_if_index_by_sup_and_sub = hash_create_mem (0, sizeof(u64),
1009                                                     sizeof (uword));
1010   {
1011     vnet_hw_interface_class_t * c;
1012
1013     c = vnm->hw_interface_class_registrations;
1014
1015     while (c)
1016       {
1017         c->index = vec_len (im->hw_interface_classes);
1018         hash_set_mem (im->hw_interface_class_by_name, c->name, c->index);
1019         vec_add1 (im->hw_interface_classes, c[0]);
1020         c = c->next_class_registration;
1021       }
1022   }
1023
1024   {
1025     clib_error_t * error;
1026
1027     if ((error = vlib_call_init_function (vm, vnet_interface_cli_init)))
1028       return error;
1029
1030     return error;
1031   }
1032 }
1033
1034 VLIB_INIT_FUNCTION (vnet_interface_init);
1035
1036 /* Kludge to renumber interface names [only!] */
1037 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance)
1038 {
1039   int rv;
1040   vnet_main_t * vnm = vnet_get_main();
1041   vnet_interface_main_t * im = &vnm->interface_main;
1042   vnet_hw_interface_t * hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
1043
1044   vnet_device_class_t * dev_class = vnet_get_device_class
1045     (vnm, hi->dev_class_index);
1046
1047   if (dev_class->name_renumber == 0 || dev_class->format_device_name == 0)
1048       return VNET_API_ERROR_UNIMPLEMENTED;
1049
1050   rv = dev_class->name_renumber (hi, new_show_dev_instance);
1051
1052   if (rv)
1053     return rv;
1054
1055   hash_unset_mem (im->hw_interface_by_name, hi->name);
1056   vec_free (hi->name);
1057   /* Use the mapping we set up to call it Ishmael */
1058   hi->name = format (0, "%U", dev_class->format_device_name,
1059                      hi->dev_instance);
1060
1061   hash_set_mem (im->hw_interface_by_name, hi->name, hi->hw_if_index);
1062   return rv;
1063 }
1064
1065 int vnet_interface_add_del_feature(vnet_main_t * vnm,
1066                                    vlib_main_t *vm,
1067                                    u32 sw_if_index,
1068                                    intf_output_feat_t feature,
1069                                    int is_add)
1070 {
1071   vnet_sw_interface_t * sw;
1072
1073   sw = vnet_get_sw_interface(vnm, sw_if_index);
1074
1075   if (is_add) {
1076
1077     sw->output_feature_bitmap |= (1 << feature);
1078     sw->output_feature_bitmap |= (1<< INTF_OUTPUT_FEAT_DONE);
1079
1080   } else { /* delete */
1081
1082     sw->output_feature_bitmap &= ~(1<<feature);
1083     if (sw->output_feature_bitmap == (1 << INTF_OUTPUT_FEAT_DONE))
1084       sw->output_feature_bitmap = 0;
1085
1086   }
1087   return 0;
1088 }
1089
1090 clib_error_t *
1091 vnet_rename_interface (vnet_main_t * vnm,
1092                        u32           hw_if_index,
1093                        char *        new_name)
1094 {
1095   vnet_interface_main_t * im = &vnm->interface_main;
1096   vlib_main_t * vm = vnm->vlib_main;
1097   vnet_hw_interface_t* hw;
1098   u8* old_name;
1099   clib_error_t * error = 0;
1100
1101   hw = vnet_get_hw_interface(vnm, hw_if_index);
1102   if (!hw)
1103     {
1104       return clib_error_return (0,
1105                                 "unable to find hw interface for index %u",
1106                                  hw_if_index);
1107     }
1108
1109   old_name = hw->name;
1110
1111   // set new hw->name
1112   hw->name = format (0, "%s", new_name);
1113
1114   // remove the old name to hw_if_index mapping and install the new one
1115   hash_unset_mem (im->hw_interface_by_name, old_name);
1116   hash_set_mem (im->hw_interface_by_name, hw->name, hw_if_index);
1117
1118   // rename tx/output nodes
1119   vlib_node_rename (vm, hw->tx_node_index, "%v-tx", hw->name);
1120   vlib_node_rename (vm, hw->output_node_index, "%v-output", hw->name);
1121
1122   // free the old name vector
1123   vec_free (old_name);
1124
1125   return error;
1126 }