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 "UP_STD.H"
sl@0: 
sl@0: #include <pbe.h>
sl@0: 
sl@0: EXPORT_C void TStorePagePoolToken::ExternalizeL(RWriteStream& aStream) const
sl@0: /** Externalises a TStorePagePoolToken object to a stream.
sl@0: 
sl@0: @param aStream Stream to which the object should be externalised */
sl@0: 	{
sl@0: 	aStream<<iHead;
sl@0: 	aStream<<iAvail;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void TStorePagePoolToken::InternalizeL(RReadStream& aStream)
sl@0: /** Internalises a TStorePagePoolToken object from a stream.
sl@0: 
sl@0: @param aStream Stream from which the object should be internalised */
sl@0: 	{
sl@0: 	aStream>>iHead;
sl@0: 	aStream>>iAvail;
sl@0: 	}
sl@0: 
sl@0: // Class RStorePagePool
sl@0: 
sl@0: EXPORT_C RStorePagePool::RStorePagePool()
sl@0: 	: iStore(NULL)
sl@0: /** Default constructor. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C RStorePagePool::RStorePagePool(CPageCache& aCache)
sl@0: 	: TCachePagePool(aCache),iStore(NULL)
sl@0: /** Constructor with a page cache for the pool.
sl@0: 
sl@0: @param aCache Page cache for the pool */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C RStorePagePool::RStorePagePool(CStreamStore& aStore)
sl@0: /** Constructor with a stream store to use for the pool.
sl@0: 
sl@0: @param aStore Stream store to use for the pool */
sl@0: 	{
sl@0: 	Create(aStore);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C RStorePagePool::RStorePagePool(CStreamStore& aStore,const TStorePagePoolToken& aToken)
sl@0: /** Constructor with a stream store and settings to use for the pool.
sl@0: 
sl@0: @param aStore Stream store to use for the pool
sl@0: @param aToken Stream store pool settings */
sl@0: 	{
sl@0: 	Open(aStore,aToken);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStorePagePool::Create(CStreamStore& aStore)
sl@0: /** Creates a new pool.
sl@0: 
sl@0: @param aStore Stream store to use for the pool */
sl@0: 	{
sl@0: 	iStore=&aStore;
sl@0: 	iHead=KNullStreamId;
sl@0: 	iAvail=KNullPageRef;
sl@0: 	iDirty=EFalse;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStorePagePool::Open(CStreamStore& aStore,const TStorePagePoolToken& aToken)
sl@0: /** Opens an existing pool.
sl@0: 
sl@0: @param aStore Stream store for the pool
sl@0: @param aToken Pool settings */
sl@0: 	{
sl@0: 	iStore=&aStore;
sl@0: 	iHead=aToken.iHead;
sl@0: 	iAvail=aToken.iAvail;
sl@0: 	iDirty=EFalse;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TStorePagePoolToken RStorePagePool::Token() const
sl@0: /** Gets an object that encapsulates the page pool settings.   
sl@0: 
sl@0: That object can then be used to externalise the settings.
sl@0: 
sl@0: @return Encapsulates the page pool settings */
sl@0: 	{
sl@0: 	return TStorePagePoolToken(iHead,iAvail);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStorePagePool::Close()
sl@0: /** Flushes and purges the page cache and stops using the stream store. */
sl@0: 	{
sl@0: 	TCachePagePool::Flush();
sl@0: 	Release();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool RStorePagePool::ReclaimL()
sl@0: /** Deletes the first stream that stores reclaimable pages in the store.
sl@0: 
sl@0: @return True if there are remaining streams (pages), false if there are no 
sl@0: more streams */
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iStore!=NULL,Panic(EPageNotOpen));
sl@0: 	__ASSERT_ALWAYS(iAvail==KNullPageRef,Panic(EPageReclaimAvailable));
sl@0: 	if (iHead!=KNullStreamId)
sl@0: 		{
sl@0: 		RStoreReadStream out;
sl@0: 		out.OpenLC(*iStore,iHead);
sl@0: 		TStreamId next;
sl@0: 		out>>next;
sl@0: 		CleanupStack::PopAndDestroy();
sl@0: 		iStore->DeleteL(iHead);
sl@0: 		iHead=next;
sl@0: 		MarkDirty();
sl@0: 		if (next!=KNullStreamId)
sl@0: 			return ETrue;
sl@0: 		}
sl@0: 	return EFalse;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStorePagePool::ReclaimAllL()
sl@0: /** Deletes all streams in the store. */
sl@0: 	{
sl@0: 	while (ReclaimL())
sl@0: 		;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TPageRef RStorePagePool::ExtendL(const TAny* aPage,TPageReclamation aReclamation)
sl@0: //
sl@0: // Create a new page.
sl@0: //
sl@0: 	{
sl@0: 	return StorePagePool::ExtendL(*this,aPage,aReclamation);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStorePagePool::WriteL(TPageRef aRef,const TAny* aPage,TPageChange aChange)
sl@0: //
sl@0: // Write a page to the store.
sl@0: //
sl@0: 	{
sl@0: 	StorePagePool::WriteL(*this,aRef,aPage,aChange);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStorePagePool::ReadL(TPageRef aRef,TAny* aPage)
sl@0: //
sl@0: // Read from the store into a page.
sl@0: //
sl@0: 	{
sl@0: 	StorePagePool::ReadL(*this,aRef,aPage);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStorePagePool::DoDeleteL(TPageRef aRef)
sl@0: //
sl@0: // Delete from store.
sl@0: //
sl@0: 	{
sl@0: 	StorePagePool::DeleteL(*this,aRef);
sl@0: 	}
sl@0: 
sl@0: // Class RSecureStorePagePool
sl@0: 
sl@0: 
sl@0: 
sl@0: EXPORT_C RSecureStorePagePool::RSecureStorePagePool(const CPBEncryptSet& aKey)
sl@0: 	: iKey(aKey)
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C RSecureStorePagePool::RSecureStorePagePool(CPageCache& aCache, const CPBEncryptSet& aKey)
sl@0: 	: RStorePagePool(aCache),
sl@0: 	iKey(aKey)
sl@0: 	{}
sl@0: 
sl@0: /** Adds a new page to the pool.
sl@0: 
sl@0: @param aPage Data for the page
sl@0: @param aReclamation Flags that define how allocated pages can be reclaimed
sl@0: @return Reference to newly created page */
sl@0: EXPORT_C TPageRef RSecureStorePagePool::ExtendL(const TAny* aPage,TPageReclamation aReclamation)
sl@0: 	{		
sl@0: 	return StorePagePool::ExtendL(*this,aPage,aReclamation);
sl@0: 	}
sl@0: 
sl@0: /** Writes data to a page in the pool.
sl@0: 
sl@0: @param aRef Reference to the page to which to write
sl@0: @param aPage Data to write
sl@0: @param aChange Flags that define how a page should be treated when it is unlocked 
sl@0: for writing */
sl@0: EXPORT_C void RSecureStorePagePool::WriteL(TPageRef aRef,const TAny* aPage,TPageChange aChange)
sl@0: 	{
sl@0: 	StorePagePool::WriteL(*this,aRef,aPage,aChange);
sl@0: 	}
sl@0: 
sl@0: /** Reads a specified page from the pool.
sl@0: 
sl@0: @param aRef Reference to page to read
sl@0: @param aPage On return, the page data */
sl@0: EXPORT_C void RSecureStorePagePool::ReadL(TPageRef aRef,TAny* aPage)
sl@0: 	{
sl@0: 	StorePagePool::ReadL(*this,aRef,aPage);
sl@0: 	}
sl@0: 
sl@0: /** Deletes a specified page.
sl@0: 
sl@0: @param aRef Reference to page to delete */
sl@0: EXPORT_C void RSecureStorePagePool::DoDeleteL(TPageRef aRef)
sl@0: 	{
sl@0: 	StorePagePool::DeleteL(*this,aRef);
sl@0: 	}
sl@0: 
sl@0: // Class StorePagePool
sl@0: // the implementation of the clever bits to share code between the secure and plain sotre page pools
sl@0: 
sl@0: const TInt KMaxPageIndex=15;
sl@0: 
sl@0: inline TInt PageSize(const CPBEncryptionBase* aKey)
sl@0: 	{
sl@0: 	return aKey ? aKey->MaxCiphertextLength(KPoolPageSize) : KPoolPageSize;
sl@0: 	}
sl@0: 
sl@0: inline TPageRef PageRef(TStreamId anId,TInt anIndex=0)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(anIndex>=0&&anIndex<=KMaxPageIndex,User::Invariant());
sl@0: 	return TPageRef((anId.Value()<<4)+anIndex);
sl@0: 	}
sl@0: inline TInt PageIndex(TPageRef aRef)
sl@0: 	{return aRef.Value()&0xf;}
sl@0: inline TStreamId StreamId(TPageRef aRef)
sl@0: 	{return TStreamId(aRef.Value()>>4);}
sl@0: inline TStreamPos PagePos(TInt anIndex,TInt aPageSize)
sl@0: 	{return TStreamPos(sizeof(TStreamId)+(anIndex-1)*aPageSize);}
sl@0: 
sl@0: void StorePagePool::PadL(RWriteStream& aStream,TInt aLength)
sl@0: //
sl@0: // zero-pad a stream
sl@0: //
sl@0: 	{
sl@0: 	TUint8 zero[KPoolPageSize];
sl@0: 	Mem::FillZ(zero,KPoolPageSize);
sl@0: 	while ((aLength-=KPoolPageSize)>0)
sl@0: 		aStream.WriteL(zero,KPoolPageSize);
sl@0: 	aStream.WriteL(zero,aLength+KPoolPageSize);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // Encrypt the page to the stream, padding out to full page size
sl@0: void StorePagePool::EncryptL(RWriteStream& aStream,const TAny* aPage,const CPBEncryptionBase& aKey)
sl@0: 	{
sl@0: 	REncryptStream encrypt;
sl@0: 	encrypt.OpenLC(aStream,aKey);
sl@0: 	encrypt.WriteL((const TUint8*)aPage,KPoolPageSize);
sl@0: 	encrypt.CommitL();
sl@0: 	CleanupStack::PopAndDestroy(&encrypt);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // Encrypt the page to the stream, padding out to full page size
sl@0: //
sl@0: void StorePagePool::EncryptNewL(RWriteStream& aStream,const TAny* aPage,const CPBEncryptionBase& aKey)
sl@0: 	{
sl@0: 	TStreamPos pos=aStream.Sink()->TellL(MStreamBuf::EWrite);		// remember the start of the data
sl@0: 	EncryptL(aStream,aPage,aKey);
sl@0: 	TInt pad=PageSize(&aKey)-(aStream.Sink()->TellL(MStreamBuf::EWrite)-pos);		// bytes written
sl@0: 	__ASSERT_DEBUG(pad>=0,Panic(EPageCipherTextOverrun));
sl@0: 	if (pad)
sl@0: 		PadL(aStream,pad);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // Encrypt the page to the stream, padding out to full page size
sl@0: //
sl@0: void StorePagePool::DecryptL(RReadStream& aStream,TAny* aPage,const CPBEncryptionBase& aKey)
sl@0: 	{
sl@0: 	RDecryptStream decrypt;
sl@0: 	decrypt.OpenLC(aStream,aKey);
sl@0: 	decrypt.ReadL((TUint8*)aPage,KPoolPageSize);
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	}
sl@0: 
sl@0: void StorePagePool::SeekL(MStreamBuf* aBuf,TInt aMark,TPageRef aRef,const CPBEncryptionBase* aKey)
sl@0: 	{
sl@0: 	TInt ix=PageIndex(aRef);
sl@0: 	if (ix)
sl@0: 		aBuf->SeekL(aMark,PagePos(ix,PageSize(aKey)));
sl@0: 	}
sl@0: 
sl@0: TPageRef StorePagePool::ExtendL(RStorePagePool& aPool,const TAny* aPage,TPageReclamation aReclamation,const CPBEncryptionBase* aKey)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aPool.iStore!=NULL,Panic(EPageNotOpen));
sl@0: 	TPageRef page;
sl@0: 	RStoreWriteStream out;
sl@0: 	if (aReclamation==EPageDeleteOnly)
sl@0: 		{	// non-reclaimable page
sl@0: 		page=PageRef(out.CreateLC(*aPool.iStore));
sl@0: 		}
sl@0: 	else if (aPool.iAvail!=KNullPageRef)
sl@0: 		{	// use free page
sl@0: 		page=aPool.iAvail;
sl@0: 		out.OpenLC(*aPool.iStore,StreamId(page));
sl@0: 		MStreamBuf* buf=out.Sink();
sl@0: 		SeekL(buf,MStreamBuf::ERead|MStreamBuf::EWrite,page,aKey);
sl@0: 		RReadStream in(buf);
sl@0: 		in>>aPool.iAvail;
sl@0: 		aPool.MarkDirty();
sl@0: 		}
sl@0: 	else
sl@0: 		{	// allocate new block, and create free list
sl@0: 		TStreamId id=out.CreateLC(*aPool.iStore);
sl@0: 		out<<aPool.iHead;			// block list
sl@0: 		const TInt pad=PageSize(aKey)-sizeof(TPageRef);
sl@0: 		page=KNullPageRef;	// free-list terminator
sl@0: 		for (TInt index=0;++index<KMaxPageIndex;)
sl@0: 			{
sl@0: 			out<<page;
sl@0: 			PadL(out,pad);
sl@0: 			page=PageRef(id,index);
sl@0: 			}
sl@0: 		aPool.MarkDirty();
sl@0: 		aPool.iHead=id;
sl@0: 		aPool.iAvail=page;
sl@0: 		page=PageRef(id,KMaxPageIndex);	// page is written at end
sl@0: 		}
sl@0: 	if (aKey)
sl@0: 		EncryptNewL(out,aPage,*aKey);
sl@0: 	else
sl@0: 		out.WriteL((const TUint8*)aPage,KPoolPageSize);
sl@0: 	out.CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	return page;
sl@0: 	}
sl@0: 
sl@0: void StorePagePool::WriteL(RStorePagePool& aPool,TPageRef aRef,const TAny* aPage,TPageChange aChange,const CPBEncryptionBase* aKey)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aChange>=EPageDirty,Panic(EPageChangeInvalid));
sl@0: 	__ASSERT_DEBUG(aPool.iStore!=NULL,Panic(EPageNotOpen));
sl@0: 	RStoreWriteStream out;
sl@0: 	if (aChange==EPageUpdate)
sl@0: 		{
sl@0: 		__ASSERT_DEBUG(PageIndex(aRef)==0,Panic(EPageChangeInvalid));
sl@0: 		out.ReplaceLC(*aPool.iStore,StreamId(aRef));
sl@0: 		if (aKey)
sl@0: 			EncryptNewL(out,aPage,*aKey);
sl@0: 		else
sl@0: 			out.WriteL((const TUint8*)aPage,KPoolPageSize);
sl@0: 		}
sl@0: 	else
sl@0: 		{	// re-write the page, no padding req'd
sl@0: 		out.OpenLC(*aPool.iStore,StreamId(aRef));
sl@0: 		SeekL(out.Sink(),MStreamBuf::EWrite,aRef,aKey);
sl@0: 		if (aKey)
sl@0: 			EncryptL(out,aPage,*aKey);
sl@0: 		else
sl@0: 			out.WriteL((const TUint8*)aPage,KPoolPageSize);
sl@0: 		}
sl@0: 	out.CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	}
sl@0: 
sl@0: void StorePagePool::ReadL(RStorePagePool& aPool,TPageRef aRef,TAny* aPage,const CPBEncryptionBase* aKey)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aPool.iStore!=NULL,Panic(EPageNotOpen));
sl@0: 	RStoreReadStream in;
sl@0: 	in.OpenLC(*aPool.iStore,StreamId(aRef));
sl@0: 	SeekL(in.Source(),MStreamBuf::ERead,aRef,aKey);
sl@0: 	if (aKey)
sl@0: 		DecryptL(in,aPage,*aKey);
sl@0: 	else
sl@0: 		in.ReadL((TUint8*)aPage,KPoolPageSize);
sl@0: 	CleanupStack::PopAndDestroy();	// in
sl@0: 	}
sl@0: 
sl@0: void StorePagePool::DeleteL(RStorePagePool& aPool,TPageRef aRef,const CPBEncryptionBase* aKey)
sl@0: 	{
sl@0: 	aPool.CacheDeleteL(aRef);
sl@0: 	__ASSERT_DEBUG(aPool.iStore!=NULL,Panic(EPageNotOpen));
sl@0: 	if (PageIndex(aRef)==0)
sl@0: 		{	//non-reclaimable
sl@0: 		aPool.iStore->DeleteL(StreamId(aRef));
sl@0: 		return;
sl@0: 		}
sl@0: 	// add to free list
sl@0: 	RStoreWriteStream out;
sl@0: 	out.OpenLC(*aPool.iStore,StreamId(aRef));
sl@0: 	SeekL(out.Sink(),MStreamBuf::EWrite,aRef,aKey);
sl@0: 	out<<aPool.iAvail;
sl@0: 	out.CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	aPool.iAvail=aRef;
sl@0: 	aPool.MarkDirty();
sl@0: 	}