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