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>
22 /** feature registration object */
23 typedef struct _vnet_feature_arc_registration
25 /** next registration in list of all registrations*/
26 struct _vnet_feature_arc_registration *next;
27 /** Feature Arc name */
32 /* Feature arc index, assigned by init function */
35 } vnet_feature_arc_registration_t;
37 /* Enable feature callback. */
38 typedef clib_error_t *(vnet_feature_enable_disable_function_t)
39 (u32 sw_if_index, int enable_disable);
41 /** feature registration object */
42 typedef struct _vnet_feature_registration
44 /** next registration in list of all registrations*/
45 struct _vnet_feature_registration *next;
46 /** Feature arc name */
48 /** Graph node name */
50 /** Pointer to this feature index, filled in by vnet_feature_arc_init */
51 u32 *feature_index_ptr;
53 /** Constraints of the form "this feature runs before X" */
55 /** Constraints of the form "this feature runs after Y" */
58 /** Function to enable/disable feature **/
59 vnet_feature_enable_disable_function_t *enable_disable_cb;
60 } vnet_feature_registration_t;
62 typedef struct vnet_feature_config_main_t_
64 vnet_config_main_t config_main;
65 u32 *config_index_by_sw_if_index;
66 } vnet_feature_config_main_t;
70 /** feature arc configuration list */
71 vnet_feature_arc_registration_t *next_arc;
72 uword **arc_index_by_name;
74 /** feature path configuration lists */
75 vnet_feature_registration_t *next_feature;
76 vnet_feature_registration_t **next_feature_by_arc;
77 uword **next_feature_by_name;
79 /** feature config main objects */
80 vnet_feature_config_main_t *feature_config_mains;
82 /** Save partial order results for show command */
83 char ***feature_nodes;
85 /** bitmap of interfaces which have driver rx features configured */
86 uword **sw_if_index_has_features;
88 /** feature reference counts by interface */
89 i16 **feature_count_by_sw_if_index;
91 /** Feature arc index for device-input */
92 u8 device_input_feature_arc_index;
95 vlib_main_t *vlib_main;
96 vnet_main_t *vnet_main;
97 } vnet_feature_main_t;
99 extern vnet_feature_main_t feature_main;
101 #define VNET_FEATURE_ARC_INIT(x,...) \
102 __VA_ARGS__ vnet_feature_arc_registration_t vnet_feat_arc_##x;\
103 static void __vnet_add_feature_arc_registration_##x (void) \
104 __attribute__((__constructor__)) ; \
105 static void __vnet_add_feature_arc_registration_##x (void) \
107 vnet_feature_main_t * fm = &feature_main; \
108 vnet_feat_arc_##x.next = fm->next_arc; \
109 fm->next_arc = & vnet_feat_arc_##x; \
111 __VA_ARGS__ vnet_feature_arc_registration_t vnet_feat_arc_##x
113 #define VNET_FEATURE_INIT(x,...) \
114 __VA_ARGS__ vnet_feature_registration_t vnet_feat_##x; \
115 static void __vnet_add_feature_registration_##x (void) \
116 __attribute__((__constructor__)) ; \
117 static void __vnet_add_feature_registration_##x (void) \
119 vnet_feature_main_t * fm = &feature_main; \
120 vnet_feat_##x.next = fm->next_feature; \
121 fm->next_feature = & vnet_feat_##x; \
123 __VA_ARGS__ vnet_feature_registration_t vnet_feat_##x
126 vnet_config_update_feature_count (vnet_feature_main_t * fm, u8 arc,
127 u32 sw_if_index, int is_add);
129 u32 vnet_get_feature_index (u8 arc, const char *s);
130 u8 vnet_get_feature_arc_index (const char *s);
131 vnet_feature_registration_t *vnet_get_feature_reg (const char *arc_name,
132 const char *node_name);
136 vnet_feature_enable_disable_with_index (u8 arc_index, u32 feature_index,
137 u32 sw_if_index, int enable_disable,
138 void *feature_config,
139 u32 n_feature_config_bytes);
142 vnet_feature_enable_disable (const char *arc_name, const char *node_name,
143 u32 sw_if_index, int enable_disable,
144 void *feature_config,
145 u32 n_feature_config_bytes);
147 static inline vnet_feature_config_main_t *
148 vnet_get_feature_arc_config_main (u8 arc_index)
150 vnet_feature_main_t *fm = &feature_main;
152 if (arc_index == (u8) ~ 0)
155 return &fm->feature_config_mains[arc_index];
158 static_always_inline vnet_feature_config_main_t *
159 vnet_feature_get_config_main (u16 arc)
161 vnet_feature_main_t *fm = &feature_main;
162 return &fm->feature_config_mains[arc];
165 static_always_inline int
166 vnet_have_features (u8 arc, u32 sw_if_index)
168 vnet_feature_main_t *fm = &feature_main;
169 return clib_bitmap_get (fm->sw_if_index_has_features[arc], sw_if_index);
172 static_always_inline u32
173 vnet_get_feature_config_index (u8 arc, u32 sw_if_index)
175 vnet_feature_main_t *fm = &feature_main;
176 vnet_feature_config_main_t *cm = &fm->feature_config_mains[arc];
177 return vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
180 static_always_inline void *
181 vnet_feature_arc_start_with_data (u8 arc, u32 sw_if_index, u32 * next,
182 vlib_buffer_t * b, u32 n_data_bytes)
184 vnet_feature_main_t *fm = &feature_main;
185 vnet_feature_config_main_t *cm;
186 cm = &fm->feature_config_mains[arc];
188 if (PREDICT_FALSE (vnet_have_features (arc, sw_if_index)))
190 b->feature_arc_index = arc;
191 b->current_config_index =
192 vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
193 return vnet_get_config_data (&cm->config_main, &b->current_config_index,
199 static_always_inline void
200 vnet_feature_arc_start (u8 arc, u32 sw_if_index, u32 * next0,
203 vnet_feature_arc_start_with_data (arc, sw_if_index, next0, b0, 0);
206 static_always_inline void *
207 vnet_feature_next_with_data (u32 sw_if_index, u32 * next0,
208 vlib_buffer_t * b0, u32 n_data_bytes)
210 vnet_feature_main_t *fm = &feature_main;
211 u8 arc = b0->feature_arc_index;
212 vnet_feature_config_main_t *cm = &fm->feature_config_mains[arc];
214 return vnet_get_config_data (&cm->config_main,
215 &b0->current_config_index, next0,
219 static_always_inline void
220 vnet_feature_next (u32 sw_if_index, u32 * next0, vlib_buffer_t * b0)
222 vnet_feature_next_with_data (sw_if_index, next0, b0, 0);
225 static_always_inline void
226 vnet_feature_start_device_input_x1 (u32 sw_if_index, u32 * next0,
227 vlib_buffer_t * b0, u16 buffer_advanced0)
229 vnet_feature_main_t *fm = &feature_main;
230 vnet_feature_config_main_t *cm;
231 u8 feature_arc_index = fm->device_input_feature_arc_index;
232 cm = &fm->feature_config_mains[feature_arc_index];
236 (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
239 * Save next0 so that the last feature in the chain
240 * can skip ethernet-input if indicated...
242 vnet_buffer (b0)->device_input_feat.saved_next_index = *next0;
243 vnet_buffer (b0)->device_input_feat.buffer_advance = buffer_advanced0;
244 vlib_buffer_advance (b0, -buffer_advanced0);
246 b0->feature_arc_index = feature_arc_index;
247 b0->current_config_index =
248 vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
249 vnet_get_config_data (&cm->config_main, &b0->current_config_index,
250 next0, /* # bytes of config data */ 0);
254 static_always_inline void
255 vnet_feature_start_device_input_x2 (u32 sw_if_index,
260 u16 buffer_advanced0,
261 u16 buffer_advanced1)
263 vnet_feature_main_t *fm = &feature_main;
264 vnet_feature_config_main_t *cm;
265 u8 feature_arc_index = fm->device_input_feature_arc_index;
266 cm = &fm->feature_config_mains[feature_arc_index];
270 (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
273 * Save next0 so that the last feature in the chain
274 * can skip ethernet-input if indicated...
276 vnet_buffer (b0)->device_input_feat.saved_next_index = *next0;
277 vnet_buffer (b1)->device_input_feat.saved_next_index = *next1;
278 vnet_buffer (b0)->device_input_feat.buffer_advance = buffer_advanced0;
279 vnet_buffer (b1)->device_input_feat.buffer_advance = buffer_advanced1;
280 vlib_buffer_advance (b0, -buffer_advanced0);
281 vlib_buffer_advance (b1, -buffer_advanced1);
283 b0->feature_arc_index = feature_arc_index;
284 b1->feature_arc_index = feature_arc_index;
285 b0->current_config_index =
286 vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
287 b1->current_config_index = b0->current_config_index;
288 vnet_get_config_data (&cm->config_main, &b0->current_config_index,
289 next0, /* # bytes of config data */ 0);
290 vnet_get_config_data (&cm->config_main, &b1->current_config_index,
291 next1, /* # bytes of config data */ 0);
295 static_always_inline void
296 vnet_feature_start_device_input_x4 (u32 sw_if_index,
305 u16 buffer_advanced0,
306 u16 buffer_advanced1,
307 u16 buffer_advanced2,
308 u16 buffer_advanced3)
310 vnet_feature_main_t *fm = &feature_main;
311 vnet_feature_config_main_t *cm;
312 u8 feature_arc_index = fm->device_input_feature_arc_index;
313 cm = &fm->feature_config_mains[feature_arc_index];
317 (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
320 * Save next0 so that the last feature in the chain
321 * can skip ethernet-input if indicated...
323 vnet_buffer (b0)->device_input_feat.saved_next_index = *next0;
324 vnet_buffer (b1)->device_input_feat.saved_next_index = *next1;
325 vnet_buffer (b2)->device_input_feat.saved_next_index = *next2;
326 vnet_buffer (b3)->device_input_feat.saved_next_index = *next3;
328 vnet_buffer (b0)->device_input_feat.buffer_advance = buffer_advanced0;
329 vnet_buffer (b1)->device_input_feat.buffer_advance = buffer_advanced1;
330 vnet_buffer (b2)->device_input_feat.buffer_advance = buffer_advanced2;
331 vnet_buffer (b3)->device_input_feat.buffer_advance = buffer_advanced3;
333 vlib_buffer_advance (b0, -buffer_advanced0);
334 vlib_buffer_advance (b1, -buffer_advanced1);
335 vlib_buffer_advance (b2, -buffer_advanced2);
336 vlib_buffer_advance (b3, -buffer_advanced3);
338 b0->feature_arc_index = feature_arc_index;
339 b1->feature_arc_index = feature_arc_index;
340 b2->feature_arc_index = feature_arc_index;
341 b3->feature_arc_index = feature_arc_index;
343 b0->current_config_index =
344 vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
345 b1->current_config_index = b0->current_config_index;
346 b2->current_config_index = b0->current_config_index;
347 b3->current_config_index = b0->current_config_index;
349 vnet_get_config_data (&cm->config_main, &b0->current_config_index,
350 next0, /* # bytes of config data */ 0);
351 vnet_get_config_data (&cm->config_main, &b1->current_config_index,
352 next1, /* # bytes of config data */ 0);
353 vnet_get_config_data (&cm->config_main, &b2->current_config_index,
354 next2, /* # bytes of config data */ 0);
355 vnet_get_config_data (&cm->config_main, &b3->current_config_index,
356 next3, /* # bytes of config data */ 0);
360 #define VNET_FEATURES(...) (char*[]) { __VA_ARGS__, 0}
362 clib_error_t *vnet_feature_arc_init (vlib_main_t * vm,
363 vnet_config_main_t * vcm,
364 char **feature_start_nodes,
365 int num_feature_start_nodes,
366 vnet_feature_registration_t *
367 first_reg, char ***feature_nodes);
369 void vnet_interface_features_show (vlib_main_t * vm, u32 sw_if_index);
371 #endif /* included_feature_h */
374 * fd.io coding-style-patch-verification: ON
377 * eval: (c-set-style "gnu")