#ifndef LLARP_BUFFER_HPP #define LLARP_BUFFER_HPP #include #include #include #include #include #include #include #include #include #include /** * buffer.h * * generic memory buffer */ /** llarp_buffer_t represents a region of memory that is ONLY valid in the current scope. make sure to follow the rules: ALWAYS copy the contents of the buffer if that data is to be used outside the current scope. ALWAYS pass a llarp_buffer_t * if you plan on modifying the data associated with the buffer ALWAYS pass a llarp_buffer_t * if you plan on advancing the stream position ALWAYS pass a const llarp_buffer_t & if you are doing a read only operation that does not modify the buffer ALWAYS pass a const llarp_buffer_t & if you don't want to advance the stream position ALWAYS bail out of the current operation if you run out of space in a buffer ALWAYS assume the pointers in the buffer are stack allocated memory (yes even if you know they are not) NEVER malloc() the pointers in the buffer when using it NEVER realloc() the pointers in the buffer when using it NEVER free() the pointers in the buffer when using it NEVER use llarp_buffer_t ** (double pointers) NEVER use llarp_buffer_t ** (double pointers) ABSOLUTELY NEVER USE DOUBLE POINTERS. */ struct ManagedBuffer; struct llarp_buffer_t { /// starting memory address byte_t *base; /// memory address of stream position byte_t *cur; /// max size of buffer size_t sz; byte_t operator[](size_t x) { return *(this->base + x); } llarp_buffer_t() : base(nullptr), cur(nullptr), sz(0) { } llarp_buffer_t(byte_t *b, byte_t *c, size_t s) : base(b), cur(c), sz(s) { } llarp_buffer_t(const ManagedBuffer &) = delete; llarp_buffer_t(ManagedBuffer &&) = delete; template < typename T > llarp_buffer_t(T *buf, size_t _sz) : base(reinterpret_cast< byte_t * >(buf)), cur(base), sz(_sz) { } template < typename T > llarp_buffer_t(const T *buf, size_t _sz) : base(reinterpret_cast< byte_t * >(const_cast< T * >(buf))) , cur(base) , sz(_sz) { } /** initialize llarp_buffer_t from container */ template < typename T > llarp_buffer_t(T &t) : base(t.data()), cur(t.data()), sz(t.size()) { // use data over the first element to "enforce" the container used has // contiguous memory. (Note this isn't required by the standard, but a // reasonable test on most standard library implementations). } template < typename T > llarp_buffer_t(const T &t) : llarp_buffer_t(t.data(), t.size()) { } size_t size_left() const; template < typename InputIt > bool write(InputIt begin, InputIt end); bool writef(const char *fmt, ...) __attribute__((format(printf, 2, 3))); ; bool put_uint16(uint16_t i); bool put_uint32(uint32_t i); bool read_uint16(uint16_t &i); bool read_uint32(uint32_t &i); size_t read_until(char delim, byte_t *result, size_t resultlen); private: friend struct ManagedBuffer; llarp_buffer_t(const llarp_buffer_t &) = default; llarp_buffer_t(llarp_buffer_t &&) = default; }; bool operator==(const llarp_buffer_t &buff, const char *data); template < typename InputIt > bool llarp_buffer_t::write(InputIt begin, InputIt end) { auto dist = std::distance(begin, end); if(static_cast< decltype(dist) >(size_left()) >= dist) { cur = std::copy(begin, end, cur); return true; } return false; } /** Provide a copyable/moveable wrapper around `llarp_buffer_t`. */ struct ManagedBuffer { llarp_buffer_t underlying; ManagedBuffer() = delete; explicit ManagedBuffer(const llarp_buffer_t &b) : underlying(b) { } ManagedBuffer(ManagedBuffer &&) = default; ManagedBuffer(const ManagedBuffer &) = default; operator const llarp_buffer_t &() const { return underlying; } }; #endif