add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / planetlab / tap.html
diff --git a/doc/sphinx/_build/html/_modules/nepi/resources/planetlab/tap.html b/doc/sphinx/_build/html/_modules/nepi/resources/planetlab/tap.html
new file mode 100644 (file)
index 0000000..9b0791c
--- /dev/null
@@ -0,0 +1,413 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>nepi.resources.planetlab.tap &mdash; NEPI 3.0 documentation</title>
+    
+    <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
+    <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../../../',
+        VERSION:     '3.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../../../_static/doctools.js"></script>
+    <link rel="top" title="NEPI 3.0 documentation" href="../../../../index.html" />
+    <link rel="up" title="Module code" href="../../../index.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
+          <li><a href="../../../index.html" accesskey="U">Module code</a> &raquo;</li> 
+      </ul>
+    </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../../../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <h1>Source code for nepi.resources.planetlab.tap</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c">#    NEPI, a framework to manage network experiments</span>
+<span class="c">#    Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c">#    This program is free software: you can redistribute it and/or modify</span>
+<span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
+<span class="c">#    published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c">#    This program is distributed in the hope that it will be useful,</span>
+<span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
+<span class="c">#    GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c">#    You should have received a copy of the GNU General Public License</span>
+<span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
+<span class="c">#</span>
+<span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
+
+<span class="kn">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Attribute</span><span class="p">,</span> <span class="n">Flags</span><span class="p">,</span> <span class="n">Types</span>
+<span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">clsinit_copy</span><span class="p">,</span> <span class="n">ResourceState</span> 
+<span class="kn">from</span> <span class="nn">nepi.resources.linux.tap</span> <span class="kn">import</span> <span class="n">LinuxTap</span>
+<span class="kn">from</span> <span class="nn">nepi.resources.planetlab.node</span> <span class="kn">import</span> <span class="n">PlanetlabNode</span>
+<span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span><span class="p">,</span> <span class="n">tdiffsec</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">time</span>
+
+<span class="n">PYTHON_VSYS_VERSION</span> <span class="o">=</span> <span class="s">&quot;1.0&quot;</span>
+
+<span class="nd">@clsinit_copy</span>
+<div class="viewcode-block" id="PlanetlabTap"><a class="viewcode-back" href="../../../../_layout/nepi.resources.planetlab.html#nepi.resources.planetlab.tap.PlanetlabTap">[docs]</a><span class="k">class</span> <span class="nc">PlanetlabTap</span><span class="p">(</span><span class="n">LinuxTap</span><span class="p">):</span>
+    <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;planetlab::Tap&quot;</span>
+    <span class="n">_help</span> <span class="o">=</span> <span class="s">&quot;Creates a TAP device on a PlanetLab host&quot;</span>
+    <span class="n">_platform</span> <span class="o">=</span> <span class="s">&quot;planetlab&quot;</span>
+
+    <span class="nd">@classmethod</span>
+    <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
+        <span class="n">snat</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;snat&quot;</span><span class="p">,</span> <span class="s">&quot;Set SNAT=1&quot;</span><span class="p">,</span> 
+                <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">,</span>
+                <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
+        
+        <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">snat</span><span class="p">)</span>
+
+    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
+        <span class="nb">super</span><span class="p">(</span><span class="n">PlanetlabTap</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;tap-</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_gre_enabled</span> <span class="o">=</span> <span class="bp">False</span>
+
+    <span class="nd">@property</span>
+<div class="viewcode-block" id="PlanetlabTap.node"><a class="viewcode-back" href="../../../../_layout/nepi.resources.planetlab.html#nepi.resources.planetlab.tap.PlanetlabTap.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>
+        <span class="n">node</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">PlanetlabNode</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
+        <span class="k">if</span> <span class="n">node</span><span class="p">:</span> <span class="k">return</span> <span class="n">node</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
+        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;TAP/TUN devices must be connected to Node&quot;</span>
+</div>
+<div class="viewcode-block" id="PlanetlabTap.upload_sources"><a class="viewcode-back" href="../../../../_layout/nepi.resources.planetlab.html#nepi.resources.planetlab.tap.PlanetlabTap.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>
+        <span class="n">scripts</span> <span class="o">=</span> <span class="p">[]</span>
+
+        <span class="c"># vif-creation python script</span>
+        <span class="n">pl_vif_create</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> <span class="s">&quot;scripts&quot;</span><span class="p">,</span>
+                <span class="s">&quot;pl-vif-create.py&quot;</span><span class="p">)</span>
+
+        <span class="n">scripts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pl_vif_create</span><span class="p">)</span>
+        
+        <span class="c"># vif-up python script</span>
+        <span class="n">pl_vif_up</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> <span class="s">&quot;scripts&quot;</span><span class="p">,</span>
+                <span class="s">&quot;pl-vif-up.py&quot;</span><span class="p">)</span>
+        
+        <span class="n">scripts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pl_vif_up</span><span class="p">)</span>
+
+        <span class="c"># vif-down python script</span>
+        <span class="n">pl_vif_down</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> <span class="s">&quot;scripts&quot;</span><span class="p">,</span>
+                <span class="s">&quot;pl-vif-down.py&quot;</span><span class="p">)</span>
+        
+        <span class="n">scripts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pl_vif_down</span><span class="p">)</span>
+
+        <span class="c"># udp-connect python script</span>
+        <span class="n">udp_connect</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> 
+                <span class="s">&quot;..&quot;</span><span class="p">,</span>
+                <span class="s">&quot;linux&quot;</span><span class="p">,</span>
+                <span class="s">&quot;scripts&quot;</span><span class="p">,</span>
+                <span class="s">&quot;linux-udp-connect.py&quot;</span><span class="p">)</span>
+        
+        <span class="n">scripts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">udp_connect</span><span class="p">)</span>
+
+        <span class="c"># tunnel creation python script</span>
+        <span class="n">tunchannel</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> 
+                <span class="s">&quot;..&quot;</span><span class="p">,</span> 
+                <span class="s">&quot;linux&quot;</span><span class="p">,</span>
+                <span class="s">&quot;scripts&quot;</span><span class="p">,</span> 
+                <span class="s">&quot;tunchannel.py&quot;</span><span class="p">)</span>
+
+        <span class="n">scripts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tunchannel</span><span class="p">)</span>
+
+        <span class="c"># Upload scripts</span>
+        <span class="n">scripts</span> <span class="o">=</span> <span class="s">&quot;;&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">scripts</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">upload</span><span class="p">(</span><span class="n">scripts</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">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>
+                <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">False</span><span class="p">)</span>
+
+        <span class="c"># upload stop.sh script</span>
+        <span class="n">stop_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="bp">self</span><span class="o">.</span><span class="n">_stop_command</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">upload_command</span><span class="p">(</span><span class="n">stop_command</span><span class="p">,</span>
+                <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">&quot;stop.sh&quot;</span><span class="p">),</span>
+                <span class="c"># Overwrite file every time. </span>
+                <span class="c"># The stop.sh has the path to the socket, which should change</span>
+                <span class="c"># on every experiment run.</span>
+                <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="PlanetlabTap.upload_start_command"><a class="viewcode-back" href="../../../../_layout/nepi.resources.planetlab.html#nepi.resources.planetlab.tap.PlanetlabTap.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>
+        <span class="nb">super</span><span class="p">(</span><span class="n">PlanetlabTap</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">upload_start_command</span><span class="p">()</span>
+
+        <span class="c"># Planetlab TAPs always add a PI header</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;pi&quot;</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
+
+        <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
+            <span class="c"># After creating the TAP, the pl-vif-create.py script</span>
+            <span class="c"># will write the name of the TAP to a file. We wait until</span>
+            <span class="c"># we can read the interface name from the file.</span>
+            <span class="n">vif_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait_vif_name</span><span class="p">()</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;deviceName&quot;</span><span class="p">,</span> <span class="n">vif_name</span><span class="p">)</span> 
+</div>
+<div class="viewcode-block" id="PlanetlabTap.wait_vif_name"><a class="viewcode-back" href="../../../../_layout/nepi.resources.planetlab.html#nepi.resources.planetlab.tap.PlanetlabTap.wait_vif_name">[docs]</a>    <span class="k">def</span> <span class="nf">wait_vif_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exec_run_home</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; Waits until the vif_name file for the command is generated, </span>
+<span class="sd">            and returns the vif_name for the device &quot;&quot;&quot;</span>
+        <span class="n">vif_name</span> <span class="o">=</span> <span class="bp">None</span>
+        <span class="n">delay</span> <span class="o">=</span> <span class="mf">0.5</span>
+
+        <span class="c"># The vif_name file will be created in the tap-home, while the</span>
+        <span class="c"># current execution home might be elsewhere to check for errors</span>
+        <span class="c"># (e.g. could be a tunnel-home)</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">exec_run_home</span><span class="p">:</span>
+            <span class="n">exec_run_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_home</span>
+
+        <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">20</span><span class="p">):</span>
+            <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">check_output</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">,</span> <span class="s">&quot;vif_name&quot;</span><span class="p">)</span>
+
+            <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
+                <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">check_errors</span><span class="p">(</span><span class="n">exec_run_home</span><span class="p">)</span>
+                
+                <span class="k">if</span> <span class="n">err</span><span class="o">.</span><span class="n">strip</span><span class="p">():</span>
+                    <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">err</span>
+
+            <span class="k">if</span> <span class="n">out</span><span class="p">:</span>
+                <span class="n">vif_name</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
+                <span class="k">break</span>
+            <span class="k">else</span><span class="p">:</span>
+                <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">delay</span><span class="p">)</span>
+                <span class="n">delay</span> <span class="o">=</span> <span class="n">delay</span> <span class="o">*</span> <span class="mf">1.5</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Couldn&#39;t retrieve vif_name&quot;</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
+            <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
+
+        <span class="k">return</span> <span class="n">vif_name</span>
+</div>
+<div class="viewcode-block" id="PlanetlabTap.gre_connect"><a class="viewcode-back" href="../../../../_layout/nepi.resources.planetlab.html#nepi.resources.planetlab.tap.PlanetlabTap.gre_connect">[docs]</a>    <span class="k">def</span> <span class="nf">gre_connect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">,</span> <span class="n">connection_app_home</span><span class="p">,</span>
+            <span class="n">connection_run_home</span><span class="p">):</span>
+        <span class="nb">super</span><span class="p">(</span><span class="n">PlanetlabTap</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">gre_connect</span><span class="p">(</span><span class="n">remote_endpoint</span><span class="p">,</span> 
+                <span class="n">connection_app_home</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">)</span>
+         <span class="c"># After creating the TAP, the pl-vif-create.py script</span>
+        <span class="c"># will write the name of the TAP to a file. We wait until</span>
+        <span class="c"># we can read the interface name from the file.</span>
+        <span class="n">vif_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait_vif_name</span><span class="p">(</span><span class="n">exec_run_home</span> <span class="o">=</span> <span class="n">connection_run_home</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;deviceName&quot;</span><span class="p">,</span> <span class="n">vif_name</span><span class="p">)</span> 
+
+        <span class="k">return</span> <span class="bp">True</span>
+</div>
+    <span class="k">def</span> <span class="nf">_gre_connect_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">,</span> <span class="n">connection_app_home</span><span class="p">,</span> 
+            <span class="n">connection_run_home</span><span class="p">):</span> 
+        <span class="c"># Set the remote endpoint, (private) IP of the device</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;pointopoint&quot;</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;ip&quot;</span><span class="p">))</span>
+        <span class="c"># Public IP of the node</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;greRemote&quot;</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;ip&quot;</span><span class="p">))</span>
+
+        <span class="c"># Generate GRE connect command</span>
+
+        <span class="c"># Use vif_down command to first kill existing TAP in GRE mode</span>
+        <span class="n">vif_down_command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vif_down_command</span>
+
+        <span class="c"># Use pl-vif-up.py script to configure TAP with peer info</span>
+        <span class="n">vif_up_command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vif_up_command</span>
+        
+        <span class="n">command</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;(&quot;</span><span class="p">]</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">vif_down_command</span><span class="p">)</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;) ; (&quot;</span><span class="p">)</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">vif_up_command</span><span class="p">)</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;)&quot;</span><span class="p">)</span>
+
+        <span class="n">command</span> <span class="o">=</span> <span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+        <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>
+
+        <span class="k">return</span> <span class="n">command</span>
+
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
+            <span class="n">command</span> <span class="o">=</span> <span class="p">[]</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">command</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;sudo -S python ${SRC}/pl-vif-create.py&quot;</span><span class="p">]</span>
+            
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-t </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">vif_type</span><span class="p">)</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-a </span><span class="si">%s</span><span class="s">&quot;</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">&quot;ip&quot;</span><span class="p">))</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-n </span><span class="si">%s</span><span class="s">&quot;</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">&quot;prefix&quot;</span><span class="p">))</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-f </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">vif_name_file</span><span class="p">)</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-S </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock_name</span><span class="p">)</span>
+
+            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;snat&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
+                <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-s&quot;</span><span class="p">)</span>
+
+            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;pointopoint&quot;</span><span class="p">):</span>
+                <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-p </span><span class="si">%s</span><span class="s">&quot;</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">&quot;pointopoint&quot;</span><span class="p">))</span>
+            
+            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;txqueuelen&quot;</span><span class="p">):</span>
+                <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-q </span><span class="si">%s</span><span class="s">&quot;</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">&quot;txqueuelen&quot;</span><span class="p">))</span>
+
+        <span class="k">return</span> <span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">_stop_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
+            <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vif_down_command</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">command</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;sudo -S &quot;</span><span class="p">]</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;PYTHONPATH=$PYTHONPATH:${SRC}&quot;</span><span class="p">)</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;python ${SRC}/pl-vif-down.py&quot;</span><span class="p">)</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-S </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">sock_name</span><span class="p">)</span>
+            <span class="n">command</span> <span class="o">=</span> <span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+
+        <span class="k">return</span> <span class="n">command</span>
+
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">_vif_up_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
+            <span class="n">device_name</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">device_name</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">&quot;deviceName&quot;</span><span class="p">)</span>
+
+        <span class="c"># Use pl-vif-up.py script to configure TAP</span>
+        <span class="n">command</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;sudo -S &quot;</span><span class="p">]</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;PYTHONPATH=$PYTHONPATH:${SRC}&quot;</span><span class="p">)</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;python ${SRC}/pl-vif-up.py&quot;</span><span class="p">)</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-u </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;username&quot;</span><span class="p">))</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-N </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">device_name</span><span class="p">)</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-t </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">vif_type</span><span class="p">)</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-a </span><span class="si">%s</span><span class="s">&quot;</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">&quot;ip&quot;</span><span class="p">))</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-n </span><span class="si">%s</span><span class="s">&quot;</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">&quot;prefix&quot;</span><span class="p">))</span>
+
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;snat&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-s&quot;</span><span class="p">)</span>
+
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;pointopoint&quot;</span><span class="p">):</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-p </span><span class="si">%s</span><span class="s">&quot;</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">&quot;pointopoint&quot;</span><span class="p">))</span>
+        
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;txqueuelen&quot;</span><span class="p">):</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-q </span><span class="si">%s</span><span class="s">&quot;</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">&quot;txqueuelen&quot;</span><span class="p">))</span>
+
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-g </span><span class="si">%s</span><span class="s">&quot;</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">&quot;greKey&quot;</span><span class="p">))</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-G </span><span class="si">%s</span><span class="s">&quot;</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">&quot;greRemote&quot;</span><span class="p">))</span>
+        
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-f </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">vif_name_file</span><span class="p">)</span>
+
+        <span class="k">return</span> <span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">_vif_down_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
+            <span class="n">device_name</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">device_name</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">&quot;deviceName&quot;</span><span class="p">)</span>
+
+        <span class="n">command</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;sudo -S &quot;</span><span class="p">]</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;PYTHONPATH=$PYTHONPATH:${SRC}&quot;</span><span class="p">)</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;python ${SRC}/pl-vif-down.py&quot;</span><span class="p">)</span>
+        <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-N </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">device_name</span><span class="p">)</span>
+        
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-u </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;username&quot;</span><span class="p">))</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-t </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">vif_type</span><span class="p">)</span>
+            <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-D&quot;</span><span class="p">)</span>
+
+        <span class="k">return</span> <span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+
+    <span class="nd">@property</span>
+<div class="viewcode-block" id="PlanetlabTap.vif_name_file"><a class="viewcode-back" href="../../../../_layout/nepi.resources.planetlab.html#nepi.resources.planetlab.tap.PlanetlabTap.vif_name_file">[docs]</a>    <span class="k">def</span> <span class="nf">vif_name_file</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</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">run_home</span><span class="p">,</span> <span class="s">&quot;vif_name&quot;</span><span class="p">)</span>
+</div>
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">_install</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="c"># Install python-vsys and python-passfd</span>
+        <span class="n">install_vsys</span> <span class="o">=</span> <span class="p">(</span> <span class="s">&quot; ( &quot;</span>
+                    <span class="s">&quot;   python -c &#39;import vsys, os;  vsys.__version__ == </span><span class="se">\&quot;</span><span class="si">%(version)s</span><span class="se">\&quot;</span><span class="s"> or os._exit(1)&#39; &quot;</span>
+                    <span class="s">&quot; ) &quot;</span>
+                    <span class="s">&quot; || &quot;</span>
+                    <span class="s">&quot; ( &quot;</span>
+                    <span class="s">&quot;   cd ${SRC} ; &quot;</span>
+                    <span class="s">&quot;   hg clone http://nepi.inria.fr/code/python-vsys ; &quot;</span>
+                    <span class="s">&quot;   cd python-vsys ; &quot;</span>
+                    <span class="s">&quot;   make all ; &quot;</span>
+                    <span class="s">&quot;   sudo -S make install &quot;</span>
+                    <span class="s">&quot; )&quot;</span> <span class="p">)</span> <span class="o">%</span> <span class="p">({</span>
+                        <span class="s">&quot;version&quot;</span><span class="p">:</span> <span class="n">PYTHON_VSYS_VERSION</span>
+                        <span class="p">})</span>
+
+        <span class="n">install_passfd</span> <span class="o">=</span> <span class="p">(</span> <span class="s">&quot; ( python -c &#39;import passfd&#39; ) &quot;</span>
+                    <span class="s">&quot; || &quot;</span>
+                    <span class="s">&quot; ( &quot;</span>
+                    <span class="s">&quot;   cd ${SRC} ; &quot;</span>
+                    <span class="s">&quot;   hg clone http://nepi.inria.fr/code/python-passfd ; &quot;</span>
+                    <span class="s">&quot;   cd python-passfd ; &quot;</span>
+                    <span class="s">&quot;   make all ; &quot;</span>
+                    <span class="s">&quot;   sudo -S make install &quot;</span>
+                    <span class="s">&quot; )&quot;</span> <span class="p">)</span>
+
+        <span class="k">return</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">install_vsys</span><span class="p">,</span> <span class="n">install_passfd</span> <span class="p">)</span>
+
+<div class="viewcode-block" id="PlanetlabTap.valid_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.planetlab.html#nepi.resources.planetlab.tap.PlanetlabTap.valid_connection">[docs]</a>    <span class="k">def</span> <span class="nf">valid_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
+        <span class="c"># TODO: Validate!</span>
+        <span class="k">return</span> <span class="bp">True</span>
+</pre></div></div></div>
+
+          </div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
+          <li><a href="../../../index.html" >Module code</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+    </div>
+  </body>
+</html>
\ No newline at end of file