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 <svm/svm_fifo_segment.h>
17 #include <vlib/vlib.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 < len; i++)
179 if (data1[i] != data2[i])
189 tcp_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_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);
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_nowait (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_number_ooo_segments (f) == 2),
251 "number of ooo segments %u", svm_fifo_number_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_number_ooo_segments (f) == 2),
269 "number of ooo segments %u", svm_fifo_number_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_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);
307 * Enqueue the missing u32
309 rv = svm_fifo_enqueue_nowait (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_number_ooo_segments (f) == 0),
315 "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
320 for (i = 0; i < 7; i++)
322 rv = svm_fifo_dequeue_nowait (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_number_ooo_segments (f) == 1),
360 "number of ooo segments %u", svm_fifo_number_ooo_segments (f));
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))
366 SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j], data[j]);
368 vec_reset_length (data_buf);
371 * Test segment overlaps: enqueue and overlap ooo segments
374 f = fifo_prepare (fifo_size);
376 for (i = 0; i < 4; i++)
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);
382 vlib_cli_output (vm, "add [%d] [%d, %d]", 2 * i + 1, offset,
383 offset + sizeof (u32));
386 clib_warning ("enqueue returned %d", rv);
392 vlib_cli_output (vm, "fifo after enqueue: %U", format_svm_fifo, f, 1);
394 rv = svm_fifo_enqueue_nowait (f, 29, data);
396 vlib_cli_output (vm, "fifo after enqueueing 29: %U", format_svm_fifo, f,
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));
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))
406 SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j], data[j]);
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);
415 vec_free (test_data);
421 vec_free (test_data);
426 tcp_test_fifo2 (vlib_main_t * vm)
429 u32 fifo_size = 1 << 20;
430 int i, rv, test_data_len;
432 test_pattern_t *tp, *vp, *test_data;
433 ooo_segment_t *ooo_seg;
435 test_data = test_pattern;
436 test_data_len = ARRAY_LEN (test_pattern);
438 vp = fifo_get_validate_pattern (vm, test_data, test_data_len);
441 f = fifo_prepare (fifo_size);
444 * Try with sorted data
446 for (i = 0; i < test_data_len; i++)
450 svm_fifo_enqueue_with_offset (f, tp->offset - f->tail, tp->len,
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);
464 rv = svm_fifo_enqueue_nowait (f, sizeof (u32), (u8 *) & data64);
465 SFIFO_TEST ((rv == 3000), "bytes to be enqueued %u", rv);
471 * Now try it again w/ unsorted data...
474 f = fifo_prepare (fifo_size);
476 for (i = 0; i < test_data_len; i++)
480 rv = svm_fifo_enqueue_with_offset (f, tp->offset - f->tail, tp->len,
484 clib_warning ("enqueue returned %d", rv);
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);
498 rv = svm_fifo_enqueue_nowait (f, sizeof (u32), (u8 *) & data64);
500 SFIFO_TEST ((rv == 3000), "bytes to be enqueued %u", rv);
508 tcp_test_fifo3 (vlib_main_t * vm, unformat_input_t * input)
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;
522 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
524 if (unformat (input, "fifo-size %d", &fifo_size))
526 else if (unformat (input, "total-size %d", &total_size))
528 else if (unformat (input, "verbose"))
530 else if (unformat (input, "overlap"))
532 else if (unformat (input, "initial-offset %d", &fifo_initial_offset))
534 else if (unformat (input, "seed %d", &seed))
536 else if (unformat (input, "nsegs %d", &nsegs))
538 else if (unformat (input, "no-randomize"))
540 else if (unformat (input, "in-seq-all"))
542 else if (unformat (input, "drop"))
546 clib_error_t *e = clib_error_return
547 (0, "unknown input `%U'", format_unformat_error, input);
548 clib_error_report (e);
553 if (total_size > fifo_size)
555 clib_warning ("total_size %d greater than fifo size %d", total_size,
559 if (overlap && randomize == 0)
561 clib_warning ("Can't enqueue in-order with overlap");
568 vec_validate (data_pattern, total_size - 1);
569 for (i = 0; i < vec_len (data_pattern); i++)
570 data_pattern[i] = i & 0xff;
575 seg_size = total_size / nsegs;
577 current_offset = randomize;
578 while (length_so_far < total_size)
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;
585 if (overlap && (len_this_chunk == seg_size))
588 offset_increment = len_this_chunk
589 % (1 + (random_u32 (&seed) % len_this_chunk));
591 while (offset_increment == 0);
593 offset_increment = len_this_chunk;
595 current_offset += offset_increment;
596 length_so_far = tp->offset + tp->len;
600 * Validate segment list. Only valid for non-overlap cases.
603 fifo_validate_pattern (vm, generate, vec_len (generate));
607 vlib_cli_output (vm, "raw data pattern:");
608 for (i = 0; i < vec_len (generate); i++)
610 vlib_cli_output (vm, "[%d] offset %u len %u", i,
611 generate[i].offset, generate[i].len);
615 /* Randomize data pattern */
618 for (i = 0; i < vec_len (generate) / 2; i++)
620 u32 src_index, dst_index;
621 test_pattern_t _tmp, *tmp = &_tmp;
623 src_index = random_u32 (&seed) % vec_len (generate);
624 dst_index = random_u32 (&seed) % vec_len (generate);
626 tmp[0] = generate[dst_index];
627 generate[dst_index] = generate[src_index];
628 generate[src_index] = tmp[0];
632 vlib_cli_output (vm, "randomized data pattern:");
633 for (i = 0; i < vec_len (generate); i++)
635 vlib_cli_output (vm, "[%d] offset %u len %u", i,
636 generate[i].offset, generate[i].len);
642 * Create a fifo and add segments
644 f = fifo_prepare (fifo_size);
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);
650 for (i = !randomize; i < vec_len (generate); i++)
653 svm_fifo_enqueue_with_offset (f,
654 fifo_initial_offset + tp->offset -
656 (u8 *) data_pattern + tp->offset);
659 /* Add the first segment in order for non random data */
661 svm_fifo_enqueue_nowait (f, generate[0].len, (u8 *) data_pattern);
664 * Expected result: one big fat chunk at offset 1 if randomize == 1
668 vlib_cli_output (vm, "fifo before missing link: %U",
669 format_svm_fifo, f, 1 /* verbose */ );
672 * Add the missing byte if segments were randomized
676 u32 bytes_to_enq = 1;
678 bytes_to_enq = total_size;
679 rv = svm_fifo_enqueue_nowait (f, bytes_to_enq, data_pattern + 0);
682 vlib_cli_output (vm, "in-order enqueue returned %d", rv);
684 SFIFO_TEST ((rv == total_size), "enqueued %u expected %u", rv,
689 SFIFO_TEST ((svm_fifo_has_ooo_data (f) == 0), "number of ooo segments %u",
690 svm_fifo_number_ooo_segments (f));
693 * Test if peeked data is the same as original data
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))
699 SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j],
702 vec_reset_length (data_buf);
705 * Dequeue or drop all data
709 svm_fifo_dequeue_drop (f, vec_len (data_pattern));
713 svm_fifo_dequeue_nowait (f, vec_len (data_pattern), data_buf);
715 (data_buf, data_pattern, 0, vec_len (data_pattern), &j))
717 SFIFO_TEST (0, "[%d] dequeued %u expected %u", j, data_buf[j],
722 SFIFO_TEST ((svm_fifo_max_dequeue (f) == 0), "fifo has %d bytes",
723 svm_fifo_max_dequeue (f));
726 vec_free (data_pattern);
733 tcp_test_fifo4 (vlib_main_t * vm, unformat_input_t * input)
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;
742 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
744 if (unformat (input, "verbose"))
748 clib_error_t *e = clib_error_return
749 (0, "unknown input `%U'", format_unformat_error, input);
750 clib_error_report (e);
756 * Create a fifo and add segments
758 f = fifo_prepare (fifo_size);
760 /* Set head and tail pointers */
761 fifo_initial_offset = fifo_initial_offset % fifo_size;
762 svm_fifo_init_pointers (f, fifo_initial_offset);
764 vec_validate (test_data, test_n_bytes - 1);
765 for (i = 0; i < vec_len (test_data); i++)
768 for (i = test_n_bytes - 1; i > 0; i--)
770 rv = svm_fifo_enqueue_with_offset (f, fifo_initial_offset + i - f->tail,
771 sizeof (u8), &test_data[i]);
773 vlib_cli_output (vm, "add [%d] [%d, %d]", i, i, i + sizeof (u8));
776 clib_warning ("enqueue returned %d", rv);
778 vec_free (test_data);
783 svm_fifo_enqueue_nowait (f, sizeof (u8), &test_data[0]);
785 vec_validate (data_buf, vec_len (test_data));
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);
790 vlib_cli_output (vm, "[%d] dequeued %u expected %u", j, data_buf[j],
792 SFIFO_TEST ((rv == 0), "dequeued compared to original returned %d", rv);
795 vec_free (test_data);
800 fifo_pos (svm_fifo_t * f, u32 pos)
806 tcp_test_fifo5 (vlib_main_t * vm, unformat_input_t * input)
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;
814 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
816 if (unformat (input, "verbose"))
820 clib_error_t *e = clib_error_return (0, "unknown input `%U'",
821 format_unformat_error, input);
822 clib_error_report (e);
827 f = fifo_prepare (fifo_size);
828 svm_fifo_init_pointers (f, offset);
830 vec_validate (test_data, 399);
831 for (i = 0; i < vec_len (test_data); i++)
832 test_data[i] = i % 0xff;
835 * Start with [100, 200] and [300, 400]
837 svm_fifo_enqueue_with_offset (f, 100, 100, &test_data[100]);
838 svm_fifo_enqueue_with_offset (f, 300, 100, &test_data[300]);
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);
844 vlib_cli_output (vm, "fifo after [100, 200] and [300, 400] : %U",
845 format_svm_fifo, f, 2 /* verbose */ );
851 rv = svm_fifo_enqueue_with_offset (f, 225, 50, &test_data[200]);
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);
879 rv = svm_fifo_enqueue_with_offset (f, 190, 120, &test_data[190]);
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);
895 rv = svm_fifo_enqueue_nowait (f, 150, test_data);
898 vlib_cli_output (vm, "fifo after [0 150] : %U", format_svm_fifo, f,
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));
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))
909 SFIFO_TEST (0, "[%d] peeked %u expected %u", j, data_buf[j],
914 * Add [100 200] and overlap it with [50 250]
917 f = fifo_prepare (fifo_size);
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",
926 SFIFO_TEST ((ooo_seg->length == 200), "first seg length %u expected %u",
927 ooo_seg->length, 200);
930 vec_free (test_data);
935 tcp_test_fifo_grow (vlib_main_t * vm, unformat_input_t * input)
937 int __clib_unused verbose, fifo_size = 201, start_offset = 100, i;
938 svm_fifo_chunk_t *c, *next, *prev;
942 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
944 if (unformat (input, "verbose"))
948 vlib_cli_output (vm, "parse error: '%U'", format_unformat_error,
954 f = fifo_prepare (fifo_size);
955 svm_fifo_init_pointers (f, start_offset);
958 * Add with fifo not wrapped
960 c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
965 svm_fifo_add_chunk (f, c);
967 SFIFO_TEST (f->size == fifo_size + 100, "size expected %u is %u",
968 fifo_size + 100, f->size);
969 SFIFO_TEST (c->start_byte == fifo_size, "start byte expected %u is %u",
970 fifo_size, c->start_byte);
973 * Add with fifo wrapped
976 f->tail = f->head + f->nitems;
977 c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
982 svm_fifo_add_chunk (f, c);
984 SFIFO_TEST (f->end_chunk != c, "tail chunk should not be updated");
985 SFIFO_TEST (f->size == fifo_size + 100, "size expected %u is %u",
986 fifo_size + 100, f->size);
987 SFIFO_TEST (c->start_byte == ~0, "start byte expected %u is %u", ~0,
993 vec_validate (buf, 200);
994 svm_fifo_dequeue_nowait (f, 201, buf);
996 SFIFO_TEST (f->end_chunk == c, "tail chunk should be updated");
997 SFIFO_TEST (f->size == fifo_size + 200, "size expected %u is %u",
998 fifo_size + 200, f->size);
999 SFIFO_TEST (c->start_byte == fifo_size + 100, "start byte expected %u is "
1000 "%u", fifo_size + 100, c->start_byte);
1006 f->head = f->nitems - 100;
1007 f->tail = f->head + f->nitems;
1010 for (i = 0; i < 5; i++)
1012 c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
1019 svm_fifo_add_chunk (f, c);
1020 SFIFO_TEST (f->size == fifo_size + 200, "size expected %u is %u",
1021 fifo_size + 200, f->size);
1024 for (i = 0; i < 5; i++)
1026 c = clib_mem_alloc (sizeof (svm_fifo_chunk_t) + 100);
1033 svm_fifo_add_chunk (f, c);
1034 SFIFO_TEST (f->size == fifo_size + 200, "size expected %u is %u",
1035 fifo_size + 200, f->size);
1037 svm_fifo_dequeue_nowait (f, 201, buf);
1039 SFIFO_TEST (f->size == fifo_size + 200 + 10 * 100, "size expected %u is %u",
1040 fifo_size + 200 + 10 * 100, f->size);
1045 c = f->start_chunk->next;
1046 while (c && c != f->start_chunk)
1060 svm_fifo_trace_elem_t fifo_trace[] = {};
1064 tcp_test_fifo_replay (vlib_main_t * vm, unformat_input_t * input)
1068 u8 no_read = 0, *str = 0;
1070 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1072 if (unformat (input, "verbose"))
1074 else if (unformat (input, "no-read"))
1078 clib_error_t *e = clib_error_return
1079 (0, "unknown input `%U'", format_unformat_error, input);
1080 clib_error_report (e);
1086 f.trace = fifo_trace;
1089 str = svm_fifo_replay (str, &f, no_read, verbose);
1090 vlib_cli_output (vm, "%v", str);
1094 static svm_fifo_segment_main_t segment_main;
1097 tcp_test_fifo_segment_hello_world (int verbose)
1099 svm_fifo_segment_create_args_t _a, *a = &_a;
1100 svm_fifo_segment_main_t *sm = &segment_main;
1101 u8 *test_data, *retrieved_data = 0;
1102 svm_fifo_segment_private_t *sp;
1106 clib_memset (a, 0, sizeof (*a));
1107 a->segment_name = "fifo-test1";
1108 a->segment_size = 256 << 10;
1110 rv = svm_fifo_segment_create (sm, a);
1112 SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
1114 sp = svm_fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1115 f = svm_fifo_segment_alloc_fifo (sp, 4096, FIFO_SEGMENT_RX_FREELIST);
1117 SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo");
1119 test_data = format (0, "Hello world%c", 0);
1120 vec_validate (retrieved_data, vec_len (test_data) - 1);
1122 while (svm_fifo_max_enqueue (f) >= vec_len (test_data))
1123 svm_fifo_enqueue_nowait (f, vec_len (test_data), test_data);
1125 while (svm_fifo_max_dequeue (f) >= vec_len (test_data))
1126 svm_fifo_dequeue_nowait (f, vec_len (retrieved_data), retrieved_data);
1128 while (svm_fifo_max_enqueue (f) >= vec_len (test_data))
1129 svm_fifo_enqueue_nowait (f, vec_len (test_data), test_data);
1131 while (svm_fifo_max_dequeue (f) >= vec_len (test_data))
1132 svm_fifo_dequeue_nowait (f, vec_len (retrieved_data), retrieved_data);
1134 SFIFO_TEST (!memcmp (retrieved_data, test_data, vec_len (test_data)),
1135 "data should be identical");
1137 vec_free (test_data);
1138 vec_free (retrieved_data);
1139 svm_fifo_segment_free_fifo (sp, f, FIFO_SEGMENT_RX_FREELIST);
1140 svm_fifo_segment_delete (sm, sp);
1145 tcp_test_fifo_segment_slave (int verbose)
1147 svm_fifo_segment_create_args_t _a, *a = &_a;
1148 svm_fifo_segment_main_t *sm = &segment_main;
1149 u8 *test_data, *retrieved_data = 0;
1150 svm_fifo_segment_private_t *sp;
1151 svm_fifo_segment_header_t *fsh;
1152 ssvm_shared_header_t *sh;
1159 sm->timeout_in_seconds = 5;
1160 clib_memset (a, 0, sizeof (*a));
1161 a->segment_name = "fifo-test1";
1163 rv = svm_fifo_segment_attach (sm, a);
1165 SFIFO_TEST (!rv, "svm_fifo_segment_attach returned %d", rv);
1167 sp = svm_fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1169 fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
1171 /* might wanna wait.. */
1174 /* Lazy bastards united */
1175 test_data = format (0, "Hello world%c", 0);
1176 vec_validate (retrieved_data, vec_len (test_data) - 1);
1178 for (i = 0; i < 1000; i++)
1180 svm_fifo_dequeue_nowait (f, vec_len (retrieved_data), retrieved_data);
1181 if (memcmp (retrieved_data, test_data, vec_len (retrieved_data)))
1183 result = (u32 *) f->head_chunk->data;
1189 result = (u32 *) f->head_chunk->data;
1192 vec_free (test_data);
1193 vec_free (retrieved_data);
1198 tcp_test_fifo_segment_master_slave (int verbose)
1200 svm_fifo_segment_create_args_t _a, *a = &_a;
1201 svm_fifo_segment_main_t *sm = &segment_main;
1202 svm_fifo_segment_private_t *sp;
1211 SFIFO_TEST (0, "fork failed");
1214 tcp_test_fifo_segment_slave (verbose);
1216 clib_memset (a, 0, sizeof (*a));
1217 a->segment_name = "fifo-test1";
1218 a->segment_size = 256 << 10;
1220 rv = svm_fifo_segment_create (sm, a);
1222 SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
1224 sp = svm_fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1225 f = svm_fifo_segment_alloc_fifo (sp, 4096, FIFO_SEGMENT_RX_FREELIST);
1227 SFIFO_TEST (f != 0, "svm_fifo_segment_alloc_fifo alloc");
1229 test_data = format (0, "Hello world%c", 0);
1233 for (i = 0; i < 1000; i++)
1234 svm_fifo_enqueue_nowait (f, vec_len (test_data), test_data);
1236 /* Wait for slave */
1238 while (svm_fifo_max_dequeue (f) && i++ < 1e10)
1243 result = (u32 *) f->head_chunk->data;
1244 SFIFO_TEST (*result == 0, "slave reported no error");
1246 vec_free (test_data);
1247 svm_fifo_segment_free_fifo (sp, f, FIFO_SEGMENT_RX_FREELIST);
1248 svm_fifo_segment_delete (sm, sp);
1253 tcp_test_fifo_segment_mempig (int verbose)
1255 svm_fifo_segment_create_args_t _a, *a = &_a;
1256 svm_fifo_segment_main_t *sm = &segment_main;
1257 svm_fifo_segment_private_t *sp;
1259 svm_fifo_t **flist = 0;
1263 clib_memset (a, 0, sizeof (*a));
1265 a->segment_name = "fifo-test1";
1266 a->segment_size = 256 << 10;
1268 rv = svm_fifo_segment_create (sm, a);
1270 SFIFO_TEST (!rv, "svm_fifo_segment_create returned %d", rv);
1272 sp = svm_fifo_segment_get_segment (sm, a->new_segment_indices[0]);
1274 for (i = 0; i < 1000; i++)
1276 f = svm_fifo_segment_alloc_fifo (sp, 4096, FIFO_SEGMENT_RX_FREELIST);
1279 vec_add1 (flist, f);
1282 SFIFO_TEST (vec_len (flist), "created %d fifos", vec_len (flist));
1284 for (i = 0; i < vec_len (flist); i++)
1287 svm_fifo_segment_free_fifo (sp, f, FIFO_SEGMENT_RX_FREELIST);
1290 _vec_len (flist) = 0;
1292 for (i = 0; i < 1000; i++)
1294 f = svm_fifo_segment_alloc_fifo (sp, 4096, FIFO_SEGMENT_RX_FREELIST);
1297 vec_add1 (flist, f);
1300 SFIFO_TEST (vec_len (flist), "second try created %d fifos",
1302 for (i = 0; i < vec_len (flist); i++)
1305 svm_fifo_segment_free_fifo (sp, f, FIFO_SEGMENT_RX_FREELIST);
1308 svm_fifo_segment_delete (sm, sp);
1313 tcp_test_fifo_segment (vlib_main_t * vm, unformat_input_t * input)
1315 int rv, verbose = 0;
1317 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1319 if (unformat (input, "verbose"))
1321 else if (unformat (input, "masterslave"))
1323 if ((rv = tcp_test_fifo_segment_master_slave (verbose)))
1326 else if (unformat (input, "basic"))
1328 if ((rv = tcp_test_fifo_segment_hello_world (verbose)))
1331 else if (unformat (input, "mempig"))
1333 if ((rv = tcp_test_fifo_segment_mempig (verbose)))
1336 else if (unformat (input, "all"))
1338 if ((rv = tcp_test_fifo_segment_hello_world (verbose)))
1340 if ((rv = tcp_test_fifo_segment_mempig (verbose)))
1342 /* Pretty slow so avoid running it always
1343 if ((rv = tcp_test_fifo_segment_master_slave (verbose)))
1349 vlib_cli_output (vm, "parse error: '%U'", format_unformat_error,
1357 static clib_error_t *
1358 svm_fifo_test (vlib_main_t * vm, unformat_input_t * input,
1359 vlib_cli_command_t * cmd_arg)
1364 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1366 if (unformat (input, "fifo1"))
1367 res = tcp_test_fifo1 (vm, input);
1368 else if (unformat (input, "fifo2"))
1369 res = tcp_test_fifo2 (vm);
1370 else if (unformat (input, "fifo3"))
1371 res = tcp_test_fifo3 (vm, input);
1372 else if (unformat (input, "fifo4"))
1373 res = tcp_test_fifo4 (vm, input);
1374 else if (unformat (input, "fifo5"))
1375 res = tcp_test_fifo5 (vm, input);
1376 else if (unformat (input, "replay"))
1377 res = tcp_test_fifo_replay (vm, input);
1378 else if (unformat (input, "grow"))
1379 res = tcp_test_fifo_grow (vm, input);
1380 else if (unformat (input, "segment"))
1381 res = tcp_test_fifo_segment (vm, input);
1382 else if (unformat (input, "all"))
1384 if ((res = tcp_test_fifo1 (vm, input)))
1387 if ((res = tcp_test_fifo2 (vm)))
1391 * Run a number of fifo3 configs
1393 str = "nsegs 10 overlap seed 123";
1394 unformat_init_cstring (input, str);
1395 if ((res = tcp_test_fifo3 (vm, input)))
1397 unformat_free (input);
1399 str = "nsegs 10 overlap seed 123 in-seq-all";
1400 unformat_init_cstring (input, str);
1401 if ((res = tcp_test_fifo3 (vm, input)))
1403 unformat_free (input);
1405 str = "nsegs 10 overlap seed 123 initial-offset 3917";
1406 unformat_init_cstring (input, str);
1407 if ((res = tcp_test_fifo3 (vm, input)))
1409 unformat_free (input);
1411 str = "nsegs 10 overlap seed 123 initial-offset 3917 drop";
1412 unformat_init_cstring (input, str);
1413 if ((res = tcp_test_fifo3 (vm, input)))
1415 unformat_free (input);
1417 str = "nsegs 10 seed 123 initial-offset 3917 drop no-randomize";
1418 unformat_init_cstring (input, str);
1419 if ((res = tcp_test_fifo3 (vm, input)))
1421 unformat_free (input);
1423 if ((res = tcp_test_fifo4 (vm, input)))
1426 if ((res = tcp_test_fifo5 (vm, input)))
1429 if ((res = tcp_test_fifo_grow (vm, input)))
1433 unformat_init_cstring (input, str);
1434 if ((res = tcp_test_fifo_segment (vm, input)))
1439 vlib_cli_output (vm, "unknown input `%U'", format_unformat_error,
1449 return clib_error_return (0, "svm fifo unit test failed");
1454 VLIB_CLI_COMMAND (svm_fifo_test_command, static) =
1456 .path = "test svm fifo",
1457 .short_help = "internal svm fifo unit tests",
1458 .function = svm_fifo_test,
1463 * fd.io coding-style-patch-verification: ON
1466 * eval: (c-set-style "gnu")