doc/sphinx/_build/html/_modules/nepi/resources/linux/traceroute.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.traceroute &mdash; NEPI 3.0 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.0',
  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.0 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.0 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.traceroute</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 <span class="kn">import</span> <span class="nn">socket</span>
  92
  93 <span class="nd">@clsinit_copy</span>
  94 <div class="viewcode-block" id="LinuxTraceroute"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.traceroute.LinuxTraceroute">[docs]</a><span class="k">class</span> <span class="nc">LinuxTraceroute</span><span class="p">(</span><span class="n">LinuxApplication</span><span class="p">):</span>
  95     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;linux::Traceroute&quot;</span>
  96
  97     <span class="nd">@classmethod</span>
  98     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
  99         <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>
 100             <span class="s">&quot;Run traceroute in a while loop&quot;</span><span class="p">,</span>
 101             <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>
 102             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 103             <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>
 104
 105         <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>
 106             <span class="s">&quot;Print timestamp before running traceroute&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">False</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">use_ip</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;useIP&quot;</span><span class="p">,</span>
 112             <span class="s">&quot;Use the IP address instead of the host domain name. &quot;</span>
 113             <span class="s">&quot;Useful for environments were dns resolution problems occur &quot;</span>
 114             <span class="s">&quot;frequently&quot;</span><span class="p">,</span>
 115             <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>
 116             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 117             <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>
 118
 119         <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>
 120             <span class="s">&quot;Traceroute target host (host that will be pinged)&quot;</span><span class="p">,</span>
 121             <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>
 122
 123         <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>
 124             <span class="s">&quot;Start ping as early as deployment. &quot;</span><span class="p">,</span>
 125             <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>
 126             <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 127             <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>
 128
 129         <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>
 130         <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>
 131         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">use_ip</span><span class="p">)</span>
 132         <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>
 133         <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>
 134
 135     <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>
 136         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxTraceroute</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>
 137         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;traceroute-</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>
 138
 139 <div class="viewcode-block" id="LinuxTraceroute.upload_start_command"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.traceroute.LinuxTraceroute.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>
 140         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxTraceroute</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>
 141
 142         <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>
 143             <span class="bp">self</span><span class="o">.</span><span class="n">_run_in_background</span><span class="p">()</span>
 144 </div>
 145 <div class="viewcode-block" id="LinuxTraceroute.do_deploy"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.traceroute.LinuxTraceroute.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>
 146         <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>
 147             <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>
 148
 149         <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>
 150             <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;traceroute&quot;</span><span class="p">)</span>
 151
 152         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxTraceroute</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>
 153 </div>
 154 <div class="viewcode-block" id="LinuxTraceroute.do_start"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.traceroute.LinuxTraceroute.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>
 155         <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>
 156             <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>
 157                 <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>
 158                 <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>
 159
 160                 <span class="bp">self</span><span class="o">.</span><span class="n">set_started</span><span class="p">()</span>
 161             <span class="k">else</span><span class="p">:</span>
 162                 <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>
 163                 <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>
 164                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 165         <span class="k">else</span><span class="p">:</span>
 166            <span class="nb">super</span><span class="p">(</span><span class="n">LinuxTraceroute</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>
 167 </div>
 168     <span class="nd">@property</span>
 169     <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 170         <span class="n">args</span> <span class="o">=</span> <span class="p">[]</span>
 171         <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>
 172             <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>
 173         <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>
 174             <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>
 175         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;traceroute&quot;</span><span class="p">)</span>
 176
 177         <span class="n">target</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;target&quot;</span><span class="p">)</span>
 178         <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;useIP&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
 179             <span class="n">target</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">gethostbyname</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>
 180         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>
 181
 182         <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>
 183             <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;; sleep 2 ; done &quot;</span><span class="p">)</span>
 184
 185         <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>
 186
 187         <span class="k">return</span> <span class="n">command</span>
 188
 189 <div class="viewcode-block" id="LinuxTraceroute.valid_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.traceroute.LinuxTraceroute.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>
 190         <span class="c"># TODO: Validate!</span>
 191         <span class="k">return</span> <span class="bp">True</span>
 192 </pre></div></div></div>
 193
 194           </div>
 195         </div>
 196       </div>
 197       <div class="clearer"></div>
 198     </div>
 199     <div class="related">
 200       <h3>Navigation</h3>
 201       <ul>
 202         <li class="right" style="margin-right: 10px">
 203           <a href="../../../../genindex.html" title="General Index"
 204              >index</a></li>
 205         <li class="right" >
 206           <a href="../../../../py-modindex.html" title="Python Module Index"
 207              >modules</a> |</li>
 208         <li><a href="../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 209           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 210       </ul>
 211     </div>
 212     <div class="footer">
 213         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 214       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 215     </div>
 216   </body>
 217 </html>