the-linux-kernel.h@ 35857

Last change on this file since 35857 was 35662, checked in by vboxsync, 14 years ago
fix for r69559
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 10.6 KB

Line
1	/* $Id: the-linux-kernel.h 35662 2011-01-20 18:11:08Z vboxsync $ */
2	/** @file
3	* IPRT - Include all necessary headers for the Linux kernel.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 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	#include <linux/string.h>
68	#include <linux/spinlock.h>
69	#include <linux/slab.h>
70	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 27)
71	# include <linux/semaphore.h>
72	#else /* older kernels */
73	# include <asm/semaphore.h>
74	#endif /* older kernels */
75	#include <linux/module.h>
76	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
77	# include <linux/moduleparam.h>
78	#endif
79	#include <linux/kernel.h>
80	#include <linux/init.h>
81	#include <linux/fs.h>
82	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
83	# include <linux/namei.h>
84	#endif
85	#include <linux/mm.h>
86	#include <linux/pagemap.h>
87	#include <linux/slab.h>
88	#include <linux/time.h>
89	#include <linux/sched.h>
90	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 7)
91	# include <linux/jiffies.h>
92	#endif
93	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 16)
94	# include <linux/ktime.h>
95	# include <linux/hrtimer.h>
96	#endif
97	#include <linux/wait.h>
98	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 5, 71)
99	# include <linux/cpu.h>
100	# include <linux/notifier.h>
101	#endif
102	/* For the basic additions module */
103	#include <linux/pci.h>
104	#include <linux/delay.h>
105	#include <linux/interrupt.h>
106	#include <linux/completion.h>
107	#include <linux/compiler.h>
108	#ifndef HAVE_UNLOCKED_IOCTL /* linux/fs.h defines this */
109	# include <linux/smp_lock.h>
110	#endif
111	/* For the shared folders module */
112	#include <linux/vmalloc.h>
113	#define wchar_t linux_wchar_t
114	#include <linux/nls.h>
115	#undef wchar_t
116	#include <asm/mman.h>
117	#include <asm/io.h>
118	#include <asm/uaccess.h>
119	#include <asm/div64.h>
120
121	#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
122	# ifndef page_to_pfn
123	# define page_to_pfn(page) ((page) - mem_map)
124	# endif
125	#endif
126
127	#ifndef DEFINE_WAIT
128	# define DEFINE_WAIT(name) DECLARE_WAITQUEUE(name, current)
129	#endif
130
131	/*
132	* 2.4 / early 2.6 compatibility wrappers
133	*/
134	#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 7)
135
136	# ifndef MAX_JIFFY_OFFSET
137	# define MAX_JIFFY_OFFSET ((~0UL >> 1)-1)
138	# endif
139
140	# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 29) \|\| LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)
141
142	DECLINLINE(unsigned int) jiffies_to_msecs(unsigned long cJiffies)
143	{
144	# if HZ <= 1000 && !(1000 % HZ)
145	return (1000 / HZ) * cJiffies;
146	# elif HZ > 1000 && !(HZ % 1000)
147	return (cJiffies + (HZ / 1000) - 1) / (HZ / 1000);
148	# else
149	return (cJiffies * 1000) / HZ;
150	# endif
151	}
152
153	DECLINLINE(unsigned long) msecs_to_jiffies(unsigned int cMillies)
154	{
155	# if HZ > 1000
156	if (cMillies > jiffies_to_msecs(MAX_JIFFY_OFFSET))
157	return MAX_JIFFY_OFFSET;
158	# endif
159	# if HZ <= 1000 && !(1000 % HZ)
160	return (cMillies + (1000 / HZ) - 1) / (1000 / HZ);
161	# elif HZ > 1000 && !(HZ % 1000)
162	return cMillies * (HZ / 1000);
163	# else
164	return (cMillies * HZ + 999) / 1000;
165	# endif
166	}
167
168	# endif /* < 2.4.29 \|\| >= 2.6.0 */
169
170	#endif /* < 2.6.7 */
171
172	/*
173	* 2.4 compatibility wrappers
174	*/
175	#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
176
177	# define prepare_to_wait(q, wait, state) \
178	do { \
179	add_wait_queue(q, wait); \
180	set_current_state(state); \
181	} while (0)
182
183	# define after_wait(wait) \
184	do { \
185	list_del_init(&(wait)->task_list); \
186	} while (0)
187
188	# define finish_wait(q, wait) \
189	do { \
190	set_current_state(TASK_RUNNING); \
191	remove_wait_queue(q, wait); \
192	} while (0)
193
194	#else /* >= 2.6.0 */
195
196	# define after_wait(wait) do {} while (0)
197
198	#endif /* >= 2.6.0 */
199
200	/** @def TICK_NSEC
201	* The time between ticks in nsec */
202	#ifndef TICK_NSEC
203	# define TICK_NSEC (1000000000UL / HZ)
204	#endif
205
206	/*
207	* This sucks soooo badly on x86! Why don't they export __PAGE_KERNEL_EXEC so PAGE_KERNEL_EXEC would be usable?
208	*/
209	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 8) && defined(RT_ARCH_AMD64)
210	# define MY_PAGE_KERNEL_EXEC PAGE_KERNEL_EXEC
211	#elif LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 8) && defined(PAGE_KERNEL_EXEC) && defined(CONFIG_X86_PAE)
212	# ifdef __PAGE_KERNEL_EXEC
213	/* >= 2.6.27 */
214	# define MY_PAGE_KERNEL_EXEC __pgprot(cpu_has_pge ? __PAGE_KERNEL_EXEC \| _PAGE_GLOBAL : __PAGE_KERNEL_EXEC)
215	# else
216	# define MY_PAGE_KERNEL_EXEC __pgprot(cpu_has_pge ? _PAGE_KERNEL_EXEC \| _PAGE_GLOBAL : _PAGE_KERNEL_EXEC)
217	# endif
218	#else
219	# define MY_PAGE_KERNEL_EXEC PAGE_KERNEL
220	#endif
221
222
223	/*
224	* The redhat hack section.
225	* - The current hacks are for 2.4.21-15.EL only.
226	*/
227	#ifndef NO_REDHAT_HACKS
228	/* accounting. */
229	# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
230	# ifdef VM_ACCOUNT
231	# define MY_DO_MUNMAP(a,b,c) do_munmap(a, b, c, 0) /* should it be 1 or 0? */
232	# endif
233	# endif
234
235	/* backported remap_page_range. */
236	# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)
237	# include <asm/tlb.h>
238	# ifdef tlb_vma /* probably not good enough... */
239	# define HAVE_26_STYLE_REMAP_PAGE_RANGE 1
240	# endif
241	# endif
242
243	# ifndef RT_ARCH_AMD64
244	/* In 2.6.9-22.ELsmp we have to call change_page_attr() twice when changing
245	* the page attributes from PAGE_KERNEL to something else, because there appears
246	* to be a bug in one of the many patches that redhat applied.
247	* It should be safe to do this on less buggy linux kernels too. ;-)
248	*/
249	# define MY_CHANGE_PAGE_ATTR(pPages, cPages, prot) \
250	do { \
251	if (pgprot_val(prot) != pgprot_val(PAGE_KERNEL)) \
252	change_page_attr(pPages, cPages, prot); \
253	change_page_attr(pPages, cPages, prot); \
254	} while (0)
255	# endif /* !RT_ARCH_AMD64 */
256	#endif /* !NO_REDHAT_HACKS */
257
258	#ifndef MY_DO_MUNMAP
259	# define MY_DO_MUNMAP(a,b,c) do_munmap(a, b, c)
260	#endif
261
262	#ifndef MY_CHANGE_PAGE_ATTR
263	# ifdef RT_ARCH_AMD64 /** @todo This is a cheap hack, but it'll get around that 'else BUG();' in __change_page_attr(). */
264	# define MY_CHANGE_PAGE_ATTR(pPages, cPages, prot) \
265	do { \
266	change_page_attr(pPages, cPages, PAGE_KERNEL_NOCACHE); \
267	change_page_attr(pPages, cPages, prot); \
268	} while (0)
269	# else
270	# define MY_CHANGE_PAGE_ATTR(pPages, cPages, prot) change_page_attr(pPages, cPages, prot)
271	# endif
272	#endif
273
274	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 25)
275	# define MY_SET_PAGES_EXEC(pPages, cPages) set_pages_x(pPages, cPages)
276	# define MY_SET_PAGES_NOEXEC(pPages, cPages) set_pages_nx(pPages, cPages)
277	#else
278	# define MY_SET_PAGES_EXEC(pPages, cPages) \
279	do { \
280	if (pgprot_val(MY_PAGE_KERNEL_EXEC) != pgprot_val(PAGE_KERNEL)) \
281	MY_CHANGE_PAGE_ATTR(pPages, cPages, MY_PAGE_KERNEL_EXEC); \
282	} while (0)
283	# define MY_SET_PAGES_NOEXEC(pPages, cPages) \
284	do { \
285	if (pgprot_val(MY_PAGE_KERNEL_EXEC) != pgprot_val(PAGE_KERNEL)) \
286	MY_CHANGE_PAGE_ATTR(pPages, cPages, PAGE_KERNEL); \
287	} while (0)
288	#endif
289
290	/** @def ONE_MSEC_IN_JIFFIES
291	* The number of jiffies that make up 1 millisecond. Must be at least 1! */
292	#if HZ <= 1000
293	# define ONE_MSEC_IN_JIFFIES 1
294	#elif !(HZ % 1000)
295	# define ONE_MSEC_IN_JIFFIES (HZ / 1000)
296	#else
297	# define ONE_MSEC_IN_JIFFIES ((HZ + 999) / 1000)
298	# error "HZ is not a multiple of 1000, the GIP stuff won't work right!"
299	#endif
300
301	/*
302	* Stop using the linux bool type.
303	*/
304	#undef bool
305
306	/*
307	* There are post-2.6.24 kernels (confusingly with unchanged version number)
308	* which eliminate macros which were marked as deprecated.
309	*/
310	#ifndef __attribute_used__
311	#define __attribute_used__ __used
312	#endif
313
314	/**
315	* Hack for shortening pointers on linux so we can stuff more stuff into the
316	* task_struct::comm field. This is used by the semaphore code but put here
317	* because we don't have any better place atm. Don't use outside IPRT, please.
318	*/
319	#ifdef RT_ARCH_AMD64
320	# define IPRT_DEBUG_SEMS_ADDRESS(addr) ( ((long)(addr) & (long)~UINT64_C(0xfffffff000000000)) )
321	#else
322	# define IPRT_DEBUG_SEMS_ADDRESS(addr) ( (long)(addr) )
323	#endif
324
325	/**
326	* Puts semaphore info into the task_struct::comm field if IPRT_DEBUG_SEMS is
327	* defined.
328	*/
329	#ifdef IPRT_DEBUG_SEMS
330	# define IPRT_DEBUG_SEMS_STATE(pThis, chState) \
331	snprintf(current->comm, sizeof(current->comm), "%c%lx", (chState), IPRT_DEBUG_SEMS_ADDRESS(pThis));
332	#else
333	# define IPRT_DEBUG_SEMS_STATE(pThis, chState) do { } while (0)
334	#endif
335
336	/**
337	* Puts semaphore info into the task_struct::comm field if IPRT_DEBUG_SEMS is
338	* defined.
339	*/
340	#ifdef IPRT_DEBUG_SEMS
341	# define IPRT_DEBUG_SEMS_STATE_RC(pThis, chState, rc) \
342	snprintf(current->comm, sizeof(current->comm), "%c%lx:%d", (chState), IPRT_DEBUG_SEMS_ADDRESS(pThis), rc);
343	#else
344	# define IPRT_DEBUG_SEMS_STATE_RC(pThis, chState, rc) do { } while (0)
345	#endif
346
347	/*
348	* There are some conflicting defines in iprt/param.h, sort them out here.
349	*/
350	#ifndef ___iprt_param_h
351	# undef PAGE_SIZE
352	# undef PAGE_OFFSET_MASK
353	# include <iprt/param.h>
354	#endif
355
356	/*
357	* Some global indicator macros.
358	*/
359	/** @def IPRT_LINUX_HAS_HRTIMER
360	* Whether the kernel support high resolution timers (Linux kernel versions
361	* 2.6.28 and later (hrtimer_add_expires_ns() & schedule_hrtimeout). */
362	#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 28)
363	# define IPRT_LINUX_HAS_HRTIMER
364	#endif
365
366
367	#endif
368

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

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

Download in other formats: