// Copyright (c) 2003-2009 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:

// Implementation of the root server startup confguration process

// 

//

#include "c32start.h"

#include <f32file.h>

#include "c32cmi.h"

#include <rserror.h>

#include <cfextras.h>

	#include <ssm/ssmdomaindefs.h>

#include <rsshared.h>				// for TRSAddMBufAllocInfoContainer

	#include "c32startserv.h"

	#include <c32startshared.h>

#include <es_mbman.h>

#ifdef _DEBUG

// Panic category for "absolutely impossible!" vanilla ASSERT()-type panics from this module

// (if it could happen through user error then you should give it an explicit, documented, category + code)

_LIT(KSpecAssert_RootSrvc32start, "RootSrvc32start.");

#endif

/**

@file

Implements the reference Comms Configurator

@publishedPartner

@released

*/

/** Local Flogger instance for debug logging. We can't use the tidier __FLOG_DECLARATION_VARIABLE macro because

the need for a statement terminator causes a warning for WINSCW UREL

*/

#if defined(__FLOG_ACTIVE)

RFileLogger __logger__;

#endif

static void Fault(TConfiguratorServerPanic aFault)

    /** Panic the configurator server

     @param aFault Fault code as defined in cs_std.h

     @internalComponent

     */

    {

    User::Panic(KRsConfiguratorServerName, aFault);

    }

/** Name of application.

*/

_LIT(KC32Start, "C32Start");

_LIT8(KAbbreviatedC32Start, "C32:");

/** Configuration file wildcard

*/

_LIT(KC32WildCard, "*.cmi");

/** Configuration process global settings

*/

_LIT(KC32StartIniFile, "c32start.ini");

/** Global section in configuration process settings

*/

_LIT8(KC32StartIniGlobalSection, "Global");

/** Optional global setting for the size of the MBuf pool, in bytes 

*/ 	 

_LIT8(KC32StartMBufPoolSize, "MBufPoolSize");

/** Optional (but highly recommended) setting to specify mbuf size allocation information; mbuf size, initial allocation, growth rate, auto growth.

*/

_LIT8(KC32StartMBufSizeAllocInfo, "MBufSizeAllocInfo");

/** Optional global override for the TestMode, in which the failure to reload a shutdown or

crashed critical module is logged, rather than causing the phone to reboot.

*/

_LIT8(KC32StartTestMode, "TestMode");

/** PANICs which can occur in this module.

*/

enum TC32StartPanics

     {

     /** There was a problem when wanting to load a module.

     */

     EPanicLoad,

     /** When starting, the system property that must be created

     by the configurator was already created.

     */

     EPanicPubSub,

     /** Unable to get value of the Rootserver Death Property.

     */

     EDeathWatch,

     /** Out of memory.

     */

     ENoMemory,

     /** SystemCritical module died and any attempt made at resurrection

	 failed. Category text will include start of module's name.

     */

     ECriticalModuleDeath

     };

/** Source of PANICs from this application.

*/

_LIT(KPanicSource, "C32Start");

CBindingRef::CBindingRef(RRootServ& aRootServer, CCommsProcessStarter& aStartConfigProcess,

							   const TRSBindingInfo& aBinding)

: CActive(EPriorityStandard),

  iRootServer(aRootServer),

  iStartProcess(aStartConfigProcess),

  iState(ENotBound),

  iBindInfo(aBinding)

/**

C'tor

*/

	{

	CActiveScheduler::Add(this);

	}

TInt CBindingRef::BindIfReady()

/** Bind a submodule if it is ready to be bound.

*/

	{

	if(iState==EBound || iState==EBindFailed)

		{

		// We don't attempt to reapply bindings once they've failed; the usual case is

		// that they've timed-out, so they may complete later and by re-requesting them

		// we'd risk generating unwanted multiple bindings.

		return KErrRSAlreadyBound;

		}

	CModuleRef* pModule = NULL;

	CModuleRef* qModule = NULL;

	TInt res = KErrNotReady; // assume the worst

	// While enumerating the CMI files it may be that a binding refers to a module not yet described; once

	// we start loading modules then all bindings will be fully defined. So if a module can't be found by

	// name we return ERSSubModuleUnknown to flag the configuration error

	qModule = iStartProcess.GetModule(FromModule().Module());

	if(!qModule)

		{

		__FLOG_1(_L8("BindIfReady(): first module %S (involved in binding) is unknown"), &FromModule().Module());

		return KErrRSSubModuleUnknown;

		}

	if(qModule->State()==ELoaded)

		{

		pModule = iStartProcess.GetModule(ToModule().Module());

		if(!pModule)

			{

			__FLOG_1(_L8("BindIfReady(): second module %S (involved in binding) is unknown"), &ToModule().Module());

			return KErrRSSubModuleUnknown;

			}

		if(pModule->State() == ELoaded && (iState !=EBinding || iState == ENotBound ))

			{

			// track bindings of either end

			pModule->IncrementBindings();

			qModule->IncrementBindings();

			iState = EBinding;

			SetPriority(EPriorityHigh);

			iBindInfo.iParams.iState1 = KErrNone;

			iBindInfo.iParams.iState2 = KErrNone;

			__FLOG_2(_L8("BindIfReady() - binding %S to %S"), &qModule->Name(), &pModule->Name());

			iRootServer.Bind(iStatus, iBindInfo);

			SetActive();

			res = KErrNone;

			}

		else if(pModule->State() == ELoadFailed)

			{

			// second named module in binding failed to load, SetState(EBindInComplete)

			SetState(EBindInComplete);

			__FLOG_2(_L8("BindIfReady(): second module %S (involved in binding) failed to load, first module %S loaded, SetState(EBindInComplete)"), &pModule->Name(), &qModule->Name());

			RDebug::Printf("WARNING: second module %S (involved in binding) failed to load, first module %S loaded, SetState(EBindInComplete)", &pModule->Name(), &qModule->Name());

			__DEBUGGER();

			}

		}

	else if(qModule->State() == ELoadFailed)

		{

		// first named module in binding failed to load, SetState(EBindInComplete)

		SetState(EBindInComplete);

		__FLOG_1(_L8("BindIfReady(): first named module %S in binding failed to load, SetState(EBindInComplete) "), &qModule->Name());

		RDebug::Printf("WARNING: first named module %S in binding failed to load, SetState(EBindInComplete)", &qModule->Name());

		__DEBUGGER();

		}

	if(iState == EBindInComplete)

		{

		// inComplete Binding, check if any of the modules is being OnDemand loaded (iRMessage != NULL)

		// if the module is tried for 'Load' complete message with KErrRSEitherModuleInBindingFailedToLoad

		if(qModule->State() != ENotLoaded)

			{

			qModule->MaybeCompleteMessage(KErrRSEitherModuleInBindingFailedToLoad);

			}

		pModule = iStartProcess.GetModule(ToModule().Module());

		if(pModule)

			{

			if(pModule->State() != ENotLoaded)

				{

				pModule->MaybeCompleteMessage(KErrRSEitherModuleInBindingFailedToLoad);

				}

			}

		}

	return res;

	}

void CBindingRef::RunL()

/** This function is invoked on completion of a bind

and is used to trigger further bindings by calling NotifyBindCompletion

in the controller object which will deal with correct behaviour.

*/

	{

	if(iStatus.Int()==KErrNone)

		{

		iState = EBound;

		__FLOG(_L8("CBindingRef completed with KErrNone."));

		UpdateCompletedBinding(iStatus.Int());

		}

	else

		{

		iState = EBindFailed;

		if(iStatus.Int()==KErrRSAlreadyBound)

			{

			__FLOG(_L8("CBindingRef completed with KErrRSAlreadyBound. This is usually OK if configurator was SoftBooted, e.g. during testing."));

			UpdateCompletedBinding(iStatus.Int());

			}

		else

			{

			__FLOG_1(_L8("CBindingRef completed with %d"), iStatus.Int());

			UpdateCompletedBinding(iStatus.Int());

			}

		}

	iStartProcess.NotifyBindCompletion(*this);

	}

CBindingRef::~CBindingRef()

/** Destructor of CBindingRef. Removes self from list of CBindingRef objects.

*/

	{

	Deque();

	}

void CBindingRef::DoCancel()

	{

	TRSSubModuleAddress subMod1(iBindInfo.iParams.iAddress1);

	TRSSubModuleAddress subMod2(iBindInfo.iParams.iAddress2);

	iRootServer.CancelBind(subMod1, subMod2);

	}

const TCFSubModuleAddress& CBindingRef::FromModule() const

/**

@return Reference to a Submodule address.

*/

	{

	return iBindInfo.iParams.iAddress1;

	}

const TCFSubModuleAddress& CBindingRef::ToModule() const

/**

@return Reference to a Submodule address.

*/

	{

	return iBindInfo.iParams.iAddress2;

	}

void CBindingRef::UpdateCompletedBinding(TInt aReturnValue)

	{

	CModuleRef* pModule = iStartProcess.GetModule(FromModule().Module());

	if(pModule)

		{

		pModule->UpdateCompletedBinding(aReturnValue);

		}

	pModule = iStartProcess.GetModule(ToModule().Module());

	if(pModule)

		{

		pModule->UpdateCompletedBinding(aReturnValue);

		}

	}

CModuleRef* CModuleRef::NewLC(RRootServ& aRootServer,

							  CCommsProcessStarter& aCommsProcess,

							  C32CmiData& aModuleCMIData)

/** Create instance of CModuleRef.

@param aRootServer The rootserver API.

@param aCommsProcess The controller object.

@param aModuleCMIData The object containing the ini data for the module.

@return A pointer to the new instance.

*/

	{

	CModuleRef* pModule=new(ELeave) CModuleRef(aRootServer, aCommsProcess);

	CleanupStack::PushL(pModule);

	pModule->ConstructL(aModuleCMIData);

	return pModule;

	}

CModuleRef::CModuleRef(RRootServ& aRootServer,CCommsProcessStarter& aCommsProcess)

	:	CActive(EPriorityStandard),

		iRootServer(aRootServer),

		iCommsProcess(aCommsProcess)

/** C'tor

@param aRootServer The rootserver API.

@param aCommsProcess The controller object.

*/

	{}

void CModuleRef::ConstructL(C32CmiData& aModuleCMIData)

/** Second phase construction, sets data members.

@param aModuleCMIData The object containing the ini data for the module

@leave KErrNoMemory

*/

	{

	if(aModuleCMIData.IsServer())

		{

		iType = EServerModule;

		}

	else

		{

		iType = EProviderModule;

		}

	iState = ENotLoaded;

	iScaledStartupState = aModuleCMIData.ScaledStartupState();

	iIniData = aModuleCMIData.IniDataL();

	iSystemCritical = aModuleCMIData.SystemCritical();

	iSystemCriticalAfterInit = aModuleCMIData.SystemCriticalAfterInit();

	iParams.iParams.iName.Copy(aModuleCMIData.Name());

	iParams.iParams.iFilename.Copy(aModuleCMIData.FileName());

	iParams.iParams.iPriority = aModuleCMIData.Priority();

	iParams.iParams.iStackSize = aModuleCMIData.StackSize();

	iParams.iParams.iHeapType = aModuleCMIData.HeapOption();

    iParams.iParams.iMinHeapSize = aModuleCMIData.MinHeapSize();

    iParams.iParams.iMaxHeapSize = aModuleCMIData.MaxHeapSize();

	iParams.iParams.iThreadFunctionOrdinal = aModuleCMIData.ThreadFuncOrdinal();

	iParams.iParams.iShareHeapWith.Copy(aModuleCMIData.SharedHeapName());

	iParams.iParams.iIsSticky = aModuleCMIData.IsSticky();

	iParams.iParams.iIsServer = aModuleCMIData.IsServer();

	// DEF040831 - Experience has demonstrated that test code frequently triggers

	// the demise of a server, deliberately or otherwise.

	//

	// CMI files are only suppressed by test code. In such a state we don't

	// panic about module deaths even when they're labelled as SystemCritical

	// since test code also manipulates these. On a real device only the

	// configurator (eg this current process) should ever be manipulating the

	// RootServer state

	//

	// DEF068506 - Determine whether to turn off this option (specified by the .CMI files) based on 'TestMode'

	// defined in the C32Start.ini. This is generally done by tests temporarily replacing the original .ini file at runtime.

	iParams.iParams.iControlFlags = aModuleCMIData.ControlFlags();

	if (iCommsProcess.InTestMode())

		{

		__FLOG(_L8("CModuleRef::ConstructL - TestMode set."));

		iParams.iParams.iControlFlags &= ~TRSStartModuleParamContainer::KCF_ThreadAsSystem;

		}

	iConfigParams.iGroupName.Copy(aModuleCMIData.GroupName());

	iConfigParams.iOnDemand = aModuleCMIData.IsOnDemand();

	CActiveScheduler::Add(this);

	}

CModuleRef::~CModuleRef()

/** D'tor. Dequeues the instance.

*/

	{

	delete iIniData;

	Deque();

	}

void CModuleRef::UpdateCompletedBinding(TInt aReturnValue)

	{

	IncrementCompletedBindings();

	MaybeCompleteMessage(aReturnValue);

	}

void CModuleRef::Load()

/** Attempts to load the module with the Rootserver.

*/

	{

	__ASSERT_ALWAYS(!IsActive(), User::Panic(KPanicSource, EPanicLoad));

	__ASSERT_ALWAYS(iState==ENotLoaded || iState==ELoadFailed, User::Panic(KPanicSource, EPanicLoad));

	__FLOG_1(_L8("CModuleRef::LoadingCPM - %S"), &iParams.iParams.iName);

	iState = ELoading;

	SetPriority(EPriorityHigh);

	iRootServer.LoadCpm(iStatus, iParams, *iIniData);

	SetActive();

	}

TBool CModuleRef::Resurrect()

/** Called when the Root Server publishes the death of this module. In an extended-feature configurator this

may attempt to reload and rebind the module. This reference implementation simply returns that resurrection failed.

@return EFalse if the module could not be reloaded.

*/

	{

	return EFalse;

	}

TBool CModuleRef::operator==(const TCFModuleNameF& aModuleName) const

	{

   	return Name() == aModuleName;

 	}

void CModuleRef::RunL()

/** Calls NotifyLoadCompletion on CCommsProcessStarter.

*/

	{

	const TInt result=iStatus.Int();

	if(result==KErrNone)

		{

		if (iState == ELoading)

			{

			iState = ELoaded;

			if(!iHasBinding)

				{

				__FLOG_1(_L8("Comms Provider Module (%S) loaded successfully, has no bindings - Complete msg"), &iParams.iParams.iName);

				MaybeCompleteMessage(result);

				}

			iCommsProcess.NotifyLoadCompletion(*this);

			}

		else if(iState == EUnLoading)

			{

			iState = ENotLoaded;

			UnBindCpm();

			__FLOG_2(_L8("Comms ProviderModule (%S) unloaded successfully state (%d) - Complete msg"), &iParams.iParams.iName, iState);

			MaybeCompleteMessage(result);

			}

		}

	else

		{

		if(iState == ELoading)

			{

			__FLOG_2(_L8("Comms Provider Module load operation failed with (%d) - state (%d) - Complete msg"), result, iState);

			}

			else if(iState == EUnLoading)

				{

				__FLOG_2(_L8("Comms Provider Module unload operation failed with (%d) - state (%d) - Complete msg"), result, iState);

				}

		else

			{

			__FLOG_2(_L8("Comms Provider Module operation failed with (%d) - state (%d) - Complete msg"), result, iState);

			}

		MaybeCompleteMessage(result);

		if(result==KErrRSModuleAlreadyExist)

			{

			__FLOG_1(_L8("Comms Provider Module %S load failed with KErrRSModuleAlreadyExist. This is usually OK if configurator was SoftBooted, e.g. during testing."), &iParams.iParams.iName);

			iState = ELoaded;

			iCommsProcess.NotifyLoadCompletion(*this);

			}

		else

			{

			if (iState == ELoading)

				{

				__FLOG_2(_L8("Comms Provider Module %S NOT loaded. Error: %d"), &iParams.iParams.iName, iStatus.Int());

				iState = ELoadFailed;

				iCommsProcess.NotifyLoadCompletion(*this);

				}

			else if (iState == EUnLoading)

				{

				__FLOG_2(_L8("Comms Provider Module %S NOT Unloaded. Error: %d"), &iParams.iParams.iName, iStatus.Int());

				iState = ELoaded;

				}

			}

		}

	}

void CModuleRef::DoCancel()

	{

	iRootServer.CancelLoadCpm(iParams.iParams.iName);

	}

TInt CModuleRef::CompareScaledStartupState(const CModuleRef& aModule1, const CModuleRef& aModule2)

	{

	// Rely upon 2s-complement maths & the comparative closeness of values to avoid explicit comparisons

	return (TInt32) aModule1.ScaledStartupState() - (TInt32) aModule2.ScaledStartupState();

	}

void CModuleRef::MaybeCompleteMessage(TInt aReturnValue)

	{

	// only complete msg for module which has RMessage set on OnDemand Loading/Unloading NOT on

	// OnDemand property of module

	if (!iRMessage.IsNull())

		{

		if(iNumBindings == iCompletedBindings && iRMessage.Function() == CSLoadCpm)

			{

			iRMessage.Complete(aReturnValue);

			}

		else if (iRMessage.Function() == CSUnloadCpm)

			{

			iRMessage.Complete(aReturnValue);

			}

		}

	}

void CModuleRef::UnBindCpm()

	/**Sets the iState of CBindinRef to ENotBound once UnLoadCpm is successful

	*/

	{

	RPointerArray<CBindingRef>& bindings = iCommsProcess.GetBindingList();

	for(TInt i=0; i<bindings.Count(); i++)

		{

		if(Name() == bindings[i]->FromModule().Module())

			{

			bindings[i]->SetState(ENotBound);

			}

		}

	}

void CModuleRef::UnLoadCpm(const TCFModuleNameF& aModuleName,TRSUnLoadType aType)

	{

	iState = EUnLoading;

	SetPriority(EPriorityHigh);