2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2014 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>
28 from optparse import OptionParser, SUPPRESS_HELP
30 from ns3wrapper import NS3Wrapper
32 class NS3WrapperMessage:
43 def handle_message(ns3_wrapper, msg_type, args, kwargs):
44 if msg_type == NS3WrapperMessage.SHUTDOWN:
45 ns3_wrapper.shutdown()
47 ns3_wrapper.logger.debug("SHUTDOWN")
51 if msg_type == NS3WrapperMessage.STOP:
52 time = kwargs.get("time")
54 ns3_wrapper.logger.debug("STOP time=%s" % str(time))
56 ns3_wrapper.stop(time=time)
59 if msg_type == NS3WrapperMessage.START:
60 ns3_wrapper.logger.debug("START")
65 if msg_type == NS3WrapperMessage.CREATE:
66 clazzname = args.pop(0)
68 result = ns3_wrapper.create(clazzname, *args)
70 ns3_wrapper.logger.debug("%s CREATE %s %s" % (str(result), clazzname,
75 if msg_type == NS3WrapperMessage.FACTORY:
76 type_name = args.pop(0)
78 result = ns3_wrapper.factory(type_name, **kwargs)
80 ns3_wrapper.logger.debug("%s FACTORY %s %s" % (str(result), type_name,
85 if msg_type == NS3WrapperMessage.INVOKE:
87 operation = args.pop(0)
89 result = ns3_wrapper.invoke(uuid, operation, *args, **kwargs)
91 ns3_wrapper.logger.debug("%s INVOKE %s %s %s %s " % (str(result), uuid,
92 operation, str(args), str(kwargs)))
96 if msg_type == NS3WrapperMessage.GET:
100 result = ns3_wrapper.get(uuid, name)
102 ns3_wrapper.logger.debug("%s GET %s %s" % (str(result), uuid, name))
106 if msg_type == NS3WrapperMessage.SET:
111 result = ns3_wrapper.set(uuid, name, value)
113 ns3_wrapper.logger.debug("%s SET %s %s %s" % (str(result), uuid, name,
118 if msg_type == NS3WrapperMessage.FLUSH:
119 # Forces flushing output and error streams.
120 # NS-3 output will stay unflushed until the program exits or
121 # explicit invocation flush is done
125 ns3_wrapper.logger.debug("FLUSHED")
129 def create_socket(socket_name):
130 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
131 sock.bind(socket_name)
138 while '\n' not in chunk:
140 chunk = conn.recv(1024)
141 except (OSError, socket.error), e:
142 if e[0] != errno.EINTR:
144 # Ignore eintr errors
153 msg = ''.join(msg).strip()
155 # The message is formatted as follows:
156 # MESSAGE_TYPE|args|kwargs
158 # where MESSAGE_TYPE, args and kwargs are pickld and enoded in base64
161 item = base64.b64decode(item).rstrip()
162 return cPickle.loads(item)
164 decoded = map(decode, msg.split("|"))
167 dmsg_type = decoded.pop(0)
168 dargs = list(decoded.pop(0)) # transforming touple into list
169 dkwargs = decoded.pop(0)
171 return (dmsg_type, dargs, dkwargs)
173 def send_reply(conn, reply):
174 encoded = base64.b64encode(cPickle.dumps(reply))
175 conn.send("%s\n" % encoded)
178 usage = ("usage: %prog -S <socket-name> -L <NS_LOG> -v ")
180 parser = OptionParser(usage = usage)
182 parser.add_option("-S", "--socket-name", dest="socket_name",
183 help = "Name for the unix socket used to interact with this process",
184 default = "tap.sock", type="str")
186 parser.add_option("-L", "--ns-log", dest="ns_log",
187 help = "NS_LOG environmental variable to be set",
188 default = "", type="str")
190 parser.add_option("-v", "--verbose",
191 help="Print debug output",
193 dest="verbose", default=False)
195 (options, args) = parser.parse_args()
197 return (options.socket_name, options.verbose, options.ns_log)
199 def run_server(socket_name, level = logging.INFO, ns_log = None):
201 # Sets NS_LOG environmental variable for NS debugging
203 os.environ["NS_LOG"] = ns_log
205 ###### ns-3 wrapper instantiation
207 ns3_wrapper = NS3Wrapper(loglevel=level)
209 ns3_wrapper.logger.info("STARTING...")
211 # create unix socket to receive instructions
212 sock = create_socket(socket_name)
215 # wait for messages to arrive and process them
219 conn, addr = sock.accept()
223 (msg_type, args, kwargs) = recv_msg(conn)
224 except socket.timeout, e:
229 # Ignore - connection lost
232 if msg_type == NS3WrapperMessage.SHUTDOWN:
236 reply = handle_message(ns3_wrapper, msg_type, args, kwargs)
239 err = traceback.format_exc()
240 ns3_wrapper.logger.error(err)
244 send_reply(conn, reply)
248 ns3_wrapper.logger.info("EXITING...")
250 if __name__ == '__main__':
252 (socket_name, verbose, ns_log) = get_options()
255 FORMAT = "%(asctime)s %(name)s %(levelname)-4s %(message)s"
256 level = logging.DEBUG if verbose else logging.INFO
258 logging.basicConfig(format = FORMAT, level = level)
261 run_server(socket_name, level, ns_log)