sl@0: // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // e32test\defrag\d_pagemove.cpp
sl@0: // LDD for testing defrag page moving
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include <kernel/kern_priv.h>
sl@0: #include "platform.h"
sl@0: #include "d_pagemove.h"
sl@0: #include "nk_priv.h"
sl@0: 
sl@0: // debug tracing for this test driver is very noisy - off by default
sl@0: #undef DEBUG_PAGEMOVE
sl@0: #ifdef DEBUG_PAGEMOVE
sl@0: #define DBG(a) a
sl@0: #else
sl@0: #define DBG(a)
sl@0: #endif
sl@0: 
sl@0: const TInt KArbitraryNumber = 4;
sl@0: 
sl@0: // This driver is ram loaded (see mmp file) so this function will do fine
sl@0: // as a test of RAM-loaded code.
sl@0: TInt RamLoadedFunction()
sl@0: 	{
sl@0: 	return KArbitraryNumber;
sl@0: 	}
sl@0: 
sl@0: const TInt KMajorVersionNumber=0;
sl@0: const TInt KMinorVersionNumber=1;
sl@0: const TInt KBuildVersionNumber=1;
sl@0: 
sl@0: class DPageMove;
sl@0: 
sl@0: class DPageMoveFactory : public DLogicalDevice
sl@0: //
sl@0: // Page move LDD factory
sl@0: //
sl@0: 	{
sl@0: public:
sl@0: 	DPageMoveFactory();
sl@0: 	virtual TInt Install();						//overriding pure virtual
sl@0: 	virtual void GetCaps(TDes8& aDes) const;	//overriding pure virtual
sl@0: 	virtual TInt Create(DLogicalChannelBase*& aChannel);	//overriding pure virtual
sl@0: 	};
sl@0: 
sl@0: class DPageMove : public DLogicalChannelBase
sl@0: //
sl@0: // Page move logical channel
sl@0: //
sl@0: 	{
sl@0: public:
sl@0: 	DPageMove();
sl@0: 	~DPageMove();
sl@0: protected:
sl@0: 	virtual TInt DoCreate(TInt aUnit, const TDesC8* anInfo, const TVersion& aVer);
sl@0: 	virtual TInt Request(TInt aFunction, TAny* a1, TAny* a2);
sl@0: 	TInt DoPageMove(TLinAddr aAddr, TBool aEchoOff=EFalse);
sl@0: 	TInt KernelDataMovePerformance(void);
sl@0: 	TInt iPageSize;
sl@0: 	};
sl@0: 
sl@0: DECLARE_STANDARD_LDD()
sl@0: 	{
sl@0:     return new DPageMoveFactory;
sl@0:     }
sl@0: 
sl@0: DPageMoveFactory::DPageMoveFactory()
sl@0: //
sl@0: // Constructor
sl@0: //
sl@0:     {
sl@0:     iVersion=TVersion(KMajorVersionNumber,KMinorVersionNumber,KBuildVersionNumber);
sl@0:     //iParseMask=0;//No units, no info, no PDD
sl@0:     //iUnitsMask=0;//Only one thing
sl@0:     }
sl@0: 
sl@0: TInt DPageMoveFactory::Create(DLogicalChannelBase*& aChannel)
sl@0: //
sl@0: // Create a new DPageMove on this logical device
sl@0: //
sl@0:     {
sl@0: 	aChannel=new DPageMove;
sl@0: 	return aChannel?KErrNone:KErrNoMemory;
sl@0:     }
sl@0: 
sl@0: TInt DPageMoveFactory::Install()
sl@0: //
sl@0: // Install the LDD - overriding pure virtual
sl@0: //
sl@0:     {
sl@0:     return SetName(&KPageMoveLddName);
sl@0:     }
sl@0: 
sl@0: void DPageMoveFactory::GetCaps(TDes8& aDes) const
sl@0: //
sl@0: // Get capabilities - overriding pure virtual
sl@0: //
sl@0:     {
sl@0:     TCapsPageMoveV01 b;
sl@0:     b.iVersion=TVersion(KMajorVersionNumber,KMinorVersionNumber,KBuildVersionNumber);
sl@0:     Kern::InfoCopy(aDes,(TUint8*)&b,sizeof(b));
sl@0:     }
sl@0: 
sl@0: DPageMove::DPageMove()
sl@0: //
sl@0: // Constructor
sl@0: //
sl@0:     {
sl@0:     }
sl@0: 
sl@0: TInt DPageMove::DoCreate(TInt /*aUnit*/, const TDesC8* /*anInfo*/, const TVersion& aVer)
sl@0: //
sl@0: // Create channel
sl@0: //
sl@0:     {
sl@0:     if (!Kern::QueryVersionSupported(TVersion(KMajorVersionNumber,KMinorVersionNumber,KBuildVersionNumber),aVer))
sl@0:     	return KErrNotSupported;
sl@0: 	iPageSize=Kern::RoundToPageSize(1);
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: DPageMove::~DPageMove()
sl@0: //
sl@0: // Destructor
sl@0: //
sl@0:     {
sl@0:     }
sl@0: 
sl@0: TInt DPageMove::Request(TInt aFunction, TAny* a1, TAny* a2)
sl@0: 	{
sl@0: 	TInt r=KErrNone;
sl@0: 	DBG(Kern::Printf("DPageMove::Request func=%d a1=%08x a2=%08x", aFunction, a1, a2));
sl@0: 	NKern::ThreadEnterCS();
sl@0: 	switch (aFunction)
sl@0: 		{
sl@0: 		case RPageMove::EControlTryMovingKHeap:
sl@0: 			// Allocate a large array on the kernel heap and try moving it around.
sl@0: 			{
sl@0: 			const TInt size=16384;
sl@0: 			TUint8* array = new TUint8[size];
sl@0: 			if (array == NULL)
sl@0: 				r=KErrNoMemory;
sl@0: 			else
sl@0: 				{
sl@0: 				for (TInt i=0; i<size; i++) array[i] = i*i;
sl@0: 
sl@0: 				TUint8* firstpage=(TUint8*)_ALIGN_DOWN((TLinAddr)array, iPageSize);
sl@0: 				for (TUint8* page=firstpage; page<array+size; page+=iPageSize)
sl@0: 					{
sl@0: 					r=DoPageMove((TLinAddr)page);
sl@0: 					if (r!=KErrNone)
sl@0: 						{
sl@0: 						Kern::Printf("Move returned %d", r);
sl@0: 						break;
sl@0: 						}
sl@0: 					}
sl@0: 
sl@0: 				if (r==KErrNone)
sl@0: 					{
sl@0: 					for (TInt i=0; i<size; i++)
sl@0: 						{
sl@0: 						if (array[i] != (TUint8)(i*i))
sl@0: 							{
sl@0: 							r=KErrGeneral;
sl@0: 							Kern::Printf("Data differs at index %d address %08x, expected %02x got %02x", i, &array[i], (TUint8)(i*i), array[i]);
sl@0: 							}
sl@0: 						}
sl@0: 					}
sl@0: 
sl@0: 				Kern::ValidateHeap();
sl@0: 
sl@0: 				delete [] array;
sl@0: 				}
sl@0: 			}
sl@0: 			break;
sl@0: 
sl@0: 		case RPageMove::EControlTryMovingKStack:
sl@0: 			// Stick a not-too-large array on the current thread's kernel stack and try moving it around.
sl@0: 			{
sl@0: 			const TInt size=1024;
sl@0: 			TUint8 array[size];
sl@0: 			for (TInt i=0; i<size; i++) array[i] = i*i;
sl@0: 
sl@0: 			TUint8* firstpage=(TUint8*)_ALIGN_DOWN((TLinAddr)array, iPageSize);
sl@0: 			for (TUint8* page=firstpage; page<array+size; page+=iPageSize)
sl@0: 				{
sl@0: 				r=DoPageMove((TLinAddr)page);
sl@0: 				if (r!=KErrNone)
sl@0: 					{
sl@0: 					Kern::Printf("Move returned %d", r);
sl@0: 					break;
sl@0: 					}
sl@0: 				}
sl@0: 
sl@0: 			if (r==KErrNone)
sl@0: 				{
sl@0: 				for (TInt i=0; i<size; i++)
sl@0: 					{
sl@0: 					if (array[i] != (TUint8)(i*i))
sl@0: 						{
sl@0: 						r=KErrGeneral;
sl@0: 						Kern::Printf("Data differs at index %d address %08x, expected %02x got %02x", i, &array[i], (TUint8)(i*i), array[i]);
sl@0: 						}
sl@0: 					}
sl@0: 				}
sl@0: 			}
sl@0: 			break;
sl@0: 
sl@0: 		case RPageMove::EControlTryMovingUserPage:
sl@0: 		case RPageMove::EControlTryMovingLocale:
sl@0: 			// Try moving the page that the user part of the test told us to.
sl@0: 			r=DoPageMove((TLinAddr)a1, (TBool)a2);
sl@0: 			if (r!=KErrNone && !a2)
sl@0: 				Kern::Printf("Move returned %d", r);
sl@0: 			break;
sl@0: 
sl@0: 		case RPageMove::EControlTryMovingKCode:
sl@0: 			{
sl@0: 			r=DoPageMove((TLinAddr)&RamLoadedFunction);
sl@0: 			if (r==KErrNone)
sl@0: 				{
sl@0: 				if (RamLoadedFunction()!=KArbitraryNumber)
sl@0: 					r=KErrGeneral;
sl@0: 				}	
sl@0: 			else
sl@0: 				Kern::Printf("Move returned %d", r);
sl@0: 			}
sl@0: 			break;
sl@0: 
sl@0: 		case RPageMove::EControlPerfMovingKData:
sl@0: 			r = KernelDataMovePerformance();
sl@0: 			break;
sl@0: 
sl@0: 		case RPageMove::EControlGetPhysAddr:
sl@0: 			TPhysAddr addr;
sl@0: 			addr = (TUint)Epoc::LinearToPhysical((TLinAddr)a1);
sl@0: 			Kern::ThreadRawWrite(&Kern::CurrentThread(),a2, &addr, sizeof(TPhysAddr));
sl@0: 			break;
sl@0: 
sl@0: 		case RPageMove::EControlTryMovingPhysAddr:
sl@0: 			{
sl@0: 			TPhysAddr newAddr;
sl@0: 			r = Epoc::MovePhysicalPage((TPhysAddr)a1, newAddr);
sl@0: 			Kern::ThreadRawWrite(&Kern::CurrentThread(),a2, &newAddr, sizeof(TPhysAddr));
sl@0: 			break;
sl@0: 			}
sl@0: 
sl@0: 		case RPageMove::EControlTryMovingPageTable:
sl@0: 			{
sl@0: 			TPhysAddr newAddr;
sl@0: 			r = Epoc::MovePhysicalPage((TPhysAddr) a1, newAddr, Epoc::ERamDefragPage_PageTable);
sl@0: 			if (newAddr != KPhysAddrInvalid)
sl@0: 				r = KErrGeneral;
sl@0: 			break;
sl@0: 			}
sl@0: 
sl@0: 		case RPageMove::EControlTryMovingPageTableInfo:
sl@0: 			{
sl@0: 			TPhysAddr newAddr;
sl@0: 			r = Epoc::MovePhysicalPage((TPhysAddr) a1, newAddr, Epoc::ERamDefragPage_PageTableInfo);
sl@0: 			if (newAddr != KPhysAddrInvalid)
sl@0: 				r = KErrGeneral;
sl@0: 			break;
sl@0: 			}
sl@0: 
sl@0: 		case RPageMove::EControlNumberOfCpus:
sl@0: 			r = NKern::NumberOfCpus();
sl@0: 			break;
sl@0: 		default:
sl@0: 			r=KErrNotSupported;
sl@0: 			break;
sl@0: 		}
sl@0: 	NKern::ThreadLeaveCS();
sl@0: 	if (r!=KErrNone)
sl@0: 		DBG(Kern::Printf("DPageMove::Request returns %d", r));
sl@0: 	return r;
sl@0: 	}
sl@0: 
sl@0: TInt DPageMove::DoPageMove(TLinAddr aAddr, TBool aEchoOff)
sl@0: 	{
sl@0: 	DBG(Kern::Printf("DPageMove::DoPageMove() addr=%08x",aAddr));
sl@0: 	aAddr = _ALIGN_DOWN(aAddr, iPageSize);
sl@0: 
sl@0: 	TPhysAddr aOld = Epoc::LinearToPhysical(aAddr);
sl@0: 	TInt r;
sl@0: 	if (aOld == KPhysAddrInvalid)
sl@0: 		r=KErrArgument;
sl@0: 	else
sl@0: 		{
sl@0: 		TPhysAddr aNew;
sl@0: 		r=Epoc::MovePhysicalPage(aOld, aNew);
sl@0: 		if (r==KErrNone)
sl@0: 			{
sl@0: 			TPhysAddr aNewCheck = Epoc::LinearToPhysical(aAddr);
sl@0: 			if (aNewCheck != aNew)
sl@0: 				{
sl@0: 				if (!aEchoOff)
sl@0: 					Kern::Printf("Address mismatch: expected %08x actual %08x\n",aNew,aNewCheck);
sl@0: 				if (aNew != KPhysAddrInvalid && aNewCheck != KPhysAddrInvalid)
sl@0: 					{// The page was not paged out by the moving so don't allow 
sl@0: 					// addresses to differ.  If is was paged out then it may have 
sl@0: 					// been paged back in again but to any free page so the addresses will differ.
sl@0: 					r=KErrGeneral;
sl@0: 					}
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 	if (r!=KErrNone)
sl@0: 		DBG(Kern::Printf("DPageMove::DoPageMove() returns %d", r));
sl@0: 	return r;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: #ifndef __MSVC6__ 	// VC6 can't cope with variable arguments in macros.
sl@0: #define KERN_PRINTF(x...) Kern::Printf(x)
sl@0: #endif
sl@0: 
sl@0: //#define EXTRA_TRACE
sl@0: #ifdef EXTRA_TRACE
sl@0: #define PRINTF(x)	x
sl@0: #else
sl@0: #define PRINTF(x)
sl@0: #endif
sl@0: 
sl@0: 
sl@0: TInt DPageMove::KernelDataMovePerformance(void)
sl@0: {
sl@0: 	const TInt KHeapPagesToMove = 2000;
sl@0: 	const TInt KMoveAttempts = 50;
sl@0: 	const TInt KStackSize=1024;
sl@0: 	enum TKMoveMode
sl@0: 		{
sl@0: 		EKMoveHeap,
sl@0: 		EKMoveStack,
sl@0: 		EKMoveModes,
sl@0: 		};
sl@0: 
sl@0: 	TInt r = KErrNone;
sl@0: 
sl@0: 	// Create some kernel stack pages
sl@0: 	TUint8 stackArray[KStackSize];
sl@0: 
sl@0: 	/// Create some kernel heap pages
sl@0: 	TUint actualHeapPages = KHeapPagesToMove;
sl@0: 	TInt heapArraySize = iPageSize * KHeapPagesToMove;
sl@0: 	TUint8* heapArray = new TUint8[heapArraySize];
sl@0: 	if (heapArray == NULL)
sl@0: 		return KErrNoMemory;
sl@0: 	
sl@0: 	TInt i = 0;
sl@0: 	for (; i < heapArraySize; i++)
sl@0: 		{
sl@0: 		heapArray[i] = i;
sl@0: 		}
sl@0: 
sl@0: 	PRINTF(KERN_PRINTF("Testing Performance of Moving Kernel Data Pages"));
sl@0: 
sl@0: 	TInt moveMode = EKMoveStack;
sl@0: 	for (; moveMode < EKMoveModes; moveMode++)
sl@0: 		{
sl@0: 		TLinAddr pageAddr = NULL;
sl@0: 		TLinAddr endAddr = NULL;
sl@0: 		TLinAddr baseAddr = NULL;
sl@0: 		switch (moveMode)
sl@0: 			{
sl@0: 			case EKMoveHeap:
sl@0: 				pageAddr = _ALIGN_DOWN((TLinAddr)heapArray, iPageSize);
sl@0: 				baseAddr = pageAddr;
sl@0: 				endAddr = _ALIGN_UP((TLinAddr)heapArray + heapArraySize, iPageSize);
sl@0: 				actualHeapPages = (endAddr - baseAddr) / iPageSize;
sl@0: 				PRINTF(KERN_PRINTF("heap baseAddr %x endAddr %x", baseAddr, endAddr));
sl@0: 				break;
sl@0: 
sl@0: 			case EKMoveStack:
sl@0: 				pageAddr = _ALIGN_DOWN((TLinAddr)stackArray, iPageSize);
sl@0: 				baseAddr = pageAddr;
sl@0: 				endAddr = _ALIGN_UP((TLinAddr)stackArray + KStackSize, iPageSize);
sl@0: 				PRINTF(KERN_PRINTF("stack baseAddr %x endAddr %x", baseAddr, endAddr));
sl@0: 				break;
sl@0: 			}
sl@0: 
sl@0: 		TUint32 minTime = KMaxTUint32;
sl@0: 		TUint32 maxTime = 0; 
sl@0: 		TUint32 cummulative = 0;
sl@0: 		TInt iterations = KMoveAttempts;
sl@0: 		TInt tot = iterations;
sl@0: 		TUint pagesMoved = (endAddr - baseAddr) / iPageSize;
sl@0: 		while (iterations--)
sl@0: 			{
sl@0: 			TUint32 diff;
sl@0: 			TUint32 startTime=0;
sl@0: 			TUint32 endTime=0;
sl@0: 			switch (moveMode)
sl@0: 				{
sl@0: 				case EKMoveHeap:
sl@0: 					startTime = NKern::FastCounter(); 
sl@0: 				
sl@0: 					while (pageAddr < endAddr) 
sl@0: 						{
sl@0: 						r = DoPageMove(pageAddr);
sl@0: 
sl@0: 						if (r != KErrNone)
sl@0: 							{
sl@0: 							goto exit;
sl@0: 							}
sl@0: 						pageAddr += iPageSize;
sl@0: 						}
sl@0: 					endTime = NKern::FastCounter();
sl@0: 					break;
sl@0: 			
sl@0: 				case EKMoveStack:
sl@0: 					// Normally will move same number of pages as heap to make comparison easier
sl@0: 					TUint i = actualHeapPages;
sl@0: 					startTime = NKern::FastCounter();
sl@0: 					for (; i > 0; i--)
sl@0: 						{
sl@0: 						while (pageAddr < endAddr) 
sl@0: 							{
sl@0: 							r = DoPageMove(pageAddr);
sl@0: 
sl@0: 							if (r != KErrNone)
sl@0: 								{
sl@0: 								goto exit;
sl@0: 								}
sl@0: 							pageAddr += iPageSize;
sl@0: 							}
sl@0: 						pageAddr = baseAddr;
sl@0: 						}
sl@0: 					endTime = NKern::FastCounter();
sl@0: 					break;
sl@0: 				}
sl@0: 			diff = endTime - startTime;
sl@0: 			if (endTime < startTime) 
sl@0: 				{
sl@0: 				Kern::Printf("WARNING - fast counter overflowed. Assuming only once and continuing");
sl@0: 				diff = (KMaxTUint32 - startTime) + endTime;
sl@0: 				}
sl@0: 
sl@0: 			if (diff == 0)
sl@0: 				{
sl@0: 				Kern::Printf("difference 0!");
sl@0: 				tot--;
sl@0: 				}
sl@0: 
sl@0: 			if (diff > maxTime)
sl@0: 				maxTime = diff;
sl@0: 			if (diff < minTime)
sl@0: 				minTime = diff;
sl@0: 
sl@0: 			if (cummulative + diff < cummulative)
sl@0: 				{
sl@0: 				Kern::Printf("OverFlow!!!");
sl@0: 				r = KErrOverflow;
sl@0: 				goto exit;
sl@0: 				}
sl@0: 			pageAddr = baseAddr;
sl@0: 			cummulative += diff;
sl@0: 			}
sl@0: 		switch (moveMode)
sl@0: 			{
sl@0: 			case EKMoveHeap:				
sl@0: 				if (tot != 0)
sl@0: 					{
sl@0: 					TUint average = (cummulative / tot);
sl@0: 					Kern::Printf("Fast counter ticks to move %d kernel heap pages: Av %d Min %d Max %d (non zero iterations = %d out of %d)", pagesMoved, average, minTime, maxTime, tot, KMoveAttempts);
sl@0: 					Kern::Printf("Average of %d ticks to move one page\n", average / pagesMoved);
sl@0: 					}
sl@0: 				else
sl@0: 					Kern::Printf("WARNING - all kernel heap page moves took 0 fast counter ticks");
sl@0: 				break;
sl@0: 			
sl@0: 			case EKMoveStack:
sl@0: 				if (tot != 0)
sl@0: 					{
sl@0: 					TUint average = (cummulative / tot);
sl@0: 					Kern::Printf("Fast counter ticks to move %d kernel stack pages %d times: Av %d Min %d Max %d (non zero iterations = %d out of %d)", pagesMoved, actualHeapPages, average, minTime, maxTime, tot, KMoveAttempts);
sl@0: 					Kern::Printf("Average of %d ticks to move one page\n", average / (pagesMoved * actualHeapPages));
sl@0: 					}
sl@0: 				else
sl@0: 					Kern::Printf("WARNING - all kernel stack page moves took 0 fast counter ticks");
sl@0: 				break;
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	r = KErrNone;
sl@0: exit:
sl@0: 	delete [] heapArray;
sl@0: 	return r;
sl@0: 	}
sl@0: 	
sl@0: