Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

documentation: atomic_add_unless() doesn't imply mb() on failure

(sorry for being offtpoic, but while experts are here...)

A "typical" implementation of atomic_add_unless() can return 0 immediately
after the first atomic_read() (before doing cmpxchg). In that case it doesn't
provide any barrier semantics. See include/asm-ia64/atomic.h as an example.

We should either change the implementation, or fix the docs.

Signed-off-by: Oleg Nesterov <oleg@tv-sign.ru>
Acked-by: Nick Piggin <npiggin@suse.de>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

authored by

Oleg Nesterov and committed by
Linus Torvalds
02c608c1 2dda81ca

+3 -2
+2 -1
Documentation/atomic_ops.txt
··· 186 186 returns non zero. If v is equal to u then it returns zero. This is done as 187 187 an atomic operation. 188 188 189 - atomic_add_unless requires explicit memory barriers around the operation. 189 + atomic_add_unless requires explicit memory barriers around the operation 190 + unless it fails (returns 0). 190 191 191 192 atomic_inc_not_zero, equivalent to atomic_add_unless(v, 1, 0) 192 193
+1 -1
Documentation/memory-barriers.txt
··· 1493 1493 atomic_dec_and_test(); 1494 1494 atomic_sub_and_test(); 1495 1495 atomic_add_negative(); 1496 - atomic_add_unless(); 1496 + atomic_add_unless(); /* when succeeds (returns 1) */ 1497 1497 test_and_set_bit(); 1498 1498 test_and_clear_bit(); 1499 1499 test_and_change_bit();