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 PYTHON_VSYS_VERSION = "1.0"
34 class PlanetlabTap(LinuxApplication):
35 _rtype = "PlanetlabTap"
36 _help = "Creates a TAP device on a PlanetLab host"
37 _backend = "planetlab"
40 def _register_attributes(cls):
41 ip4 = Attribute("ip4", "IPv4 Address",
44 mac = Attribute("mac", "MAC Address",
47 prefix4 = Attribute("prefix4", "IPv4 network prefix",
51 mtu = Attribute("mtu", "Maximum transmition unit for device",
54 devname = Attribute("deviceName",
55 "Name of the network interface (e.g. eth0, wlan0, etc)",
56 flags = Flags.NoWrite)
58 up = Attribute("up", "Link up",
61 snat = Attribute("snat", "Set SNAT=1",
65 pointopoint = Attribute("pointopoint", "Peer IP address",
68 txqueuelen = Attribute("txqueuelen", "Length of transmission queue",
71 txqueuelen = Attribute("txqueuelen", "Length of transmission queue",
74 gre_key = Attribute("greKey",
75 "GRE key to be used to configure GRE tunnel",
79 gre_remote = Attribute("greRemote",
80 "Public IP of remote endpoint for GRE tunnel",
83 tear_down = Attribute("tearDown",
84 "Bash script to be executed before releasing the resource",
87 cls._register_attribute(ip4)
88 cls._register_attribute(mac)
89 cls._register_attribute(prefix4)
90 cls._register_attribute(mtu)
91 cls._register_attribute(devname)
92 cls._register_attribute(up)
93 cls._register_attribute(snat)
94 cls._register_attribute(pointopoint)
95 cls._register_attribute(txqueuelen)
96 cls._register_attribute(gre_key)
97 cls._register_attribute(gre_remote)
98 cls._register_attribute(tear_down)
100 def __init__(self, ec, guid):
101 super(PlanetlabTap, self).__init__(ec, guid)
102 self._home = "tap-%s" % self.guid
103 self._gre_enabled = False
107 node = self.get_connected(PlanetlabNode.get_rtype())
108 if node: return node[0]
109 raise RuntimeError, "TAP/TUN devices must be connected to Node"
112 def gre_enabled(self):
113 if not self._gre_enabled:
114 from nepi.resources.linux.gretunnel import LinuxGRETunnel
115 gre = self.get_connected(LinuxGRETunnel.get_rtype())
116 if gre: self._gre_enabled = True
118 return self._gre_enabled
120 def upload_sources(self):
123 # vif-creation python script
124 pl_vif_create = os.path.join(os.path.dirname(__file__), "scripts",
127 scripts.append(pl_vif_create)
129 # vif-up python script
130 pl_vif_up = os.path.join(os.path.dirname(__file__), "scripts",
133 scripts.append(pl_vif_up)
135 # vif-down python script
136 pl_vif_down = os.path.join(os.path.dirname(__file__), "scripts",
139 scripts.append(pl_vif_down)
141 # udp-connect python script
142 pl_vif_connect = os.path.join(os.path.dirname(__file__), "scripts",
143 "pl-vif-udp-connect.py")
145 scripts.append(pl_vif_connect)
147 # tunnel creation python script
148 tunchannel = os.path.join(os.path.dirname(__file__), "..", "linux",
149 "scripts", "tunchannel.py")
151 scripts.append(tunchannel)
154 scripts = ";".join(scripts)
156 self.node.upload(scripts,
157 os.path.join(self.node.src_dir),
160 # upload stop.sh script
161 stop_command = self.replace_paths(self._stop_command)
163 self.node.upload_command(stop_command,
164 shfile = os.path.join(self.app_home, "stop.sh"),
165 # Overwrite file every time.
166 # The stop.sh has the path to the socket, which should change
167 # on every experiment run.
170 def upload_start_command(self):
171 # If GRE mode is enabled, TAP creation is delayed until the
172 # tunnel is established
173 if not self.gre_enabled:
174 # Overwrite file every time.
175 # The start.sh has the path to the socket, wich should change
176 # on every experiment run.
177 super(PlanetlabTap, self).upload_start_command(overwrite = True)
179 # We want to make sure the device is up and running
180 # before the deploy finishes, so we execute now the
181 # start script. We run it in background, because the
182 # TAP will live for as long as the process that
183 # created it is running, and wait until the TAP
185 self._run_in_background()
187 # After creating the TAP, the pl-vif-create.py script
188 # will write the name of the TAP to a file. We wait until
189 # we can read the interface name from the file.
190 vif_name = self.wait_vif_name()
191 self.set("deviceName", vif_name)
194 if not self.node or self.node.state < ResourceState.PROVISIONED:
195 self.ec.schedule(reschedule_delay, self.deploy)
197 if not self.get("command"):
198 self.set("command", self._start_command)
200 if not self.get("depends"):
201 self.set("depends", self._dependencies)
203 if not self.get("install"):
204 self.set("install", self._install)
212 if self.state == ResourceState.READY:
213 command = self.get("command")
214 self.info("Starting command '%s'" % command)
218 msg = " Failed to execute command '%s'" % command
219 self.error(msg, out, err)
220 raise RuntimeError, msg
223 command = self.get('command') or ''
225 if self.state == ResourceState.STARTED:
226 self.info("Stopping command '%s'" % command)
228 command = "bash %s" % os.path.join(self.app_home, "stop.sh")
229 (out, err), proc = self.execute_command(command,
233 msg = " Failed to stop command '%s' " % command
234 self.error(msg, out, err)
240 state_check_delay = 0.5
241 if self._state == ResourceState.STARTED and \
242 tdiffsec(tnow(), self._last_state_check) > state_check_delay:
244 if self.get("deviceName"):
245 (out, err), proc = self.node.execute("ifconfig")
247 if out.strip().find(self.get("deviceName")) == -1:
248 # tap is not running is not running (socket not found)
251 self._last_state_check = tnow()
255 def do_release(self):
256 # Node needs to wait until all associated RMs are released
258 from nepi.resources.linux.tunnel import LinuxTunnel
259 rms = self.get_connected(LinuxTunnel.get_rtype())
262 if rm.state < ResourceState.STOPPED:
263 self.ec.schedule(reschedule_delay, self.release)
266 super(PlanetlabTap, self).do_release()
268 def wait_vif_name(self, exec_run_home = None):
269 """ Waits until the vif_name file for the command is generated,
270 and returns the vif_name for the device """
274 # The vif_name file will be created in the tap-home, while the
275 # current execution home might be elsewhere to check for errors
276 # (e.g. could be a tunnel-home)
277 if not exec_run_home:
278 exec_run_home = self.run_home
281 (out, err), proc = self.node.check_output(self.run_home, "vif_name")
284 (out, err), proc = self.node.check_errors(exec_run_home)
287 raise RuntimeError, err
290 vif_name = out.strip()
296 msg = "Couldn't retrieve vif_name"
297 self.error(msg, out, err)
298 raise RuntimeError, msg
302 def gre_connect(self, remote_endpoint, connection_app_home,
303 connection_run_home):
304 gre_connect_command = self._gre_connect_command(
305 remote_endpoint, connection_run_home)
307 # upload command to connect.sh script
308 shfile = os.path.join(connection_app_home, "gre-connect.sh")
309 self.node.upload_command(gre_connect_command,
313 # invoke connect script
314 cmd = "bash %s" % shfile
315 (out, err), proc = self.node.run(cmd, connection_run_home)
317 # check if execution errors occurred
318 msg = " Failed to connect endpoints "
320 if proc.poll() or err:
321 self.error(msg, out, err)
322 raise RuntimeError, msg
324 # Wait for pid file to be generated
325 pid, ppid = self.node.wait_pid(connection_run_home)
327 # If the process is not running, check for error information
328 # on the remote machine
329 if not pid or not ppid:
330 (out, err), proc = self.node.check_errors(connection_run_home)
331 # Out is what was written in the stderr file
333 msg = " Failed to start command '%s' " % command
334 self.error(msg, out, err)
335 raise RuntimeError, msg
337 # After creating the TAP, the pl-vif-create.py script
338 # will write the name of the TAP to a file. We wait until
339 # we can read the interface name from the file.
340 vif_name = self.wait_vif_name(exec_run_home = connection_run_home)
341 self.set("deviceName", vif_name)
345 def udp_connect(self, remote_endpoint, connection_app_home,
346 connection_run_home, cipher, cipher_key, bwlimit, txqueuelen):
347 udp_connect_command = self._udp_connect_command(
348 remote_endpoint, connection_run_home,
349 cipher, cipher_key, bwlimit, txqueuelen)
351 # upload command to connect.sh script
352 shfile = os.path.join(connection_app_home, "udp-connect.sh")
353 self.node.upload_command(udp_connect_command,
357 # invoke connect script
358 cmd = "bash %s" % shfile
359 (out, err), proc = self.node.run(cmd, connection_run_home)
361 # check if execution errors occurred
362 msg = "Failed to connect endpoints "
365 self.error(msg, out, err)
366 raise RuntimeError, msg
368 # Wait for pid file to be generated
369 pid, ppid = self.node.wait_pid(connection_run_home)
371 # If the process is not running, check for error information
372 # on the remote machine
373 if not pid or not ppid:
374 (out, err), proc = self.node.check_errors(connection_run_home)
375 # Out is what was written in the stderr file
377 msg = " Failed to start command '%s' " % command
378 self.error(msg, out, err)
379 raise RuntimeError, msg
383 def _udp_connect_command(self, remote_endpoint, connection_run_home,
384 cipher, cipher_key, bwlimit, txqueuelen):
386 # Set the remote endpoint
387 self.set("pointopoint", remote_endpoint.get("ip4"))
389 remote_ip = socket.gethostbyname(
390 remote_endpoint.node.get("ip"))
392 local_port_file = os.path.join(connection_run_home,
395 remote_port_file = os.path.join(connection_run_home,
398 ret_file = os.path.join(connection_run_home,
401 # Generate UDP connect command
402 # Use pl-vif-up.py script to configure TAP with peer info
403 vif_up_command = self._vif_up_command
406 command.append(vif_up_command)
408 # Use pl-vid-udp-connect.py to stablish the tunnel between endpoints
409 command.append(") & (")
410 command.append("sudo -S")
411 command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
412 command.append("python ${SRC}/pl-vif-udp-connect.py")
413 command.append("-t %s" % self.vif_type)
414 command.append("-S %s " % self.sock_name)
415 command.append("-l %s " % local_port_file)
416 command.append("-r %s " % remote_port_file)
417 command.append("-H %s " % remote_ip)
418 command.append("-R %s " % ret_file)
420 command.append("-c %s " % cipher)
422 command.append("-k %s " % cipher_key)
424 command.append("-q %s " % txqueuelen)
426 command.append("-b %s " % bwlimit)
430 command = " ".join(command)
431 command = self.replace_paths(command)
435 def _gre_connect_command(self, remote_endpoint, connection_run_home):
436 # Set the remote endpoint
437 self.set("pointopoint", remote_endpoint.get("ip4"))
438 self.set("greRemote", socket.gethostbyname(
439 remote_endpoint.node.get("ip")))
441 # Generate GRE connect command
443 # Use vif_down command to first kill existing TAP in GRE mode
444 vif_down_command = self._vif_down_command
446 # Use pl-vif-up.py script to configure TAP with peer info
447 vif_up_command = self._vif_up_command
450 command.append(vif_down_command)
451 command.append(") ; (")
452 command.append(vif_up_command)
455 command = " ".join(command)
456 command = self.replace_paths(command)
461 def _start_command(self):
465 command = ["sudo -S python ${SRC}/pl-vif-create.py"]
467 command.append("-t %s" % self.vif_type)
468 command.append("-a %s" % self.get("ip4"))
469 command.append("-n %d" % self.get("prefix4"))
470 command.append("-f %s " % self.vif_name_file)
471 command.append("-S %s " % self.sock_name)
473 if self.get("snat") == True:
476 if self.get("pointopoint"):
477 command.append("-p %s" % self.get("pointopoint"))
479 if self.get("txqueuelen"):
480 command.append("-q %s" % self.get("txqueuelen"))
482 return " ".join(command)
485 def _stop_command(self):
487 command = self._vif_down_command
489 command = ["sudo -S "]
490 command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
491 command.append("python ${SRC}/pl-vif-down.py")
492 command.append("-S %s " % self.sock_name)
493 command = " ".join(command)
498 def _vif_up_command(self):
500 device_name = "%s" % self.guid
502 device_name = self.get("deviceName")
504 # Use pl-vif-up.py script to configure TAP
505 command = ["sudo -S "]
506 command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
507 command.append("python ${SRC}/pl-vif-up.py")
508 command.append("-u %s" % self.node.get("username"))
509 command.append("-N %s" % device_name)
510 command.append("-t %s" % self.vif_type)
511 command.append("-a %s" % self.get("ip4"))
512 command.append("-n %d" % self.get("prefix4"))
514 if self.get("snat") == True:
517 if self.get("pointopoint"):
518 command.append("-p %s" % self.get("pointopoint"))
520 if self.get("txqueuelen"):
521 command.append("-q %s" % self.get("txqueuelen"))
524 command.append("-g %s" % self.get("greKey"))
525 command.append("-G %s" % self.get("greRemote"))
527 command.append("-f %s " % self.vif_name_file)
529 return " ".join(command)
532 def _vif_down_command(self):
534 device_name = "%s" % self.guid
536 device_name = self.get("deviceName")
538 command = ["sudo -S "]
539 command.append("PYTHONPATH=$PYTHONPATH:${SRC}")
540 command.append("python ${SRC}/pl-vif-down.py")
541 command.append("-N %s " % device_name)
544 command.append("-u %s" % self.node.get("username"))
545 command.append("-t %s" % self.vif_type)
548 return " ".join(command)
555 def vif_name_file(self):
556 return os.path.join(self.run_home, "vif_name")
560 return os.path.join(self.run_home, "tap.sock")
563 def _dependencies(self):
564 return "mercurial make gcc"
568 # Install python-vsys and python-passfd
569 install_vsys = ( " ( "
570 " python -c 'import vsys, os; vsys.__version__ == \"%(version)s\" or os._exit(1)' "
575 " hg clone http://nepi.inria.fr/code/python-vsys ; "
578 " sudo -S make install "
580 "version": PYTHON_VSYS_VERSION
583 install_passfd = ( " ( python -c 'import passfd' ) "
587 " hg clone http://nepi.inria.fr/code/python-passfd ; "
588 " cd python-passfd ; "
590 " sudo -S make install "
593 return "%s ; %s" % ( install_vsys, install_passfd )
595 def valid_connection(self, guid):