Add fan control functions (#77)

Adds several fan control functions from NVML.

Author: ilya-zlobintsev

nvml-wrapper/src/device.rs

@@ -11,11 +11,10 @@ use crate::bitmasks::Behavior;
 
 use crate::enum_wrappers::{bool_from_state, device::*, state_from_bool};
 
-use crate::enums::device::BusType;
-use crate::enums::device::DeviceArchitecture;
-use crate::enums::device::GpuLockedClocksSetting;
-use crate::enums::device::PcieLinkMaxSpeed;
-use crate::enums::device::PowerSource;
+use crate::enums::device::{
+    BusType, DeviceArchitecture, FanControlPolicy, GpuLockedClocksSetting, PcieLinkMaxSpeed,
+    PowerSource,
+};
 #[cfg(target_os = "linux")]
 use crate::error::NvmlErrorWithSource;
 use crate::error::{nvml_sym, nvml_try, Bits, NvmlError};
@@ -1541,6 +1540,89 @@ impl<'nvml> Device<'nvml> {
         }
     }
 
+    /**
+    Gets current fan control policy.
+
+    You can determine valid fan indices using [`Self::num_fans()`].
+
+    # Errors
+
+    * `Uninitialized`, if the library has not been successfully initialized
+    * `InvalidArg`, if this `Device` is invalid or `fan_idx` is invalid
+    * `NotSupported`, if this `Device` does not have a fan
+    * `GpuLost`, if this `Device` has fallen off the bus or is otherwise inaccessible
+    * `UnexpectedVariant`, for which you can read the docs for
+    * `Unknown`, on any unexpected error
+
+    # Device Support
+
+    Supports Maxwell or newer fully supported discrete devices with fans.
+     */
+    #[doc(alias = "nvmlGetFanControlPolicy_v2")]
+    pub fn fan_control_policy(&self, fan_idx: u32) -> Result<FanControlPolicy, NvmlError> {
+        let sym = nvml_sym(self.nvml.lib.nvmlDeviceGetFanControlPolicy_v2.as_ref())?;
+
+        unsafe {
+            let mut policy: nvmlFanControlPolicy_t = mem::zeroed();
+            nvml_try(sym(self.device, fan_idx, &mut policy))?;
+
+            FanControlPolicy::try_from(policy)
+        }
+    }
+
+    /**
+    Sets the speed of a specified fan.
+
+    WARNING: This function changes the fan control policy to manual. It means that YOU have to monitor the temperature and adjust the fan speed accordingly.
+    If you set the fan speed too low you can burn your GPU! Use [`Device::set_default_fan_speed`] to restore default control policy.
+
+    You can determine valid fan indices using [`Self::num_fans()`].
+
+    # Errors
+
+    * `Uninitialized`, if the library has not been successfully initialized
+    * `InvalidArg`, if this `Device` is invalid or `fan_idx` is invalid
+    * `NotSupported`, if this `Device` does not have a fan
+    * `GpuLost`, if this `Device` has fallen off the bus or is otherwise inaccessible
+    * `UnexpectedVariant`, for which you can read the docs for
+    * `Unknown`, on any unexpected error
+
+    # Device Support
+
+    Supports Maxwell or newer fully supported discrete devices with fans.
+     */
+    #[doc(alias = "nvmlDeviceSetFanSpeed_v2")]
+    pub fn set_fan_speed(&mut self, fan_idx: u32, speed: u32) -> Result<(), NvmlError> {
+        let sym = nvml_sym(self.nvml.lib.nvmlDeviceSetFanSpeed_v2.as_ref())?;
+
+        unsafe { nvml_try(sym(self.device, fan_idx, speed)) }
+    }
+
+    /**
+    Sets the the fan control policy to default.
+
+    You can determine valid fan indices using [`Self::num_fans()`].
+
+    # Errors
+
+    * `Uninitialized`, if the library has not been successfully initialized
+    * `InvalidArg`, if this `Device` is invalid or `fan_idx` is invalid
+    * `NotSupported`, if this `Device` does not have a fan
+    * `GpuLost`, if this `Device` has fallen off the bus or is otherwise inaccessible
+    * `UnexpectedVariant`, for which you can read the docs for
+    * `Unknown`, on any unexpected error
+
+    # Device Support
+
+    Supports Maxwell or newer fully supported discrete devices with fans.
+     */
+    #[doc(alias = "nvmlDeviceSetDefaultFanSpeed_v2")]
+    pub fn set_default_fan_speed(&mut self, fan_idx: u32) -> Result<(), NvmlError> {
+        let sym = nvml_sym(self.nvml.lib.nvmlDeviceSetDefaultFanSpeed_v2.as_ref())?;
+
+        unsafe { nvml_try(sym(self.device, fan_idx)) }
+    }
+
     /**
     Gets the number of fans on this [`Device`].
 

nvml-wrapper/src/enums/device.rs

@@ -350,3 +350,34 @@ impl TryFrom<c_uint> for PcieLinkMaxSpeed {
         }
     }
 }
+
+#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[repr(u32)]
+pub enum FanControlPolicy {
+    TemperatureContinousSw = NVML_FAN_POLICY_TEMPERATURE_CONTINOUS_SW,
+    Manual = NVML_FAN_POLICY_MANUAL,
+}
+
+/// Returned by [`crate::Device::get_fan_control_policy()`].
+///
+/// Policy used for fan control.
+// TODO: technically this is an "enum wrapper" but the type on the C side isn't
+// an enum
+impl FanControlPolicy {
+    pub fn as_c(&self) -> nvmlFanControlPolicy_t {
+        *self as u32
+    }
+}
+
+impl TryFrom<nvmlFanControlPolicy_t> for FanControlPolicy {
+    type Error = NvmlError;
+
+    fn try_from(value: nvmlFanControlPolicy_t) -> Result<Self, Self::Error> {
+        match value {
+            NVML_FAN_POLICY_TEMPERATURE_CONTINOUS_SW => Ok(Self::TemperatureContinousSw),
+            NVML_FAN_POLICY_MANUAL => Ok(Self::TemperatureContinousSw),
+            _ => Err(NvmlError::UnexpectedVariant(value)),
+        }
+    }
+}

nvml-wrapper/unwrapped_functions.txt

@@ -5,28 +5,22 @@ nvmlComputeInstanceGetInfo_v2
 nvmlDeviceClearFieldValues
 nvmlDeviceCreateGpuInstance
 nvmlDeviceCreateGpuInstanceWithPlacement
-nvmlDeviceFreezeNvLinkUtilizationCounter
 nvmlDeviceGetActiveVgpus
 nvmlDeviceGetAdaptiveClockInfoStatus
 nvmlDeviceGetAttributes
 nvmlDeviceGetAttributes_v2
 nvmlDeviceGetClkMonStatus
 nvmlDeviceGetComputeInstanceId
-nvmlDeviceGetComputeRunningProcesses
-nvmlDeviceGetComputeRunningProcesses_v2
-nvmlDeviceGetComputeRunningProcesses_v3
 nvmlDeviceGetConfComputeGpuAttestationReport
 nvmlDeviceGetConfComputeGpuCertificate
 nvmlDeviceGetConfComputeMemSizeInfo
 nvmlDeviceGetConfComputeProtectedMemoryUsage
 nvmlDeviceGetCpuAffinityWithinScope
 nvmlDeviceGetCreatableVgpus
 nvmlDeviceGetCurrentClocksEventReasons
-nvmlDeviceGetCurrentClocksThrottleReasons
 nvmlDeviceGetDefaultEccMode
 nvmlDeviceGetDeviceHandleFromMigDeviceHandle
 nvmlDeviceGetDynamicPstatesInfo
-nvmlDeviceGetFanControlPolicy_v2
 nvmlDeviceGetGpcClkMinMaxVfOffset
 nvmlDeviceGetGpcClkVfOffset
 nvmlDeviceGetGpuFabricInfo
@@ -39,21 +33,14 @@ nvmlDeviceGetGpuInstanceProfileInfoV
 nvmlDeviceGetGpuInstanceRemainingCapacity
 nvmlDeviceGetGpuInstances
 nvmlDeviceGetGpuMaxPcieLinkGeneration
-nvmlDeviceGetGraphicsRunningProcesses
-nvmlDeviceGetGraphicsRunningProcesses_v2
-nvmlDeviceGetGraphicsRunningProcesses_v3
 nvmlDeviceGetGridLicensableFeatures
 nvmlDeviceGetGridLicensableFeatures_v2
 nvmlDeviceGetGridLicensableFeatures_v3
 nvmlDeviceGetGridLicensableFeatures_v4
 nvmlDeviceGetGspFirmwareMode
 nvmlDeviceGetGspFirmwareVersion
 nvmlDeviceGetHostVgpuMode
-nvmlDeviceGetInforomConfigurationChecksum
 nvmlDeviceGetJpgUtilization
-nvmlDeviceGetMPSComputeRunningProcesses
-nvmlDeviceGetMPSComputeRunningProcesses_v2
-nvmlDeviceGetMPSComputeRunningProcesses_v3
 nvmlDeviceGetMaxMigDeviceCount
 nvmlDeviceGetMemClkMinMaxVfOffset
 nvmlDeviceGetMemClkVfOffset
@@ -63,23 +50,16 @@ nvmlDeviceGetMigMode
 nvmlDeviceGetMinMaxClockOfPState
 nvmlDeviceGetMinMaxFanSpeed
 nvmlDeviceGetModuleId
-nvmlDeviceGetNvLinkCapability
-nvmlDeviceGetNvLinkErrorCounter
+nvmlDeviceGetMPSComputeRunningProcesses
+nvmlDeviceGetMPSComputeRunningProcesses_v2
+nvmlDeviceGetMPSComputeRunningProcesses_v3
 nvmlDeviceGetNvLinkRemoteDeviceType
-nvmlDeviceGetNvLinkRemotePciInfo
-nvmlDeviceGetNvLinkRemotePciInfo_v2
-nvmlDeviceGetNvLinkUtilizationControl
-nvmlDeviceGetNvLinkUtilizationCounter
 nvmlDeviceGetOfaUtilization
 nvmlDeviceGetPgpuMetadataString
-nvmlDeviceGetPowerManagementDefaultLimit
-nvmlDeviceGetPowerManagementLimitConstraints
 nvmlDeviceGetRemappedRows
-nvmlDeviceGetRetiredPagesPendingStatus
 nvmlDeviceGetRowRemapperHistogram
 nvmlDeviceGetRunningProcessDetailList
 nvmlDeviceGetSupportedClocksEventReasons
-nvmlDeviceGetSupportedClocksThrottleReasons
 nvmlDeviceGetSupportedPerformanceStates
 nvmlDeviceGetSupportedVgpus
 nvmlDeviceGetTargetFanSpeed
@@ -93,18 +73,12 @@ nvmlDeviceGetVgpuSchedulerState
 nvmlDeviceGetVgpuUtilization
 nvmlDeviceGetVirtualizationMode
 nvmlDeviceIsMigDeviceHandle
-nvmlDeviceResetNvLinkErrorCounters
-nvmlDeviceResetNvLinkUtilizationCounter
 nvmlDeviceSetConfComputeUnprotectedMemSize
-nvmlDeviceSetDefaultAutoBoostedClocksEnabled
-nvmlDeviceSetDefaultFanSpeed_v2
 nvmlDeviceSetFanControlPolicy
-nvmlDeviceSetFanSpeed_v2
 nvmlDeviceSetGpcClkVfOffset
 nvmlDeviceSetMemClkVfOffset
 nvmlDeviceSetMigMode
 nvmlDeviceSetNvLinkDeviceLowPowerThreshold
-nvmlDeviceSetNvLinkUtilizationControl
 nvmlDeviceSetTemperatureThreshold
 nvmlDeviceSetVgpuSchedulerState
 nvmlDeviceSetVirtualizationMode
@@ -164,8 +138,8 @@ nvmlVgpuInstanceSetEncoderCapacity
 nvmlVgpuTypeGetCapabilities
 nvmlVgpuTypeGetClass
 nvmlVgpuTypeGetDeviceID
-nvmlVgpuTypeGetFrameRateLimit
 nvmlVgpuTypeGetFramebufferSize
+nvmlVgpuTypeGetFrameRateLimit
 nvmlVgpuTypeGetGpuInstanceProfileId
 nvmlVgpuTypeGetLicense
 nvmlVgpuTypeGetMaxInstances
@@ -181,11 +155,14 @@ this means some version is already wrapped and the listed names are either
 newer versions to be wrapped or older versions that could be wrapped behind the
 legacy-functions feature.
 
+nvmlDeviceGetComputeRunningProcesses
 nvmlDeviceGetCount
 nvmlDeviceGetFanSpeed
+nvmlDeviceGetGraphicsRunningProcesses
 nvmlDeviceGetHandleByIndex
 nvmlDeviceGetHandleByPciBusId
 nvmlDeviceGetMemoryInfo_v2
+nvmlDeviceGetNvLinkRemotePciInfo
 nvmlDeviceGetPciInfo
 nvmlDeviceGetPciInfo_v2
 nvmlDeviceRemoveGpu