src/vnet/interface_funcs.h

   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_funcs.h: VNET interfaces/sub-interfaces exported functions
  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 #ifndef included_vnet_interface_funcs_h
  41 #define included_vnet_interface_funcs_h
  42
  43 always_inline vnet_hw_interface_t *
  44 vnet_get_hw_interface (vnet_main_t * vnm, u32 hw_if_index)
  45 {
  46   return pool_elt_at_index (vnm->interface_main.hw_interfaces, hw_if_index);
  47 }
  48
  49 always_inline vnet_hw_interface_t *
  50 vnet_get_hw_interface_or_null (vnet_main_t * vnm, u32 hw_if_index)
  51 {
  52   if (!pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index))
  53     return pool_elt_at_index (vnm->interface_main.hw_interfaces, hw_if_index);
  54   return (NULL);
  55 }
  56
  57 always_inline vnet_sw_interface_t *
  58 vnet_get_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
  59 {
  60   return pool_elt_at_index (vnm->interface_main.sw_interfaces, sw_if_index);
  61 }
  62
  63 always_inline vnet_sw_interface_t *
  64 vnet_get_sw_interface_or_null (vnet_main_t * vnm, u32 sw_if_index)
  65 {
  66   if (!pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
  67     return pool_elt_at_index (vnm->interface_main.sw_interfaces, sw_if_index);
  68   return (NULL);
  69 }
  70
  71 always_inline vnet_sw_interface_t *
  72 vnet_get_hw_sw_interface (vnet_main_t * vnm, u32 hw_if_index)
  73 {
  74   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
  75   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, hw->sw_if_index);
  76   ASSERT (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
  77   return sw;
  78 }
  79
  80 always_inline vnet_sw_interface_t *
  81 vnet_get_sup_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
  82 {
  83   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
  84   if (sw->type == VNET_SW_INTERFACE_TYPE_SUB ||
  85       sw->type == VNET_SW_INTERFACE_TYPE_PIPE ||
  86       sw->type == VNET_SW_INTERFACE_TYPE_P2P)
  87     sw = vnet_get_sw_interface (vnm, sw->sup_sw_if_index);
  88   return sw;
  89 }
  90
  91 always_inline vnet_hw_interface_t *
  92 vnet_get_sup_hw_interface (vnet_main_t * vnm, u32 sw_if_index)
  93 {
  94   vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
  95   ASSERT ((sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE) ||
  96           (sw->type == VNET_SW_INTERFACE_TYPE_PIPE));
  97   return vnet_get_hw_interface (vnm, sw->hw_if_index);
  98 }
  99
 100 always_inline vnet_hw_interface_t *
 101 vnet_get_sup_hw_interface_api_visible_or_null (vnet_main_t * vnm,
 102                                                u32 sw_if_index)
 103 {
 104   vnet_sw_interface_t *si;
 105   if (PREDICT_FALSE (pool_is_free_index (vnm->interface_main.sw_interfaces,
 106                                          sw_if_index)))
 107     return NULL;
 108   si = vnet_get_sup_sw_interface (vnm, sw_if_index);
 109   if (PREDICT_FALSE (si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN))
 110     return NULL;
 111   ASSERT ((si->type == VNET_SW_INTERFACE_TYPE_HARDWARE) ||
 112           (si->type == VNET_SW_INTERFACE_TYPE_PIPE));
 113   return vnet_get_hw_interface (vnm, si->hw_if_index);
 114 }
 115
 116 always_inline vnet_hw_interface_class_t *
 117 vnet_get_hw_interface_class (vnet_main_t * vnm, u32 hw_class_index)
 118 {
 119   return vec_elt_at_index (vnm->interface_main.hw_interface_classes,
 120                            hw_class_index);
 121 }
 122
 123 always_inline vnet_device_class_t *
 124 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
 125 {
 126   return vec_elt_at_index (vnm->interface_main.device_classes,
 127                            dev_class_index);
 128 }
 129
 130 static inline u8 *
 131 vnet_get_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
 132 {
 133   uword *p;
 134   p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
 135   if (p)
 136     return ((u8 *) p[0]);
 137   return 0;
 138 }
 139
 140 static inline void
 141 vnet_set_sw_interface_tag (vnet_main_t * vnm, u8 * tag, u32 sw_if_index)
 142 {
 143   uword *p;
 144   p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
 145   if (p)
 146     {
 147       u8 *oldtag = (u8 *) p[0];
 148       hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
 149       vec_free (oldtag);
 150     }
 151
 152   hash_set (vnm->interface_tag_by_sw_if_index, sw_if_index, tag);
 153 }
 154
 155 static inline void
 156 vnet_clear_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
 157 {
 158   uword *p;
 159   p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
 160   if (p)
 161     {
 162       u8 *oldtag = (u8 *) p[0];
 163       hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
 164       vec_free (oldtag);
 165     }
 166 }
 167
 168 /**
 169  * Walk return code
 170  */
 171 typedef enum walk_rc_t_
 172 {
 173   WALK_STOP,
 174   WALK_CONTINUE,
 175 } walk_rc_t;
 176
 177 /**
 178  * Call back walk type for walking SW indices on a HW interface
 179  */
 180 typedef walk_rc_t (*vnet_hw_sw_interface_walk_t) (vnet_main_t * vnm,
 181                                                   u32 sw_if_index, void *ctx);
 182
 183 /**
 184  * @brief
 185  * Walk the SW interfaces on a HW interface - this is the super
 186  * interface and any sub-interfaces.
 187  */
 188 void vnet_hw_interface_walk_sw (vnet_main_t * vnm,
 189                                 u32 hw_if_index,
 190                                 vnet_hw_sw_interface_walk_t fn, void *ctx);
 191
 192 /**
 193  * Call back walk type for walking SW indices on a HW interface
 194  */
 195 typedef walk_rc_t (*vnet_sw_interface_walk_t) (vnet_main_t * vnm,
 196                                                vnet_sw_interface_t * si,
 197                                                void *ctx);
 198
 199 /**
 200  * @brief
 201  * Walk all the SW interfaces in the system.
 202  */
 203 void vnet_sw_interface_walk (vnet_main_t * vnm,
 204                              vnet_sw_interface_walk_t fn, void *ctx);
 205
 206
 207 /**
 208  * Call back walk type for walking all HW indices
 209  */
 210 typedef walk_rc_t (*vnet_hw_interface_walk_t) (vnet_main_t * vnm,
 211                                                u32 hw_if_index, void *ctx);
 212
 213 /**
 214  * @brief
 215  * Walk all the HW interface
 216  */
 217 void vnet_hw_interface_walk (vnet_main_t * vnm,
 218                              vnet_hw_interface_walk_t fn, void *ctx);
 219
 220 /* Register a hardware interface instance. */
 221 u32 vnet_register_interface (vnet_main_t * vnm,
 222                              u32 dev_class_index,
 223                              u32 dev_instance,
 224                              u32 hw_class_index, u32 hw_instance);
 225
 226 /**
 227  * Set interface output node - for interface registered without its output/tx
 228  * nodes created because its VNET_DEVICE_CLASS did not specify any tx_function.
 229  * This is typically the case for tunnel interfaces.
 230  */
 231 void vnet_set_interface_output_node (vnet_main_t * vnm,
 232                                      u32 hw_if_index, u32 node_index);
 233
 234 /* Creates a software interface given template. */
 235 clib_error_t *vnet_create_sw_interface (vnet_main_t * vnm,
 236                                         vnet_sw_interface_t * template,
 237                                         u32 * sw_if_index);
 238
 239 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
 240 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
 241 int vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index);
 242
 243 always_inline vnet_sw_interface_flags_t
 244 vnet_sw_interface_get_flags (vnet_main_t * vnm, u32 sw_if_index)
 245 {
 246   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
 247   return sw->flags;
 248 }
 249
 250 always_inline uword
 251 vnet_sw_interface_is_valid (vnet_main_t * vnm, u32 sw_if_index)
 252 {
 253   return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index);
 254 }
 255
 256 always_inline uword
 257 vnet_hw_interface_is_valid (vnet_main_t * vnm, u32 hw_if_index)
 258 {
 259   return !pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index);
 260 }
 261
 262
 263 always_inline uword
 264 vnet_sw_interface_is_admin_up (vnet_main_t * vnm, u32 sw_if_index)
 265 {
 266   return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
 267           VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
 268 }
 269
 270 always_inline uword
 271 vnet_swif_is_api_visible (vnet_sw_interface_t * si)
 272 {
 273   return !(si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN);
 274 }
 275
 276 always_inline uword
 277 vnet_sw_interface_is_api_visible (vnet_main_t * vnm, u32 sw_if_index)
 278 {
 279   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
 280   return vnet_swif_is_api_visible (si);
 281 }
 282
 283 always_inline uword
 284 vnet_sw_interface_is_api_valid (vnet_main_t * vnm, u32 sw_if_index)
 285 {
 286   return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index)
 287     && vnet_sw_interface_is_api_visible (vnm, sw_if_index);
 288 }
 289
 290 always_inline const u8 *
 291 vnet_sw_interface_get_hw_address (vnet_main_t * vnm, u32 sw_if_index)
 292 {
 293   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 294   return hw->hw_address;
 295 }
 296
 297 always_inline uword
 298 vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
 299 {
 300   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 301   return hw->flags;
 302 }
 303
 304 always_inline u32
 305 vnet_hw_interface_get_mtu (vnet_main_t * vnm, u32 hw_if_index)
 306 {
 307   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 308   return hw->max_packet_bytes;
 309 }
 310
 311 always_inline u32
 312 vnet_sw_interface_get_mtu (vnet_main_t * vnm, u32 sw_if_index, vnet_mtu_t af)
 313 {
 314   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
 315   u32 mtu;
 316   mtu = sw->mtu[af] > 0 ? sw->mtu[af] : sw->mtu[VNET_MTU_L3];
 317   if (mtu == 0)
 318     return 9000;                /* $$$ Deal with interface-types not setting MTU */
 319   return mtu;
 320 }
 321
 322 always_inline uword
 323 vnet_hw_interface_is_link_up (vnet_main_t * vnm, u32 hw_if_index)
 324 {
 325   return ((vnet_hw_interface_get_flags (vnm, hw_if_index) &
 326            VNET_HW_INTERFACE_FLAG_LINK_UP) != 0);
 327 }
 328
 329 always_inline uword
 330 vnet_sw_interface_is_link_up (vnet_main_t * vnm, u32 sw_if_index)
 331 {
 332   vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
 333
 334   return (vnet_hw_interface_is_link_up (vnm, sw->hw_if_index));
 335 }
 336
 337 always_inline uword
 338 vnet_sw_interface_is_up (vnet_main_t * vnm, u32 sw_if_index)
 339 {
 340   return (vnet_sw_interface_is_admin_up (vnm, sw_if_index) &&
 341           vnet_sw_interface_is_link_up (vnm, sw_if_index));
 342 }
 343
 344 always_inline vlib_frame_t *
 345 vnet_get_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
 346 {
 347   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 348   return vlib_get_frame_to_node (vlib_get_main (), hw->output_node_index);
 349 }
 350
 351 always_inline void
 352 vnet_put_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index,
 353                                 vlib_frame_t * f)
 354 {
 355   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 356   return vlib_put_frame_to_node (vlib_get_main (), hw->output_node_index, f);
 357 }
 358
 359 always_inline void
 360 vnet_hw_interface_set_link_speed (vnet_main_t * vnm, u32 hw_if_index,
 361                                   u32 link_speed)
 362 {
 363   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 364   hw->link_speed = link_speed;
 365 }
 366
 367 /* Change interface flags (e.g. up, down, enable, disable). */
 368 clib_error_t *vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index,
 369                                            vnet_hw_interface_flags_t flags);
 370
 371 /* Change interface flags (e.g. up, down, enable, disable). */
 372 clib_error_t *vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index,
 373                                            vnet_sw_interface_flags_t flags);
 374
 375 void vnet_sw_interface_admin_up (vnet_main_t * vnm, u32 sw_if_index);
 376 void vnet_sw_interface_admin_down (vnet_main_t * vnm, u32 sw_if_index);
 377
 378 /* Change interface class. */
 379 clib_error_t *vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
 380                                            u32 new_hw_class_index);
 381
 382 /* Redirect rx pkts to node */
 383 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
 384                                            u32 node_index);
 385
 386 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
 387                                        u32 hw_class_index, u32 hw_instance);
 388
 389 /* Rename interface */
 390 clib_error_t *vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index,
 391                                      char *new_name);
 392
 393 /* Add/delete secondary interface mac address*/
 394 clib_error_t *vnet_hw_interface_add_del_mac_address (vnet_main_t * vnm,
 395                                                      u32 hw_if_index,
 396                                                      const u8 * mac_address,
 397                                                      u8 is_add);
 398
 399 /* Change interface mac address*/
 400 clib_error_t *vnet_hw_interface_change_mac_address (vnet_main_t * vnm,
 401                                                     u32 hw_if_index,
 402                                                     const u8 * mac_address);
 403
 404 /* Change rx-mode */
 405 clib_error_t *set_hw_interface_change_rx_mode (vnet_main_t * vnm,
 406                                                u32 hw_if_index,
 407                                                u8 queue_id_valid,
 408                                                u32 queue_id,
 409                                                vnet_hw_interface_rx_mode
 410                                                mode);
 411
 412 /* Set rx-placement on the interface */
 413 clib_error_t *set_hw_interface_rx_placement (u32 hw_if_index, u32 queue_id,
 414                                              u32 thread_index, u8 is_main);
 415
 416 /* Set the MTU on the HW interface */
 417 void vnet_hw_interface_set_mtu (vnet_main_t * vnm, u32 hw_if_index, u32 mtu);
 418
 419 /* Set the MTU on the SW interface */
 420 void vnet_sw_interface_set_mtu (vnet_main_t * vnm, u32 sw_if_index, u32 mtu);
 421 void vnet_sw_interface_set_protocol_mtu (vnet_main_t * vnm, u32 sw_if_index,
 422                                          u32 mtu[]);
 423
 424 /* update the unnumbered state of an interface */
 425 void vnet_sw_interface_update_unnumbered (u32 sw_if_index,
 426                                           u32 ip_sw_if_index, u8 enable);
 427
 428 int vnet_sw_interface_stats_collect_enable_disable (u32 sw_if_index,
 429                                                     u8 enable);
 430 void vnet_sw_interface_ip_directed_broadcast (vnet_main_t * vnm,
 431                                               u32 sw_if_index, u8 enable);
 432
 433 /* Formats sw/hw interface. */
 434 format_function_t format_vnet_hw_interface;
 435 format_function_t format_vnet_hw_interface_rx_mode;
 436 format_function_t format_vnet_hw_if_index_name;
 437 format_function_t format_vnet_sw_interface;
 438 format_function_t format_vnet_sw_interface_name;
 439 format_function_t format_vnet_sw_interface_name_override;
 440 format_function_t format_vnet_sw_if_index_name;
 441 format_function_t format_vnet_sw_interface_flags;
 442
 443 /* Parses sw/hw interface name -> index. */
 444 unformat_function_t unformat_vnet_sw_interface;
 445 unformat_function_t unformat_vnet_hw_interface;
 446
 447 /* Parses interface flags (up, down, enable, disable, etc.) */
 448 unformat_function_t unformat_vnet_hw_interface_flags;
 449 unformat_function_t unformat_vnet_sw_interface_flags;
 450
 451 /* Node runtime for interface output function. */
 452 typedef struct
 453 {
 454   u32 hw_if_index;
 455   u32 sw_if_index;
 456   u32 dev_instance;
 457   u32 is_deleted;
 458 } vnet_interface_output_runtime_t;
 459
 460 /* Interface output function. */
 461 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
 462                                 uword sw_if_index1);
 463 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
 464                                 uword hw_if_index1);
 465
 466 typedef enum
 467 {
 468   VNET_INTERFACE_OUTPUT_NEXT_DROP,
 469   VNET_INTERFACE_OUTPUT_NEXT_TX,
 470 } vnet_interface_output_next_t;
 471
 472 typedef enum
 473 {
 474   VNET_INTERFACE_TX_NEXT_DROP,
 475   VNET_INTERFACE_TX_N_NEXT,
 476 } vnet_interface_tx_next_t;
 477
 478 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
 479 #define VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT (VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT + 1)
 480
 481 typedef enum
 482 {
 483   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DOWN,
 484   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DELETED,
 485   VNET_INTERFACE_OUTPUT_ERROR_NO_BUFFERS_FOR_GSO,
 486   VNET_INTERFACE_OUTPUT_ERROR_UNHANDLED_GSO_TYPE,
 487 } vnet_interface_output_error_t;
 488
 489 /* Format for interface output traces. */
 490 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
 491
 492 serialize_function_t serialize_vnet_interface_state,
 493   unserialize_vnet_interface_state;
 494
 495 #endif /* included_vnet_interface_funcs_h */
 496
 497 /*
 498  * fd.io coding-style-patch-verification: ON
 499  *
 500  * Local Variables:
 501  * eval: (c-set-style "gnu")
 502  * End:
 503  */