VirtualBox

source: vbox/trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR0LibHGCM.cpp@ 70279

Last change on this file since 70279 was 69500, checked in by vboxsync, 7 years ago

*: scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.9 KB
Line 
1/* $Id: VBoxGuestR0LibHGCM.cpp 69500 2017-10-28 15:14:05Z vboxsync $ */
2/** @file
3 * VBoxGuestLib - Host-Guest Communication Manager, ring-0 client drivers.
4 *
5 * These public functions can be only used by other drivers. They all
6 * do an IOCTL to VBoxGuest via IDC.
7 */
8
9/*
10 * Copyright (C) 2006-2017 Oracle Corporation
11 *
12 * This file is part of VirtualBox Open Source Edition (OSE), as
13 * available from http://www.virtualbox.org. This file is free software;
14 * you can redistribute it and/or modify it under the terms of the GNU
15 * General Public License (GPL) as published by the Free Software
16 * Foundation, in version 2 as it comes in the "COPYING" file of the
17 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
18 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
19 *
20 * The contents of this file may alternatively be used under the terms
21 * of the Common Development and Distribution License Version 1.0
22 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
23 * VirtualBox OSE distribution, in which case the provisions of the
24 * CDDL are applicable instead of those of the GPL.
25 *
26 * You may elect to license modified versions of this file under the
27 * terms and conditions of either the GPL or the CDDL or both.
28 */
29
30
31/*********************************************************************************************************************************
32* Header Files *
33*********************************************************************************************************************************/
34#include "VBoxGuestR0LibInternal.h"
35
36#include <iprt/assert.h>
37#include <iprt/semaphore.h>
38#include <iprt/string.h>
39
40#ifdef VBGL_VBOXGUEST
41# error "This file shouldn't be part of the VBoxGuestR0LibBase library that is linked into VBoxGuest. It's client code."
42#endif
43
44
45/*********************************************************************************************************************************
46* Defined Constants And Macros *
47*********************************************************************************************************************************/
48#define VBGL_HGCM_ASSERT_MSG AssertReleaseMsg
49
50
51/*********************************************************************************************************************************
52* Global Variables *
53*********************************************************************************************************************************/
54/**
55 * Fast heap for HGCM handles data.
56 * @{
57 */
58static RTSEMFASTMUTEX g_hMtxHGCMHandleData;
59static struct VBGLHGCMHANDLEDATA g_aHGCMHandleData[64];
60/** @} */
61
62
63/**
64 * Initializes the HGCM VBGL bits.
65 *
66 * @return VBox status code.
67 */
68DECLR0VBGL(int) VbglR0HGCMInit(void)
69{
70 AssertReturn(g_hMtxHGCMHandleData == NIL_RTSEMFASTMUTEX, VINF_ALREADY_INITIALIZED);
71 return RTSemFastMutexCreate(&g_hMtxHGCMHandleData);
72}
73
74/**
75 * Initializes the HGCM VBGL bits.
76 *
77 * @return VBox status code.
78 */
79DECLR0VBGL(int) VbglR0HGCMTerminate(void)
80{
81 RTSemFastMutexDestroy(g_hMtxHGCMHandleData);
82 g_hMtxHGCMHandleData = NIL_RTSEMFASTMUTEX;
83
84 return VINF_SUCCESS;
85}
86
87DECLINLINE(int) vbglR0HandleHeapEnter(void)
88{
89 int rc = RTSemFastMutexRequest(g_hMtxHGCMHandleData);
90
91 VBGL_HGCM_ASSERT_MSG(RT_SUCCESS(rc), ("Failed to request handle heap mutex, rc = %Rrc\n", rc));
92
93 return rc;
94}
95
96DECLINLINE(void) vbglR0HandleHeapLeave(void)
97{
98 RTSemFastMutexRelease(g_hMtxHGCMHandleData);
99}
100
101struct VBGLHGCMHANDLEDATA *vbglR0HGCMHandleAlloc(void)
102{
103 struct VBGLHGCMHANDLEDATA *p = NULL;
104 int rc = vbglR0HandleHeapEnter();
105 if (RT_SUCCESS(rc))
106 {
107 uint32_t i;
108
109 /* Simple linear search in array. This will be called not so often, only connect/disconnect. */
110 /** @todo bitmap for faster search and other obvious optimizations. */
111 for (i = 0; i < RT_ELEMENTS(g_aHGCMHandleData); i++)
112 {
113 if (!g_aHGCMHandleData[i].fAllocated)
114 {
115 p = &g_aHGCMHandleData[i];
116 p->fAllocated = 1;
117 break;
118 }
119 }
120
121 vbglR0HandleHeapLeave();
122
123 VBGL_HGCM_ASSERT_MSG(p != NULL, ("Not enough HGCM handles.\n"));
124 }
125 return p;
126}
127
128void vbglR0HGCMHandleFree(struct VBGLHGCMHANDLEDATA *pHandle)
129{
130 if (pHandle)
131 {
132 int rc = vbglR0HandleHeapEnter();
133 if (RT_SUCCESS(rc))
134 {
135 VBGL_HGCM_ASSERT_MSG(pHandle->fAllocated, ("Freeing not allocated handle.\n"));
136
137 RT_ZERO(*pHandle);
138 vbglR0HandleHeapLeave();
139 }
140 }
141}
142
143DECLR0VBGL(int) VbglR0HGCMConnect(VBGLHGCMHANDLE *pHandle, const char *pszServiceName, HGCMCLIENTID *pidClient)
144{
145 int rc;
146 if (pHandle && pszServiceName && pidClient)
147 {
148 struct VBGLHGCMHANDLEDATA *pHandleData = vbglR0HGCMHandleAlloc();
149 if (pHandleData)
150 {
151 rc = VbglR0IdcOpen(&pHandleData->IdcHandle,
152 VBGL_IOC_VERSION /*uReqVersion*/,
153 VBGL_IOC_VERSION & UINT32_C(0xffff0000) /*uMinVersion*/,
154 NULL /*puSessionVersion*/, NULL /*puDriverVersion*/, NULL /*uDriverRevision*/);
155 if (RT_SUCCESS(rc))
156 {
157 VBGLIOCHGCMCONNECT Info;
158 RT_ZERO(Info);
159 VBGLREQHDR_INIT(&Info.Hdr, HGCM_CONNECT);
160 Info.u.In.Loc.type = VMMDevHGCMLoc_LocalHost_Existing;
161 rc = RTStrCopy(Info.u.In.Loc.u.host.achName, sizeof(Info.u.In.Loc.u.host.achName), pszServiceName);
162 if (RT_SUCCESS(rc))
163 {
164 rc = VbglR0IdcCall(&pHandleData->IdcHandle, VBGL_IOCTL_HGCM_CONNECT, &Info.Hdr, sizeof(Info));
165 if (RT_SUCCESS(rc))
166 {
167 *pidClient = Info.u.Out.idClient;
168 *pHandle = pHandleData;
169 return rc;
170 }
171 }
172
173 VbglR0IdcClose(&pHandleData->IdcHandle);
174 }
175
176 vbglR0HGCMHandleFree(pHandleData);
177 }
178 else
179 rc = VERR_NO_MEMORY;
180 }
181 else
182 rc = VERR_INVALID_PARAMETER;
183 return rc;
184}
185
186DECLR0VBGL(int) VbglR0HGCMDisconnect(VBGLHGCMHANDLE handle, HGCMCLIENTID idClient)
187{
188 int rc;
189 VBGLIOCHGCMDISCONNECT Info;
190
191 RT_ZERO(Info);
192 VBGLREQHDR_INIT(&Info.Hdr, HGCM_DISCONNECT);
193 Info.u.In.idClient = idClient;
194 rc = VbglR0IdcCall(&handle->IdcHandle, VBGL_IOCTL_HGCM_DISCONNECT, &Info.Hdr, sizeof(Info));
195
196 VbglR0IdcClose(&handle->IdcHandle);
197
198 vbglR0HGCMHandleFree(handle);
199
200 return rc;
201}
202
203DECLR0VBGL(int) VbglR0HGCMCallRaw(VBGLHGCMHANDLE handle, PVBGLIOCHGCMCALL pData, uint32_t cbData)
204{
205 VBGL_HGCM_ASSERT_MSG(cbData >= sizeof(VBGLIOCHGCMCALL) + pData->cParms * sizeof(HGCMFunctionParameter),
206 ("cbData = %d, cParms = %d (calculated size %d)\n", cbData, pData->cParms,
207 sizeof(VBGLIOCHGCMCALL) + pData->cParms * sizeof(VBGLIOCHGCMCALL)));
208
209 return VbglR0IdcCallRaw(&handle->IdcHandle, VBGL_IOCTL_HGCM_CALL(cbData), &pData->Hdr, cbData);
210}
211
212DECLR0VBGL(int) VbglR0HGCMCall(VBGLHGCMHANDLE handle, PVBGLIOCHGCMCALL pData, uint32_t cbData)
213{
214 int rc = VbglR0HGCMCallRaw(handle, pData, cbData);
215 if (RT_SUCCESS(rc))
216 rc = pData->Hdr.rc;
217 return rc;
218}
219
220DECLR0VBGL(int) VbglR0HGCMCallUserDataRaw(VBGLHGCMHANDLE handle, PVBGLIOCHGCMCALL pData, uint32_t cbData)
221{
222 VBGL_HGCM_ASSERT_MSG(cbData >= sizeof(VBGLIOCHGCMCALL) + pData->cParms * sizeof(HGCMFunctionParameter),
223 ("cbData = %d, cParms = %d (calculated size %d)\n", cbData, pData->cParms,
224 sizeof(VBGLIOCHGCMCALL) + pData->cParms * sizeof(VBGLIOCHGCMCALL)));
225
226 return VbglR0IdcCallRaw(&handle->IdcHandle, VBGL_IOCTL_HGCM_CALL_WITH_USER_DATA(cbData), &pData->Hdr, cbData);
227}
228
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette