kernel.h 11 KB

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