1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
/* $Id$ */
/** @file
* TstHGCMMockUtils.cpp - Utility functions for the HGCM Mocking framework.
*/
/*
* Copyright (C) 2022-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#include <VBox/HostServices/TstHGCMMockUtils.h>
#include <iprt/err.h>
#include <iprt/semaphore.h>
#include <iprt/thread.h>
#include <iprt/types.h>
/*********************************************************************************************************************************
* Context *
*********************************************************************************************************************************/
/**
* Initializes a HGCM Mock utils context.
*
* @param pCtx Context to intiialize.
* @param pSvc HGCM Mock service instance to use.
*/
void TstHGCMUtilsCtxInit(PTSTHGCMUTILSCTX pCtx, PTSTHGCMMOCKSVC pSvc)
{
RT_BZERO(pCtx, sizeof(TSTHGCMUTILSCTX));
pCtx->pSvc = pSvc;
}
/*********************************************************************************************************************************
* Tasks *
*********************************************************************************************************************************/
/**
* Returns the current task of a HGCM Mock utils context.
*
* @returns Current task of a HGCM Mock utils context. NULL if no current task found.
* @param pCtx HGCM Mock utils context.
*/
PTSTHGCMUTILSTASK TstHGCMUtilsTaskGetCurrent(PTSTHGCMUTILSCTX pCtx)
{
/* Currently we only support one task at a time. */
return &pCtx->Task;
}
/**
* Initializes a HGCM Mock utils task.
*
* @returns VBox status code.
* @param pTask Task to initialize.
*/
int TstHGCMUtilsTaskInit(PTSTHGCMUTILSTASK pTask)
{
pTask->pvUser = NULL;
pTask->rcCompleted = pTask->rcExpected = VERR_IPE_UNINITIALIZED_STATUS;
return RTSemEventCreate(&pTask->hEvent);
}
/**
* Destroys a HGCM Mock utils task.
*
* @returns VBox status code.
* @param pTask Task to destroy.
*/
void TstHGCMUtilsTaskDestroy(PTSTHGCMUTILSTASK pTask)
{
RTSemEventDestroy(pTask->hEvent);
}
/**
* Waits for a HGCM Mock utils task to complete.
*
* @returns VBox status code.
* @param pTask Task to wait for.
* @param msTimeout Timeout (in ms) to wait.
*/
int TstHGCMUtilsTaskWait(PTSTHGCMUTILSTASK pTask, RTMSINTERVAL msTimeout)
{
return RTSemEventWait(pTask->hEvent, msTimeout);
}
/**
* Returns if the HGCM Mock utils task has been completed successfully.
*
* @returns \c true if successful, \c false if not.
* @param pTask Task to check.
*/
bool TstHGCMUtilsTaskOk(PTSTHGCMUTILSTASK pTask)
{
return pTask->rcCompleted == pTask->rcExpected;
}
/**
* Returns if the HGCM Mock utils task has been completed (failed or succeeded).
*
* @returns \c true if completed, \c false if (still) running.
* @param pTask Task to check.
*/
bool TstHGCMUtilsTaskCompleted(PTSTHGCMUTILSTASK pTask)
{
return pTask->rcCompleted != VERR_IPE_UNINITIALIZED_STATUS;
}
/**
* Signals a HGCM Mock utils task to complete its operation.
*
* @param pTask Task to complete.
* @param rc Task result to set for completion.
*/
void TstHGCMUtilsTaskSignal(PTSTHGCMUTILSTASK pTask, int rc)
{
AssertMsg(pTask->rcCompleted == VERR_IPE_UNINITIALIZED_STATUS, ("Task already completed\n"));
pTask->rcCompleted = rc;
int rc2 = RTSemEventSignal(pTask->hEvent);
AssertRC(rc2);
}
/*********************************************************************************************************************************
* Threading *
********************************************************************************************************************************/
/**
* Thread worker for the guest side thread.
*
* @returns VBox status code.
* @param hThread Thread handle.
* @param pvUser Pointer of type PTSTHGCMUTILSCTX.
*
* @note Runs in the guest thread.
*/
static DECLCALLBACK(int) tstHGCMUtilsGuestThread(RTTHREAD hThread, void *pvUser)
{
RT_NOREF(hThread);
PTSTHGCMUTILSCTX pCtx = (PTSTHGCMUTILSCTX)pvUser;
AssertPtr(pCtx);
RTThreadUserSignal(hThread);
if (pCtx->Guest.pfnThread)
return pCtx->Guest.pfnThread(pCtx, pCtx->Guest.pvUser);
return VINF_SUCCESS;
}
/**
* Starts the guest side thread.
*
* @returns VBox status code.
* @param pCtx HGCM Mock utils context to start guest thread for.
* @param pFnThread Pointer to custom thread worker function to call within the guest side thread.
* @param pvUser User-supplied pointer to guest thread context data. Optional and can be NULL.
*/
int TstHGCMUtilsGuestThreadStart(PTSTHGCMUTILSCTX pCtx, PFNTSTHGCMUTILSTHREAD pFnThread, void *pvUser)
{
pCtx->Guest.pfnThread = pFnThread;
pCtx->Guest.pvUser = pvUser;
int rc = RTThreadCreate(&pCtx->Guest.hThread, tstHGCMUtilsGuestThread, pCtx, 0, RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE,
"tstShClGst");
if (RT_SUCCESS(rc))
rc = RTThreadUserWait(pCtx->Guest.hThread, RT_MS_30SEC);
return rc;
}
/**
* Stops the guest side thread.
*
* @returns VBox status code.
* @param pCtx HGCM Mock utils context to stop guest thread for.
*/
int TstHGCMUtilsGuestThreadStop(PTSTHGCMUTILSCTX pCtx)
{
ASMAtomicWriteBool(&pCtx->Guest.fShutdown, true);
int rcThread;
int rc = RTThreadWait(pCtx->Guest.hThread, RT_MS_30SEC, &rcThread);
if (RT_SUCCESS(rc))
rc = rcThread;
if (RT_SUCCESS(rc))
pCtx->Guest.hThread = NIL_RTTHREAD;
return rc;
}
/**
* Thread worker function for the host side HGCM service.
*
* @returns VBox status code.
* @param hThread Thread handle.
* @param pvUser Pointer of type PTSTHGCMUTILSCTX.
*
* @note Runs in the host service thread.
*/
static DECLCALLBACK(int) tstHGCMUtilsHostThreadWorker(RTTHREAD hThread, void *pvUser)
{
RT_NOREF(hThread);
PTSTHGCMUTILSCTX pCtx = (PTSTHGCMUTILSCTX)pvUser;
AssertPtr(pCtx);
int rc = VINF_SUCCESS;
RTThreadUserSignal(hThread);
PTSTHGCMMOCKSVC const pSvc = TstHgcmMockSvcInst();
for (;;)
{
if (ASMAtomicReadBool(&pCtx->Host.fShutdown))
break;
/* Wait for a new (mock) HGCM client to connect. */
PTSTHGCMMOCKCLIENT pMockClient = TstHgcmMockSvcWaitForConnectEx(pSvc, 100 /* ms */);
if (pMockClient) /* Might be NULL when timed out. */
{
if (pCtx->Host.Callbacks.pfnOnClientConnected)
/* ignore rc */ pCtx->Host.Callbacks.pfnOnClientConnected(pCtx, pMockClient, pCtx->Host.pvUser);
}
}
return rc;
}
/**
* Starts the host side thread.
*
* @returns VBox status code.
* @param pCtx HGCM Mock utils context to start host thread for.
* @param pCallbacks Pointer to host callback table to use.
* @param pvUser User-supplied pointer to reach into the host thread callbacks.
*/
int TstHGCMUtilsHostThreadStart(PTSTHGCMUTILSCTX pCtx, PTSTHGCMUTILSHOSTCALLBACKS pCallbacks, void *pvUser)
{
memcpy(&pCtx->Host.Callbacks, pCallbacks, sizeof(TSTHGCMUTILSHOSTCALLBACKS));
pCtx->Host.pvUser = pvUser;
int rc = RTThreadCreate(&pCtx->Host.hThread, tstHGCMUtilsHostThreadWorker, pCtx, 0, RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE,
"tstShClHst");
if (RT_SUCCESS(rc))
rc = RTThreadUserWait(pCtx->Host.hThread, RT_MS_30SEC);
return rc;
}
/**
* Stops the host side thread.
*
* @returns VBox status code.
* @param pCtx HGCM Mock utils context to stop host thread for.
*/
int TstHGCMUtilsHostThreadStop(PTSTHGCMUTILSCTX pCtx)
{
ASMAtomicWriteBool(&pCtx->Host.fShutdown, true);
int rcThread;
int rc = RTThreadWait(pCtx->Host.hThread, RT_MS_30SEC, &rcThread);
if (RT_SUCCESS(rc))
rc = rcThread;
if (RT_SUCCESS(rc))
pCtx->Host.hThread = NIL_RTTHREAD;
return rc;
}
|
