xref: /netbsd-src/external/gpl3/binutils.old/dist/include/coff/pe.h (revision e992f068c547fd6e84b3f104dc2340adcc955732)
1 /* pe.h  -  PE COFF header information
2 
3    Copyright (C) 1999-2022 Free Software Foundation, Inc.
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
9    the Free Software Foundation; either version 3 of the License, or
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,
19    Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
20 #ifndef _PE_H
21 #define _PE_H
22 
23 #include "msdos.h"
24 
25 /* NT specific file attributes.  */
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
30 #define IMAGE_FILE_AGGRESSIVE_WS_TRIM        0x0010
31 #define IMAGE_FILE_LARGE_ADDRESS_AWARE       0x0020
32 #define IMAGE_FILE_16BIT_MACHINE             0x0040
33 #define IMAGE_FILE_BYTES_REVERSED_LO         0x0080
34 #define IMAGE_FILE_32BIT_MACHINE             0x0100
35 #define IMAGE_FILE_DEBUG_STRIPPED            0x0200
36 #define IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP   0x0400
37 #define IMAGE_FILE_NET_RUN_FROM_SWAP         0x0800
38 #define IMAGE_FILE_SYSTEM                    0x1000
39 #define IMAGE_FILE_DLL                       0x2000
40 #define IMAGE_FILE_UP_SYSTEM_ONLY            0x4000
41 #define IMAGE_FILE_BYTES_REVERSED_HI         0x8000
42 
43 /* DllCharacteristics flag bits.  The inconsistent naming may seem
44    odd, but that is how they are defined in the PE specification.  */
45 #define IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA       0x0020
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
52 #define IMAGE_DLLCHARACTERISTICS_APPCONTAINER           0x1000
53 #define IMAGE_DLLCHARACTERISTICS_WDM_DRIVER             0x2000
54 #define IMAGE_DLLCHARACTERISTICS_GUARD_CF               0x4000
55 #define IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE  0x8000
56 
57 /* Additional flags to be set for section headers to allow the NT loader to
58    read and write to the section data (to replace the addresses of data in
59    dlls for one thing); also to execute the section in .text's case.  */
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 
65 /* Section characteristics added for ppc-nt.  */
66 
67 #define IMAGE_SCN_TYPE_NO_PAD                0x00000008  /* Reserved.  */
68 
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.  */
72 
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.  */
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 
85 /* Bit position in the s_flags field where the alignment values start.  */
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)
97 /* Default alignment if no others are specified.  */
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)
108 
109 /* Encode alignment power into IMAGE_SCN_ALIGN bits of s_flags.  */
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))
116 #define COFF_DECODE_ALIGNMENT(X)             \
117   IMAGE_SCN_ALIGN_POWER_NUM ((X) & IMAGE_SCN_ALIGN_POWER_BIT_MASK)
118 
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 
132 /* Machine numbers.  */
133 
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
140 #define IMAGE_FILE_MACHINE_ARM64             0xaa64
141 #define IMAGE_FILE_MACHINE_AXP64             IMAGE_FILE_MACHINE_ALPHA64
142 #define IMAGE_FILE_MACHINE_CEE               0xc0ee
143 #define IMAGE_FILE_MACHINE_CEF               0x0cef
144 #define IMAGE_FILE_MACHINE_EBC               0x0ebc
145 #define IMAGE_FILE_MACHINE_I386              0x014c
146 #define IMAGE_FILE_MACHINE_IA64              0x0200
147 #define IMAGE_FILE_MACHINE_M32R              0x9041
148 #define IMAGE_FILE_MACHINE_M68K              0x0268
149 #define IMAGE_FILE_MACHINE_MIPS16            0x0266
150 #define IMAGE_FILE_MACHINE_MIPSFPU           0x0366
151 #define IMAGE_FILE_MACHINE_MIPSFPU16         0x0466
152 #define IMAGE_FILE_MACHINE_POWERPC           0x01f0
153 #define IMAGE_FILE_MACHINE_POWERPCFP         0x01f1
154 #define IMAGE_FILE_MACHINE_R10000            0x0168
155 #define IMAGE_FILE_MACHINE_R3000             0x0162
156 #define IMAGE_FILE_MACHINE_R4000             0x0166
157 #define IMAGE_FILE_MACHINE_SH3               0x01a2
158 #define IMAGE_FILE_MACHINE_SH3DSP            0x01a3
159 #define IMAGE_FILE_MACHINE_SH3E              0x01a4
160 #define IMAGE_FILE_MACHINE_SH4               0x01a6
161 #define IMAGE_FILE_MACHINE_SH5               0x01a8
162 #define IMAGE_FILE_MACHINE_THUMB             0x01c2
163 #define IMAGE_FILE_MACHINE_TRICORE           0x0520
164 #define IMAGE_FILE_MACHINE_WCEMIPSV2         0x0169
165 #define IMAGE_FILE_MACHINE_AMD64             0x8664
166 
167 #define IMAGE_SUBSYSTEM_UNKNOWN			 0
168 #define IMAGE_SUBSYSTEM_NATIVE			 1
169 #define IMAGE_SUBSYSTEM_WINDOWS_GUI		 2
170 #define IMAGE_SUBSYSTEM_WINDOWS_CUI		 3
171 #define IMAGE_SUBSYSTEM_POSIX_CUI		 7
172 #define IMAGE_SUBSYSTEM_WINDOWS_CE_GUI		 9
173 #define IMAGE_SUBSYSTEM_EFI_APPLICATION		10
174 #define IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER	11
175 #define IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER	12
176 #define IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER	13
177 #define IMAGE_SUBSYSTEM_XBOX			14
178 
179 /* NT allows long filenames, we want to accommodate this.
180    This may break some of the bfd functions.  */
181 #undef  FILNMLEN
182 #define FILNMLEN	18	/* # characters in a file name.  */
183 
184 struct external_PEI_IMAGE_hdr
185 {
186   char nt_signature[4];		/* Required NT signature, 0x4550.  */
187 
188   /* From standard header.  */
189   char f_magic[2];		/* Magic number.		*/
190   char f_nscns[2];		/* Number of sections.		*/
191   char f_timdat[4];		/* Time & date stamp.		*/
192   char f_symptr[4];		/* File pointer to symtab.	*/
193   char f_nsyms[4];		/* Number of symtab entries.	*/
194   char f_opthdr[2];		/* Sizeof(optional hdr).	*/
195   char f_flags[2];		/* Flags.			*/
196 };
197 
198 struct external_PEI_filehdr
199 {
200   /* DOS header fields - always at offset zero in the EXE file.  */
201   char e_magic[2];		/* Magic number, 0x5a4d.  */
202   char e_cblp[2];		/* Bytes on last page of file, 0x90.  */
203   char e_cp[2];			/* Pages in file, 0x3.  */
204   char e_crlc[2];		/* Relocations, 0x0.  */
205   char e_cparhdr[2];		/* Size of header in paragraphs, 0x4.  */
206   char e_minalloc[2];		/* Minimum extra paragraphs needed, 0x0.  */
207   char e_maxalloc[2];		/* Maximum extra paragraphs needed, 0xFFFF.  */
208   char e_ss[2];			/* Initial (relative) SS value, 0x0.  */
209   char e_sp[2];			/* Initial SP value, 0xb8.  */
210   char e_csum[2];		/* Checksum, 0x0.  */
211   char e_ip[2];			/* Initial IP value, 0x0.  */
212   char e_cs[2];			/* Initial (relative) CS value, 0x0.  */
213   char e_lfarlc[2];		/* File address of relocation table, 0x40.  */
214   char e_ovno[2];		/* Overlay number, 0x0.  */
215   char e_res[4][2];		/* Reserved words, all 0x0.  */
216   char e_oemid[2];		/* OEM identifier (for e_oeminfo), 0x0.  */
217   char e_oeminfo[2];		/* OEM information; e_oemid specific, 0x0.  */
218   char e_res2[10][2];		/* Reserved words, all 0x0.  */
219   char e_lfanew[4];		/* File address of new exe header, usually 0x80.  */
220   char dos_message[16][4];	/* Other stuff, always follow DOS header.  */
221 
222   /* Note: additional bytes may be inserted before the signature.  Use
223    the e_lfanew field to find the actual location of the NT signature.  */
224 
225   char nt_signature[4];		/* Required NT signature, 0x4550.  */
226 
227   /* From standard header.  */
228   char f_magic[2];		/* Magic number.		*/
229   char f_nscns[2];		/* Number of sections.		*/
230   char f_timdat[4];		/* Time & date stamp.		*/
231   char f_symptr[4];		/* File pointer to symtab.	*/
232   char f_nsyms[4];		/* Number of symtab entries.	*/
233   char f_opthdr[2];		/* Sizeof(optional hdr).	*/
234   char f_flags[2];		/* Flags.			*/
235 };
236 
237 #ifdef COFF_IMAGE_WITH_PE
238 
239 /* The filehdr is only weird in images.  */
240 
241 #undef  FILHDR
242 #define FILHDR struct external_PEI_filehdr
243 #undef  FILHSZ
244 #define FILHSZ 152
245 
246 #endif /* COFF_IMAGE_WITH_PE */
247 
248 /* 32-bit PE a.out header:  */
249 
250 typedef struct
251 {
252   AOUTHDR standard;
253 
254   /* NT extra fields; see internal.h for descriptions.  */
255   char  ImageBase[4];
256   char  SectionAlignment[4];
257   char  FileAlignment[4];
258   char  MajorOperatingSystemVersion[2];
259   char  MinorOperatingSystemVersion[2];
260   char  MajorImageVersion[2];
261   char  MinorImageVersion[2];
262   char  MajorSubsystemVersion[2];
263   char  MinorSubsystemVersion[2];
264   char  Reserved1[4];
265   char  SizeOfImage[4];
266   char  SizeOfHeaders[4];
267   char  CheckSum[4];
268   char  Subsystem[2];
269   char  DllCharacteristics[2];
270   char  SizeOfStackReserve[4];
271   char  SizeOfStackCommit[4];
272   char  SizeOfHeapReserve[4];
273   char  SizeOfHeapCommit[4];
274   char  LoaderFlags[4];
275   char  NumberOfRvaAndSizes[4];
276   /* IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES];  */
277   char  DataDirectory[16][2][4]; /* 16 entries, 2 elements/entry, 4 chars.  */
278 } PEAOUTHDR;
279 
280 #undef AOUTSZ
281 #define AOUTSZ (AOUTHDRSZ + 196)
282 
283 /* Like PEAOUTHDR, except that the "standard" member has no BaseOfData
284    (aka data_start) member and that some of the members are 8 instead
285    of just 4 bytes long.  */
286 typedef struct
287 {
288 #ifdef AOUTHDRSZ64
289   AOUTHDR64 standard;
290 #else
291   AOUTHDR standard;
292 #endif
293   /* NT extra fields; see internal.h for descriptions.  */
294   char  ImageBase[8];
295   char  SectionAlignment[4];
296   char  FileAlignment[4];
297   char  MajorOperatingSystemVersion[2];
298   char  MinorOperatingSystemVersion[2];
299   char  MajorImageVersion[2];
300   char  MinorImageVersion[2];
301   char  MajorSubsystemVersion[2];
302   char  MinorSubsystemVersion[2];
303   char  Reserved1[4];
304   char  SizeOfImage[4];
305   char  SizeOfHeaders[4];
306   char  CheckSum[4];
307   char  Subsystem[2];
308   char  DllCharacteristics[2];
309   char  SizeOfStackReserve[8];
310   char  SizeOfStackCommit[8];
311   char  SizeOfHeapReserve[8];
312   char  SizeOfHeapCommit[8];
313   char  LoaderFlags[4];
314   char  NumberOfRvaAndSizes[4];
315   /* IMAGE_DATA_DIRECTORY DataDirectory[IMAGE_NUMBEROF_DIRECTORY_ENTRIES];  */
316   char  DataDirectory[16][2][4]; /* 16 entries, 2 elements/entry, 4 chars.  */
317 } PEPAOUTHDR;
318 
319 #ifdef AOUTHDRSZ64
320 #define PEPAOUTSZ	(AOUTHDRSZ64 + 196 + 5 * 4) /* = 240 */
321 #else
322 #define PEPAOUTSZ	240
323 #endif
324 
325 #undef  E_FILNMLEN
326 #define E_FILNMLEN	18	/* # characters in a file name.  */
327 
328 /* Import Tyoes fot ILF format object files..  */
329 #define IMPORT_CODE	0
330 #define IMPORT_DATA	1
331 #define IMPORT_CONST	2
332 
333 /* Import Name Tyoes for ILF format object files.  */
334 #define IMPORT_ORDINAL		0
335 #define IMPORT_NAME		1
336 #define IMPORT_NAME_NOPREFIX	2
337 #define IMPORT_NAME_UNDECORATE	3
338 
339 /* Weak external characteristics.  */
340 #define IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY	1
341 #define IMAGE_WEAK_EXTERN_SEARCH_LIBRARY	2
342 #define IMAGE_WEAK_EXTERN_SEARCH_ALIAS		3
343 
344 /* Bigobj header.  */
345 struct external_ANON_OBJECT_HEADER_BIGOBJ
346 {
347   /* ANON_OBJECT_HEADER_V2 header.  */
348   char Sig1[2];
349   char Sig2[2];
350   char Version[2];
351   char Machine[2];
352   char TimeDateStamp[4];
353   char ClassID[16];
354   char SizeOfData[4];
355   char Flags[4];
356   char MetaDataSize[4];
357   char MetaDataOffset[4];
358 
359   /* BIGOBJ specific.  */
360   char NumberOfSections[4];
361   char PointerToSymbolTable[4];
362   char NumberOfSymbols[4];
363 };
364 
365 #define FILHSZ_BIGOBJ (14 * 4)
366 
367 struct external_SYMBOL_EX
368 {
369   union
370   {
371     char e_name[E_SYMNMLEN];
372 
373     struct
374     {
375       char e_zeroes[4];
376       char e_offset[4];
377     } e;
378   } e;
379 
380   char e_value[4];
381   char e_scnum[4];
382   char e_type[2];
383   char e_sclass[1];
384   char e_numaux[1];
385 } ATTRIBUTE_PACKED ;
386 
387 #define	SYMENT_BIGOBJ	struct external_SYMBOL_EX
388 #define	SYMESZ_BIGOBJ	20
389 
390 #define FILNMLEN_BIGOBJ	20
391 
392 union external_AUX_SYMBOL_EX
393 {
394   struct
395   {
396     char WeakDefaultSymIndex[4];
397     char WeakSearchType[4];
398     char rgbReserved[12];
399   } Sym;
400 
401   struct
402   {
403     char Name[FILNMLEN_BIGOBJ];
404   } File;
405 
406   struct
407   {
408     char Length[4];		/* Section length.  */
409     char NumberOfRelocations[2];/* # relocation entries.  */
410     char NumberOfLinenumbers[2];/* # line numbers.  */
411     char Checksum[4];		/* Section COMDAT checksum.  */
412     char Number[2];	   	/* COMDAT associated section index.  */
413     char Selection[1];		/* COMDAT selection number.  */
414     char bReserved[1];
415     char HighNumber[2];         /* High bits of COMDAT associated sec.  */
416     char rgbReserved[2];
417   } Section;
418 } ATTRIBUTE_PACKED;
419 
420 #define	AUXENT_BIGOBJ	union external_AUX_SYMBOL_EX
421 #define	AUXESZ_BIGOBJ	20
422 
423 /* .pdata/.xdata defines and structures for x64 PE+ for exception handling.  */
424 
425 /* .pdata in exception directory.  */
426 
427 struct pex64_runtime_function
428 {
429   bfd_vma rva_BeginAddress;
430   bfd_vma rva_EndAddress;
431   bfd_vma rva_UnwindData;
432 };
433 
434 struct external_pex64_runtime_function
435 {
436   bfd_byte rva_BeginAddress[4];
437   bfd_byte rva_EndAddress[4];
438   bfd_byte rva_UnwindData[4];
439 };
440 
441 /* If the lowest significant bit is set for rva_UnwindData RVA, it
442    means that the unified RVA points to another pex64_runtime_function
443    that this entry shares the unwind_info block with.  */
444 #define PEX64_IS_RUNTIME_FUNCTION_CHAINED(PTR_RTF) \
445   (((PTR_RTF)->rva_UnwindData & 1) != 0)
446 #define PEX64_GET_UNWINDDATA_UNIFIED_RVA(PTR_RTF) \
447   ((PTR_RTF)->rva_UnwindData & ~1)
448 
449 /* The unwind codes.  */
450 #define UWOP_PUSH_NONVOL      0
451 #define UWOP_ALLOC_LARGE      1
452 #define UWOP_ALLOC_SMALL      2
453 #define UWOP_SET_FPREG	      3
454 #define UWOP_SAVE_NONVOL      4
455 #define UWOP_SAVE_NONVOL_FAR  5
456 #define UWOP_SAVE_XMM         6 /* For version 1.  */
457 #define UWOP_EPILOG           6 /* For version 2.  */
458 #define UWOP_SAVE_XMM_FAR     7 /* For version 1 (deprecated).  */
459 #define UWOP_SPARE            7 /* For version 2.  */
460 #define UWOP_SAVE_XMM128      8
461 #define UWOP_SAVE_XMM128_FAR  9
462 #define UWOP_PUSH_MACHFRAME   10
463 
464 struct pex64_unwind_code
465 {
466   bfd_vma prologue_offset;
467   /* Contains Frame offset, or frame allocation size.  */
468   bfd_vma frame_addr;
469   unsigned int uwop_code : 4;
470   /* xmm, mm, or standard register from 0 - 15.  */
471   unsigned int reg : 4;
472   /* Used for UWOP_PUSH_MACHFRAME to indicate optional errorcode stack
473      argument.  */
474   unsigned int has_errorcode : 1;
475 };
476 
477 struct external_pex64_unwind_code
478 {
479   bfd_byte dta[2];
480 };
481 
482 #define PEX64_UNWCODE_CODE(VAL)	((VAL) & 0xf)
483 #define PEX64_UNWCODE_INFO(VAL) (((VAL) >> 4) & 0xf)
484 
485 /* The unwind info.  */
486 #define UNW_FLAG_NHANDLER     0
487 #define UNW_FLAG_EHANDLER     1
488 #define UNW_FLAG_UHANDLER     2
489 #define UNW_FLAG_FHANDLER     3
490 #define UNW_FLAG_CHAININFO    4
491 
492 #define UNW_FLAG_MASK	      0x1f
493 
494 struct pex64_unwind_info
495 {
496   bfd_vma SizeOfBlock;
497   bfd_byte Version; /* Values from 0 up to 7 are possible.  */
498   bfd_byte Flags; /* Values from 0 up to 31 are possible.  */
499   bfd_vma SizeOfPrologue;
500   bfd_vma CountOfCodes; /* Amount of pex64_unwind_code elements.  */
501   /* 0 = CFA, 1..15 are index of integer registers.  */
502   unsigned int FrameRegister : 4;
503   bfd_vma FrameOffset;
504   bfd_vma sizeofUnwindCodes;
505   bfd_byte *rawUnwindCodes;
506   bfd_byte *rawUnwindCodesEnd;
507   bfd_vma rva_ExceptionHandler; /* UNW_EHANDLER or UNW_FLAG_UHANDLER.  */
508   bfd_vma rva_BeginAddress;	/* UNW_FLAG_CHAININFO.  */
509   bfd_vma rva_EndAddress;	/* UNW_FLAG_CHAININFO.  */
510   bfd_vma rva_UnwindData;	/* UNW_FLAG_CHAININFO.  */
511 };
512 
513 struct external_pex64_unwind_info
514 {
515   bfd_byte Version_Flags;
516   bfd_byte SizeOfPrologue;
517   bfd_byte CountOfCodes;
518   bfd_byte FrameRegisterOffset;
519   /* external_pex64_unwind_code array.  */
520   /* bfd_byte handler[4];  */
521   /* Optional language specific data.  */
522 };
523 
524 struct external_pex64_scope
525 {
526   bfd_vma Count;
527 };
528 
529 struct pex64_scope
530 {
531   bfd_byte Count[4];
532 };
533 
534 struct pex64_scope_entry
535 {
536   bfd_vma rva_BeginAddress;
537   bfd_vma rva_EndAddress;
538   bfd_vma rva_HandlerAddress;
539   bfd_vma rva_JumpAddress;
540 };
541 #define PEX64_SCOPE_ENTRY_SIZE	16
542 
543 struct external_pex64_scope_entry
544 {
545   bfd_byte rva_BeginAddress[4];
546   bfd_byte rva_EndAddress[4];
547   bfd_byte rva_HandlerAddress[4];
548   bfd_byte rva_JumpAddress[4];
549 };
550 
551 #define PEX64_UWI_VERSION(VAL)	((VAL) & 7)
552 #define PEX64_UWI_FLAGS(VAL)	(((VAL) >> 3) & 0x1f)
553 #define PEX64_UWI_FRAMEREG(VAL)	((VAL) & 0xf)
554 #define PEX64_UWI_FRAMEOFF(VAL)	(((VAL) >> 4) & 0xf)
555 #define PEX64_UWI_SIZEOF_UWCODE_ARRAY(VAL) \
556   ((((VAL) + 1) & ~1) * 2)
557 
558 #define PEX64_OFFSET_TO_UNWIND_CODE 0x4
559 
560 #define PEX64_OFFSET_TO_HANDLER_RVA (COUNTOFUNWINDCODES) \
561   (PEX64_OFFSET_TO_UNWIND_CODE + \
562    PEX64_UWI_SIZEOF_UWCODE_ARRAY(COUNTOFUNWINDCODES))
563 
564 #define PEX64_OFFSET_TO_SCOPE_COUNT(COUNTOFUNWINDCODES) \
565   (PEX64_OFFSET_TO_HANDLER_RVA(COUNTOFUNWINDCODES) + 4)
566 
567 #define PEX64_SCOPE_ENTRY(COUNTOFUNWINDCODES, IDX) \
568   (PEX64_OFFSET_TO_SCOPE_COUNT(COUNTOFUNWINDCODES) + \
569    PEX64_SCOPE_ENTRY_SIZE * (IDX))
570 
571 /* Extra structure used in debug directory.  */
572 struct external_IMAGE_DEBUG_DIRECTORY
573 {
574   char Characteristics[4];
575   char TimeDateStamp[4];
576   char MajorVersion[2];
577   char MinorVersion[2];
578   char Type[4];
579   char SizeOfData[4];
580   char AddressOfRawData[4];
581   char PointerToRawData[4];
582 };
583 
584 /* Extra structures used in codeview debug record.  */
585 /* This is not part of the PE specification.  */
586 
587 #define CVINFO_PDB70_CVSIGNATURE 0x53445352 /* "RSDS" */
588 #define CVINFO_PDB20_CVSIGNATURE 0x3031424e /* "NB10" */
589 #define CVINFO_CV50_CVSIGNATURE  0x3131424e /* "NB11" */
590 #define CVINFO_CV41_CVSIGNATURE  0x3930424e /* "NB09" */
591 
592 typedef struct _CV_INFO_PDB70
593 {
594   char CvSignature[4];
595   char Signature[16];
596   char Age[4];
597   char PdbFileName[];
598 } CV_INFO_PDB70;
599 
600 typedef struct _CV_INFO_PDB20
601 {
602   char CvHeader[4];
603   char Offset[4];
604   char Signature[4];
605   char Age[4];
606   char PdbFileName[];
607 } CV_INFO_PDB20;
608 
609 #endif /* _PE_H */
610