ROCTx Utility functions

ROCTx developer API 1.0.0 ROCm Profiling API and tools

Functions

ROCTx Utility functions

Utility functions for profiling tools to customize their behavior. More...

Functions
int	roctxNameOsThread (const char *name)
	Indicate to a profiling tool that, where possible, you would like the current CPU OS thread to be labeled by the provided name in the output of the profiling tool.
int	roctxNameHsaAgent (const char *name, const struct hsa_agent_s *agent)
	Indicate to a profiling tool that, where possible, you would like the given HSA agent to be labeled by the provided name in the output of the profiling tool.
int	roctxNameHipDevice (const char *name, int device_id)
	Indicate to a profiling tool that, where possible, you would like the given HIP device id to be labeled by the provided name in the output of the profiling tool.
int	roctxNameHipStream (const char *name, const struct ihipStream_t *stream)
	Indicate to a profiling tool that, where possible, you would like the given HIP stream to be labeled by the provided name in the output of the profiling tool.
int	roctxGetThreadId (roctx_thread_id_t *tid)
	Retrieve a id value for the current thread which will be identical to the id value a profiling tool gets via rocprofiler_get_thread_id(rocprofiler_thread_id_t*)

Detailed Description

Utility functions for profiling tools to customize their behavior.

Function Documentation

◆ roctxGetThreadId()

int roctxGetThreadId

(

roctx_thread_id_t *

tid

)

#include <rocprofiler-sdk-roctx/roctx.h>

Retrieve a id value for the current thread which will be identical to the id value a profiling tool gets via rocprofiler_get_thread_id(rocprofiler_thread_id_t*)

Parameters

tid	[out] Pointer to where the value should be placed

Returns

int A profiling tool may choose to set this value to a non-zero value to indicate a failure while executing the request or lack of support

◆ roctxNameHipDevice()

int roctxNameHipDevice	(	const char *	name,
		int	device_id
	)

#include <rocprofiler-sdk-roctx/roctx.h>

Indicate to a profiling tool that, where possible, you would like the given HIP device id to be labeled by the provided name in the output of the profiling tool.

Rocprofiler does not provide any explicit support for how profiling tools handle this request: support for this capability is tool specific.

Parameters

[in]	name	Name for the specified device
[in]	device_id	HIP device ordinal

Returns

int A profiling tool may choose to set this value to a non-zero value to indicate a failure while executing the request or lack of support

◆ roctxNameHipStream()

int roctxNameHipStream	(	const char *	name,
		const struct ihipStream_t *	stream
	)

#include <rocprofiler-sdk-roctx/roctx.h>

Indicate to a profiling tool that, where possible, you would like the given HIP stream to be labeled by the provided name in the output of the profiling tool.

Rocprofiler does not provide any explicit support for how profiling tools handle this request: support for this capability is tool specific.

Parameters

[in]	name	Name for the specified stream
[in]	stream	A hipStream_t value (hipStream_t == ihipStream_t*)

Returns

int A profiling tool may choose to set this value to a non-zero value to indicate a failure while executing the request or lack of support

◆ roctxNameHsaAgent()

int roctxNameHsaAgent	(	const char *	name,
		const struct hsa_agent_s *	agent
	)

#include <rocprofiler-sdk-roctx/roctx.h>

Indicate to a profiling tool that, where possible, you would like the given HSA agent to be labeled by the provided name in the output of the profiling tool.

Rocprofiler does not provide any explicit support for how profiling tools handle this request: support for this capability is tool specific.

Parameters

[in]	name	Name for the specified agent
[in]	agent	Pointer to a HSA agent identifier

Returns

int A profiling tool may choose to set this value to a non-zero value to indicate a failure while executing the request or lack of support

◆ roctxNameOsThread()

int roctxNameOsThread

(

const char *

name

)

#include <rocprofiler-sdk-roctx/roctx.h>

Indicate to a profiling tool that, where possible, you would like the current CPU OS thread to be labeled by the provided name in the output of the profiling tool.

Rocprofiler does not provide explicit support for how profiling tools handle this request: support for this capability is tool specific. ROCTx does NOT rename the thread via pthread_setname_np.

Parameters

[in]

name

Name for the current OS thread

Returns

int A profiling tool may choose to set this value to a non-zero value to indicate a failure while executing the request or lack of support

---

Generated by  1.9.8