DCGMDevicePool.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2024 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef DCGMDEVICEPOOL_HPP_INCLUDE
#define DCGMDEVICEPOOL_HPP_INCLUDE
 
namespace geopm
{
    class DCGMDevicePool
    {
        public:
            enum m_field_id_e {
                M_FIELD_ID_SM_ACTIVE,
                M_FIELD_ID_SM_OCCUPANCY,
                M_FIELD_ID_DRAM_ACTIVE,
                M_NUM_FIELD_ID
            };
 
            DCGMDevicePool() = default;
            virtual ~DCGMDevicePool() = default;
 
            virtual int num_device() const = 0;
            virtual double sample(int gpu_idx, int field_id) const = 0;
 
            virtual void update(int gpu_idx) = 0;
            //         at which the DCGM engine will poll for metrics
            virtual void update_rate(int field_update_rate) = 0;
            virtual void max_storage_time(int max_storage_time) = 0;
            virtual void max_samples(int max_samples) = 0;
 
            //         This function may be called repeatedly with updated polling
            //         rate or storage settings.
            virtual void polling_enable(void) = 0;
 
            virtual void polling_disable(void) = 0;
    };
 
    DCGMDevicePool &dcgm_device_pool();
}
#endif