include/llvm/IR/GVMaterializer.h

   1 //===- 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 LLVM_IR_GVMATERIALIZER_H
  19 #define LLVM_IR_GVMATERIALIZER_H
  20
  21 #include <system_error>
  22 #include <vector>
  23
  24 namespace llvm {
  25 class Function;
  26 class GlobalValue;
  27 class Module;
  28 class StructType;
  29
  30 class GVMaterializer {
  31 protected:
  32   GVMaterializer() {}
  33
  34 public:
  35   virtual ~GVMaterializer();
  36
  37   /// True if GV has been materialized and can be dematerialized back to
  38   /// whatever backing store this GVMaterializer uses.
  39   virtual bool isDematerializable(const GlobalValue *GV) const = 0;
  40
  41   /// Make sure the given GlobalValue is fully read.
  42   ///
  43   virtual std::error_code materialize(GlobalValue *GV) = 0;
  44
  45   /// If the given GlobalValue is read in, and if the GVMaterializer supports
  46   /// it, release the memory for the GV, and set it up to be materialized
  47   /// lazily. If the Materializer doesn't support this capability, this method
  48   /// is a noop.
  49   ///
  50   virtual void Dematerialize(GlobalValue *) {}
  51
  52   /// Make sure the entire Module has been completely read.
  53   ///
  54   virtual std::error_code MaterializeModule(Module *M) = 0;
  55
  56   virtual std::error_code materializeMetadata() = 0;
  57
  58   virtual std::vector<StructType *> getIdentifiedStructTypes() const = 0;
  59 };
  60
  61 } // End llvm namespace
  62
  63 #endif