Did my commit for the last patch for the .loc directory from the wrong place and
[oota-llvm.git] / include / llvm / Support / MemoryObject.h
index f8f29be5a7b354a3be55dbf058bfd60adf967c71..e193ca2f2bc529b1d90f25c28cf20157ee81f826 100644 (file)
 #ifndef MEMORYOBJECT_H
 #define MEMORYOBJECT_H
 
-#include "llvm/Support/DataTypes.h"
+#include "llvm/System/DataTypes.h"
 
 namespace llvm {
 
 /// MemoryObject - Abstract base class for contiguous addressable memory.
 ///   Necessary for cases in which the memory is in another process, in a
 ///   file, or on a remote machine.
+///   All size and offset parameters are uint64_ts, to allow 32-bit processes
+///   access to 64-bit address spaces.
 class MemoryObject {
 public:
-  /// Constructor     - Override as necessary.
-  MemoryObject() {
-  }
+  /// Destructor      - Override as necessary.
+  virtual ~MemoryObject();
   
   /// getBase         - Returns the lowest valid address in the region.
   ///
@@ -43,7 +44,7 @@ public:
   ///                   bounds violation or an implementation-specific error.
   virtual int readByte(uint64_t address, uint8_t* ptr) const = 0;
   
-  /// readByte        - Tries to read a contiguous range of bytes from the
+  /// readBytes       - Tries to read a contiguous range of bytes from the
   ///                   region, up to the end of the region.
   ///                   You should override this function if there is a quicker
   ///                   way than going back and forth with individual bytes.
@@ -53,26 +54,14 @@ public:
   /// @param size     - The maximum number of bytes to copy.
   /// @param buf      - A pointer to a buffer to be filled in.  Must be non-NULL
   ///                   and large enough to hold size bytes.
-  /// @result         - The number of bytes copied if successful; (uint64_t)-1
-  ///                   if not.
-  ///                   Failure may be due to a bounds violation or an
-  ///                   implementation-specific error.
-  virtual uint64_t readBytes(uint64_t address,
-                             uint64_t size,
-                             uint8_t* buf) const {
-    uint64_t current = address;
-    uint64_t limit = getBase() + getExtent();
-    uint64_t ret = 0;
-    
-    while(current - address < size && current < limit) {
-      if(readByte(current, &buf[(current - address)]))
-        return (uint64_t)-1;
-      
-      ret++;
-    }
-    
-    return ret;
-  }
+  /// @param copied   - A pointer to a nunber that is filled in with the number
+  ///                   of bytes actually read.  May be NULL.
+  /// @result         - 0 if successful; -1 if not.  Failure may be due to a
+  ///                   bounds violation or an implementation-specific error.
+  virtual int readBytes(uint64_t address,
+                        uint64_t size,
+                        uint8_t* buf,
+                        uint64_t* copied) const;
 };
 
 }