kernel.h 27.2 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10
#ifndef _LINUX_KERNEL_H
#define _LINUX_KERNEL_H


#include <stdarg.h>
#include <linux/linkage.h>
#include <linux/stddef.h>
#include <linux/types.h>
#include <linux/compiler.h>
#include <linux/bitops.h>
11
#include <linux/log2.h>
12
#include <linux/typecheck.h>
13
#include <linux/printk.h>
14
#include <linux/dynamic_debug.h>
Linus Torvalds's avatar
Linus Torvalds committed
15
#include <asm/byteorder.h>
16
#include <uapi/linux/kernel.h>
Linus Torvalds's avatar
Linus Torvalds committed
17

18 19 20
#define USHRT_MAX	((u16)(~0U))
#define SHRT_MAX	((s16)(USHRT_MAX>>1))
#define SHRT_MIN	((s16)(-SHRT_MAX - 1))
Linus Torvalds's avatar
Linus Torvalds committed
21 22 23 24 25 26
#define INT_MAX		((int)(~0U>>1))
#define INT_MIN		(-INT_MAX - 1)
#define UINT_MAX	(~0U)
#define LONG_MAX	((long)(~0UL>>1))
#define LONG_MIN	(-LONG_MAX - 1)
#define ULONG_MAX	(~0UL)
27 28 29
#define LLONG_MAX	((long long)(~0ULL>>1))
#define LLONG_MIN	(-LLONG_MAX - 1)
#define ULLONG_MAX	(~0ULL)
Xi Wang's avatar
Xi Wang committed
30
#define SIZE_MAX	(~(size_t)0)
Linus Torvalds's avatar
Linus Torvalds committed
31

32 33 34 35 36 37 38 39 40 41 42 43 44
#define U8_MAX		((u8)~0U)
#define S8_MAX		((s8)(U8_MAX>>1))
#define S8_MIN		((s8)(-S8_MAX - 1))
#define U16_MAX		((u16)~0U)
#define S16_MAX		((s16)(U16_MAX>>1))
#define S16_MIN		((s16)(-S16_MAX - 1))
#define U32_MAX		((u32)~0U)
#define S32_MAX		((s32)(U32_MAX>>1))
#define S32_MIN		((s32)(-S32_MAX - 1))
#define U64_MAX		((u64)~0ULL)
#define S64_MAX		((s64)(U64_MAX>>1))
#define S64_MIN		((s64)(-S64_MAX - 1))

Linus Torvalds's avatar
Linus Torvalds committed
45 46
#define STACK_MAGIC	0xdeadbeef

47 48
#define REPEAT_BYTE(x)	((~0ul / 0xff) * (x))

49
#define ALIGN(x, a)		__ALIGN_KERNEL((x), (a))
Alexey Dobriyan's avatar
Alexey Dobriyan committed
50
#define __ALIGN_MASK(x, mask)	__ALIGN_KERNEL_MASK((x), (mask))
Matthew Wilcox's avatar
Matthew Wilcox committed
51
#define PTR_ALIGN(p, a)		((typeof(p))ALIGN((unsigned long)(p), (a)))
Herbert Xu's avatar
Herbert Xu committed
52
#define IS_ALIGNED(x, a)		(((x) & ((typeof(x))(a) - 1)) == 0)
Linus Torvalds's avatar
Linus Torvalds committed
53

Rusty Russell's avatar
Rusty Russell committed
54 55
#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))

Yinghai Lu's avatar
Yinghai Lu committed
56 57 58 59 60 61 62 63 64 65
/*
 * This looks more complex than it should be. But we need to
 * get the type for the ~ right in round_down (it needs to be
 * as wide as the result!), and we want to evaluate the macro
 * arguments just once each.
 */
#define __round_mask(x, y) ((__typeof__(x))((y)-1))
#define round_up(x, y) ((((x)-1) | __round_mask(x, y))+1)
#define round_down(x, y) ((x) & ~__round_mask(x, y))

66
#define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
Steven Whitehouse's avatar
Steven Whitehouse committed
67
#define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
68 69 70 71 72 73 74 75
#define DIV_ROUND_UP_ULL(ll,d) \
	({ unsigned long long _tmp = (ll)+(d)-1; do_div(_tmp, d); _tmp; })

#if BITS_PER_LONG == 32
# define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP_ULL(ll, d)
#else
# define DIV_ROUND_UP_SECTOR_T(ll,d) DIV_ROUND_UP(ll,d)
#endif
76 77

/* The `const' in roundup() prevents gcc-3.3 from calling __divdi3 */
78 79
#define roundup(x, y) (					\
{							\
80
	const typeof(y) __y = y;			\
81 82 83
	(((x) + (__y - 1)) / __y) * __y;		\
}							\
)
Eric Paris's avatar
Eric Paris committed
84 85 86 87 88 89
#define rounddown(x, y) (				\
{							\
	typeof(x) __x = (x);				\
	__x - (__x % (y));				\
}							\
)
90 91 92

/*
 * Divide positive or negative dividend by positive divisor and round
93 94
 * to closest integer. Result is undefined for negative divisors and
 * for negative dividends if the divisor variable type is unsigned.
95
 */
96 97
#define DIV_ROUND_CLOSEST(x, divisor)(			\
{							\
98 99
	typeof(x) __x = x;				\
	typeof(divisor) __d = divisor;			\
100 101
	(((typeof(x))-1) > 0 ||				\
	 ((typeof(divisor))-1) > 0 || (__x) > 0) ?	\
102 103
		(((__x) + ((__d) / 2)) / (__d)) :	\
		(((__x) - ((__d) / 2)) / (__d));	\
104 105
}							\
)
106 107 108 109 110 111 112 113 114 115 116 117
/*
 * Same as above but for u64 dividends. divisor must be a 32-bit
 * number.
 */
#define DIV_ROUND_CLOSEST_ULL(x, divisor)(		\
{							\
	typeof(divisor) __d = divisor;			\
	unsigned long long _tmp = (x) + (__d) / 2;	\
	do_div(_tmp, __d);				\
	_tmp;						\
}							\
)
Linus Torvalds's avatar
Linus Torvalds committed
118

119 120 121 122 123 124 125 126 127 128 129 130 131
/*
 * Multiplies an integer by a fraction, while avoiding unnecessary
 * overflow or loss of precision.
 */
#define mult_frac(x, numer, denom)(			\
{							\
	typeof(x) quot = (x) / (denom);			\
	typeof(x) rem  = (x) % (denom);			\
	(quot * (numer)) + ((rem * (numer)) / (denom));	\
}							\
)


132 133 134
#define _RET_IP_		(unsigned long)__builtin_return_address(0)
#define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })

135
#ifdef CONFIG_LBDAF
136 137 138 139 140 141 142 143 144 145 146 147 148
# include <asm/div64.h>
# define sector_div(a, b) do_div(a, b)
#else
# define sector_div(n, b)( \
{ \
	int _res; \
	_res = (n) % (b); \
	(n) /= (b); \
	_res; \
} \
)
#endif

Andrew Morton's avatar
Andrew Morton committed
149 150 151 152 153 154 155 156 157 158
/**
 * upper_32_bits - return bits 32-63 of a number
 * @n: the number we're accessing
 *
 * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
 * the "right shift count >= width of type" warning when that quantity is
 * 32-bits.
 */
#define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))

Joerg Roedel's avatar
Joerg Roedel committed
159 160 161 162 163 164
/**
 * lower_32_bits - return bits 0-31 of a number
 * @n: the number we're accessing
 */
#define lower_32_bits(n) ((u32)(n))

Linus Torvalds's avatar
Linus Torvalds committed
165
struct completion;
akpm@osdl.org's avatar
akpm@osdl.org committed
166 167
struct pt_regs;
struct user;
Linus Torvalds's avatar
Linus Torvalds committed
168

169 170 171 172 173 174 175
#ifdef CONFIG_PREEMPT_VOLUNTARY
extern int _cond_resched(void);
# define might_resched() _cond_resched()
#else
# define might_resched() do { } while (0)
#endif

176
#ifdef CONFIG_DEBUG_ATOMIC_SLEEP
177
  void ___might_sleep(const char *file, int line, int preempt_offset);
178
  void __might_sleep(const char *file, int line, int preempt_offset);
Linus Torvalds's avatar
Linus Torvalds committed
179 180 181 182 183 184 185
/**
 * might_sleep - annotation for functions that can sleep
 *
 * this macro will print a stack trace if it is executed in an atomic
 * context (spinlock, irq-handler, ...).
 *
 * This is a useful debugging help to be able to catch problems early and not
186
 * be bitten later when the calling function happens to sleep when it is not
Linus Torvalds's avatar
Linus Torvalds committed
187 188
 * supposed to.
 */
189
# define might_sleep() \
190
	do { __might_sleep(__FILE__, __LINE__, 0); might_resched(); } while (0)
191
# define sched_annotate_sleep()	(current->task_state_change = 0)
Linus Torvalds's avatar
Linus Torvalds committed
192
#else
193 194
  static inline void ___might_sleep(const char *file, int line,
				   int preempt_offset) { }
195 196
  static inline void __might_sleep(const char *file, int line,
				   int preempt_offset) { }
197
# define might_sleep() do { might_resched(); } while (0)
198
# define sched_annotate_sleep() do { } while (0)
Linus Torvalds's avatar
Linus Torvalds committed
199 200
#endif

201
#define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
202

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
/*
 * abs() handles unsigned and signed longs, ints, shorts and chars.  For all
 * input types abs() returns a signed long.
 * abs() should not be used for 64-bit types (s64, u64, long long) - use abs64()
 * for those.
 */
#define abs(x) ({						\
		long ret;					\
		if (sizeof(x) == sizeof(long)) {		\
			long __x = (x);				\
			ret = (__x < 0) ? -__x : __x;		\
		} else {					\
			int __x = (x);				\
			ret = (__x < 0) ? -__x : __x;		\
		}						\
		ret;						\
Linus Torvalds's avatar
Linus Torvalds committed
219 220
	})

221 222 223 224 225
#define abs64(x) ({				\
		s64 __x = (x);			\
		(__x < 0) ? -__x : __x;		\
	})

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
/**
 * reciprocal_scale - "scale" a value into range [0, ep_ro)
 * @val: value
 * @ep_ro: right open interval endpoint
 *
 * Perform a "reciprocal multiplication" in order to "scale" a value into
 * range [0, ep_ro), where the upper interval endpoint is right-open.
 * This is useful, e.g. for accessing a index of an array containing
 * ep_ro elements, for example. Think of it as sort of modulus, only that
 * the result isn't that of modulo. ;) Note that if initial input is a
 * small value, then result will return 0.
 *
 * Return: a result based on val in interval [0, ep_ro).
 */
static inline u32 reciprocal_scale(u32 val, u32 ep_ro)
{
	return (u32)(((u64) val * ep_ro) >> 32);
}

245 246
#if defined(CONFIG_MMU) && \
	(defined(CONFIG_PROVE_LOCKING) || defined(CONFIG_DEBUG_ATOMIC_SLEEP))
247 248
#define might_fault() __might_fault(__FILE__, __LINE__)
void __might_fault(const char *file, int line);
249
#else
250
static inline void might_fault(void) { }
251 252
#endif

253
extern struct atomic_notifier_head panic_notifier_list;
254
extern long (*panic_blink)(int state);
255
__printf(1, 2)
Joe Perches's avatar
Joe Perches committed
256
void panic(const char *fmt, ...)
257
	__noreturn __cold;
258 259
extern void oops_enter(void);
extern void oops_exit(void);
260
void print_oops_end_marker(void);
261
extern int oops_may_print(void);
262
void do_exit(long error_code)
263
	__noreturn;
264
void complete_and_exit(struct completion *, long)
265
	__noreturn;
266 267 268 269 270 271 272

/* Internal, do not use. */
int __must_check _kstrtoul(const char *s, unsigned int base, unsigned long *res);
int __must_check _kstrtol(const char *s, unsigned int base, long *res);

int __must_check kstrtoull(const char *s, unsigned int base, unsigned long long *res);
int __must_check kstrtoll(const char *s, unsigned int base, long long *res);
Eldad Zack's avatar
Eldad Zack committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289

/**
 * kstrtoul - convert a string to an unsigned long
 * @s: The start of the string. The string must be null-terminated, and may also
 *  include a single newline before its terminating null. The first character
 *  may also be a plus sign, but not a minus sign.
 * @base: The number base to use. The maximum supported base is 16. If base is
 *  given as 0, then the base of the string is automatically detected with the
 *  conventional semantics - If it begins with 0x the number will be parsed as a
 *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
 *  parsed as an octal number. Otherwise it will be parsed as a decimal.
 * @res: Where to write the result of the conversion on success.
 *
 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
 * Used as a replacement for the obsolete simple_strtoull. Return code must
 * be checked.
*/
290 291 292 293 294 295 296 297 298 299 300 301 302
static inline int __must_check kstrtoul(const char *s, unsigned int base, unsigned long *res)
{
	/*
	 * We want to shortcut function call, but
	 * __builtin_types_compatible_p(unsigned long, unsigned long long) = 0.
	 */
	if (sizeof(unsigned long) == sizeof(unsigned long long) &&
	    __alignof__(unsigned long) == __alignof__(unsigned long long))
		return kstrtoull(s, base, (unsigned long long *)res);
	else
		return _kstrtoul(s, base, res);
}

Eldad Zack's avatar
Eldad Zack committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
/**
 * kstrtol - convert a string to a long
 * @s: The start of the string. The string must be null-terminated, and may also
 *  include a single newline before its terminating null. The first character
 *  may also be a plus sign or a minus sign.
 * @base: The number base to use. The maximum supported base is 16. If base is
 *  given as 0, then the base of the string is automatically detected with the
 *  conventional semantics - If it begins with 0x the number will be parsed as a
 *  hexadecimal (case insensitive), if it otherwise begins with 0, it will be
 *  parsed as an octal number. Otherwise it will be parsed as a decimal.
 * @res: Where to write the result of the conversion on success.
 *
 * Returns 0 on success, -ERANGE on overflow and -EINVAL on parsing error.
 * Used as a replacement for the obsolete simple_strtoull. Return code must
 * be checked.
 */
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
static inline int __must_check kstrtol(const char *s, unsigned int base, long *res)
{
	/*
	 * We want to shortcut function call, but
	 * __builtin_types_compatible_p(long, long long) = 0.
	 */
	if (sizeof(long) == sizeof(long long) &&
	    __alignof__(long) == __alignof__(long long))
		return kstrtoll(s, base, (long long *)res);
	else
		return _kstrtol(s, base, res);
}

int __must_check kstrtouint(const char *s, unsigned int base, unsigned int *res);
int __must_check kstrtoint(const char *s, unsigned int base, int *res);

static inline int __must_check kstrtou64(const char *s, unsigned int base, u64 *res)
{
	return kstrtoull(s, base, res);
}

static inline int __must_check kstrtos64(const char *s, unsigned int base, s64 *res)
{
	return kstrtoll(s, base, res);
}

static inline int __must_check kstrtou32(const char *s, unsigned int base, u32 *res)
{
	return kstrtouint(s, base, res);
}

static inline int __must_check kstrtos32(const char *s, unsigned int base, s32 *res)
{
	return kstrtoint(s, base, res);
}

int __must_check kstrtou16(const char *s, unsigned int base, u16 *res);
int __must_check kstrtos16(const char *s, unsigned int base, s16 *res);
int __must_check kstrtou8(const char *s, unsigned int base, u8 *res);
int __must_check kstrtos8(const char *s, unsigned int base, s8 *res);

Alexey Dobriyan's avatar
Alexey Dobriyan committed
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
int __must_check kstrtoull_from_user(const char __user *s, size_t count, unsigned int base, unsigned long long *res);
int __must_check kstrtoll_from_user(const char __user *s, size_t count, unsigned int base, long long *res);
int __must_check kstrtoul_from_user(const char __user *s, size_t count, unsigned int base, unsigned long *res);
int __must_check kstrtol_from_user(const char __user *s, size_t count, unsigned int base, long *res);
int __must_check kstrtouint_from_user(const char __user *s, size_t count, unsigned int base, unsigned int *res);
int __must_check kstrtoint_from_user(const char __user *s, size_t count, unsigned int base, int *res);
int __must_check kstrtou16_from_user(const char __user *s, size_t count, unsigned int base, u16 *res);
int __must_check kstrtos16_from_user(const char __user *s, size_t count, unsigned int base, s16 *res);
int __must_check kstrtou8_from_user(const char __user *s, size_t count, unsigned int base, u8 *res);
int __must_check kstrtos8_from_user(const char __user *s, size_t count, unsigned int base, s8 *res);

static inline int __must_check kstrtou64_from_user(const char __user *s, size_t count, unsigned int base, u64 *res)
{
	return kstrtoull_from_user(s, count, base, res);
}

static inline int __must_check kstrtos64_from_user(const char __user *s, size_t count, unsigned int base, s64 *res)
{
	return kstrtoll_from_user(s, count, base, res);
}

static inline int __must_check kstrtou32_from_user(const char __user *s, size_t count, unsigned int base, u32 *res)
{
	return kstrtouint_from_user(s, count, base, res);
}

static inline int __must_check kstrtos32_from_user(const char __user *s, size_t count, unsigned int base, s32 *res)
{
	return kstrtoint_from_user(s, count, base, res);
}

391 392
/* Obsolete, do not use.  Use kstrto<foo> instead */

Linus Torvalds's avatar
Linus Torvalds committed
393 394 395 396
extern unsigned long simple_strtoul(const char *,char **,unsigned int);
extern long simple_strtol(const char *,char **,unsigned int);
extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
extern long long simple_strtoll(const char *,char **,unsigned int);
397

398 399
extern int num_to_str(char *buf, int size, unsigned long long num);

400 401
/* lib/printf utilities */

402 403 404 405 406 407 408 409 410 411 412 413
extern __printf(2, 3) int sprintf(char *buf, const char * fmt, ...);
extern __printf(2, 0) int vsprintf(char *buf, const char *, va_list);
extern __printf(3, 4)
int snprintf(char *buf, size_t size, const char *fmt, ...);
extern __printf(3, 0)
int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
extern __printf(3, 4)
int scnprintf(char *buf, size_t size, const char *fmt, ...);
extern __printf(3, 0)
int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
extern __printf(2, 3)
char *kasprintf(gfp_t gfp, const char *fmt, ...);
414 415
extern __printf(2, 0)
char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
416 417
extern __printf(2, 0)
const char *kvasprintf_const(gfp_t gfp, const char *fmt, va_list args);
Linus Torvalds's avatar
Linus Torvalds committed
418

419 420 421 422
extern __scanf(2, 3)
int sscanf(const char *, const char *, ...);
extern __scanf(2, 0)
int vsscanf(const char *, const char *, va_list);
Linus Torvalds's avatar
Linus Torvalds committed
423 424 425

extern int get_option(char **str, int *pint);
extern char *get_options(const char *str, int nints, int *ints);
426
extern unsigned long long memparse(const char *ptr, char **retptr);
427
extern bool parse_option_str(const char *str, const char *option);
Linus Torvalds's avatar
Linus Torvalds committed
428

429
extern int core_kernel_text(unsigned long addr);
430
extern int core_kernel_data(unsigned long addr);
Linus Torvalds's avatar
Linus Torvalds committed
431 432
extern int __kernel_text_address(unsigned long addr);
extern int kernel_text_address(unsigned long addr);
433 434
extern int func_ptr_is_kernel_text(void *ptr);

Linus Torvalds's avatar
Linus Torvalds committed
435 436 437 438
unsigned long int_sqrt(unsigned long);

extern void bust_spinlocks(int yes);
extern int oops_in_progress;		/* If set, an oops, panic(), BUG() or die() is in progress */
439
extern int panic_timeout;
Linus Torvalds's avatar
Linus Torvalds committed
440
extern int panic_on_oops;
441
extern int panic_on_unrecovered_nmi;
442
extern int panic_on_io_nmi;
Prarit Bhargava's avatar
Prarit Bhargava committed
443
extern int panic_on_warn;
444
extern int sysctl_panic_on_stackoverflow;
445 446 447

extern bool crash_kexec_post_notifiers;

448 449 450 451 452 453 454 455 456
/*
 * Only to be used by arch init code. If the user over-wrote the default
 * CONFIG_PANIC_TIMEOUT, honor it.
 */
static inline void set_arch_panic_timeout(int timeout, int arch_default_timeout)
{
	if (panic_timeout == arch_default_timeout)
		panic_timeout = timeout;
}
Linus Torvalds's avatar
Linus Torvalds committed
457
extern const char *print_tainted(void);
458 459 460 461 462
enum lockdep_ok {
	LOCKDEP_STILL_OK,
	LOCKDEP_NOW_UNRELIABLE
};
extern void add_taint(unsigned flag, enum lockdep_ok);
Andi Kleen's avatar
Andi Kleen committed
463 464
extern int test_taint(unsigned flag);
extern unsigned long get_taint(void);
465
extern int root_mountflags;
Linus Torvalds's avatar
Linus Torvalds committed
466

467 468
extern bool early_boot_irqs_disabled;

Linus Torvalds's avatar
Linus Torvalds committed
469 470 471 472 473 474 475 476 477
/* Values used for system_state */
extern enum system_states {
	SYSTEM_BOOTING,
	SYSTEM_RUNNING,
	SYSTEM_HALT,
	SYSTEM_POWER_OFF,
	SYSTEM_RESTART,
} system_state;

Andi Kleen's avatar
Andi Kleen committed
478 479
#define TAINT_PROPRIETARY_MODULE	0
#define TAINT_FORCED_MODULE		1
480
#define TAINT_CPU_OUT_OF_SPEC		2
Andi Kleen's avatar
Andi Kleen committed
481 482 483 484 485 486 487
#define TAINT_FORCED_RMMOD		3
#define TAINT_MACHINE_CHECK		4
#define TAINT_BAD_PAGE			5
#define TAINT_USER			6
#define TAINT_DIE			7
#define TAINT_OVERRIDDEN_ACPI_TABLE	8
#define TAINT_WARN			9
488
#define TAINT_CRAP			10
489
#define TAINT_FIRMWARE_WORKAROUND	11
490
#define TAINT_OOT_MODULE		12
491
#define TAINT_UNSIGNED_MODULE		13
Josh Hunt's avatar
Josh Hunt committed
492
#define TAINT_SOFTLOCKUP		14
493
#define TAINT_LIVEPATCH			15
Linus Torvalds's avatar
Linus Torvalds committed
494

495 496 497 498
extern const char hex_asc[];
#define hex_asc_lo(x)	hex_asc[((x) & 0x0f)]
#define hex_asc_hi(x)	hex_asc[((x) & 0xf0) >> 4]

499
static inline char *hex_byte_pack(char *buf, u8 byte)
500 501 502 503 504
{
	*buf++ = hex_asc_hi(byte);
	*buf++ = hex_asc_lo(byte);
	return buf;
}
Randy Dunlap's avatar
Randy Dunlap committed
505

506 507 508 509 510 511 512 513 514 515 516
extern const char hex_asc_upper[];
#define hex_asc_upper_lo(x)	hex_asc_upper[((x) & 0x0f)]
#define hex_asc_upper_hi(x)	hex_asc_upper[((x) & 0xf0) >> 4]

static inline char *hex_byte_pack_upper(char *buf, u8 byte)
{
	*buf++ = hex_asc_upper_hi(byte);
	*buf++ = hex_asc_upper_lo(byte);
	return buf;
}

517
extern int hex_to_bin(char ch);
518
extern int __must_check hex2bin(u8 *dst, const char *src, size_t count);
519
extern char *bin2hex(char *dst, const void *src, size_t count);
520

521
bool mac_pton(const char *s, u8 *mac);
522

523 524
/*
 * General tracing related utility functions - trace_printk(),
525 526 527 528
 * tracing_on/tracing_off and tracing_start()/tracing_stop
 *
 * Use tracing_on/tracing_off when you want to quickly turn on or off
 * tracing. It simply enables or disables the recording of the trace events.
529
 * This also corresponds to the user space /sys/kernel/debug/tracing/tracing_on
530 531 532 533 534 535 536 537 538 539 540
 * file, which gives a means for the kernel and userspace to interact.
 * Place a tracing_off() in the kernel where you want tracing to end.
 * From user space, examine the trace, and then echo 1 > tracing_on
 * to continue tracing.
 *
 * tracing_stop/tracing_start has slightly more overhead. It is used
 * by things like suspend to ram where disabling the recording of the
 * trace is not enough, but tracing must actually stop because things
 * like calling smp_processor_id() may crash the system.
 *
 * Most likely, you want to use tracing_on/tracing_off.
541
 */
542 543 544 545 546 547 548

enum ftrace_dump_mode {
	DUMP_NONE,
	DUMP_ALL,
	DUMP_ORIG,
};

549
#ifdef CONFIG_TRACING
550 551 552
void tracing_on(void);
void tracing_off(void);
int tracing_is_on(void);
553 554
void tracing_snapshot(void);
void tracing_snapshot_alloc(void);
555

556 557 558
extern void tracing_start(void);
extern void tracing_stop(void);

559 560
static inline __printf(1, 2)
void ____trace_printk_check_format(const char *fmt, ...)
561 562 563 564 565 566 567 568
{
}
#define __trace_printk_check_format(fmt, args...)			\
do {									\
	if (0)								\
		____trace_printk_check_format(fmt, ##args);		\
} while (0)

569 570 571 572 573 574 575 576 577 578 579 580 581 582
/**
 * trace_printk - printf formatting in the ftrace buffer
 * @fmt: the printf format for printing
 *
 * Note: __trace_printk is an internal function for trace_printk and
 *       the @ip is passed in via the trace_printk macro.
 *
 * This function allows a kernel developer to debug fast path sections
 * that printk is not appropriate for. By scattering in various
 * printk like tracing in the code, a developer can quickly see
 * where problems are occurring.
 *
 * This is intended as a debugging tool for the developer only.
 * Please refrain from leaving trace_printks scattered around in
583 584
 * your code. (Extra memory is used for special buffers that are
 * allocated when trace_printk() is used)
585 586 587 588 589 590 591 592 593 594 595 596
 *
 * A little optization trick is done here. If there's only one
 * argument, there's no need to scan the string for printf formats.
 * The trace_puts() will suffice. But how can we take advantage of
 * using trace_puts() when trace_printk() has only one argument?
 * By stringifying the args and checking the size we can tell
 * whether or not there are args. __stringify((__VA_ARGS__)) will
 * turn into "()\0" with a size of 3 when there are no args, anything
 * else will be bigger. All we need to do is define a string to this,
 * and then take its size and compare to 3. If it's bigger, use
 * do_trace_printk() otherwise, optimize it to trace_puts(). Then just
 * let gcc optimize the rest.
597
 */
598

599 600 601 602 603 604 605 606 607 608
#define trace_printk(fmt, ...)				\
do {							\
	char _______STR[] = __stringify((__VA_ARGS__));	\
	if (sizeof(_______STR) > 3)			\
		do_trace_printk(fmt, ##__VA_ARGS__);	\
	else						\
		trace_puts(fmt);			\
} while (0)

#define do_trace_printk(fmt, args...)					\
609
do {									\
610 611 612 613
	static const char *trace_printk_fmt				\
		__attribute__((section("__trace_printk_fmt"))) =	\
		__builtin_constant_p(fmt) ? fmt : NULL;			\
									\
614
	__trace_printk_check_format(fmt, ##args);			\
615
									\
616
	if (__builtin_constant_p(fmt))					\
617
		__trace_bprintk(_THIS_IP_, trace_printk_fmt, ##args);	\
618 619
	else								\
		__trace_printk(_THIS_IP_, fmt, ##args);			\
620 621
} while (0)

622 623
extern __printf(2, 3)
int __trace_bprintk(unsigned long ip, const char *fmt, ...);
624

625 626
extern __printf(2, 3)
int __trace_printk(unsigned long ip, const char *fmt, ...);
627

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
/**
 * trace_puts - write a string into the ftrace buffer
 * @str: the string to record
 *
 * Note: __trace_bputs is an internal function for trace_puts and
 *       the @ip is passed in via the trace_puts macro.
 *
 * This is similar to trace_printk() but is made for those really fast
 * paths that a developer wants the least amount of "Heisenbug" affects,
 * where the processing of the print format is still too much.
 *
 * This function allows a kernel developer to debug fast path sections
 * that printk is not appropriate for. By scattering in various
 * printk like tracing in the code, a developer can quickly see
 * where problems are occurring.
 *
 * This is intended as a debugging tool for the developer only.
 * Please refrain from leaving trace_puts scattered around in
 * your code. (Extra memory is used for special buffers that are
 * allocated when trace_puts() is used)
 *
 * Returns: 0 if nothing was written, positive # if string was.
 *  (1 when __trace_bputs is used, strlen(str) when __trace_puts is used)
 */

#define trace_puts(str) ({						\
	static const char *trace_printk_fmt				\
		__attribute__((section("__trace_printk_fmt"))) =	\
		__builtin_constant_p(str) ? str : NULL;			\
									\
	if (__builtin_constant_p(str))					\
		__trace_bputs(_THIS_IP_, trace_printk_fmt);		\
	else								\
		__trace_puts(_THIS_IP_, str, strlen(str));		\
})
663 664
extern int __trace_bputs(unsigned long ip, const char *str);
extern int __trace_puts(unsigned long ip, const char *str, int size);
665

666
extern void trace_dump_stack(int skip);
667

668 669 670 671 672
/*
 * The double __builtin_constant_p is because gcc will give us an error
 * if we try to allocate the static variable to fmt if it is not a
 * constant. Even with the outer if statement.
 */
673 674
#define ftrace_vprintk(fmt, vargs)					\
do {									\
675 676 677 678
	if (__builtin_constant_p(fmt)) {				\
		static const char *trace_printk_fmt			\
		  __attribute__((section("__trace_printk_fmt"))) =	\
			__builtin_constant_p(fmt) ? fmt : NULL;		\
Ingo Molnar's avatar
Ingo Molnar committed
679
									\
680 681 682
		__ftrace_vbprintk(_THIS_IP_, trace_printk_fmt, vargs);	\
	} else								\
		__ftrace_vprintk(_THIS_IP_, fmt, vargs);		\
683 684
} while (0)

685
extern __printf(2, 0) int
686 687
__ftrace_vbprintk(unsigned long ip, const char *fmt, va_list ap);

688
extern __printf(2, 0) int
689
__ftrace_vprintk(unsigned long ip, const char *fmt, va_list ap);
690

691
extern void ftrace_dump(enum ftrace_dump_mode oops_dump_mode);
692 693 694
#else
static inline void tracing_start(void) { }
static inline void tracing_stop(void) { }
695
static inline void trace_dump_stack(int skip) { }
696 697 698 699

static inline void tracing_on(void) { }
static inline void tracing_off(void) { }
static inline int tracing_is_on(void) { return 0; }
700 701
static inline void tracing_snapshot(void) { }
static inline void tracing_snapshot_alloc(void) { }
702

703 704
static inline __printf(1, 2)
int trace_printk(const char *fmt, ...)
705 706 707
{
	return 0;
}
708
static __printf(1, 0) inline int
709 710 711 712
ftrace_vprintk(const char *fmt, va_list ap)
{
	return 0;
}
713
static inline void ftrace_dump(enum ftrace_dump_mode oops_dump_mode) { }
714
#endif /* CONFIG_TRACING */
715

Linus Torvalds's avatar
Linus Torvalds committed
716
/*
717
 * min()/max()/clamp() macros that also do
Linus Torvalds's avatar
Linus Torvalds committed
718 719 720
 * strict type-checking.. See the
 * "unnecessary" pointer comparison.
 */
721 722 723 724 725 726 727 728 729 730 731 732
#define min(x, y) ({				\
	typeof(x) _min1 = (x);			\
	typeof(y) _min2 = (y);			\
	(void) (&_min1 == &_min2);		\
	_min1 < _min2 ? _min1 : _min2; })

#define max(x, y) ({				\
	typeof(x) _max1 = (x);			\
	typeof(y) _max2 = (y);			\
	(void) (&_max1 == &_max2);		\
	_max1 > _max2 ? _max1 : _max2; })

733 734
#define min3(x, y, z) min((typeof(x))min(x, y), z)
#define max3(x, y, z) max((typeof(x))max(x, y), z)
735

Martin K. Petersen's avatar
Martin K. Petersen committed
736 737 738 739 740 741 742 743 744 745
/**
 * min_not_zero - return the minimum that is _not_ zero, unless both are zero
 * @x: value1
 * @y: value2
 */
#define min_not_zero(x, y) ({			\
	typeof(x) __x = (x);			\
	typeof(y) __y = (y);			\
	__x == 0 ? __y : ((__y == 0) ? __x : min(__x, __y)); })

746 747 748
/**
 * clamp - return a value clamped to a given range with strict typechecking
 * @val: current value
749 750
 * @lo: lowest allowable value
 * @hi: highest allowable value
751
 *
752
 * This macro does strict typechecking of lo/hi to make sure they are of the
753 754
 * same type as val.  See the unnecessary pointer comparisons.
 */
755
#define clamp(val, lo, hi) min((typeof(val))max(val, lo), hi)
Linus Torvalds's avatar
Linus Torvalds committed
756 757 758 759 760

/*
 * ..and if you can't take the strict
 * types, you can specify one yourself.
 *
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
 * Or not use min/max/clamp at all, of course.
 */
#define min_t(type, x, y) ({			\
	type __min1 = (x);			\
	type __min2 = (y);			\
	__min1 < __min2 ? __min1: __min2; })

#define max_t(type, x, y) ({			\
	type __max1 = (x);			\
	type __max2 = (y);			\
	__max1 > __max2 ? __max1: __max2; })

/**
 * clamp_t - return a value clamped to a given range using a given type
 * @type: the type of variable to use
 * @val: current value
777 778
 * @lo: minimum allowable value
 * @hi: maximum allowable value
779 780 781
 *
 * This macro does no typechecking and uses temporary variables of type
 * 'type' to make all the comparisons.
Linus Torvalds's avatar
Linus Torvalds committed
782
 */
783
#define clamp_t(type, val, lo, hi) min_t(type, max_t(type, val, lo), hi)
Linus Torvalds's avatar
Linus Torvalds committed
784

785 786 787
/**
 * clamp_val - return a value clamped to a given range using val's type
 * @val: current value
788 789
 * @lo: minimum allowable value
 * @hi: maximum allowable value
790 791 792 793 794 795
 *
 * This macro does no typechecking and uses temporary variables of whatever
 * type the input argument 'val' is.  This is useful when val is an unsigned
 * type and min and max are literals that will otherwise be assigned a signed
 * integer type.
 */
796
#define clamp_val(val, lo, hi) clamp_t(typeof(val), val, lo, hi)
Linus Torvalds's avatar
Linus Torvalds committed
797

798 799 800 801

/*
 * swap - swap value of @a and @b
 */
802 803
#define swap(a, b) \
	do { typeof(a) __tmp = (a); (a) = (b); (b) = __tmp; } while (0)
804

Linus Torvalds's avatar
Linus Torvalds committed
805 806 807 808 809 810 811 812
/**
 * container_of - cast a member of a structure out to the containing structure
 * @ptr:	the pointer to the member.
 * @type:	the type of the container struct this is embedded in.
 * @member:	the name of the member within the struct.
 *
 */
#define container_of(ptr, type, member) ({			\
813 814
	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
	(type *)( (char *)__mptr - offsetof(type,member) );})
Linus Torvalds's avatar
Linus Torvalds committed
815

816 817 818 819
/* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
#ifdef CONFIG_FTRACE_MCOUNT_RECORD
# define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
#endif
820

821
/* Permissions on a sysfs file: you didn't miss the 0 prefix did you? */
822 823 824 825 826 827 828 829 830 831
#define VERIFY_OCTAL_PERMISSIONS(perms)						\
	(BUILD_BUG_ON_ZERO((perms) < 0) +					\
	 BUILD_BUG_ON_ZERO((perms) > 0777) +					\
	 /* USER_READABLE >= GROUP_READABLE >= OTHER_READABLE */		\
	 BUILD_BUG_ON_ZERO((((perms) >> 6) & 4) < (((perms) >> 3) & 4)) +	\
	 BUILD_BUG_ON_ZERO((((perms) >> 3) & 4) < ((perms) & 4)) +		\
	 /* USER_WRITABLE >= GROUP_WRITABLE */					\
	 BUILD_BUG_ON_ZERO((((perms) >> 6) & 2) < (((perms) >> 3) & 2)) +	\
	 /* OTHER_WRITABLE?  Generally considered a bad idea. */		\
	 BUILD_BUG_ON_ZERO((perms) & 2) +					\
832
	 (perms))
Linus Torvalds's avatar
Linus Torvalds committed
833
#endif