FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
feature.h
Go to the documentation of this file.
1 /*
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:
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 #ifndef included_features_h
17 #define included_features_h
18 
19 #include <vnet/vnet.h>
20 #include <vnet/api_errno.h>
21 #include <vnet/devices/devices.h>
22 
23 /** feature registration object */
24 typedef struct _vnet_feature_arc_registration
25 {
26  /** next registration in list of all registrations*/
27  struct _vnet_feature_arc_registration *next;
28  /** Feature Arc name */
29  char *arc_name;
30  /** Start nodes */
31  char **start_nodes;
32  int n_start_nodes;
33  /** End of the arc (optional, for consistency-checking) */
34  char *last_in_arc;
35  /* Feature arc index, assigned by init function */
36  u8 feature_arc_index;
37  u8 *arc_index_ptr;
39 
40 /* Enable feature callback. */
42  (u32 sw_if_index, int enable_disable);
43 
44 /** feature registration object */
45 typedef struct _vnet_feature_registration
46 {
47  /** next registration in list of all registrations*/
48  struct _vnet_feature_registration *next, *next_in_arc;
49  /** Feature arc name */
50  char *arc_name;
51  /** Graph node name */
52  char *node_name;
53  /** Pointer to this feature index, filled in by vnet_feature_arc_init */
54  u32 *feature_index_ptr;
55  u32 feature_index;
56  /** Constraints of the form "this feature runs before X" */
57  char **runs_before;
58  /** Constraints of the form "this feature runs after Y" */
59  char **runs_after;
60 
61  /** Function to enable/disable feature **/
62  vnet_feature_enable_disable_function_t *enable_disable_cb;
64 
65 /** constraint registration object */
66 typedef struct _vnet_feature_constraint_registration
67 {
68  /** next constraint set in list of all registrations*/
69  struct _vnet_feature_constraint_registration *next, *next_in_arc;
70  /** Feature arc name */
71  char *arc_name;
72 
73  /** Feature arc index, assigned by init function */
74  u8 feature_arc_index;
75 
76  /** Node names, to run in the specified order */
77  char **node_names;
79 
81 {
85 
86 typedef struct
87 {
88  /** feature arc configuration list */
91 
92  /** feature path configuration lists */
98 
99  /** feature config main objects */
101 
102  /** Save partial order results for show command */
103  char ***feature_nodes;
104 
105  /** bitmap of interfaces which have driver rx features configured */
107 
108  /** feature reference counts by interface */
110 
111  /** Feature arc index for device-input */
113 
114  /** convenience */
118 
120 
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) \
127 { \
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; \
131 } \
132 static void __vnet_rm_feature_arc_registration_##x (void) \
133  __attribute__((__destructor__)) ; \
134 static void __vnet_rm_feature_arc_registration_##x (void) \
135 { \
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); \
139 } \
140 __VA_ARGS__ vnet_feature_arc_registration_t vnet_feat_arc_##x
141 
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) \
147 { \
148  vnet_feature_main_t * fm = &feature_main; \
149  vnet_feat_##x.next = fm->next_feature; \
150  fm->next_feature = & vnet_feat_##x; \
151 } \
152 static void __vnet_rm_feature_registration_##x (void) \
153  __attribute__((__destructor__)) ; \
154 static void __vnet_rm_feature_registration_##x (void) \
155 { \
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); \
159 } \
160 __VA_ARGS__ vnet_feature_registration_t vnet_feat_##x
161 
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) \
168 { \
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; \
172 } \
173 static void __vnet_rm_constraint_registration_##x (void) \
174  __attribute__((__destructor__)) ; \
175 static void __vnet_rm_constraint_registration_##x (void) \
176 { \
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); \
180 } \
181 __VA_ARGS__ vnet_feature_constraint_registration_t vnet_feature_constraint_##x
182 
183 #else
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
190 
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
196 
197 
198 #endif
199 
200 void
202  u32 sw_if_index, int is_add);
203 
204 u32 vnet_get_feature_index (u8 arc, const char *s);
205 u8 vnet_get_feature_arc_index (const char *s);
207  const char *node_name);
208 
209 
210 int
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);
215 
216 int
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);
221 
222 static inline vnet_feature_config_main_t *
224 {
226 
227  if (arc_index == (u8) ~ 0)
228  return 0;
229 
230  return &fm->feature_config_mains[arc_index];
231 }
232 
235 {
237  return &fm->feature_config_mains[arc];
238 }
239 
241 vnet_have_features (u8 arc, u32 sw_if_index)
242 {
244  return clib_bitmap_get (fm->sw_if_index_has_features[arc], sw_if_index);
245 }
246 
249 {
252  return vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
253 }
254 
256 vnet_feature_arc_start_with_data (u8 arc, u32 sw_if_index, u32 * next,
257  vlib_buffer_t * b, u32 n_data_bytes)
258 {
261  cm = &fm->feature_config_mains[arc];
262 
263  if (PREDICT_FALSE (vnet_have_features (arc, sw_if_index)))
264  {
265  vnet_buffer (b)->feature_arc_index = arc;
267  vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
269  next, n_data_bytes);
270  }
271  return 0;
272 }
273 
275 vnet_feature_arc_start (u8 arc, u32 sw_if_index, u32 * next0,
276  vlib_buffer_t * b0)
277 {
278  vnet_feature_arc_start_with_data (arc, sw_if_index, next0, b0, 0);
279 }
280 
283  u32 n_data_bytes)
284 {
286  u8 arc = vnet_buffer (b0)->feature_arc_index;
288 
289  return vnet_get_config_data (&cm->config_main,
290  &b0->current_config_index, next0,
291  n_data_bytes);
292 }
293 
296 {
297  vnet_feature_next_with_data (next0, b0, 0);
298 }
299 
302 {
304  return vnet_have_features (fm->device_input_feature_arc_index, sw_if_index);
305 }
306 
309  vlib_buffer_t * b0)
310 {
313  u8 feature_arc_index = fm->device_input_feature_arc_index;
314  cm = &fm->feature_config_mains[feature_arc_index];
315 
316  if (PREDICT_FALSE
318  (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
319  {
320  /*
321  * Save next0 so that the last feature in the chain
322  * can skip ethernet-input if indicated...
323  */
324  u16 adv;
325 
326  adv = device_input_next_node_advance[*next0];
327  vlib_buffer_advance (b0, -adv);
328 
329  vnet_buffer (b0)->feature_arc_index = feature_arc_index;
331  vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
333  next0, /* # bytes of config data */ 0);
334  }
335 }
336 
339  u32 * next0,
340  u32 * next1,
341  vlib_buffer_t * b0, vlib_buffer_t * b1)
342 {
345  u8 feature_arc_index = fm->device_input_feature_arc_index;
346  cm = &fm->feature_config_mains[feature_arc_index];
347 
348  if (PREDICT_FALSE
350  (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
351  {
352  /*
353  * Save next0 so that the last feature in the chain
354  * can skip ethernet-input if indicated...
355  */
356  u16 adv;
357 
358  adv = device_input_next_node_advance[*next0];
359  vlib_buffer_advance (b0, -adv);
360 
361  adv = device_input_next_node_advance[*next1];
362  vlib_buffer_advance (b1, -adv);
363 
364  vnet_buffer (b0)->feature_arc_index = feature_arc_index;
365  vnet_buffer (b1)->feature_arc_index = feature_arc_index;
367  vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
370  next0, /* # bytes of config data */ 0);
372  next1, /* # bytes of config data */ 0);
373  }
374 }
375 
378  u32 * next0,
379  u32 * next1,
380  u32 * next2,
381  u32 * next3,
382  vlib_buffer_t * b0,
383  vlib_buffer_t * b1,
384  vlib_buffer_t * b2, vlib_buffer_t * b3)
385 {
388  u8 feature_arc_index = fm->device_input_feature_arc_index;
389  cm = &fm->feature_config_mains[feature_arc_index];
390 
391  if (PREDICT_FALSE
393  (fm->sw_if_index_has_features[feature_arc_index], sw_if_index)))
394  {
395  /*
396  * Save next0 so that the last feature in the chain
397  * can skip ethernet-input if indicated...
398  */
399  u16 adv;
400 
401  adv = device_input_next_node_advance[*next0];
402  vlib_buffer_advance (b0, -adv);
403 
404  adv = device_input_next_node_advance[*next1];
405  vlib_buffer_advance (b1, -adv);
406 
407  adv = device_input_next_node_advance[*next2];
408  vlib_buffer_advance (b2, -adv);
409 
410  adv = device_input_next_node_advance[*next3];
411  vlib_buffer_advance (b3, -adv);
412 
413  vnet_buffer (b0)->feature_arc_index = feature_arc_index;
414  vnet_buffer (b1)->feature_arc_index = feature_arc_index;
415  vnet_buffer (b2)->feature_arc_index = feature_arc_index;
416  vnet_buffer (b3)->feature_arc_index = feature_arc_index;
417 
419  vec_elt (cm->config_index_by_sw_if_index, sw_if_index);
423 
425  next0, /* # bytes of config data */ 0);
427  next1, /* # bytes of config data */ 0);
429  next2, /* # bytes of config data */ 0);
431  next3, /* # bytes of config data */ 0);
432  }
433 }
434 
435 #define VNET_FEATURES(...) (char*[]) { __VA_ARGS__, 0}
436 
438  (vlib_main_t * vm,
439  vnet_config_main_t * vcm,
440  char **feature_start_nodes,
441  int num_feature_start_nodes,
442  vnet_feature_registration_t * first_reg,
443  vnet_feature_constraint_registration_t * first_const_set,
444  char ***in_feature_nodes);
445 
446 void vnet_interface_features_show (vlib_main_t * vm, u32 sw_if_index,
447  int verbose);
448 
449 #endif /* included_feature_h */
450 
451 /*
452  * fd.io coding-style-patch-verification: ON
453  *
454  * Local Variables:
455  * eval: (c-set-style "gnu")
456  * End:
457  */
vnet_config_main_t config_main
Definition: feature.h:82
struct vnet_feature_config_main_t_ vnet_feature_config_main_t
clib_error_t *() vnet_feature_enable_disable_function_t(u32 sw_if_index, int enable_disable)
Definition: feature.h:42
struct _vnet_feature_constraint_registration vnet_feature_constraint_registration_t
constraint registration object
const u32 device_input_next_node_advance[((VNET_DEVICE_INPUT_N_NEXT_NODES/CLIB_CACHE_LINE_BYTES)+1) *CLIB_CACHE_LINE_BYTES]
Definition: devices.c:47
char *** feature_nodes
Save partial order results for show command.
Definition: feature.h:103
vnet_feature_registration_t * next_feature
feature path configuration lists
Definition: feature.h:93
static_always_inline void vnet_feature_start_device_input_x4(u32 sw_if_index, u32 *next0, u32 *next1, u32 *next2, u32 *next3, vlib_buffer_t *b0, vlib_buffer_t *b1, vlib_buffer_t *b2, vlib_buffer_t *b3)
Definition: feature.h:377
static_always_inline int vnet_have_features(u8 arc, u32 sw_if_index)
Definition: feature.h:241
void vnet_config_update_feature_count(vnet_feature_main_t *fm, u8 arc, u32 sw_if_index, int is_add)
unsigned char u8
Definition: types.h:56
vnet_main_t * vnet_main
Definition: feature.h:116
#define fm
vnet_feature_constraint_registration_t * next_constraint
Definition: feature.h:95
#define static_always_inline
Definition: clib.h:99
u8 vnet_get_feature_arc_index(const char *s)
Definition: feature.c:168
vlib_main_t * vlib_main
convenience
Definition: feature.h:115
static_always_inline int vnet_device_input_have_features(u32 sw_if_index)
Definition: feature.h:301
void vnet_interface_features_show(vlib_main_t *vm, u32 sw_if_index, int verbose)
Display the set of driver features configured on a specific interface Called by "show interface" hand...
Definition: feature.c:379
clib_error_t * vnet_feature_arc_init(vlib_main_t *vm, vnet_config_main_t *vcm, char **feature_start_nodes, int num_feature_start_nodes, vnet_feature_registration_t *first_reg, vnet_feature_constraint_registration_t *first_const_set, char ***in_feature_nodes)
Initialize a feature graph arc.
Definition: registration.c:121
vnet_feature_main_t feature_main
Definition: feature.c:19
unsigned int u32
Definition: types.h:88
static_always_inline void * vnet_feature_next_with_data(u32 *next0, vlib_buffer_t *b0, u32 n_data_bytes)
Definition: feature.h:282
unsigned short u16
Definition: types.h:57
static void * vnet_get_config_data(vnet_config_main_t *cm, u32 *config_index, u32 *next_index, u32 n_data_bytes)
Definition: config.h:122
#define PREDICT_FALSE(x)
Definition: clib.h:111
uword ** next_feature_by_name
Definition: feature.h:97
static_always_inline void vnet_feature_start_device_input_x2(u32 sw_if_index, u32 *next0, u32 *next1, vlib_buffer_t *b0, vlib_buffer_t *b1)
Definition: feature.h:338
int vnet_feature_enable_disable_with_index(u8 arc_index, u32 feature_index, u32 sw_if_index, int enable_disable, void *feature_config, u32 n_feature_config_bytes)
Definition: feature.c:222
vlib_main_t * vm
Definition: buffer.c:312
static_always_inline void vnet_feature_next(u32 *next0, vlib_buffer_t *b0)
Definition: feature.h:295
u32 vnet_get_feature_index(u8 arc, const char *s)
Definition: feature.c:204
u32 current_config_index
Used by feature subgraph arcs to visit enabled feature nodes.
Definition: buffer.h:147
static uword clib_bitmap_get(uword *ai, uword i)
Gets the ith bit value from a bitmap.
Definition: bitmap.h:197
vnet_feature_constraint_registration_t ** next_constraint_by_arc
Definition: feature.h:96
uword ** arc_index_by_name
Definition: feature.h:90
i16 ** feature_count_by_sw_if_index
feature reference counts by interface
Definition: feature.h:109
u8 is_add
Definition: ipsec_gre.api:36
vnet_feature_registration_t ** next_feature_by_arc
Definition: feature.h:94
static void vlib_buffer_advance(vlib_buffer_t *b, word l)
Advance current data pointer by the supplied (signed!) amount.
Definition: buffer.h:248
int vnet_feature_enable_disable(const char *arc_name, const char *node_name, u32 sw_if_index, int enable_disable, void *feature_config, u32 n_feature_config_bytes)
Definition: feature.c:274
#define vec_elt(v, i)
Get vector value at index i.
u8 device_input_feature_arc_index
Feature arc index for device-input.
Definition: feature.h:112
static_always_inline u32 vnet_get_feature_config_index(u8 arc, u32 sw_if_index)
Definition: feature.h:248
static_always_inline void * vnet_feature_arc_start_with_data(u8 arc, u32 sw_if_index, u32 *next, vlib_buffer_t *b, u32 n_data_bytes)
Definition: feature.h:256
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static vnet_feature_config_main_t * vnet_get_feature_arc_config_main(u8 arc_index)
Definition: feature.h:223
struct _vnet_feature_arc_registration vnet_feature_arc_registration_t
feature registration object
#define vnet_buffer(b)
Definition: buffer.h:369
vnet_feature_arc_registration_t * next_arc
feature arc configuration list
Definition: feature.h:89
static_always_inline void vnet_feature_start_device_input_x1(u32 sw_if_index, u32 *next0, vlib_buffer_t *b0)
Definition: feature.h:308
uword ** sw_if_index_has_features
bitmap of interfaces which have driver rx features configured
Definition: feature.h:106
vnet_feature_registration_t * vnet_get_feature_reg(const char *arc_name, const char *node_name)
Definition: feature.c:183
vnet_feature_config_main_t * feature_config_mains
feature config main objects
Definition: feature.h:100
static_always_inline vnet_feature_config_main_t * vnet_feature_get_config_main(u16 arc)
Definition: feature.h:234
struct _vnet_feature_registration vnet_feature_registration_t
feature registration object
signed short i16
Definition: types.h:46
static_always_inline void vnet_feature_arc_start(u8 arc, u32 sw_if_index, u32 *next0, vlib_buffer_t *b0)
Definition: feature.h:275