src/plugins/unittest/svm_fifo_test.c

   1 /*
   2  * Copyright (c) 2019 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 <svm/svm_fifo.h>
  16 #include <vlib/vlib.h>
  17 #include <svm/fifo_segment.h>
  18
  19 #define SFIFO_TEST_I(_cond, _comment, _args...)                 \
  20 ({                                                              \
  21   int _evald = (_cond);                                         \
  22   if (!(_evald)) {                                              \
  23     fformat(stderr, "FAIL:%d: " _comment "\n",                  \
  24             __LINE__, ##_args);                                 \
  25   } else {                                                      \
  26     fformat(stderr, "PASS:%d: " _comment "\n",                  \
  27             __LINE__, ##_args);                                 \
  28   }                                                             \
  29   _evald;                                                       \
  30 })
  31
  32 #define SFIFO_TEST(_cond, _comment, _args...)                   \
  33 {                                                               \
  34     if (!SFIFO_TEST_I(_cond, _comment, ##_args)) {              \
  35         return 1;                                               \
  36     }                                                           \
  37 }
  38
  39 typedef struct
  40 {
  41   u32 offset;
  42   u32 len;
  43 } test_pattern_t;
  44
  45 /* *INDENT-OFF* */
  46 test_pattern_t test_pattern[] = {
  47   {380, 8}, {768, 8}, {1156, 8}, {1544, 8}, {1932, 8}, {2320, 8}, {2708, 8},
  48   {2992, 8}, {372, 8}, {760, 8}, {1148, 8}, {1536, 8}, {1924, 8}, {2312, 8},
  49   {2700, 8}, {2984, 8}, {364, 8}, {752, 8}, {1140, 8}, {1528, 8}, {1916, 8},
  50   {2304, 8}, {2692, 8}, {2976, 8}, {356, 8}, {744, 8}, {1132, 8}, {1520, 8},
  51   {1908, 8}, {2296, 8}, {2684, 8}, {2968, 8}, {348, 8}, {736, 8}, {1124, 8},
  52   {1512, 8}, {1900, 8}, {2288, 8}, {2676, 8}, {2960, 8}, {340, 8}, {728, 8},
  53   {1116, 8}, {1504, 8}, {1892, 8}, {2280, 8}, {2668, 8}, {2952, 8}, {332, 8},
  54   {720, 8}, {1108, 8}, {1496, 8}, {1884, 8}, {2272, 8}, {2660, 8}, {2944, 8},
  55   {324, 8}, {712, 8}, {1100, 8}, {1488, 8}, {1876, 8}, {2264, 8}, {2652, 8},
  56   {2936, 8}, {316, 8}, {704, 8}, {1092, 8}, {1480, 8}, {1868, 8}, {2256, 8},
  57   {2644, 8}, {2928, 8}, {308, 8}, {696, 8}, {1084, 8}, {1472, 8}, {1860, 8},
  58   {2248, 8}, {2636, 8}, {2920, 8}, {300, 8}, {688, 8}, {1076, 8}, {1464, 8},
  59   {1852, 8}, {2240, 8}, {2628, 8}, {2912, 8}, {292, 8}, {680, 8}, {1068, 8},
  60   {1456, 8}, {1844, 8}, {2232, 8}, {2620, 8}, {2904, 8}, {284, 8}, {672, 8},
  61   {1060, 8}, {1448, 8}, {1836, 8}, {2224, 8}, {2612, 8}, {2896, 8}, {276, 8},
  62   {664, 8}, {1052, 8}, {1440, 8}, {1828, 8},  {2216, 8}, {2604, 8}, {2888, 8},
  63   {268, 8}, {656, 8}, {1044, 8}, {1432, 8}, {1820, 8}, {2208, 8}, {2596, 8},
  64   {2880, 8}, {260, 8}, {648, 8}, {1036, 8}, {1424, 8}, {1812, 8}, {2200, 8},
  65   {2588, 8}, {2872, 8}, {252, 8}, {640, 8}, {1028, 8}, {1416, 8}, {1804, 8},
  66   {2192, 8}, {2580, 8}, {2864, 8}, {244, 8}, {632, 8}, {1020, 8}, {1408, 8},
  67   {1796, 8}, {2184, 8}, {2572, 8}, {2856, 8}, {236, 8}, {624, 8}, {1012, 8},
  68   {1400, 8}, {1788, 8}, {2176, 8}, {2564, 8}, {2848, 8}, {228, 8}, {616, 8},
  69   {1004, 8}, {1392, 8}, {1780, 8}, {2168, 8}, {2556, 8}, {2840, 8}, {220, 8},
  70   {608, 8}, {996, 8}, {1384, 8}, {1772, 8}, {2160, 8}, {2548, 8}, {2832, 8},
  71   {212, 8}, {600, 8}, {988, 8}, {1376, 8}, {1764, 8}, {2152, 8}, {2540, 8},
  72   {2824, 8}, {204, 8}, {592, 8}, {980, 8}, {1368, 8}, {1756, 8}, {2144, 8},
  73   {2532, 8}, {2816, 8}, {196, 8}, {584, 8}, {972, 8}, {1360, 8}, {1748, 8},
  74   {2136, 8}, {2524, 8}, {2808, 8}, {188, 8}, {576, 8}, {964, 8}, {1352, 8},
  75   {1740, 8}, {2128, 8}, {2516, 8}, {2800, 8}, {180, 8}, {568, 8}, {956, 8},
  76   {1344, 8}, {1732, 8}, {2120, 8}, {2508, 8}, {2792, 8}, {172, 8}, {560, 8},
  77   {948, 8}, {1336, 8}, {1724, 8}, {2112, 8}, {2500, 8}, {2784, 8}, {164, 8},
  78   {552, 8}, {940, 8}, {1328, 8}, {1716, 8}, {2104, 8}, {2492, 8}, {2776, 8},
  79   {156, 8}, {544, 8}, {932, 8}, {1320, 8}, {1708, 8}, {2096, 8}, {2484, 8},
  80   {2768, 8}, {148, 8}, {536, 8}, {924, 8}, {1312, 8}, {1700, 8}, {2088, 8},
  81   {2476, 8}, {2760, 8}, {140, 8}, {528, 8}, {916, 8}, {1304, 8}, {1692, 8},
  82   {2080, 8}, {2468, 8}, {2752, 8}, {132, 8}, {520, 8}, {908, 8}, {1296, 8},
  83   {1684, 8}, {2072, 8}, {2460, 8}, {2744, 8}, {124, 8}, {512, 8}, {900, 8},
  84   {1288, 8}, {1676, 8}, {2064, 8}, {2452, 8}, {2736, 8}, {116, 8}, {504, 8},
  85   {892, 8}, {1280, 8}, {1668, 8}, {2056, 8}, {2444, 8}, {2728, 8}, {108, 8},
  86   {496, 8}, {884, 8}, {1272, 8}, {1660, 8}, {2048, 8}, {2436, 8}, {2720, 8},
  87   {100, 8}, {488, 8}, {876, 8}, {1264, 8}, {1652, 8}, {2040, 8}, {2428, 8},
  88   {2716, 4}, {92, 8}, {480, 8}, {868, 8}, {1256, 8}, {1644, 8}, {2032, 8},
  89   {2420, 8}, {84, 8}, {472, 8}, {860, 8}, {1248, 8}, {1636, 8}, {2024, 8},
  90   {2412, 8}, {76, 8}, {464, 8}, {852, 8}, {1240, 8}, {1628, 8}, {2016, 8},
  91   {2404, 8}, {68, 8}, {456, 8}, {844, 8}, {1232, 8}, {1620, 8}, {2008, 8},
  92   {2396, 8}, {60, 8}, {448, 8}, {836, 8}, {1224, 8}, {1612, 8}, {2000, 8},
  93   {2388, 8}, {52, 8}, {440, 8}, {828, 8}, {1216, 8}, {1604, 8}, {1992, 8},
  94   {2380, 8}, {44, 8}, {432, 8}, {820, 8}, {1208, 8}, {1596, 8}, {1984, 8},
  95   {2372, 8}, {36, 8}, {424, 8}, {812, 8}, {1200, 8}, {1588, 8}, {1976, 8},
  96   {2364, 8}, {28, 8}, {416, 8}, {804, 8}, {1192, 8}, {1580, 8}, {1968, 8},
  97   {2356, 8}, {20, 8}, {408, 8}, {796, 8}, {1184, 8}, {1572, 8}, {1960, 8},
  98   {2348, 8}, {12, 8}, {400, 8}, {788, 8}, {1176, 8}, {1564, 8}, {1952, 8},
  99   {2340, 8}, {4, 8}, {392, 8}, {780, 8}, {1168, 8}, {1556, 8}, {1944, 8},
 100   {2332, 8},
 101   /* missing from original data set */
 102   {388, 4}, {776, 4}, {1164, 4}, {1552, 4}, {1940, 4}, {2328, 4},
 103 };
 104 /* *INDENT-ON* */
 105
 106 int
 107 pattern_cmp (const void *arg1, const void *arg2)
 108 {
 109   test_pattern_t *a1 = (test_pattern_t *) arg1;
 110   test_pattern_t *a2 = (test_pattern_t *) arg2;
 111
 112   if (a1->offset < a2->offset)
 113     return -1;
 114   else if (a1->offset > a2->offset)
 115     return 1;
 116   return 0;
 117 }
 118
 119 static u8
 120 fifo_validate_pattern (vlib_main_t * vm, test_pattern_t * pattern,
 121                        u32 pattern_length)
 122 {
 123   test_pattern_t *tp = pattern;
 124   int i;
 125
 126   /* Go through the pattern and make 100% sure it's sane */
 127   for (i = 0; i < pattern_length - 1; i++)
 128     {
 129       if (tp->offset + tp->len != (tp + 1)->offset)
 130         {
 131           vlib_cli_output (vm, "[%d] missing {%d, %d}", i,
 132                            (tp->offset + tp->len),
 133                            (tp + 1)->offset - (tp->offset + tp->len));
 134           return 0;
 135         }
 136       tp++;
 137     }
 138   return 1;
 139 }
 140
 141 static test_pattern_t *
 142 fifo_get_validate_pattern (vlib_main_t * vm, test_pattern_t * test_data,
 143                            u32 test_data_len)
 144 {
 145   test_pattern_t *validate_pattern = 0;
 146
 147   /* Validate, and try segments in order... */
 148   vec_validate (validate_pattern, test_data_len - 1);
 149   memcpy (validate_pattern, test_data,
 150           test_data_len * sizeof (test_pattern_t));
 151   qsort ((u8 *) validate_pattern, test_data_len, sizeof (test_pattern_t),
 152          pattern_cmp);
 153
 154   if (fifo_validate_pattern (vm, validate_pattern, test_data_len) == 0)
 155     return 0;
 156
 157   return validate_pattern;
 158 }
 159
 160 static svm_fifo_t *
 161 fifo_prepare (u32 fifo_size)
 162 {
 163   svm_fifo_t *f;
 164   f = svm_fifo_create (fifo_size);
 165
 166   /* Paint fifo data vector with -1's */
 167   clib_memset (f->head_chunk->data, 0xFF, fifo_size);
 168
 169   return f;
 170 }
 171
 172 static int
 173 compare_data (u8 * data1, u8 * data2, u32 start, u32 len, u32 * index)
 174 {
 175   int i;
 176
 177   for (i = start; i < len; i++)
 178     {
 179       if (data1[i] != data2[i])
 180         {
 181           *index = i;
 182           return 1;
 183         }
 184     }
 185   return 0;
 186 }
 187
 188 int
 189 sfifo_test_fifo1 (vlib_main_t * vm, unformat_input_t * input)
 190 {
 191   svm_fifo_t *f;
 192   u32 fifo_size = 1 << 20;
 193   u32 *test_data = 0;
 194   u32 offset;
 195   int i, rv, verbose = 0;
 196   u32 data_word, test_data_len, j;
 197   ooo_segment_t *ooo_seg;
 198   u8 *data, *s, *data_buf = 0;
 199
 200   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 201     {
 202       if (unformat (input, "verbose"))
 203         verbose = 1;
 204     }
 205
 206   test_data_len = fifo_size / sizeof (u32);
 207   vec_validate (test_data, test_data_len - 1);
 208
 209   for (i = 0; i < vec_len (test_data); i++)
 210     test_data[i] = i;
 211
 212   f = fifo_prepare (fifo_size);
 213
 214   /*
 215    * Enqueue an initial (un-dequeued) chunk
 216    */
 217   rv = svm_fifo_enqueue_nowait (f, sizeof (u32), (u8 *) test_data);
 218   SFIFO_TEST ((rv == sizeof (u32)), "enqueued %d", rv);
 219   SFIFO_TEST ((f->tail == 4), "fifo tail %u", f->tail);
 220
 221   /*
 222    * Create 3 chunks in the future. The offsets are relative
 223    * to the current fifo tail
 224    */
 225   for (i = 0; i < 3; i++)
 226     {
 227       offset = (2 * i + 1) * sizeof (u32) - f->tail;
 228       data = (u8 *) (test_data + (2 * i + 1));
 229       if (i == 0)
 230         {
 231           rv = svm_fifo_enqueue_nowait (f, sizeof (u32), data);
 232           rv = rv > 0 ? 0 : rv;
 233         }
 234       else
 235         rv = svm_fifo_enqueue_with_offset (f, offset, sizeof (u32), data);
 236       if (verbose)
 237         vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i + 1, offset,
 238                          offset + sizeof (u32));
 239       if (rv)
 240         {
 241           clib_warning ("enqueue returned %d", rv);
 242           goto err;
 243         }
 244     }
 245
 246   if (verbose)
 247     vlib_cli_output (vm, "fifo after odd segs: %U", format_svm_fifo, f, 1);
 248
 249   SFIFO_TEST ((f->tail == 8), "fifo tail %u", f->tail);
 250   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 2),
 251               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 252
 253   /*
 254    * Try adding a completely overlapped segment
 255    */
 256   offset = 3 * sizeof (u32) - f->tail;
 257   data = (u8 *) (test_data + 3);
 258   rv = svm_fifo_enqueue_with_offset (f, offset, sizeof (u32), data);
 259   if (rv)
 260     {
 261       clib_warning ("enqueue returned %d", rv);
 262       goto err;
 263     }
 264
 265   if (verbose)
 266     vlib_cli_output (vm, "fifo after overlap seg: %U", format_svm_fifo, f, 1);
 267
 268   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 2),
 269               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 270
 271   /*
 272    * Make sure format functions are not buggy
 273    */
 274   s = format (0, "%U", format_svm_fifo, f, 2);
 275   vec_free (s);
 276
 277   /*
 278    * Paint some of missing data backwards
 279    */
 280   for (i = 3; i > 1; i--)
 281     {
 282       offset = (2 * i + 0) * sizeof (u32) - f->tail;
 283       data = (u8 *) (test_data + (2 * i + 0));
 284       rv = svm_fifo_enqueue_with_offset (f, offset, sizeof (u32), data);
 285       if (verbose)
 286         vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i, offset,
 287                          offset + sizeof (u32));
 288       if (rv)
 289         {
 290           clib_warning ("enqueue returned %d", rv);
 291           goto err;
 292         }
 293     }
 294
 295   if (verbose)
 296     vlib_cli_output (vm, "fifo before missing link: %U", format_svm_fifo, f,
 297                      1);
 298   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 1),
 299               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 300   ooo_seg = svm_fifo_first_ooo_segment (f);
 301   SFIFO_TEST ((ooo_seg->start == 12),
 302               "first ooo seg position %u", ooo_seg->start);
 303   SFIFO_TEST ((ooo_seg->length == 16),
 304               "first ooo seg length %u", ooo_seg->length);
 305
 306   /*
 307    * Enqueue the missing u32
 308    */
 309   rv = svm_fifo_enqueue_nowait (f, sizeof (u32), (u8 *) (test_data + 2));
 310   if (verbose)
 311     vlib_cli_output (vm, "fifo after missing link: %U", format_svm_fifo, f,
 312                      1);
 313   SFIFO_TEST ((rv == 20), "bytes to be enqueued %u", rv);
 314   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 0),
 315               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 316
 317   /*
 318    * Collect results
 319    */
 320   for (i = 0; i < 7; i++)
 321     {
 322       rv = svm_fifo_dequeue_nowait (f, sizeof (u32), (u8 *) & data_word);
 323       if (rv != sizeof (u32))
 324         {
 325           clib_warning ("bytes dequeues %u", rv);
 326           goto err;
 327         }
 328       if (data_word != test_data[i])
 329         {
 330           clib_warning ("recovered [%d] %d not %d", i, data_word,
 331                         test_data[i]);
 332           goto err;
 333         }
 334     }
 335
 336   /*
 337    * Test segment overlaps: last ooo segment overlaps all
 338    */
 339   svm_fifo_free (f);
 340   f = fifo_prepare (fifo_size);
 341
 342   for (i = 0; i < 4; i++)
 343     {
 344       offset = (2 * i + 1) * sizeof (u32) - f->tail;
 345       data = (u8 *) (test_data + (2 * i + 1));
 346       rv = svm_fifo_enqueue_with_offset (f, offset, sizeof (u32), data);
 347       if (verbose)
 348         vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i + 1, offset,
 349                          offset + sizeof (u32));
 350       if (rv)
 351         {
 352           clib_warning ("enqueue returned %d", rv);
 353           goto err;
 354         }
 355     }
 356
 357   rv = svm_fifo_enqueue_with_offset (f, 8 - f->tail, 21, data);
 358   SFIFO_TEST ((rv == 0), "ooo enqueued %u", rv);
 359   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 1),
 360               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 361
 362   vec_validate (data_buf, vec_len (data));
 363   svm_fifo_peek (f, 0, vec_len (data), data_buf);
 364   if (compare_data (data_buf, data, 8, vec_len (data), &j))
 365     {
 366       SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j], data[j]);
 367     }
 368   vec_reset_length (data_buf);
 369
 370   /*
 371    * Test segment overlaps: enqueue and overlap ooo segments
 372    */
 373   svm_fifo_free (f);
 374   f = fifo_prepare (fifo_size);
 375
 376   for (i = 0; i < 4; i++)
 377     {
 378       offset = (2 * i + 1) * sizeof (u32) - f->tail;
 379       data = (u8 *) (test_data + (2 * i + 1));
 380       rv = svm_fifo_enqueue_with_offset (f, offset, sizeof (u32), data);
 381       if (verbose)
 382         vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i + 1, offset,
 383                          offset + sizeof (u32));
 384       if (rv)
 385         {
 386           clib_warning ("enqueue returned %d", rv);
 387           goto err;
 388         }
 389     }
 390
 391   if (verbose)
 392     vlib_cli_output (vm, "fifo after enqueue: %U", format_svm_fifo, f, 1);
 393
 394   rv = svm_fifo_enqueue_nowait (f, 29, data);
 395   if (verbose)
 396     vlib_cli_output (vm, "fifo after enqueueing 29: %U", format_svm_fifo, f,
 397                      1);
 398   SFIFO_TEST ((rv == 32), "ooo enqueued %u", rv);
 399   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 0),
 400               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 401
 402   vec_validate (data_buf, vec_len (data));
 403   svm_fifo_peek (f, 0, vec_len (data), data_buf);
 404   if (compare_data (data_buf, data, 0, vec_len (data), &j))
 405     {
 406       SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j], data[j]);
 407     }
 408
 409   /* Try to peek beyond the data */
 410   rv = svm_fifo_peek (f, svm_fifo_max_dequeue (f), vec_len (data), data_buf);
 411   SFIFO_TEST ((rv == 0), "peeked %u expected 0", rv);
 412
 413   vec_free (data_buf);
 414   svm_fifo_free (f);
 415   vec_free (test_data);
 416
 417   return 0;
 418
 419 err:
 420   svm_fifo_free (f);
 421   vec_free (test_data);
 422   return -1;
 423 }
 424
 425 static int
 426 sfifo_test_fifo2 (vlib_main_t * vm)
 427 {
 428   svm_fifo_t *f;
 429   u32 fifo_size = 1 << 20;
 430   int i, rv, test_data_len;
 431   u64 data64;
 432   test_pattern_t *tp, *vp, *test_data;
 433   ooo_segment_t *ooo_seg;
 434
 435   test_data = test_pattern;
 436   test_data_len = ARRAY_LEN (test_pattern);
 437
 438   vp = fifo_get_validate_pattern (vm, test_data, test_data_len);
 439
 440   /* Create a fifo */
 441   f = fifo_prepare (fifo_size);
 442
 443   /*
 444    * Try with sorted data
 445    */
 446   for (i = 0; i < test_data_len; i++)
 447     {
 448       tp = vp + i;
 449       data64 = tp->offset;
 450       svm_fifo_enqueue_with_offset (f, tp->offset - f->tail, tp->len,
 451                                     (u8 *) & data64);
 452     }
 453
 454   /* Expected result: one big fat chunk at offset 4 */
 455   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 1),
 456               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 457   ooo_seg = svm_fifo_first_ooo_segment (f);
 458   SFIFO_TEST ((ooo_seg->start == 4),
 459               "first ooo seg position %u", ooo_seg->start);
 460   SFIFO_TEST ((ooo_seg->length == 2996),
 461               "first ooo seg length %u", ooo_seg->length);
 462
 463   data64 = 0;
 464   rv = svm_fifo_enqueue_nowait (f, sizeof (u32), (u8 *) & data64);
 465   SFIFO_TEST ((rv == 3000), "bytes to be enqueued %u", rv);
 466
 467   svm_fifo_free (f);
 468   vec_free (vp);
 469
 470   /*
 471    * Now try it again w/ unsorted data...
 472    */
 473
 474   f = fifo_prepare (fifo_size);
 475
 476   for (i = 0; i < test_data_len; i++)
 477     {
 478       tp = &test_data[i];
 479       data64 = tp->offset;
 480       rv = svm_fifo_enqueue_with_offset (f, tp->offset - f->tail, tp->len,
 481                                          (u8 *) & data64);
 482       if (rv)
 483         {
 484           clib_warning ("enqueue returned %d", rv);
 485         }
 486     }
 487
 488   /* Expecting the same result: one big fat chunk at offset 4 */
 489   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 1),
 490               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 491   ooo_seg = svm_fifo_first_ooo_segment (f);
 492   SFIFO_TEST ((ooo_seg->start == 4),
 493               "first ooo seg position %u", ooo_seg->start);
 494   SFIFO_TEST ((ooo_seg->length == 2996),
 495               "first ooo seg length %u", ooo_seg->length);
 496
 497   data64 = 0;
 498   rv = svm_fifo_enqueue_nowait (f, sizeof (u32), (u8 *) & data64);
 499
 500   SFIFO_TEST ((rv == 3000), "bytes to be enqueued %u", rv);
 501
 502   svm_fifo_free (f);
 503
 504   return 0;
 505 }
 506
 507 static int
 508 sfifo_test_fifo3 (vlib_main_t * vm, unformat_input_t * input)
 509 {
 510   svm_fifo_t *f;
 511   u32 fifo_size = 4 << 10;
 512   u32 fifo_initial_offset = 0;
 513   u32 total_size = 2 << 10;
 514   int overlap = 0, verbose = 0, randomize = 1, drop = 0, in_seq_all = 0;
 515   u8 *data_pattern = 0, *data_buf = 0;
 516   test_pattern_t *tp, *generate = 0;
 517   u32 nsegs = 2, seg_size, length_so_far;
 518   u32 current_offset, offset_increment, len_this_chunk;
 519   u32 seed = 0xdeaddabe, j;
 520   int i, rv;
 521
 522   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 523     {
 524       if (unformat (input, "fifo-size %d", &fifo_size))
 525         ;
 526       else if (unformat (input, "total-size %d", &total_size))
 527         ;
 528       else if (unformat (input, "verbose"))
 529         verbose = 1;
 530       else if (unformat (input, "overlap"))
 531         overlap = 1;
 532       else if (unformat (input, "initial-offset %d", &fifo_initial_offset))
 533         ;
 534       else if (unformat (input, "seed %d", &seed))
 535         ;
 536       else if (unformat (input, "nsegs %d", &nsegs))
 537         ;
 538       else if (unformat (input, "no-randomize"))
 539         randomize = 0;
 540       else if (unformat (input, "in-seq-all"))
 541         in_seq_all = 1;
 542       else if (unformat (input, "drop"))
 543         drop = 1;
 544       else
 545         {
 546           clib_error_t *e = clib_error_return
 547             (0, "unknown input `%U'", format_unformat_error, input);
 548           clib_error_report (e);
 549           return -1;
 550         }
 551     }
 552
 553   if (total_size > fifo_size)
 554     {
 555       clib_warning ("total_size %d greater than fifo size %d", total_size,
 556                     fifo_size);
 557       return -1;
 558     }
 559   if (overlap && randomize == 0)
 560     {
 561       clib_warning ("Can't enqueue in-order with overlap");
 562       return -1;
 563     }
 564
 565   /*
 566    * Generate data
 567    */
 568   vec_validate (data_pattern, total_size - 1);
 569   for (i = 0; i < vec_len (data_pattern); i++)
 570     data_pattern[i] = i & 0xff;
 571
 572   /*
 573    * Generate segments
 574    */
 575   seg_size = total_size / nsegs;
 576   length_so_far = 0;
 577   current_offset = randomize;
 578   while (length_so_far < total_size)
 579     {
 580       vec_add2 (generate, tp, 1);
 581       len_this_chunk = clib_min (seg_size, total_size - length_so_far);
 582       tp->offset = current_offset;
 583       tp->len = len_this_chunk;
 584
 585       if (overlap && (len_this_chunk == seg_size))
 586         do
 587           {
 588             offset_increment = len_this_chunk
 589               % (1 + (random_u32 (&seed) % len_this_chunk));
 590           }
 591         while (offset_increment == 0);
 592       else
 593         offset_increment = len_this_chunk;
 594
 595       current_offset += offset_increment;
 596       length_so_far = tp->offset + tp->len;
 597     }
 598
 599   /*
 600    * Validate segment list. Only valid for non-overlap cases.
 601    */
 602   if (overlap == 0)
 603     fifo_validate_pattern (vm, generate, vec_len (generate));
 604
 605   if (verbose)
 606     {
 607       vlib_cli_output (vm, "raw data pattern:");
 608       for (i = 0; i < vec_len (generate); i++)
 609         {
 610           vlib_cli_output (vm, "[%d] offset %u len %u", i,
 611                            generate[i].offset, generate[i].len);
 612         }
 613     }
 614
 615   /* Randomize data pattern */
 616   if (randomize)
 617     {
 618       for (i = 0; i < vec_len (generate) / 2; i++)
 619         {
 620           u32 src_index, dst_index;
 621           test_pattern_t _tmp, *tmp = &_tmp;
 622
 623           src_index = random_u32 (&seed) % vec_len (generate);
 624           dst_index = random_u32 (&seed) % vec_len (generate);
 625
 626           tmp[0] = generate[dst_index];
 627           generate[dst_index] = generate[src_index];
 628           generate[src_index] = tmp[0];
 629         }
 630       if (verbose)
 631         {
 632           vlib_cli_output (vm, "randomized data pattern:");
 633           for (i = 0; i < vec_len (generate); i++)
 634             {
 635               vlib_cli_output (vm, "[%d] offset %u len %u", i,
 636                                generate[i].offset, generate[i].len);
 637             }
 638         }
 639     }
 640
 641   /*
 642    * Create a fifo and add segments
 643    */
 644   f = fifo_prepare (fifo_size);
 645
 646   /* manually set head and tail pointers to validate modular arithmetic */
 647   fifo_initial_offset = fifo_initial_offset % fifo_size;
 648   svm_fifo_init_pointers (f, fifo_initial_offset, fifo_initial_offset);
 649
 650   for (i = !randomize; i < vec_len (generate); i++)
 651     {
 652       tp = generate + i;
 653       svm_fifo_enqueue_with_offset (f,
 654                                     fifo_initial_offset + tp->offset -
 655                                     f->tail, tp->len,
 656                                     (u8 *) data_pattern + tp->offset);
 657     }
 658
 659   /* Add the first segment in order for non random data */
 660   if (!randomize)
 661     svm_fifo_enqueue_nowait (f, generate[0].len, (u8 *) data_pattern);
 662
 663   /*
 664    * Expected result: one big fat chunk at offset 1 if randomize == 1
 665    */
 666
 667   if (verbose)
 668     vlib_cli_output (vm, "fifo before missing link: %U",
 669                      format_svm_fifo, f, 1 /* verbose */ );
 670
 671   /*
 672    * Add the missing byte if segments were randomized
 673    */
 674   if (randomize)
 675     {
 676       u32 bytes_to_enq = 1;
 677       if (in_seq_all)
 678         bytes_to_enq = total_size;
 679       rv = svm_fifo_enqueue_nowait (f, bytes_to_enq, data_pattern + 0);
 680
 681       if (verbose)
 682         vlib_cli_output (vm, "in-order enqueue returned %d", rv);
 683
 684       SFIFO_TEST ((rv == total_size), "enqueued %u expected %u", rv,
 685                   total_size);
 686
 687     }
 688
 689   SFIFO_TEST ((svm_fifo_has_ooo_data (f) == 0), "number of ooo segments %u",
 690               svm_fifo_number_ooo_segments (f));
 691
 692   /*
 693    * Test if peeked data is the same as original data
 694    */
 695   vec_validate (data_buf, vec_len (data_pattern));
 696   svm_fifo_peek (f, 0, vec_len (data_pattern), data_buf);
 697   if (compare_data (data_buf, data_pattern, 0, vec_len (data_pattern), &j))
 698     {
 699       SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j],
 700                   data_pattern[j]);
 701     }
 702   vec_reset_length (data_buf);
 703
 704   /*
 705    * Dequeue or drop all data
 706    */
 707   if (drop)
 708     {
 709       svm_fifo_dequeue_drop (f, vec_len (data_pattern));
 710     }
 711   else
 712     {
 713       svm_fifo_dequeue_nowait (f, vec_len (data_pattern), data_buf);
 714       if (compare_data
 715           (data_buf, data_pattern, 0, vec_len (data_pattern), &j))
 716         {
 717           SFIFO_TEST (0, "[%d] dequeued %u expected %u", j, data_buf[j],
 718                       data_pattern[j]);
 719         }
 720     }
 721
 722   SFIFO_TEST ((svm_fifo_max_dequeue (f) == 0), "fifo has %d bytes",
 723               svm_fifo_max_dequeue (f));
 724
 725   svm_fifo_free (f);
 726   vec_free (data_pattern);
 727   vec_free (data_buf);
 728
 729   return 0;
 730 }
 731
 732 static int
 733 sfifo_test_fifo4 (vlib_main_t * vm, unformat_input_t * input)
 734 {
 735   svm_fifo_t *f;
 736   u32 fifo_size = 6 << 10;
 737   u32 fifo_initial_offset = 1000000000;
 738   u32 test_n_bytes = 5000, j;
 739   u8 *test_data = 0, *data_buf = 0;
 740   int i, rv, verbose = 0;
 741
 742   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 743     {
 744       if (unformat (input, "verbose"))
 745         verbose = 1;
 746       else
 747         {
 748           clib_error_t *e = clib_error_return
 749             (0, "unknown input `%U'", format_unformat_error, input);
 750           clib_error_report (e);
 751           return -1;
 752         }
 753     }
 754
 755   /*
 756    * Create a fifo and add segments
 757    */
 758   f = fifo_prepare (fifo_size);
 759
 760   /* Set head and tail pointers */
 761   fifo_initial_offset = fifo_initial_offset % fifo_size;
 762   svm_fifo_init_pointers (f, fifo_initial_offset, fifo_initial_offset);
 763
 764   vec_validate (test_data, test_n_bytes - 1);
 765   for (i = 0; i < vec_len (test_data); i++)
 766     test_data[i] = i;
 767
 768   for (i = test_n_bytes - 1; i > 0; i--)
 769     {
 770       rv = svm_fifo_enqueue_with_offset (f, fifo_initial_offset + i - f->tail,
 771                                          sizeof (u8), &test_data[i]);
 772       if (verbose)
 773         vlib_cli_output (vm, "add [%d] [%d, %d]", i, i, i + sizeof (u8));
 774       if (rv)
 775         {
 776           clib_warning ("enqueue returned %d", rv);
 777           svm_fifo_free (f);
 778           vec_free (test_data);
 779           return -1;
 780         }
 781     }
 782
 783   svm_fifo_enqueue_nowait (f, sizeof (u8), &test_data[0]);
 784
 785   vec_validate (data_buf, vec_len (test_data));
 786
 787   svm_fifo_dequeue_nowait (f, vec_len (test_data), data_buf);
 788   rv = compare_data (data_buf, test_data, 0, vec_len (test_data), &j);
 789   if (rv)
 790     vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
 791                      test_data[j]);
 792   SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
 793
 794   svm_fifo_free (f);
 795   vec_free (test_data);
 796   return 0;
 797 }
 798
 799 static u32
 800 fifo_pos (svm_fifo_t * f, u32 pos)
 801 {
 802   return pos;
 803 }
 804
 805 static int
 806 sfifo_test_fifo5 (vlib_main_t * vm, unformat_input_t * input)
 807 {
 808   svm_fifo_t *f;
 809   u32 fifo_size = 401, j = 0, offset = 200;
 810   int i, rv, verbose = 0;
 811   u8 *test_data = 0, *data_buf = 0;
 812   ooo_segment_t *ooo_seg;
 813
 814   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 815     {
 816       if (unformat (input, "verbose"))
 817         verbose = 1;
 818       else
 819         {
 820           clib_error_t *e = clib_error_return (0, "unknown input `%U'",
 821                                                format_unformat_error, input);
 822           clib_error_report (e);
 823           return -1;
 824         }
 825     }
 826
 827   f = fifo_prepare (fifo_size);
 828   svm_fifo_init_pointers (f, offset, offset);
 829
 830   vec_validate (test_data, 399);
 831   for (i = 0; i < vec_len (test_data); i++)
 832     test_data[i] = i % 0xff;
 833
 834   /*
 835    * Start with [100, 200] and [300, 400]
 836    */
 837   svm_fifo_enqueue_with_offset (f, 100, 100, &test_data[100]);
 838   svm_fifo_enqueue_with_offset (f, 300, 100, &test_data[300]);
 839
 840   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 2),
 841               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 842   SFIFO_TEST ((f->ooos_newest == 1), "newest %u", f->ooos_newest);
 843   if (verbose)
 844     vlib_cli_output (vm, "fifo after [100, 200] and [300, 400] : %U",
 845                      format_svm_fifo, f, 2 /* verbose */ );
 846
 847   /*
 848    * Add [225, 275]
 849    */
 850
 851   rv = svm_fifo_enqueue_with_offset (f, 225, 50, &test_data[200]);
 852   if (verbose)
 853     vlib_cli_output (vm, "fifo after [225, 275] : %U",
 854                      format_svm_fifo, f, 2 /* verbose */ );
 855   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 3),
 856               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 857   ooo_seg = svm_fifo_first_ooo_segment (f);
 858   SFIFO_TEST ((ooo_seg->start == fifo_pos (f, 100 + offset)),
 859               "first seg start %u expected %u", ooo_seg->start,
 860               fifo_pos (f, 100 + offset));
 861   SFIFO_TEST ((ooo_seg->length == 100), "first seg length %u expected %u",
 862               ooo_seg->length, 100);
 863   ooo_seg = ooo_segment_next (f, ooo_seg);
 864   SFIFO_TEST ((ooo_seg->start == fifo_pos (f, 225 + offset)),
 865               "second seg start %u expected %u",
 866               ooo_seg->start, fifo_pos (f, 225 + offset));
 867   SFIFO_TEST ((ooo_seg->length == 50), "second seg length %u expected %u",
 868               ooo_seg->length, 50);
 869   ooo_seg = ooo_segment_next (f, ooo_seg);
 870   SFIFO_TEST ((ooo_seg->start == fifo_pos (f, 300 + offset)),
 871               "third seg start %u expected %u",
 872               ooo_seg->start, fifo_pos (f, 300 + offset));
 873   SFIFO_TEST ((ooo_seg->length == 100), "third seg length %u expected %u",
 874               ooo_seg->length, 100);
 875   SFIFO_TEST ((f->ooos_newest == 2), "newest %u", f->ooos_newest);
 876   /*
 877    * Add [190, 310]
 878    */
 879   rv = svm_fifo_enqueue_with_offset (f, 190, 120, &test_data[190]);
 880   if (verbose)
 881     vlib_cli_output (vm, "fifo after [190, 310] : %U",
 882                      format_svm_fifo, f, 1 /* verbose */ );
 883   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 1),
 884               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 885   ooo_seg = svm_fifo_first_ooo_segment (f);
 886   SFIFO_TEST ((ooo_seg->start == fifo_pos (f, offset + 100)),
 887               "first seg start %u expected %u",
 888               ooo_seg->start, fifo_pos (f, offset + 100));
 889   SFIFO_TEST ((ooo_seg->length == 300), "first seg length %u expected %u",
 890               ooo_seg->length, 300);
 891
 892   /*
 893    * Add [0, 150]
 894    */
 895   rv = svm_fifo_enqueue_nowait (f, 150, test_data);
 896
 897   if (verbose)
 898     vlib_cli_output (vm, "fifo after [0 150] : %U", format_svm_fifo, f,
 899                      2 /* verbose */ );
 900
 901   SFIFO_TEST ((rv == 400), "managed to enqueue %u expected %u", rv, 400);
 902   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 0),
 903               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 904
 905   vec_validate (data_buf, 399);
 906   svm_fifo_peek (f, 0, 400, data_buf);
 907   if (compare_data (data_buf, test_data, 0, 400, &j))
 908     {
 909       SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j],
 910                   test_data[j]);
 911     }
 912
 913   /*
 914    * Add [100 200] and overlap it with [50 250]
 915    */
 916   svm_fifo_free (f);
 917   f = fifo_prepare (fifo_size);
 918
 919   svm_fifo_enqueue_with_offset (f, 100, 100, &test_data[100]);
 920   svm_fifo_enqueue_with_offset (f, 50, 200, &test_data[50]);
 921   SFIFO_TEST ((svm_fifo_number_ooo_segments (f) == 1),
 922               "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
 923   ooo_seg = svm_fifo_first_ooo_segment (f);
 924   SFIFO_TEST ((ooo_seg->start == 50), "first seg start %u expected %u",
 925               ooo_seg->start, 50);
 926   SFIFO_TEST ((ooo_seg->length == 200), "first seg length %u expected %u",
 927               ooo_seg->length, 200);
 928
 929   svm_fifo_free (f);
 930   vec_free (test_data);
 931   return 0;
 932 }
 933
 934 static int
 935 sfifo_test_fifo_grow (vlib_main_t * vm, unformat_input_t * input)
 936 {
 937   int verbose = 0, fifo_size = 201, start_offset = 100, i, j, rv;
 938   int test_n_bytes, deq_bytes, enq_bytes, n_deqs, n_enqs;
 939   svm_fifo_chunk_t *c, *next, *prev;
 940   u8 *test_data = 0, *data_buf = 0;
 941   svm_fifo_t *f;
 942
 943   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 944     {
 945       if (unformat (input, "verbose"))
 946         verbose = 1;
 947       else
 948         {
 949           vlib_cli_output (vm, "parse error: '%U'", format_unformat_error,
 950                            input);
 951           return -1;
 952         }
 953     }
 954
 955   f = fifo_prepare (fifo_size);
 956   svm_fifo_init_pointers (f, start_offset, start_offset);
 957
 958   /*
 959    * Add with fifo not wrapped
 960    */
 961   c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
 962   c->length = 100;
 963   c->start_byte = ~0;
 964   c->next = 0;
 965
 966   svm_fifo_add_chunk (f, c);
 967
 968   SFIFO_TEST (f->size == fifo_size + 100, "size expected %u is %u",
 969               fifo_size + 100, f->size);
 970   SFIFO_TEST (c->start_byte == fifo_size, "start byte expected %u is %u",
 971               fifo_size, c->start_byte);
 972
 973   /*
 974    *  Add with fifo wrapped
 975    */
 976
 977   svm_fifo_init_pointers (f, f->nitems - 100, f->nitems + 100);
 978   c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
 979   c->length = 100;
 980   c->start_byte = ~0;
 981   c->next = 0;
 982
 983   svm_fifo_add_chunk (f, c);
 984
 985   SFIFO_TEST (f->end_chunk != c, "tail chunk should not be updated");
 986   SFIFO_TEST (f->size == fifo_size + 100, "size expected %u is %u",
 987               fifo_size + 100, f->size);
 988   SFIFO_TEST (c->start_byte == fifo_size + 100, "start byte expected %u is "
 989               " %u", fifo_size + 100, c->start_byte);
 990
 991   /*
 992    * Unwrap fifo
 993    */
 994   vec_validate (data_buf, 200);
 995   svm_fifo_dequeue_nowait (f, 201, data_buf);
 996
 997   SFIFO_TEST (f->end_chunk == c, "tail chunk should be updated");
 998   SFIFO_TEST (f->size == fifo_size + 200, "size expected %u is %u",
 999               fifo_size + 200, f->size);
1000   SFIFO_TEST (c->start_byte == fifo_size + 100, "start byte expected %u is "
1001               "%u", fifo_size + 100, c->start_byte);
1002
1003   /*
1004    * Add N chunks
1005    */
1006   svm_fifo_init_pointers (f, f->nitems - 100, f->nitems + 100);
1007
1008   prev = 0;
1009   for (i = 0; i < 5; i++)
1010     {
1011       c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
1012       c->length = 100;
1013       c->start_byte = ~0;
1014       c->next = prev;
1015       prev = c;
1016     }
1017
1018   svm_fifo_add_chunk (f, c);
1019   SFIFO_TEST (f->size == fifo_size + 200, "size expected %u is %u",
1020               fifo_size + 200, f->size);
1021
1022   prev = 0;
1023   for (i = 0; i < 5; i++)
1024     {
1025       c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
1026       c->length = 100;
1027       c->start_byte = ~0;
1028       c->next = prev;
1029       prev = c;
1030     }
1031
1032   svm_fifo_add_chunk (f, c);
1033   SFIFO_TEST (f->size == fifo_size + 200, "size expected %u is %u",
1034               fifo_size + 200, f->size);
1035
1036   svm_fifo_dequeue_nowait (f, 201, data_buf);
1037
1038   SFIFO_TEST (f->size == fifo_size + 200 + 10 * 100, "size expected %u is %u",
1039               fifo_size + 200 + 10 * 100, f->size);
1040   /*
1041    * Enqueue/dequeue tests
1042    */
1043
1044   test_n_bytes = f->nitems;
1045   vec_validate (test_data, test_n_bytes - 1);
1046   vec_validate (data_buf, vec_len (test_data));
1047   n_deqs = n_enqs = 6;
1048   deq_bytes = enq_bytes = vec_len (test_data) / n_deqs;
1049
1050   for (i = 0; i < vec_len (test_data); i++)
1051     test_data[i] = i;
1052
1053   /*
1054    * Enqueue/deq boundary conditions
1055    */
1056   svm_fifo_init_pointers (f, 201, 201);
1057   SFIFO_TEST (f->tail_chunk->start_byte == 201, "start byte expected %u is "
1058               "%u", 201, f->tail_chunk->start_byte);
1059
1060   svm_fifo_enqueue_nowait (f, 200, test_data);
1061   SFIFO_TEST (f->tail_chunk->start_byte == 401, "start byte expected %u is "
1062               "%u", 401, f->tail_chunk->start_byte);
1063
1064   svm_fifo_dequeue_nowait (f, 200, data_buf);
1065   SFIFO_TEST (f->head_chunk->start_byte == 401, "start byte expected %u is "
1066               "%u", 401, f->head_chunk->start_byte);
1067
1068   /*
1069    * Simple enqueue/deq and data validation (1)
1070    */
1071   svm_fifo_init_pointers (f, f->nitems / 2, f->nitems / 2);
1072   for (i = 0; i < test_n_bytes; i++)
1073     {
1074       rv = svm_fifo_enqueue_nowait (f, sizeof (u8), &test_data[i]);
1075       if (rv < 0)
1076         {
1077           clib_warning ("enqueue returned %d", rv);
1078           goto cleanup;
1079         }
1080     }
1081
1082   SFIFO_TEST (svm_fifo_max_dequeue (f) == test_n_bytes, "max deq expected %u "
1083               "is %u", test_n_bytes, svm_fifo_max_dequeue (f));
1084
1085   for (i = 0; i < test_n_bytes; i++)
1086     svm_fifo_dequeue_nowait (f, 1, &data_buf[i]);
1087
1088   rv = compare_data (data_buf, test_data, 0, vec_len (test_data),
1089                      (u32 *) & j);
1090   if (rv)
1091     vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
1092                      test_data[j]);
1093   SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
1094
1095   /*
1096    * Simple enqueue/deq and data validation (2)
1097    */
1098   for (i = 0; i <= n_enqs; i++)
1099     {
1100       rv = svm_fifo_enqueue_nowait (f, enq_bytes, test_data + i * enq_bytes);
1101       if (rv < 0)
1102         {
1103           clib_warning ("enqueue returned %d", rv);
1104           goto cleanup;
1105         }
1106     }
1107
1108   SFIFO_TEST (svm_fifo_max_dequeue (f) == test_n_bytes, "max deq expected %u "
1109               "is %u", test_n_bytes, svm_fifo_max_dequeue (f));
1110
1111   for (i = 0; i <= n_deqs; i++)
1112     svm_fifo_dequeue_nowait (f, deq_bytes, data_buf + i * deq_bytes);
1113
1114   rv = compare_data (data_buf, test_data, 0, vec_len (test_data),
1115                      (u32 *) & j);
1116   if (rv)
1117     vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
1118                      test_data[j]);
1119   SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
1120
1121   /*
1122    * OOO enqueues/dequeues and data validation (1)
1123    */
1124   for (i = test_n_bytes - 1; i > 0; i--)
1125     {
1126       rv = svm_fifo_enqueue_with_offset (f, i, sizeof (u8), &test_data[i]);
1127       if (verbose)
1128         vlib_cli_output (vm, "add [%d] [%d, %d]", i, i, i + sizeof (u8));
1129       if (rv)
1130         {
1131           clib_warning ("enqueue returned %d", rv);
1132           goto cleanup;
1133         }
1134     }
1135
1136   SFIFO_TEST (svm_fifo_max_dequeue (f) == 0, "max deq expected %u is %u",
1137               0, svm_fifo_max_dequeue (f));
1138
1139   svm_fifo_enqueue_nowait (f, sizeof (u8), &test_data[0]);
1140
1141   memset (data_buf, 0, vec_len (data_buf));
1142   for (i = 0; i <= n_deqs; i++)
1143     svm_fifo_dequeue_nowait (f, deq_bytes, data_buf + i * deq_bytes);
1144
1145   rv = compare_data (data_buf, test_data, 0, vec_len (test_data),
1146                      (u32 *) & j);
1147   if (rv)
1148     vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
1149                      test_data[j]);
1150   SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
1151
1152   /*
1153    * OOO enqueues/dequeues and data validation (2)
1154    */
1155
1156   for (i = n_enqs; i > 0; i--)
1157     {
1158       u32 enq_now = clib_min (enq_bytes, vec_len (test_data) - i * enq_bytes);
1159       rv = svm_fifo_enqueue_with_offset (f, i * enq_bytes, enq_now,
1160                                          test_data + i * enq_bytes);
1161       if (verbose)
1162         vlib_cli_output (vm, "add [%d, %d]", i * enq_bytes,
1163                          i * enq_bytes + enq_now);
1164       if (rv)
1165         {
1166           clib_warning ("enqueue returned %d", rv);
1167           goto cleanup;
1168         }
1169     }
1170
1171   svm_fifo_enqueue_nowait (f, enq_bytes, &test_data[0]);
1172
1173   memset (data_buf, 0, vec_len (data_buf));
1174   for (i = 0; i <= n_deqs; i++)
1175     svm_fifo_dequeue_nowait (f, deq_bytes, data_buf + i * deq_bytes);
1176
1177   rv = compare_data (data_buf, test_data, 0, vec_len (test_data),
1178                      (u32 *) & j);
1179   if (rv)
1180     vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
1181                      test_data[j]);
1182   SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
1183
1184   /*
1185    * Cleanup
1186    */
1187
1188 cleanup:
1189
1190   c = f->start_chunk->next;
1191   while (c && c != f->start_chunk)
1192     {
1193       next = c->next;
1194       clib_mem_free (c);
1195       c = next;
1196     }
1197
1198   svm_fifo_free (f);
1199
1200   vec_free (data_buf);
1201   return 0;
1202 }
1203
1204 /* *INDENT-OFF* */
1205 svm_fifo_trace_elem_t fifo_trace[] = {};
1206 /* *INDENT-ON* */
1207
1208 static int
1209 sfifo_test_fifo_replay (vlib_main_t * vm, unformat_input_t * input)
1210 {
1211   svm_fifo_t f;
1212   int verbose = 0;
1213   u8 no_read = 0, *str = 0;
1214
1215   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1216     {
1217       if (unformat (input, "verbose"))
1218         verbose = 1;
1219       else if (unformat (input, "no-read"))
1220         no_read = 1;
1221       else
1222         {
1223           clib_error_t *e = clib_error_return
1224             (0, "unknown input `%U'", format_unformat_error, input);
1225           clib_error_report (e);
1226           return -1;
1227         }
1228     }
1229
1230 #if SVMF_FIFO_TRACE
1231   f.trace = fifo_trace;
1232 #endif
1233
1234   str = svm_fifo_replay (str, &f, no_read, verbose);
1235   vlib_cli_output (vm, "%v", str);
1236   return 0;
1237 }
1238
1239 static fifo_segment_main_t segment_main;
1240
1241 static int
1242 sfifo_test_fifo_segment_hello_world (int verbose)
1243 {
1244   fifo_segment_create_args_t _a, *a = &_a;
1245   fifo_segment_main_t *sm = &segment_main;
1246   u8 *test_data, *retrieved_data = 0;
1247   fifo_segment_t *fs;
1248   svm_fifo_t *f;
1249   int rv;
1250
1251   clib_memset (a, 0, sizeof (*a));
1252   a->segment_name = "fifo-test1";
1253   a->segment_size = 256 << 10;
1254
1255   rv = fifo_segment_create (sm, a);
1256
1257   SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
1258
1259   fs = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1260   f = fifo_segment_alloc_fifo (fs, 4096, FIFO_SEGMENT_RX_FIFO);
1261
1262   SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo");
1263
1264   test_data = format (0, "Hello world%c", 0);
1265   vec_validate (retrieved_data, vec_len (test_data) - 1);
1266
1267   while (svm_fifo_max_enqueue (f) >= vec_len (test_data))
1268     svm_fifo_enqueue_nowait (f, vec_len (test_data), test_data);
1269
1270   while (svm_fifo_max_dequeue (f) >= vec_len (test_data))
1271     svm_fifo_dequeue_nowait (f, vec_len (retrieved_data), retrieved_data);
1272
1273   while (svm_fifo_max_enqueue (f) >= vec_len (test_data))
1274     svm_fifo_enqueue_nowait (f, vec_len (test_data), test_data);
1275
1276   while (svm_fifo_max_dequeue (f) >= vec_len (test_data))
1277     svm_fifo_dequeue_nowait (f, vec_len (retrieved_data), retrieved_data);
1278
1279   SFIFO_TEST (!memcmp (retrieved_data, test_data, vec_len (test_data)),
1280               "data should be identical");
1281
1282   vec_free (test_data);
1283   vec_free (retrieved_data);
1284   vec_free (a->new_segment_indices);
1285   fifo_segment_free_fifo (fs, f);
1286   fifo_segment_delete (sm, fs);
1287   return 0;
1288 }
1289
1290 static int
1291 sfifo_test_fifo_segment_fifo_grow (int verbose)
1292 {
1293   fifo_segment_main_t *sm = &segment_main;
1294   fifo_segment_create_args_t _a, *a = &_a;
1295   int rv, fifo_size = 4096, n_chunks;
1296   fifo_segment_t *fs;
1297   svm_fifo_t *f;
1298
1299   clib_memset (a, 0, sizeof (*a));
1300   a->segment_name = "fifo-test1";
1301   a->segment_size = 256 << 10;
1302
1303   rv = fifo_segment_create (sm, a);
1304
1305   SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
1306
1307   /*
1308    * Alloc and grow fifo
1309    */
1310   fs = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1311   f = fifo_segment_alloc_fifo (fs, fifo_size, FIFO_SEGMENT_RX_FIFO);
1312
1313   SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo");
1314
1315   fifo_segment_grow_fifo (fs, f, fifo_size);
1316   SFIFO_TEST (f->size == 2 * fifo_size, "fifo size should be %u is %u",
1317               2 * fifo_size, f->size);
1318
1319   fifo_segment_grow_fifo (fs, f, 16 * fifo_size);
1320   SFIFO_TEST (f->size == 18 * fifo_size, "fifo size should be %u is %u",
1321               18 * fifo_size, f->size);
1322
1323   /*
1324    * Free and test free list size
1325    */
1326   fifo_segment_free_fifo (fs, f);
1327
1328   n_chunks = fifo_segment_num_free_chunks (fs, fifo_size);
1329   SFIFO_TEST (n_chunks == 1, "free 2^10B chunks should be %u is %u", 1,
1330               n_chunks);
1331   n_chunks = fifo_segment_num_free_chunks (fs, 16 * fifo_size);
1332   SFIFO_TEST (n_chunks == 1, "free 2^14B chunks should be %u is %u", 1,
1333               n_chunks);
1334   n_chunks = fifo_segment_num_free_chunks (fs, ~0);
1335   SFIFO_TEST (n_chunks == 2, "free chunks should be %u is %u", 2, n_chunks);
1336
1337   /*
1338    * Realloc fifo
1339    */
1340   f = fifo_segment_alloc_fifo (fs, fifo_size, FIFO_SEGMENT_RX_FIFO);
1341
1342   fifo_segment_grow_fifo (fs, f, fifo_size);
1343   n_chunks = fifo_segment_num_free_chunks (fs, fifo_size);
1344   SFIFO_TEST (n_chunks == 0, "free 2^10B chunks should be %u is %u", 0,
1345               n_chunks);
1346
1347   fifo_segment_grow_fifo (fs, f, 16 * fifo_size);
1348   SFIFO_TEST (n_chunks == 0, "free 2^14B chunks should be %u is %u", 0,
1349               n_chunks);
1350   n_chunks = fifo_segment_num_free_chunks (fs, ~0);
1351   SFIFO_TEST (n_chunks == 0, "free chunks should be %u is %u", 0, n_chunks);
1352
1353   /*
1354    * Free again
1355    */
1356   fifo_segment_free_fifo (fs, f);
1357   n_chunks = fifo_segment_num_free_chunks (fs, ~0);
1358   SFIFO_TEST (n_chunks == 2, "free chunks should be %u is %u", 2, n_chunks);
1359
1360   /*
1361    * Cleanup
1362    */
1363   fifo_segment_delete (sm, fs);
1364   vec_free (a->new_segment_indices);
1365   return 0;
1366 }
1367
1368 static int
1369 sfifo_test_fifo_segment_slave (int verbose)
1370 {
1371   fifo_segment_create_args_t _a, *a = &_a;
1372   fifo_segment_main_t *sm = &segment_main;
1373   u8 *test_data, *retrieved_data = 0;
1374   fifo_segment_t *sp;
1375   fifo_segment_header_t *fsh;
1376   ssvm_shared_header_t *sh;
1377   svm_fifo_t *f;
1378   u32 *result;
1379   int rv, i;
1380
1381   sleep (2);
1382
1383   sm->timeout_in_seconds = 5;
1384   clib_memset (a, 0, sizeof (*a));
1385   a->segment_name = "fifo-test1";
1386
1387   rv = fifo_segment_attach (sm, a);
1388
1389   SFIFO_TEST (!rv, "svm_fifo_segment_attach returned %d", rv);
1390
1391   sp = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1392   vec_free (a->new_segment_indices);
1393   sh = sp->ssvm.sh;
1394   fsh = (fifo_segment_header_t *) sh->opaque[0];
1395
1396   /* might wanna wait.. */
1397   f = fsh->fifos;
1398
1399   /* Lazy bastards united */
1400   test_data = format (0, "Hello world%c", 0);
1401   vec_validate (retrieved_data, vec_len (test_data) - 1);
1402
1403   for (i = 0; i < 1000; i++)
1404     {
1405       svm_fifo_dequeue_nowait (f, vec_len (retrieved_data), retrieved_data);
1406       if (memcmp (retrieved_data, test_data, vec_len (retrieved_data)))
1407         {
1408           result = (u32 *) f->head_chunk->data;
1409           *result = 1;
1410           _exit (0);
1411         }
1412     }
1413
1414   result = (u32 *) f->head_chunk->data;
1415   *result = 0;
1416
1417   vec_free (test_data);
1418   vec_free (retrieved_data);
1419   _exit (0);
1420 }
1421
1422 static int
1423 sfifo_test_fifo_segment_master_slave (int verbose)
1424 {
1425   fifo_segment_create_args_t _a, *a = &_a;
1426   fifo_segment_main_t *sm = &segment_main;
1427   fifo_segment_t *sp;
1428   svm_fifo_t *f;
1429   u8 *test_data;
1430   u32 *result;
1431   int rv, i;
1432   pid_t pid;
1433
1434   pid = fork ();
1435   if (pid < 0)
1436     SFIFO_TEST (0, "fork failed");
1437
1438   if (!pid)
1439     sfifo_test_fifo_segment_slave (verbose);
1440
1441   clib_memset (a, 0, sizeof (*a));
1442   a->segment_name = "fifo-test1";
1443   a->segment_size = 256 << 10;
1444
1445   rv = fifo_segment_create (sm, a);
1446
1447   SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
1448
1449   sp = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1450   f = fifo_segment_alloc_fifo (sp, 4096, FIFO_SEGMENT_RX_FIFO);
1451
1452   SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo alloc");
1453
1454   test_data = format (0, "Hello world%c", 0);
1455
1456   usleep (200e3);
1457
1458   for (i = 0; i < 1000; i++)
1459     svm_fifo_enqueue_nowait (f, vec_len (test_data), test_data);
1460
1461   /* Wait for slave */
1462   i = 0;
1463   while (svm_fifo_max_dequeue (f) && i++ < 1e10)
1464     ;
1465
1466   usleep (1e3);
1467
1468   result = (u32 *) f->head_chunk->data;
1469   SFIFO_TEST (*result == 0, "slave reported no error");
1470
1471   vec_free (a->new_segment_indices);
1472   vec_free (test_data);
1473   fifo_segment_free_fifo (sp, f);
1474   fifo_segment_delete (sm, sp);
1475   return 0;
1476 }
1477
1478 static int
1479 sfifo_test_fifo_segment_mempig (int verbose)
1480 {
1481   fifo_segment_create_args_t _a, *a = &_a;
1482   fifo_segment_main_t *sm = &segment_main;
1483   fifo_segment_t *sp;
1484   svm_fifo_t *f;
1485   svm_fifo_t **flist = 0;
1486   int rv;
1487   int i;
1488
1489   clib_memset (a, 0, sizeof (*a));
1490
1491   a->segment_name = "fifo-test1";
1492   a->segment_size = 256 << 10;
1493
1494   rv = fifo_segment_create (sm, a);
1495
1496   SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
1497
1498   sp = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1499
1500   for (i = 0; i < 1000; i++)
1501     {
1502       f = fifo_segment_alloc_fifo (sp, 4096, FIFO_SEGMENT_RX_FIFO);
1503       if (f == 0)
1504         break;
1505       vec_add1 (flist, f);
1506     }
1507
1508   SFIFO_TEST (vec_len (flist), "created %d fifos", vec_len (flist));
1509
1510   for (i = 0; i < vec_len (flist); i++)
1511     {
1512       f = flist[i];
1513       fifo_segment_free_fifo (sp, f);
1514     }
1515
1516   _vec_len (flist) = 0;
1517
1518   for (i = 0; i < 1000; i++)
1519     {
1520       f = fifo_segment_alloc_fifo (sp, 4096, FIFO_SEGMENT_RX_FIFO);
1521       if (f == 0)
1522         break;
1523       vec_add1 (flist, f);
1524     }
1525
1526   SFIFO_TEST (vec_len (flist), "second try created %d fifos",
1527               vec_len (flist));
1528   for (i = 0; i < vec_len (flist); i++)
1529     {
1530       f = flist[i];
1531       fifo_segment_free_fifo (sp, f);
1532     }
1533
1534   fifo_segment_delete (sm, sp);
1535   return 0;
1536 }
1537
1538 static int
1539 sfifo_test_fifo_segment (vlib_main_t * vm, unformat_input_t * input)
1540 {
1541   int rv, verbose = 0;
1542
1543   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1544     {
1545       if (unformat (input, "verbose"))
1546         verbose = 1;
1547       else if (unformat (input, "masterslave"))
1548         {
1549           if ((rv = sfifo_test_fifo_segment_master_slave (verbose)))
1550             return -1;
1551         }
1552       else if (unformat (input, "basic"))
1553         {
1554           if ((rv = sfifo_test_fifo_segment_hello_world (verbose)))
1555             return -1;
1556         }
1557       else if (unformat (input, "mempig"))
1558         {
1559           if ((rv = sfifo_test_fifo_segment_mempig (verbose)))
1560             return -1;
1561         }
1562       else if (unformat (input, "grow fifo"))
1563         {
1564           if ((rv = sfifo_test_fifo_segment_fifo_grow (verbose)))
1565             return -1;
1566         }
1567       else if (unformat (input, "all"))
1568         {
1569           if ((rv = sfifo_test_fifo_segment_hello_world (verbose)))
1570             return -1;
1571           if ((rv = sfifo_test_fifo_segment_mempig (verbose)))
1572             return -1;
1573           if ((rv = sfifo_test_fifo_segment_fifo_grow (verbose)))
1574             return -1;
1575           /* Pretty slow so avoid running it always
1576              if ((rv = sfifo_test_fifo_segment_master_slave (verbose)))
1577              return -1;
1578            */
1579         }
1580       else
1581         {
1582           vlib_cli_output (vm, "parse error: '%U'", format_unformat_error,
1583                            input);
1584           return -1;
1585         }
1586     }
1587   return 0;
1588 }
1589
1590 static clib_error_t *
1591 svm_fifo_test (vlib_main_t * vm, unformat_input_t * input,
1592                vlib_cli_command_t * cmd_arg)
1593 {
1594   int res = 0;
1595   char *str;
1596
1597   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1598     {
1599       if (unformat (input, "fifo1"))
1600         res = sfifo_test_fifo1 (vm, input);
1601       else if (unformat (input, "fifo2"))
1602         res = sfifo_test_fifo2 (vm);
1603       else if (unformat (input, "fifo3"))
1604         res = sfifo_test_fifo3 (vm, input);
1605       else if (unformat (input, "fifo4"))
1606         res = sfifo_test_fifo4 (vm, input);
1607       else if (unformat (input, "fifo5"))
1608         res = sfifo_test_fifo5 (vm, input);
1609       else if (unformat (input, "replay"))
1610         res = sfifo_test_fifo_replay (vm, input);
1611       else if (unformat (input, "grow"))
1612         res = sfifo_test_fifo_grow (vm, input);
1613       else if (unformat (input, "segment"))
1614         res = sfifo_test_fifo_segment (vm, input);
1615       else if (unformat (input, "all"))
1616         {
1617           if ((res = sfifo_test_fifo1 (vm, input)))
1618             goto done;
1619
1620           if ((res = sfifo_test_fifo2 (vm)))
1621             goto done;
1622
1623           /*
1624            * Run a number of fifo3 configs
1625            */
1626           str = "nsegs 10 overlap seed 123";
1627           unformat_init_cstring (input, str);
1628           if ((res = sfifo_test_fifo3 (vm, input)))
1629             goto done;
1630           unformat_free (input);
1631
1632           str = "nsegs 10 overlap seed 123 in-seq-all";
1633           unformat_init_cstring (input, str);
1634           if ((res = sfifo_test_fifo3 (vm, input)))
1635             goto done;
1636           unformat_free (input);
1637
1638           str = "nsegs 10 overlap seed 123 initial-offset 3917";
1639           unformat_init_cstring (input, str);
1640           if ((res = sfifo_test_fifo3 (vm, input)))
1641             goto done;
1642           unformat_free (input);
1643
1644           str = "nsegs 10 overlap seed 123 initial-offset 3917 drop";
1645           unformat_init_cstring (input, str);
1646           if ((res = sfifo_test_fifo3 (vm, input)))
1647             goto done;
1648           unformat_free (input);
1649
1650           str = "nsegs 10 seed 123 initial-offset 3917 drop no-randomize";
1651           unformat_init_cstring (input, str);
1652           if ((res = sfifo_test_fifo3 (vm, input)))
1653             goto done;
1654           unformat_free (input);
1655
1656           if ((res = sfifo_test_fifo4 (vm, input)))
1657             goto done;
1658
1659           if ((res = sfifo_test_fifo5 (vm, input)))
1660             goto done;
1661
1662           if ((res = sfifo_test_fifo_grow (vm, input)))
1663             goto done;
1664
1665           str = "all";
1666           unformat_init_cstring (input, str);
1667           if ((res = sfifo_test_fifo_segment (vm, input)))
1668             goto done;
1669         }
1670       else
1671         {
1672           vlib_cli_output (vm, "unknown input `%U'", format_unformat_error,
1673                            input);
1674           res = -1;
1675           goto done;
1676         }
1677
1678     }
1679
1680 done:
1681   if (res)
1682     return clib_error_return (0, "svm fifo unit test failed");
1683   return 0;
1684 }
1685
1686 /* *INDENT-OFF* */
1687 VLIB_CLI_COMMAND (svm_fifo_test_command, static) =
1688 {
1689   .path = "test svm fifo",
1690   .short_help = "internal svm fifo unit tests",
1691   .function = svm_fifo_test,
1692 };
1693 /* *INDENT-ON* */
1694
1695 /*
1696  * fd.io coding-style-patch-verification: ON
1697  *
1698  * Local Variables:
1699  * eval: (c-set-style "gnu")
1700  * End:
1701  */