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
 329   mask = VNET_SW_INTERFACE_FLAG_ADMIN_UP | VNET_SW_INTERFACE_FLAG_PUNT;
 330   flags &= mask;
 331
 332   if (is_create)
 333     {
 334       error = call_sw_interface_add_del_callbacks (vnm, sw_if_index, is_create);
 335       if (error)
 336         goto done;
 337
 338       if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 339         {
 340           /* Notify everyone when the interface is created as admin up */
 341           error = call_elf_section_interface_callbacks (vnm, sw_if_index,
 342                       flags, vnm->sw_interface_admin_up_down_functions);
 343           if (error)
 344             goto done;
 345         }
 346     }
 347   else
 348     {
 349       vnet_sw_interface_t * si_sup = si;
 350
 351       /* Check that super interface is in correct state. */
 352       if (si->type == VNET_SW_INTERFACE_TYPE_SUB)
 353         {
 354           si_sup = vnet_get_sw_interface (vnm, si->sup_sw_if_index);
 355
 356           if (flags != (si_sup->flags & mask))
 357             {
 358               error = clib_error_return (0, "super-interface %U must be %U",
 359                                          format_vnet_sw_interface_name, vnm, si_sup,
 360                                          format_vnet_sw_interface_flags, flags);
 361               goto done;
 362             }
 363         }
 364
 365       /* Already in the desired state? */
 366       if ((si->flags & mask) == flags)
 367         goto done;
 368
 369       /* Sub-interfaces of hardware interfaces that do no redistribute,
 370          do not redistribute themselves. */
 371       if (si_sup->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
 372         {
 373           vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, si_sup->hw_if_index);
 374           vnet_device_class_t * dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 375           if (! dev_class->redistribute)
 376             helper_flags &= ~ VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE;
 377         }
 378
 379       if (vm->mc_main
 380           && (helper_flags & VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE))
 381         {
 382           vnet_sw_hw_interface_state_t s;
 383           s.sw_hw_if_index = sw_if_index;
 384           s.flags = flags;
 385           mc_serialize (vm->mc_main, &vnet_sw_interface_set_flags_msg, &s);
 386         }
 387
 388       error = call_elf_section_interface_callbacks
 389         (vnm, sw_if_index, flags, vnm->sw_interface_admin_up_down_functions);
 390
 391       if (error)
 392         goto done;
 393
 394       if (si->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
 395         {
 396           vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, si->hw_if_index);
 397           vnet_hw_interface_class_t * hw_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
 398           vnet_device_class_t * dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 399
 400           if (dev_class->admin_up_down_function
 401               && (error = dev_class->admin_up_down_function (vnm, si->hw_if_index, flags)))
 402             goto done;
 403
 404           if (hw_class->admin_up_down_function
 405               && (error = hw_class->admin_up_down_function (vnm, si->hw_if_index, flags)))
 406             goto done;
 407
 408           /* Admin down implies link down. */
 409           if (! (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 410               && (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP))
 411             vnet_hw_interface_set_flags_helper (vnm, si->hw_if_index,
 412                                                 hi->flags &~ VNET_HW_INTERFACE_FLAG_LINK_UP,
 413                                                 helper_flags);
 414         }
 415     }
 416
 417   si->flags &= ~mask;
 418   si->flags |= flags;
 419
 420  done:
 421   return error;
 422 }
 423
 424 clib_error_t *
 425 vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 426 {
 427   return vnet_hw_interface_set_flags_helper
 428     (vnm, hw_if_index, flags,
 429      VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE);
 430 }
 431
 432 clib_error_t *
 433 vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
 434 {
 435   return vnet_sw_interface_set_flags_helper
 436     (vnm, sw_if_index, flags,
 437      VNET_INTERFACE_SET_FLAGS_HELPER_WANT_REDISTRIBUTE);
 438 }
 439
 440 static u32
 441 vnet_create_sw_interface_no_callbacks (vnet_main_t * vnm, vnet_sw_interface_t * template)
 442 {
 443   vnet_interface_main_t * im = &vnm->interface_main;
 444   vnet_sw_interface_t * sw;
 445   u32 sw_if_index;
 446
 447   pool_get (im->sw_interfaces, sw);
 448   sw_if_index = sw - im->sw_interfaces;
 449
 450   sw[0] = template[0];
 451
 452   sw->flags = 0;
 453   sw->sw_if_index = sw_if_index;
 454   if (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE)
 455     sw->sup_sw_if_index = sw->sw_if_index;
 456
 457   /* Allocate counters for this interface. */
 458   {
 459     u32 i;
 460
 461     vnet_interface_counter_lock(im);
 462
 463     for (i = 0; i < vec_len (im->sw_if_counters); i++)
 464       {
 465         vlib_validate_simple_counter (&im->sw_if_counters[i], sw_if_index);
 466         vlib_zero_simple_counter (&im->sw_if_counters[i], sw_if_index);
 467       }
 468
 469     for (i = 0; i < vec_len (im->combined_sw_if_counters); i++)
 470       {
 471         vlib_validate_combined_counter (&im->combined_sw_if_counters[i],
 472                                         sw_if_index);
 473         vlib_zero_combined_counter (&im->combined_sw_if_counters[i],
 474                                     sw_if_index);
 475       }
 476
 477     vnet_interface_counter_unlock(im);
 478   }
 479
 480   return sw_if_index;
 481 }
 482
 483 clib_error_t *
 484 vnet_create_sw_interface (vnet_main_t * vnm, vnet_sw_interface_t * template, u32 * sw_if_index)
 485 {
 486   clib_error_t * error;
 487   vnet_hw_interface_t * hi;
 488   vnet_device_class_t * dev_class;
 489
 490   hi = vnet_get_sup_hw_interface (vnm, template->sup_sw_if_index);
 491   dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 492
 493   if (template->type == VNET_SW_INTERFACE_TYPE_SUB &&
 494       dev_class->subif_add_del_function) {
 495         error = dev_class->subif_add_del_function (vnm, hi->hw_if_index,
 496                                                    (struct vnet_sw_interface_t *) template, 1);
 497         if (error)
 498           return error;
 499   }
 500
 501   *sw_if_index = vnet_create_sw_interface_no_callbacks (vnm, template);
 502   error = vnet_sw_interface_set_flags_helper
 503     (vnm, *sw_if_index, template->flags,
 504      VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
 505
 506   if (error) {
 507     // undo the work done by vnet_create_sw_interface_no_callbacks()
 508     vnet_interface_main_t * im = &vnm->interface_main;
 509     vnet_sw_interface_t * sw = pool_elt_at_index (im->sw_interfaces, *sw_if_index);
 510     pool_put (im->sw_interfaces, sw);
 511   }
 512
 513   return error;
 514 }
 515
 516 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
 517 {
 518   vnet_interface_main_t * im = &vnm->interface_main;
 519   vnet_sw_interface_t * sw = pool_elt_at_index (im->sw_interfaces, sw_if_index);
 520
 521   /* Bring down interface in case it is up. */
 522   if (sw->flags != 0)
 523     vnet_sw_interface_set_flags (vnm, sw_if_index, /* flags */ 0);
 524
 525   call_sw_interface_add_del_callbacks (vnm, sw_if_index, /* is_create */ 0);
 526
 527   pool_put (im->sw_interfaces, sw);
 528 }
 529
 530 static void setup_tx_node (vlib_main_t * vm,
 531                            u32 node_index,
 532                            vnet_device_class_t * dev_class)
 533 {
 534   vlib_node_t * n = vlib_get_node (vm, node_index);
 535
 536   n->function = dev_class->tx_function;
 537   n->format_trace = dev_class->format_tx_trace;
 538   vlib_register_errors (vm, node_index,
 539                         dev_class->tx_function_n_errors,
 540                         dev_class->tx_function_error_strings);
 541 }
 542
 543 static void setup_output_node (vlib_main_t * vm,
 544                                u32 node_index,
 545                                vnet_hw_interface_class_t * hw_class)
 546 {
 547   vlib_node_t * n = vlib_get_node (vm, node_index);
 548   n->format_buffer = hw_class->format_header;
 549   n->unformat_buffer = hw_class->unformat_header;
 550 }
 551
 552 /* Register an interface instance. */
 553 u32
 554 vnet_register_interface (vnet_main_t * vnm,
 555                          u32 dev_class_index,
 556                          u32 dev_instance,
 557                          u32 hw_class_index,
 558                          u32 hw_instance)
 559 {
 560   vnet_interface_main_t * im = &vnm->interface_main;
 561   vnet_hw_interface_t * hw;
 562   vnet_device_class_t * dev_class = vnet_get_device_class (vnm, dev_class_index);
 563   vnet_hw_interface_class_t * hw_class = vnet_get_hw_interface_class (vnm, hw_class_index);
 564   vlib_main_t * vm = vnm->vlib_main;
 565   u32 hw_index;
 566   char * tx_node_name, * output_node_name;
 567
 568   pool_get (im->hw_interfaces, hw);
 569
 570   hw_index = hw - im->hw_interfaces;
 571   hw->hw_if_index = hw_index;
 572
 573   if (dev_class->format_device_name)
 574     hw->name = format (0, "%U",
 575                        dev_class->format_device_name, dev_instance);
 576   else if (hw_class->format_interface_name)
 577     hw->name = format (0, "%U", hw_class->format_interface_name,
 578                        dev_instance);
 579   else
 580     hw->name = format (0, "%s%x", hw_class->name, dev_instance);
 581
 582   if (! im->hw_interface_by_name)
 583     im->hw_interface_by_name = hash_create_vec (/* size */ 0,
 584                                                 sizeof (hw->name[0]),
 585                                                 sizeof (uword));
 586
 587   hash_set_mem (im->hw_interface_by_name, hw->name, hw_index);
 588
 589   /* Make hardware interface point to software interface. */
 590   {
 591     vnet_sw_interface_t sw;
 592
 593     memset (&sw, 0, sizeof (sw));
 594     sw.type = VNET_SW_INTERFACE_TYPE_HARDWARE;
 595     sw.hw_if_index = hw_index;
 596     hw->sw_if_index = vnet_create_sw_interface_no_callbacks (vnm, &sw);
 597   }
 598
 599   hw->dev_class_index = dev_class_index;
 600   hw->dev_instance = dev_instance;
 601   hw->hw_class_index = hw_class_index;
 602   hw->hw_instance = hw_instance;
 603
 604   hw->max_rate_bits_per_sec = 0;
 605   hw->min_packet_bytes = 0;
 606   hw->per_packet_overhead_bytes = 0;
 607   hw->max_l3_packet_bytes[VLIB_RX] = ~0;
 608   hw->max_l3_packet_bytes[VLIB_TX] = ~0;
 609
 610   tx_node_name = (char *) format (0, "%v-tx", hw->name);
 611   output_node_name = (char *) format (0, "%v-output", hw->name);
 612
 613   /* If we have previously deleted interface nodes, re-use them. */
 614   if (vec_len (im->deleted_hw_interface_nodes) > 0)
 615     {
 616       vnet_hw_interface_nodes_t * hn;
 617       vnet_interface_output_runtime_t * rt;
 618
 619       hn = vec_end (im->deleted_hw_interface_nodes) - 1;
 620
 621       hw->tx_node_index = hn->tx_node_index;
 622       hw->output_node_index = hn->output_node_index;
 623
 624       vlib_node_rename (vm, hw->tx_node_index, "%v", tx_node_name);
 625       vlib_node_rename (vm, hw->output_node_index, "%v", output_node_name);
 626
 627       rt = vlib_node_get_runtime_data (vm, hw->output_node_index);
 628       ASSERT (rt->is_deleted == 1);
 629       rt->is_deleted = 0;
 630
 631       _vec_len (im->deleted_hw_interface_nodes) -= 1;
 632     }
 633   else
 634     {
 635       vlib_node_registration_t r;
 636       vnet_interface_output_runtime_t rt = {
 637         .hw_if_index = hw_index,
 638         .sw_if_index = hw->sw_if_index,
 639         .dev_instance = hw->dev_instance,
 640         .is_deleted = 0,
 641       };
 642
 643       memset (&r, 0, sizeof (r));
 644       r.type = VLIB_NODE_TYPE_INTERNAL;
 645       r.runtime_data = &rt;
 646       r.runtime_data_bytes = sizeof (rt);
 647       r.scalar_size = 0;
 648       r.vector_size = sizeof (u32);
 649
 650       r.flags = VLIB_NODE_FLAG_IS_OUTPUT;
 651       r.name = tx_node_name;
 652       r.function = dev_class->tx_function;
 653
 654       hw->tx_node_index = vlib_register_node (vm, &r);
 655
 656       vlib_node_add_named_next_with_slot (vm, hw->tx_node_index,
 657                                           "error-drop",
 658                                           VNET_INTERFACE_TX_NEXT_DROP);
 659
 660       r.flags = 0;
 661       r.name = output_node_name;
 662       r.function =  dev_class->no_flatten_output_chains ?
 663           vnet_interface_output_node_no_flatten :
 664           vnet_interface_output_node;
 665       r.format_trace = format_vnet_interface_output_trace;
 666
 667       {
 668         static char * e[] = {
 669           "interface is down",
 670           "interface is deleted",
 671         };
 672
 673         r.n_errors = ARRAY_LEN (e);
 674         r.error_strings = e;
 675       }
 676
 677       hw->output_node_index = vlib_register_node (vm, &r);
 678
 679 #define _(sym,str) vlib_node_add_named_next_with_slot (vm, \
 680                      hw->output_node_index, str,           \
 681                      VNET_INTERFACE_OUTPUT_NEXT_##sym);
 682       foreach_intf_output_feat
 683 #undef _
 684
 685       vlib_node_add_named_next_with_slot (vm, hw->output_node_index,
 686                                           "error-drop",
 687                                           VNET_INTERFACE_OUTPUT_NEXT_DROP);
 688       vlib_node_add_next_with_slot (vm, hw->output_node_index,
 689                                     hw->tx_node_index,
 690                                     VNET_INTERFACE_OUTPUT_NEXT_TX);
 691     }
 692
 693   setup_output_node (vm, hw->output_node_index, hw_class);
 694   setup_tx_node (vm, hw->tx_node_index, dev_class);
 695
 696   /* Call all up/down callbacks with zero flags when interface is created. */
 697   vnet_sw_interface_set_flags_helper
 698     (vnm, hw->sw_if_index, /* flags */ 0,
 699      VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
 700   vnet_hw_interface_set_flags_helper
 701     (vnm, hw_index, /* flags */ 0,
 702      VNET_INTERFACE_SET_FLAGS_HELPER_IS_CREATE);
 703
 704   return hw_index;
 705 }
 706
 707 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index)
 708 {
 709   vnet_interface_main_t * im = &vnm->interface_main;
 710   vnet_hw_interface_t * hw = vnet_get_hw_interface (vnm, hw_if_index);
 711   vlib_main_t * vm = vnm->vlib_main;
 712
 713   /* If it is up, mark it down. */
 714   if (hw->flags != 0)
 715     vnet_hw_interface_set_flags (vnm, hw_if_index, /* flags */ 0);
 716
 717   /* Call delete callbacks. */
 718   call_hw_interface_add_del_callbacks (vnm, hw_if_index, /* is_create */ 0);
 719
 720   /* Delete software interface corresponding to hardware interface. */
 721   vnet_delete_sw_interface (vnm, hw->sw_if_index);
 722
 723   /* Delete any sub-interfaces. */
 724   {
 725     u32 id, sw_if_index;
 726     hash_foreach (id, sw_if_index, hw->sub_interface_sw_if_index_by_id, ({
 727       vnet_delete_sw_interface (vnm, sw_if_index);
 728     }));
 729   }
 730
 731   {
 732     vnet_hw_interface_nodes_t * dn;
 733     vnet_interface_output_runtime_t * rt = vlib_node_get_runtime_data (vm, hw->output_node_index);
 734
 735     /* Mark node runtime as deleted so output node (if called) will drop packets. */
 736     rt->is_deleted = 1;
 737
 738     vlib_node_rename (vm, hw->output_node_index, "interface-%d-output-deleted", hw_if_index);
 739     vlib_node_rename (vm, hw->tx_node_index, "interface-%d-tx-deleted", hw_if_index);
 740     vec_add2 (im->deleted_hw_interface_nodes, dn, 1);
 741     dn->tx_node_index = hw->tx_node_index;
 742     dn->output_node_index = hw->output_node_index;
 743   }
 744
 745   hash_unset_mem (im->hw_interface_by_name, hw->name);
 746   vec_free (hw->name);
 747
 748   pool_put (im->hw_interfaces, hw);
 749 }
 750
 751 static void serialize_vnet_hw_interface_set_class (serialize_main_t * m, va_list * va)
 752 {
 753   u32 hw_if_index = va_arg (*va, u32);
 754   char * hw_class_name = va_arg (*va, char *);
 755   serialize_integer (m, hw_if_index, sizeof (hw_if_index));
 756   serialize_cstring (m, hw_class_name);
 757 }
 758
 759 static void unserialize_vnet_hw_interface_set_class (serialize_main_t * m, va_list * va)
 760 {
 761   CLIB_UNUSED (mc_main_t * mc) = va_arg (*va, mc_main_t *);
 762   vnet_main_t * vnm = vnet_get_main();
 763   u32 hw_if_index;
 764   char * hw_class_name;
 765   uword * p;
 766   clib_error_t * error;
 767
 768   unserialize_integer (m, &hw_if_index, sizeof (hw_if_index));
 769   unserialize_cstring (m, &hw_class_name);
 770   p = hash_get (vnm->interface_main.hw_interface_class_by_name, hw_class_name);
 771   ASSERT (p != 0);
 772   error = vnet_hw_interface_set_class_helper (vnm, hw_if_index, p[0], /* redistribute */ 0);
 773   if (error)
 774     clib_error_report (error);
 775 }
 776
 777 MC_SERIALIZE_MSG (vnet_hw_interface_set_class_msg, static) = {
 778   .name = "vnet_hw_interface_set_class",
 779   .serialize = serialize_vnet_hw_interface_set_class,
 780   .unserialize = unserialize_vnet_hw_interface_set_class,
 781 };
 782
 783 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index, u32 hw_instance)
 784 {
 785   vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
 786   vnet_hw_interface_class_t * hc = vnet_get_hw_interface_class (vnm, hw_class_index);
 787
 788   hi->hw_class_index = hw_class_index;
 789   hi->hw_instance = hw_instance;
 790   setup_output_node (vnm->vlib_main, hi->output_node_index, hc);
 791 }
 792
 793 static clib_error_t *
 794 vnet_hw_interface_set_class_helper (vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index, u32 redistribute)
 795 {
 796   vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
 797   vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, hi->sw_if_index);
 798   vnet_hw_interface_class_t * old_class = vnet_get_hw_interface_class (vnm, hi->hw_class_index);
 799   vnet_hw_interface_class_t * new_class = vnet_get_hw_interface_class (vnm, hw_class_index);
 800   vnet_device_class_t * dev_class = vnet_get_device_class (vnm, hi->dev_class_index);
 801   clib_error_t * error = 0;
 802
 803   /* New class equals old class?  Nothing to do. */
 804   if (hi->hw_class_index == hw_class_index)
 805     return 0;
 806
 807   /* No need (and incorrect since admin up flag may be set) to do error checking when
 808      receiving unserialize message. */
 809   if (redistribute)
 810     {
 811       if (si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 812         return clib_error_return (0, "%v must be admin down to change class from %s to %s",
 813                                   hi->name, old_class->name, new_class->name);
 814
 815       /* Make sure interface supports given class. */
 816       if ((new_class->is_valid_class_for_interface
 817            && ! new_class->is_valid_class_for_interface (vnm, hw_if_index, hw_class_index))
 818           || (dev_class ->is_valid_class_for_interface
 819               && ! dev_class->is_valid_class_for_interface (vnm, hw_if_index, hw_class_index)))
 820         return clib_error_return (0, "%v class cannot be changed from %s to %s",
 821                                   hi->name, old_class->name, new_class->name);
 822
 823       if (vnm->vlib_main->mc_main)
 824         {
 825           mc_serialize (vnm->vlib_main->mc_main, &vnet_hw_interface_set_class_msg, hw_if_index, new_class->name);
 826           return 0;
 827         }
 828     }
 829
 830   if (old_class->hw_class_change)
 831     old_class->hw_class_change (vnm, hw_if_index, old_class->index, new_class->index);
 832
 833   vnet_hw_interface_init_for_class (vnm, hw_if_index, new_class->index, /* instance */ ~0);
 834
 835   if (new_class->hw_class_change)
 836     new_class->hw_class_change (vnm, hw_if_index, old_class->index, new_class->index);
 837
 838   if (dev_class->hw_class_change)
 839     dev_class->hw_class_change (vnm, hw_if_index, new_class->index);
 840
 841   return error;
 842 }
 843
 844 clib_error_t *
 845 vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index)
 846 { return vnet_hw_interface_set_class_helper (vnm, hw_if_index, hw_class_index, /* redistribute */ 1); }
 847
 848 static int
 849 vnet_hw_interface_rx_redirect_to_node_helper (vnet_main_t * vnm,
 850                                               u32 hw_if_index,
 851                                               u32 node_index,
 852                                               u32 redistribute)
 853 {
 854   vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
 855   vnet_device_class_t * dev_class = vnet_get_device_class
 856     (vnm, hi->dev_class_index);
 857
 858   if (redistribute)
 859     {
 860       /* $$$$ fixme someday maybe */
 861       ASSERT(vnm->vlib_main->mc_main == 0);
 862     }
 863   if (dev_class->rx_redirect_to_node)
 864     {
 865       dev_class->rx_redirect_to_node (vnm, hw_if_index, node_index);
 866       return 0;
 867     }
 868
 869   return VNET_API_ERROR_UNIMPLEMENTED;
 870 }
 871
 872 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
 873                                        u32 node_index)
 874 { return vnet_hw_interface_rx_redirect_to_node_helper (vnm, hw_if_index,
 875                                                        node_index,
 876                                                        1 /* redistribute */); }
 877
 878 word
 879 vnet_sw_interface_compare (vnet_main_t * vnm,
 880                            uword sw_if_index0, uword sw_if_index1)
 881 {
 882   vnet_sw_interface_t * sup0 = vnet_get_sup_sw_interface (vnm, sw_if_index0);
 883   vnet_sw_interface_t * sup1 = vnet_get_sup_sw_interface (vnm, sw_if_index1);
 884   vnet_hw_interface_t * h0 = vnet_get_hw_interface (vnm, sup0->hw_if_index);
 885   vnet_hw_interface_t * h1 = vnet_get_hw_interface (vnm, sup1->hw_if_index);
 886
 887   if (h0 != h1)
 888     return vec_cmp (h0->name, h1->name);
 889   return (word) h0->hw_instance - (word) h1->hw_instance;
 890 }
 891
 892 word
 893 vnet_hw_interface_compare (vnet_main_t * vnm,
 894                            uword hw_if_index0, uword hw_if_index1)
 895 {
 896   vnet_hw_interface_t * h0 = vnet_get_hw_interface (vnm, hw_if_index0);
 897   vnet_hw_interface_t * h1 = vnet_get_hw_interface (vnm, hw_if_index1);
 898
 899   if (h0 != h1)
 900     return vec_cmp (h0->name, h1->name);
 901   return (word) h0->hw_instance - (word) h1->hw_instance;
 902 }
 903
 904 clib_error_t *
 905 vnet_interface_init (vlib_main_t * vm)
 906 {
 907   vnet_main_t * vnm = vnet_get_main();
 908   vnet_interface_main_t * im = &vnm->interface_main;
 909   vlib_buffer_t * b = 0;
 910   vnet_buffer_opaque_t * o = 0;
 911
 912   /*
 913    * Keep people from shooting themselves in the foot.
 914    */
 915   if (sizeof(b->opaque) != sizeof (vnet_buffer_opaque_t))
 916     {
 917 #define _(a) if (sizeof(o->a) > sizeof (o->unused))                     \
 918       clib_warning                                                      \
 919         ("FATAL: size of opaque union subtype %s is %d (max %d)",       \
 920          #a, sizeof(o->a), sizeof (o->unused));
 921     foreach_buffer_opaque_union_subtype;
 922 #undef _
 923
 924      return clib_error_return
 925            (0, "FATAL: size of vlib buffer opaque %d, size of vnet opaque %d",
 926            sizeof(b->opaque), sizeof (vnet_buffer_opaque_t));
 927     }
 928
 929   im->sw_if_counter_lock = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
 930                                                    CLIB_CACHE_LINE_BYTES);
 931   im->sw_if_counter_lock[0] = 1; /* should be no need */
 932
 933   vec_validate (im->sw_if_counters,
 934                 VNET_N_SIMPLE_INTERFACE_COUNTER - 1);
 935   im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP].name = "drops";
 936   im->sw_if_counters[VNET_INTERFACE_COUNTER_PUNT].name = "punts";
 937   im->sw_if_counters[VNET_INTERFACE_COUNTER_IP4].name  = "ip4";
 938   im->sw_if_counters[VNET_INTERFACE_COUNTER_IP6].name  = "ip6";
 939   im->sw_if_counters[VNET_INTERFACE_COUNTER_RX_NO_BUF].name = "rx-no-buf";
 940   im->sw_if_counters[VNET_INTERFACE_COUNTER_RX_MISS].name = "rx-miss";
 941   im->sw_if_counters[VNET_INTERFACE_COUNTER_RX_ERROR].name = "rx-error";
 942   im->sw_if_counters[VNET_INTERFACE_COUNTER_TX_ERROR].name = "tx-error";
 943
 944   vec_validate (im->combined_sw_if_counters,
 945                 VNET_N_COMBINED_INTERFACE_COUNTER - 1);
 946   im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX].name = "rx";
 947   im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX].name = "tx";
 948
 949   im->sw_if_counter_lock[0] = 0;
 950
 951   im->device_class_by_name = hash_create_string (/* size */ 0,
 952                                                  sizeof (uword));
 953   {
 954     vnet_device_class_t * c;
 955
 956     c = vnm->device_class_registrations;
 957
 958     while (c)
 959       {
 960         c->index = vec_len (im->device_classes);
 961         hash_set_mem (im->device_class_by_name, c->name, c->index);
 962         vec_add1 (im->device_classes, c[0]);
 963         c = c->next_class_registration;
 964       }
 965   }
 966
 967   im->hw_interface_class_by_name = hash_create_string (/* size */ 0,
 968                                                        sizeof (uword));
 969
 970   im->sw_if_index_by_sup_and_sub = hash_create_mem (0, sizeof(u64),
 971                                                     sizeof (uword));
 972   {
 973     vnet_hw_interface_class_t * c;
 974
 975     c = vnm->hw_interface_class_registrations;
 976
 977     while (c)
 978       {
 979         c->index = vec_len (im->hw_interface_classes);
 980         hash_set_mem (im->hw_interface_class_by_name, c->name, c->index);
 981         vec_add1 (im->hw_interface_classes, c[0]);
 982         c = c->next_class_registration;
 983       }
 984   }
 985
 986   {
 987     clib_error_t * error;
 988
 989     if ((error = vlib_call_init_function (vm, vnet_interface_cli_init)))
 990       return error;
 991
 992     return error;
 993   }
 994 }
 995
 996 VLIB_INIT_FUNCTION (vnet_interface_init);
 997
 998 /* Kludge to renumber interface names [only!] */
 999 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance)
1000 {
1001   int rv;
1002   vnet_main_t * vnm = vnet_get_main();
1003   vnet_interface_main_t * im = &vnm->interface_main;
1004   vnet_hw_interface_t * hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
1005
1006   vnet_device_class_t * dev_class = vnet_get_device_class
1007     (vnm, hi->dev_class_index);
1008
1009   if (dev_class->name_renumber == 0 || dev_class->format_device_name == 0)
1010       return VNET_API_ERROR_UNIMPLEMENTED;
1011
1012   rv = dev_class->name_renumber (hi, new_show_dev_instance);
1013
1014   if (rv)
1015     return rv;
1016
1017   hash_unset_mem (im->hw_interface_by_name, hi->name);
1018   vec_free (hi->name);
1019   /* Use the mapping we set up to call it Ishmael */
1020   hi->name = format (0, "%U", dev_class->format_device_name,
1021                      hi->dev_instance);
1022
1023   hash_set_mem (im->hw_interface_by_name, hi->name, hi->hw_if_index);
1024   return rv;
1025 }
1026
1027 int vnet_interface_add_del_feature(vnet_main_t * vnm,
1028                                    vlib_main_t *vm,
1029                                    u32 sw_if_index,
1030                                    intf_output_feat_t feature,
1031                                    int is_add)
1032 {
1033   vnet_sw_interface_t * sw;
1034
1035   sw = vnet_get_sw_interface(vnm, sw_if_index);
1036
1037   if (is_add) {
1038
1039     sw->output_feature_bitmap |= (1 << feature);
1040     sw->output_feature_bitmap |= (1<< INTF_OUTPUT_FEAT_DONE);
1041
1042   } else { /* delete */
1043
1044     sw->output_feature_bitmap &= ~(1<<feature);
1045     if (sw->output_feature_bitmap == (1 << INTF_OUTPUT_FEAT_DONE))
1046       sw->output_feature_bitmap = 0;
1047
1048   }
1049   return 0;
1050 }
1051