59b04589042bb04c924294d6fd8b21ca968278c5
[nepi.git] / src / nepi / resources / linux / ns3 / ns3client.py
1 #
2 #    NEPI, a framework to manage network experiments
3 #    Copyright (C) 2014 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 cPickle
22 import errno
23 import socket
24 import weakref
25
26 from optparse import OptionParser, SUPPRESS_HELP
27
28 from nepi.resources.ns3.ns3client import NS3Client
29 from nepi.resources.ns3.ns3server import NS3WrapperMessage
30
31 class LinuxNS3Client(NS3Client):
32     def __init__(self, simulation):
33         super(LinuxNS3Client, self).__init__()
34         self._simulation = weakref.ref(simulation)
35
36         self._socat_proc = None
37         self.connect_client()
38
39     @property
40     def simulation(self):
41         return self._simulation()
42
43     def connect_client(self):
44         if self.simulation.node.get("hostname") in ['localhost', '127.0.0.1']:
45             return
46
47         (out, err), self._socat_proc = self.simulation.node.socat(
48                 self.simulation.local_socket,
49                 self.simulation.remote_socket) 
50
51     def send_msg(self, msg, *args):
52         args = list(args)
53
54         sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
55         sock.connect(self.simulation.local_socket)
56
57         args.insert(0, msg)
58         def encode(arg):
59             arg = cPickle.dumps(arg)
60             return base64.b64encode(arg) 
61
62         encoded = "|".join(map(encode, args))
63         sock.send("%s\n" % encoded)
64         
65         reply = sock.recv(1024)
66         return cPickle.loads(base64.b64decode(reply))
67
68     def create(self, clazzname, *args):
69         args = list(args)
70         args.insert(0, clazzname)
71         
72         return self.send_msg(NS3WrapperMessage.CREATE, *args)
73
74     def factory(self, type_name, **kwargs):
75         args = [type_name]
76         args.append(kwargs)
77         
78         return self.send_msg(NS3WrapperMessage.FACTORY, *args)
79
80     def invoke(self, uuid, operation, *args):
81         args = list(args)
82         args.insert(0, operation)
83         args.insert(0, uuid)
84
85         return self.send_msg(NS3WrapperMessage.INVOKE, *args)
86
87     def set(self, uuid, name, value):
88         args = [uuid, name, value]
89
90         return self.send_msg(NS3WrapperMessage.SET, *args)
91
92     def get(self, uuid, name):
93         args = [uuid, name]
94
95         return self.send_msg(NS3WrapperMessage.GET, *args)
96
97     def trace(self, *args):
98         return self.send_msg(NS3WrapperMessage.TRACE, *args)
99
100     def start(self):
101         return self.send_msg(NS3WrapperMessage.START, [])
102
103     def stop(self, time = None):
104         args = None
105         if time:
106             args = [time]
107
108         return self.send_msg(NS3WrapperMessage.STOP, *args)
109
110     def shutdown(self):
111         ret = None
112
113         try:
114             ret = self.send_msg(NS3WrapperMessage.SHUTDOWN, [])
115         except:
116             pass
117
118         try:
119             if self._socat_proc:
120                 self._socat_proc.kill()
121         except:
122             pass
123
124         try:
125             os.remove(self.simulation.local_socket)
126         except:
127             pass
128
129         return ret
130