sl@0: // Copyright (c) 1994-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 the License "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: // e32\include\e32def_private.h
sl@0: // 
sl@0: // WARNING: This file contains some APIs which are internal and are subject
sl@0: //          to change without notice. Such APIs should therefore not be used
sl@0: //          outside the Kernel and Hardware Services package.
sl@0: //
sl@0: 
sl@0: #ifndef __E32DEF_PRIVATE_H__
sl@0: #define __E32DEF_PRIVATE_H__
sl@0: 
sl@0: #ifdef __PROFILING__
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @removed
sl@0: */
sl@0: #define __PROFILE_START(aBin) RDebug::ProfileStart(aBin)
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @removed
sl@0: */
sl@0: #define __PROFILE_END(aBin)   RDebug::ProfileEnd(aBin)
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @removed
sl@0: */
sl@0: #define __PROFILE_RESET(aNumberOfBins) RDebug::ProfileReset(0,aNumberOfBins)
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @removed
sl@0: */
sl@0: #define __PROFILE_DISPLAY(aNumberOfBins) \
sl@0: 			{	TFixedArray<TProfile, aNumberOfBins> result; \
sl@0: 				RDebug::ProfileResult(result.Begin(), 0, aNumberOfBins); \
sl@0: 				for (TInt i=0; i<aNumberOfBins; i++)   \
sl@0: 				RDebug::Print(_L("Profile bin %d:  Calls: %d, Clock ticks: %d\n" ),i,res[i].iCount,result[i].iTime);  \
sl@0: 			}
sl@0: #else /* __PROFILING__ */
sl@0: #define __PROFILE_START(aBin) 
sl@0: #define __PROFILE_END(aBin)   
sl@0: #define __PROFILE_RESET(aNumberOfBins) 
sl@0: #define __PROFILE_DISPLAY(aNumberOfBins)
sl@0: #endif
sl@0: 
sl@0: #if defined(_DEBUG)
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Marks the start of Kernel heap checking. 
sl@0: 
sl@0: Checking the Kernel heap is only useful when developing Kernel side code such 
sl@0: as device drivers and media drivers.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: This macro must be matched by a corresponding call to __KHEAP_MARKEND or __KHEAP_MARKENDC. 
sl@0: Calls to this macro can be nested but each call must be matched by corresponding 
sl@0: call to __KHEAP_MARKEND or __KHEAP_MARKENDC.
sl@0: 
sl@0: @see User::__DbgMarkStart()
sl@0: @see __KHEAP_MARKEND
sl@0: @see __KHEAP_MARKENDC
sl@0: */
sl@0: #define __KHEAP_MARK User::__DbgMarkStart(TRUE)
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Checks that the number of allocated cells at the current nested level of the 
sl@0: Kernel heap is the same as the specified value. This macro is defined only 
sl@0: for debug builds. Checking the Kernel heap is only useful when developing 
sl@0: Kernel side code such as device drivers and media drivers.
sl@0: 
sl@0: The macro also takes the name of the file containing this source code statement 
sl@0: and the line number of this source code statement; they are displayed as part 
sl@0: of the panic category, if the checks fail.
sl@0: 
sl@0: @param aCount The number of heap cells expected to be allocated at
sl@0:               the current nest level.
sl@0: 
sl@0: @see User::__DbgMarkCheck()
sl@0: @see __UHEAP_CHECK
sl@0: */
sl@0: #define __KHEAP_CHECK(aCount) User::__DbgMarkCheck(TRUE,FALSE,aCount,(TText8*)__FILE__,__LINE__)
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Checks that the total number of allocated cells on the Kernel heap is the same 
sl@0: as the specified value.
sl@0: 
sl@0: It is only useful when developing Kernel side code such as device drivers 
sl@0: and media drivers. 
sl@0: 
sl@0: The macro also takes the name of the file containing this source code statement 
sl@0: and the line number of this source code statement; they are displayed as part 
sl@0: of the panic category, if the checks fail.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: @param aCount The total number of heap cells expected to be allocated
sl@0: 
sl@0: @see User::__DbgMarkCheck()
sl@0: @see __UHEAP_CHECKALL
sl@0: */
sl@0: #define __KHEAP_CHECKALL(aCount) User::__DbgMarkCheck(TRUE,TRUE,aCount,(TText8*)__FILE__,__LINE__)
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Marks the end of Kernel heap checking. The macro expects zero heap cells to 
sl@0: remain allocated at the current nest level.
sl@0: 
sl@0: This macro is defined only for debug builds. Checking the Kernel heap is only 
sl@0: useful when developing Kernel side code such as device drivers and media drivers.
sl@0: 
sl@0: This macro must match an earlier call to __KHEAP_MARK.
sl@0: 
sl@0: @see User::__DbgMarkEnd()
sl@0: @see __KHEAP_MARK
sl@0: */
sl@0: #define __KHEAP_MARKEND User::__DbgMarkEnd(TRUE,0)
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Marks the end of Kernel heap checking. The macro expects aCount heap cells 
sl@0: to remain allocated at the current nest level.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: This macro must match an earlier call to __KHEAP_MARK.
sl@0: 
sl@0: @param aCount The number of heap cells expected to remain allocated at
sl@0:               the current nest level.
sl@0: 
sl@0: @see User::__DbgMarkEnd()
sl@0: @see __KHEAP_MARK
sl@0: */
sl@0: #define __KHEAP_MARKENDC(aCount) User::__DbgMarkEnd(TRUE,aCount)
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Simulates Kernel heap allocation failure. The failure occurs on the next call 
sl@0: to new or any of the functions which allocate memory from the heap. This macro 
sl@0: is defined only for debug builds.
sl@0: 
sl@0: Checking the Kernel heap is only useful when developing Kernel side code such 
sl@0: as device drivers and media drivers.
sl@0: 
sl@0: @param aCount The rate of failure - heap allocation fails every aCount attempt.
sl@0: 
sl@0: @see User::__DbgSetAllocFail()
sl@0: */
sl@0: #define __KHEAP_FAILNEXT(aCount) User::__DbgSetAllocFail(TRUE,RAllocator::EFailNext,aCount)
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Simulates Kernel heap allocation failures. aBurst failures will occur on the next call 
sl@0: to new or any of the functions which allocate memory from the heap. This macro 
sl@0: is defined only for debug builds.
sl@0: 
sl@0: Checking the Kernel heap is only useful when developing Kernel side code such 
sl@0: as device drivers and media drivers.
sl@0: 
sl@0: @param aCount The heap allocation will fail after aCount-1 allocation attempts. 
sl@0:               Note when used with RHeap the maximum value aCount can be set 
sl@0:               to is KMaxTUint16.
sl@0: @param aBurst The number of allocations that will fail after aCount-1 allocation 
sl@0:               attempts.  Note when used with RHeap the maximum value aBurst can be 
sl@0:               set to is KMaxTUint16.
sl@0: 
sl@0: 
sl@0: @see User::__DbgSetBurstAllocFail()
sl@0: */
sl@0: #define __KHEAP_BURSTFAILNEXT(aCount,aBurst) User::__DbgSetBurstAllocFail(TRUE,RAllocator::EBurstFailNext,aCount,aBurst)
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Simulates Kernel heap allocation failure. 
sl@0: 
sl@0: The failure occurs on subsequent calls to new or any of the functions which 
sl@0: allocate memory from this heap.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: @param aType  The type of failure to be simulated.
sl@0: @param aRate The failure rate.
sl@0: 
sl@0: @see RAllocator::TAllocFail
sl@0: @see User::__DbgSetAllocFail()
sl@0: */
sl@0: #define __KHEAP_SETFAIL(aType,aRate) User::__DbgSetAllocFail(TRUE,aType,aRate)
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Simulates Kernel heap allocation failure. 
sl@0: 
sl@0: The failure occurs on subsequent calls to new or any of the functions which 
sl@0: allocate memory from this heap.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: @param aType  The type of failure to be simulated.
sl@0: @param aRate  The failure rate.  Note when used with RHeap the maximum value 
sl@0:               aRate can be set to is KMaxTUint16.
sl@0: @param aBurst The number of consecutive allocations that will fail.  Note 
sl@0:               when used with RHeap the maximum value aBurst can be set to 
sl@0:               is KMaxTUint16.
sl@0: 
sl@0: @see RAllocator::TAllocFail
sl@0: @see User::__DbgSetBurstAllocFail()
sl@0: */
sl@0: #define __KHEAP_SETBURSTFAIL(aType,aRate,aBurst) User::__DbgSetBurstAllocFail(TRUE,aType,aRate,aBurst)
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Cancels simulated Kernel heap allocation failure. 
sl@0: 
sl@0: Checking the Kernel heap is only useful when developing Kernel side code such 
sl@0: as device drivers and media drivers.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: @see User::__DbgSetAllocFail()
sl@0: */
sl@0: #define __KHEAP_RESET User::__DbgSetAllocFail(TRUE,RAllocator::ENone,1)
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Cancels simulated kernel heap allocation failure. 
sl@0: It walks the the heap and sets the nesting level for all allocated
sl@0: cells to zero.
sl@0: 
sl@0: Checking the kernel heap is only useful when developing kernel side code such 
sl@0: as device drivers and media drivers.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: */
sl@0: #define __KHEAP_TOTAL_RESET User::__DbgSetAllocFail(TRUE,RAllocator::EReset,1)
sl@0: 
sl@0: #else
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Marks the start of Kernel heap checking. 
sl@0: 
sl@0: Checking the Kernel heap is only useful when developing Kernel side code such 
sl@0: as device drivers and media drivers.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: This macro must be matched by a corresponding call to __KHEAP_MARKEND or __KHEAP_MARKENDC. 
sl@0: Calls to this macro can be nested but each call must be matched by corresponding 
sl@0: call to __KHEAP_MARKEND or __KHEAP_MARKENDC.
sl@0: 
sl@0: @see User::__DbgMarkStart()
sl@0: @see __KHEAP_MARKEND
sl@0: @see __KHEAP_MARKENDC
sl@0: */
sl@0: #define __KHEAP_MARK
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Checks that the number of allocated cells at the current nested level of the 
sl@0: Kernel heap is the same as the specified value. This macro is defined only 
sl@0: for debug builds. Checking the Kernel heap is only useful when developing 
sl@0: Kernel side code such as device drivers and media drivers.
sl@0: 
sl@0: The macro also takes the name of the file containing this source code statement 
sl@0: and the line number of this source code statement; they are displayed as part 
sl@0: of the panic category, if the checks fail.
sl@0: 
sl@0: @param aCount The number of heap cells expected to be allocated at
sl@0:               the current nest level.
sl@0: 
sl@0: @see User::__DbgMarkCheck()
sl@0: @see __UHEAP_CHECK
sl@0: */
sl@0: #define __KHEAP_CHECK(aCount)
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Checks that the total number of allocated cells on the Kernel heap is the same 
sl@0: as the specified value.
sl@0: 
sl@0: It is only useful when developing Kernel side code such as device drivers 
sl@0: and media drivers. 
sl@0: 
sl@0: The macro also takes the name of the file containing this source code statement 
sl@0: and the line number of this source code statement; they are displayed as part 
sl@0: of the panic category, if the checks fail.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: @param aCount The total number of heap cells expected to be allocated
sl@0: 
sl@0: @see User::__DbgMarkCheck()
sl@0: @see __UHEAP_CHECKALL
sl@0: */
sl@0: #define __KHEAP_CHECKALL(aCount)
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Marks the end of Kernel heap checking. The macro expects zero heap cells to 
sl@0: remain allocated at the current nest level.
sl@0: 
sl@0: This macro is defined only for debug builds. Checking the Kernel heap is only 
sl@0: useful when developing Kernel side code such as device drivers and media drivers.
sl@0: 
sl@0: This macro must match an earlier call to __KHEAP_MARK.
sl@0: 
sl@0: @see User::__DbgMarkEnd()
sl@0: @see __KHEAP_MARK
sl@0: */
sl@0: #define __KHEAP_MARKEND
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Marks the end of Kernel heap checking. The macro expects aCount heap cells 
sl@0: to remain allocated at the current nest level.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: This macro must match an earlier call to __KHEAP_MARK.
sl@0: 
sl@0: @param aCount The number of heap cells expected to remain allocated at
sl@0:               the current nest level.
sl@0: 
sl@0: @see User::__DbgMarkEnd()
sl@0: @see __KHEAP_MARK
sl@0: */
sl@0: #define __KHEAP_MARKENDC(aCount)
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Simulates Kernel heap allocation failure. The failure occurs on the next call 
sl@0: to new or any of the functions which allocate memory from the heap. This macro 
sl@0: is defined only for debug builds.
sl@0: 
sl@0: Checking the Kernel heap is only useful when developing Kernel side code such 
sl@0: as device drivers and media drivers.
sl@0: 
sl@0: @param aCount The rate of failure - heap allocation fails every aCount attempt.
sl@0: 
sl@0: @see User::__DbgSetAllocFail()
sl@0: */
sl@0: #define __KHEAP_FAILNEXT(aCount)
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Simulates Kernel heap allocation failures. aBurst failures will occur on the next call 
sl@0: to new or any of the functions which allocate memory from the heap. This macro 
sl@0: is defined only for debug builds.
sl@0: 
sl@0: Checking the Kernel heap is only useful when developing Kernel side code such 
sl@0: as device drivers and media drivers.
sl@0: 
sl@0: @param aCount The heap allocation will fail after aCount-1 allocation attempts.  
sl@0:               Note when used with RHeap the maximum value aCount can be set 
sl@0:               to is KMaxTUint16.
sl@0: @param aBurst The number of allocations that will fail after aCount-1 allocation
sl@0:               attempts.  Note when used with RHeap the maximum value aBurst can 
sl@0:               be set to is KMaxTUint16.
sl@0: 
sl@0: @see User::__DbgSetBurstAllocFail()
sl@0: */
sl@0: #define __KHEAP_BURSTFAILNEXT(aCount,aBurst)
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Simulates Kernel heap allocation failure. 
sl@0: 
sl@0: The failure occurs on subsequent calls to new or any of the functions which 
sl@0: allocate memory from this heap.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: @param aType  The type of failure to be simulated.
sl@0: @param aRate The failure rate.
sl@0: 
sl@0: @see User::__DbgSetAllocFail()
sl@0: */
sl@0: #define __KHEAP_SETFAIL(aType,aRate)
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Simulates Kernel heap allocation failure. 
sl@0: 
sl@0: The failure occurs on subsequent calls to new or any of the functions which 
sl@0: allocate memory from this heap.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: @param aType  The type of failure to be simulated.
sl@0: @param aRate  The failure rate.  Note when used with RHeap the maximum value 
sl@0:               aRate can be set to is KMaxTUint16.
sl@0: @param aBurst The number of consecutive allocations that will fail.  Note 
sl@0:               when used with RHeap the maximum value aBurst can be set 
sl@0:               to is KMaxTUint16.
sl@0: 
sl@0: @see User::__DbgSetBurstAllocFail()
sl@0: */
sl@0: #define __KHEAP_SETBURSTFAIL(aType,aRate,aBurst)
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Cancels simulated Kernel heap allocation failure. 
sl@0: 
sl@0: Checking the Kernel heap is only useful when developing Kernel side code such 
sl@0: as device drivers and media drivers.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: 
sl@0: @see User::__DbgSetAllocFail()
sl@0: */
sl@0: #define __KHEAP_RESET
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: Cancels simulated kernel heap allocation failure. 
sl@0: It walks the the heap and sets the nesting level for all allocated
sl@0: cells to zero.
sl@0: 
sl@0: Checking the kernel heap is only useful when developing kernel side code such 
sl@0: as device drivers and media drivers.
sl@0: 
sl@0: This macro is defined only for debug builds.
sl@0: */
sl@0: #define __KHEAP_TOTAL_RESET
sl@0: #endif
sl@0: 
sl@0: #ifndef __VALUE_IN_REGS__ 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: */
sl@0: #define __VALUE_IN_REGS__ 
sl@0: #endif
sl@0: 
sl@0: 
sl@0: /** @internalTechnology */
sl@0: #define __NO_MUTABLE_KEYWORD
sl@0: 
sl@0: 
sl@0: /**
sl@0: @internalTechnology
sl@0: 
sl@0: A sorted list of all the code segments in ROM that contain an Exception Descriptor.
sl@0: 
sl@0: */
sl@0: typedef struct TRomExceptionSearchTable
sl@0: 	{
sl@0: 	/**
sl@0: 	The number of entries in the following table.
sl@0: 	*/
sl@0: 	TInt32 iNumEntries;
sl@0: 	
sl@0: 	/**
sl@0: 	Address of the code segment of each TRomImageHeader that has an Exception Descriptor.
sl@0: 	*/
sl@0: 	TLinAddr iEntries[1];
sl@0: 	} TRomExceptionSearchTable;
sl@0: 	
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: typedef struct TExceptionDescriptor 
sl@0: 	{
sl@0: 	TLinAddr iExIdxBase;
sl@0: 	TLinAddr iExIdxLimit;
sl@0: 	TLinAddr iROSegmentBase;
sl@0: 	TLinAddr iROSegmentLimit;
sl@0: 	} TExceptionDescriptor;
sl@0: 	
sl@0: #ifdef __KERNEL_MODE__
sl@0: 
sl@0: /** @internalComponent */
sl@0: #define	KIMPORT_C	IMPORT_C
sl@0: 
sl@0: /** @internalComponent */
sl@0: #define	KEXPORT_C	EXPORT_C
sl@0: 
sl@0: #else
sl@0: #define	KIMPORT_C
sl@0: #define	KEXPORT_C
sl@0: #endif
sl@0: 
sl@0: #endif //__E32DEF_PRIVATE_H__