AudioTestService.cpp@ 91533

Last change on this file since 91533 was 91040, checked in by vboxsync, 3 years ago
Audio/Validation Kit: Got rid of the embedded (and probably wrong) failure reply struct and replaced it with ATSPKTREPFAIL so that clients also can interpret it more easily. bugref:10008
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 42.8 KB

Line
1	/* $Id: AudioTestService.cpp 91040 2021-08-31 17:40:36Z vboxsync $ */
2	/** @file
3	* AudioTestService - Audio test execution server.
4	*/
5
6	/*
7	* Copyright (C) 2021 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
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_AUDIO_TEST
23	#include <iprt/log.h>
24
25	#include <iprt/alloca.h>
26	#include <iprt/asm.h>
27	#include <iprt/assert.h>
28	#include <iprt/critsect.h>
29	#include <iprt/crc.h>
30	#include <iprt/ctype.h>
31	#include <iprt/dir.h>
32	#include <iprt/env.h>
33	#include <iprt/err.h>
34	#include <iprt/file.h>
35	#include <iprt/getopt.h>
36	#include <iprt/handle.h>
37	#include <iprt/initterm.h>
38	#include <iprt/json.h>
39	#include <iprt/list.h>
40	#include <iprt/mem.h>
41	#include <iprt/message.h>
42	#include <iprt/param.h>
43	#include <iprt/path.h>
44	#include <iprt/pipe.h>
45	#include <iprt/poll.h>
46	#include <iprt/process.h>
47	#include <iprt/stream.h>
48	#include <iprt/string.h>
49	#include <iprt/thread.h>
50
51	#include <VBox/log.h>
52
53	#include "AudioTestService.h"
54	#include "AudioTestServiceInternal.h"
55
56
57	/*********************************************************************************************************************************
58	* Structures and Typedefs *
59	*********************************************************************************************************************************/
60	/**
61	* A generic ATS reply, used by the client
62	* to process the incoming packets.
63	*/
64	typedef struct ATSSRVREPLY
65	{
66	char szOp[ATSPKT_OPCODE_MAX_LEN];
67	void *pvPayload;
68	size_t cbPayload;
69	} ATSSRVREPLY;
70	/** Pointer to a generic ATS reply. */
71	typedef struct ATSSRVREPLY *PATSSRVREPLY;
72
73
74	/*********************************************************************************************************************************
75	* Global Variables *
76	*********************************************************************************************************************************/
77	/**
78	* Transport layers.
79	*/
80	const PCATSTRANSPORT g_apTransports[] =
81	{
82	&g_TcpTransport
83	};
84	/** Number of transport layers in \a g_apTransports. */
85	const size_t g_cTransports = RT_ELEMENTS(g_apTransports);
86
87	/**
88	* ATS client state.
89	*/
90	typedef enum ATSCLIENTSTATE
91	{
92	/** Invalid client state. */
93	ATSCLIENTSTATE_INVALID = 0,
94	/** Client is initialising, only the HOWDY and BYE packets are allowed. */
95	ATSCLIENTSTATE_INITIALISING,
96	/** Client is in fully cuntional state and ready to process all requests. */
97	ATSCLIENTSTATE_READY,
98	/** Client is destroying. */
99	ATSCLIENTSTATE_DESTROYING,
100	/** 32bit hack. */
101	ATSCLIENTSTATE_32BIT_HACK = 0x7fffffff
102	} ATSCLIENTSTATE;
103
104	/**
105	* ATS client instance.
106	*/
107	typedef struct ATSCLIENTINST
108	{
109	/** List node for new clients. */
110	RTLISTNODE NdLst;
111	/** The current client state. */
112	ATSCLIENTSTATE enmState;
113	/** Transport backend specific data. */
114	PATSTRANSPORTCLIENT pTransportClient;
115	/** Client hostname. */
116	char *pszHostname;
117	} ATSCLIENTINST;
118	/** Pointer to a ATS client instance. */
119	typedef ATSCLIENTINST *PATSCLIENTINST;
120
121
122	/*********************************************************************************************************************************
123	* Prototypes *
124	*********************************************************************************************************************************/
125	static int atsClientDisconnect(PATSSERVER pThis, PATSCLIENTINST pInst);
126
127
128
129	/**
130	* Returns the string represenation of the given state.
131	*/
132	static const char *atsClientStateStringify(ATSCLIENTSTATE enmState)
133	{
134	switch (enmState)
135	{
136	case ATSCLIENTSTATE_INVALID:
137	return "INVALID";
138	case ATSCLIENTSTATE_INITIALISING:
139	return "INITIALISING";
140	case ATSCLIENTSTATE_READY:
141	return "READY";
142	case ATSCLIENTSTATE_DESTROYING:
143	return "DESTROYING";
144	case ATSCLIENTSTATE_32BIT_HACK:
145	default:
146	break;
147	}
148
149	AssertMsgFailed(("Unknown state %#x\n", enmState));
150	return "UNKNOWN";
151	}
152
153	/**
154	* Calculates the checksum value, zero any padding space and send the packet.
155	*
156	* @returns IPRT status code.
157	* @param pThis The ATS instance.
158	* @param pInst The ATS client structure.
159	* @param pPkt The packet to send. Must point to a correctly
160	* aligned buffer.
161	*/
162	static int atsSendPkt(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPkt)
163	{
164	Assert(pPkt->cb >= sizeof(*pPkt));
165	pPkt->uCrc32 = RTCrc32(pPkt->achOpcode, pPkt->cb - RT_UOFFSETOF(ATSPKTHDR, achOpcode));
166	if (pPkt->cb != RT_ALIGN_32(pPkt->cb, ATSPKT_ALIGNMENT))
167	memset((uint8_t *)pPkt + pPkt->cb, '\0', RT_ALIGN_32(pPkt->cb, ATSPKT_ALIGNMENT) - pPkt->cb);
168
169	LogFlowFunc(("cb=%RU32 (%#x), payload=%RU32 (%#x), opcode=%.8s\n",
170	pPkt->cb, pPkt->cb, pPkt->cb - sizeof(ATSPKTHDR), pPkt->cb - sizeof(ATSPKTHDR), pPkt->achOpcode));
171	int rc = pThis->pTransport->pfnSendPkt(pThis->pTransportInst, pInst->pTransportClient, pPkt);
172	while (RT_UNLIKELY(rc == VERR_INTERRUPTED) && !pThis->fTerminate)
173	rc = pThis->pTransport->pfnSendPkt(pThis->pTransportInst, pInst->pTransportClient, pPkt);
174
175	return rc;
176	}
177
178	/**
179	* Sends a babble reply and disconnects the client (if applicable).
180	*
181	* @param pThis The ATS instance.
182	* @param pInst The ATS server instance.
183	* @param pszOpcode The BABBLE opcode.
184	*/
185	static void atsReplyBabble(PATSSERVER pThis, PATSCLIENTINST pInst, const char *pszOpcode)
186	{
187	ATSPKTHDR Reply;
188	Reply.cb = sizeof(Reply);
189	Reply.uCrc32 = 0;
190	memcpy(Reply.achOpcode, pszOpcode, sizeof(Reply.achOpcode));
191
192	pThis->pTransport->pfnBabble(pThis->pTransportInst, pInst->pTransportClient, &Reply, 20*1000);
193	}
194
195	/**
196	* Receive and validate a packet.
197	*
198	* Will send bable responses to malformed packets that results in a error status
199	* code.
200	*
201	* @returns IPRT status code.
202	* @param pThis The ATS instance.
203	* @param pInst The opaque ATS instance structure.
204	* @param ppPktHdr Where to return the packet on success. Free
205	* with RTMemFree.
206	* @param fAutoRetryOnFailure Whether to retry on error.
207	*/
208	static int atsRecvPkt(PATSSERVER pThis, PATSCLIENTINST pInst, PPATSPKTHDR ppPktHdr, bool fAutoRetryOnFailure)
209	{
210	for (;;)
211	{
212	PATSPKTHDR pPktHdr;
213	int rc = pThis->pTransport->pfnRecvPkt(pThis->pTransportInst, pInst->pTransportClient, &pPktHdr);
214	if (RT_SUCCESS(rc))
215	{
216	/* validate the packet. */
217	if ( pPktHdr->cb >= sizeof(ATSPKTHDR)
218	&& pPktHdr->cb < ATSPKT_MAX_SIZE)
219	{
220	Log2Func(("pPktHdr=%p cb=%#x crc32=%#x opcode=%.8s\n",
221	pPktHdr, pPktHdr->cb, pPktHdr->uCrc32, pPktHdr->achOpcode));
222	uint32_t uCrc32Calc = pPktHdr->uCrc32 != 0
223	? RTCrc32(&pPktHdr->achOpcode[0], pPktHdr->cb - RT_UOFFSETOF(ATSPKTHDR, achOpcode))
224	: 0;
225	if (pPktHdr->uCrc32 == uCrc32Calc)
226	{
227	AssertCompileMemberSize(ATSPKTHDR, achOpcode, 8);
228	if ( RT_C_IS_UPPER(pPktHdr->achOpcode[0])
229	&& RT_C_IS_UPPER(pPktHdr->achOpcode[1])
230	&& (RT_C_IS_UPPER(pPktHdr->achOpcode[2]) \|\| pPktHdr->achOpcode[2] == ' ')
231	&& (RT_C_IS_PRINT(pPktHdr->achOpcode[3]) \|\| pPktHdr->achOpcode[3] == ' ')
232	&& (RT_C_IS_PRINT(pPktHdr->achOpcode[4]) \|\| pPktHdr->achOpcode[4] == ' ')
233	&& (RT_C_IS_PRINT(pPktHdr->achOpcode[5]) \|\| pPktHdr->achOpcode[5] == ' ')
234	&& (RT_C_IS_PRINT(pPktHdr->achOpcode[6]) \|\| pPktHdr->achOpcode[6] == ' ')
235	&& (RT_C_IS_PRINT(pPktHdr->achOpcode[7]) \|\| pPktHdr->achOpcode[7] == ' ')
236	)
237	{
238	Log(("cb=%#x opcode=%.8s\n", pPktHdr->cb, pPktHdr->achOpcode));
239	*ppPktHdr = pPktHdr;
240	return rc;
241	}
242
243	rc = VERR_IO_BAD_COMMAND;
244	}
245	else
246	{
247	Log(("cb=%#x opcode=%.8s crc32=%#x actual=%#x\n",
248	pPktHdr->cb, pPktHdr->achOpcode, pPktHdr->uCrc32, uCrc32Calc));
249	rc = VERR_IO_CRC;
250	}
251	}
252	else
253	rc = VERR_IO_BAD_LENGTH;
254
255	/* Send babble reply and disconnect the client if the transport is
256	connection oriented. */
257	if (rc == VERR_IO_BAD_LENGTH)
258	atsReplyBabble(pThis, pInst, "BABBLE L");
259	else if (rc == VERR_IO_CRC)
260	atsReplyBabble(pThis, pInst, "BABBLE C");
261	else if (rc == VERR_IO_BAD_COMMAND)
262	atsReplyBabble(pThis, pInst, "BABBLE O");
263	else
264	atsReplyBabble(pThis, pInst, "BABBLE ");
265	RTMemFree(pPktHdr);
266	}
267
268	/* Try again or return failure? */
269	if ( pThis->fTerminate
270	\|\| rc != VERR_INTERRUPTED
271	\|\| !fAutoRetryOnFailure
272	)
273	{
274	Log(("rc=%Rrc\n", rc));
275	return rc;
276	}
277	}
278	}
279
280	/**
281	* Make a simple reply, only status opcode.
282	*
283	* @returns IPRT status code of the send.
284	* @param pThis The ATS instance.
285	* @param pInst The opaque ATS instance structure.
286	* @param pReply The reply packet.
287	* @param pszOpcode The status opcode. Exactly 8 chars long, padd
288	* with space.
289	* @param cbExtra Bytes in addition to the header.
290	*/
291	static int atsReplyInternal(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pReply, const char *pszOpcode, size_t cbExtra)
292	{
293	/* copy the opcode, don't be too strict in case of a padding screw up. */
294	size_t cchOpcode = strlen(pszOpcode);
295	if (RT_LIKELY(cchOpcode == sizeof(pReply->achOpcode)))
296	memcpy(pReply->achOpcode, pszOpcode, sizeof(pReply->achOpcode));
297	else
298	{
299	Assert(cchOpcode == sizeof(pReply->achOpcode));
300	while (cchOpcode > 0 && pszOpcode[cchOpcode - 1] == ' ')
301	cchOpcode--;
302	AssertMsgReturn(cchOpcode < sizeof(pReply->achOpcode), ("%d/'%.8s'\n", cchOpcode, pszOpcode), VERR_INTERNAL_ERROR_4);
303	memcpy(pReply->achOpcode, pszOpcode, cchOpcode);
304	memset(&pReply->achOpcode[cchOpcode], ' ', sizeof(pReply->achOpcode) - cchOpcode);
305	}
306
307	pReply->cb = (uint32_t)sizeof(ATSPKTHDR) + (uint32_t)cbExtra;
308	pReply->uCrc32 = 0;
309
310	return atsSendPkt(pThis, pInst, pReply);
311	}
312
313	/**
314	* Make a simple reply, only status opcode.
315	*
316	* @returns IPRT status code of the send.
317	* @param pThis The ATS instance.
318	* @param pInst The opaque ATS instance structure.
319	* @param pPktHdr The original packet (for future use).
320	* @param pszOpcode The status opcode. Exactly 8 chars long, padd
321	* with space.
322	*/
323	static int atsReplySimple(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr, const char *pszOpcode)
324	{
325	return atsReplyInternal(pThis, pInst, pPktHdr, pszOpcode, 0);
326	}
327
328	/**
329	* Acknowledges a packet with success.
330	*
331	* @returns IPRT status code of the send.
332	* @param pThis The ATS instance.
333	* @param pInst The opaque ATS instance structure.
334	* @param pPktHdr The original packet (for future use).
335	*/
336	static int atsReplyAck(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
337	{
338	return atsReplySimple(pThis, pInst, pPktHdr, "ACK ");
339	}
340
341	/**
342	* Replies with a failure.
343	*
344	* @returns IPRT status code of the send.
345	* @param pThis The ATS instance.
346	* @param pInst The opaque ATS instance structure.
347	* @param pPktHdr The original packet (for future use).
348	* @param pszOpcode The status opcode. Exactly 8 chars long, padd
349	* with space.
350	* @param rcReq The status code of the request.
351	* @param pszDetailFmt Longer description of the problem (format string).
352	* @param va Format arguments.
353	*/
354	static int atsReplyFailureV(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr,
355	const char pszOpcode, int rcReq, const char pszDetailFmt, va_list va)
356	{
357	RT_NOREF(pPktHdr);
358
359	ATSPKTREPFAIL Rep;
360	RT_ZERO(Rep);
361
362	size_t cchDetail = RTStrPrintfV(Rep.ach, sizeof(Rep.ach), pszDetailFmt, va);
363
364	Rep.rc = rcReq;
365
366	return atsReplyInternal(pThis, pInst, &Rep.Hdr, pszOpcode, sizeof(Rep.rc) + cchDetail + 1);
367	}
368
369	/**
370	* Replies with a failure.
371	*
372	* @returns IPRT status code of the send.
373	* @param pThis The ATS instance.
374	* @param pInst The opaque ATS instance structure.
375	* @param pPktHdr The original packet (for future use).
376	* @param pszOpcode The status opcode. Exactly 8 chars long, padd
377	* with space.
378	* @param rcReq Status code.
379	* @param pszDetailFmt Longer description of the problem (format string).
380	* @param ... Format arguments.
381	*/
382	static int atsReplyFailure(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr,
383	const char pszOpcode, int rcReq, const char pszDetailFmt, ...)
384	{
385	va_list va;
386	va_start(va, pszDetailFmt);
387	int rc = atsReplyFailureV(pThis, pInst, pPktHdr, pszOpcode, rcReq, pszDetailFmt, va);
388	va_end(va);
389	return rc;
390	}
391
392	/**
393	* Replies according to the return code.
394	*
395	* @returns IPRT status code of the send.
396	* @param pThis The ATS instance.
397	* @param pInst The opaque ATS instance structure.
398	* @param pPktHdr The packet to reply to.
399	* @param rcOperation The status code to report.
400	* @param pszOperationFmt The operation that failed. Typically giving the
401	* function call with important arguments.
402	* @param ... Arguments to the format string.
403	*/
404	static int atsReplyRC(PATSSERVER pThis,
405	PATSCLIENTINST pInst, PATSPKTHDR pPktHdr, int rcOperation, const char *pszOperationFmt, ...)
406	{
407	if (RT_SUCCESS(rcOperation))
408	return atsReplyAck(pThis, pInst, pPktHdr);
409
410	char szOperation[128];
411	va_list va;
412	va_start(va, pszOperationFmt);
413	RTStrPrintfV(szOperation, sizeof(szOperation), pszOperationFmt, va);
414	va_end(va);
415
416	return atsReplyFailure(pThis, pInst, pPktHdr, "FAILED ", rcOperation, "%s failed with rc=%Rrc (opcode '%.8s')",
417	szOperation, rcOperation, pPktHdr->achOpcode);
418	}
419
420	/**
421	* Signal a bad packet exact size.
422	*
423	* @returns IPRT status code of the send.
424	* @param pThis The ATS instance.
425	* @param pInst The opaque ATS instance structure.
426	* @param pPktHdr The packet to reply to.
427	* @param cb The wanted size.
428	*/
429	static int atsReplyBadSize(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr, size_t cb)
430	{
431	return atsReplyFailure(pThis, pInst, pPktHdr, "BAD SIZE", VERR_INVALID_PARAMETER, "Expected at %zu bytes, got %u (opcode '%.8s')",
432	cb, pPktHdr->cb, pPktHdr->achOpcode);
433	}
434
435	/**
436	* Deals with a unknown command.
437	*
438	* @returns IPRT status code of the send.
439	* @param pThis The ATS instance.
440	* @param pInst The opaque ATS instance structure.
441	* @param pPktHdr The packet to reply to.
442	*/
443	static int atsReplyUnknown(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
444	{
445	return atsReplyFailure(pThis, pInst, pPktHdr, "UNKNOWN ", VERR_NOT_FOUND, "Opcode '%.8s' is not known", pPktHdr->achOpcode);
446	}
447
448	/**
449	* Deals with a command sent in an invalid client state.
450	*
451	* @returns IPRT status code of the send.
452	* @param pThis The ATS instance.
453	* @param pInst The opaque ATS instance structure.
454	* @param pPktHdr The packet containing the unterminated string.
455	*/
456	static int atsReplyInvalidState(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
457	{
458	return atsReplyFailure(pThis, pInst, pPktHdr, "INVSTATE", VERR_INVALID_STATE, "Opcode '%.8s' is not supported at client state '%s",
459	pPktHdr->achOpcode, atsClientStateStringify(pInst->enmState));
460	}
461
462	/**
463	* Verifies and acknowledges a "BYE" request.
464	*
465	* @returns IPRT status code.
466	* @param pThis The ATS instance.
467	* @param pInst The opaque ATS instance structure.
468	* @param pPktHdr The bye packet.
469	*/
470	static int atsDoBye(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
471	{
472	int rc;
473	if (pPktHdr->cb == sizeof(ATSPKTHDR))
474	{
475	if (pThis->Callbacks.pfnBye)
476	{
477	rc = pThis->Callbacks.pfnBye(pThis->Callbacks.pvUser);
478	}
479	else
480	rc = VINF_SUCCESS;
481
482	if (RT_SUCCESS(rc))
483	{
484	rc = atsReplyAck(pThis, pInst, pPktHdr);
485	}
486	else
487	rc = atsReplyRC(pThis, pInst, pPktHdr, rc, "Disconnecting client failed");
488	}
489	else
490	rc = atsReplyBadSize(pThis, pInst, pPktHdr, sizeof(ATSPKTHDR));
491	return rc;
492	}
493
494	/**
495	* Verifies and acknowledges a "HOWDY" request.
496	*
497	* @returns IPRT status code.
498	* @param pThis The ATS instance.
499	* @param pInst The opaque ATS instance structure.
500	* @param pPktHdr The howdy packet.
501	*/
502	static int atsDoHowdy(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
503	{
504	int rc = VINF_SUCCESS;
505
506	if (pPktHdr->cb != sizeof(ATSPKTREQHOWDY))
507	return atsReplyBadSize(pThis, pInst, pPktHdr, sizeof(ATSPKTREQHOWDY));
508
509	if (pInst->enmState != ATSCLIENTSTATE_INITIALISING)
510	return atsReplyInvalidState(pThis, pInst, pPktHdr);
511
512	PATSPKTREQHOWDY pReq = (PATSPKTREQHOWDY)pPktHdr;
513
514	if (pReq->uVersion != ATS_PROTOCOL_VS)
515	return atsReplyRC(pThis, pInst, pPktHdr, VERR_VERSION_MISMATCH, "The given version %#x is not supported", pReq->uVersion);
516
517	ATSPKTREPHOWDY Rep;
518	RT_ZERO(Rep);
519
520	Rep.uVersion = ATS_PROTOCOL_VS;
521
522	rc = atsReplyInternal(pThis, pInst, &Rep.Hdr, "ACK ", sizeof(Rep) - sizeof(ATSPKTHDR));
523	if (RT_SUCCESS(rc))
524	{
525	pThis->pTransport->pfnNotifyHowdy(pThis->pTransportInst, pInst->pTransportClient);
526
527	if (pThis->Callbacks.pfnHowdy)
528	rc = pThis->Callbacks.pfnHowdy(pThis->Callbacks.pvUser);
529
530	if (RT_SUCCESS(rc))
531	pInst->enmState = ATSCLIENTSTATE_READY;
532	}
533
534	return rc;
535	}
536
537	/**
538	* Verifies and acknowledges a "TSET BEG" request.
539	*
540	* @returns IPRT status code.
541	* @param pThis The ATS instance.
542	* @param pInst The opaque ATS instance structure.
543	* @param pPktHdr The test set begin packet.
544	*/
545	static int atsDoTestSetBegin(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
546	{
547	if (pPktHdr->cb != sizeof(ATSPKTREQTSETBEG))
548	return atsReplyBadSize(pThis, pInst, pPktHdr, sizeof(ATSPKTREQTSETBEG));
549
550	PATSPKTREQTSETBEG pReq = (PATSPKTREQTSETBEG)pPktHdr;
551
552	int rc = VINF_SUCCESS;
553
554	if (pThis->Callbacks.pfnTestSetBegin)
555	rc = pThis->Callbacks.pfnTestSetBegin(pThis->Callbacks.pvUser, pReq->szTag);
556
557	if (RT_SUCCESS(rc))
558	rc = atsReplyAck(pThis, pInst, pPktHdr);
559	else
560	rc = atsReplyRC(pThis, pInst, pPktHdr, rc, "Beginning test set failed");
561	return rc;
562	}
563
564	/**
565	* Verifies and acknowledges a "TSET END" request.
566	*
567	* @returns IPRT status code.
568	* @param pThis The ATS instance.
569	* @param pInst The opaque ATS instance structure.
570	* @param pPktHdr The test set end packet.
571	*/
572	static int atsDoTestSetEnd(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
573	{
574	if (pPktHdr->cb != sizeof(ATSPKTREQTSETEND))
575	return atsReplyBadSize(pThis, pInst, pPktHdr, sizeof(ATSPKTREQTSETEND));
576
577	PATSPKTREQTSETEND pReq = (PATSPKTREQTSETEND)pPktHdr;
578
579	int rc = VINF_SUCCESS;
580
581	if (pThis->Callbacks.pfnTestSetEnd)
582	rc = pThis->Callbacks.pfnTestSetEnd(pThis->Callbacks.pvUser, pReq->szTag);
583
584	if (RT_SUCCESS(rc))
585	rc = atsReplyAck(pThis, pInst, pPktHdr);
586	else
587	rc = atsReplyRC(pThis, pInst, pPktHdr, rc, "Ending test set failed");
588	return rc;
589	}
590
591	/**
592	* Used by atsDoTestSetSend to wait for a reply ACK from the client.
593	*
594	* @returns VINF_SUCCESS on ACK, VERR_GENERAL_FAILURE on NACK,
595	* VERR_NET_NOT_CONNECTED on unknown response (sending a bable reply),
596	* or whatever atsRecvPkt returns.
597	* @param pThis The ATS instance.
598	* @param pInst The opaque ATS instance structure.
599	* @param pPktHdr The original packet (for future use).
600	*/
601	static int atsWaitForAck(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
602	{
603	RT_NOREF(pPktHdr);
604	/** @todo timeout? */
605	PATSPKTHDR pReply;
606	int rc = atsRecvPkt(pThis, pInst, &pReply, false /fAutoRetryOnFailure/);
607	if (RT_SUCCESS(rc))
608	{
609	if (atsIsSameOpcode(pReply, "ACK"))
610	rc = VINF_SUCCESS;
611	else if (atsIsSameOpcode(pReply, "NACK"))
612	rc = VERR_GENERAL_FAILURE;
613	else
614	{
615	atsReplyBabble(pThis, pInst, "BABBLE ");
616	rc = VERR_NET_NOT_CONNECTED;
617	}
618	RTMemFree(pReply);
619	}
620	return rc;
621	}
622
623	/**
624	* Verifies and acknowledges a "TSET SND" request.
625	*
626	* @returns IPRT status code.
627	* @param pThis The ATS instance.
628	* @param pInst The opaque ATS instance structure.
629	* @param pPktHdr The test set end packet.
630	*/
631	static int atsDoTestSetSend(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
632	{
633	if (pPktHdr->cb != sizeof(ATSPKTREQTSETSND))
634	return atsReplyBadSize(pThis, pInst, pPktHdr, sizeof(ATSPKTREQTSETSND));
635
636	PATSPKTREQTSETSND pReq = (PATSPKTREQTSETSND)pPktHdr;
637
638	int rc = VINF_SUCCESS;
639
640	if (!pThis->Callbacks.pfnTestSetSendRead)
641	return atsReplyRC(pThis, pInst, pPktHdr, VERR_NOT_SUPPORTED, "Sending test set not implemented");
642
643	if (pThis->Callbacks.pfnTestSetSendBegin)
644	{
645	rc = pThis->Callbacks.pfnTestSetSendBegin(pThis->Callbacks.pvUser, pReq->szTag);
646	if (RT_FAILURE(rc))
647	return atsReplyRC(pThis, pInst, pPktHdr, rc, "Beginning sending test set '%s' failed", pReq->szTag);
648	}
649
650	for (;;)
651	{
652	uint32_t uMyCrc32 = RTCrc32Start();
653	struct
654	{
655	ATSPKTHDR Hdr;
656	uint32_t uCrc32;
657	char ab[_64K];
658	char abPadding[ATSPKT_ALIGNMENT];
659	} Pkt;
660	#ifdef DEBUG
661	RT_ZERO(Pkt);
662	#endif
663	size_t cbRead = 0;
664	rc = pThis->Callbacks.pfnTestSetSendRead(pThis->Callbacks.pvUser, pReq->szTag, &Pkt.ab, sizeof(Pkt.ab), &cbRead);
665	if ( RT_FAILURE(rc)
666	\|\| cbRead == 0)
667	{
668	if ( rc == VERR_EOF
669	\|\| (RT_SUCCESS(rc) && cbRead == 0))
670	{
671	Pkt.uCrc32 = RTCrc32Finish(uMyCrc32);
672	rc = atsReplyInternal(pThis, pInst, &Pkt.Hdr, "DATA EOF", sizeof(uint32_t) /* uCrc32 */);
673	if (RT_SUCCESS(rc))
674	rc = atsWaitForAck(pThis, pInst, &Pkt.Hdr);
675	}
676	else
677	rc = atsReplyRC(pThis, pInst, pPktHdr, rc, "Sending data for test set '%s' failed", pReq->szTag);
678	break;
679	}
680
681	uMyCrc32 = RTCrc32Process(uMyCrc32, &Pkt.ab[0], cbRead);
682	Pkt.uCrc32 = RTCrc32Finish(uMyCrc32);
683
684	Log2Func(("cbRead=%zu -> uCrc32=%#x\n", cbRead, Pkt.uCrc32));
685
686	Assert(cbRead <= sizeof(Pkt.ab));
687
688	rc = atsReplyInternal(pThis, pInst, &Pkt.Hdr, "DATA ", sizeof(uint32_t) /* uCrc32 */ + cbRead);
689	if (RT_FAILURE(rc))
690	break;
691
692	rc = atsWaitForAck(pThis, pInst, &Pkt.Hdr);
693	if (RT_FAILURE(rc))
694	break;
695	}
696
697	if (pThis->Callbacks.pfnTestSetSendEnd)
698	{
699	int rc2 = pThis->Callbacks.pfnTestSetSendEnd(pThis->Callbacks.pvUser, pReq->szTag);
700	if (RT_FAILURE(rc2))
701	return atsReplyRC(pThis, pInst, pPktHdr, rc2, "Ending sending test set '%s' failed", pReq->szTag);
702	}
703
704	return rc;
705	}
706
707	/**
708	* Verifies and processes a "TN PLY" request.
709	*
710	* @returns IPRT status code.
711	* @param pThis The ATS instance.
712	* @param pInst The opaque ATS instance structure.
713	* @param pPktHdr The packet header.
714	*/
715	static int atsDoTonePlay(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
716	{
717	if (pPktHdr->cb < sizeof(ATSPKTREQTONEPLAY))
718	return atsReplyBadSize(pThis, pInst, pPktHdr, sizeof(ATSPKTREQTONEPLAY));
719
720	if (pInst->enmState != ATSCLIENTSTATE_READY)
721	return atsReplyInvalidState(pThis, pInst, pPktHdr);
722
723	int rc = VINF_SUCCESS;
724
725	PATSPKTREQTONEPLAY pReq = (PATSPKTREQTONEPLAY)pPktHdr;
726
727	if (pThis->Callbacks.pfnTonePlay)
728	rc = pThis->Callbacks.pfnTonePlay(pThis->Callbacks.pvUser, &pReq->ToneParms);
729
730	if (RT_SUCCESS(rc))
731	rc = atsReplyAck(pThis, pInst, pPktHdr);
732	else
733	rc = atsReplyRC(pThis, pInst, pPktHdr, rc, "Playing test tone failed");
734	return rc;
735	}
736
737	/**
738	* Verifies and processes a "TN REC" request.
739	*
740	* @returns IPRT status code.
741	* @param pThis The ATS instance.
742	* @param pInst The opaque ATS instance structure.
743	* @param pPktHdr The packet header.
744	*/
745	static int atsDoToneRecord(PATSSERVER pThis, PATSCLIENTINST pInst, PATSPKTHDR pPktHdr)
746	{
747	if (pPktHdr->cb < sizeof(ATSPKTREQTONEREC))
748	return atsReplyBadSize(pThis, pInst, pPktHdr, sizeof(ATSPKTREQTONEREC));
749
750	if (pInst->enmState != ATSCLIENTSTATE_READY)
751	return atsReplyInvalidState(pThis, pInst, pPktHdr);
752
753	int rc = VINF_SUCCESS;
754
755	PATSPKTREQTONEREC pReq = (PATSPKTREQTONEREC)pPktHdr;
756
757	if (pThis->Callbacks.pfnToneRecord)
758	rc = pThis->Callbacks.pfnToneRecord(pThis->Callbacks.pvUser, &pReq->ToneParms);
759
760	if (RT_SUCCESS(rc))
761	rc = atsReplyAck(pThis, pInst, pPktHdr);
762	else
763	rc = atsReplyRC(pThis, pInst, pPktHdr, rc, "Recording test tone failed");
764	return rc;
765	}
766
767	/**
768	* Main request processing routine for each client.
769	*
770	* @returns IPRT status code.
771	* @param pThis The ATS instance.
772	* @param pInst The ATS client structure sending the request.
773	* @param pfDisconnect Where to return whether to disconnect the client on success or not.
774	*/
775	static int atsClientReqProcess(PATSSERVER pThis, PATSCLIENTINST pInst, bool *pfDisconnect)
776	{
777	LogRelFlowFuncEnter();
778
779	/*
780	* Read client command packet and process it.
781	*/
782	PATSPKTHDR pPktHdr = NULL;
783	int rc = atsRecvPkt(pThis, pInst, &pPktHdr, true /fAutoRetryOnFailure/);
784	if (RT_FAILURE(rc))
785	return rc;
786
787	/*
788	* Do a string switch on the opcode bit.
789	*/
790	/* Connection: */
791	if ( atsIsSameOpcode(pPktHdr, ATSPKT_OPCODE_HOWDY))
792	rc = atsDoHowdy(pThis, pInst, pPktHdr);
793	else if (atsIsSameOpcode(pPktHdr, ATSPKT_OPCODE_BYE))
794	{
795	rc = atsDoBye(pThis, pInst, pPktHdr);
796	if (RT_SUCCESS(rc))
797	*pfDisconnect = true;
798	}
799	/* Test set handling: */
800	else if (atsIsSameOpcode(pPktHdr, ATSPKT_OPCODE_TESTSET_BEGIN))
801	rc = atsDoTestSetBegin(pThis, pInst, pPktHdr);
802	else if (atsIsSameOpcode(pPktHdr, ATSPKT_OPCODE_TESTSET_END))
803	rc = atsDoTestSetEnd(pThis, pInst, pPktHdr);
804	else if (atsIsSameOpcode(pPktHdr, ATSPKT_OPCODE_TESTSET_SEND))
805	rc = atsDoTestSetSend(pThis, pInst, pPktHdr);
806	/* Audio testing: */
807	else if (atsIsSameOpcode(pPktHdr, ATSPKT_OPCODE_TONE_PLAY))
808	rc = atsDoTonePlay(pThis, pInst, pPktHdr);
809	else if (atsIsSameOpcode(pPktHdr, ATSPKT_OPCODE_TONE_RECORD))
810	rc = atsDoToneRecord(pThis, pInst, pPktHdr);
811	/* Misc: */
812	else
813	rc = atsReplyUnknown(pThis, pInst, pPktHdr);
814
815	RTMemFree(pPktHdr);
816
817	LogRelFlowFuncLeaveRC(rc);
818	return rc;
819	}
820
821	static int atsClientDisconnect(PATSSERVER pThis, PATSCLIENTINST pInst)
822	{
823	AssertReturn(pInst->enmState != ATSCLIENTSTATE_DESTROYING, VERR_WRONG_ORDER);
824
825	pInst->enmState = ATSCLIENTSTATE_DESTROYING;
826	pThis->pTransport->pfnNotifyBye(pThis->pTransportInst, pInst->pTransportClient);
827
828	return VINF_SUCCESS;
829	}
830
831	/**
832	* Free's (destroys) a client instance.
833	*
834	* @returns nothing.
835	* @param pInst The opaque ATS instance structure.
836	*/
837	static void atsClientFree(PATSCLIENTINST pInst)
838	{
839	if (pInst->pszHostname)
840	RTStrFree(pInst->pszHostname);
841	RTMemFree(pInst);
842	}
843
844	/**
845	* The main thread worker serving the clients.
846	*/
847	static DECLCALLBACK(int) atsClientWorker(RTTHREAD hThread, void *pvUser)
848	{
849	RT_NOREF(hThread);
850
851	PATSSERVER pThis = (PATSSERVER)pvUser;
852	AssertPtrReturn(pThis, VERR_INVALID_POINTER);
853
854	unsigned cClientsMax = 0;
855	unsigned cClientsCur = 0;
856	PATSCLIENTINST *papInsts = NULL;
857
858	/* Add the pipe to the poll set. */
859	int rc = RTPollSetAddPipe(pThis->hPollSet, pThis->hPipeR, RTPOLL_EVT_READ \| RTPOLL_EVT_ERROR, 0);
860	if (RT_SUCCESS(rc))
861	{
862	while (!pThis->fTerminate)
863	{
864	uint32_t fEvts;
865	uint32_t uId;
866	rc = RTPoll(pThis->hPollSet, RT_INDEFINITE_WAIT, &fEvts, &uId);
867	LogRelFlowFunc(("RTPoll(...) returned fEvts=#%x, uId=%RU32 -> %Rrc\n", fEvts, uId, rc));
868	if (RT_SUCCESS(rc))
869	{
870	if (uId == 0)
871	{
872	if (fEvts & RTPOLL_EVT_ERROR)
873	break;
874
875	/* We got woken up because of a new client. */
876	Assert(fEvts & RTPOLL_EVT_READ);
877
878	uint8_t bRead;
879	size_t cbRead = 0;
880	rc = RTPipeRead(pThis->hPipeR, &bRead, 1, &cbRead);
881	AssertRC(rc);
882
883	RTCritSectEnter(&pThis->CritSectClients);
884	/* Walk the list and add all new clients. */
885	PATSCLIENTINST pIt, pItNext;
886	RTListForEachSafe(&pThis->LstClientsNew, pIt, pItNext, ATSCLIENTINST, NdLst)
887	{
888	RTListNodeRemove(&pIt->NdLst);
889	Assert(cClientsCur <= cClientsMax);
890	if (cClientsCur == cClientsMax)
891	{
892	/* Realloc to accommodate for the new clients. */
893	PATSCLIENTINST papInstsNew = (PATSCLIENTINST )RTMemReallocZ(papInsts, cClientsMax * sizeof(PATSCLIENTINST), (cClientsMax + 10) * sizeof(PATSCLIENTINST));
894	if (RT_LIKELY(papInstsNew))
895	{
896	cClientsMax += 10;
897	papInsts = papInstsNew;
898	}
899	}
900	if (cClientsCur < cClientsMax)
901	{
902	/* Find a free slot in the client array. */
903	unsigned idxSlt = 0;
904	while ( idxSlt < cClientsMax
905	&& papInsts[idxSlt] != NULL)
906	idxSlt++;
907
908	rc = pThis->pTransport->pfnPollSetAdd(pThis->pTransportInst, pThis->hPollSet, pIt->pTransportClient, idxSlt + 1);
909	if (RT_SUCCESS(rc))
910	{
911	cClientsCur++;
912	papInsts[idxSlt] = pIt;
913	}
914	else
915	{
916	atsClientDisconnect(pThis, pIt);
917	atsClientFree(pIt);
918	pIt = NULL;
919	}
920	}
921	else
922	{
923	atsClientDisconnect(pThis, pIt);
924	atsClientFree(pIt);
925	pIt = NULL;
926	}
927	}
928	RTCritSectLeave(&pThis->CritSectClients);
929	}
930	else
931	{
932	bool fDisconnect = false;
933
934	/* Client sends a request, pick the right client and process it. */
935	PATSCLIENTINST pInst = papInsts[uId - 1];
936	AssertPtr(pInst);
937	if (fEvts & RTPOLL_EVT_READ)
938	rc = atsClientReqProcess(pThis, pInst, &fDisconnect);
939
940	if ( (fEvts & RTPOLL_EVT_ERROR)
941	\|\| RT_FAILURE(rc)
942	\|\| fDisconnect)
943	{
944	/* Close connection and remove client from array. */
945	int rc2 = pThis->pTransport->pfnPollSetRemove(pThis->pTransportInst, pThis->hPollSet, pInst->pTransportClient, uId);
946	AssertRC(rc2);
947
948	atsClientDisconnect(pThis, pInst);
949	atsClientFree(pInst);
950	pInst = NULL;
951
952	papInsts[uId - 1] = NULL;
953	Assert(cClientsCur);
954	cClientsCur--;
955	}
956	}
957	}
958	}
959	}
960
961	return rc;
962	}
963
964	/**
965	* The main thread waiting for new client connections.
966	*
967	* @returns VBox status code.
968	*/
969	static DECLCALLBACK(int) atsMainThread(RTTHREAD hThread, void *pvUser)
970	{
971	RT_NOREF(hThread);
972
973	LogRelFlowFuncEnter();
974
975	PATSSERVER pThis = (PATSSERVER)pvUser;
976	AssertPtrReturn(pThis, VERR_INVALID_POINTER);
977
978	int rc = RTThreadUserSignal(hThread);
979	AssertRCReturn(rc, rc);
980
981	while (!pThis->fTerminate)
982	{
983	/*
984	* Wait for new connection and spin off a new thread
985	* for every new client.
986	*/
987	bool fFromServer;
988	PATSTRANSPORTCLIENT pTransportClient;
989	rc = pThis->pTransport->pfnWaitForConnect(pThis->pTransportInst, 1000 /* msTimeout */, &fFromServer, &pTransportClient);
990	if (RT_FAILURE(rc))
991	continue;
992
993	/*
994	* New connection, create new client structure and spin of
995	* the request handling thread.
996	*/
997	PATSCLIENTINST pInst = (PATSCLIENTINST)RTMemAllocZ(sizeof(ATSCLIENTINST));
998	if (RT_LIKELY(pInst))
999	{
1000	pInst->enmState = ATSCLIENTSTATE_INITIALISING;
1001	pInst->pTransportClient = pTransportClient;
1002	pInst->pszHostname = NULL;
1003
1004	/* Add client to the new list and inform the worker thread. */
1005	RTCritSectEnter(&pThis->CritSectClients);
1006	RTListAppend(&pThis->LstClientsNew, &pInst->NdLst);
1007	RTCritSectLeave(&pThis->CritSectClients);
1008
1009	size_t cbWritten = 0;
1010	rc = RTPipeWrite(pThis->hPipeW, "", 1, &cbWritten);
1011	if (RT_FAILURE(rc))
1012	LogRelFunc(("Failed to inform worker thread of a new client, rc=%Rrc\n", rc));
1013	}
1014	else
1015	{
1016	LogRelFunc(("Creating new client structure failed with out of memory error\n"));
1017	pThis->pTransport->pfnNotifyBye(pThis->pTransportInst, pTransportClient);
1018	rc = VERR_NO_MEMORY;
1019	break; /* This is fatal, break out of the loop. */
1020	}
1021
1022	if (RT_SUCCESS(rc))
1023	{
1024	LogRelFunc(("New connection established (%s)\n", fFromServer ? "from server" : "as client"));
1025
1026	/**
1027	* If the new client is not from our server but from a remote server (also called a reverse connection),
1028	* exit this loop and stop trying to connect to the remote server.
1029	*
1030	* Otherwise we would connect lots and lots of clients without any real use.
1031	*
1032	** @todo Improve this handling -- there might be a better / more elegant solution.
1033	*/
1034	if (!fFromServer)
1035	break;
1036	}
1037	}
1038
1039	LogRelFlowFuncLeaveRC(rc);
1040	return rc;
1041	}
1042
1043	/**
1044	* Initializes an ATS instance.
1045	*
1046	* @note This does not start the server!
1047	*
1048	* @returns VBox status code.
1049	* @param pThis The ATS instance.
1050	* @param pCallbacks The callbacks table to use.
1051	*/
1052	int AudioTestSvcInit(PATSSERVER pThis, PCATSCALLBACKS pCallbacks)
1053	{
1054	LogRelFlowFuncEnter();
1055
1056	RT_BZERO(pThis, sizeof(ATSSERVER));
1057
1058	pThis->hPipeR = NIL_RTPIPE;
1059	pThis->hPipeW = NIL_RTPIPE;
1060
1061	RTListInit(&pThis->LstClientsNew);
1062
1063	/* Copy callback table. */
1064	memcpy(&pThis->Callbacks, pCallbacks, sizeof(ATSCALLBACKS));
1065
1066	int rc = RTCritSectInit(&pThis->CritSectClients);
1067	if (RT_SUCCESS(rc))
1068	{
1069	rc = RTPollSetCreate(&pThis->hPollSet);
1070	if (RT_SUCCESS(rc))
1071	{
1072	rc = RTPipeCreate(&pThis->hPipeR, &pThis->hPipeW, 0);
1073	if (RT_SUCCESS(rc))
1074	{
1075	/*
1076	* The default transporter is the first one.
1077	*/
1078	pThis->pTransport = g_apTransports[0]; /** @todo Make this dynamic. */
1079
1080	rc = pThis->pTransport->pfnCreate(&pThis->pTransportInst);
1081	if (RT_SUCCESS(rc))
1082	return VINF_SUCCESS;
1083
1084	RTPipeClose(pThis->hPipeR);
1085	RTPipeClose(pThis->hPipeW);
1086	}
1087	else
1088	LogRel(("Creating communications pipe failed with %Rrc\n", rc));
1089
1090	RTPollSetDestroy(pThis->hPollSet);
1091	}
1092	else
1093	LogRel(("Creating pollset failed with %Rrc\n", rc));
1094
1095	RTCritSectDelete(&pThis->CritSectClients);
1096	}
1097	else
1098	LogRel(("Creating critical section failed with %Rrc\n", rc));
1099
1100	if (RT_FAILURE(rc))
1101	LogRel(("Creating server failed with %Rrc\n", rc));
1102
1103	LogRelFlowFuncLeaveRC(rc);
1104	return rc;
1105	}
1106
1107	/**
1108	* Handles a command line option.
1109	*
1110	* @returns VBox status code.
1111	* @param pThis The ATS instance to handle option for.
1112	* @param ch Option (short) to handle.
1113	* @param pVal Option union to store the result in on success.
1114	*/
1115	int AudioTestSvcHandleOption(PATSSERVER pThis, int ch, PCRTGETOPTUNION pVal)
1116	{
1117	AssertPtrReturn(pThis->pTransport, VERR_WRONG_ORDER); /* Must be creatd first. */
1118	if (!pThis->pTransport->pfnOption)
1119	return VERR_GETOPT_UNKNOWN_OPTION;
1120	return pThis->pTransport->pfnOption(pThis->pTransportInst, ch, pVal);
1121	}
1122
1123	/**
1124	* Starts a formerly initialized ATS instance.
1125	*
1126	* @returns VBox status code.
1127	* @param pThis The ATS instance to start.
1128	*/
1129	int AudioTestSvcStart(PATSSERVER pThis)
1130	{
1131	LogRelFlowFuncEnter();
1132
1133	/* Spin off the thread serving connections. */
1134	int rc = RTThreadCreate(&pThis->hThreadServing, atsClientWorker, pThis, 0, RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE,
1135	"ATSCLWORK");
1136	if (RT_FAILURE(rc))
1137	{
1138	LogRel(("Creating the client worker thread failed with %Rrc\n", rc));
1139	return rc;
1140	}
1141
1142	rc = pThis->pTransport->pfnStart(pThis->pTransportInst);
1143	if (RT_SUCCESS(rc))
1144	{
1145	/* Spin off the connection thread. */
1146	rc = RTThreadCreate(&pThis->hThreadMain, atsMainThread, pThis, 0, RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE,
1147	"ATSMAIN");
1148	if (RT_SUCCESS(rc))
1149	{
1150	rc = RTThreadUserWait(pThis->hThreadMain, RT_MS_30SEC);
1151	if (RT_SUCCESS(rc))
1152	pThis->fStarted = true;
1153	}
1154	}
1155
1156	LogRelFlowFuncLeaveRC(rc);
1157	return rc;
1158	}
1159
1160	/**
1161	* Stops (shuts down) a formerly started ATS instance.
1162	*
1163	* @returns VBox status code.
1164	* @param pThis The ATS instance.
1165	*/
1166	int AudioTestSvcStop(PATSSERVER pThis)
1167	{
1168	if (!pThis->fStarted)
1169	return VINF_SUCCESS;
1170
1171	LogRelFlowFuncEnter();
1172
1173	ASMAtomicXchgBool(&pThis->fTerminate, true);
1174
1175	if (pThis->pTransport)
1176	pThis->pTransport->pfnTerm(pThis->pTransportInst);
1177
1178	size_t cbWritten;
1179	int rc = RTPipeWrite(pThis->hPipeW, "", 1, &cbWritten);
1180	AssertRCReturn(rc, rc);
1181
1182	/* First close serving thread. */
1183	int rcThread;
1184	rc = RTThreadWait(pThis->hThreadServing, RT_MS_30SEC, &rcThread);
1185	if (RT_SUCCESS(rc))
1186	{
1187	rc = rcThread;
1188	if (RT_SUCCESS(rc))
1189	{
1190	/* Close the main thread last. */
1191	rc = RTThreadWait(pThis->hThreadMain, RT_MS_30SEC, &rcThread);
1192	if (RT_SUCCESS(rc))
1193	rc = rcThread;
1194
1195	if (rc == VERR_TCP_SERVER_DESTROYED)
1196	rc = VINF_SUCCESS;
1197	}
1198	}
1199
1200	if (RT_SUCCESS(rc))
1201	pThis->fStarted = false;
1202
1203	LogRelFlowFuncLeaveRC(rc);
1204	return rc;
1205	}
1206
1207	/**
1208	* Destroys an ATS instance, internal version.
1209	*
1210	* @returns VBox status code.
1211	* @param pThis ATS instance to destroy.
1212	*/
1213	static int audioTestSvcDestroyInternal(PATSSERVER pThis)
1214	{
1215	int rc = VINF_SUCCESS;
1216
1217	if (pThis->hPipeR != NIL_RTPIPE)
1218	{
1219	rc = RTPipeClose(pThis->hPipeR);
1220	AssertRCReturn(rc, rc);
1221	pThis->hPipeR = NIL_RTPIPE;
1222	}
1223
1224	if (pThis->hPipeW != NIL_RTPIPE)
1225	{
1226	rc = RTPipeClose(pThis->hPipeW);
1227	AssertRCReturn(rc, rc);
1228	pThis->hPipeW = NIL_RTPIPE;
1229	}
1230
1231	RTPollSetDestroy(pThis->hPollSet);
1232	pThis->hPollSet = NIL_RTPOLLSET;
1233
1234	PATSCLIENTINST pIt, pItNext;
1235	RTListForEachSafe(&pThis->LstClientsNew, pIt, pItNext, ATSCLIENTINST, NdLst)
1236	{
1237	RTListNodeRemove(&pIt->NdLst);
1238
1239	RTMemFree(pIt);
1240	pIt = NULL;
1241	}
1242
1243	if (RTCritSectIsInitialized(&pThis->CritSectClients))
1244	{
1245	rc = RTCritSectDelete(&pThis->CritSectClients);
1246	AssertRCReturn(rc, rc);
1247	}
1248
1249	return rc;
1250	}
1251
1252	/**
1253	* Destroys an ATS instance.
1254	*
1255	* @returns VBox status code.
1256	* @param pThis ATS instance to destroy.
1257	*/
1258	int AudioTestSvcDestroy(PATSSERVER pThis)
1259	{
1260	LogRelFlowFuncEnter();
1261
1262	int rc = audioTestSvcDestroyInternal(pThis);
1263	if (RT_SUCCESS(rc))
1264	{
1265	if (pThis->pTransport)
1266	{
1267	if ( pThis->pTransport->pfnDestroy
1268	&& pThis->pTransportInst)
1269	{
1270	pThis->pTransport->pfnDestroy(pThis->pTransportInst);
1271	pThis->pTransportInst = NULL;
1272	}
1273	}
1274	}
1275
1276	LogRelFlowFuncLeaveRC(rc);
1277	return rc;
1278	}

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

source: vbox/trunk/src/VBox/Devices/Audio/AudioTestService.cpp@ 91533

Download in other formats: