kernel.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787
  1. #ifndef _LINUX_KERNEL_H
  2. #define _LINUX_KERNEL_H
  3. /*
  4. * 'kernel.h' contains some often-used function prototypes etc
  5. */
  6. #define __ALIGN_KERNEL(x, a) __ALIGN_KERNEL_MASK(x, (typeof(x))(a) - 1)
  7. #define __ALIGN_KERNEL_MASK(x, mask) (((x) + (mask)) & ~(mask))
  8. #ifdef __KERNEL__
  9. #include <stdarg.h>
  10. #include <linux/linkage.h>
  11. #include <linux/stddef.h>
  12. #include <linux/types.h>
  13. #include <linux/compiler.h>
  14. #include <linux/bitops.h>
  15. #include <linux/log2.h>
  16. #include <linux/typecheck.h>
  17. #include <linux/dynamic_debug.h>
  18. #include <asm/byteorder.h>
  19. #include <asm/bug.h>
  20. extern const char linux_banner[];
  21. extern const char linux_proc_banner[];
  22. #define USHRT_MAX ((u16)(~0U))
  23. #define SHRT_MAX ((s16)(USHRT_MAX>>1))
  24. #define SHRT_MIN ((s16)(-SHRT_MAX - 1))
  25. #define INT_MAX ((int)(~0U>>1))
  26. #define INT_MIN (-INT_MAX - 1)
  27. #define UINT_MAX (~0U)
  28. #define LONG_MAX ((long)(~0UL>>1))
  29. #define LONG_MIN (-LONG_MAX - 1)
  30. #define ULONG_MAX (~0UL)
  31. #define LLONG_MAX ((long long)(~0ULL>>1))
  32. #define LLONG_MIN (-LLONG_MAX - 1)
  33. #define ULLONG_MAX (~0ULL)
  34. #define STACK_MAGIC 0xdeadbeef
  35. #define ALIGN(x, a) __ALIGN_KERNEL((x), (a))
  36. #define __ALIGN_MASK(x, mask) __ALIGN_KERNEL_MASK((x), (mask))
  37. #define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
  38. #define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
  39. #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
  40. /*
  41. * This looks more complex than it should be. But we need to
  42. * get the type for the ~ right in round_down (it needs to be
  43. * as wide as the result!), and we want to evaluate the macro
  44. * arguments just once each.
  45. */
  46. #define __round_mask(x, y) ((__typeof__(x))((y)-1))
  47. #define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
  48. #define round_down(x, y) ((x) & ~__round_mask(x, y))
  49. #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
  50. #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  51. #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
  52. #define DIV_ROUND_CLOSEST(x, divisor)( \
  53. { \
  54. typeof(divisor) __divisor = divisor; \
  55. (((x) + ((__divisor) / 2)) / (__divisor)); \
  56. } \
  57. )
  58. #define _RET_IP_ (unsigned long)__builtin_return_address(0)
  59. #define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
  60. #ifdef CONFIG_LBDAF
  61. # include <asm/div64.h>
  62. # define sector_div(a, b) do_div(a, b)
  63. #else
  64. # define sector_div(n, b)( \
  65. { \
  66. int _res; \
  67. _res = (n) % (b); \
  68. (n) /= (b); \
  69. _res; \
  70. } \
  71. )
  72. #endif
  73. /**
  74. * upper_32_bits - return bits 32-63 of a number
  75. * @n: the number we're accessing
  76. *
  77. * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
  78. * the "right shift count >= width of type" warning when that quantity is
  79. * 32-bits.
  80. */
  81. #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
  82. /**
  83. * lower_32_bits - return bits 0-31 of a number
  84. * @n: the number we're accessing
  85. */
  86. #define lower_32_bits(n) ((u32)(n))
  87. #define KERN_EMERG "<0>" /* system is unusable */
  88. #define KERN_ALERT "<1>" /* action must be taken immediately */
  89. #define KERN_CRIT "<2>" /* critical conditions */
  90. #define KERN_ERR "<3>" /* error conditions */
  91. #define KERN_WARNING "<4>" /* warning conditions */
  92. #define KERN_NOTICE "<5>" /* normal but significant condition */
  93. #define KERN_INFO "<6>" /* informational */
  94. #define KERN_DEBUG "<7>" /* debug-level messages */
  95. /* Use the default kernel loglevel */
  96. #define KERN_DEFAULT "<d>"
  97. /*
  98. * Annotation for a "continued" line of log printout (only done after a
  99. * line that had no enclosing \n). Only to be used by core/arch code
  100. * during early bootup (a continued line is not SMP-safe otherwise).
  101. */
  102. #define KERN_CONT "<c>"
  103. extern int console_printk[];
  104. #define console_loglevel (console_printk[0])
  105. #define default_message_loglevel (console_printk[1])
  106. #define minimum_console_loglevel (console_printk[2])
  107. #define default_console_loglevel (console_printk[3])
  108. struct completion;
  109. struct pt_regs;
  110. struct user;
  111. #ifdef CONFIG_PREEMPT_VOLUNTARY
  112. extern int _cond_resched(void);
  113. # define might_resched() _cond_resched()
  114. #else
  115. # define might_resched() do { } while (0)
  116. #endif
  117. #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
  118. void __might_sleep(const char *file, int line, int preempt_offset);
  119. /**
  120. * might_sleep - annotation for functions that can sleep
  121. *
  122. * this macro will print a stack trace if it is executed in an atomic
  123. * context (spinlock, irq-handler, ...).
  124. *
  125. * This is a useful debugging help to be able to catch problems early and not
  126. * be bitten later when the calling function happens to sleep when it is not
  127. * supposed to.
  128. */
  129. # define might_sleep() \
  130. do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
  131. #else
  132. static inline void __might_sleep(const char *file, int line,
  133. int preempt_offset) { }
  134. # define might_sleep() do { might_resched(); } while (0)
  135. #endif
  136. #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
  137. #define abs(x) ({ \
  138. long __x = (x); \
  139. (__x < 0) ? -__x : __x; \
  140. })
  141. #ifdef CONFIG_PROVE_LOCKING
  142. void might_fault(void);
  143. #else
  144. static inline void might_fault(void)
  145. {
  146. might_sleep();
  147. }
  148. #endif
  149. extern struct atomic_notifier_head panic_notifier_list;
  150. extern long (*panic_blink)(long time);
  151. NORET_TYPE void panic(const char * fmt, ...)
  152. __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
  153. extern void oops_enter(void);
  154. extern void oops_exit(void);
  155. extern int oops_may_print(void);
  156. NORET_TYPE void do_exit(long error_code)
  157. ATTRIB_NORET;
  158. NORET_TYPE void complete_and_exit(struct completion *, long)
  159. ATTRIB_NORET;
  160. extern unsigned long simple_strtoul(const char *,char **,unsigned int);
  161. extern long simple_strtol(const char *,char **,unsigned int);
  162. extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
  163. extern long long simple_strtoll(const char *,char **,unsigned int);
  164. extern int strict_strtoul(const char *, unsigned int, unsigned long *);
  165. extern int strict_strtol(const char *, unsigned int, long *);
  166. extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
  167. extern int strict_strtoll(const char *, unsigned int, long long *);
  168. extern int sprintf(char * buf, const char * fmt, ...)
  169. __attribute__ ((format (printf, 2, 3)));
  170. extern int vsprintf(char *buf, const char *, va_list)
  171. __attribute__ ((format (printf, 2, 0)));
  172. extern int snprintf(char * buf, size_t size, const char * fmt, ...)
  173. __attribute__ ((format (printf, 3, 4)));
  174. extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
  175. __attribute__ ((format (printf, 3, 0)));
  176. extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
  177. __attribute__ ((format (printf, 3, 4)));
  178. extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
  179. __attribute__ ((format (printf, 3, 0)));
  180. extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
  181. __attribute__ ((format (printf, 2, 3)));
  182. extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
  183. extern int sscanf(const char *, const char *, ...)
  184. __attribute__ ((format (scanf, 2, 3)));
  185. extern int vsscanf(const char *, const char *, va_list)
  186. __attribute__ ((format (scanf, 2, 0)));
  187. extern int get_option(char **str, int *pint);
  188. extern char *get_options(const char *str, int nints, int *ints);
  189. extern unsigned long long memparse(const char *ptr, char **retptr);
  190. extern int core_kernel_text(unsigned long addr);
  191. extern int __kernel_text_address(unsigned long addr);
  192. extern int kernel_text_address(unsigned long addr);
  193. extern int func_ptr_is_kernel_text(void *ptr);
  194. struct pid;
  195. extern struct pid *session_of_pgrp(struct pid *pgrp);
  196. /*
  197. * FW_BUG
  198. * Add this to a message where you are sure the firmware is buggy or behaves
  199. * really stupid or out of spec. Be aware that the responsible BIOS developer
  200. * should be able to fix this issue or at least get a concrete idea of the
  201. * problem by reading your message without the need of looking at the kernel
  202. * code.
  203. *
  204. * Use it for definite and high priority BIOS bugs.
  205. *
  206. * FW_WARN
  207. * Use it for not that clear (e.g. could the kernel messed up things already?)
  208. * and medium priority BIOS bugs.
  209. *
  210. * FW_INFO
  211. * Use this one if you want to tell the user or vendor about something
  212. * suspicious, but generally harmless related to the firmware.
  213. *
  214. * Use it for information or very low priority BIOS bugs.
  215. */
  216. #define FW_BUG "[Firmware Bug]: "
  217. #define FW_WARN "[Firmware Warn]: "
  218. #define FW_INFO "[Firmware Info]: "
  219. #ifdef CONFIG_PRINTK
  220. asmlinkage int vprintk(const char *fmt, va_list args)
  221. __attribute__ ((format (printf, 1, 0)));
  222. asmlinkage int printk(const char * fmt, ...)
  223. __attribute__ ((format (printf, 1, 2))) __cold;
  224. extern int __printk_ratelimit(const char *func);
  225. #define printk_ratelimit() __printk_ratelimit(__func__)
  226. extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
  227. unsigned int interval_msec);
  228. extern int printk_delay_msec;
  229. /*
  230. * Print a one-time message (analogous to WARN_ONCE() et al):
  231. */
  232. #define printk_once(x...) ({ \
  233. static bool __print_once; \
  234. \
  235. if (!__print_once) { \
  236. __print_once = true; \
  237. printk(x); \
  238. } \
  239. })
  240. void log_buf_kexec_setup(void);
  241. #else
  242. static inline int vprintk(const char *s, va_list args)
  243. __attribute__ ((format (printf, 1, 0)));
  244. static inline int vprintk(const char *s, va_list args) { return 0; }
  245. static inline int printk(const char *s, ...)
  246. __attribute__ ((format (printf, 1, 2)));
  247. static inline int __cold printk(const char *s, ...) { return 0; }
  248. static inline int printk_ratelimit(void) { return 0; }
  249. static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
  250. unsigned int interval_msec) \
  251. { return false; }
  252. /* No effect, but we still get type checking even in the !PRINTK case: */
  253. #define printk_once(x...) printk(x)
  254. static inline void log_buf_kexec_setup(void)
  255. {
  256. }
  257. #endif
  258. extern int printk_needs_cpu(int cpu);
  259. extern void printk_tick(void);
  260. extern void asmlinkage __attribute__((format(printf, 1, 2)))
  261. early_printk(const char *fmt, ...);
  262. unsigned long int_sqrt(unsigned long);
  263. static inline void console_silent(void)
  264. {
  265. console_loglevel = 0;
  266. }
  267. static inline void console_verbose(void)
  268. {
  269. if (console_loglevel)
  270. console_loglevel = 15;
  271. }
  272. extern void bust_spinlocks(int yes);
  273. extern void wake_up_klogd(void);
  274. extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
  275. extern int panic_timeout;
  276. extern int panic_on_oops;
  277. extern int panic_on_unrecovered_nmi;
  278. extern int panic_on_io_nmi;
  279. extern const char *print_tainted(void);
  280. extern void add_taint(unsigned flag);
  281. extern int test_taint(unsigned flag);
  282. extern unsigned long get_taint(void);
  283. extern int root_mountflags;
  284. /* Values used for system_state */
  285. extern enum system_states {
  286. SYSTEM_BOOTING,
  287. SYSTEM_RUNNING,
  288. SYSTEM_HALT,
  289. SYSTEM_POWER_OFF,
  290. SYSTEM_RESTART,
  291. SYSTEM_SUSPEND_DISK,
  292. } system_state;
  293. #define TAINT_PROPRIETARY_MODULE 0
  294. #define TAINT_FORCED_MODULE 1
  295. #define TAINT_UNSAFE_SMP 2
  296. #define TAINT_FORCED_RMMOD 3
  297. #define TAINT_MACHINE_CHECK 4
  298. #define TAINT_BAD_PAGE 5
  299. #define TAINT_USER 6
  300. #define TAINT_DIE 7
  301. #define TAINT_OVERRIDDEN_ACPI_TABLE 8
  302. #define TAINT_WARN 9
  303. #define TAINT_CRAP 10
  304. #define TAINT_FIRMWARE_WORKAROUND 11
  305. extern void dump_stack(void) __cold;
  306. enum {
  307. DUMP_PREFIX_NONE,
  308. DUMP_PREFIX_ADDRESS,
  309. DUMP_PREFIX_OFFSET
  310. };
  311. extern void hex_dump_to_buffer(const void *buf, size_t len,
  312. int rowsize, int groupsize,
  313. char *linebuf, size_t linebuflen, bool ascii);
  314. extern void print_hex_dump(const char *level, const char *prefix_str,
  315. int prefix_type, int rowsize, int groupsize,
  316. const void *buf, size_t len, bool ascii);
  317. extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
  318. const void *buf, size_t len);
  319. extern const char hex_asc[];
  320. #define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
  321. #define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
  322. static inline char *pack_hex_byte(char *buf, u8 byte)
  323. {
  324. *buf++ = hex_asc_hi(byte);
  325. *buf++ = hex_asc_lo(byte);
  326. return buf;
  327. }
  328. extern int hex_to_bin(char ch);
  329. #ifndef pr_fmt
  330. #define pr_fmt(fmt) fmt
  331. #endif
  332. #define pr_emerg(fmt, ...) \
  333. printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
  334. #define pr_alert(fmt, ...) \
  335. printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
  336. #define pr_crit(fmt, ...) \
  337. printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
  338. #define pr_err(fmt, ...) \
  339. printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
  340. #define pr_warning(fmt, ...) \
  341. printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
  342. #define pr_warn pr_warning
  343. #define pr_notice(fmt, ...) \
  344. printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
  345. #define pr_info(fmt, ...) \
  346. printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
  347. #define pr_cont(fmt, ...) \
  348. printk(KERN_CONT fmt, ##__VA_ARGS__)
  349. /* pr_devel() should produce zero code unless DEBUG is defined */
  350. #ifdef DEBUG
  351. #define pr_devel(fmt, ...) \
  352. printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
  353. #else
  354. #define pr_devel(fmt, ...) \
  355. ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
  356. #endif
  357. /* If you are writing a driver, please use dev_dbg instead */
  358. #if defined(DEBUG)
  359. #define pr_debug(fmt, ...) \
  360. printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
  361. #elif defined(CONFIG_DYNAMIC_DEBUG)
  362. /* dynamic_pr_debug() uses pr_fmt() internally so we don't need it here */
  363. #define pr_debug(fmt, ...) \
  364. dynamic_pr_debug(fmt, ##__VA_ARGS__)
  365. #else
  366. #define pr_debug(fmt, ...) \
  367. ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
  368. #endif
  369. /*
  370. * ratelimited messages with local ratelimit_state,
  371. * no local ratelimit_state used in the !PRINTK case
  372. */
  373. #ifdef CONFIG_PRINTK
  374. #define printk_ratelimited(fmt, ...) ({ \
  375. static DEFINE_RATELIMIT_STATE(_rs, \
  376. DEFAULT_RATELIMIT_INTERVAL, \
  377. DEFAULT_RATELIMIT_BURST); \
  378. \
  379. if (__ratelimit(&_rs)) \
  380. printk(fmt, ##__VA_ARGS__); \
  381. })
  382. #else
  383. /* No effect, but we still get type checking even in the !PRINTK case: */
  384. #define printk_ratelimited printk
  385. #endif
  386. #define pr_emerg_ratelimited(fmt, ...) \
  387. printk_ratelimited(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
  388. #define pr_alert_ratelimited(fmt, ...) \
  389. printk_ratelimited(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
  390. #define pr_crit_ratelimited(fmt, ...) \
  391. printk_ratelimited(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
  392. #define pr_err_ratelimited(fmt, ...) \
  393. printk_ratelimited(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
  394. #define pr_warning_ratelimited(fmt, ...) \
  395. printk_ratelimited(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
  396. #define pr_warn_ratelimited pr_warning_ratelimited
  397. #define pr_notice_ratelimited(fmt, ...) \
  398. printk_ratelimited(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
  399. #define pr_info_ratelimited(fmt, ...) \
  400. printk_ratelimited(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
  401. /* no pr_cont_ratelimited, don't do that... */
  402. /* If you are writing a driver, please use dev_dbg instead */
  403. #if defined(DEBUG)
  404. #define pr_debug_ratelimited(fmt, ...) \
  405. printk_ratelimited(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
  406. #else
  407. #define pr_debug_ratelimited(fmt, ...) \
  408. ({ if (0) printk_ratelimited(KERN_DEBUG pr_fmt(fmt), \
  409. ##__VA_ARGS__); 0; })
  410. #endif
  411. /*
  412. * General tracing related utility functions - trace_printk(),
  413. * tracing_on/tracing_off and tracing_start()/tracing_stop
  414. *
  415. * Use tracing_on/tracing_off when you want to quickly turn on or off
  416. * tracing. It simply enables or disables the recording of the trace events.
  417. * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
  418. * file, which gives a means for the kernel and userspace to interact.
  419. * Place a tracing_off() in the kernel where you want tracing to end.
  420. * From user space, examine the trace, and then echo 1 > tracing_on
  421. * to continue tracing.
  422. *
  423. * tracing_stop/tracing_start has slightly more overhead. It is used
  424. * by things like suspend to ram where disabling the recording of the
  425. * trace is not enough, but tracing must actually stop because things
  426. * like calling smp_processor_id() may crash the system.
  427. *
  428. * Most likely, you want to use tracing_on/tracing_off.
  429. */
  430. #ifdef CONFIG_RING_BUFFER
  431. void tracing_on(void);
  432. void tracing_off(void);
  433. /* trace_off_permanent stops recording with no way to bring it back */
  434. void tracing_off_permanent(void);
  435. int tracing_is_on(void);
  436. #else
  437. static inline void tracing_on(void) { }
  438. static inline void tracing_off(void) { }
  439. static inline void tracing_off_permanent(void) { }
  440. static inline int tracing_is_on(void) { return 0; }
  441. #endif
  442. enum ftrace_dump_mode {
  443. DUMP_NONE,
  444. DUMP_ALL,
  445. DUMP_ORIG,
  446. };
  447. #ifdef CONFIG_TRACING
  448. extern void tracing_start(void);
  449. extern void tracing_stop(void);
  450. extern void ftrace_off_permanent(void);
  451. extern void
  452. ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
  453. static inline void __attribute__ ((format (printf, 1, 2)))
  454. ____trace_printk_check_format(const char *fmt, ...)
  455. {
  456. }
  457. #define __trace_printk_check_format(fmt, args...) \
  458. do { \
  459. if (0) \
  460. ____trace_printk_check_format(fmt, ##args); \
  461. } while (0)
  462. /**
  463. * trace_printk - printf formatting in the ftrace buffer
  464. * @fmt: the printf format for printing
  465. *
  466. * Note: __trace_printk is an internal function for trace_printk and
  467. * the @ip is passed in via the trace_printk macro.
  468. *
  469. * This function allows a kernel developer to debug fast path sections
  470. * that printk is not appropriate for. By scattering in various
  471. * printk like tracing in the code, a developer can quickly see
  472. * where problems are occurring.
  473. *
  474. * This is intended as a debugging tool for the developer only.
  475. * Please refrain from leaving trace_printks scattered around in
  476. * your code.
  477. */
  478. #define trace_printk(fmt, args...) \
  479. do { \
  480. __trace_printk_check_format(fmt, ##args); \
  481. if (__builtin_constant_p(fmt)) { \
  482. static const char *trace_printk_fmt \
  483. __attribute__((section("__trace_printk_fmt"))) = \
  484. __builtin_constant_p(fmt) ? fmt : NULL; \
  485. \
  486. __trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args); \
  487. } else \
  488. __trace_printk(_THIS_IP_, fmt, ##args); \
  489. } while (0)
  490. extern int
  491. __trace_bprintk(unsigned long ip, const char *fmt, ...)
  492. __attribute__ ((format (printf, 2, 3)));
  493. extern int
  494. __trace_printk(unsigned long ip, const char *fmt, ...)
  495. __attribute__ ((format (printf, 2, 3)));
  496. extern void trace_dump_stack(void);
  497. /*
  498. * The double __builtin_constant_p is because gcc will give us an error
  499. * if we try to allocate the static variable to fmt if it is not a
  500. * constant. Even with the outer if statement.
  501. */
  502. #define ftrace_vprintk(fmt, vargs) \
  503. do { \
  504. if (__builtin_constant_p(fmt)) { \
  505. static const char *trace_printk_fmt \
  506. __attribute__((section("__trace_printk_fmt"))) = \
  507. __builtin_constant_p(fmt) ? fmt : NULL; \
  508. \
  509. __ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs); \
  510. } else \
  511. __ftrace_vprintk(_THIS_IP_, fmt, vargs); \
  512. } while (0)
  513. extern int
  514. __ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);
  515. extern int
  516. __ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
  517. extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
  518. #else
  519. static inline void
  520. ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
  521. static inline int
  522. trace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
  523. static inline void tracing_start(void) { }
  524. static inline void tracing_stop(void) { }
  525. static inline void ftrace_off_permanent(void) { }
  526. static inline void trace_dump_stack(void) { }
  527. static inline int
  528. trace_printk(const char *fmt, ...)
  529. {
  530. return 0;
  531. }
  532. static inline int
  533. ftrace_vprintk(const char *fmt, va_list ap)
  534. {
  535. return 0;
  536. }
  537. static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
  538. #endif /* CONFIG_TRACING */
  539. /*
  540. * Display an IP address in readable format.
  541. */
  542. #define NIPQUAD(addr) \
  543. ((unsigned char *)&addr)[0], \
  544. ((unsigned char *)&addr)[1], \
  545. ((unsigned char *)&addr)[2], \
  546. ((unsigned char *)&addr)[3]
  547. #define NIPQUAD_FMT "%u.%u.%u.%u"
  548. /*
  549. * min()/max()/clamp() macros that also do
  550. * strict type-checking.. See the
  551. * "unnecessary" pointer comparison.
  552. */
  553. #define min(x, y) ({ \
  554. typeof(x) _min1 = (x); \
  555. typeof(y) _min2 = (y); \
  556. (void) (&_min1 == &_min2); \
  557. _min1 < _min2 ? _min1 : _min2; })
  558. #define max(x, y) ({ \
  559. typeof(x) _max1 = (x); \
  560. typeof(y) _max2 = (y); \
  561. (void) (&_max1 == &_max2); \
  562. _max1 > _max2 ? _max1 : _max2; })
  563. /**
  564. * clamp - return a value clamped to a given range with strict typechecking
  565. * @val: current value
  566. * @min: minimum allowable value
  567. * @max: maximum allowable value
  568. *
  569. * This macro does strict typechecking of min/max to make sure they are of the
  570. * same type as val. See the unnecessary pointer comparisons.
  571. */
  572. #define clamp(val, min, max) ({ \
  573. typeof(val) __val = (val); \
  574. typeof(min) __min = (min); \
  575. typeof(max) __max = (max); \
  576. (void) (&__val == &__min); \
  577. (void) (&__val == &__max); \
  578. __val = __val < __min ? __min: __val; \
  579. __val > __max ? __max: __val; })
  580. /*
  581. * ..and if you can't take the strict
  582. * types, you can specify one yourself.
  583. *
  584. * Or not use min/max/clamp at all, of course.
  585. */
  586. #define min_t(type, x, y) ({ \
  587. type __min1 = (x); \
  588. type __min2 = (y); \
  589. __min1 < __min2 ? __min1: __min2; })
  590. #define max_t(type, x, y) ({ \
  591. type __max1 = (x); \
  592. type __max2 = (y); \
  593. __max1 > __max2 ? __max1: __max2; })
  594. /**
  595. * clamp_t - return a value clamped to a given range using a given type
  596. * @type: the type of variable to use
  597. * @val: current value
  598. * @min: minimum allowable value
  599. * @max: maximum allowable value
  600. *
  601. * This macro does no typechecking and uses temporary variables of type
  602. * 'type' to make all the comparisons.
  603. */
  604. #define clamp_t(type, val, min, max) ({ \
  605. type __val = (val); \
  606. type __min = (min); \
  607. type __max = (max); \
  608. __val = __val < __min ? __min: __val; \
  609. __val > __max ? __max: __val; })
  610. /**
  611. * clamp_val - return a value clamped to a given range using val's type
  612. * @val: current value
  613. * @min: minimum allowable value
  614. * @max: maximum allowable value
  615. *
  616. * This macro does no typechecking and uses temporary variables of whatever
  617. * type the input argument 'val' is. This is useful when val is an unsigned
  618. * type and min and max are literals that will otherwise be assigned a signed
  619. * integer type.
  620. */
  621. #define clamp_val(val, min, max) ({ \
  622. typeof(val) __val = (val); \
  623. typeof(val) __min = (min); \
  624. typeof(val) __max = (max); \
  625. __val = __val < __min ? __min: __val; \
  626. __val > __max ? __max: __val; })
  627. /*
  628. * swap - swap value of @a and @b
  629. */
  630. #define swap(a, b) \
  631. do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
  632. /**
  633. * container_of - cast a member of a structure out to the containing structure
  634. * @ptr: the pointer to the member.
  635. * @type: the type of the container struct this is embedded in.
  636. * @member: the name of the member within the struct.
  637. *
  638. */
  639. #define container_of(ptr, type, member) ({ \
  640. const typeof( ((type *)0)->member ) *__mptr = (ptr); \
  641. (type *)( (char *)__mptr - offsetof(type,member) );})
  642. struct sysinfo;
  643. extern int do_sysinfo(struct sysinfo *info);
  644. #endif /* __KERNEL__ */
  645. #ifndef __EXPORTED_HEADERS__
  646. #ifndef __KERNEL__
  647. #warning Attempt to use kernel headers from user space, see http://kernelnewbies.org/KernelHeaders
  648. #endif /* __KERNEL__ */
  649. #endif /* __EXPORTED_HEADERS__ */
  650. #define SI_LOAD_SHIFT 16
  651. struct sysinfo {
  652. long uptime; /* Seconds since boot */
  653. unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
  654. unsigned long totalram; /* Total usable main memory size */
  655. unsigned long freeram; /* Available memory size */
  656. unsigned long sharedram; /* Amount of shared memory */
  657. unsigned long bufferram; /* Memory used by buffers */
  658. unsigned long totalswap; /* Total swap space size */
  659. unsigned long freeswap; /* swap space still available */
  660. unsigned short procs; /* Number of current processes */
  661. unsigned short pad; /* explicit padding for m68k */
  662. unsigned long totalhigh; /* Total high memory size */
  663. unsigned long freehigh; /* Available high memory size */
  664. unsigned int mem_unit; /* Memory unit size in bytes */
  665. char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
  666. };
  667. /* Force a compilation error if condition is true */
  668. #define BUILD_BUG_ON(condition) ((void)BUILD_BUG_ON_ZERO(condition))
  669. /* Force a compilation error if condition is constant and true */
  670. #define MAYBE_BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2 * !!(cond)]))
  671. /* Force a compilation error if a constant expression is not a power of 2 */
  672. #define BUILD_BUG_ON_NOT_POWER_OF_2(n) \
  673. BUILD_BUG_ON((n) == 0 || (((n) & ((n) - 1)) != 0))
  674. /* Force a compilation error if condition is true, but also produce a
  675. result (of value 0 and type size_t), so the expression can be used
  676. e.g. in a structure initializer (or where-ever else comma expressions
  677. aren't permitted). */
  678. #define BUILD_BUG_ON_ZERO(e) (sizeof(struct { int:-!!(e); }))
  679. #define BUILD_BUG_ON_NULL(e) ((void *)sizeof(struct { int:-!!(e); }))
  680. /* Trap pasters of __FUNCTION__ at compile-time */
  681. #define __FUNCTION__ (__func__)
  682. /* This helps us to avoid #ifdef CONFIG_NUMA */
  683. #ifdef CONFIG_NUMA
  684. #define NUMA_BUILD 1
  685. #else
  686. #define NUMA_BUILD 0
  687. #endif
  688. /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
  689. #ifdef CONFIG_FTRACE_MCOUNT_RECORD
  690. # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
  691. #endif
  692. #endif