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
33 # TODO: UP, MTU attributes!
37 class LinuxInterface(ResourceManager):
38 _rtype = "LinuxInterface"
39 _help = "Controls network devices on Linux hosts through the ifconfig tool"
43 def _register_attributes(cls):
44 ip4 = Attribute("ip4", "IPv4 Address",
45 flags = Flags.ExecReadOnly)
47 ip6 = Attribute("ip6", "IPv6 Address",
48 flags = Flags.ExecReadOnly)
50 mac = Attribute("mac", "MAC Address",
51 flags = Flags.ExecReadOnly)
53 mask4 = Attribute("mask4", "IPv4 network mask",
54 flags = Flags.ExecReadOnly)
56 mask6 = Attribute("mask6", "IPv6 network mask",
58 flags = Flags.ExecReadOnly)
60 mtu = Attribute("mtu", "Maximum transmition unit for device",
63 devname = Attribute("deviceName",
64 "Name of the network interface (e.g. eth0, wlan0, etc)",
65 flags = Flags.ExecReadOnly)
67 up = Attribute("up", "Link up", type = Types.Bool)
69 tear_down = Attribute("tearDown", "Bash script to be executed before " + \
70 "releasing the resource",
71 flags = Flags.ExecReadOnly)
73 cls._register_attribute(ip4)
74 cls._register_attribute(ip6)
75 cls._register_attribute(mac)
76 cls._register_attribute(mask4)
77 cls._register_attribute(mask6)
78 cls._register_attribute(mtu)
79 cls._register_attribute(devname)
80 cls._register_attribute(up)
81 cls._register_attribute(tear_down)
83 def __init__(self, ec, guid):
84 super(LinuxInterface, self).__init__(ec, guid)
85 self._configured = False
89 def log_message(self, msg):
90 return " guid %d - host %s - %s " % (self.guid,
91 self.node.get("hostname"), msg)
95 node = self.get_connected(LinuxNode.get_rtype())
96 if node: return node[0]
101 chan = self.get_connected(LinuxChannel.get_rtype())
102 if chan: return chan[0]
105 def do_discover(self):
106 devname = self.get("deviceName")
107 ip4 = self.get("ip4")
108 ip6 = self.get("ip4")
109 mac = self.get("mac")
110 mask4 = self.get("mask4")
111 mask6 = self.get("mask6")
112 mtu = self.get("mtu")
114 # Get current interfaces information
115 (out, err), proc = self.node.execute("ifconfig", sudo = True, tty = True)
117 if err and proc.poll():
118 msg = " Error retrieving interface information "
119 self.error(msg, out, err)
120 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
122 # Check if an interface is found matching the RM attributes
123 ifaces = out.split("\n\n")
126 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)
135 up = True if m[12] else False
138 self.debug("Found interface %(devname)s with MAC %(mac)s,"
139 "IPv4 %(ipv4)s %(mask4)s IPv6 %(ipv6)s/%(mask6)s %(up)s %(mtu)s" % ({
150 # If the user didn't provide information we take the first
151 # interface that is UP
152 if not devname and not ip4 and not ip6 and up:
153 self._configured = True
154 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
157 # If the user provided ipv4 or ipv6 matching that of an interface
158 # load the interface info
159 if (ip4 and ip4 == i4) or (ip6 and ip6 == i6):
160 self._configured = True
161 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
164 # If the user provided the device name we load the associated info
165 if devname and devname == dn:
166 if ((ip4 and ip4 == i4) and (ipv6 and ip6 == i6)) or \
168 self._configured = True
170 # If the user gave a different ip than the existing, asume ip
171 # needs to be changed
176 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
179 if not self.get("deviceName"):
180 msg = "Unable to resolve interface "
182 raise RuntimeError, msg
184 super(LinuxInterface, self).do_discover()
186 def do_provision(self):
187 devname = self.get("deviceName")
188 ip4 = self.get("ip4")
189 ip6 = self.get("ip4")
190 mac = self.get("mac")
191 mask4 = self.get("mask4")
192 mask6 = self.get("mask6")
193 mtu = self.get("mtu")
195 # Must configure interface if configuration is required
196 if not self._configured:
197 cmd = "ifconfig %s" % devname
200 cmd += " %(ip4)s netmask %(mask4)s broadcast %(bcast)s up" % ({
205 cmd += " mtu %d " % mtu
207 (out, err), proc = self.node.execute(cmd, sudo = True)
209 if err and proc.poll():
210 msg = "Error configuring interface with command '%s'" % cmd
211 self.error(msg, out, err)
212 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
215 cmd = "ifconfig %(devname)s inet6 add %(ip6)s/%(mask6)d" % ({
220 (out, err), proc = self.node.execute(cmd, sudo = True)
222 if err and proc.poll():
223 msg = "Error seting ipv6 for interface using command '%s' " % cmd
224 self.error(msg, out, err)
225 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
227 super(LinuxInterface, self).do_provision()
230 # Wait until node is provisioned
234 if not node or node.state < ResourceState.PROVISIONED:
235 self.ec.schedule(reschedule_delay, self.deploy)
236 elif not chan or chan.state < ResourceState.READY:
237 self.ec.schedule(reschedule_delay, self.deploy)
239 # Verify if the interface exists in node. If not, configue
240 # if yes, load existing configuration
244 super(LinuxInterface, self).do_deploy()
246 def do_release(self):
247 tear_down = self.get("tearDown")
249 self.execute(tear_down)
251 super(LinuxInterface, self).do_release()
253 def valid_connection(self, guid):
257 def load_configuration(self, devname, mac, ip4, mask4, ip6, mask6, mtu, up):
258 self.set("deviceName", devname)
261 self.set("mask4", mask4)
263 self.set("mask6", mask6)
265 # set the following without validating or triggering hooks
266 attr = self._attrs["up"]
268 attr = self._attrs["mtu"]
270 def add_set_hooks(self):
271 attrup = self._attrs["up"]
272 attrup.set_hook = self.set_hook_up
274 attrmtu = self._attrs["mtu"]
275 attrmtu.set_hook = self.set_hook_mtu
277 def set_hook_up(self, oldval, newval):
281 # configure interface up
283 cmd = "ifup %s" % self.get("deviceName")
284 elif newval == False:
285 cmd = "ifdown %s" % self.get("deviceName")
287 (out, err), proc = self.node.execute(cmd, sudo = True)
289 if err and proc.poll():
290 msg = "Error setting interface up/down using command '%s' " % cmd
291 self.error(msg, err, out)
296 def set_hook_mtu(self, oldval, newval):
300 cmd = "ifconfig %s mtu %d" % (self.get("deviceName"), newval)
302 (out, err), proc = self.node.execute(cmd, sudo = True)
304 if err and proc.poll():
305 msg = "Error setting interface MTU using command '%s' " % cmd
306 self.error(msg, err, out)