loader.h (15099B)
1 #ifndef LOADER_H 2 #define LOADER_H 3 #include "hw/nvram/fw_cfg.h" 4 5 /* loader.c */ 6 /** 7 * get_image_size: retrieve size of an image file 8 * @filename: Path to the image file 9 * 10 * Returns the size of the image file on success, -1 otherwise. 11 * On error, errno is also set as appropriate. 12 */ 13 int64_t get_image_size(const char *filename); 14 /** 15 * load_image_size: load an image file into specified buffer 16 * @filename: Path to the image file 17 * @addr: Buffer to load image into 18 * @size: Size of buffer in bytes 19 * 20 * Load an image file from disk into the specified buffer. 21 * If the image is larger than the specified buffer, only 22 * @size bytes are read (this is not considered an error). 23 * 24 * Prefer to use the GLib function g_file_get_contents() rather 25 * than a "get_image_size()/g_malloc()/load_image_size()" sequence. 26 * 27 * Returns the number of bytes read, or -1 on error. On error, 28 * errno is also set as appropriate. 29 */ 30 ssize_t load_image_size(const char *filename, void *addr, size_t size); 31 32 /**load_image_targphys_as: 33 * @filename: Path to the image file 34 * @addr: Address to load the image to 35 * @max_sz: The maximum size of the image to load 36 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 37 * is used if nothing is supplied here. 38 * 39 * Load a fixed image into memory. 40 * 41 * Returns the size of the loaded image on success, -1 otherwise. 42 */ 43 ssize_t load_image_targphys_as(const char *filename, 44 hwaddr addr, uint64_t max_sz, AddressSpace *as); 45 46 /**load_targphys_hex_as: 47 * @filename: Path to the .hex file 48 * @entry: Store the entry point given by the .hex file 49 * @as: The AddressSpace to load the .hex file to. The value of 50 * address_space_memory is used if nothing is supplied here. 51 * 52 * Load a fixed .hex file into memory. 53 * 54 * Returns the size of the loaded .hex file on success, -1 otherwise. 55 */ 56 ssize_t load_targphys_hex_as(const char *filename, hwaddr *entry, 57 AddressSpace *as); 58 59 /** load_image_targphys: 60 * Same as load_image_targphys_as(), but doesn't allow the caller to specify 61 * an AddressSpace. 62 */ 63 ssize_t load_image_targphys(const char *filename, hwaddr, 64 uint64_t max_sz); 65 66 /** 67 * load_image_mr: load an image into a memory region 68 * @filename: Path to the image file 69 * @mr: Memory Region to load into 70 * 71 * Load the specified file into the memory region. 72 * The file loaded is registered as a ROM, so its contents will be 73 * reinstated whenever the system is reset. 74 * If the file is larger than the memory region's size the call will fail. 75 * Returns -1 on failure, or the size of the file. 76 */ 77 ssize_t load_image_mr(const char *filename, MemoryRegion *mr); 78 79 /* This is the limit on the maximum uncompressed image size that 80 * load_image_gzipped_buffer() and load_image_gzipped() will read. It prevents 81 * g_malloc() in those functions from allocating a huge amount of memory. 82 */ 83 #define LOAD_IMAGE_MAX_GUNZIP_BYTES (256 << 20) 84 85 ssize_t load_image_gzipped_buffer(const char *filename, uint64_t max_sz, 86 uint8_t **buffer); 87 ssize_t load_image_gzipped(const char *filename, hwaddr addr, uint64_t max_sz); 88 89 #define ELF_LOAD_FAILED -1 90 #define ELF_LOAD_NOT_ELF -2 91 #define ELF_LOAD_WRONG_ARCH -3 92 #define ELF_LOAD_WRONG_ENDIAN -4 93 #define ELF_LOAD_TOO_BIG -5 94 const char *load_elf_strerror(ssize_t error); 95 96 /** load_elf_ram_sym: 97 * @filename: Path of ELF file 98 * @elf_note_fn: optional function to parse ELF Note type 99 * passed via @translate_opaque 100 * @translate_fn: optional function to translate load addresses 101 * @translate_opaque: opaque data passed to @translate_fn 102 * @pentry: Populated with program entry point. Ignored if NULL. 103 * @lowaddr: Populated with lowest loaded address. Ignored if NULL. 104 * @highaddr: Populated with highest loaded address. Ignored if NULL. 105 * @pflags: Populated with ELF processor-specific flags. Ignore if NULL. 106 * @bigendian: Expected ELF endianness. 0 for LE otherwise BE 107 * @elf_machine: Expected ELF machine type 108 * @clear_lsb: Set to mask off LSB of addresses (Some architectures use 109 * this for non-address data) 110 * @data_swab: Set to order of byte swapping for data. 0 for no swap, 1 111 * for swapping bytes within halfwords, 2 for bytes within 112 * words and 3 for within doublewords. 113 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 114 * is used if nothing is supplied here. 115 * @load_rom : Load ELF binary as ROM 116 * @sym_cb: Callback function for symbol table entries 117 * 118 * Load an ELF file's contents to the emulated system's address space. 119 * Clients may optionally specify a callback to perform address 120 * translations. @pentry, @lowaddr and @highaddr are optional pointers 121 * which will be populated with various load information. @bigendian and 122 * @elf_machine give the expected endianness and machine for the ELF the 123 * load will fail if the target ELF does not match. Some architectures 124 * have some architecture-specific behaviours that come into effect when 125 * their particular values for @elf_machine are set. 126 * If @elf_machine is EM_NONE then the machine type will be read from the 127 * ELF header and no checks will be carried out against the machine type. 128 */ 129 typedef void (*symbol_fn_t)(const char *st_name, int st_info, 130 uint64_t st_value, uint64_t st_size); 131 132 ssize_t load_elf_ram_sym(const char *filename, 133 uint64_t (*elf_note_fn)(void *, void *, bool), 134 uint64_t (*translate_fn)(void *, uint64_t), 135 void *translate_opaque, uint64_t *pentry, 136 uint64_t *lowaddr, uint64_t *highaddr, 137 uint32_t *pflags, int big_endian, int elf_machine, 138 int clear_lsb, int data_swab, 139 AddressSpace *as, bool load_rom, symbol_fn_t sym_cb); 140 141 /** load_elf_ram: 142 * Same as load_elf_ram_sym(), but doesn't allow the caller to specify a 143 * symbol callback function 144 */ 145 ssize_t load_elf_ram(const char *filename, 146 uint64_t (*elf_note_fn)(void *, void *, bool), 147 uint64_t (*translate_fn)(void *, uint64_t), 148 void *translate_opaque, uint64_t *pentry, 149 uint64_t *lowaddr, uint64_t *highaddr, uint32_t *pflags, 150 int big_endian, int elf_machine, int clear_lsb, 151 int data_swab, AddressSpace *as, bool load_rom); 152 153 /** load_elf_as: 154 * Same as load_elf_ram(), but always loads the elf as ROM 155 */ 156 ssize_t load_elf_as(const char *filename, 157 uint64_t (*elf_note_fn)(void *, void *, bool), 158 uint64_t (*translate_fn)(void *, uint64_t), 159 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr, 160 uint64_t *highaddr, uint32_t *pflags, int big_endian, 161 int elf_machine, int clear_lsb, int data_swab, 162 AddressSpace *as); 163 164 /** load_elf: 165 * Same as load_elf_as(), but doesn't allow the caller to specify an 166 * AddressSpace. 167 */ 168 ssize_t load_elf(const char *filename, 169 uint64_t (*elf_note_fn)(void *, void *, bool), 170 uint64_t (*translate_fn)(void *, uint64_t), 171 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr, 172 uint64_t *highaddr, uint32_t *pflags, int big_endian, 173 int elf_machine, int clear_lsb, int data_swab); 174 175 /** load_elf_hdr: 176 * @filename: Path of ELF file 177 * @hdr: Buffer to populate with header data. Header data will not be 178 * filled if set to NULL. 179 * @is64: Set to true if the ELF is 64bit. Ignored if set to NULL 180 * @errp: Populated with an error in failure cases 181 * 182 * Inspect an ELF file's header. Read its full header contents into a 183 * buffer and/or determine if the ELF is 64bit. 184 */ 185 void load_elf_hdr(const char *filename, void *hdr, bool *is64, Error **errp); 186 187 ssize_t load_aout(const char *filename, hwaddr addr, int max_sz, 188 int bswap_needed, hwaddr target_page_size); 189 190 #define LOAD_UIMAGE_LOADADDR_INVALID (-1) 191 192 /** load_uimage_as: 193 * @filename: Path of uimage file 194 * @ep: Populated with program entry point. Ignored if NULL. 195 * @loadaddr: load address if none specified in the image or when loading a 196 * ramdisk. Populated with the load address. Ignored if NULL or 197 * LOAD_UIMAGE_LOADADDR_INVALID (images which do not specify a load 198 * address will not be loadable). 199 * @is_linux: Is set to true if the image loaded is Linux. Ignored if NULL. 200 * @translate_fn: optional function to translate load addresses 201 * @translate_opaque: opaque data passed to @translate_fn 202 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 203 * is used if nothing is supplied here. 204 * 205 * Loads a u-boot image into memory. 206 * 207 * Returns the size of the loaded image on success, -1 otherwise. 208 */ 209 ssize_t load_uimage_as(const char *filename, hwaddr *ep, 210 hwaddr *loadaddr, int *is_linux, 211 uint64_t (*translate_fn)(void *, uint64_t), 212 void *translate_opaque, AddressSpace *as); 213 214 /** load_uimage: 215 * Same as load_uimage_as(), but doesn't allow the caller to specify an 216 * AddressSpace. 217 */ 218 ssize_t load_uimage(const char *filename, hwaddr *ep, 219 hwaddr *loadaddr, int *is_linux, 220 uint64_t (*translate_fn)(void *, uint64_t), 221 void *translate_opaque); 222 223 /** 224 * load_ramdisk_as: 225 * @filename: Path to the ramdisk image 226 * @addr: Memory address to load the ramdisk to 227 * @max_sz: Maximum allowed ramdisk size (for non-u-boot ramdisks) 228 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 229 * is used if nothing is supplied here. 230 * 231 * Load a ramdisk image with U-Boot header to the specified memory 232 * address. 233 * 234 * Returns the size of the loaded image on success, -1 otherwise. 235 */ 236 ssize_t load_ramdisk_as(const char *filename, hwaddr addr, uint64_t max_sz, 237 AddressSpace *as); 238 239 /** 240 * load_ramdisk: 241 * Same as load_ramdisk_as(), but doesn't allow the caller to specify 242 * an AddressSpace. 243 */ 244 ssize_t load_ramdisk(const char *filename, hwaddr addr, uint64_t max_sz); 245 246 ssize_t gunzip(void *dst, size_t dstlen, uint8_t *src, size_t srclen); 247 248 ssize_t read_targphys(const char *name, 249 int fd, hwaddr dst_addr, size_t nbytes); 250 void pstrcpy_targphys(const char *name, 251 hwaddr dest, int buf_size, 252 const char *source); 253 254 extern bool option_rom_has_mr; 255 extern bool rom_file_has_mr; 256 257 ssize_t rom_add_file(const char *file, const char *fw_dir, 258 hwaddr addr, int32_t bootindex, 259 bool option_rom, MemoryRegion *mr, AddressSpace *as); 260 MemoryRegion *rom_add_blob(const char *name, const void *blob, size_t len, 261 size_t max_len, hwaddr addr, 262 const char *fw_file_name, 263 FWCfgCallback fw_callback, 264 void *callback_opaque, AddressSpace *as, 265 bool read_only); 266 int rom_add_elf_program(const char *name, GMappedFile *mapped_file, void *data, 267 size_t datasize, size_t romsize, hwaddr addr, 268 AddressSpace *as); 269 int rom_check_and_register_reset(void); 270 void rom_set_fw(FWCfgState *f); 271 void rom_set_order_override(int order); 272 void rom_reset_order_override(void); 273 274 /** 275 * rom_transaction_begin: 276 * 277 * Call this before of a series of rom_add_*() calls. Call 278 * rom_transaction_end() afterwards to commit or abort. These functions are 279 * useful for undoing a series of rom_add_*() calls if image file loading fails 280 * partway through. 281 */ 282 void rom_transaction_begin(void); 283 284 /** 285 * rom_transaction_end: 286 * @commit: true to commit added roms, false to drop added roms 287 * 288 * Call this after a series of rom_add_*() calls. See rom_transaction_begin(). 289 */ 290 void rom_transaction_end(bool commit); 291 292 int rom_copy(uint8_t *dest, hwaddr addr, size_t size); 293 void *rom_ptr(hwaddr addr, size_t size); 294 /** 295 * rom_ptr_for_as: Return a pointer to ROM blob data for the address 296 * @as: AddressSpace to look for the ROM blob in 297 * @addr: Address within @as 298 * @size: size of data required in bytes 299 * 300 * Returns: pointer into the data which backs the matching ROM blob, 301 * or NULL if no blob covers the address range. 302 * 303 * This function looks for a ROM blob which covers the specified range 304 * of bytes of length @size starting at @addr within the address space 305 * @as. This is useful for code which runs as part of board 306 * initialization or CPU reset which wants to read data that is part 307 * of a user-supplied guest image or other guest memory contents, but 308 * which runs before the ROM loader's reset function has copied the 309 * blobs into guest memory. 310 * 311 * rom_ptr_for_as() will look not just for blobs loaded directly to 312 * the specified address, but also for blobs which were loaded to an 313 * alias of the region at a different location in the AddressSpace. 314 * In other words, if a machine model has RAM at address 0x0000_0000 315 * which is aliased to also appear at 0x1000_0000, rom_ptr_for_as() 316 * will return the correct data whether the guest image was linked and 317 * loaded at 0x0000_0000 or 0x1000_0000. Contrast rom_ptr(), which 318 * will only return data if the image load address is an exact match 319 * with the queried address. 320 * 321 * New code should prefer to use rom_ptr_for_as() instead of 322 * rom_ptr(). 323 */ 324 void *rom_ptr_for_as(AddressSpace *as, hwaddr addr, size_t size); 325 void hmp_info_roms(Monitor *mon, const QDict *qdict); 326 327 #define rom_add_file_fixed(_f, _a, _i) \ 328 rom_add_file(_f, NULL, _a, _i, false, NULL, NULL) 329 #define rom_add_blob_fixed(_f, _b, _l, _a) \ 330 rom_add_blob(_f, _b, _l, _l, _a, NULL, NULL, NULL, NULL, true) 331 #define rom_add_file_mr(_f, _mr, _i) \ 332 rom_add_file(_f, NULL, 0, _i, false, _mr, NULL) 333 #define rom_add_file_as(_f, _as, _i) \ 334 rom_add_file(_f, NULL, 0, _i, false, NULL, _as) 335 #define rom_add_file_fixed_as(_f, _a, _i, _as) \ 336 rom_add_file(_f, NULL, _a, _i, false, NULL, _as) 337 #define rom_add_blob_fixed_as(_f, _b, _l, _a, _as) \ 338 rom_add_blob(_f, _b, _l, _l, _a, NULL, NULL, NULL, _as, true) 339 340 ssize_t rom_add_vga(const char *file); 341 ssize_t rom_add_option(const char *file, int32_t bootindex); 342 343 /* This is the usual maximum in uboot, so if a uImage overflows this, it would 344 * overflow on real hardware too. */ 345 #define UBOOT_MAX_GUNZIP_BYTES (64 << 20) 346 347 typedef struct RomGap { 348 hwaddr base; 349 size_t size; 350 } RomGap; 351 352 /** 353 * rom_find_largest_gap_between: return largest gap between ROMs in given range 354 * 355 * Given a range of addresses, this function finds the largest 356 * contiguous subrange which has no ROMs loaded to it. That is, 357 * it finds the biggest gap which is free for use for other things. 358 */ 359 RomGap rom_find_largest_gap_between(hwaddr base, size_t size); 360 361 #endif