src/vnet/pg/pg.h

   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.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>
  45 #include <vppinfra/fifo.h>      /* for buffer_fifo */
  46 #include <vnet/unix/pcap.h>
  47 #include <vnet/interface.h>
  48
  49 extern vnet_device_class_t pg_dev_class;
  50
  51 struct pg_main_t;
  52 struct pg_stream_t;
  53
  54 typedef struct pg_edit_group_t
  55 {
  56   /* Edits in this group. */
  57   pg_edit_t *edits;
  58
  59   /* Vector of non-fixed edits for this group. */
  60   pg_edit_t *non_fixed_edits;
  61
  62   /* Fixed edits for this group. */
  63   u8 *fixed_packet_data;
  64   u8 *fixed_packet_data_mask;
  65
  66   /* Byte offset where packet data begins. */
  67   u32 start_byte_offset;
  68
  69   /* Number of packet bytes for this edit group. */
  70   u32 n_packet_bytes;
  71
  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);
  77
  78   /* Opaque data for edit function's use. */
  79   uword edit_function_opaque;
  80 } pg_edit_group_t;
  81
  82 /* Packets are made of multiple buffers chained together.
  83    This struct keeps track of data per-chain index. */
  84 typedef struct
  85 {
  86   /* Vector of buffer edits for this stream and buffer index. */
  87   pg_edit_t *edits;
  88
  89   /* Buffers pre-initialized with fixed buffer data for this stream. */
  90   u32 *buffer_fifo;
  91
  92   /* Buffer free list for this buffer index in stream. */
  93   vlib_buffer_free_list_index_t free_list_index;
  94 } pg_buffer_index_t;
  95
  96 typedef struct pg_stream_t
  97 {
  98   /* Stream name. */
  99   u8 *name;
 100
 101   u32 flags;
 102
 103   /* Stream is currently enabled. */
 104 #define PG_STREAM_FLAGS_IS_ENABLED (1 << 0)
 105 #define PG_STREAM_FLAGS_DISABLE_BUFFER_RECYCLE (1 << 1)
 106
 107   /* Edit groups are created by each protocol level (e.g. ethernet,
 108      ip4, tcp, ...). */
 109   pg_edit_group_t *edit_groups;
 110
 111   pg_edit_type_t packet_size_edit_type;
 112
 113   /* Min/max packet size. */
 114   u32 min_packet_bytes, max_packet_bytes;
 115
 116   /* Vector of non-fixed edits for this stream.
 117      All fixed edits are performed and placed into fixed_packet_data. */
 118   pg_edit_t *non_fixed_edits;
 119
 120   /* Packet data with all fixed edits performed.
 121      All packets in stream are initialized according with this data.
 122      Mask specifies which bits of packet data are covered by fixed edits. */
 123   u8 *fixed_packet_data, *fixed_packet_data_mask;
 124
 125   /* Size to use for buffers.  0 means use buffers big enough
 126      for max_packet_bytes. */
 127   u32 buffer_bytes;
 128
 129   /* Last packet length if packet size edit type is increment. */
 130   u32 last_increment_packet_size;
 131
 132   /* Index into main interface pool for this stream. */
 133   u32 pg_if_index;
 134
 135   /* Interface used to mark packets for this stream.  May be different
 136      than hw/sw index from pg main interface pool.  They will be
 137      different if this stream is being used generate buffers as if
 138      they were received on a non-pg interface.  For example, suppose you
 139      are trying to test vlan code and you want to generate buffers that
 140      appear to come from an ethernet interface. */
 141   u32 sw_if_index[VLIB_N_RX_TX];
 142
 143   /* Node where stream's buffers get put. */
 144   u32 node_index;
 145
 146   /* Worker thread index */
 147   u32 worker_index;
 148
 149   /* Output next index to reach output node from stream input node. */
 150   u32 next_index;
 151
 152   u32 if_id;
 153
 154   /* Number of packets currently generated. */
 155   u64 n_packets_generated;
 156
 157   /* Stream is disabled when packet limit is reached.
 158      Zero means no packet limit. */
 159   u64 n_packets_limit;
 160
 161   /* Rate for this stream in packets/second.
 162      Zero means unlimited rate. */
 163   f64 rate_packets_per_second;
 164
 165   f64 time_last_generate;
 166
 167   f64 packet_accumulator;
 168
 169   pg_buffer_index_t *buffer_indices;
 170
 171   u8 **replay_packet_templates;
 172   u64 *replay_packet_timestamps;
 173   u32 current_replay_packet_index;
 174 } pg_stream_t;
 175
 176 always_inline void
 177 pg_buffer_index_free (pg_buffer_index_t * bi)
 178 {
 179   vec_free (bi->edits);
 180   clib_fifo_free (bi->buffer_fifo);
 181 }
 182
 183 always_inline void
 184 pg_edit_group_free (pg_edit_group_t * g)
 185 {
 186   pg_edit_t *e;
 187   vec_foreach (e, g->edits) pg_edit_free (e);
 188   vec_free (g->edits);
 189   vec_free (g->fixed_packet_data);
 190   vec_free (g->fixed_packet_data_mask);
 191 }
 192
 193 always_inline void
 194 pg_stream_free (pg_stream_t * s)
 195 {
 196   int i;
 197   pg_edit_group_t *g;
 198   pg_edit_t *e;
 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);
 205   vec_free (s->name);
 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);
 210
 211   {
 212     pg_buffer_index_t *bi;
 213     vec_foreach (bi, s->buffer_indices) pg_buffer_index_free (bi);
 214     vec_free (s->buffer_indices);
 215   }
 216 }
 217
 218 always_inline int
 219 pg_stream_is_enabled (pg_stream_t * s)
 220 {
 221   return (s->flags & PG_STREAM_FLAGS_IS_ENABLED) != 0;
 222 }
 223
 224 always_inline pg_edit_group_t *
 225 pg_stream_get_group (pg_stream_t * s, u32 group_index)
 226 {
 227   return vec_elt_at_index (s->edit_groups, group_index);
 228 }
 229
 230 always_inline void *
 231 pg_create_edit_group (pg_stream_t * s,
 232                       int n_edit_bytes, int n_packet_bytes, u32 * group_index)
 233 {
 234   pg_edit_group_t *g;
 235   int n_edits;
 236
 237   vec_add2 (s->edit_groups, g, 1);
 238   if (group_index)
 239     *group_index = g - s->edit_groups;
 240
 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);
 244
 245   g->n_packet_bytes = n_packet_bytes;
 246
 247   return g->edits;
 248 }
 249
 250 always_inline void *
 251 pg_add_edits (pg_stream_t * s, int n_edit_bytes, int n_packet_bytes,
 252               u32 group_index)
 253 {
 254   pg_edit_group_t *g = pg_stream_get_group (s, group_index);
 255   pg_edit_t *e;
 256   int n_edits;
 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;
 261   return e;
 262 }
 263
 264 always_inline void *
 265 pg_get_edit_group (pg_stream_t * s, u32 group_index)
 266 {
 267   pg_edit_group_t *g = pg_stream_get_group (s, group_index);
 268   return g->edits;
 269 }
 270
 271 /* Number of bytes for all groups >= given group. */
 272 always_inline uword
 273 pg_edit_group_n_bytes (pg_stream_t * s, u32 group_index)
 274 {
 275   pg_edit_group_t *g;
 276   uword n_bytes = 0;
 277
 278   for (g = s->edit_groups + group_index; g < vec_end (s->edit_groups); g++)
 279     n_bytes += g->n_packet_bytes;
 280   return n_bytes;
 281 }
 282
 283 always_inline void
 284 pg_free_edit_group (pg_stream_t * s)
 285 {
 286   uword i = vec_len (s->edit_groups) - 1;
 287   pg_edit_group_t *g = pg_stream_get_group (s, i);
 288
 289   pg_edit_group_free (g);
 290   memset (g, 0, sizeof (g[0]));
 291   _vec_len (s->edit_groups) = i;
 292 }
 293
 294 typedef struct
 295 {
 296   /* TX lock */
 297   volatile u32 *lockp;
 298
 299   /* VLIB interface indices. */
 300   u32 hw_if_index, sw_if_index;
 301
 302   /* Identifies stream for this interface. */
 303   u32 id;
 304
 305   pcap_main_t pcap_main;
 306   u8 *pcap_file_name;
 307 } pg_interface_t;
 308
 309 /* Per VLIB node data. */
 310 typedef struct
 311 {
 312   /* Parser function indexed by node index. */
 313   unformat_function_t *unformat_edit;
 314 } pg_node_t;
 315
 316 typedef struct pg_main_t
 317 {
 318   /* Pool of streams. */
 319   pg_stream_t *streams;
 320
 321   /* Bitmap indicating which streams are currently enabled. */
 322   uword **enabled_streams;
 323
 324   /* Hash mapping name -> stream index. */
 325   uword *stream_index_by_name;
 326
 327   /* Pool of interfaces. */
 328   pg_interface_t *interfaces;
 329   uword *if_index_by_if_id;
 330
 331   /* Per VLIB node information. */
 332   pg_node_t *nodes;
 333 } pg_main_t;
 334
 335 /* Global main structure. */
 336 extern pg_main_t pg_main;
 337
 338 /* Global node. */
 339 extern vlib_node_registration_t pg_input_node;
 340
 341 /* Buffer generator input, output node functions. */
 342 vlib_node_function_t pg_input, pg_output;
 343
 344 /* Stream add/delete. */
 345 void pg_stream_del (pg_main_t * pg, uword index);
 346 void pg_stream_add (pg_main_t * pg, pg_stream_t * s_init);
 347
 348 /* Enable/disable stream. */
 349 void pg_stream_enable_disable (pg_main_t * pg, pg_stream_t * s,
 350                                int is_enable);
 351
 352 /* Find/create free packet-generator interface index. */
 353 u32 pg_interface_add_or_get (pg_main_t * pg, uword stream_index);
 354
 355 always_inline pg_node_t *
 356 pg_get_node (uword node_index)
 357 {
 358   pg_main_t *pg = &pg_main;
 359   vec_validate (pg->nodes, node_index);
 360   return pg->nodes + node_index;
 361 }
 362
 363 void pg_edit_group_get_fixed_packet_data (pg_stream_t * s,
 364                                           u32 group_index,
 365                                           void *fixed_packet_data,
 366                                           void *fixed_packet_data_mask);
 367
 368 void pg_enable_disable (u32 stream_index, int is_enable);
 369
 370 typedef struct
 371 {
 372   u32 hw_if_index;
 373   u32 dev_instance;
 374   u8 is_enabled;
 375   u8 *pcap_file_name;
 376   u32 count;
 377 } pg_capture_args_t;
 378
 379 clib_error_t *pg_capture (pg_capture_args_t * a);
 380
 381 typedef struct
 382 {
 383   vlib_buffer_t buffer;
 384   u32 buffer_index;
 385 }
 386 pg_output_trace_t;
 387
 388 #endif /* included_vlib_pg_h */
 389
 390 /*
 391  * fd.io coding-style-patch-verification: ON
 392  *
 393  * Local Variables:
 394  * eval: (c-set-style "gnu")
 395  * End:
 396  */