nvml-wrapper-sys

Rust bindings for the NVIDIA Management Library (NVML), a C-based programmatic interface for monitoring and managing various states within NVIDIA (primarily Tesla) GPUs.

It is intended to be a platform for building 3rd-party applications, and is also the underlying library for NVIDIA's nvidia-smi tool.

NVML supports the following platforms:

• Windows
  • Windows Server 2008 R2 64-bit
  • Windows Server 2012 R2 64-bit
  • Windows 7 64-bit
  • Windows 8 64-bit
  • Windows 10 64-bit
• Linux
  • 64-bit
  • 32-bit
• Hypervisors
  • Windows Server 2008R2/2012 Hyper-V 64-bit
  • Citrix XenServer 6.2 SP1+
  • VMware ESX 5.1/5.5

And the following products:

• Full Support
  • Tesla products Fermi architecture and up
  • Quadro products Fermi architecture and up
  • GRID products Kepler architecture and up
  • Select GeForce Titan products
• Limited Support
  • All GeForce products Fermi architecture and up

Compilation

The NVML library comes with the NVIDIA drivers and is essentially present on any system with a functioning NVIDIA graphics card. The compilation steps vary between Windows and Linux, however.

Windows

I have been able to successfully compile and run the tests for these bindings' wrapper using both the GNU and MSVC toolchains. An import library (nvml.lib) is included for compilation with the MSVC toolchain.

The NVML library dll can be found at %ProgramW6432%\NVIDIA Corporation\NVSMI\ (which is C:\Program Files\NVIDIA Corporation\NVSMI\ on my machine). I had to add this folder to my PATH or place a copy of the dll in the same folder as the executable in order to have everything work properly at runtime with the GNU toolchain. You may need to do the same; I'm not sure if the MSVC toolchain needs this step or not.

Linux

The NVML library can be found at /usr/lib/nvidia-<driver-version>/libnvidia-ml.so; on my system with driver version 375.51 installed, this puts the library at /usr/lib/nvidia-375/libnvidia-ml.so.

The sys crates' build script will automatically add the appropriate directory to the paths searched for the library, so you shouldn't have to do anything manually in theory.

NVML Support

These bindings were generated for NVML version 10.1. Each new version of NVML is guaranteed to be backwards-compatible according to NVIDIA, so these bindings should be useful regardless of NVML version bumps.

License

^{Licensed under either of Apache License, Version 2.0 or MIT license at your option.}

_{Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.}