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.
40 #include <vnet/vnet.h>
41 #include <vnet/pg/pg.h>
44 #include <vnet/unix/pcap.h>
47 /* Root of all packet generator cli commands. */
48 VLIB_CLI_COMMAND (vlib_cli_pg_command, static) = {
49 .path = "packet-generator",
50 .short_help = "Packet generator commands",
54 enable_disable_stream (vlib_main_t * vm,
55 unformat_input_t * input,
56 vlib_cli_command_t * cmd)
58 pg_main_t * pg = &pg_main;
60 int is_enable = cmd->function_arg != 0;
61 u32 stream_index = ~0;
63 if (unformat (input, "%U", unformat_eof))
65 else if (unformat (input, "%U", unformat_hash_vec_string,
66 pg->stream_index_by_name, &stream_index))
69 return clib_error_create ("unknown input `%U'",
70 format_unformat_error, input);
72 /* No stream specified: enable/disable all streams. */
73 if (stream_index == ~0)
74 pool_foreach (s, pg->streams, ({
75 pg_stream_enable_disable (pg, s, is_enable);
79 /* enable/disable specified stream. */
80 s = pool_elt_at_index (pg->streams, stream_index);
81 pg_stream_enable_disable (pg, s, is_enable);
87 VLIB_CLI_COMMAND (enable_streams_cli, static) = {
88 .path = "packet-generator enable-stream",
89 .short_help = "Enable packet generator streams",
90 .function = enable_disable_stream,
91 .function_arg = 1, /* is_enable */
94 VLIB_CLI_COMMAND (disable_streams_cli, static) = {
95 .path = "packet-generator disable-stream",
96 .short_help = "Disable packet generator streams",
97 .function = enable_disable_stream,
98 .function_arg = 0, /* is_enable */
101 static u8 * format_pg_stream (u8 * s, va_list * va)
103 pg_stream_t * t = va_arg (*va, pg_stream_t *);
107 return format (s, "%=16s%=12s%=16s%s",
108 "Name", "Enabled", "Count", "Parameters");
110 s = format (s, "%-16v%=12s%16Ld",
112 pg_stream_is_enabled (t) ? "Yes" : "No",
113 t->n_packets_generated);
117 v = format (v, "limit %Ld, ", t->n_packets_limit);
119 v = format (v, "rate %.2e pps, ", t->rate_packets_per_second);
121 v = format (v, "size %d%c%d, ",
123 t->packet_size_edit_type == PG_EDIT_RANDOM ? '+' : '-',
124 t->max_packet_bytes);
126 v = format (v, "buffer-size %d, ", t->buffer_bytes);
130 s = format (s, " %v", v);
137 static clib_error_t *
138 show_streams (vlib_main_t * vm,
139 unformat_input_t * input,
140 vlib_cli_command_t * cmd)
142 pg_main_t * pg = &pg_main;
145 if (pool_elts (pg->streams) == 0)
147 vlib_cli_output (vm, "no streams currently defined");
151 vlib_cli_output (vm, "%U", format_pg_stream, 0);
152 pool_foreach (s, pg->streams, ({
153 vlib_cli_output (vm, "%U", format_pg_stream, s);
160 VLIB_CLI_COMMAND (show_streams_cli, static) = {
161 .path = "show packet-generator",
162 .short_help = "Show packet generator streams",
163 .function = show_streams,
166 static clib_error_t *
167 pg_pcap_read (pg_stream_t * s, char * file_name)
170 return clib_error_return (0, "no pcap support");
173 clib_error_t * error;
174 memset (&pm, 0, sizeof (pm));
175 pm.file_name = file_name;
176 error = pcap_read (&pm);
177 s->replay_packet_templates = pm.packets_read;
178 s->min_packet_bytes = pm.min_packet_bytes;
179 s->max_packet_bytes = pm.max_packet_bytes;
180 s->buffer_bytes = pm.max_packet_bytes;
181 /* For PCAP buffers we never re-use buffers. */
182 s->flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
184 #endif /* CLIB_UNIX */
188 unformat_pg_stream_parameter (unformat_input_t * input, va_list * args)
190 pg_stream_t * s = va_arg (*args, pg_stream_t *);
193 if (unformat (input, "limit %f", &x))
194 s->n_packets_limit = x;
196 else if (unformat (input, "rate %f", &x))
197 s->rate_packets_per_second = x;
199 else if (unformat (input, "size %d-%d", &s->min_packet_bytes,
200 &s->max_packet_bytes))
201 s->packet_size_edit_type = PG_EDIT_INCREMENT;
203 else if (unformat (input, "size %d+%d", &s->min_packet_bytes,
204 &s->max_packet_bytes))
205 s->packet_size_edit_type = PG_EDIT_RANDOM;
207 else if (unformat (input, "buffer-size %d", &s->buffer_bytes))
216 static clib_error_t *
217 validate_stream (pg_stream_t * s)
219 if (s->max_packet_bytes < s->min_packet_bytes)
220 return clib_error_create ("max-size < min-size");
222 if (s->buffer_bytes >= 4096 || s->buffer_bytes == 0)
223 return clib_error_create ("buffer-size must be positive and < 4096, given %d",
226 if (s->rate_packets_per_second < 0)
227 return clib_error_create ("negative rate");
232 static clib_error_t *
233 new_stream (vlib_main_t * vm,
234 unformat_input_t * input,
235 vlib_cli_command_t * cmd)
237 clib_error_t * error = 0;
240 unformat_input_t sub_input = {0};
241 int sub_input_given = 0;
242 vnet_main_t * vnm = vnet_get_main();
243 pg_main_t * pg = &pg_main;
245 char * pcap_file_name;
247 s.sw_if_index[VLIB_RX] = s.sw_if_index[VLIB_TX] = ~0;
249 s.max_packet_bytes = s.min_packet_bytes = 64;
250 s.buffer_bytes = VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES;
252 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
254 if (unformat (input, "name %v", &tmp))
261 else if (unformat (input, "node %U",
262 unformat_vnet_hw_interface, vnm, &hw_if_index))
264 vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, hw_if_index);
266 s.node_index = hi->output_node_index;
267 s.sw_if_index[VLIB_TX] = hi->sw_if_index;
270 else if (unformat (input, "node %U",
271 unformat_vlib_node, vm, &s.node_index))
274 else if (unformat (input, "interface %U",
275 unformat_vnet_sw_interface, vnm, &s.sw_if_index[VLIB_RX]))
278 else if (unformat (input, "pcap %s", &pcap_file_name))
281 else if (! sub_input_given
282 && unformat (input, "data %U", unformat_input, &sub_input))
285 else if (unformat_user (input, unformat_pg_stream_parameter, &s))
288 else if (unformat (input, "no-recycle"))
289 s.flags |= PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE;
293 error = clib_error_create ("unknown input `%U'",
294 format_unformat_error, input);
299 error = validate_stream (&s);
303 if (! sub_input_given && ! pcap_file_name)
305 error = clib_error_create ("no packet data given");
309 if (s.node_index == ~0)
311 error = clib_error_create ("output interface or node not given");
318 if (s.node_index < vec_len (pg->nodes))
319 n = pg->nodes + s.node_index;
323 if (pcap_file_name != 0)
325 error = pg_pcap_read (&s, pcap_file_name);
328 vec_free (pcap_file_name);
331 else if (n && n->unformat_edit
332 && unformat_user (&sub_input, n->unformat_edit, &s))
335 else if (! unformat_user (&sub_input, unformat_pg_payload, &s))
337 error = clib_error_create
338 ("failed to parse packet data from `%U'",
339 format_unformat_error, &sub_input);
344 pg_stream_add (pg, &s);
349 unformat_free (&sub_input);
353 VLIB_CLI_COMMAND (new_stream_cli, static) = {
354 .path = "packet-generator new",
355 .function = new_stream,
356 .short_help = "Create packet generator stream",
358 "Create packet generator stream\n"
362 "name STRING sets stream name\n"
363 "interface STRING interface for stream output \n"
364 "node NODE-NAME node for stream output\n"
365 "data STRING specifies packet data\n",
368 static clib_error_t *
369 del_stream (vlib_main_t * vm,
370 unformat_input_t * input,
371 vlib_cli_command_t * cmd)
373 pg_main_t * pg = &pg_main;
376 if (! unformat (input, "%U",
377 &unformat_hash_vec_string, pg->stream_index_by_name, &i))
378 return clib_error_create ("expected stream name `%U'",
379 format_unformat_error, input);
381 pg_stream_del (pg, i);
385 VLIB_CLI_COMMAND (del_stream_cli, static) = {
386 .path = "packet-generator delete",
387 .function = del_stream,
388 .short_help = "Delete stream with given name",
391 static clib_error_t *
392 change_stream_parameters (vlib_main_t * vm,
393 unformat_input_t * input,
394 vlib_cli_command_t * cmd)
396 pg_main_t * pg = &pg_main;
397 pg_stream_t * s, s_new;
398 u32 stream_index = ~0;
399 clib_error_t * error;
401 if (unformat (input, "%U", unformat_hash_vec_string,
402 pg->stream_index_by_name, &stream_index))
405 return clib_error_create ("expecting stream name; got `%U'",
406 format_unformat_error, input);
408 s = pool_elt_at_index (pg->streams, stream_index);
411 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
413 if (unformat_user (input, unformat_pg_stream_parameter, &s_new))
417 return clib_error_create ("unknown input `%U'",
418 format_unformat_error, input);
421 error = validate_stream (&s_new);
428 VLIB_CLI_COMMAND (change_stream_parameters_cli, static) = {
429 .path = "packet-generator configure",
430 .short_help = "Change packet generator stream parameters",
431 .function = change_stream_parameters,
434 /* Dummy init function so that we can be linked in. */
435 static clib_error_t * pg_cli_init (vlib_main_t * vm)
438 VLIB_INIT_FUNCTION (pg_cli_init);