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 "llvm/Support/system_error.h"
29 class GVMaterializer {
34 virtual ~GVMaterializer();
36 /// True if GV can be materialized from whatever backing store this
37 /// GVMaterializer uses and has not been materialized yet.
38 virtual bool isMaterializable(const GlobalValue *GV) const = 0;
40 /// True if GV has been materialized and can be dematerialized back to
41 /// whatever backing store this GVMaterializer uses.
42 virtual bool isDematerializable(const GlobalValue *GV) const = 0;
44 /// Make sure the given GlobalValue is fully read.
46 virtual error_code Materialize(GlobalValue *GV) = 0;
48 /// If the given GlobalValue is read in, and if the GVMaterializer supports
49 /// it, release the memory for the GV, and set it up to be materialized
50 /// lazily. If the Materializer doesn't support this capability, this method
53 virtual void Dematerialize(GlobalValue *) {}
55 /// Make sure the entire Module has been completely read.
57 virtual error_code MaterializeModule(Module *M) = 0;
60 } // End llvm namespace