cannam@135: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors cannam@135: // Licensed under the MIT License: cannam@135: // cannam@135: // Permission is hereby granted, free of charge, to any person obtaining a copy cannam@135: // of this software and associated documentation files (the "Software"), to deal cannam@135: // in the Software without restriction, including without limitation the rights cannam@135: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell cannam@135: // copies of the Software, and to permit persons to whom the Software is cannam@135: // furnished to do so, subject to the following conditions: cannam@135: // cannam@135: // The above copyright notice and this permission notice shall be included in cannam@135: // all copies or substantial portions of the Software. cannam@135: // cannam@135: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR cannam@135: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, cannam@135: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE cannam@135: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER cannam@135: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, cannam@135: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN cannam@135: // THE SOFTWARE. cannam@135: cannam@135: #ifndef KJ_IO_H_ cannam@135: #define KJ_IO_H_ cannam@135: cannam@135: #if defined(__GNUC__) && !KJ_HEADER_WARNINGS cannam@135: #pragma GCC system_header cannam@135: #endif cannam@135: cannam@135: #include cannam@135: #include "common.h" cannam@135: #include "array.h" cannam@135: #include "exception.h" cannam@135: cannam@135: namespace kj { cannam@135: cannam@135: // ======================================================================================= cannam@135: // Abstract interfaces cannam@135: cannam@135: class InputStream { cannam@135: public: cannam@135: virtual ~InputStream() noexcept(false); cannam@135: cannam@135: size_t read(void* buffer, size_t minBytes, size_t maxBytes); cannam@135: // Reads at least minBytes and at most maxBytes, copying them into the given buffer. Returns cannam@135: // the size read. Throws an exception on errors. Implemented in terms of tryRead(). cannam@135: // cannam@135: // maxBytes is the number of bytes the caller really wants, but minBytes is the minimum amount cannam@135: // needed by the caller before it can start doing useful processing. If the stream returns less cannam@135: // than maxBytes, the caller will usually call read() again later to get the rest. Returning cannam@135: // less than maxBytes is useful when it makes sense for the caller to parallelize processing cannam@135: // with I/O. cannam@135: // cannam@135: // Never blocks if minBytes is zero. If minBytes is zero and maxBytes is non-zero, this may cannam@135: // attempt a non-blocking read or may just return zero. To force a read, use a non-zero minBytes. cannam@135: // To detect EOF without throwing an exception, use tryRead(). cannam@135: // cannam@135: // If the InputStream can't produce minBytes, it MUST throw an exception, as the caller is not cannam@135: // expected to understand how to deal with partial reads. cannam@135: cannam@135: virtual size_t tryRead(void* buffer, size_t minBytes, size_t maxBytes) = 0; cannam@135: // Like read(), but may return fewer than minBytes on EOF. cannam@135: cannam@135: inline void read(void* buffer, size_t bytes) { read(buffer, bytes, bytes); } cannam@135: // Convenience method for reading an exact number of bytes. cannam@135: cannam@135: virtual void skip(size_t bytes); cannam@135: // Skips past the given number of bytes, discarding them. The default implementation read()s cannam@135: // into a scratch buffer. cannam@135: }; cannam@135: cannam@135: class OutputStream { cannam@135: public: cannam@135: virtual ~OutputStream() noexcept(false); cannam@135: cannam@135: virtual void write(const void* buffer, size_t size) = 0; cannam@135: // Always writes the full size. Throws exception on error. cannam@135: cannam@135: virtual void write(ArrayPtr> pieces); cannam@135: // Equivalent to write()ing each byte array in sequence, which is what the default implementation cannam@135: // does. Override if you can do something better, e.g. use writev() to do the write in a single cannam@135: // syscall. cannam@135: }; cannam@135: cannam@135: class BufferedInputStream: public InputStream { cannam@135: // An input stream which buffers some bytes in memory to reduce system call overhead. cannam@135: // - OR - cannam@135: // An input stream that actually reads from some in-memory data structure and wants to give its cannam@135: // caller a direct pointer to that memory to potentially avoid a copy. cannam@135: cannam@135: public: cannam@135: virtual ~BufferedInputStream() noexcept(false); cannam@135: cannam@135: ArrayPtr getReadBuffer(); cannam@135: // Get a direct pointer into the read buffer, which contains the next bytes in the input. If the cannam@135: // caller consumes any bytes, it should then call skip() to indicate this. This always returns a cannam@135: // non-empty buffer or throws an exception. Implemented in terms of tryGetReadBuffer(). cannam@135: cannam@135: virtual ArrayPtr tryGetReadBuffer() = 0; cannam@135: // Like getReadBuffer() but may return an empty buffer on EOF. cannam@135: }; cannam@135: cannam@135: class BufferedOutputStream: public OutputStream { cannam@135: // An output stream which buffers some bytes in memory to reduce system call overhead. cannam@135: // - OR - cannam@135: // An output stream that actually writes into some in-memory data structure and wants to give its cannam@135: // caller a direct pointer to that memory to potentially avoid a copy. cannam@135: cannam@135: public: cannam@135: virtual ~BufferedOutputStream() noexcept(false); cannam@135: cannam@135: virtual ArrayPtr getWriteBuffer() = 0; cannam@135: // Get a direct pointer into the write buffer. The caller may choose to fill in some prefix of cannam@135: // this buffer and then pass it to write(), in which case write() may avoid a copy. It is cannam@135: // incorrect to pass to write any slice of this buffer which is not a prefix. cannam@135: }; cannam@135: cannam@135: // ======================================================================================= cannam@135: // Buffered streams implemented as wrappers around regular streams cannam@135: cannam@135: class BufferedInputStreamWrapper: public BufferedInputStream { cannam@135: // Implements BufferedInputStream in terms of an InputStream. cannam@135: // cannam@135: // Note that the underlying stream's position is unpredictable once the wrapper is destroyed, cannam@135: // unless the entire stream was consumed. To read a predictable number of bytes in a buffered cannam@135: // way without going over, you'd need this wrapper to wrap some other wrapper which itself cannam@135: // implements an artificial EOF at the desired point. Such a stream should be trivial to write cannam@135: // but is not provided by the library at this time. cannam@135: cannam@135: public: cannam@135: explicit BufferedInputStreamWrapper(InputStream& inner, ArrayPtr buffer = nullptr); cannam@135: // Creates a buffered stream wrapping the given non-buffered stream. No guarantee is made about cannam@135: // the position of the inner stream after a buffered wrapper has been created unless the entire cannam@135: // input is read. cannam@135: // cannam@135: // If the second parameter is non-null, the stream uses the given buffer instead of allocating cannam@135: // its own. This may improve performance if the buffer can be reused. cannam@135: cannam@135: KJ_DISALLOW_COPY(BufferedInputStreamWrapper); cannam@135: ~BufferedInputStreamWrapper() noexcept(false); cannam@135: cannam@135: // implements BufferedInputStream ---------------------------------- cannam@135: ArrayPtr tryGetReadBuffer() override; cannam@135: size_t tryRead(void* buffer, size_t minBytes, size_t maxBytes) override; cannam@135: void skip(size_t bytes) override; cannam@135: cannam@135: private: cannam@135: InputStream& inner; cannam@135: Array ownedBuffer; cannam@135: ArrayPtr buffer; cannam@135: ArrayPtr bufferAvailable; cannam@135: }; cannam@135: cannam@135: class BufferedOutputStreamWrapper: public BufferedOutputStream { cannam@135: // Implements BufferedOutputStream in terms of an OutputStream. Note that writes to the cannam@135: // underlying stream may be delayed until flush() is called or the wrapper is destroyed. cannam@135: cannam@135: public: cannam@135: explicit BufferedOutputStreamWrapper(OutputStream& inner, ArrayPtr buffer = nullptr); cannam@135: // Creates a buffered stream wrapping the given non-buffered stream. cannam@135: // cannam@135: // If the second parameter is non-null, the stream uses the given buffer instead of allocating cannam@135: // its own. This may improve performance if the buffer can be reused. cannam@135: cannam@135: KJ_DISALLOW_COPY(BufferedOutputStreamWrapper); cannam@135: ~BufferedOutputStreamWrapper() noexcept(false); cannam@135: cannam@135: void flush(); cannam@135: // Force the wrapper to write any remaining bytes in its buffer to the inner stream. Note that cannam@135: // this only flushes this object's buffer; this object has no idea how to flush any other buffers cannam@135: // that may be present in the underlying stream. cannam@135: cannam@135: // implements BufferedOutputStream --------------------------------- cannam@135: ArrayPtr getWriteBuffer() override; cannam@135: void write(const void* buffer, size_t size) override; cannam@135: cannam@135: private: cannam@135: OutputStream& inner; cannam@135: Array ownedBuffer; cannam@135: ArrayPtr buffer; cannam@135: byte* bufferPos; cannam@135: UnwindDetector unwindDetector; cannam@135: }; cannam@135: cannam@135: // ======================================================================================= cannam@135: // Array I/O cannam@135: cannam@135: class ArrayInputStream: public BufferedInputStream { cannam@135: public: cannam@135: explicit ArrayInputStream(ArrayPtr array); cannam@135: KJ_DISALLOW_COPY(ArrayInputStream); cannam@135: ~ArrayInputStream() noexcept(false); cannam@135: cannam@135: // implements BufferedInputStream ---------------------------------- cannam@135: ArrayPtr tryGetReadBuffer() override; cannam@135: size_t tryRead(void* buffer, size_t minBytes, size_t maxBytes) override; cannam@135: void skip(size_t bytes) override; cannam@135: cannam@135: private: cannam@135: ArrayPtr array; cannam@135: }; cannam@135: cannam@135: class ArrayOutputStream: public BufferedOutputStream { cannam@135: public: cannam@135: explicit ArrayOutputStream(ArrayPtr array); cannam@135: KJ_DISALLOW_COPY(ArrayOutputStream); cannam@135: ~ArrayOutputStream() noexcept(false); cannam@135: cannam@135: ArrayPtr getArray() { cannam@135: // Get the portion of the array which has been filled in. cannam@135: return arrayPtr(array.begin(), fillPos); cannam@135: } cannam@135: cannam@135: // implements BufferedInputStream ---------------------------------- cannam@135: ArrayPtr getWriteBuffer() override; cannam@135: void write(const void* buffer, size_t size) override; cannam@135: cannam@135: private: cannam@135: ArrayPtr array; cannam@135: byte* fillPos; cannam@135: }; cannam@135: cannam@135: class VectorOutputStream: public BufferedOutputStream { cannam@135: public: cannam@135: explicit VectorOutputStream(size_t initialCapacity = 4096); cannam@135: KJ_DISALLOW_COPY(VectorOutputStream); cannam@135: ~VectorOutputStream() noexcept(false); cannam@135: cannam@135: ArrayPtr getArray() { cannam@135: // Get the portion of the array which has been filled in. cannam@135: return arrayPtr(vector.begin(), fillPos); cannam@135: } cannam@135: cannam@135: // implements BufferedInputStream ---------------------------------- cannam@135: ArrayPtr getWriteBuffer() override; cannam@135: void write(const void* buffer, size_t size) override; cannam@135: cannam@135: private: cannam@135: Array vector; cannam@135: byte* fillPos; cannam@135: cannam@135: void grow(size_t minSize); cannam@135: }; cannam@135: cannam@135: // ======================================================================================= cannam@135: // File descriptor I/O cannam@135: cannam@135: class AutoCloseFd { cannam@135: // A wrapper around a file descriptor which automatically closes the descriptor when destroyed. cannam@135: // The wrapper supports move construction for transferring ownership of the descriptor. If cannam@135: // close() returns an error, the destructor throws an exception, UNLESS the destructor is being cannam@135: // called during unwind from another exception, in which case the close error is ignored. cannam@135: // cannam@135: // If your code is not exception-safe, you should not use AutoCloseFd. In this case you will cannam@135: // have to call close() yourself and handle errors appropriately. cannam@135: cannam@135: public: cannam@135: inline AutoCloseFd(): fd(-1) {} cannam@135: inline AutoCloseFd(decltype(nullptr)): fd(-1) {} cannam@135: inline explicit AutoCloseFd(int fd): fd(fd) {} cannam@135: inline AutoCloseFd(AutoCloseFd&& other) noexcept: fd(other.fd) { other.fd = -1; } cannam@135: KJ_DISALLOW_COPY(AutoCloseFd); cannam@135: ~AutoCloseFd() noexcept(false); cannam@135: cannam@135: inline AutoCloseFd& operator=(AutoCloseFd&& other) { cannam@135: AutoCloseFd old(kj::mv(*this)); cannam@135: fd = other.fd; cannam@135: other.fd = -1; cannam@135: return *this; cannam@135: } cannam@135: cannam@135: inline AutoCloseFd& operator=(decltype(nullptr)) { cannam@135: AutoCloseFd old(kj::mv(*this)); cannam@135: return *this; cannam@135: } cannam@135: cannam@135: inline operator int() const { return fd; } cannam@135: inline int get() const { return fd; } cannam@135: cannam@135: operator bool() const = delete; cannam@135: // Deleting this operator prevents accidental use in boolean contexts, which cannam@135: // the int conversion operator above would otherwise allow. cannam@135: cannam@135: inline bool operator==(decltype(nullptr)) { return fd < 0; } cannam@135: inline bool operator!=(decltype(nullptr)) { return fd >= 0; } cannam@135: cannam@135: private: cannam@135: int fd; cannam@135: UnwindDetector unwindDetector; cannam@135: }; cannam@135: cannam@135: inline auto KJ_STRINGIFY(const AutoCloseFd& fd) cannam@135: -> decltype(kj::toCharSequence(implicitCast(fd))) { cannam@135: return kj::toCharSequence(implicitCast(fd)); cannam@135: } cannam@135: cannam@135: class FdInputStream: public InputStream { cannam@135: // An InputStream wrapping a file descriptor. cannam@135: cannam@135: public: cannam@135: explicit FdInputStream(int fd): fd(fd) {} cannam@135: explicit FdInputStream(AutoCloseFd fd): fd(fd), autoclose(mv(fd)) {} cannam@135: KJ_DISALLOW_COPY(FdInputStream); cannam@135: ~FdInputStream() noexcept(false); cannam@135: cannam@135: size_t tryRead(void* buffer, size_t minBytes, size_t maxBytes) override; cannam@135: cannam@135: private: cannam@135: int fd; cannam@135: AutoCloseFd autoclose; cannam@135: }; cannam@135: cannam@135: class FdOutputStream: public OutputStream { cannam@135: // An OutputStream wrapping a file descriptor. cannam@135: cannam@135: public: cannam@135: explicit FdOutputStream(int fd): fd(fd) {} cannam@135: explicit FdOutputStream(AutoCloseFd fd): fd(fd), autoclose(mv(fd)) {} cannam@135: KJ_DISALLOW_COPY(FdOutputStream); cannam@135: ~FdOutputStream() noexcept(false); cannam@135: cannam@135: void write(const void* buffer, size_t size) override; cannam@135: void write(ArrayPtr> pieces) override; cannam@135: cannam@135: private: cannam@135: int fd; cannam@135: AutoCloseFd autoclose; cannam@135: }; cannam@135: cannam@135: } // namespace kj cannam@135: cannam@135: #endif // KJ_IO_H_