// Copyright (c) 2007-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:

// f32test\server\t_wcache.cpp

// This file contains a test for the Write Caching functionality of the File Server

// 

//

/**

 @file

 @internalTechnology 

*/

#define __E32TEST_EXTENSION__

#include <f32file.h>

#include <e32test.h>

#include <e32svr.h>

#include <f32dbg.h>

#include "t_server.h"

#include <e32twin.h>

#include <hal.h>

#include "tf32testtimer.h"

const TInt KTotalCacheSize = 32 * 1024 * 1024;

const TInt KDefaultCacheSize = (128 + 12) * 1024; 	// This size is the default configuration size

const TInt KFilesNeededToFillCache = (KTotalCacheSize / KDefaultCacheSize) + 2;

const TInt KMinSize = 254; // Boundary minim limit

const TInt KMaxSize = 257; // Boundary max limit

//----------------------------------------------------------------------------------------------

//! @SYMTestCaseID      PBASE-T_WCACHE-0271

//! @SYMTestType        CIT

//! @SYMPREQ            PREQ914

//! @SYMTestCaseDesc    This test case is exercising the Write Caching functionality added to 

//!						the File Server. There are negative and positive tests. 

//! @SYMTestActions     0   setup the environment to execute the tests

//!						1	TestBoundaries writes/reads around the write cache boundaries to

//!							the behaviour of the cache in some common cases. 

//!						2 	TestNegative ensures the integrity of data in the cache gets 

//!							preserved under error conditions

//!						3	TestIntegrity is trying to make sure integrity of the data is preserved

//!						4	TestFillCache fills the cache and then executes TestBoundaries. 

//!						5 	TestFillCacheNegative fills the cache with uncommitted data 

//!

//! @SYMTestExpectedResults finishes if the read cache behaves as expected, panics otherwise

//! @SYMTestPriority        High

//! @SYMTestStatus          Implemented

//----------------------------------------------------------------------------------------------

////////////////////////////////////////////////////////////

// Template functions encapsulating ControlIo magic

//

template <class C>

TInt controlIo(RFs &fs, TInt drv, TInt fkn, C &c)

{

    TPtr8 ptrC((TUint8 *)&c, sizeof(C), sizeof(C));

    TInt r = fs.ControlIo(drv, fkn, ptrC);

    return r;

}

RTest test(_L("T_WCACHE"));

RFs gTheFs;

TInt gDrive;

TFileName gSessionPath;

TChar gDriveToTest;	

TThreadId gMainThreadId;

TInt gManual = 0;

HBufC8* gBuf = NULL;

TPtr8 gBufReadPtr(NULL, 0);	

HBufC8* gBufSec = NULL;

TPtr8 gBufWritePtr(NULL, 0);	

const TInt KOneK = 1024;

const TInt KOneMeg = KOneK * 1024;

const TInt KBlockSize = KOneK;

const TInt KWaitRequestsTableSize = 256;

TInt gSecondFileSize = 0; 

TInt gFirstFileSize = 0;

TInt64 gMediaSize = 0;

TTimeIntervalMicroSeconds gTimeTakenBigFile(0);

TBuf16<25> gFirstFile;

TBuf16<25> gSecondFile;

TBuf16<25> gCurrentFile;

TInt gNextFile = 0;

// Concurrent Threads

RThread gThread1;

RSemaphore gClient;

const TInt KHeapSize = 0x4000;

const TInt KMaxHeapSize = 0x100000;

/** Formats the drive 

	@param aDrive 	Drive to be formatted

	@param aFormatMode Mode for the format operation

*/

void Formatting(TInt aDrive, TUint aFormatMode )

	{

	test.Next(_L("Format"));

	TBuf<4> driveBuf = _L("?:\\");

	driveBuf[0]=(TText)(aDrive+'A');

	RFormat format;

	TInt count;

	TInt r = format.Open(gTheFs,driveBuf,aFormatMode,count);

	test_KErrNone(r);

	while(count)

		{

		TInt r = format.Next(count);

		test_KErrNone(r);

		}

	format.Close();

	}

/** Verifies the content of a buffer 

	This function returns KErrNone when all the letters are consecutive in the aBuffer, KErrCorrupt otherwise

	@param aBuffer  Buffer to be verified

	@return KErrNone if all the letters are the same, KErrCorrupt otherwise

*/

TInt VerifyBuffer(TDes8& aBuffer)

	{

	TChar c = aBuffer[0];

	for(TInt i = 1; i < aBuffer.Length(); i++)

		{

		if(i%32 != 0) 

			{

			if(c != (TChar)(aBuffer[i] - 1)) 

				return KErrCorrupt;

			}

		else

			{

			if(aBuffer[i] != aBuffer[0])		

				return KErrCorrupt;

			}

		c = aBuffer[i];

		}

	return KErrNone;

	}

/**  Fills a buffer with character aC, aC+1, aC+2, ..., aC+0x20, aC, etc 

	@param aBuffer  Buffer to be filled, output

	@param aLength  Length to be filled

	@param aC		Character to be used to fill the buffer

*/

void FillBuffer(TDes8& aBuffer, TInt aLength, TChar aC)

	{

	test (aBuffer.MaxLength() >= aLength);

	for(TInt i = 0; i < aLength; i++)

		{

		aBuffer.Append((i%32) + aC);

		}

	}

/**  Returns true if fat filesystem present on aDrive

	@param aFsSession 	Session on the File Server

	@param aDrive 		Drive to be looked at

	@return ETrue if FAT, EFalse otherwise

*/

TBool IsFSFAT(RFs &aFsSession,TInt aDrive)

	{

	TFileName f;

	TInt r = aFsSession.FileSystemName(f,aDrive);

	if (r != KErrNone)

		{

		test.Printf(_L("Unable to get file system name\n"));

		return EFalse;

		}

	return (f.CompareF(_L("Fat")) == 0);

	}

/** Generates a file name of the form FFFFF*<aPos>.TXT (aLong.3)

	@param aBuffer The filename will be returned here

	@param aLong   Defines the longitude of the file name 

	@param aPos	   Defines the number that will be attached to the filename

*/

void FileNameGen(TDes16& aBuffer, TInt aLong, TInt aPos) 

	{

	TInt padding;

	TInt i = 0;

	TBuf16<10> tempbuf;

	_LIT(KNumber,"%d");

	tempbuf.Format(KNumber,aPos);

	padding = aLong-tempbuf.Size()/2;

	aBuffer = _L("");

	while(i < padding)

	{

		aBuffer.Append('F');

		i++;

	}

	aBuffer.Append(tempbuf);

	_LIT(KExtension1, ".TXT");

	aBuffer.Append(KExtension1);

	}

/**  Delete content of directory

	@param aDir	Target directory

	@return Error returned if any, otherwise KErrNone

*/

TInt DeleteAllL(TDes16& aDir) 

	{

	TBuf16<100> dir;

	CFileMan* fMan = CFileMan::NewL(gTheFs);

	TInt r=0;

	dir = aDir;

	dir.Append(_L("F*.*"));

	r = fMan->Delete(dir);	

	delete fMan;

	return r;

	}

/**  Waits for all the TRequestStatus in status[] to complete

	@param status 	Array of TRequestStatus 

	@param aSize  Length to be filled

*/

void WaitForAll(TRequestStatus* status, TInt aSize) 

	{

	TInt i = 0;

	RTest test(_L("T_WCACHE"));

	while(i < aSize)

		{

		User::WaitForRequest(status[i]);

		if (status[i] != KErrNone)

			{

			test.Printf(_L("status[%d] == %d\n"), i, status[i].Int());

			test(EFalse);

			}

		i++;

		}

	test.Close();

	}

/**  Reads the parameters from the comand line 

	 and updates the appropriate variables

*/

void parseCommandLine() 

	{

	TBuf<0x100> cmd;

	User::CommandLine(cmd);

	TLex lex(cmd);

	TPtrC token = lex.NextToken();

	TInt r=0;

	if(token.Length() != 0)		

		{

		gDriveToTest = token[0];

		gDriveToTest.UpperCase();

		}

	else						

		{

		gDriveToTest = 'C';

		}	

	r = gTheFs.CharToDrive(gDriveToTest,gDrive);

	test_KErrNone(r);

	if(!lex.Eos()) 

		{

		token.Set(lex.NextToken());	

		if(token.Length() != 0)		

			{

				TChar c = token[0];

				c.UpperCase();

				gManual = (c == 'M'); 

			}

		}

	gSessionPath = _L("?:\\F32-TST\\");

	gSessionPath[0] = (TUint16) gDriveToTest;

	test.Printf(_L("\nCLP=%C\n"),(TInt)gDriveToTest);

	}

/**  Writes a file synchronously in blocks of aBlockSize size

	@param aFs			RFs object

	@param aFile		File 

	@param aFileName	File name

	@param aSize		Size of the file in bytes

	@param aBlockSize	Size of the blocks to be used in bytes

	@param aBuf			Buffer to be used to write

	@param aMode		Mode in which the file is meant to be opened

	@return Returns KErrNone if everything ok, otherwise it panics 

*/

TInt WriteFile(RFs& aFs, RFile& aFile, TDes16& aFileName, TInt aSize, TInt aBlockSize, TDes8& aBuf, TInt aMode) 

	{

	RTest test(_L("T_WCACHE"));

	TInt r = 0;

	test(aBlockSize > 0);	

	r = aFile.Replace(aFs,aFileName,aMode);

	test_KErrNone(r);

	TInt j = 0;

	while(j < aSize)

		{

			r = aFile.Write(aBuf, aBlockSize);

			test_KErrNone(r);

			j += aBlockSize;

		}					

	test.Close();

	return KErrNone;	

	}

/** Write a file that fits in the cache, and dies without proper cleaning

*/

LOCAL_C TInt WriteFileT(TAny* )

	{

	RTest test(_L("T_WCACHE"));

	RFs fs;

	RFile file;

	TInt r = fs.Connect();

	test_KErrNone(r);

	r = fs.SetSessionPath(gSessionPath);

	test_KErrNone(r);

	r = WriteFile(fs, file, gFirstFile, KMinSize * KOneK, KBlockSize, gBufWritePtr, EFileShareAny|EFileWrite|EFileWriteBuffered);

	test_KErrNone(r);

	gClient.Signal();

	FOREVER

		{

			// waiting for the kill

		}		

	}

/**  Read File in blocks of size aBlockSize

	@param aFs			RFs object

	@param aFile		File 

	@param aFileName	File name

	@param aSize		Expected file size

	@param aBlockSize	Size of the blocks to be used in bytes

	@param aMode		Mode in which the file is meant to be opened

	@return Returns KErrNone if everything ok, otherwise it panics 

*/

TInt ReadFile(RFs& aFs, RFile& aFile, TDes16& aFileName, TInt aSize, TInt aBlockSize, TInt aMode) 

	{

	RTest test(_L("T_WCACHE"));

	TInt r = 0, size = 0;

	test(aBlockSize>0);				// Block size must be greater than 0

	r = aFile.Open(aFs,aFileName,aMode);

	test_KErrNone(r);

	// Make sure the size of the file is the right one at this stage

	r = aFile.Size(size);

	test.Printf(_L("size of the file: %d \n"), size/KOneK); 

	test(size == aSize);

	TInt j = 0;

	while(j < size) 

	{

		r = aFile.Read(gBufReadPtr, aBlockSize);

		test_KErrNone(r);

		j += aBlockSize;

	}					

	test.Close();

	return KErrNone;	

	}

/** Write a file asynchronously in blocks of aBlockSize size

	@param aFs			RFs object

	@param aFileWrite	RFile object, needs to exist beyond the scope of this function

	@param aFile		File name

	@param aSize		Size of the file in bytes

	@param aMode		Specifies the mode in which the file should be openned

	@param aStatus		TRequestStatus array for all the requests

*/

void WriteFileAsync(RFs& aFs, RFile& aFileWrite, TDes16& aFile, TInt aSize, TInt aMode, TRequestStatus aStatus[]) 

	{

	RTest test(_L("T_WCACHE"));

	TInt r = 0;

	r = aFileWrite.Replace(aFs,aFile,aMode);

	test_KErrNone(r);

	TInt j = 0, i = 0;

	while(j < aSize)

		{

		aFileWrite.Write(gBufWritePtr, KBlockSize, aStatus[i]);

		r = aStatus[i].Int();

		if (r != KErrNone && r != KRequestPending)

			{

			test.Printf(_L("Write %d returned %d\n"), i, r);

			test(0);

			}

		i++;

		j += KBlockSize;	

		}					

	test.Close();

	}

/**  Read a file asynchronously in blocks of aBlockSize size

	@param aFs			RFs object

	@param aFileRead	RFile object, needs to exist beyond the scope of this function

	@param aFile		File name

	@param aFileSize		Size of the file in bytes

	@param aBlockSize	Size of the blocks to be used in bytes

	@param aStatus		TRequestStatus array for all the requests

	@param aMode		Specifies the mode in which the file should be openned

	@return KErrNone

*/

TInt ReadFileAsync(RFs& aFs,RFile& aFileRead, TDes16& aFile, TInt aFileSize, TInt aBlockSize,TRequestStatus aStatus[],  TInt aMode) 

	{

	RTest test(_L("T_WCACHE"));

	TInt r = 0;

	TInt size = 0;

	test(aBlockSize > 0);			

	r = aFileRead.Open(aFs,aFile, aMode); 

	test_KErrNone(r);

	r = aFileRead.Size(size);

	test_KErrNone(r);

	test.Printf(_L("size of the file %d\n"), size/KOneK);

	test(size == aFileSize);

	TInt j = 0, i = 0;

	while(j < size) 

		{

		aFileRead.Read(gBufReadPtr, aBlockSize, aStatus[i]);

		r = aStatus[i].Int();

		if (r != KErrNone && r != KRequestPending)

			{

			test.Printf(_L("Read %d returned %d\n"), i, r);

			test(0);

			}

		i++;

		j += aBlockSize;

		}					

	test.Close();

	return KErrNone;	

	}

/** Measure the time taken for this file to be written synchronously

	@param aFile 	 	File object

	@param aFileName 	File Name

	@param aSize 		Size in kilobytes

	@param aBlockSize 	Size of the block

	@param aMode 		Mode in which the file is going to be opened

	@return time taken to perform the operation in uS

*/

TTimeIntervalMicroSeconds WriteTestFile(RFile& aFile, TDes16& aFileName, TInt aSize, TInt aBlockSize, TInt aMode) 

	{

	RTest test(_L("T_WCACHE"));

	TInt r = 0;

    TF32TestTimer timer;

	timer.Start();

	r = WriteFile(gTheFs,aFile, aFileName , aSize * KOneK, aBlockSize, gBufWritePtr, aMode);

	test_KErrNone(r);

	timer.Stop();	

	gTimeTakenBigFile = timer.Time();