Context.h

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-2022 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/Config.h>
#include <dw/core/base/Exports.h>
#include <dw/core/base/Types.h>
#include <dw/core/Version.h>
#include <dw/core/base/Status.h>
#include <cuda_runtime_api.h>

// type definitions for CUDA structs
typedef struct cudaDeviceProp cudaDeviceProp;
typedef enum cudaDeviceAttr cudaDeviceAttr;
typedef enum cudaTextureAddressMode cudaTextureAddressMode;

// 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 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;

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 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_isTimePTPSynchronized(bool* const flag, dwContextHandle_t const context); // clang-tidy NOLINT(readability-non-const-parameter);

DW_API_PUBLIC
dwStatus dwContext_advanceTime(dwTime_t const newTime, dwContextHandle_t const context);

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(cudaDeviceProp* 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_getGPUDeviceType(dwGPUDeviceType* const deviceType, int32_t const deviceNum, dwContextHandle_t const context);

#ifdef DW_USE_EGL

DW_API_PUBLIC
dwStatus dwContext_setEGLDisplay(EGLDisplay display, dwContextHandle_t context);

DW_API_PUBLIC
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_getDataPath(char8_t const** const dataPath, dwContextHandle_t const context);

DW_API_PUBLIC
dwStatus dwContext_getUseVirtualTime(bool* const useVirtualTime, dwContextHandle_t const ctx);

#ifdef __cplusplus
}
#endif

#endif // DW_CORE_CONTEXT_H_