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" 17 #include "llvm/ExecutionEngine/Orc/Core.h" 18 #include "llvm/ExecutionEngine/Orc/SymbolStringPool.h" 19 #include "llvm/Support/Error.h" 20 #include "llvm/Support/raw_ostream.h" 21 #include <memory> 22 #include <string> 23 24 namespace llvm { 25 26 class MemoryBuffer; 27 28 namespace orc { 29 30 // --raw_ostream operators for ORC types-- 31 32 /// Render a SymbolStringPtr. 33 raw_ostream &operator<<(raw_ostream &OS, const SymbolStringPtr &Sym); 34 35 /// Render a NonOwningSymbolStringPtr. 36 raw_ostream &operator<<(raw_ostream &OS, NonOwningSymbolStringPtr Sym); 37 38 /// Render a SymbolNameSet. 39 raw_ostream &operator<<(raw_ostream &OS, const SymbolNameSet &Symbols); 40 41 /// Render a SymbolNameVector. 42 raw_ostream &operator<<(raw_ostream &OS, const SymbolNameVector &Symbols); 43 44 /// Render an array of SymbolStringPtrs. 45 raw_ostream &operator<<(raw_ostream &OS, ArrayRef<SymbolStringPtr> Symbols); 46 47 /// Render JITSymbolFlags. 48 raw_ostream &operator<<(raw_ostream &OS, const JITSymbolFlags &Flags); 49 50 /// Render a SymbolFlagsMap entry. 51 raw_ostream &operator<<(raw_ostream &OS, const SymbolFlagsMap::value_type &KV); 52 53 /// Render a SymbolMap entry. 54 raw_ostream &operator<<(raw_ostream &OS, const SymbolMap::value_type &KV); 55 56 /// Render a SymbolFlagsMap. 57 raw_ostream &operator<<(raw_ostream &OS, const SymbolFlagsMap &SymbolFlags); 58 59 /// Render a SymbolMap. 60 raw_ostream &operator<<(raw_ostream &OS, const SymbolMap &Symbols); 61 62 /// Render a SymbolDependenceMap entry. 63 raw_ostream &operator<<(raw_ostream &OS, 64 const SymbolDependenceMap::value_type &KV); 65 66 /// Render a SymbolDependendeMap. 67 raw_ostream &operator<<(raw_ostream &OS, const SymbolDependenceMap &Deps); 68 69 /// Render a MaterializationUnit. 70 raw_ostream &operator<<(raw_ostream &OS, const MaterializationUnit &MU); 71 72 //// Render a JITDylibLookupFlags instance. 73 raw_ostream &operator<<(raw_ostream &OS, 74 const JITDylibLookupFlags &JDLookupFlags); 75 76 /// Render a SymbolLookupFlags instance. 77 raw_ostream &operator<<(raw_ostream &OS, const SymbolLookupFlags &LookupFlags); 78 79 /// Render a SymbolLookupSet entry. 80 raw_ostream &operator<<(raw_ostream &OS, const SymbolLookupSet::value_type &KV); 81 82 /// Render a SymbolLookupSet. 83 raw_ostream &operator<<(raw_ostream &OS, const SymbolLookupSet &LookupSet); 84 85 /// Render a JITDylibSearchOrder. 86 raw_ostream &operator<<(raw_ostream &OS, 87 const JITDylibSearchOrder &SearchOrder); 88 89 /// Render a SymbolAliasMap. 90 raw_ostream &operator<<(raw_ostream &OS, const SymbolAliasMap &Aliases); 91 92 /// Render a SymbolState. 93 raw_ostream &operator<<(raw_ostream &OS, const SymbolState &S); 94 95 /// Render a LookupKind. 96 raw_ostream &operator<<(raw_ostream &OS, const LookupKind &K); 97 98 /// Dump a SymbolStringPool. Useful for debugging dangling-pointer crashes. 99 raw_ostream &operator<<(raw_ostream &OS, const SymbolStringPool &SSP); 100 101 /// A function object that can be used as an ObjectTransformLayer transform 102 /// to dump object files to disk at a specified path. 103 class DumpObjects { 104 public: 105 /// Construct a DumpObjects transform that will dump objects to disk. 106 /// 107 /// @param DumpDir specifies the path to write dumped objects to. DumpDir may 108 /// be empty, in which case files will be dumped to the working directory. If 109 /// DumpDir is non-empty then any trailing separators will be discarded. 110 /// 111 /// @param IdentifierOverride specifies a file name stem to use when dumping 112 /// objects. If empty, each MemoryBuffer's identifier will be used (with a .o 113 /// suffix added if not already present). If an identifier override is 114 /// supplied it will be used instead (since all buffers will use the same 115 /// identifier, the resulting files will be named <ident>.o, <ident>.2.o, 116 /// <ident>.3.o, and so on). IdentifierOverride should not contain an 117 /// extension, as a .o suffix will be added by DumpObjects. 118 DumpObjects(std::string DumpDir = "", std::string IdentifierOverride = ""); 119 120 /// Dumps the given buffer to disk. 121 Expected<std::unique_ptr<MemoryBuffer>> 122 operator()(std::unique_ptr<MemoryBuffer> Obj); 123 124 private: 125 StringRef getBufferIdentifier(MemoryBuffer &B); 126 std::string DumpDir; 127 std::string IdentifierOverride; 128 }; 129 130 } // End namespace orc 131 } // End namespace llvm 132 133 #endif // LLVM_EXECUTIONENGINE_ORC_DEBUGUTILS_H 134