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 <asm/byteorder.h>
22 extern const char linux_banner
[];
23 extern const char linux_proc_banner
[];
25 #define USHORT_MAX ((u16)(~0U))
26 #define SHORT_MAX ((s16)(USHORT_MAX>>1))
27 #define SHORT_MIN (-SHORT_MAX - 1)
28 #define INT_MAX ((int)(~0U>>1))
29 #define INT_MIN (-INT_MAX - 1)
30 #define UINT_MAX (~0U)
31 #define LONG_MAX ((long)(~0UL>>1))
32 #define LONG_MIN (-LONG_MAX - 1)
33 #define ULONG_MAX (~0UL)
34 #define LLONG_MAX ((long long)(~0ULL>>1))
35 #define LLONG_MIN (-LLONG_MAX - 1)
36 #define ULLONG_MAX (~0ULL)
38 #define STACK_MAGIC 0xdeadbeef
40 #define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
41 #define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
42 #define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
43 #define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
45 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
47 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
48 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
49 #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
51 #define _RET_IP_ (unsigned long)__builtin_return_address(0)
52 #define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
55 # include <asm/div64.h>
56 # define sector_div(a, b) do_div(a, b)
58 # define sector_div(n, b)( \
69 * upper_32_bits - return bits 32-63 of a number
70 * @n: the number we're accessing
72 * A basic shift-right of a 64- or 32-bit quantity. Use this to suppress
73 * the "right shift count >= width of type" warning when that quantity is
76 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
79 * lower_32_bits - return bits 0-31 of a number
80 * @n: the number we're accessing
82 #define lower_32_bits(n) ((u32)(n))
84 #define KERN_EMERG "<0>" /* system is unusable */
85 #define KERN_ALERT "<1>" /* action must be taken immediately */
86 #define KERN_CRIT "<2>" /* critical conditions */
87 #define KERN_ERR "<3>" /* error conditions */
88 #define KERN_WARNING "<4>" /* warning conditions */
89 #define KERN_NOTICE "<5>" /* normal but significant condition */
90 #define KERN_INFO "<6>" /* informational */
91 #define KERN_DEBUG "<7>" /* debug-level messages */
94 * Annotation for a "continued" line of log printout (only done after a
95 * line that had no enclosing \n). Only to be used by core/arch code
96 * during early bootup (a continued line is not SMP-safe otherwise).
100 extern int console_printk
[];
102 #define console_loglevel (console_printk[0])
103 #define default_message_loglevel (console_printk[1])
104 #define minimum_console_loglevel (console_printk[2])
105 #define default_console_loglevel (console_printk[3])
111 #ifdef CONFIG_PREEMPT_VOLUNTARY
112 extern int _cond_resched(void);
113 # define might_resched() _cond_resched()
115 # define might_resched() do { } while (0)
119 * might_sleep - annotation for functions that can sleep
121 * this macro will print a stack trace if it is executed in an atomic
122 * context (spinlock, irq-handler, ...).
124 * This is a useful debugging help to be able to catch problems early and not
125 * be bitten later when the calling function happens to sleep when it is not
128 #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
129 void __might_sleep(char *file
, int line
);
130 # define might_sleep() \
131 do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
133 # define might_sleep() do { might_resched(); } while (0)
136 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
140 (__x < 0) ? -__x : __x; \
143 extern struct atomic_notifier_head panic_notifier_list
;
144 extern long (*panic_blink
)(long time
);
145 NORET_TYPE
void panic(const char * fmt
, ...)
146 __attribute__ ((NORET_AND
format (printf
, 1, 2))) __cold
;
147 extern void oops_enter(void);
148 extern void oops_exit(void);
149 extern int oops_may_print(void);
150 NORET_TYPE
void do_exit(long error_code
)
152 NORET_TYPE
void complete_and_exit(struct completion
*, long)
154 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
155 extern long simple_strtol(const char *,char **,unsigned int);
156 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
157 extern long long simple_strtoll(const char *,char **,unsigned int);
158 extern int strict_strtoul(const char *, unsigned int, unsigned long *);
159 extern int strict_strtol(const char *, unsigned int, long *);
160 extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
161 extern int strict_strtoll(const char *, unsigned int, long long *);
162 extern int sprintf(char * buf
, const char * fmt
, ...)
163 __attribute__ ((format (printf
, 2, 3)));
164 extern int vsprintf(char *buf
, const char *, va_list)
165 __attribute__ ((format (printf
, 2, 0)));
166 extern int snprintf(char * buf
, size_t size
, const char * fmt
, ...)
167 __attribute__ ((format (printf
, 3, 4)));
168 extern int vsnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
169 __attribute__ ((format (printf
, 3, 0)));
170 extern int scnprintf(char * buf
, size_t size
, const char * fmt
, ...)
171 __attribute__ ((format (printf
, 3, 4)));
172 extern int vscnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
173 __attribute__ ((format (printf
, 3, 0)));
174 extern char *kasprintf(gfp_t gfp
, const char *fmt
, ...)
175 __attribute__ ((format (printf
, 2, 3)));
176 extern char *kvasprintf(gfp_t gfp
, const char *fmt
, va_list args
);
178 extern int sscanf(const char *, const char *, ...)
179 __attribute__ ((format (scanf
, 2, 3)));
180 extern int vsscanf(const char *, const char *, va_list)
181 __attribute__ ((format (scanf
, 2, 0)));
183 extern int get_option(char **str
, int *pint
);
184 extern char *get_options(const char *str
, int nints
, int *ints
);
185 extern unsigned long long memparse(char *ptr
, char **retptr
);
187 extern int core_kernel_text(unsigned long addr
);
188 extern int __kernel_text_address(unsigned long addr
);
189 extern int kernel_text_address(unsigned long addr
);
190 extern int func_ptr_is_kernel_text(void *ptr
);
193 extern struct pid
*session_of_pgrp(struct pid
*pgrp
);
196 asmlinkage
int vprintk(const char *fmt
, va_list args
)
197 __attribute__ ((format (printf
, 1, 0)));
198 asmlinkage
int printk(const char * fmt
, ...)
199 __attribute__ ((format (printf
, 1, 2))) __cold
;
201 extern struct ratelimit_state printk_ratelimit_state
;
202 extern int printk_ratelimit(void);
203 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies
,
204 unsigned int interval_msec
);
206 static inline int vprintk(const char *s
, va_list args
)
207 __attribute__ ((format (printf
, 1, 0)));
208 static inline int vprintk(const char *s
, va_list args
) { return 0; }
209 static inline int printk(const char *s
, ...)
210 __attribute__ ((format (printf
, 1, 2)));
211 static inline int __cold
printk(const char *s
, ...) { return 0; }
212 static inline int printk_ratelimit(void) { return 0; }
213 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies
, \
214 unsigned int interval_msec
) \
218 extern void asmlinkage
__attribute__((format(printf
, 1, 2)))
219 early_printk(const char *fmt
, ...);
221 unsigned long int_sqrt(unsigned long);
223 static inline void console_silent(void)
225 console_loglevel
= 0;
228 static inline void console_verbose(void)
230 if (console_loglevel
)
231 console_loglevel
= 15;
234 extern void bust_spinlocks(int yes
);
235 extern void wake_up_klogd(void);
236 extern int oops_in_progress
; /* If set, an oops, panic(), BUG() or die() is in progress */
237 extern int panic_timeout
;
238 extern int panic_on_oops
;
239 extern int panic_on_unrecovered_nmi
;
241 extern const char *print_tainted(void);
242 extern void add_taint(unsigned);
243 extern int root_mountflags
;
245 /* Values used for system_state */
246 extern enum system_states
{
255 #define TAINT_PROPRIETARY_MODULE (1<<0)
256 #define TAINT_FORCED_MODULE (1<<1)
257 #define TAINT_UNSAFE_SMP (1<<2)
258 #define TAINT_FORCED_RMMOD (1<<3)
259 #define TAINT_MACHINE_CHECK (1<<4)
260 #define TAINT_BAD_PAGE (1<<5)
261 #define TAINT_USER (1<<6)
262 #define TAINT_DIE (1<<7)
263 #define TAINT_OVERRIDDEN_ACPI_TABLE (1<<8)
264 #define TAINT_WARN (1<<9)
266 extern void dump_stack(void) __cold
;
273 extern void hex_dump_to_buffer(const void *buf
, size_t len
,
274 int rowsize
, int groupsize
,
275 char *linebuf
, size_t linebuflen
, bool ascii
);
276 extern void print_hex_dump(const char *level
, const char *prefix_str
,
277 int prefix_type
, int rowsize
, int groupsize
,
278 const void *buf
, size_t len
, bool ascii
);
279 extern void print_hex_dump_bytes(const char *prefix_str
, int prefix_type
,
280 const void *buf
, size_t len
);
282 extern const char hex_asc
[];
283 #define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
284 #define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
286 static inline char *pack_hex_byte(char *buf
, u8 byte
)
288 *buf
++ = hex_asc_hi(byte
);
289 *buf
++ = hex_asc_lo(byte
);
293 #define pr_emerg(fmt, arg...) \
294 printk(KERN_EMERG fmt, ##arg)
295 #define pr_alert(fmt, arg...) \
296 printk(KERN_ALERT fmt, ##arg)
297 #define pr_crit(fmt, arg...) \
298 printk(KERN_CRIT fmt, ##arg)
299 #define pr_err(fmt, arg...) \
300 printk(KERN_ERR fmt, ##arg)
301 #define pr_warning(fmt, arg...) \
302 printk(KERN_WARNING fmt, ##arg)
303 #define pr_notice(fmt, arg...) \
304 printk(KERN_NOTICE fmt, ##arg)
305 #define pr_info(fmt, arg...) \
306 printk(KERN_INFO fmt, ##arg)
309 /* If you are writing a driver, please use dev_dbg instead */
310 #define pr_debug(fmt, arg...) \
311 printk(KERN_DEBUG fmt, ##arg)
313 #define pr_debug(fmt, arg...) \
314 ({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
318 * Display an IP address in readable format.
321 #define NIPQUAD(addr) \
322 ((unsigned char *)&addr)[0], \
323 ((unsigned char *)&addr)[1], \
324 ((unsigned char *)&addr)[2], \
325 ((unsigned char *)&addr)[3]
326 #define NIPQUAD_FMT "%u.%u.%u.%u"
329 ntohs((addr).s6_addr16[0]), \
330 ntohs((addr).s6_addr16[1]), \
331 ntohs((addr).s6_addr16[2]), \
332 ntohs((addr).s6_addr16[3]), \
333 ntohs((addr).s6_addr16[4]), \
334 ntohs((addr).s6_addr16[5]), \
335 ntohs((addr).s6_addr16[6]), \
336 ntohs((addr).s6_addr16[7])
337 #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
338 #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
340 #if defined(__LITTLE_ENDIAN)
341 #define HIPQUAD(addr) \
342 ((unsigned char *)&addr)[3], \
343 ((unsigned char *)&addr)[2], \
344 ((unsigned char *)&addr)[1], \
345 ((unsigned char *)&addr)[0]
346 #elif defined(__BIG_ENDIAN)
347 #define HIPQUAD NIPQUAD
349 #error "Please fix asm/byteorder.h"
350 #endif /* __LITTLE_ENDIAN */
353 * min()/max()/clamp() macros that also do
354 * strict type-checking.. See the
355 * "unnecessary" pointer comparison.
357 #define min(x, y) ({ \
358 typeof(x) _min1 = (x); \
359 typeof(y) _min2 = (y); \
360 (void) (&_min1 == &_min2); \
361 _min1 < _min2 ? _min1 : _min2; })
363 #define max(x, y) ({ \
364 typeof(x) _max1 = (x); \
365 typeof(y) _max2 = (y); \
366 (void) (&_max1 == &_max2); \
367 _max1 > _max2 ? _max1 : _max2; })
370 * clamp - return a value clamped to a given range with strict typechecking
371 * @val: current value
372 * @min: minimum allowable value
373 * @max: maximum allowable value
375 * This macro does strict typechecking of min/max to make sure they are of the
376 * same type as val. See the unnecessary pointer comparisons.
378 #define clamp(val, min, max) ({ \
379 typeof(val) __val = (val); \
380 typeof(min) __min = (min); \
381 typeof(max) __max = (max); \
382 (void) (&__val == &__min); \
383 (void) (&__val == &__max); \
384 __val = __val < __min ? __min: __val; \
385 __val > __max ? __max: __val; })
388 * ..and if you can't take the strict
389 * types, you can specify one yourself.
391 * Or not use min/max/clamp at all, of course.
393 #define min_t(type, x, y) ({ \
396 __min1 < __min2 ? __min1: __min2; })
398 #define max_t(type, x, y) ({ \
401 __max1 > __max2 ? __max1: __max2; })
404 * clamp_t - return a value clamped to a given range using a given type
405 * @type: the type of variable to use
406 * @val: current value
407 * @min: minimum allowable value
408 * @max: maximum allowable value
410 * This macro does no typechecking and uses temporary variables of type
411 * 'type' to make all the comparisons.
413 #define clamp_t(type, val, min, max) ({ \
414 type __val = (val); \
415 type __min = (min); \
416 type __max = (max); \
417 __val = __val < __min ? __min: __val; \
418 __val > __max ? __max: __val; })
421 * clamp_val - return a value clamped to a given range using val's type
422 * @val: current value
423 * @min: minimum allowable value
424 * @max: maximum allowable value
426 * This macro does no typechecking and uses temporary variables of whatever
427 * type the input argument 'val' is. This is useful when val is an unsigned
428 * type and min and max are literals that will otherwise be assigned a signed
431 #define clamp_val(val, min, max) ({ \
432 typeof(val) __val = (val); \
433 typeof(val) __min = (min); \
434 typeof(val) __max = (max); \
435 __val = __val < __min ? __min: __val; \
436 __val > __max ? __max: __val; })
439 * container_of - cast a member of a structure out to the containing structure
440 * @ptr: the pointer to the member.
441 * @type: the type of the container struct this is embedded in.
442 * @member: the name of the member within the struct.
445 #define container_of(ptr, type, member) ({ \
446 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
447 (type *)( (char *)__mptr - offsetof(type,member) );})
450 extern int do_sysinfo(struct sysinfo
*info
);
452 #endif /* __KERNEL__ */
454 #define SI_LOAD_SHIFT 16
456 long uptime
; /* Seconds since boot */
457 unsigned long loads
[3]; /* 1, 5, and 15 minute load averages */
458 unsigned long totalram
; /* Total usable main memory size */
459 unsigned long freeram
; /* Available memory size */
460 unsigned long sharedram
; /* Amount of shared memory */
461 unsigned long bufferram
; /* Memory used by buffers */
462 unsigned long totalswap
; /* Total swap space size */
463 unsigned long freeswap
; /* swap space still available */
464 unsigned short procs
; /* Number of current processes */
465 unsigned short pad
; /* explicit padding for m68k */
466 unsigned long totalhigh
; /* Total high memory size */
467 unsigned long freehigh
; /* Available high memory size */
468 unsigned int mem_unit
; /* Memory unit size in bytes */
469 char _f
[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
472 /* Force a compilation error if condition is true */
473 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
475 /* Force a compilation error if condition is true, but also produce a
476 result (of value 0 and type size_t), so the expression can be used
477 e.g. in a structure initializer (or where-ever else comma expressions
478 aren't permitted). */
479 #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
481 /* Trap pasters of __FUNCTION__ at compile-time */
482 #define __FUNCTION__ (__func__)
484 /* This helps us to avoid #ifdef CONFIG_NUMA */