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, ResourceFactory, 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 ## TODO: Clean up DCE part. All that is DCE specific should go
  36 ##       in the linux ns3dceapplication.py
  37
  38 @clsinit_copy
  39 class LinuxNS3Simulation(LinuxApplication, NS3Simulation):
  40     _rtype = "LinuxNS3Simulation"
  41
  42     @classmethod
  43     def _register_attributes(cls):
  44         impl_type = Attribute("simulatorImplementationType",
  45                 "The object class to use as the simulator implementation",
  46             allowed = ["ns3::DefaultSimulatorImpl", "ns3::RealtimeSimulatorImpl"],
  47             default = "ns3::DefaultSimulatorImpl",
  48             type = Types.Enumerate,
  49             flags = Flags.Design)
  50
  51         sched_type = Attribute("schedulerType",
  52                 "The object class to use as the scheduler implementation",
  53                 allowed = ["ns3::MapScheduler",
  54                             "ns3::ListScheduler",
  55                             "ns3::HeapScheduler",
  56                             "ns3::MapScheduler",
  57                             "ns3::CalendarScheduler"
  58                     ],
  59             default = "ns3::MapScheduler",
  60             type = Types.Enumerate,
  61             flags = Flags.Design)
  62
  63         check_sum = Attribute("checksumEnabled",
  64                 "A global switch to enable all checksums for all protocols",
  65             default = False,
  66             type = Types.Bool,
  67             flags = Flags.Design)
  68
  69         ns_log = Attribute("nsLog",
  70             "NS_LOG environment variable. " \
  71                     " Will only generate output if ns-3 is compiled in DEBUG mode. ",
  72             flags = Flags.Design)
  73
  74         verbose = Attribute("verbose",
  75             "True to output debugging info from the ns3 client-server communication",
  76             type = Types.Bool,
  77             flags = Flags.Design)
  78
  79         enable_dump = Attribute("enableDump",
  80             "Enable dumping the remote executed ns-3 commands to a script "
  81             "in order to later reproduce and debug the experiment",
  82             type = Types.Bool,
  83             default = False,
  84             flags = Flags.Design)
  85
  86         build_mode = Attribute("buildMode",
  87             "Mode used to build ns-3 with waf. One if: debug, release, oprimized ",
  88             default = "optimized",
  89             allowed = ["debug", "release", "optimized"],
  90             type = Types.Enumerate,
  91             flags = Flags.Design)
  92
  93         ns3_version = Attribute("ns3Version",
  94             "Version of ns-3 to install from nsam repo",
  95             #default = "ns-3.19",
  96             default = "ns-3.20",
  97             #default = "ns-3-dev",
  98             flags = Flags.Design)
  99
 100         pybindgen_version = Attribute("pybindgenVersion",
 101             "Version of pybindgen to install from bazar repo",
 102             #default = "864",
 103             default = "868",
 104             #default = "876",
 105             flags = Flags.Design)
 106
 107         dce_version = Attribute("dceVersion",
 108             "Version of dce to install from nsam repo (tag branch for repo)",
 109             default = "dce-1.3",
 110             #default = "dce-dev",
 111             flags = Flags.Design)
 112
 113         populate_routing_tables = Attribute("populateRoutingTables",
 114             "Invokes  Ipv4GlobalRoutingHelper.PopulateRoutingTables() ",
 115             default = False,
 116             type = Types.Bool,
 117             flags = Flags.Design)
 118
 119         stoptime = Attribute("stopTime",
 120             "Time at which the simulation will stop",
 121             flags = Flags.Design)
 122
 123         cls._register_attribute(impl_type)
 124         cls._register_attribute(sched_type)
 125         cls._register_attribute(check_sum)
 126         cls._register_attribute(ns_log)
 127         cls._register_attribute(enable_dump)
 128         cls._register_attribute(verbose)
 129         cls._register_attribute(build_mode)
 130         cls._register_attribute(ns3_version)
 131         cls._register_attribute(pybindgen_version)
 132         cls._register_attribute(dce_version)
 133         cls._register_attribute(populate_routing_tables)
 134         cls._register_attribute(stoptime)
 135
 136     def __init__(self, ec, guid):
 137         LinuxApplication.__init__(self, ec, guid)
 138         NS3Simulation.__init__(self)
 139
 140         self._client = None
 141         self._home = "ns3-simu-%s" % self.guid
 142         self._socket_name = "ns3-%s.sock" % os.urandom(4).encode('hex')
 143         self._dce_manager_helper_uuid = None
 144         self._dce_application_helper_uuid = None
 145         self._enable_dce = None
 146
 147     @property
 148     def socket_name(self):
 149         return self._socket_name
 150
 151     @property
 152     def remote_socket(self):
 153         return os.path.join(self.run_home, self.socket_name)
 154
 155     def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0):
 156         # stout needs to get flushed on the ns-3 server side, else we will
 157         # get an empty stream. We try twice to retrieve the stream
 158         # if we get empty stdout since the stream might not be
 159         # flushed immediately.
 160         if name.endswith("stdout"):
 161             self._client.flush()
 162             result = LinuxApplication.trace(self, name, attr, block, offset)
 163             if result:
 164                 return result
 165             # Let the stream be flushed
 166             time.sleep(1)
 167
 168         return LinuxApplication.trace(self, name, attr, block, offset)
 169
 170     def upload_sources(self):
 171         self.node.mkdir(os.path.join(self.node.src_dir, "ns3wrapper"))
 172
 173         # upload ns3 wrapper python script
 174         ns3_wrapper = os.path.join(os.path.dirname(__file__), "..", "..", "ns3",
 175                 "ns3wrapper.py")
 176
 177         self.node.upload(ns3_wrapper,
 178                 os.path.join(self.node.src_dir, "ns3wrapper", "ns3wrapper.py"),
 179                 overwrite = False)
 180
 181         # upload ns3 wrapper debug python script
 182         ns3_wrapper_debug = os.path.join(os.path.dirname(__file__), "..", "..", "ns3",
 183                 "ns3wrapper_debug.py")
 184
 185         self.node.upload(ns3_wrapper_debug,
 186                 os.path.join(self.node.src_dir, "ns3wrapper", "ns3wrapper_debug.py"),
 187                 overwrite = False)
 188
 189         # upload ns3_server python script
 190         ns3_server = os.path.join(os.path.dirname(__file__), "..", "..", "ns3",
 191                 "ns3server.py")
 192
 193         self.node.upload(ns3_server,
 194                 os.path.join(self.node.src_dir, "ns3wrapper", "ns3server.py"),
 195                 overwrite = False)
 196
 197         if self.node.use_rpm:
 198             # upload pygccxml sources
 199             pygccxml_tar = os.path.join(os.path.dirname(__file__), "dependencies",
 200                     "%s.tar.gz" % self.pygccxml_version)
 201
 202             self.node.upload(pygccxml_tar,
 203                     os.path.join(self.node.src_dir, "%s.tar.gz" % self.pygccxml_version),
 204                     overwrite = False)
 205
 206         # Upload user defined ns-3 sources
 207         self.node.mkdir(os.path.join(self.node.src_dir, "ns-3"))
 208         src_dir = os.path.join(self.node.src_dir, "ns-3")
 209
 210         super(LinuxNS3Simulation, self).upload_sources(src_dir = src_dir)
 211
 212     def upload_extra_sources(self, sources = None, src_dir = None):
 213         return super(LinuxNS3Simulation, self).upload_sources(
 214                 sources = sources,
 215                 src_dir = src_dir)
 216
 217     def upload_start_command(self):
 218         command = self.get("command")
 219         env = self.get("env")
 220
 221         # We want to make sure the ccnd is running
 222         # before the experiment starts.
 223         # Run the command as a bash script in background,
 224         # in the host ( but wait until the command has
 225         # finished to continue )
 226         env = self.replace_paths(env)
 227         command = self.replace_paths(command)
 228
 229         shfile = os.path.join(self.app_home, "start.sh")
 230         self.node.upload_command(command,
 231                     shfile = shfile,
 232                     env = env,
 233                     overwrite = True)
 234
 235         # Run the ns3wrapper
 236         self._run_in_background()
 237
 238         # Wait until the remote socket is created
 239         self.wait_remote_socket()
 240
 241     def configure(self):
 242         if self.has_changed("simulatorImplementationType"):
 243             simu_type = self.get("simulatorImplementationType")
 244             stype = self.create("StringValue", simu_type)
 245             self.invoke(GLOBAL_VALUE_UUID, "Bind", "SimulatorImplementationType", stype)
 246
 247         if self.has_changed("checksumEnabled"):
 248             check_sum = self.get("checksumEnabled")
 249             btrue = self.create("BooleanValue", check_sum)
 250             self.invoke(GLOBAL_VALUE_UUID, "Bind", "ChecksumEnabled", btrue)
 251
 252         if self.has_changed("schedulerType"):
 253             sched_type = self.get("schedulerType")
 254             stype = self.create("StringValue", sched_type)
 255             self.invoke(GLOBAL_VALUE_UUID, "Bind", "SchedulerType", btrue)
 256
 257     def do_deploy(self):
 258         if not self.node or self.node.state < ResourceState.READY:
 259             self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
 260
 261             # ccnd needs to wait until node is deployed and running
 262             self.ec.schedule(reschedule_delay, self.deploy)
 263         else:
 264             if not self.get("command"):
 265                 self.set("command", self._start_command)
 266
 267             if not self.get("depends"):
 268                 self.set("depends", self._dependencies)
 269
 270             if self.get("sources"):
 271                 sources = self.get("sources")
 272                 source = sources.split(" ")[0]
 273                 basename = os.path.basename(source)
 274                 version = ( basename.strip().replace(".tar.gz", "")
 275                     .replace(".tar","")
 276                     .replace(".gz","")
 277                     .replace(".zip","") )
 278
 279                 self.set("ns3Version", version)
 280                 self.set("sources", source)
 281
 282             if not self.get("build"):
 283                 self.set("build", self._build)
 284
 285             if not self.get("install"):
 286                 self.set("install", self._install)
 287
 288             if not self.get("env"):
 289                 self.set("env", self._environment)
 290
 291             self.do_discover()
 292             self.do_provision()
 293
 294             # Create client
 295             self._client = LinuxNS3Client(self)
 296
 297             self.configure()
 298
 299             self.set_ready()
 300
 301     def do_start(self):
 302         """ Starts simulation execution
 303
 304         """
 305         self.info("Starting")
 306
 307         if self.state == ResourceState.READY:
 308             if self.get("populateRoutingTables") == True:
 309                 self.invoke(IPV4_GLOBAL_ROUTING_HELPER_UUID, "PopulateRoutingTables")
 310
 311             self._client.start()
 312
 313             self.set_started()
 314         else:
 315             msg = " Failed to execute command '%s'" % command
 316             self.error(msg, out, err)
 317             raise RuntimeError, msg
 318
 319     def do_stop(self):
 320         """ Stops simulation execution
 321
 322         """
 323         if self.state == ResourceState.STARTED:
 324             time = None
 325             if self.get("stopTime"):
 326                 time = self.get("stopTime")
 327
 328             self._client.stop(time=time)
 329             self.set_stopped()
 330
 331     def do_release(self):
 332         self.info("Releasing resource")
 333
 334         tear_down = self.get("tearDown")
 335         if tear_down:
 336             self.node.execute(tear_down)
 337
 338         self.do_stop()
 339         self._client.shutdown()
 340         LinuxApplication.do_stop(self)
 341
 342         super(LinuxApplication, self).do_release()
 343
 344     @property
 345     def enable_dce(self):
 346         if self._enable_dce is None:
 347             from nepi.resources.ns3.ns3dceapplication import NS3BaseDceApplication
 348             rclass = ResourceFactory.get_resource_type(
 349                     NS3BaseDceApplication.get_rtype())
 350
 351             self._enable_dce = False
 352             for guid in self.ec.resources:
 353                 rm = self.ec.get_resource(guid)
 354                 if isinstance(rm, rclass):
 355                     self._enable_dce = True
 356                     break
 357
 358         return self._enable_dce
 359
 360     @property
 361     def _start_command(self):
 362         command = []
 363
 364         command.append("PYTHONPATH=$PYTHONPATH:${SRC}/ns3wrapper/")
 365
 366         command.append("python ${SRC}/ns3wrapper/ns3server.py -S %s" % \
 367                 os.path.basename(self.remote_socket) )
 368
 369         ns_log = self.get("nsLog")
 370         if ns_log:
 371             command.append("-L '%s'" % ns_log)
 372
 373         if self.get("enableDump"):
 374             command.append("-D")
 375
 376         if self.get("verbose"):
 377             command.append("-v")
 378
 379         command = " ".join(command)
 380         return command
 381
 382     @property
 383     def _dependencies(self):
 384         if self.node.use_rpm:
 385             return ( " gcc gcc-c++ python python-devel mercurial bzr tcpdump socat gccxml unzip")
 386         elif self.node.use_deb:
 387             return ( " gcc g++ python python-dev mercurial bzr tcpdump socat gccxml python-pygccxml unzip")
 388         return ""
 389
 390     @property
 391     def ns3_repo(self):
 392         return "http://code.nsnam.org"
 393
 394     @property
 395     def pygccxml_version(self):
 396         return "pygccxml-1.0.0"
 397
 398     @property
 399     def dce_repo(self):
 400         return "http://code.nsnam.org/ns-3-dce"
 401         #eturn "http://code.nsnam.org/epmancini/ns-3-dce"
 402
 403     @property
 404     def dce_version(self):
 405         dce_version = self.get("dceVersion")
 406         return dce_version or "dce-dev"
 407
 408     @property
 409     def ns3_build_location(self):
 410         location = "${BIN}/ns-3/%(ns3_version)s%(dce_version)s/%(build_mode)s/build" \
 411                     % {
 412                         "ns3_version": self.get("ns3Version"),
 413                         "dce_version": "-%s" % self.get("dceVersion") \
 414                                 if self.enable_dce else "",
 415                         "build_mode": self.get("buildMode"),
 416                       }
 417
 418         return location
 419
 420
 421     @property
 422     def ns3_src_location(self):
 423         location = "${SRC}/ns-3/%(ns3_version)s" \
 424                     % {
 425                         "ns3_version": self.get("ns3Version"),
 426                       }
 427
 428         return location
 429
 430     @property
 431     def dce_src_location(self):
 432         location = "${SRC}/ns-3-dce/%(dce_version)s" \
 433                    % {
 434                         "dce_version": self.get("dceVersion"),
 435                      }
 436
 437         return location
 438
 439     @property
 440     def _clone_ns3_command(self):
 441         source = self.get("sources")
 442
 443         if not source:
 444             clone_ns3_cmd = "hg clone %(ns3_repo)s/%(ns3_version)s %(ns3_src)s" \
 445                     % {
 446                         "ns3_version": self.get("ns3Version"),
 447                         "ns3_repo": self.ns3_repo,
 448                         "ns3_src": self.ns3_src_location,
 449                       }
 450         else:
 451             if source.find(".tar.gz") > -1:
 452                 clone_ns3_cmd = (
 453                             "tar xzf ${SRC}/ns-3/%(basename)s "
 454                             " --strip-components=1 -C %(ns3_src)s"
 455                             ) % {
 456                                 "basename": os.path.basename(source),
 457                                 "ns3_src": self.ns3_src_location,
 458                                 }
 459             elif source.find(".tar") > -1:
 460                 clone_ns3_cmd = (
 461                             "tar xf ${SRC}/ns-3/%(basename)s "
 462                             " --strip-components=1 -C %(ns3_src)s"
 463                             ) % {
 464                                 "basename": os.path.basename(source),
 465                                 "ns3_src": self.ns3_src_location,
 466                                 }
 467             elif source.find(".zip") > -1:
 468                 basename = os.path.basename(source)
 469                 bare_basename = basename.replace(".zip", "")
 470
 471                 clone_ns3_cmd = (
 472                             "unzip ${SRC}/ns-3/%(basename)s && "
 473                             "mv ${SRC}/ns-3/%(bare_basename)s %(ns3_src)s"
 474                             ) % {
 475                                 "bare_basename": basename_name,
 476                                 "basename": basename,
 477                                 "ns3_src": self.ns3_src_location,
 478                                 }
 479
 480         return clone_ns3_cmd
 481
 482     @property
 483     def _clone_dce_command(self):
 484         clone_dce_cmd = " echo 'DCE will not be built' "
 485
 486         if self.enable_dce:
 487             dce_version = self.dce_version
 488             dce_tag = ""
 489             if dce_version != "dce-dev":
 490                 dce_tag = "-r %s" % dce_version
 491
 492             clone_dce_cmd = (
 493                         # DCE installation
 494                         # Test if dce is alredy cloned
 495                         " ( "
 496                         "  ( "
 497                         "    ( test -d %(dce_src)s ) "
 498                         "   && echo 'dce binaries found, nothing to do'"
 499                         "  ) "
 500                         " ) "
 501                         "  || "
 502                         # Get dce source code
 503                         " ( "
 504                         "   mkdir -p %(dce_src)s && "
 505                         "   hg clone %(dce_repo)s %(dce_tag)s %(dce_src)s"
 506                         " ) "
 507                      ) % {
 508                             "dce_repo": self.dce_repo,
 509                             "dce_tag": dce_tag,
 510                             "dce_src": self.dce_src_location,
 511                          }
 512
 513         return clone_dce_cmd
 514
 515     @property
 516     def _build(self):
 517         # If the user defined local sources for ns-3, we uncompress the sources
 518         # on the remote sources directory. Else we clone ns-3 from the official repo.
 519         clone_ns3_cmd = self._clone_ns3_command
 520         clone_dce_cmd = self._clone_dce_command
 521
 522         ns3_build_cmd = (
 523                 # NS3 installation
 524                 "( "
 525                 " ( "
 526                 # Test if ns-3 is alredy cloned
 527                 "  ((( test -d %(ns3_src)s ) || "
 528                 "    ( test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'})) "
 529                 "  && echo 'ns-3 binaries found, nothing to do' )"
 530                 " ) "
 531                 "  || "
 532                 # If not, install ns-3 and its dependencies
 533                 " (   "
 534                 # Install pygccxml
 535                 "   (   "
 536                 "     ( "
 537                 "       python -c 'import pygccxml' && "
 538                 "       echo 'pygccxml not found' "
 539                 "     ) "
 540                 "      || "
 541                 "     ( "
 542                 "       tar xf ${SRC}/%(pygccxml_version)s.tar.gz -C ${SRC} && "
 543                 "       cd ${SRC}/%(pygccxml_version)s && "
 544                 "       python setup.py build && "
 545                 "       sudo -S python setup.py install "
 546                 "     ) "
 547                 "   ) "
 548                 # Install pybindgen
 549                 "  && "
 550                 "   (   "
 551                 "     ( "
 552                 "       test -d ${SRC}/pybindgen/%(pybindgen_version)s && "
 553                 "       echo 'binaries found, nothing to do' "
 554                 "     ) "
 555                 "      || "
 556                 # If not, clone and build
 557                 "      ( cd ${SRC} && "
 558                 "        mkdir -p ${SRC}/pybindgen && "
 559                 "        bzr checkout lp:pybindgen -r %(pybindgen_version)s ${SRC}/pybindgen/%(pybindgen_version)s && "
 560                 "        cd ${SRC}/pybindgen/%(pybindgen_version)s && "
 561                 "        ./waf configure && "
 562                 "        ./waf "
 563                 "      ) "
 564                 "   ) "
 565                 " && "
 566                 # Get ns-3 source code
 567                 "  ( "
 568                 "     mkdir -p %(ns3_src)s && "
 569                 "     %(clone_ns3_cmd)s "
 570                 "  ) "
 571                 " ) "
 572                 ") "
 573                 " && "
 574                 "( "
 575                 "   %(clone_dce_cmd)s "
 576                 ") "
 577              ) % {
 578                     "ns3_src": self.ns3_src_location,
 579                     "pybindgen_version": self.get("pybindgenVersion"),
 580                     "pygccxml_version": self.pygccxml_version,
 581                     "clone_ns3_cmd": clone_ns3_cmd,
 582                     "clone_dce_cmd": clone_dce_cmd,
 583                  }
 584
 585         return ns3_build_cmd
 586
 587     @property
 588     def _install_dce_command(self):
 589         install_dce_cmd = " echo 'DCE will not be installed'"
 590
 591         if self.enable_dce:
 592             install_dce_cmd = (
 593                         " ( "
 594                         "   ((test -d %(ns3_build)s/bin_dce ) && "
 595                         "    echo 'dce binaries found, nothing to do' )"
 596                         " ) "
 597                         " ||"
 598                         " (   "
 599                          # If not, copy build to dce
 600                         "  cd %(dce_src)s && "
 601                         "  rm -rf %(dce_src)s/build && "
 602                         "  ./waf configure %(enable_opt)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s "
 603                         "  --prefix=%(ns3_build)s --with-ns3=%(ns3_build)s && "
 604                         "  ./waf build && "
 605                         "  ./waf install && "
 606                         "  [ ! -e %(ns3_build)s/lib/python/site-packages/ns/dce.so ] && "
 607                         "   mv %(ns3_build)s/lib*/python*/site-packages/ns/dce.so %(ns3_build)s/lib/python/site-packages/ns/ "
 608                         " )"
 609                 ) % {
 610                     "pybindgen_version": self.get("pybindgenVersion"),
 611                     "enable_opt": "--enable-opt" if  self.get("buildMode") == "optimized" else "",
 612                     "ns3_build": self.ns3_build_location,
 613                     "dce_src": self.dce_src_location,
 614                      }
 615
 616         return install_dce_cmd
 617
 618     @property
 619     def _install(self):
 620         install_dce_cmd = self._install_dce_command
 621
 622         install_ns3_cmd = (
 623                  # Test if ns-3 is alredy installed
 624                 "("
 625                 " ( "
 626                 "  ( ( (test -d %(ns3_build)s/lib ) || "
 627                 "    (test -d ${NS3BINDINGS:='None'} && test -d ${NS3LIBRARIES:='None'}) ) && "
 628                 "    echo 'binaries found, nothing to do' )"
 629                 " ) "
 630                 " ||"
 631                 " (   "
 632                  # If not, copy ns-3 build to bin
 633                 "  mkdir -p %(ns3_build)s && "
 634                 "  cd %(ns3_src)s && "
 635                 "  rm -rf %(ns3_src)s/build && "
 636                 "  ./waf configure -d %(build_mode)s --with-pybindgen=${SRC}/pybindgen/%(pybindgen_version)s "
 637                 "  --prefix=%(ns3_build)s && "
 638                 "  ./waf build && "
 639                 "  ./waf install && "
 640                 "  mv %(ns3_build)s/lib*/python* %(ns3_build)s/lib/python "
 641                 " )"
 642                 ") "
 643                 " && "
 644                 "( "
 645                 "   %(install_dce_cmd)s "
 646                 ") "
 647               ) % {
 648                     "pybindgen_version": self.get("pybindgenVersion"),
 649                     "build_mode": self.get("buildMode"),
 650                     "install_dce_cmd": install_dce_cmd,
 651                     "ns3_build": self.ns3_build_location,
 652                     "ns3_src": self.ns3_src_location,
 653                  }
 654
 655         return install_ns3_cmd
 656
 657     @property
 658     def _environment(self):
 659         env = []
 660         env.append("PYTHONPATH=$PYTHONPATH:${NS3BINDINGS:=%(ns3_build)s/lib/python/site-packages}" % {
 661                     "ns3_build": self.ns3_build_location
 662                  })
 663         # If NS3LIBRARIES is defined and not empty, assign its value,
 664         # if not assign ns3_build_home/lib/ to NS3LIBRARIES and LD_LIBARY_PATH
 665         env.append("LD_LIBRARY_PATH=${NS3LIBRARIES:=%(ns3_build)s/lib}" % {
 666                     "ns3_build": self.ns3_build_location
 667                  })
 668         env.append("DCE_PATH=$NS3LIBRARIES/../bin_dce")
 669         env.append("DCE_ROOT=$NS3LIBRARIES/..")
 670
 671         return " ".join(env)
 672
 673     def replace_paths(self, command):
 674         """
 675         Replace all special path tags with shell-escaped actual paths.
 676         """
 677         return ( command
 678             .replace("${USR}", self.node.usr_dir)
 679             .replace("${LIB}", self.node.lib_dir)
 680             .replace("${BIN}", self.node.bin_dir)
 681             .replace("${SRC}", self.node.src_dir)
 682             .replace("${SHARE}", self.node.share_dir)
 683             .replace("${EXP}", self.node.exp_dir)
 684             .replace("${EXP_HOME}", self.node.exp_home)
 685             .replace("${APP_HOME}", self.app_home)
 686             .replace("${RUN_HOME}", self.run_home)
 687             .replace("${NODE_HOME}", self.node.node_home)
 688             .replace("${HOME}", self.node.home_dir)
 689             # If NS3LIBRARIES is defined and not empty, use that value,
 690             # if not use ns3_build_home/lib/
 691             .replace("${BIN_DCE}", "${NS3LIBRARIES-%s/lib}/../bin_dce" % \
 692                     self.ns3_build_location)
 693             )
 694
 695     def valid_connection(self, guid):
 696         # TODO: Validate!
 697         return True
 698
 699     def wait_remote_socket(self):
 700         """ Waits until the remote socket is created
 701         """
 702         command = " [ -e %s ] && echo 'DONE' " % self.remote_socket
 703
 704         for i in xrange(200):
 705             (out, err), proc = self.node.execute(command, retry = 1,
 706                     with_lock = True)
 707
 708             if out.find("DONE") > -1:
 709                 break
 710         else:
 711             raise RuntimeError("Remote socket not found at %s" % \
 712                     self.remote_socket)
 713
 714