nvToolsExtPayload.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Licensed under the Apache License v2.0 with LLVM Exceptions.
 * See https://nvidia.github.io/NVTX/LICENSE.txt for license information.
 */
 
#if defined(NVTX_AS_SYSTEM_HEADER)
#if defined(__clang__)
#pragma clang system_header
#elif defined(__GNUC__) || defined(__NVCOMPILER)
#pragma GCC system_header
#elif defined(_MSC_VER)
#pragma system_header
#endif
#endif
 
#include "nvToolsExt.h"
 
/* Optionally include helper macros. */
/* #include "nvToolsExtPayloadHelper.h" */
 
#ifndef NVTX_EXT_PAYLOAD_COMPATID
#define NVTX_EXT_PAYLOAD_COMPATID 0x0104
#endif
 
#ifndef NVTX_EXT_PAYLOAD_MODULEID
#define NVTX_EXT_PAYLOAD_MODULEID 2
#endif
 
#ifndef NVTX_PAYLOAD_TYPE_EXT
#define NVTX_PAYLOAD_TYPE_EXT (NVTX_STATIC_CAST(int32_t, 0xDFBD0009))
#endif
 
#ifndef NVTX_PAYLOAD_ENTRY_FLAGS_V1
#define NVTX_PAYLOAD_ENTRY_FLAGS_V1
 
#define NVTX_PAYLOAD_ENTRY_FLAG_UNUSED 0
 
#define NVTX_PAYLOAD_ENTRY_FLAG_POINTER (1 << 1)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_OFFSET_FROM_BASE (1 << 2)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_OFFSET_FROM_HERE (1 << 3)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_ARRAY_FIXED_SIZE (1 << 4)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_ARRAY_ZERO_TERMINATED (2 << 4)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_ARRAY_LENGTH_INDEX (3 << 4)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_ARRAY_LENGTH_PAYLOAD_INDEX (4 << 4)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_DEEP_COPY (1 << 8)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_HIDE (1 << 9)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_EVENT_MESSAGE (1 << 10)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_TIMESTAMP (2 << 10)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_RANGE_BEGIN (1 << 12)
#define NVTX_PAYLOAD_ENTRY_FLAG_RANGE_END (2 << 12)
#define NVTX_PAYLOAD_ENTRY_FLAG_MARK (3 << 12)
#define NVTX_PAYLOAD_ENTRY_FLAG_COUNTER (4 << 12)
 
/* Helper macro to check if an entry represents an array. */
#define NVTX_PAYLOAD_ENTRY_FLAG_IS_ARRAY                                                           \
    (NVTX_PAYLOAD_ENTRY_FLAG_ARRAY_FIXED_SIZE | NVTX_PAYLOAD_ENTRY_FLAG_ARRAY_ZERO_TERMINATED |    \
     NVTX_PAYLOAD_ENTRY_FLAG_ARRAY_LENGTH_INDEX |                                                  \
     NVTX_PAYLOAD_ENTRY_FLAG_ARRAY_LENGTH_PAYLOAD_INDEX)
 
#define NVTX_PAYLOAD_ENTRY_FLAG_ARRAY_TYPE(F) ((F) & NVTX_PAYLOAD_ENTRY_FLAG_IS_ARRAY)
 
#endif /* NVTX_PAYLOAD_ENTRY_FLAGS_V1 */
#ifndef NVTX_PAYLOAD_ENTRY_TYPES_V1
#define NVTX_PAYLOAD_ENTRY_TYPES_V1
 
#define NVTX_PAYLOAD_ENTRY_TYPE_INVALID 0
 
#define NVTX_PAYLOAD_ENTRY_TYPE_CHAR 1
#define NVTX_PAYLOAD_ENTRY_TYPE_UCHAR 2
#define NVTX_PAYLOAD_ENTRY_TYPE_SHORT 3
#define NVTX_PAYLOAD_ENTRY_TYPE_USHORT 4
#define NVTX_PAYLOAD_ENTRY_TYPE_INT 5
#define NVTX_PAYLOAD_ENTRY_TYPE_UINT 6
#define NVTX_PAYLOAD_ENTRY_TYPE_LONG 7
#define NVTX_PAYLOAD_ENTRY_TYPE_ULONG 8
#define NVTX_PAYLOAD_ENTRY_TYPE_LONGLONG 9
#define NVTX_PAYLOAD_ENTRY_TYPE_ULONGLONG 10
 
#define NVTX_PAYLOAD_ENTRY_TYPE_INT8 11
#define NVTX_PAYLOAD_ENTRY_TYPE_UINT8 12
#define NVTX_PAYLOAD_ENTRY_TYPE_INT16 13
#define NVTX_PAYLOAD_ENTRY_TYPE_UINT16 14
#define NVTX_PAYLOAD_ENTRY_TYPE_INT32 15
#define NVTX_PAYLOAD_ENTRY_TYPE_UINT32 16
#define NVTX_PAYLOAD_ENTRY_TYPE_INT64 17
#define NVTX_PAYLOAD_ENTRY_TYPE_UINT64 18
 
#define NVTX_PAYLOAD_ENTRY_TYPE_FLOAT 19
#define NVTX_PAYLOAD_ENTRY_TYPE_DOUBLE 20
#define NVTX_PAYLOAD_ENTRY_TYPE_LONGDOUBLE 21
 
#define NVTX_PAYLOAD_ENTRY_TYPE_SIZE 22
 
#define NVTX_PAYLOAD_ENTRY_TYPE_ADDRESS 23
 
#define NVTX_PAYLOAD_ENTRY_TYPE_WCHAR 24 /* wide character (since C90) */
#define NVTX_PAYLOAD_ENTRY_TYPE_CHAR8 25 /* since C2x and C++20 */
#define NVTX_PAYLOAD_ENTRY_TYPE_CHAR16 26
#define NVTX_PAYLOAD_ENTRY_TYPE_CHAR32 27
 
#define NVTX_PAYLOAD_ENTRY_TYPE_INFO_ARRAY_SIZE (NVTX_PAYLOAD_ENTRY_TYPE_CHAR32 + 1)
 
#define NVTX_PAYLOAD_ENTRY_TYPE_BYTE 32
 
#define NVTX_PAYLOAD_ENTRY_TYPE_INT128 33
#define NVTX_PAYLOAD_ENTRY_TYPE_UINT128 34
 
#define NVTX_PAYLOAD_ENTRY_TYPE_FLOAT16 42
#define NVTX_PAYLOAD_ENTRY_TYPE_FLOAT32 43
#define NVTX_PAYLOAD_ENTRY_TYPE_FLOAT64 44
#define NVTX_PAYLOAD_ENTRY_TYPE_FLOAT128 45
 
#define NVTX_PAYLOAD_ENTRY_TYPE_BF16 50 /* bfloat16 (16-bit) */
#define NVTX_PAYLOAD_ENTRY_TYPE_TF32 52 /* TensorFloat-32 (stored in 32 bits) */
 
#define NVTX_PAYLOAD_ENTRY_TYPE_RANGE_ID 67 /* nvtxRangeId_t / uint64_t */
#define NVTX_PAYLOAD_ENTRY_TYPE_CATEGORY 68 /* uint32_t */
#define NVTX_PAYLOAD_ENTRY_TYPE_COLOR_ARGB 69 /* uint32_t */
 
#define NVTX_PAYLOAD_ENTRY_TYPE_SCOPE_ID 70 /* uint64_t */
 
#define NVTX_PAYLOAD_ENTRY_TYPE_PID_UINT32 71
#define NVTX_PAYLOAD_ENTRY_TYPE_PID_UINT64 72
 
#define NVTX_PAYLOAD_ENTRY_TYPE_TID_UINT32 73
#define NVTX_PAYLOAD_ENTRY_TYPE_TID_UINT64 74
 
#define NVTX_PAYLOAD_ENTRY_TYPE_CSTRING 75 /* `char*`, system LOCALE */
#define NVTX_PAYLOAD_ENTRY_TYPE_CSTRING_UTF8 76
#define NVTX_PAYLOAD_ENTRY_TYPE_CSTRING_UTF16 77
#define NVTX_PAYLOAD_ENTRY_TYPE_CSTRING_UTF32 78
 
#define NVTX_PAYLOAD_ENTRY_TYPE_NVTX_REGISTERED_STRING_HANDLE 80
 
#define NVTX_PAYLOAD_ENTRY_TYPE_UNION_SELECTOR 100
 
#define NVTX_TYPE_PAYLOAD_SCHEMA_REFERENCED 1022
 
#define NVTX_TYPE_PAYLOAD_SCHEMA_RAW 1023
 
/* Custom (static) schema IDs. */
#define NVTX_PAYLOAD_SCHEMA_ID_STATIC_START (1 << 24)
 
/* Dynamic schema IDs (generated by the tool) start here. */
#define NVTX_PAYLOAD_SCHEMA_ID_DYNAMIC_START (NVTX_STATIC_CAST(uint64_t, 1) << 32)
 
#endif /* NVTX_PAYLOAD_ENTRY_TYPES_V1 */
#ifndef NVTX_PAYLOAD_SCHEMA_TYPES_V1
#define NVTX_PAYLOAD_SCHEMA_TYPES_V1
 
#define NVTX_PAYLOAD_SCHEMA_TYPE_INVALID 0
#define NVTX_PAYLOAD_SCHEMA_TYPE_STATIC 1
#define NVTX_PAYLOAD_SCHEMA_TYPE_DYNAMIC 2
#define NVTX_PAYLOAD_SCHEMA_TYPE_UNION 3
#define NVTX_PAYLOAD_SCHEMA_TYPE_UNION_WITH_INTERNAL_SELECTOR 4
 
#endif /* NVTX_PAYLOAD_SCHEMA_TYPES_V1 */
 
#ifndef NVTX_PAYLOAD_SCHEMA_FLAGS_V1
#define NVTX_PAYLOAD_SCHEMA_FLAGS_V1
 
#define NVTX_PAYLOAD_SCHEMA_FLAG_NONE 0
 
#define NVTX_PAYLOAD_SCHEMA_FLAG_DEEP_COPY (1 << 1)
 
#define NVTX_PAYLOAD_SCHEMA_FLAG_REFERENCED (1 << 2)
 
#define NVTX_PAYLOAD_SCHEMA_FLAG_COUNTER_GROUP (1 << 3)
 
#define NVTX_PAYLOAD_SCHEMA_FLAG_RANGE_PUSHPOP (2 << 3)
#define NVTX_PAYLOAD_SCHEMA_FLAG_RANGE_STARTEND (3 << 3)
#define NVTX_PAYLOAD_SCHEMA_FLAG_MARK (4 << 3)
#define NVTX_PAYLOAD_SCHEMA_FLAG_RANGE_PUSH (5 << 3)
#define NVTX_PAYLOAD_SCHEMA_FLAG_RANGE_POP (6 << 3)
#define NVTX_PAYLOAD_SCHEMA_FLAG_RANGE_START (7 << 3)
#define NVTX_PAYLOAD_SCHEMA_FLAG_RANGE_END (8 << 3)
 
#endif /* NVTX_PAYLOAD_SCHEMA_FLAGS_V1 */
 
#ifndef NVTX_PAYLOAD_SCHEMA_ATTR_FIELDS_V1
#define NVTX_PAYLOAD_SCHEMA_ATTR_FIELDS_V1
 
#define NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_NAME (1 << 1)
#define NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_TYPE (1 << 2)
#define NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_FLAGS (1 << 3)
#define NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_ENTRIES (1 << 4)
#define NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_NUM_ENTRIES (1 << 5)
#define NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_STATIC_SIZE (1 << 6)
#define NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_ALIGNMENT (1 << 7)
#define NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_SCHEMA_ID (1 << 8)
#define NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_EXTENSION (1 << 9)
 
#endif /* NVTX_PAYLOAD_SCHEMA_ATTR_FIELDS_V1 */
 
#ifndef NVTX_PAYLOAD_ENUM_ATTR_FIELDS_V1
#define NVTX_PAYLOAD_ENUM_ATTR_FIELDS_V1
 
#define NVTX_PAYLOAD_ENUM_ATTR_FIELD_NAME (1 << 1)
#define NVTX_PAYLOAD_ENUM_ATTR_FIELD_ENTRIES (1 << 2)
#define NVTX_PAYLOAD_ENUM_ATTR_FIELD_NUM_ENTRIES (1 << 3)
#define NVTX_PAYLOAD_ENUM_ATTR_FIELD_SIZE (1 << 4)
#define NVTX_PAYLOAD_ENUM_ATTR_FIELD_SCHEMA_ID (1 << 5)
#define NVTX_PAYLOAD_ENUM_ATTR_FIELD_EXTENSION (1 << 6)
 
#endif /* NVTX_PAYLOAD_ENUM_ATTR_FIELDS_V1 */
 
#ifndef NVTX_SCOPES_V1
#define NVTX_SCOPES_V1
 
#define NVTX_SCOPE_NONE 0 /* No scope specified. */
#define NVTX_SCOPE_ROOT 1 /* The root in a hierarchy. */
 
/* Hardware events */
#define NVTX_SCOPE_CURRENT_HW_MACHINE 2 /* Node/machine name */
#define NVTX_SCOPE_CURRENT_HW_SOCKET 3
#define NVTX_SCOPE_CURRENT_HW_CPU_PHYSICAL 4 /* Physical CPU core */
#define NVTX_SCOPE_CURRENT_HW_CPU_LOGICAL 5  /* Logical CPU core */
/* Innermost HW execution context */
#define NVTX_SCOPE_CURRENT_HW_INNERMOST 15
 
/* Virtualized hardware, virtual machines */
#define NVTX_SCOPE_CURRENT_HYPERVISOR 16
#define NVTX_SCOPE_CURRENT_VM 17
#define NVTX_SCOPE_CURRENT_KERNEL 18
#define NVTX_SCOPE_CURRENT_CONTAINER 19
#define NVTX_SCOPE_CURRENT_OS 20
 
/* Software scopes */
#define NVTX_SCOPE_CURRENT_SW_PROCESS 21 /* Process scope */
#define NVTX_SCOPE_CURRENT_SW_THREAD 22  /* Thread scope */
/* Innermost SW execution context */
#define NVTX_SCOPE_CURRENT_SW_INNERMOST 31
 
#define NVTX_SCOPE_ID_STATIC_START (1 << 24)
 
/* Dynamically (tool) generated scope IDs */
#define NVTX_SCOPE_ID_DYNAMIC_START (NVTX_STATIC_CAST(uint64_t, 1) << 32)
 
#endif /* NVTX_SCOPES_V1 */
 
#ifndef NVTX_TIME_V1
#define NVTX_TIME_V1
 
#define NVTX_TIMESTAMP_TYPE_NONE 0
 
#define NVTX_TIMESTAMP_TYPE_TOOL_PROVIDED 1
 
/* RDTSC on x86, CNTVCT on ARM */
#define NVTX_TIMESTAMP_TYPE_CPU_TSC 10
/* CNTPCT on ARM */
#define NVTX_TIMESTAMP_TYPE_CPU_TSC_NONVIRTUALIZED 11
/* Nanoseconds since epoch (relative to UTC), clock_gettime(CLOCK_REALTIME) */
#define NVTX_TIMESTAMP_TYPE_CPU_CLOCK_GETTIME_REALTIME 12
/* Same as above but less overhead and precision (1-10 ms) */
#define NVTX_TIMESTAMP_TYPE_CPU_CLOCK_GETTIME_REALTIME_COARSE 13
/* POSIX, Time since system boot, adjusted by NTP */
#define NVTX_TIMESTAMP_TYPE_CPU_CLOCK_GETTIME_MONOTONIC 14
/* Linux only, Time since system boot, no NTP or frequency corrections  */
#define NVTX_TIMESTAMP_TYPE_CPU_CLOCK_GETTIME_MONOTONIC_RAW 15
/* Same as `CLOCK_MONOTONIC`, but less overhead and precision (1-10ms) */
#define NVTX_TIMESTAMP_TYPE_CPU_CLOCK_GETTIME_MONOTONIC_COARSE 16
/* Same as `CLOCK_MONOTONIC`, but including suspended time. */
#define NVTX_TIMESTAMP_TYPE_CPU_CLOCK_GETTIME_BOOTTIME 17
/* The total CPU time consumed by the calling process. */
#define NVTX_TIMESTAMP_TYPE_CPU_CLOCK_GETTIME_PROCESS_CPUTIME_ID 18
/* The total CPU time consumed by the calling thread. */
#define NVTX_TIMESTAMP_TYPE_CPU_CLOCK_GETTIME_THREAD_CPUTIME_ID 19
 
#define NVTX_TIMESTAMP_TYPE_WIN_QPC 30     /* QueryPerformanceCounter */
#define NVTX_TIMESTAMP_TYPE_WIN_GSTAFT 31  /* GetSystemTimeAsFileTime */
#define NVTX_TIMESTAMP_TYPE_WIN_GSTAFTP 32 /* GetSystemTimePreciseAsFileTime */
 
/* Seconds since epoch (represented in C as `time_t`) */
#define NVTX_TIMESTAMP_TYPE_C_TIME 40
/* CPU clock value (represented in C as `clock_t`) as returned by `clock()` */
#define NVTX_TIMESTAMP_TYPE_C_CLOCK 41
/* High-resolution time into struct timespec (C11) */
#define NVTX_TIMESTAMP_TYPE_C_TIMESPEC_GET 42
 
/* std::chrono::steady_clock (monotonic clock), similar to `CLOCK_MONOTONIC` */
#define NVTX_TIMESTAMP_TYPE_CPP_STEADY_CLOCK 50
/* std::chrono::high_resolution_clock, similar to `CLOCK_MONOTONIC` or `CLOCK_MONOTONIC_RAW` */
#define NVTX_TIMESTAMP_TYPE_CPP_HIGH_RESOLUTION_CLOCK 51
/* std::chrono::system_clock, similar to `CLOCK_REALTIME` */
#define NVTX_TIMESTAMP_TYPE_CPP_SYSTEM_CLOCK 52
/* (since C++20) std::chrono::utc_clock, similar to `CPP_SYSTEM_CLOCK` */
#define NVTX_TIMESTAMP_TYPE_CPP_UTC_CLOCK 53
/* (since C++20) std::chrono::tai_clock */
#define NVTX_TIMESTAMP_TYPE_CPP_TAI_CLOCK 54
/* (since C++20) std::chrono::gps_clock */
#define NVTX_TIMESTAMP_TYPE_CPP_GPS_CLOCK 55
/* (since C++20) std::chrono::file_clock */
#define NVTX_TIMESTAMP_TYPE_CPP_FILE_CLOCK 56
 
#define NVTX_TIMESTAMP_TYPE_GPU_GLOBALTIMER 80 /* e.g. PTIMER */
 
#define NVTX_TIME_DOMAIN_ID_NONE 0
 
#define NVTX_TIME_DOMAIN_ID_STATIC_START (1 << 24)
 
/* Dynamically (tool) generated time domain IDs */
#define NVTX_TIME_DOMAIN_ID_DYNAMIC_START (NVTX_STATIC_CAST(uint64_t, 1) << 32)
 
#define NVTX_TIMER_FLAG_NONE 0
#define NVTX_TIMER_FLAG_CLOCK_MONOTONIC (1 << 1)
#define NVTX_TIMER_FLAG_CLOCK_STEADY (1 << 2)
 
#define NVTX_TIMER_START_UNKNOWN 0
#define NVTX_TIMER_START_SYSTEM_BOOT 1
#define NVTX_TIMER_START_VM_BOOT 2
#define NVTX_TIMER_START_UNIX_EPOCH 3   /* 1 January 1970 */
#define NVTX_TIMER_START_WIN_FILETIME 4 /* 1 January 1601 */
 
#define NVTX_TIMER_SOURCE_SAFE_CALL_AFTER_PROCESS_TEARDOWN 0
#define NVTX_TIMER_SOURCE_UNSAFE_CALL_AFTER_PROCESS_TEARDOWN 1
 
#endif /* NVTX_TIME_V1 */
 
#ifndef NVTX_BATCH_FLAGS_V1
#define NVTX_BATCH_FLAGS_V1
 
#define NVTX_BATCH_FLAG_TIME_SORTED 0
#define NVTX_BATCH_FLAG_TIME_SORTED_PARTIALLY (1 << 1)
#define NVTX_BATCH_FLAG_TIME_SORTED_PER_SCOPE (2 << 1)
#define NVTX_BATCH_FLAG_UNSORTED (3 << 1)
 
#endif /* NVTX_BATCH_FLAGS_V1 */
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#ifndef NVTX_PAYLOAD_TYPEDEFS_V1
#define NVTX_PAYLOAD_TYPEDEFS_V1
 
typedef struct nvtxPayloadEntryTypeInfo_v1
{
    uint16_t size;
    uint16_t align;
} nvtxPayloadEntryTypeInfo_t;
 
typedef struct nvtxPayloadData_v1
{
    uint64_t schemaId;
 
    size_t size;
 
    const void* payload;
} nvtxPayloadData_t;
 
typedef struct nvtxSemanticsHeader_v1
{
    uint32_t structSize;                       
    uint16_t semanticId;                       
    uint16_t version;                          
    const struct nvtxSemanticsHeader_v1* next; 
    /* Additional fields are defined by the specific semantic extension. */
} nvtxSemanticsHeader_t;
 
typedef struct nvtxPayloadSchemaEntry_v1
{
    uint64_t flags;
 
    uint64_t type;
 
    const char* name;
 
    const char* description;
 
    uint64_t arrayOrUnionDetail;
 
    uint64_t offset;
 
    const nvtxSemanticsHeader_t* semantics;
 
    const void* reserved;
} nvtxPayloadSchemaEntry_t;
 
typedef struct nvtxPayloadSchemaAttr_v1
{
    uint64_t fieldMask;
 
    const char* name;
 
    uint64_t type;
 
    uint64_t flags;
 
    const nvtxPayloadSchemaEntry_t* entries;
 
    size_t numEntries;
 
    size_t payloadStaticSize;
 
    size_t packAlign;
 
    uint64_t schemaId;
 
    void* extension;
} nvtxPayloadSchemaAttr_t;
 
typedef struct nvtxPayloadEnum_v1
{
    const char* name;
 
    uint64_t value;
 
    int8_t isFlag;
} nvtxPayloadEnum_t;
 
typedef struct nvtxPayloadEnumAttr_v1
{
    uint64_t fieldMask;
 
    const char* name;
 
    const nvtxPayloadEnum_t* entries;
 
    size_t numEntries;
 
    size_t sizeOfEnum;
 
    uint64_t schemaId;
 
    void* extension;
} nvtxPayloadEnumAttr_t;
 
typedef struct nvtxScopeAttr_v1
{
    size_t structSize;
 
    const char* path;
 
    uint64_t parentScope;
 
    uint64_t scopeId;
} nvtxScopeAttr_t;
 
#endif /* NVTX_PAYLOAD_TYPEDEFS_V1 */
 
#ifndef NVTX_PAYLOAD_TYPEDEFS_DEFERRED_V1
#define NVTX_PAYLOAD_TYPEDEFS_DEFERRED_V1
 
typedef struct nvtxTimeDomainAttr_v1
{
    uint64_t scopeId;
 
    uint64_t timestampTypeId;
 
    uint64_t timeDomainId;
 
    uint64_t timerFlags;
 
    int64_t timerResolution;
 
    uint64_t timerStart;
} nvtxTimeDomainAttr_t;
 
typedef struct nvtxSyncPoint_v1
{
    int64_t src;
    int64_t dst;
} nvtxSyncPoint_t;
 
typedef struct nvtxEventBatch_v1
{
    uint64_t eventSchemaId;
 
    size_t size;
 
    const void* events;
 
    uint64_t scope;
 
    uint64_t flags;
 
    const void* flexData;
 
    size_t flexDataSize;
 
    size_t flexDataOffset;
} nvtxEventBatch_t;
 
#endif /* NVTX_PAYLOAD_TYPEDEFS_DEFERRED_V1 */
 
#ifndef NVTX_PAYLOAD_API_FUNCTIONS_V1
#define NVTX_PAYLOAD_API_FUNCTIONS_V1
 
NVTX_DECLSPEC uint64_t NVTX_API
nvtxPayloadSchemaRegister(nvtxDomainHandle_t domain, const nvtxPayloadSchemaAttr_t* attr);
 
NVTX_DECLSPEC uint64_t NVTX_API
nvtxPayloadEnumRegister(nvtxDomainHandle_t domain, const nvtxPayloadEnumAttr_t* attr);
 
NVTX_DECLSPEC uint64_t NVTX_API
nvtxScopeRegister(nvtxDomainHandle_t domain, const nvtxScopeAttr_t* attr);
 
NVTX_DECLSPEC void NVTX_API
nvtxMarkPayload(nvtxDomainHandle_t domain, const nvtxPayloadData_t* payloadData, size_t count);
 
NVTX_DECLSPEC int NVTX_API
nvtxRangePushPayload(nvtxDomainHandle_t domain, const nvtxPayloadData_t* payloadData, size_t count);
 
NVTX_DECLSPEC int NVTX_API
nvtxRangePopPayload(nvtxDomainHandle_t domain, const nvtxPayloadData_t* payloadData, size_t count);
 
NVTX_DECLSPEC nvtxRangeId_t NVTX_API nvtxRangeStartPayload(
    nvtxDomainHandle_t domain, const nvtxPayloadData_t* payloadData, size_t count);
 
NVTX_DECLSPEC void NVTX_API nvtxRangeEndPayload(
    nvtxDomainHandle_t domain,
    nvtxRangeId_t id,
    const nvtxPayloadData_t* payloadData,
    size_t count);
 
NVTX_DECLSPEC uint8_t NVTX_API nvtxDomainIsEnabled(nvtxDomainHandle_t domain);
 
#endif /* NVTX_PAYLOAD_API_FUNCTIONS_V1 */
 
#ifndef NVTX_PAYLOAD_API_FUNCTIONS_DEFERRED_V1
#define NVTX_PAYLOAD_API_FUNCTIONS_DEFERRED_V1
 
NVTX_DECLSPEC int64_t NVTX_API nvtxTimestampGet(void);
 
NVTX_DECLSPEC uint64_t NVTX_API
nvtxTimeDomainRegister(nvtxDomainHandle_t domain, const nvtxTimeDomainAttr_t* timeAttr);
 
NVTX_DECLSPEC void NVTX_API nvtxTimerSource(
    nvtxDomainHandle_t domain,
    uint64_t timeDomainId,
    uint64_t flags,
    int64_t (*timestampProviderFn)(void));
 
NVTX_DECLSPEC void NVTX_API nvtxTimerSourceWithData(
    nvtxDomainHandle_t domain,
    uint64_t timeDomainId,
    uint64_t flags,
    int64_t (*timestampProviderFn)(void* data),
    void* data);
 
NVTX_DECLSPEC void NVTX_API nvtxTimeSyncPoint(
    nvtxDomainHandle_t domain,
    uint64_t timeDomainId1,
    uint64_t timeDomainId2,
    int64_t timestamp1,
    int64_t timestamp2);
 
NVTX_DECLSPEC void NVTX_API nvtxTimeSyncPointTable(
    nvtxDomainHandle_t domain,
    uint64_t timeDomainIdSrc,
    uint64_t timeDomainIdDst,
    const nvtxSyncPoint_t* syncPoints,
    size_t count);
 
NVTX_DECLSPEC void NVTX_API nvtxTimestampConversionFactor(
    nvtxDomainHandle_t domain,
    uint64_t timeDomainIdSrc,
    uint64_t timeDomainIdDst,
    double slope,
    int64_t timestampSrc,
    int64_t timestampDst);
 
NVTX_DECLSPEC void NVTX_API nvtxEventSubmit(
    nvtxDomainHandle_t domain, const nvtxPayloadData_t* payloadData, size_t numPayloads);
 
NVTX_DECLSPEC void NVTX_API
nvtxEventBatchSubmit(nvtxDomainHandle_t domain, const nvtxEventBatch_t* eventBatch);
 
#endif /* NVTX_PAYLOAD_API_FUNCTIONS_DEFERRED_V1 */
 
#ifndef NVTX_PAYLOAD_CALLBACK_ID_V1
#define NVTX_PAYLOAD_CALLBACK_ID_V1
 
#define NVTX3EXT_CBID_nvtxPayloadSchemaRegister 0
#define NVTX3EXT_CBID_nvtxPayloadEnumRegister 1
#define NVTX3EXT_CBID_nvtxMarkPayload 2
#define NVTX3EXT_CBID_nvtxRangePushPayload 3
#define NVTX3EXT_CBID_nvtxRangePopPayload 4
#define NVTX3EXT_CBID_nvtxRangeStartPayload 5
#define NVTX3EXT_CBID_nvtxRangeEndPayload 6
#define NVTX3EXT_CBID_nvtxDomainIsEnabled 7
#define NVTX3EXT_CBID_nvtxScopeRegister 12
 
#endif /* NVTX_PAYLOAD_CALLBACK_ID_V1 */
 
#ifndef NVTX_PAYLOAD_CALLBACK_ID_DEFERRED_V1
#define NVTX_PAYLOAD_CALLBACK_ID_DEFERRED_V1
 
#define NVTX3EXT_CBID_nvtxTimestampGet 8
#define NVTX3EXT_CBID_nvtxTimeDomainRegister 9
#define NVTX3EXT_CBID_nvtxTimerSource 10
#define NVTX3EXT_CBID_nvtxTimerSourceWithData 11
#define NVTX3EXT_CBID_nvtxTimeSyncPoint 13
#define NVTX3EXT_CBID_nvtxTimeSyncPointTable 14
#define NVTX3EXT_CBID_nvtxTimestampConversionFactor 15
#define NVTX3EXT_CBID_nvtxEventSubmit 16
#define NVTX3EXT_CBID_nvtxEventBatchSubmit 17
 
#endif /* NVTX_PAYLOAD_CALLBACK_ID_DEFERRED_V1 */
 
/*** Helper utilities ***/
 
#ifndef NVTX_POINTER_AS_PAYLOAD_ULLVALUE
#ifdef __cplusplus
#define NVTX_POINTER_AS_PAYLOAD_ULLVALUE(p) static_cast<uint64_t>(reinterpret_cast<uintptr_t>(p))
#else
#define NVTX_POINTER_AS_PAYLOAD_ULLVALUE(p)                                                        \
    (NVTX_STATIC_CAST(uint64_t, NVTX_STATIC_CAST(uintptr_t, p)))
#endif
#endif
 
#ifndef NVTX_PAYLOAD_EVTATTR_SET_DATA
#define NVTX_PAYLOAD_EVTATTR_SET_DATA(evtAttr, pldata_addr, schema_id, pl_addr, sz)                \
    (pldata_addr)->schemaId = schema_id;                                                           \
    (pldata_addr)->size = sz;                                                                      \
    (pldata_addr)->payload = pl_addr;                                                              \
    (evtAttr).payload.ullValue = NVTX_POINTER_AS_PAYLOAD_ULLVALUE(pldata_addr);                    \
    (evtAttr).payloadType = NVTX_PAYLOAD_TYPE_EXT;                                                 \
    (evtAttr).reserved0 = 1;
#endif /* NVTX_PAYLOAD_EVTATTR_SET_DATA */
 
#ifndef NVTX_PAYLOAD_EVTATTR_SET_MULTIPLE
#define NVTX_PAYLOAD_EVTATTR_SET_MULTIPLE(evtAttr, pldata)                                         \
    (evtAttr).payloadType = NVTX_PAYLOAD_TYPE_EXT;                                                 \
    (evtAttr).reserved0 = sizeof(pldata) / sizeof(nvtxPayloadData_t);                              \
    (evtAttr).payload.ullValue = NVTX_POINTER_AS_PAYLOAD_ULLVALUE(pldata);
#endif /* NVTX_PAYLOAD_EVTATTR_SET_MULTIPLE */
 
#ifndef NVTX_PAYLOAD_EVTATTR_SET_MULTIPLE_N
#define NVTX_PAYLOAD_EVTATTR_SET_MULTIPLE_N(evtAttr, pldata, count) \
    (evtAttr).payloadType = NVTX_PAYLOAD_TYPE_EXT; \
    (evtAttr).reserved0 = NVTX_STATIC_CAST(int32_t, count); \
    (evtAttr).payload.ullValue = NVTX_POINTER_AS_PAYLOAD_ULLVALUE(pldata);
#endif /* NVTX_PAYLOAD_EVTATTR_SET_MULTIPLE_N */
 
#ifndef NVTX_PAYLOAD_EVTATTR_SET
/*
 * Do not use this macro directly! It is a helper to attach a single payload to
 * an NVTX event attribute.
 * @warning The NVTX push, start, or mark call must be in the same scope.
 */
#define NVTX_PAYLOAD_EVTATTR_SET(evtAttr, schema_id, pl_addr, sz)                                  \
    nvtxPayloadData_t _NVTX_PAYLOAD_DATA_VAR[] = {{schema_id, sz, pl_addr}};                       \
    (evtAttr)->payload.ullValue = NVTX_POINTER_AS_PAYLOAD_ULLVALUE(_NVTX_PAYLOAD_DATA_VAR);        \
    (evtAttr)->payloadType = NVTX_PAYLOAD_TYPE_EXT;                                                \
    (evtAttr)->reserved0 = 1;
#endif /* NVTX_PAYLOAD_EVTATTR_SET */
 
#ifndef nvtxPayloadRangePush
#define nvtxPayloadRangePush(domain, evtAttr, schemaId, plAddr, size)                              \
    do                                                                                             \
    {                                                                                              \
        NVTX_PAYLOAD_EVTATTR_SET(evtAttr, schemaId, plAddr, size)                                  \
        nvtxDomainRangePushEx(domain, evtAttr);                                                    \
    } while (0)
#endif /* nvtxPayloadRangePush */
 
#ifndef nvtxPayloadMark
#define nvtxPayloadMark(domain, evtAttr, schemaId, plAddr, size)                                   \
    do                                                                                             \
    {                                                                                              \
        NVTX_PAYLOAD_EVTATTR_SET(evtAttr, schemaId, plAddr, size)                                  \
        nvtxDomainMarkEx(domain, evtAttr);                                                         \
    } while (0)
#endif /* nvtxPayloadMark */
 
/* Macros to create versioned symbols. */
#ifndef NVTX_EXT_PAYLOAD_VERSIONED_IDENTIFIERS_V1
#define NVTX_EXT_PAYLOAD_VERSIONED_IDENTIFIERS_V1
#define NVTX_EXT_PAYLOAD_VERSIONED_IDENTIFIER_L3(NAME, VERSION, COMPATID)                          \
    NAME##_v##VERSION##_bpl##COMPATID
#define NVTX_EXT_PAYLOAD_VERSIONED_IDENTIFIER_L2(NAME, VERSION, COMPATID)                          \
    NVTX_EXT_PAYLOAD_VERSIONED_IDENTIFIER_L3(NAME, VERSION, COMPATID)
#define NVTX_EXT_PAYLOAD_VERSIONED_ID(NAME)                                                        \
    NVTX_EXT_PAYLOAD_VERSIONED_IDENTIFIER_L2(NAME, NVTX_VERSION, NVTX_EXT_PAYLOAD_COMPATID)
#endif /* NVTX_EXT_PAYLOAD_VERSIONED_IDENTIFIERS_V1 */
 
#ifdef __GNUC__
#pragma GCC visibility push(internal)
#endif
 
/* Extension types are required for the implementation and the NVTX handler. */
#define NVTX_EXT_TYPES_GUARD
#include "nvtxDetail/nvtxExtTypes.h"
#undef NVTX_EXT_TYPES_GUARD
 
#ifndef NVTX_NO_IMPL
#define NVTX_EXT_IMPL_PAYLOAD_GUARD
#include "nvtxDetail/nvtxExtImplPayload_v1.h"
#undef NVTX_EXT_IMPL_PAYLOAD_GUARD
#endif /* NVTX_NO_IMPL */
 
#ifdef __GNUC__
#pragma GCC visibility pop
#endif
 
#ifdef __cplusplus
}
#endif /* __cplusplus */