nvtxSyncUserAttributes_t Struct Reference

User Defined Synchronization Object Attributes Structure. . More...

#include <nvToolsExtSync.h>

Data Fields
uint16_t	version
	Version flag of the structure.
uint16_t	size
	Size of the structure.
int32_t	messageType
	Message type specified in this attribute structure.
nvtxMessageValue_t	message
	Message assigned to this attribute structure.

Detailed Description

User Defined Synchronization Object Attributes Structure. .

This structure is used to describe the attributes of a user defined synchronization object. The layout of the structure is defined by a specific version of the tools extension library and can change between different versions of the Tools Extension library.

Initializing the Attributes

The caller should always perform the following three tasks when using attributes:

• Zero the structure
• Set the version field
• Set the size field

Zeroing the structure sets all the event attributes types and values to the default value.

The version and size field are used by the Tools Extension implementation to handle multiple versions of the attributes structure.

It is recommended that the caller use one of the following to methods to initialize the event attributes structure:

Method 1: Initializing nvtxEventAttributes for future compatibility

nvtxSyncUserAttributes_t attribs = {0};
attribs.version = NVTX_VERSION;
attribs.size = NVTX_SYNCUSER_ATTRIB_STRUCT_SIZE;

Method 2: Initializing nvtxSyncUserAttributes_t for a specific version

nvtxSyncUserAttributes_t attribs = {0};
attribs.version = 1;
attribs.size = (uint16_t)(sizeof(nvtxSyncUserAttributes_t));

If the caller uses Method 1 it is critical that the entire binary layout of the structure be configured to 0 so that all fields are initialized to the default value.

The caller should either use both NVTX_VERSION and NVTX_SYNCUSER_ATTRIB_STRUCT_SIZE (Method 1) or use explicit values and a versioned type (Method 2). Using a mix of the two methods will likely cause either source level incompatibility or binary incompatibility in the future.

Settings Attribute Types and Values

Example:

// Initialize
nvtxSyncUserAttributes_t attribs = {0};
attribs.version = NVTX_VERSION;
attribs.size = NVTX_SYNCUSER_ATTRIB_STRUCT_SIZE;
 
// Configure the Attributes
attribs.messageType = NVTX_MESSAGE_TYPE_ASCII;
attribs.message.ascii = "Example";

See also

nvtxDomainSyncUserCreate

Definition at line 235 of file nvToolsExtSync.h.

Field Documentation

message

nvtxMessageValue_t nvtxSyncUserAttributes_t::message

Message assigned to this attribute structure.

The text message that is attached to an event.

Definition at line 267 of file nvToolsExtSync.h.

messageType

int32_t nvtxSyncUserAttributes_t::messageType

Message type specified in this attribute structure.

Defines the message format of the attribute structure's message field.

Default Value is NVTX_MESSAGE_UNKNOWN

Definition at line 261 of file nvToolsExtSync.h.

size

uint16_t nvtxSyncUserAttributes_t::size

Size of the structure.

Needs to be set to the size in bytes of the event attribute structure used to specify the event.

Definition at line 252 of file nvToolsExtSync.h.

version

uint16_t nvtxSyncUserAttributes_t::version

Version flag of the structure.

Needs to be set to NVTX_VERSION to indicate the version of NVTX APIs supported in this header file. This can optionally be overridden to another version of the tools extension library.

Definition at line 244 of file nvToolsExtSync.h.

---

The documentation for this struct was generated from the following file:

• nvToolsExtSync.h