]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
bpo-42398: Fix "make regen-all" race condition (GH-23362) (GH-23367)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 18 Nov 2020 16:28:57 +0000 (08:28 -0800)
committerGitHub <noreply@github.com>
Wed, 18 Nov 2020 16:28:57 +0000 (08:28 -0800)
commit66dd5338a1ca98921c8e6c51228541ef8ed8076a
tree1ea1f474e444d21230a3d7d2ed361dd734c05706
parent73e02ff0d47c37cf2a8f137cfbea0b36d26c48bb
bpo-42398: Fix "make regen-all" race condition (GH-23362) (GH-23367)

Fix a race condition in "make regen-all" when make -jN option is used
to run jobs in parallel. The clinic.py script now only use atomic
write to write files. Moveover, generated files are now left
unchanged if the content does not change, to not change the file
modification time.

The "make regen-all" command runs "make clinic" and "make
regen-importlib" targets:

* "make regen-importlib" builds object files (ex: Modules/_weakref.o)
  from source files (ex: Modules/_weakref.c) and clinic files (ex:
  Modules/clinic/_weakref.c.h)
* "make clinic" always rewrites all clinic files
  (ex: Modules/clinic/_weakref.c.h)

Since there is no dependency between "clinic" and "regen-importlib"
Makefile targets, these two targets can be run in parallel. Moreover,
half of clinic.py file writes are not atomic and so there is a race
condition when "make regen-all" runs jobs in parallel using make -jN
option (which can be passed in MAKEFLAGS environment variable).

Fix clinic.py to make all file writes atomic:

* Add write_file() function to ensure that all file writes are
  atomic: write into a temporary file and then use os.replace().
* Moreover, write_file() doesn't recreate or modify the file if the
  content does not change to avoid modifying the file modification
  file.
* Update test_clinic to verify these assertions with a functional
  test.
* Remove Clinic.force attribute which was no longer used, whereas
  Clinic.verify remains useful.

(cherry picked from commit 8fba9523cf08029dc2e280d9f48fdd57ab178c9d)
(cherry picked from commit c53c3f400050a7edc92ccb7285a6d7eeb4c37fd2)

Co-authored-by: Victor Stinner <vstinner@python.org>
Lib/test/test_clinic.py
Misc/NEWS.d/next/Build/2020-11-18-11-58-44.bpo-42398.Yt5wO8.rst [new file with mode: 0644]
Tools/clinic/clinic.py