2 * Copyright (c) 2016 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 #ifndef included_features_h
17 #define included_features_h
19 #include <vnet/vnet.h>
20 #include <vnet/api_errno.h>
21 #include <vnet/devices/devices.h>
23 /** feature registration object */
24 typedef struct _vnet_feature_arc_registration
26 /** next registration in list of all registrations*/
27 struct _vnet_feature_arc_registration *next;
28 /** Feature Arc name */
33 /** End of the arc (optional, for consistency-checking) */
35 /* Feature arc index, assigned by init function */
38 } vnet_feature_arc_registration_t;
40 /* Enable feature callback. */
41 typedef clib_error_t *(vnet_feature_enable_disable_function_t)
42 (u32 sw_if_index, int enable_disable);
44 /** feature registration object */
45 typedef struct _vnet_feature_registration
47 /** next registration in list of all registrations*/
48 struct _vnet_feature_registration *next, *next_in_arc;
49 /** Feature arc name */
51 /** Graph node name */
53 /** Pointer to this feature index, filled in by vnet_feature_arc_init */
54 u32 *feature_index_ptr;
56 /** Constraints of the form "this feature runs before X" */
58 /** Constraints of the form "this feature runs after Y" */
61 /** Function to enable/disable feature **/
62 vnet_feature_enable_disable_function_t *enable_disable_cb;
63 } vnet_feature_registration_t;
65 /** constraint registration object */
66 typedef struct _vnet_feature_constraint_registration
68 /** next constraint set in list of all registrations*/
69 struct _vnet_feature_constraint_registration *next, *next_in_arc;
70 /** Feature arc name */
73 /** Feature arc index, assigned by init function */
76 /** Node names, to run in the specified order */
78 } vnet_feature_constraint_registration_t;
80 typedef struct vnet_feature_config_main_t_
82 vnet_config_main_t config_main;
83 u32 *config_index_by_sw_if_index;
84 } vnet_feature_config_main_t;
88 /** feature arc configuration list */
89 vnet_feature_arc_registration_t *next_arc;
90 uword **arc_index_by_name;
92 /** feature path configuration lists */
93 vnet_feature_registration_t *next_feature;
94 vnet_feature_registration_t **next_feature_by_arc;
95 vnet_feature_constraint_registration_t *next_constraint;
96 vnet_feature_constraint_registration_t **next_constraint_by_arc;
97 uword **next_feature_by_name;
99 /** feature config main objects */
100 vnet_feature_config_main_t *feature_config_mains;
102 /** Save partial order results for show command */
103 char ***feature_nodes;
105 /** bitmap of interfaces which have driver rx features configured */
106 uword **sw_if_index_has_features;
108 /** feature reference counts by interface */
109 i16 **feature_count_by_sw_if_index;
111 /** Feature arc index for device-input */
112 u8 device_input_feature_arc_index;
115 vlib_main_t *vlib_main;
116 vnet_main_t *vnet_main;
117 } vnet_feature_main_t;
119 extern vnet_feature_main_t feature_main;
121 #ifndef CLIB_MARCH_VARIANT
122 #define VNET_FEATURE_ARC_INIT(x,...) \
123 __VA_ARGS__ vnet_feature_arc_registration_t vnet_feat_arc_##x;\
124 static void __vnet_add_feature_arc_registration_##x (void) \
125 __attribute__((__constructor__)) ; \
126 static void __vnet_add_feature_arc_registration_##x (void) \
128 vnet_feature_main_t * fm = &feature_main; \
129 vnet_feat_arc_##x.next = fm->next_arc; \
130 fm->next_arc = & vnet_feat_arc_##x; \
132 static void __vnet_rm_feature_arc_registration_##x (void) \
133 __attribute__((__destructor__)) ; \
134 static void __vnet_rm_feature_arc_registration_##x (void) \
136 vnet_feature_main_t * fm = &feature_main; \
137 vnet_feature_arc_registration_t *r = &vnet_feat_arc_##x; \
138 VLIB_REMOVE_FROM_LINKED_LIST (fm->next_arc, r, next); \
140 __VA_ARGS__ vnet_feature_arc_registration_t vnet_feat_arc_##x
142 #define VNET_FEATURE_INIT(x,...) \
143 __VA_ARGS__ vnet_feature_registration_t vnet_feat_##x; \
144 static void __vnet_add_feature_registration_##x (void) \
145 __attribute__((__constructor__)) ; \
146 static void __vnet_add_feature_registration_##x (void) \
148 vnet_feature_main_t * fm = &feature_main; \
149 vnet_feat_##x.next = fm->next_feature; \
150 fm->next_feature = & vnet_feat_##x; \
152 static void __vnet_rm_feature_registration_##x (void) \
153 __attribute__((__destructor__)) ; \
154 static void __vnet_rm_feature_registration_##x (void) \
156 vnet_feature_main_t * fm = &feature_main; \
157 vnet_feature_registration_t *r = &vnet_feat_##x; \
158 VLIB_REMOVE_FROM_LINKED_LIST (fm->next_feature, r, next); \
160 __VA_ARGS__ vnet_feature_registration_t vnet_feat_##x
162 #define VNET_FEATURE_ARC_ORDER(x,...) \
163 __VA_ARGS__ vnet_feature_constraint_registration_t \
164 vnet_feature_constraint_##x; \
165 static void __vnet_add_constraint_registration_##x (void) \
166 __attribute__((__constructor__)) ; \
167 static void __vnet_add_constraint_registration_##x (void) \
169 vnet_feature_main_t * fm = &feature_main; \
170 vnet_feature_constraint_##x.next = fm->next_constraint; \
171 fm->next_constraint = & vnet_feature_constraint_##x; \
173 static void __vnet_rm_constraint_registration_##x (void) \
174 __attribute__((__destructor__)) ; \
175 static void __vnet_rm_constraint_registration_##x (void) \
177 vnet_feature_main_t * fm = &feature_main; \
178 vnet_feature_constraint_registration_t *r = &vnet_feature_constraint_##x; \
179 VLIB_REMOVE_FROM_LINKED_LIST (fm->next_constraint, r, next); \
181 __VA_ARGS__ vnet_feature_constraint_registration_t vnet_feature_constraint_##x
184 #define VNET_FEATURE_ARC_INIT(x,...) \
185 extern vnet_feature_arc_registration_t __clib_unused vnet_feat_arc_##x; \
186 static vnet_feature_arc_registration_t __clib_unused __clib_unused_vnet_feat_arc_##x
187 #define VNET_FEATURE_INIT(x,...) \
188 extern vnet_feature_registration_t __clib_unused vnet_feat_##x; \
189 static vnet_feature_registration_t __clib_unused __clib_unused_vnet_feat_##x
191 #define VNET_FEATURE_ARC_ORDER(x,...) \
192 extern vnet_feature_constraint_registration_t \
193 __clib_unused vnet_feature_constraint_##x; \
194 static vnet_feature_constraint_registration_t __clib_unused \
195 __clib_unused_vnet_feature_constraint_##x
201 vnet_config_update_feature_count (vnet_feature_main_t * fm, u8 arc,
202 u32 sw_if_index, int is_add);
204 u32 vnet_get_feature_index (u8 arc, const char *s);
205 u8 vnet_get_feature_arc_index (const char *s);
206 vnet_feature_registration_t *vnet_get_feature_reg (const char *arc_name,
207 const char *node_name);
211 vnet_feature_enable_disable_with_index (u8 arc_index, u32 feature_index,
212 u32 sw_if_index, int enable_disable,
213 void *feature_config,
214 u32 n_feature_config_bytes);
217 vnet_feature_enable_disable (const char *arc_name, const char *node_name,
218 u32 sw_if_index, int enable_disable,
219 void *feature_config,
220 u32 n_feature_config_bytes);
223 vnet_feature_modify_end_node (u8 arc_index, u32 sw_if_index, u32 node_index);
225 static_always_inline u32
226 vnet_get_feature_count (u8 arc, u32 sw_if_index)
228 vnet_feature_main_t *fm = &feature_main;
229 return (fm->feature_count_by_sw_if_index[arc][sw_if_index]);
232 static inline vnet_feature_config_main_t *
233 vnet_get_feature_arc_config_main (u8 arc_index)
235 vnet_feature_main_t *fm = &feature_main;
237 if (arc_index == (u8) ~ 0)
240 return &fm->feature_config_mains[arc_index];
243 static_always_inline vnet_feature_config_main_t *
244 vnet_feature_get_config_main (u16 arc)
246 vnet_feature_main_t *fm = &feature_main;
247 return &fm->feature_config_mains[arc];
250 static_always_inline int
251 vnet_have_features (u8 arc, u32 sw_if_index)
253 vnet_feature_main_t *fm = &feature_main;
254 return clib_bitmap_get (fm->sw_if_index_has_features[arc], sw_if_index);
257 static_always_inline u32
258 vnet_get_feature_config_index (u8 arc, u32 sw_if_index)
260 vnet_feature_main_t *fm = &feature_main;
261 vnet_feature_config_main_t *cm = &fm->feature_config_mains[arc];
262 return vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
265 static_always_inline void *
266 vnet_feature_arc_start_with_data (u8 arc, u32 sw_if_index, u32 * next,
267 vlib_buffer_t * b, u32 n_data_bytes)
269 vnet_feature_main_t *fm = &feature_main;
270 vnet_feature_config_main_t *cm;
271 cm = &fm->feature_config_mains[arc];
273 if (PREDICT_FALSE (vnet_have_features (arc, sw_if_index)))
275 vnet_buffer (b)->feature_arc_index = arc;
276 b->current_config_index =
277 vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
278 return vnet_get_config_data (&cm->config_main, &b->current_config_index,
284 static_always_inline void *
285 vnet_feature_arc_start_w_cfg_index (u8 arc,
288 vlib_buffer_t * b, u32 cfg_index)
290 vnet_feature_main_t *fm = &feature_main;
291 vnet_feature_config_main_t *cm;
292 cm = &fm->feature_config_mains[arc];
294 vnet_buffer (b)->feature_arc_index = arc;
295 b->current_config_index = cfg_index;
297 return vnet_get_config_data (&cm->config_main, &b->current_config_index,
301 static_always_inline void
302 vnet_feature_arc_start (u8 arc, u32 sw_if_index, u32 * next0,
305 vnet_feature_arc_start_with_data (arc, sw_if_index, next0, b0, 0);
308 static_always_inline void *
309 vnet_feature_next_with_data (u32 * next0, vlib_buffer_t * b0,
312 vnet_feature_main_t *fm = &feature_main;
313 u8 arc = vnet_buffer (b0)->feature_arc_index;
314 vnet_feature_config_main_t *cm = &fm->feature_config_mains[arc];
316 return vnet_get_config_data (&cm->config_main,
317 &b0->current_config_index, next0,
321 static_always_inline void
322 vnet_feature_next (u32 * next0, vlib_buffer_t * b0)
324 vnet_feature_next_with_data (next0, b0, 0);
327 static_always_inline void
328 vnet_feature_next_u16 (u16 * next0, vlib_buffer_t * b0)
331 vnet_feature_next_with_data (&next32, b0, 0);
335 static_always_inline int
336 vnet_device_input_have_features (u32 sw_if_index)
338 vnet_feature_main_t *fm = &feature_main;
339 return vnet_have_features (fm->device_input_feature_arc_index, sw_if_index);
342 static_always_inline void
343 vnet_feature_start_device_input_x1 (u32 sw_if_index, u32 * next0,
346 vnet_feature_main_t *fm = &feature_main;
347 vnet_feature_config_main_t *cm;
348 u8 feature_arc_index = fm->device_input_feature_arc_index;
349 cm = &fm->feature_config_mains[feature_arc_index];
353 (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
356 * Save next0 so that the last feature in the chain
357 * can skip ethernet-input if indicated...
361 adv = device_input_next_node_advance[*next0];
362 vlib_buffer_advance (b0, -adv);
364 vnet_buffer (b0)->feature_arc_index = feature_arc_index;
365 b0->current_config_index =
366 vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
367 vnet_get_config_data (&cm->config_main, &b0->current_config_index,
368 next0, /* # bytes of config data */ 0);
372 static_always_inline void
373 vnet_feature_start_device_input_x2 (u32 sw_if_index,
376 vlib_buffer_t * b0, vlib_buffer_t * b1)
378 vnet_feature_main_t *fm = &feature_main;
379 vnet_feature_config_main_t *cm;
380 u8 feature_arc_index = fm->device_input_feature_arc_index;
381 cm = &fm->feature_config_mains[feature_arc_index];
385 (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
388 * Save next0 so that the last feature in the chain
389 * can skip ethernet-input if indicated...
393 adv = device_input_next_node_advance[*next0];
394 vlib_buffer_advance (b0, -adv);
396 adv = device_input_next_node_advance[*next1];
397 vlib_buffer_advance (b1, -adv);
399 vnet_buffer (b0)->feature_arc_index = feature_arc_index;
400 vnet_buffer (b1)->feature_arc_index = feature_arc_index;
401 b0->current_config_index =
402 vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
403 b1->current_config_index = b0->current_config_index;
404 vnet_get_config_data (&cm->config_main, &b0->current_config_index,
405 next0, /* # bytes of config data */ 0);
406 vnet_get_config_data (&cm->config_main, &b1->current_config_index,
407 next1, /* # bytes of config data */ 0);
411 static_always_inline void
412 vnet_feature_start_device_input_x4 (u32 sw_if_index,
419 vlib_buffer_t * b2, vlib_buffer_t * b3)
421 vnet_feature_main_t *fm = &feature_main;
422 vnet_feature_config_main_t *cm;
423 u8 feature_arc_index = fm->device_input_feature_arc_index;
424 cm = &fm->feature_config_mains[feature_arc_index];
428 (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
431 * Save next0 so that the last feature in the chain
432 * can skip ethernet-input if indicated...
436 adv = device_input_next_node_advance[*next0];
437 vlib_buffer_advance (b0, -adv);
439 adv = device_input_next_node_advance[*next1];
440 vlib_buffer_advance (b1, -adv);
442 adv = device_input_next_node_advance[*next2];
443 vlib_buffer_advance (b2, -adv);
445 adv = device_input_next_node_advance[*next3];
446 vlib_buffer_advance (b3, -adv);
448 vnet_buffer (b0)->feature_arc_index = feature_arc_index;
449 vnet_buffer (b1)->feature_arc_index = feature_arc_index;
450 vnet_buffer (b2)->feature_arc_index = feature_arc_index;
451 vnet_buffer (b3)->feature_arc_index = feature_arc_index;
453 b0->current_config_index =
454 vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
455 b1->current_config_index = b0->current_config_index;
456 b2->current_config_index = b0->current_config_index;
457 b3->current_config_index = b0->current_config_index;
459 vnet_get_config_data (&cm->config_main, &b0->current_config_index,
460 next0, /* # bytes of config data */ 0);
461 vnet_get_config_data (&cm->config_main, &b1->current_config_index,
462 next1, /* # bytes of config data */ 0);
463 vnet_get_config_data (&cm->config_main, &b2->current_config_index,
464 next2, /* # bytes of config data */ 0);
465 vnet_get_config_data (&cm->config_main, &b3->current_config_index,
466 next3, /* # bytes of config data */ 0);
470 #define VNET_FEATURES(...) (char*[]) { __VA_ARGS__, 0}
472 clib_error_t *vnet_feature_arc_init
474 vnet_config_main_t * vcm,
475 char **feature_start_nodes,
476 int num_feature_start_nodes,
478 vnet_feature_registration_t * first_reg,
479 vnet_feature_constraint_registration_t * first_const_set,
480 char ***in_feature_nodes);
482 void vnet_interface_features_show (vlib_main_t * vm, u32 sw_if_index,
485 typedef void (*vnet_feature_update_cb_t) (u32 sw_if_index,
487 u8 is_enable, void *cb);
489 extern void vnet_feature_register (vnet_feature_update_cb_t cb, void *data);
492 vnet_feature_is_enabled (const char *arc_name, const char *feature_node_name,
495 #endif /* included_feature_h */
498 * fd.io coding-style-patch-verification: ON
501 * eval: (c-set-style "gnu")