geopm::SysfsDriver Class Reference

Class used to implement the SysfsIOGroup base class. More...

#include <SysfsDriver.hpp>

Inheritance diagram for geopm::SysfsDriver:

Classes
struct	derived_signal_info_s
struct	properties_s
	The properties about a signal or control. More...

Public Member Functions
	SysfsDriver ()=default
virtual	~SysfsDriver ()=default
virtual int	domain_type (const std::string &name) const =0
	Get the PlatformTopo domain type for an named attribute.
virtual std::string	attribute_path (const std::string &name, int domain_idx)=0
	Get the path to the sysfs entry for signal.
virtual std::function< double(const std::string &)>	signal_parse (const std::string &signal_name) const =0
	Get function to convert contents of sysfs file into signal.
virtual std::function< std::string(double)>	control_gen (const std::string &control_name) const =0
	Get a function to convert a control into a sysfs string.
virtual std::string	driver (void) const =0
virtual std::map< std::string, SysfsDriver::properties_s >	properties (void) const =0
	Query the meta data about a signal or control.
virtual std::map< std::string, derived_signal_info_s >	derived_signals (void) const
	Query mapping of derived signal aliases to their metadata and sources.

Static Public Member Functions
static std::map< std::string, SysfsDriver::properties_s >	parse_properties_json (const std::string &iogroup_name, const std::string &properties_json)

Static Public Attributes
static constexpr size_t	M_IO_BUFFER_SIZE = 128
	Arbitrary buffer size.

Detailed Description

Class used to implement the SysfsIOGroup base class.

This virtual interface can be adapted for each Linux device driver. A concrete implementation can be used to construct a SysfsIOGroup object.

Constructor & Destructor Documentation

SysfsDriver()

geopm::SysfsDriver::SysfsDriver ( )

default

~SysfsDriver()

virtual geopm::SysfsDriver::~SysfsDriver ( )

virtualdefault

Member Function Documentation

attribute_path()

virtual std::string geopm::SysfsDriver::attribute_path ( const std::string &  name, int  domain_idx  )

pure virtual

Get the path to the sysfs entry for signal.

Parameters

[in]	name	The name of the signal or control
[in]	domain_idx	The index of the domain within the set of domains of the same type on the platform.

Returns

File path to the sysfs entry to be read.

Implemented in geopm::CpufreqSysfsDriver, geopm::DrmSysfsDriver, geopm::PowercapSysfsDriver, and geopm::UncoreFreqSysfsDriver.

control_gen()

virtual std::function< std::string(double)> geopm::SysfsDriver::control_gen ( const std::string &  control_name ) const

pure virtual

Get a function to convert a control into a sysfs string.

Converts from the SI unit control into the text representation required by the device driver.

Parameters

[in]

signal_name

The name of the signal.

Returns

Function returning string content to be written to sysfs file.

Implemented in geopm::CpufreqSysfsDriver, geopm::DrmSysfsDriver, geopm::PowercapSysfsDriver, and geopm::UncoreFreqSysfsDriver.

derived_signals()

std::map< std::string, SysfsDriver::derived_signal_info_s > geopm::SysfsDriver::derived_signals ( void  ) const

virtual

Query mapping of derived signal aliases to their metadata and sources.

Reimplemented in geopm::DrmSysfsDriver.

domain_type()

virtual int geopm::SysfsDriver::domain_type ( const std::string &  name ) const

pure virtual

Get the PlatformTopo domain type for an named attribute.

Parameters

[in]

name

The name of the signal or control

Returns

geopm_domain_e domain type

Implemented in geopm::CpufreqSysfsDriver, geopm::DrmSysfsDriver, geopm::PowercapSysfsDriver, and geopm::UncoreFreqSysfsDriver.

driver()

virtual std::string geopm::SysfsDriver::driver ( void  ) const

pure virtual

Name of the Linux kernel device driver

Returns

Name of device driver

Implemented in geopm::CpufreqSysfsDriver, geopm::DrmSysfsDriver, geopm::PowercapSysfsDriver, and geopm::UncoreFreqSysfsDriver.

parse_properties_json()

std::map< std::string, SysfsDriver::properties_s > geopm::SysfsDriver::parse_properties_json ( const std::string &  iogroup_name, const std::string &  properties_json  )

static

properties()

virtual std::map< std::string, SysfsDriver::properties_s > geopm::SysfsDriver::properties ( void  ) const

pure virtual

Query the meta data about a signal or control.

Implemented in geopm::CpufreqSysfsDriver, geopm::DrmSysfsDriver, geopm::PowercapSysfsDriver, and geopm::UncoreFreqSysfsDriver.

signal_parse()

virtual std::function< double(const std::string &)> geopm::SysfsDriver::signal_parse ( const std::string &  signal_name ) const

pure virtual

Get function to convert contents of sysfs file into signal.

This parsing includes the conversion of the numerical data into SI units.

Parameters

[in]	properties_id	The unique identifier of the signal.
[in]	content	The string content read from the sysfs file.

Returns

The parsed signal value in SI units.

Implemented in geopm::CpufreqSysfsDriver, geopm::DrmSysfsDriver, geopm::PowercapSysfsDriver, and geopm::UncoreFreqSysfsDriver.

Member Data Documentation

M_IO_BUFFER_SIZE

constexpr size_t geopm::SysfsDriver::M_IO_BUFFER_SIZE = 128

staticconstexpr

Arbitrary buffer size.

We're generally looking at integer values much shorter than 100 digits in length. The IOGroup performs string truncation checks in case that ever changes.

---

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

• SysfsDriver.hpp
• SysfsDriver.cpp