maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/tools/llvm-pdbutil/llvm-pdbutil.h

158 lines
4.5 KiB
C
Raw Normal View History

Rename llvm-pdbdump -> llvm-pdbutil. This is to reflect the evolving nature of the tool as being useful for more than just dumping PDBs, as it can do many other things. Differential Revision: https://reviews.llvm.org/D34062 llvm-svn: 305106
2017-06-10 04:46:17 +08:00
//===- llvm-pdbutil.h ----------------------------------------- *- C++ --*-===//
[llvm-pdbdump] Rewrite dumper using visitor pattern. This increases the flexibility of how to dump different symbol types -- necessary for context-sensitive formatting of symbol types -- and also improves the modularity by allowing the dumping to be implemented in the actual dumper, as opposed to in the PDB library. llvm-svn: 230184
2015-02-23 06:03:38 +08:00
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_TOOLS_LLVMPDBDUMP_LLVMPDBDUMP_H
#define LLVM_TOOLS_LLVMPDBDUMP_LLVMPDBDUMP_H
[pdb] Add command line options for dumping individual streams and blocks I ran into a situation where I wanted to print out the contents of page 6 of a PDB as a binary blob, and there was no straightforward way to do that. In addition to adding that, this patch also adds the ability to dump a stream by index as a binary blob, and it will stitch together all the blocks and dump the whole thing as one seemingly contiguous sequence of bytes. llvm-svn: 281070
2016-09-10 02:17:52 +08:00
#include "llvm/ADT/Optional.h"
[llvm-pdbdump] Many minor fixes and improvements A short list of some of the improvements: 1) Now supports -all command line argument, which implies many other command line arguments to simplify usage. 2) Now supports -no-compiler-generated command line argument to exclude compiler generated types. 3) Prints base class list. 4) -class-definitions implies -types. 5) Proper display of bitfields. 6) Can now distinguish between struct/class/interface/union. And a few other minor tweaks. llvm-svn: 230933
2015-03-02 12:39:56 +08:00
#include "llvm/Support/CommandLine.h"
[llvm-pdbdump] Rewrite dumper using visitor pattern. This increases the flexibility of how to dump different symbol types -- necessary for context-sensitive formatting of symbol types -- and also improves the modularity by allowing the dumping to be implemented in the actual dumper, as opposed to in the PDB library. llvm-svn: 230184
2015-02-23 06:03:38 +08:00
#include "llvm/Support/raw_ostream.h"
[llvm-pdbdump] Add the option to sort functions and data. llvm-svn: 302998
2017-05-14 09:13:40 +08:00
#include <memory>
#include <stdint.h>
namespace llvm {
namespace pdb {
class PDBSymbolData;
class PDBSymbolFunc;
uint32_t getTypeLength(const PDBSymbolData &Symbol);
}
}
[llvm-pdbdump] Many minor fixes and improvements A short list of some of the improvements: 1) Now supports -all command line argument, which implies many other command line arguments to simplify usage. 2) Now supports -no-compiler-generated command line argument to exclude compiler generated types. 3) Prints base class list. 4) -class-definitions implies -types. 5) Proper display of bitfields. 6) Can now distinguish between struct/class/interface/union. And a few other minor tweaks. llvm-svn: 230933
2015-03-02 12:39:56 +08:00
namespace opts {
[llvm-pdbdump] Introduce an abstraction for the output style. This opens the door to introducing a YAML outputter which can be used for machine consumption. Currently the yaml output style is unimplemented and returns an error if you try to use it. Reviewed By: rnk, ruiu Differential Revision: http://reviews.llvm.org/D20967 llvm-svn: 271712
2016-06-04 03:28:33 +08:00
[llvm-pdbdump] Improve consistency among subcommands. The pdb2yaml and raw subcommands did something very similar but with a different output format, and they used a lot of the same command line options, but each one re-implemented the command line option with slightly different spellings / options. This patch merges them together into a single definition which is shared by both subcommands. This new syntax also allows for more flexibility in the way debug subsections are dumped. Differential Revision: https://reviews.llvm.org/D33996 llvm-svn: 305032
2017-06-09 07:39:33 +08:00
enum class ModuleSubsection {
Unknown,
Lines,
FileChecksums,
InlineeLines,
CrossScopeImports,
CrossScopeExports,
[CodeView] Support remaining debug subsection types This adds support for Symbols, StringTable, and FrameData subsection types. Even though these subsections rarely if ever appear in a PDB file (they are usually in object files), there's no theoretical reason why they *couldn't* appear in a PDB. The real issue though is that in order to add support for dumping and writing them (which will be useful for object files), we need a way to test them. And since there is no support for reading and writing them to / from object files yet, making PDB support them is the best way to both add support for the underlying format and add support for tests at the same time. Later, when we go to add support for reading / writing them from object files, we'll need only minimal changes in the underlying read/write code. llvm-svn: 305037
2017-06-09 08:28:08 +08:00
StringTable,
Symbols,
FrameData,
[pdb] Support CoffSymbolRVA debug subsection. llvm-svn: 305108
2017-06-10 04:46:52 +08:00
CoffSymbolRVAs,
[llvm-pdbdump] Improve consistency among subcommands. The pdb2yaml and raw subcommands did something very similar but with a different output format, and they used a lot of the same command line options, but each one re-implemented the command line option with slightly different spellings / options. This patch merges them together into a single definition which is shared by both subcommands. This new syntax also allows for more flexibility in the way debug subsections are dumped. Differential Revision: https://reviews.llvm.org/D33996 llvm-svn: 305032
2017-06-09 07:39:33 +08:00
All
};
Revert "[llvm-pdbutil] rewrite the "raw" output style." This reverts commit 83ea17ebf2106859a51fbc2a86031b44d33696ad. This is failing due to some strange template problems, so reverting until it can be straightened out. llvm-svn: 305505
2017-06-16 04:55:51 +08:00
bool checkModuleSubsection(ModuleSubsection Kind);
template <typename... Ts>
bool checkModuleSubsection(ModuleSubsection K1, ModuleSubsection K2,
Ts &&... Rest) {
return checkModuleSubsection(K1) ||
checkModuleSubsection(K2, std::forward<Ts>(Rest)...);
}
Update llvm-pdbdump to use subcommands. llvm-svn: 274247
2016-07-01 01:42:48 +08:00
namespace pretty {
[llvm-pdbdump] Display padding bytes on record layout When dumping classes, show where padding occurs, and at the end of the class print statistics about how many bytes total of padding exist in a class. Since PDB doesn't specifically contain information about padding, we have to mimic this by sort of reversing a small portion of the record layout algorithm (e.g. looking at offsets and sizes and trying to determine whether something is part of the same field or a new field). Differential Revision: https://reviews.llvm.org/D31800 llvm-svn: 299869
2017-04-11 03:33:29 +08:00
[llvm-pdbdump] Merge functionality of graphical and text dumpers. The *real* difference between these two was that a) The "graphical" dumper could recurse, while the text one could not. b) The "text" dumper could display nested types and functions, while the graphical one could not. Merge these two so that there is only one dumper that can recurse arbitrarily deep and optionally display nested types or not. llvm-svn: 301204
2017-04-25 01:47:52 +08:00
enum class ClassDefinitionFormat { None, Layout, All };
[llvm-pdbdump] Allow sorting / filtering by immediate padding llvm-svn: 301358
2017-04-26 04:22:29 +08:00
enum class ClassSortMode {
None,
Name,
Size,
Padding,
PaddingPct,
PaddingImmediate,
PaddingPctImmediate
};
Allow specification of what kinds of class members to dump. Previously when dumping class definitions, there were only two modes - on or off. But it's useful to sometimes get a little more fine-grained. For example, you might only want to see the record layout (for example to look for extraneous padding). This patch adds a third mode, layout mode, which does exactly that. Only this-relative data members are displayed in this mode. Differential Revision: https://reviews.llvm.org/D31794 llvm-svn: 299733
2017-04-07 07:43:39 +08:00
[llvm-pdbdump] Add the option to sort functions and data. llvm-svn: 302998
2017-05-14 09:13:40 +08:00
enum class SymbolSortMode { None, Name, Size };
enum class SymLevel { Functions, Data, Thunks, All };
bool shouldDumpSymLevel(SymLevel Level);
bool compareFunctionSymbols(
const std::unique_ptr<llvm::pdb::PDBSymbolFunc> &F1,
const std::unique_ptr<llvm::pdb::PDBSymbolFunc> &F2);
bool compareDataSymbols(const std::unique_ptr<llvm::pdb::PDBSymbolData> &F1,
const std::unique_ptr<llvm::pdb::PDBSymbolData> &F2);
[llvm-pdbdump] Many minor fixes and improvements A short list of some of the improvements: 1) Now supports -all command line argument, which implies many other command line arguments to simplify usage. 2) Now supports -no-compiler-generated command line argument to exclude compiler generated types. 3) Prints base class list. 4) -class-definitions implies -types. 5) Proper display of bitfields. 6) Can now distinguish between struct/class/interface/union. And a few other minor tweaks. llvm-svn: 230933
2015-03-02 12:39:56 +08:00
extern llvm::cl::opt<bool> Compilands;
extern llvm::cl::opt<bool> Symbols;
extern llvm::cl::opt<bool> Globals;
[llvm-pdbdump] Allow pretty to only dump specific types of types. Previously we just had the -types option, which would dump all classes, typedefs, and enums. But this produces a lot of output if you only want to view classes, for example. This patch breaks this down into 3 additional options, -classes, -enums, and -typedefs, and keeps the -types option around which implies all 3 more specific options. Differential Revision: https://reviews.llvm.org/D31791 llvm-svn: 299732
2017-04-07 07:43:12 +08:00
extern llvm::cl::opt<bool> Classes;
extern llvm::cl::opt<bool> Enums;
extern llvm::cl::opt<bool> Typedefs;
[llvm-pdbdump] Many minor fixes and improvements A short list of some of the improvements: 1) Now supports -all command line argument, which implies many other command line arguments to simplify usage. 2) Now supports -no-compiler-generated command line argument to exclude compiler generated types. 3) Prints base class list. 4) -class-definitions implies -types. 5) Proper display of bitfields. 6) Can now distinguish between struct/class/interface/union. And a few other minor tweaks. llvm-svn: 230933
2015-03-02 12:39:56 +08:00
extern llvm::cl::opt<bool> All;
Update llvm-pdbdump to use subcommands. llvm-svn: 274247
2016-07-01 01:42:48 +08:00
extern llvm::cl::opt<bool> ExcludeCompilerGenerated;
extern llvm::cl::opt<bool> NoEnumDefs;
extern llvm::cl::list<std::string> ExcludeTypes;
extern llvm::cl::list<std::string> ExcludeSymbols;
extern llvm::cl::list<std::string> ExcludeCompilands;
extern llvm::cl::list<std::string> IncludeTypes;
extern llvm::cl::list<std::string> IncludeSymbols;
extern llvm::cl::list<std::string> IncludeCompilands;
[llvm-pdbdump] Add the option to sort functions and data. llvm-svn: 302998
2017-05-14 09:13:40 +08:00
extern llvm::cl::opt<SymbolSortMode> SymbolOrder;
[llvm-pdbdump] Recursively dump class layout. llvm-svn: 300258
2017-04-14 05:11:00 +08:00
extern llvm::cl::opt<ClassSortMode> ClassOrder;
extern llvm::cl::opt<uint32_t> SizeThreshold;
extern llvm::cl::opt<uint32_t> PaddingThreshold;
[llvm-pdbdump] Allow sorting / filtering by immediate padding llvm-svn: 301358
2017-04-26 04:22:29 +08:00
extern llvm::cl::opt<uint32_t> ImmediatePaddingThreshold;
[llvm-pdbdump] Display padding bytes on record layout When dumping classes, show where padding occurs, and at the end of the class print statistics about how many bytes total of padding exist in a class. Since PDB doesn't specifically contain information about padding, we have to mimic this by sort of reversing a small portion of the record layout algorithm (e.g. looking at offsets and sizes and trying to determine whether something is part of the same field or a new field). Differential Revision: https://reviews.llvm.org/D31800 llvm-svn: 299869
2017-04-11 03:33:29 +08:00
extern llvm::cl::opt<ClassDefinitionFormat> ClassFormat;
[llvm-pdbdump] Merge functionality of graphical and text dumpers. The *real* difference between these two was that a) The "graphical" dumper could recurse, while the text one could not. b) The "text" dumper could display nested types and functions, while the graphical one could not. Merge these two so that there is only one dumper that can recurse arbitrarily deep and optionally display nested types or not. llvm-svn: 301204
2017-04-25 01:47:52 +08:00
extern llvm::cl::opt<uint32_t> ClassRecursionDepth;
Update llvm-pdbdump to use subcommands. llvm-svn: 274247
2016-07-01 01:42:48 +08:00
}
[llvm-pdbdump] Rewrite dumper using visitor pattern. This increases the flexibility of how to dump different symbol types -- necessary for context-sensitive formatting of symbol types -- and also improves the modularity by allowing the dumping to be implemented in the actual dumper, as opposed to in the PDB library. llvm-svn: 230184
2015-02-23 06:03:38 +08:00
Update llvm-pdbdump to use subcommands. llvm-svn: 274247
2016-07-01 01:42:48 +08:00
namespace raw {
[pdb] Add command line options for dumping individual streams and blocks I ran into a situation where I wanted to print out the contents of page 6 of a PDB as a binary blob, and there was no straightforward way to do that. In addition to adding that, this patch also adds the ability to dump a stream by index as a binary blob, and it will stitch together all the blocks and dump the whole thing as one seemingly contiguous sequence of bytes. llvm-svn: 281070
2016-09-10 02:17:52 +08:00
struct BlockRange {
uint32_t Min;
llvm::Optional<uint32_t> Max;
};
extern llvm::Optional<BlockRange> DumpBlockRange;
[llvm-pdbdump] Allow printing only a portion of a stream. When dumping raw data from a stream, you might know the offset of a certain record you're interested in, as well as how long that record is. Previously, you had to dump the entire stream and wade through the bytes to find the interesting record. This patch allows you to specify an offset and length on the command line, and it will only dump the requested range. llvm-svn: 301607
2017-04-28 08:43:38 +08:00
extern llvm::cl::list<std::string> DumpStreamData;
Revert "[llvm-pdbutil] rewrite the "raw" output style." This reverts commit 83ea17ebf2106859a51fbc2a86031b44d33696ad. This is failing due to some strange template problems, so reverting until it can be straightened out. llvm-svn: 305505
2017-06-16 04:55:51 +08:00
extern llvm::cl::opt<bool> CompactRecords;
extern llvm::cl::opt<bool> DumpGlobals;
extern llvm::cl::opt<bool> DumpHeaders;
extern llvm::cl::opt<bool> DumpStreamBlocks;
extern llvm::cl::opt<bool> DumpStreamSummary;
extern llvm::cl::opt<bool> DumpPageStats;
extern llvm::cl::opt<bool> DumpTpiHash;
extern llvm::cl::opt<bool> DumpTpiRecordBytes;
extern llvm::cl::opt<bool> DumpTpiRecords;
extern llvm::cl::opt<bool> DumpIpiRecords;
extern llvm::cl::opt<bool> DumpIpiRecordBytes;
[llvm-pdbdump] Introduce an abstraction for the output style. This opens the door to introducing a YAML outputter which can be used for machine consumption. Currently the yaml output style is unimplemented and returns an error if you try to use it. Reviewed By: rnk, ruiu Differential Revision: http://reviews.llvm.org/D20967 llvm-svn: 271712
2016-06-04 03:28:33 +08:00
extern llvm::cl::opt<bool> DumpPublics;
extern llvm::cl::opt<bool> DumpSectionContribs;
extern llvm::cl::opt<bool> DumpSectionMap;
Revert "[llvm-pdbutil] rewrite the "raw" output style." This reverts commit 83ea17ebf2106859a51fbc2a86031b44d33696ad. This is failing due to some strange template problems, so reverting until it can be straightened out. llvm-svn: 305505
2017-06-16 04:55:51 +08:00
extern llvm::cl::opt<bool> DumpSymRecordBytes;
extern llvm::cl::opt<bool> DumpSectionHeaders;
extern llvm::cl::opt<bool> DumpFpo;
extern llvm::cl::opt<bool> DumpStringTable;
Update llvm-pdbdump to use subcommands. llvm-svn: 274247
2016-07-01 01:42:48 +08:00
}
[llvm-pdbdump] Introduce an abstraction for the output style. This opens the door to introducing a YAML outputter which can be used for machine consumption. Currently the yaml output style is unimplemented and returns an error if you try to use it. Reviewed By: rnk, ruiu Differential Revision: http://reviews.llvm.org/D20967 llvm-svn: 271712
2016-06-04 03:28:33 +08:00
Add the beginning of PDB diffing support. For now this only diffs the stream directory and the MSF Superblock. Future patches will drill down into individual streams to find out where the differences lie. Differential Revision: https://reviews.llvm.org/D30908 llvm-svn: 297689
2017-03-14 07:28:25 +08:00
namespace diff {
extern llvm::cl::opt<bool> Pedantic;
}
Update llvm-pdbdump to use subcommands. llvm-svn: 274247
2016-07-01 01:42:48 +08:00
namespace pdb2yaml {
[llvm-pdbdump] pdb2yaml: add an -all option to dump everything we can Reviewers: amccarth, rnk, zturner Reviewed By: zturner Subscribers: fhahn, llvm-commits Differential Revision: https://reviews.llvm.org/D33613 llvm-svn: 304047
2017-05-27 07:46:20 +08:00
extern llvm::cl::opt<bool> All;
[pdb] Add a pdb2yaml option to not dump file headers. This will be useful once we start adding the ability to dump type records and symbol records, since it will allow us to generate mergeable information instead of information that specifies an entire file. llvm-svn: 275109
2016-07-12 05:45:09 +08:00
extern llvm::cl::opt<bool> NoFileHeaders;
[pdb] Write the module info and symbol record streams. Previously we did not have support for writing detailed module information for each module, as well as the symbol records. This patch adds support for this, and in doing so enables the ability to construct minimal PDBs from just a few lines of YAML. A test is added to illustrate this functionality. llvm-svn: 297900
2017-03-16 06:18:53 +08:00
extern llvm::cl::opt<bool> Minimal;
Update llvm-pdbdump to use subcommands. llvm-svn: 274247
2016-07-01 01:42:48 +08:00
extern llvm::cl::opt<bool> StreamMetadata;
extern llvm::cl::opt<bool> StreamDirectory;
[pdb] Write the Named Stream mapping to Yaml and binary. Differential Revision: https://reviews.llvm.org/D28919 llvm-svn: 292665
2017-01-21 06:42:09 +08:00
extern llvm::cl::opt<bool> StringTable;
[pdb] Round trip the PDB stream between YAML and binary PDB. This gets writing of the PDB stream working. llvm-svn: 274647
2016-07-07 02:05:57 +08:00
extern llvm::cl::opt<bool> PdbStream;
Refactor the PDB writing to use a builder approach llvm-svn: 275110
2016-07-12 05:45:26 +08:00
extern llvm::cl::opt<bool> DbiStream;
Resubmit "Write the TPI stream from a PDB to Yaml." The original patch was breaking some buildbots due to an incorrect ordering of function definitions which caused some compilers to recognize a definition but others to not. llvm-svn: 279089
2016-08-19 00:49:29 +08:00
extern llvm::cl::opt<bool> TpiStream;
[pdb] Write the IPI stream. The IPI stream is structurally identical to the TPI stream, but it contains different record types. So we just re-use the TPI writing code. llvm-svn: 281638
2016-09-16 02:22:31 +08:00
extern llvm::cl::opt<bool> IpiStream;
Update llvm-pdbdump to use subcommands. llvm-svn: 274247
2016-07-01 01:42:48 +08:00
extern llvm::cl::list<std::string> InputFilename;
Revert "[llvm-pdbutil] rewrite the "raw" output style." This reverts commit 83ea17ebf2106859a51fbc2a86031b44d33696ad. This is failing due to some strange template problems, so reverting until it can be straightened out. llvm-svn: 305505
2017-06-16 04:55:51 +08:00
}
namespace shared {
[llvm-pdbdump] Improve consistency among subcommands. The pdb2yaml and raw subcommands did something very similar but with a different output format, and they used a lot of the same command line options, but each one re-implemented the command line option with slightly different spellings / options. This patch merges them together into a single definition which is shared by both subcommands. This new syntax also allows for more flexibility in the way debug subsections are dumped. Differential Revision: https://reviews.llvm.org/D33996 llvm-svn: 305032
2017-06-09 07:39:33 +08:00
extern llvm::cl::opt<bool> DumpModules;
extern llvm::cl::opt<bool> DumpModuleFiles;
extern llvm::cl::list<ModuleSubsection> DumpModuleSubsections;
extern llvm::cl::opt<bool> DumpModuleSyms;
Revert "[llvm-pdbutil] rewrite the "raw" output style." This reverts commit 83ea17ebf2106859a51fbc2a86031b44d33696ad. This is failing due to some strange template problems, so reverting until it can be straightened out. llvm-svn: 305505
2017-06-16 04:55:51 +08:00
} // namespace shared
[llvm-pdbdump] Rewrite dumper using visitor pattern. This increases the flexibility of how to dump different symbol types -- necessary for context-sensitive formatting of symbol types -- and also improves the modularity by allowing the dumping to be implemented in the actual dumper, as opposed to in the PDB library. llvm-svn: 230184
2015-02-23 06:03:38 +08:00
}
pdbdump: Print "Publics" stream. Publics stream seems to contain information as to public symbols. It actually contains a serialized hash table along with fixed-sized headers. This patch is not complete. It scans only till the end of the stream and dump the header information. I'll write code to de-serialize the hash table later. Reviewers: zturner Subscribers: llvm-commits Differential Revision: http://reviews.llvm.org/D20256 llvm-svn: 269484
2016-05-14 05:21:53 +08:00
#endif