update NEPI version on sphinx docs
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / ns3 / ns3wrapper.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6   <head>
7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8     
9     <title>nepi.resources.ns3.ns3wrapper &mdash; NEPI 3.2 documentation</title>
10     
11     <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
12     <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
13     
14     <script type="text/javascript">
15       var DOCUMENTATION_OPTIONS = {
16         URL_ROOT:    '../../../../',
17         VERSION:     '3.2',
18         COLLAPSE_INDEX: false,
19         FILE_SUFFIX: '.html',
20         HAS_SOURCE:  true
21       };
22     </script>
23     <script type="text/javascript" src="../../../../_static/jquery.js"></script>
24     <script type="text/javascript" src="../../../../_static/underscore.js"></script>
25     <script type="text/javascript" src="../../../../_static/doctools.js"></script>
26     <link rel="top" title="NEPI 3.2 documentation" href="../../../../index.html" />
27     <link rel="up" title="Module code" href="../../../index.html" /> 
28   </head>
29   <body>
30     <div class="related">
31       <h3>Navigation</h3>
32       <ul>
33         <li class="right" style="margin-right: 10px">
34           <a href="../../../../genindex.html" title="General Index"
35              accesskey="I">index</a></li>
36         <li class="right" >
37           <a href="../../../../py-modindex.html" title="Python Module Index"
38              >modules</a> |</li>
39         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
40           <li><a href="../../../index.html" accesskey="U">Module code</a> &raquo;</li> 
41       </ul>
42     </div>
43       <div class="sphinxsidebar">
44         <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
46   <h3>Quick search</h3>
47     <form class="search" action="../../../../search.html" method="get">
48       <input type="text" name="q" />
49       <input type="submit" value="Go" />
50       <input type="hidden" name="check_keywords" value="yes" />
51       <input type="hidden" name="area" value="default" />
52     </form>
53     <p class="searchtip" style="font-size: 90%">
54     Enter search terms or a module, class or function name.
55     </p>
56 </div>
57 <script type="text/javascript">$('#searchbox').show(0);</script>
58         </div>
59       </div>
60
61     <div class="document">
62       <div class="documentwrapper">
63         <div class="bodywrapper">
64           <div class="body">
65             
66   <h1>Source code for nepi.resources.ns3.ns3wrapper</h1><div class="highlight"><pre>
67 <span class="c">#</span>
68 <span class="c">#    NEPI, a framework to manage network experiments</span>
69 <span class="c">#    Copyright (C) 2013 INRIA</span>
70 <span class="c">#</span>
71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
73 <span class="c">#    published by the Free Software Foundation;</span>
74 <span class="c">#</span>
75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
78 <span class="c">#    GNU General Public License for more details.</span>
79 <span class="c">#</span>
80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
84
85 <span class="kn">import</span> <span class="nn">logging</span>
86 <span class="kn">import</span> <span class="nn">os</span>
87 <span class="kn">import</span> <span class="nn">sys</span>
88 <span class="kn">import</span> <span class="nn">threading</span>
89 <span class="kn">import</span> <span class="nn">time</span>
90 <span class="kn">import</span> <span class="nn">uuid</span>
91
92 <span class="n">SINGLETON</span> <span class="o">=</span> <span class="s">&quot;singleton::&quot;</span>
93 <span class="n">SIMULATOR_UUID</span> <span class="o">=</span> <span class="s">&quot;singleton::Simulator&quot;</span>
94 <span class="n">CONFIG_UUID</span> <span class="o">=</span> <span class="s">&quot;singleton::Config&quot;</span>
95 <span class="n">GLOBAL_VALUE_UUID</span> <span class="o">=</span> <span class="s">&quot;singleton::GlobalValue&quot;</span>
96 <span class="n">IPV4_GLOBAL_ROUTING_HELPER_UUID</span> <span class="o">=</span> <span class="s">&quot;singleton::Ipv4GlobalRoutingHelper&quot;</span>
97
98 <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>
99     <span class="kn">import</span> <span class="nn">ctypes</span>
100     <span class="kn">import</span> <span class="nn">re</span>
101
102     <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">&quot;NS3LIBRARIES&quot;</span><span class="p">)</span>
103
104     <span class="c"># Load the ns-3 modules shared libraries</span>
105     <span class="k">if</span> <span class="n">libdir</span><span class="p">:</span>
106         <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>
107         <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">&quot;(.*\.so)$&quot;</span><span class="p">)</span>
108         <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>
109
110         <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>
111         <span class="c"># Try to load the libraries in the right order by trial and error.</span>
112         <span class="c"># Loop until all libraries are loaded.</span>
113         <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">&gt;</span> <span class="mi">0</span><span class="p">:</span>
114             <span class="k">for</span> <span class="n">lib</span> <span class="ow">in</span> <span class="n">libs</span><span class="p">:</span>
115                 <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>
116                 <span class="k">try</span><span class="p">:</span>
117                     <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>
118                     <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>
119                 <span class="k">except</span><span class="p">:</span>
120                     <span class="c">#import traceback</span>
121                     <span class="c">#err = traceback.format_exc()</span>
122                     <span class="c">#print err</span>
123                     <span class="k">pass</span>
124
125             <span class="c"># if did not load any libraries in the last iteration break</span>
126             <span class="c"># to prevent infinit loop</span>
127             <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>
128                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Imposible to load shared libraries </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">libs</span><span class="p">))</span>
129             <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>
130 </div>
131 <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>
132     <span class="n">load_ns3_libraries</span><span class="p">()</span>
133
134     <span class="c"># import the python bindings for the ns-3 modules</span>
135     <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">&quot;NS3BINDINGS&quot;</span><span class="p">)</span>
136     <span class="k">if</span> <span class="n">bindings</span><span class="p">:</span>
137         <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>
138
139     <span class="kn">import</span> <span class="nn">pkgutil</span>
140     <span class="kn">import</span> <span class="nn">imp</span>
141     <span class="kn">import</span> <span class="nn">ns</span>
142
143     <span class="c"># create a Python module to add all ns3 classes</span>
144     <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">&quot;ns3&quot;</span><span class="p">)</span>
145     <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s">&quot;ns3&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ns3mod</span>
146
147     <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>
148         <span class="k">if</span> <span class="n">modname</span> <span class="ow">in</span> <span class="p">[</span> <span class="s">&quot;visualizer&quot;</span> <span class="p">]:</span>
149             <span class="k">continue</span>
150
151         <span class="n">fullmodname</span> <span class="o">=</span> <span class="s">&quot;ns.</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">modname</span>
152         <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">&#39;*&#39;</span><span class="p">])</span>
153
154         <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>
155             <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">&quot;_&quot;</span><span class="p">):</span>
156                 <span class="k">continue</span>
157
158             <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>
159
160             <span class="c"># netanim.Config and lte.Config singleton overrides ns3::Config</span>
161             <span class="k">if</span> <span class="n">sattr</span> <span class="o">==</span> <span class="s">&quot;Config&quot;</span> <span class="ow">and</span> <span class="n">modname</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;netanim&#39;</span><span class="p">,</span> <span class="s">&#39;lte&#39;</span><span class="p">]:</span>
162                 <span class="n">sattr</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">.</span><span class="si">%s</span><span class="s">&quot;</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>
163
164             <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>
165
166     <span class="k">return</span> <span class="n">ns3mod</span>
167 </div>
168 <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>
169     <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>
170         <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>
171         <span class="c"># Thread used to run the simulation</span>
172         <span class="bp">self</span><span class="o">.</span><span class="n">_simulation_thread</span> <span class="o">=</span> <span class="bp">None</span>
173         <span class="bp">self</span><span class="o">.</span><span class="n">_condition</span> <span class="o">=</span> <span class="bp">None</span>
174
175         <span class="c"># True if Simulator::Run was invoked</span>
176         <span class="bp">self</span><span class="o">.</span><span class="n">_started</span> <span class="o">=</span> <span class="bp">False</span>
177
178         <span class="c"># holds reference to all C++ objects and variables in the simulation</span>
179         <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>
180
181         <span class="c"># Logging</span>
182         <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">&quot;ns3wrapper&quot;</span><span class="p">)</span>
183         <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>
184
185         <span class="c">## NOTE that the reason to create a handler to the ns3 module,</span>
186         <span class="c"># that is re-loaded each time a ns-3 wrapper is instantiated,</span>
187         <span class="c"># is that else each unit test for the ns3wrapper class would need</span>
188         <span class="c"># a separate file. Several ns3wrappers would be created in the </span>
189         <span class="c"># same unit test (single process), leading to inchorences in the </span>
190         <span class="c"># state of ns-3 global objects</span>
191         <span class="c">#</span>
192         <span class="c"># Handler to ns3 classes</span>
193         <span class="bp">self</span><span class="o">.</span><span class="n">_ns3</span> <span class="o">=</span> <span class="bp">None</span>
194
195         <span class="c"># Collection of allowed ns3 classes</span>
196         <span class="bp">self</span><span class="o">.</span><span class="n">_allowed_types</span> <span class="o">=</span> <span class="bp">None</span>
197
198         <span class="c"># Object to dump instructions to reproduce and debug experiment</span>
199         <span class="kn">from</span> <span class="nn">ns3wrapper_debug</span> <span class="kn">import</span> <span class="n">NS3WrapperDebuger</span>
200         <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>
201
202     <span class="nd">@property</span>
203 <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>
204         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_debuger</span>
205 </div>
206     <span class="nd">@property</span>
207 <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>
208         <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>
209             <span class="c"># load ns-3 libraries and bindings</span>
210             <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>
211
212         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ns3</span>
213 </div>
214     <span class="nd">@property</span>
215 <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>
216         <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>
217             <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>
218             <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>
219             
220             <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>
221             <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">&quot;ns3::Object&quot;</span><span class="p">)</span>
222
223             <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>
224                 <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>
225                 
226                 <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> \
227                         <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> \
228                         <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> 
229                     <span class="k">continue</span>
230
231                 <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>
232                 <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>
233         
234         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_allowed_types</span>
235 </div>
236     <span class="nd">@property</span>
237 <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>
238         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_logger</span>
239 </div>
240     <span class="nd">@property</span>
241 <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>
242         <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>
243 </div>
244     <span class="nd">@property</span>
245 <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>
246         <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>
247             <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>
248             <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>
249                 <span class="bp">self</span><span class="o">.</span><span class="n">_started</span> <span class="o">=</span> <span class="bp">True</span>
250
251         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_started</span>
252 </div>
253     <span class="nd">@property</span>
254 <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>
255         <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>
256 </div>
257 <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>
258         <span class="k">return</span> <span class="s">&quot;uuid</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">uuid</span><span class="o">.</span><span class="n">uuid4</span><span class="p">()</span>
259 </div>
260 <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>
261         <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>
262 </div>
263 <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>
264         <span class="sd">&quot;&quot;&quot; This method should be used to construct ns-3 objects</span>
265 <span class="sd">        that have a TypeId and related introspection information &quot;&quot;&quot;</span>
266
267         <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>
268             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Type </span><span class="si">%s</span><span class="s"> not supported&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">type_name</span><span class="p">)</span> 
269             <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>
270
271         <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>
272         
273         <span class="c">### DEBUG</span>
274         <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">&quot;FACTORY </span><span class="si">%s</span><span class="s">( </span><span class="si">%s</span><span class="s"> )&quot;</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>
275         
276         <span class="c">### DUMP</span>
277         <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>
278
279         <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>
280         <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>
281
282         <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>
283             <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>
284             <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>
285
286         <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>
287
288         <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>
289
290         <span class="c">### DEBUG</span>
291         <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">&quot;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"> )&quot;</span> <span class="o">%</span> <span class="p">(</span>
292             <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>
293  
294         <span class="k">return</span> <span class="n">uuid</span>
295 </div>
296 <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>
297         <span class="sd">&quot;&quot;&quot; This method should be used to construct ns-3 objects that</span>
298 <span class="sd">        do not have a TypeId (e.g. Values) &quot;&quot;&quot;</span>
299
300         <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>
301             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Type </span><span class="si">%s</span><span class="s"> not supported&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">clazzname</span><span class="p">)</span> 
302             <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>
303
304         <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>
305         
306         <span class="c">### DEBUG</span>
307         <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">&quot;CREATE </span><span class="si">%s</span><span class="s">( </span><span class="si">%s</span><span class="s"> )&quot;</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>
308     
309         <span class="c">### DUMP</span>
310         <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>
311
312         <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>
313  
314         <span class="c"># arguments starting with &#39;uuid&#39; identify ns-3 C++</span>
315         <span class="c"># objects and must be replaced by the actual object</span>
316         <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>
317        
318         <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>
319         
320         <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>
321
322         <span class="c">### DEBUG</span>
323         <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">&quot;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"> )&quot;</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> 
324             <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>
325
326         <span class="k">return</span> <span class="n">uuid</span>
327 </div>
328 <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>
329         <span class="c">### DEBUG</span>
330         <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">&quot;INVOKE </span><span class="si">%s</span><span class="s"> -&gt; </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"> ) &quot;</span> <span class="o">%</span> <span class="p">(</span>
331             <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>
332         <span class="c">########</span>
333
334         <span class="n">result</span> <span class="o">=</span> <span class="bp">None</span>
335         <span class="n">newuuid</span> <span class="o">=</span> <span class="bp">None</span>
336
337         <span class="k">if</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">&quot;isRunning&quot;</span><span class="p">:</span>
338             <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_running</span>
339
340         <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">&quot;isStarted&quot;</span><span class="p">:</span>
341             <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_started</span>
342
343         <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">&quot;isFinished&quot;</span><span class="p">:</span>
344             <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_finished</span>
345
346         <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">&quot;isAppRunning&quot;</span><span class="p">:</span>
347             <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>
348
349         <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">&quot;isAppStarted&quot;</span><span class="p">:</span>
350             <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>
351
352         <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">&quot;recvFD&quot;</span><span class="p">:</span>
353             <span class="c">### passFD operation binds to a different random socket </span>
354             <span class="c">### en every execution, so the socket name that could be</span>
355             <span class="c">### dumped to the debug script using dump_invoke is</span>
356             <span class="c">### not be valid accross debug executions.</span>
357             <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>
358
359         <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">&quot;addStaticRoute&quot;</span><span class="p">:</span>
360             <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>
361             
362             <span class="c">### DUMP - result is static, so will be dumped as plain text</span>
363             <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>
364
365         <span class="k">elif</span> <span class="n">operation</span> <span class="o">==</span> <span class="s">&quot;retrieveObject&quot;</span><span class="p">:</span>
366             <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>
367        
368             <span class="c">### DUMP - result is static, so will be dumped as plain text</span>
369             <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>
370        
371         <span class="k">else</span><span class="p">:</span>
372             <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>
373
374             <span class="c">### DUMP - result is a uuid that encoded an dynamically generated </span>
375             <span class="c">### object</span>
376             <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>
377
378             <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>
379                 <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>
380             <span class="k">else</span><span class="p">:</span>
381                 <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>
382             
383             <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>
384
385             <span class="c"># arguments starting with &#39;uuid&#39; identify ns-3 C++</span>
386             <span class="c"># objects and must be replaced by the actual object</span>
387             <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>
388             <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>
389
390             <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>
391
392             <span class="c"># If the result is an object (not a base value),</span>
393             <span class="c"># then keep track of the object a return the object</span>
394             <span class="c"># reference (newuuid)</span>
395             <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>
396                     <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>
397                 <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>
398                 <span class="n">result</span> <span class="o">=</span> <span class="n">newuuid</span>
399
400         <span class="c">### DEBUG</span>
401         <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">&quot;RET INVOKE </span><span class="si">%s%s</span><span class="s"> = </span><span class="si">%s</span><span class="s"> -&gt; </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">) &quot;</span> <span class="o">%</span> <span class="p">(</span>
402             <span class="s">&quot;(uuid </span><span class="si">%s</span><span class="s">) &quot;</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">&quot;&quot;</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> 
403             <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>
404         <span class="c">########</span>
405
406         <span class="k">return</span> <span class="n">result</span>
407 </div>
408     <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>
409         <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>
410
411 <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>
412         <span class="c">### DEBUG</span>
413         <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">&quot;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">&quot;</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>
414     
415         <span class="c">### DUMP</span>
416         <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>
417
418         <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>
419         <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>
420         <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>
421
422         <span class="c"># If the Simulation thread is not running,</span>
423         <span class="c"># then there will be no thread-safety problems</span>
424         <span class="c"># in changing the value of an attribute directly.</span>
425         <span class="c"># However, if the simulation is running we need</span>
426         <span class="c"># to set the value by scheduling an event, else</span>
427         <span class="c"># we risk to corrupt the state of the</span>
428         <span class="c"># simulation.</span>
429         
430         <span class="n">event_executed</span> <span class="o">=</span> <span class="p">[</span><span class="bp">False</span><span class="p">]</span>
431
432         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_running</span><span class="p">:</span>
433             <span class="c"># schedule the event in the Simulator</span>
434             <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> 
435                     <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>
436
437         <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>
438             <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>
439
440         <span class="c">### DEBUG</span>
441         <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">&quot;RET SET </span><span class="si">%s</span><span class="s"> = </span><span class="si">%s</span><span class="s"> -&gt; set(</span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">)&quot;</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> 
442             <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)))</span>
443
444         <span class="k">return</span> <span class="n">value</span>
445 </div>
446     <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>
447         <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>
448
449 <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>
450         <span class="c">### DEBUG</span>
451         <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">&quot;GET </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">&quot;</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>
452         
453         <span class="c">### DUMP</span>
454         <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>
455
456         <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>
457         <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>
458         <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>
459
460         <span class="n">event_executed</span> <span class="o">=</span> <span class="p">[</span><span class="bp">False</span><span class="p">]</span>
461
462         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_running</span><span class="p">:</span>
463             <span class="c"># schedule the event in the Simulator</span>
464             <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>
465                     <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>
466
467         <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>
468             <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>
469
470         <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>
471
472         <span class="c">### DEBUG</span>
473         <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">&quot;RET GET </span><span class="si">%s</span><span class="s"> = </span><span class="si">%s</span><span class="s"> -&gt; get(</span><span class="si">%s</span><span class="s">)&quot;</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>
474
475         <span class="k">return</span> <span class="n">result</span>
476 </div>
477 <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>
478         <span class="c">### DUMP</span>
479         <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>
480
481         <span class="c"># Launch the simulator thread and Start the</span>
482         <span class="c"># simulator in that thread</span>
483         <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>
484         <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>
485                 <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>
486                 <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>
487         <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>
488         <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>
489         
490         <span class="c">### DEBUG</span>
491         <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">&quot;START&quot;</span><span class="p">)</span>
492 </div>
493 <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>
494         <span class="c">### DUMP</span>
495         <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>
496         
497         <span class="k">if</span> <span class="n">time</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
498             <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>
499         <span class="k">else</span><span class="p">:</span>
500             <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>
501
502         <span class="c">### DEBUG</span>
503         <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">&quot;STOP time=</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">time</span><span class="p">))</span>
504 </div>
505 <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>
506         <span class="c">### DUMP</span>
507         <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>
508
509         <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>
510             <span class="c">#self.logger.debug(&quot;Waiting for simulation to finish&quot;)</span>
511             <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>
512         
513         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_simulator_thread</span><span class="p">:</span>
514             <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>
515        
516         <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>
517         
518         <span class="c"># Remove all references to ns-3 objects</span>
519         <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>
520         
521         <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>
522         <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>
523
524         <span class="c">### DEBUG</span>
525         <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">&quot;SHUTDOWN&quot;</span><span class="p">)</span>
526 </div>
527     <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>
528         <span class="c"># Run simulation</span>
529         <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>
530         <span class="c"># Signal condition to indicate simulation ended and</span>
531         <span class="c"># notify waiting threads</span>
532         <span class="n">condition</span><span class="o">.</span><span class="n">acquire</span><span class="p">()</span>
533         <span class="n">condition</span><span class="o">.</span><span class="n">notifyAll</span><span class="p">()</span>
534         <span class="n">condition</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
535
536     <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>
537         <span class="sd">&quot;&quot;&quot; Schedules event on running simulation, and wait until</span>
538 <span class="sd">            event is executed&quot;&quot;&quot;</span>
539
540         <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>
541             <span class="k">try</span><span class="p">:</span>
542                 <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</span>
543                 <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>
544             <span class="k">finally</span><span class="p">:</span>
545                 <span class="c"># notify condition indicating event was executed</span>
546                 <span class="n">condition</span><span class="o">.</span><span class="n">acquire</span><span class="p">()</span>
547                 <span class="n">condition</span><span class="o">.</span><span class="n">notifyAll</span><span class="p">()</span>
548                 <span class="n">condition</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
549
550         <span class="c"># contextId is defined as general context</span>
551         <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>
552
553         <span class="c"># delay 0 means that the event is expected to execute inmediately</span>
554         <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>
555     
556         <span class="c"># Mark event as not executed</span>
557         <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>
558
559         <span class="n">condition</span><span class="o">.</span><span class="n">acquire</span><span class="p">()</span>
560         <span class="k">try</span><span class="p">:</span>
561             <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> 
562                     <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>
563             <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>
564                 <span class="n">condition</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
565         <span class="k">finally</span><span class="p">:</span>
566             <span class="n">condition</span><span class="o">.</span><span class="n">release</span><span class="p">()</span>
567
568     <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>
569         <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>
570         <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>
571         <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>
572         <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>
573             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;TypeId </span><span class="si">%s</span><span class="s"> has no attribute </span><span class="si">%s</span><span class="s">&quot;</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> 
574             <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>
575
576         <span class="n">checker</span> <span class="o">=</span> <span class="n">info</span><span class="o">.</span><span class="n">checker</span>
577         <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> 
578         <span class="k">return</span> <span class="n">ns3_value</span>
579
580     <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>
581         <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>
582         <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>
583         <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>
584         <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>
585             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;TypeId </span><span class="si">%s</span><span class="s"> has no attribute </span><span class="si">%s</span><span class="s">&quot;</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> 
586             <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>
587
588         <span class="n">checker</span> <span class="o">=</span> <span class="n">info</span><span class="o">.</span><span class="n">checker</span>
589         <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>
590
591         <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>
592         <span class="k">if</span> <span class="n">type_name</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&quot;ns3::UintegerValue&quot;</span><span class="p">,</span> <span class="s">&quot;ns3::IntegerValue&quot;</span><span class="p">]:</span>
593             <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
594         <span class="k">if</span> <span class="n">type_name</span> <span class="o">==</span> <span class="s">&quot;ns3::DoubleValue&quot;</span><span class="p">:</span>
595             <span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
596         <span class="k">if</span> <span class="n">type_name</span> <span class="o">==</span> <span class="s">&quot;ns3::BooleanValue&quot;</span><span class="p">:</span>
597             <span class="k">return</span> <span class="n">value</span> <span class="o">==</span> <span class="s">&quot;true&quot;</span>
598
599         <span class="k">return</span> <span class="n">value</span>
600
601     <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>
602         <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>
603         <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>
604         <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>
605         <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>
606             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;TypeId </span><span class="si">%s</span><span class="s"> has no attribute </span><span class="si">%s</span><span class="s">&quot;</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> 
607             <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>
608
609         <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>
610         <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>
611             <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>
612
613         <span class="n">checker</span> <span class="o">=</span> <span class="n">info</span><span class="o">.</span><span class="n">checker</span>
614         <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>
615         <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>
616         <span class="k">return</span> <span class="n">ns3_value</span>
617
618     <span class="c"># singletons are identified as &quot;ns3::ClassName&quot;</span>
619     <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>
620         <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>
621             <span class="k">return</span> <span class="bp">None</span>
622
623         <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">&quot;::&quot;</span><span class="p">)</span><span class="o">+</span><span class="mi">2</span><span class="p">:]</span>
624         <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>
625             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Type </span><span class="si">%s</span><span class="s"> not supported&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">clazzname</span><span class="p">)</span>
626             <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>
627
628         <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>
629
630     <span class="c"># replace uuids and singleton references for the real objects</span>
631 <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>
632         <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> \
633                 <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">&quot;uuid&quot;</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>
634  
635         <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> \
636                 <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>
637
638         <span class="k">return</span> <span class="n">realargs</span>
639
640     <span class="c"># replace uuids and singleton references for the real objects</span></div>
641 <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>
642         <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> \
643                 <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">&quot;uuid&quot;</span><span class="p">)</span> <span class="k">else</span> <span class="n">v</span><span class="p">)</span> \
644                 <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>
645  
646         <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> \
647                 <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>\
648                 <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>
649
650         <span class="k">return</span> <span class="n">realkwargs</span>
651 </div>
652     <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>
653         <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>
654         <span class="k">if</span> <span class="n">now</span><span class="o">.</span><span class="n">IsZero</span><span class="p">():</span>
655             <span class="k">return</span> <span class="bp">False</span>
656
657         <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>
658             <span class="k">return</span> <span class="bp">False</span>
659
660         <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>
661         <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>
662         <span class="n">app</span><span class="o">.</span><span class="n">GetAttribute</span><span class="p">(</span><span class="s">&quot;StopTime&quot;</span><span class="p">,</span> <span class="n">stop_time_value</span><span class="p">)</span>
663         <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>
664
665         <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>
666         <span class="n">app</span><span class="o">.</span><span class="n">GetAttribute</span><span class="p">(</span><span class="s">&quot;StartTime&quot;</span><span class="p">,</span> <span class="n">start_time_value</span><span class="p">)</span>
667         <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>
668         
669         <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">&gt;=</span> <span class="mi">0</span><span class="p">:</span>
670             <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">&lt;</span> <span class="mi">0</span><span class="p">:</span>
671                 <span class="k">return</span> <span class="bp">True</span>
672
673         <span class="k">return</span> <span class="bp">False</span>
674     
675     <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>
676         <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>
677
678     <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>
679         <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>
680
681         <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>
682         <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>
683
684         <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>
685         <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>
686             <span class="k">return</span> <span class="bp">False</span>
687         
688         <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>
689
690         <span class="k">if</span> <span class="n">network</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&quot;0.0.0.0&quot;</span><span class="p">,</span> <span class="s">&quot;0&quot;</span><span class="p">,</span> <span class="bp">None</span><span class="p">]:</span>
691             <span class="c"># Default route: 0.0.0.0/0</span>
692             <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>
693         <span class="k">else</span><span class="p">:</span>
694             <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">&quot;/</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">prefix</span><span class="p">)</span> 
695             <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>
696
697             <span class="k">if</span> <span class="n">prefix</span> <span class="o">==</span> <span class="mi">32</span><span class="p">:</span>
698                 <span class="c"># Host route: x.y.z.w/32</span>
699                 <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>
700             <span class="k">else</span><span class="p">:</span>
701                 <span class="c"># Network route: x.y.z.w/n</span>
702                 <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> 
703                         <span class="n">ifindex</span><span class="p">)</span> 
704         <span class="k">return</span> <span class="bp">True</span>
705
706     <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>
707         <span class="n">ifindex</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
708
709         <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>
710
711         <span class="c"># For all the interfaces registered with the ipv4 object, find</span>
712         <span class="c"># the one that matches the network of the nexthop</span>
713         <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>
714         <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>
715             <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>
716             <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>
717             <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>
718                 <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>
719                 <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>
720                 
721                 <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>
722
723                 <span class="k">if</span> <span class="n">ifindex</span> <span class="o">==</span> <span class="n">ifidx</span><span class="p">:</span>
724                     <span class="k">return</span> <span class="n">ifindex</span>
725         <span class="k">return</span> <span class="n">ifindex</span>
726
727     <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>
728         <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>
729
730         <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>
731         <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>
732         <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>
733
734         <span class="n">newuuid</span> <span class="o">=</span> <span class="bp">None</span>
735         <span class="k">if</span> <span class="n">search</span><span class="p">:</span>
736             <span class="c"># search object</span>
737             <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>
738                 <span class="k">if</span> <span class="n">nobj</span> <span class="o">==</span> <span class="n">oobj</span><span class="p">:</span>
739                     <span class="n">newuuid</span> <span class="o">=</span> <span class="n">ouuid</span>
740                     <span class="k">break</span>
741         <span class="k">else</span><span class="p">:</span> 
742             <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>
743             <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>
744
745         <span class="k">return</span> <span class="n">newuuid</span>
746
747     <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>
748         <span class="sd">&quot;&quot;&quot; Waits on a local address to receive a file descriptor</span>
749 <span class="sd">        from a local process. The file descriptor is associated</span>
750 <span class="sd">        to a FdNetDevice to stablish communication between the</span>
751 <span class="sd">        simulation and what ever process writes on that file descriptor</span>
752 <span class="sd">        &quot;&quot;&quot;</span>
753
754         <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>
755             <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>
756             <span class="c"># Store a reference to the endpoint to keep the socket alive</span>
757             <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>
758         
759         <span class="kn">import</span> <span class="nn">passfd</span>
760         <span class="kn">import</span> <span class="nn">socket</span>
761         <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>
762         <span class="n">sock</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s">&quot;&quot;</span><span class="p">)</span>
763         <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>
764         
765         <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>
766         <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>
767         <span class="n">t</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
768
769         <span class="k">return</span> <span class="n">address</span>
770 </pre></div></div>
771
772           </div>
773         </div>
774       </div>
775       <div class="clearer"></div>
776     </div>
777     <div class="related">
778       <h3>Navigation</h3>
779       <ul>
780         <li class="right" style="margin-right: 10px">
781           <a href="../../../../genindex.html" title="General Index"
782              >index</a></li>
783         <li class="right" >
784           <a href="../../../../py-modindex.html" title="Python Module Index"
785              >modules</a> |</li>
786         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
787           <li><a href="../../../index.html" >Module code</a> &raquo;</li> 
788       </ul>
789     </div>
790     <div class="footer">
791         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
792       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
793     </div>
794   </body>
795 </html>