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_stream.c: packet generator streams
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>
43 /* Mark stream active or inactive. */
44 void pg_stream_enable_disable (pg_main_t * pg, pg_stream_t * s, int want_enabled)
46 vnet_main_t * vnm = vnet_get_main();
47 pg_interface_t * pi = vec_elt_at_index (pg->interfaces, s->pg_if_index);
49 want_enabled = want_enabled != 0;
51 if (pg_stream_is_enabled (s) == want_enabled)
52 /* No change necessary. */
56 s->n_packets_generated = 0;
58 /* Toggle enabled flag. */
59 s->flags ^= PG_STREAM_FLAGS_IS_ENABLED;
61 ASSERT (! pool_is_free (pg->streams, s));
64 = clib_bitmap_set (pg->enabled_streams, s - pg->streams, want_enabled);
66 vnet_hw_interface_set_flags (vnm, pi->hw_if_index,
68 ? VNET_HW_INTERFACE_FLAG_LINK_UP
71 vnet_sw_interface_set_flags (vnm, pi->sw_if_index,
73 ? VNET_SW_INTERFACE_FLAG_ADMIN_UP
76 vlib_node_set_state (pg->vlib_main,
78 (clib_bitmap_is_zero (pg->enabled_streams)
79 ? VLIB_NODE_STATE_DISABLED
80 : VLIB_NODE_STATE_POLLING));
82 s->packet_accumulator = 0;
83 s->time_last_generate = 0;
86 static u8 * format_pg_interface_name (u8 * s, va_list * args)
88 pg_main_t * pg = &pg_main;
89 u32 if_index = va_arg (*args, u32);
92 pi = vec_elt_at_index (pg->interfaces, if_index);
93 s = format (s, "pg/stream-%d", pi->stream_index);
98 VNET_DEVICE_CLASS (pg_dev_class,static) = {
100 .tx_function = pg_output,
101 .format_device_name = format_pg_interface_name,
104 static uword pg_set_rewrite (vnet_main_t * vnm,
109 uword max_rewrite_bytes)
113 if (max_rewrite_bytes < sizeof (h[0]))
116 h[0] = clib_host_to_net_u16 (l3_type);
117 return sizeof (h[0]);
120 VNET_HW_INTERFACE_CLASS (pg_interface_class,static) = {
121 .name = "Packet generator",
122 .set_rewrite = pg_set_rewrite,
125 u32 pg_interface_find_free (pg_main_t * pg, uword stream_index)
127 vnet_main_t * vnm = vnet_get_main();
129 vnet_hw_interface_t * hi;
132 if ((l = vec_len (pg->free_interfaces)) > 0)
134 i = pg->free_interfaces[l - 1];
135 _vec_len (pg->free_interfaces) = l - 1;
136 pi = vec_elt_at_index (pg->interfaces, i);
137 pi->stream_index = stream_index;
141 i = vec_len (pg->interfaces);
142 vec_add2 (pg->interfaces, pi, 1);
144 pi->stream_index = stream_index;
145 pi->hw_if_index = vnet_register_interface (vnm,
146 pg_dev_class.index, i,
147 pg_interface_class.index, stream_index);
148 hi = vnet_get_hw_interface (vnm, pi->hw_if_index);
149 pi->sw_if_index = hi->sw_if_index;
155 static void do_edit (pg_stream_t * stream,
160 u32 i, i0, i1, mask, n_bits_left;
163 i0 = e->lsb_bit_offset / BITS (u8);
165 /* Make space for edit in value and mask. */
166 vec_validate (g->fixed_packet_data, i0);
167 vec_validate (g->fixed_packet_data_mask, i0);
169 if (e->type != PG_EDIT_FIXED)
174 case PG_EDIT_INCREMENT:
175 e->last_increment_value = pg_edit_get_value (e, PG_EDIT_LO);
184 ASSERT(e->type != PG_EDIT_INVALID_TYPE);
185 vec_add1 (g->non_fixed_edits, e[0]);
190 s = g->fixed_packet_data;
191 m = g->fixed_packet_data_mask;
193 n_bits_left = e->n_bits;
194 i0 = e->lsb_bit_offset / BITS (u8);
195 i1 = e->lsb_bit_offset % BITS (u8);
197 v = e->values[PG_EDIT_LO];
198 i = pg_edit_n_alloc_bytes (e) - 1;
200 /* Odd low order bits?. */
201 if (i1 != 0 && n_bits_left > 0)
203 u32 n = clib_min (n_bits_left, BITS (u8) - i1);
205 mask = pow2_mask (n) << i1;
207 ASSERT (i0 < vec_len (s));
208 ASSERT (i < vec_len (v));
209 ASSERT ((v[i] &~ mask) == 0);
211 s[i0] |= v[i] & mask;
220 while (n_bits_left >= 8)
222 ASSERT (i0 < vec_len (s));
223 ASSERT (i < vec_len (v));
233 /* Odd high order bits. */
236 mask = pow2_mask (n_bits_left);
238 ASSERT (i0 < vec_len (s));
239 ASSERT (i < vec_len (v));
240 ASSERT ((v[i] &~ mask) == 0);
242 s[i0] |= v[i] & mask;
250 void pg_edit_group_get_fixed_packet_data (pg_stream_t * s,
253 void * packet_data_mask)
255 pg_edit_group_t * g = pg_stream_get_group (s, group_index);
258 vec_foreach (e, g->edits)
259 do_edit (s, g, e, /* want_commit */ 0);
261 memcpy (packet_data, g->fixed_packet_data, vec_len (g->fixed_packet_data));
262 memcpy (packet_data_mask, g->fixed_packet_data_mask, vec_len (g->fixed_packet_data_mask));
265 static void perform_fixed_edits (pg_stream_t * s)
271 for (i = vec_len (s->edit_groups) - 1; i >= 0; i--)
273 g = vec_elt_at_index (s->edit_groups, i);
274 vec_foreach (e, g->edits)
275 do_edit (s, g, e, /* want_commit */ 1);
277 /* All edits have either been performed or added to
278 g->non_fixed_edits. So, we can delete the vector. */
282 vec_free (s->fixed_packet_data_mask);
283 vec_free (s->fixed_packet_data);
284 vec_foreach (g, s->edit_groups)
287 g->start_byte_offset = vec_len (s->fixed_packet_data);
289 /* Relocate and copy non-fixed edits from group to stream. */
290 vec_foreach (e, g->non_fixed_edits)
291 e->lsb_bit_offset += g->start_byte_offset * BITS (u8);
293 for (i = 0; i < vec_len (g->non_fixed_edits); i++)
294 ASSERT(g->non_fixed_edits[i].type != PG_EDIT_INVALID_TYPE);
296 vec_add (s->non_fixed_edits,
298 vec_len (g->non_fixed_edits));
299 vec_free (g->non_fixed_edits);
301 vec_add (s->fixed_packet_data,
302 g->fixed_packet_data,
303 vec_len (g->fixed_packet_data));
304 vec_add (s->fixed_packet_data_mask,
305 g->fixed_packet_data_mask,
306 vec_len (g->fixed_packet_data_mask));
310 void pg_stream_add (pg_main_t * pg, pg_stream_t * s_init)
312 vlib_main_t * vm = pg->vlib_main;
316 if (! pg->stream_index_by_name)
317 pg->stream_index_by_name
318 = hash_create_vec (0, sizeof (s->name[0]), sizeof (uword));
320 /* Delete any old stream with the same name. */
322 && (p = hash_get_mem (pg->stream_index_by_name, s_init->name)))
324 pg_stream_del (pg, p[0]);
327 pool_get (pg->streams, s);
330 /* Give it a name. */
332 s->name = format (0, "stream%d", s - pg->streams);
334 s->name = vec_dup (s->name);
336 hash_set_mem (pg->stream_index_by_name, s->name, s - pg->streams);
338 /* Get fixed part of buffer data. */
339 perform_fixed_edits (s);
341 /* Determine packet size. */
342 switch (s->packet_size_edit_type)
344 case PG_EDIT_INCREMENT:
346 if (s->min_packet_bytes == s->max_packet_bytes)
347 s->packet_size_edit_type = PG_EDIT_FIXED;
351 /* Get packet size from fixed edits. */
352 s->packet_size_edit_type = PG_EDIT_FIXED;
353 if (! s->replay_packet_templates)
354 s->min_packet_bytes = s->max_packet_bytes = vec_len (s->fixed_packet_data);
358 s->last_increment_packet_size = s->min_packet_bytes;
361 pg_buffer_index_t * bi;
364 if (! s->buffer_bytes)
365 s->buffer_bytes = s->max_packet_bytes;
367 s->buffer_bytes = vlib_buffer_round_size (s->buffer_bytes);
369 n = s->max_packet_bytes / s->buffer_bytes;
370 n += (s->max_packet_bytes % s->buffer_bytes) != 0;
372 vec_resize (s->buffer_indices, n);
374 vec_foreach (bi, s->buffer_indices)
375 bi->free_list_index = vlib_buffer_create_free_list (vm, s->buffer_bytes,
376 "pg stream %d buffer #%d",
378 1 + (bi - s->buffer_indices));
381 /* Find an interface to use. */
382 s->pg_if_index = pg_interface_find_free (pg, s - pg->streams);
385 pg_interface_t * pi = vec_elt_at_index (pg->interfaces, s->pg_if_index);
386 vlib_rx_or_tx_t rx_or_tx;
388 vlib_foreach_rx_tx (rx_or_tx)
390 if (s->sw_if_index[rx_or_tx] == ~0)
391 s->sw_if_index[rx_or_tx] = pi->sw_if_index;
395 /* Connect the graph. */
396 s->next_index = vlib_node_add_next (vm, pg_input_node.index, s->node_index);
399 void pg_stream_del (pg_main_t * pg, uword index)
401 vlib_main_t * vm = pg->vlib_main;
403 pg_buffer_index_t * bi;
405 s = pool_elt_at_index (pg->streams, index);
407 pg_stream_enable_disable (pg, s, /* want_enabled */ 0);
408 vec_add1 (pg->free_interfaces, s->pg_if_index);
409 hash_unset_mem (pg->stream_index_by_name, s->name);
411 vec_foreach (bi, s->buffer_indices)
413 vlib_buffer_delete_free_list (vm, bi->free_list_index);
414 clib_fifo_free (bi->buffer_fifo);
418 pool_put (pg->streams, s);