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