VirtualBox

source: vbox/trunk/src/VBox/Runtime/r0drv/linux/the-linux-kernel.h@ 58591

Last change on this file since 58591 was 57323, checked in by vboxsync, 9 years ago

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette