kernel.h 17 KB

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