blob: 568042290c0ba5809269fc250a1d2d56504e04f1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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>
David Howellsf0d1b0b2006-12-08 02:37:49 -080016#include <linux/log2.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <asm/byteorder.h>
18#include <asm/bug.h>
19
Roman Zippel3eb3c742007-01-10 14:45:28 +010020extern const char linux_banner[];
21extern const char linux_proc_banner[];
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#define INT_MAX ((int)(~0U>>1))
24#define INT_MIN (-INT_MAX - 1)
25#define UINT_MAX (~0U)
26#define LONG_MAX ((long)(~0UL>>1))
27#define LONG_MIN (-LONG_MAX - 1)
28#define ULONG_MAX (~0UL)
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -070029#define LLONG_MAX ((long long)(~0ULL>>1))
30#define LLONG_MIN (-LLONG_MAX - 1)
31#define ULLONG_MAX (~0ULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
33#define STACK_MAGIC 0xdeadbeef
34
Linus Torvalds2ea58142006-11-26 19:05:22 -080035#define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
36#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
Matthew Wilcoxa83308e2007-09-11 15:23:47 -070037#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
Herbert Xuf10db622008-02-06 01:37:05 -080038#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
Linus Torvalds2ea58142006-11-26 19:05:22 -080039
Rusty Russellc5e631c2007-05-06 14:51:05 -070040#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
41
Jan Beulich4552d5d2006-06-26 13:57:28 +020042#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Steven Whitehouse930631e2006-09-25 23:32:40 -070043#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
David Howellsb4cac1a2006-07-10 04:44:54 -070044#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Jens Axboe2da96ac2007-10-12 12:40:38 +020046#ifdef CONFIG_LBD
47# include <asm/div64.h>
48# define sector_div(a, b) do_div(a, b)
49#else
50# define sector_div(n, b)( \
51{ \
52 int _res; \
53 _res = (n) % (b); \
54 (n) /= (b); \
55 _res; \
56} \
57)
58#endif
59
Andrew Morton218e1802007-05-10 03:15:18 -070060/**
61 * upper_32_bits - return bits 32-63 of a number
62 * @n: the number we're accessing
63 *
64 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
65 * the "right shift count >= width of type" warning when that quantity is
66 * 32-bits.
67 */
68#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
69
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#define KERN_EMERG "<0>" /* system is unusable */
71#define KERN_ALERT "<1>" /* action must be taken immediately */
72#define KERN_CRIT "<2>" /* critical conditions */
73#define KERN_ERR "<3>" /* error conditions */
74#define KERN_WARNING "<4>" /* warning conditions */
75#define KERN_NOTICE "<5>" /* normal but significant condition */
76#define KERN_INFO "<6>" /* informational */
77#define KERN_DEBUG "<7>" /* debug-level messages */
78
Ingo Molnar47492522007-10-16 23:30:29 -070079/*
80 * Annotation for a "continued" line of log printout (only done after a
81 * line that had no enclosing \n). Only to be used by core/arch code
82 * during early bootup (a continued line is not SMP-safe otherwise).
83 */
84#define KERN_CONT ""
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086extern int console_printk[];
87
88#define console_loglevel (console_printk[0])
89#define default_message_loglevel (console_printk[1])
90#define minimum_console_loglevel (console_printk[2])
91#define default_console_loglevel (console_printk[3])
92
93struct completion;
akpm@osdl.orgdf2e71f2006-01-09 20:51:37 -080094struct pt_regs;
95struct user;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
97/**
98 * might_sleep - annotation for functions that can sleep
99 *
100 * this macro will print a stack trace if it is executed in an atomic
101 * context (spinlock, irq-handler, ...).
102 *
103 * This is a useful debugging help to be able to catch problems early and not
Jim Cromiee20ec992006-11-30 04:46:13 +0100104 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 * supposed to.
106 */
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700107#ifdef CONFIG_PREEMPT_VOLUNTARY
Herbert Xu02b67cc2008-01-25 21:08:28 +0100108extern int _cond_resched(void);
109# define might_resched() _cond_resched()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110#else
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700111# define might_resched() do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112#endif
113
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700114#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
115 void __might_sleep(char *file, int line);
116# define might_sleep() \
117 do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
118#else
119# define might_sleep() do { might_resched(); } while (0)
120#endif
121
Hua Zhong368a5fa2006-06-23 02:05:42 -0700122#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
Ingo Molnarf8cbd992005-06-25 14:57:39 -0700123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124#define abs(x) ({ \
125 int __x = (x); \
126 (__x < 0) ? -__x : __x; \
127 })
128
Alan Sterne041c682006-03-27 01:16:30 -0800129extern struct atomic_notifier_head panic_notifier_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130extern long (*panic_blink)(long time);
131NORET_TYPE void panic(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200132 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
Andrew Mortondd287792006-03-23 03:00:57 -0800133extern void oops_enter(void);
134extern void oops_exit(void);
135extern int oops_may_print(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136fastcall NORET_TYPE void do_exit(long error_code)
137 ATTRIB_NORET;
138NORET_TYPE void complete_and_exit(struct completion *, long)
139 ATTRIB_NORET;
140extern unsigned long simple_strtoul(const char *,char **,unsigned int);
141extern long simple_strtol(const char *,char **,unsigned int);
142extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
143extern long long simple_strtoll(const char *,char **,unsigned int);
144extern int sprintf(char * buf, const char * fmt, ...)
145 __attribute__ ((format (printf, 2, 3)));
146extern int vsprintf(char *buf, const char *, va_list)
147 __attribute__ ((format (printf, 2, 0)));
148extern int snprintf(char * buf, size_t size, const char * fmt, ...)
149 __attribute__ ((format (printf, 3, 4)));
150extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
151 __attribute__ ((format (printf, 3, 0)));
152extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
153 __attribute__ ((format (printf, 3, 4)));
154extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
155 __attribute__ ((format (printf, 3, 0)));
Jeremy Fitzhardingee9059142006-06-25 05:49:17 -0700156extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
157 __attribute__ ((format (printf, 2, 3)));
Jeremy Fitzhardinge11443ec2007-04-30 15:09:56 -0700158extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160extern int sscanf(const char *, const char *, ...)
161 __attribute__ ((format (scanf, 2, 3)));
162extern int vsscanf(const char *, const char *, va_list)
163 __attribute__ ((format (scanf, 2, 0)));
164
165extern int get_option(char **str, int *pint);
166extern char *get_options(const char *str, int nints, int *ints);
167extern unsigned long long memparse(char *ptr, char **retptr);
168
Trent Piepho5e376612006-05-15 09:44:06 -0700169extern int core_kernel_text(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170extern int __kernel_text_address(unsigned long addr);
171extern int kernel_text_address(unsigned long addr);
Eric W. Biederman04a2e6a2007-02-12 00:52:56 -0800172struct pid;
173extern struct pid *session_of_pgrp(struct pid *pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Matt Mackalld59745c2005-05-01 08:59:02 -0700175#ifdef CONFIG_PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176asmlinkage int vprintk(const char *fmt, va_list args)
177 __attribute__ ((format (printf, 1, 0)));
178asmlinkage int printk(const char * fmt, ...)
Andi Kleena586df02007-07-21 17:10:00 +0200179 __attribute__ ((format (printf, 1, 2))) __cold;
Mike Frysinger0b15d042007-10-16 23:26:43 -0700180extern int log_buf_get_len(void);
181extern int log_buf_read(int idx);
182extern int log_buf_copy(char *dest, int idx, int len);
Matt Mackalld59745c2005-05-01 08:59:02 -0700183#else
184static inline int vprintk(const char *s, va_list args)
185 __attribute__ ((format (printf, 1, 0)));
186static inline int vprintk(const char *s, va_list args) { return 0; }
187static inline int printk(const char *s, ...)
188 __attribute__ ((format (printf, 1, 2)));
Andi Kleena586df02007-07-21 17:10:00 +0200189static inline int __cold printk(const char *s, ...) { return 0; }
Mike Frysinger0b15d042007-10-16 23:26:43 -0700190static inline int log_buf_get_len(void) { return 0; }
191static inline int log_buf_read(int idx) { return 0; }
192static inline int log_buf_copy(char *dest, int idx, int len) { return 0; }
Matt Mackalld59745c2005-05-01 08:59:02 -0700193#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Ingo Molnar076f9772008-01-30 13:33:06 +0100195extern void __attribute__((format(printf, 1, 2)))
196 early_printk(const char *fmt, ...);
197
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198unsigned long int_sqrt(unsigned long);
199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200extern int printk_ratelimit(void);
201extern int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst);
Andrew Mortonf46c4832006-11-02 22:07:16 -0800202extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
203 unsigned int interval_msec);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205static inline void console_silent(void)
206{
207 console_loglevel = 0;
208}
209
210static inline void console_verbose(void)
211{
212 if (console_loglevel)
213 console_loglevel = 15;
214}
215
216extern void bust_spinlocks(int yes);
Kirill Korotaeve3e8a752007-02-10 01:46:19 -0800217extern void wake_up_klogd(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
Adrian Bunkaa727102006-04-10 22:53:59 -0700219extern int panic_timeout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220extern int panic_on_oops;
Don Zickus8da5add2006-09-26 10:52:27 +0200221extern int panic_on_unrecovered_nmi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222extern int tainted;
223extern const char *print_tainted(void);
224extern void add_taint(unsigned);
225
226/* Values used for system_state */
227extern enum system_states {
228 SYSTEM_BOOTING,
229 SYSTEM_RUNNING,
230 SYSTEM_HALT,
231 SYSTEM_POWER_OFF,
232 SYSTEM_RESTART,
Alexey Starikovskiy729b4d42005-12-01 04:29:00 -0500233 SYSTEM_SUSPEND_DISK,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234} system_state;
235
236#define TAINT_PROPRIETARY_MODULE (1<<0)
237#define TAINT_FORCED_MODULE (1<<1)
238#define TAINT_UNSAFE_SMP (1<<2)
239#define TAINT_FORCED_RMMOD (1<<3)
240#define TAINT_MACHINE_CHECK (1<<4)
241#define TAINT_BAD_PAGE (1<<5)
Theodore Ts'o34f5a392007-02-10 01:45:24 -0800242#define TAINT_USER (1<<6)
Pavel Emelianovbcdcd8e2007-07-17 04:03:42 -0700243#define TAINT_DIE (1<<7)
Éric Piel6ed31e92008-02-05 00:04:50 +0100244#define TAINT_OVERRIDDEN_ACPI_TABLE (1<<8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Andi Kleena586df02007-07-21 17:10:00 +0200246extern void dump_stack(void) __cold;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700248enum {
249 DUMP_PREFIX_NONE,
250 DUMP_PREFIX_ADDRESS,
251 DUMP_PREFIX_OFFSET
252};
Randy Dunlapc7909232007-06-08 13:47:04 -0700253extern void hex_dump_to_buffer(const void *buf, size_t len,
254 int rowsize, int groupsize,
255 char *linebuf, size_t linebuflen, bool ascii);
256extern void print_hex_dump(const char *level, const char *prefix_str,
257 int prefix_type, int rowsize, int groupsize,
Artem Bityutskiy6a0ed912007-08-07 23:43:14 +0300258 const void *buf, size_t len, bool ascii);
Randy Dunlapc7909232007-06-08 13:47:04 -0700259extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
Alan Sterneb9a9a52007-08-10 13:01:07 -0700260 const void *buf, size_t len);
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700261#define hex_asc(x) "0123456789abcdef"[x]
262
Emil Medve1f7c8232007-10-16 23:29:48 -0700263#define pr_emerg(fmt, arg...) \
264 printk(KERN_EMERG fmt, ##arg)
265#define pr_alert(fmt, arg...) \
266 printk(KERN_ALERT fmt, ##arg)
267#define pr_crit(fmt, arg...) \
268 printk(KERN_CRIT fmt, ##arg)
269#define pr_err(fmt, arg...) \
270 printk(KERN_ERR fmt, ##arg)
271#define pr_warning(fmt, arg...) \
272 printk(KERN_WARNING fmt, ##arg)
273#define pr_notice(fmt, arg...) \
274 printk(KERN_NOTICE fmt, ##arg)
275#define pr_info(fmt, arg...) \
276 printk(KERN_INFO fmt, ##arg)
277
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278#ifdef DEBUG
Pavel Machek1cc6daf2006-08-08 01:37:15 +0200279/* If you are writing a driver, please use dev_dbg instead */
Emil Medve1f7c8232007-10-16 23:29:48 -0700280#define pr_debug(fmt, arg...) \
281 printk(KERN_DEBUG fmt, ##arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282#else
Zach Brown8b2a1fd2006-10-03 01:16:15 -0700283static inline int __attribute__ ((format (printf, 1, 2))) pr_debug(const char * fmt, ...)
284{
285 return 0;
286}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287#endif
288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289/*
290 * Display an IP address in readable format.
291 */
292
293#define NIPQUAD(addr) \
294 ((unsigned char *)&addr)[0], \
295 ((unsigned char *)&addr)[1], \
296 ((unsigned char *)&addr)[2], \
297 ((unsigned char *)&addr)[3]
Joe Perches46b86a22006-01-13 14:29:07 -0800298#define NIPQUAD_FMT "%u.%u.%u.%u"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
300#define NIP6(addr) \
301 ntohs((addr).s6_addr16[0]), \
302 ntohs((addr).s6_addr16[1]), \
303 ntohs((addr).s6_addr16[2]), \
304 ntohs((addr).s6_addr16[3]), \
305 ntohs((addr).s6_addr16[4]), \
306 ntohs((addr).s6_addr16[5]), \
307 ntohs((addr).s6_addr16[6]), \
308 ntohs((addr).s6_addr16[7])
Joe Perches46b86a22006-01-13 14:29:07 -0800309#define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
YOSHIFUJI Hideaki9343e792006-01-17 02:10:53 -0800310#define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312#if defined(__LITTLE_ENDIAN)
313#define HIPQUAD(addr) \
314 ((unsigned char *)&addr)[3], \
315 ((unsigned char *)&addr)[2], \
316 ((unsigned char *)&addr)[1], \
317 ((unsigned char *)&addr)[0]
318#elif defined(__BIG_ENDIAN)
319#define HIPQUAD NIPQUAD
320#else
321#error "Please fix asm/byteorder.h"
322#endif /* __LITTLE_ENDIAN */
323
324/*
325 * min()/max() macros that also do
326 * strict type-checking.. See the
327 * "unnecessary" pointer comparison.
328 */
329#define min(x,y) ({ \
330 typeof(x) _x = (x); \
331 typeof(y) _y = (y); \
332 (void) (&_x == &_y); \
333 _x < _y ? _x : _y; })
334
335#define max(x,y) ({ \
336 typeof(x) _x = (x); \
337 typeof(y) _y = (y); \
338 (void) (&_x == &_y); \
339 _x > _y ? _x : _y; })
340
341/*
342 * ..and if you can't take the strict
343 * types, you can specify one yourself.
344 *
345 * Or not use min/max at all, of course.
346 */
347#define min_t(type,x,y) \
348 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
349#define max_t(type,x,y) \
350 ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
351
352
353/**
354 * container_of - cast a member of a structure out to the containing structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 * @ptr: the pointer to the member.
356 * @type: the type of the container struct this is embedded in.
357 * @member: the name of the member within the struct.
358 *
359 */
360#define container_of(ptr, type, member) ({ \
Daniel Walker78db2ad2007-05-12 16:28:35 -0700361 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
362 (type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
364/*
365 * Check at compile time that something is of a particular type.
366 * Always evaluates to 1 so you may use it easily in comparisons.
367 */
368#define typecheck(type,x) \
369({ type __dummy; \
370 typeof(x) __dummy2; \
371 (void)(&__dummy == &__dummy2); \
372 1; \
373})
374
Chuck Ebbert711a6602006-01-09 15:59:17 -0800375/*
376 * Check at compile time that 'function' is a certain type, or is a pointer
377 * to that type (needs to use typedef for the function type.)
378 */
379#define typecheck_fn(type,function) \
380({ typeof(type) __tmp = function; \
381 (void)__tmp; \
382})
383
Kyle McMartind4d23ad2007-02-10 01:46:00 -0800384struct sysinfo;
385extern int do_sysinfo(struct sysinfo *info);
386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387#endif /* __KERNEL__ */
388
389#define SI_LOAD_SHIFT 16
390struct sysinfo {
391 long uptime; /* Seconds since boot */
392 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
393 unsigned long totalram; /* Total usable main memory size */
394 unsigned long freeram; /* Available memory size */
395 unsigned long sharedram; /* Amount of shared memory */
396 unsigned long bufferram; /* Memory used by buffers */
397 unsigned long totalswap; /* Total swap space size */
398 unsigned long freeswap; /* swap space still available */
399 unsigned short procs; /* Number of current processes */
400 unsigned short pad; /* explicit padding for m68k */
401 unsigned long totalhigh; /* Total high memory size */
402 unsigned long freehigh; /* Available high memory size */
403 unsigned int mem_unit; /* Memory unit size in bytes */
404 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
405};
406
Nikita Danilovc0398ee2005-10-30 15:03:10 -0800407/* Force a compilation error if condition is true */
Andi Kleen921717a2005-09-13 01:25:13 -0700408#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Jan Beulich4552d5d2006-06-26 13:57:28 +0200410/* Force a compilation error if condition is true, but also produce a
411 result (of value 0 and type size_t), so the expression can be used
412 e.g. in a structure initializer (or where-ever else comma expressions
413 aren't permitted). */
414#define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416/* Trap pasters of __FUNCTION__ at compile-time */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417#define __FUNCTION__ (__func__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
Christoph Lameter08e0f6a2006-09-27 01:50:06 -0700419/* This helps us to avoid #ifdef CONFIG_NUMA */
420#ifdef CONFIG_NUMA
421#define NUMA_BUILD 1
422#else
423#define NUMA_BUILD 0
424#endif
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426#endif