Reference Manual

This reference manual features the GEOPM manual pages along with detailed descriptions of signals and controls.

GEOPM Manual Pages

Overview

• geopm(7) – Global Extensible Open Power Manager
  • Description
  • Job Launch
  • Application Profiling
  • Analysis Tools
  • Built-In Agents
  • Plugin Extension
  • Integration With PMPI
  • Integration With OMPT
  • Choosing An Agent And Policy
  • Interpreting The Report
  • Interpreting The Trace
  • Environment
  • GEOPM Environment Variables
  • Other Environment Variables
  • Misc
  • See Also

PlatformIO

• geopm_pio(7) – GEOPM PlatformIO interface
• geopm_pio_cnl(7) – Signals and controls for Compute Node Linux Board-Level Metrics
• geopm_pio_const_config(7) – Signals for ConstConfigIOGroup
• geopm_pio_cpuinfo(7) – Signals and controls for the CPUInfoIOGroup
• geopm_pio_dcgm(7) – IOGroup providing signals and controls for NVIDIA GPUs
• geopm_pio_levelzero(7) – IOGroup providing signals and controls for Intel GPUs
• geopm_pio_msr(7) – Signals and controls for Model Specific Registers (MSRs)
• geopm_pio_nvml(7) – IOGroup providing signals and controls for NVIDIA GPUs
• geopm_pio_profile(7) – Signals and controls for the ProfileIOGroup
• geopm_pio_service(7) – Signals and controls for the ServiceIOGroup
• geopm_pio_sst(7) – Signals and controls for Intel Speed Select Technology
• geopm_pio_sysfs(7) – Signals and controls for sysfs attributes
• geopm_pio_time(7) – Signals and controls for Time IO Group

Command Line Interfaces

• geopmaccess(1) – Access management for the GEOPM Service
• geopmadmin(1) – tool for GEOPM system administrators
• geopmagent(1) – query agent information and create static policies
• geopmbench(1) – synthetic benchmark application
• geopmctl(1) – GEOPM runtime control application
• geopmendpoint(1) – command line tool for dynamic policy control
• geopmexporter(1) – Prometheus exporter for GEOPM metrics
• geopmlaunch(1) – application launch wrapper
• geopmread(1) – query platform information
• geopmsession(1) – Command line interface for the GEOPM service batch read features
• geopmwrite(1) – modify platform state

GEOPM Python Interfaces

• geopmdpy(7) – global extensible open power manager python daemon package
  • Description
  • Synopsis
  • geopmdpy.access
  • geopmdpy.dbus_xml
  • geopmdpy.error
  • geopmdpy.loop
  • geopmdpy.pio
  • geopmdpy.schemas
  • geopmdpy.service
  • geopmdpy.session
  • geopmdpy.system_files
  • geopmdpy.topo
  • geopmdpy.version
  • See Also
• geopmpy(7) – global extensible open power manager python package
  • Description
  • Installation
  • Environment
  • Programming Interface
  • Troubleshooting
  • See Also

GEOPM C Interfaces

• geopm_agent(3) – query information about available agents
• geopm_ctl(3) – GEOPM runtime control thread
• geopm_daemon(3) – helpers for GEOPM daemons
• geopm_endpoint(3) – dynamic policy control for resource management
• geopm_error(3) – error code descriptions
• geopm_agent(3) – query information about available agents
• geopm_fortran(3) – GEOPM fortran interface
• geopm_hash(3) – helper methods for encoding
• geopm_imbalancer(3) – set artificial runtime imbalance
• geopm_pio(3) – interfaces to query and modify platform
• geopm_policystore(3) – GEOPM resource policy store interface
• geopm_prof(3) – application profiling interfaces
• geopm_sched(3) – interface with Linux scheduler
• geopm_time(3) – helper methods for time
• geopm_topo(3) – query platform component topology
• geopm_version(3) – GEOPM library version

GEOPM C++ Interfaces

• geopm::Agent(3) – GEOPM agent plugin interface
• geopm::Agg(3) – data aggregation functions
• geopm::CNLIOGroup(3) – IOGroup for interaction with Compute Node Linux
• geopm::CPUActivityAgent(3) – agent for selecting CPU frequency based on CPU compute activity
• geopm::CircularBuffer(3) – generic circular buffer
• geopm::Comm(3) – communication abstractions
• geopm::CpuinfoIOGroup(3) – IOGroup for CPU frequency limits
• geopm::Daemon(3) – GEOPM daemon helper methods
• geopm::Endpoint(3) – GEOPM endpoint interface
• geopm::Exception(3) – custom GEOPM exceptions
• geopm::GPUActivityAgent(3) – agent for selecting GPU frequency based on GPU compute activity
• geopm::Helper – common helper methods
• geopm::IOGroup(3) – provides system values and settings
• geopm::MPIComm(3) – implementation of Comm using MPI
• geopm::MSRIO(3) – methods for reading and writing MSRs
• geopm::MSRIOGroup – IOGroup providing MSR-based signals and controls
• geopm::MonitorAgent – agent that enforces no policies
• geopm::PlatformIO(3) – GEOPM platform interface
• geopm::PlatformTopo(3) – platform topology information
• geopm::PluginFactory(3) – abstract factory for plugins
• geopm::PowerBalancer(3) – balances power according to epoch runtime
• geopm::PowerBalancerAgent(3) – agent optimizing performance under a power cap
• geopm::PowerGovernor(3) – enforces a power limit
• geopm::PowerGovernorAgent(3) – agent that enforces a power cap
• geopm::ProfileIOGroup(3) – IOGroup providing application signals
• geopm::SampleAggregator(3) – per-region aggregated signal data
• geopm::SharedMemory(3) – abstractions for shared memory
• geopm::TimeIOGroup(3) – IOGroup providing time signals

Output File Formats

• geopm_report(7) – GEOPM summary report file

GEOPM HPC Runtime Agents

• geopm_agent_cpu_activity(7) – agent for selecting CPU frequency based on CPU compute activity
• geopm_agent_ffnet(7) – agent for adjusting frequencies based on application behavior
• geopm_agent_frequency_map(7) – agent for running regions at user selected frequencies
• geopm_agent_gpu_activity(7) – agent for selecting GPU frequency based on GPU compute activity
• geopm_agent_monitor(7) – agent implementation for aggregating statistics
• geopm_agent_power_balancer(7) – agent optimizes performance under a power cap
• geopm_agent_power_governor(7) – agent enforces a power cap

Doxygen Pages

• GEOPM Service

• GEOPM Runtime