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, ResourceState, \
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"
41 def _register_attributes(cls):
42 ip4 = Attribute("ip4", "IPv4 Address",
43 flags = Flags.ExecReadOnly)
45 ip6 = Attribute("ip6", "IPv6 Address",
46 flags = Flags.ExecReadOnly)
48 mac = Attribute("mac", "MAC Address",
49 flags = Flags.ExecReadOnly)
51 mask4 = Attribute("mask4", "IPv4 network mask",
52 flags = Flags.ExecReadOnly)
54 mask6 = Attribute("mask6", "IPv6 network mask",
56 flags = Flags.ExecReadOnly)
58 mtu = Attribute("mtu", "Maximum transmition unit for device",
61 devname = Attribute("deviceName",
62 "Name of the network interface (e.g. eth0, wlan0, etc)",
63 flags = Flags.ExecReadOnly)
65 up = Attribute("up", "Link up", type = Types.Bool)
67 tear_down = Attribute("tearDown", "Bash script to be executed before " + \
68 "releasing the resource",
69 flags = Flags.ExecReadOnly)
71 cls._register_attribute(ip4)
72 cls._register_attribute(ip6)
73 cls._register_attribute(mac)
74 cls._register_attribute(mask4)
75 cls._register_attribute(mask6)
76 cls._register_attribute(mtu)
77 cls._register_attribute(devname)
78 cls._register_attribute(up)
79 cls._register_attribute(tear_down)
81 def __init__(self, ec, guid):
82 super(LinuxInterface, self).__init__(ec, guid)
83 self._configured = False
87 def log_message(self, msg):
88 return " guid %d - host %s - %s " % (self.guid,
89 self.node.get("hostname"), msg)
93 node = self.get_connected(LinuxNode.rtype())
94 if node: return node[0]
99 chan = self.get_connected(LinuxChannel.rtype())
100 if chan: return chan[0]
104 devname = self.get("deviceName")
105 ip4 = self.get("ip4")
106 ip6 = self.get("ip4")
107 mac = self.get("mac")
108 mask4 = self.get("mask4")
109 mask6 = self.get("mask6")
110 mtu = self.get("mtu")
112 # Get current interfaces information
113 (out, err), proc = self.node.execute("ifconfig", sudo = True, tty = True)
115 if err and proc.poll():
116 msg = " Error retrieving interface information "
117 self.error(msg, out, err)
118 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
120 # Check if an interface is found matching the RM attributes
121 ifaces = out.split("\n\n")
124 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)
133 up = True if m[12] else False
136 self.debug("Found interface %(devname)s with MAC %(mac)s,"
137 "IPv4 %(ipv4)s %(mask4)s IPv6 %(ipv6)s/%(mask6)s %(up)s %(mtu)s" % ({
148 # If the user didn't provide information we take the first
149 # interface that is UP
150 if not devname and not ip4 and not ip6 and up:
151 self._configured = True
152 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
155 # If the user provided ipv4 or ipv6 matching that of an interface
156 # load the interface info
157 if (ip4 and ip4 == i4) or (ip6 and ip6 == i6):
158 self._configured = True
159 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
162 # If the user provided the device name we load the associated info
163 if devname and devname == dn:
164 if ((ip4 and ip4 == i4) and (ipv6 and ip6 == i6)) or \
166 self._configured = True
168 # If the user gave a different ip than the existing, asume ip
169 # needs to be changed
174 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
177 if not self.get("deviceName"):
178 msg = "Unable to resolve interface "
180 raise RuntimeError, msg
182 super(LinuxInterface, self).discover()
185 devname = self.get("deviceName")
186 ip4 = self.get("ip4")
187 ip6 = self.get("ip4")
188 mac = self.get("mac")
189 mask4 = self.get("mask4")
190 mask6 = self.get("mask6")
191 mtu = self.get("mtu")
193 # Must configure interface if configuration is required
194 if not self._configured:
195 cmd = "ifconfig %s" % devname
198 cmd += " %(ip4)s netmask %(mask4)s broadcast %(bcast)s up" % ({
203 cmd += " mtu %d " % mtu
205 (out, err), proc = self.node.execute(cmd, sudo = True)
207 if err and proc.poll():
208 msg = "Error configuring interface with command '%s'" % cmd
209 self.error(msg, out, err)
210 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
213 cmd = "ifconfig %(devname)s inet6 add %(ip6)s/%(mask6)d" % ({
218 (out, err), proc = self.node.execute(cmd, sudo = True)
220 if err and proc.poll():
221 msg = "Error seting ipv6 for interface using command '%s' " % cmd
222 self.error(msg, out, err)
223 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
225 super(LinuxInterface, self).provision()
228 # Wait until node is provisioned
232 if not node or node.state < ResourceState.PROVISIONED:
233 self.ec.schedule(reschedule_delay, self.deploy)
234 elif not chan or chan.state < ResourceState.READY:
235 self.ec.schedule(reschedule_delay, self.deploy)
237 # Verify if the interface exists in node. If not, configue
238 # if yes, load existing configuration
246 super(LinuxInterface, self).deploy()
249 tear_down = self.get("tearDown")
251 self.execute(tear_down)
253 super(LinuxInterface, self).release()
255 def valid_connection(self, guid):
259 def load_configuration(self, devname, mac, ip4, mask4, ip6, mask6, mtu, up):
260 self.set("deviceName", devname)
263 self.set("mask4", mask4)
265 self.set("mask6", mask6)
267 # set the following without validating or triggering hooks
268 attr = self._attrs["up"]
270 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):
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):
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)