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