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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * interface_funcs.h: VNET interfaces/sub-interfaces exported functions
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_vnet_interface_funcs_h
41 #define included_vnet_interface_funcs_h
43 always_inline vnet_hw_interface_t *
44 vnet_get_hw_interface (vnet_main_t * vnm, u32 hw_if_index)
46 return pool_elt_at_index (vnm->interface_main.hw_interfaces, hw_if_index);
49 always_inline vnet_sw_interface_t *
50 vnet_get_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
52 return pool_elt_at_index (vnm->interface_main.sw_interfaces, sw_if_index);
55 always_inline vnet_sw_interface_t *
56 vnet_get_hw_sw_interface (vnet_main_t * vnm, u32 hw_if_index)
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);
64 always_inline vnet_sw_interface_t *
65 vnet_get_sup_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
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);
73 always_inline vnet_hw_interface_t *
74 vnet_get_sup_hw_interface (vnet_main_t * vnm, u32 sw_if_index)
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);
81 always_inline vnet_hw_interface_class_t *
82 vnet_get_hw_interface_class (vnet_main_t * vnm, u32 hw_class_index)
84 return vec_elt_at_index (vnm->interface_main.hw_interface_classes,
88 always_inline vnet_device_class_t *
89 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
91 return vec_elt_at_index (vnm->interface_main.device_classes,
95 /* Register a hardware interface instance. */
96 u32 vnet_register_interface (vnet_main_t * vnm,
99 u32 hw_class_index, u32 hw_instance);
101 /* Creates a software interface given template. */
102 clib_error_t *vnet_create_sw_interface (vnet_main_t * vnm,
103 vnet_sw_interface_t * template,
106 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
107 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
110 vnet_sw_interface_get_flags (vnet_main_t * vnm, u32 sw_if_index)
112 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
117 vnet_sw_interface_is_admin_up (vnet_main_t * vnm, u32 sw_if_index)
119 return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
120 VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
124 vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
126 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
131 vnet_hw_interface_is_link_up (vnet_main_t * vnm, u32 hw_if_index)
133 return (vnet_hw_interface_get_flags (vnm, hw_if_index) &
134 VNET_HW_INTERFACE_FLAG_LINK_UP) != 0;
137 always_inline vlib_frame_t *
138 vnet_get_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
140 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
141 return vlib_get_frame_to_node (vnm->vlib_main, hw->output_node_index);
145 vnet_put_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index,
148 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
149 return vlib_put_frame_to_node (vnm->vlib_main, hw->output_node_index, f);
152 /* Change interface flags (e.g. up, down, enable, disable). */
153 clib_error_t *vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index,
156 /* Change interface flags (e.g. up, down, enable, disable). */
157 clib_error_t *vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index,
160 /* Change interface class. */
161 clib_error_t *vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
162 u32 new_hw_class_index);
164 /* Redirect rx pkts to node */
165 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
168 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
169 u32 hw_class_index, u32 hw_instance);
171 /* Rename interface */
172 clib_error_t *vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index,
175 /* Formats sw/hw interface. */
176 format_function_t format_vnet_hw_interface;
177 format_function_t format_vnet_sw_interface;
178 format_function_t format_vnet_sw_interface_name;
179 format_function_t format_vnet_sw_interface_name_override;
180 format_function_t format_vnet_sw_if_index_name;
181 format_function_t format_vnet_sw_interface_flags;
183 /* Parses sw/hw interface name -> index. */
184 unformat_function_t unformat_vnet_sw_interface;
185 unformat_function_t unformat_vnet_hw_interface;
187 /* Parses interface flags (up, down, enable, disable, etc.) */
188 unformat_function_t unformat_vnet_hw_interface_flags;
189 unformat_function_t unformat_vnet_sw_interface_flags;
191 /* Node runtime for interface output function. */
198 } vnet_interface_output_runtime_t;
200 /* Interface output functions. */
201 void *vnet_interface_output_node_multiarch_select (void);
202 void *vnet_interface_output_node_no_flatten_multiarch_select (void);
204 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
206 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
211 #define _(sym,str) VNET_INTERFACE_OUTPUT_NEXT_##sym,
212 foreach_intf_output_feat
214 VNET_INTERFACE_OUTPUT_NEXT_DROP,
215 VNET_INTERFACE_OUTPUT_NEXT_TX,
216 } vnet_interface_output_next_t;
220 VNET_INTERFACE_TX_NEXT_DROP,
221 VNET_INTERFACE_TX_N_NEXT,
222 } vnet_interface_tx_next_t;
224 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
228 VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DOWN,
229 VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DELETED,
230 } vnet_interface_output_error_t;
232 /* Format for interface output traces. */
233 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
235 serialize_function_t serialize_vnet_interface_state,
236 unserialize_vnet_interface_state;
238 #endif /* included_vnet_interface_funcs_h */
241 * fd.io coding-style-patch-verification: ON
244 * eval: (c-set-style "gnu")