vnet/vnet/pg/stream.c

   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
  44 /* Mark stream active or inactive. */
  45 void
  46 pg_stream_enable_disable (pg_main_t * pg, pg_stream_t * s, int want_enabled)
  47 {
  48   vnet_main_t *vnm = vnet_get_main ();
  49   pg_interface_t *pi = pool_elt_at_index (pg->interfaces, s->pg_if_index);
  50
  51   want_enabled = want_enabled != 0;
  52
  53   if (pg_stream_is_enabled (s) == want_enabled)
  54     /* No change necessary. */
  55     return;
  56
  57   if (want_enabled)
  58     s->n_packets_generated = 0;
  59
  60   /* Toggle enabled flag. */
  61   s->flags ^= PG_STREAM_FLAGS_IS_ENABLED;
  62
  63   ASSERT (!pool_is_free (pg->streams, s));
  64
  65   pg->enabled_streams
  66     = clib_bitmap_set (pg->enabled_streams, s - pg->streams, want_enabled);
  67
  68   if (want_enabled)
  69     {
  70       vnet_hw_interface_set_flags (vnm, pi->hw_if_index,
  71                                    VNET_HW_INTERFACE_FLAG_LINK_UP);
  72
  73       vnet_sw_interface_set_flags (vnm, pi->sw_if_index,
  74                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
  75     }
  76
  77   vlib_node_set_state (pg->vlib_main,
  78                        pg_input_node.index,
  79                        (clib_bitmap_is_zero (pg->enabled_streams)
  80                         ? VLIB_NODE_STATE_DISABLED
  81                         : VLIB_NODE_STATE_POLLING));
  82
  83   s->packet_accumulator = 0;
  84   s->time_last_generate = 0;
  85 }
  86
  87 static u8 *
  88 format_pg_interface_name (u8 * s, va_list * args)
  89 {
  90   pg_main_t *pg = &pg_main;
  91   u32 if_index = va_arg (*args, u32);
  92   pg_interface_t *pi;
  93
  94   pi = pool_elt_at_index (pg->interfaces, if_index);
  95   s = format (s, "pg%d", pi->id);
  96
  97   return s;
  98 }
  99
 100 static clib_error_t *
 101 pg_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 102 {
 103   u32 hw_flags = 0;
 104
 105   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 106     hw_flags = VNET_HW_INTERFACE_FLAG_LINK_UP;
 107
 108   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
 109
 110   return 0;
 111 }
 112
 113 /* *INDENT-OFF* */
 114 VNET_DEVICE_CLASS (pg_dev_class) = {
 115   .name = "pg",
 116   .tx_function = pg_output,
 117   .format_device_name = format_pg_interface_name,
 118   .admin_up_down_function = pg_interface_admin_up_down,
 119 };
 120 /* *INDENT-ON* */
 121
 122 static uword
 123 pg_set_rewrite (vnet_main_t * vnm,
 124                 u32 sw_if_index,
 125                 u32 l3_type,
 126                 void *dst_address, void *rewrite, uword max_rewrite_bytes)
 127 {
 128   u16 *h = rewrite;
 129
 130   if (max_rewrite_bytes < sizeof (h[0]))
 131     return 0;
 132
 133   h[0] = clib_host_to_net_u16 (l3_type);
 134   return sizeof (h[0]);
 135 }
 136
 137 /* *INDENT-OFF* */
 138 VNET_HW_INTERFACE_CLASS (pg_interface_class,static) = {
 139   .name = "Packet generator",
 140   .set_rewrite = pg_set_rewrite,
 141 };
 142 /* *INDENT-ON* */
 143
 144 static u32
 145 pg_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
 146 {
 147   /* nothing for now */
 148   return 0;
 149 }
 150
 151 u32
 152 pg_interface_add_or_get (pg_main_t * pg, uword if_id)
 153 {
 154   vnet_main_t *vnm = vnet_get_main ();
 155   vlib_main_t *vm = vlib_get_main ();
 156   pg_interface_t *pi;
 157   vnet_hw_interface_t *hi;
 158   uword *p;
 159   u32 i;
 160
 161   p = hash_get (pg->if_index_by_if_id, if_id);
 162
 163   if (p)
 164     {
 165       return p[0];
 166     }
 167   else
 168     {
 169       u8 hw_addr[6];
 170       f64 now = vlib_time_now (vm);
 171       u32 rnd;
 172
 173       pool_get (pg->interfaces, pi);
 174       i = pi - pg->interfaces;
 175
 176       rnd = (u32) (now * 1e6);
 177       rnd = random_u32 (&rnd);
 178       clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
 179       hw_addr[0] = 2;
 180       hw_addr[1] = 0xfe;
 181
 182       pi->id = if_id;
 183       ethernet_register_interface (vnm, pg_dev_class.index, i, hw_addr,
 184                                    &pi->hw_if_index, pg_eth_flag_change);
 185       hi = vnet_get_hw_interface (vnm, pi->hw_if_index);
 186       pi->sw_if_index = hi->sw_if_index;
 187
 188       hash_set (pg->if_index_by_if_id, if_id, i);
 189     }
 190
 191   return i;
 192 }
 193
 194 static void
 195 do_edit (pg_stream_t * stream,
 196          pg_edit_group_t * g, pg_edit_t * e, uword want_commit)
 197 {
 198   u32 i, i0, i1, mask, n_bits_left;
 199   u8 *v, *s, *m;
 200
 201   i0 = e->lsb_bit_offset / BITS (u8);
 202
 203   /* Make space for edit in value and mask. */
 204   vec_validate (g->fixed_packet_data, i0);
 205   vec_validate (g->fixed_packet_data_mask, i0);
 206
 207   if (e->type != PG_EDIT_FIXED)
 208     {
 209       switch (e->type)
 210         {
 211         case PG_EDIT_RANDOM:
 212         case PG_EDIT_INCREMENT:
 213           e->last_increment_value = pg_edit_get_value (e, PG_EDIT_LO);
 214           break;
 215
 216         default:
 217           break;
 218         }
 219
 220       if (want_commit)
 221         {
 222           ASSERT (e->type != PG_EDIT_INVALID_TYPE);
 223           vec_add1 (g->non_fixed_edits, e[0]);
 224         }
 225       return;
 226     }
 227
 228   s = g->fixed_packet_data;
 229   m = g->fixed_packet_data_mask;
 230
 231   n_bits_left = e->n_bits;
 232   i0 = e->lsb_bit_offset / BITS (u8);
 233   i1 = e->lsb_bit_offset % BITS (u8);
 234
 235   v = e->values[PG_EDIT_LO];
 236   i = pg_edit_n_alloc_bytes (e) - 1;
 237
 238   /* Odd low order bits?. */
 239   if (i1 != 0 && n_bits_left > 0)
 240     {
 241       u32 n = clib_min (n_bits_left, BITS (u8) - i1);
 242
 243       mask = pow2_mask (n) << i1;
 244
 245       ASSERT (i0 < vec_len (s));
 246       ASSERT (i < vec_len (v));
 247       ASSERT ((v[i] & ~mask) == 0);
 248
 249       s[i0] |= v[i] & mask;
 250       m[i0] |= mask;
 251
 252       i0--;
 253       i--;
 254       n_bits_left -= n;
 255     }
 256
 257   /* Even bytes. */
 258   while (n_bits_left >= 8)
 259     {
 260       ASSERT (i0 < vec_len (s));
 261       ASSERT (i < vec_len (v));
 262
 263       s[i0] = v[i];
 264       m[i0] = ~0;
 265
 266       i0--;
 267       i--;
 268       n_bits_left -= 8;
 269     }
 270
 271   /* Odd high order bits. */
 272   if (n_bits_left > 0)
 273     {
 274       mask = pow2_mask (n_bits_left);
 275
 276       ASSERT (i0 < vec_len (s));
 277       ASSERT (i < vec_len (v));
 278       ASSERT ((v[i] & ~mask) == 0);
 279
 280       s[i0] |= v[i] & mask;
 281       m[i0] |= mask;
 282     }
 283
 284   if (want_commit)
 285     pg_edit_free (e);
 286 }
 287
 288 void
 289 pg_edit_group_get_fixed_packet_data (pg_stream_t * s,
 290                                      u32 group_index,
 291                                      void *packet_data,
 292                                      void *packet_data_mask)
 293 {
 294   pg_edit_group_t *g = pg_stream_get_group (s, group_index);
 295   pg_edit_t *e;
 296
 297   vec_foreach (e, g->edits) do_edit (s, g, e, /* want_commit */ 0);
 298
 299   clib_memcpy (packet_data, g->fixed_packet_data,
 300                vec_len (g->fixed_packet_data));
 301   clib_memcpy (packet_data_mask, g->fixed_packet_data_mask,
 302                vec_len (g->fixed_packet_data_mask));
 303 }
 304
 305 static void
 306 perform_fixed_edits (pg_stream_t * s)
 307 {
 308   pg_edit_group_t *g;
 309   pg_edit_t *e;
 310   word i;
 311
 312   for (i = vec_len (s->edit_groups) - 1; i >= 0; i--)
 313     {
 314       g = vec_elt_at_index (s->edit_groups, i);
 315       vec_foreach (e, g->edits) do_edit (s, g, e, /* want_commit */ 1);
 316
 317       /* All edits have either been performed or added to
 318          g->non_fixed_edits.  So, we can delete the vector. */
 319       vec_free (g->edits);
 320     }
 321
 322   vec_free (s->fixed_packet_data_mask);
 323   vec_free (s->fixed_packet_data);
 324   vec_foreach (g, s->edit_groups)
 325   {
 326     int i;
 327     g->start_byte_offset = vec_len (s->fixed_packet_data);
 328
 329     /* Relocate and copy non-fixed edits from group to stream. */
 330     vec_foreach (e, g->non_fixed_edits)
 331       e->lsb_bit_offset += g->start_byte_offset * BITS (u8);
 332
 333     for (i = 0; i < vec_len (g->non_fixed_edits); i++)
 334       ASSERT (g->non_fixed_edits[i].type != PG_EDIT_INVALID_TYPE);
 335
 336     vec_add (s->non_fixed_edits,
 337              g->non_fixed_edits, vec_len (g->non_fixed_edits));
 338     vec_free (g->non_fixed_edits);
 339
 340     vec_add (s->fixed_packet_data,
 341              g->fixed_packet_data, vec_len (g->fixed_packet_data));
 342     vec_add (s->fixed_packet_data_mask,
 343              g->fixed_packet_data_mask, vec_len (g->fixed_packet_data_mask));
 344   }
 345 }
 346
 347 void
 348 pg_stream_add (pg_main_t * pg, pg_stream_t * s_init)
 349 {
 350   vlib_main_t *vm = pg->vlib_main;
 351   pg_stream_t *s;
 352   uword *p;
 353
 354   if (!pg->stream_index_by_name)
 355     pg->stream_index_by_name
 356       = hash_create_vec (0, sizeof (s->name[0]), sizeof (uword));
 357
 358   /* Delete any old stream with the same name. */
 359   if (s_init->name
 360       && (p = hash_get_mem (pg->stream_index_by_name, s_init->name)))
 361     {
 362       pg_stream_del (pg, p[0]);
 363     }
 364
 365   pool_get (pg->streams, s);
 366   s[0] = s_init[0];
 367
 368   /* Give it a name. */
 369   if (!s->name)
 370     s->name = format (0, "stream%d", s - pg->streams);
 371   else
 372     s->name = vec_dup (s->name);
 373
 374   hash_set_mem (pg->stream_index_by_name, s->name, s - pg->streams);
 375
 376   /* Get fixed part of buffer data. */
 377   if (s->edit_groups)
 378     perform_fixed_edits (s);
 379
 380   /* Determine packet size. */
 381   switch (s->packet_size_edit_type)
 382     {
 383     case PG_EDIT_INCREMENT:
 384     case PG_EDIT_RANDOM:
 385       if (s->min_packet_bytes == s->max_packet_bytes)
 386         s->packet_size_edit_type = PG_EDIT_FIXED;
 387       break;
 388
 389     default:
 390       /* Get packet size from fixed edits. */
 391       s->packet_size_edit_type = PG_EDIT_FIXED;
 392       if (!s->replay_packet_templates)
 393         s->min_packet_bytes = s->max_packet_bytes =
 394           vec_len (s->fixed_packet_data);
 395       break;
 396     }
 397
 398   s->last_increment_packet_size = s->min_packet_bytes;
 399
 400   {
 401     pg_buffer_index_t *bi;
 402     int n;
 403
 404     if (!s->buffer_bytes)
 405       s->buffer_bytes = s->max_packet_bytes;
 406
 407     s->buffer_bytes = vlib_buffer_round_size (s->buffer_bytes);
 408
 409     n = s->max_packet_bytes / s->buffer_bytes;
 410     n += (s->max_packet_bytes % s->buffer_bytes) != 0;
 411
 412     vec_resize (s->buffer_indices, n);
 413
 414     vec_foreach (bi, s->buffer_indices)
 415       bi->free_list_index = vlib_buffer_create_free_list (vm, s->buffer_bytes,
 416                                                           "pg stream %d buffer #%d",
 417                                                           s - pg->streams,
 418                                                           1 + (bi -
 419                                                                s->
 420                                                                buffer_indices));
 421   }
 422
 423   /* Find an interface to use. */
 424   s->pg_if_index = pg_interface_add_or_get (pg, s->if_id);
 425
 426   {
 427     pg_interface_t *pi = pool_elt_at_index (pg->interfaces, s->pg_if_index);
 428     vlib_rx_or_tx_t rx_or_tx;
 429
 430     vlib_foreach_rx_tx (rx_or_tx)
 431     {
 432       if (s->sw_if_index[rx_or_tx] == ~0)
 433         s->sw_if_index[rx_or_tx] = pi->sw_if_index;
 434     }
 435   }
 436
 437   /* Connect the graph. */
 438   s->next_index = vlib_node_add_next (vm, pg_input_node.index, s->node_index);
 439 }
 440
 441 void
 442 pg_stream_del (pg_main_t * pg, uword index)
 443 {
 444   vlib_main_t *vm = pg->vlib_main;
 445   pg_stream_t *s;
 446   pg_buffer_index_t *bi;
 447
 448   s = pool_elt_at_index (pg->streams, index);
 449
 450   pg_stream_enable_disable (pg, s, /* want_enabled */ 0);
 451   hash_unset_mem (pg->stream_index_by_name, s->name);
 452
 453   vec_foreach (bi, s->buffer_indices)
 454   {
 455     vlib_buffer_delete_free_list (vm, bi->free_list_index);
 456     clib_fifo_free (bi->buffer_fifo);
 457   }
 458
 459   pg_stream_free (s);
 460   pool_put (pg->streams, s);
 461 }
 462
 463
 464 /*
 465  * fd.io coding-style-patch-verification: ON
 466  *
 467  * Local Variables:
 468  * eval: (c-set-style "gnu")
 469  * End:
 470  */