Re-reapply "[IR] Move optional data in llvm::Function into a hungoff uselist"
[oota-llvm.git] / include / llvm / IR / GVMaterializer.h
index dbe52bc2a32928b05d6d1af157877c1a2dbec2f8..489cbf58dfa69bab70da2f149392378b0dde3fe4 100644 (file)
 #ifndef LLVM_IR_GVMATERIALIZER_H
 #define LLVM_IR_GVMATERIALIZER_H
 
-#include "llvm/Support/system_error.h"
+#include "llvm/ADT/DenseMap.h"
+#include <system_error>
+#include <vector>
 
 namespace llvm {
-
 class Function;
 class GlobalValue;
+class Metadata;
 class Module;
+class StructType;
 
 class GVMaterializer {
 protected:
@@ -33,28 +36,26 @@ protected:
 public:
   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 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 *) {}
+  virtual std::error_code materialize(GlobalValue *GV) = 0;
 
   /// Make sure the entire Module has been completely read.
   ///
-  virtual error_code MaterializeModule(Module *M) = 0;
+  virtual std::error_code materializeModule() = 0;
+
+  virtual std::error_code materializeMetadata() = 0;
+  virtual void setStripDebugInfo() = 0;
+
+  /// Client should define this interface if the mapping between metadata
+  /// values and value ids needs to be preserved, e.g. across materializer
+  /// instantiations. If OnlyTempMD is true, only those that have remained
+  /// temporary metadata are recorded in the map.
+  virtual void
+  saveMDValueList(DenseMap<const Metadata *, unsigned> &MDValueToValIDMap,
+                  bool OnlyTempMD) {}
+
+  virtual std::vector<StructType *> getIdentifiedStructTypes() const = 0;
 };
 
 } // End llvm namespace