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_or_null (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_or_null (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_t *
101 vnet_get_sup_hw_interface_api_visible_or_null (vnet_main_t * vnm,
104 vnet_sw_interface_t *si;
105 if (PREDICT_FALSE (pool_is_free_index (vnm->interface_main.sw_interfaces,
108 si = vnet_get_sup_sw_interface (vnm, sw_if_index);
109 if (PREDICT_FALSE (si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN))
111 ASSERT ((si->type == VNET_SW_INTERFACE_TYPE_HARDWARE) ||
112 (si->type == VNET_SW_INTERFACE_TYPE_PIPE));
113 return vnet_get_hw_interface (vnm, si->hw_if_index);
116 always_inline vnet_hw_interface_class_t *
117 vnet_get_hw_interface_class (vnet_main_t * vnm, u32 hw_class_index)
119 return vec_elt_at_index (vnm->interface_main.hw_interface_classes,
123 always_inline vnet_device_class_t *
124 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
126 return vec_elt_at_index (vnm->interface_main.device_classes,
131 vnet_get_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
134 p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
136 return ((u8 *) p[0]);
141 vnet_set_sw_interface_tag (vnet_main_t * vnm, u8 * tag, u32 sw_if_index)
144 p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
147 u8 *oldtag = (u8 *) p[0];
148 hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
152 hash_set (vnm->interface_tag_by_sw_if_index, sw_if_index, tag);
156 vnet_clear_sw_interface_tag (vnet_main_t * vnm, u32 sw_if_index)
159 p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
162 u8 *oldtag = (u8 *) p[0];
163 hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
171 typedef enum walk_rc_t_
178 * Call back walk type for walking SW indices on a HW interface
180 typedef walk_rc_t (*vnet_hw_sw_interface_walk_t) (vnet_main_t * vnm,
181 u32 sw_if_index, void *ctx);
185 * Walk the SW interfaces on a HW interface - this is the super
186 * interface and any sub-interfaces.
188 void vnet_hw_interface_walk_sw (vnet_main_t * vnm,
190 vnet_hw_sw_interface_walk_t fn, void *ctx);
193 * Call back walk type for walking SW indices on a HW interface
195 typedef walk_rc_t (*vnet_sw_interface_walk_t) (vnet_main_t * vnm,
196 vnet_sw_interface_t * si,
201 * Walk all the SW interfaces in the system.
203 void vnet_sw_interface_walk (vnet_main_t * vnm,
204 vnet_sw_interface_walk_t fn, void *ctx);
208 * Call back walk type for walking all HW indices
210 typedef walk_rc_t (*vnet_hw_interface_walk_t) (vnet_main_t * vnm,
211 u32 hw_if_index, void *ctx);
215 * Walk all the HW interface
217 void vnet_hw_interface_walk (vnet_main_t * vnm,
218 vnet_hw_interface_walk_t fn, void *ctx);
220 /* Register a hardware interface instance. */
221 u32 vnet_register_interface (vnet_main_t * vnm,
224 u32 hw_class_index, u32 hw_instance);
227 * Set interface output node - for interface registered without its output/tx
228 * nodes created because its VNET_DEVICE_CLASS did not specify any tx_function.
229 * This is typically the case for tunnel interfaces.
231 void vnet_set_interface_output_node (vnet_main_t * vnm,
232 u32 hw_if_index, u32 node_index);
234 /* Creates a software interface given template. */
235 clib_error_t *vnet_create_sw_interface (vnet_main_t * vnm,
236 vnet_sw_interface_t * template,
239 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
240 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
241 int vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index);
243 always_inline vnet_sw_interface_flags_t
244 vnet_sw_interface_get_flags (vnet_main_t * vnm, u32 sw_if_index)
246 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
251 vnet_sw_interface_is_valid (vnet_main_t * vnm, u32 sw_if_index)
253 return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index);
257 vnet_hw_interface_is_valid (vnet_main_t * vnm, u32 hw_if_index)
259 return !pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index);
264 vnet_sw_interface_is_admin_up (vnet_main_t * vnm, u32 sw_if_index)
266 return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
267 VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
271 vnet_swif_is_api_visible (vnet_sw_interface_t * si)
273 return !(si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN);
277 vnet_sw_interface_is_api_visible (vnet_main_t * vnm, u32 sw_if_index)
279 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
280 return vnet_swif_is_api_visible (si);
284 vnet_sw_interface_is_api_valid (vnet_main_t * vnm, u32 sw_if_index)
286 return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index)
287 && vnet_sw_interface_is_api_visible (vnm, sw_if_index);
290 always_inline const u8 *
291 vnet_sw_interface_get_hw_address (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 hw->hw_address;
298 vnet_hw_interface_get_flags (vnet_main_t * vnm, u32 hw_if_index)
300 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
305 vnet_hw_interface_get_mtu (vnet_main_t * vnm, u32 hw_if_index)
307 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
308 return hw->max_packet_bytes;
312 vnet_sw_interface_get_mtu (vnet_main_t * vnm, u32 sw_if_index, vnet_mtu_t af)
314 vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
316 mtu = sw->mtu[af] > 0 ? sw->mtu[af] : sw->mtu[VNET_MTU_L3];
318 return 9000; /* $$$ Deal with interface-types not setting MTU */
323 vnet_hw_interface_is_link_up (vnet_main_t * vnm, u32 hw_if_index)
325 return ((vnet_hw_interface_get_flags (vnm, hw_if_index) &
326 VNET_HW_INTERFACE_FLAG_LINK_UP) != 0);
330 vnet_sw_interface_is_link_up (vnet_main_t * vnm, u32 sw_if_index)
332 vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
334 return (vnet_hw_interface_is_link_up (vnm, sw->hw_if_index));
338 vnet_sw_interface_is_up (vnet_main_t * vnm, u32 sw_if_index)
340 return (vnet_sw_interface_is_admin_up (vnm, sw_if_index) &&
341 vnet_sw_interface_is_link_up (vnm, sw_if_index));
344 always_inline vlib_frame_t *
345 vnet_get_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index)
347 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
348 return vlib_get_frame_to_node (vlib_get_main (), hw->output_node_index);
352 vnet_put_frame_to_sw_interface (vnet_main_t * vnm, u32 sw_if_index,
355 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
356 return vlib_put_frame_to_node (vlib_get_main (), hw->output_node_index, f);
360 vnet_hw_interface_set_link_speed (vnet_main_t * vnm, u32 hw_if_index,
363 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
364 hw->link_speed = link_speed;
367 /* Change interface flags (e.g. up, down, enable, disable). */
368 clib_error_t *vnet_hw_interface_set_flags (vnet_main_t * vnm, u32 hw_if_index,
369 vnet_hw_interface_flags_t flags);
371 /* Change interface flags (e.g. up, down, enable, disable). */
372 clib_error_t *vnet_sw_interface_set_flags (vnet_main_t * vnm, u32 sw_if_index,
373 vnet_sw_interface_flags_t flags);
375 void vnet_sw_interface_admin_up (vnet_main_t * vnm, u32 sw_if_index);
376 void vnet_sw_interface_admin_down (vnet_main_t * vnm, u32 sw_if_index);
378 /* Change interface class. */
379 clib_error_t *vnet_hw_interface_set_class (vnet_main_t * vnm, u32 hw_if_index,
380 u32 new_hw_class_index);
382 /* Redirect rx pkts to node */
383 int vnet_hw_interface_rx_redirect_to_node (vnet_main_t * vnm, u32 hw_if_index,
386 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
387 u32 hw_class_index, u32 hw_instance);
389 /* Rename interface */
390 clib_error_t *vnet_rename_interface (vnet_main_t * vnm, u32 hw_if_index,
393 /* Change interface mac address*/
394 clib_error_t *vnet_hw_interface_change_mac_address (vnet_main_t * vnm,
396 const u8 * mac_address);
399 clib_error_t *set_hw_interface_change_rx_mode (vnet_main_t * vnm,
403 vnet_hw_interface_rx_mode
406 /* Set rx-placement on the interface */
407 clib_error_t *set_hw_interface_rx_placement (u32 hw_if_index, u32 queue_id,
408 u32 thread_index, u8 is_main);
410 /* Set the MTU on the HW interface */
411 void vnet_hw_interface_set_mtu (vnet_main_t * vnm, u32 hw_if_index, u32 mtu);
413 /* Set the MTU on the SW interface */
414 void vnet_sw_interface_set_mtu (vnet_main_t * vnm, u32 sw_if_index, u32 mtu);
415 void vnet_sw_interface_set_protocol_mtu (vnet_main_t * vnm, u32 sw_if_index,
418 /* update the unnumbered state of an interface */
419 void vnet_sw_interface_update_unnumbered (u32 sw_if_index,
420 u32 ip_sw_if_index, u8 enable);
422 int vnet_sw_interface_stats_collect_enable_disable (u32 sw_if_index,
424 void vnet_sw_interface_ip_directed_broadcast (vnet_main_t * vnm,
425 u32 sw_if_index, u8 enable);
427 /* Formats sw/hw interface. */
428 format_function_t format_vnet_hw_interface;
429 format_function_t format_vnet_hw_interface_rx_mode;
430 format_function_t format_vnet_hw_if_index_name;
431 format_function_t format_vnet_sw_interface;
432 format_function_t format_vnet_sw_interface_name;
433 format_function_t format_vnet_sw_interface_name_override;
434 format_function_t format_vnet_sw_if_index_name;
435 format_function_t format_vnet_sw_interface_flags;
437 /* Parses sw/hw interface name -> index. */
438 unformat_function_t unformat_vnet_sw_interface;
439 unformat_function_t unformat_vnet_hw_interface;
441 /* Parses interface flags (up, down, enable, disable, etc.) */
442 unformat_function_t unformat_vnet_hw_interface_flags;
443 unformat_function_t unformat_vnet_sw_interface_flags;
445 /* Node runtime for interface output function. */
452 } vnet_interface_output_runtime_t;
454 /* Interface output function. */
455 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
457 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
462 VNET_INTERFACE_OUTPUT_NEXT_DROP,
463 VNET_INTERFACE_OUTPUT_NEXT_TX,
464 } vnet_interface_output_next_t;
468 VNET_INTERFACE_TX_NEXT_DROP,
469 VNET_INTERFACE_TX_N_NEXT,
470 } vnet_interface_tx_next_t;
472 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
473 #define VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT (VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT + 1)
477 VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DOWN,
478 VNET_INTERFACE_OUTPUT_ERROR_INTERFACE_DELETED,
479 VNET_INTERFACE_OUTPUT_ERROR_NO_BUFFERS_FOR_GSO,
480 VNET_INTERFACE_OUTPUT_ERROR_UNHANDLED_GSO_TYPE,
481 } vnet_interface_output_error_t;
483 /* Format for interface output traces. */
484 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
486 serialize_function_t serialize_vnet_interface_state,
487 unserialize_vnet_interface_state;
489 #endif /* included_vnet_interface_funcs_h */
492 * fd.io coding-style-patch-verification: ON
495 * eval: (c-set-style "gnu")