ubuntu/vbox/r0drv/linux/the-linux-kernel.h

   1 /* $Id: the-linux-kernel.h $ */
   2 /** @file
   3  * IPRT - Include all necessary headers for the Linux kernel.
   4  */
   5
   6 /*
   7  * Copyright (C) 2006-2016 Oracle Corporation
   8  *
   9  * This file is part of VirtualBox Open Source Edition (OSE), as
  10  * available from http://www.virtualbox.org. This file is free software;
  11  * you can redistribute it and/or modify it under the terms of the GNU
  12  * General Public License (GPL) as published by the Free Software
  13  * Foundation, in version 2 as it comes in the "COPYING" file of the
  14  * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
  15  * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
  16  *
  17  * The contents of this file may alternatively be used under the terms
  18  * of the Common Development and Distribution License Version 1.0
  19  * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
  20  * VirtualBox OSE distribution, in which case the provisions of the
  21  * CDDL are applicable instead of those of the GPL.
  22  *
  23  * You may elect to license modified versions of this file under the
  24  * terms and conditions of either the GPL or the CDDL or both.
  25  */
  26
  27 #ifndef ___the_linux_kernel_h
  28 #define ___the_linux_kernel_h
  29
  30 /*
  31  * Include iprt/types.h to install the bool wrappers.
  32  * Then use the linux bool type for all the stuff include here.
  33  */
  34 #include <iprt/types.h>
  35 #define bool linux_bool
  36
  37 #if RT_GNUC_PREREQ(4, 6)
  38 # pragma GCC diagnostic push
  39 #endif
  40 #if RT_GNUC_PREREQ(4, 2)
  41 # pragma GCC diagnostic ignored "-Wunused-parameter"
  42 # if !defined(__cplusplus) && RT_GNUC_PREREQ(4, 3)
  43 #  pragma GCC diagnostic ignored "-Wold-style-declaration" /* 2.6.18-411.0.0.0.1.el5/build/include/asm/apic.h:110: warning: 'inline' is not at beginning of declaration [-Wold-style-declaration] */
  44 # endif
  45 #endif
  46
  47 #include <linux/version.h>
  48 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 33)
  49 # include <generated/autoconf.h>
  50 #else
  51 # ifndef AUTOCONF_INCLUDED
  52 #  include <linux/autoconf.h>
  53 # endif
  54 #endif
  55
  56 /* We only support 2.4 and 2.6 series kernels */
  57 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0)
  58 # error We only support 2.4 and 2.6 series kernels
  59 #endif
  60 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 0) && LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
  61 # error We only support 2.4 and 2.6 series kernels
  62 #endif
  63
  64 #if defined(CONFIG_MODVERSIONS) && !defined(MODVERSIONS)
  65 # define MODVERSIONS
  66 # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 71)
  67 #  include <linux/modversions.h>
  68 # endif
  69 #endif
  70 #ifndef KBUILD_STR
  71 # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 16)
  72 #  define KBUILD_STR(s) s
  73 # else
  74 #  define KBUILD_STR(s) #s
  75 # endif
  76 #endif
  77 # if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 3, 0)
  78 #  include <linux/kconfig.h> /* for macro IS_ENABLED */
  79 # endif
  80 #include <linux/string.h>
  81 #include <linux/spinlock.h>
  82 #include <linux/slab.h>
  83 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 27)
  84 # include <linux/semaphore.h>
  85 #else /* older kernels */
  86 # include <asm/semaphore.h>
  87 #endif /* older kernels */
  88 #include <linux/module.h>
  89 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
  90 # include <linux/moduleparam.h>
  91 #endif
  92 #include <linux/kernel.h>
  93 #include <linux/init.h>
  94 #include <linux/fs.h>
  95 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
  96 # include <linux/namei.h>
  97 #endif
  98 #include <linux/mm.h>
  99 #include <linux/pagemap.h>
 100 #include <linux/slab.h>
 101 #include <linux/time.h>
 102 #include <linux/sched.h>
 103 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 9, 0)
 104 # include <linux/sched/rt.h>
 105 #endif
 106 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 7)
 107 # include <linux/jiffies.h>
 108 #endif
 109 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 16)
 110 # include <linux/ktime.h>
 111 # include <linux/hrtimer.h>
 112 #endif
 113 #include <linux/wait.h>
 114 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 71)
 115 # include <linux/cpu.h>
 116 # include <linux/notifier.h>
 117 #endif
 118 /* For the basic additions module */
 119 #include <linux/pci.h>
 120 #include <linux/delay.h>
 121 #include <linux/interrupt.h>
 122 #include <linux/completion.h>
 123 #include <linux/compiler.h>
 124 #ifndef HAVE_UNLOCKED_IOCTL /* linux/fs.h defines this */
 125 # include <linux/smp_lock.h>
 126 #endif
 127 /* For the shared folders module */
 128 #include <linux/vmalloc.h>
 129 #define wchar_t linux_wchar_t
 130 #include <linux/nls.h>
 131 #undef wchar_t
 132 #include <asm/mman.h>
 133 #include <asm/io.h>
 134 #include <asm/uaccess.h>
 135 #include <asm/div64.h>
 136
 137 /* For thread-context hooks. */
 138 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 18) && defined(CONFIG_PREEMPT_NOTIFIERS)
 139 # include <linux/preempt.h>
 140 #endif
 141
 142 /* for workqueue / task queues. */
 143 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 41)
 144 # include <linux/workqueue.h>
 145 #else
 146 # include <linux/tqueue.h>
 147 #endif
 148
 149 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
 150 # include <linux/kthread.h>
 151 #endif
 152
 153 /* for cr4_init_shadow() / cpu_tlbstate. */
 154 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 20, 0)
 155 # include <asm/tlbflush.h>
 156 #endif
 157
 158 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 7, 0)
 159 # include <asm/smap.h>
 160 #else
 161 static inline void clac(void) { }
 162 static inline void stac(void) { }
 163 #endif
 164
 165 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
 166 # ifndef page_to_pfn
 167 #  define page_to_pfn(page) ((page) - mem_map)
 168 # endif
 169 #endif
 170
 171 #ifndef DEFINE_WAIT
 172 # define DEFINE_WAIT(name) DECLARE_WAITQUEUE(name, current)
 173 #endif
 174
 175 #ifndef __GFP_NOWARN
 176 # define __GFP_NOWARN 0
 177 #endif
 178
 179 /*
 180  * 2.4 / early 2.6 compatibility wrappers
 181  */
 182 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 7)
 183
 184 # ifndef MAX_JIFFY_OFFSET
 185 #  define MAX_JIFFY_OFFSET ((~0UL >> 1)-1)
 186 # endif
 187
 188 # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 29) || LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
 189
 190 DECLINLINE(unsigned int) jiffies_to_msecs(unsigned long cJiffies)
 191 {
 192 #  if HZ <= 1000 && !(1000 % HZ)
 193     return (1000 / HZ) * cJiffies;
 194 #  elif HZ > 1000 && !(HZ % 1000)
 195     return (cJiffies + (HZ / 1000) - 1) / (HZ / 1000);
 196 #  else
 197     return (cJiffies * 1000) / HZ;
 198 #  endif
 199 }
 200
 201 DECLINLINE(unsigned long) msecs_to_jiffies(unsigned int cMillies)
 202 {
 203 #  if HZ > 1000
 204     if (cMillies > jiffies_to_msecs(MAX_JIFFY_OFFSET))
 205         return MAX_JIFFY_OFFSET;
 206 #  endif
 207 #  if HZ <= 1000 && !(1000 % HZ)
 208     return (cMillies + (1000 / HZ) - 1) / (1000 / HZ);
 209 #  elif HZ > 1000 && !(HZ % 1000)
 210     return cMillies * (HZ / 1000);
 211 #  else
 212     return (cMillies * HZ + 999) / 1000;
 213 #  endif
 214 }
 215
 216 # endif  /* < 2.4.29 || >= 2.6.0 */
 217
 218 #endif /* < 2.6.7 */
 219
 220 /*
 221  * 2.4 compatibility wrappers
 222  */
 223 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
 224
 225 # define prepare_to_wait(q, wait, state) \
 226     do { \
 227         add_wait_queue(q, wait); \
 228         set_current_state(state); \
 229     } while (0)
 230
 231 # define after_wait(wait) \
 232     do { \
 233         list_del_init(&(wait)->task_list); \
 234     } while (0)
 235
 236 # define finish_wait(q, wait) \
 237     do { \
 238         set_current_state(TASK_RUNNING); \
 239         remove_wait_queue(q, wait); \
 240     } while (0)
 241
 242 #else /* >= 2.6.0 */
 243
 244 # define after_wait(wait)       do {} while (0)
 245
 246 #endif /* >= 2.6.0 */
 247
 248 /** @def TICK_NSEC
 249  * The time between ticks in nsec */
 250 #ifndef TICK_NSEC
 251 # define TICK_NSEC (1000000000UL / HZ)
 252 #endif
 253
 254 /*
 255  * This sucks soooo badly on x86! Why don't they export __PAGE_KERNEL_EXEC so PAGE_KERNEL_EXEC would be usable?
 256  */
 257 #if   LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 8) && defined(RT_ARCH_AMD64)
 258 # define MY_PAGE_KERNEL_EXEC    PAGE_KERNEL_EXEC
 259 #elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 8) && defined(PAGE_KERNEL_EXEC) && defined(CONFIG_X86_PAE)
 260 # ifdef __PAGE_KERNEL_EXEC
 261    /* >= 2.6.27 */
 262 #  define MY_PAGE_KERNEL_EXEC   __pgprot(boot_cpu_has(X86_FEATURE_PGE) ? __PAGE_KERNEL_EXEC | _PAGE_GLOBAL : __PAGE_KERNEL_EXEC)
 263 # else
 264 #  define MY_PAGE_KERNEL_EXEC   __pgprot(boot_cpu_has(X86_FEATURE_PGE) ? _PAGE_KERNEL_EXEC | _PAGE_GLOBAL : _PAGE_KERNEL_EXEC)
 265 # endif
 266 #else
 267 # define MY_PAGE_KERNEL_EXEC    PAGE_KERNEL
 268 #endif
 269
 270
 271 /*
 272  * The redhat hack section.
 273  *  - The current hacks are for 2.4.21-15.EL only.
 274  */
 275 #ifndef NO_REDHAT_HACKS
 276 /* accounting. */
 277 # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
 278 #  ifdef VM_ACCOUNT
 279 #   define USE_RHEL4_MUNMAP
 280 #  endif
 281 # endif
 282
 283 /* backported remap_page_range. */
 284 # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
 285 #  include <asm/tlb.h>
 286 #  ifdef tlb_vma /* probably not good enough... */
 287 #   define HAVE_26_STYLE_REMAP_PAGE_RANGE 1
 288 #  endif
 289 # endif
 290
 291 # ifndef RT_ARCH_AMD64
 292 /* In 2.6.9-22.ELsmp we have to call change_page_attr() twice when changing
 293  * the page attributes from PAGE_KERNEL to something else, because there appears
 294  * to be a bug in one of the many patches that redhat applied.
 295  * It should be safe to do this on less buggy linux kernels too. ;-)
 296  */
 297 #  define MY_CHANGE_PAGE_ATTR(pPages, cPages, prot) \
 298     do { \
 299         if (pgprot_val(prot) != pgprot_val(PAGE_KERNEL)) \
 300             change_page_attr(pPages, cPages, prot); \
 301         change_page_attr(pPages, cPages, prot); \
 302     } while (0)
 303 # endif  /* !RT_ARCH_AMD64 */
 304 #endif /* !NO_REDHAT_HACKS */
 305
 306 #ifndef MY_CHANGE_PAGE_ATTR
 307 # ifdef RT_ARCH_AMD64 /** @todo This is a cheap hack, but it'll get around that 'else BUG();' in __change_page_attr().  */
 308 #  define MY_CHANGE_PAGE_ATTR(pPages, cPages, prot) \
 309     do { \
 310         change_page_attr(pPages, cPages, PAGE_KERNEL_NOCACHE); \
 311         change_page_attr(pPages, cPages, prot); \
 312     } while (0)
 313 # else
 314 #  define MY_CHANGE_PAGE_ATTR(pPages, cPages, prot) change_page_attr(pPages, cPages, prot)
 315 # endif
 316 #endif
 317
 318 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 25)
 319 # define MY_SET_PAGES_EXEC(pPages, cPages)    set_pages_x(pPages, cPages)
 320 # define MY_SET_PAGES_NOEXEC(pPages, cPages)  set_pages_nx(pPages, cPages)
 321 #else
 322 # define MY_SET_PAGES_EXEC(pPages, cPages) \
 323     do { \
 324         if (pgprot_val(MY_PAGE_KERNEL_EXEC) != pgprot_val(PAGE_KERNEL)) \
 325             MY_CHANGE_PAGE_ATTR(pPages, cPages, MY_PAGE_KERNEL_EXEC); \
 326     } while (0)
 327 # define MY_SET_PAGES_NOEXEC(pPages, cPages) \
 328     do { \
 329         if (pgprot_val(MY_PAGE_KERNEL_EXEC) != pgprot_val(PAGE_KERNEL)) \
 330             MY_CHANGE_PAGE_ATTR(pPages, cPages, PAGE_KERNEL); \
 331     } while (0)
 332 #endif
 333
 334 /** @def ONE_MSEC_IN_JIFFIES
 335  * The number of jiffies that make up 1 millisecond. Must be at least 1! */
 336 #if HZ <= 1000
 337 # define ONE_MSEC_IN_JIFFIES       1
 338 #elif !(HZ % 1000)
 339 # define ONE_MSEC_IN_JIFFIES       (HZ / 1000)
 340 #else
 341 # define ONE_MSEC_IN_JIFFIES       ((HZ + 999) / 1000)
 342 # error "HZ is not a multiple of 1000, the GIP stuff won't work right!"
 343 #endif
 344
 345 /*
 346  * Stop using the linux bool type.
 347  */
 348 #undef bool
 349
 350 #if RT_GNUC_PREREQ(4, 6)
 351 # pragma GCC diagnostic pop
 352 #endif
 353
 354 /*
 355  * There are post-2.6.24 kernels (confusingly with unchanged version number)
 356  * which eliminate macros which were marked as deprecated.
 357  */
 358 #ifndef __attribute_used__
 359 #define __attribute_used__ __used
 360 #endif
 361
 362 /**
 363  * Hack for shortening pointers on linux so we can stuff more stuff into the
 364  * task_struct::comm field. This is used by the semaphore code but put here
 365  * because we don't have any better place atm. Don't use outside IPRT, please.
 366  */
 367 #ifdef RT_ARCH_AMD64
 368 # define IPRT_DEBUG_SEMS_ADDRESS(addr)  ( ((long)(addr) & (long)~UINT64_C(0xfffffff000000000)) )
 369 #else
 370 # define IPRT_DEBUG_SEMS_ADDRESS(addr)  ( (long)(addr) )
 371 #endif
 372
 373 /**
 374  * Puts semaphore info into the task_struct::comm field if IPRT_DEBUG_SEMS is
 375  * defined.
 376  */
 377 #ifdef IPRT_DEBUG_SEMS
 378 # define IPRT_DEBUG_SEMS_STATE(pThis, chState) \
 379     snprintf(current->comm, sizeof(current->comm), "%c%lx", (chState), IPRT_DEBUG_SEMS_ADDRESS(pThis));
 380 #else
 381 # define IPRT_DEBUG_SEMS_STATE(pThis, chState)  do {  } while (0)
 382 #endif
 383
 384 /**
 385  * Puts semaphore info into the task_struct::comm field if IPRT_DEBUG_SEMS is
 386  * defined.
 387  */
 388 #ifdef IPRT_DEBUG_SEMS
 389 # define IPRT_DEBUG_SEMS_STATE_RC(pThis, chState, rc) \
 390     snprintf(current->comm, sizeof(current->comm), "%c%lx:%d", (chState), IPRT_DEBUG_SEMS_ADDRESS(pThis), rc);
 391 #else
 392 # define IPRT_DEBUG_SEMS_STATE_RC(pThis, chState, rc)  do {  } while (0)
 393 #endif
 394
 395 /** @name Macros for preserving EFLAGS.AC on 3.19+/amd64  paranoid.
 396  * The AMD 64 switch_to in macro in arch/x86/include/asm/switch_to.h stopped
 397  * restoring flags.
 398  * @{ */
 399 #if defined(CONFIG_X86_SMAP) || defined(RT_STRICT) || defined(IPRT_WITH_EFLAGS_AC_PRESERVING)
 400 # include <iprt/asm-amd64-x86.h>
 401 # define IPRT_X86_EFL_AC                    RT_BIT(18)
 402 # define IPRT_LINUX_SAVE_EFL_AC()           RTCCUINTREG fSavedEfl = ASMGetFlags()
 403 # define IPRT_LINUX_RESTORE_EFL_AC()        ASMSetFlags(fSavedEfl)
 404 # define IPRT_LINUX_RESTORE_EFL_ONLY_AC()   ASMChangeFlags(~IPRT_X86_EFL_AC, fSavedEfl & IPRT_X86_EFL_AC)
 405 #else
 406 # define IPRT_LINUX_SAVE_EFL_AC()           do { } while (0)
 407 # define IPRT_LINUX_RESTORE_EFL_AC()        do { } while (0)
 408 # define IPRT_LINUX_RESTORE_EFL_ONLY_AC()   do { } while (0)
 409 #endif
 410 /** @} */
 411
 412 /*
 413  * There are some conflicting defines in iprt/param.h, sort them out here.
 414  */
 415 #ifndef ___iprt_param_h
 416 # undef PAGE_SIZE
 417 # undef PAGE_OFFSET_MASK
 418 # include <iprt/param.h>
 419 #endif
 420
 421 /*
 422  * Some global indicator macros.
 423  */
 424 /** @def IPRT_LINUX_HAS_HRTIMER
 425  * Whether the kernel support high resolution timers (Linux kernel versions
 426  * 2.6.28 and later (hrtimer_add_expires_ns() & schedule_hrtimeout). */
 427 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 28)
 428 # define IPRT_LINUX_HAS_HRTIMER
 429 #endif
 430
 431 /*
 432  * Workqueue stuff, see initterm-r0drv-linux.c.
 433  */
 434 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 41)
 435 typedef struct work_struct  RTR0LNXWORKQUEUEITEM;
 436 #else
 437 typedef struct tq_struct    RTR0LNXWORKQUEUEITEM;
 438 #endif
 439 DECLHIDDEN(void) rtR0LnxWorkqueuePush(RTR0LNXWORKQUEUEITEM *pWork, void (*pfnWorker)(RTR0LNXWORKQUEUEITEM *));
 440 DECLHIDDEN(void) rtR0LnxWorkqueueFlush(void);
 441
 442
 443 #endif