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