1 /* pdb.h - header file for generating PDB CodeView debugging files.
2 Copyright (C) 2022 Free Software Foundation, Inc.
4 This file is part of the GNU Binutils.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
19 MA 02110-1301, USA. */
21 /* Header files referred to below can be found in Microsoft's PDB
22 repository: https://github.com/microsoft/microsoft-pdb. */
32 #define LF_VTSHAPE 0x000a
33 #define LF_MODIFIER 0x1001
34 #define LF_POINTER 0x1002
35 #define LF_PROCEDURE 0x1008
36 #define LF_MFUNCTION 0x1009
37 #define LF_ARGLIST 0x1201
38 #define LF_FIELDLIST 0x1203
39 #define LF_BITFIELD 0x1205
40 #define LF_METHODLIST 0x1206
41 #define LF_BCLASS 0x1400
42 #define LF_VBCLASS 0x1401
43 #define LF_IVBCLASS 0x1402
44 #define LF_INDEX 0x1404
45 #define LF_VFUNCTAB 0x1409
46 #define LF_ENUMERATE 0x1502
47 #define LF_ARRAY 0x1503
48 #define LF_CLASS 0x1504
49 #define LF_STRUCTURE 0x1505
50 #define LF_UNION 0x1506
51 #define LF_ENUM 0x1507
52 #define LF_MEMBER 0x150d
53 #define LF_STMEMBER 0x150e
54 #define LF_METHOD 0x150f
55 #define LF_NESTTYPE 0x1510
56 #define LF_ONEMETHOD 0x1511
57 #define LF_FUNC_ID 0x1601
58 #define LF_MFUNC_ID 0x1602
59 #define LF_BUILDINFO 0x1603
60 #define LF_SUBSTR_LIST 0x1604
61 #define LF_STRING_ID 0x1605
62 #define LF_UDT_SRC_LINE 0x1606
63 #define LF_UDT_MOD_SRC_LINE 0x1607
65 #define LF_CHAR 0x8000
66 #define LF_SHORT 0x8001
67 #define LF_USHORT 0x8002
68 #define LF_LONG 0x8003
69 #define LF_ULONG 0x8004
70 #define LF_QUADWORD 0x8009
71 #define LF_UQUADWORD 0x800a
74 #define S_FRAMEPROC 0x1012
75 #define S_OBJNAME 0x1101
76 #define S_THUNK32 0x1102
77 #define S_BLOCK32 0x1103
78 #define S_LABEL32 0x1105
79 #define S_REGISTER 0x1106
80 #define S_CONSTANT 0x1107
82 #define S_BPREL32 0x110b
83 #define S_LDATA32 0x110c
84 #define S_GDATA32 0x110d
85 #define S_PUB32 0x110e
86 #define S_LPROC32 0x110f
87 #define S_GPROC32 0x1110
88 #define S_REGREL32 0x1111
89 #define S_LTHREAD32 0x1112
90 #define S_GTHREAD32 0x1113
91 #define S_UNAMESPACE 0x1124
92 #define S_PROCREF 0x1125
93 #define S_LPROCREF 0x1127
94 #define S_FRAMECOOKIE 0x113a
95 #define S_COMPILE3 0x113c
96 #define S_ENVBLOCK 0x113d
97 #define S_LOCAL 0x113e
98 #define S_DEFRANGE_REGISTER 0x1141
99 #define S_DEFRANGE_FRAMEPOINTER_REL 0x1142
100 #define S_DEFRANGE_SUBFIELD_REGISTER 0x1143
101 #define S_DEFRANGE_FRAMEPOINTER_REL_FULL_SCOPE 0x1144
102 #define S_DEFRANGE_REGISTER_REL 0x1145
103 #define S_LPROC32_ID 0x1146
104 #define S_GPROC32_ID 0x1147
105 #define S_BUILDINFO 0x114c
106 #define S_INLINESITE 0x114d
107 #define S_INLINESITE_END 0x114e
108 #define S_PROC_ID_END 0x114f
109 #define S_HEAPALLOCSITE 0x115e
111 /* PDBStream70 in pdb1.h */
120 #define PDB_STREAM_VERSION_VC70 20000404
121 #define PDB_STREAM_VERSION_VC140 20140508
124 struct pdb_tpi_stream_header
127 uint32_t header_size;
128 uint32_t type_index_begin;
129 uint32_t type_index_end;
130 uint32_t type_record_bytes;
131 uint16_t hash_stream_index;
132 uint16_t hash_aux_stream_index;
133 uint32_t hash_key_size;
134 uint32_t num_hash_buckets;
135 uint32_t hash_value_buffer_offset;
136 uint32_t hash_value_buffer_length;
137 uint32_t index_offset_buffer_offset;
138 uint32_t index_offset_buffer_length;
139 uint32_t hash_adj_buffer_offset;
140 uint32_t hash_adj_buffer_length;
143 #define TPI_STREAM_VERSION_80 20040203
145 #define TPI_FIRST_INDEX 0x1000
146 #define NUM_TPI_HASH_BUCKETS 0x3ffff
148 #define NUM_GLOBALS_HASH_BUCKETS 4096
150 /* NewDBIHdr in dbi.h */
151 struct pdb_dbi_stream_header
153 uint32_t version_signature;
154 uint32_t version_header;
156 uint16_t global_stream_index;
157 uint16_t build_number;
158 uint16_t public_stream_index;
159 uint16_t pdb_dll_version;
160 uint16_t sym_record_stream;
161 uint16_t pdb_dll_rbld;
162 uint32_t mod_info_size;
163 uint32_t section_contribution_size;
164 uint32_t section_map_size;
165 uint32_t source_info_size;
166 uint32_t type_server_map_size;
167 uint32_t mfc_type_server_index;
168 uint32_t optional_dbg_header_size;
169 uint32_t ec_substream_size;
175 #define DBI_STREAM_VERSION_70 19990903
177 /* PSGSIHDR in gsi.h */
178 struct publics_header
180 uint32_t sym_hash_size;
181 uint32_t addr_map_size;
183 uint32_t thunks_size;
184 uint32_t thunk_table;
185 uint32_t thunk_table_offset;
189 /* GSIHashHdr in gsi.h */
190 struct globals_hash_header
194 uint32_t entries_size;
195 uint32_t buckets_size;
198 /* HRFile in gsi.h */
205 #define GLOBALS_HASH_SIGNATURE 0xffffffff
206 #define GLOBALS_HASH_VERSION_70 0xf12f091a
208 /* PUBSYM32 in cvinfo.h */
211 uint16_t record_length;
212 uint16_t record_type;
216 /* followed by null-terminated string */
219 /* see bitset CV_PUBSYMFLAGS in cvinfo.h */
220 #define PUBSYM_FUNCTION 0x2
222 struct optional_dbg_header
225 uint16_t exception_stream;
226 uint16_t fixup_stream;
227 uint16_t omap_to_src_stream;
228 uint16_t omap_from_src_stream;
229 uint16_t section_header_stream;
230 uint16_t token_map_stream;
231 uint16_t xdata_stream;
232 uint16_t pdata_stream;
233 uint16_t new_fpo_stream;
234 uint16_t orig_section_header_stream;
237 #define CV_SIGNATURE_C13 4
239 #define DEBUG_S_SYMBOLS 0xf1
240 #define DEBUG_S_LINES 0xf2
241 #define DEBUG_S_STRINGTABLE 0xf3
242 #define DEBUG_S_FILECHKSMS 0xf4
244 #define STRING_TABLE_SIGNATURE 0xeffeeffe
245 #define STRING_TABLE_VERSION 1
248 struct string_table_header
254 #define SECTION_CONTRIB_VERSION_60 0xf12eba2d
256 /* SC in dbicommon.h */
257 struct section_contribution
263 uint32_t characteristics;
264 uint16_t module_index;
270 /* MODI_60_Persist in dbi.h */
274 struct section_contribution sc;
276 uint16_t module_sym_stream;
277 uint32_t sym_byte_size;
278 uint32_t c11_byte_size;
279 uint32_t c13_byte_size;
280 uint16_t source_file_count;
283 uint32_t source_file_name_index;
284 uint32_t pdb_file_path_name_index;
287 /* filedata in dumpsym7.cpp */
291 uint8_t checksum_length;
292 uint8_t checksum_type;
295 /* lfModifier in cvinfo.h */
305 /* lfPointer in cvinfo.h */
314 /* lfArgList in cvinfo.h (used for both LF_ARGLIST and LF_SUBSTR_LIST) */
319 uint32_t num_entries;
323 /* lfProc in cvinfo.h */
328 uint32_t return_type;
329 uint8_t calling_convention;
331 uint16_t num_parameters;
335 /* lfMFunc in cvinfo.h */
340 uint32_t return_type;
341 uint32_t containing_class_type;
343 uint8_t calling_convention;
345 uint16_t num_parameters;
347 int32_t this_adjustment;
350 /* lfArray in cvinfo.h */
355 uint32_t element_type;
357 uint16_t length_in_bytes;
361 /* lfBitfield in cvinfo.h */
371 /* lfMember in cvinfo.h */
381 /* from bitfield structure CV_prop_t in cvinfo.h */
382 #define CV_PROP_FORWARD_REF 0x80
383 #define CV_PROP_SCOPED 0x100
384 #define CV_PROP_HAS_UNIQUE_NAME 0x200
386 /* lfClass in cvinfo.h */
391 uint16_t num_members;
394 uint32_t derived_from;
400 /* lfUnion in cvinfo.h */
405 uint16_t num_members;
412 /* lfEnumerate in cvinfo.h */
418 /* then actual value if value >= 0x8000 */
422 /* lfEnum in cvinfo.h */
427 uint16_t num_elements;
429 uint32_t underlying_type;
434 /* lfIndex in cvinfo.h */
442 /* lfOneMethod in cvinfo.h */
446 uint16_t method_attribute;
447 uint32_t method_type;
451 /* mlMethod in cvinfo.h */
452 struct lf_methodlist_entry
454 uint16_t method_attribute;
456 uint32_t method_type;
459 /* lfMethodList in cvinfo.h */
464 struct lf_methodlist_entry entries[];
467 /* lfMethod in cvinfo.h */
472 uint32_t method_list;
476 /* lfBClass in cvinfo.h */
481 uint32_t base_class_type;
485 /* lfVFuncTab in cvinfo.h */
493 /* lfVBClass in cvinfo.h */
498 uint32_t base_class_type;
499 uint32_t virtual_base_pointer_type;
500 uint16_t virtual_base_pointer_offset;
501 uint16_t virtual_base_vbtable_offset;
504 /* lfSTMember in cvinfo.h */
505 struct lf_static_member
513 /* lfNestType in cvinfo.h */
522 /* lfStringId in cvinfo.h */
531 /* lfBuildInfo in cvinfo.h */
540 /* lfFuncId in cvinfo.h */
545 uint32_t parent_scope;
546 uint32_t function_type;
550 /* lfMFuncId in cvinfo.h */
555 uint32_t parent_type;
556 uint32_t function_type;
560 /* lfUdtSrcLine in cvinfo.h */
561 struct lf_udt_src_line
566 uint32_t source_file_type;
570 /* lfUdtModSrcLine in cvinfo.h */
571 struct lf_udt_mod_src_line
576 uint32_t source_file_string;
581 /* DATASYM32 in cvinfo.h */
592 /* PROCSYM32 in cvinfo.h */
601 uint32_t debug_start;
610 /* REFSYM2 in cvinfo.h */
616 uint32_t symbol_offset;
621 /* UDTSYM in cvinfo.h */
630 /* CONSTSYM in cvinfo.h */
637 /* then actual value if value >= 0x8000 */
641 /* BUILDINFOSYM in cvinfo.h */
649 /* BLOCKSYM32 in cvinfo.h */
662 /* BPRELSYM32 in cvinfo.h */
672 /* REGSYM in cvinfo.h */
682 /* REGREL32 in cvinfo.h */
693 /* LOCALSYM in cvinfo.h */
703 /* CV_LVAR_ADDR_RANGE in cvinfo.h */
704 struct lvar_addr_range
711 /* CV_LVAR_ADDR_GAP in cvinfo.h */
712 struct lvar_addr_gap {
717 /* DEFRANGESYMREGISTERREL in cvinfo.h */
718 struct defrange_register_rel
723 uint16_t offset_parent;
724 uint32_t offset_register;
725 struct lvar_addr_range range;
726 struct lvar_addr_gap gaps[];
729 /* DEFRANGESYMFRAMEPOINTERREL in cvinfo.h */
730 struct defrange_framepointer_rel
735 struct lvar_addr_range range;
736 struct lvar_addr_gap gaps[];
739 /* DEFRANGESYMSUBFIELDREGISTER in cvinfo.h */
740 struct defrange_subfield_register
746 uint32_t offset_parent;
747 struct lvar_addr_range range;
748 struct lvar_addr_gap gaps[];
751 /* DEFRANGESYMREGISTER in cvinfo.h */
752 struct defrange_register
758 struct lvar_addr_range range;
759 struct lvar_addr_gap gaps[];
762 /* INLINESITESYM in cvinfo.h */
770 uint8_t binary_annotations[];
773 /* THUNKSYM32 in cvinfo.h */
788 /* HEAPALLOCSITE in cvinfo.h */
789 struct heap_alloc_site
799 /* OBJNAMESYM in cvinfo.h */
808 #define CV_CFL_80386 0x03
809 #define CV_CFL_X64 0xD0
811 #define CV_CFL_LINK 0x07
813 /* COMPILESYM3 in cvinfo.h */
820 uint16_t frontend_major;
821 uint16_t frontend_minor;
822 uint16_t frontend_build;
823 uint16_t frontend_qfe;
824 uint16_t backend_major;
825 uint16_t backend_minor;
826 uint16_t backend_build;
827 uint16_t backend_qfe;
831 /* ENVBLOCKSYM in cvinfo.h */
840 extern bool create_pdb_file (bfd *, const char *, const unsigned char *);