include/linux/seqlock.h

33  * via seqcount_t under KCSAN: upon beginning a seq-reader critical section,
50  * entering the write section.
125  * that the write side critical section is properly serialized.
146  * until the end of its writer serialization lock critical section.
165  * that the write side critical section is properly serialized.
316  * __read_seqcount_begin() - begin a seqcount_t read section w/o barrier
322  * protected in this critical section.
341  * raw_read_seqcount_begin() - begin a seqcount_t read section w/o lockdep
355  * read_seqcount_begin() - begin a seqcount_t read critical section
370  * raw_read_seqcount opens a read critical section of the given
387  * raw_seqcount_begin() - begin a seqcount_t read critical section w/o
391  * raw_seqcount_begin opens a read critical section of the given
395  * section instead of stabilizing at the beginning of it.
397  * Use this only in special kernel hot paths where the read section is
413  * __read_seqcount_retry() - end a seqcount_t read section w/o barrier
420  * protected in this critical section.
425  * Return: true if a read section retry is required, else false
437  * read_seqcount_retry() - end a seqcount_t read critical section
441  * read_seqcount_retry closes the read critical section of given
442  * seqcount_t.  If the critical section was invalid, it must be ignored
445  * Return: true if a read section retry is required, else false
457  * raw_write_seqcount_begin() - start a seqcount_t write section w/o lockdep
476  * raw_write_seqcount_end() - end a seqcount_t write section w/o lockdep
495  * write_seqcount_begin_nested() - start a seqcount_t write section with
519  * write_seqcount_begin() - start a seqcount_t write side critical section
522  * write_seqcount_begin opens a write side critical section of the given
545  * write_seqcount_end() - end a seqcount_t write side critical section
548  * The write section must've been opened with write_seqcount_begin().
575  * meant to propagate to the reader critical section. This is necessary because
577  * critical section that would ensure readers are aware of ongoing writes::
641  * typically NMIs, to safely interrupt the write side critical section.
688  * read_seqcount_latch_retry() - end a seqcount_latch_t read section
692  * Return: true if a read section retry is required, else false
831  * read_seqbegin() - start a seqlock_t read side critical section
846  * read_seqretry() - end a seqlock_t read side section
850  * read_seqretry closes the read side critical section of given seqlock_t.
851  * If the critical section was invalid, it must be ignored (and typically
854  * Return: true if a read section retry is required, else false
860 	 * completing read critical section.  in read_seqretry()
874  * write_seqlock() - start a seqlock_t write side critical section
877  * write_seqlock opens a write side critical section for the given
882  * Context: if the seqlock_t read section, or other write side critical
893  * write_sequnlock() - end a seqlock_t write side critical section
897  * critical section of given seqlock_t.
906  * write_seqlock_bh() - start a softirqs-disabled seqlock_t write section
909  * _bh variant of write_seqlock(). Use only if the read side section, or
919  * write_sequnlock_bh() - end a softirqs-disabled seqlock_t write section
923  * softirqs-disabled, seqlock_t write side critical section opened with
933  * write_seqlock_irq() - start a non-interruptible seqlock_t write section
936  * _irq variant of write_seqlock(). Use only if the read side section, or
946  * write_sequnlock_irq() - end a non-interruptible seqlock_t write section
950  * seqlock_t write side section opened with write_seqlock_irq().
969  *                           section
975  * section, or other write sections, can be invoked from hardirq context.
982  *                                section
987  * seqlock_t write section previously opened with write_seqlock_irqsave().
997  * read_seqlock_excl() - begin a seqlock_t locking reader section
1000  * read_seqlock_excl opens a seqlock_t locking reader critical section.  A
1006  * Context: if the seqlock_t write section, *or other read sections*, can
1010  * The opened read section must be closed with read_sequnlock_excl().
1018  * read_sequnlock_excl() - end a seqlock_t locking reader critical section
1027  * read_seqlock_excl_bh() - start a seqlock_t locking reader section with
1032  * seqlock_t write side section, *or other read sections*, can be invoked
1042  *			      reader section
1052  *			     reader section
1056  * write side section, *or other read sections*, can be invoked from a
1066  *                             locking reader section
1084  *				 locking reader section
1090  * write side section, *or other read sections*, can be invoked from a
1098  *				      locking reader section
1119  * lockless seqlock_t read section first.  If an odd counter is found, the
1127  * Context: if the seqlock_t write section, *or other read sections*, can
1135  * value must be checked with need_seqretry(). If the read section need to
1148  * need_seqretry() - validate seqlock_t "locking or lockless" read section
1152  * Return: true if a read section retry is required, false otherwise
1160  * done_seqretry() - end seqlock_t "locking or lockless" reader section
1164  * done_seqretry finishes the seqlock_t read side critical section started
1180  * the seqlock_t write section, *or other read sections*, can be invoked
1208  *				non-interruptible locking reader section
1214  * This is the _irqrestore variant of done_seqretry(). The read section