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, Flags, Types
21 from nepi.execution.resource import clsinit_copy, ResourceState, \
23 from nepi.resources.linux.application import LinuxApplication
24 from nepi.resources.planetlab.node import PlanetlabNode
25 from nepi.util.timefuncs import tnow, tdiffsec
31 # - CREATE GRE - PlanetlabGRE - it only needs to set the gre and remote
32 # properties when configuring the vif_up
34 PYTHON_VSYS_VERSION = "1.0"
37 class PlanetlabTap(LinuxApplication):
38 _rtype = "PlanetlabTap"
39 _help = "Creates a TAP device on a PlanetLab host"
40 _backend = "planetlab"
43 def _register_attributes(cls):
44 ip4 = Attribute("ip4", "IPv4 Address",
45 flags = Flags.ExecReadOnly)
47 mac = Attribute("mac", "MAC Address",
48 flags = Flags.ExecReadOnly)
50 prefix4 = Attribute("prefix4", "IPv4 network prefix",
52 flags = Flags.ExecReadOnly)
54 mtu = Attribute("mtu", "Maximum transmition unit for device",
57 devname = Attribute("deviceName",
58 "Name of the network interface (e.g. eth0, wlan0, etc)",
59 flags = Flags.ReadOnly)
61 up = Attribute("up", "Link up",
64 snat = Attribute("snat", "Set SNAT=1",
66 flags = Flags.ExecReadOnly)
68 pointopoint = Attribute("pointopoint", "Peer IP address",
69 flags = Flags.ExecReadOnly)
71 tear_down = Attribute("tearDown", "Bash script to be executed before " + \
72 "releasing the resource",
73 flags = Flags.ExecReadOnly)
75 cls._register_attribute(ip4)
76 cls._register_attribute(mac)
77 cls._register_attribute(prefix4)
78 cls._register_attribute(mtu)
79 cls._register_attribute(devname)
80 cls._register_attribute(up)
81 cls._register_attribute(snat)
82 cls._register_attribute(pointopoint)
83 cls._register_attribute(tear_down)
85 def __init__(self, ec, guid):
86 super(PlanetlabTap, self).__init__(ec, guid)
87 self._home = "tap-%s" % self.guid
91 node = self.get_connected(PlanetlabNode.get_rtype())
92 if node: return node[0]
95 def upload_sources(self):
96 # upload vif-creation python script
97 pl_vif_create = os.path.join(os.path.dirname(__file__), "scripts",
100 self.node.upload(pl_vif_create,
101 os.path.join(self.node.src_dir, "pl-vif-create.py"),
104 # upload vif-stop python script
105 pl_vif_stop = os.path.join(os.path.dirname(__file__), "scripts",
108 self.node.upload(pl_vif_stop,
109 os.path.join(self.node.src_dir, "pl-vif-stop.py"),
112 # upload vif-connect python script
113 pl_vif_connect = os.path.join(os.path.dirname(__file__), "scripts",
114 "pl-vif-udp-connect.py")
116 self.node.upload(pl_vif_connect,
117 os.path.join(self.node.src_dir, "pl-vif-udp-connect.py"),
120 # upload tun-connect python script
121 tunchannel = os.path.join(os.path.dirname(__file__), "..", "linux",
122 "scripts", "tunchannel.py")
124 self.node.upload(tunchannel,
125 os.path.join(self.node.src_dir, "tunchannel.py"),
128 # upload stop.sh script
129 stop_command = self.replace_paths(self._stop_command)
130 self.node.upload(stop_command,
131 os.path.join(self.app_home, "stop.sh"),
133 # Overwrite file every time.
134 # The stop.sh has the path to the socket, wich should change
135 # on every experiment run.
138 def upload_start_command(self):
139 # Overwrite file every time.
140 # The stop.sh has the path to the socket, wich should change
141 # on every experiment run.
142 super(PlanetlabTap, self).upload_start_command(overwrite = True)
144 # We want to make sure the device is up and running
145 # before the deploy finishes (so things will be ready
146 # before other stuff starts running).
147 # Run the command as a bash script in background,
148 # in the host ( but wait until the command has
149 # finished to continue )
150 self._run_in_background()
153 if_name = self.wait_if_name()
154 self.set("deviceName", if_name)
157 if not self.node or self.node.state < ResourceState.PROVISIONED:
158 self.ec.schedule(reschedule_delay, self.deploy)
160 if not self.get("command"):
161 self.set("command", self._start_command)
163 if not self.get("depends"):
164 self.set("depends", self._dependencies)
166 if not self.get("install"):
167 self.set("install", self._install)
172 self.debug("----- READY ---- ")
176 if self.state == ResourceState.READY:
177 command = self.get("command")
178 self.info("Starting command '%s'" % command)
182 msg = " Failed to execute command '%s'" % command
183 self.error(msg, out, err)
184 raise RuntimeError, msg
187 command = self.get('command') or ''
189 if self.state == ResourceState.STARTED:
190 self.info("Stopping command '%s'" % command)
192 command = "bash %s" % os.path.join(self.app_home, "stop.sh")
193 (out, err), proc = self.execute_command(command,
200 # First check if the ccnd has failed
201 state_check_delay = 0.5
202 if self._state == ResourceState.STARTED and \
203 tdiffsec(tnow(), self._last_state_check) > state_check_delay:
205 if self.get("deviceName"):
206 (out, err), proc = self.node.execute("ifconfig")
208 if out.strip().find(self.get("deviceName")) == -1:
209 # tap is not running is not running (socket not found)
212 self._last_state_check = tnow()
216 def do_release(self):
217 # Node needs to wait until all associated RMs are released
219 from nepi.resources.linux.udptunnel import UdpTunnel
220 rms = self.get_connected(UdpTunnel.get_rtype())
222 if rm.state < ResourceState.STOPPED:
223 self.ec.schedule(reschedule_delay, self.release)
226 super(PlanetlabTap, self).do_release()
228 def wait_if_name(self):
229 """ Waits until the if_name file for the command is generated,
230 and returns the if_name for the device """
235 (out, err), proc = self.node.check_output(self.run_home, "if_name")
238 if_name = out.strip()
244 msg = "Couldn't retrieve if_name"
245 self.error(msg, out, err)
246 raise RuntimeError, msg
250 def udp_connect_command(self, remote_ip, local_port_file,
251 remote_port_file, ret_file, cipher, cipher_key,
252 bwlimit, txqueuelen):
253 command = ["sudo -S "]
254 command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
255 command.append("python ${SRC}/pl-vif-udp-connect.py")
256 command.append("-t %s" % self.vif_type)
257 command.append("-S %s " % self.sock_name)
258 command.append("-l %s " % local_port_file)
259 command.append("-r %s " % remote_port_file)
260 command.append("-H %s " % remote_ip)
261 command.append("-R %s " % ret_file)
263 command.append("-c %s " % cipher)
265 command.append("-k %s " % cipher_key)
267 command.append("-q %s " % txqueuelen)
269 command.append("-b %s " % bwlimit)
271 command = " ".join(command)
272 command = self.replace_paths(command)
276 def _start_command(self):
277 command = ["sudo -S python ${SRC}/pl-vif-create.py"]
279 command.append("-t %s" % self.vif_type)
280 command.append("-a %s" % self.get("ip4"))
281 command.append("-n %d" % self.get("prefix4"))
282 command.append("-f %s " % self.if_name_file)
283 command.append("-S %s " % self.sock_name)
284 if self.get("snat") == True:
286 if self.get("pointopoint"):
287 command.append("-p %s" % self.get("pointopoint"))
289 return " ".join(command)
292 def _stop_command(self):
293 command = ["sudo -S python ${SRC}/pl-vif-stop.py"]
295 command.append("-S %s " % self.sock_name)
296 return " ".join(command)
303 def if_name_file(self):
304 return os.path.join(self.run_home, "if_name")
308 return os.path.join(self.run_home, "tap.sock")
311 def _dependencies(self):
312 return "mercurial make gcc"
316 # Install python-vsys and python-passfd
317 install_vsys = ( " ( "
318 " python -c 'import vsys, os; vsys.__version__ == \"%(version)s\" or os._exit(1)' "
323 " hg clone http://nepi.inria.fr/code/python-vsys ; "
326 " sudo -S make install "
328 "version": PYTHON_VSYS_VERSION
331 install_passfd = ( " ( python -c 'import passfd' ) "
335 " hg clone http://nepi.inria.fr/code/python-passfd ; "
336 " cd python-passfd ; "
338 " sudo -S make install "
341 return "%s ; %s" % ( install_vsys, install_passfd )
343 def valid_connection(self, guid):