diff options
Diffstat (limited to 'catapult/telemetry/docs/pydoc/telemetry.internal.platform.power_monitor.sysfs_power_monitor.html')
| -rw-r--r-- | catapult/telemetry/docs/pydoc/telemetry.internal.platform.power_monitor.sysfs_power_monitor.html | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/catapult/telemetry/docs/pydoc/telemetry.internal.platform.power_monitor.sysfs_power_monitor.html b/catapult/telemetry/docs/pydoc/telemetry.internal.platform.power_monitor.sysfs_power_monitor.html new file mode 100644 index 00000000..82bec240 --- /dev/null +++ b/catapult/telemetry/docs/pydoc/telemetry.internal.platform.power_monitor.sysfs_power_monitor.html @@ -0,0 +1,147 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><title>Python: module telemetry.internal.platform.power_monitor.sysfs_power_monitor</title> +<meta charset="utf-8"> +</head><body bgcolor="#f0f0f8"> + +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> +<tr bgcolor="#7799ee"> +<td valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.platform.html"><font color="#ffffff">platform</font></a>.<a href="telemetry.internal.platform.power_monitor.html"><font color="#ffffff">power_monitor</font></a>.sysfs_power_monitor</strong></big></big></font></td +><td align=right valign=bottom +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/platform/power_monitor/sysfs_power_monitor.py">telemetry/internal/platform/power_monitor/sysfs_power_monitor.py</a></font></td></tr></table> + <p><tt># Copyright 2014 The Chromium Authors. All rights reserved.<br> +# Use of this source code is governed by a BSD-style license that can be<br> +# found in the LICENSE file.</tt></p> +<p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#aa55cc"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> + +<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> +<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="collections.html">collections</a><br> +<a href="telemetry.decorators.html">telemetry.decorators</a><br> +</td><td width="25%" valign=top><a href="logging.html">logging</a><br> +<a href="os.html">os</a><br> +</td><td width="25%" valign=top><a href="telemetry.internal.platform.power_monitor.html">telemetry.internal.platform.power_monitor</a><br> +<a href="re.html">re</a><br> +</td><td width="25%" valign=top></td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ee77aa"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> + +<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> +<td width="100%"><dl> +<dt><font face="helvetica, arial"><a href="telemetry.internal.platform.power_monitor.html#PowerMonitor">telemetry.internal.platform.power_monitor.PowerMonitor</a>(<a href="__builtin__.html#object">__builtin__.object</a>) +</font></dt><dd> +<dl> +<dt><font face="helvetica, arial"><a href="telemetry.internal.platform.power_monitor.sysfs_power_monitor.html#SysfsPowerMonitor">SysfsPowerMonitor</a> +</font></dt></dl> +</dd> +</dl> + <p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#ffc8d8"> +<td colspan=3 valign=bottom> <br> +<font color="#000000" face="helvetica, arial"><a name="SysfsPowerMonitor">class <strong>SysfsPowerMonitor</strong></a>(<a href="telemetry.internal.platform.power_monitor.html#PowerMonitor">telemetry.internal.platform.power_monitor.PowerMonitor</a>)</font></td></tr> + +<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> +<td colspan=2><tt><a href="telemetry.internal.platform.power_monitor.html#PowerMonitor">PowerMonitor</a> that relies on sysfs to monitor CPU statistics on several<br> +different platforms.<br> </tt></td></tr> +<tr><td> </td> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="telemetry.internal.platform.power_monitor.sysfs_power_monitor.html#SysfsPowerMonitor">SysfsPowerMonitor</a></dd> +<dd><a href="telemetry.internal.platform.power_monitor.html#PowerMonitor">telemetry.internal.platform.power_monitor.PowerMonitor</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> +<dl><dt><a name="SysfsPowerMonitor-CanMonitorPower"><strong>CanMonitorPower</strong></a>(*args, **kwargs)</dt></dl> + +<dl><dt><a name="SysfsPowerMonitor-GetCpuFreq"><strong>GetCpuFreq</strong></a>(self)</dt><dd><tt>Retrieve CPU frequency times from the device.<br> + <br> +Returns:<br> + Dictionary containing frequency times for each CPU.</tt></dd></dl> + +<dl><dt><a name="SysfsPowerMonitor-GetCpuState"><strong>GetCpuState</strong></a>(self)</dt><dd><tt>Retrieve CPU c-state residency times from the device.<br> + <br> +Returns:<br> + Dictionary containing c-state residency times for each CPU.</tt></dd></dl> + +<dl><dt><a name="SysfsPowerMonitor-StartMonitoringPower"><strong>StartMonitoringPower</strong></a>(self, _browser)</dt></dl> + +<dl><dt><a name="SysfsPowerMonitor-StopMonitoringPower"><strong>StopMonitoringPower</strong></a>(self)</dt></dl> + +<dl><dt><a name="SysfsPowerMonitor-__init__"><strong>__init__</strong></a>(self, linux_based_platform_backend, standalone<font color="#909090">=False</font>)</dt><dd><tt>Constructor.<br> + <br> +Args:<br> + linux_based_platform_backend: A LinuxBasedPlatformBackend object.<br> + standalone: If it is not wrapping another monitor, set to True.<br> + <br> +Attributes:<br> + _cpus: A list of the CPUs on the target device.<br> + _end_time: The time the test stopped monitoring power.<br> + _final_cstate: The c-state residency times after the test.<br> + _final_freq: The CPU frequency times after the test.<br> + _initial_cstate: The c-state residency times before the test.<br> + _initial_freq: The CPU frequency times before the test.<br> + _platform: A LinuxBasedPlatformBackend object associated with the<br> + target platform.<br> + _start_time: The time the test started monitoring power.</tt></dd></dl> + +<hr> +Static methods defined here:<br> +<dl><dt><a name="SysfsPowerMonitor-CombineResults"><strong>CombineResults</strong></a>(cpu_stats, power_stats)</dt><dd><tt>Add frequency and c-state residency data to the power data.<br> + <br> +Args:<br> + cpu_stats: Dictionary containing CPU statistics.<br> + power_stats: Dictionary containing power statistics.<br> + <br> +Returns:<br> + Dictionary in the format returned by StopMonitoringPower.</tt></dd></dl> + +<dl><dt><a name="SysfsPowerMonitor-ComputeCpuStats"><strong>ComputeCpuStats</strong></a>(initial, final)</dt><dd><tt>Parse the CPU c-state and frequency values saved during monitoring.<br> + <br> +Args:<br> + initial: The parsed dictionary of initial statistics to be converted<br> + into percentages.<br> + final: The parsed dictionary of final statistics to be converted<br> + into percentages.<br> + <br> +Returns:<br> + Dictionary containing percentages for each CPU as well as an average<br> + across all CPUs.</tt></dd></dl> + +<dl><dt><a name="SysfsPowerMonitor-ParseFreqSample"><strong>ParseFreqSample</strong></a>(sample)</dt><dd><tt>Parse a single frequency sample.<br> + <br> +Args:<br> + sample: The single sample of frequency data to be parsed.<br> + <br> +Returns:<br> + A dictionary associating a frequency with a time.</tt></dd></dl> + +<hr> +Methods inherited from <a href="telemetry.internal.platform.power_monitor.html#PowerMonitor">telemetry.internal.platform.power_monitor.PowerMonitor</a>:<br> +<dl><dt><a name="SysfsPowerMonitor-CanMeasurePerApplicationPower"><strong>CanMeasurePerApplicationPower</strong></a>(self)</dt><dd><tt>Returns True if the power monitor can measure power for the target<br> +application in isolation. False if power measurement is for full system<br> +energy consumption.</tt></dd></dl> + +<hr> +Data descriptors inherited from <a href="telemetry.internal.platform.power_monitor.html#PowerMonitor">telemetry.internal.platform.power_monitor.PowerMonitor</a>:<br> +<dl><dt><strong>__dict__</strong></dt> +<dd><tt>dictionary for instance variables (if defined)</tt></dd> +</dl> +<dl><dt><strong>__weakref__</strong></dt> +<dd><tt>list of weak references to the object (if defined)</tt></dd> +</dl> +</td></tr></table></td></tr></table><p> +<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> +<tr bgcolor="#55aa55"> +<td colspan=3 valign=bottom> <br> +<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> + +<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> +<td width="100%"><strong>CPU_PATH</strong> = '/sys/devices/system/cpu/'</td></tr></table> +</body></html>
\ No newline at end of file |