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-funtion %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   /* For PCAP buffers we never re-use buffers. */
 271   s->flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
 272
 273   if (s->n_packets_limit == 0)
 274     s->n_packets_limit = vec_len (pm.packets_read);
 275
 276   return error;
 277 #endif /* CLIB_UNIX */
 278 }
 279
 280 static uword
 281 unformat_pg_stream_parameter (unformat_input_t * input, va_list * args)
 282 {
 283   pg_stream_t *s = va_arg (*args, pg_stream_t *);
 284   f64 x;
 285
 286   if (unformat (input, "limit %f", &x))
 287     s->n_packets_limit = x;
 288
 289   else if (unformat (input, "rate %f", &x))
 290     s->rate_packets_per_second = x;
 291
 292   else if (unformat (input, "size %d-%d", &s->min_packet_bytes,
 293                      &s->max_packet_bytes))
 294     s->packet_size_edit_type = PG_EDIT_INCREMENT;
 295
 296   else if (unformat (input, "size %d+%d", &s->min_packet_bytes,
 297                      &s->max_packet_bytes))
 298     s->packet_size_edit_type = PG_EDIT_RANDOM;
 299
 300   else if (unformat (input, "buffer-size %d", &s->buffer_bytes))
 301     ;
 302
 303   else
 304     return 0;
 305
 306   return 1;
 307 }
 308
 309 static clib_error_t *
 310 validate_stream (pg_stream_t * s)
 311 {
 312   if (s->max_packet_bytes < s->min_packet_bytes)
 313     return clib_error_create ("max-size < min-size");
 314
 315   u32 hdr_size = pg_edit_group_n_bytes (s, 0);
 316   if (s->min_packet_bytes < hdr_size)
 317     return clib_error_create ("min-size < total header size %d", hdr_size);
 318   if (s->buffer_bytes == 0)
 319     return clib_error_create ("buffer-size must be positive");
 320
 321   if (s->rate_packets_per_second < 0)
 322     return clib_error_create ("negative rate");
 323
 324   return 0;
 325 }
 326
 327 static clib_error_t *
 328 new_stream (vlib_main_t * vm,
 329             unformat_input_t * input, vlib_cli_command_t * cmd)
 330 {
 331   clib_error_t *error = 0;
 332   u8 *tmp = 0;
 333   u32 hw_if_index;
 334   unformat_input_t sub_input = { 0 };
 335   int sub_input_given = 0;
 336   vnet_main_t *vnm = vnet_get_main ();
 337   pg_main_t *pg = &pg_main;
 338   pg_stream_t s = { 0 };
 339   char *pcap_file_name;
 340
 341   s.sw_if_index[VLIB_RX] = s.sw_if_index[VLIB_TX] = ~0;
 342   s.node_index = ~0;
 343   s.max_packet_bytes = s.min_packet_bytes = 64;
 344   s.buffer_bytes = VLIB_BUFFER_DATA_SIZE;
 345   s.if_id = 0;
 346   pcap_file_name = 0;
 347   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 348     {
 349       if (unformat (input, "name %v", &tmp))
 350         {
 351           if (s.name)
 352             vec_free (s.name);
 353           s.name = tmp;
 354         }
 355
 356       else if (unformat (input, "node %U",
 357                          unformat_vnet_hw_interface, vnm, &hw_if_index))
 358         {
 359           vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
 360
 361           s.node_index = hi->output_node_index;
 362           s.sw_if_index[VLIB_TX] = hi->sw_if_index;
 363         }
 364
 365       else if (unformat (input, "source pg%u", &s.if_id))
 366         ;
 367
 368       else if (unformat (input, "node %U",
 369                          unformat_vlib_node, vm, &s.node_index))
 370         ;
 371
 372       else if (unformat (input, "worker %u", &s.worker_index))
 373         ;
 374
 375       else if (unformat (input, "interface %U",
 376                          unformat_vnet_sw_interface, vnm,
 377                          &s.sw_if_index[VLIB_RX]))
 378         ;
 379
 380       else if (unformat (input, "pcap %s", &pcap_file_name))
 381         ;
 382
 383       else if (!sub_input_given
 384                && unformat (input, "data %U", unformat_input, &sub_input))
 385         sub_input_given++;
 386
 387       else if (unformat_user (input, unformat_pg_stream_parameter, &s))
 388         ;
 389
 390       else if (unformat (input, "no-recycle"))
 391         s.flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
 392
 393       else
 394         {
 395           error = clib_error_create ("unknown input `%U'",
 396                                      format_unformat_error, input);
 397           goto done;
 398         }
 399     }
 400
 401   if (!sub_input_given && !pcap_file_name)
 402     {
 403       error = clib_error_create ("no packet data given");
 404       goto done;
 405     }
 406
 407   if (s.node_index == ~0)
 408     {
 409       if (pcap_file_name != 0)
 410         {
 411           vlib_node_t *n =
 412             vlib_get_node_by_name (vm, (u8 *) "ethernet-input");
 413           s.node_index = n->index;
 414         }
 415       else
 416         {
 417           error = clib_error_create ("output interface or node not given");
 418           goto done;
 419         }
 420     }
 421
 422   {
 423     pg_node_t *n;
 424
 425     if (s.node_index < vec_len (pg->nodes))
 426       n = pg->nodes + s.node_index;
 427     else
 428       n = 0;
 429
 430     if (s.worker_index >= vlib_num_workers ())
 431       s.worker_index = 0;
 432
 433     if (pcap_file_name != 0)
 434       {
 435         error = pg_pcap_read (&s, pcap_file_name);
 436         if (error)
 437           goto done;
 438         vec_free (pcap_file_name);
 439       }
 440
 441     else if (n && n->unformat_edit
 442              && unformat_user (&sub_input, n->unformat_edit, &s))
 443       ;
 444
 445     else if (!unformat_user (&sub_input, unformat_pg_payload, &s))
 446       {
 447         error = clib_error_create
 448           ("failed to parse packet data from `%U'",
 449            format_unformat_error, &sub_input);
 450         goto done;
 451       }
 452   }
 453
 454   error = validate_stream (&s);
 455   if (error)
 456     return error;
 457
 458   pg_stream_add (pg, &s);
 459   return 0;
 460
 461 done:
 462   pg_stream_free (&s);
 463   unformat_free (&sub_input);
 464   return error;
 465 }
 466
 467 /* *INDENT-OFF* */
 468 VLIB_CLI_COMMAND (new_stream_cli, static) = {
 469   .path = "packet-generator new",
 470   .function = new_stream,
 471   .short_help = "Create packet generator stream",
 472   .long_help =
 473   "Create packet generator stream\n"
 474   "\n"
 475   "Arguments:\n"
 476   "\n"
 477   "name STRING          sets stream name\n"
 478   "interface STRING     interface for stream output \n"
 479   "node NODE-NAME       node for stream output\n"
 480   "data STRING          specifies packet data\n"
 481   "pcap FILENAME        read packet data from pcap file\n",
 482 };
 483 /* *INDENT-ON* */
 484
 485 static clib_error_t *
 486 del_stream (vlib_main_t * vm,
 487             unformat_input_t * input, vlib_cli_command_t * cmd)
 488 {
 489   pg_main_t *pg = &pg_main;
 490   u32 i;
 491
 492   if (!unformat (input, "%U",
 493                  &unformat_hash_vec_string, pg->stream_index_by_name, &i))
 494     return clib_error_create ("expected stream name `%U'",
 495                               format_unformat_error, input);
 496
 497   pg_stream_del (pg, i);
 498   return 0;
 499 }
 500
 501 /* *INDENT-OFF* */
 502 VLIB_CLI_COMMAND (del_stream_cli, static) = {
 503   .path = "packet-generator delete",
 504   .function = del_stream,
 505   .short_help = "Delete stream with given name",
 506 };
 507 /* *INDENT-ON* */
 508
 509 static clib_error_t *
 510 change_stream_parameters (vlib_main_t * vm,
 511                           unformat_input_t * input, vlib_cli_command_t * cmd)
 512 {
 513   pg_main_t *pg = &pg_main;
 514   pg_stream_t *s, s_new;
 515   u32 stream_index = ~0;
 516   clib_error_t *error;
 517
 518   if (unformat (input, "%U", unformat_hash_vec_string,
 519                 pg->stream_index_by_name, &stream_index))
 520     ;
 521   else
 522     return clib_error_create ("expecting stream name; got `%U'",
 523                               format_unformat_error, input);
 524
 525   s = pool_elt_at_index (pg->streams, stream_index);
 526   s_new = s[0];
 527
 528   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 529     {
 530       if (unformat_user (input, unformat_pg_stream_parameter, &s_new))
 531         ;
 532
 533       else
 534         return clib_error_create ("unknown input `%U'",
 535                                   format_unformat_error, input);
 536     }
 537
 538   error = validate_stream (&s_new);
 539   if (!error)
 540     {
 541       s[0] = s_new;
 542       pg_stream_change (pg, s);
 543     }
 544
 545   return error;
 546 }
 547
 548 /* *INDENT-OFF* */
 549 VLIB_CLI_COMMAND (change_stream_parameters_cli, static) = {
 550   .path = "packet-generator configure",
 551   .short_help = "Change packet generator stream parameters",
 552   .function = change_stream_parameters,
 553 };
 554 /* *INDENT-ON* */
 555
 556 static clib_error_t *
 557 pg_capture_cmd_fn (vlib_main_t * vm,
 558                    unformat_input_t * input, vlib_cli_command_t * cmd)
 559 {
 560   clib_error_t *error = 0;
 561   vnet_main_t *vnm = vnet_get_main ();
 562   unformat_input_t _line_input, *line_input = &_line_input;
 563   vnet_hw_interface_t *hi = 0;
 564   u8 *pcap_file_name = 0;
 565   u32 hw_if_index;
 566   u32 is_disable = 0;
 567   u32 count = ~0;
 568
 569   if (!unformat_user (input, unformat_line_input, line_input))
 570     return 0;
 571
 572   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 573     {
 574       if (unformat (line_input, "%U",
 575                     unformat_vnet_hw_interface, vnm, &hw_if_index))
 576         {
 577           hi = vnet_get_hw_interface (vnm, hw_if_index);
 578         }
 579
 580       else if (unformat (line_input, "pcap %s", &pcap_file_name))
 581         ;
 582       else if (unformat (line_input, "count %u", &count))
 583         ;
 584       else if (unformat (line_input, "disable"))
 585         is_disable = 1;
 586
 587       else
 588         {
 589           error = clib_error_create ("unknown input `%U'",
 590                                      format_unformat_error, line_input);
 591           goto done;
 592         }
 593     }
 594
 595   if (!hi)
 596     {
 597       error = clib_error_return (0, "Please specify interface name");
 598       goto done;
 599     }
 600
 601   if (hi->dev_class_index != pg_dev_class.index)
 602     {
 603       error =
 604         clib_error_return (0, "Please specify packet-generator interface");
 605       goto done;
 606     }
 607
 608   if (!pcap_file_name && is_disable == 0)
 609     {
 610       error = clib_error_return (0, "Please specify pcap file name");
 611       goto done;
 612     }
 613
 614
 615   pg_capture_args_t _a, *a = &_a;
 616
 617   a->hw_if_index = hw_if_index;
 618   a->dev_instance = hi->dev_instance;
 619   a->is_enabled = !is_disable;
 620   a->pcap_file_name = pcap_file_name;
 621   a->count = count;
 622
 623   error = pg_capture (a);
 624
 625 done:
 626   unformat_free (line_input);
 627
 628   return error;
 629 }
 630
 631 /* *INDENT-OFF* */
 632 VLIB_CLI_COMMAND (pg_capture_cmd, static) = {
 633   .path = "packet-generator capture",
 634   .short_help = "packet-generator capture <interface name> pcap <filename> [count <n>]",
 635   .function = pg_capture_cmd_fn,
 636 };
 637 /* *INDENT-ON* */
 638
 639 static clib_error_t *
 640 create_pg_if_cmd_fn (vlib_main_t * vm,
 641                      unformat_input_t * input, vlib_cli_command_t * cmd)
 642 {
 643   pg_main_t *pg = &pg_main;
 644   unformat_input_t _line_input, *line_input = &_line_input;
 645   u32 if_id;
 646   clib_error_t *error = NULL;
 647
 648   if (!unformat_user (input, unformat_line_input, line_input))
 649     return 0;
 650
 651   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 652     {
 653       if (unformat (line_input, "interface pg%u", &if_id))
 654         ;
 655
 656       else
 657         {
 658           error = clib_error_create ("unknown input `%U'",
 659                                      format_unformat_error, line_input);
 660           goto done;
 661         }
 662     }
 663
 664   pg_interface_add_or_get (pg, if_id);
 665
 666 done:
 667   unformat_free (line_input);
 668
 669   return error;
 670 }
 671
 672 /* *INDENT-OFF* */
 673 VLIB_CLI_COMMAND (create_pg_if_cmd, static) = {
 674   .path = "create packet-generator",
 675   .short_help = "create packet-generator interface <interface name>",
 676   .function = create_pg_if_cmd_fn,
 677 };
 678 /* *INDENT-ON* */
 679
 680 /* Dummy init function so that we can be linked in. */
 681 static clib_error_t *
 682 pg_cli_init (vlib_main_t * vm)
 683 {
 684   return 0;
 685 }
 686
 687 VLIB_INIT_FUNCTION (pg_cli_init);
 688
 689 /*
 690  * fd.io coding-style-patch-verification: ON
 691  *
 692  * Local Variables:
 693  * eval: (c-set-style "gnu")
 694  * End:
 695  */