hw/core/loader.c

   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 "hw/hw.h"
  46 #include "disas/disas.h"
  47 #include "monitor/monitor.h"
  48 #include "sysemu/sysemu.h"
  49 #include "uboot_image.h"
  50 #include "hw/loader.h"
  51 #include "hw/nvram/fw_cfg.h"
  52 #include "exec/memory.h"
  53 #include "exec/address-spaces.h"
  54
  55 #include <zlib.h>
  56
  57 bool option_rom_has_mr = false;
  58 bool rom_file_has_mr = true;
  59
  60 static int roms_loaded;
  61
  62 /* return the size or -1 if error */
  63 int get_image_size(const char *filename)
  64 {
  65     int fd, size;
  66     fd = open(filename, O_RDONLY | O_BINARY);
  67     if (fd < 0)
  68         return -1;
  69     size = lseek(fd, 0, SEEK_END);
  70     close(fd);
  71     return size;
  72 }
  73
  74 /* return the size or -1 if error */
  75 /* deprecated, because caller does not specify buffer size! */
  76 int load_image(const char *filename, uint8_t *addr)
  77 {
  78     int fd, size;
  79     fd = open(filename, O_RDONLY | O_BINARY);
  80     if (fd < 0)
  81         return -1;
  82     size = lseek(fd, 0, SEEK_END);
  83     if (size == -1) {
  84         fprintf(stderr, "file %-20s: get size error: %s\n",
  85                 filename, strerror(errno));
  86         close(fd);
  87         return -1;
  88     }
  89
  90     lseek(fd, 0, SEEK_SET);
  91     if (read(fd, addr, size) != size) {
  92         close(fd);
  93         return -1;
  94     }
  95     close(fd);
  96     return size;
  97 }
  98
  99 /* return the size or -1 if error */
 100 ssize_t load_image_size(const char *filename, void *addr, size_t size)
 101 {
 102     int fd;
 103     ssize_t actsize;
 104
 105     fd = open(filename, O_RDONLY | O_BINARY);
 106     if (fd < 0) {
 107         return -1;
 108     }
 109
 110     actsize = read(fd, addr, size);
 111     if (actsize < 0) {
 112         close(fd);
 113         return -1;
 114     }
 115     close(fd);
 116
 117     return actsize;
 118 }
 119
 120 /* read()-like version */
 121 ssize_t read_targphys(const char *name,
 122                       int fd, hwaddr dst_addr, size_t nbytes)
 123 {
 124     uint8_t *buf;
 125     ssize_t did;
 126
 127     buf = g_malloc(nbytes);
 128     did = read(fd, buf, nbytes);
 129     if (did > 0)
 130         rom_add_blob_fixed("read", buf, did, dst_addr);
 131     g_free(buf);
 132     return did;
 133 }
 134
 135 /* return the size or -1 if error */
 136 int load_image_targphys(const char *filename,
 137                         hwaddr addr, uint64_t max_sz)
 138 {
 139     int size;
 140
 141     size = get_image_size(filename);
 142     if (size > max_sz) {
 143         return -1;
 144     }
 145     if (size > 0) {
 146         rom_add_file_fixed(filename, addr, -1);
 147     }
 148     return size;
 149 }
 150
 151 void pstrcpy_targphys(const char *name, hwaddr dest, int buf_size,
 152                       const char *source)
 153 {
 154     const char *nulp;
 155     char *ptr;
 156
 157     if (buf_size <= 0) return;
 158     nulp = memchr(source, 0, buf_size);
 159     if (nulp) {
 160         rom_add_blob_fixed(name, source, (nulp - source) + 1, dest);
 161     } else {
 162         rom_add_blob_fixed(name, source, buf_size, dest);
 163         ptr = rom_ptr(dest + buf_size - 1);
 164         *ptr = 0;
 165     }
 166 }
 167
 168 /* A.OUT loader */
 169
 170 struct exec
 171 {
 172   uint32_t a_info;   /* Use macros N_MAGIC, etc for access */
 173   uint32_t a_text;   /* length of text, in bytes */
 174   uint32_t a_data;   /* length of data, in bytes */
 175   uint32_t a_bss;    /* length of uninitialized data area, in bytes */
 176   uint32_t a_syms;   /* length of symbol table data in file, in bytes */
 177   uint32_t a_entry;  /* start address */
 178   uint32_t a_trsize; /* length of relocation info for text, in bytes */
 179   uint32_t a_drsize; /* length of relocation info for data, in bytes */
 180 };
 181
 182 static void bswap_ahdr(struct exec *e)
 183 {
 184     bswap32s(&e->a_info);
 185     bswap32s(&e->a_text);
 186     bswap32s(&e->a_data);
 187     bswap32s(&e->a_bss);
 188     bswap32s(&e->a_syms);
 189     bswap32s(&e->a_entry);
 190     bswap32s(&e->a_trsize);
 191     bswap32s(&e->a_drsize);
 192 }
 193
 194 #define N_MAGIC(exec) ((exec).a_info & 0xffff)
 195 #define OMAGIC 0407
 196 #define NMAGIC 0410
 197 #define ZMAGIC 0413
 198 #define QMAGIC 0314
 199 #define _N_HDROFF(x) (1024 - sizeof (struct exec))
 200 #define N_TXTOFF(x)                                                     \
 201     (N_MAGIC(x) == ZMAGIC ? _N_HDROFF((x)) + sizeof (struct exec) :     \
 202      (N_MAGIC(x) == QMAGIC ? 0 : sizeof (struct exec)))
 203 #define N_TXTADDR(x, target_page_size) (N_MAGIC(x) == QMAGIC ? target_page_size : 0)
 204 #define _N_SEGMENT_ROUND(x, target_page_size) (((x) + target_page_size - 1) & ~(target_page_size - 1))
 205
 206 #define _N_TXTENDADDR(x, target_page_size) (N_TXTADDR(x, target_page_size)+(x).a_text)
 207
 208 #define N_DATADDR(x, target_page_size) \
 209     (N_MAGIC(x)==OMAGIC? (_N_TXTENDADDR(x, target_page_size)) \
 210      : (_N_SEGMENT_ROUND (_N_TXTENDADDR(x, target_page_size), target_page_size)))
 211
 212
 213 int load_aout(const char *filename, hwaddr addr, int max_sz,
 214               int bswap_needed, hwaddr target_page_size)
 215 {
 216     int fd;
 217     ssize_t size, ret;
 218     struct exec e;
 219     uint32_t magic;
 220
 221     fd = open(filename, O_RDONLY | O_BINARY);
 222     if (fd < 0)
 223         return -1;
 224
 225     size = read(fd, &e, sizeof(e));
 226     if (size < 0)
 227         goto fail;
 228
 229     if (bswap_needed) {
 230         bswap_ahdr(&e);
 231     }
 232
 233     magic = N_MAGIC(e);
 234     switch (magic) {
 235     case ZMAGIC:
 236     case QMAGIC:
 237     case OMAGIC:
 238         if (e.a_text + e.a_data > max_sz)
 239             goto fail;
 240         lseek(fd, N_TXTOFF(e), SEEK_SET);
 241         size = read_targphys(filename, fd, addr, e.a_text + e.a_data);
 242         if (size < 0)
 243             goto fail;
 244         break;
 245     case NMAGIC:
 246         if (N_DATADDR(e, target_page_size) + e.a_data > max_sz)
 247             goto fail;
 248         lseek(fd, N_TXTOFF(e), SEEK_SET);
 249         size = read_targphys(filename, fd, addr, e.a_text);
 250         if (size < 0)
 251             goto fail;
 252         ret = read_targphys(filename, fd, addr + N_DATADDR(e, target_page_size),
 253                             e.a_data);
 254         if (ret < 0)
 255             goto fail;
 256         size += ret;
 257         break;
 258     default:
 259         goto fail;
 260     }
 261     close(fd);
 262     return size;
 263  fail:
 264     close(fd);
 265     return -1;
 266 }
 267
 268 /* ELF loader */
 269
 270 static void *load_at(int fd, off_t offset, size_t size)
 271 {
 272     void *ptr;
 273     if (lseek(fd, offset, SEEK_SET) < 0)
 274         return NULL;
 275     ptr = g_malloc(size);
 276     if (read(fd, ptr, size) != size) {
 277         g_free(ptr);
 278         return NULL;
 279     }
 280     return ptr;
 281 }
 282
 283 #ifdef ELF_CLASS
 284 #undef ELF_CLASS
 285 #endif
 286
 287 #define ELF_CLASS   ELFCLASS32
 288 #include "elf.h"
 289
 290 #define SZ              32
 291 #define elf_word        uint32_t
 292 #define elf_sword        int32_t
 293 #define bswapSZs        bswap32s
 294 #include "hw/elf_ops.h"
 295
 296 #undef elfhdr
 297 #undef elf_phdr
 298 #undef elf_shdr
 299 #undef elf_sym
 300 #undef elf_rela
 301 #undef elf_note
 302 #undef elf_word
 303 #undef elf_sword
 304 #undef bswapSZs
 305 #undef SZ
 306 #define elfhdr          elf64_hdr
 307 #define elf_phdr        elf64_phdr
 308 #define elf_note        elf64_note
 309 #define elf_shdr        elf64_shdr
 310 #define elf_sym         elf64_sym
 311 #define elf_rela        elf64_rela
 312 #define elf_word        uint64_t
 313 #define elf_sword        int64_t
 314 #define bswapSZs        bswap64s
 315 #define SZ              64
 316 #include "hw/elf_ops.h"
 317
 318 const char *load_elf_strerror(int error)
 319 {
 320     switch (error) {
 321     case 0:
 322         return "No error";
 323     case ELF_LOAD_FAILED:
 324         return "Failed to load ELF";
 325     case ELF_LOAD_NOT_ELF:
 326         return "The image is not ELF";
 327     case ELF_LOAD_WRONG_ARCH:
 328         return "The image is from incompatible architecture";
 329     case ELF_LOAD_WRONG_ENDIAN:
 330         return "The image has incorrect endianness";
 331     default:
 332         return "Unknown error";
 333     }
 334 }
 335
 336 /* return < 0 if error, otherwise the number of bytes loaded in memory */
 337 int load_elf(const char *filename, uint64_t (*translate_fn)(void *, uint64_t),
 338              void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr,
 339              uint64_t *highaddr, int big_endian, int elf_machine, int clear_lsb)
 340 {
 341     int fd, data_order, target_data_order, must_swab, ret = ELF_LOAD_FAILED;
 342     uint8_t e_ident[EI_NIDENT];
 343
 344     fd = open(filename, O_RDONLY | O_BINARY);
 345     if (fd < 0) {
 346         perror(filename);
 347         return -1;
 348     }
 349     if (read(fd, e_ident, sizeof(e_ident)) != sizeof(e_ident))
 350         goto fail;
 351     if (e_ident[0] != ELFMAG0 ||
 352         e_ident[1] != ELFMAG1 ||
 353         e_ident[2] != ELFMAG2 ||
 354         e_ident[3] != ELFMAG3) {
 355         ret = ELF_LOAD_NOT_ELF;
 356         goto fail;
 357     }
 358 #ifdef HOST_WORDS_BIGENDIAN
 359     data_order = ELFDATA2MSB;
 360 #else
 361     data_order = ELFDATA2LSB;
 362 #endif
 363     must_swab = data_order != e_ident[EI_DATA];
 364     if (big_endian) {
 365         target_data_order = ELFDATA2MSB;
 366     } else {
 367         target_data_order = ELFDATA2LSB;
 368     }
 369
 370     if (target_data_order != e_ident[EI_DATA]) {
 371         ret = ELF_LOAD_WRONG_ENDIAN;
 372         goto fail;
 373     }
 374
 375     lseek(fd, 0, SEEK_SET);
 376     if (e_ident[EI_CLASS] == ELFCLASS64) {
 377         ret = load_elf64(filename, fd, translate_fn, translate_opaque, must_swab,
 378                          pentry, lowaddr, highaddr, elf_machine, clear_lsb);
 379     } else {
 380         ret = load_elf32(filename, fd, translate_fn, translate_opaque, must_swab,
 381                          pentry, lowaddr, highaddr, elf_machine, clear_lsb);
 382     }
 383
 384  fail:
 385     close(fd);
 386     return ret;
 387 }
 388
 389 static void bswap_uboot_header(uboot_image_header_t *hdr)
 390 {
 391 #ifndef HOST_WORDS_BIGENDIAN
 392     bswap32s(&hdr->ih_magic);
 393     bswap32s(&hdr->ih_hcrc);
 394     bswap32s(&hdr->ih_time);
 395     bswap32s(&hdr->ih_size);
 396     bswap32s(&hdr->ih_load);
 397     bswap32s(&hdr->ih_ep);
 398     bswap32s(&hdr->ih_dcrc);
 399 #endif
 400 }
 401
 402
 403 #define ZALLOC_ALIGNMENT        16
 404
 405 static void *zalloc(void *x, unsigned items, unsigned size)
 406 {
 407     void *p;
 408
 409     size *= items;
 410     size = (size + ZALLOC_ALIGNMENT - 1) & ~(ZALLOC_ALIGNMENT - 1);
 411
 412     p = g_malloc(size);
 413
 414     return (p);
 415 }
 416
 417 static void zfree(void *x, void *addr)
 418 {
 419     g_free(addr);
 420 }
 421
 422
 423 #define HEAD_CRC        2
 424 #define EXTRA_FIELD     4
 425 #define ORIG_NAME       8
 426 #define COMMENT         0x10
 427 #define RESERVED        0xe0
 428
 429 #define DEFLATED        8
 430
 431 /* This is the usual maximum in uboot, so if a uImage overflows this, it would
 432  * overflow on real hardware too. */
 433 #define UBOOT_MAX_GUNZIP_BYTES (64 << 20)
 434
 435 static ssize_t gunzip(void *dst, size_t dstlen, uint8_t *src,
 436                       size_t srclen)
 437 {
 438     z_stream s;
 439     ssize_t dstbytes;
 440     int r, i, flags;
 441
 442     /* skip header */
 443     i = 10;
 444     flags = src[3];
 445     if (src[2] != DEFLATED || (flags & RESERVED) != 0) {
 446         puts ("Error: Bad gzipped data\n");
 447         return -1;
 448     }
 449     if ((flags & EXTRA_FIELD) != 0)
 450         i = 12 + src[10] + (src[11] << 8);
 451     if ((flags & ORIG_NAME) != 0)
 452         while (src[i++] != 0)
 453             ;
 454     if ((flags & COMMENT) != 0)
 455         while (src[i++] != 0)
 456             ;
 457     if ((flags & HEAD_CRC) != 0)
 458         i += 2;
 459     if (i >= srclen) {
 460         puts ("Error: gunzip out of data in header\n");
 461         return -1;
 462     }
 463
 464     s.zalloc = zalloc;
 465     s.zfree = zfree;
 466
 467     r = inflateInit2(&s, -MAX_WBITS);
 468     if (r != Z_OK) {
 469         printf ("Error: inflateInit2() returned %d\n", r);
 470         return (-1);
 471     }
 472     s.next_in = src + i;
 473     s.avail_in = srclen - i;
 474     s.next_out = dst;
 475     s.avail_out = dstlen;
 476     r = inflate(&s, Z_FINISH);
 477     if (r != Z_OK && r != Z_STREAM_END) {
 478         printf ("Error: inflate() returned %d\n", r);
 479         return -1;
 480     }
 481     dstbytes = s.next_out - (unsigned char *) dst;
 482     inflateEnd(&s);
 483
 484     return dstbytes;
 485 }
 486
 487 /* Load a U-Boot image.  */
 488 static int load_uboot_image(const char *filename, hwaddr *ep, hwaddr *loadaddr,
 489                             int *is_linux, uint8_t image_type,
 490                             uint64_t (*translate_fn)(void *, uint64_t),
 491                             void *translate_opaque)
 492 {
 493     int fd;
 494     int size;
 495     hwaddr address;
 496     uboot_image_header_t h;
 497     uboot_image_header_t *hdr = &h;
 498     uint8_t *data = NULL;
 499     int ret = -1;
 500     int do_uncompress = 0;
 501
 502     fd = open(filename, O_RDONLY | O_BINARY);
 503     if (fd < 0)
 504         return -1;
 505
 506     size = read(fd, hdr, sizeof(uboot_image_header_t));
 507     if (size < 0)
 508         goto out;
 509
 510     bswap_uboot_header(hdr);
 511
 512     if (hdr->ih_magic != IH_MAGIC)
 513         goto out;
 514
 515     if (hdr->ih_type != image_type) {
 516         fprintf(stderr, "Wrong image type %d, expected %d\n", hdr->ih_type,
 517                 image_type);
 518         goto out;
 519     }
 520
 521     /* TODO: Implement other image types.  */
 522     switch (hdr->ih_type) {
 523     case IH_TYPE_KERNEL:
 524         address = hdr->ih_load;
 525         if (translate_fn) {
 526             address = translate_fn(translate_opaque, address);
 527         }
 528         if (loadaddr) {
 529             *loadaddr = hdr->ih_load;
 530         }
 531
 532         switch (hdr->ih_comp) {
 533         case IH_COMP_NONE:
 534             break;
 535         case IH_COMP_GZIP:
 536             do_uncompress = 1;
 537             break;
 538         default:
 539             fprintf(stderr,
 540                     "Unable to load u-boot images with compression type %d\n",
 541                     hdr->ih_comp);
 542             goto out;
 543         }
 544
 545         if (ep) {
 546             *ep = hdr->ih_ep;
 547         }
 548
 549         /* TODO: Check CPU type.  */
 550         if (is_linux) {
 551             if (hdr->ih_os == IH_OS_LINUX) {
 552                 *is_linux = 1;
 553             } else {
 554                 *is_linux = 0;
 555             }
 556         }
 557
 558         break;
 559     case IH_TYPE_RAMDISK:
 560         address = *loadaddr;
 561         break;
 562     default:
 563         fprintf(stderr, "Unsupported u-boot image type %d\n", hdr->ih_type);
 564         goto out;
 565     }
 566
 567     data = g_malloc(hdr->ih_size);
 568
 569     if (read(fd, data, hdr->ih_size) != hdr->ih_size) {
 570         fprintf(stderr, "Error reading file\n");
 571         goto out;
 572     }
 573
 574     if (do_uncompress) {
 575         uint8_t *compressed_data;
 576         size_t max_bytes;
 577         ssize_t bytes;
 578
 579         compressed_data = data;
 580         max_bytes = UBOOT_MAX_GUNZIP_BYTES;
 581         data = g_malloc(max_bytes);
 582
 583         bytes = gunzip(data, max_bytes, compressed_data, hdr->ih_size);
 584         g_free(compressed_data);
 585         if (bytes < 0) {
 586             fprintf(stderr, "Unable to decompress gzipped image!\n");
 587             goto out;
 588         }
 589         hdr->ih_size = bytes;
 590     }
 591
 592     rom_add_blob_fixed(filename, data, hdr->ih_size, address);
 593
 594     ret = hdr->ih_size;
 595
 596 out:
 597     g_free(data);
 598     close(fd);
 599     return ret;
 600 }
 601
 602 int load_uimage(const char *filename, hwaddr *ep, hwaddr *loadaddr,
 603                 int *is_linux,
 604                 uint64_t (*translate_fn)(void *, uint64_t),
 605                 void *translate_opaque)
 606 {
 607     return load_uboot_image(filename, ep, loadaddr, is_linux, IH_TYPE_KERNEL,
 608                             translate_fn, translate_opaque);
 609 }
 610
 611 /* Load a ramdisk.  */
 612 int load_ramdisk(const char *filename, hwaddr addr, uint64_t max_sz)
 613 {
 614     return load_uboot_image(filename, NULL, &addr, NULL, IH_TYPE_RAMDISK,
 615                             NULL, NULL);
 616 }
 617
 618 /* Load a gzip-compressed kernel to a dynamically allocated buffer. */
 619 int load_image_gzipped_buffer(const char *filename, uint64_t max_sz,
 620                               uint8_t **buffer)
 621 {
 622     uint8_t *compressed_data = NULL;
 623     uint8_t *data = NULL;
 624     gsize len;
 625     ssize_t bytes;
 626     int ret = -1;
 627
 628     if (!g_file_get_contents(filename, (char **) &compressed_data, &len,
 629                              NULL)) {
 630         goto out;
 631     }
 632
 633     /* Is it a gzip-compressed file? */
 634     if (len < 2 ||
 635         compressed_data[0] != 0x1f ||
 636         compressed_data[1] != 0x8b) {
 637         goto out;
 638     }
 639
 640     if (max_sz > LOAD_IMAGE_MAX_GUNZIP_BYTES) {
 641         max_sz = LOAD_IMAGE_MAX_GUNZIP_BYTES;
 642     }
 643
 644     data = g_malloc(max_sz);
 645     bytes = gunzip(data, max_sz, compressed_data, len);
 646     if (bytes < 0) {
 647         fprintf(stderr, "%s: unable to decompress gzipped kernel file\n",
 648                 filename);
 649         goto out;
 650     }
 651
 652     /* trim to actual size and return to caller */
 653     *buffer = g_realloc(data, bytes);
 654     ret = bytes;
 655     /* ownership has been transferred to caller */
 656     data = NULL;
 657
 658  out:
 659     g_free(compressed_data);
 660     g_free(data);
 661     return ret;
 662 }
 663
 664 /* Load a gzip-compressed kernel. */
 665 int load_image_gzipped(const char *filename, hwaddr addr, uint64_t max_sz)
 666 {
 667     int bytes;
 668     uint8_t *data;
 669
 670     bytes = load_image_gzipped_buffer(filename, max_sz, &data);
 671     if (bytes != -1) {
 672         rom_add_blob_fixed(filename, data, bytes, addr);
 673         g_free(data);
 674     }
 675     return bytes;
 676 }
 677
 678 /*
 679  * Functions for reboot-persistent memory regions.
 680  *  - used for vga bios and option roms.
 681  *  - also linux kernel (-kernel / -initrd).
 682  */
 683
 684 typedef struct Rom Rom;
 685
 686 struct Rom {
 687     char *name;
 688     char *path;
 689
 690     /* datasize is the amount of memory allocated in "data". If datasize is less
 691      * than romsize, it means that the area from datasize to romsize is filled
 692      * with zeros.
 693      */
 694     size_t romsize;
 695     size_t datasize;
 696
 697     uint8_t *data;
 698     MemoryRegion *mr;
 699     int isrom;
 700     char *fw_dir;
 701     char *fw_file;
 702
 703     hwaddr addr;
 704     QTAILQ_ENTRY(Rom) next;
 705 };
 706
 707 static FWCfgState *fw_cfg;
 708 static QTAILQ_HEAD(, Rom) roms = QTAILQ_HEAD_INITIALIZER(roms);
 709
 710 static void rom_insert(Rom *rom)
 711 {
 712     Rom *item;
 713
 714     if (roms_loaded) {
 715         hw_error ("ROM images must be loaded at startup\n");
 716     }
 717
 718     /* list is ordered by load address */
 719     QTAILQ_FOREACH(item, &roms, next) {
 720         if (rom->addr >= item->addr)
 721             continue;
 722         QTAILQ_INSERT_BEFORE(item, rom, next);
 723         return;
 724     }
 725     QTAILQ_INSERT_TAIL(&roms, rom, next);
 726 }
 727
 728 static void fw_cfg_resized(const char *id, uint64_t length, void *host)
 729 {
 730     if (fw_cfg) {
 731         fw_cfg_modify_file(fw_cfg, id + strlen("/rom@"), host, length);
 732     }
 733 }
 734
 735 static void *rom_set_mr(Rom *rom, Object *owner, const char *name)
 736 {
 737     void *data;
 738
 739     rom->mr = g_malloc(sizeof(*rom->mr));
 740     memory_region_init_resizeable_ram(rom->mr, owner, name,
 741                                       rom->datasize, rom->romsize,
 742                                       fw_cfg_resized,
 743                                       &error_fatal);
 744     memory_region_set_readonly(rom->mr, true);
 745     vmstate_register_ram_global(rom->mr);
 746
 747     data = memory_region_get_ram_ptr(rom->mr);
 748     memcpy(data, rom->data, rom->datasize);
 749
 750     return data;
 751 }
 752
 753 int rom_add_file(const char *file, const char *fw_dir,
 754                  hwaddr addr, int32_t bootindex,
 755                  bool option_rom)
 756 {
 757     Rom *rom;
 758     int rc, fd = -1;
 759     char devpath[100];
 760
 761     rom = g_malloc0(sizeof(*rom));
 762     rom->name = g_strdup(file);
 763     rom->path = qemu_find_file(QEMU_FILE_TYPE_BIOS, rom->name);
 764     if (rom->path == NULL) {
 765         rom->path = g_strdup(file);
 766     }
 767
 768     fd = open(rom->path, O_RDONLY | O_BINARY);
 769     if (fd == -1) {
 770         fprintf(stderr, "Could not open option rom '%s': %s\n",
 771                 rom->path, strerror(errno));
 772         goto err;
 773     }
 774
 775     if (fw_dir) {
 776         rom->fw_dir  = g_strdup(fw_dir);
 777         rom->fw_file = g_strdup(file);
 778     }
 779     rom->addr     = addr;
 780     rom->romsize  = lseek(fd, 0, SEEK_END);
 781     if (rom->romsize == -1) {
 782         fprintf(stderr, "rom: file %-20s: get size error: %s\n",
 783                 rom->name, strerror(errno));
 784         goto err;
 785     }
 786
 787     rom->datasize = rom->romsize;
 788     rom->data     = g_malloc0(rom->datasize);
 789     lseek(fd, 0, SEEK_SET);
 790     rc = read(fd, rom->data, rom->datasize);
 791     if (rc != rom->datasize) {
 792         fprintf(stderr, "rom: file %-20s: read error: rc=%d (expected %zd)\n",
 793                 rom->name, rc, rom->datasize);
 794         goto err;
 795     }
 796     close(fd);
 797     rom_insert(rom);
 798     if (rom->fw_file && fw_cfg) {
 799         const char *basename;
 800         char fw_file_name[FW_CFG_MAX_FILE_PATH];
 801         void *data;
 802
 803         basename = strrchr(rom->fw_file, '/');
 804         if (basename) {
 805             basename++;
 806         } else {
 807             basename = rom->fw_file;
 808         }
 809         snprintf(fw_file_name, sizeof(fw_file_name), "%s/%s", rom->fw_dir,
 810                  basename);
 811         snprintf(devpath, sizeof(devpath), "/rom@%s", fw_file_name);
 812
 813         if ((!option_rom || option_rom_has_mr) && rom_file_has_mr) {
 814             data = rom_set_mr(rom, OBJECT(fw_cfg), devpath);
 815         } else {
 816             data = rom->data;
 817         }
 818
 819         fw_cfg_add_file(fw_cfg, fw_file_name, data, rom->romsize);
 820     } else {
 821         snprintf(devpath, sizeof(devpath), "/rom@" TARGET_FMT_plx, addr);
 822     }
 823
 824     add_boot_device_path(bootindex, NULL, devpath);
 825     return 0;
 826
 827 err:
 828     if (fd != -1)
 829         close(fd);
 830     g_free(rom->data);
 831     g_free(rom->path);
 832     g_free(rom->name);
 833     g_free(rom);
 834     return -1;
 835 }
 836
 837 MemoryRegion *rom_add_blob(const char *name, const void *blob, size_t len,
 838                    size_t max_len, hwaddr addr, const char *fw_file_name,
 839                    FWCfgReadCallback fw_callback, void *callback_opaque)
 840 {
 841     Rom *rom;
 842     MemoryRegion *mr = NULL;
 843
 844     rom           = g_malloc0(sizeof(*rom));
 845     rom->name     = g_strdup(name);
 846     rom->addr     = addr;
 847     rom->romsize  = max_len ? max_len : len;
 848     rom->datasize = len;
 849     rom->data     = g_malloc0(rom->datasize);
 850     memcpy(rom->data, blob, len);
 851     rom_insert(rom);
 852     if (fw_file_name && fw_cfg) {
 853         char devpath[100];
 854         void *data;
 855
 856         snprintf(devpath, sizeof(devpath), "/rom@%s", fw_file_name);
 857
 858         if (rom_file_has_mr) {
 859             data = rom_set_mr(rom, OBJECT(fw_cfg), devpath);
 860             mr = rom->mr;
 861         } else {
 862             data = rom->data;
 863         }
 864
 865         fw_cfg_add_file_callback(fw_cfg, fw_file_name,
 866                                  fw_callback, callback_opaque,
 867                                  data, rom->datasize);
 868     }
 869     return mr;
 870 }
 871
 872 /* This function is specific for elf program because we don't need to allocate
 873  * all the rom. We just allocate the first part and the rest is just zeros. This
 874  * is why romsize and datasize are different. Also, this function seize the
 875  * memory ownership of "data", so we don't have to allocate and copy the buffer.
 876  */
 877 int rom_add_elf_program(const char *name, void *data, size_t datasize,
 878                         size_t romsize, hwaddr addr)
 879 {
 880     Rom *rom;
 881
 882     rom           = g_malloc0(sizeof(*rom));
 883     rom->name     = g_strdup(name);
 884     rom->addr     = addr;
 885     rom->datasize = datasize;
 886     rom->romsize  = romsize;
 887     rom->data     = data;
 888     rom_insert(rom);
 889     return 0;
 890 }
 891
 892 int rom_add_vga(const char *file)
 893 {
 894     return rom_add_file(file, "vgaroms", 0, -1, true);
 895 }
 896
 897 int rom_add_option(const char *file, int32_t bootindex)
 898 {
 899     return rom_add_file(file, "genroms", 0, bootindex, true);
 900 }
 901
 902 static void rom_reset(void *unused)
 903 {
 904     Rom *rom;
 905
 906     QTAILQ_FOREACH(rom, &roms, next) {
 907         if (rom->fw_file) {
 908             continue;
 909         }
 910         if (rom->data == NULL) {
 911             continue;
 912         }
 913         if (rom->mr) {
 914             void *host = memory_region_get_ram_ptr(rom->mr);
 915             memcpy(host, rom->data, rom->datasize);
 916         } else {
 917             cpu_physical_memory_write_rom(&address_space_memory,
 918                                           rom->addr, rom->data, rom->datasize);
 919         }
 920         if (rom->isrom) {
 921             /* rom needs to be written only once */
 922             g_free(rom->data);
 923             rom->data = NULL;
 924         }
 925         /*
 926          * The rom loader is really on the same level as firmware in the guest
 927          * shadowing a ROM into RAM. Such a shadowing mechanism needs to ensure
 928          * that the instruction cache for that new region is clear, so that the
 929          * CPU definitely fetches its instructions from the just written data.
 930          */
 931         cpu_flush_icache_range(rom->addr, rom->datasize);
 932     }
 933 }
 934
 935 int rom_check_and_register_reset(void)
 936 {
 937     hwaddr addr = 0;
 938     MemoryRegionSection section;
 939     Rom *rom;
 940
 941     QTAILQ_FOREACH(rom, &roms, next) {
 942         if (rom->fw_file) {
 943             continue;
 944         }
 945         if (addr > rom->addr) {
 946             fprintf(stderr, "rom: requested regions overlap "
 947                     "(rom %s. free=0x" TARGET_FMT_plx
 948                     ", addr=0x" TARGET_FMT_plx ")\n",
 949                     rom->name, addr, rom->addr);
 950             return -1;
 951         }
 952         addr  = rom->addr;
 953         addr += rom->romsize;
 954         section = memory_region_find(get_system_memory(), rom->addr, 1);
 955         rom->isrom = int128_nz(section.size) && memory_region_is_rom(section.mr);
 956         memory_region_unref(section.mr);
 957     }
 958     qemu_register_reset(rom_reset, NULL);
 959     roms_loaded = 1;
 960     return 0;
 961 }
 962
 963 void rom_set_fw(FWCfgState *f)
 964 {
 965     fw_cfg = f;
 966 }
 967
 968 static Rom *find_rom(hwaddr addr)
 969 {
 970     Rom *rom;
 971
 972     QTAILQ_FOREACH(rom, &roms, next) {
 973         if (rom->fw_file) {
 974             continue;
 975         }
 976         if (rom->mr) {
 977             continue;
 978         }
 979         if (rom->addr > addr) {
 980             continue;
 981         }
 982         if (rom->addr + rom->romsize < addr) {
 983             continue;
 984         }
 985         return rom;
 986     }
 987     return NULL;
 988 }
 989
 990 /*
 991  * Copies memory from registered ROMs to dest. Any memory that is contained in
 992  * a ROM between addr and addr + size is copied. Note that this can involve
 993  * multiple ROMs, which need not start at addr and need not end at addr + size.
 994  */
 995 int rom_copy(uint8_t *dest, hwaddr addr, size_t size)
 996 {
 997     hwaddr end = addr + size;
 998     uint8_t *s, *d = dest;
 999     size_t l = 0;
1000     Rom *rom;
1001
1002     QTAILQ_FOREACH(rom, &roms, next) {
1003         if (rom->fw_file) {
1004             continue;
1005         }
1006         if (rom->mr) {
1007             continue;
1008         }
1009         if (rom->addr + rom->romsize < addr) {
1010             continue;
1011         }
1012         if (rom->addr > end) {
1013             break;
1014         }
1015
1016         d = dest + (rom->addr - addr);
1017         s = rom->data;
1018         l = rom->datasize;
1019
1020         if ((d + l) > (dest + size)) {
1021             l = dest - d;
1022         }
1023
1024         if (l > 0) {
1025             memcpy(d, s, l);
1026         }
1027
1028         if (rom->romsize > rom->datasize) {
1029             /* If datasize is less than romsize, it means that we didn't
1030              * allocate all the ROM because the trailing data are only zeros.
1031              */
1032
1033             d += l;
1034             l = rom->romsize - rom->datasize;
1035
1036             if ((d + l) > (dest + size)) {
1037                 /* Rom size doesn't fit in the destination area. Adjust to avoid
1038                  * overflow.
1039                  */
1040                 l = dest - d;
1041             }
1042
1043             if (l > 0) {
1044                 memset(d, 0x0, l);
1045             }
1046         }
1047     }
1048
1049     return (d + l) - dest;
1050 }
1051
1052 void *rom_ptr(hwaddr addr)
1053 {
1054     Rom *rom;
1055
1056     rom = find_rom(addr);
1057     if (!rom || !rom->data)
1058         return NULL;
1059     return rom->data + (addr - rom->addr);
1060 }
1061
1062 void hmp_info_roms(Monitor *mon, const QDict *qdict)
1063 {
1064     Rom *rom;
1065
1066     QTAILQ_FOREACH(rom, &roms, next) {
1067         if (rom->mr) {
1068             monitor_printf(mon, "%s"
1069                            " size=0x%06zx name=\"%s\"\n",
1070                            memory_region_name(rom->mr),
1071                            rom->romsize,
1072                            rom->name);
1073         } else if (!rom->fw_file) {
1074             monitor_printf(mon, "addr=" TARGET_FMT_plx
1075                            " size=0x%06zx mem=%s name=\"%s\"\n",
1076                            rom->addr, rom->romsize,
1077                            rom->isrom ? "rom" : "ram",
1078                            rom->name);
1079         } else {
1080             monitor_printf(mon, "fw=%s/%s"
1081                            " size=0x%06zx name=\"%s\"\n",
1082                            rom->fw_dir,
1083                            rom->fw_file,
1084                            rom->romsize,
1085                            rom->name);
1086         }
1087     }
1088 }