"nepi.resources.ns3",
"nepi.resources.omf",
"nepi.resources.planetlab",
- "nepi.resources.planetlab",
"nepi.util"],
package_dir = {"": "src"},
+ package_data = {"nepi.resources.planetlab" : [ "scripts/*.py" ]}
)
--- /dev/null
+#
+# NEPI, a framework to manage network experiments
+# Copyright (C) 2013 INRIA
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: Alina Quereilhac <alina.quereilhac@inria.fr>
+
+import base64
+import errno
+import vsys
+import socket
+from optparse import OptionParser, SUPPRESS_HELP
+
+# TODO: GRE OPTION!! CONFIGURE THE VIF-UP IN GRE MODE!!
+
+STOP_MSG = "STOP"
+
+def create_socket(socket_name):
+ sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+ sock.bind(socket_name)
+ return sock
+
+def recv_msg(conn):
+ msg = []
+ chunk = ''
+
+ while '\n' not in chunk:
+ try:
+ chunk = conn.recv(1024)
+ except (OSError, socket.error), e:
+ if e[0] != errno.EINTR:
+ raise
+ # Ignore eintr errors
+ continue
+
+ if chunk:
+ msg.append(chunk)
+ else:
+ # empty chunk = EOF
+ break
+
+ msg = ''.join(msg).split('\n')[0]
+ decoded = base64.b64decode(msg)
+ return decoded.rstrip()
+
+def send_reply(conn, reply):
+ encoded = base64.b64encode(reply)
+ conn.send("%s\n" % encoded)
+
+def stop_action():
+ return "STOP-ACK"
+
+def reply_action(msg):
+ return "Reply to: %s" % msg
+
+def get_options():
+ usage = ("usage: %prog -t <vif-type> -a <ip4-address> -n <net-prefix> "
+ "-s <snat> -p <pointopoint> -f <if-name-file> -S <socket-name>")
+
+ parser = OptionParser(usage = usage)
+
+ parser.add_option("-t", "--vif-type", dest="vif_type",
+ help = "Virtual interface type. Either IFF_TAP or IFF_TUN. "
+ "Defaults to IFF_TAP. ", type="str")
+
+ parser.add_option("-a", "--ip4-address", dest="ip4_address",
+ help = "IPv4 address to assign to interface. It must belong to the "
+ "network segment owned by the slice, given by the vsys_vnet tag. ",
+ type="str")
+
+ parser.add_option("-n", "--net-prefix", dest="net_prefix",
+ help = "IPv4 network prefix for the interface. It must be the one "
+ "given by the slice's vsys_vnet tag. ",
+ type="int")
+
+ parser.add_option("-s", "--snat", dest="snat", default = False,
+ action="store_true", help="Enable SNAT for the interface")
+
+ parser.add_option("-p", "--pointopoint", dest="pointopoint",
+ help = "Peer end point for the interface ", default = None,
+ type="str")
+
+ parser.add_option("-f", "--if-name-file", dest="if_name_file",
+ help = "File to store the interface name assigned by the OS",
+ default = "if_name", type="str")
+
+ parser.add_option("-S", "--socket-name", dest="socket_name",
+ help = "Name for the unix socket used to interact with this process",
+ default = "tap.sock", type="str")
+
+ (options, args) = parser.parse_args()
+
+ vif_type = vsys.IFF_TAP
+ if options.vif_type and options.vif_type == "IFF_TUN":
+ vif_type = vsys.IFF_TUN
+
+ return (vif_type, options.ip4_address, options.net_prefix, options.snat,
+ options.pointopoint, options.if_name_file, options.socket_name)
+
+if __name__ == '__main__':
+
+ (vif_type, ip4_address, net_prefix, snat, pointopoint,
+ if_name_file, socket_name) = get_options()
+
+ (fd, if_name) = vsys.fd_tuntap(vif_type)
+ vsys.vif_up(if_name, ip4_address, net_prefix, snat, pointopoint)
+
+ # Saving interface name to 'if_name_file
+ f = open(if_name_file, 'w')
+ f.write(if_name)
+ f.close()
+
+ # create unix socket to receive instructions
+ sock = create_socket(socket_name)
+ sock.listen(0)
+
+ # wait for messages to arrive and process them
+ stop = False
+
+ while not stop:
+ conn, addr = sock.accept()
+ conn.settimeout(5)
+
+ while not stop:
+ try:
+ msg = recv_msg(conn)
+ except socket.timeout, e:
+ # Ingore time-out
+ continue
+
+ if not msg:
+ # Ignore - connection lost
+ break
+
+ if msg == STOP_MSG:
+ stop = True
+ reply = stop_action()
+ else:
+ reply = reply_action(msg)
+
+ try:
+ send_reply(conn, reply)
+ except socket.error:
+ break
+
--- /dev/null
+#
+# NEPI, a framework to manage network experiments
+# Copyright (C) 2013 INRIA
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: Alina Quereilhac <alina.quereilhac@inria.fr>
+
+import base64
+import errno
+import vsys
+import socket
+from optparse import OptionParser, SUPPRESS_HELP
+
+STOP_MSG = "STOP"
+
+def get_options():
+ usage = ("usage: %prog -S <socket-name>")
+
+ parser = OptionParser(usage = usage)
+
+ parser.add_option("-S", "--socket-name", dest="socket_name",
+ help = "Name for the unix socket used to interact with this process",
+ default = "tap.sock", type="str")
+
+ (options, args) = parser.parse_args()
+
+ return (options.socket_name)
+
+if __name__ == '__main__':
+
+ (socket_name) = get_options()
+
+ sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+ sock.connect(socket_name)
+ encoded = base64.b64encode(STOP_MSG)
+ sock.send("%s\n" % encoded)
+ reply = sock.recv(1024)
+ reply = base64.b64decode(reply)
+
+ print reply
+
+
+
+
import time
# TODO: - routes!!!
-# - Make base clase 'virtual device' and redefine vif_type
# - Instead of doing an infinite loop, open a port for communication allowing
# to pass the fd to another process
flags = Flags.ExecReadOnly)
prefix4 = Attribute("prefix4", "IPv4 network prefix",
+ type = Types.Integer,
flags = Flags.ExecReadOnly)
mtu = Attribute("mtu", "Maximum transmition unit for device",
def upload_start_command(self):
# upload tap-creation python script
- start_script = self.replace_paths(self._start_script)
- self.node.upload(start_script,
- os.path.join(self.app_home, "tap_create.py"),
- text = True,
+ pl_tap_create = os.path.join(os.path.dirname(__file__), "scripts",
+ "pl-tap-create.py")
+ self.node.upload(pl_tap_create,
+ os.path.join(self.app_home, "pl-vif-create.py"),
overwrite = False)
# upload start.sh
start_command = self.replace_paths(self._start_command)
-
+
self.info("Uploading command '%s'" % start_command)
self.set("command", start_command)
+
self.node.upload(start_command,
os.path.join(self.app_home, "start.sh"),
text = True,
overwrite = False)
+ # upload tap-stop python script
+ pl_tap_stop = os.path.join(os.path.dirname(__file__), "scripts",
+ "pl-tap-stop.py")
+ self.node.upload(pl_tap_stop,
+ os.path.join(self.app_home, "pl-vif-stop.py"),
+ overwrite = False)
+
+ # upload stop.sh script
+ stop_command = self.replace_paths(self._stop_command)
+ self.node.upload(stop_command,
+ os.path.join(self.app_home, "stop.sh"),
+ text = True,
+ overwrite = False)
+
# We want to make sure the device is up and running
- # before the experiment starts.
+ # before the deploy finishes (so things will be ready
+ # before other stuff starts running).
# Run the command as a bash script in background,
# in the host ( but wait until the command has
# finished to continue )
if state == ResourceState.STARTED:
self.info("Stopping command '%s'" % command)
- command = "rm %s" % os.path.join(self.run_home, "if_stop")
- (out, err), proc = self.execute_command(command)
+ command = "bash %s" % os.path.join(self.app_home, "stop.sh")
+ (out, err), proc = self.execute_command(command,
+ blocking = True)
self._stop_time = tnow()
self._state = ResourceState.STOPPED
@property
def _start_command(self):
- return "sudo -S python ${APP_HOME}/tap_create.py"
+ command = ["sudo -S python ${APP_HOME}/pl-vif-create.py"]
+
+ command.append("-t %s" % self.vif_type)
+ command.append("-a %s" % self.get("ip4"))
+ command.append("-n %d" % self.get("prefix4"))
+ command.append("-f %s " % self.if_name_file)
+ command.append("-S %s " % self.sock_name)
+ if self.get("snat") == True:
+ command.append("-s")
+ if self.get("pointopoint"):
+ command.append("-p %s" % self.get("pointopoint"))
+
+ return " ".join(command)
@property
- def _start_script(self):
- return ( "import vsys, time, os \n"
- "(fd, if_name) = vsys.fd_tuntap(vsys.%(devtype)s)\n"
- "vsys.vif_up(if_name, '%(ip)s', %(prefix)s%(snat)s%(pointopoint)s)\n"
- "f = open('%(if_name_file)s', 'w')\n"
- "f.write(if_name)\n"
- "f.close()\n\n"
- "f = open('%(if_stop_file)s', 'w')\n"
- "f.close()\n\n"
- "while os.path.exists('%(if_stop_file)s'):\n"
- " time.sleep(2)\n"
- ) % ({
- "devtype": self._vif_type,
- "ip": self.get("ip4"),
- "prefix": self.get("prefix4"),
- "snat": ", snat=True" if self.get("snat") else "",
- "pointopoint": ", pointopoint=%s" % self.get("pointopoint") \
- if self.get("pointopoint") else "",
- "if_name_file": os.path.join(self.run_home, "if_name"),
- "if_stop_file": os.path.join(self.run_home, "if_stop"),
- })
+ def _stop_command(self):
+ command = ["sudo -S python ${APP_HOME}/pl-vif-stop.py"]
+
+ command.append("-S %s " % self.sock_name)
+ return " ".join(command)
@property
- def _vif_type(self):
+ def vif_type(self):
return "IFF_TAP"
+ @property
+ def if_name_file(self):
+ return os.path.join(self.run_home, "if_name")
+
+ @property
+ def sock_name(self):
+ return os.path.join(self.run_home, "tap.sock")
+
def valid_connection(self, guid):
# TODO: Validate!
return True
from nepi.execution.resource import clsinit_copy
from nepi.resources.planetlab.tap import PlanetlabTap
+import os
+
@clsinit_copy
class PlanetlabTun(PlanetlabTap):
_rtype = "PlanetlabTun"
self._home = "tun-%s" % self.guid
@property
- def _vif_type(self):
+ def sock_name(self):
+ return os.path.join(self.run_home, "tun.sock")
+
+ @property
+ def vif_type(self):
return "IFF_TUN"
tap = ec.register_resource("PlanetlabTap")
ec.set(tap, "ip4", "192.168.1.1")
- ec.set(tap, "prefix4", "24")
+ ec.set(tap, "prefix4", 24)
ec.register_connection(tap, node)
app = ec.register_resource("LinuxApplication")
- cmd = "ping -c3 192.168.1.1"
+ cmd = "ping -c3 192.168.1.1"
ec.set(app, "command", cmd)
ec.register_connection(app, node)
tun = ec.register_resource("PlanetlabTun")
ec.set(tun, "ip4", "192.168.1.1")
- ec.set(tun, "prefix4", "24")
+ ec.set(tun, "prefix4", 24)
ec.register_connection(tun, node)
app = ec.register_resource("LinuxApplication")