// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// f32\sfat\sl_dir_cache.cpp

//

//

//!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

//!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

//!!

//!! WARNING!! DO NOT edit this file !! '\sfat' component is obsolete and is not being used. '\sfat32'replaces it

//!!

//!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

//!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

#include "sl_std.h"

#include "sl_dir_cache.h"

//======================================================================

TDynamicDirCachePage::~TDynamicDirCachePage()

    {

    }

/**

The static cache page creation function.

Cache page objects are not supposed to be created on the stack, so this factory function is required.

*/

TDynamicDirCachePage* TDynamicDirCachePage::NewL(CDynamicDirCache* aOwnerCache, TInt64 aStartMedPos, TUint8* aStartRamAddr)

    {

    return new(ELeave) TDynamicDirCachePage(aOwnerCache, aStartMedPos, aStartRamAddr);

    }

/**

Cache page constructor.

@param  aOwnerCache pointer of the cache that owns this page

@param  aStartMedPos    the start address on the media that this page caches

@param  aStartRamAddr   the start address in the ram that this page content lives

*/

TDynamicDirCachePage::TDynamicDirCachePage(CDynamicDirCache* aOwnerCache, TInt64 aStartMedPos, TUint8* aStartRamAddr)

:iStartMedPos(aStartMedPos),

iStartRamAddr(aStartRamAddr),

iOwnerCache(aOwnerCache),

iValid(EFalse),

iLocked(EFalse)

    {

//  __PRINT3(_L("TDynamicDirCachePage::TDynamicDirCachePage(aStartMedPos=%lx, aStartRamAddr=0x%X, aPageSize=%u)"), aStartMedPos, aStartRamAddr, PageSizeInBytes());

    iType = EUnknown;

    }

/////////////////////////////// class CDynamicDirCache::TLookupEntry ///////////////////////////

/**

Required by RHashSet<TLookupEntry> to identify individual hash set entries.

@see    RHashSet

*/

TBool IdentityFunction(const TLookupEntry& aEntry1, const TLookupEntry& aEntry2)

    {

    // only check starting med pos for hash searching

    return aEntry1.iPos == aEntry2.iPos;

    }

/**

Required by RHashSet<TLookupEntry> to generate hash value.

@see    RHashSet

*/

TUint32 HashFunction(const TLookupEntry& aEntry)

    {

    return (DefaultHash::Integer(I64HIGH(aEntry.iPos)) + DefaultHash::Integer(I64LOW(aEntry.iPos)));

    }

/////////////////////////////// class CDynamicDirCache ///////////////////////////

CDynamicDirCache::~CDynamicDirCache()

    {

//  __PRINT(_L("CDynamicDirCache::~CDynamicDirCache()"));

    // we should never decommit locked pages

    while (!iLockedQ.IsEmpty())

        {

        TDynamicDirCachePage* page = iLockedQ.Last();

        DeQueue(page);      // remove from queue

        LookupTblRemove(page->StartPos());  // remove from lookuptable

        delete page;

        }

    ASSERT(iLockedQCount == 0);

    while (!iUnlockedQ.IsEmpty())

        {

        TDynamicDirCachePage* page = iUnlockedQ.Last();

        DeQueue(page);      // remove from queue

        LookupTblRemove(page->StartPos());  // remove from lookuptable

        DecommitPage(page); // inform cache client to decommit page memory

        delete page;

        }

    ASSERT(iUnlockedQCount == 0);

    delete iActivePage;

    ASSERT(iLookupTable.Count() == 0);

    iLookupTable.Close();

    if (iCacheMemoryClient)

        iCacheMemoryClient->Reset();

    }

/**

Constructor of CDynamicDirCache.

@param  aDrive  local drive interface to read/write media

@param  aMinPageNum the minimum page number for the cache, includes iActive page and locked pages.

@param  aMaxPageNum the maximum page number for the cache, includes iActive page, locked pages and unlocked pages.

@param  aPageSizeInBytesLog2    the log2 value of page size in bytes, assumes page size is always a power of two

*/

CDynamicDirCache::CDynamicDirCache(TFatDriveInterface& aDrive, TUint32 aMinPageNum, TUint32 aMaxPageNum, TUint32 aPageSizeInBytesLog2)

:iPageSizeLog2(aPageSizeInBytesLog2),

iMinSizeInPages(aMinPageNum),

iMaxSizeInPages(aMaxPageNum),

iDrive(aDrive),

iLockedQ(_FOFF(TDynamicDirCachePage, iLink)),

iUnlockedQ(_FOFF(TDynamicDirCachePage, iLink)),

iLockedQCount(0),

iUnlockedQCount(0),

iHashFunction(HashFunction),

iIdentityFunction(IdentityFunction),

iLookupTable(iHashFunction, iIdentityFunction)

    {

    iPageSizeInBytes = 1 << aPageSizeInBytesLog2;

    iCacheDisabled = EFalse;

    iMinCacheSizeInBytes = aMinPageNum << aPageSizeInBytesLog2;

    iMaxCacheSizeInBytes = aMaxPageNum << aPageSizeInBytesLog2;

    ASSERT(iPageSizeInBytes && iPageSizeInBytes <= iMinCacheSizeInBytes && iMinCacheSizeInBytes <= iMaxCacheSizeInBytes);

    // initial value, will be reset from outside

    iCacheBasePos = 0;

    }

/**

Second phase constructor of CDynamicDirCache.

@param  aClientName the identification of cache memeory client this cache connects

*/

void CDynamicDirCache::ConstructL(const TDesC& aClientName)

    {

//    __PRINT3(_L("CDynamicDirCache::ConstructL(Min=%u, Max=%u, page=%u)"), iMinCacheSizeInBytes, iMaxCacheSizeInBytes, iPageSizeInBytes);

    CCacheMemoryManager* manager = CCacheMemoryManagerFactory::CacheMemoryManager();

    if (manager)

        {

        // client will register itself onto cache memory manager when created

        // note this operation may leave under OOM condition

        iCacheMemoryClient = manager->ConnectClientL(aClientName, iMinSizeInPages * PageSizeInSegs(), iMaxSizeInPages * PageSizeInSegs());

        }

    else

        {

        User::Leave(KErrNotSupported);

        }

    ASSERT(iCacheMemoryClient);

    if (!iCacheMemoryClient)

        {

        User::Leave(KErrNoMemory);

        }

    // reserve active page

    iActivePage = AllocateAndLockNewPageL(0);

    ASSERT(iActivePage);

    if (!iActivePage)

        {

        User::Leave(KErrNoMemory);

        }

    iActivePage->SetPageType(TDynamicDirCachePage::EActivePage);

    }

/**

Static factory function of CDynamicDirCache

*/

CDynamicDirCache* CDynamicDirCache::NewL(TFatDriveInterface& aDrive, TUint32 aMinPageNum, TUint32 aMaxPageNum, TUint32 aPageSizeLog2, const TDesC& aClientName)

    {

//    __PRINT3(_L("CDynamicDirCache::NewL(MinPageNum=%u, MaxPageNum=%u, page=%u)"), aMinPageNum, aMaxPageNum, 1<<aPageSizeLog2);

    CDynamicDirCache* pSelf = new (ELeave) CDynamicDirCache(aDrive, aMinPageNum, aMaxPageNum, aPageSizeLog2);

    CleanupStack::PushL(pSelf);

    pSelf->ConstructL(aClientName);

    CleanupStack::Pop();

    return pSelf;

    }

/**

Insert an unlocked page into the last position of the locked queue, may squeeze the original last page into

the unlocked queue.

This function is used on last visited but 'unlocked' pages to avoid excessive lock/unlock calls to cache memory

manager as contiguous entry reading/writing often happens on the same page.

@param  aPage   the page to be inserted.

@pre    the page type of aPage should only be TDynamicDirCachePage::EUnknown

*/

void CDynamicDirCache::MakePageLastLocked(TDynamicDirCachePage* aPage)

    {

    // this function should not be called on active pages

    ASSERT(aPage->iType == TDynamicDirCachePage::EUnknown);

    if (iLockedQ.IsEmpty())

        {

        // if locked queue is empty, add it onto the locked queue directly

        AddFirstOntoQueue(aPage, TDynamicDirCachePage::ELocked);

        }

    else

        {

        // otherwise, we squeeze for the last position on locked queue

        while (iLockedQCount + 1 >= iMinSizeInPages)

            {

            TDynamicDirCachePage* last = iLockedQ.Last();

            DeQueue(last);

            UnlockPage(last);

            AddFirstOntoQueue(last, TDynamicDirCachePage::EUnlocked);

            }

        // iLockedQCount + 1 < iMinSizeInPages

        iLockedQ.AddLast(*aPage);

        aPage->SetPageType(TDynamicDirCachePage::ELocked);

        iLockedQCount++;

        }

    }

/**

Read data from a single page. If the page is not found or not valid anymore, read media onto iActive page

first.

@param  aPos    the starting position of the media address to be read.

@param  aLength the length of the content to be read.

@param  aDes    the descriptor to contain the content.

@pre    aLength should be no more than page size.

*/

void CDynamicDirCache::ReadDataFromSinglePageL(TInt64 aPos, TInt aLength, TDes8& aDes)

    {

    //-- the data section is in the cache page entirely, take data directly from the cache

    TDynamicDirCachePage* pPage = FindPageByPos(aPos);

    if (pPage)

        {

        // lock page before reading,

        if (LockPage(pPage) != NULL)

            {

            // read data

            aDes.Copy(pPage->PtrInPage(aPos), aLength);

            // if page is from unlocked queue, insert it onto the last page of the locked

            //  queue. this is to avoid excessive locking and unlocking operations that is

            //  highly likely to happen for following reads.

            if (pPage->PageType() == TDynamicDirCachePage::EUnlocked)

                {

                DeQueue(pPage);

                MakePageLastLocked(pPage);

                }

            }

        else    // page locking failed

            {

            ASSERT(pPage->PageType() == TDynamicDirCachePage::EUnlocked);

            DeQueue(pPage);

            LookupTblRemove(pPage->StartPos());

            DecommitPage(pPage);

            delete pPage;

            pPage = NULL;

            }

        }

    if (!pPage)

        {

        // if page not found or page data not valid anymore, use active page to read data in

        pPage = UpdateActivePageL(aPos);

        // read data

        aDes.Copy(pPage->PtrInPage(aPos), aLength);

        }

    }

//====================================================================

/**

Implementation of pure virtual function.

@see    MWTCacheInterface::ReadL()

*/

void CDynamicDirCache::ReadL(TInt64 aPos, TInt aLength, TDes8& aDes)

    {

#ifdef _DEBUG

    if(iCacheDisabled)

        {

        // cache is disabled for debug purposes

        __PRINT(_L("CDynamicDirCache disabled"));

        User::LeaveIfError(iDrive.ReadNonCritical(aPos, aLength, aDes));

        return;

        }

#endif //_DEBUG

    aDes.Zero();

    const TUint32 PageSz = iPageSizeInBytes;//-- cache page size

    TInt64 pageStartMedPos = CalcPageStartPos(aPos);

    const TUint32 bytesToPageEnd = (TUint32)(pageStartMedPos + PageSz - aPos); //-- number of bytes from aPos to the end of the page

//    __PRINT5(_L("CDynamicDirCache::ReadL: aPos=%lx, aLength=%x, page:%lx, pageSz:%x, bytesToPageEnd=%x"), aPos, aLength, pageStartMedPos, PageSz, bytesToPageEnd);

    // if all data needed is on a single page

    if((TUint32)aLength <= bytesToPageEnd)

        {

        ReadDataFromSinglePageL(aPos, aLength, aDes);

        }

    // or data to be read cross cache page boundary or probably we have more than 1 page to read

    else

        {

        __PRINT(_L("CDynamicDirCache::ReadL() CROSS PAGE!"));

        TUint32 dataLen(aLength);   //-- current data length

        TInt64  currMediaPos(aPos); //-- current media position

        //-- 1. read data that are already in the current page

        ReadDataFromSinglePageL(currMediaPos, bytesToPageEnd, aDes);

        dataLen -= bytesToPageEnd;

        currMediaPos += bytesToPageEnd;

        TPtr8 dataNext = aDes.MidTPtr(aDes.Length());

        //-- 2. read whole pages of data

        while (dataLen >= PageSz)

            {

            //-- find out if currMediaPos is in cache. If not, find a spare page and read data there

            ReadDataFromSinglePageL(currMediaPos, PageSz, dataNext);

            currMediaPos += PageSz;

            dataLen -= PageSz;

            dataNext = dataNext.MidTPtr(dataNext.Length());

            }

        //-- 3. read the rest of the data

        if(dataLen > 0)

            {

            ReadDataFromSinglePageL(currMediaPos, dataLen, dataNext);

            }

        } //else((TUint32)aLength <= bytesToPageEnd)

    }

/**

Write data through a single page. If the page is not found or not valid anymore, read media onto iActive page

first, then write data through iActive page.

@param  aPos    the starting position of the media address to be write.

@param  aData   the starting address that the writing content lives in the ram.

@param  aDataLen    the length of the content to be written.

@pre    aDataLen    should be no more than page size.

*/

void CDynamicDirCache::WriteDataOntoSinglePageL(TInt64 aPos, const TUint8* aData, TUint32 aDataLen)

    {

    ASSERT(aDataLen <= iPageSizeInBytes);

    //-- the data section is in the cache page entirely, take data directly from the cache

    TDynamicDirCachePage* pPage = FindPageByPos(aPos);

    if (pPage)

        {

        // lock page before writing,

        if (LockPage(pPage) != NULL)

            {

            //-- update cache

            Mem::Copy(pPage->PtrInPage(aPos), aData, aDataLen);

            }

        else

            {

            ASSERT(pPage->PageType() == TDynamicDirCachePage::EUnlocked);

            DeQueue(pPage);

            LookupTblRemove(pPage->StartPos());

            DecommitPage(pPage);

            delete pPage;

            pPage = NULL;

            }

        }

    // if page not found or page data not valid anymore, use active page to read data in

    if (!pPage)

        {

        pPage = UpdateActivePageL(aPos);

        //-- update cache

        Mem::Copy(pPage->PtrInPage(aPos), aData, aDataLen);

        }

    // make sure the page is unlocked after use

    if (pPage->PageType() == TDynamicDirCachePage::EUnlocked)

        {

        UnlockPage(pPage);

        }

    // always make writting events MRU

    MakePageMRU(aPos);

    return;

    }

/**

Implementation of pure virtual function.

@see    MWTCacheInterface::WriteL()

*/

void CDynamicDirCache::WriteL(TInt64 aPos,const TDesC8& aDes)

    {

#ifdef _DEBUG

    if(iCacheDisabled)

        {

        // cache is disabled for debug purposes

        __PRINT(_L("CDynamicDirCache disabled"));

        User::LeaveIfError(iDrive.WriteCritical(aPos,aDes));

        return;

        }

#endif //_DEBUG

    TUint32 dataLen = aDes.Size();

    const TUint8* pData   = aDes.Ptr();

    const TUint32 PageSz  = iPageSizeInBytes; //-- cache page size

    TInt64 pageStartMedPos = CalcPageStartPos(aPos);

    TUint32 bytesToPageEnd = (TUint32)(pageStartMedPos + PageSz - aPos);

//    __PRINT5(_L("CDynamicDirCache::WriteL: aPos=%lx, aLength=%x, page:%lx, pageSz:%x, bytesToPageEnd=%x"), aPos, dataLen, pageStartMedPos, PageSz, bytesToPageEnd);

    if(dataLen <= bytesToPageEnd)

        {

        WriteDataOntoSinglePageL(aPos, pData, dataLen);

        }

    else

        {

        __PRINT(_L("CDynamicDirCache::WriteL() CROSS PAGE!"));

        //-- Data to be written cross cache page boundary or probably we have more than 1 page to write

        TInt64  currMediaPos(aPos);

        //-- 1. update the current page

        WriteDataOntoSinglePageL(currMediaPos, pData, bytesToPageEnd);

        pData += bytesToPageEnd;

        currMediaPos += bytesToPageEnd;

        dataLen -= bytesToPageEnd;

        //-- 2. write whole pages of data to the cache

        while (dataLen >= PageSz)

            {

            WriteDataOntoSinglePageL(currMediaPos, pData, PageSz);

            pData += PageSz;

            currMediaPos += PageSz;

            dataLen -= PageSz;

            }

        //-- 3. write the rest of the data

        if(dataLen > 0)

            {

            WriteDataOntoSinglePageL(currMediaPos, pData, dataLen);

            }

        }// else(dataLen <= bytesToPageEnd)

    //-- write data to the media

    const TInt nErr = iDrive.WriteCritical(aPos,aDes);

    if(nErr != KErrNone)

        {//-- some serious problem occured during writing, invalidate cache.

        InvalidateCache();

        User::Leave(nErr);

        }

    }

/**

Implementation of pure virtual function.

@see    MWTCacheInterface::InvalidateCache()

*/

void CDynamicDirCache::InvalidateCache(void)

    {

    __PRINT2(_L("CDynamicDirCache::InvalidateCache(locked=%d, unlocked=%d)"), iLockedQCount, iUnlockedQCount);

    // we should never decommit locked pages as they needs to be reserved anyway

    // the overhead of unnecessary page committing operations

    while(!iLockedQ.IsEmpty())

        {

        TDynamicDirCachePage* page = iLockedQ.Last();

        DeQueue(page);                      // remove from queue

        LookupTblRemove(page->StartPos());  // remove from lookuptable

        delete page;

        }

    ASSERT(iLockedQCount == 0);

    // however we should decommit unlocked pages here

    while (!iUnlockedQ.IsEmpty())

        {

        TDynamicDirCachePage* page = iUnlockedQ.Last();

        DeQueue(page);                      // remove from queue

        LookupTblRemove(page->StartPos());  // remove from lookuptable

        DecommitPage(page);                 // inform cache client to decommit page memory

        delete page;

        }

    ASSERT(iUnlockedQCount == 0);

    ASSERT(iLookupTable.Count() == 0);

    iLookupTable.Close();

    ASSERT(iCacheMemoryClient);

    // initialize cache state.

    // Note that once the client is reset, all pages lose connection with the client

    //  including the active page. So we will need to reset and re-allocate active page

    //  properly.

    if (iCacheMemoryClient)

        iCacheMemoryClient->Reset();

    // reset and re-allocate active page

    ResetPagePos(iActivePage);              // reset start media position (0), invalidate page content

    TUint8* startRamAddr = iCacheMemoryClient->AllocateAndLockSegments(PageSizeInSegs());

    // this should always succeed as the client has just been reset and there are always reserved pages

    ASSERT(startRamAddr);

    iActivePage->SetStartPtr(startRamAddr); // set RAM address