kernel.h 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  1. #ifndef _LINUX_KERNEL_H
  2. #define _LINUX_KERNEL_H
  3. #include <linux/types.h>
  4. #include <linux/printk.h> /* for printf/pr_* utilities */
  5. #define USHRT_MAX ((u16)(~0U))
  6. #define SHRT_MAX ((s16)(USHRT_MAX>>1))
  7. #define SHRT_MIN ((s16)(-SHRT_MAX - 1))
  8. #define INT_MAX ((int)(~0U>>1))
  9. #define INT_MIN (-INT_MAX - 1)
  10. #define UINT_MAX (~0U)
  11. #define LONG_MAX ((long)(~0UL>>1))
  12. #define LONG_MIN (-LONG_MAX - 1)
  13. #define ULONG_MAX (~0UL)
  14. #define LLONG_MAX ((long long)(~0ULL>>1))
  15. #define LLONG_MIN (-LLONG_MAX - 1)
  16. #define ULLONG_MAX (~0ULL)
  17. #ifndef SIZE_MAX
  18. #define SIZE_MAX (~(size_t)0)
  19. #endif
  20. #ifndef SSIZE_MAX
  21. #define SSIZE_MAX ((ssize_t)(SIZE_MAX >> 1))
  22. #endif
  23. #define U8_MAX ((u8)~0U)
  24. #define S8_MAX ((s8)(U8_MAX>>1))
  25. #define S8_MIN ((s8)(-S8_MAX - 1))
  26. #define U16_MAX ((u16)~0U)
  27. #define S16_MAX ((s16)(U16_MAX>>1))
  28. #define S16_MIN ((s16)(-S16_MAX - 1))
  29. #define U32_MAX ((u32)~0U)
  30. #define S32_MAX ((s32)(U32_MAX>>1))
  31. #define S32_MIN ((s32)(-S32_MAX - 1))
  32. #define U64_MAX ((u64)~0ULL)
  33. #define S64_MAX ((s64)(U64_MAX>>1))
  34. #define S64_MIN ((s64)(-S64_MAX - 1))
  35. /* Aliases defined by stdint.h */
  36. #define UINT32_MAX U32_MAX
  37. #define UINT64_MAX U64_MAX
  38. #define INT32_MAX S32_MAX
  39. #define STACK_MAGIC 0xdeadbeef
  40. #define REPEAT_BYTE(x) ((~0ul / 0xff) * (x))
  41. #define ALIGN(x,a) __ALIGN_MASK((x),(typeof(x))(a)-1)
  42. #define ALIGN_DOWN(x, a) ALIGN((x) - ((a) - 1), (a))
  43. #define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
  44. #define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
  45. #define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
  46. #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  47. /*
  48. * This looks more complex than it should be. But we need to
  49. * get the type for the ~ right in round_down (it needs to be
  50. * as wide as the result!), and we want to evaluate the macro
  51. * arguments just once each.
  52. */
  53. #define __round_mask(x, y) ((__typeof__(x))((y)-1))
  54. #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
  55. #define round_down(x, y) ((x) & ~__round_mask(x, y))
  56. #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
  57. #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  58. #define DIV_ROUND_DOWN_ULL(ll, d) \
  59. ({ unsigned long long _tmp = (ll); do_div(_tmp, d); _tmp; })
  60. #define DIV_ROUND_UP_ULL(ll, d) DIV_ROUND_DOWN_ULL((ll) + (d) - 1, (d))
  61. #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
  62. #if BITS_PER_LONG == 32
  63. # define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP_ULL(ll, d)
  64. #else
  65. # define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP(ll,d)
  66. #endif
  67. /* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
  68. #define roundup(x, y) ( \
  69. { \
  70. const typeof(y) __y = y; \
  71. (((x) + (__y - 1)) / __y) * __y; \
  72. } \
  73. )
  74. #define rounddown(x, y) ( \
  75. { \
  76. typeof(x) __x = (x); \
  77. __x - (__x % (y)); \
  78. } \
  79. )
  80. /*
  81. * Divide positive or negative dividend by positive divisor and round
  82. * to closest integer. Result is undefined for negative divisors and
  83. * for negative dividends if the divisor variable type is unsigned.
  84. */
  85. #define DIV_ROUND_CLOSEST(x, divisor)( \
  86. { \
  87. typeof(x) __x = x; \
  88. typeof(divisor) __d = divisor; \
  89. (((typeof(x))-1) > 0 || \
  90. ((typeof(divisor))-1) > 0 || (__x) > 0) ? \
  91. (((__x) + ((__d) / 2)) / (__d)) : \
  92. (((__x) - ((__d) / 2)) / (__d)); \
  93. } \
  94. )
  95. /*
  96. * Same as above but for u64 dividends. divisor must be a 32-bit
  97. * number.
  98. */
  99. #define DIV_ROUND_CLOSEST_ULL(x, divisor)( \
  100. { \
  101. typeof(divisor) __d = divisor; \
  102. unsigned long long _tmp = (x) + (__d) / 2; \
  103. do_div(_tmp, __d); \
  104. _tmp; \
  105. } \
  106. )
  107. /*
  108. * Multiplies an integer by a fraction, while avoiding unnecessary
  109. * overflow or loss of precision.
  110. */
  111. #define mult_frac(x, numer, denom)( \
  112. { \
  113. typeof(x) quot = (x) / (denom); \
  114. typeof(x) rem = (x) % (denom); \
  115. (quot * (numer)) + ((rem * (numer)) / (denom)); \
  116. } \
  117. )
  118. /**
  119. * upper_32_bits - return bits 32-63 of a number
  120. * @n: the number we're accessing
  121. *
  122. * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
  123. * the "right shift count >= width of type" warning when that quantity is
  124. * 32-bits.
  125. */
  126. #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
  127. /**
  128. * lower_32_bits - return bits 0-31 of a number
  129. * @n: the number we're accessing
  130. */
  131. #define lower_32_bits(n) ((u32)(n))
  132. /*
  133. * abs() handles unsigned and signed longs, ints, shorts and chars. For all
  134. * input types abs() returns a signed long.
  135. * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
  136. * for those.
  137. */
  138. #define abs(x) ({ \
  139. long ret; \
  140. if (sizeof(x) == sizeof(long)) { \
  141. long __x = (x); \
  142. ret = (__x < 0) ? -__x : __x; \
  143. } else { \
  144. int __x = (x); \
  145. ret = (__x < 0) ? -__x : __x; \
  146. } \
  147. ret; \
  148. })
  149. #define abs64(x) ({ \
  150. s64 __x = (x); \
  151. (__x < 0) ? -__x : __x; \
  152. })
  153. /*
  154. * min()/max()/clamp() macros that also do
  155. * strict type-checking.. See the
  156. * "unnecessary" pointer comparison.
  157. */
  158. #define min(x, y) ({ \
  159. typeof(x) _min1 = (x); \
  160. typeof(y) _min2 = (y); \
  161. (void) (&_min1 == &_min2); \
  162. _min1 < _min2 ? _min1 : _min2; })
  163. #define max(x, y) ({ \
  164. typeof(x) _max1 = (x); \
  165. typeof(y) _max2 = (y); \
  166. (void) (&_max1 == &_max2); \
  167. _max1 > _max2 ? _max1 : _max2; })
  168. #define min3(x, y, z) min((typeof(x))min(x, y), z)
  169. #define max3(x, y, z) max((typeof(x))max(x, y), z)
  170. /**
  171. * min_not_zero - return the minimum that is _not_ zero, unless both are zero
  172. * @x: value1
  173. * @y: value2
  174. */
  175. #define min_not_zero(x, y) ({ \
  176. typeof(x) __x = (x); \
  177. typeof(y) __y = (y); \
  178. __x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })
  179. /**
  180. * clamp - return a value clamped to a given range with strict typechecking
  181. * @val: current value
  182. * @lo: lowest allowable value
  183. * @hi: highest allowable value
  184. *
  185. * This macro does strict typechecking of lo/hi to make sure they are of the
  186. * same type as val. See the unnecessary pointer comparisons.
  187. */
  188. #define clamp(val, lo, hi) min((typeof(val))max(val, lo), hi)
  189. /*
  190. * ..and if you can't take the strict
  191. * types, you can specify one yourself.
  192. *
  193. * Or not use min/max/clamp at all, of course.
  194. */
  195. #define min_t(type, x, y) ({ \
  196. type __min1 = (x); \
  197. type __min2 = (y); \
  198. __min1 < __min2 ? __min1: __min2; })
  199. #define max_t(type, x, y) ({ \
  200. type __max1 = (x); \
  201. type __max2 = (y); \
  202. __max1 > __max2 ? __max1: __max2; })
  203. /**
  204. * clamp_t - return a value clamped to a given range using a given type
  205. * @type: the type of variable to use
  206. * @val: current value
  207. * @lo: minimum allowable value
  208. * @hi: maximum allowable value
  209. *
  210. * This macro does no typechecking and uses temporary variables of type
  211. * 'type' to make all the comparisons.
  212. */
  213. #define clamp_t(type, val, lo, hi) min_t(type, max_t(type, val, lo), hi)
  214. /**
  215. * clamp_val - return a value clamped to a given range using val's type
  216. * @val: current value
  217. * @lo: minimum allowable value
  218. * @hi: maximum allowable value
  219. *
  220. * This macro does no typechecking and uses temporary variables of whatever
  221. * type the input argument 'val' is. This is useful when val is an unsigned
  222. * type and min and max are literals that will otherwise be assigned a signed
  223. * integer type.
  224. */
  225. #define clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi)
  226. /*
  227. * swap - swap value of @a and @b
  228. */
  229. #define swap(a, b) \
  230. do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
  231. /**
  232. * container_of - cast a member of a structure out to the containing structure
  233. * @ptr: the pointer to the member.
  234. * @type: the type of the container struct this is embedded in.
  235. * @member: the name of the member within the struct.
  236. *
  237. */
  238. #define container_of(ptr, type, member) ({ \
  239. const typeof( ((type *)0)->member ) *__mptr = (ptr); \
  240. (type *)( (char *)__mptr - offsetof(type,member) );})
  241. /*
  242. * check_member() - Check the offset of a structure member
  243. *
  244. * @structure: Name of structure (e.g. global_data)
  245. * @member: Name of member (e.g. baudrate)
  246. * @offset: Expected offset in bytes
  247. */
  248. #define check_member(structure, member, offset) _Static_assert( \
  249. offsetof(struct structure, member) == (offset), \
  250. "`struct " #structure "` offset for `" #member "` is not " #offset)
  251. #endif