--- /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.ns3.ns3wrapper — NEPI 3.2 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.2',
+ 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.2 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.2 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.ns3.ns3wrapper</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) 2013 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">import</span> <span class="nn">logging</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">sys</span>
+<span class="kn">import</span> <span class="nn">threading</span>
+<span class="kn">import</span> <span class="nn">time</span>
+<span class="kn">import</span> <span class="nn">uuid</span>
+
+<span class="n">SINGLETON</span> <span class="o">=</span> <span class="s">"singleton::"</span>
+<span class="n">SIMULATOR_UUID</span> <span class="o">=</span> <span class="s">"singleton::Simulator"</span>
+<span class="n">CONFIG_UUID</span> <span class="o">=</span> <span class="s">"singleton::Config"</span>
+<span class="n">GLOBAL_VALUE_UUID</span> <span class="o">=</span> <span class="s">"singleton::GlobalValue"</span>
+<span class="n">IPV4_GLOBAL_ROUTING_HELPER_UUID</span> <span class="o">=</span> <span class="s">"singleton::Ipv4GlobalRoutingHelper"</span>
+
+<div class="viewcode-block" id="load_ns3_libraries"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.load_ns3_libraries">[docs]</a><span class="k">def</span> <span class="nf">load_ns3_libraries</span><span class="p">():</span>
+ <span class="kn">import</span> <span class="nn">ctypes</span>
+ <span class="kn">import</span> <span class="nn">re</span>
+
+ <span class="n">libdir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"NS3LIBRARIES"</span><span class="p">)</span>
+
+ <span class="c"># Load the ns-3 modules shared libraries</span>
+ <span class="k">if</span> <span class="n">libdir</span><span class="p">:</span>
+ <span class="n">files</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">libdir</span><span class="p">)</span>
+ <span class="n">regex</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">"(.*\.so)$"</span><span class="p">)</span>
+ <span class="n">libs</span> <span class="o">=</span> <span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">files</span> <span class="k">for</span> <span class="n">m</span> <span class="ow">in</span> <span class="p">[</span><span class="n">regex</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">filename</span><span class="p">)]</span> <span class="k">if</span> <span class="n">m</span><span class="p">]</span>
+
+ <span class="n">initial_size</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">libs</span><span class="p">)</span>
+ <span class="c"># Try to load the libraries in the right order by trial and error.</span>
+ <span class="c"># Loop until all libraries are loaded.</span>
+ <span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="n">libs</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">for</span> <span class="n">lib</span> <span class="ow">in</span> <span class="n">libs</span><span class="p">:</span>
+ <span class="n">libfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">libdir</span><span class="p">,</span> <span class="n">lib</span><span class="p">)</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">ctypes</span><span class="o">.</span><span class="n">CDLL</span><span class="p">(</span><span class="n">libfile</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="n">RTLD_GLOBAL</span><span class="p">)</span>
+ <span class="n">libs</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">lib</span><span class="p">)</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="c">#import traceback</span>
+ <span class="c">#err = traceback.format_exc()</span>
+ <span class="c">#print err</span>
+ <span class="k">pass</span>
+
+ <span class="c"># if did not load any libraries in the last iteration break</span>
+ <span class="c"># to prevent infinit loop</span>
+ <span class="k">if</span> <span class="n">initial_size</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">libs</span><span class="p">):</span>
+ <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">"Imposible to load shared libraries </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">libs</span><span class="p">))</span>
+ <span class="n">initial_size</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">libs</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="load_ns3_module"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.load_ns3_module">[docs]</a><span class="k">def</span> <span class="nf">load_ns3_module</span><span class="p">():</span>
+ <span class="n">load_ns3_libraries</span><span class="p">()</span>
+
+ <span class="c"># import the python bindings for the ns-3 modules</span>
+ <span class="n">bindings</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"NS3BINDINGS"</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">bindings</span><span class="p">:</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">bindings</span><span class="p">)</span>
+
+ <span class="kn">import</span> <span class="nn">pkgutil</span>
+ <span class="kn">import</span> <span class="nn">imp</span>
+ <span class="kn">import</span> <span class="nn">ns</span>
+
+ <span class="c"># create a Python module to add all ns3 classes</span>
+ <span class="n">ns3mod</span> <span class="o">=</span> <span class="n">imp</span><span class="o">.</span><span class="n">new_module</span><span class="p">(</span><span class="s">"ns3"</span><span class="p">)</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">"ns3"</span><span class="p">]</span> <span class="o">=</span> <span class="n">ns3mod</span>
+
+ <span class="k">for</span> <span class="n">importer</span><span class="p">,</span> <span class="n">modname</span><span class="p">,</span> <span class="n">ispkg</span> <span class="ow">in</span> <span class="n">pkgutil</span><span class="o">.</span><span class="n">iter_modules</span><span class="p">(</span><span class="n">ns</span><span class="o">.</span><span class="n">__path__</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">modname</span> <span class="ow">in</span> <span class="p">[</span> <span class="s">"visualizer"</span> <span class="p">]:</span>
+ <span class="k">continue</span>
+
+ <span class="n">fullmodname</span> <span class="o">=</span> <span class="s">"ns.</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">modname</span>
+ <span class="n">module</span> <span class="o">=</span> <span class="nb">__import__</span><span class="p">(</span><span class="n">fullmodname</span><span class="p">,</span> <span class="nb">globals</span><span class="p">(),</span> <span class="nb">locals</span><span class="p">(),</span> <span class="p">[</span><span class="s">'*'</span><span class="p">])</span>
+
+ <span class="k">for</span> <span class="n">sattr</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">module</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">sattr</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"_"</span><span class="p">):</span>
+ <span class="k">continue</span>
+
+ <span class="n">attr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">module</span><span class="p">,</span> <span class="n">sattr</span><span class="p">)</span>
+
+ <span class="c"># netanim.Config and lte.Config singleton overrides ns3::Config</span>
+ <span class="k">if</span> <span class="n">sattr</span> <span class="o">==</span> <span class="s">"Config"</span> <span class="ow">and</span> <span class="n">modname</span> <span class="ow">in</span> <span class="p">[</span><span class="s">'netanim'</span><span class="p">,</span> <span class="s">'lte'</span><span class="p">]:</span>
+ <span class="n">sattr</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s">.</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">modname</span><span class="p">,</span> <span class="n">sattr</span><span class="p">)</span>
+
+ <span class="nb">setattr</span><span class="p">(</span><span class="n">ns3mod</span><span class="p">,</span> <span class="n">sattr</span><span class="p">,</span> <span class="n">attr</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">ns3mod</span>
+</div>
+<div class="viewcode-block" id="NS3Wrapper"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper">[docs]</a><span class="k">class</span> <span class="nc">NS3Wrapper</span><span class="p">(</span><span class="nb">object</span><span class="p">):</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">loglevel</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">,</span> <span class="n">enable_dump</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
+ <span class="nb">super</span><span class="p">(</span><span class="n">NS3Wrapper</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="c"># Thread used to run the simulation</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_simulation_thread</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_condition</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c"># True if Simulator::Run was invoked</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_started</span> <span class="o">=</span> <span class="bp">False</span>
+
+ <span class="c"># holds reference to all C++ objects and variables in the simulation</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_objects</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+
+ <span class="c"># Logging</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s">"ns3wrapper"</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">loglevel</span><span class="p">)</span>
+
+ <span class="c">## NOTE that the reason to create a handler to the ns3 module,</span>
+ <span class="c"># that is re-loaded each time a ns-3 wrapper is instantiated,</span>
+ <span class="c"># is that else each unit test for the ns3wrapper class would need</span>
+ <span class="c"># a separate file. Several ns3wrappers would be created in the </span>
+ <span class="c"># same unit test (single process), leading to inchorences in the </span>
+ <span class="c"># state of ns-3 global objects</span>
+ <span class="c">#</span>
+ <span class="c"># Handler to ns3 classes</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_ns3</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c"># Collection of allowed ns3 classes</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_allowed_types</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="c"># Object to dump instructions to reproduce and debug experiment</span>
+ <span class="kn">from</span> <span class="nn">ns3wrapper_debug</span> <span class="kn">import</span> <span class="n">NS3WrapperDebuger</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_debuger</span> <span class="o">=</span> <span class="n">NS3WrapperDebuger</span><span class="p">(</span><span class="n">enabled</span> <span class="o">=</span> <span class="n">enable_dump</span><span class="p">)</span>
+
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="NS3Wrapper.debuger"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.debuger">[docs]</a> <span class="k">def</span> <span class="nf">debuger</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">_debuger</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="NS3Wrapper.ns3"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.ns3">[docs]</a> <span class="k">def</span> <span class="nf">ns3</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ns3</span><span class="p">:</span>
+ <span class="c"># load ns-3 libraries and bindings</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_ns3</span> <span class="o">=</span> <span class="n">load_ns3_module</span><span class="p">()</span>
+
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ns3</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="NS3Wrapper.allowed_types"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.allowed_types">[docs]</a> <span class="k">def</span> <span class="nf">allowed_types</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_allowed_types</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_allowed_types</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
+ <span class="n">type_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">TypeId</span><span class="p">()</span>
+
+ <span class="n">tid_count</span> <span class="o">=</span> <span class="n">type_id</span><span class="o">.</span><span class="n">GetRegisteredN</span><span class="p">()</span>
+ <span class="n">base</span> <span class="o">=</span> <span class="n">type_id</span><span class="o">.</span><span class="n">LookupByName</span><span class="p">(</span><span class="s">"ns3::Object"</span><span class="p">)</span>
+
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="n">tid_count</span><span class="p">):</span>
+ <span class="n">tid</span> <span class="o">=</span> <span class="n">type_id</span><span class="o">.</span><span class="n">GetRegistered</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">tid</span><span class="o">.</span><span class="n">MustHideFromDocumentation</span><span class="p">()</span> <span class="ow">or</span> \
+ <span class="ow">not</span> <span class="n">tid</span><span class="o">.</span><span class="n">HasConstructor</span><span class="p">()</span> <span class="ow">or</span> \
+ <span class="ow">not</span> <span class="n">tid</span><span class="o">.</span><span class="n">IsChildOf</span><span class="p">(</span><span class="n">base</span><span class="p">):</span>
+ <span class="k">continue</span>
+
+ <span class="n">type_name</span> <span class="o">=</span> <span class="n">tid</span><span class="o">.</span><span class="n">GetName</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_allowed_types</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">type_name</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_allowed_types</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="NS3Wrapper.logger"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.logger">[docs]</a> <span class="k">def</span> <span class="nf">logger</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">_logger</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="NS3Wrapper.is_running"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.is_running">[docs]</a> <span class="k">def</span> <span class="nf">is_running</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">is_started</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">IsFinished</span><span class="p">()</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="NS3Wrapper.is_started"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.is_started">[docs]</a> <span class="k">def</span> <span class="nf">is_started</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_started</span><span class="p">:</span>
+ <span class="n">now</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">Now</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">now</span><span class="o">.</span><span class="n">IsZero</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_started</span> <span class="o">=</span> <span class="bp">True</span>
+
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_started</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="NS3Wrapper.is_finished"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.is_finished">[docs]</a> <span class="k">def</span> <span class="nf">is_finished</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">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">IsFinished</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="NS3Wrapper.make_uuid"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.make_uuid">[docs]</a> <span class="k">def</span> <span class="nf">make_uuid</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s">"uuid</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="NS3Wrapper.get_object"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.get_object">[docs]</a> <span class="k">def</span> <span class="nf">get_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="NS3Wrapper.factory"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.factory">[docs]</a> <span class="k">def</span> <span class="nf">factory</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">type_name</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+ <span class="sd">""" This method should be used to construct ns-3 objects</span>
+<span class="sd"> that have a TypeId and related introspection information """</span>
+
+ <span class="k">if</span> <span class="n">type_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">allowed_types</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Type </span><span class="si">%s</span><span class="s"> not supported"</span> <span class="o">%</span> <span class="p">(</span><span class="n">type_name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</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">uuid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_uuid</span><span class="p">()</span>
+
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"FACTORY </span><span class="si">%s</span><span class="s">( </span><span class="si">%s</span><span class="s"> )"</span> <span class="o">%</span> <span class="p">(</span><span class="n">type_name</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)))</span>
+
+ <span class="c">### DUMP</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debuger</span><span class="o">.</span><span class="n">dump_factory</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="n">type_name</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
+
+ <span class="n">factory</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">ObjectFactory</span><span class="p">()</span>
+ <span class="n">factory</span><span class="o">.</span><span class="n">SetTypeId</span><span class="p">(</span><span class="n">type_name</span><span class="p">)</span>
+
+ <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
+ <span class="n">ns3_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_from_string_to_ns3_value</span><span class="p">(</span><span class="n">type_name</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">factory</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">ns3_value</span><span class="p">)</span>
+
+ <span class="n">obj</span> <span class="o">=</span> <span class="n">factory</span><span class="o">.</span><span class="n">Create</span><span class="p">()</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">_objects</span><span class="p">[</span><span class="n">uuid</span><span class="p">]</span> <span class="o">=</span> <span class="n">obj</span>
+
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"RET FACTORY ( uuid </span><span class="si">%s</span><span class="s"> ) </span><span class="si">%s</span><span class="s"> = </span><span class="si">%s</span><span class="s">( </span><span class="si">%s</span><span class="s"> )"</span> <span class="o">%</span> <span class="p">(</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">obj</span><span class="p">),</span> <span class="n">type_name</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)))</span>
+
+ <span class="k">return</span> <span class="n">uuid</span>
+</div>
+<div class="viewcode-block" id="NS3Wrapper.create"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">clazzname</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
+ <span class="sd">""" This method should be used to construct ns-3 objects that</span>
+<span class="sd"> do not have a TypeId (e.g. Values) """</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="p">,</span> <span class="n">clazzname</span><span class="p">):</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Type </span><span class="si">%s</span><span class="s"> not supported"</span> <span class="o">%</span> <span class="p">(</span><span class="n">clazzname</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</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">uuid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_uuid</span><span class="p">()</span>
+
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"CREATE </span><span class="si">%s</span><span class="s">( </span><span class="si">%s</span><span class="s"> )"</span> <span class="o">%</span> <span class="p">(</span><span class="n">clazzname</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">args</span><span class="p">)))</span>
+
+ <span class="c">### DUMP</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debuger</span><span class="o">.</span><span class="n">dump_create</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="n">clazzname</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
+
+ <span class="n">clazz</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="p">,</span> <span class="n">clazzname</span><span class="p">)</span>
+
+ <span class="c"># arguments starting with 'uuid' identify ns-3 C++</span>
+ <span class="c"># objects and must be replaced by the actual object</span>
+ <span class="n">realargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">replace_args</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
+
+ <span class="n">obj</span> <span class="o">=</span> <span class="n">clazz</span><span class="p">(</span><span class="o">*</span><span class="n">realargs</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">_objects</span><span class="p">[</span><span class="n">uuid</span><span class="p">]</span> <span class="o">=</span> <span class="n">obj</span>
+
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"RET CREATE ( uuid </span><span class="si">%s</span><span class="s"> ) </span><span class="si">%s</span><span class="s"> = </span><span class="si">%s</span><span class="s">( </span><span class="si">%s</span><span class="s"> )"</span> <span class="o">%</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="p">),</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">obj</span><span class="p">),</span> <span class="n">clazzname</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">args</span><span class="p">)))</span>
+
+ <span class="k">return</span> <span class="n">uuid</span>
+</div>
+<div class="viewcode-block" id="NS3Wrapper.invoke"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.invoke">[docs]</a> <span class="k">def</span> <span class="nf">invoke</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">operation</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"INVOKE </span><span class="si">%s</span><span class="s"> -> </span><span class="si">%s</span><span class="s">( </span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s"> ) "</span> <span class="o">%</span> <span class="p">(</span>
+ <span class="n">uuid</span><span class="p">,</span> <span class="n">operation</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">args</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)))</span>
+ <span class="c">########</span>
+
+ <span class="n">result</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="n">newuuid</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="k">if</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">"isRunning"</span><span class="p">:</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_running</span>
+
+ <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">"isStarted"</span><span class="p">:</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_started</span>
+
+ <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">"isFinished"</span><span class="p">:</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_finished</span>
+
+ <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">"isAppRunning"</span><span class="p">:</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_app_running</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
+
+ <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">"isAppStarted"</span><span class="p">:</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_app_started</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
+
+ <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">"recvFD"</span><span class="p">:</span>
+ <span class="c">### passFD operation binds to a different random socket </span>
+ <span class="c">### en every execution, so the socket name that could be</span>
+ <span class="c">### dumped to the debug script using dump_invoke is</span>
+ <span class="c">### not be valid accross debug executions.</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_recv_fd</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+
+ <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">"addStaticRoute"</span><span class="p">:</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_add_static_route</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span>
+
+ <span class="c">### DUMP - result is static, so will be dumped as plain text</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debuger</span><span class="o">.</span><span class="n">dump_invoke</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">operation</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
+
+ <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">"retrieveObject"</span><span class="p">:</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_retrieve_object</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+
+ <span class="c">### DUMP - result is static, so will be dumped as plain text</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debuger</span><span class="o">.</span><span class="n">dump_invoke</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">operation</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
+
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">newuuid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_uuid</span><span class="p">()</span>
+
+ <span class="c">### DUMP - result is a uuid that encoded an dynamically generated </span>
+ <span class="c">### object</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debuger</span><span class="o">.</span><span class="n">dump_invoke</span><span class="p">(</span><span class="n">newuuid</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">operation</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">uuid</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">SINGLETON</span><span class="p">):</span>
+ <span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_singleton</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
+
+ <span class="n">method</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">operation</span><span class="p">)</span>
+
+ <span class="c"># arguments starting with 'uuid' identify ns-3 C++</span>
+ <span class="c"># objects and must be replaced by the actual object</span>
+ <span class="n">realargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">replace_args</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
+ <span class="n">realkwargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">replace_kwargs</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
+
+ <span class="n">result</span> <span class="o">=</span> <span class="n">method</span><span class="p">(</span><span class="o">*</span><span class="n">realargs</span><span class="p">,</span> <span class="o">**</span><span class="n">realkwargs</span><span class="p">)</span>
+
+ <span class="c"># If the result is an object (not a base value),</span>
+ <span class="c"># then keep track of the object a return the object</span>
+ <span class="c"># reference (newuuid)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">result</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">or</span> <span class="nb">type</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> <span class="ow">in</span> <span class="p">[</span>
+ <span class="nb">bool</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="nb">long</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="nb">int</span><span class="p">]):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_objects</span><span class="p">[</span><span class="n">newuuid</span><span class="p">]</span> <span class="o">=</span> <span class="n">result</span>
+ <span class="n">result</span> <span class="o">=</span> <span class="n">newuuid</span>
+
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"RET INVOKE </span><span class="si">%s%s</span><span class="s"> = </span><span class="si">%s</span><span class="s"> -> </span><span class="si">%s</span><span class="s">(</span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">) "</span> <span class="o">%</span> <span class="p">(</span>
+ <span class="s">"(uuid </span><span class="si">%s</span><span class="s">) "</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">newuuid</span><span class="p">)</span> <span class="k">if</span> <span class="n">newuuid</span> <span class="k">else</span> <span class="s">""</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">result</span><span class="p">),</span> <span class="n">uuid</span><span class="p">,</span>
+ <span class="n">operation</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">args</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)))</span>
+ <span class="c">########</span>
+
+ <span class="k">return</span> <span class="n">result</span>
+</div>
+ <span class="k">def</span> <span class="nf">_set_attr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">ns3_value</span><span class="p">):</span>
+ <span class="n">obj</span><span class="o">.</span><span class="n">SetAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">ns3_value</span><span class="p">)</span>
+
+<div class="viewcode-block" id="NS3Wrapper.set"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.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">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="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"SET </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
+
+ <span class="c">### DUMP</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debuger</span><span class="o">.</span><span class="n">dump_set</span><span class="p">(</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">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
+ <span class="n">type_name</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">GetInstanceTypeId</span><span class="p">()</span><span class="o">.</span><span class="n">GetName</span><span class="p">()</span>
+ <span class="n">ns3_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_from_string_to_ns3_value</span><span class="p">(</span><span class="n">type_name</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="c"># If the Simulation thread is not running,</span>
+ <span class="c"># then there will be no thread-safety problems</span>
+ <span class="c"># in changing the value of an attribute directly.</span>
+ <span class="c"># However, if the simulation is running we need</span>
+ <span class="c"># to set the value by scheduling an event, else</span>
+ <span class="c"># we risk to corrupt the state of the</span>
+ <span class="c"># simulation.</span>
+
+ <span class="n">event_executed</span> <span class="o">=</span> <span class="p">[</span><span class="bp">False</span><span class="p">]</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_running</span><span class="p">:</span>
+ <span class="c"># schedule the event in the Simulator</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_schedule_event</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_condition</span><span class="p">,</span> <span class="n">event_executed</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_set_attr</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">ns3_value</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">event_executed</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_set_attr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">ns3_value</span><span class="p">)</span>
+
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"RET SET </span><span class="si">%s</span><span class="s"> = </span><span class="si">%s</span><span class="s"> -> set(</span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span>
+ <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
+
+ <span class="k">return</span> <span class="n">value</span>
+</div>
+ <span class="k">def</span> <span class="nf">_get_attr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">ns3_value</span><span class="p">):</span>
+ <span class="n">obj</span><span class="o">.</span><span class="n">GetAttribute</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">ns3_value</span><span class="p">)</span>
+
+<div class="viewcode-block" id="NS3Wrapper.get"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.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">uuid</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"GET </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
+
+ <span class="c">### DUMP</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debuger</span><span class="o">.</span><span class="n">dump_get</span><span class="p">(</span><span class="n">uuid</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
+
+ <span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
+ <span class="n">type_name</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">GetInstanceTypeId</span><span class="p">()</span><span class="o">.</span><span class="n">GetName</span><span class="p">()</span>
+ <span class="n">ns3_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_create_attr_ns3_value</span><span class="p">(</span><span class="n">type_name</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
+
+ <span class="n">event_executed</span> <span class="o">=</span> <span class="p">[</span><span class="bp">False</span><span class="p">]</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_running</span><span class="p">:</span>
+ <span class="c"># schedule the event in the Simulator</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_schedule_event</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_condition</span><span class="p">,</span> <span class="n">event_executed</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_get_attr</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">ns3_value</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">event_executed</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_get_attr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">ns3_value</span><span class="p">)</span>
+
+ <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_from_ns3_value_to_string</span><span class="p">(</span><span class="n">type_name</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">ns3_value</span><span class="p">)</span>
+
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"RET GET </span><span class="si">%s</span><span class="s"> = </span><span class="si">%s</span><span class="s"> -> get(</span><span class="si">%s</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">result</span><span class="p">),</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
+
+ <span class="k">return</span> <span class="n">result</span>
+</div>
+<div class="viewcode-block" id="NS3Wrapper.start"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="c">### DUMP</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debuger</span><span class="o">.</span><span class="n">dump_start</span><span class="p">()</span>
+
+ <span class="c"># Launch the simulator thread and Start the</span>
+ <span class="c"># simulator in that thread</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_condition</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Condition</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_simulator_thread</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">(</span>
+ <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_simulator_run</span><span class="p">,</span>
+ <span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_condition</span><span class="p">])</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_simulator_thread</span><span class="o">.</span><span class="n">setDaemon</span><span class="p">(</span><span class="bp">True</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_simulator_thread</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
+
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"START"</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="NS3Wrapper.stop"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">time</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="c">### DUMP</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debuger</span><span class="o">.</span><span class="n">dump_stop</span><span class="p">(</span><span class="n">time</span><span class="o">=</span><span class="n">time</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">time</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">Stop</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">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">Stop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Time</span><span class="p">(</span><span class="n">time</span><span class="p">))</span>
+
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"STOP time=</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">time</span><span class="p">))</span>
+</div>
+<div class="viewcode-block" id="NS3Wrapper.shutdown"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.shutdown">[docs]</a> <span class="k">def</span> <span class="nf">shutdown</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="c">### DUMP</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">debuger</span><span class="o">.</span><span class="n">dump_shutdown</span><span class="p">()</span>
+
+ <span class="k">while</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">IsFinished</span><span class="p">():</span>
+ <span class="c">#self.logger.debug("Waiting for simulation to finish")</span>
+ <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.5</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_simulator_thread</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_simulator_thread</span><span class="o">.</span><span class="n">join</span><span class="p">()</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">Destroy</span><span class="p">()</span>
+
+ <span class="c"># Remove all references to ns-3 objects</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_objects</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
+
+ <span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+ <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+
+ <span class="c">### DEBUG</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"SHUTDOWN"</span><span class="p">)</span>
+</div>
+ <span class="k">def</span> <span class="nf">_simulator_run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">condition</span><span class="p">):</span>
+ <span class="c"># Run simulation</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">Run</span><span class="p">()</span>
+ <span class="c"># Signal condition to indicate simulation ended and</span>
+ <span class="c"># notify waiting threads</span>
+ <span class="n">condition</span><span class="o">.</span><span class="n">acquire</span><span class="p">()</span>
+ <span class="n">condition</span><span class="o">.</span><span class="n">notifyAll</span><span class="p">()</span>
+ <span class="n">condition</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
+
+ <span class="k">def</span> <span class="nf">_schedule_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">condition</span><span class="p">,</span> <span class="n">event_executed</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
+ <span class="sd">""" Schedules event on running simulation, and wait until</span>
+<span class="sd"> event is executed"""</span>
+
+ <span class="k">def</span> <span class="nf">execute_event</span><span class="p">(</span><span class="n">contextId</span><span class="p">,</span> <span class="n">condition</span><span class="p">,</span> <span class="n">event_executed</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</span>
+ <span class="n">event_executed</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">finally</span><span class="p">:</span>
+ <span class="c"># notify condition indicating event was executed</span>
+ <span class="n">condition</span><span class="o">.</span><span class="n">acquire</span><span class="p">()</span>
+ <span class="n">condition</span><span class="o">.</span><span class="n">notifyAll</span><span class="p">()</span>
+ <span class="n">condition</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
+
+ <span class="c"># contextId is defined as general context</span>
+ <span class="n">contextId</span> <span class="o">=</span> <span class="nb">long</span><span class="p">(</span><span class="mh">0xffffffff</span><span class="p">)</span>
+
+ <span class="c"># delay 0 means that the event is expected to execute inmediately</span>
+ <span class="n">delay</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Seconds</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+
+ <span class="c"># Mark event as not executed</span>
+ <span class="n">event_executed</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="bp">False</span>
+
+ <span class="n">condition</span><span class="o">.</span><span class="n">acquire</span><span class="p">()</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">ScheduleWithContext</span><span class="p">(</span><span class="n">contextId</span><span class="p">,</span> <span class="n">delay</span><span class="p">,</span> <span class="n">execute_event</span><span class="p">,</span>
+ <span class="n">condition</span><span class="p">,</span> <span class="n">event_executed</span><span class="p">,</span> <span class="n">func</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">IsFinished</span><span class="p">():</span>
+ <span class="n">condition</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
+ <span class="k">finally</span><span class="p">:</span>
+ <span class="n">condition</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
+
+ <span class="k">def</span> <span class="nf">_create_attr_ns3_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">type_name</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
+ <span class="n">TypeId</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">TypeId</span><span class="p">()</span>
+ <span class="n">tid</span> <span class="o">=</span> <span class="n">TypeId</span><span class="o">.</span><span class="n">LookupByName</span><span class="p">(</span><span class="n">type_name</span><span class="p">)</span>
+ <span class="n">info</span> <span class="o">=</span> <span class="n">TypeId</span><span class="o">.</span><span class="n">AttributeInformation</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">tid</span><span class="o">.</span><span class="n">LookupAttributeByName</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">info</span><span class="p">):</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"TypeId </span><span class="si">%s</span><span class="s"> has no attribute </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">type_name</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</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">checker</span> <span class="o">=</span> <span class="n">info</span><span class="o">.</span><span class="n">checker</span>
+ <span class="n">ns3_value</span> <span class="o">=</span> <span class="n">checker</span><span class="o">.</span><span class="n">Create</span><span class="p">()</span>
+ <span class="k">return</span> <span class="n">ns3_value</span>
+
+ <span class="k">def</span> <span class="nf">_attr_from_ns3_value_to_string</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">type_name</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">ns3_value</span><span class="p">):</span>
+ <span class="n">TypeId</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">TypeId</span><span class="p">()</span>
+ <span class="n">tid</span> <span class="o">=</span> <span class="n">TypeId</span><span class="o">.</span><span class="n">LookupByName</span><span class="p">(</span><span class="n">type_name</span><span class="p">)</span>
+ <span class="n">info</span> <span class="o">=</span> <span class="n">TypeId</span><span class="o">.</span><span class="n">AttributeInformation</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">tid</span><span class="o">.</span><span class="n">LookupAttributeByName</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">info</span><span class="p">):</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"TypeId </span><span class="si">%s</span><span class="s"> has no attribute </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">type_name</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</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">checker</span> <span class="o">=</span> <span class="n">info</span><span class="o">.</span><span class="n">checker</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="n">ns3_value</span><span class="o">.</span><span class="n">SerializeToString</span><span class="p">(</span><span class="n">checker</span><span class="p">)</span>
+
+ <span class="n">type_name</span> <span class="o">=</span> <span class="n">checker</span><span class="o">.</span><span class="n">GetValueTypeName</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">type_name</span> <span class="ow">in</span> <span class="p">[</span><span class="s">"ns3::UintegerValue"</span><span class="p">,</span> <span class="s">"ns3::IntegerValue"</span><span class="p">]:</span>
+ <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">type_name</span> <span class="o">==</span> <span class="s">"ns3::DoubleValue"</span><span class="p">:</span>
+ <span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">type_name</span> <span class="o">==</span> <span class="s">"ns3::BooleanValue"</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">value</span> <span class="o">==</span> <span class="s">"true"</span>
+
+ <span class="k">return</span> <span class="n">value</span>
+
+ <span class="k">def</span> <span class="nf">_attr_from_string_to_ns3_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">type_name</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">TypeId</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">TypeId</span><span class="p">()</span>
+ <span class="n">tid</span> <span class="o">=</span> <span class="n">TypeId</span><span class="o">.</span><span class="n">LookupByName</span><span class="p">(</span><span class="n">type_name</span><span class="p">)</span>
+ <span class="n">info</span> <span class="o">=</span> <span class="n">TypeId</span><span class="o">.</span><span class="n">AttributeInformation</span><span class="p">()</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">tid</span><span class="o">.</span><span class="n">LookupAttributeByName</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">info</span><span class="p">):</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"TypeId </span><span class="si">%s</span><span class="s"> has no attribute </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">type_name</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</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">str_value</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
+ <span class="n">str_value</span> <span class="o">=</span> <span class="n">str_value</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
+
+ <span class="n">checker</span> <span class="o">=</span> <span class="n">info</span><span class="o">.</span><span class="n">checker</span>
+ <span class="n">ns3_value</span> <span class="o">=</span> <span class="n">checker</span><span class="o">.</span><span class="n">Create</span><span class="p">()</span>
+ <span class="n">ns3_value</span><span class="o">.</span><span class="n">DeserializeFromString</span><span class="p">(</span><span class="n">str_value</span><span class="p">,</span> <span class="n">checker</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">ns3_value</span>
+
+ <span class="c"># singletons are identified as "ns3::ClassName"</span>
+ <span class="k">def</span> <span class="nf">_singleton</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ident</span><span class="p">):</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">ident</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">SINGLETON</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">None</span>
+
+ <span class="n">clazzname</span> <span class="o">=</span> <span class="n">ident</span><span class="p">[</span><span class="n">ident</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"::"</span><span class="p">)</span><span class="o">+</span><span class="mi">2</span><span class="p">:]</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="p">,</span> <span class="n">clazzname</span><span class="p">):</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Type </span><span class="si">%s</span><span class="s"> not supported"</span> <span class="o">%</span> <span class="p">(</span><span class="n">clazzname</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">logger</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="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="p">,</span> <span class="n">clazzname</span><span class="p">)</span>
+
+ <span class="c"># replace uuids and singleton references for the real objects</span>
+<div class="viewcode-block" id="NS3Wrapper.replace_args"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.replace_args">[docs]</a> <span class="k">def</span> <span class="nf">replace_args</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
+ <span class="n">realargs</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span> <span class="k">if</span> \
+ <span class="nb">str</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"uuid"</span><span class="p">)</span> <span class="k">else</span> <span class="n">arg</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">]</span>
+
+ <span class="n">realargs</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_singleton</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span> <span class="k">if</span> \
+ <span class="nb">str</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">SINGLETON</span><span class="p">)</span> <span class="k">else</span> <span class="n">arg</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">realargs</span><span class="p">]</span>
+
+ <span class="k">return</span> <span class="n">realargs</span>
+
+ <span class="c"># replace uuids and singleton references for the real objects</span></div>
+<div class="viewcode-block" id="NS3Wrapper.replace_kwargs"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3wrapper.NS3Wrapper.replace_kwargs">[docs]</a> <span class="k">def</span> <span class="nf">replace_kwargs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">):</span>
+ <span class="n">realkwargs</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([(</span><span class="n">k</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> \
+ <span class="k">if</span> <span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"uuid"</span><span class="p">)</span> <span class="k">else</span> <span class="n">v</span><span class="p">)</span> \
+ <span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">iteritems</span><span class="p">()])</span>
+
+ <span class="n">realkwargs</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">([(</span><span class="n">k</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_singleton</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> \
+ <span class="k">if</span> <span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">)</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">SINGLETON</span><span class="p">)</span> <span class="k">else</span> <span class="n">v</span> <span class="p">)</span>\
+ <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">realkwargs</span><span class="o">.</span><span class="n">iteritems</span><span class="p">()])</span>
+
+ <span class="k">return</span> <span class="n">realkwargs</span>
+</div>
+ <span class="k">def</span> <span class="nf">_is_app_running</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
+ <span class="n">now</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">Now</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">now</span><span class="o">.</span><span class="n">IsZero</span><span class="p">():</span>
+ <span class="k">return</span> <span class="bp">False</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Simulator</span><span class="o">.</span><span class="n">IsFinished</span><span class="p">():</span>
+ <span class="k">return</span> <span class="bp">False</span>
+
+ <span class="n">app</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
+ <span class="n">stop_time_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">TimeValue</span><span class="p">()</span>
+ <span class="n">app</span><span class="o">.</span><span class="n">GetAttribute</span><span class="p">(</span><span class="s">"StopTime"</span><span class="p">,</span> <span class="n">stop_time_value</span><span class="p">)</span>
+ <span class="n">stop_time</span> <span class="o">=</span> <span class="n">stop_time_value</span><span class="o">.</span><span class="n">Get</span><span class="p">()</span>
+
+ <span class="n">start_time_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">TimeValue</span><span class="p">()</span>
+ <span class="n">app</span><span class="o">.</span><span class="n">GetAttribute</span><span class="p">(</span><span class="s">"StartTime"</span><span class="p">,</span> <span class="n">start_time_value</span><span class="p">)</span>
+ <span class="n">start_time</span> <span class="o">=</span> <span class="n">start_time_value</span><span class="o">.</span><span class="n">Get</span><span class="p">()</span>
+
+ <span class="k">if</span> <span class="n">now</span><span class="o">.</span><span class="n">Compare</span><span class="p">(</span><span class="n">start_time</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">stop_time</span><span class="o">.</span><span class="n">IsZero</span><span class="p">()</span> <span class="ow">or</span> <span class="n">now</span><span class="o">.</span><span class="n">Compare</span><span class="p">(</span><span class="n">stop_time</span><span class="p">)</span> <span class="o"><</span> <span class="mi">0</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>
+
+ <span class="k">def</span> <span class="nf">_is_app_started</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_app_running</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_finished</span>
+
+ <span class="k">def</span> <span class="nf">_add_static_route</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ipv4_uuid</span><span class="p">,</span> <span class="n">network</span><span class="p">,</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">nexthop</span><span class="p">):</span>
+ <span class="n">ipv4</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">ipv4_uuid</span><span class="p">)</span>
+
+ <span class="n">list_routing</span> <span class="o">=</span> <span class="n">ipv4</span><span class="o">.</span><span class="n">GetRoutingProtocol</span><span class="p">()</span>
+ <span class="p">(</span><span class="n">static_routing</span><span class="p">,</span> <span class="n">priority</span><span class="p">)</span> <span class="o">=</span> <span class="n">list_routing</span><span class="o">.</span><span class="n">GetRoutingProtocol</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+
+ <span class="n">ifindex</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_find_ifindex</span><span class="p">(</span><span class="n">ipv4</span><span class="p">,</span> <span class="n">nexthop</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">ifindex</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">False</span>
+
+ <span class="n">nexthop</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Ipv4Address</span><span class="p">(</span><span class="n">nexthop</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">network</span> <span class="ow">in</span> <span class="p">[</span><span class="s">"0.0.0.0"</span><span class="p">,</span> <span class="s">"0"</span><span class="p">,</span> <span class="bp">None</span><span class="p">]:</span>
+ <span class="c"># Default route: 0.0.0.0/0</span>
+ <span class="n">static_routing</span><span class="o">.</span><span class="n">SetDefaultRoute</span><span class="p">(</span><span class="n">nexthop</span><span class="p">,</span> <span class="n">ifindex</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">mask</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Ipv4Mask</span><span class="p">(</span><span class="s">"/</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">prefix</span><span class="p">)</span>
+ <span class="n">network</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Ipv4Address</span><span class="p">(</span><span class="n">network</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">prefix</span> <span class="o">==</span> <span class="mi">32</span><span class="p">:</span>
+ <span class="c"># Host route: x.y.z.w/32</span>
+ <span class="n">static_routing</span><span class="o">.</span><span class="n">AddHostRouteTo</span><span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">nexthop</span><span class="p">,</span> <span class="n">ifindex</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># Network route: x.y.z.w/n</span>
+ <span class="n">static_routing</span><span class="o">.</span><span class="n">AddNetworkRouteTo</span><span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">nexthop</span><span class="p">,</span>
+ <span class="n">ifindex</span><span class="p">)</span>
+ <span class="k">return</span> <span class="bp">True</span>
+
+ <span class="k">def</span> <span class="nf">_find_ifindex</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ipv4</span><span class="p">,</span> <span class="n">nexthop</span><span class="p">):</span>
+ <span class="n">ifindex</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
+
+ <span class="n">nexthop</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">Ipv4Address</span><span class="p">(</span><span class="n">nexthop</span><span class="p">)</span>
+
+ <span class="c"># For all the interfaces registered with the ipv4 object, find</span>
+ <span class="c"># the one that matches the network of the nexthop</span>
+ <span class="n">nifaces</span> <span class="o">=</span> <span class="n">ipv4</span><span class="o">.</span><span class="n">GetNInterfaces</span><span class="p">()</span>
+ <span class="k">for</span> <span class="n">ifidx</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="n">nifaces</span><span class="p">):</span>
+ <span class="n">iface</span> <span class="o">=</span> <span class="n">ipv4</span><span class="o">.</span><span class="n">GetInterface</span><span class="p">(</span><span class="n">ifidx</span><span class="p">)</span>
+ <span class="n">naddress</span> <span class="o">=</span> <span class="n">iface</span><span class="o">.</span><span class="n">GetNAddresses</span><span class="p">()</span>
+ <span class="k">for</span> <span class="n">addridx</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="n">naddress</span><span class="p">):</span>
+ <span class="n">ifaddr</span> <span class="o">=</span> <span class="n">iface</span><span class="o">.</span><span class="n">GetAddress</span><span class="p">(</span><span class="n">addridx</span><span class="p">)</span>
+ <span class="n">ifmask</span> <span class="o">=</span> <span class="n">ifaddr</span><span class="o">.</span><span class="n">GetMask</span><span class="p">()</span>
+
+ <span class="n">ifindex</span> <span class="o">=</span> <span class="n">ipv4</span><span class="o">.</span><span class="n">GetInterfaceForPrefix</span><span class="p">(</span><span class="n">nexthop</span><span class="p">,</span> <span class="n">ifmask</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">ifindex</span> <span class="o">==</span> <span class="n">ifidx</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">ifindex</span>
+ <span class="k">return</span> <span class="n">ifindex</span>
+
+ <span class="k">def</span> <span class="nf">_retrieve_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">typeid</span><span class="p">,</span> <span class="n">search</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
+ <span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
+
+ <span class="n">type_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns3</span><span class="o">.</span><span class="n">TypeId</span><span class="p">()</span>
+ <span class="n">tid</span> <span class="o">=</span> <span class="n">type_id</span><span class="o">.</span><span class="n">LookupByName</span><span class="p">(</span><span class="n">typeid</span><span class="p">)</span>
+ <span class="n">nobj</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">GetObject</span><span class="p">(</span><span class="n">tid</span><span class="p">)</span>
+
+ <span class="n">newuuid</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">if</span> <span class="n">search</span><span class="p">:</span>
+ <span class="c"># search object</span>
+ <span class="k">for</span> <span class="n">ouuid</span><span class="p">,</span> <span class="n">oobj</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_objects</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
+ <span class="k">if</span> <span class="n">nobj</span> <span class="o">==</span> <span class="n">oobj</span><span class="p">:</span>
+ <span class="n">newuuid</span> <span class="o">=</span> <span class="n">ouuid</span>
+ <span class="k">break</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">newuuid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_uuid</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_objects</span><span class="p">[</span><span class="n">newuuid</span><span class="p">]</span> <span class="o">=</span> <span class="n">nobj</span>
+
+ <span class="k">return</span> <span class="n">newuuid</span>
+
+ <span class="k">def</span> <span class="nf">_recv_fd</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">uuid</span><span class="p">):</span>
+ <span class="sd">""" Waits on a local address to receive a file descriptor</span>
+<span class="sd"> from a local process. The file descriptor is associated</span>
+<span class="sd"> to a FdNetDevice to stablish communication between the</span>
+<span class="sd"> simulation and what ever process writes on that file descriptor</span>
+<span class="sd"> """</span>
+
+ <span class="k">def</span> <span class="nf">recvfd</span><span class="p">(</span><span class="n">sock</span><span class="p">,</span> <span class="n">fdnd</span><span class="p">):</span>
+ <span class="p">(</span><span class="n">fd</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span> <span class="o">=</span> <span class="n">passfd</span><span class="o">.</span><span class="n">recvfd</span><span class="p">(</span><span class="n">sock</span><span class="p">)</span>
+ <span class="c"># Store a reference to the endpoint to keep the socket alive</span>
+ <span class="n">fdnd</span><span class="o">.</span><span class="n">SetFileDescriptor</span><span class="p">(</span><span class="n">fd</span><span class="p">)</span>
+
+ <span class="kn">import</span> <span class="nn">passfd</span>
+ <span class="kn">import</span> <span class="nn">socket</span>
+ <span class="n">sock</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">socket</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_UNIX</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">SOCK_DGRAM</span><span class="p">)</span>
+ <span class="n">sock</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s">""</span><span class="p">)</span>
+ <span class="n">address</span> <span class="o">=</span> <span class="n">sock</span><span class="o">.</span><span class="n">getsockname</span><span class="p">()</span>
+
+ <span class="n">fdnd</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">(</span><span class="n">uuid</span><span class="p">)</span>
+ <span class="n">t</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">(</span><span class="n">target</span><span class="o">=</span><span class="n">recvfd</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="n">sock</span><span class="p">,</span><span class="n">fdnd</span><span class="p">))</span>
+ <span class="n">t</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
+
+ <span class="k">return</span> <span class="n">address</span>
+</pre></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.2 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