tracy/common/TracyQueue.hpp

542 lines
12 KiB
C++
Raw Normal View History

2017-09-10 18:06:52 +00:00
#ifndef __TRACYQUEUE_HPP__
#define __TRACYQUEUE_HPP__
#include <stdint.h>
namespace tracy
{
enum class QueueType : uint8_t
{
ZoneText,
2018-06-29 14:01:31 +00:00
ZoneName,
Message,
2019-05-10 18:17:44 +00:00
MessageColor,
2019-11-14 22:40:41 +00:00
MessageCallstack,
MessageColorCallstack,
MessageAppInfo,
ZoneBeginAllocSrcLoc,
ZoneBeginAllocSrcLocCallstack,
CallstackMemory,
2018-06-21 22:56:01 +00:00
Callstack,
2019-02-28 19:16:19 +00:00
CallstackAlloc,
2020-02-22 12:42:09 +00:00
CallstackSample,
2020-02-26 21:35:15 +00:00
SymbolInformation,
2019-06-06 19:39:54 +00:00
FrameImage,
ZoneBegin,
ZoneBeginCallstack,
ZoneEnd,
LockWait,
LockObtain,
LockRelease,
LockSharedWait,
LockSharedObtain,
LockSharedRelease,
2020-03-08 12:47:38 +00:00
LockName,
MemAlloc,
MemFree,
MemAllocCallstack,
MemFreeCallstack,
GpuZoneBegin,
GpuZoneBeginCallstack,
GpuZoneEnd,
GpuZoneBeginSerial,
GpuZoneBeginCallstackSerial,
GpuZoneEndSerial,
PlotData,
2019-10-25 17:13:11 +00:00
ContextSwitch,
ThreadWakeup,
2019-10-25 17:52:01 +00:00
GpuTime,
2017-10-18 16:48:51 +00:00
Terminate,
2018-07-10 19:23:19 +00:00
KeepAlive,
ThreadContext,
Crash,
2018-08-20 00:07:31 +00:00
CrashReport,
2019-01-14 21:16:14 +00:00
ZoneValidation,
FrameMarkMsg,
2018-08-05 00:09:59 +00:00
FrameMarkMsgStart,
FrameMarkMsgEnd,
SourceLocation,
2017-12-10 20:37:39 +00:00
LockAnnounce,
2018-12-16 19:37:48 +00:00
LockTerminate,
2017-10-06 14:32:32 +00:00
LockMark,
2017-10-15 11:06:49 +00:00
MessageLiteral,
2019-05-10 18:17:44 +00:00
MessageLiteralColor,
2019-11-14 22:40:41 +00:00
MessageLiteralCallstack,
MessageLiteralColorCallstack,
2017-11-11 18:44:09 +00:00
GpuNewContext,
CallstackFrameSize,
2018-06-19 23:06:31 +00:00
CallstackFrame,
2019-02-21 20:59:02 +00:00
SysTimeReport,
2019-08-17 20:32:41 +00:00
TidToPid,
2019-11-05 15:47:41 +00:00
PlotConfig,
ParamSetup,
CpuTopology,
StringData,
ThreadName,
CustomStringData,
PlotName,
SourceLocationPayload,
2018-06-19 17:09:43 +00:00
CallstackPayload,
2019-02-28 19:30:07 +00:00
CallstackAllocPayload,
2018-08-04 18:48:21 +00:00
FrameName,
2019-06-06 19:39:54 +00:00
FrameImageData,
ExternalName,
2019-08-16 17:49:16 +00:00
ExternalThreadName,
2017-09-11 23:14:04 +00:00
NUM_TYPES
2017-09-10 18:06:52 +00:00
};
2017-09-11 22:28:50 +00:00
#pragma pack( 1 )
struct QueueThreadContext
{
uint64_t thread;
};
2017-09-10 18:06:52 +00:00
struct QueueZoneBegin
{
int64_t time;
2017-10-03 14:41:32 +00:00
uint64_t srcloc; // ptr
2017-09-10 18:06:52 +00:00
};
struct QueueZoneEnd
{
int64_t time;
2017-09-10 18:06:52 +00:00
};
2019-01-14 21:16:14 +00:00
struct QueueZoneValidation
{
uint32_t id;
};
2017-10-03 14:41:32 +00:00
struct QueueStringTransfer
{
uint64_t ptr;
};
struct QueueFrameMark
{
int64_t time;
2018-08-04 13:03:47 +00:00
uint64_t name; // ptr
2017-10-03 14:41:32 +00:00
};
2019-06-06 19:39:54 +00:00
struct QueueFrameImage
{
uint64_t image; // ptr
uint64_t frame;
2019-06-06 19:39:54 +00:00
uint16_t w;
uint16_t h;
2019-06-12 13:28:32 +00:00
uint8_t flip;
2019-06-06 19:39:54 +00:00
};
struct QueueSourceLocation
{
uint64_t name;
uint64_t function; // ptr
uint64_t file; // ptr
uint32_t line;
uint8_t r;
uint8_t g;
uint8_t b;
};
2017-09-27 00:18:17 +00:00
struct QueueZoneText
{
uint64_t text; // ptr
};
2017-12-10 20:37:39 +00:00
enum class LockType : uint8_t
{
2017-12-10 20:49:45 +00:00
Lockable,
SharedLockable
2017-12-10 20:37:39 +00:00
};
struct QueueLockAnnounce
{
uint32_t id;
2018-12-16 19:33:18 +00:00
int64_t time;
2017-12-10 20:37:39 +00:00
uint64_t lckloc; // ptr
LockType type;
};
2018-12-16 19:37:48 +00:00
struct QueueLockTerminate
{
uint32_t id;
int64_t time;
LockType type;
};
2017-10-04 14:16:27 +00:00
struct QueueLockWait
{
uint64_t thread;
uint32_t id;
2017-10-04 14:45:46 +00:00
int64_t time;
LockType type;
2017-10-04 14:16:27 +00:00
};
struct QueueLockObtain
{
uint64_t thread;
uint32_t id;
2017-10-04 14:45:46 +00:00
int64_t time;
2017-10-04 14:16:27 +00:00
};
struct QueueLockRelease
{
uint64_t thread;
uint32_t id;
2017-10-04 14:45:46 +00:00
int64_t time;
2017-10-04 14:16:27 +00:00
};
2017-10-06 14:32:32 +00:00
struct QueueLockMark
{
uint64_t thread;
uint32_t id;
2017-10-06 14:32:32 +00:00
uint64_t srcloc; // ptr
};
2020-03-08 12:47:38 +00:00
struct QueueLockName
{
uint32_t id;
uint64_t name; // ptr
};
2017-10-13 00:21:29 +00:00
enum class PlotDataType : uint8_t
{
Float,
Double,
Int
};
2017-10-13 00:07:03 +00:00
struct QueuePlotData
{
uint64_t name; // ptr
int64_t time;
2017-10-13 00:21:29 +00:00
PlotDataType type;
union
{
double d;
float f;
int64_t i;
} data;
2017-10-13 00:07:03 +00:00
};
2017-10-14 11:23:13 +00:00
struct QueueMessage
{
int64_t time;
uint64_t text; // ptr
};
2019-05-10 18:17:44 +00:00
struct QueueMessageColor : public QueueMessage
{
uint8_t r;
uint8_t g;
uint8_t b;
};
2017-11-11 18:44:09 +00:00
struct QueueGpuNewContext
{
2017-11-25 12:14:16 +00:00
int64_t cpuTime;
int64_t gpuTime;
2017-11-13 23:48:26 +00:00
uint64_t thread;
float period;
2018-06-22 13:10:23 +00:00
uint8_t context;
2017-11-17 13:07:42 +00:00
uint8_t accuracyBits;
2017-11-11 18:44:09 +00:00
};
2017-11-11 20:09:48 +00:00
struct QueueGpuZoneBegin
{
int64_t cpuTime;
uint64_t srcloc;
2018-06-17 16:55:12 +00:00
uint64_t thread;
2018-06-22 13:57:54 +00:00
uint16_t queryId;
2018-06-22 13:10:23 +00:00
uint8_t context;
2017-11-11 20:09:48 +00:00
};
struct QueueGpuZoneEnd
{
int64_t cpuTime;
uint64_t thread;
2018-06-22 13:57:54 +00:00
uint16_t queryId;
2018-06-22 13:10:23 +00:00
uint8_t context;
2017-11-11 20:09:48 +00:00
};
2017-11-11 21:08:47 +00:00
struct QueueGpuTime
{
int64_t gpuTime;
2018-06-22 14:19:53 +00:00
uint16_t queryId;
2018-06-22 13:10:23 +00:00
uint8_t context;
2017-11-11 21:08:47 +00:00
};
2018-03-31 19:56:05 +00:00
struct QueueMemAlloc
{
int64_t time;
uint64_t thread;
uint64_t ptr;
char size[6];
};
struct QueueMemFree
{
int64_t time;
uint64_t thread;
uint64_t ptr;
};
2018-06-19 16:50:29 +00:00
struct QueueCallstackMemory
{
uint64_t ptr;
};
2018-06-21 22:56:01 +00:00
struct QueueCallstack
{
uint64_t ptr;
};
struct QueueCallstackAlloc
{
uint64_t ptr;
uint64_t nativePtr;
};
2020-02-22 12:42:09 +00:00
struct QueueCallstackSample
{
int64_t time;
uint64_t thread;
uint64_t ptr;
};
struct QueueCallstackFrameSize
2018-06-19 23:06:31 +00:00
{
uint64_t ptr;
uint8_t size;
2020-02-25 23:33:09 +00:00
uint64_t imageName;
};
struct QueueCallstackFrame
{
2018-06-19 23:06:31 +00:00
uint64_t name;
uint64_t file;
uint32_t line;
2020-02-25 22:03:40 +00:00
uint64_t symAddr;
2018-06-19 23:06:31 +00:00
};
2020-02-27 11:49:48 +00:00
struct QueueSymbolInformation
{
uint64_t file;
uint32_t line;
uint64_t symAddr;
};
2018-08-20 00:07:31 +00:00
struct QueueCrashReport
{
int64_t time;
uint64_t text; // ptr
};
2019-02-21 20:59:02 +00:00
struct QueueSysTime
{
int64_t time;
float sysTime;
};
struct QueueContextSwitch
{
int64_t time;
uint64_t oldThread;
uint64_t newThread;
uint8_t cpu;
uint8_t reason;
uint8_t state;
};
2019-08-17 15:05:29 +00:00
struct QueueThreadWakeup
{
int64_t time;
uint64_t thread;
};
2019-08-17 20:32:41 +00:00
struct QueueTidToPid
{
uint64_t tid;
uint64_t pid;
};
2019-11-05 15:47:41 +00:00
enum class PlotFormatType : uint8_t
{
Number,
Memory,
Percentage
};
struct QueuePlotConfig
{
uint64_t name; // ptr
uint8_t type;
};
struct QueueParamSetup
{
uint32_t idx;
uint64_t name; // ptr
uint8_t isBool;
int32_t val;
};
struct QueueCpuTopology
{
uint32_t package;
uint32_t core;
uint32_t thread;
};
struct QueueHeader
2017-09-10 18:06:52 +00:00
{
union
{
QueueType type;
uint8_t idx;
};
};
struct QueueItem
{
QueueHeader hdr;
2017-09-10 18:06:52 +00:00
union
{
QueueThreadContext threadCtx;
2017-09-10 18:06:52 +00:00
QueueZoneBegin zoneBegin;
QueueZoneEnd zoneEnd;
2019-01-14 21:16:14 +00:00
QueueZoneValidation zoneValidation;
2017-10-03 14:41:32 +00:00
QueueStringTransfer stringTransfer;
QueueFrameMark frameMark;
2019-06-06 19:39:54 +00:00
QueueFrameImage frameImage;
QueueSourceLocation srcloc;
2017-09-27 00:18:17 +00:00
QueueZoneText zoneText;
2017-12-10 20:37:39 +00:00
QueueLockAnnounce lockAnnounce;
2018-12-16 19:37:48 +00:00
QueueLockTerminate lockTerminate;
2017-10-04 14:16:27 +00:00
QueueLockWait lockWait;
QueueLockObtain lockObtain;
QueueLockRelease lockRelease;
2017-10-06 14:32:32 +00:00
QueueLockMark lockMark;
2020-03-08 12:47:38 +00:00
QueueLockName lockName;
2017-10-13 00:07:03 +00:00
QueuePlotData plotData;
2017-10-14 11:23:13 +00:00
QueueMessage message;
2019-05-10 18:17:44 +00:00
QueueMessageColor messageColor;
2017-11-11 18:44:09 +00:00
QueueGpuNewContext gpuNewContext;
2017-11-11 20:09:48 +00:00
QueueGpuZoneBegin gpuZoneBegin;
QueueGpuZoneEnd gpuZoneEnd;
2017-11-11 21:08:47 +00:00
QueueGpuTime gpuTime;
2018-03-31 19:56:05 +00:00
QueueMemAlloc memAlloc;
QueueMemFree memFree;
2018-06-19 16:50:29 +00:00
QueueCallstackMemory callstackMemory;
2018-06-21 22:56:01 +00:00
QueueCallstack callstack;
QueueCallstackAlloc callstackAlloc;
2020-02-22 12:42:09 +00:00
QueueCallstackSample callstackSample;
QueueCallstackFrameSize callstackFrameSize;
2018-06-19 23:06:31 +00:00
QueueCallstackFrame callstackFrame;
2020-02-27 11:49:48 +00:00
QueueSymbolInformation symbolInformation;
2018-08-20 00:07:31 +00:00
QueueCrashReport crashReport;
2019-02-21 20:59:02 +00:00
QueueSysTime sysTime;
QueueContextSwitch contextSwitch;
2019-08-17 15:05:29 +00:00
QueueThreadWakeup threadWakeup;
2019-08-17 20:32:41 +00:00
QueueTidToPid tidToPid;
2019-11-05 15:47:41 +00:00
QueuePlotConfig plotConfig;
QueueParamSetup paramSetup;
QueueCpuTopology cpuTopology;
2017-09-10 18:06:52 +00:00
};
};
2017-09-11 22:28:50 +00:00
#pragma pack()
2017-09-10 18:06:52 +00:00
enum { QueueItemSize = sizeof( QueueItem ) };
2020-01-06 14:16:27 +00:00
static constexpr size_t QueueDataSize[] = {
sizeof( QueueHeader ) + sizeof( QueueZoneText ),
2018-06-29 14:01:31 +00:00
sizeof( QueueHeader ) + sizeof( QueueZoneText ), // zone name
sizeof( QueueHeader ) + sizeof( QueueMessage ),
2019-05-10 18:17:44 +00:00
sizeof( QueueHeader ) + sizeof( QueueMessageColor ),
2019-11-14 22:40:41 +00:00
sizeof( QueueHeader ) + sizeof( QueueMessage ), // callstack
sizeof( QueueHeader ) + sizeof( QueueMessageColor ), // callstack
sizeof( QueueHeader ) + sizeof( QueueMessage ), // app info
sizeof( QueueHeader ) + sizeof( QueueZoneBegin ), // allocated source location
sizeof( QueueHeader ) + sizeof( QueueZoneBegin ), // allocated source location, callstack
sizeof( QueueHeader ) + sizeof( QueueCallstackMemory ),
2018-06-21 22:56:01 +00:00
sizeof( QueueHeader ) + sizeof( QueueCallstack ),
sizeof( QueueHeader ) + sizeof( QueueCallstackAlloc ),
2020-02-22 12:42:09 +00:00
sizeof( QueueHeader ) + sizeof( QueueCallstackSample ),
2020-02-27 11:49:48 +00:00
sizeof( QueueHeader ) + sizeof( QueueSymbolInformation ),
2019-06-06 19:39:54 +00:00
sizeof( QueueHeader ) + sizeof( QueueFrameImage ),
sizeof( QueueHeader ) + sizeof( QueueZoneBegin ),
sizeof( QueueHeader ) + sizeof( QueueZoneBegin ), // callstack
sizeof( QueueHeader ) + sizeof( QueueZoneEnd ),
sizeof( QueueHeader ) + sizeof( QueueLockWait ),
sizeof( QueueHeader ) + sizeof( QueueLockObtain ),
sizeof( QueueHeader ) + sizeof( QueueLockRelease ),
sizeof( QueueHeader ) + sizeof( QueueLockWait ), // shared
sizeof( QueueHeader ) + sizeof( QueueLockObtain ), // shared
sizeof( QueueHeader ) + sizeof( QueueLockRelease ), // shared
2020-03-08 12:47:38 +00:00
sizeof( QueueHeader ) + sizeof( QueueLockName ),
sizeof( QueueHeader ) + sizeof( QueueMemAlloc ),
sizeof( QueueHeader ) + sizeof( QueueMemFree ),
sizeof( QueueHeader ) + sizeof( QueueMemAlloc ), // callstack
sizeof( QueueHeader ) + sizeof( QueueMemFree ), // callstack
sizeof( QueueHeader ) + sizeof( QueueGpuZoneBegin ),
sizeof( QueueHeader ) + sizeof( QueueGpuZoneBegin ), // callstack
sizeof( QueueHeader ) + sizeof( QueueGpuZoneEnd ),
sizeof( QueueHeader ) + sizeof( QueueGpuZoneBegin ), // serial
sizeof( QueueHeader ) + sizeof( QueueGpuZoneBegin ), // serial, callstack
sizeof( QueueHeader ) + sizeof( QueueGpuZoneEnd ), // serial
sizeof( QueueHeader ) + sizeof( QueuePlotData ),
2019-10-25 17:13:11 +00:00
sizeof( QueueHeader ) + sizeof( QueueContextSwitch ),
sizeof( QueueHeader ) + sizeof( QueueThreadWakeup ),
2019-10-25 17:52:01 +00:00
sizeof( QueueHeader ) + sizeof( QueueGpuTime ),
// above items must be first
2017-10-18 16:48:51 +00:00
sizeof( QueueHeader ), // terminate
2018-07-10 19:23:19 +00:00
sizeof( QueueHeader ), // keep alive
sizeof( QueueHeader ) + sizeof( QueueThreadContext ),
sizeof( QueueHeader ), // crash
2018-08-20 00:07:31 +00:00
sizeof( QueueHeader ) + sizeof( QueueCrashReport ),
2019-01-14 21:16:14 +00:00
sizeof( QueueHeader ) + sizeof( QueueZoneValidation ),
2018-08-05 00:09:59 +00:00
sizeof( QueueHeader ) + sizeof( QueueFrameMark ), // continuous frames
sizeof( QueueHeader ) + sizeof( QueueFrameMark ), // start
sizeof( QueueHeader ) + sizeof( QueueFrameMark ), // end
sizeof( QueueHeader ) + sizeof( QueueSourceLocation ),
2017-12-10 20:37:39 +00:00
sizeof( QueueHeader ) + sizeof( QueueLockAnnounce ),
2018-12-16 19:37:48 +00:00
sizeof( QueueHeader ) + sizeof( QueueLockTerminate ),
2017-10-06 14:32:32 +00:00
sizeof( QueueHeader ) + sizeof( QueueLockMark ),
2017-10-15 11:06:49 +00:00
sizeof( QueueHeader ) + sizeof( QueueMessage ), // literal
2019-05-10 18:17:44 +00:00
sizeof( QueueHeader ) + sizeof( QueueMessageColor ), // literal
2019-11-14 22:40:41 +00:00
sizeof( QueueHeader ) + sizeof( QueueMessage ), // literal, callstack
sizeof( QueueHeader ) + sizeof( QueueMessageColor ), // literal, callstack
2017-11-11 18:44:09 +00:00
sizeof( QueueHeader ) + sizeof( QueueGpuNewContext ),
sizeof( QueueHeader ) + sizeof( QueueCallstackFrameSize ),
2018-06-19 23:06:31 +00:00
sizeof( QueueHeader ) + sizeof( QueueCallstackFrame ),
2019-02-21 20:59:02 +00:00
sizeof( QueueHeader ) + sizeof( QueueSysTime ),
2019-08-17 20:32:41 +00:00
sizeof( QueueHeader ) + sizeof( QueueTidToPid ),
2019-11-05 15:47:41 +00:00
sizeof( QueueHeader ) + sizeof( QueuePlotConfig ),
sizeof( QueueHeader ) + sizeof( QueueParamSetup ),
sizeof( QueueHeader ) + sizeof( QueueCpuTopology ),
// keep all QueueStringTransfer below
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // string data
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // thread name
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // custom string data
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // plot name
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // allocated source location payload
2018-06-19 17:09:43 +00:00
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // callstack payload
2019-02-28 19:30:07 +00:00
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // callstack alloc payload
2018-08-04 18:48:21 +00:00
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // frame name
2019-06-06 19:39:54 +00:00
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // frame image data
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // external name
2019-08-16 17:49:16 +00:00
sizeof( QueueHeader ) + sizeof( QueueStringTransfer ), // external thread name
2017-09-11 23:14:04 +00:00
};
static_assert( QueueItemSize == 32, "Queue item size not 32 bytes" );
2017-09-11 23:14:04 +00:00
static_assert( sizeof( QueueDataSize ) / sizeof( size_t ) == (uint8_t)QueueType::NUM_TYPES, "QueueDataSize mismatch" );
static_assert( sizeof( void* ) <= sizeof( uint64_t ), "Pointer size > 8 bytes" );
static_assert( sizeof( void* ) == sizeof( uintptr_t ), "Pointer size != uintptr_t" );
2017-09-11 23:14:04 +00:00
2017-09-10 18:06:52 +00:00
};
#endif