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)
103 #define PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE (1 << 1)
105 /* Edit groups are created by each protocol level (e.g. ethernet,
107 pg_edit_group_t *edit_groups;
109 pg_edit_type_t packet_size_edit_type;
111 /* Min/max packet size. */
112 u32 min_packet_bytes, max_packet_bytes;
114 /* Vector of non-fixed edits for this stream.
115 All fixed edits are performed and placed into fixed_packet_data. */
116 pg_edit_t *non_fixed_edits;
118 /* Packet data with all fixed edits performed.
119 All packets in stream are initialized according with this data.
120 Mask specifies which bits of packet data are covered by fixed edits. */
121 u8 *fixed_packet_data, *fixed_packet_data_mask;
123 /* Size to use for buffers. 0 means use buffers big enough
124 for max_packet_bytes. */
127 /* Last packet length if packet size edit type is increment. */
128 u32 last_increment_packet_size;
130 /* Index into main interface pool for this stream. */
133 /* Interface used to mark packets for this stream. May be different
134 than hw/sw index from pg main interface pool. They will be
135 different if this stream is being used generate buffers as if
136 they were received on a non-pg interface. For example, suppose you
137 are trying to test vlan code and you want to generate buffers that
138 appear to come from an ethernet interface. */
139 u32 sw_if_index[VLIB_N_RX_TX];
141 /* Node where stream's buffers get put. */
144 /* Worker thread index */
147 /* Output next index to reach output node from stream input node. */
152 /* Number of packets currently generated. */
153 u64 n_packets_generated;
155 /* Stream is disabled when packet limit is reached.
156 Zero means no packet limit. */
159 /* Rate for this stream in packets/second.
160 Zero means unlimited rate. */
161 f64 rate_packets_per_second;
163 f64 time_last_generate;
165 f64 packet_accumulator;
167 pg_buffer_index_t *buffer_indices;
169 u8 **replay_packet_templates;
170 u64 *replay_packet_timestamps;
171 u32 current_replay_packet_index;
175 pg_buffer_index_free (pg_buffer_index_t * bi)
177 vec_free (bi->edits);
178 clib_fifo_free (bi->buffer_fifo);
182 pg_edit_group_free (pg_edit_group_t * g)
185 vec_foreach (e, g->edits) pg_edit_free (e);
187 vec_free (g->fixed_packet_data);
188 vec_free (g->fixed_packet_data_mask);
192 pg_stream_free (pg_stream_t * s)
197 vec_foreach (e, s->non_fixed_edits) pg_edit_free (e);
198 vec_free (s->non_fixed_edits);
199 vec_foreach (g, s->edit_groups) pg_edit_group_free (g);
200 vec_free (s->edit_groups);
201 vec_free (s->fixed_packet_data);
202 vec_free (s->fixed_packet_data_mask);
204 for (i = 0; i < vec_len (s->replay_packet_templates); i++)
205 vec_free (s->replay_packet_templates[i]);
206 vec_free (s->replay_packet_templates);
207 vec_free (s->replay_packet_timestamps);
210 pg_buffer_index_t *bi;
211 vec_foreach (bi, s->buffer_indices) pg_buffer_index_free (bi);
212 vec_free (s->buffer_indices);
217 pg_stream_is_enabled (pg_stream_t * s)
219 return (s->flags & PG_STREAM_FLAGS_IS_ENABLED) != 0;
222 always_inline pg_edit_group_t *
223 pg_stream_get_group (pg_stream_t * s, u32 group_index)
225 return vec_elt_at_index (s->edit_groups, group_index);
229 pg_create_edit_group (pg_stream_t * s,
230 int n_edit_bytes, int n_packet_bytes, u32 * group_index)
235 vec_add2 (s->edit_groups, g, 1);
237 *group_index = g - s->edit_groups;
239 ASSERT (n_edit_bytes % sizeof (pg_edit_t) == 0);
240 n_edits = n_edit_bytes / sizeof (pg_edit_t);
241 vec_resize (g->edits, n_edits);
243 g->n_packet_bytes = n_packet_bytes;
249 pg_add_edits (pg_stream_t * s, int n_edit_bytes, int n_packet_bytes,
252 pg_edit_group_t *g = pg_stream_get_group (s, group_index);
255 ASSERT (n_edit_bytes % sizeof (pg_edit_t) == 0);
256 n_edits = n_edit_bytes / sizeof (pg_edit_t);
257 vec_add2 (g->edits, e, n_edits);
258 g->n_packet_bytes += n_packet_bytes;
263 pg_get_edit_group (pg_stream_t * s, u32 group_index)
265 pg_edit_group_t *g = pg_stream_get_group (s, group_index);
269 /* Number of bytes for all groups >= given group. */
271 pg_edit_group_n_bytes (pg_stream_t * s, u32 group_index)
276 for (g = s->edit_groups + group_index; g < vec_end (s->edit_groups); g++)
277 n_bytes += g->n_packet_bytes;
282 pg_free_edit_group (pg_stream_t * s)
284 uword i = vec_len (s->edit_groups) - 1;
285 pg_edit_group_t *g = pg_stream_get_group (s, i);
287 pg_edit_group_free (g);
288 clib_memset (g, 0, sizeof (g[0]));
289 _vec_len (s->edit_groups) = i;
297 /* VLIB interface indices. */
298 u32 hw_if_index, sw_if_index;
300 /* Identifies stream for this interface. */
303 pcap_main_t pcap_main;
307 /* Per VLIB node data. */
310 /* Parser function indexed by node index. */
311 unformat_function_t *unformat_edit;
314 typedef struct pg_main_t
316 /* Pool of streams. */
317 pg_stream_t *streams;
319 /* Bitmap indicating which streams are currently enabled. */
320 uword **enabled_streams;
322 /* Hash mapping name -> stream index. */
323 uword *stream_index_by_name;
325 /* Pool of interfaces. */
326 pg_interface_t *interfaces;
327 uword *if_index_by_if_id;
329 /* Vector of buffer indices for use in pg_stream_fill_replay, per thread */
330 u32 **replay_buffers_by_thread;
332 /* Per VLIB node information. */
336 /* Global main structure. */
337 extern pg_main_t pg_main;
340 extern vlib_node_registration_t pg_input_node;
342 /* Buffer generator input, output node functions. */
343 vlib_node_function_t pg_input, pg_output;
345 /* Stream add/delete. */
346 void pg_stream_del (pg_main_t * pg, uword index);
347 void pg_stream_add (pg_main_t * pg, pg_stream_t * s_init);
348 void pg_stream_change (pg_main_t * pg, pg_stream_t * s);
350 /* Enable/disable stream. */
351 void pg_stream_enable_disable (pg_main_t * pg, pg_stream_t * s,
354 /* Find/create free packet-generator interface index. */
355 u32 pg_interface_add_or_get (pg_main_t * pg, uword stream_index);
357 always_inline pg_node_t *
358 pg_get_node (uword node_index)
360 pg_main_t *pg = &pg_main;
361 vec_validate (pg->nodes, node_index);
362 return pg->nodes + node_index;
365 void pg_edit_group_get_fixed_packet_data (pg_stream_t * s,
367 void *fixed_packet_data,
368 void *fixed_packet_data_mask);
370 void pg_enable_disable (u32 stream_index, int is_enable);
381 clib_error_t *pg_capture (pg_capture_args_t * a);
385 vlib_buffer_t buffer;
390 #endif /* included_vlib_pg_h */
393 * fd.io coding-style-patch-verification: ON
396 * eval: (c-set-style "gnu")