Context.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2016-2025 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 DW_CORE_CONTEXT_H_
#define DW_CORE_CONTEXT_H_
 
#include <dw/core/base/Config.h>
#include <dw/core/base/Exports.h>
#include <dw/core/base/Types.h>
#include <dw/core/base/Version.h>
#include <dw/core/base/Status.h>
#include <dw/core/time/Timer.h>
#include <dw/core/health/HealthSignals.h>
#include <dw/core/platform/GPUProperties.h>
 
#include <cuda_runtime_api.h>
#include <cuda_runtime.h>
#include <nvscibuf.h>
#include <nvscisync.h>
 
// type definitions for CUDA structs
typedef enum cudaDeviceAttr cudaDeviceAttr;
 
// Forward declares from EGL
typedef void* EGLDisplay;
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct dwContextObject* dwContextHandle_t;
typedef struct dwContextObject const* dwConstContextHandle_t;
 
typedef struct dwModuleObject* dwModuleHandle_t;
typedef struct dwModuleObject const* dwConstModuleHandle_t;
 
typedef struct dwContextParameters
{
 
#ifdef DW_USE_EGL
    EGLDisplay eglDisplay;
 
    bool skipEglInit;
#endif
 
    const char8_t* dataPath;
 
    bool skipCudaInit;
 
    bool enablePVA;
 
    bool enableCudaTaskGraph;
 
    bool useVirtualTime;
} dwContextParameters;
 
typedef void* dwCustomizedFileHandle;
 
typedef void* dwDLAHandleArray;
 
typedef struct dwCustomizedFileFunctions
{
    void (*close)(dwCustomizedFileHandle hnd);
 
    size_t (*write)(dwCustomizedFileHandle hnd, const void* ptr, size_t size);
 
    size_t (*read)(dwCustomizedFileHandle hnd, void* ptr, size_t size);
 
    bool (*getString)(dwCustomizedFileHandle hnd, char8_t* ptr, size_t size);
 
    size_t (*size)(dwCustomizedFileHandle hnd);
 
    size_t (*getPosition)(dwCustomizedFileHandle hnd);
 
    void (*setPosition)(dwCustomizedFileHandle hnd, size_t size);
 
    bool (*eof)(dwCustomizedFileHandle hnd);
 
    bool (*error)(dwCustomizedFileHandle hnd);
 
    void (*flush)(dwCustomizedFileHandle hnd);
 
    dwCustomizedFileHandle (*open)(const char8_t* ptr1, const char8_t* ptr2);
 
} dwCustomizedFileFunctions;
 
typedef enum {
    DW_PTP_STATUS_NO_INIT_SYNC = 0,
 
    DW_PTP_STATUS_NO_ERROR,
 
    DW_PTP_STATUS_LOST_SYNC,
 
    DW_PTP_STATUS_INTERNAL_ERROR,
} dwPTPStatus;
 
DW_API_PUBLIC
dwStatus dwContext_setCustomFileFunctions(dwContextHandle_t const context, dwCustomizedFileFunctions* const fileFunctionPtr);
 
DW_API_PUBLIC
dwStatus dwGetLastError(char8_t const** const errorMsg);
 
DW_API_PUBLIC
dwStatus dwGetLastCudaError(cudaError_t* const cudaError, char8_t const** const errorMsg);
 
DW_API_PUBLIC
dwStatus dwInitialize(dwContextHandle_t* const context, dwVersion const headerVersion, dwContextParameters const* const params);
 
DW_API_PUBLIC
dwStatus dwRelease(dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getCurrentTime(dwTime_t* const time, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getCurrentTimeMono(dwTime_t* const time, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getCurrentTimeUTC(dwTime_t* const time, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getTimeSource(dwTimeSourceHandle_t* const source, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_isTimePTPSynchronized(bool* const flag, dwContextHandle_t const context); // clang-tidy NOLINT(readability-non-const-parameter);
 
DW_API_PUBLIC
dwStatus dwContext_getTimePTPSynchronizationStatus(dwPTPStatus* const status, dwContextHandle_t const context); // clang-tidy NOLINT(readability-non-const-parameter);
 
DW_API_PUBLIC
dwStatus dwContext_sleepMonotonic(dwTime_t const sleepTimeUs);
 
DW_API_PUBLIC
dwStatus dwContext_selectGPUDevice(int32_t const deviceNumber, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getGPUDeviceCurrent(int32_t* const deviceNumber, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getGPUCount(int32_t* const count, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getGPUProperties(dwGPUDeviceProperties* const properties, int32_t const deviceNum,
                                    dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getGPUAttribute(int32_t* const value, cudaDeviceAttr const attribute, int32_t const deviceNum,
                                   dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getGPUArchitecture(char8_t const** const architecture, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getCUDAProperties(int32_t* const driverVersion, int32_t* const apiVersion, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getCUDAStream(cudaStream_t* stream, uint32_t streamIndex, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getGPUDeviceType(dwGPUDeviceType* const deviceType, int32_t const deviceNum, dwContextHandle_t const context);
 
#ifdef DW_USE_EGL
 
DW_API_PUBLIC
DW_DEPRECATED("Display and EGL related context is moved to src/dwvisualization, please replace this call with dwVisualization_setEGLDisplay.")
dwStatus dwContext_setEGLDisplay(EGLDisplay display, dwContextHandle_t context);
 
DW_API_PUBLIC
DW_DEPRECATED("Display and EGL related context is moved to src/dwvisualization, please replace this call with dwVisualization_getEGLDisplay.")
dwStatus dwContext_getEGLDisplay(EGLDisplay* display, dwContextHandle_t context);
#endif
 
DW_API_PUBLIC
dwStatus dwContext_getDLAEngineCount(int32_t* const count, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_setupCUDLA(uint16_t const* handleCountArray, uint16_t const handleCountArraySize, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getCUDLADeviceHandleArray(dwDLAHandleArray* const cudlaDeviceHandleArray, uint16_t* const cudlaDeviceHandleCount, uint16_t const engineId, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getDataPath(char8_t const** const dataPath, dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getUseVirtualTime(bool* const useVirtualTime, dwContextHandle_t const ctx);
 
DW_API_PUBLIC
dwStatus dwContext_getNvSciSyncModule(NvSciSyncModule* mod,
                                      dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getNvSciBufModule(NvSciBufModule* mod,
                                     dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwContext_getErrorSignal(dwErrorSignal* errorSignal, dwModuleHandle_t handle);
 
#ifdef __cplusplus
}
#endif
 
#endif // DW_CORE_CONTEXT_H_