src/vnet/pg/cli.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 /*
  16  * pg_cli.c: packet generator cli
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #include <sys/stat.h>
  41
  42 #include <vnet/vnet.h>
  43 #include <vnet/pg/pg.h>
  44
  45 #include <strings.h>
  46 #include <vppinfra/pcap.h>
  47
  48
  49 /* Root of all packet generator cli commands. */
  50 /* *INDENT-OFF* */
  51 VLIB_CLI_COMMAND (vlib_cli_pg_command, static) = {
  52   .path = "packet-generator",
  53   .short_help = "Packet generator commands",
  54 };
  55 /* *INDENT-ON* */
  56
  57 void
  58 pg_enable_disable (u32 stream_index, int is_enable)
  59 {
  60   pg_main_t *pg = &pg_main;
  61   pg_stream_t *s;
  62
  63   if (stream_index == ~0)
  64     {
  65       /* No stream specified: enable/disable all streams. */
  66       /* *INDENT-OFF* */
  67         pool_foreach (s, pg->streams, ({
  68             pg_stream_enable_disable (pg, s, is_enable);
  69         }));
  70         /* *INDENT-ON* */
  71     }
  72   else
  73     {
  74       /* enable/disable specified stream. */
  75       s = pool_elt_at_index (pg->streams, stream_index);
  76       pg_stream_enable_disable (pg, s, is_enable);
  77     }
  78 }
  79
  80 clib_error_t *
  81 pg_capture (pg_capture_args_t * a)
  82 {
  83   pg_main_t *pg = &pg_main;
  84   pg_interface_t *pi;
  85
  86   if (a->is_enabled == 1)
  87     {
  88       struct stat sb;
  89       if (stat ((char *) a->pcap_file_name, &sb) != -1)
  90         return clib_error_return (0, "Cannot create pcap file");
  91     }
  92
  93   pi = pool_elt_at_index (pg->interfaces, a->dev_instance);
  94   vec_free (pi->pcap_file_name);
  95   clib_memset (&pi->pcap_main, 0, sizeof (pi->pcap_main));
  96
  97   if (a->is_enabled == 0)
  98     return 0;
  99
 100   pi->pcap_file_name = a->pcap_file_name;
 101   pi->pcap_main.file_name = (char *) pi->pcap_file_name;
 102   pi->pcap_main.n_packets_to_capture = a->count;
 103   pi->pcap_main.packet_type = PCAP_PACKET_TYPE_ethernet;
 104
 105   return 0;
 106 }
 107
 108 static clib_error_t *
 109 enable_disable_stream (vlib_main_t * vm,
 110                        unformat_input_t * input, vlib_cli_command_t * cmd)
 111 {
 112   pg_main_t *pg = &pg_main;
 113   int is_enable = cmd->function_arg != 0;
 114   u32 stream_index = ~0;
 115
 116   if (unformat (input, "%U", unformat_eof))
 117     ;
 118   else if (unformat (input, "%U", unformat_hash_vec_string,
 119                      pg->stream_index_by_name, &stream_index))
 120     ;
 121   else
 122     return clib_error_create ("unknown input `%U'",
 123                               format_unformat_error, input);
 124
 125   pg_enable_disable (stream_index, is_enable);
 126
 127   return 0;
 128 }
 129
 130 /* *INDENT-OFF* */
 131 VLIB_CLI_COMMAND (enable_streams_cli, static) = {
 132   .path = "packet-generator enable-stream",
 133   .short_help = "Enable packet generator streams",
 134   .function = enable_disable_stream,
 135   .function_arg = 1,            /* is_enable */
 136 };
 137 /* *INDENT-ON* */
 138
 139 /* *INDENT-OFF* */
 140 VLIB_CLI_COMMAND (disable_streams_cli, static) = {
 141   .path = "packet-generator disable-stream",
 142   .short_help = "Disable packet generator streams",
 143   .function = enable_disable_stream,
 144   .function_arg = 0,            /* is_enable */
 145 };
 146 /* *INDENT-ON* */
 147
 148 static u8 *
 149 format_pg_edit_group (u8 * s, va_list * va)
 150 {
 151   pg_edit_group_t *g = va_arg (*va, pg_edit_group_t *);
 152
 153   s =
 154     format (s, "hdr-size %d, offset %d, ", g->n_packet_bytes,
 155             g->start_byte_offset);
 156   if (g->edit_function)
 157     {
 158       u8 *function_name;
 159       u8 *junk_after_name;
 160       function_name = format (0, "%U%c", format_clib_elf_symbol_with_address,
 161                               g->edit_function, 0);
 162       junk_after_name = function_name;
 163       while (*junk_after_name && *junk_after_name != ' ')
 164         junk_after_name++;
 165       *junk_after_name = 0;
 166       s = format (s, "edit-function %s, ", function_name);
 167       vec_free (function_name);
 168     }
 169
 170   return s;
 171 }
 172
 173 static u8 *
 174 format_pg_stream (u8 * s, va_list * va)
 175 {
 176   pg_stream_t *t = va_arg (*va, pg_stream_t *);
 177   int verbose = va_arg (*va, int);
 178
 179   if (!t)
 180     return format (s, "%-16s%=12s%=16s%s",
 181                    "Name", "Enabled", "Count", "Parameters");
 182
 183   s = format (s, "%-16v%=12s%=16Ld",
 184               t->name,
 185               pg_stream_is_enabled (t) ? "Yes" : "No",
 186               t->n_packets_generated);
 187
 188   int indent = format_get_indent (s);
 189
 190   s = format (s, "limit %Ld, ", t->n_packets_limit);
 191   s = format (s, "rate %.2e pps, ", t->rate_packets_per_second);
 192   s = format (s, "size %d%c%d, ",
 193               t->min_packet_bytes,
 194               t->packet_size_edit_type == PG_EDIT_RANDOM ? '+' : '-',
 195               t->max_packet_bytes);
 196   s = format (s, "buffer-size %d, ", t->buffer_bytes);
 197   s = format (s, "worker %d, ", t->worker_index);
 198
 199   if (verbose)
 200     {
 201       pg_edit_group_t *g;
 202   /* *INDENT-OFF* */
 203   vec_foreach (g, t->edit_groups)
 204     {
 205       s = format (s, "\n%U%U", format_white_space, indent, format_pg_edit_group, g);
 206     }
 207   /* *INDENT-ON* */
 208     }
 209
 210   return s;
 211 }
 212
 213 static clib_error_t *
 214 show_streams (vlib_main_t * vm,
 215               unformat_input_t * input, vlib_cli_command_t * cmd)
 216 {
 217   pg_main_t *pg = &pg_main;
 218   pg_stream_t *s;
 219   int verbose = 0;
 220
 221   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 222     {
 223       if (unformat (input, "verbose"))
 224         verbose = 1;
 225       else
 226         break;
 227     }
 228
 229   if (pool_elts (pg->streams) == 0)
 230     {
 231       vlib_cli_output (vm, "no streams currently defined");
 232       goto done;
 233     }
 234
 235   vlib_cli_output (vm, "%U", format_pg_stream, 0, 0);
 236   /* *INDENT-OFF* */
 237   pool_foreach (s, pg->streams, ({
 238       vlib_cli_output (vm, "%U", format_pg_stream, s, verbose);
 239     }));
 240   /* *INDENT-ON* */
 241
 242 done:
 243   return 0;
 244 }
 245
 246 /* *INDENT-OFF* */
 247 VLIB_CLI_COMMAND (show_streams_cli, static) = {
 248   .path = "show packet-generator ",
 249   .short_help = "show packet-generator [verbose]",
 250   .function = show_streams,
 251 };
 252 /* *INDENT-ON* */
 253
 254 static clib_error_t *
 255 pg_pcap_read (pg_stream_t * s, char *file_name)
 256 {
 257 #ifndef CLIB_UNIX
 258   return clib_error_return (0, "no pcap support");
 259 #else
 260   pcap_main_t pm;
 261   clib_error_t *error;
 262   clib_memset (&pm, 0, sizeof (pm));
 263   pm.file_name = file_name;
 264   error = pcap_read (&pm);
 265   s->replay_packet_templates = pm.packets_read;
 266   s->replay_packet_timestamps = pm.timestamps;
 267   s->min_packet_bytes = pm.min_packet_bytes;
 268   s->max_packet_bytes = pm.max_packet_bytes;
 269   s->buffer_bytes = pm.max_packet_bytes;
 270
 271   if (s->n_packets_limit == 0)
 272     s->n_packets_limit = vec_len (pm.packets_read);
 273
 274   return error;
 275 #endif /* CLIB_UNIX */
 276 }
 277
 278 static uword
 279 unformat_pg_stream_parameter (unformat_input_t * input, va_list * args)
 280 {
 281   pg_stream_t *s = va_arg (*args, pg_stream_t *);
 282   f64 x;
 283
 284   if (unformat (input, "limit %f", &x))
 285     s->n_packets_limit = x;
 286
 287   else if (unformat (input, "rate %f", &x))
 288     s->rate_packets_per_second = x;
 289
 290   else if (unformat (input, "size %d-%d", &s->min_packet_bytes,
 291                      &s->max_packet_bytes))
 292     s->packet_size_edit_type = PG_EDIT_INCREMENT;
 293
 294   else if (unformat (input, "size %d+%d", &s->min_packet_bytes,
 295                      &s->max_packet_bytes))
 296     s->packet_size_edit_type = PG_EDIT_RANDOM;
 297
 298   else if (unformat (input, "buffer-size %d", &s->buffer_bytes))
 299     ;
 300
 301   else
 302     return 0;
 303
 304   return 1;
 305 }
 306
 307 static clib_error_t *
 308 validate_stream (pg_stream_t * s)
 309 {
 310   if (s->max_packet_bytes < s->min_packet_bytes)
 311     return clib_error_create ("max-size < min-size");
 312
 313   u32 hdr_size = pg_edit_group_n_bytes (s, 0);
 314   if (s->min_packet_bytes < hdr_size)
 315     return clib_error_create ("min-size < total header size %d", hdr_size);
 316   if (s->buffer_bytes == 0)
 317     return clib_error_create ("buffer-size must be positive");
 318
 319   if (s->rate_packets_per_second < 0)
 320     return clib_error_create ("negative rate");
 321
 322   return 0;
 323 }
 324
 325 static clib_error_t *
 326 new_stream (vlib_main_t * vm,
 327             unformat_input_t * input, vlib_cli_command_t * cmd)
 328 {
 329   clib_error_t *error = 0;
 330   u8 *tmp = 0;
 331   u32 hw_if_index;
 332   unformat_input_t sub_input = { 0 };
 333   int sub_input_given = 0;
 334   vnet_main_t *vnm = vnet_get_main ();
 335   pg_main_t *pg = &pg_main;
 336   pg_stream_t s = { 0 };
 337   char *pcap_file_name;
 338
 339   s.sw_if_index[VLIB_RX] = s.sw_if_index[VLIB_TX] = ~0;
 340   s.node_index = ~0;
 341   s.max_packet_bytes = s.min_packet_bytes = 64;
 342   s.buffer_bytes = vlib_buffer_get_default_data_size (vm);
 343   s.if_id = 0;
 344   pcap_file_name = 0;
 345   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 346     {
 347       if (unformat (input, "name %v", &tmp))
 348         {
 349           if (s.name)
 350             vec_free (s.name);
 351           s.name = tmp;
 352         }
 353
 354       else if (unformat (input, "node %U",
 355                          unformat_vnet_hw_interface, vnm, &hw_if_index))
 356         {
 357           vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
 358
 359           s.node_index = hi->output_node_index;
 360           s.sw_if_index[VLIB_TX] = hi->sw_if_index;
 361         }
 362
 363       else if (unformat (input, "source pg%u", &s.if_id))
 364         ;
 365
 366       else if (unformat (input, "node %U",
 367                          unformat_vlib_node, vm, &s.node_index))
 368         ;
 369
 370       else if (unformat (input, "worker %u", &s.worker_index))
 371         ;
 372
 373       else if (unformat (input, "interface %U",
 374                          unformat_vnet_sw_interface, vnm,
 375                          &s.sw_if_index[VLIB_RX]))
 376         ;
 377
 378       else if (unformat (input, "pcap %s", &pcap_file_name))
 379         ;
 380
 381       else if (!sub_input_given
 382                && unformat (input, "data %U", unformat_input, &sub_input))
 383         sub_input_given++;
 384
 385       else if (unformat_user (input, unformat_pg_stream_parameter, &s))
 386         ;
 387
 388       else
 389         {
 390           error = clib_error_create ("unknown input `%U'",
 391                                      format_unformat_error, input);
 392           goto done;
 393         }
 394     }
 395
 396   if (!sub_input_given && !pcap_file_name)
 397     {
 398       error = clib_error_create ("no packet data given");
 399       goto done;
 400     }
 401
 402   if (s.node_index == ~0)
 403     {
 404       if (pcap_file_name != 0)
 405         {
 406           vlib_node_t *n =
 407             vlib_get_node_by_name (vm, (u8 *) "ethernet-input");
 408           s.node_index = n->index;
 409         }
 410       else
 411         {
 412           error = clib_error_create ("output interface or node not given");
 413           goto done;
 414         }
 415     }
 416
 417   {
 418     pg_node_t *n;
 419
 420     if (s.node_index < vec_len (pg->nodes))
 421       n = pg->nodes + s.node_index;
 422     else
 423       n = 0;
 424
 425     if (s.worker_index >= vlib_num_workers ())
 426       s.worker_index = 0;
 427
 428     if (pcap_file_name != 0)
 429       {
 430         error = pg_pcap_read (&s, pcap_file_name);
 431         if (error)
 432           goto done;
 433         vec_free (pcap_file_name);
 434       }
 435
 436     else if (n && n->unformat_edit
 437              && unformat_user (&sub_input, n->unformat_edit, &s))
 438       ;
 439
 440     else if (!unformat_user (&sub_input, unformat_pg_payload, &s))
 441       {
 442         error = clib_error_create
 443           ("failed to parse packet data from `%U'",
 444            format_unformat_error, &sub_input);
 445         goto done;
 446       }
 447   }
 448
 449   error = validate_stream (&s);
 450   if (error)
 451     return error;
 452
 453   pg_stream_add (pg, &s);
 454   return 0;
 455
 456 done:
 457   pg_stream_free (&s);
 458   unformat_free (&sub_input);
 459   return error;
 460 }
 461
 462 /* *INDENT-OFF* */
 463 VLIB_CLI_COMMAND (new_stream_cli, static) = {
 464   .path = "packet-generator new",
 465   .function = new_stream,
 466   .short_help = "Create packet generator stream",
 467   .long_help =
 468   "Create packet generator stream\n"
 469   "\n"
 470   "Arguments:\n"
 471   "\n"
 472   "name STRING          sets stream name\n"
 473   "interface STRING     interface for stream output \n"
 474   "node NODE-NAME       node for stream output\n"
 475   "data STRING          specifies packet data\n"
 476   "pcap FILENAME        read packet data from pcap file\n",
 477 };
 478 /* *INDENT-ON* */
 479
 480 static clib_error_t *
 481 del_stream (vlib_main_t * vm,
 482             unformat_input_t * input, vlib_cli_command_t * cmd)
 483 {
 484   pg_main_t *pg = &pg_main;
 485   u32 i;
 486
 487   if (!unformat (input, "%U",
 488                  &unformat_hash_vec_string, pg->stream_index_by_name, &i))
 489     return clib_error_create ("expected stream name `%U'",
 490                               format_unformat_error, input);
 491
 492   pg_stream_del (pg, i);
 493   return 0;
 494 }
 495
 496 /* *INDENT-OFF* */
 497 VLIB_CLI_COMMAND (del_stream_cli, static) = {
 498   .path = "packet-generator delete",
 499   .function = del_stream,
 500   .short_help = "Delete stream with given name",
 501 };
 502 /* *INDENT-ON* */
 503
 504 static clib_error_t *
 505 change_stream_parameters (vlib_main_t * vm,
 506                           unformat_input_t * input, vlib_cli_command_t * cmd)
 507 {
 508   pg_main_t *pg = &pg_main;
 509   pg_stream_t *s, s_new;
 510   u32 stream_index = ~0;
 511   clib_error_t *error;
 512
 513   if (unformat (input, "%U", unformat_hash_vec_string,
 514                 pg->stream_index_by_name, &stream_index))
 515     ;
 516   else
 517     return clib_error_create ("expecting stream name; got `%U'",
 518                               format_unformat_error, input);
 519
 520   s = pool_elt_at_index (pg->streams, stream_index);
 521   s_new = s[0];
 522
 523   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 524     {
 525       if (unformat_user (input, unformat_pg_stream_parameter, &s_new))
 526         ;
 527
 528       else
 529         return clib_error_create ("unknown input `%U'",
 530                                   format_unformat_error, input);
 531     }
 532
 533   error = validate_stream (&s_new);
 534   if (!error)
 535     {
 536       s[0] = s_new;
 537       pg_stream_change (pg, s);
 538     }
 539
 540   return error;
 541 }
 542
 543 /* *INDENT-OFF* */
 544 VLIB_CLI_COMMAND (change_stream_parameters_cli, static) = {
 545   .path = "packet-generator configure",
 546   .short_help = "Change packet generator stream parameters",
 547   .function = change_stream_parameters,
 548 };
 549 /* *INDENT-ON* */
 550
 551 static clib_error_t *
 552 pg_capture_cmd_fn (vlib_main_t * vm,
 553                    unformat_input_t * input, vlib_cli_command_t * cmd)
 554 {
 555   clib_error_t *error = 0;
 556   vnet_main_t *vnm = vnet_get_main ();
 557   unformat_input_t _line_input, *line_input = &_line_input;
 558   vnet_hw_interface_t *hi = 0;
 559   u8 *pcap_file_name = 0;
 560   u32 hw_if_index;
 561   u32 is_disable = 0;
 562   u32 count = ~0;
 563
 564   if (!unformat_user (input, unformat_line_input, line_input))
 565     return 0;
 566
 567   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 568     {
 569       if (unformat (line_input, "%U",
 570                     unformat_vnet_hw_interface, vnm, &hw_if_index))
 571         {
 572           hi = vnet_get_hw_interface (vnm, hw_if_index);
 573         }
 574
 575       else if (unformat (line_input, "pcap %s", &pcap_file_name))
 576         ;
 577       else if (unformat (line_input, "count %u", &count))
 578         ;
 579       else if (unformat (line_input, "disable"))
 580         is_disable = 1;
 581
 582       else
 583         {
 584           error = clib_error_create ("unknown input `%U'",
 585                                      format_unformat_error, line_input);
 586           goto done;
 587         }
 588     }
 589
 590   if (!hi)
 591     {
 592       error = clib_error_return (0, "Please specify interface name");
 593       goto done;
 594     }
 595
 596   if (hi->dev_class_index != pg_dev_class.index)
 597     {
 598       error =
 599         clib_error_return (0, "Please specify packet-generator interface");
 600       goto done;
 601     }
 602
 603   if (!pcap_file_name && is_disable == 0)
 604     {
 605       error = clib_error_return (0, "Please specify pcap file name");
 606       goto done;
 607     }
 608
 609
 610   pg_capture_args_t _a, *a = &_a;
 611
 612   a->hw_if_index = hw_if_index;
 613   a->dev_instance = hi->dev_instance;
 614   a->is_enabled = !is_disable;
 615   a->pcap_file_name = pcap_file_name;
 616   a->count = count;
 617
 618   error = pg_capture (a);
 619
 620 done:
 621   unformat_free (line_input);
 622
 623   return error;
 624 }
 625
 626 /* *INDENT-OFF* */
 627 VLIB_CLI_COMMAND (pg_capture_cmd, static) = {
 628   .path = "packet-generator capture",
 629   .short_help = "packet-generator capture <interface name> pcap <filename> [count <n>]",
 630   .function = pg_capture_cmd_fn,
 631 };
 632 /* *INDENT-ON* */
 633
 634 static clib_error_t *
 635 create_pg_if_cmd_fn (vlib_main_t * vm,
 636                      unformat_input_t * input, vlib_cli_command_t * cmd)
 637 {
 638   pg_main_t *pg = &pg_main;
 639   unformat_input_t _line_input, *line_input = &_line_input;
 640   u32 if_id;
 641   clib_error_t *error = NULL;
 642
 643   if (!unformat_user (input, unformat_line_input, line_input))
 644     return 0;
 645
 646   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 647     {
 648       if (unformat (line_input, "interface pg%u", &if_id))
 649         ;
 650
 651       else
 652         {
 653           error = clib_error_create ("unknown input `%U'",
 654                                      format_unformat_error, line_input);
 655           goto done;
 656         }
 657     }
 658
 659   pg_interface_add_or_get (pg, if_id);
 660
 661 done:
 662   unformat_free (line_input);
 663
 664   return error;
 665 }
 666
 667 /* *INDENT-OFF* */
 668 VLIB_CLI_COMMAND (create_pg_if_cmd, static) = {
 669   .path = "create packet-generator",
 670   .short_help = "create packet-generator interface <interface name>",
 671   .function = create_pg_if_cmd_fn,
 672 };
 673 /* *INDENT-ON* */
 674
 675 /* Dummy init function so that we can be linked in. */
 676 static clib_error_t *
 677 pg_cli_init (vlib_main_t * vm)
 678 {
 679   return 0;
 680 }
 681
 682 VLIB_INIT_FUNCTION (pg_cli_init);
 683
 684 /*
 685  * fd.io coding-style-patch-verification: ON
 686  *
 687  * Local Variables:
 688  * eval: (c-set-style "gnu")
 689  * End:
 690  */