GVMaterializer.h revision 263508 
1//===-- llvm/GVMaterializer.h - Interface for GV materializers --*- C++ -*-===//
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 provides an abstract interface for loading a module from some
11// place.  This interface allows incremental or random access loading of
12// functions from the file.  This is useful for applications like JIT compilers
13// or interprocedural optimizers that do not need the entire program in memory
14// at the same time.
15//
16//===----------------------------------------------------------------------===//
17
18#ifndef LLVM_GVMATERIALIZER_H
19#define LLVM_GVMATERIALIZER_H
20
21#include "llvm/Support/system_error.h"
22
23namespace llvm {
24
25class Function;
26class GlobalValue;
27class Module;
28
29class GVMaterializer {
30protected:
31  GVMaterializer() {}
32
33public:
34  virtual ~GVMaterializer();
35
36  /// isMaterializable - True if GV can be materialized from whatever backing
37  /// store this GVMaterializer uses and has not been materialized yet.
38  virtual bool isMaterializable(const GlobalValue *GV) const = 0;
39
40  /// isDematerializable - True if GV has been materialized and can be
41  /// dematerialized back to whatever backing store this GVMaterializer uses.
42  virtual bool isDematerializable(const GlobalValue *GV) const = 0;
43
44  /// Materialize - make sure the given GlobalValue is fully read.
45  ///
46  virtual error_code Materialize(GlobalValue *GV) = 0;
47
48  /// Dematerialize - If the given GlobalValue is read in, and if the
49  /// GVMaterializer supports it, release the memory for the GV, and set it up
50  /// to be materialized lazily.  If the Materializer doesn't support this
51  /// capability, this method is a noop.
52  ///
53  virtual void Dematerialize(GlobalValue *) {}
54
55  /// MaterializeModule - make sure the entire Module has been completely read.
56  ///
57  virtual error_code MaterializeModule(Module *M) = 0;
58};
59
60} // End llvm namespace
61
62#endif
63