PlatformIO.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2024 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef PLATFORMIO_HPP_INCLUDE
#define PLATFORMIO_HPP_INCLUDE
 
#include <climits>
#include <functional>
#include <memory>
#include <set>
#include <string>
#include <vector>
 
#include "geopm_pio.h"
#include "geopm_public.h"
 
struct GEOPM_PUBLIC geopm_request_s {
    int domain_type;
    int domain_idx;
    char name[NAME_MAX];
};
 
namespace geopm
{
    class IOGroup;
    class ProfileIOGroup;
 
    class GEOPM_PUBLIC PlatformIO
    {
        public:
            PlatformIO() = default;
            virtual ~PlatformIO() = default;
            virtual void register_iogroup(std::shared_ptr<IOGroup> iogroup) = 0;
            virtual std::set<std::string> signal_names(void) const = 0;
            virtual std::set<std::string> control_names(void) const = 0;
            virtual int signal_domain_type(const std::string &signal_name) const = 0;
            virtual int control_domain_type(const std::string &control_name) const = 0;
            virtual int push_signal(const std::string &signal_name,
                                    int domain_type,
                                    int domain_idx) = 0;
            virtual int push_control(const std::string &control_name,
                                     int domain_type,
                                     int domain_idx) = 0;
            virtual double sample(int signal_idx) = 0;
            virtual void adjust(int control_idx,
                                double setting) = 0;
            virtual void read_batch(void) = 0;
            virtual void write_batch(void) = 0;
            virtual double read_signal(const std::string &signal_name,
                                       int domain_type,
                                       int domain_idx) = 0;
            virtual void write_control(const std::string &control_name,
                                       int domain_type,
                                       int domain_idx,
                                       double setting) = 0;
            virtual void save_control(void) = 0;
            virtual void restore_control(void) = 0;
            virtual std::function<double(const std::vector<double> &)> agg_function(const std::string &signal_name) const = 0;
            virtual std::function<std::string(double)> format_function(const std::string &signal_name) const = 0;
            virtual std::string signal_description(const std::string &signal_name) const = 0;
            virtual std::string control_description(const std::string &control_name) const = 0;
            virtual int signal_behavior(const std::string &signal_name) const = 0;
            virtual void save_control(const std::string &save_dir) = 0;
            virtual void restore_control(const std::string &save_dir) = 0;
            virtual void start_batch_server(int client_pid,
                                            const std::vector<geopm_request_s> &signal_config,
                                            const std::vector<geopm_request_s> &control_config,
                                            int &server_pid,
                                            std::string &server_key) = 0;
            virtual void stop_batch_server(int server_pid) = 0;
 
            static bool is_valid_value(double value);
    };
 
    PlatformIO GEOPM_PUBLIC &
        platform_io(void);
}
 
#endif