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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #include <svm/svm_fifo.h>
16 #include <vlib/vlib.h>
17 #include <svm/fifo_segment.h>
19 #define SFIFO_TEST_I(_cond, _comment, _args...) \
21 int _evald = (_cond); \
23 fformat(stderr, "FAIL:%d: " _comment "\n", \
26 fformat(stderr, "PASS:%d: " _comment "\n", \
32 #define SFIFO_TEST(_cond, _comment, _args...) \
34 if (!SFIFO_TEST_I(_cond, _comment, ##_args)) { \
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},
101 /* missing from original data set */
102 {388, 4}, {776, 4}, {1164, 4}, {1552, 4}, {1940, 4}, {2328, 4},
107 pattern_cmp (const void *arg1, const void *arg2)
109 test_pattern_t *a1 = (test_pattern_t *) arg1;
110 test_pattern_t *a2 = (test_pattern_t *) arg2;
112 if (a1->offset < a2->offset)
114 else if (a1->offset > a2->offset)
120 fifo_validate_pattern (vlib_main_t * vm, test_pattern_t * pattern,
123 test_pattern_t *tp = pattern;
126 /* Go through the pattern and make 100% sure it's sane */
127 for (i = 0; i < pattern_length - 1; i++)
129 if (tp->offset + tp->len != (tp + 1)->offset)
131 vlib_cli_output (vm, "[%d] missing {%d, %d}", i,
132 (tp->offset + tp->len),
133 (tp + 1)->offset - (tp->offset + tp->len));
141 static test_pattern_t *
142 fifo_get_validate_pattern (vlib_main_t * vm, test_pattern_t * test_data,
145 test_pattern_t *validate_pattern = 0;
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),
154 if (fifo_validate_pattern (vm, validate_pattern, test_data_len) == 0)
157 return validate_pattern;
161 fifo_prepare (u32 fifo_size)
164 f = svm_fifo_create (fifo_size);
166 /* Paint fifo data vector with -1's */
167 clib_memset (f->head_chunk->data, 0xFF, fifo_size);
173 compare_data (u8 * data1, u8 * data2, u32 start, u32 len, u32 * index)
177 for (i = start; i < start + len; i++)
179 if (data1[i] != data2[i])
189 sfifo_test_fifo1 (vlib_main_t * vm, unformat_input_t * input)
192 u32 fifo_size = 1 << 20;
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;
200 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
202 if (unformat (input, "verbose"))
206 test_data_len = fifo_size / sizeof (u32);
207 vec_validate (test_data, test_data_len - 1);
209 for (i = 0; i < vec_len (test_data); i++)
212 f = fifo_prepare (fifo_size);
215 * Enqueue an initial (un-dequeued) chunk
217 rv = svm_fifo_enqueue (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);
222 * Create 3 chunks in the future. The offsets are relative
223 * to the current fifo tail
225 for (i = 0; i < 3; i++)
227 offset = (2 * i + 1) * sizeof (u32) - f->tail;
228 data = (u8 *) (test_data + (2 * i + 1));
231 rv = svm_fifo_enqueue (f, sizeof (u32), data);
232 rv = rv > 0 ? 0 : rv;
235 rv = svm_fifo_enqueue_with_offset (f, offset, sizeof (u32), data);
237 vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i + 1, offset,
238 offset + sizeof (u32));
241 clib_warning ("enqueue returned %d", rv);
247 vlib_cli_output (vm, "fifo after odd segs: %U", format_svm_fifo, f, 1);
249 SFIFO_TEST ((f->tail == 8), "fifo tail %u", f->tail);
250 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 2),
251 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
254 * Try adding a completely overlapped segment
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);
261 clib_warning ("enqueue returned %d", rv);
266 vlib_cli_output (vm, "fifo after overlap seg: %U", format_svm_fifo, f, 1);
268 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 2),
269 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
272 * Make sure format functions are not buggy
274 s = format (0, "%U", format_svm_fifo, f, 2);
278 * Paint some of missing data backwards
280 for (i = 3; i > 1; i--)
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);
286 vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i, offset,
287 offset + sizeof (u32));
290 clib_warning ("enqueue returned %d", rv);
296 vlib_cli_output (vm, "fifo before missing link: %U", format_svm_fifo, f,
298 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 1),
299 "number of ooo segments %u", svm_fifo_n_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);
307 * Enqueue the missing u32
309 rv = svm_fifo_enqueue (f, sizeof (u32), (u8 *) (test_data + 2));
311 vlib_cli_output (vm, "fifo after missing link: %U", format_svm_fifo, f,
313 SFIFO_TEST ((rv == 20), "bytes to be enqueued %u", rv);
314 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 0),
315 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
320 for (i = 0; i < 7; i++)
322 rv = svm_fifo_dequeue (f, sizeof (u32), (u8 *) & data_word);
323 if (rv != sizeof (u32))
325 clib_warning ("bytes dequeues %u", rv);
328 if (data_word != test_data[i])
330 clib_warning ("recovered [%d] %d not %d", i, data_word,
337 * Test segment overlaps: last ooo segment overlaps all
340 f = fifo_prepare (fifo_size);
342 for (i = 0; i < 4; i++)
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);
348 vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i + 1, offset,
349 offset + sizeof (u32));
352 clib_warning ("enqueue returned %d", rv);
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_n_ooo_segments (f) == 1),
360 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
362 /* add missing data to be able to dequeue something */
363 rv = svm_fifo_enqueue (f, 4, data);
364 SFIFO_TEST ((rv == 32), "enqueued %u", rv);
365 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 0),
366 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
368 vec_validate (data_buf, vec_len (test_data));
369 svm_fifo_peek (f, 0, 4, data_buf);
370 if (compare_data (data_buf, data, 0, 4, &j))
371 SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j], data[j]);
372 svm_fifo_peek (f, 8, 21, data_buf);
373 if (compare_data (data_buf, data, 0, 21, &j))
374 SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j], data[j]);
375 vec_reset_length (data_buf);
378 * Test segment overlaps: enqueue and overlap ooo segments
381 f = fifo_prepare (fifo_size);
383 for (i = 0; i < 4; i++)
385 offset = (2 * i + 1) * sizeof (u32) - f->tail;
386 data = (u8 *) (test_data + (2 * i + 1));
387 rv = svm_fifo_enqueue_with_offset (f, offset, sizeof (u32), data);
389 vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i + 1, offset,
390 offset + sizeof (u32));
393 clib_warning ("enqueue returned %d", rv);
399 vlib_cli_output (vm, "fifo after enqueue: %U", format_svm_fifo, f, 1);
401 rv = svm_fifo_enqueue (f, 29, data);
403 vlib_cli_output (vm, "fifo after enqueueing 29: %U", format_svm_fifo, f,
405 SFIFO_TEST ((rv == 32), "ooo enqueued %u", rv);
406 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 0),
407 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
409 vec_validate (data_buf, vec_len (data));
410 svm_fifo_peek (f, 0, vec_len (data), data_buf);
411 if (compare_data (data_buf, data, 0, vec_len (data), &j))
413 SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j], data[j]);
416 /* Try to peek beyond the data */
417 rv = svm_fifo_peek (f, svm_fifo_max_dequeue (f), vec_len (data), data_buf);
418 SFIFO_TEST ((rv == 0), "peeked %u expected 0", rv);
422 vec_free (test_data);
428 vec_free (test_data);
433 sfifo_test_fifo2 (vlib_main_t * vm)
436 u32 fifo_size = (1 << 20) + 1;
437 int i, rv, test_data_len;
439 test_pattern_t *tp, *vp, *test_data;
440 ooo_segment_t *ooo_seg;
442 test_data = test_pattern;
443 test_data_len = ARRAY_LEN (test_pattern);
445 vp = fifo_get_validate_pattern (vm, test_data, test_data_len);
448 f = fifo_prepare (fifo_size);
451 * Try with sorted data
453 for (i = 0; i < test_data_len; i++)
457 svm_fifo_enqueue_with_offset (f, tp->offset - f->tail, tp->len,
461 /* Expected result: one big fat chunk at offset 4 */
462 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 1),
463 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
464 ooo_seg = svm_fifo_first_ooo_segment (f);
465 SFIFO_TEST ((ooo_seg->start == 4),
466 "first ooo seg position %u", ooo_seg->start);
467 SFIFO_TEST ((ooo_seg->length == 2996),
468 "first ooo seg length %u", ooo_seg->length);
471 rv = svm_fifo_enqueue (f, sizeof (u32), (u8 *) & data64);
472 SFIFO_TEST ((rv == 3000), "bytes to be enqueued %u", rv);
478 * Now try it again w/ unsorted data...
481 f = fifo_prepare (fifo_size);
483 for (i = 0; i < test_data_len; i++)
487 rv = svm_fifo_enqueue_with_offset (f, tp->offset - f->tail, tp->len,
491 clib_warning ("enqueue returned %d", rv);
495 /* Expecting the same result: one big fat chunk at offset 4 */
496 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 1),
497 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
498 ooo_seg = svm_fifo_first_ooo_segment (f);
499 SFIFO_TEST ((ooo_seg->start == 4),
500 "first ooo seg position %u", ooo_seg->start);
501 SFIFO_TEST ((ooo_seg->length == 2996),
502 "first ooo seg length %u", ooo_seg->length);
505 rv = svm_fifo_enqueue (f, sizeof (u32), (u8 *) & data64);
507 SFIFO_TEST ((rv == 3000), "bytes to be enqueued %u", rv);
515 sfifo_test_fifo3 (vlib_main_t * vm, unformat_input_t * input)
518 u32 fifo_size = (4 << 10) + 1;
519 u32 fifo_initial_offset = 0;
520 u32 total_size = 2 << 10;
521 int overlap = 0, verbose = 0, randomize = 1, drop = 0, in_seq_all = 0;
522 u8 *data_pattern = 0, *data_buf = 0;
523 test_pattern_t *tp, *generate = 0;
524 u32 nsegs = 2, seg_size, length_so_far;
525 u32 current_offset, offset_increment, len_this_chunk;
526 u32 seed = 0xdeaddabe, j;
529 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
531 if (unformat (input, "fifo-size %d", &fifo_size))
533 else if (unformat (input, "total-size %d", &total_size))
535 else if (unformat (input, "verbose"))
537 else if (unformat (input, "overlap"))
539 else if (unformat (input, "initial-offset %d", &fifo_initial_offset))
541 else if (unformat (input, "seed %d", &seed))
543 else if (unformat (input, "nsegs %d", &nsegs))
545 else if (unformat (input, "no-randomize"))
547 else if (unformat (input, "in-seq-all"))
549 else if (unformat (input, "drop"))
553 clib_error_t *e = clib_error_return
554 (0, "unknown input `%U'", format_unformat_error, input);
555 clib_error_report (e);
560 if (total_size > fifo_size)
562 clib_warning ("total_size %d greater than fifo size %d", total_size,
566 if (overlap && randomize == 0)
568 clib_warning ("Can't enqueue in-order with overlap");
575 vec_validate (data_pattern, total_size - 1);
576 for (i = 0; i < vec_len (data_pattern); i++)
577 data_pattern[i] = i & 0xff;
582 seg_size = total_size / nsegs;
584 current_offset = randomize;
585 while (length_so_far < total_size)
587 vec_add2 (generate, tp, 1);
588 len_this_chunk = clib_min (seg_size, total_size - length_so_far);
589 tp->offset = current_offset;
590 tp->len = len_this_chunk;
592 if (overlap && (len_this_chunk == seg_size))
595 offset_increment = len_this_chunk
596 % (1 + (random_u32 (&seed) % len_this_chunk));
598 while (offset_increment == 0);
600 offset_increment = len_this_chunk;
602 current_offset += offset_increment;
603 length_so_far = tp->offset + tp->len;
607 * Validate segment list. Only valid for non-overlap cases.
610 fifo_validate_pattern (vm, generate, vec_len (generate));
614 vlib_cli_output (vm, "raw data pattern:");
615 for (i = 0; i < vec_len (generate); i++)
617 vlib_cli_output (vm, "[%d] offset %u len %u", i,
618 generate[i].offset, generate[i].len);
622 /* Randomize data pattern */
625 for (i = 0; i < vec_len (generate) / 2; i++)
627 u32 src_index, dst_index;
628 test_pattern_t _tmp, *tmp = &_tmp;
630 src_index = random_u32 (&seed) % vec_len (generate);
631 dst_index = random_u32 (&seed) % vec_len (generate);
633 tmp[0] = generate[dst_index];
634 generate[dst_index] = generate[src_index];
635 generate[src_index] = tmp[0];
639 vlib_cli_output (vm, "randomized data pattern:");
640 for (i = 0; i < vec_len (generate); i++)
642 vlib_cli_output (vm, "[%d] offset %u len %u", i,
643 generate[i].offset, generate[i].len);
649 * Create a fifo and add segments
651 f = fifo_prepare (fifo_size);
653 /* manually set head and tail pointers to validate modular arithmetic */
654 fifo_initial_offset = fifo_initial_offset % fifo_size;
655 svm_fifo_init_pointers (f, fifo_initial_offset, fifo_initial_offset);
657 for (i = !randomize; i < vec_len (generate); i++)
660 svm_fifo_enqueue_with_offset (f,
661 fifo_initial_offset + tp->offset -
663 (u8 *) data_pattern + tp->offset);
666 /* Add the first segment in order for non random data */
668 svm_fifo_enqueue (f, generate[0].len, (u8 *) data_pattern);
671 * Expected result: one big fat chunk at offset 1 if randomize == 1
675 vlib_cli_output (vm, "fifo before missing link: %U",
676 format_svm_fifo, f, 1 /* verbose */ );
679 * Add the missing byte if segments were randomized
683 u32 bytes_to_enq = 1;
685 bytes_to_enq = total_size;
686 rv = svm_fifo_enqueue (f, bytes_to_enq, data_pattern + 0);
689 vlib_cli_output (vm, "in-order enqueue returned %d", rv);
691 SFIFO_TEST ((rv == total_size), "enqueued %u expected %u", rv,
696 SFIFO_TEST ((svm_fifo_has_ooo_data (f) == 0), "number of ooo segments %u",
697 svm_fifo_n_ooo_segments (f));
700 * Test if peeked data is the same as original data
702 vec_validate (data_buf, vec_len (data_pattern));
703 svm_fifo_peek (f, 0, vec_len (data_pattern), data_buf);
704 if (compare_data (data_buf, data_pattern, 0, vec_len (data_pattern), &j))
706 SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j],
709 vec_reset_length (data_buf);
712 * Dequeue or drop all data
716 svm_fifo_dequeue_drop (f, vec_len (data_pattern));
720 svm_fifo_dequeue (f, vec_len (data_pattern), data_buf);
722 (data_buf, data_pattern, 0, vec_len (data_pattern), &j))
724 SFIFO_TEST (0, "[%d] dequeued %u expected %u", j, data_buf[j],
729 SFIFO_TEST ((svm_fifo_max_dequeue (f) == 0), "fifo has %d bytes",
730 svm_fifo_max_dequeue (f));
733 vec_free (data_pattern);
740 sfifo_test_fifo4 (vlib_main_t * vm, unformat_input_t * input)
743 u32 fifo_size = 6 << 10;
744 u32 fifo_initial_offset = 1000000000;
745 u32 test_n_bytes = 5000, j;
746 u8 *test_data = 0, *data_buf = 0;
747 int i, rv, verbose = 0;
749 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
751 if (unformat (input, "verbose"))
755 clib_error_t *e = clib_error_return
756 (0, "unknown input `%U'", format_unformat_error, input);
757 clib_error_report (e);
763 * Create a fifo and add segments
765 f = fifo_prepare (fifo_size);
767 /* Set head and tail pointers */
768 fifo_initial_offset = fifo_initial_offset % fifo_size;
769 svm_fifo_init_pointers (f, fifo_initial_offset, fifo_initial_offset);
771 vec_validate (test_data, test_n_bytes - 1);
772 for (i = 0; i < vec_len (test_data); i++)
775 for (i = test_n_bytes - 1; i > 0; i--)
777 rv = svm_fifo_enqueue_with_offset (f, fifo_initial_offset + i - f->tail,
778 sizeof (u8), &test_data[i]);
780 vlib_cli_output (vm, "add [%d] [%d, %d]", i, i, i + sizeof (u8));
783 clib_warning ("enqueue returned %d", rv);
785 vec_free (test_data);
790 svm_fifo_enqueue (f, sizeof (u8), &test_data[0]);
792 vec_validate (data_buf, vec_len (test_data));
794 svm_fifo_dequeue (f, vec_len (test_data), data_buf);
795 rv = compare_data (data_buf, test_data, 0, vec_len (test_data), &j);
797 vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
799 SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
802 vec_free (test_data);
807 fifo_pos (svm_fifo_t * f, u32 pos)
809 return pos % f->size;
812 /* Avoids exposing svm_fifo.c internal function */
813 static ooo_segment_t *
814 ooo_seg_next (svm_fifo_t * f, ooo_segment_t * s)
816 if (pool_is_free_index (f->ooo_segments, s->next))
818 return pool_elt_at_index (f->ooo_segments, s->next);
822 sfifo_test_fifo5 (vlib_main_t * vm, unformat_input_t * input)
825 u32 fifo_size = 401, j = 0, offset = 200;
826 int i, rv, verbose = 0;
827 u8 *test_data = 0, *data_buf = 0;
828 ooo_segment_t *ooo_seg;
830 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
832 if (unformat (input, "verbose"))
836 clib_error_t *e = clib_error_return (0, "unknown input `%U'",
837 format_unformat_error, input);
838 clib_error_report (e);
843 f = fifo_prepare (fifo_size);
844 svm_fifo_init_pointers (f, offset, offset);
846 vec_validate (test_data, 399);
847 for (i = 0; i < vec_len (test_data); i++)
848 test_data[i] = i % 0xff;
851 * Start with [100, 200] and [300, 400]
853 svm_fifo_enqueue_with_offset (f, 100, 100, &test_data[100]);
854 svm_fifo_enqueue_with_offset (f, 300, 100, &test_data[300]);
856 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 2),
857 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
858 SFIFO_TEST ((f->ooos_newest == 1), "newest %u", f->ooos_newest);
860 vlib_cli_output (vm, "fifo after [100, 200] and [300, 400] : %U",
861 format_svm_fifo, f, 2 /* verbose */ );
867 rv = svm_fifo_enqueue_with_offset (f, 225, 50, &test_data[225]);
869 vlib_cli_output (vm, "fifo after [225, 275] : %U",
870 format_svm_fifo, f, 2 /* verbose */ );
871 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 3),
872 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
873 ooo_seg = svm_fifo_first_ooo_segment (f);
874 SFIFO_TEST ((ooo_seg->start == fifo_pos (f, 100 + offset)),
875 "first seg start %u expected %u", ooo_seg->start,
876 fifo_pos (f, 100 + offset));
877 SFIFO_TEST ((ooo_seg->length == 100), "first seg length %u expected %u",
878 ooo_seg->length, 100);
879 ooo_seg = ooo_seg_next (f, ooo_seg);
880 SFIFO_TEST ((ooo_seg->start == fifo_pos (f, 225 + offset)),
881 "second seg start %u expected %u",
882 ooo_seg->start, fifo_pos (f, 225 + offset));
883 SFIFO_TEST ((ooo_seg->length == 50), "second seg length %u expected %u",
884 ooo_seg->length, 50);
885 ooo_seg = ooo_seg_next (f, ooo_seg);
886 SFIFO_TEST ((ooo_seg->start == fifo_pos (f, 300 + offset)),
887 "third seg start %u expected %u",
888 ooo_seg->start, fifo_pos (f, 300 + offset));
889 SFIFO_TEST ((ooo_seg->length == 100), "third seg length %u expected %u",
890 ooo_seg->length, 100);
891 SFIFO_TEST ((f->ooos_newest == 2), "newest %u", f->ooos_newest);
895 rv = svm_fifo_enqueue_with_offset (f, 190, 120, &test_data[190]);
897 vlib_cli_output (vm, "fifo after [190, 310] : %U",
898 format_svm_fifo, f, 1 /* verbose */ );
899 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 1),
900 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
901 ooo_seg = svm_fifo_first_ooo_segment (f);
902 SFIFO_TEST ((ooo_seg->start == fifo_pos (f, offset + 100)),
903 "first seg start %u expected %u",
904 ooo_seg->start, fifo_pos (f, offset + 100));
905 SFIFO_TEST ((ooo_seg->length == 300), "first seg length %u expected %u",
906 ooo_seg->length, 300);
911 rv = svm_fifo_enqueue (f, 150, test_data);
914 vlib_cli_output (vm, "fifo after [0 150] : %U", format_svm_fifo, f,
917 SFIFO_TEST ((rv == 400), "managed to enqueue %u expected %u", rv, 400);
918 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 0),
919 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
921 vec_validate (data_buf, 399);
922 svm_fifo_peek (f, 0, 400, data_buf);
923 if (compare_data (data_buf, test_data, 0, 400, &j))
925 SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j],
930 * Add [100 200] and overlap it with [50 250]
933 f = fifo_prepare (fifo_size);
935 svm_fifo_enqueue_with_offset (f, 100, 100, &test_data[100]);
936 svm_fifo_enqueue_with_offset (f, 50, 200, &test_data[50]);
937 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 1),
938 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
939 ooo_seg = svm_fifo_first_ooo_segment (f);
940 SFIFO_TEST ((ooo_seg->start == 50), "first seg start %u expected %u",
942 SFIFO_TEST ((ooo_seg->length == 200), "first seg length %u expected %u",
943 ooo_seg->length, 200);
946 vec_free (test_data);
951 * Test ooo head/tail u32 wrapping
954 sfifo_test_fifo6 (vlib_main_t * vm, unformat_input_t * input)
956 u32 fifo_size = 101, n_test_bytes = 100;
957 int i, j, rv, __clib_unused verbose = 0;
958 u8 *test_data = 0, *data_buf = 0;
959 ooo_segment_t *ooo_seg;
962 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
964 if (unformat (input, "verbose"))
968 vlib_cli_output (vm, "parse error: '%U'", format_unformat_error,
974 f = fifo_prepare (fifo_size);
975 vec_validate (test_data, n_test_bytes - 1);
976 vec_validate (data_buf, n_test_bytes - 1);
977 for (i = 0; i < vec_len (test_data); i++)
978 test_data[i] = i % 0xff;
981 * Test ooo segment distance to/from tail with u32 wrap
985 * |0|---[start]--(len5)-->|0|--(len6)-->[end]---|0|
987 rv = f_distance_from (f, ~0 - 5, 5);
988 SFIFO_TEST (rv == 11, "distance to tail should be %u is %u", 11, rv);
990 rv = f_distance_to (f, ~0 - 5, 5);
991 SFIFO_TEST (rv == f->size - 11, "distance from tail should be %u is %u",
995 * |0|---[end]--(len5)-->|0|--(len6)-->[start]---|0|
997 rv = f_distance_to (f, 5, ~0 - 5);
998 SFIFO_TEST (rv == 11, "distance from tail should be %u is %u", 11, rv);
1000 rv = f_distance_from (f, 5, ~0 - 5);
1001 SFIFO_TEST (rv == f->size - 11, "distance to tail should be %u is %u",
1005 * Add ooo with tail and ooo segment start u32 wrap
1007 svm_fifo_init_pointers (f, ~0, ~0);
1008 svm_fifo_enqueue_with_offset (f, 10, 10, &test_data[10]);
1009 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 1),
1010 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
1011 ooo_seg = svm_fifo_first_ooo_segment (f);
1012 rv = ooo_segment_offset_prod (f, ooo_seg);
1013 SFIFO_TEST (rv == 10, "offset should be %u is %u", 10, rv);
1015 svm_fifo_enqueue (f, 10, test_data);
1016 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 0),
1017 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
1018 SFIFO_TEST (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX,
1019 "there should be no ooo seg");
1021 svm_fifo_peek (f, 5, 10, &data_buf[5]);
1022 if (compare_data (data_buf, test_data, 5, 10, (u32 *) & j))
1023 SFIFO_TEST (0, "[%d] dequeued %u expected %u", j, data_buf[j],
1026 svm_fifo_dequeue (f, 20, data_buf);
1027 if (compare_data (data_buf, test_data, 0, 20, (u32 *) & j))
1028 SFIFO_TEST (0, "[%d] dequeued %u expected %u", j, data_buf[j],
1032 * Force collect with tail u32 wrap and without ooo segment start u32 wrap
1034 svm_fifo_init_pointers (f, ~0 - 10, ~0 - 10);
1035 svm_fifo_enqueue_with_offset (f, 5, 15, &test_data[5]);
1036 svm_fifo_enqueue (f, 12, test_data);
1038 SFIFO_TEST ((svm_fifo_n_ooo_segments (f) == 0),
1039 "number of ooo segments %u", svm_fifo_n_ooo_segments (f));
1040 SFIFO_TEST (f->ooos_list_head == OOO_SEGMENT_INVALID_INDEX,
1041 "there should be no ooo seg");
1043 svm_fifo_dequeue (f, 20, data_buf);
1044 if (compare_data (data_buf, test_data, 0, 20, (u32 *) & j))
1045 SFIFO_TEST (0, "[%d] dequeued %u expected %u", j, data_buf[j],
1051 vec_free (test_data);
1052 vec_free (data_buf);
1058 * Multiple ooo enqueues and dequeues that force fifo tail/head wrap
1061 sfifo_test_fifo7 (vlib_main_t * vm, unformat_input_t * input)
1063 u32 fifo_size = 101, n_iterations = 100;
1064 int i, j, rv, __clib_unused verbose = 0;
1065 u8 *test_data = 0, *data_buf = 0;
1066 u64 n_test_bytes = 100;
1069 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1071 if (unformat (input, "verbose"))
1075 vlib_cli_output (vm, "parse error: '%U'", format_unformat_error,
1082 * Prepare data structures
1084 f = fifo_prepare (fifo_size);
1085 svm_fifo_init_pointers (f, ~0, ~0);
1087 vec_validate (test_data, n_test_bytes - 1);
1088 vec_validate (data_buf, n_test_bytes - 1);
1089 for (i = 0; i < vec_len (test_data); i++)
1090 test_data[i] = i % 0xff;
1093 * Run n iterations of test
1095 for (i = 0; i < n_iterations; i++)
1097 for (j = n_test_bytes - 1; j > 0; j -= 2)
1099 svm_fifo_enqueue_with_offset (f, j, 1, &test_data[j]);
1100 rv = svm_fifo_n_ooo_segments (f);
1101 if (rv != (n_test_bytes - j) / 2 + 1)
1102 SFIFO_TEST (0, "number of ooo segments expected %u is %u",
1103 (n_test_bytes - j) / 2 + 1, rv);
1106 svm_fifo_enqueue_with_offset (f, 1, n_test_bytes - 1, &test_data[1]);
1107 rv = svm_fifo_n_ooo_segments (f);
1109 SFIFO_TEST (0, "number of ooo segments %u", rv);
1111 svm_fifo_enqueue (f, 1, test_data);
1112 rv = svm_fifo_n_ooo_segments (f);
1114 SFIFO_TEST (0, "number of ooo segments %u", rv);
1116 svm_fifo_dequeue (f, n_test_bytes, data_buf);
1117 if (compare_data (data_buf, test_data, 0, n_test_bytes, (u32 *) & j))
1118 SFIFO_TEST (0, "[%d] dequeued %u expected %u", j, data_buf[j],
1120 svm_fifo_init_pointers (f, ~0 - i, ~0 - i);
1122 SFIFO_TEST (1, "passed multiple ooo enqueue/dequeue");
1127 vec_free (test_data);
1128 vec_free (data_buf);
1134 * Enqueue more than 4GB
1137 sfifo_test_fifo_large (vlib_main_t * vm, unformat_input_t * input)
1139 u32 n_iterations = 100, n_bytes_per_iter, half;
1140 int i, j, rv, __clib_unused verbose = 0;
1141 u8 *test_data = 0, *data_buf = 0;
1142 u64 n_test_bytes = 100;
1145 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1147 if (unformat (input, "verbose"))
1151 vlib_cli_output (vm, "parse error: '%U'", format_unformat_error,
1158 n_test_bytes = 5ULL << 30;
1159 n_iterations = 1 << 10;
1160 n_bytes_per_iter = n_test_bytes / n_iterations;
1162 f = fifo_prepare (n_bytes_per_iter + 1);
1163 svm_fifo_init_pointers (f, ~0, ~0);
1165 vec_validate (test_data, n_bytes_per_iter - 1);
1166 vec_validate (data_buf, n_bytes_per_iter - 1);
1167 for (i = 0; i < vec_len (test_data); i++)
1168 test_data[i] = i % 0xff;
1170 half = n_bytes_per_iter / 2;
1171 for (i = 0; i < n_iterations; i++)
1173 svm_fifo_enqueue_with_offset (f, half, half, &test_data[half]);
1174 svm_fifo_enqueue (f, half, test_data);
1175 rv = svm_fifo_n_ooo_segments (f);
1177 SFIFO_TEST (0, "number of ooo segments %u", rv);
1178 svm_fifo_dequeue (f, n_bytes_per_iter, data_buf);
1179 if (compare_data (data_buf, test_data, 0, n_bytes_per_iter,
1181 SFIFO_TEST (0, "[%d][%d] dequeued %u expected %u", i, j, data_buf[j],
1184 SFIFO_TEST (1, "passed large transfer");
1190 sfifo_test_fifo_grow (vlib_main_t * vm, unformat_input_t * input)
1192 int verbose = 0, fifo_size = 201, start_offset = 100, i, j, rv;
1193 int test_n_bytes, deq_bytes, enq_bytes, n_deqs, n_enqs;
1194 svm_fifo_chunk_t *c, *next, *prev;
1195 u8 *test_data = 0, *data_buf = 0;
1199 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1201 if (unformat (input, "verbose"))
1205 vlib_cli_output (vm, "parse error: '%U'", format_unformat_error,
1211 f = fifo_prepare (fifo_size);
1212 svm_fifo_init_pointers (f, start_offset, start_offset);
1215 * Add with fifo not wrapped
1217 c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
1222 svm_fifo_add_chunk (f, c);
1224 SFIFO_TEST (f->size == fifo_size + 100, "size expected %u is %u",
1225 fifo_size + 100, f->size);
1226 SFIFO_TEST (c->start_byte == fifo_size, "start byte expected %u is %u",
1227 fifo_size, c->start_byte);
1230 * Add with fifo wrapped
1233 svm_fifo_init_pointers (f, f->nitems - 100, f->nitems + 100);
1234 c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
1239 svm_fifo_add_chunk (f, c);
1241 SFIFO_TEST (f->end_chunk != c, "tail chunk should not be updated");
1242 SFIFO_TEST (f->size == fifo_size + 100, "size expected %u is %u",
1243 fifo_size + 100, f->size);
1244 SFIFO_TEST (c->start_byte == fifo_size + 100, "start byte expected %u is "
1245 " %u", fifo_size + 100, c->start_byte);
1250 vec_validate (data_buf, 200);
1251 svm_fifo_dequeue (f, 201, data_buf);
1253 SFIFO_TEST (f->end_chunk == c, "tail chunk should be updated");
1254 SFIFO_TEST (f->size == fifo_size + 200, "size expected %u is %u",
1255 fifo_size + 200, f->size);
1256 SFIFO_TEST (c->start_byte == fifo_size + 100, "start byte expected %u is "
1257 "%u", fifo_size + 100, c->start_byte);
1262 svm_fifo_init_pointers (f, f->nitems - 100, f->nitems + 100);
1265 for (i = 0; i < 5; i++)
1267 c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
1274 svm_fifo_add_chunk (f, c);
1275 SFIFO_TEST (f->size == fifo_size + 200, "size expected %u is %u",
1276 fifo_size + 200, f->size);
1279 for (i = 0; i < 5; i++)
1281 c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
1288 svm_fifo_add_chunk (f, c);
1289 SFIFO_TEST (f->size == fifo_size + 200, "size expected %u is %u",
1290 fifo_size + 200, f->size);
1293 svm_fifo_dequeue (f, 101, data_buf);
1295 SFIFO_TEST (f->size == fifo_size + 200 + 10 * 100, "size expected %u is %u",
1296 fifo_size + 200 + 10 * 100, f->size);
1297 SFIFO_TEST (f->tail == old_tail, "new tail expected %u is %u", old_tail,
1301 * Enqueue/dequeue tests
1304 test_n_bytes = f->nitems;
1305 vec_validate (test_data, test_n_bytes - 1);
1306 vec_validate (data_buf, vec_len (test_data));
1307 n_deqs = n_enqs = 6;
1308 deq_bytes = enq_bytes = vec_len (test_data) / n_deqs;
1310 for (i = 0; i < vec_len (test_data); i++)
1314 * Enqueue/deq boundary conditions
1316 svm_fifo_init_pointers (f, 201, 201);
1317 SFIFO_TEST (f->tail_chunk->start_byte == 201, "start byte expected %u is "
1318 "%u", 201, f->tail_chunk->start_byte);
1320 svm_fifo_enqueue (f, 200, test_data);
1321 SFIFO_TEST (f->tail_chunk->start_byte == 401, "start byte expected %u is "
1322 "%u", 401, f->tail_chunk->start_byte);
1324 svm_fifo_dequeue (f, 200, data_buf);
1325 SFIFO_TEST (f->head_chunk->start_byte == 401, "start byte expected %u is "
1326 "%u", 401, f->head_chunk->start_byte);
1329 * Simple enqueue/deq and data validation (1)
1331 svm_fifo_init_pointers (f, f->nitems / 2, f->nitems / 2);
1332 for (i = 0; i < test_n_bytes; i++)
1334 rv = svm_fifo_enqueue (f, sizeof (u8), &test_data[i]);
1337 clib_warning ("enqueue returned %d", rv);
1342 SFIFO_TEST (svm_fifo_max_dequeue (f) == test_n_bytes, "max deq expected %u "
1343 "is %u", test_n_bytes, svm_fifo_max_dequeue (f));
1345 for (i = 0; i < test_n_bytes; i++)
1346 svm_fifo_dequeue (f, 1, &data_buf[i]);
1348 rv = compare_data (data_buf, test_data, 0, vec_len (test_data),
1351 vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
1353 SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
1356 * Simple enqueue/deq and data validation (2)
1358 for (i = 0; i <= n_enqs; i++)
1360 rv = svm_fifo_enqueue (f, enq_bytes, test_data + i * enq_bytes);
1363 clib_warning ("enqueue returned %d", rv);
1368 SFIFO_TEST (svm_fifo_max_dequeue (f) == test_n_bytes, "max deq expected %u "
1369 "is %u", test_n_bytes, svm_fifo_max_dequeue (f));
1371 for (i = 0; i <= n_deqs; i++)
1372 svm_fifo_dequeue (f, deq_bytes, data_buf + i * deq_bytes);
1374 rv = compare_data (data_buf, test_data, 0, vec_len (test_data),
1377 vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
1379 SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
1382 * OOO enqueues/dequeues and data validation (1)
1384 for (i = test_n_bytes - 1; i > 0; i--)
1386 rv = svm_fifo_enqueue_with_offset (f, i, sizeof (u8), &test_data[i]);
1388 vlib_cli_output (vm, "add [%d] [%d, %d]", i, i, i + sizeof (u8));
1391 clib_warning ("enqueue returned %d", rv);
1396 SFIFO_TEST (svm_fifo_max_dequeue (f) == 0, "max deq expected %u is %u",
1397 0, svm_fifo_max_dequeue (f));
1399 svm_fifo_enqueue (f, sizeof (u8), &test_data[0]);
1401 memset (data_buf, 0, vec_len (data_buf));
1402 for (i = 0; i <= n_deqs; i++)
1403 svm_fifo_dequeue (f, deq_bytes, data_buf + i * deq_bytes);
1405 rv = compare_data (data_buf, test_data, 0, vec_len (test_data),
1408 vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
1410 SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
1413 * OOO enqueues/dequeues and data validation (2)
1416 for (i = n_enqs; i > 0; i--)
1418 u32 enq_now = clib_min (enq_bytes, vec_len (test_data) - i * enq_bytes);
1419 rv = svm_fifo_enqueue_with_offset (f, i * enq_bytes, enq_now,
1420 test_data + i * enq_bytes);
1422 vlib_cli_output (vm, "add [%d, %d]", i * enq_bytes,
1423 i * enq_bytes + enq_now);
1426 clib_warning ("enqueue returned %d", rv);
1431 svm_fifo_enqueue (f, enq_bytes, &test_data[0]);
1433 memset (data_buf, 0, vec_len (data_buf));
1434 for (i = 0; i <= n_deqs; i++)
1435 svm_fifo_dequeue (f, deq_bytes, data_buf + i * deq_bytes);
1437 rv = compare_data (data_buf, test_data, 0, vec_len (test_data),
1440 vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
1442 SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
1450 c = f->start_chunk->next;
1451 while (c && c != f->start_chunk)
1459 vec_free (test_data);
1460 vec_free (data_buf);
1465 chunk_list_len (svm_fifo_chunk_t * c)
1467 svm_fifo_chunk_t *it;
1475 while (it && it != c)
1484 chunk_list_free (svm_fifo_chunk_t * c, svm_fifo_chunk_t * stop)
1486 svm_fifo_chunk_t *it, *next;
1489 while (it && it != stop)
1498 chunk_list_splice (svm_fifo_chunk_t * a, svm_fifo_chunk_t * b)
1500 svm_fifo_chunk_t *it;
1509 sfifo_test_fifo_shrink (vlib_main_t * vm, unformat_input_t * input)
1511 int __clib_unused verbose = 0, fifo_size = 101, chunk_size = 100;
1512 int i, rv, test_n_bytes, diff, deq_bytes;
1513 svm_fifo_chunk_t *c, *prev, *collected;
1514 u8 *test_data = 0, *data_buf = 0;
1517 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1519 if (unformat (input, "verbose"))
1523 vlib_cli_output (vm, "parse error: '%U'", format_unformat_error,
1530 * Init fifo with multiple chunks
1532 f = fifo_prepare (fifo_size);
1533 svm_fifo_init_pointers (f, 0, 0);
1536 for (i = 0; i < 11; i++)
1538 c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + chunk_size);
1545 svm_fifo_add_chunk (f, c);
1546 SFIFO_TEST (f->size == 12 * chunk_size + 1, "size expected %u is %u",
1547 12 * chunk_size + 1, f->size);
1550 * No fifo wrap and no chunk used (one chunk)
1552 rv = svm_fifo_reduce_size (f, chunk_size, 0);
1553 SFIFO_TEST (rv == chunk_size, "len expected %u is %u", chunk_size, rv);
1554 SFIFO_TEST (f->size == 12 * chunk_size + 1, "size expected %u is %u",
1555 12 * chunk_size + 1, f->size);
1556 SFIFO_TEST (f->flags & SVM_FIFO_F_SHRINK, "shrink flag should be set");
1558 /* Check enqueue space to force size reduction */
1559 (void) svm_fifo_max_enqueue (f);
1561 SFIFO_TEST (f->size == 11 * chunk_size + 1, "size expected %u is %u",
1562 11 * chunk_size + 1, f->size);
1563 SFIFO_TEST (f->flags & SVM_FIFO_F_COLLECT_CHUNKS, "collect flag should"
1565 SFIFO_TEST (!(f->flags & SVM_FIFO_F_SHRINK), "shrink flag should not be"
1568 collected = c = svm_fifo_collect_chunks (f);
1569 rv = chunk_list_len (c);
1570 SFIFO_TEST (rv == 1, "expected %u chunks got %u", 1, rv);
1571 rv = chunk_list_len (f->start_chunk);
1572 SFIFO_TEST (rv == 11, "expected %u chunks got %u", 11, rv);
1573 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1577 * Fifo wrap and multiple chunks used
1580 /* Init test data and fifo */
1581 test_n_bytes = f->nitems;
1582 vec_validate (test_data, test_n_bytes - 1);
1583 vec_validate (data_buf, vec_len (test_data));
1585 for (i = 0; i < vec_len (test_data); i++)
1588 svm_fifo_init_pointers (f, f->size / 2, f->size / 2);
1589 for (i = 0; i < test_n_bytes; i++)
1591 rv = svm_fifo_enqueue (f, sizeof (u8), &test_data[i]);
1593 SFIFO_TEST (0, "enqueue returned");
1596 /* Try to reduce fifo size with fifo full */
1597 rv = svm_fifo_reduce_size (f, 3.5 * chunk_size, 0);
1598 SFIFO_TEST (rv == 3 * chunk_size, "len expected %u is %u", 3 * chunk_size,
1600 SFIFO_TEST (f->size == 11 * chunk_size + 1, "size expected %u is %u",
1601 11 * chunk_size + 1, f->size);
1602 SFIFO_TEST (f->flags & SVM_FIFO_F_SHRINK, "shrink flag should be set");
1604 /* Check enqueue space to try size reduction. Should not work */
1605 rv = svm_fifo_max_enqueue (f);
1607 SFIFO_TEST (rv == 0, "free space expected %u is %u", 0, rv);
1608 SFIFO_TEST (f->size == 11 * chunk_size + 1, "size expected %u is %u",
1609 11 * chunk_size + 1, f->size);
1610 SFIFO_TEST (f->flags & SVM_FIFO_F_SHRINK, "shrink flag should be set");
1611 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1614 /* Dequeue byte-by-byte up to last byte on last chunk */
1615 deq_bytes = f->size - f->size / 2 - 1;
1616 for (i = 0; i < deq_bytes; i++)
1618 (void) svm_fifo_max_enqueue (f);
1619 rv = svm_fifo_dequeue (f, 1, &data_buf[i]);
1621 SFIFO_TEST (0, "dequeue returned");
1624 rv = svm_fifo_max_enqueue (f);
1626 /* We've dequeued more than 3*chunk_size so nitems should be updated */
1627 SFIFO_TEST (f->nitems == 8 * chunk_size, "nitems expected %u is %u",
1628 8 * chunk_size, f->nitems);
1629 /* Free space should be what was dequeued - 3 * chunk_size, which was
1630 * consumed by shrinking the fifo */
1631 diff = deq_bytes - 3 * chunk_size;
1632 SFIFO_TEST (rv == diff, "free space expected %u is %u", diff, rv);
1633 SFIFO_TEST (f->size == 11 * chunk_size + 1, "size expected %u is %u",
1634 11 * chunk_size + 1, f->size);
1635 SFIFO_TEST (f->flags & SVM_FIFO_F_SHRINK, "shrink flag should be set");
1636 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1639 /* Dequeue one more such that head goes beyond last chunk */
1640 rv = svm_fifo_dequeue (f, 1, &data_buf[deq_bytes]);
1642 SFIFO_TEST (0, "dequeue returned");
1644 rv = svm_fifo_max_enqueue (f);
1645 SFIFO_TEST (f->nitems == 8 * chunk_size, "nitems expected %u is %u",
1646 8 * chunk_size, f->nitems);
1647 SFIFO_TEST (rv == diff + 1, "free space expected %u is %u", diff + 1, rv);
1648 SFIFO_TEST (f->size == 8 * chunk_size + 1, "size expected %u is %u",
1649 8 * chunk_size + 1, f->size);
1650 SFIFO_TEST (!(f->flags & SVM_FIFO_F_SHRINK), "shrink flag should not be"
1652 SFIFO_TEST (f->flags & SVM_FIFO_F_COLLECT_CHUNKS, "collect flag should"
1655 /* Dequeue the rest of the data */
1657 for (i = 0; i < test_n_bytes - deq_bytes; i++)
1659 rv = svm_fifo_dequeue (f, 1, &data_buf[i + deq_bytes]);
1661 SFIFO_TEST (0, "dequeue returned");
1664 rv = svm_fifo_max_enqueue (f);
1666 SFIFO_TEST (f->size == 8 * chunk_size + 1, "size expected %u is %u",
1667 8 * chunk_size + 1, f->size);
1668 SFIFO_TEST (rv == 8 * chunk_size, "free space expected %u is %u",
1669 8 * chunk_size, rv);
1671 rv = compare_data (data_buf, test_data, 0, vec_len (test_data),
1674 SFIFO_TEST (0, "[%d] dequeued %u expected %u", i, data_buf[i],
1677 c = svm_fifo_collect_chunks (f);
1678 rv = chunk_list_len (c);
1679 SFIFO_TEST (rv == 3, "expected %u chunks got %u", 3, rv);
1680 rv = chunk_list_len (f->start_chunk);
1681 SFIFO_TEST (rv == 8, "expected %u chunks got %u", 8, rv);
1682 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1686 * OOO segment on chunk that should be removed
1689 svm_fifo_add_chunk (f, c);
1690 SFIFO_TEST (f->size == 11 * chunk_size + 1, "size expected %u is %u",
1691 11 * chunk_size + 1, f->size);
1693 memset (data_buf, 0, vec_len (data_buf));
1694 svm_fifo_init_pointers (f, f->size / 2, f->size / 2);
1695 svm_fifo_enqueue (f, 200, test_data);
1696 svm_fifo_enqueue_with_offset (f, 50, vec_len (test_data) - 250,
1700 rv = svm_fifo_max_enqueue (f);
1701 SFIFO_TEST (rv == vec_len (test_data) - 200, "free space expected %u is %u",
1702 vec_len (test_data) - 200, rv);
1704 /* Ask to reduce size */
1705 rv = svm_fifo_reduce_size (f, 3.5 * chunk_size, 0);
1706 SFIFO_TEST (rv == 3 * chunk_size, "len expected %u is %u", 3 * chunk_size,
1708 SFIFO_TEST (f->size == 11 * chunk_size + 1, "size expected %u is %u",
1709 11 * chunk_size + 1, f->size);
1710 SFIFO_TEST (f->flags & SVM_FIFO_F_SHRINK, "shrink flag should be set");
1712 /* Try to force size reduction but it should fail */
1713 rv = svm_fifo_max_enqueue (f);
1715 SFIFO_TEST (rv == vec_len (test_data) - 200, "free space expected %u is %u",
1716 vec_len (test_data) - 200, rv);
1717 SFIFO_TEST (f->size == 11 * chunk_size + 1, "size expected %u is %u",
1718 11 * chunk_size + 1, f->size);
1719 SFIFO_TEST (f->flags & SVM_FIFO_F_SHRINK, "shrink flag should be set");
1720 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1723 /* Dequeue the in order data. This should shrink nitems */
1724 rv = svm_fifo_dequeue (f, 200, data_buf);
1726 SFIFO_TEST (0, "dequeue returned");
1728 rv = svm_fifo_max_enqueue (f);
1729 SFIFO_TEST (rv == vec_len (test_data) - 200, "free space expected %u is %u",
1730 vec_len (test_data) - 200, rv);
1731 SFIFO_TEST (f->size == 11 * chunk_size + 1, "size expected %u is %u",
1732 11 * chunk_size + 1, f->size);
1733 SFIFO_TEST (f->nitems == 11 * chunk_size - 200, "nitems expected %u is %u",
1734 11 * chunk_size - 200, f->nitems);
1735 SFIFO_TEST (f->flags & SVM_FIFO_F_SHRINK, "shrink flag should be set");
1736 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1739 /* Enqueue the missing 50 bytes. Fifo will become full */
1740 rv = svm_fifo_enqueue (f, 50, &test_data[200]);
1741 SFIFO_TEST (rv == vec_len (test_data) - 200, "free space expected %u is %u",
1742 vec_len (test_data) - 200, rv);
1744 rv = svm_fifo_max_enqueue (f);
1746 SFIFO_TEST (rv == 0, "free space expected %u is %u", 0, rv);
1747 SFIFO_TEST (f->size == 11 * chunk_size + 1, "size expected %u is %u",
1748 11 * chunk_size + 1, f->size);
1749 SFIFO_TEST (f->flags & SVM_FIFO_F_SHRINK, "shrink flag should be set");
1750 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1754 /* Dequeue a chunk and check nitems shrink but fifo still full */
1755 svm_fifo_dequeue (f, 100, &data_buf[200]);
1757 rv = svm_fifo_max_enqueue (f);
1759 SFIFO_TEST (rv == 0, "free space expected %u is %u", 0, rv);
1760 SFIFO_TEST (f->size == 11 * chunk_size + 1, "size expected %u is %u",
1761 11 * chunk_size + 1, f->size);
1762 SFIFO_TEST (f->nitems == 11 * chunk_size - 300, "nitems expected %u is %u",
1763 11 * chunk_size - 300, f->nitems);
1764 SFIFO_TEST (f->flags & SVM_FIFO_F_SHRINK, "shrink flag should be set");
1765 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1768 /* Dequeue enough to unwrap the fifo */
1769 deq_bytes = f->size - f->size / 2 - 300;
1770 svm_fifo_dequeue (f, deq_bytes, &data_buf[300]);
1771 rv = svm_fifo_max_enqueue (f);
1773 /* Overall we've dequeued deq_bytes + 300, but fifo size shrunk 300 */
1774 SFIFO_TEST (rv == 300 + deq_bytes - 300, "free space expected %u is %u",
1775 300 + deq_bytes - 300, rv);
1776 SFIFO_TEST (f->size == 8 * chunk_size + 1, "size expected %u is %u",
1777 8 * chunk_size + 1, f->size);
1778 SFIFO_TEST (f->nitems == 8 * chunk_size, "nitems expected %u is %u",
1779 8 * chunk_size, f->nitems);
1780 SFIFO_TEST (!(f->flags & SVM_FIFO_F_SHRINK), "shrink flag should not be"
1782 SFIFO_TEST (f->flags & SVM_FIFO_F_COLLECT_CHUNKS, "collect flag should"
1785 /* Dequeue the rest */
1786 svm_fifo_dequeue (f, test_n_bytes / 2, &data_buf[300 + deq_bytes]);
1787 rv = compare_data (data_buf, test_data, 0, vec_len (test_data),
1790 SFIFO_TEST (0, "[%d] dequeued %u expected %u", i, data_buf[i],
1793 c = svm_fifo_collect_chunks (f);
1794 rv = chunk_list_len (c);
1795 SFIFO_TEST (rv == 3, "expected %u chunks got %u", 3, rv);
1796 rv = chunk_list_len (f->start_chunk);
1797 SFIFO_TEST (rv == 8, "expected %u chunks got %u", 8, rv);
1798 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1801 chunk_list_splice (collected, c);
1804 * Remove all chunks possible
1806 svm_fifo_init_pointers (f, 601, 601);
1807 rv = svm_fifo_reduce_size (f, 8 * chunk_size, 1);
1808 SFIFO_TEST (rv == 7 * chunk_size, "actual len expected %u is %u",
1809 7 * chunk_size, rv);
1810 SFIFO_TEST (f->size == 6 * chunk_size + 1, "size expected %u is %u",
1811 6 * chunk_size + 1, f->size);
1812 SFIFO_TEST (f->nitems == 1 * chunk_size, "nitems expected %u is %u",
1813 1 * chunk_size, f->nitems);
1814 SFIFO_TEST (f->flags & SVM_FIFO_F_SHRINK, "shrink flag should be set");
1815 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1818 rv = svm_fifo_max_enqueue (f);
1819 SFIFO_TEST (rv == chunk_size, "free space expected %u is %u", chunk_size,
1822 /* Force head/tail to move to first chunk */
1823 svm_fifo_enqueue (f, 1, test_data);
1824 svm_fifo_dequeue (f, 1, data_buf);
1825 rv = svm_fifo_max_enqueue (f);
1827 SFIFO_TEST (rv == chunk_size, "free space expected %u is %u", chunk_size,
1829 SFIFO_TEST (f->size == chunk_size + 1, "size expected %u is %u",
1830 chunk_size + 1, f->size);
1831 SFIFO_TEST (!(f->flags & SVM_FIFO_F_SHRINK), "shrink flag should not be"
1833 SFIFO_TEST (f->flags & SVM_FIFO_F_COLLECT_CHUNKS, "collect flag should"
1836 c = svm_fifo_collect_chunks (f);
1837 rv = chunk_list_len (c);
1838 SFIFO_TEST (rv == 7, "expected %u chunks got %u", 7, rv);
1839 SFIFO_TEST (!(f->flags & SVM_FIFO_F_COLLECT_CHUNKS), "collect flag should"
1841 SFIFO_TEST (!(f->flags & SVM_FIFO_F_MULTI_CHUNK), "multi-chunk flag should"
1844 chunk_list_splice (collected, c);
1850 chunk_list_free (f->start_chunk->next, f->start_chunk);
1851 chunk_list_free (collected, 0);
1853 vec_free (test_data);
1854 vec_free (data_buf);
1860 svm_fifo_trace_elem_t fifo_trace[] = {};
1864 sfifo_test_fifo_replay (vlib_main_t * vm, unformat_input_t * input)
1868 u8 no_read = 0, *str = 0;
1870 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1872 if (unformat (input, "verbose"))
1874 else if (unformat (input, "no-read"))
1878 clib_error_t *e = clib_error_return
1879 (0, "unknown input `%U'", format_unformat_error, input);
1880 clib_error_report (e);
1886 f.trace = fifo_trace;
1889 str = svm_fifo_replay (str, &f, no_read, verbose);
1890 vlib_cli_output (vm, "%v", str);
1894 static fifo_segment_main_t segment_main;
1897 sfifo_test_fifo_segment_hello_world (int verbose)
1899 fifo_segment_create_args_t _a, *a = &_a;
1900 fifo_segment_main_t *sm = &segment_main;
1901 u8 *test_data, *retrieved_data = 0;
1906 clib_memset (a, 0, sizeof (*a));
1907 a->segment_name = "fifo-test1";
1908 a->segment_size = 256 << 10;
1910 rv = fifo_segment_create (sm, a);
1911 SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
1913 fs = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1914 f = fifo_segment_alloc_fifo (fs, 4096, FIFO_SEGMENT_RX_FIFO);
1916 SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo");
1918 test_data = format (0, "Hello world%c", 0);
1919 vec_validate (retrieved_data, vec_len (test_data) - 1);
1921 while (svm_fifo_max_enqueue (f) >= vec_len (test_data))
1922 svm_fifo_enqueue (f, vec_len (test_data), test_data);
1924 while (svm_fifo_max_dequeue (f) >= vec_len (test_data))
1925 svm_fifo_dequeue (f, vec_len (retrieved_data), retrieved_data);
1927 while (svm_fifo_max_enqueue (f) >= vec_len (test_data))
1928 svm_fifo_enqueue (f, vec_len (test_data), test_data);
1930 while (svm_fifo_max_dequeue (f) >= vec_len (test_data))
1931 svm_fifo_dequeue (f, vec_len (retrieved_data), retrieved_data);
1933 SFIFO_TEST (!memcmp (retrieved_data, test_data, vec_len (test_data)),
1934 "data should be identical");
1936 vec_free (test_data);
1937 vec_free (retrieved_data);
1938 vec_free (a->new_segment_indices);
1939 fifo_segment_free_fifo (fs, f);
1940 fifo_segment_delete (sm, fs);
1945 sfifo_test_fifo_segment_fifo_grow (int verbose)
1947 int rv, fifo_size = 4096, n_chunks, n_batch;
1948 fifo_segment_main_t *sm = &segment_main;
1949 fifo_segment_create_args_t _a, *a = &_a;
1950 u32 n_free_chunk_bytes;
1954 clib_memset (a, 0, sizeof (*a));
1955 a->segment_name = "fifo-test1";
1956 /* size chosen to be able to force multi chunk allocation lower */
1957 a->segment_size = 208 << 10;
1959 /* fifo allocation allocates chunks in batch */
1960 n_batch = FIFO_SEGMENT_ALLOC_BATCH_SIZE;
1962 rv = fifo_segment_create (sm, a);
1964 SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
1967 * Alloc and grow fifo
1969 fs = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1970 f = fifo_segment_alloc_fifo (fs, fifo_size, FIFO_SEGMENT_RX_FIFO);
1972 SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo");
1974 n_chunks = fifo_segment_num_free_chunks (fs, fifo_size);
1975 SFIFO_TEST (n_chunks == n_batch - 1, "free 2^10B chunks "
1976 "should be %u is %u", n_batch - 1, n_chunks);
1977 rv = fifo_segment_fl_chunk_bytes (fs);
1978 SFIFO_TEST (rv == (n_batch - 1) * fifo_size, "free chunk bytes %u "
1979 "expected %u", rv, (n_batch - 1) * fifo_size);
1981 fifo_segment_grow_fifo (fs, f, fifo_size);
1982 SFIFO_TEST (f->size == 2 * fifo_size, "fifo size should be %u is %u",
1983 2 * fifo_size, f->size);
1985 n_chunks = fifo_segment_num_free_chunks (fs, fifo_size);
1986 SFIFO_TEST (n_chunks == n_batch - 2, "free 2^10B chunks "
1987 "should be %u is %u", n_batch - 2, n_chunks);
1988 rv = fifo_segment_fl_chunk_bytes (fs);
1989 SFIFO_TEST (rv == (n_batch - 2) * fifo_size, "free chunk bytes %u "
1990 "expected %u", rv, (n_batch - 2) * fifo_size);
1992 fifo_segment_grow_fifo (fs, f, 16 * fifo_size);
1993 SFIFO_TEST (f->size == 18 * fifo_size, "fifo size should be %u is %u",
1994 18 * fifo_size, f->size);
1996 rv = fifo_segment_fl_chunk_bytes (fs);
1997 SFIFO_TEST (rv == (n_batch - 2) * fifo_size, "free chunk bytes %u "
1998 "expected %u", rv, (n_batch - 2) * fifo_size);
2001 * Free and test free list size
2003 fifo_segment_free_fifo (fs, f);
2005 rv = fifo_segment_fl_chunk_bytes (fs);
2006 SFIFO_TEST (rv == (16 + n_batch) * fifo_size, "free chunk bytes expected %u"
2007 " is %u", (16 + n_batch) * fifo_size, rv);
2008 n_chunks = fifo_segment_num_free_chunks (fs, fifo_size);
2009 SFIFO_TEST (n_chunks == n_batch, "free 2^10B chunks "
2010 "should be %u is %u", n_batch, n_chunks);
2011 n_chunks = fifo_segment_num_free_chunks (fs, 16 * fifo_size);
2012 SFIFO_TEST (n_chunks == 1, "free 2^14B chunks should be %u is %u", 1,
2014 n_chunks = fifo_segment_num_free_chunks (fs, ~0);
2015 SFIFO_TEST (n_chunks == 1 + n_batch, "free chunks should be %u is %u",
2016 1 + n_batch, n_chunks);
2021 f = fifo_segment_alloc_fifo (fs, fifo_size, FIFO_SEGMENT_RX_FIFO);
2023 fifo_segment_grow_fifo (fs, f, fifo_size);
2024 n_chunks = fifo_segment_num_free_chunks (fs, fifo_size);
2025 SFIFO_TEST (n_chunks == n_batch - 2, "free 2^10B chunks should be %u is %u",
2026 n_batch - 2, n_chunks);
2028 fifo_segment_grow_fifo (fs, f, 16 * fifo_size);
2029 n_chunks = fifo_segment_num_free_chunks (fs, 16 * fifo_size);
2030 SFIFO_TEST (n_chunks == 0, "free 2^14B chunks should be %u is %u", 0,
2032 n_chunks = fifo_segment_num_free_chunks (fs, ~0);
2033 SFIFO_TEST (n_chunks == n_batch - 2, "free chunks should be %u is %u",
2034 n_batch - 2, n_chunks);
2039 fifo_segment_free_fifo (fs, f);
2040 n_chunks = fifo_segment_num_free_chunks (fs, ~0);
2041 SFIFO_TEST (n_chunks == 1 + n_batch, "free chunks should be %u is %u",
2042 1 + n_batch, n_chunks);
2044 rv = fifo_segment_fl_chunk_bytes (fs);
2045 SFIFO_TEST (rv == (16 + n_batch) * fifo_size, "free chunk bytes expected %u"
2046 " is %u", (16 + n_batch) * fifo_size, rv);
2048 n_free_chunk_bytes = rv;
2051 * Allocate non power of 2 fifo/chunk and check that free chunk bytes
2052 * is correctly updated
2055 f = fifo_segment_alloc_fifo (fs, 16 * fifo_size - 1, FIFO_SEGMENT_RX_FIFO);
2056 rv = fifo_segment_fl_chunk_bytes (fs);
2058 SFIFO_TEST (n_free_chunk_bytes - 16 * fifo_size == rv, "free chunk bytes "
2059 "expected %u is %u", n_free_chunk_bytes - 16 * fifo_size, rv);
2061 fifo_segment_free_fifo (fs, f);
2062 rv = fifo_segment_fl_chunk_bytes (fs);
2064 SFIFO_TEST (n_free_chunk_bytes == rv, "free chunk bytes expected %u is %u",
2065 n_free_chunk_bytes, rv);
2068 * Force multi chunk fifo allocation
2071 f = fifo_segment_alloc_fifo (fs, 17 * fifo_size, FIFO_SEGMENT_RX_FIFO);
2072 rv = fifo_segment_fl_chunk_bytes (fs);
2074 /* Make sure that the non-power of two chunk freed above is correctly
2075 * accounted for in the chunk free bytes reduction due to chunk allocation
2076 * for the fifo, i.e., it's rounded up by 1 */
2077 SFIFO_TEST (n_free_chunk_bytes - 17 * fifo_size == rv, "free chunk bytes "
2078 "expected %u is %u", n_free_chunk_bytes - 17 * fifo_size, rv);
2080 fifo_segment_free_fifo (fs, f);
2082 rv = fifo_segment_fl_chunk_bytes (fs);
2083 SFIFO_TEST (n_free_chunk_bytes == rv, "free chunk bytes expected %u is %u",
2084 n_free_chunk_bytes, rv);
2087 * Allocate fifo that has all chunks
2089 f = fifo_segment_alloc_fifo (fs, n_free_chunk_bytes, FIFO_SEGMENT_RX_FIFO);
2090 SFIFO_TEST (f != 0, "allocation should work");
2092 fifo_segment_free_fifo (fs, f);
2094 rv = fifo_segment_fl_chunk_bytes (fs);
2095 SFIFO_TEST (n_free_chunk_bytes == rv, "free chunk bytes expected %u is %u",
2096 n_free_chunk_bytes, rv);
2099 * Try to allocate more than space available
2102 f = fifo_segment_alloc_fifo (fs, n_free_chunk_bytes + fifo_size,
2103 FIFO_SEGMENT_RX_FIFO);
2104 SFIFO_TEST (f == 0, "allocation should fail");
2107 * Allocate fifo and try to grow beyond available space
2109 f = fifo_segment_alloc_fifo (fs, fifo_size, FIFO_SEGMENT_RX_FIFO);
2110 rv = fifo_segment_grow_fifo (fs, f, n_free_chunk_bytes);
2112 SFIFO_TEST (rv == -1, "grow should fail");
2114 fifo_segment_free_fifo (fs, f);
2119 fifo_segment_delete (sm, fs);
2120 vec_free (a->new_segment_indices);
2125 sfifo_test_fifo_segment_fifo_shrink (int verbose)
2127 int i, rv, chunk_size = 4096, n_chunks, n_free;
2128 fifo_segment_main_t *sm = &segment_main;
2129 fifo_segment_create_args_t _a, *a = &_a;
2133 clib_memset (a, 0, sizeof (*a));
2134 a->segment_name = "fifo-test1";
2135 a->segment_size = 256 << 10;
2137 rv = fifo_segment_create (sm, a);
2139 SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
2142 * Alloc and grow fifo
2144 fs = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
2145 f = fifo_segment_alloc_fifo (fs, chunk_size, FIFO_SEGMENT_RX_FIFO);
2146 n_free = FIFO_SEGMENT_ALLOC_BATCH_SIZE - 1;
2148 SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo");
2150 for (i = 0; i < 9; i++)
2152 fifo_segment_grow_fifo (fs, f, chunk_size);
2154 if (f->size != (i + 2) * chunk_size)
2155 SFIFO_TEST (0, "fifo size should be %u is %u",
2156 (i + 2) * chunk_size, f->size);
2159 rv = svm_fifo_reduce_size (f, 3.5 * chunk_size, 1 /* is producer */ );
2160 SFIFO_TEST (rv == 3 * chunk_size, "len expected %u is %u", 3 * chunk_size,
2163 n_chunks = fifo_segment_num_free_chunks (fs, chunk_size);
2164 SFIFO_TEST (n_chunks == n_free, "free chunks should be %u is %u", n_free,
2167 fifo_segment_collect_fifo_chunks (fs, f);
2170 n_chunks = fifo_segment_num_free_chunks (fs, chunk_size);
2171 SFIFO_TEST (n_chunks == n_free, "free chunks should be %u is %u", n_free,
2174 rv = svm_fifo_reduce_size (f, 7 * chunk_size - 1, 1 /* is producer */ );
2175 SFIFO_TEST (rv == 6 * chunk_size, "len expected %u is %u", 6 * chunk_size,
2178 fifo_segment_collect_fifo_chunks (fs, f);
2181 n_chunks = fifo_segment_num_free_chunks (fs, chunk_size);
2182 SFIFO_TEST (n_chunks == n_free, "free chunks should be %u is %u", n_free,
2187 fifo_segment_free_fifo (fs, f);
2189 n_chunks = fifo_segment_num_free_chunks (fs, ~0);
2190 SFIFO_TEST (n_chunks == n_free, "free chunks should be %u is %u", n_free,
2196 fifo_segment_delete (sm, fs);
2197 vec_free (a->new_segment_indices);
2202 sfifo_test_fifo_segment_slave (int verbose)
2204 fifo_segment_create_args_t _a, *a = &_a;
2205 fifo_segment_main_t *sm = &segment_main;
2206 u8 *test_data, *retrieved_data = 0;
2208 fifo_segment_header_t *fsh;
2209 ssvm_shared_header_t *sh;
2216 sm->timeout_in_seconds = 5;
2217 clib_memset (a, 0, sizeof (*a));
2218 a->segment_name = "fifo-test1";
2220 rv = fifo_segment_attach (sm, a);
2222 SFIFO_TEST (!rv, "svm_fifo_segment_attach returned %d", rv);
2224 sp = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
2225 vec_free (a->new_segment_indices);
2227 fsh = (fifo_segment_header_t *) sh->opaque[0];
2229 /* might wanna wait.. */
2232 /* Lazy bastards united */
2233 test_data = format (0, "Hello world%c", 0);
2234 vec_validate (retrieved_data, vec_len (test_data) - 1);
2236 for (i = 0; i < 1000; i++)
2238 svm_fifo_dequeue (f, vec_len (retrieved_data), retrieved_data);
2239 if (memcmp (retrieved_data, test_data, vec_len (retrieved_data)))
2241 result = (u32 *) f->head_chunk->data;
2247 result = (u32 *) f->head_chunk->data;
2250 vec_free (test_data);
2251 vec_free (retrieved_data);
2256 sfifo_test_fifo_segment_master_slave (int verbose)
2258 fifo_segment_create_args_t _a, *a = &_a;
2259 fifo_segment_main_t *sm = &segment_main;
2269 SFIFO_TEST (0, "fork failed");
2272 sfifo_test_fifo_segment_slave (verbose);
2274 clib_memset (a, 0, sizeof (*a));
2275 a->segment_name = "fifo-test1";
2276 a->segment_size = 256 << 10;
2278 rv = fifo_segment_create (sm, a);
2280 SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
2282 sp = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
2283 f = fifo_segment_alloc_fifo (sp, 4096, FIFO_SEGMENT_RX_FIFO);
2285 SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo alloc");
2287 test_data = format (0, "Hello world%c", 0);
2291 for (i = 0; i < 1000; i++)
2292 svm_fifo_enqueue (f, vec_len (test_data), test_data);
2294 /* Wait for slave */
2296 while (svm_fifo_max_dequeue (f) && i++ < 1e10)
2301 result = (u32 *) f->head_chunk->data;
2302 SFIFO_TEST (*result == 0, "slave reported no error");
2304 vec_free (a->new_segment_indices);
2305 vec_free (test_data);
2306 fifo_segment_free_fifo (sp, f);
2307 fifo_segment_delete (sm, sp);
2312 sfifo_test_fifo_segment_mempig (int verbose)
2314 fifo_segment_create_args_t _a, *a = &_a;
2315 fifo_segment_main_t *sm = &segment_main;
2318 svm_fifo_t **flist = 0;
2322 clib_memset (a, 0, sizeof (*a));
2324 a->segment_name = "fifo-test1";
2325 a->segment_size = 256 << 10;
2327 rv = fifo_segment_create (sm, a);
2329 SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
2331 sp = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
2333 for (i = 0; i < 1000; i++)
2335 f = fifo_segment_alloc_fifo (sp, 4096, FIFO_SEGMENT_RX_FIFO);
2338 vec_add1 (flist, f);
2341 SFIFO_TEST (vec_len (flist), "created %d fifos", vec_len (flist));
2343 for (i = 0; i < vec_len (flist); i++)
2346 fifo_segment_free_fifo (sp, f);
2349 _vec_len (flist) = 0;
2351 for (i = 0; i < 1000; i++)
2353 f = fifo_segment_alloc_fifo (sp, 4096, FIFO_SEGMENT_RX_FIFO);
2356 vec_add1 (flist, f);
2359 SFIFO_TEST (vec_len (flist), "second try created %d fifos",
2361 for (i = 0; i < vec_len (flist); i++)
2364 fifo_segment_free_fifo (sp, f);
2367 fifo_segment_delete (sm, sp);
2372 sfifo_test_fifo_segment_prealloc (int verbose)
2374 fifo_segment_create_args_t _a, *a = &_a;
2375 fifo_segment_main_t *sm = &segment_main;
2376 u32 max_pairs, pairs_req, free_space, pair_mem;
2377 svm_fifo_t *f, *old;
2381 clib_memset (a, 0, sizeof (*a));
2383 a->segment_name = "fifo-test-prealloc";
2384 a->segment_size = 256 << 10;
2385 a->segment_type = SSVM_SEGMENT_MEMFD;
2387 rv = fifo_segment_create (sm, a);
2388 SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
2389 fs = fifo_segment_get_segment (sm, a->new_segment_indices[0]);
2392 * Prealloc chunks and headers
2394 free_space = fifo_segment_free_bytes (fs);
2395 SFIFO_TEST (free_space <= 256 << 10, "free space expected %u is %u",
2396 256 << 10, free_space);
2397 rv = fifo_segment_prealloc_fifo_chunks (fs, 4096, 50);
2398 SFIFO_TEST (rv == 0, "chunk prealloc should work");
2399 rv = fifo_segment_num_free_chunks (fs, 4096);
2400 SFIFO_TEST (rv == 50, "prealloc chunks expected %u is %u", 50, rv);
2401 rv = fifo_segment_free_bytes (fs);
2402 free_space -= (sizeof (svm_fifo_chunk_t) + 4096) * 50;
2403 SFIFO_TEST (rv == free_space, "free space expected %u is %u", free_space,
2405 rv = fifo_segment_fl_chunk_bytes (fs);
2406 SFIFO_TEST (rv == 4096 * 50, "chunk free space expected %u is %u",
2409 rv = fifo_segment_prealloc_fifo_hdrs (fs, 50);
2410 SFIFO_TEST (rv == 0, "fifo hdr prealloc should work");
2411 rv = fifo_segment_num_free_fifos (fs);
2412 SFIFO_TEST (rv == 50, "prealloc fifo hdrs expected %u is %u", 50, rv);
2413 rv = fifo_segment_free_bytes (fs);
2414 free_space -= sizeof (svm_fifo_t) * 50;
2415 SFIFO_TEST (rv == free_space, "free space expected %u is %u", free_space,
2418 fifo_segment_update_free_bytes (fs);
2419 rv = fifo_segment_free_bytes (fs);
2420 SFIFO_TEST (clib_abs (rv - (int) free_space) < 512,
2421 "free space expected %u is %u", free_space, rv);
2423 f = fifo_segment_alloc_fifo (fs, 200 << 10, FIFO_SEGMENT_RX_FIFO);
2424 SFIFO_TEST (f != 0, "fifo allocated");
2425 rv = fifo_segment_num_free_chunks (fs, 4096);
2426 SFIFO_TEST (rv == 0, "prealloc chunks expected %u is %u", 0, rv);
2427 rv = fifo_segment_fl_chunk_bytes (fs);
2428 SFIFO_TEST (rv == 0, "chunk free space expected %u is %u", 0, rv);
2431 * Multiple preallocs that consume the remaining space
2433 pair_mem = 2 * (4096 + sizeof (*f) + sizeof (svm_fifo_chunk_t));
2434 max_pairs = pairs_req = free_space / pair_mem - 1;
2435 fifo_segment_preallocate_fifo_pairs (fs, 4096, 4096, &pairs_req);
2436 SFIFO_TEST (pairs_req == 0, "prealloc pairs should work");
2437 rv = fifo_segment_num_free_chunks (fs, 4096);
2438 SFIFO_TEST (rv == max_pairs * 2, "prealloc chunks expected %u is %u",
2441 rv = fifo_segment_prealloc_fifo_chunks (fs, 4096, 2);
2442 SFIFO_TEST (rv == 0, "chunk prealloc should work");
2443 rv = fifo_segment_num_free_chunks (fs, 4096);
2444 SFIFO_TEST (rv == (max_pairs + 1) * 2, "prealloc chunks expected %u is %u",
2445 (max_pairs + 1) * 2, rv);
2447 free_space = fifo_segment_free_bytes (fs);
2448 SFIFO_TEST (rv < 8192, "free bytes expected less than %u is %u", 8192, rv);
2451 * Test negative prealloc cases
2454 fifo_segment_preallocate_fifo_pairs (fs, 4096, 4096, &pairs_req);
2455 SFIFO_TEST (pairs_req == 1, "prealloc pairs should not work");
2458 f = fifo_segment_alloc_fifo (fs, 200 << 10, FIFO_SEGMENT_RX_FIFO);
2459 SFIFO_TEST (f == 0, "fifo alloc should fail");
2461 rv = fifo_segment_prealloc_fifo_chunks (fs, 4096, 50);
2462 SFIFO_TEST (rv == -1, "chunk prealloc should fail");
2464 rv = fifo_segment_prealloc_fifo_hdrs (fs, 50);
2465 SFIFO_TEST (rv == -1, "fifo hdr prealloc should fail");
2470 fifo_segment_free_fifo (fs, old);
2471 close (fs->ssvm.fd);
2472 fifo_segment_delete (sm, fs);
2477 sfifo_test_fifo_segment (vlib_main_t * vm, unformat_input_t * input)
2479 int rv, verbose = 0;
2481 fifo_segment_main_init (&segment_main, 3ULL << 30, 5);
2482 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2484 if (unformat (input, "verbose"))
2486 else if (unformat (input, "masterslave"))
2488 if ((rv = sfifo_test_fifo_segment_master_slave (verbose)))
2491 else if (unformat (input, "basic"))
2493 if ((rv = sfifo_test_fifo_segment_hello_world (verbose)))
2496 else if (unformat (input, "mempig"))
2498 if ((rv = sfifo_test_fifo_segment_mempig (verbose)))
2501 else if (unformat (input, "grow fifo"))
2503 if ((rv = sfifo_test_fifo_segment_fifo_grow (verbose)))
2506 else if (unformat (input, "shrink fifo"))
2508 if ((rv = sfifo_test_fifo_segment_fifo_shrink (verbose)))
2511 else if (unformat (input, "prealloc"))
2513 if ((rv = sfifo_test_fifo_segment_prealloc (verbose)))
2516 else if (unformat (input, "all"))
2518 if ((rv = sfifo_test_fifo_segment_hello_world (verbose)))
2520 if ((rv = sfifo_test_fifo_segment_mempig (verbose)))
2522 if ((rv = sfifo_test_fifo_segment_fifo_grow (verbose)))
2524 if ((rv = sfifo_test_fifo_segment_fifo_shrink (verbose)))
2526 if ((rv = sfifo_test_fifo_segment_prealloc (verbose)))
2528 /* Pretty slow so avoid running it always
2529 if ((rv = sfifo_test_fifo_segment_master_slave (verbose)))
2535 vlib_cli_output (vm, "parse error: '%U'", format_unformat_error,
2543 static clib_error_t *
2544 svm_fifo_test (vlib_main_t * vm, unformat_input_t * input,
2545 vlib_cli_command_t * cmd_arg)
2551 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2553 if (unformat (input, "fifo1"))
2554 res = sfifo_test_fifo1 (vm, input);
2555 else if (unformat (input, "fifo2"))
2556 res = sfifo_test_fifo2 (vm);
2557 else if (unformat (input, "fifo3"))
2558 res = sfifo_test_fifo3 (vm, input);
2559 else if (unformat (input, "fifo4"))
2560 res = sfifo_test_fifo4 (vm, input);
2561 else if (unformat (input, "fifo5"))
2562 res = sfifo_test_fifo5 (vm, input);
2563 else if (unformat (input, "fifo6"))
2564 res = sfifo_test_fifo6 (vm, input);
2565 else if (unformat (input, "fifo7"))
2566 res = sfifo_test_fifo7 (vm, input);
2567 else if (unformat (input, "large"))
2568 res = sfifo_test_fifo_large (vm, input);
2569 else if (unformat (input, "replay"))
2570 res = sfifo_test_fifo_replay (vm, input);
2571 else if (unformat (input, "grow"))
2572 res = sfifo_test_fifo_grow (vm, input);
2573 else if (unformat (input, "shrink"))
2574 res = sfifo_test_fifo_shrink (vm, input);
2575 else if (unformat (input, "segment"))
2576 res = sfifo_test_fifo_segment (vm, input);
2577 else if (unformat (input, "all"))
2579 if ((res = sfifo_test_fifo1 (vm, input)))
2582 if ((res = sfifo_test_fifo2 (vm)))
2586 * Run a number of fifo3 configs
2588 str = "nsegs 10 overlap seed 123";
2589 unformat_init_cstring (input, str);
2590 if ((res = sfifo_test_fifo3 (vm, input)))
2592 unformat_free (input);
2594 str = "nsegs 10 overlap seed 123 in-seq-all";
2595 unformat_init_cstring (input, str);
2596 if ((res = sfifo_test_fifo3 (vm, input)))
2598 unformat_free (input);
2600 str = "nsegs 10 overlap seed 123 initial-offset 3917";
2601 unformat_init_cstring (input, str);
2602 if ((res = sfifo_test_fifo3 (vm, input)))
2604 unformat_free (input);
2606 str = "nsegs 10 overlap seed 123 initial-offset 3917 drop";
2607 unformat_init_cstring (input, str);
2608 if ((res = sfifo_test_fifo3 (vm, input)))
2610 unformat_free (input);
2612 str = "nsegs 10 seed 123 initial-offset 3917 drop no-randomize";
2613 unformat_init_cstring (input, str);
2614 if ((res = sfifo_test_fifo3 (vm, input)))
2616 unformat_free (input);
2618 if ((res = sfifo_test_fifo4 (vm, input)))
2621 if ((res = sfifo_test_fifo5 (vm, input)))
2624 if ((res = sfifo_test_fifo6 (vm, input)))
2627 if ((res = sfifo_test_fifo7 (vm, input)))
2630 if ((res = sfifo_test_fifo_grow (vm, input)))
2633 if ((res = sfifo_test_fifo_shrink (vm, input)))
2637 unformat_init_cstring (input, str);
2638 if ((res = sfifo_test_fifo_segment (vm, input)))
2643 vlib_cli_output (vm, "unknown input `%U'", format_unformat_error,
2653 return clib_error_return (0, "svm fifo unit test failed");
2658 VLIB_CLI_COMMAND (svm_fifo_test_command, static) =
2660 .path = "test svm fifo",
2661 .short_help = "internal svm fifo unit tests",
2662 .function = svm_fifo_test,
2667 * fd.io coding-style-patch-verification: ON
2670 * eval: (c-set-style "gnu")