vnet/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 /**
  96  * Call back walk type for walking SW indices on a HW interface
  97  */
  98 typedef void (*vnet_hw_sw_interface_walk_t) (vnet_main_t * vnm,
  99                                              u32 sw_if_index, void *ctx);
 100
 101 /**
 102  * @brief
 103  * Walk the SW interfaces on a HW interface - this is the super
 104  * interface and any sub-interfaces.
 105  */
 106 void vnet_hw_interface_walk_sw (vnet_main_t * vnm,
 107                                 u32 hw_if_index,
 108                                 vnet_hw_sw_interface_walk_t fn, void *ctx);
 109
 110 /* Register a hardware interface instance. */
 111 u32 vnet_register_interface (vnet_main_t * vnm,
 112                              u32 dev_class_index,
 113                              u32 dev_instance,
 114                              u32 hw_class_index, u32 hw_instance);
 115
 116 /* Creates a software interface given template. */
 117 clib_error_t *vnet_create_sw_interface (vnet_main_t * vnm,
 118                                         vnet_sw_interface_t * template,
 119                                         u32 * sw_if_index);
 120
 121 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
 122 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
 123 int vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index);
 124
 125 always_inline uword
 126 vnet_sw_interface_get_flags (vnet_main_t * vnm, u32 sw_if_index)
 127 {
 128   vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
 129   return sw->flags;
 130 }
 131
 132 always_inline uword
 133 vnet_sw_interface_is_admin_up (vnet_main_t * vnm, u32 sw_if_index)
 134 {
 135   return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
 136           VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
 137 }
 138
 139 always_inline uword
 140 vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
 141 {
 142   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 143   return hw->flags;
 144 }
 145
 146 always_inline uword
 147 vnet_hw_interface_get_mtu (vnet_main_t * vnm, u32 hw_if_index,
 148                            vlib_rx_or_tx_t dir)
 149 {
 150   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 151   return hw->max_l3_packet_bytes[dir];
 152 }
 153
 154 always_inline uword
 155 vnet_sw_interface_get_mtu (vnet_main_t * vnm, u32 sw_if_index,
 156                            vlib_rx_or_tx_t dir)
 157 {
 158   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 159   return (hw->max_l3_packet_bytes[dir]);
 160 }
 161
 162 always_inline uword
 163 vnet_hw_interface_is_link_up (vnet_main_t * vnm, u32 hw_if_index)
 164 {
 165   return (vnet_hw_interface_get_flags (vnm, hw_if_index) &
 166           VNET_HW_INTERFACE_FLAG_LINK_UP) != 0;
 167 }
 168
 169 always_inline vlib_frame_t *
 170 vnet_get_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
 171 {
 172   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 173   return vlib_get_frame_to_node (vnm->vlib_main, hw->output_node_index);
 174 }
 175
 176 always_inline void
 177 vnet_put_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index,
 178                                 vlib_frame_t * f)
 179 {
 180   vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 181   return vlib_put_frame_to_node (vnm->vlib_main, hw->output_node_index, f);
 182 }
 183
 184 /* Change interface flags (e.g. up, down, enable, disable). */
 185 clib_error_t *vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index,
 186                                            u32 flags);
 187
 188 /* Change interface flags (e.g. up, down, enable, disable). */
 189 clib_error_t *vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index,
 190                                            u32 flags);
 191
 192 /* Change interface class. */
 193 clib_error_t *vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
 194                                            u32 new_hw_class_index);
 195
 196 /* Redirect rx pkts to node */
 197 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
 198                                            u32 node_index);
 199
 200 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
 201                                        u32 hw_class_index, u32 hw_instance);
 202
 203 /* Rename interface */
 204 clib_error_t *vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index,
 205                                      char *new_name);
 206
 207 /* Change interface mac address*/
 208 clib_error_t *vnet_hw_interface_change_mac_address (vnet_main_t * vnm,
 209                                                     u32 hw_if_index,
 210                                                     u64 mac_address);
 211
 212 /* Formats sw/hw interface. */
 213 format_function_t format_vnet_hw_interface;
 214 format_function_t format_vnet_sw_interface;
 215 format_function_t format_vnet_sw_interface_name;
 216 format_function_t format_vnet_sw_interface_name_override;
 217 format_function_t format_vnet_sw_if_index_name;
 218 format_function_t format_vnet_sw_interface_flags;
 219
 220 /* Parses sw/hw interface name -> index. */
 221 unformat_function_t unformat_vnet_sw_interface;
 222 unformat_function_t unformat_vnet_hw_interface;
 223
 224 /* Parses interface flags (up, down, enable, disable, etc.) */
 225 unformat_function_t unformat_vnet_hw_interface_flags;
 226 unformat_function_t unformat_vnet_sw_interface_flags;
 227
 228 /* Node runtime for interface output function. */
 229 typedef struct
 230 {
 231   u32 hw_if_index;
 232   u32 sw_if_index;
 233   u32 dev_instance;
 234   u32 is_deleted;
 235 } vnet_interface_output_runtime_t;
 236
 237 /* Interface output functions. */
 238 void *vnet_interface_output_node_multiarch_select (void);
 239 void *vnet_interface_output_node_no_flatten_multiarch_select (void);
 240
 241 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
 242                                 uword sw_if_index1);
 243 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
 244                                 uword hw_if_index1);
 245
 246 typedef enum
 247 {
 248   VNET_INTERFACE_OUTPUT_NEXT_DROP,
 249   VNET_INTERFACE_OUTPUT_NEXT_TX,
 250 } vnet_interface_output_next_t;
 251
 252 typedef enum
 253 {
 254   VNET_INTERFACE_TX_NEXT_DROP,
 255   VNET_INTERFACE_TX_N_NEXT,
 256 } vnet_interface_tx_next_t;
 257
 258 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
 259
 260 typedef enum
 261 {
 262   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DOWN,
 263   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DELETED,
 264 } vnet_interface_output_error_t;
 265
 266 /* Format for interface output traces. */
 267 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
 268
 269 serialize_function_t serialize_vnet_interface_state,
 270   unserialize_vnet_interface_state;
 271
 272 #endif /* included_vnet_interface_funcs_h */
 273
 274 /*
 275  * fd.io coding-style-patch-verification: ON
 276  *
 277  * Local Variables:
 278  * eval: (c-set-style "gnu")
 279  * End:
 280  */