NVTX C API Reference v3
NVIDIA Tools Extension Library
Loading...
Searching...
No Matches
Data Fields
nvtxScopeAttr_t Struct Reference

Data Fields

size_t structSize
 
const char * path
 
uint64_t parentScope
 
uint64_t scopeId
 

Detailed Description

Definition at line 911 of file nvToolsExtPayload.h.

Field Documentation

◆ parentScope

uint64_t nvtxScopeAttr_t::parentScope

Identifier of the parent scope, to which path is appended.

Definition at line 934 of file nvToolsExtPayload.h.

◆ path

const char* nvtxScopeAttr_t::path

Path delimited by '/' characters, relative to parentScope. Leading slashes are ignored. Nodes in the path may use name[key] syntax to indicate an array of sibling nodes, which may be combined with other non-array nodes or different arrays at the same scope. Node names should be UTF8 printable characters. '\' has to be used to escape '/', '[', and ']' characters in node names. An empty C string "" and NULL are valid inputs and treated equivalently.

A GPU can be specified using its

  • unique identifier (UUID) with "GPU[UUID:#]",
  • CUDA device ID (sensitive to CUDA_VISIBLE_DEVICES) with "GPU[CUDAID:#]",
  • NVML (nvidia-smi) device ID with "GPU[NVSMI:#]" (replace # with the actual device ID). For display purposes, a tool is recommended to show a pretty name.

Definition at line 931 of file nvToolsExtPayload.h.

◆ scopeId

uint64_t nvtxScopeAttr_t::scopeId

Static scope ID. Must be unique within the domain, >= NVTX_SCOPE_ID_STATIC_START, and < NVTX_SCOPE_ID_DYNAMIC_START. Use NVTX_SCOPE_NONE to let the tool create a (dynamic) scope ID.

Definition at line 941 of file nvToolsExtPayload.h.

◆ structSize

size_t nvtxScopeAttr_t::structSize

Definition at line 913 of file nvToolsExtPayload.h.


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