Fix deadlock detection after ForgetDeadlockInfo() on a held Mutex

In debug builds, the Mutex deadlock detector records each lock order edge
(A is held while B is acquired) in a global graph keyed by Mutex address.
ForgetDeadlockInfo() erases everything recorded about one Mutex by removing its
graph node. The header says to call it when the lock ordering of a Mutex
changes. ~Mutex() also calls it in debug builds, so that a new Mutex at a
reused address does not inherit the old one's history.

Each thread keeps a list of the locks it holds, so that it can add an edge from
each of them when it acquires another lock. This list identified a held lock
by the graph id that was looked up when the lock was acquired, and
ForgetDeadlockInfo() makes that id stale. So, before this change, if any thread
called ForgetDeadlockInfo() on a Mutex while some thread held it:

- The hold was ignored for lock ordering until it was released.
- unlock() looked up the entry by a newly assigned id, so it never removed the
  entry. After 40 leaked entries the list was full, and the detector silently
  stopped checking that thread. For example, if a thread held a Mutex 50
  times, and each time another thread forgot it, a later a -> b, b -> a
  inversion on the first thread was not reported.
- AssertNotHeld() compared a new id with the stale one, so it passed although
  the thread held the Mutex.

These effects were accidental. This change identifies held locks by Mutex*
instead. ForgetDeadlockInfo() still removes the Mutex's graph node, and now:

- If the calling thread holds the Mutex, that hold is still ignored for lock
  ordering until it is released. A new per-entry flag marks such holds.
- Holds by other threads keep counting. When such a thread next acquires
  another lock, the detector looks up the Mutex's new graph id and records the
  edge. This includes the later hold of a thread that was blocked in lock(), or
  waiting in CondVar::Wait(), when the Mutex was forgotten.
- unlock() always removes the entry, so the thread keeps being checked.
- ~Mutex() also removes any entry for the Mutex on the calling thread, since a
  Mutex destroyed while locked is never unlocked. Previously, destroying 40
  locked Mutexes on a thread (as in Mutex.LockedMutexDestructionBug) filled the
  list and disabled deadlock detection on that thread for the rest of the
  process.
- AssertNotHeld() fails for any Mutex that the thread holds, even after
  ForgetDeadlockInfo().

These rules do not depend on when a graph id was looked up. This lets a
follow-up change look up graph ids only for nested locking, without changing
behavior.

As a side effect, unlock() and AssertNotHeld() no longer look up a graph id, so
they no longer take deadlock_graph_mu or create graph nodes. (Before, unlock()
even created a new node for a forgotten Mutex.) So a lock()/unlock() pair now
takes deadlock_graph_mu once instead of twice. ~Mutex() still takes it once.

Code that calls ForgetDeadlockInfo() on a Mutex that other threads hold may now
get deadlock reports. First, those holds now count. Second, threads that used
to stop being checked after 40 leaked entries keep being checked, which can
also surface real inversions that involve other Mutexes. This mainly affects
code that calls ForgetDeadlockInfo() right before every lock, to turn off
deadlock detection for one Mutex.

PiperOrigin-RevId: 1002421692
2 files changed
tree: be5aa36a960c35fd486ae0c7f79dfdf831cdd3cb
  1. .github/
  2. absl/
  3. ci/
  4. CMake/
  5. .bazelrc
  6. .clang-format
  7. .gitignore
  8. ABSEIL_ISSUE_TEMPLATE.md
  9. AUTHORS
  10. BUILD.bazel
  11. CMakeLists.txt
  12. conanfile.py
  13. CONTRIBUTING.md
  14. create_lts.py
  15. FAQ.md
  16. LICENSE
  17. MODULE.bazel
  18. PrivacyInfo.xcprivacy
  19. README.md
  20. UPGRADES.md
README.md

Abseil - C++ Common Libraries

The repository contains the Abseil C++ library code. Abseil is an open-source collection of C++ code (compliant to C++17) designed to augment the C++ standard library.

Table of Contents

About Abseil

Abseil is an open-source collection of C++ library code designed to augment the C++ standard library. The Abseil library code is collected from Google's own C++ code base, has been extensively tested and used in production, and is the same code we depend on in our daily coding lives.

In some cases, Abseil provides pieces missing from the C++ standard; in others, Abseil provides alternatives to the standard for special needs we've found through usage in the Google code base. We denote those cases clearly within the library code we provide you.

Abseil is not meant to be a competitor to the standard library; we've just found that many of these utilities serve a purpose within our code base, and we now want to provide those resources to the C++ community as a whole.

Quickstart

If you want to just get started, make sure you at least run through the Abseil Quickstart. The Quickstart contains information about setting up your development environment, downloading the Abseil code, running tests, and getting a simple binary working.

Building Abseil

Bazel and CMake are the official build systems for Abseil. See the quickstart for more information on building Abseil using the Bazel build system. If you require CMake support, please check the CMake build instructions and CMake Quickstart.

Support

Abseil follows Google's Foundational C++ Support Policy. See this table for a list of currently supported versions compilers, platforms, and build tools.

Codemap

Abseil contains the following C++ library components:

  • base
    The base library contains initialization code and other code which all other Abseil code depends on. Code within base may not depend on any other code (other than the C++ standard library).
  • algorithm
    The algorithm library contains additions to the C++ <algorithm> library and container-based versions of such algorithms.
  • cleanup
    The cleanup library contains the control-flow-construct-like type absl::Cleanup which is used for executing a callback on scope exit.
  • container
    The container library contains additional STL-style containers, including Abseil's unordered “Swiss table” containers.
  • crc The crc library contains code for computing error-detecting cyclic redundancy checks on data.
  • debugging
    The debugging library contains code useful for enabling leak checks, and stacktrace and symbolization utilities.
  • flags
    The flags library contains code for handling command line flags for libraries and binaries built with Abseil.
  • hash
    The hash library contains the hashing framework and default hash functor implementations for hashable types in Abseil.
  • log
    The log library contains LOG and CHECK macros and facilities for writing logged messages out to disk, stderr, or user-extensible destinations.
  • memory
    The memory library contains memory management facilities that augment C++'s <memory> library.
  • meta
    The meta library contains type checks similar to those available in the C++ <type_traits> library.
  • numeric
    The numeric library contains 128-bit integer types as well as implementations of C++20's bitwise math functions.
  • profiling
    The profiling library contains utility code for profiling C++ entities. It is currently a private dependency of other Abseil libraries.
  • random
    The random library contains functions for generating pseudorandom values.
  • status
    The status library contains abstractions for error handling, specifically absl::Status and absl::StatusOr<T>.
  • strings
    The strings library contains a variety of strings routines and utilities.
  • synchronization
    The synchronization library contains concurrency primitives (Abseil's absl::Mutex class, an alternative to std::mutex) and a variety of synchronization abstractions.
  • time
    The time library contains abstractions for computing with absolute points in time, durations of time, and formatting and parsing time within time zones.
  • types
    The types library contains non-container utility types.
  • utility
    The utility library contains utility and helper code.

Releases

Abseil recommends users “live-at-head” (update to the latest commit from the master branch as often as possible). However, we realize this philosophy doesn't work for every project, so we also provide Long Term Support Releases to which we backport fixes for severe bugs. See our release management document for more details.

License

The Abseil C++ library is licensed under the terms of the Apache license. See LICENSE for more information.

Links

For more information about Abseil: