1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

// Copyright 2019-2022 Clemens Lutz
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

pub use nvml_impl::*;

#[cfg(target_arch = "aarch64")]
mod nvml_impl {
    use std::fmt;

    pub struct ThrottleReasons;

    impl fmt::Display for ThrottleReasons {
        fn fmt(&self, _: &mut fmt::Formatter<'_>) -> fmt::Result {
            Ok(())
        }
    }
}

#[cfg(not(target_arch = "aarch64"))]
mod nvml_impl {
    use crate::error::{ErrorKind, Result};
    use crate::runtime::linux_wrapper::{numa_node_of_cpu, CpuSet};
    use nvml_wrapper::bitmasks::device::ThrottleReasons as NvmlTR;
    use nvml_wrapper::device::Device;
    use nvml_wrapper::enum_wrappers::device::Clock as GpuClock;
    use nvml_wrapper::error::NvmlError;
    use std::convert::From;
    use std::fmt;
    use std::mem;
    use std::os::raw::c_ulong;

    pub struct ThrottleReasons(NvmlTR);

    impl fmt::Display for ThrottleReasons {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            let possible_reasons = [
                (NvmlTR::GPU_IDLE, "GPU_Idle|"),
                (
                    NvmlTR::APPLICATIONS_CLOCKS_SETTING,
                    "Applications_Clocks_Settings|",
                ),
                (NvmlTR::SW_POWER_CAP, "SW_Power_Cap|"),
                (NvmlTR::HW_SLOWDOWN, "HW_Slowdown|"),
                (NvmlTR::SYNC_BOOST, "Sync_Boost|"),
                (NvmlTR::SW_THERMAL_SLOWDOWN, "SW_Thermal_Slowdown|"),
                (NvmlTR::HW_THERMAL_SLOWDOWN, "HW_Thermal_Slowdown|"),
                (NvmlTR::HW_POWER_BRAKE_SLOWDOWN, "HW_Power_Brake_Slowdown|"),
                (NvmlTR::DISPLAY_CLOCK_SETTING, "Display_Clock_Setting|"),
                (NvmlTR::NONE, "None|"),
            ];

            let mut reasons: String = possible_reasons
                .iter()
                .filter_map(|&(reason, reason_str)| {
                    if self.0.contains(reason) {
                        Some(reason_str)
                    } else {
                        None
                    }
                })
                .collect();
            reasons.pop();

            write!(f, "{}", reasons)
        }
    }

    impl From<NvmlTR> for ThrottleReasons {
        fn from(other: NvmlTR) -> Self {
            Self(other)
        }
    }

    /// Extra features for GPU devices with NVML
    pub trait NvmlDeviceExtra {
        /// Returns the NUMA memory affinity of the GPU device
        fn numa_mem_affinity(&self) -> Result<u16>;
    }

    impl NvmlDeviceExtra for Device<'_> {
        fn numa_mem_affinity(&self) -> Result<u16> {
            let mut cpu_set = CpuSet::new();
            let capacity = cpu_set.bytes() / mem::size_of::<c_ulong>();

            // Supporting only 64-bit systems, 32-bit will require bit-shifting
            assert_eq!(mem::size_of::<c_ulong>(), mem::size_of::<u64>());

            let cpu_affinity: Vec<_> = self
                .cpu_affinity(capacity)
                .map_err(|e| ErrorKind::RuntimeError(e.to_string()))?
                .iter()
                .map(|&ulong| ulong as u64)
                .collect();
            cpu_set
                .as_mut_slice()
                .iter_mut()
                .zip(cpu_affinity.iter())
                .for_each(|(set_item, nvml_item)| *set_item = *nvml_item);
            let first_cpu = (0..=cpu_set.max_id())
                .find(|&id| cpu_set.is_set(id))
                .ok_or_else(|| ErrorKind::RuntimeError("GPU has no CPU affinity".to_string()))?;
            let memory_affinity = numa_node_of_cpu(first_cpu)?;

            Ok(memory_affinity)
        }
    }

    pub trait DeviceClocks {
        fn set_max_gpu_clocks(&mut self) -> Result<()>;
        fn set_default_gpu_clocks(&mut self) -> Result<()>;
    }

    impl DeviceClocks for Device<'_> {
        fn set_max_gpu_clocks(&mut self) -> Result<()> {
            let max_graphics_mhz = self
                .max_clock_info(GpuClock::Graphics)
                .map_err(|e| ErrorKind::RuntimeError(e.to_string()))?;
            let max_memory_mhz = self
                .max_clock_info(GpuClock::Memory)
                .map_err(|e| ErrorKind::RuntimeError(e.to_string()))?;

            if let Err(error) = self.set_applications_clocks(max_memory_mhz, max_graphics_mhz) {
                match error {
                    NvmlError::NotSupported => eprintln!(
                        "WARNING: Your GPU doesn't support setting the clock \
                        rate. Measurements may be inaccurate."
                    ),
                    NvmlError::NoPermission => {
                        return Err(ErrorKind::RuntimeError(
                            "Failed to set GPU clock rate. Setting changes \
                            might be restricted to root. Try running: sudo \
                            nvidia-smi --persistence-mode=ENABLED; sudo \
                            nvidia-smi \
                            --applications-clocks-permission=UNRESTRICTED"
                                .to_string(),
                        )
                        .into())
                    }
                    _ => return Err(ErrorKind::RuntimeError(error.to_string()).into()),
                }
            }

            Ok(())
        }

        fn set_default_gpu_clocks(&mut self) -> Result<()> {
            if let Err(error) = self.reset_applications_clocks() {
                match error {
                    NvmlError::NotSupported => { /* ignore */ }
                    NvmlError::NoPermission => { /* ignore */ }
                    _ => return Err(ErrorKind::RuntimeError(error.to_string()).into()),
                }
            }

            Ok(())
        }
    }
}