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   u32 indent = format_get_indent (s);
 104
 105   s = format (s, "%Ubuffer 0x%x: %U",
 106               format_white_space, indent,
 107               t->buffer_index, format_vnet_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 static int
 143 pg_mac_address_cmp (const mac_address_t * m1, const mac_address_t * m2)
 144 {
 145   return (!mac_address_cmp (m1, m2));
 146 }
 147
 148 static clib_error_t *
 149 pg_add_del_mac_address (vnet_hw_interface_t * hi,
 150                         const u8 * address, u8 is_add)
 151 {
 152   pg_main_t *pg = &pg_main;
 153
 154   if (ethernet_address_cast (address))
 155     {
 156       mac_address_t mac;
 157       pg_interface_t *pi;
 158
 159       pi = pool_elt_at_index (pg->interfaces, hi->dev_instance);
 160
 161       mac_address_from_bytes (&mac, address);
 162       if (is_add)
 163         vec_add1 (pi->allowed_mcast_macs, mac);
 164       else
 165         {
 166           u32 pos = vec_search_with_function (pi->allowed_mcast_macs, &mac,
 167                                               pg_mac_address_cmp);
 168           if (~0 != pos)
 169             vec_del1 (pi->allowed_mcast_macs, pos);
 170         }
 171     }
 172   return (NULL);
 173 }
 174
 175 /* *INDENT-OFF* */
 176 VNET_DEVICE_CLASS (pg_dev_class) = {
 177   .name = "pg",
 178   .tx_function = pg_output,
 179   .format_device_name = format_pg_interface_name,
 180   .format_tx_trace = format_pg_output_trace,
 181   .admin_up_down_function = pg_interface_admin_up_down,
 182   .mac_addr_add_del_function = pg_add_del_mac_address,
 183 };
 184 /* *INDENT-ON* */
 185
 186 static u8 *
 187 pg_build_rewrite (vnet_main_t * vnm,
 188                   u32 sw_if_index,
 189                   vnet_link_t link_type, const void *dst_address)
 190 {
 191   u8 *rewrite = NULL;
 192   u16 *h;
 193
 194   vec_validate (rewrite, sizeof (*h) - 1);
 195   h = (u16 *) rewrite;
 196   h[0] = clib_host_to_net_u16 (vnet_link_to_l3_proto (link_type));
 197
 198   return (rewrite);
 199 }
 200
 201 /* *INDENT-OFF* */
 202 VNET_HW_INTERFACE_CLASS (pg_interface_class,static) = {
 203   .name = "Packet generator",
 204   .build_rewrite = pg_build_rewrite,
 205 };
 206 /* *INDENT-ON* */
 207
 208 static u32
 209 pg_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
 210 {
 211   /* nothing for now */
 212   return 0;
 213 }
 214
 215 void
 216 pg_interface_enable_disable_coalesce (pg_interface_t * pi, u8 enable,
 217                                       u32 tx_node_index)
 218 {
 219   if (enable)
 220     {
 221       gro_flow_table_init (&pi->flow_table, 1 /* is_l2 */ ,
 222                            tx_node_index);
 223       pi->coalesce_enabled = 1;
 224     }
 225   else
 226     {
 227       pi->coalesce_enabled = 0;
 228       gro_flow_table_free (pi->flow_table);
 229     }
 230 }
 231
 232 u32
 233 pg_interface_add_or_get (pg_main_t * pg, uword if_id, u8 gso_enabled,
 234                          u32 gso_size, u8 coalesce_enabled)
 235 {
 236   vnet_main_t *vnm = vnet_get_main ();
 237   vlib_main_t *vm = vlib_get_main ();
 238   pg_interface_t *pi;
 239   vnet_hw_interface_t *hi;
 240   uword *p;
 241   u32 i;
 242
 243   p = hash_get (pg->if_index_by_if_id, if_id);
 244
 245   if (p)
 246     {
 247       return p[0];
 248     }
 249   else
 250     {
 251       u8 hw_addr[6];
 252       f64 now = vlib_time_now (vm);
 253       u32 rnd;
 254
 255       pool_get (pg->interfaces, pi);
 256       i = pi - pg->interfaces;
 257
 258       rnd = (u32) (now * 1e6);
 259       rnd = random_u32 (&rnd);
 260       clib_memcpy_fast (hw_addr + 2, &rnd, sizeof (rnd));
 261       hw_addr[0] = 2;
 262       hw_addr[1] = 0xfe;
 263
 264       pi->id = if_id;
 265       ethernet_register_interface (vnm, pg_dev_class.index, i, hw_addr,
 266                                    &pi->hw_if_index, pg_eth_flag_change);
 267       hi = vnet_get_hw_interface (vnm, pi->hw_if_index);
 268       if (gso_enabled)
 269         {
 270           hi->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_TCP_GSO;
 271           pi->gso_enabled = 1;
 272           pi->gso_size = gso_size;
 273           if (coalesce_enabled)
 274             {
 275               pg_interface_enable_disable_coalesce (pi, 1, hi->tx_node_index);
 276             }
 277         }
 278       pi->sw_if_index = hi->sw_if_index;
 279
 280       hash_set (pg->if_index_by_if_id, if_id, i);
 281
 282       vec_validate (pg->if_id_by_sw_if_index, hi->sw_if_index);
 283       pg->if_id_by_sw_if_index[hi->sw_if_index] = i;
 284
 285       if (vlib_num_workers ())
 286         {
 287           pi->lockp = clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES,
 288                                               CLIB_CACHE_LINE_BYTES);
 289           *pi->lockp = 0;
 290         }
 291     }
 292
 293   return i;
 294 }
 295
 296 static void
 297 do_edit (pg_stream_t * stream,
 298          pg_edit_group_t * g, pg_edit_t * e, uword want_commit)
 299 {
 300   u32 i, i0, i1, mask, n_bits_left;
 301   u8 *v, *s, *m;
 302
 303   i0 = e->lsb_bit_offset / BITS (u8);
 304
 305   /* Make space for edit in value and mask. */
 306   vec_validate (g->fixed_packet_data, i0);
 307   vec_validate (g->fixed_packet_data_mask, i0);
 308
 309   if (e->type != PG_EDIT_FIXED)
 310     {
 311       switch (e->type)
 312         {
 313         case PG_EDIT_RANDOM:
 314         case PG_EDIT_INCREMENT:
 315           e->last_increment_value = pg_edit_get_value (e, PG_EDIT_LO);
 316           break;
 317
 318         default:
 319           break;
 320         }
 321
 322       if (want_commit)
 323         {
 324           ASSERT (e->type != PG_EDIT_INVALID_TYPE);
 325           vec_add1 (g->non_fixed_edits, e[0]);
 326         }
 327       return;
 328     }
 329
 330   s = g->fixed_packet_data;
 331   m = g->fixed_packet_data_mask;
 332
 333   n_bits_left = e->n_bits;
 334   i0 = e->lsb_bit_offset / BITS (u8);
 335   i1 = e->lsb_bit_offset % BITS (u8);
 336
 337   v = e->values[PG_EDIT_LO];
 338   i = pg_edit_n_alloc_bytes (e) - 1;
 339
 340   /* Odd low order bits?. */
 341   if (i1 != 0 && n_bits_left > 0)
 342     {
 343       u32 n = clib_min (n_bits_left, BITS (u8) - i1);
 344
 345       mask = pow2_mask (n) << i1;
 346
 347       ASSERT (i0 < vec_len (s));
 348       ASSERT (i < vec_len (v));
 349       ASSERT ((v[i] & ~mask) == 0);
 350
 351       s[i0] |= v[i] & mask;
 352       m[i0] |= mask;
 353
 354       i0--;
 355       i--;
 356       n_bits_left -= n;
 357     }
 358
 359   /* Even bytes. */
 360   while (n_bits_left >= 8)
 361     {
 362       ASSERT (i0 < vec_len (s));
 363       ASSERT (i < vec_len (v));
 364
 365       s[i0] = v[i];
 366       m[i0] = ~0;
 367
 368       i0--;
 369       i--;
 370       n_bits_left -= 8;
 371     }
 372
 373   /* Odd high order bits. */
 374   if (n_bits_left > 0)
 375     {
 376       mask = pow2_mask (n_bits_left);
 377
 378       ASSERT (i0 < vec_len (s));
 379       ASSERT (i < vec_len (v));
 380       ASSERT ((v[i] & ~mask) == 0);
 381
 382       s[i0] |= v[i] & mask;
 383       m[i0] |= mask;
 384     }
 385
 386   if (want_commit)
 387     pg_edit_free (e);
 388 }
 389
 390 void
 391 pg_edit_group_get_fixed_packet_data (pg_stream_t * s,
 392                                      u32 group_index,
 393                                      void *packet_data,
 394                                      void *packet_data_mask)
 395 {
 396   pg_edit_group_t *g = pg_stream_get_group (s, group_index);
 397   pg_edit_t *e;
 398
 399   vec_foreach (e, g->edits) do_edit (s, g, e, /* want_commit */ 0);
 400
 401   clib_memcpy_fast (packet_data, g->fixed_packet_data,
 402                     vec_len (g->fixed_packet_data));
 403   clib_memcpy_fast (packet_data_mask, g->fixed_packet_data_mask,
 404                     vec_len (g->fixed_packet_data_mask));
 405 }
 406
 407 static void
 408 perform_fixed_edits (pg_stream_t * s)
 409 {
 410   pg_edit_group_t *g;
 411   pg_edit_t *e;
 412   word i;
 413
 414   for (i = vec_len (s->edit_groups) - 1; i >= 0; i--)
 415     {
 416       g = vec_elt_at_index (s->edit_groups, i);
 417       vec_foreach (e, g->edits) do_edit (s, g, e, /* want_commit */ 1);
 418
 419       /* All edits have either been performed or added to
 420          g->non_fixed_edits.  So, we can delete the vector. */
 421       vec_free (g->edits);
 422     }
 423
 424   vec_free (s->fixed_packet_data_mask);
 425   vec_free (s->fixed_packet_data);
 426   vec_foreach (g, s->edit_groups)
 427   {
 428     int i;
 429     g->start_byte_offset = vec_len (s->fixed_packet_data);
 430
 431     /* Relocate and copy non-fixed edits from group to stream. */
 432     vec_foreach (e, g->non_fixed_edits)
 433       e->lsb_bit_offset += g->start_byte_offset * BITS (u8);
 434
 435     for (i = 0; i < vec_len (g->non_fixed_edits); i++)
 436       ASSERT (g->non_fixed_edits[i].type != PG_EDIT_INVALID_TYPE);
 437
 438     vec_add (s->non_fixed_edits,
 439              g->non_fixed_edits, vec_len (g->non_fixed_edits));
 440     vec_free (g->non_fixed_edits);
 441
 442     vec_add (s->fixed_packet_data,
 443              g->fixed_packet_data, vec_len (g->fixed_packet_data));
 444     vec_add (s->fixed_packet_data_mask,
 445              g->fixed_packet_data_mask, vec_len (g->fixed_packet_data_mask));
 446   }
 447 }
 448
 449 void
 450 pg_stream_add (pg_main_t * pg, pg_stream_t * s_init)
 451 {
 452   vlib_main_t *vm = vlib_get_main ();
 453   pg_stream_t *s;
 454   uword *p;
 455
 456   if (!pg->stream_index_by_name)
 457     pg->stream_index_by_name
 458       = hash_create_vec (0, sizeof (s->name[0]), sizeof (uword));
 459
 460   /* Delete any old stream with the same name. */
 461   if (s_init->name
 462       && (p = hash_get_mem (pg->stream_index_by_name, s_init->name)))
 463     {
 464       pg_stream_del (pg, p[0]);
 465     }
 466
 467   pool_get (pg->streams, s);
 468   s[0] = s_init[0];
 469
 470   /* Give it a name. */
 471   if (!s->name)
 472     s->name = format (0, "stream%d", s - pg->streams);
 473   else
 474     s->name = vec_dup (s->name);
 475
 476   hash_set_mem (pg->stream_index_by_name, s->name, s - pg->streams);
 477
 478   /* Get fixed part of buffer data. */
 479   if (s->edit_groups)
 480     perform_fixed_edits (s);
 481
 482   /* Determine packet size. */
 483   switch (s->packet_size_edit_type)
 484     {
 485     case PG_EDIT_INCREMENT:
 486     case PG_EDIT_RANDOM:
 487       if (s->min_packet_bytes == s->max_packet_bytes)
 488         s->packet_size_edit_type = PG_EDIT_FIXED;
 489       break;
 490
 491     default:
 492       /* Get packet size from fixed edits. */
 493       s->packet_size_edit_type = PG_EDIT_FIXED;
 494       if (!s->replay_packet_templates)
 495         s->min_packet_bytes = s->max_packet_bytes =
 496           vec_len (s->fixed_packet_data);
 497       break;
 498     }
 499
 500   s->last_increment_packet_size = s->min_packet_bytes;
 501
 502   {
 503     int n;
 504
 505     s->buffer_bytes = vlib_buffer_get_default_data_size (vm);
 506     n = s->max_packet_bytes / s->buffer_bytes;
 507     n += (s->max_packet_bytes % s->buffer_bytes) != 0;
 508
 509     vec_resize (s->buffer_indices, n);
 510   }
 511
 512   /* Find an interface to use. */
 513   s->pg_if_index =
 514     pg_interface_add_or_get (pg, s->if_id, 0 /* gso_enabled */ ,
 515                              0 /* gso_size */ , 0 /* coalesce_enabled */ );
 516
 517   if (s->sw_if_index[VLIB_RX] == ~0)
 518     {
 519       pg_interface_t *pi = pool_elt_at_index (pg->interfaces, s->pg_if_index);
 520       /*
 521        * Default the RX interface if unset. It's a bad mistake to
 522        * set [VLIB_TX] prior to ip lookup, since the ip lookup code
 523        * interprets [VLIB_TX] as a fib index...
 524        */
 525       s->sw_if_index[VLIB_RX] = pi->sw_if_index;
 526     }
 527
 528   /* Connect the graph. */
 529   s->next_index = vlib_node_add_next (vm, device_input_node.index,
 530                                       s->node_index);
 531 }
 532
 533 void
 534 pg_stream_del (pg_main_t * pg, uword index)
 535 {
 536   pg_stream_t *s;
 537   pg_buffer_index_t *bi;
 538
 539   s = pool_elt_at_index (pg->streams, index);
 540
 541   pg_stream_enable_disable (pg, s, /* want_enabled */ 0);
 542   hash_unset_mem (pg->stream_index_by_name, s->name);
 543
 544   vec_foreach (bi, s->buffer_indices)
 545   {
 546     clib_fifo_free (bi->buffer_fifo);
 547   }
 548
 549   pg_stream_free (s);
 550   pool_put (pg->streams, s);
 551 }
 552
 553 void
 554 pg_stream_change (pg_main_t * pg, pg_stream_t * s)
 555 {
 556   /* Determine packet size. */
 557   switch (s->packet_size_edit_type)
 558     {
 559     case PG_EDIT_INCREMENT:
 560     case PG_EDIT_RANDOM:
 561       if (s->min_packet_bytes == s->max_packet_bytes)
 562         s->packet_size_edit_type = PG_EDIT_FIXED;
 563     case PG_EDIT_FIXED:
 564       break;
 565
 566     default:
 567       /* Get packet size from fixed edits. */
 568       s->packet_size_edit_type = PG_EDIT_FIXED;
 569       if (!s->replay_packet_templates)
 570         s->min_packet_bytes = s->max_packet_bytes =
 571           vec_len (s->fixed_packet_data);
 572       break;
 573     }
 574
 575   s->last_increment_packet_size = s->min_packet_bytes;
 576 }
 577
 578
 579 /*
 580  * fd.io coding-style-patch-verification: ON
 581  *
 582  * Local Variables:
 583  * eval: (c-set-style "gnu")
 584  * End:
 585  */