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