xref: /aosp_15_r20/external/vboot_reference/cgpt/cgpt_create.c (revision 8617a60d3594060b7ecbd21bc622a7c14f3cf2bc)
1*8617a60dSAndroid Build Coastguard Worker /* Copyright 2012 The ChromiumOS Authors
2*8617a60dSAndroid Build Coastguard Worker  * Use of this source code is governed by a BSD-style license that can be
3*8617a60dSAndroid Build Coastguard Worker  * found in the LICENSE file.
4*8617a60dSAndroid Build Coastguard Worker  */
5*8617a60dSAndroid Build Coastguard Worker 
6*8617a60dSAndroid Build Coastguard Worker #include <string.h>
7*8617a60dSAndroid Build Coastguard Worker 
8*8617a60dSAndroid Build Coastguard Worker #include "cgpt.h"
9*8617a60dSAndroid Build Coastguard Worker #include "cgptlib_internal.h"
10*8617a60dSAndroid Build Coastguard Worker #include "vboot_host.h"
11*8617a60dSAndroid Build Coastguard Worker 
AllocAndClear(uint8_t ** buf,uint64_t size)12*8617a60dSAndroid Build Coastguard Worker static void AllocAndClear(uint8_t **buf, uint64_t size) {
13*8617a60dSAndroid Build Coastguard Worker   if (*buf) {
14*8617a60dSAndroid Build Coastguard Worker     memset(*buf, 0, size);
15*8617a60dSAndroid Build Coastguard Worker   } else {
16*8617a60dSAndroid Build Coastguard Worker     *buf = calloc(1, size);
17*8617a60dSAndroid Build Coastguard Worker     if (!*buf) {
18*8617a60dSAndroid Build Coastguard Worker       Error("Cannot allocate %" PRIu64 " bytes.\n", size);
19*8617a60dSAndroid Build Coastguard Worker       abort();
20*8617a60dSAndroid Build Coastguard Worker     }
21*8617a60dSAndroid Build Coastguard Worker   }
22*8617a60dSAndroid Build Coastguard Worker }
23*8617a60dSAndroid Build Coastguard Worker 
GptCreate(struct drive * drive,CgptCreateParams * params)24*8617a60dSAndroid Build Coastguard Worker static int GptCreate(struct drive *drive, CgptCreateParams *params) {
25*8617a60dSAndroid Build Coastguard Worker   // Do not replace any existing IGNOREME GPT headers.
26*8617a60dSAndroid Build Coastguard Worker   if (!memcmp(((GptHeader*)drive->gpt.primary_header)->signature,
27*8617a60dSAndroid Build Coastguard Worker               GPT_HEADER_SIGNATURE_IGNORED, GPT_HEADER_SIGNATURE_SIZE)) {
28*8617a60dSAndroid Build Coastguard Worker     drive->gpt.ignored |= MASK_PRIMARY;
29*8617a60dSAndroid Build Coastguard Worker     Warning("Primary GPT was marked ignored, will not overwrite.\n");
30*8617a60dSAndroid Build Coastguard Worker   }
31*8617a60dSAndroid Build Coastguard Worker 
32*8617a60dSAndroid Build Coastguard Worker   if (!memcmp(((GptHeader*)drive->gpt.secondary_header)->signature,
33*8617a60dSAndroid Build Coastguard Worker               GPT_HEADER_SIGNATURE_IGNORED, GPT_HEADER_SIGNATURE_SIZE)) {
34*8617a60dSAndroid Build Coastguard Worker     drive->gpt.ignored |= MASK_SECONDARY;
35*8617a60dSAndroid Build Coastguard Worker     Warning("Secondary GPT was marked ignored, will not overwrite.\n");
36*8617a60dSAndroid Build Coastguard Worker   }
37*8617a60dSAndroid Build Coastguard Worker 
38*8617a60dSAndroid Build Coastguard Worker   // Allocate and/or erase the data.
39*8617a60dSAndroid Build Coastguard Worker   // We cannot assume the GPT headers or entry arrays have been allocated
40*8617a60dSAndroid Build Coastguard Worker   // by GptLoad() because those fields might have failed validation checks.
41*8617a60dSAndroid Build Coastguard Worker   AllocAndClear(&drive->gpt.primary_header,
42*8617a60dSAndroid Build Coastguard Worker                 drive->gpt.sector_bytes * GPT_HEADER_SECTORS);
43*8617a60dSAndroid Build Coastguard Worker   AllocAndClear(&drive->gpt.secondary_header,
44*8617a60dSAndroid Build Coastguard Worker                 drive->gpt.sector_bytes * GPT_HEADER_SECTORS);
45*8617a60dSAndroid Build Coastguard Worker 
46*8617a60dSAndroid Build Coastguard Worker   drive->gpt.modified |= (GPT_MODIFIED_HEADER1 | GPT_MODIFIED_ENTRIES1 |
47*8617a60dSAndroid Build Coastguard Worker                          GPT_MODIFIED_HEADER2 | GPT_MODIFIED_ENTRIES2);
48*8617a60dSAndroid Build Coastguard Worker 
49*8617a60dSAndroid Build Coastguard Worker   // Initialize a blank set
50*8617a60dSAndroid Build Coastguard Worker   if (!params->zap) {
51*8617a60dSAndroid Build Coastguard Worker     GptHeader *h = (GptHeader *)drive->gpt.primary_header;
52*8617a60dSAndroid Build Coastguard Worker     memcpy(h->signature, GPT_HEADER_SIGNATURE, GPT_HEADER_SIGNATURE_SIZE);
53*8617a60dSAndroid Build Coastguard Worker     h->revision = GPT_HEADER_REVISION;
54*8617a60dSAndroid Build Coastguard Worker     h->size = sizeof(GptHeader);
55*8617a60dSAndroid Build Coastguard Worker     h->my_lba = GPT_PMBR_SECTORS;  /* The second sector on drive. */
56*8617a60dSAndroid Build Coastguard Worker     h->alternate_lba = drive->gpt.gpt_drive_sectors - GPT_HEADER_SECTORS;
57*8617a60dSAndroid Build Coastguard Worker     if (CGPT_OK != GenerateGuid(&h->disk_uuid)) {
58*8617a60dSAndroid Build Coastguard Worker       Error("Unable to generate new GUID.\n");
59*8617a60dSAndroid Build Coastguard Worker       return -1;
60*8617a60dSAndroid Build Coastguard Worker     }
61*8617a60dSAndroid Build Coastguard Worker 
62*8617a60dSAndroid Build Coastguard Worker     /* Calculate number of entries */
63*8617a60dSAndroid Build Coastguard Worker     h->size_of_entry = sizeof(GptEntry);
64*8617a60dSAndroid Build Coastguard Worker     h->number_of_entries = MAX_NUMBER_OF_ENTRIES;
65*8617a60dSAndroid Build Coastguard Worker     if (drive->gpt.flags & GPT_FLAG_EXTERNAL) {
66*8617a60dSAndroid Build Coastguard Worker       // We might have smaller space for the GPT table. Scale accordingly.
67*8617a60dSAndroid Build Coastguard Worker       //
68*8617a60dSAndroid Build Coastguard Worker       // +------+------------+---------------+-----+--------------+-----------+
69*8617a60dSAndroid Build Coastguard Worker       // | PMBR | Prim. Head | Prim. Entries | ... | Sec. Entries | Sec. Head |
70*8617a60dSAndroid Build Coastguard Worker       // +------+------------+---------------+-----+--------------+-----------+
71*8617a60dSAndroid Build Coastguard Worker       //
72*8617a60dSAndroid Build Coastguard Worker       // Half the size of gpt_drive_sectors must be big enough to hold PMBR +
73*8617a60dSAndroid Build Coastguard Worker       // GPT Header + Entries Table, though the secondary structures do not
74*8617a60dSAndroid Build Coastguard Worker       // contain PMBR.
75*8617a60dSAndroid Build Coastguard Worker       size_t required_headers_size =
76*8617a60dSAndroid Build Coastguard Worker           (GPT_PMBR_SECTORS + GPT_HEADER_SECTORS) * drive->gpt.sector_bytes;
77*8617a60dSAndroid Build Coastguard Worker       size_t min_entries_size = MIN_NUMBER_OF_ENTRIES * h->size_of_entry;
78*8617a60dSAndroid Build Coastguard Worker       size_t required_min_size = required_headers_size + min_entries_size;
79*8617a60dSAndroid Build Coastguard Worker       size_t half_size =
80*8617a60dSAndroid Build Coastguard Worker           (drive->gpt.gpt_drive_sectors / 2) * drive->gpt.sector_bytes;
81*8617a60dSAndroid Build Coastguard Worker       if (half_size < required_min_size) {
82*8617a60dSAndroid Build Coastguard Worker         Error("Not enough space to store GPT structures. Required %zu bytes.\n",
83*8617a60dSAndroid Build Coastguard Worker               required_min_size * 2);
84*8617a60dSAndroid Build Coastguard Worker         return -1;
85*8617a60dSAndroid Build Coastguard Worker       }
86*8617a60dSAndroid Build Coastguard Worker       size_t max_entries =
87*8617a60dSAndroid Build Coastguard Worker           (half_size - required_headers_size) / h->size_of_entry;
88*8617a60dSAndroid Build Coastguard Worker       if (h->number_of_entries > max_entries) {
89*8617a60dSAndroid Build Coastguard Worker         h->number_of_entries = max_entries;
90*8617a60dSAndroid Build Coastguard Worker       }
91*8617a60dSAndroid Build Coastguard Worker     }
92*8617a60dSAndroid Build Coastguard Worker 
93*8617a60dSAndroid Build Coastguard Worker     /* Then use number of entries to calculate entries_lba. */
94*8617a60dSAndroid Build Coastguard Worker     h->entries_lba = h->my_lba + GPT_HEADER_SECTORS;
95*8617a60dSAndroid Build Coastguard Worker     if (!(drive->gpt.flags & GPT_FLAG_EXTERNAL)) {
96*8617a60dSAndroid Build Coastguard Worker       h->entries_lba += params->padding;
97*8617a60dSAndroid Build Coastguard Worker       h->first_usable_lba = h->entries_lba + CalculateEntriesSectors(h,
98*8617a60dSAndroid Build Coastguard Worker                                                drive->gpt.sector_bytes);
99*8617a60dSAndroid Build Coastguard Worker       h->last_usable_lba =
100*8617a60dSAndroid Build Coastguard Worker         (drive->gpt.streaming_drive_sectors - GPT_HEADER_SECTORS -
101*8617a60dSAndroid Build Coastguard Worker           CalculateEntriesSectors(h, drive->gpt.sector_bytes) - 1);
102*8617a60dSAndroid Build Coastguard Worker     } else {
103*8617a60dSAndroid Build Coastguard Worker       h->first_usable_lba = params->padding;
104*8617a60dSAndroid Build Coastguard Worker       h->last_usable_lba = (drive->gpt.streaming_drive_sectors - 1);
105*8617a60dSAndroid Build Coastguard Worker     }
106*8617a60dSAndroid Build Coastguard Worker 
107*8617a60dSAndroid Build Coastguard Worker     size_t entries_size = h->number_of_entries * h->size_of_entry;
108*8617a60dSAndroid Build Coastguard Worker     AllocAndClear(&drive->gpt.primary_entries, entries_size);
109*8617a60dSAndroid Build Coastguard Worker     AllocAndClear(&drive->gpt.secondary_entries, entries_size);
110*8617a60dSAndroid Build Coastguard Worker 
111*8617a60dSAndroid Build Coastguard Worker     // Copy to secondary
112*8617a60dSAndroid Build Coastguard Worker     RepairHeader(&drive->gpt, MASK_PRIMARY);
113*8617a60dSAndroid Build Coastguard Worker 
114*8617a60dSAndroid Build Coastguard Worker     UpdateCrc(&drive->gpt);
115*8617a60dSAndroid Build Coastguard Worker   }
116*8617a60dSAndroid Build Coastguard Worker 
117*8617a60dSAndroid Build Coastguard Worker   return 0;
118*8617a60dSAndroid Build Coastguard Worker }
119*8617a60dSAndroid Build Coastguard Worker 
CgptCreate(CgptCreateParams * params)120*8617a60dSAndroid Build Coastguard Worker int CgptCreate(CgptCreateParams *params) {
121*8617a60dSAndroid Build Coastguard Worker   struct drive drive;
122*8617a60dSAndroid Build Coastguard Worker 
123*8617a60dSAndroid Build Coastguard Worker   if (params == NULL)
124*8617a60dSAndroid Build Coastguard Worker     return CGPT_FAILED;
125*8617a60dSAndroid Build Coastguard Worker 
126*8617a60dSAndroid Build Coastguard Worker   if (CGPT_OK != DriveOpen(params->drive_name, &drive, O_RDWR,
127*8617a60dSAndroid Build Coastguard Worker                            params->drive_size))
128*8617a60dSAndroid Build Coastguard Worker     return CGPT_FAILED;
129*8617a60dSAndroid Build Coastguard Worker 
130*8617a60dSAndroid Build Coastguard Worker   if (GptCreate(&drive, params))
131*8617a60dSAndroid Build Coastguard Worker     goto bad;
132*8617a60dSAndroid Build Coastguard Worker 
133*8617a60dSAndroid Build Coastguard Worker   // Write it all out
134*8617a60dSAndroid Build Coastguard Worker   return DriveClose(&drive, 1);
135*8617a60dSAndroid Build Coastguard Worker 
136*8617a60dSAndroid Build Coastguard Worker bad:
137*8617a60dSAndroid Build Coastguard Worker 
138*8617a60dSAndroid Build Coastguard Worker   DriveClose(&drive, 0);
139*8617a60dSAndroid Build Coastguard Worker   return CGPT_FAILED;
140*8617a60dSAndroid Build Coastguard Worker }
141