vGPU Structs#
Macros#
- NVML_GRID_LICENSE_STATE_LICENSED
Licensed state.
- NVML_GRID_LICENSE_STATE_UNINITIALIZED
Uninitialized state.
- NVML_GRID_LICENSE_STATE_UNKNOWN
vGPU license state
- NVML_GRID_LICENSE_STATE_UNLICENSED
Unlicensed state.
- NVML_GRID_LICENSE_STATE_UNLICENSED_RESTRICTED
Unlicensed restricted state.
- NVML_GRID_LICENSE_STATE_UNLICENSED_UNRESTRICTED
Unlicensed unrestricted state.
- NVML_SCHEDULER_SW_MAX_LOG_ENTRIES
Maximum number of scheduler log entries.
- NVML_SUPPORTED_VGPU_SCHEDULER_POLICY_COUNT
Number of supported vGPU scheduler policies.
- NVML_VGPU_SCHEDULER_ARR_DEFAULT
Default Adaptive Round Robin mode.
- NVML_VGPU_SCHEDULER_ARR_DISABLE
Disable Adaptive Round Robin mode.
- NVML_VGPU_SCHEDULER_ARR_ENABLE
Enable Adaptive Round Robin mode.
- NVML_VGPU_SCHEDULER_ENGINE_TYPE_GRAPHICS
vGPU scheduler engine types A GPU or GI may support a subset of engines
- NVML_VGPU_SCHEDULER_ENGINE_TYPE_NVENC0
NVENC0.
- NVML_VGPU_SCHEDULER_ENGINE_TYPE_NVENC1
NVENC1.
- NVML_VGPU_SCHEDULER_POLICY_BEST_EFFORT
Best effort scheduler policy.
- NVML_VGPU_SCHEDULER_POLICY_EQUAL_SHARE
Equal share scheduler policy.
- NVML_VGPU_SCHEDULER_POLICY_FIXED_SHARE
Fixed share scheduler policy.
- NVML_VGPU_SCHEDULER_POLICY_UNKNOWN
vGPU scheduler policies
- nvmlActiveVgpuInstanceInfo_v1
Version macro for nvmlActiveVgpuInstanceInfo_v1_t .
- nvmlVgpuCreatablePlacementInfo_v1
Version macro for nvmlVgpuCreatablePlacementInfo_v1_t .
- nvmlVgpuHeterogeneousMode_v1
Version macro for nvmlVgpuHeterogeneousMode_v1_t .
- nvmlVgpuInstancesUtilizationInfo_v1
Version macro for nvmlVgpuInstancesUtilizationInfo_v1_t .
- nvmlVgpuPlacementId_v1
Version macro for nvmlVgpuPlacementId_v1_t .
- nvmlVgpuPlacementList_v1
Version macro for nvmlVgpuPlacementList_v1_t .
- nvmlVgpuPlacementList_v2
Version macro for nvmlVgpuPlacementList_v2_t .
- nvmlVgpuProcessesUtilizationInfo_v1
Version macro for nvmlVgpuProcessesUtilizationInfo_v1_t .
- nvmlVgpuRuntimeState_v1
Version macro for nvmlVgpuRuntimeState_v1_t .
- nvmlVgpuSchedulerLogInfo_v1
Version macro for nvmlVgpuSchedulerLogInfo_v1_t .
- nvmlVgpuSchedulerStateInfo_v1
Version macro for nvmlVgpuSchedulerStateInfo_v1_t .
- nvmlVgpuSchedulerState_v1
Version macro for nvmlVgpuSchedulerState_v1_t .
- nvmlVgpuTypeBar1Info_v1
Version macro for nvmlVgpuTypeBar1Info_v1_t .
- nvmlVgpuTypeIdInfo_v1
Version macro for nvmlVgpuTypeIdInfo_v1_t .
- nvmlVgpuTypeMaxInstance_v1
Version macro for nvmlVgpuTypeMaxInstance_v1_t .
Enumerations#
- nvmlDeviceGpuRecoveryAction_t
Enum describing the GPU Recovery Action.
Structs#
- nvmlActiveVgpuInstanceInfo_v1_t
Structure to store active vGPU instance information Version 1.
- nvmlGridLicensableFeature_t
Structure containing vGPU software licensable feature information.
- nvmlGridLicensableFeatures_t
Structure to store vGPU software licensable features.
- nvmlGridLicenseExpiry_t
Structure to store license expiry date and time values.
- nvmlVgpuCreatablePlacementInfo_v1_t
Structure to store creatable vGPU placement information version 1.
- nvmlVgpuHeterogeneousMode_v1_t
Structure to store the vGPU heterogeneous mode of device version 1.
- nvmlVgpuInstanceUtilizationInfo_v1_t
Structure to store Utilization Value and vgpuInstance Info Version 1.
- nvmlVgpuInstanceUtilizationSample_t
Structure to store Utilization Value and vgpuInstance.
- nvmlVgpuInstancesUtilizationInfo_v1_t
Structure to store recent utilization for vGPU instances running on a device version 1.
- nvmlVgpuLicenseExpiry_t
Structure to store the vGPU license expiry details.
- nvmlVgpuLicenseInfo_t
- nvmlVgpuPlacementId_v1_t
Structure to store the placement ID of vGPU instance version 1.
- nvmlVgpuPlacementList_v1_t
Structure to store the list of vGPU placements version 1.
- nvmlVgpuPlacementList_v2_t
Structure to store the list of vGPU placements version 2.
- nvmlVgpuProcessUtilizationInfo_v1_t
Structure to store Utilization Value, vgpuInstance and subprocess information for process running on vGPU instance version 1.
- nvmlVgpuProcessUtilizationSample_t
Structure to store Utilization Value, vgpuInstance and subprocess information.
- nvmlVgpuProcessesUtilizationInfo_v1_t
Structure to store recent utilization, vgpuInstance and subprocess information for processes running on vGPU instances active on a device version 1.
- nvmlVgpuRuntimeState_v1_t
Structure to store the information of vGPU runtime state version 1.
- nvmlVgpuSchedulerCapabilities_t
Structure to store the vGPU scheduler capabilities.
- nvmlVgpuSchedulerGetState_t
Structure to store the vGPU scheduler state.
- nvmlVgpuSchedulerLogEntry_t
Structure to store the state and logs of a software runlist.
- nvmlVgpuSchedulerLogEntry_v2_t
Structure to store the state and logs of a software runlist.
- nvmlVgpuSchedulerLogInfo_v1_t
Structure to store vGPU scheduler log information Version 1.
- nvmlVgpuSchedulerLogInfo_v2_t
Structure to store vGPU scheduler log information.
- nvmlVgpuSchedulerLog_t
Structure to store a vGPU software scheduler log.
- nvmlVgpuSchedulerSetState_t
Structure to set the vGPU scheduler state.
- nvmlVgpuSchedulerStateInfo_v1_t
Structure to store vGPU scheduler state information Version 1.
- nvmlVgpuSchedulerStateInfo_v2_t
Structure to store vGPU scheduler state information.
- nvmlVgpuSchedulerState_v1_t
Structure to set vGPU scheduler state information version 1.
- nvmlVgpuSchedulerState_v2_t
Structure to set vGPU scheduler state information.
- nvmlVgpuTypeBar1Info_v1_t
Structure to store BAR1 size information of vGPU type Version 1.
- nvmlVgpuTypeIdInfo_v1_t
Structure to store the vGPU type IDs version 1.
- nvmlVgpuTypeMaxInstance_v1_t
Structure to store the maximum number of possible vGPU type IDs version 1.
Typedefs#
- nvmlActiveVgpuInstanceInfo_t
- nvmlVgpuCreatablePlacementInfo_t
- nvmlVgpuHeterogeneousMode_t
- nvmlVgpuInstance_t
- nvmlVgpuInstancesUtilizationInfo_t
- nvmlVgpuPlacementId_t
- nvmlVgpuPlacementList_t
- nvmlVgpuProcessesUtilizationInfo_t
- nvmlVgpuRuntimeState_t
- nvmlVgpuSchedulerLogInfo_t
- nvmlVgpuSchedulerStateInfo_t
- nvmlVgpuSchedulerState_t
- nvmlVgpuTypeBar1Info_t
- nvmlVgpuTypeIdInfo_t
- nvmlVgpuTypeId_t
- nvmlVgpuTypeMaxInstance_t
Unions#
- nvmlVgpuSchedulerParams_t
Union to represent the vGPU Scheduler Parameters.
- nvmlVgpuSchedulerSetParams_t
Union to represent the vGPU Scheduler set Parameters.
Macros#
-
NVML_GRID_LICENSE_STATE_LICENSED#
Licensed state.
-
NVML_GRID_LICENSE_STATE_UNINITIALIZED#
Uninitialized state.
-
NVML_GRID_LICENSE_STATE_UNKNOWN#
vGPU license state
Unknown state
-
NVML_GRID_LICENSE_STATE_UNLICENSED#
Unlicensed state.
-
NVML_GRID_LICENSE_STATE_UNLICENSED_RESTRICTED#
Unlicensed restricted state.
-
NVML_GRID_LICENSE_STATE_UNLICENSED_UNRESTRICTED#
Unlicensed unrestricted state.
-
NVML_SCHEDULER_SW_MAX_LOG_ENTRIES#
Maximum number of scheduler log entries.
-
NVML_SUPPORTED_VGPU_SCHEDULER_POLICY_COUNT#
Number of supported vGPU scheduler policies.
-
NVML_VGPU_SCHEDULER_ARR_DEFAULT#
Default Adaptive Round Robin mode.
-
NVML_VGPU_SCHEDULER_ARR_DISABLE#
Disable Adaptive Round Robin mode.
-
NVML_VGPU_SCHEDULER_ARR_ENABLE#
Enable Adaptive Round Robin mode.
-
NVML_VGPU_SCHEDULER_ENGINE_TYPE_GRAPHICS#
vGPU scheduler engine types A GPU or GI may support a subset of engines
Graphics engine.
-
NVML_VGPU_SCHEDULER_ENGINE_TYPE_NVENC0#
NVENC0.
-
NVML_VGPU_SCHEDULER_ENGINE_TYPE_NVENC1#
NVENC1.
-
NVML_VGPU_SCHEDULER_POLICY_BEST_EFFORT#
Best effort scheduler policy.
-
NVML_VGPU_SCHEDULER_POLICY_EQUAL_SHARE#
Equal share scheduler policy.
-
NVML_VGPU_SCHEDULER_POLICY_FIXED_SHARE#
Fixed share scheduler policy.
-
NVML_VGPU_SCHEDULER_POLICY_UNKNOWN#
vGPU scheduler policies
Unknown scheduler policy.
-
nvmlActiveVgpuInstanceInfo_v1#
Version macro for nvmlActiveVgpuInstanceInfo_v1_t.
-
nvmlVgpuCreatablePlacementInfo_v1#
Version macro for nvmlVgpuCreatablePlacementInfo_v1_t.
-
nvmlVgpuHeterogeneousMode_v1#
Version macro for nvmlVgpuHeterogeneousMode_v1_t.
-
nvmlVgpuInstancesUtilizationInfo_v1#
Version macro for nvmlVgpuInstancesUtilizationInfo_v1_t.
-
nvmlVgpuPlacementId_v1#
Version macro for nvmlVgpuPlacementId_v1_t.
-
nvmlVgpuPlacementList_v1#
Version macro for nvmlVgpuPlacementList_v1_t.
-
nvmlVgpuPlacementList_v2#
Version macro for nvmlVgpuPlacementList_v2_t.
-
nvmlVgpuProcessesUtilizationInfo_v1#
Version macro for nvmlVgpuProcessesUtilizationInfo_v1_t.
-
nvmlVgpuRuntimeState_v1#
Version macro for nvmlVgpuRuntimeState_v1_t.
-
nvmlVgpuSchedulerLogInfo_v1#
Version macro for nvmlVgpuSchedulerLogInfo_v1_t.
-
nvmlVgpuSchedulerStateInfo_v1#
Version macro for nvmlVgpuSchedulerStateInfo_v1_t.
-
nvmlVgpuSchedulerState_v1#
Version macro for nvmlVgpuSchedulerState_v1_t.
-
nvmlVgpuTypeBar1Info_v1#
Version macro for nvmlVgpuTypeBar1Info_v1_t.
-
nvmlVgpuTypeIdInfo_v1#
Version macro for nvmlVgpuTypeIdInfo_v1_t.
-
nvmlVgpuTypeMaxInstance_v1#
Version macro for nvmlVgpuTypeMaxInstance_v1_t.
Enumerations#
-
enum nvmlDeviceGpuRecoveryAction_t#
Enum describing the GPU Recovery Action.
Values:
-
enumerator NVML_GPU_RECOVERY_ACTION_NONE#
No action needed.
-
enumerator NVML_GPU_RECOVERY_ACTION_GPU_RESET#
Reset Gpu.
-
enumerator NVML_GPU_RECOVERY_ACTION_NODE_REBOOT#
Reboot Node.
-
enumerator NVML_GPU_RECOVERY_ACTION_DRAIN_P2P#
Drain P2P.
-
enumerator NVML_GPU_RECOVERY_ACTION_DRAIN_AND_RESET#
Drain P2P and Reset Gpu.
-
enumerator NVML_GPU_RECOVERY_ACTION_RECOVER_IMEX_DOMAIN#
Recover IMEX Domain.
-
enumerator NVML_GPU_RECOVERY_ACTION_BUS_RESET#
Reset the GPU’s PCIe bus.
-
enumerator NVML_GPU_RECOVERY_ACTION_SYSTEM_REBOOT#
Reboot the system.
-
enumerator NVML_GPU_RECOVERY_ACTION_NONE#
Typedefs#
-
typedef nvmlActiveVgpuInstanceInfo_v1_t nvmlActiveVgpuInstanceInfo_t#
-
typedef nvmlVgpuCreatablePlacementInfo_v1_t nvmlVgpuCreatablePlacementInfo_t#
-
typedef nvmlVgpuHeterogeneousMode_v1_t nvmlVgpuHeterogeneousMode_t#
-
typedef unsigned int nvmlVgpuInstance_t#
-
typedef nvmlVgpuInstancesUtilizationInfo_v1_t nvmlVgpuInstancesUtilizationInfo_t#
-
typedef nvmlVgpuPlacementId_v1_t nvmlVgpuPlacementId_t#
-
typedef nvmlVgpuPlacementList_v2_t nvmlVgpuPlacementList_t#
-
typedef nvmlVgpuProcessesUtilizationInfo_v1_t nvmlVgpuProcessesUtilizationInfo_t#
-
typedef nvmlVgpuRuntimeState_v1_t nvmlVgpuRuntimeState_t#
-
typedef nvmlVgpuSchedulerLogInfo_v1_t nvmlVgpuSchedulerLogInfo_t#
-
typedef nvmlVgpuSchedulerStateInfo_v1_t nvmlVgpuSchedulerStateInfo_t#
-
typedef nvmlVgpuSchedulerState_v1_t nvmlVgpuSchedulerState_t#
-
typedef nvmlVgpuTypeBar1Info_v1_t nvmlVgpuTypeBar1Info_t#
-
typedef nvmlVgpuTypeIdInfo_v1_t nvmlVgpuTypeIdInfo_t#
-
typedef unsigned int nvmlVgpuTypeId_t#
-
typedef nvmlVgpuTypeMaxInstance_v1_t nvmlVgpuTypeMaxInstance_t#