X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FModuleProvider.h;h=0a91cd1f01d7879d4930ded578f565822b334bae;hb=1a957d563fe894c797e0eba00bf069fbe7ecba77;hp=8ef74276574ccf0b7ade3d5d31b1170bd9ca5bd2;hpb=fdf148ea71e7ff836f67497a0e18885434abdef6;p=oota-llvm.git

diff --git a/include/llvm/ModuleProvider.h b/include/llvm/ModuleProvider.h
index 8ef74276574..0a91cd1f01d 100644
--- a/include/llvm/ModuleProvider.h
+++ b/include/llvm/ModuleProvider.h
@@ -1,45 +1,88 @@
 //===-- llvm/ModuleProvider.h - Interface for module providers --*- C++ -*-===//
 //
-// Abstract interface for providing a module.
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file provides an abstract interface for loading a module from some
+// place.  This interface allows incremental or random access loading of
+// functions from the file.  This is useful for applications like JIT compilers
+// or interprocedural optimizers that do not need the entire program in memory
+// at the same time.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef MODULEPROVIDER_H
 #define MODULEPROVIDER_H
 
+#include <string>
+
+namespace llvm {
+
 class Function;
 class Module;
 
-class AbstractModuleProvider {
+class ModuleProvider {
 protected:
   Module *TheModule;
-  AbstractModuleProvider();
+  ModuleProvider();
 
 public:
-  virtual ~AbstractModuleProvider();
+  virtual ~ModuleProvider();
 
   /// getModule - returns the module this provider is encapsulating.
   ///
   Module* getModule() { return TheModule; }
 
-  /// materializeFunction - make sure the given function is fully read.
+  /// materializeFunction - make sure the given function is fully read.  If the
+  /// module is corrupt, this returns true and fills in the optional string
+  /// with information about the problem.  If successful, this returns false.
   ///
-  virtual void materializeFunction(Function *F) = 0;
+  virtual bool materializeFunction(Function *F, std::string *ErrInfo = 0) = 0;
 
+  /// dematerializeFunction - If the given function is read in, and if the
+  /// module provider supports it, release the memory for the function, and set
+  /// it up to be materialized lazily.  If the provider doesn't support this
+  /// capability, this method is a noop.
+  ///
+  virtual void dematerializeFunction(Function *F) {}
+  
   /// materializeModule - make sure the entire Module has been completely read.
+  /// On error, return null and fill in the error string if specified.
   ///
-  void materializeModule();
+  virtual Module* materializeModule(std::string *ErrInfo = 0) = 0;
 
   /// releaseModule - no longer delete the Module* when provider is destroyed.
+  /// On error, return null and fill in the error string if specified.
   ///
-  virtual Module* releaseModule() { 
+  virtual Module* releaseModule(std::string *ErrInfo = 0) {
     // Since we're losing control of this Module, we must hand it back complete
-    materializeModule();
-    Module *tempM = TheModule; 
-    TheModule = 0; 
-    return tempM; 
+    if (!materializeModule(ErrInfo))
+      return 0;
+    Module *tempM = TheModule;
+    TheModule = 0;
+    return tempM;
   }
+};
+
 
+/// ExistingModuleProvider - Allow conversion from a fully materialized Module
+/// into a ModuleProvider, allowing code that expects a ModuleProvider to work
+/// if we just have a Module.  Note that the ModuleProvider takes ownership of
+/// the Module specified.
+struct ExistingModuleProvider : public ModuleProvider {
+  ExistingModuleProvider(Module *M) {
+    TheModule = M;
+  }
+  bool materializeFunction(Function *F, std::string *ErrInfo = 0) {
+    return false;
+  }
+  Module* materializeModule(std::string *ErrInfo = 0) { return TheModule; }
 };
 
+} // End llvm namespace
+
 #endif