src/nepi/resources/netns/netnswrapper.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 version 2 as
   7 #    published by the Free Software Foundation;
   8 #
   9 #    This program is distributed in the hope that it will be useful,
  10 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 #    GNU General Public License for more details.
  13 #
  14 #    You should have received a copy of the GNU General Public License
  15 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 #
  17 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  18
  19 import logging
  20 import time
  21 import os
  22 import sys
  23 import uuid
  24
  25 class NetNSWrapper(object):
  26     def __init__(self, loglevel = logging.INFO, enable_dump = False):
  27         super(NetNSWrapper, self).__init__()
  28         # holds reference to all C++ objects and variables in the simulation
  29         self._objects = dict()
  30
  31         # Logging
  32         self._logger = logging.getLogger("netnswrapper")
  33         self._logger.setLevel(loglevel)
  34
  35         # Object to dump instructions to reproduce and debug experiment
  36         from netnswrapper_debug import NetNSWrapperDebuger
  37         self._debuger = NetNSWrapperDebuger(enabled = enable_dump)
  38
  39     @property
  40     def debuger(self):
  41         return self._debuger
  42
  43     @property
  44     def logger(self):
  45         return self._logger
  46
  47     def make_uuid(self):
  48         return "uuid%s" % uuid.uuid4()
  49
  50     def get_object(self, uuid):
  51         return self._objects.get(uuid)
  52
  53     def create(self, clazzname, *args):
  54         """ This method should be used to construct netns objects """
  55         import netns
  56
  57         if clazzname not in ['open'] and not hasattr(netns, clazzname):
  58             msg = "Type %s not supported" % (clazzname)
  59             self.logger.error(msg)
  60
  61         uuid = self.make_uuid()
  62
  63         ### DEBUG
  64         self.logger.debug("CREATE %s( %s )" % (clazzname, str(args)))
  65
  66         self.debuger.dump_create(uuid, clazzname, args)
  67         ########
  68
  69         if clazzname == "open":
  70             path = args[0]
  71             mode = args[1]
  72             obj = open(path, mode)
  73         else:
  74             clazz = getattr(netns, clazzname)
  75
  76             # arguments starting with 'uuid' identify ns-3 C++
  77             # objects and must be replaced by the actual object
  78             realargs = self.replace_args(args)
  79
  80             obj = clazz(*realargs)
  81
  82         self._objects[uuid] = obj
  83
  84         ### DEBUG
  85         self.logger.debug("RET CREATE ( uuid %s ) %s = %s( %s )" % (str(uuid),
  86             str(obj), clazzname, str(args)))
  87         ########
  88
  89         return uuid
  90
  91     def invoke(self, uuid, operation, *args, **kwargs):
  92         newuuid = self.make_uuid()
  93
  94         ### DEBUG
  95         self.logger.debug("INVOKE %s -> %s( %s, %s ) " % (
  96             uuid, operation, str(args), str(kwargs)))
  97
  98         self.debuger.dump_invoke(newuuid, uuid, operation, args, kwargs)
  99         ########
 100
 101         obj = self.get_object(uuid)
 102
 103         method = getattr(obj, operation)
 104
 105         # arguments starting with 'uuid' identify netns
 106         # objects and must be replaced by the actual object
 107         realargs = self.replace_args(args)
 108         realkwargs = self.replace_kwargs(kwargs)
 109
 110         result = method(*realargs, **realkwargs)
 111
 112         # If the result is an object (not a base value),
 113         # then keep track of the object a return the object
 114         # reference (newuuid)
 115         # xxx the two instances of `int` are from 2to3
 116         if not (result is None or type(result) in [
 117                 bool, float, int, str, int]):
 118             self._objects[newuuid] = result
 119             result = newuuid
 120
 121         ### DEBUG
 122         self.logger.debug("RET INVOKE %s%s = %s -> %s(%s, %s) " % (
 123             "(uuid %s) " % str(newuuid) if newuuid else "", str(result), uuid,
 124             operation, str(args), str(kwargs)))
 125         ########
 126
 127         return result
 128
 129     def set(self, uuid, name, value):
 130         ### DEBUG
 131         self.logger.debug("SET %s %s %s" % (uuid, name, str(value)))
 132
 133         self.debuger.dump_set(uuid, name, value)
 134         ########
 135
 136         obj = self.get_object(uuid)
 137         setattr(obj, name, value)
 138
 139         ### DEBUG
 140         self.logger.debug("RET SET %s = %s -> set(%s, %s)" % (str(value), uuid, name,
 141             str(value)))
 142         ########
 143
 144         return value
 145
 146     def get(self, uuid, name):
 147         ### DEBUG
 148         self.logger.debug("GET %s %s" % (uuid, name))
 149
 150         self.debuger.dump_get(uuid, name)
 151         ########
 152
 153         obj = self.get_object(uuid)
 154         result = getattr(obj, name)
 155
 156         ### DEBUG
 157         self.logger.debug("RET GET %s = %s -> get(%s)" % (str(result), uuid, name))
 158         ########
 159
 160         return result
 161
 162     def shutdown(self):
 163         ### DEBUG
 164         self.debuger.dump_shutdown()
 165         ########
 166
 167         ### FLUSH PIPES
 168         sys.stdout.flush()
 169         sys.stderr.flush()
 170
 171         ### RELEASE OBJECTS
 172         del self._objects
 173
 174         ### DEBUG
 175         self.logger.debug("SHUTDOWN")
 176         ########
 177
 178     def replace_args(self, args):
 179         realargs = [self.get_object(arg) if \
 180                 str(arg).startswith("uuid") else arg for arg in args]
 181
 182         return realargs
 183
 184     def replace_kwargs(self, kwargs):
 185         realkwargs = dict([(k, self.get_object(v) \
 186                 if str(v).startswith("uuid") else v) \
 187                 for k,v in kwargs.items()])
 188
 189         return realkwargs
 190