sl@0: // Copyright (c) 1998-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 "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: //
sl@0: 
sl@0: #include <s32file.h>
sl@0: #include <e32test.h>
sl@0: #include <e32math.h>
sl@0: #include <hal.h>
sl@0: 
sl@0: // This is a path specification and should not be used as is
sl@0: _LIT(KFileLocationSpec, "Z:\\STOR-TST\\T_FRECL.DAT");
sl@0: const TPtrC KTestText=_L("Reclamation testing in progress...");
sl@0: const TInt 	KTestStreams=1000;
sl@0: const TInt 	KTestReplicas=5000;
sl@0: 
sl@0: TFileName TheFileName; 
sl@0: 
sl@0: RTest 	TheTest(_L("t_storfrecl"));
sl@0: RFs 	TheFs;
sl@0: TInt64 	TheSeed;
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: void DeleteDataFile(const TDesC& aFullName)
sl@0: 	{
sl@0: 	RFs fsSession;
sl@0: 	TInt err = fsSession.Connect();
sl@0: 	if(err == KErrNone)
sl@0: 		{
sl@0: 		TEntry entry;
sl@0: 		if(fsSession.Entry(aFullName, entry) == KErrNone)
sl@0: 			{
sl@0: 			RDebug::Print(_L("Deleting \"%S\" file.\n"), &aFullName);
sl@0: 			err = fsSession.SetAtt(aFullName, 0, KEntryAttReadOnly);
sl@0: 			if(err != KErrNone)
sl@0: 				{
sl@0: 				RDebug::Print(_L("Error %d changing \"%S\" file attributes.\n"), err, &aFullName);
sl@0: 				}
sl@0: 			err = fsSession.Delete(aFullName);
sl@0: 			if(err != KErrNone)
sl@0: 				{
sl@0: 				RDebug::Print(_L("Error %d deleting \"%S\" file.\n"), err, &aFullName);
sl@0: 				}
sl@0: 			}
sl@0: 		fsSession.Close();
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		RDebug::Print(_L("Error %d connecting file session. File: %S.\n"), err, &aFullName);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////
sl@0: //Test macros and functions
sl@0: void Check(TInt aValue, TInt aLine)
sl@0: 	{
sl@0: 	if(!aValue)
sl@0: 		{
sl@0: 		TheTest.Printf(_L("*** Boolean expression evaluated to false\r\n"));
sl@0: 		DeleteDataFile(TheFileName);
sl@0: 		TheTest(EFalse, aLine);
sl@0: 		}
sl@0: 	}
sl@0: void Check(TInt aValue, TInt aExpected, TInt aLine)
sl@0: 	{
sl@0: 	if(aValue != aExpected)
sl@0: 		{
sl@0: 		DeleteDataFile(TheFileName);
sl@0: 		TheTest.Printf(_L("*** Expected error: %d, got: %d\r\n"), aExpected, aValue);
sl@0: 		TheTest(EFalse, aLine);
sl@0: 		}
sl@0: 	}
sl@0: #define TEST(arg) ::Check((arg), __LINE__)
sl@0: #define TEST2(aValue, aExpected) ::Check(aValue, aExpected, __LINE__)
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: static TInt TheCounterFreq = -10000000;
sl@0: const TInt KMicroSecIn1Sec = 1000000;
sl@0: 
sl@0: TUint32 CalcTickDiff(TUint32 aStartTicks, TUint32 aEndTicks)
sl@0: 	{
sl@0: 	TInt64 diffTicks = (TInt64)aEndTicks - (TInt64)aStartTicks;
sl@0: 	if(diffTicks < 0)
sl@0: 		{
sl@0: 		diffTicks = KMaxTUint32 + diffTicks + 1;
sl@0: 		}
sl@0: 	return (TUint32)diffTicks;
sl@0: 	}
sl@0: 
sl@0: //Prints aFastCount parameter (converted to us) and the bytes count
sl@0: void PrintFcDiffAsUs2(const TDesC& aFormatStr, TInt aBytes, TUint32 aFastCount)
sl@0: 	{
sl@0: 	if(TheCounterFreq <= 0)
sl@0: 		{
sl@0: 		TEST2(HAL::Get(HAL::EFastCounterFrequency, TheCounterFreq), KErrNone);
sl@0: 		TheTest.Printf(_L("Counter frequency=%d Hz\r\n"), TheCounterFreq);
sl@0: 		}
sl@0: 	double v = ((double)aFastCount * KMicroSecIn1Sec) / (double)TheCounterFreq;
sl@0: 	TInt v2 = (TInt)v;
sl@0: 	TheTest.Printf(aFormatStr, aBytes, v2);
sl@0: 	}
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: TInt ReclaimL(CStreamStore& aStore)
sl@0: 	{
sl@0: 	TUint32 fc = User::FastCounter();
sl@0: 	TInt total = aStore.ReclaimL();
sl@0: 	TUint32 time = CalcTickDiff(fc, User::FastCounter());
sl@0: 	PrintFcDiffAsUs2(_L("### CStreamStore::ReclaimL(), %d bytes reclaimable, Time=%d us\r\n"), total, time);
sl@0: 	return total;
sl@0: 	}
sl@0: /**
sl@0: @SYMTestCaseID          SYSLIB-STORE-CT-1159
sl@0: @SYMTestCaseDesc	    Tests CStreamStore::ReclaimL() function
sl@0: @SYMTestPriority 	    High
sl@0: @SYMTestActions  	    Tests for reclaiming the space on the store.
sl@0:                         Tests for an empty store,simple and a complex store.
sl@0: @SYMTestExpectedResults Test must not fail
sl@0: @SYMREQ                 REQ0000
sl@0: */
sl@0: void ReclaimTestL()
sl@0: 	{
sl@0: 	TheTest.Start(_L(" @SYMTestCaseID:SYSLIB-STORE-CT-1159 CPermanentFileStore::ReclaimL()"));
sl@0: 	
sl@0: 	TheTest.Printf(_L(" Empty store\r\n"));
sl@0: 	CFileStore* store = CPermanentFileStore::ReplaceLC(TheFs, TheFileName, EFileRead | EFileWrite);
sl@0: 	store->SetTypeL(store->Layout());
sl@0: 	TInt bytes = ReclaimL(*store);
sl@0: 	TEST2(bytes, 0);
sl@0: 
sl@0: 	TheTest.Printf(_L(" Simple store\r\n"));
sl@0: 	RStoreWriteStream strm;
sl@0: 	TStreamId id=strm.CreateLC(*store);
sl@0: 	strm<<KTestText;
sl@0: 	strm.CommitL();
sl@0: 	strm.Release();
sl@0: 	store->CommitL();
sl@0: 	(void)ReclaimL(*store);
sl@0: 
sl@0: 	TheTest.Printf(_L(" Complex store\r\n"));
sl@0: 	TInt ii;
sl@0: 	for (ii=0;ii<KTestStreams;++ii)
sl@0: 		{
sl@0: 		id=strm.CreateL(*store);
sl@0: 		TInt val=Math::Rand(TheSeed);
sl@0: 		TInt len=(val>>11)%(KTestText.Length()+1);
sl@0: 		if (len>0)
sl@0: 			strm<<KTestText.Left(len-1);
sl@0: 		strm.CommitL();
sl@0: 		strm.Release();
sl@0: 		if ((val>>7)&1)
sl@0: 			store->DeleteL(id);
sl@0: 		}
sl@0: 	store->CommitL();
sl@0: 	(void)ReclaimL(*store);
sl@0: 
sl@0: 	TheTest.Printf(_L(" Large stream\r\n"));
sl@0: 	id=strm.CreateL(*store);
sl@0: 	for (ii=0;ii<KTestReplicas;++ii)
sl@0: 		strm<<KTestText;
sl@0: 	strm.CommitL();
sl@0: 	strm.Release();
sl@0: 	store->CommitL();
sl@0: 	(void)ReclaimL(*store);
sl@0: 
sl@0: 	TheTest.Printf(_L(" Deleted large stream\r\n"));
sl@0: 	store->DeleteL(id);
sl@0: 	store->CommitL();
sl@0: 	(void)ReclaimL(*store);
sl@0: 
sl@0: 	TheTest.Printf(_L(" Mixed reclaim and commit\r\n"));
sl@0: 	RStoreReclaim reclaim;
sl@0: 	TInt step;
sl@0: 	reclaim.OpenLC(*store,step);
sl@0: 	TRequestStatus status;
sl@0: 	TPckgBuf<TInt> pckgStep(step);
sl@0: 	TRAPD(r, reclaim.NextL(pckgStep,status));
sl@0: 	TEST2(r, KErrNone);
sl@0: 	User::WaitForRequest(status);
sl@0: 	TEST2(status.Int(), KErrNone);
sl@0: 	TEST(step>0);
sl@0: 	strm.CreateL(*store);
sl@0: 	strm<<KTestText;
sl@0: 	strm.CommitL();
sl@0: 	strm.Release();
sl@0: 	TRAP(r, reclaim.NextL(step));
sl@0: 	TEST(r!=KErrNone);
sl@0: 	reclaim.ResetL(step);
sl@0: 	r = reclaim.Next(step);
sl@0: 	TEST(r!=KErrNone);
sl@0: 	store->CommitL();
sl@0: 	TPckgBuf<TInt> pckgStep1(step);
sl@0: 	reclaim.Next(pckgStep1,status) ;
sl@0: 	User::WaitForRequest(status);
sl@0: 	TEST(status.Int() != KErrNone);
sl@0: 	reclaim.ResetL(step);
sl@0: 	while (step)
sl@0: 		{
sl@0: 		r = reclaim.Next(step);
sl@0: 		TEST2(r, KErrNone);
sl@0: 		}
sl@0: 
sl@0: 	TInt total=reclaim.Available();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	TheTest.Printf(_L(" %d byte(s) reclaimable\n"),total);
sl@0: 
sl@0: 	CleanupStack::Pop();	// strm
sl@0: 	CleanupStack::PopAndDestroy();	// store
sl@0: 	}
sl@0: 
sl@0: //Initialize TheFileName. RFs::Connect(). Prepare the test directory. 
sl@0: void CreateTestEnv()
sl@0:     {
sl@0: 	TDriveUnit drive(static_cast<TUint>(RFs::GetSystemDrive()));	
sl@0: 	TParse parse;
sl@0: 	parse.Set(drive.Name(), &KFileLocationSpec, NULL);
sl@0: 	TheFileName.Copy(parse.FullName());
sl@0: 	TheTest.Printf(_L("### Test file: %S\r\n"), &TheFileName);
sl@0:     
sl@0: 	TInt err = TheFs.Connect();
sl@0: 	TheTest(err == KErrNone);
sl@0: 
sl@0: 	err = TheFs.MkDirAll(TheFileName);
sl@0: 	TEST(err == KErrNone || err == KErrAlreadyExists);
sl@0: 	}
sl@0: 
sl@0: TInt E32Main()
sl@0:     {
sl@0: 	TheTest.Title();
sl@0: 	
sl@0: 	CTrapCleanup* tc = CTrapCleanup::New();
sl@0: 	TheTest(tc != NULL);
sl@0: 	
sl@0: 	__UHEAP_MARK;
sl@0: 	
sl@0: 	CreateTestEnv();
sl@0: 	
sl@0: 	TRAPD(err, ReclaimTestL());
sl@0: 	::DeleteDataFile(TheFileName);
sl@0: 	TheFs.Close();
sl@0: 	TEST2(err, KErrNone);
sl@0: 
sl@0: 	__UHEAP_MARKEND;
sl@0: 	
sl@0: 	TheTest.End();
sl@0: 	TheTest.Close();
sl@0: 
sl@0: 	delete tc;
sl@0: 	
sl@0: 	return 0;
sl@0:     }
sl@0: