SUPLibInternal.h@ 40282

Last change on this file since 40282 was 38636, checked in by vboxsync, 13 years ago
*,IPRT: Redid the ring-3 init to always convert the arguments to UTF-8.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 11.9 KB

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

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

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

Download in other formats: