util/dvsim/LocalLauncher.py

# Copyright lowRISC contributors.
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0

import datetime
import os
import shlex
import subprocess

from Launcher import ErrorMessage, Launcher, LauncherError


class LocalLauncher(Launcher):
    """
    Implementation of Launcher to launch jobs in the user's local workstation.
    """

    # Misc common LocalLauncher settings.
    max_odirs = 5

    def __init__(self, deploy):
        '''Initialize common class members.'''

        super().__init__(deploy)

        # Popen object when launching the job.
        self.process = None

    def _do_launch(self):
        # Update the shell's env vars with self.exports. Values in exports must
        # replace the values in the shell's env vars if the keys match.
        exports = os.environ.copy()
        if self.deploy.exports:
            exports.update(self.deploy.exports)

        # Clear the magic MAKEFLAGS variable from exports if necessary. This
        # variable is used by recursive Make calls to pass variables from one
        # level to the next. Here, self.cmd is a call to Make but it's
        # logically a top-level invocation: we don't want to pollute the flow's
        # Makefile with Make variables from any wrapper that called dvsim.
        if 'MAKEFLAGS' in exports:
            del exports['MAKEFLAGS']

        self._dump_env_vars(exports)

        if not self.deploy.sim_cfg.interactive:
            try:
                f = open(self.deploy.get_log_path(),
                         "w",
                         encoding="UTF-8",
                         errors="surrogateescape")
                f.write("[Executing]:\n{}\n\n".format(self.deploy.cmd))
                f.flush()
                timeout_mins = self.deploy.get_timeout_mins()
                if timeout_mins:
                    self.timeout_secs = timeout_mins * 60
                else:
                    self.timeout_secs = None
                self.process = subprocess.Popen(shlex.split(self.deploy.cmd),
                                                bufsize=4096,
                                                universal_newlines=True,
                                                stdout=f,
                                                stderr=f,
                                                env=exports)
            except subprocess.SubprocessError as e:
                raise LauncherError('IO Error: {}\nSee {}'.format(
                    e, self.deploy.get_log_path()))
            finally:
                self._close_process()
        else:
            # Interactive: Set RUN_INTERACTIVE to 1
            exports['RUN_INTERACTIVE'] = "1"

            # Interactive. stdin / stdout are transparent
            # no timeout and blocking op as user controls the flow
            print("Interactive mode is not supported yet.")
            print("Cmd : {}".format(self.deploy.cmd))
            self.process = subprocess.Popen(shlex.split(self.deploy.cmd),
                                            stdin=None,
                                            stdout=None,
                                            stderr=subprocess.STDOUT,
                                            # string mode
                                            universal_newlines=True,
                                            env=exports)

            # Wait until the process exit
            self.process.wait()

        self._link_odir("D")

    def poll(self):
        '''Check status of the running process

        This returns 'D', 'P', 'F', or 'K'. If 'D', the job is still running.
        If 'P', the job finished successfully. If 'F', the job finished with
        an error. If 'K' it was killed.

        This function must only be called after running self.dispatch_cmd() and
        must not be called again once it has returned 'P' or 'F'.
        '''

        assert self.process is not None
        elapsed_time = datetime.datetime.now() - self.start_time
        self.job_runtime_secs = elapsed_time.total_seconds()
        if self.process.poll() is None:
            if self.timeout_secs and (self.job_runtime_secs >
                                      self.timeout_secs) and not self.deploy.gui:
                self._kill()
                timeout_message = 'Job timed out after {} minutes'.format(
                    self.deploy.get_timeout_mins())
                self._post_finish(
                    'K',
                    ErrorMessage(line_number=None,
                                 message=timeout_message,
                                 context=[timeout_message]))
                return 'K'

            return 'D'

        self.exit_code = self.process.returncode
        status, err_msg = self._check_status()
        self._post_finish(status, err_msg)
        return self.status

    def _kill(self):
        '''Kill the running process.

        Try to kill the running process. Send SIGTERM first, wait a bit,
        and then send SIGKILL if it didn't work.
        '''
        assert self.process is not None
        self.process.terminate()
        try:
            self.process.wait(timeout=2)
        except subprocess.TimeoutExpired:
            self.process.kill()

    def kill(self):
        '''Kill the running process.

        This must be called between dispatching and reaping the process (the
        same window as poll()).

        '''
        self._kill()
        self._post_finish(
            'K',
            ErrorMessage(line_number=None, message='Job killed!', context=[]))

    def _post_finish(self, status, err_msg):
        self._close_process()
        self.process = None
        super()._post_finish(status, err_msg)

    def _close_process(self):
        '''Close the file descriptors associated with the process.'''

        assert self.process
        if self.process.stdout:
            self.process.stdout.close()