author | Pat Downey <patrick.downey@nokia.com> |
Thu, 25 Jun 2009 15:59:54 +0100 | |
changeset 1 | 0a7b44b10206 |
child 2 | 806186ab5e14 |
permissions | -rw-r--r-- |
1
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
1 |
// Copyright (c) 1994-2009 Nokia Corporation and/or its subsidiary(-ies). |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
2 |
// All rights reserved. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
3 |
// This component and the accompanying materials are made available |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
4 |
// under the terms of the License "Symbian Foundation License v1.0" |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
5 |
// which accompanies this distribution, and is available |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
6 |
// at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html". |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
7 |
// |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
8 |
// Initial Contributors: |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
9 |
// Nokia Corporation - initial contribution. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
10 |
// |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
11 |
// Contributors: |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
12 |
// |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
13 |
// Description: |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
14 |
// e32\include\e32def_private.h |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
15 |
// |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
16 |
// |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
17 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
18 |
#ifndef __E32DEF_PRIVATE_H__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
19 |
#define __E32DEF_PRIVATE_H__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
20 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
21 |
#ifdef __PROFILING__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
22 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
23 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
24 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
25 |
@removed |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
26 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
27 |
#define __PROFILE_START(aBin) RDebug::ProfileStart(aBin) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
28 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
29 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
30 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
31 |
@removed |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
32 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
33 |
#define __PROFILE_END(aBin) RDebug::ProfileEnd(aBin) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
34 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
35 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
36 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
37 |
@removed |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
38 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
39 |
#define __PROFILE_RESET(aNumberOfBins) RDebug::ProfileReset(0,aNumberOfBins) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
40 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
41 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
42 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
43 |
@removed |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
44 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
45 |
#define __PROFILE_DISPLAY(aNumberOfBins) \ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
46 |
{ TFixedArray<TProfile, aNumberOfBins> result; \ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
47 |
RDebug::ProfileResult(result.Begin(), 0, aNumberOfBins); \ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
48 |
for (TInt i=0; i<aNumberOfBins; i++) \ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
49 |
RDebug::Print(_L("Profile bin %d: Calls: %d, Clock ticks: %d\n" ),i,res[i].iCount,result[i].iTime); \ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
50 |
} |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
51 |
#else /* __PROFILING__ */ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
52 |
#define __PROFILE_START(aBin) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
53 |
#define __PROFILE_END(aBin) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
54 |
#define __PROFILE_RESET(aNumberOfBins) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
55 |
#define __PROFILE_DISPLAY(aNumberOfBins) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
56 |
#endif |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
57 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
58 |
#if defined(_DEBUG) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
59 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
60 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
61 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
62 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
63 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
64 |
Marks the start of Kernel heap checking. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
65 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
66 |
Checking the Kernel heap is only useful when developing Kernel side code such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
67 |
as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
68 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
69 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
70 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
71 |
This macro must be matched by a corresponding call to __KHEAP_MARKEND or __KHEAP_MARKENDC. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
72 |
Calls to this macro can be nested but each call must be matched by corresponding |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
73 |
call to __KHEAP_MARKEND or __KHEAP_MARKENDC. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
74 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
75 |
@see User::__DbgMarkStart() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
76 |
@see __KHEAP_MARKEND |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
77 |
@see __KHEAP_MARKENDC |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
78 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
79 |
#define __KHEAP_MARK User::__DbgMarkStart(TRUE) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
80 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
81 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
82 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
83 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
84 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
85 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
86 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
87 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
88 |
Checks that the number of allocated cells at the current nested level of the |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
89 |
Kernel heap is the same as the specified value. This macro is defined only |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
90 |
for debug builds. Checking the Kernel heap is only useful when developing |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
91 |
Kernel side code such as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
92 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
93 |
The macro also takes the name of the file containing this source code statement |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
94 |
and the line number of this source code statement; they are displayed as part |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
95 |
of the panic category, if the checks fail. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
96 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
97 |
@param aCount The number of heap cells expected to be allocated at |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
98 |
the current nest level. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
99 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
100 |
@see User::__DbgMarkCheck() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
101 |
@see __UHEAP_CHECK |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
102 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
103 |
#define __KHEAP_CHECK(aCount) User::__DbgMarkCheck(TRUE,FALSE,aCount,(TText8*)__FILE__,__LINE__) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
104 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
105 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
106 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
107 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
108 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
109 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
110 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
111 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
112 |
Checks that the total number of allocated cells on the Kernel heap is the same |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
113 |
as the specified value. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
114 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
115 |
It is only useful when developing Kernel side code such as device drivers |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
116 |
and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
117 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
118 |
The macro also takes the name of the file containing this source code statement |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
119 |
and the line number of this source code statement; they are displayed as part |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
120 |
of the panic category, if the checks fail. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
121 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
122 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
123 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
124 |
@param aCount The total number of heap cells expected to be allocated |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
125 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
126 |
@see User::__DbgMarkCheck() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
127 |
@see __UHEAP_CHECKALL |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
128 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
129 |
#define __KHEAP_CHECKALL(aCount) User::__DbgMarkCheck(TRUE,TRUE,aCount,(TText8*)__FILE__,__LINE__) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
130 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
131 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
132 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
133 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
134 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
135 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
136 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
137 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
138 |
Marks the end of Kernel heap checking. The macro expects zero heap cells to |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
139 |
remain allocated at the current nest level. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
140 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
141 |
This macro is defined only for debug builds. Checking the Kernel heap is only |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
142 |
useful when developing Kernel side code such as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
143 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
144 |
This macro must match an earlier call to __KHEAP_MARK. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
145 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
146 |
@see User::__DbgMarkEnd() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
147 |
@see __KHEAP_MARK |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
148 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
149 |
#define __KHEAP_MARKEND User::__DbgMarkEnd(TRUE,0) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
150 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
151 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
152 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
153 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
154 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
155 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
156 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
157 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
158 |
Marks the end of Kernel heap checking. The macro expects aCount heap cells |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
159 |
to remain allocated at the current nest level. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
160 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
161 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
162 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
163 |
This macro must match an earlier call to __KHEAP_MARK. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
164 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
165 |
@param aCount The number of heap cells expected to remain allocated at |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
166 |
the current nest level. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
167 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
168 |
@see User::__DbgMarkEnd() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
169 |
@see __KHEAP_MARK |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
170 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
171 |
#define __KHEAP_MARKENDC(aCount) User::__DbgMarkEnd(TRUE,aCount) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
172 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
173 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
174 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
175 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
176 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
177 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
178 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
179 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
180 |
Simulates Kernel heap allocation failure. The failure occurs on the next call |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
181 |
to new or any of the functions which allocate memory from the heap. This macro |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
182 |
is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
183 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
184 |
Checking the Kernel heap is only useful when developing Kernel side code such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
185 |
as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
186 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
187 |
@param aCount The rate of failure - heap allocation fails every aCount attempt. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
188 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
189 |
@see User::__DbgSetAllocFail() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
190 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
191 |
#define __KHEAP_FAILNEXT(aCount) User::__DbgSetAllocFail(TRUE,RAllocator::EFailNext,aCount) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
192 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
193 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
194 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
195 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
196 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
197 |
Simulates Kernel heap allocation failures. aBurst failures will occur on the next call |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
198 |
to new or any of the functions which allocate memory from the heap. This macro |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
199 |
is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
200 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
201 |
Checking the Kernel heap is only useful when developing Kernel side code such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
202 |
as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
203 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
204 |
@param aCount The heap allocation will fail after aCount-1 allocation attempts. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
205 |
Note when used with RHeap the maximum value aCount can be set |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
206 |
to is KMaxTUint16. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
207 |
@param aBurst The number of allocations that will fail after aCount-1 allocation |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
208 |
attempts. Note when used with RHeap the maximum value aBurst can be |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
209 |
set to is KMaxTUint16. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
210 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
211 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
212 |
@see User::__DbgSetBurstAllocFail() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
213 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
214 |
#define __KHEAP_BURSTFAILNEXT(aCount,aBurst) User::__DbgSetBurstAllocFail(TRUE,RAllocator::EBurstFailNext,aCount,aBurst) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
215 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
216 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
217 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
218 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
219 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
220 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
221 |
Simulates Kernel heap allocation failure. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
222 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
223 |
The failure occurs on subsequent calls to new or any of the functions which |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
224 |
allocate memory from this heap. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
225 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
226 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
227 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
228 |
@param aType The type of failure to be simulated. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
229 |
@param aRate The failure rate. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
230 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
231 |
@see RAllocator::TAllocFail |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
232 |
@see User::__DbgSetAllocFail() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
233 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
234 |
#define __KHEAP_SETFAIL(aType,aRate) User::__DbgSetAllocFail(TRUE,aType,aRate) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
235 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
236 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
237 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
238 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
239 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
240 |
Simulates Kernel heap allocation failure. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
241 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
242 |
The failure occurs on subsequent calls to new or any of the functions which |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
243 |
allocate memory from this heap. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
244 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
245 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
246 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
247 |
@param aType The type of failure to be simulated. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
248 |
@param aRate The failure rate. Note when used with RHeap the maximum value |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
249 |
aRate can be set to is KMaxTUint16. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
250 |
@param aBurst The number of consecutive allocations that will fail. Note |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
251 |
when used with RHeap the maximum value aBurst can be set to |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
252 |
is KMaxTUint16. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
253 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
254 |
@see RAllocator::TAllocFail |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
255 |
@see User::__DbgSetBurstAllocFail() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
256 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
257 |
#define __KHEAP_SETBURSTFAIL(aType,aRate,aBurst) User::__DbgSetBurstAllocFail(TRUE,aType,aRate,aBurst) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
258 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
259 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
260 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
261 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
262 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
263 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
264 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
265 |
Cancels simulated Kernel heap allocation failure. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
266 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
267 |
Checking the Kernel heap is only useful when developing Kernel side code such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
268 |
as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
269 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
270 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
271 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
272 |
@see User::__DbgSetAllocFail() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
273 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
274 |
#define __KHEAP_RESET User::__DbgSetAllocFail(TRUE,RAllocator::ENone,1) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
275 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
276 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
277 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
278 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
279 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
280 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
281 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
282 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
283 |
Cancels simulated kernel heap allocation failure. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
284 |
It walks the the heap and sets the nesting level for all allocated |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
285 |
cells to zero. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
286 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
287 |
Checking the kernel heap is only useful when developing kernel side code such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
288 |
as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
289 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
290 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
291 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
292 |
#define __KHEAP_TOTAL_RESET User::__DbgSetAllocFail(TRUE,RAllocator::EReset,1) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
293 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
294 |
#else |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
295 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
296 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
297 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
298 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
299 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
300 |
Marks the start of Kernel heap checking. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
301 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
302 |
Checking the Kernel heap is only useful when developing Kernel side code such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
303 |
as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
304 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
305 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
306 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
307 |
This macro must be matched by a corresponding call to __KHEAP_MARKEND or __KHEAP_MARKENDC. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
308 |
Calls to this macro can be nested but each call must be matched by corresponding |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
309 |
call to __KHEAP_MARKEND or __KHEAP_MARKENDC. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
310 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
311 |
@see User::__DbgMarkStart() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
312 |
@see __KHEAP_MARKEND |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
313 |
@see __KHEAP_MARKENDC |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
314 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
315 |
#define __KHEAP_MARK |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
316 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
317 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
318 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
319 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
320 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
321 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
322 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
323 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
324 |
Checks that the number of allocated cells at the current nested level of the |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
325 |
Kernel heap is the same as the specified value. This macro is defined only |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
326 |
for debug builds. Checking the Kernel heap is only useful when developing |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
327 |
Kernel side code such as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
328 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
329 |
The macro also takes the name of the file containing this source code statement |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
330 |
and the line number of this source code statement; they are displayed as part |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
331 |
of the panic category, if the checks fail. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
332 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
333 |
@param aCount The number of heap cells expected to be allocated at |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
334 |
the current nest level. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
335 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
336 |
@see User::__DbgMarkCheck() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
337 |
@see __UHEAP_CHECK |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
338 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
339 |
#define __KHEAP_CHECK(aCount) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
340 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
341 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
342 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
343 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
344 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
345 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
346 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
347 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
348 |
Checks that the total number of allocated cells on the Kernel heap is the same |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
349 |
as the specified value. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
350 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
351 |
It is only useful when developing Kernel side code such as device drivers |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
352 |
and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
353 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
354 |
The macro also takes the name of the file containing this source code statement |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
355 |
and the line number of this source code statement; they are displayed as part |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
356 |
of the panic category, if the checks fail. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
357 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
358 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
359 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
360 |
@param aCount The total number of heap cells expected to be allocated |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
361 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
362 |
@see User::__DbgMarkCheck() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
363 |
@see __UHEAP_CHECKALL |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
364 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
365 |
#define __KHEAP_CHECKALL(aCount) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
366 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
367 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
368 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
369 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
370 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
371 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
372 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
373 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
374 |
Marks the end of Kernel heap checking. The macro expects zero heap cells to |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
375 |
remain allocated at the current nest level. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
376 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
377 |
This macro is defined only for debug builds. Checking the Kernel heap is only |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
378 |
useful when developing Kernel side code such as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
379 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
380 |
This macro must match an earlier call to __KHEAP_MARK. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
381 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
382 |
@see User::__DbgMarkEnd() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
383 |
@see __KHEAP_MARK |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
384 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
385 |
#define __KHEAP_MARKEND |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
386 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
387 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
388 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
389 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
390 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
391 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
392 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
393 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
394 |
Marks the end of Kernel heap checking. The macro expects aCount heap cells |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
395 |
to remain allocated at the current nest level. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
396 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
397 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
398 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
399 |
This macro must match an earlier call to __KHEAP_MARK. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
400 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
401 |
@param aCount The number of heap cells expected to remain allocated at |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
402 |
the current nest level. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
403 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
404 |
@see User::__DbgMarkEnd() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
405 |
@see __KHEAP_MARK |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
406 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
407 |
#define __KHEAP_MARKENDC(aCount) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
408 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
409 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
410 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
411 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
412 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
413 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
414 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
415 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
416 |
Simulates Kernel heap allocation failure. The failure occurs on the next call |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
417 |
to new or any of the functions which allocate memory from the heap. This macro |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
418 |
is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
419 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
420 |
Checking the Kernel heap is only useful when developing Kernel side code such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
421 |
as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
422 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
423 |
@param aCount The rate of failure - heap allocation fails every aCount attempt. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
424 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
425 |
@see User::__DbgSetAllocFail() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
426 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
427 |
#define __KHEAP_FAILNEXT(aCount) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
428 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
429 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
430 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
431 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
432 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
433 |
Simulates Kernel heap allocation failures. aBurst failures will occur on the next call |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
434 |
to new or any of the functions which allocate memory from the heap. This macro |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
435 |
is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
436 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
437 |
Checking the Kernel heap is only useful when developing Kernel side code such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
438 |
as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
439 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
440 |
@param aCount The heap allocation will fail after aCount-1 allocation attempts. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
441 |
Note when used with RHeap the maximum value aCount can be set |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
442 |
to is KMaxTUint16. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
443 |
@param aBurst The number of allocations that will fail after aCount-1 allocation |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
444 |
attempts. Note when used with RHeap the maximum value aBurst can |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
445 |
be set to is KMaxTUint16. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
446 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
447 |
@see User::__DbgSetBurstAllocFail() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
448 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
449 |
#define __KHEAP_BURSTFAILNEXT(aCount,aBurst) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
450 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
451 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
452 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
453 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
454 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
455 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
456 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
457 |
Simulates Kernel heap allocation failure. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
458 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
459 |
The failure occurs on subsequent calls to new or any of the functions which |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
460 |
allocate memory from this heap. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
461 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
462 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
463 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
464 |
@param aType The type of failure to be simulated. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
465 |
@param aRate The failure rate. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
466 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
467 |
@see User::__DbgSetAllocFail() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
468 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
469 |
#define __KHEAP_SETFAIL(aType,aRate) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
470 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
471 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
472 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
473 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
474 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
475 |
Simulates Kernel heap allocation failure. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
476 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
477 |
The failure occurs on subsequent calls to new or any of the functions which |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
478 |
allocate memory from this heap. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
479 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
480 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
481 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
482 |
@param aType The type of failure to be simulated. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
483 |
@param aRate The failure rate. Note when used with RHeap the maximum value |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
484 |
aRate can be set to is KMaxTUint16. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
485 |
@param aBurst The number of consecutive allocations that will fail. Note |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
486 |
when used with RHeap the maximum value aBurst can be set |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
487 |
to is KMaxTUint16. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
488 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
489 |
@see User::__DbgSetBurstAllocFail() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
490 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
491 |
#define __KHEAP_SETBURSTFAIL(aType,aRate,aBurst) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
492 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
493 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
494 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
495 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
496 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
497 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
498 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
499 |
Cancels simulated Kernel heap allocation failure. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
500 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
501 |
Checking the Kernel heap is only useful when developing Kernel side code such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
502 |
as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
503 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
504 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
505 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
506 |
@see User::__DbgSetAllocFail() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
507 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
508 |
#define __KHEAP_RESET |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
509 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
510 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
511 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
512 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
513 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
514 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
515 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
516 |
Cancels simulated kernel heap allocation failure. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
517 |
It walks the the heap and sets the nesting level for all allocated |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
518 |
cells to zero. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
519 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
520 |
Checking the kernel heap is only useful when developing kernel side code such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
521 |
as device drivers and media drivers. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
522 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
523 |
This macro is defined only for debug builds. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
524 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
525 |
#define __KHEAP_TOTAL_RESET |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
526 |
#endif |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
527 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
528 |
#ifndef __VALUE_IN_REGS__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
529 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
530 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
531 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
532 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
533 |
#define __VALUE_IN_REGS__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
534 |
#endif |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
535 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
536 |
#ifdef __REMOVE_PLATSEC_DIAGNOSTICS__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
537 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
538 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
539 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
540 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
541 |
#ifndef __REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
542 |
#define __REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
543 |
#endif /*__REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
544 |
#endif /*__REMOVE_PLATSEC_DIAGNOSTICS__*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
545 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
546 |
#ifndef __REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
547 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
548 |
@internalComponent |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
549 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
550 |
#define __PLATSEC_DIAGNOSTIC_FILE_AND_LINE_HELPER(l) #l |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
551 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
552 |
@internalComponent |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
553 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
554 |
#define __PLATSEC_DIAGNOSTIC_FILE_AND_LINE_HELPER2(f,l) f "(" __PLATSEC_DIAGNOSTIC_FILE_AND_LINE_HELPER(l) ")" |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
555 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
556 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
557 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
558 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
559 |
#define __PLATSEC_DIAGNOSTIC_FILE_AND_LINE __PLATSEC_DIAGNOSTIC_FILE_AND_LINE_HELPER2(__FILE__,__LINE__) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
560 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
561 |
#endif /* !__REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__ */ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
562 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
563 |
#ifndef __REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
564 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
565 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
566 |
@publishedPartner |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
567 |
@released |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
568 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
569 |
A macro that should be used to enclose a platform security diagnostic |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
570 |
'C' style string that can be passed to a capability checking function such |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
571 |
as RThread::HasCapability() and Kern::CurrentThreadHasCapability(). |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
572 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
573 |
The content of the string is emitted if the capability test finds that |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
574 |
the capability is not present. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
575 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
576 |
The macro provides a convenient mechanism that allows the strings to |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
577 |
be removed from future versions of Symbian OS. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
578 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
579 |
For example: |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
580 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
581 |
@code |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
582 |
if(!Kern::CurrentThreadHasCapability(ECapabilityPowerMgmt,__PLATSEC_DIAGNOSTIC_STRING("Checked by Hal function EDisplayHalSetState"))) |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
583 |
{ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
584 |
return KErrPermissionDenied; |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
585 |
} |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
586 |
@endcode |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
587 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
588 |
In this example, the string: |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
589 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
590 |
@code |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
591 |
Checked by Hal function EDisplayHalSetState |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
592 |
@endcode |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
593 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
594 |
is emitted if the calling process does not have the ECapabilityPowerMgmt capability. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
595 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
596 |
@param s A C-style string. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
597 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
598 |
@see RProcess::HasCapability() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
599 |
@see RThread::HasCapability() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
600 |
@see RMessagePtr2::HasCapability() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
601 |
@see User::CreatorHasCapability() |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
602 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
603 |
#define __PLATSEC_DIAGNOSTIC_STRING(s) s |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
604 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
605 |
#else /* __REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__ */ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
606 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
607 |
#define __PLATSEC_DIAGNOSTIC_STRING(s) NULL |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
608 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
609 |
#endif /* !__REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__ */ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
610 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
611 |
/** @internalTechnology */ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
612 |
#define __NO_MUTABLE_KEYWORD |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
613 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
614 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
615 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
616 |
@internalTechnology |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
617 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
618 |
A sorted list of all the code segments in ROM that contain an Exception Descriptor. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
619 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
620 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
621 |
typedef struct TRomExceptionSearchTable |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
622 |
{ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
623 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
624 |
The number of entries in the following table. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
625 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
626 |
TInt32 iNumEntries; |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
627 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
628 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
629 |
Address of the code segment of each TRomImageHeader that has an Exception Descriptor. |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
630 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
631 |
TLinAddr iEntries[1]; |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
632 |
} TRomExceptionSearchTable; |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
633 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
634 |
/** |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
635 |
@internalComponent |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
636 |
*/ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
637 |
typedef struct TExceptionDescriptor |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
638 |
{ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
639 |
TLinAddr iExIdxBase; |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
640 |
TLinAddr iExIdxLimit; |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
641 |
TLinAddr iROSegmentBase; |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
642 |
TLinAddr iROSegmentLimit; |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
643 |
} TExceptionDescriptor; |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
644 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
645 |
#ifdef __KERNEL_MODE__ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
646 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
647 |
/** @internalComponent */ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
648 |
#define KIMPORT_C IMPORT_C |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
649 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
650 |
/** @internalComponent */ |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
651 |
#define KEXPORT_C EXPORT_C |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
652 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
653 |
#else |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
654 |
#define KIMPORT_C |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
655 |
#define KEXPORT_C |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
656 |
#endif |
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
657 |
|
0a7b44b10206
Catch up of Symbian tools for @1627812
Pat Downey <patrick.downey@nokia.com>
parents:
diff
changeset
|
658 |
#endif //__E32DEF_PRIVATE_H__ |