FrequencyMapAgent.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2025 Intel Corporation
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef FREQUENCYMAPAGENT_HPP_INCLUDE
#define FREQUENCYMAPAGENT_HPP_INCLUDE
 
#include <vector>
#include <map>
#include <string>
#include <memory>
#include <functional>
#include <set>
 
#include "geopm/Agent.hpp"
 
namespace geopm
{
    class PlatformIO;
    class PlatformTopo;
    class Waiter;
 
    class FrequencyMapAgent : public Agent
    {
        public:
            FrequencyMapAgent();
            FrequencyMapAgent(PlatformIO &plat_io, const PlatformTopo &topo,
                              std::shared_ptr<Waiter> waiter);
            FrequencyMapAgent(PlatformIO &plat_io, const PlatformTopo &topo,
                              std::shared_ptr<Waiter> waiter,
                              const std::map<uint64_t, double>& hash_freq_map,
                              const std::set<uint64_t>& default_freq_hash);
            virtual ~FrequencyMapAgent() = default;
            void init(int level, const std::vector<int> &fan_in, bool is_level_root) override;
            void validate_policy(std::vector<double> &policy) const override;
            void split_policy(const std::vector<double> &in_policy,
                              std::vector<std::vector<double> > &out_policy) override;
            bool do_send_policy(void) const override;
            void aggregate_sample(const std::vector<std::vector<double> > &in_sample,
                                  std::vector<double> &out_sample) override;
            bool do_send_sample(void) const override;
            void adjust_platform(const std::vector<double> &in_policy) override;
            bool do_write_batch(void) const override;
            void sample_platform(std::vector<double> &out_sample) override;
            void wait(void) override;
            std::vector<std::pair<std::string, std::string> > report_header(void) const override;
            std::vector<std::pair<std::string, std::string> > report_host(void) const override;
            std::map<uint64_t, std::vector<std::pair<std::string, std::string> > > report_region(void) const override;
            std::vector<std::string> trace_names(void) const override;
            std::vector<std::function<std::string(double)> > trace_formats(void) const override;
            void trace_values(std::vector<double> &values) override;
            void enforce_policy(const std::vector<double> &policy) const override;
 
            static std::string plugin_name(void);
            static std::unique_ptr<Agent> make_plugin(void);
            static std::vector<std::string> policy_names(void);
            static std::vector<std::string> sample_names(void);
 
        private:
            void update_policy(const std::vector<double> &policy);
            void init_platform_io(void);
 
            enum m_policy_e {
                M_POLICY_FREQ_CPU_DEFAULT,
                M_POLICY_FREQ_CPU_UNCORE,
                M_POLICY_FREQ_GPU_DEFAULT,
                M_POLICY_FIRST_HASH,
                M_POLICY_FIRST_FREQUENCY,
                // The remainder of policy values can be additional pairs of
                // (hash, frequency)
                M_NUM_POLICY = 65,
            };
 
            static constexpr double M_WAIT_SEC = 0.002;
            PlatformIO &m_platform_io;
            const PlatformTopo &m_platform_topo;
            std::vector<int> m_hash_signal_idx;
            std::vector<int> m_freq_control_idx;
            int m_gpu_min_control_idx;
            int m_gpu_max_control_idx;
            int m_uncore_min_ctl_idx;
            int m_uncore_max_ctl_idx;
            std::vector<uint64_t> m_last_hash;
            std::vector<double> m_last_freq;
            double m_last_uncore_freq;
            double m_last_gpu_freq;
            int m_num_children;
            bool m_is_policy_updated;
            bool m_do_write_batch;
            bool m_is_adjust_initialized;
            bool m_is_real_policy;
            int m_freq_ctl_domain_type;
            int m_num_freq_ctl_domain;
            bool m_do_gpu_ctl;
            double m_core_freq_min;
            double m_core_freq_max;
            double m_uncore_init_min;
            double m_uncore_init_max;
            double m_gpu_init_freq_min;
            double m_gpu_init_freq_max;
            double m_default_freq;
            double m_uncore_freq;
            double m_default_gpu_freq;
            std::map<uint64_t, double> m_hash_freq_map;
            std::set<uint64_t> m_default_freq_hash;
            std::shared_ptr<Waiter> m_waiter;
    };
}
 
#endif