doc/sphinx/_build/html/_modules/nepi/resources/linux/mtr.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>nepi.resources.linux.mtr &mdash; NEPI 3.2 documentation</title>
  10
  11     <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
  12     <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
  13
  14     <script type="text/javascript">
  15       var DOCUMENTATION_OPTIONS = {
  16         URL_ROOT:    '../../../../',
  17         VERSION:     '3.2',
  18         COLLAPSE_INDEX: false,
  19         FILE_SUFFIX: '.html',
  20         HAS_SOURCE:  true
  21       };
  22     </script>
  23     <script type="text/javascript" src="../../../../_static/jquery.js"></script>
  24     <script type="text/javascript" src="../../../../_static/underscore.js"></script>
  25     <script type="text/javascript" src="../../../../_static/doctools.js"></script>
  26     <link rel="top" title="NEPI 3.2 documentation" href="../../../../index.html" />
  27     <link rel="up" title="Module code" href="../../../index.html" />
  28   </head>
  29   <body>
  30     <div class="related">
  31       <h3>Navigation</h3>
  32       <ul>
  33         <li class="right" style="margin-right: 10px">
  34           <a href="../../../../genindex.html" title="General Index"
  35              accesskey="I">index</a></li>
  36         <li class="right" >
  37           <a href="../../../../py-modindex.html" title="Python Module Index"
  38              >modules</a> |</li>
  39         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
  40           <li><a href="../../../index.html" accesskey="U">Module code</a> &raquo;</li>
  41       </ul>
  42     </div>
  43       <div class="sphinxsidebar">
  44         <div class="sphinxsidebarwrapper">
  45 <div id="searchbox" style="display: none">
  46   <h3>Quick search</h3>
  47     <form class="search" action="../../../../search.html" method="get">
  48       <input type="text" name="q" />
  49       <input type="submit" value="Go" />
  50       <input type="hidden" name="check_keywords" value="yes" />
  51       <input type="hidden" name="area" value="default" />
  52     </form>
  53     <p class="searchtip" style="font-size: 90%">
  54     Enter search terms or a module, class or function name.
  55     </p>
  56 </div>
  57 <script type="text/javascript">$('#searchbox').show(0);</script>
  58         </div>
  59       </div>
  60
  61     <div class="document">
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <h1>Source code for nepi.resources.linux.mtr</h1><div class="highlight"><pre>
  67 <span class="c">#</span>
  68 <span class="c">#    NEPI, a framework to manage network experiments</span>
  69 <span class="c">#    Copyright (C) 2013 INRIA</span>
  70 <span class="c">#</span>
  71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
  72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
  73 <span class="c">#    published by the Free Software Foundation;</span>
  74 <span class="c">#</span>
  75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
  76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  78 <span class="c">#    GNU General Public License for more details.</span>
  79 <span class="c">#</span>
  80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
  81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  82 <span class="c">#</span>
  83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
  84
  85 <span class="kn">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Attribute</span><span class="p">,</span> <span class="n">Flags</span><span class="p">,</span> <span class="n">Types</span>
  86 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">clsinit_copy</span><span class="p">,</span> <span class="n">ResourceState</span>
  87 <span class="kn">from</span> <span class="nn">nepi.resources.linux.application</span> <span class="kn">import</span> <span class="n">LinuxApplication</span>
  88 <span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span>
  89
  90 <span class="kn">import</span> <span class="nn">os</span>
  91
  92 <span class="nd">@clsinit_copy</span>
  93 <div class="viewcode-block" id="LinuxMtr"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.mtr.LinuxMtr">[docs]</a><span class="k">class</span> <span class="nc">LinuxMtr</span><span class="p">(</span><span class="n">LinuxApplication</span><span class="p">):</span>
  94     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;linux::Mtr&quot;</span>
  95
  96     <span class="nd">@classmethod</span>
  97     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
  98         <span class="n">report_cycles</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;reportCycles&quot;</span><span class="p">,</span>
  99             <span class="s">&quot;sets mtr --report-cycles (-c) option. Determines the number of &quot;</span>
 100             <span class="s">&quot;pings sent to determine both machines in the networks. Each &quot;</span>
 101             <span class="s">&quot;cycle lasts one sencond.&quot;</span><span class="p">,</span>
 102             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 103
 104         <span class="n">no_dns</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;noDns&quot;</span><span class="p">,</span>
 105             <span class="s">&quot;sets mtr --no-dns (-n) option. Forces mtr to display IPs intead of &quot;</span>
 106             <span class="s">&quot;trying to resolve to host names &quot;</span><span class="p">,</span>
 107             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
 108             <span class="n">default</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
 109             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 110
 111         <span class="n">address</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;address&quot;</span><span class="p">,</span>
 112             <span class="s">&quot;sets mtr --address (-a) option. Binds the socket to send outgoing &quot;</span>
 113             <span class="s">&quot;packets to the interface of the specified address, so that any &quot;</span>
 114             <span class="s">&quot;any packets are sent through this interface. &quot;</span><span class="p">,</span>
 115             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 116
 117         <span class="n">interval</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;interval&quot;</span><span class="p">,</span>
 118             <span class="s">&quot;sets mtr --interval (-i) option. Specifies the number of seconds &quot;</span>
 119             <span class="s">&quot;between ICMP ECHO requests. Default value is one second &quot;</span><span class="p">,</span>
 120             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 121
 122         <span class="n">countinuous</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;continuous&quot;</span><span class="p">,</span>
 123             <span class="s">&quot;Run mtr in a while loop&quot;</span><span class="p">,</span>
 124             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
 125             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 126             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 127
 128         <span class="n">print_timestamp</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;printTimestamp&quot;</span><span class="p">,</span>
 129             <span class="s">&quot;Print timestamp before running mtr&quot;</span><span class="p">,</span>
 130             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
 131             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 132             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 133
 134         <span class="n">target</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;target&quot;</span><span class="p">,</span>
 135             <span class="s">&quot;mtr target host (host that will be pinged)&quot;</span><span class="p">,</span>
 136             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 137
 138         <span class="n">early_start</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;earlyStart&quot;</span><span class="p">,</span>
 139             <span class="s">&quot;Start ping as early as deployment. &quot;</span><span class="p">,</span>
 140             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
 141             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 142             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
 143
 144         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">report_cycles</span><span class="p">)</span>
 145         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">no_dns</span><span class="p">)</span>
 146         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">address</span><span class="p">)</span>
 147         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">interval</span><span class="p">)</span>
 148         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">countinuous</span><span class="p">)</span>
 149         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">print_timestamp</span><span class="p">)</span>
 150         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>
 151         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">early_start</span><span class="p">)</span>
 152
 153     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
 154         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxMtr</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span>
 155         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;mtr-</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span>
 156         <span class="bp">self</span><span class="o">.</span><span class="n">_sudo_kill</span> <span class="o">=</span> <span class="bp">True</span>
 157
 158 <div class="viewcode-block" id="LinuxMtr.upload_start_command"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.mtr.LinuxMtr.upload_start_command">[docs]</a>    <span class="k">def</span> <span class="nf">upload_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 159         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxMtr</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">upload_start_command</span><span class="p">()</span>
 160
 161         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;earlyStart&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
 162             <span class="bp">self</span><span class="o">.</span><span class="n">_run_in_background</span><span class="p">()</span>
 163 </div>
 164 <div class="viewcode-block" id="LinuxMtr.do_deploy"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.mtr.LinuxMtr.do_deploy">[docs]</a>    <span class="k">def</span> <span class="nf">do_deploy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 165         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">):</span>
 166             <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_command</span><span class="p">)</span>
 167
 168         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;env&quot;</span><span class="p">):</span>
 169             <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;env&quot;</span><span class="p">,</span> <span class="s">&quot;PATH=$PATH:/usr/sbin/&quot;</span><span class="p">)</span>
 170
 171         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;depends&quot;</span><span class="p">):</span>
 172             <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;depends&quot;</span><span class="p">,</span> <span class="s">&quot;mtr&quot;</span><span class="p">)</span>
 173
 174         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxMtr</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_deploy</span><span class="p">()</span>
 175 </div>
 176 <div class="viewcode-block" id="LinuxMtr.do_start"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.mtr.LinuxMtr.do_start">[docs]</a>    <span class="k">def</span> <span class="nf">do_start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 177         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;earlyStart&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
 178             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span><span class="p">:</span>
 179                 <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">)</span>
 180                 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Starting command &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
 181
 182                 <span class="bp">self</span><span class="o">.</span><span class="n">set_started</span><span class="p">()</span>
 183             <span class="k">else</span><span class="p">:</span>
 184                 <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Failed to execute command &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">command</span>
 185                 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
 186                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 187         <span class="k">else</span><span class="p">:</span>
 188            <span class="nb">super</span><span class="p">(</span><span class="n">LinuxMtr</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_start</span><span class="p">()</span>
 189 </div>
 190     <span class="nd">@property</span>
 191     <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 192         <span class="n">args</span> <span class="o">=</span> <span class="p">[]</span>
 193         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;continuous&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
 194             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;while true; do &quot;</span><span class="p">)</span>
 195         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;printTimestamp&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
 196             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;&quot;&quot;echo &quot;`date +&#39;%Y%m</span><span class="si">%d</span><span class="s">%H%M%S&#39;`&quot;;&quot;&quot;&quot;</span><span class="p">)</span>
 197         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;sudo -S mtr --report&quot;</span><span class="p">)</span>
 198         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;reportCycles&quot;</span><span class="p">):</span>
 199             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-c </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;reportCycles&quot;</span><span class="p">))</span>
 200         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;noDns&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
 201             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-n&quot;</span><span class="p">)</span>
 202         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;address&quot;</span><span class="p">):</span>
 203             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-a </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;address&quot;</span><span class="p">))</span>
 204         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;target&quot;</span><span class="p">))</span>
 205         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;continuous&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
 206             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;; done &quot;</span><span class="p">)</span>
 207
 208         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
 209
 210         <span class="k">return</span> <span class="n">command</span>
 211
 212 <div class="viewcode-block" id="LinuxMtr.valid_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.mtr.LinuxMtr.valid_connection">[docs]</a>    <span class="k">def</span> <span class="nf">valid_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
 213         <span class="c"># TODO: Validate!</span>
 214         <span class="k">return</span> <span class="bp">True</span>
 215 </pre></div></div></div>
 216
 217           </div>
 218         </div>
 219       </div>
 220       <div class="clearer"></div>
 221     </div>
 222     <div class="related">
 223       <h3>Navigation</h3>
 224       <ul>
 225         <li class="right" style="margin-right: 10px">
 226           <a href="../../../../genindex.html" title="General Index"
 227              >index</a></li>
 228         <li class="right" >
 229           <a href="../../../../py-modindex.html" title="Python Module Index"
 230              >modules</a> |</li>
 231         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 232           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 233       </ul>
 234     </div>
 235     <div class="footer">
 236         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 237       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 238     </div>
 239   </body>
 240 </html>