src/vnet/policer/policer.c

   1 /*
   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:
   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 #include <stdint.h>
  16 #include <stdbool.h>
  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>
  21
  22 vnet_policer_main_t vnet_policer_main;
  23
  24 u8 *
  25 format_policer_handoff_trace (u8 *s, va_list *args)
  26 {
  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 *);
  30
  31   s = format (s, "policer %d, handoff thread %d to %d", t->policer_index,
  32               t->current_worker_index, t->next_worker_index);
  33
  34   return s;
  35 }
  36
  37 vlib_combined_counter_main_t policer_counters[] = {
  38   {
  39     .name = "Policer-Conform",
  40     .stat_segment_name = "/net/policer/conform",
  41   },
  42   {
  43     .name = "Policer-Exceed",
  44     .stat_segment_name = "/net/policer/exceed",
  45   },
  46   {
  47     .name = "Policer-Violate",
  48     .stat_segment_name = "/net/policer/violate",
  49   },
  50 };
  51
  52 clib_error_t *
  53 policer_add_del (vlib_main_t *vm, u8 *name, qos_pol_cfg_params_st *cfg,
  54                  u32 *policer_index, u8 is_add)
  55 {
  56   vnet_policer_main_t *pm = &vnet_policer_main;
  57   policer_t test_policer;
  58   policer_t *policer;
  59   uword *p;
  60   u32 pi;
  61   int rv;
  62
  63   p = hash_get_mem (pm->policer_config_by_name, name);
  64
  65   if (is_add == 0)
  66     {
  67       /* free policer config and template */
  68       if (p == 0)
  69         {
  70           vec_free (name);
  71           return clib_error_return (0, "No such policer configuration");
  72         }
  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);
  76
  77       /* free policer */
  78       p = hash_get_mem (pm->policer_index_by_name, name);
  79       if (p == 0)
  80         {
  81           vec_free (name);
  82           return clib_error_return (0, "No such policer");
  83         }
  84       pool_put_index (pm->policers, p[0]);
  85       hash_unset_mem (pm->policer_index_by_name, name);
  86
  87       vec_free (name);
  88       return 0;
  89     }
  90
  91   if (p != 0)
  92     {
  93       vec_free (name);
  94       return clib_error_return (0, "Policer already exists");
  95     }
  96
  97   /* Vet the configuration before adding it to the table */
  98   rv = pol_logical_2_physical (cfg, &test_policer);
  99
 100   if (rv == 0)
 101     {
 102       policer_t *pp;
 103       qos_pol_cfg_params_st *cp;
 104       int i;
 105
 106       pool_get (pm->configs, cp);
 107       pool_get (pm->policer_templates, pp);
 108
 109       ASSERT (cp - pm->configs == pp - pm->policer_templates);
 110
 111       clib_memcpy (cp, cfg, sizeof (*cp));
 112       clib_memcpy (pp, &test_policer, sizeof (*pp));
 113
 114       hash_set_mem (pm->policer_config_by_name, name, cp - pm->configs);
 115       pool_get_aligned (pm->policers, policer, CLIB_CACHE_LINE_BYTES);
 116       policer[0] = pp[0];
 117       pi = policer - pm->policers;
 118       hash_set_mem (pm->policer_index_by_name, name, pi);
 119       *policer_index = pi;
 120       policer->thread_index = ~0;
 121
 122       for (i = 0; i < NUM_POLICE_RESULTS; i++)
 123         {
 124           vlib_validate_combined_counter (&policer_counters[i], pi);
 125           vlib_zero_combined_counter (&policer_counters[i], pi);
 126         }
 127     }
 128   else
 129     {
 130       vec_free (name);
 131       return clib_error_return (0, "Config failed sanity check");
 132     }
 133
 134   return 0;
 135 }
 136
 137 int
 138 policer_bind_worker (u8 *name, u32 worker, bool bind)
 139 {
 140   vnet_policer_main_t *pm = &vnet_policer_main;
 141   policer_t *policer;
 142   uword *p;
 143
 144   p = hash_get_mem (pm->policer_index_by_name, name);
 145   if (p == 0)
 146     {
 147       return VNET_API_ERROR_NO_SUCH_ENTRY;
 148     }
 149
 150   policer = &pm->policers[p[0]];
 151
 152   if (bind)
 153     {
 154       if (worker >= vlib_num_workers ())
 155         {
 156           return VNET_API_ERROR_INVALID_WORKER;
 157         }
 158
 159       policer->thread_index = vlib_get_worker_thread_index (worker);
 160     }
 161   else
 162     {
 163       policer->thread_index = ~0;
 164     }
 165   return 0;
 166 }
 167
 168 u8 *
 169 format_policer_instance (u8 * s, va_list * va)
 170 {
 171   policer_t *i = va_arg (*va, policer_t *);
 172   uword pi = va_arg (*va, uword);
 173   int result;
 174   vlib_counter_t counts[NUM_POLICE_RESULTS];
 175
 176   for (result = 0; result < NUM_POLICE_RESULTS; result++)
 177     {
 178       vlib_get_combined_counter (&policer_counters[result], pi,
 179                                  &counts[result]);
 180     }
 181
 182   s = format (s, "policer at %llx: %s rate, %s color-aware\n",
 183               i, i->single_rate ? "single" : "dual",
 184               i->color_aware ? "is" : "not");
 185   s = format (s, "cir %u tok/period, pir %u tok/period, scale %u\n",
 186               i->cir_tokens_per_period, i->pir_tokens_per_period, i->scale);
 187   s = format (s, "cur lim %u, cur bkt %u, ext lim %u, ext bkt %u\n",
 188               i->current_limit,
 189               i->current_bucket, i->extended_limit, i->extended_bucket);
 190   s = format (s, "last update %llu\n", i->last_update_time);
 191   s = format (s, "conform %llu packets, %llu bytes\n",
 192               counts[POLICE_CONFORM].packets, counts[POLICE_CONFORM].bytes);
 193   s = format (s, "exceed %llu packets, %llu bytes\n",
 194               counts[POLICE_EXCEED].packets, counts[POLICE_EXCEED].bytes);
 195   s = format (s, "violate %llu packets, %llu bytes\n",
 196               counts[POLICE_VIOLATE].packets, counts[POLICE_VIOLATE].bytes);
 197   return s;
 198 }
 199
 200 static u8 *
 201 format_policer_round_type (u8 * s, va_list * va)
 202 {
 203   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 204
 205   if (c->rnd_type == QOS_ROUND_TO_CLOSEST)
 206     s = format (s, "closest");
 207   else if (c->rnd_type == QOS_ROUND_TO_UP)
 208     s = format (s, "up");
 209   else if (c->rnd_type == QOS_ROUND_TO_DOWN)
 210     s = format (s, "down");
 211   else
 212     s = format (s, "ILLEGAL");
 213   return s;
 214 }
 215
 216
 217 static u8 *
 218 format_policer_rate_type (u8 * s, va_list * va)
 219 {
 220   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 221
 222   if (c->rate_type == QOS_RATE_KBPS)
 223     s = format (s, "kbps");
 224   else if (c->rate_type == QOS_RATE_PPS)
 225     s = format (s, "pps");
 226   else
 227     s = format (s, "ILLEGAL");
 228   return s;
 229 }
 230
 231 static u8 *
 232 format_policer_type (u8 * s, va_list * va)
 233 {
 234   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 235
 236   if (c->rfc == QOS_POLICER_TYPE_1R2C)
 237     s = format (s, "1r2c");
 238
 239   else if (c->rfc == QOS_POLICER_TYPE_1R3C_RFC_2697)
 240     s = format (s, "1r3c");
 241
 242   else if (c->rfc == QOS_POLICER_TYPE_2R3C_RFC_2698)
 243     s = format (s, "2r3c-2698");
 244
 245   else if (c->rfc == QOS_POLICER_TYPE_2R3C_RFC_4115)
 246     s = format (s, "2r3c-4115");
 247
 248   else if (c->rfc == QOS_POLICER_TYPE_2R3C_RFC_MEF5CF1)
 249     s = format (s, "2r3c-mef5cf1");
 250   else
 251     s = format (s, "ILLEGAL");
 252   return s;
 253 }
 254
 255 static u8 *
 256 format_policer_action_type (u8 * s, va_list * va)
 257 {
 258   qos_pol_action_params_st *a = va_arg (*va, qos_pol_action_params_st *);
 259
 260   if (a->action_type == QOS_ACTION_DROP)
 261     s = format (s, "drop");
 262   else if (a->action_type == QOS_ACTION_TRANSMIT)
 263     s = format (s, "transmit");
 264   else if (a->action_type == QOS_ACTION_MARK_AND_TRANSMIT)
 265     s = format (s, "mark-and-transmit %U", format_ip_dscp, a->dscp);
 266   else
 267     s = format (s, "ILLEGAL");
 268   return s;
 269 }
 270
 271 u8 *
 272 format_policer_config (u8 * s, va_list * va)
 273 {
 274   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 275
 276   s = format (s, "type %U cir %u eir %u cb %u eb %u\n",
 277               format_policer_type, c,
 278               c->rb.kbps.cir_kbps,
 279               c->rb.kbps.eir_kbps, c->rb.kbps.cb_bytes, c->rb.kbps.eb_bytes);
 280   s = format (s, "rate type %U, round type %U\n",
 281               format_policer_rate_type, c, format_policer_round_type, c);
 282   s = format (s, "conform action %U, exceed action %U, violate action %U\n",
 283               format_policer_action_type, &c->conform_action,
 284               format_policer_action_type, &c->exceed_action,
 285               format_policer_action_type, &c->violate_action);
 286   return s;
 287 }
 288
 289 static uword
 290 unformat_policer_type (unformat_input_t * input, va_list * va)
 291 {
 292   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 293
 294   if (!unformat (input, "type"))
 295     return 0;
 296
 297   if (unformat (input, "1r2c"))
 298     c->rfc = QOS_POLICER_TYPE_1R2C;
 299   else if (unformat (input, "1r3c"))
 300     c->rfc = QOS_POLICER_TYPE_1R3C_RFC_2697;
 301   else if (unformat (input, "2r3c-2698"))
 302     c->rfc = QOS_POLICER_TYPE_2R3C_RFC_2698;
 303   else if (unformat (input, "2r3c-4115"))
 304     c->rfc = QOS_POLICER_TYPE_2R3C_RFC_4115;
 305   else if (unformat (input, "2r3c-mef5cf1"))
 306     c->rfc = QOS_POLICER_TYPE_2R3C_RFC_MEF5CF1;
 307   else
 308     return 0;
 309   return 1;
 310 }
 311
 312 static uword
 313 unformat_policer_round_type (unformat_input_t * input, va_list * va)
 314 {
 315   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 316
 317   if (!unformat (input, "round"))
 318     return 0;
 319
 320   if (unformat (input, "closest"))
 321     c->rnd_type = QOS_ROUND_TO_CLOSEST;
 322   else if (unformat (input, "up"))
 323     c->rnd_type = QOS_ROUND_TO_UP;
 324   else if (unformat (input, "down"))
 325     c->rnd_type = QOS_ROUND_TO_DOWN;
 326   else
 327     return 0;
 328   return 1;
 329 }
 330
 331 static uword
 332 unformat_policer_rate_type (unformat_input_t * input, va_list * va)
 333 {
 334   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 335
 336   if (!unformat (input, "rate"))
 337     return 0;
 338
 339   if (unformat (input, "kbps"))
 340     c->rate_type = QOS_RATE_KBPS;
 341   else if (unformat (input, "pps"))
 342     c->rate_type = QOS_RATE_PPS;
 343   else
 344     return 0;
 345   return 1;
 346 }
 347
 348 static uword
 349 unformat_policer_cir (unformat_input_t * input, va_list * va)
 350 {
 351   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 352
 353   if (unformat (input, "cir %u", &c->rb.kbps.cir_kbps))
 354     return 1;
 355   return 0;
 356 }
 357
 358 static uword
 359 unformat_policer_eir (unformat_input_t * input, va_list * va)
 360 {
 361   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 362
 363   if (unformat (input, "eir %u", &c->rb.kbps.eir_kbps))
 364     return 1;
 365   return 0;
 366 }
 367
 368 static uword
 369 unformat_policer_cb (unformat_input_t * input, va_list * va)
 370 {
 371   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 372
 373   if (unformat (input, "cb %u", &c->rb.kbps.cb_bytes))
 374     return 1;
 375   return 0;
 376 }
 377
 378 static uword
 379 unformat_policer_eb (unformat_input_t * input, va_list * va)
 380 {
 381   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 382
 383   if (unformat (input, "eb %u", &c->rb.kbps.eb_bytes))
 384     return 1;
 385   return 0;
 386 }
 387
 388 static uword
 389 unformat_policer_action_type (unformat_input_t * input, va_list * va)
 390 {
 391   qos_pol_action_params_st *a = va_arg (*va, qos_pol_action_params_st *);
 392
 393   if (unformat (input, "drop"))
 394     a->action_type = QOS_ACTION_DROP;
 395   else if (unformat (input, "transmit"))
 396     a->action_type = QOS_ACTION_TRANSMIT;
 397   else if (unformat (input, "mark-and-transmit %U", unformat_ip_dscp,
 398                      &a->dscp))
 399     a->action_type = QOS_ACTION_MARK_AND_TRANSMIT;
 400   else
 401     return 0;
 402   return 1;
 403 }
 404
 405 static uword
 406 unformat_policer_action (unformat_input_t * input, va_list * va)
 407 {
 408   qos_pol_cfg_params_st *c = va_arg (*va, qos_pol_cfg_params_st *);
 409
 410   if (unformat (input, "conform-action %U", unformat_policer_action_type,
 411                 &c->conform_action))
 412     return 1;
 413   else if (unformat (input, "exceed-action %U", unformat_policer_action_type,
 414                      &c->exceed_action))
 415     return 1;
 416   else if (unformat (input, "violate-action %U", unformat_policer_action_type,
 417                      &c->violate_action))
 418     return 1;
 419   return 0;
 420 }
 421
 422 static uword
 423 unformat_policer_classify_next_index (unformat_input_t * input, va_list * va)
 424 {
 425   u32 *r = va_arg (*va, u32 *);
 426   vnet_policer_main_t *pm = &vnet_policer_main;
 427   uword *p;
 428   u8 *match_name = 0;
 429
 430   if (unformat (input, "%s", &match_name))
 431     ;
 432   else
 433     return 0;
 434
 435   p = hash_get_mem (pm->policer_index_by_name, match_name);
 436
 437   if (p == 0)
 438     return 0;
 439
 440   *r = p[0];
 441
 442   return 1;
 443 }
 444
 445 static uword
 446 unformat_policer_classify_precolor (unformat_input_t * input, va_list * va)
 447 {
 448   u32 *r = va_arg (*va, u32 *);
 449
 450   if (unformat (input, "conform-color"))
 451     *r = POLICE_CONFORM;
 452   else if (unformat (input, "exceed-color"))
 453     *r = POLICE_EXCEED;
 454   else
 455     return 0;
 456
 457   return 1;
 458 }
 459
 460 #define foreach_config_param                    \
 461 _(eb)                                           \
 462 _(cb)                                           \
 463 _(eir)                                          \
 464 _(cir)                                          \
 465 _(rate_type)                                    \
 466 _(round_type)                                   \
 467 _(type)                                         \
 468 _(action)
 469
 470 static clib_error_t *
 471 configure_policer_command_fn (vlib_main_t * vm,
 472                               unformat_input_t * input,
 473                               vlib_cli_command_t * cmd)
 474 {
 475   qos_pol_cfg_params_st c;
 476   unformat_input_t _line_input, *line_input = &_line_input;
 477   u8 is_add = 1;
 478   u8 *name = 0;
 479   u32 pi;
 480   clib_error_t *error = NULL;
 481
 482   /* Get a line of input. */
 483   if (!unformat_user (input, unformat_line_input, line_input))
 484     return 0;
 485
 486   clib_memset (&c, 0, sizeof (c));
 487
 488   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 489     {
 490       if (unformat (line_input, "del"))
 491         is_add = 0;
 492       else if (unformat (line_input, "name %s", &name))
 493         ;
 494       else if (unformat (line_input, "color-aware"))
 495         c.color_aware = 1;
 496
 497 #define _(a) else if (unformat (line_input, "%U", unformat_policer_##a, &c)) ;
 498       foreach_config_param
 499 #undef _
 500         else
 501         {
 502           error = clib_error_return (0, "unknown input `%U'",
 503                                      format_unformat_error, line_input);
 504           goto done;
 505         }
 506     }
 507
 508   error = policer_add_del (vm, name, &c, &pi, is_add);
 509
 510 done:
 511   unformat_free (line_input);
 512
 513   return error;
 514 }
 515
 516 /* *INDENT-OFF* */
 517 VLIB_CLI_COMMAND (configure_policer_command, static) = {
 518     .path = "configure policer",
 519     .short_help = "configure policer name <name> <params> ",
 520     .function = configure_policer_command_fn,
 521 };
 522 /* *INDENT-ON* */
 523
 524 static clib_error_t *
 525 show_policer_command_fn (vlib_main_t * vm,
 526                          unformat_input_t * input, vlib_cli_command_t * cmd)
 527 {
 528   vnet_policer_main_t *pm = &vnet_policer_main;
 529   hash_pair_t *p;
 530   u32 pool_index;
 531   u8 *match_name = 0;
 532   u8 *name;
 533   uword *pi;
 534   qos_pol_cfg_params_st *config;
 535   policer_t *templ;
 536
 537   (void) unformat (input, "name %s", &match_name);
 538
 539   /* *INDENT-OFF* */
 540   hash_foreach_pair (p, pm->policer_config_by_name,
 541   ({
 542     name = (u8 *) p->key;
 543     if (match_name == 0 || !strcmp((char *) name, (char *) match_name))
 544       {
 545         pi = hash_get_mem (pm->policer_index_by_name, name);
 546
 547         pool_index = p->value[0];
 548         config = pool_elt_at_index (pm->configs, pool_index);
 549         templ = pool_elt_at_index (pm->policer_templates, pool_index);
 550         vlib_cli_output (vm, "Name \"%s\" %U ", name, format_policer_config,
 551                          config);
 552         vlib_cli_output (vm, "Template %U", format_policer_instance, templ,
 553                          pi[0]);
 554         vlib_cli_output (vm, "-----------");
 555       }
 556   }));
 557   /* *INDENT-ON* */
 558   return 0;
 559 }
 560
 561
 562 /* *INDENT-OFF* */
 563 VLIB_CLI_COMMAND (show_policer_command, static) = {
 564     .path = "show policer",
 565     .short_help = "show policer [name]",
 566     .function = show_policer_command_fn,
 567 };
 568 /* *INDENT-ON* */
 569
 570 static clib_error_t *
 571 show_policer_pools_command_fn (vlib_main_t * vm,
 572                                unformat_input_t * input,
 573                                vlib_cli_command_t * cmd)
 574 {
 575   vnet_policer_main_t *pm = &vnet_policer_main;
 576
 577   vlib_cli_output (vm, "pool sizes: configs=%d templates=%d policers=%d",
 578                    pool_elts (pm->configs),
 579                    pool_elts (pm->policer_templates),
 580                    pool_elts (pm->policers));
 581   return 0;
 582 }
 583 /* *INDENT-OFF* */
 584 VLIB_CLI_COMMAND (show_policer_pools_command, static) = {
 585     .path = "show policer pools",
 586     .short_help = "show policer pools",
 587     .function = show_policer_pools_command_fn,
 588 };
 589 /* *INDENT-ON* */
 590
 591 clib_error_t *
 592 policer_init (vlib_main_t * vm)
 593 {
 594   vnet_policer_main_t *pm = &vnet_policer_main;
 595   void vnet_policer_node_funcs_reference (void);
 596
 597   vnet_policer_node_funcs_reference ();
 598
 599   pm->vlib_main = vm;
 600   pm->vnet_main = vnet_get_main ();
 601   pm->log_class = vlib_log_register_class ("policer", 0);
 602
 603   pm->policer_config_by_name = hash_create_string (0, sizeof (uword));
 604   pm->policer_index_by_name = hash_create_string (0, sizeof (uword));
 605
 606   vnet_classify_register_unformat_policer_next_index_fn
 607     (unformat_policer_classify_next_index);
 608   vnet_classify_register_unformat_opaque_index_fn
 609     (unformat_policer_classify_precolor);
 610
 611   return 0;
 612 }
 613
 614 VLIB_INIT_FUNCTION (policer_init);
 615
 616
 617
 618 /*
 619  * fd.io coding-style-patch-verification: ON
 620  *
 621  * Local Variables:
 622  * eval: (c-set-style "gnu")
 623  * End:
 624  */