OpenTTD-patches/src/misc/blob.hpp

/* $Id$ */

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */

/** @file blob.hpp Support for storing random binary data. */

#ifndef BLOB_HPP
#define BLOB_HPP

#include "../core/alloc_func.hpp"
#include "../core/mem_func.hpp"
#include <new>

/** Base class for simple binary blobs.
 *  Item is byte.
 *  The word 'simple' means:
 *    - no configurable allocator type (always made from heap)
 *    - no smart deallocation - deallocation must be called from the same
 *        module (DLL) where the blob was allocated
 *    - no configurable allocation policy (how big blocks should be allocated)
 *    - no extra ownership policy (i.e. 'copy on write') when blob is copied
 *    - no thread synchronization at all
 *
 *  Internal member layout:
 *  1. The only class member is pointer to the first item (see union).
 *  2. Allocated block contains the blob header (see BlobHeader) followed by the raw byte data.
 *     Always, when it allocates memory the allocated size is:
 *                                                      sizeof(BlobHeader) + <data capacity>
 *  3. Two 'virtual' members (items and capacity) are stored in the BlobHeader at beginning
 *     of the alloated block.
 *  4. The pointer of the union pobsize_ts behind the header (to the first data byte).
 *     When memory block is allocated, the sizeof(BlobHeader) it added to it.
 *  5. Benefits of this layout:
 *     - items are accessed in the simplest possible way - just dereferencing the pointer,
 *       which is good for performance (assuming that data are accessed most often).
 *     - sizeof(blob) is the same as the size of any other pointer
 *  6. Drawbacks of this layout:
 *     - the fact, that pointer to the alocated block is adjusted by sizeof(BlobHeader) before
 *       it is stored can lead to several confusions:
 *         - it is not common pattern so the implementation code is bit harder to read
 *         - valgrind can generate warning that allocated block is lost (not accessible)
 */
class ByteBlob {
protected:
	/** header of the allocated memory block */
	struct BlobHeader {
		uint    items;      ///< actual blob size in bytes
		uint    capacity;  ///< maximum (allocated) size in bytes
	};

	/** type used as class member */
	union {
		byte *data;    ///< ptr to the first byte of data
		BlobHeader *header;   ///< ptr just after the BlobHeader holding items and capacity
	};

private:
	/**
	 * Just to silence an unsilencable GCC 4.4+ warning
	 * Note: This cannot be 'const' as we do a lot of 'hdrEmpty[0]->items += 0;' and 'hdrEmpty[0]->capacity += 0;'
	 *       after const_casting.
	 */
	static BlobHeader hdrEmpty[];

public:
	static const uint tail_reserve = 4; ///< four extra bytes will be always allocated and zeroed at the end
	static const uint header_size = sizeof(BlobHeader);

	/** default constructor - initializes empty blob */
	FORCEINLINE ByteBlob() { InitEmpty(); }

	/** move constructor - take ownership of blob data */
	FORCEINLINE ByteBlob(BlobHeader * const & src)
	{
		assert(src != NULL);
		header = src;
		*const_cast<BlobHeader**>(&src) = NULL;
	}

	/** destructor */
	FORCEINLINE ~ByteBlob()
	{
		Free();
	}

protected:
	/** initialize the empty blob by setting the header pointer to the static BlobHeader with
	 *  both items and capacity containing zero */
	FORCEINLINE void InitEmpty()
	{
		header = const_cast<BlobHeader *>(&ByteBlob::hdrEmpty[1]);
	}

	/** initialize blob by attaching it to the given header followed by data */
	FORCEINLINE void Init(BlobHeader *src)
	{
		header = &src[1];
	}

	/** blob header accessor - use it rather than using the pointer arithmetics directly - non-const version */
	FORCEINLINE BlobHeader& Hdr()
	{
		return *(header - 1);
	}

	/** blob header accessor - use it rather than using the pointer arithmetics directly - const version */
	FORCEINLINE const BlobHeader& Hdr() const
	{
		return *(header - 1);
	}

	/** return reference to the actual blob size - used when the size needs to be modified */
	FORCEINLINE uint& RawSizeRef()
	{
		return Hdr().items;
	};

public:
	/** return true if blob doesn't contain valid data */
	FORCEINLINE bool IsEmpty() const
	{
		return RawSize() == 0;
	}

	/** return the number of valid data bytes in the blob */
	FORCEINLINE uint RawSize() const
	{
		return Hdr().items;
	};

	/** return the current blob capacity in bytes */
	FORCEINLINE uint MaxRawSize() const
	{
		return Hdr().capacity;
	};

	/** return pointer to the first byte of data - non-const version */
	FORCEINLINE byte *RawData()
	{
		return data;
	}

	/** return pointer to the first byte of data - const version */
	FORCEINLINE const byte *RawData() const
	{
		return data;
	}

	/** invalidate blob's data - doesn't free buffer */
	FORCEINLINE void Clear()
	{
		RawSizeRef() = 0;
	}

	/** free the blob's memory */
	FORCEINLINE void Free()
	{
		if (MaxRawSize() > 0) {
			RawFree(&Hdr());
			InitEmpty();
		}
	}

	/** append new bytes at the end of existing data bytes - reallocates if necessary */
	FORCEINLINE void AppendRaw(const void *p, uint num_bytes)
	{
		assert(p != NULL);
		if (num_bytes > 0) {
			memcpy(GrowRawSize(num_bytes), p, num_bytes);
		}
	}

	/** append bytes from given source blob to the end of existing data bytes - reallocates if necessary */
	FORCEINLINE void AppendRaw(const ByteBlob& src)
	{
		if (!src.IsEmpty())
			memcpy(GrowRawSize(src.RawSize()), src.RawData(), src.RawSize());
	}

	/** Reallocate if there is no free space for num_bytes bytes.
	 *  @return pointer to the new data to be added */
	FORCEINLINE byte *MakeRawFreeSpace(uint num_bytes)
	{
		uint new_size = RawSize() + num_bytes;
		if (new_size > MaxRawSize()) SmartAlloc(new_size);
		return data + RawSize();
	}

	/** Increase RawSize() by num_bytes.
	 *  @return pointer to the new data added */
	FORCEINLINE byte *GrowRawSize(uint num_bytes)
	{
		byte *pNewData = MakeRawFreeSpace(num_bytes);
		RawSizeRef() += num_bytes;
		return pNewData;
	}

	/** reallocate blob data if needed */
	void SmartAlloc(uint new_size)
	{
		uint old_max_size = MaxRawSize();
		if (old_max_size >= new_size) return;
		/* calculate minimum block size we need to allocate */
		uint min_alloc_size = header_size + new_size + tail_reserve;
		/* ask allocation policy for some reasonable block size */
		uint alloc_size = AllocPolicy(min_alloc_size);
		/* allocate new block */
		BlobHeader *tmp = RawAlloc(alloc_size);
		/* setup header */
		tmp->items = RawSize();
		tmp->capacity = alloc_size - (header_size + tail_reserve);
		/* copy existing data */
		if (RawSize() > 0)
			memcpy(tmp + 1, data, tmp->items);
		/* replace our block with new one */
		BlobHeader *pOldHdr = &Hdr();
		Init(tmp);
		if (old_max_size > 0)
			RawFree(pOldHdr);
	}

	/** simple allocation policy - can be optimized later */
	FORCEINLINE static uint AllocPolicy(uint min_alloc)
	{
		if (min_alloc < (1 << 9)) {
			if (min_alloc < (1 << 5)) return (1 << 5);
			return (min_alloc < (1 << 7)) ? (1 << 7) : (1 << 9);
		}
		if (min_alloc < (1 << 15)) {
			if (min_alloc < (1 << 11)) return (1 << 11);
			return (min_alloc < (1 << 13)) ? (1 << 13) : (1 << 15);
		}
		if (min_alloc < (1 << 20)) {
			if (min_alloc < (1 << 17)) return (1 << 17);
			return (min_alloc < (1 << 19)) ? (1 << 19) : (1 << 20);
		}
		min_alloc = (min_alloc | ((1 << 20) - 1)) + 1;
		return min_alloc;
	}

	/** all allocation should happen here */
	static FORCEINLINE BlobHeader *RawAlloc(uint num_bytes)
	{
		return (BlobHeader*)MallocT<byte>(num_bytes);
	}

	/** all deallocations should happen here */
	static FORCEINLINE void RawFree(BlobHeader *p)
	{
		/* Just to silence an unsilencable GCC 4.4+ warning. */
		assert(p != ByteBlob::hdrEmpty);

		/* In case GCC warns about the following, see GCC's PR38509 why it is bogus. */
		free(p);
	}
	/** fixing the four bytes at the end of blob data - useful when blob is used to hold string */
	FORCEINLINE void FixTail() const
	{
		if (MaxRawSize() > 0) {
			byte *p = &data[RawSize()];
			for (uint i = 0; i < tail_reserve; i++) {
				p[i] = 0;
			}
		}
	}
};

/** Blob - simple dynamic T array. T (template argument) is a placeholder for any type.
 *  T can be any integral type, pointer, or structure. Using Blob instead of just plain C array
 *  simplifies the resource management in several ways:
 *  1. When adding new item(s) it automatically grows capacity if needed.
 *  2. When variable of type Blob comes out of scope it automatically frees the data buffer.
 *  3. Takes care about the actual data size (number of used items).
 *  4. Dynamically constructs only used items (as opposite of static array which constructs all items) */
template <typename T>
class CBlobT : public ByteBlob {
	/* make template arguments public: */
public:
	typedef ByteBlob base;

	static const uint type_size = sizeof(T);

	struct OnTransfer {
		typename base::BlobHeader *header;
		OnTransfer(const OnTransfer& src) : header(src.header) {assert(src.header != NULL); *const_cast<typename base::BlobHeader**>(&src.header) = NULL;}
		OnTransfer(CBlobT& src) : header(src.header) {src.InitEmpty();}
		~OnTransfer() {assert(header == NULL);}
	};

	/** Default constructor - makes new Blob ready to accept any data */
	FORCEINLINE CBlobT()
		: base()
	{}

	/** Take ownership constructor */
	FORCEINLINE CBlobT(const OnTransfer& ot)
		: base(ot.header)
	{}

	/** Destructor - ensures that allocated memory (if any) is freed */
	FORCEINLINE ~CBlobT()
	{
		Free();
	}

	/** Check the validity of item index (only in debug mode) */
	FORCEINLINE void CheckIdx(uint index) const
	{
		assert(index < Size());
	}

	/** Return pointer to the first data item - non-const version */
	FORCEINLINE T *Data()
	{
		return (T*)base::RawData();
	}

	/** Return pointer to the first data item - const version */
	FORCEINLINE const T *Data() const
	{
		return (const T*)base::RawData();
	}

	/** Return pointer to the index-th data item - non-const version */
	FORCEINLINE T *Data(uint index)
	{
		CheckIdx(index);
		return (Data() + index);
	}

	/** Return pointer to the index-th data item - const version */
	FORCEINLINE const T *Data(uint index) const
	{
		CheckIdx(index);
		return (Data() + index);
	}

	/** Return number of items in the Blob */
	FORCEINLINE uint Size() const
	{
		return (base::RawSize() / type_size);
	}

	/** Return total number of items that can fit in the Blob without buffer reallocation */
	FORCEINLINE uint MaxSize() const
	{
		return (base::MaxRawSize() / type_size);
	}
	/** Return number of additional items that can fit in the Blob without buffer reallocation */
	FORCEINLINE uint GetReserve() const
	{
		return ((base::MaxRawSize() - base::RawSize()) / type_size);
	}

	/** Grow number of data items in Blob by given number - doesn't construct items */
	FORCEINLINE T *GrowSizeNC(uint num_items)
	{
		return (T*)base::GrowRawSize(num_items * type_size);
	}

	/** Add given items (ptr + number of items) at the end of blob */
	FORCEINLINE T *Append(const T *pSrc, uint num_items)
	{
		T *pDst = GrowSizeNC(num_items);
		T *pDstOrg = pDst;
		T *pDstEnd = pDst + num_items;
		while (pDst < pDstEnd) new (pDst++) T(*(pSrc++));
		return pDstOrg;
	}

	/** Ensures that given number of items can be added to the end of Blob. Returns pointer to the
	 *  first free (unused) item */
	FORCEINLINE T *MakeFreeSpace(uint num_items)
	{
		return (T*)base::MakeRawFreeSpace(num_items * type_size);
	}

	FORCEINLINE OnTransfer Transfer()
	{
		return OnTransfer(*this);
	};
};


#endif /* BLOB_HPP */