2 * Copyright (c) 2015 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.
17 #include <vnet/policer/policer.h>
18 #include <vnet/policer/police_inlines.h>
19 #include <vnet/classify/vnet_classify.h>
20 #include <vnet/ip/ip_packet.h>
22 vnet_policer_main_t vnet_policer_main;
25 format_policer_handoff_trace (u8 *s, va_list *args)
27 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
28 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
29 policer_handoff_trace_t *t = va_arg (*args, policer_handoff_trace_t *);
31 s = format (s, "policer %d, handoff thread %d to %d", t->policer_index,
32 t->current_worker_index, t->next_worker_index);
37 vlib_combined_counter_main_t policer_counters[] = {
39 .name = "Policer-Conform",
40 .stat_segment_name = "/net/policer/conform",
43 .name = "Policer-Exceed",
44 .stat_segment_name = "/net/policer/exceed",
47 .name = "Policer-Violate",
48 .stat_segment_name = "/net/policer/violate",
53 policer_add_del (vlib_main_t *vm, u8 *name, qos_pol_cfg_params_st *cfg,
54 u32 *policer_index, u8 is_add)
56 vnet_policer_main_t *pm = &vnet_policer_main;
57 policer_t test_policer;
63 p = hash_get_mem (pm->policer_config_by_name, name);
67 /* free policer config and template */
71 return clib_error_return (0, "No such policer configuration");
73 pool_put_index (pm->configs, p[0]);
74 pool_put_index (pm->policer_templates, p[0]);
75 hash_unset_mem (pm->policer_config_by_name, name);
78 p = hash_get_mem (pm->policer_index_by_name, name);
82 return clib_error_return (0, "No such policer");
84 pool_put_index (pm->policers, p[0]);
85 hash_unset_mem (pm->policer_index_by_name, name);
94 return clib_error_return (0, "Policer already exists");
97 /* Vet the configuration before adding it to the table */
98 rv = pol_logical_2_physical (cfg, &test_policer);
103 qos_pol_cfg_params_st *cp;
106 pool_get (pm->configs, cp);
107 pool_get (pm->policer_templates, pp);
109 ASSERT (cp - pm->configs == pp - pm->policer_templates);
111 clib_memcpy (cp, cfg, sizeof (*cp));
112 clib_memcpy (pp, &test_policer, sizeof (*pp));
114 hash_set_mem (pm->policer_config_by_name, name, cp - pm->configs);
115 pool_get_aligned (pm->policers, policer, CLIB_CACHE_LINE_BYTES);
117 pi = policer - pm->policers;
118 hash_set_mem (pm->policer_index_by_name, name, pi);
120 policer->thread_index = ~0;
122 for (i = 0; i < NUM_POLICE_RESULTS; i++)
124 vlib_validate_combined_counter (&policer_counters[i], pi);
125 vlib_zero_combined_counter (&policer_counters[i], pi);
131 return clib_error_return (0, "Config failed sanity check");
138 policer_bind_worker (u8 *name, u32 worker, bool bind)
140 vnet_policer_main_t *pm = &vnet_policer_main;
144 p = hash_get_mem (pm->policer_index_by_name, name);
147 return VNET_API_ERROR_NO_SUCH_ENTRY;
150 policer = &pm->policers[p[0]];
154 if (worker >= vlib_num_workers ())
156 return VNET_API_ERROR_INVALID_WORKER;
159 policer->thread_index = vlib_get_worker_thread_index (worker);
163 policer->thread_index = ~0;
169 policer_input (u8 *name, u32 sw_if_index, bool apply)
171 vnet_policer_main_t *pm = &vnet_policer_main;
176 p = hash_get_mem (pm->policer_index_by_name, name);
179 return VNET_API_ERROR_NO_SUCH_ENTRY;
182 policer = &pm->policers[p[0]];
183 policer_index = policer - pm->policers;
187 vec_validate (pm->policer_index_by_sw_if_index, sw_if_index);
188 pm->policer_index_by_sw_if_index[sw_if_index] = policer_index;
192 pm->policer_index_by_sw_if_index[sw_if_index] = ~0;
195 vnet_feature_enable_disable ("device-input", "policer-input", sw_if_index,
201 format_policer_instance (u8 * s, va_list * va)
203 policer_t *i = va_arg (*va, policer_t *);
204 uword pi = va_arg (*va, uword);
206 vlib_counter_t counts[NUM_POLICE_RESULTS];
208 for (result = 0; result < NUM_POLICE_RESULTS; result++)
210 vlib_get_combined_counter (&policer_counters[result], pi,
214 s = format (s, "policer at %llx: %s rate, %s color-aware\n",
215 i, i->single_rate ? "single" : "dual",
216 i->color_aware ? "is" : "not");
217 s = format (s, "cir %u tok/period, pir %u tok/period, scale %u\n",
218 i->cir_tokens_per_period, i->pir_tokens_per_period, i->scale);
219 s = format (s, "cur lim %u, cur bkt %u, ext lim %u, ext bkt %u\n",
221 i->current_bucket, i->extended_limit, i->extended_bucket);
222 s = format (s, "last update %llu\n", i->last_update_time);
223 s = format (s, "conform %llu packets, %llu bytes\n",
224 counts[POLICE_CONFORM].packets, counts[POLICE_CONFORM].bytes);
225 s = format (s, "exceed %llu packets, %llu bytes\n",
226 counts[POLICE_EXCEED].packets, counts[POLICE_EXCEED].bytes);
227 s = format (s, "violate %llu packets, %llu bytes\n",
228 counts[POLICE_VIOLATE].packets, counts[POLICE_VIOLATE].bytes);
233 format_policer_round_type (u8 * s, va_list * va)
235 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
237 if (c->rnd_type == QOS_ROUND_TO_CLOSEST)
238 s = format (s, "closest");
239 else if (c->rnd_type == QOS_ROUND_TO_UP)
240 s = format (s, "up");
241 else if (c->rnd_type == QOS_ROUND_TO_DOWN)
242 s = format (s, "down");
244 s = format (s, "ILLEGAL");
250 format_policer_rate_type (u8 * s, va_list * va)
252 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
254 if (c->rate_type == QOS_RATE_KBPS)
255 s = format (s, "kbps");
256 else if (c->rate_type == QOS_RATE_PPS)
257 s = format (s, "pps");
259 s = format (s, "ILLEGAL");
264 format_policer_type (u8 * s, va_list * va)
266 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
268 if (c->rfc == QOS_POLICER_TYPE_1R2C)
269 s = format (s, "1r2c");
271 else if (c->rfc == QOS_POLICER_TYPE_1R3C_RFC_2697)
272 s = format (s, "1r3c");
274 else if (c->rfc == QOS_POLICER_TYPE_2R3C_RFC_2698)
275 s = format (s, "2r3c-2698");
277 else if (c->rfc == QOS_POLICER_TYPE_2R3C_RFC_4115)
278 s = format (s, "2r3c-4115");
280 else if (c->rfc == QOS_POLICER_TYPE_2R3C_RFC_MEF5CF1)
281 s = format (s, "2r3c-mef5cf1");
283 s = format (s, "ILLEGAL");
288 format_policer_action_type (u8 * s, va_list * va)
290 qos_pol_action_params_st *a = va_arg (*va, qos_pol_action_params_st *);
292 if (a->action_type == QOS_ACTION_DROP)
293 s = format (s, "drop");
294 else if (a->action_type == QOS_ACTION_TRANSMIT)
295 s = format (s, "transmit");
296 else if (a->action_type == QOS_ACTION_MARK_AND_TRANSMIT)
297 s = format (s, "mark-and-transmit %U", format_ip_dscp, a->dscp);
299 s = format (s, "ILLEGAL");
304 format_policer_config (u8 * s, va_list * va)
306 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
308 s = format (s, "type %U cir %u eir %u cb %u eb %u\n",
309 format_policer_type, c,
311 c->rb.kbps.eir_kbps, c->rb.kbps.cb_bytes, c->rb.kbps.eb_bytes);
312 s = format (s, "rate type %U, round type %U\n",
313 format_policer_rate_type, c, format_policer_round_type, c);
314 s = format (s, "conform action %U, exceed action %U, violate action %U\n",
315 format_policer_action_type, &c->conform_action,
316 format_policer_action_type, &c->exceed_action,
317 format_policer_action_type, &c->violate_action);
322 unformat_policer_type (unformat_input_t * input, va_list * va)
324 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
326 if (!unformat (input, "type"))
329 if (unformat (input, "1r2c"))
330 c->rfc = QOS_POLICER_TYPE_1R2C;
331 else if (unformat (input, "1r3c"))
332 c->rfc = QOS_POLICER_TYPE_1R3C_RFC_2697;
333 else if (unformat (input, "2r3c-2698"))
334 c->rfc = QOS_POLICER_TYPE_2R3C_RFC_2698;
335 else if (unformat (input, "2r3c-4115"))
336 c->rfc = QOS_POLICER_TYPE_2R3C_RFC_4115;
337 else if (unformat (input, "2r3c-mef5cf1"))
338 c->rfc = QOS_POLICER_TYPE_2R3C_RFC_MEF5CF1;
345 unformat_policer_round_type (unformat_input_t * input, va_list * va)
347 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
349 if (!unformat (input, "round"))
352 if (unformat (input, "closest"))
353 c->rnd_type = QOS_ROUND_TO_CLOSEST;
354 else if (unformat (input, "up"))
355 c->rnd_type = QOS_ROUND_TO_UP;
356 else if (unformat (input, "down"))
357 c->rnd_type = QOS_ROUND_TO_DOWN;
364 unformat_policer_rate_type (unformat_input_t * input, va_list * va)
366 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
368 if (!unformat (input, "rate"))
371 if (unformat (input, "kbps"))
372 c->rate_type = QOS_RATE_KBPS;
373 else if (unformat (input, "pps"))
374 c->rate_type = QOS_RATE_PPS;
381 unformat_policer_cir (unformat_input_t * input, va_list * va)
383 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
385 if (unformat (input, "cir %u", &c->rb.kbps.cir_kbps))
391 unformat_policer_eir (unformat_input_t * input, va_list * va)
393 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
395 if (unformat (input, "eir %u", &c->rb.kbps.eir_kbps))
401 unformat_policer_cb (unformat_input_t * input, va_list * va)
403 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
405 if (unformat (input, "cb %u", &c->rb.kbps.cb_bytes))
411 unformat_policer_eb (unformat_input_t * input, va_list * va)
413 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
415 if (unformat (input, "eb %u", &c->rb.kbps.eb_bytes))
421 unformat_policer_action_type (unformat_input_t * input, va_list * va)
423 qos_pol_action_params_st *a = va_arg (*va, qos_pol_action_params_st *);
425 if (unformat (input, "drop"))
426 a->action_type = QOS_ACTION_DROP;
427 else if (unformat (input, "transmit"))
428 a->action_type = QOS_ACTION_TRANSMIT;
429 else if (unformat (input, "mark-and-transmit %U", unformat_ip_dscp,
431 a->action_type = QOS_ACTION_MARK_AND_TRANSMIT;
438 unformat_policer_action (unformat_input_t * input, va_list * va)
440 qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
442 if (unformat (input, "conform-action %U", unformat_policer_action_type,
445 else if (unformat (input, "exceed-action %U", unformat_policer_action_type,
448 else if (unformat (input, "violate-action %U", unformat_policer_action_type,
455 unformat_policer_classify_next_index (unformat_input_t * input, va_list * va)
457 u32 *r = va_arg (*va, u32 *);
458 vnet_policer_main_t *pm = &vnet_policer_main;
462 if (unformat (input, "%s", &match_name))
467 p = hash_get_mem (pm->policer_index_by_name, match_name);
478 unformat_policer_classify_precolor (unformat_input_t * input, va_list * va)
480 u32 *r = va_arg (*va, u32 *);
482 if (unformat (input, "conform-color"))
484 else if (unformat (input, "exceed-color"))
492 #define foreach_config_param \
502 static clib_error_t *
503 configure_policer_command_fn (vlib_main_t * vm,
504 unformat_input_t * input,
505 vlib_cli_command_t * cmd)
507 qos_pol_cfg_params_st c;
508 unformat_input_t _line_input, *line_input = &_line_input;
512 clib_error_t *error = NULL;
514 /* Get a line of input. */
515 if (!unformat_user (input, unformat_line_input, line_input))
518 clib_memset (&c, 0, sizeof (c));
520 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
522 if (unformat (line_input, "del"))
524 else if (unformat (line_input, "name %s", &name))
526 else if (unformat (line_input, "color-aware"))
529 #define _(a) else if (unformat (line_input, "%U", unformat_policer_##a, &c)) ;
534 error = clib_error_return (0, "unknown input `%U'",
535 format_unformat_error, line_input);
540 error = policer_add_del (vm, name, &c, &pi, is_add);
543 unformat_free (line_input);
549 VLIB_CLI_COMMAND (configure_policer_command, static) = {
550 .path = "configure policer",
551 .short_help = "configure policer name <name> <params> ",
552 .function = configure_policer_command_fn,
556 static clib_error_t *
557 show_policer_command_fn (vlib_main_t * vm,
558 unformat_input_t * input, vlib_cli_command_t * cmd)
560 vnet_policer_main_t *pm = &vnet_policer_main;
566 qos_pol_cfg_params_st *config;
569 (void) unformat (input, "name %s", &match_name);
572 hash_foreach_pair (p, pm->policer_config_by_name,
574 name = (u8 *) p->key;
575 if (match_name == 0 || !strcmp((char *) name, (char *) match_name))
577 pi = hash_get_mem (pm->policer_index_by_name, name);
579 pool_index = p->value[0];
580 config = pool_elt_at_index (pm->configs, pool_index);
581 templ = pool_elt_at_index (pm->policer_templates, pool_index);
582 vlib_cli_output (vm, "Name \"%s\" %U ", name, format_policer_config,
584 vlib_cli_output (vm, "Template %U", format_policer_instance, templ,
586 vlib_cli_output (vm, "-----------");
595 VLIB_CLI_COMMAND (show_policer_command, static) = {
596 .path = "show policer",
597 .short_help = "show policer [name]",
598 .function = show_policer_command_fn,
602 static clib_error_t *
603 show_policer_pools_command_fn (vlib_main_t * vm,
604 unformat_input_t * input,
605 vlib_cli_command_t * cmd)
607 vnet_policer_main_t *pm = &vnet_policer_main;
609 vlib_cli_output (vm, "pool sizes: configs=%d templates=%d policers=%d",
610 pool_elts (pm->configs),
611 pool_elts (pm->policer_templates),
612 pool_elts (pm->policers));
616 VLIB_CLI_COMMAND (show_policer_pools_command, static) = {
617 .path = "show policer pools",
618 .short_help = "show policer pools",
619 .function = show_policer_pools_command_fn,
624 policer_init (vlib_main_t * vm)
626 vnet_policer_main_t *pm = &vnet_policer_main;
629 pm->vnet_main = vnet_get_main ();
630 pm->log_class = vlib_log_register_class ("policer", 0);
632 pm->policer_config_by_name = hash_create_string (0, sizeof (uword));
633 pm->policer_index_by_name = hash_create_string (0, sizeof (uword));
635 vnet_classify_register_unformat_policer_next_index_fn
636 (unformat_policer_classify_next_index);
637 vnet_classify_register_unformat_opaque_index_fn
638 (unformat_policer_classify_precolor);
643 VLIB_INIT_FUNCTION (policer_init);
648 * fd.io coding-style-patch-verification: ON
651 * eval: (c-set-style "gnu")