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