kernel.h 12 KB

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