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 { return pool_elt_at_index (vnm->interface_main.hw_interfaces, hw_if_index); }
  46
  47 always_inline vnet_sw_interface_t *
  48 vnet_get_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
  49 { return pool_elt_at_index (vnm->interface_main.sw_interfaces, sw_if_index); }
  50
  51 always_inline vnet_sw_interface_t *
  52 vnet_get_hw_sw_interface (vnet_main_t * vnm, u32 hw_if_index)
  53 {
  54   vnet_hw_interface_t * hw = vnet_get_hw_interface (vnm, hw_if_index);
  55   vnet_sw_interface_t * sw = vnet_get_sw_interface (vnm, hw->sw_if_index);
  56   ASSERT (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
  57   return sw;
  58 }
  59
  60 always_inline vnet_sw_interface_t *
  61 vnet_get_sup_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
  62 {
  63   vnet_sw_interface_t * sw = vnet_get_sw_interface (vnm, sw_if_index);
  64   if (sw->type == VNET_SW_INTERFACE_TYPE_SUB)
  65     sw = vnet_get_sw_interface (vnm, sw->sup_sw_if_index);
  66   return sw;
  67 }
  68
  69 always_inline vnet_hw_interface_t *
  70 vnet_get_sup_hw_interface (vnet_main_t * vnm, u32 sw_if_index)
  71 {
  72   vnet_sw_interface_t * sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
  73   ASSERT (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
  74   return vnet_get_hw_interface (vnm, sw->hw_if_index);
  75 }
  76
  77 always_inline vnet_hw_interface_class_t *
  78 vnet_get_hw_interface_class (vnet_main_t * vnm, u32 hw_class_index)
  79 { return vec_elt_at_index (vnm->interface_main.hw_interface_classes, hw_class_index); }
  80
  81 always_inline vnet_device_class_t *
  82 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
  83 { return vec_elt_at_index (vnm->interface_main.device_classes, dev_class_index); }
  84
  85 /* Register a hardware interface instance. */
  86 u32 vnet_register_interface (vnet_main_t * vnm,
  87                              u32 dev_class_index,
  88                              u32 dev_instance,
  89                              u32 hw_class_index,
  90                              u32 hw_instance);
  91
  92 /* Creates a software interface given template. */
  93 clib_error_t *
  94 vnet_create_sw_interface (vnet_main_t * vnm, vnet_sw_interface_t * template, u32 * sw_if_index);
  95
  96 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
  97 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
  98
  99 always_inline uword
 100 vnet_sw_interface_get_flags (vnet_main_t * vnm, u32 sw_if_index)
 101 {
 102   vnet_sw_interface_t * sw = vnet_get_sw_interface (vnm, sw_if_index);
 103   return sw->flags;
 104 }
 105
 106 always_inline uword
 107 vnet_sw_interface_is_admin_up (vnet_main_t * vnm, u32 sw_if_index)
 108 { return (vnet_sw_interface_get_flags (vnm, sw_if_index) & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0; }
 109
 110 always_inline uword
 111 vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
 112 {
 113   vnet_hw_interface_t * hw = vnet_get_hw_interface (vnm, hw_if_index);
 114   return hw->flags;
 115 }
 116
 117 always_inline uword
 118 vnet_hw_interface_is_link_up (vnet_main_t * vnm, u32 hw_if_index)
 119 { return (vnet_hw_interface_get_flags (vnm, hw_if_index) & VNET_HW_INTERFACE_FLAG_LINK_UP) != 0; }
 120
 121 always_inline vlib_frame_t *
 122 vnet_get_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
 123 {
 124   vnet_hw_interface_t * hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 125   return vlib_get_frame_to_node (vnm->vlib_main, hw->output_node_index);
 126 }
 127
 128 always_inline void
 129 vnet_put_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index, vlib_frame_t * f)
 130 {
 131   vnet_hw_interface_t * hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
 132   return vlib_put_frame_to_node (vnm->vlib_main, hw->output_node_index, f);
 133 }
 134
 135 /* Change interface flags (e.g. up, down, enable, disable). */
 136 clib_error_t *
 137 vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags);
 138
 139 /* Change interface flags (e.g. up, down, enable, disable). */
 140 clib_error_t *
 141 vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index, u32 flags);
 142
 143 /* Change interface class. */
 144 clib_error_t *
 145 vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index, u32 new_hw_class_index);
 146
 147 /* Redirect rx pkts to node */
 148 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
 149                                            u32 node_index);
 150
 151 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index, u32 hw_instance);
 152
 153 /* Rename interface */
 154 clib_error_t *
 155 vnet_rename_interface (vnet_main_t * vnm, u32  hw_if_index, char * new_name);
 156
 157 /* Formats sw/hw interface. */
 158 format_function_t format_vnet_hw_interface;
 159 format_function_t format_vnet_sw_interface;
 160 format_function_t format_vnet_sw_interface_name;
 161 format_function_t format_vnet_sw_interface_name_override;
 162 format_function_t format_vnet_sw_if_index_name;
 163 format_function_t format_vnet_sw_interface_flags;
 164
 165 /* Parses sw/hw interface name -> index. */
 166 unformat_function_t unformat_vnet_sw_interface;
 167 unformat_function_t unformat_vnet_hw_interface;
 168
 169 /* Parses interface flags (up, down, enable, disable, etc.) */
 170 unformat_function_t unformat_vnet_hw_interface_flags;
 171 unformat_function_t unformat_vnet_sw_interface_flags;
 172
 173 /* Node runtime for interface output function. */
 174 typedef struct {
 175   u32 hw_if_index;
 176   u32 sw_if_index;
 177   u32 dev_instance;
 178   u32 is_deleted;
 179 } vnet_interface_output_runtime_t;
 180
 181 /* Interface output functions. */
 182 void * vnet_interface_output_node_multiarch_select (void);
 183 void * vnet_interface_output_node_no_flatten_multiarch_select (void);
 184
 185 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0, uword sw_if_index1);
 186 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0, uword hw_if_index1);
 187
 188 typedef enum {
 189 #define _(sym,str) VNET_INTERFACE_OUTPUT_NEXT_##sym,
 190   foreach_intf_output_feat
 191 #undef _
 192   VNET_INTERFACE_OUTPUT_NEXT_DROP,
 193   VNET_INTERFACE_OUTPUT_NEXT_TX,
 194 } vnet_interface_output_next_t;
 195
 196 typedef enum {
 197   VNET_INTERFACE_TX_NEXT_DROP,
 198   VNET_INTERFACE_TX_N_NEXT,
 199 } vnet_interface_tx_next_t;
 200
 201 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
 202
 203 typedef enum {
 204   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DOWN,
 205   VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DELETED,
 206 } vnet_interface_output_error_t;
 207
 208 /* Format for interface output traces. */
 209 u8 * format_vnet_interface_output_trace (u8 * s, va_list * va);
 210
 211 serialize_function_t serialize_vnet_interface_state, unserialize_vnet_interface_state;
 212
 213 #endif /* included_vnet_interface_funcs_h */