mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-24 03:33:20 +01:00
5fd8290a6c
Often you have an array and you just want to use it. With the current design, you have to first construct a `BinaryByteStream`, and then create a `BinaryStreamRef` from it. Worse, the `BinaryStreamRef` holds a pointer to the `BinaryByteStream`, so you can't just create a temporary one to appease the compiler, you have to actually hold onto both the `ArrayRef` as well as the `BinaryByteStream` *AND* the `BinaryStreamReader` on top of that. This makes for very cumbersome code, often requiring one to store a `BinaryByteStream` in a class just to circumvent this. At the cost of some added complexity (not exposed to users, but internal to the library), we can do better than this. This patch allows us to construct `BinaryStreamReaders` and `BinaryStreamWriters` directly from source data (e.g. `StringRef`, `MutableArrayRef<uint8_t>`, etc). Not only does this reduce the amount of code you have to type and make it more obvious how to use it, but it solves real lifetime issues when it's inconvenient to hold onto a `BinaryByteStream` for a long time. The additional complexity is in the form of an added layer of indirection. Whereas before we simply stored a `BinaryStream*` in the ref, we now store both a `BinaryStream*` **and** a `std::shared_ptr<BinaryStream>`. When the user wants to construct a `BinaryStreamRef` directly from an `ArrayRef` etc, we allocate an internal object that holds ownership over a `BinaryByteStream` and forwards all calls, and store this in the `shared_ptr<>`. This also maintains the ref semantics, as you can copy it by value and references refer to the same underlying stream -- the one being held in the object stored in the `shared_ptr`. Differential Revision: https://reviews.llvm.org/D33293 llvm-svn: 303294
89 lines
2.9 KiB
C++
89 lines
2.9 KiB
C++
//===- BinaryStreamWriter.cpp - Writes objects to a BinaryStream ----------===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/Support/BinaryStreamWriter.h"
|
|
|
|
#include "llvm/Support/BinaryStreamError.h"
|
|
#include "llvm/Support/BinaryStreamReader.h"
|
|
#include "llvm/Support/BinaryStreamRef.h"
|
|
|
|
using namespace llvm;
|
|
|
|
BinaryStreamWriter::BinaryStreamWriter(WritableBinaryStreamRef Ref)
|
|
: Stream(Ref) {}
|
|
|
|
BinaryStreamWriter::BinaryStreamWriter(WritableBinaryStream &Stream)
|
|
: Stream(Stream) {}
|
|
|
|
BinaryStreamWriter::BinaryStreamWriter(MutableArrayRef<uint8_t> Data,
|
|
llvm::support::endianness Endian)
|
|
: Stream(Data, Endian) {}
|
|
|
|
Error BinaryStreamWriter::writeBytes(ArrayRef<uint8_t> Buffer) {
|
|
if (auto EC = Stream.writeBytes(Offset, Buffer))
|
|
return EC;
|
|
Offset += Buffer.size();
|
|
return Error::success();
|
|
}
|
|
|
|
Error BinaryStreamWriter::writeCString(StringRef Str) {
|
|
if (auto EC = writeFixedString(Str))
|
|
return EC;
|
|
if (auto EC = writeObject('\0'))
|
|
return EC;
|
|
|
|
return Error::success();
|
|
}
|
|
|
|
Error BinaryStreamWriter::writeFixedString(StringRef Str) {
|
|
return writeBytes(ArrayRef<uint8_t>(Str.bytes_begin(), Str.bytes_end()));
|
|
}
|
|
|
|
Error BinaryStreamWriter::writeStreamRef(BinaryStreamRef Ref) {
|
|
return writeStreamRef(Ref, Ref.getLength());
|
|
}
|
|
|
|
Error BinaryStreamWriter::writeStreamRef(BinaryStreamRef Ref, uint32_t Length) {
|
|
BinaryStreamReader SrcReader(Ref.slice(0, Length));
|
|
// This is a bit tricky. If we just call readBytes, we are requiring that it
|
|
// return us the entire stream as a contiguous buffer. There is no guarantee
|
|
// this can be satisfied by returning a reference straight from the buffer, as
|
|
// an implementation may not store all data in a single contiguous buffer. So
|
|
// we iterate over each contiguous chunk, writing each one in succession.
|
|
while (SrcReader.bytesRemaining() > 0) {
|
|
ArrayRef<uint8_t> Chunk;
|
|
if (auto EC = SrcReader.readLongestContiguousChunk(Chunk))
|
|
return EC;
|
|
if (auto EC = writeBytes(Chunk))
|
|
return EC;
|
|
}
|
|
return Error::success();
|
|
}
|
|
|
|
std::pair<BinaryStreamWriter, BinaryStreamWriter>
|
|
BinaryStreamWriter::split(uint32_t Off) const {
|
|
assert(getLength() >= Off);
|
|
|
|
WritableBinaryStreamRef First = Stream.drop_front(Offset);
|
|
|
|
WritableBinaryStreamRef Second = First.drop_front(Off);
|
|
First = First.keep_front(Off);
|
|
BinaryStreamWriter W1{First};
|
|
BinaryStreamWriter W2{Second};
|
|
return std::make_pair(W1, W2);
|
|
}
|
|
|
|
Error BinaryStreamWriter::padToAlignment(uint32_t Align) {
|
|
uint32_t NewOffset = alignTo(Offset, Align);
|
|
if (NewOffset > getLength())
|
|
return make_error<BinaryStreamError>(stream_error_code::stream_too_short);
|
|
Offset = NewOffset;
|
|
return Error::success();
|
|
}
|