printk: robustify printk, fix
[GitHub/LineageOS/android_kernel_samsung_universal7580.git] / include / linux / kernel.h
CommitLineData
1da177e4
LT
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>
f0d1b0b3 16#include <linux/log2.h>
e0deaff4 17#include <linux/typecheck.h>
717115e1 18#include <linux/ratelimit.h>
1da177e4
LT
19#include <asm/byteorder.h>
20#include <asm/bug.h>
21
3eb3c740
RZ
22extern const char linux_banner[];
23extern const char linux_proc_banner[];
24
44f564a4
ZY
25#define USHORT_MAX ((u16)(~0U))
26#define SHORT_MAX ((s16)(USHORT_MAX>>1))
27#define SHORT_MIN (-SHORT_MAX - 1)
1da177e4
LT
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)
111ebb6e
OH
34#define LLONG_MAX ((long long)(~0ULL>>1))
35#define LLONG_MIN (-LLONG_MAX - 1)
36#define ULLONG_MAX (~0ULL)
1da177e4
LT
37
38#define STACK_MAGIC 0xdeadbeef
39
2ea58144
LT
40#define ALIGN(x,a) __ALIGN_MASK(x,(typeof(x))(a)-1)
41#define __ALIGN_MASK(x,mask) (((x)+(mask))&~(mask))
a83308e6 42#define PTR_ALIGN(p, a) ((typeof(p))ALIGN((unsigned long)(p), (a)))
f10db627 43#define IS_ALIGNED(x, a) (((x) & ((typeof(x))(a) - 1)) == 0)
2ea58144 44
c5e631cf
RR
45#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
46
4552d5dc 47#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
930631ed 48#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
b4cac1a0 49#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
1da177e4 50
ca31e146
EGM
51#define _RET_IP_ (unsigned long)__builtin_return_address(0)
52#define _THIS_IP_ ({ __label__ __here; __here: (unsigned long)&&__here; })
53
2da96acd
JA
54#ifdef CONFIG_LBD
55# include <asm/div64.h>
56# define sector_div(a, b) do_div(a, b)
57#else
58# define sector_div(n, b)( \
59{ \
60 int _res; \
61 _res = (n) % (b); \
62 (n) /= (b); \
63 _res; \
64} \
65)
66#endif
67
218e180e
AM
68/**
69 * upper_32_bits - return bits 32-63 of a number
70 * @n: the number we're accessing
71 *
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
74 * 32-bits.
75 */
76#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
77
204b885e
JR
78/**
79 * lower_32_bits - return bits 0-31 of a number
80 * @n: the number we're accessing
81 */
82#define lower_32_bits(n) ((u32)(n))
83
1da177e4
LT
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 */
92
47492527
IM
93/*
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).
97 */
98#define KERN_CONT ""
99
1da177e4
LT
100extern int console_printk[];
101
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])
106
107struct completion;
df2e71fb
AM
108struct pt_regs;
109struct user;
1da177e4
LT
110
111/**
112 * might_sleep - annotation for functions that can sleep
113 *
114 * this macro will print a stack trace if it is executed in an atomic
115 * context (spinlock, irq-handler, ...).
116 *
117 * This is a useful debugging help to be able to catch problems early and not
e20ec991 118 * be bitten later when the calling function happens to sleep when it is not
1da177e4
LT
119 * supposed to.
120 */
f8cbd99b 121#ifdef CONFIG_PREEMPT_VOLUNTARY
02b67cc3
HX
122extern int _cond_resched(void);
123# define might_resched() _cond_resched()
f8cbd99b
IM
124#else
125# define might_resched() do { } while (0)
126#endif
127
1da177e4 128#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
f8cbd99b
IM
129 void __might_sleep(char *file, int line);
130# define might_sleep() \
131 do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
1da177e4 132#else
f8cbd99b 133# define might_sleep() do { might_resched(); } while (0)
1da177e4
LT
134#endif
135
368a5fa1 136#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
f8cbd99b 137
1da177e4
LT
138#define abs(x) ({ \
139 int __x = (x); \
140 (__x < 0) ? -__x : __x; \
141 })
142
e041c683 143extern struct atomic_notifier_head panic_notifier_list;
1da177e4
LT
144extern long (*panic_blink)(long time);
145NORET_TYPE void panic(const char * fmt, ...)
a586df06 146 __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
dd287796
AM
147extern void oops_enter(void);
148extern void oops_exit(void);
149extern int oops_may_print(void);
ec701584 150NORET_TYPE void do_exit(long error_code)
1da177e4
LT
151 ATTRIB_NORET;
152NORET_TYPE void complete_and_exit(struct completion *, long)
153 ATTRIB_NORET;
154extern unsigned long simple_strtoul(const char *,char **,unsigned int);
155extern long simple_strtol(const char *,char **,unsigned int);
156extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
157extern long long simple_strtoll(const char *,char **,unsigned int);
06b2a76d
YY
158extern int strict_strtoul(const char *, unsigned int, unsigned long *);
159extern int strict_strtol(const char *, unsigned int, long *);
160extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
161extern int strict_strtoll(const char *, unsigned int, long long *);
1da177e4
LT
162extern int sprintf(char * buf, const char * fmt, ...)
163 __attribute__ ((format (printf, 2, 3)));
164extern int vsprintf(char *buf, const char *, va_list)
165 __attribute__ ((format (printf, 2, 0)));
166extern int snprintf(char * buf, size_t size, const char * fmt, ...)
167 __attribute__ ((format (printf, 3, 4)));
168extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
169 __attribute__ ((format (printf, 3, 0)));
170extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
171 __attribute__ ((format (printf, 3, 4)));
172extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
173 __attribute__ ((format (printf, 3, 0)));
e905914f
JF
174extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
175 __attribute__ ((format (printf, 2, 3)));
11443ec7 176extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
1da177e4
LT
177
178extern int sscanf(const char *, const char *, ...)
179 __attribute__ ((format (scanf, 2, 3)));
180extern int vsscanf(const char *, const char *, va_list)
181 __attribute__ ((format (scanf, 2, 0)));
182
183extern int get_option(char **str, int *pint);
184extern char *get_options(const char *str, int nints, int *ints);
185extern unsigned long long memparse(char *ptr, char **retptr);
186
5e376613 187extern int core_kernel_text(unsigned long addr);
1da177e4
LT
188extern int __kernel_text_address(unsigned long addr);
189extern int kernel_text_address(unsigned long addr);
04a2e6a5
EB
190struct pid;
191extern struct pid *session_of_pgrp(struct pid *pgrp);
1da177e4 192
d59745ce 193#ifdef CONFIG_PRINTK
1da177e4
LT
194asmlinkage int vprintk(const char *fmt, va_list args)
195 __attribute__ ((format (printf, 1, 0)));
196asmlinkage int printk(const char * fmt, ...)
a586df06 197 __attribute__ ((format (printf, 1, 2))) __cold;
7ef3d2fd 198
717115e1 199extern struct ratelimit_state printk_ratelimit_state;
7ef3d2fd 200extern int printk_ratelimit(void);
7ef3d2fd
JP
201extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
202 unsigned int interval_msec);
d59745ce
MM
203#else
204static inline int vprintk(const char *s, va_list args)
205 __attribute__ ((format (printf, 1, 0)));
206static inline int vprintk(const char *s, va_list args) { return 0; }
207static inline int printk(const char *s, ...)
208 __attribute__ ((format (printf, 1, 2)));
a586df06 209static inline int __cold printk(const char *s, ...) { return 0; }
7ef3d2fd 210static inline int printk_ratelimit(void) { return 0; }
7ef3d2fd
JP
211static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
212 unsigned int interval_msec) \
213 { return false; }
d59745ce 214#endif
1da177e4 215
ced9cd40
IM
216extern int printk_needs_cpu(int cpu);
217extern void printk_tick(void);
218
e17ba73b 219extern void asmlinkage __attribute__((format(printf, 1, 2)))
076f9776
IM
220 early_printk(const char *fmt, ...);
221
1da177e4
LT
222unsigned long int_sqrt(unsigned long);
223
1da177e4
LT
224static inline void console_silent(void)
225{
226 console_loglevel = 0;
227}
228
229static inline void console_verbose(void)
230{
231 if (console_loglevel)
232 console_loglevel = 15;
233}
234
235extern void bust_spinlocks(int yes);
e3e8a75d 236extern void wake_up_klogd(void);
1da177e4 237extern int oops_in_progress; /* If set, an oops, panic(), BUG() or die() is in progress */
aa727107 238extern int panic_timeout;
1da177e4 239extern int panic_on_oops;
8da5adda 240extern int panic_on_unrecovered_nmi;
1da177e4
LT
241extern int tainted;
242extern const char *print_tainted(void);
243extern void add_taint(unsigned);
b920de1b 244extern int root_mountflags;
1da177e4
LT
245
246/* Values used for system_state */
247extern enum system_states {
248 SYSTEM_BOOTING,
249 SYSTEM_RUNNING,
250 SYSTEM_HALT,
251 SYSTEM_POWER_OFF,
252 SYSTEM_RESTART,
729b4d4c 253 SYSTEM_SUSPEND_DISK,
1da177e4
LT
254} system_state;
255
256#define TAINT_PROPRIETARY_MODULE (1<<0)
257#define TAINT_FORCED_MODULE (1<<1)
258#define TAINT_UNSAFE_SMP (1<<2)
259#define TAINT_FORCED_RMMOD (1<<3)
260#define TAINT_MACHINE_CHECK (1<<4)
261#define TAINT_BAD_PAGE (1<<5)
34f5a398 262#define TAINT_USER (1<<6)
bcdcd8e7 263#define TAINT_DIE (1<<7)
6ed31e92 264#define TAINT_OVERRIDDEN_ACPI_TABLE (1<<8)
95b570c9 265#define TAINT_WARN (1<<9)
1da177e4 266
a586df06 267extern void dump_stack(void) __cold;
1da177e4 268
99eaf3c4
RD
269enum {
270 DUMP_PREFIX_NONE,
271 DUMP_PREFIX_ADDRESS,
272 DUMP_PREFIX_OFFSET
273};
c7909234
RD
274extern void hex_dump_to_buffer(const void *buf, size_t len,
275 int rowsize, int groupsize,
276 char *linebuf, size_t linebuflen, bool ascii);
277extern void print_hex_dump(const char *level, const char *prefix_str,
278 int prefix_type, int rowsize, int groupsize,
6a0ed91e 279 const void *buf, size_t len, bool ascii);
c7909234 280extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
eb9a9a56 281 const void *buf, size_t len);
3fc95772
HH
282
283extern const char hex_asc[];
284#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
285#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
286
287static inline char *pack_hex_byte(char *buf, u8 byte)
288{
289 *buf++ = hex_asc_hi(byte);
290 *buf++ = hex_asc_lo(byte);
291 return buf;
292}
99eaf3c4 293
1f7c8234
EM
294#define pr_emerg(fmt, arg...) \
295 printk(KERN_EMERG fmt, ##arg)
296#define pr_alert(fmt, arg...) \
297 printk(KERN_ALERT fmt, ##arg)
298#define pr_crit(fmt, arg...) \
299 printk(KERN_CRIT fmt, ##arg)
300#define pr_err(fmt, arg...) \
301 printk(KERN_ERR fmt, ##arg)
302#define pr_warning(fmt, arg...) \
303 printk(KERN_WARNING fmt, ##arg)
304#define pr_notice(fmt, arg...) \
305 printk(KERN_NOTICE fmt, ##arg)
306#define pr_info(fmt, arg...) \
307 printk(KERN_INFO fmt, ##arg)
308
1da177e4 309#ifdef DEBUG
1cc6daf2 310/* If you are writing a driver, please use dev_dbg instead */
1f7c8234
EM
311#define pr_debug(fmt, arg...) \
312 printk(KERN_DEBUG fmt, ##arg)
1da177e4 313#else
1429db83
JP
314#define pr_debug(fmt, arg...) \
315 ({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
1da177e4
LT
316#endif
317
1da177e4
LT
318/*
319 * Display an IP address in readable format.
320 */
321
322#define NIPQUAD(addr) \
323 ((unsigned char *)&addr)[0], \
324 ((unsigned char *)&addr)[1], \
325 ((unsigned char *)&addr)[2], \
326 ((unsigned char *)&addr)[3]
46b86a2d 327#define NIPQUAD_FMT "%u.%u.%u.%u"
1da177e4
LT
328
329#define NIP6(addr) \
330 ntohs((addr).s6_addr16[0]), \
331 ntohs((addr).s6_addr16[1]), \
332 ntohs((addr).s6_addr16[2]), \
333 ntohs((addr).s6_addr16[3]), \
334 ntohs((addr).s6_addr16[4]), \
335 ntohs((addr).s6_addr16[5]), \
336 ntohs((addr).s6_addr16[6]), \
337 ntohs((addr).s6_addr16[7])
46b86a2d 338#define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
9343e79a 339#define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
1da177e4
LT
340
341#if defined(__LITTLE_ENDIAN)
342#define HIPQUAD(addr) \
343 ((unsigned char *)&addr)[3], \
344 ((unsigned char *)&addr)[2], \
345 ((unsigned char *)&addr)[1], \
346 ((unsigned char *)&addr)[0]
347#elif defined(__BIG_ENDIAN)
348#define HIPQUAD NIPQUAD
349#else
350#error "Please fix asm/byteorder.h"
351#endif /* __LITTLE_ENDIAN */
352
353/*
bdf4bbaa 354 * min()/max()/clamp() macros that also do
1da177e4
LT
355 * strict type-checking.. See the
356 * "unnecessary" pointer comparison.
357 */
bdf4bbaa
HH
358#define min(x, y) ({ \
359 typeof(x) _min1 = (x); \
360 typeof(y) _min2 = (y); \
361 (void) (&_min1 == &_min2); \
362 _min1 < _min2 ? _min1 : _min2; })
363
364#define max(x, y) ({ \
365 typeof(x) _max1 = (x); \
366 typeof(y) _max2 = (y); \
367 (void) (&_max1 == &_max2); \
368 _max1 > _max2 ? _max1 : _max2; })
369
370/**
371 * clamp - return a value clamped to a given range with strict typechecking
372 * @val: current value
373 * @min: minimum allowable value
374 * @max: maximum allowable value
375 *
376 * This macro does strict typechecking of min/max to make sure they are of the
377 * same type as val. See the unnecessary pointer comparisons.
378 */
379#define clamp(val, min, max) ({ \
380 typeof(val) __val = (val); \
381 typeof(min) __min = (min); \
382 typeof(max) __max = (max); \
383 (void) (&__val == &__min); \
384 (void) (&__val == &__max); \
385 __val = __val < __min ? __min: __val; \
386 __val > __max ? __max: __val; })
1da177e4
LT
387
388/*
389 * ..and if you can't take the strict
390 * types, you can specify one yourself.
391 *
bdf4bbaa
HH
392 * Or not use min/max/clamp at all, of course.
393 */
394#define min_t(type, x, y) ({ \
395 type __min1 = (x); \
396 type __min2 = (y); \
397 __min1 < __min2 ? __min1: __min2; })
398
399#define max_t(type, x, y) ({ \
400 type __max1 = (x); \
401 type __max2 = (y); \
402 __max1 > __max2 ? __max1: __max2; })
403
404/**
405 * clamp_t - return a value clamped to a given range using a given type
406 * @type: the type of variable to use
407 * @val: current value
408 * @min: minimum allowable value
409 * @max: maximum allowable value
410 *
411 * This macro does no typechecking and uses temporary variables of type
412 * 'type' to make all the comparisons.
1da177e4 413 */
bdf4bbaa
HH
414#define clamp_t(type, val, min, max) ({ \
415 type __val = (val); \
416 type __min = (min); \
417 type __max = (max); \
418 __val = __val < __min ? __min: __val; \
419 __val > __max ? __max: __val; })
1da177e4 420
bdf4bbaa
HH
421/**
422 * clamp_val - return a value clamped to a given range using val's type
423 * @val: current value
424 * @min: minimum allowable value
425 * @max: maximum allowable value
426 *
427 * This macro does no typechecking and uses temporary variables of whatever
428 * type the input argument 'val' is. This is useful when val is an unsigned
429 * type and min and max are literals that will otherwise be assigned a signed
430 * integer type.
431 */
432#define clamp_val(val, min, max) ({ \
433 typeof(val) __val = (val); \
434 typeof(val) __min = (min); \
435 typeof(val) __max = (max); \
436 __val = __val < __min ? __min: __val; \
437 __val > __max ? __max: __val; })
1da177e4
LT
438
439/**
440 * container_of - cast a member of a structure out to the containing structure
1da177e4
LT
441 * @ptr: the pointer to the member.
442 * @type: the type of the container struct this is embedded in.
443 * @member: the name of the member within the struct.
444 *
445 */
446#define container_of(ptr, type, member) ({ \
78db2ad6
DW
447 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
448 (type *)( (char *)__mptr - offsetof(type,member) );})
1da177e4 449
d4d23add
KM
450struct sysinfo;
451extern int do_sysinfo(struct sysinfo *info);
452
1da177e4
LT
453#endif /* __KERNEL__ */
454
455#define SI_LOAD_SHIFT 16
456struct sysinfo {
457 long uptime; /* Seconds since boot */
458 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
459 unsigned long totalram; /* Total usable main memory size */
460 unsigned long freeram; /* Available memory size */
461 unsigned long sharedram; /* Amount of shared memory */
462 unsigned long bufferram; /* Memory used by buffers */
463 unsigned long totalswap; /* Total swap space size */
464 unsigned long freeswap; /* swap space still available */
465 unsigned short procs; /* Number of current processes */
466 unsigned short pad; /* explicit padding for m68k */
467 unsigned long totalhigh; /* Total high memory size */
468 unsigned long freehigh; /* Available high memory size */
469 unsigned int mem_unit; /* Memory unit size in bytes */
470 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
471};
472
c0398ee6 473/* Force a compilation error if condition is true */
921717a2 474#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
1da177e4 475
4552d5dc
JB
476/* Force a compilation error if condition is true, but also produce a
477 result (of value 0 and type size_t), so the expression can be used
478 e.g. in a structure initializer (or where-ever else comma expressions
479 aren't permitted). */
480#define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
481
1da177e4 482/* Trap pasters of __FUNCTION__ at compile-time */
1da177e4 483#define __FUNCTION__ (__func__)
1da177e4 484
08e0f6a9
CL
485/* This helps us to avoid #ifdef CONFIG_NUMA */
486#ifdef CONFIG_NUMA
487#define NUMA_BUILD 1
488#else
489#define NUMA_BUILD 0
490#endif
491
1da177e4 492#endif