1 /* rescoff.c -- read and write resources in Windows COFF files.
2 Copyright 1997, 1998, 1999, 2000, 2003
3 Free Software Foundation, Inc.
4 Written by Ian Lance Taylor, Cygnus Support.
6 This file is part of GNU Binutils.
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.
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.
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
23 /* This file contains function that read and write Windows resources
28 #include "libiberty.h"
33 /* In order to use the address of a resource data entry, we need to
34 get the image base of the file. Right now we extract it from
35 internal BFD information. FIXME. */
37 #include "coff/internal.h"
40 /* Information we extract from the file. */
46 /* Data read from the file. */
48 /* End of data read from file. */
49 const bfd_byte *data_end;
50 /* Address of the resource section minus the image base of the file. */
52 /* Non-zero if the file is big endian. */
56 /* A resource directory table in a COFF file. */
58 struct 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 /* Macros to swap in values. */
101 #define getfi_16(fi, s) ((fi)->big_endian ? bfd_getb16 (s) : bfd_getl16 (s))
102 #define getfi_32(fi, s) ((fi)->big_endian ? bfd_getb32 (s) : bfd_getl32 (s))
104 /* Local functions. */
106 static void overrun (const struct coff_file_info *, const char *);
107 static struct res_directory *read_coff_res_dir
108 (const bfd_byte *, const struct coff_file_info *,
109 const struct res_id *, int);
110 static struct res_resource *read_coff_data_entry
111 (const bfd_byte *, const struct coff_file_info *, const struct res_id *);
113 /* Read the resources in a COFF file. */
115 struct res_directory *
116 read_coff_rsrc (const char *filename, const char *target)
123 struct coff_file_info finfo;
125 if (filename == NULL)
126 fatal (_("filename required for COFF input"));
128 abfd = bfd_openr (filename, target);
130 bfd_fatal (filename);
132 if (! bfd_check_format_matches (abfd, bfd_object, &matching))
134 bfd_nonfatal (bfd_get_filename (abfd));
135 if (bfd_get_error () == bfd_error_file_ambiguously_recognized)
136 list_matching_formats (matching);
140 sec = bfd_get_section_by_name (abfd, ".rsrc");
143 fatal (_("%s: no resource section"), filename);
146 size = bfd_section_size (abfd, sec);
147 data = (bfd_byte *) res_alloc (size);
149 if (! bfd_get_section_contents (abfd, sec, data, 0, size))
150 bfd_fatal (_("can't read resource section"));
152 finfo.filename = filename;
154 finfo.data_end = data + size;
155 finfo.secaddr = (bfd_get_section_vma (abfd, sec)
156 - pe_data (abfd)->pe_opthdr.ImageBase);
157 finfo.big_endian = bfd_big_endian (abfd);
161 /* Now just read in the top level resource directory. Note that we
162 don't free data, since we create resource entries that point into
163 it. If we ever want to free up the resource information we read,
164 this will have to be cleaned up. */
166 return read_coff_res_dir (data, &finfo, (const struct res_id *) NULL, 0);
169 /* Give an error if we are out of bounds. */
172 overrun (const struct coff_file_info *finfo, const char *msg)
174 fatal (_("%s: %s: address out of bounds"), finfo->filename, msg);
177 /* Read a resource directory. */
179 static struct res_directory *
180 read_coff_res_dir (const bfd_byte *data, const struct coff_file_info *finfo,
181 const struct res_id *type, int level)
183 const struct extern_res_directory *erd;
184 struct res_directory *rd;
185 int name_count, id_count, i;
186 struct res_entry **pp;
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 = (struct res_directory *) res_alloc (sizeof *rd);
195 rd->characteristics = getfi_32 (finfo, erd->characteristics);
196 rd->time = getfi_32 (finfo, erd->time);
197 rd->major = getfi_16 (finfo, erd->major);
198 rd->minor = getfi_16 (finfo, erd->minor);
201 name_count = getfi_16 (finfo, erd->name_count);
202 id_count = getfi_16 (finfo, erd->id_count);
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 unsigned long name, rva;
213 struct res_entry *re;
217 if ((const bfd_byte *) ere >= finfo->data_end)
218 overrun (finfo, _("named directory entry"));
220 name = getfi_32 (finfo, ere->name);
221 rva = getfi_32 (finfo, ere->rva);
223 /* For some reason the high bit in NAME is set. */
226 if (name > (size_t) (finfo->data_end - finfo->data))
227 overrun (finfo, _("directory entry name"));
229 ers = finfo->data + name;
231 re = (struct res_entry *) res_alloc (sizeof *re);
234 length = getfi_16 (finfo, ers);
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] = getfi_16 (finfo, ers + j * 2 + 2);
243 if ((rva & 0x80000000) != 0)
246 if (rva >= (size_t) (finfo->data_end - finfo->data))
247 overrun (finfo, _("named subdirectory"));
249 re->u.dir = read_coff_res_dir (finfo->data + rva, finfo, type,
254 if (rva >= (size_t) (finfo->data_end - finfo->data))
255 overrun (finfo, _("named resource"));
257 re->u.res = read_coff_data_entry (finfo->data + rva, finfo, type);
264 for (i = 0; i < id_count; i++, ere++)
266 unsigned long name, rva;
267 struct res_entry *re;
269 if ((const bfd_byte *) ere >= finfo->data_end)
270 overrun (finfo, _("ID directory entry"));
272 name = getfi_32 (finfo, ere->name);
273 rva = getfi_32 (finfo, ere->rva);
275 re = (struct res_entry *) res_alloc (sizeof *re);
283 if ((rva & 0x80000000) != 0)
286 if (rva >= (size_t) (finfo->data_end - finfo->data))
287 overrun (finfo, _("ID subdirectory"));
289 re->u.dir = read_coff_res_dir (finfo->data + rva, finfo, type,
294 if (rva >= (size_t) (finfo->data_end - finfo->data))
295 overrun (finfo, _("ID resource"));
297 re->u.res = read_coff_data_entry (finfo->data + rva, finfo, type);
307 /* Read a resource data entry. */
309 static struct res_resource *
310 read_coff_data_entry (const bfd_byte *data, const struct coff_file_info *finfo, const struct res_id *type)
312 const struct extern_res_data *erd;
313 struct res_resource *r;
314 unsigned long size, rva;
315 const bfd_byte *resdata;
318 fatal (_("resource type unknown"));
320 if ((size_t) (finfo->data_end - data) < sizeof (struct extern_res_data))
321 overrun (finfo, _("data entry"));
323 erd = (const struct extern_res_data *) data;
325 size = getfi_32 (finfo, erd->size);
326 rva = getfi_32 (finfo, erd->rva);
327 if (rva < finfo->secaddr
328 || rva - finfo->secaddr >= (size_t) (finfo->data_end - finfo->data))
329 overrun (finfo, _("resource data"));
331 resdata = finfo->data + (rva - finfo->secaddr);
333 if (size > (size_t) (finfo->data_end - resdata))
334 overrun (finfo, _("resource data size"));
336 r = bin_to_res (*type, resdata, size, finfo->big_endian);
338 memset (&r->res_info, 0, sizeof (struct res_res_info));
339 r->coff_info.codepage = getfi_32 (finfo, erd->codepage);
340 r->coff_info.reserved = getfi_32 (finfo, erd->reserved);
345 /* This structure is used to build a list of bindata structures. */
351 /* The last structure we have added to the list. */
352 struct bindata *last;
353 /* The size of the list as a whole. */
354 unsigned long length;
357 /* This structure keeps track of information as we build the directory
360 struct coff_write_info
362 /* These fields are based on the BFD. */
363 /* The BFD itself. */
365 /* Non-zero if the file is big endian. */
367 /* Pointer to section symbol used to build RVA relocs. */
370 /* These fields are computed initially, and then not changed. */
371 /* Length of directory tables and entries. */
372 unsigned long dirsize;
373 /* Length of directory entry strings. */
374 unsigned long dirstrsize;
375 /* Length of resource data entries. */
376 unsigned long dataentsize;
378 /* These fields are updated as we add data. */
379 /* Directory tables and entries. */
380 struct bindata_build dirs;
381 /* Directory entry strings. */
382 struct bindata_build dirstrs;
383 /* Resource data entries. */
384 struct bindata_build dataents;
385 /* Actual resource data. */
386 struct bindata_build resources;
389 /* Number of relocations. */
390 unsigned int reloc_count;
393 /* Macros to swap out values. */
395 #define putcwi_16(cwi, v, s) \
396 ((cwi->big_endian) ? bfd_putb16 ((v), (s)) : bfd_putl16 ((v), (s)))
397 #define putcwi_32(cwi, v, s) \
398 ((cwi->big_endian) ? bfd_putb32 ((v), (s)) : bfd_putl32 ((v), (s)))
400 static void coff_bin_sizes
401 (const struct res_directory *, struct coff_write_info *);
402 static unsigned char *coff_alloc (struct bindata_build *, size_t);
403 static void coff_to_bin
404 (const struct res_directory *, struct coff_write_info *);
405 static void coff_res_to_bin
406 (const struct res_resource *, struct coff_write_info *);
408 /* Write resources to a COFF file. RESOURCES should already be
411 Right now we always create a new file. Someday we should also
412 offer the ability to merge resources into an existing file. This
413 would require doing the basic work of objcopy, just modifying or
414 adding the .rsrc section. */
417 write_coff_file (const char *filename, const char *target,
418 const struct res_directory *resources)
422 struct coff_write_info cwi;
424 unsigned long length, offset;
426 if (filename == NULL)
427 fatal (_("filename required for COFF output"));
429 abfd = bfd_openw (filename, target);
431 bfd_fatal (filename);
433 if (! bfd_set_format (abfd, bfd_object))
434 bfd_fatal ("bfd_set_format");
436 #if defined DLLTOOL_SH
437 if (! bfd_set_arch_mach (abfd, bfd_arch_sh, 0))
438 bfd_fatal ("bfd_set_arch_mach(sh)");
439 #elif defined DLLTOOL_MIPS
440 if (! bfd_set_arch_mach (abfd, bfd_arch_mips, 0))
441 bfd_fatal ("bfd_set_arch_mach(mips)");
442 #elif defined DLLTOOL_ARM
443 if (! bfd_set_arch_mach (abfd, bfd_arch_arm, 0))
444 bfd_fatal ("bfd_set_arch_mach(arm)");
446 /* FIXME: This is obviously i386 specific. */
447 if (! bfd_set_arch_mach (abfd, bfd_arch_i386, 0))
448 bfd_fatal ("bfd_set_arch_mach(i386)");
451 if (! bfd_set_file_flags (abfd, HAS_SYMS | HAS_RELOC))
452 bfd_fatal ("bfd_set_file_flags");
454 sec = bfd_make_section (abfd, ".rsrc");
456 bfd_fatal ("bfd_make_section");
458 if (! bfd_set_section_flags (abfd, sec,
459 (SEC_HAS_CONTENTS | SEC_ALLOC
460 | SEC_LOAD | SEC_DATA)))
461 bfd_fatal ("bfd_set_section_flags");
463 if (! bfd_set_symtab (abfd, sec->symbol_ptr_ptr, 1))
464 bfd_fatal ("bfd_set_symtab");
466 /* Requiring this is probably a bug in BFD. */
467 sec->output_section = sec;
469 /* The order of data in the .rsrc section is
470 resource directory tables and entries
471 resource directory strings
472 resource data entries
475 We build these different types of data in different lists. */
478 cwi.big_endian = bfd_big_endian (abfd);
479 cwi.sympp = sec->symbol_ptr_ptr;
484 cwi.dirs.last = NULL;
486 cwi.dirstrs.d = NULL;
487 cwi.dirstrs.last = NULL;
488 cwi.dirstrs.length = 0;
489 cwi.dataents.d = NULL;
490 cwi.dataents.last = NULL;
491 cwi.dataents.length = 0;
492 cwi.resources.d = NULL;
493 cwi.resources.last = NULL;
494 cwi.resources.length = 0;
498 /* Work out the sizes of the resource directory entries, so that we
499 know the various offsets we will need. */
500 coff_bin_sizes (resources, &cwi);
502 /* Force the directory strings to be 32 bit aligned. Every other
503 structure is 32 bit aligned anyhow. */
504 cwi.dirstrsize = (cwi.dirstrsize + 3) &~ 3;
506 /* Actually convert the resources to binary. */
507 coff_to_bin (resources, &cwi);
509 /* Add another 2 bytes to the directory strings if needed for
511 if ((cwi.dirstrs.length & 3) != 0)
515 ex = coff_alloc (&cwi.dirstrs, 2);
520 /* Make sure that the data we built came out to the same size as we
521 calculated initially. */
522 assert (cwi.dirs.length == cwi.dirsize);
523 assert (cwi.dirstrs.length == cwi.dirstrsize);
524 assert (cwi.dataents.length == cwi.dataentsize);
526 length = (cwi.dirsize
529 + cwi.resources.length);
531 if (! bfd_set_section_size (abfd, sec, length))
532 bfd_fatal ("bfd_set_section_size");
534 bfd_set_reloc (abfd, sec, cwi.relocs, cwi.reloc_count);
537 for (d = cwi.dirs.d; d != NULL; d = d->next)
539 if (! bfd_set_section_contents (abfd, sec, d->data, offset, d->length))
540 bfd_fatal ("bfd_set_section_contents");
543 for (d = cwi.dirstrs.d; d != NULL; d = d->next)
545 if (! bfd_set_section_contents (abfd, sec, d->data, offset, d->length))
546 bfd_fatal ("bfd_set_section_contents");
549 for (d = cwi.dataents.d; d != NULL; d = d->next)
551 if (! bfd_set_section_contents (abfd, sec, d->data, offset, d->length))
552 bfd_fatal ("bfd_set_section_contents");
555 for (d = cwi.resources.d; d != NULL; d = d->next)
557 if (! bfd_set_section_contents (abfd, sec, d->data, offset, d->length))
558 bfd_fatal ("bfd_set_section_contents");
562 assert (offset == length);
564 if (! bfd_close (abfd))
565 bfd_fatal ("bfd_close");
567 /* We allocated the relocs array using malloc. */
571 /* Work out the sizes of the various fixed size resource directory
572 entries. This updates fields in CWI. */
575 coff_bin_sizes (const struct res_directory *resdir,
576 struct coff_write_info *cwi)
578 const struct res_entry *re;
580 cwi->dirsize += sizeof (struct extern_res_directory);
582 for (re = resdir->entries; re != NULL; re = re->next)
584 cwi->dirsize += sizeof (struct extern_res_entry);
587 cwi->dirstrsize += re->id.u.n.length * 2 + 2;
590 coff_bin_sizes (re->u.dir, cwi);
592 cwi->dataentsize += sizeof (struct extern_res_data);
596 /* Allocate data for a particular list. */
598 static unsigned char *
599 coff_alloc (struct bindata_build *bb, size_t size)
603 d = (struct bindata *) reswr_alloc (sizeof *d);
606 d->data = (unsigned char *) reswr_alloc (size);
619 /* Convert the resource directory RESDIR to binary. */
622 coff_to_bin (const struct res_directory *resdir, struct coff_write_info *cwi)
624 struct extern_res_directory *erd;
626 const struct res_entry *e;
627 struct extern_res_entry *ere;
629 /* Write out the directory table. */
631 erd = ((struct extern_res_directory *)
632 coff_alloc (&cwi->dirs, sizeof (*erd)));
634 putcwi_32 (cwi, resdir->characteristics, erd->characteristics);
635 putcwi_32 (cwi, resdir->time, erd->time);
636 putcwi_16 (cwi, resdir->major, erd->major);
637 putcwi_16 (cwi, resdir->minor, erd->minor);
641 for (e = resdir->entries; e != NULL; e = e->next)
649 putcwi_16 (cwi, cn, erd->name_count);
650 putcwi_16 (cwi, ci, erd->id_count);
652 /* Write out the data entries. Note that we allocate space for all
653 the entries before writing them out. That permits a recursive
654 call to work correctly when writing out subdirectories. */
656 ere = ((struct extern_res_entry *)
657 coff_alloc (&cwi->dirs, (ci + cn) * sizeof (*ere)));
658 for (e = resdir->entries; e != NULL; e = e->next, ere++)
661 putcwi_32 (cwi, e->id.u.id, ere->name);
667 /* For some reason existing files seem to have the high bit
668 set on the address of the name, although that is not
671 0x80000000 | (cwi->dirsize + cwi->dirstrs.length),
674 str = coff_alloc (&cwi->dirstrs, e->id.u.n.length * 2 + 2);
675 putcwi_16 (cwi, e->id.u.n.length, str);
676 for (i = 0; i < e->id.u.n.length; i++)
677 putcwi_16 (cwi, e->id.u.n.name[i], str + i * 2 + 2);
682 putcwi_32 (cwi, 0x80000000 | cwi->dirs.length, ere->rva);
683 coff_to_bin (e->u.dir, cwi);
688 cwi->dirsize + cwi->dirstrsize + cwi->dataents.length,
691 coff_res_to_bin (e->u.res, cwi);
696 /* Convert the resource RES to binary. */
699 coff_res_to_bin (const struct res_resource *res, struct coff_write_info *cwi)
702 struct extern_res_data *erd;
704 unsigned long length;
706 /* For some reason, although every other address is a section
707 offset, the address of the resource data itself is an RVA. That
708 means that we need to generate a relocation for it. We allocate
709 the relocs array using malloc so that we can use realloc. FIXME:
710 This relocation handling is correct for the i386, but probably
711 not for any other target. */
713 r = (arelent *) reswr_alloc (sizeof (arelent));
714 r->sym_ptr_ptr = cwi->sympp;
715 r->address = cwi->dirsize + cwi->dirstrsize + cwi->dataents.length;
717 r->howto = bfd_reloc_type_lookup (cwi->abfd, BFD_RELOC_RVA);
718 if (r->howto == NULL)
719 bfd_fatal (_("can't get BFD_RELOC_RVA relocation type"));
721 cwi->relocs = xrealloc (cwi->relocs,
722 (cwi->reloc_count + 2) * sizeof (arelent *));
723 cwi->relocs[cwi->reloc_count] = r;
724 cwi->relocs[cwi->reloc_count + 1] = NULL;
727 erd = (struct extern_res_data *) coff_alloc (&cwi->dataents, sizeof (*erd));
733 + cwi->resources.length),
735 putcwi_32 (cwi, res->coff_info.codepage, erd->codepage);
736 putcwi_32 (cwi, res->coff_info.reserved, erd->reserved);
738 d = res_to_bin (res, cwi->big_endian);
740 if (cwi->resources.d == NULL)
741 cwi->resources.d = d;
743 cwi->resources.last->next = d;
746 for (; d->next != NULL; d = d->next)
749 cwi->resources.last = d;
750 cwi->resources.length += length;
752 putcwi_32 (cwi, length, erd->size);
754 /* Force the next resource to have 32 bit alignment. */
756 if ((length & 3) != 0)
761 add = 4 - (length & 3);
763 ex = coff_alloc (&cwi->resources, add);