Trace.hpp

Go to the documentation of this file.

 
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2016-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//
 
#ifndef DWTRACE_TRACE_HPP_
#define DWTRACE_TRACE_HPP_
 
// Trace Public header file
#include <dwtrace/dw/trace/TraceTypes.hpp>
#include <dwtrace/dw/trace/TraceStructures.hpp>
#include <dwtrace/dw/trace/TraceFunctions.hpp>
#include <dwtrace/dw/trace/CpuScopeTraceEvent.hpp>
#include <dwtrace/dw/trace/CudaScopeTraceEvent.hpp>
#include <dwtrace/dw/trace/TraceUtils.hpp>
 
namespace dw
{
namespace trace
{
// Supports up to 5 layers of Concatenation
#define DW_TRACE_GET_MACRO_2(_1, _2, NAME, ...) NAME
#define DW_TRACE_GET_MACRO_5(_1, _2, _3, _4, _5, NAME, ...) NAME
 
#define DW_TRACE_TAG(...) \
    dw::trace::dwtFixedString_t(DW_TRACE_GET_MACRO_5(__VA_ARGS__, DW_TRACE_TAG5, DW_TRACE_TAG4, DW_TRACE_TAG3, DW_TRACE_TAG2, DW_TRACE_TAG1)(__VA_ARGS__))
#define DW_TRACE_TAG1(STR1) (STR1)
#define DW_TRACE_TAG2(STR1, STR2) (STR1 "@" STR2)
#define DW_TRACE_TAG3(STR1, STR2, STR3) (STR1 ":" STR2 "@" STR3)
#define DW_TRACE_TAG4(STR1, STR2, STR3, STR4) (STR1 ":" STR2 ":" STR3 "@" STR4)
#define DW_TRACE_TAG5(STR1, STR2, STR3, STR4, STR5) (STR1 ":" STR2 ":" STR3 ":" STR4 "@" STR5)
 
#define DW_TRACE_PAYLOAD(...)                                               \
    DW_TRACE_GET_MACRO_2(__VA_ARGS__, DW_TRACE_PAYLOAD2, DW_TRACE_PAYLOAD1) \
    (__VA_ARGS__)
#define DW_TRACE_PAYLOAD1(STR1) dw::trace::TraceFunctions::singlePayload(STR1)
#define DW_TRACE_PAYLOAD2(STR1, STR2) dw::trace::TraceFunctions::joinPayloadChars(STR1, STR2)
 
// Avoid shadow declaration for nested tracing with unique variables
#define DW_CONCAT_(x, y) x##y
#define DW_CONCAT(x, y) DW_CONCAT_(x, y)
#define DW_UNIQUE_VAR(name) DW_CONCAT(name, __LINE__)
 
#define DW_TRACE_ENABLE(chan_mask, level) dw::trace::TraceFunctions::dwTraceEnable(chan_mask, level)
 
#define DW_TRACE_DISABLE(chan_mask) dw::trace::TraceFunctions::dwTraceDisable(chan_mask)
 
#define DW_TRACE_ENABLE_ALL() dw::trace::TraceFunctions::dwTraceEnableAll()
 
#define DW_TRACE_MARK(...) dw::trace::TraceFunctions::dwTraceMark(__VA_ARGS__)
 
#define DW_TRACE_BEGIN(...) dw::trace::TraceFunctions::dwTraceBegin(__VA_ARGS__)
 
#define DW_TRACE_END(...) dw::trace::TraceFunctions::dwTraceEnd(__VA_ARGS__)
 
#define DW_TRACE_ASYNC_BEGIN(...) dw::trace::TraceFunctions::dwTraceAsyncBegin(__VA_ARGS__)
 
#define DW_TRACE_ASYNC_END(...) dw::trace::TraceFunctions::dwTraceAsyncEnd(__VA_ARGS__)
 
#define DW_TRACE_CUDA_BEGIN(...) dw::trace::TraceFunctions::dwTraceCudaBegin(__VA_ARGS__)
 
#define DW_TRACE_CUDA_END(...) dw::trace::TraceFunctions::dwTraceCudaEnd(__VA_ARGS__)
 
#define DW_TRACE_CUDA_BEGIN_ASYNC(...) DW_TRACE_CUDA_BEGIN(__VA_ARGS__)
 
#define DW_TRACE_CUDA_RECORD_ASYNC(...) dw::trace::TraceFunctions::dwTraceCudaRecordAsync(__VA_ARGS__)
 
#define DW_TRACE_CUDA_COLLECT_ASYNC(...) dw::trace::TraceFunctions::dwTraceCudaCollectAsync(__VA_ARGS__)
 
#define DW_TRACE_CUDA_COLLECT_ALL() dw::trace::TraceFunctions::dwTraceCudaCollectAll()
 
#define DW_TRACE_CORE_INIT(...) dw::trace::TraceFunctions::dwTraceCoreInit(__VA_ARGS__)
 
#define DW_TRACE_INIT(...)                                   \
    dw::trace::TraceFunctions::dwTraceCoreInit(__VA_ARGS__); \
    dw::trace::TraceFunctions::dwTraceWrapperInit(__VA_ARGS__);
 
#define DW_TRACE_RESET(...)                               \
    dw::trace::TraceFunctions::dwTraceReset(__VA_ARGS__); \
    dw::trace::TraceFunctions::dwTraceWrapperDeinit(__VA_ARGS__);
 
#define DW_TRACE_RESET_WRAPPER(...) \
    dw::trace::TraceFunctions::dwTraceWrapperReset(__VA_ARGS__);
 
#define DW_TRACE_BIND_OUTPUT(...) dw::trace::TraceFunctions::dwTraceBindOutput(__VA_ARGS__)
 
#define DW_TRACE_REGISTER_CB(...) dw::trace::TraceFunctions::dwTraceRegisterCallback(__VA_ARGS__)
#define DW_TRACE_FLUSH(isForce) dw::trace::TraceFunctions::dwTraceFlush(isForce)
 
#define DW_TRACE_SCOPE(...)                                                   \
    dw::trace::CpuScopeTraceEvent DW_UNIQUE_VAR(cpuTraceEvent_){__VA_ARGS__}; \
    dw::trace::TraceFunctions::dwTraceBegin(__VA_ARGS__);
 
#define DW_TRACE_CUDA_SCOPE(...)                                                       \
    dw::trace::CudaScopeTraceEvent DW_UNIQUE_VAR(cudaTraceEvent_){false, __VA_ARGS__}; \
    dw::trace::TraceFunctions::dwTraceCudaBegin(__VA_ARGS__);
 
#define DW_TRACE_CUDA_SCOPE_ASYNC(...)                                                \
    dw::trace::CudaScopeTraceEvent DW_UNIQUE_VAR(cudaTraceEvent_){true, __VA_ARGS__}; \
    dw::trace::TraceFunctions::dwTraceCudaBegin(__VA_ARGS__);
 
#ifdef __QNX__
#define DW_TRACE_BOOT_PROFILER(msg) dw::trace::TraceFunctions::dwTraceBootProfiler(msg)
#else
#define DW_TRACE_BOOT_PROFILER(msg)
#endif
 
} // namespace trace
} // namespace dw
 
#endif // DWTRACE_TRACE_HPP_