FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
interface_funcs.h
Go to the documentation of this file.
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 
45 {
46  return pool_elt_at_index (vnm->interface_main.hw_interfaces, hw_if_index);
47 }
48 
51 {
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);
54  return (NULL);
55 }
56 
59 {
60  return pool_elt_at_index (vnm->interface_main.sw_interfaces, sw_if_index);
61 }
62 
65 {
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);
68  return (NULL);
69 }
70 
73 {
74  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
77  return sw;
78 }
79 
82 {
83  vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
84  if (sw->type == VNET_SW_INTERFACE_TYPE_SUB ||
87  sw = vnet_get_sw_interface (vnm, sw->sup_sw_if_index);
88  return sw;
89 }
90 
93 {
94  vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
97  return vnet_get_hw_interface (vnm, sw->hw_if_index);
98 }
99 
103 {
106  sw_if_index)))
107  return NULL;
108  si = vnet_get_sup_sw_interface (vnm, sw_if_index);
110  return NULL;
113  return vnet_get_hw_interface (vnm, si->hw_if_index);
114 }
115 
118 {
120  hw_class_index);
121 }
122 
124 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
125 {
127  dev_class_index);
128 }
129 
130 static inline u8 *
132 {
133  uword *p;
134  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
135  if (p)
136  return ((u8 *) p[0]);
137  return 0;
138 }
139 
140 static inline void
142 {
143  uword *p;
144  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
145  if (p)
146  {
147  u8 *oldtag = (u8 *) p[0];
148  hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
149  vec_free (oldtag);
150  }
151 
152  hash_set (vnm->interface_tag_by_sw_if_index, sw_if_index, tag);
153 }
154 
155 static inline void
157 {
158  uword *p;
159  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
160  if (p)
161  {
162  u8 *oldtag = (u8 *) p[0];
163  hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
164  vec_free (oldtag);
165  }
166 }
167 
168 /**
169  * Walk return code
170  */
171 typedef enum walk_rc_t_
172 {
175 } walk_rc_t;
176 
177 /**
178  * Call back walk type for walking SW indices on a HW interface
179  */
181  u32 sw_if_index, void *ctx);
182 
183 /**
184  * @brief
185  * Walk the SW interfaces on a HW interface - this is the super
186  * interface and any sub-interfaces.
187  */
189  u32 hw_if_index,
190  vnet_hw_sw_interface_walk_t fn, void *ctx);
191 
192 /**
193  * Call back walk type for walking SW indices on a HW interface
194  */
196  vnet_sw_interface_t * si,
197  void *ctx);
198 
199 /**
200  * @brief
201  * Walk all the SW interfaces in the system.
202  */
204  vnet_sw_interface_walk_t fn, void *ctx);
205 
206 
207 /**
208  * Call back walk type for walking all HW indices
209  */
211  u32 hw_if_index, void *ctx);
212 
213 /**
214  * @brief
215  * Walk all the HW interface
216  */
218  vnet_hw_interface_walk_t fn, void *ctx);
219 
220 /* Register a hardware interface instance. */
222  u32 dev_class_index,
223  u32 dev_instance,
224  u32 hw_class_index, u32 hw_instance);
225 
226 /**
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.
230  */
232  u32 hw_if_index, u32 node_index);
233 
234 /* Creates a software interface given template. */
236  vnet_sw_interface_t * template,
237  u32 * sw_if_index);
238 
239 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
242 
245 {
246  vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
247  return sw->flags;
248 }
249 
252 {
253  return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index);
254 }
255 
258 {
259  return !pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index);
260 }
261 
262 
265 {
266  return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
268 }
269 
272 {
273  return !(si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN);
274 }
275 
278 {
279  vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
280  return vnet_swif_is_api_visible (si);
281 }
282 
285 {
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);
288 }
289 
290 always_inline const u8 *
292 {
293  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
294  return hw->hw_address;
295 }
296 
299 {
300  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
301  return hw->flags;
302 }
303 
306 {
307  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
308  return hw->max_packet_bytes;
309 }
310 
313 {
314  vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
315  u32 mtu;
316  mtu = sw->mtu[af] > 0 ? sw->mtu[af] : sw->mtu[VNET_MTU_L3];
317  if (mtu == 0)
318  return 9000; /* $$$ Deal with interface-types not setting MTU */
319  return mtu;
320 }
321 
324 {
325  return ((vnet_hw_interface_get_flags (vnm, hw_if_index) &
327 }
328 
331 {
332  vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
333 
334  return (vnet_hw_interface_is_link_up (vnm, sw->hw_if_index));
335 }
336 
339 {
340  return (vnet_sw_interface_is_admin_up (vnm, sw_if_index) &&
341  vnet_sw_interface_is_link_up (vnm, sw_if_index));
342 }
343 
346 {
347  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
349 }
350 
351 always_inline void
353  vlib_frame_t * f)
354 {
355  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
357 }
358 
359 always_inline void
361  u32 link_speed)
362 {
363  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
364  hw->link_speed = link_speed;
365 }
366 
367 /* Change interface flags (e.g. up, down, enable, disable). */
370 
371 /* Change interface flags (e.g. up, down, enable, disable). */
374 
375 /* Change interface class. */
377  u32 new_hw_class_index);
378 
379 /* Redirect rx pkts to node */
381  u32 node_index);
382 
383 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
384  u32 hw_class_index, u32 hw_instance);
385 
386 /* Rename interface */
388  char *new_name);
389 
390 /* Change interface mac address*/
392  u32 hw_if_index,
393  const u8 * mac_address);
394 
395 /* Change rx-mode */
397  u32 hw_if_index,
398  u8 queue_id_valid,
399  u32 queue_id,
401  mode);
402 
403 /* Set rx-placement on the interface */
404 clib_error_t *set_hw_interface_rx_placement (u32 hw_if_index, u32 queue_id,
405  u32 thread_index, u8 is_main);
406 
407 /* Set the MTU on the HW interface */
408 void vnet_hw_interface_set_mtu (vnet_main_t * vnm, u32 hw_if_index, u32 mtu);
409 
410 /* Set the MTU on the SW interface */
413  u32 mtu[]);
414 
415 /* update the unnumbered state of an interface */
417  u32 ip_sw_if_index, u8 enable);
418 
420  u8 enable);
422  u32 sw_if_index, u8 enable);
423 
424 /* Formats sw/hw interface. */
433 
434 /* Parses sw/hw interface name -> index. */
437 
438 /* Parses interface flags (up, down, enable, disable, etc.) */
441 
442 /* Node runtime for interface output function. */
443 typedef struct
444 {
450 
451 /* Interface output function. */
452 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
453  uword sw_if_index1);
454 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
455  uword hw_if_index1);
456 
457 typedef enum
458 {
462 
463 typedef enum
464 {
468 
469 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
470 #define VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT (VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT + 1)
471 
472 typedef enum
473 {
479 
480 /* Format for interface output traces. */
481 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
482 
485 
486 #endif /* included_vnet_interface_funcs_h */
487 
488 /*
489  * fd.io coding-style-patch-verification: ON
490  *
491  * Local Variables:
492  * eval: (c-set-style "gnu")
493  * End:
494  */
unformat_function_t unformat_vnet_hw_interface
u32 sw_if_index
Definition: ipsec_gre.api:37
static uword vnet_sw_interface_is_up(vnet_main_t *vnm, u32 sw_if_index)
void vnet_set_interface_output_node(vnet_main_t *vnm, u32 hw_if_index, u32 node_index)
Set interface output node - for interface registered without its output/tx nodes created because its ...
vnet_interface_tx_next_t
void vnet_sw_interface_walk(vnet_main_t *vnm, vnet_sw_interface_walk_t fn, void *ctx)
Walk all the SW interfaces in the system.
Definition: interface.c:1062
format_function_t format_vnet_sw_interface
format_function_t format_vnet_hw_if_index_name
#define hash_set(h, key, value)
Definition: hash.h:255
u32 flags
Definition: vhost_user.h:115
#define hash_unset(h, key)
Definition: hash.h:261
void vnet_hw_interface_walk(vnet_main_t *vnm, vnet_hw_interface_walk_t fn, void *ctx)
Walk all the HW interface.
Definition: interface.c:1044
static vnet_hw_interface_t * vnet_get_sup_hw_interface(vnet_main_t *vnm, u32 sw_if_index)
void vnet_hw_interface_walk_sw(vnet_main_t *vnm, u32 hw_if_index, vnet_hw_sw_interface_walk_t fn, void *ctx)
Walk the SW interfaces on a HW interface - this is the super interface and any sub-interfaces.
Definition: interface.c:1021
clib_error_t * vnet_rename_interface(vnet_main_t *vnm, u32 hw_if_index, char *new_name)
Definition: interface.c:1384
vnet_interface_main_t interface_main
Definition: vnet.h:56
serialize_function_t serialize_vnet_interface_state
#define NULL
Definition: clib.h:58
walk_rc_t(* vnet_hw_interface_walk_t)(vnet_main_t *vnm, u32 hw_if_index, void *ctx)
Call back walk type for walking all HW indices.
word vnet_sw_interface_compare(vnet_main_t *vnm, uword sw_if_index0, uword sw_if_index1)
Definition: interface.c:1186
static vnet_hw_interface_t * vnet_get_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
static u32 vnet_hw_interface_get_mtu(vnet_main_t *vnm, u32 hw_if_index)
static void vnet_clear_sw_interface_tag(vnet_main_t *vnm, u32 sw_if_index)
word vnet_hw_interface_compare(vnet_main_t *vnm, uword hw_if_index0, uword hw_if_index1)
Definition: interface.c:1200
void() serialize_function_t(serialize_main_t *m, va_list *va)
Definition: serialize.h:168
static vnet_sw_interface_t * vnet_get_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
static u32 vnet_sw_interface_get_mtu(vnet_main_t *vnm, u32 sw_if_index, vnet_mtu_t af)
unformat_function_t unformat_vnet_sw_interface
uword * interface_tag_by_sw_if_index
Definition: vnet.h:72
void vnet_hw_interface_set_mtu(vnet_main_t *vnm, u32 hw_if_index, u32 mtu)
Definition: interface.c:702
struct _vnet_device_class vnet_device_class_t
format_function_t format_vnet_sw_if_index_name
static uword vnet_sw_interface_is_link_up(vnet_main_t *vnm, u32 sw_if_index)
unsigned char u8
Definition: types.h:56
enum vnet_sw_interface_flags_t_ vnet_sw_interface_flags_t
static vnet_sw_interface_t * vnet_get_hw_sw_interface(vnet_main_t *vnm, u32 hw_if_index)
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
enum walk_rc_t_ walk_rc_t
Walk return code.
vnet_hw_interface_rx_mode
Definition: interface.h:52
format_function_t format_vnet_hw_interface
i64 word
Definition: types.h:111
clib_error_t * set_hw_interface_rx_placement(u32 hw_if_index, u32 queue_id, u32 thread_index, u8 is_main)
int vnet_hw_interface_rx_redirect_to_node(vnet_main_t *vnm, u32 hw_if_index, u32 node_index)
Definition: interface.c:1177
#define always_inline
Definition: clib.h:98
static vnet_device_class_t * vnet_get_device_class(vnet_main_t *vnm, u32 dev_class_index)
enum vnet_hw_interface_flags_t_ vnet_hw_interface_flags_t
vnet_hw_interface_flags_t flags
Definition: interface.h:494
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
static vnet_sw_interface_t * vnet_get_sup_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
vlib_frame_t * vlib_get_frame_to_node(vlib_main_t *vm, u32 to_node_index)
Definition: main.c:187
u32 mtu[VNET_N_MTU]
Definition: interface.h:701
clib_error_t * set_hw_interface_change_rx_mode(vnet_main_t *vnm, u32 hw_if_index, u8 queue_id_valid, u32 queue_id, vnet_hw_interface_rx_mode mode)
unsigned int u32
Definition: types.h:88
static uword vnet_sw_interface_is_valid(vnet_main_t *vnm, u32 sw_if_index)
void vnet_delete_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
Definition: interface.c:604
static const u8 * vnet_sw_interface_get_hw_address(vnet_main_t *vnm, u32 sw_if_index)
vnet_hw_interface_t * hw_interfaces
Definition: interface.h:801
#define hash_get(h, key)
Definition: hash.h:249
format_function_t format_vnet_sw_interface_name
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
u8 * format_vnet_interface_output_trace(u8 *s, va_list *va)
static uword vnet_hw_interface_get_flags(vnet_main_t *vnm, u32 hw_if_index)
long ctx[MAX_CONNS]
Definition: main.c:144
serialize_function_t unserialize_vnet_interface_state
vnet_mtu_t
Definition: interface.h:639
void vlib_put_frame_to_node(vlib_main_t *vm, u32 to_node_index, vlib_frame_t *f)
Definition: main.c:196
format_function_t format_vnet_hw_interface_rx_mode
#define PREDICT_FALSE(x)
Definition: clib.h:111
vnet_sw_interface_flags_t flags
Definition: interface.h:684
vnet_interface_output_error_t
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:232
void vnet_hw_interface_init_for_class(vnet_main_t *vnm, u32 hw_if_index, u32 hw_class_index, u32 hw_instance)
Definition: interface.c:1080
static void vnet_put_frame_to_sw_interface(vnet_main_t *vnm, u32 sw_if_index, vlib_frame_t *f)
#define vec_free(V)
Free vector's memory (no header).
Definition: vec.h:341
static vnet_hw_interface_t * vnet_get_sup_hw_interface_api_visible_or_null(vnet_main_t *vnm, u32 sw_if_index)
static uword vnet_swif_is_api_visible(vnet_sw_interface_t *si)
vnet_interface_output_next_t
walk_rc_t_
Walk return code.
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:283
void vnet_sw_interface_set_mtu(vnet_main_t *vnm, u32 sw_if_index, u32 mtu)
Definition: interface.c:642
static uword vnet_hw_interface_is_valid(vnet_main_t *vnm, u32 hw_if_index)
vl_api_vxlan_gbp_api_tunnel_mode_t mode
Definition: vxlan_gbp.api:44
format_function_t format_vnet_sw_interface_flags
u32 vnet_register_interface(vnet_main_t *vnm, u32 dev_class_index, u32 dev_instance, u32 hw_class_index, u32 hw_instance)
Definition: interface.c:740
#define ASSERT(truth)
void vnet_sw_interface_update_unnumbered(u32 sw_if_index, u32 ip_sw_if_index, u8 enable)
Definition: interface.c:1475
static void vnet_set_sw_interface_tag(vnet_main_t *vnm, u8 *tag, u32 sw_if_index)
static vnet_hw_interface_class_t * vnet_get_hw_interface_class(vnet_main_t *vnm, u32 hw_class_index)
void vnet_sw_interface_ip_directed_broadcast(vnet_main_t *vnm, u32 sw_if_index, u8 enable)
Definition: interface.c:675
clib_error_t * vnet_hw_interface_set_class(vnet_main_t *vnm, u32 hw_if_index, u32 new_hw_class_index)
Definition: interface.c:1150
static u8 * vnet_get_sw_interface_tag(vnet_main_t *vnm, u32 sw_if_index)
walk_rc_t(* vnet_hw_sw_interface_walk_t)(vnet_main_t *vnm, u32 sw_if_index, void *ctx)
Call back walk type for walking SW indices on a HW interface.
static vlib_frame_t * vnet_get_frame_to_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
int vnet_sw_interface_is_p2p(vnet_main_t *vnm, u32 sw_if_index)
Definition: interface.c:1212
u8 mac_address[6]
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
static uword vnet_sw_interface_is_admin_up(vnet_main_t *vnm, u32 sw_if_index)
static uword vnet_sw_interface_is_api_valid(vnet_main_t *vnm, u32 sw_if_index)
void vnet_sw_interface_set_protocol_mtu(vnet_main_t *vnm, u32 sw_if_index, u32 mtu[])
Definition: interface.c:654
struct _vnet_hw_interface_class vnet_hw_interface_class_t
unformat_function_t unformat_vnet_sw_interface_flags
u64 uword
Definition: types.h:112
vnet_sw_interface_t * sw_interfaces
Definition: interface.h:815
vnet_hw_interface_class_t * hw_interface_classes
Definition: interface.h:807
walk_rc_t(* vnet_sw_interface_walk_t)(vnet_main_t *vnm, vnet_sw_interface_t *si, void *ctx)
Call back walk type for walking SW indices on a HW interface.
int vnet_sw_interface_stats_collect_enable_disable(u32 sw_if_index, u8 enable)
void vnet_delete_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
Definition: interface.c:951
unformat_function_t unformat_vnet_hw_interface_flags
static vnet_sw_interface_flags_t vnet_sw_interface_get_flags(vnet_main_t *vnm, u32 sw_if_index)
vnet_sw_interface_type_t type
Definition: interface.h:682
static vnet_hw_interface_t * vnet_get_hw_interface_or_null(vnet_main_t *vnm, u32 hw_if_index)
vnet_device_class_t * device_classes
Definition: interface.h:808
clib_error_t * vnet_hw_interface_change_mac_address(vnet_main_t *vnm, u32 hw_if_index, const u8 *mac_address)
Definition: interface.c:1466
clib_error_t * vnet_create_sw_interface(vnet_main_t *vnm, vnet_sw_interface_t *template, u32 *sw_if_index)
Definition: interface.c:566
clib_error_t * vnet_sw_interface_set_flags(vnet_main_t *vnm, u32 sw_if_index, vnet_sw_interface_flags_t flags)
Definition: interface.c:513
format_function_t format_vnet_sw_interface_name_override
static uword vnet_hw_interface_is_link_up(vnet_main_t *vnm, u32 hw_if_index)
static vnet_sw_interface_t * vnet_get_sw_interface_or_null(vnet_main_t *vnm, u32 sw_if_index)
static void vnet_hw_interface_set_link_speed(vnet_main_t *vnm, u32 hw_if_index, u32 link_speed)
clib_error_t * vnet_hw_interface_set_flags(vnet_main_t *vnm, u32 hw_if_index, vnet_hw_interface_flags_t flags)
Definition: interface.c:504
static uword vnet_sw_interface_is_api_visible(vnet_main_t *vnm, u32 sw_if_index)