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