VirtualBox

source: vbox/trunk/src/VBox/Main/linux/HostHardwareLinux.cpp@ 28800

Last change on this file since 28800 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 Id Revision
File size: 91.3 KB
Line 
1/* $Id: HostHardwareLinux.cpp 28800 2010-04-27 08:22:32Z vboxsync $ */
2/** @file
3 * Classes for handling hardware detection under Linux. Please feel free to
4 * expand these to work for other systems (Solaris!) or to add new ones for
5 * other systems.
6 */
7
8/*
9 * Copyright (C) 2008 Oracle Corporation
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.215389.xyz. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 */
19
20#define LOG_GROUP LOG_GROUP_MAIN
21
22/*******************************************************************************
23* Header Files *
24*******************************************************************************/
25
26#include <HostHardwareLinux.h>
27
28#include <VBox/err.h>
29#include <VBox/log.h>
30
31#ifdef VBOX_USB_WITH_DBUS
32# include <VBox/dbus.h>
33#endif
34
35#include <iprt/asm.h>
36#include <iprt/dir.h>
37#include <iprt/env.h>
38#include <iprt/file.h>
39#include <iprt/mem.h>
40#include <iprt/param.h>
41#include <iprt/path.h>
42#include <iprt/pipe.h>
43#include <iprt/poll.h>
44#include <iprt/socket.h>
45#include <iprt/string.h>
46#include <iprt/thread.h> /* for RTThreadSleep() */
47
48#include <linux/cdrom.h>
49#include <linux/fd.h>
50#include <linux/major.h>
51#include <scsi/scsi.h>
52
53#include <iprt/linux/sysfs.h>
54
55#ifdef VBOX_USB_WITH_SYSFS
56# ifdef VBOX_USB_WITH_FAM
57# include <fam.h>
58# endif
59#endif
60
61#include <vector>
62
63#include <errno.h>
64
65/******************************************************************************
66* Global Variables *
67******************************************************************************/
68
69#ifdef TESTCASE
70static bool testing() { return true; }
71static bool fNoProbe = false;
72static bool noProbe() { return fNoProbe; }
73static void setNoProbe(bool val) { fNoProbe = val; }
74#else
75static bool testing() { return false; }
76static bool noProbe() { return false; }
77static void setNoProbe(bool val) { (void)val; }
78#endif
79
80/******************************************************************************
81* Typedefs and Defines *
82******************************************************************************/
83
84/** When waiting for hotplug events, we currently restart the wait after at
85 * most this many milliseconds. */
86enum { DBUS_POLL_TIMEOUT = 2000 /* ms */ };
87
88static int getDriveInfoFromEnv(const char *pcszVar, DriveInfoList *pList,
89 bool isDVD, bool *pfSuccess);
90static int getDriveInfoFromDev(DriveInfoList *pList, bool isDVD,
91 bool *pfSuccess);
92static int getDriveInfoFromSysfs(DriveInfoList *pList, bool isDVD,
93 bool *pfSuccess);
94#ifdef VBOX_USB_WITH_SYSFS
95# ifdef VBOX_USB_WITH_FAM
96static int getUSBDeviceInfoFromSysfs(USBDeviceInfoList *pList, bool *pfSuccess);
97# endif
98# ifdef VBOX_USB_WITH_DBUS
99/* These must be extern to be usable in the RTMemAutoPtr template */
100extern void VBoxHalShutdown (DBusConnection *pConnection);
101extern void VBoxHalShutdownPrivate (DBusConnection *pConnection);
102extern void VBoxDBusConnectionUnref(DBusConnection *pConnection);
103extern void VBoxDBusConnectionCloseAndUnref(DBusConnection *pConnection);
104extern void VBoxDBusMessageUnref(DBusMessage *pMessage);
105
106static int halInit(RTMemAutoPtr <DBusConnection, VBoxHalShutdown> *pConnection);
107static int halInitPrivate(RTMemAutoPtr <DBusConnection, VBoxHalShutdownPrivate> *pConnection);
108static int halFindDeviceStringMatch (DBusConnection *pConnection,
109 const char *pszKey, const char *pszValue,
110 RTMemAutoPtr <DBusMessage, VBoxDBusMessageUnref> *pMessage);
111/*
112static int halFindDeviceStringMatchVector (DBusConnection *pConnection,
113 const char *pszKey,
114 const char *pszValue,
115 std::vector<iprt::MiniString> *pMatches);
116*/
117static int halGetPropertyStrings (DBusConnection *pConnection,
118 const char *pszUdi, size_t cKeys,
119 const char **papszKeys, char **papszValues,
120 RTMemAutoPtr <DBusMessage, VBoxDBusMessageUnref> *pMessage);
121/*
122static int halGetPropertyStringsVector (DBusConnection *pConnection,
123 const char *pszUdi, size_t cProps,
124 const char **papszKeys,
125 std::vector<iprt::MiniString> *pMatches,
126 bool *pfMatches, bool *pfSuccess);
127*/
128static int getUSBDeviceInfoFromHal(USBDeviceInfoList *pList, bool *pfSuccess);
129static int getOldUSBDeviceInfoFromHal(USBDeviceInfoList *pList, bool *pfSuccess);
130static int getUSBInterfacesFromHal(std::vector <iprt::MiniString> *pList,
131 const char *pcszUdi, bool *pfSuccess);
132static DBusHandlerResult dbusFilterFunction (DBusConnection *pConnection,
133 DBusMessage *pMessage, void *pvUser);
134# endif /* VBOX_USB_WITH_DBUS */
135#endif /* VBOX_USB_WITH_SYSFS */
136
137
138/** Find the length of a string, ignoring trailing non-ascii or control
139 * characters */
140static size_t strLenStripped(const char *pcsz)
141{
142 size_t cch = 0;
143 for (size_t i = 0; pcsz[i] != '\0'; ++i)
144 if (pcsz[i] > 32 && pcsz[i] < 127)
145 cch = i;
146 return cch + 1;
147}
148
149
150/**
151 * Get the name of a floppy drive according to the Linux floppy driver.
152 * @returns true on success, false if the name was not available (i.e. the
153 * device was not readible, or the file name wasn't a PC floppy
154 * device)
155 * @param pcszNode the path to the device node for the device
156 * @param Number the Linux floppy driver number for the drive. Required.
157 * @param pszName where to store the name retreived
158 */
159static bool floppyGetName(const char *pcszNode, unsigned Number,
160 floppy_drive_name pszName)
161{
162 AssertPtrReturn(pcszNode, false);
163 AssertPtrReturn(pszName, false);
164 AssertReturn(Number <= 7, false);
165 RTFILE File;
166 int rc = RTFileOpen(&File, pcszNode, RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_NONE | RTFILE_O_NON_BLOCK);
167 if (RT_SUCCESS(rc))
168 {
169 int rcIoCtl;
170 rc = RTFileIoCtl(File, FDGETDRVTYP, pszName, 0, &rcIoCtl);
171 RTFileClose(File);
172 if (RT_SUCCESS(rc) && rcIoCtl >= 0)
173 return true;
174 }
175 return false;
176}
177
178
179/**
180 * Create a UDI and a description for a floppy drive based on a number and the
181 * driver's name for it. We deliberately return an ugly sequence of
182 * characters as the description rather than an English language string to
183 * avoid translation issues.
184 *
185 * @returns true if we know the device to be valid, false otherwise
186 * @param pcszName the floppy driver name for the device (optional)
187 * @param Number the number of the floppy (0 to 3 on FDC 0, 4 to 7 on
188 * FDC 1)
189 * @param pszDesc where to store the device description (optional)
190 * @param cchDesc the size of the buffer in @a pszDesc
191 * @param pszUdi where to store the device UDI (optional)
192 * @param cchUdi the size of the buffer in @a pszUdi
193 */
194static void floppyCreateDeviceStrings(const floppy_drive_name pcszName,
195 unsigned Number, char *pszDesc,
196 size_t cchDesc, char *pszUdi,
197 size_t cchUdi)
198{
199 AssertPtrNullReturnVoid(pcszName);
200 AssertPtrNullReturnVoid(pszDesc);
201 AssertReturnVoid(!pszDesc || cchDesc > 0);
202 AssertPtrNullReturnVoid(pszUdi);
203 AssertReturnVoid(!pszUdi || cchUdi > 0);
204 AssertReturnVoid(Number <= 7);
205 if (pcszName)
206 {
207 const char *pcszSize;
208 switch(pcszName[0])
209 {
210 case 'd': case 'q': case 'h':
211 pcszSize = "5.25\"";
212 break;
213 case 'D': case 'H': case 'E': case 'u':
214 pcszSize = "3.5\"";
215 break;
216 default:
217 pcszSize = "(unknown)";
218 }
219 if (pszDesc)
220 RTStrPrintf(pszDesc, cchDesc, "%s %s K%s", pcszSize, &pcszName[1],
221 Number > 3 ? ", FDC 2" : "");
222 }
223 else
224 {
225 if (pszDesc)
226 RTStrPrintf(pszDesc, cchDesc, "FDD %d%s", (Number & 4) + 1,
227 Number > 3 ? ", FDC 2" : "");
228 }
229 if (pszUdi)
230 RTStrPrintf(pszUdi, cchUdi,
231 "/org/freedesktop/Hal/devices/platform_floppy_%u_storage",
232 Number);
233}
234
235
236/**
237 * Check whether a device number might correspond to a CD-ROM device according
238 * to Documentation/devices.txt in the Linux kernel source.
239 * @returns true if it might, false otherwise
240 * @param Number the device number (major and minor combination)
241 */
242static bool isCdromDevNum(dev_t Number)
243{
244 int major = major(Number);
245 int minor = minor(Number);
246 if ((major == IDE0_MAJOR) && !(minor & 0x3f))
247 return true;
248 if (major == SCSI_CDROM_MAJOR)
249 return true;
250 if (major == CDU31A_CDROM_MAJOR)
251 return true;
252 if (major == GOLDSTAR_CDROM_MAJOR)
253 return true;
254 if (major == OPTICS_CDROM_MAJOR)
255 return true;
256 if (major == SANYO_CDROM_MAJOR)
257 return true;
258 if (major == MITSUMI_X_CDROM_MAJOR)
259 return true;
260 if ((major == IDE1_MAJOR) && !(minor & 0x3f))
261 return true;
262 if (major == MITSUMI_CDROM_MAJOR)
263 return true;
264 if (major == CDU535_CDROM_MAJOR)
265 return true;
266 if (major == MATSUSHITA_CDROM_MAJOR)
267 return true;
268 if (major == MATSUSHITA_CDROM2_MAJOR)
269 return true;
270 if (major == MATSUSHITA_CDROM3_MAJOR)
271 return true;
272 if (major == MATSUSHITA_CDROM4_MAJOR)
273 return true;
274 if (major == AZTECH_CDROM_MAJOR)
275 return true;
276 if (major == 30 /* CM205_CDROM_MAJOR */) /* no #define for some reason */
277 return true;
278 if (major == CM206_CDROM_MAJOR)
279 return true;
280 if ((major == IDE3_MAJOR) && !(minor & 0x3f))
281 return true;
282 if (major == 46 /* Parallel port ATAPI CD-ROM */) /* no #define */
283 return true;
284 if ((major == IDE4_MAJOR) && !(minor & 0x3f))
285 return true;
286 if ((major == IDE5_MAJOR) && !(minor & 0x3f))
287 return true;
288 if ((major == IDE6_MAJOR) && !(minor & 0x3f))
289 return true;
290 if ((major == IDE7_MAJOR) && !(minor & 0x3f))
291 return true;
292 if ((major == IDE8_MAJOR) && !(minor & 0x3f))
293 return true;
294 if ((major == IDE9_MAJOR) && !(minor & 0x3f))
295 return true;
296 if (major == 113 /* VIOCD_MAJOR */)
297 return true;
298 return false;
299}
300
301
302/**
303 * Send an SCSI INQUIRY command to a device and return selected information.
304 * @returns iprt status code
305 * @returns VERR_TRY_AGAIN if the query failed but might succeed next time
306 * @param pcszNode the full path to the device node
307 * @param pu8Type where to store the SCSI device type on success (optional)
308 * @param pchVendor where to store the vendor id string on success (optional)
309 * @param cchVendor the size of the @a pchVendor buffer
310 * @param pchModel where to store the product id string on success (optional)
311 * @param cchModel the size of the @a pchModel buffer
312 * @note check documentation on the SCSI INQUIRY command and the Linux kernel
313 * SCSI headers included above if you want to understand what is going
314 * on in this method.
315 */
316static int cdromDoInquiry(const char *pcszNode, uint8_t *pu8Type,
317 char *pchVendor, size_t cchVendor, char *pchModel,
318 size_t cchModel)
319{
320 LogRelFlowFunc(("pcszNode=%s, pu8Type=%p, pchVendor=%p, cchVendor=%llu, pchModel=%p, cchModel=%llu\n",
321 pcszNode, pu8Type, pchVendor, cchVendor, pchModel,
322 cchModel));
323 AssertPtrReturn(pcszNode, VERR_INVALID_POINTER);
324 AssertPtrNullReturn(pu8Type, VERR_INVALID_POINTER);
325 AssertPtrNullReturn(pchVendor, VERR_INVALID_POINTER);
326 AssertPtrNullReturn(pchModel, VERR_INVALID_POINTER);
327
328 RTFILE hFile;
329 int rc = RTFileOpen(&hFile, pcszNode, RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_NONE | RTFILE_O_NON_BLOCK);
330 if (RT_SUCCESS(rc))
331 {
332 int rcIoCtl = 0;
333 unsigned char u8Response[96] = { 0 };
334 struct cdrom_generic_command CdromCommandReq;
335 RT_ZERO(CdromCommandReq);
336 CdromCommandReq.cmd[0] = INQUIRY;
337 CdromCommandReq.cmd[4] = sizeof(u8Response);
338 CdromCommandReq.buffer = u8Response;
339 CdromCommandReq.buflen = sizeof(u8Response);
340 CdromCommandReq.data_direction = CGC_DATA_READ;
341 CdromCommandReq.timeout = 5000; /* ms */
342 rc = RTFileIoCtl(hFile, CDROM_SEND_PACKET, &CdromCommandReq, 0, &rcIoCtl);
343 if (RT_SUCCESS(rc) && rcIoCtl < 0)
344 rc = RTErrConvertFromErrno(-CdromCommandReq.stat);
345 RTFileClose(hFile);
346
347 if (RT_SUCCESS(rc))
348 {
349 if (pu8Type)
350 *pu8Type = u8Response[0] & 0x1f;
351 if (pchVendor)
352 RTStrPrintf(pchVendor, cchVendor, "%.8s",
353 &u8Response[8] /* vendor id string */);
354 if (pchModel)
355 RTStrPrintf(pchModel, cchModel, "%.16s",
356 &u8Response[16] /* product id string */);
357 LogRelFlowFunc(("returning success: type=%u, vendor=%.8s, product=%.16s\n",
358 u8Response[0] & 0x1f, &u8Response[8], &u8Response[16]));
359 return VINF_SUCCESS;
360 }
361 }
362 LogRelFlowFunc(("returning %Rrc\n", rc));
363 return rc;
364}
365
366
367/**
368 * Initialise the device strings (description and UDI) for a DVD drive based on
369 * vendor and model name strings.
370 * @param pcszVendor the vendor ID string
371 * @param pcszModel the product ID string
372 * @param pszDesc where to store the description string (optional)
373 * @param cchDesc the size of the buffer in @pszDesc
374 * @param pszUdi where to store the UDI string (optional)
375 * @param cchUdi the size of the buffer in @pszUdi
376 */
377/* static */
378void dvdCreateDeviceStrings(const char *pcszVendor, const char *pcszModel,
379 char *pszDesc, size_t cchDesc, char *pszUdi,
380 size_t cchUdi)
381{
382 AssertPtrReturnVoid(pcszVendor);
383 AssertPtrReturnVoid(pcszModel);
384 AssertPtrNullReturnVoid(pszDesc);
385 AssertReturnVoid(!pszDesc || cchDesc > 0);
386 AssertPtrNullReturnVoid(pszUdi);
387 AssertReturnVoid(!pszUdi || cchUdi > 0);
388 char szCleaned[128];
389 size_t cchVendor = strLenStripped(pcszVendor);
390 size_t cchModel = strLenStripped(pcszModel);
391
392 /* Create a cleaned version of the model string for the UDI string. */
393 for (unsigned i = 0; pcszModel[i] != '\0' && i < sizeof(szCleaned); ++i)
394 if ( (pcszModel[i] >= '0' && pcszModel[i] <= '9')
395 || (pcszModel[i] >= 'A' && pcszModel[i] <= 'z'))
396 szCleaned[i] = pcszModel[i];
397 else
398 szCleaned[i] = '_';
399 szCleaned[RT_MIN(cchModel, sizeof(szCleaned) - 1)] = '\0';
400
401 /* Construct the description string as "Vendor Product" */
402 if (pszDesc)
403 {
404 if (cchVendor > 0)
405 RTStrPrintf(pszDesc, cchDesc, "%.*s %s", cchVendor, pcszVendor,
406 cchModel > 0 ? pcszModel : "(unknown drive model)");
407 else
408 RTStrPrintf(pszDesc, cchDesc, "%s", pcszModel);
409 }
410 /* Construct the UDI string */
411 if (pszUdi)
412 {
413 if (cchModel > 0)
414 RTStrPrintf(pszUdi, cchUdi,
415 "/org/freedesktop/Hal/devices/storage_model_%s",
416 szCleaned);
417 else
418 pszUdi[0] = '\0';
419 }
420}
421
422
423/**
424 * Check whether a device node points to a valid device and create a UDI and
425 * a description for it, and store the device number, if it does.
426 * @returns true if the device is valid, false otherwise
427 * @param pcszNode the path to the device node
428 * @param isDVD are we looking for a DVD device (or a floppy device)?
429 * @param pDevice where to store the device node (optional)
430 * @param pszDesc where to store the device description (optional)
431 * @param cchDesc the size of the buffer in @a pszDesc
432 * @param pszUdi where to store the device UDI (optional)
433 * @param cchUdi the size of the buffer in @a pszUdi
434 */
435static bool devValidateDevice(const char *pcszNode, bool isDVD, dev_t *pDevice,
436 char *pszDesc, size_t cchDesc, char *pszUdi,
437 size_t cchUdi)
438{
439 AssertPtrReturn(pcszNode, false);
440 AssertPtrNullReturn(pDevice, false);
441 AssertPtrNullReturn(pszDesc, false);
442 AssertReturn(!pszDesc || cchDesc > 0, false);
443 AssertPtrNullReturn(pszUdi, false);
444 AssertReturn(!pszUdi || cchUdi > 0, false);
445 RTFSOBJINFO ObjInfo;
446 if (RT_FAILURE(RTPathQueryInfo(pcszNode, &ObjInfo, RTFSOBJATTRADD_UNIX)))
447 return false;
448 if (!RTFS_IS_DEV_BLOCK(ObjInfo.Attr.fMode))
449 return false;
450 if (pDevice)
451 *pDevice = ObjInfo.Attr.u.Unix.Device;
452 if (isDVD)
453 {
454 char szVendor[128], szModel[128];
455 uint8_t u8Type;
456 if (!isCdromDevNum(ObjInfo.Attr.u.Unix.Device))
457 return false;
458 if (RT_FAILURE(cdromDoInquiry(pcszNode, &u8Type,
459 szVendor, sizeof(szVendor),
460 szModel, sizeof(szModel))))
461 return false;
462 if (u8Type != TYPE_ROM)
463 return false;
464 dvdCreateDeviceStrings(szVendor, szModel, pszDesc, cchDesc,
465 pszUdi, cchUdi);
466 }
467 else
468 {
469 /* Floppies on Linux are legacy devices with hardcoded majors and
470 * minors */
471 unsigned Number;
472 floppy_drive_name szName;
473 if (major(ObjInfo.Attr.u.Unix.Device) != FLOPPY_MAJOR)
474 return false;
475 switch (minor(ObjInfo.Attr.u.Unix.Device))
476 {
477 case 0: case 1: case 2: case 3:
478 Number = minor(ObjInfo.Attr.u.Unix.Device);
479 break;
480 case 128: case 129: case 130: case 131:
481 Number = minor(ObjInfo.Attr.u.Unix.Device) - 128 + 4;
482 break;
483 default:
484 return false;
485 }
486 if (!floppyGetName(pcszNode, Number, szName))
487 return false;
488 floppyCreateDeviceStrings(szName, Number, pszDesc, cchDesc, pszUdi,
489 cchUdi);
490 }
491 return true;
492}
493
494
495int VBoxMainDriveInfo::updateDVDs ()
496{
497 LogFlowThisFunc(("entered\n"));
498 int rc = VINF_SUCCESS;
499 bool success = false; /* Have we succeeded in finding anything yet? */
500 try
501 {
502 mDVDList.clear ();
503 /* Always allow the user to override our auto-detection using an
504 * environment variable. */
505 if (RT_SUCCESS(rc) && (!success || testing()))
506 rc = getDriveInfoFromEnv ("VBOX_CDROM", &mDVDList, true /* isDVD */,
507 &success);
508 setNoProbe(false);
509 if (RT_SUCCESS(rc) && (!success | testing()))
510 rc = getDriveInfoFromSysfs(&mDVDList, true /* isDVD */, &success);
511 if (RT_SUCCESS(rc) && testing())
512 {
513 setNoProbe(true);
514 rc = getDriveInfoFromSysfs(&mDVDList, true /* isDVD */, &success);
515 }
516 /* Walk through the /dev subtree if nothing else has helped. */
517 if (RT_SUCCESS(rc) && (!success | testing()))
518 rc = getDriveInfoFromDev(&mDVDList, true /* isDVD */, &success);
519 }
520 catch(std::bad_alloc &e)
521 {
522 rc = VERR_NO_MEMORY;
523 }
524 LogFlowThisFunc(("rc=%Rrc\n", rc));
525 return rc;
526}
527
528int VBoxMainDriveInfo::updateFloppies ()
529{
530 LogFlowThisFunc(("entered\n"));
531 int rc = VINF_SUCCESS;
532 bool success = false; /* Have we succeeded in finding anything yet? */
533 try
534 {
535 mFloppyList.clear ();
536 if (RT_SUCCESS(rc) && (!success || testing()))
537 rc = getDriveInfoFromEnv("VBOX_FLOPPY", &mFloppyList,
538 false /* isDVD */, &success);
539 setNoProbe(false);
540 if ( RT_SUCCESS(rc) && (!success || testing()))
541 rc = getDriveInfoFromSysfs(&mFloppyList, false /* isDVD */,
542 &success);
543 if (RT_SUCCESS(rc) && testing())
544 {
545 setNoProbe(true);
546 rc = getDriveInfoFromSysfs(&mFloppyList, false /* isDVD */, &success);
547 }
548 /* Walk through the /dev subtree if nothing else has helped. */
549 if ( RT_SUCCESS(rc) && (!success || testing()))
550 rc = getDriveInfoFromDev(&mFloppyList, false /* isDVD */,
551 &success);
552 }
553 catch(std::bad_alloc &e)
554 {
555 rc = VERR_NO_MEMORY;
556 }
557 LogFlowThisFunc(("rc=%Rrc\n", rc));
558 return rc;
559}
560
561
562/**
563 * Extract the names of drives from an environment variable and add them to a
564 * list if they are valid.
565 * @returns iprt status code
566 * @param pcszVar the name of the environment variable. The variable
567 * value should be a list of device node names, separated
568 * by ':' characters.
569 * @param pList the list to append the drives found to
570 * @param isDVD are we looking for DVD drives or for floppies?
571 * @param pfSuccess this will be set to true if we found at least one drive
572 * and to false otherwise. Optional.
573 */
574/* static */
575int getDriveInfoFromEnv(const char *pcszVar, DriveInfoList *pList,
576 bool isDVD, bool *pfSuccess)
577{
578 AssertPtrReturn(pcszVar, VERR_INVALID_POINTER);
579 AssertPtrReturn(pList, VERR_INVALID_POINTER);
580 AssertPtrNullReturn(pfSuccess, VERR_INVALID_POINTER);
581 LogFlowFunc(("pcszVar=%s, pList=%p, isDVD=%d, pfSuccess=%p\n", pcszVar,
582 pList, isDVD, pfSuccess));
583 int rc = VINF_SUCCESS;
584 bool success = false;
585 char *pszFreeMe = RTEnvDupEx(RTENV_DEFAULT, pcszVar);
586
587 try
588 {
589 const char *pcszCurrent = pszFreeMe;
590 while (pcszCurrent && *pcszCurrent != '\0')
591 {
592 const char *pcszNext = strchr(pcszCurrent, ':');
593 char szPath[RTPATH_MAX], szReal[RTPATH_MAX];
594 char szDesc[256], szUdi[256];
595 if (pcszNext)
596 RTStrPrintf(szPath, sizeof(szPath), "%.*s",
597 pcszNext - pcszCurrent - 1, pcszCurrent);
598 else
599 RTStrPrintf(szPath, sizeof(szPath), "%s", pcszCurrent);
600 if ( RT_SUCCESS(RTPathReal(szPath, szReal, sizeof(szReal)))
601 && devValidateDevice(szReal, isDVD, NULL, szDesc,
602 sizeof(szDesc), szUdi, sizeof(szUdi)))
603 {
604 pList->push_back(DriveInfo(szReal, szUdi, szDesc));
605 success = true;
606 }
607 pcszCurrent = pcszNext ? pcszNext + 1 : NULL;
608 }
609 if (pfSuccess != NULL)
610 *pfSuccess = success;
611 }
612 catch(std::bad_alloc &e)
613 {
614 rc = VERR_NO_MEMORY;
615 }
616 RTStrFree(pszFreeMe);
617 LogFlowFunc(("rc=%Rrc, success=%d\n", rc, success));
618 return rc;
619}
620
621
622class sysfsBlockDev
623{
624public:
625 sysfsBlockDev(const char *pcszName, bool wantDVD)
626 : mpcszName(pcszName), mwantDVD(wantDVD), misConsistent(true),
627 misValid(false)
628 {
629 if (findDeviceNode())
630 {
631 if (mwantDVD)
632 validateAndInitForDVD();
633 else
634 validateAndInitForFloppy();
635 }
636 }
637private:
638 /** The name of the subdirectory of /sys/block for this device */
639 const char *mpcszName;
640 /** Are we looking for a floppy or a DVD device? */
641 bool mwantDVD;
642 /** The device node for the device */
643 char mszNode[RTPATH_MAX];
644 /** Does the sysfs entry look like we expect it too? This is a canary
645 * for future sysfs ABI changes. */
646 bool misConsistent;
647 /** Is this entry a valid specimen of what we are looking for? */
648 bool misValid;
649 /** Human readible drive description string */
650 char mszDesc[256];
651 /** Unique identifier for the drive. Should be identical to hal's UDI for
652 * the device. May not be unique for two identical drives. */
653 char mszUdi[256];
654private:
655 /* Private methods */
656
657 /**
658 * Fill in the device node member based on the /sys/block subdirectory.
659 * @returns boolean success value
660 */
661 bool findDeviceNode()
662 {
663 dev_t dev = RTLinuxSysFsReadDevNumFile("block/%s/dev", mpcszName);
664 if (dev == 0)
665 {
666 misConsistent = false;
667 return false;
668 }
669 if (RTLinuxFindDevicePath(dev, RTFS_TYPE_DEV_BLOCK, mszNode,
670 sizeof(mszNode), "%s", mpcszName) < 0)
671 return false;
672 return true;
673 }
674
675 /** Check whether the sysfs block entry is valid for a DVD device and
676 * initialise the string data members for the object. We try to get all
677 * the information we need from sysfs if possible, to avoid unnecessarily
678 * poking the device, and if that fails we fall back to an SCSI INQUIRY
679 * command. */
680 void validateAndInitForDVD()
681 {
682 char szVendor[128], szModel[128];
683 ssize_t cchVendor, cchModel;
684 int64_t type = RTLinuxSysFsReadIntFile(10, "block/%s/device/type",
685 mpcszName);
686 if (type >= 0 && type != TYPE_ROM)
687 return;
688 if (type == TYPE_ROM)
689 {
690 cchVendor = RTLinuxSysFsReadStrFile(szVendor, sizeof(szVendor),
691 "block/%s/device/vendor",
692 mpcszName);
693 if (cchVendor >= 0)
694 {
695 cchModel = RTLinuxSysFsReadStrFile(szModel, sizeof(szModel),
696 "block/%s/device/model",
697 mpcszName);
698 if (cchModel >= 0)
699 {
700 misValid = true;
701 dvdCreateDeviceStrings(szVendor, szModel,
702 mszDesc, sizeof(mszDesc),
703 mszUdi, sizeof(mszUdi));
704 return;
705 }
706 }
707 }
708 if (!noProbe())
709 probeAndInitForDVD();
710 }
711
712 /** Try to find out whether a device is a DVD drive by sending it an
713 * SCSI INQUIRY command. If it is, initialise the string and validity
714 * data members for the object based on the returned data.
715 */
716 void probeAndInitForDVD()
717 {
718 AssertReturnVoid(mszNode[0] != '\0');
719 uint8_t u8Type = 0;
720 char szVendor[128] = "";
721 char szModel[128] = "";
722 int rc = cdromDoInquiry(mszNode, &u8Type, szVendor,
723 sizeof(szVendor), szModel,
724 sizeof(szModel));
725 if (RT_SUCCESS(rc) && (u8Type == TYPE_ROM))
726 {
727 misValid = true;
728 dvdCreateDeviceStrings(szVendor, szModel, mszDesc, sizeof(mszDesc),
729 mszUdi, sizeof(mszUdi));
730 }
731 }
732
733 /** Check whether the sysfs block entry is valid for a floppy device and
734 * initialise the string data members for the object. Since we only
735 * support floppies using the basic "floppy" driver, we check the driver
736 * using the entry name and a driver-specific ioctl. */
737 void validateAndInitForFloppy()
738 {
739 bool haveName = false;
740 floppy_drive_name szName;
741 char szDriver[8];
742 if ( mpcszName[0] != 'f'
743 || mpcszName[1] != 'd'
744 || mpcszName[2] < '0'
745 || mpcszName[2] > '7'
746 || mpcszName[3] != '\0')
747 return;
748 if (!noProbe())
749 haveName = floppyGetName(mszNode, mpcszName[2] - '0', szName);
750 if (RTLinuxSysFsGetLinkDest(szDriver, sizeof(szDriver), "block/%s/%s",
751 mpcszName, "device/driver") >= 0)
752 {
753 if (RTStrCmp(szDriver, "floppy"))
754 return;
755 }
756 else if (!haveName)
757 return;
758 floppyCreateDeviceStrings(haveName ? szName : NULL,
759 mpcszName[2] - '0', mszDesc,
760 sizeof(mszDesc), mszUdi, sizeof(mszUdi));
761 misValid = true;
762 }
763
764public:
765 bool isConsistent()
766 {
767 return misConsistent;
768 }
769 bool isValid()
770 {
771 return misValid;
772 }
773 const char *getDesc()
774 {
775 return mszDesc;
776 }
777 const char *getUdi()
778 {
779 return mszUdi;
780 }
781 const char *getNode()
782 {
783 return mszNode;
784 }
785};
786
787/**
788 * Helper function to query the sysfs subsystem for information about DVD
789 * drives attached to the system.
790 * @returns iprt status code
791 * @param pList where to add information about the drives detected
792 * @param isDVD are we looking for DVDs or floppies?
793 * @param pfSuccess Did we find anything?
794 *
795 * @returns IPRT status code
796 */
797/* static */
798int getDriveInfoFromSysfs(DriveInfoList *pList, bool isDVD, bool *pfSuccess)
799{
800 AssertPtrReturn(pList, VERR_INVALID_POINTER);
801 AssertPtrNullReturn(pfSuccess, VERR_INVALID_POINTER); /* Valid or Null */
802 LogFlowFunc (("pList=%p, isDVD=%u, pfSuccess=%p\n",
803 pList, (unsigned) isDVD, pfSuccess));
804 PRTDIR pDir = NULL;
805 int rc;
806 bool fSuccess = false;
807 unsigned cFound = 0;
808
809 if (!RTPathExists("/sys"))
810 return VINF_SUCCESS;
811 rc = RTDirOpen(&pDir, "/sys/block");
812 /* This might mean that sysfs semantics have changed */
813 AssertReturn(rc != VERR_FILE_NOT_FOUND, VINF_SUCCESS);
814 fSuccess = true;
815 if (RT_SUCCESS(rc))
816 for (;;)
817 {
818 RTDIRENTRY entry;
819 rc = RTDirRead(pDir, &entry, NULL);
820 Assert(rc != VERR_BUFFER_OVERFLOW); /* Should never happen... */
821 if (RT_FAILURE(rc)) /* Including overflow and no more files */
822 break;
823 if (entry.szName[0] == '.')
824 continue;
825 sysfsBlockDev dev(entry.szName, isDVD);
826 /* This might mean that sysfs semantics have changed */
827 AssertBreakStmt(dev.isConsistent(), fSuccess = false);
828 if (!dev.isValid())
829 continue;
830 try
831 {
832 pList->push_back(DriveInfo(dev.getNode(), dev.getUdi(),
833 dev.getDesc()));
834 }
835 catch(std::bad_alloc &e)
836 {
837 rc = VERR_NO_MEMORY;
838 break;
839 }
840 ++cFound;
841 }
842 RTDirClose(pDir);
843 if (rc == VERR_NO_MORE_FILES)
844 rc = VINF_SUCCESS;
845 if (RT_FAILURE(rc))
846 /* Clean up again */
847 for (unsigned i = 0; i < cFound; ++i)
848 pList->pop_back();
849 if (pfSuccess)
850 *pfSuccess = fSuccess;
851 LogFlow (("rc=%Rrc, fSuccess=%u\n", rc, (unsigned) fSuccess));
852 return rc;
853}
854
855
856/** Structure for holding information about a drive we have found */
857struct deviceNodeInfo
858{
859 /** The device number */
860 dev_t Device;
861 /** The device node path */
862 char szPath[RTPATH_MAX];
863 /** The device description */
864 char szDesc[256];
865 /** The device UDI */
866 char szUdi[256];
867};
868
869/** The maximum number of devices we will search for. */
870enum { MAX_DEVICE_NODES = 8 };
871/** An array of MAX_DEVICE_NODES devices */
872typedef struct deviceNodeInfo deviceNodeArray[MAX_DEVICE_NODES];
873
874/**
875 * Recursive worker function to walk the /dev tree looking for DVD or floppy
876 * devices.
877 * @returns true if we have already found MAX_DEVICE_NODES devices, false
878 * otherwise
879 * @param pszPath the path to start recursing. The function can modify
880 * this string at and after the terminating zero
881 * @param cchPath the size of the buffer (not the string!) in @a pszPath
882 * @param aDevices where to fill in information about devices that we have
883 * found
884 * @param wantDVD are we looking for DVD devices (or floppies)?
885 */
886static bool devFindDeviceRecursive(char *pszPath, size_t cchPath,
887 deviceNodeArray aDevices, bool wantDVD)
888{
889 /*
890 * Check assumptions made by the code below.
891 */
892 size_t const cchBasePath = strlen(pszPath);
893 AssertReturn(cchBasePath < RTPATH_MAX - 10U, false);
894 AssertReturn(pszPath[cchBasePath - 1] != '/', false);
895
896 PRTDIR pDir;
897 if (RT_FAILURE(RTDirOpen(&pDir, pszPath)))
898 return false;
899 for (;;)
900 {
901 RTDIRENTRY Entry;
902 RTFSOBJINFO ObjInfo;
903 int rc = RTDirRead(pDir, &Entry, NULL);
904 if (RT_FAILURE(rc))
905 break;
906 if (Entry.enmType == RTDIRENTRYTYPE_UNKNOWN)
907 {
908 if (RT_FAILURE(RTPathQueryInfo(pszPath, &ObjInfo,
909 RTFSOBJATTRADD_UNIX)))
910 continue;
911 if (RTFS_IS_SYMLINK(ObjInfo.Attr.fMode))
912 continue;
913 }
914
915 if (Entry.enmType == RTDIRENTRYTYPE_SYMLINK)
916 continue;
917 pszPath[cchBasePath] = '\0';
918 if (RT_FAILURE(RTPathAppend(pszPath, cchPath, Entry.szName)))
919 break;
920
921 /* Do the matching. */
922 dev_t DevNode;
923 char szDesc[256], szUdi[256];
924 if (!devValidateDevice(pszPath, wantDVD, &DevNode, szDesc,
925 sizeof(szDesc), szUdi, sizeof(szUdi)))
926 continue;
927 unsigned i;
928 for (i = 0; i < MAX_DEVICE_NODES; ++i)
929 if (!aDevices[i].Device || (aDevices[i].Device == DevNode))
930 break;
931 AssertBreak(i < MAX_DEVICE_NODES);
932 if (aDevices[i].Device)
933 continue;
934 aDevices[i].Device = DevNode;
935 RTStrPrintf(aDevices[i].szPath, sizeof(aDevices[i].szPath),
936 "%s", pszPath);
937 AssertCompile(sizeof(aDevices[i].szDesc) == sizeof(szDesc));
938 strcpy(aDevices[i].szDesc, szDesc);
939 AssertCompile(sizeof(aDevices[i].szUdi) == sizeof(szUdi));
940 strcpy(aDevices[i].szUdi, szUdi);
941 if (i == MAX_DEVICE_NODES - 1)
942 break;
943 continue;
944
945 /* Recurse into subdirectories. */
946 if ( (Entry.enmType == RTDIRENTRYTYPE_UNKNOWN)
947 && !RTFS_IS_DIRECTORY(ObjInfo.Attr.fMode))
948 continue;
949 if (Entry.enmType != RTDIRENTRYTYPE_DIRECTORY)
950 continue;
951 if (Entry.szName[0] == '.')
952 continue;
953
954 if (devFindDeviceRecursive(pszPath, cchPath, aDevices, wantDVD))
955 break;
956 }
957 RTDirClose(pDir);
958 return aDevices[MAX_DEVICE_NODES - 1].Device ? true : false;
959}
960
961
962/**
963 * Recursively walk through the /dev tree and add any DVD or floppy drives we
964 * find and can access to our list. (If we can't access them we can't check
965 * whether or not they are really DVD or floppy drives).
966 * @note this is rather slow (a couple of seconds) for DVD probing on
967 * systems with a static /dev tree, as the current code tries to open
968 * any device node with a major/minor combination that could belong to
969 * a CD-ROM device, and opening a non-existent device can take a non.
970 * negligeable time on Linux. If it is ever necessary to improve this
971 * (static /dev trees are no longer very fashionable these days, and
972 * sysfs looks like it will be with us for a while), we could further
973 * reduce the number of device nodes we open by checking whether the
974 * driver is actually loaded in /proc/devices, and by counting the
975 * of currently attached SCSI CD-ROM devices in /proc/scsi/scsi (yes,
976 * there is a race, but it is probably not important for us).
977 * @returns iprt status code
978 * @param pList the list to append the drives found to
979 * @param isDVD are we looking for DVD drives or for floppies?
980 * @param pfSuccess this will be set to true if we found at least one drive
981 * and to false otherwise. Optional.
982 */
983/* static */
984int getDriveInfoFromDev(DriveInfoList *pList, bool isDVD, bool *pfSuccess)
985{
986 AssertPtrReturn(pList, VERR_INVALID_POINTER);
987 AssertPtrNullReturn(pfSuccess, VERR_INVALID_POINTER);
988 LogFlowFunc(("pList=%p, isDVD=%d, pfSuccess=%p\n", pList, isDVD,
989 pfSuccess));
990 int rc = VINF_SUCCESS;
991 bool success = false;
992
993 char szPath[RTPATH_MAX] = "/dev";
994 deviceNodeArray aDevices;
995 RT_ZERO(aDevices);
996 devFindDeviceRecursive(szPath, sizeof(szPath), aDevices, isDVD);
997 try
998 {
999 for (unsigned i = 0; i < MAX_DEVICE_NODES; ++i)
1000 {
1001 if (aDevices[i].Device)
1002 {
1003 pList->push_back(DriveInfo(aDevices[i].szPath,
1004 aDevices[i].szUdi, aDevices[i].szDesc));
1005 success = true;
1006 }
1007 }
1008 if (pfSuccess != NULL)
1009 *pfSuccess = success;
1010 }
1011 catch(std::bad_alloc &e)
1012 {
1013 rc = VERR_NO_MEMORY;
1014 }
1015 LogFlowFunc (("rc=%Rrc, success=%d\n", rc, success));
1016 return rc;
1017}
1018
1019
1020int VBoxMainUSBDeviceInfo::UpdateDevices ()
1021{
1022 LogFlowThisFunc(("entered\n"));
1023 int rc = VINF_SUCCESS;
1024 bool success = false; /* Have we succeeded in finding anything yet? */
1025 try
1026 {
1027 mDeviceList.clear();
1028#ifdef VBOX_USB_WITH_SYSFS
1029# ifdef VBOX_USB_WITH_DBUS
1030 bool halSuccess = false;
1031 if ( RT_SUCCESS(rc)
1032 && RT_SUCCESS(RTDBusLoadLib())
1033 && (!success || testing()))
1034 rc = getUSBDeviceInfoFromHal(&mDeviceList, &halSuccess);
1035 /* Try the old API if the new one *succeeded* as only one of them will
1036 * pick up devices anyway. */
1037 if (RT_SUCCESS(rc) && halSuccess && (!success || testing()))
1038 rc = getOldUSBDeviceInfoFromHal(&mDeviceList, &halSuccess);
1039 if (!success)
1040 success = halSuccess;
1041# endif /* VBOX_USB_WITH_DBUS */
1042# ifdef VBOX_USB_WITH_FAM
1043 if ( RT_SUCCESS(rc)
1044 && (!success || testing()))
1045 rc = getUSBDeviceInfoFromSysfs(&mDeviceList, &success);
1046# endif
1047#else /* !VBOX_USB_WITH_SYSFS */
1048 NOREF(success);
1049#endif /* !VBOX_USB_WITH_SYSFS */
1050 }
1051 catch(std::bad_alloc &e)
1052 {
1053 rc = VERR_NO_MEMORY;
1054 }
1055 LogFlowThisFunc(("rc=%Rrc\n", rc));
1056 return rc;
1057}
1058
1059#if defined VBOX_USB_WITH_SYSFS && defined VBOX_USB_WITH_DBUS
1060class hotplugDBusImpl : public VBoxMainHotplugWaiterImpl
1061{
1062 /** The connection to DBus */
1063 RTMemAutoPtr <DBusConnection, VBoxHalShutdownPrivate> mConnection;
1064 /** Semaphore which is set when a device is hotplugged and reset when
1065 * it is read. */
1066 volatile bool mTriggered;
1067 /** A flag to say that we wish to interrupt the current wait. */
1068 volatile bool mInterrupt;
1069
1070public:
1071 /** Test whether this implementation can be used on the current system */
1072 static bool HalAvailable(void)
1073 {
1074 RTMemAutoPtr<DBusConnection, VBoxHalShutdown> dbusConnection;
1075
1076 /* Try to open a test connection to hal */
1077 if (RT_SUCCESS(RTDBusLoadLib()) && RT_SUCCESS(halInit (&dbusConnection)))
1078 return !!dbusConnection;
1079 return false;
1080 }
1081
1082 /** Constructor */
1083 hotplugDBusImpl (void);
1084 virtual ~hotplugDBusImpl (void);
1085 /** @copydoc VBoxMainHotplugWaiter::Wait */
1086 virtual int Wait (RTMSINTERVAL cMillies);
1087 /** @copydoc VBoxMainHotplugWaiter::Interrupt */
1088 virtual void Interrupt (void);
1089};
1090
1091/* This constructor sets up a private connection to the DBus daemon, connects
1092 * to the hal service and installs a filter which sets the mTriggered flag in
1093 * the Context structure when a device (not necessarily USB) is added or
1094 * removed. */
1095hotplugDBusImpl::hotplugDBusImpl (void) : mTriggered(false), mInterrupt(false)
1096{
1097 int rc = VINF_SUCCESS;
1098
1099 if (RT_SUCCESS(RTDBusLoadLib()))
1100 {
1101 for (unsigned i = 0; RT_SUCCESS(rc) && i < 5 && !mConnection; ++i)
1102 {
1103 rc = halInitPrivate (&mConnection);
1104 }
1105 if (!mConnection)
1106 rc = VERR_NOT_SUPPORTED;
1107 DBusMessage *pMessage;
1108 while ( RT_SUCCESS(rc)
1109 && (pMessage = dbus_connection_pop_message (mConnection.get())) != NULL)
1110 dbus_message_unref (pMessage); /* empty the message queue. */
1111 if ( RT_SUCCESS(rc)
1112 && !dbus_connection_add_filter (mConnection.get(),
1113 dbusFilterFunction,
1114 (void *) &mTriggered, NULL))
1115 rc = VERR_NO_MEMORY;
1116 if (RT_FAILURE(rc))
1117 mConnection.reset();
1118 }
1119}
1120
1121/* Destructor */
1122hotplugDBusImpl::~hotplugDBusImpl ()
1123{
1124 if (!!mConnection)
1125 dbus_connection_remove_filter (mConnection.get(), dbusFilterFunction,
1126 (void *) &mTriggered);
1127}
1128
1129/* Currently this is implemented using a timed out wait on our private DBus
1130 * connection. Because the connection is private we don't have to worry about
1131 * blocking other users. */
1132int hotplugDBusImpl::Wait(RTMSINTERVAL cMillies)
1133{
1134 int rc = VINF_SUCCESS;
1135 if (!mConnection)
1136 rc = VERR_NOT_SUPPORTED;
1137 bool connected = true;
1138 mTriggered = false;
1139 mInterrupt = false;
1140 unsigned cRealMillies;
1141 if (cMillies != RT_INDEFINITE_WAIT)
1142 cRealMillies = cMillies;
1143 else
1144 cRealMillies = DBUS_POLL_TIMEOUT;
1145 while ( RT_SUCCESS(rc) && connected && !mTriggered
1146 && !mInterrupt)
1147 {
1148 connected = dbus_connection_read_write_dispatch (mConnection.get(),
1149 cRealMillies);
1150 if (mInterrupt)
1151 LogFlowFunc(("wait loop interrupted\n"));
1152 if (cMillies != RT_INDEFINITE_WAIT)
1153 mInterrupt = true;
1154 }
1155 if (!connected)
1156 rc = VERR_TRY_AGAIN;
1157 return rc;
1158}
1159
1160/* Set a flag to tell the Wait not to resume next time it times out. */
1161void hotplugDBusImpl::Interrupt()
1162{
1163 LogFlowFunc(("\n"));
1164 mInterrupt = true;
1165}
1166#endif /* VBOX_USB_WITH_SYSFS && VBOX_USB_WITH_DBUS */
1167
1168class hotplugNullImpl : public VBoxMainHotplugWaiterImpl
1169{
1170public:
1171 hotplugNullImpl (void) {}
1172 virtual ~hotplugNullImpl (void) {}
1173 /** @copydoc VBoxMainHotplugWaiter::Wait */
1174 virtual int Wait (RTMSINTERVAL)
1175 {
1176 return VERR_NOT_SUPPORTED;
1177 }
1178 /** @copydoc VBoxMainHotplugWaiter::Interrupt */
1179 virtual void Interrupt (void) {}
1180};
1181
1182#ifdef VBOX_USB_WITH_SYSFS
1183# ifdef VBOX_USB_WITH_FAM
1184
1185# define SYSFS_USB_DEVICE_PATH "/dev/bus/usb"
1186# define SYSFS_WAKEUP_STRING "Wake up!"
1187
1188class hotplugSysfsFAMImpl : public VBoxMainHotplugWaiterImpl
1189{
1190 /** Pipe used to interrupt wait(), the read end. */
1191 RTPIPE mhWakeupPipeR;
1192 /** Pipe used to interrupt wait(), the write end. */
1193 RTPIPE mhWakeupPipeW;
1194 /** Our connection to FAM for polling for changes on sysfs. */
1195 FAMConnection mFAMConnection;
1196 /** Has our connection been initialised? */
1197 bool mfFAMInitialised;
1198 /** The iprt native handle of the FAM fd socket. */
1199 RTSOCKET mhFAMFD;
1200 /** Poll set containing the FAM socket and the termination pipe */
1201 RTPOLLSET mhPollSet;
1202 /** Flag to mark that the Wait() method is currently being called, and to
1203 * ensure that it isn't called multiple times in parallel. */
1204 uint32_t mfWaiting;
1205 /** iprt result code from object initialisation. Should be AssertReturn-ed
1206 * on at the start of all methods. I went this way because I didn't want
1207 * to deal with exceptions. */
1208 int mStatus;
1209 /** ID values associates with the wakeup pipe and the FAM socket for polling
1210 */
1211 enum
1212 {
1213 RPIPE_ID = 1,
1214 FAMFD_ID
1215 };
1216
1217 /** Initialise the connection to the FAM daemon, allocating all required
1218 * resources.
1219 * @returns iprt status code
1220 */
1221 int initConnection(void);
1222
1223 /** Clean up the connection to the FAM daemon, freeing any allocated
1224 * resources and gracefully skipping over any which have not yet been
1225 * allocated or already cleaned up.
1226 * @returns iprt status code
1227 */
1228 void termConnection(void);
1229
1230 /** Clean up any resources in use, gracefully skipping over any which have
1231 * not yet been allocated or already cleaned up. Intended to be called
1232 * from the destructor or after a failed initialisation. */
1233 void term(void);
1234
1235 /** Make sure that the object is correctly initialised and re-initialises
1236 * it if not, and if the maximum number of connection attempts has not been
1237 * reached.
1238 * @returns iprt status value
1239 * @returns VERR_TRY_AGAIN if we are giving up on this attempt but may
1240 * still succeed on future attempts
1241 */
1242 int checkConnection(void);
1243
1244 /** Quick failure test of the checkConnection() function. */
1245 void testCheckConnection(void);
1246
1247 /** Open our connection to FAM and convert the status to iprt.
1248 * @todo really convert the status
1249 */
1250 int openFAM(void)
1251 {
1252 if (FAMOpen(&mFAMConnection) < 0)
1253 return VERR_FAM_OPEN_FAILED;
1254 mfFAMInitialised = true;
1255 return VINF_SUCCESS;
1256 }
1257
1258 /** Monitor a file through the FAM connection. */
1259 int monitorDirectoryFAM(const char *pszName)
1260 {
1261 AssertReturn(mfFAMInitialised, VERR_WRONG_ORDER);
1262 FAMRequest dummyReq;
1263 if (FAMMonitorDirectory(&mFAMConnection, pszName, &dummyReq, NULL) < 0)
1264 return VERR_FAM_MONITOR_DIRECTORY_FAILED;
1265 return VINF_SUCCESS;
1266 }
1267
1268 /** Quick failure test of the monitor function - we temporarily invalidate
1269 * the connection FD to trigger an error path. */
1270 void testMonitorDirectoryFAM(void)
1271 {
1272 int oldFD = FAMCONNECTION_GETFD(&mFAMConnection);
1273 FAMCONNECTION_GETFD(&mFAMConnection) = -1;
1274 Assert(monitorDirectoryFAM(NULL) == VERR_FAM_MONITOR_DIRECTORY_FAILED);
1275 FAMCONNECTION_GETFD(&mFAMConnection) = oldFD;
1276 }
1277
1278 int nextEventFAM(FAMEvent *pEv)
1279 {
1280 if (FAMNextEvent(&mFAMConnection, pEv) == 1)
1281 return VINF_SUCCESS;
1282 mStatus = VERR_FAM_CONNECTION_LOST;
1283 return VERR_TRY_AGAIN;
1284 }
1285
1286 /** Quick failure test of the nextevent function. */
1287 void testNextEventFAM(void)
1288 {
1289 int oldStatus = mStatus;
1290 mStatus = VINF_SUCCESS;
1291 Assert(nextEventFAM(NULL) == VERR_TRY_AGAIN);
1292 mStatus = oldStatus;
1293 }
1294
1295 /** Close our connection to FAM. We ignore errors as there is no
1296 * documentation as to what they mean, and the only error which might
1297 * interest us (EINTR) should be (but isn't) handled inside the library. */
1298 void closeFAM(void)
1299 {
1300 if (mfFAMInitialised)
1301 FAMClose(&mFAMConnection);
1302 mfFAMInitialised = false;
1303 }
1304
1305 /** Read the wakeup string from the wakeup pipe */
1306 int drainWakeupPipe(void);
1307public:
1308 hotplugSysfsFAMImpl(void);
1309 virtual ~hotplugSysfsFAMImpl(void)
1310 {
1311 term();
1312#ifdef DEBUG
1313 /** The first call to term should mark all resources as freed, so this
1314 * should be a semantic no-op. */
1315 term();
1316#endif
1317 }
1318 /** Is sysfs available on this system? If so we expect that this
1319 * implementation will be usable. */
1320 static bool SysfsAvailable(void)
1321 {
1322 return RTDirExists(SYSFS_USB_DEVICE_PATH);
1323 }
1324 /** @copydoc VBoxMainHotplugWaiter::Wait */
1325 virtual int Wait(RTMSINTERVAL);
1326 /** @copydoc VBoxMainHotplugWaiter::Interrupt */
1327 virtual void Interrupt(void);
1328};
1329
1330hotplugSysfsFAMImpl::hotplugSysfsFAMImpl(void) :
1331 mhWakeupPipeR(NIL_RTPIPE), mhWakeupPipeW(NIL_RTPIPE),
1332 mfFAMInitialised(false), mhFAMFD(NIL_RTSOCKET), mhPollSet(NIL_RTPOLLSET),
1333 mfWaiting(0), mStatus(VERR_WRONG_ORDER)
1334{
1335# ifdef DEBUG
1336 /* Excercise the code path (term() on a not-fully-initialised object) as
1337 * well as we can. On an uninitialised object this method is a sematic
1338 * no-op. */
1339 term();
1340 /* For now this probing method should only be used if nothing else is
1341 * available */
1342 if (!testing())
1343 {
1344# ifndef VBOX_WITH_SYSFS_BY_DEFAULT
1345 Assert(!RTFileExists("/proc/bus/usb/devices"));
1346# endif
1347# ifdef VBOX_USB_WITH_DBUS
1348 Assert(!hotplugDBusImpl::HalAvailable());
1349# endif
1350 }
1351# endif
1352 int rc;
1353 do {
1354 if (RT_FAILURE(rc = RTPipeCreate(&mhWakeupPipeR, &mhWakeupPipeW, 0)))
1355 break;
1356 if (RT_FAILURE(rc = initConnection()))
1357 break;
1358# ifdef DEBUG
1359 /** Other tests */
1360 testMonitorDirectoryFAM();
1361 testNextEventFAM();
1362 testCheckConnection();
1363# endif
1364 } while(0);
1365 mStatus = rc;
1366 if (RT_FAILURE(rc))
1367 term();
1368}
1369
1370int hotplugSysfsFAMImpl::initConnection(void)
1371{
1372 int rc;
1373
1374 if (RT_FAILURE(rc = openFAM()))
1375 return rc;
1376 if (RT_FAILURE(rc = RTSocketFromNative
1377 (&mhFAMFD, FAMCONNECTION_GETFD(&mFAMConnection))))
1378 return rc;
1379 if (RT_FAILURE(rc = monitorDirectoryFAM(SYSFS_USB_DEVICE_PATH)))
1380 return rc;
1381 if (RT_FAILURE(rc = RTPollSetCreate(&mhPollSet)))
1382 return rc;
1383 if (RT_FAILURE(rc = RTPollSetAddSocket
1384 (mhPollSet, mhFAMFD, RTPOLL_EVT_READ, FAMFD_ID)))
1385 return rc;
1386 AssertReturn(mhWakeupPipeR != NIL_RTPIPE, VERR_WRONG_ORDER);
1387 if (RT_FAILURE(rc = RTPollSetAddPipe(mhPollSet, mhWakeupPipeR,
1388 RTPOLL_EVT_READ, RPIPE_ID)))
1389 return rc;
1390 return VINF_SUCCESS;
1391}
1392
1393void hotplugSysfsFAMImpl::termConnection(void)
1394{
1395 closeFAM();
1396 mhFAMFD = NIL_RTSOCKET;
1397 RTPollSetDestroy(mhPollSet);
1398 mhPollSet = NIL_RTPOLLSET;
1399}
1400
1401int hotplugSysfsFAMImpl::checkConnection(void)
1402{
1403 /** We should only be called from within Wait(). */
1404 AssertReturn(mfWaiting, VERR_WRONG_ORDER);
1405 if (mStatus == VERR_FAM_CONNECTION_LOST)
1406 {
1407 termConnection();
1408 mStatus = initConnection();
1409 }
1410 return mStatus;
1411}
1412
1413void hotplugSysfsFAMImpl::testCheckConnection(void)
1414{
1415 int oldStatus = mStatus;
1416 mStatus = VERR_UNRESOLVED_ERROR;
1417
1418 bool fEntered = ASMAtomicCmpXchgU32(&mfWaiting, 1, 0);
1419 AssertReturnVoid(fEntered);
1420 Assert(checkConnection() == VERR_UNRESOLVED_ERROR);
1421 mStatus = VERR_FAM_CONNECTION_LOST;
1422 AssertRC(checkConnection());
1423 mStatus = oldStatus;
1424 mfWaiting = 0;
1425}
1426
1427void hotplugSysfsFAMImpl::term(void)
1428{
1429 /** This would probably be a pending segfault, so die cleanly */
1430 AssertRelease(!mfWaiting);
1431 termConnection();
1432 RTPipeClose(mhWakeupPipeR);
1433 mhWakeupPipeR = NIL_RTPIPE;
1434 RTPipeClose(mhWakeupPipeW);
1435 mhWakeupPipeW = NIL_RTPIPE;
1436}
1437
1438/** Does a FAM event code mean that the available devices have (probably)
1439 * changed? */
1440static int sysfsGetStatusForFAMCode(FAMCodes enmCode)
1441{
1442 if (enmCode == FAMExists || enmCode == FAMEndExist)
1443 return VERR_TRY_AGAIN;
1444 return VINF_SUCCESS;
1445}
1446
1447int hotplugSysfsFAMImpl::drainWakeupPipe(void)
1448{
1449 char szBuf[sizeof(SYSFS_WAKEUP_STRING)];
1450 size_t cbDummy;
1451
1452 int rc = RTPipeRead(mhWakeupPipeR, szBuf, sizeof(szBuf), &cbDummy);
1453 AssertRC(rc);
1454 return VINF_SUCCESS;
1455}
1456
1457int hotplugSysfsFAMImpl::Wait(RTMSINTERVAL aMillies)
1458{
1459 uint32_t id;
1460 int rc;
1461 FAMEvent ev;
1462
1463 bool fEntered = ASMAtomicCmpXchgU32(&mfWaiting, 1, 0);
1464 AssertReturn(fEntered, VERR_WRONG_ORDER);
1465 do {
1466 if (RT_FAILURE(rc = checkConnection()))
1467 break;
1468 /* timeout returns */
1469 if (RT_FAILURE(rc = RTPoll(mhPollSet, aMillies, NULL, &id)))
1470 break;
1471 if (id == RPIPE_ID)
1472 {
1473 rc = drainWakeupPipe();
1474 break;
1475 }
1476 AssertBreakStmt(id == FAMFD_ID, rc = VERR_NOT_SUPPORTED);
1477 if (RT_FAILURE(rc = nextEventFAM(&ev)))
1478 break;
1479 rc = sysfsGetStatusForFAMCode(ev.code);
1480 } while (false);
1481 mfWaiting = 0;
1482 /* If at all, this should only get called once. */
1483 AssertLogRelMsg( RT_SUCCESS(rc)
1484 || rc == VERR_TRY_AGAIN
1485 || rc == VERR_TIMEOUT, ("rc = %Rrc\n", rc));
1486 return rc;
1487}
1488
1489void hotplugSysfsFAMImpl::Interrupt(void)
1490{
1491 size_t cbDummy;
1492 int rc = RTPipeWrite(mhWakeupPipeW, SYSFS_WAKEUP_STRING,
1493 sizeof(SYSFS_WAKEUP_STRING), &cbDummy);
1494 if (RT_SUCCESS(rc))
1495 RTPipeFlush(mhWakeupPipeW);
1496}
1497
1498# endif /* VBOX_USB_WITH_FAM */
1499#endif /* VBOX_USB_WTH_SYSFS */
1500
1501VBoxMainHotplugWaiter::VBoxMainHotplugWaiter(void)
1502{
1503#ifdef VBOX_USB_WITH_SYSFS
1504# ifdef VBOX_USB_WITH_DBUS
1505 if (hotplugDBusImpl::HalAvailable())
1506 {
1507 mImpl = new hotplugDBusImpl;
1508 return;
1509 }
1510# endif /* VBOX_USB_WITH_DBUS */
1511# ifdef VBOX_USB_WITH_FAM
1512 if (hotplugSysfsFAMImpl::SysfsAvailable())
1513 {
1514 mImpl = new hotplugSysfsFAMImpl;
1515 return;
1516 }
1517# endif /* VBOX_USB_WITH_FAM */
1518#endif /* VBOX_USB_WITH_SYSFS */
1519 mImpl = new hotplugNullImpl;
1520}
1521
1522#ifdef VBOX_USB_WITH_SYSFS
1523# ifdef VBOX_USB_WITH_FAM
1524class sysfsPathHandler
1525{
1526 /** Called on each element of the sysfs directory. Can e.g. store
1527 * interesting entries in a list. */
1528 virtual bool handle(const char *pcszNode) = 0;
1529public:
1530 bool doHandle(const char *pcszNode)
1531 {
1532 AssertPtr(pcszNode);
1533 Assert(pcszNode[0] == '/');
1534 Assert(RTPathExists(pcszNode));
1535 return handle(pcszNode);
1536 }
1537};
1538
1539/**
1540 * Helper function to walk a sysfs directory for extracting information about
1541 * devices.
1542 * @returns iprt status code
1543 * @param pcszPath Sysfs directory to walk. Must exist.
1544 * @param pHandler Handler object which will be invoked on each directory
1545 * entry
1546 *
1547 * @returns IPRT status code
1548 */
1549/* static */
1550int getDeviceInfoFromSysfs(const char *pcszPath, sysfsPathHandler *pHandler)
1551{
1552 AssertPtrReturn(pcszPath, VERR_INVALID_POINTER);
1553 AssertPtrReturn(pHandler, VERR_INVALID_POINTER);
1554 LogFlowFunc (("pcszPath=%s, pHandler=%p\n", pcszPath, pHandler));
1555 PRTDIR pDir = NULL;
1556 int rc;
1557
1558 rc = RTDirOpen(&pDir, pcszPath);
1559 AssertRCReturn(rc, rc);
1560 while (RT_SUCCESS(rc))
1561 {
1562 RTDIRENTRY entry;
1563 char szPath[RTPATH_MAX], szAbsPath[RTPATH_MAX];
1564
1565 rc = RTDirRead(pDir, &entry, NULL);
1566 Assert(rc != VERR_BUFFER_OVERFLOW); /* Should never happen... */
1567 /* We break on "no more files" as well as on "real" errors */
1568 if (RT_FAILURE(rc))
1569 break;
1570 if (entry.szName[0] == '.')
1571 continue;
1572 if (RTStrPrintf(szPath, sizeof(szPath), "%s/%s", pcszPath,
1573 entry.szName) >= sizeof(szPath))
1574 rc = VERR_BUFFER_OVERFLOW;
1575 if (RT_FAILURE(rc))
1576 break;
1577 rc = RTPathReal(szPath, szAbsPath, sizeof(szAbsPath));
1578 AssertRCBreak(rc); /* sysfs should guarantee that this exists */
1579 if (!pHandler->doHandle(szAbsPath))
1580 break;
1581 }
1582 RTDirClose(pDir);
1583 if (rc == VERR_NO_MORE_FILES)
1584 rc = VINF_SUCCESS;
1585 LogFlow (("rc=%Rrc\n", rc));
1586 return rc;
1587}
1588
1589
1590#define USBDEVICE_MAJOR 189
1591
1592/** Deduce the bus that a USB device is plugged into from the device node
1593 * number. See drivers/usb/core/hub.c:usb_new_device as of Linux 2.6.20. */
1594static unsigned usbBusFromDevNum(dev_t devNum)
1595{
1596 AssertReturn(devNum, 0);
1597 AssertReturn(major(devNum) == USBDEVICE_MAJOR, 0);
1598 return (minor(devNum) >> 7) + 1;
1599}
1600
1601
1602/** Deduce the device number of a USB device on the bus from the device node
1603 * number. See drivers/usb/core/hub.c:usb_new_device as of Linux 2.6.20. */
1604static unsigned usbDeviceFromDevNum(dev_t devNum)
1605{
1606 AssertReturn(devNum, 0);
1607 AssertReturn(major(devNum) == USBDEVICE_MAJOR, 0);
1608 return (minor(devNum) & 127) + 1;
1609}
1610
1611
1612/**
1613 * Tell whether a file in /sys/bus/usb/devices is a device rather than an
1614 * interface. To be used with getDeviceInfoFromSysfs().
1615 */
1616class matchUSBDevice : public sysfsPathHandler
1617{
1618 USBDeviceInfoList *mList;
1619public:
1620 matchUSBDevice(USBDeviceInfoList *pList) : mList(pList) {}
1621private:
1622 virtual bool handle(const char *pcszNode)
1623 {
1624 const char *pcszFile = strrchr(pcszNode, '/');
1625 if (strchr(pcszFile, ':'))
1626 return true;
1627 dev_t devnum = RTLinuxSysFsReadDevNumFile("%s/dev", pcszNode);
1628 /* Sanity test of our static helpers */
1629 Assert(usbBusFromDevNum(makedev(USBDEVICE_MAJOR, 517)) == 5);
1630 Assert(usbDeviceFromDevNum(makedev(USBDEVICE_MAJOR, 517)) == 6);
1631 AssertReturn (devnum, true);
1632 char szDevPath[RTPATH_MAX];
1633 ssize_t cchDevPath;
1634 cchDevPath = RTLinuxFindDevicePath(devnum, RTFS_TYPE_DEV_CHAR,
1635 szDevPath, sizeof(szDevPath),
1636 "/dev/bus/usb/%.3d/%.3d",
1637 usbBusFromDevNum(devnum),
1638 usbDeviceFromDevNum(devnum));
1639 if (cchDevPath < 0)
1640 return true;
1641 try
1642 {
1643 mList->push_back(USBDeviceInfo(szDevPath, pcszNode));
1644 }
1645 catch(std::bad_alloc &e)
1646 {
1647 return false;
1648 }
1649 return true;
1650 }
1651};
1652
1653/**
1654 * Tell whether a file in /sys/bus/usb/devices is an interface rather than a
1655 * device. To be used with getDeviceInfoFromSysfs().
1656 */
1657class matchUSBInterface : public sysfsPathHandler
1658{
1659 USBDeviceInfo *mInfo;
1660public:
1661 /** This constructor is currently used to unit test the class logic in
1662 * debug builds. Since no access is made to anything outside the class,
1663 * this shouldn't cause any slowdown worth mentioning. */
1664 matchUSBInterface(USBDeviceInfo *pInfo) : mInfo(pInfo)
1665 {
1666 Assert(isAnInterfaceOf("/sys/devices/pci0000:00/0000:00:1a.0/usb3/3-0:1.0",
1667 "/sys/devices/pci0000:00/0000:00:1a.0/usb3"));
1668 Assert(!isAnInterfaceOf("/sys/devices/pci0000:00/0000:00:1a.0/usb3/3-1",
1669 "/sys/devices/pci0000:00/0000:00:1a.0/usb3"));
1670 Assert(!isAnInterfaceOf("/sys/devices/pci0000:00/0000:00:1a.0/usb3/3-0:1.0/driver",
1671 "/sys/devices/pci0000:00/0000:00:1a.0/usb3"));
1672 }
1673private:
1674 /** The logic for testing whether a sysfs address corresponds to an
1675 * interface of a device. Both must be referenced by their canonical
1676 * sysfs paths. This is not tested, as the test requires file-system
1677 * interaction. */
1678 bool isAnInterfaceOf(const char *pcszIface, const char *pcszDev)
1679 {
1680 size_t cchDev = strlen(pcszDev);
1681
1682 AssertPtr(pcszIface);
1683 AssertPtr(pcszDev);
1684 Assert(pcszIface[0] == '/');
1685 Assert(pcszDev[0] == '/');
1686 Assert(pcszDev[cchDev - 1] != '/');
1687 /* If this passes, pcszIface is at least cchDev long */
1688 if (strncmp(pcszIface, pcszDev, cchDev))
1689 return false;
1690 /* If this passes, pcszIface is longer than cchDev */
1691 if (pcszIface[cchDev] != '/')
1692 return false;
1693 /* In sysfs an interface is an immediate subdirectory of the device */
1694 if (strchr(pcszIface + cchDev + 1, '/'))
1695 return false;
1696 /* And it always has a colon in its name */
1697 if (!strchr(pcszIface + cchDev + 1, ':'))
1698 return false;
1699 /* And hopefully we have now elimitated everything else */
1700 return true;
1701 }
1702
1703 virtual bool handle(const char *pcszNode)
1704 {
1705 if (!isAnInterfaceOf(pcszNode, mInfo->mSysfsPath.c_str()))
1706 return true;
1707 try
1708 {
1709 mInfo->mInterfaces.push_back(pcszNode);
1710 }
1711 catch(std::bad_alloc &e)
1712 {
1713 return false;
1714 }
1715 return true;
1716 }
1717};
1718
1719/**
1720 * Helper function to query the sysfs subsystem for information about USB
1721 * devices attached to the system.
1722 * @returns iprt status code
1723 * @param pList where to add information about the drives detected
1724 * @param pfSuccess Did we find anything?
1725 *
1726 * @returns IPRT status code
1727 */
1728static int getUSBDeviceInfoFromSysfs(USBDeviceInfoList *pList,
1729 bool *pfSuccess)
1730{
1731 AssertPtrReturn(pList, VERR_INVALID_POINTER);
1732 AssertPtrNullReturn(pfSuccess, VERR_INVALID_POINTER); /* Valid or Null */
1733 LogFlowFunc (("pList=%p, pfSuccess=%p\n",
1734 pList, pfSuccess));
1735 size_t cDevices = pList->size();
1736 matchUSBDevice devHandler(pList);
1737 int rc = getDeviceInfoFromSysfs("/sys/bus/usb/devices", &devHandler);
1738 do {
1739 if (RT_FAILURE(rc))
1740 break;
1741 for (USBDeviceInfoList::iterator pInfo = pList->begin();
1742 pInfo != pList->end(); ++pInfo)
1743 {
1744 matchUSBInterface ifaceHandler(&*pInfo);
1745 rc = getDeviceInfoFromSysfs("/sys/bus/usb/devices", &ifaceHandler);
1746 if (RT_FAILURE(rc))
1747 break;
1748 }
1749 } while(0);
1750 if (RT_FAILURE(rc))
1751 /* Clean up again */
1752 while (pList->size() > cDevices)
1753 pList->pop_back();
1754 if (pfSuccess)
1755 *pfSuccess = RT_SUCCESS(rc);
1756 LogFlow (("rc=%Rrc\n", rc));
1757 return rc;
1758}
1759# endif /* VBOX_USB_WITH_FAM */
1760#endif /* VBOX_USB_WITH_SYSFS */
1761
1762#if defined VBOX_USB_WITH_SYSFS && defined VBOX_USB_WITH_DBUS
1763/** Wrapper class around DBusError for automatic cleanup */
1764class autoDBusError
1765{
1766 DBusError mError;
1767public:
1768 autoDBusError () { dbus_error_init (&mError); }
1769 ~autoDBusError ()
1770 {
1771 if (IsSet())
1772 dbus_error_free (&mError);
1773 }
1774 DBusError &get () { return mError; }
1775 bool IsSet ()
1776 {
1777 Assert((mError.name == NULL) == (mError.message == NULL));
1778 return (mError.name != NULL);
1779 }
1780 bool HasName (const char *pcszName)
1781 {
1782 Assert((mError.name == NULL) == (mError.message == NULL));
1783 return (RTStrCmp (mError.name, pcszName) == 0);
1784 }
1785 void FlowLog ()
1786 {
1787 if (IsSet ())
1788 LogFlow(("DBus error %s: %s\n", mError.name, mError.message));
1789 }
1790};
1791
1792/**
1793 * Helper function for setting up a connection to the DBus daemon and
1794 * registering with the hal service.
1795 *
1796 * @note If libdbus is being loaded at runtime then be sure to call
1797 * VBoxDBusCheckPresence before calling this.
1798 * @returns iprt status code
1799 * @param ppConnection where to store the connection handle
1800 */
1801/* static */
1802int halInit (RTMemAutoPtr <DBusConnection, VBoxHalShutdown> *pConnection)
1803{
1804 AssertReturn(VALID_PTR (pConnection), VERR_INVALID_POINTER);
1805 LogFlowFunc (("pConnection=%p\n", pConnection));
1806 int rc = VINF_SUCCESS;
1807 bool halSuccess = true;
1808 autoDBusError dbusError;
1809
1810 RTMemAutoPtr <DBusConnection, VBoxDBusConnectionUnref> dbusConnection;
1811 dbusConnection = dbus_bus_get (DBUS_BUS_SYSTEM, &dbusError.get());
1812 if (!dbusConnection)
1813 halSuccess = false;
1814 if (halSuccess)
1815 {
1816 dbus_connection_set_exit_on_disconnect (dbusConnection.get(), false);
1817 halSuccess = dbus_bus_name_has_owner (dbusConnection.get(),
1818 "org.freedesktop.Hal", &dbusError.get());
1819 }
1820 if (halSuccess)
1821 {
1822 dbus_bus_add_match (dbusConnection.get(),
1823 "type='signal',"
1824 "interface='org.freedesktop.Hal.Manager',"
1825 "sender='org.freedesktop.Hal',"
1826 "path='/org/freedesktop/Hal/Manager'",
1827 &dbusError.get());
1828 halSuccess = !dbusError.IsSet();
1829 }
1830 if (dbusError.HasName (DBUS_ERROR_NO_MEMORY))
1831 rc = VERR_NO_MEMORY;
1832 if (halSuccess)
1833 *pConnection = dbusConnection.release();
1834 LogFlowFunc(("rc=%Rrc, (*pConnection).get()=%p\n", rc, (*pConnection).get()));
1835 dbusError.FlowLog();
1836 return rc;
1837}
1838
1839/**
1840 * Helper function for setting up a private connection to the DBus daemon and
1841 * registering with the hal service. Private connections are considered
1842 * unsociable and should not be used unnecessarily (as per the DBus API docs).
1843 *
1844 * @note If libdbus is being loaded at runtime then be sure to call
1845 * VBoxDBusCheckPresence before calling this.
1846 * @returns iprt status code
1847 * @param pConnection where to store the connection handle
1848 */
1849/* static */
1850int halInitPrivate (RTMemAutoPtr <DBusConnection, VBoxHalShutdownPrivate> *pConnection)
1851{
1852 AssertReturn(VALID_PTR (pConnection), VERR_INVALID_POINTER);
1853 LogFlowFunc (("pConnection=%p\n", pConnection));
1854 int rc = VINF_SUCCESS;
1855 bool halSuccess = true;
1856 autoDBusError dbusError;
1857
1858 RTMemAutoPtr <DBusConnection, VBoxDBusConnectionCloseAndUnref> dbusConnection;
1859 dbusConnection = dbus_bus_get_private (DBUS_BUS_SYSTEM, &dbusError.get());
1860 if (!dbusConnection)
1861 halSuccess = false;
1862 if (halSuccess)
1863 {
1864 dbus_connection_set_exit_on_disconnect (dbusConnection.get(), false);
1865 halSuccess = dbus_bus_name_has_owner (dbusConnection.get(),
1866 "org.freedesktop.Hal", &dbusError.get());
1867 }
1868 if (halSuccess)
1869 {
1870 dbus_bus_add_match (dbusConnection.get(),
1871 "type='signal',"
1872 "interface='org.freedesktop.Hal.Manager',"
1873 "sender='org.freedesktop.Hal',"
1874 "path='/org/freedesktop/Hal/Manager'",
1875 &dbusError.get());
1876 halSuccess = !dbusError.IsSet();
1877 }
1878 if (dbusError.HasName (DBUS_ERROR_NO_MEMORY))
1879 rc = VERR_NO_MEMORY;
1880 if (halSuccess)
1881 *pConnection = dbusConnection.release();
1882 LogFlowFunc(("rc=%Rrc, (*pConnection).get()=%p\n", rc, (*pConnection).get()));
1883 dbusError.FlowLog();
1884 return rc;
1885}
1886
1887/**
1888 * Helper function for shutting down a connection to DBus and hal.
1889 * @param pConnection the connection handle
1890 */
1891/* extern */
1892void VBoxHalShutdown (DBusConnection *pConnection)
1893{
1894 AssertReturnVoid(VALID_PTR (pConnection));
1895 LogFlowFunc (("pConnection=%p\n", pConnection));
1896 autoDBusError dbusError;
1897
1898 dbus_bus_remove_match (pConnection,
1899 "type='signal',"
1900 "interface='org.freedesktop.Hal.Manager',"
1901 "sender='org.freedesktop.Hal',"
1902 "path='/org/freedesktop/Hal/Manager'",
1903 &dbusError.get());
1904 dbus_connection_unref (pConnection);
1905 LogFlowFunc(("returning\n"));
1906 dbusError.FlowLog();
1907}
1908
1909/**
1910 * Helper function for shutting down a private connection to DBus and hal.
1911 * @param pConnection the connection handle
1912 */
1913/* extern */
1914void VBoxHalShutdownPrivate (DBusConnection *pConnection)
1915{
1916 AssertReturnVoid(VALID_PTR (pConnection));
1917 LogFlowFunc (("pConnection=%p\n", pConnection));
1918 autoDBusError dbusError;
1919
1920 dbus_bus_remove_match (pConnection,
1921 "type='signal',"
1922 "interface='org.freedesktop.Hal.Manager',"
1923 "sender='org.freedesktop.Hal',"
1924 "path='/org/freedesktop/Hal/Manager'",
1925 &dbusError.get());
1926 dbus_connection_close (pConnection);
1927 dbus_connection_unref (pConnection);
1928 LogFlowFunc(("returning\n"));
1929 dbusError.FlowLog();
1930}
1931
1932/** Wrapper around dbus_connection_unref. We need this to use it as a real
1933 * function in auto pointers, as a function pointer won't wash here. */
1934/* extern */
1935void VBoxDBusConnectionUnref(DBusConnection *pConnection)
1936{
1937 dbus_connection_unref(pConnection);
1938}
1939
1940/**
1941 * This function closes and unrefs a private connection to dbus. It should
1942 * only be called once no-one else is referencing the connection.
1943 */
1944/* extern */
1945void VBoxDBusConnectionCloseAndUnref(DBusConnection *pConnection)
1946{
1947 dbus_connection_close(pConnection);
1948 dbus_connection_unref(pConnection);
1949}
1950
1951/** Wrapper around dbus_message_unref. We need this to use it as a real
1952 * function in auto pointers, as a function pointer won't wash here. */
1953/* extern */
1954void VBoxDBusMessageUnref(DBusMessage *pMessage)
1955{
1956 dbus_message_unref(pMessage);
1957}
1958
1959/**
1960 * Find the UDIs of hal entries that contain Key=Value property.
1961 * @returns iprt status code. If a non-fatal error occurs, we return success
1962 * but reset pMessage to NULL.
1963 * @param pConnection an initialised connection DBus
1964 * @param pszKey the property key
1965 * @param pszValue the property value
1966 * @param pMessage where to store the return DBus message. This must be
1967 * parsed to get at the UDIs. NOT optional.
1968 */
1969/* static */
1970int halFindDeviceStringMatch (DBusConnection *pConnection, const char *pszKey,
1971 const char *pszValue,
1972 RTMemAutoPtr <DBusMessage, VBoxDBusMessageUnref> *pMessage)
1973{
1974 AssertReturn( VALID_PTR (pConnection) && VALID_PTR (pszKey)
1975 && VALID_PTR (pszValue) && VALID_PTR (pMessage),
1976 VERR_INVALID_POINTER);
1977 LogFlowFunc (("pConnection=%p, pszKey=%s, pszValue=%s, pMessage=%p\n",
1978 pConnection, pszKey, pszValue, pMessage));
1979 int rc = VINF_SUCCESS; /* We set this to failure on fatal errors. */
1980 bool halSuccess = true; /* We set this to false to abort the operation. */
1981 autoDBusError dbusError;
1982
1983 RTMemAutoPtr <DBusMessage, VBoxDBusMessageUnref> message, reply;
1984 if (halSuccess && RT_SUCCESS(rc))
1985 {
1986 message = dbus_message_new_method_call ("org.freedesktop.Hal",
1987 "/org/freedesktop/Hal/Manager",
1988 "org.freedesktop.Hal.Manager",
1989 "FindDeviceStringMatch");
1990 if (!message)
1991 rc = VERR_NO_MEMORY;
1992 }
1993 if (halSuccess && RT_SUCCESS(rc))
1994 {
1995 DBusMessageIter iterAppend;
1996 dbus_message_iter_init_append (message.get(), &iterAppend);
1997 dbus_message_iter_append_basic (&iterAppend, DBUS_TYPE_STRING, &pszKey);
1998 dbus_message_iter_append_basic (&iterAppend, DBUS_TYPE_STRING, &pszValue);
1999 reply = dbus_connection_send_with_reply_and_block (pConnection,
2000 message.get(), -1,
2001 &dbusError.get());
2002 if (!reply)
2003 halSuccess = false;
2004 }
2005 *pMessage = reply.release ();
2006 LogFlowFunc (("rc=%Rrc, *pMessage.value()=%p\n", rc, (*pMessage).get()));
2007 dbusError.FlowLog();
2008 return rc;
2009}
2010
2011/**
2012 * Find the UDIs of hal entries that contain Key=Value property and return the
2013 * result on the end of a vector of iprt::MiniString.
2014 * @returns iprt status code. If a non-fatal error occurs, we return success
2015 * but set *pfSuccess to false.
2016 * @param pConnection an initialised connection DBus
2017 * @param pszKey the property key
2018 * @param pszValue the property value
2019 * @param pMatches pointer to an array of iprt::MiniString to append the
2020 * results to. NOT optional.
2021 * @param pfSuccess will be set to true if the operation succeeds
2022 */
2023/* static */
2024int halFindDeviceStringMatchVector (DBusConnection *pConnection,
2025 const char *pszKey, const char *pszValue,
2026 std::vector<iprt::MiniString> *pMatches,
2027 bool *pfSuccess)
2028{
2029 AssertPtrReturn (pConnection, VERR_INVALID_POINTER);
2030 AssertPtrReturn (pszKey, VERR_INVALID_POINTER);
2031 AssertPtrReturn (pszValue, VERR_INVALID_POINTER);
2032 AssertPtrReturn (pMatches, VERR_INVALID_POINTER);
2033 AssertReturn(pfSuccess == NULL || VALID_PTR (pfSuccess), VERR_INVALID_POINTER);
2034 LogFlowFunc (("pConnection=%p, pszKey=%s, pszValue=%s, pMatches=%p, pfSuccess=%p\n",
2035 pConnection, pszKey, pszValue, pMatches, pfSuccess));
2036 int rc = VINF_SUCCESS; /* We set this to failure on fatal errors. */
2037 bool halSuccess = true; /* We set this to false to abort the operation. */
2038
2039 RTMemAutoPtr <DBusMessage, VBoxDBusMessageUnref> message, replyFind;
2040 DBusMessageIter iterFind, iterUdis;
2041
2042 if (halSuccess && RT_SUCCESS(rc))
2043 {
2044 rc = halFindDeviceStringMatch (pConnection, pszKey, pszValue,
2045 &replyFind);
2046 if (!replyFind)
2047 halSuccess = false;
2048 }
2049 if (halSuccess && RT_SUCCESS(rc))
2050 {
2051 dbus_message_iter_init (replyFind.get(), &iterFind);
2052 if (dbus_message_iter_get_arg_type (&iterFind) != DBUS_TYPE_ARRAY)
2053 halSuccess = false;
2054 }
2055 if (halSuccess && RT_SUCCESS(rc))
2056 dbus_message_iter_recurse (&iterFind, &iterUdis);
2057 for (; halSuccess && RT_SUCCESS(rc)
2058 && dbus_message_iter_get_arg_type (&iterUdis) == DBUS_TYPE_STRING;
2059 dbus_message_iter_next(&iterUdis))
2060 {
2061 /* Now get all UDIs from the iterator */
2062 const char *pszUdi;
2063 dbus_message_iter_get_basic (&iterUdis, &pszUdi);
2064 try
2065 {
2066 pMatches->push_back(pszUdi);
2067 }
2068 catch(std::bad_alloc &e)
2069 {
2070 rc = VERR_NO_MEMORY;
2071 }
2072 }
2073 if (pfSuccess != NULL)
2074 *pfSuccess = halSuccess;
2075 LogFlow (("rc=%Rrc, halSuccess=%d\n", rc, halSuccess));
2076 return rc;
2077}
2078
2079/**
2080 * Read a set of string properties for a device. If some of the properties are
2081 * not of type DBUS_TYPE_STRING or do not exist then a NULL pointer will be
2082 * returned for them.
2083 * @returns iprt status code. If the operation failed for non-fatal reasons
2084 * then we return success and leave pMessage untouched - reset it
2085 * before the call to detect this.
2086 * @param pConnection an initialised connection DBus
2087 * @param pszUdi the Udi of the device
2088 * @param cProps the number of property values to look up
2089 * @param papszKeys the keys of the properties to be looked up
2090 * @param papszValues where to store the values of the properties. The
2091 * strings returned will be valid until the message
2092 * returned in @a ppMessage is freed. Undefined if
2093 * the message is NULL.
2094 * @param pMessage where to store the return DBus message. The caller
2095 * is responsible for freeing this once they have
2096 * finished with the value strings. NOT optional.
2097 */
2098/* static */
2099int halGetPropertyStrings (DBusConnection *pConnection, const char *pszUdi,
2100 size_t cProps, const char **papszKeys,
2101 char **papszValues,
2102 RTMemAutoPtr <DBusMessage, VBoxDBusMessageUnref> *pMessage)
2103{
2104 AssertReturn( VALID_PTR (pConnection) && VALID_PTR (pszUdi)
2105 && VALID_PTR (papszKeys) && VALID_PTR (papszValues)
2106 && VALID_PTR (pMessage),
2107 VERR_INVALID_POINTER);
2108 LogFlowFunc (("pConnection=%p, pszUdi=%s, cProps=%llu, papszKeys=%p, papszValues=%p, pMessage=%p\n",
2109 pConnection, pszUdi, cProps, papszKeys, papszValues, pMessage));
2110 int rc = VINF_SUCCESS; /* We set this to failure on fatal errors. */
2111 bool halSuccess = true; /* We set this to false to abort the operation. */
2112 autoDBusError dbusError;
2113
2114 RTMemAutoPtr <DBusMessage, VBoxDBusMessageUnref> message, reply;
2115 DBusMessageIter iterGet, iterProps;
2116
2117 /* Initialise the return array to NULLs */
2118 for (size_t i = 0; i < cProps; ++i)
2119 papszValues[i] = NULL;
2120
2121 /* Send a GetAllProperties message to hald */
2122 message = dbus_message_new_method_call ("org.freedesktop.Hal", pszUdi,
2123 "org.freedesktop.Hal.Device",
2124 "GetAllProperties");
2125 if (!message)
2126 rc = VERR_NO_MEMORY;
2127 if (halSuccess && RT_SUCCESS(rc))
2128 {
2129 reply = dbus_connection_send_with_reply_and_block (pConnection,
2130 message.get(), -1,
2131 &dbusError.get());
2132 if (!reply)
2133 halSuccess = false;
2134 }
2135
2136 /* Parse the reply */
2137 if (halSuccess && RT_SUCCESS(rc))
2138 {
2139 dbus_message_iter_init (reply.get(), &iterGet);
2140 if ( dbus_message_iter_get_arg_type (&iterGet) != DBUS_TYPE_ARRAY
2141 && dbus_message_iter_get_element_type (&iterGet) != DBUS_TYPE_DICT_ENTRY)
2142 halSuccess = false;
2143 }
2144 if (halSuccess && RT_SUCCESS(rc))
2145 dbus_message_iter_recurse (&iterGet, &iterProps);
2146 /* Go through all entries in the reply and see if any match our keys. */
2147 while ( halSuccess && RT_SUCCESS(rc)
2148 && dbus_message_iter_get_arg_type (&iterProps)
2149 == DBUS_TYPE_DICT_ENTRY)
2150 {
2151 const char *pszKey;
2152 DBusMessageIter iterEntry, iterValue;
2153 dbus_message_iter_recurse (&iterProps, &iterEntry);
2154 dbus_message_iter_get_basic (&iterEntry, &pszKey);
2155 dbus_message_iter_next (&iterEntry);
2156 dbus_message_iter_recurse (&iterEntry, &iterValue);
2157 /* Fill in any matches. */
2158 for (size_t i = 0; i < cProps; ++i)
2159 if (strcmp (pszKey, papszKeys[i]) == 0)
2160 {
2161 if (dbus_message_iter_get_arg_type (&iterValue) == DBUS_TYPE_STRING)
2162 dbus_message_iter_get_basic (&iterValue, &papszValues[i]);
2163 }
2164 dbus_message_iter_next (&iterProps);
2165 }
2166 if (RT_SUCCESS(rc) && halSuccess)
2167 *pMessage = reply.release();
2168 if (dbusError.HasName (DBUS_ERROR_NO_MEMORY))
2169 rc = VERR_NO_MEMORY;
2170 LogFlowFunc (("rc=%Rrc, *pMessage.value()=%p\n", rc, (*pMessage).get()));
2171 dbusError.FlowLog();
2172 return rc;
2173}
2174
2175/**
2176 * Read a set of string properties for a device. If some properties do not
2177 * exist or are not of type DBUS_TYPE_STRING, we will still fetch the others.
2178 * @returns iprt status code. If the operation failed for non-fatal reasons
2179 * then we return success and set *pfSuccess to false.
2180 * @param pConnection an initialised connection DBus
2181 * @param pszUdi the Udi of the device
2182 * @param cProps the number of property values to look up
2183 * @param papszKeys the keys of the properties to be looked up
2184 * @param pMatches pointer to an empty array of iprt::MiniString to append the
2185 * results to. NOT optional.
2186 * @param pfMatches pointer to an array of boolean values indicating
2187 * whether the respective property is a string. If this
2188 * is not supplied then all properties must be strings
2189 * for the operation to be considered successful
2190 * @param pfSuccess will be set to true if the operation succeeds
2191 */
2192/* static */
2193int halGetPropertyStringsVector (DBusConnection *pConnection,
2194 const char *pszUdi, size_t cProps,
2195 const char **papszKeys,
2196 std::vector<iprt::MiniString> *pMatches,
2197 bool *pfMatches, bool *pfSuccess)
2198{
2199 AssertPtrReturn (pConnection, VERR_INVALID_POINTER);
2200 AssertPtrReturn (pszUdi, VERR_INVALID_POINTER);
2201 AssertPtrReturn (papszKeys, VERR_INVALID_POINTER);
2202 AssertPtrReturn (pMatches, VERR_INVALID_POINTER);
2203 AssertReturn((pfMatches == NULL) || VALID_PTR (pfMatches), VERR_INVALID_POINTER);
2204 AssertReturn((pfSuccess == NULL) || VALID_PTR (pfSuccess), VERR_INVALID_POINTER);
2205 AssertReturn(pMatches->empty(), VERR_INVALID_PARAMETER);
2206 LogFlowFunc (("pConnection=%p, pszUdi=%s, cProps=%llu, papszKeys=%p, pMatches=%p, pfMatches=%p, pfSuccess=%p\n",
2207 pConnection, pszUdi, cProps, papszKeys, pMatches, pfMatches, pfSuccess));
2208 RTMemAutoPtr <char *> values(cProps);
2209 RTMemAutoPtr <DBusMessage, VBoxDBusMessageUnref> message;
2210 bool halSuccess = true;
2211 int rc = halGetPropertyStrings (pConnection, pszUdi, cProps, papszKeys,
2212 values.get(), &message);
2213 if (!message)
2214 halSuccess = false;
2215 for (size_t i = 0; RT_SUCCESS(rc) && halSuccess && i < cProps; ++i)
2216 {
2217 bool fMatches = values[i] != NULL;
2218 if (pfMatches != NULL)
2219 pfMatches[i] = fMatches;
2220 else
2221 halSuccess = fMatches;
2222 try
2223 {
2224 pMatches->push_back(fMatches ? values[i] : "");
2225 }
2226 catch(std::bad_alloc &e)
2227 {
2228 rc = VERR_NO_MEMORY;
2229 }
2230 }
2231 if (pfSuccess != NULL)
2232 *pfSuccess = halSuccess;
2233 if (RT_SUCCESS(rc) && halSuccess)
2234 {
2235 Assert(pMatches->size() == cProps);
2236 AssertForEach(j, size_t, 0, cProps, (pfMatches == NULL)
2237 || (pfMatches[j] == true)
2238 || ((pfMatches[j] == false) && (pMatches[j].size() == 0)));
2239 }
2240 LogFlowFunc (("rc=%Rrc, halSuccess=%d\n", rc, halSuccess));
2241 return rc;
2242}
2243
2244
2245/**
2246 * Helper function to query the hal subsystem for information about USB devices
2247 * attached to the system.
2248 * @returns iprt status code
2249 * @param pList where to add information about the devices detected
2250 * @param pfSuccess will be set to true if all interactions with hal
2251 * succeeded and to false otherwise. Optional.
2252 *
2253 * @returns IPRT status code
2254 */
2255/* static */
2256int getUSBDeviceInfoFromHal(USBDeviceInfoList *pList, bool *pfSuccess)
2257{
2258 AssertReturn(VALID_PTR (pList) && (pfSuccess == NULL || VALID_PTR (pfSuccess)),
2259 VERR_INVALID_POINTER);
2260 LogFlowFunc (("pList=%p, pfSuccess=%p\n", pList, pfSuccess));
2261 int rc = VINF_SUCCESS; /* We set this to failure on fatal errors. */
2262 bool halSuccess = true; /* We set this to false to abort the operation. */
2263 autoDBusError dbusError;
2264
2265 RTMemAutoPtr<DBusMessage, VBoxDBusMessageUnref> message, replyFind, replyGet;
2266 RTMemAutoPtr<DBusConnection, VBoxHalShutdown> dbusConnection;
2267 DBusMessageIter iterFind, iterUdis;
2268
2269 /* Connect to hal */
2270 rc = halInit (&dbusConnection);
2271 if (!dbusConnection)
2272 halSuccess = false;
2273 /* Get an array of all devices in the usb_device subsystem */
2274 if (halSuccess && RT_SUCCESS(rc))
2275 {
2276 rc = halFindDeviceStringMatch(dbusConnection.get(), "info.subsystem",
2277 "usb_device", &replyFind);
2278 if (!replyFind)
2279 halSuccess = false;
2280 }
2281 if (halSuccess && RT_SUCCESS(rc))
2282 {
2283 dbus_message_iter_init(replyFind.get(), &iterFind);
2284 if (dbus_message_iter_get_arg_type (&iterFind) != DBUS_TYPE_ARRAY)
2285 halSuccess = false;
2286 }
2287 /* Recurse down into the array and query interesting information about the
2288 * entries. */
2289 if (halSuccess && RT_SUCCESS(rc))
2290 dbus_message_iter_recurse(&iterFind, &iterUdis);
2291 for (; halSuccess && RT_SUCCESS(rc)
2292 && dbus_message_iter_get_arg_type(&iterUdis) == DBUS_TYPE_STRING;
2293 dbus_message_iter_next(&iterUdis))
2294 {
2295 /* Get the device node and the sysfs path for the current entry. */
2296 const char *pszUdi;
2297 dbus_message_iter_get_basic (&iterUdis, &pszUdi);
2298 static const char *papszKeys[] = { "linux.device_file", "linux.sysfs_path" };
2299 char *papszValues[RT_ELEMENTS(papszKeys)];
2300 rc = halGetPropertyStrings(dbusConnection.get(), pszUdi, RT_ELEMENTS(papszKeys),
2301 papszKeys, papszValues, &replyGet);
2302 const char *pszDevice = papszValues[0], *pszSysfsPath = papszValues[1];
2303 /* Get the interfaces. */
2304 if (!!replyGet && pszDevice && pszSysfsPath)
2305 {
2306 USBDeviceInfo info(pszDevice, pszSysfsPath);
2307 bool ifaceSuccess = true; /* If we can't get the interfaces, just
2308 * skip this one device. */
2309 rc = getUSBInterfacesFromHal(&info.mInterfaces, pszUdi, &ifaceSuccess);
2310 if (RT_SUCCESS(rc) && halSuccess && ifaceSuccess)
2311 try
2312 {
2313 pList->push_back(info);
2314 }
2315 catch(std::bad_alloc &e)
2316 {
2317 rc = VERR_NO_MEMORY;
2318 }
2319 }
2320 }
2321 if (dbusError.HasName (DBUS_ERROR_NO_MEMORY))
2322 rc = VERR_NO_MEMORY;
2323 if (pfSuccess != NULL)
2324 *pfSuccess = halSuccess;
2325 LogFlow(("rc=%Rrc, halSuccess=%d\n", rc, halSuccess));
2326 dbusError.FlowLog();
2327 return rc;
2328}
2329
2330/**
2331 * Helper function to query the hal subsystem for information about USB devices
2332 * attached to the system, using the older API.
2333 * @returns iprt status code
2334 * @param pList where to add information about the devices detected
2335 * @param pfSuccess will be set to true if all interactions with hal
2336 * succeeded and to false otherwise. Optional.
2337 *
2338 * @returns IPRT status code
2339 */
2340/* static */
2341int getOldUSBDeviceInfoFromHal(USBDeviceInfoList *pList, bool *pfSuccess)
2342{
2343 AssertReturn(VALID_PTR (pList) && (pfSuccess == NULL || VALID_PTR (pfSuccess)),
2344 VERR_INVALID_POINTER);
2345 LogFlowFunc (("pList=%p, pfSuccess=%p\n", pList, pfSuccess));
2346 int rc = VINF_SUCCESS; /* We set this to failure on fatal errors. */
2347 bool halSuccess = true; /* We set this to false to abort the operation. */
2348 autoDBusError dbusError;
2349
2350 RTMemAutoPtr<DBusMessage, VBoxDBusMessageUnref> message, replyFind, replyGet;
2351 RTMemAutoPtr<DBusConnection, VBoxHalShutdown> dbusConnection;
2352 DBusMessageIter iterFind, iterUdis;
2353
2354 /* Connect to hal */
2355 rc = halInit(&dbusConnection);
2356 if (!dbusConnection)
2357 halSuccess = false;
2358 /* Get an array of all devices in the usb_device subsystem */
2359 if (halSuccess && RT_SUCCESS(rc))
2360 {
2361 rc = halFindDeviceStringMatch(dbusConnection.get(), "info.category",
2362 "usbraw", &replyFind);
2363 if (!replyFind)
2364 halSuccess = false;
2365 }
2366 if (halSuccess && RT_SUCCESS(rc))
2367 {
2368 dbus_message_iter_init(replyFind.get(), &iterFind);
2369 if (dbus_message_iter_get_arg_type(&iterFind) != DBUS_TYPE_ARRAY)
2370 halSuccess = false;
2371 }
2372 /* Recurse down into the array and query interesting information about the
2373 * entries. */
2374 if (halSuccess && RT_SUCCESS(rc))
2375 dbus_message_iter_recurse(&iterFind, &iterUdis);
2376 for (; halSuccess && RT_SUCCESS(rc)
2377 && dbus_message_iter_get_arg_type(&iterUdis) == DBUS_TYPE_STRING;
2378 dbus_message_iter_next(&iterUdis))
2379 {
2380 /* Get the device node and the sysfs path for the current entry. */
2381 const char *pszUdi;
2382 dbus_message_iter_get_basic(&iterUdis, &pszUdi);
2383 static const char *papszKeys[] = { "linux.device_file", "info.parent" };
2384 char *papszValues[RT_ELEMENTS(papszKeys)];
2385 rc = halGetPropertyStrings(dbusConnection.get(), pszUdi, RT_ELEMENTS(papszKeys),
2386 papszKeys, papszValues, &replyGet);
2387 const char *pszDevice = papszValues[0], *pszSysfsPath = papszValues[1];
2388 /* Get the interfaces. */
2389 if (!!replyGet && pszDevice && pszSysfsPath)
2390 {
2391 USBDeviceInfo info(pszDevice, pszSysfsPath);
2392 bool ifaceSuccess = false; /* If we can't get the interfaces, just
2393 * skip this one device. */
2394 rc = getUSBInterfacesFromHal(&info.mInterfaces, pszSysfsPath,
2395 &ifaceSuccess);
2396 if (RT_SUCCESS(rc) && halSuccess && ifaceSuccess)
2397 try
2398 {
2399 pList->push_back(info);
2400 }
2401 catch(std::bad_alloc &e)
2402 {
2403 rc = VERR_NO_MEMORY;
2404 }
2405 }
2406 }
2407 if (dbusError.HasName(DBUS_ERROR_NO_MEMORY))
2408 rc = VERR_NO_MEMORY;
2409 if (pfSuccess != NULL)
2410 *pfSuccess = halSuccess;
2411 LogFlow(("rc=%Rrc, halSuccess=%d\n", rc, halSuccess));
2412 dbusError.FlowLog();
2413 return rc;
2414}
2415
2416
2417/**
2418 * Helper function to query the hal subsystem for information about USB devices
2419 * attached to the system.
2420 * @returns iprt status code
2421 * @param pList where to add information about the devices detected. If
2422 * certain interfaces are not found (@a pfFound is false on
2423 * return) this may contain invalid information.
2424 * @param pcszUdi the hal UDI of the device
2425 * @param pfSuccess will be set to true if the operation succeeds and to
2426 * false if it fails for non-critical reasons. Optional.
2427 *
2428 * @returns IPRT status code
2429 */
2430/* static */
2431int getUSBInterfacesFromHal(std::vector<iprt::MiniString> *pList,
2432 const char *pcszUdi, bool *pfSuccess)
2433{
2434 AssertReturn(VALID_PTR(pList) && VALID_PTR(pcszUdi) &&
2435 (pfSuccess == NULL || VALID_PTR (pfSuccess)),
2436 VERR_INVALID_POINTER);
2437 LogFlowFunc(("pList=%p, pcszUdi=%s, pfSuccess=%p\n", pList, pcszUdi,
2438 pfSuccess));
2439 int rc = VINF_SUCCESS; /* We set this to failure on fatal errors. */
2440 bool halSuccess = true; /* We set this to false to abort the operation. */
2441 autoDBusError dbusError;
2442
2443 RTMemAutoPtr <DBusMessage, VBoxDBusMessageUnref> message, replyFind, replyGet;
2444 RTMemAutoPtr <DBusConnection, VBoxHalShutdown> dbusConnection;
2445 DBusMessageIter iterFind, iterUdis;
2446
2447 rc = halInit(&dbusConnection);
2448 if (!dbusConnection)
2449 halSuccess = false;
2450 if (halSuccess && RT_SUCCESS(rc))
2451 {
2452 /* Look for children of the current UDI. */
2453 rc = halFindDeviceStringMatch(dbusConnection.get(), "info.parent",
2454 pcszUdi, &replyFind);
2455 if (!replyFind)
2456 halSuccess = false;
2457 }
2458 if (halSuccess && RT_SUCCESS(rc))
2459 {
2460 dbus_message_iter_init(replyFind.get(), &iterFind);
2461 if (dbus_message_iter_get_arg_type(&iterFind) != DBUS_TYPE_ARRAY)
2462 halSuccess = false;
2463 }
2464 if (halSuccess && RT_SUCCESS(rc))
2465 dbus_message_iter_recurse(&iterFind, &iterUdis);
2466 for (; halSuccess && RT_SUCCESS(rc)
2467 && dbus_message_iter_get_arg_type(&iterUdis) == DBUS_TYPE_STRING;
2468 dbus_message_iter_next(&iterUdis))
2469 {
2470 /* Now get the sysfs path and the subsystem from the iterator */
2471 const char *pszUdi;
2472 dbus_message_iter_get_basic(&iterUdis, &pszUdi);
2473 static const char *papszKeys[] = { "linux.sysfs_path", "info.subsystem",
2474 "linux.subsystem" };
2475 char *papszValues[RT_ELEMENTS(papszKeys)];
2476 rc = halGetPropertyStrings(dbusConnection.get(), pszUdi, RT_ELEMENTS(papszKeys),
2477 papszKeys, papszValues, &replyGet);
2478 const char *pszSysfsPath = papszValues[0], *pszInfoSubsystem = papszValues[1],
2479 *pszLinuxSubsystem = papszValues[2];
2480 if (!replyGet)
2481 halSuccess = false;
2482 if (!!replyGet && pszSysfsPath == NULL)
2483 halSuccess = false;
2484 if ( halSuccess && RT_SUCCESS(rc)
2485 && RTStrCmp (pszInfoSubsystem, "usb_device") != 0 /* Children of buses can also be devices. */
2486 && RTStrCmp (pszLinuxSubsystem, "usb_device") != 0)
2487 try
2488 {
2489 pList->push_back(pszSysfsPath);
2490 }
2491 catch(std::bad_alloc &e)
2492 {
2493 rc = VERR_NO_MEMORY;
2494 }
2495 }
2496 if (dbusError.HasName(DBUS_ERROR_NO_MEMORY))
2497 rc = VERR_NO_MEMORY;
2498 if (pfSuccess != NULL)
2499 *pfSuccess = halSuccess;
2500 LogFlow(("rc=%Rrc, halSuccess=%d\n", rc, halSuccess));
2501 dbusError.FlowLog();
2502 return rc;
2503}
2504
2505/**
2506 * When it is registered with DBus, this function will be called by
2507 * dbus_connection_read_write_dispatch each time a message is received over the
2508 * DBus connection. We check whether that message was caused by a hal device
2509 * hotplug event, and if so we set a flag. dbus_connection_read_write_dispatch
2510 * will return after calling its filter functions, and its caller should then
2511 * check the status of the flag passed to the filter function.
2512 *
2513 * @param pConnection The DBus connection we are using.
2514 * @param pMessage The DBus message which just arrived.
2515 * @param pvUser A pointer to the flag variable we are to set.
2516 */
2517/* static */
2518DBusHandlerResult dbusFilterFunction(DBusConnection * /* pConnection */,
2519 DBusMessage *pMessage, void *pvUser)
2520{
2521 volatile bool *pTriggered = reinterpret_cast<volatile bool *>(pvUser);
2522 if ( dbus_message_is_signal(pMessage, "org.freedesktop.Hal.Manager",
2523 "DeviceAdded")
2524 || dbus_message_is_signal(pMessage, "org.freedesktop.Hal.Manager",
2525 "DeviceRemoved"))
2526 {
2527 *pTriggered = true;
2528 }
2529 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
2530}
2531#endif /* VBOX_USB_WITH_SYSFS && VBOX_USB_WITH_DBUS */
2532
Note: See TracBrowser for help on using the repository browser.

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