kernel.h 9.6 KB

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