#include <FrequencyMapAgent.hpp>

Inheritance diagram for geopm::FrequencyMapAgent:

Collaboration diagram for geopm::FrequencyMapAgent:

Public Member Functions
	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
	Set the level where this Agent is active and push signals/controls for that level. More...

void	validate_policy (std::vector< double > &policy) const override
	Called by Controller to validate incoming policy values and configure defaults requested in incoming policy. Policy sender can request default value with 'NaN' at the desired offset in the policy vector. Returned policy should not contain 'NaN's and be consumeable by descend and adjust_platform. More...

void	split_policy (const std::vector< double > &in_policy, std::vector< std::vector< double > > &out_policy) override
	Called by Controller to split policy for children at next level down the tree. More...

bool	do_send_policy (void) const override
	Called by Controller to determine if new policy values should be sent down the tree to the Agent's children. More...

void	aggregate_sample (const std::vector< std::vector< double > > &in_sample, std::vector< double > &out_sample) override
	Aggregate samples from children for the next level up the tree. More...

bool	do_send_sample (void) const override

void	adjust_platform (const std::vector< double > &in_policy) override
	Adjust the platform settings based the policy from above. More...

bool	do_write_batch (void) const override
	Called by the Controller to decide whether to call write_batch() to update platform controls. More...

void	sample_platform (std::vector< double > &out_sample) override
	Read signals from the platform and interpret/aggregate these signals to create a sample which can be sent up the tree. More...

void	wait (void) override
	Called by Controller to wait for sample period to elapse. This controls the cadence of the Controller main loop. More...

std::vector< std::pair< std::string, std::string > >	report_header (void) const override
	Custom fields that will be added to the report header when this agent is used. More...

std::vector< std::pair< std::string, std::string > >	report_host (void) const override
	Custom fields for the host section of the report. More...

std::map< uint64_t, std::vector< std::pair< std::string, std::string > > >	report_region (void) const override
	Custom fields for each region in the report. More...

std::vector< std::string >	trace_names (void) const override
	Column headers to be added to the trace. More...

std::vector< std::function< std::string(double)> >	trace_formats (void) const override
	Returns format string for each column added to the trace. More...

void	trace_values (std::vector< double > &values) override
	Called by Controller to get latest values to be added to the trace. More...

void	enforce_policy (const std::vector< double > &policy) const override
	Enforce the policy one time with PlatformIO::write_control(). Called to enforce static policies in the absence of a Controller. More...

Public Member Functions inherited from geopm::Agent
	Agent ()=default

virtual	~Agent ()=default

Static Public Member Functions
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)

Static Public Member Functions inherited from geopm::Agent
static std::vector< std::string >	agent_names (void)

static std::unique_ptr< Agent >	make_unique (const std::string &agent_name)

static int	num_policy (const std::map< std::string, std::string > &dictionary)
	Used to look up the number of values in the policy vector sent down the tree for a specific Agent. This should be called with the dictionary returned by agent_factory().dictionary(agent_name) for the Agent of interest. More...

static int	num_policy (const std::string &agent_name)
	Used to look up the number of values in the policy vector sent down the tree for a specific Agent. More...

static int	num_sample (const std::map< std::string, std::string > &dictionary)
	Used to look up the number of values in the sample vector sent up the tree for a specific Agent. This should be called with the dictionary returned by agent_factory().dictionary(agent_name) for the Agent of interest. More...

static int	num_sample (const std::string &agent_name)
	Used to look up the number of values in the sample vector sent up the tree for a specific Agent. More...

static std::vector< std::string >	policy_names (const std::map< std::string, std::string > &dictionary)
	Used to look up the names of values in the policy vector sent down the tree for a specific Agent. This should be called with the dictionary returned by agent_factory().dictionary(agent_name) for the Agent of interest. More...

static std::vector< std::string >	policy_names (const std::string &agent_name)
	Used to look up the names of values in the policy vector sent down the tree for a specific Agent. More...

static std::vector< std::string >	sample_names (const std::map< std::string, std::string > &dictionary)
	Used to look up the names of values in the sample vector sent up the tree for a specific Agent. This should be called with the dictionary returned by agent_factory().dictionary(agent_name) for the Agent of interest. More...

static std::vector< std::string >	sample_names (const std::string &agent_name)
	Used to look up the names of values in the sample vector sent up the tree for a specific Agent. More...

static std::map< std::string, std::string >	make_dictionary (const std::vector< std::string > &policy_names, const std::vector< std::string > &sample_names)
	Used to create a correctly-formatted dictionary for an Agent at the time the Agent is registered with the factory. Concrete Agent classes may provide policy_names() and sample_names() methods to provide the vectors to be passed to this method. More...

static void	aggregate_sample (const std::vector< std::vector< double > > &in_sample, const std::vector< std::function< double(const std::vector< double > &)> > &agg_func, std::vector< double > &out_sample)
	Generically aggregate a vector of samples given a vector of aggregation functions. This helper method applies a different aggregation function to each sample element while aggregating across child samples. More...

Additional Inherited Members
Static Public Attributes inherited from geopm::Agent
static const std::string	M_PLUGIN_PREFIX = "libgeopmagent_"

Constructor & Destructor Documentation

◆ FrequencyMapAgent() [1/3]

geopm::FrequencyMapAgent::FrequencyMapAgent ( )

◆ FrequencyMapAgent() [2/3]

geopm::FrequencyMapAgent::FrequencyMapAgent	(	PlatformIO &	plat_io,
		const PlatformTopo &	topo,
		std::shared_ptr< Waiter >	waiter
	)

◆ FrequencyMapAgent() [3/3]

geopm::FrequencyMapAgent::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
	)

◆ ~FrequencyMapAgent()

virtual geopm::FrequencyMapAgent::~FrequencyMapAgent ( )

virtualdefault

Member Function Documentation

◆ adjust_platform()

void geopm::FrequencyMapAgent::adjust_platform ( const std::vector< double > & in_policy )

overridevirtual

Adjust the platform settings based the policy from above.

Parameters

[in] policy Settings for each control in the policy.

Implements geopm::Agent.

◆ aggregate_sample()

void geopm::FrequencyMapAgent::aggregate_sample	(	const std::vector< std::vector< double > > &	in_sample,
		std::vector< double > &	out_sample
	)

overridevirtual

Aggregate samples from children for the next level up the tree.

Parameters

[in]	in_sample	Vector of sample vectors, one from each child.
[out]	out_sample	Aggregated sample values to be sent up to the parent.

Implements geopm::Agent.

◆ do_send_policy()

bool geopm::FrequencyMapAgent::do_send_policy ( void ) const

overridevirtual

Called by Controller to determine if new policy values should be sent down the tree to the Agent's children.

Returns: True if the policy has been updated since last call.

Implements geopm::Agent.

◆ do_send_sample()

bool geopm::FrequencyMapAgent::do_send_sample ( void ) const

overridevirtual

Returns: True if new samples were read since last call.

Implements geopm::Agent.

◆ do_write_batch()

bool geopm::FrequencyMapAgent::do_write_batch ( void ) const

overridevirtual

Called by the Controller to decide whether to call write_batch() to update platform controls.

Returns: True if platform was adjusted, false otherwise.

Implements geopm::Agent.

◆ enforce_policy()

void geopm::FrequencyMapAgent::enforce_policy ( const std::vector< double > & policy ) const

overridevirtual

Enforce the policy one time with PlatformIO::write_control(). Called to enforce static policies in the absence of a Controller.

Implements geopm::Agent.

◆ init()

void geopm::FrequencyMapAgent::init	(	int	level,
		const std::vector< int > &	fan_in,
		bool	is_level_root
	)

overridevirtual

Set the level where this Agent is active and push signals/controls for that level.

Parameters

[in]	level	Level of the tree where this agent is active. Note that only agents at level zero execute sample_platform() and adjust_platform().
[in]	fan_in	Vector over level giving the the number of Agents that report to each root Agent operating at the level.
[in]	is_level_root	True if the agent plays the role of root of the level. Only root agents for a level execute ascend() and descend().

Implements geopm::Agent.

◆ make_plugin()

std::unique_ptr< Agent > geopm::FrequencyMapAgent::make_plugin ( void )

static

◆ plugin_name()

std::string geopm::FrequencyMapAgent::plugin_name ( void )

static

◆ policy_names()

std::vector< std::string > geopm::FrequencyMapAgent::policy_names ( void )

static

◆ report_header()

std::vector< std::pair< std::string, std::string > > geopm::FrequencyMapAgent::report_header ( void ) const

overridevirtual

Custom fields that will be added to the report header when this agent is used.

Implements geopm::Agent.

◆ report_host()

std::vector< std::pair< std::string, std::string > > geopm::FrequencyMapAgent::report_host ( void ) const

overridevirtual

Custom fields for the host section of the report.

Implements geopm::Agent.

◆ report_region()

std::map< uint64_t, std::vector< std::pair< std::string, std::string > > > geopm::FrequencyMapAgent::report_region ( void ) const

overridevirtual

Custom fields for each region in the report.

Implements geopm::Agent.

◆ sample_names()

std::vector< std::string > geopm::FrequencyMapAgent::sample_names ( void )

static

◆ sample_platform()

void geopm::FrequencyMapAgent::sample_platform ( std::vector< double > & out_sample )

overridevirtual

Read signals from the platform and interpret/aggregate these signals to create a sample which can be sent up the tree.

Parameters

[out] sample Vector of agent specific sample values to be sent up the tree.

Implements geopm::Agent.

◆ split_policy()

void geopm::FrequencyMapAgent::split_policy	(	const std::vector< double > &	in_policy,
		std::vector< std::vector< double > > &	out_policy
	)

overridevirtual

Called by Controller to split policy for children at next level down the tree.

Parameters

[in]	in_policy	Policy values from the parent.
[out]	out_policy	Vector of policies to be sent to each child.

Implements geopm::Agent.

◆ trace_formats()

std::vector< std::function< std::string(double)> > geopm::FrequencyMapAgent::trace_formats ( void ) const

overridevirtual

Returns format string for each column added to the trace.

Reimplemented from geopm::Agent.

◆ trace_names()

std::vector< std::string > geopm::FrequencyMapAgent::trace_names ( void ) const

overridevirtual

Column headers to be added to the trace.

Implements geopm::Agent.

◆ trace_values()

void geopm::FrequencyMapAgent::trace_values ( std::vector< double > & values )

overridevirtual

Called by Controller to get latest values to be added to the trace.

Implements geopm::Agent.

◆ validate_policy()

void geopm::FrequencyMapAgent::validate_policy ( std::vector< double > & policy ) const

overridevirtual

Called by Controller to validate incoming policy values and configure defaults requested in incoming policy. Policy sender can request default value with 'NaN' at the desired offset in the policy vector. Returned policy should not contain 'NaN's and be consumeable by descend and adjust_platform.

Parameters

[in,out] policy Policy replace NaN's with defaults. If a value of policy is not NaN but the value is not supported by the Agent the method will throw a geopm::Exception with error code GEOPM_ERROR_INVALID.

Todo:: : in the future, this should not be accepted by this agent.

Implements geopm::Agent.

◆ wait()

void geopm::FrequencyMapAgent::wait ( void )

overridevirtual

Called by Controller to wait for sample period to elapse. This controls the cadence of the Controller main loop.

Implements geopm::Agent.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ FrequencyMapAgent() [1/3]

◆ FrequencyMapAgent() [2/3]

◆ FrequencyMapAgent() [3/3]

◆ ~FrequencyMapAgent()

Member Function Documentation

◆ adjust_platform()

◆ aggregate_sample()

◆ do_send_policy()

◆ do_send_sample()

◆ do_write_batch()

◆ enforce_policy()

◆ init()

◆ make_plugin()

◆ plugin_name()

◆ policy_names()

◆ report_header()

◆ report_host()

◆ report_region()

◆ sample_names()

◆ sample_platform()

◆ split_policy()

◆ trace_formats()

◆ trace_names()

◆ trace_values()

◆ validate_policy()

◆ wait()