DriveWorks SDK Reference
5.14.77 Release
For Test and Development only

Context.h
Go to the documentation of this file.
1
2//
3// Notice
4// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
5// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
6// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
7// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
8//
9// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
10// information or for any infringement of patents or other rights of third parties that may
11// result from its use. No license is granted by implication or otherwise under any patent
12// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
13// expressly authorized by NVIDIA. Details are subject to change without notice.
14// This code supersedes and replaces all information previously supplied.
15// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
16// components in life support devices or systems without express written approval of
17// NVIDIA CORPORATION & AFFILIATES.
18//
19// SPDX-FileCopyrightText: Copyright (c) 2016-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
20// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
21//
22// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
23// property and proprietary rights in and to this material, related
24// documentation and any modifications thereto. Any use, reproduction,
25// disclosure or distribution of this material and related documentation
26// without an express license agreement from NVIDIA CORPORATION or
27// its affiliates is strictly prohibited.
28//
30
48#ifndef DW_CORE_CONTEXT_H_
49#define DW_CORE_CONTEXT_H_
50
51#include <dw/core/base/Config.h>
53#include <dw/core/base/Types.h>
55#include <dw/core/base/Status.h>
56#include <dw/core/time/Timer.h>
58
59#include <cuda_runtime_api.h>
60#include <cuda_runtime.h>
61#include <nvscibuf.h>
62#include <nvscisync.h>
63
64// type definitions for CUDA structs
68
69// Forward declares from EGL
70typedef void* EGLDisplay;
71
72#ifdef __cplusplus
73extern "C" {
74#endif
75
85// coverity[misra_c_2012_rule_1_1_violation]
86typedef struct dwContextObject* dwContextHandle_t;
87typedef struct dwContextObject const* dwConstContextHandle_t;
88
90typedef struct dwModuleObject* dwModuleHandle_t;
91typedef struct dwModuleObject const* dwConstModuleHandle_t;
92
96typedef struct dwContextParameters
97{
98
99#ifdef DW_USE_EGL
101 EGLDisplay eglDisplay;
102
107 bool skipEglInit;
108#endif
109
114 const char8_t* dataPath;
115
121
129
134
141
144
149{
153
159 size_t (*write)(dwCustomizedFileHandle hnd, const void* ptr, size_t size);
160
165 size_t (*read)(dwCustomizedFileHandle hnd, void* ptr, size_t size);
166
171 bool (*getString)(dwCustomizedFileHandle hnd, char8_t* ptr, size_t size);
172
177
182
187
192
197
201
206 dwCustomizedFileHandle (*open)(const char8_t* ptr1, const char8_t* ptr2);
207
209
213typedef enum {
216
219
222
226
240
256dwStatus dwGetLastError(char8_t const** const errorMsg);
257
286dwStatus dwInitialize(dwContextHandle_t* const context, dwVersion const headerVersion, dwContextParameters const* const params);
287
302
320
335
358dwStatus dwContext_isTimePTPSynchronized(bool* const flag, dwContextHandle_t const context); // clang-tidy NOLINT(readability-non-const-parameter);
359
373dwStatus dwContext_getTimePTPSynchronizationStatus(dwPTPStatus* const status, dwContextHandle_t const context); // clang-tidy NOLINT(readability-non-const-parameter);
374
384
399dwStatus dwContext_selectGPUDevice(int32_t const deviceNumber, dwContextHandle_t const context);
400
412dwStatus dwContext_getGPUDeviceCurrent(int32_t* const deviceNumber, dwContextHandle_t const context);
413
425dwStatus dwContext_getGPUCount(int32_t* const count, dwContextHandle_t const context);
426
442dwStatus dwContext_getGPUProperties(dwGPUDeviceProperties* const properties, int32_t const deviceNum,
443 dwContextHandle_t const context);
444
462dwStatus dwContext_getGPUAttribute(int32_t* const value, cudaDeviceAttr const attribute, int32_t const deviceNum,
463 dwContextHandle_t const context);
464
476dwStatus dwContext_getGPUArchitecture(char8_t const** const architecture, dwContextHandle_t const context);
477
491dwStatus dwContext_getCUDAProperties(int32_t* const driverVersion, int32_t* const apiVersion, dwContextHandle_t const context);
492
506dwStatus dwContext_getGPUDeviceType(dwGPUDeviceType* const deviceType, int32_t const deviceNum, dwContextHandle_t const context);
507
508#ifdef DW_USE_EGL
524dwStatus dwContext_setEGLDisplay(EGLDisplay display, dwContextHandle_t context);
525
540dwStatus dwContext_getEGLDisplay(EGLDisplay* display, dwContextHandle_t context);
541#endif
542
554dwStatus dwContext_getDLAEngineCount(int32_t* const count, dwContextHandle_t const context);
555
569dwStatus dwContext_getDataPath(char8_t const** const dataPath, dwContextHandle_t const context);
570
582dwStatus dwContext_getUseVirtualTime(bool* const useVirtualTime, dwContextHandle_t const ctx);
583
597 dwContextHandle_t const context);
598
612 dwContextHandle_t const context);
613
614#ifdef __cplusplus
615}
616#endif
618#endif // DW_CORE_CONTEXT_H_
struct cudaDeviceProp cudaDeviceProp
Definition: Context.h:65
enum cudaDeviceAttr cudaDeviceAttr
Definition: Context.h:66
void * EGLDisplay
Definition: Context.h:70
enum cudaTextureAddressMode cudaTextureAddressMode
Definition: Context.h:67
dwStatus
Status definition.
Definition: ErrorDefs.h:45
Redefinition of cudaDeviceProp for the safety build.
Definition: GPUProperties.h:37
NVIDIA DriveWorks API: Core Status Methods
NVIDIA DriveWorks API: Timer
NVIDIA DriveWorks API: Core Types
NVIDIA DriveWorks API: Core Version Information
NVIDIA DriveWorks API: Core Exports
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: BasicTypes.h:65
const char8_t * dataPath
Path where all DriveWorks related data required during runtime are stored.
Definition: Context.h:114
bool enablePVA
if true, PVA platform will be enabled.
Definition: Context.h:128
bool skipCudaInit
if true will skip CUDA initialization in the context
Definition: Context.h:120
bool enableCudaTaskGraph
if true, Cuda task-graph will be used where possible.
Definition: Context.h:133
bool useVirtualTime
if true, the context's time source will be a virtual clock.
Definition: Context.h:139
DW_API_PUBLIC dwStatus dwInitialize(dwContextHandle_t *const context, dwVersion const headerVersion, dwContextParameters const *const params)
Creates and initializes an SDK context.
DW_API_PUBLIC dwStatus dwRelease(dwContextHandle_t const context)
Releases the context.
DW_API_PUBLIC dwStatus dwContext_getUseVirtualTime(bool *const useVirtualTime, dwContextHandle_t const ctx)
Check if in virtual time mode.
DW_API_PUBLIC dwStatus dwContext_getGPUDeviceCurrent(int32_t *const deviceNumber, dwContextHandle_t const context)
Returns the currently selected GPU device.
struct dwModuleObject * dwModuleHandle_t
The Generic Module Object Handle.
Definition: Context.h:90
DW_API_PUBLIC dwStatus dwContext_setCustomFileFunctions(dwContextHandle_t const context, dwCustomizedFileFunctions *const fileFunctionPtr)
Set the customized fileStream function pointers in context.
DW_API_PUBLIC dwStatus dwContext_getCUDAProperties(int32_t *const driverVersion, int32_t *const apiVersion, dwContextHandle_t const context)
Returns Driver and Runtime API version of CUDA on the current machine.
DW_API_PUBLIC dwStatus dwContext_getGPUCount(int32_t *const count, dwContextHandle_t const context)
Get the available GPU devices count.
struct dwContextObject const * dwConstContextHandle_t
Definition: Context.h:87
DW_API_PUBLIC dwStatus dwContext_getGPUDeviceType(dwGPUDeviceType *const deviceType, int32_t const deviceNum, dwContextHandle_t const context)
Returns the device type of the input GPU number.
DW_API_PUBLIC dwStatus dwContext_getDLAEngineCount(int32_t *const count, dwContextHandle_t const context)
Get the available DLA engines count.
DW_API_PUBLIC dwStatus dwContext_getNvSciSyncModule(NvSciSyncModule *mod, dwContextHandle_t const context)
Get the NvSciSync module.
struct dwModuleObject const * dwConstModuleHandle_t
Definition: Context.h:91
dwPTPStatus
Defines PTP synchronization status.
Definition: Context.h:213
DW_API_PUBLIC dwStatus dwContext_getGPUArchitecture(char8_t const **const architecture, dwContextHandle_t const context)
Returns the architecture for the currently selected CUDA device.
DW_API_PUBLIC dwStatus dwContext_getNvSciBufModule(NvSciBufModule *mod, dwContextHandle_t const context)
Get the nvscibuf module.
DW_API_PUBLIC dwStatus dwContext_selectGPUDevice(int32_t const deviceNumber, dwContextHandle_t const context)
Selects a GPU device, if available.
DW_API_PUBLIC dwStatus dwContext_getGPUAttribute(int32_t *const value, cudaDeviceAttr const attribute, int32_t const deviceNum, dwContextHandle_t const context)
Returns the value of the selected CUDA attribute for the specific CUDA device.
DW_API_PUBLIC dwStatus dwContext_getCurrentTime(dwTime_t *const time, dwContextHandle_t const context)
Returns the current timestamp.
DW_API_PUBLIC dwStatus dwContext_getTimePTPSynchronizationStatus(dwPTPStatus *const status, dwContextHandle_t const context)
Get the PTP synchronization status of time source inside the context.
DW_API_PUBLIC dwStatus dwContext_getGPUProperties(dwGPUDeviceProperties *const properties, int32_t const deviceNum, dwContextHandle_t const context)
Returns the properties for the specific CUDA device.
DW_API_PUBLIC dwStatus dwContext_getDataPath(char8_t const **const dataPath, dwContextHandle_t const context)
Gets the initial data path of the library that contains the driveworks context.
DW_API_PUBLIC dwStatus dwGetLastError(char8_t const **const errorMsg)
Retrieves the last error encountered.
struct dwContextObject * dwContextHandle_t
Context handle.
Definition: Context.h:86
DW_API_PUBLIC dwStatus dwContext_advanceTime(dwTime_t const newTime, dwContextHandle_t const context)
Advances the virtual time to newTime.
DW_API_PUBLIC dwStatus dwContext_getTimeSource(dwTimeSourceHandle_t *const source, dwContextHandle_t const context)
Retrieve time source used in the context.
void * dwCustomizedFileHandle
FileStream function pointers handle.
Definition: Context.h:143
DW_API_PUBLIC dwStatus dwContext_isTimePTPSynchronized(bool *const flag, dwContextHandle_t const context)
Check if the used time source inside the context is synchronized over PTP.
@ DW_PTP_STATUS_NO_ERROR
No error.
Definition: Context.h:218
@ DW_PTP_STATUS_LOST_SYNC
PTP synchronization lost.
Definition: Context.h:221
@ DW_PTP_STATUS_NO_INIT_SYNC
PTP synchronization is not started.
Definition: Context.h:215
@ DW_PTP_STATUS_INTERNAL_ERROR
PTP internal error.
Definition: Context.h:224
A set of parameters that is passed to the SDK to create the context.
Definition: Context.h:97
#define DW_API_PUBLIC
Definition: Exports.h:54
dwGPUDeviceType
GPU device type definitions Only applicable on Drive platforms.
Definition: TypesExtra.h:120
struct dwTimeSourceObject * dwTimeSourceHandle_t
Definition: Timer.h:57
Data structure representing a customized FileStream that can be passed in.
Definition: Context.h:149
size_t(* read)(dwCustomizedFileHandle hnd, void *ptr, size_t size)
Function pointer: Read raw data from the file stream and return the number of bytes read.
Definition: Context.h:165
void(* setPosition)(dwCustomizedFileHandle hnd, size_t size)
Function pointer: Set the desired position inside the file stream.
Definition: Context.h:186
dwCustomizedFileHandle(* open)(const char8_t *ptr1, const char8_t *ptr2)
Function pointer: Open the file stream and returns the handle to the file.
Definition: Context.h:206
size_t(* write)(dwCustomizedFileHandle hnd, const void *ptr, size_t size)
Function pointer: Write raw data to the file stream from an input buffer and return the number of byt...
Definition: Context.h:159
size_t(* size)(dwCustomizedFileHandle hnd)
Function pointer: Returns the total number of bytes in the file stream.
Definition: Context.h:176
bool(* getString)(dwCustomizedFileHandle hnd, char8_t *ptr, size_t size)
Function pointer: Read a string from the file stream.
Definition: Context.h:171
void(* flush)(dwCustomizedFileHandle hnd)
Function pointer: Synchronizes the file stream, waiting that all requested bytes have been read.
Definition: Context.h:200
bool(* error)(dwCustomizedFileHandle hnd)
Function pointer: Check if any I/O error occurred during OPEN/RD/WR operations.
Definition: Context.h:196
bool(* eof)(dwCustomizedFileHandle hnd)
Function pointer: Check if the end of file flag is set for the file stream.
Definition: Context.h:191
void(* close)(dwCustomizedFileHandle hnd)
Function pointer: Close the file stream.
Definition: Context.h:152
size_t(* getPosition)(dwCustomizedFileHandle hnd)
Function pointer: Returns the current position inside the file stream.
Definition: Context.h:181