LLVM 18.0.0git
DebugUtils.h
Go to the documentation of this file.
1//===----- DebugUtils.h - Utilities for debugging ORC JITs ------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// Utilities for debugging ORC-based JITs.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_EXECUTIONENGINE_ORC_DEBUGUTILS_H
14#define LLVM_EXECUTIONENGINE_ORC_DEBUGUTILS_H
15
16#include "llvm/ADT/ArrayRef.h"
19#include "llvm/Support/Error.h"
21#include <memory>
22#include <string>
23
24namespace llvm {
25
26class MemoryBuffer;
27
28namespace orc {
29
30// --raw_ostream operators for ORC types--
31
32/// Render a SymbolStringPtr.
33raw_ostream &operator<<(raw_ostream &OS, const SymbolStringPtr &Sym);
34
35/// Render a SymbolNameSet.
36raw_ostream &operator<<(raw_ostream &OS, const SymbolNameSet &Symbols);
37
38/// Render a SymbolNameVector.
39raw_ostream &operator<<(raw_ostream &OS, const SymbolNameVector &Symbols);
40
41/// Render an array of SymbolStringPtrs.
42raw_ostream &operator<<(raw_ostream &OS, ArrayRef<SymbolStringPtr> Symbols);
43
44/// Render JITSymbolFlags.
45raw_ostream &operator<<(raw_ostream &OS, const JITSymbolFlags &Flags);
46
47/// Render a SymbolFlagsMap entry.
48raw_ostream &operator<<(raw_ostream &OS, const SymbolFlagsMap::value_type &KV);
49
50/// Render a SymbolMap entry.
51raw_ostream &operator<<(raw_ostream &OS, const SymbolMap::value_type &KV);
52
53/// Render a SymbolFlagsMap.
54raw_ostream &operator<<(raw_ostream &OS, const SymbolFlagsMap &SymbolFlags);
55
56/// Render a SymbolMap.
57raw_ostream &operator<<(raw_ostream &OS, const SymbolMap &Symbols);
58
59/// Render a SymbolDependenceMap entry.
60raw_ostream &operator<<(raw_ostream &OS,
62
63/// Render a SymbolDependendeMap.
64raw_ostream &operator<<(raw_ostream &OS, const SymbolDependenceMap &Deps);
65
66/// Render a MaterializationUnit.
67raw_ostream &operator<<(raw_ostream &OS, const MaterializationUnit &MU);
68
69//// Render a JITDylibLookupFlags instance.
70raw_ostream &operator<<(raw_ostream &OS,
71 const JITDylibLookupFlags &JDLookupFlags);
72
73/// Render a SymbolLookupFlags instance.
74raw_ostream &operator<<(raw_ostream &OS, const SymbolLookupFlags &LookupFlags);
75
76/// Render a SymbolLookupSet entry.
77raw_ostream &operator<<(raw_ostream &OS, const SymbolLookupSet::value_type &KV);
78
79/// Render a SymbolLookupSet.
80raw_ostream &operator<<(raw_ostream &OS, const SymbolLookupSet &LookupSet);
81
82/// Render a JITDylibSearchOrder.
83raw_ostream &operator<<(raw_ostream &OS,
84 const JITDylibSearchOrder &SearchOrder);
85
86/// Render a SymbolAliasMap.
87raw_ostream &operator<<(raw_ostream &OS, const SymbolAliasMap &Aliases);
88
89/// Render a SymbolState.
90raw_ostream &operator<<(raw_ostream &OS, const SymbolState &S);
91
92/// Render a LookupKind.
93raw_ostream &operator<<(raw_ostream &OS, const LookupKind &K);
94
95/// Dump a SymbolStringPool. Useful for debugging dangling-pointer crashes.
96raw_ostream &operator<<(raw_ostream &OS, const SymbolStringPool &SSP);
97
98/// A function object that can be used as an ObjectTransformLayer transform
99/// to dump object files to disk at a specified path.
101public:
102 /// Construct a DumpObjects transform that will dump objects to disk.
103 ///
104 /// @param DumpDir specifies the path to write dumped objects to. DumpDir may
105 /// be empty, in which case files will be dumped to the working directory. If
106 /// DumpDir is non-empty then any trailing separators will be discarded.
107 ///
108 /// @param IdentifierOverride specifies a file name stem to use when dumping
109 /// objects. If empty, each MemoryBuffer's identifier will be used (with a .o
110 /// suffix added if not already present). If an identifier override is
111 /// supplied it will be used instead (since all buffers will use the same
112 /// identifier, the resulting files will be named <ident>.o, <ident>.2.o,
113 /// <ident>.3.o, and so on). IdentifierOverride should not contain an
114 /// extension, as a .o suffix will be added by DumpObjects.
115 DumpObjects(std::string DumpDir = "", std::string IdentifierOverride = "");
116
117 /// Dumps the given buffer to disk.
119 operator()(std::unique_ptr<MemoryBuffer> Obj);
120
121private:
122 StringRef getBufferIdentifier(MemoryBuffer &B);
123 std::string DumpDir;
124 std::string IdentifierOverride;
125};
126
127} // End namespace orc
128} // End namespace llvm
129
130#endif // LLVM_EXECUTIONENGINE_ORC_DEBUGUTILS_H
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
Symbol * Sym
Definition: ELF_riscv.cpp:477
raw_pwrite_stream & OS
BucketT value_type
Definition: DenseMap.h:69
Tagged union holding either a T or a Error.
Definition: Error.h:474
This interface provides simple read-only access to a block of memory, and provides simple methods for...
Definition: MemoryBuffer.h:51
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
A function object that can be used as an ObjectTransformLayer transform to dump object files to disk ...
Definition: DebugUtils.h:100
Expected< std::unique_ptr< MemoryBuffer > > operator()(std::unique_ptr< MemoryBuffer > Obj)
Dumps the given buffer to disk.
Definition: DebugUtils.cpp:321
std::pair< SymbolStringPtr, SymbolLookupFlags > value_type
Definition: Core.h:185
std::vector< std::pair< JITDylib *, JITDylibLookupFlags > > JITDylibSearchOrder
A list of (JITDylib*, JITDylibLookupFlags) pairs to be used as a search order during symbol lookup.
Definition: Core.h:162
SymbolLookupFlags
Lookup flags that apply to each symbol in a lookup.
Definition: Core.h:145
DenseMap< SymbolStringPtr, SymbolAliasMapEntry > SymbolAliasMap
A map of Symbols to (Symbol, Flags) pairs.
Definition: Core.h:396
JITDylibLookupFlags
Lookup flags that apply to each dylib in the search order for a lookup.
Definition: Core.h:135
DenseMap< SymbolStringPtr, ExecutorSymbolDef > SymbolMap
A map from symbol names (as SymbolStringPtrs) to JITSymbols (address/flags pairs).
Definition: Core.h:121
DenseMap< SymbolStringPtr, JITSymbolFlags > SymbolFlagsMap
A map from symbol names (as SymbolStringPtrs) to JITSymbolFlags.
Definition: Core.h:124
DenseSet< SymbolStringPtr > SymbolNameSet
A set of symbol names (represented by SymbolStringPtrs for.
Definition: Core.h:114
LookupKind
Describes the kind of lookup being performed.
Definition: Core.h:157
std::vector< SymbolStringPtr > SymbolNameVector
A vector of symbol names.
Definition: Core.h:117
SymbolState
Represents the state that a symbol has reached during materialization.
Definition: Core.h:828
DenseMap< JITDylib *, SymbolNameSet > SymbolDependenceMap
A map from JITDylibs to sets of symbols.
Definition: Core.h:127
raw_ostream & operator<<(raw_ostream &OS, const SymbolStringPtr &Sym)
Render a SymbolStringPtr.
Definition: DebugUtils.cpp:141
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18