hgcmsvc.h@ 29567

Last change on this file since 29567 was 28800, checked in by vboxsync, 15 years ago
Automated rebranding to Oracle copyright/license strings via filemuncher
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 13.5 KB

Line
1	/** @file
2	* Host-Guest Communication Manager (HGCM) - Service library definitions.
3	*/
4
5	/*
6	* Copyright (C) 2006-2007 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___VBox_hgcm_h
27	#define ___VBox_hgcm_h
28
29	#include <iprt/assert.h>
30	#include <iprt/string.h>
31	#include <VBox/cdefs.h>
32	#include <VBox/types.h>
33	#include <VBox/err.h>
34	#ifdef VBOX_TEST_HGCM_PARMS
35	# include <iprt/test.h>
36	#endif
37
38	/** @todo proper comments. */
39
40	/**
41	* Service interface version.
42	*
43	* Includes layout of both VBOXHGCMSVCFNTABLE and VBOXHGCMSVCHELPERS.
44	*
45	* A service can work with these structures if major version
46	* is equal and minor version of service is <= version of the
47	* structures.
48	*
49	* For example when a new helper is added at the end of helpers
50	* structure, then the minor version will be increased. All older
51	* services still can work because they have their old helpers
52	* unchanged.
53	*
54	* Revision history.
55	* 1.1->2.1 Because the pfnConnect now also has the pvClient parameter.
56	* 2.1->2.2 Because pfnSaveState and pfnLoadState were added
57	* 2.2->3.1 Because pfnHostCall is now synchronous, returns rc, and parameters were changed
58	* 3.1->3.2 Because pfnRegisterExtension was added
59	* 3.2->3.3 Because pfnDisconnectClient helper was added
60	* 3.3->4.1 Because the pvService entry and parameter was added
61	* 4.1->4.2 Because the VBOX_HGCM_SVC_PARM_CALLBACK parameter type was added
62	* 4.2->5.1 Removed the VBOX_HGCM_SVC_PARM_CALLBACK parameter type, as
63	* this problem is already solved by service extension callbacks
64	*/
65	#define VBOX_HGCM_SVC_VERSION_MAJOR (0x0005)
66	#define VBOX_HGCM_SVC_VERSION_MINOR (0x0001)
67	#define VBOX_HGCM_SVC_VERSION ((VBOX_HGCM_SVC_VERSION_MAJOR << 16) + VBOX_HGCM_SVC_VERSION_MINOR)
68
69
70	/** Typed pointer to distinguish a call to service. */
71	struct VBOXHGCMCALLHANDLE_TYPEDEF;
72	typedef struct VBOXHGCMCALLHANDLE_TYPEDEF *VBOXHGCMCALLHANDLE;
73
74	/** Service helpers pointers table. */
75	typedef struct _VBOXHGCMSVCHELPERS
76	{
77	/** The service has processed the Call request. */
78	DECLR3CALLBACKMEMBER(void, pfnCallComplete, (VBOXHGCMCALLHANDLE callHandle, int32_t rc));
79
80	void *pvInstance;
81
82	/** The service disconnects the client. */
83	DECLR3CALLBACKMEMBER(void, pfnDisconnectClient, (void *pvInstance, uint32_t u32ClientID));
84	} VBOXHGCMSVCHELPERS;
85
86	typedef VBOXHGCMSVCHELPERS *PVBOXHGCMSVCHELPERS;
87
88
89	#define VBOX_HGCM_SVC_PARM_INVALID (0U)
90	#define VBOX_HGCM_SVC_PARM_32BIT (1U)
91	#define VBOX_HGCM_SVC_PARM_64BIT (2U)
92	#define VBOX_HGCM_SVC_PARM_PTR (3U)
93
94	typedef struct VBOXHGCMSVCPARM
95	{
96	/** VBOX_HGCM_SVC_PARM_* values. */
97	uint32_t type;
98
99	union
100	{
101	uint32_t uint32;
102	uint64_t uint64;
103	struct
104	{
105	uint32_t size;
106	void *addr;
107	} pointer;
108	} u;
109	#ifdef __cplusplus
110	/** Extract a uint32_t value from an HGCM parameter structure */
111	int getUInt32 (uint32_t *u32)
112	{
113	AssertPtrReturn(u32, VERR_INVALID_POINTER);
114	int rc = VINF_SUCCESS;
115	if (type != VBOX_HGCM_SVC_PARM_32BIT)
116	rc = VERR_INVALID_PARAMETER;
117	if (RT_SUCCESS(rc))
118	*u32 = u.uint32;
119	return rc;
120	}
121
122	/** Extract a uint64_t value from an HGCM parameter structure */
123	int getUInt64 (uint64_t *u64)
124	{
125	AssertPtrReturn(u64, VERR_INVALID_POINTER);
126	int rc = VINF_SUCCESS;
127	if (type != VBOX_HGCM_SVC_PARM_64BIT)
128	rc = VERR_INVALID_PARAMETER;
129	if (RT_SUCCESS(rc))
130	*u64 = u.uint64;
131	return rc;
132	}
133
134	/** Extract a pointer value from an HGCM parameter structure */
135	int getPointer (void *ppv, uint32_t pcb)
136	{
137	AssertPtrReturn(ppv, VERR_INVALID_POINTER);
138	AssertPtrReturn(pcb, VERR_INVALID_POINTER);
139	if (type == VBOX_HGCM_SVC_PARM_PTR)
140	{
141	*ppv = u.pointer.addr;
142	*pcb = u.pointer.size;
143	return VINF_SUCCESS;
144	}
145
146	return VERR_INVALID_PARAMETER;
147	}
148
149	/** Extract a constant pointer value from an HGCM parameter structure */
150	int getPointer (const void *ppcv, uint32_t pcb)
151	{
152	AssertPtrReturn(ppcv, VERR_INVALID_POINTER);
153	AssertPtrReturn(pcb, VERR_INVALID_POINTER);
154	void *pv;
155	int rc = getPointer(&pv, pcb);
156	*ppcv = pv;
157	return rc;
158	}
159
160	/** Extract a pointer value to a non-empty buffer from an HGCM parameter
161	* structure */
162	int getBuffer (void *ppv, uint32_t pcb)
163	{
164	AssertPtrReturn(ppv, VERR_INVALID_POINTER);
165	AssertPtrReturn(pcb, VERR_INVALID_POINTER);
166	void *pv = NULL;
167	uint32_t cb = 0;
168	int rc = getPointer(&pv, &cb);
169	if ( RT_SUCCESS(rc)
170	&& VALID_PTR(pv)
171	&& cb > 0)
172	{
173	*ppv = pv;
174	*pcb = cb;
175	return VINF_SUCCESS;
176	}
177
178	return VERR_INVALID_PARAMETER;
179	}
180
181	/** Extract a pointer value to a non-empty constant buffer from an HGCM
182	* parameter structure */
183	int getBuffer (const void *ppcv, uint32_t pcb)
184	{
185	AssertPtrReturn(ppcv, VERR_INVALID_POINTER);
186	AssertPtrReturn(pcb, VERR_INVALID_POINTER);
187	void *pcv = NULL;
188	int rc = getBuffer(&pcv, pcb);
189	*ppcv = pcv;
190	return rc;
191	}
192
193	/** Extract a string value from an HGCM parameter structure */
194	int getString (char *ppch, uint32_t pcb)
195	{
196	uint32_t cb = 0;
197	char *pch = NULL;
198	int rc = getBuffer((void **)&pch, &cb);
199	if (RT_FAILURE(rc))
200	{
201	*ppch = NULL;
202	*pcb = 0;
203	return rc;
204	}
205	rc = RTStrValidateEncodingEx(pch, cb,
206	RTSTR_VALIDATE_ENCODING_ZERO_TERMINATED);
207	*ppch = pch;
208	*pcb = cb;
209	return rc;
210	}
211
212	/** Extract a constant string value from an HGCM parameter structure */
213	int getString (const char *ppcch, uint32_t pcb)
214	{
215	char *pch = NULL;
216	int rc = getString(&pch, pcb);
217	*ppcch = pch;
218	return rc;
219	}
220
221	/** Set a uint32_t value to an HGCM parameter structure */
222	void setUInt32(uint32_t u32)
223	{
224	type = VBOX_HGCM_SVC_PARM_32BIT;
225	u.uint32 = u32;
226	}
227
228	/** Set a uint64_t value to an HGCM parameter structure */
229	void setUInt64(uint64_t u64)
230	{
231	type = VBOX_HGCM_SVC_PARM_64BIT;
232	u.uint64 = u64;
233	}
234
235	/** Set a pointer value to an HGCM parameter structure */
236	void setPointer(void *pv, uint32_t cb)
237	{
238	type = VBOX_HGCM_SVC_PARM_PTR;
239	u.pointer.addr = pv;
240	u.pointer.size = cb;
241	}
242
243	#ifdef VBOX_TEST_HGCM_PARMS
244	/** Test the getString member function. Indirectly tests the getPointer
245	* and getBuffer APIs.
246	* @param hTest an running IPRT test
247	* @param aType the type that the parameter should be set to before
248	* calling getString
249	* @param apcc the value that the parameter should be set to before
250	* calling getString, and also the address (!) which we
251	* expect getString to return. Stricter than needed of
252	* course, but I was feeling lazy.
253	* @param acb the size that the parameter should be set to before
254	* calling getString, and also the size which we expect
255	* getString to return.
256	* @param rcExp the expected return value of the call to getString.
257	*/
258	void doTestGetString(RTTEST hTest, uint32_t aType, const char *apcc,
259	uint32_t acb, int rcExp)
260	{
261	/* An RTTest API like this, which would print out an additional line
262	* of context if a test failed, would be nice. This is because the
263	* line number alone doesn't help much here, given that this is a
264	* subroutine called many times. */
265	/*
266	RTTestContextF(hTest,
267	("doTestGetString, aType=%u, apcc=%p, acp=%u, rcExp=%Rrc",
268	aType, apcc, acp, rcExp));
269	*/
270	setPointer((void *)apcc, acb);
271	type = aType; /* in case we don't want VBOX_HGCM_SVC_PARM_PTR */
272	const char *pcc = NULL;
273	uint32_t cb = 0;
274	int rc = getString(&pcc, &cb);
275	RTTEST_CHECK_RC(hTest, rc, rcExp);
276	if (RT_SUCCESS(rcExp))
277	{
278	RTTEST_CHECK_MSG_RETV(hTest, (pcc == apcc),
279	(hTest, "expected %p, got %p", apcc, pcc));
280	RTTEST_CHECK_MSG_RETV(hTest, (cb == acb),
281	(hTest, "expected %u, got %u", acb, cb));
282	}
283	}
284
285	/** Run some unit tests on the getString method and indirectly test
286	* getPointer and getBuffer as well. */
287	void testGetString(RTTEST hTest)
288	{
289	RTTestSub(hTest, "HGCM string parameter handling");
290	doTestGetString(hTest, VBOX_HGCM_SVC_PARM_32BIT, "test", 3,
291	VERR_INVALID_PARAMETER);
292	doTestGetString(hTest, VBOX_HGCM_SVC_PARM_PTR, "test", 5,
293	VINF_SUCCESS);
294	doTestGetString(hTest, VBOX_HGCM_SVC_PARM_PTR, "test", 3,
295	VERR_BUFFER_OVERFLOW);
296	doTestGetString(hTest, VBOX_HGCM_SVC_PARM_PTR, "test\xf0", 6,
297	VERR_INVALID_UTF8_ENCODING);
298	doTestGetString(hTest, VBOX_HGCM_SVC_PARM_PTR, "test", 0,
299	VERR_INVALID_PARAMETER);
300	doTestGetString(hTest, VBOX_HGCM_SVC_PARM_PTR, (const char *)0x1, 5,
301	VERR_INVALID_PARAMETER);
302	RTTestSubDone(hTest);
303	}
304	#endif
305
306	VBOXHGCMSVCPARM() : type(VBOX_HGCM_SVC_PARM_INVALID) {}
307	#endif
308	} VBOXHGCMSVCPARM;
309
310	typedef VBOXHGCMSVCPARM *PVBOXHGCMSVCPARM;
311
312	/** Service specific extension callback.
313	* This callback is called by the service to perform service specific operation.
314	*
315	* @param pvExtension The extension pointer.
316	* @param u32Function What the callback is supposed to do.
317	* @param pvParm The function parameters.
318	* @param cbParm The size of the function parameters.
319	*/
320	typedef DECLCALLBACK(int) FNHGCMSVCEXT(void pvExtension, uint32_t u32Function, void pvParm, uint32_t cbParms);
321	typedef FNHGCMSVCEXT *PFNHGCMSVCEXT;
322
323	/** The Service DLL entry points.
324	*
325	* HGCM will call the DLL "VBoxHGCMSvcLoad"
326	* function and the DLL must fill in the VBOXHGCMSVCFNTABLE
327	* with function pointers.
328	*/
329
330	/* The structure is used in separately compiled binaries so an explicit packing is required. */
331	#pragma pack(1)
332	typedef struct _VBOXHGCMSVCFNTABLE
333	{
334	/** Filled by HGCM */
335
336	/** Size of the structure. */
337	uint32_t cbSize;
338
339	/** Version of the structure, including the helpers. */
340	uint32_t u32Version;
341
342	PVBOXHGCMSVCHELPERS pHelpers;
343
344	/** Filled by the service. */
345
346	/** Size of client information the service want to have. */
347	uint32_t cbClient;
348	#if ARCH_BITS == 64
349	/** Ensure that the following pointers are properly aligned on 64-bit system. */
350	uint32_t u32Alignment0;
351	#endif
352
353	/** Uninitialize service */
354	DECLR3CALLBACKMEMBER(int, pfnUnload, (void *pvService));
355
356	/** Inform the service about a client connection. */
357	DECLR3CALLBACKMEMBER(int, pfnConnect, (void pvService, uint32_t u32ClientID, void pvClient));
358
359	/** Inform the service that the client wants to disconnect. */
360	DECLR3CALLBACKMEMBER(int, pfnDisconnect, (void pvService, uint32_t u32ClientID, void pvClient));
361
362	/** Service entry point.
363	* Return code is passed to pfnCallComplete callback.
364	*/
365	DECLR3CALLBACKMEMBER(void, pfnCall, (void pvService, VBOXHGCMCALLHANDLE callHandle, uint32_t u32ClientID, void pvClient, uint32_t function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]));
366
367	/** Host Service entry point meant for privileged features invisible to the guest.
368	* Return code is passed to pfnCallComplete callback.
369	*/
370	DECLR3CALLBACKMEMBER(int, pfnHostCall, (void *pvService, uint32_t function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]));
371
372	/** Inform the service about a VM save operation. */
373	DECLR3CALLBACKMEMBER(int, pfnSaveState, (void pvService, uint32_t u32ClientID, void pvClient, PSSMHANDLE pSSM));
374
375	/** Inform the service about a VM load operation. */
376	DECLR3CALLBACKMEMBER(int, pfnLoadState, (void pvService, uint32_t u32ClientID, void pvClient, PSSMHANDLE pSSM));
377
378	/** Register a service extension callback. */
379	DECLR3CALLBACKMEMBER(int, pfnRegisterExtension, (void pvService, PFNHGCMSVCEXT pfnExtension, void pvExtension));
380
381	/** User/instance data pointer for the service. */
382	void *pvService;
383
384	} VBOXHGCMSVCFNTABLE;
385	#pragma pack()
386
387
388	/** Service initialization entry point. */
389	typedef DECLCALLBACK(int) VBOXHGCMSVCLOAD(VBOXHGCMSVCFNTABLE *ptable);
390	typedef VBOXHGCMSVCLOAD *PFNVBOXHGCMSVCLOAD;
391	#define VBOX_HGCM_SVCLOAD_NAME "VBoxHGCMSvcLoad"
392
393	#endif

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

source: vbox/trunk/include/VBox/hgcmsvc.h@ 29567

Download in other formats: