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 <asm/byteorder.h>
  17 #include <asm/bug.h>
  18
  19 extern const char linux_banner[];
  20
  21 #define INT_MAX         ((int)(~0U>>1))
  22 #define INT_MIN         (-INT_MAX - 1)
  23 #define UINT_MAX        (~0U)
  24 #define LONG_MAX        ((long)(~0UL>>1))
  25 #define LONG_MIN        (-LONG_MAX - 1)
  26 #define ULONG_MAX       (~0UL)
  27
  28 #define STACK_MAGIC     0xdeadbeef
  29
  30 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  31 #define ALIGN(x,a) (((x)+(a)-1)&~((a)-1))
  32
  33 #define KERN_EMERG      "<0>"   /* system is unusable                   */
  34 #define KERN_ALERT      "<1>"   /* action must be taken immediately     */
  35 #define KERN_CRIT       "<2>"   /* critical conditions                  */
  36 #define KERN_ERR        "<3>"   /* error conditions                     */
  37 #define KERN_WARNING    "<4>"   /* warning conditions                   */
  38 #define KERN_NOTICE     "<5>"   /* normal but significant condition     */
  39 #define KERN_INFO       "<6>"   /* informational                        */
  40 #define KERN_DEBUG      "<7>"   /* debug-level messages                 */
  41
  42 extern int console_printk[];
  43
  44 #define console_loglevel (console_printk[0])
  45 #define default_message_loglevel (console_printk[1])
  46 #define minimum_console_loglevel (console_printk[2])
  47 #define default_console_loglevel (console_printk[3])
  48
  49 struct completion;
  50
  51 #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
  52 void __might_sleep(char *file, int line);
  53 #define might_sleep() __might_sleep(__FILE__, __LINE__)
  54 #define might_sleep_if(cond) do { if (unlikely(cond)) might_sleep(); } while (0)
  55 #else
  56 #define might_sleep() do {} while(0)
  57 #define might_sleep_if(cond) do {} while (0)
  58 #endif
  59
  60 #define abs(x) ({                               \
  61                 int __x = (x);                  \
  62                 (__x < 0) ? -__x : __x;         \
  63         })
  64
  65 #define labs(x) ({                              \
  66                 long __x = (x);                 \
  67                 (__x < 0) ? -__x : __x;         \
  68         })
  69
  70 extern struct notifier_block *panic_notifier_list;
  71 extern long (*panic_blink)(long time);
  72 NORET_TYPE void panic(const char * fmt, ...)
  73         __attribute__ ((NORET_AND format (printf, 1, 2)));
  74 fastcall NORET_TYPE void do_exit(long error_code)
  75         ATTRIB_NORET;
  76 NORET_TYPE void complete_and_exit(struct completion *, long)
  77         ATTRIB_NORET;
  78 extern unsigned long simple_strtoul(const char *,char **,unsigned int);
  79 extern long simple_strtol(const char *,char **,unsigned int);
  80 extern unsigned long long simple_strtoull(const char *,char **,unsigned int);
  81 extern long long simple_strtoll(const char *,char **,unsigned int);
  82 extern int sprintf(char * buf, const char * fmt, ...)
  83         __attribute__ ((format (printf, 2, 3)));
  84 extern int vsprintf(char *buf, const char *, va_list);
  85 extern int snprintf(char * buf, size_t size, const char * fmt, ...)
  86         __attribute__ ((format (printf, 3, 4)));
  87 extern int vsnprintf(char *buf, size_t size, const char *fmt, va_list args);
  88 extern int scnprintf(char * buf, size_t size, const char * fmt, ...)
  89         __attribute__ ((format (printf, 3, 4)));
  90 extern int vscnprintf(char *buf, size_t size, const char *fmt, va_list args);
  91
  92 extern int sscanf(const char *, const char *, ...)
  93         __attribute__ ((format (scanf,2,3)));
  94 extern int vsscanf(const char *, const char *, va_list);
  95
  96 extern void qsort(void *, size_t, size_t, int (*)(const void *,const void *));
  97
  98 extern int get_option(char **str, int *pint);
  99 extern char *get_options(const char *str, int nints, int *ints);
 100 extern unsigned long long memparse(char *ptr, char **retptr);
 101
 102 extern int __kernel_text_address(unsigned long addr);
 103 extern int kernel_text_address(unsigned long addr);
 104 extern int session_of_pgrp(int pgrp);
 105
 106 asmlinkage int vprintk(const char *fmt, va_list args);
 107 asmlinkage int printk(const char * fmt, ...)
 108         __attribute__ ((format (printf, 1, 2)));
 109
 110 unsigned long int_sqrt(unsigned long);
 111
 112 static inline int __attribute_pure__ long_log2(unsigned long x)
 113 {
 114         int r = 0;
 115         for (x >>= 1; x > 0; x >>= 1)
 116                 r++;
 117         return r;
 118 }
 119
 120 static inline unsigned long __attribute_const__ roundup_pow_of_two(unsigned long x)
 121 {
 122         return (1UL << fls(x - 1));
 123 }
 124
 125 extern int printk_ratelimit(void);
 126 extern int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst);
 127
 128 static inline void console_silent(void)
 129 {
 130         console_loglevel = 0;
 131 }
 132
 133 static inline void console_verbose(void)
 134 {
 135         if (console_loglevel)
 136                 console_loglevel = 15;
 137 }
 138
 139 extern void bust_spinlocks(int yes);
 140 extern int oops_in_progress;            /* If set, an oops, panic(), BUG() or die() is in progress */
 141 extern int panic_timeout;
 142 extern int panic_on_oops;
 143 extern int tainted;
 144 extern const char *print_tainted(void);
 145 extern void add_taint(unsigned);
 146
 147 /* Values used for system_state */
 148 extern enum system_states {
 149         SYSTEM_BOOTING,
 150         SYSTEM_RUNNING,
 151         SYSTEM_HALT,
 152         SYSTEM_POWER_OFF,
 153         SYSTEM_RESTART,
 154 } system_state;
 155
 156 #define TAINT_PROPRIETARY_MODULE        (1<<0)
 157 #define TAINT_FORCED_MODULE             (1<<1)
 158 #define TAINT_UNSAFE_SMP                (1<<2)
 159 #define TAINT_FORCED_RMMOD              (1<<3)
 160 #define TAINT_MACHINE_CHECK             (1<<4)
 161 #define TAINT_BAD_PAGE                  (1<<5)
 162
 163 extern void dump_stack(void);
 164
 165 #ifdef DEBUG
 166 #define pr_debug(fmt,arg...) \
 167         printk(KERN_DEBUG fmt,##arg)
 168 #else
 169 #define pr_debug(fmt,arg...) \
 170         do { } while (0)
 171 #endif
 172
 173 #define pr_info(fmt,arg...) \
 174         printk(KERN_INFO fmt,##arg)
 175
 176 /*
 177  *      Display an IP address in readable format.
 178  */
 179
 180 #define NIPQUAD(addr) \
 181         ((unsigned char *)&addr)[0], \
 182         ((unsigned char *)&addr)[1], \
 183         ((unsigned char *)&addr)[2], \
 184         ((unsigned char *)&addr)[3]
 185
 186 #define NIP6(addr) \
 187         ntohs((addr).s6_addr16[0]), \
 188         ntohs((addr).s6_addr16[1]), \
 189         ntohs((addr).s6_addr16[2]), \
 190         ntohs((addr).s6_addr16[3]), \
 191         ntohs((addr).s6_addr16[4]), \
 192         ntohs((addr).s6_addr16[5]), \
 193         ntohs((addr).s6_addr16[6]), \
 194         ntohs((addr).s6_addr16[7])
 195
 196 #if defined(__LITTLE_ENDIAN)
 197 #define HIPQUAD(addr) \
 198         ((unsigned char *)&addr)[3], \
 199         ((unsigned char *)&addr)[2], \
 200         ((unsigned char *)&addr)[1], \
 201         ((unsigned char *)&addr)[0]
 202 #elif defined(__BIG_ENDIAN)
 203 #define HIPQUAD NIPQUAD
 204 #else
 205 #error "Please fix asm/byteorder.h"
 206 #endif /* __LITTLE_ENDIAN */
 207
 208 /*
 209  * min()/max() macros that also do
 210  * strict type-checking.. See the
 211  * "unnecessary" pointer comparison.
 212  */
 213 #define min(x,y) ({ \
 214         typeof(x) _x = (x);     \
 215         typeof(y) _y = (y);     \
 216         (void) (&_x == &_y);            \
 217         _x < _y ? _x : _y; })
 218
 219 #define max(x,y) ({ \
 220         typeof(x) _x = (x);     \
 221         typeof(y) _y = (y);     \
 222         (void) (&_x == &_y);            \
 223         _x > _y ? _x : _y; })
 224
 225 /*
 226  * ..and if you can't take the strict
 227  * types, you can specify one yourself.
 228  *
 229  * Or not use min/max at all, of course.
 230  */
 231 #define min_t(type,x,y) \
 232         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
 233 #define max_t(type,x,y) \
 234         ({ type __x = (x); type __y = (y); __x > __y ? __x: __y; })
 235
 236
 237 /**
 238  * container_of - cast a member of a structure out to the containing structure
 239  *
 240  * @ptr:        the pointer to the member.
 241  * @type:       the type of the container struct this is embedded in.
 242  * @member:     the name of the member within the struct.
 243  *
 244  */
 245 #define container_of(ptr, type, member) ({                      \
 246         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 247         (type *)( (char *)__mptr - offsetof(type,member) );})
 248
 249 /*
 250  * Check at compile time that something is of a particular type.
 251  * Always evaluates to 1 so you may use it easily in comparisons.
 252  */
 253 #define typecheck(type,x) \
 254 ({      type __dummy; \
 255         typeof(x) __dummy2; \
 256         (void)(&__dummy == &__dummy2); \
 257         1; \
 258 })
 259
 260 #endif /* __KERNEL__ */
 261
 262 #define SI_LOAD_SHIFT   16
 263 struct sysinfo {
 264         long uptime;                    /* Seconds since boot */
 265         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 266         unsigned long totalram;         /* Total usable main memory size */
 267         unsigned long freeram;          /* Available memory size */
 268         unsigned long sharedram;        /* Amount of shared memory */
 269         unsigned long bufferram;        /* Memory used by buffers */
 270         unsigned long totalswap;        /* Total swap space size */
 271         unsigned long freeswap;         /* swap space still available */
 272         unsigned short procs;           /* Number of current processes */
 273         unsigned short pad;             /* explicit padding for m68k */
 274         unsigned long totalhigh;        /* Total high memory size */
 275         unsigned long freehigh;         /* Available high memory size */
 276         unsigned int mem_unit;          /* Memory unit size in bytes */
 277         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 278 };
 279
 280 extern void BUILD_BUG(void);
 281 #define BUILD_BUG_ON(condition) do { if (condition) BUILD_BUG(); } while(0)
 282
 283 /* Trap pasters of __FUNCTION__ at compile-time */
 284 #if __GNUC__ > 2 || __GNUC_MINOR__ >= 95
 285 #define __FUNCTION__ (__func__)
 286 #endif
 287
 288 #endif