FD.io VPP  v16.12-rc0-308-g931be3a
Vector Packet Processing
stream.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * pg_stream.c: packet generator streams
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 
40 #include <vnet/vnet.h>
41 #include <vnet/pg/pg.h>
42 #include <vnet/ethernet/ethernet.h>
43 #include <vnet/ip/ip.h>
44 #include <vnet/mpls/mpls.h>
45 
46 /* Mark stream active or inactive. */
47 void
48 pg_stream_enable_disable (pg_main_t * pg, pg_stream_t * s, int want_enabled)
49 {
50  vnet_main_t *vnm = vnet_get_main ();
52 
53  want_enabled = want_enabled != 0;
54 
55  if (pg_stream_is_enabled (s) == want_enabled)
56  /* No change necessary. */
57  return;
58 
59  if (want_enabled)
60  s->n_packets_generated = 0;
61 
62  /* Toggle enabled flag. */
64 
65  ASSERT (!pool_is_free (pg->streams, s));
66 
67  pg->enabled_streams
68  = clib_bitmap_set (pg->enabled_streams, s - pg->streams, want_enabled);
69 
70  if (want_enabled)
71  {
74 
77  }
78 
80  pg_input_node.index,
82  ? VLIB_NODE_STATE_DISABLED
83  : VLIB_NODE_STATE_POLLING));
84 
85  s->packet_accumulator = 0;
86  s->time_last_generate = 0;
87 }
88 
89 static u8 *
90 format_pg_interface_name (u8 * s, va_list * args)
91 {
92  pg_main_t *pg = &pg_main;
93  u32 if_index = va_arg (*args, u32);
94  pg_interface_t *pi;
95 
96  pi = pool_elt_at_index (pg->interfaces, if_index);
97  s = format (s, "pg%d", pi->id);
98 
99  return s;
100 }
101 
102 static clib_error_t *
104 {
105  u32 hw_flags = 0;
106 
109 
110  vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
111 
112  return 0;
113 }
114 
115 /* *INDENT-OFF* */
117  .name = "pg",
118  .tx_function = pg_output,
119  .format_device_name = format_pg_interface_name,
120  .admin_up_down_function = pg_interface_admin_up_down,
121 };
122 /* *INDENT-ON* */
123 
124 static u8 *
126  u32 sw_if_index,
127  vnet_link_t link_type, const void *dst_address)
128 {
129  u8 *rewrite = NULL;
130  u16 *h;
131 
132  vec_validate (rewrite, sizeof (*h) - 1);
133  h = (u16 *) rewrite;
134  h[0] = clib_host_to_net_u16 (vnet_link_to_l3_proto (link_type));
135 
136  return (rewrite);
137 }
138 
139 /* *INDENT-OFF* */
140 VNET_HW_INTERFACE_CLASS (pg_interface_class,static) = {
141  .name = "Packet generator",
142  .build_rewrite = pg_build_rewrite,
143 };
144 /* *INDENT-ON* */
145 
146 static u32
148 {
149  /* nothing for now */
150  return 0;
151 }
152 
153 u32
155 {
156  vnet_main_t *vnm = vnet_get_main ();
157  vlib_main_t *vm = vlib_get_main ();
158  pg_interface_t *pi;
160  uword *p;
161  u32 i;
162 
163  p = hash_get (pg->if_index_by_if_id, if_id);
164 
165  if (p)
166  {
167  return p[0];
168  }
169  else
170  {
171  u8 hw_addr[6];
172  f64 now = vlib_time_now (vm);
173  u32 rnd;
174 
175  pool_get (pg->interfaces, pi);
176  i = pi - pg->interfaces;
177 
178  rnd = (u32) (now * 1e6);
179  rnd = random_u32 (&rnd);
180  clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
181  hw_addr[0] = 2;
182  hw_addr[1] = 0xfe;
183 
184  pi->id = if_id;
185  ethernet_register_interface (vnm, pg_dev_class.index, i, hw_addr,
187  hi = vnet_get_hw_interface (vnm, pi->hw_if_index);
188  pi->sw_if_index = hi->sw_if_index;
189 
190  hash_set (pg->if_index_by_if_id, if_id, i);
191 
195  }
196 
197  return i;
198 }
199 
200 static void
202  pg_edit_group_t * g, pg_edit_t * e, uword want_commit)
203 {
204  u32 i, i0, i1, mask, n_bits_left;
205  u8 *v, *s, *m;
206 
207  i0 = e->lsb_bit_offset / BITS (u8);
208 
209  /* Make space for edit in value and mask. */
212 
213  if (e->type != PG_EDIT_FIXED)
214  {
215  switch (e->type)
216  {
217  case PG_EDIT_RANDOM:
218  case PG_EDIT_INCREMENT:
220  break;
221 
222  default:
223  break;
224  }
225 
226  if (want_commit)
227  {
229  vec_add1 (g->non_fixed_edits, e[0]);
230  }
231  return;
232  }
233 
234  s = g->fixed_packet_data;
235  m = g->fixed_packet_data_mask;
236 
237  n_bits_left = e->n_bits;
238  i0 = e->lsb_bit_offset / BITS (u8);
239  i1 = e->lsb_bit_offset % BITS (u8);
240 
241  v = e->values[PG_EDIT_LO];
242  i = pg_edit_n_alloc_bytes (e) - 1;
243 
244  /* Odd low order bits?. */
245  if (i1 != 0 && n_bits_left > 0)
246  {
247  u32 n = clib_min (n_bits_left, BITS (u8) - i1);
248 
249  mask = pow2_mask (n) << i1;
250 
251  ASSERT (i0 < vec_len (s));
252  ASSERT (i < vec_len (v));
253  ASSERT ((v[i] & ~mask) == 0);
254 
255  s[i0] |= v[i] & mask;
256  m[i0] |= mask;
257 
258  i0--;
259  i--;
260  n_bits_left -= n;
261  }
262 
263  /* Even bytes. */
264  while (n_bits_left >= 8)
265  {
266  ASSERT (i0 < vec_len (s));
267  ASSERT (i < vec_len (v));
268 
269  s[i0] = v[i];
270  m[i0] = ~0;
271 
272  i0--;
273  i--;
274  n_bits_left -= 8;
275  }
276 
277  /* Odd high order bits. */
278  if (n_bits_left > 0)
279  {
280  mask = pow2_mask (n_bits_left);
281 
282  ASSERT (i0 < vec_len (s));
283  ASSERT (i < vec_len (v));
284  ASSERT ((v[i] & ~mask) == 0);
285 
286  s[i0] |= v[i] & mask;
287  m[i0] |= mask;
288  }
289 
290  if (want_commit)
291  pg_edit_free (e);
292 }
293 
294 void
296  u32 group_index,
297  void *packet_data,
298  void *packet_data_mask)
299 {
300  pg_edit_group_t *g = pg_stream_get_group (s, group_index);
301  pg_edit_t *e;
302 
303  vec_foreach (e, g->edits) do_edit (s, g, e, /* want_commit */ 0);
304 
305  clib_memcpy (packet_data, g->fixed_packet_data,
307  clib_memcpy (packet_data_mask, g->fixed_packet_data_mask,
309 }
310 
311 static void
313 {
314  pg_edit_group_t *g;
315  pg_edit_t *e;
316  word i;
317 
318  for (i = vec_len (s->edit_groups) - 1; i >= 0; i--)
319  {
320  g = vec_elt_at_index (s->edit_groups, i);
321  vec_foreach (e, g->edits) do_edit (s, g, e, /* want_commit */ 1);
322 
323  /* All edits have either been performed or added to
324  g->non_fixed_edits. So, we can delete the vector. */
325  vec_free (g->edits);
326  }
327 
330  vec_foreach (g, s->edit_groups)
331  {
332  int i;
334 
335  /* Relocate and copy non-fixed edits from group to stream. */
338 
339  for (i = 0; i < vec_len (g->non_fixed_edits); i++)
341 
343  g->non_fixed_edits, vec_len (g->non_fixed_edits));
345 
347  g->fixed_packet_data, vec_len (g->fixed_packet_data));
350  }
351 }
352 
353 void
355 {
356  vlib_main_t *vm = pg->vlib_main;
357  pg_stream_t *s;
358  uword *p;
359 
360  if (!pg->stream_index_by_name)
362  = hash_create_vec (0, sizeof (s->name[0]), sizeof (uword));
363 
364  /* Delete any old stream with the same name. */
365  if (s_init->name
366  && (p = hash_get_mem (pg->stream_index_by_name, s_init->name)))
367  {
368  pg_stream_del (pg, p[0]);
369  }
370 
371  pool_get (pg->streams, s);
372  s[0] = s_init[0];
373 
374  /* Give it a name. */
375  if (!s->name)
376  s->name = format (0, "stream%d", s - pg->streams);
377  else
378  s->name = vec_dup (s->name);
379 
380  hash_set_mem (pg->stream_index_by_name, s->name, s - pg->streams);
381 
382  /* Get fixed part of buffer data. */
383  if (s->edit_groups)
385 
386  /* Determine packet size. */
387  switch (s->packet_size_edit_type)
388  {
389  case PG_EDIT_INCREMENT:
390  case PG_EDIT_RANDOM:
391  if (s->min_packet_bytes == s->max_packet_bytes)
393  break;
394 
395  default:
396  /* Get packet size from fixed edits. */
398  if (!s->replay_packet_templates)
401  break;
402  }
403 
405 
406  {
407  pg_buffer_index_t *bi;
408  int n;
409 
410  if (!s->buffer_bytes)
412 
414 
415  n = s->max_packet_bytes / s->buffer_bytes;
416  n += (s->max_packet_bytes % s->buffer_bytes) != 0;
417 
418  vec_resize (s->buffer_indices, n);
419 
420  vec_foreach (bi, s->buffer_indices)
422  "pg stream %d buffer #%d",
423  s - pg->streams,
424  1 + (bi -
425  s->
426  buffer_indices));
427  }
428 
429  /* Find an interface to use. */
431 
432  {
434  vlib_rx_or_tx_t rx_or_tx;
435 
436  vlib_foreach_rx_tx (rx_or_tx)
437  {
438  if (s->sw_if_index[rx_or_tx] == ~0)
439  s->sw_if_index[rx_or_tx] = pi->sw_if_index;
440  }
441  }
442 
443  /* Connect the graph. */
445 }
446 
447 void
449 {
450  vlib_main_t *vm = pg->vlib_main;
451  pg_stream_t *s;
452  pg_buffer_index_t *bi;
453 
454  s = pool_elt_at_index (pg->streams, index);
455 
456  pg_stream_enable_disable (pg, s, /* want_enabled */ 0);
458 
459  vec_foreach (bi, s->buffer_indices)
460  {
463  }
464 
465  pg_stream_free (s);
466  pool_put (pg->streams, s);
467 }
468 
469 
470 /*
471  * fd.io coding-style-patch-verification: ON
472  *
473  * Local Variables:
474  * eval: (c-set-style "gnu")
475  * End:
476  */
u32 sw_if_index
Definition: pg.h:288
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:396
Definition: edit.h:64
u32 next_index
Definition: pg.h:147
static int pg_stream_is_enabled(pg_stream_t *s)
Definition: pg.h:210
vmrglw vmrglh hi
#define PG_EDIT_LO
Definition: edit.h:83
void mpls_sw_interface_enable_disable(mpls_main_t *mm, u32 sw_if_index, u8 is_enable)
Definition: interface.c:275
#define hash_set(h, key, value)
Definition: hash.h:254
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:343
#define clib_min(x, y)
Definition: clib.h:326
clib_error_t * vnet_hw_interface_set_flags(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: interface.c:522
u8 * fixed_packet_data
Definition: pg.h:123
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
Definition: pg.h:304
pg_edit_group_t * edit_groups
Definition: pg.h:109
#define NULL
Definition: clib.h:55
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:182
uword * stream_index_by_name
Definition: pg.h:316
static vnet_hw_interface_t * vnet_get_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
VNET_DEVICE_CLASS(pg_dev_class)
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:482
static clib_error_t * pg_interface_admin_up_down(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: stream.c:103
static uword * clib_bitmap_set(uword *ai, uword i, uword value)
Sets the ith bit of a bitmap to new_value Removes trailing zeros from the bitmap. ...
Definition: bitmap.h:167
#define hash_set_mem(h, key, value)
Definition: hash.h:274
u64 last_increment_value
Definition: edit.h:87
#define pool_is_free(P, E)
Use free bitmap to query whether given element is free.
Definition: pool.h:203
pg_buffer_index_t * buffer_indices
Definition: pg.h:166
u32 hw_if_index
Definition: pg.h:288
#define VNET_HW_INTERFACE_FLAG_LINK_UP
Definition: interface.h:348
pg_edit_type_t packet_size_edit_type
Definition: pg.h:111
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:200
static uword vlib_node_add_next(vlib_main_t *vm, uword node, uword next_node)
Definition: node_funcs.h:1063
VNET_HW_INTERFACE_CLASS(pg_interface_class, static)
u8 * fixed_packet_data_mask
Definition: pg.h:123
u32 start_byte_offset
Definition: pg.h:67
static pg_edit_group_t * pg_stream_get_group(pg_stream_t *s, u32 group_index)
Definition: pg.h:216
#define vec_add(V, E, N)
Add N elements to end of vector V (no header, unspecified alignment)
Definition: vec.h:559
vlib_rx_or_tx_t
Definition: defs.h:44
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
vlib_node_registration_t pg_input_node
(constructor) VLIB_REGISTER_NODE (pg_input_node)
Definition: input.c:1667
static u8 * format_pg_interface_name(u8 *s, va_list *args)
Definition: stream.c:90
static uword pow2_mask(uword x)
Definition: clib.h:251
u8 * fixed_packet_data_mask
Definition: pg.h:64
static uword clib_bitmap_is_zero(uword *ai)
predicate function; is an entire bitmap empty?
Definition: bitmap.h:57
pg_edit_type_t type
Definition: edit.h:66
u8 * fixed_packet_data
Definition: pg.h:63
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
i32 lsb_bit_offset
Definition: edit.h:73
#define vec_resize(V, N)
Resize a vector (no header, unspecified alignment) Add N elements to end of given vector V...
Definition: vec.h:201
void pg_stream_del(pg_main_t *pg, uword index)
Definition: stream.c:448
#define PG_STREAM_FLAGS_IS_ENABLED
Definition: pg.h:104
uword * if_index_by_if_id
Definition: pg.h:320
u32 buffer_bytes
Definition: pg.h:127
static u32 pg_eth_flag_change(vnet_main_t *vnm, vnet_hw_interface_t *hi, u32 flags)
Definition: stream.c:147
u8 * values[2]
Definition: edit.h:82
f64 packet_accumulator
Definition: pg.h:164
#define hash_get(h, key)
Definition: hash.h:248
u32 last_increment_packet_size
Definition: pg.h:130
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:369
#define hash_unset_mem(h, key)
Definition: hash.h:280
u32 pg_if_index
Definition: pg.h:133
void ip4_sw_interface_enable_disable(u32 sw_if_index, u32 is_enable)
Definition: ip4_forward.c:709
pg_edit_t * non_fixed_edits
Definition: pg.h:60
u8 * name
Definition: pg.h:99
static u64 pg_edit_get_value(pg_edit_t *e, int hi_or_lo)
Definition: edit.h:173
static void pg_stream_free(pg_stream_t *s)
Definition: pg.h:190
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:214
#define vec_dup(V)
Return copy of vector (no header, no alignment)
Definition: vec.h:334
vlib_node_function_t pg_output
Definition: pg.h:333
u32 n_bits
Definition: edit.h:79
static u8 * pg_build_rewrite(vnet_main_t *vnm, u32 sw_if_index, vnet_link_t link_type, const void *dst_address)
Definition: stream.c:125
mpls_main_t mpls_main
Definition: mpls.c:25
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:300
u32 min_packet_bytes
Definition: pg.h:114
u32 max_packet_bytes
Definition: pg.h:114
u32 pg_interface_add_or_get(pg_main_t *pg, uword if_id)
Definition: stream.c:154
#define clib_memcpy(a, b, c)
Definition: string.h:64
void pg_edit_group_get_fixed_packet_data(pg_stream_t *s, u32 group_index, void *packet_data, void *packet_data_mask)
Definition: stream.c:295
pg_edit_t * non_fixed_edits
Definition: pg.h:118
u8 ** replay_packet_templates
Definition: pg.h:168
static void perform_fixed_edits(pg_stream_t *s)
Definition: stream.c:312
pg_stream_t * streams
Definition: pg.h:310
#define VNET_SW_INTERFACE_FLAG_ADMIN_UP
Definition: interface.h:490
#define ASSERT(truth)
vlib_main_t * vlib_main
Definition: pg.h:307
unsigned int u32
Definition: types.h:88
#define vlib_foreach_rx_tx(v)
Definition: defs.h:51
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
u32 free_list_index
Definition: pg.h:93
uword * enabled_streams
Definition: pg.h:313
void pg_stream_enable_disable(pg_main_t *pg, pg_stream_t *s, int want_enabled)
Definition: stream.c:48
clib_error_t * ethernet_register_interface(vnet_main_t *vnm, u32 dev_class_index, u32 dev_instance, u8 *address, u32 *hw_if_index_return, ethernet_flag_change_function_t flag_change)
Definition: interface.c:205
void pg_stream_add(pg_main_t *pg, pg_stream_t *s_init)
Definition: stream.c:354
static void vlib_node_set_state(vlib_main_t *vm, u32 node_index, vlib_node_state_t new_state)
Set node dispatch state.
Definition: node_funcs.h:146
#define clib_fifo_free(f)
Definition: fifo.h:257
Definition: pg.h:96
pg_main_t pg_main
Definition: init.c:44
void vlib_buffer_delete_free_list(vlib_main_t *vm, u32 free_list_index)
Definition: dpdk_buffer.c:434
u64 uword
Definition: types.h:112
static uword pg_edit_n_alloc_bytes(pg_edit_t *e)
Definition: edit.h:120
u32 node_index
Definition: pg.h:144
u32 sw_if_index[VLIB_N_RX_TX]
Definition: pg.h:141
unsigned short u16
Definition: types.h:57
#define hash_create_vec(elts, key_bytes, value_bytes)
Definition: hash.h:644
i64 word
Definition: types.h:111
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
double f64
Definition: types.h:142
u32 id
Definition: pg.h:291
unsigned char u8
Definition: types.h:56
vnet_l3_packet_type_t vnet_link_to_l3_proto(vnet_link_t link)
Convert a link to to an Ethertype.
Definition: interface.c:1329
u32 if_id
Definition: pg.h:149
pg_edit_t * edits
Definition: pg.h:57
#define hash_get_mem(h, key)
Definition: hash.h:268
static void do_edit(pg_stream_t *stream, pg_edit_group_t *g, pg_edit_t *e, uword want_commit)
Definition: stream.c:201
static u32 random_u32(u32 *seed)
32-bit random number generator
Definition: random.h:69
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:418
u64 n_packets_generated
Definition: pg.h:152
#define vec_foreach(var, vec)
Vector iterator.
clib_error_t * vnet_sw_interface_set_flags(vnet_main_t *vnm, u32 sw_if_index, u32 flags)
Definition: interface.c:530
static void pg_edit_free(pg_edit_t *e)
Definition: edit.h:91
vnet_device_class_t pg_dev_class
u32 flags
Definition: vhost-user.h:75
#define BITS(x)
Definition: clib.h:58
f64 time_last_generate
Definition: pg.h:162
void ip6_sw_interface_enable_disable(u32 sw_if_index, u32 is_enable)
Definition: ip6_forward.c:412
pg_interface_t * interfaces
Definition: pg.h:319
u32 vlib_buffer_create_free_list(vlib_main_t *vm, u32 n_data_bytes, char *fmt,...)
Definition: dpdk_buffer.c:366
static u32 vlib_buffer_round_size(u32 size)
Definition: buffer_funcs.h:271
u32 flags
Definition: pg.h:101
u32 * buffer_fifo
Definition: pg.h:90