Commit ef558b4b authored by Mark Rutland's avatar Mark Rutland Committed by Peter Zijlstra
Browse files

locking/atomic: treewide: delete arch_atomic_*() kerneldoc 



Currently several architectures have kerneldoc comments for
arch_atomic_*(), which is unhelpful as these live in a shared namespace
where they clash, and the arch_atomic_*() ops are now an implementation
detail of the raw_atomic_*() ops, which no-one should use those
directly.

Delete the kerneldoc comments for arch_atomic_*(), along with
pseudo-kerneldoc comments which are in the correct style but are missing
the leading '/**' necessary to be true kerneldoc comments.

There should be no functional change as a result of this patch.

Signed-off-by: default avatarMark Rutland <mark.rutland@arm.com>
Signed-off-by: default avatarPeter Zijlstra (Intel) <peterz@infradead.org>
Reviewed-by: default avatarKees Cook <keescook@chromium.org>
Link: https://lore.kernel.org/r/20230605070124.3741859-28-mark.rutland@arm.com
parent e74f4059

arch/alpha/include/asm/atomic.h

+0 −25
Original line number Diff line number Diff line
@@ -200,15 +200,6 @@ ATOMIC_OPS(xor, xor) 
#undef ATOMIC_OP_RETURN

#undef ATOMIC_OP



/**

 * arch_atomic_fetch_add_unless - add unless the number is a given value

 * @v: pointer of type atomic_t

 * @a: the amount to add to v...

 * @u: ...unless v is equal to u.

 *

 * Atomically adds @a to @v, so long as it was not @u.

 * Returns the old value of @v.

 */

static __inline__ int arch_atomic_fetch_add_unless(atomic_t *v, int a, int u)

{

	int c, new, old;
@@ -232,15 +223,6 @@ static __inline__ int arch_atomic_fetch_add_unless(atomic_t *v, int a, int u) 
}

#define arch_atomic_fetch_add_unless arch_atomic_fetch_add_unless



/**

 * arch_atomic64_fetch_add_unless - add unless the number is a given value

 * @v: pointer of type atomic64_t

 * @a: the amount to add to v...

 * @u: ...unless v is equal to u.

 *

 * Atomically adds @a to @v, so long as it was not @u.

 * Returns the old value of @v.

 */

static __inline__ s64 arch_atomic64_fetch_add_unless(atomic64_t *v, s64 a, s64 u)

{

	s64 c, new, old;
@@ -264,13 +246,6 @@ static __inline__ s64 arch_atomic64_fetch_add_unless(atomic64_t *v, s64 a, s64 u 
}

#define arch_atomic64_fetch_add_unless arch_atomic64_fetch_add_unless



/*

 * arch_atomic64_dec_if_positive - decrement by 1 if old value positive

 * @v: pointer of type atomic_t

 *

 * The function returns the old value of *v minus 1, even if

 * the atomic variable, v, was not decremented.

 */

static inline s64 arch_atomic64_dec_if_positive(atomic64_t *v)

{

	s64 old, tmp;

arch/arc/include/asm/atomic64-arcv2.h

+0 −17
Original line number Diff line number Diff line
@@ -182,14 +182,6 @@ static inline s64 arch_atomic64_xchg(atomic64_t *ptr, s64 new) 
}

#define arch_atomic64_xchg arch_atomic64_xchg



/**

 * arch_atomic64_dec_if_positive - decrement by 1 if old value positive

 * @v: pointer of type atomic64_t

 *

 * The function returns the old value of *v minus 1, even if

 * the atomic variable, v, was not decremented.

 */



static inline s64 arch_atomic64_dec_if_positive(atomic64_t *v)

{

	s64 val;
@@ -214,15 +206,6 @@ static inline s64 arch_atomic64_dec_if_positive(atomic64_t *v) 
}

#define arch_atomic64_dec_if_positive arch_atomic64_dec_if_positive



/**

 * arch_atomic64_fetch_add_unless - add unless the number is a given value

 * @v: pointer of type atomic64_t

 * @a: the amount to add to v...

 * @u: ...unless v is equal to u.

 *

 * Atomically adds @a to @v, if it was not @u.

 * Returns the old value of @v

 */

static inline s64 arch_atomic64_fetch_add_unless(atomic64_t *v, s64 a, s64 u)

{

	s64 old, temp;

arch/hexagon/include/asm/atomic.h

+0 −16
Original line number Diff line number Diff line
@@ -28,12 +28,6 @@ static inline void arch_atomic_set(atomic_t *v, int new) 


#define arch_atomic_set_release(v, i)	arch_atomic_set((v), (i))



/**

 * arch_atomic_read - reads a word, atomically

 * @v: pointer to atomic value

 *

 * Assumes all word reads on our architecture are atomic.

 */

#define arch_atomic_read(v)		READ_ONCE((v)->counter)



#define ATOMIC_OP(op)							\
@@ -112,16 +106,6 @@ ATOMIC_OPS(xor) 
#undef ATOMIC_OP_RETURN

#undef ATOMIC_OP



/**

 * arch_atomic_fetch_add_unless - add unless the number is a given value

 * @v: pointer to value

 * @a: amount to add

 * @u: unless value is equal to u

 *

 * Returns old value.

 *

 */



static inline int arch_atomic_fetch_add_unless(atomic_t *v, int a, int u)

{

	int __oldval;

arch/loongarch/include/asm/atomic.h

+0 −49
Original line number Diff line number Diff line
@@ -29,21 +29,7 @@ 


#define ATOMIC_INIT(i)	  { (i) }



/*

 * arch_atomic_read - read atomic variable

 * @v: pointer of type atomic_t

 *

 * Atomically reads the value of @v.

 */

#define arch_atomic_read(v)	READ_ONCE((v)->counter)



/*

 * arch_atomic_set - set atomic variable

 * @v: pointer of type atomic_t

 * @i: required value

 *

 * Atomically sets the value of @v to @i.

 */

#define arch_atomic_set(v, i)	WRITE_ONCE((v)->counter, (i))



#define ATOMIC_OP(op, I, asm_op)					\
@@ -139,14 +125,6 @@ static inline int arch_atomic_fetch_add_unless(atomic_t *v, int a, int u) 
}

#define arch_atomic_fetch_add_unless arch_atomic_fetch_add_unless



/*

 * arch_atomic_sub_if_positive - conditionally subtract integer from atomic variable

 * @i: integer value to subtract

 * @v: pointer of type atomic_t

 *

 * Atomically test @v and subtract @i if @v is greater or equal than @i.

 * The function returns the old value of @v minus @i.

 */

static inline int arch_atomic_sub_if_positive(int i, atomic_t *v)

{

	int result;
@@ -181,28 +159,13 @@ static inline int arch_atomic_sub_if_positive(int i, atomic_t *v) 
	return result;

}



/*

 * arch_atomic_dec_if_positive - decrement by 1 if old value positive

 * @v: pointer of type atomic_t

 */

#define arch_atomic_dec_if_positive(v)	arch_atomic_sub_if_positive(1, v)



#ifdef CONFIG_64BIT



#define ATOMIC64_INIT(i)    { (i) }



/*

 * arch_atomic64_read - read atomic variable

 * @v: pointer of type atomic64_t

 *

 */

#define arch_atomic64_read(v)	READ_ONCE((v)->counter)



/*

 * arch_atomic64_set - set atomic variable

 * @v: pointer of type atomic64_t

 * @i: required value

 */

#define arch_atomic64_set(v, i)	WRITE_ONCE((v)->counter, (i))



#define ATOMIC64_OP(op, I, asm_op)					\
@@ -297,14 +260,6 @@ static inline long arch_atomic64_fetch_add_unless(atomic64_t *v, long a, long u) 
}

#define arch_atomic64_fetch_add_unless arch_atomic64_fetch_add_unless



/*

 * arch_atomic64_sub_if_positive - conditionally subtract integer from atomic variable

 * @i: integer value to subtract

 * @v: pointer of type atomic64_t

 *

 * Atomically test @v and subtract @i if @v is greater or equal than @i.

 * The function returns the old value of @v minus @i.

 */

static inline long arch_atomic64_sub_if_positive(long i, atomic64_t *v)

{

	long result;
@@ -339,10 +294,6 @@ static inline long arch_atomic64_sub_if_positive(long i, atomic64_t *v) 
	return result;

}



/*

 * arch_atomic64_dec_if_positive - decrement by 1 if old value positive

 * @v: pointer of type atomic64_t

 */

#define arch_atomic64_dec_if_positive(v)	arch_atomic64_sub_if_positive(1, v)



#endif /* CONFIG_64BIT */

arch/x86/include/asm/atomic.h

+0 −87
Original line number Diff line number Diff line
@@ -14,12 +14,6 @@ 
 * resource counting etc..

 */



/**

 * arch_atomic_read - read atomic variable

 * @v: pointer of type atomic_t

 *

 * Atomically reads the value of @v.

 */

static __always_inline int arch_atomic_read(const atomic_t *v)

{

	/*
@@ -29,25 +23,11 @@ static __always_inline int arch_atomic_read(const atomic_t *v) 
	return __READ_ONCE((v)->counter);

}



/**

 * arch_atomic_set - set atomic variable

 * @v: pointer of type atomic_t

 * @i: required value

 *

 * Atomically sets the value of @v to @i.

 */

static __always_inline void arch_atomic_set(atomic_t *v, int i)

{

	__WRITE_ONCE(v->counter, i);

}



/**

 * arch_atomic_add - add integer to atomic variable

 * @i: integer value to add

 * @v: pointer of type atomic_t

 *

 * Atomically adds @i to @v.

 */

static __always_inline void arch_atomic_add(int i, atomic_t *v)

{

	asm volatile(LOCK_PREFIX "addl %1,%0"
@@ -55,13 +35,6 @@ static __always_inline void arch_atomic_add(int i, atomic_t *v) 
		     : "ir" (i) : "memory");

}



/**

 * arch_atomic_sub - subtract integer from atomic variable

 * @i: integer value to subtract

 * @v: pointer of type atomic_t

 *

 * Atomically subtracts @i from @v.

 */

static __always_inline void arch_atomic_sub(int i, atomic_t *v)

{

	asm volatile(LOCK_PREFIX "subl %1,%0"
@@ -69,27 +42,12 @@ static __always_inline void arch_atomic_sub(int i, atomic_t *v) 
		     : "ir" (i) : "memory");

}



/**

 * arch_atomic_sub_and_test - subtract value from variable and test result

 * @i: integer value to subtract

 * @v: pointer of type atomic_t

 *

 * Atomically subtracts @i from @v and returns

 * true if the result is zero, or false for all

 * other cases.

 */

static __always_inline bool arch_atomic_sub_and_test(int i, atomic_t *v)

{

	return GEN_BINARY_RMWcc(LOCK_PREFIX "subl", v->counter, e, "er", i);

}

#define arch_atomic_sub_and_test arch_atomic_sub_and_test



/**

 * arch_atomic_inc - increment atomic variable

 * @v: pointer of type atomic_t

 *

 * Atomically increments @v by 1.

 */

static __always_inline void arch_atomic_inc(atomic_t *v)

{

	asm volatile(LOCK_PREFIX "incl %0"
@@ -97,12 +55,6 @@ static __always_inline void arch_atomic_inc(atomic_t *v) 
}

#define arch_atomic_inc arch_atomic_inc



/**

 * arch_atomic_dec - decrement atomic variable

 * @v: pointer of type atomic_t

 *

 * Atomically decrements @v by 1.

 */

static __always_inline void arch_atomic_dec(atomic_t *v)

{

	asm volatile(LOCK_PREFIX "decl %0"
@@ -110,69 +62,30 @@ static __always_inline void arch_atomic_dec(atomic_t *v) 
}

#define arch_atomic_dec arch_atomic_dec



/**

 * arch_atomic_dec_and_test - decrement and test

 * @v: pointer of type atomic_t

 *

 * Atomically decrements @v by 1 and

 * returns true if the result is 0, or false for all other

 * cases.

 */

static __always_inline bool arch_atomic_dec_and_test(atomic_t *v)

{

	return GEN_UNARY_RMWcc(LOCK_PREFIX "decl", v->counter, e);

}

#define arch_atomic_dec_and_test arch_atomic_dec_and_test



/**

 * arch_atomic_inc_and_test - increment and test

 * @v: pointer of type atomic_t

 *

 * Atomically increments @v by 1

 * and returns true if the result is zero, or false for all

 * other cases.

 */

static __always_inline bool arch_atomic_inc_and_test(atomic_t *v)

{

	return GEN_UNARY_RMWcc(LOCK_PREFIX "incl", v->counter, e);

}

#define arch_atomic_inc_and_test arch_atomic_inc_and_test



/**

 * arch_atomic_add_negative - add and test if negative

 * @i: integer value to add

 * @v: pointer of type atomic_t

 *

 * Atomically adds @i to @v and returns true

 * if the result is negative, or false when

 * result is greater than or equal to zero.

 */

static __always_inline bool arch_atomic_add_negative(int i, atomic_t *v)

{

	return GEN_BINARY_RMWcc(LOCK_PREFIX "addl", v->counter, s, "er", i);

}

#define arch_atomic_add_negative arch_atomic_add_negative



/**

 * arch_atomic_add_return - add integer and return

 * @i: integer value to add

 * @v: pointer of type atomic_t

 *

 * Atomically adds @i to @v and returns @i + @v

 */

static __always_inline int arch_atomic_add_return(int i, atomic_t *v)

{

	return i + xadd(&v->counter, i);

}

#define arch_atomic_add_return arch_atomic_add_return



/**

 * arch_atomic_sub_return - subtract integer and return

 * @v: pointer of type atomic_t

 * @i: integer value to subtract

 *

 * Atomically subtracts @i from @v and returns @v - @i

 */

static __always_inline int arch_atomic_sub_return(int i, atomic_t *v)

{

	return arch_atomic_add_return(-i, v);