Blame view

include/linux/kernel.h 10.7 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  #ifndef _LINUX_KERNEL_H
  #define _LINUX_KERNEL_H
  
  /*
   * 'kernel.h' contains some often-used function prototypes etc
   */
  
  #ifdef __KERNEL__
  
  #include <stdarg.h>
  #include <linux/linkage.h>
  #include <linux/stddef.h>
  #include <linux/types.h>
  #include <linux/compiler.h>
  #include <linux/bitops.h>
f0d1b0b30   David Howells   [PATCH] LOG2: Imp...
16
  #include <linux/log2.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
17
18
19
20
21
22
23
24
25
26
27
  #include <asm/byteorder.h>
  #include <asm/bug.h>
  
  extern const char linux_banner[];
  
  #define INT_MAX		((int)(~0U>>1))
  #define INT_MIN		(-INT_MAX - 1)
  #define UINT_MAX	(~0U)
  #define LONG_MAX	((long)(~0UL>>1))
  #define LONG_MIN	(-LONG_MAX - 1)
  #define ULONG_MAX	(~0UL)
111ebb6e6   OGAWA Hirofumi   [PATCH] writeback...
28
29
30
  #define LLONG_MAX	((long long)(~0ULL>>1))
  #define LLONG_MIN	(-LLONG_MAX - 1)
  #define ULLONG_MAX	(~0ULL)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
31
32
  
  #define STACK_MAGIC	0xdeadbeef
2ea581447   Linus Torvalds   Fix 'ALIGN()' mac...
33
34
  #define ALIGN(x,a)		__ALIGN_MASK(x,(typeof(x))(a)-1)
  #define __ALIGN_MASK(x,mask)	(((x)+(mask))&~(mask))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
35
  #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
4552d5dc0   Jan Beulich   [PATCH] x86_64: r...
36
  #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
930631edd   Steven Whitehouse   [PATCH] add DIV_R...
37
  #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
b4cac1a02   David Howells   [PATCH] FDPIC: Mo...
38
  #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
  
  #define	KERN_EMERG	"<0>"	/* system is unusable			*/
  #define	KERN_ALERT	"<1>"	/* action must be taken immediately	*/
  #define	KERN_CRIT	"<2>"	/* critical conditions			*/
  #define	KERN_ERR	"<3>"	/* error conditions			*/
  #define	KERN_WARNING	"<4>"	/* warning conditions			*/
  #define	KERN_NOTICE	"<5>"	/* normal but significant condition	*/
  #define	KERN_INFO	"<6>"	/* informational			*/
  #define	KERN_DEBUG	"<7>"	/* debug-level messages			*/
  
  extern int console_printk[];
  
  #define console_loglevel (console_printk[0])
  #define default_message_loglevel (console_printk[1])
  #define minimum_console_loglevel (console_printk[2])
  #define default_console_loglevel (console_printk[3])
  
  struct completion;
df2e71fb9   Andrew Morton   [PATCH] dump_thre...
57
58
  struct pt_regs;
  struct user;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
59
60
61
62
63
64
65
66
  
  /**
   * might_sleep - annotation for functions that can sleep
   *
   * this macro will print a stack trace if it is executed in an atomic
   * context (spinlock, irq-handler, ...).
   *
   * This is a useful debugging help to be able to catch problems early and not
e20ec9911   Jim Cromie   fix spelling erro...
67
   * be bitten later when the calling function happens to sleep when it is not
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
68
69
   * supposed to.
   */
f8cbd99bd   Ingo Molnar   [PATCH] sched: vo...
70
71
72
73
74
75
  #ifdef CONFIG_PREEMPT_VOLUNTARY
  extern int cond_resched(void);
  # define might_resched() cond_resched()
  #else
  # define might_resched() do { } while (0)
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
76
  #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
f8cbd99bd   Ingo Molnar   [PATCH] sched: vo...
77
78
79
    void __might_sleep(char *file, int line);
  # define might_sleep() \
  	do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
80
  #else
f8cbd99bd   Ingo Molnar   [PATCH] sched: vo...
81
  # define might_sleep() do { might_resched(); } while (0)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
82
  #endif
368a5fa1f   Hua Zhong   [PATCH] remove un...
83
  #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
f8cbd99bd   Ingo Molnar   [PATCH] sched: vo...
84

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
85
86
87
88
89
90
91
92
93
  #define abs(x) ({				\
  		int __x = (x);			\
  		(__x < 0) ? -__x : __x;		\
  	})
  
  #define labs(x) ({				\
  		long __x = (x);			\
  		(__x < 0) ? -__x : __x;		\
  	})
e041c6834   Alan Stern   [PATCH] Notifier ...
94
  extern struct atomic_notifier_head panic_notifier_list;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
95
96
97
  extern long (*panic_blink)(long time);
  NORET_TYPE void panic(const char * fmt, ...)
  	__attribute__ ((NORET_AND format (printf, 1, 2)));
dd287796d   Andrew Morton   [PATCH] pause_on_...
98
99
100
  extern void oops_enter(void);
  extern void oops_exit(void);
  extern int oops_may_print(void);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
  fastcall NORET_TYPE void do_exit(long error_code)
  	ATTRIB_NORET;
  NORET_TYPE void complete_and_exit(struct completion *, long)
  	ATTRIB_NORET;
  extern unsigned long simple_strtoul(const char *,char **,unsigned int);
  extern long simple_strtol(const char *,char **,unsigned int);
  extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
  extern long long simple_strtoll(const char *,char **,unsigned int);
  extern int sprintf(char * buf, const char * fmt, ...)
  	__attribute__ ((format (printf, 2, 3)));
  extern int vsprintf(char *buf, const char *, va_list)
  	__attribute__ ((format (printf, 2, 0)));
  extern int snprintf(char * buf, size_t size, const char * fmt, ...)
  	__attribute__ ((format (printf, 3, 4)));
  extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
  	__attribute__ ((format (printf, 3, 0)));
  extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
  	__attribute__ ((format (printf, 3, 4)));
  extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
  	__attribute__ ((format (printf, 3, 0)));
e905914f9   Jeremy Fitzhardinge   [PATCH] Implement...
121
122
  extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
  	__attribute__ ((format (printf, 2, 3)));
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
123
124
125
126
127
128
129
130
131
  
  extern int sscanf(const char *, const char *, ...)
  	__attribute__ ((format (scanf, 2, 3)));
  extern int vsscanf(const char *, const char *, va_list)
  	__attribute__ ((format (scanf, 2, 0)));
  
  extern int get_option(char **str, int *pint);
  extern char *get_options(const char *str, int nints, int *ints);
  extern unsigned long long memparse(char *ptr, char **retptr);
5e3766138   Trent Piepho   [PATCH] symbol_pu...
132
  extern int core_kernel_text(unsigned long addr);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
133
134
135
  extern int __kernel_text_address(unsigned long addr);
  extern int kernel_text_address(unsigned long addr);
  extern int session_of_pgrp(int pgrp);
df2e71fb9   Andrew Morton   [PATCH] dump_thre...
136
  extern void dump_thread(struct pt_regs *regs, struct user *dump);
d59745ce3   Matt Mackall   [PATCH] clean up ...
137
  #ifdef CONFIG_PRINTK
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
138
139
140
141
  asmlinkage int vprintk(const char *fmt, va_list args)
  	__attribute__ ((format (printf, 1, 0)));
  asmlinkage int printk(const char * fmt, ...)
  	__attribute__ ((format (printf, 1, 2)));
d59745ce3   Matt Mackall   [PATCH] clean up ...
142
143
144
145
146
147
148
149
  #else
  static inline int vprintk(const char *s, va_list args)
  	__attribute__ ((format (printf, 1, 0)));
  static inline int vprintk(const char *s, va_list args) { return 0; }
  static inline int printk(const char *s, ...)
  	__attribute__ ((format (printf, 1, 2)));
  static inline int printk(const char *s, ...) { return 0; }
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
150
151
  
  unsigned long int_sqrt(unsigned long);
962749af6   Andrew Morton   [PATCH] roundup_p...
152
153
  static inline unsigned long
  __attribute_const__ roundup_pow_of_two(unsigned long x)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
154
  {
962749af6   Andrew Morton   [PATCH] roundup_p...
155
  	return 1UL << fls_long(x - 1);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
156
157
158
159
  }
  
  extern int printk_ratelimit(void);
  extern int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst);
f46c48335   Andrew Morton   [PATCH] Add print...
160
161
  extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
  				unsigned int interval_msec);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  
  static inline void console_silent(void)
  {
  	console_loglevel = 0;
  }
  
  static inline void console_verbose(void)
  {
  	if (console_loglevel)
  		console_loglevel = 15;
  }
  
  extern void bust_spinlocks(int yes);
  extern int oops_in_progress;		/* If set, an oops, panic(), BUG() or die() is in progress */
aa7271076   Adrian Bunk   [PATCH] the sched...
176
  extern int panic_timeout;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
177
  extern int panic_on_oops;
8da5adda9   Don Zickus   [PATCH] x86: Allo...
178
  extern int panic_on_unrecovered_nmi;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
179
180
181
182
183
184
185
186
187
188
189
  extern int tainted;
  extern const char *print_tainted(void);
  extern void add_taint(unsigned);
  
  /* Values used for system_state */
  extern enum system_states {
  	SYSTEM_BOOTING,
  	SYSTEM_RUNNING,
  	SYSTEM_HALT,
  	SYSTEM_POWER_OFF,
  	SYSTEM_RESTART,
729b4d4ce   Alexey Starikovskiy   [ACPI] fix reboot...
190
  	SYSTEM_SUSPEND_DISK,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
191
192
193
194
195
196
197
198
199
200
201
202
  } system_state;
  
  #define TAINT_PROPRIETARY_MODULE	(1<<0)
  #define TAINT_FORCED_MODULE		(1<<1)
  #define TAINT_UNSAFE_SMP		(1<<2)
  #define TAINT_FORCED_RMMOD		(1<<3)
  #define TAINT_MACHINE_CHECK		(1<<4)
  #define TAINT_BAD_PAGE			(1<<5)
  
  extern void dump_stack(void);
  
  #ifdef DEBUG
1cc6daf23   Pavel Machek   pr_debug() should...
203
  /* If you are writing a driver, please use dev_dbg instead */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
204
205
206
  #define pr_debug(fmt,arg...) \
  	printk(KERN_DEBUG fmt,##arg)
  #else
8b2a1fd1b   Zach Brown   [PATCH] pr_debug:...
207
208
209
210
  static inline int __attribute__ ((format (printf, 1, 2))) pr_debug(const char * fmt, ...)
  {
  	return 0;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
211
212
213
214
215
216
217
218
219
220
221
222
223
224
  #endif
  
  #define pr_info(fmt,arg...) \
  	printk(KERN_INFO fmt,##arg)
  
  /*
   *      Display an IP address in readable format.
   */
  
  #define NIPQUAD(addr) \
  	((unsigned char *)&addr)[0], \
  	((unsigned char *)&addr)[1], \
  	((unsigned char *)&addr)[2], \
  	((unsigned char *)&addr)[3]
46b86a2da   Joe Perches   [NET]: Use NIP6_F...
225
  #define NIPQUAD_FMT "%u.%u.%u.%u"
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
226
227
228
229
230
231
232
233
234
235
  
  #define NIP6(addr) \
  	ntohs((addr).s6_addr16[0]), \
  	ntohs((addr).s6_addr16[1]), \
  	ntohs((addr).s6_addr16[2]), \
  	ntohs((addr).s6_addr16[3]), \
  	ntohs((addr).s6_addr16[4]), \
  	ntohs((addr).s6_addr16[5]), \
  	ntohs((addr).s6_addr16[6]), \
  	ntohs((addr).s6_addr16[7])
46b86a2da   Joe Perches   [NET]: Use NIP6_F...
236
  #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
9343e79a7   YOSHIFUJI Hideaki   [IPV6]: Preserve ...
237
  #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
  
  #if defined(__LITTLE_ENDIAN)
  #define HIPQUAD(addr) \
  	((unsigned char *)&addr)[3], \
  	((unsigned char *)&addr)[2], \
  	((unsigned char *)&addr)[1], \
  	((unsigned char *)&addr)[0]
  #elif defined(__BIG_ENDIAN)
  #define HIPQUAD	NIPQUAD
  #else
  #error "Please fix asm/byteorder.h"
  #endif /* __LITTLE_ENDIAN */
  
  /*
   * min()/max() macros that also do
   * strict type-checking.. See the
   * "unnecessary" pointer comparison.
   */
  #define min(x,y) ({ \
  	typeof(x) _x = (x);	\
  	typeof(y) _y = (y);	\
  	(void) (&_x == &_y);		\
  	_x < _y ? _x : _y; })
  
  #define max(x,y) ({ \
  	typeof(x) _x = (x);	\
  	typeof(y) _y = (y);	\
  	(void) (&_x == &_y);		\
  	_x > _y ? _x : _y; })
  
  /*
   * ..and if you can't take the strict
   * types, you can specify one yourself.
   *
   * Or not use min/max at all, of course.
   */
  #define min_t(type,x,y) \
  	({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
  #define max_t(type,x,y) \
  	({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
  
  
  /**
   * container_of - cast a member of a structure out to the containing structure
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
   * @ptr:	the pointer to the member.
   * @type:	the type of the container struct this is embedded in.
   * @member:	the name of the member within the struct.
   *
   */
  #define container_of(ptr, type, member) ({			\
          const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
          (type *)( (char *)__mptr - offsetof(type,member) );})
  
  /*
   * Check at compile time that something is of a particular type.
   * Always evaluates to 1 so you may use it easily in comparisons.
   */
  #define typecheck(type,x) \
  ({	type __dummy; \
  	typeof(x) __dummy2; \
  	(void)(&__dummy == &__dummy2); \
  	1; \
  })
711a660dc   Chuck Ebbert   [PATCH] mutex sub...
301
302
303
304
305
306
307
308
  /*
   * Check at compile time that 'function' is a certain type, or is a pointer
   * to that type (needs to use typedef for the function type.)
   */
  #define typecheck_fn(type,function) \
  ({	typeof(type) __tmp = function; \
  	(void)__tmp; \
  })
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
  #endif /* __KERNEL__ */
  
  #define SI_LOAD_SHIFT	16
  struct sysinfo {
  	long uptime;			/* Seconds since boot */
  	unsigned long loads[3];		/* 1, 5, and 15 minute load averages */
  	unsigned long totalram;		/* Total usable main memory size */
  	unsigned long freeram;		/* Available memory size */
  	unsigned long sharedram;	/* Amount of shared memory */
  	unsigned long bufferram;	/* Memory used by buffers */
  	unsigned long totalswap;	/* Total swap space size */
  	unsigned long freeswap;		/* swap space still available */
  	unsigned short procs;		/* Number of current processes */
  	unsigned short pad;		/* explicit padding for m68k */
  	unsigned long totalhigh;	/* Total high memory size */
  	unsigned long freehigh;		/* Available high memory size */
  	unsigned int mem_unit;		/* Memory unit size in bytes */
  	char _f[20-2*sizeof(long)-sizeof(int)];	/* Padding: libc5 uses this.. */
  };
c0398ee6c   Nikita Danilov   [PATCH] include/l...
328
  /* Force a compilation error if condition is true */
921717a2a   Andi Kleen   [PATCH] Make BUIL...
329
  #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
330

4552d5dc0   Jan Beulich   [PATCH] x86_64: r...
331
332
333
334
335
  /* Force a compilation error if condition is true, but also produce a
     result (of value 0 and type size_t), so the expression can be used
     e.g. in a structure initializer (or where-ever else comma expressions
     aren't permitted). */
  #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
336
  /* Trap pasters of __FUNCTION__ at compile-time */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
337
  #define __FUNCTION__ (__func__)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
338

08e0f6a97   Christoph Lameter   [PATCH] Add NUMA_...
339
340
341
342
343
344
  /* This helps us to avoid #ifdef CONFIG_NUMA */
  #ifdef CONFIG_NUMA
  #define NUMA_BUILD 1
  #else
  #define NUMA_BUILD 0
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
345
  #endif