// Copyright (c) 2009-2010 Satoshi Nakamoto // Copyright (c) 2009-2012 The Bitcoin developers // Distributed under the MIT/X11 software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_SERIALIZE_H #define BITCOIN_SERIALIZE_H #include #include #include #include #include #include #include #include #include #include #if defined __USE_MINGW_ANSI_STDIO #undef __USE_MINGW_ANSI_STDIO // This constant forces MinGW to conduct stupid behavior #endif class CScript; static const unsigned int MAX_SIZE = 0x02000000; // Used to bypass the rule against non-const reference to temporary // where it makes sense with wrappers such as CFlatData or CTxDB template inline T& REF(const T& val) { return const_cast(val); } ///////////////////////////////////////////////////////////////// // // Templates for serializing to anything that looks like a stream, // i.e. anything that supports .read(char*, int) and .write(char*, int) // enum { // primary actions SER_NETWORK = (1 << 0), SER_DISK = (1 << 1), SER_GETHASH = (1 << 2), // modifiers SER_SKIPSIG = (1 << 16), SER_BLOCKHEADERONLY = (1 << 17) }; #define IMPLEMENT_SERIALIZE(statements) \ unsigned int GetSerializeSize(int nType, int nVersion) const \ { \ CSerActionGetSerializeSize ser_action; \ const bool fGetSize = true; \ const bool fWrite = false; \ const bool fRead = false; \ unsigned int nSerSize = 0; \ ser_streamplaceholder s; \ assert(fGetSize||fWrite||fRead); /* suppress warning */ \ s.nType = nType; \ s.nVersion = nVersion; \ {statements} \ return nSerSize; \ } \ template \ void Serialize(Stream& s, int nType, int nVersion) const \ { \ CSerActionSerialize ser_action; \ const bool fGetSize = false; \ const bool fWrite = true; \ const bool fRead = false; \ unsigned int nSerSize = 0; \ assert(fGetSize||fWrite||fRead); /* suppress warning */ \ {statements} \ } \ template \ void Unserialize(Stream& s, int nType, int nVersion) \ { \ CSerActionUnserialize ser_action; \ const bool fGetSize = false; \ const bool fWrite = false; \ const bool fRead = true; \ unsigned int nSerSize = 0; \ assert(fGetSize||fWrite||fRead); /* suppress warning */ \ {statements} \ } #define READWRITE(obj) (nSerSize += ::SerReadWrite(s, (obj), nType, nVersion, ser_action)) // // Basic types // #define WRITEDATA(s, obj) s.write((char*)&(obj), sizeof(obj)) #define READDATA(s, obj) s.read((char*)&(obj), sizeof(obj)) inline unsigned int GetSerializeSize(char a, int, int=0) { return sizeof(a); } inline unsigned int GetSerializeSize(signed char a, int, int=0) { return sizeof(a); } inline unsigned int GetSerializeSize(unsigned char a, int, int=0) { return sizeof(a); } inline unsigned int GetSerializeSize(signed short a, int, int=0) { return sizeof(a); } inline unsigned int GetSerializeSize(unsigned short a, int, int=0) { return sizeof(a); } inline unsigned int GetSerializeSize(signed int a, int, int=0) { return sizeof(a); } inline unsigned int GetSerializeSize(unsigned int a, int, int=0) { return sizeof(a); } //inline unsigned int GetSerializeSize(signed long a, int, int=0) { return sizeof(a); } //inline unsigned int GetSerializeSize(unsigned long a, int, int=0) { return sizeof(a); } inline unsigned int GetSerializeSize(int64_t a, int, int=0) { return sizeof(a); } inline unsigned int GetSerializeSize(uint64_t a, int, int=0) { return sizeof(a); } inline unsigned int GetSerializeSize(float a, int, int=0) { return sizeof(a); } inline unsigned int GetSerializeSize(double a, int, int=0) { return sizeof(a); } template inline void Serialize(Stream& s, char a, int, int=0) { WRITEDATA(s, a); } template inline void Serialize(Stream& s, signed char a, int, int=0) { WRITEDATA(s, a); } template inline void Serialize(Stream& s, unsigned char a, int, int=0) { WRITEDATA(s, a); } template inline void Serialize(Stream& s, signed short a, int, int=0) { WRITEDATA(s, a); } template inline void Serialize(Stream& s, unsigned short a, int, int=0) { WRITEDATA(s, a); } template inline void Serialize(Stream& s, signed int a, int, int=0) { WRITEDATA(s, a); } template inline void Serialize(Stream& s, unsigned int a, int, int=0) { WRITEDATA(s, a); } //template inline void Serialize(Stream& s, signed long a, int, int=0) { WRITEDATA(s, a); } //template inline void Serialize(Stream& s, unsigned long a, int, int=0) { WRITEDATA(s, a); } template inline void Serialize(Stream& s, int64_t a, int, int=0) { WRITEDATA(s, a); } template inline void Serialize(Stream& s, uint64_t a, int, int=0) { WRITEDATA(s, a); } template inline void Serialize(Stream& s, float a, int, int=0) { WRITEDATA(s, a); } template inline void Serialize(Stream& s, double a, int, int=0) { WRITEDATA(s, a); } template inline void Unserialize(Stream& s, char& a, int, int=0) { READDATA(s, a); } template inline void Unserialize(Stream& s, signed char& a, int, int=0) { READDATA(s, a); } template inline void Unserialize(Stream& s, unsigned char& a, int, int=0) { READDATA(s, a); } template inline void Unserialize(Stream& s, signed short& a, int, int=0) { READDATA(s, a); } template inline void Unserialize(Stream& s, unsigned short& a, int, int=0) { READDATA(s, a); } template inline void Unserialize(Stream& s, signed int& a, int, int=0) { READDATA(s, a); } template inline void Unserialize(Stream& s, unsigned int& a, int, int=0) { READDATA(s, a); } //template inline void Unserialize(Stream& s, signed long& a, int, int=0) { READDATA(s, a); } //template inline void Unserialize(Stream& s, unsigned long& a, int, int=0) { READDATA(s, a); } template inline void Unserialize(Stream& s, int64_t& a, int, int=0) { READDATA(s, a); } template inline void Unserialize(Stream& s, uint64_t& a, int, int=0) { READDATA(s, a); } template inline void Unserialize(Stream& s, float& a, int, int=0) { READDATA(s, a); } template inline void Unserialize(Stream& s, double& a, int, int=0) { READDATA(s, a); } inline unsigned int GetSerializeSize(bool a, int, int=0) { return sizeof(char); } template inline void Serialize(Stream& s, bool a, int, int=0) { char f=a; WRITEDATA(s, f); } template inline void Unserialize(Stream& s, bool& a, int, int=0) { char f; READDATA(s, f); a=f; } // // Compact size // size < 253 -- 1 byte // size <= USHRT_MAX -- 3 bytes (253 + 2 bytes) // size <= UINT_MAX -- 5 bytes (254 + 4 bytes) // size > UINT_MAX -- 9 bytes (255 + 8 bytes) // inline unsigned int GetSizeOfCompactSize(uint64_t nSize) { if (nSize < 253) return sizeof(unsigned char); else if (nSize <= std::numeric_limits::max()) return sizeof(unsigned char) + sizeof(unsigned short); else if (nSize <= std::numeric_limits::max()) return sizeof(unsigned char) + sizeof(unsigned int); else return sizeof(unsigned char) + sizeof(uint64_t); } template void WriteCompactSize(Stream& os, uint64_t nSize) { if (nSize < 253) { unsigned char chSize = (unsigned char)nSize; WRITEDATA(os, chSize); } else if (nSize <= std::numeric_limits::max()) { unsigned char chSize = 253; unsigned short xSize = (unsigned short)nSize; WRITEDATA(os, chSize); WRITEDATA(os, xSize); } else if (nSize <= std::numeric_limits::max()) { unsigned char chSize = 254; unsigned int xSize = (unsigned int)nSize; WRITEDATA(os, chSize); WRITEDATA(os, xSize); } else { unsigned char chSize = 255; uint64_t xSize = nSize; WRITEDATA(os, chSize); WRITEDATA(os, xSize); } return; } template uint64_t ReadCompactSize(Stream& is) { unsigned char chSize; READDATA(is, chSize); uint64_t nSizeRet = 0; if (chSize < 253) { nSizeRet = chSize; } else if (chSize == 253) { unsigned short xSize; READDATA(is, xSize); nSizeRet = xSize; } else if (chSize == 254) { unsigned int xSize; READDATA(is, xSize); nSizeRet = xSize; } else { uint64_t xSize; READDATA(is, xSize); nSizeRet = xSize; } if (nSizeRet > (uint64_t)MAX_SIZE) throw std::ios_base::failure("ReadCompactSize() : size too large"); return nSizeRet; } // Variable-length integers: bytes are a MSB base-128 encoding of the number. // The high bit in each byte signifies whether another digit follows. To make // the encoding is one-to-one, one is subtracted from all but the last digit. // Thus, the byte sequence a[] with length len, where all but the last byte // has bit 128 set, encodes the number: // // (a[len-1] & 0x7F) + sum(i=1..len-1, 128^i*((a[len-i-1] & 0x7F)+1)) // // Properties: // * Very small (0-127: 1 byte, 128-16511: 2 bytes, 16512-2113663: 3 bytes) // * Every integer has exactly one encoding // * Encoding does not depend on size of original integer type // * No redundancy: every (infinite) byte sequence corresponds to a list // of encoded integers. // // 0: [0x00] 256: [0x81 0x00] // 1: [0x01] 16383: [0xFE 0x7F] // 127: [0x7F] 16384: [0xFF 0x00] // 128: [0x80 0x00] 16511: [0x80 0xFF 0x7F] // 255: [0x80 0x7F] 65535: [0x82 0xFD 0x7F] // 2^32: [0x8E 0xFE 0xFE 0xFF 0x00] template inline unsigned int GetSizeOfVarInt(I n) { int nRet = 0; for ( ; ; ) { nRet++; if (n <= 0x7F) break; n = (n >> 7) - 1; } return nRet; } template void WriteVarInt(Stream& os, I n) { unsigned char tmp[(sizeof(n)*8+6)/7]; int len=0; for ( ; ; ) { tmp[len] = (n & 0x7F) | (len ? 0x80 : 0x00); if (n <= 0x7F) break; n = (n >> 7) - 1; len++; } do { WRITEDATA(os, tmp[len]); } while(len--); } template I ReadVarInt(Stream& is) { I n = 0; for ( ; ; ) { unsigned char chData; READDATA(is, chData); n = (n << 7) | (chData & 0x7F); if (chData & 0x80) n++; else return n; } } #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj))) #define VARINT(obj) REF(WrapVarInt(REF(obj))) /** Wrapper for serializing arrays and POD. */ class CFlatData { protected: char* pbegin; char* pend; public: CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { } char* begin() { return pbegin; } const char* begin() const { return pbegin; } char* end() { return pend; } const char* end() const { return pend; } unsigned int GetSerializeSize(int, int=0) const { return (unsigned int)(pend - pbegin); } template void Serialize(Stream& s, int, int=0) const { s.write(pbegin, (int)(pend - pbegin)); } template void Unserialize(Stream& s, int, int=0) { s.read(pbegin, pend - pbegin); } }; template class CVarInt { protected: I &n; public: CVarInt(I& nIn) : n(nIn) { } unsigned int GetSerializeSize(int, int) const { return GetSizeOfVarInt(n); } template void Serialize(Stream &s, int, int) const { WriteVarInt(s, n); } template void Unserialize(Stream& s, int, int) { n = ReadVarInt(s); } }; template CVarInt WrapVarInt(I& n) { return CVarInt(n); } // // Forward declarations // // string template unsigned int GetSerializeSize(const std::basic_string& str, int, int=0); template void Serialize(Stream& os, const std::basic_string& str, int, int=0); template void Unserialize(Stream& is, std::basic_string& str, int, int=0); // vector template unsigned int GetSerializeSize_impl(const std::vector& v, int nType, int nVersion, const std::true_type&); template unsigned int GetSerializeSize_impl(const std::vector& v, int nType, int nVersion, const std::false_type&); template inline unsigned int GetSerializeSize(const std::vector& v, int nType, int nVersion); template void Serialize_impl(Stream& os, const std::vector& v, int nType, int nVersion, const std::true_type&); template void Serialize_impl(Stream& os, const std::vector& v, int nType, int nVersion, const std::false_type&); template inline void Serialize(Stream& os, const std::vector& v, int nType, int nVersion); template void Unserialize_impl(Stream& is, std::vector& v, int nType, int nVersion, const std::true_type&); template void Unserialize_impl(Stream& is, std::vector& v, int nType, int nVersion, const std::false_type&); template inline void Unserialize(Stream& is, std::vector& v, int nType, int nVersion); // others derived from vector extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion); template void Serialize(Stream& os, const CScript& v, int nType, int nVersion); template void Unserialize(Stream& is, CScript& v, int nType, int nVersion); // pair template unsigned int GetSerializeSize(const std::pair& item, int nType, int nVersion); template void Serialize(Stream& os, const std::pair& item, int nType, int nVersion); template void Unserialize(Stream& is, std::pair& item, int nType, int nVersion); // 3 tuple template unsigned int GetSerializeSize(const std::tuple& item, int nType, int nVersion); template void Serialize(Stream& os, const std::tuple& item, int nType, int nVersion); template void Unserialize(Stream& is, std::tuple& item, int nType, int nVersion); // 4 tuple template unsigned int GetSerializeSize(const std::tuple& item, int nType, int nVersion); template void Serialize(Stream& os, const std::tuple& item, int nType, int nVersion); template void Unserialize(Stream& is, std::tuple& item, int nType, int nVersion); // map template unsigned int GetSerializeSize(const std::map& m, int nType, int nVersion); template void Serialize(Stream& os, const std::map& m, int nType, int nVersion); template void Unserialize(Stream& is, std::map& m, int nType, int nVersion); // set template unsigned int GetSerializeSize(const std::set& m, int nType, int nVersion); template void Serialize(Stream& os, const std::set& m, int nType, int nVersion); template void Unserialize(Stream& is, std::set& m, int nType, int nVersion); // // If none of the specialized versions above matched, default to calling member function. // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error. // The compiler will only cast int to long if none of the other templates matched. // Thanks to Boost serialization for this idea. // template inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion) { return a.GetSerializeSize((int)nType, nVersion); } template inline void Serialize(Stream& os, const T& a, long nType, int nVersion) { a.Serialize(os, (int)nType, nVersion); } template inline void Unserialize(Stream& is, T& a, long nType, int nVersion) { a.Unserialize(is, (int)nType, nVersion); } // // string // template unsigned int GetSerializeSize(const std::basic_string& str, int, int) { return (unsigned int)(GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0])); } template void Serialize(Stream& os, const std::basic_string& str, int, int) { WriteCompactSize(os, str.size()); if (!str.empty()) os.write((char*)&str[0], (int)(str.size() * sizeof(str[0]))); } template void Unserialize(Stream& is, std::basic_string& str, int, int) { unsigned int nSize = (unsigned int)(ReadCompactSize(is)); str.resize(nSize); if (nSize != 0) is.read((char*)&str[0], nSize * sizeof(str[0])); } // // vector // template unsigned int GetSerializeSize_impl(const std::vector& v, int nType, int nVersion, const std::true_type&) { return (unsigned int)(GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T)); } template unsigned int GetSerializeSize_impl(const std::vector& v, int nType, int nVersion, const std::false_type&) { unsigned int nSize = GetSizeOfCompactSize(v.size()); for (typename std::vector::const_iterator vi = v.begin(); vi != v.end(); ++vi) nSize += GetSerializeSize((*vi), nType, nVersion); return nSize; } template inline unsigned int GetSerializeSize(const std::vector& v, int nType, int nVersion) { return GetSerializeSize_impl(v, nType, nVersion, std::is_fundamental()); } template void Serialize_impl(Stream& os, const std::vector& v, int nType, int nVersion, const std::true_type&) { WriteCompactSize(os, v.size()); if (!v.empty()) os.write((char*)&v[0], (int)(v.size() * sizeof(T))); } template void Serialize_impl(Stream& os, const std::vector& v, int nType, int nVersion, const std::false_type&) { WriteCompactSize(os, v.size()); for (typename std::vector::const_iterator vi = v.begin(); vi != v.end(); ++vi) ::Serialize(os, (*vi), nType, nVersion); } template inline void Serialize(Stream& os, const std::vector& v, int nType, int nVersion) { Serialize_impl(os, v, nType, nVersion, std::is_fundamental()); } template void Unserialize_impl(Stream& is, std::vector& v, int nType, int nVersion, const std::true_type&) { // Limit size per read so bogus size value won't cause out of memory v.clear(); unsigned int nSize = (unsigned int)(ReadCompactSize(is)); unsigned int i = 0; while (i < nSize) { unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T))); v.resize(i + blk); is.read((char*)&v[i], blk * sizeof(T)); i += blk; } } template void Unserialize_impl(Stream& is, std::vector& v, int nType, int nVersion, const std::false_type&) { v.clear(); unsigned int nSize = (unsigned int)(ReadCompactSize(is)); unsigned int i = 0; unsigned int nMid = 0; while (nMid < nSize) { nMid += 5000000 / sizeof(T); if (nMid > nSize) nMid = nSize; v.resize(nMid); for (; i < nMid; i++) Unserialize(is, v[i], nType, nVersion); } } template inline void Unserialize(Stream& is, std::vector& v, int nType, int nVersion) { Unserialize_impl(is, v, nType, nVersion, std::is_fundamental()); } // // others derived from vector // inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion) { return GetSerializeSize((const std::vector&)v, nType, nVersion); } template void Serialize(Stream& os, const CScript& v, int nType, int nVersion) { Serialize(os, (const std::vector&)v, nType, nVersion); } template void Unserialize(Stream& is, CScript& v, int nType, int nVersion) { Unserialize(is, (std::vector&)v, nType, nVersion); } // // pair // template unsigned int GetSerializeSize(const std::pair& item, int nType, int nVersion) { return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion); } template void Serialize(Stream& os, const std::pair& item, int nType, int nVersion) { Serialize(os, item.first, nType, nVersion); Serialize(os, item.second, nType, nVersion); } template void Unserialize(Stream& is, std::pair& item, int nType, int nVersion) { Unserialize(is, item.first, nType, nVersion); Unserialize(is, item.second, nType, nVersion); } // // 3 tuple // template unsigned int GetSerializeSize(const std::tuple& item, int nType, int nVersion) { unsigned int nSize = 0; nSize += GetSerializeSize(std::get<0>(item), nType, nVersion); nSize += GetSerializeSize(std::get<1>(item), nType, nVersion); nSize += GetSerializeSize(std::get<2>(item), nType, nVersion); return nSize; } template void Serialize(Stream& os, const std::tuple& item, int nType, int nVersion) { Serialize(os, std::get<0>(item), nType, nVersion); Serialize(os, std::get<1>(item), nType, nVersion); Serialize(os, std::get<2>(item), nType, nVersion); } template void Unserialize(Stream& is, std::tuple& item, int nType, int nVersion) { Unserialize(is, std::get<0>(item), nType, nVersion); Unserialize(is, std::get<1>(item), nType, nVersion); Unserialize(is, std::get<2>(item), nType, nVersion); } // // 4 tuple // template unsigned int GetSerializeSize(const std::tuple& item, int nType, int nVersion) { unsigned int nSize = 0; nSize += GetSerializeSize(std::get<0>(item), nType, nVersion); nSize += GetSerializeSize(std::get<1>(item), nType, nVersion); nSize += GetSerializeSize(std::get<2>(item), nType, nVersion); nSize += GetSerializeSize(std::get<3>(item), nType, nVersion); return nSize; } template void Serialize(Stream& os, const std::tuple& item, int nType, int nVersion) { Serialize(os, std::get<0>(item), nType, nVersion); Serialize(os, std::get<1>(item), nType, nVersion); Serialize(os, std::get<2>(item), nType, nVersion); Serialize(os, std::get<3>(item), nType, nVersion); } template void Unserialize(Stream& is, std::tuple& item, int nType, int nVersion) { Unserialize(is, std::get<0>(item), nType, nVersion); Unserialize(is, std::get<1>(item), nType, nVersion); Unserialize(is, std::get<2>(item), nType, nVersion); Unserialize(is, std::get<3>(item), nType, nVersion); } // // map // template unsigned int GetSerializeSize(const std::map& m, int nType, int nVersion) { unsigned int nSize = GetSizeOfCompactSize(m.size()); for (typename std::map::const_iterator mi = m.begin(); mi != m.end(); ++mi) nSize += GetSerializeSize((*mi), nType, nVersion); return nSize; } template void Serialize(Stream& os, const std::map& m, int nType, int nVersion) { WriteCompactSize(os, m.size()); for (typename std::map::const_iterator mi = m.begin(); mi != m.end(); ++mi) Serialize(os, (*mi), nType, nVersion); } template void Unserialize(Stream& is, std::map& m, int nType, int nVersion) { m.clear(); unsigned int nSize = (unsigned int)(ReadCompactSize(is)); typename std::map::iterator mi = m.begin(); for (unsigned int i = 0; i < nSize; i++) { std::pair item; Unserialize(is, item, nType, nVersion); mi = m.insert(mi, item); } } // // set // template unsigned int GetSerializeSize(const std::set& m, int nType, int nVersion) { unsigned int nSize = GetSizeOfCompactSize(m.size()); for (typename std::set::const_iterator it = m.begin(); it != m.end(); ++it) nSize += GetSerializeSize((*it), nType, nVersion); return nSize; } template void Serialize(Stream& os, const std::set& m, int nType, int nVersion) { WriteCompactSize(os, m.size()); for (typename std::set::const_iterator it = m.begin(); it != m.end(); ++it) Serialize(os, (*it), nType, nVersion); } template void Unserialize(Stream& is, std::set& m, int nType, int nVersion) { m.clear(); unsigned int nSize = ReadCompactSize(is); typename std::set::iterator it = m.begin(); for (unsigned int i = 0; i < nSize; i++) { K key; Unserialize(is, key, nType, nVersion); it = m.insert(it, key); } } // // Support for IMPLEMENT_SERIALIZE and READWRITE macro // class CSerActionGetSerializeSize { }; class CSerActionSerialize { }; class CSerActionUnserialize { }; template inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action) { return ::GetSerializeSize(obj, nType, nVersion); } template inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action) { ::Serialize(s, obj, nType, nVersion); return 0; } template inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action) { ::Unserialize(s, obj, nType, nVersion); return 0; } struct ser_streamplaceholder { int nType; int nVersion; }; #endif