1 #ifndef _LINUX_KERNEL_H
2 #define _LINUX_KERNEL_H
5 * 'kernel.h' contains some often-used function prototypes etc
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 <linux/log2.h>
17 #include <linux/typecheck.h>
18 #include <linux/ratelimit.h>
19 #include <linux/dynamic_printk.h>
20 #include <asm/byteorder.h>
23 extern const char linux_banner
[];
24 extern const char linux_proc_banner
[];
26 #define USHORT_MAX ((u16)(~0U))
27 #define SHORT_MAX ((s16)(USHORT_MAX>>1))
28 #define SHORT_MIN (-SHORT_MAX - 1)
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)
35 #define LLONG_MAX ((long long)(~0ULL>>1))
36 #define LLONG_MIN (-LLONG_MAX - 1)
37 #define ULLONG_MAX (~0ULL)
39 #define STACK_MAGIC 0xdeadbeef
41 #define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
42 #define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
43 #define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
44 #define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
46 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
48 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
49 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
50 #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
52 #define _RET_IP_ (unsigned long)__builtin_return_address(0)
53 #define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
56 # include <asm/div64.h>
57 # define sector_div(a, b) do_div(a, b)
59 # define sector_div(n, b)( \
70 * upper_32_bits - return bits 32-63 of a number
71 * @n: the number we're accessing
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
77 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
80 * lower_32_bits - return bits 0-31 of a number
81 * @n: the number we're accessing
83 #define lower_32_bits(n) ((u32)(n))
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 */
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).
101 extern int console_printk
[];
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])
112 #ifdef CONFIG_PREEMPT_VOLUNTARY
113 extern int _cond_resched(void);
114 # define might_resched() _cond_resched()
116 # define might_resched() do { } while (0)
119 #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
120 void __might_sleep(char *file
, int line
);
122 * might_sleep - annotation for functions that can sleep
124 * this macro will print a stack trace if it is executed in an atomic
125 * context (spinlock, irq-handler, ...).
127 * This is a useful debugging help to be able to catch problems early and not
128 * be bitten later when the calling function happens to sleep when it is not
131 # define might_sleep() \
132 do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
134 # define might_sleep() do { might_resched(); } while (0)
137 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
141 (__x < 0) ? -__x : __x; \
144 #ifdef CONFIG_PROVE_LOCKING
145 void might_fault(void);
147 static inline void might_fault(void)
153 extern struct atomic_notifier_head panic_notifier_list
;
154 extern long (*panic_blink
)(long time
);
155 NORET_TYPE
void panic(const char * fmt
, ...)
156 __attribute__ ((NORET_AND
format (printf
, 1, 2))) __cold
;
157 extern void oops_enter(void);
158 extern void oops_exit(void);
159 extern int oops_may_print(void);
160 NORET_TYPE
void do_exit(long error_code
)
162 NORET_TYPE
void complete_and_exit(struct completion
*, long)
164 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
165 extern long simple_strtol(const char *,char **,unsigned int);
166 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
167 extern long long simple_strtoll(const char *,char **,unsigned int);
168 extern int strict_strtoul(const char *, unsigned int, unsigned long *);
169 extern int strict_strtol(const char *, unsigned int, long *);
170 extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
171 extern int strict_strtoll(const char *, unsigned int, long long *);
172 extern int sprintf(char * buf
, const char * fmt
, ...)
173 __attribute__ ((format (printf
, 2, 3)));
174 extern int vsprintf(char *buf
, const char *, va_list)
175 __attribute__ ((format (printf
, 2, 0)));
176 extern int snprintf(char * buf
, size_t size
, const char * fmt
, ...)
177 __attribute__ ((format (printf
, 3, 4)));
178 extern int vsnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
179 __attribute__ ((format (printf
, 3, 0)));
180 extern int scnprintf(char * buf
, size_t size
, const char * fmt
, ...)
181 __attribute__ ((format (printf
, 3, 4)));
182 extern int vscnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
183 __attribute__ ((format (printf
, 3, 0)));
184 extern char *kasprintf(gfp_t gfp
, const char *fmt
, ...)
185 __attribute__ ((format (printf
, 2, 3)));
186 extern char *kvasprintf(gfp_t gfp
, const char *fmt
, va_list args
);
188 extern int sscanf(const char *, const char *, ...)
189 __attribute__ ((format (scanf
, 2, 3)));
190 extern int vsscanf(const char *, const char *, va_list)
191 __attribute__ ((format (scanf
, 2, 0)));
193 extern int get_option(char **str
, int *pint
);
194 extern char *get_options(const char *str
, int nints
, int *ints
);
195 extern unsigned long long memparse(const char *ptr
, char **retptr
);
197 extern int core_kernel_text(unsigned long addr
);
198 extern int __kernel_text_address(unsigned long addr
);
199 extern int kernel_text_address(unsigned long addr
);
200 extern int func_ptr_is_kernel_text(void *ptr
);
203 extern struct pid
*session_of_pgrp(struct pid
*pgrp
);
207 * Add this to a message where you are sure the firmware is buggy or behaves
208 * really stupid or out of spec. Be aware that the responsible BIOS developer
209 * should be able to fix this issue or at least get a concrete idea of the
210 * problem by reading your message without the need of looking at the kernel
213 * Use it for definite and high priority BIOS bugs.
216 * Use it for not that clear (e.g. could the kernel messed up things already?)
217 * and medium priority BIOS bugs.
220 * Use this one if you want to tell the user or vendor about something
221 * suspicious, but generally harmless related to the firmware.
223 * Use it for information or very low priority BIOS bugs.
225 #define FW_BUG "[Firmware Bug]: "
226 #define FW_WARN "[Firmware Warn]: "
227 #define FW_INFO "[Firmware Info]: "
230 asmlinkage
int vprintk(const char *fmt
, va_list args
)
231 __attribute__ ((format (printf
, 1, 0)));
232 asmlinkage
int printk(const char * fmt
, ...)
233 __attribute__ ((format (printf
, 1, 2))) __cold
;
235 extern struct ratelimit_state printk_ratelimit_state
;
236 extern int printk_ratelimit(void);
237 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies
,
238 unsigned int interval_msec
);
240 static inline int vprintk(const char *s
, va_list args
)
241 __attribute__ ((format (printf
, 1, 0)));
242 static inline int vprintk(const char *s
, va_list args
) { return 0; }
243 static inline int printk(const char *s
, ...)
244 __attribute__ ((format (printf
, 1, 2)));
245 static inline int __cold
printk(const char *s
, ...) { return 0; }
246 static inline int printk_ratelimit(void) { return 0; }
247 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies
, \
248 unsigned int interval_msec
) \
252 extern int printk_needs_cpu(int cpu
);
253 extern void printk_tick(void);
255 extern void asmlinkage
__attribute__((format(printf
, 1, 2)))
256 early_printk(const char *fmt
, ...);
258 unsigned long int_sqrt(unsigned long);
260 static inline void console_silent(void)
262 console_loglevel
= 0;
265 static inline void console_verbose(void)
267 if (console_loglevel
)
268 console_loglevel
= 15;
271 extern void bust_spinlocks(int yes
);
272 extern void wake_up_klogd(void);
273 extern int oops_in_progress
; /* If set, an oops, panic(), BUG() or die() is in progress */
274 extern int panic_timeout
;
275 extern int panic_on_oops
;
276 extern int panic_on_unrecovered_nmi
;
277 extern const char *print_tainted(void);
278 extern void add_taint(unsigned flag
);
279 extern int test_taint(unsigned flag
);
280 extern unsigned long get_taint(void);
281 extern int root_mountflags
;
283 /* Values used for system_state */
284 extern enum system_states
{
293 #define TAINT_PROPRIETARY_MODULE 0
294 #define TAINT_FORCED_MODULE 1
295 #define TAINT_UNSAFE_SMP 2
296 #define TAINT_FORCED_RMMOD 3
297 #define TAINT_MACHINE_CHECK 4
298 #define TAINT_BAD_PAGE 5
301 #define TAINT_OVERRIDDEN_ACPI_TABLE 8
303 #define TAINT_CRAP 10
305 extern void dump_stack(void) __cold
;
312 extern void hex_dump_to_buffer(const void *buf
, size_t len
,
313 int rowsize
, int groupsize
,
314 char *linebuf
, size_t linebuflen
, bool ascii
);
315 extern void print_hex_dump(const char *level
, const char *prefix_str
,
316 int prefix_type
, int rowsize
, int groupsize
,
317 const void *buf
, size_t len
, bool ascii
);
318 extern void print_hex_dump_bytes(const char *prefix_str
, int prefix_type
,
319 const void *buf
, size_t len
);
321 extern const char hex_asc
[];
322 #define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
323 #define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
325 static inline char *pack_hex_byte(char *buf
, u8 byte
)
327 *buf
++ = hex_asc_hi(byte
);
328 *buf
++ = hex_asc_lo(byte
);
333 #define pr_fmt(fmt) fmt
336 #define pr_emerg(fmt, ...) \
337 printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
338 #define pr_alert(fmt, ...) \
339 printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
340 #define pr_crit(fmt, ...) \
341 printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
342 #define pr_err(fmt, ...) \
343 printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
344 #define pr_warning(fmt, ...) \
345 printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
346 #define pr_notice(fmt, ...) \
347 printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
348 #define pr_info(fmt, ...) \
349 printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
351 /* If you are writing a driver, please use dev_dbg instead */
352 #if defined(CONFIG_DYNAMIC_PRINTK_DEBUG)
353 #define pr_debug(fmt, ...) do { \
354 dynamic_pr_debug(pr_fmt(fmt), ##__VA_ARGS__); \
357 #define pr_debug(fmt, ...) \
358 printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
360 #define pr_debug(fmt, ...) \
361 ({ if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); 0; })
365 * Display an IP address in readable format.
368 #define NIPQUAD(addr) \
369 ((unsigned char *)&addr)[0], \
370 ((unsigned char *)&addr)[1], \
371 ((unsigned char *)&addr)[2], \
372 ((unsigned char *)&addr)[3]
373 #define NIPQUAD_FMT "%u.%u.%u.%u"
376 ntohs((addr).s6_addr16[0]), \
377 ntohs((addr).s6_addr16[1]), \
378 ntohs((addr).s6_addr16[2]), \
379 ntohs((addr).s6_addr16[3]), \
380 ntohs((addr).s6_addr16[4]), \
381 ntohs((addr).s6_addr16[5]), \
382 ntohs((addr).s6_addr16[6]), \
383 ntohs((addr).s6_addr16[7])
384 #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
385 #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
387 #if defined(__LITTLE_ENDIAN)
388 #define HIPQUAD(addr) \
389 ((unsigned char *)&addr)[3], \
390 ((unsigned char *)&addr)[2], \
391 ((unsigned char *)&addr)[1], \
392 ((unsigned char *)&addr)[0]
393 #elif defined(__BIG_ENDIAN)
394 #define HIPQUAD NIPQUAD
396 #error "Please fix asm/byteorder.h"
397 #endif /* __LITTLE_ENDIAN */
400 * min()/max()/clamp() macros that also do
401 * strict type-checking.. See the
402 * "unnecessary" pointer comparison.
404 #define min(x, y) ({ \
405 typeof(x) _min1 = (x); \
406 typeof(y) _min2 = (y); \
407 (void) (&_min1 == &_min2); \
408 _min1 < _min2 ? _min1 : _min2; })
410 #define max(x, y) ({ \
411 typeof(x) _max1 = (x); \
412 typeof(y) _max2 = (y); \
413 (void) (&_max1 == &_max2); \
414 _max1 > _max2 ? _max1 : _max2; })
417 * clamp - return a value clamped to a given range with strict typechecking
418 * @val: current value
419 * @min: minimum allowable value
420 * @max: maximum allowable value
422 * This macro does strict typechecking of min/max to make sure they are of the
423 * same type as val. See the unnecessary pointer comparisons.
425 #define clamp(val, min, max) ({ \
426 typeof(val) __val = (val); \
427 typeof(min) __min = (min); \
428 typeof(max) __max = (max); \
429 (void) (&__val == &__min); \
430 (void) (&__val == &__max); \
431 __val = __val < __min ? __min: __val; \
432 __val > __max ? __max: __val; })
435 * ..and if you can't take the strict
436 * types, you can specify one yourself.
438 * Or not use min/max/clamp at all, of course.
440 #define min_t(type, x, y) ({ \
443 __min1 < __min2 ? __min1: __min2; })
445 #define max_t(type, x, y) ({ \
448 __max1 > __max2 ? __max1: __max2; })
451 * clamp_t - return a value clamped to a given range using a given type
452 * @type: the type of variable to use
453 * @val: current value
454 * @min: minimum allowable value
455 * @max: maximum allowable value
457 * This macro does no typechecking and uses temporary variables of type
458 * 'type' to make all the comparisons.
460 #define clamp_t(type, val, min, max) ({ \
461 type __val = (val); \
462 type __min = (min); \
463 type __max = (max); \
464 __val = __val < __min ? __min: __val; \
465 __val > __max ? __max: __val; })
468 * clamp_val - return a value clamped to a given range using val's type
469 * @val: current value
470 * @min: minimum allowable value
471 * @max: maximum allowable value
473 * This macro does no typechecking and uses temporary variables of whatever
474 * type the input argument 'val' is. This is useful when val is an unsigned
475 * type and min and max are literals that will otherwise be assigned a signed
478 #define clamp_val(val, min, max) ({ \
479 typeof(val) __val = (val); \
480 typeof(val) __min = (min); \
481 typeof(val) __max = (max); \
482 __val = __val < __min ? __min: __val; \
483 __val > __max ? __max: __val; })
486 * container_of - cast a member of a structure out to the containing structure
487 * @ptr: the pointer to the member.
488 * @type: the type of the container struct this is embedded in.
489 * @member: the name of the member within the struct.
492 #define container_of(ptr, type, member) ({ \
493 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
494 (type *)( (char *)__mptr - offsetof(type,member) );})
497 extern int do_sysinfo(struct sysinfo
*info
);
499 #endif /* __KERNEL__ */
501 #define SI_LOAD_SHIFT 16
503 long uptime
; /* Seconds since boot */
504 unsigned long loads
[3]; /* 1, 5, and 15 minute load averages */
505 unsigned long totalram
; /* Total usable main memory size */
506 unsigned long freeram
; /* Available memory size */
507 unsigned long sharedram
; /* Amount of shared memory */
508 unsigned long bufferram
; /* Memory used by buffers */
509 unsigned long totalswap
; /* Total swap space size */
510 unsigned long freeswap
; /* swap space still available */
511 unsigned short procs
; /* Number of current processes */
512 unsigned short pad
; /* explicit padding for m68k */
513 unsigned long totalhigh
; /* Total high memory size */
514 unsigned long freehigh
; /* Available high memory size */
515 unsigned int mem_unit
; /* Memory unit size in bytes */
516 char _f
[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
519 /* Force a compilation error if condition is true */
520 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
522 /* Force a compilation error if condition is true, but also produce a
523 result (of value 0 and type size_t), so the expression can be used
524 e.g. in a structure initializer (or where-ever else comma expressions
525 aren't permitted). */
526 #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
528 /* Trap pasters of __FUNCTION__ at compile-time */
529 #define __FUNCTION__ (__func__)
531 /* This helps us to avoid #ifdef CONFIG_NUMA */
538 /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
539 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
540 # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD