1 /* rescoff.c -- read and write resources in Windows COFF files.
2 Copyright 1997, 1998, 1999, 2000, 2003, 2007
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., 51 Franklin Street - Fifth Floor, Boston, MA
23 /* This file contains function that read and write Windows resources
28 #include "libiberty.h"
34 /* In order to use the address of a resource data entry, we need to
35 get the image base of the file. Right now we extract it from
36 internal BFD information. FIXME. */
38 #include "coff/internal.h"
41 /* Information we extract from the file. */
47 /* Data read from the file. */
49 /* End of data read from file. */
50 const bfd_byte
*data_end
;
51 /* Address of the resource section minus the image base of the file. */
53 /* Non-zero if the file is big endian. */
57 /* A resource directory table in a COFF file. */
59 struct extern_res_directory
61 /* Characteristics. */
62 bfd_byte characteristics
[4];
65 /* Major version number. */
67 /* Minor version number. */
69 /* Number of named directory entries. */
70 bfd_byte name_count
[2];
71 /* Number of directory entries with IDs. */
75 /* A resource directory entry in a COFF file. */
77 struct extern_res_entry
81 /* Address of resource entry or subdirectory. */
85 /* A resource data entry in a COFF file. */
87 struct extern_res_data
89 /* Address of resource data. This is apparently a file relative
90 address, rather than a section offset. */
92 /* Size of resource data. */
100 /* Macros to swap in values. */
102 #define getfi_16(fi, s) ((fi)->big_endian ? bfd_getb16 (s) : bfd_getl16 (s))
103 #define getfi_32(fi, s) ((fi)->big_endian ? bfd_getb32 (s) : bfd_getl32 (s))
105 /* Local functions. */
107 static void overrun (const struct coff_file_info
*, const char *);
108 static struct res_directory
*read_coff_res_dir
109 (const bfd_byte
*, const struct coff_file_info
*,
110 const struct res_id
*, int);
111 static struct res_resource
*read_coff_data_entry
112 (const bfd_byte
*, const struct coff_file_info
*, const struct res_id
*);
114 /* Read the resources in a COFF file. */
116 struct res_directory
*
117 read_coff_rsrc (const char *filename
, const char *target
)
124 struct coff_file_info finfo
;
126 if (filename
== NULL
)
127 fatal (_("filename required for COFF input"));
129 abfd
= bfd_openr (filename
, target
);
131 bfd_fatal (filename
);
133 if (! bfd_check_format_matches (abfd
, bfd_object
, &matching
))
135 bfd_nonfatal (bfd_get_filename (abfd
));
136 if (bfd_get_error () == bfd_error_file_ambiguously_recognized
)
137 list_matching_formats (matching
);
141 sec
= bfd_get_section_by_name (abfd
, ".rsrc");
144 fatal (_("%s: no resource section"), filename
);
147 size
= bfd_section_size (abfd
, sec
);
148 data
= (bfd_byte
*) res_alloc (size
);
150 if (! bfd_get_section_contents (abfd
, sec
, data
, 0, size
))
151 bfd_fatal (_("can't read resource section"));
153 finfo
.filename
= filename
;
155 finfo
.data_end
= data
+ size
;
156 finfo
.secaddr
= (bfd_get_section_vma (abfd
, sec
)
157 - pe_data (abfd
)->pe_opthdr
.ImageBase
);
158 finfo
.big_endian
= bfd_big_endian (abfd
);
162 /* Now just read in the top level resource directory. Note that we
163 don't free data, since we create resource entries that point into
164 it. If we ever want to free up the resource information we read,
165 this will have to be cleaned up. */
167 return read_coff_res_dir (data
, &finfo
, (const struct res_id
*) NULL
, 0);
170 /* Give an error if we are out of bounds. */
173 overrun (const struct coff_file_info
*finfo
, const char *msg
)
175 fatal (_("%s: %s: address out of bounds"), finfo
->filename
, msg
);
178 /* Read a resource directory. */
180 static struct res_directory
*
181 read_coff_res_dir (const bfd_byte
*data
, const struct coff_file_info
*finfo
,
182 const struct res_id
*type
, int level
)
184 const struct extern_res_directory
*erd
;
185 struct res_directory
*rd
;
186 int name_count
, id_count
, i
;
187 struct res_entry
**pp
;
188 const struct extern_res_entry
*ere
;
190 if ((size_t) (finfo
->data_end
- data
) < sizeof (struct extern_res_directory
))
191 overrun (finfo
, _("directory"));
193 erd
= (const struct extern_res_directory
*) data
;
195 rd
= (struct res_directory
*) res_alloc (sizeof *rd
);
196 rd
->characteristics
= getfi_32 (finfo
, erd
->characteristics
);
197 rd
->time
= getfi_32 (finfo
, erd
->time
);
198 rd
->major
= getfi_16 (finfo
, erd
->major
);
199 rd
->minor
= getfi_16 (finfo
, erd
->minor
);
202 name_count
= getfi_16 (finfo
, erd
->name_count
);
203 id_count
= getfi_16 (finfo
, erd
->id_count
);
207 /* The resource directory entries immediately follow the directory
209 ere
= (const struct extern_res_entry
*) (erd
+ 1);
211 for (i
= 0; i
< name_count
; i
++, ere
++)
213 unsigned long name
, rva
;
214 struct res_entry
*re
;
218 if ((const bfd_byte
*) ere
>= finfo
->data_end
)
219 overrun (finfo
, _("named directory entry"));
221 name
= getfi_32 (finfo
, ere
->name
);
222 rva
= getfi_32 (finfo
, ere
->rva
);
224 /* For some reason the high bit in NAME is set. */
227 if (name
> (size_t) (finfo
->data_end
- finfo
->data
))
228 overrun (finfo
, _("directory entry name"));
230 ers
= finfo
->data
+ name
;
232 re
= (struct res_entry
*) res_alloc (sizeof *re
);
235 length
= getfi_16 (finfo
, ers
);
236 re
->id
.u
.n
.length
= length
;
237 re
->id
.u
.n
.name
= (unichar
*) res_alloc (length
* sizeof (unichar
));
238 for (j
= 0; j
< length
; j
++)
239 re
->id
.u
.n
.name
[j
] = getfi_16 (finfo
, ers
+ j
* 2 + 2);
244 if ((rva
& 0x80000000) != 0)
247 if (rva
>= (size_t) (finfo
->data_end
- finfo
->data
))
248 overrun (finfo
, _("named subdirectory"));
250 re
->u
.dir
= read_coff_res_dir (finfo
->data
+ rva
, finfo
, type
,
255 if (rva
>= (size_t) (finfo
->data_end
- finfo
->data
))
256 overrun (finfo
, _("named resource"));
258 re
->u
.res
= read_coff_data_entry (finfo
->data
+ rva
, finfo
, type
);
265 for (i
= 0; i
< id_count
; i
++, ere
++)
267 unsigned long name
, rva
;
268 struct res_entry
*re
;
270 if ((const bfd_byte
*) ere
>= finfo
->data_end
)
271 overrun (finfo
, _("ID directory entry"));
273 name
= getfi_32 (finfo
, ere
->name
);
274 rva
= getfi_32 (finfo
, ere
->rva
);
276 re
= (struct res_entry
*) res_alloc (sizeof *re
);
284 if ((rva
& 0x80000000) != 0)
287 if (rva
>= (size_t) (finfo
->data_end
- finfo
->data
))
288 overrun (finfo
, _("ID subdirectory"));
290 re
->u
.dir
= read_coff_res_dir (finfo
->data
+ rva
, finfo
, type
,
295 if (rva
>= (size_t) (finfo
->data_end
- finfo
->data
))
296 overrun (finfo
, _("ID resource"));
298 re
->u
.res
= read_coff_data_entry (finfo
->data
+ rva
, finfo
, type
);
308 /* Read a resource data entry. */
310 static struct res_resource
*
311 read_coff_data_entry (const bfd_byte
*data
, const struct coff_file_info
*finfo
, const struct res_id
*type
)
313 const struct extern_res_data
*erd
;
314 struct res_resource
*r
;
315 unsigned long size
, rva
;
316 const bfd_byte
*resdata
;
319 fatal (_("resource type unknown"));
321 if ((size_t) (finfo
->data_end
- data
) < sizeof (struct extern_res_data
))
322 overrun (finfo
, _("data entry"));
324 erd
= (const struct extern_res_data
*) data
;
326 size
= getfi_32 (finfo
, erd
->size
);
327 rva
= getfi_32 (finfo
, erd
->rva
);
328 if (rva
< finfo
->secaddr
329 || rva
- finfo
->secaddr
>= (size_t) (finfo
->data_end
- finfo
->data
))
330 overrun (finfo
, _("resource data"));
332 resdata
= finfo
->data
+ (rva
- finfo
->secaddr
);
334 if (size
> (size_t) (finfo
->data_end
- resdata
))
335 overrun (finfo
, _("resource data size"));
337 r
= bin_to_res (*type
, resdata
, size
, finfo
->big_endian
);
339 memset (&r
->res_info
, 0, sizeof (struct res_res_info
));
340 r
->coff_info
.codepage
= getfi_32 (finfo
, erd
->codepage
);
341 r
->coff_info
.reserved
= getfi_32 (finfo
, erd
->reserved
);
346 /* This structure is used to build a list of bindata structures. */
352 /* The last structure we have added to the list. */
353 struct bindata
*last
;
354 /* The size of the list as a whole. */
355 unsigned long length
;
358 /* This structure keeps track of information as we build the directory
361 struct coff_write_info
363 /* These fields are based on the BFD. */
364 /* The BFD itself. */
366 /* Non-zero if the file is big endian. */
368 /* Pointer to section symbol used to build RVA relocs. */
371 /* These fields are computed initially, and then not changed. */
372 /* Length of directory tables and entries. */
373 unsigned long dirsize
;
374 /* Length of directory entry strings. */
375 unsigned long dirstrsize
;
376 /* Length of resource data entries. */
377 unsigned long dataentsize
;
379 /* These fields are updated as we add data. */
380 /* Directory tables and entries. */
381 struct bindata_build dirs
;
382 /* Directory entry strings. */
383 struct bindata_build dirstrs
;
384 /* Resource data entries. */
385 struct bindata_build dataents
;
386 /* Actual resource data. */
387 struct bindata_build resources
;
390 /* Number of relocations. */
391 unsigned int reloc_count
;
394 /* Macros to swap out values. */
396 #define putcwi_16(cwi, v, s) \
397 ((cwi->big_endian) ? bfd_putb16 ((v), (s)) : bfd_putl16 ((v), (s)))
398 #define putcwi_32(cwi, v, s) \
399 ((cwi->big_endian) ? bfd_putb32 ((v), (s)) : bfd_putl32 ((v), (s)))
401 static void coff_bin_sizes
402 (const struct res_directory
*, struct coff_write_info
*);
403 static unsigned char *coff_alloc (struct bindata_build
*, size_t);
404 static void coff_to_bin
405 (const struct res_directory
*, struct coff_write_info
*);
406 static void coff_res_to_bin
407 (const struct res_resource
*, struct coff_write_info
*);
409 /* Write resources to a COFF file. RESOURCES should already be
412 Right now we always create a new file. Someday we should also
413 offer the ability to merge resources into an existing file. This
414 would require doing the basic work of objcopy, just modifying or
415 adding the .rsrc section. */
418 write_coff_file (const char *filename
, const char *target
,
419 const struct res_directory
*resources
)
423 struct coff_write_info cwi
;
425 unsigned long length
, offset
;
427 if (filename
== NULL
)
428 fatal (_("filename required for COFF output"));
430 abfd
= bfd_openw (filename
, target
);
432 bfd_fatal (filename
);
434 if (! bfd_set_format (abfd
, bfd_object
))
435 bfd_fatal ("bfd_set_format");
437 #if defined DLLTOOL_SH
438 if (! bfd_set_arch_mach (abfd
, bfd_arch_sh
, 0))
439 bfd_fatal ("bfd_set_arch_mach(sh)");
440 #elif defined DLLTOOL_MIPS
441 if (! bfd_set_arch_mach (abfd
, bfd_arch_mips
, 0))
442 bfd_fatal ("bfd_set_arch_mach(mips)");
443 #elif defined DLLTOOL_ARM
444 if (! bfd_set_arch_mach (abfd
, bfd_arch_arm
, 0))
445 bfd_fatal ("bfd_set_arch_mach(arm)");
447 /* FIXME: This is obviously i386 specific. */
448 if (! bfd_set_arch_mach (abfd
, bfd_arch_i386
, 0))
449 bfd_fatal ("bfd_set_arch_mach(i386)");
452 if (! bfd_set_file_flags (abfd
, HAS_SYMS
| HAS_RELOC
))
453 bfd_fatal ("bfd_set_file_flags");
455 sec
= bfd_make_section (abfd
, ".rsrc");
457 bfd_fatal ("bfd_make_section");
459 if (! bfd_set_section_flags (abfd
, sec
,
460 (SEC_HAS_CONTENTS
| SEC_ALLOC
461 | SEC_LOAD
| SEC_DATA
)))
462 bfd_fatal ("bfd_set_section_flags");
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. */
479 cwi
.big_endian
= bfd_big_endian (abfd
);
480 cwi
.sympp
= sec
->symbol_ptr_ptr
;
485 cwi
.dirs
.last
= NULL
;
487 cwi
.dirstrs
.d
= NULL
;
488 cwi
.dirstrs
.last
= NULL
;
489 cwi
.dirstrs
.length
= 0;
490 cwi
.dataents
.d
= NULL
;
491 cwi
.dataents
.last
= NULL
;
492 cwi
.dataents
.length
= 0;
493 cwi
.resources
.d
= NULL
;
494 cwi
.resources
.last
= NULL
;
495 cwi
.resources
.length
= 0;
499 /* Work out the sizes of the resource directory entries, so that we
500 know the various offsets we will need. */
501 coff_bin_sizes (resources
, &cwi
);
503 /* Force the directory strings to be 32 bit aligned. Every other
504 structure is 32 bit aligned anyhow. */
505 cwi
.dirstrsize
= (cwi
.dirstrsize
+ 3) &~ 3;
507 /* Actually convert the resources to binary. */
508 coff_to_bin (resources
, &cwi
);
510 /* Add another 2 bytes to the directory strings if needed for
512 if ((cwi
.dirstrs
.length
& 3) != 0)
516 ex
= coff_alloc (&cwi
.dirstrs
, 2);
521 /* Make sure that the data we built came out to the same size as we
522 calculated initially. */
523 assert (cwi
.dirs
.length
== cwi
.dirsize
);
524 assert (cwi
.dirstrs
.length
== cwi
.dirstrsize
);
525 assert (cwi
.dataents
.length
== cwi
.dataentsize
);
527 length
= (cwi
.dirsize
530 + cwi
.resources
.length
);
532 if (! bfd_set_section_size (abfd
, sec
, length
))
533 bfd_fatal ("bfd_set_section_size");
535 bfd_set_reloc (abfd
, sec
, cwi
.relocs
, cwi
.reloc_count
);
538 for (d
= cwi
.dirs
.d
; d
!= NULL
; d
= d
->next
)
540 if (! bfd_set_section_contents (abfd
, sec
, d
->data
, offset
, d
->length
))
541 bfd_fatal ("bfd_set_section_contents");
544 for (d
= cwi
.dirstrs
.d
; d
!= NULL
; d
= d
->next
)
546 if (! bfd_set_section_contents (abfd
, sec
, d
->data
, offset
, d
->length
))
547 bfd_fatal ("bfd_set_section_contents");
550 for (d
= cwi
.dataents
.d
; d
!= NULL
; d
= d
->next
)
552 if (! bfd_set_section_contents (abfd
, sec
, d
->data
, offset
, d
->length
))
553 bfd_fatal ("bfd_set_section_contents");
556 for (d
= cwi
.resources
.d
; d
!= NULL
; d
= d
->next
)
558 if (! bfd_set_section_contents (abfd
, sec
, d
->data
, offset
, d
->length
))
559 bfd_fatal ("bfd_set_section_contents");
563 assert (offset
== length
);
565 if (! bfd_close (abfd
))
566 bfd_fatal ("bfd_close");
568 /* We allocated the relocs array using malloc. */
572 /* Work out the sizes of the various fixed size resource directory
573 entries. This updates fields in CWI. */
576 coff_bin_sizes (const struct res_directory
*resdir
,
577 struct coff_write_info
*cwi
)
579 const struct res_entry
*re
;
581 cwi
->dirsize
+= sizeof (struct extern_res_directory
);
583 for (re
= resdir
->entries
; re
!= NULL
; re
= re
->next
)
585 cwi
->dirsize
+= sizeof (struct extern_res_entry
);
588 cwi
->dirstrsize
+= re
->id
.u
.n
.length
* 2 + 2;
591 coff_bin_sizes (re
->u
.dir
, cwi
);
593 cwi
->dataentsize
+= sizeof (struct extern_res_data
);
597 /* Allocate data for a particular list. */
599 static unsigned char *
600 coff_alloc (struct bindata_build
*bb
, size_t size
)
604 d
= (struct bindata
*) reswr_alloc (sizeof *d
);
607 d
->data
= (unsigned char *) reswr_alloc (size
);
620 /* Convert the resource directory RESDIR to binary. */
623 coff_to_bin (const struct res_directory
*resdir
, struct coff_write_info
*cwi
)
625 struct extern_res_directory
*erd
;
627 const struct res_entry
*e
;
628 struct extern_res_entry
*ere
;
630 /* Write out the directory table. */
632 erd
= ((struct extern_res_directory
*)
633 coff_alloc (&cwi
->dirs
, sizeof (*erd
)));
635 putcwi_32 (cwi
, resdir
->characteristics
, erd
->characteristics
);
636 putcwi_32 (cwi
, resdir
->time
, erd
->time
);
637 putcwi_16 (cwi
, resdir
->major
, erd
->major
);
638 putcwi_16 (cwi
, resdir
->minor
, erd
->minor
);
642 for (e
= resdir
->entries
; e
!= NULL
; e
= e
->next
)
650 putcwi_16 (cwi
, cn
, erd
->name_count
);
651 putcwi_16 (cwi
, ci
, erd
->id_count
);
653 /* Write out the data entries. Note that we allocate space for all
654 the entries before writing them out. That permits a recursive
655 call to work correctly when writing out subdirectories. */
657 ere
= ((struct extern_res_entry
*)
658 coff_alloc (&cwi
->dirs
, (ci
+ cn
) * sizeof (*ere
)));
659 for (e
= resdir
->entries
; e
!= NULL
; e
= e
->next
, ere
++)
662 putcwi_32 (cwi
, e
->id
.u
.id
, ere
->name
);
668 /* For some reason existing files seem to have the high bit
669 set on the address of the name, although that is not
672 0x80000000 | (cwi
->dirsize
+ cwi
->dirstrs
.length
),
675 str
= coff_alloc (&cwi
->dirstrs
, e
->id
.u
.n
.length
* 2 + 2);
676 putcwi_16 (cwi
, e
->id
.u
.n
.length
, str
);
677 for (i
= 0; i
< e
->id
.u
.n
.length
; i
++)
678 putcwi_16 (cwi
, e
->id
.u
.n
.name
[i
], str
+ i
* 2 + 2);
683 putcwi_32 (cwi
, 0x80000000 | cwi
->dirs
.length
, ere
->rva
);
684 coff_to_bin (e
->u
.dir
, cwi
);
689 cwi
->dirsize
+ cwi
->dirstrsize
+ cwi
->dataents
.length
,
692 coff_res_to_bin (e
->u
.res
, cwi
);
697 /* Convert the resource RES to binary. */
700 coff_res_to_bin (const struct res_resource
*res
, struct coff_write_info
*cwi
)
703 struct extern_res_data
*erd
;
705 unsigned long length
;
707 /* For some reason, although every other address is a section
708 offset, the address of the resource data itself is an RVA. That
709 means that we need to generate a relocation for it. We allocate
710 the relocs array using malloc so that we can use realloc. FIXME:
711 This relocation handling is correct for the i386, but probably
712 not for any other target. */
714 r
= (arelent
*) reswr_alloc (sizeof (arelent
));
715 r
->sym_ptr_ptr
= cwi
->sympp
;
716 r
->address
= cwi
->dirsize
+ cwi
->dirstrsize
+ cwi
->dataents
.length
;
718 r
->howto
= bfd_reloc_type_lookup (cwi
->abfd
, BFD_RELOC_RVA
);
719 if (r
->howto
== NULL
)
720 bfd_fatal (_("can't get BFD_RELOC_RVA relocation type"));
722 cwi
->relocs
= xrealloc (cwi
->relocs
,
723 (cwi
->reloc_count
+ 2) * sizeof (arelent
*));
724 cwi
->relocs
[cwi
->reloc_count
] = r
;
725 cwi
->relocs
[cwi
->reloc_count
+ 1] = NULL
;
728 erd
= (struct extern_res_data
*) coff_alloc (&cwi
->dataents
, sizeof (*erd
));
734 + cwi
->resources
.length
),
736 putcwi_32 (cwi
, res
->coff_info
.codepage
, erd
->codepage
);
737 putcwi_32 (cwi
, res
->coff_info
.reserved
, erd
->reserved
);
739 d
= res_to_bin (res
, cwi
->big_endian
);
741 if (cwi
->resources
.d
== NULL
)
742 cwi
->resources
.d
= d
;
744 cwi
->resources
.last
->next
= d
;
747 for (; d
->next
!= NULL
; d
= d
->next
)
750 cwi
->resources
.last
= d
;
751 cwi
->resources
.length
+= length
;
753 putcwi_32 (cwi
, length
, erd
->size
);
755 /* Force the next resource to have 32 bit alignment. */
757 if ((length
& 3) != 0)
762 add
= 4 - (length
& 3);
764 ex
= coff_alloc (&cwi
->resources
, add
);