FD.io VPP  v19.01.3-6-g70449b9b9
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 #include <vnet/devices/devices.h>
46 
47 /* Mark stream active or inactive. */
48 void
49 pg_stream_enable_disable (pg_main_t * pg, pg_stream_t * s, int want_enabled)
50 {
51  vlib_main_t *vm;
52  vnet_main_t *vnm = vnet_get_main ();
54 
55  want_enabled = want_enabled != 0;
56 
57  if (pg_stream_is_enabled (s) == want_enabled)
58  /* No change necessary. */
59  return;
60 
61  if (want_enabled)
62  s->n_packets_generated = 0;
63 
64  /* Toggle enabled flag. */
66 
67  ASSERT (!pool_is_free (pg->streams, s));
68 
72  want_enabled);
73 
74  if (want_enabled)
75  {
78 
81  }
82 
83  if (vlib_num_workers ())
85  else
86  vm = vlib_get_main ();
87 
90  (pg->enabled_streams[s->worker_index]) ?
91  VLIB_NODE_STATE_DISABLED : VLIB_NODE_STATE_POLLING));
92 
93  s->packet_accumulator = 0;
94  s->time_last_generate = 0;
95 }
96 
97 static u8 *
98 format_pg_output_trace (u8 * s, va_list * va)
99 {
100  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
101  CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
102  pg_output_trace_t *t = va_arg (*va, pg_output_trace_t *);
103  u32 indent = format_get_indent (s);
104 
105  s = format (s, "%Ubuffer 0x%x: %U",
106  format_white_space, indent,
108 
109  s = format (s, "\n%U%U", format_white_space, indent,
111  sizeof (t->buffer.pre_data));
112 
113  return s;
114 }
115 
116 static u8 *
117 format_pg_interface_name (u8 * s, va_list * args)
118 {
119  pg_main_t *pg = &pg_main;
120  u32 if_index = va_arg (*args, u32);
121  pg_interface_t *pi;
122 
123  pi = pool_elt_at_index (pg->interfaces, if_index);
124  s = format (s, "pg%d", pi->id);
125 
126  return s;
127 }
128 
129 static clib_error_t *
131 {
132  u32 hw_flags = 0;
133 
136 
137  vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
138 
139  return 0;
140 }
141 
142 /* *INDENT-OFF* */
144  .name = "pg",
145  .tx_function = pg_output,
146  .format_device_name = format_pg_interface_name,
147  .format_tx_trace = format_pg_output_trace,
148  .admin_up_down_function = pg_interface_admin_up_down,
149 };
150 /* *INDENT-ON* */
151 
152 static u8 *
155  vnet_link_t link_type, const void *dst_address)
156 {
157  u8 *rewrite = NULL;
158  u16 *h;
159 
160  vec_validate (rewrite, sizeof (*h) - 1);
161  h = (u16 *) rewrite;
162  h[0] = clib_host_to_net_u16 (vnet_link_to_l3_proto (link_type));
163 
164  return (rewrite);
165 }
166 
167 /* *INDENT-OFF* */
168 VNET_HW_INTERFACE_CLASS (pg_interface_class,static) = {
169  .name = "Packet generator",
170  .build_rewrite = pg_build_rewrite,
171 };
172 /* *INDENT-ON* */
173 
174 static u32
176 {
177  /* nothing for now */
178  return 0;
179 }
180 
181 u32
183 {
184  vnet_main_t *vnm = vnet_get_main ();
186  pg_interface_t *pi;
188  uword *p;
189  u32 i;
190 
191  p = hash_get (pg->if_index_by_if_id, if_id);
192 
193  if (p)
194  {
195  return p[0];
196  }
197  else
198  {
199  u8 hw_addr[6];
200  f64 now = vlib_time_now (vm);
201  u32 rnd;
202 
203  pool_get (pg->interfaces, pi);
204  i = pi - pg->interfaces;
205 
206  rnd = (u32) (now * 1e6);
207  rnd = random_u32 (&rnd);
208  clib_memcpy_fast (hw_addr + 2, &rnd, sizeof (rnd));
209  hw_addr[0] = 2;
210  hw_addr[1] = 0xfe;
211 
212  pi->id = if_id;
213  ethernet_register_interface (vnm, pg_dev_class.index, i, hw_addr,
215  hi = vnet_get_hw_interface (vnm, pi->hw_if_index);
216  pi->sw_if_index = hi->sw_if_index;
217 
218  hash_set (pg->if_index_by_if_id, if_id, i);
219 
220  if (vlib_num_workers ())
221  {
224  *pi->lockp = 0;
225  }
226  }
227 
228  return i;
229 }
230 
231 static void
233  pg_edit_group_t * g, pg_edit_t * e, uword want_commit)
234 {
235  u32 i, i0, i1, mask, n_bits_left;
236  u8 *v, *s, *m;
237 
238  i0 = e->lsb_bit_offset / BITS (u8);
239 
240  /* Make space for edit in value and mask. */
243 
244  if (e->type != PG_EDIT_FIXED)
245  {
246  switch (e->type)
247  {
248  case PG_EDIT_RANDOM:
249  case PG_EDIT_INCREMENT:
251  break;
252 
253  default:
254  break;
255  }
256 
257  if (want_commit)
258  {
260  vec_add1 (g->non_fixed_edits, e[0]);
261  }
262  return;
263  }
264 
265  s = g->fixed_packet_data;
266  m = g->fixed_packet_data_mask;
267 
268  n_bits_left = e->n_bits;
269  i0 = e->lsb_bit_offset / BITS (u8);
270  i1 = e->lsb_bit_offset % BITS (u8);
271 
272  v = e->values[PG_EDIT_LO];
273  i = pg_edit_n_alloc_bytes (e) - 1;
274 
275  /* Odd low order bits?. */
276  if (i1 != 0 && n_bits_left > 0)
277  {
278  u32 n = clib_min (n_bits_left, BITS (u8) - i1);
279 
280  mask = pow2_mask (n) << i1;
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  i0--;
290  i--;
291  n_bits_left -= n;
292  }
293 
294  /* Even bytes. */
295  while (n_bits_left >= 8)
296  {
297  ASSERT (i0 < vec_len (s));
298  ASSERT (i < vec_len (v));
299 
300  s[i0] = v[i];
301  m[i0] = ~0;
302 
303  i0--;
304  i--;
305  n_bits_left -= 8;
306  }
307 
308  /* Odd high order bits. */
309  if (n_bits_left > 0)
310  {
311  mask = pow2_mask (n_bits_left);
312 
313  ASSERT (i0 < vec_len (s));
314  ASSERT (i < vec_len (v));
315  ASSERT ((v[i] & ~mask) == 0);
316 
317  s[i0] |= v[i] & mask;
318  m[i0] |= mask;
319  }
320 
321  if (want_commit)
322  pg_edit_free (e);
323 }
324 
325 void
327  u32 group_index,
328  void *packet_data,
329  void *packet_data_mask)
330 {
331  pg_edit_group_t *g = pg_stream_get_group (s, group_index);
332  pg_edit_t *e;
333 
334  vec_foreach (e, g->edits) do_edit (s, g, e, /* want_commit */ 0);
335 
336  clib_memcpy_fast (packet_data, g->fixed_packet_data,
338  clib_memcpy_fast (packet_data_mask, g->fixed_packet_data_mask,
340 }
341 
342 static void
344 {
345  pg_edit_group_t *g;
346  pg_edit_t *e;
347  word i;
348 
349  for (i = vec_len (s->edit_groups) - 1; i >= 0; i--)
350  {
351  g = vec_elt_at_index (s->edit_groups, i);
352  vec_foreach (e, g->edits) do_edit (s, g, e, /* want_commit */ 1);
353 
354  /* All edits have either been performed or added to
355  g->non_fixed_edits. So, we can delete the vector. */
356  vec_free (g->edits);
357  }
358 
361  vec_foreach (g, s->edit_groups)
362  {
363  int i;
365 
366  /* Relocate and copy non-fixed edits from group to stream. */
369 
370  for (i = 0; i < vec_len (g->non_fixed_edits); i++)
372 
374  g->non_fixed_edits, vec_len (g->non_fixed_edits));
376 
378  g->fixed_packet_data, vec_len (g->fixed_packet_data));
381  }
382 }
383 
384 void
386 {
388  pg_stream_t *s;
389  uword *p;
390 
391  if (!pg->stream_index_by_name)
393  = hash_create_vec (0, sizeof (s->name[0]), sizeof (uword));
394 
395  /* Delete any old stream with the same name. */
396  if (s_init->name
397  && (p = hash_get_mem (pg->stream_index_by_name, s_init->name)))
398  {
399  pg_stream_del (pg, p[0]);
400  }
401 
402  pool_get (pg->streams, s);
403  s[0] = s_init[0];
404 
405  /* Give it a name. */
406  if (!s->name)
407  s->name = format (0, "stream%d", s - pg->streams);
408  else
409  s->name = vec_dup (s->name);
410 
411  hash_set_mem (pg->stream_index_by_name, s->name, s - pg->streams);
412 
413  /* Get fixed part of buffer data. */
414  if (s->edit_groups)
416 
417  /* Determine packet size. */
418  switch (s->packet_size_edit_type)
419  {
420  case PG_EDIT_INCREMENT:
421  case PG_EDIT_RANDOM:
422  if (s->min_packet_bytes == s->max_packet_bytes)
424  break;
425 
426  default:
427  /* Get packet size from fixed edits. */
429  if (!s->replay_packet_templates)
432  break;
433  }
434 
436 
437  {
438  int n;
439 
441  n = s->max_packet_bytes / s->buffer_bytes;
442  n += (s->max_packet_bytes % s->buffer_bytes) != 0;
443 
444  vec_resize (s->buffer_indices, n);
445  }
446 
447  /* Find an interface to use. */
449 
450  {
452  vlib_rx_or_tx_t rx_or_tx;
453 
454  vlib_foreach_rx_tx (rx_or_tx)
455  {
456  if (s->sw_if_index[rx_or_tx] == ~0)
457  s->sw_if_index[rx_or_tx] = pi->sw_if_index;
458  }
459  }
460 
461  /* Connect the graph. */
463  s->node_index);
464 }
465 
466 void
468 {
469  pg_stream_t *s;
470  pg_buffer_index_t *bi;
471 
472  s = pool_elt_at_index (pg->streams, index);
473 
474  pg_stream_enable_disable (pg, s, /* want_enabled */ 0);
476 
477  vec_foreach (bi, s->buffer_indices)
478  {
480  }
481 
482  pg_stream_free (s);
483  pool_put (pg->streams, s);
484 }
485 
486 
487 /*
488  * fd.io coding-style-patch-verification: ON
489  *
490  * Local Variables:
491  * eval: (c-set-style "gnu")
492  * End:
493  */
u32 sw_if_index
Definition: pg.h:298
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:439
Definition: edit.h:64
u32 next_index
Definition: pg.h:148
static int pg_stream_is_enabled(pg_stream_t *s)
Definition: pg.h:217
vmrglw vmrglh hi
#define PG_EDIT_LO
Definition: edit.h:83
#define hash_set(h, key, value)
Definition: hash.h:255
u32 flags
Definition: vhost_user.h:115
#define clib_min(x, y)
Definition: clib.h:295
#define CLIB_UNUSED(x)
Definition: clib.h:82
u8 * fixed_packet_data
Definition: pg.h:121
vlib_buffer_t buffer
Definition: pg.h:384
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
Definition: pg.h:314
pg_edit_group_t * edit_groups
Definition: pg.h:107
#define clib_memcpy_fast(a, b, c)
Definition: string.h:81
#define NULL
Definition: clib.h:58
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:232
uword * stream_index_by_name
Definition: pg.h:323
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:525
u32 worker_index
Definition: pg.h:145
static clib_error_t * pg_interface_admin_up_down(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: stream.c:130
int i
u32 buffer_index
Definition: pg.h:385
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
static u32 format_get_indent(u8 *s)
Definition: format.h:72
#define hash_set_mem(h, key, value)
Definition: hash.h:275
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
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:275
pg_buffer_index_t * buffer_indices
Definition: pg.h:167
u32 hw_if_index
Definition: pg.h:298
pg_edit_type_t packet_size_edit_type
Definition: pg.h:109
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:236
static uword vlib_node_add_next(vlib_main_t *vm, uword node, uword next_node)
Definition: node_funcs.h:1092
VNET_HW_INTERFACE_CLASS(pg_interface_class, static)
unsigned char u8
Definition: types.h:56
u8 * fixed_packet_data_mask
Definition: pg.h:121
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:223
double f64
Definition: types.h:142
#define vec_add(V, E, N)
Add N elements to end of vector V (no header, unspecified alignment)
Definition: vec.h:602
vlib_rx_or_tx_t
Definition: defs.h:44
i64 word
Definition: types.h:111
u32 sw_if_index
Definition: vxlan_gbp.api:37
static u8 * format_pg_interface_name(u8 *s, va_list *args)
Definition: stream.c:117
static uword pow2_mask(uword x)
Definition: clib.h:220
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
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:113
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.
u8 pre_data[VLIB_BUFFER_PRE_DATA_SIZE]
Space for inserting data before buffer start.
Definition: buffer.h:168
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:242
unsigned int u32
Definition: types.h:88
void pg_stream_del(pg_main_t *pg, uword index)
Definition: stream.c:467
#define PG_STREAM_FLAGS_IS_ENABLED
Definition: pg.h:102
uword * if_index_by_if_id
Definition: pg.h:327
u32 buffer_bytes
Definition: pg.h:125
static u32 pg_eth_flag_change(vnet_main_t *vnm, vnet_hw_interface_t *hi, u32 flags)
Definition: stream.c:175
volatile u32 * lockp
Definition: pg.h:295
u8 * values[2]
Definition: edit.h:82
f64 packet_accumulator
Definition: pg.h:165
#define hash_get(h, key)
Definition: hash.h:249
u32 last_increment_packet_size
Definition: pg.h:128
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:511
#define hash_unset_mem(h, key)
Definition: hash.h:291
u32 pg_if_index
Definition: pg.h:131
format_function_t format_vnet_buffer
Definition: buffer.h:423
pg_edit_t * non_fixed_edits
Definition: pg.h:60
u8 * name
Definition: pg.h:97
unsigned short u16
Definition: types.h:57
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:192
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:286
#define vec_dup(V)
Return copy of vector (no header, no alignment)
Definition: vec.h:375
vlib_node_function_t pg_output
Definition: pg.h:343
uword ** enabled_streams
Definition: pg.h:320
u32 n_bits
Definition: edit.h:79
u8 * format_ethernet_header_with_length(u8 *s, va_list *args)
Definition: format.c:97
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:153
vlib_main_t * vm
Definition: buffer.c:301
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
u32 min_packet_bytes
Definition: pg.h:112
u32 max_packet_bytes
Definition: pg.h:112
u32 pg_interface_add_or_get(pg_main_t *pg, uword if_id)
Definition: stream.c:182
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:326
pg_edit_t * non_fixed_edits
Definition: pg.h:116
u8 ** replay_packet_templates
Definition: pg.h:169
#define VLIB_BUFFER_DATA_SIZE
Definition: buffer.h:51
static void perform_fixed_edits(pg_stream_t *s)
Definition: stream.c:343
pg_stream_t * streams
Definition: pg.h:317
#define ASSERT(truth)
#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.
void pg_stream_enable_disable(pg_main_t *pg, pg_stream_t *s, int want_enabled)
Definition: stream.c:49
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:277
void pg_stream_add(pg_main_t *pg, pg_stream_t *s_init)
Definition: stream.c:385
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:148
#define clib_fifo_free(f)
Definition: fifo.h:257
Definition: pg.h:94
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
static uword pg_edit_n_alloc_bytes(pg_edit_t *e)
Definition: edit.h:120
u32 node_index
Definition: pg.h:142
static u8 * format_pg_output_trace(u8 *s, va_list *va)
Definition: stream.c:98
u32 sw_if_index[VLIB_N_RX_TX]
Definition: pg.h:139
#define hash_create_vec(elts, key_bytes, value_bytes)
Definition: hash.h:668
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u32 id
Definition: pg.h:301
clib_error_t * vnet_hw_interface_set_flags(vnet_main_t *vnm, u32 hw_if_index, vnet_hw_interface_flags_t flags)
Definition: interface.c:504
vnet_l3_packet_type_t vnet_link_to_l3_proto(vnet_link_t link)
Convert a link to to an Ethertype.
Definition: interface.c:1513
u32 if_id
Definition: pg.h:150
u64 uword
Definition: types.h:112
pg_edit_t * edits
Definition: pg.h:57
#define hash_get_mem(h, key)
Definition: hash.h:269
static void * clib_mem_alloc_aligned(uword size, uword align)
Definition: mem.h:140
static void do_edit(pg_stream_t *stream, pg_edit_group_t *g, pg_edit_t *e, uword want_commit)
Definition: stream.c:232
static u32 random_u32(u32 *seed)
32-bit random number generator
Definition: random.h:69
clib_error_t * vnet_sw_interface_set_flags(vnet_main_t *vnm, u32 sw_if_index, vnet_sw_interface_flags_t flags)
Definition: interface.c:513
static u32 vlib_num_workers()
Definition: threads.h:366
u64 n_packets_generated
Definition: pg.h:153
vlib_node_registration_t pg_input_node
(constructor) VLIB_REGISTER_NODE (pg_input_node)
Definition: input.c:1720
pg_main_t pg_main
Definition: init.c:44
#define vec_foreach(var, vec)
Vector iterator.
static void pg_edit_free(pg_edit_t *e)
Definition: edit.h:91
vnet_device_class_t pg_dev_class
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
#define BITS(x)
Definition: clib.h:61
f64 time_last_generate
Definition: pg.h:163
pg_interface_t * interfaces
Definition: pg.h:326
vlib_node_registration_t device_input_node
(constructor) VLIB_REGISTER_NODE (device_input_node)
Definition: devices.c:32
static vlib_main_t * vlib_get_worker_vlib_main(u32 worker_index)
Definition: threads.h:500
u32 flags
Definition: pg.h:99
u32 * buffer_fifo
Definition: pg.h:90