Thread Trace Service

ROCprofiler-SDK developer API 1.3.2 ROCm Profiling API and tools

Data Structures | Typedefs | Enumerations | Functions

Thread Trace Service

Provides API calls to enable and handle thread trace data. More...

Data Structures
struct	rocprofiler_thread_trace_parameter_t
	Thread Trace parameter specification. More...
struct	rocprofiler_thread_trace_decoder_id_t
	Handle containing a loaded rocprof-trace-decoder and a decoder state. More...
struct	rocprofiler_thread_trace_decoder_pc_t
	Describes a PC address. More...
struct	rocprofiler_thread_trace_decoder_perfevent_t
	Describes four performance counter values. More...
struct	rocprofiler_thread_trace_decoder_occupancy_t
	Describes an occupancy event (wave started or wave ended). More...
struct	rocprofiler_thread_trace_decoder_wave_state_t
	A wave state change event. More...
struct	rocprofiler_thread_trace_decoder_inst_t
	Describes an instruction execution event. More...
struct	rocprofiler_thread_trace_decoder_wave_t
	Struct describing a wave during it's lifetime. This record is only generated for waves executing in the target_cu and target_simd, selected by ROCPROFILER_THREAD_TRACE_PARAMETER_TARGET_CU and ROCPROFILER_THREAD_TRACE_PARAMETER_SIMD_SELECT. More...
struct	rocprofiler_thread_trace_decoder_realtime_t
	Matches the reference (realtime) clock with the shader clock Added in rocprof-trace-decoder 0.1.3. Requires aqlprofile for rocm 7.1+. clock_in_seconds = realtime_clock / ROCPROFILER_THREAD_TRACE_DECODER_RECORD_RT_FREQUENCY gfx_frequency = delta(shader_clock) / delta(clock_in_seconds) For best average, use gfx_frequency[n] = (shader_clock[n]-shader_clock[0]) / (clock_in_seconds[n]-clock_in_seconds[0]) More...
struct	rocprofiler_thread_trace_decoder_shaderdata_t
	Record created by s_ttracedata and s_ttracedata_imm Added in rocprof-trace-decoder 0.1.3. More...
struct	rocprofiler_thread_trace_decoder_inst_other_simd_t
	Tracks VMEM operations on the other SIMD Gfx11+ only. Added in rocprof-trace-decoder 0.1.5. More...

Typedefs
typedef void(*	rocprofiler_thread_trace_shader_data_callback_t) (rocprofiler_agent_id_t agent, int64_t shader_engine_id, void *data, unsigned long data_size, rocprofiler_thread_trace_shader_data_flags_t flags, rocprofiler_user_data_t userdata)
	Callback to be triggered every time some ATT data is generated by the device.
typedef rocprofiler_thread_trace_control_flags_t(*	rocprofiler_thread_trace_dispatch_callback_t) (rocprofiler_agent_id_t agent_id, rocprofiler_queue_id_t queue_id, rocprofiler_async_correlation_id_t correlation_id, rocprofiler_kernel_id_t kernel_id, rocprofiler_dispatch_id_t dispatch_id, void *userdata_config, rocprofiler_user_data_t *userdata_shader)
	Callback to be triggered every kernel dispatch, indicating to start and/or stop ATT.
typedef void(*	rocprofiler_thread_trace_decoder_callback_t) (rocprofiler_thread_trace_decoder_record_type_t record_type_id, void *trace_events, uint64_t trace_size, void *userdata)
	Callback for rocprof-trace-decoder to return decoder traces back to user.

Enumerations
enum	rocprofiler_thread_trace_parameter_buffering_mode_t {   ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_NONE = 0 ,   ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_SINGLE_BUFFER ,   ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_TRIPLE_BUFFER ,   ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_LAST }
	Types of Thread Trace buffering modes ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_NONE defines no preference TRIPLE_BUFFER is currently only available for a single shader engine at a time. More...
enum	rocprofiler_thread_trace_parameter_type_t {   ROCPROFILER_THREAD_TRACE_PARAMETER_TARGET_CU = 0 ,   ROCPROFILER_THREAD_TRACE_PARAMETER_SHADER_ENGINE_MASK ,   ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFER_SIZE ,   ROCPROFILER_THREAD_TRACE_PARAMETER_SIMD_SELECT ,   ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTERS_CTRL ,   ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTER ,   ROCPROFILER_THREAD_TRACE_PARAMETER_SERIALIZE_ALL ,   ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTER_EXCLUDE_MASK ,   ROCPROFILER_THREAD_TRACE_PARAMETER_NO_DETAIL ,   ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE ,   ROCPROFILER_THREAD_TRACE_PARAMETER_LAST }
	Types of Thread Trace parameters. More...
enum	rocprofiler_thread_trace_shader_data_flags_t {   ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_NONE = 0 ,   ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_END = 1 << 0 ,   ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_GPU_BUFFER_FULL = 1 << 1 ,   ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_CPU_BUFFER_FULL = 1 << 2 ,   ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_LAST }
	Flags for the data received in rocprofiler_thread_trace_shader_data_callback_t The last record takes on the flag ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_END. If the CPU or GPU buffer cannot be flushed during the trace, the trace will be interrupted and one (or both) of the buffer full flags will be set. When this happens, the trace will be disabled for that agent until all the shader data is flushed and then re-enabled. More...
enum	rocprofiler_thread_trace_control_flags_t {   ROCPROFILER_THREAD_TRACE_CONTROL_NONE = 0 ,   ROCPROFILER_THREAD_TRACE_CONTROL_START_AND_STOP = 3 }
enum	rocprofiler_thread_trace_decoder_info_t {   ROCPROFILER_THREAD_TRACE_DECODER_INFO_NONE = 0 ,   ROCPROFILER_THREAD_TRACE_DECODER_INFO_DATA_LOST ,   ROCPROFILER_THREAD_TRACE_DECODER_INFO_STITCH_INCOMPLETE ,   ROCPROFILER_THREAD_TRACE_DECODER_INFO_WAVE_INCOMPLETE ,   ROCPROFILER_THREAD_TRACE_DECODER_INFO_LAST }
	Describes the type of info received. More...
enum	rocprofiler_thread_trace_decoder_wstate_type_t {   ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_EMPTY = 0 ,   ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_IDLE ,   ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_EXEC ,   ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_WAIT ,   ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_STALL ,   ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_LAST }
	Wave state type. More...
enum	rocprofiler_thread_trace_decoder_inst_category_t {   ROCPROFILER_THREAD_TRACE_DECODER_INST_NONE = 0 ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_SMEM ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_SALU ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_VMEM ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_FLAT ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_LDS ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_VALU ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_JUMP ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_NEXT ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_IMMED ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_CONTEXT ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_MESSAGE ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_BVH ,   ROCPROFILER_THREAD_TRACE_DECODER_INST_LAST }
	Instruction type. More...
enum	rocprofiler_thread_trace_decoder_shaderdata_flags_t { ROCPROFILER_THREAD_TRACE_DECODER_SHADERDATA_FLAGS_IMM = 0 }
	Bitmask of additional information for shaderdata_t Added in rocprof-trace-decoder 0.1.3. More...
enum	rocprofiler_thread_trace_decoder_event_type_t {   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_NONE = 0 ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CS_PARTIAL_FLUSH ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_BOTTOM_OF_PIPE_TS ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_SAVE_CONTEXT ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_DISPATCH_END ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CACHE_FLUSH ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_PACKET_LOSS ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CODE_OBJECT_LOAD ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CODE_OBJECT_UNLOAD ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_TT_STALL_BEGIN ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_TT_STALL_END ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_TT_FLUSH ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_DIDT_STALL_BEGIN ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_DIDT_STALL_END ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CLUSTER_BARRIER ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_RESERVED ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_GC_RINSE ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_SPM_SAMPLE ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_LAST }
enum	rocprofiler_thread_trace_decoder_event_flags_t {   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_FLAGS_NONE = 0 ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_FLAGS_PER_PIPE = 0x1 ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_FLAGS_BOP = 0x2 ,   ROCPROFILER_THREAD_TRACE_DECODER_EVENT_FLAGS_LAST }
enum	rocprofiler_thread_trace_decoder_dispatch_flags_t {   ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_NONE = 0 ,   ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_SCALAR_CACHE_INVALIDATE = 0x1 ,   ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_VECTOR_CACHE_INVALIDATE = 0x2 ,   ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_IS_CTX_RESTORE = 0x4 ,   ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_SCRATCH_ENABLED = 0x8 ,   ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_REALTIME_TS = 0x10 ,   ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_LAST }
enum	rocprofiler_thread_trace_decoder_record_type_t {   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_GFXIP = 0 ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_OCCUPANCY ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_PERFEVENT ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_WAVE ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_INFO ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_EVENT ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_SHADERDATA ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_REALTIME ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_RT_FREQUENCY ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_INST_OTHER_SIMD ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_DISPATCH ,   ROCPROFILER_THREAD_TRACE_DECODER_RECORD_INST_OTHER_SIMD }
	Defines the type of payload received by rocprofiler_thread_trace_decoder_callback_t. More...

Functions
rocprofiler_status_t	rocprofiler_configure_device_thread_trace_service (rocprofiler_context_id_t context_id, rocprofiler_agent_id_t agent_id, rocprofiler_thread_trace_parameter_t *parameters, unsigned long num_parameters, rocprofiler_thread_trace_shader_data_callback_t shader_callback, rocprofiler_user_data_t callback_userdata)
	Configure Thread Trace Service for agent. There may only be one agent profile configured per context and can be only one active context that is profiling a single agent at a time. Multiple agent contexts can be started at the same time if they are profiling different agents.
rocprofiler_status_t	rocprofiler_configure_dispatch_thread_trace_service (rocprofiler_context_id_t context_id, rocprofiler_agent_id_t agent_id, rocprofiler_thread_trace_parameter_t *parameters, unsigned long num_parameters, rocprofiler_thread_trace_dispatch_callback_t dispatch_callback, rocprofiler_thread_trace_shader_data_callback_t shader_callback, void *callback_userdata)
	Enables the thread trace service for dispatch-based tracing. The tool has an option to enable/disable thread trace on every dispatch callback. This service serializes all traced kernels, and optionally all non-traced kernels.
rocprofiler_status_t	rocprofiler_thread_trace_decoder_create (rocprofiler_thread_trace_decoder_id_t *handle, const char *path)
	Initializes Trace Decoder library with a library search path.
void	rocprofiler_thread_trace_decoder_destroy (rocprofiler_thread_trace_decoder_id_t handle)
	Deletes handle created by rocprofiler_thread_trace_decoder_create.
rocprofiler_status_t	rocprofiler_thread_trace_decoder_codeobj_load (rocprofiler_thread_trace_decoder_id_t handle, uint64_t load_id, uint64_t load_addr, uint64_t load_size, const void *data, uint64_t size)
	Loads a code object binary to match with Thread Trace. The size, data and load_* are reported by rocprofiler-sdk's code object tracing service. Used for the decoder library to know what code objects to look into when decoding shader data. Not all application code objects are required to be reported here, only the ones containing code executed at the time the shader data was collected by thread_trace services. If a code object not reported here is encountered while decoding shader data, a record of type INFO_STITCH_INCOMPLETE will be generated and instructions will not be reported with a PC address.
rocprofiler_status_t	rocprofiler_thread_trace_decoder_codeobj_unload (rocprofiler_thread_trace_decoder_id_t handle, uint64_t load_id)
	Unloads a code object binary.
rocprofiler_status_t	rocprofiler_trace_decode (rocprofiler_thread_trace_decoder_id_t handle, rocprofiler_thread_trace_decoder_callback_t callback, void *data, uint64_t size, void *userdata)
	Decodes shader data returned by rocprofiler_thread_trace_shader_data_callback_t. Use rocprofiler_thread_trace_decoder_codeobj_load to add references to loaded code objects during the trace. A rocprofiler_thread_trace_decoder_callback_t returns decoded data back to user. The first record is always of type ROCPROFILER_THREAD_TRACE_DECODER_RECORD_GFXIP.
const char *	rocprofiler_thread_trace_decoder_info_string (rocprofiler_thread_trace_decoder_id_t handle, rocprofiler_thread_trace_decoder_info_t info)
	Returns the string description of a rocprofiler_thread_trace_decoder_info_t record.

Detailed Description

Provides API calls to enable and handle thread trace data.

ROCprof-trace-decoder defined types. All timestamp values are in shader clock units.

ROCprof-trace-decoder wrapper. Provides API calls to decode thread trace shader data.

---

Data Structure Documentation

◆ rocprofiler_thread_trace_parameter_t

struct rocprofiler_thread_trace_parameter_t

Thread Trace parameter specification.

Definition at line 80 of file core.h.

Collaboration diagram for rocprofiler_thread_trace_parameter_t:

Data Fields
union rocprofiler_thread_trace_parameter_t.__unnamed15__	__unnamed__
rocprofiler_thread_trace_parameter_type_t	type

◆ rocprofiler_thread_trace_decoder_id_t

struct rocprofiler_thread_trace_decoder_id_t

Handle containing a loaded rocprof-trace-decoder and a decoder state.

Definition at line 39 of file trace_decoder.h.

Collaboration diagram for rocprofiler_thread_trace_decoder_id_t:

Data Fields
uint64_t	handle

◆ rocprofiler_thread_trace_decoder_pc_t

struct rocprofiler_thread_trace_decoder_pc_t

Describes a PC address.

Definition at line 56 of file trace_decoder_types.h.

Collaboration diagram for rocprofiler_thread_trace_decoder_pc_t:

Data Fields
uint64_t	address	Address (code_object_id == 0), or ELF vaddr (code_object_id != 0)
uint64_t	code_object_id	Zero if no code object was found.

◆ rocprofiler_thread_trace_decoder_perfevent_t

struct rocprofiler_thread_trace_decoder_perfevent_t

Describes four performance counter values.

Definition at line 65 of file trace_decoder_types.h.

Collaboration diagram for rocprofiler_thread_trace_decoder_perfevent_t:

Data Fields
uint8_t	bank	Selects counter group [0,3] or [4,7].
uint8_t	CU	Shader compute unit ID these counters were collected from.
uint16_t	events0	Counter0 (bank==0) or Counter4 (bank==1).
uint16_t	events1	Counter1 (bank==0) or Counter5 (bank==1).
uint16_t	events2	Counter2 (bank==0) or Counter6 (bank==1).
uint16_t	events3	Counter3 (bank==0) or Counter7 (bank==1).
int64_t	time	Shader clock timestamp in which these counters were read.

◆ rocprofiler_thread_trace_decoder_occupancy_t

struct rocprofiler_thread_trace_decoder_occupancy_t

Describes an occupancy event (wave started or wave ended).

Definition at line 79 of file trace_decoder_types.h.

Collaboration diagram for rocprofiler_thread_trace_decoder_occupancy_t:

Data Fields
uint32_t	_rsvd: 11
uint32_t	cluster_id: 5	0 = not in a cluster; only valid on wavestart
uint8_t	cu	Compute unit ID (gfx9) or WGP ID (gfx10+).
uint32_t	is_ext: 1	Is workgroup_id valid?
uint32_t	me_id: 3	MicroEngine ID.
rocprofiler_thread_trace_decoder_pc_t	pc	Wave start address (kernel entry point)
uint32_t	pipe_id: 4
uint8_t	reserved	Reserved.
uint8_t	simd	SIMD ID [0,3] within compute unit.
uint32_t	start: 1	1 if wave_start, 0 if a wave_end
uint64_t	time	Timestamp of event.
uint8_t	wave_id	Wave slot ID within SIMD.
uint32_t	workgroup_id: 7

◆ rocprofiler_thread_trace_decoder_wave_state_t

struct rocprofiler_thread_trace_decoder_wave_state_t

A wave state change event.

Definition at line 112 of file trace_decoder_types.h.

Collaboration diagram for rocprofiler_thread_trace_decoder_wave_state_t:

Data Fields
int32_t	duration	state duration in cycles
int32_t	type	one of rocprofiler_thread_trace_decoder_waveslot_state_type_t

◆ rocprofiler_thread_trace_decoder_inst_t

struct rocprofiler_thread_trace_decoder_inst_t

Describes an instruction execution event.

The duration is measured as stall+issue time (gfx9) or stall+execution time (gfx10+). Time + duration marks the issue (gfx9) or execution (gfx10+) completion time. Time + stall marks the successful issue time. Duration - stall is the issue time (gfx9) or execution time (gfx10+).

Definition at line 147 of file trace_decoder_types.h.

Collaboration diagram for rocprofiler_thread_trace_decoder_inst_t:

Data Fields
uint32_t	category: 8	One of rocprofiler_thread_trace_decoder_inst_category_t.
int32_t	duration	Total instruction duration, in clock cycles.
rocprofiler_thread_trace_decoder_pc_t	pc
uint32_t	stall: 24	Stall duration, in clock cycles.
int64_t	time	When the wave first attempted to execute this instruction.

◆ rocprofiler_thread_trace_decoder_wave_t

struct rocprofiler_thread_trace_decoder_wave_t

Struct describing a wave during it's lifetime. This record is only generated for waves executing in the target_cu and target_simd, selected by ROCPROFILER_THREAD_TRACE_PARAMETER_TARGET_CU and ROCPROFILER_THREAD_TRACE_PARAMETER_SIMD_SELECT.

instructions_array contains a time-ordered list of all (traced) instructions by the wave.

Definition at line 163 of file trace_decoder_types.h.

Collaboration diagram for rocprofiler_thread_trace_decoder_wave_t:

Data Fields
int64_t	begin_time	Wave begin time. Should match occupancy event wave start.
uint8_t	cluster_id	0 = not in a cluster
uint8_t	contexts	Counts how many CWSR events have occurred during the wave lifetime.
uint8_t	cu	CU id (gfx9) or wgp id (gfx10+). This is always the target_cu.
uint8_t	dispatcher	[0:3] PIPE_ID, [4:6] ME_ID
int64_t	end_time	Wave end time. Should match occupancy event wave end.
rocprofiler_thread_trace_decoder_inst_t *	instructions_array	Instructions executed.
uint64_t	instructions_size	instructions_array size
uint8_t	reserved	Reserved.
uint8_t	simd	SIMD ID [0,3].
uint64_t	size	Size of this struct.
rocprofiler_thread_trace_decoder_wave_state_t *	timeline_array	wave state change events
uint64_t	timeline_size	timeline_array size
uint8_t	wave_id	Wave slot ID within SIMD.
uint8_t	workgroup_id	Workgroup ID.

◆ rocprofiler_thread_trace_decoder_realtime_t

struct rocprofiler_thread_trace_decoder_realtime_t

Matches the reference (realtime) clock with the shader clock Added in rocprof-trace-decoder 0.1.3. Requires aqlprofile for rocm 7.1+. clock_in_seconds = realtime_clock / ROCPROFILER_THREAD_TRACE_DECODER_RECORD_RT_FREQUENCY gfx_frequency = delta(shader_clock) / delta(clock_in_seconds) For best average, use gfx_frequency[n] = (shader_clock[n]-shader_clock[0]) / (clock_in_seconds[n]-clock_in_seconds[0])

Definition at line 193 of file trace_decoder_types.h.

Collaboration diagram for rocprofiler_thread_trace_decoder_realtime_t:

Data Fields
uint64_t	realtime_clock	Clock timestamp in realtime units.
uint64_t	reserved
int64_t	shader_clock	Clock timestamp in gfx clock units.

◆ rocprofiler_thread_trace_decoder_shaderdata_t

struct rocprofiler_thread_trace_decoder_shaderdata_t

Record created by s_ttracedata and s_ttracedata_imm Added in rocprof-trace-decoder 0.1.3.

Definition at line 217 of file trace_decoder_types.h.

Collaboration diagram for rocprofiler_thread_trace_decoder_shaderdata_t:

Data Fields
uint8_t	cu	CU id (gfx9) or wgp id (gfx10+).
uint8_t	flags	bitmask of rocprofiler_thread_trace_decoder_shaderdata_flags_t
uint32_t	reserved
uint8_t	simd	SIMD ID [0,3].
int64_t	time
uint64_t	value	Value written from M0/IMM.
uint8_t	wave_id	Wave slot ID within SIMD.

◆ rocprofiler_thread_trace_decoder_inst_other_simd_t

struct rocprofiler_thread_trace_decoder_inst_other_simd_t

Tracks VMEM operations on the other SIMD Gfx11+ only. Added in rocprof-trace-decoder 0.1.5.

Definition at line 232 of file trace_decoder_types.h.

Collaboration diagram for rocprofiler_thread_trace_decoder_inst_other_simd_t:

Data Fields
uint8_t	category	One of rocprofiler_thread_trace_decoder_inst_category_t.
uint16_t	cycles	Execution duration, not including stall.
uint64_t	size	Size of this struct.
int64_t	time	Issue time.
uint8_t	wgp	WGP ID. This is always the target cu.

Typedef Documentation

◆ rocprofiler_thread_trace_decoder_callback_t

typedef void(* rocprofiler_thread_trace_decoder_callback_t) (rocprofiler_thread_trace_decoder_record_type_t record_type_id, void *trace_events, uint64_t trace_size, void *userdata)

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder.h>

Callback for rocprof-trace-decoder to return decoder traces back to user.

Parameters

[in]	record_type_id	One of rocprofiler_thread_trace_decoder_record_type_t
[in]	trace_events	A pointer to sequence of events, of size trace_size.
[in]	trace_size	The number of events in the trace.
[in]	userdata	Arbitrary data pointer to be sent back to the user via callback.

Definition at line 113 of file trace_decoder.h.

◆ rocprofiler_thread_trace_dispatch_callback_t

typedef rocprofiler_thread_trace_control_flags_t(* rocprofiler_thread_trace_dispatch_callback_t) (rocprofiler_agent_id_t agent_id, rocprofiler_queue_id_t queue_id, rocprofiler_async_correlation_id_t correlation_id, rocprofiler_kernel_id_t kernel_id, rocprofiler_dispatch_id_t dispatch_id, void *userdata_config, rocprofiler_user_data_t *userdata_shader)

#include <rocprofiler-sdk/experimental/thread-trace/dispatch.h>

Callback to be triggered every kernel dispatch, indicating to start and/or stop ATT.

Parameters

[in]	agent_id	agent_id.
[in]	queue_id	queue_id.
[in]	correlation_id	internal correlation id.
[in]	kernel_id	kernel_id.
[in]	dispatch_id	dispatch_id.
[in]	userdata_config	Userdata passed back from rocprofiler_configure_dispatch_thread_trace_service.
[out]	userdata_shader	Userdata to be passed in shader_callback

Definition at line 57 of file dispatch.h.

◆ rocprofiler_thread_trace_shader_data_callback_t

typedef void(* rocprofiler_thread_trace_shader_data_callback_t) (rocprofiler_agent_id_t agent, int64_t shader_engine_id, void *data, unsigned long data_size, rocprofiler_thread_trace_shader_data_flags_t flags, rocprofiler_user_data_t userdata)

#include <rocprofiler-sdk/experimental/thread-trace/core.h>

Callback to be triggered every time some ATT data is generated by the device.

Parameters

[in]

agent

Identifier for the target agent (

See also

rocprofiler_agent_id_t)

Parameters

[in]	shader_engine_id	ID of shader engine, as enabled by SE_MASK
[in]	data	Pointer to the buffer containing the ATT data
[in]	data_size	Number of bytes in "data"
[in]	userdata	Passed back to user from rocprofiler_thread_trace_dispatch_callback_t()

Definition at line 129 of file core.h.

Enumeration Type Documentation

◆ rocprofiler_thread_trace_control_flags_t

enum rocprofiler_thread_trace_control_flags_t

#include <rocprofiler-sdk/experimental/thread-trace/dispatch.h>

Definition at line 40 of file dispatch.h.

41{

42 ROCPROFILER_THREAD_TRACE_CONTROL_NONE = 0,

43 ROCPROFILER_THREAD_TRACE_CONTROL_START_AND_STOP = 3

44} rocprofiler_thread_trace_control_flags_t;

◆ rocprofiler_thread_trace_decoder_dispatch_flags_t

enum rocprofiler_thread_trace_decoder_dispatch_flags_t

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder_types.h>

Definition at line 297 of file trace_decoder_types.h.

298{

299 ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_NONE = 0,

300 ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_SCALAR_CACHE_INVALIDATE = 0x1,

301 ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_VECTOR_CACHE_INVALIDATE = 0x2,

302 ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_IS_CTX_RESTORE = 0x4,

303 ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_SCRATCH_ENABLED = 0x8,

304 ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_REALTIME_TS = 0x10,

305 ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_LAST =

306 ROCPROFILER_THREAD_TRACE_DECODER_DISPATCH_FLAGS_REALTIME_TS,

307} rocprofiler_thread_trace_decoder_dispatch_flags_t;

◆ rocprofiler_thread_trace_decoder_event_flags_t

enum rocprofiler_thread_trace_decoder_event_flags_t

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder_types.h>

Definition at line 265 of file trace_decoder_types.h.

266{

267 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_FLAGS_NONE = 0,

268 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_FLAGS_PER_PIPE = 0x1,

269 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_FLAGS_BOP = 0x2,

270 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_FLAGS_LAST =

271 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_FLAGS_BOP,

272} rocprofiler_thread_trace_decoder_event_flags_t;

◆ rocprofiler_thread_trace_decoder_event_type_t

enum rocprofiler_thread_trace_decoder_event_type_t

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder_types.h>

Enumerator
ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CODE_OBJECT_LOAD	ID = payload.code_object_id.
ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CODE_OBJECT_UNLOAD	ID = payload.code_object_id.
ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CLUSTER_BARRIER	IDs = cluster_barrier.{cluster_id, barrier_id}.

Definition at line 241 of file trace_decoder_types.h.

242{

243 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_NONE = 0,

244 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CS_PARTIAL_FLUSH,

245 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_BOTTOM_OF_PIPE_TS,

246 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_SAVE_CONTEXT,

247 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_DISPATCH_END,

248 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CACHE_FLUSH,

249 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_PACKET_LOSS,

250 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CODE_OBJECT_LOAD, ///< ID = payload.code_object_id

251 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CODE_OBJECT_UNLOAD, ///< ID = payload.code_object_id

252 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_TT_STALL_BEGIN,

253 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_TT_STALL_END,

254 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_TT_FLUSH,

255 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_DIDT_STALL_BEGIN,

256 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_DIDT_STALL_END,

257 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CLUSTER_BARRIER, ///< IDs = cluster_barrier.{cluster_id,

258 ///< barrier_id}

259 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_RESERVED,

260 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_GC_RINSE,

261 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_SPM_SAMPLE,

262 ROCPROFILER_THREAD_TRACE_DECODER_EVENT_LAST

263} rocprofiler_thread_trace_decoder_event_type_t;

rocprofiler_thread_trace_decoder_event_type_t

rocprofiler_thread_trace_decoder_event_type_t

Definition trace_decoder_types.h:242

ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CODE_OBJECT_LOAD

@ ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CODE_OBJECT_LOAD

ID = payload.code_object_id.

Definition trace_decoder_types.h:250

ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CODE_OBJECT_UNLOAD

@ ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CODE_OBJECT_UNLOAD

ID = payload.code_object_id.

Definition trace_decoder_types.h:251

ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CLUSTER_BARRIER

@ ROCPROFILER_THREAD_TRACE_DECODER_EVENT_CLUSTER_BARRIER

IDs = cluster_barrier.{cluster_id, barrier_id}.

Definition trace_decoder_types.h:257

◆ rocprofiler_thread_trace_decoder_info_t

enum rocprofiler_thread_trace_decoder_info_t

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder_types.h>

Describes the type of info received.

Definition at line 44 of file trace_decoder_types.h.

45{

46 ROCPROFILER_THREAD_TRACE_DECODER_INFO_NONE = 0,

47 ROCPROFILER_THREAD_TRACE_DECODER_INFO_DATA_LOST,

48 ROCPROFILER_THREAD_TRACE_DECODER_INFO_STITCH_INCOMPLETE,

49 ROCPROFILER_THREAD_TRACE_DECODER_INFO_WAVE_INCOMPLETE,

50 ROCPROFILER_THREAD_TRACE_DECODER_INFO_LAST

51} rocprofiler_thread_trace_decoder_info_t;

rocprofiler_thread_trace_decoder_info_t

rocprofiler_thread_trace_decoder_info_t

Describes the type of info received.

Definition trace_decoder_types.h:45

◆ rocprofiler_thread_trace_decoder_inst_category_t

enum rocprofiler_thread_trace_decoder_inst_category_t

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder_types.h>

Instruction type.

Enumerator
ROCPROFILER_THREAD_TRACE_DECODER_INST_SMEM	Scalar memory op.
ROCPROFILER_THREAD_TRACE_DECODER_INST_SALU	Scalar ALU op.
ROCPROFILER_THREAD_TRACE_DECODER_INST_VMEM	Vector memory op.
ROCPROFILER_THREAD_TRACE_DECODER_INST_FLAT	Flat addressing vmem or lds.
ROCPROFILER_THREAD_TRACE_DECODER_INST_LDS	Local Data Share op.
ROCPROFILER_THREAD_TRACE_DECODER_INST_VALU	Vector ALU op.
ROCPROFILER_THREAD_TRACE_DECODER_INST_JUMP	Branch taken.
ROCPROFILER_THREAD_TRACE_DECODER_INST_NEXT	Branch not taken.
ROCPROFILER_THREAD_TRACE_DECODER_INST_IMMED	Internal operation.
ROCPROFILER_THREAD_TRACE_DECODER_INST_CONTEXT	Wave context switch.
ROCPROFILER_THREAD_TRACE_DECODER_INST_MESSAGE	MSG types.
ROCPROFILER_THREAD_TRACE_DECODER_INST_BVH	Raytrace op.

Definition at line 121 of file trace_decoder_types.h.

122{

123 ROCPROFILER_THREAD_TRACE_DECODER_INST_NONE = 0,

124 ROCPROFILER_THREAD_TRACE_DECODER_INST_SMEM, ///< Scalar memory op

125 ROCPROFILER_THREAD_TRACE_DECODER_INST_SALU, ///< Scalar ALU op

126 ROCPROFILER_THREAD_TRACE_DECODER_INST_VMEM, ///< Vector memory op

127 ROCPROFILER_THREAD_TRACE_DECODER_INST_FLAT, ///< Flat addressing vmem or lds

128 ROCPROFILER_THREAD_TRACE_DECODER_INST_LDS, ///< Local Data Share op

129 ROCPROFILER_THREAD_TRACE_DECODER_INST_VALU, ///< Vector ALU op

130 ROCPROFILER_THREAD_TRACE_DECODER_INST_JUMP, ///< Branch taken

131 ROCPROFILER_THREAD_TRACE_DECODER_INST_NEXT, ///< Branch not taken

132 ROCPROFILER_THREAD_TRACE_DECODER_INST_IMMED, ///< Internal operation

133 ROCPROFILER_THREAD_TRACE_DECODER_INST_CONTEXT, ///< Wave context switch

134 ROCPROFILER_THREAD_TRACE_DECODER_INST_MESSAGE, ///< MSG types

135 ROCPROFILER_THREAD_TRACE_DECODER_INST_BVH, ///< Raytrace op

136 ROCPROFILER_THREAD_TRACE_DECODER_INST_LAST

137} rocprofiler_thread_trace_decoder_inst_category_t;

rocprofiler_thread_trace_decoder_inst_category_t

rocprofiler_thread_trace_decoder_inst_category_t

Instruction type.

Definition trace_decoder_types.h:122

ROCPROFILER_THREAD_TRACE_DECODER_INST_BVH

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_BVH

Raytrace op.

Definition trace_decoder_types.h:135

ROCPROFILER_THREAD_TRACE_DECODER_INST_VALU

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_VALU

Vector ALU op.

Definition trace_decoder_types.h:129

ROCPROFILER_THREAD_TRACE_DECODER_INST_FLAT

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_FLAT

Flat addressing vmem or lds.

Definition trace_decoder_types.h:127

ROCPROFILER_THREAD_TRACE_DECODER_INST_IMMED

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_IMMED

Internal operation.

Definition trace_decoder_types.h:132

ROCPROFILER_THREAD_TRACE_DECODER_INST_CONTEXT

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_CONTEXT

Wave context switch.

Definition trace_decoder_types.h:133

ROCPROFILER_THREAD_TRACE_DECODER_INST_LDS

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_LDS

Local Data Share op.

Definition trace_decoder_types.h:128

ROCPROFILER_THREAD_TRACE_DECODER_INST_SMEM

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_SMEM

Scalar memory op.

Definition trace_decoder_types.h:124

ROCPROFILER_THREAD_TRACE_DECODER_INST_NEXT

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_NEXT

Branch not taken.

Definition trace_decoder_types.h:131

ROCPROFILER_THREAD_TRACE_DECODER_INST_SALU

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_SALU

Scalar ALU op.

Definition trace_decoder_types.h:125

ROCPROFILER_THREAD_TRACE_DECODER_INST_MESSAGE

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_MESSAGE

MSG types.

Definition trace_decoder_types.h:134

ROCPROFILER_THREAD_TRACE_DECODER_INST_VMEM

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_VMEM

Vector memory op.

Definition trace_decoder_types.h:126

ROCPROFILER_THREAD_TRACE_DECODER_INST_JUMP

@ ROCPROFILER_THREAD_TRACE_DECODER_INST_JUMP

Branch taken.

Definition trace_decoder_types.h:130

◆ rocprofiler_thread_trace_decoder_record_type_t

enum rocprofiler_thread_trace_decoder_record_type_t

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder_types.h>

Defines the type of payload received by rocprofiler_thread_trace_decoder_callback_t.

Enumerator
ROCPROFILER_THREAD_TRACE_DECODER_RECORD_GFXIP	Record is gfxip_major, type uint64_t.
ROCPROFILER_THREAD_TRACE_DECODER_RECORD_OCCUPANCY	rocprofiler_thread_trace_decoder_occupancy_t*
ROCPROFILER_THREAD_TRACE_DECODER_RECORD_PERFEVENT	rocprofiler_thread_trace_decoder_perfevent_t*
ROCPROFILER_THREAD_TRACE_DECODER_RECORD_WAVE	rocprofiler_thread_trace_decoder_wave_t*
ROCPROFILER_THREAD_TRACE_DECODER_RECORD_INFO	rocprofiler_thread_trace_decoder_info_t*
ROCPROFILER_THREAD_TRACE_DECODER_RECORD_EVENT	rocprofiler_thread_trace_decoder_event_t*
ROCPROFILER_THREAD_TRACE_DECODER_RECORD_SHADERDATA	rocprofiler_thread_trace_decoder_shaderdata_t*
ROCPROFILER_THREAD_TRACE_DECODER_RECORD_REALTIME	rocprofiler_thread_trace_decoder_realtime_t*

Definition at line 332 of file trace_decoder_types.h.

333{

334 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_GFXIP = 0, ///< Record is gfxip_major, type uint64_t

335 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_OCCUPANCY, ///< rocprofiler_thread_trace_decoder_occupancy_t*

336 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_PERFEVENT, ///< rocprofiler_thread_trace_decoder_perfevent_t*

337 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_WAVE, ///< rocprofiler_thread_trace_decoder_wave_t*

338 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_INFO, ///< rocprofiler_thread_trace_decoder_info_t*

339 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_EVENT, ///< rocprofiler_thread_trace_decoder_event_t*

340 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_SHADERDATA, ///< rocprofiler_thread_trace_decoder_shaderdata_t*

341 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_REALTIME, ///< rocprofiler_thread_trace_decoder_realtime_t*

342 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_RT_FREQUENCY,

343 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_INST_OTHER_SIMD,

344 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_DISPATCH,

345 ROCPROFILER_THREAD_TRACE_DECODER_RECORD_LAST

346

347 /// @var ROCPROFILER_THREAD_TRACE_DECODER_RECORD_RT_FREQUENCY

348 /// @brief uint64_t*. Realtime clock frequency in Hz.

349 /// @var ROCPROFILER_THREAD_TRACE_DECODER_RECORD_INST_OTHER_SIMD

350 /// @brief rocprofiler_thread_trace_decoder_inst_other_simd_t*. Instruction issue on other simd.

351} rocprofiler_thread_trace_decoder_record_type_t;

rocprofiler_thread_trace_decoder_record_type_t

rocprofiler_thread_trace_decoder_record_type_t

Defines the type of payload received by rocprofiler_thread_trace_decoder_callback_t.

Definition trace_decoder_types.h:333

ROCPROFILER_THREAD_TRACE_DECODER_RECORD_GFXIP

@ ROCPROFILER_THREAD_TRACE_DECODER_RECORD_GFXIP

Record is gfxip_major, type uint64_t.

Definition trace_decoder_types.h:334

ROCPROFILER_THREAD_TRACE_DECODER_RECORD_SHADERDATA

@ ROCPROFILER_THREAD_TRACE_DECODER_RECORD_SHADERDATA

rocprofiler_thread_trace_decoder_shaderdata_t*

Definition trace_decoder_types.h:340

ROCPROFILER_THREAD_TRACE_DECODER_RECORD_EVENT

@ ROCPROFILER_THREAD_TRACE_DECODER_RECORD_EVENT

rocprofiler_thread_trace_decoder_event_t*

Definition trace_decoder_types.h:339

ROCPROFILER_THREAD_TRACE_DECODER_RECORD_INFO

@ ROCPROFILER_THREAD_TRACE_DECODER_RECORD_INFO

rocprofiler_thread_trace_decoder_info_t*

Definition trace_decoder_types.h:338

ROCPROFILER_THREAD_TRACE_DECODER_RECORD_OCCUPANCY

@ ROCPROFILER_THREAD_TRACE_DECODER_RECORD_OCCUPANCY

rocprofiler_thread_trace_decoder_occupancy_t*

Definition trace_decoder_types.h:335

ROCPROFILER_THREAD_TRACE_DECODER_RECORD_WAVE

@ ROCPROFILER_THREAD_TRACE_DECODER_RECORD_WAVE

rocprofiler_thread_trace_decoder_wave_t*

Definition trace_decoder_types.h:337

ROCPROFILER_THREAD_TRACE_DECODER_RECORD_REALTIME

@ ROCPROFILER_THREAD_TRACE_DECODER_RECORD_REALTIME

rocprofiler_thread_trace_decoder_realtime_t*

Definition trace_decoder_types.h:341

ROCPROFILER_THREAD_TRACE_DECODER_RECORD_PERFEVENT

@ ROCPROFILER_THREAD_TRACE_DECODER_RECORD_PERFEVENT

rocprofiler_thread_trace_decoder_perfevent_t*

Definition trace_decoder_types.h:336

◆ rocprofiler_thread_trace_decoder_shaderdata_flags_t

enum rocprofiler_thread_trace_decoder_shaderdata_flags_t

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder_types.h>

Bitmask of additional information for shaderdata_t Added in rocprof-trace-decoder 0.1.3.

Definition at line 204 of file trace_decoder_types.h.

205{

206 ROCPROFILER_THREAD_TRACE_DECODER_SHADERDATA_FLAGS_IMM = 0,

207 ROCPROFILER_THREAD_TRACE_DECODER_SHADERDATA_FLAGS_PRIV ///< Generated by the trap handler

208

209 /// @var ROCPROFILER_THREAD_TRACE_DECODER_SHADERDATA_FLAGS_IMM

210 /// @brief Value comes from s_ttracedata_imm.

211} rocprofiler_thread_trace_decoder_shaderdata_flags_t;

rocprofiler_thread_trace_decoder_shaderdata_flags_t

rocprofiler_thread_trace_decoder_shaderdata_flags_t

Bitmask of additional information for shaderdata_t Added in rocprof-trace-decoder 0....

Definition trace_decoder_types.h:205

◆ rocprofiler_thread_trace_decoder_wstate_type_t

enum rocprofiler_thread_trace_decoder_wstate_type_t

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder_types.h>

Wave state type.

Definition at line 99 of file trace_decoder_types.h.

100{

101 ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_EMPTY = 0,

102 ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_IDLE,

103 ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_EXEC,

104 ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_WAIT,

105 ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_STALL,

106 ROCPROFILER_THREAD_TRACE_DECODER_WSTATE_LAST,

107} rocprofiler_thread_trace_decoder_wstate_type_t;

rocprofiler_thread_trace_decoder_wstate_type_t

rocprofiler_thread_trace_decoder_wstate_type_t

Wave state type.

Definition trace_decoder_types.h:100

◆ rocprofiler_thread_trace_parameter_buffering_mode_t

enum rocprofiler_thread_trace_parameter_buffering_mode_t

#include <rocprofiler-sdk/experimental/thread-trace/core.h>

Types of Thread Trace buffering modes ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_NONE defines no preference TRIPLE_BUFFER is currently only available for a single shader engine at a time.

Definition at line 45 of file core.h.

46{

47 ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_NONE = 0,

48 ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_SINGLE_BUFFER,

49 ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_TRIPLE_BUFFER,

50 ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_LAST

51} rocprofiler_thread_trace_parameter_buffering_mode_t;

rocprofiler_thread_trace_parameter_buffering_mode_t

rocprofiler_thread_trace_parameter_buffering_mode_t

Types of Thread Trace buffering modes ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE_NONE defines ...

Definition core.h:46

◆ rocprofiler_thread_trace_parameter_type_t

enum rocprofiler_thread_trace_parameter_type_t

#include <rocprofiler-sdk/experimental/thread-trace/core.h>

Types of Thread Trace parameters.

Enumerator
ROCPROFILER_THREAD_TRACE_PARAMETER_TARGET_CU	Select the Target CU or WGP.
ROCPROFILER_THREAD_TRACE_PARAMETER_SHADER_ENGINE_MASK	Bitmask of shader engines.
ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFER_SIZE	Size of combined GPU buffer for ATT.
ROCPROFILER_THREAD_TRACE_PARAMETER_SIMD_SELECT	Bitmask (GFX9) or ID (Navi) of SIMDs.
ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTERS_CTRL	Period [1,32] or disable (0) perfmon.
ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTER	Perfmon ID and SIMD mask. gfx9 only.
ROCPROFILER_THREAD_TRACE_PARAMETER_SERIALIZE_ALL	Serializes also kernels not under thread trace.
ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTER_EXCLUDE_MASK	Bitmask of which compute units to exclude from perfcounters. gfx9 only.
ROCPROFILER_THREAD_TRACE_PARAMETER_NO_DETAIL	Dont collect instruction timing, only shader-wide information.
ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE	Enables GPU Triple buffering.

Definition at line 57 of file core.h.

58{

59 ROCPROFILER_THREAD_TRACE_PARAMETER_TARGET_CU = 0, ///< Select the Target CU or WGP

60 ROCPROFILER_THREAD_TRACE_PARAMETER_SHADER_ENGINE_MASK, ///< Bitmask of shader engines.

61 ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFER_SIZE, ///< Size of combined GPU buffer for ATT

62 ROCPROFILER_THREAD_TRACE_PARAMETER_SIMD_SELECT, ///< Bitmask (GFX9) or ID (Navi) of SIMDs

63 ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTERS_CTRL, ///< Period [1,32] or disable (0) perfmon

64 ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTER, ///< Perfmon ID and SIMD mask. gfx9 only

65 ROCPROFILER_THREAD_TRACE_PARAMETER_SERIALIZE_ALL, ///< Serializes also kernels not under

66 ///< thread trace

67 ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTER_EXCLUDE_MASK, ///< Bitmask of which compute

68 ///< units to exclude from

69 ///< perfcounters. gfx9 only

70 ROCPROFILER_THREAD_TRACE_PARAMETER_NO_DETAIL, ///< Dont collect instruction timing,

71 ///< only shader-wide information

72 ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE, ///< Enables GPU Triple buffering.

73 ROCPROFILER_THREAD_TRACE_PARAMETER_LAST

74} rocprofiler_thread_trace_parameter_type_t;

rocprofiler_thread_trace_parameter_type_t

rocprofiler_thread_trace_parameter_type_t

Types of Thread Trace parameters.

Definition core.h:58

ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTER_EXCLUDE_MASK

@ ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTER_EXCLUDE_MASK

Bitmask of which compute units to exclude from perfcounters. gfx9 only.

Definition core.h:67

ROCPROFILER_THREAD_TRACE_PARAMETER_SHADER_ENGINE_MASK

@ ROCPROFILER_THREAD_TRACE_PARAMETER_SHADER_ENGINE_MASK

Bitmask of shader engines.

Definition core.h:60

ROCPROFILER_THREAD_TRACE_PARAMETER_NO_DETAIL

@ ROCPROFILER_THREAD_TRACE_PARAMETER_NO_DETAIL

Dont collect instruction timing, only shader-wide information.

Definition core.h:70

ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFER_SIZE

@ ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFER_SIZE

Size of combined GPU buffer for ATT.

Definition core.h:61

ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTERS_CTRL

@ ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTERS_CTRL

Period [1,32] or disable (0) perfmon.

Definition core.h:63

ROCPROFILER_THREAD_TRACE_PARAMETER_SERIALIZE_ALL

@ ROCPROFILER_THREAD_TRACE_PARAMETER_SERIALIZE_ALL

Serializes also kernels not under thread trace.

Definition core.h:65

ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE

@ ROCPROFILER_THREAD_TRACE_PARAMETER_BUFFERING_MODE

Enables GPU Triple buffering.

Definition core.h:72

ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTER

@ ROCPROFILER_THREAD_TRACE_PARAMETER_PERFCOUNTER

Perfmon ID and SIMD mask. gfx9 only.

Definition core.h:64

ROCPROFILER_THREAD_TRACE_PARAMETER_SIMD_SELECT

@ ROCPROFILER_THREAD_TRACE_PARAMETER_SIMD_SELECT

Bitmask (GFX9) or ID (Navi) of SIMDs.

Definition core.h:62

ROCPROFILER_THREAD_TRACE_PARAMETER_TARGET_CU

@ ROCPROFILER_THREAD_TRACE_PARAMETER_TARGET_CU

Select the Target CU or WGP.

Definition core.h:59

◆ rocprofiler_thread_trace_shader_data_flags_t

enum rocprofiler_thread_trace_shader_data_flags_t

#include <rocprofiler-sdk/experimental/thread-trace/core.h>

Flags for the data received in rocprofiler_thread_trace_shader_data_callback_t The last record takes on the flag ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_END. If the CPU or GPU buffer cannot be flushed during the trace, the trace will be interrupted and one (or both) of the buffer full flags will be set. When this happens, the trace will be disabled for that agent until all the shader data is flushed and then re-enabled.

Definition at line 101 of file core.h.

102{

103 ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_NONE = 0,

104 ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_END = 1 << 0,

105 ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_GPU_BUFFER_FULL = 1 << 1,

106 ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_CPU_BUFFER_FULL = 1 << 2,

107 ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_LAST =

108 ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_CPU_BUFFER_FULL

109

110 /// @var ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_END

111 /// @brief This is the last record for shader engine.

112 /// @var ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_GPU_BUFFER_FULL

113 /// @brief Trace was interrupted due to GPU buffer full. For triple buffering, this usually

114 /// happens when the profiler was unable to retrieve data from the GPU fast enough. For single

115 /// buffer, this usually happens when the buffer is not large enough.

116 /// @var ROCPROFILER_THREAD_TRACE_SHADER_DATA_FLAGS_CPU_BUFFER_FULL

117 /// @brief Trace was interrupted due to CPU buffer locked. This usually happens when the user

118 /// handling of rocprofiler_thread_trace_shader_data_callback_t takes too long.

119} rocprofiler_thread_trace_shader_data_flags_t;

rocprofiler_thread_trace_shader_data_flags_t

rocprofiler_thread_trace_shader_data_flags_t

Flags for the data received in rocprofiler_thread_trace_shader_data_callback_t The last record takes ...

Definition core.h:102

Function Documentation

◆ rocprofiler_configure_device_thread_trace_service()

rocprofiler_status_t rocprofiler_configure_device_thread_trace_service	(	rocprofiler_context_id_t	context_id,
		rocprofiler_agent_id_t	agent_id,
		rocprofiler_thread_trace_parameter_t *	parameters,
		unsigned long	num_parameters,
		rocprofiler_thread_trace_shader_data_callback_t	shader_callback,
		rocprofiler_user_data_t	callback_userdata
	)

#include <rocprofiler-sdk/experimental/thread-trace/agent.h>

Configure Thread Trace Service for agent. There may only be one agent profile configured per context and can be only one active context that is profiling a single agent at a time. Multiple agent contexts can be started at the same time if they are profiling different agents.

Parameters

[in]	context_id	context id
[in]	parameters	List of ATT-specific parameters.
[in]	num_parameters	Number of parameters. Zero is allowed.
[in]	agent_id	agent to configure profiling on.
[in]	shader_callback	Callback fn where the collected data will be sent to.
[in]	callback_userdata	Passed back to user in shader_callback.

Returns

rocprofiler_status_t

Return values

ROCPROFILER_STATUS_SUCCESS	on success
ROCPROFILER_STATUS_ERROR_CONFIGURATION_LOCKED	for configuration locked
ROCPROFILER_STATUS_ERROR_CONTEXT_INVALID	for conflicting configurations in the same ctx
ROCPROFILER_STATUS_ERROR_CONTEXT_NOT_FOUND	for invalid context id
ROCPROFILER_STATUS_ERROR_INVALID_ARGUMENT	for invalid rocprofiler_thread_trace_parameter_t

◆ rocprofiler_configure_dispatch_thread_trace_service()

rocprofiler_status_t rocprofiler_configure_dispatch_thread_trace_service	(	rocprofiler_context_id_t	context_id,
		rocprofiler_agent_id_t	agent_id,
		rocprofiler_thread_trace_parameter_t *	parameters,
		unsigned long	num_parameters,
		rocprofiler_thread_trace_dispatch_callback_t	dispatch_callback,
		rocprofiler_thread_trace_shader_data_callback_t	shader_callback,
		void *	callback_userdata
	)

#include <rocprofiler-sdk/experimental/thread-trace/dispatch.h>

Enables the thread trace service for dispatch-based tracing. The tool has an option to enable/disable thread trace on every dispatch callback. This service serializes all traced kernels, and optionally all non-traced kernels.

Parameters

[in]	context_id	id of the context used for start/stop thread_trace.
[in]	agent_id	rocprofiler_agent_id_t to configure thread trace.
[in]	parameters	List of ATT-specific parameters.
[in]	num_parameters	Number of parameters. Zero is allowed.
[in]	dispatch_callback	Control fn which decides when TT starts/stop collecting.
[in]	shader_callback	Callback fn where the collected data will be sent to.
[in]	callback_userdata	Passed back to user in dispatch_callback.

Returns

rocprofiler_status_t

Return values

ROCPROFILER_STATUS_SUCCESS	on success
ROCPROFILER_STATUS_ERROR_CONFIGURATION_LOCKED	for configuration locked
ROCPROFILER_STATUS_ERROR_CONTEXT_INVALID	for conflicting configurations in the same ctx
ROCPROFILER_STATUS_ERROR_CONTEXT_NOT_FOUND	for invalid context id
ROCPROFILER_STATUS_ERROR_INVALID_ARGUMENT	for invalid rocprofiler_thread_trace_parameter_t
ROCPROFILER_STATUS_ERROR_SERVICE_ALREADY_CONFIGURED	if already configured

◆ rocprofiler_thread_trace_decoder_codeobj_load()

rocprofiler_status_t rocprofiler_thread_trace_decoder_codeobj_load	(	rocprofiler_thread_trace_decoder_id_t	handle,
		uint64_t	load_id,
		uint64_t	load_addr,
		uint64_t	load_size,
		const void *	data,
		uint64_t	size
	)

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder.h>

Loads a code object binary to match with Thread Trace. The size, data and load_* are reported by rocprofiler-sdk's code object tracing service. Used for the decoder library to know what code objects to look into when decoding shader data. Not all application code objects are required to be reported here, only the ones containing code executed at the time the shader data was collected by thread_trace services. If a code object not reported here is encountered while decoding shader data, a record of type INFO_STITCH_INCOMPLETE will be generated and instructions will not be reported with a PC address.

Parameters

[in]	handle	Handle to decoder instance.
[in]	load_id	Code object load ID.
[in]	load_addr	Code object load address.
[in]	load_size	Code object load size.
[in]	data	Code object binary data.
[in]	size	Code object binary data size.

Returns

rocprofiler_status_t

Return values

ROCPROFILER_STATUS_ERROR	Unable to load code object.
ROCPROFILER_STATUS_ERROR_INVALID_ARGUMENT	Invalid handle
ROCPROFILER_STATUS_SUCCESS	Code object loaded

◆ rocprofiler_thread_trace_decoder_codeobj_unload()

rocprofiler_status_t rocprofiler_thread_trace_decoder_codeobj_unload	(	rocprofiler_thread_trace_decoder_id_t	handle,
		uint64_t	load_id
	)

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder.h>

Unloads a code object binary.

Parameters

[in]	handle	Handle to decoder instance.
[in]	load_id	Code object load ID to remove.

Returns

rocprofiler_status_t

Return values

ROCPROFILER_STATUS_ERROR	Code object not loaded.
ROCPROFILER_STATUS_ERROR_INVALID_ARGUMENT	Invalid handle
ROCPROFILER_STATUS_SUCCESS	Code object unloaded

◆ rocprofiler_thread_trace_decoder_create()

rocprofiler_status_t rocprofiler_thread_trace_decoder_create	(	rocprofiler_thread_trace_decoder_id_t *	handle,
		const char *	path
	)

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder.h>

Initializes Trace Decoder library with a library search path.

Parameters

[out]	handle	Handle to created decoder instance.
[in]	path	Path to trace decoder library location (e.g. /opt/rocm/lib).

Returns

rocprofiler_status_t

Return values

ROCPROFILER_STATUS_ERROR_NOT_AVAILABLE	Library not found
ROCPROFILER_STATUS_ERROR_INCOMPATIBLE_ABI	Library found but version not supported
ROCPROFILER_STATUS_SUCCESS	Handle created

◆ rocprofiler_thread_trace_decoder_destroy()

void rocprofiler_thread_trace_decoder_destroy

(

rocprofiler_thread_trace_decoder_id_t

handle

)

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder.h>

Deletes handle created by rocprofiler_thread_trace_decoder_create.

Parameters

[in]

handle

Handle to destroy

◆ rocprofiler_thread_trace_decoder_info_string()

const char * rocprofiler_thread_trace_decoder_info_string	(	rocprofiler_thread_trace_decoder_id_t	handle,
		rocprofiler_thread_trace_decoder_info_t	info
	)

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder.h>

Returns the string description of a rocprofiler_thread_trace_decoder_info_t record.

Parameters

[in]	handle	Decoder handle
[in]	info	The decoder info received

Return values

null	terminated string as description of "info".

◆ rocprofiler_trace_decode()

rocprofiler_status_t rocprofiler_trace_decode	(	rocprofiler_thread_trace_decoder_id_t	handle,
		rocprofiler_thread_trace_decoder_callback_t	callback,
		void *	data,
		uint64_t	size,
		void *	userdata
	)

#include <rocprofiler-sdk/experimental/thread-trace/trace_decoder.h>

Decodes shader data returned by rocprofiler_thread_trace_shader_data_callback_t. Use rocprofiler_thread_trace_decoder_codeobj_load to add references to loaded code objects during the trace. A rocprofiler_thread_trace_decoder_callback_t returns decoded data back to user. The first record is always of type ROCPROFILER_THREAD_TRACE_DECODER_RECORD_GFXIP.

Parameters

[in]	handle	Decoder handle
[in]	callback	Decoded trace data returned to user.
[in]	data	Thread trace binary data.
[in]	size	Thread trace binary size.
[in]	userdata	Userdata passed back to caller via callback.

Returns

rocprofiler_status_t

Return values

ROCPROFILER_STATUS_ERROR_INVALID_ARGUMENT	invalid argument
ROCPROFILER_STATUS_ERROR_AGENT_ARCH_NOT_SUPPORTED	arch not supported
ROCPROFILER_STATUS_ERROR	generic error
ROCPROFILER_STATUS_SUCCESS	on success

---

Generated by  1.9.8