kernel.h 16 KB

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