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