| /* |
| * This file is part of the coreboot project. |
| * |
| * This program is free software; you can redistribute it and/or modify |
| * it under the terms of the GNU General Public License as published by |
| * the Free Software Foundation; version 2 of the License. |
| * |
| * This program is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| * GNU General Public License for more details. |
| */ |
| |
| #ifndef COMMONLIB_HELPERS_H |
| #define COMMONLIB_HELPERS_H |
| /* This file is for helpers for both coreboot firmware and its utilities. */ |
| |
| #ifndef __ASSEMBLER__ |
| #include <commonlib/compiler.h> |
| #include <stddef.h> |
| #endif |
| |
| #ifndef ARRAY_SIZE |
| #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) |
| #endif |
| |
| #define ALIGN(x, a) __ALIGN_MASK(x, (__typeof__(x))(a)-1UL) |
| #define __ALIGN_MASK(x, mask) (((x)+(mask))&~(mask)) |
| #define ALIGN_UP(x, a) ALIGN((x), (a)) |
| #define ALIGN_DOWN(x, a) ((x) & ~((__typeof__(x))(a)-1UL)) |
| #define IS_ALIGNED(x, a) (((x) & ((__typeof__(x))(a)-1UL)) == 0) |
| |
| /* Double-evaluation unsafe min/max, for bitfields and outside of functions */ |
| #define __CMP_UNSAFE(a, b, op) ((a) op (b) ? (a) : (b)) |
| #define MIN_UNSAFE(a, b) __CMP_UNSAFE(a, b, <) |
| #define MAX_UNSAFE(a, b) __CMP_UNSAFE(a, b, >) |
| |
| #define __CMP_SAFE(a, b, op, var_a, var_b) ({ \ |
| __TYPEOF_UNLESS_CONST(a, b) var_a = (a); \ |
| __TYPEOF_UNLESS_CONST(b, a) var_b = (b); \ |
| var_a op var_b ? var_a : var_b; \ |
| }) |
| |
| #ifdef __ROMCC__ /* romcc doesn't support __builtin_choose_expr() */ |
| #define __CMP(a, b, op) __CMP_UNSAFE(a, b, op) |
| #else |
| #define __CMP(a, b, op) __builtin_choose_expr( \ |
| __builtin_constant_p(a) && __builtin_constant_p(b), \ |
| __CMP_UNSAFE(a, b, op), __CMP_SAFE(a, b, op, __TMPNAME, __TMPNAME)) |
| #endif |
| |
| #ifndef MIN |
| #define MIN(a, b) __CMP(a, b, <) |
| #endif |
| #ifndef MAX |
| #define MAX(a, b) __CMP(a, b, >) |
| #endif |
| |
| #ifndef ABS |
| #define ABS(a) ({ \ |
| __typeof__(a) _abs_local_a = (a); \ |
| (_abs_local_a < 0) ? (-_abs_local_a) : _abs_local_a; \ |
| }) |
| #endif |
| |
| #define IS_POWER_OF_2(x) ({ \ |
| __typeof__(x) _power_local_x = (x); \ |
| (_power_local_x & (_power_local_x - 1)) == 0; \ |
| }) |
| |
| #define DIV_ROUND_UP(x, y) ({ \ |
| __typeof__(x) _div_local_x = (x); \ |
| __typeof__(y) _div_local_y = (y); \ |
| (_div_local_x + _div_local_y - 1) / _div_local_y; \ |
| }) |
| |
| #define SWAP(a, b) do { \ |
| __typeof__(&(a)) _swap_local_a = &(a); \ |
| __typeof__(&(b)) _swap_local_b = &(b); \ |
| __typeof__(a) _swap_local_tmp = *_swap_local_a; \ |
| *_swap_local_a = *_swap_local_b; \ |
| *_swap_local_b = _swap_local_tmp; \ |
| } while (0) |
| |
| /* |
| * Divide positive or negative dividend by positive divisor and round |
| * to closest integer. Result is undefined for negative divisors and |
| * for negative dividends if the divisor variable type is unsigned. |
| */ |
| #define DIV_ROUND_CLOSEST(x, divisor)({ \ |
| __typeof__(x) _div_local_x = (x); \ |
| __typeof__(divisor) _div_local_d = (divisor); \ |
| (((__typeof__(x))-1) > 0 || \ |
| ((__typeof__(divisor))-1) > 0 || (_div_local_x) > 0) ? \ |
| ((_div_local_x + (_div_local_d / 2)) / _div_local_d) : \ |
| ((_div_local_x - (_div_local_d / 2)) / _div_local_d); \ |
| }) |
| |
| /* Standard units. */ |
| #define KiB (1<<10) |
| #define MiB (1<<20) |
| #define GiB (1<<30) |
| /* Could we ever run into this one? I hope we get this much memory! */ |
| #define TiB (1<<40) |
| |
| #define KHz (1000) |
| #define MHz (1000 * KHz) |
| #define GHz (1000 * MHz) |
| |
| #ifndef offsetof |
| #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER) |
| #endif |
| |
| #if !defined(__clang__) |
| #define check_member(structure, member, offset) _Static_assert( \ |
| offsetof(struct structure, member) == offset, \ |
| "`struct " #structure "` offset for `" #member "` is not " #offset) |
| #else |
| #define check_member(structure, member, offset) |
| #endif |
| |
| /** |
| * container_of - cast a member of a structure out to the containing structure |
| * @param ptr: the pointer to the member. |
| * @param type: the type of the container struct this is embedded in. |
| * @param member: the name of the member within the struct. |
| * |
| */ |
| #define container_of(ptr, type, member) ({ \ |
| const __typeof__(((type *)0)->member) *__mptr = (ptr); \ |
| (type *)((char *)__mptr - offsetof(type, member)); }) |
| |
| /* Calculate size of structure member. */ |
| #define member_size(type, member) (sizeof(((type *)0)->member)) |
| |
| #ifndef __unused |
| #define __unused __attribute__((unused)) |
| #endif |
| |
| #endif /* COMMONLIB_HELPERS_H */ |