CNLIOGroup.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2024 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef CNLIOGROUP_HPP_INCLUDE
#define CNLIOGROUP_HPP_INCLUDE
 
#include <functional>
#include <map>
 
#include "geopm/IOGroup.hpp"
#include "geopm_time.h"
 
namespace geopm
{
    class CNLIOGroup : public IOGroup
    {
        public:
            CNLIOGroup();
            CNLIOGroup(const std::string &pm_counters_path);
            virtual ~CNLIOGroup() = default;
            std::set<std::string> signal_names(void) const override;
            std::set<std::string> control_names(void) const override;
            bool is_valid_signal(const std::string &signal_name) const override;
            bool is_valid_control(const std::string &control_name) const override;
            int signal_domain_type(const std::string &signal_name) const override;
            int control_domain_type(const std::string &control_name) const override;
            int push_signal(const std::string &signal_name, int domain_type,
                            int domain_idx) override;
            int push_control(const std::string &control_name, int domain_type,
                             int domain_idx) override;
            void read_batch(void) override;
            void write_batch(void) override;
            double sample(int batch_idx) override;
            void adjust(int batch_idx, double setting) override;
            double read_signal(const std::string &signal_name, int domain_type,
                               int domain_idx) override;
            void write_control(const std::string &control_name, int domain_type,
                               int domain_idx, double setting) override;
            void save_control(void) override;
            void restore_control(void) override;
            std::function<double(const std::vector<double> &)>
                agg_function(const std::string &signal_name) const override;
            std::function<std::string(double)>
                format_function(const std::string &signal_name) const override;
            std::string signal_description(const std::string &signal_name) const override;
            std::string control_description(const std::string &control_name) const override;
            int signal_behavior(const std::string &signal_name) const override;
            void save_control(const std::string &save_path) override;
            void restore_control(const std::string &save_path) override;
            std::string name(void) const override;
            static std::string plugin_name(void);
            static std::unique_ptr<IOGroup> make_plugin(void);
 
        private:
            void register_signal_alias(const std::string &alias_name, const std::string &signal_name);
 
            struct m_signal_info_s {
                std::string m_description;
                std::function<double(const std::vector<double> &)> m_agg_function;
                std::function<std::string(double)> m_format_function;
                std::function<double()> m_read_function;
                bool m_do_read;
                double m_value;
                int m_units;
                int m_behavior;
            };
            std::map<std::string, m_signal_info_s> m_signal_available;
 
            double read_time(const std::string &freshness_path) const;
 
            geopm_time_s m_time_zero;
            double m_initial_freshness;
            double m_sample_rate;
    };
}
 
#endif