FD.io VPP  v17.07-30-g839fa73
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);
77  sw = vnet_get_sw_interface (vnm, sw->sup_sw_if_index);
78  return sw;
79 }
80 
83 {
84  vnet_sw_interface_t *sw = vnet_get_sup_sw_interface (vnm, sw_if_index);
86  return vnet_get_hw_interface (vnm, sw->hw_if_index);
87 }
88 
91 {
93  hw_class_index);
94 }
95 
97 vnet_get_device_class (vnet_main_t * vnm, u32 dev_class_index)
98 {
100  dev_class_index);
101 }
102 
103 static inline u8 *
105 {
106  uword *p;
107  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
108  if (p)
109  return ((u8 *) p[0]);
110  return 0;
111 }
112 
113 static inline void
114 vnet_set_sw_interface_tag (vnet_main_t * vnm, u8 * tag, u32 sw_if_index)
115 {
116  uword *p;
117  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
118  if (p)
119  {
120  u8 *oldtag = (u8 *) p[0];
121  hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
122  vec_free (oldtag);
123  }
124 
125  hash_set (vnm->interface_tag_by_sw_if_index, sw_if_index, tag);
126 }
127 
128 static inline void
130 {
131  uword *p;
132  p = hash_get (vnm->interface_tag_by_sw_if_index, sw_if_index);
133  if (p)
134  {
135  u8 *oldtag = (u8 *) p[0];
136  hash_unset (vnm->interface_tag_by_sw_if_index, sw_if_index);
137  vec_free (oldtag);
138  }
139 }
140 
141 /**
142  * Call back walk type for walking SW indices on a HW interface
143  */
145  u32 sw_if_index, void *ctx);
146 
147 /**
148  * @brief
149  * Walk the SW interfaces on a HW interface - this is the super
150  * interface and any sub-interfaces.
151  */
153  u32 hw_if_index,
154  vnet_hw_sw_interface_walk_t fn, void *ctx);
155 
156 /* Register a hardware interface instance. */
158  u32 dev_class_index,
159  u32 dev_instance,
160  u32 hw_class_index, u32 hw_instance);
161 
162 /* Creates a software interface given template. */
164  vnet_sw_interface_t * template,
165  u32 * sw_if_index);
166 
167 void vnet_delete_hw_interface (vnet_main_t * vnm, u32 hw_if_index);
168 void vnet_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index);
169 int vnet_sw_interface_is_p2p (vnet_main_t * vnm, u32 sw_if_index);
170 
173 {
174  vnet_sw_interface_t *sw = vnet_get_sw_interface (vnm, sw_if_index);
175  return sw->flags;
176 }
177 
180 {
181  return (vnet_sw_interface_get_flags (vnm, sw_if_index) &
183 }
184 
187 {
188  return !(si->flags & VNET_SW_INTERFACE_FLAG_HIDDEN);
189 }
190 
193 {
194  vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
195  return vnet_swif_is_api_visible (si);
196 }
197 
200 {
201  return !pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index)
202  && vnet_sw_interface_is_api_visible (vnm, sw_if_index);
203 }
204 
207 {
208  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
209  return hw->flags;
210 }
211 
214  vlib_rx_or_tx_t dir)
215 {
216  vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
217  return hw->max_l3_packet_bytes[dir];
218 }
219 
222  vlib_rx_or_tx_t dir)
223 {
224  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
225  return (hw->max_l3_packet_bytes[dir]);
226 }
227 
230 {
231  return (vnet_hw_interface_get_flags (vnm, hw_if_index) &
233 }
234 
237 {
238  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
240 }
241 
242 always_inline void
244  vlib_frame_t * f)
245 {
246  vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
247  return vlib_put_frame_to_node (vnm->vlib_main, hw->output_node_index, f);
248 }
249 
250 /* Change interface flags (e.g. up, down, enable, disable). */
252  u32 flags);
253 
254 /* Change interface flags (e.g. up, down, enable, disable). */
256  u32 flags);
257 
258 /* Change interface class. */
260  u32 new_hw_class_index);
261 
262 /* Redirect rx pkts to node */
264  u32 node_index);
265 
266 void vnet_hw_interface_init_for_class (vnet_main_t * vnm, u32 hw_if_index,
267  u32 hw_class_index, u32 hw_instance);
268 
269 /* Rename interface */
271  char *new_name);
272 
273 /* Change interface mac address*/
275  u32 hw_if_index,
276  u64 mac_address);
277 
278 /* Formats sw/hw interface. */
286 
287 /* Parses sw/hw interface name -> index. */
290 
291 /* Parses interface flags (up, down, enable, disable, etc.) */
294 
295 /* Node runtime for interface output function. */
296 typedef struct
297 {
303 
304 /* Interface output functions. */
307 
308 word vnet_sw_interface_compare (vnet_main_t * vnm, uword sw_if_index0,
309  uword sw_if_index1);
310 word vnet_hw_interface_compare (vnet_main_t * vnm, uword hw_if_index0,
311  uword hw_if_index1);
312 
313 typedef enum
314 {
318 
319 typedef enum
320 {
324 
325 #define VNET_SIMULATED_ETHERNET_TX_NEXT_ETHERNET_INPUT VNET_INTERFACE_TX_N_NEXT
326 
327 typedef enum
328 {
332 
333 /* Format for interface output traces. */
334 u8 *format_vnet_interface_output_trace (u8 * s, va_list * va);
335 
338 
339 #endif /* included_vnet_interface_funcs_h */
340 
341 /*
342  * fd.io coding-style-patch-verification: ON
343  *
344  * Local Variables:
345  * eval: (c-set-style "gnu")
346  * End:
347  */
unformat_function_t unformat_vnet_hw_interface
vlib_frame_t * vlib_get_frame_to_node(vlib_main_t *vm, u32 to_node_index)
Definition: main.c:187
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:955
clib_error_t * vnet_rename_interface(vnet_main_t *vnm, u32 hw_if_index, char *new_name)
Definition: interface.c:1296
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:1130
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:1144
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:397
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:537
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
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:1121
#define always_inline
Definition: clib.h:84
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)
unsigned long u64
Definition: types.h:89
void vnet_delete_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
Definition: interface.c:635
vnet_hw_interface_t * hw_interfaces
Definition: interface.h:630
#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:397
u8 * format_vnet_interface_output_trace(u8 *s, va_list *va)
clib_error_t * vnet_hw_interface_change_mac_address(vnet_main_t *vnm, u32 hw_if_index, u64 mac_address)
Definition: interface.c:1374
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
format_function_t format_vnet_hw_interface_rx_mode
void * vnet_interface_output_node_flatten_multiarch_select(void)
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:1012
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:340
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:572
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:238
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:688
#define VNET_SW_INTERFACE_FLAG_ADMIN_UP
Definition: interface.h:560
u32 max_l3_packet_bytes[VLIB_N_RX_TX]
Definition: interface.h:468
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
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:1089
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:1156
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:644
vnet_hw_interface_class_t * hw_interface_classes
Definition: interface.h:636
void vnet_delete_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
Definition: interface.c:897
unformat_function_t unformat_vnet_hw_interface_flags
vnet_sw_interface_type_t type
Definition: interface.h:555
vnet_device_class_t * device_classes
Definition: interface.h:637
void vlib_put_frame_to_node(vlib_main_t *vm, u32 to_node_index, vlib_frame_t *f)
Definition: main.c:196
clib_error_t * vnet_create_sw_interface(vnet_main_t *vnm, vnet_sw_interface_t *template, u32 *sw_if_index)
Definition: interface.c:597
u32 flags
Definition: vhost-user.h:76
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:545
static uword vnet_sw_interface_is_api_visible(vnet_main_t *vnm, u32 sw_if_index)