1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2018, Google Inc. All rights reserved.
10 #include <asm/global_data.h>
11 #include <test/suites.h>
12 #include <test/test.h>
15 DECLARE_GLOBAL_DATA_PTR;
17 /* Declare a new bloblist test */
18 #define BLOBLIST_TEST(_name, _flags) \
19 UNIT_TEST(_name, _flags, bloblist_test)
22 TEST_TAG = BLOBLISTT_U_BOOT_SPL_HANDOFF,
23 TEST_TAG2 = BLOBLISTT_VBOOT_CTX,
24 TEST_TAG_MISSING = 0x10000,
28 TEST_SIZE_LARGE = 0x3e0,
30 TEST_ADDR = CONFIG_BLOBLIST_ADDR,
31 TEST_BLOBLIST_SIZE = 0x400,
36 static const char test1_str[] = "the eyes are open";
37 static const char test2_str[] = "the mouth moves";
39 static struct bloblist_hdr *clear_bloblist(void)
41 struct bloblist_hdr *hdr;
44 * Clear out any existing bloblist so we have a clean slate. Zero the
45 * header so that existing records are removed, but set everything else
46 * to 0xff for testing purposes.
48 hdr = map_sysmem(CONFIG_BLOBLIST_ADDR, TEST_BLOBLIST_SIZE);
49 memset(hdr, ERASE_BYTE, TEST_BLOBLIST_SIZE);
50 memset(hdr, '\0', sizeof(*hdr));
55 static int check_zero(void *data, int size)
60 for (ptr = data, i = 0; i < size; i++, ptr++) {
68 static int bloblist_test_init(struct unit_test_state *uts)
70 struct bloblist_hdr *hdr;
72 hdr = clear_bloblist();
73 ut_asserteq(-ENOENT, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
74 ut_asserteq_ptr(NULL, bloblist_check_magic(TEST_ADDR));
75 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
76 ut_asserteq_ptr(hdr, bloblist_check_magic(TEST_ADDR));
78 ut_asserteq(-EPROTONOSUPPORT, bloblist_check(TEST_ADDR,
81 ut_asserteq(-ENOSPC, bloblist_new(TEST_ADDR, 0x10, 0));
82 ut_asserteq(-EFAULT, bloblist_new(1, TEST_BLOBLIST_SIZE, 0));
83 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
85 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
86 ut_assertok(bloblist_finish());
87 ut_assertok(bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
90 ut_asserteq_ptr(NULL, bloblist_check_magic(TEST_ADDR));
94 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
98 BLOBLIST_TEST(bloblist_test_init, 0);
100 static int bloblist_test_blob(struct unit_test_state *uts)
102 struct bloblist_hdr *hdr;
103 struct bloblist_rec *rec, *rec2;
106 /* At the start there should be no records */
107 hdr = clear_bloblist();
108 ut_assertnull(bloblist_find(TEST_TAG, TEST_BLOBLIST_SIZE));
109 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
110 ut_asserteq(TEST_BLOBLIST_SIZE, bloblist_get_size());
111 ut_asserteq(TEST_ADDR, bloblist_get_base());
112 ut_asserteq(map_to_sysmem(hdr), TEST_ADDR);
114 /* Add a record and check that we can find it */
115 data = bloblist_add(TEST_TAG, TEST_SIZE, 0);
116 rec = (void *)(hdr + 1);
117 ut_asserteq_addr(rec + 1, data);
118 data = bloblist_find(TEST_TAG, TEST_SIZE);
119 ut_asserteq_addr(rec + 1, data);
121 /* Check the data is zeroed */
122 ut_assertok(check_zero(data, TEST_SIZE));
124 /* Check the 'ensure' method */
125 ut_asserteq_addr(data, bloblist_ensure(TEST_TAG, TEST_SIZE));
126 ut_assertnull(bloblist_ensure(TEST_TAG, TEST_SIZE2));
127 rec2 = (struct bloblist_rec *)(data + ALIGN(TEST_SIZE, BLOBLIST_ALIGN));
128 ut_assertok(check_zero(data, TEST_SIZE));
130 /* Check for a non-existent record */
131 ut_asserteq_addr(data, bloblist_ensure(TEST_TAG, TEST_SIZE));
132 ut_asserteq_addr(rec2 + 1, bloblist_ensure(TEST_TAG2, TEST_SIZE2));
133 ut_assertnull(bloblist_find(TEST_TAG_MISSING, 0));
137 BLOBLIST_TEST(bloblist_test_blob, 0);
139 /* Check bloblist_ensure_size_ret() */
140 static int bloblist_test_blob_ensure(struct unit_test_state *uts)
145 /* At the start there should be no records */
147 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
149 /* Test with an empty bloblist */
151 ut_assertok(bloblist_ensure_size_ret(TEST_TAG, &size, &data));
152 ut_asserteq(TEST_SIZE, size);
153 ut_assertok(check_zero(data, TEST_SIZE));
155 /* Check that we get the same thing again */
156 ut_assertok(bloblist_ensure_size_ret(TEST_TAG, &size, &data2));
157 ut_asserteq(TEST_SIZE, size);
158 ut_asserteq_addr(data, data2);
160 /* Check that the size remains the same */
162 ut_assertok(bloblist_ensure_size_ret(TEST_TAG, &size, &data));
163 ut_asserteq(TEST_SIZE, size);
165 /* Check running out of space */
166 size = TEST_SIZE_LARGE;
167 ut_asserteq(-ENOSPC, bloblist_ensure_size_ret(TEST_TAG2, &size, &data));
171 BLOBLIST_TEST(bloblist_test_blob_ensure, 0);
173 static int bloblist_test_bad_blob(struct unit_test_state *uts)
175 struct bloblist_hdr *hdr;
178 hdr = clear_bloblist();
179 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
181 data += sizeof(struct bloblist_rec);
182 ut_asserteq_addr(data, bloblist_ensure(TEST_TAG, TEST_SIZE));
183 ut_asserteq_addr(data, bloblist_ensure(TEST_TAG, TEST_SIZE));
187 BLOBLIST_TEST(bloblist_test_bad_blob, 0);
189 static int bloblist_test_checksum(struct unit_test_state *uts)
191 struct bloblist_hdr *hdr;
194 hdr = clear_bloblist();
195 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
196 ut_assertok(bloblist_finish());
197 ut_assertok(bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
200 * Now change things amd make sure that the checksum notices. We cannot
201 * change the size or alloced fields, since that will crash the code.
202 * It has to rely on these being correct.
205 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
209 ut_asserteq(-EFBIG, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
213 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
217 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
220 /* Make sure the checksum changes when we add blobs */
221 data = bloblist_add(TEST_TAG, TEST_SIZE, 0);
222 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
224 data2 = bloblist_add(TEST_TAG2, TEST_SIZE2, 0);
225 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
226 ut_assertok(bloblist_finish());
228 /* It should also change if we change the data */
229 ut_assertok(bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
231 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
234 ut_assertok(bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
236 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
240 * Changing data outside the range of valid data should affect the
243 ut_assertok(bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
245 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
247 ut_assertok(bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
250 ut_asserteq(-EIO, bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
252 ut_assertok(bloblist_check(TEST_ADDR, TEST_BLOBLIST_SIZE));
256 BLOBLIST_TEST(bloblist_test_checksum, 0);
258 /* Test the 'bloblist info' command */
259 static int bloblist_test_cmd_info(struct unit_test_state *uts)
261 struct bloblist_hdr *hdr;
264 hdr = clear_bloblist();
265 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
266 data = bloblist_ensure(TEST_TAG, TEST_SIZE);
267 data2 = bloblist_ensure(TEST_TAG2, TEST_SIZE2);
269 console_record_reset_enable();
270 ut_silence_console(uts);
271 console_record_reset();
272 run_command("bloblist info", 0);
273 ut_assert_nextline("base: %lx", (ulong)map_to_sysmem(hdr));
274 ut_assert_nextline("size: 400 1 KiB");
275 ut_assert_nextline("alloced: 70 112 Bytes");
276 ut_assert_nextline("free: 390 912 Bytes");
277 ut_assert_console_end();
278 ut_unsilence_console(uts);
282 BLOBLIST_TEST(bloblist_test_cmd_info, 0);
284 /* Test the 'bloblist list' command */
285 static int bloblist_test_cmd_list(struct unit_test_state *uts)
287 struct bloblist_hdr *hdr;
290 hdr = clear_bloblist();
291 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
292 data = bloblist_ensure(TEST_TAG, TEST_SIZE);
293 data2 = bloblist_ensure(TEST_TAG2, TEST_SIZE2);
295 console_record_reset_enable();
296 ut_silence_console(uts);
297 console_record_reset();
298 run_command("bloblist list", 0);
299 ut_assert_nextline("Address Size Tag Name");
300 ut_assert_nextline("%08lx %8x fff000 SPL hand-off",
301 (ulong)map_to_sysmem(data), TEST_SIZE);
302 ut_assert_nextline("%08lx %8x 202 Chrome OS vboot context",
303 (ulong)map_to_sysmem(data2), TEST_SIZE2);
304 ut_assert_console_end();
305 ut_unsilence_console(uts);
309 BLOBLIST_TEST(bloblist_test_cmd_list, 0);
311 /* Test alignment of bloblist blobs */
312 static int bloblist_test_align(struct unit_test_state *uts)
314 struct bloblist_hdr *hdr;
319 /* At the start there should be no records */
320 hdr = clear_bloblist();
321 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
322 ut_assertnull(bloblist_find(TEST_TAG, TEST_BLOBLIST_SIZE));
324 /* Check the default alignment */
325 for (i = 0; i < 3; i++) {
331 data = bloblist_add(i, size, 0);
332 ut_assertnonnull(data);
333 addr = map_to_sysmem(data);
334 ut_asserteq(0, addr & (BLOBLIST_ALIGN - 1));
336 /* Only the bytes in the blob data should be zeroed */
337 for (j = 0; j < size; j++)
338 ut_asserteq(0, data[j]);
339 for (; j < BLOBLIST_ALIGN; j++)
340 ut_asserteq(ERASE_BYTE, data[j]);
343 /* Check larger alignment */
344 for (i = 0; i < 3; i++) {
347 data = bloblist_add(3 + i, i * 4, align);
348 ut_assertnonnull(data);
349 addr = map_to_sysmem(data);
350 ut_asserteq(0, addr & (align - 1));
353 /* Check alignment with an bloblist starting on a smaller alignment */
354 hdr = map_sysmem(TEST_ADDR + BLOBLIST_ALIGN, TEST_BLOBLIST_SIZE);
355 memset(hdr, ERASE_BYTE, TEST_BLOBLIST_SIZE);
356 memset(hdr, '\0', sizeof(*hdr));
357 ut_assertok(bloblist_new(TEST_ADDR + BLOBLIST_ALIGN, TEST_BLOBLIST_SIZE,
360 data = bloblist_add(1, 5, BLOBLIST_ALIGN_LOG2 + 1);
361 ut_assertnonnull(data);
362 addr = map_to_sysmem(data);
363 ut_asserteq(0, addr & (BLOBLIST_ALIGN * 2 - 1));
367 BLOBLIST_TEST(bloblist_test_align, 0);
369 /* Test relocation of a bloblist */
370 static int bloblist_test_reloc(struct unit_test_state *uts)
372 const uint large_size = TEST_BLOBLIST_SIZE;
373 const uint small_size = 0x20;
374 void *old_ptr, *new_ptr;
379 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
380 old_ptr = map_sysmem(TEST_ADDR, TEST_BLOBLIST_SIZE);
382 /* Add one blob and then one that won't fit */
383 blob1 = bloblist_add(TEST_TAG, small_size, 0);
384 ut_assertnonnull(blob1);
385 blob2 = bloblist_add(TEST_TAG2, large_size, 0);
386 ut_assertnull(blob2);
388 /* Relocate the bloblist somewhere else, a bit larger */
389 new_addr = TEST_ADDR + TEST_BLOBLIST_SIZE;
390 new_size = TEST_BLOBLIST_SIZE + 0x100;
391 new_ptr = map_sysmem(new_addr, TEST_BLOBLIST_SIZE);
392 bloblist_reloc(new_ptr, new_size, old_ptr, TEST_BLOBLIST_SIZE);
393 gd->bloblist = new_ptr;
395 /* Check the old blob is there and that we can now add the bigger one */
396 ut_assertnonnull(bloblist_find(TEST_TAG, small_size));
397 ut_assertnull(bloblist_find(TEST_TAG2, small_size));
398 blob2 = bloblist_add(TEST_TAG2, large_size, 0);
399 ut_assertnonnull(blob2);
403 BLOBLIST_TEST(bloblist_test_reloc, 0);
405 /* Test expansion of a blob */
406 static int bloblist_test_grow(struct unit_test_state *uts)
408 const uint small_size = 0x20;
409 void *blob1, *blob2, *blob1_new;
410 struct bloblist_hdr *hdr;
413 ptr = map_sysmem(TEST_ADDR, TEST_BLOBLIST_SIZE);
415 memset(hdr, ERASE_BYTE, TEST_BLOBLIST_SIZE);
417 /* Create two blobs */
418 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
419 blob1 = bloblist_add(TEST_TAG, small_size, 0);
420 ut_assertnonnull(blob1);
421 ut_assertok(check_zero(blob1, small_size));
422 strcpy(blob1, test1_str);
424 blob2 = bloblist_add(TEST_TAG2, small_size, 0);
425 ut_assertnonnull(blob2);
426 strcpy(blob2, test2_str);
428 ut_asserteq(sizeof(struct bloblist_hdr) +
429 sizeof(struct bloblist_rec) * 2 + small_size * 2,
432 /* Resize the first one */
433 ut_assertok(bloblist_resize(TEST_TAG, small_size + 4));
435 /* The first one should not have moved, just got larger */
436 blob1_new = bloblist_find(TEST_TAG, small_size + 4);
437 ut_asserteq_ptr(blob1, blob1_new);
439 /* The new space should be zeroed */
440 ut_assertok(check_zero(blob1 + small_size, 4));
442 /* The second one should have moved */
443 blob2 = bloblist_find(TEST_TAG2, small_size);
444 ut_assertnonnull(blob2);
445 ut_asserteq_str(test2_str, blob2);
447 /* The header should have more bytes in use */
449 ut_asserteq(sizeof(struct bloblist_hdr) +
450 sizeof(struct bloblist_rec) * 2 + small_size * 2 +
456 BLOBLIST_TEST(bloblist_test_grow, 0);
458 /* Test shrinking of a blob */
459 static int bloblist_test_shrink(struct unit_test_state *uts)
461 const uint small_size = 0x20;
462 void *blob1, *blob2, *blob1_new;
463 struct bloblist_hdr *hdr;
467 ptr = map_sysmem(TEST_ADDR, TEST_BLOBLIST_SIZE);
469 /* Create two blobs */
470 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
471 blob1 = bloblist_add(TEST_TAG, small_size, 0);
472 ut_assertnonnull(blob1);
473 strcpy(blob1, test1_str);
475 blob2 = bloblist_add(TEST_TAG2, small_size, 0);
476 ut_assertnonnull(blob2);
477 strcpy(blob2, test2_str);
480 ut_asserteq(sizeof(struct bloblist_hdr) +
481 sizeof(struct bloblist_rec) * 2 + small_size * 2,
484 /* Resize the first one */
485 new_size = small_size - BLOBLIST_ALIGN - 4;
486 ut_assertok(bloblist_resize(TEST_TAG, new_size));
488 /* The first one should not have moved, just got smaller */
489 blob1_new = bloblist_find(TEST_TAG, new_size);
490 ut_asserteq_ptr(blob1, blob1_new);
492 /* The second one should have moved */
493 blob2 = bloblist_find(TEST_TAG2, small_size);
494 ut_assertnonnull(blob2);
495 ut_asserteq_str(test2_str, blob2);
497 /* The header should have fewer bytes in use */
499 ut_asserteq(sizeof(struct bloblist_hdr) +
500 sizeof(struct bloblist_rec) * 2 + small_size * 2 -
506 BLOBLIST_TEST(bloblist_test_shrink, 0);
508 /* Test failing to adjust a blob size */
509 static int bloblist_test_resize_fail(struct unit_test_state *uts)
511 const uint small_size = 0x20;
512 struct bloblist_hdr *hdr;
517 ptr = map_sysmem(TEST_ADDR, TEST_BLOBLIST_SIZE);
519 /* Create two blobs */
520 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
521 blob1 = bloblist_add(TEST_TAG, small_size, 0);
522 ut_assertnonnull(blob1);
524 blob2 = bloblist_add(TEST_TAG2, small_size, 0);
525 ut_assertnonnull(blob2);
528 ut_asserteq(sizeof(struct bloblist_hdr) +
529 sizeof(struct bloblist_rec) * 2 + small_size * 2,
532 /* Resize the first one, to check the boundary conditions */
533 ut_asserteq(-EINVAL, bloblist_resize(TEST_TAG, -1));
535 new_size = small_size + (hdr->size - hdr->alloced);
536 ut_asserteq(-ENOSPC, bloblist_resize(TEST_TAG, new_size + 1));
537 ut_assertok(bloblist_resize(TEST_TAG, new_size));
541 BLOBLIST_TEST(bloblist_test_resize_fail, 0);
543 /* Test expanding the last blob in a bloblist */
544 static int bloblist_test_resize_last(struct unit_test_state *uts)
546 const uint small_size = 0x20;
547 struct bloblist_hdr *hdr;
548 void *blob1, *blob2, *blob2_new;
552 ptr = map_sysmem(TEST_ADDR, TEST_BLOBLIST_SIZE);
553 memset(ptr, ERASE_BYTE, TEST_BLOBLIST_SIZE);
556 /* Create two blobs */
557 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
558 blob1 = bloblist_add(TEST_TAG, small_size, 0);
559 ut_assertnonnull(blob1);
561 blob2 = bloblist_add(TEST_TAG2, small_size, 0);
562 ut_assertnonnull(blob2);
564 /* Check the byte after the last blob */
565 alloced_val = sizeof(struct bloblist_hdr) +
566 sizeof(struct bloblist_rec) * 2 + small_size * 2;
567 ut_asserteq(alloced_val, hdr->alloced);
568 ut_asserteq_ptr((void *)hdr + alloced_val, blob2 + small_size);
569 ut_asserteq((u8)ERASE_BYTE, *((u8 *)hdr + hdr->alloced));
571 /* Resize the second one, checking nothing changes */
572 ut_asserteq(0, bloblist_resize(TEST_TAG2, small_size + 4));
574 blob2_new = bloblist_find(TEST_TAG2, small_size + 4);
575 ut_asserteq_ptr(blob2, blob2_new);
578 * the new blob should encompass the byte we checked now, so it should
579 * be zeroed. This zeroing should affect only the four new bytes added
582 ut_asserteq(0, *((u8 *)hdr + alloced_val));
583 ut_asserteq((u8)ERASE_BYTE, *((u8 *)hdr + alloced_val + 4));
585 /* Check that the new top of the allocated blobs has not been touched */
586 alloced_val += BLOBLIST_ALIGN;
587 ut_asserteq(alloced_val, hdr->alloced);
588 ut_asserteq((u8)ERASE_BYTE, *((u8 *)hdr + hdr->alloced));
592 BLOBLIST_TEST(bloblist_test_resize_last, 0);
594 /* Check a completely full bloblist */
595 static int bloblist_test_blob_maxsize(struct unit_test_state *uts)
600 /* At the start there should be no records */
602 ut_assertok(bloblist_new(TEST_ADDR, TEST_BLOBLIST_SIZE, 0));
604 /* Add a blob that takes up all space */
605 size = TEST_BLOBLIST_SIZE - sizeof(struct bloblist_hdr) -
606 sizeof(struct bloblist_rec);
607 ptr = bloblist_add(TEST_TAG, size, 0);
608 ut_assertnonnull(ptr);
610 ptr = bloblist_add(TEST_TAG, size + 1, 0);
615 BLOBLIST_TEST(bloblist_test_blob_maxsize, 0);
617 int do_ut_bloblist(struct cmd_tbl *cmdtp, int flag, int argc,
620 struct unit_test *tests = UNIT_TEST_SUITE_START(bloblist_test);
621 const int n_ents = UNIT_TEST_SUITE_COUNT(bloblist_test);
623 return cmd_ut_category("bloblist", "bloblist_test_",
624 tests, n_ents, argc, argv);