doc/sphinx/_build/html/_modules/nepi/resources/linux/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.linux.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.linux.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.application</span> <span class="kn">import</span> <span class="n">LinuxApplication</span>
  88 <span class="kn">from</span> <span class="nn">nepi.resources.linux.node</span> <span class="kn">import</span> <span class="n">LinuxNode</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="LinuxTap"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap">[docs]</a><span class="k">class</span> <span class="nc">LinuxTap</span><span class="p">(</span><span class="n">LinuxApplication</span><span class="p">):</span>
  98     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;linux::Tap&quot;</span>
  99     <span class="n">_help</span> <span class="o">=</span> <span class="s">&quot;Creates a TAP device on a Linux host&quot;</span>
 100
 101     <span class="n">IFF_TUN</span> <span class="o">=</span> <span class="mh">0x0001</span>
 102     <span class="n">IFF_TAP</span> <span class="o">=</span> <span class="mh">0x0002</span>
 103
 104     <span class="nd">@classmethod</span>
 105     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
 106         <span class="n">ip</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;ip&quot;</span><span class="p">,</span> <span class="s">&quot;IPv4 Address&quot;</span><span class="p">,</span>
 107               <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>
 108
 109         <span class="n">mac</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;mac&quot;</span><span class="p">,</span> <span class="s">&quot;MAC Address&quot;</span><span class="p">,</span>
 110                 <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>
 111
 112         <span class="n">prefix</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;prefix&quot;</span><span class="p">,</span> <span class="s">&quot;IPv4 network prefix&quot;</span><span class="p">,</span>
 113                 <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>
 114
 115         <span class="n">mtu</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;mtu&quot;</span><span class="p">,</span> <span class="s">&quot;Maximum transmition unit for device&quot;</span><span class="p">,</span>
 116                 <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</span><span class="p">)</span>
 117
 118         <span class="n">devname</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;deviceName&quot;</span><span class="p">,</span>
 119                 <span class="s">&quot;Name of the network interface (e.g. eth0, wlan0, etc)&quot;</span><span class="p">,</span>
 120                 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">NoWrite</span><span class="p">)</span>
 121
 122         <span class="n">up</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;up&quot;</span><span class="p">,</span> <span class="s">&quot;Link up&quot;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
 123                 <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>
 124
 125         <span class="n">pointopoint</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;pointopoint&quot;</span><span class="p">,</span> <span class="s">&quot;Peer IP address&quot;</span><span class="p">,</span>
 126                 <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>
 127
 128         <span class="n">txqueuelen</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;txqueuelen&quot;</span><span class="p">,</span> <span class="s">&quot;Length of transmission queue&quot;</span><span class="p">,</span>
 129                 <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>
 130
 131         <span class="n">txqueuelen</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;txqueuelen&quot;</span><span class="p">,</span> <span class="s">&quot;Length of transmission queue&quot;</span><span class="p">,</span>
 132                 <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>
 133
 134         <span class="n">gre_key</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;greKey&quot;</span><span class="p">,</span>
 135                 <span class="s">&quot;GRE key to be used to configure GRE tunnel&quot;</span><span class="p">,</span>
 136                 <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;1&quot;</span><span class="p">,</span>
 137                 <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>
 138
 139         <span class="n">gre_remote</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;greRemote&quot;</span><span class="p">,</span>
 140                 <span class="s">&quot;Public IP of remote endpoint for GRE tunnel&quot;</span><span class="p">,</span>
 141                 <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>
 142
 143         <span class="n">pi</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;pi&quot;</span><span class="p">,</span> <span class="s">&quot;Add PI (protocol information) header&quot;</span><span class="p">,</span>
 144                 <span class="n">default</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 145                 <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>
 146
 147         <span class="n">tear_down</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;tearDown&quot;</span><span class="p">,</span>
 148                 <span class="s">&quot;Bash script to be executed before releasing the resource&quot;</span><span class="p">,</span>
 149                 <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>
 150
 151         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">ip</span><span class="p">)</span>
 152         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">mac</span><span class="p">)</span>
 153         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span>
 154         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">mtu</span><span class="p">)</span>
 155         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">devname</span><span class="p">)</span>
 156         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">up</span><span class="p">)</span>
 157         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">pointopoint</span><span class="p">)</span>
 158         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">txqueuelen</span><span class="p">)</span>
 159         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">gre_key</span><span class="p">)</span>
 160         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">gre_remote</span><span class="p">)</span>
 161         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">pi</span><span class="p">)</span>
 162         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">tear_down</span><span class="p">)</span>
 163
 164     <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>
 165         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxTap</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>
 166         <span class="bp">self</span><span class="o">.</span><span class="n">_gre_enabled</span> <span class="o">=</span> <span class="bp">None</span>
 167         <span class="bp">self</span><span class="o">.</span><span class="n">_vif_prefix</span> <span class="o">=</span> <span class="s">&quot;tap&quot;</span>
 168         <span class="bp">self</span><span class="o">.</span><span class="n">_vif_type</span> <span class="o">=</span> <span class="s">&quot;IFF_TAP&quot;</span>
 169         <span class="bp">self</span><span class="o">.</span><span class="n">_vif_type_flag</span> <span class="o">=</span> <span class="n">LinuxTap</span><span class="o">.</span><span class="n">IFF_TAP</span>
 170         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">-</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">vif_prefix</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">)</span>
 171
 172     <span class="nd">@property</span>
 173 <div class="viewcode-block" id="LinuxTap.node"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.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>
 174         <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">LinuxNode</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
 175         <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>
 176         <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;linux::TAP/TUN devices must be connected to a linux::Node&quot;</span>
 177 </div>
 178     <span class="nd">@property</span>
 179 <div class="viewcode-block" id="LinuxTap.gre_enabled"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.gre_enabled">[docs]</a>    <span class="k">def</span> <span class="nf">gre_enabled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 180         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_gre_enabled</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
 181             <span class="kn">from</span> <span class="nn">nepi.resources.linux.gretunnel</span> <span class="kn">import</span> <span class="n">LinuxGRETunnel</span>
 182             <span class="n">gre</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">LinuxGRETunnel</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
 183             <span class="k">if</span> <span class="n">gre</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_gre_enabled</span> <span class="o">=</span> <span class="bp">True</span>
 184
 185         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_gre_enabled</span>
 186 </div>
 187 <div class="viewcode-block" id="LinuxTap.upload_sources"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.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>
 188         <span class="n">scripts</span> <span class="o">=</span> <span class="p">[]</span>
 189
 190         <span class="c"># udp-connect python script</span>
 191         <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;scripts&quot;</span><span class="p">,</span>
 192                 <span class="s">&quot;linux-udp-connect.py&quot;</span><span class="p">)</span>
 193
 194         <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>
 195
 196         <span class="n">tap_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>
 197                 <span class="s">&quot;linux-tap-create.py&quot;</span><span class="p">)</span>
 198
 199         <span class="n">scripts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tap_create</span><span class="p">)</span>
 200
 201         <span class="n">tap_delete</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>
 202                 <span class="s">&quot;linux-tap-delete.py&quot;</span><span class="p">)</span>
 203
 204         <span class="n">scripts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tap_delete</span><span class="p">)</span>
 205
 206         <span class="c"># tunnel creation python script</span>
 207         <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;scripts&quot;</span><span class="p">,</span>
 208                 <span class="s">&quot;tunchannel.py&quot;</span><span class="p">)</span>
 209
 210         <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>
 211
 212         <span class="c"># Upload scripts</span>
 213         <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>
 214
 215         <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>
 216                 <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>
 217                 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">False</span><span class="p">)</span>
 218
 219         <span class="c"># upload stop.sh script</span>
 220         <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>
 221
 222         <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">stop_command</span><span class="p">,</span>
 223                 <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>
 224                 <span class="n">text</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
 225                 <span class="c"># Overwrite file every time. </span>
 226                 <span class="c"># The stop.sh has the path to the socket, which should change</span>
 227                 <span class="c"># on every experiment run.</span>
 228                 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
 229 </div>
 230     <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>
 231         <span class="c"># If GRE mode is enabled, TAP creation is delayed until the</span>
 232         <span class="c"># tunnel is established</span>
 233         <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>
 234             <span class="c"># We want to make sure the device is up and running</span>
 235             <span class="c"># before the deploy is over, so we execute the </span>
 236             <span class="c"># start script now and wait until it finishes. </span>
 237             <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">)</span>
 238             <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>
 239
 240             <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;start.sh&quot;</span><span class="p">)</span>
 241             <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">run_and_wait</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">,</span>
 242                 <span class="n">shfile</span> <span class="o">=</span> <span class="n">shfile</span><span class="p">,</span>
 243                 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
 244
 245 <div class="viewcode-block" id="LinuxTap.upload_start_command"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.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>
 246         <span class="c"># If GRE mode is enabled, TAP creation is delayed until the</span>
 247         <span class="c"># tunnel is established</span>
 248         <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>
 249             <span class="c"># Overwrite file every time. </span>
 250             <span class="c"># The start.sh has the path to the socket, wich should change</span>
 251             <span class="c"># on every experiment run.</span>
 252             <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">)</span>
 253
 254             <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Uploading command &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
 255
 256             <span class="c"># replace application specific paths in the command</span>
 257             <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>
 258
 259             <span class="c"># replace application specific paths in the environment</span>
 260             <span class="n">env</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;env&quot;</span><span class="p">)</span>
 261             <span class="n">env</span> <span class="o">=</span> <span class="n">env</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">replace_paths</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
 262
 263             <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;start.sh&quot;</span><span class="p">)</span>
 264
 265             <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">command</span><span class="p">,</span>
 266                     <span class="n">shfile</span> <span class="o">=</span> <span class="n">shfile</span><span class="p">,</span>
 267                     <span class="n">env</span> <span class="o">=</span> <span class="n">env</span><span class="p">,</span>
 268                     <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
 269
 270             <span class="c"># We want to make sure the device is up and running</span>
 271             <span class="c"># before the deploy finishes, so we execute now the </span>
 272             <span class="c"># start script. We run it in background, because the </span>
 273             <span class="c"># TAP will live for as long as the process that </span>
 274             <span class="c"># created it is running, and wait until the TAP  </span>
 275             <span class="c"># is created. </span>
 276             <span class="bp">self</span><span class="o">.</span><span class="n">_run_in_background</span><span class="p">()</span>
 277             </div>
 278 <div class="viewcode-block" id="LinuxTap.do_deploy"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.do_deploy">[docs]</a>    <span class="k">def</span> <span class="nf">do_deploy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 279         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">state</span> <span class="o">&lt;</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">PROVISIONED</span><span class="p">:</span>
 280             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">schedule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reschedule_delay</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">deploy</span><span class="p">)</span>
 281         <span class="k">else</span><span class="p">:</span>
 282             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
 283                 <span class="bp">self</span><span class="o">.</span><span class="n">_vif_prefix</span> <span class="o">=</span> <span class="s">&quot;gre&quot;</span>
 284                 <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">-</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">vif_prefix</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">)</span>
 285
 286             <span class="k">if</span> <span class="ow">not</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>
 287                 <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="s">&quot;</span><span class="si">%s%d</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">vif_prefix</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">))</span>
 288
 289             <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">):</span>
 290                 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_command</span><span class="p">)</span>
 291
 292             <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;depends&quot;</span><span class="p">):</span>
 293                 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;depends&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dependencies</span><span class="p">)</span>
 294
 295             <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;install&quot;</span><span class="p">):</span>
 296                 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;install&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_install</span><span class="p">)</span>
 297
 298             <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
 299             <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
 300
 301             <span class="bp">self</span><span class="o">.</span><span class="n">set_ready</span><span class="p">()</span>
 302 </div>
 303 <div class="viewcode-block" id="LinuxTap.do_start"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.do_start">[docs]</a>    <span class="k">def</span> <span class="nf">do_start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 304         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span><span class="p">:</span>
 305             <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;command&quot;</span><span class="p">)</span>
 306             <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Starting command &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
 307
 308             <span class="bp">self</span><span class="o">.</span><span class="n">set_started</span><span class="p">()</span>
 309         <span class="k">else</span><span class="p">:</span>
 310             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Failed to execute command &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">command</span>
 311             <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>
 312             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 313 </div>
 314 <div class="viewcode-block" id="LinuxTap.do_stop"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.do_stop">[docs]</a>    <span class="k">def</span> <span class="nf">do_stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 315         <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;command&#39;</span><span class="p">)</span> <span class="ow">or</span> <span class="s">&#39;&#39;</span>
 316
 317         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">STARTED</span><span class="p">:</span>
 318             <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Stopping command &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">command</span><span class="p">)</span>
 319
 320             <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;bash </span><span class="si">%s</span><span class="s">&quot;</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>
 321             <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">execute_command</span><span class="p">(</span><span class="n">command</span><span class="p">,</span>
 322                     <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
 323
 324             <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
 325                 <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Failed to stop command &#39;</span><span class="si">%s</span><span class="s">&#39; &quot;</span> <span class="o">%</span> <span class="n">command</span>
 326                 <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>
 327
 328             <span class="bp">self</span><span class="o">.</span><span class="n">set_stopped</span><span class="p">()</span>
 329 </div>
 330     <span class="nd">@property</span>
 331 <div class="viewcode-block" id="LinuxTap.state"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.state">[docs]</a>    <span class="k">def</span> <span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 332         <span class="n">state_check_delay</span> <span class="o">=</span> <span class="mf">0.5</span>
 333         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_state</span> <span class="o">==</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">STARTED</span> <span class="ow">and</span> \
 334                 <span class="n">tdiffsec</span><span class="p">(</span><span class="n">tnow</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_state_check</span><span class="p">)</span> <span class="o">&gt;</span> <span class="n">state_check_delay</span><span class="p">:</span>
 335
 336             <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;deviceName&quot;</span><span class="p">):</span>
 337                 <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">execute</span><span class="p">(</span><span class="s">&quot;ifconfig&quot;</span><span class="p">)</span>
 338
 339                 <span class="k">if</span> <span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">find</span><span class="p">(</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="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
 340                     <span class="c"># tap is not running is not running (socket not found)</span>
 341                     <span class="bp">self</span><span class="o">.</span><span class="n">set_stopped</span><span class="p">()</span>
 342
 343             <span class="bp">self</span><span class="o">.</span><span class="n">_last_state_check</span> <span class="o">=</span> <span class="n">tnow</span><span class="p">()</span>
 344
 345         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_state</span>
 346 </div>
 347 <div class="viewcode-block" id="LinuxTap.do_release"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.do_release">[docs]</a>    <span class="k">def</span> <span class="nf">do_release</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 348         <span class="c"># Node needs to wait until all associated RMs are released</span>
 349         <span class="c"># to be released</span>
 350         <span class="kn">from</span> <span class="nn">nepi.resources.linux.tunnel</span> <span class="kn">import</span> <span class="n">LinuxTunnel</span>
 351         <span class="n">rms</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">LinuxTunnel</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
 352
 353         <span class="k">for</span> <span class="n">rm</span> <span class="ow">in</span> <span class="n">rms</span><span class="p">:</span>
 354             <span class="k">if</span> <span class="n">rm</span><span class="o">.</span><span class="n">state</span> <span class="o">&lt;</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">STOPPED</span><span class="p">:</span>
 355                 <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">schedule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reschedule_delay</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">release</span><span class="p">)</span>
 356                 <span class="k">return</span>
 357
 358         <span class="nb">super</span><span class="p">(</span><span class="n">LinuxTap</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_release</span><span class="p">()</span>
 359 </div>
 360 <div class="viewcode-block" id="LinuxTap.gre_connect"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.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>
 361             <span class="n">connection_run_home</span><span class="p">):</span>
 362         <span class="n">gre_connect_command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_gre_connect_command</span><span class="p">(</span><span class="n">remote_endpoint</span><span class="p">,</span>
 363                 <span class="n">connection_app_home</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">)</span>
 364
 365         <span class="c"># upload command to connect.sh script</span>
 366         <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="n">connection_app_home</span><span class="p">,</span> <span class="s">&quot;gre-connect.sh&quot;</span><span class="p">)</span>
 367         <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">gre_connect_command</span><span class="p">,</span>
 368                 <span class="n">shfile</span> <span class="o">=</span> <span class="n">shfile</span><span class="p">,</span>
 369                 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">False</span><span class="p">)</span>
 370
 371         <span class="c"># invoke connect script</span>
 372         <span class="n">cmd</span> <span class="o">=</span> <span class="s">&quot;bash </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">shfile</span>
 373         <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">run</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">,</span>
 374                 <span class="n">pidfile</span> <span class="o">=</span> <span class="s">&quot;gre_connect_pidfile&quot;</span><span class="p">,</span>
 375                 <span class="n">stdout</span> <span class="o">=</span> <span class="s">&quot;gre_connect_stdout&quot;</span><span class="p">,</span>
 376                 <span class="n">stderr</span> <span class="o">=</span> <span class="s">&quot;gre_connect_stderr&quot;</span><span class="p">,</span>
 377                 <span class="p">)</span>
 378
 379         <span class="c"># check if execution errors occurred</span>
 380         <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Failed to connect endpoints &quot;</span>
 381
 382         <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="ow">or</span> <span class="n">err</span><span class="p">:</span>
 383             <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>
 384             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 385
 386         <span class="c"># Wait for pid file to be generated</span>
 387         <span class="n">pid</span><span class="p">,</span> <span class="n">ppid</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">wait_pid</span><span class="p">(</span><span class="n">connection_run_home</span><span class="p">,</span>
 388                 <span class="n">pidfile</span> <span class="o">=</span> <span class="s">&quot;gre_connect_pidfile&quot;</span><span class="p">)</span>
 389
 390         <span class="c"># If the process is not running, check for error information</span>
 391         <span class="c"># on the remote machine</span>
 392         <span class="k">if</span> <span class="ow">not</span> <span class="n">pid</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">ppid</span><span class="p">:</span>
 393             <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">connection_run_home</span><span class="p">,</span>
 394                     <span class="n">stderr</span> <span class="o">=</span> <span class="s">&quot;gre_connect_stderr&quot;</span><span class="p">)</span>
 395
 396             <span class="c"># Out is what was written in the stderr file</span>
 397             <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
 398                 <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Failed to start command &#39;</span><span class="si">%s</span><span class="s">&#39; &quot;</span> <span class="o">%</span> <span class="n">command</span>
 399                 <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>
 400                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 401
 402         <span class="k">return</span> <span class="bp">True</span>
 403 </div>
 404 <div class="viewcode-block" id="LinuxTap.initiate_udp_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.initiate_udp_connection">[docs]</a>    <span class="k">def</span> <span class="nf">initiate_udp_connection</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>
 405             <span class="n">connection_run_home</span><span class="p">,</span> <span class="n">cipher</span><span class="p">,</span> <span class="n">cipher_key</span><span class="p">,</span> <span class="n">bwlimit</span><span class="p">,</span> <span class="n">txqueuelen</span><span class="p">):</span>
 406         <span class="n">port</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">udp_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>
 407             <span class="n">connection_run_home</span><span class="p">,</span> <span class="n">cipher</span><span class="p">,</span> <span class="n">cipher_key</span><span class="p">,</span> <span class="n">bwlimit</span><span class="p">,</span> <span class="n">txqueuelen</span><span class="p">)</span>
 408         <span class="k">return</span> <span class="n">port</span>
 409 </div>
 410 <div class="viewcode-block" id="LinuxTap.udp_connect"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.udp_connect">[docs]</a>    <span class="k">def</span> <span class="nf">udp_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>
 411             <span class="n">connection_run_home</span><span class="p">,</span> <span class="n">cipher</span><span class="p">,</span> <span class="n">cipher_key</span><span class="p">,</span> <span class="n">bwlimit</span><span class="p">,</span> <span class="n">txqueuelen</span><span class="p">):</span>
 412         <span class="n">udp_connect_command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_udp_connect_command</span><span class="p">(</span>
 413                 <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>
 414                 <span class="n">cipher</span><span class="p">,</span> <span class="n">cipher_key</span><span class="p">,</span> <span class="n">bwlimit</span><span class="p">,</span> <span class="n">txqueuelen</span><span class="p">)</span>
 415
 416         <span class="c"># upload command to connect.sh script</span>
 417         <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="n">connection_app_home</span><span class="p">,</span> <span class="s">&quot;udp-connect.sh&quot;</span><span class="p">)</span>
 418         <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">udp_connect_command</span><span class="p">,</span>
 419                 <span class="n">shfile</span> <span class="o">=</span> <span class="n">shfile</span><span class="p">,</span>
 420                 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">False</span><span class="p">)</span>
 421
 422         <span class="c"># invoke connect script</span>
 423         <span class="n">cmd</span> <span class="o">=</span> <span class="s">&quot;bash </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">shfile</span>
 424         <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">run</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">,</span>
 425                <span class="n">pidfile</span> <span class="o">=</span> <span class="s">&quot;udp_connect_pidfile&quot;</span><span class="p">,</span>
 426                <span class="n">stdout</span> <span class="o">=</span> <span class="s">&quot;udp_connect_stdout&quot;</span><span class="p">,</span>
 427                <span class="n">stderr</span> <span class="o">=</span> <span class="s">&quot;udp_connect_stderr&quot;</span><span class="p">,</span>
 428                 <span class="p">)</span>
 429
 430         <span class="c"># check if execution errors occurred</span>
 431         <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Failed to connect endpoints &quot;</span>
 432
 433         <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
 434             <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>
 435             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 436
 437         <span class="c"># Wait for pid file to be generated</span>
 438         <span class="bp">self</span><span class="o">.</span><span class="n">_pid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ppid</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">wait_pid</span><span class="p">(</span>
 439                 <span class="n">connection_run_home</span><span class="p">,</span>
 440                 <span class="n">pidfile</span> <span class="o">=</span> <span class="s">&quot;udp_connect_pidfile&quot;</span><span class="p">)</span>
 441
 442         <span class="c"># If the process is not running, check for error information</span>
 443         <span class="c"># on the remote machine</span>
 444         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_pid</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ppid</span><span class="p">:</span>
 445             <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>
 446                     <span class="n">connection_run_home</span><span class="p">,</span>
 447                     <span class="n">stderr</span> <span class="o">=</span> <span class="s">&quot;udp_connect_stderr&quot;</span><span class="p">)</span>
 448
 449             <span class="c"># Out is what was written in the stderr file</span>
 450             <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
 451                 <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Failed to start command &#39;</span><span class="si">%s</span><span class="s">&#39; &quot;</span> <span class="o">%</span> <span class="n">command</span>
 452                 <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>
 453                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 454
 455         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait_file</span><span class="p">(</span><span class="n">connection_run_home</span><span class="p">,</span> <span class="s">&quot;local_port&quot;</span><span class="p">)</span>
 456 </div>
 457 <div class="viewcode-block" id="LinuxTap.establish_udp_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.establish_udp_connection">[docs]</a>    <span class="k">def</span> <span class="nf">establish_udp_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">,</span>
 458             <span class="n">connection_app_home</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span>
 459         <span class="c"># upload remote port number to file</span>
 460         <span class="n">rem_port</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="se">\n</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">port</span>
 461         <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">rem_port</span><span class="p">,</span>
 462                 <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">connection_run_home</span><span class="p">,</span> <span class="s">&quot;remote_port&quot;</span><span class="p">),</span>
 463                 <span class="n">text</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
 464                 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">False</span><span class="p">)</span>
 465 </div>
 466 <div class="viewcode-block" id="LinuxTap.verify_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.verify_connection">[docs]</a>    <span class="k">def</span> <span class="nf">verify_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">,</span>
 467             <span class="n">connection_app_home</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">):</span>
 468
 469         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait_file</span><span class="p">(</span><span class="n">connection_run_home</span><span class="p">,</span> <span class="s">&quot;ret_file&quot;</span><span class="p">)</span>
 470 </div>
 471 <div class="viewcode-block" id="LinuxTap.terminate_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.terminate_connection">[docs]</a>    <span class="k">def</span> <span class="nf">terminate_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">,</span>
 472             <span class="n">connection_app_home</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">):</span>
 473         <span class="k">if</span>  <span class="bp">self</span><span class="o">.</span><span class="n">_pid</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ppid</span><span class="p">:</span>
 474             <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">kill</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_pid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ppid</span><span class="p">,</span>
 475                     <span class="n">sudo</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
 476
 477             <span class="c"># check if execution errors occurred</span>
 478             <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="ow">and</span> <span class="n">err</span><span class="p">:</span>
 479                 <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Failed to Kill the Tap&quot;</span>
 480                 <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>
 481                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 482 </div>
 483 <div class="viewcode-block" id="LinuxTap.check_status"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.check_status">[docs]</a>    <span class="k">def</span> <span class="nf">check_status</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 484         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">status</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_pid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ppid</span><span class="p">)</span>
 485 </div>
 486 <div class="viewcode-block" id="LinuxTap.wait_file"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.wait_file">[docs]</a>    <span class="k">def</span> <span class="nf">wait_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">home</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
 487         <span class="sd">&quot;&quot;&quot; Waits until file on endpoint is generated &quot;&quot;&quot;</span>
 488         <span class="n">result</span> <span class="o">=</span> <span class="bp">None</span>
 489         <span class="n">delay</span> <span class="o">=</span> <span class="mf">1.0</span>
 490
 491         <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>
 492             <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="n">home</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span>
 493             <span class="k">if</span> <span class="n">out</span><span class="p">:</span>
 494                 <span class="n">result</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
 495                 <span class="k">break</span>
 496             <span class="k">else</span><span class="p">:</span>
 497                 <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>
 498                 <span class="n">delay</span> <span class="o">=</span> <span class="n">delay</span> <span class="o">*</span> <span class="mf">1.5</span>
 499         <span class="k">else</span><span class="p">:</span>
 500             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Couldn&#39;t retrieve </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">filename</span>
 501             <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>
 502             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
 503
 504         <span class="k">return</span> <span class="n">result</span>
 505 </div>
 506     <span class="nd">@property</span>
 507     <span class="k">def</span> <span class="nf">_start_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 508         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
 509             <span class="n">command</span> <span class="o">=</span> <span class="p">[]</span>
 510         <span class="k">else</span><span class="p">:</span>
 511             <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>
 512             <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>
 513             <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;python ${SRC}/linux-tap-create.py&quot;</span><span class="p">)</span>
 514             <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>
 515             <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>
 516             <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>
 517             <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;deviceName&quot;</span><span class="p">))</span>
 518             <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>
 519             <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;pi&quot;</span><span class="p">):</span>
 520                 <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-p&quot;</span><span class="p">)</span>
 521
 522         <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>
 523
 524     <span class="nd">@property</span>
 525     <span class="k">def</span> <span class="nf">_stop_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 526         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gre_enabled</span><span class="p">:</span>
 527             <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stop_gre_command</span>
 528         <span class="k">else</span><span class="p">:</span>
 529             <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>
 530             <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>
 531             <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;python ${SRC}/linux-tap-delete.py&quot;</span><span class="p">)</span>
 532             <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;deviceName&quot;</span><span class="p">))</span>
 533             <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>
 534             <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>
 535
 536         <span class="k">return</span> <span class="n">command</span>
 537
 538     <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>
 539             <span class="n">connection_app_home</span><span class="p">,</span> <span class="n">connecrion_app_home</span><span class="p">):</span>
 540         <span class="c"># Set the remote endpoint to (private) device IP</span>
 541         <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>
 542         <span class="c">## public node IP</span>
 543         <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>
 544
 545         <span class="c"># Generate GRE connect command</span>
 546         <span class="n">command</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;(&quot;</span><span class="p">]</span>
 547         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_stop_gre_command</span><span class="p">)</span>
 548         <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>
 549         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_start_gre_command</span><span class="p">)</span>
 550         <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>
 551
 552         <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>
 553         <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>
 554
 555         <span class="k">return</span> <span class="n">command</span>
 556
 557     <span class="nd">@property</span>
 558     <span class="k">def</span> <span class="nf">_start_gre_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 559         <span class="n">command</span> <span class="o">=</span> <span class="p">[]</span>
 560         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;sudo -S modprobe ip_gre&quot;</span><span class="p">)</span>
 561         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;sudo -S ip tunnel add </span><span class="si">%s</span><span class="s"> mode gre remote </span><span class="si">%s</span><span class="s"> local </span><span class="si">%s</span><span class="s"> ttl 255 csum key </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span>
 562                 <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>
 563                 <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>
 564                 <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;ip&quot;</span><span class="p">),</span>
 565                 <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>
 566             <span class="p">))</span>
 567         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;sudo -S ip addr add </span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s"> peer </span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s"> dev </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span>
 568                 <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>
 569                 <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>
 570                 <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>
 571                 <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>
 572                 <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>
 573                 <span class="p">))</span>
 574         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;sudo -S ip link set </span><span class="si">%s</span><span class="s"> up &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;deviceName&quot;</span><span class="p">))</span>
 575
 576         <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>
 577
 578     <span class="nd">@property</span>
 579     <span class="k">def</span> <span class="nf">_stop_gre_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 580         <span class="n">command</span> <span class="o">=</span> <span class="p">[]</span>
 581         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;sudo -S modprobe -r ip_gre&quot;</span><span class="p">)</span>
 582         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;sudo -S ip link set down dev </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span>
 583                 <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>
 584             <span class="p">))</span>
 585         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;sudo -S ip link del dev </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span>
 586                 <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>
 587                 <span class="p">))</span>
 588
 589         <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>
 590
 591     <span class="k">def</span> <span class="nf">_udp_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>
 592             <span class="n">connection_app_home</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">,</span>
 593             <span class="n">cipher</span><span class="p">,</span> <span class="n">cipher_key</span><span class="p">,</span> <span class="n">bwlimit</span><span class="p">,</span> <span class="n">txqueuelen</span><span class="p">):</span>
 594
 595         <span class="c"># Set the remote endpoint to the IP of the device</span>
 596         <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>
 597
 598         <span class="c"># Public IP of the remote NODE to stablish tunnel</span>
 599         <span class="n">remote_ip</span> <span class="o">=</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>
 600         <span class="n">local_ip</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;ip&quot;</span><span class="p">)</span>
 601
 602         <span class="n">local_port_file</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">connection_run_home</span><span class="p">,</span>
 603                 <span class="s">&quot;local_port&quot;</span><span class="p">)</span>
 604
 605         <span class="n">remote_port_file</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">connection_run_home</span><span class="p">,</span>
 606                 <span class="s">&quot;remote_port&quot;</span><span class="p">)</span>
 607
 608         <span class="n">ret_file</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">connection_run_home</span><span class="p">,</span>
 609                 <span class="s">&quot;ret_file&quot;</span><span class="p">)</span>
 610
 611         <span class="c"># Generate UDP connect command</span>
 612         <span class="c"># Use the start command to configure TAP with peer info</span>
 613         <span class="n">start_command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_start_command</span>
 614
 615         <span class="n">command</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;&quot;</span><span class="p">]</span>
 616         <span class="c"># Use pl-vid-udp-connect.py to stablish the tunnel between endpoints</span>
 617         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;sudo -S&quot;</span><span class="p">)</span>
 618         <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>
 619         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;python ${SRC}/linux-udp-connect.py&quot;</span><span class="p">)</span>
 620         <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>
 621         <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>
 622         <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="n">local_port_file</span><span class="p">)</span>
 623         <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="n">remote_port_file</span><span class="p">)</span>
 624         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-o </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">local_ip</span><span class="p">)</span>
 625         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-O </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">remote_ip</span><span class="p">)</span>
 626         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-R </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">ret_file</span><span class="p">)</span>
 627         <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;pi&quot;</span><span class="p">):</span>
 628             <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-n&quot;</span><span class="p">)</span>
 629         <span class="k">if</span> <span class="n">cipher</span><span class="p">:</span>
 630             <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-c </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">cipher</span><span class="p">)</span>
 631         <span class="k">if</span> <span class="n">cipher_key</span><span class="p">:</span>
 632             <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-k </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">cipher_key</span><span class="p">)</span>
 633         <span class="k">if</span> <span class="n">txqueuelen</span><span class="p">:</span>
 634             <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="n">txqueuelen</span><span class="p">)</span>
 635         <span class="k">if</span> <span class="n">bwlimit</span><span class="p">:</span>
 636             <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;-b </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">bwlimit</span><span class="p">)</span>
 637
 638         <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>
 639         <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>
 640
 641         <span class="k">return</span> <span class="n">command</span>
 642
 643     <span class="nd">@property</span>
 644     <span class="k">def</span> <span class="nf">_dependencies</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 645         <span class="k">return</span> <span class="s">&quot;mercurial make gcc&quot;</span>
 646
 647     <span class="nd">@property</span>
 648     <span class="k">def</span> <span class="nf">_install</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 649         <span class="c"># Install python-vsys and python-passfd</span>
 650         <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>
 651                     <span class="s">&quot; || &quot;</span>
 652                     <span class="s">&quot; ( &quot;</span>
 653                     <span class="s">&quot;   cd ${SRC} ; &quot;</span>
 654                     <span class="s">&quot;   hg clone http://nepi.inria.fr/code/python-passfd ; &quot;</span>
 655                     <span class="s">&quot;   cd python-passfd ; &quot;</span>
 656                     <span class="s">&quot;   make all ; &quot;</span>
 657                     <span class="s">&quot;   sudo -S make install &quot;</span>
 658                     <span class="s">&quot; )&quot;</span> <span class="p">)</span>
 659
 660         <span class="k">return</span> <span class="n">install_passfd</span>
 661
 662     <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>
 663         <span class="c"># TODO: Validate!</span>
 664         <span class="k">return</span> <span class="bp">True</span>
 665
 666     <span class="nd">@property</span>
 667 <div class="viewcode-block" id="LinuxTap.vif_type"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.vif_type">[docs]</a>    <span class="k">def</span> <span class="nf">vif_type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 668         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vif_type</span>
 669 </div>
 670     <span class="nd">@property</span>
 671 <div class="viewcode-block" id="LinuxTap.vif_type_flag"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.vif_type_flag">[docs]</a>    <span class="k">def</span> <span class="nf">vif_type_flag</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 672         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vif_type_flag</span>
 673  </div>
 674     <span class="nd">@property</span>
 675 <div class="viewcode-block" id="LinuxTap.vif_prefix"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.vif_prefix">[docs]</a>    <span class="k">def</span> <span class="nf">vif_prefix</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 676         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vif_prefix</span>
 677 </div>
 678     <span class="nd">@property</span>
 679 <div class="viewcode-block" id="LinuxTap.sock_name"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.sock_name">[docs]</a>    <span class="k">def</span> <span class="nf">sock_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 680         <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;</span><span class="si">%s</span><span class="s">.sock&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">vif_prefix</span><span class="p">)</span>
 681 </div>
 682 <div class="viewcode-block" id="LinuxTap.valid_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.tap.LinuxTap.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>
 683         <span class="c"># TODO: Validate!</span>
 684         <span class="k">return</span> <span class="bp">True</span>
 685 </pre></div></div></div>
 686
 687           </div>
 688         </div>
 689       </div>
 690       <div class="clearer"></div>
 691     </div>
 692     <div class="related">
 693       <h3>Navigation</h3>
 694       <ul>
 695         <li class="right" style="margin-right: 10px">
 696           <a href="../../../../genindex.html" title="General Index"
 697              >index</a></li>
 698         <li class="right" >
 699           <a href="../../../../py-modindex.html" title="Python Module Index"
 700              >modules</a> |</li>
 701         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 702           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 703       </ul>
 704     </div>
 705     <div class="footer">
 706         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 707       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 708     </div>
 709   </body>
 710 </html>