FD.io VPP  v18.01.2-1-g9b554f3
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  return pool_elt_at_index (vnm->interface_main.sw_interfaces, sw_if_index);
53 }
54 
57 {
58  if (!pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
59  return pool_elt_at_index (vnm->interface_main.sw_interfaces, sw_if_index);
60  return (NULL);
61 }
62 
65 {
66  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
69  return sw;
70 }
71 
74 {
75  vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
76  if (sw->type == VNET_SW_INTERFACE_TYPE_SUB ||
78  sw = vnet_get_sw_interface (vnm, sw->sup_sw_if_index);
79  return sw;
80 }
81 
84 {
85  vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
87  return vnet_get_hw_interface (vnm, sw->hw_if_index);
88 }
89 
92 {
94  hw_class_index);
95 }
96 
98 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
99 {
101  dev_class_index);
102 }
103 
104 static inline u8 *
106 {
107  uword *p;
108  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
109  if (p)
110  return ((u8 *) p[0]);
111  return 0;
112 }
113 
114 static inline void
115 vnet_set_sw_interface_tag (vnet_main_t * vnm, u8 * tag, u32 sw_if_index)
116 {
117  uword *p;
118  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
119  if (p)
120  {
121  u8 *oldtag = (u8 *) p[0];
122  hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
123  vec_free (oldtag);
124  }
125 
126  hash_set (vnm->interface_tag_by_sw_if_index, sw_if_index, tag);
127 }
128 
129 static inline void
131 {
132  uword *p;
133  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
134  if (p)
135  {
136  u8 *oldtag = (u8 *) p[0];
137  hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
138  vec_free (oldtag);
139  }
140 }
141 
142 /**
143  * Call back walk type for walking SW indices on a HW interface
144  */
146  u32 sw_if_index, void *ctx);
147 
148 /**
149  * @brief
150  * Walk the SW interfaces on a HW interface - this is the super
151  * interface and any sub-interfaces.
152  */
154  u32 hw_if_index,
155  vnet_hw_sw_interface_walk_t fn, void *ctx);
156 
157 /* Register a hardware interface instance. */
159  u32 dev_class_index,
160  u32 dev_instance,
161  u32 hw_class_index, u32 hw_instance);
162 
163 /**
164  * Set interface output node - for interface registered without its output/tx
165  * nodes created because its VNET_DEVICE_CLASS did not specify any tx_function.
166  * This is typically the case for tunnel interfaces.
167  */
169  u32 hw_if_index, u32 node_index);
170 
171 /* Creates a software interface given template. */
173  vnet_sw_interface_t * template,
174  u32 * sw_if_index);
175 
176 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
177 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
178 int vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index);
179 
182 {
183  vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
184  return sw->flags;
185 }
186 
189 {
190  return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
192 }
193 
196 {
197  return !(si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN);
198 }
199 
202 {
203  vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
204  return vnet_swif_is_api_visible (si);
205 }
206 
209 {
210  return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index)
211  && vnet_sw_interface_is_api_visible (vnm, sw_if_index);
212 }
213 
216 {
217  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
218  return hw->flags;
219 }
220 
223  vlib_rx_or_tx_t dir)
224 {
225  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
226  return hw->max_l3_packet_bytes[dir];
227 }
228 
231  vlib_rx_or_tx_t dir)
232 {
233  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
234  return (hw->max_l3_packet_bytes[dir]);
235 }
236 
239 {
240  return (vnet_hw_interface_get_flags (vnm, hw_if_index) &
242 }
243 
246 {
247  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
249 }
250 
251 always_inline void
253  vlib_frame_t * f)
254 {
255  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
256  return vlib_put_frame_to_node (vnm->vlib_main, hw->output_node_index, f);
257 }
258 
259 /* Change interface flags (e.g. up, down, enable, disable). */
261  u32 flags);
262 
263 /* Change interface flags (e.g. up, down, enable, disable). */
265  u32 flags);
266 
267 /* Change interface class. */
269  u32 new_hw_class_index);
270 
271 /* Redirect rx pkts to node */
273  u32 node_index);
274 
275 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
276  u32 hw_class_index, u32 hw_instance);
277 
278 /* Rename interface */
280  char *new_name);
281 
282 /* Change interface mac address*/
284  u32 hw_if_index,
285  u8 * mac_address);
286 
287 /* Change rx-mode */
289  u32 hw_if_index,
290  u8 queue_id_valid,
291  u32 queue_id,
293  mode);
294 
295 /* Formats sw/hw interface. */
303 
304 /* Parses sw/hw interface name -> index. */
307 
308 /* Parses interface flags (up, down, enable, disable, etc.) */
311 
312 /* Node runtime for interface output function. */
313 typedef struct
314 {
320 
321 /* Interface output function. */
323 
324 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
325  uword sw_if_index1);
326 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
327  uword hw_if_index1);
328 
329 typedef enum
330 {
334 
335 typedef enum
336 {
340 
341 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
342 
343 typedef enum
344 {
348 
349 /* Format for interface output traces. */
350 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
351 
354 
355 #endif /* included_vnet_interface_funcs_h */
356 
357 /*
358  * fd.io coding-style-patch-verification: ON
359  *
360  * Local Variables:
361  * eval: (c-set-style "gnu")
362  * End:
363  */
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:231
void(* 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.
format_function_t format_vnet_sw_interface
#define hash_set(h, key, value)
Definition: hash.h:254
static uword vnet_hw_interface_get_mtu(vnet_main_t *vnm, u32 hw_if_index, vlib_rx_or_tx_t dir)
#define hash_unset(h, key)
Definition: hash.h:260
static uword vnet_sw_interface_get_mtu(vnet_main_t *vnm, u32 sw_if_index, vlib_rx_or_tx_t dir)
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:967
clib_error_t * vnet_rename_interface(vnet_main_t *vnm, u32 hw_if_index, char *new_name)
Definition: interface.c:1315
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
word vnet_sw_interface_compare(vnet_main_t *vnm, uword sw_if_index0, uword sw_if_index1)
Definition: interface.c:1142
static vnet_hw_interface_t * vnet_get_hw_interface(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:1156
static vnet_sw_interface_t * vnet_get_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
unformat_function_t unformat_vnet_sw_interface
uword * interface_tag_by_sw_if_index
Definition: vnet.h:70
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
#define VNET_HW_INTERFACE_FLAG_LINK_UP
Definition: interface.h:394
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:538
format_function_t format_vnet_sw_if_index_name
static vnet_sw_interface_t * vnet_get_hw_sw_interface(vnet_main_t *vnm, u32 hw_if_index)
vlib_rx_or_tx_t
Definition: defs.h:44
vnet_hw_interface_rx_mode
Definition: interface.h:51
format_function_t format_vnet_hw_interface
int vnet_hw_interface_rx_redirect_to_node(vnet_main_t *vnm, u32 hw_if_index, u32 node_index)
Definition: interface.c:1133
#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
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)
void vnet_delete_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
Definition: interface.c:636
vnet_hw_interface_t * hw_interfaces
Definition: interface.h:649
#define hash_get(h, key)
Definition: hash.h:248
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:459
u8 * format_vnet_interface_output_trace(u8 *s, va_list *va)
vlib_main_t * vlib_main
Definition: vnet.h:78
static uword vnet_hw_interface_get_flags(vnet_main_t *vnm, u32 hw_if_index)
serialize_function_t unserialize_vnet_interface_state
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
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:1024
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:336
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)
#define VNET_SW_INTERFACE_FLAG_HIDDEN
Definition: interface.h:588
vnet_interface_output_next_t
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:268
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:689
#define VNET_SW_INTERFACE_FLAG_ADMIN_UP
Definition: interface.h:576
u32 max_l3_packet_bytes[VLIB_N_RX_TX]
Definition: interface.h:472
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
long ctx[MAX_CONNS]
Definition: main.c:122
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:1101
static u8 * vnet_get_sw_interface_tag(vnet_main_t *vnm, u32 sw_if_index)
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:1168
clib_error_t * vnet_hw_interface_change_mac_address(vnet_main_t *vnm, u32 hw_if_index, u8 *mac_address)
Definition: interface.c:1394
static uword vnet_sw_interface_is_admin_up(vnet_main_t *vnm, u32 sw_if_index)
u64 uword
Definition: types.h:112
static uword vnet_sw_interface_is_api_valid(vnet_main_t *vnm, u32 sw_if_index)
i64 word
Definition: types.h:111
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
unsigned char u8
Definition: types.h:56
unformat_function_t unformat_vnet_sw_interface_flags
vnet_sw_interface_t * sw_interfaces
Definition: interface.h:663
vnet_hw_interface_class_t * hw_interface_classes
Definition: interface.h:655
void vnet_delete_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
Definition: interface.c:899
unformat_function_t unformat_vnet_hw_interface_flags
vnet_sw_interface_type_t type
Definition: interface.h:571
vnet_device_class_t * device_classes
Definition: interface.h:656
clib_error_t * vnet_create_sw_interface(vnet_main_t *vnm, vnet_sw_interface_t *template, u32 *sw_if_index)
Definition: interface.c:598
u32 flags
Definition: vhost-user.h:77
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:546
static uword vnet_sw_interface_is_api_visible(vnet_main_t *vnm, u32 sw_if_index)