nvtx3/nvtxDetail/nvtxExtTypes.h

0001 /*
0002  * SPDX-FileCopyrightText: Copyright (c) 2021-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 #ifndef NVTX_EXT_TYPES_GUARD
0022 #error Never include this file directly -- it is automatically included by nvToolsExt[EXTENSION].h.
0023 #endif
0024
0025 #if defined(NVTX_AS_SYSTEM_HEADER)
0026 #if defined(__clang__)
0027 #pragma clang system_header
0028 #elif defined(__GNUC__) || defined(__NVCOMPILER)
0029 #pragma GCC system_header
0030 #elif defined(_MSC_VER)
0031 #pragma system_header
0032 #endif
0033 #endif
0034
0035 /* This header defines types which are used by the internal implementation
0036 *  of NVTX and callback subscribers.  API clients do not use these types,
0037 *  so they are defined here instead of in nvToolsExt.h to clarify they are
0038 *  not part of the NVTX client API. */
0039
0040 #ifndef NVTXEXTTYPES_H
0041 #define NVTXEXTTYPES_H
0042
0043 typedef intptr_t (NVTX_API * NvtxExtGetExportFunction_t)(uint32_t exportFunctionId);
0044
0045 typedef struct nvtxExtModuleSegment_t
0046 {
0047     size_t segmentId;
0048     size_t slotCount;
0049     intptr_t* functionSlots;
0050 } nvtxExtModuleSegment_t;
0051
0052 typedef struct nvtxExtModuleInfo_t
0053 {
0054     uint16_t nvtxVer;
0055     uint16_t structSize;
0056     uint16_t moduleId;
0057     uint16_t compatId;
0058     size_t segmentsCount;
0059     nvtxExtModuleSegment_t* segments;
0060     NvtxExtGetExportFunction_t getExportFunction;
0061     const void* extInfo;
0062 } nvtxExtModuleInfo_t;
0063
0064 typedef int (NVTX_API * NvtxExtInitializeInjectionFunc_t)(nvtxExtModuleInfo_t* moduleInfo);
0065
0066 #endif /* NVTXEXTTYPES_H */