1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/store/UPAGE/UP_STOR.CPP Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,402 @@
1.4 +// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#include "UP_STD.H"
1.20 +
1.21 +#include <pbe.h>
1.22 +
1.23 +EXPORT_C void TStorePagePoolToken::ExternalizeL(RWriteStream& aStream) const
1.24 +/** Externalises a TStorePagePoolToken object to a stream.
1.25 +
1.26 +@param aStream Stream to which the object should be externalised */
1.27 + {
1.28 + aStream<<iHead;
1.29 + aStream<<iAvail;
1.30 + }
1.31 +
1.32 +EXPORT_C void TStorePagePoolToken::InternalizeL(RReadStream& aStream)
1.33 +/** Internalises a TStorePagePoolToken object from a stream.
1.34 +
1.35 +@param aStream Stream from which the object should be internalised */
1.36 + {
1.37 + aStream>>iHead;
1.38 + aStream>>iAvail;
1.39 + }
1.40 +
1.41 +// Class RStorePagePool
1.42 +
1.43 +EXPORT_C RStorePagePool::RStorePagePool()
1.44 + : iStore(NULL)
1.45 +/** Default constructor. */
1.46 + {}
1.47 +
1.48 +EXPORT_C RStorePagePool::RStorePagePool(CPageCache& aCache)
1.49 + : TCachePagePool(aCache),iStore(NULL)
1.50 +/** Constructor with a page cache for the pool.
1.51 +
1.52 +@param aCache Page cache for the pool */
1.53 + {}
1.54 +
1.55 +EXPORT_C RStorePagePool::RStorePagePool(CStreamStore& aStore)
1.56 +/** Constructor with a stream store to use for the pool.
1.57 +
1.58 +@param aStore Stream store to use for the pool */
1.59 + {
1.60 + Create(aStore);
1.61 + }
1.62 +
1.63 +EXPORT_C RStorePagePool::RStorePagePool(CStreamStore& aStore,const TStorePagePoolToken& aToken)
1.64 +/** Constructor with a stream store and settings to use for the pool.
1.65 +
1.66 +@param aStore Stream store to use for the pool
1.67 +@param aToken Stream store pool settings */
1.68 + {
1.69 + Open(aStore,aToken);
1.70 + }
1.71 +
1.72 +EXPORT_C void RStorePagePool::Create(CStreamStore& aStore)
1.73 +/** Creates a new pool.
1.74 +
1.75 +@param aStore Stream store to use for the pool */
1.76 + {
1.77 + iStore=&aStore;
1.78 + iHead=KNullStreamId;
1.79 + iAvail=KNullPageRef;
1.80 + iDirty=EFalse;
1.81 + }
1.82 +
1.83 +EXPORT_C void RStorePagePool::Open(CStreamStore& aStore,const TStorePagePoolToken& aToken)
1.84 +/** Opens an existing pool.
1.85 +
1.86 +@param aStore Stream store for the pool
1.87 +@param aToken Pool settings */
1.88 + {
1.89 + iStore=&aStore;
1.90 + iHead=aToken.iHead;
1.91 + iAvail=aToken.iAvail;
1.92 + iDirty=EFalse;
1.93 + }
1.94 +
1.95 +EXPORT_C TStorePagePoolToken RStorePagePool::Token() const
1.96 +/** Gets an object that encapsulates the page pool settings.
1.97 +
1.98 +That object can then be used to externalise the settings.
1.99 +
1.100 +@return Encapsulates the page pool settings */
1.101 + {
1.102 + return TStorePagePoolToken(iHead,iAvail);
1.103 + }
1.104 +
1.105 +EXPORT_C void RStorePagePool::Close()
1.106 +/** Flushes and purges the page cache and stops using the stream store. */
1.107 + {
1.108 + TCachePagePool::Flush();
1.109 + Release();
1.110 + }
1.111 +
1.112 +EXPORT_C TBool RStorePagePool::ReclaimL()
1.113 +/** Deletes the first stream that stores reclaimable pages in the store.
1.114 +
1.115 +@return True if there are remaining streams (pages), false if there are no
1.116 +more streams */
1.117 + {
1.118 + __ASSERT_DEBUG(iStore!=NULL,Panic(EPageNotOpen));
1.119 + __ASSERT_ALWAYS(iAvail==KNullPageRef,Panic(EPageReclaimAvailable));
1.120 + if (iHead!=KNullStreamId)
1.121 + {
1.122 + RStoreReadStream out;
1.123 + out.OpenLC(*iStore,iHead);
1.124 + TStreamId next;
1.125 + out>>next;
1.126 + CleanupStack::PopAndDestroy();
1.127 + iStore->DeleteL(iHead);
1.128 + iHead=next;
1.129 + MarkDirty();
1.130 + if (next!=KNullStreamId)
1.131 + return ETrue;
1.132 + }
1.133 + return EFalse;
1.134 + }
1.135 +
1.136 +EXPORT_C void RStorePagePool::ReclaimAllL()
1.137 +/** Deletes all streams in the store. */
1.138 + {
1.139 + while (ReclaimL())
1.140 + ;
1.141 + }
1.142 +
1.143 +EXPORT_C TPageRef RStorePagePool::ExtendL(const TAny* aPage,TPageReclamation aReclamation)
1.144 +//
1.145 +// Create a new page.
1.146 +//
1.147 + {
1.148 + return StorePagePool::ExtendL(*this,aPage,aReclamation);
1.149 + }
1.150 +
1.151 +EXPORT_C void RStorePagePool::WriteL(TPageRef aRef,const TAny* aPage,TPageChange aChange)
1.152 +//
1.153 +// Write a page to the store.
1.154 +//
1.155 + {
1.156 + StorePagePool::WriteL(*this,aRef,aPage,aChange);
1.157 + }
1.158 +
1.159 +EXPORT_C void RStorePagePool::ReadL(TPageRef aRef,TAny* aPage)
1.160 +//
1.161 +// Read from the store into a page.
1.162 +//
1.163 + {
1.164 + StorePagePool::ReadL(*this,aRef,aPage);
1.165 + }
1.166 +
1.167 +EXPORT_C void RStorePagePool::DoDeleteL(TPageRef aRef)
1.168 +//
1.169 +// Delete from store.
1.170 +//
1.171 + {
1.172 + StorePagePool::DeleteL(*this,aRef);
1.173 + }
1.174 +
1.175 +// Class RSecureStorePagePool
1.176 +
1.177 +
1.178 +
1.179 +EXPORT_C RSecureStorePagePool::RSecureStorePagePool(const CPBEncryptSet& aKey)
1.180 + : iKey(aKey)
1.181 + {}
1.182 +
1.183 +EXPORT_C RSecureStorePagePool::RSecureStorePagePool(CPageCache& aCache, const CPBEncryptSet& aKey)
1.184 + : RStorePagePool(aCache),
1.185 + iKey(aKey)
1.186 + {}
1.187 +
1.188 +/** Adds a new page to the pool.
1.189 +
1.190 +@param aPage Data for the page
1.191 +@param aReclamation Flags that define how allocated pages can be reclaimed
1.192 +@return Reference to newly created page */
1.193 +EXPORT_C TPageRef RSecureStorePagePool::ExtendL(const TAny* aPage,TPageReclamation aReclamation)
1.194 + {
1.195 + return StorePagePool::ExtendL(*this,aPage,aReclamation);
1.196 + }
1.197 +
1.198 +/** Writes data to a page in the pool.
1.199 +
1.200 +@param aRef Reference to the page to which to write
1.201 +@param aPage Data to write
1.202 +@param aChange Flags that define how a page should be treated when it is unlocked
1.203 +for writing */
1.204 +EXPORT_C void RSecureStorePagePool::WriteL(TPageRef aRef,const TAny* aPage,TPageChange aChange)
1.205 + {
1.206 + StorePagePool::WriteL(*this,aRef,aPage,aChange);
1.207 + }
1.208 +
1.209 +/** Reads a specified page from the pool.
1.210 +
1.211 +@param aRef Reference to page to read
1.212 +@param aPage On return, the page data */
1.213 +EXPORT_C void RSecureStorePagePool::ReadL(TPageRef aRef,TAny* aPage)
1.214 + {
1.215 + StorePagePool::ReadL(*this,aRef,aPage);
1.216 + }
1.217 +
1.218 +/** Deletes a specified page.
1.219 +
1.220 +@param aRef Reference to page to delete */
1.221 +EXPORT_C void RSecureStorePagePool::DoDeleteL(TPageRef aRef)
1.222 + {
1.223 + StorePagePool::DeleteL(*this,aRef);
1.224 + }
1.225 +
1.226 +// Class StorePagePool
1.227 +// the implementation of the clever bits to share code between the secure and plain sotre page pools
1.228 +
1.229 +const TInt KMaxPageIndex=15;
1.230 +
1.231 +inline TInt PageSize(const CPBEncryptionBase* aKey)
1.232 + {
1.233 + return aKey ? aKey->MaxCiphertextLength(KPoolPageSize) : KPoolPageSize;
1.234 + }
1.235 +
1.236 +inline TPageRef PageRef(TStreamId anId,TInt anIndex=0)
1.237 + {
1.238 + __ASSERT_DEBUG(anIndex>=0&&anIndex<=KMaxPageIndex,User::Invariant());
1.239 + return TPageRef((anId.Value()<<4)+anIndex);
1.240 + }
1.241 +inline TInt PageIndex(TPageRef aRef)
1.242 + {return aRef.Value()&0xf;}
1.243 +inline TStreamId StreamId(TPageRef aRef)
1.244 + {return TStreamId(aRef.Value()>>4);}
1.245 +inline TStreamPos PagePos(TInt anIndex,TInt aPageSize)
1.246 + {return TStreamPos(sizeof(TStreamId)+(anIndex-1)*aPageSize);}
1.247 +
1.248 +void StorePagePool::PadL(RWriteStream& aStream,TInt aLength)
1.249 +//
1.250 +// zero-pad a stream
1.251 +//
1.252 + {
1.253 + TUint8 zero[KPoolPageSize];
1.254 + Mem::FillZ(zero,KPoolPageSize);
1.255 + while ((aLength-=KPoolPageSize)>0)
1.256 + aStream.WriteL(zero,KPoolPageSize);
1.257 + aStream.WriteL(zero,aLength+KPoolPageSize);
1.258 + }
1.259 +
1.260 +//
1.261 +// Encrypt the page to the stream, padding out to full page size
1.262 +void StorePagePool::EncryptL(RWriteStream& aStream,const TAny* aPage,const CPBEncryptionBase& aKey)
1.263 + {
1.264 + REncryptStream encrypt;
1.265 + encrypt.OpenLC(aStream,aKey);
1.266 + encrypt.WriteL((const TUint8*)aPage,KPoolPageSize);
1.267 + encrypt.CommitL();
1.268 + CleanupStack::PopAndDestroy(&encrypt);
1.269 + }
1.270 +
1.271 +//
1.272 +// Encrypt the page to the stream, padding out to full page size
1.273 +//
1.274 +void StorePagePool::EncryptNewL(RWriteStream& aStream,const TAny* aPage,const CPBEncryptionBase& aKey)
1.275 + {
1.276 + TStreamPos pos=aStream.Sink()->TellL(MStreamBuf::EWrite); // remember the start of the data
1.277 + EncryptL(aStream,aPage,aKey);
1.278 + TInt pad=PageSize(&aKey)-(aStream.Sink()->TellL(MStreamBuf::EWrite)-pos); // bytes written
1.279 + __ASSERT_DEBUG(pad>=0,Panic(EPageCipherTextOverrun));
1.280 + if (pad)
1.281 + PadL(aStream,pad);
1.282 + }
1.283 +
1.284 +//
1.285 +// Encrypt the page to the stream, padding out to full page size
1.286 +//
1.287 +void StorePagePool::DecryptL(RReadStream& aStream,TAny* aPage,const CPBEncryptionBase& aKey)
1.288 + {
1.289 + RDecryptStream decrypt;
1.290 + decrypt.OpenLC(aStream,aKey);
1.291 + decrypt.ReadL((TUint8*)aPage,KPoolPageSize);
1.292 + CleanupStack::PopAndDestroy();
1.293 + }
1.294 +
1.295 +void StorePagePool::SeekL(MStreamBuf* aBuf,TInt aMark,TPageRef aRef,const CPBEncryptionBase* aKey)
1.296 + {
1.297 + TInt ix=PageIndex(aRef);
1.298 + if (ix)
1.299 + aBuf->SeekL(aMark,PagePos(ix,PageSize(aKey)));
1.300 + }
1.301 +
1.302 +TPageRef StorePagePool::ExtendL(RStorePagePool& aPool,const TAny* aPage,TPageReclamation aReclamation,const CPBEncryptionBase* aKey)
1.303 + {
1.304 + __ASSERT_DEBUG(aPool.iStore!=NULL,Panic(EPageNotOpen));
1.305 + TPageRef page;
1.306 + RStoreWriteStream out;
1.307 + if (aReclamation==EPageDeleteOnly)
1.308 + { // non-reclaimable page
1.309 + page=PageRef(out.CreateLC(*aPool.iStore));
1.310 + }
1.311 + else if (aPool.iAvail!=KNullPageRef)
1.312 + { // use free page
1.313 + page=aPool.iAvail;
1.314 + out.OpenLC(*aPool.iStore,StreamId(page));
1.315 + MStreamBuf* buf=out.Sink();
1.316 + SeekL(buf,MStreamBuf::ERead|MStreamBuf::EWrite,page,aKey);
1.317 + RReadStream in(buf);
1.318 + in>>aPool.iAvail;
1.319 + aPool.MarkDirty();
1.320 + }
1.321 + else
1.322 + { // allocate new block, and create free list
1.323 + TStreamId id=out.CreateLC(*aPool.iStore);
1.324 + out<<aPool.iHead; // block list
1.325 + const TInt pad=PageSize(aKey)-sizeof(TPageRef);
1.326 + page=KNullPageRef; // free-list terminator
1.327 + for (TInt index=0;++index<KMaxPageIndex;)
1.328 + {
1.329 + out<<page;
1.330 + PadL(out,pad);
1.331 + page=PageRef(id,index);
1.332 + }
1.333 + aPool.MarkDirty();
1.334 + aPool.iHead=id;
1.335 + aPool.iAvail=page;
1.336 + page=PageRef(id,KMaxPageIndex); // page is written at end
1.337 + }
1.338 + if (aKey)
1.339 + EncryptNewL(out,aPage,*aKey);
1.340 + else
1.341 + out.WriteL((const TUint8*)aPage,KPoolPageSize);
1.342 + out.CommitL();
1.343 + CleanupStack::PopAndDestroy();
1.344 + return page;
1.345 + }
1.346 +
1.347 +void StorePagePool::WriteL(RStorePagePool& aPool,TPageRef aRef,const TAny* aPage,TPageChange aChange,const CPBEncryptionBase* aKey)
1.348 + {
1.349 + __ASSERT_DEBUG(aChange>=EPageDirty,Panic(EPageChangeInvalid));
1.350 + __ASSERT_DEBUG(aPool.iStore!=NULL,Panic(EPageNotOpen));
1.351 + RStoreWriteStream out;
1.352 + if (aChange==EPageUpdate)
1.353 + {
1.354 + __ASSERT_DEBUG(PageIndex(aRef)==0,Panic(EPageChangeInvalid));
1.355 + out.ReplaceLC(*aPool.iStore,StreamId(aRef));
1.356 + if (aKey)
1.357 + EncryptNewL(out,aPage,*aKey);
1.358 + else
1.359 + out.WriteL((const TUint8*)aPage,KPoolPageSize);
1.360 + }
1.361 + else
1.362 + { // re-write the page, no padding req'd
1.363 + out.OpenLC(*aPool.iStore,StreamId(aRef));
1.364 + SeekL(out.Sink(),MStreamBuf::EWrite,aRef,aKey);
1.365 + if (aKey)
1.366 + EncryptL(out,aPage,*aKey);
1.367 + else
1.368 + out.WriteL((const TUint8*)aPage,KPoolPageSize);
1.369 + }
1.370 + out.CommitL();
1.371 + CleanupStack::PopAndDestroy();
1.372 + }
1.373 +
1.374 +void StorePagePool::ReadL(RStorePagePool& aPool,TPageRef aRef,TAny* aPage,const CPBEncryptionBase* aKey)
1.375 + {
1.376 + __ASSERT_DEBUG(aPool.iStore!=NULL,Panic(EPageNotOpen));
1.377 + RStoreReadStream in;
1.378 + in.OpenLC(*aPool.iStore,StreamId(aRef));
1.379 + SeekL(in.Source(),MStreamBuf::ERead,aRef,aKey);
1.380 + if (aKey)
1.381 + DecryptL(in,aPage,*aKey);
1.382 + else
1.383 + in.ReadL((TUint8*)aPage,KPoolPageSize);
1.384 + CleanupStack::PopAndDestroy(); // in
1.385 + }
1.386 +
1.387 +void StorePagePool::DeleteL(RStorePagePool& aPool,TPageRef aRef,const CPBEncryptionBase* aKey)
1.388 + {
1.389 + aPool.CacheDeleteL(aRef);
1.390 + __ASSERT_DEBUG(aPool.iStore!=NULL,Panic(EPageNotOpen));
1.391 + if (PageIndex(aRef)==0)
1.392 + { //non-reclaimable
1.393 + aPool.iStore->DeleteL(StreamId(aRef));
1.394 + return;
1.395 + }
1.396 + // add to free list
1.397 + RStoreWriteStream out;
1.398 + out.OpenLC(*aPool.iStore,StreamId(aRef));
1.399 + SeekL(out.Sink(),MStreamBuf::EWrite,aRef,aKey);
1.400 + out<<aPool.iAvail;
1.401 + out.CommitL();
1.402 + CleanupStack::PopAndDestroy();
1.403 + aPool.iAvail=aRef;
1.404 + aPool.MarkDirty();
1.405 + }