1 /* Support for the generic parts of PE/PEI; common header information.
2 Copyright 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2005
3 Free Software Foundation, Inc.
4 Written by Cygnus Solutions.
6 This file is part of BFD, the Binary File Descriptor library.
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 02110-1301, USA. */
22 /* Most of this hacked by Steve Chamberlain,
25 PE/PEI rearrangement (and code added): Donn Terry
26 Softway Systems, Inc. */
28 /* Hey look, some documentation [and in a place you expect to find it]!
30 The main reference for the pei format is "Microsoft Portable Executable
31 and Common Object File Format Specification 4.1". Get it if you need to
32 do some serious hacking on this code.
35 "Peering Inside the PE: A Tour of the Win32 Portable Executable
36 File Format", MSJ 1994, Volume 9.
38 The *sole* difference between the pe format and the pei format is that the
39 latter has an MSDOS 2.0 .exe header on the front that prints the message
40 "This app must be run under Windows." (or some such).
41 (FIXME: Whether that statement is *really* true or not is unknown.
42 Are there more subtle differences between pe and pei formats?
43 For now assume there aren't. If you find one, then for God sakes
46 The Microsoft docs use the word "image" instead of "executable" because
47 the former can also refer to a DLL (shared library). Confusion can arise
48 because the `i' in `pei' also refers to "image". The `pe' format can
49 also create images (i.e. executables), it's just that to run on a win32
50 system you need to use the pei format.
52 FIXME: Please add more docs here so the next poor fool that has to hack
53 on this code has a chance of getting something accomplished without
54 wasting too much time. */
56 #ifndef GET_FCN_LNNOPTR
57 #define GET_FCN_LNNOPTR(abfd, ext) \
58 H_GET_32 (abfd, ext->x_sym.x_fcnary.x_fcn.x_lnnoptr)
61 #ifndef GET_FCN_ENDNDX
62 #define GET_FCN_ENDNDX(abfd, ext) \
63 H_GET_32 (abfd, ext->x_sym.x_fcnary.x_fcn.x_endndx)
66 #ifndef PUT_FCN_LNNOPTR
67 #define PUT_FCN_LNNOPTR(abfd, in, ext) \
68 H_PUT_32(abfd, in, ext->x_sym.x_fcnary.x_fcn.x_lnnoptr)
70 #ifndef PUT_FCN_ENDNDX
71 #define PUT_FCN_ENDNDX(abfd, in, ext) \
72 H_PUT_32(abfd, in, ext->x_sym.x_fcnary.x_fcn.x_endndx)
75 #define GET_LNSZ_LNNO(abfd, ext) \
76 H_GET_16 (abfd, ext->x_sym.x_misc.x_lnsz.x_lnno)
79 #define GET_LNSZ_SIZE(abfd, ext) \
80 H_GET_16 (abfd, ext->x_sym.x_misc.x_lnsz.x_size)
83 #define PUT_LNSZ_LNNO(abfd, in, ext) \
84 H_PUT_16(abfd, in, ext->x_sym.x_misc.x_lnsz.x_lnno)
87 #define PUT_LNSZ_SIZE(abfd, in, ext) \
88 H_PUT_16(abfd, in, ext->x_sym.x_misc.x_lnsz.x_size)
90 #ifndef GET_SCN_SCNLEN
91 #define GET_SCN_SCNLEN(abfd, ext) \
92 H_GET_32 (abfd, ext->x_scn.x_scnlen)
94 #ifndef GET_SCN_NRELOC
95 #define GET_SCN_NRELOC(abfd, ext) \
96 H_GET_16 (abfd, ext->x_scn.x_nreloc)
98 #ifndef GET_SCN_NLINNO
99 #define GET_SCN_NLINNO(abfd, ext) \
100 H_GET_16 (abfd, ext->x_scn.x_nlinno)
102 #ifndef PUT_SCN_SCNLEN
103 #define PUT_SCN_SCNLEN(abfd, in, ext) \
104 H_PUT_32(abfd, in, ext->x_scn.x_scnlen)
106 #ifndef PUT_SCN_NRELOC
107 #define PUT_SCN_NRELOC(abfd, in, ext) \
108 H_PUT_16(abfd, in, ext->x_scn.x_nreloc)
110 #ifndef PUT_SCN_NLINNO
111 #define PUT_SCN_NLINNO(abfd, in, ext) \
112 H_PUT_16(abfd,in, ext->x_scn.x_nlinno)
114 #ifndef GET_LINENO_LNNO
115 #define GET_LINENO_LNNO(abfd, ext) \
116 H_GET_16 (abfd, ext->l_lnno);
118 #ifndef PUT_LINENO_LNNO
119 #define PUT_LINENO_LNNO(abfd, val, ext) \
120 H_PUT_16(abfd,val, ext->l_lnno);
123 /* The f_symptr field in the filehdr is sometimes 64 bits. */
124 #ifndef GET_FILEHDR_SYMPTR
125 #define GET_FILEHDR_SYMPTR H_GET_32
127 #ifndef PUT_FILEHDR_SYMPTR
128 #define PUT_FILEHDR_SYMPTR H_PUT_32
131 /* Some fields in the aouthdr are sometimes 64 bits. */
132 #ifndef GET_AOUTHDR_TSIZE
133 #define GET_AOUTHDR_TSIZE H_GET_32
135 #ifndef PUT_AOUTHDR_TSIZE
136 #define PUT_AOUTHDR_TSIZE H_PUT_32
138 #ifndef GET_AOUTHDR_DSIZE
139 #define GET_AOUTHDR_DSIZE H_GET_32
141 #ifndef PUT_AOUTHDR_DSIZE
142 #define PUT_AOUTHDR_DSIZE H_PUT_32
144 #ifndef GET_AOUTHDR_BSIZE
145 #define GET_AOUTHDR_BSIZE H_GET_32
147 #ifndef PUT_AOUTHDR_BSIZE
148 #define PUT_AOUTHDR_BSIZE H_PUT_32
150 #ifndef GET_AOUTHDR_ENTRY
151 #define GET_AOUTHDR_ENTRY H_GET_32
153 #ifndef PUT_AOUTHDR_ENTRY
154 #define PUT_AOUTHDR_ENTRY H_PUT_32
156 #ifndef GET_AOUTHDR_TEXT_START
157 #define GET_AOUTHDR_TEXT_START H_GET_32
159 #ifndef PUT_AOUTHDR_TEXT_START
160 #define PUT_AOUTHDR_TEXT_START H_PUT_32
162 #ifndef GET_AOUTHDR_DATA_START
163 #define GET_AOUTHDR_DATA_START H_GET_32
165 #ifndef PUT_AOUTHDR_DATA_START
166 #define PUT_AOUTHDR_DATA_START H_PUT_32
169 /* Some fields in the scnhdr are sometimes 64 bits. */
170 #ifndef GET_SCNHDR_PADDR
171 #define GET_SCNHDR_PADDR H_GET_32
173 #ifndef PUT_SCNHDR_PADDR
174 #define PUT_SCNHDR_PADDR H_PUT_32
176 #ifndef GET_SCNHDR_VADDR
177 #define GET_SCNHDR_VADDR H_GET_32
179 #ifndef PUT_SCNHDR_VADDR
180 #define PUT_SCNHDR_VADDR H_PUT_32
182 #ifndef GET_SCNHDR_SIZE
183 #define GET_SCNHDR_SIZE H_GET_32
185 #ifndef PUT_SCNHDR_SIZE
186 #define PUT_SCNHDR_SIZE H_PUT_32
188 #ifndef GET_SCNHDR_SCNPTR
189 #define GET_SCNHDR_SCNPTR H_GET_32
191 #ifndef PUT_SCNHDR_SCNPTR
192 #define PUT_SCNHDR_SCNPTR H_PUT_32
194 #ifndef GET_SCNHDR_RELPTR
195 #define GET_SCNHDR_RELPTR H_GET_32
197 #ifndef PUT_SCNHDR_RELPTR
198 #define PUT_SCNHDR_RELPTR H_PUT_32
200 #ifndef GET_SCNHDR_LNNOPTR
201 #define GET_SCNHDR_LNNOPTR H_GET_32
203 #ifndef PUT_SCNHDR_LNNOPTR
204 #define PUT_SCNHDR_LNNOPTR H_PUT_32
209 #define GET_OPTHDR_IMAGE_BASE H_GET_64
210 #define PUT_OPTHDR_IMAGE_BASE H_PUT_64
211 #define GET_OPTHDR_SIZE_OF_STACK_RESERVE H_GET_64
212 #define PUT_OPTHDR_SIZE_OF_STACK_RESERVE H_PUT_64
213 #define GET_OPTHDR_SIZE_OF_STACK_COMMIT H_GET_64
214 #define PUT_OPTHDR_SIZE_OF_STACK_COMMIT H_PUT_64
215 #define GET_OPTHDR_SIZE_OF_HEAP_RESERVE H_GET_64
216 #define PUT_OPTHDR_SIZE_OF_HEAP_RESERVE H_PUT_64
217 #define GET_OPTHDR_SIZE_OF_HEAP_COMMIT H_GET_64
218 #define PUT_OPTHDR_SIZE_OF_HEAP_COMMIT H_PUT_64
219 #define GET_PDATA_ENTRY bfd_get_64
221 #define _bfd_XX_bfd_copy_private_bfd_data_common _bfd_pep_bfd_copy_private_bfd_data_common
222 #define _bfd_XX_bfd_copy_private_section_data _bfd_pep_bfd_copy_private_section_data
223 #define _bfd_XX_get_symbol_info _bfd_pep_get_symbol_info
224 #define _bfd_XX_only_swap_filehdr_out _bfd_pep_only_swap_filehdr_out
225 #define _bfd_XX_print_private_bfd_data_common _bfd_pep_print_private_bfd_data_common
226 #define _bfd_XXi_final_link_postscript _bfd_pepi_final_link_postscript
227 #define _bfd_XXi_final_link_postscript _bfd_pepi_final_link_postscript
228 #define _bfd_XXi_only_swap_filehdr_out _bfd_pepi_only_swap_filehdr_out
229 #define _bfd_XXi_swap_aouthdr_in _bfd_pepi_swap_aouthdr_in
230 #define _bfd_XXi_swap_aouthdr_out _bfd_pepi_swap_aouthdr_out
231 #define _bfd_XXi_swap_aux_in _bfd_pepi_swap_aux_in
232 #define _bfd_XXi_swap_aux_out _bfd_pepi_swap_aux_out
233 #define _bfd_XXi_swap_lineno_in _bfd_pepi_swap_lineno_in
234 #define _bfd_XXi_swap_lineno_out _bfd_pepi_swap_lineno_out
235 #define _bfd_XXi_swap_scnhdr_out _bfd_pepi_swap_scnhdr_out
236 #define _bfd_XXi_swap_sym_in _bfd_pepi_swap_sym_in
237 #define _bfd_XXi_swap_sym_out _bfd_pepi_swap_sym_out
239 #else /* !COFF_WITH_pep */
241 #define GET_OPTHDR_IMAGE_BASE H_GET_32
242 #define PUT_OPTHDR_IMAGE_BASE H_PUT_32
243 #define GET_OPTHDR_SIZE_OF_STACK_RESERVE H_GET_32
244 #define PUT_OPTHDR_SIZE_OF_STACK_RESERVE H_PUT_32
245 #define GET_OPTHDR_SIZE_OF_STACK_COMMIT H_GET_32
246 #define PUT_OPTHDR_SIZE_OF_STACK_COMMIT H_PUT_32
247 #define GET_OPTHDR_SIZE_OF_HEAP_RESERVE H_GET_32
248 #define PUT_OPTHDR_SIZE_OF_HEAP_RESERVE H_PUT_32
249 #define GET_OPTHDR_SIZE_OF_HEAP_COMMIT H_GET_32
250 #define PUT_OPTHDR_SIZE_OF_HEAP_COMMIT H_PUT_32
251 #define GET_PDATA_ENTRY bfd_get_32
253 #define _bfd_XX_bfd_copy_private_bfd_data_common _bfd_pe_bfd_copy_private_bfd_data_common
254 #define _bfd_XX_bfd_copy_private_section_data _bfd_pe_bfd_copy_private_section_data
255 #define _bfd_XX_get_symbol_info _bfd_pe_get_symbol_info
256 #define _bfd_XX_only_swap_filehdr_out _bfd_pe_only_swap_filehdr_out
257 #define _bfd_XX_print_private_bfd_data_common _bfd_pe_print_private_bfd_data_common
258 #define _bfd_XXi_final_link_postscript _bfd_pei_final_link_postscript
259 #define _bfd_XXi_final_link_postscript _bfd_pei_final_link_postscript
260 #define _bfd_XXi_only_swap_filehdr_out _bfd_pei_only_swap_filehdr_out
261 #define _bfd_XXi_swap_aouthdr_in _bfd_pei_swap_aouthdr_in
262 #define _bfd_XXi_swap_aouthdr_out _bfd_pei_swap_aouthdr_out
263 #define _bfd_XXi_swap_aux_in _bfd_pei_swap_aux_in
264 #define _bfd_XXi_swap_aux_out _bfd_pei_swap_aux_out
265 #define _bfd_XXi_swap_lineno_in _bfd_pei_swap_lineno_in
266 #define _bfd_XXi_swap_lineno_out _bfd_pei_swap_lineno_out
267 #define _bfd_XXi_swap_scnhdr_out _bfd_pei_swap_scnhdr_out
268 #define _bfd_XXi_swap_sym_in _bfd_pei_swap_sym_in
269 #define _bfd_XXi_swap_sym_out _bfd_pei_swap_sym_out
271 #endif /* !COFF_WITH_pep */
273 /* Macro: Returns true if the bfd is a PE executable as opposed to a PE object file. */
274 #define bfd_pe_executable_p(abfd) \
275 (strncmp ((abfd)->xvec->name, "pei-", 4) == 0 \
276 || strncmp ((abfd)->xvec->name, "efi-app-", 8) == 0)
278 /* These functions are architecture dependent, and are in peicode.h:
280 int coff_swap_reloc_out
286 /* The functions described below are common across all PE/PEI
287 implementations architecture types, and actually appear in
290 #define coff_swap_sym_in _bfd_XXi_swap_sym_in
291 #define coff_swap_sym_out _bfd_XXi_swap_sym_out
292 #define coff_swap_aux_in _bfd_XXi_swap_aux_in
293 #define coff_swap_aux_out _bfd_XXi_swap_aux_out
294 #define coff_swap_lineno_in _bfd_XXi_swap_lineno_in
295 #define coff_swap_lineno_out _bfd_XXi_swap_lineno_out
296 #define coff_swap_aouthdr_in _bfd_XXi_swap_aouthdr_in
297 #define coff_swap_aouthdr_out _bfd_XXi_swap_aouthdr_out
298 #define coff_swap_scnhdr_out _bfd_XXi_swap_scnhdr_out
300 #ifndef coff_final_link_postscript
301 #define coff_final_link_postscript _bfd_XXi_final_link_postscript
304 void _bfd_XXi_swap_sym_in (bfd
*, void *, void *);
305 unsigned _bfd_XXi_swap_sym_out (bfd
*, void *, void *);
306 void _bfd_XXi_swap_aux_in (bfd
*, void *, int, int, int, int, void *);
307 unsigned _bfd_XXi_swap_aux_out (bfd
*, void *, int, int, int, int, void *);
308 void _bfd_XXi_swap_lineno_in (bfd
*, void *, void *);
309 unsigned _bfd_XXi_swap_lineno_out (bfd
*, void *, void *);
310 void _bfd_XXi_swap_aouthdr_in (bfd
*, void *, void *);
311 unsigned _bfd_XXi_swap_aouthdr_out (bfd
*, void *, void *);
312 unsigned _bfd_XXi_swap_scnhdr_out (bfd
*, void *, void *);
313 bfd_boolean
_bfd_XX_print_private_bfd_data_common (bfd
*, void *);
314 bfd_boolean
_bfd_XX_bfd_copy_private_bfd_data_common (bfd
*, bfd
*);
315 void _bfd_XX_get_symbol_info (bfd
*, asymbol
*, symbol_info
*);
316 bfd_boolean
_bfd_XXi_final_link_postscript (bfd
*, struct coff_final_link_info
*);
318 /* The following are needed only for ONE of pe or pei, but don't
319 otherwise vary; peicode.h fixes up ifdefs but we provide the
322 unsigned _bfd_XX_only_swap_filehdr_out (bfd
*, void *, void *);
323 unsigned _bfd_XXi_only_swap_filehdr_out (bfd
*, void *, void *);
324 bfd_boolean
_bfd_XX_bfd_copy_private_section_data (bfd
*, asection
*, bfd
*, asection
*);
This page took 0.035159 seconds and 4 git commands to generate.