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

// e32\include\nkernsmp\nk_priv.h

// 

// WARNING: This file contains some APIs which are internal and are subject

//          to change without notice. Such APIs should therefore not be used

//          outside the Kernel and Hardware Services package.

//

#ifndef __NK_PRIV_H__

#define __NK_PRIV_H__

#include <cpudefs.h>

#include <nkern.h>

#define __USE_BTRACE_LOCK__

class Monitor;

/********************************************

 * Schedulable = thread or thread group

 ********************************************/

/**

@publishedPartner

@prototype

Base class for a nanokernel thread or group

*/

class NThreadGroup;

class NSchedulable : public TPriListLink

	{

public:

	enum

		{

		EReadyGroup=1,

		EReadyCpuMask=0x7f,

		EReadyOffset=0x80,

		};

	enum NReadyFlags

		{

		ENewTimeslice=1,

		EPreferSameCpu=2,

		EUnPause=4,

		};

	enum NEventState

		{

		EEventCountShift=16u,

		EEventCountMask=0xffff0000u,

		EEventCountInc=0x10000u,

		EEventCpuShift=0u,

		EEventCpuMask=0x1fu,

		EThreadCpuShift=8u,

		EThreadCpuMask=0x1f00u,

		EDeferredReady=0x4000u,

		EEventParent=0x8000u,

		};

public:

	NSchedulable();

	void AcqSLock();

	void RelSLock();

	void LAcqSLock();

	void RelSLockU();

	void ReadyT(TUint aMode);					// make ready, assumes lock held

	TInt BeginTiedEvent();

	void EndTiedEvent();

	TInt AddTiedEvent(NEventHandler* aEvent);

	TBool TiedEventReadyInterlock(TInt aCpu);

	void UnPauseT();							// decrement pause count and make ready if necessary

	static void DeferredReadyIDfcFn(TAny*);

	void DetachTiedEvents();

public:

	inline TBool IsGroup()			{return !iParent;}

	inline TBool IsLoneThread()		{return iParent==this;}

	inline TBool IsGroupThread()	{return iParent && iParent!=this;}

public:

//	TUint8				iReady;					/**< @internalComponent */	// flag indicating thread on ready list = cpu number | EReadyOffset

//	TUint8				iCurrent;				/**< @internalComponent */	// flag indicating thread is running

//	TUint8				iLastCpu;				/**< @internalComponent */	// CPU on which this thread last ran

	TUint8				iPauseCount;			/**< @internalComponent */	// count of externally requested pauses extending a voluntary wait

	TUint8				iSuspended;				/**< @internalComponent */	// flag indicating active external suspend (Not used for groups)

	TUint8				iNSchedulableSpare1;	/**< @internalComponent */

	TUint8				iNSchedulableSpare2;	/**< @internalComponent */

	TUint8				iCpuChange;				/**< @internalComponent */	// flag showing CPU migration outstanding

	TUint8				iStopping;				/**< @internalComponent */	// thread is exiting, thread group is being destroyed

	TUint16				iFreezeCpu;				/**< @internalComponent */	// flag set if CPU frozen - count for groups

	NSchedulable*		iParent;				/**< @internalComponent */	// Pointer to group containing thread, =this for normal thread, =0 for group

	TUint32				iCpuAffinity;			/**< @internalComponent */

	volatile TUint32	iEventState;			/**< @internalComponent */	// bits 16-31=count, 0-4=event CPU, 5-9=thread CPU, 10=defer, 11=parent

	TSpinLock			iSSpinLock;				/**< @internalComponent */

	SDblQue				iEvents;				/**< @internalComponent */	// doubly-linked list of tied events

	TUint32				i_IDfcMem[sizeof(TDfc)/sizeof(TUint32)];	/**< @internalComponent */	// IDFC used to make thread ready after last tied event completes

//	TDfc				iDeferredReadyIDfc;		/**< @internalComponent */	// IDFC used to make thread ready after last tied event completes

	union

		{

		TUint64			iRunCount64;

		TUint32			iRunCount32[2];

		};

	union

		{

		TUint64			iTotalCpuTime64;		/**< @internalComponent */	// total time spent running, in hi-res timer ticks

		TUint32			iTotalCpuTime32[2];		/**< @internalComponent */	// total time spent running, in hi-res timer ticks

		};

	};

__ASSERT_COMPILE(!(_FOFF(NSchedulable,iSSpinLock)&7));

__ASSERT_COMPILE(!(_FOFF(NSchedulable,iRunCount64)&7));

__ASSERT_COMPILE(!(_FOFF(NSchedulable,iTotalCpuTime64)&7));

__ASSERT_COMPILE(!(sizeof(NSchedulable)&7));

/**

@internalComponent

*/

inline TBool TDfc::IsValid()

	{

	if (iHType < KNumDfcPriorities)

		return TRUE;

	if (iHType != EEventHandlerIDFC)

		return FALSE;

	return !iTied || !iTied->iStopping;

	}

/********************************************

 * Thread

 ********************************************/

/**

@internalComponent

*/

class NThreadWaitState

	{

private:

	enum TWtStFlags

		{

		EWtStWaitPending		=0x01u,		// thread is about to wait

		EWtStWaitActive			=0x02u,		// thread is actually blocked

		EWtStTimeout			=0x04u,		// timeout is active on this wait

		EWtStObstructed			=0x08u,		// wait is due to obstruction (e.g. mutex) rather than lack of work to do

		EWtStDead				=0x80u,		// thread is dead

		};

private:

	NThreadWaitState();

	void SetUpWait(TUint aType, TUint aFlags, TAny* aWaitObj);

	void SetUpWait(TUint aType, TUint aFlags, TAny* aWaitObj, TUint32 aTimeout);

	void SetDead(TDfc* aKillDfc);

	void CancelWait();

	TInt DoWait();

	static void TimerExpired(TAny*);

	TInt UnBlockT(TUint aType, TAny* aWaitObj, TInt aReturnValue);

	TUint32 ReleaseT(TAny*& aWaitObj, TInt aReturnValue);

	void CancelTimerT();

private:

	inline NThreadBase* Thread();

	inline TBool WaitPending()

		{ return iWtC.iWtStFlags & (EWtStWaitPending|EWtStDead); }

	inline TBool ThreadIsBlocked()

		{ return iWtC.iWtStFlags & (EWtStWaitActive|EWtStDead); }

	inline TBool ThreadIsDead()

		{ return iWtC.iWtStFlags & EWtStDead; }

private:

	struct S

		{

		volatile TUint8			iWtStFlags;

		volatile TUint8			iWtObjType;

		volatile TUint8			iWtStSpare1;

		volatile TUint8			iWtStSpare2;

		union

			{

			TAny* volatile		iWtObj;

			volatile TInt		iRetVal;

			TDfc* volatile		iKillDfc;

			};

		};

	union

		{

		S						iWtC;

		volatile TUint32		iWtSt32[2];

		volatile TUint64		iWtSt64;

		};

	NTimer						iTimer;

private:

	friend class NSchedulable;

	friend class NThreadBase;

	friend class NThread;

	friend class TScheduler;

	friend class TSubScheduler;

	friend class TDfc;

	friend class TDfcQue;

	friend class NFastSemaphore;

	friend class NFastMutex;

	friend class NTimer;

	friend class NTimerQ;

	friend class NKern;

	friend class Monitor;

	friend class NKTest;

	};

/**

@publishedPartner

@prototype

Base class for a nanokernel thread.

*/

class TSubScheduler;

class NThreadBase : public NSchedulable

	{

public:

    /**

    Defines the possible types of wait object

    */

	enum NThreadWaitType

		{

		EWaitNone,

		EWaitFastSemaphore,

		EWaitFastMutex,

		EWaitSleep,

		EWaitBlocked,

		EWaitDfc,

		ENumWaitTypes

		};

	/**

	@internalComponent

	*/

	enum NThreadCSFunction

		{

		ECSExitPending=-1,

		ECSExitInProgress=-2,

		ECSDivertPending=-3,

		};

	/**

	@internalComponent

	*/

	enum NThreadTimeoutOp

		{

		ETimeoutPreamble=0,

		ETimeoutPostamble=1,

		ETimeoutSpurious=2,

		};

public:

	NThreadBase();

	TInt Create(SNThreadCreateInfo& anInfo,	TBool aInitial);

	void UnReadyT();

	TBool SuspendOrKill(TInt aCount);

	TBool DoSuspendOrKillT(TInt aCount, TSubScheduler* aS);

	TBool CancelTimerT();

	void DoReleaseT(TInt aReturnCode, TUint aMode);

	TBool CheckFastMutexDefer();

	void DoCsFunctionT();

	TBool Resume(TBool aForce);

	IMPORT_C TBool Suspend(TInt aCount);		/**< @internalComponent */

	IMPORT_C TBool Resume();					/**< @internalComponent */

	IMPORT_C TBool ForceResume();				/**< @internalComponent */

	IMPORT_C void Release(TInt aReturnCode, TUint aMode);	/**< @internalComponent */

	IMPORT_C void RequestSignal();				/**< @internalComponent */

	IMPORT_C void SetPriority(TInt aPriority);	/**< @internalComponent */

	void SetMutexPriority(NFastMutex* aMutex);

	void LoseInheritedPriorityT();

	void ChangeReadyThreadPriority();

	TUint32 SetCpuAffinity(TUint32 aAffinity);

	TBool TiedEventLeaveInterlock();

	TBool TiedEventJoinInterlock();

	IMPORT_C void Kill();						/**< @internalComponent */

	void Exit();

	// hooks for platform-specific code

	void OnKill(); 

	void OnExit();

public:

	static void TimerExpired(TAny* aPtr);

	/** @internalComponent */

	inline void UnknownState(TInt aOp, TInt aParam)

		{ (*iHandlers->iStateHandler)((NThread*)this,aOp,aParam); }

	/** @internalComponent */

	inline TUint8 Attributes()

		{ return i_ThrdAttr; }

	/** @internalComponent */

	inline TUint8 SetAttributes(TUint8 aNewAtt)

		{ return __e32_atomic_swp_ord8(&i_ThrdAttr, aNewAtt); }

	/** @internalComponent */

	inline TUint8 ModifyAttributes(TUint8 aClearMask, TUint8 aSetMask)

		{ return __e32_atomic_axo_ord8(&i_ThrdAttr, (TUint8)~(aClearMask|aSetMask), aSetMask); }

	/** @internalComponent */

	inline void SetAddressSpace(TAny* a)

		{ iAddressSpace=a; }

	/** @internalComponent */

	inline void SetExtraContext(TAny* a, TInt aSize)

		{ iExtraContext = a; iExtraContextSize = aSize; }

	/** @internalTechnology */

	inline TBool IsDead()

		{ return iWaitState.ThreadIsDead(); }

public:

	TPriListLink		iWaitLink;				/**< @internalComponent */	// used to link thread into a wait queue

//	TUint8				iBasePri;				/**< @internalComponent */	// priority with no fast mutex held

//	TUint8				iMutexPri;				/**< @internalComponent */	// priority from held fast mutex

//	TUint8				iInitial;				/**< @internalComponent */	// TRUE if this is an initial thread

	TUint8				iLinkedObjType;

	TUint8				i_ThrdAttr;				/**< @internalComponent */

	TUint8				iNThreadBaseSpare10;

	TUint8				iFastMutexDefer;		/**< @internalComponent */

	NFastSemaphore		iRequestSemaphore;		/**< @internalComponent */

	TInt				iTime;					/**< @internalComponent */	// time remaining, 0 if expired

	TInt				iTimeslice;				/**< @internalComponent */	// timeslice for this thread, -ve = no timeslicing

	TLinAddr			iSavedSP;				/**< @internalComponent */

	TAny*				iAddressSpace;			/**< @internalComponent */

	NFastMutex* volatile iHeldFastMutex;		/**< @internalComponent */	// fast mutex held by this thread

	TUserModeCallback* volatile iUserModeCallbacks;	/**< @internalComponent */	// Head of singly-linked list of callbacks

	TAny* volatile		iLinkedObj;				/**< @internalComponent */	// object to which this thread is linked

	NThreadGroup*		iNewParent;				/**< @internalComponent */	// group to join

	const SFastExecTable* iFastExecTable;		/**< @internalComponent */

	const SSlowExecEntry* iSlowExecTable;		/**< @internalComponent */	// points to first entry iEntries[0]

	volatile TInt		iCsCount;				/**< @internalComponent */	// critical section count

	volatile TInt		iCsFunction;			/**< @internalComponent */	// what to do on leaving CS: +n=suspend n times, 0=nothing, -1=exit

	NThreadWaitState	iWaitState;				/**< @internalComponent */

	const SNThreadHandlers* iHandlers;			/**< @internalComponent */	// additional thread event handlers

	TInt				iSuspendCount;			/**< @internalComponent */	// -how many times we have been suspended

	TLinAddr			iStackBase;				/**< @internalComponent */

	TInt				iStackSize;				/**< @internalComponent */

	TAny*				iExtraContext;			/**< @internalComponent */	// parent FPSCR value (iExtraContextSize == -1), coprocessor context (iExtraContextSize > 0) or NULL

	TInt				iExtraContextSize;		/**< @internalComponent */	// +ve=dynamically allocated, 0=none, -1=iExtraContext stores parent FPSCR value

	TUint32				iNThreadBaseSpare6;		/**< @internalComponent */	// spare to allow growth while preserving BC

	TUint32				iNThreadBaseSpare7;		/**< @internalComponent */	// spare to allow growth while preserving BC

	TUint32				iNThreadBaseSpare8;		/**< @internalComponent */	// spare to allow growth while preserving BC

	TUint32				iNThreadBaseSpare9;		/**< @internalComponent */	// spare to allow growth while preserving BC

	// For EMI support - HOPEFULLY THIS CAN DIE

	TUint32	iTag;							/**< @internalComponent */	// User defined set of bits which is ANDed with a mask when the thread is scheduled, and indicates if a DFC should be scheduled.

	TAny* iVemsData;						/**< @internalComponent */	// This pointer can be used by any VEMS to store any data associated with the thread.  This data must be clean up before the Thread Exit Monitor completes.

	};

__ASSERT_COMPILE(!(_FOFF(NThreadBase,iWaitLink)&7));

__ASSERT_COMPILE(!(sizeof(NThreadBase)&7));

#ifdef __INCLUDE_NTHREADBASE_DEFINES__

#define	iReady				iSpare1				/**< @internalComponent */

#define	iCurrent			iSpare2				/**< @internalComponent */

#define	iLastCpu			iSpare3				/**< @internalComponent */

#define iBasePri			iWaitLink.iSpare1	/**< @internalComponent */

#define	iMutexPri			iWaitLink.iSpare2	/**< @internalComponent */

#define	i_NThread_Initial	iWaitLink.iSpare3	/**< @internalComponent */

#endif

/** @internalComponent */

#define	i_NThread_BasePri	iWaitLink.iSpare1

/** @internalComponent */

#define	NTHREADBASE_CPU_AFFINITY_MASK	0x80000000

/** @internalComponent */

inline NThreadBase* NThreadWaitState::Thread()

	{ return _LOFF(this, NThreadBase, iWaitState); }

/********************************************

 * Thread group

 ********************************************/

/**

@publishedPartner

@prototype

Base class for a nanokernel thread or group

*/

class NThreadGroup : public NSchedulable

	{

public:

	NThreadGroup();

public:

	TInt iThreadCount;										/**< @internalComponent */

	TPriList<NThreadBase, KNumPriorities> iNThreadList;		/**< @internalComponent */

	};

/********************************************

 * Scheduler

 ********************************************/

/**

@internalComponent

*/

class TScheduler;

class NThread;

class NIrqHandler;

class TSubScheduler : public TPriListBase

	{

public:

	TSubScheduler();

	void QueueDfcs();

	void RotateReadyList(TInt aPriority);

	NThread* SelectNextThread();

	TBool QueueEvent(NEventHandler* aEvent);

	void QueueEventAndKick(NEventHandler* aEvent);

	void SaveTimesliceTimer(NThreadBase* aThread);

	void UpdateThreadTimes(NThreadBase* aOld, NThreadBase* aNew);

private:

	SDblQueLink*	iExtraQueues[KNumPriorities-1];

public:

	TSpinLock		iExIDfcLock;				// lock to protect exogenous IDFC queue

	SDblQue			iExIDfcs;					// list of pending exogenous IDFCs (i.e. ones punted over from another CPU)

	SDblQue			iDfcs;						// normal IDFC/DFC pending queue (only accessed by this CPU)

	TDfc* volatile	iCurrentIDFC;				// pointer to IDFC currently running on this CPU

	NThread*		iCurrentThread;				// the thread currently running on this CPU

	TUint32			iCpuNum;

	TUint32			iCpuMask;

	TSpinLock		iReadyListLock;

	volatile TUint8	iRescheduleNeededFlag;		// TRUE if a thread reschedule is pending

	TUint8			iSubSchedulerSBZ1;			// always zero

	volatile TUint8	iDfcPendingFlag;			// TRUE if a normal IDFC is pending

	volatile TUint8	iExIDfcPendingFlag;			// TRUE if an exogenous IDFC is pending

	TInt			iKernLockCount;				// how many times the current CPU has locked the kernel

	TUint8			iInIDFC;					// TRUE if IDFCs are currently being run on this CPU

	volatile TUint8	iEventHandlersPending;		// TRUE if an event handler is pending on this CPU

	TUint8			iSubSchedulerSpare4;

	TUint8			iSubSchedulerSpare5;

	TAny*			iAddressSpace;

	TUint32			iReschedIPIs;

	TScheduler*		iScheduler;

	union

		{

		TUint64		iLastTimestamp64;			// NKern::Timestamp() value at last reschedule or timestamp sync

		TUint32		iLastTimestamp32[2];

		};

	union

		{

		TUint64		iReschedCount64;

		TUint32		iReschedCount32[2];

		};

	TAny*			iExtras[24];				// Space for platform-specific extras

	TGenericIPI*	iNextIPI;					// next generic IPI to run on this CPU

	NThread*		iInitialThread;				// Initial (idle) thread on this CPU

	TSpinLock		iEventHandlerLock;			// lock to protect event handler queue

	SDblQue			iEventHandlers;				// queue of pending event handlers on this CPU

	TUint64			iSpinLockOrderCheck;		// bitmask showing which spinlock orders currently held

	TUint32			iSubSchedulerPadding[8];

	};

__ASSERT_COMPILE(!(_FOFF(TSubScheduler,iExIDfcLock)&7));

__ASSERT_COMPILE(!(_FOFF(TSubScheduler,iEventHandlerLock)&7));

__ASSERT_COMPILE(!(_FOFF(TSubScheduler,iReadyListLock)&7));

__ASSERT_COMPILE(!(_FOFF(TSubScheduler,iLastTimestamp64)&7));

__ASSERT_COMPILE(!(_FOFF(TSubScheduler,iReschedCount64)&7));

__ASSERT_COMPILE(sizeof(TSubScheduler)==512);	// make it a nice power of 2 size for easy indexing

/**

@internalComponent

*/

class TScheduler

	{

public:

	TScheduler();

	static void Reschedule();

	IMPORT_C static TScheduler* Ptr();

	inline void SetProcessHandler(TLinAddr aHandler) {iProcessHandler=aHandler;}

public:

	TLinAddr		iMonitorExceptionHandler;

	TLinAddr		iProcessHandler;

	TLinAddr		iRescheduleHook;

	TUint32			iActiveCpus1;				// bit n set if CPU n is accepting unlocked threads

	TUint32			iActiveCpus2;				// bit n set if CPU n is accepting generic IPIs

	TInt			iNumCpus;					// number of CPUs under the kernel's control

	TSubScheduler*	iSub[KMaxCpus];				// one subscheduler per CPU

	TAny*			iExtras[24];				// Space for platform-specific extras

	NFastMutex		iLock;						// the 'system lock' fast mutex

	TSpinLock		iIdleSpinLock;				// lock to protect list of DFCs to be run on idle

	SDblQue			iIdleDfcs;					// list of DFCs to run when all CPUs go idle

	TUint32			iCpusNotIdle;				// bitmask - Bit n set => CPU n is not idle