Threads

Give names to threads. More...

Collaboration diagram for Threads:

Topics
	Domains
	Domains group.
	IDs
	IDs group.
	String Handles
	String Handles group.
	Task Group
	Task Group.
	Tasks
	A task instance represents a piece of work performed by a particular thread for a period of time.
	Markers
	Markers represent a single discreet event in time.
	Metadata
	The metadata API is used to attach extra information to named entities.
	Relations
	Instances of named entities can be explicitly associated with other instances using instance IDs and the relationship API calls.
	Counters
	Counters are user-defined objects with a monotonically increasing value.

Macros
#define	__itt_thread_set_name   __itt_thread_set_nameA
#define	__itt_thread_set_name_ptr   __itt_thread_set_nameA_ptr
#define	__itt_timestamp_none   ((__itt_timestamp)-1LL)
#define	__itt_counter_set_value   ITTNOTIFY_VOID(counter_set_value)
#define	__itt_counter_set_value_ptr   ITTNOTIFY_NAME(counter_set_value)
#define	__itt_counter_create_typed   __itt_counter_create_typedA
#define	__itt_counter_create_typed_ptr   __itt_counter_create_typedA_ptr
#define	__itt_counter_create_typedA   ITTNOTIFY_DATA(counter_create_typedA)
#define	__itt_counter_create_typedA_ptr   ITTNOTIFY_NAME(counter_create_typedA)
#define	__itt_counter_create_typedW   ITTNOTIFY_DATA(counter_create_typedW)
#define	__itt_counter_create_typedW_ptr   ITTNOTIFY_NAME(counter_create_typedW)
#define	__itt_counter_destroy   ITTNOTIFY_VOID(counter_destroy)
#define	__itt_counter_destroy_ptr   ITTNOTIFY_NAME(counter_destroy)

Functions
void ITTAPI	__itt_thread_set_nameA (const char *name)
	Sets thread name of calling thread.
void ITTAPI	__itt_thread_set_nameW (const wchar_t *name)
__itt_clock_domain *ITTAPI	__itt_clock_domain_create (__itt_get_clock_info_fn fn, void *fn_data)
	Create a clock domain.
void ITTAPI	__itt_clock_domain_reset (void)
	Recalculate clock domains frequencies and clock base timestamps.
void ITTAPI	__itt_id_create_ex (const __itt_domain *domain, __itt_clock_domain *clock_domain, unsigned long long timestamp, __itt_id id)
	Create an instance of identifier.
void ITTAPI	__itt_id_destroy_ex (const __itt_domain *domain, __itt_clock_domain *clock_domain, unsigned long long timestamp, __itt_id id)
	Destroy an instance of identifier.
void ITTAPI	__itt_task_begin_ex (const __itt_domain *domain, __itt_clock_domain *clock_domain, unsigned long long timestamp, __itt_id taskid, __itt_id parentid, __itt_string_handle *name)
	Begin a task instance.
void ITTAPI	__itt_task_begin_fn_ex (const __itt_domain *domain, __itt_clock_domain *clock_domain, unsigned long long timestamp, __itt_id taskid, __itt_id parentid, void *fn)
	Begin a task instance.
void ITTAPI	__itt_task_end_ex (const __itt_domain *domain, __itt_clock_domain *clock_domain, unsigned long long timestamp)
	End the current task instance.
void ITTAPI	__itt_counter_set_value (__itt_counter id, void *value_ptr)
	Set the counter value.
void ITTAPI	__itt_counter_set_value_ex (__itt_counter id, __itt_clock_domain *clock_domain, unsigned long long timestamp, void *value_ptr)
	Set the counter value.
__itt_counter ITTAPI	__itt_counter_create_typedA (const char *name, const char *domain, __itt_metadata_type type)
	Create a typed counter with given name/domain.
__itt_counter ITTAPI	__itt_counter_create_typedW (const wchar_t *name, const wchar_t *domain, __itt_metadata_type type)
	ITT_STUB (ITTAPI, __itt_counter, counter_create_typedA,(const char *name, const char *domain, __itt_metadata_type type)) ITT_STUB(ITTAPI
void ITTAPI	__itt_counter_destroy (__itt_counter id)
	Destroy the counter identified by the pointer previously returned by __itt_counter_create() or __itt_counter_create_typed()

Variables
	__itt_counter
	counter_create_typedW
void const char const char int ITT_FORMAT __itt_group_sync x void const char *	name
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void ITT_FORMAT p void ITT_FORMAT p void size_t ITT_FORMAT d void ITT_FORMAT p const wchar_t ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s no args void ITT_FORMAT p size_t ITT_FORMAT d no args const wchar_t const wchar_t *	domain

Detailed Description

Give names to threads.

Macro Definition Documentation

__itt_counter_create_typed

#define __itt_counter_create_typed   __itt_counter_create_typedA

Definition at line 3460 of file ittnotify.h.

__itt_counter_create_typed_ptr

#define __itt_counter_create_typed_ptr   __itt_counter_create_typedA_ptr

Definition at line 3461 of file ittnotify.h.

__itt_counter_create_typedA

#define __itt_counter_create_typedA   ITTNOTIFY_DATA(counter_create_typedA)

Definition at line 3481 of file ittnotify.h.

__itt_counter_create_typedA_ptr

#define __itt_counter_create_typedA_ptr   ITTNOTIFY_NAME(counter_create_typedA)

Definition at line 3482 of file ittnotify.h.

__itt_counter_create_typedW

#define __itt_counter_create_typedW   ITTNOTIFY_DATA(counter_create_typedW)

Definition at line 3483 of file ittnotify.h.

__itt_counter_create_typedW_ptr

#define __itt_counter_create_typedW_ptr   ITTNOTIFY_NAME(counter_create_typedW)

Definition at line 3484 of file ittnotify.h.

__itt_counter_destroy

#define __itt_counter_destroy   ITTNOTIFY_VOID(counter_destroy)

Definition at line 3520 of file ittnotify.h.

__itt_counter_destroy_ptr

#define __itt_counter_destroy_ptr   ITTNOTIFY_NAME(counter_destroy)

Definition at line 3521 of file ittnotify.h.

__itt_counter_set_value

#define __itt_counter_set_value   ITTNOTIFY_VOID(counter_set_value)

Definition at line 3404 of file ittnotify.h.

__itt_counter_set_value_ptr

#define __itt_counter_set_value_ptr   ITTNOTIFY_NAME(counter_set_value)

Definition at line 3405 of file ittnotify.h.

__itt_thread_set_name

#define __itt_thread_set_name   __itt_thread_set_nameA

Definition at line 484 of file ittnotify.h.

__itt_thread_set_name_ptr

#define __itt_thread_set_name_ptr   __itt_thread_set_nameA_ptr

Definition at line 485 of file ittnotify.h.

__itt_timestamp_none

#define __itt_timestamp_none   ((__itt_timestamp)-1LL)

Definition at line 2140 of file ittnotify.h.

Function Documentation

__itt_clock_domain_create()

__itt_clock_domain *ITTAPI __itt_clock_domain_create	(	__itt_get_clock_info_fn	fn,
		void *	fn_data )

Create a clock domain.

Certain applications require the capability to trace their application using a clock domain different than the CPU, for instance the instrumentation of events that occur on a GPU. Because the set of domains is expected to be static over the application's execution time, there is no mechanism to destroy a domain. Any domain can be accessed by any thread in the process, regardless of which thread created the domain. This call is thread-safe.

Parameters

[in]	fn	A pointer to a callback function which retrieves alternative CPU timestamps
[in]	fn_data	Argument for a callback function; may be NULL

References fn.

__itt_clock_domain_reset()

void ITTAPI __itt_clock_domain_reset

(

void

)

Recalculate clock domains frequencies and clock base timestamps.

References clock_domain_reset.

__itt_counter_create_typedA()

__itt_counter ITTAPI __itt_counter_create_typedA	(	const char *	name,
		const char *	domain,
		__itt_metadata_type	type )

Create a typed counter with given name/domain.

After __itt_counter_create_typed() is called, __itt_counter_inc(id), __itt_counter_inc_delta(id, delta), __itt_counter_set_value(id, value_ptr) or __itt_counter_set_value_ex(id, clock_domain, timestamp, value_ptr) can be used to change the value of the counter

References __itt_counter, domain, name, and type.

__itt_counter_create_typedW()

__itt_counter ITTAPI __itt_counter_create_typedW	(	const wchar_t *	name,
		const wchar_t *	domain,
		__itt_metadata_type	type )

References __itt_counter, domain, name, and type.

__itt_counter_destroy()

void ITTAPI __itt_counter_destroy

(

__itt_counter

id

)

Destroy the counter identified by the pointer previously returned by __itt_counter_create() or __itt_counter_create_typed()

References __itt_counter, and counter_destroy.

__itt_counter_set_value()

void ITTAPI __itt_counter_set_value	(	__itt_counter	id,
		void *	value_ptr )

Set the counter value.

References __itt_counter, and value_ptr.

__itt_counter_set_value_ex()

void ITTAPI __itt_counter_set_value_ex	(	__itt_counter	id,
		__itt_clock_domain *	clock_domain,
		unsigned long long	timestamp,
		void *	value_ptr )

Set the counter value.

References __itt_counter, clock_domain, counter_set_value_ex, timestamp, and value_ptr.

__itt_id_create_ex()

void ITTAPI __itt_id_create_ex	(	const __itt_domain *	domain,
		__itt_clock_domain *	clock_domain,
		unsigned long long	timestamp,
		__itt_id	id )

Create an instance of identifier.

This establishes the beginning of the lifetime of an instance of the given ID in the trace. Once this lifetime starts, the ID can be used to tag named entity instances in calls such as __itt_task_begin, and to specify relationships among identified named entity instances, using the Relations APIs.

Parameters

[in]	domain	The domain controlling the execution of this call.
[in]	clock_domain	The clock domain controlling the execution of this call.
[in]	timestamp	The user defined timestamp.
[in]	id	The ID to create.

References clock_domain, domain, and timestamp.

__itt_id_destroy_ex()

void ITTAPI __itt_id_destroy_ex	(	const __itt_domain *	domain,
		__itt_clock_domain *	clock_domain,
		unsigned long long	timestamp,
		__itt_id	id )

Destroy an instance of identifier.

This ends the lifetime of the current instance of the given ID value in the trace. Any relationships that are established after this lifetime ends are invalid. This call must be performed before the given ID value can be reused for a different named entity instance.

Parameters

[in]	domain	The domain controlling the execution of this call.
[in]	clock_domain	The clock domain controlling the execution of this call.
[in]	timestamp	The user defined timestamp.
[in]	id	The ID to destroy.

References clock_domain, domain, id_destroy_ex, and timestamp.

__itt_task_begin_ex()

void ITTAPI __itt_task_begin_ex	(	const __itt_domain *	domain,
		__itt_clock_domain *	clock_domain,
		unsigned long long	timestamp,
		__itt_id	taskid,
		__itt_id	parentid,
		__itt_string_handle *	name )

Begin a task instance.

Parameters

[in]	domain	The domain for this task
[in]	clock_domain	The clock domain controlling the execution of this call.
[in]	timestamp	The user defined timestamp.
[in]	taskid	The instance ID for this task instance, or __itt_null
[in]	parentid	The parent instance to which this task instance belongs, or __itt_null
[in]	name	The name of this task

References clock_domain, domain, name, parentid, and timestamp.

__itt_task_begin_fn_ex()

void ITTAPI __itt_task_begin_fn_ex	(	const __itt_domain *	domain,
		__itt_clock_domain *	clock_domain,
		unsigned long long	timestamp,
		__itt_id	taskid,
		__itt_id	parentid,
		void *	fn )

Begin a task instance.

Parameters

[in]	domain	The domain for this task
[in]	clock_domain	The clock domain controlling the execution of this call.
[in]	timestamp	The user defined timestamp.
[in]	taskid	The identifier for this task instance, or __itt_null
[in]	parentid	The parent of this task, or __itt_null
[in]	fn	The pointer to the function you are tracing

References clock_domain, domain, fn, parentid, and timestamp.

__itt_task_end_ex()

void ITTAPI __itt_task_end_ex	(	const __itt_domain *	domain,
		__itt_clock_domain *	clock_domain,
		unsigned long long	timestamp )

End the current task instance.

Parameters

[in]	domain	The domain for this task
[in]	clock_domain	The clock domain controlling the execution of this call.
[in]	timestamp	The user defined timestamp.

References __itt_counter, clock_domain, domain, fn, name, parentid, task_begin_fn_ex, and timestamp.

__itt_thread_set_nameA()

void ITTAPI __itt_thread_set_nameA

(

const char *

name

)

Sets thread name of calling thread.

Parameters

[in]

name

- name of thread

References name.

__itt_thread_set_nameW()

void ITTAPI __itt_thread_set_nameW

(

const wchar_t *

name

)

References name.

ITT_STUB()

ITT_STUB	(	ITTAPI	,
		__itt_counter	,
		counter_create_typedA	,
		(const char *name, const char *domain, __itt_metadata_type type)	)

References __itt_counter, domain, name, and type.

Referenced by ITT_STUB(), ITT_STUB(), ITT_STUB(), ITT_STUB(), ITT_STUB(), ITT_STUB(), ITT_STUB(), ITT_STUB(), and ITT_STUB().

Variable Documentation

__itt_counter

__itt_counter

Definition at line 3474 of file ittnotify.h.

Referenced by __itt_counter_create_typedA(), __itt_counter_create_typedW(), __itt_counter_dec_delta(), __itt_counter_destroy(), __itt_counter_inc(), __itt_counter_inc_delta(), __itt_counter_set_value(), __itt_counter_set_value_ex(), __itt_task_end_ex(), ITT_STUB(), ITT_STUBV(), ITT_STUBV(), ITT_STUBV(), ITT_STUBV(), and ITT_STUBV().

counter_create_typedW

counter_create_typedW

Definition at line 3474 of file ittnotify.h.

domain

const wchar_t const wchar_t * domain

Definition at line 296 of file ittnotify_static.h.

name

const wchar_t * name

Definition at line 160 of file ittnotify_static.h.