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