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