kernel.h 24 KB

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