1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>nepi.resources.linux.ns3.tuntapfdlink — NEPI 3.2 documentation</title>
11 <link rel="stylesheet" href="../../../../../_static/sphinxdoc.css" type="text/css" />
12 <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: '../../../../../',
18 COLLAPSE_INDEX: false,
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" />
33 <li class="right" style="margin-right: 10px">
34 <a href="../../../../../genindex.html" title="General Index"
35 accesskey="I">index</a></li>
37 <a href="../../../../../py-modindex.html" title="Python Module Index"
39 <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> »</li>
40 <li><a href="../../../../index.html" accesskey="U">Module code</a> »</li>
43 <div class="sphinxsidebar">
44 <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
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" />
53 <p class="searchtip" style="font-size: 90%">
54 Enter search terms or a module, class or function name.
57 <script type="text/javascript">$('#searchbox').show(0);</script>
61 <div class="document">
62 <div class="documentwrapper">
63 <div class="bodywrapper">
66 <h1>Source code for nepi.resources.linux.ns3.tuntapfdlink</h1><div class="highlight"><pre>
67 <span class="c">#</span>
68 <span class="c"># NEPI, a framework to manage network experiments</span>
69 <span class="c"># Copyright (C) 2014 INRIA</span>
70 <span class="c">#</span>
71 <span class="c"># This program is free software: you can redistribute it and/or modify</span>
72 <span class="c"># it under the terms of the GNU General Public License version 2 as</span>
73 <span class="c"># published by the Free Software Foundation;</span>
74 <span class="c">#</span>
75 <span class="c"># This program is distributed in the hope that it will be useful,</span>
76 <span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
77 <span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
78 <span class="c"># GNU General Public License for more details.</span>
79 <span class="c">#</span>
80 <span class="c"># You should have received a copy of the GNU General Public License</span>
81 <span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
84 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">ResourceState</span><span class="p">,</span> <span class="n">clsinit_copy</span>
85 <span class="kn">from</span> <span class="nn">nepi.resources.linux.application</span> <span class="kn">import</span> <span class="n">LinuxApplication</span>
87 <span class="kn">import</span> <span class="nn">base64</span>
88 <span class="kn">import</span> <span class="nn">fcntl</span>
89 <span class="kn">import</span> <span class="nn">os</span>
90 <span class="kn">import</span> <span class="nn">socket</span>
91 <span class="kn">import</span> <span class="nn">struct</span>
93 <span class="nd">@clsinit_copy</span>
94 <div class="viewcode-block" id="LinuxTunTapFdLink"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink">[docs]</a><span class="k">class</span> <span class="nc">LinuxTunTapFdLink</span><span class="p">(</span><span class="n">LinuxApplication</span><span class="p">):</span>
95 <span class="sd">""" Interconnects a TAP or TUN Linux device to a FdNetDevice</span>
96 <span class="sd"> """</span>
97 <span class="n">_rtype</span> <span class="o">=</span> <span class="s">"linux::ns3::TunTapFdLink"</span>
99 <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
100 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxTunTapFdLink</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span>
101 <span class="bp">self</span><span class="o">.</span><span class="n">_tap</span> <span class="o">=</span> <span class="bp">None</span>
102 <span class="bp">self</span><span class="o">.</span><span class="n">_fdnetdevice</span> <span class="o">=</span> <span class="bp">None</span>
103 <span class="bp">self</span><span class="o">.</span><span class="n">_fd_node</span> <span class="o">=</span> <span class="bp">None</span>
104 <span class="bp">self</span><span class="o">.</span><span class="n">send_address</span> <span class="o">=</span> <span class="bp">None</span>
105 <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">"tuntap-link-</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span>
107 <span class="nd">@property</span>
108 <div class="viewcode-block" id="LinuxTunTapFdLink.fdnetdevice"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink.fdnetdevice">[docs]</a> <span class="k">def</span> <span class="nf">fdnetdevice</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
109 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fdnetdevice</span><span class="p">:</span>
110 <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3fdnetdevice</span> <span class="kn">import</span> <span class="n">NS3BaseFdNetDevice</span>
111 <span class="n">devices</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">NS3BaseFdNetDevice</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
112 <span class="k">if</span> <span class="ow">not</span> <span class="n">devices</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">devices</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
113 <span class="n">msg</span> <span class="o">=</span> <span class="s">"TunTapFdLink must be connected to exactly one FdNetDevice"</span>
114 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
115 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
117 <span class="bp">self</span><span class="o">.</span><span class="n">_fdnetdevice</span> <span class="o">=</span> <span class="n">devices</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
119 <span class="n">simu</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fdnetdevice</span><span class="o">.</span><span class="n">simulation</span>
120 <span class="kn">from</span> <span class="nn">nepi.resources.linux.node</span> <span class="kn">import</span> <span class="n">LinuxNode</span>
121 <span class="n">nodes</span> <span class="o">=</span> <span class="n">simu</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">LinuxNode</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
122 <span class="bp">self</span><span class="o">.</span><span class="n">_fd_node</span> <span class="o">=</span> <span class="n">nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
124 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fdnetdevice</span>
126 <span class="nd">@property</span>
127 <div class="viewcode-block" id="LinuxTunTapFdLink.fdnode"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink.fdnode">[docs]</a> <span class="k">def</span> <span class="nf">fdnode</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
128 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fd_node</span>
130 <span class="nd">@property</span>
131 <div class="viewcode-block" id="LinuxTunTapFdLink.tap"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink.tap">[docs]</a> <span class="k">def</span> <span class="nf">tap</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
132 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tap</span><span class="p">:</span>
133 <span class="kn">from</span> <span class="nn">nepi.resources.linux.tap</span> <span class="kn">import</span> <span class="n">LinuxTap</span>
134 <span class="n">devices</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">LinuxTap</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
135 <span class="k">if</span> <span class="ow">not</span> <span class="n">devices</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">devices</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
136 <span class="n">msg</span> <span class="o">=</span> <span class="s">"TunTapLink must be connected to exactly one Tap or Tun"</span>
137 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
138 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
140 <span class="bp">self</span><span class="o">.</span><span class="n">_tap</span> <span class="o">=</span> <span class="n">devices</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
142 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tap</span>
144 <span class="nd">@property</span>
145 <div class="viewcode-block" id="LinuxTunTapFdLink.tapnode"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink.tapnode">[docs]</a> <span class="k">def</span> <span class="nf">tapnode</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
146 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">tap</span><span class="o">.</span><span class="n">node</span>
148 <span class="nd">@property</span>
149 <div class="viewcode-block" id="LinuxTunTapFdLink.node"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink.node">[docs]</a> <span class="k">def</span> <span class="nf">node</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
150 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">tapnode</span>
152 <div class="viewcode-block" id="LinuxTunTapFdLink.upload_sources"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink.upload_sources">[docs]</a> <span class="k">def</span> <span class="nf">upload_sources</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
153 <span class="n">scripts</span> <span class="o">=</span> <span class="p">[]</span>
155 <span class="c"># vif-passfd python script</span>
156 <span class="n">linux_passfd</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">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">__file__</span><span class="p">),</span>
157 <span class="s">".."</span><span class="p">,</span>
158 <span class="s">"scripts"</span><span class="p">,</span>
159 <span class="s">"linux-tap-passfd.py"</span><span class="p">)</span>
161 <span class="n">scripts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">linux_passfd</span><span class="p">)</span>
163 <span class="c"># Upload scripts</span>
164 <span class="n">scripts</span> <span class="o">=</span> <span class="s">";"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">scripts</span><span class="p">)</span>
166 <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">upload</span><span class="p">(</span><span class="n">scripts</span><span class="p">,</span>
167 <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="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">src_dir</span><span class="p">),</span>
168 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">False</span><span class="p">)</span>
170 <div class="viewcode-block" id="LinuxTunTapFdLink.upload_start_command"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink.upload_start_command">[docs]</a> <span class="k">def</span> <span class="nf">upload_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
171 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">tapnode</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"hostname"</span><span class="p">)</span> <span class="o">!=</span> \
172 <span class="bp">self</span><span class="o">.</span><span class="n">fdnode</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"hostname"</span><span class="p">):</span>
173 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Tap and FdNetDevice are not in the same host"</span>
174 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
175 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
177 <span class="bp">self</span><span class="o">.</span><span class="n">send_address</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fdnetdevice</span><span class="o">.</span><span class="n">recv_fd</span><span class="p">()</span>
178 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"command"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_command</span><span class="p">)</span>
180 <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"command"</span><span class="p">)</span>
182 <span class="n">shfile</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="bp">self</span><span class="o">.</span><span class="n">app_home</span><span class="p">,</span> <span class="s">"start.sh"</span><span class="p">)</span>
183 <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">run_and_wait</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">,</span>
184 <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
185 <span class="n">wait_run</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
186 <span class="n">overwrite</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
188 <div class="viewcode-block" id="LinuxTunTapFdLink.do_deploy"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink.do_deploy">[docs]</a> <span class="k">def</span> <span class="nf">do_deploy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
189 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">tap</span><span class="o">.</span><span class="n">state</span> <span class="o"><</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span> <span class="ow">or</span> \
190 <span class="bp">self</span><span class="o">.</span><span class="n">fdnetdevice</span><span class="o">.</span><span class="n">state</span> <span class="o"><</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span><span class="p">:</span>
191 <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"---- RESCHEDULING DEPLOY ---- "</span><span class="p">)</span>
192 <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">schedule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reschedule_delay</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">deploy</span><span class="p">)</span>
193 <span class="k">else</span><span class="p">:</span>
194 <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
195 <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
197 <span class="bp">self</span><span class="o">.</span><span class="n">set_ready</span><span class="p">()</span>
199 <div class="viewcode-block" id="LinuxTunTapFdLink.do_start"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.linux.ns3.html#nepi.resources.linux.ns3.tuntapfdlink.LinuxTunTapFdLink.do_start">[docs]</a> <span class="k">def</span> <span class="nf">do_start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
200 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span><span class="p">:</span>
201 <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"command"</span><span class="p">)</span>
202 <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">"Starting command '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
204 <span class="bp">self</span><span class="o">.</span><span class="n">set_started</span><span class="p">()</span>
205 <span class="k">else</span><span class="p">:</span>
206 <span class="n">msg</span> <span class="o">=</span> <span class="s">" Failed to execute command '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">command</span>
207 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
208 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
210 <span class="nd">@property</span>
211 <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
212 <span class="n">address</span> <span class="o">=</span> <span class="n">base64</span><span class="o">.</span><span class="n">b64encode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">send_address</span><span class="p">)</span>
214 <span class="n">command</span> <span class="o">=</span> <span class="p">[]</span>
215 <span class="c"># Use tap-passfd.py to send fd from TAP to FdNetDevice</span>
216 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"sudo -S"</span><span class="p">)</span>
217 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"PYTHONPATH=$PYTHONPATH:${SRC}"</span><span class="p">)</span>
218 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"python ${SRC}/linux-tap-passfd.py"</span><span class="p">)</span>
219 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"-a </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">address</span><span class="p">)</span>
220 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">"-S </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">tap</span><span class="o">.</span><span class="n">sock_name</span><span class="p">)</span>
222 <span class="n">command</span> <span class="o">=</span> <span class="s">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
223 <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">replace_paths</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
225 <span class="k">return</span> <span class="n">command</span>
231 <div class="clearer"></div>
233 <div class="related">
236 <li class="right" style="margin-right: 10px">
237 <a href="../../../../../genindex.html" title="General Index"
240 <a href="../../../../../py-modindex.html" title="Python Module Index"
242 <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> »</li>
243 <li><a href="../../../../index.html" >Module code</a> »</li>
247 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
248 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.