Run passing tests with the GIL disabled

swtaarrs · swtaarrs · commit 1fe9165e2823 · 2024-03-07T13:02:27.000-08:00
In `--disable-gil` builds, `make test` and `make buildbottest` now run all
tests not know to fail with `-Xgil=0`. The test runner itself occasionally
crashes with the GIL off, so until that's resolved, it takes a `--disable-gil`
option to pass `-Xgil=0` to the worker processes.
diff --git a/Lib/test/gil_disabled_failing_tests.txt b/Lib/test/gil_disabled_failing_tests.txt
@@ -0,0 +1,30 @@
+test.test_asyncio.test_base_events.*
+test.test_asyncio.test_ssl.*
+test.test_capi.*
+test.test_code.*
+test.test_compileall.*
+test.test_concurrent_futures.*
+test.test_enum.*
+test.test_fork1.*
+test.test_functools.*
+test.test_httpservers.*
+test.test_imaplib.*
+test.test_import.*
+test.test_importlib.*
+test.test_io.*
+test.test_logging.*
+test.test_multiprocessing_forkserver.*
+test.test_multiprocessing_spawn.*
+test.test_pickle.*
+test.test_queue.*
+test.test_smtpnet.*
+test.test_socketserver.*
+test.test_ssl.*
+test.test_syslog.*
+test.test_thread.*
+test.test_threadedtempfile.*
+test.test_threading.*
+test.test_threading_local.*
+test.test_threadsignals.*
+test.test_urllib2net.*
+test.test_weakref.*
diff --git a/Lib/test/libregrtest/cmdline.py b/Lib/test/libregrtest/cmdline.py
@@ -349,6 +349,10 @@ def _create_parser():
                        help='remove old test_python_* directories')
     group.add_argument('--bisect', action='store_true',
                        help='if some tests fail, run test.bisect_cmd on them')
+    # This option is used to disable the GIL in worker processes until the test
+    # runner is stable under -Xgil=0.
+    group.add_argument('--disable-gil', action='store_true',
+                       help='Pass -Xgil=0 to worker processes.')
     group.add_argument('--dont-add-python-opts', dest='_add_python_opts',
                        action='store_false',
                        help="internal option, don't use it")
diff --git a/Lib/test/libregrtest/main.py b/Lib/test/libregrtest/main.py
@@ -120,6 +120,7 @@ def __init__(self, ns: Namespace, _add_python_opts: bool = False):
         self.coverage: bool = ns.trace
         self.coverage_dir: StrPath | None = ns.coverdir
         self.tmp_dir: StrPath | None = ns.tempdir
+        self.disable_gil: bool = ns.disable_gil
 
         # Randomize
         self.randomize: bool = ns.randomize
@@ -480,6 +481,7 @@ def create_run_tests(self, tests: TestTuple):
             python_cmd=self.python_cmd,
             randomize=self.randomize,
             random_seed=self.random_seed,
+            disable_gil=self.disable_gil,
         )
 
     def _run_tests(self, selected: TestTuple, tests: TestList | None) -> int:
diff --git a/Lib/test/libregrtest/runtests.py b/Lib/test/libregrtest/runtests.py
@@ -100,6 +100,7 @@ class RunTests:
     python_cmd: tuple[str, ...] | None
     randomize: bool
     random_seed: int | str
+    disable_gil: bool
 
     def copy(self, **override) -> 'RunTests':
         state = dataclasses.asdict(self)
@@ -146,6 +147,8 @@ def json_file_use_stdout(self) -> bool:
 
     def create_python_cmd(self) -> list[str]:
         python_opts = support.args_from_interpreter_flags()
+        if self.disable_gil:
+            python_opts.append("-Xgil=0")
         if self.python_cmd is not None:
             executable = self.python_cmd
             # Remove -E option, since --python=COMMAND can set PYTHON
diff --git a/Makefile.pre.in b/Makefile.pre.in
@@ -78,6 +78,8 @@ MKDIR_P=	@MKDIR_P@
 
 MAKESETUP=      $(srcdir)/Modules/makesetup
 
+GIL_DISABLED=   @GIL_DISABLED@
+
 # Compiler options
 OPT=		@OPT@
 BASECFLAGS=	@BASECFLAGS@
@@ -2024,6 +2026,7 @@ TESTOPTS=	$(EXTRATESTOPTS)
 TESTPYTHON=	$(RUNSHARED) $(PYTHON_FOR_BUILD) $(TESTPYTHONOPTS)
 TESTRUNNER=	$(TESTPYTHON) -m test
 TESTTIMEOUT=
+GIL_DISABLED_IGNORELIST= $(srcdir)/Lib/test/gil_disabled_failing_tests.txt
 
 # Remove "test_python_*" directories of previous failed test jobs.
 # Pass TESTOPTS options because it can contain --tempdir option.
@@ -2037,6 +2040,10 @@ cleantest: all
 .PHONY: test
 test: all
 	$(TESTRUNNER) --fast-ci --timeout=$(TESTTIMEOUT) $(TESTOPTS)
+ifeq ($(GIL_DISABLED),yes)
+	$(TESTRUNNER) --fast-ci --timeout=$(TESTTIMEOUT) $(TESTOPTS) \
+		--disable-gil --ignorefile=$(GIL_DISABLED_IGNORELIST)
+endif
 
 # Run the test suite for both architectures in a Universal build on OSX.
 # Must be run on an Intel box.
@@ -2095,6 +2102,10 @@ buildbottest: all
 		pybuildbot.identify "CC='$(CC)'" "CXX='$(CXX)'"; \
 	fi
 	$(TESTRUNNER) --slow-ci --timeout=$(TESTTIMEOUT) $(TESTOPTS)
+ifeq ($(GIL_DISABLED),yes)
+	$(TESTRUNNER) --slow-ci --timeout=$(TESTTIMEOUT) $(TESTOPTS) \
+		--disable-gil --ignorefile=$(GIL_DISABLED_IGNORELIST)
+endif
 
 .PHONY: pythoninfo
 pythoninfo: all
diff --git a/configure b/configure
diff --git a/configure.ac b/configure.ac
@@ -1666,11 +1666,15 @@ AC_ARG_ENABLE([gil],
 )
 AC_MSG_RESULT([$disable_gil])
 
+AC_SUBST([GIL_DISABLED])
+GIL_DISABLED=""
+
 if test "$disable_gil" = "yes"
 then
   AC_DEFINE([Py_GIL_DISABLED], [1],
             [Define if you want to disable the GIL])
   # Add "t" for "threaded"
+  GIL_DISABLED="yes"
   ABIFLAGS="${ABIFLAGS}t"
 fi
 
