src/nepi/resources/linux/application.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 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, ResourceState, \
  23     reschedule_delay
  24 from nepi.resources.linux.node import LinuxNode
  25 from nepi.util.sshfuncs import ProcStatus
  26 from nepi.util.timefuncs import tnow, tdiffsec
  27
  28 import os
  29 import subprocess
  30
  31 # TODO: Resolve wildcards in commands!!
  32
  33 @clsinit
  34 class LinuxApplication(ResourceManager):
  35     """
  36     .. class:: Class Args :
  37
  38         :param ec: The Experiment controller
  39         :type ec: ExperimentController
  40         :param guid: guid of the RM
  41         :type guid: int
  42
  43     .. note::
  44
  45     A LinuxApplication RM represents a process that can be executed in
  46     a remote Linux host using SSH.
  47
  48     The LinuxApplication RM takes care of uploadin sources and any files
  49     needed to run the experiment, to the remote host.
  50     It also allows to provide source compilation (build) and installation
  51     instructions, and takes care of automating the sources build and
  52     installation tasks for the user.
  53
  54     It is important to note that files uploaded to the remote host have
  55     two possible scopes: single-experiment or multi-experiment.
  56     Single experiment files are those that will not be re-used by other
  57     experiments. Multi-experiment files are those that will.
  58     Sources and shared files are always made available to all experiments.
  59
  60     Directory structure:
  61
  62     The directory structure used by LinuxApplication RM at the Linux
  63     host is the following:
  64
  65         ${HOME}/nepi-usr --> Base directory for multi-experiment files
  66                       |
  67         ${LIB}        |- /lib --> Base directory for libraries
  68         ${BIN}        |- /bin --> Base directory for binary files
  69         ${SRC}        |- /src --> Base directory for sources
  70         ${SHARE}      |- /share --> Base directory for other files
  71
  72         ${HOME}/nepi-exp --> Base directory for single-experiment files
  73                       |
  74         ${EXP_HOME}   |- /<exp-id>  --> Base directory for experiment exp-id
  75                           |
  76         ${APP_HOME}       |- /<app-guid> --> Base directory for application
  77                                |     specific files (e.g. command.sh, input)
  78                                |
  79         ${RUN_HOME}            |- /<run-id> --> Base directory for run specific
  80
  81     """
  82
  83     _rtype = "LinuxApplication"
  84
  85     @classmethod
  86     def _register_attributes(cls):
  87         command = Attribute("command", "Command to execute at application start. "
  88                 "Note that commands will be executed in the ${RUN_HOME} directory, "
  89                 "make sure to take this into account when using relative paths. ",
  90                 flags = Flags.ExecReadOnly)
  91         forward_x11 = Attribute("forwardX11", "Enables X11 forwarding for SSH connections",
  92                 flags = Flags.ExecReadOnly)
  93         env = Attribute("env", "Environment variables string for command execution",
  94                 flags = Flags.ExecReadOnly)
  95         sudo = Attribute("sudo", "Run with root privileges",
  96                 flags = Flags.ExecReadOnly)
  97         depends = Attribute("depends",
  98                 "Space-separated list of packages required to run the application",
  99                 flags = Flags.ExecReadOnly)
 100         sources = Attribute("sources",
 101                 "Space-separated list of regular files to be uploaded to ${SRC} "
 102                 "directory prior to building. Archives won't be expanded automatically. "
 103                 "Sources are globally available for all experiments unless "
 104                 "cleanHome is set to True (This will delete all sources). ",
 105                 flags = Flags.ExecReadOnly)
 106         files = Attribute("files",
 107                 "Space-separated list of regular miscellaneous files to be uploaded "
 108                 "to ${SHARE} directory. "
 109                 "Files are globally available for all experiments unless "
 110                 "cleanHome is set to True (This will delete all files). ",
 111                 flags = Flags.ExecReadOnly)
 112         libs = Attribute("libs",
 113                 "Space-separated list of libraries (e.g. .so files) to be uploaded "
 114                 "to ${LIB} directory. "
 115                 "Libraries are globally available for all experiments unless "
 116                 "cleanHome is set to True (This will delete all files). ",
 117                 flags = Flags.ExecReadOnly)
 118         bins = Attribute("bins",
 119                 "Space-separated list of binary files to be uploaded "
 120                 "to ${BIN} directory. "
 121                 "Binaries are globally available for all experiments unless "
 122                 "cleanHome is set to True (This will delete all files). ",
 123                 flags = Flags.ExecReadOnly)
 124         code = Attribute("code",
 125                 "Plain text source code to be uploaded to the ${APP_HOME} directory. ",
 126                 flags = Flags.ExecReadOnly)
 127         build = Attribute("build",
 128                 "Build commands to execute after deploying the sources. "
 129                 "Sources are uploaded to the ${SRC} directory and code "
 130                 "is uploaded to the ${APP_HOME} directory. \n"
 131                 "Usage example: tar xzf ${SRC}/my-app.tgz && cd my-app && "
 132                 "./configure && make && make clean.\n"
 133                 "Make sure to make the build commands return with a nonzero exit "
 134                 "code on error.",
 135                 flags = Flags.ReadOnly)
 136         install = Attribute("install",
 137                 "Commands to transfer built files to their final destinations. "
 138                 "Install commands are executed after build commands. ",
 139                 flags = Flags.ReadOnly)
 140         stdin = Attribute("stdin", "Standard input for the 'command'",
 141                 flags = Flags.ExecReadOnly)
 142         tear_down = Attribute("tearDown", "Command to be executed just before "
 143                 "releasing the resource",
 144                 flags = Flags.ReadOnly)
 145
 146         cls._register_attribute(command)
 147         cls._register_attribute(forward_x11)
 148         cls._register_attribute(env)
 149         cls._register_attribute(sudo)
 150         cls._register_attribute(depends)
 151         cls._register_attribute(sources)
 152         cls._register_attribute(code)
 153         cls._register_attribute(files)
 154         cls._register_attribute(bins)
 155         cls._register_attribute(libs)
 156         cls._register_attribute(build)
 157         cls._register_attribute(install)
 158         cls._register_attribute(stdin)
 159         cls._register_attribute(tear_down)
 160
 161     @classmethod
 162     def _register_traces(cls):
 163         stdout = Trace("stdout", "Standard output stream")
 164         stderr = Trace("stderr", "Standard error stream")
 165
 166         cls._register_trace(stdout)
 167         cls._register_trace(stderr)
 168
 169     def __init__(self, ec, guid):
 170         super(LinuxApplication, self).__init__(ec, guid)
 171         self._pid = None
 172         self._ppid = None
 173         self._home = "app-%s" % self.guid
 174         self._in_foreground = False
 175
 176         # keep a reference to the running process handler when
 177         # the command is not executed as remote daemon in background
 178         self._proc = None
 179
 180         # timestamp of last state check of the application
 181         self._last_state_check = tnow()
 182
 183     def log_message(self, msg):
 184         return " guid %d - host %s - %s " % (self.guid,
 185                 self.node.get("hostname"), msg)
 186
 187     @property
 188     def node(self):
 189         node = self.get_connected(LinuxNode.rtype())
 190         if node: return node[0]
 191         return None
 192
 193     @property
 194     def app_home(self):
 195         return os.path.join(self.node.exp_home, self._home)
 196
 197     @property
 198     def run_home(self):
 199         return os.path.join(self.app_home, self.ec.run_id)
 200
 201     @property
 202     def pid(self):
 203         return self._pid
 204
 205     @property
 206     def ppid(self):
 207         return self._ppid
 208
 209     @property
 210     def in_foreground(self):
 211         """ Returns True if the command needs to be executed in foreground.
 212         This means that command will be executed using 'execute' instead of
 213         'run' ('run' executes a command in background and detached from the
 214         terminal)
 215
 216         When using X11 forwarding option, the command can not run in background
 217         and detached from a terminal, since we need to keep the terminal attached
 218         to interact with it.
 219         """
 220         return self.get("forwardX11") or self._in_foreground
 221
 222     def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0):
 223         self.info("Retrieving '%s' trace %s " % (name, attr))
 224
 225         path = os.path.join(self.run_home, name)
 226
 227         command = "(test -f %s && echo 'success') || echo 'error'" % path
 228         (out, err), proc = self.node.execute(command)
 229
 230         if (err and proc.poll()) or out.find("error") != -1:
 231             msg = " Couldn't find trace %s " % name
 232             self.error(msg, out, err)
 233             return None
 234
 235         if attr == TraceAttr.PATH:
 236             return path
 237
 238         if attr == TraceAttr.ALL:
 239             (out, err), proc = self.node.check_output(self.run_home, name)
 240
 241             if err and proc.poll():
 242                 msg = " Couldn't read trace %s " % name
 243                 self.error(msg, out, err)
 244                 return None
 245
 246             return out
 247
 248         if attr == TraceAttr.STREAM:
 249             cmd = "dd if=%s bs=%d count=1 skip=%d" % (path, block, offset)
 250         elif attr == TraceAttr.SIZE:
 251             cmd = "stat -c%%s %s " % path
 252
 253         (out, err), proc = self.node.execute(cmd)
 254
 255         if err and proc.poll():
 256             msg = " Couldn't find trace %s " % name
 257             self.error(msg, out, err)
 258             return None
 259
 260         if attr == TraceAttr.SIZE:
 261             out = int(out.strip())
 262
 263         return out
 264
 265     def provision(self):
 266         # create run dir for application
 267         self.node.mkdir(self.run_home)
 268
 269         # List of all the provision methods to invoke
 270         steps = [
 271             # upload sources
 272             self.upload_sources,
 273             # upload files
 274             self.upload_files,
 275             # upload binaries
 276             self.upload_binaries,
 277             # upload libraries
 278             self.upload_libraries,
 279             # upload code
 280             self.upload_code,
 281             # upload stdin
 282             self.upload_stdin,
 283             # install dependencies
 284             self.install_dependencies,
 285             # build
 286             self.build,
 287             # Install
 288             self.install]
 289
 290         command = []
 291
 292         # Since provisioning takes a long time, before
 293         # each step we check that the EC is still
 294         for step in steps:
 295             if self.ec.finished:
 296                 raise RuntimeError, "EC finished"
 297
 298             ret = step()
 299             if ret:
 300                 command.append(ret)
 301
 302         # upload deploy script
 303         deploy_command = ";".join(command)
 304         self.execute_deploy_command(deploy_command)
 305
 306         # upload start script
 307         self.upload_start_command()
 308
 309         self.info("Provisioning finished")
 310
 311         super(LinuxApplication, self).provision()
 312
 313     def upload_start_command(self):
 314         # Upload command to remote bash script
 315         # - only if command can be executed in background and detached
 316         command = self.get("command")
 317
 318         if command and not self.in_foreground:
 319             self.info("Uploading command '%s'" % command)
 320
 321             # replace application specific paths in the command
 322             command = self.replace_paths(command)
 323
 324             # replace application specific paths in the environment
 325             env = self.get("env")
 326             env = env and self.replace_paths(env)
 327
 328             shfile = os.path.join(self.app_home, "start.sh")
 329
 330             self.node.upload_command(command,
 331                     shfile = shfile,
 332                     env = env)
 333
 334     def execute_deploy_command(self, command):
 335         if command:
 336             # Upload the command to a bash script and run it
 337             # in background ( but wait until the command has
 338             # finished to continue )
 339             shfile = os.path.join(self.app_home, "deploy.sh")
 340             self.node.run_and_wait(command, self.run_home,
 341                     shfile = shfile,
 342                     overwrite = False,
 343                     pidfile = "deploy_pidfile",
 344                     ecodefile = "deploy_exitcode",
 345                     stdout = "deploy_stdout",
 346                     stderr = "deploy_stderr")
 347
 348     def upload_sources(self):
 349         sources = self.get("sources")
 350
 351         command = ""
 352
 353         if sources:
 354             self.info("Uploading sources ")
 355
 356             sources = sources.split(' ')
 357
 358             # Separate sources that should be downloaded from
 359             # the web, from sources that should be uploaded from
 360             # the local machine
 361             command = []
 362             for source in list(sources):
 363                 if source.startswith("http") or source.startswith("https"):
 364                     # remove the hhtp source from the sources list
 365                     sources.remove(source)
 366
 367                     command.append( " ( "
 368                             # Check if the source already exists
 369                             " ls ${SRC}/%(basename)s "
 370                             " || ( "
 371                             # If source doesn't exist, download it and check
 372                             # that it it downloaded ok
 373                             "   wget -c --directory-prefix=${SRC} %(source)s && "
 374                             "   ls ${SRC}/%(basename)s "
 375                             " ) ) " % {
 376                                 "basename": os.path.basename(source),
 377                                 "source": source
 378                                 })
 379
 380             command = " && ".join(command)
 381
 382             # replace application specific paths in the command
 383             command = self.replace_paths(command)
 384
 385             if sources:
 386                 sources = ' '.join(sources)
 387                 self.node.upload(sources, self.node.src_dir, overwrite = False)
 388
 389         return command
 390
 391     def upload_files(self):
 392         files = self.get("files")
 393
 394         if files:
 395             self.info("Uploading files %s " % files)
 396             self.node.upload(files, self.node.share_dir, overwrite = False)
 397
 398     def upload_libraries(self):
 399         libs = self.get("libs")
 400
 401         if libs:
 402             self.info("Uploading libraries %s " % libaries)
 403             self.node.upload(libs, self.node.lib_dir, overwrite = False)
 404
 405     def upload_binaries(self):
 406         bins = self.get("bins")
 407
 408         if bins:
 409             self.info("Uploading binaries %s " % binaries)
 410             self.node.upload(bins, self.node.bin_dir, overwrite = False)
 411
 412     def upload_code(self):
 413         code = self.get("code")
 414
 415         if code:
 416             self.info("Uploading code")
 417
 418             dst = os.path.join(self.app_home, "code")
 419             self.node.upload(code, dst, overwrite = False, text = True)
 420
 421     def upload_stdin(self):
 422         stdin = self.get("stdin")
 423         if stdin:
 424             # create dir for sources
 425             self.info("Uploading stdin")
 426
 427             # upload stdin file to ${SHARE_DIR} directory
 428             basename = os.path.basename(stdin)
 429             dst = os.path.join(self.node.share_dir, basename)
 430             self.node.upload(stdin, dst, overwrite = False, text = True)
 431
 432             # create "stdin" symlink on ${APP_HOME} directory
 433             command = "( cd %s ; ln -s %s stdin )" % ( self.app_home, dst)
 434
 435             return command
 436
 437     def install_dependencies(self):
 438         depends = self.get("depends")
 439         if depends:
 440             self.info("Installing dependencies %s" % depends)
 441             self.node.install_packages(depends, self.app_home, self.run_home)
 442
 443     def build(self):
 444         build = self.get("build")
 445
 446         if build:
 447             self.info("Building sources ")
 448
 449             # replace application specific paths in the command
 450             return self.replace_paths(build)
 451
 452     def install(self):
 453         install = self.get("install")
 454
 455         if install:
 456             self.info("Installing sources ")
 457
 458             # replace application specific paths in the command
 459             return self.replace_paths(install)
 460
 461     def deploy(self):
 462         # Wait until node is associated and deployed
 463         node = self.node
 464         if not node or node.state < ResourceState.READY:
 465             self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
 466             self.ec.schedule(reschedule_delay, self.deploy)
 467         else:
 468             try:
 469                 command = self.get("command") or ""
 470                 self.info("Deploying command '%s' " % command)
 471                 self.discover()
 472                 self.provision()
 473             except:
 474                 self.fail()
 475                 raise
 476
 477             super(LinuxApplication, self).deploy()
 478
 479     def start(self):
 480         command = self.get("command")
 481
 482         self.info("Starting command '%s'" % command)
 483
 484         if not command:
 485             # If no command was given (i.e. Application was used for dependency
 486             # installation), then the application is directly marked as FINISHED
 487             self._state = ResourceState.FINISHED
 488         else:
 489
 490             if self.in_foreground:
 491                 self._start_in_foreground()
 492             else:
 493                 self._start_in_background()
 494
 495             super(LinuxApplication, self).start()
 496
 497     def _start_in_foreground(self):
 498         command = self.get("command")
 499         sudo = self.get("sudo") or False
 500         x11 = self.get("forwardX11")
 501
 502         # For a command being executed in foreground, if there is stdin,
 503         # it is expected to be text string not a file or pipe
 504         stdin = self.get("stdin") or None
 505
 506         # Command will be launched in foreground and attached to the
 507         # terminal using the node 'execute' in non blocking mode.
 508
 509         # Export environment
 510         env = self.get("env")
 511         environ = self.node.format_environment(env, inline = True)
 512         command = environ + command
 513         command = self.replace_paths(command)
 514
 515         # We save the reference to the process in self._proc
 516         # to be able to kill the process from the stop method.
 517         # We also set blocking = False, since we don't want the
 518         # thread to block until the execution finishes.
 519         (out, err), self._proc = self.node.execute(command,
 520                 sudo = sudo,
 521                 stdin = stdin,
 522                 forward_x11 = x11,
 523                 blocking = False)
 524
 525         if self._proc.poll():
 526             self.fail()
 527             self.error(msg, out, err)
 528             raise RuntimeError, msg
 529
 530     def _start_in_background(self):
 531         command = self.get("command")
 532         env = self.get("env")
 533         sudo = self.get("sudo") or False
 534
 535         stdout = "stdout"
 536         stderr = "stderr"
 537         stdin = os.path.join(self.app_home, "stdin") if self.get("stdin") \
 538                 else None
 539
 540         # Command will be run as a daemon in baground and detached from any
 541         # terminal.
 542         # The command to run was previously uploaded to a bash script
 543         # during deployment, now we launch the remote script using 'run'
 544         # method from the node.
 545         cmd = "bash %s" % os.path.join(self.app_home, "start.sh")
 546         (out, err), proc = self.node.run(cmd, self.run_home,
 547             stdin = stdin,
 548             stdout = stdout,
 549             stderr = stderr,
 550             sudo = sudo)
 551
 552         # check if execution errors occurred
 553         msg = " Failed to start command '%s' " % command
 554
 555         if proc.poll():
 556             self.fail()
 557             self.error(msg, out, err)
 558             raise RuntimeError, msg
 559
 560         # Wait for pid file to be generated
 561         pid, ppid = self.node.wait_pid(self.run_home)
 562         if pid: self._pid = int(pid)
 563         if ppid: self._ppid = int(ppid)
 564
 565         # If the process is not running, check for error information
 566         # on the remote machine
 567         if not self.pid or not self.ppid:
 568             (out, err), proc = self.node.check_errors(self.run_home,
 569                     stderr = stderr)
 570
 571             # Out is what was written in the stderr file
 572             if err:
 573                 self.fail()
 574                 msg = " Failed to start command '%s' " % command
 575                 self.error(msg, out, err)
 576                 raise RuntimeError, msg
 577
 578     def stop(self):
 579         """ Stops application execution
 580         """
 581         command = self.get('command') or ''
 582
 583         if self.state == ResourceState.STARTED:
 584             stopped = True
 585
 586             self.info("Stopping command '%s'" % command)
 587
 588             # If the command is running in foreground (it was launched using
 589             # the node 'execute' method), then we use the handler to the Popen
 590             # process to kill it. Else we send a kill signal using the pid and ppid
 591             # retrieved after running the command with the node 'run' method
 592
 593             if self._proc:
 594                 self._proc.kill()
 595             else:
 596                 # Only try to kill the process if the pid and ppid
 597                 # were retrieved
 598                 if self.pid and self.ppid:
 599                     (out, err), proc = self.node.kill(self.pid, self.ppid)
 600
 601                     if out or err:
 602                         # check if execution errors occurred
 603                         msg = " Failed to STOP command '%s' " % self.get("command")
 604                         self.error(msg, out, err)
 605                         self.fail()
 606                         stopped = False
 607
 608             if stopped:
 609                 super(LinuxApplication, self).stop()
 610
 611     def release(self):
 612         self.info("Releasing resource")
 613
 614         tear_down = self.get("tearDown")
 615         if tear_down:
 616             self.node.execute(tear_down)
 617
 618         self.stop()
 619
 620         if self.state == ResourceState.STOPPED:
 621             super(LinuxApplication, self).release()
 622
 623     @property
 624     def state(self):
 625         """ Returns the state of the application
 626         """
 627         if self._state == ResourceState.STARTED:
 628             if self.in_foreground:
 629                 # Check if the process we used to execute the command
 630                 # is still running ...
 631                 retcode = self._proc.poll()
 632
 633                 # retcode == None -> running
 634                 # retcode > 0 -> error
 635                 # retcode == 0 -> finished
 636                 if retcode:
 637                     out = ""
 638                     msg = " Failed to execute command '%s'" % self.get("command")
 639                     err = self._proc.stderr.read()
 640                     self.error(msg, out, err)
 641                     self.fail()
 642                 elif retcode == 0:
 643                     self._state = ResourceState.FINISHED
 644
 645             else:
 646                 # We need to query the status of the command we launched in
 647                 # background. In oredr to avoid overwhelming the remote host and
 648                 # the local processor with too many ssh queries, the state is only
 649                 # requested every 'state_check_delay' seconds.
 650                 state_check_delay = 0.5
 651                 if tdiffsec(tnow(), self._last_state_check) > state_check_delay:
 652                     # check if execution errors occurred
 653                     (out, err), proc = self.node.check_errors(self.run_home)
 654
 655                     if err:
 656                         msg = " Failed to execute command '%s'" % self.get("command")
 657                         self.error(msg, out, err)
 658                         self.fail()
 659
 660                     elif self.pid and self.ppid:
 661                         # No execution errors occurred. Make sure the background
 662                         # process with the recorded pid is still running.
 663                         status = self.node.status(self.pid, self.ppid)
 664
 665                         if status == ProcStatus.FINISHED:
 666                             self._state = ResourceState.FINISHED
 667
 668                     self._last_state_check = tnow()
 669
 670         return self._state
 671
 672     def replace_paths(self, command):
 673         """
 674         Replace all special path tags with shell-escaped actual paths.
 675         """
 676         return ( command
 677             .replace("${USR}", self.node.usr_dir)
 678             .replace("${LIB}", self.node.lib_dir)
 679             .replace("${BIN}", self.node.bin_dir)
 680             .replace("${SRC}", self.node.src_dir)
 681             .replace("${SHARE}", self.node.share_dir)
 682             .replace("${EXP}", self.node.exp_dir)
 683             .replace("${EXP_HOME}", self.node.exp_home)
 684             .replace("${APP_HOME}", self.app_home)
 685             .replace("${RUN_HOME}", self.run_home)
 686             .replace("${NODE_HOME}", self.node.node_home)
 687             .replace("${HOME}", self.node.home_dir)
 688             )
 689
 690     def valid_connection(self, guid):
 691         # TODO: Validate!
 692         return True
 693