Commit e876695a authored by I Hsin Cheng's avatar I Hsin Cheng Committed by Yury Norov
Browse files

cpumask: Rephrase comments for cpumask_any*() APIs 



The cpumask_any*() APIs comment states that it returns a "random" cpu
within the given cpumask. However it's not actually random as random
itself stands a meaning for uniform distribution.

cpumask_any*() APIs are a naming convention for the caller to states that
it doesn't care which CPU it gets, so change "random" to "arbitrary" would
be more appropriate.

CC: Mark Rutland <mark.rutland@arm.com>
Signed-off-by: default avatarI Hsin Cheng <richard120310@gmail.com>
Reviewed-by: default avatarKuan-Wei Chiu <visitorckw@gmail.com>
Signed-off-by: default avatarYury Norov <yury.norov@gmail.com>
parent 7f15d4ab

include/linux/cpumask.h

+4 −4
Original line number Diff line number Diff line
@@ -391,7 +391,7 @@ unsigned int __pure cpumask_next_wrap(int n, const struct cpumask *mask, int sta 
	for_each_set_bit_from(cpu, cpumask_bits(mask), small_cpumask_bits)



/**

 * cpumask_any_but - return a "random" in a cpumask, but not this one.

 * cpumask_any_but - return an arbitrary cpu in a cpumask, but not this one.

 * @mask: the cpumask to search

 * @cpu: the cpu to ignore.

 *
@@ -411,7 +411,7 @@ unsigned int cpumask_any_but(const struct cpumask *mask, unsigned int cpu) 
}



/**

 * cpumask_any_and_but - pick a "random" cpu from *mask1 & *mask2, but not this one.

 * cpumask_any_and_but - pick an arbitrary cpu from *mask1 & *mask2, but not this one.

 * @mask1: the first input cpumask

 * @mask2: the second input cpumask

 * @cpu: the cpu to ignore
@@ -840,7 +840,7 @@ void cpumask_copy(struct cpumask *dstp, const struct cpumask *srcp) 
}



/**

 * cpumask_any - pick a "random" cpu from *srcp

 * cpumask_any - pick an arbitrary cpu from *srcp

 * @srcp: the input cpumask

 *

 * Return: >= nr_cpu_ids if no cpus set.
@@ -848,7 +848,7 @@ void cpumask_copy(struct cpumask *dstp, const struct cpumask *srcp) 
#define cpumask_any(srcp) cpumask_first(srcp)



/**

 * cpumask_any_and - pick a "random" cpu from *mask1 & *mask2

 * cpumask_any_and - pick an arbitrary cpu from *mask1 & *mask2

 * @mask1: the first input cpumask

 * @mask2: the second input cpumask

 *