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