2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2013 INRIA
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
20 from nepi.execution.attribute import Attribute, Types, Flags
21 from nepi.execution.resource import ResourceManager, clsinit_copy, \
22 ResourceState, reschedule_delay
23 from nepi.resources.linux.node import LinuxNode
24 from nepi.resources.linux.channel import LinuxChannel
34 # - check UP, MTU attributes!
35 # - clean up code and test!
38 class LinuxInterface(ResourceManager):
39 _rtype = "LinuxInterface"
40 _help = "Controls network devices on Linux hosts through the ifconfig tool"
44 def _register_attributes(cls):
45 ip4 = Attribute("ip4", "IPv4 Address",
48 ip6 = Attribute("ip6", "IPv6 Address",
51 mac = Attribute("mac", "MAC Address",
54 mask4 = Attribute("mask4", "IPv4 network mask",
57 mask6 = Attribute("mask6", "IPv6 network mask",
61 mtu = Attribute("mtu", "Maximum transmition unit for device",
64 devname = Attribute("deviceName",
65 "Name of the network interface (e.g. eth0, wlan0, etc)",
68 up = Attribute("up", "Link up", type = Types.Bool)
70 tear_down = Attribute("tearDown", "Bash script to be executed before " + \
71 "releasing the resource",
74 cls._register_attribute(ip4)
75 cls._register_attribute(ip6)
76 cls._register_attribute(mac)
77 cls._register_attribute(mask4)
78 cls._register_attribute(mask6)
79 cls._register_attribute(mtu)
80 cls._register_attribute(devname)
81 cls._register_attribute(up)
82 cls._register_attribute(tear_down)
84 def __init__(self, ec, guid):
85 super(LinuxInterface, self).__init__(ec, guid)
86 self._configured = False
90 def log_message(self, msg):
91 return " guid %d - host %s - %s " % (self.guid,
92 self.node.get("hostname"), msg)
96 node = self.get_connected(LinuxNode.get_rtype())
97 if node: return node[0]
102 chan = self.get_connected(LinuxChannel.get_rtype())
103 if chan: return chan[0]
106 def do_discover(self):
107 devname = self.get("deviceName")
108 ip4 = self.get("ip4")
109 ip6 = self.get("ip4")
110 mac = self.get("mac")
111 mask4 = self.get("mask4")
112 mask6 = self.get("mask6")
113 mtu = self.get("mtu")
115 # Get current interfaces information
116 (out, err), proc = self.node.execute("ifconfig", sudo = True, tty = True)
118 if err and proc.poll():
119 msg = " Error retrieving interface information "
120 self.error(msg, out, err)
121 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
123 # Check if an interface is found matching the RM attributes
124 ifaces = out.split("\n\n")
127 m = re.findall("(\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+))?", i, re.DOTALL)
136 up = True if m[12] else False
139 self.debug("Found interface %(devname)s with MAC %(mac)s,"
140 "IPv4 %(ipv4)s %(mask4)s IPv6 %(ipv6)s/%(mask6)s %(up)s %(mtu)s" % ({
151 # If the user didn't provide information we take the first
152 # interface that is UP
153 if not devname and not ip4 and not ip6 and up:
154 self._configured = True
155 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
158 # If the user provided ipv4 or ipv6 matching that of an interface
159 # load the interface info
160 if (ip4 and ip4 == i4) or (ip6 and ip6 == i6):
161 self._configured = True
162 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
165 # If the user provided the device name we load the associated info
166 if devname and devname == dn:
167 if ((ip4 and ip4 == i4) and (ipv6 and ip6 == i6)) or \
169 self._configured = True
171 # If the user gave a different ip than the existing, asume ip
172 # needs to be changed
177 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
180 if not self.get("deviceName"):
181 msg = "Unable to resolve interface "
183 raise RuntimeError, msg
185 super(LinuxInterface, self).do_discover()
187 def do_provision(self):
188 devname = self.get("deviceName")
189 ip4 = self.get("ip4")
190 ip6 = self.get("ip4")
191 mac = self.get("mac")
192 mask4 = self.get("mask4")
193 mask6 = self.get("mask6")
194 mtu = self.get("mtu")
196 # Must configure interface if configuration is required
197 if not self._configured:
198 cmd = "ifconfig %s" % devname
201 cmd += " %(ip4)s netmask %(mask4)s broadcast %(bcast)s up" % ({
206 cmd += " mtu %d " % mtu
208 (out, err), proc = self.node.execute(cmd, sudo = True)
210 if err and proc.poll():
211 msg = "Error configuring interface with command '%s'" % cmd
212 self.error(msg, out, err)
213 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
216 cmd = "ifconfig %(devname)s inet6 add %(ip6)s/%(mask6)d" % ({
221 (out, err), proc = self.node.execute(cmd, sudo = True)
223 if err and proc.poll():
224 msg = "Error seting ipv6 for interface using command '%s' " % cmd
225 self.error(msg, out, err)
226 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
228 super(LinuxInterface, self).do_provision()
231 # Wait until node is provisioned
235 if not node or node.state < ResourceState.PROVISIONED:
236 self.ec.schedule(reschedule_delay, self.deploy)
237 elif not chan or chan.state < ResourceState.READY:
238 self.ec.schedule(reschedule_delay, self.deploy)
240 # Verify if the interface exists in node. If not, configue
241 # if yes, load existing configuration
245 super(LinuxInterface, self).do_deploy()
247 def do_release(self):
248 tear_down = self.get("tearDown")
250 self.execute(tear_down)
252 super(LinuxInterface, self).do_release()
254 def valid_connection(self, guid):
258 def load_configuration(self, devname, mac, ip4, mask4, ip6, mask6, mtu, up):
259 self.set("deviceName", devname)
262 self.set("mask4", mask4)
264 self.set("mask6", mask6)
266 # set the following without validating or triggering hooks
267 attr = self._attrs["up"]
269 attr = self._attrs["mtu"]
272 def add_set_hooks(self):
273 attrup = self._attrs["up"]
274 attrup.set_hook = self.set_hook_up
276 attrmtu = self._attrs["mtu"]
277 attrmtu.set_hook = self.set_hook_mtu
279 def set_hook_up(self, oldval, newval):
280 if self.state == ResourceState.NEW or oldval == newval:
283 # configure interface up
285 cmd = "ifup %s" % self.get("deviceName")
286 elif newval == False:
287 cmd = "ifdown %s" % self.get("deviceName")
289 (out, err), proc = self.node.execute(cmd, sudo = True)
291 if err and proc.poll():
292 msg = "Error setting interface up/down using command '%s' " % cmd
293 self.error(msg, err, out)
298 def set_hook_mtu(self, oldval, newval):
299 if self.state == ResourceState.NEW or oldval == newval:
302 cmd = "ifconfig %s mtu %d" % (self.get("deviceName"), newval)
304 (out, err), proc = self.node.execute(cmd, sudo = True)
306 if err and proc.poll():
307 msg = "Error setting interface MTU using command '%s' " % cmd
308 self.error(msg, err, out)