sl@0: // Copyright (c) 2008-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: // Demonstrates performance assesment of CPermanentFileStore
sl@0: // The Store root stream serves as an example of persistent data structure
sl@0: // 
sl@0: //
sl@0: 
sl@0: // The file name, extension and path for the file store
sl@0: _LIT(KPermFileStoreName,"Z:\\STOR-TST\\BMPermFileStores.dat");
sl@0: extern TFileName ThePermStoreFilePath;
sl@0: 
sl@0: // Create a permanent file store and initialise its stream structure
sl@0: LOCAL_C void doPrepareStoreL(const TDesC& aName);
sl@0: 
sl@0: // Use the store, preserving the stream structure
sl@0: LOCAL_C void doPermFileStoreL(const TDesC& aName);
sl@0: 
sl@0: // Update the data in the store
sl@0: LOCAL_C void doUpdateStoreL(CPersistentStore& aStore);
sl@0: #define PFSTORERUNSIZE	1000
sl@0: 
sl@0: typedef TBuf<100> TItem;
sl@0: 
sl@0: // The main object's in-memory representation
sl@0: class CItemArray : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	static TStreamId CreateL(CStreamStore& aStore);
sl@0: 	~CItemArray();
sl@0: 	static CItemArray* NewLC(CStreamStore& aStore,TStreamId anId);
sl@0: 	void RestoreL();
sl@0: 	void StoreL() const;
sl@0: 	void ExternalizeL(RWriteStream& aStream) const;
sl@0: 	//
sl@0: 	void AddItemL(const TItem& anItem);
sl@0: 	void RemoveItemL(TInt anIndex);
sl@0: 	TInt Count() const;
sl@0: 	void GetItemL(TItem& anItem,TInt anIndex) const;
sl@0: protected:
sl@0: 	CItemArray(CStreamStore& aStore);
sl@0: 	void ConstructL();
sl@0: 	void InternalizeL(RReadStream& aStream);
sl@0: private:
sl@0: 	CStreamStore& iStore;
sl@0: 	TStreamId iMyId;
sl@0: 	CArrayFixFlat<TStreamId>* iArray;
sl@0: 	CArrayFixFlat<TElement>* nArray;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID          SYSLIB-STORE-PT-1371
sl@0: @SYMTestCaseDesc	CR MRLM-6A9DF7. Tests the impact of RFileBuf cache size on CPermanentFileStore performance. RFileBuf cache size must be set at a build time in EStor_Template.mmh file, DEFAULT_FILE_BUF_SIZE macro definition.
sl@0: @SYMTestPriority 	High
sl@0: @SYMTestActions  	The test creates a set of test objects, externalizes them PFSTORERUNSIZE times and prints the execution time. Then internalizes them PFSTORERUNSIZE times and prints the execution time. PFSTORERUNSIZE is a constant, defined in the source file.
sl@0: @SYMTestExpectedResults Test must show a performance improvement
sl@0: @SYMPREQ                PREQ1132
sl@0: @SYMREQ			REQ4883
sl@0: */
sl@0: LOCAL_C void doPermanentFileStoreL()
sl@0:     {
sl@0:     TDriveUnit drive(static_cast<TUint>(RFs::GetSystemDrive()));	
sl@0: 	TParse permFileStoreName;
sl@0: 	permFileStoreName.Set(drive.Name(), &KPermFileStoreName, NULL);
sl@0: 	ThePermStoreFilePath.Copy(permFileStoreName.FullName());
sl@0:     
sl@0: 	TheFs.MkDirAll(permFileStoreName.DriveAndPath());
sl@0: 	doPrepareStoreL(ThePermStoreFilePath);
sl@0: 	
sl@0: 	TTime start;
sl@0: 	start.HomeTime();
sl@0: 	for(int i=0; i<PFSTORERUNSIZE; i++)
sl@0: 		{
sl@0: 		doPermFileStoreL(ThePermStoreFilePath);
sl@0: 		}
sl@0: 	TTime end;
sl@0: 	end.HomeTime();
sl@0: 	TTimeIntervalMicroSeconds us = end.MicroSecondsFrom(start);
sl@0: 	TheTest.Printf(_L("CPermanentFileStore, %d 'write' tests. Time=%ld ms\r\n"), PFSTORERUNSIZE, us.Int64() / 1000);
sl@0: 	}
sl@0: 
sl@0: LOCAL_C void doPrepareStoreL(const TDesC& aName)
sl@0: 	{
sl@0: 				// construct file store object - the file to contain the
sl@0: 				// the store replaces any existing file of the same name.
sl@0: 	CFileStore* store = CPermanentFileStore::ReplaceLC(TheFs,aName,EFileRead|EFileWrite);
sl@0: 				// Easy way to set the layout type
sl@0:     store->SetTypeL(store->Layout());
sl@0: 		
sl@0: 				// create the required stream for CItemArray
sl@0: 	TStreamId id=CItemArray::CreateL(*store);
sl@0: 	store->SetRootL(id);
sl@0: 	store->CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	}
sl@0: 
sl@0: LOCAL_C void doPermFileStoreL(const TDesC& aName)
sl@0: 	{
sl@0: 				// construct file store object - specifying the file
sl@0: 				// containing the store.
sl@0: 				// Do not need to specify the file store type, this is
sl@0: 				// specified by the file itself
sl@0: 	CFileStore* store = CFileStore::OpenL(TheFs,aName,EFileRead|EFileWrite);
sl@0: 
sl@0: 				// The standard form for using permanent file stores:
sl@0: 				// 1. The store object is not owned by the updating code
sl@0: 				// 2  Failure at any point during update, including the
sl@0: 				//    final commit, should result in Revert() being called
sl@0: 				//    on the store (before destruction).
sl@0: 	_LIT(KTxtErrorOccurred,"\n** Error %d occured during store update");
sl@0: 
sl@0: 	TRAPD(error,doUpdateStoreL(*store));
sl@0: 	if (error!=KErrNone)
sl@0: 		{
sl@0: 		store->Revert();
sl@0: 		TheTest.Printf(KTxtErrorOccurred);
sl@0: 		}
sl@0: 
sl@0: 	// the store is not on the cleanup stack
sl@0: 	delete store;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: LOCAL_C void doUpdateStoreL(CPersistentStore& aStore)
sl@0: 	{
sl@0: 				// get the root stream into memory
sl@0: 	CItemArray* array=CItemArray::NewLC(aStore,aStore.Root());
sl@0: 
sl@0: 				// Add some items
sl@0: 	_LIT(KTxtHello,"hello");
sl@0: 	_LIT(KTxtWorld," world!");
sl@0: 
sl@0: 	TItem item;
sl@0: 	item = KTxtHello;
sl@0: 	array->AddItemL(item);
sl@0: 	item = KTxtWorld;
sl@0: 	array->AddItemL(item);
sl@0: 				// Re-write the root stream with new data
sl@0: 	array->StoreL();
sl@0: 	aStore.CommitL();
sl@0: 
sl@0: 				// remove an item
sl@0: 	array->RemoveItemL(1);		// " world!"
sl@0: 				// Re-write the root stream with new data
sl@0: 	array->StoreL();
sl@0: 	aStore.CommitL();
sl@0: 				// Add an item
sl@0: 	_LIT(KTxtCapWorld," WORLD!");
sl@0: 	item= KTxtCapWorld;
sl@0: 	array->AddItemL(item);
sl@0: 				// Re-write the root stream with new data
sl@0: 	array->StoreL();
sl@0: 				// Discard all changes since last store commit
sl@0: 	aStore.Revert();
sl@0: 				// array and aStore are not in snych after revert...
sl@0: 				// restore in-memory version to match store version
sl@0: 	array->RestoreL();
sl@0: 					// Add the item again
sl@0: 	array->AddItemL(item);
sl@0: 				// Re-write the root stream with new data
sl@0: 	array->StoreL();
sl@0: 	aStore.CommitL();
sl@0: 	CleanupStack::PopAndDestroy(); // array
sl@0: 	}
sl@0: 
sl@0: //***************************************************************
sl@0: CItemArray::~CItemArray()
sl@0: 	{
sl@0: 	delete iArray;
sl@0: 	delete nArray;
sl@0: 	}
sl@0: 
sl@0: CItemArray::CItemArray(CStreamStore& aStore)
sl@0: 	: iStore(aStore)
sl@0: 	{}
sl@0: 
sl@0: TStreamId CItemArray::CreateL(CStreamStore& aStore)
sl@0: // create the stream representation of the class
sl@0: 	{
sl@0: 				// use a temporary CItemArray
sl@0: 	CItemArray* self=new(ELeave) CItemArray(aStore);
sl@0: 	CleanupStack::PushL(self);
sl@0: 				// construct object
sl@0: 	self->ConstructL();
sl@0: 				// create new stream
sl@0: 	RStoreWriteStream outstream;
sl@0: 	TStreamId id=outstream.CreateLC(aStore);
sl@0: 				// write  external rep
sl@0: 	self->ExternalizeL(outstream);
sl@0: 				// commit stream
sl@0: 	outstream.CommitL();
sl@0: 				// cleanup stream and temporary self
sl@0: 	CleanupStack::PopAndDestroy(2);
sl@0: 	return id;
sl@0: 	}
sl@0: 
sl@0: CItemArray* CItemArray::NewLC(CStreamStore& aStore,TStreamId anId)
sl@0: // construct a CItemArray from persistent storage
sl@0: 	{
sl@0: 	CItemArray* self=new(ELeave) CItemArray(aStore);
sl@0: 	CleanupStack::PushL(self);
sl@0: 				// construct object
sl@0: 	self->ConstructL();
sl@0: 				// set the stream id for StoreL/RestoreL
sl@0: 	self->iMyId=anId;
sl@0: 				// restore the internal rep.
sl@0: 	self->RestoreL();
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: void CItemArray::StoreL() const
sl@0: // replace external rep. with internal one
sl@0: 	{
sl@0: 	RStoreWriteStream outstream;
sl@0: 	outstream.ReplaceLC(iStore,iMyId);
sl@0: 	ExternalizeL(outstream);
sl@0: 	outstream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	}
sl@0: 
sl@0: void CItemArray::RestoreL()
sl@0: // replace internal rep with external one
sl@0: 	{
sl@0: 	iArray->Reset();
sl@0: 	nArray->Reset();
sl@0: 	RStoreReadStream instream;
sl@0: 	instream.OpenLC(iStore,iMyId);
sl@0: 	InternalizeL(instream);
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	}
sl@0: 
sl@0: void CItemArray::AddItemL(const TItem& anItem)
sl@0: // add item to the collection
sl@0: 	{
sl@0: 				// write external rep of item
sl@0: 	RStoreWriteStream outstream;
sl@0: 	TStreamId id=outstream.CreateLC(iStore);
sl@0: 	outstream<<anItem;
sl@0: 	outstream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 				// add new stream id to the internal array
sl@0: 	iArray->AppendL(id);
sl@0: 	}
sl@0: 
sl@0: void CItemArray::RemoveItemL(TInt anIndex)
sl@0: // remove an item from the collection
sl@0: 	{
sl@0: 				// remove the stream from the store
sl@0: 	iStore.DeleteL((*iArray)[anIndex]);
sl@0: 				// remove the entry from the internal array
sl@0: 	iArray->Delete(anIndex);
sl@0: 	}
sl@0: 
sl@0: TInt CItemArray::Count() const
sl@0: 	{
sl@0: 	return iArray->Count();
sl@0: 	}
sl@0: 
sl@0: void CItemArray::GetItemL(TItem& anItem,TInt anIndex) const
sl@0: 	{
sl@0: 				// retrieve an item from the store
sl@0: 	RStoreReadStream instream;
sl@0: 	instream.OpenLC(iStore,(*iArray)[anIndex]);
sl@0: 	instream>>anItem;
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	}
sl@0: 
sl@0: void CItemArray::ConstructL()
sl@0: 	{
sl@0: 	iArray=new(ELeave) CArrayFixFlat<TStreamId>(8);
sl@0: 	nArray = new (ELeave) CArrayFixFlat<TElement>(PFSTORERUNSIZE);
sl@0: 	TElement theElement;
sl@0: 	_LIT(KFormatTxt,"BenchMarkingPermanentFileStore%4u");
sl@0: 	TBuf<256> str(KFormatTxt);
sl@0: 
sl@0: 	for (TInt index = 0; index < PFSTORERUNSIZE; index++)
sl@0: 		{
sl@0: 		theElement.iData.Format(KFormatTxt,index);
sl@0: 		nArray->AppendL(theElement);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CItemArray::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 				// stream out the array
sl@0: 	aStream<<*iArray;
sl@0: 	TInt count = nArray->Count();
sl@0: 	TElement theElement;
sl@0: 	for (TInt index = 0; index < count; index++)
sl@0: 		{
sl@0: 		theElement =((*nArray)[index]);
sl@0: 		aStream.WriteL(theElement.iData, 34);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CItemArray::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 				// stream in the array
sl@0: 	aStream>>*iArray;
sl@0: 	
sl@0: 	TElement theElement;
sl@0: 	TInt count = nArray->Count();
sl@0: 	nArray->Reset();
sl@0: 	for (TInt index = 0; index < count; index++)
sl@0: 		{
sl@0: 		aStream.ReadL(theElement.iData, 34);
sl@0: 		nArray->AppendL(theElement);
sl@0: 		}
sl@0: 	}