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.h: VLIB packet generator
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 #ifndef included_vlib_pg_h
41 #define included_vlib_pg_h
43 #include <vlib/vlib.h> /* for VLIB_N_RX_TX */
44 #include <vnet/pg/edit.h>
45 #include <vppinfra/fifo.h> /* for buffer_fifo */
46 #include <vppinfra/pcap.h>
47 #include <vnet/interface.h>
49 extern vnet_device_class_t pg_dev_class;
54 typedef struct pg_edit_group_t
56 /* Edits in this group. */
59 /* Vector of non-fixed edits for this group. */
60 pg_edit_t *non_fixed_edits;
62 /* Fixed edits for this group. */
63 u8 *fixed_packet_data;
64 u8 *fixed_packet_data_mask;
66 /* Byte offset where packet data begins. */
67 u32 start_byte_offset;
69 /* Number of packet bytes for this edit group. */
72 /* Function to perform miscellaneous edits (e.g. set IP checksum, ...). */
73 void (*edit_function) (struct pg_main_t * pg,
74 struct pg_stream_t * s,
75 struct pg_edit_group_t * g,
76 u32 * buffers, u32 n_buffers);
78 /* Opaque data for edit function's use. */
79 uword edit_function_opaque;
82 /* Packets are made of multiple buffers chained together.
83 This struct keeps track of data per-chain index. */
86 /* Vector of buffer edits for this stream and buffer index. */
89 /* Buffers pre-initialized with fixed buffer data for this stream. */
94 typedef struct pg_stream_t
101 /* Stream is currently enabled. */
102 #define PG_STREAM_FLAGS_IS_ENABLED (1 << 0)
104 /* Edit groups are created by each protocol level (e.g. ethernet,
106 pg_edit_group_t *edit_groups;
108 pg_edit_type_t packet_size_edit_type;
110 /* Min/max packet size. */
111 u32 min_packet_bytes, max_packet_bytes;
113 /* Vector of non-fixed edits for this stream.
114 All fixed edits are performed and placed into fixed_packet_data. */
115 pg_edit_t *non_fixed_edits;
117 /* Packet data with all fixed edits performed.
118 All packets in stream are initialized according with this data.
119 Mask specifies which bits of packet data are covered by fixed edits. */
120 u8 *fixed_packet_data, *fixed_packet_data_mask;
122 /* Size to use for buffers. 0 means use buffers big enough
123 for max_packet_bytes. */
126 /* Last packet length if packet size edit type is increment. */
127 u32 last_increment_packet_size;
129 /* Index into main interface pool for this stream. */
132 /* Interface used to mark packets for this stream. May be different
133 than hw/sw index from pg main interface pool. They will be
134 different if this stream is being used generate buffers as if
135 they were received on a non-pg interface. For example, suppose you
136 are trying to test vlan code and you want to generate buffers that
137 appear to come from an ethernet interface. */
138 u32 sw_if_index[VLIB_N_RX_TX];
140 /* Node where stream's buffers get put. */
143 /* Worker thread index */
146 /* Output next index to reach output node from stream input node. */
151 /* Number of packets currently generated. */
152 u64 n_packets_generated;
154 /* Stream is disabled when packet limit is reached.
155 Zero means no packet limit. */
158 /* Only generate up to n_max_frame per frame. */
161 /* Rate for this stream in packets/second.
162 Zero means unlimited rate. */
163 f64 rate_packets_per_second;
165 f64 time_last_generate;
167 f64 packet_accumulator;
169 pg_buffer_index_t *buffer_indices;
171 u8 **replay_packet_templates;
172 u64 *replay_packet_timestamps;
173 u32 current_replay_packet_index;
177 pg_buffer_index_free (pg_buffer_index_t * bi)
179 vec_free (bi->edits);
180 clib_fifo_free (bi->buffer_fifo);
184 pg_edit_group_free (pg_edit_group_t * g)
187 vec_foreach (e, g->edits) pg_edit_free (e);
189 vec_free (g->fixed_packet_data);
190 vec_free (g->fixed_packet_data_mask);
194 pg_stream_free (pg_stream_t * s)
199 vec_foreach (e, s->non_fixed_edits) pg_edit_free (e);
200 vec_free (s->non_fixed_edits);
201 vec_foreach (g, s->edit_groups) pg_edit_group_free (g);
202 vec_free (s->edit_groups);
203 vec_free (s->fixed_packet_data);
204 vec_free (s->fixed_packet_data_mask);
206 for (i = 0; i < vec_len (s->replay_packet_templates); i++)
207 vec_free (s->replay_packet_templates[i]);
208 vec_free (s->replay_packet_templates);
209 vec_free (s->replay_packet_timestamps);
212 pg_buffer_index_t *bi;
213 vec_foreach (bi, s->buffer_indices) pg_buffer_index_free (bi);
214 vec_free (s->buffer_indices);
219 pg_stream_is_enabled (pg_stream_t * s)
221 return (s->flags & PG_STREAM_FLAGS_IS_ENABLED) != 0;
224 always_inline pg_edit_group_t *
225 pg_stream_get_group (pg_stream_t * s, u32 group_index)
227 return vec_elt_at_index (s->edit_groups, group_index);
231 pg_create_edit_group (pg_stream_t * s,
232 int n_edit_bytes, int n_packet_bytes, u32 * group_index)
237 vec_add2 (s->edit_groups, g, 1);
239 *group_index = g - s->edit_groups;
241 ASSERT (n_edit_bytes % sizeof (pg_edit_t) == 0);
242 n_edits = n_edit_bytes / sizeof (pg_edit_t);
243 vec_resize (g->edits, n_edits);
245 g->n_packet_bytes = n_packet_bytes;
251 pg_add_edits (pg_stream_t * s, int n_edit_bytes, int n_packet_bytes,
254 pg_edit_group_t *g = pg_stream_get_group (s, group_index);
257 ASSERT (n_edit_bytes % sizeof (pg_edit_t) == 0);
258 n_edits = n_edit_bytes / sizeof (pg_edit_t);
259 vec_add2 (g->edits, e, n_edits);
260 g->n_packet_bytes += n_packet_bytes;
265 pg_get_edit_group (pg_stream_t * s, u32 group_index)
267 pg_edit_group_t *g = pg_stream_get_group (s, group_index);
271 /* Number of bytes for all groups >= given group. */
273 pg_edit_group_n_bytes (pg_stream_t * s, u32 group_index)
278 for (g = s->edit_groups + group_index; g < vec_end (s->edit_groups); g++)
279 n_bytes += g->n_packet_bytes;
284 pg_free_edit_group (pg_stream_t * s)
286 uword i = vec_len (s->edit_groups) - 1;
287 pg_edit_group_t *g = pg_stream_get_group (s, i);
289 pg_edit_group_free (g);
290 clib_memset (g, 0, sizeof (g[0]));
291 _vec_len (s->edit_groups) = i;
299 /* VLIB interface indices. */
300 u32 hw_if_index, sw_if_index;
302 /* Identifies stream for this interface. */
307 pcap_main_t pcap_main;
308 char *pcap_file_name;
311 /* Per VLIB node data. */
314 /* Parser function indexed by node index. */
315 unformat_function_t *unformat_edit;
318 typedef struct pg_main_t
320 /* Pool of streams. */
321 pg_stream_t *streams;
323 /* Bitmap indicating which streams are currently enabled. */
324 uword **enabled_streams;
326 /* Hash mapping name -> stream index. */
327 uword *stream_index_by_name;
329 /* Pool of interfaces. */
330 pg_interface_t *interfaces;
331 uword *if_index_by_if_id;
333 /* Vector of buffer indices for use in pg_stream_fill_replay, per thread */
334 u32 **replay_buffers_by_thread;
336 /* Per VLIB node information. */
340 /* Global main structure. */
341 extern pg_main_t pg_main;
344 extern vlib_node_registration_t pg_input_node;
346 /* Buffer generator input, output node functions. */
347 vlib_node_function_t pg_input, pg_output;
349 /* Stream add/delete. */
350 void pg_stream_del (pg_main_t * pg, uword index);
351 void pg_stream_add (pg_main_t * pg, pg_stream_t * s_init);
352 void pg_stream_change (pg_main_t * pg, pg_stream_t * s);
354 /* Enable/disable stream. */
355 void pg_stream_enable_disable (pg_main_t * pg, pg_stream_t * s,
358 /* Find/create free packet-generator interface index. */
359 u32 pg_interface_add_or_get (pg_main_t * pg, uword stream_index,
360 u8 gso_enabled, u32 gso_size);
362 always_inline pg_node_t *
363 pg_get_node (uword node_index)
365 pg_main_t *pg = &pg_main;
366 vec_validate (pg->nodes, node_index);
367 return pg->nodes + node_index;
370 void pg_edit_group_get_fixed_packet_data (pg_stream_t * s,
372 void *fixed_packet_data,
373 void *fixed_packet_data_mask);
375 void pg_enable_disable (u32 stream_index, int is_enable);
382 char *pcap_file_name;
386 clib_error_t *pg_capture (pg_capture_args_t * a);
390 vlib_buffer_t buffer;
395 #endif /* included_vlib_pg_h */
398 * fd.io coding-style-patch-verification: ON
401 * eval: (c-set-style "gnu")