/* SPDX-License-Identifier: GPL-2.0 */ #ifndef _LINUX_MINMAX_H #define _LINUX_MINMAX_H #include <linux/build_bug.h> #include <linux/compiler.h> #include <linux/const.h> #include <linux/types.h> /* * min()/max()/clamp() macros must accomplish three things: * * - Avoid multiple evaluations of the arguments (so side-effects like * "x++" happen only once) when non-constant. * - Retain result as a constant expressions when called with only * constant expressions (to avoid tripping VLA warnings in stack * allocation usage). * - Perform signed v unsigned type-checking (to generate compile * errors instead of nasty runtime surprises). * - Unsigned char/short are always promoted to signed int and can be * compared against signed or unsigned arguments. * - Unsigned arguments can be compared against non-negative signed constants. * - Comparison of a signed argument against an unsigned constant fails * even if the constant is below __INT_MAX__ and could be cast to int. */ #define __typecheck(x, y) … /* * __sign_use for integer expressions: * bit #0 set if ok for unsigned comparisons * bit #1 set if ok for signed comparisons * * In particular, statically non-negative signed integer * expressions are ok for both. * * NOTE! Unsigned types smaller than 'int' are implicitly * converted to 'int' in expressions, and are accepted for * signed conversions for now. This is debatable. * * Note that 'x' is the original expression, and 'ux' is * the unique variable that contains the value. * * We use 'ux' for pure type checking, and 'x' for when * we need to look at the value (but without evaluating * it for side effects! Careful to only ever evaluate it * with sizeof() or __builtin_constant_p() etc). * * Pointers end up being checked by the normal C type * rules at the actual comparison, and these expressions * only need to be careful to not cause warnings for * pointer use. */ #define __signed_type_use(x,ux) … #define __unsigned_type_use(x,ux) … #define __sign_use(x,ux) … /* * To avoid warnings about casting pointers to integers * of different sizes, we need that special sign type. * * On 64-bit we can just always use 'long', since any * integer or pointer type can just be cast to that. * * This does not work for 128-bit signed integers since * the cast would truncate them, but we do not use s128 * types in the kernel (we do use 'u128', but they will * be handled by the !is_signed_type() case). * * NOTE! The cast is there only to avoid any warnings * from when values that aren't signed integer types. */ #ifdef CONFIG_64BIT #define __signed_type(ux) … #else #define __signed_type … #endif #define __is_nonneg(x,ux) … #define __types_ok(x,y,ux,uy) … #define __types_ok3(x,y,z,ux,uy,uz) … #define __cmp_op_min … #define __cmp_op_max … #define __cmp(op, x, y) … #define __cmp_once_unique(op, type, x, y, ux, uy) … #define __cmp_once(op, type, x, y) … #define __careful_cmp_once(op, x, y, ux, uy) … #define __careful_cmp(op, x, y) … #define __clamp(val, lo, hi) … #define __clamp_once(val, lo, hi, uval, ulo, uhi) … #define __careful_clamp(val, lo, hi) … /** * min - return minimum of two values of the same or compatible types * @x: first value * @y: second value */ #define min(x, y) … /** * max - return maximum of two values of the same or compatible types * @x: first value * @y: second value */ #define max(x, y) … /** * umin - return minimum of two non-negative values * Signed types are zero extended to match a larger unsigned type. * @x: first value * @y: second value */ #define umin(x, y) … /** * umax - return maximum of two non-negative values * @x: first value * @y: second value */ #define umax(x, y) … #define __careful_op3(op, x, y, z, ux, uy, uz) … /** * min3 - return minimum of three values * @x: first value * @y: second value * @z: third value */ #define min3(x, y, z) … /** * max3 - return maximum of three values * @x: first value * @y: second value * @z: third value */ #define max3(x, y, z) … /** * min_not_zero - return the minimum that is _not_ zero, unless both are zero * @x: value1 * @y: value2 */ #define min_not_zero(x, y) … /** * clamp - return a value clamped to a given range with strict typechecking * @val: current value * @lo: lowest allowable value * @hi: highest allowable value * * This macro does strict typechecking of @lo/@hi to make sure they are of the * same type as @val. See the unnecessary pointer comparisons. */ #define clamp(val, lo, hi) … /* * ..and if you can't take the strict * types, you can specify one yourself. * * Or not use min/max/clamp at all, of course. */ /** * min_t - return minimum of two values, using the specified type * @type: data type to use * @x: first value * @y: second value */ #define min_t(type, x, y) … /** * max_t - return maximum of two values, using the specified type * @type: data type to use * @x: first value * @y: second value */ #define max_t(type, x, y) … /* * Do not check the array parameter using __must_be_array(). * In the following legit use-case where the "array" passed is a simple pointer, * __must_be_array() will return a failure. * --- 8< --- * int *buff * ... * min = min_array(buff, nb_items); * --- 8< --- * * The first typeof(&(array)[0]) is needed in order to support arrays of both * 'int *buff' and 'int buff[N]' types. * * The array can be an array of const items. * typeof() keeps the const qualifier. Use __unqual_scalar_typeof() in order * to discard the const qualifier for the __element variable. */ #define __minmax_array(op, array, len) … /** * min_array - return minimum of values present in an array * @array: array * @len: array length * * Note that @len must not be zero (empty array). */ #define min_array(array, len) … /** * max_array - return maximum of values present in an array * @array: array * @len: array length * * Note that @len must not be zero (empty array). */ #define max_array(array, len) … /** * clamp_t - return a value clamped to a given range using a given type * @type: the type of variable to use * @val: current value * @lo: minimum allowable value * @hi: maximum allowable value * * This macro does no typechecking and uses temporary variables of type * @type to make all the comparisons. */ #define clamp_t(type, val, lo, hi) … /** * clamp_val - return a value clamped to a given range using val's type * @val: current value * @lo: minimum allowable value * @hi: maximum allowable value * * This macro does no typechecking and uses temporary variables of whatever * type the input argument @val is. This is useful when @val is an unsigned * type and @lo and @hi are literals that will otherwise be assigned a signed * integer type. */ #define clamp_val(val, lo, hi) … static inline bool in_range64(u64 val, u64 start, u64 len) { … } static inline bool in_range32(u32 val, u32 start, u32 len) { … } /** * in_range - Determine if a value lies within a range. * @val: Value to test. * @start: First value in range. * @len: Number of values in range. * * This is more efficient than "if (start <= val && val < (start + len))". * It also gives a different answer if @start + @len overflows the size of * the type by a sufficient amount to encompass @val. Decide for yourself * which behaviour you want, or prove that start + len never overflow. * Do not blindly replace one form with the other. */ #define in_range(val, start, len) … /** * swap - swap values of @a and @b * @a: first value * @b: second value */ #define swap(a, b) … /* * Use these carefully: no type checking, and uses the arguments * multiple times. Use for obvious constants only. */ #define MIN(a,b) … #define MAX(a,b) … #define MIN_T(type,a,b) … #define MAX_T(type,a,b) … #endif /* _LINUX_MINMAX_H */
Codebase Browser
linux