update NEPI version on sphinx docs
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / planetlab / openvswitch / ovs.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.ovs &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.ovs</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
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.execution.attribute</span> <span class="kn">import</span> <span class="n">Attribute</span><span class="p">,</span> <span class="n">Flags</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 <span class="kn">import</span> <span class="nn">os</span>
94
95 <span class="nd">@clsinit_copy</span>                    
96 <div class="viewcode-block" id="PlanetlabOVSSwitch"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch">[docs]</a><span class="k">class</span> <span class="nc">PlanetlabOVSSwitch</span><span class="p">(</span><span class="n">LinuxApplication</span><span class="p">):</span>
97     <span class="sd">&quot;&quot;&quot;</span>
98 <span class="sd">    .. class:: Class Args :</span>
99 <span class="sd">      </span>
100 <span class="sd">        :param ec: The Experiment controller</span>
101 <span class="sd">        :type ec: ExperimentController</span>
102 <span class="sd">        :param guid: guid of the RM</span>
103 <span class="sd">        :type guid: int</span>
104
105 <span class="sd">    &quot;&quot;&quot;</span>
106
107     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;planetlab::OVSSwitch&quot;</span>
108     <span class="n">_help</span> <span class="o">=</span> <span class="s">&quot;Runs an OpenVSwitch on a PlanetLab host&quot;</span>
109     <span class="n">_platform</span> <span class="o">=</span> <span class="s">&quot;planetlab&quot;</span>
110
111     <span class="n">_authorized_connections</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;planetlab::Node&quot;</span><span class="p">,</span> <span class="s">&quot;planetla::OVSPort&quot;</span><span class="p">,</span> <span class="s">&quot;linux::Node&quot;</span><span class="p">]</span>       
112
113     <span class="nd">@classmethod</span>
114     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
115         <span class="sd">&quot;&quot;&quot; Register the attributes of OVSSwitch RM </span>
116
117 <span class="sd">        &quot;&quot;&quot;</span>
118         <span class="n">bridge_name</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;bridge_name&quot;</span><span class="p">,</span> 
119                 <span class="s">&quot;Name of the switch/bridge&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">virtual_ip_pref</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;virtual_ip_pref&quot;</span><span class="p">,</span> 
122                 <span class="s">&quot;Virtual IP/PREFIX of the switch&quot;</span><span class="p">,</span>
123                 <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> 
124         <span class="n">controller_ip</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;controller_ip&quot;</span><span class="p">,</span> 
125                 <span class="s">&quot;IP of the controller&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         <span class="n">controller_port</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;controller_port&quot;</span><span class="p">,</span> 
128                 <span class="s">&quot;Port of the controller&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">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">bridge_name</span><span class="p">)</span>
132         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">virtual_ip_pref</span><span class="p">)</span>
133         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">controller_ip</span><span class="p">)</span>
134         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">controller_port</span><span class="p">)</span>
135
136     <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>
137         <span class="sd">&quot;&quot;&quot;</span>
138 <span class="sd">        :param ec: The Experiment controller</span>
139 <span class="sd">        :type ec: ExperimentController</span>
140 <span class="sd">        :param guid: guid of the RM</span>
141 <span class="sd">        :type guid: int</span>
142 <span class="sd">    </span>
143 <span class="sd">        &quot;&quot;&quot;</span>
144         <span class="nb">super</span><span class="p">(</span><span class="n">PlanetlabOVSSwitch</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>
145         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;ovsswitch-</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>
146         <span class="bp">self</span><span class="o">.</span><span class="n">_node</span> <span class="o">=</span> <span class="bp">None</span>
147
148     <span class="nd">@property</span>
149 <div class="viewcode-block" id="PlanetlabOVSSwitch.node"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.node">[docs]</a>    <span class="k">def</span> <span class="nf">node</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
150         <span class="sd">&quot;&quot;&quot; Node wthat run the switch</span>
151 <span class="sd">        &quot;&quot;&quot;</span>
152         <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="p">:</span>
153             <span class="n">nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">PlanetlabNode</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
154             <span class="k">if</span> <span class="ow">not</span> <span class="n">nodes</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">nodes</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span> 
155                 <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;PlanetlabOVSSwitch must be connected to exactly one PlanetlabNode&quot;</span>
156                 <span class="c">#self.error(msg)</span>
157                 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
158
159             <span class="bp">self</span><span class="o">.</span><span class="n">_node</span> <span class="o">=</span> <span class="n">nodes</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
160
161         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_node</span>
162 </div>
163 <div class="viewcode-block" id="PlanetlabOVSSwitch.valid_connection"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.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>
164         <span class="sd">&quot;&quot;&quot; Check if the connection with the guid in parameter is possible. Only meaningful connections are allowed.</span>
165
166 <span class="sd">        :param guid: Guid of the current RM</span>
167 <span class="sd">        :type guid: int</span>
168 <span class="sd">        :rtype:  Boolean</span>
169
170 <span class="sd">        &quot;&quot;&quot;</span>
171         <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>
172         <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>
173             <span class="k">return</span> <span class="bp">False</span>
174         <span class="k">return</span> <span class="bp">True</span>
175 </div>
176 <div class="viewcode-block" id="PlanetlabOVSSwitch.do_provision"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.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>
177         <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>
178
179         <span class="bp">self</span><span class="o">.</span><span class="n">check_sliver_ovs</span><span class="p">()</span>
180         <span class="bp">self</span><span class="o">.</span><span class="n">servers_on</span><span class="p">()</span>
181         <span class="bp">self</span><span class="o">.</span><span class="n">create_bridge</span><span class="p">()</span>
182         <span class="bp">self</span><span class="o">.</span><span class="n">assign_controller</span><span class="p">()</span>
183         <span class="bp">self</span><span class="o">.</span><span class="n">ovs_status</span><span class="p">()</span>
184         
185         <span class="bp">self</span><span class="o">.</span><span class="n">set_provisioned</span><span class="p">()</span>
186                                 </div>
187 <div class="viewcode-block" id="PlanetlabOVSSwitch.do_deploy"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.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>
188         <span class="sd">&quot;&quot;&quot; Deploy the OVS Switch : Turn on the server, create the bridges</span>
189 <span class="sd">            and assign the controller</span>
190 <span class="sd">        &quot;&quot;&quot;</span>
191
192         <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">READY</span><span class="p">:</span>
193             <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">&quot;---- RESCHEDULING DEPLOY ---- node 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">node</span><span class="o">.</span><span class="n">state</span><span class="p">)</span>
194             <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>
195         <span class="k">else</span><span class="p">:</span>
196             <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
197             <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
198                
199             <span class="bp">self</span><span class="o">.</span><span class="n">set_ready</span><span class="p">()</span>
200 </div>
201 <div class="viewcode-block" id="PlanetlabOVSSwitch.check_sliver_ovs"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.check_sliver_ovs">[docs]</a>    <span class="k">def</span> <span class="nf">check_sliver_ovs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>  
202         <span class="sd">&quot;&quot;&quot; Check if sliver-ovs exists. If it does not exist, the execution is stopped</span>
203 <span class="sd">        &quot;&quot;&quot;</span>
204         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;compgen -c | grep sliver-ovs&quot;</span>                 
205         <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;check_ovs_cmd.sh&quot;</span><span class="p">)</span>
206         <span class="k">try</span><span class="p">:</span>
207             <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>
208                     <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
209                     <span class="n">sudo</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> 
210                     <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;check_ovs_cmd_pidfile&quot;</span><span class="p">,</span>
211                     <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;check_ovs_cmd_exitcode&quot;</span><span class="p">,</span> 
212                     <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;check_ovs_cmd_stdout&quot;</span><span class="p">,</span> 
213                     <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;check_ovs_cmd_stderr&quot;</span><span class="p">)</span>
214         <span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
215             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Command sliver-ovs does not exist on the VM&quot;</span>           
216             <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>
217             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
218 </div>
219 <div class="viewcode-block" id="PlanetlabOVSSwitch.servers_on"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.servers_on">[docs]</a>    <span class="k">def</span> <span class="nf">servers_on</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
220         <span class="sd">&quot;&quot;&quot; Start the openvswitch servers and check it</span>
221 <span class="sd">        &quot;&quot;&quot;</span>
222         <span class="c"># Make sure the server is not running        </span>
223         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;sliver-ovs del-bridge </span><span class="si">%s</span><span class="s">; sliver-ovs stop&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;bridge_name&#39;</span><span class="p">)</span>
224         <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;clean.sh&quot;</span><span class="p">)</span>
225         <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>
226                 <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
227                 <span class="n">sudo</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
228                 <span class="n">raise_on_error</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
229                 <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;clean_pidfile&quot;</span><span class="p">,</span>
230                 <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;clean_exitcode&quot;</span><span class="p">,</span> 
231                 <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;clean_stdout&quot;</span><span class="p">,</span> 
232                 <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;clean_stderr&quot;</span><span class="p">)</span>
233
234         <span class="c"># start the server        </span>
235         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;sliver-ovs start&quot;</span>             
236         <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>
237         <span class="k">try</span><span class="p">:</span>
238             <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>
239                     <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
240                     <span class="n">sudo</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> 
241                     <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;start_pidfile&quot;</span><span class="p">,</span>
242                     <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;start_exitcode&quot;</span><span class="p">,</span> 
243                     <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;start_stdout&quot;</span><span class="p">,</span> 
244                     <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;start_stderr&quot;</span><span class="p">)</span>
245         <span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
246             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Failed to start ovs-server on VM&quot;</span>      
247             <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>
248             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
249
250         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;ps -A | grep ovsdb-server&quot;</span>
251         <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;ovsdb_status.sh&quot;</span><span class="p">)</span>
252         <span class="k">try</span><span class="p">:</span>
253             <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>
254                     <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
255                     <span class="n">sudo</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> 
256                     <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;ovsdb_status_pidfile&quot;</span><span class="p">,</span>
257                     <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;ovsdb_status_exitcode&quot;</span><span class="p">,</span> 
258                     <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;ovsdb_status_stdout&quot;</span><span class="p">,</span> 
259                     <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;ovsdb_status_stderr&quot;</span><span class="p">)</span>
260         <span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
261             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;ovsdb-server not running on VM&quot;</span>        
262             <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>
263             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
264         
265         <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Server OVS Started...&quot;</span><span class="p">)</span>  
266 </div>
267 <div class="viewcode-block" id="PlanetlabOVSSwitch.create_bridge"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.create_bridge">[docs]</a>    <span class="k">def</span> <span class="nf">create_bridge</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
268         <span class="sd">&quot;&quot;&quot; Create the bridge/switch and check error during SSH connection</span>
269 <span class="sd">        &quot;&quot;&quot;</span>
270         <span class="c"># TODO: Check if previous bridge exist and delete them. Use ovs-vsctl list-br</span>
271         <span class="c"># TODO: Add check for virtual_ip belonging to vsys_tag</span>
272         <span class="k">if</span> <span class="ow">not</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;bridge_name&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;virtual_ip_pref&quot;</span><span class="p">)):</span>
273             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;No assignment in one or both attributes&quot;</span>
274             <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>
275             <span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">,</span> <span class="n">msg</span>
276
277         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;sliver-ovs create-bridge &#39;</span><span class="si">%s</span><span class="s">&#39; &#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span>
278                           <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;bridge_name&quot;</span><span class="p">),</span> 
279                           <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;virtual_ip_pref&quot;</span><span class="p">))</span> 
280         
281         <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;bridge_create.sh&quot;</span><span class="p">)</span>
282         <span class="k">try</span><span class="p">:</span>
283             <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>
284                     <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
285                     <span class="n">sudo</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> 
286                     <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;bridge_create_pidfile&quot;</span><span class="p">,</span>
287                     <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;bridge_create_exitcode&quot;</span><span class="p">,</span> 
288                     <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;bridge_create_stdout&quot;</span><span class="p">,</span> 
289                     <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;bridge_create_stderr&quot;</span><span class="p">)</span>
290         <span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
291             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;No such pltap netdev</span><span class="se">\n</span><span class="s">ovs-appctl: ovs-vswitchd: server returned an error&quot;</span>
292             <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>
293             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
294
295         <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot; Bridge </span><span class="si">%s</span><span class="s"> Created and Assigned to </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span>\
296             <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;bridge_name&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;virtual_ip_pref&quot;</span><span class="p">))</span> <span class="p">)</span>
297 </div>
298 <div class="viewcode-block" id="PlanetlabOVSSwitch.assign_controller"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.assign_controller">[docs]</a>    <span class="k">def</span> <span class="nf">assign_controller</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
299         <span class="sd">&quot;&quot;&quot; Set the controller IP</span>
300 <span class="sd">        &quot;&quot;&quot;</span>
301
302         <span class="k">if</span> <span class="ow">not</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;controller_ip&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;controller_port&quot;</span><span class="p">)):</span>
303             <span class="k">return</span> 
304
305         <span class="sd">&quot;&quot;&quot;</span>
306 <span class="sd">        if not (self.get(&quot;controller_ip&quot;) and self.get(&quot;controller_port&quot;)):</span>
307 <span class="sd">            msg = &quot;No assignment in one or both attributes&quot;</span>
308 <span class="sd">            self.error(msg)</span>
309 <span class="sd">            raise AttributeError, msg</span>
310 <span class="sd">        &quot;&quot;&quot;</span>
311         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;ovs-vsctl set-controller </span><span class="si">%s</span><span class="s"> tcp:</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> \
312                 <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;bridge_name&quot;</span><span class="p">),</span> 
313                         <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;controller_ip&quot;</span><span class="p">),</span> 
314                         <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;controller_port&quot;</span><span class="p">))</span>
315         
316         <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;set_controller.sh&quot;</span><span class="p">)</span>
317         <span class="k">try</span><span class="p">:</span>
318             <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>
319                     <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
320                     <span class="n">sudo</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> 
321                     <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;set_controller_pidfile&quot;</span><span class="p">,</span>
322                     <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;set_controller_exitcode&quot;</span><span class="p">,</span> 
323                     <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;set_controller_stdout&quot;</span><span class="p">,</span> 
324                     <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;set_controller_stderr&quot;</span><span class="p">)</span>
325         <span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
326             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;SSH connection in the method assign_controller&quot;</span>
327             <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>
328             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
329
330         <span class="bp">self</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Controller assigned to the bridge </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;bridge_name&quot;</span><span class="p">))</span>
331             </div>
332 <div class="viewcode-block" id="PlanetlabOVSSwitch.ovs_status"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.ovs_status">[docs]</a>    <span class="k">def</span> <span class="nf">ovs_status</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
333         <span class="sd">&quot;&quot;&quot; Print the status of the bridge                              </span>
334 <span class="sd">        &quot;&quot;&quot;</span>
335         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;sliver-ovs show | tail -n +2&quot;</span>
336         <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;ovs_status.sh&quot;</span><span class="p">)</span>
337         <span class="k">try</span><span class="p">:</span>
338             <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>
339                     <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
340                     <span class="n">sudo</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> 
341                     <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;ovs_status_pidfile&quot;</span><span class="p">,</span>
342                     <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;ovs_status_exitcode&quot;</span><span class="p">,</span> 
343                     <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;ovs_status_stdout&quot;</span><span class="p">,</span> 
344                     <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;ovs_status_stderr&quot;</span><span class="p">)</span>
345         <span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
346             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Error when checking the status of the OpenVswitch&quot;</span>
347             <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>
348             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
349 </div>
350 <div class="viewcode-block" id="PlanetlabOVSSwitch.do_release"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.planetlab.openvswitch.html#nepi.resources.planetlab.openvswitch.ovs.PlanetlabOVSSwitch.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>
351         <span class="sd">&quot;&quot;&quot; Delete the bridge and close the server.  </span>
352
353 <span class="sd">          .. note : It need to wait for the others RM (OVSPort and OVSTunnel)</span>
354 <span class="sd">        to be released before releasing itself</span>
355
356 <span class="sd">        &quot;&quot;&quot;</span>
357
358         <span class="kn">from</span> <span class="nn">nepi.resources.planetlab.openvswitch.ovsport</span> <span class="kn">import</span> <span class="n">PlanetlabOVSPort</span>
359         <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">PlanetlabOVSPort</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
360
361         <span class="k">for</span> <span class="n">rm</span> <span class="ow">in</span> <span class="n">rms</span><span class="p">:</span>
362             <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">RELEASED</span><span class="p">:</span>
363                 <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>
364                 <span class="k">return</span> 
365             
366         <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Deleting the bridge </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;bridge_name&#39;</span><span class="p">)</span>
367         <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>
368         
369         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;sliver-ovs del-bridge </span><span class="si">%s</span><span class="s">; sliver-ovs stop&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;bridge_name&#39;</span><span class="p">)</span>
370         <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>
371
372         <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>
373                 <span class="n">shfile</span><span class="o">=</span><span class="n">shfile</span><span class="p">,</span>
374                 <span class="n">sudo</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> 
375                 <span class="n">pidfile</span><span class="o">=</span><span class="s">&quot;stop_pidfile&quot;</span><span class="p">,</span>
376                 <span class="n">ecodefile</span><span class="o">=</span><span class="s">&quot;stop_exitcode&quot;</span><span class="p">,</span> 
377                 <span class="n">stdout</span><span class="o">=</span><span class="s">&quot;stop_stdout&quot;</span><span class="p">,</span> 
378                 <span class="n">stderr</span><span class="o">=</span><span class="s">&quot;stop_stderr&quot;</span><span class="p">)</span>
379
380         <span class="nb">super</span><span class="p">(</span><span class="n">PlanetlabOVSSwitch</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>
381 </pre></div></div></div>
382
383           </div>
384         </div>
385       </div>
386       <div class="clearer"></div>
387     </div>
388     <div class="related">
389       <h3>Navigation</h3>
390       <ul>
391         <li class="right" style="margin-right: 10px">
392           <a href="../../../../../genindex.html" title="General Index"
393              >index</a></li>
394         <li class="right" >
395           <a href="../../../../../py-modindex.html" title="Python Module Index"
396              >modules</a> |</li>
397         <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
398           <li><a href="../../../../index.html" >Module code</a> &raquo;</li> 
399       </ul>
400     </div>
401     <div class="footer">
402         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
403       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
404     </div>
405   </body>
406 </html>