nvtx3/nvtxDetail/nvtxImplCore.h

0001 /*
0002  * SPDX-FileCopyrightText: Copyright (c) 2009-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 NVTX_DECLSPEC void NVTX_API nvtxMarkEx(const nvtxEventAttributes_t* eventAttrib)
0032 {
0033     NVTX_SET_NAME_MANGLING_OPTIONS
0034 #ifdef NVTX_DISABLE
0035     (void)eventAttrib;
0036 #else /* NVTX_DISABLE */
0037     nvtxMarkEx_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxMarkEx_impl_fnptr;
0038     if (local != NVTX_NULLPTR)
0039         (*local)(eventAttrib);
0040 #endif /* NVTX_DISABLE */
0041 }
0042
0043 NVTX_DECLSPEC void NVTX_API nvtxMarkA(const char* message)
0044 {
0045     NVTX_SET_NAME_MANGLING_OPTIONS
0046 #ifdef NVTX_DISABLE
0047     (void)message;
0048 #else /* NVTX_DISABLE */
0049     nvtxMarkA_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxMarkA_impl_fnptr;
0050     if (local != NVTX_NULLPTR)
0051         (*local)(message);
0052 #endif /* NVTX_DISABLE */
0053 }
0054
0055 NVTX_DECLSPEC void NVTX_API nvtxMarkW(const wchar_t* message)
0056 {
0057     NVTX_SET_NAME_MANGLING_OPTIONS
0058 #ifdef NVTX_DISABLE
0059     (void)message;
0060 #else /* NVTX_DISABLE */
0061     nvtxMarkW_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxMarkW_impl_fnptr;
0062     if (local != NVTX_NULLPTR)
0063         (*local)(message);
0064 #endif /* NVTX_DISABLE */
0065 }
0066
0067 NVTX_DECLSPEC nvtxRangeId_t NVTX_API nvtxRangeStartEx(const nvtxEventAttributes_t* eventAttrib)
0068 {
0069     NVTX_SET_NAME_MANGLING_OPTIONS
0070 #ifdef NVTX_DISABLE
0071     (void)eventAttrib;
0072 #else /* NVTX_DISABLE */
0073     nvtxRangeStartEx_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxRangeStartEx_impl_fnptr;
0074     if (local != NVTX_NULLPTR)
0075         return (*local)(eventAttrib);
0076     else
0077 #endif /* NVTX_DISABLE */
0078         return NVTX_STATIC_CAST(nvtxRangeId_t, 0);
0079 }
0080
0081 NVTX_DECLSPEC nvtxRangeId_t NVTX_API nvtxRangeStartA(const char* message)
0082 {
0083     NVTX_SET_NAME_MANGLING_OPTIONS
0084 #ifdef NVTX_DISABLE
0085     (void)message;
0086 #else /* NVTX_DISABLE */
0087     nvtxRangeStartA_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxRangeStartA_impl_fnptr;
0088     if (local != NVTX_NULLPTR)
0089         return (*local)(message);
0090     else
0091 #endif /* NVTX_DISABLE */
0092         return NVTX_STATIC_CAST(nvtxRangeId_t, 0);
0093 }
0094
0095 NVTX_DECLSPEC nvtxRangeId_t NVTX_API nvtxRangeStartW(const wchar_t* message)
0096 {
0097     NVTX_SET_NAME_MANGLING_OPTIONS
0098 #ifdef NVTX_DISABLE
0099     (void)message;
0100 #else /* NVTX_DISABLE */
0101     nvtxRangeStartW_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxRangeStartW_impl_fnptr;
0102     if (local != NVTX_NULLPTR)
0103         return (*local)(message);
0104     else
0105 #endif /* NVTX_DISABLE */
0106         return NVTX_STATIC_CAST(nvtxRangeId_t, 0);
0107 }
0108
0109 NVTX_DECLSPEC void NVTX_API nvtxRangeEnd(nvtxRangeId_t id)
0110 {
0111     NVTX_SET_NAME_MANGLING_OPTIONS
0112 #ifdef NVTX_DISABLE
0113     (void)id;
0114 #else /* NVTX_DISABLE */
0115     nvtxRangeEnd_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxRangeEnd_impl_fnptr;
0116     if (local != NVTX_NULLPTR)
0117         (*local)(id);
0118 #endif /* NVTX_DISABLE */
0119 }
0120
0121 NVTX_DECLSPEC int NVTX_API nvtxRangePushEx(const nvtxEventAttributes_t* eventAttrib)
0122 {
0123     NVTX_SET_NAME_MANGLING_OPTIONS
0124 #ifdef NVTX_DISABLE
0125     (void)eventAttrib;
0126 #else /* NVTX_DISABLE */
0127     nvtxRangePushEx_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxRangePushEx_impl_fnptr;
0128     if (local != NVTX_NULLPTR)
0129         return (*local)(eventAttrib);
0130     else
0131 #endif /* NVTX_DISABLE */
0132         return NVTX_STATIC_CAST(int, NVTX_NO_PUSH_POP_TRACKING);
0133 }
0134
0135 NVTX_DECLSPEC int NVTX_API nvtxRangePushA(const char* message)
0136 {
0137     NVTX_SET_NAME_MANGLING_OPTIONS
0138 #ifdef NVTX_DISABLE
0139     (void)message;
0140 #else /* NVTX_DISABLE */
0141     nvtxRangePushA_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxRangePushA_impl_fnptr;
0142     if (local != NVTX_NULLPTR)
0143         return (*local)(message);
0144     else
0145 #endif /* NVTX_DISABLE */
0146         return NVTX_STATIC_CAST(int, NVTX_NO_PUSH_POP_TRACKING);
0147 }
0148
0149 NVTX_DECLSPEC int NVTX_API nvtxRangePushW(const wchar_t* message)
0150 {
0151     NVTX_SET_NAME_MANGLING_OPTIONS
0152 #ifdef NVTX_DISABLE
0153     (void)message;
0154 #else /* NVTX_DISABLE */
0155     nvtxRangePushW_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxRangePushW_impl_fnptr;
0156     if (local != NVTX_NULLPTR)
0157         return (*local)(message);
0158     else
0159 #endif /* NVTX_DISABLE */
0160         return NVTX_STATIC_CAST(int, NVTX_NO_PUSH_POP_TRACKING);
0161 }
0162
0163 NVTX_DECLSPEC int NVTX_API nvtxRangePop(void)
0164 {
0165     NVTX_SET_NAME_MANGLING_OPTIONS
0166 #ifndef NVTX_DISABLE
0167     nvtxRangePop_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxRangePop_impl_fnptr;
0168     if (local != NVTX_NULLPTR)
0169         return (*local)();
0170     else
0171 #endif /* NVTX_DISABLE */
0172         return NVTX_STATIC_CAST(int, NVTX_NO_PUSH_POP_TRACKING);
0173 }
0174
0175 NVTX_DECLSPEC void NVTX_API nvtxNameCategoryA(uint32_t category, const char* name)
0176 {
0177     NVTX_SET_NAME_MANGLING_OPTIONS
0178 #ifdef NVTX_DISABLE
0179     (void)category;
0180     (void)name;
0181 #else /* NVTX_DISABLE */
0182     nvtxNameCategoryA_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxNameCategoryA_impl_fnptr;
0183     if (local != NVTX_NULLPTR)
0184         (*local)(category, name);
0185 #endif /* NVTX_DISABLE */
0186 }
0187
0188 NVTX_DECLSPEC void NVTX_API nvtxNameCategoryW(uint32_t category, const wchar_t* name)
0189 {
0190     NVTX_SET_NAME_MANGLING_OPTIONS
0191 #ifdef NVTX_DISABLE
0192     (void)category;
0193     (void)name;
0194 #else /* NVTX_DISABLE */
0195     nvtxNameCategoryW_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxNameCategoryW_impl_fnptr;
0196     if (local != NVTX_NULLPTR)
0197         (*local)(category, name);
0198 #endif /* NVTX_DISABLE */
0199 }
0200
0201 NVTX_DECLSPEC void NVTX_API nvtxNameOsThreadA(uint32_t threadId, const char* name)
0202 {
0203     NVTX_SET_NAME_MANGLING_OPTIONS
0204 #ifdef NVTX_DISABLE
0205     (void)threadId;
0206     (void)name;
0207 #else /* NVTX_DISABLE */
0208     nvtxNameOsThreadA_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxNameOsThreadA_impl_fnptr;
0209     if (local != NVTX_NULLPTR)
0210         (*local)(threadId, name);
0211 #endif /* NVTX_DISABLE */
0212 }
0213
0214 NVTX_DECLSPEC void NVTX_API nvtxNameOsThreadW(uint32_t threadId, const wchar_t* name)
0215 {
0216     NVTX_SET_NAME_MANGLING_OPTIONS
0217 #ifdef NVTX_DISABLE
0218     (void)threadId;
0219     (void)name;
0220 #else /* NVTX_DISABLE */
0221     nvtxNameOsThreadW_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxNameOsThreadW_impl_fnptr;
0222     if (local != NVTX_NULLPTR)
0223         (*local)(threadId, name);
0224 #endif /* NVTX_DISABLE */
0225 }
0226
0227 NVTX_DECLSPEC void NVTX_API nvtxDomainMarkEx(nvtxDomainHandle_t domain, const nvtxEventAttributes_t* eventAttrib)
0228 {
0229     NVTX_SET_NAME_MANGLING_OPTIONS
0230 #ifdef NVTX_DISABLE
0231     (void)domain;
0232     (void)eventAttrib;
0233 #else /* NVTX_DISABLE */
0234     nvtxDomainMarkEx_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainMarkEx_impl_fnptr;
0235     if (local != NVTX_NULLPTR)
0236         (*local)(domain, eventAttrib);
0237 #endif /* NVTX_DISABLE */
0238 }
0239
0240 NVTX_DECLSPEC nvtxRangeId_t NVTX_API nvtxDomainRangeStartEx(nvtxDomainHandle_t domain, const nvtxEventAttributes_t* eventAttrib)
0241 {
0242     NVTX_SET_NAME_MANGLING_OPTIONS
0243 #ifdef NVTX_DISABLE
0244     (void)domain;
0245     (void)eventAttrib;
0246 #else /* NVTX_DISABLE */
0247     nvtxDomainRangeStartEx_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainRangeStartEx_impl_fnptr;
0248     if (local != NVTX_NULLPTR)
0249         return (*local)(domain, eventAttrib);
0250     else
0251 #endif /* NVTX_DISABLE */
0252         return NVTX_STATIC_CAST(nvtxRangeId_t, 0);
0253 }
0254
0255 NVTX_DECLSPEC void NVTX_API nvtxDomainRangeEnd(nvtxDomainHandle_t domain, nvtxRangeId_t id)
0256 {
0257     NVTX_SET_NAME_MANGLING_OPTIONS
0258 #ifdef NVTX_DISABLE
0259     (void)domain;
0260     (void)id;
0261 #else /* NVTX_DISABLE */
0262     nvtxDomainRangeEnd_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainRangeEnd_impl_fnptr;
0263     if (local != NVTX_NULLPTR)
0264         (*local)(domain, id);
0265 #endif /* NVTX_DISABLE */
0266 }
0267
0268 NVTX_DECLSPEC int NVTX_API nvtxDomainRangePushEx(nvtxDomainHandle_t domain, const nvtxEventAttributes_t* eventAttrib)
0269 {
0270     NVTX_SET_NAME_MANGLING_OPTIONS
0271 #ifdef NVTX_DISABLE
0272     (void)domain;
0273     (void)eventAttrib;
0274 #else /* NVTX_DISABLE */
0275     nvtxDomainRangePushEx_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainRangePushEx_impl_fnptr;
0276     if (local != NVTX_NULLPTR)
0277         return (*local)(domain, eventAttrib);
0278     else
0279 #endif /* NVTX_DISABLE */
0280         return NVTX_STATIC_CAST(int, NVTX_NO_PUSH_POP_TRACKING);
0281 }
0282
0283 NVTX_DECLSPEC int NVTX_API nvtxDomainRangePop(nvtxDomainHandle_t domain)
0284 {
0285     NVTX_SET_NAME_MANGLING_OPTIONS
0286 #ifdef NVTX_DISABLE
0287     (void)domain;
0288 #else /* NVTX_DISABLE */
0289     nvtxDomainRangePop_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainRangePop_impl_fnptr;
0290     if (local != NVTX_NULLPTR)
0291         return (*local)(domain);
0292     else
0293 #endif /* NVTX_DISABLE */
0294         return NVTX_STATIC_CAST(int, NVTX_NO_PUSH_POP_TRACKING);
0295 }
0296
0297 NVTX_DECLSPEC nvtxResourceHandle_t NVTX_API nvtxDomainResourceCreate(nvtxDomainHandle_t domain, nvtxResourceAttributes_t* attribs)
0298 {
0299     NVTX_SET_NAME_MANGLING_OPTIONS
0300 #ifdef NVTX_DISABLE
0301     (void)domain;
0302     (void)attribs;
0303 #else /* NVTX_DISABLE */
0304     nvtxDomainResourceCreate_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainResourceCreate_impl_fnptr;
0305     if (local != NVTX_NULLPTR)
0306         return (*local)(domain, attribs);
0307     else
0308 #endif /* NVTX_DISABLE */
0309         return NVTX_NULLPTR;
0310 }
0311
0312 NVTX_DECLSPEC void NVTX_API nvtxDomainResourceDestroy(nvtxResourceHandle_t resource)
0313 {
0314     NVTX_SET_NAME_MANGLING_OPTIONS
0315 #ifdef NVTX_DISABLE
0316     (void)resource;
0317 #else /* NVTX_DISABLE */
0318     nvtxDomainResourceDestroy_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainResourceDestroy_impl_fnptr;
0319     if (local != NVTX_NULLPTR)
0320         (*local)(resource);
0321 #endif /* NVTX_DISABLE */
0322 }
0323
0324 NVTX_DECLSPEC void NVTX_API nvtxDomainNameCategoryA(nvtxDomainHandle_t domain, uint32_t category, const char* name)
0325 {
0326     NVTX_SET_NAME_MANGLING_OPTIONS
0327 #ifdef NVTX_DISABLE
0328     (void)domain;
0329     (void)category;
0330     (void)name;
0331 #else /* NVTX_DISABLE */
0332     nvtxDomainNameCategoryA_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainNameCategoryA_impl_fnptr;
0333     if (local != NVTX_NULLPTR)
0334         (*local)(domain, category, name);
0335 #endif /* NVTX_DISABLE */
0336 }
0337
0338 NVTX_DECLSPEC void NVTX_API nvtxDomainNameCategoryW(nvtxDomainHandle_t domain, uint32_t category, const wchar_t* name)
0339 {
0340     NVTX_SET_NAME_MANGLING_OPTIONS
0341 #ifdef NVTX_DISABLE
0342     (void)domain;
0343     (void)category;
0344     (void)name;
0345 #else /* NVTX_DISABLE */
0346     nvtxDomainNameCategoryW_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainNameCategoryW_impl_fnptr;
0347     if (local != NVTX_NULLPTR)
0348         (*local)(domain, category, name);
0349 #endif /* NVTX_DISABLE */
0350 }
0351
0352 NVTX_DECLSPEC nvtxStringHandle_t NVTX_API nvtxDomainRegisterStringA(nvtxDomainHandle_t domain, const char* string)
0353 {
0354     NVTX_SET_NAME_MANGLING_OPTIONS
0355 #ifdef NVTX_DISABLE
0356     (void)domain;
0357     (void)string;
0358 #else /* NVTX_DISABLE */
0359     nvtxDomainRegisterStringA_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainRegisterStringA_impl_fnptr;
0360     if (local != NVTX_NULLPTR)
0361         return (*local)(domain, string);
0362     else
0363 #endif /* NVTX_DISABLE */
0364         return NVTX_NULLPTR;
0365 }
0366
0367 NVTX_DECLSPEC nvtxStringHandle_t NVTX_API nvtxDomainRegisterStringW(nvtxDomainHandle_t domain, const wchar_t* string)
0368 {
0369     NVTX_SET_NAME_MANGLING_OPTIONS
0370 #ifdef NVTX_DISABLE
0371     (void)domain;
0372     (void)string;
0373 #else /* NVTX_DISABLE */
0374     nvtxDomainRegisterStringW_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainRegisterStringW_impl_fnptr;
0375     if (local != NVTX_NULLPTR)
0376         return (*local)(domain, string);
0377     else
0378 #endif /* NVTX_DISABLE */
0379         return NVTX_NULLPTR;
0380 }
0381
0382 NVTX_DECLSPEC nvtxDomainHandle_t NVTX_API nvtxDomainCreateA(const char* message)
0383 {
0384     NVTX_SET_NAME_MANGLING_OPTIONS
0385 #ifdef NVTX_DISABLE
0386     (void)message;
0387 #else /* NVTX_DISABLE */
0388     nvtxDomainCreateA_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainCreateA_impl_fnptr;
0389     if (local != NVTX_NULLPTR)
0390         return (*local)(message);
0391     else
0392 #endif /* NVTX_DISABLE */
0393         return NVTX_NULLPTR;
0394 }
0395
0396 NVTX_DECLSPEC nvtxDomainHandle_t NVTX_API nvtxDomainCreateW(const wchar_t* message)
0397 {
0398     NVTX_SET_NAME_MANGLING_OPTIONS
0399 #ifdef NVTX_DISABLE
0400     (void)message;
0401 #else /* NVTX_DISABLE */
0402     nvtxDomainCreateW_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainCreateW_impl_fnptr;
0403     if (local != NVTX_NULLPTR)
0404         return (*local)(message);
0405     else
0406 #endif /* NVTX_DISABLE */
0407         return NVTX_NULLPTR;
0408 }
0409
0410 NVTX_DECLSPEC void NVTX_API nvtxDomainDestroy(nvtxDomainHandle_t domain)
0411 {
0412     NVTX_SET_NAME_MANGLING_OPTIONS
0413 #ifdef NVTX_DISABLE
0414     (void)domain;
0415 #else /* NVTX_DISABLE */
0416     nvtxDomainDestroy_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxDomainDestroy_impl_fnptr;
0417     if (local != NVTX_NULLPTR)
0418         (*local)(domain);
0419 #endif /* NVTX_DISABLE */
0420 }
0421
0422 NVTX_DECLSPEC void NVTX_API nvtxInitialize(const void* reserved)
0423 {
0424     NVTX_SET_NAME_MANGLING_OPTIONS
0425 #ifdef NVTX_DISABLE
0426     (void)reserved;
0427 #else /* NVTX_DISABLE */
0428     nvtxInitialize_impl_fntype local = NVTX_VERSIONED_IDENTIFIER(nvtxGlobals).nvtxInitialize_impl_fnptr;
0429     if (local != NVTX_NULLPTR)
0430         (*local)(reserved);
0431 #endif /* NVTX_DISABLE */
0432 }