| 1 | /* $Id: the-linux-kernel.h 23717 2009-10-13 10:16:38Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - Include all necessary headers for the Linux kernel.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2007 Sun Microsystems, Inc.
|
|---|
| 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 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
|---|
| 27 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
|---|
| 28 | * additional information or have any questions.
|
|---|
| 29 | */
|
|---|
| 30 |
|
|---|
| 31 | #ifndef ___the_linux_kernel_h
|
|---|
| 32 | #define ___the_linux_kernel_h
|
|---|
| 33 |
|
|---|
| 34 | /*
|
|---|
| 35 | * Include iprt/types.h to install the bool wrappers.
|
|---|
| 36 | * Then use the linux bool type for all the stuff include here.
|
|---|
| 37 | */
|
|---|
| 38 | #include <iprt/types.h>
|
|---|
| 39 | #define bool linux_bool
|
|---|
| 40 |
|
|---|
| 41 | #include <linux/autoconf.h>
|
|---|
| 42 | #include <linux/version.h>
|
|---|
| 43 |
|
|---|
| 44 | /* We only support 2.4 and 2.6 series kernels */
|
|---|
| 45 | #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0)
|
|---|
| 46 | # error We only support 2.4 and 2.6 series kernels
|
|---|
| 47 | #endif
|
|---|
| 48 | #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 0) && LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
|
|---|
| 49 | # error We only support 2.4 and 2.6 series kernels
|
|---|
| 50 | #endif
|
|---|
| 51 |
|
|---|
| 52 | #if defined(CONFIG_MODVERSIONS) && !defined(MODVERSIONS)
|
|---|
| 53 | # define MODVERSIONS
|
|---|
| 54 | # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 71)
|
|---|
| 55 | # include <linux/modversions.h>
|
|---|
| 56 | # endif
|
|---|
| 57 | #endif
|
|---|
| 58 | #ifndef KBUILD_STR
|
|---|
| 59 | # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 16)
|
|---|
| 60 | # define KBUILD_STR(s) s
|
|---|
| 61 | # else
|
|---|
| 62 | # define KBUILD_STR(s) #s
|
|---|
| 63 | # endif
|
|---|
| 64 | #endif
|
|---|
| 65 | #include <linux/string.h>
|
|---|
| 66 | #include <linux/spinlock.h>
|
|---|
| 67 | #include <linux/slab.h>
|
|---|
| 68 | #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 27)
|
|---|
| 69 | # include <linux/semaphore.h>
|
|---|
| 70 | #else /* older kernels */
|
|---|
| 71 | # include <asm/semaphore.h>
|
|---|
| 72 | #endif /* older kernels */
|
|---|
| 73 | #include <linux/module.h>
|
|---|
| 74 | #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
|
|---|
| 75 | # include <linux/moduleparam.h>
|
|---|
| 76 | #endif
|
|---|
| 77 | #include <linux/kernel.h>
|
|---|
| 78 | #include <linux/init.h>
|
|---|
| 79 | #include <linux/fs.h>
|
|---|
| 80 | #include <linux/mm.h>
|
|---|
| 81 | #include <linux/pagemap.h>
|
|---|
| 82 | #include <linux/slab.h>
|
|---|
| 83 | #include <linux/time.h>
|
|---|
| 84 | #include <linux/sched.h>
|
|---|
| 85 | #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 7)
|
|---|
| 86 | # include <linux/jiffies.h>
|
|---|
| 87 | #endif
|
|---|
| 88 | #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 16)
|
|---|
| 89 | # include <linux/ktime.h>
|
|---|
| 90 | # include <linux/hrtimer.h>
|
|---|
| 91 | #endif
|
|---|
| 92 | #include <linux/wait.h>
|
|---|
| 93 | #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 71)
|
|---|
| 94 | # include <linux/cpu.h>
|
|---|
| 95 | # include <linux/notifier.h>
|
|---|
| 96 | #endif
|
|---|
| 97 | /* For the basic additions module */
|
|---|
| 98 | #include <linux/pci.h>
|
|---|
| 99 | #include <linux/delay.h>
|
|---|
| 100 | #include <linux/interrupt.h>
|
|---|
| 101 | #include <linux/completion.h>
|
|---|
| 102 | #include <linux/compiler.h>
|
|---|
| 103 | #ifndef HAVE_UNLOCKED_IOCTL /* linux/fs.h defines this */
|
|---|
| 104 | # include <linux/smp_lock.h>
|
|---|
| 105 | #endif
|
|---|
| 106 | /* For the shared folders module */
|
|---|
| 107 | #include <linux/vmalloc.h>
|
|---|
| 108 | #define wchar_t linux_wchar_t
|
|---|
| 109 | #include <linux/nls.h>
|
|---|
| 110 | #undef wchar_t
|
|---|
| 111 | #include <asm/mman.h>
|
|---|
| 112 | #include <asm/io.h>
|
|---|
| 113 | #include <asm/uaccess.h>
|
|---|
| 114 | #include <asm/div64.h>
|
|---|
| 115 |
|
|---|
| 116 | #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
|
|---|
| 117 | # ifndef page_to_pfn
|
|---|
| 118 | # define page_to_pfn(page) ((page) - mem_map)
|
|---|
| 119 | # endif
|
|---|
| 120 | #endif
|
|---|
| 121 |
|
|---|
| 122 | #ifndef DEFINE_WAIT
|
|---|
| 123 | # define DEFINE_WAIT(name) DECLARE_WAITQUEUE(name, current)
|
|---|
| 124 | #endif
|
|---|
| 125 |
|
|---|
| 126 | /*
|
|---|
| 127 | * 2.4 compatibility wrappers
|
|---|
| 128 | */
|
|---|
| 129 | #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 7)
|
|---|
| 130 |
|
|---|
| 131 | # ifndef MAX_JIFFY_OFFSET
|
|---|
| 132 | # define MAX_JIFFY_OFFSET ((~0UL >> 1)-1)
|
|---|
| 133 | # endif
|
|---|
| 134 |
|
|---|
| 135 | # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 29) || LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
|
|---|
| 136 |
|
|---|
| 137 | DECLINLINE(unsigned int) jiffies_to_msecs(unsigned long cJiffies)
|
|---|
| 138 | {
|
|---|
| 139 | # if HZ <= 1000 && !(1000 % HZ)
|
|---|
| 140 | return (1000 / HZ) * cJiffies;
|
|---|
| 141 | # elif HZ > 1000 && !(HZ % 1000)
|
|---|
| 142 | return (cJiffies + (HZ / 1000) - 1) / (HZ / 1000);
|
|---|
| 143 | # else
|
|---|
| 144 | return (cJiffies * 1000) / HZ;
|
|---|
| 145 | # endif
|
|---|
| 146 | }
|
|---|
| 147 |
|
|---|
| 148 | DECLINLINE(unsigned long) msecs_to_jiffies(unsigned int cMillies)
|
|---|
| 149 | {
|
|---|
| 150 | # if HZ > 1000
|
|---|
| 151 | if (cMillies > jiffies_to_msecs(MAX_JIFFY_OFFSET))
|
|---|
| 152 | return MAX_JIFFY_OFFSET;
|
|---|
| 153 | # endif
|
|---|
| 154 | # if HZ <= 1000 && !(1000 % HZ)
|
|---|
| 155 | return (cMillies + (1000 / HZ) - 1) / (1000 / HZ);
|
|---|
| 156 | # elif HZ > 1000 && !(HZ % 1000)
|
|---|
| 157 | return cMillies * (HZ / 1000);
|
|---|
| 158 | # else
|
|---|
| 159 | return (cMillies * HZ + 999) / 1000;
|
|---|
| 160 | # endif
|
|---|
| 161 | }
|
|---|
| 162 |
|
|---|
| 163 | # endif /* < 2.4.29 || >= 2.6.0 */
|
|---|
| 164 |
|
|---|
| 165 | # define prepare_to_wait(q, wait, state) \
|
|---|
| 166 | do { \
|
|---|
| 167 | set_current_state(state); \
|
|---|
| 168 | add_wait_queue(q, wait); \
|
|---|
| 169 | } while (0)
|
|---|
| 170 |
|
|---|
| 171 | # define finish_wait(q, wait) \
|
|---|
| 172 | do { \
|
|---|
| 173 | remove_wait_queue(q, wait); \
|
|---|
| 174 | set_current_state(TASK_RUNNING); \
|
|---|
| 175 | } while (0)
|
|---|
| 176 |
|
|---|
| 177 | #endif /* < 2.6.7 */
|
|---|
| 178 |
|
|---|
| 179 | /** @def TICK_NSEC
|
|---|
| 180 | * The time between ticks in nsec */
|
|---|
| 181 | #ifndef TICK_NSEC
|
|---|
| 182 | # define TICK_NSEC (1000000000UL / HZ)
|
|---|
| 183 | #endif
|
|---|
| 184 |
|
|---|
| 185 | /*
|
|---|
| 186 | * This sucks soooo badly on x86! Why don't they export __PAGE_KERNEL_EXEC so PAGE_KERNEL_EXEC would be usable?
|
|---|
| 187 | */
|
|---|
| 188 | #if defined(RT_ARCH_AMD64)
|
|---|
| 189 | # define MY_PAGE_KERNEL_EXEC PAGE_KERNEL_EXEC
|
|---|
| 190 | #elif defined(PAGE_KERNEL_EXEC) && defined(CONFIG_X86_PAE)
|
|---|
| 191 | # ifdef __PAGE_KERNEL_EXEC
|
|---|
| 192 | /* >= 2.6.27 */
|
|---|
| 193 | # define MY_PAGE_KERNEL_EXEC __pgprot(cpu_has_pge ? __PAGE_KERNEL_EXEC | _PAGE_GLOBAL : __PAGE_KERNEL_EXEC)
|
|---|
| 194 | # else
|
|---|
| 195 | # define MY_PAGE_KERNEL_EXEC __pgprot(cpu_has_pge ? _PAGE_KERNEL_EXEC | _PAGE_GLOBAL : _PAGE_KERNEL_EXEC)
|
|---|
| 196 | # endif
|
|---|
| 197 | #else
|
|---|
| 198 | # define MY_PAGE_KERNEL_EXEC PAGE_KERNEL
|
|---|
| 199 | #endif
|
|---|
| 200 |
|
|---|
| 201 |
|
|---|
| 202 | /*
|
|---|
| 203 | * The redhat hack section.
|
|---|
| 204 | * - The current hacks are for 2.4.21-15.EL only.
|
|---|
| 205 | */
|
|---|
| 206 | #ifndef NO_REDHAT_HACKS
|
|---|
| 207 | /* accounting. */
|
|---|
| 208 | # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
|
|---|
| 209 | # ifdef VM_ACCOUNT
|
|---|
| 210 | # define MY_DO_MUNMAP(a,b,c) do_munmap(a, b, c, 0) /* should it be 1 or 0? */
|
|---|
| 211 | # endif
|
|---|
| 212 | # endif
|
|---|
| 213 |
|
|---|
| 214 | /* backported remap_page_range. */
|
|---|
| 215 | # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
|
|---|
| 216 | # include <asm/tlb.h>
|
|---|
| 217 | # ifdef tlb_vma /* probably not good enough... */
|
|---|
| 218 | # define HAVE_26_STYLE_REMAP_PAGE_RANGE 1
|
|---|
| 219 | # endif
|
|---|
| 220 | # endif
|
|---|
| 221 |
|
|---|
| 222 | # ifndef RT_ARCH_AMD64
|
|---|
| 223 | /* In 2.6.9-22.ELsmp we have to call change_page_attr() twice when changing
|
|---|
| 224 | * the page attributes from PAGE_KERNEL to something else, because there appears
|
|---|
| 225 | * to be a bug in one of the many patches that redhat applied.
|
|---|
| 226 | * It should be safe to do this on less buggy linux kernels too. ;-)
|
|---|
| 227 | */
|
|---|
| 228 | # define MY_CHANGE_PAGE_ATTR(pPages, cPages, prot) \
|
|---|
| 229 | do { \
|
|---|
| 230 | if (pgprot_val(prot) != pgprot_val(PAGE_KERNEL)) \
|
|---|
| 231 | change_page_attr(pPages, cPages, prot); \
|
|---|
| 232 | change_page_attr(pPages, cPages, prot); \
|
|---|
| 233 | } while (0)
|
|---|
| 234 | # endif /* !RT_ARCH_AMD64 */
|
|---|
| 235 | #endif /* !NO_REDHAT_HACKS */
|
|---|
| 236 |
|
|---|
| 237 | #ifndef MY_DO_MUNMAP
|
|---|
| 238 | # define MY_DO_MUNMAP(a,b,c) do_munmap(a, b, c)
|
|---|
| 239 | #endif
|
|---|
| 240 |
|
|---|
| 241 | #ifndef MY_CHANGE_PAGE_ATTR
|
|---|
| 242 | # ifdef RT_ARCH_AMD64 /** @todo This is a cheap hack, but it'll get around that 'else BUG();' in __change_page_attr(). */
|
|---|
| 243 | # define MY_CHANGE_PAGE_ATTR(pPages, cPages, prot) \
|
|---|
| 244 | do { \
|
|---|
| 245 | change_page_attr(pPages, cPages, PAGE_KERNEL_NOCACHE); \
|
|---|
| 246 | change_page_attr(pPages, cPages, prot); \
|
|---|
| 247 | } while (0)
|
|---|
| 248 | # else
|
|---|
| 249 | # define MY_CHANGE_PAGE_ATTR(pPages, cPages, prot) change_page_attr(pPages, cPages, prot)
|
|---|
| 250 | # endif
|
|---|
| 251 | #endif
|
|---|
| 252 |
|
|---|
| 253 | #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 25)
|
|---|
| 254 | # define MY_SET_PAGES_EXEC(pPages, cPages) set_pages_x(pPages, cPages)
|
|---|
| 255 | # define MY_SET_PAGES_NOEXEC(pPages, cPages) set_pages_nx(pPages, cPages)
|
|---|
| 256 | #else
|
|---|
| 257 | # define MY_SET_PAGES_EXEC(pPages, cPages) \
|
|---|
| 258 | do { \
|
|---|
| 259 | if (pgprot_val(MY_PAGE_KERNEL_EXEC) != pgprot_val(PAGE_KERNEL)) \
|
|---|
| 260 | MY_CHANGE_PAGE_ATTR(pPages, cPages, MY_PAGE_KERNEL_EXEC); \
|
|---|
| 261 | } while (0)
|
|---|
| 262 | # define MY_SET_PAGES_NOEXEC(pPages, cPages) \
|
|---|
| 263 | do { \
|
|---|
| 264 | if (pgprot_val(MY_PAGE_KERNEL_EXEC) != pgprot_val(PAGE_KERNEL)) \
|
|---|
| 265 | MY_CHANGE_PAGE_ATTR(pPages, cPages, PAGE_KERNEL); \
|
|---|
| 266 | } while (0)
|
|---|
| 267 | #endif
|
|---|
| 268 |
|
|---|
| 269 | /** @def ONE_MSEC_IN_JIFFIES
|
|---|
| 270 | * The number of jiffies that make up 1 millisecond. Must be at least 1! */
|
|---|
| 271 | #if HZ <= 1000
|
|---|
| 272 | # define ONE_MSEC_IN_JIFFIES 1
|
|---|
| 273 | #elif !(HZ % 1000)
|
|---|
| 274 | # define ONE_MSEC_IN_JIFFIES (HZ / 1000)
|
|---|
| 275 | #else
|
|---|
| 276 | # define ONE_MSEC_IN_JIFFIES ((HZ + 999) / 1000)
|
|---|
| 277 | # error "HZ is not a multiple of 1000, the GIP stuff won't work right!"
|
|---|
| 278 | #endif
|
|---|
| 279 |
|
|---|
| 280 | /*
|
|---|
| 281 | * Stop using the linux bool type.
|
|---|
| 282 | */
|
|---|
| 283 | #undef bool
|
|---|
| 284 |
|
|---|
| 285 | /*
|
|---|
| 286 | * There are post-2.6.24 kernels (confusingly with unchanged version number)
|
|---|
| 287 | * which eliminate macros which were marked as deprecated.
|
|---|
| 288 | */
|
|---|
| 289 | #ifndef __attribute_used__
|
|---|
| 290 | #define __attribute_used__ __used
|
|---|
| 291 | #endif
|
|---|
| 292 |
|
|---|
| 293 | /**
|
|---|
| 294 | * Hack for shortening pointers on linux so we can stuff more stuff into the
|
|---|
| 295 | * task_struct::comm field. This is used by the semaphore code but put here
|
|---|
| 296 | * because we don't have any better place atm. Don't use outside IPRT, please.
|
|---|
| 297 | */
|
|---|
| 298 | #ifdef RT_ARCH_AMD64
|
|---|
| 299 | # define IPRT_DEBUG_SEMS_ADDRESS(addr) ( ((long)(addr) & (long)~UINT64_C(0xfffffff000000000)) )
|
|---|
| 300 | #else
|
|---|
| 301 | # define IPRT_DEBUG_SEMS_ADDRESS(addr) ( (long)(addr) )
|
|---|
| 302 | #endif
|
|---|
| 303 |
|
|---|
| 304 | /*
|
|---|
| 305 | * There are some conflicting defines in iprt/param.h, sort them out here.
|
|---|
| 306 | */
|
|---|
| 307 | #ifndef ___iprt_param_h
|
|---|
| 308 | # undef PAGE_SIZE
|
|---|
| 309 | # undef PAGE_OFFSET_MASK
|
|---|
| 310 | # include <iprt/param.h>
|
|---|
| 311 | #endif
|
|---|
| 312 |
|
|---|
| 313 | #endif
|
|---|
| 314 |
|
|---|
