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 <vnet/unix/pcap.h>
49 /* Root of all packet generator cli commands. */
50 VLIB_CLI_COMMAND (vlib_cli_pg_command, static) = {
51 .path = "packet-generator",
52 .short_help = "Packet generator commands",
56 enable_disable_stream (vlib_main_t * vm,
57 unformat_input_t * input,
58 vlib_cli_command_t * cmd)
60 pg_main_t * pg = &pg_main;
62 int is_enable = cmd->function_arg != 0;
63 u32 stream_index = ~0;
65 if (unformat (input, "%U", unformat_eof))
67 else if (unformat (input, "%U", unformat_hash_vec_string,
68 pg->stream_index_by_name, &stream_index))
71 return clib_error_create ("unknown input `%U'",
72 format_unformat_error, input);
74 /* No stream specified: enable/disable all streams. */
75 if (stream_index == ~0)
76 pool_foreach (s, pg->streams, ({
77 pg_stream_enable_disable (pg, s, is_enable);
81 /* enable/disable specified stream. */
82 s = pool_elt_at_index (pg->streams, stream_index);
83 pg_stream_enable_disable (pg, s, is_enable);
89 VLIB_CLI_COMMAND (enable_streams_cli, static) = {
90 .path = "packet-generator enable-stream",
91 .short_help = "Enable packet generator streams",
92 .function = enable_disable_stream,
93 .function_arg = 1, /* is_enable */
96 VLIB_CLI_COMMAND (disable_streams_cli, static) = {
97 .path = "packet-generator disable-stream",
98 .short_help = "Disable packet generator streams",
99 .function = enable_disable_stream,
100 .function_arg = 0, /* is_enable */
103 static u8 * format_pg_stream (u8 * s, va_list * va)
105 pg_stream_t * t = va_arg (*va, pg_stream_t *);
109 return format (s, "%=16s%=12s%=16s%s",
110 "Name", "Enabled", "Count", "Parameters");
112 s = format (s, "%-16v%=12s%16Ld",
114 pg_stream_is_enabled (t) ? "Yes" : "No",
115 t->n_packets_generated);
119 v = format (v, "limit %Ld, ", t->n_packets_limit);
121 v = format (v, "rate %.2e pps, ", t->rate_packets_per_second);
123 v = format (v, "size %d%c%d, ",
125 t->packet_size_edit_type == PG_EDIT_RANDOM ? '+' : '-',
126 t->max_packet_bytes);
128 v = format (v, "buffer-size %d, ", t->buffer_bytes);
132 s = format (s, " %v", v);
139 static clib_error_t *
140 show_streams (vlib_main_t * vm,
141 unformat_input_t * input,
142 vlib_cli_command_t * cmd)
144 pg_main_t * pg = &pg_main;
147 if (pool_elts (pg->streams) == 0)
149 vlib_cli_output (vm, "no streams currently defined");
153 vlib_cli_output (vm, "%U", format_pg_stream, 0);
154 pool_foreach (s, pg->streams, ({
155 vlib_cli_output (vm, "%U", format_pg_stream, s);
162 VLIB_CLI_COMMAND (show_streams_cli, static) = {
163 .path = "show packet-generator",
164 .short_help = "Show packet generator streams",
165 .function = show_streams,
168 static clib_error_t *
169 pg_pcap_read (pg_stream_t * s, char * file_name)
172 return clib_error_return (0, "no pcap support");
175 clib_error_t * error;
176 memset (&pm, 0, sizeof (pm));
177 pm.file_name = file_name;
178 error = pcap_read (&pm);
179 s->replay_packet_templates = pm.packets_read;
180 s->min_packet_bytes = pm.min_packet_bytes;
181 s->max_packet_bytes = pm.max_packet_bytes;
182 s->buffer_bytes = pm.max_packet_bytes;
183 /* For PCAP buffers we never re-use buffers. */
184 s->flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
186 #endif /* CLIB_UNIX */
190 unformat_pg_stream_parameter (unformat_input_t * input, va_list * args)
192 pg_stream_t * s = va_arg (*args, pg_stream_t *);
195 if (unformat (input, "limit %f", &x))
196 s->n_packets_limit = x;
198 else if (unformat (input, "rate %f", &x))
199 s->rate_packets_per_second = x;
201 else if (unformat (input, "size %d-%d", &s->min_packet_bytes,
202 &s->max_packet_bytes))
203 s->packet_size_edit_type = PG_EDIT_INCREMENT;
205 else if (unformat (input, "size %d+%d", &s->min_packet_bytes,
206 &s->max_packet_bytes))
207 s->packet_size_edit_type = PG_EDIT_RANDOM;
209 else if (unformat (input, "buffer-size %d", &s->buffer_bytes))
218 static clib_error_t *
219 validate_stream (pg_stream_t * s)
221 if (s->max_packet_bytes < s->min_packet_bytes)
222 return clib_error_create ("max-size < min-size");
224 if (s->buffer_bytes >= 4096 || s->buffer_bytes == 0)
225 return clib_error_create ("buffer-size must be positive and < 4096, given %d",
228 if (s->rate_packets_per_second < 0)
229 return clib_error_create ("negative rate");
234 static clib_error_t *
235 new_stream (vlib_main_t * vm,
236 unformat_input_t * input,
237 vlib_cli_command_t * cmd)
239 clib_error_t * error = 0;
242 unformat_input_t sub_input = {0};
243 int sub_input_given = 0;
244 vnet_main_t * vnm = vnet_get_main();
245 pg_main_t * pg = &pg_main;
247 char * pcap_file_name;
249 s.sw_if_index[VLIB_RX] = s.sw_if_index[VLIB_TX] = ~0;
251 s.max_packet_bytes = s.min_packet_bytes = 64;
252 s.buffer_bytes = VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES;
255 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
257 if (unformat (input, "name %v", &tmp))
264 else if (unformat (input, "node %U",
265 unformat_vnet_hw_interface, vnm, &hw_if_index))
267 vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
269 s.node_index = hi->output_node_index;
270 s.sw_if_index[VLIB_TX] = hi->sw_if_index;
273 else if (unformat (input, "source pg%u",&s.if_id))
276 else if (unformat (input, "node %U",
277 unformat_vlib_node, vm, &s.node_index))
280 else if (unformat (input, "interface %U",
281 unformat_vnet_sw_interface, vnm, &s.sw_if_index[VLIB_RX]))
284 else if (unformat (input, "pcap %s", &pcap_file_name))
287 else if (! sub_input_given
288 && unformat (input, "data %U", unformat_input, &sub_input))
291 else if (unformat_user (input, unformat_pg_stream_parameter, &s))
294 else if (unformat (input, "no-recycle"))
295 s.flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
299 error = clib_error_create ("unknown input `%U'",
300 format_unformat_error, input);
305 error = validate_stream (&s);
309 if (! sub_input_given && ! pcap_file_name)
311 error = clib_error_create ("no packet data given");
315 if (s.node_index == ~0)
317 error = clib_error_create ("output interface or node not given");
324 if (s.node_index < vec_len (pg->nodes))
325 n = pg->nodes + s.node_index;
329 if (pcap_file_name != 0)
331 error = pg_pcap_read (&s, pcap_file_name);
334 vec_free (pcap_file_name);
337 else if (n && n->unformat_edit
338 && unformat_user (&sub_input, n->unformat_edit, &s))
341 else if (! unformat_user (&sub_input, unformat_pg_payload, &s))
343 error = clib_error_create
344 ("failed to parse packet data from `%U'",
345 format_unformat_error, &sub_input);
350 pg_stream_add (pg, &s);
355 unformat_free (&sub_input);
359 VLIB_CLI_COMMAND (new_stream_cli, static) = {
360 .path = "packet-generator new",
361 .function = new_stream,
362 .short_help = "Create packet generator stream",
364 "Create packet generator stream\n"
368 "name STRING sets stream name\n"
369 "interface STRING interface for stream output \n"
370 "node NODE-NAME node for stream output\n"
371 "data STRING specifies packet data\n",
374 static clib_error_t *
375 del_stream (vlib_main_t * vm,
376 unformat_input_t * input,
377 vlib_cli_command_t * cmd)
379 pg_main_t * pg = &pg_main;
382 if (! unformat (input, "%U",
383 &unformat_hash_vec_string, pg->stream_index_by_name, &i))
384 return clib_error_create ("expected stream name `%U'",
385 format_unformat_error, input);
387 pg_stream_del (pg, i);
391 VLIB_CLI_COMMAND (del_stream_cli, static) = {
392 .path = "packet-generator delete",
393 .function = del_stream,
394 .short_help = "Delete stream with given name",
397 static clib_error_t *
398 change_stream_parameters (vlib_main_t * vm,
399 unformat_input_t * input,
400 vlib_cli_command_t * cmd)
402 pg_main_t * pg = &pg_main;
403 pg_stream_t * s, s_new;
404 u32 stream_index = ~0;
405 clib_error_t * error;
407 if (unformat (input, "%U", unformat_hash_vec_string,
408 pg->stream_index_by_name, &stream_index))
411 return clib_error_create ("expecting stream name; got `%U'",
412 format_unformat_error, input);
414 s = pool_elt_at_index (pg->streams, stream_index);
417 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
419 if (unformat_user (input, unformat_pg_stream_parameter, &s_new))
423 return clib_error_create ("unknown input `%U'",
424 format_unformat_error, input);
427 error = validate_stream (&s_new);
434 VLIB_CLI_COMMAND (change_stream_parameters_cli, static) = {
435 .path = "packet-generator configure",
436 .short_help = "Change packet generator stream parameters",
437 .function = change_stream_parameters,
440 static clib_error_t *
441 pg_capture_cmd_fn (vlib_main_t * vm,
442 unformat_input_t * input,
443 vlib_cli_command_t * cmd)
445 pg_main_t * pg = &pg_main;
446 clib_error_t * error = 0;
447 vnet_main_t * vnm = vnet_get_main();
448 unformat_input_t _line_input, * line_input = &_line_input;
449 vnet_hw_interface_t * hi = 0;
451 u8 * pcap_file_name = 0;
455 if (! unformat_user (input, unformat_line_input, line_input))
458 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
460 if (unformat (line_input, "%U",
461 unformat_vnet_hw_interface, vnm, &hw_if_index))
463 hi = vnet_get_hw_interface (vnm, hw_if_index);
466 else if (unformat (line_input, "pcap %s", &pcap_file_name))
468 else if (unformat (line_input, "count %u", &count))
473 error = clib_error_create ("unknown input `%U'",
474 format_unformat_error, input);
480 return clib_error_return (0, "Please specify interface name");
482 if (hi->dev_class_index != pg_dev_class.index)
483 return clib_error_return (0, "Please specify packet-generator interface");
486 return clib_error_return (0, "Please specify pcap file name");
490 if (stat ((char *) pcap_file_name, &sb) != -1)
491 return clib_error_return (0, "Cannot create pcap file");
494 unformat_free (line_input);
496 pi = pool_elt_at_index (pg->interfaces, hi->dev_instance);
497 vec_free (pi->pcap_file_name);
498 pi->pcap_file_name = pcap_file_name;
499 memset (&pi->pcap_main, 0, sizeof (pi->pcap_main));
500 pi->pcap_main.file_name = (char *) pi->pcap_file_name;
501 pi->pcap_main.n_packets_to_capture = count;
502 pi->pcap_main.packet_type = PCAP_PACKET_TYPE_ethernet;
507 VLIB_CLI_COMMAND (pg_capture_cmd, static) = {
508 .path = "packet-generator capture",
509 .short_help = "packet-generator capture <interface name> pcap <filename> [count <n>]",
510 .function = pg_capture_cmd_fn,
513 static clib_error_t *
514 create_pg_if_cmd_fn (vlib_main_t * vm,
515 unformat_input_t * input,
516 vlib_cli_command_t * cmd)
518 pg_main_t * pg = &pg_main;
519 unformat_input_t _line_input, * line_input = &_line_input;
522 if (! unformat_user (input, unformat_line_input, line_input))
525 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
527 if (unformat (line_input, "interface pg%u", &if_id))
531 return clib_error_create ("unknown input `%U'",
532 format_unformat_error, input);
535 unformat_free (line_input);
537 pg_interface_add_or_get (pg, if_id);
541 VLIB_CLI_COMMAND (create_pg_if_cmd, static) = {
542 .path = "create packet-generator",
543 .short_help = "create packet-generator interface <interface name>",
544 .function = create_pg_if_cmd_fn,
547 /* Dummy init function so that we can be linked in. */
548 static clib_error_t * pg_cli_init (vlib_main_t * vm)
551 VLIB_INIT_FUNCTION (pg_cli_init);