kernel.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405
  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 <asm/byteorder.h>
  15. #include <asm/bug.h>
  16. extern const char linux_banner[];
  17. extern const char linux_proc_banner[];
  18. #define INT_MAX ((int)(~0U>>1))
  19. #define INT_MIN (-INT_MAX - 1)
  20. #define UINT_MAX (~0U)
  21. #define LONG_MAX ((long)(~0UL>>1))
  22. #define LONG_MIN (-LONG_MAX - 1)
  23. #define ULONG_MAX (~0UL)
  24. #define LLONG_MAX ((long long)(~0ULL>>1))
  25. #define LLONG_MIN (-LLONG_MAX - 1)
  26. #define ULLONG_MAX (~0ULL)
  27. #define STACK_MAGIC 0xdeadbeef
  28. #define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
  29. #define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
  30. #define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
  31. #define IS_ALIGNED(x,a) (((x) % ((typeof(x))(a))) == 0)
  32. #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
  33. #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
  34. #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  35. #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
  36. #ifdef CONFIG_LBD
  37. # include <asm/div64.h>
  38. # define sector_div(a, b) do_div(a, b)
  39. #else
  40. # define sector_div(n, b)( \
  41. { \
  42. int _res; \
  43. _res = (n) % (b); \
  44. (n) /= (b); \
  45. _res; \
  46. } \
  47. )
  48. #endif
  49. /**
  50. * upper_32_bits - return bits 32-63 of a number
  51. * @n: the number we're accessing
  52. *
  53. * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
  54. * the "right shift count >= width of type" warning when that quantity is
  55. * 32-bits.
  56. */
  57. #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
  58. #define KERN_EMERG "<0>" /* system is unusable */
  59. #define KERN_ALERT "<1>" /* action must be taken immediately */
  60. #define KERN_CRIT "<2>" /* critical conditions */
  61. #define KERN_ERR "<3>" /* error conditions */
  62. #define KERN_WARNING "<4>" /* warning conditions */
  63. #define KERN_NOTICE "<5>" /* normal but significant condition */
  64. #define KERN_INFO "<6>" /* informational */
  65. #define KERN_DEBUG "<7>" /* debug-level messages */
  66. extern int console_printk[];
  67. #define console_loglevel (console_printk[0])
  68. #define default_message_loglevel (console_printk[1])
  69. #define minimum_console_loglevel (console_printk[2])
  70. #define default_console_loglevel (console_printk[3])
  71. struct completion;
  72. struct pt_regs;
  73. struct user;
  74. /**
  75. * might_sleep - annotation for functions that can sleep
  76. *
  77. * this macro will print a stack trace if it is executed in an atomic
  78. * context (spinlock, irq-handler, ...).
  79. *
  80. * This is a useful debugging help to be able to catch problems early and not
  81. * be bitten later when the calling function happens to sleep when it is not
  82. * supposed to.
  83. */
  84. #ifdef CONFIG_PREEMPT_VOLUNTARY
  85. extern int cond_resched(void);
  86. # define might_resched() cond_resched()
  87. #else
  88. # define might_resched() do { } while (0)
  89. #endif
  90. #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
  91. void __might_sleep(char *file, int line);
  92. # define might_sleep() \
  93. do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
  94. #else
  95. # define might_sleep() do { might_resched(); } while (0)
  96. #endif
  97. #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
  98. #define abs(x) ({ \
  99. int __x = (x); \
  100. (__x < 0) ? -__x : __x; \
  101. })
  102. extern struct atomic_notifier_head panic_notifier_list;
  103. extern long (*panic_blink)(long time);
  104. NORET_TYPE void panic(const char * fmt, ...)
  105. __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
  106. extern void oops_enter(void);
  107. extern void oops_exit(void);
  108. extern int oops_may_print(void);
  109. fastcall NORET_TYPE void do_exit(long error_code)
  110. ATTRIB_NORET;
  111. NORET_TYPE void complete_and_exit(struct completion *, long)
  112. ATTRIB_NORET;
  113. extern unsigned long simple_strtoul(const char *,char **,unsigned int);
  114. extern long simple_strtol(const char *,char **,unsigned int);
  115. extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
  116. extern long long simple_strtoll(const char *,char **,unsigned int);
  117. extern int sprintf(char * buf, const char * fmt, ...)
  118. __attribute__ ((format (printf, 2, 3)));
  119. extern int vsprintf(char *buf, const char *, va_list)
  120. __attribute__ ((format (printf, 2, 0)));
  121. extern int snprintf(char * buf, size_t size, const char * fmt, ...)
  122. __attribute__ ((format (printf, 3, 4)));
  123. extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
  124. __attribute__ ((format (printf, 3, 0)));
  125. extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
  126. __attribute__ ((format (printf, 3, 4)));
  127. extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
  128. __attribute__ ((format (printf, 3, 0)));
  129. extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
  130. __attribute__ ((format (printf, 2, 3)));
  131. extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
  132. extern int sscanf(const char *, const char *, ...)
  133. __attribute__ ((format (scanf, 2, 3)));
  134. extern int vsscanf(const char *, const char *, va_list)
  135. __attribute__ ((format (scanf, 2, 0)));
  136. extern int get_option(char **str, int *pint);
  137. extern char *get_options(const char *str, int nints, int *ints);
  138. extern unsigned long long memparse(char *ptr, char **retptr);
  139. extern int core_kernel_text(unsigned long addr);
  140. extern int __kernel_text_address(unsigned long addr);
  141. extern int kernel_text_address(unsigned long addr);
  142. struct pid;
  143. extern struct pid *session_of_pgrp(struct pid *pgrp);
  144. extern void dump_thread(struct pt_regs *regs, struct user *dump);
  145. #ifdef CONFIG_PRINTK
  146. asmlinkage int vprintk(const char *fmt, va_list args)
  147. __attribute__ ((format (printf, 1, 0)));
  148. asmlinkage int printk(const char * fmt, ...)
  149. __attribute__ ((format (printf, 1, 2))) __cold;
  150. extern int log_buf_get_len(void);
  151. extern int log_buf_read(int idx);
  152. extern int log_buf_copy(char *dest, int idx, int len);
  153. #else
  154. static inline int vprintk(const char *s, va_list args)
  155. __attribute__ ((format (printf, 1, 0)));
  156. static inline int vprintk(const char *s, va_list args) { return 0; }
  157. static inline int printk(const char *s, ...)
  158. __attribute__ ((format (printf, 1, 2)));
  159. static inline int __cold printk(const char *s, ...) { return 0; }
  160. static inline int log_buf_get_len(void) { return 0; }
  161. static inline int log_buf_read(int idx) { return 0; }
  162. static inline int log_buf_copy(char *dest, int idx, int len) { return 0; }
  163. #endif
  164. unsigned long int_sqrt(unsigned long);
  165. extern int printk_ratelimit(void);
  166. extern int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst);
  167. extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
  168. unsigned int interval_msec);
  169. static inline void console_silent(void)
  170. {
  171. console_loglevel = 0;
  172. }
  173. static inline void console_verbose(void)
  174. {
  175. if (console_loglevel)
  176. console_loglevel = 15;
  177. }
  178. extern void bust_spinlocks(int yes);
  179. extern void wake_up_klogd(void);
  180. extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
  181. extern int panic_timeout;
  182. extern int panic_on_oops;
  183. extern int panic_on_unrecovered_nmi;
  184. extern int tainted;
  185. extern const char *print_tainted(void);
  186. extern void add_taint(unsigned);
  187. /* Values used for system_state */
  188. extern enum system_states {
  189. SYSTEM_BOOTING,
  190. SYSTEM_RUNNING,
  191. SYSTEM_HALT,
  192. SYSTEM_POWER_OFF,
  193. SYSTEM_RESTART,
  194. SYSTEM_SUSPEND_DISK,
  195. } system_state;
  196. #define TAINT_PROPRIETARY_MODULE (1<<0)
  197. #define TAINT_FORCED_MODULE (1<<1)
  198. #define TAINT_UNSAFE_SMP (1<<2)
  199. #define TAINT_FORCED_RMMOD (1<<3)
  200. #define TAINT_MACHINE_CHECK (1<<4)
  201. #define TAINT_BAD_PAGE (1<<5)
  202. #define TAINT_USER (1<<6)
  203. #define TAINT_DIE (1<<7)
  204. extern void dump_stack(void) __cold;
  205. enum {
  206. DUMP_PREFIX_NONE,
  207. DUMP_PREFIX_ADDRESS,
  208. DUMP_PREFIX_OFFSET
  209. };
  210. extern void hex_dump_to_buffer(const void *buf, size_t len,
  211. int rowsize, int groupsize,
  212. char *linebuf, size_t linebuflen, bool ascii);
  213. extern void print_hex_dump(const char *level, const char *prefix_str,
  214. int prefix_type, int rowsize, int groupsize,
  215. const void *buf, size_t len, bool ascii);
  216. extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
  217. const void *buf, size_t len);
  218. #define hex_asc(x) "0123456789abcdef"[x]
  219. #ifdef DEBUG
  220. /* If you are writing a driver, please use dev_dbg instead */
  221. #define pr_debug(fmt,arg...) \
  222. printk(KERN_DEBUG fmt,##arg)
  223. #else
  224. static inline int __attribute__ ((format (printf, 1, 2))) pr_debug(const char * fmt, ...)
  225. {
  226. return 0;
  227. }
  228. #endif
  229. #define pr_info(fmt,arg...) \
  230. printk(KERN_INFO fmt,##arg)
  231. /*
  232. * Display an IP address in readable format.
  233. */
  234. #define NIPQUAD(addr) \
  235. ((unsigned char *)&addr)[0], \
  236. ((unsigned char *)&addr)[1], \
  237. ((unsigned char *)&addr)[2], \
  238. ((unsigned char *)&addr)[3]
  239. #define NIPQUAD_FMT "%u.%u.%u.%u"
  240. #define NIP6(addr) \
  241. ntohs((addr).s6_addr16[0]), \
  242. ntohs((addr).s6_addr16[1]), \
  243. ntohs((addr).s6_addr16[2]), \
  244. ntohs((addr).s6_addr16[3]), \
  245. ntohs((addr).s6_addr16[4]), \
  246. ntohs((addr).s6_addr16[5]), \
  247. ntohs((addr).s6_addr16[6]), \
  248. ntohs((addr).s6_addr16[7])
  249. #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
  250. #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
  251. #if defined(__LITTLE_ENDIAN)
  252. #define HIPQUAD(addr) \
  253. ((unsigned char *)&addr)[3], \
  254. ((unsigned char *)&addr)[2], \
  255. ((unsigned char *)&addr)[1], \
  256. ((unsigned char *)&addr)[0]
  257. #elif defined(__BIG_ENDIAN)
  258. #define HIPQUAD NIPQUAD
  259. #else
  260. #error "Please fix asm/byteorder.h"
  261. #endif /* __LITTLE_ENDIAN */
  262. /*
  263. * min()/max() macros that also do
  264. * strict type-checking.. See the
  265. * "unnecessary" pointer comparison.
  266. */
  267. #define min(x,y) ({ \
  268. typeof(x) _x = (x); \
  269. typeof(y) _y = (y); \
  270. (void) (&_x == &_y); \
  271. _x < _y ? _x : _y; })
  272. #define max(x,y) ({ \
  273. typeof(x) _x = (x); \
  274. typeof(y) _y = (y); \
  275. (void) (&_x == &_y); \
  276. _x > _y ? _x : _y; })
  277. /*
  278. * ..and if you can't take the strict
  279. * types, you can specify one yourself.
  280. *
  281. * Or not use min/max at all, of course.
  282. */
  283. #define min_t(type,x,y) \
  284. ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
  285. #define max_t(type,x,y) \
  286. ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
  287. /**
  288. * container_of - cast a member of a structure out to the containing structure
  289. * @ptr: the pointer to the member.
  290. * @type: the type of the container struct this is embedded in.
  291. * @member: the name of the member within the struct.
  292. *
  293. */
  294. #define container_of(ptr, type, member) ({ \
  295. const typeof( ((type *)0)->member ) *__mptr = (ptr); \
  296. (type *)( (char *)__mptr - offsetof(type,member) );})
  297. /*
  298. * Check at compile time that something is of a particular type.
  299. * Always evaluates to 1 so you may use it easily in comparisons.
  300. */
  301. #define typecheck(type,x) \
  302. ({ type __dummy; \
  303. typeof(x) __dummy2; \
  304. (void)(&__dummy == &__dummy2); \
  305. 1; \
  306. })
  307. /*
  308. * Check at compile time that 'function' is a certain type, or is a pointer
  309. * to that type (needs to use typedef for the function type.)
  310. */
  311. #define typecheck_fn(type,function) \
  312. ({ typeof(type) __tmp = function; \
  313. (void)__tmp; \
  314. })
  315. struct sysinfo;
  316. extern int do_sysinfo(struct sysinfo *info);
  317. #endif /* __KERNEL__ */
  318. #define SI_LOAD_SHIFT 16
  319. struct sysinfo {
  320. long uptime; /* Seconds since boot */
  321. unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
  322. unsigned long totalram; /* Total usable main memory size */
  323. unsigned long freeram; /* Available memory size */
  324. unsigned long sharedram; /* Amount of shared memory */
  325. unsigned long bufferram; /* Memory used by buffers */
  326. unsigned long totalswap; /* Total swap space size */
  327. unsigned long freeswap; /* swap space still available */
  328. unsigned short procs; /* Number of current processes */
  329. unsigned short pad; /* explicit padding for m68k */
  330. unsigned long totalhigh; /* Total high memory size */
  331. unsigned long freehigh; /* Available high memory size */
  332. unsigned int mem_unit; /* Memory unit size in bytes */
  333. char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
  334. };
  335. /* Force a compilation error if condition is true */
  336. #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
  337. /* Force a compilation error if condition is true, but also produce a
  338. result (of value 0 and type size_t), so the expression can be used
  339. e.g. in a structure initializer (or where-ever else comma expressions
  340. aren't permitted). */
  341. #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
  342. /* Trap pasters of __FUNCTION__ at compile-time */
  343. #define __FUNCTION__ (__func__)
  344. /* This helps us to avoid #ifdef CONFIG_NUMA */
  345. #ifdef CONFIG_NUMA
  346. #define NUMA_BUILD 1
  347. #else
  348. #define NUMA_BUILD 0
  349. #endif
  350. #endif