DrvHostBase.cpp@ 63429

Last change on this file since 63429 was 62956, checked in by vboxsync, 8 years ago
@copydoc -> @interface_method_impl
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 76.6 KB

Line
1	/* $Id: DrvHostBase.cpp 62956 2016-08-04 07:49:34Z vboxsync $ */
2	/** @file
3	* DrvHostBase - Host base drive access driver.
4	*/
5
6	/*
7	* Copyright (C) 2006-2016 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_DRV_HOST_BASE
23	#ifdef RT_OS_DARWIN
24	# include <mach/mach.h>
25	# include <Carbon/Carbon.h>
26	# include <IOKit/IOKitLib.h>
27	# include <IOKit/storage/IOStorageDeviceCharacteristics.h>
28	# include <IOKit/scsi/SCSITaskLib.h>
29	# include <IOKit/scsi/SCSICommandOperationCodes.h>
30	# include <IOKit/IOBSD.h>
31	# include <DiskArbitration/DiskArbitration.h>
32	# include <mach/mach_error.h>
33	# include <VBox/scsi.h>
34
35	#elif defined(RT_OS_L4)
36	/* Nothing special requires... yeah, right. */
37
38	#elif defined(RT_OS_LINUX)
39	# include <sys/ioctl.h>
40	# include <sys/fcntl.h>
41	# include <errno.h>
42
43	#elif defined(RT_OS_SOLARIS)
44	# include <fcntl.h>
45	# include <errno.h>
46	# include <stropts.h>
47	# include <malloc.h>
48	# include <sys/dkio.h>
49	extern "C" char getfullblkname(char );
50
51	#elif defined(RT_OS_WINDOWS)
52	# define WIN32_NO_STATUS
53	# include <iprt/win/windows.h>
54	# include <dbt.h>
55	# undef WIN32_NO_STATUS
56	# include <ntstatus.h>
57
58	/* from ntdef.h */
59	typedef LONG NTSTATUS;
60
61	/* from ntddk.h */
62	typedef struct _IO_STATUS_BLOCK {
63	union {
64	NTSTATUS Status;
65	PVOID Pointer;
66	};
67	ULONG_PTR Information;
68	} IO_STATUS_BLOCK, *PIO_STATUS_BLOCK;
69
70
71	/* from ntinternals.com */
72	typedef enum _FS_INFORMATION_CLASS {
73	FileFsVolumeInformation=1,
74	FileFsLabelInformation,
75	FileFsSizeInformation,
76	FileFsDeviceInformation,
77	FileFsAttributeInformation,
78	FileFsControlInformation,
79	FileFsFullSizeInformation,
80	FileFsObjectIdInformation,
81	FileFsMaximumInformation
82	} FS_INFORMATION_CLASS, *PFS_INFORMATION_CLASS;
83
84	typedef struct _FILE_FS_SIZE_INFORMATION {
85	LARGE_INTEGER TotalAllocationUnits;
86	LARGE_INTEGER AvailableAllocationUnits;
87	ULONG SectorsPerAllocationUnit;
88	ULONG BytesPerSector;
89	} FILE_FS_SIZE_INFORMATION, *PFILE_FS_SIZE_INFORMATION;
90
91	extern "C"
92	NTSTATUS __stdcall NtQueryVolumeInformationFile(
93	/IN/ HANDLE FileHandle,
94	/OUT/ PIO_STATUS_BLOCK IoStatusBlock,
95	/OUT/ PVOID FileSystemInformation,
96	/IN/ ULONG Length,
97	/IN/ FS_INFORMATION_CLASS FileSystemInformationClass );
98
99	#elif defined(RT_OS_FREEBSD)
100	# include <sys/cdefs.h>
101	# include <sys/param.h>
102	# include <errno.h>
103	# include <stdio.h>
104	# include <cam/cam.h>
105	# include <cam/cam_ccb.h>
106	# include <cam/scsi/scsi_message.h>
107	# include <cam/scsi/scsi_pass.h>
108	# include <VBox/scsi.h>
109	# include <iprt/log.h>
110	#else
111	# error "Unsupported Platform."
112	#endif
113
114	#include <VBox/vmm/pdmdrv.h>
115	#include <VBox/vmm/pdmstorageifs.h>
116	#include <iprt/assert.h>
117	#include <iprt/file.h>
118	#include <iprt/path.h>
119	#include <iprt/string.h>
120	#include <iprt/thread.h>
121	#include <iprt/semaphore.h>
122	#include <iprt/uuid.h>
123	#include <iprt/asm.h>
124	#include <iprt/critsect.h>
125	#include <iprt/ctype.h>
126	#include <iprt/mem.h>
127
128	#include "DrvHostBase.h"
129
130
131
132
133	/* -=-=-=-=- IBlock -=-=-=-=- */
134
135	/** @interface_method_impl{PDMIBLOCK,pfnRead} */
136	static DECLCALLBACK(int) drvHostBaseRead(PPDMIMEDIA pInterface, uint64_t off, void *pvBuf, size_t cbRead)
137	{
138	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
139	LogFlow(("%s-%d: drvHostBaseRead: off=%#llx pvBuf=%p cbRead=%#x (%s)\n",
140	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, off, pvBuf, cbRead, pThis->pszDevice));
141	RTCritSectEnter(&pThis->CritSect);
142
143	/*
144	* Check the state.
145	*/
146	int rc;
147	#ifdef RT_OS_DARWIN
148	if ( pThis->fMediaPresent
149	&& pThis->ppScsiTaskDI
150	&& pThis->cbBlock)
151	#elif defined(RT_OS_FREEBSD)
152	if ( pThis->fMediaPresent
153	&& pThis->cbBlock)
154	#else
155	if (pThis->fMediaPresent)
156	#endif
157	{
158	#if defined(RT_OS_DARWIN) \|\| defined(RT_OS_FREEBSD)
159	/*
160	* Issue a READ(12) request.
161	*/
162	do
163	{
164	const uint32_t LBA = off / pThis->cbBlock;
165	AssertReturn(!(off % pThis->cbBlock), VERR_INVALID_PARAMETER);
166	uint32_t cbRead32 = cbRead > SCSI_MAX_BUFFER_SIZE
167	? SCSI_MAX_BUFFER_SIZE
168	: (uint32_t)cbRead;
169	const uint32_t cBlocks = cbRead32 / pThis->cbBlock;
170	AssertReturn(!(cbRead % pThis->cbBlock), VERR_INVALID_PARAMETER);
171	uint8_t abCmd[16] =
172	{
173	SCSI_READ_12, 0,
174	RT_BYTE4(LBA), RT_BYTE3(LBA), RT_BYTE2(LBA), RT_BYTE1(LBA),
175	RT_BYTE4(cBlocks), RT_BYTE3(cBlocks), RT_BYTE2(cBlocks), RT_BYTE1(cBlocks),
176	0, 0, 0, 0, 0
177	};
178	rc = DRVHostBaseScsiCmd(pThis, abCmd, 12, PDMMEDIATXDIR_FROM_DEVICE, pvBuf, &cbRead32, NULL, 0, 0);
179
180	off += cbRead32;
181	cbRead -= cbRead32;
182	pvBuf = (uint8_t *)pvBuf + cbRead32;
183	} while ((cbRead > 0) && RT_SUCCESS(rc));
184
185	#else
186	/*
187	* Seek and read.
188	*/
189	rc = RTFileReadAt(pThis->hFileDevice, off, pvBuf, cbRead, NULL);
190	if (RT_SUCCESS(rc))
191	{
192	Log2(("%s-%d: drvHostBaseRead: off=%#llx cbRead=%#x\n"
193	"%16.*Rhxd\n",
194	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, off, cbRead, cbRead, pvBuf));
195	}
196	else
197	Log(("%s-%d: drvHostBaseRead: RTFileReadAt(%RTfile, %#llx, %p, %#x) -> %Rrc ('%s')\n",
198	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, pThis->hFileDevice,
199	off, pvBuf, cbRead, rc, pThis->pszDevice));
200	#endif
201	}
202	else
203	rc = VERR_MEDIA_NOT_PRESENT;
204
205	RTCritSectLeave(&pThis->CritSect);
206	LogFlow(("%s-%d: drvHostBaseRead: returns %Rrc\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, rc));
207	return rc;
208	}
209
210
211	/** @interface_method_impl{PDMIBLOCK,pfnWrite} */
212	static DECLCALLBACK(int) drvHostBaseWrite(PPDMIMEDIA pInterface, uint64_t off, const void *pvBuf, size_t cbWrite)
213	{
214	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
215	LogFlow(("%s-%d: drvHostBaseWrite: off=%#llx pvBuf=%p cbWrite=%#x (%s)\n",
216	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, off, pvBuf, cbWrite, pThis->pszDevice));
217	Log2(("%s-%d: drvHostBaseWrite: off=%#llx cbWrite=%#x\n"
218	"%16.*Rhxd\n",
219	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, off, cbWrite, cbWrite, pvBuf));
220	RTCritSectEnter(&pThis->CritSect);
221
222	/*
223	* Check the state.
224	*/
225	int rc;
226	if (!pThis->fReadOnly)
227	{
228	if (pThis->fMediaPresent)
229	{
230	#if defined(RT_OS_DARWIN) \|\| defined(RT_OS_FREEBSD)
231	/** @todo write support... */
232	rc = VERR_WRITE_PROTECT;
233
234	#else
235	/*
236	* Seek and write.
237	*/
238	rc = RTFileWriteAt(pThis->hFileDevice, off, pvBuf, cbWrite, NULL);
239	if (RT_FAILURE(rc))
240	Log(("%s-%d: drvHostBaseWrite: RTFileWriteAt(%RTfile, %#llx, %p, %#x) -> %Rrc ('%s')\n",
241	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, pThis->hFileDevice,
242	off, pvBuf, cbWrite, rc, pThis->pszDevice));
243	#endif
244	}
245	else
246	rc = VERR_MEDIA_NOT_PRESENT;
247	}
248	else
249	rc = VERR_WRITE_PROTECT;
250
251	RTCritSectLeave(&pThis->CritSect);
252	LogFlow(("%s-%d: drvHostBaseWrite: returns %Rrc\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, rc));
253	return rc;
254	}
255
256
257	/** @interface_method_impl{PDMIBLOCK,pfnFlush} */
258	static DECLCALLBACK(int) drvHostBaseFlush(PPDMIMEDIA pInterface)
259	{
260	int rc;
261	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
262	LogFlow(("%s-%d: drvHostBaseFlush: (%s)\n",
263	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, pThis->pszDevice));
264	RTCritSectEnter(&pThis->CritSect);
265
266	if (pThis->fMediaPresent)
267	{
268	#if defined(RT_OS_DARWIN) \|\| defined(RT_OS_FREEBSD)
269	rc = VINF_SUCCESS;
270	/** @todo scsi device buffer flush... */
271	#else
272	rc = RTFileFlush(pThis->hFileDevice);
273	#endif
274	}
275	else
276	rc = VERR_MEDIA_NOT_PRESENT;
277
278	RTCritSectLeave(&pThis->CritSect);
279	LogFlow(("%s-%d: drvHostBaseFlush: returns %Rrc\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, rc));
280	return rc;
281	}
282
283
284	/** @interface_method_impl{PDMIBLOCK,pfnIsReadOnly} */
285	static DECLCALLBACK(bool) drvHostBaseIsReadOnly(PPDMIMEDIA pInterface)
286	{
287	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
288	return pThis->fReadOnly;
289	}
290
291
292	/** @interface_method_impl{PDMIBLOCK,pfnGetSize} */
293	static DECLCALLBACK(uint64_t) drvHostBaseGetSize(PPDMIMEDIA pInterface)
294	{
295	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
296	RTCritSectEnter(&pThis->CritSect);
297
298	uint64_t cb = 0;
299	if (pThis->fMediaPresent)
300	cb = pThis->cbSize;
301
302	RTCritSectLeave(&pThis->CritSect);
303	LogFlow(("%s-%d: drvHostBaseGetSize: returns %llu\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, cb));
304	return cb;
305	}
306
307
308	/** @interface_method_impl{PDMIBLOCK,pfnGetType} */
309	static DECLCALLBACK(PDMMEDIATYPE) drvHostBaseGetType(PPDMIMEDIA pInterface)
310	{
311	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
312	LogFlow(("%s-%d: drvHostBaseGetType: returns %d\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, pThis->enmType));
313	return pThis->enmType;
314	}
315
316
317	/** @interface_method_impl{PDMIBLOCK,pfnGetUuid} */
318	static DECLCALLBACK(int) drvHostBaseGetUuid(PPDMIMEDIA pInterface, PRTUUID pUuid)
319	{
320	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
321
322	*pUuid = pThis->Uuid;
323
324	LogFlow(("%s-%d: drvHostBaseGetUuid: returns VINF_SUCCESS *pUuid=%RTuuid\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, pUuid));
325	return VINF_SUCCESS;
326	}
327
328
329	/** @interface_method_impl{PDMIBLOCK,pfnIoBufAlloc} */
330	static DECLCALLBACK(int) drvHostBaseIoBufAlloc(PPDMIMEDIA pInterface, size_t cb, void **ppvNew)
331	{
332	RT_NOREF(pInterface);
333	LogFlowFunc(("\n"));
334
335	int rc;
336	void *pvNew = RTMemAlloc(cb);
337	if (RT_LIKELY(pvNew))
338	{
339	*ppvNew = pvNew;
340	rc = VINF_SUCCESS;
341	}
342	else
343	rc = VERR_NO_MEMORY;
344
345	LogFlowFunc(("returns %Rrc\n", rc));
346	return rc;
347	}
348
349	/** @interface_method_impl{PDMIBLOCK,pfnIoBufFree} */
350	static DECLCALLBACK(int) drvHostBaseIoBufFree(PPDMIMEDIA pInterface, void *pv, size_t cb)
351	{
352	RT_NOREF(pInterface, cb);
353	LogFlowFunc(("\n"));
354
355	RTMemFree(pv);
356
357	LogFlowFunc(("returns %Rrc\n", VINF_SUCCESS));
358	return VINF_SUCCESS;
359	}
360
361
362	/** @interface_method_impl{PDMIBLOCKBIOS,pfnBiosGetPCHSGeometry} */
363	static DECLCALLBACK(int) drvHostBaseGetPCHSGeometry(PPDMIMEDIA pInterface, PPDMMEDIAGEOMETRY pPCHSGeometry)
364	{
365	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
366	RTCritSectEnter(&pThis->CritSect);
367
368	int rc = VINF_SUCCESS;
369	if (pThis->fMediaPresent)
370	{
371	if ( pThis->PCHSGeometry.cCylinders > 0
372	&& pThis->PCHSGeometry.cHeads > 0
373	&& pThis->PCHSGeometry.cSectors > 0)
374	{
375	*pPCHSGeometry = pThis->PCHSGeometry;
376	}
377	else
378	rc = VERR_PDM_GEOMETRY_NOT_SET;
379	}
380	else
381	rc = VERR_PDM_MEDIA_NOT_MOUNTED;
382
383	RTCritSectLeave(&pThis->CritSect);
384	LogFlow(("%s-%d: %s: returns %Rrc CHS={%d,%d,%d}\n",
385	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, __FUNCTION__, rc, pThis->PCHSGeometry.cCylinders, pThis->PCHSGeometry.cHeads, pThis->PCHSGeometry.cSectors));
386	return rc;
387	}
388
389
390	/** @interface_method_impl{PDMIBLOCKBIOS,pfnBiosSetPCHSGeometry} */
391	static DECLCALLBACK(int) drvHostBaseSetPCHSGeometry(PPDMIMEDIA pInterface, PCPDMMEDIAGEOMETRY pPCHSGeometry)
392	{
393	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
394	LogFlow(("%s-%d: %s: cCylinders=%d cHeads=%d cSectors=%d\n",
395	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, __FUNCTION__, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
396	RTCritSectEnter(&pThis->CritSect);
397
398	int rc = VINF_SUCCESS;
399	if (pThis->fMediaPresent)
400	{
401	pThis->PCHSGeometry = *pPCHSGeometry;
402	}
403	else
404	{
405	AssertMsgFailed(("Invalid state! Not mounted!\n"));
406	rc = VERR_PDM_MEDIA_NOT_MOUNTED;
407	}
408
409	RTCritSectLeave(&pThis->CritSect);
410	return rc;
411	}
412
413
414	/** @interface_method_impl{PDMIBLOCKBIOS,pfnGetLCHSGeometry} */
415	static DECLCALLBACK(int) drvHostBaseGetLCHSGeometry(PPDMIMEDIA pInterface, PPDMMEDIAGEOMETRY pLCHSGeometry)
416	{
417	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
418	RTCritSectEnter(&pThis->CritSect);
419
420	int rc = VINF_SUCCESS;
421	if (pThis->fMediaPresent)
422	{
423	if ( pThis->LCHSGeometry.cCylinders > 0
424	&& pThis->LCHSGeometry.cHeads > 0
425	&& pThis->LCHSGeometry.cSectors > 0)
426	{
427	*pLCHSGeometry = pThis->LCHSGeometry;
428	}
429	else
430	rc = VERR_PDM_GEOMETRY_NOT_SET;
431	}
432	else
433	rc = VERR_PDM_MEDIA_NOT_MOUNTED;
434
435	RTCritSectLeave(&pThis->CritSect);
436	LogFlow(("%s-%d: %s: returns %Rrc CHS={%d,%d,%d}\n",
437	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, __FUNCTION__, rc, pThis->LCHSGeometry.cCylinders, pThis->LCHSGeometry.cHeads, pThis->LCHSGeometry.cSectors));
438	return rc;
439	}
440
441
442	/** @interface_method_impl{PDMIBLOCKBIOS,pfnSetLCHSGeometry} */
443	static DECLCALLBACK(int) drvHostBaseSetLCHSGeometry(PPDMIMEDIA pInterface, PCPDMMEDIAGEOMETRY pLCHSGeometry)
444	{
445	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
446	LogFlow(("%s-%d: %s: cCylinders=%d cHeads=%d cSectors=%d\n",
447	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, __FUNCTION__, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
448	RTCritSectEnter(&pThis->CritSect);
449
450	int rc = VINF_SUCCESS;
451	if (pThis->fMediaPresent)
452	{
453	pThis->LCHSGeometry = *pLCHSGeometry;
454	}
455	else
456	{
457	AssertMsgFailed(("Invalid state! Not mounted!\n"));
458	rc = VERR_PDM_MEDIA_NOT_MOUNTED;
459	}
460
461	RTCritSectLeave(&pThis->CritSect);
462	return rc;
463	}
464
465
466	/** @interface_method_impl{PDMIBLOCKBIOS,pfnIsVisible} */
467	static DECLCALLBACK(bool) drvHostBaseIsVisible(PPDMIMEDIA pInterface)
468	{
469	PDRVHOSTBASE pThis = PDMIMEDIA_2_DRVHOSTBASE(pInterface);
470	return pThis->fBiosVisible;
471	}
472
473
474
475	/* -=-=-=-=- IMount -=-=-=-=- */
476
477	/** @interface_method_impl{PDMIMOUNT,pfnUnmount} */
478	static DECLCALLBACK(int) drvHostBaseUnmount(PPDMIMOUNT pInterface, bool fForce, bool fEject)
479	{
480	RT_NOREF(fEject);
481	/* While we're not mountable (see drvHostBaseMount), we're unmountable. */
482	PDRVHOSTBASE pThis = PDMIMOUNT_2_DRVHOSTBASE(pInterface);
483	RTCritSectEnter(&pThis->CritSect);
484
485	/*
486	* Validate state.
487	*/
488	int rc = VINF_SUCCESS;
489	if (!pThis->fLocked \|\| fForce)
490	{
491	/* Unlock drive if necessary. */
492	if (pThis->fLocked)
493	{
494	if (pThis->pfnDoLock)
495	rc = pThis->pfnDoLock(pThis, false);
496	if (RT_SUCCESS(rc))
497	pThis->fLocked = false;
498	}
499
500	/*
501	* Media is no longer present.
502	*/
503	DRVHostBaseMediaNotPresent(pThis);
504	}
505	else
506	{
507	Log(("drvHostiBaseUnmount: Locked\n"));
508	rc = VERR_PDM_MEDIA_LOCKED;
509	}
510
511	RTCritSectLeave(&pThis->CritSect);
512	LogFlow(("drvHostBaseUnmount: returns %Rrc\n", rc));
513	return rc;
514	}
515
516
517	/** @interface_method_impl{PDMIMOUNT,pfnIsMounted} */
518	static DECLCALLBACK(bool) drvHostBaseIsMounted(PPDMIMOUNT pInterface)
519	{
520	PDRVHOSTBASE pThis = PDMIMOUNT_2_DRVHOSTBASE(pInterface);
521	RTCritSectEnter(&pThis->CritSect);
522
523	bool fRc = pThis->fMediaPresent;
524
525	RTCritSectLeave(&pThis->CritSect);
526	return fRc;
527	}
528
529
530	/** @interface_method_impl{PDMIMOUNT,pfnIsLocked} */
531	static DECLCALLBACK(int) drvHostBaseLock(PPDMIMOUNT pInterface)
532	{
533	PDRVHOSTBASE pThis = PDMIMOUNT_2_DRVHOSTBASE(pInterface);
534	RTCritSectEnter(&pThis->CritSect);
535
536	int rc = VINF_SUCCESS;
537	if (!pThis->fLocked)
538	{
539	if (pThis->pfnDoLock)
540	rc = pThis->pfnDoLock(pThis, true);
541	if (RT_SUCCESS(rc))
542	pThis->fLocked = true;
543	}
544	else
545	LogFlow(("%s-%d: drvHostBaseLock: already locked\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance));
546
547	RTCritSectLeave(&pThis->CritSect);
548	LogFlow(("%s-%d: drvHostBaseLock: returns %Rrc\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, rc));
549	return rc;
550	}
551
552
553	/** @interface_method_impl{PDMIMOUNT,pfnIsLocked} */
554	static DECLCALLBACK(int) drvHostBaseUnlock(PPDMIMOUNT pInterface)
555	{
556	PDRVHOSTBASE pThis = PDMIMOUNT_2_DRVHOSTBASE(pInterface);
557	RTCritSectEnter(&pThis->CritSect);
558
559	int rc = VINF_SUCCESS;
560	if (pThis->fLocked)
561	{
562	if (pThis->pfnDoLock)
563	rc = pThis->pfnDoLock(pThis, false);
564	if (RT_SUCCESS(rc))
565	pThis->fLocked = false;
566	}
567	else
568	LogFlow(("%s-%d: drvHostBaseUnlock: not locked\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance));
569
570	RTCritSectLeave(&pThis->CritSect);
571	LogFlow(("%s-%d: drvHostBaseUnlock: returns %Rrc\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, rc));
572	return rc;
573	}
574
575
576	/** @interface_method_impl{PDMIMOUNT,pfnIsLocked} */
577	static DECLCALLBACK(bool) drvHostBaseIsLocked(PPDMIMOUNT pInterface)
578	{
579	PDRVHOSTBASE pThis = PDMIMOUNT_2_DRVHOSTBASE(pInterface);
580	RTCritSectEnter(&pThis->CritSect);
581
582	bool fRc = pThis->fLocked;
583
584	RTCritSectLeave(&pThis->CritSect);
585	return fRc;
586	}
587
588
589	/* -=-=-=-=- IBase -=-=-=-=- */
590
591	/**
592	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
593	*/
594	static DECLCALLBACK(void ) drvHostBaseQueryInterface(PPDMIBASE pInterface, const char pszIID)
595	{
596	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
597	PDRVHOSTBASE pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTBASE);
598
599	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
600	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIA, &pThis->IMedia);
601	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMOUNT, &pThis->IMount);
602	return NULL;
603	}
604
605
606	/* -=-=-=-=- poller thread -=-=-=-=- */
607
608	#ifdef RT_OS_DARWIN
609	/** The runloop input source name for the disk arbitration events. */
610	# define MY_RUN_LOOP_MODE CFSTR("drvHostBaseDA") /** @todo r=bird: Check if this will cause trouble in the same way that the one in the USB code did. */
611
612	/**
613	* Gets the BSD Name (/dev/disc[0-9]+) for the service.
614	*
615	* This is done by recursing down the I/O registry until we hit upon an entry
616	* with a BSD Name. Usually we find it two levels down. (Further down under
617	* the IOCDPartitionScheme, the volume (slices) BSD Name is found. We don't
618	* seem to have to go this far fortunately.)
619	*
620	* @return VINF_SUCCESS if found, VERR_FILE_NOT_FOUND otherwise.
621	* @param Entry The current I/O registry entry reference.
622	* @param pszName Where to store the name. 128 bytes.
623	* @param cRecursions Number of recursions. This is used as an precaution
624	* just to limit the depth and avoid blowing the stack
625	* should we hit a bug or something.
626	*/
627	static int drvHostBaseGetBSDName(io_registry_entry_t Entry, char *pszName, unsigned cRecursions)
628	{
629	int rc = VERR_FILE_NOT_FOUND;
630	io_iterator_t Children = 0;
631	kern_return_t krc = IORegistryEntryGetChildIterator(Entry, kIOServicePlane, &Children);
632	if (krc == KERN_SUCCESS)
633	{
634	io_object_t Child;
635	while ( rc == VERR_FILE_NOT_FOUND
636	&& (Child = IOIteratorNext(Children)) != 0)
637	{
638	CFStringRef BSDNameStrRef = (CFStringRef)IORegistryEntryCreateCFProperty(Child, CFSTR(kIOBSDNameKey), kCFAllocatorDefault, 0);
639	if (BSDNameStrRef)
640	{
641	if (CFStringGetCString(BSDNameStrRef, pszName, 128, kCFStringEncodingUTF8))
642	rc = VINF_SUCCESS;
643	else
644	AssertFailed();
645	CFRelease(BSDNameStrRef);
646	}
647	if (rc == VERR_FILE_NOT_FOUND && cRecursions < 10)
648	rc = drvHostBaseGetBSDName(Child, pszName, cRecursions + 1);
649	IOObjectRelease(Child);
650	}
651	IOObjectRelease(Children);
652	}
653	return rc;
654	}
655
656
657	/**
658	* Callback notifying us that the async DADiskClaim()/DADiskUnmount call has completed.
659	*
660	* @param DiskRef The disk that was attempted claimed / unmounted.
661	* @param DissenterRef NULL on success, contains details on failure.
662	* @param pvContext Pointer to the return code variable.
663	*/
664	static void drvHostBaseDADoneCallback(DADiskRef DiskRef, DADissenterRef DissenterRef, void *pvContext)
665	{
666	int prc = (int )pvContext;
667	if (!DissenterRef)
668	*prc = 0;
669	else
670	*prc = DADissenterGetStatus(DissenterRef) ? DADissenterGetStatus(DissenterRef) : -1;
671	CFRunLoopStop(CFRunLoopGetCurrent());
672	}
673
674
675	/**
676	* Obtain exclusive access to the DVD device, umount it if necessary.
677	*
678	* @return VBox status code.
679	* @param pThis The driver instance.
680	* @param DVDService The DVD service object.
681	*/
682	static int drvHostBaseObtainExclusiveAccess(PDRVHOSTBASE pThis, io_object_t DVDService)
683	{
684	PPDMDRVINS pDrvIns = pThis->pDrvIns; NOREF(pDrvIns);
685
686	for (unsigned iTry = 0;; iTry++)
687	{
688	IOReturn irc = (*pThis->ppScsiTaskDI)->ObtainExclusiveAccess(pThis->ppScsiTaskDI);
689	if (irc == kIOReturnSuccess)
690	{
691	/*
692	* This is a bit weird, but if we unmounted the DVD drive we also need to
693	* unlock it afterwards or the guest won't be able to eject it later on.
694	*/
695	if (pThis->pDADisk)
696	{
697	uint8_t abCmd[16] =
698	{
699	SCSI_PREVENT_ALLOW_MEDIUM_REMOVAL, 0, 0, 0, false, 0,
700	0,0,0,0,0,0,0,0,0,0
701	};
702	DRVHostBaseScsiCmd(pThis, abCmd, 6, PDMMEDIATXDIR_NONE, NULL, NULL, NULL, 0, 0);
703	}
704	return VINF_SUCCESS;
705	}
706	if (irc == kIOReturnExclusiveAccess)
707	return VERR_SHARING_VIOLATION; /* already used exclusivly. */
708	if (irc != kIOReturnBusy)
709	return VERR_GENERAL_FAILURE; /* not mounted */
710
711	/*
712	* Attempt to the unmount all volumes of the device.
713	* It seems we can can do this all in one go without having to enumerate the
714	* volumes (sessions) and deal with them one by one. This is very fortuitous
715	* as the disk arbitration API is a bit cumbersome to deal with.
716	*/
717	if (iTry > 2)
718	return VERR_DRIVE_LOCKED;
719	char szName[128];
720	int rc = drvHostBaseGetBSDName(DVDService, &szName[0], 0);
721	if (RT_SUCCESS(rc))
722	{
723	pThis->pDASession = DASessionCreate(kCFAllocatorDefault);
724	if (pThis->pDASession)
725	{
726	DASessionScheduleWithRunLoop(pThis->pDASession, CFRunLoopGetCurrent(), MY_RUN_LOOP_MODE);
727	pThis->pDADisk = DADiskCreateFromBSDName(kCFAllocatorDefault, pThis->pDASession, szName);
728	if (pThis->pDADisk)
729	{
730	/*
731	* Try claim the device.
732	*/
733	Log(("%s-%d: calling DADiskClaim on '%s'.\n", pDrvIns->pReg->szName, pDrvIns->iInstance, szName));
734	int rcDA = -2;
735	DADiskClaim(pThis->pDADisk, kDADiskClaimOptionDefault, NULL, NULL, drvHostBaseDADoneCallback, &rcDA);
736	SInt32 rc32 = CFRunLoopRunInMode(MY_RUN_LOOP_MODE, 120.0, FALSE);
737	AssertMsg(rc32 == kCFRunLoopRunStopped, ("rc32=%RI32 (%RX32)\n", rc32, rc32));
738	if ( rc32 == kCFRunLoopRunStopped
739	&& !rcDA)
740	{
741	/*
742	* Try unmount the device.
743	*/
744	Log(("%s-%d: calling DADiskUnmount on '%s'.\n", pDrvIns->pReg->szName, pDrvIns->iInstance, szName));
745	rcDA = -2;
746	DADiskUnmount(pThis->pDADisk, kDADiskUnmountOptionWhole, drvHostBaseDADoneCallback, &rcDA);
747	rc32 = CFRunLoopRunInMode(MY_RUN_LOOP_MODE, 120.0, FALSE);
748	AssertMsg(rc32 == kCFRunLoopRunStopped, ("rc32=%RI32 (%RX32)\n", rc32, rc32));
749	if ( rc32 == kCFRunLoopRunStopped
750	&& !rcDA)
751	{
752	iTry = 99;
753	DASessionUnscheduleFromRunLoop(pThis->pDASession, CFRunLoopGetCurrent(), MY_RUN_LOOP_MODE);
754	Log(("%s-%d: unmount succeed - retrying.\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
755	continue;
756	}
757	Log(("%s-%d: umount => rc32=%d & rcDA=%#x\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc32, rcDA));
758
759	/* failed - cleanup */
760	DADiskUnclaim(pThis->pDADisk);
761	}
762	else
763	Log(("%s-%d: claim => rc32=%d & rcDA=%#x\n", pDrvIns->pReg->szName, pDrvIns->iInstance, rc32, rcDA));
764
765	CFRelease(pThis->pDADisk);
766	pThis->pDADisk = NULL;
767	}
768	else
769	Log(("%s-%d: failed to open disk '%s'!\n", pDrvIns->pReg->szName, pDrvIns->iInstance, szName));
770
771	DASessionUnscheduleFromRunLoop(pThis->pDASession, CFRunLoopGetCurrent(), MY_RUN_LOOP_MODE);
772	CFRelease(pThis->pDASession);
773	pThis->pDASession = NULL;
774	}
775	else
776	Log(("%s-%d: failed to create DA session!\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
777	}
778	RTThreadSleep(10);
779	}
780	}
781	#endif /* RT_OS_DARWIN */
782
783
784	#ifndef RT_OS_SOLARIS
785	/**
786	* Wrapper for open / RTFileOpen / IOKit.
787	*
788	* @remark The Darwin code must correspond exactly to the enumeration
789	* done in Main/darwin/iokit.c.
790	*/
791	static int drvHostBaseOpen(PDRVHOSTBASE pThis, PRTFILE pFileDevice, bool fReadOnly)
792	{
793	# ifdef RT_OS_DARWIN
794	/* Darwin is kind of special... */
795	Assert(!pFileDevice); NOREF(pFileDevice);
796	Assert(!pThis->cbBlock);
797	Assert(!pThis->MasterPort);
798	Assert(!pThis->ppMMCDI);
799	Assert(!pThis->ppScsiTaskDI);
800
801	/*
802	* Open the master port on the first invocation.
803	*/
804	kern_return_t krc = IOMasterPort(MACH_PORT_NULL, &pThis->MasterPort);
805	AssertReturn(krc == KERN_SUCCESS, VERR_GENERAL_FAILURE);
806
807	/*
808	* Create a matching dictionary for searching for CD, DVD and BlueRay services in the IOKit.
809	*
810	* The idea is to find all the devices which are of class IOCDBlockStorageDevice.
811	* CD devices are represented by IOCDBlockStorageDevice class itself, while DVD and BlueRay ones
812	* have it as a parent class.
813	*/
814	CFMutableDictionaryRef RefMatchingDict = IOServiceMatching("IOCDBlockStorageDevice");
815	AssertReturn(RefMatchingDict, VERR_NOT_FOUND);
816
817	/*
818	* do the search and get a collection of keyboards.
819	*/
820	io_iterator_t DVDServices = NULL;
821	IOReturn irc = IOServiceGetMatchingServices(pThis->MasterPort, RefMatchingDict, &DVDServices);
822	AssertMsgReturn(irc == kIOReturnSuccess, ("irc=%d\n", irc), VERR_NOT_FOUND);
823	RefMatchingDict = NULL; /* the reference is consumed by IOServiceGetMatchingServices. */
824
825	/*
826	* Enumerate the matching drives (services).
827	* (This enumeration must be identical to the one performed in Main/src-server/darwin/iokit.cpp.)
828	*/
829	int rc = VERR_FILE_NOT_FOUND;
830	unsigned i = 0;
831	io_object_t DVDService;
832	while ((DVDService = IOIteratorNext(DVDServices)) != 0)
833	{
834	/*
835	* Get the properties we use to identify the DVD drive.
836	*
837	* While there is a (weird 12 byte) GUID, it isn't persistent
838	* across boots. So, we have to use a combination of the
839	* vendor name and product name properties with an optional
840	* sequence number for identification.
841	*/
842	CFMutableDictionaryRef PropsRef = 0;
843	krc = IORegistryEntryCreateCFProperties(DVDService, &PropsRef, kCFAllocatorDefault, kNilOptions);
844	if (krc == KERN_SUCCESS)
845	{
846	/* Get the Device Characteristics dictionary. */
847	CFDictionaryRef DevCharRef = (CFDictionaryRef)CFDictionaryGetValue(PropsRef, CFSTR(kIOPropertyDeviceCharacteristicsKey));
848	if (DevCharRef)
849	{
850	/* The vendor name. */
851	char szVendor[128];
852	char *pszVendor = &szVendor[0];
853	CFTypeRef ValueRef = CFDictionaryGetValue(DevCharRef, CFSTR(kIOPropertyVendorNameKey));
854	if ( ValueRef
855	&& CFGetTypeID(ValueRef) == CFStringGetTypeID()
856	&& CFStringGetCString((CFStringRef)ValueRef, szVendor, sizeof(szVendor), kCFStringEncodingUTF8))
857	pszVendor = RTStrStrip(szVendor);
858	else
859	*pszVendor = '\0';
860
861	/* The product name. */
862	char szProduct[128];
863	char *pszProduct = &szProduct[0];
864	ValueRef = CFDictionaryGetValue(DevCharRef, CFSTR(kIOPropertyProductNameKey));
865	if ( ValueRef
866	&& CFGetTypeID(ValueRef) == CFStringGetTypeID()
867	&& CFStringGetCString((CFStringRef)ValueRef, szProduct, sizeof(szProduct), kCFStringEncodingUTF8))
868	pszProduct = RTStrStrip(szProduct);
869	else
870	*pszProduct = '\0';
871
872	/* Construct the two names and compare thwm with the one we're searching for. */
873	char szName1[256 + 32];
874	char szName2[256 + 32];
875	if (pszVendor \|\| pszProduct)
876	{
877	if (pszVendor && pszProduct)
878	{
879	RTStrPrintf(szName1, sizeof(szName1), "%s %s", pszVendor, pszProduct);
880	RTStrPrintf(szName2, sizeof(szName2), "%s %s (#%u)", pszVendor, pszProduct, i);
881	}
882	else
883	{
884	strcpy(szName1, *pszVendor ? pszVendor : pszProduct);
885	RTStrPrintf(szName2, sizeof(szName2), "%s (#%u)", *pszVendor ? pszVendor : pszProduct, i);
886	}
887	}
888	else
889	{
890	RTStrPrintf(szName1, sizeof(szName1), "(#%u)", i);
891	strcpy(szName2, szName1);
892	}
893
894	if ( !strcmp(szName1, pThis->pszDeviceOpen)
895	\|\| !strcmp(szName2, pThis->pszDeviceOpen))
896	{
897	/*
898	* Found it! Now, get the client interface and stuff.
899	* Note that we could also query kIOSCSITaskDeviceUserClientTypeID here if the
900	* MMC client plugin is missing. For now we assume this won't be necessary.
901	*/
902	SInt32 Score = 0;
903	IOCFPlugInInterface **ppPlugInInterface = NULL;
904	krc = IOCreatePlugInInterfaceForService(DVDService, kIOMMCDeviceUserClientTypeID, kIOCFPlugInInterfaceID,
905	&ppPlugInInterface, &Score);
906	if (krc == KERN_SUCCESS)
907	{
908	HRESULT hrc = (*ppPlugInInterface)->QueryInterface(ppPlugInInterface,
909	CFUUIDGetUUIDBytes(kIOMMCDeviceInterfaceID),
910	(LPVOID *)&pThis->ppMMCDI);
911	(*ppPlugInInterface)->Release(ppPlugInInterface);
912	ppPlugInInterface = NULL;
913	if (hrc == S_OK)
914	{
915	pThis->ppScsiTaskDI = (*pThis->ppMMCDI)->GetSCSITaskDeviceInterface(pThis->ppMMCDI);
916	if (pThis->ppScsiTaskDI)
917	rc = VINF_SUCCESS;
918	else
919	{
920	LogRel(("GetSCSITaskDeviceInterface failed on '%s'\n", pThis->pszDeviceOpen));
921	rc = VERR_NOT_SUPPORTED;
922	(*pThis->ppMMCDI)->Release(pThis->ppMMCDI);
923	}
924	}
925	else
926	{
927	rc = VERR_GENERAL_FAILURE;//RTErrConvertFromDarwinCOM(krc);
928	pThis->ppMMCDI = NULL;
929	}
930	}
931	else /* Check for kIOSCSITaskDeviceUserClientTypeID? */
932	rc = VERR_GENERAL_FAILURE;//RTErrConvertFromDarwinKern(krc);
933
934	/* Obtain exclusive access to the device so we can send SCSI commands. */
935	if (RT_SUCCESS(rc))
936	rc = drvHostBaseObtainExclusiveAccess(pThis, DVDService);
937
938	/* Cleanup on failure. */
939	if (RT_FAILURE(rc))
940	{
941	if (pThis->ppScsiTaskDI)
942	{
943	(*pThis->ppScsiTaskDI)->Release(pThis->ppScsiTaskDI);
944	pThis->ppScsiTaskDI = NULL;
945	}
946	if (pThis->ppMMCDI)
947	{
948	(*pThis->ppMMCDI)->Release(pThis->ppMMCDI);
949	pThis->ppMMCDI = NULL;
950	}
951	}
952
953	IOObjectRelease(DVDService);
954	break;
955	}
956	}
957	CFRelease(PropsRef);
958	}
959	else
960	AssertMsgFailed(("krc=%#x\n", krc));
961
962	IOObjectRelease(DVDService);
963	i++;
964	}
965
966	IOObjectRelease(DVDServices);
967	return rc;
968
969	#elif defined(RT_OS_FREEBSD)
970	RTFILE hFileDevice;
971	int rc = RTFileOpen(&hFileDevice, pThis->pszDeviceOpen, RTFILE_O_READWRITE \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE);
972	if (RT_FAILURE(rc))
973	return rc;
974
975	/*
976	* The current device handle can't passthrough SCSI commands.
977	* We have to get he passthrough device path and open this.
978	*/
979	union ccb DeviceCCB;
980	memset(&DeviceCCB, 0, sizeof(DeviceCCB));
981
982	DeviceCCB.ccb_h.func_code = XPT_GDEVLIST;
983	int rcBSD = ioctl(RTFileToNative(hFileDevice), CAMGETPASSTHRU, &DeviceCCB);
984	if (!rcBSD)
985	{
986	char *pszPassthroughDevice = NULL;
987	rc = RTStrAPrintf(&pszPassthroughDevice, "/dev/%s%u",
988	DeviceCCB.cgdl.periph_name, DeviceCCB.cgdl.unit_number);
989	if (rc >= 0)
990	{
991	RTFILE hPassthroughDevice;
992	rc = RTFileOpen(&hPassthroughDevice, pszPassthroughDevice, RTFILE_O_READWRITE \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE);
993	RTStrFree(pszPassthroughDevice);
994	if (RT_SUCCESS(rc))
995	{
996	/* Get needed device parameters. */
997
998	/*
999	* The device path, target id and lun id. Those are
1000	* needed for the SCSI passthrough ioctl.
1001	*/
1002	memset(&DeviceCCB, 0, sizeof(DeviceCCB));
1003	DeviceCCB.ccb_h.func_code = XPT_GDEVLIST;
1004
1005	rcBSD = ioctl(RTFileToNative(hPassthroughDevice), CAMGETPASSTHRU, &DeviceCCB);
1006	if (!rcBSD)
1007	{
1008	if (DeviceCCB.cgdl.status != CAM_GDEVLIST_ERROR)
1009	{
1010	pThis->ScsiBus = DeviceCCB.ccb_h.path_id;
1011	pThis->ScsiTargetID = DeviceCCB.ccb_h.target_id;
1012	pThis->ScsiLunID = DeviceCCB.ccb_h.target_lun;
1013	*pFileDevice = hPassthroughDevice;
1014	}
1015	else
1016	{
1017	/* The passthrough device wasn't found. */
1018	rc = VERR_NOT_FOUND;
1019	}
1020	}
1021	else
1022	rc = RTErrConvertFromErrno(errno);
1023
1024	if (RT_FAILURE(rc))
1025	RTFileClose(hPassthroughDevice);
1026	}
1027	}
1028	else
1029	rc = VERR_NO_STR_MEMORY;
1030	}
1031	else
1032	rc = RTErrConvertFromErrno(errno);
1033
1034	RTFileClose(hFileDevice);
1035	return rc;
1036
1037	#else
1038	uint32_t fFlags = (fReadOnly ? RTFILE_O_READ : RTFILE_O_READWRITE) \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE;
1039	# ifdef RT_OS_LINUX
1040	fFlags \|= RTFILE_O_NON_BLOCK;
1041	# endif
1042	return RTFileOpen(pFileDevice, pThis->pszDeviceOpen, fFlags);
1043	#endif
1044	}
1045
1046	#else /* RT_OS_SOLARIS */
1047
1048	/**
1049	* Solaris wrapper for RTFileOpen.
1050	*
1051	* Solaris has to deal with two filehandles, a block and a raw one. Rather than messing
1052	* with drvHostBaseOpen's function signature & body, having a separate one is better.
1053	*
1054	* @returns VBox status code.
1055	*/
1056	static int drvHostBaseOpen(PDRVHOSTBASE pThis, PRTFILE pFileBlockDevice, PRTFILE pFileRawDevice, bool fReadOnly)
1057	{
1058	unsigned fFlags = (fReadOnly ? RTFILE_O_READ : RTFILE_O_READWRITE)
1059	\| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE \| RTFILE_O_NON_BLOCK;
1060	int rc = RTFileOpen(pFileBlockDevice, pThis->pszDeviceOpen, fFlags);
1061	if (RT_SUCCESS(rc))
1062	{
1063	rc = RTFileOpen(pFileRawDevice, pThis->pszRawDeviceOpen, fFlags);
1064	if (RT_SUCCESS(rc))
1065	return rc;
1066
1067	LogRel(("DVD: failed to open device %s rc=%Rrc\n", pThis->pszRawDeviceOpen, rc));
1068	RTFileClose(*pFileBlockDevice);
1069	}
1070	else
1071	LogRel(("DVD: failed to open device %s rc=%Rrc\n", pThis->pszDeviceOpen, rc));
1072	return rc;
1073	}
1074	#endif /* RT_OS_SOLARIS */
1075
1076
1077	/**
1078	* (Re)opens the device.
1079	*
1080	* This is used to open the device during construction, but it's also used to re-open
1081	* the device when a media is inserted. This re-open will kill off any cached data
1082	* that Linux for some peculiar reason thinks should survive a media change...
1083	*
1084	* @returns VBOX status code.
1085	* @param pThis Instance data.
1086	*/
1087	static int drvHostBaseReopen(PDRVHOSTBASE pThis)
1088	{
1089	#ifndef RT_OS_DARWIN /* Only one open for darwin. */
1090	LogFlow(("%s-%d: drvHostBaseReopen: '%s'\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, pThis->pszDeviceOpen));
1091
1092	RTFILE hFileDevice;
1093	#ifdef RT_OS_SOLARIS
1094	if (pThis->hFileRawDevice != NIL_RTFILE)
1095	{
1096	RTFileClose(pThis->hFileRawDevice);
1097	pThis->hFileRawDevice = NIL_RTFILE;
1098	}
1099	if (pThis->hFileDevice != NIL_RTFILE)
1100	{
1101	RTFileClose(pThis->hFileDevice);
1102	pThis->hFileDevice = NIL_RTFILE;
1103	}
1104	RTFILE hFileRawDevice;
1105	int rc = drvHostBaseOpen(pThis, &hFileDevice, &hFileRawDevice, pThis->fReadOnlyConfig);
1106	#else
1107	int rc = drvHostBaseOpen(pThis, &hFileDevice, pThis->fReadOnlyConfig);
1108	#endif
1109	if (RT_FAILURE(rc))
1110	{
1111	if (!pThis->fReadOnlyConfig)
1112	{
1113	LogFlow(("%s-%d: drvHostBaseReopen: '%s' - retry readonly (%Rrc)\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, pThis->pszDeviceOpen, rc));
1114	#ifdef RT_OS_SOLARIS
1115	rc = drvHostBaseOpen(pThis, &hFileDevice, &hFileRawDevice, false);
1116	#else
1117	rc = drvHostBaseOpen(pThis, &hFileDevice, false);
1118	#endif
1119	}
1120	if (RT_FAILURE(rc))
1121	{
1122	LogFlow(("%s-%d: failed to open device '%s', rc=%Rrc\n",
1123	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, pThis->pszDevice, rc));
1124	return rc;
1125	}
1126	pThis->fReadOnly = true;
1127	}
1128	else
1129	pThis->fReadOnly = pThis->fReadOnlyConfig;
1130
1131	#ifdef RT_OS_SOLARIS
1132	if (pThis->hFileRawDevice != NIL_RTFILE)
1133	RTFileClose(pThis->hFileRawDevice);
1134	pThis->hFileRawDevice = hFileRawDevice;
1135	#endif
1136
1137	if (pThis->hFileDevice != NIL_RTFILE)
1138	RTFileClose(pThis->hFileDevice);
1139	pThis->hFileDevice = hFileDevice;
1140	#endif /* !RT_OS_DARWIN */
1141	return VINF_SUCCESS;
1142	}
1143
1144
1145	/**
1146	* Queries the media size.
1147	*
1148	* @returns VBox status code.
1149	* @param pThis Pointer to the instance data.
1150	* @param pcb Where to store the media size in bytes.
1151	*/
1152	static DECLCALLBACK(int) drvHostBaseGetMediaSize(PDRVHOSTBASE pThis, uint64_t *pcb)
1153	{
1154	#if defined(RT_OS_DARWIN) \|\| defined(RT_OS_FREEBSD)
1155	/*
1156	* Try a READ_CAPACITY command...
1157	*/
1158	struct
1159	{
1160	uint32_t cBlocks;
1161	uint32_t cbBlock;
1162	} Buf = {0, 0};
1163	uint32_t cbBuf = sizeof(Buf);
1164	uint8_t abCmd[16] =
1165	{
1166	SCSI_READ_CAPACITY, 0, 0, 0, 0, 0, 0,
1167	0,0,0,0,0,0,0,0,0
1168	};
1169	int rc = DRVHostBaseScsiCmd(pThis, abCmd, 6, PDMMEDIATXDIR_FROM_DEVICE, &Buf, &cbBuf, NULL, 0, 0);
1170	if (RT_SUCCESS(rc))
1171	{
1172	Assert(cbBuf == sizeof(Buf));
1173	Buf.cBlocks = RT_BE2H_U32(Buf.cBlocks);
1174	Buf.cbBlock = RT_BE2H_U32(Buf.cbBlock);
1175	//if (Buf.cbBlock > 2048) /* everyone else is doing this... check if it needed/right.*/
1176	// Buf.cbBlock = 2048;
1177	pThis->cbBlock = Buf.cbBlock;
1178
1179	pcb = (uint64_t)Buf.cBlocks Buf.cbBlock;
1180	}
1181	return rc;
1182
1183	#elif defined(RT_OS_SOLARIS)
1184	/*
1185	* Sun docs suggests using DKIOCGGEOM instead of DKIOCGMEDIAINFO, but
1186	* Sun themselves use DKIOCGMEDIAINFO for DVDs/CDs, and use DKIOCGGEOM
1187	* for secondary storage devices.
1188	*/
1189	struct dk_minfo MediaInfo;
1190	if (ioctl(RTFileToNative(pThis->hFileRawDevice), DKIOCGMEDIAINFO, &MediaInfo) == 0)
1191	{
1192	pcb = MediaInfo.dki_capacity (uint64_t)MediaInfo.dki_lbsize;
1193	return VINF_SUCCESS;
1194	}
1195	return RTFileSeek(pThis->hFileDevice, 0, RTFILE_SEEK_END, pcb);
1196
1197	#elif defined(RT_OS_WINDOWS)
1198	/* use NT api, retry a few times if the media is being verified. */
1199	IO_STATUS_BLOCK IoStatusBlock = {0};
1200	FILE_FS_SIZE_INFORMATION FsSize= {0};
1201	NTSTATUS rcNt = NtQueryVolumeInformationFile((HANDLE)RTFileToNative(pThis->hFileDevice), &IoStatusBlock,
1202	&FsSize, sizeof(FsSize), FileFsSizeInformation);
1203	int cRetries = 5;
1204	while (rcNt == STATUS_VERIFY_REQUIRED && cRetries-- > 0)
1205	{
1206	RTThreadSleep(10);
1207	rcNt = NtQueryVolumeInformationFile((HANDLE)RTFileToNative(pThis->hFileDevice), &IoStatusBlock,
1208	&FsSize, sizeof(FsSize), FileFsSizeInformation);
1209	}
1210	if (rcNt >= 0)
1211	{
1212	pcb = FsSize.TotalAllocationUnits.QuadPart FsSize.BytesPerSector;
1213	return VINF_SUCCESS;
1214	}
1215
1216	/* convert nt status code to VBox status code. */
1217	/** @todo Make conversion function!. */
1218	int rc = VERR_GENERAL_FAILURE;
1219	switch (rcNt)
1220	{
1221	case STATUS_NO_MEDIA_IN_DEVICE: rc = VERR_MEDIA_NOT_PRESENT; break;
1222	case STATUS_VERIFY_REQUIRED: rc = VERR_TRY_AGAIN; break;
1223	}
1224	LogFlow(("drvHostBaseGetMediaSize: NtQueryVolumeInformationFile -> %#lx\n", rcNt, rc));
1225	return rc;
1226	#else
1227	return RTFileSeek(pThis->hFileDevice, 0, RTFILE_SEEK_END, pcb);
1228	#endif
1229	}
1230
1231
1232	#if defined(RT_OS_DARWIN) \|\| defined(RT_OS_FREEBSD)
1233	/**
1234	* Execute a SCSI command.
1235	*
1236	* @param pThis The instance data.
1237	* @param pbCmd Pointer to the SCSI command.
1238	* @param cbCmd The size of the SCSI command.
1239	* @param enmTxDir The transfer direction.
1240	* @param pvBuf The buffer. Can be NULL if enmTxDir is PDMMEDIATXDIR_NONE.
1241	* @param pcbBuf Where to get the buffer size from and put the actual transfer size. Can be NULL.
1242	* @param pbSense Where to put the sense data. Can be NULL.
1243	* @param cbSense Size of the sense data buffer.
1244	* @param cTimeoutMillies The timeout. 0 mean the default timeout.
1245	*
1246	* @returns VINF_SUCCESS on success (no sense code).
1247	* @returns VERR_UNRESOLVED_ERROR if sense code is present.
1248	* @returns Some other VBox status code on failures without sense code.
1249	*
1250	* @todo Fix VERR_UNRESOLVED_ERROR abuse.
1251	*/
1252	DECLCALLBACK(int) DRVHostBaseScsiCmd(PDRVHOSTBASE pThis, const uint8_t *pbCmd, size_t cbCmd, PDMMEDIATXDIR enmTxDir,
1253	void pvBuf, uint32_t pcbBuf, uint8_t *pbSense, size_t cbSense, uint32_t cTimeoutMillies)
1254	{
1255	/*
1256	* Minimal input validation.
1257	*/
1258	Assert(enmTxDir == PDMMEDIATXDIR_NONE \|\| enmTxDir == PDMMEDIATXDIR_FROM_DEVICE \|\| enmTxDir == PDMMEDIATXDIR_TO_DEVICE);
1259	Assert(!pvBuf \|\| pcbBuf);
1260	Assert(pvBuf \|\| enmTxDir == PDMMEDIATXDIR_NONE);
1261	Assert(pbSense \|\| !cbSense);
1262	AssertPtr(pbCmd);
1263	Assert(cbCmd <= 16 && cbCmd >= 1);
1264	const uint32_t cbBuf = pcbBuf ? *pcbBuf : 0;
1265	if (pcbBuf)
1266	*pcbBuf = 0;
1267
1268	# ifdef RT_OS_DARWIN
1269	Assert(pThis->ppScsiTaskDI);
1270
1271	int rc = VERR_GENERAL_FAILURE;
1272	SCSITaskInterface *ppScsiTaskI = (pThis->ppScsiTaskDI)->CreateSCSITask(pThis->ppScsiTaskDI);
1273	if (!ppScsiTaskI)
1274	return VERR_NO_MEMORY;
1275	do
1276	{
1277	/* Setup the scsi command. */
1278	SCSICommandDescriptorBlock cdb = { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 };
1279	memcpy(&cdb[0], pbCmd, cbCmd);
1280	IOReturn irc = (*ppScsiTaskI)->SetCommandDescriptorBlock(ppScsiTaskI, cdb, cbCmd);
1281	AssertBreak(irc == kIOReturnSuccess);
1282
1283	/* Setup the buffer. */
1284	if (enmTxDir == PDMMEDIATXDIR_NONE)
1285	irc = (*ppScsiTaskI)->SetScatterGatherEntries(ppScsiTaskI, NULL, 0, 0, kSCSIDataTransfer_NoDataTransfer);
1286	else
1287	{
1288	IOVirtualRange Range = { (IOVirtualAddress)pvBuf, cbBuf };
1289	irc = (*ppScsiTaskI)->SetScatterGatherEntries(ppScsiTaskI, &Range, 1, cbBuf,
1290	enmTxDir == PDMMEDIATXDIR_FROM_DEVICE
1291	? kSCSIDataTransfer_FromTargetToInitiator
1292	: kSCSIDataTransfer_FromInitiatorToTarget);
1293	}
1294	AssertBreak(irc == kIOReturnSuccess);
1295
1296	/* Set the timeout. */
1297	irc = (ppScsiTaskI)->SetTimeoutDuration(ppScsiTaskI, cTimeoutMillies ? cTimeoutMillies : 30000 /ms*/);
1298	AssertBreak(irc == kIOReturnSuccess);
1299
1300	/* Execute the command and get the response. */
1301	SCSI_Sense_Data SenseData = { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 };
1302	SCSIServiceResponse ServiceResponse = kSCSIServiceResponse_Request_In_Process;
1303	SCSITaskStatus TaskStatus = kSCSITaskStatus_GOOD;
1304	UInt64 cbReturned = 0;
1305	irc = (*ppScsiTaskI)->ExecuteTaskSync(ppScsiTaskI, &SenseData, &TaskStatus, &cbReturned);
1306	AssertBreak(irc == kIOReturnSuccess);
1307	if (pcbBuf)
1308	*pcbBuf = (int32_t)cbReturned;
1309
1310	irc = (*ppScsiTaskI)->GetSCSIServiceResponse(ppScsiTaskI, &ServiceResponse);
1311	AssertBreak(irc == kIOReturnSuccess);
1312	AssertBreak(ServiceResponse == kSCSIServiceResponse_TASK_COMPLETE);
1313
1314	if (TaskStatus == kSCSITaskStatus_GOOD)
1315	rc = VINF_SUCCESS;
1316	else if ( TaskStatus == kSCSITaskStatus_CHECK_CONDITION
1317	&& pbSense)
1318	{
1319	memset(pbSense, 0, cbSense); /* lazy */
1320	memcpy(pbSense, &SenseData, RT_MIN(sizeof(SenseData), cbSense));
1321	rc = VERR_UNRESOLVED_ERROR;
1322	}
1323	/** @todo convert sense codes when caller doesn't wish to do this himself. */
1324	/*else if ( TaskStatus == kSCSITaskStatus_CHECK_CONDITION
1325	&& SenseData.ADDITIONAL_SENSE_CODE == 0x3A)
1326	rc = VERR_MEDIA_NOT_PRESENT; */
1327	else
1328	{
1329	rc = enmTxDir == PDMMEDIATXDIR_NONE
1330	? VERR_DEV_IO_ERROR
1331	: enmTxDir == PDMMEDIATXDIR_FROM_DEVICE
1332	? VERR_READ_ERROR
1333	: VERR_WRITE_ERROR;
1334	if (pThis->cLogRelErrors++ < 10)
1335	LogRel(("DVD scsi error: cmd={%.*Rhxs} TaskStatus=%#x key=%#x ASC=%#x ASCQ=%#x (%Rrc)\n",
1336	cbCmd, pbCmd, TaskStatus, SenseData.SENSE_KEY, SenseData.ADDITIONAL_SENSE_CODE,
1337	SenseData.ADDITIONAL_SENSE_CODE_QUALIFIER, rc));
1338	}
1339	} while (0);
1340
1341	(*ppScsiTaskI)->Release(ppScsiTaskI);
1342
1343	# elif defined(RT_OS_FREEBSD)
1344	int rc = VINF_SUCCESS;
1345	int rcBSD = 0;
1346	union ccb DeviceCCB;
1347	union ccb *pDeviceCCB = &DeviceCCB;
1348	u_int32_t fFlags;
1349
1350	memset(pDeviceCCB, 0, sizeof(DeviceCCB));
1351	pDeviceCCB->ccb_h.path_id = pThis->ScsiBus;
1352	pDeviceCCB->ccb_h.target_id = pThis->ScsiTargetID;
1353	pDeviceCCB->ccb_h.target_lun = pThis->ScsiLunID;
1354
1355	/* The SCSI INQUIRY command can't be passed through directly. */
1356	if (pbCmd[0] == SCSI_INQUIRY)
1357	{
1358	pDeviceCCB->ccb_h.func_code = XPT_GDEV_TYPE;
1359
1360	rcBSD = ioctl(RTFileToNative(pThis->hFileDevice), CAMIOCOMMAND, pDeviceCCB);
1361	if (!rcBSD)
1362	{
1363	uint32_t cbCopy = cbBuf < sizeof(struct scsi_inquiry_data)
1364	? cbBuf
1365	: sizeof(struct scsi_inquiry_data);;
1366	memcpy(pvBuf, &pDeviceCCB->cgd.inq_data, cbCopy);
1367	memset(pbSense, 0, cbSense);
1368
1369	if (pcbBuf)
1370	*pcbBuf = cbCopy;
1371	}
1372	else
1373	rc = RTErrConvertFromErrno(errno);
1374	}
1375	else
1376	{
1377	/* Copy the CDB. */
1378	memcpy(&pDeviceCCB->csio.cdb_io.cdb_bytes, pbCmd, cbCmd);
1379
1380	/* Set direction. */
1381	if (enmTxDir == PDMMEDIATXDIR_NONE)
1382	fFlags = CAM_DIR_NONE;
1383	else if (enmTxDir == PDMMEDIATXDIR_FROM_DEVICE)
1384	fFlags = CAM_DIR_IN;
1385	else
1386	fFlags = CAM_DIR_OUT;
1387
1388	fFlags \|= CAM_DEV_QFRZDIS;
1389
1390	cam_fill_csio(&pDeviceCCB->csio, 1, NULL, fFlags, MSG_SIMPLE_Q_TAG,
1391	(u_int8_t *)pvBuf, cbBuf, cbSense, cbCmd,
1392	cTimeoutMillies ? cTimeoutMillies : 30000/* timeout */);
1393
1394	/* Send command */
1395	rcBSD = ioctl(RTFileToNative(pThis->hFileDevice), CAMIOCOMMAND, pDeviceCCB);
1396	if (!rcBSD)
1397	{
1398	switch (pDeviceCCB->ccb_h.status & CAM_STATUS_MASK)
1399	{
1400	case CAM_REQ_CMP:
1401	rc = VINF_SUCCESS;
1402	break;
1403	case CAM_SEL_TIMEOUT:
1404	rc = VERR_DEV_IO_ERROR;
1405	break;
1406	case CAM_CMD_TIMEOUT:
1407	rc = VERR_TIMEOUT;
1408	break;
1409	default:
1410	rc = VERR_DEV_IO_ERROR;
1411	}
1412
1413	if (pcbBuf)
1414	*pcbBuf = cbBuf - pDeviceCCB->csio.resid;
1415
1416	if (pbSense)
1417	memcpy(pbSense, &pDeviceCCB->csio.sense_data,
1418	cbSense - pDeviceCCB->csio.sense_resid);
1419	}
1420	else
1421	rc = RTErrConvertFromErrno(errno);
1422	}
1423	# endif
1424
1425	return rc;
1426	}
1427	#endif
1428
1429
1430	/**
1431	* Media present.
1432	* Query the size and notify the above driver / device.
1433	*
1434	* @param pThis The instance data.
1435	*/
1436	int DRVHostBaseMediaPresent(PDRVHOSTBASE pThis)
1437	{
1438	/*
1439	* Open the drive.
1440	*/
1441	int rc = drvHostBaseReopen(pThis);
1442	if (RT_FAILURE(rc))
1443	return rc;
1444
1445	/*
1446	* Determine the size.
1447	*/
1448	uint64_t cb;
1449	rc = pThis->pfnGetMediaSize(pThis, &cb);
1450	if (RT_FAILURE(rc))
1451	{
1452	LogFlow(("%s-%d: failed to figure media size of %s, rc=%Rrc\n",
1453	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, pThis->pszDevice, rc));
1454	return rc;
1455	}
1456
1457	/*
1458	* Update the data and inform the unit.
1459	*/
1460	pThis->cbSize = cb;
1461	pThis->fMediaPresent = true;
1462	if (pThis->pDrvMountNotify)
1463	pThis->pDrvMountNotify->pfnMountNotify(pThis->pDrvMountNotify);
1464	LogFlow(("%s-%d: drvHostBaseMediaPresent: cbSize=%lld (%#llx)\n",
1465	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, pThis->cbSize, pThis->cbSize));
1466	return VINF_SUCCESS;
1467	}
1468
1469
1470	/**
1471	* Media no longer present.
1472	* @param pThis The instance data.
1473	*/
1474	void DRVHostBaseMediaNotPresent(PDRVHOSTBASE pThis)
1475	{
1476	pThis->fMediaPresent = false;
1477	pThis->fLocked = false;
1478	pThis->PCHSGeometry.cCylinders = 0;
1479	pThis->PCHSGeometry.cHeads = 0;
1480	pThis->PCHSGeometry.cSectors = 0;
1481	pThis->LCHSGeometry.cCylinders = 0;
1482	pThis->LCHSGeometry.cHeads = 0;
1483	pThis->LCHSGeometry.cSectors = 0;
1484	if (pThis->pDrvMountNotify)
1485	pThis->pDrvMountNotify->pfnUnmountNotify(pThis->pDrvMountNotify);
1486	}
1487
1488
1489	#ifdef RT_OS_WINDOWS
1490
1491	/**
1492	* Window procedure for the invisible window used to catch the WM_DEVICECHANGE broadcasts.
1493	*/
1494	static LRESULT CALLBACK DeviceChangeWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
1495	{
1496	Log2(("DeviceChangeWindowProc: hwnd=%08x uMsg=%08x\n", hwnd, uMsg));
1497	if (uMsg == WM_DESTROY)
1498	{
1499	PDRVHOSTBASE pThis = (PDRVHOSTBASE)GetWindowLongPtr(hwnd, GWLP_USERDATA);
1500	if (pThis)
1501	ASMAtomicXchgSize(&pThis->hwndDeviceChange, NULL);
1502	PostQuitMessage(0);
1503	}
1504
1505	if (uMsg != WM_DEVICECHANGE)
1506	return DefWindowProc(hwnd, uMsg, wParam, lParam);
1507
1508	PDEV_BROADCAST_HDR lpdb = (PDEV_BROADCAST_HDR)lParam;
1509	PDRVHOSTBASE pThis = (PDRVHOSTBASE)GetWindowLongPtr(hwnd, GWLP_USERDATA);
1510	Assert(pThis);
1511	if (pThis == NULL)
1512	return 0;
1513
1514	switch (wParam)
1515	{
1516	case DBT_DEVICEARRIVAL:
1517	case DBT_DEVICEREMOVECOMPLETE:
1518	// Check whether a CD or DVD was inserted into or removed from a drive.
1519	if (lpdb->dbch_devicetype == DBT_DEVTYP_VOLUME)
1520	{
1521	PDEV_BROADCAST_VOLUME lpdbv = (PDEV_BROADCAST_VOLUME)lpdb;
1522	if ( (lpdbv->dbcv_flags & DBTF_MEDIA)
1523	&& (pThis->fUnitMask & lpdbv->dbcv_unitmask))
1524	{
1525	RTCritSectEnter(&pThis->CritSect);
1526	if (wParam == DBT_DEVICEARRIVAL)
1527	{
1528	int cRetries = 10;
1529	int rc = DRVHostBaseMediaPresent(pThis);
1530	while (RT_FAILURE(rc) && cRetries-- > 0)
1531	{
1532	RTThreadSleep(50);
1533	rc = DRVHostBaseMediaPresent(pThis);
1534	}
1535	}
1536	else
1537	DRVHostBaseMediaNotPresent(pThis);
1538	RTCritSectLeave(&pThis->CritSect);
1539	}
1540	}
1541	break;
1542	}
1543	return TRUE;
1544	}
1545
1546	#endif /* RT_OS_WINDOWS */
1547
1548
1549	/**
1550	* This thread will periodically poll the device for media presence.
1551	*
1552	* @returns Ignored.
1553	* @param ThreadSelf Handle of this thread. Ignored.
1554	* @param pvUser Pointer to the driver instance structure.
1555	*/
1556	static DECLCALLBACK(int) drvHostBaseMediaThread(RTTHREAD ThreadSelf, void *pvUser)
1557	{
1558	PDRVHOSTBASE pThis = (PDRVHOSTBASE)pvUser;
1559	LogFlow(("%s-%d: drvHostBaseMediaThread: ThreadSelf=%p pvUser=%p\n",
1560	pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, ThreadSelf, pvUser));
1561	#ifdef RT_OS_WINDOWS
1562	static WNDCLASS s_classDeviceChange = {0};
1563	static ATOM s_hAtomDeviceChange = 0;
1564
1565	/*
1566	* Register custom window class.
1567	*/
1568	if (s_hAtomDeviceChange == 0)
1569	{
1570	memset(&s_classDeviceChange, 0, sizeof(s_classDeviceChange));
1571	s_classDeviceChange.lpfnWndProc = DeviceChangeWindowProc;
1572	s_classDeviceChange.lpszClassName = "VBOX_DeviceChangeClass";
1573	s_classDeviceChange.hInstance = GetModuleHandle("VBoxDD.dll");
1574	Assert(s_classDeviceChange.hInstance);
1575	s_hAtomDeviceChange = RegisterClassA(&s_classDeviceChange);
1576	Assert(s_hAtomDeviceChange);
1577	}
1578
1579	/*
1580	* Create Window w/ the pThis as user data.
1581	*/
1582	HWND hwnd = CreateWindow((LPCTSTR)s_hAtomDeviceChange, "", WS_POPUP, 0, 0, 0, 0, 0, 0, s_classDeviceChange.hInstance, 0);
1583	AssertMsg(hwnd, ("CreateWindow failed with %d\n", GetLastError()));
1584	SetWindowLongPtr(hwnd, GWLP_USERDATA, (LONG_PTR)pThis);
1585
1586	/*
1587	* Signal the waiting EMT thread that everything went fine.
1588	*/
1589	ASMAtomicXchgPtr((void * volatile *)&pThis->hwndDeviceChange, hwnd);
1590	RTThreadUserSignal(ThreadSelf);
1591	if (!hwnd)
1592	{
1593	LogFlow(("%s-%d: drvHostBaseMediaThread: returns VERR_GENERAL_FAILURE\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance));
1594	return VERR_GENERAL_FAILURE;
1595	}
1596	LogFlow(("%s-%d: drvHostBaseMediaThread: Created hwndDeviceChange=%p\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance, hwnd));
1597
1598	/*
1599	* Message pump.
1600	*/
1601	MSG Msg;
1602	BOOL fRet;
1603	while ((fRet = GetMessage(&Msg, NULL, 0, 0)) != FALSE)
1604	{
1605	if (fRet != -1)
1606	{
1607	TranslateMessage(&Msg);
1608	DispatchMessage(&Msg);
1609	}
1610	//else: handle the error and possibly exit
1611	}
1612	Assert(!pThis->hwndDeviceChange);
1613
1614	#else /* !RT_OS_WINDOWS */
1615	bool fFirst = true;
1616	int cRetries = 10;
1617	while (!pThis->fShutdownPoller)
1618	{
1619	/*
1620	* Perform the polling (unless we've run out of 50ms retries).
1621	*/
1622	if ( pThis->pfnPoll
1623	&& cRetries-- > 0)
1624	{
1625
1626	int rc = pThis->pfnPoll(pThis);
1627	if (RT_FAILURE(rc))
1628	{
1629	RTSemEventWait(pThis->EventPoller, 50);
1630	continue;
1631	}
1632	}
1633
1634	/*
1635	* Signal EMT after the first go.
1636	*/
1637	if (fFirst)
1638	{
1639	RTThreadUserSignal(ThreadSelf);
1640	fFirst = false;
1641	}
1642
1643	/*
1644	* Sleep.
1645	*/
1646	int rc = RTSemEventWait(pThis->EventPoller, pThis->cMilliesPoller);
1647	if ( RT_FAILURE(rc)
1648	&& rc != VERR_TIMEOUT)
1649	{
1650	AssertMsgFailed(("rc=%Rrc\n", rc));
1651	pThis->ThreadPoller = NIL_RTTHREAD;
1652	LogFlow(("drvHostBaseMediaThread: returns %Rrc\n", rc));
1653	return rc;
1654	}
1655	cRetries = 10;
1656	}
1657
1658	#endif /* !RT_OS_WINDOWS */
1659
1660	/* (Don't clear the thread handle here, the destructor thread is using it to wait.) */
1661	LogFlow(("%s-%d: drvHostBaseMediaThread: returns VINF_SUCCESS\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance));
1662	return VINF_SUCCESS;
1663	}
1664
1665	/* -=-=-=-=- driver interface -=-=-=-=- */
1666
1667
1668	/**
1669	* Done state load operation.
1670	*
1671	* @returns VBox load code.
1672	* @param pDrvIns Driver instance of the driver which registered the data unit.
1673	* @param pSSM SSM operation handle.
1674	*/
1675	static DECLCALLBACK(int) drvHostBaseLoadDone(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
1676	{
1677	RT_NOREF(pSSM);
1678	PDRVHOSTBASE pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTBASE);
1679	LogFlow(("%s-%d: drvHostBaseMediaThread:\n", pThis->pDrvIns->pReg->szName, pThis->pDrvIns->iInstance));
1680	RTCritSectEnter(&pThis->CritSect);
1681
1682	/*
1683	* Tell the device/driver above us that the media status is uncertain.
1684	*/
1685	if (pThis->pDrvMountNotify)
1686	{
1687	pThis->pDrvMountNotify->pfnUnmountNotify(pThis->pDrvMountNotify);
1688	if (pThis->fMediaPresent)
1689	pThis->pDrvMountNotify->pfnMountNotify(pThis->pDrvMountNotify);
1690	}
1691
1692	RTCritSectLeave(&pThis->CritSect);
1693	return VINF_SUCCESS;
1694	}
1695
1696
1697	/** @copydoc FNPDMDRVDESTRUCT */
1698	DECLCALLBACK(void) DRVHostBaseDestruct(PPDMDRVINS pDrvIns)
1699	{
1700	PDRVHOSTBASE pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTBASE);
1701	LogFlow(("%s-%d: drvHostBaseDestruct: iInstance=%d\n", pDrvIns->pReg->szName, pDrvIns->iInstance, pDrvIns->iInstance));
1702
1703	/*
1704	* Terminate the thread.
1705	*/
1706	if (pThis->ThreadPoller != NIL_RTTHREAD)
1707	{
1708	pThis->fShutdownPoller = true;
1709	int rc;
1710	int cTimes = 50;
1711	do
1712	{
1713	#ifdef RT_OS_WINDOWS
1714	if (pThis->hwndDeviceChange)
1715	PostMessage(pThis->hwndDeviceChange, WM_CLOSE, 0, 0); /* default win proc will destroy the window */
1716	#else
1717	RTSemEventSignal(pThis->EventPoller);
1718	#endif
1719	rc = RTThreadWait(pThis->ThreadPoller, 100, NULL);
1720	} while (cTimes-- > 0 && rc == VERR_TIMEOUT);
1721
1722	if (!rc)
1723	pThis->ThreadPoller = NIL_RTTHREAD;
1724	}
1725
1726	/*
1727	* Unlock the drive if we've locked it or we're in passthru mode.
1728	*/
1729	#ifdef RT_OS_DARWIN
1730	if ( ( pThis->fLocked
1731	\|\| pThis->IMedia.pfnSendCmd)
1732	&& pThis->ppScsiTaskDI
1733	#else /** @todo Check if the other guys can mix pfnDoLock with scsi passthru.
1734	* (We're currently not unlocking the device after use. See todo in DevATA.cpp.) */
1735	if ( pThis->fLocked
1736	&& pThis->hFileDevice != NIL_RTFILE
1737	#endif
1738	&& pThis->pfnDoLock)
1739	{
1740	int rc = pThis->pfnDoLock(pThis, false);
1741	if (RT_SUCCESS(rc))
1742	pThis->fLocked = false;
1743	}
1744
1745	/*
1746	* Cleanup the other resources.
1747	*/
1748	#ifdef RT_OS_WINDOWS
1749	if (pThis->hwndDeviceChange)
1750	{
1751	if (SetWindowLongPtr(pThis->hwndDeviceChange, GWLP_USERDATA, 0) == (LONG_PTR)pThis)
1752	PostMessage(pThis->hwndDeviceChange, WM_CLOSE, 0, 0); /* default win proc will destroy the window */
1753	pThis->hwndDeviceChange = NULL;
1754	}
1755	#else
1756	if (pThis->EventPoller != NULL)
1757	{
1758	RTSemEventDestroy(pThis->EventPoller);
1759	pThis->EventPoller = NULL;
1760	}
1761	#endif
1762
1763	#ifdef RT_OS_DARWIN
1764	/*
1765	* The unclaiming doesn't seem to mean much, the DVD is actually
1766	* remounted when we release exclusive access. I'm not quite sure
1767	* if I should put the unclaim first or not...
1768	*
1769	* Anyway, that it's automatically remounted very good news for us,
1770	* because that means we don't have to mess with that ourselves. Of
1771	* course there is the unlikely scenario that we've succeeded in claiming
1772	* and umount the DVD but somehow failed to gain exclusive scsi access...
1773	*/
1774	if (pThis->ppScsiTaskDI)
1775	{
1776	LogFlow(("%s-%d: releasing exclusive scsi access!\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
1777	(*pThis->ppScsiTaskDI)->ReleaseExclusiveAccess(pThis->ppScsiTaskDI);
1778	(*pThis->ppScsiTaskDI)->Release(pThis->ppScsiTaskDI);
1779	pThis->ppScsiTaskDI = NULL;
1780	}
1781	if (pThis->pDADisk)
1782	{
1783	LogFlow(("%s-%d: unclaiming the disk!\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
1784	DADiskUnclaim(pThis->pDADisk);
1785	CFRelease(pThis->pDADisk);
1786	pThis->pDADisk = NULL;
1787	}
1788	if (pThis->ppMMCDI)
1789	{
1790	LogFlow(("%s-%d: releasing the MMC object!\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
1791	(*pThis->ppMMCDI)->Release(pThis->ppMMCDI);
1792	pThis->ppMMCDI = NULL;
1793	}
1794	if (pThis->MasterPort)
1795	{
1796	mach_port_deallocate(mach_task_self(), pThis->MasterPort);
1797	pThis->MasterPort = 0;
1798	}
1799	if (pThis->pDASession)
1800	{
1801	LogFlow(("%s-%d: releasing the DA session!\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
1802	CFRelease(pThis->pDASession);
1803	pThis->pDASession = NULL;
1804	}
1805	#else
1806	if (pThis->hFileDevice != NIL_RTFILE)
1807	{
1808	int rc = RTFileClose(pThis->hFileDevice);
1809	AssertRC(rc);
1810	pThis->hFileDevice = NIL_RTFILE;
1811	}
1812	#endif
1813
1814	#ifdef RT_OS_SOLARIS
1815	if (pThis->hFileRawDevice != NIL_RTFILE)
1816	{
1817	int rc = RTFileClose(pThis->hFileRawDevice);
1818	AssertRC(rc);
1819	pThis->hFileRawDevice = NIL_RTFILE;
1820	}
1821
1822	if (pThis->pszRawDeviceOpen)
1823	{
1824	RTStrFree(pThis->pszRawDeviceOpen);
1825	pThis->pszRawDeviceOpen = NULL;
1826	}
1827	#endif
1828
1829	if (pThis->pszDevice)
1830	{
1831	MMR3HeapFree(pThis->pszDevice);
1832	pThis->pszDevice = NULL;
1833	}
1834
1835	if (pThis->pszDeviceOpen)
1836	{
1837	RTStrFree(pThis->pszDeviceOpen);
1838	pThis->pszDeviceOpen = NULL;
1839	}
1840
1841	/* Forget about the notifications. */
1842	pThis->pDrvMountNotify = NULL;
1843
1844	/* Leave the instance operational if this is just a cleanup of the state
1845	* after an attach error happened. So don't destroy the critsect then. */
1846	if (!pThis->fKeepInstance && RTCritSectIsInitialized(&pThis->CritSect))
1847	RTCritSectDelete(&pThis->CritSect);
1848	LogFlow(("%s-%d: drvHostBaseDestruct completed\n", pDrvIns->pReg->szName, pDrvIns->iInstance));
1849	}
1850
1851
1852	/**
1853	* Initializes the instance data (init part 1).
1854	*
1855	* The driver which derives from this base driver will override function pointers after
1856	* calling this method, and complete the construction by calling DRVHostBaseInitFinish().
1857	*
1858	* On failure call DRVHostBaseDestruct().
1859	*
1860	* @returns VBox status code.
1861	* @param pDrvIns Driver instance.
1862	* @param pCfg Configuration handle.
1863	* @param enmType Device type.
1864	*/
1865	int DRVHostBaseInitData(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, PDMMEDIATYPE enmType)
1866	{
1867	PDRVHOSTBASE pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTBASE);
1868	LogFlow(("%s-%d: DRVHostBaseInitData: iInstance=%d\n", pDrvIns->pReg->szName, pDrvIns->iInstance, pDrvIns->iInstance));
1869
1870	/*
1871	* Initialize most of the data members.
1872	*/
1873	pThis->pDrvIns = pDrvIns;
1874	pThis->fKeepInstance = false;
1875	pThis->ThreadPoller = NIL_RTTHREAD;
1876	#ifdef RT_OS_DARWIN
1877	pThis->MasterPort = NULL;
1878	pThis->ppMMCDI = NULL;
1879	pThis->ppScsiTaskDI = NULL;
1880	pThis->cbBlock = 0;
1881	pThis->pDADisk = NULL;
1882	pThis->pDASession = NULL;
1883	#else
1884	pThis->hFileDevice = NIL_RTFILE;
1885	#endif
1886	#ifdef RT_OS_SOLARIS
1887	pThis->hFileRawDevice = NIL_RTFILE;
1888	#endif
1889	pThis->enmType = enmType;
1890	//pThis->cErrors = 0;
1891	pThis->fAttachFailError = true; /* It's an error until we've read the config. */
1892
1893	pThis->pfnGetMediaSize = drvHostBaseGetMediaSize;
1894
1895	/* IBase. */
1896	pDrvIns->IBase.pfnQueryInterface = drvHostBaseQueryInterface;
1897
1898	/* IMedia. */
1899	pThis->IMedia.pfnRead = drvHostBaseRead;
1900	pThis->IMedia.pfnWrite = drvHostBaseWrite;
1901	pThis->IMedia.pfnFlush = drvHostBaseFlush;
1902	pThis->IMedia.pfnIsReadOnly = drvHostBaseIsReadOnly;
1903	pThis->IMedia.pfnGetSize = drvHostBaseGetSize;
1904	pThis->IMedia.pfnGetType = drvHostBaseGetType;
1905	pThis->IMedia.pfnGetUuid = drvHostBaseGetUuid;
1906	pThis->IMedia.pfnIoBufAlloc = drvHostBaseIoBufAlloc;
1907	pThis->IMedia.pfnIoBufFree = drvHostBaseIoBufFree;
1908	pThis->IMedia.pfnBiosGetPCHSGeometry = drvHostBaseGetPCHSGeometry;
1909	pThis->IMedia.pfnBiosSetPCHSGeometry = drvHostBaseSetPCHSGeometry;
1910	pThis->IMedia.pfnBiosGetLCHSGeometry = drvHostBaseGetLCHSGeometry;
1911	pThis->IMedia.pfnBiosSetLCHSGeometry = drvHostBaseSetLCHSGeometry;
1912	pThis->IMedia.pfnBiosIsVisible = drvHostBaseIsVisible;
1913
1914	/* IMount. */
1915	pThis->IMount.pfnUnmount = drvHostBaseUnmount;
1916	pThis->IMount.pfnIsMounted = drvHostBaseIsMounted;
1917	pThis->IMount.pfnLock = drvHostBaseLock;
1918	pThis->IMount.pfnUnlock = drvHostBaseUnlock;
1919	pThis->IMount.pfnIsLocked = drvHostBaseIsLocked;
1920
1921	/*
1922	* Get the IBlockPort & IMountNotify interfaces of the above driver/device.
1923	*/
1924	pThis->pDrvMediaPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIMEDIAPORT);
1925	if (!pThis->pDrvMediaPort)
1926	{
1927	AssertMsgFailed(("Configuration error: No media port interface above!\n"));
1928	return VERR_PDM_MISSING_INTERFACE_ABOVE;
1929	}
1930	pThis->pDrvMountNotify = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIMOUNTNOTIFY);
1931
1932	/*
1933	* Query configuration.
1934	*/
1935	/* Device */
1936	int rc = CFGMR3QueryStringAlloc(pCfg, "Path", &pThis->pszDevice);
1937	if (RT_FAILURE(rc))
1938	{
1939	AssertMsgFailed(("Configuration error: query for \"Path\" string returned %Rra.\n", rc));
1940	return rc;
1941	}
1942
1943	/* Mountable */
1944	uint32_t u32;
1945	rc = CFGMR3QueryU32(pCfg, "Interval", &u32);
1946	if (RT_SUCCESS(rc))
1947	pThis->cMilliesPoller = u32;
1948	else if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1949	pThis->cMilliesPoller = 1000;
1950	else if (RT_FAILURE(rc))
1951	{
1952	AssertMsgFailed(("Configuration error: Query \"Mountable\" resulted in %Rrc.\n", rc));
1953	return rc;
1954	}
1955
1956	/* ReadOnly */
1957	rc = CFGMR3QueryBool(pCfg, "ReadOnly", &pThis->fReadOnlyConfig);
1958	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1959	pThis->fReadOnlyConfig = enmType == PDMMEDIATYPE_DVD \|\| enmType == PDMMEDIATYPE_CDROM ? true : false;
1960	else if (RT_FAILURE(rc))
1961	{
1962	AssertMsgFailed(("Configuration error: Query \"ReadOnly\" resulted in %Rrc.\n", rc));
1963	return rc;
1964	}
1965
1966	/* Locked */
1967	rc = CFGMR3QueryBool(pCfg, "Locked", &pThis->fLocked);
1968	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1969	pThis->fLocked = false;
1970	else if (RT_FAILURE(rc))
1971	{
1972	AssertMsgFailed(("Configuration error: Query \"Locked\" resulted in %Rrc.\n", rc));
1973	return rc;
1974	}
1975
1976	/* BIOS visible */
1977	rc = CFGMR3QueryBool(pCfg, "BIOSVisible", &pThis->fBiosVisible);
1978	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1979	pThis->fBiosVisible = true;
1980	else if (RT_FAILURE(rc))
1981	{
1982	AssertMsgFailed(("Configuration error: Query \"BIOSVisible\" resulted in %Rrc.\n", rc));
1983	return rc;
1984	}
1985
1986	/* Uuid */
1987	char *psz;
1988	rc = CFGMR3QueryStringAlloc(pCfg, "Uuid", &psz);
1989	if (rc == VERR_CFGM_VALUE_NOT_FOUND)
1990	RTUuidClear(&pThis->Uuid);
1991	else if (RT_SUCCESS(rc))
1992	{
1993	rc = RTUuidFromStr(&pThis->Uuid, psz);
1994	if (RT_FAILURE(rc))
1995	{
1996	AssertMsgFailed(("Configuration error: Uuid from string failed on \"%s\", rc=%Rrc.\n", psz, rc));
1997	MMR3HeapFree(psz);
1998	return rc;
1999	}
2000	MMR3HeapFree(psz);
2001	}
2002	else
2003	{
2004	AssertMsgFailed(("Configuration error: Failed to obtain the uuid, rc=%Rrc.\n", rc));
2005	return rc;
2006	}
2007
2008	/* Define whether attach failure is an error (default) or not. */
2009	bool fAttachFailError;
2010	rc = CFGMR3QueryBool(pCfg, "AttachFailError", &fAttachFailError);
2011	if (RT_FAILURE(rc))
2012	fAttachFailError = true;
2013	pThis->fAttachFailError = fAttachFailError;
2014
2015	/* name to open & watch for */
2016	#ifdef RT_OS_WINDOWS
2017	int iBit = RT_C_TO_UPPER(pThis->pszDevice[0]) - 'A';
2018	if ( iBit > 'Z' - 'A'
2019	\|\| pThis->pszDevice[1] != ':'
2020	\|\| pThis->pszDevice[2])
2021	{
2022	AssertMsgFailed(("Configuration error: Invalid drive specification: '%s'\n", pThis->pszDevice));
2023	return VERR_INVALID_PARAMETER;
2024	}
2025	pThis->fUnitMask = 1 << iBit;
2026	RTStrAPrintf(&pThis->pszDeviceOpen, "\\\\.\\%s", pThis->pszDevice);
2027
2028	#elif defined(RT_OS_SOLARIS)
2029	char *pszBlockDevName = getfullblkname(pThis->pszDevice);
2030	if (!pszBlockDevName)
2031	return VERR_NO_MEMORY;
2032	pThis->pszDeviceOpen = RTStrDup(pszBlockDevName); /* for RTStrFree() */
2033	free(pszBlockDevName);
2034	pThis->pszRawDeviceOpen = RTStrDup(pThis->pszDevice);
2035
2036	#else
2037	pThis->pszDeviceOpen = RTStrDup(pThis->pszDevice);
2038	#endif
2039
2040	if (!pThis->pszDeviceOpen)
2041	return VERR_NO_MEMORY;
2042
2043	return VINF_SUCCESS;
2044	}
2045
2046
2047	/**
2048	* Do the 2nd part of the init after the derived driver has overridden the defaults.
2049	*
2050	* On failure call DRVHostBaseDestruct().
2051	*
2052	* @returns VBox status code.
2053	* @param pThis Pointer to the instance data.
2054	*/
2055	int DRVHostBaseInitFinish(PDRVHOSTBASE pThis)
2056	{
2057	int src = VINF_SUCCESS;
2058	PPDMDRVINS pDrvIns = pThis->pDrvIns;
2059
2060	/* log config summary */
2061	Log(("%s-%d: pszDevice='%s' (%s) cMilliesPoller=%d fReadOnlyConfig=%d fLocked=%d fBIOSVisible=%d Uuid=%RTuuid\n",
2062	pDrvIns->pReg->szName, pDrvIns->iInstance, pThis->pszDevice, pThis->pszDeviceOpen, pThis->cMilliesPoller,
2063	pThis->fReadOnlyConfig, pThis->fLocked, pThis->fBiosVisible, &pThis->Uuid));
2064
2065	/*
2066	* Check that there are no drivers below us.
2067	*/
2068	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
2069	("Configuration error: Not possible to attach anything to this driver!\n"),
2070	VERR_PDM_DRVINS_NO_ATTACH);
2071
2072	/*
2073	* Register saved state.
2074	*/
2075	int rc = PDMDrvHlpSSMRegisterLoadDone(pDrvIns, drvHostBaseLoadDone);
2076	if (RT_FAILURE(rc))
2077	return rc;
2078
2079	/*
2080	* Verify type.
2081	*/
2082	#ifdef RT_OS_WINDOWS
2083	UINT uDriveType = GetDriveType(pThis->pszDevice);
2084	switch (pThis->enmType)
2085	{
2086	case PDMMEDIATYPE_FLOPPY_360:
2087	case PDMMEDIATYPE_FLOPPY_720:
2088	case PDMMEDIATYPE_FLOPPY_1_20:
2089	case PDMMEDIATYPE_FLOPPY_1_44:
2090	case PDMMEDIATYPE_FLOPPY_2_88:
2091	case PDMMEDIATYPE_FLOPPY_FAKE_15_6:
2092	case PDMMEDIATYPE_FLOPPY_FAKE_63_5:
2093	if (uDriveType != DRIVE_REMOVABLE)
2094	{
2095	AssertMsgFailed(("Configuration error: '%s' is not a floppy (type=%d)\n",
2096	pThis->pszDevice, uDriveType));
2097	return VERR_INVALID_PARAMETER;
2098	}
2099	break;
2100	case PDMMEDIATYPE_CDROM:
2101	case PDMMEDIATYPE_DVD:
2102	if (uDriveType != DRIVE_CDROM)
2103	{
2104	AssertMsgFailed(("Configuration error: '%s' is not a cdrom (type=%d)\n",
2105	pThis->pszDevice, uDriveType));
2106	return VERR_INVALID_PARAMETER;
2107	}
2108	break;
2109	case PDMMEDIATYPE_HARD_DISK:
2110	default:
2111	AssertMsgFailed(("enmType=%d\n", pThis->enmType));
2112	return VERR_INVALID_PARAMETER;
2113	}
2114	#endif
2115
2116	/*
2117	* Open the device.
2118	*/
2119	#if defined(RT_OS_DARWIN)
2120	rc = drvHostBaseOpen(pThis, NULL, pThis->fReadOnlyConfig);
2121	#else
2122	rc = drvHostBaseReopen(pThis);
2123	#endif
2124	if (RT_FAILURE(rc))
2125	{
2126	char *pszDevice = pThis->pszDevice;
2127	#ifndef RT_OS_DARWIN
2128	char szPathReal[256];
2129	if ( RTPathExists(pszDevice)
2130	&& RT_SUCCESS(RTPathReal(pszDevice, szPathReal, sizeof(szPathReal))))
2131	pszDevice = szPathReal;
2132	pThis->hFileDevice = NIL_RTFILE;
2133	#endif
2134	#ifdef RT_OS_SOLARIS
2135	pThis->hFileRawDevice = NIL_RTFILE;
2136	#endif
2137
2138	/*
2139	* Disable CD/DVD passthrough in case it was enabled. Would cause
2140	* weird failures later when the guest issues commands. These would
2141	* all fail because of the invalid file handle. So use the normal
2142	* virtual CD/DVD code, which deals more gracefully with unavailable
2143	* "media" - actually a complete drive in this case.
2144	*/
2145	pThis->IMedia.pfnSendCmd = NULL;
2146	AssertMsgFailed(("Could not open host device %s, rc=%Rrc\n", pszDevice, rc));
2147	switch (rc)
2148	{
2149	case VERR_ACCESS_DENIED:
2150	return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS,
2151	#ifdef RT_OS_LINUX
2152	N_("Cannot open host device '%s' for %s access. Check the permissions "
2153	"of that device ('/bin/ls -l %s'): Most probably you need to be member "
2154	"of the device group. Make sure that you logout/login after changing "
2155	"the group settings of the current user"),
2156	#else
2157	N_("Cannot open host device '%s' for %s access. Check the permissions "
2158	"of that device"),
2159	#endif
2160	pszDevice, pThis->fReadOnlyConfig ? "readonly" : "read/write",
2161	pszDevice);
2162	default:
2163	{
2164	if (pThis->fAttachFailError)
2165	return rc;
2166	int erc = PDMDrvHlpVMSetRuntimeError(pDrvIns, 0 /fFlags/,
2167	"DrvHost_MOUNTFAIL",
2168	N_("Cannot attach to host device '%s'"), pszDevice);
2169	AssertRC(erc);
2170	src = rc;
2171	}
2172	}
2173	}
2174	#ifdef RT_OS_WINDOWS
2175	if (RT_SUCCESS(src))
2176	DRVHostBaseMediaPresent(pThis);
2177	#endif
2178
2179	/*
2180	* Lock the drive if that's required by the configuration.
2181	*/
2182	if (pThis->fLocked)
2183	{
2184	if (pThis->pfnDoLock)
2185	rc = pThis->pfnDoLock(pThis, true);
2186	if (RT_FAILURE(rc))
2187	{
2188	AssertMsgFailed(("Failed to lock the dvd drive. rc=%Rrc\n", rc));
2189	return rc;
2190	}
2191	}
2192
2193	#ifndef RT_OS_WINDOWS
2194	if (RT_SUCCESS(src))
2195	{
2196	/*
2197	* Create the event semaphore which the poller thread will wait on.
2198	*/
2199	rc = RTSemEventCreate(&pThis->EventPoller);
2200	if (RT_FAILURE(rc))
2201	return rc;
2202	}
2203	#endif
2204
2205	/*
2206	* Initialize the critical section used for serializing the access to the media.
2207	*/
2208	rc = RTCritSectInit(&pThis->CritSect);
2209	if (RT_FAILURE(rc))
2210	return rc;
2211
2212	if (RT_SUCCESS(src))
2213	{
2214	/*
2215	* Start the thread which will poll for the media.
2216	*/
2217	rc = RTThreadCreate(&pThis->ThreadPoller, drvHostBaseMediaThread, pThis, 0,
2218	RTTHREADTYPE_INFREQUENT_POLLER, RTTHREADFLAGS_WAITABLE, "DVDMEDIA");
2219	if (RT_FAILURE(rc))
2220	{
2221	AssertMsgFailed(("Failed to create poller thread. rc=%Rrc\n", rc));
2222	return rc;
2223	}
2224
2225	/*
2226	* Wait for the thread to start up (!w32:) and do one detection loop.
2227	*/
2228	rc = RTThreadUserWait(pThis->ThreadPoller, 10000);
2229	AssertRC(rc);
2230	#ifdef RT_OS_WINDOWS
2231	if (!pThis->hwndDeviceChange)
2232	return VERR_GENERAL_FAILURE;
2233	#endif
2234	}
2235
2236	if (RT_FAILURE(src))
2237	return src;
2238	return rc;
2239	}
2240

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

source: vbox/trunk/src/VBox/Devices/Storage/DrvHostBase.cpp@ 63429

Download in other formats: