doc/sphinx/_build/html/_modules/nepi/resources/netns/netnsapplication.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.netns.netnsapplication &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.netns.netnsapplication</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) 2014 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.resources.netns.netnsbase</span> <span class="kn">import</span> <span class="n">NetNSBase</span>
  87 <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>
  88
  89 <span class="kn">import</span> <span class="nn">shlex</span>
  90
  91 <span class="nd">@clsinit_copy</span>
  92 <div class="viewcode-block" id="NetNSApplication"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsapplication.NetNSApplication">[docs]</a><span class="k">class</span> <span class="nc">NetNSApplication</span><span class="p">(</span><span class="n">NetNSBase</span><span class="p">):</span>
  93     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;netns::Application&quot;</span>
  94
  95     <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>
  96         <span class="nb">super</span><span class="p">(</span><span class="n">NetNSApplication</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>
  97         <span class="bp">self</span><span class="o">.</span><span class="n">_traces</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
  98
  99     <span class="nd">@classmethod</span>
 100     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
 101         <span class="n">command</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">,</span> <span class="s">&quot;Command to execute&quot;</span><span class="p">,</span> <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>
 102         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
 103
 104     <span class="nd">@property</span>
 105 <div class="viewcode-block" id="NetNSApplication.emulation"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsapplication.NetNSApplication.emulation">[docs]</a>    <span class="k">def</span> <span class="nf">emulation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 106         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">emulation</span>
 107 </div>
 108     <span class="nd">@property</span>
 109 <div class="viewcode-block" id="NetNSApplication.node"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsapplication.NetNSApplication.node">[docs]</a>    <span class="k">def</span> <span class="nf">node</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 110         <span class="kn">from</span> <span class="nn">nepi.resources.netns.netnsnode</span> <span class="kn">import</span> <span class="n">NetNSNode</span>
 111         <span class="n">node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">NetNSNode</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
 112
 113         <span class="k">if</span> <span class="ow">not</span> <span class="n">node</span><span class="p">:</span>
 114             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Route not connected to Node!!&quot;</span>
 115             <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>
 116             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 117
 118         <span class="k">return</span> <span class="n">node</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
 119 </div>
 120     <span class="nd">@property</span>
 121     <span class="k">def</span> <span class="nf">_rms_to_wait</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 122         <span class="k">return</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="p">]</span>
 123
 124 <div class="viewcode-block" id="NetNSApplication.do_start"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsapplication.NetNSApplication.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>
 125         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">state</span> <span class="o">&lt;</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">STARTED</span><span class="p">:</span>
 126             <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;---- RESCHEDULING START ----&quot;</span> <span class="p">)</span>
 127             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">schedule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reschedule_delay</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">)</span>
 128         <span class="k">else</span><span class="p">:</span>
 129             <span class="bp">self</span><span class="o">.</span><span class="n">_configure_traces</span><span class="p">()</span>
 130
 131             <span class="n">command</span> <span class="o">=</span> <span class="n">shlex</span><span class="o">.</span><span class="n">split</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;command&quot;</span><span class="p">))</span>
 132             <span class="n">stdout</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_traces</span><span class="p">[</span><span class="s">&quot;stdout&quot;</span><span class="p">]</span>
 133             <span class="n">stderr</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_traces</span><span class="p">[</span><span class="s">&quot;stderr&quot;</span><span class="p">]</span>
 134             <span class="bp">self</span><span class="o">.</span><span class="n">_uuid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">uuid</span><span class="p">,</span>
 135                     <span class="s">&quot;Popen&quot;</span><span class="p">,</span> <span class="n">command</span><span class="p">,</span> <span class="n">stdout</span> <span class="o">=</span> <span class="n">stdout</span><span class="p">,</span>
 136                     <span class="n">stderr</span> <span class="o">=</span> <span class="n">stderr</span><span class="p">)</span>
 137
 138             <span class="nb">super</span><span class="p">(</span><span class="n">NetNSApplication</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>
 139             <span class="bp">self</span><span class="o">.</span><span class="n">_start_time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">start_time</span>
 140 </div>
 141     <span class="k">def</span> <span class="nf">_configure_traces</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 142         <span class="n">stdout</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">/</span><span class="si">%d</span><span class="s">.stdout&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">run_home</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">)</span>
 143         <span class="n">stderr</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">/</span><span class="si">%d</span><span class="s">.stderr&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">run_home</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">)</span>
 144         <span class="bp">self</span><span class="o">.</span><span class="n">_trace_filename</span><span class="p">[</span><span class="s">&quot;stdout&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">stdout</span>
 145         <span class="bp">self</span><span class="o">.</span><span class="n">_trace_filename</span><span class="p">[</span><span class="s">&quot;stderr&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">stderr</span>
 146         <span class="bp">self</span><span class="o">.</span><span class="n">_traces</span><span class="p">[</span><span class="s">&quot;stdout&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="s">&quot;open&quot;</span><span class="p">,</span> <span class="n">stdout</span><span class="p">,</span> <span class="s">&quot;w&quot;</span><span class="p">)</span>
 147         <span class="bp">self</span><span class="o">.</span><span class="n">_traces</span><span class="p">[</span><span class="s">&quot;stderr&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="s">&quot;open&quot;</span><span class="p">,</span> <span class="n">stderr</span><span class="p">,</span> <span class="s">&quot;w&quot;</span><span class="p">)</span>
 148
 149     <span class="nd">@property</span>
 150 <div class="viewcode-block" id="NetNSApplication.state"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsapplication.NetNSApplication.state">[docs]</a>    <span class="k">def</span> <span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 151         <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">STARTED</span><span class="p">:</span>
 152             <span class="n">retcode</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">uuid</span><span class="p">,</span> <span class="s">&quot;poll&quot;</span><span class="p">)</span>
 153
 154             <span class="k">if</span> <span class="n">retcode</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
 155                 <span class="k">if</span> <span class="n">retcode</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
 156                     <span class="bp">self</span><span class="o">.</span><span class="n">set_stopped</span><span class="p">()</span>
 157                 <span class="k">else</span><span class="p">:</span>
 158                     <span class="n">out</span> <span class="o">=</span> <span class="s">&quot;&quot;</span>
 159                     <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="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>
 160                     <span class="n">err</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s">&quot;stderr&quot;</span><span class="p">)</span>
 161                     <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>
 162                     <span class="bp">self</span><span class="o">.</span><span class="n">do_fail</span><span class="p">()</span>
 163
 164         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_state</span>
 165 </pre></div></div></div>
 166
 167           </div>
 168         </div>
 169       </div>
 170       <div class="clearer"></div>
 171     </div>
 172     <div class="related">
 173       <h3>Navigation</h3>
 174       <ul>
 175         <li class="right" style="margin-right: 10px">
 176           <a href="../../../../genindex.html" title="General Index"
 177              >index</a></li>
 178         <li class="right" >
 179           <a href="../../../../py-modindex.html" title="Python Module Index"
 180              >modules</a> |</li>
 181         <li><a href="../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 182           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 183       </ul>
 184     </div>
 185     <div class="footer">
 186         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 187       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 188     </div>
 189   </body>
 190 </html>