1 /* 2 * QEMU Executable loader 3 * 4 * Copyright (c) 2006 Fabrice Bellard 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to deal 8 * in the Software without restriction, including without limitation the rights 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 * copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in 14 * all copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 22 * THE SOFTWARE. 23 * 24 * Gunzip functionality in this file is derived from u-boot: 25 * 26 * (C) Copyright 2008 Semihalf 27 * 28 * (C) Copyright 2000-2005 29 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 30 * 31 * This program is free software; you can redistribute it and/or 32 * modify it under the terms of the GNU General Public License as 33 * published by the Free Software Foundation; either version 2 of 34 * the License, or (at your option) any later version. 35 * 36 * This program is distributed in the hope that it will be useful, 37 * but WITHOUT ANY WARRANTY; without even the implied warranty of 38 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 39 * GNU General Public License for more details. 40 * 41 * You should have received a copy of the GNU General Public License along 42 * with this program; if not, see <http://www.gnu.org/licenses/>. 43 */ 44 45 #include "qemu/osdep.h" 46 #include "qapi/error.h" 47 #include "hw/hw.h" 48 #include "disas/disas.h" 49 #include "monitor/monitor.h" 50 #include "sysemu/sysemu.h" 51 #include "uboot_image.h" 52 #include "hw/loader.h" 53 #include "hw/nvram/fw_cfg.h" 54 #include "exec/memory.h" 55 #include "exec/address-spaces.h" 56 #include "hw/boards.h" 57 #include "qemu/cutils.h" 58 59 #include <zlib.h> 60 61 static int roms_loaded; 62 63 /* return the size or -1 if error */ 64 int get_image_size(const char *filename) 65 { 66 int fd, size; 67 fd = open(filename, O_RDONLY | O_BINARY); 68 if (fd < 0) 69 return -1; 70 size = lseek(fd, 0, SEEK_END); 71 close(fd); 72 return size; 73 } 74 75 /* return the size or -1 if error */ 76 /* deprecated, because caller does not specify buffer size! */ 77 int load_image(const char *filename, uint8_t *addr) 78 { 79 int fd, size; 80 fd = open(filename, O_RDONLY | O_BINARY); 81 if (fd < 0) 82 return -1; 83 size = lseek(fd, 0, SEEK_END); 84 if (size == -1) { 85 fprintf(stderr, "file %-20s: get size error: %s\n", 86 filename, strerror(errno)); 87 close(fd); 88 return -1; 89 } 90 91 lseek(fd, 0, SEEK_SET); 92 if (read(fd, addr, size) != size) { 93 close(fd); 94 return -1; 95 } 96 close(fd); 97 return size; 98 } 99 100 /* return the size or -1 if error */ 101 ssize_t load_image_size(const char *filename, void *addr, size_t size) 102 { 103 int fd; 104 ssize_t actsize; 105 106 fd = open(filename, O_RDONLY | O_BINARY); 107 if (fd < 0) { 108 return -1; 109 } 110 111 actsize = read(fd, addr, size); 112 if (actsize < 0) { 113 close(fd); 114 return -1; 115 } 116 close(fd); 117 118 return actsize; 119 } 120 121 /* read()-like version */ 122 ssize_t read_targphys(const char *name, 123 int fd, hwaddr dst_addr, size_t nbytes) 124 { 125 uint8_t *buf; 126 ssize_t did; 127 128 buf = g_malloc(nbytes); 129 did = read(fd, buf, nbytes); 130 if (did > 0) 131 rom_add_blob_fixed("read", buf, did, dst_addr); 132 g_free(buf); 133 return did; 134 } 135 136 int load_image_targphys(const char *filename, 137 hwaddr addr, uint64_t max_sz) 138 { 139 return load_image_targphys_as(filename, addr, max_sz, NULL); 140 } 141 142 /* return the size or -1 if error */ 143 int load_image_targphys_as(const char *filename, 144 hwaddr addr, uint64_t max_sz, AddressSpace *as) 145 { 146 int size; 147 148 size = get_image_size(filename); 149 if (size > max_sz) { 150 return -1; 151 } 152 if (size > 0) { 153 rom_add_file_fixed_as(filename, addr, -1, as); 154 } 155 return size; 156 } 157 158 int load_image_mr(const char *filename, MemoryRegion *mr) 159 { 160 int size; 161 162 if (!memory_access_is_direct(mr, false)) { 163 /* Can only load an image into RAM or ROM */ 164 return -1; 165 } 166 167 size = get_image_size(filename); 168 169 if (size > memory_region_size(mr)) { 170 return -1; 171 } 172 if (size > 0) { 173 if (rom_add_file_mr(filename, mr, -1) < 0) { 174 return -1; 175 } 176 } 177 return size; 178 } 179 180 void pstrcpy_targphys(const char *name, hwaddr dest, int buf_size, 181 const char *source) 182 { 183 const char *nulp; 184 char *ptr; 185 186 if (buf_size <= 0) return; 187 nulp = memchr(source, 0, buf_size); 188 if (nulp) { 189 rom_add_blob_fixed(name, source, (nulp - source) + 1, dest); 190 } else { 191 rom_add_blob_fixed(name, source, buf_size, dest); 192 ptr = rom_ptr(dest + buf_size - 1); 193 *ptr = 0; 194 } 195 } 196 197 /* A.OUT loader */ 198 199 struct exec 200 { 201 uint32_t a_info; /* Use macros N_MAGIC, etc for access */ 202 uint32_t a_text; /* length of text, in bytes */ 203 uint32_t a_data; /* length of data, in bytes */ 204 uint32_t a_bss; /* length of uninitialized data area, in bytes */ 205 uint32_t a_syms; /* length of symbol table data in file, in bytes */ 206 uint32_t a_entry; /* start address */ 207 uint32_t a_trsize; /* length of relocation info for text, in bytes */ 208 uint32_t a_drsize; /* length of relocation info for data, in bytes */ 209 }; 210 211 static void bswap_ahdr(struct exec *e) 212 { 213 bswap32s(&e->a_info); 214 bswap32s(&e->a_text); 215 bswap32s(&e->a_data); 216 bswap32s(&e->a_bss); 217 bswap32s(&e->a_syms); 218 bswap32s(&e->a_entry); 219 bswap32s(&e->a_trsize); 220 bswap32s(&e->a_drsize); 221 } 222 223 #define N_MAGIC(exec) ((exec).a_info & 0xffff) 224 #define OMAGIC 0407 225 #define NMAGIC 0410 226 #define ZMAGIC 0413 227 #define QMAGIC 0314 228 #define _N_HDROFF(x) (1024 - sizeof (struct exec)) 229 #define N_TXTOFF(x) \ 230 (N_MAGIC(x) == ZMAGIC ? _N_HDROFF((x)) + sizeof (struct exec) : \ 231 (N_MAGIC(x) == QMAGIC ? 0 : sizeof (struct exec))) 232 #define N_TXTADDR(x, target_page_size) (N_MAGIC(x) == QMAGIC ? target_page_size : 0) 233 #define _N_SEGMENT_ROUND(x, target_page_size) (((x) + target_page_size - 1) & ~(target_page_size - 1)) 234 235 #define _N_TXTENDADDR(x, target_page_size) (N_TXTADDR(x, target_page_size)+(x).a_text) 236 237 #define N_DATADDR(x, target_page_size) \ 238 (N_MAGIC(x)==OMAGIC? (_N_TXTENDADDR(x, target_page_size)) \ 239 : (_N_SEGMENT_ROUND (_N_TXTENDADDR(x, target_page_size), target_page_size))) 240 241 242 int load_aout(const char *filename, hwaddr addr, int max_sz, 243 int bswap_needed, hwaddr target_page_size) 244 { 245 int fd; 246 ssize_t size, ret; 247 struct exec e; 248 uint32_t magic; 249 250 fd = open(filename, O_RDONLY | O_BINARY); 251 if (fd < 0) 252 return -1; 253 254 size = read(fd, &e, sizeof(e)); 255 if (size < 0) 256 goto fail; 257 258 if (bswap_needed) { 259 bswap_ahdr(&e); 260 } 261 262 magic = N_MAGIC(e); 263 switch (magic) { 264 case ZMAGIC: 265 case QMAGIC: 266 case OMAGIC: 267 if (e.a_text + e.a_data > max_sz) 268 goto fail; 269 lseek(fd, N_TXTOFF(e), SEEK_SET); 270 size = read_targphys(filename, fd, addr, e.a_text + e.a_data); 271 if (size < 0) 272 goto fail; 273 break; 274 case NMAGIC: 275 if (N_DATADDR(e, target_page_size) + e.a_data > max_sz) 276 goto fail; 277 lseek(fd, N_TXTOFF(e), SEEK_SET); 278 size = read_targphys(filename, fd, addr, e.a_text); 279 if (size < 0) 280 goto fail; 281 ret = read_targphys(filename, fd, addr + N_DATADDR(e, target_page_size), 282 e.a_data); 283 if (ret < 0) 284 goto fail; 285 size += ret; 286 break; 287 default: 288 goto fail; 289 } 290 close(fd); 291 return size; 292 fail: 293 close(fd); 294 return -1; 295 } 296 297 /* ELF loader */ 298 299 static void *load_at(int fd, off_t offset, size_t size) 300 { 301 void *ptr; 302 if (lseek(fd, offset, SEEK_SET) < 0) 303 return NULL; 304 ptr = g_malloc(size); 305 if (read(fd, ptr, size) != size) { 306 g_free(ptr); 307 return NULL; 308 } 309 return ptr; 310 } 311 312 #ifdef ELF_CLASS 313 #undef ELF_CLASS 314 #endif 315 316 #define ELF_CLASS ELFCLASS32 317 #include "elf.h" 318 319 #define SZ 32 320 #define elf_word uint32_t 321 #define elf_sword int32_t 322 #define bswapSZs bswap32s 323 #include "hw/elf_ops.h" 324 325 #undef elfhdr 326 #undef elf_phdr 327 #undef elf_shdr 328 #undef elf_sym 329 #undef elf_rela 330 #undef elf_note 331 #undef elf_word 332 #undef elf_sword 333 #undef bswapSZs 334 #undef SZ 335 #define elfhdr elf64_hdr 336 #define elf_phdr elf64_phdr 337 #define elf_note elf64_note 338 #define elf_shdr elf64_shdr 339 #define elf_sym elf64_sym 340 #define elf_rela elf64_rela 341 #define elf_word uint64_t 342 #define elf_sword int64_t 343 #define bswapSZs bswap64s 344 #define SZ 64 345 #include "hw/elf_ops.h" 346 347 const char *load_elf_strerror(int error) 348 { 349 switch (error) { 350 case 0: 351 return "No error"; 352 case ELF_LOAD_FAILED: 353 return "Failed to load ELF"; 354 case ELF_LOAD_NOT_ELF: 355 return "The image is not ELF"; 356 case ELF_LOAD_WRONG_ARCH: 357 return "The image is from incompatible architecture"; 358 case ELF_LOAD_WRONG_ENDIAN: 359 return "The image has incorrect endianness"; 360 default: 361 return "Unknown error"; 362 } 363 } 364 365 void load_elf_hdr(const char *filename, void *hdr, bool *is64, Error **errp) 366 { 367 int fd; 368 uint8_t e_ident_local[EI_NIDENT]; 369 uint8_t *e_ident; 370 size_t hdr_size, off; 371 bool is64l; 372 373 if (!hdr) { 374 hdr = e_ident_local; 375 } 376 e_ident = hdr; 377 378 fd = open(filename, O_RDONLY | O_BINARY); 379 if (fd < 0) { 380 error_setg_errno(errp, errno, "Failed to open file: %s", filename); 381 return; 382 } 383 if (read(fd, hdr, EI_NIDENT) != EI_NIDENT) { 384 error_setg_errno(errp, errno, "Failed to read file: %s", filename); 385 goto fail; 386 } 387 if (e_ident[0] != ELFMAG0 || 388 e_ident[1] != ELFMAG1 || 389 e_ident[2] != ELFMAG2 || 390 e_ident[3] != ELFMAG3) { 391 error_setg(errp, "Bad ELF magic"); 392 goto fail; 393 } 394 395 is64l = e_ident[EI_CLASS] == ELFCLASS64; 396 hdr_size = is64l ? sizeof(Elf64_Ehdr) : sizeof(Elf32_Ehdr); 397 if (is64) { 398 *is64 = is64l; 399 } 400 401 off = EI_NIDENT; 402 while (hdr != e_ident_local && off < hdr_size) { 403 size_t br = read(fd, hdr + off, hdr_size - off); 404 switch (br) { 405 case 0: 406 error_setg(errp, "File too short: %s", filename); 407 goto fail; 408 case -1: 409 error_setg_errno(errp, errno, "Failed to read file: %s", 410 filename); 411 goto fail; 412 } 413 off += br; 414 } 415 416 fail: 417 close(fd); 418 } 419 420 /* return < 0 if error, otherwise the number of bytes loaded in memory */ 421 int load_elf(const char *filename, uint64_t (*translate_fn)(void *, uint64_t), 422 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr, 423 uint64_t *highaddr, int big_endian, int elf_machine, 424 int clear_lsb, int data_swab) 425 { 426 return load_elf_as(filename, translate_fn, translate_opaque, pentry, 427 lowaddr, highaddr, big_endian, elf_machine, clear_lsb, 428 data_swab, NULL); 429 } 430 431 /* return < 0 if error, otherwise the number of bytes loaded in memory */ 432 int load_elf_as(const char *filename, 433 uint64_t (*translate_fn)(void *, uint64_t), 434 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr, 435 uint64_t *highaddr, int big_endian, int elf_machine, 436 int clear_lsb, int data_swab, AddressSpace *as) 437 { 438 return load_elf_ram(filename, translate_fn, translate_opaque, 439 pentry, lowaddr, highaddr, big_endian, elf_machine, 440 clear_lsb, data_swab, as, true); 441 } 442 443 /* return < 0 if error, otherwise the number of bytes loaded in memory */ 444 int load_elf_ram(const char *filename, 445 uint64_t (*translate_fn)(void *, uint64_t), 446 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr, 447 uint64_t *highaddr, int big_endian, int elf_machine, 448 int clear_lsb, int data_swab, AddressSpace *as, 449 bool load_rom) 450 { 451 int fd, data_order, target_data_order, must_swab, ret = ELF_LOAD_FAILED; 452 uint8_t e_ident[EI_NIDENT]; 453 454 fd = open(filename, O_RDONLY | O_BINARY); 455 if (fd < 0) { 456 perror(filename); 457 return -1; 458 } 459 if (read(fd, e_ident, sizeof(e_ident)) != sizeof(e_ident)) 460 goto fail; 461 if (e_ident[0] != ELFMAG0 || 462 e_ident[1] != ELFMAG1 || 463 e_ident[2] != ELFMAG2 || 464 e_ident[3] != ELFMAG3) { 465 ret = ELF_LOAD_NOT_ELF; 466 goto fail; 467 } 468 #ifdef HOST_WORDS_BIGENDIAN 469 data_order = ELFDATA2MSB; 470 #else 471 data_order = ELFDATA2LSB; 472 #endif 473 must_swab = data_order != e_ident[EI_DATA]; 474 if (big_endian) { 475 target_data_order = ELFDATA2MSB; 476 } else { 477 target_data_order = ELFDATA2LSB; 478 } 479 480 if (target_data_order != e_ident[EI_DATA]) { 481 fprintf(stderr, "%s: wrong endianness\n", filename); 482 ret = ELF_LOAD_WRONG_ENDIAN; 483 goto fail; 484 } 485 486 lseek(fd, 0, SEEK_SET); 487 if (e_ident[EI_CLASS] == ELFCLASS64) { 488 ret = load_elf64(filename, fd, translate_fn, translate_opaque, must_swab, 489 pentry, lowaddr, highaddr, elf_machine, clear_lsb, 490 data_swab, as, load_rom); 491 } else { 492 ret = load_elf32(filename, fd, translate_fn, translate_opaque, must_swab, 493 pentry, lowaddr, highaddr, elf_machine, clear_lsb, 494 data_swab, as, load_rom); 495 } 496 497 fail: 498 close(fd); 499 return ret; 500 } 501 502 static void bswap_uboot_header(uboot_image_header_t *hdr) 503 { 504 #ifndef HOST_WORDS_BIGENDIAN 505 bswap32s(&hdr->ih_magic); 506 bswap32s(&hdr->ih_hcrc); 507 bswap32s(&hdr->ih_time); 508 bswap32s(&hdr->ih_size); 509 bswap32s(&hdr->ih_load); 510 bswap32s(&hdr->ih_ep); 511 bswap32s(&hdr->ih_dcrc); 512 #endif 513 } 514 515 516 #define ZALLOC_ALIGNMENT 16 517 518 static void *zalloc(void *x, unsigned items, unsigned size) 519 { 520 void *p; 521 522 size *= items; 523 size = (size + ZALLOC_ALIGNMENT - 1) & ~(ZALLOC_ALIGNMENT - 1); 524 525 p = g_malloc(size); 526 527 return (p); 528 } 529 530 static void zfree(void *x, void *addr) 531 { 532 g_free(addr); 533 } 534 535 536 #define HEAD_CRC 2 537 #define EXTRA_FIELD 4 538 #define ORIG_NAME 8 539 #define COMMENT 0x10 540 #define RESERVED 0xe0 541 542 #define DEFLATED 8 543 544 ssize_t gunzip(void *dst, size_t dstlen, uint8_t *src, size_t srclen) 545 { 546 z_stream s; 547 ssize_t dstbytes; 548 int r, i, flags; 549 550 /* skip header */ 551 i = 10; 552 flags = src[3]; 553 if (src[2] != DEFLATED || (flags & RESERVED) != 0) { 554 puts ("Error: Bad gzipped data\n"); 555 return -1; 556 } 557 if ((flags & EXTRA_FIELD) != 0) 558 i = 12 + src[10] + (src[11] << 8); 559 if ((flags & ORIG_NAME) != 0) 560 while (src[i++] != 0) 561 ; 562 if ((flags & COMMENT) != 0) 563 while (src[i++] != 0) 564 ; 565 if ((flags & HEAD_CRC) != 0) 566 i += 2; 567 if (i >= srclen) { 568 puts ("Error: gunzip out of data in header\n"); 569 return -1; 570 } 571 572 s.zalloc = zalloc; 573 s.zfree = zfree; 574 575 r = inflateInit2(&s, -MAX_WBITS); 576 if (r != Z_OK) { 577 printf ("Error: inflateInit2() returned %d\n", r); 578 return (-1); 579 } 580 s.next_in = src + i; 581 s.avail_in = srclen - i; 582 s.next_out = dst; 583 s.avail_out = dstlen; 584 r = inflate(&s, Z_FINISH); 585 if (r != Z_OK && r != Z_STREAM_END) { 586 printf ("Error: inflate() returned %d\n", r); 587 return -1; 588 } 589 dstbytes = s.next_out - (unsigned char *) dst; 590 inflateEnd(&s); 591 592 return dstbytes; 593 } 594 595 /* Load a U-Boot image. */ 596 static int load_uboot_image(const char *filename, hwaddr *ep, hwaddr *loadaddr, 597 int *is_linux, uint8_t image_type, 598 uint64_t (*translate_fn)(void *, uint64_t), 599 void *translate_opaque, AddressSpace *as) 600 { 601 int fd; 602 int size; 603 hwaddr address; 604 uboot_image_header_t h; 605 uboot_image_header_t *hdr = &h; 606 uint8_t *data = NULL; 607 int ret = -1; 608 int do_uncompress = 0; 609 610 fd = open(filename, O_RDONLY | O_BINARY); 611 if (fd < 0) 612 return -1; 613 614 size = read(fd, hdr, sizeof(uboot_image_header_t)); 615 if (size < sizeof(uboot_image_header_t)) { 616 goto out; 617 } 618 619 bswap_uboot_header(hdr); 620 621 if (hdr->ih_magic != IH_MAGIC) 622 goto out; 623 624 if (hdr->ih_type != image_type) { 625 fprintf(stderr, "Wrong image type %d, expected %d\n", hdr->ih_type, 626 image_type); 627 goto out; 628 } 629 630 /* TODO: Implement other image types. */ 631 switch (hdr->ih_type) { 632 case IH_TYPE_KERNEL: 633 address = hdr->ih_load; 634 if (translate_fn) { 635 address = translate_fn(translate_opaque, address); 636 } 637 if (loadaddr) { 638 *loadaddr = hdr->ih_load; 639 } 640 641 switch (hdr->ih_comp) { 642 case IH_COMP_NONE: 643 break; 644 case IH_COMP_GZIP: 645 do_uncompress = 1; 646 break; 647 default: 648 fprintf(stderr, 649 "Unable to load u-boot images with compression type %d\n", 650 hdr->ih_comp); 651 goto out; 652 } 653 654 if (ep) { 655 *ep = hdr->ih_ep; 656 } 657 658 /* TODO: Check CPU type. */ 659 if (is_linux) { 660 if (hdr->ih_os == IH_OS_LINUX) { 661 *is_linux = 1; 662 } else { 663 *is_linux = 0; 664 } 665 } 666 667 break; 668 case IH_TYPE_RAMDISK: 669 address = *loadaddr; 670 break; 671 default: 672 fprintf(stderr, "Unsupported u-boot image type %d\n", hdr->ih_type); 673 goto out; 674 } 675 676 data = g_malloc(hdr->ih_size); 677 678 if (read(fd, data, hdr->ih_size) != hdr->ih_size) { 679 fprintf(stderr, "Error reading file\n"); 680 goto out; 681 } 682 683 if (do_uncompress) { 684 uint8_t *compressed_data; 685 size_t max_bytes; 686 ssize_t bytes; 687 688 compressed_data = data; 689 max_bytes = UBOOT_MAX_GUNZIP_BYTES; 690 data = g_malloc(max_bytes); 691 692 bytes = gunzip(data, max_bytes, compressed_data, hdr->ih_size); 693 g_free(compressed_data); 694 if (bytes < 0) { 695 fprintf(stderr, "Unable to decompress gzipped image!\n"); 696 goto out; 697 } 698 hdr->ih_size = bytes; 699 } 700 701 rom_add_blob_fixed_as(filename, data, hdr->ih_size, address, as); 702 703 ret = hdr->ih_size; 704 705 out: 706 g_free(data); 707 close(fd); 708 return ret; 709 } 710 711 int load_uimage(const char *filename, hwaddr *ep, hwaddr *loadaddr, 712 int *is_linux, 713 uint64_t (*translate_fn)(void *, uint64_t), 714 void *translate_opaque) 715 { 716 return load_uboot_image(filename, ep, loadaddr, is_linux, IH_TYPE_KERNEL, 717 translate_fn, translate_opaque, NULL); 718 } 719 720 int load_uimage_as(const char *filename, hwaddr *ep, hwaddr *loadaddr, 721 int *is_linux, 722 uint64_t (*translate_fn)(void *, uint64_t), 723 void *translate_opaque, AddressSpace *as) 724 { 725 return load_uboot_image(filename, ep, loadaddr, is_linux, IH_TYPE_KERNEL, 726 translate_fn, translate_opaque, as); 727 } 728 729 /* Load a ramdisk. */ 730 int load_ramdisk(const char *filename, hwaddr addr, uint64_t max_sz) 731 { 732 return load_uboot_image(filename, NULL, &addr, NULL, IH_TYPE_RAMDISK, 733 NULL, NULL, NULL); 734 } 735 736 /* Load a gzip-compressed kernel to a dynamically allocated buffer. */ 737 int load_image_gzipped_buffer(const char *filename, uint64_t max_sz, 738 uint8_t **buffer) 739 { 740 uint8_t *compressed_data = NULL; 741 uint8_t *data = NULL; 742 gsize len; 743 ssize_t bytes; 744 int ret = -1; 745 746 if (!g_file_get_contents(filename, (char **) &compressed_data, &len, 747 NULL)) { 748 goto out; 749 } 750 751 /* Is it a gzip-compressed file? */ 752 if (len < 2 || 753 compressed_data[0] != 0x1f || 754 compressed_data[1] != 0x8b) { 755 goto out; 756 } 757 758 if (max_sz > LOAD_IMAGE_MAX_GUNZIP_BYTES) { 759 max_sz = LOAD_IMAGE_MAX_GUNZIP_BYTES; 760 } 761 762 data = g_malloc(max_sz); 763 bytes = gunzip(data, max_sz, compressed_data, len); 764 if (bytes < 0) { 765 fprintf(stderr, "%s: unable to decompress gzipped kernel file\n", 766 filename); 767 goto out; 768 } 769 770 /* trim to actual size and return to caller */ 771 *buffer = g_realloc(data, bytes); 772 ret = bytes; 773 /* ownership has been transferred to caller */ 774 data = NULL; 775 776 out: 777 g_free(compressed_data); 778 g_free(data); 779 return ret; 780 } 781 782 /* Load a gzip-compressed kernel. */ 783 int load_image_gzipped(const char *filename, hwaddr addr, uint64_t max_sz) 784 { 785 int bytes; 786 uint8_t *data; 787 788 bytes = load_image_gzipped_buffer(filename, max_sz, &data); 789 if (bytes != -1) { 790 rom_add_blob_fixed(filename, data, bytes, addr); 791 g_free(data); 792 } 793 return bytes; 794 } 795 796 /* 797 * Functions for reboot-persistent memory regions. 798 * - used for vga bios and option roms. 799 * - also linux kernel (-kernel / -initrd). 800 */ 801 802 typedef struct Rom Rom; 803 804 struct Rom { 805 char *name; 806 char *path; 807 808 /* datasize is the amount of memory allocated in "data". If datasize is less 809 * than romsize, it means that the area from datasize to romsize is filled 810 * with zeros. 811 */ 812 size_t romsize; 813 size_t datasize; 814 815 uint8_t *data; 816 MemoryRegion *mr; 817 AddressSpace *as; 818 int isrom; 819 char *fw_dir; 820 char *fw_file; 821 822 hwaddr addr; 823 QTAILQ_ENTRY(Rom) next; 824 }; 825 826 static FWCfgState *fw_cfg; 827 static QTAILQ_HEAD(, Rom) roms = QTAILQ_HEAD_INITIALIZER(roms); 828 829 static inline bool rom_order_compare(Rom *rom, Rom *item) 830 { 831 return ((uintptr_t)(void *)rom->as > (uintptr_t)(void *)item->as) || 832 (rom->as == item->as && rom->addr >= item->addr); 833 } 834 835 static void rom_insert(Rom *rom) 836 { 837 Rom *item; 838 839 if (roms_loaded) { 840 hw_error ("ROM images must be loaded at startup\n"); 841 } 842 843 /* The user didn't specify an address space, this is the default */ 844 if (!rom->as) { 845 rom->as = &address_space_memory; 846 } 847 848 /* List is ordered by load address in the same address space */ 849 QTAILQ_FOREACH(item, &roms, next) { 850 if (rom_order_compare(rom, item)) { 851 continue; 852 } 853 QTAILQ_INSERT_BEFORE(item, rom, next); 854 return; 855 } 856 QTAILQ_INSERT_TAIL(&roms, rom, next); 857 } 858 859 static void fw_cfg_resized(const char *id, uint64_t length, void *host) 860 { 861 if (fw_cfg) { 862 fw_cfg_modify_file(fw_cfg, id + strlen("/rom@"), host, length); 863 } 864 } 865 866 static void *rom_set_mr(Rom *rom, Object *owner, const char *name, bool ro) 867 { 868 void *data; 869 870 rom->mr = g_malloc(sizeof(*rom->mr)); 871 memory_region_init_resizeable_ram(rom->mr, owner, name, 872 rom->datasize, rom->romsize, 873 fw_cfg_resized, 874 &error_fatal); 875 memory_region_set_readonly(rom->mr, ro); 876 vmstate_register_ram_global(rom->mr); 877 878 data = memory_region_get_ram_ptr(rom->mr); 879 memcpy(data, rom->data, rom->datasize); 880 881 return data; 882 } 883 884 int rom_add_file(const char *file, const char *fw_dir, 885 hwaddr addr, int32_t bootindex, 886 bool option_rom, MemoryRegion *mr, 887 AddressSpace *as) 888 { 889 MachineClass *mc = MACHINE_GET_CLASS(qdev_get_machine()); 890 Rom *rom; 891 int rc, fd = -1; 892 char devpath[100]; 893 894 if (as && mr) { 895 fprintf(stderr, "Specifying an Address Space and Memory Region is " \ 896 "not valid when loading a rom\n"); 897 /* We haven't allocated anything so we don't need any cleanup */ 898 return -1; 899 } 900 901 rom = g_malloc0(sizeof(*rom)); 902 rom->name = g_strdup(file); 903 rom->path = qemu_find_file(QEMU_FILE_TYPE_BIOS, rom->name); 904 rom->as = as; 905 if (rom->path == NULL) { 906 rom->path = g_strdup(file); 907 } 908 909 fd = open(rom->path, O_RDONLY | O_BINARY); 910 if (fd == -1) { 911 fprintf(stderr, "Could not open option rom '%s': %s\n", 912 rom->path, strerror(errno)); 913 goto err; 914 } 915 916 if (fw_dir) { 917 rom->fw_dir = g_strdup(fw_dir); 918 rom->fw_file = g_strdup(file); 919 } 920 rom->addr = addr; 921 rom->romsize = lseek(fd, 0, SEEK_END); 922 if (rom->romsize == -1) { 923 fprintf(stderr, "rom: file %-20s: get size error: %s\n", 924 rom->name, strerror(errno)); 925 goto err; 926 } 927 928 rom->datasize = rom->romsize; 929 rom->data = g_malloc0(rom->datasize); 930 lseek(fd, 0, SEEK_SET); 931 rc = read(fd, rom->data, rom->datasize); 932 if (rc != rom->datasize) { 933 fprintf(stderr, "rom: file %-20s: read error: rc=%d (expected %zd)\n", 934 rom->name, rc, rom->datasize); 935 goto err; 936 } 937 close(fd); 938 rom_insert(rom); 939 if (rom->fw_file && fw_cfg) { 940 const char *basename; 941 char fw_file_name[FW_CFG_MAX_FILE_PATH]; 942 void *data; 943 944 basename = strrchr(rom->fw_file, '/'); 945 if (basename) { 946 basename++; 947 } else { 948 basename = rom->fw_file; 949 } 950 snprintf(fw_file_name, sizeof(fw_file_name), "%s/%s", rom->fw_dir, 951 basename); 952 snprintf(devpath, sizeof(devpath), "/rom@%s", fw_file_name); 953 954 if ((!option_rom || mc->option_rom_has_mr) && mc->rom_file_has_mr) { 955 data = rom_set_mr(rom, OBJECT(fw_cfg), devpath, true); 956 } else { 957 data = rom->data; 958 } 959 960 fw_cfg_add_file(fw_cfg, fw_file_name, data, rom->romsize); 961 } else { 962 if (mr) { 963 rom->mr = mr; 964 snprintf(devpath, sizeof(devpath), "/rom@%s", file); 965 } else { 966 snprintf(devpath, sizeof(devpath), "/rom@" TARGET_FMT_plx, addr); 967 } 968 } 969 970 add_boot_device_path(bootindex, NULL, devpath); 971 return 0; 972 973 err: 974 if (fd != -1) 975 close(fd); 976 977 g_free(rom->data); 978 g_free(rom->path); 979 g_free(rom->name); 980 if (fw_dir) { 981 g_free(rom->fw_dir); 982 g_free(rom->fw_file); 983 } 984 g_free(rom); 985 986 return -1; 987 } 988 989 MemoryRegion *rom_add_blob(const char *name, const void *blob, size_t len, 990 size_t max_len, hwaddr addr, const char *fw_file_name, 991 FWCfgReadCallback fw_callback, void *callback_opaque, 992 AddressSpace *as, bool read_only) 993 { 994 MachineClass *mc = MACHINE_GET_CLASS(qdev_get_machine()); 995 Rom *rom; 996 MemoryRegion *mr = NULL; 997 998 rom = g_malloc0(sizeof(*rom)); 999 rom->name = g_strdup(name); 1000 rom->as = as; 1001 rom->addr = addr; 1002 rom->romsize = max_len ? max_len : len; 1003 rom->datasize = len; 1004 rom->data = g_malloc0(rom->datasize); 1005 memcpy(rom->data, blob, len); 1006 rom_insert(rom); 1007 if (fw_file_name && fw_cfg) { 1008 char devpath[100]; 1009 void *data; 1010 1011 if (read_only) { 1012 snprintf(devpath, sizeof(devpath), "/rom@%s", fw_file_name); 1013 } else { 1014 snprintf(devpath, sizeof(devpath), "/ram@%s", fw_file_name); 1015 } 1016 1017 if (mc->rom_file_has_mr) { 1018 data = rom_set_mr(rom, OBJECT(fw_cfg), devpath, read_only); 1019 mr = rom->mr; 1020 } else { 1021 data = rom->data; 1022 } 1023 1024 fw_cfg_add_file_callback(fw_cfg, fw_file_name, 1025 fw_callback, callback_opaque, 1026 data, rom->datasize, read_only); 1027 } 1028 return mr; 1029 } 1030 1031 /* This function is specific for elf program because we don't need to allocate 1032 * all the rom. We just allocate the first part and the rest is just zeros. This 1033 * is why romsize and datasize are different. Also, this function seize the 1034 * memory ownership of "data", so we don't have to allocate and copy the buffer. 1035 */ 1036 int rom_add_elf_program(const char *name, void *data, size_t datasize, 1037 size_t romsize, hwaddr addr, AddressSpace *as) 1038 { 1039 Rom *rom; 1040 1041 rom = g_malloc0(sizeof(*rom)); 1042 rom->name = g_strdup(name); 1043 rom->addr = addr; 1044 rom->datasize = datasize; 1045 rom->romsize = romsize; 1046 rom->data = data; 1047 rom->as = as; 1048 rom_insert(rom); 1049 return 0; 1050 } 1051 1052 int rom_add_vga(const char *file) 1053 { 1054 return rom_add_file(file, "vgaroms", 0, -1, true, NULL, NULL); 1055 } 1056 1057 int rom_add_option(const char *file, int32_t bootindex) 1058 { 1059 return rom_add_file(file, "genroms", 0, bootindex, true, NULL, NULL); 1060 } 1061 1062 static void rom_reset(void *unused) 1063 { 1064 Rom *rom; 1065 1066 QTAILQ_FOREACH(rom, &roms, next) { 1067 if (rom->fw_file) { 1068 continue; 1069 } 1070 if (rom->data == NULL) { 1071 continue; 1072 } 1073 if (rom->mr) { 1074 void *host = memory_region_get_ram_ptr(rom->mr); 1075 memcpy(host, rom->data, rom->datasize); 1076 } else { 1077 cpu_physical_memory_write_rom(rom->as, rom->addr, rom->data, 1078 rom->datasize); 1079 } 1080 if (rom->isrom) { 1081 /* rom needs to be written only once */ 1082 g_free(rom->data); 1083 rom->data = NULL; 1084 } 1085 /* 1086 * The rom loader is really on the same level as firmware in the guest 1087 * shadowing a ROM into RAM. Such a shadowing mechanism needs to ensure 1088 * that the instruction cache for that new region is clear, so that the 1089 * CPU definitely fetches its instructions from the just written data. 1090 */ 1091 cpu_flush_icache_range(rom->addr, rom->datasize); 1092 } 1093 } 1094 1095 int rom_check_and_register_reset(void) 1096 { 1097 hwaddr addr = 0; 1098 MemoryRegionSection section; 1099 Rom *rom; 1100 AddressSpace *as = NULL; 1101 1102 QTAILQ_FOREACH(rom, &roms, next) { 1103 if (rom->fw_file) { 1104 continue; 1105 } 1106 if ((addr > rom->addr) && (as == rom->as)) { 1107 fprintf(stderr, "rom: requested regions overlap " 1108 "(rom %s. free=0x" TARGET_FMT_plx 1109 ", addr=0x" TARGET_FMT_plx ")\n", 1110 rom->name, addr, rom->addr); 1111 return -1; 1112 } 1113 addr = rom->addr; 1114 addr += rom->romsize; 1115 section = memory_region_find(rom->mr ? rom->mr : get_system_memory(), 1116 rom->addr, 1); 1117 rom->isrom = int128_nz(section.size) && memory_region_is_rom(section.mr); 1118 memory_region_unref(section.mr); 1119 as = rom->as; 1120 } 1121 qemu_register_reset(rom_reset, NULL); 1122 roms_loaded = 1; 1123 return 0; 1124 } 1125 1126 void rom_set_fw(FWCfgState *f) 1127 { 1128 fw_cfg = f; 1129 } 1130 1131 void rom_set_order_override(int order) 1132 { 1133 if (!fw_cfg) 1134 return; 1135 fw_cfg_set_order_override(fw_cfg, order); 1136 } 1137 1138 void rom_reset_order_override(void) 1139 { 1140 if (!fw_cfg) 1141 return; 1142 fw_cfg_reset_order_override(fw_cfg); 1143 } 1144 1145 static Rom *find_rom(hwaddr addr) 1146 { 1147 Rom *rom; 1148 1149 QTAILQ_FOREACH(rom, &roms, next) { 1150 if (rom->fw_file) { 1151 continue; 1152 } 1153 if (rom->mr) { 1154 continue; 1155 } 1156 if (rom->addr > addr) { 1157 continue; 1158 } 1159 if (rom->addr + rom->romsize < addr) { 1160 continue; 1161 } 1162 return rom; 1163 } 1164 return NULL; 1165 } 1166 1167 /* 1168 * Copies memory from registered ROMs to dest. Any memory that is contained in 1169 * a ROM between addr and addr + size is copied. Note that this can involve 1170 * multiple ROMs, which need not start at addr and need not end at addr + size. 1171 */ 1172 int rom_copy(uint8_t *dest, hwaddr addr, size_t size) 1173 { 1174 hwaddr end = addr + size; 1175 uint8_t *s, *d = dest; 1176 size_t l = 0; 1177 Rom *rom; 1178 1179 QTAILQ_FOREACH(rom, &roms, next) { 1180 if (rom->fw_file) { 1181 continue; 1182 } 1183 if (rom->mr) { 1184 continue; 1185 } 1186 if (rom->addr + rom->romsize < addr) { 1187 continue; 1188 } 1189 if (rom->addr > end) { 1190 break; 1191 } 1192 1193 d = dest + (rom->addr - addr); 1194 s = rom->data; 1195 l = rom->datasize; 1196 1197 if ((d + l) > (dest + size)) { 1198 l = dest - d; 1199 } 1200 1201 if (l > 0) { 1202 memcpy(d, s, l); 1203 } 1204 1205 if (rom->romsize > rom->datasize) { 1206 /* If datasize is less than romsize, it means that we didn't 1207 * allocate all the ROM because the trailing data are only zeros. 1208 */ 1209 1210 d += l; 1211 l = rom->romsize - rom->datasize; 1212 1213 if ((d + l) > (dest + size)) { 1214 /* Rom size doesn't fit in the destination area. Adjust to avoid 1215 * overflow. 1216 */ 1217 l = dest - d; 1218 } 1219 1220 if (l > 0) { 1221 memset(d, 0x0, l); 1222 } 1223 } 1224 } 1225 1226 return (d + l) - dest; 1227 } 1228 1229 void *rom_ptr(hwaddr addr) 1230 { 1231 Rom *rom; 1232 1233 rom = find_rom(addr); 1234 if (!rom || !rom->data) 1235 return NULL; 1236 return rom->data + (addr - rom->addr); 1237 } 1238 1239 void hmp_info_roms(Monitor *mon, const QDict *qdict) 1240 { 1241 Rom *rom; 1242 1243 QTAILQ_FOREACH(rom, &roms, next) { 1244 if (rom->mr) { 1245 monitor_printf(mon, "%s" 1246 " size=0x%06zx name=\"%s\"\n", 1247 memory_region_name(rom->mr), 1248 rom->romsize, 1249 rom->name); 1250 } else if (!rom->fw_file) { 1251 monitor_printf(mon, "addr=" TARGET_FMT_plx 1252 " size=0x%06zx mem=%s name=\"%s\"\n", 1253 rom->addr, rom->romsize, 1254 rom->isrom ? "rom" : "ram", 1255 rom->name); 1256 } else { 1257 monitor_printf(mon, "fw=%s/%s" 1258 " size=0x%06zx name=\"%s\"\n", 1259 rom->fw_dir, 1260 rom->fw_file, 1261 rom->romsize, 1262 rom->name); 1263 } 1264 } 1265 } 1266