src/nepi/resources/linux/ns3/ns3simulation.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 from nepi.execution.attribute import Attribute, Flags, Types
  21 from nepi.execution.trace import Trace, TraceAttr
  22 from nepi.execution.resource import ResourceManager, clsinit_copy, \
  23         ResourceState, reschedule_delay
  24 from nepi.resources.linux.application import LinuxApplication
  25 from nepi.util.timefuncs import tnow, tdiffsec
  26 from nepi.resources.ns3.ns3simulation import NS3Simulation
  27 from nepi.resources.ns3.ns3wrapper import SIMULATOR_UUID, GLOBAL_VALUE_UUID, \
  28         IPV4_GLOBAL_ROUTING_HELPER_UUID
  29 from nepi.resources.linux.ns3.ns3client import LinuxNS3Client
  30
  31 import os
  32 import time
  33 import threading
  34
  35 @clsinit_copy
  36 class LinuxNS3Simulation(LinuxApplication, NS3Simulation):
  37     _rtype = "LinuxNS3Simulation"
  38
  39     @classmethod
  40     def _register_attributes(cls):
  41         impl_type = Attribute("simulatorImplementationType",
  42                 "The object class to use as the simulator implementation",
  43             allowed = ["ns3::DefaultSimulatorImpl", "ns3::RealtimeSimulatorImpl"],
  44             default = "ns3::DefaultSimulatorImpl",
  45             type = Types.Enumerate,
  46             flags = Flags.Design)
  47
  48         sched_type = Attribute("schedulerType",
  49                 "The object class to use as the scheduler implementation",
  50                 allowed = ["ns3::MapScheduler",
  51                             "ns3::ListScheduler",
  52                             "ns3::HeapScheduler",
  53                             "ns3::MapScheduler",
  54                             "ns3::CalendarScheduler"
  55                     ],
  56             default = "ns3::MapScheduler",
  57             type = Types.Enumerate,
  58             flags = Flags.Design)
  59
  60         check_sum = Attribute("checksumEnabled",
  61                 "A global switch to enable all checksums for all protocols",
  62             default = False,
  63             type = Types.Bool,
  64             flags = Flags.Design)
  65
  66         ns_log = Attribute("nsLog",
  67             "NS_LOG environment variable. " \
  68                     " Will only generate output if ns-3 is compiled in DEBUG mode. ",
  69             flags = Flags.Design)
  70
  71         verbose = Attribute("verbose",
  72             "True to output debugging info from the ns3 client-server communication",
  73             type = Types.Bool,
  74             flags = Flags.Design)
  75
  76         build_mode = Attribute("buildMode",
  77             "Mode used to build ns-3 with waf. One if: debug, release, oprimized ",
  78             default = "optimized",
  79             allowed = ["debug", "release", "optimized"],
  80             type = Types.Enumerate,
  81             flags = Flags.Design)
  82
  83         ns3_version = Attribute("ns3Version",
  84             "Version of ns-3 to install from nsam repo",
  85             #default = "ns-3.19",
  86             default = "ns-3-dev",
  87             flags = Flags.Design)
  88
  89         enable_dce = Attribute("enableDCE",
  90             "Install DCE source code",
  91             default = False,
  92             type = Types.Bool,
  93             flags = Flags.Design)
  94
  95         pybindgen_version = Attribute("pybindgenVersion",
  96             "Version of pybindgen to install from bazar repo",
  97             default = "868",
  98             flags = Flags.Design)
  99
 100         populate_routing_tables = Attribute("populateRoutingTables",
 101             "Invokes  Ipv4GlobalRoutingHelper.PopulateRoutingTables() ",
 102             default = False,
 103             type = Types.Bool,
 104             flags = Flags.Design)
 105
 106         cls._register_attribute(impl_type)
 107         cls._register_attribute(sched_type)
 108         cls._register_attribute(check_sum)
 109         cls._register_attribute(ns_log)
 110         cls._register_attribute(verbose)
 111         cls._register_attribute(build_mode)
 112         cls._register_attribute(ns3_version)
 113         cls._register_attribute(pybindgen_version)
 114         cls._register_attribute(populate_routing_tables)
 115         cls._register_attribute(enable_dce)
 116
 117     def __init__(self, ec, guid):
 118         LinuxApplication.__init__(self, ec, guid)
 119         NS3Simulation.__init__(self)
 120
 121         self._client = None
 122         self._home = "ns3-simu-%s" % self.guid
 123         self._socket_name = "ns3-%s.sock" % os.urandom(4).encode('hex')
 124         self._dce_manager_helper_uuid = None
 125         self._dce_application_helper_uuid = None
 126
 127         # Lock used to synchronize usage of DceManagerHelper
 128         self.dce_manager_lock = threading.Lock()
 129         # Lock used to synchronize usage of DceApplicationHelper
 130         self.dce_application_lock = threading.Lock()
 131
 132     @property
 133     def socket_name(self):
 134         return self._socket_name
 135
 136     @property
 137     def remote_socket(self):
 138         return os.path.join(self.run_home, self.socket_name)
 139
 140     @property
 141     def dce_manager_helper_uuid(self):
 142         return self._dce_manager_helper_uuid
 143
 144     @property
 145     def dce_application_helper_uuid(self):
 146         return self._dce_application_helper_uuid
 147
 148     @property
 149     def ns3_build_home(self):
 150         return os.path.join(self.node.bin_dir, "ns-3", self.get("ns3Version"),
 151                 self.get("buildMode"), "build")
 152
 153     def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0):
 154         self._client.flush()
 155         return LinuxApplication.trace(self, name, attr, block, offset)
 156
 157     def upload_sources(self):
 158         self.node.mkdir(os.path.join(self.node.src_dir, "ns3wrapper"))
 159
 160         # upload ns3 wrapper python script
 161         ns3_wrapper = os.path.join(os.path.dirname(__file__), "..", "..", "ns3",
 162                 "ns3wrapper.py")
 163
 164         self.node.upload(ns3_wrapper,
 165                 os.path.join(self.node.src_dir, "ns3wrapper", "ns3wrapper.py"),
 166                 overwrite = False)
 167
 168         # upload ns3_server python script
 169         ns3_server = os.path.join(os.path.dirname(__file__), "..", "..", "ns3",
 170                 "ns3server.py")
 171
 172         self.node.upload(ns3_server,
 173                 os.path.join(self.node.src_dir, "ns3wrapper", "ns3server.py"),
 174                 overwrite = False)
 175
 176         if self.node.use_rpm:
 177             # upload pygccxml sources
 178             pygccxml_tar = os.path.join(os.path.dirname(__file__), "dependencies",
 179                     "%s.tar.gz" % self.pygccxml_version)
 180
 181             self.node.upload(pygccxml_tar,
 182                     os.path.join(self.node.src_dir, "%s.tar.gz" % self.pygccxml_version),
 183                     overwrite = False)
 184
 185         # Upload user defined ns-3 sources
 186         self.node.mkdir(os.path.join(self.node.src_dir, "ns-3"))
 187         src_dir = os.path.join(self.node.src_dir, "ns-3")
 188
 189         super(LinuxNS3Simulation, self).upload_sources(src_dir = src_dir)
 190
 191     def upload_start_command(self):
 192         command = self.get("command")
 193         env = self.get("env")
 194
 195         # We want to make sure the ccnd is running
 196         # before the experiment starts.
 197         # Run the command as a bash script in background,
 198         # in the host ( but wait until the command has
 199         # finished to continue )
 200         env = self.replace_paths(env)
 201         command = self.replace_paths(command)
 202
 203         shfile = os.path.join(self.app_home, "start.sh")
 204         self.node.upload_command(command,
 205                     shfile = shfile,
 206                     env = env,
 207                     overwrite = True)
 208
 209         # Run the ns3wrapper
 210         self._run_in_background()
 211
 212     def configure(self):
 213         if self.has_changed("simulatorImplementationType"):
 214             simu_type = self.get("simulatorImplementationType")
 215             stype = self.create("StringValue", simu_type)
 216             self.invoke(GLOBAL_VALUE_UUID, "Bind", "SimulatorImplementationType", stype)
 217
 218         if self.has_changed("checksumEnabled"):
 219             check_sum = self.get("checksumEnabled")
 220             btrue = self.create("BooleanValue", check_sum)
 221             self.invoke(GLOBAL_VALUE_UUID, "Bind", "ChecksumEnabled", btrue)
 222
 223         if self.has_changed("schedulerType"):
 224             sched_type = self.get("schedulerType")
 225             stype = self.create("StringValue", sched_type)
 226             self.invoke(GLOBAL_VALUE_UUID, "Bind", "SchedulerType", btrue)
 227
 228         if self.get("enableDCE"):
 229             self._dce_manager_helper_uuid = self.create("DceManagerHelper")
 230             self._dce_application_helper_uuid = self.create("DceApplicationHelper")
 231
 232     def do_deploy(self):
 233         if not self.node or self.node.state < ResourceState.READY:
 234             self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
 235
 236             # ccnd needs to wait until node is deployed and running
 237             self.ec.schedule(reschedule_delay, self.deploy)
 238         else:
 239             if not self.get("command"):
 240                 self.set("command", self._start_command)
 241
 242             if not self.get("depends"):
 243                 self.set("depends", self._dependencies)
 244
 245             if self.get("sources"):
 246                 sources = self.get("sources")
 247                 source = sources.split(" ")[0]
 248                 basename = os.path.basename(source)
 249                 version = ( basename.strip().replace(".tar.gz", "")
 250                     .replace(".tar","")
 251                     .replace(".gz","")
 252                     .replace(".zip","") )
 253
 254                 self.set("ns3Version", version)
 255                 self.set("sources", source)
 256
 257             if not self.get("build"):
 258                 self.set("build", self._build)
 259
 260             if not self.get("install"):
 261                 self.set("install", self._install)
 262
 263             if not self.get("env"):
 264                 self.set("env", self._environment)
 265
 266             self.do_discover()
 267             self.do_provision()
 268
 269             # Create client
 270             self._client = LinuxNS3Client(self)
 271
 272             self.configure()
 273
 274             self.set_ready()
 275
 276     def do_start(self):
 277         """ Starts simulation execution
 278
 279         """
 280         self.info("Starting")
 281
 282         if self.state == ResourceState.READY:
 283             if self.get("populateRoutingTables") == True:
 284                 self.invoke(IPV4_GLOBAL_ROUTING_HELPER_UUID, "PopulateRoutingTables")
 285
 286             self._client.start()
 287
 288             self.set_started()
 289         else:
 290             msg = " Failed to execute command '%s'" % command
 291             self.error(msg, out, err)
 292             raise RuntimeError, msg
 293
 294     def do_stop(self):
 295         """ Stops simulation execution
 296
 297         """
 298         if self.state == ResourceState.STARTED:
 299             self._client.stop()
 300             self.set_stopped()
 301
 302     def do_release(self):
 303         self.info("Releasing resource")
 304
 305         tear_down = self.get("tearDown")
 306         if tear_down:
 307             self.node.execute(tear_down)
 308
 309         self.do_stop()
 310         self._client.shutdown()
 311         LinuxApplication.do_stop(self)
 312
 313         super(LinuxApplication, self).do_release()
 314
 315     @property
 316     def _start_command(self):
 317         command = []
 318
 319         command.append("PYTHONPATH=$PYTHONPATH:${SRC}/ns3wrapper/")
 320
 321         command.append("python ${SRC}/ns3wrapper/ns3server.py -S %s" % \
 322                 os.path.basename(self.remote_socket) )
 323
 324         ns_log = self.get("nsLog")
 325         if ns_log:
 326             command.append("-L '%s'" % ns_log)
 327
 328         if self.get("verbose"):
 329             command.append("-v")
 330
 331         command = " ".join(command)
 332         return command
 333
 334     @property
 335     def _dependencies(self):
 336         if self.node.use_rpm:
 337             return ( " gcc gcc-c++ python python-devel mercurial bzr tcpdump socat gccxml unzip")
 338         elif self.node.use_deb:
 339             return ( " gcc g++ python python-dev mercurial bzr tcpdump socat gccxml python-pygccxml unzip")
 340         return ""
 341
 342     @property
 343     def ns3_repo(self):
 344         return "http://code.nsnam.org"
 345
 346     @property
 347     def pygccxml_version(self):
 348         return "pygccxml-1.0.0"
 349
 350     @property
 351     def dce_repo(self):
 352         #return "http://code.nsnam.org/ns-3-dce"
 353         return "http://code.nsnam.org/epmancini/ns-3-dce"
 354
 355     @property
 356     def _build(self):
 357         # If the user defined local sources for ns-3, we uncompress the sources
 358         # on the remote sources directory. Else we clone ns-3 from the official repo.
 359         source = self.get("sources")
 360         if not source:
 361             clone_ns3_cmd = "hg clone %(ns3_repo)s/%(ns3_version)s ${SRC}/ns-3/%(ns3_version)s" \
 362                     % {
 363                         'ns3_version': self.get("ns3Version"),
 364                         'ns3_repo':  self.ns3_repo,
 365                       }
 366         else:
 367             if source.find(".tar.gz") > -1:
 368                 clone_ns3_cmd = (
 369                             "tar xzf ${SRC}/ns-3/%(basename)s "
 370                             " --strip-components=1 -C ${SRC}/ns-3/%(ns3_version)s "
 371                             ) % {
 372                                 'basename': os.path.basename(source),
 373                                 'ns3_version': self.get("ns3Version"),
 374                                 }
 375             elif source.find(".tar") > -1:
 376                 clone_ns3_cmd = (
 377                             "tar xf ${SRC}/ns-3/%(basename)s "
 378                             " --strip-components=1 -C ${SRC}/ns-3/%(ns3_version)s "
 379                             ) % {
 380                                 'basename': os.path.basename(source),
 381                                 'ns3_version': self.get("ns3Version"),
 382                                 }
 383             elif source.find(".zip") > -1:
 384                 basename = os.path.basename(source)
 385                 bare_basename = basename.replace(".zip", "") \
 386                         .replace(".tar", "") \
 387                         .replace(".tar.gz", "")
 388
 389                 clone_ns3_cmd = (
 390                             "unzip ${SRC}/ns-3/%(basename)s && "
 391                             "mv ${SRC}/ns-3/%(bare_basename)s ${SRC}/ns-3/%(ns3_version)s "
 392                             ) % {
 393                                 'bare_basename': basename_name,
 394                                 'basename': basename,
 395                                 'ns3_version': self.get("ns3Version"),
 396                                 }
 397
 398         clone_dce_cmd = " echo 'DCE will not be built' "
 399         if self.get("enableDCE"):
 400             clone_dce_cmd = (
 401                         # DCE installation
 402                         # Test if dce is alredy installed
 403                         " ( "
 404                         "  ( "
 405                         "    ( test -d ${SRC}/dce/ns-3-dce ) "
 406                         "   && echo 'dce binaries found, nothing to do'"
 407                         "  ) "
 408                         " ) "
 409                         "  || "
 410                         # Get dce source code
 411                         " ( "
 412                         "   mkdir -p ${SRC}/dce && "
 413                         "   hg clone %(dce_repo)s ${SRC}/dce/ns-3-dce"
 414                         " ) "
 415                      ) % {
 416                             'dce_repo': self.dce_repo
 417                          }
 418
 419
 420         return (
 421                 # NS3 installation
 422                 "( "
 423                 " ( "
 424                 # Test if ns-3 is alredy installed
 425                 "  ((( test -d ${SRC}/ns-3/%(ns3_version)s ) || "
 426                 "    ( test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'})) "
 427                 "  && echo 'ns-3 binaries found, nothing to do' )"
 428                 " ) "
 429                 "  || "
 430                 # If not, install ns-3 and its dependencies
 431                 " (   "
 432                 # Install pygccxml
 433                 "   (   "
 434                 "     ( "
 435                 "       python -c 'import pygccxml' && "
 436                 "       echo 'pygccxml not found' "
 437                 "     ) "
 438                 "      || "
 439                 "     ( "
 440                 "       tar xf ${SRC}/%(pygccxml_version)s.tar.gz -C ${SRC} && "
 441                 "       cd ${SRC}/%(pygccxml_version)s && "
 442                 "       python setup.py build && "
 443                 "       sudo -S python setup.py install "
 444                 "     ) "
 445                 "   ) "
 446                 # Install pybindgen
 447                 "  && "
 448                 "   (   "
 449                 "     ( "
 450                 "       test -d ${SRC}/pybindgen/%(pybindgen_version)s && "
 451                 "       echo 'binaries found, nothing to do' "
 452                 "     ) "
 453                 "      || "
 454                 # If not, clone and build
 455                 "      ( cd ${SRC} && "
 456                 "        mkdir -p ${SRC}/pybindgen && "
 457                 "        bzr checkout lp:pybindgen -r %(pybindgen_version)s ${SRC}/pybindgen/%(pybindgen_version)s && "
 458                 "        cd ${SRC}/pybindgen/%(pybindgen_version)s && "
 459                 "        ./waf configure && "
 460                 "        ./waf "
 461                 "      ) "
 462                 "   ) "
 463                 " && "
 464                 # Get ns-3 source code
 465                 "  ( "
 466                 "     mkdir -p ${SRC}/ns-3/%(ns3_version)s && "
 467                 "     %(clone_ns3_cmd)s "
 468                 "  ) "
 469                 " ) "
 470                 ") "
 471                 " && "
 472                 "( "
 473                 "   %(clone_dce_cmd)s "
 474                 ") "
 475              ) % {
 476                     'ns3_version': self.get("ns3Version"),
 477                     'pybindgen_version': self.get("pybindgenVersion"),
 478                     'pygccxml_version': self.pygccxml_version,
 479                     'clone_ns3_cmd': clone_ns3_cmd,
 480                     'clone_dce_cmd': clone_dce_cmd,
 481                  }
 482
 483     @property
 484     def _install(self):
 485         install_dce_cmd = " echo 'DCE will not be installed' "
 486         if self.get("enableDCE"):
 487             install_dce_cmd = (
 488                         " ( "
 489                         "   ((test -d %(ns3_build_home)s/bin_dce ) && "
 490                         "    echo 'dce binaries found, nothing to do' )"
 491                         " ) "
 492                         " ||"
 493                         " (   "
 494                          # If not, copy ns-3 build to bin
 495                         "  cd ${SRC}/dce/ns-3-dce && "
 496                         "  ./waf configure %(enable_opt)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s "
 497                         "  --prefix=%(ns3_build_home)s --with-ns3=%(ns3_build_home)s && "
 498                         "  ./waf build && "
 499                         "  ./waf install && "
 500                         "  mv %(ns3_build_home)s/lib*/python*/site-packages/ns/dce.so %(ns3_build_home)s/lib/python/site-packages/ns/ "
 501                         " )"
 502                 ) % {
 503                     'ns3_version': self.get("ns3Version"),
 504                     'pybindgen_version': self.get("pybindgenVersion"),
 505                     'ns3_build_home': self.ns3_build_home,
 506                     'build_mode': self.get("buildMode"),
 507                     'enable_opt': "--enable-opt" if  self.get("buildMode") == "optimized" else ""
 508                     }
 509
 510         return (
 511                  # Test if ns-3 is alredy installed
 512                 "("
 513                 " ( "
 514                 "  ( ( (test -d %(ns3_build_home)s/lib ) || "
 515                 "    (test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'}) ) && "
 516                 "    echo 'binaries found, nothing to do' )"
 517                 " ) "
 518                 " ||"
 519                 " (   "
 520                  # If not, copy ns-3 build to bin
 521                 "  mkdir -p %(ns3_build_home)s && "
 522                 "  cd ${SRC}/ns-3/%(ns3_version)s && "
 523                 "  ./waf configure -d %(build_mode)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s "
 524                 "  --prefix=%(ns3_build_home)s && "
 525                 "  ./waf build && "
 526                 "  ./waf install && "
 527                 "  mv %(ns3_build_home)s/lib*/python* %(ns3_build_home)s/lib/python "
 528                 " )"
 529                 ") "
 530                 " && "
 531                 "( "
 532                 "   %(install_dce_cmd)s "
 533                 ") "
 534               ) % {
 535                     'ns3_version': self.get("ns3Version"),
 536                     'pybindgen_version': self.get("pybindgenVersion"),
 537                     'build_mode': self.get("buildMode"),
 538                     'ns3_build_home': self.ns3_build_home,
 539                     'install_dce_cmd': install_dce_cmd
 540                  }
 541
 542     @property
 543     def _environment(self):
 544         env = []
 545         env.append("PYTHONPATH=$PYTHONPATH:${NS3BINDINGS:=%(ns3_build_home)s/lib/python/site-packages}" % {
 546                     'ns3_build_home': self.ns3_build_home
 547                  })
 548         env.append("LD_LIBRARY_PATH=${NS3LIBRARIES:=%(ns3_build_home)s/lib/}" % {
 549                     'ns3_build_home': self.ns3_build_home
 550                  })
 551         env.append("DCE_PATH=$PATH:$NS3LIBRARIES/../bin_dce")
 552         env.append("DCE_ROOT=$PATH:$NS3LIBRARIES/..")
 553
 554         return " ".join(env)
 555
 556     def valid_connection(self, guid):
 557         # TODO: Validate!
 558         return True
 559