1 //===- GVMaterializer.h - Interface for GV materializers --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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
16 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_IR_GVMATERIALIZER_H
19 #define LLVM_IR_GVMATERIALIZER_H
21 #include <system_error>
28 class GVMaterializer {
33 virtual ~GVMaterializer();
35 /// True if GV has been materialized and can be dematerialized back to
36 /// whatever backing store this GVMaterializer uses.
37 virtual bool isDematerializable(const GlobalValue *GV) const = 0;
39 /// Make sure the given GlobalValue is fully read.
41 virtual std::error_code materialize(GlobalValue *GV) = 0;
43 /// If the given GlobalValue is read in, and if the GVMaterializer supports
44 /// it, release the memory for the GV, and set it up to be materialized
45 /// lazily. If the Materializer doesn't support this capability, this method
48 virtual void Dematerialize(GlobalValue *) {}
50 /// Make sure the entire Module has been completely read.
52 virtual std::error_code MaterializeModule(Module *M) = 0;
55 } // End llvm namespace