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)
120 * might_sleep - annotation for functions that can sleep
122 * this macro will print a stack trace if it is executed in an atomic
123 * context (spinlock, irq-handler, ...).
125 * This is a useful debugging help to be able to catch problems early and not
126 * be bitten later when the calling function happens to sleep when it is not
129 #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
130 void __might_sleep(char *file, int line);
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 extern struct atomic_notifier_head panic_notifier_list;
145 extern long (*panic_blink)(long time);
146 NORET_TYPE void panic(const char * fmt, ...)
147 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
148 extern void oops_enter(void);
149 extern void oops_exit(void);
150 extern int oops_may_print(void);
151 NORET_TYPE void do_exit(long error_code)
153 NORET_TYPE void complete_and_exit(struct completion *, long)
155 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
156 extern long simple_strtol(const char *,char **,unsigned int);
157 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
158 extern long long simple_strtoll(const char *,char **,unsigned int);
159 extern int strict_strtoul(const char *, unsigned int, unsigned long *);
160 extern int strict_strtol(const char *, unsigned int, long *);
161 extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
162 extern int strict_strtoll(const char *, unsigned int, long long *);
163 extern int sprintf(char * buf, const char * fmt, ...)
164 __attribute__ ((format (printf, 2, 3)));
165 extern int vsprintf(char *buf, const char *, va_list)
166 __attribute__ ((format (printf, 2, 0)));
167 extern int snprintf(char * buf, size_t size, const char * fmt, ...)
168 __attribute__ ((format (printf, 3, 4)));
169 extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
170 __attribute__ ((format (printf, 3, 0)));
171 extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
172 __attribute__ ((format (printf, 3, 4)));
173 extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
174 __attribute__ ((format (printf, 3, 0)));
175 extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
176 __attribute__ ((format (printf, 2, 3)));
177 extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
179 extern int sscanf(const char *, const char *, ...)
180 __attribute__ ((format (scanf, 2, 3)));
181 extern int vsscanf(const char *, const char *, va_list)
182 __attribute__ ((format (scanf, 2, 0)));
184 extern int get_option(char **str, int *pint);
185 extern char *get_options(const char *str, int nints, int *ints);
186 extern unsigned long long memparse(const char *ptr, char **retptr);
188 extern int core_kernel_text(unsigned long addr);
189 extern int __kernel_text_address(unsigned long addr);
190 extern int kernel_text_address(unsigned long addr);
192 extern struct pid *session_of_pgrp(struct pid *pgrp);
195 asmlinkage int vprintk(const char *fmt, va_list args)
196 __attribute__ ((format (printf, 1, 0)));
197 asmlinkage int printk(const char * fmt, ...)
198 __attribute__ ((format (printf, 1, 2))) __cold;
200 extern struct ratelimit_state printk_ratelimit_state;
201 extern int printk_ratelimit(void);
202 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
203 unsigned int interval_msec);
205 static inline int vprintk(const char *s, va_list args)
206 __attribute__ ((format (printf, 1, 0)));
207 static inline int vprintk(const char *s, va_list args) { return 0; }
208 static inline int printk(const char *s, ...)
209 __attribute__ ((format (printf, 1, 2)));
210 static inline int __cold printk(const char *s, ...) { return 0; }
211 static inline int printk_ratelimit(void) { return 0; }
212 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
213 unsigned int interval_msec) \
217 extern void asmlinkage __attribute__((format(printf, 1, 2)))
218 early_printk(const char *fmt, ...);
220 unsigned long int_sqrt(unsigned long);
222 static inline void console_silent(void)
224 console_loglevel = 0;
227 static inline void console_verbose(void)
229 if (console_loglevel)
230 console_loglevel = 15;
233 extern void bust_spinlocks(int yes);
234 extern void wake_up_klogd(void);
235 extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
236 extern int panic_timeout;
237 extern int panic_on_oops;
238 extern int panic_on_unrecovered_nmi;
240 extern const char *print_tainted(void);
241 extern void add_taint(unsigned);
242 extern int root_mountflags;
244 /* Values used for system_state */
245 extern enum system_states {
254 #define TAINT_PROPRIETARY_MODULE (1<<0)
255 #define TAINT_FORCED_MODULE (1<<1)
256 #define TAINT_UNSAFE_SMP (1<<2)
257 #define TAINT_FORCED_RMMOD (1<<3)
258 #define TAINT_MACHINE_CHECK (1<<4)
259 #define TAINT_BAD_PAGE (1<<5)
260 #define TAINT_USER (1<<6)
261 #define TAINT_DIE (1<<7)
262 #define TAINT_OVERRIDDEN_ACPI_TABLE (1<<8)
263 #define TAINT_WARN (1<<9)
265 extern void dump_stack(void) __cold;
272 extern void hex_dump_to_buffer(const void *buf, size_t len,
273 int rowsize, int groupsize,
274 char *linebuf, size_t linebuflen, bool ascii);
275 extern void print_hex_dump(const char *level, const char *prefix_str,
276 int prefix_type, int rowsize, int groupsize,
277 const void *buf, size_t len, bool ascii);
278 extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
279 const void *buf, size_t len);
281 extern const char hex_asc[];
282 #define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
283 #define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
285 static inline char *pack_hex_byte(char *buf, u8 byte)
287 *buf++ = hex_asc_hi(byte);
288 *buf++ = hex_asc_lo(byte);
292 #define pr_emerg(fmt, arg...) \
293 printk(KERN_EMERG fmt, ##arg)
294 #define pr_alert(fmt, arg...) \
295 printk(KERN_ALERT fmt, ##arg)
296 #define pr_crit(fmt, arg...) \
297 printk(KERN_CRIT fmt, ##arg)
298 #define pr_err(fmt, arg...) \
299 printk(KERN_ERR fmt, ##arg)
300 #define pr_warning(fmt, arg...) \
301 printk(KERN_WARNING fmt, ##arg)
302 #define pr_notice(fmt, arg...) \
303 printk(KERN_NOTICE fmt, ##arg)
304 #define pr_info(fmt, arg...) \
305 printk(KERN_INFO fmt, ##arg)
307 /* If you are writing a driver, please use dev_dbg instead */
308 #if defined(CONFIG_DYNAMIC_PRINTK_DEBUG)
309 #define pr_debug(fmt, ...) do { \
310 dynamic_pr_debug(fmt, ##__VA_ARGS__); \
313 #define pr_debug(fmt, arg...) \
314 printk(KERN_DEBUG fmt, ##arg)
316 #define pr_debug(fmt, arg...) \
317 ({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
321 * Display an IP address in readable format.
324 #define NIPQUAD(addr) \
325 ((unsigned char *)&addr)[0], \
326 ((unsigned char *)&addr)[1], \
327 ((unsigned char *)&addr)[2], \
328 ((unsigned char *)&addr)[3]
329 #define NIPQUAD_FMT "%u.%u.%u.%u"
332 ntohs((addr).s6_addr16[0]), \
333 ntohs((addr).s6_addr16[1]), \
334 ntohs((addr).s6_addr16[2]), \
335 ntohs((addr).s6_addr16[3]), \
336 ntohs((addr).s6_addr16[4]), \
337 ntohs((addr).s6_addr16[5]), \
338 ntohs((addr).s6_addr16[6]), \
339 ntohs((addr).s6_addr16[7])
340 #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
341 #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
343 #if defined(__LITTLE_ENDIAN)
344 #define HIPQUAD(addr) \
345 ((unsigned char *)&addr)[3], \
346 ((unsigned char *)&addr)[2], \
347 ((unsigned char *)&addr)[1], \
348 ((unsigned char *)&addr)[0]
349 #elif defined(__BIG_ENDIAN)
350 #define HIPQUAD NIPQUAD
352 #error "Please fix asm/byteorder.h"
353 #endif /* __LITTLE_ENDIAN */
356 * min()/max()/clamp() macros that also do
357 * strict type-checking.. See the
358 * "unnecessary" pointer comparison.
360 #define min(x, y) ({ \
361 typeof(x) _min1 = (x); \
362 typeof(y) _min2 = (y); \
363 (void) (&_min1 == &_min2); \
364 _min1 < _min2 ? _min1 : _min2; })
366 #define max(x, y) ({ \
367 typeof(x) _max1 = (x); \
368 typeof(y) _max2 = (y); \
369 (void) (&_max1 == &_max2); \
370 _max1 > _max2 ? _max1 : _max2; })
373 * clamp - return a value clamped to a given range with strict typechecking
374 * @val: current value
375 * @min: minimum allowable value
376 * @max: maximum allowable value
378 * This macro does strict typechecking of min/max to make sure they are of the
379 * same type as val. See the unnecessary pointer comparisons.
381 #define clamp(val, min, max) ({ \
382 typeof(val) __val = (val); \
383 typeof(min) __min = (min); \
384 typeof(max) __max = (max); \
385 (void) (&__val == &__min); \
386 (void) (&__val == &__max); \
387 __val = __val < __min ? __min: __val; \
388 __val > __max ? __max: __val; })
391 * ..and if you can't take the strict
392 * types, you can specify one yourself.
394 * Or not use min/max/clamp at all, of course.
396 #define min_t(type, x, y) ({ \
399 __min1 < __min2 ? __min1: __min2; })
401 #define max_t(type, x, y) ({ \
404 __max1 > __max2 ? __max1: __max2; })
407 * clamp_t - return a value clamped to a given range using a given type
408 * @type: the type of variable to use
409 * @val: current value
410 * @min: minimum allowable value
411 * @max: maximum allowable value
413 * This macro does no typechecking and uses temporary variables of type
414 * 'type' to make all the comparisons.
416 #define clamp_t(type, val, min, max) ({ \
417 type __val = (val); \
418 type __min = (min); \
419 type __max = (max); \
420 __val = __val < __min ? __min: __val; \
421 __val > __max ? __max: __val; })
424 * clamp_val - return a value clamped to a given range using val's type
425 * @val: current value
426 * @min: minimum allowable value
427 * @max: maximum allowable value
429 * This macro does no typechecking and uses temporary variables of whatever
430 * type the input argument 'val' is. This is useful when val is an unsigned
431 * type and min and max are literals that will otherwise be assigned a signed
434 #define clamp_val(val, min, max) ({ \
435 typeof(val) __val = (val); \
436 typeof(val) __min = (min); \
437 typeof(val) __max = (max); \
438 __val = __val < __min ? __min: __val; \
439 __val > __max ? __max: __val; })
442 * container_of - cast a member of a structure out to the containing structure
443 * @ptr: the pointer to the member.
444 * @type: the type of the container struct this is embedded in.
445 * @member: the name of the member within the struct.
448 #define container_of(ptr, type, member) ({ \
449 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
450 (type *)( (char *)__mptr - offsetof(type,member) );})
453 extern int do_sysinfo(struct sysinfo *info);
455 #endif /* __KERNEL__ */
457 #define SI_LOAD_SHIFT 16
459 long uptime; /* Seconds since boot */
460 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
461 unsigned long totalram; /* Total usable main memory size */
462 unsigned long freeram; /* Available memory size */
463 unsigned long sharedram; /* Amount of shared memory */
464 unsigned long bufferram; /* Memory used by buffers */
465 unsigned long totalswap; /* Total swap space size */
466 unsigned long freeswap; /* swap space still available */
467 unsigned short procs; /* Number of current processes */
468 unsigned short pad; /* explicit padding for m68k */
469 unsigned long totalhigh; /* Total high memory size */
470 unsigned long freehigh; /* Available high memory size */
471 unsigned int mem_unit; /* Memory unit size in bytes */
472 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
475 /* Force a compilation error if condition is true */
476 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
478 /* Force a compilation error if condition is true, but also produce a
479 result (of value 0 and type size_t), so the expression can be used
480 e.g. in a structure initializer (or where-ever else comma expressions
481 aren't permitted). */
482 #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
484 /* Trap pasters of __FUNCTION__ at compile-time */
485 #define __FUNCTION__ (__func__)
487 /* This helps us to avoid #ifdef CONFIG_NUMA */