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);
68 return clib_error_return (0, "Unknown feature arc '%s'",
71 areg = uword_to_pointer (p[0], vnet_feature_arc_registration_t *);
72 arc_index = areg->feature_arc_index;
75 freg->next = fm->next_feature_by_arc[arc_index];
76 fm->next_feature_by_arc[arc_index] = freg;
86 vnet_feature_config_main_t *cm;
87 vnet_config_main_t *vcm;
89 arc_index = areg->feature_arc_index;
90 cm = &fm->feature_config_mains[arc_index];
91 vcm = &cm->config_main;
92 if ((error = vnet_feature_arc_init (vm, vcm,
95 fm->next_feature_by_arc[arc_index],
96 &fm->feature_nodes[arc_index])))
101 fm->next_feature_by_name[arc_index] =
102 hash_create_string (0, sizeof (uword));
103 freg = fm->next_feature_by_arc[arc_index];
107 hash_set_mem (fm->next_feature_by_name[arc_index],
108 freg->node_name, pointer_to_uword (freg));
112 cm->end_feature_index =
113 vnet_get_feature_index (arc_index, areg->end_node);
123 VLIB_INIT_FUNCTION (vnet_feature_init);
126 vnet_get_feature_arc_index (const char *s)
128 vnet_feature_main_t *fm = &feature_main;
129 vnet_feature_arc_registration_t *reg;
132 p = hash_get_mem (fm->arc_index_by_name, s);
136 reg = uword_to_pointer (p[0], vnet_feature_arc_registration_t *);
137 return reg->feature_arc_index;
140 vnet_feature_registration_t *
141 vnet_get_feature_reg (const char *arc_name, const char *node_name)
145 arc_index = vnet_get_feature_arc_index (arc_name);
146 if (arc_index == (u8) ~ 0)
149 vnet_feature_main_t *fm = &feature_main;
150 vnet_feature_registration_t *reg;
153 p = hash_get_mem (fm->next_feature_by_name[arc_index], node_name);
157 reg = uword_to_pointer (p[0], vnet_feature_registration_t *);
162 vnet_get_feature_index (u8 arc, const char *s)
164 vnet_feature_main_t *fm = &feature_main;
165 vnet_feature_registration_t *reg;
171 p = hash_get_mem (fm->next_feature_by_name[arc], s);
175 reg = uword_to_pointer (p[0], vnet_feature_registration_t *);
176 return reg->feature_index;
180 vnet_feature_enable_disable_with_index (u8 arc_index, u32 feature_index,
181 u32 sw_if_index, int enable_disable,
182 void *feature_config,
183 u32 n_feature_config_bytes)
185 vnet_feature_main_t *fm = &feature_main;
186 vnet_feature_config_main_t *cm;
188 int is_first_or_last;
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);
212 cm->config_index_by_sw_if_index[sw_if_index] = ci;
214 /* update feature count */
215 enable_disable = (enable_disable > 0);
216 feature_count += enable_disable ? 1 : -1;
217 is_first_or_last = (feature_count == enable_disable);
218 ASSERT (feature_count >= 0);
220 if (is_first_or_last && cm->end_feature_index != ~0)
222 /*register end node */
224 ? vnet_config_add_feature
225 : vnet_config_del_feature)
226 (vlib_get_main (), &cm->config_main, ci, cm->end_feature_index, 0, 0);
227 cm->config_index_by_sw_if_index[sw_if_index] = ci;
230 fm->sw_if_index_has_features[arc_index] =
231 clib_bitmap_set (fm->sw_if_index_has_features[arc_index], sw_if_index,
232 (feature_count > 0));
233 adj_feature_update (sw_if_index, arc_index, (feature_count > 0));
235 fm->feature_count_by_sw_if_index[arc_index][sw_if_index] = feature_count;
240 vnet_feature_enable_disable (const char *arc_name, const char *node_name,
241 u32 sw_if_index, int enable_disable,
242 void *feature_config, u32 n_feature_config_bytes)
247 arc_index = vnet_get_feature_arc_index (arc_name);
249 if (arc_index == (u8) ~ 0)
250 return VNET_API_ERROR_INVALID_VALUE;
252 feature_index = vnet_get_feature_index (arc_index, node_name);
254 return vnet_feature_enable_disable_with_index (arc_index, feature_index,
255 sw_if_index, enable_disable,
257 n_feature_config_bytes);
261 /** Display the set of available driver features.
262 Useful for verifying that expected features are present
265 static clib_error_t *
266 show_features_command_fn (vlib_main_t * vm,
267 unformat_input_t * input, vlib_cli_command_t * cmd)
269 vnet_feature_main_t *fm = &feature_main;
270 vnet_feature_arc_registration_t *areg;
271 vnet_feature_registration_t *freg;
273 vlib_cli_output (vm, "Available feature paths");
278 vlib_cli_output (vm, "%s:", areg->arc_name);
279 freg = fm->next_feature_by_arc[areg->feature_arc_index];
282 vlib_cli_output (vm, " %s\n", freg->node_name);
295 * Display the set of available driver features
299 * @cliexcmd{show ip features}
304 VLIB_CLI_COMMAND (show_features_command, static) = {
305 .path = "show features",
306 .short_help = "show features",
307 .function = show_features_command_fn,
311 /** Display the set of driver features configured on a specific interface
312 * Called by "show interface" handler
316 vnet_interface_features_show (vlib_main_t * vm, u32 sw_if_index)
318 vnet_feature_main_t *fm = &feature_main;
319 u32 node_index, current_config_index;
321 vnet_feature_config_main_t *cm = fm->feature_config_mains;
322 vnet_feature_arc_registration_t *areg;
323 vnet_config_main_t *vcm;
326 vnet_config_feature_t *feat;
330 vlib_cli_output (vm, "Driver feature paths configured on %U...",
331 format_vnet_sw_if_index_name,
332 vnet_get_main (), sw_if_index);
337 feature_arc = areg->feature_arc_index;
338 vcm = &(cm[feature_arc].config_main);
340 vlib_cli_output (vm, "\n%s:", areg->arc_name);
343 if (NULL == cm[feature_arc].config_index_by_sw_if_index ||
344 vec_len (cm[feature_arc].config_index_by_sw_if_index) <=
347 vlib_cli_output (vm, " none configured");
351 current_config_index =
352 vec_elt (cm[feature_arc].config_index_by_sw_if_index, sw_if_index);
354 if (current_config_index == ~0)
356 vlib_cli_output (vm, " none configured");
360 ASSERT (current_config_index
361 < vec_len (vcm->config_pool_index_by_user_index));
363 cfg_index = vcm->config_pool_index_by_user_index[current_config_index];
364 cfg = pool_elt_at_index (vcm->config_pool, cfg_index);
366 for (i = 0; i < vec_len (cfg->features); i++)
368 feat = cfg->features + i;
369 node_index = feat->node_index;
370 n = vlib_get_node (vm, node_index);
371 vlib_cli_output (vm, " %v", n->name);
376 static clib_error_t *
377 set_interface_features_command_fn (vlib_main_t * vm,
378 unformat_input_t * input,
379 vlib_cli_command_t * cmd)
381 vnet_main_t *vnm = vnet_get_main ();
382 unformat_input_t _line_input, *line_input = &_line_input;
383 clib_error_t *error = 0;
386 u8 *feature_name = 0;
387 u32 sw_if_index = ~0;
390 /* Get a line of input. */
391 if (!unformat_user (input, unformat_line_input, line_input))
394 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
397 (line_input, "%U %v", unformat_vnet_sw_interface, vnm, &sw_if_index,
400 else if (unformat (line_input, "arc %v", &arc_name))
402 else if (unformat (line_input, "disable"))
406 error = unformat_parse_error (line_input);
411 if (sw_if_index == ~0)
413 error = clib_error_return (0, "Interface not specified...");
417 vec_add1 (arc_name, 0);
418 vec_add1 (feature_name, 0);
420 vnet_feature_registration_t *reg;
422 vnet_get_feature_reg ((const char *) arc_name,
423 (const char *) feature_name);
426 error = clib_error_return (0, "Unknown feature...");
429 if (reg->enable_disable_cb)
430 error = reg->enable_disable_cb (sw_if_index, enable);
432 vnet_feature_enable_disable ((const char *) arc_name,
433 (const char *) feature_name, sw_if_index,
437 vec_free (feature_name);
439 unformat_free (line_input);
444 * Set feature for given interface
448 * @cliexcmd{set interface feature GigabitEthernet2/0/0 ip4_flow_classify arc ip4_unicast}
453 VLIB_CLI_COMMAND (set_interface_feature_command, static) = {
454 .path = "set interface feature",
455 .short_help = "set interface feature <intfc> <feature_name> arc <arc_name>",
456 .function = set_interface_features_command_fn,
461 * fd.io coding-style-patch-verification: ON
464 * eval: (c-set-style "gnu")