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, [email protected].
  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 int64_t get_image_size(const char *filename)
  65 {
  66     int fd;
  67     int64_t size;
  68     fd = open(filename, O_RDONLY | O_BINARY);
  69     if (fd < 0)
  70         return -1;
  71     size = lseek(fd, 0, SEEK_END);
  72     close(fd);
  73     return size;
  74 }
  75
  76 /* return the size or -1 if error */
  77 ssize_t load_image_size(const char *filename, void *addr, size_t size)
  78 {
  79     int fd;
  80     ssize_t actsize, l = 0;
  81
  82     fd = open(filename, O_RDONLY | O_BINARY);
  83     if (fd < 0) {
  84         return -1;
  85     }
  86
  87     while ((actsize = read(fd, addr + l, size - l)) > 0) {
  88         l += actsize;
  89     }
  90
  91     close(fd);
  92
  93     return actsize < 0 ? -1 : l;
  94 }
  95
  96 /* read()-like version */
  97 ssize_t read_targphys(const char *name,
  98                       int fd, hwaddr dst_addr, size_t nbytes)
  99 {
 100     uint8_t *buf;
 101     ssize_t did;
 102
 103     buf = g_malloc(nbytes);
 104     did = read(fd, buf, nbytes);
 105     if (did > 0)
 106         rom_add_blob_fixed("read", buf, did, dst_addr);
 107     g_free(buf);
 108     return did;
 109 }
 110
 111 int load_image_targphys(const char *filename,
 112                         hwaddr addr, uint64_t max_sz)
 113 {
 114     return load_image_targphys_as(filename, addr, max_sz, NULL);
 115 }
 116
 117 /* return the size or -1 if error */
 118 int load_image_targphys_as(const char *filename,
 119                            hwaddr addr, uint64_t max_sz, AddressSpace *as)
 120 {
 121     int size;
 122
 123     size = get_image_size(filename);
 124     if (size < 0 || size > max_sz) {
 125         return -1;
 126     }
 127     if (size > 0) {
 128         if (rom_add_file_fixed_as(filename, addr, -1, as) < 0) {
 129             return -1;
 130         }
 131     }
 132     return size;
 133 }
 134
 135 int load_image_mr(const char *filename, MemoryRegion *mr)
 136 {
 137     int size;
 138
 139     if (!memory_access_is_direct(mr, false)) {
 140         /* Can only load an image into RAM or ROM */
 141         return -1;
 142     }
 143
 144     size = get_image_size(filename);
 145
 146     if (size < 0 || size > memory_region_size(mr)) {
 147         return -1;
 148     }
 149     if (size > 0) {
 150         if (rom_add_file_mr(filename, mr, -1) < 0) {
 151             return -1;
 152         }
 153     }
 154     return size;
 155 }
 156
 157 void pstrcpy_targphys(const char *name, hwaddr dest, int buf_size,
 158                       const char *source)
 159 {
 160     const char *nulp;
 161     char *ptr;
 162
 163     if (buf_size <= 0) return;
 164     nulp = memchr(source, 0, buf_size);
 165     if (nulp) {
 166         rom_add_blob_fixed(name, source, (nulp - source) + 1, dest);
 167     } else {
 168         rom_add_blob_fixed(name, source, buf_size, dest);
 169         ptr = rom_ptr(dest + buf_size - 1, sizeof(*ptr));
 170         *ptr = 0;
 171     }
 172 }
 173
 174 /* A.OUT loader */
 175
 176 struct exec
 177 {
 178   uint32_t a_info;   /* Use macros N_MAGIC, etc for access */
 179   uint32_t a_text;   /* length of text, in bytes */
 180   uint32_t a_data;   /* length of data, in bytes */
 181   uint32_t a_bss;    /* length of uninitialized data area, in bytes */
 182   uint32_t a_syms;   /* length of symbol table data in file, in bytes */
 183   uint32_t a_entry;  /* start address */
 184   uint32_t a_trsize; /* length of relocation info for text, in bytes */
 185   uint32_t a_drsize; /* length of relocation info for data, in bytes */
 186 };
 187
 188 static void bswap_ahdr(struct exec *e)
 189 {
 190     bswap32s(&e->a_info);
 191     bswap32s(&e->a_text);
 192     bswap32s(&e->a_data);
 193     bswap32s(&e->a_bss);
 194     bswap32s(&e->a_syms);
 195     bswap32s(&e->a_entry);
 196     bswap32s(&e->a_trsize);
 197     bswap32s(&e->a_drsize);
 198 }
 199
 200 #define N_MAGIC(exec) ((exec).a_info & 0xffff)
 201 #define OMAGIC 0407
 202 #define NMAGIC 0410
 203 #define ZMAGIC 0413
 204 #define QMAGIC 0314
 205 #define _N_HDROFF(x) (1024 - sizeof (struct exec))
 206 #define N_TXTOFF(x)                                                     \
 207     (N_MAGIC(x) == ZMAGIC ? _N_HDROFF((x)) + sizeof (struct exec) :     \
 208      (N_MAGIC(x) == QMAGIC ? 0 : sizeof (struct exec)))
 209 #define N_TXTADDR(x, target_page_size) (N_MAGIC(x) == QMAGIC ? target_page_size : 0)
 210 #define _N_SEGMENT_ROUND(x, target_page_size) (((x) + target_page_size - 1) & ~(target_page_size - 1))
 211
 212 #define _N_TXTENDADDR(x, target_page_size) (N_TXTADDR(x, target_page_size)+(x).a_text)
 213
 214 #define N_DATADDR(x, target_page_size) \
 215     (N_MAGIC(x)==OMAGIC? (_N_TXTENDADDR(x, target_page_size)) \
 216      : (_N_SEGMENT_ROUND (_N_TXTENDADDR(x, target_page_size), target_page_size)))
 217
 218
 219 int load_aout(const char *filename, hwaddr addr, int max_sz,
 220               int bswap_needed, hwaddr target_page_size)
 221 {
 222     int fd;
 223     ssize_t size, ret;
 224     struct exec e;
 225     uint32_t magic;
 226
 227     fd = open(filename, O_RDONLY | O_BINARY);
 228     if (fd < 0)
 229         return -1;
 230
 231     size = read(fd, &e, sizeof(e));
 232     if (size < 0)
 233         goto fail;
 234
 235     if (bswap_needed) {
 236         bswap_ahdr(&e);
 237     }
 238
 239     magic = N_MAGIC(e);
 240     switch (magic) {
 241     case ZMAGIC:
 242     case QMAGIC:
 243     case OMAGIC:
 244         if (e.a_text + e.a_data > max_sz)
 245             goto fail;
 246         lseek(fd, N_TXTOFF(e), SEEK_SET);
 247         size = read_targphys(filename, fd, addr, e.a_text + e.a_data);
 248         if (size < 0)
 249             goto fail;
 250         break;
 251     case NMAGIC:
 252         if (N_DATADDR(e, target_page_size) + e.a_data > max_sz)
 253             goto fail;
 254         lseek(fd, N_TXTOFF(e), SEEK_SET);
 255         size = read_targphys(filename, fd, addr, e.a_text);
 256         if (size < 0)
 257             goto fail;
 258         ret = read_targphys(filename, fd, addr + N_DATADDR(e, target_page_size),
 259                             e.a_data);
 260         if (ret < 0)
 261             goto fail;
 262         size += ret;
 263         break;
 264     default:
 265         goto fail;
 266     }
 267     close(fd);
 268     return size;
 269  fail:
 270     close(fd);
 271     return -1;
 272 }
 273
 274 /* ELF loader */
 275
 276 static void *load_at(int fd, off_t offset, size_t size)
 277 {
 278     void *ptr;
 279     if (lseek(fd, offset, SEEK_SET) < 0)
 280         return NULL;
 281     ptr = g_malloc(size);
 282     if (read(fd, ptr, size) != size) {
 283         g_free(ptr);
 284         return NULL;
 285     }
 286     return ptr;
 287 }
 288
 289 #ifdef ELF_CLASS
 290 #undef ELF_CLASS
 291 #endif
 292
 293 #define ELF_CLASS   ELFCLASS32
 294 #include "elf.h"
 295
 296 #define SZ              32
 297 #define elf_word        uint32_t
 298 #define elf_sword        int32_t
 299 #define bswapSZs        bswap32s
 300 #include "hw/elf_ops.h"
 301
 302 #undef elfhdr
 303 #undef elf_phdr
 304 #undef elf_shdr
 305 #undef elf_sym
 306 #undef elf_rela
 307 #undef elf_note
 308 #undef elf_word
 309 #undef elf_sword
 310 #undef bswapSZs
 311 #undef SZ
 312 #define elfhdr          elf64_hdr
 313 #define elf_phdr        elf64_phdr
 314 #define elf_note        elf64_note
 315 #define elf_shdr        elf64_shdr
 316 #define elf_sym         elf64_sym
 317 #define elf_rela        elf64_rela
 318 #define elf_word        uint64_t
 319 #define elf_sword        int64_t
 320 #define bswapSZs        bswap64s
 321 #define SZ              64
 322 #include "hw/elf_ops.h"
 323
 324 const char *load_elf_strerror(int error)
 325 {
 326     switch (error) {
 327     case 0:
 328         return "No error";
 329     case ELF_LOAD_FAILED:
 330         return "Failed to load ELF";
 331     case ELF_LOAD_NOT_ELF:
 332         return "The image is not ELF";
 333     case ELF_LOAD_WRONG_ARCH:
 334         return "The image is from incompatible architecture";
 335     case ELF_LOAD_WRONG_ENDIAN:
 336         return "The image has incorrect endianness";
 337     default:
 338         return "Unknown error";
 339     }
 340 }
 341
 342 void load_elf_hdr(const char *filename, void *hdr, bool *is64, Error **errp)
 343 {
 344     int fd;
 345     uint8_t e_ident_local[EI_NIDENT];
 346     uint8_t *e_ident;
 347     size_t hdr_size, off;
 348     bool is64l;
 349
 350     if (!hdr) {
 351         hdr = e_ident_local;
 352     }
 353     e_ident = hdr;
 354
 355     fd = open(filename, O_RDONLY | O_BINARY);
 356     if (fd < 0) {
 357         error_setg_errno(errp, errno, "Failed to open file: %s", filename);
 358         return;
 359     }
 360     if (read(fd, hdr, EI_NIDENT) != EI_NIDENT) {
 361         error_setg_errno(errp, errno, "Failed to read file: %s", filename);
 362         goto fail;
 363     }
 364     if (e_ident[0] != ELFMAG0 ||
 365         e_ident[1] != ELFMAG1 ||
 366         e_ident[2] != ELFMAG2 ||
 367         e_ident[3] != ELFMAG3) {
 368         error_setg(errp, "Bad ELF magic");
 369         goto fail;
 370     }
 371
 372     is64l = e_ident[EI_CLASS] == ELFCLASS64;
 373     hdr_size = is64l ? sizeof(Elf64_Ehdr) : sizeof(Elf32_Ehdr);
 374     if (is64) {
 375         *is64 = is64l;
 376     }
 377
 378     off = EI_NIDENT;
 379     while (hdr != e_ident_local && off < hdr_size) {
 380         size_t br = read(fd, hdr + off, hdr_size - off);
 381         switch (br) {
 382         case 0:
 383             error_setg(errp, "File too short: %s", filename);
 384             goto fail;
 385         case -1:
 386             error_setg_errno(errp, errno, "Failed to read file: %s",
 387                              filename);
 388             goto fail;
 389         }
 390         off += br;
 391     }
 392
 393 fail:
 394     close(fd);
 395 }
 396
 397 /* return < 0 if error, otherwise the number of bytes loaded in memory */
 398 int load_elf(const char *filename,
 399              uint64_t (*elf_note_fn)(void *, void *, bool),
 400              uint64_t (*translate_fn)(void *, uint64_t),
 401              void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr,
 402              uint64_t *highaddr, int big_endian, int elf_machine,
 403              int clear_lsb, int data_swab)
 404 {
 405     return load_elf_as(filename, elf_note_fn, translate_fn, translate_opaque,
 406                        pentry, lowaddr, highaddr, big_endian, elf_machine,
 407                        clear_lsb, data_swab, NULL);
 408 }
 409
 410 /* return < 0 if error, otherwise the number of bytes loaded in memory */
 411 int load_elf_as(const char *filename,
 412                 uint64_t (*elf_note_fn)(void *, void *, bool),
 413                 uint64_t (*translate_fn)(void *, uint64_t),
 414                 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr,
 415                 uint64_t *highaddr, int big_endian, int elf_machine,
 416                 int clear_lsb, int data_swab, AddressSpace *as)
 417 {
 418     return load_elf_ram(filename, elf_note_fn, translate_fn, translate_opaque,
 419                         pentry, lowaddr, highaddr, big_endian, elf_machine,
 420                         clear_lsb, data_swab, as, true);
 421 }
 422
 423 /* return < 0 if error, otherwise the number of bytes loaded in memory */
 424 int load_elf_ram(const char *filename,
 425                  uint64_t (*elf_note_fn)(void *, void *, bool),
 426                  uint64_t (*translate_fn)(void *, uint64_t),
 427                  void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr,
 428                  uint64_t *highaddr, int big_endian, int elf_machine,
 429                  int clear_lsb, int data_swab, AddressSpace *as,
 430                  bool load_rom)
 431 {
 432     return load_elf_ram_sym(filename, elf_note_fn,
 433                             translate_fn, translate_opaque,
 434                             pentry, lowaddr, highaddr, big_endian,
 435                             elf_machine, clear_lsb, data_swab, as,
 436                             load_rom, NULL);
 437 }
 438
 439 /* return < 0 if error, otherwise the number of bytes loaded in memory */
 440 int load_elf_ram_sym(const char *filename,
 441                      uint64_t (*elf_note_fn)(void *, void *, bool),
 442                      uint64_t (*translate_fn)(void *, uint64_t),
 443                      void *translate_opaque, uint64_t *pentry,
 444                      uint64_t *lowaddr, uint64_t *highaddr, int big_endian,
 445                      int elf_machine, int clear_lsb, int data_swab,
 446                      AddressSpace *as, bool load_rom, symbol_fn_t sym_cb)
 447 {
 448     int fd, data_order, target_data_order, must_swab, ret = ELF_LOAD_FAILED;
 449     uint8_t e_ident[EI_NIDENT];
 450
 451     fd = open(filename, O_RDONLY | O_BINARY);
 452     if (fd < 0) {
 453         perror(filename);
 454         return -1;
 455     }
 456     if (read(fd, e_ident, sizeof(e_ident)) != sizeof(e_ident))
 457         goto fail;
 458     if (e_ident[0] != ELFMAG0 ||
 459         e_ident[1] != ELFMAG1 ||
 460         e_ident[2] != ELFMAG2 ||
 461         e_ident[3] != ELFMAG3) {
 462         ret = ELF_LOAD_NOT_ELF;
 463         goto fail;
 464     }
 465 #ifdef HOST_WORDS_BIGENDIAN
 466     data_order = ELFDATA2MSB;
 467 #else
 468     data_order = ELFDATA2LSB;
 469 #endif
 470     must_swab = data_order != e_ident[EI_DATA];
 471     if (big_endian) {
 472         target_data_order = ELFDATA2MSB;
 473     } else {
 474         target_data_order = ELFDATA2LSB;
 475     }
 476
 477     if (target_data_order != e_ident[EI_DATA]) {
 478         ret = ELF_LOAD_WRONG_ENDIAN;
 479         goto fail;
 480     }
 481
 482     lseek(fd, 0, SEEK_SET);
 483     if (e_ident[EI_CLASS] == ELFCLASS64) {
 484         ret = load_elf64(filename, fd, elf_note_fn,
 485                          translate_fn, translate_opaque, must_swab,
 486                          pentry, lowaddr, highaddr, elf_machine, clear_lsb,
 487                          data_swab, as, load_rom, sym_cb);
 488     } else {
 489         ret = load_elf32(filename, fd, elf_note_fn,
 490                          translate_fn, translate_opaque, must_swab,
 491                          pentry, lowaddr, highaddr, elf_machine, clear_lsb,
 492                          data_swab, as, load_rom, sym_cb);
 493     }
 494
 495  fail:
 496     close(fd);
 497     return ret;
 498 }
 499
 500 static void bswap_uboot_header(uboot_image_header_t *hdr)
 501 {
 502 #ifndef HOST_WORDS_BIGENDIAN
 503     bswap32s(&hdr->ih_magic);
 504     bswap32s(&hdr->ih_hcrc);
 505     bswap32s(&hdr->ih_time);
 506     bswap32s(&hdr->ih_size);
 507     bswap32s(&hdr->ih_load);
 508     bswap32s(&hdr->ih_ep);
 509     bswap32s(&hdr->ih_dcrc);
 510 #endif
 511 }
 512
 513
 514 #define ZALLOC_ALIGNMENT        16
 515
 516 static void *zalloc(void *x, unsigned items, unsigned size)
 517 {
 518     void *p;
 519
 520     size *= items;
 521     size = (size + ZALLOC_ALIGNMENT - 1) & ~(ZALLOC_ALIGNMENT - 1);
 522
 523     p = g_malloc(size);
 524
 525     return (p);
 526 }
 527
 528 static void zfree(void *x, void *addr)
 529 {
 530     g_free(addr);
 531 }
 532
 533
 534 #define HEAD_CRC        2
 535 #define EXTRA_FIELD     4
 536 #define ORIG_NAME       8
 537 #define COMMENT         0x10
 538 #define RESERVED        0xe0
 539
 540 #define DEFLATED        8
 541
 542 ssize_t gunzip(void *dst, size_t dstlen, uint8_t *src, size_t srclen)
 543 {
 544     z_stream s;
 545     ssize_t dstbytes;
 546     int r, i, flags;
 547
 548     /* skip header */
 549     i = 10;
 550     flags = src[3];
 551     if (src[2] != DEFLATED || (flags & RESERVED) != 0) {
 552         puts ("Error: Bad gzipped data\n");
 553         return -1;
 554     }
 555     if ((flags & EXTRA_FIELD) != 0)
 556         i = 12 + src[10] + (src[11] << 8);
 557     if ((flags & ORIG_NAME) != 0)
 558         while (src[i++] != 0)
 559             ;
 560     if ((flags & COMMENT) != 0)
 561         while (src[i++] != 0)
 562             ;
 563     if ((flags & HEAD_CRC) != 0)
 564         i += 2;
 565     if (i >= srclen) {
 566         puts ("Error: gunzip out of data in header\n");
 567         return -1;
 568     }
 569
 570     s.zalloc = zalloc;
 571     s.zfree = zfree;
 572
 573     r = inflateInit2(&s, -MAX_WBITS);
 574     if (r != Z_OK) {
 575         printf ("Error: inflateInit2() returned %d\n", r);
 576         return (-1);
 577     }
 578     s.next_in = src + i;
 579     s.avail_in = srclen - i;
 580     s.next_out = dst;
 581     s.avail_out = dstlen;
 582     r = inflate(&s, Z_FINISH);
 583     if (r != Z_OK && r != Z_STREAM_END) {
 584         printf ("Error: inflate() returned %d\n", r);
 585         return -1;
 586     }
 587     dstbytes = s.next_out - (unsigned char *) dst;
 588     inflateEnd(&s);
 589
 590     return dstbytes;
 591 }
 592
 593 /* Load a U-Boot image.  */
 594 static int load_uboot_image(const char *filename, hwaddr *ep, hwaddr *loadaddr,
 595                             int *is_linux, uint8_t image_type,
 596                             uint64_t (*translate_fn)(void *, uint64_t),
 597                             void *translate_opaque, AddressSpace *as)
 598 {
 599     int fd;
 600     int size;
 601     hwaddr address;
 602     uboot_image_header_t h;
 603     uboot_image_header_t *hdr = &h;
 604     uint8_t *data = NULL;
 605     int ret = -1;
 606     int do_uncompress = 0;
 607
 608     fd = open(filename, O_RDONLY | O_BINARY);
 609     if (fd < 0)
 610         return -1;
 611
 612     size = read(fd, hdr, sizeof(uboot_image_header_t));
 613     if (size < sizeof(uboot_image_header_t)) {
 614         goto out;
 615     }
 616
 617     bswap_uboot_header(hdr);
 618
 619     if (hdr->ih_magic != IH_MAGIC)
 620         goto out;
 621
 622     if (hdr->ih_type != image_type) {
 623         if (!(image_type == IH_TYPE_KERNEL &&
 624             hdr->ih_type == IH_TYPE_KERNEL_NOLOAD)) {
 625             fprintf(stderr, "Wrong image type %d, expected %d\n", hdr->ih_type,
 626                     image_type);
 627             goto out;
 628         }
 629     }
 630
 631     /* TODO: Implement other image types.  */
 632     switch (hdr->ih_type) {
 633     case IH_TYPE_KERNEL_NOLOAD:
 634         if (!loadaddr || *loadaddr == LOAD_UIMAGE_LOADADDR_INVALID) {
 635             fprintf(stderr, "this image format (kernel_noload) cannot be "
 636                     "loaded on this machine type");
 637             goto out;
 638         }
 639
 640         hdr->ih_load = *loadaddr + sizeof(*hdr);
 641         hdr->ih_ep += hdr->ih_load;
 642         /* fall through */
 643     case IH_TYPE_KERNEL:
 644         address = hdr->ih_load;
 645         if (translate_fn) {
 646             address = translate_fn(translate_opaque, address);
 647         }
 648         if (loadaddr) {
 649             *loadaddr = hdr->ih_load;
 650         }
 651
 652         switch (hdr->ih_comp) {
 653         case IH_COMP_NONE:
 654             break;
 655         case IH_COMP_GZIP:
 656             do_uncompress = 1;
 657             break;
 658         default:
 659             fprintf(stderr,
 660                     "Unable to load u-boot images with compression type %d\n",
 661                     hdr->ih_comp);
 662             goto out;
 663         }
 664
 665         if (ep) {
 666             *ep = hdr->ih_ep;
 667         }
 668
 669         /* TODO: Check CPU type.  */
 670         if (is_linux) {
 671             if (hdr->ih_os == IH_OS_LINUX) {
 672                 *is_linux = 1;
 673             } else {
 674                 *is_linux = 0;
 675             }
 676         }
 677
 678         break;
 679     case IH_TYPE_RAMDISK:
 680         address = *loadaddr;
 681         break;
 682     default:
 683         fprintf(stderr, "Unsupported u-boot image type %d\n", hdr->ih_type);
 684         goto out;
 685     }
 686
 687     data = g_malloc(hdr->ih_size);
 688
 689     if (read(fd, data, hdr->ih_size) != hdr->ih_size) {
 690         fprintf(stderr, "Error reading file\n");
 691         goto out;
 692     }
 693
 694     if (do_uncompress) {
 695         uint8_t *compressed_data;
 696         size_t max_bytes;
 697         ssize_t bytes;
 698
 699         compressed_data = data;
 700         max_bytes = UBOOT_MAX_GUNZIP_BYTES;
 701         data = g_malloc(max_bytes);
 702
 703         bytes = gunzip(data, max_bytes, compressed_data, hdr->ih_size);
 704         g_free(compressed_data);
 705         if (bytes < 0) {
 706             fprintf(stderr, "Unable to decompress gzipped image!\n");
 707             goto out;
 708         }
 709         hdr->ih_size = bytes;
 710     }
 711
 712     rom_add_blob_fixed_as(filename, data, hdr->ih_size, address, as);
 713
 714     ret = hdr->ih_size;
 715
 716 out:
 717     g_free(data);
 718     close(fd);
 719     return ret;
 720 }
 721
 722 int load_uimage(const char *filename, hwaddr *ep, hwaddr *loadaddr,
 723                 int *is_linux,
 724                 uint64_t (*translate_fn)(void *, uint64_t),
 725                 void *translate_opaque)
 726 {
 727     return load_uboot_image(filename, ep, loadaddr, is_linux, IH_TYPE_KERNEL,
 728                             translate_fn, translate_opaque, NULL);
 729 }
 730
 731 int load_uimage_as(const char *filename, hwaddr *ep, hwaddr *loadaddr,
 732                    int *is_linux,
 733                    uint64_t (*translate_fn)(void *, uint64_t),
 734                    void *translate_opaque, AddressSpace *as)
 735 {
 736     return load_uboot_image(filename, ep, loadaddr, is_linux, IH_TYPE_KERNEL,
 737                             translate_fn, translate_opaque, as);
 738 }
 739
 740 /* Load a ramdisk.  */
 741 int load_ramdisk(const char *filename, hwaddr addr, uint64_t max_sz)
 742 {
 743     return load_ramdisk_as(filename, addr, max_sz, NULL);
 744 }
 745
 746 int load_ramdisk_as(const char *filename, hwaddr addr, uint64_t max_sz,
 747                     AddressSpace *as)
 748 {
 749     return load_uboot_image(filename, NULL, &addr, NULL, IH_TYPE_RAMDISK,
 750                             NULL, NULL, as);
 751 }
 752
 753 /* Load a gzip-compressed kernel to a dynamically allocated buffer. */
 754 int load_image_gzipped_buffer(const char *filename, uint64_t max_sz,
 755                               uint8_t **buffer)
 756 {
 757     uint8_t *compressed_data = NULL;
 758     uint8_t *data = NULL;
 759     gsize len;
 760     ssize_t bytes;
 761     int ret = -1;
 762
 763     if (!g_file_get_contents(filename, (char **) &compressed_data, &len,
 764                              NULL)) {
 765         goto out;
 766     }
 767
 768     /* Is it a gzip-compressed file? */
 769     if (len < 2 ||
 770         compressed_data[0] != 0x1f ||
 771         compressed_data[1] != 0x8b) {
 772         goto out;
 773     }
 774
 775     if (max_sz > LOAD_IMAGE_MAX_GUNZIP_BYTES) {
 776         max_sz = LOAD_IMAGE_MAX_GUNZIP_BYTES;
 777     }
 778
 779     data = g_malloc(max_sz);
 780     bytes = gunzip(data, max_sz, compressed_data, len);
 781     if (bytes < 0) {
 782         fprintf(stderr, "%s: unable to decompress gzipped kernel file\n",
 783                 filename);
 784         goto out;
 785     }
 786
 787     /* trim to actual size and return to caller */
 788     *buffer = g_realloc(data, bytes);
 789     ret = bytes;
 790     /* ownership has been transferred to caller */
 791     data = NULL;
 792
 793  out:
 794     g_free(compressed_data);
 795     g_free(data);
 796     return ret;
 797 }
 798
 799 /* Load a gzip-compressed kernel. */
 800 int load_image_gzipped(const char *filename, hwaddr addr, uint64_t max_sz)
 801 {
 802     int bytes;
 803     uint8_t *data;
 804
 805     bytes = load_image_gzipped_buffer(filename, max_sz, &data);
 806     if (bytes != -1) {
 807         rom_add_blob_fixed(filename, data, bytes, addr);
 808         g_free(data);
 809     }
 810     return bytes;
 811 }
 812
 813 /*
 814  * Functions for reboot-persistent memory regions.
 815  *  - used for vga bios and option roms.
 816  *  - also linux kernel (-kernel / -initrd).
 817  */
 818
 819 typedef struct Rom Rom;
 820
 821 struct Rom {
 822     char *name;
 823     char *path;
 824
 825     /* datasize is the amount of memory allocated in "data". If datasize is less
 826      * than romsize, it means that the area from datasize to romsize is filled
 827      * with zeros.
 828      */
 829     size_t romsize;
 830     size_t datasize;
 831
 832     uint8_t *data;
 833     MemoryRegion *mr;
 834     AddressSpace *as;
 835     int isrom;
 836     char *fw_dir;
 837     char *fw_file;
 838
 839     bool committed;
 840
 841     hwaddr addr;
 842     QTAILQ_ENTRY(Rom) next;
 843 };
 844
 845 static FWCfgState *fw_cfg;
 846 static QTAILQ_HEAD(, Rom) roms = QTAILQ_HEAD_INITIALIZER(roms);
 847
 848 /* rom->data must be heap-allocated (do not use with rom_add_elf_program()) */
 849 static void rom_free(Rom *rom)
 850 {
 851     g_free(rom->data);
 852     g_free(rom->path);
 853     g_free(rom->name);
 854     g_free(rom->fw_dir);
 855     g_free(rom->fw_file);
 856     g_free(rom);
 857 }
 858
 859 static inline bool rom_order_compare(Rom *rom, Rom *item)
 860 {
 861     return ((uintptr_t)(void *)rom->as > (uintptr_t)(void *)item->as) ||
 862            (rom->as == item->as && rom->addr >= item->addr);
 863 }
 864
 865 static void rom_insert(Rom *rom)
 866 {
 867     Rom *item;
 868
 869     if (roms_loaded) {
 870         hw_error ("ROM images must be loaded at startup\n");
 871     }
 872
 873     /* The user didn't specify an address space, this is the default */
 874     if (!rom->as) {
 875         rom->as = &address_space_memory;
 876     }
 877
 878     rom->committed = false;
 879
 880     /* List is ordered by load address in the same address space */
 881     QTAILQ_FOREACH(item, &roms, next) {
 882         if (rom_order_compare(rom, item)) {
 883             continue;
 884         }
 885         QTAILQ_INSERT_BEFORE(item, rom, next);
 886         return;
 887     }
 888     QTAILQ_INSERT_TAIL(&roms, rom, next);
 889 }
 890
 891 static void fw_cfg_resized(const char *id, uint64_t length, void *host)
 892 {
 893     if (fw_cfg) {
 894         fw_cfg_modify_file(fw_cfg, id + strlen("/rom@"), host, length);
 895     }
 896 }
 897
 898 static void *rom_set_mr(Rom *rom, Object *owner, const char *name, bool ro)
 899 {
 900     void *data;
 901
 902     rom->mr = g_malloc(sizeof(*rom->mr));
 903     memory_region_init_resizeable_ram(rom->mr, owner, name,
 904                                       rom->datasize, rom->romsize,
 905                                       fw_cfg_resized,
 906                                       &error_fatal);
 907     memory_region_set_readonly(rom->mr, ro);
 908     vmstate_register_ram_global(rom->mr);
 909
 910     data = memory_region_get_ram_ptr(rom->mr);
 911     memcpy(data, rom->data, rom->datasize);
 912
 913     return data;
 914 }
 915
 916 int rom_add_file(const char *file, const char *fw_dir,
 917                  hwaddr addr, int32_t bootindex,
 918                  bool option_rom, MemoryRegion *mr,
 919                  AddressSpace *as)
 920 {
 921     MachineClass *mc = MACHINE_GET_CLASS(qdev_get_machine());
 922     Rom *rom;
 923     int rc, fd = -1;
 924     char devpath[100];
 925
 926     if (as && mr) {
 927         fprintf(stderr, "Specifying an Address Space and Memory Region is " \
 928                 "not valid when loading a rom\n");
 929         /* We haven't allocated anything so we don't need any cleanup */
 930         return -1;
 931     }
 932
 933     rom = g_malloc0(sizeof(*rom));
 934     rom->name = g_strdup(file);
 935     rom->path = qemu_find_file(QEMU_FILE_TYPE_BIOS, rom->name);
 936     rom->as = as;
 937     if (rom->path == NULL) {
 938         rom->path = g_strdup(file);
 939     }
 940
 941     fd = open(rom->path, O_RDONLY | O_BINARY);
 942     if (fd == -1) {
 943         fprintf(stderr, "Could not open option rom '%s': %s\n",
 944                 rom->path, strerror(errno));
 945         goto err;
 946     }
 947
 948     if (fw_dir) {
 949         rom->fw_dir  = g_strdup(fw_dir);
 950         rom->fw_file = g_strdup(file);
 951     }
 952     rom->addr     = addr;
 953     rom->romsize  = lseek(fd, 0, SEEK_END);
 954     if (rom->romsize == -1) {
 955         fprintf(stderr, "rom: file %-20s: get size error: %s\n",
 956                 rom->name, strerror(errno));
 957         goto err;
 958     }
 959
 960     rom->datasize = rom->romsize;
 961     rom->data     = g_malloc0(rom->datasize);
 962     lseek(fd, 0, SEEK_SET);
 963     rc = read(fd, rom->data, rom->datasize);
 964     if (rc != rom->datasize) {
 965         fprintf(stderr, "rom: file %-20s: read error: rc=%d (expected %zd)\n",
 966                 rom->name, rc, rom->datasize);
 967         goto err;
 968     }
 969     close(fd);
 970     rom_insert(rom);
 971     if (rom->fw_file && fw_cfg) {
 972         const char *basename;
 973         char fw_file_name[FW_CFG_MAX_FILE_PATH];
 974         void *data;
 975
 976         basename = strrchr(rom->fw_file, '/');
 977         if (basename) {
 978             basename++;
 979         } else {
 980             basename = rom->fw_file;
 981         }
 982         snprintf(fw_file_name, sizeof(fw_file_name), "%s/%s", rom->fw_dir,
 983                  basename);
 984         snprintf(devpath, sizeof(devpath), "/rom@%s", fw_file_name);
 985
 986         if ((!option_rom || mc->option_rom_has_mr) && mc->rom_file_has_mr) {
 987             data = rom_set_mr(rom, OBJECT(fw_cfg), devpath, true);
 988         } else {
 989             data = rom->data;
 990         }
 991
 992         fw_cfg_add_file(fw_cfg, fw_file_name, data, rom->romsize);
 993     } else {
 994         if (mr) {
 995             rom->mr = mr;
 996             snprintf(devpath, sizeof(devpath), "/rom@%s", file);
 997         } else {
 998             snprintf(devpath, sizeof(devpath), "/rom@" TARGET_FMT_plx, addr);
 999         }
1000     }
1001
1002     add_boot_device_path(bootindex, NULL, devpath);
1003     return 0;
1004
1005 err:
1006     if (fd != -1)
1007         close(fd);
1008
1009     rom_free(rom);
1010     return -1;
1011 }
1012
1013 MemoryRegion *rom_add_blob(const char *name, const void *blob, size_t len,
1014                    size_t max_len, hwaddr addr, const char *fw_file_name,
1015                    FWCfgCallback fw_callback, void *callback_opaque,
1016                    AddressSpace *as, bool read_only)
1017 {
1018     MachineClass *mc = MACHINE_GET_CLASS(qdev_get_machine());
1019     Rom *rom;
1020     MemoryRegion *mr = NULL;
1021
1022     rom           = g_malloc0(sizeof(*rom));
1023     rom->name     = g_strdup(name);
1024     rom->as       = as;
1025     rom->addr     = addr;
1026     rom->romsize  = max_len ? max_len : len;
1027     rom->datasize = len;
1028     rom->data     = g_malloc0(rom->datasize);
1029     memcpy(rom->data, blob, len);
1030     rom_insert(rom);
1031     if (fw_file_name && fw_cfg) {
1032         char devpath[100];
1033         void *data;
1034
1035         if (read_only) {
1036             snprintf(devpath, sizeof(devpath), "/rom@%s", fw_file_name);
1037         } else {
1038             snprintf(devpath, sizeof(devpath), "/ram@%s", fw_file_name);
1039         }
1040
1041         if (mc->rom_file_has_mr) {
1042             data = rom_set_mr(rom, OBJECT(fw_cfg), devpath, read_only);
1043             mr = rom->mr;
1044         } else {
1045             data = rom->data;
1046         }
1047
1048         fw_cfg_add_file_callback(fw_cfg, fw_file_name,
1049                                  fw_callback, NULL, callback_opaque,
1050                                  data, rom->datasize, read_only);
1051     }
1052     return mr;
1053 }
1054
1055 /* This function is specific for elf program because we don't need to allocate
1056  * all the rom. We just allocate the first part and the rest is just zeros. This
1057  * is why romsize and datasize are different. Also, this function seize the
1058  * memory ownership of "data", so we don't have to allocate and copy the buffer.
1059  */
1060 int rom_add_elf_program(const char *name, void *data, size_t datasize,
1061                         size_t romsize, hwaddr addr, AddressSpace *as)
1062 {
1063     Rom *rom;
1064
1065     rom           = g_malloc0(sizeof(*rom));
1066     rom->name     = g_strdup(name);
1067     rom->addr     = addr;
1068     rom->datasize = datasize;
1069     rom->romsize  = romsize;
1070     rom->data     = data;
1071     rom->as       = as;
1072     rom_insert(rom);
1073     return 0;
1074 }
1075
1076 int rom_add_vga(const char *file)
1077 {
1078     return rom_add_file(file, "vgaroms", 0, -1, true, NULL, NULL);
1079 }
1080
1081 int rom_add_option(const char *file, int32_t bootindex)
1082 {
1083     return rom_add_file(file, "genroms", 0, bootindex, true, NULL, NULL);
1084 }
1085
1086 static void rom_reset(void *unused)
1087 {
1088     Rom *rom;
1089
1090     QTAILQ_FOREACH(rom, &roms, next) {
1091         if (rom->fw_file) {
1092             continue;
1093         }
1094         if (rom->data == NULL) {
1095             continue;
1096         }
1097         if (rom->mr) {
1098             void *host = memory_region_get_ram_ptr(rom->mr);
1099             memcpy(host, rom->data, rom->datasize);
1100         } else {
1101             address_space_write_rom(rom->as, rom->addr, MEMTXATTRS_UNSPECIFIED,
1102                                     rom->data, rom->datasize);
1103         }
1104         if (rom->isrom) {
1105             /* rom needs to be written only once */
1106             g_free(rom->data);
1107             rom->data = NULL;
1108         }
1109         /*
1110          * The rom loader is really on the same level as firmware in the guest
1111          * shadowing a ROM into RAM. Such a shadowing mechanism needs to ensure
1112          * that the instruction cache for that new region is clear, so that the
1113          * CPU definitely fetches its instructions from the just written data.
1114          */
1115         cpu_flush_icache_range(rom->addr, rom->datasize);
1116     }
1117 }
1118
1119 int rom_check_and_register_reset(void)
1120 {
1121     hwaddr addr = 0;
1122     MemoryRegionSection section;
1123     Rom *rom;
1124     AddressSpace *as = NULL;
1125
1126     QTAILQ_FOREACH(rom, &roms, next) {
1127         if (rom->fw_file) {
1128             continue;
1129         }
1130         if (!rom->mr) {
1131             if ((addr > rom->addr) && (as == rom->as)) {
1132                 fprintf(stderr, "rom: requested regions overlap "
1133                         "(rom %s. free=0x" TARGET_FMT_plx
1134                         ", addr=0x" TARGET_FMT_plx ")\n",
1135                         rom->name, addr, rom->addr);
1136                 return -1;
1137             }
1138             addr  = rom->addr;
1139             addr += rom->romsize;
1140             as = rom->as;
1141         }
1142         section = memory_region_find(rom->mr ? rom->mr : get_system_memory(),
1143                                      rom->addr, 1);
1144         rom->isrom = int128_nz(section.size) && memory_region_is_rom(section.mr);
1145         memory_region_unref(section.mr);
1146     }
1147     qemu_register_reset(rom_reset, NULL);
1148     roms_loaded = 1;
1149     return 0;
1150 }
1151
1152 void rom_set_fw(FWCfgState *f)
1153 {
1154     fw_cfg = f;
1155 }
1156
1157 void rom_set_order_override(int order)
1158 {
1159     if (!fw_cfg)
1160         return;
1161     fw_cfg_set_order_override(fw_cfg, order);
1162 }
1163
1164 void rom_reset_order_override(void)
1165 {
1166     if (!fw_cfg)
1167         return;
1168     fw_cfg_reset_order_override(fw_cfg);
1169 }
1170
1171 void rom_transaction_begin(void)
1172 {
1173     Rom *rom;
1174
1175     /* Ignore ROMs added without the transaction API */
1176     QTAILQ_FOREACH(rom, &roms, next) {
1177         rom->committed = true;
1178     }
1179 }
1180
1181 void rom_transaction_end(bool commit)
1182 {
1183     Rom *rom;
1184     Rom *tmp;
1185
1186     QTAILQ_FOREACH_SAFE(rom, &roms, next, tmp) {
1187         if (rom->committed) {
1188             continue;
1189         }
1190         if (commit) {
1191             rom->committed = true;
1192         } else {
1193             QTAILQ_REMOVE(&roms, rom, next);
1194             rom_free(rom);
1195         }
1196     }
1197 }
1198
1199 static Rom *find_rom(hwaddr addr, size_t size)
1200 {
1201     Rom *rom;
1202
1203     QTAILQ_FOREACH(rom, &roms, next) {
1204         if (rom->fw_file) {
1205             continue;
1206         }
1207         if (rom->mr) {
1208             continue;
1209         }
1210         if (rom->addr > addr) {
1211             continue;
1212         }
1213         if (rom->addr + rom->romsize < addr + size) {
1214             continue;
1215         }
1216         return rom;
1217     }
1218     return NULL;
1219 }
1220
1221 /*
1222  * Copies memory from registered ROMs to dest. Any memory that is contained in
1223  * a ROM between addr and addr + size is copied. Note that this can involve
1224  * multiple ROMs, which need not start at addr and need not end at addr + size.
1225  */
1226 int rom_copy(uint8_t *dest, hwaddr addr, size_t size)
1227 {
1228     hwaddr end = addr + size;
1229     uint8_t *s, *d = dest;
1230     size_t l = 0;
1231     Rom *rom;
1232
1233     QTAILQ_FOREACH(rom, &roms, next) {
1234         if (rom->fw_file) {
1235             continue;
1236         }
1237         if (rom->mr) {
1238             continue;
1239         }
1240         if (rom->addr + rom->romsize < addr) {
1241             continue;
1242         }
1243         if (rom->addr > end) {
1244             break;
1245         }
1246
1247         d = dest + (rom->addr - addr);
1248         s = rom->data;
1249         l = rom->datasize;
1250
1251         if ((d + l) > (dest + size)) {
1252             l = dest - d;
1253         }
1254
1255         if (l > 0) {
1256             memcpy(d, s, l);
1257         }
1258
1259         if (rom->romsize > rom->datasize) {
1260             /* If datasize is less than romsize, it means that we didn't
1261              * allocate all the ROM because the trailing data are only zeros.
1262              */
1263
1264             d += l;
1265             l = rom->romsize - rom->datasize;
1266
1267             if ((d + l) > (dest + size)) {
1268                 /* Rom size doesn't fit in the destination area. Adjust to avoid
1269                  * overflow.
1270                  */
1271                 l = dest - d;
1272             }
1273
1274             if (l > 0) {
1275                 memset(d, 0x0, l);
1276             }
1277         }
1278     }
1279
1280     return (d + l) - dest;
1281 }
1282
1283 void *rom_ptr(hwaddr addr, size_t size)
1284 {
1285     Rom *rom;
1286
1287     rom = find_rom(addr, size);
1288     if (!rom || !rom->data)
1289         return NULL;
1290     return rom->data + (addr - rom->addr);
1291 }
1292
1293 void hmp_info_roms(Monitor *mon, const QDict *qdict)
1294 {
1295     Rom *rom;
1296
1297     QTAILQ_FOREACH(rom, &roms, next) {
1298         if (rom->mr) {
1299             monitor_printf(mon, "%s"
1300                            " size=0x%06zx name=\"%s\"\n",
1301                            memory_region_name(rom->mr),
1302                            rom->romsize,
1303                            rom->name);
1304         } else if (!rom->fw_file) {
1305             monitor_printf(mon, "addr=" TARGET_FMT_plx
1306                            " size=0x%06zx mem=%s name=\"%s\"\n",
1307                            rom->addr, rom->romsize,
1308                            rom->isrom ? "rom" : "ram",
1309                            rom->name);
1310         } else {
1311             monitor_printf(mon, "fw=%s/%s"
1312                            " size=0x%06zx name=\"%s\"\n",
1313                            rom->fw_dir,
1314                            rom->fw_file,
1315                            rom->romsize,
1316                            rom->name);
1317         }
1318     }
1319 }
1320
1321 typedef enum HexRecord HexRecord;
1322 enum HexRecord {
1323     DATA_RECORD = 0,
1324     EOF_RECORD,
1325     EXT_SEG_ADDR_RECORD,
1326     START_SEG_ADDR_RECORD,
1327     EXT_LINEAR_ADDR_RECORD,
1328     START_LINEAR_ADDR_RECORD,
1329 };
1330
1331 /* Each record contains a 16-bit address which is combined with the upper 16
1332  * bits of the implicit "next address" to form a 32-bit address.
1333  */
1334 #define NEXT_ADDR_MASK 0xffff0000
1335
1336 #define DATA_FIELD_MAX_LEN 0xff
1337 #define LEN_EXCEPT_DATA 0x5
1338 /* 0x5 = sizeof(byte_count) + sizeof(address) + sizeof(record_type) +
1339  *       sizeof(checksum) */
1340 typedef struct {
1341     uint8_t byte_count;
1342     uint16_t address;
1343     uint8_t record_type;
1344     uint8_t data[DATA_FIELD_MAX_LEN];
1345     uint8_t checksum;
1346 } HexLine;
1347
1348 /* return 0 or -1 if error */
1349 static bool parse_record(HexLine *line, uint8_t *our_checksum, const uint8_t c,
1350                          uint32_t *index, const bool in_process)
1351 {
1352     /* +-------+---------------+-------+---------------------+--------+
1353      * | byte  |               |record |                     |        |
1354      * | count |    address    | type  |        data         |checksum|
1355      * +-------+---------------+-------+---------------------+--------+
1356      * ^       ^               ^       ^                     ^        ^
1357      * |1 byte |    2 bytes    |1 byte |     0-255 bytes     | 1 byte |
1358      */
1359     uint8_t value = 0;
1360     uint32_t idx = *index;
1361     /* ignore space */
1362     if (g_ascii_isspace(c)) {
1363         return true;
1364     }
1365     if (!g_ascii_isxdigit(c) || !in_process) {
1366         return false;
1367     }
1368     value = g_ascii_xdigit_value(c);
1369     value = (idx & 0x1) ? (value & 0xf) : (value << 4);
1370     if (idx < 2) {
1371         line->byte_count |= value;
1372     } else if (2 <= idx && idx < 6) {
1373         line->address <<= 4;
1374         line->address += g_ascii_xdigit_value(c);
1375     } else if (6 <= idx && idx < 8) {
1376         line->record_type |= value;
1377     } else if (8 <= idx && idx < 8 + 2 * line->byte_count) {
1378         line->data[(idx - 8) >> 1] |= value;
1379     } else if (8 + 2 * line->byte_count <= idx &&
1380                idx < 10 + 2 * line->byte_count) {
1381         line->checksum |= value;
1382     } else {
1383         return false;
1384     }
1385     *our_checksum += value;
1386     ++(*index);
1387     return true;
1388 }
1389
1390 typedef struct {
1391     const char *filename;
1392     HexLine line;
1393     uint8_t *bin_buf;
1394     hwaddr *start_addr;
1395     int total_size;
1396     uint32_t next_address_to_write;
1397     uint32_t current_address;
1398     uint32_t current_rom_index;
1399     uint32_t rom_start_address;
1400     AddressSpace *as;
1401 } HexParser;
1402
1403 /* return size or -1 if error */
1404 static int handle_record_type(HexParser *parser)
1405 {
1406     HexLine *line = &(parser->line);
1407     switch (line->record_type) {
1408     case DATA_RECORD:
1409         parser->current_address =
1410             (parser->next_address_to_write & NEXT_ADDR_MASK) | line->address;
1411         /* verify this is a contiguous block of memory */
1412         if (parser->current_address != parser->next_address_to_write) {
1413             if (parser->current_rom_index != 0) {
1414                 rom_add_blob_fixed_as(parser->filename, parser->bin_buf,
1415                                       parser->current_rom_index,
1416                                       parser->rom_start_address, parser->as);
1417             }
1418             parser->rom_start_address = parser->current_address;
1419             parser->current_rom_index = 0;
1420         }
1421
1422         /* copy from line buffer to output bin_buf */
1423         memcpy(parser->bin_buf + parser->current_rom_index, line->data,
1424                line->byte_count);
1425         parser->current_rom_index += line->byte_count;
1426         parser->total_size += line->byte_count;
1427         /* save next address to write */
1428         parser->next_address_to_write =
1429             parser->current_address + line->byte_count;
1430         break;
1431
1432     case EOF_RECORD:
1433         if (parser->current_rom_index != 0) {
1434             rom_add_blob_fixed_as(parser->filename, parser->bin_buf,
1435                                   parser->current_rom_index,
1436                                   parser->rom_start_address, parser->as);
1437         }
1438         return parser->total_size;
1439     case EXT_SEG_ADDR_RECORD:
1440     case EXT_LINEAR_ADDR_RECORD:
1441         if (line->byte_count != 2 && line->address != 0) {
1442             return -1;
1443         }
1444
1445         if (parser->current_rom_index != 0) {
1446             rom_add_blob_fixed_as(parser->filename, parser->bin_buf,
1447                                   parser->current_rom_index,
1448                                   parser->rom_start_address, parser->as);
1449         }
1450
1451         /* save next address to write,
1452          * in case of non-contiguous block of memory */
1453         parser->next_address_to_write = (line->data[0] << 12) |
1454                                         (line->data[1] << 4);
1455         if (line->record_type == EXT_LINEAR_ADDR_RECORD) {
1456             parser->next_address_to_write <<= 12;
1457         }
1458
1459         parser->rom_start_address = parser->next_address_to_write;
1460         parser->current_rom_index = 0;
1461         break;
1462
1463     case START_SEG_ADDR_RECORD:
1464         if (line->byte_count != 4 && line->address != 0) {
1465             return -1;
1466         }
1467
1468         /* x86 16-bit CS:IP segmented addressing */
1469         *(parser->start_addr) = (((line->data[0] << 8) | line->data[1]) << 4) +
1470                                 ((line->data[2] << 8) | line->data[3]);
1471         break;
1472
1473     case START_LINEAR_ADDR_RECORD:
1474         if (line->byte_count != 4 && line->address != 0) {
1475             return -1;
1476         }
1477
1478         *(parser->start_addr) = ldl_be_p(line->data);
1479         break;
1480
1481     default:
1482         return -1;
1483     }
1484
1485     return parser->total_size;
1486 }
1487
1488 /* return size or -1 if error */
1489 static int parse_hex_blob(const char *filename, hwaddr *addr, uint8_t *hex_blob,
1490                           size_t hex_blob_size, AddressSpace *as)
1491 {
1492     bool in_process = false; /* avoid re-enter and
1493                               * check whether record begin with ':' */
1494     uint8_t *end = hex_blob + hex_blob_size;
1495     uint8_t our_checksum = 0;
1496     uint32_t record_index = 0;
1497     HexParser parser = {
1498         .filename = filename,
1499         .bin_buf = g_malloc(hex_blob_size),
1500         .start_addr = addr,
1501         .as = as,
1502     };
1503
1504     rom_transaction_begin();
1505
1506     for (; hex_blob < end; ++hex_blob) {
1507         switch (*hex_blob) {
1508         case '\r':
1509         case '\n':
1510             if (!in_process) {
1511                 break;
1512             }
1513
1514             in_process = false;
1515             if ((LEN_EXCEPT_DATA + parser.line.byte_count) * 2 !=
1516                     record_index ||
1517                 our_checksum != 0) {
1518                 parser.total_size = -1;
1519                 goto out;
1520             }
1521
1522             if (handle_record_type(&parser) == -1) {
1523                 parser.total_size = -1;
1524                 goto out;
1525             }
1526             break;
1527
1528         /* start of a new record. */
1529         case ':':
1530             memset(&parser.line, 0, sizeof(HexLine));
1531             in_process = true;
1532             record_index = 0;
1533             break;
1534
1535         /* decoding lines */
1536         default:
1537             if (!parse_record(&parser.line, &our_checksum, *hex_blob,
1538                               &record_index, in_process)) {
1539                 parser.total_size = -1;
1540                 goto out;
1541             }
1542             break;
1543         }
1544     }
1545
1546 out:
1547     g_free(parser.bin_buf);
1548     rom_transaction_end(parser.total_size != -1);
1549     return parser.total_size;
1550 }
1551
1552 /* return size or -1 if error */
1553 int load_targphys_hex_as(const char *filename, hwaddr *entry, AddressSpace *as)
1554 {
1555     gsize hex_blob_size;
1556     gchar *hex_blob;
1557     int total_size = 0;
1558
1559     if (!g_file_get_contents(filename, &hex_blob, &hex_blob_size, NULL)) {
1560         return -1;
1561     }
1562
1563     total_size = parse_hex_blob(filename, entry, (uint8_t *)hex_blob,
1564                                 hex_blob_size, as);
1565
1566     g_free(hex_blob);
1567     return total_size;
1568 }