FD.io VPP  v18.11-rc0-18-g2a3fb1a
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 
102 {
104  hw_class_index);
105 }
106 
108 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
109 {
111  dev_class_index);
112 }
113 
114 static inline u8 *
116 {
117  uword *p;
118  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
119  if (p)
120  return ((u8 *) p[0]);
121  return 0;
122 }
123 
124 static inline void
125 vnet_set_sw_interface_tag (vnet_main_t * vnm, u8 * tag, u32 sw_if_index)
126 {
127  uword *p;
128  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
129  if (p)
130  {
131  u8 *oldtag = (u8 *) p[0];
132  hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
133  vec_free (oldtag);
134  }
135 
136  hash_set (vnm->interface_tag_by_sw_if_index, sw_if_index, tag);
137 }
138 
139 static inline void
141 {
142  uword *p;
143  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
144  if (p)
145  {
146  u8 *oldtag = (u8 *) p[0];
147  hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
148  vec_free (oldtag);
149  }
150 }
151 
152 /**
153  * Walk return code
154  */
155 typedef enum walk_rc_t_
156 {
159 } walk_rc_t;
160 
161 /**
162  * Call back walk type for walking SW indices on a HW interface
163  */
165  u32 sw_if_index, void *ctx);
166 
167 /**
168  * @brief
169  * Walk the SW interfaces on a HW interface - this is the super
170  * interface and any sub-interfaces.
171  */
173  u32 hw_if_index,
174  vnet_hw_sw_interface_walk_t fn, void *ctx);
175 
176 /**
177  * Call back walk type for walking SW indices on a HW interface
178  */
180  vnet_sw_interface_t * si,
181  void *ctx);
182 
183 /**
184  * @brief
185  * Walk all the SW interfaces in the system.
186  */
188  vnet_sw_interface_walk_t fn, void *ctx);
189 
190 
191 /**
192  * Call back walk type for walking all HW indices
193  */
195  u32 hw_if_index, void *ctx);
196 
197 /**
198  * @brief
199  * Walk all the HW interface
200  */
202  vnet_hw_interface_walk_t fn, void *ctx);
203 
204 /* Register a hardware interface instance. */
206  u32 dev_class_index,
207  u32 dev_instance,
208  u32 hw_class_index, u32 hw_instance);
209 
210 /**
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.
214  */
216  u32 hw_if_index, u32 node_index);
217 
218 /* Creates a software interface given template. */
220  vnet_sw_interface_t * template,
221  u32 * sw_if_index);
222 
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);
226 
229 {
230  vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
231  return sw->flags;
232 }
233 
236 {
237  return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index);
238 }
239 
242 {
243  return !pool_is_free_index (vnm->interface_main.hw_interfaces, hw_if_index);
244 }
245 
246 
249 {
250  return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
252 }
253 
256 {
257  return !(si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN);
258 }
259 
262 {
263  vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
264  return vnet_swif_is_api_visible (si);
265 }
266 
269 {
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);
272 }
273 
276 {
277  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
278  return hw->flags;
279 }
280 
283 {
284  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
285  return hw->max_packet_bytes;
286 }
287 
290 {
291  vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
292  u32 mtu;
293  mtu = sw->mtu[af] > 0 ? sw->mtu[af] : sw->mtu[VNET_MTU_L3];
294  if (mtu == 0)
295  return 9000; /* $$$ Deal with interface-types not setting MTU */
296  return mtu;
297 }
298 
301 {
302  return (vnet_hw_interface_get_flags (vnm, hw_if_index) &
304 }
305 
308 {
309  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
311 }
312 
313 always_inline void
315  vlib_frame_t * f)
316 {
317  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
319 }
320 
321 /* Change interface flags (e.g. up, down, enable, disable). */
323  u32 flags);
324 
325 /* Change interface flags (e.g. up, down, enable, disable). */
327  u32 flags);
328 
329 /* Change interface class. */
331  u32 new_hw_class_index);
332 
333 /* Redirect rx pkts to node */
335  u32 node_index);
336 
337 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
338  u32 hw_class_index, u32 hw_instance);
339 
340 /* Rename interface */
342  char *new_name);
343 
344 /* Change interface mac address*/
346  u32 hw_if_index,
347  u8 * mac_address);
348 
349 /* Change rx-mode */
351  u32 hw_if_index,
352  u8 queue_id_valid,
353  u32 queue_id,
355  mode);
356 
357 /* Set the MTU on the HW interface */
358 void vnet_hw_interface_set_mtu (vnet_main_t * vnm, u32 hw_if_index, u32 mtu);
359 
360 /* Set the MTU on the SW interface */
361 void vnet_sw_interface_set_mtu (vnet_main_t * vnm, u32 sw_if_index, u32 mtu);
362 void vnet_sw_interface_set_protocol_mtu (vnet_main_t * vnm, u32 sw_if_index,
363  u32 mtu[]);
364 
365 /* update the unnumbered state of an interface */
366 void vnet_sw_interface_update_unnumbered (u32 sw_if_index,
367  u32 ip_sw_if_index, u8 enable);
368 
370  u8 enable);
371 
372 /* Formats sw/hw interface. */
381 
382 /* Parses sw/hw interface name -> index. */
385 
386 /* Parses interface flags (up, down, enable, disable, etc.) */
389 
390 /* Node runtime for interface output function. */
391 typedef struct
392 {
398 
399 /* Interface output function. */
401 
402 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
403  uword sw_if_index1);
404 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
405  uword hw_if_index1);
406 
407 typedef enum
408 {
412 
413 typedef enum
414 {
418 
419 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
420 #define VNET_SIMULATED_ETHERNET_TX_NEXT_L2_INPUT (VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT + 1)
421 
422 typedef enum
423 {
427 
428 /* Format for interface output traces. */
429 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
430 
433 
434 #endif /* included_vnet_interface_funcs_h */
435 
436 /*
437  * fd.io coding-style-patch-verification: ON
438  *
439  * Local Variables:
440  * eval: (c-set-style "gnu")
441  * End:
442  */
unformat_function_t unformat_vnet_hw_interface
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
uword( unformat_function_t)(unformat_input_t *input, va_list *args)
Definition: format.h:232
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:1078
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
#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:1060
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:1037
clib_error_t * vnet_rename_interface(vnet_main_t *vnm, u32 hw_if_index, char *new_name)
Definition: interface.c:1422
vnet_interface_main_t interface_main
Definition: vnet.h:56
void * vnet_interface_output_node_multiarch_select(void)
serialize_function_t serialize_vnet_interface_state
#define NULL
Definition: clib.h:55
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:1250
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:1264
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
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
#define VNET_HW_INTERFACE_FLAG_LINK_UP
Definition: interface.h:458
void vnet_hw_interface_set_mtu(vnet_main_t *vnm, u32 hw_if_index, u32 mtu)
Definition: interface.c:720
struct _vnet_device_class vnet_device_class_t
clib_error_t * vnet_hw_interface_set_flags(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: interface.c:541
format_function_t format_vnet_sw_if_index_name
unsigned char u8
Definition: types.h:56
static vnet_sw_interface_t * vnet_get_hw_sw_interface(vnet_main_t *vnm, u32 hw_if_index)
enum walk_rc_t_ walk_rc_t
Walk return code.
vnet_hw_interface_rx_mode
Definition: interface.h:51
format_function_t format_vnet_hw_interface
i64 word
Definition: types.h:111
int vnet_hw_interface_rx_redirect_to_node(vnet_main_t *vnm, u32 hw_if_index, u32 node_index)
Definition: interface.c:1241
#define always_inline
Definition: clib.h:92
static vnet_device_class_t * vnet_get_device_class(vnet_main_t *vnm, u32 dev_class_index)
#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:182
u32 mtu[VNET_N_MTU]
Definition: interface.h:695
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:639
vnet_hw_interface_t * hw_interfaces
Definition: interface.h:788
#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:464
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)
serialize_function_t unserialize_vnet_interface_state
vnet_mtu_t
Definition: interface.h:640
void vlib_put_frame_to_node(vlib_main_t *vm, u32 to_node_index, vlib_frame_t *f)
Definition: main.c:191
format_function_t format_vnet_hw_interface_rx_mode
vnet_interface_output_error_t
u32 flags
Definition: vhost_user.h:110
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:1132
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:339
static vnet_sw_interface_t * vnet_get_sw_interface_safe(vnet_main_t *vnm, u32 sw_if_index)
static uword vnet_swif_is_api_visible(vnet_sw_interface_t *si)
static vnet_hw_interface_t * vnet_get_hw_interface_safe(vnet_main_t *vnm, u32 hw_if_index)
#define VNET_SW_INTERFACE_FLAG_HIDDEN
Definition: interface.h:673
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:271
void vnet_sw_interface_set_mtu(vnet_main_t *vnm, u32 sw_if_index, u32 mtu)
Definition: interface.c:676
static uword vnet_hw_interface_is_valid(vnet_main_t *vnm, u32 hw_if_index)
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:758
#define VNET_SW_INTERFACE_FLAG_ADMIN_UP
Definition: interface.h:661
#define ASSERT(truth)
long ctx[MAX_CONNS]
Definition: main.c:126
void vnet_sw_interface_update_unnumbered(u32 sw_if_index, u32 ip_sw_if_index, u8 enable)
Definition: interface.c:1510
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)
clib_error_t * vnet_hw_interface_set_class(vnet_main_t *vnm, u32 hw_if_index, u32 new_hw_class_index)
Definition: interface.c:1209
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:1276
clib_error_t * vnet_hw_interface_change_mac_address(vnet_main_t *vnm, u32 hw_if_index, u8 *mac_address)
Definition: interface.c:1501
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:688
struct _vnet_hw_interface_class vnet_hw_interface_class_t
void( serialize_function_t)(serialize_main_t *m, va_list *va)
Definition: serialize.h:168
unformat_function_t unformat_vnet_sw_interface_flags
u64 uword
Definition: types.h:112
vnet_sw_interface_t * sw_interfaces
Definition: interface.h:802
vnet_hw_interface_class_t * hw_interface_classes
Definition: interface.h:794
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:968
unformat_function_t unformat_vnet_hw_interface_flags
vnet_sw_interface_type_t type
Definition: interface.h:656
vnet_device_class_t * device_classes
Definition: interface.h:795
clib_error_t * vnet_create_sw_interface(vnet_main_t *vnm, vnet_sw_interface_t *template, u32 *sw_if_index)
Definition: interface.c:601
static uword vnet_sw_interface_get_flags(vnet_main_t *vnm, u32 sw_if_index)
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)
clib_error_t * vnet_sw_interface_set_flags(vnet_main_t *vnm, u32 sw_if_index, u32 flags)
Definition: interface.c:549
static uword vnet_sw_interface_is_api_visible(vnet_main_t *vnm, u32 sw_if_index)