/*

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

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "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:  Main classes for Graphics Out of Memory Monitor

*

*/

#define USE_ASYNCYH_NOTIFICATIONS

#include <hal.h>

#include <libc/string.h>

#include <UikonInternalPSKeys.h>

#include <EGL/egl.h>

#include "goommemorymonitor.h"

#include "goommonitorplugin.h"

#include "goomconfig.h"

#include "goommemorymonitorserver.h"

#include "goomconfigparser.h"

#include "goomactionlist.h"

#include "goomlog.h"

#include "goomtraces.h"

#include "goomwserveventreceiver.h"

#include "goomconstants.hrh"

#include "goomrunpluginconfig.h"

#include "goomapplicationconfig.h"

#include "goomcloseappconfig.h"

#include <goommonitorsession.h>

#ifdef USE_ASYNCYH_NOTIFICATIONS 

#include "goomthresholdcrossedao.inl"

#endif

const TInt KGoomWaitTimeToSynch = 1000000;

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

// class CMemoryMonitor

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

// ---------------------------------------------------------

//

// ---------------------------------------------------------

//

CMemoryMonitor* CMemoryMonitor::NewL()

    { // static

    FUNC_LOG;

    CMemoryMonitor* self = new(ELeave) CMemoryMonitor();

    CleanupStack::PushL(self);

    self->ConstructL();

    CleanupStack::Pop(self);

    return self;

    }

CMemoryMonitor::CMemoryMonitor()

    {

    FUNC_LOG;

    SetGMemoryMonitorTls(this);

    }

// ---------------------------------------------------------

//

// ---------------------------------------------------------

//

CMemoryMonitor::~CMemoryMonitor()

    {

    FUNC_LOG;

    delete iSynchTimer;

    delete iServer;

    delete iWservEventReceiver;

    iFs.Close();

    iWs.Close();

    delete iGOomWindowGroupList;

    delete iGOomActionList;

    delete iConfig;

 #ifdef USE_ASYNCYH_NOTIFICATIONS    

    delete iMemAllocationsGrowing;

    delete iMemAllocationsGoingDown;

 #endif

    eglTerminate(eglGetDisplay(EGL_DEFAULT_DISPLAY));

#ifdef _DEBUG

    delete iLogger;

#endif

    }

// ---------------------------------------------------------

//

// ---------------------------------------------------------

//

void CMemoryMonitor::ConstructL()

    {

    FUNC_LOG;

	    //Initialize EGL extension for memory data

    EGLDisplay dpy = eglGetDisplay(EGL_DEFAULT_DISPLAY);

    EGLint major, minor;

    eglInitialize(dpy, &major, &minor);

    /*

     ** Search for extName in the extensions string.  Use of strstr()

     ** is not sufficient because extension names can be prefixes of

     ** other extension names.  Could use strtok() but the constant

     ** string returned by glGetString can be in read-only memory.

     */

    TBool extensionFound = EFalse;

    char *p = (char *) eglQueryString(dpy,EGL_EXTENSIONS);

    char *end;

    int extNameLen;

    extNameLen = strlen("EGL_NOK_resource_profiling");

    end = p + strlen(p);

    while (p < end) 

        {

        int n = strcspn(p, " ");

        if ((extNameLen == n) && (strncmp("EGL_NOK_resource_profiling", p, n) == 0)) 

            {

            extensionFound = ETrue;

            break;

            }

        p += (n + 1);

        }

    if (!extensionFound)

        {

        TRACES("EGL_NOK_resource_profiling not found from EGL_EXTENSIONS");

        }

    // okay, let's fetch the function ptr to our profiling functions

    eglQueryProfilingData = (NOK_resource_profiling)eglGetProcAddress("eglQueryProfilingDataNOK");

    if (!eglQueryProfilingData)

        {

        TRACES("eglQueryProfilingDataNOK not found via eglGetProcAddress()");

        User::Leave(KErrNotSupported);

        }

    User::LeaveIfError(iWs.Connect());

    iWs.ComputeMode(RWsSession::EPriorityControlDisabled); 

    iGOomWindowGroupList = CGOomWindowGroupList::NewL(iWs);

    iConfig = CGOomConfig::NewL();

    iServer = CMemoryMonitorServer::NewL(*this);

   // Load up threshold & OOM app lists from resource.

    User::LeaveIfError(iFs.Connect());

    CGOomConfigParser* oomConfigParser = new (ELeave) CGOomConfigParser(*iConfig, iFs);

    CleanupStack::PushL(oomConfigParser);

    oomConfigParser->ParseL();

    CleanupStack::PopAndDestroy(oomConfigParser);

    iGOomActionList = CGOomActionList::NewL(*this, *iServer, iWs, *iConfig);

#ifdef _DEBUG

    iLogger = CGOomLogger::NewL(iWs, iFs);

#endif

    // Get the thresholds based on the current foreground app and the config

    RefreshThresholds();

    iWservEventReceiver = new(ELeave) CWservEventReceiver(*this, iWs);

    iWservEventReceiver->ConstructL();

    iSynchTimer = CGOomSynchTimer::NewL(*this);

    }

const CGOomGlobalConfig& CMemoryMonitor::GlobalConfig()

    {

    CMemoryMonitor* globalMemoryMonitor = static_cast<CMemoryMonitor*>(Dll::Tls());

    return globalMemoryMonitor->iConfig->GlobalConfig();

    }

// ---------------------------------------------------------

//

// ---------------------------------------------------------

//

void CMemoryMonitor::FreeMemThresholdCrossedL(TInt /*aAction*/, TInt aThreshold)

    {

    FUNC_LOG;

    // keep only one notification active at a moment

#ifdef USE_ASYNCYH_NOTIFICATIONS 

    if (aThreshold == EGL_PROF_TOTAL_MEMORY_USAGE_LT_NOK)

        {

        TInt current = GetFreeMemory();

        if(current >= iGoodThreshold  && (!NeedToPostponeMemGood()))

            {

            TRACES2("FreeMemThresholdCrossedL : crossed good threshold Free %d, GThresh %d, Calling MemoryGood",current, iGoodThreshold);

            iGOomActionList->MemoryGood();

            iMemAllocationsGrowing->Continue();

            iMemAllocationsGoingDown->Stop();

            return;

            }

        else

            {

            TRACES3("FreeMemThresholdCrossedL : Not Calling MemoryGOOD. Free %d, GThresh %d, Handshakepending = %d",current, iGoodThreshold, NeedToPostponeMemGood()?1:0);

            //if we remain in low mem mode, we have to wait for the same trigger i.e. free mem crossing good threshold

            if(NeedToPostponeMemGood()) //if handshake pending

                iMemAllocationsGoingDown->Stop();   //Stop till handhsake is complete. It will be made to continue from DoPostponedMemoryGood

            else

                iMemAllocationsGoingDown->Continue();

            }

        }

    else//if aThreshold == EGL_PROF_TOTAL_MEMORY_USAGE_GT_NOK

        {

        TRACES1("FreeMemThresholdCrossedL : crossed low threshold %d", iLowThreshold);

        iMemAllocationsGrowing->Stop();

        iMemAllocationsGoingDown->Continue();

            StartFreeSomeRamL(iGoodThreshold, EGOomTriggerThresholdCrossed);

        }

#endif

    }

void CMemoryMonitor::HandleFocusedWgChangeL(TInt aForegroundAppUid)

    {

    FUNC_LOG;

    TRACES1("CMemoryMonitor::HandleFocusedWgChangeL Foregroundapp id = %x", aForegroundAppUid);

    if(aForegroundAppUid == 0)

        {

        return;

        }

    iForegroundAppUid = aForegroundAppUid;    

    // Refresh the low and good memory thresholds as they may have changed due to the new foreground application

    RefreshThresholds(aForegroundAppUid);

        {

        StartFreeSomeRamL(iCurrentTarget, EGOomTriggerFocusChanged);

        }

     }

void CMemoryMonitor::StartFreeSomeRamL(TInt aTargetFree, TInt aMaxPriority, TGOomTrigger aTrigger) // The maximum priority of action to run

    {

    FUNC_LOG;

    TRACES2("MemoryMonitor::StartFreeSomeRamL: aTargetFree = %d, iCurrentTarget = %d", aTargetFree, iCurrentTarget);

    // Update the target if new target is higher. If the target is lower than the current target and memory

    // is currently being freed then we do not want to reduce the amount of memory this operation frees.

    if (aTargetFree > iCurrentTarget)

        iCurrentTarget = aTargetFree;

    // check if there is enough free memory already.

    TInt freeMemory;

    TBool freeMemoryAboveCurrentTarget = FreeGraphicsMemoryAboveThresholdL(freeMemory);

    TRACES2("MemoryMonitor::StartFreeSomeRamL freeMemoryAboveTarget = %d, freeMemory = %d", freeMemoryAboveCurrentTarget, freeMemory);

    if (freeMemoryAboveCurrentTarget)

        {

        /*if(freeMemory >= iGoodThreshold && !NeedToPostponeMemGood())

            {

                iGOomActionList->MemoryGood();

            }

        */

            {

            iServer->CloseAppsFinished(freeMemory, ETrue);

            WaitAndSynchroniseMemoryState();

            }

        }

    // update wg list only when actually about to use it 

    //iGOomWindowGroupList->Refresh();

#ifdef _DEBUG

    iLogger->StartL();

#endif

    // Build the list of memory freeing actions

    iGOomActionList->BuildPluginActionListL(*iGOomWindowGroupList, *iConfig);

    //iGOomActionList->SetCurrentTarget(aTargetFree);

    iGOomActionList->SetCurrentTarget(iCurrentTarget);

    iTrigger = aTrigger;

    iGOomActionList->SetUseSwRendering(ETrue); //Always use SW rendering in low mode .. (for now..) 

    // Run the memory freeing actions

    iGOomActionList->FreeMemory(aMaxPriority);

    }

void CMemoryMonitor::RunCloseAppActions(TInt aMaxPriority)

    {

    FUNC_LOG;

    // Build the list of memory freeing actions (by killing apps)

    TRAP_IGNORE(iGOomActionList->BuildKillAppActionListL(*iGOomWindowGroupList, *iConfig));

    iGOomActionList->FreeMemory(aMaxPriority);

    }

// ---------------------------------------------------------

// This function attempts to free enough RAM to leave the target amount of space free.

// This function could take a substantial time to return as it may have to close a number

// of applications, and each will be given a timeout of KAPPEXITTIMEOUT.

// ---------------------------------------------------------

//

void CMemoryMonitor::StartFreeSomeRamL(TInt aTargetFree, TGOomTrigger aTrigger)

    {

    FUNC_LOG;

    StartFreeSomeRamL(aTargetFree, KGOomPriorityInfinate - 1, aTrigger);

    }

void CMemoryMonitor::RequestFreeMemoryL(TInt aTargetFree, TBool aUseAbsolute)

    {

    FUNC_LOG;

    StartFreeSomeRamL(aUseAbsolute?aTargetFree:(aTargetFree + iLowThreshold), KGOomPriorityInfinate - 1, EGOomTriggerRequestMemory);

    }

void CMemoryMonitor::FreeOptionalRamL(TInt aTargetFree, TInt aPluginId, TBool aUseAbsolute) // The ID of the plugin that will clear up the allocation, used to determine the priority of the allocation

    {

    FUNC_LOG;

    // Calculate the priority of the allocation (the priority of the plugin that will clear it up - 1)

    TInt priorityOfAllocation = iConfig->GetPluginConfig(aPluginId).CalculatePluginPriority(*iGOomWindowGroupList) - 1;

    StartFreeSomeRamL(aUseAbsolute?aTargetFree:(aTargetFree + iGoodThreshold), priorityOfAllocation, EGOomTriggerRequestMemory);

    }

// Does the EGL extension return the amount of memory in bits?

// If yes, int is clearly not enough

// Note that this function reserves memory so it can fail if the "standard" memory

// gets full.

TBool CMemoryMonitor::FreeGraphicsMemoryAboveThresholdL(TInt& aCurrentFreeMemory)

    {

    FUNC_LOG;

    TInt current = GetFreeMemory();

    User::LeaveIfError(current);

    aCurrentFreeMemory = current;

    return (current >= iCurrentTarget);

    }

// ---------------------------------------------------------

//

// ---------------------------------------------------------

//

void CMemoryMonitor::AppNotExiting(TInt aWgId)

    {

    FUNC_LOG;

    iGOomActionList->AppNotExiting(aWgId);

    }

void CMemoryMonitor::RefreshThresholds(TInt aForegroundAppUid)

    {

    FUNC_LOG;    

    TInt origGood = iGoodThreshold;

    TInt origLow = iLowThreshold;

    // Calculate the desired good threshold, this could be the globally configured value...

    iGoodThreshold = CMemoryMonitor::GlobalConfig().iGoodRamThreshold;

    iLowThreshold = CMemoryMonitor::GlobalConfig().iLowRamThreshold;

    //if(iCurrentTarget < iLowThreshold)

    //    iCurrentTarget = iLowThreshold;

    TRACES2("CMemoryMonitor::RefreshThresholds: Global Good Threshold = %d, Global Low Threshold = %d", iGoodThreshold, iLowThreshold);

    TBool useSwRendering = EFalse;

    // The global value can be overridden by an app specific value

    // Find the application config entry for the foreground application

    if (aForegroundAppUid == KErrNotFound)

        {

        return;

        }     

    // If this application configuration overrides the good_ram_threshold then set it

    if (iConfig->GetApplicationConfig(aForegroundAppUid).iGoodRamThreshold != KGOomThresholdUnset)

        {

        iGoodThreshold = iConfig->GetApplicationConfig(aForegroundAppUid).iGoodRamThreshold;

        TRACES2("CMemoryMonitor::RefreshThresholds: For foreground app %x, Good Threshold = %d", aForegroundAppUid, iGoodThreshold);

        }

    // If this application configuration overrides the low_ram_threshold then set it

    if (iConfig->GetApplicationConfig(aForegroundAppUid).iLowRamThreshold != KGOomThresholdUnset)

        {

        iLowThreshold = iConfig->GetApplicationConfig(aForegroundAppUid).iLowRamThreshold;

        TRACES2("CMemoryMonitor::RefreshThresholds: For foreground app %x, Low Threshold = %d", aForegroundAppUid, iLowThreshold);

        }

    // If this application configuration overrides the good_ram_threshold then set it

    if (iConfig->GetApplicationConfig(aForegroundAppUid).iTargetFree != KGOomThresholdUnset)

        {

        iCurrentTarget = iConfig->GetApplicationConfig(aForegroundAppUid).iTargetFree;

        TRACES2("CMemoryMonitor::RefreshThresholds: For foreground app %x, Target Free on Startup = %d", aForegroundAppUid, iCurrentTarget);

        }

    if (iConfig->GetApplicationConfig(aForegroundAppUid).iUseSwRendering != KGOomThresholdUnset)

        {

        useSwRendering = iConfig->GetApplicationConfig(aForegroundAppUid).iUseSwRendering;

        TRACES2("CMemoryMonitor::RefreshThresholds: For foreground app %x, UseSwRendering = %d", aForegroundAppUid, useSwRendering);

        }

    iGOomActionList->SetCurrentTarget(iCurrentTarget);

    iGOomActionList->SetUseSwRendering(useSwRendering);

#ifdef USE_ASYNCYH_NOTIFICATIONS 

    // if allocation should fail, threshold should not naturally be set

    if (!iMemAllocationsGrowing)

        {

        TRAP_IGNORE(iMemAllocationsGrowing = CreateThresholdCrossedThreadL(*this, EGL_PROF_TOTAL_MEMORY_USAGE_GT_NOK, iLowThreshold))

        origLow = iLowThreshold; // do not reset

        }

    if (!iMemAllocationsGoingDown)

        {

        TRAP_IGNORE(iMemAllocationsGoingDown = CreateThresholdCrossedThreadL(*this, EGL_PROF_TOTAL_MEMORY_USAGE_LT_NOK, iGoodThreshold))

        origGood = iGoodThreshold; // do not reset

        }

    TBool releaseClient = ETrue;

    // update thresholds only if they really change

    if (origGood != iGoodThreshold)

        {

        iMemAllocationsGoingDown->SetThreshold(iGoodThreshold);

        }

    if ( origLow != iLowThreshold)

        {

        // need to synchronously check whether client should wait

        // memory to be released

        if(GetFreeMemory() <= iLowThreshold )    

            {

            releaseClient = EFalse;

            }

        iMemAllocationsGrowing->SetThreshold(iLowThreshold);

        }

   TRACES3("CMemoryMonitor::RefreshThresholds: releaseClient: %d For foreground app 0x%x, Active client = 0x%x",releaseClient, aForegroundAppUid, ActiveClientId());

   if (releaseClient && ActiveClientId() == iForegroundAppUid)

        {

        iServer->CloseAppsFinished(0, ETrue);    

        }     

#endif