include/nvtx3/nvToolsExtSemanticsScope.h

0001 /*
0002  * SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
0003  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0004  *
0005  * Licensed under the Apache License, Version 2.0 (the "License");
0006  * you may not use this file except in compliance with the License.
0007  * You may obtain a copy of the License at
0008  *
0009  *     http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  *
0017  * Licensed under the Apache License v2.0 with LLVM Exceptions.
0018  * See https://nvidia.github.io/NVTX/LICENSE.txt for license information.
0019  */
0020
0021 #if defined(NVTX_AS_SYSTEM_HEADER)
0022 #if defined(__clang__)
0023 #pragma clang system_header
0024 #elif defined(__GNUC__) || defined(__NVCOMPILER)
0025 #pragma GCC system_header
0026 #elif defined(_MSC_VER)
0027 #pragma system_header
0028 #endif
0029 #endif
0030
0031 #include "nvToolsExtPayload.h"
0032
0033 #ifndef NVTX_SEMANTIC_ID_SCOPE_V1
0034 #define NVTX_SEMANTIC_ID_SCOPE_V1 1
0035
0036 /**
0037  * \brief Specify the NVTX scope for a payload entry.
0038  *
0039  * This allows the scope to be set for a specific value or counter in a payload.
0040  * The scope must be known at schema registration time.
0041  */
0042 typedef struct nvtxSemanticsScope_v1
0043 {
0044     struct nvtxSemanticsHeader_v1 header;
0045
0046     /** Specifies the scope of a payload entry, e.g. a counter or timestamp. */
0047     uint64_t scopeId;
0048 } nvtxSemanticsScope_t;
0049
0050 #endif /* NVTX_SEMANTIC_ID_SCOPE_V1 */