kernel.h 11 KB

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