--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>nepi.resources.netns.netnsbase — NEPI 3.0 documentation</title>
+
+ <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
+ <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../../',
+ VERSION: '3.0',
+ 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>
+ <link rel="top" title="NEPI 3.0 documentation" href="../../../../index.html" />
+ <link rel="up" title="Module code" href="../../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for nepi.resources.netns.netnsbase</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c"># NEPI, a framework to manage network experiments</span>
+<span class="c"># Copyright (C) 2014 INRIA</span>
+<span class="c">#</span>
+<span class="c"># This program is free software: you can redistribute it and/or modify</span>
+<span class="c"># it under the terms of the GNU General Public License version 2 as</span>
+<span class="c"># published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c"># This program is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
+<span class="c"># GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU General Public License</span>
+<span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
+<span class="c">#</span>
+<span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
+
+<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> \
+ <span class="n">ResourceState</span>
+<span class="kn">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Flags</span>
+<span class="kn">from</span> <span class="nn">nepi.execution.trace</span> <span class="kn">import</span> <span class="n">TraceAttr</span>
+
+<span class="nd">@clsinit_copy</span>
+<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>
+ <span class="n">_rtype</span> <span class="o">=</span> <span class="s">"abstract::netns::Object"</span>
+ <span class="n">_platform</span> <span class="o">=</span> <span class="s">"netns"</span>
+
+ <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>
+ <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>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_uuid</span> <span class="o">=</span> <span class="bp">None</span>
+ <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>
+ <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>
+
+ <span class="nd">@property</span>
+<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>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_connected</span>
+</div>
+ <span class="nd">@property</span>
+<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>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_uuid</span>
+</div>
+<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>
+ <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>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">filename</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s">"Can not resolve trace </span><span class="si">%s</span><span class="s">. Did you enabled it?"</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
+ <span class="k">return</span> <span class="s">""</span>
+
+ <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>
+</div>
+ <span class="nd">@property</span>
+ <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>
+ <span class="sd">""" Returns the collection of RMs that this RM needs to</span>
+<span class="sd"> wait for before start</span>
+
+<span class="sd"> This method should be overriden to wait for other</span>
+<span class="sd"> objects to be deployed before proceeding with the deployment</span>
+
+<span class="sd"> """</span>
+ <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">"No dependencies defined!"</span>
+
+ <span class="k">def</span> <span class="nf">_instantiate_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">pass</span>
+
+ <span class="k">def</span> <span class="nf">_wait_rms</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">rms</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
+ <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>
+ <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>
+ <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>
+
+ <span class="sd">""" Returns True if dependent RMs are not yer READY, False otherwise"""</span>
+ <span class="k">for</span> <span class="n">rm</span> <span class="ow">in</span> <span class="n">rms</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">rm</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>
+ <span class="k">return</span> <span class="bp">True</span>
+ <span class="k">return</span> <span class="bp">False</span>
+
+<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>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_instantiate_object</span><span class="p">()</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Provisioning finished"</span><span class="p">)</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">do_provision</span><span class="p">()</span>
+</div>
+<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>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wait_rms</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"---- RESCHEDULING DEPLOY ----"</span> <span class="p">)</span>
+ <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>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_ready</span><span class="p">()</span>
+</div>
+<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>
+ <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>
+ <span class="c"># No need to do anything, emulation.Run() will start every object</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Starting"</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_started</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">" Failed "</span>
+ <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>
+ <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
+</div>
+<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>
+ <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>
+ <span class="c"># No need to do anything, emulation.Destroy() will stop every object</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_stopped</span><span class="p">()</span>
+ </div>
+ <span class="nd">@property</span>
+<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>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_state</span>
+</div>
+<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>
+ <span class="c">#flags = Flags.NoWrite | Flags.NoRead | Flags.Design</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="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> \
+ <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>
+ <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>
+
+ <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>
+ <span class="k">return</span> <span class="n">value</span>
+</div>
+<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>
+ <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="k">if</span> <span class="p">(</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">NEW</span> <span class="ow">and</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="o">.</span><span class="n">Design</span><span class="p">))</span> <span class="ow">or</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="o">.</span><span class="n">NoWrite</span><span class="p">):</span>
+ <span class="n">out</span> <span class="o">=</span> <span class="n">err</span> <span class="o">=</span> <span class="s">""</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">" Cannot change Design only attribue </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">name</span>
+ <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>
+ <span class="k">return</span>
+
+ <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>
+ <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>
+
+ <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>
+
+ <span class="k">return</span> <span class="n">value</span>
+</pre></div></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
git://git.onelab.eu / nepi.git / blobdiff