ld/pdb.h

   1 /* pdb.h - header file for generating PDB CodeView debugging files.
   2    Copyright (C) 2022 Free Software Foundation, Inc.
   3
   4    This file is part of the GNU Binutils.
   5
   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.
  10
  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.
  15
  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.  */
  20
  21 /* Header files referred to below can be found in Microsoft's PDB
  22    repository: https://github.com/microsoft/microsoft-pdb.  */
  23
  24 #ifndef PDB_H
  25 #define PDB_H
  26
  27 #include "sysdep.h"
  28 #include "bfd.h"
  29 #include <stdbool.h>
  30 #include <stddef.h>
  31
  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
  64
  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
  72
  73 #define S_PUB32                         0x110e
  74
  75 /* PDBStream70 in pdb1.h */
  76 struct pdb_stream_70
  77 {
  78   uint32_t version;
  79   uint32_t signature;
  80   uint32_t age;
  81   uint8_t guid[16];
  82 };
  83
  84 #define PDB_STREAM_VERSION_VC70         20000404
  85 #define PDB_STREAM_VERSION_VC140        20140508
  86
  87 /* HDR in tpi.h */
  88 struct pdb_tpi_stream_header
  89 {
  90   uint32_t version;
  91   uint32_t header_size;
  92   uint32_t type_index_begin;
  93   uint32_t type_index_end;
  94   uint32_t type_record_bytes;
  95   uint16_t hash_stream_index;
  96   uint16_t hash_aux_stream_index;
  97   uint32_t hash_key_size;
  98   uint32_t num_hash_buckets;
  99   uint32_t hash_value_buffer_offset;
 100   uint32_t hash_value_buffer_length;
 101   uint32_t index_offset_buffer_offset;
 102   uint32_t index_offset_buffer_length;
 103   uint32_t hash_adj_buffer_offset;
 104   uint32_t hash_adj_buffer_length;
 105 };
 106
 107 #define TPI_STREAM_VERSION_80           20040203
 108
 109 #define TPI_FIRST_INDEX                 0x1000
 110 #define NUM_TPI_HASH_BUCKETS            0x3ffff
 111
 112 /* NewDBIHdr in dbi.h */
 113 struct pdb_dbi_stream_header
 114 {
 115   uint32_t version_signature;
 116   uint32_t version_header;
 117   uint32_t age;
 118   uint16_t global_stream_index;
 119   uint16_t build_number;
 120   uint16_t public_stream_index;
 121   uint16_t pdb_dll_version;
 122   uint16_t sym_record_stream;
 123   uint16_t pdb_dll_rbld;
 124   uint32_t mod_info_size;
 125   uint32_t section_contribution_size;
 126   uint32_t section_map_size;
 127   uint32_t source_info_size;
 128   uint32_t type_server_map_size;
 129   uint32_t mfc_type_server_index;
 130   uint32_t optional_dbg_header_size;
 131   uint32_t ec_substream_size;
 132   uint16_t flags;
 133   uint16_t machine;
 134   uint32_t padding;
 135 };
 136
 137 #define DBI_STREAM_VERSION_70           19990903
 138
 139 /* PSGSIHDR in gsi.h */
 140 struct publics_header
 141 {
 142   uint32_t sym_hash_size;
 143   uint32_t addr_map_size;
 144   uint32_t num_thunks;
 145   uint32_t thunks_size;
 146   uint32_t thunk_table;
 147   uint32_t thunk_table_offset;
 148   uint32_t num_sects;
 149 };
 150
 151 /* GSIHashHdr in gsi.h */
 152 struct globals_hash_header
 153 {
 154   uint32_t signature;
 155   uint32_t version;
 156   uint32_t entries_size;
 157   uint32_t buckets_size;
 158 };
 159
 160 /* HRFile in gsi.h */
 161 struct hash_record
 162 {
 163   uint32_t offset;
 164   uint32_t reference;
 165 };
 166
 167 #define GLOBALS_HASH_SIGNATURE          0xffffffff
 168 #define GLOBALS_HASH_VERSION_70         0xf12f091a
 169
 170 /* PUBSYM32 in cvinfo.h */
 171 struct pubsym
 172 {
 173   uint16_t record_length;
 174   uint16_t record_type;
 175   uint32_t flags;
 176   uint32_t offset;
 177   uint16_t section;
 178   /* followed by null-terminated string */
 179 } ATTRIBUTE_PACKED;
 180
 181 /* see bitset CV_PUBSYMFLAGS in cvinfo.h */
 182 #define PUBSYM_FUNCTION                 0x2
 183
 184 struct optional_dbg_header
 185 {
 186   uint16_t fpo_stream;
 187   uint16_t exception_stream;
 188   uint16_t fixup_stream;
 189   uint16_t omap_to_src_stream;
 190   uint16_t omap_from_src_stream;
 191   uint16_t section_header_stream;
 192   uint16_t token_map_stream;
 193   uint16_t xdata_stream;
 194   uint16_t pdata_stream;
 195   uint16_t new_fpo_stream;
 196   uint16_t orig_section_header_stream;
 197 };
 198
 199 #define CV_SIGNATURE_C13                4
 200
 201 #define DEBUG_S_LINES                   0xf2
 202 #define DEBUG_S_STRINGTABLE             0xf3
 203 #define DEBUG_S_FILECHKSMS              0xf4
 204
 205 #define STRING_TABLE_SIGNATURE          0xeffeeffe
 206 #define STRING_TABLE_VERSION            1
 207
 208 /* VHdr in nmt.h */
 209 struct string_table_header
 210 {
 211   uint32_t signature;
 212   uint32_t version;
 213 };
 214
 215 #define SECTION_CONTRIB_VERSION_60      0xf12eba2d
 216
 217 /* SC in dbicommon.h */
 218 struct section_contribution
 219 {
 220   uint16_t section;
 221   uint16_t padding1;
 222   uint32_t offset;
 223   uint32_t size;
 224   uint32_t characteristics;
 225   uint16_t module_index;
 226   uint16_t padding2;
 227   uint32_t data_crc;
 228   uint32_t reloc_crc;
 229 };
 230
 231 /* MODI_60_Persist in dbi.h */
 232 struct module_info
 233 {
 234   uint32_t unused1;
 235   struct section_contribution sc;
 236   uint16_t flags;
 237   uint16_t module_sym_stream;
 238   uint32_t sym_byte_size;
 239   uint32_t c11_byte_size;
 240   uint32_t c13_byte_size;
 241   uint16_t source_file_count;
 242   uint16_t padding;
 243   uint32_t unused2;
 244   uint32_t source_file_name_index;
 245   uint32_t pdb_file_path_name_index;
 246 };
 247
 248 /* filedata in dumpsym7.cpp */
 249 struct file_checksum
 250 {
 251   uint32_t file_id;
 252   uint8_t checksum_length;
 253   uint8_t checksum_type;
 254 } ATTRIBUTE_PACKED;
 255
 256 /* lfModifier in cvinfo.h */
 257 struct lf_modifier
 258 {
 259   uint16_t size;
 260   uint16_t kind;
 261   uint32_t base_type;
 262   uint16_t modifier;
 263   uint16_t padding;
 264 } ATTRIBUTE_PACKED;
 265
 266 /* lfPointer in cvinfo.h */
 267 struct lf_pointer
 268 {
 269   uint16_t size;
 270   uint16_t kind;
 271   uint32_t base_type;
 272   uint32_t attributes;
 273 } ATTRIBUTE_PACKED;
 274
 275 /* lfArgList in cvinfo.h (used for both LF_ARGLIST and LF_SUBSTR_LIST) */
 276 struct lf_arglist
 277 {
 278   uint16_t size;
 279   uint16_t kind;
 280   uint32_t num_entries;
 281   uint32_t args[];
 282 } ATTRIBUTE_PACKED;
 283
 284 /* lfProc in cvinfo.h */
 285 struct lf_procedure
 286 {
 287   uint16_t size;
 288   uint16_t kind;
 289   uint32_t return_type;
 290   uint8_t calling_convention;
 291   uint8_t attributes;
 292   uint16_t num_parameters;
 293   uint32_t arglist;
 294 } ATTRIBUTE_PACKED;
 295
 296 /* lfMFunc in cvinfo.h */
 297 struct lf_mfunction
 298 {
 299   uint16_t size;
 300   uint16_t kind;
 301   uint32_t return_type;
 302   uint32_t containing_class_type;
 303   uint32_t this_type;
 304   uint8_t calling_convention;
 305   uint8_t attributes;
 306   uint16_t num_parameters;
 307   uint32_t arglist;
 308   int32_t this_adjustment;
 309 } ATTRIBUTE_PACKED;
 310
 311 /* lfArray in cvinfo.h */
 312 struct lf_array
 313 {
 314   uint16_t size;
 315   uint16_t kind;
 316   uint32_t element_type;
 317   uint32_t index_type;
 318   uint16_t length_in_bytes;
 319   char name[];
 320 } ATTRIBUTE_PACKED;
 321
 322 /* lfBitfield in cvinfo.h */
 323 struct lf_bitfield
 324 {
 325   uint16_t size;
 326   uint16_t kind;
 327   uint32_t base_type;
 328   uint8_t length;
 329   uint8_t position;
 330 } ATTRIBUTE_PACKED;
 331
 332 /* lfMember in cvinfo.h */
 333 struct lf_member
 334 {
 335   uint16_t kind;
 336   uint16_t attributes;
 337   uint32_t type;
 338   uint16_t offset;
 339   char name[];
 340 } ATTRIBUTE_PACKED;
 341
 342 /* from bitfield structure CV_prop_t in cvinfo.h */
 343 #define CV_PROP_FORWARD_REF     0x80
 344 #define CV_PROP_SCOPED          0x100
 345 #define CV_PROP_HAS_UNIQUE_NAME 0x200
 346
 347 /* lfClass in cvinfo.h */
 348 struct lf_class
 349 {
 350   uint16_t size;
 351   uint16_t kind;
 352   uint16_t num_members;
 353   uint16_t properties;
 354   uint32_t field_list;
 355   uint32_t derived_from;
 356   uint32_t vshape;
 357   uint16_t length;
 358   char name[];
 359 } ATTRIBUTE_PACKED;
 360
 361 /* lfUnion in cvinfo.h */
 362 struct lf_union
 363 {
 364   uint16_t size;
 365   uint16_t kind;
 366   uint16_t num_members;
 367   uint16_t properties;
 368   uint32_t field_list;
 369   uint16_t length;
 370   char name[];
 371 } ATTRIBUTE_PACKED;
 372
 373 /* lfEnumerate in cvinfo.h */
 374 struct lf_enumerate
 375 {
 376   uint16_t kind;
 377   uint16_t attributes;
 378   uint16_t value;
 379   /* then actual value if value >= 0x8000 */
 380   char name[];
 381 } ATTRIBUTE_PACKED;
 382
 383 /* lfEnum in cvinfo.h */
 384 struct lf_enum
 385 {
 386   uint16_t size;
 387   uint16_t kind;
 388   uint16_t num_elements;
 389   uint16_t properties;
 390   uint32_t underlying_type;
 391   uint32_t field_list;
 392   char name[];
 393 } ATTRIBUTE_PACKED;
 394
 395 /* lfIndex in cvinfo.h */
 396 struct lf_index
 397 {
 398   uint16_t kind;
 399   uint16_t padding;
 400   uint32_t index;
 401 } ATTRIBUTE_PACKED;
 402
 403 /* lfOneMethod in cvinfo.h */
 404 struct lf_onemethod
 405 {
 406   uint16_t kind;
 407   uint16_t method_attribute;
 408   uint32_t method_type;
 409   char name[];
 410 } ATTRIBUTE_PACKED;
 411
 412 /* mlMethod in cvinfo.h */
 413 struct lf_methodlist_entry
 414 {
 415   uint16_t method_attribute;
 416   uint16_t padding;
 417   uint32_t method_type;
 418 } ATTRIBUTE_PACKED;
 419
 420 /* lfMethodList in cvinfo.h */
 421 struct lf_methodlist
 422 {
 423   uint16_t size;
 424   uint16_t kind;
 425   struct lf_methodlist_entry entries[];
 426 } ATTRIBUTE_PACKED;
 427
 428 /* lfMethod in cvinfo.h */
 429 struct lf_method
 430 {
 431   uint16_t kind;
 432   uint16_t count;
 433   uint32_t method_list;
 434   char name[];
 435 } ATTRIBUTE_PACKED;
 436
 437 /* lfBClass in cvinfo.h */
 438 struct lf_bclass
 439 {
 440   uint16_t kind;
 441   uint16_t attributes;
 442   uint32_t base_class_type;
 443   uint16_t offset;
 444   uint16_t padding;
 445 } ATTRIBUTE_PACKED;
 446
 447 /* lfVFuncTab in cvinfo.h */
 448 struct lf_vfunctab
 449 {
 450   uint16_t kind;
 451   uint16_t padding;
 452   uint32_t type;
 453 } ATTRIBUTE_PACKED;
 454
 455 /* lfVBClass in cvinfo.h */
 456 struct lf_vbclass
 457 {
 458   uint16_t kind;
 459   uint16_t attributes;
 460   uint32_t base_class_type;
 461   uint32_t virtual_base_pointer_type;
 462   uint16_t virtual_base_pointer_offset;
 463   uint16_t virtual_base_vbtable_offset;
 464 } ATTRIBUTE_PACKED;
 465
 466 /* lfSTMember in cvinfo.h */
 467 struct lf_static_member
 468 {
 469   uint16_t kind;
 470   uint16_t attributes;
 471   uint32_t type;
 472   char name[];
 473 } ATTRIBUTE_PACKED;
 474
 475 /* lfNestType in cvinfo.h */
 476 struct lf_nest_type
 477 {
 478   uint16_t kind;
 479   uint16_t padding;
 480   uint32_t type;
 481   char name[];
 482 } ATTRIBUTE_PACKED;
 483
 484 /* lfStringId in cvinfo.h */
 485 struct lf_string_id
 486 {
 487   uint16_t size;
 488   uint16_t kind;
 489   uint32_t substring;
 490   char string[];
 491 } ATTRIBUTE_PACKED;
 492
 493 /* lfBuildInfo in cvinfo.h */
 494 struct lf_build_info
 495 {
 496   uint16_t size;
 497   uint16_t kind;
 498   uint16_t count;
 499   uint32_t strings[];
 500 } ATTRIBUTE_PACKED;
 501
 502 /* lfFuncId in cvinfo.h */
 503 struct lf_func_id
 504 {
 505   uint16_t size;
 506   uint16_t kind;
 507   uint32_t parent_scope;
 508   uint32_t function_type;
 509   char name[];
 510 } ATTRIBUTE_PACKED;
 511
 512 /* lfMFuncId in cvinfo.h */
 513 struct lf_mfunc_id
 514 {
 515   uint16_t size;
 516   uint16_t kind;
 517   uint32_t parent_type;
 518   uint32_t function_type;
 519   char name[];
 520 } ATTRIBUTE_PACKED;
 521
 522 /* lfUdtSrcLine in cvinfo.h */
 523 struct lf_udt_src_line
 524 {
 525   uint16_t size;
 526   uint16_t kind;
 527   uint32_t type;
 528   uint32_t source_file_type;
 529   uint32_t line_no;
 530 } ATTRIBUTE_PACKED;
 531
 532 /* lfUdtModSrcLine in cvinfo.h */
 533 struct lf_udt_mod_src_line
 534 {
 535   uint16_t size;
 536   uint16_t kind;
 537   uint32_t type;
 538   uint32_t source_file_string;
 539   uint32_t line_no;
 540   uint16_t module_no;
 541 } ATTRIBUTE_PACKED;
 542
 543 extern bool create_pdb_file (bfd *, const char *, const unsigned char *);
 544
 545 #endif