sl@0: // Copyright (c) 2004-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: #ifndef CACHEMGR_H
sl@0: #define CACHEMGR_H
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include "log.h"
sl@0: #include "panic.h"
sl@0: #include "srvdefs.h"
sl@0: #include <f32file.h>
sl@0: 
sl@0: _LIT(KCacheMgrIniFile, "centrep.ini");
sl@0: 
sl@0: #ifndef DEFAULT_CENTREP_CACHE_SIZE
sl@0: 	/** 
sl@0: 	The default size of the coarse-grained cache, used when there is no .ini setting defined.
sl@0: 	The default value is approximately the size needed to cache everything during device boot-up
sl@0: 	@internalComponent
sl@0: 	*/
sl@0: 	#define DEFAULT_CENTREP_CACHE_SIZE 200000
sl@0: #else
sl@0: 	#if DEFAULT_CENTREP_CACHE_SIZE <= 0
sl@0: 		#error "DEFAULT_CENTREP_CACHE_SIZE macro value must be greater than 0"
sl@0: 	#endif
sl@0: #endif
sl@0: 
sl@0: /** 
sl@0: The default size of the coarse-grained cache. 
sl@0: @internalComponent
sl@0: */
sl@0: const TInt KDefaultCacheSize=DEFAULT_CENTREP_CACHE_SIZE;
sl@0: 
sl@0: /** 
sl@0: The special cache size value used for enabling the cache without changing the current cache size value.
sl@0: @internalComponent
sl@0: */
sl@0: const TInt KInvalidCacheSize	= -1;
sl@0: 
sl@0: #ifndef DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT
sl@0: 	/** 
sl@0: 	The default timeout value of the coarse-grained cache, used when there is no .ini setting defined.
sl@0: 	The default value is approximately the timeout needed to keep everything in cache during device boot-up
sl@0: 	@internalComponent
sl@0: 	*/
sl@0: 	// If this value will need to be changed, please ensure the KTimeoutToSizeConversion is adjusted accordingly.
sl@0: 	#define DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT 120000000
sl@0: #else
sl@0: 	#if DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT <= 0
sl@0: 		#error "DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT macro value must be greater than 0"
sl@0: 	#endif
sl@0: #endif
sl@0: 
sl@0: /** 
sl@0: The default timeout value (in microseconds) for the coarse-grained cache repository eviction. 
sl@0: @internalComponent
sl@0: */
sl@0: const TInt KDefaultEvictionTimeout=DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT;
sl@0: 
sl@0: /** 
sl@0: The constant used in forced evicition sorting algorithm for converting microsecond-based timeout 
sl@0: values to an intermediary unit compatible with byte-based size values.
sl@0: @internalComponent
sl@0: */
sl@0: const TInt KTimeoutToSizeConversion=DEFAULT_CENTREP_CACHE_EVICTION_TIMEOUT/(100000*24);
sl@0: 
sl@0: /** 
sl@0: The special timeout value used for enabling the cache without changing the current timeout value.
sl@0: @internalComponent
sl@0: */
sl@0: const TInt KInvalidEvictionTimeout=-1;
sl@0: 
sl@0: 
sl@0: class CSharedRepository;
sl@0: 
sl@0: /**
sl@0: @internalTechnology
sl@0: This is the class which manages Coarse-Grained cache operations including delayed-unloading of
sl@0: repositories and forced eviction of repositories under OOM conditions.
sl@0: */
sl@0: class CRepositoryCacheManager : public CTimer
sl@0: 	{
sl@0: 	friend class TRepositoryCacheManagerTester;
sl@0: public:
sl@0: 	static CRepositoryCacheManager* NewLC(RFs& aFs);
sl@0: 	~CRepositoryCacheManager();
sl@0: 	void ConstructL(RFs& aFs);
sl@0: 	
sl@0: 	void EnableCache();
sl@0: 	void DisableCache(TBool aFullFlush = EFalse);
sl@0: 	void EnableCache(TInt aDefaultTimeout, TInt aCacheSize);
sl@0: 	
sl@0: 	inline TBool Enabled();
sl@0: 
sl@0: 	TBool StartEviction(CSharedRepository*& aRepository);
sl@0: 	
sl@0: 	void RemoveIdleRepository(CSharedRepository* aRepository);	
sl@0: 	void FlushCache(TBool aFullFlush = ETrue);
sl@0: 
sl@0: protected:
sl@0: 	/**
sl@0: 	@internalTechnology
sl@0: 	This is the class/structure which keeps eviction-related cache data 
sl@0: 	*/
sl@0: 	class TRepositoryCacheInfo
sl@0: 		{
sl@0: 	public:
sl@0: 		TTime iCacheTime;
sl@0: 		CSharedRepository* iSharedRepository;
sl@0: 		};
sl@0: 
sl@0: 	void RunL();
sl@0: 		
sl@0: private:
sl@0: 	inline CRepositoryCacheManager(); 
sl@0: 
sl@0: 	void Evict(TInt aIdleRepIndex);
sl@0: 	void RescheduleTimer(const TTime& aTimeInUTC);
sl@0: 	
sl@0: 	static TInt ForcedEvictionSortOrder(const TRepositoryCacheInfo &aRepository1, const TRepositoryCacheInfo &aRepository2);
sl@0: 	static TInt TimerEvictionSortOrder(const TRepositoryCacheInfo &aRepository1, const TRepositoryCacheInfo &aRepository2);	
sl@0: 	
sl@0: private:
sl@0: 	TBool iEnabled; 
sl@0: 	TInt  iTotalCacheUsage; 
sl@0: 	RArray<TRepositoryCacheInfo> iIdleRepositories;
sl@0: 	TTimeIntervalMicroSeconds32 iDefaultTimeout;
sl@0: 	TInt  iCacheSize;
sl@0: 	};
sl@0: 
sl@0: #include "cachemgr.inl"
sl@0: 
sl@0: #endif // CACHEMGR_H