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 | */ | |
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> | |
16 | #include <asm/byteorder.h> | |
17 | #include <asm/bug.h> | |
18 | ||
19 | extern const char linux_banner[]; | |
20 | ||
21 | #define INT_MAX ((int)(~0U>>1)) | |
22 | #define INT_MIN (-INT_MAX - 1) | |
23 | #define UINT_MAX (~0U) | |
24 | #define LONG_MAX ((long)(~0UL>>1)) | |
25 | #define LONG_MIN (-LONG_MAX - 1) | |
26 | #define ULONG_MAX (~0UL) | |
111ebb6e OH |
27 | #define LLONG_MAX ((long long)(~0ULL>>1)) |
28 | #define LLONG_MIN (-LLONG_MAX - 1) | |
29 | #define ULLONG_MAX (~0ULL) | |
1da177e4 LT |
30 | |
31 | #define STACK_MAGIC 0xdeadbeef | |
32 | ||
33 | #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) | |
4c8bd7ee | 34 | #define ALIGN(x,a) (((x)+(a)-1UL)&~((a)-1UL)) |
4552d5dc | 35 | #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f)) |
930631ed | 36 | #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d)) |
b4cac1a0 | 37 | #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y)) |
1da177e4 LT |
38 | |
39 | #define KERN_EMERG "<0>" /* system is unusable */ | |
40 | #define KERN_ALERT "<1>" /* action must be taken immediately */ | |
41 | #define KERN_CRIT "<2>" /* critical conditions */ | |
42 | #define KERN_ERR "<3>" /* error conditions */ | |
43 | #define KERN_WARNING "<4>" /* warning conditions */ | |
44 | #define KERN_NOTICE "<5>" /* normal but significant condition */ | |
45 | #define KERN_INFO "<6>" /* informational */ | |
46 | #define KERN_DEBUG "<7>" /* debug-level messages */ | |
47 | ||
48 | extern int console_printk[]; | |
49 | ||
50 | #define console_loglevel (console_printk[0]) | |
51 | #define default_message_loglevel (console_printk[1]) | |
52 | #define minimum_console_loglevel (console_printk[2]) | |
53 | #define default_console_loglevel (console_printk[3]) | |
54 | ||
55 | struct completion; | |
df2e71fb | 56 | struct pt_regs; |
57 | struct user; | |
1da177e4 LT |
58 | |
59 | /** | |
60 | * might_sleep - annotation for functions that can sleep | |
61 | * | |
62 | * this macro will print a stack trace if it is executed in an atomic | |
63 | * context (spinlock, irq-handler, ...). | |
64 | * | |
65 | * This is a useful debugging help to be able to catch problems early and not | |
66 | * be biten later when the calling function happens to sleep when it is not | |
67 | * supposed to. | |
68 | */ | |
f8cbd99b IM |
69 | #ifdef CONFIG_PREEMPT_VOLUNTARY |
70 | extern int cond_resched(void); | |
71 | # define might_resched() cond_resched() | |
72 | #else | |
73 | # define might_resched() do { } while (0) | |
74 | #endif | |
75 | ||
1da177e4 | 76 | #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP |
f8cbd99b IM |
77 | void __might_sleep(char *file, int line); |
78 | # define might_sleep() \ | |
79 | do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0) | |
1da177e4 | 80 | #else |
f8cbd99b | 81 | # define might_sleep() do { might_resched(); } while (0) |
1da177e4 LT |
82 | #endif |
83 | ||
368a5fa1 | 84 | #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0) |
f8cbd99b | 85 | |
1da177e4 LT |
86 | #define abs(x) ({ \ |
87 | int __x = (x); \ | |
88 | (__x < 0) ? -__x : __x; \ | |
89 | }) | |
90 | ||
91 | #define labs(x) ({ \ | |
92 | long __x = (x); \ | |
93 | (__x < 0) ? -__x : __x; \ | |
94 | }) | |
95 | ||
e041c683 | 96 | extern struct atomic_notifier_head panic_notifier_list; |
1da177e4 LT |
97 | extern long (*panic_blink)(long time); |
98 | NORET_TYPE void panic(const char * fmt, ...) | |
99 | __attribute__ ((NORET_AND format (printf, 1, 2))); | |
dd287796 AM |
100 | extern void oops_enter(void); |
101 | extern void oops_exit(void); | |
102 | extern int oops_may_print(void); | |
1da177e4 LT |
103 | fastcall NORET_TYPE void do_exit(long error_code) |
104 | ATTRIB_NORET; | |
105 | NORET_TYPE void complete_and_exit(struct completion *, long) | |
106 | ATTRIB_NORET; | |
107 | extern unsigned long simple_strtoul(const char *,char **,unsigned int); | |
108 | extern long simple_strtol(const char *,char **,unsigned int); | |
109 | extern unsigned long long simple_strtoull(const char *,char **,unsigned int); | |
110 | extern long long simple_strtoll(const char *,char **,unsigned int); | |
111 | extern int sprintf(char * buf, const char * fmt, ...) | |
112 | __attribute__ ((format (printf, 2, 3))); | |
113 | extern int vsprintf(char *buf, const char *, va_list) | |
114 | __attribute__ ((format (printf, 2, 0))); | |
115 | extern int snprintf(char * buf, size_t size, const char * fmt, ...) | |
116 | __attribute__ ((format (printf, 3, 4))); | |
117 | extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args) | |
118 | __attribute__ ((format (printf, 3, 0))); | |
119 | extern int scnprintf(char * buf, size_t size, const char * fmt, ...) | |
120 | __attribute__ ((format (printf, 3, 4))); | |
121 | extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args) | |
122 | __attribute__ ((format (printf, 3, 0))); | |
e905914f JF |
123 | extern char *kasprintf(gfp_t gfp, const char *fmt, ...) |
124 | __attribute__ ((format (printf, 2, 3))); | |
1da177e4 LT |
125 | |
126 | extern int sscanf(const char *, const char *, ...) | |
127 | __attribute__ ((format (scanf, 2, 3))); | |
128 | extern int vsscanf(const char *, const char *, va_list) | |
129 | __attribute__ ((format (scanf, 2, 0))); | |
130 | ||
131 | extern int get_option(char **str, int *pint); | |
132 | extern char *get_options(const char *str, int nints, int *ints); | |
133 | extern unsigned long long memparse(char *ptr, char **retptr); | |
134 | ||
5e376613 | 135 | extern int core_kernel_text(unsigned long addr); |
1da177e4 LT |
136 | extern int __kernel_text_address(unsigned long addr); |
137 | extern int kernel_text_address(unsigned long addr); | |
138 | extern int session_of_pgrp(int pgrp); | |
139 | ||
df2e71fb | 140 | extern void dump_thread(struct pt_regs *regs, struct user *dump); |
141 | ||
d59745ce | 142 | #ifdef CONFIG_PRINTK |
1da177e4 LT |
143 | asmlinkage int vprintk(const char *fmt, va_list args) |
144 | __attribute__ ((format (printf, 1, 0))); | |
145 | asmlinkage int printk(const char * fmt, ...) | |
146 | __attribute__ ((format (printf, 1, 2))); | |
d59745ce MM |
147 | #else |
148 | static inline int vprintk(const char *s, va_list args) | |
149 | __attribute__ ((format (printf, 1, 0))); | |
150 | static inline int vprintk(const char *s, va_list args) { return 0; } | |
151 | static inline int printk(const char *s, ...) | |
152 | __attribute__ ((format (printf, 1, 2))); | |
153 | static inline int printk(const char *s, ...) { return 0; } | |
154 | #endif | |
1da177e4 LT |
155 | |
156 | unsigned long int_sqrt(unsigned long); | |
157 | ||
158 | static inline int __attribute_pure__ long_log2(unsigned long x) | |
159 | { | |
160 | int r = 0; | |
161 | for (x >>= 1; x > 0; x >>= 1) | |
162 | r++; | |
163 | return r; | |
164 | } | |
165 | ||
962749af AM |
166 | static inline unsigned long |
167 | __attribute_const__ roundup_pow_of_two(unsigned long x) | |
1da177e4 | 168 | { |
962749af | 169 | return 1UL << fls_long(x - 1); |
1da177e4 LT |
170 | } |
171 | ||
172 | extern int printk_ratelimit(void); | |
173 | extern int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst); | |
f46c4833 AM |
174 | extern bool printk_timed_ratelimit(unsigned long *caller_jiffies, |
175 | unsigned int interval_msec); | |
1da177e4 LT |
176 | |
177 | static inline void console_silent(void) | |
178 | { | |
179 | console_loglevel = 0; | |
180 | } | |
181 | ||
182 | static inline void console_verbose(void) | |
183 | { | |
184 | if (console_loglevel) | |
185 | console_loglevel = 15; | |
186 | } | |
187 | ||
188 | extern void bust_spinlocks(int yes); | |
189 | extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */ | |
aa727107 | 190 | extern int panic_timeout; |
1da177e4 | 191 | extern int panic_on_oops; |
8da5adda | 192 | extern int panic_on_unrecovered_nmi; |
1da177e4 LT |
193 | extern int tainted; |
194 | extern const char *print_tainted(void); | |
195 | extern void add_taint(unsigned); | |
196 | ||
197 | /* Values used for system_state */ | |
198 | extern enum system_states { | |
199 | SYSTEM_BOOTING, | |
200 | SYSTEM_RUNNING, | |
201 | SYSTEM_HALT, | |
202 | SYSTEM_POWER_OFF, | |
203 | SYSTEM_RESTART, | |
729b4d4c | 204 | SYSTEM_SUSPEND_DISK, |
1da177e4 LT |
205 | } system_state; |
206 | ||
207 | #define TAINT_PROPRIETARY_MODULE (1<<0) | |
208 | #define TAINT_FORCED_MODULE (1<<1) | |
209 | #define TAINT_UNSAFE_SMP (1<<2) | |
210 | #define TAINT_FORCED_RMMOD (1<<3) | |
211 | #define TAINT_MACHINE_CHECK (1<<4) | |
212 | #define TAINT_BAD_PAGE (1<<5) | |
213 | ||
214 | extern void dump_stack(void); | |
215 | ||
216 | #ifdef DEBUG | |
1cc6daf2 | 217 | /* If you are writing a driver, please use dev_dbg instead */ |
1da177e4 LT |
218 | #define pr_debug(fmt,arg...) \ |
219 | printk(KERN_DEBUG fmt,##arg) | |
220 | #else | |
8b2a1fd1 ZB |
221 | static inline int __attribute__ ((format (printf, 1, 2))) pr_debug(const char * fmt, ...) |
222 | { | |
223 | return 0; | |
224 | } | |
1da177e4 LT |
225 | #endif |
226 | ||
227 | #define pr_info(fmt,arg...) \ | |
228 | printk(KERN_INFO fmt,##arg) | |
229 | ||
230 | /* | |
231 | * Display an IP address in readable format. | |
232 | */ | |
233 | ||
234 | #define NIPQUAD(addr) \ | |
235 | ((unsigned char *)&addr)[0], \ | |
236 | ((unsigned char *)&addr)[1], \ | |
237 | ((unsigned char *)&addr)[2], \ | |
238 | ((unsigned char *)&addr)[3] | |
46b86a2d | 239 | #define NIPQUAD_FMT "%u.%u.%u.%u" |
1da177e4 LT |
240 | |
241 | #define NIP6(addr) \ | |
242 | ntohs((addr).s6_addr16[0]), \ | |
243 | ntohs((addr).s6_addr16[1]), \ | |
244 | ntohs((addr).s6_addr16[2]), \ | |
245 | ntohs((addr).s6_addr16[3]), \ | |
246 | ntohs((addr).s6_addr16[4]), \ | |
247 | ntohs((addr).s6_addr16[5]), \ | |
248 | ntohs((addr).s6_addr16[6]), \ | |
249 | ntohs((addr).s6_addr16[7]) | |
46b86a2d | 250 | #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x" |
9343e79a | 251 | #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x" |
1da177e4 LT |
252 | |
253 | #if defined(__LITTLE_ENDIAN) | |
254 | #define HIPQUAD(addr) \ | |
255 | ((unsigned char *)&addr)[3], \ | |
256 | ((unsigned char *)&addr)[2], \ | |
257 | ((unsigned char *)&addr)[1], \ | |
258 | ((unsigned char *)&addr)[0] | |
259 | #elif defined(__BIG_ENDIAN) | |
260 | #define HIPQUAD NIPQUAD | |
261 | #else | |
262 | #error "Please fix asm/byteorder.h" | |
263 | #endif /* __LITTLE_ENDIAN */ | |
264 | ||
265 | /* | |
266 | * min()/max() macros that also do | |
267 | * strict type-checking.. See the | |
268 | * "unnecessary" pointer comparison. | |
269 | */ | |
270 | #define min(x,y) ({ \ | |
271 | typeof(x) _x = (x); \ | |
272 | typeof(y) _y = (y); \ | |
273 | (void) (&_x == &_y); \ | |
274 | _x < _y ? _x : _y; }) | |
275 | ||
276 | #define max(x,y) ({ \ | |
277 | typeof(x) _x = (x); \ | |
278 | typeof(y) _y = (y); \ | |
279 | (void) (&_x == &_y); \ | |
280 | _x > _y ? _x : _y; }) | |
281 | ||
282 | /* | |
283 | * ..and if you can't take the strict | |
284 | * types, you can specify one yourself. | |
285 | * | |
286 | * Or not use min/max at all, of course. | |
287 | */ | |
288 | #define min_t(type,x,y) \ | |
289 | ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; }) | |
290 | #define max_t(type,x,y) \ | |
291 | ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; }) | |
292 | ||
293 | ||
294 | /** | |
295 | * container_of - cast a member of a structure out to the containing structure | |
1da177e4 LT |
296 | * @ptr: the pointer to the member. |
297 | * @type: the type of the container struct this is embedded in. | |
298 | * @member: the name of the member within the struct. | |
299 | * | |
300 | */ | |
301 | #define container_of(ptr, type, member) ({ \ | |
302 | const typeof( ((type *)0)->member ) *__mptr = (ptr); \ | |
303 | (type *)( (char *)__mptr - offsetof(type,member) );}) | |
304 | ||
305 | /* | |
306 | * Check at compile time that something is of a particular type. | |
307 | * Always evaluates to 1 so you may use it easily in comparisons. | |
308 | */ | |
309 | #define typecheck(type,x) \ | |
310 | ({ type __dummy; \ | |
311 | typeof(x) __dummy2; \ | |
312 | (void)(&__dummy == &__dummy2); \ | |
313 | 1; \ | |
314 | }) | |
315 | ||
711a660d CE |
316 | /* |
317 | * Check at compile time that 'function' is a certain type, or is a pointer | |
318 | * to that type (needs to use typedef for the function type.) | |
319 | */ | |
320 | #define typecheck_fn(type,function) \ | |
321 | ({ typeof(type) __tmp = function; \ | |
322 | (void)__tmp; \ | |
323 | }) | |
324 | ||
1da177e4 LT |
325 | #endif /* __KERNEL__ */ |
326 | ||
327 | #define SI_LOAD_SHIFT 16 | |
328 | struct sysinfo { | |
329 | long uptime; /* Seconds since boot */ | |
330 | unsigned long loads[3]; /* 1, 5, and 15 minute load averages */ | |
331 | unsigned long totalram; /* Total usable main memory size */ | |
332 | unsigned long freeram; /* Available memory size */ | |
333 | unsigned long sharedram; /* Amount of shared memory */ | |
334 | unsigned long bufferram; /* Memory used by buffers */ | |
335 | unsigned long totalswap; /* Total swap space size */ | |
336 | unsigned long freeswap; /* swap space still available */ | |
337 | unsigned short procs; /* Number of current processes */ | |
338 | unsigned short pad; /* explicit padding for m68k */ | |
339 | unsigned long totalhigh; /* Total high memory size */ | |
340 | unsigned long freehigh; /* Available high memory size */ | |
341 | unsigned int mem_unit; /* Memory unit size in bytes */ | |
342 | char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */ | |
343 | }; | |
344 | ||
c0398ee6 | 345 | /* Force a compilation error if condition is true */ |
921717a2 | 346 | #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)])) |
1da177e4 | 347 | |
4552d5dc JB |
348 | /* Force a compilation error if condition is true, but also produce a |
349 | result (of value 0 and type size_t), so the expression can be used | |
350 | e.g. in a structure initializer (or where-ever else comma expressions | |
351 | aren't permitted). */ | |
352 | #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1) | |
353 | ||
1da177e4 | 354 | /* Trap pasters of __FUNCTION__ at compile-time */ |
1da177e4 | 355 | #define __FUNCTION__ (__func__) |
1da177e4 | 356 | |
08e0f6a9 CL |
357 | /* This helps us to avoid #ifdef CONFIG_NUMA */ |
358 | #ifdef CONFIG_NUMA | |
359 | #define NUMA_BUILD 1 | |
360 | #else | |
361 | #define NUMA_BUILD 0 | |
362 | #endif | |
363 | ||
1da177e4 | 364 | #endif |