Skip to content

Commit 3348972

Browse files
committed
[Autotuner] Add crash recovery script for unrecoverable CUDA errors
1 parent c104092 commit 3348972

File tree

6 files changed

+376
-2
lines changed

6 files changed

+376
-2
lines changed

docs/deployment_autotuning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,10 +196,10 @@ automatically. On successful completion, the checkpoint file is cleaned up.
196196

197197
```bash
198198
# Enable checkpointing to a directory:
199-
HELION_AUTOTUNE_CHECKPOINT_DIR=/tmp/helion_checkpoints python run_kernel.py
199+
HELION_AUTOTUNE_CHECKPOINT_DIR=/tmp/$USER/helion_checkpoints python run_kernel.py
200200

201201
# If interrupted, just re-run with the same directory to resume:
202-
HELION_AUTOTUNE_CHECKPOINT_DIR=/tmp/helion_checkpoints python run_kernel.py
202+
HELION_AUTOTUNE_CHECKPOINT_DIR=/tmp/$USER/helion_checkpoints python run_kernel.py
203203
```
204204

205205
Without `HELION_AUTOTUNE_CHECKPOINT_DIR`, no checkpoints are saved (opt-in).

helion/autotuner/base_search.py

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,6 +369,8 @@ class BaseSearch(BaseAutotuner):
369369
"_skip_cache",
370370
"_autotune_metrics",
371371
"_stable_hash",
372+
# Loaded separately from .crashed_configs file
373+
"_crashed_config_strs",
372374
}
373375

374376
@classmethod
@@ -423,6 +425,7 @@ def __init__(self, kernel: _AutotunableKernel, args: Sequence[object]) -> None:
423425
self._precompile_tmpdir: tempfile.TemporaryDirectory[str] | None = None
424426
self._precompile_args_path: str | None = None
425427
self._precompile_result_counter = count()
428+
self._crashed_config_strs: set[str] = set()
426429

427430
def _prepare(self) -> None:
428431
"""Some initialization deferred until autotuning actually runs.
@@ -522,6 +525,32 @@ def _try_load_checkpoint(self) -> bool:
522525
self.log(f"Resumed at generation {self._current_generation}")
523526
return True
524527

528+
def _load_crashed_configs(self) -> None:
529+
"""Load crashed configs from {hash}.crashed_configs (written by crash-recovery script)."""
530+
checkpoint_dir_str = self.settings.autotune_checkpoint_dir
531+
if checkpoint_dir_str is None:
532+
return
533+
crashed_configs_path = (
534+
Path(checkpoint_dir_str) / f"{self._get_stable_hash()}.crashed_configs"
535+
)
536+
if crashed_configs_path.exists():
537+
self._crashed_config_strs |= {
538+
line.strip()
539+
for line in crashed_configs_path.read_text().splitlines()
540+
if line.strip()
541+
}
542+
if self._crashed_config_strs:
543+
self.log(
544+
f"Loaded {len(self._crashed_config_strs)} crashed config(s) to skip"
545+
)
546+
547+
def _get_pending_config_path(self) -> Path | None:
548+
"""Get path for pending-config sentinel, or None if checkpointing disabled."""
549+
checkpoint_dir_str = self.settings.autotune_checkpoint_dir
550+
if checkpoint_dir_str is None:
551+
return None
552+
return Path(checkpoint_dir_str) / f"{self._get_stable_hash()}.pending_config"
553+
525554
def _compute_baseline(
526555
self,
527556
) -> tuple[object, Sequence[int], Sequence[object] | None]:
@@ -744,6 +773,12 @@ def benchmark_function(self, config: Config, fn: CompiledConfig) -> float:
744773
Returns:
745774
The performance of the configuration in ms.
746775
"""
776+
# Skip configs that previously crashed the subprocess
777+
config_str = str(config)
778+
if config_str in self._crashed_config_strs:
779+
self.log.warning(f"Skipping known-crashed config: {config}")
780+
return inf
781+
747782
self._autotune_metrics.num_configs_tested += 1
748783
self.counters["benchmark"] += 1
749784
self.log.debug(lambda: f"Running benchmark for {config!r}")
@@ -1024,13 +1059,32 @@ def _benchmark(
10241059
A list of BenchmarkResult entries containing the configuration, compiled
10251060
callable, measured performance, status, and compilation time.
10261061
"""
1062+
# Filter out known-crashed configs before compilation
1063+
if self._crashed_config_strs:
1064+
original_len = len(configs)
1065+
configs = [c for c in configs if str(c) not in self._crashed_config_strs]
1066+
skipped = original_len - len(configs)
1067+
if skipped:
1068+
self.log.warning(
1069+
f"Skipped {skipped} known-crashed config(s) before compilation"
1070+
)
1071+
if not configs:
1072+
return []
1073+
10271074
fns: list[Callable[..., object]] = []
10281075
valid_configs: list[Config] = []
10291076
futures: list[PrecompileFuture] | None = None
1077+
pending_path = self._get_pending_config_path()
10301078
for i, config in enumerate(configs):
1079+
# Write sentinel before compile so a hard crash (SIGKILL /
1080+
# CUDA IMA) leaves a trace the crash recovery script can find.
1081+
if pending_path is not None:
1082+
pending_path.write_text(str(config))
10311083
try:
10321084
fn = self.kernel.compile_config(config, allow_print=False)
10331085
except Exception:
1086+
if pending_path is not None:
1087+
pending_path.unlink(missing_ok=True)
10341088
# If all configs failed, raise error
10351089
if not valid_configs and i == len(configs) - 1:
10361090
raise
@@ -1040,9 +1094,14 @@ def _benchmark(
10401094
exc_info=True,
10411095
)
10421096
continue
1097+
if pending_path is not None:
1098+
pending_path.unlink(missing_ok=True)
10431099
fns.append(fn)
10441100
valid_configs.append(config)
10451101
configs = valid_configs
1102+
# NOTE: precompile runs in separate subprocesses with isolated CUDA
1103+
# contexts; crashes there are caught via is_working checks, not
1104+
# sentinels.
10461105
if self.settings.autotune_precompile:
10471106
futures = list(
10481107
starmap(
@@ -1104,7 +1163,14 @@ def _benchmark(
11041163
)
11051164
)
11061165
# benchmark one-by-one to avoid noisy results
1166+
# Write pending-config sentinel; cleared after benchmark.
1167+
# On crash the file stays so the crash recovery script can
1168+
# detect which config caused the failure.
1169+
if pending_path is not None:
1170+
pending_path.write_text(str(config))
11071171
perf = self.benchmark_function(config, fn)
1172+
if pending_path is not None:
1173+
pending_path.unlink(missing_ok=True)
11081174
status = "ok" if math.isfinite(perf) else "error"
11091175
# Log completion after benchmarking
11101176
self.log.record_autotune_entry(
@@ -1209,6 +1275,7 @@ def autotune(self, *, skip_cache: bool = False) -> Config:
12091275

12101276
if not self._try_load_checkpoint():
12111277
self._init_search()
1278+
self._load_crashed_configs()
12121279
try:
12131280
best = self._autotune()
12141281
self._cleanup_checkpoint()
@@ -1311,6 +1378,12 @@ def _cleanup_checkpoint(self) -> None:
13111378
checkpoint_file.unlink()
13121379
self.log(f"Checkpoint cleaned up: {checkpoint_file}")
13131380

1381+
# Clean up crash-recovery artifacts
1382+
for suffix in (".pending_config", ".crashed_configs"):
1383+
artifact = Path(checkpoint_dir_str) / f"{stable_hash}{suffix}"
1384+
if artifact.exists():
1385+
artifact.unlink()
1386+
13141387
@staticmethod
13151388
def _serialize_numpy_rng_state(
13161389
state: tuple[str, Any, int, int, float],
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
"""Autotuner crash recovery wrapper.
2+
3+
Runs a command (typically a Python script that calls helion autotuning) in a
4+
retry loop. When the process crashes due to an unrecoverable CUDA error
5+
(illegal memory access, misaligned address, etc.), the autotuner leaves a
6+
``{hash}.pending_config`` sentinel in the checkpoint directory. This script
7+
detects that file, records the poison config in ``{hash}.crashed_configs``, and
8+
re-runs the command. On re-run the autotuner loads its checkpoint and skips
9+
the crashed config.
10+
11+
Progress detection
12+
------------------
13+
Each crash should block a different config (since blocked configs are skipped
14+
on re-run). If the same config crashes twice, the autotuner is stuck and we
15+
give up.
16+
17+
Requirements
18+
------------
19+
``HELION_AUTOTUNE_CHECKPOINT_DIR`` must be set in the environment.
20+
21+
Usage
22+
-----
23+
::
24+
25+
HELION_AUTOTUNE_CHECKPOINT_DIR=/tmp/$USER/helion_ckpt \\
26+
python -m helion.experimental.crash_recovery [--max-retries N] -- COMMAND [ARGS...]
27+
28+
Examples
29+
--------
30+
::
31+
32+
HELION_AUTOTUNE_CHECKPOINT_DIR=/tmp/$USER/helion_autotune_ckpt \\
33+
python -m helion.experimental.crash_recovery -- python train.py
34+
"""
35+
36+
from __future__ import annotations
37+
38+
import argparse
39+
import os
40+
from pathlib import Path
41+
import subprocess
42+
import sys
43+
44+
45+
def _log(msg: str) -> None:
46+
print(f"[crash-recovery] {msg}", file=sys.stderr)
47+
48+
49+
def main(argv: list[str] | None = None) -> int:
50+
parser = argparse.ArgumentParser(
51+
description="Autotuner crash recovery wrapper.",
52+
usage=(
53+
"HELION_AUTOTUNE_CHECKPOINT_DIR=/path/to/dir\n"
54+
" %(prog)s [--max-retries N] -- COMMAND [ARGS...]"
55+
),
56+
)
57+
parser.add_argument(
58+
"--max-retries",
59+
type=int,
60+
default=50,
61+
help="Maximum number of crash recovery retries (default: 50)",
62+
)
63+
parser.add_argument(
64+
"command",
65+
nargs=argparse.REMAINDER,
66+
help="Command to run (after '--' separator)",
67+
)
68+
args = parser.parse_args(argv)
69+
70+
# argparse.REMAINDER absorbs '--' as first element when present.
71+
command: list[str] = args.command
72+
if command and command[0] == "--":
73+
command = command[1:]
74+
if not command:
75+
parser.error("no command specified after --")
76+
77+
checkpoint_dir_str = os.environ.get("HELION_AUTOTUNE_CHECKPOINT_DIR", "")
78+
if not checkpoint_dir_str:
79+
print(
80+
"Error: HELION_AUTOTUNE_CHECKPOINT_DIR must be set.",
81+
file=sys.stderr,
82+
)
83+
return 1
84+
85+
checkpoint_dir = Path(checkpoint_dir_str)
86+
checkpoint_dir.mkdir(parents=True, exist_ok=True)
87+
88+
attempt = 0
89+
all_crashed: set[str] = set()
90+
91+
while True:
92+
attempt += 1
93+
94+
result = subprocess.run(command)
95+
exit_code = result.returncode
96+
97+
if exit_code == 0:
98+
return 0
99+
100+
# Look for any *.pending_config sentinel left by the autotuner.
101+
pending_files = sorted(checkpoint_dir.glob("*.pending_config"))
102+
103+
if pending_files:
104+
stuck = False
105+
for pending_path in pending_files:
106+
hash_prefix = pending_path.stem # {hash} without .pending_config
107+
crashed_configs_path = checkpoint_dir / f"{hash_prefix}.crashed_configs"
108+
109+
config = pending_path.read_text().strip()
110+
pending_path.unlink()
111+
112+
with open(crashed_configs_path, "a") as f:
113+
f.write(config + "\n")
114+
115+
_log(f"Blocked config: {config}")
116+
117+
# If this config was already blocked in a previous attempt,
118+
# the autotuner is not skipping it -- it's stuck.
119+
if config in all_crashed:
120+
stuck = True
121+
all_crashed.add(config)
122+
123+
_log(f"Process crashed (exit code {exit_code}, attempt {attempt}).")
124+
125+
if stuck:
126+
_log("Same config crashed twice \u2014 the autotuner appears stuck.")
127+
_log(
128+
"All crashed configs have been recorded. You can re-run "
129+
"this script and it will resume from the latest "
130+
"checkpoint, skipping all previously recorded crashed "
131+
"configs."
132+
)
133+
return 1
134+
135+
if attempt >= args.max_retries:
136+
_log(f"Reached maximum retry limit ({args.max_retries}). Giving up.")
137+
return 1
138+
139+
_log("Restarting from checkpoint...")
140+
else:
141+
# No pending file -- not a recoverable CUDA crash.
142+
return exit_code
143+
144+
145+
if __name__ == "__main__":
146+
sys.exit(main())

test/data/autotune_crash_helper.py

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
"""Helper script for crash recovery tests.
2+
3+
Run via:
4+
HELION_AUTOTUNE_CHECKPOINT_DIR=DIR \
5+
python -m helion.experimental.crash_recovery -- python test/data/autotune_crash_helper.py
6+
7+
On first run (when _CRASH_ON_FIRST_BENCHMARK or _CRASH_ON_FIRST_COMPILE is
8+
set and no counter file exists): patches do_bench / compile_config to trigger
9+
a hard crash, which exercises the pending_config sentinel and the crash
10+
recovery script. On subsequent runs: autotuning resumes from checkpoint
11+
normally, skipping the crashed config.
12+
13+
Without the crash env vars: runs autotuning normally (used to test that the
14+
crash recovery script passes through a successful run).
15+
"""
16+
17+
from __future__ import annotations
18+
19+
import os
20+
from pathlib import Path
21+
22+
import torch
23+
24+
checkpoint_dir = os.environ["HELION_AUTOTUNE_CHECKPOINT_DIR"]
25+
crash_on_first_benchmark = os.environ.get("_CRASH_ON_FIRST_BENCHMARK", "")
26+
crash_on_first_compile = os.environ.get("_CRASH_ON_FIRST_COMPILE", "")
27+
counter_file = Path(checkpoint_dir) / "_crash_counter"
28+
29+
if crash_on_first_benchmark and not counter_file.exists():
30+
import triton
31+
import triton.language as tl
32+
33+
import helion.autotuner.base_search as _bs
34+
35+
@triton.jit
36+
def _ima_kernel(ptr):
37+
"""Triton kernel that triggers illegal memory access."""
38+
bad_ptr = ptr + (1 << 40)
39+
tl.store(bad_ptr, tl.full([], 42.0, dtype=tl.float32))
40+
41+
_original_do_bench = _bs.do_bench
42+
43+
def _ima_do_bench(*args, **kwargs): # type: ignore[no-untyped-def]
44+
counter_file.write_text("done")
45+
# Restore original so this only fires once
46+
_bs.do_bench = _original_do_bench
47+
# Trigger real CUDA illegal memory access
48+
x = torch.zeros(1, device="cuda")
49+
_ima_kernel[(1,)](x)
50+
torch.cuda.synchronize()
51+
# Should not reach here — IMA raises an exception
52+
return _original_do_bench(*args, **kwargs)
53+
54+
_bs.do_bench = _ima_do_bench
55+
56+
if crash_on_first_compile and not counter_file.exists():
57+
import helion.autotuner.base_search as _bs
58+
59+
# Wrap _benchmark so the real sentinel-writing code runs, but
60+
# compile_config triggers a hard crash (os._exit) on first call.
61+
_original_benchmark = _bs.BaseSearch._benchmark
62+
63+
def _crashing_benchmark(self, configs, **kwargs): # type: ignore[no-untyped-def]
64+
_orig_compile = self.kernel.compile_config
65+
66+
def _crash_compile(*args, **kw): # type: ignore[no-untyped-def]
67+
counter_file.write_text("done")
68+
# Simulate a hard crash during compile_config. Real CUDA
69+
# crashes exit with signal codes (e.g. -11), but the crash
70+
# recovery script triggers on any non-zero exit + pending
71+
# sentinel, so os._exit(1) suffices for testing.
72+
os._exit(1)
73+
74+
self.kernel.compile_config = _crash_compile
75+
return _original_benchmark(self, configs, **kwargs)
76+
77+
_bs.BaseSearch._benchmark = _crashing_benchmark # type: ignore[assignment]
78+
79+
# Import and run real autotuning
80+
from helion._testing import import_path # noqa: E402
81+
82+
datadir = Path(__file__).parent
83+
basic_kernels = import_path(datadir / "basic_kernels.py")
84+
85+
args = (torch.randn([8, 32], device="cuda"), torch.randn([8, 32], device="cuda"))
86+
bound = basic_kernels.add.bind(args)
87+
bound.settings.autotune_checkpoint_dir = checkpoint_dir
88+
bound.settings.autotune_effort = "quick"
89+
config = bound.autotune(args, force=True)
90+
result = bound(*args)
91+
torch.testing.assert_close(result, args[0] + args[1])

0 commit comments

Comments
 (0)