VirtualBox

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

Last change on this file since 30760 was 30659, checked in by vboxsync, 14 years ago

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

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