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_PIPE ||
86 sw->type == VNET_SW_INTERFACE_TYPE_P2P)
87 sw = vnet_get_sw_interface (vnm, sw->sup_sw_if_index);
91 always_inline vnet_hw_interface_t *
92 vnet_get_sup_hw_interface (vnet_main_t * vnm, u32 sw_if_index)
94 vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
95 ASSERT ((sw->type == VNET_SW_INTERFACE_TYPE_HARDWARE) ||
96 (sw->type == VNET_SW_INTERFACE_TYPE_PIPE));
97 return vnet_get_hw_interface (vnm, sw->hw_if_index);
100 always_inline vnet_hw_interface_class_t *
101 vnet_get_hw_interface_class (vnet_main_t * vnm, u32 hw_class_index)
103 return vec_elt_at_index (vnm->interface_main.hw_interface_classes,
107 always_inline vnet_device_class_t *
108 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
110 return vec_elt_at_index (vnm->interface_main.device_classes,
115 vnet_get_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
118 p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
120 return ((u8 *) p[0]);
125 vnet_set_sw_interface_tag (vnet_main_t * vnm, u8 * tag, u32 sw_if_index)
128 p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
131 u8 *oldtag = (u8 *) p[0];
132 hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
136 hash_set (vnm->interface_tag_by_sw_if_index, sw_if_index, tag);
140 vnet_clear_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
143 p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
146 u8 *oldtag = (u8 *) p[0];
147 hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
155 typedef enum walk_rc_t_
162 * Call back walk type for walking SW indices on a HW interface
164 typedef walk_rc_t (*vnet_hw_sw_interface_walk_t) (vnet_main_t * vnm,
165 u32 sw_if_index, void *ctx);
169 * Walk the SW interfaces on a HW interface - this is the super
170 * interface and any sub-interfaces.
172 void vnet_hw_interface_walk_sw (vnet_main_t * vnm,
174 vnet_hw_sw_interface_walk_t fn, void *ctx);
177 * Call back walk type for walking SW indices on a HW interface
179 typedef walk_rc_t (*vnet_sw_interface_walk_t) (vnet_main_t * vnm,
180 vnet_sw_interface_t * si,
185 * Walk all the SW interfaces in the system.
187 void vnet_sw_interface_walk (vnet_main_t * vnm,
188 vnet_sw_interface_walk_t fn, void *ctx);
192 * Call back walk type for walking all HW indices
194 typedef walk_rc_t (*vnet_hw_interface_walk_t) (vnet_main_t * vnm,
195 u32 hw_if_index, void *ctx);
199 * Walk all the HW interface
201 void vnet_hw_interface_walk (vnet_main_t * vnm,
202 vnet_hw_interface_walk_t fn, void *ctx);
204 /* Register a hardware interface instance. */
205 u32 vnet_register_interface (vnet_main_t * vnm,
208 u32 hw_class_index, u32 hw_instance);
211 * Set interface output node - for interface registered without its output/tx
212 * nodes created because its VNET_DEVICE_CLASS did not specify any tx_function.
213 * This is typically the case for tunnel interfaces.
215 void vnet_set_interface_output_node (vnet_main_t * vnm,
216 u32 hw_if_index, u32 node_index);
218 /* Creates a software interface given template. */
219 clib_error_t *vnet_create_sw_interface (vnet_main_t * vnm,
220 vnet_sw_interface_t * template,
223 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
224 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
225 int vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index);
227 always_inline vnet_sw_interface_flags_t
228 vnet_sw_interface_get_flags (vnet_main_t * vnm, u32 sw_if_index)
230 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
235 vnet_sw_interface_is_valid (vnet_main_t * vnm, u32 sw_if_index)
237 return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index);
241 vnet_hw_interface_is_valid (vnet_main_t * vnm, u32 hw_if_index)
243 return !pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index);
248 vnet_sw_interface_is_admin_up (vnet_main_t * vnm, u32 sw_if_index)
250 return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
251 VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
255 vnet_swif_is_api_visible (vnet_sw_interface_t * si)
257 return !(si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN);
261 vnet_sw_interface_is_api_visible (vnet_main_t * vnm, u32 sw_if_index)
263 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
264 return vnet_swif_is_api_visible (si);
268 vnet_sw_interface_is_api_valid (vnet_main_t * vnm, u32 sw_if_index)
270 return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index)
271 && vnet_sw_interface_is_api_visible (vnm, sw_if_index);
274 always_inline const u8 *
275 vnet_sw_interface_get_hw_address (vnet_main_t * vnm, u32 sw_if_index)
277 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
278 return hw->hw_address;
282 vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
284 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
289 vnet_hw_interface_get_mtu (vnet_main_t * vnm, u32 hw_if_index)
291 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
292 return hw->max_packet_bytes;
296 vnet_sw_interface_get_mtu (vnet_main_t * vnm, u32 sw_if_index, vnet_mtu_t af)
298 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
300 mtu = sw->mtu[af] > 0 ? sw->mtu[af] : sw->mtu[VNET_MTU_L3];
302 return 9000; /* $$$ Deal with interface-types not setting MTU */
307 vnet_hw_interface_is_link_up (vnet_main_t * vnm, u32 hw_if_index)
309 return ((vnet_hw_interface_get_flags (vnm, hw_if_index) &
310 VNET_HW_INTERFACE_FLAG_LINK_UP) != 0);
314 vnet_sw_interface_is_link_up (vnet_main_t * vnm, u32 sw_if_index)
316 vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
318 return (vnet_hw_interface_is_link_up (vnm, sw->hw_if_index));
322 vnet_sw_interface_is_up (vnet_main_t * vnm, u32 sw_if_index)
324 return (vnet_sw_interface_is_admin_up (vnm, sw_if_index) &&
325 vnet_sw_interface_is_link_up (vnm, sw_if_index));
328 always_inline vlib_frame_t *
329 vnet_get_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
331 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
332 return vlib_get_frame_to_node (vlib_get_main (), hw->output_node_index);
336 vnet_put_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index,
339 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
340 return vlib_put_frame_to_node (vlib_get_main (), hw->output_node_index, f);
344 vnet_hw_interface_set_link_speed (vnet_main_t * vnm, u32 hw_if_index,
347 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
348 hw->link_speed = link_speed;
351 /* Change interface flags (e.g. up, down, enable, disable). */
352 clib_error_t *vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index,
353 vnet_hw_interface_flags_t flags);
355 /* Change interface flags (e.g. up, down, enable, disable). */
356 clib_error_t *vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index,
357 vnet_sw_interface_flags_t flags);
359 /* Change interface class. */
360 clib_error_t *vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
361 u32 new_hw_class_index);
363 /* Redirect rx pkts to node */
364 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
367 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
368 u32 hw_class_index, u32 hw_instance);
370 /* Rename interface */
371 clib_error_t *vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index,
374 /* Change interface mac address*/
375 clib_error_t *vnet_hw_interface_change_mac_address (vnet_main_t * vnm,
377 const u8 * mac_address);
380 clib_error_t *set_hw_interface_change_rx_mode (vnet_main_t * vnm,
384 vnet_hw_interface_rx_mode
387 /* Set rx-placement on the interface */
388 clib_error_t *set_hw_interface_rx_placement (u32 hw_if_index, u32 queue_id,
389 u32 thread_index, u8 is_main);
391 /* Set the MTU on the HW interface */
392 void vnet_hw_interface_set_mtu (vnet_main_t * vnm, u32 hw_if_index, u32 mtu);
394 /* Set the MTU on the SW interface */
395 void vnet_sw_interface_set_mtu (vnet_main_t * vnm, u32 sw_if_index, u32 mtu);
396 void vnet_sw_interface_set_protocol_mtu (vnet_main_t * vnm, u32 sw_if_index,
399 /* update the unnumbered state of an interface */
400 void vnet_sw_interface_update_unnumbered (u32 sw_if_index,
401 u32 ip_sw_if_index, u8 enable);
403 int vnet_sw_interface_stats_collect_enable_disable (u32 sw_if_index,
405 void vnet_sw_interface_ip_directed_broadcast (vnet_main_t * vnm,
406 u32 sw_if_index, u8 enable);
408 /* Formats sw/hw interface. */
409 format_function_t format_vnet_hw_interface;
410 format_function_t format_vnet_hw_interface_rx_mode;
411 format_function_t format_vnet_hw_if_index_name;
412 format_function_t format_vnet_sw_interface;
413 format_function_t format_vnet_sw_interface_name;
414 format_function_t format_vnet_sw_interface_name_override;
415 format_function_t format_vnet_sw_if_index_name;
416 format_function_t format_vnet_sw_interface_flags;
418 /* Parses sw/hw interface name -> index. */
419 unformat_function_t unformat_vnet_sw_interface;
420 unformat_function_t unformat_vnet_hw_interface;
422 /* Parses interface flags (up, down, enable, disable, etc.) */
423 unformat_function_t unformat_vnet_hw_interface_flags;
424 unformat_function_t unformat_vnet_sw_interface_flags;
426 /* Node runtime for interface output function. */
433 } vnet_interface_output_runtime_t;
435 /* Interface output function. */
436 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
438 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
443 VNET_INTERFACE_OUTPUT_NEXT_DROP,
444 VNET_INTERFACE_OUTPUT_NEXT_TX,
445 } vnet_interface_output_next_t;
449 VNET_INTERFACE_TX_NEXT_DROP,
450 VNET_INTERFACE_TX_N_NEXT,
451 } vnet_interface_tx_next_t;
453 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
454 #define VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT (VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT + 1)
458 VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DOWN,
459 VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DELETED,
460 VNET_INTERFACE_OUTPUT_ERROR_NO_BUFFERS_FOR_GSO,
461 VNET_INTERFACE_OUTPUT_ERROR_UNHANDLED_GSO_TYPE,
462 } vnet_interface_output_error_t;
464 /* Format for interface output traces. */
465 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
467 serialize_function_t serialize_vnet_interface_state,
468 unserialize_vnet_interface_state;
470 #endif /* included_vnet_interface_funcs_h */
473 * fd.io coding-style-patch-verification: ON
476 * eval: (c-set-style "gnu")