Skip to content

Fix cleanup race condition with exclusive and shared lock files (backport #5319)#5695

Merged
MiguelCompany merged 1 commit into2.10.xfrom
mergify/bp/2.10.x/pr-5319
May 20, 2025
Merged

Fix cleanup race condition with exclusive and shared lock files (backport #5319)#5695
MiguelCompany merged 1 commit into2.10.xfrom
mergify/bp/2.10.x/pr-5319

Conversation

@mergify
Copy link
Copy Markdown
Contributor

@mergify mergify Bot commented Mar 7, 2025

Description

Since on unix file opening and locking are non-atomic operations (open() system call followed with a flock() call), and clean.py depends on exclusive lockability to in order to decide on zombie file deletion, the following race condition (although rare) exists:

RobustExclusiveLock.hpp RobustExclusiveLock::open_and_lock_file calls open() successfully
clean.py opens, successfully locks and deletes the file
RobustExclusiveLock.hpp RobustExclusiveLock::open_and_lock_file calls flock() successfully

This leads to the file's creator assuming a successful file creation (the fd is valid and usable), while in reality the file is not accessible anymore since its directory entry has been removed. A similar situation might be triggered in obustSharedLock.hpp.

Verifying the existence of the directory entry with a call to stat() after successfully obtaining the exclusive lock of the file fixes and restarting the open and lock procedure in case the file was removed in between seems to fix the behavior.

@Mergifyio backport 3.1.x 2.14.x 2.10.x

Contributor Checklist

  • Commit messages follow the project guidelines.

  • The code follows the style guidelines of this project.

  • N/A Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally

  • N/A Any new/modified methods have been properly documented using Doxygen.

  • N/A Any new configuration API has an equivalent XML API (with the corresponding XSD extension)

  • Changes are backport compatible: they do NOT break ABI nor change library core behavior.

  • Changes are API compatible.

  • N/A New feature has been added to the versions.md file (if applicable).

  • N/A New feature has been documented/Current behavior is correctly described in the documentation.

  • Applicable backports have been included in the description.

Reviewer Checklist

  • The PR has a milestone assigned.
  • The title and description correctly express the PR's purpose.
  • Check contributor checklist is correct.
  • N/A If this is a critical bug fix, backports to the critical-only supported branches have been requested.
  • Check CI results: changes do not issue any warning.
  • Check CI results: failing tests are unrelated with the changes.

This is an automatic backport of pull request #5319 done by [Mergify](https://mergify.com).

@MiguelCompany MiguelCompany added this to the v2.10.7 milestone Mar 7, 2025
@MiguelCompany MiguelCompany self-requested a review March 7, 2025 12:19
@github-actions github-actions Bot added the ci-pending PR which CI is running label Mar 7, 2025
@MiguelCompany
Copy link
Copy Markdown
Member

@Mergifyio rebase

@mergify
Copy link
Copy Markdown
Contributor Author

mergify Bot commented May 14, 2025

rebase

✅ Branch has been successfully rebased

@MiguelCompany MiguelCompany force-pushed the mergify/bp/2.10.x/pr-5319 branch from 97f6127 to 89d63b2 Compare May 14, 2025 14:34
@MiguelCompany MiguelCompany removed the ci-pending PR which CI is running label May 14, 2025
@MiguelCompany
Copy link
Copy Markdown
Member

@Mergifyio rebase

* Prevent race condition with concurrent cleanup operation in RobustExclusiveLock

Signed-off-by: Matthias Schneider <ma30002000@yahoo.de>

* Prevent race condition with concurrent cleanup operation in RobustSharedLock

Signed-off-by: Matthias Schneider <ma30002000@yahoo.de>

* Adapted coding style as suggested by MiguelCompany

Signed-off-by: Matthias Schneider <ma30002000@yahoo.de>

---------

Signed-off-by: Matthias Schneider <ma30002000@yahoo.de>
(cherry picked from commit 53bf6ab)
@mergify
Copy link
Copy Markdown
Contributor Author

mergify Bot commented May 16, 2025

rebase

✅ Branch has been successfully rebased

@MiguelCompany MiguelCompany force-pushed the mergify/bp/2.10.x/pr-5319 branch from 89d63b2 to d7cbab5 Compare May 16, 2025 09:32
@MiguelCompany MiguelCompany requested review from MiguelCompany and removed request for MiguelCompany May 16, 2025 09:34
@github-actions github-actions Bot added the ci-pending PR which CI is running label May 16, 2025
@MiguelCompany MiguelCompany merged commit 5641a4b into 2.10.x May 20, 2025
13 of 18 checks passed
@MiguelCompany MiguelCompany deleted the mergify/bp/2.10.x/pr-5319 branch May 20, 2025 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-pending PR which CI is running

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants