applied the except and raise fixers to the master branch to close the gap with py3
[nepi.git] / src / nepi / resources / planetlab / scripts / pl-vif-create.py
index 758cfc4..6b72278 100644 (file)
@@ -3,9 +3,8 @@
 #    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.
+#    it under the terms of the GNU General Public License version 2 as
+#    published by the Free Software Foundation;
 #
 #    This program is distributed in the hope that it will be useful,
 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
 #
 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
 
+from __future__ import print_function
+
 import base64
 import errno
-import vsys
+import passfd
 import socket
-from optparse import OptionParser, SUPPRESS_HELP
-
-# TODO: GRE OPTION!! CONFIGURE THE VIF-UP IN GRE MODE!!
+import vsys
+from optparse import OptionParser
 
 STOP_MSG = "STOP"
+PASSFD_MSG = "PASSFD"
 
 def create_socket(socket_name):
     sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
@@ -39,7 +40,7 @@ def recv_msg(conn):
     while '\n' not in chunk:
         try:
             chunk = conn.recv(1024)
-        except (OSError, socket.error), e:
+        except (OSError, socket.error) as e:
             if e[0] != errno.EINTR:
                 raise
             # Ignore eintr errors
@@ -52,8 +53,18 @@ def recv_msg(conn):
             break
 
     msg = ''.join(msg).split('\n')[0]
-    decoded = base64.b64decode(msg)
-    return decoded.rstrip()
+    # The message might have arguments that will be appended
+    # as a '|' separated list after the message type
+    args = msg.split("|")
+    msg = args.pop(0)
+
+    dmsg = base64.b64decode(msg)
+    dargs = []
+    for arg in args:
+        darg = base64.b64decode(arg)
+        dargs.append(darg.rstrip())
+
+    return (dmsg.rstrip(), dargs)
 
 def send_reply(conn, reply):
     encoded = base64.b64encode(reply)
@@ -62,12 +73,21 @@ def send_reply(conn, reply):
 def stop_action():
     return "STOP-ACK"
 
-def reply_action(msg):
-    return "Reply to: %s" % msg
+def passfd_action(fd, args):
+    """ Sends the file descriptor associated to the TAP device 
+    to another process through a unix socket.
+    """
+    address = args.pop(0)
+    print(address)
+    sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
+    sock.connect(address)
+    passfd.sendfd(sock, fd, '0')
+    return "PASSFD-ACK"
 
 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>")
+        "-s <snat> -p <pointopoint> -q <txqueuelen> -f <vif-name-file> "
+        "-S <socket-name>")
     
     parser = OptionParser(usage = usage)
 
@@ -92,13 +112,18 @@ def get_options():
         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("-q", "--txqueuelen", dest="txqueuelen",
+        help = "Size of transmision queue. Defaults to 0.",
+        default = 0,
+        type="int")
+
+    parser.add_option("-f", "--vif-name-file", dest="vif_name_file",
+        help = "File to store the virtual interface name assigned by the OS", 
+        default = "vif_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")
+        type="str")
 
     (options, args) = parser.parse_args()
     
@@ -106,21 +131,23 @@ def get_options():
     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)
+    return (vif_type, options.ip4_address, options.net_prefix, 
+            options.snat, options.pointopoint, options.txqueuelen,
+            options.vif_name_file, options.socket_name)
 
 if __name__ == '__main__':
 
-    (vif_type, ip4_address, net_prefix, snat, pointopoint,
-            if_name_file, socket_name) = get_options()
+    (vif_type, ip4_address, net_prefix, snat, pointopoint, 
+            txqueuelen, vif_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()
+    (fd, vif_name) = vsys.fd_tuntap(vif_type)
+  
+    vsys.vif_up(vif_name, ip4_address, net_prefix, snat = snat, 
+            pointopoint = pointopoint, txqueuelen = txqueuelen) 
+     
+    # Saving interface name to vif_name_file
+    with open(vif_name_file, 'w') as f:
+        f.write(vif_name)
 
     # create unix socket to receive instructions
     sock = create_socket(socket_name)
@@ -135,8 +162,8 @@ if __name__ == '__main__':
 
         while not stop:
             try:
-                msg = recv_msg(conn)
-            except socket.timeout, e:
+                (msg, args) = recv_msg(conn)
+            except socket.timeout as e:
                 # Ingore time-out
                 continue
 
@@ -147,8 +174,8 @@ if __name__ == '__main__':
             if msg == STOP_MSG:
                 stop = True
                 reply = stop_action()
-            else:
-                reply = reply_action(msg)
+            elif msg == PASSFD_MSG:
+                reply = passfd_action(fd, args)
 
             try:
                 send_reply(conn, reply)