1 from nepi.execution.attribute import Attribute, Types, Flags
2 from nepi.execution.resource import ResourceManager, clsinit, ResourceState
3 from nepi.resources.linux.node import LinuxNode
4 from nepi.resources.linux.channel import LinuxChannel
14 # TODO: UP, MTU attributes!
16 reschedule_delay = "0.5s"
19 class LinuxInterface(ResourceManager):
20 _rtype = "LinuxInterface"
23 def _register_attributes(cls):
24 ip4 = Attribute("ip4", "IPv4 Address",
25 flags = Flags.ExecReadOnly)
27 ip6 = Attribute("ip6", "IPv6 Address",
28 flags = Flags.ExecReadOnly)
30 mac = Attribute("mac", "MAC Address",
31 flags = Flags.ExecReadOnly)
33 mask4 = Attribute("mask4", "IPv4 network mask",
34 flags = Flags.ExecReadOnly)
36 mask6 = Attribute("mask6", "IPv6 network mask",
38 flags = Flags.ExecReadOnly)
40 mtu = Attribute("mtu", "Maximum transmition unit for device",
43 devname = Attribute("deviceName",
44 "Name of the network interface (e.g. eth0, wlan0, etc)",
45 flags = Flags.ExecReadOnly)
47 up = Attribute("up", "Link up", type = Types.Bool)
49 tear_down = Attribute("tearDown", "Bash script to be executed before " + \
50 "releasing the resource",
51 flags = Flags.ExecReadOnly)
53 cls._register_attribute(ip4)
54 cls._register_attribute(ip6)
55 cls._register_attribute(mac)
56 cls._register_attribute(mask4)
57 cls._register_attribute(mask6)
58 cls._register_attribute(mtu)
59 cls._register_attribute(devname)
60 cls._register_attribute(up)
61 cls._register_attribute(tear_down)
63 def __init__(self, ec, guid):
64 super(LinuxInterface, self).__init__(ec, guid)
65 self._configured = False
67 self._logger = logging.getLogger("LinuxInterface")
71 def log_message(self, msg):
72 return " guid %d - host %s - %s " % (self.guid,
73 self.node.get("hostname"), msg)
77 node = self.get_connected(LinuxNode.rtype())
78 if node: return node[0]
83 chan = self.get_connected(LinuxChannel.rtype())
84 if chan: return chan[0]
87 def discover(self, filters = None):
88 devname = self.get("deviceName")
92 mask4 = self.get("mask4")
93 mask6 = self.get("mask6")
96 # Get current interfaces information
97 (out, err), proc = self.node.execute("ifconfig", sudo = True)
99 if err and proc.poll():
100 msg = " Error retrieving interface information "
101 self.error(msg, out, err)
102 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
104 # Check if an interface is found matching the RM attributes
105 ifaces = out.split("\n\n")
108 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)
117 up = True if m[12] else False
120 self.debug("Found interface %(devname)s with MAC %(mac)s,"
121 "IPv4 %(ipv4)s %(mask4)s IPv6 %(ipv6)s/%(mask6)s %(up)s %(mtu)s" % ({
132 # If the user didn't provide information we take the first
133 # interface that is UP
134 if not devname and not ip4 and not ip6 and up:
135 self._configured = True
136 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
139 # If the user provided ipv4 or ipv6 matching that of an interface
140 # load the interface info
141 if (ip4 and ip4 == i4) or (ip6 and ip6 == i6):
142 self._configured = True
143 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
146 # If the user provided the device name we load the associated info
147 if devname and devname == dn:
148 if ((ip4 and ip4 == i4) and (ipv6 and ip6 == i6)) or \
150 self._configured = True
152 # If the user gave a different ip than the existing, asume ip
153 # needs to be changed
158 self.load_configuration(dn, mc, i4, msk4, i6, msk6, mu, up)
161 if not self.get("deviceName"):
162 msg = "Unable to resolve interface "
164 raise RuntimeError, msg
166 super(LinuxInterface, self).discover(filters = filters)
168 def provision(self, filters = None):
169 devname = self.get("deviceName")
170 ip4 = self.get("ip4")
171 ip6 = self.get("ip4")
172 mac = self.get("mac")
173 mask4 = self.get("mask4")
174 mask6 = self.get("mask6")
175 mtu = self.get("mtu")
177 # Must configure interface if configuration is required
178 if not self._configured:
179 cmd = "ifconfig %s" % devname
182 cmd += " %(ip4)s netmask %(mask4)s broadcast %(bcast)s up" % ({
187 cmd += " mtu %d " % mtu
189 (out, err), proc = self.node.execute(cmd, sudo = True)
191 if err and proc.poll():
192 msg = "Error configuring interface with command '%s'" % cmd
193 self.error(msg, out, err)
194 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
197 cmd = "ifconfig %(devname)s inet6 add %(ip6)s/%(mask6)d" % ({
202 (out, err), proc = self.node.execute(cmd, sudo = True)
204 if err and proc.poll():
205 msg = "Error seting ipv6 for interface using command '%s' " % cmd
206 self.error(msg, out, err)
207 raise RuntimeError, "%s - %s - %s" % (msg, out, err)
209 super(LinuxInterface, self).provision(filters = filters)
212 # Wait until node is provisioned
216 if not node or node.state < ResourceState.PROVISIONED:
217 self.ec.schedule(reschedule_delay, self.deploy)
218 elif not chan or chan.state < ResourceState.READY:
219 self.ec.schedule(reschedule_delay, self.deploy)
221 # Verify if the interface exists in node. If not, configue
222 # if yes, load existing configuration
227 self._state = ResourceState.FAILED
230 super(LinuxInterface, self).deploy()
233 tear_down = self.get("tearDown")
235 self.execute(tear_down)
237 super(LinuxInterface, self).release()
239 def valid_connection(self, guid):
243 def load_configuration(self, devname, mac, ip4, mask4, ip6, mask6, mtu, up):
244 self.set("deviceName", devname)
247 self.set("mask4", mask4)
249 self.set("mask6", mask6)
251 # set the following without validating or triggering hooks
252 attr = self._attrs["up"]
254 attr = self._attrs["mtu"]
256 def add_set_hooks(self):
257 attrup = self._attrs["up"]
258 attrup.set_hook = self.set_hook_up
260 attrmtu = self._attrs["mtu"]
261 attrmtu.set_hook = self.set_hook_mtu
263 def set_hook_up(self, oldval, newval):
267 # configure interface up
269 cmd = "ifup %s" % self.get("deviceName")
270 elif newval == False:
271 cmd = "ifdown %s" % self.get("deviceName")
273 (out, err), proc = self.node.execute(cmd, sudo = True)
275 if err and proc.poll():
276 msg = "Error setting interface up/down using command '%s' " % cmd
277 self.error(msg, err, out)
282 def set_hook_mtu(self, oldval, newval):
286 cmd = "ifconfig %s mtu %d" % (self.get("deviceName"), newval)
288 (out, err), proc = self.node.execute(cmd, sudo = True)
290 if err and proc.poll():
291 msg = "Error setting interface MTU using command '%s' " % cmd
292 self.error(msg, err, out)