pkgstripfiles: symlinking docs and optimizing pngs/trucating changelogs in parallel produces undeterministic results
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
pkgbinarymangler (Ubuntu) |
Fix Released
|
Undecided
|
Unassigned | ||
Bionic |
Fix Released
|
Undecided
|
Unassigned |
Bug Description
[Impact]
* PNG optimization and changelog truncation can happen in parallel with symlinking docs across packages. When checking for duplicates files the duplicate check may compare the processed files with non-processed ones and in that case they are found to be different despite the processed (or the unprocessed) files would be identical. The resulting binary packages would be still valid, but may be different for different architectures since the parallel build process may hit this race condition when processing different files making the arch:any packages not coinstallable on a multiarch-enabled system.
* One manifestation of the problem can be seen in https:/
...
Searching for duplicated docs in dependency libgpm2...
pkgstripfiles: Truncating usr/share/
gzip: /<<PKGBUILDDIR>
cmp: EOF on /dev/fd/62 which is empty
...
* The fix is protecting png optimization and trucating changelogs with the same lock as used to serialize doc symlinking thus those steps are serialized as well. The fix also skips optimizing PNGs and truncating changelogs of dbgsym files in pkgstripfiles.
[Test Case]
* Build an affected package (like gpm) for i386 and amd64 with fixed pkgbinarymangler and observe the files in /usr/share/doc in the built packages to be identical and there should be no line like the following in the build log:
gzip: /<<PKGBUILDDIR>
* Note that due to the non-deterministic nature of the failure several builds could be necessary to reproduce the original problem and also for verifying that the problem is fixed. You can increase the chances of observing the failure by building the packages with higher level of parallelism (-jX).
[Regression Potential]
* Due to serialization the build times may increase for packages where the serialized steps ran in parallel originally. IMO there is not much we can do about that apart from trying to speed up the steps themselves.
* Since no additional locks were introduced I believe the builds won't break or stall due to this change.
* The fix also skips optimizing PNGs and truncating changelogs of dbgsym files, but PNG files are typically not present there and /usr/share/
[Other Info]
* There are some packages which need to be rebuilt with the updated pkgbinarymangler, collecting them is in progress.
description: | updated |
tags: | added: id-5b2bdda1b1a060708081efe3 |
description: | updated |
description: | updated |
This bug was fixed in the package pkgbinarymangler - 141
---------------
pkgbinarymangler (141) cosmic; urgency=medium
* pkgstripfiles: Serialize PNG optimization and changelog trucation using
the lock already used for serializing creating symlinks for identical
documentation files. (LP: #1782094)
-- Balint Reczey <email address hidden> Tue, 17 Jul 2018 10:03:52 +0200