1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
#include "stdafx.h"
#include "perflog.h"
#include "jitperf.h"
#include <limits.h>
#include "sstring.h"
//=============================================================================
// ALL THE PERF LOG CODE IS COMPILED ONLY IF ENABLE_PERF_LOG IS DEFINED.
#if defined (ENABLE_PERF_LOG)
//=============================================================================
//-----------------------------------------------------------------------------
// Widechar strings representing the units in UnitOfMeasure. *** Keep in sync ***
// with the array defined in PerfLog.cpp
const wchar_t * const wszUnitOfMeasureDescr[MAX_UNITS_OF_MEASURE] =
{
W(""),
W("sec"),
W("Bytes"),
W("KBytes"),
W("KBytes/sec"),
W("cycles")
};
//-----------------------------------------------------------------------------
// Widechar strings representing the "direction" property of above units.
// *** Keep in sync *** with the array defined in PerfLog.cpp
// "Direction" property is false if an increase in the value of the counter indicates
// a degrade.
// "Direction" property is true if an increase in the value of the counter indicates
// an improvement.
const wchar_t * const wszIDirection[MAX_UNITS_OF_MEASURE] =
{
W("false"),
W("false"),
W("false"),
W("false"),
W("true"),
W("false")
};
//-----------------------------------------------------------------------------
// Initialize static variables of the PerfLog class.
bool PerfLog::m_perfLogInit = false;
wchar_t PerfLog::m_wszOutStr_1[];
DWORD PerfLog::m_dwWriteByte = 0;
int PerfLog::m_fLogPerfData = 0;
HANDLE PerfLog::m_hPerfLogFileHandle = 0;
bool PerfLog::m_perfAutomationFormat = false;
bool PerfLog::m_commaSeparatedFormat = false;
//-----------------------------------------------------------------------------
// Initliaze perf logging. Must be called before calling PERFLOG (x)...
void PerfLog::PerfLogInitialize()
{
LIMITED_METHOD_CONTRACT;
// Make sure we are called only once.
if (m_perfLogInit)
{
return;
}
// First check for special cases:
#if defined(ENABLE_JIT_PERF)
// Checks the JIT_PERF_OUTPUT env var and sets g_fJitPerfOn.
InitJitPerf();
#endif
#ifdef WS_PERF
// Private working set perf stats
InitWSPerf();
#endif // WS_PERF
// Put other special cases here.
// <TODO>@TODO agk: clean this logic a bit</TODO>
// Special cases considered. Now turn on loggin if any of above want logging
// or if PERF_OUTPUT says so.
InlineSString<4> lpszValue;
// Read the env var PERF_OUTPUT and if set continue.
m_fLogPerfData = WszGetEnvironmentVariable (W("PERF_OUTPUT"), lpszValue);
#if defined(ENABLE_JIT_PERF)
if (!m_fLogPerfData)
{
// Make sure that JIT perf was not requested.
if (!g_fJitPerfOn)
return;
// JIT perf stats are needed so set the flags also.
m_fLogPerfData = 1;
}
#endif
// See if we want to output to the database
PathString _lpszValue;
DWORD _cchValue = 10; // 11 - 1
_cchValue = WszGetEnvironmentVariable (W("PerfOutput"), _lpszValue);
if (_cchValue && (wcscmp (_lpszValue, W("DBase")) == 0))
m_perfAutomationFormat = true;
if (_cchValue && (wcscmp (_lpszValue, W("CSV")) == 0))
m_commaSeparatedFormat = true;
if (PerfAutomationFormat() || CommaSeparatedFormat())
{
// Hardcoded file name for spitting the perf auotmation formatted perf data. Open
// the file here for writing and close in PerfLogDone().
m_hPerfLogFileHandle = WszCreateFile (
#ifdef PLATFORM_UNIX
W("/tmp/PerfData.dat"),
#else
W("C:\\PerfData.dat"),
#endif
GENERIC_WRITE,
FILE_SHARE_WRITE,
0,
OPEN_ALWAYS,
FILE_ATTRIBUTE_NORMAL,
0);
// check return value
if(m_hPerfLogFileHandle == INVALID_HANDLE_VALUE)
{
m_fLogPerfData = 0;
goto ErrExit;
}
// Make sure we append to the file. <TODO>@TODO agk: Is this necessary?</TODO>
if(SetFilePointer (m_hPerfLogFileHandle, 0, NULL, FILE_END) == INVALID_SET_FILE_POINTER )
{
CloseHandle (m_hPerfLogFileHandle);
m_fLogPerfData = 0;
goto ErrExit;
}
}
m_perfLogInit = true;
ErrExit:
return;
}
// Wrap up...
void PerfLog::PerfLogDone()
{
LIMITED_METHOD_CONTRACT;
#if defined(ENABLE_JIT_PERF)
DoneJitPerfStats();
#endif
#ifdef WS_PERF
// Private working set perf
OutputWSPerfStats();
#endif // WS_PERF
if (CommaSeparatedFormat())
{
if (0 == WriteFile (m_hPerfLogFileHandle, "\n", (DWORD)strlen("\n"), &m_dwWriteByte, NULL))
printf("ERROR: Could not write to perf log.\n");
}
if (PerfLoggingEnabled())
CloseHandle (m_hPerfLogFileHandle);
}
void PerfLog::OutToStdout(__in_z const wchar_t *wszName, UnitOfMeasure unit, __in_opt const wchar_t *wszDescr)
{
LIMITED_METHOD_CONTRACT;
wchar_t wszOutStr_2[PRINT_STR_LEN];
if (wszDescr)
_snwprintf_s(wszOutStr_2, PRINT_STR_LEN, PRINT_STR_LEN - 1, W(" (%s)\n"), wszDescr);
else
_snwprintf_s(wszOutStr_2, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("\n"));
printf("%S", m_wszOutStr_1);
printf("%S", wszOutStr_2);
}
void PerfLog::OutToPerfFile(__in_z const wchar_t *wszName, UnitOfMeasure unit, __in_opt const wchar_t *wszDescr)
{
LIMITED_METHOD_CONTRACT;
char szPrintStr[PRINT_STR_LEN];
if (CommaSeparatedFormat())
{
if (WszWideCharToMultiByte (CP_ACP, 0, m_wszOutStr_1, -1, szPrintStr, PRINT_STR_LEN-1, 0, 0) ) {
if (0 == WriteFile (m_hPerfLogFileHandle, szPrintStr, (DWORD)strlen(szPrintStr), &m_dwWriteByte, NULL))
printf("ERROR: Could not write to perf log.\n");
}
else
wprintf(W("ERROR: Could not do string conversion.\n"));
}
else
{
wchar_t wszOutStr_2[PRINT_STR_LEN];
// workaround. The formats for ExecTime is slightly different from a custom value.
if (wcscmp(wszName, W("ExecTime")) == 0)
_snwprintf_s(wszOutStr_2, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("ExecUnitDescr=%s\nExecIDirection=%s\n"), wszDescr, wszIDirection[unit]);
else
{
if (wszDescr)
_snwprintf_s(wszOutStr_2, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s Descr=%s\n%s Unit Descr=None\n%s IDirection=%s\n"), wszName, wszDescr, wszName, wszName, wszIDirection[unit]);
else
_snwprintf_s(wszOutStr_2, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s Descr=None\n%s Unit Descr=None\n%s IDirection=%s\n"), wszName, wszName, wszName, wszIDirection[unit]);
}
// Write both pieces to the file.
if(WszWideCharToMultiByte (CP_ACP, 0, m_wszOutStr_1, -1, szPrintStr, PRINT_STR_LEN-1, 0, 0) ) {
if (0 == WriteFile (m_hPerfLogFileHandle, szPrintStr, (DWORD)strlen(szPrintStr), &m_dwWriteByte, NULL))
printf("ERROR: Could not write to perf log.\n");
}
else
wprintf(W("ERROR: Could not do string conversion.\n"));
if(WszWideCharToMultiByte (CP_ACP, 0, wszOutStr_2, -1, szPrintStr, PRINT_STR_LEN-1, 0, 0)) {
if (0 == WriteFile (m_hPerfLogFileHandle, szPrintStr, (DWORD)strlen(szPrintStr), &m_dwWriteByte, NULL))
printf("ERROR: Could not write to perf log.\n");
}
else
wprintf(W("ERROR: Could not do string conversion.\n"));
}
}
// Output stats in pretty print to stdout and perf automation format to file
// handle m_hPerfLogFileHandle
void PerfLog::Log(__in_z const wchar_t *wszName, UINT64 val, UnitOfMeasure unit, __in_opt const wchar_t *wszDescr)
{
LIMITED_METHOD_CONTRACT;
// Format the output into two pieces: The first piece is formatted here, rest in OutToStdout.
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%-30s%12.3I64u %s"), wszName, val, wszUnitOfMeasureDescr[unit]);
OutToStdout (wszName, unit, wszDescr);
// Format the output into two pieces: The first piece is formatted here, rest in OutToPerfFile
if (CommaSeparatedFormat())
{
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s;%0.3I64u;"), wszName, val);
OutToPerfFile (wszName, unit, wszDescr);
}
if (PerfAutomationFormat())
{
// workaround, Special case for ExecTime. since the format is slightly different than for custom value.
if (wcscmp(wszName, W("ExecTime")) == 0)
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s=%0.3I64u\nExecUnit=%s\n"), wszName, val, wszUnitOfMeasureDescr[unit]);
else
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s=%0.3I64u\n%s Unit=%s\n"), wszName, val, wszName, wszUnitOfMeasureDescr[unit]);
OutToPerfFile (wszName, unit, wszDescr);
}
}
// Output stats in pretty print to stdout and perf automation format to file
// handle m_hPerfLogFileHandle
void PerfLog::Log(__in_z const wchar_t *wszName, double val, UnitOfMeasure unit, __in_opt const wchar_t *wszDescr)
{
LIMITED_METHOD_CONTRACT;
// Format the output into two pieces: The first piece is formatted here, rest in OutToStdout.
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%-30s%12.3g %s"), wszName, val, wszUnitOfMeasureDescr[unit]);
OutToStdout (wszName, unit, wszDescr);
// Format the output into two pieces: The first piece is formatted here, rest in OutToPerfFile
if (CommaSeparatedFormat())
{
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s;%0.3g;"), wszName, val);
OutToPerfFile (wszName, unit, wszDescr);
}
if (PerfAutomationFormat())
{
// workaround, Special case for ExecTime. since the format is slightly different than for custom value.
if (wcscmp(wszName, W("ExecTime")) == 0)
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s=%0.3g\nExecUnit=%s\n"), wszName, val, wszUnitOfMeasureDescr[unit]);
else
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s=%0.3g\n%s Unit=%s\n"), wszName, val, wszName, wszUnitOfMeasureDescr[unit]);
OutToPerfFile (wszName, unit, wszDescr);
}
}
// Output stats in pretty print to stdout and perf automation format to file
// handle m_hPerfLogFileHandle
void PerfLog::Log(__in_z const wchar_t *wszName, UINT32 val, UnitOfMeasure unit, __in_opt const wchar_t *wszDescr)
{
LIMITED_METHOD_CONTRACT;
// Format the output into two pieces: The first piece is formatted here, rest in OutToStdout.
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%-30s%12d %s"), wszName, val, wszUnitOfMeasureDescr[unit]);
OutToStdout (wszName, unit, wszDescr);
// Format the output into two pieces: The first piece is formatted here, rest in OutToPerfFile
if (CommaSeparatedFormat())
{
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s;%d;"), wszName, val);
OutToPerfFile (wszName, unit, wszDescr);
}
if (PerfAutomationFormat())
{
// workaround, Special case for ExecTime. since the format is slightly different than for custom value.
if (wcscmp(wszName, W("ExecTime")) == 0)
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s=%0.3d\nExecUnit=%s\n"), wszName, val, wszUnitOfMeasureDescr[unit]);
else
_snwprintf_s(m_wszOutStr_1, PRINT_STR_LEN, PRINT_STR_LEN - 1, W("%s=%0.3d\n%s Unit=%s\n"), wszName, val, wszName, wszUnitOfMeasureDescr[unit]);
OutToPerfFile (wszName, unit, wszDescr);
}
}
//=============================================================================
// ALL THE PERF LOG CODE IS COMPILED ONLY IF THE ENABLE_PERF_LOG WAS DEFINED.
#endif // ENABLE_PERF_LOG
//=============================================================================
|
