vnet/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 #ifdef CLIB_UNIX
  46 #include <vnet/unix/pcap.h>
  47 #endif
  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   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_stream (u8 * s, va_list * va)
 150 {
 151   pg_stream_t *t = va_arg (*va, pg_stream_t *);
 152   u8 *v;
 153
 154   if (!t)
 155     return format (s, "%=16s%=12s%=16s%s",
 156                    "Name", "Enabled", "Count", "Parameters");
 157
 158   s = format (s, "%-16v%=12s%16Ld",
 159               t->name,
 160               pg_stream_is_enabled (t) ? "Yes" : "No",
 161               t->n_packets_generated);
 162
 163   v = 0;
 164
 165   v = format (v, "limit %Ld, ", t->n_packets_limit);
 166
 167   v = format (v, "rate %.2e pps, ", t->rate_packets_per_second);
 168
 169   v = format (v, "size %d%c%d, ",
 170               t->min_packet_bytes,
 171               t->packet_size_edit_type == PG_EDIT_RANDOM ? '+' : '-',
 172               t->max_packet_bytes);
 173
 174   v = format (v, "buffer-size %d, ", t->buffer_bytes);
 175
 176   if (v)
 177     {
 178       s = format (s, "  %v", v);
 179       vec_free (v);
 180     }
 181
 182   return s;
 183 }
 184
 185 static clib_error_t *
 186 show_streams (vlib_main_t * vm,
 187               unformat_input_t * input, vlib_cli_command_t * cmd)
 188 {
 189   pg_main_t *pg = &pg_main;
 190   pg_stream_t *s;
 191
 192   if (pool_elts (pg->streams) == 0)
 193     {
 194       vlib_cli_output (vm, "no streams currently defined");
 195       goto done;
 196     }
 197
 198   vlib_cli_output (vm, "%U", format_pg_stream, 0);
 199   /* *INDENT-OFF* */
 200   pool_foreach (s, pg->streams, ({
 201       vlib_cli_output (vm, "%U", format_pg_stream, s);
 202     }));
 203   /* *INDENT-ON* */
 204
 205 done:
 206   return 0;
 207 }
 208
 209 /* *INDENT-OFF* */
 210 VLIB_CLI_COMMAND (show_streams_cli, static) = {
 211   .path = "show packet-generator",
 212   .short_help = "Show packet generator streams",
 213   .function = show_streams,
 214 };
 215 /* *INDENT-ON* */
 216
 217 static clib_error_t *
 218 pg_pcap_read (pg_stream_t * s, char *file_name)
 219 {
 220 #ifndef CLIB_UNIX
 221   return clib_error_return (0, "no pcap support");
 222 #else
 223   pcap_main_t pm;
 224   clib_error_t *error;
 225   memset (&pm, 0, sizeof (pm));
 226   pm.file_name = file_name;
 227   error = pcap_read (&pm);
 228   s->replay_packet_templates = pm.packets_read;
 229   s->min_packet_bytes = pm.min_packet_bytes;
 230   s->max_packet_bytes = pm.max_packet_bytes;
 231   s->buffer_bytes = pm.max_packet_bytes;
 232   /* For PCAP buffers we never re-use buffers. */
 233   s->flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
 234
 235   if (s->n_packets_limit == 0)
 236     s->n_packets_limit = vec_len (pm.packets_read);
 237
 238   return error;
 239 #endif /* CLIB_UNIX */
 240 }
 241
 242 static uword
 243 unformat_pg_stream_parameter (unformat_input_t * input, va_list * args)
 244 {
 245   pg_stream_t *s = va_arg (*args, pg_stream_t *);
 246   f64 x;
 247
 248   if (unformat (input, "limit %f", &x))
 249     s->n_packets_limit = x;
 250
 251   else if (unformat (input, "rate %f", &x))
 252     s->rate_packets_per_second = x;
 253
 254   else if (unformat (input, "size %d-%d", &s->min_packet_bytes,
 255                      &s->max_packet_bytes))
 256     s->packet_size_edit_type = PG_EDIT_INCREMENT;
 257
 258   else if (unformat (input, "size %d+%d", &s->min_packet_bytes,
 259                      &s->max_packet_bytes))
 260     s->packet_size_edit_type = PG_EDIT_RANDOM;
 261
 262   else if (unformat (input, "buffer-size %d", &s->buffer_bytes))
 263     ;
 264
 265   else
 266     return 0;
 267
 268   return 1;
 269 }
 270
 271 static clib_error_t *
 272 validate_stream (pg_stream_t * s)
 273 {
 274   if (s->max_packet_bytes < s->min_packet_bytes)
 275     return clib_error_create ("max-size < min-size");
 276
 277   if (s->buffer_bytes >= 4096 || s->buffer_bytes == 0)
 278     return
 279       clib_error_create ("buffer-size must be positive and < 4096, given %d",
 280                          s->buffer_bytes);
 281
 282   if (s->rate_packets_per_second < 0)
 283     return clib_error_create ("negative rate");
 284
 285   return 0;
 286 }
 287
 288 static clib_error_t *
 289 new_stream (vlib_main_t * vm,
 290             unformat_input_t * input, vlib_cli_command_t * cmd)
 291 {
 292   clib_error_t *error = 0;
 293   u8 *tmp = 0;
 294   u32 hw_if_index;
 295   unformat_input_t sub_input = { 0 };
 296   int sub_input_given = 0;
 297   vnet_main_t *vnm = vnet_get_main ();
 298   pg_main_t *pg = &pg_main;
 299   pg_stream_t s = { 0 };
 300   char *pcap_file_name;
 301
 302   s.sw_if_index[VLIB_RX] = s.sw_if_index[VLIB_TX] = ~0;
 303   s.node_index = ~0;
 304   s.max_packet_bytes = s.min_packet_bytes = 64;
 305   s.buffer_bytes = VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES;
 306   s.if_id = 0;
 307   pcap_file_name = 0;
 308   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 309     {
 310       if (unformat (input, "name %v", &tmp))
 311         {
 312           if (s.name)
 313             vec_free (s.name);
 314           s.name = tmp;
 315         }
 316
 317       else if (unformat (input, "node %U",
 318                          unformat_vnet_hw_interface, vnm, &hw_if_index))
 319         {
 320           vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
 321
 322           s.node_index = hi->output_node_index;
 323           s.sw_if_index[VLIB_TX] = hi->sw_if_index;
 324         }
 325
 326       else if (unformat (input, "source pg%u", &s.if_id))
 327         ;
 328
 329       else if (unformat (input, "node %U",
 330                          unformat_vlib_node, vm, &s.node_index))
 331         ;
 332
 333       else if (unformat (input, "interface %U",
 334                          unformat_vnet_sw_interface, vnm,
 335                          &s.sw_if_index[VLIB_RX]))
 336         ;
 337
 338       else if (unformat (input, "pcap %s", &pcap_file_name))
 339         ;
 340
 341       else if (!sub_input_given
 342                && unformat (input, "data %U", unformat_input, &sub_input))
 343         sub_input_given++;
 344
 345       else if (unformat_user (input, unformat_pg_stream_parameter, &s))
 346         ;
 347
 348       else if (unformat (input, "no-recycle"))
 349         s.flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
 350
 351       else
 352         {
 353           error = clib_error_create ("unknown input `%U'",
 354                                      format_unformat_error, input);
 355           goto done;
 356         }
 357     }
 358
 359   error = validate_stream (&s);
 360   if (error)
 361     return error;
 362
 363   if (!sub_input_given && !pcap_file_name)
 364     {
 365       error = clib_error_create ("no packet data given");
 366       goto done;
 367     }
 368
 369   if (s.node_index == ~0)
 370     {
 371       if (pcap_file_name != 0)
 372         {
 373           vlib_node_t *n =
 374             vlib_get_node_by_name (vm, (u8 *) "ethernet-input");
 375           s.node_index = n->index;
 376         }
 377       else
 378         {
 379           error = clib_error_create ("output interface or node not given");
 380           goto done;
 381         }
 382     }
 383
 384   {
 385     pg_node_t *n;
 386
 387     if (s.node_index < vec_len (pg->nodes))
 388       n = pg->nodes + s.node_index;
 389     else
 390       n = 0;
 391
 392     if (pcap_file_name != 0)
 393       {
 394         error = pg_pcap_read (&s, pcap_file_name);
 395         if (error)
 396           goto done;
 397         vec_free (pcap_file_name);
 398       }
 399
 400     else if (n && n->unformat_edit
 401              && unformat_user (&sub_input, n->unformat_edit, &s))
 402       ;
 403
 404     else if (!unformat_user (&sub_input, unformat_pg_payload, &s))
 405       {
 406         error = clib_error_create
 407           ("failed to parse packet data from `%U'",
 408            format_unformat_error, &sub_input);
 409         goto done;
 410       }
 411   }
 412
 413   pg_stream_add (pg, &s);
 414   return 0;
 415
 416 done:
 417   pg_stream_free (&s);
 418   unformat_free (&sub_input);
 419   return error;
 420 }
 421
 422 /* *INDENT-OFF* */
 423 VLIB_CLI_COMMAND (new_stream_cli, static) = {
 424   .path = "packet-generator new",
 425   .function = new_stream,
 426   .short_help = "Create packet generator stream",
 427   .long_help =
 428   "Create packet generator stream\n"
 429   "\n"
 430   "Arguments:\n"
 431   "\n"
 432   "name STRING          sets stream name\n"
 433   "interface STRING     interface for stream output \n"
 434   "node NODE-NAME       node for stream output\n"
 435   "data STRING          specifies packet data\n"
 436   "pcap FILENAME        read packet data from pcap file\n",
 437 };
 438 /* *INDENT-ON* */
 439
 440 static clib_error_t *
 441 del_stream (vlib_main_t * vm,
 442             unformat_input_t * input, vlib_cli_command_t * cmd)
 443 {
 444   pg_main_t *pg = &pg_main;
 445   u32 i;
 446
 447   if (!unformat (input, "%U",
 448                  &unformat_hash_vec_string, pg->stream_index_by_name, &i))
 449     return clib_error_create ("expected stream name `%U'",
 450                               format_unformat_error, input);
 451
 452   pg_stream_del (pg, i);
 453   return 0;
 454 }
 455
 456 /* *INDENT-OFF* */
 457 VLIB_CLI_COMMAND (del_stream_cli, static) = {
 458   .path = "packet-generator delete",
 459   .function = del_stream,
 460   .short_help = "Delete stream with given name",
 461 };
 462 /* *INDENT-ON* */
 463
 464 static clib_error_t *
 465 change_stream_parameters (vlib_main_t * vm,
 466                           unformat_input_t * input, vlib_cli_command_t * cmd)
 467 {
 468   pg_main_t *pg = &pg_main;
 469   pg_stream_t *s, s_new;
 470   u32 stream_index = ~0;
 471   clib_error_t *error;
 472
 473   if (unformat (input, "%U", unformat_hash_vec_string,
 474                 pg->stream_index_by_name, &stream_index))
 475     ;
 476   else
 477     return clib_error_create ("expecting stream name; got `%U'",
 478                               format_unformat_error, input);
 479
 480   s = pool_elt_at_index (pg->streams, stream_index);
 481   s_new = s[0];
 482
 483   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 484     {
 485       if (unformat_user (input, unformat_pg_stream_parameter, &s_new))
 486         ;
 487
 488       else
 489         return clib_error_create ("unknown input `%U'",
 490                                   format_unformat_error, input);
 491     }
 492
 493   error = validate_stream (&s_new);
 494   if (!error)
 495     s[0] = s_new;
 496
 497   return error;
 498 }
 499
 500 /* *INDENT-OFF* */
 501 VLIB_CLI_COMMAND (change_stream_parameters_cli, static) = {
 502   .path = "packet-generator configure",
 503   .short_help = "Change packet generator stream parameters",
 504   .function = change_stream_parameters,
 505 };
 506 /* *INDENT-ON* */
 507
 508 static clib_error_t *
 509 pg_capture_cmd_fn (vlib_main_t * vm,
 510                    unformat_input_t * input, vlib_cli_command_t * cmd)
 511 {
 512   clib_error_t *error = 0;
 513   vnet_main_t *vnm = vnet_get_main ();
 514   unformat_input_t _line_input, *line_input = &_line_input;
 515   vnet_hw_interface_t *hi = 0;
 516   u8 *pcap_file_name = 0;
 517   u32 hw_if_index;
 518   u32 is_disable = 0;
 519   u32 count = ~0;
 520
 521   if (!unformat_user (input, unformat_line_input, line_input))
 522     return 0;
 523
 524   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 525     {
 526       if (unformat (line_input, "%U",
 527                     unformat_vnet_hw_interface, vnm, &hw_if_index))
 528         {
 529           hi = vnet_get_hw_interface (vnm, hw_if_index);
 530         }
 531
 532       else if (unformat (line_input, "pcap %s", &pcap_file_name))
 533         ;
 534       else if (unformat (line_input, "count %u", &count))
 535         ;
 536       else if (unformat (line_input, "disable"))
 537         is_disable = 1;
 538
 539       else
 540         {
 541           error = clib_error_create ("unknown input `%U'",
 542                                      format_unformat_error, input);
 543           return error;
 544         }
 545     }
 546
 547   if (!hi)
 548     return clib_error_return (0, "Please specify interface name");
 549
 550   if (hi->dev_class_index != pg_dev_class.index)
 551     return clib_error_return (0, "Please specify packet-generator interface");
 552
 553   if (!pcap_file_name && is_disable == 0)
 554     return clib_error_return (0, "Please specify pcap file name");
 555
 556   unformat_free (line_input);
 557
 558   pg_capture_args_t _a, *a = &_a;
 559
 560   a->hw_if_index = hw_if_index;
 561   a->dev_instance = hi->dev_instance;
 562   a->is_enabled = !is_disable;
 563   a->pcap_file_name = pcap_file_name;
 564   a->count = count;
 565
 566   error = pg_capture (a);
 567   return error;
 568 }
 569
 570 /* *INDENT-OFF* */
 571 VLIB_CLI_COMMAND (pg_capture_cmd, static) = {
 572   .path = "packet-generator capture",
 573   .short_help = "packet-generator capture <interface name> pcap <filename> [count <n>]",
 574   .function = pg_capture_cmd_fn,
 575 };
 576 /* *INDENT-ON* */
 577
 578 static clib_error_t *
 579 create_pg_if_cmd_fn (vlib_main_t * vm,
 580                      unformat_input_t * input, vlib_cli_command_t * cmd)
 581 {
 582   pg_main_t *pg = &pg_main;
 583   unformat_input_t _line_input, *line_input = &_line_input;
 584   u32 if_id;
 585
 586   if (!unformat_user (input, unformat_line_input, line_input))
 587     return 0;
 588
 589   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 590     {
 591       if (unformat (line_input, "interface pg%u", &if_id))
 592         ;
 593
 594       else
 595         return clib_error_create ("unknown input `%U'",
 596                                   format_unformat_error, input);
 597     }
 598
 599   unformat_free (line_input);
 600
 601   pg_interface_add_or_get (pg, if_id);
 602   return 0;
 603 }
 604
 605 /* *INDENT-OFF* */
 606 VLIB_CLI_COMMAND (create_pg_if_cmd, static) = {
 607   .path = "create packet-generator",
 608   .short_help = "create packet-generator interface <interface name>",
 609   .function = create_pg_if_cmd_fn,
 610 };
 611 /* *INDENT-ON* */
 612
 613 /* Dummy init function so that we can be linked in. */
 614 static clib_error_t *
 615 pg_cli_init (vlib_main_t * vm)
 616 {
 617   return 0;
 618 }
 619
 620 VLIB_INIT_FUNCTION (pg_cli_init);
 621
 622 /*
 623  * fd.io coding-style-patch-verification: ON
 624  *
 625  * Local Variables:
 626  * eval: (c-set-style "gnu")
 627  * End:
 628  */