1 //===- IRObjectFile.h - LLVM IR object file implementation ------*- 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 // This file declares the IRObjectFile template class. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #ifndef LLVM_OBJECT_IROBJECTFILE_H 14 #define LLVM_OBJECT_IROBJECTFILE_H 15 16 #include "llvm/ADT/PointerUnion.h" 17 #include "llvm/Object/IRSymtab.h" 18 #include "llvm/Object/ModuleSymbolTable.h" 19 #include "llvm/Object/SymbolicFile.h" 20 21 namespace llvm { 22 class BitcodeModule; 23 class Module; 24 25 namespace object { 26 class ObjectFile; 27 28 class IRObjectFile : public SymbolicFile { 29 std::vector<std::unique_ptr<Module>> Mods; 30 ModuleSymbolTable SymTab; 31 IRObjectFile(MemoryBufferRef Object, 32 std::vector<std::unique_ptr<Module>> Mods); 33 34 public: 35 ~IRObjectFile() override; 36 void moveSymbolNext(DataRefImpl &Symb) const override; 37 Error printSymbolName(raw_ostream &OS, DataRefImpl Symb) const override; 38 Expected<uint32_t> getSymbolFlags(DataRefImpl Symb) const override; 39 basic_symbol_iterator symbol_begin() const override; 40 basic_symbol_iterator symbol_end() const override; 41 42 StringRef getTargetTriple() const; 43 44 static bool classof(const Binary *v) { 45 return v->isIR(); 46 } 47 48 using module_iterator = 49 pointee_iterator<std::vector<std::unique_ptr<Module>>::const_iterator, 50 const Module>; 51 52 module_iterator module_begin() const { return module_iterator(Mods.begin()); } 53 module_iterator module_end() const { return module_iterator(Mods.end()); } 54 55 iterator_range<module_iterator> modules() const { 56 return make_range(module_begin(), module_end()); 57 } 58 59 /// Finds and returns bitcode embedded in the given object file, or an 60 /// error code if not found. 61 static Expected<MemoryBufferRef> findBitcodeInObject(const ObjectFile &Obj); 62 63 /// Finds and returns bitcode in the given memory buffer (which may 64 /// be either a bitcode file or a native object file with embedded bitcode), 65 /// or an error code if not found. 66 static Expected<MemoryBufferRef> 67 findBitcodeInMemBuffer(MemoryBufferRef Object); 68 69 static Expected<std::unique_ptr<IRObjectFile>> create(MemoryBufferRef Object, 70 LLVMContext &Context); 71 }; 72 73 /// The contents of a bitcode file and its irsymtab. Any underlying data 74 /// for the irsymtab are owned by Symtab and Strtab. 75 struct IRSymtabFile { 76 std::vector<BitcodeModule> Mods; 77 SmallVector<char, 0> Symtab, Strtab; 78 irsymtab::Reader TheReader; 79 }; 80 81 /// Reads a bitcode file, creating its irsymtab if necessary. 82 Expected<IRSymtabFile> readIRSymtab(MemoryBufferRef MBRef); 83 84 } 85 86 } 87 88 #endif 89