NAME

nvidia2::ml - Perl bindings to NVML, the NVIDIA Management Library

SYNOPSIS

   use nvidia2::ml qw(:all);

   nvmlInit();

   ($ret, $version) = nvmlSystemGetDriverVersion();
   die nvmlErrorString($ret) unless $ret == $nvidia2::ml::bindings::NVML_SUCCESS;
   print "Driver version: " . $version . "\n";

   ($ret, $count) = nvmlDeviceGetCount();
   die nvmlErrorString($ret) unless $ret == $nvidia2::ml::bindings::NVML_SUCCESS;

   for ($i=0; $i<$count; $i++)
   {
       ($ret, $handle) = nvmlDeviceGetHandleByIndex($i);
       next if $ret != $nvidia2::ml::bindings::NVML_SUCCESS;
    
       ($ret, $speed) = nvmlDeviceGetFanSpeed($handle);
       next if $ret != $nvidia2::ml::bindings::NVML_SUCCESS;
       print "Device " . $i . " fan speed: " . $speed . "%\n";
    
       ($ret, $info) = nvmlDeviceGetMemoryInfo($handle);
       next if $ret != $nvidia2::ml::bindings::NVML_SUCCESS;
       $total = ($info->{"total"} / 1024 / 1024);
       print "Device " . $i . " total memory: " . $total . " MB\n";
   }

   nvmlShutdown();

   # there is a higher-level module which does some standard enquiries for you
   # and returns results back as a hashref and for each GPU found
   use nvidia2::ml::Utils;
   use Data::Dumper;

   my $enquiry_result = nvidia2::ml::Utils::enquire_gpu_hardware();
   print Dumper($enquiry_result);

DESCRIPTION

Provides a Perl interface to GPU management and monitoring functions.

This is a wrapper around the NVML library. For information about the NVML library, see the NVML documentation.

UPDATE

UPDATE 30 Jul 2021: as per https://docs.nvidia.com/deploy/nvml-api/change-log.html Perl bindings support on behalf of NVIDIA has been discontinued. This is cited as a change between versions v346 and v349 in the linked document. The original module nvidia::ml at CPAN has last been updated in 2013. It does not work for (at least) Perl version 5.32 because the SWIG-made code in provided nvml_wrap.c does not compile, it complains about bool undefined. The current module nvidia2::ml was created in order to fix that problem and also bring the Perl Bindings up to date with latest nvidia-ml library, which is provided by the NVIDIA CUDA Toolkit at https://developer.nvidia.com/cuda-downloads. The current nvidia2::ml is a copy-paste of nvidia::ml with the addition of more bindings and the fixing of nvml_wrap.c in order to compile and be compatible with newer Perl versions. I do not own the copyright to nvidia::ml and I hereby declare that nvidia2::ml uses all code from nvidia::ml which is owned and created by NVIDIA. If that is an infringmenet of Copyright on my (Andreas Hadjiprocopis) behalf then please let me know as soon as possible at bliako at cpan dot org.

REQUIRES

Exporter

EXPORTS

This module has no exports. To add functions and constants to your namespace use: use nvidia2::ml qw(:all);

METHODS

See EXPORTS and NVML documentation. Perl methods wrap NVML functions, implemented in a C shared library. The functions use is the same with the following exceptions:

• Perl methods accept the input arguments of the C function it wraps only. All C function output parameters are returned after the return code, left to right

    C:
    nvmlReturn_t nvmlDeviceGetEccMode(nvmlDevice_t device,
                                      nvmlEnableState_t *current,
                                      nvmlEnableState_t *pending);
    Perl:
    ($ret, $current, $pending) = nvmlDeviceGetEccMode($device); 
  

• Perl handles string buffer creation

    C:
    nvmlReturn_t nvmlSystemGetDriverVersion(char* version,
                                            unsigned int length);
    Perl:
    ($ret, $version) = nvmlSystemGetDriverVersion();
  

• C structs are converted to Perl hashes, nested as needed

    C:
    nvmlReturn_t DECLDIR nvmlDeviceGetMemoryInfo(nvmlDevice_t device,
                                                 nvmlMemory_t *memory);
    typedef struct nvmlMemory_st {
        unsigned long long total;
        unsigned long long free;
        unsigned long long used;
    } nvmlMemory_t;
    Perl:
    ($ret, $memory) = nvmlDeviceGetMemoryInfo($device);
    print "Total memory " . $memory->{"total"} . "\n";
    print "Used memory " . $memory->{"used"} . "\n";
    print "Free memory " . $memory->{"free"} . "\n";
  

VARIABLES

See EXPORTS and NVML documentation. All NVML constants and enums are exposed.

COPYRIGHT

Copyright (c) 2011-2012, NVIDIA Corporation. All rights reserved.

LICENSE

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the NVIDIA Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.