Adding tuncahnnel and pl-vif-tunnconnect scripts
[nepi.git] / src / nepi / resources / planetlab / scripts / pl-vif-create.py
1 #
2 #    NEPI, a framework to manage network experiments
3 #    Copyright (C) 2013 INRIA
4 #
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.
9 #
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.
14 #
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/>.
17 #
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19
20 import base64
21 import errno
22 import passfd
23 import socket
24 import vsys
25 from optparse import OptionParser, SUPPRESS_HELP
26
27 # TODO: GRE OPTION!! CONFIGURE THE VIF-UP IN GRE MODE!!
28
29 STOP_MSG = "STOP"
30 PASSFD_MSG = "PASSFD"
31
32 def create_socket(socket_name):
33     sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
34     sock.bind(socket_name)
35     return sock
36
37 def recv_msg(conn):
38     msg = []
39     chunk = ''
40
41     while '\n' not in chunk:
42         try:
43             chunk = conn.recv(1024)
44         except (OSError, socket.error), e:
45             if e[0] != errno.EINTR:
46                 raise
47             # Ignore eintr errors
48             continue
49
50         if chunk:
51             msg.append(chunk)
52         else:
53             # empty chunk = EOF
54             break
55
56     msg = ''.join(msg).split('\n')[0]
57     # The message might have arguments that will be appended
58     # as a '|' separated list after the message type
59     args = msg.split("|")
60     msg = args.pop(0)
61
62     dmsg = base64.b64decode(msg)
63     dargs = []
64     for arg in args:
65         darg = base64.b64decode(arg)
66         dargs.append(darg.rstrip())
67
68     return (dmsg.rstrip(), dargs)
69
70 def send_reply(conn, reply):
71     encoded = base64.b64encode(reply)
72     conn.send("%s\n" % encoded)
73
74 def stop_action():
75     return "STOP-ACK"
76
77 def passfd_action(fd, args):
78     address = args.pop(0)
79     print address
80     sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
81     sock.connect(address)
82     passfd.sendfd(sock, fd, '0')
83     return "PASSFD-ACK"
84
85 def get_options():
86     usage = ("usage: %prog -t <vif-type> -a <ip4-address> -n <net-prefix> "
87         "-s <snat> -p <pointopoint> -f <if-name-file> -S <socket-name>")
88     
89     parser = OptionParser(usage = usage)
90
91     parser.add_option("-t", "--vif-type", dest="vif_type",
92         help = "Virtual interface type. Either IFF_TAP or IFF_TUN. "
93             "Defaults to IFF_TAP. ", type="str")
94
95     parser.add_option("-a", "--ip4-address", dest="ip4_address",
96         help = "IPv4 address to assign to interface. It must belong to the "
97             "network segment owned by the slice, given by the vsys_vnet tag. ",
98         type="str")
99
100     parser.add_option("-n", "--net-prefix", dest="net_prefix",
101         help = "IPv4 network prefix for the interface. It must be the one "
102             "given by the slice's vsys_vnet tag. ",
103         type="int")
104
105     parser.add_option("-s", "--snat", dest="snat", default = False,
106         action="store_true", help="Enable SNAT for the interface")
107
108     parser.add_option("-p", "--pointopoint", dest="pointopoint",
109         help = "Peer end point for the interface  ", default = None,
110         type="str")
111
112     parser.add_option("-f", "--if-name-file", dest="if_name_file",
113         help = "File to store the interface name assigned by the OS", 
114         default = "if_name", type="str")
115
116     parser.add_option("-S", "--socket-name", dest="socket_name",
117         help = "Name for the unix socket used to interact with this process", 
118         default = "tap.sock", type="str")
119
120     (options, args) = parser.parse_args()
121     
122     vif_type = vsys.IFF_TAP
123     if options.vif_type and options.vif_type == "IFF_TUN":
124         vif_type = vsys.IFF_TUN
125
126     return (vif_type, options.ip4_address, options.net_prefix, options.snat,
127             options.pointopoint, options.if_name_file, options.socket_name)
128
129 if __name__ == '__main__':
130
131     (vif_type, ip4_address, net_prefix, snat, pointopoint,
132             if_name_file, socket_name) = get_options()
133
134     (fd, if_name) = vsys.fd_tuntap(vif_type)
135     vsys.vif_up(if_name, ip4_address, net_prefix, snat, pointopoint)
136     
137     # Saving interface name to 'if_name_file
138     f = open(if_name_file, 'w')
139     f.write(if_name)
140     f.close()
141
142     # create unix socket to receive instructions
143     sock = create_socket(socket_name)
144     sock.listen(0)
145
146     # wait for messages to arrive and process them
147     stop = False
148
149     while not stop:
150         conn, addr = sock.accept()
151         conn.settimeout(5)
152
153         while not stop:
154             try:
155                 (msg, args) = recv_msg(conn)
156             except socket.timeout, e:
157                 # Ingore time-out
158                 continue
159
160             if not msg:
161                 # Ignore - connection lost
162                 break
163
164             if msg == STOP_MSG:
165                 stop = True
166                 reply = stop_action()
167             elif msg == PASSFD_MSG:
168                 reply = passfd_action(fd, args)
169
170             try:
171                 send_reply(conn, reply)
172             except socket.error:
173                 break
174