diff --git a/docs/src/commands/minheap.md b/docs/src/commands/minheap.md index 0080e00..a55ca40 100644 --- a/docs/src/commands/minheap.md +++ b/docs/src/commands/minheap.md @@ -47,7 +47,7 @@ dacapochopin-69a704e: ## Usage ```console -minheap [-h] [-a|--attempts ATTEMPTS] CONFIG RESULT +minheap [-h] [-a|--attempts ATTEMPTS] [--log-dir LOG_DIR] [-p|--id-prefix ID_PREFIX] CONFIG RESULT ``` `-h`: print help message. @@ -55,6 +55,12 @@ minheap [-h] [-a|--attempts ATTEMPTS] CONFIG RESULT `-a` (preview ⚠️): set the number of attempts. Overrides `attempts` in the config file. +`--log-dir`: if specified, persist per-run benchmark logs under `LOG_DIR/RUN_ID/` using the same run-id layout and log filename format as `runbms`. +`minheap_args.yml` and `minheap.yml` are also stored in that run directory. +If omitted, `minheap` keeps using a temporary working directory and does not preserve benchmark logs after exit. + +`-p`: add a prefix to the generated run directory name, matching `runbms`. + `CONFIG`: the path to the configuration file. This is required. diff --git a/docs/src/references/suite.md b/docs/src/references/suite.md index 4210175..7cd0378 100644 --- a/docs/src/references/suite.md +++ b/docs/src/references/suite.md @@ -212,6 +212,9 @@ GC benchmarks for Julia: https://github.com/JuliaCI/GCBenchmarks The value is required. Environment variables will be expanded. +`timeout`: timeout for one invocation of a benchmark in seconds. +The default value is `null`. + `minheap`: a string that selects one of the `minheap_values` sets to use. `minheap_values`: a dictionary containing multiple named sets of minimal heap sizes that is enough for a benchmark from the suite to run without triggering `Out of Memory!`. @@ -231,3 +234,16 @@ An example looks like this: slow/bigint/pidigits: 198 slow/rb_tree/rb_tree: 8640 ``` + +### Benchmark Specification +Benchmarks can be specified either as strings or as dictionaries. + +The keys currently supported in the dictionary form are `name` and `timeout`. + +Example: +```yaml +benchmarks: + gcbenchmarks: + - name: serial/gcbench/gcbench + timeout: 30 +``` diff --git a/src/running/command/minheap.py b/src/running/command/minheap.py index e9a2153..b2d273f 100644 --- a/src/running/command/minheap.py +++ b/src/running/command/minheap.py @@ -1,10 +1,16 @@ -from typing import Any, Dict, Optional, DefaultDict +from typing import Any, Dict, Optional, DefaultDict, BinaryIO from running.config import Configuration from pathlib import Path from running.runtime import NativeExecutable, Runtime from running.benchmark import Benchmark, SubprocessrExit from running.suite import BenchmarkSuite from running.util import parse_config_str, config_str_encode +from running.command.runbms import ( + get_filename, + get_log_epilogue, + get_log_prologue, + getid, +) import logging import tempfile import yaml @@ -22,6 +28,8 @@ def setup_parser(subparsers): f.add_argument("CONFIG", type=Path) f.add_argument("RESULT", type=Path) f.add_argument("-a", "--attempts", type=int) + f.add_argument("--log-dir", type=Path) + f.add_argument("-p", "--id-prefix") class ContinueSearch(Enum): @@ -32,9 +40,12 @@ class ContinueSearch(Enum): def run_bm_with_retry( suite: BenchmarkSuite, + config: str, runtime: Runtime, bm_with_heapsize: Benchmark, + heapsize: int, minheap_dir: Path, + log_dir: Optional[Path], attempts: int, ) -> ContinueSearch: def log(s): @@ -42,9 +53,26 @@ def log(s): log(" ") for _ in range(attempts): - output, _companion_output, subprocess_exit = bm_with_heapsize.run( - runtime, cwd=minheap_dir - ) + fd: Optional[BinaryIO] = None + if log_dir is not None and not is_dry_run(): + log_path = log_dir / get_filename(bm_with_heapsize, None, heapsize, config) + fd = log_path.open("ab") + prologue = get_log_prologue(runtime, bm_with_heapsize) + fd.write(prologue.encode("ascii")) + try: + output, companion_output, subprocess_exit = bm_with_heapsize.run( + runtime, cwd=minheap_dir + ) + if fd: + fd.write(output) + if companion_output: + fd.write(b"*****\n") + fd.write(companion_output) + epilogue = get_log_epilogue(runtime, bm_with_heapsize) + fd.write(epilogue.encode("ascii")) + finally: + if fd: + fd.close() if runtime.is_oom(output): # if OOM is detected, we exit the loop regardless the exit statussour log("x ") @@ -68,10 +96,12 @@ def log(s): def minheap_one_bm( suite: BenchmarkSuite, + config: str, runtime: Runtime, bm: Benchmark, heap: int, minheap_dir: Path, + log_dir: Optional[Path], attempts: int, ) -> float: lo = 2 @@ -84,7 +114,14 @@ def minheap_one_bm( print(size_str, end="", flush=True) bm_with_heapsize = bm.attach_modifiers(heapsize) result = run_bm_with_retry( - suite, runtime, bm_with_heapsize, minheap_dir, attempts + suite, + config, + runtime, + bm_with_heapsize, + mid, + minheap_dir, + log_dir, + attempts, ) if result is ContinueSearch.Abort: return float("inf") @@ -103,6 +140,7 @@ def minheap_one_bm( def run_with_persistence( result: Dict[str, Any], minheap_dir: Path, + log_dir: Optional[Path], result_file: Optional[Path], attempts: int, ): @@ -131,7 +169,7 @@ def run_with_persistence( b.get_runtime_specific_modifiers(runtime) ) minheap = minheap_one_bm( - suite, runtime, mod_b, maxheap, minheap_dir, attempts + suite, c, runtime, mod_b, maxheap, minheap_dir, log_dir, attempts ) print("minheap {}".format(minheap)) result[c_encoded][suite_name][b.name] = minheap @@ -174,7 +212,6 @@ def run(args): return False global configuration configuration = Configuration.from_file(Path(os.getcwd()), args.get("CONFIG")) - configuration.resolve_class() result_file = args.get("RESULT") if result_file.exists(): with result_file.open() as fd: @@ -186,11 +223,30 @@ def run(args): attempts = configuration.get("attempts") if args.get("attempts"): attempts = args.get("attempts") + configuration.resolve_class() + log_dir: Optional[Path] = None + log_dir_base = args.get("log_dir") + if log_dir_base is not None: + prefix = args.get("id_prefix") + run_id = getid() + if prefix: + run_id = "{}-{}".format(prefix, run_id) + print("Run id: {}".format(run_id)) + run_log_dir = log_dir_base / run_id + log_dir = run_log_dir + if not is_dry_run(): + run_log_dir.mkdir(parents=True, exist_ok=True) + with (run_log_dir / "minheap_args.yml").open("w") as fd: + yaml.dump(args, fd) + with (run_log_dir / "minheap.yml").open("w") as fd: + configuration.save_to_file(fd) with tempfile.TemporaryDirectory(prefix="minheap-") as minheap_dir: logging.info("Temporary directory: {}".format(minheap_dir)) if is_dry_run(): - run_with_persistence(result, Path(minheap_dir), None, attempts) + run_with_persistence(result, Path(minheap_dir), None, None, attempts) else: - run_with_persistence(result, Path(minheap_dir), result_file, attempts) + run_with_persistence( + result, Path(minheap_dir), log_dir, result_file, attempts + ) print_best(result) return True diff --git a/src/running/suite.py b/src/running/suite.py index 8146aa8..6f0ca13 100644 --- a/src/running/suite.py +++ b/src/running/suite.py @@ -489,6 +489,8 @@ def __init__(self, **kwargs): self.name, self.name ) ) + self.timeout: Optional[int] + self.timeout = kwargs.get("timeout") def __str__(self) -> str: return "{} JuliaGCBenchmarks {}".format(super().__str__(), self.path) @@ -505,13 +507,25 @@ def get_minheap(self, bm: Benchmark) -> int: return minheap[name] def get_benchmark(self, bm_spec: Union[str, Dict[str, Any]]) -> "JuliaBenchmark": - assert type(bm_spec) is str + timeout = self.timeout + if type(bm_spec) is str: + name = bm_spec + else: + assert type(bm_spec) is dict + if "name" not in bm_spec: + raise KeyError( + "When a dictionary is used to specify a benchmark, you need to provide `name`" + ) + name = bm_spec["name"] + if "timeout" in bm_spec: + timeout = bm_spec["timeout"] return JuliaBenchmark( julia_args=[], suite_name=self.name, - name=bm_spec, + name=name, suite_path=self.path, program_args=[], + timeout=timeout, ) def is_passed(self, output: bytes) -> bool: