1
//===-- llvm/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 GVMATERIALIZER_H
19
#define GVMATERIALIZER_H
29
class GVMaterializer {
34
virtual ~GVMaterializer();
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;
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;
44
/// Materialize - make sure the given GlobalValue is fully read. If the
45
/// module is corrupt, this returns true and fills in the optional string with
46
/// information about the problem. If successful, this returns false.
48
virtual bool Materialize(GlobalValue *GV, std::string *ErrInfo = 0) = 0;
50
/// Dematerialize - If the given GlobalValue is read in, and if the
51
/// GVMaterializer supports it, release the memory for the GV, and set it up
52
/// to be materialized lazily. If the Materializer doesn't support this
53
/// capability, this method is a noop.
55
virtual void Dematerialize(GlobalValue *) {}
57
/// MaterializeModule - make sure the entire Module has been completely read.
58
/// On error, this returns true and fills in the optional string with
59
/// information about the problem. If successful, this returns false.
61
virtual bool MaterializeModule(Module *M, std::string *ErrInfo = 0) = 0;
64
} // End llvm namespace