1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>nepi.resources.linux.interface — NEPI 3.0 documentation</title>
11 <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
12 <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: '../../../../',
18 COLLAPSE_INDEX: false,
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.0 documentation" href="../../../../index.html" />
27 <link rel="up" title="Module code" href="../../../index.html" />
33 <li class="right" style="margin-right: 10px">
34 <a href="../../../../genindex.html" title="General Index"
35 accesskey="I">index</a></li>
37 <a href="../../../../py-modindex.html" title="Python Module Index"
39 <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
40 <li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
43 <div class="sphinxsidebar">
44 <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
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" />
53 <p class="searchtip" style="font-size: 90%">
54 Enter search terms or a module, class or function name.
57 <script type="text/javascript">$('#searchbox').show(0);</script>
61 <div class="document">
62 <div class="documentwrapper">
63 <div class="bodywrapper">
66 <h1>Source code for nepi.resources.linux.interface</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 <http://www.gnu.org/licenses/>.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
85 <span class="kn">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Attribute</span><span class="p">,</span> <span class="n">Types</span><span class="p">,</span> <span class="n">Flags</span>
86 <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> \
87 <span class="n">ResourceState</span>
88 <span class="kn">from</span> <span class="nn">nepi.resources.linux.node</span> <span class="kn">import</span> <span class="n">LinuxNode</span>
89 <span class="kn">from</span> <span class="nn">nepi.resources.linux.channel</span> <span class="kn">import</span> <span class="n">LinuxChannel</span>
91 <span class="kn">import</span> <span class="nn">collections</span>
92 <span class="kn">import</span> <span class="nn">os</span>
93 <span class="kn">import</span> <span class="nn">random</span>
94 <span class="kn">import</span> <span class="nn">re</span>
95 <span class="kn">import</span> <span class="nn">tempfile</span>
96 <span class="kn">import</span> <span class="nn">time</span>
98 <span class="c"># TODO: </span>
99 <span class="c"># - check UP, MTU attributes!</span>
100 <span class="c"># - clean up code and test!</span>
102 <span class="nd">@clsinit_copy</span>
103 <div class="viewcode-block" id="LinuxInterface"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface">[docs]</a><span class="k">class</span> <span class="nc">LinuxInterface</span><span class="p">(</span><span class="n">ResourceManager</span><span class="p">):</span>
104 <span class="n">_rtype</span> <span class="o">=</span> <span class="s">"linux::Interface"</span>
105 <span class="n">_help</span> <span class="o">=</span> <span class="s">"Controls network devices on Linux hosts through the ifconfig tool"</span>
106 <span class="n">_platform</span> <span class="o">=</span> <span class="s">"linux"</span>
108 <span class="nd">@classmethod</span>
109 <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
110 <span class="n">ip4</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"ip4"</span><span class="p">,</span> <span class="s">"IPv4 Address"</span><span class="p">,</span>
111 <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>
113 <span class="n">ip6</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"ip6"</span><span class="p">,</span> <span class="s">"IPv6 Address"</span><span class="p">,</span>
114 <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>
116 <span class="n">mac</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"mac"</span><span class="p">,</span> <span class="s">"MAC Address"</span><span class="p">,</span>
117 <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>
119 <span class="n">mask4</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"mask4"</span><span class="p">,</span> <span class="s">"IPv4 network mask"</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>
122 <span class="n">mask6</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"mask6"</span><span class="p">,</span> <span class="s">"IPv6 network mask"</span><span class="p">,</span>
123 <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</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>
126 <span class="n">mtu</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"mtu"</span><span class="p">,</span> <span class="s">"Maximum transmition unit for device"</span><span class="p">,</span>
127 <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</span><span class="p">)</span>
129 <span class="n">devname</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"deviceName"</span><span class="p">,</span>
130 <span class="s">"Name of the network interface (e.g. eth0, wlan0, etc)"</span><span class="p">,</span>
131 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
133 <span class="n">up</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"up"</span><span class="p">,</span> <span class="s">"Link up"</span><span class="p">,</span> <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Bool</span><span class="p">)</span>
135 <span class="n">tear_down</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"tearDown"</span><span class="p">,</span> <span class="s">"Bash script to be executed before "</span> <span class="o">+</span> \
136 <span class="s">"releasing the resource"</span><span class="p">,</span>
137 <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
139 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">ip4</span><span class="p">)</span>
140 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">ip6</span><span class="p">)</span>
141 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">mac</span><span class="p">)</span>
142 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">mask4</span><span class="p">)</span>
143 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">mask6</span><span class="p">)</span>
144 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">mtu</span><span class="p">)</span>
145 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">devname</span><span class="p">)</span>
146 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">up</span><span class="p">)</span>
147 <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">tear_down</span><span class="p">)</span>
149 <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>
150 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxInterface</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>
151 <span class="bp">self</span><span class="o">.</span><span class="n">_configured</span> <span class="o">=</span> <span class="bp">False</span>
153 <span class="bp">self</span><span class="o">.</span><span class="n">add_set_hooks</span><span class="p">()</span>
155 <div class="viewcode-block" id="LinuxInterface.log_message"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.log_message">[docs]</a> <span class="k">def</span> <span class="nf">log_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
156 <span class="k">return</span> <span class="s">" guid </span><span class="si">%d</span><span class="s"> - host </span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">,</span>
157 <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"hostname"</span><span class="p">),</span> <span class="n">msg</span><span class="p">)</span>
159 <span class="nd">@property</span>
160 <div class="viewcode-block" id="LinuxInterface.node"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.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>
161 <span class="n">node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">LinuxNode</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
162 <span class="k">if</span> <span class="n">node</span><span class="p">:</span> <span class="k">return</span> <span class="n">node</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
163 <span class="k">return</span> <span class="bp">None</span>
165 <span class="nd">@property</span>
166 <div class="viewcode-block" id="LinuxInterface.channel"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.channel">[docs]</a> <span class="k">def</span> <span class="nf">channel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
167 <span class="n">chan</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">LinuxChannel</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
168 <span class="k">if</span> <span class="n">chan</span><span class="p">:</span> <span class="k">return</span> <span class="n">chan</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
169 <span class="k">return</span> <span class="bp">None</span>
171 <div class="viewcode-block" id="LinuxInterface.do_discover"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.do_discover">[docs]</a> <span class="k">def</span> <span class="nf">do_discover</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
172 <span class="n">devname</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">"deviceName"</span><span class="p">)</span>
173 <span class="n">ip4</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">"ip4"</span><span class="p">)</span>
174 <span class="n">ip6</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">"ip4"</span><span class="p">)</span>
175 <span class="n">mac</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">"mac"</span><span class="p">)</span>
176 <span class="n">mask4</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">"mask4"</span><span class="p">)</span>
177 <span class="n">mask6</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">"mask6"</span><span class="p">)</span>
178 <span class="n">mtu</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">"mtu"</span><span class="p">)</span>
180 <span class="c"># Get current interfaces information</span>
181 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"ifconfig"</span><span class="p">,</span> <span class="n">sudo</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> <span class="n">tty</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
183 <span class="k">if</span> <span class="n">err</span> <span class="ow">and</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
184 <span class="n">msg</span> <span class="o">=</span> <span class="s">" Error retrieving interface information "</span>
185 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
186 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">"</span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
188 <span class="c"># Check if an interface is found matching the RM attributes</span>
189 <span class="n">ifaces</span> <span class="o">=</span> <span class="n">out</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"</span><span class="se">\n\n</span><span class="s">"</span><span class="p">)</span>
191 <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">ifaces</span><span class="p">:</span>
192 <span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="s">"(\w+)\s+Link\s+encap:\w+(\s+HWaddr\s+(([0-9a-fA-F]{2}:?){6}))?(\s+inet\s+addr:((\d+\.?){4}).+Mask:(\d+\.\d+\.\d+\.\d+))?(.+inet6\s+addr:\s+([0-9a-fA-F:.]+)/(\d+))?(.+(UP))?(.+MTU:(\d+))?"</span><span class="p">,</span> <span class="n">i</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">DOTALL</span><span class="p">)</span>
194 <span class="n">m</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
195 <span class="n">dn</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
196 <span class="n">mc</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
197 <span class="n">i4</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">5</span><span class="p">]</span>
198 <span class="n">msk4</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">7</span><span class="p">]</span>
199 <span class="n">i6</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">9</span><span class="p">]</span>
200 <span class="n">msk6</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">10</span><span class="p">]</span>
201 <span class="n">up</span> <span class="o">=</span> <span class="bp">True</span> <span class="k">if</span> <span class="n">m</span><span class="p">[</span><span class="mi">12</span><span class="p">]</span> <span class="k">else</span> <span class="bp">False</span>
202 <span class="n">mu</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">14</span><span class="p">]</span>
204 <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"Found interface </span><span class="si">%(devname)s</span><span class="s"> with MAC </span><span class="si">%(mac)s</span><span class="s">,"</span>
205 <span class="s">"IPv4 </span><span class="si">%(ipv4)s</span><span class="s"> </span><span class="si">%(mask4)s</span><span class="s"> IPv6 </span><span class="si">%(ipv6)s</span><span class="s">/</span><span class="si">%(mask6)s</span><span class="s"> </span><span class="si">%(up)s</span><span class="s"> </span><span class="si">%(mtu)s</span><span class="s">"</span> <span class="o">%</span> <span class="p">({</span>
206 <span class="s">'devname'</span><span class="p">:</span> <span class="n">dn</span><span class="p">,</span>
207 <span class="s">'mac'</span><span class="p">:</span> <span class="n">mc</span><span class="p">,</span>
208 <span class="s">'ipv4'</span><span class="p">:</span> <span class="n">i4</span><span class="p">,</span>
209 <span class="s">'mask4'</span><span class="p">:</span> <span class="n">msk4</span><span class="p">,</span>
210 <span class="s">'ipv6'</span><span class="p">:</span> <span class="n">i6</span><span class="p">,</span>
211 <span class="s">'mask6'</span><span class="p">:</span> <span class="n">msk6</span><span class="p">,</span>
212 <span class="s">'up'</span><span class="p">:</span> <span class="n">up</span><span class="p">,</span>
213 <span class="s">'mtu'</span><span class="p">:</span> <span class="n">mu</span>
214 <span class="p">})</span> <span class="p">)</span>
216 <span class="c"># If the user didn't provide information we take the first </span>
217 <span class="c"># interface that is UP</span>
218 <span class="k">if</span> <span class="ow">not</span> <span class="n">devname</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">ip4</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">ip6</span> <span class="ow">and</span> <span class="n">up</span><span class="p">:</span>
219 <span class="bp">self</span><span class="o">.</span><span class="n">_configured</span> <span class="o">=</span> <span class="bp">True</span>
220 <span class="bp">self</span><span class="o">.</span><span class="n">load_configuration</span><span class="p">(</span><span class="n">dn</span><span class="p">,</span> <span class="n">mc</span><span class="p">,</span> <span class="n">i4</span><span class="p">,</span> <span class="n">msk4</span><span class="p">,</span> <span class="n">i6</span><span class="p">,</span> <span class="n">msk6</span><span class="p">,</span> <span class="n">mu</span><span class="p">,</span> <span class="n">up</span><span class="p">)</span>
221 <span class="k">break</span>
223 <span class="c"># If the user provided ipv4 or ipv6 matching that of an interface</span>
224 <span class="c"># load the interface info</span>
225 <span class="k">if</span> <span class="p">(</span><span class="n">ip4</span> <span class="ow">and</span> <span class="n">ip4</span> <span class="o">==</span> <span class="n">i4</span><span class="p">)</span> <span class="ow">or</span> <span class="p">(</span><span class="n">ip6</span> <span class="ow">and</span> <span class="n">ip6</span> <span class="o">==</span> <span class="n">i6</span><span class="p">):</span>
226 <span class="bp">self</span><span class="o">.</span><span class="n">_configured</span> <span class="o">=</span> <span class="bp">True</span>
227 <span class="bp">self</span><span class="o">.</span><span class="n">load_configuration</span><span class="p">(</span><span class="n">dn</span><span class="p">,</span> <span class="n">mc</span><span class="p">,</span> <span class="n">i4</span><span class="p">,</span> <span class="n">msk4</span><span class="p">,</span> <span class="n">i6</span><span class="p">,</span> <span class="n">msk6</span><span class="p">,</span> <span class="n">mu</span><span class="p">,</span> <span class="n">up</span><span class="p">)</span>
228 <span class="k">break</span>
230 <span class="c"># If the user provided the device name we load the associated info</span>
231 <span class="k">if</span> <span class="n">devname</span> <span class="ow">and</span> <span class="n">devname</span> <span class="o">==</span> <span class="n">dn</span><span class="p">:</span>
232 <span class="k">if</span> <span class="p">((</span><span class="n">ip4</span> <span class="ow">and</span> <span class="n">ip4</span> <span class="o">==</span> <span class="n">i4</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="n">ipv6</span> <span class="ow">and</span> <span class="n">ip6</span> <span class="o">==</span> <span class="n">i6</span><span class="p">))</span> <span class="ow">or</span> \
233 <span class="ow">not</span> <span class="p">(</span><span class="n">ip4</span> <span class="ow">or</span> <span class="n">ip6</span><span class="p">):</span>
234 <span class="bp">self</span><span class="o">.</span><span class="n">_configured</span> <span class="o">=</span> <span class="bp">True</span>
236 <span class="c"># If the user gave a different ip than the existing, asume ip </span>
237 <span class="c"># needs to be changed</span>
238 <span class="n">i4</span> <span class="o">=</span> <span class="n">ip4</span> <span class="ow">or</span> <span class="n">i4</span>
239 <span class="n">i6</span> <span class="o">=</span> <span class="n">ip6</span> <span class="ow">or</span> <span class="n">i6</span>
240 <span class="n">mu</span> <span class="o">=</span> <span class="n">mtu</span> <span class="ow">or</span> <span class="n">mu</span>
242 <span class="bp">self</span><span class="o">.</span><span class="n">load_configuration</span><span class="p">(</span><span class="n">dn</span><span class="p">,</span> <span class="n">mc</span><span class="p">,</span> <span class="n">i4</span><span class="p">,</span> <span class="n">msk4</span><span class="p">,</span> <span class="n">i6</span><span class="p">,</span> <span class="n">msk6</span><span class="p">,</span> <span class="n">mu</span><span class="p">,</span> <span class="n">up</span><span class="p">)</span>
243 <span class="k">break</span>
245 <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">"deviceName"</span><span class="p">):</span>
246 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Unable to resolve interface "</span>
247 <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>
248 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
250 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxInterface</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
252 <div class="viewcode-block" id="LinuxInterface.do_provision"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.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>
253 <span class="n">devname</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">"deviceName"</span><span class="p">)</span>
254 <span class="n">ip4</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">"ip4"</span><span class="p">)</span>
255 <span class="n">ip6</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">"ip4"</span><span class="p">)</span>
256 <span class="n">mac</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">"mac"</span><span class="p">)</span>
257 <span class="n">mask4</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">"mask4"</span><span class="p">)</span>
258 <span class="n">mask6</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">"mask6"</span><span class="p">)</span>
259 <span class="n">mtu</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">"mtu"</span><span class="p">)</span>
261 <span class="c"># Must configure interface if configuration is required</span>
262 <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_configured</span><span class="p">:</span>
263 <span class="n">cmd</span> <span class="o">=</span> <span class="s">"ifconfig </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">devname</span>
265 <span class="k">if</span> <span class="n">ip4</span> <span class="ow">and</span> <span class="n">mask4</span><span class="p">:</span>
266 <span class="n">cmd</span> <span class="o">+=</span> <span class="s">" </span><span class="si">%(ip4)s</span><span class="s"> netmask </span><span class="si">%(mask4)s</span><span class="s"> broadcast </span><span class="si">%(bcast)s</span><span class="s"> up"</span> <span class="o">%</span> <span class="p">({</span>
267 <span class="s">'ip4'</span><span class="p">:</span> <span class="n">ip4</span><span class="p">,</span>
268 <span class="s">'mask4'</span><span class="p">:</span> <span class="n">mask4</span><span class="p">,</span>
269 <span class="s">'bcast'</span><span class="p">:</span> <span class="n">bcast</span><span class="p">})</span>
270 <span class="k">if</span> <span class="n">mtu</span><span class="p">:</span>
271 <span class="n">cmd</span> <span class="o">+=</span> <span class="s">" mtu </span><span class="si">%d</span><span class="s"> "</span> <span class="o">%</span> <span class="n">mtu</span>
273 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">sudo</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
275 <span class="k">if</span> <span class="n">err</span> <span class="ow">and</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
276 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Error configuring interface with command '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">cmd</span>
277 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
278 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">"</span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
280 <span class="k">if</span> <span class="n">ip6</span> <span class="ow">and</span> <span class="n">mask6</span><span class="p">:</span>
281 <span class="n">cmd</span> <span class="o">=</span> <span class="s">"ifconfig </span><span class="si">%(devname)s</span><span class="s"> inet6 add </span><span class="si">%(ip6)s</span><span class="s">/</span><span class="si">%(mask6)d</span><span class="s">"</span> <span class="o">%</span> <span class="p">({</span>
282 <span class="s">'devname'</span><span class="p">:</span> <span class="n">devname</span><span class="p">,</span>
283 <span class="s">'ip6'</span><span class="p">:</span> <span class="n">ip6</span><span class="p">,</span>
284 <span class="s">'mask6'</span><span class="p">:</span> <span class="n">mask6</span><span class="p">})</span>
286 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">sudo</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
288 <span class="k">if</span> <span class="n">err</span> <span class="ow">and</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
289 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Error seting ipv6 for interface using command '</span><span class="si">%s</span><span class="s">' "</span> <span class="o">%</span> <span class="n">cmd</span>
290 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
291 <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">"</span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
293 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxInterface</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
295 <div class="viewcode-block" id="LinuxInterface.do_deploy"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.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>
296 <span class="c"># Wait until node is provisioned</span>
297 <span class="n">node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span>
298 <span class="n">chan</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">channel</span>
300 <span class="k">if</span> <span class="ow">not</span> <span class="n">node</span> <span class="ow">or</span> <span class="n">node</span><span class="o">.</span><span class="n">state</span> <span class="o"><</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">PROVISIONED</span><span class="p">:</span>
301 <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>
302 <span class="k">elif</span> <span class="ow">not</span> <span class="n">chan</span> <span class="ow">or</span> <span class="n">chan</span><span class="o">.</span><span class="n">state</span> <span class="o"><</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">READY</span><span class="p">:</span>
303 <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>
304 <span class="k">else</span><span class="p">:</span>
305 <span class="c"># Verify if the interface exists in node. If not, configue</span>
306 <span class="c"># if yes, load existing configuration</span>
307 <span class="bp">self</span><span class="o">.</span><span class="n">do_discover</span><span class="p">()</span>
308 <span class="bp">self</span><span class="o">.</span><span class="n">do_provision</span><span class="p">()</span>
310 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxInterface</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">do_deploy</span><span class="p">()</span>
312 <div class="viewcode-block" id="LinuxInterface.do_release"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.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>
313 <span class="n">tear_down</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">"tearDown"</span><span class="p">)</span>
314 <span class="k">if</span> <span class="n">tear_down</span><span class="p">:</span>
315 <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">tear_down</span><span class="p">)</span>
317 <span class="nb">super</span><span class="p">(</span><span class="n">LinuxInterface</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>
319 <div class="viewcode-block" id="LinuxInterface.valid_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.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>
320 <span class="c"># TODO: Validate!</span>
321 <span class="k">return</span> <span class="bp">True</span>
323 <div class="viewcode-block" id="LinuxInterface.load_configuration"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.load_configuration">[docs]</a> <span class="k">def</span> <span class="nf">load_configuration</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">devname</span><span class="p">,</span> <span class="n">mac</span><span class="p">,</span> <span class="n">ip4</span><span class="p">,</span> <span class="n">mask4</span><span class="p">,</span> <span class="n">ip6</span><span class="p">,</span> <span class="n">mask6</span><span class="p">,</span> <span class="n">mtu</span><span class="p">,</span> <span class="n">up</span><span class="p">):</span>
324 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"deviceName"</span><span class="p">,</span> <span class="n">devname</span><span class="p">)</span>
325 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"mac"</span><span class="p">,</span> <span class="n">mac</span><span class="p">)</span>
326 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"ip4"</span><span class="p">,</span> <span class="n">ip4</span><span class="p">)</span>
327 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"mask4"</span><span class="p">,</span> <span class="n">mask4</span><span class="p">)</span>
328 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"ip6"</span><span class="p">,</span> <span class="n">ip6</span><span class="p">)</span>
329 <span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">"mask6"</span><span class="p">,</span> <span class="n">mask6</span><span class="p">)</span>
331 <span class="c"># set the following without validating or triggering hooks</span>
332 <span class="n">attr</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attrs</span><span class="p">[</span><span class="s">"up"</span><span class="p">]</span>
333 <span class="n">attr</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">up</span>
334 <span class="n">attr</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attrs</span><span class="p">[</span><span class="s">"mtu"</span><span class="p">]</span>
335 <span class="n">attr</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">mtu</span>
337 <div class="viewcode-block" id="LinuxInterface.add_set_hooks"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.add_set_hooks">[docs]</a> <span class="k">def</span> <span class="nf">add_set_hooks</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
338 <span class="n">attrup</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attrs</span><span class="p">[</span><span class="s">"up"</span><span class="p">]</span>
339 <span class="n">attrup</span><span class="o">.</span><span class="n">set_hook</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">set_hook_up</span>
341 <span class="n">attrmtu</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attrs</span><span class="p">[</span><span class="s">"mtu"</span><span class="p">]</span>
342 <span class="n">attrmtu</span><span class="o">.</span><span class="n">set_hook</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">set_hook_mtu</span>
344 <div class="viewcode-block" id="LinuxInterface.set_hook_up"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.set_hook_up">[docs]</a> <span class="k">def</span> <span class="nf">set_hook_up</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">oldval</span><span class="p">,</span> <span class="n">newval</span><span class="p">):</span>
345 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">NEW</span> <span class="ow">or</span> <span class="n">oldval</span> <span class="o">==</span> <span class="n">newval</span><span class="p">:</span>
346 <span class="k">return</span> <span class="n">oldval</span>
348 <span class="c"># configure interface up</span>
349 <span class="k">if</span> <span class="n">newval</span> <span class="o">==</span> <span class="bp">True</span><span class="p">:</span>
350 <span class="n">cmd</span> <span class="o">=</span> <span class="s">"ifup </span><span class="si">%s</span><span class="s">"</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">"deviceName"</span><span class="p">)</span>
351 <span class="k">elif</span> <span class="n">newval</span> <span class="o">==</span> <span class="bp">False</span><span class="p">:</span>
352 <span class="n">cmd</span> <span class="o">=</span> <span class="s">"ifdown </span><span class="si">%s</span><span class="s">"</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">"deviceName"</span><span class="p">)</span>
354 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">sudo</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
356 <span class="k">if</span> <span class="n">err</span> <span class="ow">and</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
357 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Error setting interface up/down using command '</span><span class="si">%s</span><span class="s">' "</span> <span class="o">%</span> <span class="n">cmd</span>
358 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">err</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span>
359 <span class="k">return</span> <span class="n">oldval</span>
361 <span class="k">return</span> <span class="n">newval</span>
363 <div class="viewcode-block" id="LinuxInterface.set_hook_mtu"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.interface.LinuxInterface.set_hook_mtu">[docs]</a> <span class="k">def</span> <span class="nf">set_hook_mtu</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">oldval</span><span class="p">,</span> <span class="n">newval</span><span class="p">):</span>
364 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">ResourceState</span><span class="o">.</span><span class="n">NEW</span> <span class="ow">or</span> <span class="n">oldval</span> <span class="o">==</span> <span class="n">newval</span><span class="p">:</span>
365 <span class="k">return</span> <span class="n">oldval</span>
367 <span class="n">cmd</span> <span class="o">=</span> <span class="s">"ifconfig </span><span class="si">%s</span><span class="s"> mtu </span><span class="si">%d</span><span class="s">"</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">"deviceName"</span><span class="p">),</span> <span class="n">newval</span><span class="p">)</span>
369 <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">sudo</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
371 <span class="k">if</span> <span class="n">err</span> <span class="ow">and</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
372 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Error setting interface MTU using command '</span><span class="si">%s</span><span class="s">' "</span> <span class="o">%</span> <span class="n">cmd</span>
373 <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">err</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span>
374 <span class="k">return</span> <span class="n">oldval</span>
376 <span class="k">return</span> <span class="n">newval</span>
377 </pre></div></div></div>
382 <div class="clearer"></div>
384 <div class="related">
387 <li class="right" style="margin-right: 10px">
388 <a href="../../../../genindex.html" title="General Index"
391 <a href="../../../../py-modindex.html" title="Python Module Index"
393 <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
394 <li><a href="../../../index.html" >Module code</a> »</li>
398 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
399 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.