Better handle CTRL-C during clang-tidy/format

It was possible (with some frequency) for the clang-tidy/format target
to continue starting new subprocesses after a CTRL-C, because we were
not canceling the already queued tasks and waiting for all of them.

This makes a best-effort attempt to cancel all further subprocesses. It
is not 100%, because there is a race that is hard to avoid (without
major restructuring, at least): new subprocesses may be started after
KeyboardInterrupt (or any other exception) is raised but before we get
to the cancellation.

When the race happens, the calling ninja may exit before Meson exits,
causing some output (from clang-tidy/format and Meson's traceback) to be
printed after returning to the shell prompt. But this is an improvement
over potentially launching all the remaining tasks after having returned
to the shell, which is what used to happen rather often.

In practice, it appears that we cleanly exit with a pretty high
probability unless CTRL-C is hit very early after starting (presumably
before the thread pool has launched subprocesses on all its threads).
pull/13367/head
Mark A. Tsuchida 3 months ago committed by Jussi Pakkanen
parent 0bd45b3676
commit a57c880368
  1. 22
      mesonbuild/scripts/run_tool.py

@ -5,8 +5,8 @@ from __future__ import annotations
import itertools
import fnmatch
import concurrent.futures
from pathlib import Path
from concurrent.futures import ThreadPoolExecutor
from ..compilers import lang_suffixes
from ..mesonlib import quiet_git
@ -46,13 +46,27 @@ def run_tool(name: str, srcdir: Path, builddir: Path, fn: T.Callable[..., subpro
suffixes = {f'.{s}' for s in suffixes}
futures = []
returncode = 0
with ThreadPoolExecutor() as e:
e = concurrent.futures.ThreadPoolExecutor()
try:
for f in itertools.chain(*globs):
strf = str(f)
if f.is_dir() or f.suffix not in suffixes or \
any(fnmatch.fnmatch(strf, i) for i in ignore):
continue
futures.append(e.submit(fn, f, *args))
if futures:
returncode = max(x.result().returncode for x in futures)
concurrent.futures.wait(
futures,
return_when=concurrent.futures.FIRST_EXCEPTION
)
finally:
# We try to prevent new subprocesses from being started by canceling
# the futures, but this is not water-tight: some may have started
# between the wait being interrupted or exited and the futures being
# canceled. (A fundamental fix would probably require the ability to
# terminate such subprocesses upon cancellation of the future.)
for x in futures: # Python >=3.9: e.shutdown(cancel_futures=True)
x.cancel()
e.shutdown()
if futures:
returncode = max(x.result().returncode for x in futures)
return returncode

Loading…
Cancel
Save