bfd/ppcboot.c

   1 /* BFD back-end for PPCbug boot records.
   2    Copyright 1996, 1997, 1998, 1999, 2000, 2001
   3    Free Software Foundation, Inc.
   4    Written by Michael Meissner, Cygnus Support, <meissner@cygnus.com>
   5
   6 This file is part of BFD, the Binary File Descriptor library.
   7
   8 This program is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2 of the License, or
  11 (at your option) any later version.
  12
  13 This program is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with this program; if not, write to the Free Software
  20 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  21
  22 /* This is a BFD backend which may be used to write PowerPCBug boot objects.
  23    It may only be used for output, not input.  The intention is that this may
  24    be used as an output format for objcopy in order to generate raw binary
  25    data.
  26
  27    This is very simple.  The only complication is that the real data
  28    will start at some address X, and in some cases we will not want to
  29    include X zeroes just to get to that point.  Since the start
  30    address is not meaningful for this object file format, we use it
  31    instead to indicate the number of zeroes to skip at the start of
  32    the file.  objcopy cooperates by specially setting the start
  33    address to zero by default.  */
  34
  35 #include <ctype.h>
  36
  37 #include "bfd.h"
  38 #include "sysdep.h"
  39 #include "libbfd.h"
  40
  41 /* PPCbug location structure */
  42 typedef struct ppcboot_location {
  43   bfd_byte      ind;
  44   bfd_byte      head;
  45   bfd_byte      sector;
  46   bfd_byte      cylinder;
  47 } ppcboot_location_t;
  48
  49 /* PPCbug partition table layout */
  50 typedef struct ppcboot_partition {
  51   ppcboot_location_t    partition_begin;        /* partition begin */
  52   ppcboot_location_t    partition_end;          /* partition end */
  53   bfd_byte              sector_begin[4];        /* 32-bit start RBA (zero-based), little endian */
  54   bfd_byte              sector_length[4];       /* 32-bit RBA count (one-based), little endian */
  55 } ppcboot_partition_t;
  56
  57 /* PPCbug boot layout.  */
  58 typedef struct ppcboot_hdr {
  59   bfd_byte              pc_compatibility[446];  /* x86 instruction field */
  60   ppcboot_partition_t   partition[4];           /* partition information */
  61   bfd_byte              signature[2];           /* 0x55 and 0xaa */
  62   bfd_byte              entry_offset[4];        /* entry point offset, little endian */
  63   bfd_byte              length[4];              /* load image length, little endian */
  64   bfd_byte              flags;                  /* flag field */
  65   bfd_byte              os_id;                  /* OS_ID */
  66   char                  partition_name[32];     /* partition name */
  67   bfd_byte              reserved1[470];         /* reserved */
  68 }
  69 #ifdef __GNUC__
  70   __attribute__ ((packed))
  71 #endif
  72 ppcboot_hdr_t;
  73
  74 /* Signature bytes for last 2 bytes of the 512 byte record */
  75 #define SIGNATURE0 0x55
  76 #define SIGNATURE1 0xaa
  77
  78 /* PowerPC boot type */
  79 #define PPC_IND 0x41
  80
  81 /* Information needed for ppcboot header */
  82 typedef struct ppcboot_data {
  83   ppcboot_hdr_t header;                         /* raw header */
  84   asection *sec;                                /* single section */
  85 } ppcboot_data_t;
  86
  87 /* Any bfd we create by reading a ppcboot file has three symbols:
  88    a start symbol, an end symbol, and an absolute length symbol.  */
  89 #define PPCBOOT_SYMS 3
  90
  91 static boolean ppcboot_mkobject PARAMS ((bfd *));
  92 static const bfd_target *ppcboot_object_p PARAMS ((bfd *));
  93 static boolean ppcboot_set_arch_mach
  94   PARAMS ((bfd *, enum bfd_architecture, unsigned long));
  95 static boolean ppcboot_get_section_contents
  96   PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type));
  97 static long ppcboot_get_symtab_upper_bound PARAMS ((bfd *));
  98 static char *mangle_name PARAMS ((bfd *, char *));
  99 static long ppcboot_get_symtab PARAMS ((bfd *, asymbol **));
 100 static asymbol *ppcboot_make_empty_symbol PARAMS ((bfd *));
 101 static void ppcboot_get_symbol_info PARAMS ((bfd *, asymbol *, symbol_info *));
 102 static boolean ppcboot_set_section_contents
 103   PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type));
 104 static int ppcboot_sizeof_headers PARAMS ((bfd *, boolean));
 105 static boolean ppcboot_bfd_print_private_bfd_data PARAMS ((bfd *, PTR));
 106
 107 #define ppcboot_set_tdata(abfd, ptr) ((abfd)->tdata.any = (PTR) (ptr))
 108 #define ppcboot_get_tdata(abfd) ((ppcboot_data_t *) ((abfd)->tdata.any))
 109 \f
 110 /* Create a ppcboot object.  Invoked via bfd_set_format.  */
 111
 112 static boolean
 113 ppcboot_mkobject (abfd)
 114      bfd *abfd;
 115 {
 116   if (!ppcboot_get_tdata (abfd))
 117     {
 118       bfd_size_type amt = sizeof (ppcboot_data_t);
 119       ppcboot_set_tdata (abfd, bfd_zalloc (abfd, amt));
 120     }
 121
 122   return true;
 123 }
 124
 125 \f
 126 /* Set the architecture to PowerPC */
 127 static boolean
 128 ppcboot_set_arch_mach (abfd, arch, machine)
 129      bfd *abfd;
 130      enum bfd_architecture arch;
 131      unsigned long machine;
 132 {
 133   if (arch == bfd_arch_unknown)
 134     arch = bfd_arch_powerpc;
 135
 136   else if (arch != bfd_arch_powerpc)
 137     return false;
 138
 139   return bfd_default_set_arch_mach (abfd, arch, machine);
 140 }
 141
 142 \f
 143 /* Any file may be considered to be a ppcboot file, provided the target
 144    was not defaulted.  That is, it must be explicitly specified as
 145    being ppcboot.  */
 146
 147 static const bfd_target *
 148 ppcboot_object_p (abfd)
 149      bfd *abfd;
 150 {
 151   struct stat statbuf;
 152   asection *sec;
 153   ppcboot_hdr_t hdr;
 154   size_t i;
 155   ppcboot_data_t *tdata;
 156
 157   BFD_ASSERT (sizeof (ppcboot_hdr_t) == 1024);
 158
 159   if (abfd->target_defaulted)
 160     {
 161       bfd_set_error (bfd_error_wrong_format);
 162       return NULL;
 163     }
 164
 165   /* Find the file size.  */
 166   if (bfd_stat (abfd, &statbuf) < 0)
 167     {
 168       bfd_set_error (bfd_error_system_call);
 169       return NULL;
 170     }
 171
 172   if ((size_t) statbuf.st_size < sizeof (ppcboot_hdr_t))
 173     {
 174       bfd_set_error (bfd_error_wrong_format);
 175       return NULL;
 176     }
 177
 178   if (bfd_bread ((PTR) &hdr, (bfd_size_type) sizeof (hdr), abfd)
 179       != sizeof (hdr))
 180     {
 181       if (bfd_get_error () != bfd_error_system_call)
 182         bfd_set_error (bfd_error_wrong_format);
 183
 184       return NULL;
 185     }
 186
 187   /* Now do some basic checks.  */
 188   for (i = 0; i < sizeof (hdr.pc_compatibility); i++)
 189     if (hdr.pc_compatibility[i])
 190       {
 191         bfd_set_error (bfd_error_wrong_format);
 192         return NULL;
 193       }
 194
 195   if (hdr.signature[0] != SIGNATURE0 || hdr.signature[1] != SIGNATURE1)
 196     {
 197       bfd_set_error (bfd_error_wrong_format);
 198       return NULL;
 199     }
 200
 201   if (hdr.partition[0].partition_end.ind != PPC_IND)
 202     {
 203       bfd_set_error (bfd_error_wrong_format);
 204       return NULL;
 205     }
 206
 207   abfd->symcount = PPCBOOT_SYMS;
 208
 209   /* One data section.  */
 210   sec = bfd_make_section (abfd, ".data");
 211   if (sec == NULL)
 212     return NULL;
 213   sec->flags = SEC_ALLOC | SEC_LOAD | SEC_DATA | SEC_CODE | SEC_HAS_CONTENTS;
 214   sec->vma = 0;
 215   sec->_raw_size = statbuf.st_size - sizeof (ppcboot_hdr_t);
 216   sec->filepos = sizeof (ppcboot_hdr_t);
 217
 218   ppcboot_mkobject (abfd);
 219   tdata = ppcboot_get_tdata (abfd);
 220   tdata->sec = sec;
 221   memcpy ((PTR) &tdata->header, (PTR) &hdr, sizeof (ppcboot_hdr_t));
 222
 223   ppcboot_set_arch_mach (abfd, bfd_arch_powerpc, 0L);
 224   return abfd->xvec;
 225 }
 226
 227 #define ppcboot_close_and_cleanup _bfd_generic_close_and_cleanup
 228 #define ppcboot_bfd_free_cached_info _bfd_generic_bfd_free_cached_info
 229 #define ppcboot_new_section_hook _bfd_generic_new_section_hook
 230
 231 \f
 232 /* Get contents of the only section.  */
 233
 234 static boolean
 235 ppcboot_get_section_contents (abfd, section, location, offset, count)
 236      bfd *abfd;
 237      asection *section ATTRIBUTE_UNUSED;
 238      PTR location;
 239      file_ptr offset;
 240      bfd_size_type count;
 241 {
 242   if (bfd_seek (abfd, offset + (file_ptr) sizeof (ppcboot_hdr_t), SEEK_SET) != 0
 243       || bfd_bread (location, count, abfd) != count)
 244     return false;
 245   return true;
 246 }
 247
 248 \f
 249 /* Return the amount of memory needed to read the symbol table.  */
 250
 251 static long
 252 ppcboot_get_symtab_upper_bound (abfd)
 253      bfd *abfd ATTRIBUTE_UNUSED;
 254 {
 255   return (PPCBOOT_SYMS + 1) * sizeof (asymbol *);
 256 }
 257
 258 \f
 259 /* Create a symbol name based on the bfd's filename.  */
 260
 261 static char *
 262 mangle_name (abfd, suffix)
 263      bfd *abfd;
 264      char *suffix;
 265 {
 266   bfd_size_type size;
 267   char *buf;
 268   char *p;
 269
 270   size = (strlen (bfd_get_filename (abfd))
 271           + strlen (suffix)
 272           + sizeof "_ppcboot__");
 273
 274   buf = (char *) bfd_alloc (abfd, size);
 275   if (buf == NULL)
 276     return "";
 277
 278   sprintf (buf, "_ppcboot_%s_%s", bfd_get_filename (abfd), suffix);
 279
 280   /* Change any non-alphanumeric characters to underscores.  */
 281   for (p = buf; *p; p++)
 282     if (! isalnum ((unsigned char) *p))
 283       *p = '_';
 284
 285   return buf;
 286 }
 287
 288 \f
 289 /* Return the symbol table.  */
 290
 291 static long
 292 ppcboot_get_symtab (abfd, alocation)
 293      bfd *abfd;
 294      asymbol **alocation;
 295 {
 296   asection *sec = ppcboot_get_tdata (abfd)->sec;
 297   asymbol *syms;
 298   unsigned int i;
 299   bfd_size_type amt = PPCBOOT_SYMS * sizeof (asymbol);
 300
 301   syms = (asymbol *) bfd_alloc (abfd, amt);
 302   if (syms == NULL)
 303     return false;
 304
 305   /* Start symbol.  */
 306   syms[0].the_bfd = abfd;
 307   syms[0].name = mangle_name (abfd, "start");
 308   syms[0].value = 0;
 309   syms[0].flags = BSF_GLOBAL;
 310   syms[0].section = sec;
 311   syms[0].udata.p = NULL;
 312
 313   /* End symbol.  */
 314   syms[1].the_bfd = abfd;
 315   syms[1].name = mangle_name (abfd, "end");
 316   syms[1].value = sec->_raw_size;
 317   syms[1].flags = BSF_GLOBAL;
 318   syms[1].section = sec;
 319   syms[1].udata.p = NULL;
 320
 321   /* Size symbol.  */
 322   syms[2].the_bfd = abfd;
 323   syms[2].name = mangle_name (abfd, "size");
 324   syms[2].value = sec->_raw_size;
 325   syms[2].flags = BSF_GLOBAL;
 326   syms[2].section = bfd_abs_section_ptr;
 327   syms[2].udata.p = NULL;
 328
 329   for (i = 0; i < PPCBOOT_SYMS; i++)
 330     *alocation++ = syms++;
 331   *alocation = NULL;
 332
 333   return PPCBOOT_SYMS;
 334 }
 335
 336 \f
 337 /* Make an empty symbol.  */
 338
 339 static asymbol *
 340 ppcboot_make_empty_symbol (abfd)
 341      bfd *abfd;
 342 {
 343   return (asymbol *) bfd_alloc (abfd, (bfd_size_type) sizeof (asymbol));
 344 }
 345
 346 \f
 347 #define ppcboot_print_symbol _bfd_nosymbols_print_symbol
 348
 349 /* Get information about a symbol.  */
 350
 351 static void
 352 ppcboot_get_symbol_info (ignore_abfd, symbol, ret)
 353      bfd *ignore_abfd ATTRIBUTE_UNUSED;
 354      asymbol *symbol;
 355      symbol_info *ret;
 356 {
 357   bfd_symbol_info (symbol, ret);
 358 }
 359
 360 #define ppcboot_bfd_is_local_label_name bfd_generic_is_local_label_name
 361 #define ppcboot_get_lineno _bfd_nosymbols_get_lineno
 362 #define ppcboot_find_nearest_line _bfd_nosymbols_find_nearest_line
 363 #define ppcboot_bfd_make_debug_symbol _bfd_nosymbols_bfd_make_debug_symbol
 364 #define ppcboot_read_minisymbols _bfd_generic_read_minisymbols
 365 #define ppcboot_minisymbol_to_symbol _bfd_generic_minisymbol_to_symbol
 366
 367 #define ppcboot_get_reloc_upper_bound \
 368   ((long (*) PARAMS ((bfd *, asection *))) bfd_0l)
 369 #define ppcboot_canonicalize_reloc \
 370   ((long (*) PARAMS ((bfd *, asection *, arelent **, asymbol **))) bfd_0l)
 371 #define ppcboot_bfd_reloc_type_lookup _bfd_norelocs_bfd_reloc_type_lookup
 372 \f
 373 /* Write section contents of a ppcboot file.  */
 374
 375 static boolean
 376 ppcboot_set_section_contents (abfd, sec, data, offset, size)
 377      bfd *abfd;
 378      asection *sec;
 379      PTR data;
 380      file_ptr offset;
 381      bfd_size_type size;
 382 {
 383   if (! abfd->output_has_begun)
 384     {
 385       bfd_vma low;
 386       asection *s;
 387
 388       /* The lowest section VMA sets the virtual address of the start
 389          of the file.  We use the set the file position of all the
 390          sections.  */
 391       low = abfd->sections->vma;
 392       for (s = abfd->sections->next; s != NULL; s = s->next)
 393         if (s->vma < low)
 394           low = s->vma;
 395
 396       for (s = abfd->sections; s != NULL; s = s->next)
 397         s->filepos = s->vma - low;
 398
 399       abfd->output_has_begun = true;
 400     }
 401
 402   return _bfd_generic_set_section_contents (abfd, sec, data, offset, size);
 403 }
 404
 405 \f
 406 static int
 407 ppcboot_sizeof_headers (abfd, exec)
 408      bfd *abfd ATTRIBUTE_UNUSED;
 409      boolean exec ATTRIBUTE_UNUSED;
 410 {
 411   return sizeof (ppcboot_hdr_t);
 412 }
 413
 414 \f
 415 /* Print out the program headers.  */
 416
 417 static boolean
 418 ppcboot_bfd_print_private_bfd_data (abfd, farg)
 419      bfd *abfd;
 420      PTR farg;
 421 {
 422   FILE *f = (FILE *)farg;
 423   ppcboot_data_t *tdata = ppcboot_get_tdata (abfd);
 424   long entry_offset = bfd_getl_signed_32 ((PTR) tdata->header.entry_offset);
 425   long length = bfd_getl_signed_32 ((PTR) tdata->header.length);
 426   int i;
 427
 428   fprintf (f, _("\nppcboot header:\n"));
 429   fprintf (f, _("Entry offset        = 0x%.8lx (%ld)\n"), entry_offset, entry_offset);
 430   fprintf (f, _("Length              = 0x%.8lx (%ld)\n"), length, length);
 431
 432   if (tdata->header.flags)
 433     fprintf (f, _("Flag field          = 0x%.2x\n"), tdata->header.flags);
 434
 435   if (tdata->header.os_id)
 436     fprintf (f, "OS_ID               = 0x%.2x\n", tdata->header.os_id);
 437
 438   if (tdata->header.partition_name)
 439     fprintf (f, _("Partition name      = \"%s\"\n"), tdata->header.partition_name);
 440
 441   for (i = 0; i < 4; i++)
 442     {
 443       long sector_begin  = bfd_getl_signed_32 ((PTR) tdata->header.partition[i].sector_begin);
 444       long sector_length = bfd_getl_signed_32 ((PTR) tdata->header.partition[i].sector_length);
 445
 446       /* Skip all 0 entries */
 447       if (!tdata->header.partition[i].partition_begin.ind
 448           && !tdata->header.partition[i].partition_begin.head
 449           && !tdata->header.partition[i].partition_begin.sector
 450           && !tdata->header.partition[i].partition_begin.cylinder
 451           && !tdata->header.partition[i].partition_end.ind
 452           && !tdata->header.partition[i].partition_end.head
 453           && !tdata->header.partition[i].partition_end.sector
 454           && !tdata->header.partition[i].partition_end.cylinder
 455           && !sector_begin && !sector_length)
 456         continue;
 457
 458       fprintf (f, _("\nPartition[%d] start  = { 0x%.2x, 0x%.2x, 0x%.2x, 0x%.2x }\n"), i,
 459                tdata->header.partition[i].partition_begin.ind,
 460                tdata->header.partition[i].partition_begin.head,
 461                tdata->header.partition[i].partition_begin.sector,
 462                tdata->header.partition[i].partition_begin.cylinder);
 463
 464       fprintf (f, _("Partition[%d] end    = { 0x%.2x, 0x%.2x, 0x%.2x, 0x%.2x }\n"), i,
 465                tdata->header.partition[i].partition_end.ind,
 466                tdata->header.partition[i].partition_end.head,
 467                tdata->header.partition[i].partition_end.sector,
 468                tdata->header.partition[i].partition_end.cylinder);
 469
 470       fprintf (f, _("Partition[%d] sector = 0x%.8lx (%ld)\n"), i, sector_begin, sector_begin);
 471       fprintf (f, _("Partition[%d] length = 0x%.8lx (%ld)\n"), i, sector_length, sector_length);
 472     }
 473
 474   fprintf (f, "\n");
 475   return true;
 476 }
 477
 478 \f
 479 #define ppcboot_bfd_get_relocated_section_contents \
 480   bfd_generic_get_relocated_section_contents
 481 #define ppcboot_bfd_relax_section bfd_generic_relax_section
 482 #define ppcboot_bfd_gc_sections bfd_generic_gc_sections
 483 #define ppcboot_bfd_merge_sections bfd_generic_merge_sections
 484 #define ppcboot_bfd_link_hash_table_create _bfd_generic_link_hash_table_create
 485 #define ppcboot_bfd_link_add_symbols _bfd_generic_link_add_symbols
 486 #define ppcboot_bfd_final_link _bfd_generic_final_link
 487 #define ppcboot_bfd_link_split_section _bfd_generic_link_split_section
 488 #define ppcboot_get_section_contents_in_window \
 489   _bfd_generic_get_section_contents_in_window
 490
 491 #define ppcboot_bfd_copy_private_bfd_data _bfd_generic_bfd_copy_private_bfd_data
 492 #define ppcboot_bfd_merge_private_bfd_data _bfd_generic_bfd_merge_private_bfd_data
 493 #define ppcboot_bfd_copy_private_section_data _bfd_generic_bfd_copy_private_section_data
 494 #define ppcboot_bfd_copy_private_symbol_data _bfd_generic_bfd_copy_private_symbol_data
 495 #define ppcboot_bfd_set_private_flags _bfd_generic_bfd_set_private_flags
 496 #define ppcboot_bfd_print_private_bfd_dat ppcboot_bfd_print_private_bfd_data
 497
 498 const bfd_target ppcboot_vec =
 499 {
 500   "ppcboot",                    /* name */
 501   bfd_target_unknown_flavour,   /* flavour */
 502   BFD_ENDIAN_BIG,               /* byteorder is big endian for code */
 503   BFD_ENDIAN_LITTLE,            /* header_byteorder */
 504   EXEC_P,                       /* object_flags */
 505   (SEC_ALLOC | SEC_LOAD | SEC_READONLY | SEC_CODE | SEC_DATA
 506    | SEC_ROM | SEC_HAS_CONTENTS), /* section_flags */
 507   0,                            /* symbol_leading_char */
 508   ' ',                          /* ar_pad_char */
 509   16,                           /* ar_max_namelen */
 510   bfd_getb64, bfd_getb_signed_64, bfd_putb64,
 511   bfd_getb32, bfd_getb_signed_32, bfd_putb32,
 512   bfd_getb16, bfd_getb_signed_16, bfd_putb16,   /* data */
 513   bfd_getl64, bfd_getl_signed_64, bfd_putl64,
 514   bfd_getl32, bfd_getl_signed_32, bfd_putl32,
 515   bfd_getl16, bfd_getl_signed_16, bfd_putl16,   /* hdrs */
 516   {                             /* bfd_check_format */
 517     _bfd_dummy_target,
 518     ppcboot_object_p,           /* bfd_check_format */
 519     _bfd_dummy_target,
 520     _bfd_dummy_target,
 521   },
 522   {                             /* bfd_set_format */
 523     bfd_false,
 524     ppcboot_mkobject,
 525     bfd_false,
 526     bfd_false,
 527   },
 528   {                             /* bfd_write_contents */
 529     bfd_false,
 530     bfd_true,
 531     bfd_false,
 532     bfd_false,
 533   },
 534
 535   BFD_JUMP_TABLE_GENERIC (ppcboot),
 536   BFD_JUMP_TABLE_COPY (ppcboot),
 537   BFD_JUMP_TABLE_CORE (_bfd_nocore),
 538   BFD_JUMP_TABLE_ARCHIVE (_bfd_noarchive),
 539   BFD_JUMP_TABLE_SYMBOLS (ppcboot),
 540   BFD_JUMP_TABLE_RELOCS (ppcboot),
 541   BFD_JUMP_TABLE_WRITE (ppcboot),
 542   BFD_JUMP_TABLE_LINK (ppcboot),
 543   BFD_JUMP_TABLE_DYNAMIC (_bfd_nodynamic),
 544
 545   NULL,
 546
 547   NULL
 548 };