|
sl@0
|
1 |
/**
|
|
sl@0
|
2 |
* Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of the License "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
* Trace API
|
|
sl@0
|
16 |
* ---------------TTraceContext-----------------------
|
|
sl@0
|
17 |
*
|
|
sl@0
|
18 |
*/
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
/**
|
|
sl@0
|
24 |
@file
|
|
sl@0
|
25 |
@publishedPartner
|
|
sl@0
|
26 |
@prototype
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
Define the context of a trace packet by setting its attributes.
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
The module UID is defaulted according to the FW_DEFAULT_MODULEUID definition.
|
|
sl@0
|
31 |
The HasThreadIdentification is defaulted to the FW_DEFAULT_HAS_THREAD_IDENTIFICATION definition.
|
|
sl@0
|
32 |
The HasProgramCounter is defaulted to the FW_DEFAULT_HAS_PC definition.
|
|
sl@0
|
33 |
|
|
sl@0
|
34 |
@param aClassification @see TClassification
|
|
sl@0
|
35 |
|
|
sl@0
|
36 |
*/
|
|
sl@0
|
37 |
TTraceContext::TTraceContext(const TClassification aClassification)
|
|
sl@0
|
38 |
:iModuleUid(FW_DEFAULT_MODULEUID), iClassification(aClassification), iHasThreadIdentification(FW_DEFAULT_HAS_THREAD_IDENTIFICATION), iHasProgramCounter(FW_DEFAULT_HAS_PC), iReserved1(0), iReserved2(0)
|
|
sl@0
|
39 |
{
|
|
sl@0
|
40 |
}
|
|
sl@0
|
41 |
|
|
sl@0
|
42 |
/**
|
|
sl@0
|
43 |
* Define the context of a trace packet by setting its attributes.
|
|
sl@0
|
44 |
*
|
|
sl@0
|
45 |
* The HasThreadIdentification is defaulted to the FW_DEFAULT_HAS_THREAD_IDENTIFICATION definition.
|
|
sl@0
|
46 |
* The HasProgramCounter is defaulted to the FW_DEFAULT_HAS_PC definition.
|
|
sl@0
|
47 |
*
|
|
sl@0
|
48 |
* @param aModuleUid @see TModuleUid
|
|
sl@0
|
49 |
* @param aClassification @see TClassification
|
|
sl@0
|
50 |
*/
|
|
sl@0
|
51 |
TTraceContext::TTraceContext(const TModuleUid aModuleUid, const TClassification aClassification)
|
|
sl@0
|
52 |
:iModuleUid(aModuleUid), iClassification(aClassification), iHasThreadIdentification(FW_DEFAULT_HAS_THREAD_IDENTIFICATION), iHasProgramCounter(FW_DEFAULT_HAS_PC), iReserved1(0), iReserved2(0)
|
|
sl@0
|
53 |
{
|
|
sl@0
|
54 |
}
|
|
sl@0
|
55 |
|
|
sl@0
|
56 |
/**
|
|
sl@0
|
57 |
* Define the context of a trace packet by setting its attributes.
|
|
sl@0
|
58 |
*
|
|
sl@0
|
59 |
* The module UID is defaulted according to the FW_DEFAULT_MODULEUID definition.
|
|
sl@0
|
60 |
*
|
|
sl@0
|
61 |
* @param aClassification @see TClassification
|
|
sl@0
|
62 |
* @param aHasThreadIdentification Set whether to add thread identification automatically in the trace packet.
|
|
sl@0
|
63 |
* @param aHasProgramCounter Set whether to add PC (program counter) automatically in the trace packet.
|
|
sl@0
|
64 |
*/
|
|
sl@0
|
65 |
TTraceContext::TTraceContext(const TClassification aClassification, const THasThreadIdentification aHasThreadIdentification, const THasProgramCounter aHasProgramCounter)
|
|
sl@0
|
66 |
:iModuleUid(FW_DEFAULT_MODULEUID), iClassification(aClassification), iHasThreadIdentification(aHasThreadIdentification), iHasProgramCounter(aHasProgramCounter), iReserved1(0), iReserved2(0)
|
|
sl@0
|
67 |
{
|
|
sl@0
|
68 |
}
|
|
sl@0
|
69 |
|
|
sl@0
|
70 |
|
|
sl@0
|
71 |
/**
|
|
sl@0
|
72 |
* Define the context of a trace packet by setting its attributes.
|
|
sl@0
|
73 |
*
|
|
sl@0
|
74 |
* @param aModuleUid @see TModuleUid
|
|
sl@0
|
75 |
* @param aClassification @see TClassification
|
|
sl@0
|
76 |
* @param aHasThreadIdentification Set whether to add thread identification automatically in the trace packet.
|
|
sl@0
|
77 |
* @param aHasProgramCounter Set whether to add PC (program counter) automatically in the trace packet.
|
|
sl@0
|
78 |
*/
|
|
sl@0
|
79 |
TTraceContext::TTraceContext(const TModuleUid aModuleUid, const TClassification aClassification, const THasThreadIdentification aHasThreadIdentification, const THasProgramCounter aHasProgramCounter)
|
|
sl@0
|
80 |
:iModuleUid(aModuleUid), iClassification(aClassification), iHasThreadIdentification(aHasThreadIdentification), iHasProgramCounter(aHasProgramCounter), iReserved1(0), iReserved2(0)
|
|
sl@0
|
81 |
{
|
|
sl@0
|
82 |
}
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
//------------------ Trace -----------------------
|
|
sl@0
|
85 |
/**
|
|
sl@0
|
86 |
Outputs a trace packet containing variable length data.
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
If the specified data is too big to fit into a single
|
|
sl@0
|
89 |
trace record a multipart trace is generated.
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
@param aContext Attributes of the trace point.
|
|
sl@0
|
92 |
@param aFormatId A format identifier as specified by @see TFormatId
|
|
sl@0
|
93 |
@param aData Additional data to add to trace packet.
|
|
sl@0
|
94 |
Must be word aligned, i.e. a multiple of 4.
|
|
sl@0
|
95 |
|
|
sl@0
|
96 |
@return The trace packet was/was not logged.
|
|
sl@0
|
97 |
|
|
sl@0
|
98 |
@See BTrace::TMultipart
|
|
sl@0
|
99 |
*/
|
|
sl@0
|
100 |
template<typename T>
|
|
sl@0
|
101 |
TBool Trace(const TTraceContext& aContext, TFormatId aFormatId, const T& aData)
|
|
sl@0
|
102 |
{
|
|
sl@0
|
103 |
return Trace(aContext, aFormatId, &aData, sizeof(aData));
|
|
sl@0
|
104 |
}
|
|
sl@0
|
105 |
|