mirror of
https://github.com/torvalds/linux.git
synced 2026-05-12 16:18:45 +02:00
0d24f65e93
Proper documentation for the design and usage of sequence counters and
sequential locks does not exist. Complete the seqlock.h documentation as
follows:
- Divide all documentation on a seqcount_t vs. seqlock_t basis. The
description for both mechanisms was intermingled, which is incorrect
since the usage constrains for each type are vastly different.
- Add an introductory paragraph describing the internal design of, and
rationale for, sequence counters.
- Document seqcount_t writer non-preemptibility requirement, which was
not previously documented anywhere, and provide a clear rationale.
- Provide template code for seqcount_t and seqlock_t initialization
and reader/writer critical sections.
- Recommend using seqlock_t by default. It implicitly handles the
serialization and non-preemptibility requirements of writers.
At seqlock.h:
- Remove references to brlocks as they've long been removed from the
kernel.
- Remove references to gcc-3.x since the kernel's minimum supported
gcc version is 4.9.
References:
|
||
|---|---|---|
| .. | ||
| futex-requeue-pi.rst | ||
| hwspinlock.rst | ||
| index.rst | ||
| lockdep-design.rst | ||
| lockstat.rst | ||
| locktorture.rst | ||
| locktypes.rst | ||
| mutex-design.rst | ||
| percpu-rw-semaphore.rst | ||
| pi-futex.rst | ||
| preempt-locking.rst | ||
| robust-futex-ABI.rst | ||
| robust-futexes.rst | ||
| rt-mutex-design.rst | ||
| rt-mutex.rst | ||
| seqlock.rst | ||
| spinlocks.rst | ||
| ww-mutex-design.rst | ||