include/linux/kernel.h

   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 <linux/typecheck.h>
  18 #include <linux/ratelimit.h>
  19 #include <linux/dynamic_printk.h>
  20 #include <asm/byteorder.h>
  21 #include <asm/bug.h>
  22
  23 extern const char linux_banner[];
  24 extern const char linux_proc_banner[];
  25
  26 #define USHORT_MAX      ((u16)(~0U))
  27 #define SHORT_MAX       ((s16)(USHORT_MAX>>1))
  28 #define SHORT_MIN       (-SHORT_MAX - 1)
  29 #define INT_MAX         ((int)(~0U>>1))
  30 #define INT_MIN         (-INT_MAX - 1)
  31 #define UINT_MAX        (~0U)
  32 #define LONG_MAX        ((long)(~0UL>>1))
  33 #define LONG_MIN        (-LONG_MAX - 1)
  34 #define ULONG_MAX       (~0UL)
  35 #define LLONG_MAX       ((long long)(~0ULL>>1))
  36 #define LLONG_MIN       (-LLONG_MAX - 1)
  37 #define ULLONG_MAX      (~0ULL)
  38
  39 #define STACK_MAGIC     0xdeadbeef
  40
  41 #define ALIGN(x,a)              __ALIGN_MASK(x,(typeof(x))(a)-1)
  42 #define __ALIGN_MASK(x,mask)    (((x)+(mask))&~(mask))
  43 #define PTR_ALIGN(p, a)         ((typeof(p))ALIGN((unsigned long)(p), (a)))
  44 #define IS_ALIGNED(x, a)                (((x) & ((typeof(x))(a) - 1)) == 0)
  45
  46 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + __must_be_array(arr))
  47
  48 #define FIELD_SIZEOF(t, f) (sizeof(((t*)0)->f))
  49 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
  50 #define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
  51
  52 #define _RET_IP_                (unsigned long)__builtin_return_address(0)
  53 #define _THIS_IP_  ({ __label__ __here; __here: (unsigned long)&&__here; })
  54
  55 #ifdef CONFIG_LBD
  56 # include <asm/div64.h>
  57 # define sector_div(a, b) do_div(a, b)
  58 #else
  59 # define sector_div(n, b)( \
  60 { \
  61         int _res; \
  62         _res = (n) % (b); \
  63         (n) /= (b); \
  64         _res; \
  65 } \
  66 )
  67 #endif
  68
  69 /**
  70  * upper_32_bits - return bits 32-63 of a number
  71  * @n: the number we're accessing
  72  *
  73  * A basic shift-right of a 64- or 32-bit quantity.  Use this to suppress
  74  * the "right shift count >= width of type" warning when that quantity is
  75  * 32-bits.
  76  */
  77 #define upper_32_bits(n) ((u32)(((n) >> 16) >> 16))
  78
  79 /**
  80  * lower_32_bits - return bits 0-31 of a number
  81  * @n: the number we're accessing
  82  */
  83 #define lower_32_bits(n) ((u32)(n))
  84
  85 #define KERN_EMERG      "<0>"   /* system is unusable                   */
  86 #define KERN_ALERT      "<1>"   /* action must be taken immediately     */
  87 #define KERN_CRIT       "<2>"   /* critical conditions                  */
  88 #define KERN_ERR        "<3>"   /* error conditions                     */
  89 #define KERN_WARNING    "<4>"   /* warning conditions                   */
  90 #define KERN_NOTICE     "<5>"   /* normal but significant condition     */
  91 #define KERN_INFO       "<6>"   /* informational                        */
  92 #define KERN_DEBUG      "<7>"   /* debug-level messages                 */
  93
  94 /*
  95  * Annotation for a "continued" line of log printout (only done after a
  96  * line that had no enclosing \n). Only to be used by core/arch code
  97  * during early bootup (a continued line is not SMP-safe otherwise).
  98  */
  99 #define KERN_CONT       ""
 100
 101 extern int console_printk[];
 102
 103 #define console_loglevel (console_printk[0])
 104 #define default_message_loglevel (console_printk[1])
 105 #define minimum_console_loglevel (console_printk[2])
 106 #define default_console_loglevel (console_printk[3])
 107
 108 struct completion;
 109 struct pt_regs;
 110 struct user;
 111
 112 #ifdef CONFIG_PREEMPT_VOLUNTARY
 113 extern int _cond_resched(void);
 114 # define might_resched() _cond_resched()
 115 #else
 116 # define might_resched() do { } while (0)
 117 #endif
 118
 119 /**
 120  * might_sleep - annotation for functions that can sleep
 121  *
 122  * this macro will print a stack trace if it is executed in an atomic
 123  * context (spinlock, irq-handler, ...).
 124  *
 125  * This is a useful debugging help to be able to catch problems early and not
 126  * be bitten later when the calling function happens to sleep when it is not
 127  * supposed to.
 128  */
 129 #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
 130   void __might_sleep(char *file, int line);
 131 # define might_sleep() \
 132         do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)
 133 #else
 134 # define might_sleep() do { might_resched(); } while (0)
 135 #endif
 136
 137 #define might_sleep_if(cond) do { if (cond) might_sleep(); } while (0)
 138
 139 #define abs(x) ({                               \
 140                 int __x = (x);                  \
 141                 (__x < 0) ? -__x : __x;         \
 142         })
 143
 144 #ifdef CONFIG_PROVE_LOCKING
 145 void might_fault(void);
 146 #else
 147 static inline void might_fault(void)
 148 {
 149         might_sleep();
 150 }
 151 #endif
 152
 153 extern struct atomic_notifier_head panic_notifier_list;
 154 extern long (*panic_blink)(long time);
 155 NORET_TYPE void panic(const char * fmt, ...)
 156         __attribute__ ((NORET_AND format (printf, 1, 2))) __cold;
 157 extern void oops_enter(void);
 158 extern void oops_exit(void);
 159 extern int oops_may_print(void);
 160 NORET_TYPE void do_exit(long error_code)
 161         ATTRIB_NORET;
 162 NORET_TYPE void complete_and_exit(struct completion *, long)
 163         ATTRIB_NORET;
 164 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
 165 extern long simple_strtol(const char *,char **,unsigned int);
 166 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
 167 extern long long simple_strtoll(const char *,char **,unsigned int);
 168 extern int strict_strtoul(const char *, unsigned int, unsigned long *);
 169 extern int strict_strtol(const char *, unsigned int, long *);
 170 extern int strict_strtoull(const char *, unsigned int, unsigned long long *);
 171 extern int strict_strtoll(const char *, unsigned int, long long *);
 172 extern int sprintf(char * buf, const char * fmt, ...)
 173         __attribute__ ((format (printf, 2, 3)));
 174 extern int vsprintf(char *buf, const char *, va_list)
 175         __attribute__ ((format (printf, 2, 0)));
 176 extern int snprintf(char * buf, size_t size, const char * fmt, ...)
 177         __attribute__ ((format (printf, 3, 4)));
 178 extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
 179         __attribute__ ((format (printf, 3, 0)));
 180 extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
 181         __attribute__ ((format (printf, 3, 4)));
 182 extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
 183         __attribute__ ((format (printf, 3, 0)));
 184 extern char *kasprintf(gfp_t gfp, const char *fmt, ...)
 185         __attribute__ ((format (printf, 2, 3)));
 186 extern char *kvasprintf(gfp_t gfp, const char *fmt, va_list args);
 187
 188 extern int sscanf(const char *, const char *, ...)
 189         __attribute__ ((format (scanf, 2, 3)));
 190 extern int vsscanf(const char *, const char *, va_list)
 191         __attribute__ ((format (scanf, 2, 0)));
 192
 193 extern int get_option(char **str, int *pint);
 194 extern char *get_options(const char *str, int nints, int *ints);
 195 extern unsigned long long memparse(const char *ptr, char **retptr);
 196
 197 extern int core_kernel_text(unsigned long addr);
 198 extern int __kernel_text_address(unsigned long addr);
 199 extern int kernel_text_address(unsigned long addr);
 200 struct pid;
 201 extern struct pid *session_of_pgrp(struct pid *pgrp);
 202
 203 /*
 204  * FW_BUG
 205  * Add this to a message where you are sure the firmware is buggy or behaves
 206  * really stupid or out of spec. Be aware that the responsible BIOS developer
 207  * should be able to fix this issue or at least get a concrete idea of the
 208  * problem by reading your message without the need of looking at the kernel
 209  * code.
 210  *
 211  * Use it for definite and high priority BIOS bugs.
 212  *
 213  * FW_WARN
 214  * Use it for not that clear (e.g. could the kernel messed up things already?)
 215  * and medium priority BIOS bugs.
 216  *
 217  * FW_INFO
 218  * Use this one if you want to tell the user or vendor about something
 219  * suspicious, but generally harmless related to the firmware.
 220  *
 221  * Use it for information or very low priority BIOS bugs.
 222  */
 223 #define FW_BUG          "[Firmware Bug]: "
 224 #define FW_WARN         "[Firmware Warn]: "
 225 #define FW_INFO         "[Firmware Info]: "
 226
 227 #ifdef CONFIG_PRINTK
 228 asmlinkage int vprintk(const char *fmt, va_list args)
 229         __attribute__ ((format (printf, 1, 0)));
 230 asmlinkage int printk(const char * fmt, ...)
 231         __attribute__ ((format (printf, 1, 2))) __cold;
 232
 233 extern struct ratelimit_state printk_ratelimit_state;
 234 extern int printk_ratelimit(void);
 235 extern bool printk_timed_ratelimit(unsigned long *caller_jiffies,
 236                                    unsigned int interval_msec);
 237 #else
 238 static inline int vprintk(const char *s, va_list args)
 239         __attribute__ ((format (printf, 1, 0)));
 240 static inline int vprintk(const char *s, va_list args) { return 0; }
 241 static inline int printk(const char *s, ...)
 242         __attribute__ ((format (printf, 1, 2)));
 243 static inline int __cold printk(const char *s, ...) { return 0; }
 244 static inline int printk_ratelimit(void) { return 0; }
 245 static inline bool printk_timed_ratelimit(unsigned long *caller_jiffies, \
 246                                           unsigned int interval_msec)   \
 247                 { return false; }
 248 #endif
 249
 250 extern int printk_needs_cpu(int cpu);
 251 extern void printk_tick(void);
 252
 253 extern void asmlinkage __attribute__((format(printf, 1, 2)))
 254         early_printk(const char *fmt, ...);
 255
 256 unsigned long int_sqrt(unsigned long);
 257
 258 static inline void console_silent(void)
 259 {
 260         console_loglevel = 0;
 261 }
 262
 263 static inline void console_verbose(void)
 264 {
 265         if (console_loglevel)
 266                 console_loglevel = 15;
 267 }
 268
 269 extern void bust_spinlocks(int yes);
 270 extern void wake_up_klogd(void);
 271 extern int oops_in_progress;            /* If set, an oops, panic(), BUG() or die() is in progress */
 272 extern int panic_timeout;
 273 extern int panic_on_oops;
 274 extern int panic_on_unrecovered_nmi;
 275 extern const char *print_tainted(void);
 276 extern void add_taint(unsigned flag);
 277 extern int test_taint(unsigned flag);
 278 extern unsigned long get_taint(void);
 279 extern int root_mountflags;
 280
 281 /* Values used for system_state */
 282 extern enum system_states {
 283         SYSTEM_BOOTING,
 284         SYSTEM_RUNNING,
 285         SYSTEM_HALT,
 286         SYSTEM_POWER_OFF,
 287         SYSTEM_RESTART,
 288         SYSTEM_SUSPEND_DISK,
 289 } system_state;
 290
 291 #define TAINT_PROPRIETARY_MODULE        0
 292 #define TAINT_FORCED_MODULE             1
 293 #define TAINT_UNSAFE_SMP                2
 294 #define TAINT_FORCED_RMMOD              3
 295 #define TAINT_MACHINE_CHECK             4
 296 #define TAINT_BAD_PAGE                  5
 297 #define TAINT_USER                      6
 298 #define TAINT_DIE                       7
 299 #define TAINT_OVERRIDDEN_ACPI_TABLE     8
 300 #define TAINT_WARN                      9
 301 #define TAINT_CRAP                      10
 302
 303 extern void dump_stack(void) __cold;
 304
 305 enum {
 306         DUMP_PREFIX_NONE,
 307         DUMP_PREFIX_ADDRESS,
 308         DUMP_PREFIX_OFFSET
 309 };
 310 extern void hex_dump_to_buffer(const void *buf, size_t len,
 311                                 int rowsize, int groupsize,
 312                                 char *linebuf, size_t linebuflen, bool ascii);
 313 extern void print_hex_dump(const char *level, const char *prefix_str,
 314                                 int prefix_type, int rowsize, int groupsize,
 315                                 const void *buf, size_t len, bool ascii);
 316 extern void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
 317                         const void *buf, size_t len);
 318
 319 extern const char hex_asc[];
 320 #define hex_asc_lo(x)   hex_asc[((x) & 0x0f)]
 321 #define hex_asc_hi(x)   hex_asc[((x) & 0xf0) >> 4]
 322
 323 static inline char *pack_hex_byte(char *buf, u8 byte)
 324 {
 325         *buf++ = hex_asc_hi(byte);
 326         *buf++ = hex_asc_lo(byte);
 327         return buf;
 328 }
 329
 330 #define pr_emerg(fmt, arg...) \
 331         printk(KERN_EMERG fmt, ##arg)
 332 #define pr_alert(fmt, arg...) \
 333         printk(KERN_ALERT fmt, ##arg)
 334 #define pr_crit(fmt, arg...) \
 335         printk(KERN_CRIT fmt, ##arg)
 336 #define pr_err(fmt, arg...) \
 337         printk(KERN_ERR fmt, ##arg)
 338 #define pr_warning(fmt, arg...) \
 339         printk(KERN_WARNING fmt, ##arg)
 340 #define pr_notice(fmt, arg...) \
 341         printk(KERN_NOTICE fmt, ##arg)
 342 #define pr_info(fmt, arg...) \
 343         printk(KERN_INFO fmt, ##arg)
 344
 345 /* If you are writing a driver, please use dev_dbg instead */
 346 #if defined(CONFIG_DYNAMIC_PRINTK_DEBUG)
 347 #define pr_debug(fmt, ...) do { \
 348         dynamic_pr_debug(fmt, ##__VA_ARGS__); \
 349         } while (0)
 350 #elif defined(DEBUG)
 351 #define pr_debug(fmt, arg...) \
 352         printk(KERN_DEBUG fmt, ##arg)
 353 #else
 354 #define pr_debug(fmt, arg...) \
 355         ({ if (0) printk(KERN_DEBUG fmt, ##arg); 0; })
 356 #endif
 357
 358 /*
 359  *      Display an IP address in readable format.
 360  */
 361
 362 #define NIPQUAD(addr) \
 363         ((unsigned char *)&addr)[0], \
 364         ((unsigned char *)&addr)[1], \
 365         ((unsigned char *)&addr)[2], \
 366         ((unsigned char *)&addr)[3]
 367 #define NIPQUAD_FMT "%u.%u.%u.%u"
 368
 369 #define NIP6(addr) \
 370         ntohs((addr).s6_addr16[0]), \
 371         ntohs((addr).s6_addr16[1]), \
 372         ntohs((addr).s6_addr16[2]), \
 373         ntohs((addr).s6_addr16[3]), \
 374         ntohs((addr).s6_addr16[4]), \
 375         ntohs((addr).s6_addr16[5]), \
 376         ntohs((addr).s6_addr16[6]), \
 377         ntohs((addr).s6_addr16[7])
 378 #define NIP6_FMT "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x"
 379 #define NIP6_SEQFMT "%04x%04x%04x%04x%04x%04x%04x%04x"
 380
 381 #if defined(__LITTLE_ENDIAN)
 382 #define HIPQUAD(addr) \
 383         ((unsigned char *)&addr)[3], \
 384         ((unsigned char *)&addr)[2], \
 385         ((unsigned char *)&addr)[1], \
 386         ((unsigned char *)&addr)[0]
 387 #elif defined(__BIG_ENDIAN)
 388 #define HIPQUAD NIPQUAD
 389 #else
 390 #error "Please fix asm/byteorder.h"
 391 #endif /* __LITTLE_ENDIAN */
 392
 393 /*
 394  * min()/max()/clamp() macros that also do
 395  * strict type-checking.. See the
 396  * "unnecessary" pointer comparison.
 397  */
 398 #define min(x, y) ({                            \
 399         typeof(x) _min1 = (x);                  \
 400         typeof(y) _min2 = (y);                  \
 401         (void) (&_min1 == &_min2);              \
 402         _min1 < _min2 ? _min1 : _min2; })
 403
 404 #define max(x, y) ({                            \
 405         typeof(x) _max1 = (x);                  \
 406         typeof(y) _max2 = (y);                  \
 407         (void) (&_max1 == &_max2);              \
 408         _max1 > _max2 ? _max1 : _max2; })
 409
 410 /**
 411  * clamp - return a value clamped to a given range with strict typechecking
 412  * @val: current value
 413  * @min: minimum allowable value
 414  * @max: maximum allowable value
 415  *
 416  * This macro does strict typechecking of min/max to make sure they are of the
 417  * same type as val.  See the unnecessary pointer comparisons.
 418  */
 419 #define clamp(val, min, max) ({                 \
 420         typeof(val) __val = (val);              \
 421         typeof(min) __min = (min);              \
 422         typeof(max) __max = (max);              \
 423         (void) (&__val == &__min);              \
 424         (void) (&__val == &__max);              \
 425         __val = __val < __min ? __min: __val;   \
 426         __val > __max ? __max: __val; })
 427
 428 /*
 429  * ..and if you can't take the strict
 430  * types, you can specify one yourself.
 431  *
 432  * Or not use min/max/clamp at all, of course.
 433  */
 434 #define min_t(type, x, y) ({                    \
 435         type __min1 = (x);                      \
 436         type __min2 = (y);                      \
 437         __min1 < __min2 ? __min1: __min2; })
 438
 439 #define max_t(type, x, y) ({                    \
 440         type __max1 = (x);                      \
 441         type __max2 = (y);                      \
 442         __max1 > __max2 ? __max1: __max2; })
 443
 444 /**
 445  * clamp_t - return a value clamped to a given range using a given type
 446  * @type: the type of variable to use
 447  * @val: current value
 448  * @min: minimum allowable value
 449  * @max: maximum allowable value
 450  *
 451  * This macro does no typechecking and uses temporary variables of type
 452  * 'type' to make all the comparisons.
 453  */
 454 #define clamp_t(type, val, min, max) ({         \
 455         type __val = (val);                     \
 456         type __min = (min);                     \
 457         type __max = (max);                     \
 458         __val = __val < __min ? __min: __val;   \
 459         __val > __max ? __max: __val; })
 460
 461 /**
 462  * clamp_val - return a value clamped to a given range using val's type
 463  * @val: current value
 464  * @min: minimum allowable value
 465  * @max: maximum allowable value
 466  *
 467  * This macro does no typechecking and uses temporary variables of whatever
 468  * type the input argument 'val' is.  This is useful when val is an unsigned
 469  * type and min and max are literals that will otherwise be assigned a signed
 470  * integer type.
 471  */
 472 #define clamp_val(val, min, max) ({             \
 473         typeof(val) __val = (val);              \
 474         typeof(val) __min = (min);              \
 475         typeof(val) __max = (max);              \
 476         __val = __val < __min ? __min: __val;   \
 477         __val > __max ? __max: __val; })
 478
 479 /**
 480  * container_of - cast a member of a structure out to the containing structure
 481  * @ptr:        the pointer to the member.
 482  * @type:       the type of the container struct this is embedded in.
 483  * @member:     the name of the member within the struct.
 484  *
 485  */
 486 #define container_of(ptr, type, member) ({                      \
 487         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 488         (type *)( (char *)__mptr - offsetof(type,member) );})
 489
 490 struct sysinfo;
 491 extern int do_sysinfo(struct sysinfo *info);
 492
 493 #endif /* __KERNEL__ */
 494
 495 #define SI_LOAD_SHIFT   16
 496 struct sysinfo {
 497         long uptime;                    /* Seconds since boot */
 498         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 499         unsigned long totalram;         /* Total usable main memory size */
 500         unsigned long freeram;          /* Available memory size */
 501         unsigned long sharedram;        /* Amount of shared memory */
 502         unsigned long bufferram;        /* Memory used by buffers */
 503         unsigned long totalswap;        /* Total swap space size */
 504         unsigned long freeswap;         /* swap space still available */
 505         unsigned short procs;           /* Number of current processes */
 506         unsigned short pad;             /* explicit padding for m68k */
 507         unsigned long totalhigh;        /* Total high memory size */
 508         unsigned long freehigh;         /* Available high memory size */
 509         unsigned int mem_unit;          /* Memory unit size in bytes */
 510         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 511 };
 512
 513 /* Force a compilation error if condition is true */
 514 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
 515
 516 /* Force a compilation error if condition is true, but also produce a
 517    result (of value 0 and type size_t), so the expression can be used
 518    e.g. in a structure initializer (or where-ever else comma expressions
 519    aren't permitted). */
 520 #define BUILD_BUG_ON_ZERO(e) (sizeof(char[1 - 2 * !!(e)]) - 1)
 521
 522 /* Trap pasters of __FUNCTION__ at compile-time */
 523 #define __FUNCTION__ (__func__)
 524
 525 /* This helps us to avoid #ifdef CONFIG_NUMA */
 526 #ifdef CONFIG_NUMA
 527 #define NUMA_BUILD 1
 528 #else
 529 #define NUMA_BUILD 0
 530 #endif
 531
 532 /* Rebuild everything on CONFIG_FTRACE_MCOUNT_RECORD */
 533 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
 534 # define REBUILD_DUE_TO_FTRACE_MCOUNT_RECORD
 535 #endif
 536
 537 #endif