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 /* Creates a software interface given template. */
 164 clib_error_t *vnet_create_sw_interface (vnet_main_t * vnm,
 165                                         vnet_sw_interface_t * template,
 166                                         u32 * sw_if_index);
 167
 168 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
 169 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
 170 int vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index);
 171
 172 always_inline uword
 173 vnet_sw_interface_get_flags (vnet_main_t * vnm, u32 sw_if_index)
 174 {
 175   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
 176   return sw->flags;
 177 }
 178
 179 always_inline uword
 180 vnet_sw_interface_is_admin_up (vnet_main_t * vnm, u32 sw_if_index)
 181 {
 182   return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
 183           VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
 184 }
 185
 186 always_inline uword
 187 vnet_swif_is_api_visible (vnet_sw_interface_t * si)
 188 {
 189   return !(si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN);
 190 }
 191
 192 always_inline uword
 193 vnet_sw_interface_is_api_visible (vnet_main_t * vnm, u32 sw_if_index)
 194 {
 195   vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
 196   return vnet_swif_is_api_visible (si);
 197 }
 198
 199 always_inline uword
 200 vnet_sw_interface_is_api_valid (vnet_main_t * vnm, u32 sw_if_index)
 201 {
 202   return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index)
 203     && vnet_sw_interface_is_api_visible (vnm, sw_if_index);
 204 }
 205
 206 always_inline uword
 207 vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
 208 {
 209   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 210   return hw->flags;
 211 }
 212
 213 always_inline uword
 214 vnet_hw_interface_get_mtu (vnet_main_t * vnm, u32 hw_if_index,
 215                            vlib_rx_or_tx_t dir)
 216 {
 217   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 218   return hw->max_l3_packet_bytes[dir];
 219 }
 220
 221 always_inline uword
 222 vnet_sw_interface_get_mtu (vnet_main_t * vnm, u32 sw_if_index,
 223                            vlib_rx_or_tx_t dir)
 224 {
 225   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 226   return (hw->max_l3_packet_bytes[dir]);
 227 }
 228
 229 always_inline uword
 230 vnet_hw_interface_is_link_up (vnet_main_t * vnm, u32 hw_if_index)
 231 {
 232   return (vnet_hw_interface_get_flags (vnm, hw_if_index) &
 233           VNET_HW_INTERFACE_FLAG_LINK_UP) != 0;
 234 }
 235
 236 always_inline vlib_frame_t *
 237 vnet_get_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
 238 {
 239   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 240   return vlib_get_frame_to_node (vnm->vlib_main, hw->output_node_index);
 241 }
 242
 243 always_inline void
 244 vnet_put_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index,
 245                                 vlib_frame_t * f)
 246 {
 247   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 248   return vlib_put_frame_to_node (vnm->vlib_main, hw->output_node_index, f);
 249 }
 250
 251 /* Change interface flags (e.g. up, down, enable, disable). */
 252 clib_error_t *vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index,
 253                                            u32 flags);
 254
 255 /* Change interface flags (e.g. up, down, enable, disable). */
 256 clib_error_t *vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index,
 257                                            u32 flags);
 258
 259 /* Change interface class. */
 260 clib_error_t *vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
 261                                            u32 new_hw_class_index);
 262
 263 /* Redirect rx pkts to node */
 264 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
 265                                            u32 node_index);
 266
 267 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
 268                                        u32 hw_class_index, u32 hw_instance);
 269
 270 /* Rename interface */
 271 clib_error_t *vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index,
 272                                      char *new_name);
 273
 274 /* Change interface mac address*/
 275 clib_error_t *vnet_hw_interface_change_mac_address (vnet_main_t * vnm,
 276                                                     u32 hw_if_index,
 277                                                     u8 * mac_address);
 278
 279 /* Change rx-mode */
 280 clib_error_t *set_hw_interface_change_rx_mode (vnet_main_t * vnm,
 281                                                u32 hw_if_index,
 282                                                u8 queue_id_valid,
 283                                                u32 queue_id,
 284                                                vnet_hw_interface_rx_mode
 285                                                mode);
 286
 287 /* Formats sw/hw interface. */
 288 format_function_t format_vnet_hw_interface;
 289 format_function_t format_vnet_hw_interface_rx_mode;
 290 format_function_t format_vnet_sw_interface;
 291 format_function_t format_vnet_sw_interface_name;
 292 format_function_t format_vnet_sw_interface_name_override;
 293 format_function_t format_vnet_sw_if_index_name;
 294 format_function_t format_vnet_sw_interface_flags;
 295
 296 /* Parses sw/hw interface name -> index. */
 297 unformat_function_t unformat_vnet_sw_interface;
 298 unformat_function_t unformat_vnet_hw_interface;
 299
 300 /* Parses interface flags (up, down, enable, disable, etc.) */
 301 unformat_function_t unformat_vnet_hw_interface_flags;
 302 unformat_function_t unformat_vnet_sw_interface_flags;
 303
 304 /* Node runtime for interface output function. */
 305 typedef struct
 306 {
 307   u32 hw_if_index;
 308   u32 sw_if_index;
 309   u32 dev_instance;
 310   u32 is_deleted;
 311 } vnet_interface_output_runtime_t;
 312
 313 /* Interface output function. */
 314 void *vnet_interface_output_node_multiarch_select (void);
 315
 316 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
 317                                 uword sw_if_index1);
 318 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
 319                                 uword hw_if_index1);
 320
 321 typedef enum
 322 {
 323   VNET_INTERFACE_OUTPUT_NEXT_DROP,
 324   VNET_INTERFACE_OUTPUT_NEXT_TX,
 325 } vnet_interface_output_next_t;
 326
 327 typedef enum
 328 {
 329   VNET_INTERFACE_TX_NEXT_DROP,
 330   VNET_INTERFACE_TX_N_NEXT,
 331 } vnet_interface_tx_next_t;
 332
 333 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
 334
 335 typedef enum
 336 {
 337   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DOWN,
 338   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DELETED,
 339 } vnet_interface_output_error_t;
 340
 341 /* Format for interface output traces. */
 342 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
 343
 344 serialize_function_t serialize_vnet_interface_state,
 345   unserialize_vnet_interface_state;
 346
 347 #endif /* included_vnet_interface_funcs_h */
 348
 349 /*
 350  * fd.io coding-style-patch-verification: ON
 351  *
 352  * Local Variables:
 353  * eval: (c-set-style "gnu")
 354  * End:
 355  */