2016-04-29 19:22:58 +02:00
|
|
|
//===- ByteStream.h - Reads stream data from a byte sequence ----*- C++ -*-===//
|
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2016-07-22 21:56:05 +02:00
|
|
|
#ifndef LLVM_DEBUGINFO_MSF_BYTESTREAM_H
|
|
|
|
#define LLVM_DEBUGINFO_MSF_BYTESTREAM_H
|
2016-04-29 19:22:58 +02:00
|
|
|
|
|
|
|
#include "llvm/ADT/ArrayRef.h"
|
2016-05-10 01:11:38 +02:00
|
|
|
#include "llvm/ADT/StringRef.h"
|
2016-07-29 22:56:36 +02:00
|
|
|
#include "llvm/DebugInfo/MSF/MSFError.h"
|
|
|
|
#include "llvm/DebugInfo/MSF/StreamInterface.h"
|
2016-05-10 01:11:38 +02:00
|
|
|
#include "llvm/Support/Error.h"
|
2016-07-28 21:12:28 +02:00
|
|
|
#include "llvm/Support/FileOutputBuffer.h"
|
|
|
|
#include "llvm/Support/MemoryBuffer.h"
|
2016-05-10 01:11:38 +02:00
|
|
|
#include <cstdint>
|
|
|
|
#include <memory>
|
2016-06-10 07:09:12 +02:00
|
|
|
#include <type_traits>
|
2016-04-29 19:22:58 +02:00
|
|
|
|
|
|
|
namespace llvm {
|
2016-07-22 21:56:05 +02:00
|
|
|
namespace msf {
|
2016-06-10 07:09:12 +02:00
|
|
|
|
2016-07-28 21:12:28 +02:00
|
|
|
class ByteStream : public ReadableStream {
|
2016-04-29 19:22:58 +02:00
|
|
|
public:
|
2016-06-10 07:09:12 +02:00
|
|
|
ByteStream() {}
|
2016-07-28 21:12:28 +02:00
|
|
|
explicit ByteStream(ArrayRef<uint8_t> Data) : Data(Data) {}
|
2016-10-20 20:31:19 +02:00
|
|
|
explicit ByteStream(StringRef Data)
|
|
|
|
: Data(Data.bytes_begin(), Data.bytes_end()) {}
|
2016-04-29 19:22:58 +02:00
|
|
|
|
2016-05-27 03:54:44 +02:00
|
|
|
Error readBytes(uint32_t Offset, uint32_t Size,
|
2016-07-28 21:12:28 +02:00
|
|
|
ArrayRef<uint8_t> &Buffer) const override {
|
|
|
|
if (Offset > Data.size())
|
2016-07-29 22:56:36 +02:00
|
|
|
return make_error<MSFError>(msf_error_code::insufficient_buffer);
|
2016-07-28 21:12:28 +02:00
|
|
|
if (Data.size() < Size + Offset)
|
2016-07-29 22:56:36 +02:00
|
|
|
return make_error<MSFError>(msf_error_code::insufficient_buffer);
|
2016-07-28 21:12:28 +02:00
|
|
|
Buffer = Data.slice(Offset, Size);
|
|
|
|
return Error::success();
|
|
|
|
}
|
2016-06-10 07:09:12 +02:00
|
|
|
Error readLongestContiguousChunk(uint32_t Offset,
|
2016-07-28 21:12:28 +02:00
|
|
|
ArrayRef<uint8_t> &Buffer) const override {
|
|
|
|
if (Offset >= Data.size())
|
2016-07-29 22:56:36 +02:00
|
|
|
return make_error<MSFError>(msf_error_code::insufficient_buffer);
|
2016-07-28 21:12:28 +02:00
|
|
|
Buffer = Data.slice(Offset);
|
|
|
|
return Error::success();
|
|
|
|
}
|
2016-06-10 07:09:12 +02:00
|
|
|
|
2016-07-28 21:12:28 +02:00
|
|
|
uint32_t getLength() const override { return Data.size(); }
|
2016-05-03 02:28:21 +02:00
|
|
|
|
2016-07-28 21:12:28 +02:00
|
|
|
ArrayRef<uint8_t> data() const { return Data; }
|
2016-04-29 19:22:58 +02:00
|
|
|
|
2016-07-28 21:12:28 +02:00
|
|
|
StringRef str() const {
|
|
|
|
const char *CharData = reinterpret_cast<const char *>(Data.data());
|
|
|
|
return StringRef(CharData, Data.size());
|
|
|
|
}
|
2016-06-30 19:43:00 +02:00
|
|
|
|
2016-07-28 21:12:28 +02:00
|
|
|
protected:
|
|
|
|
ArrayRef<uint8_t> Data;
|
|
|
|
};
|
|
|
|
|
|
|
|
// MemoryBufferByteStream behaves like a read-only ByteStream, but has its data
|
|
|
|
// backed by an llvm::MemoryBuffer. It also owns the underlying MemoryBuffer.
|
|
|
|
class MemoryBufferByteStream : public ByteStream {
|
|
|
|
public:
|
|
|
|
explicit MemoryBufferByteStream(std::unique_ptr<MemoryBuffer> Buffer)
|
|
|
|
: ByteStream(ArrayRef<uint8_t>(Buffer->getBuffer().bytes_begin(),
|
|
|
|
Buffer->getBuffer().bytes_end())),
|
|
|
|
MemBuffer(std::move(Buffer)) {}
|
|
|
|
|
|
|
|
std::unique_ptr<MemoryBuffer> MemBuffer;
|
|
|
|
};
|
|
|
|
|
|
|
|
class MutableByteStream : public WritableStream {
|
|
|
|
public:
|
|
|
|
MutableByteStream() {}
|
|
|
|
explicit MutableByteStream(MutableArrayRef<uint8_t> Data)
|
|
|
|
: Data(Data), ImmutableStream(Data) {}
|
|
|
|
|
|
|
|
Error readBytes(uint32_t Offset, uint32_t Size,
|
|
|
|
ArrayRef<uint8_t> &Buffer) const override {
|
|
|
|
return ImmutableStream.readBytes(Offset, Size, Buffer);
|
|
|
|
}
|
|
|
|
Error readLongestContiguousChunk(uint32_t Offset,
|
|
|
|
ArrayRef<uint8_t> &Buffer) const override {
|
|
|
|
return ImmutableStream.readLongestContiguousChunk(Offset, Buffer);
|
|
|
|
}
|
|
|
|
|
|
|
|
uint32_t getLength() const override { return ImmutableStream.getLength(); }
|
|
|
|
|
|
|
|
Error writeBytes(uint32_t Offset, ArrayRef<uint8_t> Buffer) const override {
|
2016-11-14 23:05:19 +01:00
|
|
|
if (Buffer.empty())
|
|
|
|
return Error::success();
|
|
|
|
|
2016-07-28 21:12:28 +02:00
|
|
|
if (Data.size() < Buffer.size())
|
2016-07-29 22:56:36 +02:00
|
|
|
return make_error<MSFError>(msf_error_code::insufficient_buffer);
|
2016-07-28 21:12:28 +02:00
|
|
|
if (Offset > Buffer.size() - Data.size())
|
2016-07-29 22:56:36 +02:00
|
|
|
return make_error<MSFError>(msf_error_code::insufficient_buffer);
|
2016-07-28 21:12:28 +02:00
|
|
|
|
|
|
|
uint8_t *DataPtr = const_cast<uint8_t *>(Data.data());
|
|
|
|
::memcpy(DataPtr + Offset, Buffer.data(), Buffer.size());
|
|
|
|
return Error::success();
|
|
|
|
}
|
|
|
|
|
|
|
|
Error commit() const override { return Error::success(); }
|
|
|
|
|
|
|
|
MutableArrayRef<uint8_t> data() const { return Data; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
MutableArrayRef<uint8_t> Data;
|
|
|
|
ByteStream ImmutableStream;
|
|
|
|
};
|
|
|
|
|
|
|
|
// A simple adapter that acts like a ByteStream but holds ownership over
|
|
|
|
// and underlying FileOutputBuffer.
|
|
|
|
class FileBufferByteStream : public WritableStream {
|
|
|
|
private:
|
|
|
|
class StreamImpl : public MutableByteStream {
|
|
|
|
public:
|
|
|
|
StreamImpl(std::unique_ptr<FileOutputBuffer> Buffer)
|
|
|
|
: MutableByteStream(MutableArrayRef<uint8_t>(Buffer->getBufferStart(),
|
|
|
|
Buffer->getBufferEnd())),
|
|
|
|
FileBuffer(std::move(Buffer)) {}
|
|
|
|
|
|
|
|
Error commit() const override {
|
|
|
|
if (FileBuffer->commit())
|
2016-07-29 22:56:36 +02:00
|
|
|
return llvm::make_error<MSFError>(msf_error_code::not_writable);
|
2016-07-28 21:12:28 +02:00
|
|
|
return Error::success();
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
std::unique_ptr<FileOutputBuffer> FileBuffer;
|
|
|
|
};
|
|
|
|
|
|
|
|
public:
|
|
|
|
explicit FileBufferByteStream(std::unique_ptr<FileOutputBuffer> Buffer)
|
|
|
|
: Impl(std::move(Buffer)) {}
|
|
|
|
|
|
|
|
Error readBytes(uint32_t Offset, uint32_t Size,
|
|
|
|
ArrayRef<uint8_t> &Buffer) const override {
|
|
|
|
return Impl.readBytes(Offset, Size, Buffer);
|
|
|
|
}
|
|
|
|
Error readLongestContiguousChunk(uint32_t Offset,
|
|
|
|
ArrayRef<uint8_t> &Buffer) const override {
|
|
|
|
return Impl.readLongestContiguousChunk(Offset, Buffer);
|
|
|
|
}
|
|
|
|
|
|
|
|
uint32_t getLength() const override { return Impl.getLength(); }
|
|
|
|
|
|
|
|
Error writeBytes(uint32_t Offset, ArrayRef<uint8_t> Data) const override {
|
|
|
|
return Impl.writeBytes(Offset, Data);
|
|
|
|
}
|
|
|
|
Error commit() const override { return Impl.commit(); }
|
2016-04-29 19:22:58 +02:00
|
|
|
|
|
|
|
private:
|
2016-07-28 21:12:28 +02:00
|
|
|
StreamImpl Impl;
|
2016-04-29 19:22:58 +02:00
|
|
|
};
|
|
|
|
|
2016-06-10 07:09:12 +02:00
|
|
|
|
2016-07-22 21:56:05 +02:00
|
|
|
} // end namespace msf
|
2016-05-10 01:11:38 +02:00
|
|
|
} // end namespace llvm
|
|
|
|
|
2016-07-22 21:56:05 +02:00
|
|
|
#endif // LLVM_DEBUGINFO_MSF_BYTESTREAM_H
|