1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/dbms/ustor/US_DBS.CPP Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,545 @@
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 "US_STD.H"
1.20 +
1.21 +// Class CDbStoreDatabase::CCompactor
1.22 +
1.23 +NONSHARABLE_CLASS(CDbStoreDatabase::CCompactor) : public CDbStoreDatabase::CStepper
1.24 + {
1.25 +public:
1.26 + static CCompactor* NewL(CDbDatabase::TUtility aType, CStreamStore& aStore,
1.27 + TInt& aReclaim, TInt& aStep);
1.28 + ~CCompactor();
1.29 +private:
1.30 + inline CCompactor(TInt& aReclaim);
1.31 +// from CStepper
1.32 + TInt StepL(TInt aStep);
1.33 +private:
1.34 + RStoreReclaim iReclaimer;
1.35 + TInt& iReclaim;
1.36 + };
1.37 +
1.38 +inline CDbStoreDatabase::CCompactor::CCompactor(TInt& aReclaim)
1.39 + :iReclaim(aReclaim)
1.40 + {
1.41 + }
1.42 +
1.43 +CDbStoreDatabase::CCompactor* CDbStoreDatabase::CCompactor::NewL(CDbDatabase::TUtility aType,
1.44 + CStreamStore& aStore,
1.45 + TInt& aReclaim,TInt& aStep)
1.46 + {
1.47 + CCompactor* self=new(ELeave) CCompactor(aReclaim);
1.48 + CleanupStack::PushL(self);
1.49 + if (aType==CDbDatabase::ECompact)
1.50 + self->iReclaimer.CompactL(aStore,aStep);
1.51 + else
1.52 + self->iReclaimer.OpenL(aStore,aStep);
1.53 + CleanupStack::Pop();
1.54 + return self;
1.55 + }
1.56 +
1.57 +CDbStoreDatabase::CCompactor::~CCompactor()
1.58 + {
1.59 + iReclaimer.Close();
1.60 + }
1.61 +
1.62 +//
1.63 +// Single step the compactor
1.64 +// We cannot deal with the "in use" scenario as we could end up locking out forever
1.65 +// that has to be left to clients using the RDbIncremental interface
1.66 +//
1.67 +TInt CDbStoreDatabase::CCompactor::StepL(TInt aStep)
1.68 + {
1.69 + iReclaimer.NextL(aStep);
1.70 + if (aStep==0)
1.71 + {
1.72 + iReclaim=iReclaimer.Available();
1.73 + iReclaimer.Close();
1.74 + }
1.75 + return aStep;
1.76 + }
1.77 +
1.78 +
1.79 +// Class CDbStoreDatabase
1.80 +
1.81 +EXPORT_C CDbStoreDatabase::CDbStoreDatabase()
1.82 + :iReclaim(KErrGeneral)
1.83 + {
1.84 + }
1.85 +
1.86 +//
1.87 +// Create a StoreDatabase object. This type shares the store
1.88 +//
1.89 +CDbStoreDatabase* CDbStoreDatabase::NewLC(CStreamStore* aStore)
1.90 + {
1.91 + __ASSERT(aStore);
1.92 + CDbStoreDatabase* self=new(ELeave) CDbStoreDatabase;
1.93 + CleanupStack::PushL(self);
1.94 + self->iStore=aStore;
1.95 + self->iSharedStore=1;
1.96 + return self;
1.97 + }
1.98 +
1.99 +
1.100 +//SYMBIAN_REMOVE_TRIVIAL_ENCRYPTION version of the method.
1.101 +CDbDatabase* CDbStoreDatabase::CreateL(CStreamStore* aStore,TStreamId& aStreamId)
1.102 + {
1.103 + CDbStoreDatabase* self=NewLC(aStore);
1.104 + aStreamId=self->ConstructL();
1.105 + CDbDatabase* db=self->InterfaceL();
1.106 + CleanupStack::Pop(); // self
1.107 + return db;
1.108 + }
1.109 +
1.110 +// SYMBIAN_REMOVE_TRIVIAL_ENCRYPTION version of the method.
1.111 +// Phase 2 construction for creating a new database
1.112 +// Initialise a new database object, creating the required persistent structure
1.113 +//
1.114 +EXPORT_C TStreamId CDbStoreDatabase::ConstructL()
1.115 + {
1.116 + __ASSERT(iStore); // this must have been provided by now
1.117 + iVersion=TUint8(EDbStoreVersion2);
1.118 + InitPagePoolL();
1.119 + iPagePool->Create(Store());
1.120 + iTokenId=Store().ExtendL();
1.121 + ReplaceTokenL(0);
1.122 + iSchemaId=Store().ExtendL();
1.123 + Schema().Loaded();
1.124 + ReplaceSchemaL();
1.125 + return iSchemaId;
1.126 + }
1.127 +
1.128 +// SYMBIAN_REMOVE_TRIVIAL_ENCRYPTION version of the method.
1.129 +// Open phase #2: Authenticate the client
1.130 +//
1.131 +EXPORT_C void CDbStoreDatabase::AuthenticateL()
1.132 + {
1.133 + if (!iPagePool)
1.134 + {
1.135 + // first client to open the database, so complete initialisation now
1.136 + InitPagePoolL();
1.137 + SchemaL();
1.138 + }
1.139 + }
1.140 +
1.141 +// SYMBIAN_REMOVE_TRIVIAL_ENCRYPTION version of the method.
1.142 +void CDbStoreDatabase::InitPagePoolL()
1.143 + {
1.144 + iPagePool = new(ELeave) RStorePagePool;
1.145 + }
1.146 +
1.147 +
1.148 +CDbSource* CDbStoreDatabase::OpenL(CStreamStore* aStore,TStreamId aStreamId)
1.149 + {
1.150 + CDbStoreDatabase* self=NewLC(aStore);
1.151 + self->RestoreL(aStreamId);
1.152 + CDbSource* src=self->SourceL();
1.153 + CleanupStack::Pop(); // self
1.154 + return src;
1.155 + }
1.156 +
1.157 +//
1.158 +// Phase 2 construction for opening a database
1.159 +// Client must still authenticate before it can be used
1.160 +//
1.161 +EXPORT_C void CDbStoreDatabase::RestoreL(TStreamId aStreamId)
1.162 + {
1.163 + __ASSERT(iStore); // this must have been provided by now
1.164 + iSchemaId=aStreamId;
1.165 +// read the databse header for encryption information
1.166 + RStoreReadStream strm;
1.167 + strm.OpenLC(Store(),aStreamId);
1.168 + ReadHeaderL(strm);
1.169 + CleanupStack::PopAndDestroy(); // strm
1.170 + }
1.171 +
1.172 +//
1.173 +// Load the root stream header (up to the security key)
1.174 +//
1.175 +void CDbStoreDatabase::ReadHeaderL(RReadStream& aStream)
1.176 + {
1.177 + TUid uid;
1.178 + aStream>>uid;
1.179 + if (uid!=KDbmsStoreDatabase)
1.180 + __LEAVE(KErrArgument);
1.181 + aStream>>iVersion;
1.182 + switch (iVersion)
1.183 + {
1.184 + case EDbStoreCompressed:
1.185 + aStream>>CompressionL();
1.186 + break;
1.187 + case EDbStoreVersion2:
1.188 + break;
1.189 + default:
1.190 + __LEAVE(KErrNotSupported);
1.191 + break;
1.192 + }
1.193 + }
1.194 +
1.195 +CDbStoreCompression& CDbStoreDatabase::CompressionL()
1.196 + {
1.197 + CDbStoreCompression* c=iCompression;
1.198 + if (!c)
1.199 + iFilter=iCompression=c=CDbStoreCompression::NewL();
1.200 + return *c;
1.201 + }
1.202 +
1.203 +EXPORT_C CDbStoreDatabase::~CDbStoreDatabase()
1.204 + {
1.205 + if (iPageCache)
1.206 + {
1.207 + iPagePool->Release();
1.208 + delete iPageCache;
1.209 + }
1.210 + delete iClusterCache;
1.211 + delete iPagePool;
1.212 + delete iCompression;
1.213 + if (!iSharedStore)
1.214 + delete iStore;
1.215 + }
1.216 +
1.217 +//
1.218 +// Validate the column set first
1.219 +//
1.220 +EXPORT_C CDbTableDef* CDbStoreDatabase::CreateTableL(const TDesC& aName,const CDbColSet& aColSet,const CDbKey* aPrimaryKey)
1.221 + {
1.222 + if (aPrimaryKey)
1.223 + __LEAVE(KErrNotSupported); // Store database does not support primary keys
1.224 + CDbStoreDef* def=CDbStoreDef::NewLC(aName,aColSet);
1.225 + def->SetTokenId(CDbStoreRecords::CreateL(ClusterCacheL()));
1.226 + CleanupStack::Pop();
1.227 + return def;
1.228 + }
1.229 +
1.230 +EXPORT_C CDbTableIndexDef* CDbStoreDatabase::CreateIndexL(const CDbTableDef& aTable,const TDesC& aName,const CDbKey& aKey)
1.231 + {
1.232 + CDbStoreIndexDef* def=CDbStoreIndexDef::NewLC(aName,aKey,aTable.Columns());
1.233 + def->SetTokenId(CDbStoreIndex::CreateL(*this,*def));
1.234 + CleanupStack::Pop(); // IndexDef
1.235 + return def;
1.236 + }
1.237 +
1.238 +//
1.239 +// Destroy the entire database...
1.240 +//
1.241 +EXPORT_C void CDbStoreDatabase::DestroyL()
1.242 + {
1.243 + iPagePool->Discard();
1.244 + iPagePool->ReclaimAllL(); // reclaim all page pool space
1.245 + iStore->DeleteL(iSchemaId);
1.246 + iStore->DeleteL(iTokenId);
1.247 + iStore->CommitL();
1.248 + }
1.249 +
1.250 +EXPORT_C CDbTable* CDbStoreDatabase::TableL(const CDbTableDef& aDef)
1.251 + {
1.252 + return new(ELeave) CDbStoreTable(*this,aDef);
1.253 + }
1.254 +
1.255 +//
1.256 +// load the schema for the database
1.257 +//
1.258 +EXPORT_C void CDbStoreDatabase::LoadSchemaL()
1.259 + {
1.260 + RDbStoreReadStream strm(*this);
1.261 + strm.OpenLC(Store(),iSchemaId);
1.262 + ReadHeaderL(strm);
1.263 + strm.FilterL(strm.EMixed,iSchemaId.Value());
1.264 + strm>>iTokenId;
1.265 + RDbTableSchema& schema=Schema();
1.266 + TCardinality tables;
1.267 + strm>>tables;
1.268 + for (TInt ii=tables;ii>0;--ii)
1.269 + schema.Add(CDbStoreDef::NewL(strm));
1.270 + CleanupStack::PopAndDestroy();
1.271 + strm.OpenLC(Store(),iTokenId);
1.272 + strm>>iFlags>>iPoolToken;
1.273 + iPagePool->Open(Store(),iPoolToken);
1.274 + CleanupStack::PopAndDestroy();
1.275 + }
1.276 +
1.277 +//
1.278 +// Re-write the schema stream
1.279 +//
1.280 +void CDbStoreDatabase::ReplaceSchemaL()
1.281 + {
1.282 + RDbStoreWriteStream out(*this);
1.283 + out.ReplaceLC(Store(),iSchemaId);
1.284 + out<<KDbmsStoreDatabase<<iVersion;
1.285 + switch (iVersion)
1.286 + {
1.287 + case EDbStoreCompressed:
1.288 + __ASSERT(iCompression);
1.289 + out<<*iCompression;
1.290 + break;
1.291 + case EDbStoreVersion2:
1.292 + break;
1.293 + default:
1.294 + __ASSERT(0);
1.295 + }
1.296 + out.FilterL(out.EMixed,iSchemaId.Value());
1.297 + out<<iTokenId;
1.298 + TSglQueIterC<CDbStoreDef> iter(Schema());
1.299 + TInt count=0;
1.300 + while (iter++)
1.301 + ++count;
1.302 + out<<TCardinality(count);
1.303 + iter.SetToFirst();
1.304 + for (const CDbStoreDef* def;(def=iter++)!=0;)
1.305 + out<<*def;
1.306 + out.CommitL();
1.307 + CleanupStack::PopAndDestroy();
1.308 + }
1.309 +
1.310 +//
1.311 +// Re-write the token stream, removing the mark
1.312 +//
1.313 +void CDbStoreDatabase::ReplaceTokenL(TUint aFlags)
1.314 + {
1.315 + RStoreWriteStream out;
1.316 + out.ReplaceLC(Store(),iTokenId);
1.317 + out<<TUint8(aFlags&EDamaged)<<iPagePool->Token();
1.318 + out.CommitL();
1.319 + CleanupStack::PopAndDestroy();
1.320 + }
1.321 +
1.322 +//
1.323 +// Return some database property
1.324 +//
1.325 +EXPORT_C TInt CDbStoreDatabase::Property(CDbDatabase::TProperty aProperty)
1.326 + {
1.327 + switch (aProperty)
1.328 + {
1.329 + case CDbDatabase::EIsDamaged:
1.330 + return iFlags&EDamaged ? 1 : 0;
1.331 + case CDbDatabase::ECompactable:
1.332 + return 1;
1.333 + default:
1.334 + return CDbTableDatabase::Property(aProperty);
1.335 + }
1.336 + }
1.337 +
1.338 +//
1.339 +// mark the database as dirty
1.340 +//
1.341 +void CDbStoreDatabase::MarkL()
1.342 + {
1.343 + if (!(iFlags&EModified))
1.344 + {
1.345 + RStoreWriteStream out;
1.346 + out.OpenLC(Store(),iTokenId);
1.347 + out.WriteUint8L(EDamaged); // mark as dirty
1.348 + iPoolToken.Touch();
1.349 + out<<iPoolToken;
1.350 + out.CommitL();
1.351 + CleanupStack::PopAndDestroy();
1.352 + iFlags|=EModified;
1.353 + }
1.354 + }
1.355 +
1.356 +//
1.357 +// Reset all cache buffers
1.358 +//
1.359 +EXPORT_C void CDbStoreDatabase::Idle()
1.360 + {
1.361 + if (iPageCache)
1.362 + {
1.363 + iPagePool->Purge();
1.364 + delete iPageCache;
1.365 + iPageCache=NULL;
1.366 + }
1.367 + if (iClusterCache)
1.368 + {
1.369 + delete iClusterCache;
1.370 + iClusterCache=NULL;
1.371 + }
1.372 + }
1.373 +
1.374 +//
1.375 +// Commit the store, and when all is well, clear the token
1.376 +//
1.377 +void CDbStoreDatabase::SynchStoreL(TDbLockType aLock)
1.378 + {
1.379 + if (iPageCache)
1.380 + iPagePool->FlushL();
1.381 + TUint newflags=iFlags&~EModified;
1.382 + if (aLock==EDbRecoveryLock)
1.383 + newflags&=~EDamaged;
1.384 + if (aLock==EDbRecoveryLock || iFlags&EModified)
1.385 + ReplaceTokenL(newflags);
1.386 + if (aLock>=EDbWriteLock || iSharedStore)
1.387 + {
1.388 + iStore->CommitL();
1.389 + iFlags=TUint8(newflags);
1.390 + iPoolToken=iPagePool->Token();
1.391 + }
1.392 + }
1.393 +
1.394 +//
1.395 +// An index has been successfully recovered, commit it
1.396 +//
1.397 +void CDbStoreDatabase::IndexRecoveredL()
1.398 + {
1.399 + SynchStoreL(EDbSchemaLock);
1.400 + }
1.401 +
1.402 +//
1.403 +// Ensure all data is in the store
1.404 +//
1.405 +EXPORT_C void CDbStoreDatabase::SynchL(TDbLockType aLock)
1.406 + {
1.407 + if (aLock==EDbSchemaLock)
1.408 + ReplaceSchemaL();
1.409 + if (iClusterCache)
1.410 + iClusterCache->FlushL();
1.411 + SynchStoreL(aLock);
1.412 + }
1.413 +
1.414 +//
1.415 +// Unwind the store, throw out changes, etc
1.416 +//
1.417 +EXPORT_C void CDbStoreDatabase::Revert(TDbLockType aLock)
1.418 + {
1.419 + if (aLock>=EDbWriteLock)
1.420 + {
1.421 + if (iClusterCache)
1.422 + iClusterCache->Discard();
1.423 + if (iPageCache)
1.424 + iPagePool->Purge();
1.425 + if (iFlags&EModified)
1.426 + iFlags|=EDamaged;
1.427 + iPagePool->Open(Store(),iPoolToken); // reset the page pool
1.428 + }
1.429 + else if (!iSharedStore) // don't touch the store if not shared
1.430 + return;
1.431 + iStore->Revert();
1.432 + }
1.433 +
1.434 +//
1.435 +// Ensure we have a cluster cache and return it
1.436 +//
1.437 +CClusterCache& CDbStoreDatabase::ClusterCacheL()
1.438 + {
1.439 + CClusterCache* cache=iClusterCache;
1.440 + if (!cache)
1.441 + iClusterCache=cache=CClusterCache::NewL(*this);
1.442 + return *cache;
1.443 + }
1.444 +
1.445 +//
1.446 +// Ensure we have a page cache and return the pool
1.447 +//
1.448 +MPagePool& CDbStoreDatabase::PagePoolL()
1.449 + {
1.450 + if (!iPageCache)
1.451 + {
1.452 + iPageCache=CPageCache::NewL(EPageCachePages);
1.453 + iPagePool->Set(*iPageCache);
1.454 + }
1.455 + return *iPagePool;
1.456 + }
1.457 +
1.458 +//
1.459 +// Create an incremental object that compacts the store
1.460 +//
1.461 +EXPORT_C CDbTableDatabase::CStepper* CDbStoreDatabase::UtilityL(CDbDatabase::TUtility aType,TInt& aStep)
1.462 + {
1.463 + switch (aType)
1.464 + {
1.465 + case CDbDatabase::EStats:
1.466 + case CDbDatabase::ECompact:
1.467 + return CCompactor::NewL(aType,Store(),iReclaim,aStep);
1.468 + case CDbDatabase::ERecover:
1.469 + return RecoverL(aStep);
1.470 + default:
1.471 + return CDbTableDatabase::UtilityL(aType,aStep);
1.472 + }
1.473 + }
1.474 +
1.475 +//
1.476 +// Create an incremental object to destroy a table
1.477 +//
1.478 +EXPORT_C CDbTableDatabase::CStepper* CDbStoreDatabase::RecordDiscarderL(const CDbTableDef& aTable,TInt& aStep)
1.479 + {
1.480 + CDbStoreTable::CDiscarder* discarder=new(ELeave) CDbStoreTable::CDiscarder;
1.481 + CleanupStack::PushL(discarder);
1.482 + aStep=discarder->OpenL((CDbStoreTable*)TableL(aTable));
1.483 + CleanupStack::Pop();
1.484 + return discarder;
1.485 + }
1.486 +
1.487 +//
1.488 +// Create an incremental object to destroy an index
1.489 +//
1.490 +EXPORT_C CDbTableDatabase::CStepper* CDbStoreDatabase::IndexDiscarderL(const CDbTableDef& aTable,const CDbTableIndexDef& anIndex,TInt& aStep)
1.491 + {
1.492 + CDbStoreIndex::CDiscarder* discarder=new(ELeave) CDbStoreIndex::CDiscarder;
1.493 + CleanupStack::PushL(discarder);
1.494 + CDbStoreIndex* index=CDbStoreIndex::NewL(*this,(const CDbStoreIndexDef&)anIndex,aTable);
1.495 + aStep=discarder->Open(index);
1.496 + index->OpenL();
1.497 + CleanupStack::Pop();
1.498 + return discarder;
1.499 + }
1.500 +
1.501 +//
1.502 +// Provide a stepper to alter the table data
1.503 +// if no data to alter, return 0
1.504 +//
1.505 +EXPORT_C CDbTableDatabase::CStepper* CDbStoreDatabase::TableAlterL(CDbTableDef& aTable,const HDbColumnSet& aNewSet,TInt& aStep)
1.506 + {
1.507 + CDbStoreDef& def=STATIC_CAST(CDbStoreDef&,aTable);
1.508 +//
1.509 + aStep=CDbStoreRecords::CardinalityL(Store(),def);
1.510 + if (!aStep)
1.511 + return NULL; // no data to modify
1.512 +
1.513 +// check that all added columns are nullable
1.514 + HDbColumnSet::TIteratorC col=aNewSet.Begin();
1.515 + HDbColumnSet::TIteratorC end=aNewSet.End();
1.516 + do
1.517 + {
1.518 + if (col->iFlags&TDbColumnDef::EAdded && col->iAttributes&TDbCol::ENotNull)
1.519 + __LEAVE(KErrArgument); // added column is not nullable
1.520 + } while (++col<end);
1.521 +//
1.522 +// check to see if anything is being dropped or changed type
1.523 + col=aTable.Columns().Begin();
1.524 + end=aTable.Columns().End();
1.525 + while (!(col->iFlags&(TDbColumnDef::EDropped|TDbColumnDef::EChangedType|TDbColumnDef::EChangedLen)))
1.526 + {
1.527 + if (++col==end)
1.528 + { // no changes which affect layout, so no work required
1.529 + aStep=0;
1.530 + return NULL;
1.531 + }
1.532 + }
1.533 +// work required
1.534 + CDbStoreTable::CAlter* alter=new(ELeave) CDbStoreTable::CAlter;
1.535 + CleanupStack::PushL(alter);
1.536 + alter->OpenL((CDbStoreTable*)TableL(def),aNewSet);
1.537 + CleanupStack::Pop();
1.538 + return alter;
1.539 + }
1.540 +
1.541 +EXPORT_C void CDbStoreDatabase::Reserved_1()
1.542 + {
1.543 + }
1.544 +
1.545 +EXPORT_C void CDbStoreDatabase::Reserved_2()
1.546 + {
1.547 + }
1.548 +