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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
|
/************************************************************************************
PublicHeader: n/a
Filename : Tracing.h
Content : Performance tracing
Created : December 4, 2014
Author : Ed Hutchins
Copyright : Copyright (c) Facebook Technologies, LLC and its affiliates. All rights reserved.
Licensed under the Oculus Master SDK License Version 1.0 (the "License");
you may not use the Oculus VR Rift SDK except in compliance with the License,
which is provided at the time of installation or download, or which
otherwise accompanies this software in either electronic or hard copy form.
You may obtain a copy of the License at
https://developer.oculus.com/licenses/oculusmastersdk-1.0
Unless required by applicable law or agreed to in writing, the Oculus VR SDK
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
************************************************************************************/
#ifndef OVR_Tracing_h
#define OVR_Tracing_h
//-----------------------------------------------------------------------------------
// ***** OVR_ENABLE_ETW_TRACING definition (XXX default to on for windows builds?)
//
#ifdef OVR_OS_WIN32
#define OVR_ENABLE_ETW_TRACING
#endif
//-----------------------------------------------------------------------------------
// ***** Trace* definitions
//
#ifdef OVR_ENABLE_ETW_TRACING
#define TracingIsEnabled() (OVR_SDK_LibOVREnableBits[0] != 0)
#ifdef TRACE_STATE_CAPTURE_FUNC
// hook in our own state capture callback to record the state of all opened HMDs (supress unused
// parameter warnings with void() casts)
#define MCGEN_PRIVATE_ENABLE_CALLBACK_V2( \
SourceId, ControlCode, Level, MatchAnyKeyword, MatchAllKeywords, FilterData, CallbackContext) \
(void(SourceId), \
void(Level), \
void(MatchAnyKeyword), \
void(MatchAllKeywords), \
void(FilterData), \
void(CallbackContext), \
(((ControlCode) == EVENT_CONTROL_CODE_CAPTURE_STATE) ? (void)(TRACE_STATE_CAPTURE_FUNC) \
: (void)0))
#endif
#if !defined(_In_reads_)
// get VS2010 working
#define _In_reads_(x)
#endif
#include "LibOVREvents.h"
// Register/Unregister the OVR_SDK_LibOVR provider with ETW
// (MCGEN_PRIVATE_ENABLE_CALLBACK_V2 hooks in our state capture)
#define TraceInit(_Logger) \
do { \
ULONG status = EventRegisterOVR_SDK_LibOVR(); \
if (ERROR_SUCCESS != status) { \
_Logger.LogError("Failed to register ETW provider (%ul)", status); \
} \
} while (0)
#define TraceFini() EventUnregisterOVR_SDK_LibOVR()
// Trace function call and return for perf, and waypoints for debug
#define TraceCall(frameIndex) EventWriteCall(__FUNCTIONW__, __LINE__, (frameIndex))
#define TraceReturn(frameIndex) EventWriteReturn(__FUNCTIONW__, __LINE__, (frameIndex))
#define TraceWaypoint(frameIndex) EventWriteWaypoint(__FUNCTIONW__, __LINE__, (frameIndex))
// DistortionRenderer events
#define TraceDistortionBegin(id, frameIndex) EventWriteDistortionBegin((id), (frameIndex))
#define TraceDistortionWaitGPU(id, frameIndex) EventWriteDistortionWaitGPU((id), (frameIndex))
#define TraceDistortionPresent(id, frameIndex) EventWriteDistortionPresent((id), (frameIndex))
#define TraceDistortionEnd(id, frameIndex) EventWriteDistortionEnd((id), (frameIndex))
#define TraceDistortionEndToEndTiming(elapsedMs) EventWriteDistortionEndToEndTiming((elapsedMs))
// Tracking Camera events
#define _TraceCameraFrameData(fn, camIdx, img) \
fn((camIdx), \
(uint32_t)(img).FrameNumber, \
(img).HmdFrameNumber, \
(img).ArrivalTime, \
(img).CaptureTime)
#define TraceCameraFrameReceived(img) _TraceCameraFrameData(EventWriteCameraFrameReceived, 0, (img))
#define TraceCameraBeginProcessing(camIdx, img) \
_TraceCameraFrameData(EventWriteCameraBeginProcessing, (camIdx), (img))
#define TraceCameraEndProcessing(camIdx, img) \
_TraceCameraFrameData(EventWriteCameraEndProcessing, (camIdx), (img))
#define TraceCameraFrameRequest(requestNumber, frameCount, lastFrameNumber) \
EventWriteCameraFrameRequest(requestNumber, frameCount, lastFrameNumber)
#define TraceCameraSkippedFrames(camIdx, skippedFrameCount) \
EventWriteCameraSkippedFrames(camIdx, skippedFrameCount)
// Trace the interesting parts of an ovrHmdDesc structure
#define TraceHmdDesc(desc) \
EventWriteHmdDesc( \
(desc).Type, \
(desc).VendorId, \
(desc).ProductId, \
(desc).SerialNumber, \
(desc).FirmwareMajor, \
(desc).FirmwareMinor, \
(desc).AvailableHmdCaps, \
(desc).AvailableTrackingCaps, \
(desc).Resolution.w, \
(desc).Resolution.h)
#define TraceHmdDisplay(dpy) \
EventWriteHmdDisplay( \
(0), \
(0), \
(dpy).Edid.VendorID, \
(dpy).Edid.ModelNumber, \
(dpy).DisplayIdentifier.ToCStr(), \
(dpy).ModelName.ToCStr(), \
(dpy).EdidSerialNumber.ToCStr(), \
(dpy).LogicalResolutionInPixels.w, \
(dpy).LogicalResolutionInPixels.h, \
(dpy).NativeResolutionInPixels.w, \
(dpy).NativeResolutionInPixels.h, \
0, \
0, \
(dpy).DeviceNumber, \
(dpy).Rotation, \
(dpy).ApplicationExclusive)
// Trace part of a JSON string (events have a 64k limit)
#define TraceJSONChunk(Name, TotalChunks, ChunkSequence, TotalSize, ChunkSize, ChunkOffset, Chunk) \
EventWriteJSONChunk(Name, TotalChunks, ChunkSequence, TotalSize, ChunkSize, ChunkOffset, Chunk)
// Trace messages from the public ovr_Trace API and our internal logger
#define TraceLogDebug(message) EventWriteLogDebugMessage(message)
#define TraceLogInfo(message) EventWriteLogInfoMessage(message)
#define TraceLogError(message) EventWriteLogErrorMessage(message)
// Trace an ovrTrackingState
#define TraceTrackingState(ts) \
EventWriteHmdTrackingState( \
(ts).HeadPose.TimeInSeconds, \
&(ts).HeadPose.ThePose.Orientation.x, \
&(ts).HeadPose.ThePose.Position.x, \
&(ts).HeadPose.AngularVelocity.x, \
&(ts).HeadPose.LinearVelocity.x, \
0, \
0, \
(ts).StatusFlags)
#define TraceCameraBlobs(camIdx, frame) \
if (EventEnabledCameraBlobs()) { \
const int max_blobs = 80; \
int count = (frame).Blobs.GetSizeI(); \
double x[max_blobs]; \
double y[max_blobs]; \
int size[max_blobs]; \
if (count > max_blobs) \
count = max_blobs; \
for (int i = 0; i < count; ++i) { \
x[i] = (frame).Blobs[i].DistortedPosition.x; \
y[i] = (frame).Blobs[i].DistortedPosition.y; \
size[i] = (frame).Blobs[i].BlobSize; \
} \
EventWriteCameraBlobs( \
camIdx, \
(uint32_t)(frame).Frame->FrameNumber, \
(frame).Frame->ArrivalTime, \
(frame).Frame->Width, \
(frame).Frame->Height, \
count, \
x, \
y, \
size); \
} else \
((void)0)
#define TracePosePrediction( \
OriginalPose, PredictedPose, PredictionTimeDeltaSeconds, CurrentTimeInSeconds, id) \
EventWritePosePrediction( \
&(OriginalPose).Translation.x, \
&(OriginalPose).Rotation.x, \
&(PredictedPose).Translation.x, \
&(PredictedPose).Rotation.x, \
(PredictionTimeDeltaSeconds), \
(CurrentTimeInSeconds), \
(id))
// Trace PoseLatching CPU pinned memory write
#define TracePoseLatchCPUWrite( \
Sequence, \
Layer, \
MotionSensorTime, \
PredictedScanlineFirst, \
PredictedScanlineLast, \
TimeToScanlineFirst, \
TimeToScanlineLast, \
StartPosition, \
EndPosition, \
StartQuat, \
EndQuat) \
EventWritePoseLatchCPUWrite( \
Sequence, \
Layer, \
MotionSensorTime, \
PredictedScanlineFirst, \
PredictedScanlineLast, \
TimeToScanlineFirst, \
TimeToScanlineLast, \
StartPosition, \
EndPosition, \
StartQuat, \
EndQuat)
// Trace PoseLatching GPU latch
#define TracePoseLatchGPULatchReadback( \
Sequence, \
Layer, \
MotionSensorTime, \
PredictedScanlineFirst, \
PredictedScanlineLast, \
TimeToScanlineFirst, \
TimeToScanlineLast) \
EventWritePoseLatchGPULatchReadback( \
Sequence, \
Layer, \
MotionSensorTime, \
PredictedScanlineFirst, \
PredictedScanlineLast, \
TimeToScanlineFirst, \
TimeToScanlineLast)
#define TraceVSync(VSyncTime, FrameIndex, TWGpuEndTime) \
EventWriteVSync(VSyncTime, FrameIndex, TWGpuEndTime)
#define TraceAppCompositorFocus(Pid) EventWriteAppCompositorFocus(Pid)
#define TraceAppConnect(Pid) EventWriteAppConnect(Pid)
#define TraceAppDisconnect(Pid) EventWriteAppDisconnect(Pid)
#define TraceAppNoOp(Pid) EventWriteAppNoOp(Pid)
#define TraceLatencyTiming(LatencyTiming) \
EventWriteLatencyTiming( \
LatencyTiming.LatencyRenderCpuBegin, \
LatencyTiming.LatencyRenderCpuEnd, \
LatencyTiming.LatencyRenderIMU, \
LatencyTiming.LatencyTimewarpCpu, \
LatencyTiming.LatencyTimewarpLatched, \
LatencyTiming.LatencyTimewarpGpuEnd, \
LatencyTiming.LatencyPostPresent, \
LatencyTiming.ErrorRender, \
LatencyTiming.ErrorTimewarp)
#define TraceEndFrameAppTiming(AppTiming, RenderCount) \
EventWriteEndFrameAppTiming( \
AppTiming.AppFrameIndex, \
AppTiming.AppRenderIMUTime, \
AppTiming.AppVisibleMidpointTime, \
AppTiming.AppGpuRenderDuration, \
AppTiming.AppBeginRenderingTime, \
AppTiming.AppEndRenderingTime, \
AppTiming.QueueAheadSeconds, \
RenderCount)
#define TraceEndFrameOrigAppTiming(AppTiming, RenderCount) \
EventWriteEndFrameOrigAppTiming( \
AppTiming.AppFrameIndex, \
AppTiming.AppRenderIMUTime, \
AppTiming.AppVisibleMidpointTime, \
AppTiming.AppGpuRenderDuration, \
AppTiming.AppBeginRenderingTime, \
AppTiming.AppEndRenderingTime, \
AppTiming.QueueAheadSeconds, \
RenderCount)
// XXX for future reference this could have been done with events with different opcodes and
// identical templates
#define VirtualDisplayPacketTrace_Begin 0
#define VirtualDisplayPacketTrace_End 1
#define VirtualDisplayPacketTrace_Queue 2
#define VirtualDisplayPacketTrace_QueueRelease 3
#define VirtualDisplayPacketTrace_Result 5
#define TraceVirtualDisplayPacket(PacketType, Stage, SubmittingProcessID, ActiveProcessID) \
EventWriteVirtualDisplayPacketTrace(PacketType, Stage, SubmittingProcessID, ActiveProcessID)
#define TraceClientFrameMissed(FrameIndex, ProcessID) \
EventWriteClientFrameMissed(FrameIndex, ProcessID)
#define TraceCompositionBegin(ExpectedCPUStartTimeInSeconds, ActualCPUStartTimeInSeconds) \
EventWriteCompositionBegin(ExpectedCPUStartTimeInSeconds, ActualCPUStartTimeInSeconds)
#define TraceCompositionEnd() EventWriteCompositionEnd()
#define TraceCompositionEndSpinWait() EventWriteCompositionEndSpinWait()
#define TraceCompositionFlushingToGPU() EventWriteCompositionFlushingToGPU()
#define TraceRenderPacket(Stage, ClientPID) EventWriteRenderPacketTrace(Stage, ClientPID)
#define TraceHardwareInfo(data) \
EventWriteHardwareInfo( \
data.RequestedBits, \
data.CollectedBits, \
data.ImuTemp, \
data.StmTemp, \
data.NrfTemp, \
data.VBusVoltage, \
data.IAD, \
data.Proximity, \
data.PanelOnTime, \
data.UseRolling, \
data.HighBrightness, \
data.DP, \
data.SelfRefresh, \
data.Persistence, \
data.LightingOffset, \
data.PixelSettle, \
data.TotalRows)
#define TraceCompositionMissedCompositorFrame() EventWriteCompositionMissedCompositorFrame()
#define TraceCompositionGPUStartTime(Seconds) EventWriteCompositionGPUStartTime(Seconds)
#define TraceNotificationEnd( \
AppFrameIndex, CpuBeginToGpuEndSeconds, CpuBeginSeconds, GpuEndSeconds, SleepMs) \
EventWriteNotificationEnd( \
AppFrameIndex, CpuBeginToGpuEndSeconds, CpuBeginSeconds, GpuEndSeconds, SleepMs)
#define TraceNotificationBegin( \
AppFrameIndex, \
CpuBeginToGpuEndSeconds, \
CompositeTimeSeconds, \
VSyncTimeSeconds, \
CompositeDeltaSeconds, \
VSyncDeltaSeconds) \
EventWriteNotificationBegin( \
AppFrameIndex, \
CpuBeginToGpuEndSeconds, \
CompositeTimeSeconds, \
VSyncTimeSeconds, \
CompositeDeltaSeconds, \
VSyncDeltaSeconds)
#define TraceNotificationCompSubmit(IsEnabled, IsDisabled, FrameIndex) \
EventWriteNotificationCompSubmit(IsEnabled, IsDisabled, FrameIndex)
#define TraceMotionEstimationCostStats(Count, Average, Log2Histogram) \
EventWriteMotionEstimationCostStats(Count, Average, Log2Histogram)
#else // OVR_ENABLE_ETW_TRACING
// Eventually other platforms could support their form of performance tracing
#define TracingIsEnabled() (false)
#define TraceInit() ((void)0)
#define TraceFini() ((void)0)
#define TraceCall(frameIndex) ((void)0)
#define TraceReturn(frameIndex) ((void)0)
#define TraceWaypoint(frameIndex) ((void)0)
#define TraceDistortionBegin(id, frameIndex) ((void)0)
#define TraceDistortionWaitGPU(id, frameIndex) ((void)0)
#define TraceDistortionPresent(id, frameIndex) ((void)0)
#define TraceDistortionEnd(id, frameIndex) ((void)0)
#define TraceDistortionEndToEndTiming(elapsedMs) ((void)0)
#define TraceCameraFrameReceived(cfd) ((void)0)
#define TraceCameraBeginProcessing(camIdx, img) ((void)0)
#define TraceCameraFrameRequest(requestNumber, frameCount, lastFrameNumber) ((void)0)
#define TraceCameraEndProcessing(camIdx, img) ((void)0)
#define TraceCameraSkippedFrames(camIdx, skippedFrameCount) ((void)0)
#define TraceHmdDesc(desc) ((void)0)
#define TraceHmdDisplay(dpy) ((void)0)
#define TraceJSONChunk(Name, TotalChunks, ChunkSequence, TotalSize, ChunkSize, ChunkOffset, Chunk) \
((void)0)
#define TraceLogDebug(message) ((void)0)
#define TraceLogInfo(message) ((void)0)
#define TraceLogError(message) ((void)0)
#define TraceTrackingState(ts) ((void)0)
#define TraceCameraBlobs(camIdx, frame) ((void)0)
#define TracePoseLatchCPUWrite( \
Sequence, \
Layer, \
MotionSensorTime, \
PredictedScanlineFirst, \
PredictedScanlineLast, \
TimeToScanlineFirst, \
TimeToScanlineLast, \
StartPosition, \
EndPosition, \
StartQuat, \
EndQuat) \
((void)0)
#define TracePoseLatchGPULatchReadback( \
Sequence, \
Layer, \
MotionSensorTime, \
PredictedScanlineFirst, \
PredictedScanlineLast, \
TimeToScanlineFirst, \
TimeToScanlineLast) \
((void)0)
#define TraceVSync(VSyncTime, FrameIndex, TWGpuEndTime) ((void)0)
#define TracePosePrediction( \
OriginalPose, PredictedPose, PredictionTimeDeltaSeconds, CurrentTimeInSeconds, id) \
((void)0)
#define TraceAppCompositorFocus(Pid) ((void)0)
#define TraceAppConnect(Pid) ((void)0)
#define TraceAppDisconnect(Pid) ((void)0)
#define TraceAppNoOp(Pid) ((void)0)
#define TraceLatencyTiming(LatencyTiming) ((void)0)
#define TraceEndFrameAppTiming(AppTiming, RenderCount) ((void)0)
#define TraceEndFrameOrigAppTiming(AppTiming, RenderCount) ((void)0)
#define TraceVirtualDisplayPacket(PacketType, Stage, SubmittingProcessID, ActiveProcessID) ((void)0)
#define TraceClientFrameMissed(FrameIndex, ProcessID) ((void)0)
#define TraceCompositionBegin(ExpectedCPUStartTimeInSeconds, ActualCPUStartTimeInSeconds) ((void)0)
#define TraceCompositionEnd() ((void)0)
#define TraceCompositionEndSpinWait() ((void)0)
#define TraceCompositionFlushingToGPU() ((void)0)
#define TraceRenderPacket(Stage, ClientPID) ((void)0)
#define TraceHardwareInfo(data) ((void)0)
#define TraceCompositionMissedCompositorFrame() ((void)0)
#define TraceCompositionGPUStartTime(Seconds) ((void)0)
#define TraceNotificationEnd( \
AppFrameIndex, CpuBeginToGpuEndSeconds, CpuBeginSeconds, GpuEndSeconds, SleepMs) \
((void)0)
#define TraceNotificationBegin( \
AppFrameIndex, \
CpuBeginToGpuEndSeconds, \
CompositeTimeSeconds, \
VSyncTimeSeconds, \
CompositeDeltaSeconds, \
VSyncDeltaSeconds) \
((void)0)
#define TraceNotificationCompSubmit(IsEnabled, IsDisabled, FrameIndex) ((void)0)
#define TraceMotionEstimationCostStats(Count, Average, Log2Histogram) ((void)0)
#endif // OVR_ENABLE_ETW_TRACING
#endif // OVR_Tracing_h
|
