1//===---- ObjectImage.h - Format independent executuable object image -----===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file declares a file format independent ObjectImage class.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_EXECUTIONENGINE_OBJECTIMAGE_H
15#define LLVM_EXECUTIONENGINE_OBJECTIMAGE_H
16
17#include "llvm/ExecutionEngine/ObjectBuffer.h"
18#include "llvm/Object/ObjectFile.h"
19
20namespace llvm {
21
22
23/// ObjectImage - A container class that represents an ObjectFile that has been
24/// or is in the process of being loaded into memory for execution.
25class ObjectImage {
26  ObjectImage() LLVM_DELETED_FUNCTION;
27  ObjectImage(const ObjectImage &other) LLVM_DELETED_FUNCTION;
28  virtual void anchor();
29
30protected:
31  std::unique_ptr<ObjectBuffer> Buffer;
32
33public:
34  ObjectImage(ObjectBuffer *Input) : Buffer(Input) {}
35  virtual ~ObjectImage() {}
36
37  virtual object::symbol_iterator begin_symbols() const = 0;
38  virtual object::symbol_iterator end_symbols() const = 0;
39  iterator_range<object::symbol_iterator> symbols() const {
40    return iterator_range<object::symbol_iterator>(begin_symbols(),
41                                                   end_symbols());
42  }
43
44  virtual object::section_iterator begin_sections() const = 0;
45  virtual object::section_iterator end_sections() const  = 0;
46  iterator_range<object::section_iterator> sections() const {
47    return iterator_range<object::section_iterator>(begin_sections(),
48                                                    end_sections());
49  }
50
51  virtual /* Triple::ArchType */ unsigned getArch() const = 0;
52
53  // Subclasses can override these methods to update the image with loaded
54  // addresses for sections and common symbols
55  virtual void updateSectionAddress(const object::SectionRef &Sec,
56                                    uint64_t Addr) = 0;
57  virtual void updateSymbolAddress(const object::SymbolRef &Sym,
58                                   uint64_t Addr) = 0;
59
60  virtual StringRef getData() const = 0;
61
62  virtual object::ObjectFile* getObjectFile() const = 0;
63
64  // Subclasses can override these methods to provide JIT debugging support
65  virtual void registerWithDebugger() = 0;
66  virtual void deregisterWithDebugger() = 0;
67};
68
69} // end namespace llvm
70
71#endif // LLVM_EXECUTIONENGINE_OBJECTIMAGE_H
72