SUPLibInternal.h@ 15531

Last change on this file since 15531 was 13865, checked in by vboxsync, 16 years ago
SUP: pass idCpu up on all platforms (save OS/2), handle it in ring-0 on solaris, linux and freebsd.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 11.0 KB

Line
1	/* $Id: SUPLibInternal.h 13865 2008-11-05 14:14:11Z vboxsync $ */
2	/** @file
3	* VirtualBox Support Library - Internal header.
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 ___SUPLibInternal_h___
32	#define ___SUPLibInternal_h___
33
34	#include <VBox/cdefs.h>
35	#include <VBox/types.h>
36	#include <iprt/stdarg.h>
37
38
39	/*******************************************************************************
40	* Defined Constants And Macros *
41	*******************************************************************************/
42	/** @def SUPLIB_DLL_SUFF
43	* The (typical) DLL/DYLIB/SO suffix. */
44	#if defined(RT_OS_DARWIN)
45	# define SUPLIB_DLL_SUFF ".dylib"
46	#elif defined(RT_OS_L4)
47	# define SUPLIB_DLL_SUFF ".s.so"
48	#elif defined(RT_OS_OS2) \|\| defined(RT_OS_WINDOWS)
49	# define SUPLIB_DLL_SUFF ".dll"
50	#else
51	# define SUPLIB_DLL_SUFF ".so"
52	#endif
53
54	/** @def SUPLIB_EXE_SUFF
55	* The (typical) executable suffix. */
56	#if defined(RT_OS_OS2) \|\| defined(RT_OS_WINDOWS)
57	# define SUPLIB_EXE_SUFF ".exe"
58	#else
59	# define SUPLIB_EXE_SUFF ""
60	#endif
61
62	/** @def SUP_HARDENED_SUID
63	* Whether we're employing set-user-ID-on-execute in the hardening.
64	*/
65	#if !defined(RT_OS_OS2) && !defined(RT_OS_WINDOWS) && !defined(RT_OS_L4)
66	# define SUP_HARDENED_SUID
67	#else
68	# undef SUP_HARDENED_SUID
69	#endif
70
71	#ifdef IN_SUP_HARDENED_R3
72	/** @name Make the symbols in SUPR3HardenedStatic different from the VBoxRT ones.
73	* We cannot rely on DECLHIDDEN to make this separation for us since it doesn't
74	* work with all GCC versions. So, we resort to old fashion precompiler hacking.
75	* @{
76	*/
77	# define supR3HardenedPathAppPrivateNoArch supR3HardenedStaticPathAppPrivateNoArch
78	# define supR3HardenedPathAppPrivateArch supR3HardenedStaticPathAppPrivateArch
79	# define supR3HardenedPathSharedLibs supR3HardenedStaticPathSharedLibs
80	# define supR3HardenedPathAppDocs supR3HardenedStaticPathAppDocs
81	# define supR3HardenedPathProgram supR3HardenedStaticPathProgram
82	# define supR3HardenedPathFilename supR3HardenedStaticPathFilename
83	# define supR3HardenedFatalV supR3HardenedStaticFatalV
84	# define supR3HardenedFatal supR3HardenedStaticFatal
85	# define supR3HardenedFatalMsgV supR3HardenedStaticFatalMsgV
86	# define supR3HardenedFatalMsg supR3HardenedStaticFatalMsg
87	# define supR3HardenedErrorV supR3HardenedStaticErrorV
88	# define supR3HardenedError supR3HardenedStaticError
89	# define supR3HardenedVerifyAll supR3HardenedStaticVerifyAll
90	# define supR3HardenedVerifyDir supR3HardenedStaticVerifyDir
91	# define supR3HardenedVerifyFile supR3HardenedStaticVerifyFile
92	# define supR3HardenedGetPreInitData supR3HardenedStaticGetPreInitData
93	# define supR3HardenedRecvPreInitData supR3HardenedStaticRecvPreInitData
94	/** @} */
95	#endif /* IN_SUP_HARDENED_R3 */
96
97
98	/*******************************************************************************
99	* Global Variables *
100	*******************************************************************************/
101	/** The negotiated interrupt number. */
102	extern DECLHIDDEN(uint8_t) g_uchInterruptNo;
103	/** The negotiated cookie. */
104	extern DECLHIDDEN(uint32_t) g_u32Cookie;
105	/** The negotiated cookie. */
106	extern DECLHIDDEN(uint32_t) g_u32CookieSession;
107
108
109	/*******************************************************************************
110	* Structures and Typedefs *
111	*******************************************************************************/
112	/**
113	* The type of an installed file.
114	*/
115	typedef enum SUPINSTFILETYPE
116	{
117	kSupIFT_Invalid = 0,
118	kSupIFT_Exe,
119	kSupIFT_Dll,
120	kSupIFT_Sys,
121	kSupIFT_Script,
122	kSupIFT_Data,
123	kSupIFT_End
124	} SUPINSTFILETYPE;
125
126	/**
127	* Installation directory specifier.
128	*/
129	typedef enum SUPINSTDIR
130	{
131	kSupID_Invalid = 0,
132	kSupID_Bin,
133	kSupID_AppBin,
134	kSupID_SharedLib,
135	kSupID_AppPrivArch,
136	kSupID_AppPrivArchComp,
137	kSupID_AppPrivNoArch,
138	kSupID_End
139	} SUPINSTDIR;
140
141	/**
142	* Installed file.
143	*/
144	typedef struct SUPINSTFILE
145	{
146	/** File type. */
147	SUPINSTFILETYPE enmType;
148	/** Install directory. */
149	SUPINSTDIR enmDir;
150	/** Optional (true) or mandatory (false. */
151	bool fOptional;
152	/** File name. */
153	const char *pszFile;
154	} SUPINSTFILE;
155	typedef SUPINSTFILE *PSUPINSTFILE;
156	typedef SUPINSTFILE const *PCSUPINSTFILE;
157
158	/**
159	* Status data for a verified file.
160	*/
161	typedef struct SUPVERIFIEDFILE
162	{
163	/** The file handle or descriptor. -1 if not open. */
164	intptr_t hFile;
165	/** Whether the file has been validated. */
166	bool fValidated;
167	} SUPVERIFIEDFILE;
168	typedef SUPVERIFIEDFILE *PSUPVERIFIEDFILE;
169	typedef SUPVERIFIEDFILE const *PCSUPVERIFIEDFILE;
170
171	/**
172	* Status data for a verified directory.
173	*/
174	typedef struct SUPVERIFIEDDIR
175	{
176	/** The directory handle or descriptor. -1 if not open. */
177	intptr_t hDir;
178	/** Whether the directory has been validated. */
179	bool fValidated;
180	} SUPVERIFIEDDIR;
181	typedef SUPVERIFIEDDIR *PSUPVERIFIEDDIR;
182	typedef SUPVERIFIEDDIR const *PCSUPVERIFIEDDIR;
183
184
185	/**
186	* SUPLib instance data.
187	*
188	* This is data that is passed from the static to the dynamic SUPLib
189	* in a hardened setup.
190	*/
191	typedef struct SUPLIBDATA
192	{
193	/** The device handle. */
194	RTFILE hDevice;
195	#if defined(RT_OS_DARWIN)
196	/** The connection to the VBoxSupDrv service. */
197	void *pvConnection;
198	#elif defined(RT_OS_LINUX)
199	/** Indicates whether madvise(,,MADV_DONTFORK) works. */
200	bool fSysMadviseWorks;
201	#elif defined(RT_OS_WINDOWS)
202	#endif
203	} SUPLIBDATA;
204	/** Pointer to the pre-init data. */
205	typedef SUPLIBDATA *PSUPLIBDATA;
206	/** Pointer to const pre-init data. */
207	typedef SUPLIBDATA const *PCSUPLIBDATA;
208
209
210	/**
211	* Pre-init data that is handed over from the hardened executable stub.
212	*/
213	typedef struct SUPPREINITDATA
214	{
215	/** Magic value (SUPPREINITDATA_MAGIC). */
216	uint32_t u32Magic;
217	/** The SUPLib instance data. */
218	SUPLIBDATA Data;
219	/** The number of entries in paInstallFiles and paVerifiedFiles. */
220	size_t cInstallFiles;
221	/** g_aSupInstallFiles. */
222	PCSUPINSTFILE paInstallFiles;
223	/** g_aSupVerifiedFiles. */
224	PCSUPVERIFIEDFILE paVerifiedFiles;
225	/** The number of entries in paVerifiedDirs. */
226	size_t cVerifiedDirs;
227	/** g_aSupVerifiedDirs. */
228	PCSUPVERIFIEDDIR paVerifiedDirs;
229	/** Magic value (SUPPREINITDATA_MAGIC). */
230	uint32_t u32EndMagic;
231	} SUPPREINITDATA;
232	typedef SUPPREINITDATA *PSUPPREINITDATA;
233	typedef SUPPREINITDATA const *PCSUPPREINITDATA;
234
235	/** Magic value for SUPPREINITDATA::u32Magic and SUPPREINITDATA::u32EndMagic. */
236	#define SUPPREINITDATA_MAGIC UINT32_C(0xbeef0001)
237
238	/** @copydoc supR3PreInit */
239	typedef DECLCALLBACK(int) FNSUPR3PREINIT(PSUPPREINITDATA pPreInitData, uint32_t fFlags);
240	/** Pointer to supR3PreInit. */
241	typedef FNSUPR3PREINIT *PFNSUPR3PREINIT;
242
243
244	/*******************************************************************************
245	* OS Specific Function *
246	*******************************************************************************/
247	__BEGIN_DECLS
248	int suplibOsInstall(void);
249	int suplibOsUninstall(void);
250	int suplibOsInit(PSUPLIBDATA pThis, bool fPreInited);
251	int suplibOsTerm(PSUPLIBDATA pThis);
252	int suplibOsIOCtl(PSUPLIBDATA pThis, uintptr_t uFunction, void *pvReq, size_t cbReq);
253	int suplibOsIOCtlFast(PSUPLIBDATA pThis, uintptr_t uFunction, uintptr_t idCpu);
254	int suplibOsPageAlloc(PSUPLIBDATA pThis, size_t cPages, void **ppvPages);
255	int suplibOsPageFree(PSUPLIBDATA pThis, void *pvPages, size_t cPages);
256
257
258	/**
259	* Performs the pre-initialization of the support library.
260	*
261	* This is dynamically resolved and invoked by the static library before it
262	* calls RTR3Init and thereby SUPR3Init.
263	*
264	* @returns IPRT status code.
265	* @param pPreInitData The pre init data.
266	* @param fFlags The SUPR3HardenedMain flags.
267	*/
268	DECLEXPORT(int) supR3PreInit(PSUPPREINITDATA pPreInitData, uint32_t fFlags);
269
270
271	/** @copydoc RTPathAppPrivateNoArch */
272	DECLHIDDEN(int) supR3HardenedPathAppPrivateNoArch(char *pszPath, size_t cchPath);
273	/** @copydoc RTPathAppPrivateArch */
274	DECLHIDDEN(int) supR3HardenedPathAppPrivateArch(char *pszPath, size_t cchPath);
275	/** @copydoc RTPathSharedLibs */
276	DECLHIDDEN(int) supR3HardenedPathSharedLibs(char *pszPath, size_t cchPath);
277	/** @copydoc RTPathAppDocs */
278	DECLHIDDEN(int) supR3HardenedPathAppDocs(char *pszPath, size_t cchPath);
279	/** @copydoc RTPathProgram */
280	DECLHIDDEN(int) supR3HardenedPathProgram(char *pszPath, size_t cchPath);
281	/** @copydoc RTPathFilename */
282	DECLHIDDEN(char ) supR3HardenedPathFilename(const char pszPath);
283
284	/**
285	* Display a fatal error and try call TrustedError or quit.
286	*/
287	DECLHIDDEN(void) supR3HardenedFatalMsgV(const char pszWhere, SUPINITOP enmWhat, int rc, const char pszMsgFmt, va_list va);
288
289	/**
290	* Display a fatal error and try call TrustedError or quit.
291	*/
292	DECLHIDDEN(void) supR3HardenedFatalMsg(const char pszWhere, SUPINITOP enmWhat, int rc, const char pszMsgFmt, ...);
293
294	/**
295	* Display a fatal error and quit.
296	*/
297	DECLHIDDEN(void) supR3HardenedFatalV(const char *pszFormat, va_list va);
298
299	/**
300	* Display a fatal error and quit.
301	*/
302	DECLHIDDEN(void) supR3HardenedFatal(const char *pszFormat, ...);
303
304	/**
305	* Display an error which may or may not be fatal.
306	*/
307	DECLHIDDEN(int) supR3HardenedErrorV(int rc, bool fFatal, const char *pszFormat, va_list va);
308
309	/**
310	* Display an error which may or may not be fatal.
311	*/
312	DECLHIDDEN(int) supR3HardenedError(int rc, bool fFatal, const char *pszFormat, ...);
313	DECLHIDDEN(int) supR3HardenedVerifyAll(bool fFatal, bool fLeaveFilesOpen, const char *pszProgName);
314	DECLHIDDEN(int) supR3HardenedVerifyDir(SUPINSTDIR enmDir, bool fFatal);
315	DECLHIDDEN(int) supR3HardenedVerifyFile(const char *pszFilename, bool fFatal);
316	DECLHIDDEN(void) supR3HardenedGetPreInitData(PSUPPREINITDATA pPreInitData);
317	DECLHIDDEN(int) supR3HardenedRecvPreInitData(PCSUPPREINITDATA pPreInitData);
318
319
320	__END_DECLS
321
322
323	#endif
324

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

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPLibInternal.h@ 15531

Download in other formats: