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