2
* Copyright (C) 2011 Michael Brown <mbrown@fensystems.co.uk>.
4
* This program is free software; you can redistribute it and/or
5
* modify it under the terms of the GNU General Public License as
6
* published by the Free Software Foundation; either version 2 of the
7
* License, or any later version.
9
* This program is distributed in the hope that it will be useful, but
10
* WITHOUT ANY WARRANTY; without even the implied warranty of
11
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12
* General Public License for more details.
14
* You should have received a copy of the GNU General Public License
15
* along with this program; if not, write to the Free Software
16
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19
* You can also choose to distribute this program under the terms of
20
* the Unmodified Binary Distribution Licence (as given in the file
21
* COPYING.UBDL), provided that you have satisfied its requirements.
24
FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
32
/* Forcibly enable assertions for list_check() */
38
#include <ipxe/list.h>
39
#include <ipxe/test.h>
41
/** A list test structure */
44
struct list_head list;
49
/** List test elements */
50
static struct list_test list_tests[] = {
64
static LIST_HEAD ( test_list );
67
* Check list contents are as expected
70
* @v expected Expected contents
71
* @v ok List contents are as expected
73
static int list_check_contents ( struct list_head *list,
74
const char *expected ) {
75
struct list_test *entry;
76
size_t num_entries = 0;
78
/* Determine size of list */
79
list_for_each_entry ( entry, list, list )
83
char found[ num_entries + 1 ];
84
char found_rev[ num_entries + 1 ];
87
/* Build up list content string */
89
list_for_each_entry ( entry, list, list )
90
*(tmp++) = entry->label;
93
/* Sanity check reversed list */
94
tmp = &found_rev[ sizeof ( found_rev ) - 1 ];
96
list_for_each_entry_reverse ( entry, list, list )
97
*(--tmp) = entry->label;
98
if ( strcmp ( found, found_rev ) != 0 ) {
99
printf ( "FAILURE: list reversal mismatch (forward "
100
"\"%s\", reverse \"%s\")\n",
105
/* Compare against expected content */
106
if ( strcmp ( found, expected ) == 0 ) {
109
printf ( "FAILURE: expected \"%s\", got \"%s\"\n",
117
* Report list test result
120
* @v expected Expected contents
122
#define list_contents_ok( list, expected ) do { \
123
ok ( list_check_contents ( (list), (expected) ) ); \
127
* Report list iteration test result
129
* @v macro Iterator macro
130
* @v expected Expected contents
132
* @v ... Arguments to iterator macro
134
#define list_iterate_ok( macro, expected, pos, ... ) do { \
135
const char *check = expected; \
136
macro ( pos, __VA_ARGS__ ) { \
137
struct list_test *entry = \
138
list_entry ( pos, struct list_test, \
140
ok ( entry->label == *(check++) ); \
142
ok ( *check == '\0' ); \
146
* Report list entry iteration test result
148
* @v macro Iterator macro
149
* @v expected Expected contents
151
* @v ... Arguments to iterator macro
153
#define list_iterate_entry_ok( macro, expected, pos, ... ) do { \
154
const char *check = expected; \
155
macro ( pos, __VA_ARGS__ ) { \
156
ok ( (pos)->label == *(check++) ); \
158
ok ( *check == '\0' ); \
162
* Perform list self-test
165
static void list_test_exec ( void ) {
166
struct list_head *list = &test_list;
167
struct list_head target_list;
168
struct list_head *target = &target_list;
169
struct list_head *raw_pos;
170
struct list_test *pos;
171
struct list_test *tmp;
173
/* Test initialiser and list_empty() */
174
ok ( list_empty ( list ) );
175
list_contents_ok ( list, "" );
177
/* Test list_add(), list_add_tail() and list_del() */
178
INIT_LIST_HEAD ( list );
179
list_contents_ok ( list, "" );
180
list_add ( &list_tests[4].list, list ); /* prepend */
181
list_contents_ok ( list, "4" );
182
list_add ( &list_tests[2].list, list ); /* prepend */
183
list_contents_ok ( list, "24" );
184
list_add_tail ( &list_tests[7].list, list ); /* append */
185
list_contents_ok ( list, "247" );
186
list_add ( &list_tests[1].list, &list_tests[4].list ); /* after */
187
list_contents_ok ( list, "2417" );
188
list_add_tail ( &list_tests[8].list, &list_tests[7].list ); /* before */
189
list_contents_ok ( list, "24187" );
190
list_del ( &list_tests[4].list ); /* delete middle */
191
list_contents_ok ( list, "2187" );
192
list_del ( &list_tests[2].list ); /* delete first */
193
list_contents_ok ( list, "187" );
194
list_del ( &list_tests[7].list ); /* delete last */
195
list_contents_ok ( list, "18" );
196
list_del ( &list_tests[1].list ); /* delete all */
197
list_del ( &list_tests[8].list ); /* delete all */
198
list_contents_ok ( list, "" );
199
ok ( list_empty ( list ) );
201
/* Test list_is_singular() */
202
INIT_LIST_HEAD ( list );
203
ok ( ! list_is_singular ( list ) );
204
list_add ( &list_tests[1].list, list );
205
ok ( list_is_singular ( list ) );
206
list_add ( &list_tests[3].list, list );
207
ok ( ! list_is_singular ( list ) );
208
list_del ( &list_tests[1].list );
209
ok ( list_is_singular ( list ) );
211
/* Test list_is_last() */
212
INIT_LIST_HEAD ( list );
213
list_add_tail ( &list_tests[6].list, list );
214
ok ( list_is_last ( &list_tests[6].list, list ) );
215
list_add_tail ( &list_tests[4].list, list );
216
ok ( list_is_last ( &list_tests[4].list, list ) );
217
ok ( ! list_is_last ( &list_tests[6].list, list ) );
219
/* Test list_cut_position() - empty list */
220
INIT_LIST_HEAD ( list );
221
INIT_LIST_HEAD ( target );
222
list_cut_position ( target, list, list );
223
list_contents_ok ( list, "" );
224
list_contents_ok ( target, "" );
226
/* Test list_cut_position() - singular list, move nothing */
227
INIT_LIST_HEAD ( list );
228
INIT_LIST_HEAD ( target );
229
list_add_tail ( &list_tests[4].list, list );
230
list_cut_position ( target, list, list );
231
list_contents_ok ( list, "4" );
232
list_contents_ok ( target, "" );
234
/* Test list_cut_position() - singular list, move singular entry */
235
INIT_LIST_HEAD ( list );
236
INIT_LIST_HEAD ( target );
237
list_add_tail ( &list_tests[9].list, list );
238
list_cut_position ( target, list, &list_tests[9].list );
239
list_contents_ok ( list, "" );
240
list_contents_ok ( target, "9" );
242
/* Test list_cut_position() - multi-entry list, move nothing */
243
INIT_LIST_HEAD ( list );
244
list_add_tail ( &list_tests[3].list, list );
245
list_add_tail ( &list_tests[2].list, list );
246
list_add_tail ( &list_tests[7].list, list );
247
INIT_LIST_HEAD ( target );
248
list_cut_position ( target, list, list );
249
list_contents_ok ( list, "327" );
250
list_contents_ok ( target, "" );
252
/* Test list_cut_position() - multi-entry list, move some */
253
INIT_LIST_HEAD ( list );
254
INIT_LIST_HEAD ( target );
255
list_add_tail ( &list_tests[8].list, list );
256
list_add_tail ( &list_tests[0].list, list );
257
list_add_tail ( &list_tests[9].list, list );
258
list_add_tail ( &list_tests[3].list, list );
259
list_add_tail ( &list_tests[2].list, list );
260
list_cut_position ( target, list, &list_tests[0].list );
261
list_contents_ok ( list, "932" );
262
list_contents_ok ( target, "80" );
264
/* Test list_cut_position() - multi-entry list, move everything */
265
INIT_LIST_HEAD ( list );
266
INIT_LIST_HEAD ( target );
267
list_add_tail ( &list_tests[3].list, list );
268
list_add_tail ( &list_tests[5].list, list );
269
list_add_tail ( &list_tests[4].list, list );
270
list_add_tail ( &list_tests[7].list, list );
271
list_add_tail ( &list_tests[1].list, list );
272
list_cut_position ( target, list, &list_tests[1].list );
273
list_contents_ok ( list, "" );
274
list_contents_ok ( target, "35471" );
276
/* Test list_splice() - empty list */
277
INIT_LIST_HEAD ( list );
278
INIT_LIST_HEAD ( target );
279
list_splice ( list, target );
280
list_contents_ok ( list, "" );
281
list_contents_ok ( target, "" );
283
/* Test list_splice() - both lists empty */
284
INIT_LIST_HEAD ( list );
285
INIT_LIST_HEAD ( target );
286
list_splice ( list, target );
287
list_contents_ok ( target, "" );
289
/* Test list_splice() - source list empty */
290
INIT_LIST_HEAD ( list );
291
INIT_LIST_HEAD ( target );
292
list_add_tail ( &list_tests[1].list, target );
293
list_add_tail ( &list_tests[3].list, target );
294
list_splice ( list, &list_tests[1].list );
295
list_contents_ok ( target, "13" );
297
/* Test list_splice() - destination list empty */
298
INIT_LIST_HEAD ( list );
299
INIT_LIST_HEAD ( target );
300
list_add_tail ( &list_tests[6].list, list );
301
list_add_tail ( &list_tests[5].list, list );
302
list_add_tail ( &list_tests[2].list, list );
303
list_splice ( list, target );
304
list_contents_ok ( target, "652" );
306
/* Test list_splice() - both lists non-empty */
307
INIT_LIST_HEAD ( list );
308
INIT_LIST_HEAD ( target );
309
list_add_tail ( &list_tests[8].list, list );
310
list_add_tail ( &list_tests[4].list, list );
311
list_add_tail ( &list_tests[5].list, list );
312
list_add_tail ( &list_tests[1].list, target );
313
list_add_tail ( &list_tests[9].list, target );
314
list_splice ( list, &list_tests[1].list );
315
list_contents_ok ( target, "18459" );
317
/* Test list_splice_tail() - both lists empty */
318
INIT_LIST_HEAD ( list );
319
INIT_LIST_HEAD ( target );
320
list_splice_tail ( list, target );
321
list_contents_ok ( target, "" );
323
/* Test list_splice_tail() - source list empty */
324
INIT_LIST_HEAD ( list );
325
INIT_LIST_HEAD ( target );
326
list_add_tail ( &list_tests[5].list, target );
327
list_splice_tail ( list, &list_tests[5].list );
328
list_contents_ok ( target, "5" );
330
/* Test list_splice_tail() - destination list empty */
331
INIT_LIST_HEAD ( list );
332
INIT_LIST_HEAD ( target );
333
list_add_tail ( &list_tests[2].list, list );
334
list_add_tail ( &list_tests[1].list, list );
335
list_add_tail ( &list_tests[0].list, list );
336
list_splice_tail ( list, target );
337
list_contents_ok ( target, "210" );
339
/* Test list_splice_tail() - both lists non-empty */
340
INIT_LIST_HEAD ( list );
341
INIT_LIST_HEAD ( target );
342
list_add_tail ( &list_tests[9].list, list );
343
list_add_tail ( &list_tests[5].list, list );
344
list_add_tail ( &list_tests[7].list, list );
345
list_add_tail ( &list_tests[2].list, target );
346
list_add_tail ( &list_tests[4].list, target );
347
list_splice_tail ( list, &list_tests[2].list );
348
list_contents_ok ( target, "95724" );
350
/* Test list_splice_init() */
351
INIT_LIST_HEAD ( list );
352
INIT_LIST_HEAD ( target );
353
list_add_tail ( &list_tests[4].list, list );
354
list_add_tail ( &list_tests[1].list, target );
355
list_splice_init ( list, target );
356
ok ( list_empty ( list ) );
357
list_contents_ok ( list, "" );
358
list_contents_ok ( target, "41" );
360
/* Test list_splice_tail_init() */
361
INIT_LIST_HEAD ( list );
362
INIT_LIST_HEAD ( target );
363
list_add_tail ( &list_tests[3].list, list );
364
list_add_tail ( &list_tests[2].list, list );
365
list_add_tail ( &list_tests[5].list, target );
366
list_splice_tail_init ( list, &list_tests[5].list );
367
ok ( list_empty ( list ) );
368
list_contents_ok ( list, "" );
369
list_contents_ok ( target, "325" );
371
/* Test list_entry() */
372
INIT_LIST_HEAD ( &list_tests[3].list ); // for list_check()
373
ok ( list_entry ( &list_tests[3].list, struct list_test, list )
376
/* Test list_first_entry() and list_last_entry() */
377
INIT_LIST_HEAD ( list );
378
list_add_tail ( &list_tests[9].list, list );
379
list_add_tail ( &list_tests[5].list, list );
380
list_add_tail ( &list_tests[6].list, list );
381
ok ( list_first_entry ( list, struct list_test, list )
383
ok ( list_last_entry ( list, struct list_test, list )
385
list_del ( &list_tests[9].list );
386
ok ( list_first_entry ( list, struct list_test, list )
388
ok ( list_last_entry ( list, struct list_test, list )
390
list_del ( &list_tests[6].list );
391
ok ( list_first_entry ( list, struct list_test, list )
393
ok ( list_last_entry ( list, struct list_test, list )
395
list_del ( &list_tests[5].list );
396
ok ( list_first_entry ( list, struct list_test, list ) == NULL );
397
ok ( list_last_entry ( list, struct list_test, list ) == NULL );
399
/* Test list_next_entry() and list_prev_entry() */
400
INIT_LIST_HEAD ( list );
401
list_add_tail ( &list_tests[5].list, list );
402
list_add_tail ( &list_tests[3].list, list );
403
list_add_tail ( &list_tests[1].list, list );
404
list_add_tail ( &list_tests[7].list, list );
405
ok ( list_prev_entry ( &list_tests[5], list, list ) == NULL );
406
ok ( list_next_entry ( &list_tests[5], list, list ) == &list_tests[3] );
407
ok ( list_prev_entry ( &list_tests[3], list, list ) == &list_tests[5] );
408
ok ( list_next_entry ( &list_tests[3], list, list ) == &list_tests[1] );
409
ok ( list_prev_entry ( &list_tests[1], list, list ) == &list_tests[3] );
410
ok ( list_next_entry ( &list_tests[1], list, list ) == &list_tests[7] );
411
ok ( list_prev_entry ( &list_tests[7], list, list ) == &list_tests[1] );
412
ok ( list_next_entry ( &list_tests[7], list, list ) == NULL );
413
list_del ( &list_tests[7].list );
414
ok ( list_prev_entry ( &list_tests[1], list, list ) == &list_tests[3] );
415
ok ( list_next_entry ( &list_tests[1], list, list ) == NULL );
416
list_del ( &list_tests[3].list );
417
ok ( list_prev_entry ( &list_tests[5], list, list ) == NULL );
418
ok ( list_next_entry ( &list_tests[5], list, list ) == &list_tests[1] );
419
ok ( list_prev_entry ( &list_tests[1], list, list ) == &list_tests[5] );
420
ok ( list_next_entry ( &list_tests[1], list, list ) == NULL );
422
/* Test list_for_each() */
423
INIT_LIST_HEAD ( list );
424
list_add_tail ( &list_tests[6].list, list );
425
list_add_tail ( &list_tests[7].list, list );
426
list_add_tail ( &list_tests[3].list, list );
427
list_iterate_ok ( list_for_each, "673", raw_pos, list );
429
/* Test list_for_each_entry() and list_for_each_entry_reverse() */
430
INIT_LIST_HEAD ( list );
431
list_add_tail ( &list_tests[3].list, list );
432
list_add_tail ( &list_tests[2].list, list );
433
list_add_tail ( &list_tests[6].list, list );
434
list_add_tail ( &list_tests[9].list, list );
435
list_iterate_entry_ok ( list_for_each_entry, "3269",
437
list_iterate_entry_ok ( list_for_each_entry_reverse, "9623",
440
/* Test list_for_each_entry_safe() */
441
INIT_LIST_HEAD ( list );
442
list_add_tail ( &list_tests[2].list, list );
443
list_add_tail ( &list_tests[4].list, list );
444
list_add_tail ( &list_tests[1].list, list );
446
char *expected = "241";
447
list_for_each_entry_safe ( pos, tmp, list, list ) {
448
list_contents_ok ( list, expected );
449
list_del ( &pos->list );
451
list_contents_ok ( list, expected );
454
ok ( list_empty ( list ) );
456
/* Test list_for_each_entry_continue() and
457
* list_for_each_entry_continue_reverse()
459
INIT_LIST_HEAD ( list );
460
list_add_tail ( &list_tests[4].list, list );
461
list_add_tail ( &list_tests[7].list, list );
462
list_add_tail ( &list_tests[2].list, list );
463
list_add_tail ( &list_tests[9].list, list );
464
list_add_tail ( &list_tests[3].list, list );
465
pos = &list_tests[7];
466
list_iterate_entry_ok ( list_for_each_entry_continue, "293",
468
ok ( pos == list_entry ( list, struct list_test, list ) );
469
list_iterate_entry_ok ( list_for_each_entry_continue, "47293",
471
pos = &list_tests[3];
472
list_iterate_entry_ok ( list_for_each_entry_continue, "",
474
pos = &list_tests[2];
475
list_iterate_entry_ok ( list_for_each_entry_continue_reverse, "74",
477
ok ( pos == list_entry ( list, struct list_test, list ) );
478
list_iterate_entry_ok ( list_for_each_entry_continue_reverse, "39274",
480
pos = &list_tests[4];
481
list_iterate_entry_ok ( list_for_each_entry_continue_reverse, "",
484
/* Test list_contains() and list_contains_entry() */
485
INIT_LIST_HEAD ( list );
486
INIT_LIST_HEAD ( &list_tests[3].list );
487
list_add ( &list_tests[8].list, list );
488
list_add ( &list_tests[5].list, list );
489
ok ( list_contains ( &list_tests[8].list, list ) );
490
ok ( list_contains_entry ( &list_tests[8], list, list ) );
491
ok ( list_contains ( &list_tests[5].list, list ) );
492
ok ( list_contains_entry ( &list_tests[5], list, list ) );
493
ok ( ! list_contains ( &list_tests[3].list, list ) );
494
ok ( ! list_contains_entry ( &list_tests[3], list, list ) );
496
/* Test list_check_contains_entry() */
497
INIT_LIST_HEAD ( list );
498
list_add ( &list_tests[4].list, list );
499
list_add ( &list_tests[0].list, list );
500
list_add ( &list_tests[3].list, list );
501
list_check_contains_entry ( &list_tests[4], list, list );
502
list_check_contains_entry ( &list_tests[0], list, list );
503
list_check_contains_entry ( &list_tests[3], list, list );
506
/** List self-test */
507
struct self_test list_test __self_test = {
509
.exec = list_test_exec,