// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// e32test\heap\t_heap2.cpp

// Overview:

// Tests RHeap class, including a stress test and a "grow in place"

// ReAlloc test.

// API Information:

// RHeap

// Details:

// - Test allocation on fixed length heaps in local, disconnected chunks for

// different heap sizes and alignments.  Assumes knowledge of heap

// implementation.

// - Test allocation, free, reallocation and compression on chunk heaps with

// different maximum and minimum lengths and alignments.  Assumes knowledge

// of heap implementation.      

// - Stress test heap implementation with a single thread that allocates, frees

// and reallocates cells, and checks the heap.

// - Stress test heap implementation with two threads that run concurrently.

// - Create a chunk heap, test growing in place by allocating a cell and 

// then reallocating additional space until failure, verify that the cell 

// did not move and the size was increased.

// - The heap is checked to verify that no cells remain allocated after the 

// tests are complete.

// Platforms/Drives/Compatibility:

// All

// Assumptions/Requirement/Pre-requisites:

// Failures and causes:

// Base Port information:

// 

//

#include <e32test.h>

#include <e32hal.h>

#include <e32def.h>

#include <e32def_private.h>

// Needed for KHeapShrinkHysRatio which is now ROM 'patchdata'

#include "TestRHeapShrink.h"

#define DECL_GET(T,x)		inline T x() const {return i##x;}

#define DECL_GET2(T,x,y)	inline T y() const {return i##x;}

#ifdef __EABI__

       IMPORT_D extern const TInt KHeapMinCellSize;

#else

       const TInt KHeapMinCellSize = 0;

#endif

RTest test(_L("T_HEAP2"));

#define	TEST_ALIGN(p,a)		test((TLinAddr(p)&((a)-1))==0)

struct STestCell

	{

	enum {EMagic = 0xb8aa3b29};

	TUint32 iLength;

	TUint32 iData[1];

	void Set(TInt aLength);

	void Verify(TInt aLength);

	void Verify(const TAny* aInitPtr, TInt aInitLength, TInt aLength);

	};

void STestCell::Set(TInt aLength)

	{

	TInt i;

	TUint32 x = (TUint32)this ^ (TUint32)aLength ^ (TUint32)EMagic;

	aLength -= RHeap::EAllocCellSize;

	if (aLength==0)

		return;

	iLength = x;

	aLength /= sizeof(TUint32);

	for (i=0; i<aLength-1; ++i)

		{

		x *= 69069;

		x += 41;

		iData[i] = x;

		}

	}

void STestCell::Verify(TInt aLength)

	{

	Verify(this, aLength, aLength);

	}

void STestCell::Verify(const TAny* aInitPtr, TInt aInitLength, TInt aLength)

	{

	TInt i;

	TUint32 x = (TUint32)aInitPtr ^ (TUint32)aInitLength ^ (TUint32)EMagic;

	aLength -= RHeap::EAllocCellSize;

	if (aLength==0)

		return;

	test(iLength == x);

	aLength /= sizeof(TUint32);

	for (i=0; i<aLength-1; ++i)

		{

		x *= 69069;

		x += 41;

		test(iData[i] == x);

		}

	}

class RTestHeap : public RHeap

	{

public:

	DECL_GET(TInt,AccessCount)

	DECL_GET(TInt,HandleCount)

	DECL_GET(TInt*,Handles)

	DECL_GET(TUint32,Flags)

	DECL_GET(TInt,CellCount)

	DECL_GET(TInt,TotalAllocSize)

	DECL_GET(TInt,MinLength)

	DECL_GET(TInt,Offset)

	DECL_GET(TInt,GrowBy)

	DECL_GET(TInt,ChunkHandle)

	DECL_GET2(const RFastLock&,Lock,LockRef)

	DECL_GET(TUint8*,Top)

	DECL_GET(TInt,Align)

	DECL_GET(TInt,MinCell)

	DECL_GET(TInt,PageSize)

	DECL_GET2(const SCell&,Free,FreeRef)

public:

	TInt CheckAllocatedCell(const TAny* aCell) const;

	void FullCheckAllocatedCell(const TAny* aCell) const;

	TAny* TestAlloc(TInt aSize);

	void TestFree(TAny* aPtr);

	TAny* TestReAlloc(TAny* aPtr, TInt aSize, TInt aMode=0);

	void FullCheck();

	static void WalkFullCheckCell(TAny* aPtr, TCellType aType, TAny* aCell, TInt aLen);

	TInt FreeCellLen(const TAny* aPtr) const;

	static RTestHeap* FixedHeap(TInt aMaxLength, TInt aAlign=0, TBool aSingleThread=ETrue);

	void TakeChunkOwnership(RChunk aChunk);

	TInt LastFreeCellLen(void) const;

	TInt CalcComp(TInt aCompSize);

	void ForceCompress(TInt aFreed);

	};

TInt RTestHeap::CheckAllocatedCell(const TAny* aCell) const

	{

	SCell* pC = GetAddress(aCell);

	TInt len = pC->len;

	TUint8* pEnd = (TUint8*)pC + len;

	TEST_ALIGN(aCell, iAlign);

	TEST_ALIGN(len, iAlign);

	test(len >= iMinCell);

	test((TUint8*)pC>=iBase && pEnd<=iTop);

	return len;

	}

void RTestHeap::FullCheckAllocatedCell(const TAny* aCell) const

	{

	((STestCell*)aCell)->Verify(CheckAllocatedCell(aCell));

	}

TAny* RTestHeap::TestAlloc(TInt aSize)

	{

	TAny* p = Alloc(aSize);

	if (p)

		{

		TInt len = CheckAllocatedCell(p);

		test((len-RHeap::EAllocCellSize)>=aSize);

		((STestCell*)p)->Set(len);

		}

	return p;

	}

void RTestHeap::TestFree(TAny* aPtr)

	{

	if (aPtr)

		FullCheckAllocatedCell(aPtr);

	Free(aPtr);

	}

TAny* RTestHeap::TestReAlloc(TAny* aPtr, TInt aSize, TInt aMode)

	{

	TInt old_len = aPtr ? CheckAllocatedCell(aPtr) : 0;

	if (aPtr)

		((STestCell*)aPtr)->Verify(old_len);

	TAny* p = ReAlloc(aPtr, aSize, aMode);

	if (!p)

		{

		((STestCell*)aPtr)->Verify(old_len);

		return p;

		}

	TInt new_len = CheckAllocatedCell(p);

	test((new_len-RHeap::EAllocCellSize)>=aSize);

	if (p == aPtr)

		{

		((STestCell*)p)->Verify(p, old_len, Min(old_len, new_len));

		if (new_len != old_len)

			((STestCell*)p)->Set(new_len);

		return p;

		}

	test(!(aMode & ENeverMove));

	test((new_len > old_len) || (aMode & EAllowMoveOnShrink));

	if (old_len)

		((STestCell*)p)->Verify(aPtr, old_len, Min(old_len, new_len));

	if (new_len != old_len)

		((STestCell*)p)->Set(new_len);

	return p;

	}

struct SHeapCellInfo

	{

	RTestHeap* iHeap;

	TInt iTotalAlloc;

	TInt iTotalAllocSize;

	TInt iTotalFree;

	TUint8* iNextCell;

	};

void RTestHeap::WalkFullCheckCell(TAny* aPtr, TCellType aType, TAny* aCell, TInt aLen)

	{

	(void)aCell;

	::SHeapCellInfo& info = *(::SHeapCellInfo*)aPtr;

	switch(aType)

		{

		case EGoodAllocatedCell:

			{

			test(aCell == info.iNextCell);

			TInt len = ((SCell*)aCell)->len;

			test(len == aLen);

			info.iNextCell += len;

			++info.iTotalAlloc;

			info.iTotalAllocSize += (aLen-EAllocCellSize);

			STestCell* pT = (STestCell*)((TUint8*)aCell + EAllocCellSize);

			pT->Verify(len);

			break;

			}

		case EGoodFreeCell:

			{

			test(aCell == info.iNextCell);

			TInt len = ((SCell*)aCell)->len;

			test(len == aLen);

			info.iNextCell += len;

			++info.iTotalFree;

			break;

			}

		default:

			test.Printf(_L("TYPE=%d ??\n"),aType);

			test(0);

			break;

		}

	}

void RTestHeap::FullCheck()

	{

	::SHeapCellInfo info;

	Mem::FillZ(&info, sizeof(info));

	info.iHeap = this;

	info.iNextCell = iBase;

	DebugFunction(EWalk, (TAny*)&WalkFullCheckCell, &info);

	test(info.iNextCell == iTop);

	test(info.iTotalAlloc == iCellCount);

	test(info.iTotalAllocSize == iTotalAllocSize);

	}

TInt RTestHeap::FreeCellLen(const TAny* aPtr) const

	{

	SCell* p = iFree.next;

	SCell* q = (SCell*)((TUint8*)aPtr - EAllocCellSize);

	for (; p && p!=q; p = p->next) {}

	if (p == q)

		return p->len - EAllocCellSize;

	return -1;

	}

TInt RTestHeap::LastFreeCellLen(void) const

	{

	SCell* p = iFree.next;

	if (p==NULL)

		return -1;	

	for (; p->next; p=p->next){}

	return p->len;

	}

/** Checks whether a call to Compress() will actually perform a reduction 

	of the heap.

	Relies on the free last cell on the heap being cell that has just been freed

	plus any extra.

	Intended for use by t_heap2.cpp - DoTest4().  

	@param aFreedSize The size in bytes of the cell that was freed

*/

TInt RTestHeap::CalcComp(TInt aFreedSize)

	{	

	TInt largestCell=0;

	largestCell = LastFreeCellLen();

	// if the largest cell is too small or it would have been compressed by the

	// free operation then return 0.

	if (largestCell < iPageSize || aFreedSize >= KHeapShrinkHysRatio*(iGrowBy>>8))

		{

		return 0;			

		}

		else

		{

		return _ALIGN_DOWN(aFreedSize,iPageSize);

		}	

	}

/** compress the heap if the KHeapShrinkRatio is too large for what we are

	expecting in DoTest4().

*/

void RTestHeap::ForceCompress(TInt aFreed)

	{	

	if (aFreed < KHeapShrinkHysRatio*(iGrowBy>>8))

		{

		Compress();

		}

	}

RTestHeap* RTestHeap::FixedHeap(TInt aMaxLength, TInt aAlign, TBool aSingleThread)

	{

	RChunk c;

	TInt bottom = 0x40000;

	TInt top = bottom + aMaxLength;

	TInt r = c.CreateDisconnectedLocal(bottom, top, top + bottom, EOwnerThread);

	if (r!=KErrNone)

		return NULL;

	TUint8* base = c.Base() + bottom;

	RTestHeap* h = (RTestHeap*)UserHeap::FixedHeap(base, aMaxLength, aAlign, aSingleThread);

	if (!aAlign)

		aAlign = RHeap::ECellAlignment;

	test((TUint8*)h == base);

	test(h->AccessCount() == 1);

	test(h->HandleCount() == (aSingleThread ? 0 : 1));

	test(h->Handles() == (aSingleThread ? NULL : (TInt*)&h->LockRef()));

	test(h->Flags() == TUint32(RAllocator::EFixedSize | (aSingleThread ? RAllocator::ESingleThreaded : 0)));

	test(h->CellCount() == 0);

	test(h->TotalAllocSize() == 0);

	test(h->MaxLength() == aMaxLength);

	test(h->MinLength() == h->Top() - (TUint8*)h);

	test(h->Offset() == 0);

	test(h->GrowBy() == 0);

	test(h->ChunkHandle() == 0);

	test(h->Align() == aAlign);

	TInt min_cell = _ALIGN_UP((KHeapMinCellSize + Max((TInt)RHeap::EAllocCellSize, (TInt)RHeap::EFreeCellSize)), aAlign);

	TInt hdr_len = _ALIGN_UP(sizeof(RHeap) + RHeap::EAllocCellSize, aAlign) - RHeap::EAllocCellSize;

	TInt user_len = _ALIGN_DOWN(aMaxLength - hdr_len, aAlign);

	test(h->Base() == base + hdr_len);

	test(h->MinCell() == min_cell);

	test(h->Top() - h->Base() == user_len);

	test(h->FreeRef().next == (RHeap::SCell*)h->Base());

	h->TakeChunkOwnership(c);

	return h;

	}

void RTestHeap::TakeChunkOwnership(RChunk aChunk)

	{

	iChunkHandle = aChunk.Handle();

	++iHandleCount;

	iHandles = &iChunkHandle;

	}

#define	ACCESS_COUNT(h)		(((RTestHeap*)h)->AccessCount())

#define	HANDLE_COUNT(h)		(((RTestHeap*)h)->HandleCount())

#define	HANDLES(h)			(((RTestHeap*)h)->Handles())

#define	FLAGS(h)			(((RTestHeap*)h)->Flags())

#define	CELL_COUNT(h)		(((RTestHeap*)h)->CellCount())

#define	TOTAL_ALLOC_SIZE(h)	(((RTestHeap*)h)->TotalAllocSize())

#define	MIN_LENGTH(h)		(((RTestHeap*)h)->MinLength())

#define	OFFSET(h)			(((RTestHeap*)h)->Offset())

#define	GROW_BY(h)			(((RTestHeap*)h)->GrowBy())

#define	CHUNK_HANDLE(h)		(((RTestHeap*)h)->ChunkHandle())

#define	LOCK_REF(h)			(((RTestHeap*)h)->LockRef())

#define	TOP(h)				(((RTestHeap*)h)->Top())

#define	ALIGN(h)			(((RTestHeap*)h)->Align())

#define	MIN_CELL(h)			(((RTestHeap*)h)->MinCell())

#define	PAGE_SIZE(h)		(((RTestHeap*)h)->PageSize())

#define	FREE_REF(h)			(((RTestHeap*)h)->FreeRef())

void DoTest1(RHeap* aH)

	{

	RTestHeap* h = (RTestHeap*)aH;

	test.Printf(_L("Test Alloc: min=%x max=%x align=%d growby=%d\n"),

						h->MinLength(), h->MaxLength(), h->Align(), h->GrowBy());

	TInt l;

	TAny* p = NULL;

	TUint8* next = h->Base();

	TUint8* top = h->Top();

	TUint8* limit = (TUint8*)h + h->MaxLength();

	TBool fixed = h->Flags() & RAllocator::EFixedSize;

	for (l=1; l<=1024; ++l)

		{

		TInt remain1 = top - next;

		TInt xl1 = _ALIGN_UP(Max((l+RHeap::EAllocCellSize), h->MinCell()), h->Align());

		p = h->TestAlloc(l);

		if ( (fixed && remain1 < xl1) || (next + xl1 > limit) )

			{

			test(p == NULL);

			test(top == h->Top());

			test.Printf(_L("Alloc failed at l=%d next=%08x\n"), l, next);

			break;

			}

		test(p == next + RHeap::EAllocCellSize);

		if (xl1 > remain1)

			{

			// no room for this cell

			TInt g = h->GrowBy();

			while (xl1 > remain1)

				{

				top += g;

				remain1 += g;

				}

			}

		test(top == h->Top());

		if (xl1 + h->MinCell() > remain1)

			{

			// this cell fits but remainder is too small or nonexistent

			xl1 = top - next;

			next = top;

			test(h->FreeRef().next == NULL);

			}

		else

			{

			// this cell fits and remainder can be reused

			next += xl1;

			}

		test(aH->AllocLen(p) == xl1 - RHeap::EAllocCellSize);

		}

	h->FullCheck();

	}

void DoTest2(RHeap* aH)

	{

	RTestHeap* h = (RTestHeap*)aH;

	test.Printf(_L("Test Free: min=%x max=%x align=%d growby=%d\n"),

						h->MinLength(), h->MaxLength(), h->Align(), h->GrowBy());

	TInt al;

	TInt min = h->MinCell();

	TBool pad = EFalse;

	for (al=1; al<256; (void)((pad=!pad)!=0 || (al+=al+1)) )

		{

		TAny* p[32];

		TInt last_len = 0;

		TAny* last = NULL;

		TInt i;

		test.Printf(_L("al=%d pad=%d\n"), al, pad);

		TUint8* top=0;

		TAny* spare=0;

		TBool heapReduced = EFalse;

		for (i=0; i<32; ++i)

			{

			// Check whether the cell created for the allocation of al would end up

			// including extra bytes from the last free cell that aren't enough

			// to create a new free cell.

			top = h->Top();

			TInt freeLen=h->LastFreeCellLen();

			TInt actualAllocBytes = Max(_ALIGN_UP(al + RHeap::EAllocCellSize, h->Align()), min);

			TInt remainingBytes = freeLen - actualAllocBytes;

			if (remainingBytes < min)

				{

				// Force the heap to grow so that once this allocation is freed

				// the free cell left will be large enough to include the al allocation

				// and to create a new free cell if necessary.

				actualAllocBytes = _ALIGN_UP(actualAllocBytes + min, h->Align());

				TAny* q = h->TestAlloc(actualAllocBytes);

				// Check heap has grown

				test(top < h->Top());

				top = h->Top();

				test(q!=NULL);

				// Have grown the heap so allocate a cell as a place holder to stop

				// the heap being shrunk and the actual cell we want to allocate from being the

				// wrong size

				spare=h->TestAlloc(8);

				h->TestFree(q);

				// Ensure heap wasn't shrunk after free

				test(top == h->Top());

				}

			top = h->Top();

			// Allocate the new 

			p[i] = h->TestAlloc(al);

			test(p[i]!=NULL);

			if (remainingBytes < min)

				{// now safe to free any padding as p[i] now allocated and its size can't change

				h->TestFree(spare);

				}

			TInt tmp1=h->AllocLen(p[i]);

			TInt tmp2=Max(_ALIGN_UP(al+RHeap::EAllocCellSize,h->Align()), min)-RHeap::EAllocCellSize;

			test(tmp1 == tmp2);

			}

		last = (TUint8*)p[31] + _ALIGN_UP(Max((al + RHeap::EAllocCellSize), min), h->Align());

		last_len = h->FreeCellLen(last);

		test(last_len > 0);

		if (pad)

			{

			test(h->TestAlloc(last_len) == last);

			test(h->FreeRef().next == NULL);

			}

		else

			last = NULL;

		top = h->Top();

		for (i=0,heapReduced=EFalse; i<32; ++i)

			{

			h->TestFree(p[i]);

			TInt fl = h->FreeCellLen(p[i]);

			TInt xfl = _ALIGN_UP(Max((al + RHeap::EAllocCellSize), h->MinCell()), h->Align()) - RHeap::EAllocCellSize;

			if (h->Top() < top) // heap was reduced due to small KHeapShrinkHysRatio and big KHeapMinCellSize

				{

				top = h->Top();

				heapReduced = ETrue;

				}

			if (i < 31 || pad)

				test(fl == xfl);

			else

				{

				if (!heapReduced)

					test(fl == xfl + RHeap::EAllocCellSize + last_len);

				else

					{

					heapReduced = EFalse;

					}

				}

			test(h->TestAlloc(al)==p[i]);