Merge pull request #566 from itajaja/parallel-exec

Add parallel execution

Author: mr-c

cwltool/argparser.py

@@ -28,7 +28,10 @@ def arg_parser():  # type: () -> argparse.ArgumentParser
     parser.add_argument("--no-container", action="store_false", default=True,
                         help="Do not execute jobs in a Docker container, even when specified by the CommandLineTool",
                         dest="use_container")
-
+    parser.add_argument("--parallel", action="store_true", default=False,
+                        help="[experimental] Run jobs in parallel. "
+                             "Does not currently keep track of ResourceRequirements like the number of cores"
+                             "or memory and can overload this system")
     parser.add_argument("--preserve-environment", type=Text, action="append",
                         help="Preserve specific environment variable when running CommandLineTools.  May be provided multiple times.",
                         metavar="ENVVAR",

cwltool/executors.py

@@ -0,0 +1,175 @@
+import logging
+import tempfile
+import threading
+
+import os
+from abc import ABCMeta, abstractmethod
+
+from typing import Dict, Text, Any, Tuple, Set, List
+
+from cwltool.builder import Builder
+from cwltool.errors import WorkflowException
+from cwltool.mutation import MutationManager
+from cwltool.job import JobBase
+from cwltool.process import relocateOutputs, cleanIntermediate, Process
+
+
+_logger = logging.getLogger("cwltool")
+
+defaultStreamHandler = logging.StreamHandler()
+_logger.addHandler(defaultStreamHandler)
+_logger.setLevel(logging.INFO)
+
+
+class JobExecutor(object):
+    __metaclass__ = ABCMeta
+
+    def __init__(self):
+        # type: (...) -> None
+        self.final_output = []  # type: List
+        self.final_status = []  # type: List
+        self.output_dirs = set()  # type: Set
+
+    def __call__(self, *args, **kwargs):
+        return self.execute(*args, **kwargs)
+
+    def output_callback(self, out, processStatus):
+        self.final_status.append(processStatus)
+        self.final_output.append(out)
+
+    @abstractmethod
+    def run_jobs(self,
+                 t,  # type: Process
+                 job_order_object,  # type: Dict[Text, Any]
+                 logger,
+                 **kwargs  # type: Any
+                 ):
+        pass
+
+    def execute(self, t,  # type: Process
+                job_order_object,  # type: Dict[Text, Any]
+                logger=_logger,
+                **kwargs  # type: Any
+                ):
+        # type: (...) -> Tuple[Dict[Text, Any], Text]
+
+        if "basedir" not in kwargs:
+            raise WorkflowException("Must provide 'basedir' in kwargs")
+
+        finaloutdir = os.path.abspath(kwargs.get("outdir")) if kwargs.get("outdir") else None
+        kwargs["outdir"] = tempfile.mkdtemp(prefix=kwargs["tmp_outdir_prefix"]) if kwargs.get(
+            "tmp_outdir_prefix") else tempfile.mkdtemp()
+        self.output_dirs.add(kwargs["outdir"])
+        kwargs["mutation_manager"] = MutationManager()
+
+        jobReqs = None
+        if "cwl:requirements" in job_order_object:
+            jobReqs = job_order_object["cwl:requirements"]
+        elif ("cwl:defaults" in t.metadata and "cwl:requirements" in t.metadata["cwl:defaults"]):
+            jobReqs = t.metadata["cwl:defaults"]["cwl:requirements"]
+        if jobReqs:
+            for req in jobReqs:
+                t.requirements.append(req)
+
+        self.run_jobs(t, job_order_object, logger, **kwargs)
+
+        if self.final_output and self.final_output[0] and finaloutdir:
+            self.final_output[0] = relocateOutputs(self.final_output[0], finaloutdir,
+                                                   self.output_dirs, kwargs.get("move_outputs"),
+                                                   kwargs["make_fs_access"](""))
+
+        if kwargs.get("rm_tmpdir"):
+            cleanIntermediate(self.output_dirs)
+
+        if self.final_output and self.final_status:
+            return (self.final_output[0], self.final_status[0])
+        else:
+            return (None, "permanentFail")
+
+
+class SingleJobExecutor(JobExecutor):
+    def run_jobs(self,
+                 t,  # type: Process
+                 job_order_object,  # type: Dict[Text, Any]
+                 logger,
+                 **kwargs  # type: Any
+                 ):
+        jobiter = t.job(job_order_object,
+                        self.output_callback,
+                        **kwargs)
+
+        try:
+            for r in jobiter:
+                if r:
+                    builder = kwargs.get("builder", None)  # type: Builder
+                    if builder is not None:
+                        r.builder = builder
+                    if r.outdir:
+                        self.output_dirs.add(r.outdir)
+                    r.run(**kwargs)
+                else:
+                    logger.error("Workflow cannot make any more progress.")
+                    break
+        except WorkflowException:
+            raise
+        except Exception as e:
+            logger.exception("Got workflow error")
+            raise WorkflowException(Text(e))
+
+
+class MultithreadedJobExecutor(JobExecutor):
+    def __init__(self):
+        super(MultithreadedJobExecutor, self).__init__()
+        self.threads = set()
+        self.exceptions = []
+
+    def run_job(self,
+                job, # type:  JobBase
+                **kwargs  # type:  Any
+                ):
+        # type: (...) -> None
+        def runner():
+            try:
+                job.run(**kwargs)
+            except WorkflowException as e:
+                self.exceptions.append(e)
+            except Exception as e:
+                self.exceptions.append(WorkflowException(Text(e)))
+
+            self.threads.remove(thread)
+
+        thread = threading.Thread(target=runner)
+        thread.daemon = True
+        self.threads.add(thread)
+        thread.start()
+
+    def wait_for_next_completion(self):  # type: () -> None
+        if self.exceptions:
+            raise self.exceptions[0]
+
+    def run_jobs(self,
+                 t,  # type: Process
+                 job_order_object,  # type: Dict[Text, Any]
+                 logger,
+                 **kwargs  # type: Any
+                 ):
+
+        jobiter = t.job(job_order_object, self.output_callback, **kwargs)
+
+        for r in jobiter:
+            if r:
+                builder = kwargs.get("builder", None)  # type: Builder
+                if builder is not None:
+                    r.builder = builder
+                if r.outdir:
+                    self.output_dirs.add(r.outdir)
+                self.run_job(r, **kwargs)
+            else:
+                if len(self.threads):
+                    self.wait_for_next_completion()
+                else:
+                    logger.error("Workflow cannot make any more progress.")
+                    break
+
+        while len(self.threads) > 0:
+            self.wait_for_next_completion()

cwltool/factory.py

@@ -3,8 +3,9 @@
 from typing import Callable as tCallable
 from typing import Any, Dict, Text, Tuple, Union
 
-from . import load_tool, main, workflow
+from . import load_tool, workflow
 from .argparser import get_default_args
+from .executors import SingleJobExecutor
 from .process import Process
 
 
@@ -36,11 +37,13 @@ class Factory(object):
     def __init__(self,
                  makeTool=workflow.defaultMakeTool,  # type: tCallable[[Any], Process]
                  # should be tCallable[[Dict[Text, Any], Any], Process] ?
-                 executor=main.single_job_executor,  # type: tCallable[...,Tuple[Dict[Text,Any], Text]]
+                 executor=None,  # type: tCallable[...,Tuple[Dict[Text,Any], Text]]
                  **execkwargs  # type: Any
                  ):
         # type: (...) -> None
         self.makeTool = makeTool
+        if executor is None:
+            executor = SingleJobExecutor()
         self.executor = executor
 
         kwargs = get_default_args()

cwltool/job.py

@@ -1,5 +1,7 @@
 from __future__ import absolute_import
+
 import codecs
+import datetime
 import functools
 import io
 import json
@@ -11,27 +13,29 @@
 import subprocess
 import sys
 import tempfile
-import datetime
 from io import open
+from threading import Lock
 from typing import (IO, Any, Callable, Dict, Iterable, List, MutableMapping, Text,
-                    Tuple, Union, cast)
+                    Union, cast)
 
 import shellescape
 
-from .utils import copytree_with_merge, docker_windows_path_adjust, onWindows
 from . import docker
 from .builder import Builder
 from .docker_id import docker_vm_id
 from .errors import WorkflowException
 from .pathmapper import PathMapper, ensure_writable
-from .process import (UnsupportedRequirement, empty_subtree, get_feature,
+from .process import (UnsupportedRequirement, get_feature,
                       stageFiles)
 from .utils import bytes2str_in_dicts
+from .utils import copytree_with_merge, docker_windows_path_adjust, onWindows
 
 _logger = logging.getLogger("cwltool")
 
 needs_shell_quoting_re = re.compile(r"""(^$|[\s|&;()<>\'"$@])""")
 
+job_output_lock = Lock()
+
 FORCE_SHELLED_POPEN = os.getenv("CWLTOOL_FORCE_SHELL_POPEN", "0") == "1"
 
 SHELL_COMMAND_TEMPLATE = """#!/bin/bash
@@ -267,7 +271,8 @@ def _execute(self, runtime, env, rm_tmpdir=True, move_outputs="move"):
         if _logger.isEnabledFor(logging.DEBUG):
             _logger.debug(u"[job %s] %s", self.name, json.dumps(outputs, indent=4))
 
-        self.output_callback(outputs, processStatus)
+        with job_output_lock:
+            self.output_callback(outputs, processStatus)
 
         if self.stagedir and os.path.exists(self.stagedir):
             _logger.debug(u"[job %s] Removing input staging directory %s", self.name, self.stagedir)