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 "llvm/ADT/DenseMap.h"
  22 #include <system_error>
  23 #include <vector>
  24
  25 namespace llvm {
  26 class Function;
  27 class GlobalValue;
  28 class Metadata;
  29 class Module;
  30 class StructType;
  31
  32 class GVMaterializer {
  33 protected:
  34   GVMaterializer() {}
  35
  36 public:
  37   virtual ~GVMaterializer();
  38
  39   /// True if GV has been materialized and can be dematerialized back to
  40   /// whatever backing store this GVMaterializer uses.
  41   virtual bool isDematerializable(const GlobalValue *GV) const = 0;
  42
  43   /// Make sure the given GlobalValue is fully read.
  44   ///
  45   virtual std::error_code materialize(GlobalValue *GV) = 0;
  46
  47   /// If the given GlobalValue is read in, and if the GVMaterializer supports
  48   /// it, release the memory for the GV, and set it up to be materialized
  49   /// lazily. If the Materializer doesn't support this capability, this method
  50   /// is a noop.
  51   ///
  52   virtual void dematerialize(GlobalValue *) {}
  53
  54   /// Make sure the entire Module has been completely read.
  55   ///
  56   virtual std::error_code materializeModule(Module *M) = 0;
  57
  58   virtual std::error_code materializeMetadata() = 0;
  59   virtual void setStripDebugInfo() = 0;
  60
  61   /// Client should define this interface if the mapping between metadata
  62   /// values and value ids needs to be preserved, e.g. across materializer
  63   /// instantiations. If OnlyTempMD is true, only those that have remained
  64   /// temporary metadata are recorded in the map.
  65   virtual void
  66   saveMDValueList(DenseMap<const Metadata *, unsigned> &MDValueToValIDMap,
  67                   bool OnlyTempMD) {}
  68
  69   virtual std::vector<StructType *> getIdentifiedStructTypes() const = 0;
  70 };
  71
  72 } // End llvm namespace
  73
  74 #endif