include/llvm/GVMaterializer.h

   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 GVMATERIALIZER_H
  19 #define GVMATERIALIZER_H
  20
  21 #include <string>
  22
  23 namespace llvm {
  24
  25 class Function;
  26 class GlobalValue;
  27 class Module;
  28
  29 class GVMaterializer {
  30 protected:
  31   GVMaterializer() {}
  32
  33 public:
  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.  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.
  47   ///
  48   virtual bool Materialize(GlobalValue *GV, std::string *ErrInfo = 0) = 0;
  49
  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.
  54   ///
  55   virtual void Dematerialize(GlobalValue *) {}
  56
  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.
  60   ///
  61   virtual bool MaterializeModule(Module *M, std::string *ErrInfo = 0) = 0;
  62 };
  63
  64 } // End llvm namespace
  65
  66 #endif