doc/sphinx/_build/html/_modules/nepi/resources/netns/netnsbase.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.netnsbase &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.netns.netnsbase</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.resource</span> <span class="kn">import</span> <span class="n">ResourceManager</span><span class="p">,</span> <span class="n">clsinit_copy</span><span class="p">,</span> \
  86         <span class="n">ResourceState</span>
  87 <span class="kn">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Flags</span>
  88 <span class="kn">from</span> <span class="nn">nepi.execution.trace</span> <span class="kn">import</span> <span class="n">TraceAttr</span>
  89
  90 <span class="nd">@clsinit_copy</span>
  91 <div class="viewcode-block" id="NetNSBase"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase">[docs]</a><span class="k">class</span> <span class="nc">NetNSBase</span><span class="p">(</span><span class="n">ResourceManager</span><span class="p">):</span>
  92     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;abstract::netns::Object&quot;</span>
  93     <span class="n">_platform</span> <span class="o">=</span> <span class="s">&quot;netns&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">NetNSBase</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">_uuid</span> <span class="o">=</span> <span class="bp">None</span>
  98         <span class="bp">self</span><span class="o">.</span><span class="n">_connected</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
  99         <span class="bp">self</span><span class="o">.</span><span class="n">_trace_filename</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
 100
 101     <span class="nd">@property</span>
 102 <div class="viewcode-block" id="NetNSBase.connected"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase.connected">[docs]</a>    <span class="k">def</span> <span class="nf">connected</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 103         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connected</span>
 104 </div>
 105     <span class="nd">@property</span>
 106 <div class="viewcode-block" id="NetNSBase.uuid"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase.uuid">[docs]</a>    <span class="k">def</span> <span class="nf">uuid</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 107         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_uuid</span>
 108 </div>
 109 <div class="viewcode-block" id="NetNSBase.trace"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase.trace">[docs]</a>    <span class="k">def</span> <span class="nf">trace</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">attr</span> <span class="o">=</span> <span class="n">TraceAttr</span><span class="o">.</span><span class="n">ALL</span><span class="p">,</span> <span class="n">block</span> <span class="o">=</span> <span class="mi">512</span><span class="p">,</span> <span class="n">offset</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
 110         <span class="n">filename</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_trace_filename</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 111         <span class="k">if</span> <span class="ow">not</span> <span class="n">filename</span><span class="p">:</span>
 112             <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s">&quot;Can not resolve trace </span><span class="si">%s</span><span class="s">. Did you enabled it?&quot;</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
 113             <span class="k">return</span> <span class="s">&quot;&quot;</span>
 114
 115         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">block</span><span class="p">,</span> <span class="n">offset</span><span class="p">)</span>
 116 </div>
 117     <span class="nd">@property</span>
 118     <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>
 119         <span class="sd">&quot;&quot;&quot; Returns the collection of RMs that this RM needs to</span>
 120 <span class="sd">        wait for before start</span>
 121
 122 <span class="sd">        This method should be overriden to wait for other</span>
 123 <span class="sd">        objects to be deployed before proceeding with the deployment</span>
 124
 125 <span class="sd">        &quot;&quot;&quot;</span>
 126         <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;No dependencies defined!&quot;</span>
 127
 128     <span class="k">def</span> <span class="nf">_instantiate_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 129         <span class="k">pass</span>
 130
 131     <span class="k">def</span> <span class="nf">_wait_rms</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 132         <span class="n">rms</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
 133         <span class="k">for</span> <span class="n">rm</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_rms_to_wait</span><span class="p">:</span>
 134             <span class="k">if</span> <span class="n">rm</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
 135                 <span class="n">rms</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">rm</span><span class="p">)</span>
 136
 137         <span class="sd">&quot;&quot;&quot; Returns True if dependent RMs are not yer READY, False otherwise&quot;&quot;&quot;</span>
 138         <span class="k">for</span> <span class="n">rm</span> <span class="ow">in</span> <span class="n">rms</span><span class="p">:</span>
 139             <span class="k">if</span> <span class="n">rm</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">READY</span><span class="p">:</span>
 140                 <span class="k">return</span> <span class="bp">True</span>
 141         <span class="k">return</span> <span class="bp">False</span>
 142
 143 <div class="viewcode-block" id="NetNSBase.do_provision"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase.do_provision">[docs]</a>    <span class="k">def</span> <span class="nf">do_provision</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 144         <span class="bp">self</span><span class="o">.</span><span class="n">_instantiate_object</span><span class="p">()</span>
 145
 146         <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Provisioning finished&quot;</span><span class="p">)</span>
 147
 148         <span class="nb">super</span><span class="p">(</span><span class="n">NetNSBase</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
 149 </div>
 150 <div class="viewcode-block" id="NetNSBase.do_deploy"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase.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>
 151         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wait_rms</span><span class="p">():</span>
 152             <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;---- RESCHEDULING DEPLOY ----&quot;</span> <span class="p">)</span>
 153             <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">deploy</span><span class="p">)</span>
 154         <span class="k">else</span><span class="p">:</span>
 155             <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
 156             <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
 157
 158             <span class="bp">self</span><span class="o">.</span><span class="n">set_ready</span><span class="p">()</span>
 159 </div>
 160 <div class="viewcode-block" id="NetNSBase.do_start"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase.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>
 161         <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>
 162             <span class="c"># No need to do anything, emulation.Run() will start every object</span>
 163             <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Starting&quot;</span><span class="p">)</span>
 164             <span class="bp">self</span><span class="o">.</span><span class="n">set_started</span><span class="p">()</span>
 165         <span class="k">else</span><span class="p">:</span>
 166             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Failed &quot;</span>
 167             <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>
 168             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 169 </div>
 170 <div class="viewcode-block" id="NetNSBase.do_stop"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase.do_stop">[docs]</a>    <span class="k">def</span> <span class="nf">do_stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 171         <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>
 172             <span class="c"># No need to do anything, emulation.Destroy() will stop every object</span>
 173             <span class="bp">self</span><span class="o">.</span><span class="n">set_stopped</span><span class="p">()</span>
 174     </div>
 175     <span class="nd">@property</span>
 176 <div class="viewcode-block" id="NetNSBase.state"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase.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>
 177         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_state</span>
 178 </div>
 179 <div class="viewcode-block" id="NetNSBase.get"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase.get">[docs]</a>    <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
 180         <span class="c">#flags = Flags.NoWrite | Flags.NoRead | Flags.Design</span>
 181         <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span>
 182         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_state</span> <span class="ow">in</span> <span class="p">[</span><span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span><span class="p">,</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">STARTED</span><span class="p">]</span> \
 183                 <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_flag</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">flags</span><span class="p">):</span>
 184             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">emu_get</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="n">name</span><span class="p">)</span>
 185
 186         <span class="n">value</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">NetNSBase</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
 187         <span class="k">return</span> <span class="n">value</span>
 188 </div>
 189 <div class="viewcode-block" id="NetNSBase.set"><a class="viewcode-back" href="../../../../_layout/nepi.resources.netns.html#nepi.resources.netns.netnsbase.NetNSBase.set">[docs]</a>    <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
 190         <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span>
 191         <span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_state</span> <span class="o">&gt;</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">NEW</span> <span class="ow">and</span> \
 192                 <span class="bp">self</span><span class="o">.</span><span class="n">has_flag</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">))</span> <span class="ow">or</span> \
 193                 <span class="bp">self</span><span class="o">.</span><span class="n">has_flag</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">Flags</span><span class="o">.</span><span class="n">NoWrite</span><span class="p">):</span>
 194             <span class="n">out</span> <span class="o">=</span> <span class="n">err</span> <span class="o">=</span> <span class="s">&quot;&quot;</span>
 195             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Cannot change Design only attribue </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">name</span>
 196             <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>
 197             <span class="k">return</span>
 198
 199         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_state</span> <span class="ow">in</span> <span class="p">[</span><span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span><span class="p">,</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">STARTED</span><span class="p">]:</span>
 200             <span class="bp">self</span><span class="o">.</span><span class="n">emulation</span><span class="o">.</span><span class="n">emu_set</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="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 201
 202         <span class="n">value</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">NetNSBase</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 203
 204         <span class="k">return</span> <span class="n">value</span>
 205 </pre></div></div></div>
 206
 207           </div>
 208         </div>
 209       </div>
 210       <div class="clearer"></div>
 211     </div>
 212     <div class="related">
 213       <h3>Navigation</h3>
 214       <ul>
 215         <li class="right" style="margin-right: 10px">
 216           <a href="../../../../genindex.html" title="General Index"
 217              >index</a></li>
 218         <li class="right" >
 219           <a href="../../../../py-modindex.html" title="Python Module Index"
 220              >modules</a> |</li>
 221         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 222           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 223       </ul>
 224     </div>
 225     <div class="footer">
 226         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 227       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 228     </div>
 229   </body>
 230 </html>