<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>stem.util.proc — Stem 1.1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/theme_extras.js"></script>
<link rel="shortcut icon" href="../../../_static/favicon.png"/>
<link rel="top" title="Stem 1.1.0 documentation" href="../../../index.html" />
<link rel="up" title="stem" href="../../stem.html" />
</head>
<body>
<div class="header"><img class="rightlogo" src="../../../_static/logo.png" alt="Logo"/><h1 class="heading"><a href="../../../index.html">
<span>Stem Docs</span></a></h1>
<h2 class="heading"><span>stem.util.proc</span></h2>
</div>
<div class="topnav">
<p>
<ul id="navbar">
<li><a href="../../../index.html">Home</a></li>
<li><a href="../../../tutorials.html">Tutorials</a>
<ul>
<li><a href="../../../tutorials/the_little_relay_that_could.html">Hello World</a></li>
<li><a href="../../../tutorials/to_russia_with_love.html">Client Usage</a></li>
<li><a href="../../../tutorials/tortoise_and_the_hare.html">Event Listening</a></li>
<li><a href="../../../tutorials/mirror_mirror_on_the_wall.html">Tor Descriptors</a></li>
<li><a href="../../../tutorials/east_of_the_sun.html">Utilities</a></li>
<li><a href="../../../tutorials/double_double_toil_and_trouble.html">Examples</a></li>
</ul>
</li>
<li><a href="../../../api.html">API</a>
<ul>
<li><a href="../../../api/control.html">stem.control</a></li>
<li><a href="../../../api/connection.html">stem.connection</a></li>
<li><a href="../../../api/socket.html">stem.socket</a></li>
<li><a href="../../../api/process.html">stem.process</a></li>
<li><a href="../../../api/response.html">stem.response</a></li>
<li><a href="../../../api/exit_policy.html">stem.exit_policy</a></li>
<li><a href="../../../api/version.html">stem.version</a></li>
<li><a href="../../../api.html#descriptors">Descriptors</a></li>
<li><a href="../../../api.html#utilities">Utilities</a></li>
</ul>
</li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem">Development</a>
<ul>
<li><a href="../../../faq.html">FAQ</a></li>
<li><a href="../../../change_log.html">Change Log</a></li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs">Bug Tracker</a></li>
<li><a href="../../../download.html">Download</a></li>
</ul>
</li>
</ul>
</p>
</div>
<div class="content">
<h1>Source code for stem.util.proc</h1><div class="highlight"><pre>
<span class="c"># Copyright 2011-2013, Damian Johnson and The Tor Project</span>
<span class="c"># See LICENSE for licensing information</span>
<span class="sd">"""</span>
<span class="sd">Helper functions for querying process and system information from the /proc</span>
<span class="sd">contents. Fetching information this way provides huge performance benefits</span>
<span class="sd">over lookups via system utilities (ps, netstat, etc). For instance, resolving</span>
<span class="sd">connections this way cuts the runtime by around 90% verses the alternatives.</span>
<span class="sd">These functions may not work on all platforms (only Linux?).</span>
<span class="sd">The method for reading these files (and a little code) are borrowed from</span>
<span class="sd">`psutil <https://code.google.com/p/psutil/>`_, which was written by Jay Loden,</span>
<span class="sd">Dave Daeschler, Giampaolo Rodola' and is under the BSD license.</span>
<span class="sd">**These functions are not being vended to stem users. They may change in the</span>
<span class="sd">future, use them at your own risk.**</span>
<span class="sd">**Module Overview:**</span>
<span class="sd">::</span>
<span class="sd"> is_available - checks if proc utilities can be used on this system</span>
<span class="sd"> get_system_start_time - unix timestamp for when the system started</span>
<span class="sd"> get_physical_memory - memory available on this system</span>
<span class="sd"> get_cwd - provides the current working directory for a process</span>
<span class="sd"> get_uid - provides the user id a process is running under</span>
<span class="sd"> get_memory_usage - provides the memory usage of a process</span>
<span class="sd"> get_stats - queries statistics about a process</span>
<span class="sd"> get_connections - provides the connections made by a process</span>
<span class="sd">.. data:: Stat (enum)</span>
<span class="sd"> Types of data available via the :func:`~stem.util.proc.get_stats` function.</span>
<span class="sd"> ============== ===========</span>
<span class="sd"> Stat Description</span>
<span class="sd"> ============== ===========</span>
<span class="sd"> **COMMAND** command name under which the process is running</span>
<span class="sd"> **CPU_UTIME** total user time spent on the process</span>
<span class="sd"> **CPU_STIME** total system time spent on the process</span>
<span class="sd"> **START_TIME** when this process began, in unix time</span>
<span class="sd"> ============== ===========</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">base64</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">platform</span>
<span class="kn">import</span> <span class="nn">socket</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">stem.util.enum</span>
<span class="kn">from</span> <span class="nn">stem.util</span> <span class="kn">import</span> <span class="n">log</span>
<span class="k">try</span><span class="p">:</span>
<span class="c"># added in python 3.2</span>
<span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="n">lru_cache</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">stem.util.lru_cache</span> <span class="kn">import</span> <span class="n">lru_cache</span>
<span class="c"># os.sysconf is only defined on unix</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">CLOCK_TICKS</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">sysconf</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">sysconf_names</span><span class="p">[</span><span class="s">"SC_CLK_TCK"</span><span class="p">])</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="n">CLOCK_TICKS</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">Stat</span> <span class="o">=</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">(</span>
<span class="p">(</span><span class="s">"COMMAND"</span><span class="p">,</span> <span class="s">"command"</span><span class="p">),</span> <span class="p">(</span><span class="s">"CPU_UTIME"</span><span class="p">,</span> <span class="s">"utime"</span><span class="p">),</span>
<span class="p">(</span><span class="s">"CPU_STIME"</span><span class="p">,</span> <span class="s">"stime"</span><span class="p">),</span> <span class="p">(</span><span class="s">"START_TIME"</span><span class="p">,</span> <span class="s">"start time"</span><span class="p">)</span>
<span class="p">)</span>
<span class="nd">@lru_cache</span><span class="p">()</span>
<div class="viewcode-block" id="is_available"><a class="viewcode-back" href="../../../api/util/proc.html#stem.util.proc.is_available">[docs]</a><span class="k">def</span> <span class="nf">is_available</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Checks if proc information is available on this platform.</span>
<span class="sd"> :returns: **True** if proc contents exist on this platform, **False** otherwise</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span> <span class="o">!=</span> <span class="s">"Linux"</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># list of process independent proc paths we use</span>
<span class="n">proc_paths</span> <span class="o">=</span> <span class="p">(</span><span class="s">"/proc/stat"</span><span class="p">,</span> <span class="s">"/proc/meminfo"</span><span class="p">,</span> <span class="s">"/proc/net/tcp"</span><span class="p">,</span> <span class="s">"/proc/net/udp"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">proc_paths</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">return</span> <span class="bp">True</span>
</div>
<span class="nd">@lru_cache</span><span class="p">()</span>
<div class="viewcode-block" id="get_system_start_time"><a class="viewcode-back" href="../../../api/util/proc.html#stem.util.proc.get_system_start_time">[docs]</a><span class="k">def</span> <span class="nf">get_system_start_time</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Provides the unix time (seconds since epoch) when the system started.</span>
<span class="sd"> :returns: **float** for the unix time of when the system started</span>
<span class="sd"> :raises: **IOError** if it can't be determined</span>
<span class="sd"> """</span>
<span class="n">start_time</span><span class="p">,</span> <span class="n">parameter</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="s">"system start time"</span>
<span class="n">btime_line</span> <span class="o">=</span> <span class="n">_get_line</span><span class="p">(</span><span class="s">"/proc/stat"</span><span class="p">,</span> <span class="s">"btime"</span><span class="p">,</span> <span class="n">parameter</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">btime_line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span>
<span class="n">_log_runtime</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="s">"/proc/stat[btime]"</span><span class="p">,</span> <span class="n">start_time</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">exc</span> <span class="o">=</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"unable to parse the /proc/stat btime entry: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">btime_line</span><span class="p">)</span>
<span class="n">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">exc</span>
</div>
<span class="nd">@lru_cache</span><span class="p">()</span>
<div class="viewcode-block" id="get_physical_memory"><a class="viewcode-back" href="../../../api/util/proc.html#stem.util.proc.get_physical_memory">[docs]</a><span class="k">def</span> <span class="nf">get_physical_memory</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Provides the total physical memory on the system in bytes.</span>
<span class="sd"> :returns: **int** for the bytes of physical memory this system has</span>
<span class="sd"> :raises: **IOError** if it can't be determined</span>
<span class="sd"> """</span>
<span class="n">start_time</span><span class="p">,</span> <span class="n">parameter</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="s">"system physical memory"</span>
<span class="n">mem_total_line</span> <span class="o">=</span> <span class="n">_get_line</span><span class="p">(</span><span class="s">"/proc/meminfo"</span><span class="p">,</span> <span class="s">"MemTotal:"</span><span class="p">,</span> <span class="n">parameter</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">mem_total_line</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mi">1024</span>
<span class="n">_log_runtime</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="s">"/proc/meminfo[MemTotal]"</span><span class="p">,</span> <span class="n">start_time</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">exc</span> <span class="o">=</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"unable to parse the /proc/meminfo MemTotal entry: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">mem_total_line</span><span class="p">)</span>
<span class="n">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">exc</span>
</div>
<div class="viewcode-block" id="get_cwd"><a class="viewcode-back" href="../../../api/util/proc.html#stem.util.proc.get_cwd">[docs]</a><span class="k">def</span> <span class="nf">get_cwd</span><span class="p">(</span><span class="n">pid</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides the current working directory for the given process.</span>
<span class="sd"> :param int pid: process id of the process to be queried</span>
<span class="sd"> :returns: **str** with the path of the working directory for the process</span>
<span class="sd"> :raises: **IOError** if it can't be determined</span>
<span class="sd"> """</span>
<span class="n">start_time</span><span class="p">,</span> <span class="n">parameter</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="s">"cwd"</span>
<span class="n">proc_cwd_link</span> <span class="o">=</span> <span class="s">"/proc/</span><span class="si">%s</span><span class="s">/cwd"</span> <span class="o">%</span> <span class="n">pid</span>
<span class="k">if</span> <span class="n">pid</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">cwd</span> <span class="o">=</span> <span class="s">""</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">cwd</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">readlink</span><span class="p">(</span><span class="n">proc_cwd_link</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
<span class="n">exc</span> <span class="o">=</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"unable to read </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">proc_cwd_link</span><span class="p">)</span>
<span class="n">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">exc</span>
<span class="n">_log_runtime</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">proc_cwd_link</span><span class="p">,</span> <span class="n">start_time</span><span class="p">)</span>
<span class="k">return</span> <span class="n">cwd</span>
</div>
<div class="viewcode-block" id="get_uid"><a class="viewcode-back" href="../../../api/util/proc.html#stem.util.proc.get_uid">[docs]</a><span class="k">def</span> <span class="nf">get_uid</span><span class="p">(</span><span class="n">pid</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides the user ID the given process is running under.</span>
<span class="sd"> :param int pid: process id of the process to be queried</span>
<span class="sd"> :returns: **int** with the user id for the owner of the process</span>
<span class="sd"> :raises: **IOError** if it can't be determined</span>
<span class="sd"> """</span>
<span class="n">start_time</span><span class="p">,</span> <span class="n">parameter</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="s">"uid"</span>
<span class="n">status_path</span> <span class="o">=</span> <span class="s">"/proc/</span><span class="si">%s</span><span class="s">/status"</span> <span class="o">%</span> <span class="n">pid</span>
<span class="n">uid_line</span> <span class="o">=</span> <span class="n">_get_line</span><span class="p">(</span><span class="n">status_path</span><span class="p">,</span> <span class="s">"Uid:"</span><span class="p">,</span> <span class="n">parameter</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">uid_line</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span>
<span class="n">_log_runtime</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="s">"</span><span class="si">%s</span><span class="s">[Uid]"</span> <span class="o">%</span> <span class="n">status_path</span><span class="p">,</span> <span class="n">start_time</span><span class="p">)</span>
<span class="k">return</span> <span class="n">result</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">exc</span> <span class="o">=</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"unable to parse the </span><span class="si">%s</span><span class="s"> Uid entry: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">status_path</span><span class="p">,</span> <span class="n">uid_line</span><span class="p">))</span>
<span class="n">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">exc</span>
</div>
<div class="viewcode-block" id="get_memory_usage"><a class="viewcode-back" href="../../../api/util/proc.html#stem.util.proc.get_memory_usage">[docs]</a><span class="k">def</span> <span class="nf">get_memory_usage</span><span class="p">(</span><span class="n">pid</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides the memory usage in bytes for the given process.</span>
<span class="sd"> :param int pid: process id of the process to be queried</span>
<span class="sd"> :returns: **tuple** of two ints with the memory usage of the process, of the</span>
<span class="sd"> form **(resident_size, virtual_size)**</span>
<span class="sd"> :raises: **IOError** if it can't be determined</span>
<span class="sd"> """</span>
<span class="c"># checks if this is the kernel process</span>
<span class="k">if</span> <span class="n">pid</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">start_time</span><span class="p">,</span> <span class="n">parameter</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="s">"memory usage"</span>
<span class="n">status_path</span> <span class="o">=</span> <span class="s">"/proc/</span><span class="si">%s</span><span class="s">/status"</span> <span class="o">%</span> <span class="n">pid</span>
<span class="n">mem_lines</span> <span class="o">=</span> <span class="n">_get_lines</span><span class="p">(</span><span class="n">status_path</span><span class="p">,</span> <span class="p">(</span><span class="s">"VmRSS:"</span><span class="p">,</span> <span class="s">"VmSize:"</span><span class="p">),</span> <span class="n">parameter</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">residentSize</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">mem_lines</span><span class="p">[</span><span class="s">"VmRSS:"</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mi">1024</span>
<span class="n">virtualSize</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">mem_lines</span><span class="p">[</span><span class="s">"VmSize:"</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="mi">1024</span>
<span class="n">_log_runtime</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="s">"</span><span class="si">%s</span><span class="s">[VmRSS|VmSize]"</span> <span class="o">%</span> <span class="n">status_path</span><span class="p">,</span> <span class="n">start_time</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="n">residentSize</span><span class="p">,</span> <span class="n">virtualSize</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">exc</span> <span class="o">=</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"unable to parse the </span><span class="si">%s</span><span class="s"> VmRSS and VmSize entries: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">status_path</span><span class="p">,</span> <span class="s">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">mem_lines</span><span class="p">)))</span>
<span class="n">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">exc</span>
</div>
<div class="viewcode-block" id="get_stats"><a class="viewcode-back" href="../../../api/util/proc.html#stem.util.proc.get_stats">[docs]</a><span class="k">def</span> <span class="nf">get_stats</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="o">*</span><span class="n">stat_types</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides process specific information. See the :data:`~stem.util.proc.Stat`</span>
<span class="sd"> enum for valid options.</span>
<span class="sd"> :param int pid: process id of the process to be queried</span>
<span class="sd"> :param Stat stat_types: information to be provided back</span>
<span class="sd"> :returns: **tuple** with all of the requested statistics as strings</span>
<span class="sd"> :raises: **IOError** if it can't be determined</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">CLOCK_TICKS</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"Unable to look up SC_CLK_TCK"</span><span class="p">)</span>
<span class="n">start_time</span><span class="p">,</span> <span class="n">parameter</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="s">"process </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="s">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">stat_types</span><span class="p">)</span>
<span class="c"># the stat file contains a single line, of the form...</span>
<span class="c"># 8438 (tor) S 8407 8438 8407 34818 8438 4202496...</span>
<span class="n">stat_path</span> <span class="o">=</span> <span class="s">"/proc/</span><span class="si">%s</span><span class="s">/stat"</span> <span class="o">%</span> <span class="n">pid</span>
<span class="n">stat_line</span> <span class="o">=</span> <span class="n">_get_line</span><span class="p">(</span><span class="n">stat_path</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">pid</span><span class="p">),</span> <span class="n">parameter</span><span class="p">)</span>
<span class="c"># breaks line into component values</span>
<span class="n">stat_comp</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">cmd_start</span><span class="p">,</span> <span class="n">cmd_end</span> <span class="o">=</span> <span class="n">stat_line</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"("</span><span class="p">),</span> <span class="n">stat_line</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">")"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">cmd_start</span> <span class="o">!=</span> <span class="o">-</span><span class="mi">1</span> <span class="ow">and</span> <span class="n">cmd_end</span> <span class="o">!=</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
<span class="n">stat_comp</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">stat_line</span><span class="p">[:</span><span class="n">cmd_start</span><span class="p">])</span>
<span class="n">stat_comp</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">stat_line</span><span class="p">[</span><span class="n">cmd_start</span> <span class="o">+</span> <span class="mi">1</span><span class="p">:</span><span class="n">cmd_end</span><span class="p">])</span>
<span class="n">stat_comp</span> <span class="o">+=</span> <span class="n">stat_line</span><span class="p">[</span><span class="n">cmd_end</span> <span class="o">+</span> <span class="mi">1</span><span class="p">:]</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">stat_comp</span><span class="p">)</span> <span class="o"><</span> <span class="mi">44</span> <span class="ow">and</span> <span class="n">_is_float</span><span class="p">(</span><span class="n">stat_comp</span><span class="p">[</span><span class="mi">13</span><span class="p">],</span> <span class="n">stat_comp</span><span class="p">[</span><span class="mi">14</span><span class="p">],</span> <span class="n">stat_comp</span><span class="p">[</span><span class="mi">21</span><span class="p">]):</span>
<span class="n">exc</span> <span class="o">=</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"stat file had an unexpected format: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">stat_path</span><span class="p">)</span>
<span class="n">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">exc</span>
<span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">stat_type</span> <span class="ow">in</span> <span class="n">stat_types</span><span class="p">:</span>
<span class="k">if</span> <span class="n">stat_type</span> <span class="o">==</span> <span class="n">Stat</span><span class="o">.</span><span class="n">COMMAND</span><span class="p">:</span>
<span class="k">if</span> <span class="n">pid</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"sched"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">stat_comp</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="k">elif</span> <span class="n">stat_type</span> <span class="o">==</span> <span class="n">Stat</span><span class="o">.</span><span class="n">CPU_UTIME</span><span class="p">:</span>
<span class="k">if</span> <span class="n">pid</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"0"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">stat_comp</span><span class="p">[</span><span class="mi">13</span><span class="p">])</span> <span class="o">/</span> <span class="n">CLOCK_TICKS</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">stat_type</span> <span class="o">==</span> <span class="n">Stat</span><span class="o">.</span><span class="n">CPU_STIME</span><span class="p">:</span>
<span class="k">if</span> <span class="n">pid</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"0"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">stat_comp</span><span class="p">[</span><span class="mi">14</span><span class="p">])</span> <span class="o">/</span> <span class="n">CLOCK_TICKS</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">stat_type</span> <span class="o">==</span> <span class="n">Stat</span><span class="o">.</span><span class="n">START_TIME</span><span class="p">:</span>
<span class="k">if</span> <span class="n">pid</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="n">get_system_start_time</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># According to documentation, starttime is in field 21 and the unit is</span>
<span class="c"># jiffies (clock ticks). We divide it for clock ticks, then add the</span>
<span class="c"># uptime to get the seconds since the epoch.</span>
<span class="n">p_start_time</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">stat_comp</span><span class="p">[</span><span class="mi">21</span><span class="p">])</span> <span class="o">/</span> <span class="n">CLOCK_TICKS</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">p_start_time</span> <span class="o">+</span> <span class="n">get_system_start_time</span><span class="p">()))</span>
<span class="n">_log_runtime</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">stat_path</span><span class="p">,</span> <span class="n">start_time</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="get_connections"><a class="viewcode-back" href="../../../api/util/proc.html#stem.util.proc.get_connections">[docs]</a><span class="k">def</span> <span class="nf">get_connections</span><span class="p">(</span><span class="n">pid</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Queries connection related information from the proc contents. This provides</span>
<span class="sd"> similar results to netstat, lsof, sockstat, and other connection resolution</span>
<span class="sd"> utilities (though the lookup is far quicker).</span>
<span class="sd"> :param int pid: process id of the process to be queried</span>
<span class="sd"> :returns: A listing of connection tuples of the form **[(local_ipAddr1,</span>
<span class="sd"> local_port1, foreign_ipAddr1, foreign_port1, protocol), ...]** (addresses</span>
<span class="sd"> and protocols are strings and ports are ints)</span>
<span class="sd"> :raises: **IOError** if it can't be determined</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">pid</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">pid</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"Process pid was non-numeric: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">pid</span><span class="p">)</span>
<span class="k">if</span> <span class="n">pid</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[]</span>
<span class="c"># fetches the inode numbers for socket file descriptors</span>
<span class="n">start_time</span><span class="p">,</span> <span class="n">parameter</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> <span class="s">"process connections"</span>
<span class="n">inodes</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">fd</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="s">"/proc/</span><span class="si">%s</span><span class="s">/fd"</span> <span class="o">%</span> <span class="n">pid</span><span class="p">):</span>
<span class="n">fd_path</span> <span class="o">=</span> <span class="s">"/proc/</span><span class="si">%s</span><span class="s">/fd/</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">fd</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="c"># File descriptor link, such as 'socket:[30899]'</span>
<span class="n">fd_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">readlink</span><span class="p">(</span><span class="n">fd_path</span><span class="p">)</span>
<span class="k">if</span> <span class="n">fd_name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'socket:['</span><span class="p">):</span>
<span class="n">inodes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">fd_name</span><span class="p">[</span><span class="mi">8</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
<span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
<span class="c"># most likely couldn't be read due to permissions</span>
<span class="n">exc</span> <span class="o">=</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"unable to determine file descriptor destination: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">fd_path</span><span class="p">)</span>
<span class="n">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">exc</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">inodes</span><span class="p">:</span>
<span class="c"># unable to fetch any connections for this process</span>
<span class="k">return</span> <span class="p">[]</span>
<span class="c"># check for the connection information from the /proc/net contents</span>
<span class="n">conn</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">proc_file_path</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"/proc/net/tcp"</span><span class="p">,</span> <span class="s">"/proc/net/udp"</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">proc_file</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">proc_file_path</span><span class="p">)</span>
<span class="n">proc_file</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span> <span class="c"># skip the first line</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">proc_file</span><span class="p">:</span>
<span class="n">_</span><span class="p">,</span> <span class="n">l_addr</span><span class="p">,</span> <span class="n">f_addr</span><span class="p">,</span> <span class="n">status</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">inode</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">split</span><span class="p">()[:</span><span class="mi">10</span><span class="p">]</span>
<span class="k">if</span> <span class="n">inode</span> <span class="ow">in</span> <span class="n">inodes</span><span class="p">:</span>
<span class="c"># if a tcp connection, skip if it isn't yet established</span>
<span class="k">if</span> <span class="n">proc_file_path</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">"/tcp"</span><span class="p">)</span> <span class="ow">and</span> <span class="n">status</span> <span class="o">!=</span> <span class="s">"01"</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">local_ip</span><span class="p">,</span> <span class="n">local_port</span> <span class="o">=</span> <span class="n">_decode_proc_address_encoding</span><span class="p">(</span><span class="n">l_addr</span><span class="p">)</span>
<span class="n">foreign_ip</span><span class="p">,</span> <span class="n">foreign_port</span> <span class="o">=</span> <span class="n">_decode_proc_address_encoding</span><span class="p">(</span><span class="n">f_addr</span><span class="p">)</span>
<span class="n">protocol</span> <span class="o">=</span> <span class="n">proc_file_path</span><span class="p">[</span><span class="mi">10</span><span class="p">:]</span>
<span class="n">conn</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">local_ip</span><span class="p">,</span> <span class="n">local_port</span><span class="p">,</span> <span class="n">foreign_ip</span><span class="p">,</span> <span class="n">foreign_port</span><span class="p">,</span> <span class="n">protocol</span><span class="p">))</span>
<span class="n">proc_file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="n">exc</span> <span class="o">=</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"unable to read '</span><span class="si">%s</span><span class="s">': </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">proc_file_path</span><span class="p">,</span> <span class="n">exc</span><span class="p">))</span>
<span class="n">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">exc</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="n">exc</span> <span class="o">=</span> <span class="ne">IOError</span><span class="p">(</span><span class="s">"unable to parse '</span><span class="si">%s</span><span class="s">': </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">proc_file_path</span><span class="p">,</span> <span class="n">exc</span><span class="p">))</span>
<span class="n">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">exc</span>
<span class="n">_log_runtime</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="s">"/proc/net/[tcp|udp]"</span><span class="p">,</span> <span class="n">start_time</span><span class="p">)</span>
<span class="k">return</span> <span class="n">conn</span>
</div>
<span class="k">def</span> <span class="nf">_decode_proc_address_encoding</span><span class="p">(</span><span class="n">addr</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Translates an address entry in the /proc/net/* contents to a human readable</span>
<span class="sd"> form (`reference <http://linuxdevcenter.com/pub/a/linux/2000/11/16/LinuxAdmin.html>`_,</span>
<span class="sd"> for instance:</span>
<span class="sd"> ::</span>
<span class="sd"> "0500000A:0016" -> ("10.0.0.5", 22)</span>
<span class="sd"> :param str addr: proc address entry to be decoded</span>
<span class="sd"> :returns: **tuple** of the form **(addr, port)**, with addr as a string and port an int</span>
<span class="sd"> """</span>
<span class="n">ip</span><span class="p">,</span> <span class="n">port</span> <span class="o">=</span> <span class="n">addr</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">':'</span><span class="p">)</span>
<span class="c"># the port is represented as a two-byte hexadecimal number</span>
<span class="n">port</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="mi">16</span><span class="p">)</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,):</span>
<span class="n">ip</span> <span class="o">=</span> <span class="n">ip</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'ascii'</span><span class="p">)</span>
<span class="c"># The IPv4 address portion is a little-endian four-byte hexadecimal number.</span>
<span class="c"># That is, the least significant byte is listed first, so we need to reverse</span>
<span class="c"># the order of the bytes to convert it to an IP address.</span>
<span class="c">#</span>
<span class="c"># This needs to account for the endian ordering as per...</span>
<span class="c"># http://code.google.com/p/psutil/issues/detail?id=201</span>
<span class="c"># https://trac.torproject.org/projects/tor/ticket/4777</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">byteorder</span> <span class="o">==</span> <span class="s">'little'</span><span class="p">:</span>
<span class="n">ip</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">inet_ntop</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_INET</span><span class="p">,</span> <span class="n">base64</span><span class="o">.</span><span class="n">b16decode</span><span class="p">(</span><span class="n">ip</span><span class="p">)[::</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">ip</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">inet_ntop</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_INET</span><span class="p">,</span> <span class="n">base64</span><span class="o">.</span><span class="n">b16decode</span><span class="p">(</span><span class="n">ip</span><span class="p">))</span>
<span class="k">return</span> <span class="p">(</span><span class="n">ip</span><span class="p">,</span> <span class="n">port</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_is_float</span><span class="p">(</span><span class="o">*</span><span class="n">value</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
<span class="nb">float</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">def</span> <span class="nf">_get_line</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="n">line_prefix</span><span class="p">,</span> <span class="n">parameter</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_get_lines</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="p">(</span><span class="n">line_prefix</span><span class="p">,</span> <span class="p">),</span> <span class="n">parameter</span><span class="p">)[</span><span class="n">line_prefix</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">_get_lines</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="n">line_prefixes</span><span class="p">,</span> <span class="n">parameter</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Fetches lines with the given prefixes from a file. This only provides back</span>
<span class="sd"> the first instance of each prefix.</span>
<span class="sd"> :param str file_path: path of the file to read</span>
<span class="sd"> :param tuple line_prefixes: string prefixes of the lines to return</span>
<span class="sd"> :param str parameter: description of the proc attribute being fetch</span>
<span class="sd"> :returns: mapping of prefixes to the matching line</span>
<span class="sd"> :raises: **IOError** if unable to read the file or can't find all of the prefixes</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">remaining_prefixes</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">line_prefixes</span><span class="p">)</span>
<span class="n">proc_file</span><span class="p">,</span> <span class="n">results</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_path</span><span class="p">),</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">proc_file</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">remaining_prefixes</span><span class="p">:</span>
<span class="k">break</span> <span class="c"># found everything we're looking for</span>
<span class="k">for</span> <span class="n">prefix</span> <span class="ow">in</span> <span class="n">remaining_prefixes</span><span class="p">:</span>
<span class="k">if</span> <span class="n">line</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">prefix</span><span class="p">):</span>
<span class="n">results</span><span class="p">[</span><span class="n">prefix</span><span class="p">]</span> <span class="o">=</span> <span class="n">line</span>
<span class="n">remaining_prefixes</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span>
<span class="k">break</span>
<span class="n">proc_file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">if</span> <span class="n">remaining_prefixes</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">remaining_prefixes</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s"> did not contain a </span><span class="si">%s</span><span class="s"> entry"</span> <span class="o">%</span> <span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="n">remaining_prefixes</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s"> did not contain </span><span class="si">%s</span><span class="s"> entries"</span> <span class="o">%</span> <span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="s">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">remaining_prefixes</span><span class="p">))</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">results</span>
<span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="n">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">exc</span>
<span class="k">def</span> <span class="nf">_log_runtime</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">proc_location</span><span class="p">,</span> <span class="n">start_time</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Logs a message indicating a successful proc query.</span>
<span class="sd"> :param str parameter: description of the proc attribute being fetch</span>
<span class="sd"> :param str proc_location: proc files we were querying</span>
<span class="sd"> :param int start_time: unix time for when this query was started</span>
<span class="sd"> """</span>
<span class="n">runtime</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">-</span> <span class="n">start_time</span>
<span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"proc call (</span><span class="si">%s</span><span class="s">): </span><span class="si">%s</span><span class="s"> (runtime: </span><span class="si">%0.4f</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">proc_location</span><span class="p">,</span> <span class="n">runtime</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_log_failure</span><span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Logs a message indicating that the proc query failed.</span>
<span class="sd"> :param str parameter: description of the proc attribute being fetch</span>
<span class="sd"> :param Exception exc: exception that we're raising</span>
<span class="sd"> """</span>
<span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"proc call failed (</span><span class="si">%s</span><span class="s">): </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">parameter</span><span class="p">,</span> <span class="n">exc</span><span class="p">))</span>
</pre></div>
</div>
<div class="bottomnav">
</div>
<div class="footer">
</div>
</body>
</html>
