Merge StreamableMemoryObject into MemoryObject.

Every MemoryObject is a StreamableMemoryObject since the removal of
StringRefMemoryObject, so just merge the two.

I will clean up the MemoryObject interface in the upcoming commits.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@221766 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Rafael Espindola
2014-11-12 03:55:46 +00:00
parent 64f62a02e0
commit d0518569ec
6 changed files with 51 additions and 63 deletions

View File

@@ -14,10 +14,17 @@
namespace llvm {
/// 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.
/// Interface to data which might be streamed. Streamability has 2 important
/// implications/restrictions. First, the data might not yet exist in memory
/// when the request is made. This just means that readByte/readBytes might have
/// to block or do some work to get it. More significantly, the exact size of
/// the object might not be known until it has all been fetched. This means that
/// to return the right result, getExtent must also wait for all the data to
/// arrive; therefore it should not be called on objects which are actually
/// streamed (this would defeat the purpose of streaming). Instead,
/// isValidAddress and isObjectEnd can be used to test addresses without knowing
/// the exact size of the stream. Finally, getPointer can be used instead of
/// readBytes to avoid extra copying.
class MemoryObject {
public:
virtual ~MemoryObject();
@@ -41,6 +48,28 @@ public:
/// bounds violation or an implementation-specific error.
virtual int readBytes(uint64_t address, uint64_t size,
uint8_t *buf) const = 0;
/// Ensures that the requested data is in memory, and returns a pointer to it.
/// More efficient than using readBytes if the data is already in memory. May
/// block until (address - base + size) bytes have been read
/// @param address - address of the byte, in the same space as getBase()
/// @param size - amount of data that must be available on return
/// @result - valid pointer to the requested data
virtual const uint8_t *getPointer(uint64_t address, uint64_t size) const = 0;
/// Returns true if the address is within the object (i.e. between base and
/// base + extent - 1 inclusive). May block until (address - base) bytes have
/// been read
/// @param address - address of the byte, in the same space as getBase()
/// @result - true if the address may be read with readByte()
virtual bool isValidAddress(uint64_t address) const = 0;
/// Returns true if the address is one past the end of the object (i.e. if it
/// is equal to base + extent). May block until (address - base) bytes have
/// been read
/// @param address - address of the byte, in the same space as getBase()
/// @result - true if the address is equal to base + extent
virtual bool isObjectEnd(uint64_t address) const = 0;
};
}