doc/sphinx/_build/html/_modules/nepi/resources/planetlab/tap.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.planetlab.tap &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.planetlab.tap</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">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>
  86 <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>
  87 <span class="kn">from</span> <span class="nn">nepi.resources.linux.tap</span> <span class="kn">import</span> <span class="n">LinuxTap</span>
  88 <span class="kn">from</span> <span class="nn">nepi.resources.planetlab.node</span> <span class="kn">import</span> <span class="n">PlanetlabNode</span>
  89 <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>
  90
  91 <span class="kn">import</span> <span class="nn">os</span>
  92 <span class="kn">import</span> <span class="nn">time</span>
  93
  94 <span class="n">PYTHON_VSYS_VERSION</span> <span class="o">=</span> <span class="s">&quot;1.0&quot;</span>
  95
  96 <span class="nd">@clsinit_copy</span>
  97 <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>
  98     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;planetlab::Tap&quot;</span>
  99     <span class="n">_help</span> <span class="o">=</span> <span class="s">&quot;Creates a TAP device on a PlanetLab host&quot;</span>
 100     <span class="n">_platform</span> <span class="o">=</span> <span class="s">&quot;planetlab&quot;</span>
 101
 102     <span class="nd">@classmethod</span>
 103     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
 104         <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>
 105                 <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>
 106                 <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>
 107
 108         <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>
 109
 110     <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>
 111         <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>
 112         <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>
 113         <span class="bp">self</span><span class="o">.</span><span class="n">_gre_enabled</span> <span class="o">=</span> <span class="bp">False</span>
 114
 115     <span class="nd">@property</span>
 116 <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>
 117         <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>
 118         <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>
 119         <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>
 120 </div>
 121 <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>
 122         <span class="n">scripts</span> <span class="o">=</span> <span class="p">[]</span>
 123
 124         <span class="c"># vif-creation python script</span>
 125         <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>
 126                 <span class="s">&quot;pl-vif-create.py&quot;</span><span class="p">)</span>
 127
 128         <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>
 129
 130         <span class="c"># vif-up python script</span>
 131         <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>
 132                 <span class="s">&quot;pl-vif-up.py&quot;</span><span class="p">)</span>
 133
 134         <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>
 135
 136         <span class="c"># vif-down python script</span>
 137         <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>
 138                 <span class="s">&quot;pl-vif-down.py&quot;</span><span class="p">)</span>
 139
 140         <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>
 141
 142         <span class="c"># udp-connect python script</span>
 143         <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>
 144                 <span class="s">&quot;..&quot;</span><span class="p">,</span>
 145                 <span class="s">&quot;linux&quot;</span><span class="p">,</span>
 146                 <span class="s">&quot;scripts&quot;</span><span class="p">,</span>
 147                 <span class="s">&quot;linux-udp-connect.py&quot;</span><span class="p">)</span>
 148
 149         <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>
 150
 151         <span class="c"># tunnel creation python script</span>
 152         <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>
 153                 <span class="s">&quot;..&quot;</span><span class="p">,</span>
 154                 <span class="s">&quot;linux&quot;</span><span class="p">,</span>
 155                 <span class="s">&quot;scripts&quot;</span><span class="p">,</span>
 156                 <span class="s">&quot;tunchannel.py&quot;</span><span class="p">)</span>
 157
 158         <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>
 159
 160         <span class="c"># Upload scripts</span>
 161         <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>
 162
 163         <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>
 164                 <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>
 165                 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">False</span><span class="p">)</span>
 166
 167         <span class="c"># upload stop.sh script</span>
 168         <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>
 169
 170         <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>
 171                 <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>
 172                 <span class="c"># Overwrite file every time. </span>
 173                 <span class="c"># The stop.sh has the path to the socket, which should change</span>
 174                 <span class="c"># on every experiment run.</span>
 175                 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
 176 </div>
 177 <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>
 178         <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>
 179
 180         <span class="c"># Planetlab TAPs always add a PI header</span>
 181         <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>
 182
 183         <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>
 184             <span class="c"># After creating the TAP, the pl-vif-create.py script</span>
 185             <span class="c"># will write the name of the TAP to a file. We wait until</span>
 186             <span class="c"># we can read the interface name from the file.</span>
 187             <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>
 188             <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>
 189 </div>
 190 <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>
 191         <span class="sd">&quot;&quot;&quot; Waits until the vif_name file for the command is generated, </span>
 192 <span class="sd">            and returns the vif_name for the device &quot;&quot;&quot;</span>
 193         <span class="n">vif_name</span> <span class="o">=</span> <span class="bp">None</span>
 194         <span class="n">delay</span> <span class="o">=</span> <span class="mf">0.5</span>
 195
 196         <span class="c"># The vif_name file will be created in the tap-home, while the</span>
 197         <span class="c"># current execution home might be elsewhere to check for errors</span>
 198         <span class="c"># (e.g. could be a tunnel-home)</span>
 199         <span class="k">if</span> <span class="ow">not</span> <span class="n">exec_run_home</span><span class="p">:</span>
 200             <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>
 201
 202         <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>
 203             <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>
 204
 205             <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>
 206                 <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>
 207
 208                 <span class="k">if</span> <span class="n">err</span><span class="o">.</span><span class="n">strip</span><span class="p">():</span>
 209                     <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">err</span>
 210
 211             <span class="k">if</span> <span class="n">out</span><span class="p">:</span>
 212                 <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>
 213                 <span class="k">break</span>
 214             <span class="k">else</span><span class="p">:</span>
 215                 <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>
 216                 <span class="n">delay</span> <span class="o">=</span> <span class="n">delay</span> <span class="o">*</span> <span class="mf">1.5</span>
 217         <span class="k">else</span><span class="p">:</span>
 218             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Couldn&#39;t retrieve vif_name&quot;</span>
 219             <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>
 220             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 221
 222         <span class="k">return</span> <span class="n">vif_name</span>
 223 </div>
 224 <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>
 225             <span class="n">connection_run_home</span><span class="p">):</span>
 226         <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>
 227                 <span class="n">connection_app_home</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">)</span>
 228          <span class="c"># After creating the TAP, the pl-vif-create.py script</span>
 229         <span class="c"># will write the name of the TAP to a file. We wait until</span>
 230         <span class="c"># we can read the interface name from the file.</span>
 231         <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>
 232         <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>
 233
 234         <span class="k">return</span> <span class="bp">True</span>
 235 </div>
 236     <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>
 237             <span class="n">connection_run_home</span><span class="p">):</span>
 238         <span class="c"># Set the remote endpoint, (private) IP of the device</span>
 239         <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>
 240         <span class="c"># Public IP of the node</span>
 241         <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>
 242
 243         <span class="c"># Generate GRE connect command</span>
 244
 245         <span class="c"># Use vif_down command to first kill existing TAP in GRE mode</span>
 246         <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>
 247
 248         <span class="c"># Use pl-vif-up.py script to configure TAP with peer info</span>
 249         <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>
 250
 251         <span class="n">command</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;(&quot;</span><span class="p">]</span>
 252         <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>
 253         <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>
 254         <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>
 255         <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>
 256
 257         <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>
 258         <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>
 259
 260         <span class="k">return</span> <span class="n">command</span>
 261
 262     <span class="nd">@property</span>
 263     <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 264         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
 265             <span class="n">command</span> <span class="o">=</span> <span class="p">[]</span>
 266         <span class="k">else</span><span class="p">:</span>
 267             <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>
 268
 269             <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>
 270             <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>
 271             <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>
 272             <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>
 273             <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>
 274
 275             <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>
 276                 <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>
 277
 278             <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>
 279                 <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>
 280
 281             <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>
 282                 <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>
 283
 284         <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>
 285
 286     <span class="nd">@property</span>
 287     <span class="k">def</span> <span class="nf">_stop_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 288         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
 289             <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>
 290         <span class="k">else</span><span class="p">:</span>
 291             <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>
 292             <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>
 293             <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>
 294             <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>
 295             <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>
 296
 297         <span class="k">return</span> <span class="n">command</span>
 298
 299     <span class="nd">@property</span>
 300     <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>
 301         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
 302             <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>
 303         <span class="k">else</span><span class="p">:</span>
 304             <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>
 305
 306         <span class="c"># Use pl-vif-up.py script to configure TAP</span>
 307         <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>
 308         <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>
 309         <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>
 310         <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>
 311         <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>
 312         <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>
 313         <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>
 314         <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>
 315
 316         <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>
 317             <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>
 318
 319         <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>
 320             <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>
 321
 322         <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>
 323             <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>
 324
 325         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
 326             <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>
 327             <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>
 328
 329         <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>
 330
 331         <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>
 332
 333     <span class="nd">@property</span>
 334     <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>
 335         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
 336             <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>
 337         <span class="k">else</span><span class="p">:</span>
 338             <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>
 339
 340         <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>
 341         <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>
 342         <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>
 343         <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>
 344
 345         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
 346             <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>
 347             <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>
 348             <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>
 349
 350         <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>
 351
 352     <span class="nd">@property</span>
 353 <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>
 354         <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>
 355 </div>
 356     <span class="nd">@property</span>
 357     <span class="k">def</span> <span class="nf">_install</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 358         <span class="c"># Install python-vsys and python-passfd</span>
 359         <span class="n">install_vsys</span> <span class="o">=</span> <span class="p">(</span> <span class="s">&quot; ( &quot;</span>
 360                     <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>
 361                     <span class="s">&quot; ) &quot;</span>
 362                     <span class="s">&quot; || &quot;</span>
 363                     <span class="s">&quot; ( &quot;</span>
 364                     <span class="s">&quot;   cd ${SRC} ; &quot;</span>
 365                     <span class="s">&quot;   hg clone http://nepi.inria.fr/code/python-vsys ; &quot;</span>
 366                     <span class="s">&quot;   cd python-vsys ; &quot;</span>
 367                     <span class="s">&quot;   make all ; &quot;</span>
 368                     <span class="s">&quot;   sudo -S make install &quot;</span>
 369                     <span class="s">&quot; )&quot;</span> <span class="p">)</span> <span class="o">%</span> <span class="p">({</span>
 370                         <span class="s">&quot;version&quot;</span><span class="p">:</span> <span class="n">PYTHON_VSYS_VERSION</span>
 371                         <span class="p">})</span>
 372
 373         <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>
 374                     <span class="s">&quot; || &quot;</span>
 375                     <span class="s">&quot; ( &quot;</span>
 376                     <span class="s">&quot;   cd ${SRC} ; &quot;</span>
 377                     <span class="s">&quot;   hg clone http://nepi.inria.fr/code/python-passfd ; &quot;</span>
 378                     <span class="s">&quot;   cd python-passfd ; &quot;</span>
 379                     <span class="s">&quot;   make all ; &quot;</span>
 380                     <span class="s">&quot;   sudo -S make install &quot;</span>
 381                     <span class="s">&quot; )&quot;</span> <span class="p">)</span>
 382
 383         <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>
 384
 385 <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>
 386         <span class="c"># TODO: Validate!</span>
 387         <span class="k">return</span> <span class="bp">True</span>
 388 </pre></div></div></div>
 389
 390           </div>
 391         </div>
 392       </div>
 393       <div class="clearer"></div>
 394     </div>
 395     <div class="related">
 396       <h3>Navigation</h3>
 397       <ul>
 398         <li class="right" style="margin-right: 10px">
 399           <a href="../../../../genindex.html" title="General Index"
 400              >index</a></li>
 401         <li class="right" >
 402           <a href="../../../../py-modindex.html" title="Python Module Index"
 403              >modules</a> |</li>
 404         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 405           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 406       </ul>
 407     </div>
 408     <div class="footer">
 409         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 410       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 411     </div>
 412   </body>
 413 </html>