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