TraceFunctions.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) 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_FUNCTIONS_HPP_
#define DWTRACE_TRACE_FUNCTIONS_HPP_
 
#include <dwtrace/dw/trace/TraceTypes.hpp>
#include <dwtrace/dw/trace/TraceStructures.hpp>
#include <dwtrace/dw/trace/DWTraceChannel.hpp>
 
namespace dw
{
namespace trace
{
 
// advertise performance impact of cudaEventBlockingSync (true = use it)
inline bool isBlockingSyncPreferred()
{
#ifdef VIBRANTE
    return true; // Tegra
#else
    return false; // x86
#endif
}
 
inline uint32_t getPreferredBlockingFlags()
{
    return dw::trace::isBlockingSyncPreferred() ? static_cast<uint32_t>(cudaEventBlockingSync) : static_cast<uint32_t>(0U);
}
 
class TraceFunctions
{
public:
    static Level getTraceLevel(const sv& level);
    static uint64_t getFlushInterval();
    static Level getTraceLevel();
 
    static dwtFixedString_t singlePayload(char8_t const* const str1);
    static dwtFixedString_t singlePayload(int32_t const i);
    static dwtFixedString_t joinPayloadChars(char8_t const* const str1, char8_t const* const str2);
 
    static bool isFileBackendEnabled();
    static bool isNVTXBackendEnabled();
    static bool isFTraceBackendEnabled();
    static bool isDWTracingEnabled();
 
    static void fTraceInit();
    static void fTraceWrite(dwtFixedString_t& str);
    static void fTraceDeInit();
 
    static void dwTraceEnable(TracerConfig& config);
    static void dwTraceDisable(uint64_t const chanMask);
    static void dwTraceEnableAll();
 
    static size_t getDeviceMemFree();
    static int32_t getHostMemUsed();
    static uint64_t getNvMapMemUsed();
 
    static void dwTraceCoreInit(TracerConfig tracerCfg);
    static void dwTraceWrapperInit(TracerConfig const tracerCfg);
    static void dwTraceWrapperReset();
    static void dwTraceWrapperDeinit();
    static void dwTraceReset();
 
    static void dwTraceBindOutput(TraceBuf* const buf);
    static void dwTraceRegisterCallback(avtFlushCb_t func, void* const userdata);
 
    static void dwTraceMark(
        TraceChannel const chan, dwtFixedString_t const& name = dwtFixedString_t(""),
        Level const level                              = DW_TRACE_LEVEL_DEFAULT,
        dwtFixedString_t const& payload                = dwtFixedString_t(""),
        dw::core::Optional<uint64_t> const nvtxPayload = dw::core::NULLOPT);
 
    static void dwTraceBegin(TraceChannel const chan, dwtFixedString_t const& name = dwtFixedString_t(""),
                             Level const level                              = DW_TRACE_LEVEL_DEFAULT,
                             dwtFixedString_t const& payload                = dwtFixedString_t(""),
                             dw::core::Optional<uint64_t> const nvtxPayload = dw::core::NULLOPT);
 
    static void dwTraceEnd(TraceChannel const chan, dwtFixedString_t const& name = dwtFixedString_t(""),
                           Level const level                              = DW_TRACE_LEVEL_DEFAULT,
                           dwtFixedString_t const& payload                = dwtFixedString_t(""),
                           dw::core::Optional<uint64_t> const nvtxPayload = dw::core::NULLOPT);
 
    static void dwTraceAsyncBegin(TraceChannel const chan, dwtFixedString_t const& name = dwtFixedString_t(""),
                                  Level const level                              = DW_TRACE_LEVEL_DEFAULT,
                                  dwtFixedString_t const& payload                = dwtFixedString_t(""),
                                  dw::core::Optional<uint64_t> const nvtxPayload = dw::core::NULLOPT);
 
    static void dwTraceAsyncEnd(TraceChannel const chan, dwtFixedString_t const& name = dwtFixedString_t(""),
                                Level const level                              = DW_TRACE_LEVEL_DEFAULT,
                                dwtFixedString_t const& payload                = dwtFixedString_t(""),
                                dw::core::Optional<uint64_t> const nvtxPayload = dw::core::NULLOPT);
 
    static void dwTraceCudaBegin(TraceChannel const chan, dwtFixedString_t const& name = dwtFixedString_t(""),
                                 cudaStream_t const stream       = nullptr,
                                 Level const level               = DW_TRACE_LEVEL_DEFAULT,
                                 dwtFixedString_t const& payload = dwtFixedString_t(""));
 
    static void dwTraceCudaEnd(TraceChannel const chan, dwtFixedString_t const& name = dwtFixedString_t(""),
                               cudaStream_t stream             = nullptr,
                               Level const level               = DW_TRACE_LEVEL_DEFAULT,
                               dwtFixedString_t const& payload = dwtFixedString_t(""));
 
    static void dwTraceCudaRecordAsync(TraceChannel const chan, dwtFixedString_t const& name = dwtFixedString_t(""),
                                       cudaStream_t const stream = nullptr,
                                       Level const level         = DW_TRACE_LEVEL_DEFAULT);
 
    static void dwTraceCudaCollectAsync(TraceChannel const chan, dwtFixedString_t const& name = dwtFixedString_t(""),
                                        Level const level               = DW_TRACE_LEVEL_DEFAULT,
                                        dwtFixedString_t const& payload = dwtFixedString_t(""));
 
    static void dwTraceCudaCollectAll();
 
    static void dwTraceFlush(bool const isForce);
 
#ifdef __QNX__
    static void dwTraceBootProfiler(const dw::core::FixedString<256>& msg);
#endif
};
 
} // namespace trace
} // namespace dw
 
#endif // DWTRACE_TRACE_FUNCTIONS_HPP_