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 #include <vnet/feature/feature.h>
17 #include <vnet/adj/adj.h>
19 vnet_feature_main_t feature_main;
22 vnet_feature_init (vlib_main_t * vm)
24 vnet_feature_main_t *fm = &feature_main;
25 vnet_feature_registration_t *freg;
26 vnet_feature_arc_registration_t *areg;
29 fm->arc_index_by_name = hash_create_string (0, sizeof (uword));
32 /* process feature arc registrations */
37 areg->feature_arc_index = arc_index;
38 if (areg->arc_index_ptr)
39 *areg->arc_index_ptr = arc_index;
40 hash_set_mem (fm->arc_index_by_name, areg->arc_name,
41 pointer_to_uword (areg));
43 /* process start nodes */
44 while ((s = areg->start_nodes[i]))
48 areg->n_start_nodes = i;
55 vec_validate (fm->next_feature_by_arc, arc_index - 1);
56 vec_validate (fm->feature_nodes, arc_index - 1);
57 vec_validate (fm->feature_config_mains, arc_index - 1);
58 vec_validate (fm->next_feature_by_name, arc_index - 1);
59 vec_validate (fm->sw_if_index_has_features, arc_index - 1);
60 vec_validate (fm->feature_count_by_sw_if_index, arc_index - 1);
62 freg = fm->next_feature;
65 vnet_feature_registration_t *next;
66 uword *p = hash_get_mem (fm->arc_index_by_name, freg->arc_name);
69 /* Don't start vpp with broken features arcs */
70 clib_warning ("Unknown feature arc '%s'", freg->arc_name);
74 areg = uword_to_pointer (p[0], vnet_feature_arc_registration_t *);
75 arc_index = areg->feature_arc_index;
78 freg->next_in_arc = fm->next_feature_by_arc[arc_index];
79 fm->next_feature_by_arc[arc_index] = freg;
89 vnet_feature_config_main_t *cm;
90 vnet_config_main_t *vcm;
92 arc_index = areg->feature_arc_index;
93 cm = &fm->feature_config_mains[arc_index];
94 vcm = &cm->config_main;
95 if ((error = vnet_feature_arc_init (vm, vcm,
98 fm->next_feature_by_arc[arc_index],
99 &fm->feature_nodes[arc_index])))
101 clib_error_report (error);
105 fm->next_feature_by_name[arc_index] =
106 hash_create_string (0, sizeof (uword));
107 freg = fm->next_feature_by_arc[arc_index];
111 hash_set_mem (fm->next_feature_by_name[arc_index],
112 freg->node_name, pointer_to_uword (freg));
113 freg = freg->next_in_arc;
124 VLIB_INIT_FUNCTION (vnet_feature_init);
127 vnet_get_feature_arc_index (const char *s)
129 vnet_feature_main_t *fm = &feature_main;
130 vnet_feature_arc_registration_t *reg;
133 p = hash_get_mem (fm->arc_index_by_name, s);
137 reg = uword_to_pointer (p[0], vnet_feature_arc_registration_t *);
138 return reg->feature_arc_index;
141 vnet_feature_registration_t *
142 vnet_get_feature_reg (const char *arc_name, const char *node_name)
146 arc_index = vnet_get_feature_arc_index (arc_name);
147 if (arc_index == (u8) ~ 0)
150 vnet_feature_main_t *fm = &feature_main;
151 vnet_feature_registration_t *reg;
154 p = hash_get_mem (fm->next_feature_by_name[arc_index], node_name);
158 reg = uword_to_pointer (p[0], vnet_feature_registration_t *);
163 vnet_get_feature_index (u8 arc, const char *s)
165 vnet_feature_main_t *fm = &feature_main;
166 vnet_feature_registration_t *reg;
172 p = hash_get_mem (fm->next_feature_by_name[arc], s);
176 reg = uword_to_pointer (p[0], vnet_feature_registration_t *);
177 return reg->feature_index;
181 vnet_feature_enable_disable_with_index (u8 arc_index, u32 feature_index,
182 u32 sw_if_index, int enable_disable,
183 void *feature_config,
184 u32 n_feature_config_bytes)
186 vnet_feature_main_t *fm = &feature_main;
187 vnet_feature_config_main_t *cm;
191 if (arc_index == (u8) ~ 0)
192 return VNET_API_ERROR_INVALID_VALUE;
194 if (feature_index == ~0)
195 return VNET_API_ERROR_INVALID_VALUE_2;
197 cm = &fm->feature_config_mains[arc_index];
198 vec_validate_init_empty (cm->config_index_by_sw_if_index, sw_if_index, ~0);
199 ci = cm->config_index_by_sw_if_index[sw_if_index];
201 vec_validate (fm->feature_count_by_sw_if_index[arc_index], sw_if_index);
202 feature_count = fm->feature_count_by_sw_if_index[arc_index][sw_if_index];
204 if (!enable_disable && feature_count < 1)
208 ? vnet_config_add_feature
209 : vnet_config_del_feature)
210 (vlib_get_main (), &cm->config_main, ci, feature_index, feature_config,
211 n_feature_config_bytes);
216 cm->config_index_by_sw_if_index[sw_if_index] = ci;
218 /* update feature count */
219 enable_disable = (enable_disable > 0);
220 feature_count += enable_disable ? 1 : -1;
221 ASSERT (feature_count >= 0);
223 fm->sw_if_index_has_features[arc_index] =
224 clib_bitmap_set (fm->sw_if_index_has_features[arc_index], sw_if_index,
225 (feature_count > 0));
226 adj_feature_update (sw_if_index, arc_index, (feature_count > 0));
228 fm->feature_count_by_sw_if_index[arc_index][sw_if_index] = feature_count;
233 vnet_feature_enable_disable (const char *arc_name, const char *node_name,
234 u32 sw_if_index, int enable_disable,
235 void *feature_config, u32 n_feature_config_bytes)
240 arc_index = vnet_get_feature_arc_index (arc_name);
242 if (arc_index == (u8) ~ 0)
243 return VNET_API_ERROR_INVALID_VALUE;
245 feature_index = vnet_get_feature_index (arc_index, node_name);
247 return vnet_feature_enable_disable_with_index (arc_index, feature_index,
248 sw_if_index, enable_disable,
250 n_feature_config_bytes);
254 feature_cmp (void *a1, void *a2)
256 vnet_feature_registration_t *reg1 = a1;
257 vnet_feature_registration_t *reg2 = a2;
259 return (int) reg1->feature_index - reg2->feature_index;
262 /** Display the set of available driver features.
263 Useful for verifying that expected features are present
266 static clib_error_t *
267 show_features_command_fn (vlib_main_t * vm,
268 unformat_input_t * input, vlib_cli_command_t * cmd)
270 vnet_feature_main_t *fm = &feature_main;
271 vnet_feature_arc_registration_t *areg;
272 vnet_feature_registration_t *freg;
273 vnet_feature_registration_t *feature_regs = 0;
276 if (unformat (input, "verbose"))
279 vlib_cli_output (vm, "Available feature paths");
285 vlib_cli_output (vm, "[%2d] %s:", areg->feature_arc_index,
288 vlib_cli_output (vm, "%s:", areg->arc_name);
290 freg = fm->next_feature_by_arc[areg->feature_arc_index];
293 vec_add1 (feature_regs, freg[0]);
294 freg = freg->next_in_arc;
297 vec_sort_with_function (feature_regs, feature_cmp);
299 vec_foreach (freg, feature_regs)
302 vlib_cli_output (vm, " [%2d]: %s\n", freg->feature_index,
305 vlib_cli_output (vm, " %s\n", freg->node_name);
307 vec_reset_length (feature_regs);
311 vec_free (feature_regs);
317 * Display the set of available driver features
321 * @cliexcmd{show features [verbose]}
326 VLIB_CLI_COMMAND (show_features_command, static) = {
327 .path = "show features",
328 .short_help = "show features",
329 .function = show_features_command_fn,
333 /** Display the set of driver features configured on a specific interface
334 * Called by "show interface" handler
338 vnet_interface_features_show (vlib_main_t * vm, u32 sw_if_index, int verbose)
340 vnet_feature_main_t *fm = &feature_main;
341 u32 node_index, current_config_index;
343 vnet_feature_config_main_t *cm = fm->feature_config_mains;
344 vnet_feature_arc_registration_t *areg;
345 vnet_config_main_t *vcm;
348 vnet_config_feature_t *feat;
352 vlib_cli_output (vm, "Feature paths configured on %U...",
353 format_vnet_sw_if_index_name,
354 vnet_get_main (), sw_if_index);
359 feature_arc = areg->feature_arc_index;
360 vcm = &(cm[feature_arc].config_main);
362 vlib_cli_output (vm, "\n%s:", areg->arc_name);
365 if (NULL == cm[feature_arc].config_index_by_sw_if_index ||
366 vec_len (cm[feature_arc].config_index_by_sw_if_index) <=
369 vlib_cli_output (vm, " none configured");
373 current_config_index =
374 vec_elt (cm[feature_arc].config_index_by_sw_if_index, sw_if_index);
376 if (current_config_index == ~0)
378 vlib_cli_output (vm, " none configured");
382 ASSERT (current_config_index
383 < vec_len (vcm->config_pool_index_by_user_index));
385 cfg_index = vcm->config_pool_index_by_user_index[current_config_index];
386 cfg = pool_elt_at_index (vcm->config_pool, cfg_index);
388 for (i = 0; i < vec_len (cfg->features); i++)
390 feat = cfg->features + i;
391 node_index = feat->node_index;
392 n = vlib_get_node (vm, node_index);
394 vlib_cli_output (vm, " [%2d] %v", feat->feature_index, n->name);
396 vlib_cli_output (vm, " %v", n->name);
401 static clib_error_t *
402 set_interface_features_command_fn (vlib_main_t * vm,
403 unformat_input_t * input,
404 vlib_cli_command_t * cmd)
406 vnet_main_t *vnm = vnet_get_main ();
407 unformat_input_t _line_input, *line_input = &_line_input;
408 clib_error_t *error = 0;
411 u8 *feature_name = 0;
412 u32 sw_if_index = ~0;
415 /* Get a line of input. */
416 if (!unformat_user (input, unformat_line_input, line_input))
419 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
422 (line_input, "%U %v", unformat_vnet_sw_interface, vnm, &sw_if_index,
425 else if (unformat (line_input, "arc %v", &arc_name))
427 else if (unformat (line_input, "disable"))
431 if (feature_name && arc_name)
433 error = unformat_parse_error (line_input);
438 if (sw_if_index == ~0)
440 error = clib_error_return (0, "Interface not specified...");
444 vec_add1 (arc_name, 0);
445 vec_add1 (feature_name, 0);
447 vnet_feature_registration_t *reg;
449 vnet_get_feature_reg ((const char *) arc_name,
450 (const char *) feature_name);
453 error = clib_error_return (0, "Unknown feature...");
456 if (reg->enable_disable_cb)
457 error = reg->enable_disable_cb (sw_if_index, enable);
459 vnet_feature_enable_disable ((const char *) arc_name,
460 (const char *) feature_name, sw_if_index,
464 vec_free (feature_name);
466 unformat_free (line_input);
471 * Set feature for given interface
475 * @cliexcmd{set interface feature GigabitEthernet2/0/0 ip4_flow_classify arc ip4_unicast}
480 VLIB_CLI_COMMAND (set_interface_feature_command, static) = {
481 .path = "set interface feature",
482 .short_help = "set interface feature <intfc> <feature_name> arc <arc_name> "
484 .function = set_interface_features_command_fn,
489 * fd.io coding-style-patch-verification: ON
492 * eval: (c-set-style "gnu")