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_stream (u8 * s, va_list * va)
151 pg_stream_t *t = va_arg (*va, pg_stream_t *);
155 return format (s, "%=16s%=12s%=16s%s",
156 "Name", "Enabled", "Count", "Parameters");
158 s = format (s, "%-16v%=12s%16Ld",
160 pg_stream_is_enabled (t) ? "Yes" : "No",
161 t->n_packets_generated);
165 v = format (v, "limit %Ld, ", t->n_packets_limit);
167 v = format (v, "rate %.2e pps, ", t->rate_packets_per_second);
169 v = format (v, "size %d%c%d, ",
171 t->packet_size_edit_type == PG_EDIT_RANDOM ? '+' : '-',
172 t->max_packet_bytes);
174 v = format (v, "buffer-size %d, ", t->buffer_bytes);
176 v = format (v, "worker %d, ", t->worker_index);
180 s = format (s, " %v", v);
187 static clib_error_t *
188 show_streams (vlib_main_t * vm,
189 unformat_input_t * input, vlib_cli_command_t * cmd)
191 pg_main_t *pg = &pg_main;
194 if (pool_elts (pg->streams) == 0)
196 vlib_cli_output (vm, "no streams currently defined");
200 vlib_cli_output (vm, "%U", format_pg_stream, 0);
202 pool_foreach (s, pg->streams, ({
203 vlib_cli_output (vm, "%U", format_pg_stream, s);
212 VLIB_CLI_COMMAND (show_streams_cli, static) = {
213 .path = "show packet-generator",
214 .short_help = "Show packet generator streams",
215 .function = show_streams,
219 static clib_error_t *
220 pg_pcap_read (pg_stream_t * s, char *file_name)
223 return clib_error_return (0, "no pcap support");
227 clib_memset (&pm, 0, sizeof (pm));
228 pm.file_name = file_name;
229 error = pcap_read (&pm);
230 s->replay_packet_templates = pm.packets_read;
231 s->replay_packet_timestamps = pm.timestamps;
232 s->min_packet_bytes = pm.min_packet_bytes;
233 s->max_packet_bytes = pm.max_packet_bytes;
234 s->buffer_bytes = pm.max_packet_bytes;
235 /* For PCAP buffers we never re-use buffers. */
236 s->flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
238 if (s->n_packets_limit == 0)
239 s->n_packets_limit = vec_len (pm.packets_read);
242 #endif /* CLIB_UNIX */
246 unformat_pg_stream_parameter (unformat_input_t * input, va_list * args)
248 pg_stream_t *s = va_arg (*args, pg_stream_t *);
251 if (unformat (input, "limit %f", &x))
252 s->n_packets_limit = x;
254 else if (unformat (input, "rate %f", &x))
255 s->rate_packets_per_second = x;
257 else if (unformat (input, "size %d-%d", &s->min_packet_bytes,
258 &s->max_packet_bytes))
259 s->packet_size_edit_type = PG_EDIT_INCREMENT;
261 else if (unformat (input, "size %d+%d", &s->min_packet_bytes,
262 &s->max_packet_bytes))
263 s->packet_size_edit_type = PG_EDIT_RANDOM;
265 else if (unformat (input, "buffer-size %d", &s->buffer_bytes))
274 static clib_error_t *
275 validate_stream (pg_stream_t * s)
277 if (s->max_packet_bytes < s->min_packet_bytes)
278 return clib_error_create ("max-size < min-size");
280 if (s->buffer_bytes >= 4096 || s->buffer_bytes == 0)
282 clib_error_create ("buffer-size must be positive and < 4096, given %d",
285 if (s->rate_packets_per_second < 0)
286 return clib_error_create ("negative rate");
291 static clib_error_t *
292 new_stream (vlib_main_t * vm,
293 unformat_input_t * input, vlib_cli_command_t * cmd)
295 clib_error_t *error = 0;
298 unformat_input_t sub_input = { 0 };
299 int sub_input_given = 0;
300 vnet_main_t *vnm = vnet_get_main ();
301 pg_main_t *pg = &pg_main;
302 pg_stream_t s = { 0 };
303 char *pcap_file_name;
305 s.sw_if_index[VLIB_RX] = s.sw_if_index[VLIB_TX] = ~0;
307 s.max_packet_bytes = s.min_packet_bytes = 64;
308 s.buffer_bytes = VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES;
311 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
313 if (unformat (input, "name %v", &tmp))
320 else if (unformat (input, "node %U",
321 unformat_vnet_hw_interface, vnm, &hw_if_index))
323 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
325 s.node_index = hi->output_node_index;
326 s.sw_if_index[VLIB_TX] = hi->sw_if_index;
329 else if (unformat (input, "source pg%u", &s.if_id))
332 else if (unformat (input, "node %U",
333 unformat_vlib_node, vm, &s.node_index))
336 else if (unformat (input, "worker %u", &s.worker_index))
339 else if (unformat (input, "interface %U",
340 unformat_vnet_sw_interface, vnm,
341 &s.sw_if_index[VLIB_RX]))
344 else if (unformat (input, "pcap %s", &pcap_file_name))
347 else if (!sub_input_given
348 && unformat (input, "data %U", unformat_input, &sub_input))
351 else if (unformat_user (input, unformat_pg_stream_parameter, &s))
354 else if (unformat (input, "no-recycle"))
355 s.flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
359 error = clib_error_create ("unknown input `%U'",
360 format_unformat_error, input);
365 error = validate_stream (&s);
369 if (!sub_input_given && !pcap_file_name)
371 error = clib_error_create ("no packet data given");
375 if (s.node_index == ~0)
377 if (pcap_file_name != 0)
380 vlib_get_node_by_name (vm, (u8 *) "ethernet-input");
381 s.node_index = n->index;
385 error = clib_error_create ("output interface or node not given");
393 if (s.node_index < vec_len (pg->nodes))
394 n = pg->nodes + s.node_index;
398 if (s.worker_index >= vlib_num_workers ())
401 if (pcap_file_name != 0)
403 error = pg_pcap_read (&s, pcap_file_name);
406 vec_free (pcap_file_name);
409 else if (n && n->unformat_edit
410 && unformat_user (&sub_input, n->unformat_edit, &s))
413 else if (!unformat_user (&sub_input, unformat_pg_payload, &s))
415 error = clib_error_create
416 ("failed to parse packet data from `%U'",
417 format_unformat_error, &sub_input);
422 pg_stream_add (pg, &s);
427 unformat_free (&sub_input);
432 VLIB_CLI_COMMAND (new_stream_cli, static) = {
433 .path = "packet-generator new",
434 .function = new_stream,
435 .short_help = "Create packet generator stream",
437 "Create packet generator stream\n"
441 "name STRING sets stream name\n"
442 "interface STRING interface for stream output \n"
443 "node NODE-NAME node for stream output\n"
444 "data STRING specifies packet data\n"
445 "pcap FILENAME read packet data from pcap file\n",
449 static clib_error_t *
450 del_stream (vlib_main_t * vm,
451 unformat_input_t * input, vlib_cli_command_t * cmd)
453 pg_main_t *pg = &pg_main;
456 if (!unformat (input, "%U",
457 &unformat_hash_vec_string, pg->stream_index_by_name, &i))
458 return clib_error_create ("expected stream name `%U'",
459 format_unformat_error, input);
461 pg_stream_del (pg, i);
466 VLIB_CLI_COMMAND (del_stream_cli, static) = {
467 .path = "packet-generator delete",
468 .function = del_stream,
469 .short_help = "Delete stream with given name",
473 static clib_error_t *
474 change_stream_parameters (vlib_main_t * vm,
475 unformat_input_t * input, vlib_cli_command_t * cmd)
477 pg_main_t *pg = &pg_main;
478 pg_stream_t *s, s_new;
479 u32 stream_index = ~0;
482 if (unformat (input, "%U", unformat_hash_vec_string,
483 pg->stream_index_by_name, &stream_index))
486 return clib_error_create ("expecting stream name; got `%U'",
487 format_unformat_error, input);
489 s = pool_elt_at_index (pg->streams, stream_index);
492 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
494 if (unformat_user (input, unformat_pg_stream_parameter, &s_new))
498 return clib_error_create ("unknown input `%U'",
499 format_unformat_error, input);
502 error = validate_stream (&s_new);
510 VLIB_CLI_COMMAND (change_stream_parameters_cli, static) = {
511 .path = "packet-generator configure",
512 .short_help = "Change packet generator stream parameters",
513 .function = change_stream_parameters,
517 static clib_error_t *
518 pg_capture_cmd_fn (vlib_main_t * vm,
519 unformat_input_t * input, vlib_cli_command_t * cmd)
521 clib_error_t *error = 0;
522 vnet_main_t *vnm = vnet_get_main ();
523 unformat_input_t _line_input, *line_input = &_line_input;
524 vnet_hw_interface_t *hi = 0;
525 u8 *pcap_file_name = 0;
530 if (!unformat_user (input, unformat_line_input, line_input))
533 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
535 if (unformat (line_input, "%U",
536 unformat_vnet_hw_interface, vnm, &hw_if_index))
538 hi = vnet_get_hw_interface (vnm, hw_if_index);
541 else if (unformat (line_input, "pcap %s", &pcap_file_name))
543 else if (unformat (line_input, "count %u", &count))
545 else if (unformat (line_input, "disable"))
550 error = clib_error_create ("unknown input `%U'",
551 format_unformat_error, line_input);
558 error = clib_error_return (0, "Please specify interface name");
562 if (hi->dev_class_index != pg_dev_class.index)
565 clib_error_return (0, "Please specify packet-generator interface");
569 if (!pcap_file_name && is_disable == 0)
571 error = clib_error_return (0, "Please specify pcap file name");
576 pg_capture_args_t _a, *a = &_a;
578 a->hw_if_index = hw_if_index;
579 a->dev_instance = hi->dev_instance;
580 a->is_enabled = !is_disable;
581 a->pcap_file_name = pcap_file_name;
584 error = pg_capture (a);
587 unformat_free (line_input);
593 VLIB_CLI_COMMAND (pg_capture_cmd, static) = {
594 .path = "packet-generator capture",
595 .short_help = "packet-generator capture <interface name> pcap <filename> [count <n>]",
596 .function = pg_capture_cmd_fn,
600 static clib_error_t *
601 create_pg_if_cmd_fn (vlib_main_t * vm,
602 unformat_input_t * input, vlib_cli_command_t * cmd)
604 pg_main_t *pg = &pg_main;
605 unformat_input_t _line_input, *line_input = &_line_input;
607 clib_error_t *error = NULL;
609 if (!unformat_user (input, unformat_line_input, line_input))
612 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
614 if (unformat (line_input, "interface pg%u", &if_id))
619 error = clib_error_create ("unknown input `%U'",
620 format_unformat_error, line_input);
625 pg_interface_add_or_get (pg, if_id);
628 unformat_free (line_input);
634 VLIB_CLI_COMMAND (create_pg_if_cmd, static) = {
635 .path = "create packet-generator",
636 .short_help = "create packet-generator interface <interface name>",
637 .function = create_pg_if_cmd_fn,
641 /* Dummy init function so that we can be linked in. */
642 static clib_error_t *
643 pg_cli_init (vlib_main_t * vm)
648 VLIB_INIT_FUNCTION (pg_cli_init);
651 * fd.io coding-style-patch-verification: ON
654 * eval: (c-set-style "gnu")