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