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