]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - include/coff/pe.h
Update year range in copyright notice of binutils files
[thirdparty/binutils-gdb.git] / include / coff / pe.h
CommitLineData
61e2488c 1/* pe.h - PE COFF header information
252b5132 2
fd67aa11 3 Copyright (C) 1999-2024 Free Software Foundation, Inc.
d155c6ea
NC
4
5 This file is part of BFD, the Binary File Descriptor library.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
e4e42b45 9 the Free Software Foundation; either version 3 of the License, or
d155c6ea
NC
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software Foundation,
e172dbf8 19 Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
252b5132
RH
20#ifndef _PE_H
21#define _PE_H
22
830db048
ZF
23#include "msdos.h"
24
cbaede9c 25/* NT specific file attributes. */
252b5132
RH
26#define IMAGE_FILE_RELOCS_STRIPPED 0x0001
27#define IMAGE_FILE_EXECUTABLE_IMAGE 0x0002
28#define IMAGE_FILE_LINE_NUMS_STRIPPED 0x0004
29#define IMAGE_FILE_LOCAL_SYMS_STRIPPED 0x0008
cbaede9c
NC
30#define IMAGE_FILE_AGGRESSIVE_WS_TRIM 0x0010
31#define IMAGE_FILE_LARGE_ADDRESS_AWARE 0x0020
32#define IMAGE_FILE_16BIT_MACHINE 0x0040
252b5132
RH
33#define IMAGE_FILE_BYTES_REVERSED_LO 0x0080
34#define IMAGE_FILE_32BIT_MACHINE 0x0100
35#define IMAGE_FILE_DEBUG_STRIPPED 0x0200
cbaede9c 36#define IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP 0x0400
93e49a47 37#define IMAGE_FILE_NET_RUN_FROM_SWAP 0x0800
252b5132
RH
38#define IMAGE_FILE_SYSTEM 0x1000
39#define IMAGE_FILE_DLL 0x2000
cbaede9c 40#define IMAGE_FILE_UP_SYSTEM_ONLY 0x4000
252b5132
RH
41#define IMAGE_FILE_BYTES_REVERSED_HI 0x8000
42
2f563b51
DK
43/* DllCharacteristics flag bits. The inconsistent naming may seem
44 odd, but that is how they are defined in the PE specification. */
2d5c3743 45#define IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA 0x0020
2f563b51
DK
46#define IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE 0x0040
47#define IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY 0x0080
48#define IMAGE_DLL_CHARACTERISTICS_NX_COMPAT 0x0100
49#define IMAGE_DLLCHARACTERISTICS_NO_ISOLATION 0x0200
50#define IMAGE_DLLCHARACTERISTICS_NO_SEH 0x0400
51#define IMAGE_DLLCHARACTERISTICS_NO_BIND 0x0800
18e9a809 52#define IMAGE_DLLCHARACTERISTICS_APPCONTAINER 0x1000
2f563b51 53#define IMAGE_DLLCHARACTERISTICS_WDM_DRIVER 0x2000
18e9a809 54#define IMAGE_DLLCHARACTERISTICS_GUARD_CF 0x4000
2f563b51
DK
55#define IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE 0x8000
56
cbaede9c 57/* Additional flags to be set for section headers to allow the NT loader to
252b5132 58 read and write to the section data (to replace the addresses of data in
cbaede9c 59 dlls for one thing); also to execute the section in .text's case. */
252b5132
RH
60#define IMAGE_SCN_MEM_DISCARDABLE 0x02000000
61#define IMAGE_SCN_MEM_EXECUTE 0x20000000
62#define IMAGE_SCN_MEM_READ 0x40000000
63#define IMAGE_SCN_MEM_WRITE 0x80000000
64
cbaede9c 65/* Section characteristics added for ppc-nt. */
252b5132 66
2d5c3743 67#define IMAGE_SCN_TYPE_NO_PAD 0x00000008 /* Reserved. */
252b5132 68
2d5c3743
NC
69#define IMAGE_SCN_CNT_CODE 0x00000020 /* Section contains code. */
70#define IMAGE_SCN_CNT_INITIALIZED_DATA 0x00000040 /* Section contains initialized data. */
71#define IMAGE_SCN_CNT_UNINITIALIZED_DATA 0x00000080 /* Section contains uninitialized data. */
252b5132 72
2d5c3743
NC
73#define IMAGE_SCN_LNK_OTHER 0x00000100 /* Reserved. */
74#define IMAGE_SCN_LNK_INFO 0x00000200 /* Section contains comments or some other type of information. */
75#define IMAGE_SCN_LNK_REMOVE 0x00000800 /* Section contents will not become part of image. */
76#define IMAGE_SCN_LNK_COMDAT 0x00001000 /* Section contents comdat. */
252b5132
RH
77
78#define IMAGE_SCN_MEM_FARDATA 0x00008000
79
80#define IMAGE_SCN_MEM_PURGEABLE 0x00020000
81#define IMAGE_SCN_MEM_16BIT 0x00020000
82#define IMAGE_SCN_MEM_LOCKED 0x00040000
83#define IMAGE_SCN_MEM_PRELOAD 0x00080000
84
2d5c3743 85/* Bit position in the s_flags field where the alignment values start. */
bd33be6e
L
86#define IMAGE_SCN_ALIGN_POWER_BIT_POS 20
87#define IMAGE_SCN_ALIGN_POWER_BIT_MASK 0x00f00000
88#define IMAGE_SCN_ALIGN_POWER_NUM(val) \
89 (((val) >> IMAGE_SCN_ALIGN_POWER_BIT_POS) - 1)
90#define IMAGE_SCN_ALIGN_POWER_CONST(val) \
91 (((val) + 1) << IMAGE_SCN_ALIGN_POWER_BIT_POS)
92
93#define IMAGE_SCN_ALIGN_1BYTES IMAGE_SCN_ALIGN_POWER_CONST (0)
94#define IMAGE_SCN_ALIGN_2BYTES IMAGE_SCN_ALIGN_POWER_CONST (1)
95#define IMAGE_SCN_ALIGN_4BYTES IMAGE_SCN_ALIGN_POWER_CONST (2)
96#define IMAGE_SCN_ALIGN_8BYTES IMAGE_SCN_ALIGN_POWER_CONST (3)
2d5c3743 97/* Default alignment if no others are specified. */
bd33be6e
L
98#define IMAGE_SCN_ALIGN_16BYTES IMAGE_SCN_ALIGN_POWER_CONST (4)
99#define IMAGE_SCN_ALIGN_32BYTES IMAGE_SCN_ALIGN_POWER_CONST (5)
100#define IMAGE_SCN_ALIGN_64BYTES IMAGE_SCN_ALIGN_POWER_CONST (6)
101#define IMAGE_SCN_ALIGN_128BYTES IMAGE_SCN_ALIGN_POWER_CONST (7)
102#define IMAGE_SCN_ALIGN_256BYTES IMAGE_SCN_ALIGN_POWER_CONST (8)
103#define IMAGE_SCN_ALIGN_512BYTES IMAGE_SCN_ALIGN_POWER_CONST (9)
104#define IMAGE_SCN_ALIGN_1024BYTES IMAGE_SCN_ALIGN_POWER_CONST (10)
105#define IMAGE_SCN_ALIGN_2048BYTES IMAGE_SCN_ALIGN_POWER_CONST (11)
106#define IMAGE_SCN_ALIGN_4096BYTES IMAGE_SCN_ALIGN_POWER_CONST (12)
107#define IMAGE_SCN_ALIGN_8192BYTES IMAGE_SCN_ALIGN_POWER_CONST (13)
252b5132 108
2d5c3743 109/* Encode alignment power into IMAGE_SCN_ALIGN bits of s_flags. */
6f8f6017
AM
110#define COFF_ENCODE_ALIGNMENT(ABFD, SECTION, ALIGNMENT_POWER) \
111 (((ABFD)->flags & (EXEC_P | DYNAMIC)) != 0 ? false \
112 : ((SECTION).s_flags \
113 |= IMAGE_SCN_ALIGN_POWER_CONST ((ALIGNMENT_POWER) < 13 \
114 ? (ALIGNMENT_POWER) : 13), \
115 true))
5be87c8f
JB
116#define COFF_DECODE_ALIGNMENT(X) \
117 IMAGE_SCN_ALIGN_POWER_NUM ((X) & IMAGE_SCN_ALIGN_POWER_BIT_MASK)
11ec4ba9 118
252b5132
RH
119#define IMAGE_SCN_LNK_NRELOC_OVFL 0x01000000 /* Section contains extended relocations. */
120#define IMAGE_SCN_MEM_NOT_CACHED 0x04000000 /* Section is not cachable. */
121#define IMAGE_SCN_MEM_NOT_PAGED 0x08000000 /* Section is not pageable. */
122#define IMAGE_SCN_MEM_SHARED 0x10000000 /* Section is shareable. */
123
124/* COMDAT selection codes. */
125
126#define IMAGE_COMDAT_SELECT_NODUPLICATES (1) /* Warn if duplicates. */
127#define IMAGE_COMDAT_SELECT_ANY (2) /* No warning. */
128#define IMAGE_COMDAT_SELECT_SAME_SIZE (3) /* Warn if different size. */
129#define IMAGE_COMDAT_SELECT_EXACT_MATCH (4) /* Warn if different. */
130#define IMAGE_COMDAT_SELECT_ASSOCIATIVE (5) /* Base on other section. */
131
cbaede9c
NC
132/* Machine numbers. */
133
93e49a47
NC
134#define IMAGE_FILE_MACHINE_UNKNOWN 0x0000
135#define IMAGE_FILE_MACHINE_ALPHA 0x0184
136#define IMAGE_FILE_MACHINE_ALPHA64 0x0284
137#define IMAGE_FILE_MACHINE_AM33 0x01d3
138#define IMAGE_FILE_MACHINE_AMD64 0x8664
139#define IMAGE_FILE_MACHINE_ARM 0x01c0
b69c9d41 140#define IMAGE_FILE_MACHINE_ARM64 0xaa64
20c52e68 141#define IMAGE_FILE_MACHINE_ARMNT 0x01c4
93e49a47
NC
142#define IMAGE_FILE_MACHINE_AXP64 IMAGE_FILE_MACHINE_ALPHA64
143#define IMAGE_FILE_MACHINE_CEE 0xc0ee
144#define IMAGE_FILE_MACHINE_CEF 0x0cef
145#define IMAGE_FILE_MACHINE_EBC 0x0ebc
146#define IMAGE_FILE_MACHINE_I386 0x014c
147#define IMAGE_FILE_MACHINE_IA64 0x0200
5fd6b60d 148#define IMAGE_FILE_MACHINE_LOONGARCH64 0x6264
93e49a47
NC
149#define IMAGE_FILE_MACHINE_M32R 0x9041
150#define IMAGE_FILE_MACHINE_M68K 0x0268
151#define IMAGE_FILE_MACHINE_MIPS16 0x0266
152#define IMAGE_FILE_MACHINE_MIPSFPU 0x0366
153#define IMAGE_FILE_MACHINE_MIPSFPU16 0x0466
154#define IMAGE_FILE_MACHINE_POWERPC 0x01f0
155#define IMAGE_FILE_MACHINE_POWERPCFP 0x01f1
156#define IMAGE_FILE_MACHINE_R10000 0x0168
157#define IMAGE_FILE_MACHINE_R3000 0x0162
158#define IMAGE_FILE_MACHINE_R4000 0x0166
1b183017
AS
159#define IMAGE_FILE_MACHINE_RISCV32 0x5032
160#define IMAGE_FILE_MACHINE_RISCV64 0x5064
93e49a47
NC
161#define IMAGE_FILE_MACHINE_SH3 0x01a2
162#define IMAGE_FILE_MACHINE_SH3DSP 0x01a3
163#define IMAGE_FILE_MACHINE_SH3E 0x01a4
164#define IMAGE_FILE_MACHINE_SH4 0x01a6
165#define IMAGE_FILE_MACHINE_SH5 0x01a8
166#define IMAGE_FILE_MACHINE_THUMB 0x01c2
167#define IMAGE_FILE_MACHINE_TRICORE 0x0520
168#define IMAGE_FILE_MACHINE_WCEMIPSV2 0x0169
169
63fa1674
JW
170#define IMAGE_SUBSYSTEM_UNKNOWN 0
171#define IMAGE_SUBSYSTEM_NATIVE 1
172#define IMAGE_SUBSYSTEM_WINDOWS_GUI 2
173#define IMAGE_SUBSYSTEM_WINDOWS_CUI 3
174#define IMAGE_SUBSYSTEM_POSIX_CUI 7
175#define IMAGE_SUBSYSTEM_WINDOWS_CE_GUI 9
176#define IMAGE_SUBSYSTEM_EFI_APPLICATION 10
177#define IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11
178#define IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER 12
d9118602 179#define IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER 13
6c73cbb1 180#define IMAGE_SUBSYSTEM_XBOX 14
61e2488c 181
d155c6ea
NC
182/* NT allows long filenames, we want to accommodate this.
183 This may break some of the bfd functions. */
252b5132 184#undef FILNMLEN
d155c6ea 185#define FILNMLEN 18 /* # characters in a file name. */
252b5132 186
98536290
L
187struct external_PEI_IMAGE_hdr
188{
2d5c3743 189 char nt_signature[4]; /* Required NT signature, 0x4550. */
98536290
L
190
191 /* From standard header. */
192 char f_magic[2]; /* Magic number. */
193 char f_nscns[2]; /* Number of sections. */
194 char f_timdat[4]; /* Time & date stamp. */
195 char f_symptr[4]; /* File pointer to symtab. */
196 char f_nsyms[4]; /* Number of symtab entries. */
197 char f_opthdr[2]; /* Sizeof(optional hdr). */
198 char f_flags[2]; /* Flags. */
199};
200
25bcc51d 201struct external_PEI_filehdr
252b5132 202{
d155c6ea
NC
203 /* DOS header fields - always at offset zero in the EXE file. */
204 char e_magic[2]; /* Magic number, 0x5a4d. */
205 char e_cblp[2]; /* Bytes on last page of file, 0x90. */
206 char e_cp[2]; /* Pages in file, 0x3. */
207 char e_crlc[2]; /* Relocations, 0x0. */
208 char e_cparhdr[2]; /* Size of header in paragraphs, 0x4. */
209 char e_minalloc[2]; /* Minimum extra paragraphs needed, 0x0. */
210 char e_maxalloc[2]; /* Maximum extra paragraphs needed, 0xFFFF. */
211 char e_ss[2]; /* Initial (relative) SS value, 0x0. */
212 char e_sp[2]; /* Initial SP value, 0xb8. */
213 char e_csum[2]; /* Checksum, 0x0. */
214 char e_ip[2]; /* Initial IP value, 0x0. */
215 char e_cs[2]; /* Initial (relative) CS value, 0x0. */
216 char e_lfarlc[2]; /* File address of relocation table, 0x40. */
217 char e_ovno[2]; /* Overlay number, 0x0. */
218 char e_res[4][2]; /* Reserved words, all 0x0. */
219 char e_oemid[2]; /* OEM identifier (for e_oeminfo), 0x0. */
220 char e_oeminfo[2]; /* OEM information; e_oemid specific, 0x0. */
221 char e_res2[10][2]; /* Reserved words, all 0x0. */
222 char e_lfanew[4]; /* File address of new exe header, usually 0x80. */
6785fd72 223 char dos_message[64]; /* Other stuff, always follow DOS header. */
c689311b
DD
224
225 /* Note: additional bytes may be inserted before the signature. Use
d155c6ea
NC
226 the e_lfanew field to find the actual location of the NT signature. */
227
2d5c3743 228 char nt_signature[4]; /* Required NT signature, 0x4550. */
d155c6ea
NC
229
230 /* From standard header. */
231 char f_magic[2]; /* Magic number. */
232 char f_nscns[2]; /* Number of sections. */
233 char f_timdat[4]; /* Time & date stamp. */
234 char f_symptr[4]; /* File pointer to symtab. */
235 char f_nsyms[4]; /* Number of symtab entries. */
236 char f_opthdr[2]; /* Sizeof(optional hdr). */
237 char f_flags[2]; /* Flags. */
252b5132
RH
238};
239
25bcc51d
ILT
240#ifdef COFF_IMAGE_WITH_PE
241
cbaede9c 242/* The filehdr is only weird in images. */
252b5132 243
cbaede9c 244#undef FILHDR
25bcc51d 245#define FILHDR struct external_PEI_filehdr
cbaede9c 246#undef FILHSZ
252b5132
RH
247#define FILHSZ 152
248
25bcc51d 249#endif /* COFF_IMAGE_WITH_PE */
252b5132 250
2d5c3743 251/* 32-bit PE a.out header: */
63fa1674 252
61e2488c 253typedef struct
252b5132
RH
254{
255 AOUTHDR standard;
256
d155c6ea 257 /* NT extra fields; see internal.h for descriptions. */
252b5132
RH
258 char ImageBase[4];
259 char SectionAlignment[4];
260 char FileAlignment[4];
261 char MajorOperatingSystemVersion[2];
262 char MinorOperatingSystemVersion[2];
263 char MajorImageVersion[2];
264 char MinorImageVersion[2];
265 char MajorSubsystemVersion[2];
266 char MinorSubsystemVersion[2];
267 char Reserved1[4];
268 char SizeOfImage[4];
269 char SizeOfHeaders[4];
270 char CheckSum[4];
271 char Subsystem[2];
272 char DllCharacteristics[2];
273 char SizeOfStackReserve[4];
274 char SizeOfStackCommit[4];
275 char SizeOfHeapReserve[4];
276 char SizeOfHeapCommit[4];
277 char LoaderFlags[4];
278 char NumberOfRvaAndSizes[4];
d155c6ea
NC
279 /* IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES]; */
280 char DataDirectory[16][2][4]; /* 16 entries, 2 elements/entry, 4 chars. */
252b5132 281} PEAOUTHDR;
99ad8390 282
252b5132
RH
283#undef AOUTSZ
284#define AOUTSZ (AOUTHDRSZ + 196)
285
63fa1674
JW
286/* Like PEAOUTHDR, except that the "standard" member has no BaseOfData
287 (aka data_start) member and that some of the members are 8 instead
288 of just 4 bytes long. */
61e2488c 289typedef struct
63fa1674 290{
99ad8390
NC
291#ifdef AOUTHDRSZ64
292 AOUTHDR64 standard;
293#else
63fa1674 294 AOUTHDR standard;
99ad8390 295#endif
d155c6ea 296 /* NT extra fields; see internal.h for descriptions. */
63fa1674
JW
297 char ImageBase[8];
298 char SectionAlignment[4];
299 char FileAlignment[4];
300 char MajorOperatingSystemVersion[2];
301 char MinorOperatingSystemVersion[2];
302 char MajorImageVersion[2];
303 char MinorImageVersion[2];
304 char MajorSubsystemVersion[2];
305 char MinorSubsystemVersion[2];
306 char Reserved1[4];
307 char SizeOfImage[4];
308 char SizeOfHeaders[4];
309 char CheckSum[4];
310 char Subsystem[2];
311 char DllCharacteristics[2];
312 char SizeOfStackReserve[8];
313 char SizeOfStackCommit[8];
314 char SizeOfHeapReserve[8];
315 char SizeOfHeapCommit[8];
316 char LoaderFlags[4];
317 char NumberOfRvaAndSizes[4];
d155c6ea
NC
318 /* IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES]; */
319 char DataDirectory[16][2][4]; /* 16 entries, 2 elements/entry, 4 chars. */
c9430732 320} PEPAOUTHDR;
99ad8390
NC
321
322#ifdef AOUTHDRSZ64
323#define PEPAOUTSZ (AOUTHDRSZ64 + 196 + 5 * 4) /* = 240 */
324#else
c9430732 325#define PEPAOUTSZ 240
99ad8390 326#endif
61e2488c 327
252b5132 328#undef E_FILNMLEN
d155c6ea 329#define E_FILNMLEN 18 /* # characters in a file name. */
056350c6
NC
330
331/* Import Tyoes fot ILF format object files.. */
332#define IMPORT_CODE 0
333#define IMPORT_DATA 1
334#define IMPORT_CONST 2
335
336/* Import Name Tyoes for ILF format object files. */
337#define IMPORT_ORDINAL 0
338#define IMPORT_NAME 1
339#define IMPORT_NAME_NOPREFIX 2
340#define IMPORT_NAME_UNDECORATE 3
341
977cdf5a
NC
342/* Weak external characteristics. */
343#define IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY 1
344#define IMAGE_WEAK_EXTERN_SEARCH_LIBRARY 2
345#define IMAGE_WEAK_EXTERN_SEARCH_ALIAS 3
346
167ad85b
TG
347/* Bigobj header. */
348struct external_ANON_OBJECT_HEADER_BIGOBJ
349{
350 /* ANON_OBJECT_HEADER_V2 header. */
351 char Sig1[2];
352 char Sig2[2];
353 char Version[2];
354 char Machine[2];
355 char TimeDateStamp[4];
356 char ClassID[16];
357 char SizeOfData[4];
358 char Flags[4];
359 char MetaDataSize[4];
360 char MetaDataOffset[4];
361
362 /* BIGOBJ specific. */
363 char NumberOfSections[4];
364 char PointerToSymbolTable[4];
365 char NumberOfSymbols[4];
366};
367
368#define FILHSZ_BIGOBJ (14 * 4)
369
370struct external_SYMBOL_EX
371{
372 union
373 {
374 char e_name[E_SYMNMLEN];
375
376 struct
377 {
378 char e_zeroes[4];
379 char e_offset[4];
380 } e;
381 } e;
382
383 char e_value[4];
384 char e_scnum[4];
385 char e_type[2];
386 char e_sclass[1];
387 char e_numaux[1];
388} ATTRIBUTE_PACKED ;
389
390#define SYMENT_BIGOBJ struct external_SYMBOL_EX
391#define SYMESZ_BIGOBJ 20
392
393#define FILNMLEN_BIGOBJ 20
394
395union external_AUX_SYMBOL_EX
396{
397 struct
398 {
399 char WeakDefaultSymIndex[4];
400 char WeakSearchType[4];
401 char rgbReserved[12];
402 } Sym;
403
404 struct
405 {
406 char Name[FILNMLEN_BIGOBJ];
407 } File;
408
409 struct
410 {
2d5c3743
NC
411 char Length[4]; /* Section length. */
412 char NumberOfRelocations[2];/* # relocation entries. */
413 char NumberOfLinenumbers[2];/* # line numbers. */
414 char Checksum[4]; /* Section COMDAT checksum. */
415 char Number[2]; /* COMDAT associated section index. */
416 char Selection[1]; /* COMDAT selection number. */
167ad85b 417 char bReserved[1];
2d5c3743 418 char HighNumber[2]; /* High bits of COMDAT associated sec. */
167ad85b
TG
419 char rgbReserved[2];
420 } Section;
421} ATTRIBUTE_PACKED;
422
423#define AUXENT_BIGOBJ union external_AUX_SYMBOL_EX
424#define AUXESZ_BIGOBJ 20
425
e48570bb
DK
426/* .pdata/.xdata defines and structures for x64 PE+ for exception handling. */
427
428/* .pdata in exception directory. */
429
430struct pex64_runtime_function
431{
432 bfd_vma rva_BeginAddress;
433 bfd_vma rva_EndAddress;
434 bfd_vma rva_UnwindData;
e48570bb
DK
435};
436
437struct external_pex64_runtime_function
438{
439 bfd_byte rva_BeginAddress[4];
440 bfd_byte rva_EndAddress[4];
441 bfd_byte rva_UnwindData[4];
442};
443
444/* If the lowest significant bit is set for rva_UnwindData RVA, it
445 means that the unified RVA points to another pex64_runtime_function
446 that this entry shares the unwind_info block with. */
447#define PEX64_IS_RUNTIME_FUNCTION_CHAINED(PTR_RTF) \
448 (((PTR_RTF)->rva_UnwindData & 1) != 0)
449#define PEX64_GET_UNWINDDATA_UNIFIED_RVA(PTR_RTF) \
450 ((PTR_RTF)->rva_UnwindData & ~1)
451
452/* The unwind codes. */
453#define UWOP_PUSH_NONVOL 0
454#define UWOP_ALLOC_LARGE 1
455#define UWOP_ALLOC_SMALL 2
456#define UWOP_SET_FPREG 3
457#define UWOP_SAVE_NONVOL 4
458#define UWOP_SAVE_NONVOL_FAR 5
2b597f54
TG
459#define UWOP_SAVE_XMM 6 /* For version 1. */
460#define UWOP_EPILOG 6 /* For version 2. */
461#define UWOP_SAVE_XMM_FAR 7 /* For version 1 (deprecated). */
462#define UWOP_SPARE 7 /* For version 2. */
e48570bb
DK
463#define UWOP_SAVE_XMM128 8
464#define UWOP_SAVE_XMM128_FAR 9
465#define UWOP_PUSH_MACHFRAME 10
466
467struct pex64_unwind_code
468{
469 bfd_vma prologue_offset;
470 /* Contains Frame offset, or frame allocation size. */
471 bfd_vma frame_addr;
472 unsigned int uwop_code : 4;
473 /* xmm, mm, or standard register from 0 - 15. */
474 unsigned int reg : 4;
475 /* Used for UWOP_PUSH_MACHFRAME to indicate optional errorcode stack
476 argument. */
477 unsigned int has_errorcode : 1;
478};
479
480struct external_pex64_unwind_code
481{
482 bfd_byte dta[2];
483};
484
485#define PEX64_UNWCODE_CODE(VAL) ((VAL) & 0xf)
486#define PEX64_UNWCODE_INFO(VAL) (((VAL) >> 4) & 0xf)
487
488/* The unwind info. */
489#define UNW_FLAG_NHANDLER 0
490#define UNW_FLAG_EHANDLER 1
491#define UNW_FLAG_UHANDLER 2
492#define UNW_FLAG_FHANDLER 3
493#define UNW_FLAG_CHAININFO 4
494
495#define UNW_FLAG_MASK 0x1f
496
497struct pex64_unwind_info
498{
499 bfd_vma SizeOfBlock;
500 bfd_byte Version; /* Values from 0 up to 7 are possible. */
501 bfd_byte Flags; /* Values from 0 up to 31 are possible. */
502 bfd_vma SizeOfPrologue;
503 bfd_vma CountOfCodes; /* Amount of pex64_unwind_code elements. */
504 /* 0 = CFA, 1..15 are index of integer registers. */
505 unsigned int FrameRegister : 4;
506 bfd_vma FrameOffset;
507 bfd_vma sizeofUnwindCodes;
508 bfd_byte *rawUnwindCodes;
3e33b239 509 bfd_byte *rawUnwindCodesEnd;
48d5accb
TG
510 bfd_vma rva_ExceptionHandler; /* UNW_EHANDLER or UNW_FLAG_UHANDLER. */
511 bfd_vma rva_BeginAddress; /* UNW_FLAG_CHAININFO. */
512 bfd_vma rva_EndAddress; /* UNW_FLAG_CHAININFO. */
513 bfd_vma rva_UnwindData; /* UNW_FLAG_CHAININFO. */
e48570bb
DK
514};
515
516struct external_pex64_unwind_info
517{
518 bfd_byte Version_Flags;
519 bfd_byte SizeOfPrologue;
520 bfd_byte CountOfCodes;
521 bfd_byte FrameRegisterOffset;
522 /* external_pex64_unwind_code array. */
523 /* bfd_byte handler[4]; */
524 /* Optional language specific data. */
525};
526
527struct external_pex64_scope
528{
529 bfd_vma Count;
530};
531
532struct pex64_scope
533{
534 bfd_byte Count[4];
535};
536
537struct pex64_scope_entry
538{
539 bfd_vma rva_BeginAddress;
540 bfd_vma rva_EndAddress;
541 bfd_vma rva_HandlerAddress;
542 bfd_vma rva_JumpAddress;
543};
544#define PEX64_SCOPE_ENTRY_SIZE 16
545
546struct external_pex64_scope_entry
547{
548 bfd_byte rva_BeginAddress[4];
549 bfd_byte rva_EndAddress[4];
550 bfd_byte rva_HandlerAddress[4];
551 bfd_byte rva_JumpAddress[4];
552};
553
554#define PEX64_UWI_VERSION(VAL) ((VAL) & 7)
555#define PEX64_UWI_FLAGS(VAL) (((VAL) >> 3) & 0x1f)
556#define PEX64_UWI_FRAMEREG(VAL) ((VAL) & 0xf)
557#define PEX64_UWI_FRAMEOFF(VAL) (((VAL) >> 4) & 0xf)
558#define PEX64_UWI_SIZEOF_UWCODE_ARRAY(VAL) \
559 ((((VAL) + 1) & ~1) * 2)
560
561#define PEX64_OFFSET_TO_UNWIND_CODE 0x4
562
563#define PEX64_OFFSET_TO_HANDLER_RVA (COUNTOFUNWINDCODES) \
564 (PEX64_OFFSET_TO_UNWIND_CODE + \
565 PEX64_UWI_SIZEOF_UWCODE_ARRAY(COUNTOFUNWINDCODES))
566
567#define PEX64_OFFSET_TO_SCOPE_COUNT(COUNTOFUNWINDCODES) \
568 (PEX64_OFFSET_TO_HANDLER_RVA(COUNTOFUNWINDCODES) + 4)
569
570#define PEX64_SCOPE_ENTRY(COUNTOFUNWINDCODES, IDX) \
571 (PEX64_OFFSET_TO_SCOPE_COUNT(COUNTOFUNWINDCODES) + \
572 PEX64_SCOPE_ENTRY_SIZE * (IDX))
573
2d5c3743
NC
574/* Extra structure used in debug directory. */
575struct external_IMAGE_DEBUG_DIRECTORY
576{
61e2488c
JT
577 char Characteristics[4];
578 char TimeDateStamp[4];
579 char MajorVersion[2];
580 char MinorVersion[2];
581 char Type[4];
582 char SizeOfData[4];
583 char AddressOfRawData[4];
584 char PointerToRawData[4];
585};
586
2d5c3743
NC
587/* Extra structures used in codeview debug record. */
588/* This is not part of the PE specification. */
61e2488c 589
279edac5
AM
590#define CVINFO_PDB70_CVSIGNATURE 0x53445352 /* "RSDS" */
591#define CVINFO_PDB20_CVSIGNATURE 0x3031424e /* "NB10" */
592#define CVINFO_CV50_CVSIGNATURE 0x3131424e /* "NB11" */
593#define CVINFO_CV41_CVSIGNATURE 0x3930424e /* "NB09" */
61e2488c
JT
594
595typedef struct _CV_INFO_PDB70
596{
597 char CvSignature[4];
598 char Signature[16];
599 char Age[4];
600 char PdbFileName[];
601} CV_INFO_PDB70;
602
603typedef struct _CV_INFO_PDB20
604{
605 char CvHeader[4];
606 char Offset[4];
607 char Signature[4];
608 char Age[4];
609 char PdbFileName[];
610} CV_INFO_PDB20;
611
056350c6 612#endif /* _PE_H */