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