blob: f5b5e5ac358f5f7dfaea19e76e38cc75c2ee586e [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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.h: VLIB packet generator
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#ifndef included_vlib_pg_h
41#define included_vlib_pg_h
42
43#include <vlib/vlib.h> /* for VLIB_N_RX_TX */
44#include <vnet/pg/edit.h>
Calvin71e97c62016-08-19 16:23:14 -040045#include <vppinfra/fifo.h> /* for buffer_fifo */
Dave Barach3ae28732018-11-16 17:19:00 -050046#include <vppinfra/pcap.h>
Damjan Marion3d9c86e2016-07-04 21:04:40 +020047#include <vnet/interface.h>
Neale Ranns21fb4f72020-10-05 12:26:47 +000048#include <vnet/ethernet/mac_address.h>
Mohsin Kazmif382b062020-08-11 15:00:44 +020049#include <vnet/gso/gro.h>
Damjan Marion3d9c86e2016-07-04 21:04:40 +020050
51extern vnet_device_class_t pg_dev_class;
Ed Warnickecb9cada2015-12-08 15:45:58 -070052
53struct pg_main_t;
54struct pg_stream_t;
55
Calvin71e97c62016-08-19 16:23:14 -040056typedef struct pg_edit_group_t
57{
Ed Warnickecb9cada2015-12-08 15:45:58 -070058 /* Edits in this group. */
Calvin71e97c62016-08-19 16:23:14 -040059 pg_edit_t *edits;
Ed Warnickecb9cada2015-12-08 15:45:58 -070060
61 /* Vector of non-fixed edits for this group. */
Calvin71e97c62016-08-19 16:23:14 -040062 pg_edit_t *non_fixed_edits;
Ed Warnickecb9cada2015-12-08 15:45:58 -070063
64 /* Fixed edits for this group. */
Calvin71e97c62016-08-19 16:23:14 -040065 u8 *fixed_packet_data;
66 u8 *fixed_packet_data_mask;
Ed Warnickecb9cada2015-12-08 15:45:58 -070067
68 /* Byte offset where packet data begins. */
69 u32 start_byte_offset;
70
71 /* Number of packet bytes for this edit group. */
72 u32 n_packet_bytes;
73
74 /* Function to perform miscellaneous edits (e.g. set IP checksum, ...). */
Calvin71e97c62016-08-19 16:23:14 -040075 void (*edit_function) (struct pg_main_t * pg,
76 struct pg_stream_t * s,
77 struct pg_edit_group_t * g,
78 u32 * buffers, u32 n_buffers);
Ed Warnickecb9cada2015-12-08 15:45:58 -070079
80 /* Opaque data for edit function's use. */
81 uword edit_function_opaque;
82} pg_edit_group_t;
83
84/* Packets are made of multiple buffers chained together.
85 This struct keeps track of data per-chain index. */
Calvin71e97c62016-08-19 16:23:14 -040086typedef struct
87{
Ed Warnickecb9cada2015-12-08 15:45:58 -070088 /* Vector of buffer edits for this stream and buffer index. */
Calvin71e97c62016-08-19 16:23:14 -040089 pg_edit_t *edits;
Ed Warnickecb9cada2015-12-08 15:45:58 -070090
91 /* Buffers pre-initialized with fixed buffer data for this stream. */
Calvin71e97c62016-08-19 16:23:14 -040092 u32 *buffer_fifo;
Ed Warnickecb9cada2015-12-08 15:45:58 -070093
Ed Warnickecb9cada2015-12-08 15:45:58 -070094} pg_buffer_index_t;
95
Calvin71e97c62016-08-19 16:23:14 -040096typedef struct pg_stream_t
97{
Ed Warnickecb9cada2015-12-08 15:45:58 -070098 /* Stream name. */
Calvin71e97c62016-08-19 16:23:14 -040099 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700100
101 u32 flags;
102
103 /* Stream is currently enabled. */
104#define PG_STREAM_FLAGS_IS_ENABLED (1 << 0)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700105
106 /* Edit groups are created by each protocol level (e.g. ethernet,
107 ip4, tcp, ...). */
Calvin71e97c62016-08-19 16:23:14 -0400108 pg_edit_group_t *edit_groups;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700109
110 pg_edit_type_t packet_size_edit_type;
111
112 /* Min/max packet size. */
113 u32 min_packet_bytes, max_packet_bytes;
114
115 /* Vector of non-fixed edits for this stream.
116 All fixed edits are performed and placed into fixed_packet_data. */
Calvin71e97c62016-08-19 16:23:14 -0400117 pg_edit_t *non_fixed_edits;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700118
119 /* Packet data with all fixed edits performed.
120 All packets in stream are initialized according with this data.
121 Mask specifies which bits of packet data are covered by fixed edits. */
Calvin71e97c62016-08-19 16:23:14 -0400122 u8 *fixed_packet_data, *fixed_packet_data_mask;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700123
124 /* Size to use for buffers. 0 means use buffers big enough
125 for max_packet_bytes. */
126 u32 buffer_bytes;
127
Dave Barach08eb2bb2020-04-15 09:34:43 -0400128 /* Buffer flags to set in each packet e.g. checksum offload flags */
129 u32 buffer_flags;
130
Ed Warnickecb9cada2015-12-08 15:45:58 -0700131 /* Last packet length if packet size edit type is increment. */
132 u32 last_increment_packet_size;
133
134 /* Index into main interface pool for this stream. */
135 u32 pg_if_index;
136
137 /* Interface used to mark packets for this stream. May be different
138 than hw/sw index from pg main interface pool. They will be
139 different if this stream is being used generate buffers as if
140 they were received on a non-pg interface. For example, suppose you
141 are trying to test vlan code and you want to generate buffers that
142 appear to come from an ethernet interface. */
143 u32 sw_if_index[VLIB_N_RX_TX];
144
145 /* Node where stream's buffers get put. */
146 u32 node_index;
147
Damjan Marion64034362016-11-07 22:19:55 +0100148 /* Worker thread index */
149 u32 worker_index;
150
Ed Warnickecb9cada2015-12-08 15:45:58 -0700151 /* Output next index to reach output node from stream input node. */
152 u32 next_index;
153
Damjan Marion3d9c86e2016-07-04 21:04:40 +0200154 u32 if_id;
155
Ed Warnickecb9cada2015-12-08 15:45:58 -0700156 /* Number of packets currently generated. */
157 u64 n_packets_generated;
158
159 /* Stream is disabled when packet limit is reached.
160 Zero means no packet limit. */
161 u64 n_packets_limit;
162
Christian E. Hopps87d7bac2019-09-27 12:59:30 -0400163 /* Only generate up to n_max_frame per frame. */
164 u32 n_max_frame;
165
Ed Warnickecb9cada2015-12-08 15:45:58 -0700166 /* Rate for this stream in packets/second.
167 Zero means unlimited rate. */
168 f64 rate_packets_per_second;
169
170 f64 time_last_generate;
171
172 f64 packet_accumulator;
173
Calvin71e97c62016-08-19 16:23:14 -0400174 pg_buffer_index_t *buffer_indices;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700175
Calvin71e97c62016-08-19 16:23:14 -0400176 u8 **replay_packet_templates;
Dave Barach78c56892018-05-16 11:34:35 -0400177 u64 *replay_packet_timestamps;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700178 u32 current_replay_packet_index;
179} pg_stream_t;
180
181always_inline void
182pg_buffer_index_free (pg_buffer_index_t * bi)
183{
184 vec_free (bi->edits);
185 clib_fifo_free (bi->buffer_fifo);
186}
187
188always_inline void
189pg_edit_group_free (pg_edit_group_t * g)
190{
Calvin71e97c62016-08-19 16:23:14 -0400191 pg_edit_t *e;
192 vec_foreach (e, g->edits) pg_edit_free (e);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700193 vec_free (g->edits);
194 vec_free (g->fixed_packet_data);
195 vec_free (g->fixed_packet_data_mask);
196}
197
198always_inline void
199pg_stream_free (pg_stream_t * s)
200{
Dave Barach78c56892018-05-16 11:34:35 -0400201 int i;
Calvin71e97c62016-08-19 16:23:14 -0400202 pg_edit_group_t *g;
203 pg_edit_t *e;
204 vec_foreach (e, s->non_fixed_edits) pg_edit_free (e);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700205 vec_free (s->non_fixed_edits);
Calvin71e97c62016-08-19 16:23:14 -0400206 vec_foreach (g, s->edit_groups) pg_edit_group_free (g);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700207 vec_free (s->edit_groups);
208 vec_free (s->fixed_packet_data);
209 vec_free (s->fixed_packet_data_mask);
210 vec_free (s->name);
Dave Barach78c56892018-05-16 11:34:35 -0400211 for (i = 0; i < vec_len (s->replay_packet_templates); i++)
212 vec_free (s->replay_packet_templates[i]);
213 vec_free (s->replay_packet_templates);
214 vec_free (s->replay_packet_timestamps);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700215
216 {
Calvin71e97c62016-08-19 16:23:14 -0400217 pg_buffer_index_t *bi;
218 vec_foreach (bi, s->buffer_indices) pg_buffer_index_free (bi);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700219 vec_free (s->buffer_indices);
220 }
221}
222
223always_inline int
224pg_stream_is_enabled (pg_stream_t * s)
Calvin71e97c62016-08-19 16:23:14 -0400225{
226 return (s->flags & PG_STREAM_FLAGS_IS_ENABLED) != 0;
227}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700228
229always_inline pg_edit_group_t *
230pg_stream_get_group (pg_stream_t * s, u32 group_index)
Calvin71e97c62016-08-19 16:23:14 -0400231{
232 return vec_elt_at_index (s->edit_groups, group_index);
233}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700234
235always_inline void *
236pg_create_edit_group (pg_stream_t * s,
Calvin71e97c62016-08-19 16:23:14 -0400237 int n_edit_bytes, int n_packet_bytes, u32 * group_index)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700238{
Calvin71e97c62016-08-19 16:23:14 -0400239 pg_edit_group_t *g;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700240 int n_edits;
241
242 vec_add2 (s->edit_groups, g, 1);
243 if (group_index)
244 *group_index = g - s->edit_groups;
245
246 ASSERT (n_edit_bytes % sizeof (pg_edit_t) == 0);
247 n_edits = n_edit_bytes / sizeof (pg_edit_t);
248 vec_resize (g->edits, n_edits);
249
250 g->n_packet_bytes = n_packet_bytes;
251
252 return g->edits;
253}
254
255always_inline void *
256pg_add_edits (pg_stream_t * s, int n_edit_bytes, int n_packet_bytes,
257 u32 group_index)
258{
Calvin71e97c62016-08-19 16:23:14 -0400259 pg_edit_group_t *g = pg_stream_get_group (s, group_index);
260 pg_edit_t *e;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700261 int n_edits;
262 ASSERT (n_edit_bytes % sizeof (pg_edit_t) == 0);
263 n_edits = n_edit_bytes / sizeof (pg_edit_t);
264 vec_add2 (g->edits, e, n_edits);
265 g->n_packet_bytes += n_packet_bytes;
266 return e;
267}
268
269always_inline void *
270pg_get_edit_group (pg_stream_t * s, u32 group_index)
271{
Calvin71e97c62016-08-19 16:23:14 -0400272 pg_edit_group_t *g = pg_stream_get_group (s, group_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700273 return g->edits;
274}
275
276/* Number of bytes for all groups >= given group. */
277always_inline uword
278pg_edit_group_n_bytes (pg_stream_t * s, u32 group_index)
279{
Calvin71e97c62016-08-19 16:23:14 -0400280 pg_edit_group_t *g;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700281 uword n_bytes = 0;
282
283 for (g = s->edit_groups + group_index; g < vec_end (s->edit_groups); g++)
284 n_bytes += g->n_packet_bytes;
285 return n_bytes;
286}
287
288always_inline void
289pg_free_edit_group (pg_stream_t * s)
290{
291 uword i = vec_len (s->edit_groups) - 1;
Calvin71e97c62016-08-19 16:23:14 -0400292 pg_edit_group_t *g = pg_stream_get_group (s, i);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700293
294 pg_edit_group_free (g);
Dave Barachb7b92992018-10-17 10:38:51 -0400295 clib_memset (g, 0, sizeof (g[0]));
Ed Warnickecb9cada2015-12-08 15:45:58 -0700296 _vec_len (s->edit_groups) = i;
297}
298
Calvin71e97c62016-08-19 16:23:14 -0400299typedef struct
300{
Damjan Marion64034362016-11-07 22:19:55 +0100301 /* TX lock */
302 volatile u32 *lockp;
303
Ed Warnickecb9cada2015-12-08 15:45:58 -0700304 /* VLIB interface indices. */
305 u32 hw_if_index, sw_if_index;
306
307 /* Identifies stream for this interface. */
Damjan Marion3d9c86e2016-07-04 21:04:40 +0200308 u32 id;
309
Mohsin Kazmif382b062020-08-11 15:00:44 +0200310 u8 coalesce_enabled;
311 gro_flow_table_t *flow_table;
Mohsin Kazmi22e9cfd2019-07-23 11:54:48 +0200312 u8 gso_enabled;
313 u32 gso_size;
Damjan Marion3d9c86e2016-07-04 21:04:40 +0200314 pcap_main_t pcap_main;
Jakub Grajciardb863292020-01-30 14:14:15 +0100315 char *pcap_file_name;
Neale Ranns21fb4f72020-10-05 12:26:47 +0000316
317 mac_address_t *allowed_mcast_macs;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700318} pg_interface_t;
319
320/* Per VLIB node data. */
Calvin71e97c62016-08-19 16:23:14 -0400321typedef struct
322{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700323 /* Parser function indexed by node index. */
Calvin71e97c62016-08-19 16:23:14 -0400324 unformat_function_t *unformat_edit;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700325} pg_node_t;
326
Calvin71e97c62016-08-19 16:23:14 -0400327typedef struct pg_main_t
328{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700329 /* Pool of streams. */
Calvin71e97c62016-08-19 16:23:14 -0400330 pg_stream_t *streams;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700331
332 /* Bitmap indicating which streams are currently enabled. */
Damjan Marion3a4ed392016-11-08 13:20:42 +0100333 uword **enabled_streams;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700334
335 /* Hash mapping name -> stream index. */
Calvin71e97c62016-08-19 16:23:14 -0400336 uword *stream_index_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700337
Damjan Marion3d9c86e2016-07-04 21:04:40 +0200338 /* Pool of interfaces. */
Calvin71e97c62016-08-19 16:23:14 -0400339 pg_interface_t *interfaces;
340 uword *if_index_by_if_id;
Neale Ranns21fb4f72020-10-05 12:26:47 +0000341 uword *if_id_by_sw_if_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700342
Dave Barach3c8e1462019-01-05 16:51:41 -0500343 /* Vector of buffer indices for use in pg_stream_fill_replay, per thread */
344 u32 **replay_buffers_by_thread;
345
Ed Warnickecb9cada2015-12-08 15:45:58 -0700346 /* Per VLIB node information. */
Calvin71e97c62016-08-19 16:23:14 -0400347 pg_node_t *nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700348} pg_main_t;
349
350/* Global main structure. */
351extern pg_main_t pg_main;
352
353/* Global node. */
354extern vlib_node_registration_t pg_input_node;
355
356/* Buffer generator input, output node functions. */
357vlib_node_function_t pg_input, pg_output;
358
359/* Stream add/delete. */
360void pg_stream_del (pg_main_t * pg, uword index);
361void pg_stream_add (pg_main_t * pg, pg_stream_t * s_init);
Kingwel Xie42223472019-01-19 22:49:26 -0500362void pg_stream_change (pg_main_t * pg, pg_stream_t * s);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700363
364/* Enable/disable stream. */
Calvin71e97c62016-08-19 16:23:14 -0400365void pg_stream_enable_disable (pg_main_t * pg, pg_stream_t * s,
366 int is_enable);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700367
Mohsin Kazmif382b062020-08-11 15:00:44 +0200368/* Enable/disable packet coalesce on given interface */
369void pg_interface_enable_disable_coalesce (pg_interface_t * pi, u8 enable,
370 u32 tx_node_index);
371
Ed Warnickecb9cada2015-12-08 15:45:58 -0700372/* Find/create free packet-generator interface index. */
Mohsin Kazmi22e9cfd2019-07-23 11:54:48 +0200373u32 pg_interface_add_or_get (pg_main_t * pg, uword stream_index,
Mohsin Kazmif382b062020-08-11 15:00:44 +0200374 u8 gso_enabled, u32 gso_size,
375 u8 coalesce_enabled);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700376
377always_inline pg_node_t *
378pg_get_node (uword node_index)
379{
Calvin71e97c62016-08-19 16:23:14 -0400380 pg_main_t *pg = &pg_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700381 vec_validate (pg->nodes, node_index);
382 return pg->nodes + node_index;
383}
384
385void pg_edit_group_get_fixed_packet_data (pg_stream_t * s,
386 u32 group_index,
Calvin71e97c62016-08-19 16:23:14 -0400387 void *fixed_packet_data,
388 void *fixed_packet_data_mask);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700389
Pavel Kotucek9e6ed6e2016-07-12 10:18:26 +0200390void pg_enable_disable (u32 stream_index, int is_enable);
391
Calvin71e97c62016-08-19 16:23:14 -0400392typedef struct
393{
394 u32 hw_if_index;
395 u32 dev_instance;
396 u8 is_enabled;
Jakub Grajciardb863292020-01-30 14:14:15 +0100397 char *pcap_file_name;
Calvin71e97c62016-08-19 16:23:14 -0400398 u32 count;
Pavel Kotucek9e6ed6e2016-07-12 10:18:26 +0200399} pg_capture_args_t;
400
Calvin71e97c62016-08-19 16:23:14 -0400401clib_error_t *pg_capture (pg_capture_args_t * a);
Pavel Kotucek9e6ed6e2016-07-12 10:18:26 +0200402
Damjan Marionbfe4dfa2017-02-03 21:16:16 +0100403typedef struct
404{
405 vlib_buffer_t buffer;
406 u32 buffer_index;
407}
408pg_output_trace_t;
409
Ed Warnickecb9cada2015-12-08 15:45:58 -0700410#endif /* included_vlib_pg_h */
Calvin71e97c62016-08-19 16:23:14 -0400411
412/*
413 * fd.io coding-style-patch-verification: ON
414 *
415 * Local Variables:
416 * eval: (c-set-style "gnu")
417 * End:
418 */