the-linux-kernel.h@ 9563

Last change on this file since 9563 was 9442, checked in by vboxsync, 17 years ago
Fixed TICK_NSEC (1000 times too small).
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 8.7 KB

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

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: