HostHardwareFreeBSD.cpp@ 28851

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

Line
1	/* $Id: HostHardwareFreeBSD.cpp 28800 2010-04-27 08:22:32Z vboxsync $ */
2	/** @file
3	* Classes for handling hardware detection under FreeBSD.
4	*/
5
6	/*
7	* Copyright (C) 2008 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	#define LOG_GROUP LOG_GROUP_MAIN
19
20	/*******************************************************************************
21	* Header Files *
22	*******************************************************************************/
23
24	#include <HostHardwareLinux.h>
25
26	#include <VBox/log.h>
27
28	#include <iprt/dir.h>
29	#include <iprt/env.h>
30	#include <iprt/file.h>
31	#include <iprt/mem.h>
32	#include <iprt/param.h>
33	#include <iprt/path.h>
34	#include <iprt/thread.h> /* for RTThreadSleep() */
35	#include <iprt/string.h>
36
37	#ifdef RT_OS_FREEBSD
38	# include <sys/types.h>
39	# include <sys/stat.h>
40	# include <unistd.h>
41	# include <sys/ioctl.h>
42	# include <fcntl.h>
43	# include <cam/cam.h>
44	# include <cam/cam_ccb.h>
45	# include <cam/scsi/scsi_pass.h>
46	#endif /* RT_OS_FREEBSD */
47	#include <vector>
48
49	/******************************************************************************
50	* Typedefs and Defines *
51	******************************************************************************/
52
53	static int getDriveInfoFromEnv(const char pcszVar, DriveInfoList pList,
54	bool isDVD, bool *pfSuccess);
55	static int getDVDInfoFromCAM(DriveInfoList pList, bool pfSuccess);
56
57	/** Find the length of a string, ignoring trailing non-ascii or control
58	* characters */
59	static size_t strLenStripped(const char *pcsz)
60	{
61	size_t cch = 0;
62	for (size_t i = 0; pcsz[i] != '\0'; ++i)
63	if (pcsz[i] > 32 && pcsz[i] < 127)
64	cch = i;
65	return cch + 1;
66	}
67
68	static void strLenRemoveTrailingWhiteSpace(char *psz, size_t cchStr)
69	{
70	while ( (cchStr > 0)
71	&& (psz[cchStr -1] == ' '))
72	psz[--cchStr] = '\0';
73	}
74
75	/**
76	* Initialise the device description for a DVD drive based on
77	* vendor and model name strings.
78	* @param pcszVendor the vendor ID string
79	* @param pcszModel the product ID string
80	* @param pszDesc where to store the description string (optional)
81	* @param cchDesc the size of the buffer in @pszDesc
82	*/
83	/* static */
84	void dvdCreateDeviceString(const char pcszVendor, const char pcszModel,
85	char *pszDesc, size_t cchDesc)
86	{
87	AssertPtrReturnVoid(pcszVendor);
88	AssertPtrReturnVoid(pcszModel);
89	AssertPtrNullReturnVoid(pszDesc);
90	AssertReturnVoid(!pszDesc \|\| cchDesc > 0);
91	size_t cchVendor = strLenStripped(pcszVendor);
92	size_t cchModel = strLenStripped(pcszModel);
93
94	/* Construct the description string as "Vendor Product" */
95	if (pszDesc)
96	{
97	if (cchVendor > 0)
98	RTStrPrintf(pszDesc, cchDesc, "%.*s %s", cchVendor, pcszVendor,
99	cchModel > 0 ? pcszModel : "(unknown drive model)");
100	else
101	RTStrPrintf(pszDesc, cchDesc, "%s", pcszModel);
102	}
103	}
104
105
106	int VBoxMainDriveInfo::updateDVDs ()
107	{
108	LogFlowThisFunc(("entered\n"));
109	int rc = VINF_SUCCESS;
110	bool fSuccess = false; /* Have we succeeded in finding anything yet? */
111
112	try
113	{
114	mDVDList.clear ();
115	/* Always allow the user to override our auto-detection using an
116	* environment variable. */
117	if (RT_SUCCESS(rc) && !fSuccess)
118	rc = getDriveInfoFromEnv("VBOX_CDROM", &mDVDList, true /* isDVD */,
119	&fSuccess);
120	if (RT_SUCCESS(rc) && !fSuccess)
121	rc = getDVDInfoFromCAM(&mDVDList, &fSuccess);
122	}
123	catch(std::bad_alloc &e)
124	{
125	rc = VERR_NO_MEMORY;
126	}
127	LogFlowThisFunc(("rc=%Rrc\n", rc));
128	return rc;
129	}
130
131	int VBoxMainDriveInfo::updateFloppies ()
132	{
133	LogFlowThisFunc(("entered\n"));
134	int rc = VINF_SUCCESS;
135	bool fSuccess = false; /* Have we succeeded in finding anything yet? */
136
137	try
138	{
139	mFloppyList.clear ();
140	/* Always allow the user to override our auto-detection using an
141	* environment variable. */
142	if (RT_SUCCESS(rc) && !fSuccess)
143	rc = getDriveInfoFromEnv("VBOX_FLOPPY", &mFloppyList, false /* isDVD */,
144	&fSuccess);
145	}
146	catch(std::bad_alloc &e)
147	{
148	rc = VERR_NO_MEMORY;
149	}
150	LogFlowThisFunc(("rc=%Rrc\n", rc));
151	return rc;
152	}
153
154	/**
155	* Search for available CD/DVD drives using the CAM layer.
156	*
157	* @returns iprt status code
158	* @param pList the list to append the drives found to
159	* @param pfSuccess this will be set to true if we found at least one drive
160	* and to false otherwise. Optional.
161	*/
162	static int getDVDInfoFromCAM(DriveInfoList pList, bool pfSuccess)
163	{
164	int rc = VINF_SUCCESS;
165	RTFILE FileXpt;
166
167	rc = RTFileOpen(&FileXpt, "/dev/xpt0", RTFILE_O_READWRITE \| RTFILE_O_OPEN \| RTFILE_O_DENY_NONE);
168	if (RT_SUCCESS(rc))
169	{
170	union ccb DeviceCCB;
171	struct dev_match_pattern DeviceMatchPattern;
172	struct dev_match_result *paMatches = NULL;
173
174	memset(&DeviceCCB, 0, sizeof(union ccb));
175	memset(&DeviceMatchPattern, 0, sizeof(struct device_match_pattern));
176
177	/* We want to get all devices. */
178	DeviceCCB.ccb_h.func_code = XPT_DEV_MATCH;
179	DeviceCCB.ccb_h.path_id = CAM_XPT_PATH_ID;
180	DeviceCCB.ccb_h.target_id = CAM_TARGET_WILDCARD;
181	DeviceCCB.ccb_h.target_lun = CAM_LUN_WILDCARD;
182
183	/* Setup the pattern */
184	DeviceMatchPattern.type = DEV_MATCH_DEVICE;
185	DeviceMatchPattern.pattern.device_pattern.path_id = CAM_XPT_PATH_ID;
186	DeviceMatchPattern.pattern.device_pattern.target_id = CAM_TARGET_WILDCARD;
187	DeviceMatchPattern.pattern.device_pattern.target_lun = CAM_LUN_WILDCARD;
188	DeviceMatchPattern.pattern.device_pattern.flags = DEV_MATCH_INQUIRY;
189	DeviceMatchPattern.pattern.device_pattern.inq_pat.type = T_CDROM;
190	DeviceMatchPattern.pattern.device_pattern.inq_pat.media_type = SIP_MEDIA_REMOVABLE \| SIP_MEDIA_FIXED;
191	DeviceMatchPattern.pattern.device_pattern.inq_pat.vendor[0] = ''; / Matches anything */
192	DeviceMatchPattern.pattern.device_pattern.inq_pat.product[0] = ''; / Matches anything */
193	DeviceMatchPattern.pattern.device_pattern.inq_pat.revision[0] = ''; / Matches anything */
194	DeviceCCB.cdm.num_patterns = 1;
195	DeviceCCB.cdm.pattern_buf_len = sizeof(struct dev_match_result);
196	DeviceCCB.cdm.patterns = &DeviceMatchPattern;
197
198	/*
199	* Allocate the buffer holding the matches.
200	* We will allocate for 10 results and call
201	* CAM multiple times if we have more results.
202	*/
203	paMatches = (struct dev_match_result )RTMemAllocZ(10 sizeof(struct dev_match_result));
204	if (paMatches)
205	{
206	DeviceCCB.cdm.num_matches = 0;
207	DeviceCCB.cdm.match_buf_len = 10 * sizeof(struct dev_match_result);
208	DeviceCCB.cdm.matches = paMatches;
209
210	do
211	{
212	rc = RTFileIoCtl(FileXpt, CAMIOCOMMAND, &DeviceCCB, sizeof(union ccb), NULL);
213	if (RT_FAILURE(rc))
214	{
215	Log(("Error while querying available CD/DVD devices rc=%Rrc\n", rc));
216	break;
217	}
218
219	for (unsigned i = 0; i < DeviceCCB.cdm.num_matches; i++)
220	{
221	if (paMatches[i].type == DEV_MATCH_DEVICE)
222	{
223	/* We have the drive now but need the appropriate device node */
224	struct device_match_result *pDevResult = &paMatches[i].result.device_result;
225	union ccb PeriphCCB;
226	struct dev_match_pattern PeriphMatchPattern;
227	struct dev_match_result aPeriphMatches[2];
228	struct periph_match_result *pPeriphResult = NULL;
229	unsigned iPeriphMatch = 0;
230
231	memset(&PeriphCCB, 0, sizeof(union ccb));
232	memset(&PeriphMatchPattern, 0, sizeof(struct dev_match_pattern));
233	memset(aPeriphMatches, 0, sizeof(aPeriphMatches));
234
235	/* This time we only want the specific nodes for the device. */
236	PeriphCCB.ccb_h.func_code = XPT_DEV_MATCH;
237	PeriphCCB.ccb_h.path_id = paMatches[i].result.device_result.path_id;
238	PeriphCCB.ccb_h.target_id = paMatches[i].result.device_result.target_id;
239	PeriphCCB.ccb_h.target_lun = paMatches[i].result.device_result.target_lun;
240
241	/* Setup the pattern */
242	PeriphMatchPattern.type = DEV_MATCH_PERIPH;
243	PeriphMatchPattern.pattern.periph_pattern.path_id = paMatches[i].result.device_result.path_id;
244	PeriphMatchPattern.pattern.periph_pattern.target_id = paMatches[i].result.device_result.target_id;
245	PeriphMatchPattern.pattern.periph_pattern.target_lun = paMatches[i].result.device_result.target_lun;
246	PeriphMatchPattern.pattern.periph_pattern.flags = PERIPH_MATCH_PATH \| PERIPH_MATCH_TARGET \| PERIPH_MATCH_LUN;
247	PeriphCCB.cdm.num_patterns = 1;
248	PeriphCCB.cdm.pattern_buf_len = sizeof(struct dev_match_result);
249	PeriphCCB.cdm.patterns = &PeriphMatchPattern;
250	PeriphCCB.cdm.num_matches = 0;
251	PeriphCCB.cdm.match_buf_len = sizeof(aPeriphMatches);
252	PeriphCCB.cdm.matches = aPeriphMatches;
253
254	do
255	{
256	rc = RTFileIoCtl(FileXpt, CAMIOCOMMAND, &PeriphCCB, sizeof(union ccb), NULL);
257	if (RT_FAILURE(rc))
258	{
259	Log(("Error while querying available periph devices rc=%Rrc\n", rc));
260	break;
261	}
262
263	for (iPeriphMatch = 0; iPeriphMatch < PeriphCCB.cdm.num_matches; iPeriphMatch++)
264	{
265	if ( (aPeriphMatches[iPeriphMatch].type == DEV_MATCH_PERIPH)
266	&& (!strcmp(aPeriphMatches[iPeriphMatch].result.periph_result.periph_name, "cd")))
267	{
268	pPeriphResult = &aPeriphMatches[iPeriphMatch].result.periph_result;
269	break; /* We found the periph device */
270	}
271	}
272
273	if (iPeriphMatch < PeriphCCB.cdm.num_matches)
274	break;
275
276	} while ( (DeviceCCB.ccb_h.status == CAM_REQ_CMP)
277	&& (DeviceCCB.cdm.status == CAM_DEV_MATCH_MORE));
278
279	if (pPeriphResult)
280	{
281	char szPath[RTPATH_MAX];
282	char szDesc[256];
283
284	RTStrPrintf(szPath, sizeof(szPath), "/dev/%s%d",
285	pPeriphResult->periph_name, pPeriphResult->unit_number);
286
287	/* Remove trailing white space. */
288	strLenRemoveTrailingWhiteSpace(pDevResult->inq_data.vendor,
289	sizeof(pDevResult->inq_data.vendor));
290	strLenRemoveTrailingWhiteSpace(pDevResult->inq_data.product,
291	sizeof(pDevResult->inq_data.product));
292
293	dvdCreateDeviceString(pDevResult->inq_data.vendor,
294	pDevResult->inq_data.product,
295	szDesc, sizeof(szDesc));
296
297	pList->push_back(DriveInfo(szPath, NULL, szDesc));
298	if (pfSuccess)
299	*pfSuccess = true;
300	}
301	}
302	}
303	} while ( (DeviceCCB.ccb_h.status == CAM_REQ_CMP)
304	&& (DeviceCCB.cdm.status == CAM_DEV_MATCH_MORE));
305
306	RTMemFree(paMatches);
307	}
308	else
309	rc = VERR_NO_MEMORY;
310
311	RTFileClose(FileXpt);
312	}
313
314	return rc;
315	}
316
317	/**
318	* Extract the names of drives from an environment variable and add them to a
319	* list if they are valid.
320	* @returns iprt status code
321	* @param pcszVar the name of the environment variable. The variable
322	* value should be a list of device node names, separated
323	* by ':' characters.
324	* @param pList the list to append the drives found to
325	* @param isDVD are we looking for DVD drives or for floppies?
326	* @param pfSuccess this will be set to true if we found at least one drive
327	* and to false otherwise. Optional.
328	*/
329	static int getDriveInfoFromEnv(const char pcszVar, DriveInfoList pList,
330	bool isDVD, bool *pfSuccess)
331	{
332	AssertPtrReturn(pcszVar, VERR_INVALID_POINTER);
333	AssertPtrReturn(pList, VERR_INVALID_POINTER);
334	AssertPtrNullReturn(pfSuccess, VERR_INVALID_POINTER);
335	LogFlowFunc(("pcszVar=%s, pList=%p, isDVD=%d, pfSuccess=%p\n", pcszVar,
336	pList, isDVD, pfSuccess));
337	int rc = VINF_SUCCESS;
338	bool success = false;
339	char *pszFreeMe = RTEnvDupEx(RTENV_DEFAULT, pcszVar);
340
341	try
342	{
343	const char *pcszCurrent = pszFreeMe;
344	while (pcszCurrent && *pcszCurrent != '\0')
345	{
346	const char *pcszNext = strchr(pcszCurrent, ':');
347	char szPath[RTPATH_MAX], szReal[RTPATH_MAX];
348	char szDesc[256], szUdi[256];
349	if (pcszNext)
350	RTStrPrintf(szPath, sizeof(szPath), "%.*s",
351	pcszNext - pcszCurrent - 1, pcszCurrent);
352	else
353	RTStrPrintf(szPath, sizeof(szPath), "%s", pcszCurrent);
354	if (RT_SUCCESS(RTPathReal(szPath, szReal, sizeof(szReal))))
355	{
356	szUdi[0] = '\0'; /** @todo r=bird: missing a call to devValidateDevice() here and szUdi wasn't
357	* initialized because of that. Need proper fixing. */
358	pList->push_back(DriveInfo(szReal, szUdi, szDesc));
359	success = true;
360	}
361	pcszCurrent = pcszNext ? pcszNext + 1 : NULL;
362	}
363	if (pfSuccess != NULL)
364	*pfSuccess = success;
365	}
366	catch(std::bad_alloc &e)
367	{
368	rc = VERR_NO_MEMORY;
369	}
370	RTStrFree(pszFreeMe);
371	LogFlowFunc(("rc=%Rrc, success=%d\n", rc, success));
372	return rc;
373	}
374
375	#if 0
376	int VBoxMainUSBDeviceInfo::UpdateDevices ()
377	{
378	LogFlowThisFunc(("entered\n"));
379	int rc = VINF_SUCCESS;
380	bool success = false; /* Have we succeeded in finding anything yet? */
381	try
382	{
383	bool halSuccess = false;
384	mDeviceList.clear();
385	#if defined(RT_OS_LINUX)
386	#ifdef VBOX_WITH_DBUS
387	if ( RT_SUCCESS(rc)
388	&& RT_SUCCESS(RTDBusLoadLib())
389	&& (!success \|\| testing()))
390	rc = getUSBDeviceInfoFromHal(&mDeviceList, &halSuccess);
391	/* Try the old API if the new one succeeded as only one of them will
392	* pick up devices anyway. */
393	if (RT_SUCCESS(rc) && halSuccess && (!success \|\| testing()))
394	rc = getOldUSBDeviceInfoFromHal(&mDeviceList, &halSuccess);
395	if (!success)
396	success = halSuccess;
397	#endif /* VBOX_WITH_DBUS defined */
398	#endif /* RT_OS_LINUX */
399	}
400	catch(std::bad_alloc &e)
401	{
402	rc = VERR_NO_MEMORY;
403	}
404	LogFlowThisFunc(("rc=%Rrc\n", rc));
405	return rc;
406	}
407
408	struct VBoxMainHotplugWaiter::Context
409	{
410	#if defined RT_OS_LINUX && defined VBOX_WITH_DBUS
411	/** The connection to DBus */
412	RTMemAutoPtr <DBusConnection, VBoxHalShutdownPrivate> mConnection;
413	/** Semaphore which is set when a device is hotplugged and reset when
414	* it is read. */
415	volatile bool mTriggered;
416	/** A flag to say that we wish to interrupt the current wait. */
417	volatile bool mInterrupt;
418	/** Constructor */
419	Context() : mTriggered(false), mInterrupt(false) {}
420	#endif /* defined RT_OS_LINUX && defined VBOX_WITH_DBUS */
421	};
422
423	/* This constructor sets up a private connection to the DBus daemon, connects
424	* to the hal service and installs a filter which sets the mTriggered flag in
425	* the Context structure when a device (not necessarily USB) is added or
426	* removed. */
427	VBoxMainHotplugWaiter::VBoxMainHotplugWaiter ()
428	{
429	#if defined RT_OS_LINUX && defined VBOX_WITH_DBUS
430	int rc = VINF_SUCCESS;
431
432	mContext = new Context;
433	if (RT_SUCCESS(RTDBusLoadLib()))
434	{
435	for (unsigned i = 0; RT_SUCCESS(rc) && i < 5 && !mContext->mConnection; ++i)
436	{
437	rc = halInitPrivate (&mContext->mConnection);
438	}
439	if (!mContext->mConnection)
440	rc = VERR_NOT_SUPPORTED;
441	DBusMessage *pMessage;
442	while ( RT_SUCCESS(rc)
443	&& (pMessage = dbus_connection_pop_message (mContext->mConnection.get())) != NULL)
444	dbus_message_unref (pMessage); /* empty the message queue. */
445	if ( RT_SUCCESS(rc)
446	&& !dbus_connection_add_filter (mContext->mConnection.get(),
447	dbusFilterFunction,
448	(void *) &mContext->mTriggered, NULL))
449	rc = VERR_NO_MEMORY;
450	if (RT_FAILURE(rc))
451	mContext->mConnection.reset();
452	}
453	#endif /* defined RT_OS_LINUX && defined VBOX_WITH_DBUS */
454	}
455
456	/* Destructor */
457	VBoxMainHotplugWaiter::~VBoxMainHotplugWaiter ()
458	{
459	#if defined RT_OS_LINUX && defined VBOX_WITH_DBUS
460	if (!!mContext->mConnection)
461	dbus_connection_remove_filter (mContext->mConnection.get(), dbusFilterFunction,
462	(void *) &mContext->mTriggered);
463	delete mContext;
464	#endif /* defined RT_OS_LINUX && defined VBOX_WITH_DBUS */
465	}
466
467	/* Currently this is implemented using a timed out wait on our private DBus
468	* connection. Because the connection is private we don't have to worry about
469	* blocking other users. */
470	int VBoxMainHotplugWaiter::Wait(RTMSINTERVAL cMillies)
471	{
472	int rc = VINF_SUCCESS;
473	#if defined RT_OS_LINUX && defined VBOX_WITH_DBUS
474	if (!mContext->mConnection)
475	rc = VERR_NOT_SUPPORTED;
476	bool connected = true;
477	mContext->mTriggered = false;
478	mContext->mInterrupt = false;
479	unsigned cRealMillies;
480	if (cMillies != RT_INDEFINITE_WAIT)
481	cRealMillies = cMillies;
482	else
483	cRealMillies = DBUS_POLL_TIMEOUT;
484	while ( RT_SUCCESS(rc) && connected && !mContext->mTriggered
485	&& !mContext->mInterrupt)
486	{
487	connected = dbus_connection_read_write_dispatch (mContext->mConnection.get(),
488	cRealMillies);
489	if (mContext->mInterrupt)
490	LogFlowFunc(("wait loop interrupted\n"));
491	if (cMillies != RT_INDEFINITE_WAIT)
492	mContext->mInterrupt = true;
493	}
494	if (!connected)
495	rc = VERR_TRY_AGAIN;
496	#else /* !(defined RT_OS_LINUX && defined VBOX_WITH_DBUS) */
497	rc = VERR_NOT_IMPLEMENTED;
498	#endif /* !(defined RT_OS_LINUX && defined VBOX_WITH_DBUS) */
499	return rc;
500	}
501
502	/* Set a flag to tell the Wait not to resume next time it times out. */
503	void VBoxMainHotplugWaiter::Interrupt()
504	{
505	#if defined RT_OS_LINUX && defined VBOX_WITH_DBUS
506	LogFlowFunc(("\n"));
507	mContext->mInterrupt = true;
508	#endif /* defined RT_OS_LINUX && defined VBOX_WITH_DBUS */
509	}
510	#endif
511

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

source: vbox/trunk/src/VBox/Main/freebsd/HostHardwareFreeBSD.cpp@ 28851

Download in other formats: