1 /* rescoff.c -- read and write resources in Windows COFF files.
2 Copyright 1997, 1998, 1999, 2000, 2003, 2005, 2007, 2008
3 Free Software Foundation, Inc.
4 Written by Ian Lance Taylor, Cygnus Support.
5 Rewritten by Kai Tietz, Onevision.
7 This file is part of GNU Binutils.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
24 /* This file contains function that read and write Windows resources
30 #include "libiberty.h"
35 /* In order to use the address of a resource data entry, we need to
36 get the image base of the file. Right now we extract it from
37 internal BFD information. FIXME. */
39 #include "coff/internal.h"
42 /* Information we extract from the file. */
48 /* Data read from the file. */
50 /* End of data read from file. */
51 const bfd_byte *data_end;
52 /* Address of the resource section minus the image base of the file. */
56 /* A resource directory table in a COFF file. */
58 struct __attribute__ ((__packed__)) extern_res_directory
60 /* Characteristics. */
61 bfd_byte characteristics[4];
64 /* Major version number. */
66 /* Minor version number. */
68 /* Number of named directory entries. */
69 bfd_byte name_count[2];
70 /* Number of directory entries with IDs. */
74 /* A resource directory entry in a COFF file. */
76 struct extern_res_entry
80 /* Address of resource entry or subdirectory. */
84 /* A resource data entry in a COFF file. */
86 struct extern_res_data
88 /* Address of resource data. This is apparently a file relative
89 address, rather than a section offset. */
91 /* Size of resource data. */
99 /* Local functions. */
101 static void overrun (const struct coff_file_info *, const char *);
102 static rc_res_directory *read_coff_res_dir (windres_bfd *, const bfd_byte *,
103 const struct coff_file_info *,
104 const rc_res_id *, int);
105 static rc_res_resource *read_coff_data_entry (windres_bfd *, const bfd_byte *,
106 const struct coff_file_info *,
109 /* Read the resources in a COFF file. */
112 read_coff_rsrc (const char *filename, const char *target)
114 rc_res_directory *ret;
121 struct coff_file_info finfo;
123 if (filename == NULL)
124 fatal (_("filename required for COFF input"));
126 abfd = bfd_openr (filename, target);
128 bfd_fatal (filename);
130 if (! bfd_check_format_matches (abfd, bfd_object, &matching))
132 bfd_nonfatal (bfd_get_filename (abfd));
133 if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
134 list_matching_formats (matching);
138 sec = bfd_get_section_by_name (abfd, ".rsrc");
141 fatal (_("%s: no resource section"), filename);
144 set_windres_bfd (&wrbfd, abfd, sec, WR_KIND_BFD);
145 size = bfd_section_size (abfd, sec);
146 data = (bfd_byte *) res_alloc (size);
148 get_windres_bfd_content (&wrbfd, data, 0, size);
150 finfo.filename = filename;
152 finfo.data_end = data + size;
153 finfo.secaddr = (bfd_get_section_vma (abfd, sec)
154 - pe_data (abfd)->pe_opthdr.ImageBase);
156 /* Now just read in the top level resource directory. Note that we
157 don't free data, since we create resource entries that point into
158 it. If we ever want to free up the resource information we read,
159 this will have to be cleaned up. */
161 ret = read_coff_res_dir (&wrbfd, data, &finfo, (const rc_res_id *) NULL, 0);
168 /* Give an error if we are out of bounds. */
171 overrun (const struct coff_file_info *finfo, const char *msg)
173 fatal (_("%s: %s: address out of bounds"), finfo->filename, msg);
176 /* Read a resource directory. */
178 static rc_res_directory *
179 read_coff_res_dir (windres_bfd *wrbfd, const bfd_byte *data,
180 const struct coff_file_info *finfo,
181 const rc_res_id *type, int level)
183 const struct extern_res_directory *erd;
184 rc_res_directory *rd;
185 int name_count, id_count, i;
187 const struct extern_res_entry *ere;
189 if ((size_t) (finfo->data_end - data) < sizeof (struct extern_res_directory))
190 overrun (finfo, _("directory"));
192 erd = (const struct extern_res_directory *) data;
194 rd = (rc_res_directory *) res_alloc (sizeof (rc_res_directory));
195 rd->characteristics = windres_get_32 (wrbfd, erd->characteristics, 4);
196 rd->time = windres_get_32 (wrbfd, erd->time, 4);
197 rd->major = windres_get_16 (wrbfd, erd->major, 2);
198 rd->minor = windres_get_16 (wrbfd, erd->minor, 2);
201 name_count = windres_get_16 (wrbfd, erd->name_count, 2);
202 id_count = windres_get_16 (wrbfd, erd->id_count, 2);
206 /* The resource directory entries immediately follow the directory
208 ere = (const struct extern_res_entry *) (erd + 1);
210 for (i = 0; i < name_count; i++, ere++)
212 rc_uint_type name, rva;
217 if ((const bfd_byte *) ere >= finfo->data_end)
218 overrun (finfo, _("named directory entry"));
220 name = windres_get_32 (wrbfd, ere->name, 4);
221 rva = windres_get_32 (wrbfd, ere->rva, 4);
223 /* For some reason the high bit in NAME is set. */
226 if (name > (rc_uint_type) (finfo->data_end - finfo->data))
227 overrun (finfo, _("directory entry name"));
229 ers = finfo->data + name;
231 re = (rc_res_entry *) res_alloc (sizeof *re);
234 length = windres_get_16 (wrbfd, ers, 2);
235 re->id.u.n.length = length;
236 re->id.u.n.name = (unichar *) res_alloc (length * sizeof (unichar));
237 for (j = 0; j < length; j++)
238 re->id.u.n.name[j] = windres_get_16 (wrbfd, ers + j * 2 + 2, 2);
243 if ((rva & 0x80000000) != 0)
246 if (rva >= (rc_uint_type) (finfo->data_end - finfo->data))
247 overrun (finfo, _("named subdirectory"));
249 re->u.dir = read_coff_res_dir (wrbfd, finfo->data + rva, finfo, type,
254 if (rva >= (rc_uint_type) (finfo->data_end - finfo->data))
255 overrun (finfo, _("named resource"));
257 re->u.res = read_coff_data_entry (wrbfd, finfo->data + rva, finfo, type);
264 for (i = 0; i < id_count; i++, ere++)
266 unsigned long name, rva;
269 if ((const bfd_byte *) ere >= finfo->data_end)
270 overrun (finfo, _("ID directory entry"));
272 name = windres_get_32 (wrbfd, ere->name, 4);
273 rva = windres_get_32 (wrbfd, ere->rva, 4);
275 re = (rc_res_entry *) res_alloc (sizeof *re);
283 if ((rva & 0x80000000) != 0)
286 if (rva >= (rc_uint_type) (finfo->data_end - finfo->data))
287 overrun (finfo, _("ID subdirectory"));
289 re->u.dir = read_coff_res_dir (wrbfd, finfo->data + rva, finfo, type,
294 if (rva >= (rc_uint_type) (finfo->data_end - finfo->data))
295 overrun (finfo, _("ID resource"));
297 re->u.res = read_coff_data_entry (wrbfd, finfo->data + rva, finfo, type);
307 /* Read a resource data entry. */
309 static rc_res_resource *
310 read_coff_data_entry (windres_bfd *wrbfd, const bfd_byte *data,
311 const struct coff_file_info *finfo,
312 const rc_res_id *type)
314 const struct extern_res_data *erd;
316 rc_uint_type size, rva;
317 const bfd_byte *resdata;
320 fatal (_("resource type unknown"));
322 if ((size_t) (finfo->data_end - data) < sizeof (struct extern_res_data))
323 overrun (finfo, _("data entry"));
325 erd = (const struct extern_res_data *) data;
327 size = windres_get_32 (wrbfd, erd->size, 4);
328 rva = windres_get_32 (wrbfd, erd->rva, 4);
329 if (rva < finfo->secaddr
330 || rva - finfo->secaddr >= (rc_uint_type) (finfo->data_end - finfo->data))
331 overrun (finfo, _("resource data"));
333 resdata = finfo->data + (rva - finfo->secaddr);
335 if (size > (rc_uint_type) (finfo->data_end - resdata))
336 overrun (finfo, _("resource data size"));
338 r = bin_to_res (wrbfd, *type, resdata, size);
340 memset (&r->res_info, 0, sizeof (rc_res_res_info));
341 r->coff_info.codepage = windres_get_32 (wrbfd, erd->codepage, 4);
342 r->coff_info.reserved = windres_get_32 (wrbfd, erd->reserved, 4);
347 /* This structure is used to build a list of bindata structures. */
353 /* The last structure we have added to the list. */
355 /* The size of the list as a whole. */
356 unsigned long length;
359 struct coff_res_data_build
363 /* The last structure we have added to the list. */
365 /* The size of the list as a whole. */
366 unsigned long length;
369 /* This structure keeps track of information as we build the directory
372 struct coff_write_info
374 /* These fields are based on the BFD. */
375 /* The BFD itself. */
377 /* Pointer to section symbol used to build RVA relocs. */
380 /* These fields are computed initially, and then not changed. */
381 /* Length of directory tables and entries. */
382 unsigned long dirsize;
383 /* Length of directory entry strings. */
384 unsigned long dirstrsize;
385 /* Length of resource data entries. */
386 unsigned long dataentsize;
388 /* These fields are updated as we add data. */
389 /* Directory tables and entries. */
390 struct bindata_build dirs;
391 /* Directory entry strings. */
392 struct bindata_build dirstrs;
393 /* Resource data entries. */
394 struct bindata_build dataents;
395 /* Actual resource data. */
396 struct coff_res_data_build resources;
399 /* Number of relocations. */
400 unsigned int reloc_count;
403 static void coff_bin_sizes (const rc_res_directory *, struct coff_write_info *);
404 static bfd_byte *coff_alloc (struct bindata_build *, rc_uint_type);
405 static void coff_to_bin
406 (const rc_res_directory *, struct coff_write_info *);
407 static void coff_res_to_bin
408 (const rc_res_resource *, struct coff_write_info *);
410 /* Write resources to a COFF file. RESOURCES should already be
413 Right now we always create a new file. Someday we should also
414 offer the ability to merge resources into an existing file. This
415 would require doing the basic work of objcopy, just modifying or
416 adding the .rsrc section. */
419 write_coff_file (const char *filename, const char *target,
420 const rc_res_directory *resources)
424 struct coff_write_info cwi;
428 unsigned long length, offset;
430 if (filename == NULL)
431 fatal (_("filename required for COFF output"));
433 abfd = bfd_openw (filename, target);
435 bfd_fatal (filename);
437 if (! bfd_set_format (abfd, bfd_object))
438 bfd_fatal ("bfd_set_format");
440 #if defined DLLTOOL_SH
441 if (! bfd_set_arch_mach (abfd, bfd_arch_sh, 0))
442 bfd_fatal ("bfd_set_arch_mach(sh)");
443 #elif defined DLLTOOL_MIPS
444 if (! bfd_set_arch_mach (abfd, bfd_arch_mips, 0))
445 bfd_fatal ("bfd_set_arch_mach(mips)");
446 #elif defined DLLTOOL_ARM
447 if (! bfd_set_arch_mach (abfd, bfd_arch_arm, 0))
448 bfd_fatal ("bfd_set_arch_mach(arm)");
450 /* FIXME: This is obviously i386 specific. */
451 if (! bfd_set_arch_mach (abfd, bfd_arch_i386, 0))
452 bfd_fatal ("bfd_set_arch_mach(i386)");
455 if (! bfd_set_file_flags (abfd, HAS_SYMS | HAS_RELOC))
456 bfd_fatal ("bfd_set_file_flags");
458 sec = bfd_make_section_with_flags (abfd, ".rsrc",
459 (SEC_HAS_CONTENTS | SEC_ALLOC
460 | SEC_LOAD | SEC_DATA));
462 bfd_fatal ("bfd_make_section");
464 if (! bfd_set_symtab (abfd, sec->symbol_ptr_ptr, 1))
465 bfd_fatal ("bfd_set_symtab");
467 /* Requiring this is probably a bug in BFD. */
468 sec->output_section = sec;
470 /* The order of data in the .rsrc section is
471 resource directory tables and entries
472 resource directory strings
473 resource data entries
476 We build these different types of data in different lists. */
478 set_windres_bfd (&wrbfd, abfd, sec, WR_KIND_BFD);
481 cwi.sympp = sec->symbol_ptr_ptr;
486 cwi.dirs.last = NULL;
488 cwi.dirstrs.d = NULL;
489 cwi.dirstrs.last = NULL;
490 cwi.dirstrs.length = 0;
491 cwi.dataents.d = NULL;
492 cwi.dataents.last = NULL;
493 cwi.dataents.length = 0;
494 cwi.resources.d = NULL;
495 cwi.resources.last = NULL;
496 cwi.resources.length = 0;
500 /* Work out the sizes of the resource directory entries, so that we
501 know the various offsets we will need. */
502 coff_bin_sizes (resources, &cwi);
504 /* Force the directory strings to be 32 bit aligned. Every other
505 structure is 32 bit aligned anyhow. */
506 cwi.dirstrsize = (cwi.dirstrsize + 3) &~ 3;
508 /* Actually convert the resources to binary. */
509 coff_to_bin (resources, &cwi);
511 /* Add another 2 bytes to the directory strings if needed for
513 if ((cwi.dirstrs.length & 3) != 0)
517 ex = coff_alloc (&cwi.dirstrs, 2);
522 /* Make sure that the data we built came out to the same size as we
523 calculated initially. */
524 assert (cwi.dirs.length == cwi.dirsize);
525 assert (cwi.dirstrs.length == cwi.dirstrsize);
526 assert (cwi.dataents.length == cwi.dataentsize);
528 length = (cwi.dirsize
531 + cwi.resources.length);
533 if (! bfd_set_section_size (abfd, sec, length))
534 bfd_fatal ("bfd_set_section_size");
536 bfd_set_reloc (abfd, sec, cwi.relocs, cwi.reloc_count);
539 for (d = cwi.dirs.d; d != NULL; d = d->next)
541 if (! bfd_set_section_contents (abfd, sec, d->data, offset, d->length))
542 bfd_fatal ("bfd_set_section_contents");
545 for (d = cwi.dirstrs.d; d != NULL; d = d->next)
547 set_windres_bfd_content (&wrbfd, d->data, offset, d->length);
550 for (d = cwi.dataents.d; d != NULL; d = d->next)
552 set_windres_bfd_content (&wrbfd, d->data, offset, d->length);
555 for (rd = cwi.resources.d; rd != NULL; rd = rd->next)
557 res_to_bin (cwi.wrbfd, (rc_uint_type) offset, rd->res);
558 offset += rd->length;
561 assert (offset == length);
563 if (! bfd_close (abfd))
564 bfd_fatal ("bfd_close");
566 /* We allocated the relocs array using malloc. */
570 /* Work out the sizes of the various fixed size resource directory
571 entries. This updates fields in CWI. */
574 coff_bin_sizes (const rc_res_directory *resdir,
575 struct coff_write_info *cwi)
577 const rc_res_entry *re;
579 cwi->dirsize += sizeof (struct extern_res_directory);
581 for (re = resdir->entries; re != NULL; re = re->next)
583 cwi->dirsize += sizeof (struct extern_res_entry);
586 cwi->dirstrsize += re->id.u.n.length * 2 + 2;
589 coff_bin_sizes (re->u.dir, cwi);
591 cwi->dataentsize += sizeof (struct extern_res_data);
595 /* Allocate data for a particular list. */
598 coff_alloc (struct bindata_build *bb, rc_uint_type size)
602 d = (bindata *) reswr_alloc (sizeof (bindata));
605 d->data = (bfd_byte *) reswr_alloc (size);
618 /* Convert the resource directory RESDIR to binary. */
621 coff_to_bin (const rc_res_directory *resdir, struct coff_write_info *cwi)
623 struct extern_res_directory *erd;
625 const rc_res_entry *e;
626 struct extern_res_entry *ere;
628 /* Write out the directory table. */
630 erd = ((struct extern_res_directory *)
631 coff_alloc (&cwi->dirs, sizeof (*erd)));
633 windres_put_32 (cwi->wrbfd, erd->characteristics, resdir->characteristics);
634 windres_put_32 (cwi->wrbfd, erd->time, resdir->time);
635 windres_put_16 (cwi->wrbfd, erd->major, resdir->major);
636 windres_put_16 (cwi->wrbfd, erd->minor, resdir->minor);
640 for (e = resdir->entries; e != NULL; e = e->next)
648 windres_put_16 (cwi->wrbfd, erd->name_count, cn);
649 windres_put_16 (cwi->wrbfd, erd->id_count, ci);
651 /* Write out the data entries. Note that we allocate space for all
652 the entries before writing them out. That permits a recursive
653 call to work correctly when writing out subdirectories. */
655 ere = ((struct extern_res_entry *)
656 coff_alloc (&cwi->dirs, (ci + cn) * sizeof (*ere)));
657 for (e = resdir->entries; e != NULL; e = e->next, ere++)
660 windres_put_32 (cwi->wrbfd, ere->name, e->id.u.id);
666 /* For some reason existing files seem to have the high bit
667 set on the address of the name, although that is not
669 windres_put_32 (cwi->wrbfd, ere->name,
670 0x80000000 | (cwi->dirsize + cwi->dirstrs.length));
672 str = coff_alloc (&cwi->dirstrs, e->id.u.n.length * 2 + 2);
673 windres_put_16 (cwi->wrbfd, str, e->id.u.n.length);
674 for (i = 0; i < e->id.u.n.length; i++)
675 windres_put_16 (cwi->wrbfd, str + (i + 1) * sizeof (unichar), e->id.u.n.name[i]);
680 windres_put_32 (cwi->wrbfd, ere->rva, 0x80000000 | cwi->dirs.length);
681 coff_to_bin (e->u.dir, cwi);
685 windres_put_32 (cwi->wrbfd, ere->rva,
686 cwi->dirsize + cwi->dirstrsize + cwi->dataents.length);
688 coff_res_to_bin (e->u.res, cwi);
693 /* Convert the resource RES to binary. */
696 coff_res_to_bin (const rc_res_resource *res, struct coff_write_info *cwi)
699 struct extern_res_data *erd;
702 /* For some reason, although every other address is a section
703 offset, the address of the resource data itself is an RVA. That
704 means that we need to generate a relocation for it. We allocate
705 the relocs array using malloc so that we can use realloc. FIXME:
706 This relocation handling is correct for the i386, but probably
707 not for any other target. */
709 r = (arelent *) reswr_alloc (sizeof (arelent));
710 r->sym_ptr_ptr = cwi->sympp;
711 r->address = cwi->dirsize + cwi->dirstrsize + cwi->dataents.length;
713 r->howto = bfd_reloc_type_lookup (WR_BFD (cwi->wrbfd), BFD_RELOC_RVA);
714 if (r->howto == NULL)
715 bfd_fatal (_("can't get BFD_RELOC_RVA relocation type"));
717 cwi->relocs = xrealloc (cwi->relocs,
718 (cwi->reloc_count + 2) * sizeof (arelent *));
719 cwi->relocs[cwi->reloc_count] = r;
720 cwi->relocs[cwi->reloc_count + 1] = NULL;
723 erd = (struct extern_res_data *) coff_alloc (&cwi->dataents, sizeof (*erd));
725 windres_put_32 (cwi->wrbfd, erd->rva,
729 + cwi->resources.length));
730 windres_put_32 (cwi->wrbfd, erd->codepage, res->coff_info.codepage);
731 windres_put_32 (cwi->wrbfd, erd->reserved, res->coff_info.reserved);
733 d = (coff_res_data *) reswr_alloc (sizeof (coff_res_data));
734 d->length = res_to_bin (NULL, (rc_uint_type) 0, res);
738 if (cwi->resources.d == NULL)
739 cwi->resources.d = d;
741 cwi->resources.last->next = d;
743 cwi->resources.last = d;
744 cwi->resources.length += (d->length + 3) & ~3;
746 windres_put_32 (cwi->wrbfd, erd->size, d->length);
748 /* Force the next resource to have 32 bit alignment. */
749 d->length = (d->length + 3) & ~3;