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.
16 * pg_cli.c: packet generator cli
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
42 #include <vnet/vnet.h>
43 #include <vnet/pg/pg.h>
46 #include <vppinfra/pcap.h>
49 /* Root of all packet generator cli commands. */
51 VLIB_CLI_COMMAND (vlib_cli_pg_command, static) = {
52 .path = "packet-generator",
53 .short_help = "Packet generator commands",
58 pg_enable_disable (u32 stream_index, int is_enable)
60 pg_main_t *pg = &pg_main;
63 if (stream_index == ~0)
65 /* No stream specified: enable/disable all streams. */
67 pool_foreach (s, pg->streams, ({
68 pg_stream_enable_disable (pg, s, is_enable);
74 /* enable/disable specified stream. */
75 s = pool_elt_at_index (pg->streams, stream_index);
76 pg_stream_enable_disable (pg, s, is_enable);
81 pg_capture (pg_capture_args_t * a)
83 pg_main_t *pg = &pg_main;
86 if (a->is_enabled == 1)
89 if (stat ((char *) a->pcap_file_name, &sb) != -1)
90 return clib_error_return (0, "Cannot create pcap file");
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));
97 if (a->is_enabled == 0)
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;
108 static clib_error_t *
109 enable_disable_stream (vlib_main_t * vm,
110 unformat_input_t * input, vlib_cli_command_t * cmd)
112 pg_main_t *pg = &pg_main;
113 int is_enable = cmd->function_arg != 0;
114 u32 stream_index = ~0;
116 if (unformat (input, "%U", unformat_eof))
118 else if (unformat (input, "%U", unformat_hash_vec_string,
119 pg->stream_index_by_name, &stream_index))
122 return clib_error_create ("unknown input `%U'",
123 format_unformat_error, input);
125 pg_enable_disable (stream_index, is_enable);
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 */
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 */
149 format_pg_edit_group (u8 * s, va_list * va)
151 pg_edit_group_t *g = va_arg (*va, pg_edit_group_t *);
154 format (s, "hdr-size %d, offset %d, ", g->n_packet_bytes,
155 g->start_byte_offset);
156 if (g->edit_function)
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 != ' ')
165 *junk_after_name = 0;
166 s = format (s, "edit-funtion %s, ", function_name);
167 vec_free (function_name);
174 format_pg_stream (u8 * s, va_list * va)
176 pg_stream_t *t = va_arg (*va, pg_stream_t *);
177 int verbose = va_arg (*va, int);
180 return format (s, "%-16s%=12s%=16s%s",
181 "Name", "Enabled", "Count", "Parameters");
183 s = format (s, "%-16v%=12s%=16Ld",
185 pg_stream_is_enabled (t) ? "Yes" : "No",
186 t->n_packets_generated);
188 int indent = format_get_indent (s);
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, ",
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);
203 vec_foreach (g, t->edit_groups)
205 s = format (s, "\n%U%U", format_white_space, indent, format_pg_edit_group, g);
213 static clib_error_t *
214 show_streams (vlib_main_t * vm,
215 unformat_input_t * input, vlib_cli_command_t * cmd)
217 pg_main_t *pg = &pg_main;
221 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
223 if (unformat (input, "verbose"))
229 if (pool_elts (pg->streams) == 0)
231 vlib_cli_output (vm, "no streams currently defined");
235 vlib_cli_output (vm, "%U", format_pg_stream, 0, 0);
237 pool_foreach (s, pg->streams, ({
238 vlib_cli_output (vm, "%U", format_pg_stream, s, verbose);
247 VLIB_CLI_COMMAND (show_streams_cli, static) = {
248 .path = "show packet-generator ",
249 .short_help = "show packet-generator [verbose]",
250 .function = show_streams,
254 static clib_error_t *
255 pg_pcap_read (pg_stream_t * s, char *file_name)
258 return clib_error_return (0, "no pcap support");
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;
273 if (s->n_packets_limit == 0)
274 s->n_packets_limit = vec_len (pm.packets_read);
277 #endif /* CLIB_UNIX */
281 unformat_pg_stream_parameter (unformat_input_t * input, va_list * args)
283 pg_stream_t *s = va_arg (*args, pg_stream_t *);
286 if (unformat (input, "limit %f", &x))
287 s->n_packets_limit = x;
289 else if (unformat (input, "rate %f", &x))
290 s->rate_packets_per_second = x;
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;
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;
300 else if (unformat (input, "buffer-size %d", &s->buffer_bytes))
309 static clib_error_t *
310 validate_stream (pg_stream_t * s)
312 if (s->max_packet_bytes < s->min_packet_bytes)
313 return clib_error_create ("max-size < min-size");
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");
321 if (s->rate_packets_per_second < 0)
322 return clib_error_create ("negative rate");
327 static clib_error_t *
328 new_stream (vlib_main_t * vm,
329 unformat_input_t * input, vlib_cli_command_t * cmd)
331 clib_error_t *error = 0;
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;
341 s.sw_if_index[VLIB_RX] = s.sw_if_index[VLIB_TX] = ~0;
343 s.max_packet_bytes = s.min_packet_bytes = 64;
344 s.buffer_bytes = vlib_bufer_get_default_size (vm);
347 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
349 if (unformat (input, "name %v", &tmp))
356 else if (unformat (input, "node %U",
357 unformat_vnet_hw_interface, vnm, &hw_if_index))
359 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
361 s.node_index = hi->output_node_index;
362 s.sw_if_index[VLIB_TX] = hi->sw_if_index;
365 else if (unformat (input, "source pg%u", &s.if_id))
368 else if (unformat (input, "node %U",
369 unformat_vlib_node, vm, &s.node_index))
372 else if (unformat (input, "worker %u", &s.worker_index))
375 else if (unformat (input, "interface %U",
376 unformat_vnet_sw_interface, vnm,
377 &s.sw_if_index[VLIB_RX]))
380 else if (unformat (input, "pcap %s", &pcap_file_name))
383 else if (!sub_input_given
384 && unformat (input, "data %U", unformat_input, &sub_input))
387 else if (unformat_user (input, unformat_pg_stream_parameter, &s))
390 else if (unformat (input, "no-recycle"))
391 s.flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
395 error = clib_error_create ("unknown input `%U'",
396 format_unformat_error, input);
401 if (!sub_input_given && !pcap_file_name)
403 error = clib_error_create ("no packet data given");
407 if (s.node_index == ~0)
409 if (pcap_file_name != 0)
412 vlib_get_node_by_name (vm, (u8 *) "ethernet-input");
413 s.node_index = n->index;
417 error = clib_error_create ("output interface or node not given");
425 if (s.node_index < vec_len (pg->nodes))
426 n = pg->nodes + s.node_index;
430 if (s.worker_index >= vlib_num_workers ())
433 if (pcap_file_name != 0)
435 error = pg_pcap_read (&s, pcap_file_name);
438 vec_free (pcap_file_name);
441 else if (n && n->unformat_edit
442 && unformat_user (&sub_input, n->unformat_edit, &s))
445 else if (!unformat_user (&sub_input, unformat_pg_payload, &s))
447 error = clib_error_create
448 ("failed to parse packet data from `%U'",
449 format_unformat_error, &sub_input);
454 error = validate_stream (&s);
458 pg_stream_add (pg, &s);
463 unformat_free (&sub_input);
468 VLIB_CLI_COMMAND (new_stream_cli, static) = {
469 .path = "packet-generator new",
470 .function = new_stream,
471 .short_help = "Create packet generator stream",
473 "Create packet generator stream\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",
485 static clib_error_t *
486 del_stream (vlib_main_t * vm,
487 unformat_input_t * input, vlib_cli_command_t * cmd)
489 pg_main_t *pg = &pg_main;
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);
497 pg_stream_del (pg, i);
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",
509 static clib_error_t *
510 change_stream_parameters (vlib_main_t * vm,
511 unformat_input_t * input, vlib_cli_command_t * cmd)
513 pg_main_t *pg = &pg_main;
514 pg_stream_t *s, s_new;
515 u32 stream_index = ~0;
518 if (unformat (input, "%U", unformat_hash_vec_string,
519 pg->stream_index_by_name, &stream_index))
522 return clib_error_create ("expecting stream name; got `%U'",
523 format_unformat_error, input);
525 s = pool_elt_at_index (pg->streams, stream_index);
528 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
530 if (unformat_user (input, unformat_pg_stream_parameter, &s_new))
534 return clib_error_create ("unknown input `%U'",
535 format_unformat_error, input);
538 error = validate_stream (&s_new);
542 pg_stream_change (pg, s);
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,
556 static clib_error_t *
557 pg_capture_cmd_fn (vlib_main_t * vm,
558 unformat_input_t * input, vlib_cli_command_t * cmd)
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;
569 if (!unformat_user (input, unformat_line_input, line_input))
572 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
574 if (unformat (line_input, "%U",
575 unformat_vnet_hw_interface, vnm, &hw_if_index))
577 hi = vnet_get_hw_interface (vnm, hw_if_index);
580 else if (unformat (line_input, "pcap %s", &pcap_file_name))
582 else if (unformat (line_input, "count %u", &count))
584 else if (unformat (line_input, "disable"))
589 error = clib_error_create ("unknown input `%U'",
590 format_unformat_error, line_input);
597 error = clib_error_return (0, "Please specify interface name");
601 if (hi->dev_class_index != pg_dev_class.index)
604 clib_error_return (0, "Please specify packet-generator interface");
608 if (!pcap_file_name && is_disable == 0)
610 error = clib_error_return (0, "Please specify pcap file name");
615 pg_capture_args_t _a, *a = &_a;
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;
623 error = pg_capture (a);
626 unformat_free (line_input);
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,
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)
643 pg_main_t *pg = &pg_main;
644 unformat_input_t _line_input, *line_input = &_line_input;
646 clib_error_t *error = NULL;
648 if (!unformat_user (input, unformat_line_input, line_input))
651 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
653 if (unformat (line_input, "interface pg%u", &if_id))
658 error = clib_error_create ("unknown input `%U'",
659 format_unformat_error, line_input);
664 pg_interface_add_or_get (pg, if_id);
667 unformat_free (line_input);
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,
680 /* Dummy init function so that we can be linked in. */
681 static clib_error_t *
682 pg_cli_init (vlib_main_t * vm)
687 VLIB_INIT_FUNCTION (pg_cli_init);
690 * fd.io coding-style-patch-verification: ON
693 * eval: (c-set-style "gnu")