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.util.sshfuncs import ProcStatus
25 from nepi.util.timefuncs import tnow, tdiffsec
32 class UdpTunnel(LinuxApplication):
34 _help = "Constructs a tunnel between two Linux endpoints using a UDP connection "
39 def _register_attributes(cls):
40 cipher = Attribute("cipher",
41 "Cipher to encript communication. "
42 "One of PLAIN, AES, Blowfish, DES, DES3. ",
44 allowed = ["PLAIN", "AES", "Blowfish", "DES", "DES3"],
45 type = Types.Enumerate,
46 flags = Flags.ExecReadOnly)
48 cipher_key = Attribute("cipherKey",
49 "Specify a symmetric encryption key with which to protect "
50 "packets across the tunnel. python-crypto must be installed "
52 flags = Flags.ExecReadOnly)
54 txqueuelen = Attribute("txQueueLen",
55 "Specifies the interface's transmission queue length. "
58 flags = Flags.ExecReadOnly)
60 bwlimit = Attribute("bwLimit",
61 "Specifies the interface's emulated bandwidth in bytes "
64 flags = Flags.ExecReadOnly)
66 cls._register_attribute(cipher)
67 cls._register_attribute(cipher_key)
68 cls._register_attribute(txqueuelen)
69 cls._register_attribute(bwlimit)
71 def __init__(self, ec, guid):
72 super(UdpTunnel, self).__init__(ec, guid)
73 self._home = "udp-tunnel-%s" % self.guid
79 def log_message(self, msg):
80 return " guid %d - tunnel %s - %s - %s " % (self.guid,
81 self.endpoint1.node.get("hostname"),
82 self.endpoint2.node.get("hostname"),
85 def get_endpoints(self):
86 """ Returns the list of RM that are endpoints to the tunnel
89 for guid in self.connections:
90 rm = self.ec.get_resource(guid)
91 if hasattr(rm, "udp_connect_command"):
97 endpoints = self.get_endpoints()
98 if endpoints: return endpoints[0]
103 endpoints = self.get_endpoints()
104 if endpoints and len(endpoints) > 1: return endpoints[1]
107 def app_home(self, endpoint):
108 return os.path.join(endpoint.node.exp_home, self._home)
110 def run_home(self, endpoint):
111 return os.path.join(self.app_home(endpoint), self.ec.run_id)
113 def udp_connect(self, endpoint, remote_ip):
114 # Get udp connect command
115 local_port_file = os.path.join(self.run_home(endpoint),
117 remote_port_file = os.path.join(self.run_home(endpoint),
119 ret_file = os.path.join(self.run_home(endpoint),
121 cipher = self.get("cipher")
122 cipher_key = self.get("cipherKey")
123 bwlimit = self.get("bwLimit")
124 txqueuelen = self.get("txQueueLen")
125 udp_connect_command = endpoint.udp_connect_command(
126 remote_ip, local_port_file, remote_port_file,
127 ret_file, cipher, cipher_key, bwlimit, txqueuelen)
129 # upload command to connect.sh script
130 shfile = os.path.join(self.app_home(endpoint), "udp-connect.sh")
131 endpoint.node.upload(udp_connect_command,
136 # invoke connect script
137 cmd = "bash %s" % shfile
138 (out, err), proc = endpoint.node.run(cmd, self.run_home(endpoint))
140 # check if execution errors occurred
141 msg = " Failed to connect endpoints "
144 self.error(msg, out, err)
145 raise RuntimeError, msg
147 # Wait for pid file to be generated
148 pid, ppid = endpoint.node.wait_pid(self.run_home(endpoint))
150 # If the process is not running, check for error information
151 # on the remote machine
152 if not pid or not ppid:
153 (out, err), proc = endpoint.node.check_errors(self.run_home(endpoint))
154 # Out is what was written in the stderr file
156 msg = " Failed to start command '%s' " % command
157 self.error(msg, out, err)
158 raise RuntimeError, msg
160 # wait until port is written to file
161 port = self.wait_local_port(endpoint)
162 return (port, pid, ppid)
164 def do_provision(self):
165 # create run dir for tunnel on each node
166 self.endpoint1.node.mkdir(self.run_home(self.endpoint1))
167 self.endpoint2.node.mkdir(self.run_home(self.endpoint2))
169 # Invoke connect script in endpoint 1
170 remote_ip1 = socket.gethostbyname(self.endpoint2.node.get("hostname"))
171 (port1, self._pid1, self._ppid1) = self.udp_connect(self.endpoint1,
174 # Invoke connect script in endpoint 2
175 remote_ip2 = socket.gethostbyname(self.endpoint1.node.get("hostname"))
176 (port2, self._pid2, self._ppid2) = self.udp_connect(self.endpoint2,
179 # upload file with port 2 to endpoint 1
180 self.upload_remote_port(self.endpoint1, port2)
182 # upload file with port 1 to endpoint 2
183 self.upload_remote_port(self.endpoint2, port1)
185 # check if connection was successful on both sides
186 self.wait_result(self.endpoint1)
187 self.wait_result(self.endpoint2)
189 self.info("Provisioning finished")
191 self.set_provisioned()
194 if (not self.endpoint1 or self.endpoint1.state < ResourceState.READY) or \
195 (not self.endpoint2 or self.endpoint2.state < ResourceState.READY):
196 self.ec.schedule(reschedule_delay, self.deploy)
201 self.debug("----- READY ---- ")
205 if self.state == ResourceState.READY:
206 command = self.get("command")
207 self.info("Starting command '%s'" % command)
211 msg = " Failed to execute command '%s'" % command
212 self.error(msg, out, err)
213 raise RuntimeError, msg
216 """ Stops application execution
218 if self.state == ResourceState.STARTED:
219 self.info("Stopping tunnel")
221 # Only try to kill the process if the pid and ppid
223 if self._pid1 and self._ppid1 and self._pid2 and self._ppid2:
224 (out1, err1), proc1 = self.endpoint1.node.kill(self._pid1,
225 self._ppid1, sudo = True)
226 (out2, err2), proc2 = self.endpoint2.node.kill(self._pid2,
227 self._ppid2, sudo = True)
229 if err1 or err2 or proc1.poll() or proc2.poll():
230 # check if execution errors occurred
231 msg = " Failed to STOP tunnel"
232 self.error(msg, err1, err2)
233 raise RuntimeError, msg
239 """ Returns the state of the application
241 if self._state == ResourceState.STARTED:
242 # In order to avoid overwhelming the remote host and
243 # the local processor with too many ssh queries, the state is only
244 # requested every 'state_check_delay' seconds.
245 state_check_delay = 0.5
246 if tdiffsec(tnow(), self._last_state_check) > state_check_delay:
247 if self._pid1 and self._ppid1 and self._pid2 and self._ppid2:
248 # Make sure the process is still running in background
249 # No execution errors occurred. Make sure the background
250 # process with the recorded pid is still running.
251 status1 = self.endpoint1.node.status(self._pid1, self._ppid1)
252 status2 = self.endpoint2.node.status(self._pid2, self._ppid2)
254 if status1 == ProcStatus.FINISHED and \
255 status2 == ProcStatus.FINISHED:
257 # check if execution errors occurred
258 (out1, err1), proc1 = self.endpoint1.node.check_errors(
259 self.run_home(self.endpoint1))
261 (out2, err2), proc2 = self.endpoint2.node.check_errors(
262 self.run_home(self.endpoint2))
265 msg = "Error occurred in tunnel"
266 self.error(msg, err1, err2)
271 self._last_state_check = tnow()
275 def wait_local_port(self, endpoint):
276 """ Waits until the local_port file for the endpoint is generated,
277 and returns the port number
280 return self.wait_file(endpoint, "local_port")
282 def wait_result(self, endpoint):
283 """ Waits until the return code file for the endpoint is generated
286 return self.wait_file(endpoint, "ret_file")
288 def wait_file(self, endpoint, filename):
289 """ Waits until file on endpoint is generated """
294 (out, err), proc = endpoint.node.check_output(
295 self.run_home(endpoint), filename)
304 msg = "Couldn't retrieve %s" % filename
305 self.error(msg, out, err)
306 raise RuntimeError, msg
310 def upload_remote_port(self, endpoint, port):
311 # upload remote port number to file
313 endpoint.node.upload(port,
314 os.path.join(self.run_home(endpoint), "remote_port"),
318 def valid_connection(self, guid):