src/vnet/tcp/tcp_test.c

   1 /*
   2  * Copyright (c) 2017 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 #include <vnet/tcp/tcp.h>
  16
  17 #define TCP_TEST_I(_cond, _comment, _args...)                   \
  18 ({                                                              \
  19   int _evald = (_cond);                                         \
  20   if (!(_evald)) {                                              \
  21     fformat(stderr, "FAIL:%d: " _comment "\n",                  \
  22             __LINE__, ##_args);                                 \
  23   } else {                                                      \
  24     fformat(stderr, "PASS:%d: " _comment "\n",                  \
  25             __LINE__, ##_args);                                 \
  26   }                                                             \
  27   _evald;                                                       \
  28 })
  29
  30 #define TCP_TEST(_cond, _comment, _args...)                     \
  31 {                                                               \
  32     if (!TCP_TEST_I(_cond, _comment, ##_args)) {                \
  33         return 1;                                               \
  34     }                                                           \
  35 }
  36
  37 static int
  38 tcp_test_sack ()
  39 {
  40   tcp_connection_t _tc, *tc = &_tc;
  41   sack_scoreboard_t *sb = &tc->sack_sb;
  42   sack_block_t *sacks = 0, block;
  43   sack_scoreboard_hole_t *hole;
  44   int i;
  45
  46   memset (tc, 0, sizeof (*tc));
  47
  48   tc->snd_una = 0;
  49   tc->snd_una_max = 1000;
  50   tc->snd_nxt = 1000;
  51   tc->opt.flags |= TCP_OPTS_FLAG_SACK;
  52   scoreboard_init (&tc->sack_sb);
  53
  54   for (i = 0; i < 1000 / 100; i++)
  55     {
  56       block.start = i * 100;
  57       block.end = (i + 1) * 100;
  58       vec_add1 (sacks, block);
  59     }
  60
  61   /*
  62    * Inject even blocks
  63    */
  64
  65   for (i = 0; i < 1000 / 200; i++)
  66     {
  67       vec_add1 (tc->opt.sacks, sacks[i * 2]);
  68     }
  69   tc->opt.n_sack_blocks = vec_len (tc->opt.sacks);
  70   tcp_rcv_sacks (tc, 0);
  71
  72   TCP_TEST ((pool_elts (sb->holes) == 5),
  73             "scoreboard has %d elements", pool_elts (sb->holes));
  74
  75   /* First SACK block should be rejected */
  76   hole = scoreboard_first_hole (sb);
  77   TCP_TEST ((hole->start == 0 && hole->end == 200),
  78             "first hole start %u end %u", hole->start, hole->end);
  79   hole = scoreboard_last_hole (sb);
  80   TCP_TEST ((hole->start == 900 && hole->end == 1000),
  81             "last hole start %u end %u", hole->start, hole->end);
  82   TCP_TEST ((sb->sacked_bytes == 400), "sacked bytes %d", sb->sacked_bytes);
  83   TCP_TEST ((sb->snd_una_adv == 0), "snd_una_adv %u", sb->snd_una_adv);
  84   TCP_TEST ((sb->last_sacked_bytes == 400),
  85             "last sacked bytes %d", sb->last_sacked_bytes);
  86
  87   /*
  88    * Inject odd blocks
  89    */
  90
  91   vec_reset_length (tc->opt.sacks);
  92   for (i = 0; i < 1000 / 200; i++)
  93     {
  94       vec_add1 (tc->opt.sacks, sacks[i * 2 + 1]);
  95     }
  96   tc->opt.n_sack_blocks = vec_len (tc->opt.sacks);
  97   tcp_rcv_sacks (tc, 0);
  98
  99   hole = scoreboard_first_hole (sb);
 100   TCP_TEST ((pool_elts (sb->holes) == 1),
 101             "scoreboard has %d holes", pool_elts (sb->holes));
 102   TCP_TEST ((hole->start == 0 && hole->end == 100),
 103             "first hole start %u end %u", hole->start, hole->end);
 104   TCP_TEST ((sb->sacked_bytes == 900), "sacked bytes %d", sb->sacked_bytes);
 105   TCP_TEST ((sb->snd_una_adv == 0), "snd_una_adv %u", sb->snd_una_adv);
 106   TCP_TEST ((sb->max_byte_sacked == 1000),
 107             "max sacked byte %u", sb->max_byte_sacked);
 108   TCP_TEST ((sb->last_sacked_bytes == 500),
 109             "last sacked bytes %d", sb->last_sacked_bytes);
 110
 111   /*
 112    *  Ack until byte 100, all bytes are now acked + sacked
 113    */
 114   tcp_rcv_sacks (tc, 100);
 115
 116   TCP_TEST ((pool_elts (sb->holes) == 0),
 117             "scoreboard has %d elements", pool_elts (sb->holes));
 118   TCP_TEST ((sb->snd_una_adv == 900),
 119             "snd_una_adv after ack %u", sb->snd_una_adv);
 120   TCP_TEST ((sb->max_byte_sacked == 1000),
 121             "max sacked byte %u", sb->max_byte_sacked);
 122   TCP_TEST ((sb->sacked_bytes == 0), "sacked bytes %d", sb->sacked_bytes);
 123   TCP_TEST ((sb->last_sacked_bytes == 0),
 124             "last sacked bytes %d", sb->last_sacked_bytes);
 125
 126   /*
 127    * Add new block
 128    */
 129
 130   vec_reset_length (tc->opt.sacks);
 131
 132   block.start = 1200;
 133   block.end = 1300;
 134   vec_add1 (tc->opt.sacks, block);
 135
 136   tc->snd_una_max = 1500;
 137   tc->snd_una = 1000;
 138   tc->snd_nxt = 1500;
 139   tcp_rcv_sacks (tc, 1000);
 140
 141   TCP_TEST ((sb->snd_una_adv == 0),
 142             "snd_una_adv after ack %u", sb->snd_una_adv);
 143   TCP_TEST ((pool_elts (sb->holes) == 2),
 144             "scoreboard has %d holes", pool_elts (sb->holes));
 145   hole = scoreboard_first_hole (sb);
 146   TCP_TEST ((hole->start == 1000 && hole->end == 1200),
 147             "first hole start %u end %u", hole->start, hole->end);
 148   hole = scoreboard_last_hole (sb);
 149   TCP_TEST ((hole->start == 1300 && hole->end == 1500),
 150             "last hole start %u end %u", hole->start, hole->end);
 151   TCP_TEST ((sb->sacked_bytes == 100), "sacked bytes %d", sb->sacked_bytes);
 152
 153   /*
 154    * Ack first hole
 155    */
 156
 157   vec_reset_length (tc->opt.sacks);
 158   tcp_rcv_sacks (tc, 1200);
 159
 160   TCP_TEST ((sb->snd_una_adv == 100),
 161             "snd_una_adv after ack %u", sb->snd_una_adv);
 162   TCP_TEST ((sb->sacked_bytes == 0), "sacked bytes %d", sb->sacked_bytes);
 163   TCP_TEST ((pool_elts (sb->holes) == 1),
 164             "scoreboard has %d elements", pool_elts (sb->holes));
 165
 166   /*
 167    * Remove all
 168    */
 169
 170   scoreboard_clear (sb);
 171   TCP_TEST ((pool_elts (sb->holes) == 0),
 172             "number of holes %d", pool_elts (sb->holes));
 173   return 0;
 174 }
 175
 176 typedef struct
 177 {
 178   u32 offset;
 179   u32 len;
 180 } test_pattern_t;
 181
 182 /* *INDENT-OFF* */
 183 test_pattern_t test_pattern[] = {
 184   {380, 8}, {768, 8}, {1156, 8}, {1544, 8}, {1932, 8}, {2320, 8}, {2708, 8},
 185   {2992, 8}, {372, 8}, {760, 8}, {1148, 8}, {1536, 8}, {1924, 8}, {2312, 8},
 186   {2700, 8}, {2984, 8}, {364, 8}, {752, 8}, {1140, 8}, {1528, 8}, {1916, 8},
 187   {2304, 8}, {2692, 8}, {2976, 8}, {356, 8}, {744, 8}, {1132, 8}, {1520, 8},
 188   {1908, 8}, {2296, 8}, {2684, 8}, {2968, 8}, {348, 8}, {736, 8}, {1124, 8},
 189   {1512, 8}, {1900, 8}, {2288, 8}, {2676, 8}, {2960, 8}, {340, 8}, {728, 8},
 190   {1116, 8}, {1504, 8}, {1892, 8}, {2280, 8}, {2668, 8}, {2952, 8}, {332, 8},
 191   {720, 8}, {1108, 8}, {1496, 8}, {1884, 8}, {2272, 8}, {2660, 8}, {2944, 8},
 192   {324, 8}, {712, 8}, {1100, 8}, {1488, 8}, {1876, 8}, {2264, 8}, {2652, 8},
 193   {2936, 8}, {316, 8}, {704, 8}, {1092, 8}, {1480, 8}, {1868, 8}, {2256, 8},
 194   {2644, 8}, {2928, 8}, {308, 8}, {696, 8}, {1084, 8}, {1472, 8}, {1860, 8},
 195   {2248, 8}, {2636, 8}, {2920, 8}, {300, 8}, {688, 8}, {1076, 8}, {1464, 8},
 196   {1852, 8}, {2240, 8}, {2628, 8}, {2912, 8}, {292, 8}, {680, 8}, {1068, 8},
 197   {1456, 8}, {1844, 8}, {2232, 8}, {2620, 8}, {2904, 8}, {284, 8}, {672, 8},
 198   {1060, 8}, {1448, 8}, {1836, 8}, {2224, 8}, {2612, 8}, {2896, 8}, {276, 8},
 199   {664, 8}, {1052, 8}, {1440, 8}, {1828, 8},  {2216, 8}, {2604, 8}, {2888, 8},
 200   {268, 8}, {656, 8}, {1044, 8}, {1432, 8}, {1820, 8}, {2208, 8}, {2596, 8},
 201   {2880, 8}, {260, 8}, {648, 8}, {1036, 8}, {1424, 8}, {1812, 8}, {2200, 8},
 202   {2588, 8}, {2872, 8}, {252, 8}, {640, 8}, {1028, 8}, {1416, 8}, {1804, 8},
 203   {2192, 8}, {2580, 8}, {2864, 8}, {244, 8}, {632, 8}, {1020, 8}, {1408, 8},
 204   {1796, 8}, {2184, 8}, {2572, 8}, {2856, 8}, {236, 8}, {624, 8}, {1012, 8},
 205   {1400, 8}, {1788, 8}, {2176, 8}, {2564, 8}, {2848, 8}, {228, 8}, {616, 8},
 206   {1004, 8}, {1392, 8}, {1780, 8}, {2168, 8}, {2556, 8}, {2840, 8}, {220, 8},
 207   {608, 8}, {996, 8}, {1384, 8}, {1772, 8}, {2160, 8}, {2548, 8}, {2832, 8},
 208   {212, 8}, {600, 8}, {988, 8}, {1376, 8}, {1764, 8}, {2152, 8}, {2540, 8},
 209   {2824, 8}, {204, 8}, {592, 8}, {980, 8}, {1368, 8}, {1756, 8}, {2144, 8},
 210   {2532, 8}, {2816, 8}, {196, 8}, {584, 8}, {972, 8}, {1360, 8}, {1748, 8},
 211   {2136, 8}, {2524, 8}, {2808, 8}, {188, 8}, {576, 8}, {964, 8}, {1352, 8},
 212   {1740, 8}, {2128, 8}, {2516, 8}, {2800, 8}, {180, 8}, {568, 8}, {956, 8},
 213   {1344, 8}, {1732, 8}, {2120, 8}, {2508, 8}, {2792, 8}, {172, 8}, {560, 8},
 214   {948, 8}, {1336, 8}, {1724, 8}, {2112, 8}, {2500, 8}, {2784, 8}, {164, 8},
 215   {552, 8}, {940, 8}, {1328, 8}, {1716, 8}, {2104, 8}, {2492, 8}, {2776, 8},
 216   {156, 8}, {544, 8}, {932, 8}, {1320, 8}, {1708, 8}, {2096, 8}, {2484, 8},
 217   {2768, 8}, {148, 8}, {536, 8}, {924, 8}, {1312, 8}, {1700, 8}, {2088, 8},
 218   {2476, 8}, {2760, 8}, {140, 8}, {528, 8}, {916, 8}, {1304, 8}, {1692, 8},
 219   {2080, 8}, {2468, 8}, {2752, 8}, {132, 8}, {520, 8}, {908, 8}, {1296, 8},
 220   {1684, 8}, {2072, 8}, {2460, 8}, {2744, 8}, {124, 8}, {512, 8}, {900, 8},
 221   {1288, 8}, {1676, 8}, {2064, 8}, {2452, 8}, {2736, 8}, {116, 8}, {504, 8},
 222   {892, 8}, {1280, 8}, {1668, 8}, {2056, 8}, {2444, 8}, {2728, 8}, {108, 8},
 223   {496, 8}, {884, 8}, {1272, 8}, {1660, 8}, {2048, 8}, {2436, 8}, {2720, 8},
 224   {100, 8}, {488, 8}, {876, 8}, {1264, 8}, {1652, 8}, {2040, 8}, {2428, 8},
 225   {2716, 4}, {92, 8}, {480, 8}, {868, 8}, {1256, 8}, {1644, 8}, {2032, 8},
 226   {2420, 8}, {84, 8}, {472, 8}, {860, 8}, {1248, 8}, {1636, 8}, {2024, 8},
 227   {2412, 8}, {76, 8}, {464, 8}, {852, 8}, {1240, 8}, {1628, 8}, {2016, 8},
 228   {2404, 8}, {68, 8}, {456, 8}, {844, 8}, {1232, 8}, {1620, 8}, {2008, 8},
 229   {2396, 8}, {60, 8}, {448, 8}, {836, 8}, {1224, 8}, {1612, 8}, {2000, 8},
 230   {2388, 8}, {52, 8}, {440, 8}, {828, 8}, {1216, 8}, {1604, 8}, {1992, 8},
 231   {2380, 8}, {44, 8}, {432, 8}, {820, 8}, {1208, 8}, {1596, 8}, {1984, 8},
 232   {2372, 8}, {36, 8}, {424, 8}, {812, 8}, {1200, 8}, {1588, 8}, {1976, 8},
 233   {2364, 8}, {28, 8}, {416, 8}, {804, 8}, {1192, 8}, {1580, 8}, {1968, 8},
 234   {2356, 8}, {20, 8}, {408, 8}, {796, 8}, {1184, 8}, {1572, 8}, {1960, 8},
 235   {2348, 8}, {12, 8}, {400, 8}, {788, 8}, {1176, 8}, {1564, 8}, {1952, 8},
 236   {2340, 8}, {4, 8}, {392, 8}, {780, 8}, {1168, 8}, {1556, 8}, {1944, 8},
 237   {2332, 8},
 238   /* missing from original data set */
 239   {388, 4}, {776, 4}, {1164, 4}, {1552, 4}, {1940, 4}, {2328, 4},
 240 };
 241 /* *INDENT-ON* */
 242
 243 int
 244 pattern_cmp (const void *arg1, const void *arg2)
 245 {
 246   test_pattern_t *a1 = (test_pattern_t *) arg1;
 247   test_pattern_t *a2 = (test_pattern_t *) arg2;
 248
 249   if (a1->offset < a2->offset)
 250     return -1;
 251   else if (a1->offset > a2->offset)
 252     return 1;
 253   return 0;
 254 }
 255
 256 static u8
 257 fifo_validate_pattern (vlib_main_t * vm, test_pattern_t * pattern,
 258                        u32 pattern_length)
 259 {
 260   test_pattern_t *tp = pattern;
 261   int i;
 262
 263   /* Go through the pattern and make 100% sure it's sane */
 264   for (i = 0; i < pattern_length - 1; i++)
 265     {
 266       if (tp->offset + tp->len != (tp + 1)->offset)
 267         {
 268           vlib_cli_output (vm, "[%d] missing {%d, %d}", i,
 269                            (tp->offset + tp->len),
 270                            (tp + 1)->offset - (tp->offset + tp->len));
 271           return 0;
 272         }
 273       tp++;
 274     }
 275   return 1;
 276 }
 277
 278 static test_pattern_t *
 279 fifo_get_validate_pattern (vlib_main_t * vm, test_pattern_t * test_data,
 280                            u32 test_data_len)
 281 {
 282   test_pattern_t *validate_pattern = 0;
 283
 284   /* Validate, and try segments in order... */
 285   vec_validate (validate_pattern, test_data_len - 1);
 286   memcpy (validate_pattern, test_data,
 287           test_data_len * sizeof (test_pattern_t));
 288   qsort ((u8 *) validate_pattern, test_data_len, sizeof (test_pattern_t),
 289          pattern_cmp);
 290
 291   if (fifo_validate_pattern (vm, validate_pattern, test_data_len) == 0)
 292     return 0;
 293
 294   return validate_pattern;
 295 }
 296
 297 static svm_fifo_t *
 298 fifo_prepare (u32 fifo_size)
 299 {
 300   svm_fifo_t *f;
 301   f = svm_fifo_create (fifo_size);
 302
 303   /* Paint fifo data vector with -1's */
 304   memset (f->data, 0xFF, fifo_size);
 305
 306   return f;
 307 }
 308
 309 static int
 310 compare_data (u8 * data1, u8 * data2, u32 start, u32 len, u32 * index)
 311 {
 312   int i;
 313
 314   for (i = start; i < len; i++)
 315     {
 316       if (data1[i] != data2[i])
 317         {
 318           *index = i;
 319           return 1;
 320         }
 321     }
 322   return 0;
 323 }
 324
 325 int
 326 tcp_test_fifo1 (vlib_main_t * vm, unformat_input_t * input)
 327 {
 328   svm_fifo_t *f;
 329   u32 fifo_size = 1 << 20;
 330   u32 *test_data = 0;
 331   u32 offset;
 332   int i, rv, verbose = 0;
 333   u32 data_word, test_data_len, j;
 334   ooo_segment_t *ooo_seg;
 335   u8 *data, *s, *data_buf = 0;
 336
 337   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 338     {
 339       if (unformat (input, "verbose"))
 340         verbose = 1;
 341     }
 342
 343   test_data_len = fifo_size / sizeof (u32);
 344   vec_validate (test_data, test_data_len - 1);
 345
 346   for (i = 0; i < vec_len (test_data); i++)
 347     test_data[i] = i;
 348
 349   f = fifo_prepare (fifo_size);
 350
 351   /*
 352    * Enqueue an initial (un-dequeued) chunk
 353    */
 354   rv = svm_fifo_enqueue_nowait (f, 0 /* pid */ ,
 355                                 sizeof (u32), (u8 *) test_data);
 356   TCP_TEST ((rv == sizeof (u32)), "enqueued %d", rv);
 357   TCP_TEST ((f->tail == 4), "fifo tail %u", f->tail);
 358
 359   /*
 360    * Create 3 chunks in the future. The offsets are relative
 361    * to the current fifo tail
 362    */
 363   for (i = 0; i < 3; i++)
 364     {
 365       offset = (2 * i + 1) * sizeof (u32);
 366       data = (u8 *) (test_data + (2 * i + 1));
 367       rv = svm_fifo_enqueue_with_offset (f, 0, offset, sizeof (u32), data);
 368       if (verbose)
 369         vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i + 1, offset,
 370                          offset + sizeof (u32));
 371       if (rv)
 372         {
 373           clib_warning ("enqueue returned %d", rv);
 374           goto err;
 375         }
 376     }
 377
 378   if (verbose)
 379     vlib_cli_output (vm, "fifo after odd segs: %U", format_svm_fifo, f, 1);
 380
 381   TCP_TEST ((f->tail == 8), "fifo tail %u", f->tail);
 382
 383   /*
 384    * Make sure format functions are not buggy
 385    */
 386   s = format (0, "%U", format_svm_fifo, f, 2);
 387   vec_free (s);
 388
 389   /*
 390    * Paint some of missing data backwards
 391    */
 392   for (i = 3; i > 1; i--)
 393     {
 394       offset = (2 * i + 0) * sizeof (u32);
 395       data = (u8 *) (test_data + (2 * i + 0));
 396       rv = svm_fifo_enqueue_with_offset (f, 0, offset, sizeof (u32), data);
 397       if (verbose)
 398         vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i, offset,
 399                          offset + sizeof (u32));
 400       if (rv)
 401         {
 402           clib_warning ("enqueue returned %d", rv);
 403           goto err;
 404         }
 405     }
 406
 407   if (verbose)
 408     vlib_cli_output (vm, "fifo before missing link: %U", format_svm_fifo, f,
 409                      1);
 410   TCP_TEST ((svm_fifo_number_ooo_segments (f) == 1),
 411             "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 412   ooo_seg = svm_fifo_first_ooo_segment (f);
 413   TCP_TEST ((ooo_seg->start == 12),
 414             "first ooo seg position %u", ooo_seg->start);
 415   TCP_TEST ((ooo_seg->length == 16),
 416             "first ooo seg length %u", ooo_seg->length);
 417
 418   /*
 419    * Enqueue the missing u32
 420    */
 421   rv = svm_fifo_enqueue_nowait (f, 0 /* pid */ , sizeof (u32),
 422                                 (u8 *) (test_data + 2));
 423   if (verbose)
 424     vlib_cli_output (vm, "fifo after missing link: %U", format_svm_fifo, f,
 425                      1);
 426   TCP_TEST ((rv == 20), "bytes to be enqueued %u", rv);
 427   TCP_TEST ((svm_fifo_number_ooo_segments (f) == 0),
 428             "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 429
 430   /*
 431    * Collect results
 432    */
 433   for (i = 0; i < 7; i++)
 434     {
 435       rv = svm_fifo_dequeue_nowait (f, 0 /* pid */ , sizeof (u32),
 436                                     (u8 *) & data_word);
 437       if (rv != sizeof (u32))
 438         {
 439           clib_warning ("bytes dequeues %u", rv);
 440           goto err;
 441         }
 442       if (data_word != test_data[i])
 443         {
 444           clib_warning ("recovered [%d] %d not %d", i, data_word,
 445                         test_data[i]);
 446           goto err;
 447         }
 448     }
 449
 450   /*
 451    * Test segment overlaps: last ooo segment overlaps all
 452    */
 453   svm_fifo_free (f);
 454   f = fifo_prepare (fifo_size);
 455
 456   for (i = 0; i < 4; i++)
 457     {
 458       offset = (2 * i + 1) * sizeof (u32);
 459       data = (u8 *) (test_data + (2 * i + 1));
 460       rv = svm_fifo_enqueue_with_offset (f, 0, offset, sizeof (u32), data);
 461       if (verbose)
 462         vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i + 1, offset,
 463                          offset + sizeof (u32));
 464       if (rv)
 465         {
 466           clib_warning ("enqueue returned %d", rv);
 467           goto err;
 468         }
 469     }
 470
 471   rv = svm_fifo_enqueue_with_offset (f, 0, 8, 21, data);
 472   TCP_TEST ((rv == 0), "ooo enqueued %u", rv);
 473   TCP_TEST ((svm_fifo_number_ooo_segments (f) == 1),
 474             "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 475
 476   vec_validate (data_buf, vec_len (data));
 477   svm_fifo_peek (f, 0, 0, vec_len (data), data_buf);
 478   if (compare_data (data_buf, data, 8, vec_len (data), &j))
 479     {
 480       TCP_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j], data[j]);
 481     }
 482   vec_reset_length (data_buf);
 483
 484   /*
 485    * Test segment overlaps: enqueue and overlap ooo segments
 486    */
 487   svm_fifo_free (f);
 488   f = fifo_prepare (fifo_size);
 489
 490   for (i = 0; i < 4; i++)
 491     {
 492       offset = (2 * i + 1) * sizeof (u32);
 493       data = (u8 *) (test_data + (2 * i + 1));
 494       rv = svm_fifo_enqueue_with_offset (f, 0, offset, sizeof (u32), data);
 495       if (verbose)
 496         vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i + 1, offset,
 497                          offset + sizeof (u32));
 498       if (rv)
 499         {
 500           clib_warning ("enqueue returned %d", rv);
 501           goto err;
 502         }
 503     }
 504
 505   rv = svm_fifo_enqueue_nowait (f, 0, 29, data);
 506   TCP_TEST ((rv == 32), "ooo enqueued %u", rv);
 507   TCP_TEST ((svm_fifo_number_ooo_segments (f) == 0),
 508             "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 509
 510   vec_validate (data_buf, vec_len (data));
 511   svm_fifo_peek (f, 0, 0, vec_len (data), data_buf);
 512   if (compare_data (data_buf, data, 0, vec_len (data), &j))
 513     {
 514       TCP_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j], data[j]);
 515     }
 516
 517   vec_free (data_buf);
 518   svm_fifo_free (f);
 519   vec_free (test_data);
 520
 521   return 0;
 522
 523 err:
 524   svm_fifo_free (f);
 525   vec_free (test_data);
 526   return -1;
 527 }
 528
 529 static int
 530 tcp_test_fifo2 (vlib_main_t * vm)
 531 {
 532   svm_fifo_t *f;
 533   u32 fifo_size = 1 << 20;
 534   int i, rv, test_data_len;
 535   u64 data64;
 536   test_pattern_t *tp, *vp, *test_data;
 537   ooo_segment_t *ooo_seg;
 538
 539   test_data = test_pattern;
 540   test_data_len = ARRAY_LEN (test_pattern);
 541
 542   vp = fifo_get_validate_pattern (vm, test_data, test_data_len);
 543
 544   /* Create a fifo */
 545   f = fifo_prepare (fifo_size);
 546
 547   /*
 548    * Try with sorted data
 549    */
 550   for (i = 0; i < test_data_len; i++)
 551     {
 552       tp = vp + i;
 553       data64 = tp->offset;
 554       rv = svm_fifo_enqueue_with_offset (f, 0, tp->offset, tp->len,
 555                                          (u8 *) & data64);
 556     }
 557
 558   /* Expected result: one big fat chunk at offset 4 */
 559   TCP_TEST ((svm_fifo_number_ooo_segments (f) == 1),
 560             "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 561   ooo_seg = svm_fifo_first_ooo_segment (f);
 562   TCP_TEST ((ooo_seg->start == 4),
 563             "first ooo seg position %u", ooo_seg->start);
 564   TCP_TEST ((ooo_seg->length == 2996),
 565             "first ooo seg length %u", ooo_seg->length);
 566
 567   data64 = 0;
 568   rv = svm_fifo_enqueue_nowait (f, 0, sizeof (u32), (u8 *) & data64);
 569   TCP_TEST ((rv == 3000), "bytes to be enqueued %u", rv);
 570
 571   svm_fifo_free (f);
 572   vec_free (vp);
 573
 574   /*
 575    * Now try it again w/ unsorted data...
 576    */
 577
 578   f = fifo_prepare (fifo_size);
 579
 580   for (i = 0; i < test_data_len; i++)
 581     {
 582       tp = &test_data[i];
 583       data64 = tp->offset;
 584       rv = svm_fifo_enqueue_with_offset (f, 0, tp->offset, tp->len,
 585                                          (u8 *) & data64);
 586       if (rv)
 587         {
 588           clib_warning ("enqueue returned %d", rv);
 589         }
 590     }
 591
 592   /* Expecting the same result: one big fat chunk at offset 4 */
 593   TCP_TEST ((svm_fifo_number_ooo_segments (f) == 1),
 594             "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 595   ooo_seg = svm_fifo_first_ooo_segment (f);
 596   TCP_TEST ((ooo_seg->start == 4),
 597             "first ooo seg position %u", ooo_seg->start);
 598   TCP_TEST ((ooo_seg->length == 2996),
 599             "first ooo seg length %u", ooo_seg->length);
 600
 601   data64 = 0;
 602   rv = svm_fifo_enqueue_nowait (f, 0, sizeof (u32), (u8 *) & data64);
 603
 604   TCP_TEST ((rv == 3000), "bytes to be enqueued %u", rv);
 605
 606   svm_fifo_free (f);
 607
 608   return 0;
 609 }
 610
 611 static int
 612 tcp_test_fifo3 (vlib_main_t * vm, unformat_input_t * input)
 613 {
 614   svm_fifo_t *f;
 615   u32 fifo_size = 4 << 10;
 616   u32 fifo_initial_offset = 0;
 617   u32 total_size = 2 << 10;
 618   int overlap = 0, verbose = 0, randomize = 1, drop = 0, in_seq_all = 0;
 619   u8 *data_pattern = 0, *data_buf = 0;
 620   test_pattern_t *tp, *generate = 0;
 621   u32 nsegs = 2, seg_size, length_so_far;
 622   u32 current_offset, offset_increment, len_this_chunk;
 623   u32 seed = 0xdeaddabe, j;
 624   int i, rv;
 625
 626   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 627     {
 628       if (unformat (input, "fifo-size %d", &fifo_size))
 629         ;
 630       else if (unformat (input, "total-size %d", &total_size))
 631         ;
 632       else if (unformat (input, "verbose"))
 633         verbose = 1;
 634       else if (unformat (input, "overlap"))
 635         overlap = 1;
 636       else if (unformat (input, "initial-offset %d", &fifo_initial_offset))
 637         ;
 638       else if (unformat (input, "seed %d", &seed))
 639         ;
 640       else if (unformat (input, "nsegs %d", &nsegs))
 641         ;
 642       else if (unformat (input, "no-randomize"))
 643         randomize = 0;
 644       else if (unformat (input, "in-seq-all"))
 645         in_seq_all = 1;
 646       else if (unformat (input, "drop"))
 647         drop = 1;
 648       else
 649         {
 650           clib_error_t *e = clib_error_return
 651             (0, "unknown input `%U'", format_unformat_error, input);
 652           clib_error_report (e);
 653           return -1;
 654         }
 655     }
 656
 657   if (total_size > fifo_size)
 658     {
 659       clib_warning ("total_size %d greater than fifo size %d", total_size,
 660                     fifo_size);
 661       return -1;
 662     }
 663   if (overlap && randomize == 0)
 664     {
 665       clib_warning ("Can't enqueue in-order with overlap");
 666       return -1;
 667     }
 668
 669   /*
 670    * Generate data
 671    */
 672   vec_validate (data_pattern, total_size - 1);
 673   for (i = 0; i < vec_len (data_pattern); i++)
 674     data_pattern[i] = i & 0xff;
 675
 676   /*
 677    * Generate segments
 678    */
 679   seg_size = total_size / nsegs;
 680   length_so_far = 0;
 681   current_offset = randomize;
 682   while (length_so_far < total_size)
 683     {
 684       vec_add2 (generate, tp, 1);
 685       len_this_chunk = clib_min (seg_size, total_size - length_so_far);
 686       tp->offset = current_offset;
 687       tp->len = len_this_chunk;
 688
 689       if (overlap && (len_this_chunk == seg_size))
 690         do
 691           {
 692             offset_increment = len_this_chunk
 693               % (1 + (random_u32 (&seed) % len_this_chunk));
 694           }
 695         while (offset_increment == 0);
 696       else
 697         offset_increment = len_this_chunk;
 698
 699       current_offset += offset_increment;
 700       length_so_far = tp->offset + tp->len;
 701     }
 702
 703   /*
 704    * Validate segment list. Only valid for non-overlap cases.
 705    */
 706   if (overlap == 0)
 707     fifo_validate_pattern (vm, generate, vec_len (generate));
 708
 709   if (verbose)
 710     {
 711       vlib_cli_output (vm, "raw data pattern:");
 712       for (i = 0; i < vec_len (generate); i++)
 713         {
 714           vlib_cli_output (vm, "[%d] offset %u len %u", i,
 715                            generate[i].offset, generate[i].len);
 716         }
 717     }
 718
 719   /* Randomize data pattern */
 720   if (randomize)
 721     {
 722       for (i = 0; i < vec_len (generate) / 2; i++)
 723         {
 724           u32 src_index, dst_index;
 725           test_pattern_t _tmp, *tmp = &_tmp;
 726
 727           src_index = random_u32 (&seed) % vec_len (generate);
 728           dst_index = random_u32 (&seed) % vec_len (generate);
 729
 730           tmp[0] = generate[dst_index];
 731           generate[dst_index] = generate[src_index];
 732           generate[src_index] = tmp[0];
 733         }
 734       if (verbose)
 735         {
 736           vlib_cli_output (vm, "randomized data pattern:");
 737           for (i = 0; i < vec_len (generate); i++)
 738             {
 739               vlib_cli_output (vm, "[%d] offset %u len %u", i,
 740                                generate[i].offset, generate[i].len);
 741             }
 742         }
 743     }
 744
 745   /*
 746    * Create a fifo and add segments
 747    */
 748   f = fifo_prepare (fifo_size);
 749
 750   /* manually set head and tail pointers to validate modular arithmetic */
 751   fifo_initial_offset = fifo_initial_offset % fifo_size;
 752   f->head = fifo_initial_offset;
 753   f->tail = fifo_initial_offset;
 754
 755   for (i = 0; i < vec_len (generate); i++)
 756     {
 757       tp = generate + i;
 758       rv = svm_fifo_enqueue_with_offset (f, 0, fifo_initial_offset
 759                                          + tp->offset, tp->len,
 760                                          (u8 *) data_pattern + tp->offset);
 761     }
 762
 763   /*
 764    * Expected result: one big fat chunk at offset 1 if randomize == 1
 765    */
 766
 767   if (verbose)
 768     vlib_cli_output (vm, "fifo before missing link: %U",
 769                      format_svm_fifo, f, 1 /* verbose */ );
 770
 771   /*
 772    * Add the missing byte if segments were randomized
 773    */
 774   if (randomize)
 775     {
 776       u32 bytes_to_enq = 1;
 777       if (in_seq_all)
 778         bytes_to_enq = total_size;
 779       rv = svm_fifo_enqueue_nowait (f, 0, bytes_to_enq, data_pattern + 0);
 780
 781       if (verbose)
 782         vlib_cli_output (vm, "in-order enqueue returned %d", rv);
 783
 784       TCP_TEST ((rv == total_size), "enqueued %u expected %u", rv,
 785                 total_size);
 786
 787     }
 788
 789   TCP_TEST ((svm_fifo_has_ooo_data (f) == 0), "number of ooo segments %u",
 790             svm_fifo_number_ooo_segments (f));
 791
 792   /*
 793    * Test if peeked data is the same as original data
 794    */
 795   vec_validate (data_buf, vec_len (data_pattern));
 796   svm_fifo_peek (f, 0, 0, vec_len (data_pattern), data_buf);
 797   if (compare_data (data_buf, data_pattern, 0, vec_len (data_pattern), &j))
 798     {
 799       TCP_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j],
 800                 data_pattern[j]);
 801     }
 802   vec_reset_length (data_buf);
 803
 804   /*
 805    * Dequeue or drop all data
 806    */
 807   if (drop)
 808     {
 809       svm_fifo_dequeue_drop (f, 0, vec_len (data_pattern));
 810     }
 811   else
 812     {
 813       svm_fifo_dequeue_nowait (f, 0, vec_len (data_pattern), data_buf);
 814       if (compare_data
 815           (data_buf, data_pattern, 0, vec_len (data_pattern), &j))
 816         {
 817           TCP_TEST (0, "[%d] dequeued %u expected %u", j, data_buf[j],
 818                     data_pattern[j]);
 819         }
 820     }
 821
 822   TCP_TEST ((svm_fifo_max_dequeue (f) == 0), "fifo has %d bytes",
 823             svm_fifo_max_dequeue (f));
 824
 825   svm_fifo_free (f);
 826   vec_free (data_pattern);
 827   vec_free (data_buf);
 828
 829   return 0;
 830 }
 831
 832 static int
 833 tcp_test_fifo (vlib_main_t * vm, unformat_input_t * input)
 834 {
 835   int res = 0;
 836   char *str;
 837
 838   /* Run all tests */
 839   if (unformat_check_input (input) == UNFORMAT_END_OF_INPUT)
 840     {
 841       res = tcp_test_fifo1 (vm, input);
 842       if (res)
 843         return res;
 844
 845       res = tcp_test_fifo2 (vm);
 846       if (res)
 847         return res;
 848
 849       /*
 850        * Run a number of fifo3 configs
 851        */
 852       str = "nsegs 10 overlap seed 123";
 853       unformat_init_cstring (input, str);
 854       if (tcp_test_fifo3 (vm, input))
 855         return -1;
 856       unformat_free (input);
 857
 858       str = "nsegs 10 overlap seed 123 in-seq-all";
 859       unformat_init_cstring (input, str);
 860       if (tcp_test_fifo3 (vm, input))
 861         return -1;
 862       unformat_free (input);
 863
 864       str = "nsegs 10 overlap seed 123 initial-offset 3917";
 865       unformat_init_cstring (input, str);
 866       if (tcp_test_fifo3 (vm, input))
 867         return -1;
 868       unformat_free (input);
 869
 870       str = "nsegs 10 overlap seed 123 initial-offset 3917 drop";
 871       unformat_init_cstring (input, str);
 872       if (tcp_test_fifo3 (vm, input))
 873         return -1;
 874       unformat_free (input);
 875
 876       str = "nsegs 10 seed 123 initial-offset 3917 drop no-randomize";
 877       unformat_init_cstring (input, str);
 878       if (tcp_test_fifo3 (vm, input))
 879         return -1;
 880       unformat_free (input);
 881     }
 882   else
 883     {
 884       if (unformat (input, "fifo3"))
 885         {
 886           res = tcp_test_fifo3 (vm, input);
 887         }
 888       else if (unformat (input, "fifo2"))
 889         {
 890           res = tcp_test_fifo2 (vm);
 891         }
 892       else if (unformat (input, "fifo1"))
 893         {
 894           res = tcp_test_fifo1 (vm, input);
 895         }
 896     }
 897
 898   return res;
 899 }
 900
 901 static clib_error_t *
 902 tcp_test (vlib_main_t * vm,
 903           unformat_input_t * input, vlib_cli_command_t * cmd_arg)
 904 {
 905   int res = 0;
 906
 907   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 908     {
 909       if (unformat (input, "sack"))
 910         {
 911           res = tcp_test_sack ();
 912         }
 913       else if (unformat (input, "fifo"))
 914         {
 915           res = tcp_test_fifo (vm, input);
 916         }
 917       else
 918         {
 919           return clib_error_return (0, "unknown input `%U'",
 920                                     format_unformat_error, input);
 921         }
 922     }
 923
 924   if (res)
 925     {
 926       return clib_error_return (0, "TCP unit test failed");
 927     }
 928   else
 929     {
 930       return 0;
 931     }
 932 }
 933
 934 /* *INDENT-OFF* */
 935 VLIB_CLI_COMMAND (tcp_test_command, static) =
 936 {
 937   .path = "test tcp",
 938   .short_help = "internal tcp unit tests",
 939   .function = tcp_test,
 940 };
 941 /* *INDENT-ON* */
 942
 943
 944 /*
 945  * fd.io coding-style-patch-verification: ON
 946  *
 947  * Local Variables:
 948  * eval: (c-set-style "gnu")
 949  * End:
 950  */