]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/kernel.h
driver core: basic infrastructure for per-module dynamic debug messages
[net-next-2.6.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 */
7
8#ifdef __KERNEL__
9
10#include <stdarg.h>
11#include <linux/linkage.h>
12#include <linux/stddef.h>
13#include <linux/types.h>
14#include <linux/compiler.h>
15#include <linux/bitops.h>
f0d1b0b3 16#include <linux/log2.h>
e0deaff4 17#include <linux/typecheck.h>
717115e1 18#include <linux/ratelimit.h>
346e15be 19#include <linux/dynamic_printk.h>
1da177e4
LT
20#include <asm/byteorder.h>
21#include <asm/bug.h>
22
3eb3c740
RZ
23extern const char linux_banner[];
24extern const char linux_proc_banner[];
25
44f564a4
ZY
26#define USHORT_MAX ((u16)(~0U))
27#define SHORT_MAX ((s16)(USHORT_MAX>>1))
28#define SHORT_MIN (-SHORT_MAX - 1)
1da177e4
LT
29#define INT_MAX ((int)(~0U>>1))
30#define INT_MIN (-INT_MAX - 1)
31#define UINT_MAX (~0U)
32#define LONG_MAX ((long)(~0UL>>1))
33#define LONG_MIN (-LONG_MAX - 1)
34#define ULONG_MAX (~0UL)
111ebb6e
OH
35#define LLONG_MAX ((long long)(~0ULL>>1))
36#define LLONG_MIN (-LLONG_MAX - 1)
37#define ULLONG_MAX (~0ULL)
1da177e4
LT
38
39#define STACK_MAGIC 0xdeadbeef
40
2ea58144
LT
41#define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
42#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
a83308e6 43#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
f10db627 44#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
2ea58144 45
c5e631cf
RR
46#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
47
4552d5dc 48#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
930631ed 49#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
b4cac1a0 50#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
1da177e4 51
ca31e146
EGM
52#define _RET_IP_ (unsigned long)__builtin_return_address(0)
53#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
54
2da96acd
JA
55#ifdef CONFIG_LBD
56# include <asm/div64.h>
57# define sector_div(a, b) do_div(a, b)
58#else
59# define sector_div(n, b)( \
60{ \
61 int _res; \
62 _res = (n) % (b); \
63 (n) /= (b); \
64 _res; \
65} \
66)
67#endif
68
218e180e
AM
69/**
70 * upper_32_bits - return bits 32-63 of a number
71 * @n: the number we're accessing
72 *
73 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
74 * the "right shift count >= width of type" warning when that quantity is
75 * 32-bits.
76 */
77#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
78
204b885e
JR
79/**
80 * lower_32_bits - return bits 0-31 of a number
81 * @n: the number we're accessing
82 */
83#define lower_32_bits(n) ((u32)(n))
84
1da177e4
LT
85#define KERN_EMERG "<0>" /* system is unusable */
86#define KERN_ALERT "<1>" /* action must be taken immediately */
87#define KERN_CRIT "<2>" /* critical conditions */
88#define KERN_ERR "<3>" /* error conditions */
89#define KERN_WARNING "<4>" /* warning conditions */
90#define KERN_NOTICE "<5>" /* normal but significant condition */
91#define KERN_INFO "<6>" /* informational */
92#define KERN_DEBUG "<7>" /* debug-level messages */
93
47492527
IM
94/*
95 * Annotation for a "continued" line of log printout (only done after a
96 * line that had no enclosing \n). Only to be used by core/arch code
97 * during early bootup (a continued line is not SMP-safe otherwise).
98 */
99#define KERN_CONT ""
100
1da177e4
LT
101extern int console_printk[];
102
103#define console_loglevel (console_printk[0])
104#define default_message_loglevel (console_printk[1])
105#define minimum_console_loglevel (console_printk[2])
106#define default_console_loglevel (console_printk[3])
107
108struct completion;
df2e71fb
AM
109struct pt_regs;
110struct user;
1da177e4 111
070cb065
UKK
112#ifdef CONFIG_PREEMPT_VOLUNTARY
113extern int _cond_resched(void);
114# define might_resched() _cond_resched()
115#else
116# define might_resched() do { } while (0)
117#endif
118
1da177e4
LT
119/**
120 * might_sleep - annotation for functions that can sleep
121 *
122 * this macro will print a stack trace if it is executed in an atomic
123 * context (spinlock, irq-handler, ...).
124 *
125 * This is a useful debugging help to be able to catch problems early and not
e20ec991 126 * be bitten later when the calling function happens to sleep when it is not
1da177e4
LT
127 * supposed to.
128 */
129#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
f8cbd99b
IM
130 void __might_sleep(char *file, int line);
131# define might_sleep() \
132 do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
1da177e4 133#else
f8cbd99b 134# define might_sleep() do { might_resched(); } while (0)
1da177e4
LT
135#endif
136
368a5fa1 137#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
f8cbd99b 138
1da177e4
LT
139#define abs(x) ({ \
140 int __x = (x); \
141 (__x < 0) ? -__x : __x; \
142 })
143
e041c683 144extern struct atomic_notifier_head panic_notifier_list;
1da177e4
LT
145extern long (*panic_blink)(long time);
146NORET_TYPE void panic(const char * fmt, ...)
a586df06 147 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
dd287796
AM
148extern void oops_enter(void);
149extern void oops_exit(void);
150extern int oops_may_print(void);
ec701584 151NORET_TYPE void do_exit(long error_code)
1da177e4
LT
152 ATTRIB_NORET;
153NORET_TYPE void complete_and_exit(struct completion *, long)
154 ATTRIB_NORET;
155extern unsigned long simple_strtoul(const char *,char **,unsigned int);
156extern long simple_strtol(const char *,char **,unsigned int);
157extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
158extern long long simple_strtoll(const char *,char **,unsigned int);
06b2a76d
YY
159extern int strict_strtoul(const char *, unsigned int, unsigned long *);
160extern int strict_strtol(const char *, unsigned int, long *);
161extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
162extern int strict_strtoll(const char *, unsigned int, long long *);
1da177e4
LT
163extern int sprintf(char * buf, const char * fmt, ...)
164 __attribute__ ((format (printf, 2, 3)));
165extern int vsprintf(char *buf, const char *, va_list)
166 __attribute__ ((format (printf, 2, 0)));
167extern int snprintf(char * buf, size_t size, const char * fmt, ...)
168 __attribute__ ((format (printf, 3, 4)));
169extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
170 __attribute__ ((format (printf, 3, 0)));
171extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
172 __attribute__ ((format (printf, 3, 4)));
173extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
174 __attribute__ ((format (printf, 3, 0)));
e905914f
JF
175extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
176 __attribute__ ((format (printf, 2, 3)));
11443ec7 177extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
1da177e4
LT
178
179extern int sscanf(const char *, const char *, ...)
180 __attribute__ ((format (scanf, 2, 3)));
181extern int vsscanf(const char *, const char *, va_list)
182 __attribute__ ((format (scanf, 2, 0)));
183
184extern int get_option(char **str, int *pint);
185extern char *get_options(const char *str, int nints, int *ints);
d974ae37 186extern unsigned long long memparse(const char *ptr, char **retptr);
1da177e4 187
5e376613 188extern int core_kernel_text(unsigned long addr);
1da177e4
LT
189extern int __kernel_text_address(unsigned long addr);
190extern int kernel_text_address(unsigned long addr);
04a2e6a5
EB
191struct pid;
192extern struct pid *session_of_pgrp(struct pid *pgrp);
1da177e4 193
d59745ce 194#ifdef CONFIG_PRINTK
1da177e4
LT
195asmlinkage int vprintk(const char *fmt, va_list args)
196 __attribute__ ((format (printf, 1, 0)));
197asmlinkage int printk(const char * fmt, ...)
a586df06 198 __attribute__ ((format (printf, 1, 2))) __cold;
7ef3d2fd 199
717115e1 200extern struct ratelimit_state printk_ratelimit_state;
7ef3d2fd 201extern int printk_ratelimit(void);
7ef3d2fd
JP
202extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
203 unsigned int interval_msec);
d59745ce
MM
204#else
205static inline int vprintk(const char *s, va_list args)
206 __attribute__ ((format (printf, 1, 0)));
207static inline int vprintk(const char *s, va_list args) { return 0; }
208static inline int printk(const char *s, ...)
209 __attribute__ ((format (printf, 1, 2)));
a586df06 210static inline int __cold printk(const char *s, ...) { return 0; }
7ef3d2fd 211static inline int printk_ratelimit(void) { return 0; }
7ef3d2fd
JP
212static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
213 unsigned int interval_msec) \
214 { return false; }
d59745ce 215#endif
1da177e4 216
e17ba73b 217extern void asmlinkage __attribute__((format(printf, 1, 2)))
076f9776
IM
218 early_printk(const char *fmt, ...);
219
1da177e4
LT
220unsigned long int_sqrt(unsigned long);
221
1da177e4
LT
222static inline void console_silent(void)
223{
224 console_loglevel = 0;
225}
226
227static inline void console_verbose(void)
228{
229 if (console_loglevel)
230 console_loglevel = 15;
231}
232
233extern void bust_spinlocks(int yes);
e3e8a75d 234extern void wake_up_klogd(void);
1da177e4 235extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
aa727107 236extern int panic_timeout;
1da177e4 237extern int panic_on_oops;
8da5adda 238extern int panic_on_unrecovered_nmi;
1da177e4
LT
239extern int tainted;
240extern const char *print_tainted(void);
241extern void add_taint(unsigned);
b920de1b 242extern int root_mountflags;
1da177e4
LT
243
244/* Values used for system_state */
245extern enum system_states {
246 SYSTEM_BOOTING,
247 SYSTEM_RUNNING,
248 SYSTEM_HALT,
249 SYSTEM_POWER_OFF,
250 SYSTEM_RESTART,
729b4d4c 251 SYSTEM_SUSPEND_DISK,
1da177e4
LT
252} system_state;
253
254#define TAINT_PROPRIETARY_MODULE (1<<0)
255#define TAINT_FORCED_MODULE (1<<1)
256#define TAINT_UNSAFE_SMP (1<<2)
257#define TAINT_FORCED_RMMOD (1<<3)
258#define TAINT_MACHINE_CHECK (1<<4)
259#define TAINT_BAD_PAGE (1<<5)
34f5a398 260#define TAINT_USER (1<<6)
bcdcd8e7 261#define TAINT_DIE (1<<7)
6ed31e92 262#define TAINT_OVERRIDDEN_ACPI_TABLE (1<<8)
95b570c9 263#define TAINT_WARN (1<<9)
1da177e4 264
a586df06 265extern void dump_stack(void) __cold;
1da177e4 266
99eaf3c4
RD
267enum {
268 DUMP_PREFIX_NONE,
269 DUMP_PREFIX_ADDRESS,
270 DUMP_PREFIX_OFFSET
271};
c7909234
RD
272extern void hex_dump_to_buffer(const void *buf, size_t len,
273 int rowsize, int groupsize,
274 char *linebuf, size_t linebuflen, bool ascii);
275extern void print_hex_dump(const char *level, const char *prefix_str,
276 int prefix_type, int rowsize, int groupsize,
6a0ed91e 277 const void *buf, size_t len, bool ascii);
c7909234 278extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
eb9a9a56 279 const void *buf, size_t len);
3fc95772
HH
280
281extern const char hex_asc[];
282#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
283#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
284
285static inline char *pack_hex_byte(char *buf, u8 byte)
286{
287 *buf++ = hex_asc_hi(byte);
288 *buf++ = hex_asc_lo(byte);
289 return buf;
290}
99eaf3c4 291
1f7c8234
EM
292#define pr_emerg(fmt, arg...) \
293 printk(KERN_EMERG fmt, ##arg)
294#define pr_alert(fmt, arg...) \
295 printk(KERN_ALERT fmt, ##arg)
296#define pr_crit(fmt, arg...) \
297 printk(KERN_CRIT fmt, ##arg)
298#define pr_err(fmt, arg...) \
299 printk(KERN_ERR fmt, ##arg)
300#define pr_warning(fmt, arg...) \
301 printk(KERN_WARNING fmt, ##arg)
302#define pr_notice(fmt, arg...) \
303 printk(KERN_NOTICE fmt, ##arg)
304#define pr_info(fmt, arg...) \
305 printk(KERN_INFO fmt, ##arg)
306
1cc6daf2 307/* If you are writing a driver, please use dev_dbg instead */
346e15be
JB
308#if defined(CONFIG_DYNAMIC_PRINTK_DEBUG)
309#define pr_debug(fmt, ...) do { \
310 dynamic_pr_debug(fmt, ##__VA_ARGS__); \
311 } while (0)
312#elif defined(DEBUG)
1f7c8234
EM
313#define pr_debug(fmt, arg...) \
314 printk(KERN_DEBUG fmt, ##arg)
1da177e4 315#else
1429db83
JP
316#define pr_debug(fmt, arg...) \
317 ({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
1da177e4
LT
318#endif
319
1da177e4
LT
320/*
321 * Display an IP address in readable format.
322 */
323
324#define NIPQUAD(addr) \
325 ((unsigned char *)&addr)[0], \
326 ((unsigned char *)&addr)[1], \
327 ((unsigned char *)&addr)[2], \
328 ((unsigned char *)&addr)[3]
46b86a2d 329#define NIPQUAD_FMT "%u.%u.%u.%u"
1da177e4
LT
330
331#define NIP6(addr) \
332 ntohs((addr).s6_addr16[0]), \
333 ntohs((addr).s6_addr16[1]), \
334 ntohs((addr).s6_addr16[2]), \
335 ntohs((addr).s6_addr16[3]), \
336 ntohs((addr).s6_addr16[4]), \
337 ntohs((addr).s6_addr16[5]), \
338 ntohs((addr).s6_addr16[6]), \
339 ntohs((addr).s6_addr16[7])
46b86a2d 340#define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
9343e79a 341#define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
1da177e4
LT
342
343#if defined(__LITTLE_ENDIAN)
344#define HIPQUAD(addr) \
345 ((unsigned char *)&addr)[3], \
346 ((unsigned char *)&addr)[2], \
347 ((unsigned char *)&addr)[1], \
348 ((unsigned char *)&addr)[0]
349#elif defined(__BIG_ENDIAN)
350#define HIPQUAD NIPQUAD
351#else
352#error "Please fix asm/byteorder.h"
353#endif /* __LITTLE_ENDIAN */
354
355/*
bdf4bbaa 356 * min()/max()/clamp() macros that also do
1da177e4
LT
357 * strict type-checking.. See the
358 * "unnecessary" pointer comparison.
359 */
bdf4bbaa
HH
360#define min(x, y) ({ \
361 typeof(x) _min1 = (x); \
362 typeof(y) _min2 = (y); \
363 (void) (&_min1 == &_min2); \
364 _min1 < _min2 ? _min1 : _min2; })
365
366#define max(x, y) ({ \
367 typeof(x) _max1 = (x); \
368 typeof(y) _max2 = (y); \
369 (void) (&_max1 == &_max2); \
370 _max1 > _max2 ? _max1 : _max2; })
371
372/**
373 * clamp - return a value clamped to a given range with strict typechecking
374 * @val: current value
375 * @min: minimum allowable value
376 * @max: maximum allowable value
377 *
378 * This macro does strict typechecking of min/max to make sure they are of the
379 * same type as val. See the unnecessary pointer comparisons.
380 */
381#define clamp(val, min, max) ({ \
382 typeof(val) __val = (val); \
383 typeof(min) __min = (min); \
384 typeof(max) __max = (max); \
385 (void) (&__val == &__min); \
386 (void) (&__val == &__max); \
387 __val = __val < __min ? __min: __val; \
388 __val > __max ? __max: __val; })
1da177e4
LT
389
390/*
391 * ..and if you can't take the strict
392 * types, you can specify one yourself.
393 *
bdf4bbaa
HH
394 * Or not use min/max/clamp at all, of course.
395 */
396#define min_t(type, x, y) ({ \
397 type __min1 = (x); \
398 type __min2 = (y); \
399 __min1 < __min2 ? __min1: __min2; })
400
401#define max_t(type, x, y) ({ \
402 type __max1 = (x); \
403 type __max2 = (y); \
404 __max1 > __max2 ? __max1: __max2; })
405
406/**
407 * clamp_t - return a value clamped to a given range using a given type
408 * @type: the type of variable to use
409 * @val: current value
410 * @min: minimum allowable value
411 * @max: maximum allowable value
412 *
413 * This macro does no typechecking and uses temporary variables of type
414 * 'type' to make all the comparisons.
1da177e4 415 */
bdf4bbaa
HH
416#define clamp_t(type, val, min, max) ({ \
417 type __val = (val); \
418 type __min = (min); \
419 type __max = (max); \
420 __val = __val < __min ? __min: __val; \
421 __val > __max ? __max: __val; })
1da177e4 422
bdf4bbaa
HH
423/**
424 * clamp_val - return a value clamped to a given range using val's type
425 * @val: current value
426 * @min: minimum allowable value
427 * @max: maximum allowable value
428 *
429 * This macro does no typechecking and uses temporary variables of whatever
430 * type the input argument 'val' is. This is useful when val is an unsigned
431 * type and min and max are literals that will otherwise be assigned a signed
432 * integer type.
433 */
434#define clamp_val(val, min, max) ({ \
435 typeof(val) __val = (val); \
436 typeof(val) __min = (min); \
437 typeof(val) __max = (max); \
438 __val = __val < __min ? __min: __val; \
439 __val > __max ? __max: __val; })
1da177e4
LT
440
441/**
442 * container_of - cast a member of a structure out to the containing structure
1da177e4
LT
443 * @ptr: the pointer to the member.
444 * @type: the type of the container struct this is embedded in.
445 * @member: the name of the member within the struct.
446 *
447 */
448#define container_of(ptr, type, member) ({ \
78db2ad6
DW
449 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
450 (type *)( (char *)__mptr - offsetof(type,member) );})
1da177e4 451
d4d23add
KM
452struct sysinfo;
453extern int do_sysinfo(struct sysinfo *info);
454
1da177e4
LT
455#endif /* __KERNEL__ */
456
457#define SI_LOAD_SHIFT 16
458struct sysinfo {
459 long uptime; /* Seconds since boot */
460 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
461 unsigned long totalram; /* Total usable main memory size */
462 unsigned long freeram; /* Available memory size */
463 unsigned long sharedram; /* Amount of shared memory */
464 unsigned long bufferram; /* Memory used by buffers */
465 unsigned long totalswap; /* Total swap space size */
466 unsigned long freeswap; /* swap space still available */
467 unsigned short procs; /* Number of current processes */
468 unsigned short pad; /* explicit padding for m68k */
469 unsigned long totalhigh; /* Total high memory size */
470 unsigned long freehigh; /* Available high memory size */
471 unsigned int mem_unit; /* Memory unit size in bytes */
472 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
473};
474
c0398ee6 475/* Force a compilation error if condition is true */
921717a2 476#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
1da177e4 477
4552d5dc
JB
478/* Force a compilation error if condition is true, but also produce a
479 result (of value 0 and type size_t), so the expression can be used
480 e.g. in a structure initializer (or where-ever else comma expressions
481 aren't permitted). */
482#define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
483
1da177e4 484/* Trap pasters of __FUNCTION__ at compile-time */
1da177e4 485#define __FUNCTION__ (__func__)
1da177e4 486
08e0f6a9
CL
487/* This helps us to avoid #ifdef CONFIG_NUMA */
488#ifdef CONFIG_NUMA
489#define NUMA_BUILD 1
490#else
491#define NUMA_BUILD 0
492#endif
493
1da177e4 494#endif