Source code for reframe.core.launchers

# Copyright 2016-2022 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
# ReFrame Project Developers. See the top-level LICENSE file for details.
#
# SPDX-License-Identifier: BSD-3-Clause

import abc

import reframe.core.fields as fields
import reframe.utility.typecheck as typ


[docs]class JobLauncher(abc.ABC): '''Abstract base class for job launchers. A job launcher is the executable that actually launches a distributed program to multiple nodes, e.g., ``mpirun``, ``srun`` etc. .. warning:: Users may not create job launchers directly. .. note:: .. versionchanged:: 2.8 Job launchers do not get a reference to a job during their initialization. ''' #: List of options to be passed to the job launcher invocation. #: #: :type: :class:`List[str]` #: :default: ``[]`` options = fields.TypedField(typ.List[str]) def __init__(self): self.options = []
[docs] @abc.abstractmethod def command(self, job): '''The launcher command to be emitted for a specific job. Launcher backends provide concrete implementations of this method. :param job: A job descriptor. :returns: the basic launcher command as a list of tokens. '''
[docs] def run_command(self, job): '''The full launcher command to be emitted for a specific job. This includes any user options. :param job: a job descriptor. :returns: the launcher command as a string. ''' return ' '.join(self.command(job) + self.options)
[docs]class LauncherWrapper(JobLauncher): '''Wrap a launcher object so as to modify its invocation. This is useful for parallel debuggers. For example, to launch a regression test using the `ARM DDT <https://www.arm.com/products/development-tools/server-and-hpc/forge>`__ debugger, you can do the following: .. code:: python @run_after('setup') def set_launcher(self): self.job.launcher = LauncherWrapper(self.job.launcher, 'ddt', ['--offline']) If the current system partition uses native Slurm for job submission, this setup will generate the following command in the submission script: :: ddt --offline srun <test_executable> If the current partition uses ``mpirun`` instead, it will generate :: ddt --offline mpirun -np <num_tasks> ... <test_executable> :arg target_launcher: The launcher to wrap. :arg wrapper_command: The wrapper command. :arg wrapper_options: List of options to pass to the wrapper command. ''' def __init__(self, target_launcher, wrapper_command, wrapper_options=[]): super().__init__() self.options = target_launcher.options self._target_launcher = target_launcher self._wrapper_command = [wrapper_command] + wrapper_options
[docs] def command(self, job): return self._wrapper_command + self._target_launcher.command(job)