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_hw_interface_t *
50 vnet_get_hw_interface_safe (vnet_main_t * vnm, u32 hw_if_index)
52 if (!pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index))
53 return pool_elt_at_index (vnm->interface_main.hw_interfaces, hw_if_index);
57 always_inline vnet_sw_interface_t *
58 vnet_get_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
60 return pool_elt_at_index (vnm->interface_main.sw_interfaces, sw_if_index);
63 always_inline vnet_sw_interface_t *
64 vnet_get_sw_interface_safe (vnet_main_t * vnm, u32 sw_if_index)
66 if (!pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
67 return pool_elt_at_index (vnm->interface_main.sw_interfaces, sw_if_index);
71 always_inline vnet_sw_interface_t *
72 vnet_get_hw_sw_interface (vnet_main_t * vnm, u32 hw_if_index)
74 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
75 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, hw->sw_if_index);
76 ASSERT (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
80 always_inline vnet_sw_interface_t *
81 vnet_get_sup_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
83 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
84 if (sw->type == VNET_SW_INTERFACE_TYPE_SUB ||
85 sw->type == VNET_SW_INTERFACE_TYPE_P2P)
86 sw = vnet_get_sw_interface (vnm, sw->sup_sw_if_index);
90 always_inline vnet_hw_interface_t *
91 vnet_get_sup_hw_interface (vnet_main_t * vnm, u32 sw_if_index)
93 vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
94 ASSERT (sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE);
95 return vnet_get_hw_interface (vnm, sw->hw_if_index);
98 always_inline vnet_hw_interface_class_t *
99 vnet_get_hw_interface_class (vnet_main_t * vnm, u32 hw_class_index)
101 return vec_elt_at_index (vnm->interface_main.hw_interface_classes,
105 always_inline vnet_device_class_t *
106 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
108 return vec_elt_at_index (vnm->interface_main.device_classes,
113 vnet_get_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
116 p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
118 return ((u8 *) p[0]);
123 vnet_set_sw_interface_tag (vnet_main_t * vnm, u8 * tag, u32 sw_if_index)
126 p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
129 u8 *oldtag = (u8 *) p[0];
130 hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
134 hash_set (vnm->interface_tag_by_sw_if_index, sw_if_index, tag);
138 vnet_clear_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
141 p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
144 u8 *oldtag = (u8 *) p[0];
145 hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
153 typedef enum walk_rc_t_
160 * Call back walk type for walking SW indices on a HW interface
162 typedef walk_rc_t (*vnet_hw_sw_interface_walk_t) (vnet_main_t * vnm,
163 u32 sw_if_index, void *ctx);
167 * Walk the SW interfaces on a HW interface - this is the super
168 * interface and any sub-interfaces.
170 void vnet_hw_interface_walk_sw (vnet_main_t * vnm,
172 vnet_hw_sw_interface_walk_t fn, void *ctx);
175 * Call back walk type for walking SW indices on a HW interface
177 typedef walk_rc_t (*vnet_sw_interface_walk_t) (vnet_main_t * vnm,
178 vnet_sw_interface_t * si,
183 * Walk all the SW interfaces in the system.
185 void vnet_sw_interface_walk (vnet_main_t * vnm,
186 vnet_sw_interface_walk_t fn, void *ctx);
188 /* Register a hardware interface instance. */
189 u32 vnet_register_interface (vnet_main_t * vnm,
192 u32 hw_class_index, u32 hw_instance);
195 * Set interface output node - for interface registered without its output/tx
196 * nodes created because its VNET_DEVICE_CLASS did not specify any tx_function.
197 * This is typically the case for tunnel interfaces.
199 void vnet_set_interface_output_node (vnet_main_t * vnm,
200 u32 hw_if_index, u32 node_index);
202 /* Creates a software interface given template. */
203 clib_error_t *vnet_create_sw_interface (vnet_main_t * vnm,
204 vnet_sw_interface_t * template,
207 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
208 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
209 int vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index);
212 vnet_sw_interface_get_flags (vnet_main_t * vnm, u32 sw_if_index)
214 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
219 vnet_sw_interface_is_valid (vnet_main_t * vnm, u32 sw_if_index)
221 return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index);
225 vnet_hw_interface_is_valid (vnet_main_t * vnm, u32 hw_if_index)
227 return !pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index);
232 vnet_sw_interface_is_admin_up (vnet_main_t * vnm, u32 sw_if_index)
234 return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
235 VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
239 vnet_swif_is_api_visible (vnet_sw_interface_t * si)
241 return !(si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN);
245 vnet_sw_interface_is_api_visible (vnet_main_t * vnm, u32 sw_if_index)
247 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
248 return vnet_swif_is_api_visible (si);
252 vnet_sw_interface_is_api_valid (vnet_main_t * vnm, u32 sw_if_index)
254 return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index)
255 && vnet_sw_interface_is_api_visible (vnm, sw_if_index);
259 vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
261 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
266 vnet_hw_interface_get_mtu (vnet_main_t * vnm, u32 hw_if_index)
268 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
269 return hw->max_packet_bytes;
273 vnet_sw_interface_get_mtu (vnet_main_t * vnm, u32 sw_if_index, vnet_mtu_t af)
275 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
277 mtu = sw->mtu[af] > 0 ? sw->mtu[af] : sw->mtu[VNET_MTU_L3];
279 return 9000; /* $$$ Deal with interface-types not setting MTU */
284 vnet_hw_interface_is_link_up (vnet_main_t * vnm, u32 hw_if_index)
286 return (vnet_hw_interface_get_flags (vnm, hw_if_index) &
287 VNET_HW_INTERFACE_FLAG_LINK_UP) != 0;
290 always_inline vlib_frame_t *
291 vnet_get_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
293 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
294 return vlib_get_frame_to_node (vlib_get_main (), hw->output_node_index);
298 vnet_put_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index,
301 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
302 return vlib_put_frame_to_node (vlib_get_main (), hw->output_node_index, f);
305 /* Change interface flags (e.g. up, down, enable, disable). */
306 clib_error_t *vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index,
309 /* Change interface flags (e.g. up, down, enable, disable). */
310 clib_error_t *vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index,
313 /* Change interface class. */
314 clib_error_t *vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
315 u32 new_hw_class_index);
317 /* Redirect rx pkts to node */
318 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
321 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
322 u32 hw_class_index, u32 hw_instance);
324 /* Rename interface */
325 clib_error_t *vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index,
328 /* Change interface mac address*/
329 clib_error_t *vnet_hw_interface_change_mac_address (vnet_main_t * vnm,
334 clib_error_t *set_hw_interface_change_rx_mode (vnet_main_t * vnm,
338 vnet_hw_interface_rx_mode
341 /* Set the MTU on the HW interface */
342 void vnet_hw_interface_set_mtu (vnet_main_t * vnm, u32 hw_if_index, u32 mtu);
344 /* Set the MTU on the SW interface */
345 void vnet_sw_interface_set_mtu (vnet_main_t * vnm, u32 sw_if_index, u32 mtu);
346 void vnet_sw_interface_set_protocol_mtu (vnet_main_t * vnm, u32 sw_if_index,
349 /* update the unnumbered state of an interface */
350 void vnet_sw_interface_update_unnumbered (u32 sw_if_index,
351 u32 ip_sw_if_index, u8 enable);
353 int vnet_sw_interface_stats_collect_enable_disable (u32 sw_if_index,
356 /* Formats sw/hw interface. */
357 format_function_t format_vnet_hw_interface;
358 format_function_t format_vnet_hw_interface_rx_mode;
359 format_function_t format_vnet_hw_if_index_name;
360 format_function_t format_vnet_sw_interface;
361 format_function_t format_vnet_sw_interface_name;
362 format_function_t format_vnet_sw_interface_name_override;
363 format_function_t format_vnet_sw_if_index_name;
364 format_function_t format_vnet_sw_interface_flags;
366 /* Parses sw/hw interface name -> index. */
367 unformat_function_t unformat_vnet_sw_interface;
368 unformat_function_t unformat_vnet_hw_interface;
370 /* Parses interface flags (up, down, enable, disable, etc.) */
371 unformat_function_t unformat_vnet_hw_interface_flags;
372 unformat_function_t unformat_vnet_sw_interface_flags;
374 /* Node runtime for interface output function. */
381 } vnet_interface_output_runtime_t;
383 /* Interface output function. */
384 void *vnet_interface_output_node_multiarch_select (void);
386 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
388 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
393 VNET_INTERFACE_OUTPUT_NEXT_DROP,
394 VNET_INTERFACE_OUTPUT_NEXT_TX,
395 } vnet_interface_output_next_t;
399 VNET_INTERFACE_TX_NEXT_DROP,
400 VNET_INTERFACE_TX_N_NEXT,
401 } vnet_interface_tx_next_t;
403 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
407 VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DOWN,
408 VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DELETED,
409 } vnet_interface_output_error_t;
411 /* Format for interface output traces. */
412 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
414 serialize_function_t serialize_vnet_interface_state,
415 unserialize_vnet_interface_state;
417 #endif /* included_vnet_interface_funcs_h */
420 * fd.io coding-style-patch-verification: ON
423 * eval: (c-set-style "gnu")