kernel.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504
  1. #ifndef _LINUX_KERNEL_H
  2. #define _LINUX_KERNEL_H
  3. /*
  4. * 'kernel.h' contains some often-used function prototypes etc
  5. */
  6. #ifdef __KERNEL__
  7. #include <stdarg.h>
  8. #include <linux/linkage.h>
  9. #include <linux/stddef.h>
  10. #include <linux/types.h>
  11. #include <linux/compiler.h>
  12. #include <linux/bitops.h>
  13. #include <linux/log2.h>
  14. #include <linux/typecheck.h>
  15. #include <linux/ratelimit.h>
  16. #include <linux/dynamic_printk.h>
  17. #include <asm/byteorder.h>
  18. #include <asm/bug.h>
  19. extern const char linux_banner[];
  20. extern const char linux_proc_banner[];
  21. #define USHORT_MAX ((u16)(~0U))
  22. #define SHORT_MAX ((s16)(USHORT_MAX>>1))
  23. #define SHORT_MIN (-SHORT_MAX - 1)
  24. #define INT_MAX ((int)(~0U>>1))
  25. #define INT_MIN (-INT_MAX - 1)
  26. #define UINT_MAX (~0U)
  27. #define LONG_MAX ((long)(~0UL>>1))
  28. #define LONG_MIN (-LONG_MAX - 1)
  29. #define ULONG_MAX (~0UL)
  30. #define LLONG_MAX ((long long)(~0ULL>>1))
  31. #define LLONG_MIN (-LLONG_MAX - 1)
  32. #define ULLONG_MAX (~0ULL)
  33. #define STACK_MAGIC 0xdeadbeef
  34. #define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
  35. #define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
  36. #define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
  37. #define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
  38. #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
  39. #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
  40. #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  41. #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
  42. #define _RET_IP_ (unsigned long)__builtin_return_address(0)
  43. #define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
  44. #ifdef CONFIG_LBD
  45. # include <asm/div64.h>
  46. # define sector_div(a, b) do_div(a, b)
  47. #else
  48. # define sector_div(n, b)( \
  49. { \
  50. int _res; \
  51. _res = (n) % (b); \
  52. (n) /= (b); \
  53. _res; \
  54. } \
  55. )
  56. #endif
  57. /**
  58. * upper_32_bits - return bits 32-63 of a number
  59. * @n: the number we're accessing
  60. *
  61. * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
  62. * the "right shift count >= width of type" warning when that quantity is
  63. * 32-bits.
  64. */
  65. #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
  66. /**
  67. * lower_32_bits - return bits 0-31 of a number
  68. * @n: the number we're accessing
  69. */
  70. #define lower_32_bits(n) ((u32)(n))
  71. #define KERN_EMERG "<0>" /* system is unusable */
  72. #define KERN_ALERT "<1>" /* action must be taken immediately */
  73. #define KERN_CRIT "<2>" /* critical conditions */
  74. #define KERN_ERR "<3>" /* error conditions */
  75. #define KERN_WARNING "<4>" /* warning conditions */
  76. #define KERN_NOTICE "<5>" /* normal but significant condition */
  77. #define KERN_INFO "<6>" /* informational */
  78. #define KERN_DEBUG "<7>" /* debug-level messages */
  79. /*
  80. * Annotation for a "continued" line of log printout (only done after a
  81. * line that had no enclosing \n). Only to be used by core/arch code
  82. * during early bootup (a continued line is not SMP-safe otherwise).
  83. */
  84. #define KERN_CONT ""
  85. extern int console_printk[];
  86. #define console_loglevel (console_printk[0])
  87. #define default_message_loglevel (console_printk[1])
  88. #define minimum_console_loglevel (console_printk[2])
  89. #define default_console_loglevel (console_printk[3])
  90. struct completion;
  91. struct pt_regs;
  92. struct user;
  93. #ifdef CONFIG_PREEMPT_VOLUNTARY
  94. extern int _cond_resched(void);
  95. # define might_resched() _cond_resched()
  96. #else
  97. # define might_resched() do { } while (0)
  98. #endif
  99. /**
  100. * might_sleep - annotation for functions that can sleep
  101. *
  102. * this macro will print a stack trace if it is executed in an atomic
  103. * context (spinlock, irq-handler, ...).
  104. *
  105. * This is a useful debugging help to be able to catch problems early and not
  106. * be bitten later when the calling function happens to sleep when it is not
  107. * supposed to.
  108. */
  109. #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
  110. void __might_sleep(char *file, int line);
  111. # define might_sleep() \
  112. do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
  113. #else
  114. # define might_sleep() do { might_resched(); } while (0)
  115. #endif
  116. #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
  117. #define abs(x) ({ \
  118. int __x = (x); \
  119. (__x < 0) ? -__x : __x; \
  120. })
  121. extern struct atomic_notifier_head panic_notifier_list;
  122. extern long (*panic_blink)(long time);
  123. NORET_TYPE void panic(const char * fmt, ...)
  124. __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
  125. extern void oops_enter(void);
  126. extern void oops_exit(void);
  127. extern int oops_may_print(void);
  128. NORET_TYPE void do_exit(long error_code)
  129. ATTRIB_NORET;
  130. NORET_TYPE void complete_and_exit(struct completion *, long)
  131. ATTRIB_NORET;
  132. extern unsigned long simple_strtoul(const char *,char **,unsigned int);
  133. extern long simple_strtol(const char *,char **,unsigned int);
  134. extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
  135. extern long long simple_strtoll(const char *,char **,unsigned int);
  136. extern int strict_strtoul(const char *, unsigned int, unsigned long *);
  137. extern int strict_strtol(const char *, unsigned int, long *);
  138. extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
  139. extern int strict_strtoll(const char *, unsigned int, long long *);
  140. extern int sprintf(char * buf, const char * fmt, ...)
  141. __attribute__ ((format (printf, 2, 3)));
  142. extern int vsprintf(char *buf, const char *, va_list)
  143. __attribute__ ((format (printf, 2, 0)));
  144. extern int snprintf(char * buf, size_t size, const char * fmt, ...)
  145. __attribute__ ((format (printf, 3, 4)));
  146. extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
  147. __attribute__ ((format (printf, 3, 0)));
  148. extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
  149. __attribute__ ((format (printf, 3, 4)));
  150. extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
  151. __attribute__ ((format (printf, 3, 0)));
  152. extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
  153. __attribute__ ((format (printf, 2, 3)));
  154. extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
  155. extern int sscanf(const char *, const char *, ...)
  156. __attribute__ ((format (scanf, 2, 3)));
  157. extern int vsscanf(const char *, const char *, va_list)
  158. __attribute__ ((format (scanf, 2, 0)));
  159. extern int get_option(char **str, int *pint);
  160. extern char *get_options(const char *str, int nints, int *ints);
  161. extern unsigned long long memparse(const char *ptr, char **retptr);
  162. extern int core_kernel_text(unsigned long addr);
  163. extern int __kernel_text_address(unsigned long addr);
  164. extern int kernel_text_address(unsigned long addr);
  165. struct pid;
  166. extern struct pid *session_of_pgrp(struct pid *pgrp);
  167. #ifdef CONFIG_PRINTK
  168. asmlinkage int vprintk(const char *fmt, va_list args)
  169. __attribute__ ((format (printf, 1, 0)));
  170. asmlinkage int printk(const char * fmt, ...)
  171. __attribute__ ((format (printf, 1, 2))) __cold;
  172. extern struct ratelimit_state printk_ratelimit_state;
  173. extern int printk_ratelimit(void);
  174. extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
  175. unsigned int interval_msec);
  176. #else
  177. static inline int vprintk(const char *s, va_list args)
  178. __attribute__ ((format (printf, 1, 0)));
  179. static inline int vprintk(const char *s, va_list args) { return 0; }
  180. static inline int printk(const char *s, ...)
  181. __attribute__ ((format (printf, 1, 2)));
  182. static inline int __cold printk(const char *s, ...) { return 0; }
  183. static inline int printk_ratelimit(void) { return 0; }
  184. static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
  185. unsigned int interval_msec) \
  186. { return false; }
  187. #endif
  188. extern int printk_needs_cpu(int cpu);
  189. extern void printk_tick(void);
  190. extern void asmlinkage __attribute__((format(printf, 1, 2)))
  191. early_printk(const char *fmt, ...);
  192. unsigned long int_sqrt(unsigned long);
  193. static inline void console_silent(void)
  194. {
  195. console_loglevel = 0;
  196. }
  197. static inline void console_verbose(void)
  198. {
  199. if (console_loglevel)
  200. console_loglevel = 15;
  201. }
  202. extern void bust_spinlocks(int yes);
  203. extern void wake_up_klogd(void);
  204. extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
  205. extern int panic_timeout;
  206. extern int panic_on_oops;
  207. extern int panic_on_unrecovered_nmi;
  208. extern const char *print_tainted(void);
  209. extern void add_taint(unsigned flag);
  210. extern int test_taint(unsigned flag);
  211. extern unsigned long get_taint(void);
  212. extern int root_mountflags;
  213. /* Values used for system_state */
  214. extern enum system_states {
  215. SYSTEM_BOOTING,
  216. SYSTEM_RUNNING,
  217. SYSTEM_HALT,
  218. SYSTEM_POWER_OFF,
  219. SYSTEM_RESTART,
  220. SYSTEM_SUSPEND_DISK,
  221. } system_state;
  222. #define TAINT_PROPRIETARY_MODULE 0
  223. #define TAINT_FORCED_MODULE 1
  224. #define TAINT_UNSAFE_SMP 2
  225. #define TAINT_FORCED_RMMOD 3
  226. #define TAINT_MACHINE_CHECK 4
  227. #define TAINT_BAD_PAGE 5
  228. #define TAINT_USER 6
  229. #define TAINT_DIE 7
  230. #define TAINT_OVERRIDDEN_ACPI_TABLE 8
  231. #define TAINT_WARN 9
  232. #define TAINT_CRAP 10
  233. extern void dump_stack(void) __cold;
  234. enum {
  235. DUMP_PREFIX_NONE,
  236. DUMP_PREFIX_ADDRESS,
  237. DUMP_PREFIX_OFFSET
  238. };
  239. extern void hex_dump_to_buffer(const void *buf, size_t len,
  240. int rowsize, int groupsize,
  241. char *linebuf, size_t linebuflen, bool ascii);
  242. extern void print_hex_dump(const char *level, const char *prefix_str,
  243. int prefix_type, int rowsize, int groupsize,
  244. const void *buf, size_t len, bool ascii);
  245. extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
  246. const void *buf, size_t len);
  247. extern const char hex_asc[];
  248. #define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
  249. #define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
  250. static inline char *pack_hex_byte(char *buf, u8 byte)
  251. {
  252. *buf++ = hex_asc_hi(byte);
  253. *buf++ = hex_asc_lo(byte);
  254. return buf;
  255. }
  256. #define pr_emerg(fmt, arg...) \
  257. printk(KERN_EMERG fmt, ##arg)
  258. #define pr_alert(fmt, arg...) \
  259. printk(KERN_ALERT fmt, ##arg)
  260. #define pr_crit(fmt, arg...) \
  261. printk(KERN_CRIT fmt, ##arg)
  262. #define pr_err(fmt, arg...) \
  263. printk(KERN_ERR fmt, ##arg)
  264. #define pr_warning(fmt, arg...) \
  265. printk(KERN_WARNING fmt, ##arg)
  266. #define pr_notice(fmt, arg...) \
  267. printk(KERN_NOTICE fmt, ##arg)
  268. #define pr_info(fmt, arg...) \
  269. printk(KERN_INFO fmt, ##arg)
  270. /* If you are writing a driver, please use dev_dbg instead */
  271. #if defined(CONFIG_DYNAMIC_PRINTK_DEBUG)
  272. #define pr_debug(fmt, ...) do { \
  273. dynamic_pr_debug(fmt, ##__VA_ARGS__); \
  274. } while (0)
  275. #elif defined(DEBUG)
  276. #define pr_debug(fmt, arg...) \
  277. printk(KERN_DEBUG fmt, ##arg)
  278. #else
  279. #define pr_debug(fmt, arg...) \
  280. ({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
  281. #endif
  282. /*
  283. * Display an IP address in readable format.
  284. */
  285. #define NIPQUAD(addr) \
  286. ((unsigned char *)&addr)[0], \
  287. ((unsigned char *)&addr)[1], \
  288. ((unsigned char *)&addr)[2], \
  289. ((unsigned char *)&addr)[3]
  290. #define NIPQUAD_FMT "%u.%u.%u.%u"
  291. #define NIP6(addr) \
  292. ntohs((addr).s6_addr16[0]), \
  293. ntohs((addr).s6_addr16[1]), \
  294. ntohs((addr).s6_addr16[2]), \
  295. ntohs((addr).s6_addr16[3]), \
  296. ntohs((addr).s6_addr16[4]), \
  297. ntohs((addr).s6_addr16[5]), \
  298. ntohs((addr).s6_addr16[6]), \
  299. ntohs((addr).s6_addr16[7])
  300. #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
  301. #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
  302. #if defined(__LITTLE_ENDIAN)
  303. #define HIPQUAD(addr) \
  304. ((unsigned char *)&addr)[3], \
  305. ((unsigned char *)&addr)[2], \
  306. ((unsigned char *)&addr)[1], \
  307. ((unsigned char *)&addr)[0]
  308. #elif defined(__BIG_ENDIAN)
  309. #define HIPQUAD NIPQUAD
  310. #else
  311. #error "Please fix asm/byteorder.h"
  312. #endif /* __LITTLE_ENDIAN */
  313. /*
  314. * min()/max()/clamp() macros that also do
  315. * strict type-checking.. See the
  316. * "unnecessary" pointer comparison.
  317. */
  318. #define min(x, y) ({ \
  319. typeof(x) _min1 = (x); \
  320. typeof(y) _min2 = (y); \
  321. (void) (&_min1 == &_min2); \
  322. _min1 < _min2 ? _min1 : _min2; })
  323. #define max(x, y) ({ \
  324. typeof(x) _max1 = (x); \
  325. typeof(y) _max2 = (y); \
  326. (void) (&_max1 == &_max2); \
  327. _max1 > _max2 ? _max1 : _max2; })
  328. /**
  329. * clamp - return a value clamped to a given range with strict typechecking
  330. * @val: current value
  331. * @min: minimum allowable value
  332. * @max: maximum allowable value
  333. *
  334. * This macro does strict typechecking of min/max to make sure they are of the
  335. * same type as val. See the unnecessary pointer comparisons.
  336. */
  337. #define clamp(val, min, max) ({ \
  338. typeof(val) __val = (val); \
  339. typeof(min) __min = (min); \
  340. typeof(max) __max = (max); \
  341. (void) (&__val == &__min); \
  342. (void) (&__val == &__max); \
  343. __val = __val < __min ? __min: __val; \
  344. __val > __max ? __max: __val; })
  345. /*
  346. * ..and if you can't take the strict
  347. * types, you can specify one yourself.
  348. *
  349. * Or not use min/max/clamp at all, of course.
  350. */
  351. #define min_t(type, x, y) ({ \
  352. type __min1 = (x); \
  353. type __min2 = (y); \
  354. __min1 < __min2 ? __min1: __min2; })
  355. #define max_t(type, x, y) ({ \
  356. type __max1 = (x); \
  357. type __max2 = (y); \
  358. __max1 > __max2 ? __max1: __max2; })
  359. /**
  360. * clamp_t - return a value clamped to a given range using a given type
  361. * @type: the type of variable to use
  362. * @val: current value
  363. * @min: minimum allowable value
  364. * @max: maximum allowable value
  365. *
  366. * This macro does no typechecking and uses temporary variables of type
  367. * 'type' to make all the comparisons.
  368. */
  369. #define clamp_t(type, val, min, max) ({ \
  370. type __val = (val); \
  371. type __min = (min); \
  372. type __max = (max); \
  373. __val = __val < __min ? __min: __val; \
  374. __val > __max ? __max: __val; })
  375. /**
  376. * clamp_val - return a value clamped to a given range using val's type
  377. * @val: current value
  378. * @min: minimum allowable value
  379. * @max: maximum allowable value
  380. *
  381. * This macro does no typechecking and uses temporary variables of whatever
  382. * type the input argument 'val' is. This is useful when val is an unsigned
  383. * type and min and max are literals that will otherwise be assigned a signed
  384. * integer type.
  385. */
  386. #define clamp_val(val, min, max) ({ \
  387. typeof(val) __val = (val); \
  388. typeof(val) __min = (min); \
  389. typeof(val) __max = (max); \
  390. __val = __val < __min ? __min: __val; \
  391. __val > __max ? __max: __val; })
  392. /**
  393. * container_of - cast a member of a structure out to the containing structure
  394. * @ptr: the pointer to the member.
  395. * @type: the type of the container struct this is embedded in.
  396. * @member: the name of the member within the struct.
  397. *
  398. */
  399. #define container_of(ptr, type, member) ({ \
  400. const typeof( ((type *)0)->member ) *__mptr = (ptr); \
  401. (type *)( (char *)__mptr - offsetof(type,member) );})
  402. struct sysinfo;
  403. extern int do_sysinfo(struct sysinfo *info);
  404. #endif /* __KERNEL__ */
  405. #define SI_LOAD_SHIFT 16
  406. struct sysinfo {
  407. long uptime; /* Seconds since boot */
  408. unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
  409. unsigned long totalram; /* Total usable main memory size */
  410. unsigned long freeram; /* Available memory size */
  411. unsigned long sharedram; /* Amount of shared memory */
  412. unsigned long bufferram; /* Memory used by buffers */
  413. unsigned long totalswap; /* Total swap space size */
  414. unsigned long freeswap; /* swap space still available */
  415. unsigned short procs; /* Number of current processes */
  416. unsigned short pad; /* explicit padding for m68k */
  417. unsigned long totalhigh; /* Total high memory size */
  418. unsigned long freehigh; /* Available high memory size */
  419. unsigned int mem_unit; /* Memory unit size in bytes */
  420. char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
  421. };
  422. /* Force a compilation error if condition is true */
  423. #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
  424. /* Force a compilation error if condition is true, but also produce a
  425. result (of value 0 and type size_t), so the expression can be used
  426. e.g. in a structure initializer (or where-ever else comma expressions
  427. aren't permitted). */
  428. #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
  429. /* Trap pasters of __FUNCTION__ at compile-time */
  430. #define __FUNCTION__ (__func__)
  431. /* This helps us to avoid #ifdef CONFIG_NUMA */
  432. #ifdef CONFIG_NUMA
  433. #define NUMA_BUILD 1
  434. #else
  435. #define NUMA_BUILD 0
  436. #endif
  437. /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
  438. #ifdef CONFIG_FTRACE_MCOUNT_RECORD
  439. # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
  440. #endif
  441. #endif