Rename MDValue* to Metadata* (NFC)
[oota-llvm.git] / 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   /// Make sure the given GlobalValue is fully read.
40   ///
41   virtual std::error_code materialize(GlobalValue *GV) = 0;
42
43   /// Make sure the entire Module has been completely read.
44   ///
45   virtual std::error_code materializeModule() = 0;
46
47   virtual std::error_code materializeMetadata() = 0;
48   virtual void setStripDebugInfo() = 0;
49
50   /// Client should define this interface if the mapping between metadata
51   /// values and value ids needs to be preserved, e.g. across materializer
52   /// instantiations. If OnlyTempMD is true, only those that have remained
53   /// temporary metadata are recorded in the map.
54   virtual void
55   saveMetadataList(DenseMap<const Metadata *, unsigned> &MetadataToIDs,
56                    bool OnlyTempMD) {}
57
58   virtual std::vector<StructType *> getIdentifiedStructTypes() const = 0;
59 };
60
61 } // End llvm namespace
62
63 #endif