update NEPI version on sphinx docs
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / planetlab / openvswitch / ovsport.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6   <head>
7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8     
9     <title>nepi.resources.planetlab.openvswitch.ovsport &mdash; NEPI 3.2 documentation</title>
10     
11     <link rel="stylesheet" href="../../../../../_static/sphinxdoc.css" type="text/css" />
12     <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
13     
14     <script type="text/javascript">
15       var DOCUMENTATION_OPTIONS = {
16         URL_ROOT:    '../../../../../',
17         VERSION:     '3.2',
18         COLLAPSE_INDEX: false,
19         FILE_SUFFIX: '.html',
20         HAS_SOURCE:  true
21       };
22     </script>
23     <script type="text/javascript" src="../../../../../_static/jquery.js"></script>
24     <script type="text/javascript" src="../../../../../_static/underscore.js"></script>
25     <script type="text/javascript" src="../../../../../_static/doctools.js"></script>
26     <link rel="top" title="NEPI 3.2 documentation" href="../../../../../index.html" />
27     <link rel="up" title="Module code" href="../../../../index.html" /> 
28   </head>
29   <body>
30     <div class="related">
31       <h3>Navigation</h3>
32       <ul>
33         <li class="right" style="margin-right: 10px">
34           <a href="../../../../../genindex.html" title="General Index"
35              accesskey="I">index</a></li>
36         <li class="right" >
37           <a href="../../../../../py-modindex.html" title="Python Module Index"
38              >modules</a> |</li>
39         <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
40           <li><a href="../../../../index.html" accesskey="U">Module code</a> &raquo;</li> 
41       </ul>
42     </div>
43       <div class="sphinxsidebar">
44         <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
46   <h3>Quick search</h3>
47     <form class="search" action="../../../../../search.html" method="get">
48       <input type="text" name="q" />
49       <input type="submit" value="Go" />
50       <input type="hidden" name="check_keywords" value="yes" />
51       <input type="hidden" name="area" value="default" />
52     </form>
53     <p class="searchtip" style="font-size: 90%">
54     Enter search terms or a module, class or function name.
55     </p>
56 </div>
57 <script type="text/javascript">$('#searchbox').show(0);</script>
58         </div>
59       </div>
60
61     <div class="document">
62       <div class="documentwrapper">
63         <div class="bodywrapper">
64           <div class="body">
65             
66   <h1>Source code for nepi.resources.planetlab.openvswitch.ovsport</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"># Authors: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
84 <span class="c">#         Alexandros Kouvakas &lt;alexandros.kouvakas@inria.fr&gt;</span>
85 <span class="c">#         Julien Tribino &lt;julien.tribino@inria.fr&gt;</span>
86
87 <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>
88 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">ResourceManager</span><span class="p">,</span> <span class="n">clsinit_copy</span><span class="p">,</span> \
89         <span class="n">ResourceState</span>
90 <span class="kn">from</span> <span class="nn">nepi.resources.planetlab.openvswitch.ovs</span> <span class="kn">import</span> <span class="n">PlanetlabOVSSwitch</span>        
91 <span class="kn">from</span> <span class="nn">nepi.resources.planetlab.node</span> <span class="kn">import</span> <span class="n">PlanetlabNode</span>        
92 <span class="kn">from</span> <span class="nn">nepi.resources.linux.application</span> <span class="kn">import</span> <span class="n">LinuxApplication</span>
93
94 <span class="kn">import</span> <span class="nn">os</span>
95
96 <span class="nd">@clsinit_copy</span>                 
97 <div class="viewcode-block" id="PlanetlabOVSPort"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort">[docs]</a><span class="k">class</span> <span class="nc">PlanetlabOVSPort</span><span class="p">(</span><span class="n">LinuxApplication</span><span class="p">):</span>
98     <span class="sd">&quot;&quot;&quot;</span>
99 <span class="sd">    .. class:: Class Args :</span>
100 <span class="sd">      </span>
101 <span class="sd">        :param ec: The Experiment controller</span>
102 <span class="sd">        :type ec: ExperimentController</span>
103 <span class="sd">        :param guid: guid of the RM</span>
104 <span class="sd">        :type guid: int</span>
105
106 <span class="sd">    &quot;&quot;&quot;</span>
107     
108     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;planetlab::OVSPort&quot;</span>
109     <span class="n">_help</span> <span class="o">=</span> <span class="s">&quot;Runs an OpenVSwitch on a PlanetLab host&quot;</span>
110     <span class="n">_platform</span> <span class="o">=</span> <span class="s">&quot;planetlab&quot;</span>
111
112     <span class="n">_authorized_connections</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;planetlab::OVSSwitch&quot;</span><span class="p">,</span> <span class="s">&quot;linux::UdpTunnel&quot;</span><span class="p">,</span> <span class="s">&quot;linux::Tunnel&quot;</span><span class="p">]</span>      
113
114     <span class="nd">@classmethod</span>
115     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
116         <span class="sd">&quot;&quot;&quot; Register the attributes of OVSPort RM </span>
117
118 <span class="sd">        &quot;&quot;&quot;</span>
119         <span class="n">port_name</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;port_name&quot;</span><span class="p">,</span> <span class="s">&quot;Name of the port&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">Design</span><span class="p">)</span>                     
121         <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;IP of the endpoint. This is the attribute &quot;</span> 
122                                 <span class="s">&quot;you should use to establish a tunnel or a remote &quot;</span>
123                                 <span class="s">&quot;connection between endpoint&quot;</span><span class="p">,</span>
124             <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>
125         <span class="n">network</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;network&quot;</span><span class="p">,</span> <span class="s">&quot;Network used by the port&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">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">port_name</span><span class="p">)</span>
129         <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>
130         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">network</span><span class="p">)</span>
131
132     <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>
133         <span class="sd">&quot;&quot;&quot;</span>
134 <span class="sd">        :param ec: The Experiment controller</span>
135 <span class="sd">        :type ec: ExperimentController</span>
136 <span class="sd">        :param guid: guid of the RM</span>
137 <span class="sd">        :type guid: int</span>
138 <span class="sd">    </span>
139 <span class="sd">        &quot;&quot;&quot;</span>
140         <span class="nb">super</span><span class="p">(</span><span class="n">PlanetlabOVSPort</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>
141         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;ovsport-</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span>
142         <span class="bp">self</span><span class="o">.</span><span class="n">_port_number</span> <span class="o">=</span> <span class="bp">None</span>
143
144     <span class="nd">@property</span>
145 <div class="viewcode-block" id="PlanetlabOVSPort.node"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.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>
146         <span class="sd">&quot;&quot;&quot; Node that run the switch and the ports</span>
147 <span class="sd">        &quot;&quot;&quot;</span>
148         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ovsswitch</span><span class="o">.</span><span class="n">node</span>
149 </div>
150     <span class="nd">@property</span>
151 <div class="viewcode-block" id="PlanetlabOVSPort.ovsswitch"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.ovsswitch">[docs]</a>    <span class="k">def</span> <span class="nf">ovsswitch</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
152         <span class="sd">&quot;&quot;&quot; Switch where the port is created</span>
153 <span class="sd">        &quot;&quot;&quot;</span>
154         <span class="n">ovsswitch</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">PlanetlabOVSSwitch</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
155         <span class="k">if</span> <span class="n">ovsswitch</span><span class="p">:</span> <span class="k">return</span> <span class="n">ovsswitch</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
156         <span class="k">return</span> <span class="bp">None</span>
157         </div>
158     <span class="nd">@property</span>
159 <div class="viewcode-block" id="PlanetlabOVSPort.port_number"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.port_number">[docs]</a>    <span class="k">def</span> <span class="nf">port_number</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
160         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_port_number</span>
161 </div>
162 <div class="viewcode-block" id="PlanetlabOVSPort.valid_connection"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.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>
163         <span class="sd">&quot;&quot;&quot; Check if the connection is available.</span>
164
165 <span class="sd">        :param guid: Guid of the current RM</span>
166 <span class="sd">        :type guid: int</span>
167 <span class="sd">        :rtype:  Boolean</span>
168
169 <span class="sd">        &quot;&quot;&quot;</span>
170         <span class="n">rm</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">get_resource</span><span class="p">(</span><span class="n">guid</span><span class="p">)</span>
171         <span class="k">if</span> <span class="n">rm</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_authorized_connections</span><span class="p">:</span>
172             <span class="k">return</span> <span class="bp">False</span>
173
174         <span class="k">return</span> <span class="bp">True</span>
175 </div>
176 <div class="viewcode-block" id="PlanetlabOVSPort.create_port"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.create_port">[docs]</a>    <span class="k">def</span> <span class="nf">create_port</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
177         <span class="sd">&quot;&quot;&quot; Create the desired port</span>
178 <span class="sd">        &quot;&quot;&quot;</span>
179         <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Creating the port </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">&#39;port_name&#39;</span><span class="p">)</span>
180         <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
181
182         <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">&#39;port_name&#39;</span><span class="p">):</span>
183             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;The port name is not assigned&quot;</span>
184             <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>
185             <span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">,</span> <span class="n">msg</span>
186
187         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ovsswitch</span><span class="p">:</span>
188             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;The OVSwitch RM is not running&quot;</span>
189             <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>
190             <span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">,</span> <span class="n">msg</span>
191
192         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;sliver-ovs create-port </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>
193                 <span class="bp">self</span><span class="o">.</span><span class="n">ovsswitch</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;bridge_name&#39;</span><span class="p">),</span>
194                 <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;port_name&#39;</span><span class="p">))</span>   
195         
196         <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;create_port.sh&quot;</span><span class="p">)</span>
197         <span class="k">try</span><span class="p">:</span>
198             <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>
199                     <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
200                     <span class="n">sudo</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
201                     <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;port_stdout&quot;</span><span class="p">,</span> 
202                     <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;port_stderr&quot;</span><span class="p">,</span>
203                     <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;port_pidfile&quot;</span><span class="p">,</span>
204                     <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;port_exitcode&quot;</span><span class="p">)</span>
205         <span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
206             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Could not create ovs-port&quot;</span>             
207             <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
208             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
209
210         <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Created port </span><span class="si">%s</span><span class="s"> on switch </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span>
211             <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;port_name&#39;</span><span class="p">),</span>
212             <span class="bp">self</span><span class="o">.</span><span class="n">ovsswitch</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;bridge_name&#39;</span><span class="p">)))</span>     
213             </div>
214 <div class="viewcode-block" id="PlanetlabOVSPort.initiate_udp_connection"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.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> 
215             <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>
216         <span class="sd">&quot;&quot;&quot; Get the local_endpoint of the port</span>
217 <span class="sd">        &quot;&quot;&quot;</span>
218         <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Discovering the port number for </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">&#39;port_name&#39;</span><span class="p">)</span>
219         <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
220
221         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;sliver-ovs get-local-endpoint </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">&#39;port_name&#39;</span><span class="p">)</span>
222
223         <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;get_port.sh&quot;</span><span class="p">)</span>
224         <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_and_wait</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">,</span>
225                 <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
226                 <span class="n">sudo</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> 
227                 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
228                 <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;get_port_pidfile&quot;</span><span class="p">,</span>
229                 <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;get_port_exitcode&quot;</span><span class="p">,</span> 
230                 <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;get_port_stdout&quot;</span><span class="p">,</span>    
231                 <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;get_port_stderr&quot;</span><span class="p">)</span>
232
233         <span class="k">if</span> <span class="n">err</span> <span class="o">!=</span> <span class="s">&quot;&quot;</span><span class="p">:</span>
234             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Error retrieving the local endpoint of the port&quot;</span>
235             <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>
236             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
237
238         <span class="k">if</span> <span class="n">out</span><span class="p">:</span>
239             <span class="bp">self</span><span class="o">.</span><span class="n">_port_number</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
240
241         <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;The number of the </span><span class="si">%s</span><span class="s"> is </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">get</span><span class="p">(</span><span class="s">&#39;port_name&#39;</span><span class="p">),</span> 
242            <span class="bp">self</span><span class="o">.</span><span class="n">port_number</span><span class="p">))</span>
243
244         <span class="c"># Must set a routing rule in the ovs client nodes so they know</span>
245         <span class="c"># that the LAN can be found through the switch</span>
246         <span class="k">if</span> <span class="n">remote_endpoint</span><span class="o">.</span><span class="n">is_rm_instance</span><span class="p">(</span><span class="s">&quot;planetlab::Tap&quot;</span><span class="p">):</span>
247             <span class="bp">self</span><span class="o">.</span><span class="n">_vroute</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">register_resource</span><span class="p">(</span><span class="s">&quot;planetlab::Vroute&quot;</span><span class="p">)</span>
248             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_vroute</span><span class="p">,</span> <span class="s">&quot;action&quot;</span><span class="p">,</span> <span class="s">&quot;add&quot;</span><span class="p">)</span>
249             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_vroute</span><span class="p">,</span> <span class="s">&quot;prefix&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;prefix&quot;</span><span class="p">))</span>
250             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_vroute</span><span class="p">,</span> <span class="s">&quot;nexthop&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;pointopoint&quot;</span><span class="p">))</span>
251             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_vroute</span><span class="p">,</span> <span class="s">&quot;network&quot;</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;network&quot;</span><span class="p">))</span>
252
253             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">register_connection</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_vroute</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="o">.</span><span class="n">guid</span><span class="p">)</span>
254             <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">deploy</span><span class="p">(</span><span class="n">guids</span><span class="o">=</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_vroute</span><span class="p">],</span> <span class="n">group</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">deployment_group</span><span class="p">)</span>
255
256             <span class="c"># For debugging</span>
257             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Route for the tap configured&quot;</span>
258             <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
259
260         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">port_number</span>
261 </div>
262 <div class="viewcode-block" id="PlanetlabOVSPort.establish_udp_connection"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.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>
263             <span class="n">connection_app_home</span><span class="p">,</span>
264             <span class="n">connection_run_home</span><span class="p">,</span> 
265             <span class="n">port</span><span class="p">):</span>
266         <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>
267         <span class="n">command</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_establish_connection_command</span><span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="n">remote_ip</span><span class="p">)</span>
268
269         <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;connect_port.sh&quot;</span><span class="p">)</span>
270         <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_and_wait</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">connection_run_home</span><span class="p">,</span>
271                 <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
272                 <span class="n">sudo</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> 
273                 <span class="n">overwrite</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
274                 <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;connect_port_pidfile&quot;</span><span class="p">,</span>
275                 <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;connect_port_exitcode&quot;</span><span class="p">,</span> 
276                 <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;connect_port_stdout&quot;</span><span class="p">,</span>    
277                 <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;connect_port_stderr&quot;</span><span class="p">)</span>
278
279         <span class="c"># For debugging</span>
280         <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Connection on port configured&quot;</span>
281         <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
282 </div>
283     <span class="k">def</span> <span class="nf">_establish_connection_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">remote_ip</span><span class="p">):</span>
284         <span class="sd">&quot;&quot;&quot; Script to create the connection from a switch to a </span>
285 <span class="sd">             remote endpoint</span>
286 <span class="sd">        &quot;&quot;&quot;</span>
287         <span class="n">local_port_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;port_name&#39;</span><span class="p">)</span>
288
289         <span class="n">command</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;sliver-ovs&quot;</span><span class="p">]</span>
290         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&quot;set-remote-endpoint&quot;</span><span class="p">)</span>
291         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">local_port_name</span><span class="p">)</span>
292         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">remote_ip</span><span class="p">)</span>
293         <span class="n">command</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">port</span><span class="p">)</span>
294         <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>
295         <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>
296         <span class="k">return</span> <span class="n">command</span>
297        
298 <div class="viewcode-block" id="PlanetlabOVSPort.verify_connection"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.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> <span class="n">connection_app_home</span><span class="p">,</span> 
299                 <span class="n">connection_run_home</span><span class="p">):</span>
300         <span class="bp">self</span><span class="o">.</span><span class="n">ovsswitch</span><span class="o">.</span><span class="n">ovs_status</span><span class="p">()</span>
301 </div>
302 <div class="viewcode-block" id="PlanetlabOVSPort.terminate_connection"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.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">endpoint</span><span class="p">,</span> <span class="n">connection_app_home</span><span class="p">,</span> 
303                 <span class="n">connection_run_home</span><span class="p">):</span>
304         <span class="k">return</span> <span class="bp">True</span>
305 </div>
306 <div class="viewcode-block" id="PlanetlabOVSPort.check_status"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.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>
307         <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>
308 </div>
309 <div class="viewcode-block" id="PlanetlabOVSPort.do_provision"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.do_provision">[docs]</a>    <span class="k">def</span> <span class="nf">do_provision</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
310         <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">)</span>
311
312         <span class="bp">self</span><span class="o">.</span><span class="n">create_port</span><span class="p">()</span>
313         <span class="n">end_ip</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ovsswitch</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;virtual_ip_pref&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&#39;/&#39;</span><span class="p">)</span>
314         <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;ip&quot;</span><span class="p">,</span> <span class="n">end_ip</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
315
316         <span class="c">#Check the status of the OVS Switch</span>
317         <span class="bp">self</span><span class="o">.</span><span class="n">ovsswitch</span><span class="o">.</span><span class="n">ovs_status</span><span class="p">()</span>
318     
319         <span class="bp">self</span><span class="o">.</span><span class="n">set_provisioned</span><span class="p">()</span>
320                 </div>
321 <div class="viewcode-block" id="PlanetlabOVSPort.do_deploy"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.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>
322         <span class="sd">&quot;&quot;&quot; Deploy the OVS port after the OVS Switch</span>
323 <span class="sd">        &quot;&quot;&quot;</span>
324         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">ovsswitch</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">ovsswitch</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">READY</span><span class="p">:</span>       
325             <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;---- RESCHEDULING DEPLOY ---- OVSwitch state </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">ovsswitch</span><span class="o">.</span><span class="n">state</span> <span class="p">)</span>  
326             <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>
327         <span class="k">else</span><span class="p">:</span>
328             <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
329             <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
330
331             <span class="bp">self</span><span class="o">.</span><span class="n">set_ready</span><span class="p">()</span>
332 </div>
333 <div class="viewcode-block" id="PlanetlabOVSPort.do_release"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovsport.PlanetlabOVSPort.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>
334         <span class="sd">&quot;&quot;&quot; Delete the port on the OVSwitch. It needs to wait for the tunnel</span>
335 <span class="sd">        to be released.</span>
336 <span class="sd">        &quot;&quot;&quot;</span>
337         <span class="kn">from</span> <span class="nn">nepi.resources.linux.udptunnel</span> <span class="kn">import</span> <span class="n">LinuxUdpTunnel</span>
338         <span class="n">rm</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">LinuxUdpTunnel</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
339
340         <span class="k">if</span> <span class="n">rm</span> <span class="ow">and</span> <span class="n">rm</span><span class="p">[</span><span class="mi">0</span><span class="p">]</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>
341             <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>
342             <span class="k">return</span> 
343             
344         <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Deleting the port </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">&#39;port_name&#39;</span><span class="p">)</span>
345         <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
346
347         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;sliver-ovs del_port </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">&#39;port_name&#39;</span><span class="p">)</span>
348
349         <span class="n">shfile</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app_home</span><span class="p">,</span> <span class="s">&quot;stop.sh&quot;</span><span class="p">)</span>
350         <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>
351                 <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
352                 <span class="n">sudo</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> 
353                 <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;stop_pidfile&quot;</span><span class="p">,</span>
354                 <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;stop_exitcode&quot;</span><span class="p">,</span> 
355                 <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;stop_stdout&quot;</span><span class="p">,</span> 
356                 <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;stop_stderr&quot;</span><span class="p">)</span>
357
358         <span class="nb">super</span><span class="p">(</span><span class="n">PlanetlabOVSPort</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 </pre></div></div></div>
360
361           </div>
362         </div>
363       </div>
364       <div class="clearer"></div>
365     </div>
366     <div class="related">
367       <h3>Navigation</h3>
368       <ul>
369         <li class="right" style="margin-right: 10px">
370           <a href="../../../../../genindex.html" title="General Index"
371              >index</a></li>
372         <li class="right" >
373           <a href="../../../../../py-modindex.html" title="Python Module Index"
374              >modules</a> |</li>
375         <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
376           <li><a href="../../../../index.html" >Module code</a> &raquo;</li> 
377       </ul>
378     </div>
379     <div class="footer">
380         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
381       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
382     </div>
383   </body>
384 </html>