kernel.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498
  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 <linux/typecheck.h>
  15. #include <linux/ratelimit.h>
  16. #include <asm/byteorder.h>
  17. #include <asm/bug.h>
  18. extern const char linux_banner[];
  19. extern const char linux_proc_banner[];
  20. #define USHORT_MAX ((u16)(~0U))
  21. #define SHORT_MAX ((s16)(USHORT_MAX>>1))
  22. #define SHORT_MIN (-SHORT_MAX - 1)
  23. #define INT_MAX ((int)(~0U>>1))
  24. #define INT_MIN (-INT_MAX - 1)
  25. #define UINT_MAX (~0U)
  26. #define LONG_MAX ((long)(~0UL>>1))
  27. #define LONG_MIN (-LONG_MAX - 1)
  28. #define ULONG_MAX (~0UL)
  29. #define LLONG_MAX ((long long)(~0ULL>>1))
  30. #define LLONG_MIN (-LLONG_MAX - 1)
  31. #define ULLONG_MAX (~0ULL)
  32. #define STACK_MAGIC 0xdeadbeef
  33. #define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
  34. #define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
  35. #define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
  36. #define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
  37. #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
  38. #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
  39. #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  40. #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
  41. #define _RET_IP_ (unsigned long)__builtin_return_address(0)
  42. #define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
  43. #ifdef CONFIG_LBD
  44. # include <asm/div64.h>
  45. # define sector_div(a, b) do_div(a, b)
  46. #else
  47. # define sector_div(n, b)( \
  48. { \
  49. int _res; \
  50. _res = (n) % (b); \
  51. (n) /= (b); \
  52. _res; \
  53. } \
  54. )
  55. #endif
  56. /**
  57. * upper_32_bits - return bits 32-63 of a number
  58. * @n: the number we're accessing
  59. *
  60. * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
  61. * the "right shift count >= width of type" warning when that quantity is
  62. * 32-bits.
  63. */
  64. #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
  65. /**
  66. * lower_32_bits - return bits 0-31 of a number
  67. * @n: the number we're accessing
  68. */
  69. #define lower_32_bits(n) ((u32)(n))
  70. #define KERN_EMERG "<0>" /* system is unusable */
  71. #define KERN_ALERT "<1>" /* action must be taken immediately */
  72. #define KERN_CRIT "<2>" /* critical conditions */
  73. #define KERN_ERR "<3>" /* error conditions */
  74. #define KERN_WARNING "<4>" /* warning conditions */
  75. #define KERN_NOTICE "<5>" /* normal but significant condition */
  76. #define KERN_INFO "<6>" /* informational */
  77. #define KERN_DEBUG "<7>" /* debug-level messages */
  78. /*
  79. * Annotation for a "continued" line of log printout (only done after a
  80. * line that had no enclosing \n). Only to be used by core/arch code
  81. * during early bootup (a continued line is not SMP-safe otherwise).
  82. */
  83. #define KERN_CONT ""
  84. extern int console_printk[];
  85. #define console_loglevel (console_printk[0])
  86. #define default_message_loglevel (console_printk[1])
  87. #define minimum_console_loglevel (console_printk[2])
  88. #define default_console_loglevel (console_printk[3])
  89. struct completion;
  90. struct pt_regs;
  91. struct user;
  92. #ifdef CONFIG_PREEMPT_VOLUNTARY
  93. extern int _cond_resched(void);
  94. # define might_resched() _cond_resched()
  95. #else
  96. # define might_resched() do { } while (0)
  97. #endif
  98. /**
  99. * might_sleep - annotation for functions that can sleep
  100. *
  101. * this macro will print a stack trace if it is executed in an atomic
  102. * context (spinlock, irq-handler, ...).
  103. *
  104. * This is a useful debugging help to be able to catch problems early and not
  105. * be bitten later when the calling function happens to sleep when it is not
  106. * supposed to.
  107. */
  108. #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
  109. void __might_sleep(char *file, int line);
  110. # define might_sleep() \
  111. do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
  112. #else
  113. # define might_sleep() do { might_resched(); } while (0)
  114. #endif
  115. #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
  116. #define abs(x) ({ \
  117. int __x = (x); \
  118. (__x < 0) ? -__x : __x; \
  119. })
  120. #ifdef CONFIG_PROVE_LOCKING
  121. void might_fault(void);
  122. #else
  123. static inline void might_fault(void)
  124. {
  125. might_sleep();
  126. }
  127. #endif
  128. extern struct atomic_notifier_head panic_notifier_list;
  129. extern long (*panic_blink)(long time);
  130. NORET_TYPE void panic(const char * fmt, ...)
  131. __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
  132. extern void oops_enter(void);
  133. extern void oops_exit(void);
  134. extern int oops_may_print(void);
  135. NORET_TYPE void do_exit(long error_code)
  136. ATTRIB_NORET;
  137. NORET_TYPE void complete_and_exit(struct completion *, long)
  138. ATTRIB_NORET;
  139. extern unsigned long simple_strtoul(const char *,char **,unsigned int);
  140. extern long simple_strtol(const char *,char **,unsigned int);
  141. extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
  142. extern long long simple_strtoll(const char *,char **,unsigned int);
  143. extern int strict_strtoul(const char *, unsigned int, unsigned long *);
  144. extern int strict_strtol(const char *, unsigned int, long *);
  145. extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
  146. extern int strict_strtoll(const char *, unsigned int, long long *);
  147. extern int sprintf(char * buf, const char * fmt, ...)
  148. __attribute__ ((format (printf, 2, 3)));
  149. extern int vsprintf(char *buf, const char *, va_list)
  150. __attribute__ ((format (printf, 2, 0)));
  151. extern int snprintf(char * buf, size_t size, const char * fmt, ...)
  152. __attribute__ ((format (printf, 3, 4)));
  153. extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
  154. __attribute__ ((format (printf, 3, 0)));
  155. extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
  156. __attribute__ ((format (printf, 3, 4)));
  157. extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
  158. __attribute__ ((format (printf, 3, 0)));
  159. extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
  160. __attribute__ ((format (printf, 2, 3)));
  161. extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
  162. extern int sscanf(const char *, const char *, ...)
  163. __attribute__ ((format (scanf, 2, 3)));
  164. extern int vsscanf(const char *, const char *, va_list)
  165. __attribute__ ((format (scanf, 2, 0)));
  166. extern int get_option(char **str, int *pint);
  167. extern char *get_options(const char *str, int nints, int *ints);
  168. extern unsigned long long memparse(char *ptr, char **retptr);
  169. extern int core_kernel_text(unsigned long addr);
  170. extern int __kernel_text_address(unsigned long addr);
  171. extern int kernel_text_address(unsigned long addr);
  172. struct pid;
  173. extern struct pid *session_of_pgrp(struct pid *pgrp);
  174. #ifdef CONFIG_PRINTK
  175. asmlinkage int vprintk(const char *fmt, va_list args)
  176. __attribute__ ((format (printf, 1, 0)));
  177. asmlinkage int printk(const char * fmt, ...)
  178. __attribute__ ((format (printf, 1, 2))) __cold;
  179. extern struct ratelimit_state printk_ratelimit_state;
  180. extern int printk_ratelimit(void);
  181. extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
  182. unsigned int interval_msec);
  183. #else
  184. static inline int vprintk(const char *s, va_list args)
  185. __attribute__ ((format (printf, 1, 0)));
  186. static inline int vprintk(const char *s, va_list args) { return 0; }
  187. static inline int printk(const char *s, ...)
  188. __attribute__ ((format (printf, 1, 2)));
  189. static inline int __cold printk(const char *s, ...) { return 0; }
  190. static inline int printk_ratelimit(void) { return 0; }
  191. static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
  192. unsigned int interval_msec) \
  193. { return false; }
  194. #endif
  195. extern void asmlinkage __attribute__((format(printf, 1, 2)))
  196. early_printk(const char *fmt, ...);
  197. unsigned long int_sqrt(unsigned long);
  198. static inline void console_silent(void)
  199. {
  200. console_loglevel = 0;
  201. }
  202. static inline void console_verbose(void)
  203. {
  204. if (console_loglevel)
  205. console_loglevel = 15;
  206. }
  207. extern void bust_spinlocks(int yes);
  208. extern void wake_up_klogd(void);
  209. extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
  210. extern int panic_timeout;
  211. extern int panic_on_oops;
  212. extern int panic_on_unrecovered_nmi;
  213. extern int tainted;
  214. extern const char *print_tainted(void);
  215. extern void add_taint(unsigned);
  216. extern int root_mountflags;
  217. /* Values used for system_state */
  218. extern enum system_states {
  219. SYSTEM_BOOTING,
  220. SYSTEM_RUNNING,
  221. SYSTEM_HALT,
  222. SYSTEM_POWER_OFF,
  223. SYSTEM_RESTART,
  224. SYSTEM_SUSPEND_DISK,
  225. } system_state;
  226. #define TAINT_PROPRIETARY_MODULE (1<<0)
  227. #define TAINT_FORCED_MODULE (1<<1)
  228. #define TAINT_UNSAFE_SMP (1<<2)
  229. #define TAINT_FORCED_RMMOD (1<<3)
  230. #define TAINT_MACHINE_CHECK (1<<4)
  231. #define TAINT_BAD_PAGE (1<<5)
  232. #define TAINT_USER (1<<6)
  233. #define TAINT_DIE (1<<7)
  234. #define TAINT_OVERRIDDEN_ACPI_TABLE (1<<8)
  235. #define TAINT_WARN (1<<9)
  236. extern void dump_stack(void) __cold;
  237. enum {
  238. DUMP_PREFIX_NONE,
  239. DUMP_PREFIX_ADDRESS,
  240. DUMP_PREFIX_OFFSET
  241. };
  242. extern void hex_dump_to_buffer(const void *buf, size_t len,
  243. int rowsize, int groupsize,
  244. char *linebuf, size_t linebuflen, bool ascii);
  245. extern void print_hex_dump(const char *level, const char *prefix_str,
  246. int prefix_type, int rowsize, int groupsize,
  247. const void *buf, size_t len, bool ascii);
  248. extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
  249. const void *buf, size_t len);
  250. extern const char hex_asc[];
  251. #define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
  252. #define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
  253. static inline char *pack_hex_byte(char *buf, u8 byte)
  254. {
  255. *buf++ = hex_asc_hi(byte);
  256. *buf++ = hex_asc_lo(byte);
  257. return buf;
  258. }
  259. #define pr_emerg(fmt, arg...) \
  260. printk(KERN_EMERG fmt, ##arg)
  261. #define pr_alert(fmt, arg...) \
  262. printk(KERN_ALERT fmt, ##arg)
  263. #define pr_crit(fmt, arg...) \
  264. printk(KERN_CRIT fmt, ##arg)
  265. #define pr_err(fmt, arg...) \
  266. printk(KERN_ERR fmt, ##arg)
  267. #define pr_warning(fmt, arg...) \
  268. printk(KERN_WARNING fmt, ##arg)
  269. #define pr_notice(fmt, arg...) \
  270. printk(KERN_NOTICE fmt, ##arg)
  271. #define pr_info(fmt, arg...) \
  272. printk(KERN_INFO fmt, ##arg)
  273. #ifdef DEBUG
  274. /* If you are writing a driver, please use dev_dbg instead */
  275. #define pr_debug(fmt, arg...) \
  276. printk(KERN_DEBUG fmt, ##arg)
  277. #else
  278. #define pr_debug(fmt, arg...) \
  279. ({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
  280. #endif
  281. /*
  282. * Display an IP address in readable format.
  283. */
  284. #define NIPQUAD(addr) \
  285. ((unsigned char *)&addr)[0], \
  286. ((unsigned char *)&addr)[1], \
  287. ((unsigned char *)&addr)[2], \
  288. ((unsigned char *)&addr)[3]
  289. #define NIPQUAD_FMT "%u.%u.%u.%u"
  290. #define NIP6(addr) \
  291. ntohs((addr).s6_addr16[0]), \
  292. ntohs((addr).s6_addr16[1]), \
  293. ntohs((addr).s6_addr16[2]), \
  294. ntohs((addr).s6_addr16[3]), \
  295. ntohs((addr).s6_addr16[4]), \
  296. ntohs((addr).s6_addr16[5]), \
  297. ntohs((addr).s6_addr16[6]), \
  298. ntohs((addr).s6_addr16[7])
  299. #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
  300. #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
  301. #if defined(__LITTLE_ENDIAN)
  302. #define HIPQUAD(addr) \
  303. ((unsigned char *)&addr)[3], \
  304. ((unsigned char *)&addr)[2], \
  305. ((unsigned char *)&addr)[1], \
  306. ((unsigned char *)&addr)[0]
  307. #elif defined(__BIG_ENDIAN)
  308. #define HIPQUAD NIPQUAD
  309. #else
  310. #error "Please fix asm/byteorder.h"
  311. #endif /* __LITTLE_ENDIAN */
  312. /*
  313. * min()/max()/clamp() macros that also do
  314. * strict type-checking.. See the
  315. * "unnecessary" pointer comparison.
  316. */
  317. #define min(x, y) ({ \
  318. typeof(x) _min1 = (x); \
  319. typeof(y) _min2 = (y); \
  320. (void) (&_min1 == &_min2); \
  321. _min1 < _min2 ? _min1 : _min2; })
  322. #define max(x, y) ({ \
  323. typeof(x) _max1 = (x); \
  324. typeof(y) _max2 = (y); \
  325. (void) (&_max1 == &_max2); \
  326. _max1 > _max2 ? _max1 : _max2; })
  327. /**
  328. * clamp - return a value clamped to a given range with strict typechecking
  329. * @val: current value
  330. * @min: minimum allowable value
  331. * @max: maximum allowable value
  332. *
  333. * This macro does strict typechecking of min/max to make sure they are of the
  334. * same type as val. See the unnecessary pointer comparisons.
  335. */
  336. #define clamp(val, min, max) ({ \
  337. typeof(val) __val = (val); \
  338. typeof(min) __min = (min); \
  339. typeof(max) __max = (max); \
  340. (void) (&__val == &__min); \
  341. (void) (&__val == &__max); \
  342. __val = __val < __min ? __min: __val; \
  343. __val > __max ? __max: __val; })
  344. /*
  345. * ..and if you can't take the strict
  346. * types, you can specify one yourself.
  347. *
  348. * Or not use min/max/clamp at all, of course.
  349. */
  350. #define min_t(type, x, y) ({ \
  351. type __min1 = (x); \
  352. type __min2 = (y); \
  353. __min1 < __min2 ? __min1: __min2; })
  354. #define max_t(type, x, y) ({ \
  355. type __max1 = (x); \
  356. type __max2 = (y); \
  357. __max1 > __max2 ? __max1: __max2; })
  358. /**
  359. * clamp_t - return a value clamped to a given range using a given type
  360. * @type: the type of variable to use
  361. * @val: current value
  362. * @min: minimum allowable value
  363. * @max: maximum allowable value
  364. *
  365. * This macro does no typechecking and uses temporary variables of type
  366. * 'type' to make all the comparisons.
  367. */
  368. #define clamp_t(type, val, min, max) ({ \
  369. type __val = (val); \
  370. type __min = (min); \
  371. type __max = (max); \
  372. __val = __val < __min ? __min: __val; \
  373. __val > __max ? __max: __val; })
  374. /**
  375. * clamp_val - return a value clamped to a given range using val's type
  376. * @val: current value
  377. * @min: minimum allowable value
  378. * @max: maximum allowable value
  379. *
  380. * This macro does no typechecking and uses temporary variables of whatever
  381. * type the input argument 'val' is. This is useful when val is an unsigned
  382. * type and min and max are literals that will otherwise be assigned a signed
  383. * integer type.
  384. */
  385. #define clamp_val(val, min, max) ({ \
  386. typeof(val) __val = (val); \
  387. typeof(val) __min = (min); \
  388. typeof(val) __max = (max); \
  389. __val = __val < __min ? __min: __val; \
  390. __val > __max ? __max: __val; })
  391. /**
  392. * container_of - cast a member of a structure out to the containing structure
  393. * @ptr: the pointer to the member.
  394. * @type: the type of the container struct this is embedded in.
  395. * @member: the name of the member within the struct.
  396. *
  397. */
  398. #define container_of(ptr, type, member) ({ \
  399. const typeof( ((type *)0)->member ) *__mptr = (ptr); \
  400. (type *)( (char *)__mptr - offsetof(type,member) );})
  401. struct sysinfo;
  402. extern int do_sysinfo(struct sysinfo *info);
  403. #endif /* __KERNEL__ */
  404. #define SI_LOAD_SHIFT 16
  405. struct sysinfo {
  406. long uptime; /* Seconds since boot */
  407. unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
  408. unsigned long totalram; /* Total usable main memory size */
  409. unsigned long freeram; /* Available memory size */
  410. unsigned long sharedram; /* Amount of shared memory */
  411. unsigned long bufferram; /* Memory used by buffers */
  412. unsigned long totalswap; /* Total swap space size */
  413. unsigned long freeswap; /* swap space still available */
  414. unsigned short procs; /* Number of current processes */
  415. unsigned short pad; /* explicit padding for m68k */
  416. unsigned long totalhigh; /* Total high memory size */
  417. unsigned long freehigh; /* Available high memory size */
  418. unsigned int mem_unit; /* Memory unit size in bytes */
  419. char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
  420. };
  421. /* Force a compilation error if condition is true */
  422. #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
  423. /* Force a compilation error if condition is true, but also produce a
  424. result (of value 0 and type size_t), so the expression can be used
  425. e.g. in a structure initializer (or where-ever else comma expressions
  426. aren't permitted). */
  427. #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
  428. /* Trap pasters of __FUNCTION__ at compile-time */
  429. #define __FUNCTION__ (__func__)
  430. /* This helps us to avoid #ifdef CONFIG_NUMA */
  431. #ifdef CONFIG_NUMA
  432. #define NUMA_BUILD 1
  433. #else
  434. #define NUMA_BUILD 0
  435. #endif
  436. #endif