blob: a1216a174282b4b0b7883d116ac67d50ff2a4da8 [file] [log] [blame]
//===- GVMaterializer.h - Interface for GV materializers --------*- C++ -*-===//
// The LLVM Compiler Infrastructure
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
// This file provides an abstract interface for loading a module from some
// place. This interface allows incremental or random access loading of
// functions from the file. This is useful for applications like JIT compilers
// or interprocedural optimizers that do not need the entire program in memory
// at the same time.
#include <system_error>
namespace llvm {
class Function;
class GlobalValue;
class Module;
class GVMaterializer {
GVMaterializer() {}
virtual ~GVMaterializer();
/// True if GV can be materialized from whatever backing store this
/// GVMaterializer uses and has not been materialized yet.
virtual bool isMaterializable(const GlobalValue *GV) const = 0;
/// True if GV has been materialized and can be dematerialized back to
/// whatever backing store this GVMaterializer uses.
virtual bool isDematerializable(const GlobalValue *GV) const = 0;
/// Make sure the given GlobalValue is fully read.
virtual std::error_code Materialize(GlobalValue *GV) = 0;
/// If the given GlobalValue is read in, and if the GVMaterializer supports
/// it, release the memory for the GV, and set it up to be materialized
/// lazily. If the Materializer doesn't support this capability, this method
/// is a noop.
virtual void Dematerialize(GlobalValue *) {}
/// Make sure the entire Module has been completely read.
virtual std::error_code MaterializeModule(Module *M) = 0;
virtual void releaseBuffer() = 0;
} // End llvm namespace