blob: ba9cd05b47972ded092e045944f4aeeca77d75c4 [file] [log] [blame]
Randall Spanglere9213a72013-01-24 11:19:55 -08001/* Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -07002 * Use of this source code is governed by a BSD-style license that can be
3 * found in the LICENSE file.
4 */
5
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -07006#include <string.h>
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07007
Albert Chaulk534723a2013-03-20 14:46:50 -07008#include "../cgpt/cgpt.h"
Louis Yung-Chieh Lo0dce41c2010-05-17 22:45:30 -07009#include "cgptlib_internal.h"
Randall Spangler3dcf9dc2010-06-02 12:46:17 -070010#include "cgptlib_test.h"
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -070011#include "crc32.h"
Louis Yung-Chieh Lob31ddce2010-05-21 16:35:44 +080012#include "crc32_test.h"
Albert Chaulk534723a2013-03-20 14:46:50 -070013#include "errno.h"
14#include "flash_ts.h"
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -070015#include "gpt.h"
Albert Chaulk5c9e4532013-03-20 16:03:49 -070016#include "mtdlib.h"
vbendeb3ecaf772010-06-24 16:19:53 -070017#include "test_common.h"
Albert Chaulk534723a2013-03-20 14:46:50 -070018#define _STUB_IMPLEMENTATION_
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -070019#include "utility.h"
20
Randall Spanglere9213a72013-01-24 11:19:55 -080021/*
22 * Testing partition layout (sector_bytes=512)
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -070023 *
24 * LBA Size Usage
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -070025 * ---------------------------------------------------------
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -070026 * 0 1 PMBR
27 * 1 1 primary partition header
28 * 2 32 primary partition entries (128B * 128)
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -070029 * 34 100 kernel A (index: 0)
30 * 134 100 root A (index: 1)
31 * 234 100 root B (index: 2)
32 * 334 100 kernel B (index: 3)
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -070033 * 434 32 secondary partition entries
34 * 466 1 secondary partition header
35 * 467
36 */
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -070037#define KERNEL_A 0
Randall Spangler3dcf9dc2010-06-02 12:46:17 -070038#define KERNEL_B 1
39#define ROOTFS_A 2
40#define ROOTFS_B 3
41#define KERNEL_X 2 /* Overload ROOTFS_A, for some GetNext tests */
42#define KERNEL_Y 3 /* Overload ROOTFS_B, for some GetNext tests */
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -070043
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -070044#define DEFAULT_SECTOR_SIZE 512
45#define MAX_SECTOR_SIZE 4096
46#define DEFAULT_DRIVE_SECTORS 467
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -070047#define PARTITION_ENTRIES_SIZE TOTAL_ENTRIES_SIZE /* 16384 */
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -070048
Randall Spangler3dcf9dc2010-06-02 12:46:17 -070049static const Guid guid_zero = {{{0, 0, 0, 0, 0, {0, 0, 0, 0, 0, 0}}}};
50static const Guid guid_kernel = GPT_ENT_TYPE_CHROMEOS_KERNEL;
51static const Guid guid_rootfs = GPT_ENT_TYPE_CHROMEOS_ROOTFS;
52
Albert Chaulk534723a2013-03-20 14:46:50 -070053// cgpt_common.c requires these be defined if linked in.
54const char *progname = "CGPT-TEST";
55const char *command = "TEST";
56
57// Ramdisk for flash ts testing.
58static uint8_t *nand_drive = NULL;
59static uint32_t nand_drive_sz;
60static uint8_t *nand_bad_block_map = NULL;
61
Randall Spanglere9213a72013-01-24 11:19:55 -080062/*
63 * Copy a random-for-this-program-only Guid into the dest. The num parameter
Bill Richardsonaa8eda42010-08-27 09:31:26 -070064 * completely determines the Guid.
65 */
Randall Spanglere9213a72013-01-24 11:19:55 -080066static void SetGuid(void *dest, uint32_t num)
67{
68 Guid g = {{{num,0xd450,0x44bc,0xa6,0x93,
69 {0xb8,0xac,0x75,0x5f,0xcd,0x48}}}};
70 Memcpy(dest, &g, sizeof(Guid));
Bill Richardsonaa8eda42010-08-27 09:31:26 -070071}
Randall Spangler3dcf9dc2010-06-02 12:46:17 -070072
Randall Spanglere9213a72013-01-24 11:19:55 -080073/*
74 * Given a GptData pointer, first re-calculate entries CRC32 value, then reset
75 * header CRC32 value to 0, and calculate header CRC32 value. Both primary and
76 * secondary are updated.
77 */
78static void RefreshCrc32(GptData *gpt)
79{
80 GptHeader *header, *header2;
81 GptEntry *entries, *entries2;
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -070082
Randall Spanglere9213a72013-01-24 11:19:55 -080083 header = (GptHeader *)gpt->primary_header;
84 entries = (GptEntry *)gpt->primary_entries;
85 header2 = (GptHeader *)gpt->secondary_header;
86 entries2 = (GptEntry *)gpt->secondary_entries;
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -070087
Randall Spanglere9213a72013-01-24 11:19:55 -080088 header->entries_crc32 =
89 Crc32((uint8_t *)entries,
90 header->number_of_entries * header->size_of_entry);
91 header->header_crc32 = 0;
92 header->header_crc32 = Crc32((uint8_t *)header, header->size);
93 header2->entries_crc32 =
94 Crc32((uint8_t *)entries2,
95 header2->number_of_entries * header2->size_of_entry);
96 header2->header_crc32 = 0;
97 header2->header_crc32 = Crc32((uint8_t *)header2, header2->size);
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -070098}
99
Randall Spanglere9213a72013-01-24 11:19:55 -0800100static void ZeroHeaders(GptData *gpt)
101{
102 Memset(gpt->primary_header, 0, MAX_SECTOR_SIZE);
103 Memset(gpt->secondary_header, 0, MAX_SECTOR_SIZE);
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700104}
105
Randall Spanglere9213a72013-01-24 11:19:55 -0800106static void ZeroEntries(GptData *gpt)
107{
108 Memset(gpt->primary_entries, 0, PARTITION_ENTRIES_SIZE);
109 Memset(gpt->secondary_entries, 0, PARTITION_ENTRIES_SIZE);
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700110}
111
Randall Spanglere9213a72013-01-24 11:19:55 -0800112static void ZeroHeadersEntries(GptData *gpt)
113{
114 ZeroHeaders(gpt);
115 ZeroEntries(gpt);
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700116}
117
Randall Spanglere9213a72013-01-24 11:19:55 -0800118/*
119 * Return a pointer to a static GptData instance (no free is required).
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700120 * All fields are zero except 4 pointers linking to header and entries.
Randall Spanglere9213a72013-01-24 11:19:55 -0800121 * All content of headers and entries are zero.
122 */
123static GptData *GetEmptyGptData(void)
124{
125 static GptData gpt;
126 static uint8_t primary_header[MAX_SECTOR_SIZE];
127 static uint8_t primary_entries[PARTITION_ENTRIES_SIZE];
128 static uint8_t secondary_header[MAX_SECTOR_SIZE];
129 static uint8_t secondary_entries[PARTITION_ENTRIES_SIZE];
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700130
Randall Spanglere9213a72013-01-24 11:19:55 -0800131 Memset(&gpt, 0, sizeof(gpt));
132 gpt.primary_header = primary_header;
133 gpt.primary_entries = primary_entries;
134 gpt.secondary_header = secondary_header;
135 gpt.secondary_entries = secondary_entries;
136 ZeroHeadersEntries(&gpt);
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700137
Randall Spanglere9213a72013-01-24 11:19:55 -0800138 /* Initialize GptData internal states. */
139 gpt.current_kernel = CGPT_KERNEL_ENTRY_NOT_FOUND;
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -0700140
Randall Spanglere9213a72013-01-24 11:19:55 -0800141 return &gpt;
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700142}
143
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700144static MtdData *GetEmptyMtdData() {
145 static MtdData mtd;
146 Memset(&mtd, 0, sizeof(mtd));
147 mtd.current_kernel = CGPT_KERNEL_ENTRY_NOT_FOUND;
148 return &mtd;
149}
150
Randall Spanglere9213a72013-01-24 11:19:55 -0800151/*
152 * Fill in most of fields and creates the layout described in the top of this
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700153 * file. Before calling this function, primary/secondary header/entries must
154 * have been pointed to the buffer, say, a gpt returned from GetEmptyGptData().
155 * This function returns a good (valid) copy of GPT layout described in top of
Randall Spanglere9213a72013-01-24 11:19:55 -0800156 * this file.
157 */
158static void BuildTestGptData(GptData *gpt)
159{
160 GptHeader *header, *header2;
161 GptEntry *entries, *entries2;
162 Guid chromeos_kernel = GPT_ENT_TYPE_CHROMEOS_KERNEL;
163 Guid chromeos_rootfs = GPT_ENT_TYPE_CHROMEOS_ROOTFS;
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700164
Randall Spanglere9213a72013-01-24 11:19:55 -0800165 gpt->sector_bytes = DEFAULT_SECTOR_SIZE;
166 gpt->drive_sectors = DEFAULT_DRIVE_SECTORS;
167 gpt->current_kernel = CGPT_KERNEL_ENTRY_NOT_FOUND;
168 gpt->valid_headers = MASK_BOTH;
169 gpt->valid_entries = MASK_BOTH;
170 gpt->modified = 0;
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700171
Randall Spanglere9213a72013-01-24 11:19:55 -0800172 /* Build primary */
173 header = (GptHeader *)gpt->primary_header;
174 entries = (GptEntry *)gpt->primary_entries;
175 Memcpy(header->signature, GPT_HEADER_SIGNATURE,
176 sizeof(GPT_HEADER_SIGNATURE));
177 header->revision = GPT_HEADER_REVISION;
178 header->size = sizeof(GptHeader);
179 header->reserved_zero = 0;
180 header->my_lba = 1;
181 header->alternate_lba = DEFAULT_DRIVE_SECTORS - 1;
182 header->first_usable_lba = 34;
183 header->last_usable_lba = DEFAULT_DRIVE_SECTORS - 1 - 32 - 1; /* 433 */
184 header->entries_lba = 2;
185 /* 512B / 128B * 32sectors = 128 entries */
186 header->number_of_entries = 128;
187 header->size_of_entry = 128; /* bytes */
188 Memcpy(&entries[0].type, &chromeos_kernel, sizeof(chromeos_kernel));
189 SetGuid(&entries[0].unique, 0);
190 entries[0].starting_lba = 34;
191 entries[0].ending_lba = 133;
192 Memcpy(&entries[1].type, &chromeos_rootfs, sizeof(chromeos_rootfs));
193 SetGuid(&entries[1].unique, 1);
194 entries[1].starting_lba = 134;
195 entries[1].ending_lba = 232;
196 Memcpy(&entries[2].type, &chromeos_rootfs, sizeof(chromeos_rootfs));
197 SetGuid(&entries[2].unique, 2);
198 entries[2].starting_lba = 234;
199 entries[2].ending_lba = 331;
200 Memcpy(&entries[3].type, &chromeos_kernel, sizeof(chromeos_kernel));
201 SetGuid(&entries[3].unique, 3);
202 entries[3].starting_lba = 334;
203 entries[3].ending_lba = 430;
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700204
Randall Spanglere9213a72013-01-24 11:19:55 -0800205 /* Build secondary */
206 header2 = (GptHeader *)gpt->secondary_header;
207 entries2 = (GptEntry *)gpt->secondary_entries;
208 Memcpy(header2, header, sizeof(GptHeader));
209 Memcpy(entries2, entries, PARTITION_ENTRIES_SIZE);
210 header2->my_lba = DEFAULT_DRIVE_SECTORS - 1; /* 466 */
211 header2->alternate_lba = 1;
212 header2->entries_lba = DEFAULT_DRIVE_SECTORS - 1 - 32; /* 434 */
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700213
Randall Spanglere9213a72013-01-24 11:19:55 -0800214 RefreshCrc32(gpt);
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700215}
216
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700217static void BuildTestMtdData(MtdData *mtd) {
218 MtdDiskPartition *partitions;
219
220 mtd->sector_bytes = DEFAULT_SECTOR_SIZE;
221 mtd->drive_sectors = DEFAULT_DRIVE_SECTORS;
222 mtd->current_kernel = CGPT_KERNEL_ENTRY_NOT_FOUND;
223 mtd->modified = 0;
224 Memset(&mtd->primary, 0, sizeof(mtd->primary));
225
226 Memcpy(mtd->primary.signature, MTD_DRIVE_SIGNATURE,
227 sizeof(mtd->primary.signature));
228 mtd->primary.first_lba = 32;
229 mtd->primary.last_lba = DEFAULT_DRIVE_SECTORS - 1;
230 mtd->primary.size = MTD_DRIVE_V1_SIZE;
231
232 /* These values are not used directly by the library, but they are checked */
233 mtd->flash_page_bytes = mtd->sector_bytes * 8;
234 mtd->flash_block_bytes = mtd->flash_page_bytes * 8;
235 mtd->fts_block_offset = 1;
236 mtd->fts_block_size = 1;
237
238 partitions = &mtd->primary.partitions[0];
239 partitions[0].starting_lba = 34;
240 partitions[0].ending_lba = 133;
241 partitions[0].flags =
242 MTD_PARTITION_TYPE_CHROMEOS_KERNEL << MTD_ATTRIBUTE_TYPE_OFFSET;
243 partitions[1].starting_lba = 134;
244 partitions[1].ending_lba = 232;
245 partitions[1].flags =
246 MTD_PARTITION_TYPE_CHROMEOS_ROOTFS << MTD_ATTRIBUTE_TYPE_OFFSET;
247 partitions[2].starting_lba = 234;
248 partitions[2].ending_lba = 331;
249 partitions[2].flags =
250 MTD_PARTITION_TYPE_CHROMEOS_KERNEL << MTD_ATTRIBUTE_TYPE_OFFSET;
251 partitions[3].starting_lba = 334;
252 partitions[3].ending_lba = 430;
253 partitions[3].flags =
254 MTD_PARTITION_TYPE_CHROMEOS_ROOTFS << MTD_ATTRIBUTE_TYPE_OFFSET;
255
256 mtd->primary.crc32 = 0;
257 mtd->primary.crc32 = Crc32(&mtd->primary, MTD_DRIVE_V1_SIZE);
258}
259
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700260
Randall Spanglere9213a72013-01-24 11:19:55 -0800261/*
262 * Test if the structures are the expected size; if this fails, struct packing
263 * is not working properly.
264 */
265static int StructSizeTest(void)
266{
Randall Spangler81d09962010-06-23 10:15:38 -0700267
Randall Spanglere9213a72013-01-24 11:19:55 -0800268 EXPECT(GUID_EXPECTED_SIZE == sizeof(Guid));
269 EXPECT(GPTHEADER_EXPECTED_SIZE == sizeof(GptHeader));
270 EXPECT(GPTENTRY_EXPECTED_SIZE == sizeof(GptEntry));
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700271 EXPECT(MTDENTRY_EXPECTED_SIZE == sizeof(MtdDiskPartition));
272 EXPECT(MTDLAYOUT_EXPECTED_SIZE == sizeof(MtdDiskLayout));
Randall Spanglere9213a72013-01-24 11:19:55 -0800273 return TEST_OK;
Randall Spangler81d09962010-06-23 10:15:38 -0700274}
275
276
Randall Spanglere9213a72013-01-24 11:19:55 -0800277/* Test if the default structure returned by BuildTestGptData() is good. */
278static int TestBuildTestGptData(void)
279{
280 GptData *gpt;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700281
Randall Spanglere9213a72013-01-24 11:19:55 -0800282 gpt = GetEmptyGptData();
283 BuildTestGptData(gpt);
284 EXPECT(GPT_SUCCESS == GptInit(gpt));
Randall Spangler0bda13f2013-01-24 12:25:26 -0800285 gpt->sector_bytes = 0;
286 EXPECT(GPT_ERROR_INVALID_SECTOR_SIZE == GptInit(gpt));
Randall Spanglere9213a72013-01-24 11:19:55 -0800287 return TEST_OK;
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700288}
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700289
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700290static int TestBuildTestMtdData() {
291 MtdData *mtd = GetEmptyMtdData();
292
293 BuildTestMtdData(mtd);
294 EXPECT(GPT_SUCCESS == MtdInit(mtd));
295 return TEST_OK;
296}
297
Randall Spanglere9213a72013-01-24 11:19:55 -0800298/*
299 * Test if wrong sector_bytes or drive_sectors is detected by GptInit().
300 * Currently we only support 512 bytes per sector. In the future, we may
301 * support other sizes. A too small drive_sectors should be rejected by
302 * GptInit().
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700303 * For MtdInit(), additionally test various flash geometries to verify
304 * that only valid ones are accepted.
Randall Spanglere9213a72013-01-24 11:19:55 -0800305 */
306static int ParameterTests(void)
307{
308 GptData *gpt;
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700309 MtdData *mtd;
Randall Spanglere9213a72013-01-24 11:19:55 -0800310 struct {
311 uint32_t sector_bytes;
312 uint64_t drive_sectors;
313 int expected_retval;
314 } cases[] = {
315 {512, DEFAULT_DRIVE_SECTORS, GPT_SUCCESS},
316 {520, DEFAULT_DRIVE_SECTORS, GPT_ERROR_INVALID_SECTOR_SIZE},
317 {512, 0, GPT_ERROR_INVALID_SECTOR_NUMBER},
318 {512, 66, GPT_ERROR_INVALID_SECTOR_NUMBER},
319 {512, GPT_PMBR_SECTOR + GPT_HEADER_SECTOR * 2 +
320 GPT_ENTRIES_SECTORS * 2, GPT_SUCCESS},
321 {4096, DEFAULT_DRIVE_SECTORS, GPT_ERROR_INVALID_SECTOR_SIZE},
322 };
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700323 struct {
324 uint32_t sector_bytes;
325 uint32_t drive_sectors;
326 uint32_t flash_page_bytes;
327 uint32_t flash_block_bytes;
328 int expected_retval;
329 } mtdcases[] = {
330 {512, DEFAULT_DRIVE_SECTORS, 8*512,
331 8*512, GPT_SUCCESS},
332 {510, DEFAULT_DRIVE_SECTORS, 8*512,
333 8*512, GPT_ERROR_INVALID_SECTOR_SIZE},
334 {512, DEFAULT_DRIVE_SECTORS, 8*512,
335 8*512, GPT_SUCCESS},
336 {512, DEFAULT_DRIVE_SECTORS, 512,
337 8*512, GPT_SUCCESS},
338 {512, DEFAULT_DRIVE_SECTORS, 8*512,
339 10*512, GPT_ERROR_INVALID_FLASH_GEOMETRY},
340 {512, DEFAULT_DRIVE_SECTORS, 3*512,
341 9*512, GPT_SUCCESS},
342 {512, DEFAULT_DRIVE_SECTORS, 8*512,
343 6*512, GPT_ERROR_INVALID_FLASH_GEOMETRY},
344 {512, DEFAULT_DRIVE_SECTORS, 256,
345 6*512, GPT_ERROR_INVALID_FLASH_GEOMETRY},
346 {512, DEFAULT_DRIVE_SECTORS, 512,
347 6*512 + 256, GPT_ERROR_INVALID_FLASH_GEOMETRY},
348 };
Randall Spanglere9213a72013-01-24 11:19:55 -0800349 int i;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700350
Randall Spanglere9213a72013-01-24 11:19:55 -0800351 gpt = GetEmptyGptData();
352 for (i = 0; i < ARRAY_SIZE(cases); ++i) {
353 BuildTestGptData(gpt);
354 gpt->sector_bytes = cases[i].sector_bytes;
355 gpt->drive_sectors = cases[i].drive_sectors;
356 EXPECT(cases[i].expected_retval == CheckParameters(gpt));
357 }
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700358
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700359 mtd = GetEmptyMtdData();
360 for (i = 0; i < ARRAY_SIZE(cases); ++i) {
361 BuildTestMtdData(mtd);
362 mtd->sector_bytes = mtdcases[i].sector_bytes;
363 mtd->drive_sectors = mtdcases[i].drive_sectors;
364 mtd->flash_block_bytes = mtdcases[i].flash_block_bytes;
365 mtd->flash_page_bytes = mtdcases[i].flash_page_bytes;
366 if(mtdcases[i].expected_retval != MtdCheckParameters(mtd)) {
367 printf("i=%d\n",i);
368 }
369 EXPECT(mtdcases[i].expected_retval == MtdCheckParameters(mtd));
370 }
371
Randall Spanglere9213a72013-01-24 11:19:55 -0800372 return TEST_OK;
Louis Yung-Chieh Lo37f6b552010-04-22 21:22:22 -0700373}
374
Randall Spanglere9213a72013-01-24 11:19:55 -0800375/* Test if header CRC in two copies are calculated. */
376static int HeaderCrcTest(void)
377{
378 GptData *gpt = GetEmptyGptData();
379 GptHeader *h1 = (GptHeader *)gpt->primary_header;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700380
Randall Spanglere9213a72013-01-24 11:19:55 -0800381 BuildTestGptData(gpt);
382 EXPECT(HeaderCrc(h1) == h1->header_crc32);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700383
Randall Spanglere9213a72013-01-24 11:19:55 -0800384 /* CRC covers first byte of header */
385 BuildTestGptData(gpt);
386 gpt->primary_header[0] ^= 0xa5;
387 EXPECT(HeaderCrc(h1) != h1->header_crc32);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700388
Randall Spanglere9213a72013-01-24 11:19:55 -0800389 /* CRC covers last byte of header */
390 BuildTestGptData(gpt);
391 gpt->primary_header[h1->size - 1] ^= 0x5a;
392 EXPECT(HeaderCrc(h1) != h1->header_crc32);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700393
Randall Spanglere9213a72013-01-24 11:19:55 -0800394 /* CRC only covers header */
395 BuildTestGptData(gpt);
396 gpt->primary_header[h1->size] ^= 0x5a;
397 EXPECT(HeaderCrc(h1) == h1->header_crc32);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700398
Randall Spanglere9213a72013-01-24 11:19:55 -0800399 return TEST_OK;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700400}
401
Randall Spangler0bda13f2013-01-24 12:25:26 -0800402/* Test if header-same comparison works. */
403static int HeaderSameTest(void)
404{
405 GptData *gpt = GetEmptyGptData();
406 GptHeader *h1 = (GptHeader *)gpt->primary_header;
407 GptHeader *h2 = (GptHeader *)gpt->secondary_header;
408 GptHeader h3;
409
410 EXPECT(0 == HeaderFieldsSame(h1, h2));
411
412 Memcpy(&h3, h2, sizeof(h3));
413 h3.signature[0] ^= 0xba;
414 EXPECT(1 == HeaderFieldsSame(h1, &h3));
415
416 Memcpy(&h3, h2, sizeof(h3));
417 h3.revision++;
418 EXPECT(1 == HeaderFieldsSame(h1, &h3));
419
420 Memcpy(&h3, h2, sizeof(h3));
421 h3.size++;
422 EXPECT(1 == HeaderFieldsSame(h1, &h3));
423
424 Memcpy(&h3, h2, sizeof(h3));
425 h3.reserved_zero++;
426 EXPECT(1 == HeaderFieldsSame(h1, &h3));
427
428 Memcpy(&h3, h2, sizeof(h3));
429 h3.first_usable_lba++;
430 EXPECT(1 == HeaderFieldsSame(h1, &h3));
431
432 Memcpy(&h3, h2, sizeof(h3));
433 h3.last_usable_lba++;
434 EXPECT(1 == HeaderFieldsSame(h1, &h3));
435
436 Memcpy(&h3, h2, sizeof(h3));
437 h3.disk_uuid.u.raw[0] ^= 0xba;
438 EXPECT(1 == HeaderFieldsSame(h1, &h3));
439
440 Memcpy(&h3, h2, sizeof(h3));
441 h3.number_of_entries++;
442 EXPECT(1 == HeaderFieldsSame(h1, &h3));
443
444 Memcpy(&h3, h2, sizeof(h3));
445 h3.size_of_entry++;
446 EXPECT(1 == HeaderFieldsSame(h1, &h3));
447
448 Memcpy(&h3, h2, sizeof(h3));
449 h3.entries_crc32++;
450 EXPECT(1 == HeaderFieldsSame(h1, &h3));
451
452 return TEST_OK;
453}
454
Randall Spanglere9213a72013-01-24 11:19:55 -0800455/* Test if signature ("EFI PART") is checked. */
456static int SignatureTest(void)
457{
458 GptData *gpt = GetEmptyGptData();
459 GptHeader *h1 = (GptHeader *)gpt->primary_header;
460 GptHeader *h2 = (GptHeader *)gpt->secondary_header;
461 int i;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700462
Randall Spangler0bda13f2013-01-24 12:25:26 -0800463 EXPECT(1 == CheckHeader(NULL, 0, gpt->drive_sectors));
464
Randall Spanglere9213a72013-01-24 11:19:55 -0800465 for (i = 0; i < 8; ++i) {
466 BuildTestGptData(gpt);
467 h1->signature[i] ^= 0xff;
468 h2->signature[i] ^= 0xff;
469 RefreshCrc32(gpt);
470 EXPECT(1 == CheckHeader(h1, 0, gpt->drive_sectors));
471 EXPECT(1 == CheckHeader(h2, 1, gpt->drive_sectors));
472 }
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700473
Randall Spanglere9213a72013-01-24 11:19:55 -0800474 return TEST_OK;
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700475}
476
Randall Spanglere9213a72013-01-24 11:19:55 -0800477/*
478 * The revision we currently support is GPT_HEADER_REVISION. If the revision
479 * in header is not that, we expect the header is invalid.
480 */
481static int RevisionTest(void)
482{
483 GptData *gpt = GetEmptyGptData();
484 GptHeader *h1 = (GptHeader *)gpt->primary_header;
485 GptHeader *h2 = (GptHeader *)gpt->secondary_header;
486 int i;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700487
Randall Spanglere9213a72013-01-24 11:19:55 -0800488 struct {
489 uint32_t value_to_test;
490 int expect_rv;
491 } cases[] = {
492 {0x01000000, 1},
493 {0x00010000, 0}, /* GPT_HEADER_REVISION */
494 {0x00000100, 1},
495 {0x00000001, 1},
496 {0x23010456, 1},
497 };
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700498
Randall Spanglere9213a72013-01-24 11:19:55 -0800499 for (i = 0; i < ARRAY_SIZE(cases); ++i) {
500 BuildTestGptData(gpt);
501 h1->revision = cases[i].value_to_test;
502 h2->revision = cases[i].value_to_test;
503 RefreshCrc32(gpt);
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700504
Randall Spanglere9213a72013-01-24 11:19:55 -0800505 EXPECT(CheckHeader(h1, 0, gpt->drive_sectors) ==
506 cases[i].expect_rv);
507 EXPECT(CheckHeader(h2, 1, gpt->drive_sectors) ==
508 cases[i].expect_rv);
509 }
510 return TEST_OK;
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700511}
512
Randall Spanglere9213a72013-01-24 11:19:55 -0800513static int SizeTest(void)
514{
515 GptData *gpt = GetEmptyGptData();
516 GptHeader *h1 = (GptHeader *)gpt->primary_header;
517 GptHeader *h2 = (GptHeader *)gpt->secondary_header;
518 int i;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700519
Randall Spanglere9213a72013-01-24 11:19:55 -0800520 struct {
521 uint32_t value_to_test;
522 int expect_rv;
523 } cases[] = {
524 {91, 1},
525 {92, 0},
526 {93, 0},
527 {511, 0},
528 {512, 0},
529 {513, 1},
530 };
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700531
Randall Spanglere9213a72013-01-24 11:19:55 -0800532 for (i = 0; i < ARRAY_SIZE(cases); ++i) {
533 BuildTestGptData(gpt);
534 h1->size = cases[i].value_to_test;
535 h2->size = cases[i].value_to_test;
536 RefreshCrc32(gpt);
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700537
Randall Spanglere9213a72013-01-24 11:19:55 -0800538 EXPECT(CheckHeader(h1, 0, gpt->drive_sectors) ==
539 cases[i].expect_rv);
540 EXPECT(CheckHeader(h2, 1, gpt->drive_sectors) ==
541 cases[i].expect_rv);
542 }
543 return TEST_OK;
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700544}
545
Randall Spanglere9213a72013-01-24 11:19:55 -0800546/* Test if CRC is checked. */
547static int CrcFieldTest(void)
548{
549 GptData *gpt = GetEmptyGptData();
550 GptHeader *h1 = (GptHeader *)gpt->primary_header;
551 GptHeader *h2 = (GptHeader *)gpt->secondary_header;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700552
Randall Spanglere9213a72013-01-24 11:19:55 -0800553 BuildTestGptData(gpt);
554 /* Modify a field that the header verification doesn't care about */
555 h1->entries_crc32++;
556 h2->entries_crc32++;
557 EXPECT(1 == CheckHeader(h1, 0, gpt->drive_sectors));
558 EXPECT(1 == CheckHeader(h2, 1, gpt->drive_sectors));
559 /* Refresh the CRC; should pass now */
560 RefreshCrc32(gpt);
561 EXPECT(0 == CheckHeader(h1, 0, gpt->drive_sectors));
562 EXPECT(0 == CheckHeader(h2, 1, gpt->drive_sectors));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700563
Randall Spanglere9213a72013-01-24 11:19:55 -0800564 return TEST_OK;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700565}
566
Randall Spanglere9213a72013-01-24 11:19:55 -0800567/* Test if reserved fields are checked. We'll try non-zero values to test. */
568static int ReservedFieldsTest(void)
569{
570 GptData *gpt = GetEmptyGptData();
571 GptHeader *h1 = (GptHeader *)gpt->primary_header;
572 GptHeader *h2 = (GptHeader *)gpt->secondary_header;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700573
Randall Spanglere9213a72013-01-24 11:19:55 -0800574 BuildTestGptData(gpt);
575 h1->reserved_zero ^= 0x12345678; /* whatever random */
576 h2->reserved_zero ^= 0x12345678; /* whatever random */
577 RefreshCrc32(gpt);
578 EXPECT(1 == CheckHeader(h1, 0, gpt->drive_sectors));
579 EXPECT(1 == CheckHeader(h2, 1, gpt->drive_sectors));
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700580
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700581#ifdef PADDING_CHECKED
Randall Spanglere9213a72013-01-24 11:19:55 -0800582 /* TODO: padding check is currently disabled */
583 BuildTestGptData(gpt);
584 h1->padding[12] ^= 0x34; /* whatever random */
585 h2->padding[56] ^= 0x78; /* whatever random */
586 RefreshCrc32(gpt);
587 EXPECT(1 == CheckHeader(h1, 0, gpt->drive_sectors));
588 EXPECT(1 == CheckHeader(h2, 1, gpt->drive_sectors));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700589#endif
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700590
Randall Spanglere9213a72013-01-24 11:19:55 -0800591 return TEST_OK;
592}
593
594/*
595 * Technically, any size which is 2^N where N > 6 should work, but our
596 * library only supports one size.
597 */
598static int SizeOfPartitionEntryTest(void) {
599 GptData *gpt = GetEmptyGptData();
600 GptHeader *h1 = (GptHeader *)gpt->primary_header;
601 GptHeader *h2 = (GptHeader *)gpt->secondary_header;
602 int i;
603
604 struct {
605 uint32_t value_to_test;
606 int expect_rv;
607 } cases[] = {
608 {127, 1},
609 {128, 0},
610 {129, 1},
611 {256, 1},
612 {512, 1},
613 };
614
615 /* Check size of entryes */
616 for (i = 0; i < ARRAY_SIZE(cases); ++i) {
617 BuildTestGptData(gpt);
618 h1->size_of_entry = cases[i].value_to_test;
619 h2->size_of_entry = cases[i].value_to_test;
620 h1->number_of_entries = TOTAL_ENTRIES_SIZE /
621 cases[i].value_to_test;
622 h2->number_of_entries = TOTAL_ENTRIES_SIZE /
623 cases[i].value_to_test;
624 RefreshCrc32(gpt);
625
626 EXPECT(CheckHeader(h1, 0, gpt->drive_sectors) ==
627 cases[i].expect_rv);
628 EXPECT(CheckHeader(h2, 1, gpt->drive_sectors) ==
629 cases[i].expect_rv);
630 }
631
632 return TEST_OK;
633}
634
635/*
636 * Technically, any size which is 2^N where N > 6 should work, but our library
637 * only supports one size.
638 */
639static int NumberOfPartitionEntriesTest(void)
640{
641 GptData *gpt = GetEmptyGptData();
642 GptHeader *h1 = (GptHeader *)gpt->primary_header;
643 GptHeader *h2 = (GptHeader *)gpt->secondary_header;
644
645 BuildTestGptData(gpt);
646 h1->number_of_entries--;
647 h2->number_of_entries /= 2;
648 RefreshCrc32(gpt);
649 EXPECT(1 == CheckHeader(h1, 0, gpt->drive_sectors));
650 EXPECT(1 == CheckHeader(h2, 1, gpt->drive_sectors));
651
652 return TEST_OK;
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -0700653}
654
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700655
Randall Spanglere9213a72013-01-24 11:19:55 -0800656/* Test if myLBA field is checked (1 for primary, last for secondary). */
657static int MyLbaTest(void)
658{
659 GptData *gpt = GetEmptyGptData();
660 GptHeader *h1 = (GptHeader *)gpt->primary_header;
661 GptHeader *h2 = (GptHeader *)gpt->secondary_header;
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700662
Randall Spanglere9213a72013-01-24 11:19:55 -0800663 /* myLBA depends on primary vs secondary flag */
664 BuildTestGptData(gpt);
665 EXPECT(1 == CheckHeader(h1, 1, gpt->drive_sectors));
666 EXPECT(1 == CheckHeader(h2, 0, gpt->drive_sectors));
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700667
Randall Spanglere9213a72013-01-24 11:19:55 -0800668 BuildTestGptData(gpt);
669 h1->my_lba--;
670 h2->my_lba--;
671 RefreshCrc32(gpt);
672 EXPECT(1 == CheckHeader(h1, 0, gpt->drive_sectors));
673 EXPECT(1 == CheckHeader(h2, 1, gpt->drive_sectors));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700674
Randall Spanglere9213a72013-01-24 11:19:55 -0800675 BuildTestGptData(gpt);
676 h1->my_lba = 2;
677 h2->my_lba--;
678 RefreshCrc32(gpt);
679 EXPECT(1 == CheckHeader(h1, 0, gpt->drive_sectors));
680 EXPECT(1 == CheckHeader(h2, 1, gpt->drive_sectors));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700681
Randall Spanglere9213a72013-01-24 11:19:55 -0800682 /* We should ignore the alternate_lba field entirely */
683 BuildTestGptData(gpt);
684 h1->alternate_lba++;
685 h2->alternate_lba++;
686 RefreshCrc32(gpt);
687 EXPECT(0 == CheckHeader(h1, 0, gpt->drive_sectors));
688 EXPECT(0 == CheckHeader(h2, 1, gpt->drive_sectors));
689
690 BuildTestGptData(gpt);
691 h1->alternate_lba--;
692 h2->alternate_lba--;
693 RefreshCrc32(gpt);
694 EXPECT(0 == CheckHeader(h1, 0, gpt->drive_sectors));
695 EXPECT(0 == CheckHeader(h2, 1, gpt->drive_sectors));
696
697 BuildTestGptData(gpt);
698 h1->entries_lba++;
699 h2->entries_lba++;
700 RefreshCrc32(gpt);
701 EXPECT(1 == CheckHeader(h1, 0, gpt->drive_sectors));
702 EXPECT(1 == CheckHeader(h2, 1, gpt->drive_sectors));
703
704 BuildTestGptData(gpt);
705 h1->entries_lba--;
706 h2->entries_lba--;
707 RefreshCrc32(gpt);
708 EXPECT(1 == CheckHeader(h1, 0, gpt->drive_sectors));
709 EXPECT(1 == CheckHeader(h2, 1, gpt->drive_sectors));
710
711 return TEST_OK;
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -0700712}
713
Randall Spanglere9213a72013-01-24 11:19:55 -0800714/* Test if FirstUsableLBA and LastUsableLBA are checked.
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -0700715 * FirstUsableLBA must be after the end of the primary GPT table array.
716 * LastUsableLBA must be before the start of the secondary GPT table array.
717 * FirstUsableLBA <= LastUsableLBA. */
Randall Spanglere9213a72013-01-24 11:19:55 -0800718static int FirstUsableLbaAndLastUsableLbaTest(void)
719{
720 GptData *gpt = GetEmptyGptData();
721 GptHeader *h1 = (GptHeader *)gpt->primary_header;
722 GptHeader *h2 = (GptHeader *)gpt->secondary_header;
723 int i;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700724
Randall Spanglere9213a72013-01-24 11:19:55 -0800725 struct {
726 uint64_t primary_entries_lba;
727 uint64_t primary_first_usable_lba;
728 uint64_t primary_last_usable_lba;
729 uint64_t secondary_first_usable_lba;
730 uint64_t secondary_last_usable_lba;
731 uint64_t secondary_entries_lba;
732 int primary_rv;
733 int secondary_rv;
734 } cases[] = {
735 {2, 34, 433, 34, 433, 434, 0, 0},
736 {2, 34, 432, 34, 430, 434, 0, 0},
737 {2, 33, 433, 33, 433, 434, 1, 1},
738 {2, 34, 434, 34, 433, 434, 1, 0},
739 {2, 34, 433, 34, 434, 434, 0, 1},
740 {2, 35, 433, 35, 433, 434, 0, 0},
741 {2, 433, 433, 433, 433, 434, 0, 0},
742 {2, 434, 433, 434, 434, 434, 1, 1},
743 {2, 433, 34, 34, 433, 434, 1, 0},
744 {2, 34, 433, 433, 34, 434, 0, 1},
745 };
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700746
Randall Spanglere9213a72013-01-24 11:19:55 -0800747 for (i = 0; i < ARRAY_SIZE(cases); ++i) {
748 BuildTestGptData(gpt);
749 h1->entries_lba = cases[i].primary_entries_lba;
750 h1->first_usable_lba = cases[i].primary_first_usable_lba;
751 h1->last_usable_lba = cases[i].primary_last_usable_lba;
752 h2->entries_lba = cases[i].secondary_entries_lba;
753 h2->first_usable_lba = cases[i].secondary_first_usable_lba;
754 h2->last_usable_lba = cases[i].secondary_last_usable_lba;
755 RefreshCrc32(gpt);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700756
Randall Spanglere9213a72013-01-24 11:19:55 -0800757 EXPECT(CheckHeader(h1, 0, gpt->drive_sectors) ==
758 cases[i].primary_rv);
759 EXPECT(CheckHeader(h2, 1, gpt->drive_sectors) ==
760 cases[i].secondary_rv);
761 }
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700762
Randall Spanglere9213a72013-01-24 11:19:55 -0800763 return TEST_OK;
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -0700764}
765
Randall Spanglere9213a72013-01-24 11:19:55 -0800766/*
767 * Test if PartitionEntryArrayCRC32 is checked. PartitionEntryArrayCRC32 must
768 * be calculated over SizeOfPartitionEntry * NumberOfPartitionEntries bytes.
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -0700769 */
Randall Spanglere9213a72013-01-24 11:19:55 -0800770static int EntriesCrcTest(void)
771{
772 GptData *gpt = GetEmptyGptData();
773 GptHeader *h1 = (GptHeader *)gpt->primary_header;
774 GptEntry *e1 = (GptEntry *)(gpt->primary_entries);
775 GptEntry *e2 = (GptEntry *)(gpt->secondary_entries);
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700776
Randall Spanglere9213a72013-01-24 11:19:55 -0800777 /* Modify first byte of primary entries, and expect the CRC is wrong. */
778 BuildTestGptData(gpt);
779 EXPECT(0 == CheckEntries(e1, h1));
780 EXPECT(0 == CheckEntries(e2, h1));
781 gpt->primary_entries[0] ^= 0xa5; /* just XOR a non-zero value */
782 gpt->secondary_entries[TOTAL_ENTRIES_SIZE-1] ^= 0x5a;
783 EXPECT(GPT_ERROR_CRC_CORRUPTED == CheckEntries(e1, h1));
784 EXPECT(GPT_ERROR_CRC_CORRUPTED == CheckEntries(e2, h1));
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700785
Randall Spanglere9213a72013-01-24 11:19:55 -0800786 return TEST_OK;
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700787}
788
Randall Spanglere9213a72013-01-24 11:19:55 -0800789/*
790 * Test if partition geometry is checked.
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -0700791 * All active (non-zero PartitionTypeGUID) partition entries should have:
792 * entry.StartingLBA >= header.FirstUsableLBA
793 * entry.EndingLBA <= header.LastUsableLBA
794 * entry.StartingLBA <= entry.EndingLBA
795 */
Randall Spanglere9213a72013-01-24 11:19:55 -0800796static int ValidEntryTest(void)
797{
798 GptData *gpt = GetEmptyGptData();
799 GptHeader *h1 = (GptHeader *)gpt->primary_header;
800 GptEntry *e1 = (GptEntry *)(gpt->primary_entries);
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700801 MtdData *mtd = GetEmptyMtdData();
802 MtdDiskLayout *mh = &mtd->primary;
803 MtdDiskPartition *me = mh->partitions;
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700804
Randall Spanglere9213a72013-01-24 11:19:55 -0800805 /* error case: entry.StartingLBA < header.FirstUsableLBA */
806 BuildTestGptData(gpt);
807 e1[0].starting_lba = h1->first_usable_lba - 1;
808 RefreshCrc32(gpt);
809 EXPECT(GPT_ERROR_OUT_OF_REGION == CheckEntries(e1, h1));
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700810
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700811 BuildTestMtdData(mtd);
812 if (mh->first_lba > 0) {
813 me[0].starting_lba = mh->first_lba - 1;
814 mh->crc32 = MtdHeaderCrc(mh);
815 EXPECT(GPT_ERROR_OUT_OF_REGION == MtdCheckEntries(me, mh));
816 }
817
Randall Spanglere9213a72013-01-24 11:19:55 -0800818 /* error case: entry.EndingLBA > header.LastUsableLBA */
819 BuildTestGptData(gpt);
820 e1[2].ending_lba = h1->last_usable_lba + 1;
821 RefreshCrc32(gpt);
822 EXPECT(GPT_ERROR_OUT_OF_REGION == CheckEntries(e1, h1));
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700823
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700824 BuildTestMtdData(mtd);
825 me[0].ending_lba = mh->last_lba + 1;
826 mh->crc32 = MtdHeaderCrc(mh);
827 EXPECT(GPT_ERROR_OUT_OF_REGION == MtdCheckEntries(me, mh));
828
Randall Spanglere9213a72013-01-24 11:19:55 -0800829 /* error case: entry.StartingLBA > entry.EndingLBA */
830 BuildTestGptData(gpt);
831 e1[3].starting_lba = e1[3].ending_lba + 1;
832 RefreshCrc32(gpt);
833 EXPECT(GPT_ERROR_OUT_OF_REGION == CheckEntries(e1, h1));
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700834
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700835 BuildTestMtdData(mtd);
836 me[0].starting_lba = me[0].ending_lba + 1;
837 mh->crc32 = MtdHeaderCrc(mh);
838 EXPECT(GPT_ERROR_OUT_OF_REGION == MtdCheckEntries(me, mh));
839
Randall Spanglere9213a72013-01-24 11:19:55 -0800840 /* case: non active entry should be ignored. */
841 BuildTestGptData(gpt);
842 Memset(&e1[1].type, 0, sizeof(e1[1].type));
843 e1[1].starting_lba = e1[1].ending_lba + 1;
844 RefreshCrc32(gpt);
845 EXPECT(0 == CheckEntries(e1, h1));
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700846
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700847 BuildTestMtdData(mtd);
848 me[0].flags = 0;
849 me[0].starting_lba = me[0].ending_lba + 1;
850 mh->crc32 = MtdHeaderCrc(mh);
851 EXPECT(GPT_SUCCESS == MtdCheckEntries(me, mh));
852
Randall Spanglere9213a72013-01-24 11:19:55 -0800853 return TEST_OK;
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -0700854}
855
Randall Spanglere9213a72013-01-24 11:19:55 -0800856/* Test if overlapped partition tables can be detected. */
857static int OverlappedPartitionTest(void) {
858 GptData *gpt = GetEmptyGptData();
859 GptHeader *h = (GptHeader *)gpt->primary_header;
860 GptEntry *e = (GptEntry *)gpt->primary_entries;
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700861 MtdData *mtd = GetEmptyMtdData();
862 MtdDiskLayout *mh = &mtd->primary;
863 MtdDiskPartition *me = mh->partitions;
Randall Spanglere9213a72013-01-24 11:19:55 -0800864 int i, j;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700865
Randall Spanglere9213a72013-01-24 11:19:55 -0800866 struct {
867 int overlapped;
868 struct {
869 int active;
870 uint64_t starting_lba;
871 uint64_t ending_lba;
872 } entries[16]; /* enough for testing. */
873 } cases[] = {
874 {GPT_SUCCESS, {{0, 100, 199}}},
875 {GPT_SUCCESS, {{1, 100, 199}}},
876 {GPT_SUCCESS, {{1, 100, 150}, {1, 200, 250}, {1, 300, 350}}},
877 {GPT_ERROR_START_LBA_OVERLAP,
878 {{1, 200, 299}, {1, 100, 199}, {1, 100, 100}}},
879 {GPT_ERROR_END_LBA_OVERLAP,
880 {{1, 200, 299}, {1, 100, 199}, {1, 299, 299}}},
881 {GPT_SUCCESS, {{1, 300, 399}, {1, 200, 299}, {1, 100, 199}}},
882 {GPT_ERROR_END_LBA_OVERLAP,
883 {{1, 100, 199}, {1, 199, 299}, {1, 299, 399}}},
884 {GPT_ERROR_START_LBA_OVERLAP,
885 {{1, 100, 199}, {1, 200, 299}, {1, 75, 399}}},
886 {GPT_ERROR_START_LBA_OVERLAP,
887 {{1, 100, 199}, {1, 75, 250}, {1, 200, 299}}},
888 {GPT_ERROR_END_LBA_OVERLAP,
889 {{1, 75, 150}, {1, 100, 199}, {1, 200, 299}}},
890 {GPT_ERROR_START_LBA_OVERLAP,
891 {{1, 200, 299}, {1, 100, 199}, {1, 300, 399}, {1, 100, 399}}},
892 {GPT_SUCCESS,
893 {{1, 200, 299}, {1, 100, 199}, {1, 300, 399}, {0, 100, 399}}},
894 {GPT_ERROR_START_LBA_OVERLAP,
895 {{1, 200, 300}, {1, 100, 200}, {1, 100, 400}, {1, 300, 400}}},
896 {GPT_ERROR_START_LBA_OVERLAP,
897 {{0, 200, 300}, {1, 100, 200}, {1, 100, 400}, {1, 300, 400}}},
898 {GPT_SUCCESS,
899 {{1, 200, 300}, {1, 100, 199}, {0, 100, 400}, {0, 300, 400}}},
900 {GPT_ERROR_END_LBA_OVERLAP,
901 {{1, 200, 299}, {1, 100, 199}, {1, 199, 199}}},
902 {GPT_SUCCESS, {{1, 200, 299}, {0, 100, 199}, {1, 199, 199}}},
903 {GPT_SUCCESS, {{1, 200, 299}, {1, 100, 199}, {0, 199, 199}}},
904 {GPT_ERROR_START_LBA_OVERLAP,
905 {{1, 199, 199}, {1, 200, 200}, {1, 201, 201}, {1, 202, 202},
906 {1, 203, 203}, {1, 204, 204}, {1, 205, 205}, {1, 206, 206},
907 {1, 207, 207}, {1, 208, 208}, {1, 199, 199}}},
908 {GPT_SUCCESS,
909 {{1, 199, 199}, {1, 200, 200}, {1, 201, 201}, {1, 202, 202},
910 {1, 203, 203}, {1, 204, 204}, {1, 205, 205}, {1, 206, 206},
911 {1, 207, 207}, {1, 208, 208}, {0, 199, 199}}},
912 };
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700913
Randall Spanglere9213a72013-01-24 11:19:55 -0800914 for (i = 0; i < ARRAY_SIZE(cases); ++i) {
915 BuildTestGptData(gpt);
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700916 BuildTestMtdData(mtd);
917 Memset(mh->partitions, 0, sizeof(mh->partitions));
Randall Spanglere9213a72013-01-24 11:19:55 -0800918 ZeroEntries(gpt);
919 for(j = 0; j < ARRAY_SIZE(cases[0].entries); ++j) {
920 if (!cases[i].entries[j].starting_lba)
921 break;
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700922
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700923 if (cases[i].entries[j].active) {
Randall Spanglere9213a72013-01-24 11:19:55 -0800924 Memcpy(&e[j].type, &guid_kernel, sizeof(Guid));
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700925 me[j].flags =
926 MTD_PARTITION_TYPE_CHROMEOS_KERNEL << MTD_ATTRIBUTE_TYPE_OFFSET;
927 }
Randall Spanglere9213a72013-01-24 11:19:55 -0800928 SetGuid(&e[j].unique, j);
929 e[j].starting_lba = cases[i].entries[j].starting_lba;
930 e[j].ending_lba = cases[i].entries[j].ending_lba;
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700931 me[j].starting_lba = cases[i].entries[j].starting_lba;
932 me[j].ending_lba = cases[i].entries[j].ending_lba;
933
Randall Spanglere9213a72013-01-24 11:19:55 -0800934 }
935 RefreshCrc32(gpt);
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700936
Randall Spanglere9213a72013-01-24 11:19:55 -0800937 EXPECT(cases[i].overlapped == CheckEntries(e, h));
Albert Chaulk5c9e4532013-03-20 16:03:49 -0700938 EXPECT(cases[i].overlapped == MtdCheckEntries(me, mh));
Randall Spanglere9213a72013-01-24 11:19:55 -0800939 }
940 return TEST_OK;
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -0700941}
942
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700943/* Test both sanity checking and repair. */
Randall Spanglere9213a72013-01-24 11:19:55 -0800944static int SanityCheckTest(void)
945{
946 GptData *gpt = GetEmptyGptData();
947 GptHeader *h1 = (GptHeader *)gpt->primary_header;
Randall Spangler0bda13f2013-01-24 12:25:26 -0800948 GptEntry *e1 = (GptEntry *)gpt->primary_entries;
949 uint8_t *tempptr;
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -0700950
Randall Spanglere9213a72013-01-24 11:19:55 -0800951 /* Unmodified test data is completely sane */
952 BuildTestGptData(gpt);
953 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
954 EXPECT(MASK_BOTH == gpt->valid_headers);
955 EXPECT(MASK_BOTH == gpt->valid_entries);
956 /* Repair doesn't damage it */
957 GptRepair(gpt);
958 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
959 EXPECT(MASK_BOTH == gpt->valid_headers);
960 EXPECT(MASK_BOTH == gpt->valid_entries);
961 EXPECT(0 == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700962
Randall Spangler0bda13f2013-01-24 12:25:26 -0800963 /* Invalid sector size should fail */
964 BuildTestGptData(gpt);
965 gpt->sector_bytes = 1024;
966 EXPECT(GPT_ERROR_INVALID_SECTOR_SIZE == GptSanityCheck(gpt));
967
Randall Spanglere9213a72013-01-24 11:19:55 -0800968 /* Modify headers */
969 BuildTestGptData(gpt);
970 gpt->primary_header[0]++;
971 gpt->secondary_header[0]++;
972 EXPECT(GPT_ERROR_INVALID_HEADERS == GptSanityCheck(gpt));
973 EXPECT(0 == gpt->valid_headers);
974 EXPECT(0 == gpt->valid_entries);
975 /* Repair can't fix completely busted headers */
976 GptRepair(gpt);
977 EXPECT(GPT_ERROR_INVALID_HEADERS == GptSanityCheck(gpt));
978 EXPECT(0 == gpt->valid_headers);
979 EXPECT(0 == gpt->valid_entries);
980 EXPECT(0 == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700981
Randall Spanglere9213a72013-01-24 11:19:55 -0800982 BuildTestGptData(gpt);
983 gpt->primary_header[0]++;
984 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
985 EXPECT(MASK_SECONDARY == gpt->valid_headers);
986 EXPECT(MASK_BOTH == gpt->valid_entries);
987 GptRepair(gpt);
988 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
989 EXPECT(MASK_BOTH == gpt->valid_headers);
990 EXPECT(MASK_BOTH == gpt->valid_entries);
991 EXPECT(GPT_MODIFIED_HEADER1 == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -0700992
Randall Spanglere9213a72013-01-24 11:19:55 -0800993 BuildTestGptData(gpt);
994 gpt->secondary_header[0]++;
995 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
996 EXPECT(MASK_PRIMARY == gpt->valid_headers);
997 EXPECT(MASK_BOTH == gpt->valid_entries);
998 GptRepair(gpt);
999 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1000 EXPECT(MASK_BOTH == gpt->valid_headers);
1001 EXPECT(MASK_BOTH == gpt->valid_entries);
1002 EXPECT(GPT_MODIFIED_HEADER2 == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001003
Randall Spanglere9213a72013-01-24 11:19:55 -08001004 /*
1005 * Modify header1 and update its CRC. Since header2 is now different
1006 * than header1, it'll be the one considered invalid.
1007 */
1008 BuildTestGptData(gpt);
1009 h1->size++;
1010 RefreshCrc32(gpt);
1011 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1012 EXPECT(MASK_PRIMARY == gpt->valid_headers);
1013 EXPECT(MASK_BOTH == gpt->valid_entries);
1014 GptRepair(gpt);
1015 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1016 EXPECT(MASK_BOTH == gpt->valid_headers);
1017 EXPECT(MASK_BOTH == gpt->valid_entries);
1018 EXPECT(GPT_MODIFIED_HEADER2 == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001019
Randall Spanglere9213a72013-01-24 11:19:55 -08001020 /* Modify entries */
1021 BuildTestGptData(gpt);
1022 gpt->primary_entries[0]++;
1023 gpt->secondary_entries[0]++;
1024 EXPECT(GPT_ERROR_INVALID_ENTRIES == GptSanityCheck(gpt));
1025 EXPECT(MASK_BOTH == gpt->valid_headers);
1026 EXPECT(MASK_NONE == gpt->valid_entries);
1027 /* Repair can't fix both copies of entries being bad, either. */
1028 GptRepair(gpt);
1029 EXPECT(GPT_ERROR_INVALID_ENTRIES == GptSanityCheck(gpt));
1030 EXPECT(MASK_BOTH == gpt->valid_headers);
1031 EXPECT(MASK_NONE == gpt->valid_entries);
1032 EXPECT(0 == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001033
Randall Spanglere9213a72013-01-24 11:19:55 -08001034 BuildTestGptData(gpt);
1035 gpt->primary_entries[0]++;
1036 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1037 EXPECT(MASK_BOTH == gpt->valid_headers);
1038 EXPECT(MASK_SECONDARY == gpt->valid_entries);
1039 GptRepair(gpt);
1040 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1041 EXPECT(MASK_BOTH == gpt->valid_headers);
1042 EXPECT(MASK_BOTH == gpt->valid_entries);
1043 EXPECT(GPT_MODIFIED_ENTRIES1 == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001044
Randall Spanglere9213a72013-01-24 11:19:55 -08001045 BuildTestGptData(gpt);
1046 gpt->secondary_entries[0]++;
1047 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1048 EXPECT(MASK_BOTH == gpt->valid_headers);
1049 EXPECT(MASK_PRIMARY == gpt->valid_entries);
1050 GptRepair(gpt);
1051 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1052 EXPECT(MASK_BOTH == gpt->valid_headers);
1053 EXPECT(MASK_BOTH == gpt->valid_entries);
1054 EXPECT(GPT_MODIFIED_ENTRIES2 == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001055
Randall Spangler0bda13f2013-01-24 12:25:26 -08001056 /*
1057 * Modify entries and recompute CRCs, then make both primary and
1058 * secondary entry pointers use the secondary data. The primary
1059 * header will have the wrong entries CRC, so we should fall back
1060 * to the secondary header.
1061 */
1062 BuildTestGptData(gpt);
1063 e1->starting_lba++;
1064 RefreshCrc32(gpt);
1065 tempptr = gpt->primary_entries;
1066 gpt->primary_entries = gpt->secondary_entries;
1067 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1068 EXPECT(MASK_SECONDARY == gpt->valid_headers);
1069 EXPECT(MASK_BOTH == gpt->valid_entries);
1070 gpt->primary_entries = tempptr;
1071
Randall Spanglere9213a72013-01-24 11:19:55 -08001072 /* Modify both header and entries */
1073 BuildTestGptData(gpt);
1074 gpt->primary_header[0]++;
1075 gpt->primary_entries[0]++;
1076 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1077 EXPECT(MASK_SECONDARY == gpt->valid_headers);
1078 EXPECT(MASK_SECONDARY == gpt->valid_entries);
1079 GptRepair(gpt);
1080 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1081 EXPECT(MASK_BOTH == gpt->valid_headers);
1082 EXPECT(MASK_BOTH == gpt->valid_entries);
1083 EXPECT((GPT_MODIFIED_HEADER1 | GPT_MODIFIED_ENTRIES1) == gpt->modified);
Bill Richardsonaa8eda42010-08-27 09:31:26 -07001084
Randall Spanglere9213a72013-01-24 11:19:55 -08001085 BuildTestGptData(gpt);
1086 gpt->secondary_header[0]++;
1087 gpt->secondary_entries[0]++;
1088 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1089 EXPECT(MASK_PRIMARY == gpt->valid_headers);
1090 EXPECT(MASK_PRIMARY == gpt->valid_entries);
1091 GptRepair(gpt);
1092 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1093 EXPECT(MASK_BOTH == gpt->valid_headers);
1094 EXPECT(MASK_BOTH == gpt->valid_entries);
1095 EXPECT((GPT_MODIFIED_HEADER2 | GPT_MODIFIED_ENTRIES2) == gpt->modified);
Bill Richardsonaa8eda42010-08-27 09:31:26 -07001096
Randall Spanglere9213a72013-01-24 11:19:55 -08001097 /* Test cross-correction (h1+e2, h2+e1) */
1098 BuildTestGptData(gpt);
1099 gpt->primary_header[0]++;
1100 gpt->secondary_entries[0]++;
1101 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1102 EXPECT(MASK_SECONDARY == gpt->valid_headers);
1103 EXPECT(MASK_PRIMARY == gpt->valid_entries);
1104 GptRepair(gpt);
1105 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1106 EXPECT(MASK_BOTH == gpt->valid_headers);
1107 EXPECT(MASK_BOTH == gpt->valid_entries);
1108 EXPECT((GPT_MODIFIED_HEADER1 | GPT_MODIFIED_ENTRIES2) == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001109
Randall Spanglere9213a72013-01-24 11:19:55 -08001110 BuildTestGptData(gpt);
1111 gpt->secondary_header[0]++;
1112 gpt->primary_entries[0]++;
1113 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1114 EXPECT(MASK_PRIMARY == gpt->valid_headers);
1115 EXPECT(MASK_SECONDARY == gpt->valid_entries);
1116 GptRepair(gpt);
1117 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1118 EXPECT(MASK_BOTH == gpt->valid_headers);
1119 EXPECT(MASK_BOTH == gpt->valid_entries);
1120 EXPECT((GPT_MODIFIED_HEADER2 | GPT_MODIFIED_ENTRIES1) == gpt->modified);
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -07001121
Randall Spanglere9213a72013-01-24 11:19:55 -08001122 /*
1123 * Test mismatched pairs (h1+e1 valid, h2+e2 valid but different. This
1124 * simulates a partial update of the drive.
1125 */
1126 BuildTestGptData(gpt);
1127 gpt->secondary_entries[0]++;
1128 RefreshCrc32(gpt);
1129 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1130 EXPECT(MASK_PRIMARY == gpt->valid_headers);
1131 EXPECT(MASK_PRIMARY == gpt->valid_entries);
1132 GptRepair(gpt);
1133 EXPECT(GPT_SUCCESS == GptSanityCheck(gpt));
1134 EXPECT(MASK_BOTH == gpt->valid_headers);
1135 EXPECT(MASK_BOTH == gpt->valid_entries);
1136 EXPECT((GPT_MODIFIED_HEADER2 | GPT_MODIFIED_ENTRIES2) == gpt->modified);
Louis Yung-Chieh Lo49fa8e52010-04-30 16:10:48 -07001137
Randall Spanglere9213a72013-01-24 11:19:55 -08001138 return TEST_OK;
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -07001139}
1140
Randall Spanglere9213a72013-01-24 11:19:55 -08001141static int EntryAttributeGetSetTest(void)
1142{
1143 GptData *gpt = GetEmptyGptData();
1144 GptEntry *e = (GptEntry *)(gpt->primary_entries);
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001145 MtdData *mtd = GetEmptyMtdData();
1146 MtdDiskPartition *m = &mtd->primary.partitions[0];
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001147
Randall Spanglere9213a72013-01-24 11:19:55 -08001148 e->attrs.whole = 0x0000000000000000ULL;
1149 SetEntrySuccessful(e, 1);
1150 EXPECT(0x0100000000000000ULL == e->attrs.whole);
1151 EXPECT(1 == GetEntrySuccessful(e));
1152 e->attrs.whole = 0xFFFFFFFFFFFFFFFFULL;
1153 SetEntrySuccessful(e, 0);
1154 EXPECT(0xFEFFFFFFFFFFFFFFULL == e->attrs.whole);
1155 EXPECT(0 == GetEntrySuccessful(e));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001156
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001157 m->flags = 0;
1158 MtdSetEntrySuccessful(m, 1);
1159 EXPECT(0x00000100 == m->flags);
1160 EXPECT(1 == MtdGetEntrySuccessful(m));
1161 m->flags = ~0;
1162 MtdSetEntrySuccessful(m, 0);
1163 EXPECT(0xFFFFFEFF == m->flags);
1164 EXPECT(0 == MtdGetEntrySuccessful(m));
1165
Randall Spanglere9213a72013-01-24 11:19:55 -08001166 e->attrs.whole = 0x0000000000000000ULL;
1167 SetEntryTries(e, 15);
1168 EXPECT(15 == GetEntryTries(e));
1169 EXPECT(0x00F0000000000000ULL == e->attrs.whole);
1170 e->attrs.whole = 0xFFFFFFFFFFFFFFFFULL;
1171 SetEntryTries(e, 0);
1172 EXPECT(0xFF0FFFFFFFFFFFFFULL == e->attrs.whole);
1173 EXPECT(0 == GetEntryTries(e));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001174
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001175 m->flags = 0;
1176 MtdSetEntryTries(m, 15);
1177 EXPECT(0x000000F0 == m->flags);
1178 EXPECT(15 == MtdGetEntryTries(m));
1179 m->flags = ~0;
1180 MtdSetEntryTries(m, 0);
1181 EXPECT(0xFFFFFF0F == m->flags);
1182 EXPECT(0 == MtdGetEntryTries(m));
1183
Randall Spanglere9213a72013-01-24 11:19:55 -08001184 e->attrs.whole = 0x0000000000000000ULL;
1185 SetEntryPriority(e, 15);
1186 EXPECT(0x000F000000000000ULL == e->attrs.whole);
1187 EXPECT(15 == GetEntryPriority(e));
1188 e->attrs.whole = 0xFFFFFFFFFFFFFFFFULL;
1189 SetEntryPriority(e, 0);
1190 EXPECT(0xFFF0FFFFFFFFFFFFULL == e->attrs.whole);
1191 EXPECT(0 == GetEntryPriority(e));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001192
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001193 m->flags = 0;
1194 MtdSetEntryPriority(m, 15);
1195 EXPECT(0x0000000F == m->flags);
1196 EXPECT(15 == MtdGetEntryPriority(m));
1197 m->flags = ~0;
1198 MtdSetEntryPriority(m, 0);
1199 EXPECT(0xFFFFFFF0 == m->flags);
1200 EXPECT(0 == MtdGetEntryPriority(m));
1201
Randall Spanglere9213a72013-01-24 11:19:55 -08001202 e->attrs.whole = 0xFFFFFFFFFFFFFFFFULL;
1203 EXPECT(1 == GetEntrySuccessful(e));
1204 EXPECT(15 == GetEntryPriority(e));
1205 EXPECT(15 == GetEntryTries(e));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001206
Randall Spanglere9213a72013-01-24 11:19:55 -08001207 e->attrs.whole = 0x0123000000000000ULL;
1208 EXPECT(1 == GetEntrySuccessful(e));
1209 EXPECT(2 == GetEntryTries(e));
1210 EXPECT(3 == GetEntryPriority(e));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001211
Randall Spanglere9213a72013-01-24 11:19:55 -08001212 return TEST_OK;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001213}
1214
Randall Spanglere9213a72013-01-24 11:19:55 -08001215static int EntryTypeTest(void)
1216{
1217 GptData *gpt = GetEmptyGptData();
1218 GptEntry *e = (GptEntry *)(gpt->primary_entries);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001219
Randall Spanglere9213a72013-01-24 11:19:55 -08001220 Memcpy(&e->type, &guid_zero, sizeof(Guid));
1221 EXPECT(1 == IsUnusedEntry(e));
1222 EXPECT(0 == IsKernelEntry(e));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001223
Randall Spanglere9213a72013-01-24 11:19:55 -08001224 Memcpy(&e->type, &guid_kernel, sizeof(Guid));
1225 EXPECT(0 == IsUnusedEntry(e));
1226 EXPECT(1 == IsKernelEntry(e));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001227
Randall Spanglere9213a72013-01-24 11:19:55 -08001228 Memcpy(&e->type, &guid_rootfs, sizeof(Guid));
1229 EXPECT(0 == IsUnusedEntry(e));
1230 EXPECT(0 == IsKernelEntry(e));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001231
Randall Spanglere9213a72013-01-24 11:19:55 -08001232 return TEST_OK;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001233}
1234
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001235/* Make an entry unused by clearing its type. */
Randall Spanglere9213a72013-01-24 11:19:55 -08001236static void FreeEntry(GptEntry *e)
1237{
1238 Memset(&e->type, 0, sizeof(Guid));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001239}
1240
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001241static void MtdFreeEntry(MtdDiskPartition *e)
1242{
1243 MtdSetEntryType(e, MTD_PARTITION_TYPE_UNUSED);
1244}
1245
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001246/* Set up an entry. */
Randall Spanglere9213a72013-01-24 11:19:55 -08001247static void FillEntry(GptEntry *e, int is_kernel,
1248 int priority, int successful, int tries)
1249{
1250 Memcpy(&e->type, (is_kernel ? &guid_kernel : &guid_zero), sizeof(Guid));
1251 SetEntryPriority(e, priority);
1252 SetEntrySuccessful(e, successful);
1253 SetEntryTries(e, tries);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001254}
1255
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001256static void MtdFillEntry(MtdDiskPartition *e, int is_kernel,
1257 int priority, int successful, int tries)
1258{
1259 MtdSetEntryType(e, is_kernel ? MTD_PARTITION_TYPE_CHROMEOS_KERNEL :
1260 MTD_PARTITION_TYPE_CHROMEOS_FIRMWARE);
1261 MtdSetEntryPriority(e, priority);
1262 MtdSetEntrySuccessful(e, successful);
1263 MtdSetEntryTries(e, tries);
1264}
1265
Randall Spanglere9213a72013-01-24 11:19:55 -08001266/*
1267 * Invalidate all kernel entries and expect GptNextKernelEntry() cannot find
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -07001268 * any usable kernel entry.
1269 */
Randall Spanglere9213a72013-01-24 11:19:55 -08001270static int NoValidKernelEntryTest(void)
1271{
1272 GptData *gpt = GetEmptyGptData();
1273 GptEntry *e1 = (GptEntry *)(gpt->primary_entries);
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -07001274
Randall Spanglere9213a72013-01-24 11:19:55 -08001275 BuildTestGptData(gpt);
1276 SetEntryPriority(e1 + KERNEL_A, 0);
1277 FreeEntry(e1 + KERNEL_B);
1278 RefreshCrc32(gpt);
1279 EXPECT(GPT_ERROR_NO_VALID_KERNEL ==
1280 GptNextKernelEntry(gpt, NULL, NULL));
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -07001281
Randall Spanglere9213a72013-01-24 11:19:55 -08001282 return TEST_OK;
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -07001283}
1284
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001285static int MtdNoValidKernelEntryTest(void)
1286{
1287 MtdData *mtd = GetEmptyMtdData();
1288 MtdDiskPartition *e1 = mtd->primary.partitions;
1289
1290 BuildTestMtdData(mtd);
1291 MtdSetEntryPriority(e1 + KERNEL_A, 0);
1292 MtdFreeEntry(e1 + KERNEL_B);
1293 EXPECT(GPT_ERROR_NO_VALID_KERNEL ==
1294 MtdNextKernelEntry(mtd, NULL, NULL));
1295
1296 return TEST_OK;
1297}
1298
Randall Spanglere9213a72013-01-24 11:19:55 -08001299static int GetNextNormalTest(void)
1300{
1301 GptData *gpt = GetEmptyGptData();
1302 GptEntry *e1 = (GptEntry *)(gpt->primary_entries);
1303 uint64_t start, size;
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -07001304
Randall Spanglere9213a72013-01-24 11:19:55 -08001305 /* Normal case - both kernels successful */
1306 BuildTestGptData(gpt);
1307 FillEntry(e1 + KERNEL_A, 1, 2, 1, 0);
1308 FillEntry(e1 + KERNEL_B, 1, 2, 1, 0);
1309 RefreshCrc32(gpt);
1310 GptInit(gpt);
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -07001311
Randall Spanglere9213a72013-01-24 11:19:55 -08001312 EXPECT(GPT_SUCCESS == GptNextKernelEntry(gpt, &start, &size));
1313 EXPECT(KERNEL_A == gpt->current_kernel);
1314 EXPECT(34 == start);
1315 EXPECT(100 == size);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001316
Randall Spanglere9213a72013-01-24 11:19:55 -08001317 EXPECT(GPT_SUCCESS == GptNextKernelEntry(gpt, &start, &size));
1318 EXPECT(KERNEL_B == gpt->current_kernel);
1319 EXPECT(134 == start);
1320 EXPECT(99 == size);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001321
Randall Spanglere9213a72013-01-24 11:19:55 -08001322 EXPECT(GPT_ERROR_NO_VALID_KERNEL ==
1323 GptNextKernelEntry(gpt, &start, &size));
1324 EXPECT(-1 == gpt->current_kernel);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001325
Randall Spanglere9213a72013-01-24 11:19:55 -08001326 /* Call as many times as you want; you won't get another kernel... */
1327 EXPECT(GPT_ERROR_NO_VALID_KERNEL ==
1328 GptNextKernelEntry(gpt, &start, &size));
1329 EXPECT(-1 == gpt->current_kernel);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001330
Randall Spanglere9213a72013-01-24 11:19:55 -08001331 return TEST_OK;
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -07001332}
1333
Randall Spanglere9213a72013-01-24 11:19:55 -08001334static int GetNextPrioTest(void)
1335{
1336 GptData *gpt = GetEmptyGptData();
1337 GptEntry *e1 = (GptEntry *)(gpt->primary_entries);
1338 uint64_t start, size;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001339
Randall Spanglere9213a72013-01-24 11:19:55 -08001340 /* Priority 3, 4, 0, 4 - should boot order B, Y, A */
1341 BuildTestGptData(gpt);
1342 FillEntry(e1 + KERNEL_A, 1, 3, 1, 0);
1343 FillEntry(e1 + KERNEL_B, 1, 4, 1, 0);
1344 FillEntry(e1 + KERNEL_X, 1, 0, 1, 0);
1345 FillEntry(e1 + KERNEL_Y, 1, 4, 1, 0);
1346 RefreshCrc32(gpt);
1347 GptInit(gpt);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001348
Randall Spanglere9213a72013-01-24 11:19:55 -08001349 EXPECT(GPT_SUCCESS == GptNextKernelEntry(gpt, &start, &size));
1350 EXPECT(KERNEL_B == gpt->current_kernel);
1351 EXPECT(GPT_SUCCESS == GptNextKernelEntry(gpt, &start, &size));
1352 EXPECT(KERNEL_Y == gpt->current_kernel);
1353 EXPECT(GPT_SUCCESS == GptNextKernelEntry(gpt, &start, &size));
1354 EXPECT(KERNEL_A == gpt->current_kernel);
1355 EXPECT(GPT_ERROR_NO_VALID_KERNEL ==
1356 GptNextKernelEntry(gpt, &start, &size));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001357
Randall Spanglere9213a72013-01-24 11:19:55 -08001358 return TEST_OK;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001359}
1360
Randall Spanglere9213a72013-01-24 11:19:55 -08001361static int GetNextTriesTest(void)
1362{
1363 GptData *gpt = GetEmptyGptData();
1364 GptEntry *e1 = (GptEntry *)(gpt->primary_entries);
1365 uint64_t start, size;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001366
Randall Spanglere9213a72013-01-24 11:19:55 -08001367 /* Tries=nonzero is attempted just like success, but tries=0 isn't */
1368 BuildTestGptData(gpt);
1369 FillEntry(e1 + KERNEL_A, 1, 2, 1, 0);
1370 FillEntry(e1 + KERNEL_B, 1, 3, 0, 0);
1371 FillEntry(e1 + KERNEL_X, 1, 4, 0, 1);
1372 FillEntry(e1 + KERNEL_Y, 1, 0, 0, 5);
1373 RefreshCrc32(gpt);
1374 GptInit(gpt);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001375
Randall Spanglere9213a72013-01-24 11:19:55 -08001376 EXPECT(GPT_SUCCESS == GptNextKernelEntry(gpt, &start, &size));
1377 EXPECT(KERNEL_X == gpt->current_kernel);
1378 EXPECT(GPT_SUCCESS == GptNextKernelEntry(gpt, &start, &size));
1379 EXPECT(KERNEL_A == gpt->current_kernel);
1380 EXPECT(GPT_ERROR_NO_VALID_KERNEL ==
1381 GptNextKernelEntry(gpt, &start, &size));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001382
Randall Spanglere9213a72013-01-24 11:19:55 -08001383 return TEST_OK;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001384}
1385
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001386static int MtdGetNextNormalTest(void)
1387{
1388 MtdData *mtd = GetEmptyMtdData();
1389 MtdDiskPartition *e1 = mtd->primary.partitions;
1390 uint64_t start, size;
1391
1392 /* Normal case - both kernels successful */
1393 BuildTestMtdData(mtd);
1394 MtdFillEntry(e1 + KERNEL_A, 1, 2, 1, 0);
1395 MtdFillEntry(e1 + KERNEL_B, 1, 2, 1, 0);
1396 mtd->primary.crc32 = MtdHeaderCrc(&mtd->primary);
1397 MtdInit(mtd);
1398
1399 EXPECT(GPT_SUCCESS == MtdNextKernelEntry(mtd, &start, &size));
1400 EXPECT(KERNEL_A == mtd->current_kernel);
1401 EXPECT(34 == start);
1402 EXPECT(100 == size);
1403
1404 EXPECT(GPT_SUCCESS == MtdNextKernelEntry(mtd, &start, &size));
1405 EXPECT(KERNEL_B == mtd->current_kernel);
1406 EXPECT(134 == start);
1407 EXPECT(99 == size);
1408
1409 EXPECT(GPT_ERROR_NO_VALID_KERNEL ==
1410 MtdNextKernelEntry(mtd, &start, &size));
1411 EXPECT(-1 == mtd->current_kernel);
1412
1413 /* Call as many times as you want; you won't get another kernel... */
1414 EXPECT(GPT_ERROR_NO_VALID_KERNEL ==
1415 MtdNextKernelEntry(mtd, &start, &size));
1416 EXPECT(-1 == mtd->current_kernel);
1417
1418 return TEST_OK;
1419}
1420
1421static int MtdGetNextPrioTest(void)
1422{
1423 MtdData *mtd = GetEmptyMtdData();
1424 MtdDiskPartition *e1 = mtd->primary.partitions;
1425 uint64_t start, size;
1426
1427 /* Priority 3, 4, 0, 4 - should boot order B, Y, A */
1428 BuildTestMtdData(mtd);
1429 MtdFillEntry(e1 + KERNEL_A, 1, 3, 1, 0);
1430 MtdFillEntry(e1 + KERNEL_B, 1, 4, 1, 0);
1431 MtdFillEntry(e1 + KERNEL_X, 1, 0, 1, 0);
1432 MtdFillEntry(e1 + KERNEL_Y, 1, 4, 1, 0);
1433 mtd->primary.crc32 = MtdHeaderCrc(&mtd->primary);
1434 MtdInit(mtd);
1435
1436 EXPECT(GPT_SUCCESS == MtdNextKernelEntry(mtd, &start, &size));
1437 EXPECT(KERNEL_B == mtd->current_kernel);
1438 EXPECT(GPT_SUCCESS == MtdNextKernelEntry(mtd, &start, &size));
1439 EXPECT(KERNEL_Y == mtd->current_kernel);
1440 EXPECT(GPT_SUCCESS == MtdNextKernelEntry(mtd, &start, &size));
1441 EXPECT(KERNEL_A == mtd->current_kernel);
1442 EXPECT(GPT_ERROR_NO_VALID_KERNEL ==
1443 MtdNextKernelEntry(mtd, &start, &size));
1444
1445 return TEST_OK;
1446}
1447
1448static int MtdGetNextTriesTest(void)
1449{
1450 MtdData *mtd = GetEmptyMtdData();
1451 MtdDiskPartition *e1 = mtd->primary.partitions;
1452 uint64_t start, size;
1453
1454 /* Tries=nonzero is attempted just like success, but tries=0 isn't */
1455 BuildTestMtdData(mtd);
1456 MtdFillEntry(e1 + KERNEL_A, 1, 2, 1, 0);
1457 MtdFillEntry(e1 + KERNEL_B, 1, 3, 0, 0);
1458 MtdFillEntry(e1 + KERNEL_X, 1, 4, 0, 1);
1459 MtdFillEntry(e1 + KERNEL_Y, 1, 0, 0, 5);
1460 mtd->primary.crc32 = MtdHeaderCrc(&mtd->primary);
1461 MtdInit(mtd);
1462
1463 EXPECT(GPT_SUCCESS == MtdNextKernelEntry(mtd, &start, &size));
1464 EXPECT(KERNEL_X == mtd->current_kernel);
1465 EXPECT(GPT_SUCCESS == MtdNextKernelEntry(mtd, &start, &size));
1466 EXPECT(KERNEL_A == mtd->current_kernel);
1467 EXPECT(GPT_ERROR_NO_VALID_KERNEL ==
1468 MtdNextKernelEntry(mtd, &start, &size));
1469
1470 return TEST_OK;
1471}
1472
1473static int MtdUpdateTest() {
1474 MtdData *mtd = GetEmptyMtdData();
1475 MtdDiskPartition *e = &mtd->primary.partitions[0];
1476 uint64_t start, size;
1477
1478 BuildTestMtdData(mtd);
1479
1480 /* Tries=nonzero is attempted just like success, but tries=0 isn't */
1481 MtdFillEntry(e + KERNEL_A, 1, 4, 1, 0);
1482 MtdFillEntry(e + KERNEL_B, 1, 3, 0, 2);
1483 MtdFillEntry(e + KERNEL_X, 1, 2, 0, 2);
1484 mtd->primary.crc32 = MtdHeaderCrc(&mtd->primary);
1485 mtd->modified = 0;
1486 EXPECT(GPT_SUCCESS == MtdInit(mtd));
1487
1488 /* Successful kernel */
1489 EXPECT(GPT_SUCCESS == MtdNextKernelEntry(mtd, &start, &size));
1490 EXPECT(KERNEL_A == mtd->current_kernel);
1491 EXPECT(1 == MtdGetEntrySuccessful(e + KERNEL_A));
1492 EXPECT(4 == MtdGetEntryPriority(e + KERNEL_A));
1493 EXPECT(0 == MtdGetEntryTries(e + KERNEL_A));
1494 /* Trying successful kernel changes nothing */
1495 EXPECT(GPT_SUCCESS == MtdUpdateKernelEntry(mtd, GPT_UPDATE_ENTRY_TRY));
1496 EXPECT(1 == MtdGetEntrySuccessful(e + KERNEL_A));
1497 EXPECT(4 == MtdGetEntryPriority(e + KERNEL_A));
1498 EXPECT(0 == MtdGetEntryTries(e + KERNEL_A));
1499 EXPECT(0 == mtd->modified);
1500 /* Marking it bad also does not update it. */
1501 EXPECT(GPT_SUCCESS == MtdUpdateKernelEntry(mtd, GPT_UPDATE_ENTRY_BAD));
1502 EXPECT(1 == MtdGetEntrySuccessful(e + KERNEL_A));
1503 EXPECT(4 == MtdGetEntryPriority(e + KERNEL_A));
1504 EXPECT(0 == MtdGetEntryTries(e + KERNEL_A));
1505 EXPECT(0 == mtd->modified);
1506
1507 /* Kernel with tries */
1508 EXPECT(GPT_SUCCESS == MtdNextKernelEntry(mtd, &start, &size));
1509 EXPECT(KERNEL_B == mtd->current_kernel);
1510 EXPECT(0 == MtdGetEntrySuccessful(e + KERNEL_B));
1511 EXPECT(3 == MtdGetEntryPriority(e + KERNEL_B));
1512 EXPECT(2 == MtdGetEntryTries(e + KERNEL_B));
1513 /* Marking it bad clears it */
1514 EXPECT(GPT_SUCCESS == MtdUpdateKernelEntry(mtd, GPT_UPDATE_ENTRY_BAD));
1515 EXPECT(0 == MtdGetEntrySuccessful(e + KERNEL_B));
1516 EXPECT(0 == MtdGetEntryPriority(e + KERNEL_B));
1517 EXPECT(0 == MtdGetEntryTries(e + KERNEL_B));
1518 /* And that's caused the mtd to need updating */
1519 EXPECT(1 == mtd->modified);
1520
1521 /* Another kernel with tries */
1522 EXPECT(GPT_SUCCESS == MtdNextKernelEntry(mtd, &start, &size));
1523 EXPECT(KERNEL_X == mtd->current_kernel);
1524 EXPECT(0 == MtdGetEntrySuccessful(e + KERNEL_X));
1525 EXPECT(2 == MtdGetEntryPriority(e + KERNEL_X));
1526 EXPECT(2 == MtdGetEntryTries(e + KERNEL_X));
1527 /* Trying it uses up a try */
1528 EXPECT(GPT_SUCCESS == MtdUpdateKernelEntry(mtd, GPT_UPDATE_ENTRY_TRY));
1529 EXPECT(0 == MtdGetEntrySuccessful(e + KERNEL_X));
1530 EXPECT(2 == MtdGetEntryPriority(e + KERNEL_X));
1531 EXPECT(1 == MtdGetEntryTries(e + KERNEL_X));
1532 /* Trying it again marks it inactive */
1533 EXPECT(GPT_SUCCESS == MtdUpdateKernelEntry(mtd, GPT_UPDATE_ENTRY_TRY));
1534 EXPECT(0 == MtdGetEntrySuccessful(e + KERNEL_X));
1535 EXPECT(0 == MtdGetEntryPriority(e + KERNEL_X));
1536 EXPECT(0 == MtdGetEntryTries(e + KERNEL_X));
1537
1538 /* Can't update if entry isn't a kernel, or there isn't an entry */
1539 MtdSetEntryType(e + KERNEL_X, MTD_PARTITION_TYPE_UNUSED);
1540 EXPECT(GPT_ERROR_INVALID_UPDATE_TYPE ==
1541 MtdUpdateKernelEntry(mtd, GPT_UPDATE_ENTRY_BAD));
1542 mtd->current_kernel = CGPT_KERNEL_ENTRY_NOT_FOUND;
1543 EXPECT(GPT_ERROR_INVALID_UPDATE_TYPE ==
1544 MtdUpdateKernelEntry(mtd, GPT_UPDATE_ENTRY_BAD));
1545
1546 return TEST_OK;
1547}
1548
Randall Spanglere9213a72013-01-24 11:19:55 -08001549static int GptUpdateTest(void)
1550{
1551 GptData *gpt = GetEmptyGptData();
1552 GptEntry *e = (GptEntry *)(gpt->primary_entries);
1553 GptEntry *e2 = (GptEntry *)(gpt->secondary_entries);
1554 uint64_t start, size;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001555
Randall Spanglere9213a72013-01-24 11:19:55 -08001556 /* Tries=nonzero is attempted just like success, but tries=0 isn't */
1557 BuildTestGptData(gpt);
1558 FillEntry(e + KERNEL_A, 1, 4, 1, 0);
1559 FillEntry(e + KERNEL_B, 1, 3, 0, 2);
1560 FillEntry(e + KERNEL_X, 1, 2, 0, 2);
1561 RefreshCrc32(gpt);
1562 GptInit(gpt);
1563 gpt->modified = 0; /* Nothing modified yet */
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001564
Randall Spanglere9213a72013-01-24 11:19:55 -08001565 /* Successful kernel */
1566 EXPECT(GPT_SUCCESS == GptNextKernelEntry(gpt, &start, &size));
1567 EXPECT(KERNEL_A == gpt->current_kernel);
1568 EXPECT(1 == GetEntrySuccessful(e + KERNEL_A));
1569 EXPECT(4 == GetEntryPriority(e + KERNEL_A));
1570 EXPECT(0 == GetEntryTries(e + KERNEL_A));
1571 EXPECT(1 == GetEntrySuccessful(e2 + KERNEL_A));
1572 EXPECT(4 == GetEntryPriority(e2 + KERNEL_A));
1573 EXPECT(0 == GetEntryTries(e2 + KERNEL_A));
1574 /* Trying successful kernel changes nothing */
1575 EXPECT(GPT_SUCCESS == GptUpdateKernelEntry(gpt, GPT_UPDATE_ENTRY_TRY));
1576 EXPECT(1 == GetEntrySuccessful(e + KERNEL_A));
1577 EXPECT(4 == GetEntryPriority(e + KERNEL_A));
1578 EXPECT(0 == GetEntryTries(e + KERNEL_A));
1579 EXPECT(0 == gpt->modified);
1580 /* Marking it bad also does not update it. */
1581 EXPECT(GPT_SUCCESS == GptUpdateKernelEntry(gpt, GPT_UPDATE_ENTRY_BAD));
1582 EXPECT(1 == GetEntrySuccessful(e + KERNEL_A));
1583 EXPECT(4 == GetEntryPriority(e + KERNEL_A));
1584 EXPECT(0 == GetEntryTries(e + KERNEL_A));
1585 EXPECT(0 == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001586
Randall Spanglere9213a72013-01-24 11:19:55 -08001587 /* Kernel with tries */
1588 EXPECT(GPT_SUCCESS == GptNextKernelEntry(gpt, &start, &size));
1589 EXPECT(KERNEL_B == gpt->current_kernel);
1590 EXPECT(0 == GetEntrySuccessful(e + KERNEL_B));
1591 EXPECT(3 == GetEntryPriority(e + KERNEL_B));
1592 EXPECT(2 == GetEntryTries(e + KERNEL_B));
1593 /* Marking it bad clears it */
1594 EXPECT(GPT_SUCCESS == GptUpdateKernelEntry(gpt, GPT_UPDATE_ENTRY_BAD));
1595 EXPECT(0 == GetEntrySuccessful(e + KERNEL_B));
1596 EXPECT(0 == GetEntryPriority(e + KERNEL_B));
1597 EXPECT(0 == GetEntryTries(e + KERNEL_B));
1598 /* Which affects both copies of the partition entries */
1599 EXPECT(0 == GetEntrySuccessful(e2 + KERNEL_B));
1600 EXPECT(0 == GetEntryPriority(e2 + KERNEL_B));
1601 EXPECT(0 == GetEntryTries(e2 + KERNEL_B));
1602 /* And that's caused the GPT to need updating */
1603 EXPECT(0x0F == gpt->modified);
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001604
Randall Spanglere9213a72013-01-24 11:19:55 -08001605 /* Another kernel with tries */
1606 EXPECT(GPT_SUCCESS == GptNextKernelEntry(gpt, &start, &size));
1607 EXPECT(KERNEL_X == gpt->current_kernel);
1608 EXPECT(0 == GetEntrySuccessful(e + KERNEL_X));
1609 EXPECT(2 == GetEntryPriority(e + KERNEL_X));
1610 EXPECT(2 == GetEntryTries(e + KERNEL_X));
1611 /* Trying it uses up a try */
1612 EXPECT(GPT_SUCCESS == GptUpdateKernelEntry(gpt, GPT_UPDATE_ENTRY_TRY));
1613 EXPECT(0 == GetEntrySuccessful(e + KERNEL_X));
1614 EXPECT(2 == GetEntryPriority(e + KERNEL_X));
1615 EXPECT(1 == GetEntryTries(e + KERNEL_X));
1616 EXPECT(0 == GetEntrySuccessful(e2 + KERNEL_X));
1617 EXPECT(2 == GetEntryPriority(e2 + KERNEL_X));
1618 EXPECT(1 == GetEntryTries(e2 + KERNEL_X));
1619 /* Trying it again marks it inactive */
1620 EXPECT(GPT_SUCCESS == GptUpdateKernelEntry(gpt, GPT_UPDATE_ENTRY_TRY));
1621 EXPECT(0 == GetEntrySuccessful(e + KERNEL_X));
1622 EXPECT(0 == GetEntryPriority(e + KERNEL_X));
1623 EXPECT(0 == GetEntryTries(e + KERNEL_X));
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001624
Randall Spangler0bda13f2013-01-24 12:25:26 -08001625 /* Can't update if entry isn't a kernel, or there isn't an entry */
1626 Memcpy(&e[KERNEL_X].type, &guid_rootfs, sizeof(guid_rootfs));
1627 EXPECT(GPT_ERROR_INVALID_UPDATE_TYPE ==
1628 GptUpdateKernelEntry(gpt, GPT_UPDATE_ENTRY_BAD));
1629 gpt->current_kernel = CGPT_KERNEL_ENTRY_NOT_FOUND;
1630 EXPECT(GPT_ERROR_INVALID_UPDATE_TYPE ==
1631 GptUpdateKernelEntry(gpt, GPT_UPDATE_ENTRY_BAD));
1632
1633
Randall Spanglere9213a72013-01-24 11:19:55 -08001634 return TEST_OK;
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001635}
1636
Randall Spanglere9213a72013-01-24 11:19:55 -08001637/*
1638 * Give an invalid kernel type, and expect GptUpdateKernelEntry() returns
1639 * GPT_ERROR_INVALID_UPDATE_TYPE.
1640 */
1641static int UpdateInvalidKernelTypeTest(void)
1642{
1643 GptData *gpt = GetEmptyGptData();
Randall Spangler3dcf9dc2010-06-02 12:46:17 -07001644
Randall Spanglere9213a72013-01-24 11:19:55 -08001645 BuildTestGptData(gpt);
1646 /* anything, but not CGPT_KERNEL_ENTRY_NOT_FOUND */
1647 gpt->current_kernel = 0;
1648 /* any invalid update_type value */
1649 EXPECT(GPT_ERROR_INVALID_UPDATE_TYPE ==
1650 GptUpdateKernelEntry(gpt, 99));
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -07001651
Randall Spanglere9213a72013-01-24 11:19:55 -08001652 return TEST_OK;
Louis Yung-Chieh Lob17db3c2010-05-05 11:21:08 -07001653}
1654
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001655static int MtdUpdateInvalidKernelTypeTest(void)
1656{
1657 MtdData *mtd = GetEmptyMtdData();
1658
1659 BuildTestMtdData(mtd);
1660 /* anything, but not CGPT_KERNEL_ENTRY_NOT_FOUND */
1661 mtd->current_kernel = 0;
1662 /* any invalid update_type value */
1663 EXPECT(GPT_ERROR_INVALID_UPDATE_TYPE ==
1664 MtdUpdateKernelEntry(mtd, 99));
1665
1666 return TEST_OK;
1667}
1668
Randall Spanglere9213a72013-01-24 11:19:55 -08001669/* Test duplicate UniqueGuids can be detected. */
1670static int DuplicateUniqueGuidTest(void)
1671{
1672 GptData *gpt = GetEmptyGptData();
1673 GptHeader *h = (GptHeader *)gpt->primary_header;
1674 GptEntry *e = (GptEntry *)gpt->primary_entries;
1675 int i, j;
Bill Richardsonaa8eda42010-08-27 09:31:26 -07001676
Randall Spanglere9213a72013-01-24 11:19:55 -08001677 struct {
1678 int duplicate;
1679 struct {
1680 uint64_t starting_lba;
1681 uint64_t ending_lba;
1682 uint32_t type_guid;
1683 uint32_t unique_guid;
1684 } entries[16]; /* enough for testing. */
1685 } cases[] = {
1686 {GPT_SUCCESS, {{100, 109, 1, 1},
1687 {110, 119, 2, 2},
1688 {120, 129, 3, 3},
1689 {130, 139, 4, 4},
1690 }},
1691 {GPT_SUCCESS, {{100, 109, 1, 1},
1692 {110, 119, 1, 2},
1693 {120, 129, 2, 3},
1694 {130, 139, 2, 4},
1695 }},
1696 {GPT_ERROR_DUP_GUID, {{100, 109, 1, 1},
1697 {110, 119, 2, 2},
1698 {120, 129, 3, 1},
1699 {130, 139, 4, 4},
1700 }},
1701 {GPT_ERROR_DUP_GUID, {{100, 109, 1, 1},
1702 {110, 119, 1, 2},
1703 {120, 129, 2, 3},
1704 {130, 139, 2, 2},
1705 }},
1706 };
Bill Richardsonaa8eda42010-08-27 09:31:26 -07001707
Randall Spanglere9213a72013-01-24 11:19:55 -08001708 for (i = 0; i < ARRAY_SIZE(cases); ++i) {
1709 BuildTestGptData(gpt);
1710 ZeroEntries(gpt);
1711 for(j = 0; j < ARRAY_SIZE(cases[0].entries); ++j) {
1712 if (!cases[i].entries[j].starting_lba)
1713 break;
Bill Richardsonaa8eda42010-08-27 09:31:26 -07001714
Randall Spanglere9213a72013-01-24 11:19:55 -08001715 e[j].starting_lba = cases[i].entries[j].starting_lba;
1716 e[j].ending_lba = cases[i].entries[j].ending_lba;
1717 SetGuid(&e[j].type, cases[i].entries[j].type_guid);
1718 SetGuid(&e[j].unique, cases[i].entries[j].unique_guid);
1719 }
1720 RefreshCrc32(gpt);
Bill Richardsonaa8eda42010-08-27 09:31:26 -07001721
Randall Spanglere9213a72013-01-24 11:19:55 -08001722 EXPECT(cases[i].duplicate == CheckEntries(e, h));
1723 }
Bill Richardsonaa8eda42010-08-27 09:31:26 -07001724
Randall Spanglere9213a72013-01-24 11:19:55 -08001725 return TEST_OK;
Bill Richardsonaa8eda42010-08-27 09:31:26 -07001726}
1727
Randall Spangler0bda13f2013-01-24 12:25:26 -08001728/* Test getting the current kernel GUID */
1729static int GetKernelGuidTest(void)
1730{
1731 GptData *gpt = GetEmptyGptData();
1732 GptEntry *e = (GptEntry *)gpt->primary_entries;
1733 Guid g;
1734
1735 BuildTestGptData(gpt);
1736 gpt->current_kernel = 0;
1737 GetCurrentKernelUniqueGuid(gpt, &g);
1738 EXPECT(!Memcmp(&g, &e[0].unique, sizeof(Guid)));
1739 gpt->current_kernel = 1;
1740 GetCurrentKernelUniqueGuid(gpt, &g);
1741 EXPECT(!Memcmp(&g, &e[1].unique, sizeof(Guid)));
1742
1743 return TEST_OK;
1744}
1745
1746/* Test getting GPT error text strings */
1747static int ErrorTextTest(void)
1748{
1749 int i;
1750
1751 /* Known errors are not unknown */
1752 for (i = 0; i < GPT_ERROR_COUNT; i++) {
1753 EXPECT(GptErrorText(i));
1754 EXPECT(strcmp(GptErrorText(i), "Unknown"));
1755 }
1756
1757 /* But other error values are */
1758 EXPECT(!strcmp(GptErrorText(GPT_ERROR_COUNT), "Unknown"));
1759
1760 return TEST_OK;
1761}
1762
Albert Chaulk534723a2013-03-20 14:46:50 -07001763int nand_read_page(const nand_geom *nand, int page, void *buf, int size) {
1764 uint32_t ofs = page * nand->szofpg;
1765 uint32_t sz = size;
1766 if (ofs + sz > nand_drive_sz) {
1767 return -1;
1768 }
1769 Memcpy(buf, nand_drive + ofs, sz);
1770 return 0;
1771}
1772
1773int nand_write_page(const nand_geom *nand, int page,
1774 const void *buf, int size) {
1775 uint32_t ofs = page * nand->szofpg;
1776 uint32_t sz = size;
1777 uint32_t i;
1778 if (ofs + sz > nand_drive_sz) {
1779 return -1;
1780 }
1781 for (i = 0; i < sz; i++) {
1782 if (nand_drive[ofs + i] != 0xff) {
1783 return -1;
1784 }
1785 }
1786 Memcpy(nand_drive + ofs, buf, sz);
1787 return 0;
1788}
1789
1790int nand_erase_block(const nand_geom *nand, int block) {
1791 uint32_t ofs = block * nand->szofblk;
1792 uint32_t sz = nand->szofblk;
1793 if (ofs + sz > nand_drive_sz) {
1794 return -1;
1795 }
1796 if (!--nand_bad_block_map[block]) {
1797 return -1;
1798 }
1799 Memset(nand_drive + ofs, 0xFF, sz);
1800 return 0;
1801}
1802
1803int nand_is_bad_block(const nand_geom *nand, int block) {
1804 return nand_bad_block_map[block] == 0;
1805}
1806
1807
1808static void nand_make_ramdisk() {
1809 if (nand_drive) {
1810 free(nand_drive);
1811 }
1812 if (nand_bad_block_map) {
1813 free(nand_bad_block_map);
1814 }
1815 nand_drive_sz = 1024 * 1024 * 16;
1816 nand_drive = (uint8_t *)malloc(nand_drive_sz);
1817 nand_bad_block_map = (uint8_t *)malloc(nand_drive_sz / 512);
1818 Memset(nand_drive, 0xff, nand_drive_sz);
1819 Memset(nand_bad_block_map, 0xff, nand_drive_sz / 512);
1820}
1821
1822static int MtdFtsTest() {
1823 int MtdLoad(struct drive *drive, int sector_bytes);
1824 int MtdSave(struct drive *drive);
1825 int FlashGet(const char *key, uint8_t *data, uint32_t *bufsz);
1826 int FlashSet(const char *key, const uint8_t *data, uint32_t bufsz);
1827
1828 int i, j, err;
1829
1830 struct {
1831 int result;
1832 unsigned int offset, size, block_size_bytes, page_size_bytes;
1833 } cases[] = {
1834 { 0, 1, 2, 1024 * 1024, 1024 * 4 },
1835 { 0, 1, 2, 1024 * 1024, 1024 * 16 },
1836
1837 /* Failure cases, non-power-of-2 */
1838 { -ENODEV, 1, 2, 5000000, 1024 * 16 },
1839 { -ENODEV, 1, 2, 1024 * 1024, 65535 },
1840
1841 /* Page > block */
1842 { -ENODEV, 1, 2, 1024 * 16, 1024 * 1024 },
1843 };
1844
1845
1846 /* Check if the FTS store works */
1847 for (i = 0; i < ARRAY_SIZE(cases); i++) {
1848 nand_make_ramdisk();
1849 EXPECT(cases[i].result == flash_ts_init(cases[i].offset, cases[i].size,
1850 cases[i].page_size_bytes,
1851 cases[i].block_size_bytes, 512, 0));
1852
1853 if (cases[i].result == 0) {
1854 /* We should have a working FTS store now */
1855 char buffer[64];
1856 uint8_t blob[256], blob_read[256];
1857 uint32_t sz = sizeof(blob_read);
1858 struct drive drive;
1859
1860 /* Test the low level API */
1861 EXPECT(0 == flash_ts_set("some_key", "some value"));
1862 flash_ts_get("some_key", buffer, sizeof(buffer));
1863 EXPECT(0 == strcmp(buffer, "some value"));
1864
1865 /* Check overwrite */
1866 EXPECT(0 == flash_ts_set("some_key", "some other value"));
1867 flash_ts_get("some_key", buffer, sizeof(buffer));
1868 EXPECT(0 == strcmp(buffer, "some other value"));
1869
1870 /* Check delete */
1871 EXPECT(0 == flash_ts_set("some_key", ""));
1872
1873 /* Verify that re-initialization pulls the right record. */
1874 flash_ts_init(cases[i].offset, cases[i].size, cases[i].page_size_bytes,
1875 cases[i].block_size_bytes, 512, 0);
1876 flash_ts_get("some_key", buffer, sizeof(buffer));
1877 EXPECT(0 == strcmp(buffer, ""));
1878
1879 /* Fill up the disk, eating all erase cycles */
1880 for (j = 0; j < nand_drive_sz / 512; j++) {
1881 nand_bad_block_map[j] = 2;
1882 }
1883 for (j = 0; j < 999999; j++) {
1884 char str[32];
1885 sprintf(str, "%d", j);
1886 err = flash_ts_set("some_new_key", str);
1887 if (err) {
1888 EXPECT(err == -ENOMEM);
1889 break;
1890 }
1891
1892 /* Make sure we can figure out where the latest is. */
1893 flash_ts_init(cases[i].offset, cases[i].size, cases[i].page_size_bytes,
1894 cases[i].block_size_bytes, 512, 0);
1895 flash_ts_get("some_new_key", buffer, sizeof(buffer));
1896 EXPECT(0 == strcmp(buffer, str));
1897 }
1898 EXPECT(j < 999999);
1899
1900 /* We need our drive back. */
1901 nand_make_ramdisk();
1902 flash_ts_init(cases[i].offset, cases[i].size, cases[i].page_size_bytes,
1903 cases[i].block_size_bytes, 512, 0);
1904
1905
1906 for (j = 0; j < 256; j++) {
1907 blob[j] = j;
1908 }
1909
1910 /* Hex conversion / blob storage */
1911 EXPECT(0 == FlashSet("some_blob", blob, sizeof(blob)));
1912 EXPECT(0 == FlashGet("some_blob", blob_read, &sz));
1913 EXPECT(sz == sizeof(blob_read));
1914 EXPECT(0 == Memcmp(blob, blob_read, sizeof(blob)));
1915
1916 BuildTestMtdData(&drive.mtd);
1917 drive.mtd.flash_block_bytes = cases[i].block_size_bytes;
1918 drive.mtd.flash_page_bytes = cases[i].page_size_bytes;
1919 drive.mtd.fts_block_offset = cases[i].offset;
1920 drive.mtd.fts_block_size = cases[i].size;
1921 drive.mtd.sector_bytes = 512;
1922 drive.mtd.drive_sectors = nand_drive_sz / 512;
1923
1924 /* MTD-level API */
1925 EXPECT(0 == MtdSave(&drive));
1926 Memset(&drive.mtd.primary, 0, sizeof(drive.mtd.primary));
1927 EXPECT(0 == MtdLoad(&drive, 512));
1928 }
1929 }
1930
1931 return TEST_OK;
1932}
1933
Randall Spanglere9213a72013-01-24 11:19:55 -08001934int main(int argc, char *argv[])
1935{
1936 int i;
1937 int error_count = 0;
1938 struct {
1939 char *name;
1940 test_func fp;
1941 int retval;
1942 } test_cases[] = {
1943 { TEST_CASE(StructSizeTest), },
1944 { TEST_CASE(TestBuildTestGptData), },
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001945 { TEST_CASE(TestBuildTestMtdData), },
Randall Spanglere9213a72013-01-24 11:19:55 -08001946 { TEST_CASE(ParameterTests), },
1947 { TEST_CASE(HeaderCrcTest), },
Randall Spangler0bda13f2013-01-24 12:25:26 -08001948 { TEST_CASE(HeaderSameTest), },
Randall Spanglere9213a72013-01-24 11:19:55 -08001949 { TEST_CASE(SignatureTest), },
1950 { TEST_CASE(RevisionTest), },
1951 { TEST_CASE(SizeTest), },
1952 { TEST_CASE(CrcFieldTest), },
1953 { TEST_CASE(ReservedFieldsTest), },
1954 { TEST_CASE(SizeOfPartitionEntryTest), },
1955 { TEST_CASE(NumberOfPartitionEntriesTest), },
1956 { TEST_CASE(MyLbaTest), },
1957 { TEST_CASE(FirstUsableLbaAndLastUsableLbaTest), },
1958 { TEST_CASE(EntriesCrcTest), },
1959 { TEST_CASE(ValidEntryTest), },
1960 { TEST_CASE(OverlappedPartitionTest), },
1961 { TEST_CASE(SanityCheckTest), },
1962 { TEST_CASE(NoValidKernelEntryTest), },
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001963 { TEST_CASE(MtdNoValidKernelEntryTest), },
Randall Spanglere9213a72013-01-24 11:19:55 -08001964 { TEST_CASE(EntryAttributeGetSetTest), },
1965 { TEST_CASE(EntryTypeTest), },
1966 { TEST_CASE(GetNextNormalTest), },
1967 { TEST_CASE(GetNextPrioTest), },
1968 { TEST_CASE(GetNextTriesTest), },
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001969 { TEST_CASE(MtdGetNextNormalTest), },
1970 { TEST_CASE(MtdGetNextPrioTest), },
1971 { TEST_CASE(MtdGetNextTriesTest), },
Randall Spanglere9213a72013-01-24 11:19:55 -08001972 { TEST_CASE(GptUpdateTest), },
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001973 { TEST_CASE(MtdUpdateTest), },
Randall Spanglere9213a72013-01-24 11:19:55 -08001974 { TEST_CASE(UpdateInvalidKernelTypeTest), },
Albert Chaulk5c9e4532013-03-20 16:03:49 -07001975 { TEST_CASE(MtdUpdateInvalidKernelTypeTest), },
Randall Spanglere9213a72013-01-24 11:19:55 -08001976 { TEST_CASE(DuplicateUniqueGuidTest), },
1977 { TEST_CASE(TestCrc32TestVectors), },
Randall Spangler0bda13f2013-01-24 12:25:26 -08001978 { TEST_CASE(GetKernelGuidTest), },
1979 { TEST_CASE(ErrorTextTest), },
Albert Chaulk534723a2013-03-20 14:46:50 -07001980 { TEST_CASE(MtdFtsTest), },
Randall Spanglere9213a72013-01-24 11:19:55 -08001981 };
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -07001982
Randall Spanglere9213a72013-01-24 11:19:55 -08001983 for (i = 0; i < sizeof(test_cases)/sizeof(test_cases[0]); ++i) {
1984 printf("Running %s() ...\n", test_cases[i].name);
1985 test_cases[i].retval = test_cases[i].fp();
1986 if (test_cases[i].retval) {
1987 printf(COL_RED "[ERROR]\n\n" COL_STOP);
1988 ++error_count;
1989 } else {
1990 printf(COL_GREEN "[PASS]\n\n" COL_STOP);
1991 }
1992 }
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -07001993
Randall Spanglere9213a72013-01-24 11:19:55 -08001994 if (error_count) {
1995 printf("\n------------------------------------------------\n");
1996 printf(COL_RED "The following %d test cases are failed:\n"
1997 COL_STOP, error_count);
1998 for (i = 0; i < sizeof(test_cases)/sizeof(test_cases[0]); ++i) {
1999 if (test_cases[i].retval)
2000 printf(" %s()\n", test_cases[i].name);
2001 }
2002 }
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -07002003
Randall Spanglere9213a72013-01-24 11:19:55 -08002004 return error_count ? 1 : 0;
Louis Yung-Chieh Lo4bbf21e2010-04-21 17:29:05 -07002005}