Angel Pons | 118a9c7 | 2020-04-02 23:48:34 +0200 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
Peter Stuge | 483b7bb | 2009-04-14 07:40:01 +0000 | [diff] [blame] | 2 | |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 3 | #include <assert.h> |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 4 | #include <boot_device.h> |
| 5 | #include <cbfs.h> |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 6 | #include <cbfs_private.h> |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 7 | #include <cbmem.h> |
Julius Werner | 98eeb96 | 2019-12-11 15:47:42 -0800 | [diff] [blame] | 8 | #include <commonlib/bsd/compression.h> |
Aaron Durbin | 0b418bd | 2020-10-08 14:56:03 -0600 | [diff] [blame] | 9 | #include <commonlib/endian.h> |
Bill XIE | c79e96b | 2019-08-22 20:28:36 +0800 | [diff] [blame] | 10 | #include <console/console.h> |
Bill XIE | c79e96b | 2019-08-22 20:28:36 +0800 | [diff] [blame] | 11 | #include <fmap.h> |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 12 | #include <lib.h> |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 13 | #include <metadata_hash.h> |
Bill XIE | c79e96b | 2019-08-22 20:28:36 +0800 | [diff] [blame] | 14 | #include <security/tpm/tspi/crtm.h> |
| 15 | #include <security/vboot/vboot_common.h> |
| 16 | #include <stdlib.h> |
| 17 | #include <string.h> |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 18 | #include <symbols.h> |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 19 | #include <timestamp.h> |
Patrick Georgi | 58a150a | 2016-05-02 17:22:29 +0800 | [diff] [blame] | 20 | |
Raul E Rangel | 3d7b984 | 2021-10-08 13:10:38 -0600 | [diff] [blame^] | 21 | #if ENV_STAGE_HAS_DATA_SECTION |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame] | 22 | struct mem_pool cbfs_cache = MEM_POOL_INIT(_cbfs_cache, REGION_SIZE(cbfs_cache)); |
Raul E Rangel | 3d7b984 | 2021-10-08 13:10:38 -0600 | [diff] [blame^] | 23 | #else |
| 24 | struct mem_pool cbfs_cache = MEM_POOL_INIT(NULL, 0); |
| 25 | #endif |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame] | 26 | |
| 27 | static void switch_to_postram_cache(int unused) |
| 28 | { |
| 29 | if (_preram_cbfs_cache != _postram_cbfs_cache) |
| 30 | mem_pool_init(&cbfs_cache, _postram_cbfs_cache, |
| 31 | REGION_SIZE(postram_cbfs_cache)); |
| 32 | } |
| 33 | ROMSTAGE_CBMEM_INIT_HOOK(switch_to_postram_cache); |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame] | 34 | |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 35 | cb_err_t cbfs_boot_lookup(const char *name, bool force_ro, |
| 36 | union cbfs_mdata *mdata, struct region_device *rdev) |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 37 | { |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 38 | const struct cbfs_boot_device *cbd = cbfs_get_boot_device(force_ro); |
| 39 | if (!cbd) |
| 40 | return CB_ERR; |
| 41 | |
| 42 | size_t data_offset; |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 43 | cb_err_t err = CB_CBFS_CACHE_FULL; |
Julius Werner | 34cf073 | 2020-12-08 14:21:43 -0800 | [diff] [blame] | 44 | if (!CONFIG(NO_CBFS_MCACHE) && !ENV_SMM && cbd->mcache_size) |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 45 | err = cbfs_mcache_lookup(cbd->mcache, cbd->mcache_size, |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 46 | name, mdata, &data_offset); |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 47 | if (err == CB_CBFS_CACHE_FULL) { |
| 48 | struct vb2_hash *metadata_hash = NULL; |
| 49 | if (CONFIG(TOCTOU_SAFETY)) { |
| 50 | if (ENV_SMM) /* Cannot provide TOCTOU safety for SMM */ |
| 51 | dead_code(); |
Julius Werner | 34cf073 | 2020-12-08 14:21:43 -0800 | [diff] [blame] | 52 | if (!cbd->mcache_size) |
| 53 | die("Cannot access CBFS TOCTOU-safely in " ENV_STRING " before CBMEM init!\n"); |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 54 | /* We can only reach this for the RW CBFS -- an mcache overflow in the |
| 55 | RO CBFS would have been caught when building the mcache in cbfs_get |
| 56 | boot_device(). (Note that TOCTOU_SAFETY implies !NO_CBFS_MCACHE.) */ |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 57 | assert(cbd == vboot_get_cbfs_boot_device()); |
| 58 | /* TODO: set metadata_hash to RW metadata hash here. */ |
| 59 | } |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 60 | err = cbfs_lookup(&cbd->rdev, name, mdata, &data_offset, metadata_hash); |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 61 | } |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 62 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 63 | if (CONFIG(VBOOT_ENABLE_CBFS_FALLBACK) && !force_ro && err == CB_CBFS_NOT_FOUND) { |
| 64 | printk(BIOS_INFO, "CBFS: Fall back to RO region for %s\n", name); |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 65 | return cbfs_boot_lookup(name, true, mdata, rdev); |
| 66 | } |
Julius Werner | 0247fcf | 2020-12-03 12:41:00 -0800 | [diff] [blame] | 67 | if (err) { |
| 68 | if (err == CB_CBFS_NOT_FOUND) |
| 69 | printk(BIOS_WARNING, "CBFS: '%s' not found.\n", name); |
| 70 | else if (err == CB_CBFS_HASH_MISMATCH) |
| 71 | printk(BIOS_ERR, "CBFS ERROR: metadata hash mismatch!\n"); |
| 72 | else |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 73 | printk(BIOS_ERR, "CBFS ERROR: error %d when looking up '%s'\n", |
Julius Werner | 0247fcf | 2020-12-03 12:41:00 -0800 | [diff] [blame] | 74 | err, name); |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 75 | return err; |
Julius Werner | 0247fcf | 2020-12-03 12:41:00 -0800 | [diff] [blame] | 76 | } |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 77 | |
| 78 | if (rdev_chain(rdev, &cbd->rdev, data_offset, be32toh(mdata->h.len))) |
| 79 | return CB_ERR; |
| 80 | |
Arthur Heymans | 27545df | 2021-02-26 14:22:47 +0100 | [diff] [blame] | 81 | if (tspi_measure_cbfs_hook(rdev, name, be32toh(mdata->h.type))) { |
| 82 | printk(BIOS_ERR, "CBFS ERROR: error when measuring '%s'\n", name); |
| 83 | } |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 84 | |
| 85 | return CB_SUCCESS; |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 86 | } |
| 87 | |
Aaron Durbin | 37a5d15 | 2015-09-17 16:09:30 -0500 | [diff] [blame] | 88 | int cbfs_boot_locate(struct cbfsf *fh, const char *name, uint32_t *type) |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 89 | { |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 90 | if (cbfs_boot_lookup(name, false, &fh->mdata, &fh->data)) |
Julius Werner | 1cd013b | 2019-12-11 16:50:02 -0800 | [diff] [blame] | 91 | return -1; |
| 92 | |
| 93 | size_t msize = be32toh(fh->mdata.h.offset); |
Julius Werner | c893197 | 2021-04-16 16:48:32 -0700 | [diff] [blame] | 94 | if (rdev_chain_mem(&fh->metadata, &fh->mdata, msize)) |
Julius Werner | 1cd013b | 2019-12-11 16:50:02 -0800 | [diff] [blame] | 95 | return -1; |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 96 | |
Julius Werner | 1cd013b | 2019-12-11 16:50:02 -0800 | [diff] [blame] | 97 | if (type) { |
| 98 | if (!*type) |
| 99 | *type = be32toh(fh->mdata.h.type); |
| 100 | else if (*type != be32toh(fh->mdata.h.type)) |
| 101 | return -1; |
Wim Vervoorn | 114e2e8 | 2019-11-05 14:09:16 +0100 | [diff] [blame] | 102 | } |
| 103 | |
Julius Werner | 1cd013b | 2019-12-11 16:50:02 -0800 | [diff] [blame] | 104 | return 0; |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 105 | } |
| 106 | |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame] | 107 | void cbfs_unmap(void *mapping) |
Julius Werner | 834b3ec | 2020-03-04 16:52:08 -0800 | [diff] [blame] | 108 | { |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame] | 109 | /* |
| 110 | * This is save to call with mappings that weren't allocated in the cache (e.g. x86 |
| 111 | * direct mappings) -- mem_pool_free() just does nothing for addresses it doesn't |
| 112 | * recognize. This hardcodes the assumption that if platforms implement an rdev_mmap() |
| 113 | * that requires a free() for the boot_device, they need to implement it via the |
| 114 | * cbfs_cache mem_pool. |
| 115 | */ |
Raul E Rangel | 3d7b984 | 2021-10-08 13:10:38 -0600 | [diff] [blame^] | 116 | mem_pool_free(&cbfs_cache, mapping); |
Julius Werner | 834b3ec | 2020-03-04 16:52:08 -0800 | [diff] [blame] | 117 | } |
| 118 | |
Pratik Prajapati | 2a7708a | 2016-11-30 17:29:10 -0800 | [diff] [blame] | 119 | int cbfs_locate_file_in_region(struct cbfsf *fh, const char *region_name, |
Philipp Deppenwiese | 66f9a09 | 2018-11-08 10:59:40 +0100 | [diff] [blame] | 120 | const char *name, uint32_t *type) |
Pratik Prajapati | 2a7708a | 2016-11-30 17:29:10 -0800 | [diff] [blame] | 121 | { |
| 122 | struct region_device rdev; |
Bill XIE | bad08c2 | 2020-02-13 11:11:35 +0800 | [diff] [blame] | 123 | int ret = 0; |
Pratik Prajapati | 2a7708a | 2016-11-30 17:29:10 -0800 | [diff] [blame] | 124 | if (fmap_locate_area_as_rdev(region_name, &rdev)) { |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 125 | LOG("%s region not found while looking for %s\n", region_name, name); |
Pratik Prajapati | 2a7708a | 2016-11-30 17:29:10 -0800 | [diff] [blame] | 126 | return -1; |
| 127 | } |
| 128 | |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 129 | uint32_t dummy_type = 0; |
| 130 | if (!type) |
| 131 | type = &dummy_type; |
| 132 | |
Bill XIE | bad08c2 | 2020-02-13 11:11:35 +0800 | [diff] [blame] | 133 | ret = cbfs_locate(fh, &rdev, name, type); |
| 134 | if (!ret) |
Julius Werner | 0d9072b | 2020-03-05 12:51:08 -0800 | [diff] [blame] | 135 | if (tspi_measure_cbfs_hook(&rdev, name, *type)) |
Arthur Heymans | 27545df | 2021-02-26 14:22:47 +0100 | [diff] [blame] | 136 | LOG("error measuring %s in region %s\n", name, region_name); |
Bill XIE | bad08c2 | 2020-02-13 11:11:35 +0800 | [diff] [blame] | 137 | return ret; |
Pratik Prajapati | 2a7708a | 2016-11-30 17:29:10 -0800 | [diff] [blame] | 138 | } |
| 139 | |
Aaron Durbin | a85febc | 2020-05-15 15:09:10 -0600 | [diff] [blame] | 140 | static inline bool fsps_env(void) |
| 141 | { |
| 142 | /* FSP-S is assumed to be loaded in ramstage. */ |
| 143 | if (ENV_RAMSTAGE) |
| 144 | return true; |
| 145 | return false; |
| 146 | } |
| 147 | |
Aaron Durbin | ecbfa99 | 2020-05-15 17:01:58 -0600 | [diff] [blame] | 148 | static inline bool fspm_env(void) |
| 149 | { |
| 150 | /* FSP-M is assumed to be loaded in romstage. */ |
| 151 | if (ENV_ROMSTAGE) |
| 152 | return true; |
| 153 | return false; |
| 154 | } |
| 155 | |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 156 | static inline bool cbfs_lz4_enabled(void) |
| 157 | { |
Aaron Durbin | a85febc | 2020-05-15 15:09:10 -0600 | [diff] [blame] | 158 | if (fsps_env() && CONFIG(FSP_COMPRESS_FSP_S_LZ4)) |
| 159 | return true; |
Aaron Durbin | ecbfa99 | 2020-05-15 17:01:58 -0600 | [diff] [blame] | 160 | if (fspm_env() && CONFIG(FSP_COMPRESS_FSP_M_LZ4)) |
| 161 | return true; |
Aaron Durbin | a85febc | 2020-05-15 15:09:10 -0600 | [diff] [blame] | 162 | |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 163 | if ((ENV_BOOTBLOCK || ENV_SEPARATE_VERSTAGE) && !CONFIG(COMPRESS_PRERAM_STAGES)) |
| 164 | return false; |
| 165 | |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame] | 166 | if (ENV_SMM) |
| 167 | return false; |
| 168 | |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 169 | return true; |
| 170 | } |
| 171 | |
| 172 | static inline bool cbfs_lzma_enabled(void) |
| 173 | { |
Aaron Durbin | a85febc | 2020-05-15 15:09:10 -0600 | [diff] [blame] | 174 | if (fsps_env() && CONFIG(FSP_COMPRESS_FSP_S_LZMA)) |
| 175 | return true; |
Aaron Durbin | ecbfa99 | 2020-05-15 17:01:58 -0600 | [diff] [blame] | 176 | if (fspm_env() && CONFIG(FSP_COMPRESS_FSP_M_LZMA)) |
| 177 | return true; |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 178 | /* We assume here romstage and postcar are never compressed. */ |
| 179 | if (ENV_BOOTBLOCK || ENV_SEPARATE_VERSTAGE) |
| 180 | return false; |
| 181 | if (ENV_ROMSTAGE && CONFIG(POSTCAR_STAGE)) |
| 182 | return false; |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 183 | if ((ENV_ROMSTAGE || ENV_POSTCAR) && !CONFIG(COMPRESS_RAMSTAGE)) |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 184 | return false; |
Julius Werner | 9b1f3cc | 2020-12-30 17:30:12 -0800 | [diff] [blame] | 185 | if (ENV_SMM) |
| 186 | return false; |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 187 | return true; |
| 188 | } |
| 189 | |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 190 | static inline bool cbfs_file_hash_mismatch(const void *buffer, size_t size, |
| 191 | const struct vb2_hash *file_hash) |
| 192 | { |
| 193 | /* Avoid linking hash functions when verification is disabled. */ |
| 194 | if (!CONFIG(CBFS_VERIFICATION)) |
| 195 | return false; |
| 196 | |
| 197 | /* If there is no file hash, always count that as a mismatch. */ |
| 198 | if (file_hash && vb2_hash_verify(buffer, size, file_hash) == VB2_SUCCESS) |
| 199 | return false; |
| 200 | |
| 201 | printk(BIOS_CRIT, "CBFS file hash mismatch!\n"); |
| 202 | return true; |
| 203 | } |
| 204 | |
| 205 | static size_t cbfs_load_and_decompress(const struct region_device *rdev, void *buffer, |
| 206 | size_t buffer_size, uint32_t compression, |
| 207 | const struct vb2_hash *file_hash) |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 208 | { |
Julius Werner | eca99af | 2021-03-10 18:49:37 -0800 | [diff] [blame] | 209 | size_t in_size = region_device_sz(rdev); |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 210 | size_t out_size = 0; |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 211 | void *map; |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 212 | |
Julius Werner | eca99af | 2021-03-10 18:49:37 -0800 | [diff] [blame] | 213 | DEBUG("Decompressing %zu bytes to %p with algo %d\n", in_size, buffer, compression); |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 214 | |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 215 | switch (compression) { |
| 216 | case CBFS_COMPRESS_NONE: |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 217 | if (buffer_size < in_size) |
| 218 | return 0; |
Julius Werner | eca99af | 2021-03-10 18:49:37 -0800 | [diff] [blame] | 219 | if (rdev_readat(rdev, buffer, 0, in_size) != in_size) |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 220 | return 0; |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 221 | if (cbfs_file_hash_mismatch(buffer, in_size, file_hash)) |
| 222 | return 0; |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 223 | return in_size; |
| 224 | |
| 225 | case CBFS_COMPRESS_LZ4: |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 226 | if (!cbfs_lz4_enabled()) |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 227 | return 0; |
| 228 | |
Julius Werner | eca99af | 2021-03-10 18:49:37 -0800 | [diff] [blame] | 229 | /* cbfs_prog_stage_load() takes care of in-place LZ4 decompression by |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 230 | setting up the rdev to be in memory. */ |
Julius Werner | eca99af | 2021-03-10 18:49:37 -0800 | [diff] [blame] | 231 | map = rdev_mmap_full(rdev); |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 232 | if (map == NULL) |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 233 | return 0; |
| 234 | |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 235 | if (!cbfs_file_hash_mismatch(map, in_size, file_hash)) { |
| 236 | timestamp_add_now(TS_START_ULZ4F); |
| 237 | out_size = ulz4fn(map, in_size, buffer, buffer_size); |
| 238 | timestamp_add_now(TS_END_ULZ4F); |
| 239 | } |
Aaron Durbin | 84f394e | 2020-05-26 16:16:42 -0600 | [diff] [blame] | 240 | |
| 241 | rdev_munmap(rdev, map); |
| 242 | |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 243 | return out_size; |
| 244 | |
| 245 | case CBFS_COMPRESS_LZMA: |
Aaron Durbin | a121f95 | 2020-05-26 15:48:10 -0600 | [diff] [blame] | 246 | if (!cbfs_lzma_enabled()) |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 247 | return 0; |
Julius Werner | eca99af | 2021-03-10 18:49:37 -0800 | [diff] [blame] | 248 | map = rdev_mmap_full(rdev); |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 249 | if (map == NULL) |
| 250 | return 0; |
| 251 | |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 252 | if (!cbfs_file_hash_mismatch(map, in_size, file_hash)) { |
| 253 | /* Note: timestamp not useful for memory-mapped media (x86) */ |
| 254 | timestamp_add_now(TS_START_ULZMA); |
| 255 | out_size = ulzman(map, in_size, buffer, buffer_size); |
| 256 | timestamp_add_now(TS_END_ULZMA); |
| 257 | } |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 258 | |
| 259 | rdev_munmap(rdev, map); |
| 260 | |
| 261 | return out_size; |
| 262 | |
| 263 | default: |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 264 | return 0; |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 265 | } |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 266 | } |
| 267 | |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 268 | void *_cbfs_alloc(const char *name, cbfs_allocator_t allocator, void *arg, |
| 269 | size_t *size_out, bool force_ro, enum cbfs_type *type) |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 270 | { |
Julius Werner | d17ce41 | 2020-10-01 18:25:49 -0700 | [diff] [blame] | 271 | struct region_device rdev; |
| 272 | union cbfs_mdata mdata; |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 273 | void *loc; |
| 274 | |
| 275 | DEBUG("%s(name='%s', alloc=%p(%p), force_ro=%s, type=%d)\n", __func__, name, allocator, |
| 276 | arg, force_ro ? "true" : "false", type ? *type : -1); |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 277 | |
Julius Werner | 9d0cc2a | 2020-01-22 18:00:18 -0800 | [diff] [blame] | 278 | if (cbfs_boot_lookup(name, force_ro, &mdata, &rdev)) |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 279 | return NULL; |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 280 | |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 281 | if (type) { |
| 282 | const enum cbfs_type real_type = be32toh(mdata.h.type); |
| 283 | if (*type == CBFS_TYPE_QUERY) |
| 284 | *type = real_type; |
| 285 | else if (*type != real_type) { |
| 286 | ERROR("'%s' type mismatch (is %u, expected %u)\n", |
| 287 | mdata.h.filename, real_type, *type); |
| 288 | return NULL; |
| 289 | } |
Julius Werner | d17ce41 | 2020-10-01 18:25:49 -0700 | [diff] [blame] | 290 | } |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 291 | |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 292 | size_t size = region_device_sz(&rdev); |
| 293 | uint32_t compression = CBFS_COMPRESS_NONE; |
| 294 | const struct cbfs_file_attr_compression *cattr = cbfs_find_attr(&mdata, |
| 295 | CBFS_FILE_ATTR_TAG_COMPRESSION, sizeof(*cattr)); |
| 296 | if (cattr) { |
| 297 | compression = be32toh(cattr->compression); |
| 298 | size = be32toh(cattr->decompressed_size); |
| 299 | } |
| 300 | |
| 301 | if (size_out) |
| 302 | *size_out = size; |
| 303 | |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 304 | const struct vb2_hash *file_hash = NULL; |
| 305 | if (CONFIG(CBFS_VERIFICATION)) |
| 306 | file_hash = cbfs_file_hash(&mdata); |
| 307 | |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 308 | /* allocator == NULL means do a cbfs_map() */ |
| 309 | if (allocator) { |
| 310 | loc = allocator(arg, size, &mdata); |
| 311 | } else if (compression == CBFS_COMPRESS_NONE) { |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 312 | void *mapping = rdev_mmap_full(&rdev); |
Raul E Rangel | 3f41d32 | 2021-07-23 15:23:12 -0600 | [diff] [blame] | 313 | |
| 314 | if (!mapping) |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 315 | return NULL; |
Raul E Rangel | 3f41d32 | 2021-07-23 15:23:12 -0600 | [diff] [blame] | 316 | |
| 317 | if (cbfs_file_hash_mismatch(mapping, size, file_hash)) { |
| 318 | rdev_munmap(&rdev, mapping); |
| 319 | return NULL; |
| 320 | } |
| 321 | |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 322 | return mapping; |
Raul E Rangel | 3d7b984 | 2021-10-08 13:10:38 -0600 | [diff] [blame^] | 323 | } else if (!cbfs_cache.size) { |
| 324 | /* |
| 325 | * In order to use the cbfs_cache you need to add a CBFS_CACHE to your |
| 326 | * memlayout. For stages that don't have .data sections (x86 pre-RAM), |
| 327 | * it is not possible to add a CBFS_CACHE. |
| 328 | */ |
| 329 | ERROR("Cannot map compressed file %s without cbfs_cache\n", mdata.h.filename); |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 330 | return NULL; |
| 331 | } else { |
| 332 | loc = mem_pool_alloc(&cbfs_cache, size); |
| 333 | } |
| 334 | |
| 335 | if (!loc) { |
| 336 | ERROR("'%s' allocation failure\n", mdata.h.filename); |
| 337 | return NULL; |
| 338 | } |
| 339 | |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 340 | size = cbfs_load_and_decompress(&rdev, loc, size, compression, file_hash); |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 341 | if (!size) |
| 342 | return NULL; |
| 343 | |
| 344 | return loc; |
| 345 | } |
| 346 | |
Julius Werner | 4676ec5 | 2021-03-10 16:52:14 -0800 | [diff] [blame] | 347 | void *_cbfs_default_allocator(void *arg, size_t size, const union cbfs_mdata *unused) |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 348 | { |
| 349 | struct _cbfs_default_allocator_arg *darg = arg; |
| 350 | if (size > darg->buf_size) |
| 351 | return NULL; |
| 352 | return darg->buf; |
| 353 | } |
| 354 | |
Julius Werner | 4676ec5 | 2021-03-10 16:52:14 -0800 | [diff] [blame] | 355 | void *_cbfs_cbmem_allocator(void *arg, size_t size, const union cbfs_mdata *unused) |
Julius Werner | 7778cf2 | 2021-01-05 18:54:19 -0800 | [diff] [blame] | 356 | { |
| 357 | return cbmem_add((uintptr_t)arg, size); |
Julius Werner | f975e55 | 2016-08-19 15:43:06 -0700 | [diff] [blame] | 358 | } |
| 359 | |
Julius Werner | 1de8708 | 2020-12-23 17:38:11 -0800 | [diff] [blame] | 360 | cb_err_t cbfs_prog_stage_load(struct prog *pstage) |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 361 | { |
Julius Werner | 1de8708 | 2020-12-23 17:38:11 -0800 | [diff] [blame] | 362 | union cbfs_mdata mdata; |
| 363 | struct region_device rdev; |
Julius Werner | 1de8708 | 2020-12-23 17:38:11 -0800 | [diff] [blame] | 364 | cb_err_t err; |
Hung-Te Lin | 6fe0cab | 2013-01-22 18:57:56 +0800 | [diff] [blame] | 365 | |
Julius Werner | 1de8708 | 2020-12-23 17:38:11 -0800 | [diff] [blame] | 366 | prog_locate_hook(pstage); |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 367 | |
Julius Werner | 1de8708 | 2020-12-23 17:38:11 -0800 | [diff] [blame] | 368 | if ((err = cbfs_boot_lookup(prog_name(pstage), false, &mdata, &rdev))) |
| 369 | return err; |
| 370 | |
| 371 | assert(be32toh(mdata.h.type) == CBFS_TYPE_STAGE); |
| 372 | pstage->cbfs_type = CBFS_TYPE_STAGE; |
| 373 | |
Julius Werner | 81dc20e | 2020-10-15 17:37:57 -0700 | [diff] [blame] | 374 | enum cbfs_compression compression = CBFS_COMPRESS_NONE; |
| 375 | const struct cbfs_file_attr_compression *cattr = cbfs_find_attr(&mdata, |
| 376 | CBFS_FILE_ATTR_TAG_COMPRESSION, sizeof(*cattr)); |
| 377 | if (cattr) |
| 378 | compression = be32toh(cattr->compression); |
Julius Werner | 1de8708 | 2020-12-23 17:38:11 -0800 | [diff] [blame] | 379 | |
Julius Werner | 81dc20e | 2020-10-15 17:37:57 -0700 | [diff] [blame] | 380 | const struct cbfs_file_attr_stageheader *sattr = cbfs_find_attr(&mdata, |
| 381 | CBFS_FILE_ATTR_TAG_STAGEHEADER, sizeof(*sattr)); |
| 382 | if (!sattr) |
| 383 | return CB_ERR; |
| 384 | prog_set_area(pstage, (void *)(uintptr_t)be64toh(sattr->loadaddr), |
| 385 | be32toh(sattr->memlen)); |
| 386 | prog_set_entry(pstage, prog_start(pstage) + |
| 387 | be32toh(sattr->entry_offset), NULL); |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 388 | |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 389 | const struct vb2_hash *file_hash = NULL; |
| 390 | if (CONFIG(CBFS_VERIFICATION)) |
| 391 | file_hash = cbfs_file_hash(&mdata); |
| 392 | |
Aaron Durbin | ed253c8 | 2015-10-07 17:22:42 -0500 | [diff] [blame] | 393 | /* Hacky way to not load programs over read only media. The stages |
| 394 | * that would hit this path initialize themselves. */ |
Julius Werner | 21a4053 | 2020-04-21 16:03:53 -0700 | [diff] [blame] | 395 | if ((ENV_BOOTBLOCK || ENV_SEPARATE_VERSTAGE) && |
| 396 | !CONFIG(NO_XIP_EARLY_STAGES) && CONFIG(BOOT_DEVICE_MEMORY_MAPPED)) { |
Julius Werner | 81dc20e | 2020-10-15 17:37:57 -0700 | [diff] [blame] | 397 | void *mapping = rdev_mmap_full(&rdev); |
Julius Werner | 1de8708 | 2020-12-23 17:38:11 -0800 | [diff] [blame] | 398 | rdev_munmap(&rdev, mapping); |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 399 | if (cbfs_file_hash_mismatch(mapping, region_device_sz(&rdev), file_hash)) |
| 400 | return CB_CBFS_HASH_MISMATCH; |
Julius Werner | 81dc20e | 2020-10-15 17:37:57 -0700 | [diff] [blame] | 401 | if (mapping == prog_start(pstage)) |
| 402 | return CB_SUCCESS; |
Aaron Durbin | ed253c8 | 2015-10-07 17:22:42 -0500 | [diff] [blame] | 403 | } |
| 404 | |
Julius Werner | eca99af | 2021-03-10 18:49:37 -0800 | [diff] [blame] | 405 | /* LZ4 stages can be decompressed in-place to save mapping scratch space. Load the |
| 406 | compressed data to the end of the buffer and point &rdev to that memory location. */ |
| 407 | if (cbfs_lz4_enabled() && compression == CBFS_COMPRESS_LZ4) { |
| 408 | size_t in_size = region_device_sz(&rdev); |
| 409 | void *compr_start = prog_start(pstage) + prog_size(pstage) - in_size; |
| 410 | if (rdev_readat(&rdev, compr_start, 0, in_size) != in_size) |
| 411 | return CB_ERR; |
Julius Werner | c893197 | 2021-04-16 16:48:32 -0700 | [diff] [blame] | 412 | rdev_chain_mem(&rdev, compr_start, in_size); |
Julius Werner | eca99af | 2021-03-10 18:49:37 -0800 | [diff] [blame] | 413 | } |
| 414 | |
| 415 | size_t fsize = cbfs_load_and_decompress(&rdev, prog_start(pstage), prog_size(pstage), |
Julius Werner | fccf122 | 2021-04-02 15:58:05 -0700 | [diff] [blame] | 416 | compression, file_hash); |
Julius Werner | 09f2921 | 2015-09-29 13:51:35 -0700 | [diff] [blame] | 417 | if (!fsize) |
Julius Werner | 1de8708 | 2020-12-23 17:38:11 -0800 | [diff] [blame] | 418 | return CB_ERR; |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 419 | |
| 420 | /* Clear area not covered by file. */ |
Julius Werner | 81dc20e | 2020-10-15 17:37:57 -0700 | [diff] [blame] | 421 | memset(prog_start(pstage) + fsize, 0, prog_size(pstage) - fsize); |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 422 | |
Julius Werner | 81dc20e | 2020-10-15 17:37:57 -0700 | [diff] [blame] | 423 | prog_segment_loaded((uintptr_t)prog_start(pstage), prog_size(pstage), |
| 424 | SEG_FINAL); |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 425 | |
Julius Werner | 1de8708 | 2020-12-23 17:38:11 -0800 | [diff] [blame] | 426 | return CB_SUCCESS; |
Hung-Te Lin | 6fe0cab | 2013-01-22 18:57:56 +0800 | [diff] [blame] | 427 | } |
Aaron Durbin | 6d720f3 | 2015-12-08 17:00:23 -0600 | [diff] [blame] | 428 | |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 429 | void cbfs_boot_device_find_mcache(struct cbfs_boot_device *cbd, uint32_t id) |
Aaron Durbin | 6d720f3 | 2015-12-08 17:00:23 -0600 | [diff] [blame] | 430 | { |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 431 | if (CONFIG(NO_CBFS_MCACHE) || ENV_SMM) |
| 432 | return; |
| 433 | |
Julius Werner | 34cf073 | 2020-12-08 14:21:43 -0800 | [diff] [blame] | 434 | if (cbd->mcache_size) |
| 435 | return; |
| 436 | |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 437 | const struct cbmem_entry *entry; |
| 438 | if (cbmem_possibly_online() && |
| 439 | (entry = cbmem_entry_find(id))) { |
| 440 | cbd->mcache = cbmem_entry_start(entry); |
| 441 | cbd->mcache_size = cbmem_entry_size(entry); |
| 442 | } else if (ENV_ROMSTAGE_OR_BEFORE) { |
| 443 | u8 *boundary = _ecbfs_mcache - REGION_SIZE(cbfs_mcache) * |
| 444 | CONFIG_CBFS_MCACHE_RW_PERCENTAGE / 100; |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 445 | boundary = (u8 *)ALIGN_DOWN((uintptr_t)boundary, CBFS_MCACHE_ALIGNMENT); |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 446 | if (id == CBMEM_ID_CBFS_RO_MCACHE) { |
| 447 | cbd->mcache = _cbfs_mcache; |
| 448 | cbd->mcache_size = boundary - _cbfs_mcache; |
| 449 | } else if (id == CBMEM_ID_CBFS_RW_MCACHE) { |
| 450 | cbd->mcache = boundary; |
| 451 | cbd->mcache_size = _ecbfs_mcache - boundary; |
| 452 | } |
| 453 | } |
Aaron Durbin | 6d720f3 | 2015-12-08 17:00:23 -0600 | [diff] [blame] | 454 | } |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 455 | |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 456 | cb_err_t cbfs_init_boot_device(const struct cbfs_boot_device *cbd, |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 457 | struct vb2_hash *mdata_hash) |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 458 | { |
| 459 | /* If we have an mcache, mcache_build() will also check mdata hash. */ |
| 460 | if (!CONFIG(NO_CBFS_MCACHE) && !ENV_SMM && cbd->mcache_size > 0) |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 461 | return cbfs_mcache_build(&cbd->rdev, cbd->mcache, cbd->mcache_size, mdata_hash); |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 462 | |
| 463 | /* No mcache and no verification means we have nothing special to do. */ |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 464 | if (!CONFIG(CBFS_VERIFICATION) || !mdata_hash) |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 465 | return CB_SUCCESS; |
| 466 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 467 | /* Verification only: use cbfs_walk() without a walker() function to just run through |
| 468 | the CBFS once, will return NOT_FOUND by default. */ |
| 469 | cb_err_t err = cbfs_walk(&cbd->rdev, NULL, NULL, mdata_hash, 0); |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 470 | if (err == CB_CBFS_NOT_FOUND) |
| 471 | err = CB_SUCCESS; |
| 472 | return err; |
| 473 | } |
| 474 | |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 475 | const struct cbfs_boot_device *cbfs_get_boot_device(bool force_ro) |
| 476 | { |
| 477 | static struct cbfs_boot_device ro; |
| 478 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 479 | /* Ensure we always init RO mcache, even if the first file is from the RW CBFS. |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 480 | Otherwise it may not be available when needed in later stages. */ |
| 481 | if (ENV_INITIAL_STAGE && !force_ro && !region_device_sz(&ro.rdev)) |
| 482 | cbfs_get_boot_device(true); |
| 483 | |
| 484 | if (!force_ro) { |
| 485 | const struct cbfs_boot_device *rw = vboot_get_cbfs_boot_device(); |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 486 | /* This will return NULL if vboot isn't enabled, didn't run yet or decided to |
| 487 | boot into recovery mode. */ |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 488 | if (rw) |
| 489 | return rw; |
| 490 | } |
| 491 | |
Julius Werner | 723e3b1 | 2020-12-29 17:33:30 -0800 | [diff] [blame] | 492 | /* In rare cases post-RAM stages may run this before cbmem_initialize(), so we can't |
| 493 | lock in the result of find_mcache() on the first try and should keep trying every |
| 494 | time until an mcache is found. */ |
Julius Werner | 34cf073 | 2020-12-08 14:21:43 -0800 | [diff] [blame] | 495 | cbfs_boot_device_find_mcache(&ro, CBMEM_ID_CBFS_RO_MCACHE); |
| 496 | |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 497 | if (region_device_sz(&ro.rdev)) |
| 498 | return &ro; |
| 499 | |
| 500 | if (fmap_locate_area_as_rdev("COREBOOT", &ro.rdev)) |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 501 | die("Cannot locate primary CBFS"); |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 502 | |
Julius Werner | fdabf3f | 2020-05-06 17:06:35 -0700 | [diff] [blame] | 503 | if (ENV_INITIAL_STAGE) { |
| 504 | cb_err_t err = cbfs_init_boot_device(&ro, metadata_hash_get()); |
| 505 | if (err == CB_CBFS_HASH_MISMATCH) |
| 506 | die("RO CBFS metadata hash verification failure"); |
| 507 | else if (CONFIG(TOCTOU_SAFETY) && err == CB_CBFS_CACHE_FULL) |
| 508 | die("RO mcache overflow breaks TOCTOU safety!\n"); |
| 509 | else if (err && err != CB_CBFS_CACHE_FULL) |
| 510 | die("RO CBFS initialization error: %d", err); |
Julius Werner | 1e37c9c | 2019-12-11 17:09:39 -0800 | [diff] [blame] | 511 | } |
| 512 | |
| 513 | return &ro; |
| 514 | } |
| 515 | |
| 516 | #if !CONFIG(NO_CBFS_MCACHE) |
| 517 | static void mcache_to_cbmem(const struct cbfs_boot_device *cbd, u32 cbmem_id) |
| 518 | { |
| 519 | if (!cbd) |
| 520 | return; |
| 521 | |
| 522 | size_t real_size = cbfs_mcache_real_size(cbd->mcache, cbd->mcache_size); |
| 523 | void *cbmem_mcache = cbmem_add(cbmem_id, real_size); |
| 524 | if (!cbmem_mcache) { |
| 525 | printk(BIOS_ERR, "ERROR: Cannot allocate CBMEM mcache %#x (%#zx bytes)!\n", |
| 526 | cbmem_id, real_size); |
| 527 | return; |
| 528 | } |
| 529 | memcpy(cbmem_mcache, cbd->mcache, real_size); |
| 530 | } |
| 531 | |
| 532 | static void cbfs_mcache_migrate(int unused) |
| 533 | { |
| 534 | mcache_to_cbmem(vboot_get_cbfs_boot_device(), CBMEM_ID_CBFS_RW_MCACHE); |
| 535 | mcache_to_cbmem(cbfs_get_boot_device(true), CBMEM_ID_CBFS_RO_MCACHE); |
| 536 | } |
| 537 | ROMSTAGE_CBMEM_INIT_HOOK(cbfs_mcache_migrate) |
| 538 | #endif |