terminator/doc/apidoc/_build/html/_modules/terminatorlib/freebsd.html

313 lines
23 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>terminatorlib.freebsd &mdash; terminatorlib 0.98 documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="top" title="terminatorlib 0.98 documentation" href="../../index.html"/>
<link rel="up" title="Module code" href="../index.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="../../index.html" class="icon icon-home"> terminatorlib
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../terminatorlib.html">terminatorlib package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../terminatorlib.configobj.html">terminatorlib.configobj package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj.configobj">terminatorlib.configobj.configobj module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj.validate">terminatorlib.configobj.validate module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.configobj.html#module-terminatorlib.configobj">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../terminatorlib.plugins.html">terminatorlib.plugins package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.activitywatch">terminatorlib.plugins.activitywatch module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.custom_commands">terminatorlib.plugins.custom_commands module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.logger">terminatorlib.plugins.logger module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.maven">terminatorlib.plugins.maven module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.terminalshot">terminatorlib.plugins.terminalshot module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.testplugin">terminatorlib.plugins.testplugin module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins.url_handlers">terminatorlib.plugins.url_handlers module</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../terminatorlib.plugins.html#module-terminatorlib.plugins">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.borg">terminatorlib.borg module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.config">terminatorlib.config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.container">terminatorlib.container module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.cwd">terminatorlib.cwd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.debugserver">terminatorlib.debugserver module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.editablelabel">terminatorlib.editablelabel module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.encoding">terminatorlib.encoding module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.factory">terminatorlib.factory module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.freebsd">terminatorlib.freebsd module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.ipc">terminatorlib.ipc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.keybindings">terminatorlib.keybindings module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.layoutlauncher">terminatorlib.layoutlauncher module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.notebook">terminatorlib.notebook module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.optionparse">terminatorlib.optionparse module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.paned">terminatorlib.paned module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.plugin">terminatorlib.plugin module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.prefseditor">terminatorlib.prefseditor module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.searchbar">terminatorlib.searchbar module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.signalman">terminatorlib.signalman module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminal">terminatorlib.terminal module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminal_popup_menu">terminatorlib.terminal_popup_menu module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.terminator">terminatorlib.terminator module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.titlebar">terminatorlib.titlebar module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.translation">terminatorlib.translation module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.util">terminatorlib.util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.version">terminatorlib.version module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib.window">terminatorlib.window module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../terminatorlib.html#module-terminatorlib">Module contents</a></li>
</ul>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">terminatorlib</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
<li>terminatorlib.freebsd</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<h1>Source code for terminatorlib.freebsd</h1><div class="highlight"><pre>
<span class="c">#!/usr/bin/python</span>
<span class="c">#</span>
<span class="c"># Copyright (c) 2008, Thomas Hurst &lt;tom@hur.st&gt;</span>
<span class="c">#</span>
<span class="c"># Use of this file is unrestricted provided this notice is retained.</span>
<span class="c"># If you use it, it&#39;d be nice if you dropped me a note. Also beer.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> freebsd.get_process_cwd(pid):</span>
<span class="sd"> Use sysctl() to retrieve the cwd of an arbitrary process on FreeBSD</span>
<span class="sd"> using kern.proc.filedesc, as used by procstat(1).</span>
<span class="sd"> Tested on FreeBSD 7-STABLE/amd64 from April 11 2008.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">ctypes</span> <span class="kn">import</span> <span class="o">*</span>
<div class="viewcode-block" id="sockaddr_storage"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.freebsd.sockaddr_storage">[docs]</a><span class="k">class</span> <span class="nc">sockaddr_storage</span><span class="p">(</span><span class="n">Structure</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;struct sockaddr_storage, defined in /usr/include/sys/socket.h&quot;&quot;&quot;</span>
<span class="n">_fields_</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">(</span><span class="s">&#39;ss_len&#39;</span><span class="p">,</span> <span class="n">c_char</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;ss_family&#39;</span><span class="p">,</span> <span class="n">c_char</span><span class="p">),</span> <span class="c"># /usr/include/sys/_types.h; _uint8_t</span>
<span class="p">(</span><span class="s">&#39;__ss_pad1&#39;</span><span class="p">,</span> <span class="n">c_char</span> <span class="o">*</span> <span class="mi">6</span><span class="p">),</span> <span class="c"># (sizeof(int64) - sizeof(char) - sizeof(ss_family_t))</span>
<span class="p">(</span><span class="s">&#39;__ss_align&#39;</span><span class="p">,</span> <span class="n">c_longlong</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;__ss_pad2&#39;</span><span class="p">,</span> <span class="n">c_char</span> <span class="o">*</span> <span class="mi">112</span><span class="p">),</span> <span class="c"># (128(maxsize) - sizeof(char) - sizeof(ss_family_t) -</span>
<span class="c"># sizeof(ss_pad1) - sizeof(int64))</span>
<span class="p">]</span>
</div>
<div class="viewcode-block" id="kinfo_file"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.freebsd.kinfo_file">[docs]</a><span class="k">class</span> <span class="nc">kinfo_file</span><span class="p">(</span><span class="n">Structure</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;struct kinfo_file, defined in /usr/include/sys/user.h &quot;&quot;&quot;</span>
<span class="n">_fields_</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">(</span><span class="s">&#39;kf_structsize&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;kf_type&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;kf_fd&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;kf_ref_count&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;kf_flags&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;kf_offset&#39;</span><span class="p">,</span> <span class="n">c_size_t</span><span class="p">),</span> <span class="c"># this is a off_t, a pointer</span>
<span class="p">(</span><span class="s">&#39;kf_vnode_type&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;kf_sock_domain&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;kf_sock_type&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;kf_sock_protocol&#39;</span><span class="p">,</span> <span class="n">c_int</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;kf_path&#39;</span><span class="p">,</span> <span class="n">c_char</span> <span class="o">*</span> <span class="mi">1024</span><span class="p">),</span> <span class="c"># PATH_MAX</span>
<span class="p">(</span><span class="s">&#39;kf_sa_local&#39;</span><span class="p">,</span> <span class="n">sockaddr_storage</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;kf_sa_peer&#39;</span><span class="p">,</span> <span class="n">sockaddr_storage</span><span class="p">),</span>
<span class="p">]</span>
</div>
<span class="n">libc</span> <span class="o">=</span> <span class="n">CDLL</span><span class="p">(</span><span class="s">&#39;libc.so.7&#39;</span><span class="p">)</span>
<span class="n">uintlen</span> <span class="o">=</span> <span class="n">c_size_t</span><span class="p">(</span><span class="n">sizeof</span><span class="p">(</span><span class="n">c_uint</span><span class="p">))</span>
<span class="n">ver</span> <span class="o">=</span> <span class="n">c_uint</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="p">(</span><span class="n">libc</span><span class="o">.</span><span class="n">sysctlbyname</span><span class="p">(</span><span class="s">&#39;kern.osreldate&#39;</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">ver</span><span class="p">),</span> <span class="n">byref</span><span class="p">(</span><span class="n">uintlen</span><span class="p">),</span> <span class="bp">None</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">OSError</span><span class="p">,</span> <span class="s">&quot;sysctlbyname returned &lt; 0&quot;</span>
<span class="c"># kern.proc.filedesc added for procstat(1) after these __FreeBSD_versions</span>
<span class="k">if</span> <span class="n">ver</span><span class="o">.</span><span class="n">value</span> <span class="o">&lt;</span> <span class="mi">700104</span> <span class="ow">and</span> <span class="n">ver</span><span class="o">.</span><span class="n">value</span> <span class="o">&lt;</span> <span class="mi">800019</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">,</span> <span class="s">&quot;cwd detection requires a recent 7.0-STABLE or 8-CURRENT&quot;</span>
<div class="viewcode-block" id="get_process_cwd"><a class="viewcode-back" href="../../terminatorlib.html#terminatorlib.freebsd.get_process_cwd">[docs]</a><span class="k">def</span> <span class="nf">get_process_cwd</span><span class="p">(</span><span class="n">pid</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Return string containing the current working directory of the given pid,</span>
<span class="sd"> or None on failure.&quot;&quot;&quot;</span>
<span class="c"># /usr/include/sys/sysctl.h</span>
<span class="c"># CTL_KERN, KERN_PROC, KERN_PROC_FILEDESC</span>
<span class="n">oid</span> <span class="o">=</span> <span class="p">(</span><span class="n">c_uint</span> <span class="o">*</span> <span class="mi">4</span><span class="p">)(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">14</span><span class="p">,</span> <span class="mi">14</span><span class="p">,</span> <span class="n">pid</span><span class="p">)</span>
<span class="k">if</span> <span class="n">libc</span><span class="o">.</span><span class="n">sysctl</span><span class="p">(</span><span class="n">oid</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">uintlen</span><span class="p">),</span> <span class="bp">None</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">None</span>
<span class="n">buf</span> <span class="o">=</span> <span class="n">c_char_p</span><span class="p">(</span><span class="s">&quot; &quot;</span> <span class="o">*</span> <span class="n">uintlen</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="n">libc</span><span class="o">.</span><span class="n">sysctl</span><span class="p">(</span><span class="n">oid</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="n">buf</span><span class="p">,</span> <span class="n">byref</span><span class="p">(</span><span class="n">uintlen</span><span class="p">),</span> <span class="bp">None</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">None</span>
<span class="n">kifs</span> <span class="o">=</span> <span class="n">cast</span><span class="p">(</span><span class="n">buf</span><span class="p">,</span> <span class="n">POINTER</span><span class="p">(</span><span class="n">kinfo_file</span><span class="p">))</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">uintlen</span><span class="o">.</span><span class="n">value</span> <span class="o">/</span> <span class="n">sizeof</span><span class="p">(</span><span class="n">kinfo_file</span><span class="p">)):</span>
<span class="n">kif</span> <span class="o">=</span> <span class="n">kifs</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
<span class="k">if</span> <span class="n">kif</span><span class="o">.</span><span class="n">kf_fd</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span> <span class="c"># KF_FD_TYPE_CWD</span>
<span class="k">return</span> <span class="n">kif</span><span class="o">.</span><span class="n">kf_path</span>
</div>
<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&#39;__main__&#39;</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">sys</span>
<span class="k">print</span> <span class="s">&quot; =&gt; </span><span class="si">%d</span><span class="s"> cwd = </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getpid</span><span class="p">(),</span> <span class="n">get_process_cwd</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getpid</span><span class="p">()))</span>
<span class="k">for</span> <span class="n">pid</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</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="p">:</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">print</span> <span class="s">&quot; =&gt; </span><span class="si">%d</span><span class="s"> cwd = </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">get_process_cwd</span><span class="p">(</span><span class="n">pid</span><span class="p">))</span>
</pre></div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2015, Stephen Boddy, licensed under the CC-BY-SA..
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'0.98',
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/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>