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_safe (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_safe (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_P2P)
  86     sw = vnet_get_sw_interface (vnm, sw->sup_sw_if_index);
  87   return sw;
  88 }
  89
  90 always_inline vnet_hw_interface_t *
  91 vnet_get_sup_hw_interface (vnet_main_t * vnm, u32 sw_if_index)
  92 {
  93   vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
  94   ASSERT (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
  95   return vnet_get_hw_interface (vnm, sw->hw_if_index);
  96 }
  97
  98 always_inline vnet_hw_interface_class_t *
  99 vnet_get_hw_interface_class (vnet_main_t * vnm, u32 hw_class_index)
 100 {
 101   return vec_elt_at_index (vnm->interface_main.hw_interface_classes,
 102                            hw_class_index);
 103 }
 104
 105 always_inline vnet_device_class_t *
 106 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
 107 {
 108   return vec_elt_at_index (vnm->interface_main.device_classes,
 109                            dev_class_index);
 110 }
 111
 112 static inline u8 *
 113 vnet_get_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
 114 {
 115   uword *p;
 116   p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
 117   if (p)
 118     return ((u8 *) p[0]);
 119   return 0;
 120 }
 121
 122 static inline void
 123 vnet_set_sw_interface_tag (vnet_main_t * vnm, u8 * tag, u32 sw_if_index)
 124 {
 125   uword *p;
 126   p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
 127   if (p)
 128     {
 129       u8 *oldtag = (u8 *) p[0];
 130       hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
 131       vec_free (oldtag);
 132     }
 133
 134   hash_set (vnm->interface_tag_by_sw_if_index, sw_if_index, tag);
 135 }
 136
 137 static inline void
 138 vnet_clear_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
 139 {
 140   uword *p;
 141   p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
 142   if (p)
 143     {
 144       u8 *oldtag = (u8 *) p[0];
 145       hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
 146       vec_free (oldtag);
 147     }
 148 }
 149
 150 /**
 151  * Walk return code
 152  */
 153 typedef enum walk_rc_t_
 154 {
 155   WALK_STOP,
 156   WALK_CONTINUE,
 157 } walk_rc_t;
 158
 159 /**
 160  * Call back walk type for walking SW indices on a HW interface
 161  */
 162 typedef walk_rc_t (*vnet_hw_sw_interface_walk_t) (vnet_main_t * vnm,
 163                                                   u32 sw_if_index, void *ctx);
 164
 165 /**
 166  * @brief
 167  * Walk the SW interfaces on a HW interface - this is the super
 168  * interface and any sub-interfaces.
 169  */
 170 void vnet_hw_interface_walk_sw (vnet_main_t * vnm,
 171                                 u32 hw_if_index,
 172                                 vnet_hw_sw_interface_walk_t fn, void *ctx);
 173
 174 /**
 175  * Call back walk type for walking SW indices on a HW interface
 176  */
 177 typedef walk_rc_t (*vnet_sw_interface_walk_t) (vnet_main_t * vnm,
 178                                                vnet_sw_interface_t * si,
 179                                                void *ctx);
 180
 181 /**
 182  * @brief
 183  * Walk all the SW interfaces in the system.
 184  */
 185 void vnet_sw_interface_walk (vnet_main_t * vnm,
 186                              vnet_sw_interface_walk_t fn, void *ctx);
 187
 188 /* Register a hardware interface instance. */
 189 u32 vnet_register_interface (vnet_main_t * vnm,
 190                              u32 dev_class_index,
 191                              u32 dev_instance,
 192                              u32 hw_class_index, u32 hw_instance);
 193
 194 /**
 195  * Set interface output node - for interface registered without its output/tx
 196  * nodes created because its VNET_DEVICE_CLASS did not specify any tx_function.
 197  * This is typically the case for tunnel interfaces.
 198  */
 199 void vnet_set_interface_output_node (vnet_main_t * vnm,
 200                                      u32 hw_if_index, u32 node_index);
 201
 202 /* Creates a software interface given template. */
 203 clib_error_t *vnet_create_sw_interface (vnet_main_t * vnm,
 204                                         vnet_sw_interface_t * template,
 205                                         u32 * sw_if_index);
 206
 207 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
 208 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
 209 int vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index);
 210
 211 always_inline uword
 212 vnet_sw_interface_get_flags (vnet_main_t * vnm, u32 sw_if_index)
 213 {
 214   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
 215   return sw->flags;
 216 }
 217
 218 always_inline uword
 219 vnet_sw_interface_is_valid (vnet_main_t * vnm, u32 sw_if_index)
 220 {
 221   return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index);
 222 }
 223
 224 always_inline uword
 225 vnet_hw_interface_is_valid (vnet_main_t * vnm, u32 hw_if_index)
 226 {
 227   return !pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index);
 228 }
 229
 230
 231 always_inline uword
 232 vnet_sw_interface_is_admin_up (vnet_main_t * vnm, u32 sw_if_index)
 233 {
 234   return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
 235           VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
 236 }
 237
 238 always_inline uword
 239 vnet_swif_is_api_visible (vnet_sw_interface_t * si)
 240 {
 241   return !(si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN);
 242 }
 243
 244 always_inline uword
 245 vnet_sw_interface_is_api_visible (vnet_main_t * vnm, u32 sw_if_index)
 246 {
 247   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
 248   return vnet_swif_is_api_visible (si);
 249 }
 250
 251 always_inline uword
 252 vnet_sw_interface_is_api_valid (vnet_main_t * vnm, u32 sw_if_index)
 253 {
 254   return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index)
 255     && vnet_sw_interface_is_api_visible (vnm, sw_if_index);
 256 }
 257
 258 always_inline uword
 259 vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
 260 {
 261   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 262   return hw->flags;
 263 }
 264
 265 always_inline uword
 266 vnet_hw_interface_get_mtu (vnet_main_t * vnm, u32 hw_if_index,
 267                            vlib_rx_or_tx_t dir)
 268 {
 269   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 270   return hw->max_l3_packet_bytes[dir];
 271 }
 272
 273 always_inline uword
 274 vnet_sw_interface_get_mtu (vnet_main_t * vnm, u32 sw_if_index,
 275                            vlib_rx_or_tx_t dir)
 276 {
 277   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 278   return (hw->max_l3_packet_bytes[dir]);
 279 }
 280
 281 always_inline uword
 282 vnet_hw_interface_is_link_up (vnet_main_t * vnm, u32 hw_if_index)
 283 {
 284   return (vnet_hw_interface_get_flags (vnm, hw_if_index) &
 285           VNET_HW_INTERFACE_FLAG_LINK_UP) != 0;
 286 }
 287
 288 always_inline vlib_frame_t *
 289 vnet_get_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
 290 {
 291   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 292   return vlib_get_frame_to_node (vlib_get_main (), hw->output_node_index);
 293 }
 294
 295 always_inline void
 296 vnet_put_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index,
 297                                 vlib_frame_t * f)
 298 {
 299   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 300   return vlib_put_frame_to_node (vlib_get_main (), hw->output_node_index, f);
 301 }
 302
 303 /* Change interface flags (e.g. up, down, enable, disable). */
 304 clib_error_t *vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index,
 305                                            u32 flags);
 306
 307 /* Change interface flags (e.g. up, down, enable, disable). */
 308 clib_error_t *vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index,
 309                                            u32 flags);
 310
 311 /* Change interface class. */
 312 clib_error_t *vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
 313                                            u32 new_hw_class_index);
 314
 315 /* Redirect rx pkts to node */
 316 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
 317                                            u32 node_index);
 318
 319 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
 320                                        u32 hw_class_index, u32 hw_instance);
 321
 322 /* Rename interface */
 323 clib_error_t *vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index,
 324                                      char *new_name);
 325
 326 /* Change interface mac address*/
 327 clib_error_t *vnet_hw_interface_change_mac_address (vnet_main_t * vnm,
 328                                                     u32 hw_if_index,
 329                                                     u8 * mac_address);
 330
 331 /* Change rx-mode */
 332 clib_error_t *set_hw_interface_change_rx_mode (vnet_main_t * vnm,
 333                                                u32 hw_if_index,
 334                                                u8 queue_id_valid,
 335                                                u32 queue_id,
 336                                                vnet_hw_interface_rx_mode
 337                                                mode);
 338
 339 /* Set the MTU on the HW interface */
 340 void vnet_hw_interface_set_mtu (vnet_main_t * vnm, u32 hw_if_index, u32 mtu);
 341
 342 /* update the unnumbered state of an interface */
 343 void vnet_sw_interface_update_unnumbered (u32 sw_if_index,
 344                                           u32 ip_sw_if_index, u8 enable);
 345
 346 int vnet_sw_interface_stats_collect_enable_disable (u32 sw_if_index,
 347                                                     u8 enable);
 348
 349 /* Formats sw/hw interface. */
 350 format_function_t format_vnet_hw_interface;
 351 format_function_t format_vnet_hw_interface_rx_mode;
 352 format_function_t format_vnet_hw_if_index_name;
 353 format_function_t format_vnet_sw_interface;
 354 format_function_t format_vnet_sw_interface_name;
 355 format_function_t format_vnet_sw_interface_name_override;
 356 format_function_t format_vnet_sw_if_index_name;
 357 format_function_t format_vnet_sw_interface_flags;
 358
 359 /* Parses sw/hw interface name -> index. */
 360 unformat_function_t unformat_vnet_sw_interface;
 361 unformat_function_t unformat_vnet_hw_interface;
 362
 363 /* Parses interface flags (up, down, enable, disable, etc.) */
 364 unformat_function_t unformat_vnet_hw_interface_flags;
 365 unformat_function_t unformat_vnet_sw_interface_flags;
 366
 367 /* Node runtime for interface output function. */
 368 typedef struct
 369 {
 370   u32 hw_if_index;
 371   u32 sw_if_index;
 372   u32 dev_instance;
 373   u32 is_deleted;
 374 } vnet_interface_output_runtime_t;
 375
 376 /* Interface output function. */
 377 void *vnet_interface_output_node_multiarch_select (void);
 378
 379 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
 380                                 uword sw_if_index1);
 381 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
 382                                 uword hw_if_index1);
 383
 384 typedef enum
 385 {
 386   VNET_INTERFACE_OUTPUT_NEXT_DROP,
 387   VNET_INTERFACE_OUTPUT_NEXT_TX,
 388 } vnet_interface_output_next_t;
 389
 390 typedef enum
 391 {
 392   VNET_INTERFACE_TX_NEXT_DROP,
 393   VNET_INTERFACE_TX_N_NEXT,
 394 } vnet_interface_tx_next_t;
 395
 396 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
 397
 398 typedef enum
 399 {
 400   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DOWN,
 401   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DELETED,
 402 } vnet_interface_output_error_t;
 403
 404 /* Format for interface output traces. */
 405 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
 406
 407 serialize_function_t serialize_vnet_interface_state,
 408   unserialize_vnet_interface_state;
 409
 410 #endif /* included_vnet_interface_funcs_h */
 411
 412 /*
 413  * fd.io coding-style-patch-verification: ON
 414  *
 415  * Local Variables:
 416  * eval: (c-set-style "gnu")
 417  * End:
 418  */