1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/centralrepository/cenrepsrv/cachemgr.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,145 @@
1.4 +// Copyright (c) 2004-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 +#ifndef CACHEMGR_H
1.20 +#define CACHEMGR_H
1.21 +
1.22 +#include <e32base.h>
1.23 +#include "log.h"
1.24 +#include "panic.h"
1.25 +#include "srvdefs.h"
1.26 +#include <f32file.h>
1.27 +
1.28 +_LIT(KCacheMgrIniFile, "centrep.ini");
1.29 +
1.30 +#ifndef DEFAULT_CENTREP_CACHE_SIZE
1.31 + /**
1.32 + The default size of the coarse-grained cache, used when there is no .ini setting defined.
1.33 + The default value is approximately the size needed to cache everything during device boot-up
1.34 + @internalComponent
1.35 + */
1.36 + #define DEFAULT_CENTREP_CACHE_SIZE 200000
1.37 +#else
1.38 + #if DEFAULT_CENTREP_CACHE_SIZE <= 0
1.39 + #error "DEFAULT_CENTREP_CACHE_SIZE macro value must be greater than 0"
1.40 + #endif
1.41 +#endif
1.42 +
1.43 +/**
1.44 +The default size of the coarse-grained cache.
1.45 +@internalComponent
1.46 +*/
1.47 +const TInt KDefaultCacheSize=DEFAULT_CENTREP_CACHE_SIZE;
1.48 +
1.49 +/**
1.50 +The special cache size value used for enabling the cache without changing the current cache size value.
1.51 +@internalComponent
1.52 +*/
1.53 +const TInt KInvalidCacheSize = -1;
1.54 +
1.55 +#ifndef DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT
1.56 + /**
1.57 + The default timeout value of the coarse-grained cache, used when there is no .ini setting defined.
1.58 + The default value is approximately the timeout needed to keep everything in cache during device boot-up
1.59 + @internalComponent
1.60 + */
1.61 + // If this value will need to be changed, please ensure the KTimeoutToSizeConversion is adjusted accordingly.
1.62 + #define DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT 120000000
1.63 +#else
1.64 + #if DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT <= 0
1.65 + #error "DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT macro value must be greater than 0"
1.66 + #endif
1.67 +#endif
1.68 +
1.69 +/**
1.70 +The default timeout value (in microseconds) for the coarse-grained cache repository eviction.
1.71 +@internalComponent
1.72 +*/
1.73 +const TInt KDefaultEvictionTimeout=DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT;
1.74 +
1.75 +/**
1.76 +The constant used in forced evicition sorting algorithm for converting microsecond-based timeout
1.77 +values to an intermediary unit compatible with byte-based size values.
1.78 +@internalComponent
1.79 +*/
1.80 +const TInt KTimeoutToSizeConversion=DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT/(100000*24);
1.81 +
1.82 +/**
1.83 +The special timeout value used for enabling the cache without changing the current timeout value.
1.84 +@internalComponent
1.85 +*/
1.86 +const TInt KInvalidEvictionTimeout=-1;
1.87 +
1.88 +
1.89 +class CSharedRepository;
1.90 +
1.91 +/**
1.92 +@internalTechnology
1.93 +This is the class which manages Coarse-Grained cache operations including delayed-unloading of
1.94 +repositories and forced eviction of repositories under OOM conditions.
1.95 +*/
1.96 +class CRepositoryCacheManager : public CTimer
1.97 + {
1.98 + friend class TRepositoryCacheManagerTester;
1.99 +public:
1.100 + static CRepositoryCacheManager* NewLC(RFs& aFs);
1.101 + ~CRepositoryCacheManager();
1.102 + void ConstructL(RFs& aFs);
1.103 +
1.104 + void EnableCache();
1.105 + void DisableCache(TBool aFullFlush = EFalse);
1.106 + void EnableCache(TInt aDefaultTimeout, TInt aCacheSize);
1.107 +
1.108 + inline TBool Enabled();
1.109 +
1.110 + TBool StartEviction(CSharedRepository*& aRepository);
1.111 +
1.112 + void RemoveIdleRepository(CSharedRepository* aRepository);
1.113 + void FlushCache(TBool aFullFlush = ETrue);
1.114 +
1.115 +protected:
1.116 + /**
1.117 + @internalTechnology
1.118 + This is the class/structure which keeps eviction-related cache data
1.119 + */
1.120 + class TRepositoryCacheInfo
1.121 + {
1.122 + public:
1.123 + TTime iCacheTime;
1.124 + CSharedRepository* iSharedRepository;
1.125 + };
1.126 +
1.127 + void RunL();
1.128 +
1.129 +private:
1.130 + inline CRepositoryCacheManager();
1.131 +
1.132 + void Evict(TInt aIdleRepIndex);
1.133 + void RescheduleTimer(const TTime& aTimeInUTC);
1.134 +
1.135 + static TInt ForcedEvictionSortOrder(const TRepositoryCacheInfo &aRepository1, const TRepositoryCacheInfo &aRepository2);
1.136 + static TInt TimerEvictionSortOrder(const TRepositoryCacheInfo &aRepository1, const TRepositoryCacheInfo &aRepository2);
1.137 +
1.138 +private:
1.139 + TBool iEnabled;
1.140 + TInt iTotalCacheUsage;
1.141 + RArray<TRepositoryCacheInfo> iIdleRepositories;
1.142 + TTimeIntervalMicroSeconds32 iDefaultTimeout;
1.143 + TInt iCacheSize;
1.144 + };
1.145 +
1.146 +#include "cachemgr.inl"
1.147 +
1.148 +#endif // CACHEMGR_H