1 | /* $Id: HostHardwareLinux.cpp 69500 2017-10-28 15:14:05Z 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-2017 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 | /*********************************************************************************************************************************
|
---|
24 | * Header Files *
|
---|
25 | *********************************************************************************************************************************/
|
---|
26 |
|
---|
27 | #include <HostHardwareLinux.h>
|
---|
28 | #include <vector.h>
|
---|
29 |
|
---|
30 | #include <VBox/err.h>
|
---|
31 | #include <VBox/log.h>
|
---|
32 |
|
---|
33 | #include <iprt/asm.h>
|
---|
34 | #include <iprt/dir.h>
|
---|
35 | #include <iprt/env.h>
|
---|
36 | #include <iprt/file.h>
|
---|
37 | #include <iprt/mem.h>
|
---|
38 | #include <iprt/param.h>
|
---|
39 | #include <iprt/path.h>
|
---|
40 | #include <iprt/string.h>
|
---|
41 |
|
---|
42 | #include <linux/cdrom.h>
|
---|
43 | #include <linux/fd.h>
|
---|
44 | #include <linux/major.h>
|
---|
45 | #include <scsi/scsi.h>
|
---|
46 |
|
---|
47 | #include <iprt/linux/sysfs.h>
|
---|
48 |
|
---|
49 | #ifdef VBOX_USB_WITH_SYSFS
|
---|
50 | # ifdef VBOX_USB_WITH_INOTIFY
|
---|
51 | # include <dlfcn.h>
|
---|
52 | # include <fcntl.h>
|
---|
53 | # include <poll.h>
|
---|
54 | # include <signal.h>
|
---|
55 | # include <unistd.h>
|
---|
56 | # endif
|
---|
57 | #endif
|
---|
58 |
|
---|
59 | #include <vector>
|
---|
60 |
|
---|
61 | #include <errno.h>
|
---|
62 | #include <dirent.h>
|
---|
63 | #include <limits.h>
|
---|
64 | #include <stdio.h>
|
---|
65 | #include <stdlib.h>
|
---|
66 | #include <sys/types.h>
|
---|
67 | #include <sys/sysmacros.h>
|
---|
68 |
|
---|
69 |
|
---|
70 | /*********************************************************************************************************************************
|
---|
71 | * Global Variables *
|
---|
72 | *********************************************************************************************************************************/
|
---|
73 |
|
---|
74 | #ifdef TESTCASE
|
---|
75 | static bool testing() { return true; }
|
---|
76 | static bool fNoProbe = false;
|
---|
77 | static bool noProbe() { return fNoProbe; }
|
---|
78 | static void setNoProbe(bool val) { fNoProbe = val; }
|
---|
79 | #else
|
---|
80 | static bool testing() { return false; }
|
---|
81 | static bool noProbe() { return false; }
|
---|
82 | static void setNoProbe(bool val) { (void)val; }
|
---|
83 | #endif
|
---|
84 |
|
---|
85 |
|
---|
86 | /*********************************************************************************************************************************
|
---|
87 | * Typedefs and Defines *
|
---|
88 | *********************************************************************************************************************************/
|
---|
89 |
|
---|
90 | static int getDriveInfoFromEnv(const char *pcszVar, DriveInfoList *pList,
|
---|
91 | bool isDVD, bool *pfSuccess);
|
---|
92 | static int getDriveInfoFromSysfs(DriveInfoList *pList, bool isDVD,
|
---|
93 | bool *pfSuccess);
|
---|
94 |
|
---|
95 | /** Find the length of a string, ignoring trailing non-ascii or control
|
---|
96 | * characters */
|
---|
97 | static size_t strLenStripped(const char *pcsz)
|
---|
98 | {
|
---|
99 | size_t cch = 0;
|
---|
100 | for (size_t i = 0; pcsz[i] != '\0'; ++i)
|
---|
101 | if (pcsz[i] > 32 && pcsz[i] < 127)
|
---|
102 | cch = i;
|
---|
103 | return cch + 1;
|
---|
104 | }
|
---|
105 |
|
---|
106 |
|
---|
107 | /**
|
---|
108 | * Get the name of a floppy drive according to the Linux floppy driver.
|
---|
109 | * @returns true on success, false if the name was not available (i.e. the
|
---|
110 | * device was not readable, or the file name wasn't a PC floppy
|
---|
111 | * device)
|
---|
112 | * @param pcszNode the path to the device node for the device
|
---|
113 | * @param Number the Linux floppy driver number for the drive. Required.
|
---|
114 | * @param pszName where to store the name retrieved
|
---|
115 | */
|
---|
116 | static bool floppyGetName(const char *pcszNode, unsigned Number,
|
---|
117 | floppy_drive_name pszName)
|
---|
118 | {
|
---|
119 | AssertPtrReturn(pcszNode, false);
|
---|
120 | AssertPtrReturn(pszName, false);
|
---|
121 | AssertReturn(Number <= 7, false);
|
---|
122 | RTFILE File;
|
---|
123 | int rc = RTFileOpen(&File, pcszNode, RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_NONE | RTFILE_O_NON_BLOCK);
|
---|
124 | if (RT_SUCCESS(rc))
|
---|
125 | {
|
---|
126 | int rcIoCtl;
|
---|
127 | rc = RTFileIoCtl(File, FDGETDRVTYP, pszName, 0, &rcIoCtl);
|
---|
128 | RTFileClose(File);
|
---|
129 | if (RT_SUCCESS(rc) && rcIoCtl >= 0)
|
---|
130 | return true;
|
---|
131 | }
|
---|
132 | return false;
|
---|
133 | }
|
---|
134 |
|
---|
135 |
|
---|
136 | /**
|
---|
137 | * Create a UDI and a description for a floppy drive based on a number and the
|
---|
138 | * driver's name for it. We deliberately return an ugly sequence of
|
---|
139 | * characters as the description rather than an English language string to
|
---|
140 | * avoid translation issues.
|
---|
141 | *
|
---|
142 | * @returns true if we know the device to be valid, false otherwise
|
---|
143 | * @param pcszName the floppy driver name for the device (optional)
|
---|
144 | * @param Number the number of the floppy (0 to 3 on FDC 0, 4 to 7 on
|
---|
145 | * FDC 1)
|
---|
146 | * @param pszDesc where to store the device description (optional)
|
---|
147 | * @param cchDesc the size of the buffer in @a pszDesc
|
---|
148 | * @param pszUdi where to store the device UDI (optional)
|
---|
149 | * @param cchUdi the size of the buffer in @a pszUdi
|
---|
150 | */
|
---|
151 | static void floppyCreateDeviceStrings(const floppy_drive_name pcszName,
|
---|
152 | unsigned Number, char *pszDesc,
|
---|
153 | size_t cchDesc, char *pszUdi,
|
---|
154 | size_t cchUdi)
|
---|
155 | {
|
---|
156 | AssertPtrNullReturnVoid(pcszName);
|
---|
157 | AssertPtrNullReturnVoid(pszDesc);
|
---|
158 | AssertReturnVoid(!pszDesc || cchDesc > 0);
|
---|
159 | AssertPtrNullReturnVoid(pszUdi);
|
---|
160 | AssertReturnVoid(!pszUdi || cchUdi > 0);
|
---|
161 | AssertReturnVoid(Number <= 7);
|
---|
162 | if (pcszName)
|
---|
163 | {
|
---|
164 | const char *pcszSize;
|
---|
165 | switch(pcszName[0])
|
---|
166 | {
|
---|
167 | case 'd': case 'q': case 'h':
|
---|
168 | pcszSize = "5.25\"";
|
---|
169 | break;
|
---|
170 | case 'D': case 'H': case 'E': case 'u':
|
---|
171 | pcszSize = "3.5\"";
|
---|
172 | break;
|
---|
173 | default:
|
---|
174 | pcszSize = "(unknown)";
|
---|
175 | }
|
---|
176 | if (pszDesc)
|
---|
177 | RTStrPrintf(pszDesc, cchDesc, "%s %s K%s", pcszSize, &pcszName[1],
|
---|
178 | Number > 3 ? ", FDC 2" : "");
|
---|
179 | }
|
---|
180 | else
|
---|
181 | {
|
---|
182 | if (pszDesc)
|
---|
183 | RTStrPrintf(pszDesc, cchDesc, "FDD %d%s", (Number & 4) + 1,
|
---|
184 | Number > 3 ? ", FDC 2" : "");
|
---|
185 | }
|
---|
186 | if (pszUdi)
|
---|
187 | RTStrPrintf(pszUdi, cchUdi,
|
---|
188 | "/org/freedesktop/Hal/devices/platform_floppy_%u_storage",
|
---|
189 | Number);
|
---|
190 | }
|
---|
191 |
|
---|
192 |
|
---|
193 | /**
|
---|
194 | * Check whether a device number might correspond to a CD-ROM device according
|
---|
195 | * to Documentation/devices.txt in the Linux kernel source.
|
---|
196 | * @returns true if it might, false otherwise
|
---|
197 | * @param Number the device number (major and minor combination)
|
---|
198 | */
|
---|
199 | static bool isCdromDevNum(dev_t Number)
|
---|
200 | {
|
---|
201 | int major = major(Number);
|
---|
202 | int minor = minor(Number);
|
---|
203 | if ((major == IDE0_MAJOR) && !(minor & 0x3f))
|
---|
204 | return true;
|
---|
205 | if (major == SCSI_CDROM_MAJOR)
|
---|
206 | return true;
|
---|
207 | if (major == CDU31A_CDROM_MAJOR)
|
---|
208 | return true;
|
---|
209 | if (major == GOLDSTAR_CDROM_MAJOR)
|
---|
210 | return true;
|
---|
211 | if (major == OPTICS_CDROM_MAJOR)
|
---|
212 | return true;
|
---|
213 | if (major == SANYO_CDROM_MAJOR)
|
---|
214 | return true;
|
---|
215 | if (major == MITSUMI_X_CDROM_MAJOR)
|
---|
216 | return true;
|
---|
217 | if ((major == IDE1_MAJOR) && !(minor & 0x3f))
|
---|
218 | return true;
|
---|
219 | if (major == MITSUMI_CDROM_MAJOR)
|
---|
220 | return true;
|
---|
221 | if (major == CDU535_CDROM_MAJOR)
|
---|
222 | return true;
|
---|
223 | if (major == MATSUSHITA_CDROM_MAJOR)
|
---|
224 | return true;
|
---|
225 | if (major == MATSUSHITA_CDROM2_MAJOR)
|
---|
226 | return true;
|
---|
227 | if (major == MATSUSHITA_CDROM3_MAJOR)
|
---|
228 | return true;
|
---|
229 | if (major == MATSUSHITA_CDROM4_MAJOR)
|
---|
230 | return true;
|
---|
231 | if (major == AZTECH_CDROM_MAJOR)
|
---|
232 | return true;
|
---|
233 | if (major == 30 /* CM205_CDROM_MAJOR */) /* no #define for some reason */
|
---|
234 | return true;
|
---|
235 | if (major == CM206_CDROM_MAJOR)
|
---|
236 | return true;
|
---|
237 | if ((major == IDE3_MAJOR) && !(minor & 0x3f))
|
---|
238 | return true;
|
---|
239 | if (major == 46 /* Parallel port ATAPI CD-ROM */) /* no #define */
|
---|
240 | return true;
|
---|
241 | if ((major == IDE4_MAJOR) && !(minor & 0x3f))
|
---|
242 | return true;
|
---|
243 | if ((major == IDE5_MAJOR) && !(minor & 0x3f))
|
---|
244 | return true;
|
---|
245 | if ((major == IDE6_MAJOR) && !(minor & 0x3f))
|
---|
246 | return true;
|
---|
247 | if ((major == IDE7_MAJOR) && !(minor & 0x3f))
|
---|
248 | return true;
|
---|
249 | if ((major == IDE8_MAJOR) && !(minor & 0x3f))
|
---|
250 | return true;
|
---|
251 | if ((major == IDE9_MAJOR) && !(minor & 0x3f))
|
---|
252 | return true;
|
---|
253 | if (major == 113 /* VIOCD_MAJOR */)
|
---|
254 | return true;
|
---|
255 | return false;
|
---|
256 | }
|
---|
257 |
|
---|
258 |
|
---|
259 | /**
|
---|
260 | * Send an SCSI INQUIRY command to a device and return selected information.
|
---|
261 | * @returns iprt status code
|
---|
262 | * @returns VERR_TRY_AGAIN if the query failed but might succeed next time
|
---|
263 | * @param pcszNode the full path to the device node
|
---|
264 | * @param pu8Type where to store the SCSI device type on success (optional)
|
---|
265 | * @param pchVendor where to store the vendor id string on success (optional)
|
---|
266 | * @param cchVendor the size of the @a pchVendor buffer
|
---|
267 | * @param pchModel where to store the product id string on success (optional)
|
---|
268 | * @param cchModel the size of the @a pchModel buffer
|
---|
269 | * @note check documentation on the SCSI INQUIRY command and the Linux kernel
|
---|
270 | * SCSI headers included above if you want to understand what is going
|
---|
271 | * on in this method.
|
---|
272 | */
|
---|
273 | static int cdromDoInquiry(const char *pcszNode, uint8_t *pu8Type,
|
---|
274 | char *pchVendor, size_t cchVendor, char *pchModel,
|
---|
275 | size_t cchModel)
|
---|
276 | {
|
---|
277 | LogRelFlowFunc(("pcszNode=%s, pu8Type=%p, pchVendor=%p, cchVendor=%llu, pchModel=%p, cchModel=%llu\n",
|
---|
278 | pcszNode, pu8Type, pchVendor, cchVendor, pchModel,
|
---|
279 | cchModel));
|
---|
280 | AssertPtrReturn(pcszNode, VERR_INVALID_POINTER);
|
---|
281 | AssertPtrNullReturn(pu8Type, VERR_INVALID_POINTER);
|
---|
282 | AssertPtrNullReturn(pchVendor, VERR_INVALID_POINTER);
|
---|
283 | AssertPtrNullReturn(pchModel, VERR_INVALID_POINTER);
|
---|
284 |
|
---|
285 | RTFILE hFile;
|
---|
286 | int rc = RTFileOpen(&hFile, pcszNode, RTFILE_O_READ | RTFILE_O_OPEN | RTFILE_O_DENY_NONE | RTFILE_O_NON_BLOCK);
|
---|
287 | if (RT_SUCCESS(rc))
|
---|
288 | {
|
---|
289 | int rcIoCtl = 0;
|
---|
290 | unsigned char u8Response[96] = { 0 };
|
---|
291 | struct cdrom_generic_command CdromCommandReq;
|
---|
292 | RT_ZERO(CdromCommandReq);
|
---|
293 | CdromCommandReq.cmd[0] = INQUIRY;
|
---|
294 | CdromCommandReq.cmd[4] = sizeof(u8Response);
|
---|
295 | CdromCommandReq.buffer = u8Response;
|
---|
296 | CdromCommandReq.buflen = sizeof(u8Response);
|
---|
297 | CdromCommandReq.data_direction = CGC_DATA_READ;
|
---|
298 | CdromCommandReq.timeout = 5000; /* ms */
|
---|
299 | rc = RTFileIoCtl(hFile, CDROM_SEND_PACKET, &CdromCommandReq, 0, &rcIoCtl);
|
---|
300 | if (RT_SUCCESS(rc) && rcIoCtl < 0)
|
---|
301 | rc = RTErrConvertFromErrno(-CdromCommandReq.stat);
|
---|
302 | RTFileClose(hFile);
|
---|
303 |
|
---|
304 | if (RT_SUCCESS(rc))
|
---|
305 | {
|
---|
306 | if (pu8Type)
|
---|
307 | *pu8Type = u8Response[0] & 0x1f;
|
---|
308 | if (pchVendor)
|
---|
309 | RTStrPrintf(pchVendor, cchVendor, "%.8s",
|
---|
310 | &u8Response[8] /* vendor id string */);
|
---|
311 | if (pchModel)
|
---|
312 | RTStrPrintf(pchModel, cchModel, "%.16s",
|
---|
313 | &u8Response[16] /* product id string */);
|
---|
314 | LogRelFlowFunc(("returning success: type=%u, vendor=%.8s, product=%.16s\n",
|
---|
315 | u8Response[0] & 0x1f, &u8Response[8], &u8Response[16]));
|
---|
316 | return VINF_SUCCESS;
|
---|
317 | }
|
---|
318 | }
|
---|
319 | LogRelFlowFunc(("returning %Rrc\n", rc));
|
---|
320 | return rc;
|
---|
321 | }
|
---|
322 |
|
---|
323 |
|
---|
324 | /**
|
---|
325 | * Initialise the device strings (description and UDI) for a DVD drive based on
|
---|
326 | * vendor and model name strings.
|
---|
327 | * @param pcszVendor the vendor ID string
|
---|
328 | * @param pcszModel the product ID string
|
---|
329 | * @param pszDesc where to store the description string (optional)
|
---|
330 | * @param cchDesc the size of the buffer in @a pszDesc
|
---|
331 | * @param pszUdi where to store the UDI string (optional)
|
---|
332 | * @param cchUdi the size of the buffer in @a pszUdi
|
---|
333 | */
|
---|
334 | /* static */
|
---|
335 | void dvdCreateDeviceStrings(const char *pcszVendor, const char *pcszModel,
|
---|
336 | char *pszDesc, size_t cchDesc, char *pszUdi,
|
---|
337 | size_t cchUdi)
|
---|
338 | {
|
---|
339 | AssertPtrReturnVoid(pcszVendor);
|
---|
340 | AssertPtrReturnVoid(pcszModel);
|
---|
341 | AssertPtrNullReturnVoid(pszDesc);
|
---|
342 | AssertReturnVoid(!pszDesc || cchDesc > 0);
|
---|
343 | AssertPtrNullReturnVoid(pszUdi);
|
---|
344 | AssertReturnVoid(!pszUdi || cchUdi > 0);
|
---|
345 | char szCleaned[128];
|
---|
346 | size_t cchVendor = strLenStripped(pcszVendor);
|
---|
347 | size_t cchModel = strLenStripped(pcszModel);
|
---|
348 |
|
---|
349 | /* Create a cleaned version of the model string for the UDI string. */
|
---|
350 | for (unsigned i = 0; i < sizeof(szCleaned) && pcszModel[i] != '\0'; ++i)
|
---|
351 | if ( (pcszModel[i] >= '0' && pcszModel[i] <= '9')
|
---|
352 | || (pcszModel[i] >= 'A' && pcszModel[i] <= 'z'))
|
---|
353 | szCleaned[i] = pcszModel[i];
|
---|
354 | else
|
---|
355 | szCleaned[i] = '_';
|
---|
356 | szCleaned[RT_MIN(cchModel, sizeof(szCleaned) - 1)] = '\0';
|
---|
357 |
|
---|
358 | /* Construct the description string as "Vendor Product" */
|
---|
359 | if (pszDesc)
|
---|
360 | {
|
---|
361 | if (cchVendor > 0)
|
---|
362 | RTStrPrintf(pszDesc, cchDesc, "%.*s %s", cchVendor, pcszVendor,
|
---|
363 | cchModel > 0 ? pcszModel : "(unknown drive model)");
|
---|
364 | else
|
---|
365 | RTStrPrintf(pszDesc, cchDesc, "%s", pcszModel);
|
---|
366 | }
|
---|
367 | /* Construct the UDI string */
|
---|
368 | if (pszUdi)
|
---|
369 | {
|
---|
370 | if (cchModel > 0)
|
---|
371 | RTStrPrintf(pszUdi, cchUdi,
|
---|
372 | "/org/freedesktop/Hal/devices/storage_model_%s",
|
---|
373 | szCleaned);
|
---|
374 | else
|
---|
375 | pszUdi[0] = '\0';
|
---|
376 | }
|
---|
377 | }
|
---|
378 |
|
---|
379 |
|
---|
380 | /**
|
---|
381 | * Check whether a device node points to a valid device and create a UDI and
|
---|
382 | * a description for it, and store the device number, if it does.
|
---|
383 | * @returns true if the device is valid, false otherwise
|
---|
384 | * @param pcszNode the path to the device node
|
---|
385 | * @param isDVD are we looking for a DVD device (or a floppy device)?
|
---|
386 | * @param pDevice where to store the device node (optional)
|
---|
387 | * @param pszDesc where to store the device description (optional)
|
---|
388 | * @param cchDesc the size of the buffer in @a pszDesc
|
---|
389 | * @param pszUdi where to store the device UDI (optional)
|
---|
390 | * @param cchUdi the size of the buffer in @a pszUdi
|
---|
391 | */
|
---|
392 | static bool devValidateDevice(const char *pcszNode, bool isDVD, dev_t *pDevice,
|
---|
393 | char *pszDesc, size_t cchDesc, char *pszUdi,
|
---|
394 | size_t cchUdi)
|
---|
395 | {
|
---|
396 | AssertPtrReturn(pcszNode, false);
|
---|
397 | AssertPtrNullReturn(pDevice, false);
|
---|
398 | AssertPtrNullReturn(pszDesc, false);
|
---|
399 | AssertReturn(!pszDesc || cchDesc > 0, false);
|
---|
400 | AssertPtrNullReturn(pszUdi, false);
|
---|
401 | AssertReturn(!pszUdi || cchUdi > 0, false);
|
---|
402 | RTFSOBJINFO ObjInfo;
|
---|
403 | if (RT_FAILURE(RTPathQueryInfo(pcszNode, &ObjInfo, RTFSOBJATTRADD_UNIX)))
|
---|
404 | return false;
|
---|
405 | if (!RTFS_IS_DEV_BLOCK(ObjInfo.Attr.fMode))
|
---|
406 | return false;
|
---|
407 | if (pDevice)
|
---|
408 | *pDevice = ObjInfo.Attr.u.Unix.Device;
|
---|
409 | if (isDVD)
|
---|
410 | {
|
---|
411 | char szVendor[128], szModel[128];
|
---|
412 | uint8_t u8Type;
|
---|
413 | if (!isCdromDevNum(ObjInfo.Attr.u.Unix.Device))
|
---|
414 | return false;
|
---|
415 | if (RT_FAILURE(cdromDoInquiry(pcszNode, &u8Type,
|
---|
416 | szVendor, sizeof(szVendor),
|
---|
417 | szModel, sizeof(szModel))))
|
---|
418 | return false;
|
---|
419 | if (u8Type != TYPE_ROM)
|
---|
420 | return false;
|
---|
421 | dvdCreateDeviceStrings(szVendor, szModel, pszDesc, cchDesc,
|
---|
422 | pszUdi, cchUdi);
|
---|
423 | }
|
---|
424 | else
|
---|
425 | {
|
---|
426 | /* Floppies on Linux are legacy devices with hardcoded majors and
|
---|
427 | * minors */
|
---|
428 | unsigned Number;
|
---|
429 | floppy_drive_name szName;
|
---|
430 | if (major(ObjInfo.Attr.u.Unix.Device) != FLOPPY_MAJOR)
|
---|
431 | return false;
|
---|
432 | switch (minor(ObjInfo.Attr.u.Unix.Device))
|
---|
433 | {
|
---|
434 | case 0: case 1: case 2: case 3:
|
---|
435 | Number = minor(ObjInfo.Attr.u.Unix.Device);
|
---|
436 | break;
|
---|
437 | case 128: case 129: case 130: case 131:
|
---|
438 | Number = minor(ObjInfo.Attr.u.Unix.Device) - 128 + 4;
|
---|
439 | break;
|
---|
440 | default:
|
---|
441 | return false;
|
---|
442 | }
|
---|
443 | if (!floppyGetName(pcszNode, Number, szName))
|
---|
444 | return false;
|
---|
445 | floppyCreateDeviceStrings(szName, Number, pszDesc, cchDesc, pszUdi,
|
---|
446 | cchUdi);
|
---|
447 | }
|
---|
448 | return true;
|
---|
449 | }
|
---|
450 |
|
---|
451 |
|
---|
452 | int VBoxMainDriveInfo::updateDVDs ()
|
---|
453 | {
|
---|
454 | LogFlowThisFunc(("entered\n"));
|
---|
455 | int rc = VINF_SUCCESS;
|
---|
456 | bool success = false; /* Have we succeeded in finding anything yet? */
|
---|
457 | try
|
---|
458 | {
|
---|
459 | mDVDList.clear ();
|
---|
460 | /* Always allow the user to override our auto-detection using an
|
---|
461 | * environment variable. */
|
---|
462 | if (RT_SUCCESS(rc) && (!success || testing()))
|
---|
463 | rc = getDriveInfoFromEnv ("VBOX_CDROM", &mDVDList, true /* isDVD */,
|
---|
464 | &success);
|
---|
465 | setNoProbe(false);
|
---|
466 | if (RT_SUCCESS(rc) && (!success || testing()))
|
---|
467 | rc = getDriveInfoFromSysfs(&mDVDList, true /* isDVD */, &success);
|
---|
468 | if (RT_SUCCESS(rc) && testing())
|
---|
469 | {
|
---|
470 | setNoProbe(true);
|
---|
471 | rc = getDriveInfoFromSysfs(&mDVDList, true /* isDVD */, &success);
|
---|
472 | }
|
---|
473 | }
|
---|
474 | catch(std::bad_alloc &e)
|
---|
475 | {
|
---|
476 | rc = VERR_NO_MEMORY;
|
---|
477 | }
|
---|
478 | LogFlowThisFunc(("rc=%Rrc\n", rc));
|
---|
479 | return rc;
|
---|
480 | }
|
---|
481 |
|
---|
482 | int VBoxMainDriveInfo::updateFloppies ()
|
---|
483 | {
|
---|
484 | LogFlowThisFunc(("entered\n"));
|
---|
485 | int rc = VINF_SUCCESS;
|
---|
486 | bool success = false; /* Have we succeeded in finding anything yet? */
|
---|
487 | try
|
---|
488 | {
|
---|
489 | mFloppyList.clear ();
|
---|
490 | if (RT_SUCCESS(rc) && (!success || testing()))
|
---|
491 | rc = getDriveInfoFromEnv("VBOX_FLOPPY", &mFloppyList,
|
---|
492 | false /* isDVD */, &success);
|
---|
493 | setNoProbe(false);
|
---|
494 | if ( RT_SUCCESS(rc) && (!success || testing()))
|
---|
495 | rc = getDriveInfoFromSysfs(&mFloppyList, false /* isDVD */,
|
---|
496 | &success);
|
---|
497 | if (RT_SUCCESS(rc) && testing())
|
---|
498 | {
|
---|
499 | setNoProbe(true);
|
---|
500 | rc = getDriveInfoFromSysfs(&mFloppyList, false /* isDVD */, &success);
|
---|
501 | }
|
---|
502 | }
|
---|
503 | catch(std::bad_alloc &e)
|
---|
504 | {
|
---|
505 | rc = VERR_NO_MEMORY;
|
---|
506 | }
|
---|
507 | LogFlowThisFunc(("rc=%Rrc\n", rc));
|
---|
508 | return rc;
|
---|
509 | }
|
---|
510 |
|
---|
511 |
|
---|
512 | /**
|
---|
513 | * Extract the names of drives from an environment variable and add them to a
|
---|
514 | * list if they are valid.
|
---|
515 | * @returns iprt status code
|
---|
516 | * @param pcszVar the name of the environment variable. The variable
|
---|
517 | * value should be a list of device node names, separated
|
---|
518 | * by ':' characters.
|
---|
519 | * @param pList the list to append the drives found to
|
---|
520 | * @param isDVD are we looking for DVD drives or for floppies?
|
---|
521 | * @param pfSuccess this will be set to true if we found at least one drive
|
---|
522 | * and to false otherwise. Optional.
|
---|
523 | */
|
---|
524 | /* static */
|
---|
525 | int getDriveInfoFromEnv(const char *pcszVar, DriveInfoList *pList,
|
---|
526 | bool isDVD, bool *pfSuccess)
|
---|
527 | {
|
---|
528 | AssertPtrReturn(pcszVar, VERR_INVALID_POINTER);
|
---|
529 | AssertPtrReturn(pList, VERR_INVALID_POINTER);
|
---|
530 | AssertPtrNullReturn(pfSuccess, VERR_INVALID_POINTER);
|
---|
531 | LogFlowFunc(("pcszVar=%s, pList=%p, isDVD=%d, pfSuccess=%p\n", pcszVar,
|
---|
532 | pList, isDVD, pfSuccess));
|
---|
533 | int rc = VINF_SUCCESS;
|
---|
534 | bool success = false;
|
---|
535 | char *pszFreeMe = RTEnvDupEx(RTENV_DEFAULT, pcszVar);
|
---|
536 |
|
---|
537 | try
|
---|
538 | {
|
---|
539 | const char *pcszCurrent = pszFreeMe;
|
---|
540 | while (pcszCurrent && *pcszCurrent != '\0')
|
---|
541 | {
|
---|
542 | const char *pcszNext = strchr(pcszCurrent, ':');
|
---|
543 | char szPath[RTPATH_MAX], szReal[RTPATH_MAX];
|
---|
544 | char szDesc[256], szUdi[256];
|
---|
545 | if (pcszNext)
|
---|
546 | RTStrPrintf(szPath, sizeof(szPath), "%.*s",
|
---|
547 | pcszNext - pcszCurrent - 1, pcszCurrent);
|
---|
548 | else
|
---|
549 | RTStrPrintf(szPath, sizeof(szPath), "%s", pcszCurrent);
|
---|
550 | if ( RT_SUCCESS(RTPathReal(szPath, szReal, sizeof(szReal)))
|
---|
551 | && devValidateDevice(szReal, isDVD, NULL, szDesc,
|
---|
552 | sizeof(szDesc), szUdi, sizeof(szUdi)))
|
---|
553 | {
|
---|
554 | pList->push_back(DriveInfo(szReal, szUdi, szDesc));
|
---|
555 | success = true;
|
---|
556 | }
|
---|
557 | pcszCurrent = pcszNext ? pcszNext + 1 : NULL;
|
---|
558 | }
|
---|
559 | if (pfSuccess != NULL)
|
---|
560 | *pfSuccess = success;
|
---|
561 | }
|
---|
562 | catch(std::bad_alloc &e)
|
---|
563 | {
|
---|
564 | rc = VERR_NO_MEMORY;
|
---|
565 | }
|
---|
566 | RTStrFree(pszFreeMe);
|
---|
567 | LogFlowFunc(("rc=%Rrc, success=%d\n", rc, success));
|
---|
568 | return rc;
|
---|
569 | }
|
---|
570 |
|
---|
571 |
|
---|
572 | class sysfsBlockDev
|
---|
573 | {
|
---|
574 | public:
|
---|
575 | sysfsBlockDev(const char *pcszName, bool wantDVD)
|
---|
576 | : mpcszName(pcszName), mwantDVD(wantDVD), misConsistent(true),
|
---|
577 | misValid(false)
|
---|
578 | {
|
---|
579 | if (findDeviceNode())
|
---|
580 | {
|
---|
581 | if (mwantDVD)
|
---|
582 | validateAndInitForDVD();
|
---|
583 | else
|
---|
584 | validateAndInitForFloppy();
|
---|
585 | }
|
---|
586 | }
|
---|
587 | private:
|
---|
588 | /** The name of the subdirectory of /sys/block for this device */
|
---|
589 | const char *mpcszName;
|
---|
590 | /** Are we looking for a floppy or a DVD device? */
|
---|
591 | bool mwantDVD;
|
---|
592 | /** The device node for the device */
|
---|
593 | char mszNode[RTPATH_MAX];
|
---|
594 | /** Does the sysfs entry look like we expect it too? This is a canary
|
---|
595 | * for future sysfs ABI changes. */
|
---|
596 | bool misConsistent;
|
---|
597 | /** Is this entry a valid specimen of what we are looking for? */
|
---|
598 | bool misValid;
|
---|
599 | /** Human readable drive description string */
|
---|
600 | char mszDesc[256];
|
---|
601 | /** Unique identifier for the drive. Should be identical to hal's UDI for
|
---|
602 | * the device. May not be unique for two identical drives. */
|
---|
603 | char mszUdi[256];
|
---|
604 | private:
|
---|
605 | /* Private methods */
|
---|
606 |
|
---|
607 | /**
|
---|
608 | * Fill in the device node member based on the /sys/block subdirectory.
|
---|
609 | * @returns boolean success value
|
---|
610 | */
|
---|
611 | bool findDeviceNode()
|
---|
612 | {
|
---|
613 | dev_t dev = 0;
|
---|
614 | int rc = RTLinuxSysFsReadDevNumFile(&dev, "block/%s/dev", mpcszName);
|
---|
615 | if (RT_FAILURE(rc) || dev == 0)
|
---|
616 | {
|
---|
617 | misConsistent = false;
|
---|
618 | return false;
|
---|
619 | }
|
---|
620 | rc = RTLinuxCheckDevicePath(dev, RTFS_TYPE_DEV_BLOCK, mszNode,
|
---|
621 | sizeof(mszNode), "%s", mpcszName);
|
---|
622 | if (RT_FAILURE(rc))
|
---|
623 | return false;
|
---|
624 | return true;
|
---|
625 | }
|
---|
626 |
|
---|
627 | /** Check whether the sysfs block entry is valid for a DVD device and
|
---|
628 | * initialise the string data members for the object. We try to get all
|
---|
629 | * the information we need from sysfs if possible, to avoid unnecessarily
|
---|
630 | * poking the device, and if that fails we fall back to an SCSI INQUIRY
|
---|
631 | * command. */
|
---|
632 | void validateAndInitForDVD()
|
---|
633 | {
|
---|
634 | char szVendor[128], szModel[128];
|
---|
635 | int64_t type = 0;
|
---|
636 | int rc = RTLinuxSysFsReadIntFile(10, &type, "block/%s/device/type", mpcszName);
|
---|
637 | if (RT_SUCCESS(rc) && type != TYPE_ROM)
|
---|
638 | return;
|
---|
639 | if (type == TYPE_ROM)
|
---|
640 | {
|
---|
641 | rc = RTLinuxSysFsReadStrFile(szVendor, sizeof(szVendor), NULL,
|
---|
642 | "block/%s/device/vendor", mpcszName);
|
---|
643 | if (RT_SUCCESS(rc))
|
---|
644 | {
|
---|
645 | rc = RTLinuxSysFsReadStrFile(szModel, sizeof(szModel), NULL,
|
---|
646 | "block/%s/device/model", mpcszName);
|
---|
647 | if (RT_SUCCESS(rc))
|
---|
648 | {
|
---|
649 | misValid = true;
|
---|
650 | dvdCreateDeviceStrings(szVendor, szModel,
|
---|
651 | mszDesc, sizeof(mszDesc),
|
---|
652 | mszUdi, sizeof(mszUdi));
|
---|
653 | return;
|
---|
654 | }
|
---|
655 | }
|
---|
656 | }
|
---|
657 | if (!noProbe())
|
---|
658 | probeAndInitForDVD();
|
---|
659 | }
|
---|
660 |
|
---|
661 | /** Try to find out whether a device is a DVD drive by sending it an
|
---|
662 | * SCSI INQUIRY command. If it is, initialise the string and validity
|
---|
663 | * data members for the object based on the returned data.
|
---|
664 | */
|
---|
665 | void probeAndInitForDVD()
|
---|
666 | {
|
---|
667 | AssertReturnVoid(mszNode[0] != '\0');
|
---|
668 | uint8_t u8Type = 0;
|
---|
669 | char szVendor[128] = "";
|
---|
670 | char szModel[128] = "";
|
---|
671 | int rc = cdromDoInquiry(mszNode, &u8Type, szVendor,
|
---|
672 | sizeof(szVendor), szModel,
|
---|
673 | sizeof(szModel));
|
---|
674 | if (RT_SUCCESS(rc) && (u8Type == TYPE_ROM))
|
---|
675 | {
|
---|
676 | misValid = true;
|
---|
677 | dvdCreateDeviceStrings(szVendor, szModel, mszDesc, sizeof(mszDesc),
|
---|
678 | mszUdi, sizeof(mszUdi));
|
---|
679 | }
|
---|
680 | }
|
---|
681 |
|
---|
682 | /** Check whether the sysfs block entry is valid for a floppy device and
|
---|
683 | * initialise the string data members for the object. Since we only
|
---|
684 | * support floppies using the basic "floppy" driver, we check the driver
|
---|
685 | * using the entry name and a driver-specific ioctl. */
|
---|
686 | void validateAndInitForFloppy()
|
---|
687 | {
|
---|
688 | bool haveName = false;
|
---|
689 | floppy_drive_name szName;
|
---|
690 | char szDriver[8];
|
---|
691 | if ( mpcszName[0] != 'f'
|
---|
692 | || mpcszName[1] != 'd'
|
---|
693 | || mpcszName[2] < '0'
|
---|
694 | || mpcszName[2] > '7'
|
---|
695 | || mpcszName[3] != '\0')
|
---|
696 | return;
|
---|
697 | if (!noProbe())
|
---|
698 | haveName = floppyGetName(mszNode, mpcszName[2] - '0', szName);
|
---|
699 | int rc = RTLinuxSysFsGetLinkDest(szDriver, sizeof(szDriver), NULL, "block/%s/%s",
|
---|
700 | mpcszName, "device/driver");
|
---|
701 | if (RT_SUCCESS(rc))
|
---|
702 | {
|
---|
703 | if (RTStrCmp(szDriver, "floppy"))
|
---|
704 | return;
|
---|
705 | }
|
---|
706 | else if (!haveName)
|
---|
707 | return;
|
---|
708 | floppyCreateDeviceStrings(haveName ? szName : NULL,
|
---|
709 | mpcszName[2] - '0', mszDesc,
|
---|
710 | sizeof(mszDesc), mszUdi, sizeof(mszUdi));
|
---|
711 | misValid = true;
|
---|
712 | }
|
---|
713 |
|
---|
714 | public:
|
---|
715 | bool isConsistent()
|
---|
716 | {
|
---|
717 | return misConsistent;
|
---|
718 | }
|
---|
719 | bool isValid()
|
---|
720 | {
|
---|
721 | return misValid;
|
---|
722 | }
|
---|
723 | const char *getDesc()
|
---|
724 | {
|
---|
725 | return mszDesc;
|
---|
726 | }
|
---|
727 | const char *getUdi()
|
---|
728 | {
|
---|
729 | return mszUdi;
|
---|
730 | }
|
---|
731 | const char *getNode()
|
---|
732 | {
|
---|
733 | return mszNode;
|
---|
734 | }
|
---|
735 | };
|
---|
736 |
|
---|
737 | /**
|
---|
738 | * Helper function to query the sysfs subsystem for information about DVD
|
---|
739 | * drives attached to the system.
|
---|
740 | * @returns iprt status code
|
---|
741 | * @param pList where to add information about the drives detected
|
---|
742 | * @param isDVD are we looking for DVDs or floppies?
|
---|
743 | * @param pfSuccess Did we find anything?
|
---|
744 | *
|
---|
745 | * @returns IPRT status code
|
---|
746 | */
|
---|
747 | /* static */
|
---|
748 | int getDriveInfoFromSysfs(DriveInfoList *pList, bool isDVD, bool *pfSuccess)
|
---|
749 | {
|
---|
750 | AssertPtrReturn(pList, VERR_INVALID_POINTER);
|
---|
751 | AssertPtrNullReturn(pfSuccess, VERR_INVALID_POINTER); /* Valid or Null */
|
---|
752 | LogFlowFunc (("pList=%p, isDVD=%u, pfSuccess=%p\n",
|
---|
753 | pList, (unsigned) isDVD, pfSuccess));
|
---|
754 | PRTDIR pDir = NULL;
|
---|
755 | int rc;
|
---|
756 | bool fSuccess = false;
|
---|
757 | unsigned cFound = 0;
|
---|
758 |
|
---|
759 | if (!RTPathExists("/sys"))
|
---|
760 | return VINF_SUCCESS;
|
---|
761 | rc = RTDirOpen(&pDir, "/sys/block");
|
---|
762 | /* This might mean that sysfs semantics have changed */
|
---|
763 | AssertReturn(rc != VERR_FILE_NOT_FOUND, VINF_SUCCESS);
|
---|
764 | fSuccess = true;
|
---|
765 | if (RT_SUCCESS(rc))
|
---|
766 | for (;;)
|
---|
767 | {
|
---|
768 | RTDIRENTRY entry;
|
---|
769 | rc = RTDirRead(pDir, &entry, NULL);
|
---|
770 | Assert(rc != VERR_BUFFER_OVERFLOW); /* Should never happen... */
|
---|
771 | if (RT_FAILURE(rc)) /* Including overflow and no more files */
|
---|
772 | break;
|
---|
773 | if (entry.szName[0] == '.')
|
---|
774 | continue;
|
---|
775 | sysfsBlockDev dev(entry.szName, isDVD);
|
---|
776 | /* This might mean that sysfs semantics have changed */
|
---|
777 | AssertBreakStmt(dev.isConsistent(), fSuccess = false);
|
---|
778 | if (!dev.isValid())
|
---|
779 | continue;
|
---|
780 | try
|
---|
781 | {
|
---|
782 | pList->push_back(DriveInfo(dev.getNode(), dev.getUdi(),
|
---|
783 | dev.getDesc()));
|
---|
784 | }
|
---|
785 | catch(std::bad_alloc &e)
|
---|
786 | {
|
---|
787 | rc = VERR_NO_MEMORY;
|
---|
788 | break;
|
---|
789 | }
|
---|
790 | ++cFound;
|
---|
791 | }
|
---|
792 | RTDirClose(pDir);
|
---|
793 | if (rc == VERR_NO_MORE_FILES)
|
---|
794 | rc = VINF_SUCCESS;
|
---|
795 | if (RT_FAILURE(rc))
|
---|
796 | /* Clean up again */
|
---|
797 | for (unsigned i = 0; i < cFound; ++i)
|
---|
798 | pList->pop_back();
|
---|
799 | if (pfSuccess)
|
---|
800 | *pfSuccess = fSuccess;
|
---|
801 | LogFlow (("rc=%Rrc, fSuccess=%u\n", rc, (unsigned) fSuccess));
|
---|
802 | return rc;
|
---|
803 | }
|
---|
804 |
|
---|
805 |
|
---|
806 | /** Helper for readFilePathsFromDir(). Adds a path to the vector if it is not
|
---|
807 | * NULL and not a dotfile (".", "..", ".*"). */
|
---|
808 | static int maybeAddPathToVector(const char *pcszPath, const char *pcszEntry,
|
---|
809 | VECTOR_PTR(char *) *pvecpchDevs)
|
---|
810 | {
|
---|
811 | char *pszPath;
|
---|
812 |
|
---|
813 | if (!pcszPath)
|
---|
814 | return 0;
|
---|
815 | if (pcszEntry[0] == '.')
|
---|
816 | return 0;
|
---|
817 | pszPath = RTStrDup(pcszPath);
|
---|
818 | if (!pszPath)
|
---|
819 | return ENOMEM;
|
---|
820 | if (RT_FAILURE(VEC_PUSH_BACK_PTR(pvecpchDevs, char *, pszPath)))
|
---|
821 | return ENOMEM;
|
---|
822 | return 0;
|
---|
823 | }
|
---|
824 |
|
---|
825 | /** Helper for readFilePaths(). Adds the entries from the open directory
|
---|
826 | * @a pDir to the vector @a pvecpchDevs using either the full path or the
|
---|
827 | * realpath() and skipping hidden files and files on which realpath() fails. */
|
---|
828 | static int readFilePathsFromDir(const char *pcszPath, DIR *pDir,
|
---|
829 | VECTOR_PTR(char *) *pvecpchDevs, int withRealPath)
|
---|
830 | {
|
---|
831 | struct dirent entry, *pResult;
|
---|
832 | int err;
|
---|
833 |
|
---|
834 | #if RT_GNUC_PREREQ(4, 6)
|
---|
835 | # pragma GCC diagnostic push
|
---|
836 | # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
|
---|
837 | #endif
|
---|
838 | for (err = readdir_r(pDir, &entry, &pResult); pResult;
|
---|
839 | err = readdir_r(pDir, &entry, &pResult))
|
---|
840 | #if RT_GNUC_PREREQ(4, 6)
|
---|
841 | # pragma GCC diagnostic pop
|
---|
842 | #endif
|
---|
843 | {
|
---|
844 | /* We (implicitly) require that PATH_MAX be defined */
|
---|
845 | char szPath[PATH_MAX + 1], szRealPath[PATH_MAX + 1], *pszPath;
|
---|
846 | if (snprintf(szPath, sizeof(szPath), "%s/%s", pcszPath,
|
---|
847 | entry.d_name) < 0)
|
---|
848 | return errno;
|
---|
849 | if (withRealPath)
|
---|
850 | pszPath = realpath(szPath, szRealPath);
|
---|
851 | else
|
---|
852 | pszPath = szPath;
|
---|
853 | if ((err = maybeAddPathToVector(pszPath, entry.d_name, pvecpchDevs)))
|
---|
854 | return err;
|
---|
855 | }
|
---|
856 | return err;
|
---|
857 | }
|
---|
858 |
|
---|
859 |
|
---|
860 | /**
|
---|
861 | * Helper for walkDirectory to dump the names of a directory's entries into a
|
---|
862 | * vector of char pointers.
|
---|
863 | *
|
---|
864 | * @returns zero on success or (positive) posix error value.
|
---|
865 | * @param pcszPath the path to dump.
|
---|
866 | * @param pvecpchDevs an empty vector of char pointers - must be cleaned up
|
---|
867 | * by the caller even on failure.
|
---|
868 | * @param withRealPath whether to canonicalise the filename with realpath
|
---|
869 | */
|
---|
870 | static int readFilePaths(const char *pcszPath, VECTOR_PTR(char *) *pvecpchDevs,
|
---|
871 | int withRealPath)
|
---|
872 | {
|
---|
873 | DIR *pDir;
|
---|
874 | int err;
|
---|
875 |
|
---|
876 | AssertPtrReturn(pvecpchDevs, EINVAL);
|
---|
877 | AssertReturn(VEC_SIZE_PTR(pvecpchDevs) == 0, EINVAL);
|
---|
878 | AssertPtrReturn(pcszPath, EINVAL);
|
---|
879 |
|
---|
880 | pDir = opendir(pcszPath);
|
---|
881 | if (!pDir)
|
---|
882 | return RTErrConvertFromErrno(errno);
|
---|
883 | err = readFilePathsFromDir(pcszPath, pDir, pvecpchDevs, withRealPath);
|
---|
884 | if (closedir(pDir) < 0 && !err)
|
---|
885 | err = errno;
|
---|
886 | return RTErrConvertFromErrno(err);
|
---|
887 | }
|
---|
888 |
|
---|
889 |
|
---|
890 | class hotplugNullImpl : public VBoxMainHotplugWaiterImpl
|
---|
891 | {
|
---|
892 | public:
|
---|
893 | hotplugNullImpl(const char *) {}
|
---|
894 | virtual ~hotplugNullImpl (void) {}
|
---|
895 | /** @copydoc VBoxMainHotplugWaiter::Wait */
|
---|
896 | virtual int Wait (RTMSINTERVAL cMillies)
|
---|
897 | {
|
---|
898 | NOREF(cMillies);
|
---|
899 | return VERR_NOT_SUPPORTED;
|
---|
900 | }
|
---|
901 | /** @copydoc VBoxMainHotplugWaiter::Interrupt */
|
---|
902 | virtual void Interrupt (void) {}
|
---|
903 | virtual int getStatus(void)
|
---|
904 | {
|
---|
905 | return VERR_NOT_SUPPORTED;
|
---|
906 | }
|
---|
907 |
|
---|
908 | };
|
---|
909 |
|
---|
910 | #ifdef VBOX_USB_WITH_SYSFS
|
---|
911 | # ifdef VBOX_USB_WITH_INOTIFY
|
---|
912 | /** Class wrapper around an inotify watch (or a group of them to be precise).
|
---|
913 | */
|
---|
914 | typedef struct inotifyWatch
|
---|
915 | {
|
---|
916 | /** Pointer to the inotify_add_watch() glibc function/Linux API */
|
---|
917 | int (*inotify_add_watch)(int, const char *, uint32_t);
|
---|
918 | /** The native handle of the inotify fd. */
|
---|
919 | int mhInotify;
|
---|
920 | } inotifyWatch;
|
---|
921 |
|
---|
922 | /** The flags we pass to inotify - modify, create, delete, change permissions
|
---|
923 | */
|
---|
924 | #define IN_FLAGS 0x306
|
---|
925 |
|
---|
926 | static int iwAddWatch(inotifyWatch *pSelf, const char *pcszPath)
|
---|
927 | {
|
---|
928 | errno = 0;
|
---|
929 | if ( pSelf->inotify_add_watch(pSelf->mhInotify, pcszPath, IN_FLAGS) >= 0
|
---|
930 | || (errno == EACCES))
|
---|
931 | return VINF_SUCCESS;
|
---|
932 | /* Other errors listed in the manpage can be treated as fatal */
|
---|
933 | return RTErrConvertFromErrno(errno);
|
---|
934 | }
|
---|
935 |
|
---|
936 | /** Object initialisation */
|
---|
937 | static int iwInit(inotifyWatch *pSelf)
|
---|
938 | {
|
---|
939 | int (*inotify_init)(void);
|
---|
940 | int fd, flags;
|
---|
941 | int rc = VINF_SUCCESS;
|
---|
942 |
|
---|
943 | AssertPtr(pSelf);
|
---|
944 | pSelf->mhInotify = -1;
|
---|
945 | errno = 0;
|
---|
946 | *(void **)(&inotify_init) = dlsym(RTLD_DEFAULT, "inotify_init");
|
---|
947 | if (!inotify_init)
|
---|
948 | return VERR_LDR_IMPORTED_SYMBOL_NOT_FOUND;
|
---|
949 | *(void **)(&pSelf->inotify_add_watch)
|
---|
950 | = dlsym(RTLD_DEFAULT, "inotify_add_watch");
|
---|
951 | if (!pSelf->inotify_add_watch)
|
---|
952 | return VERR_LDR_IMPORTED_SYMBOL_NOT_FOUND;
|
---|
953 | fd = inotify_init();
|
---|
954 | if (fd < 0)
|
---|
955 | {
|
---|
956 | Assert(errno > 0);
|
---|
957 | return RTErrConvertFromErrno(errno);
|
---|
958 | }
|
---|
959 | Assert(errno == 0);
|
---|
960 |
|
---|
961 | flags = fcntl(fd, F_GETFL, NULL);
|
---|
962 | if ( flags < 0
|
---|
963 | || fcntl(fd, F_SETFL, flags | O_NONBLOCK) < 0
|
---|
964 | || fcntl(fd, F_SETFD, FD_CLOEXEC) < 0 /* race here */)
|
---|
965 | {
|
---|
966 | Assert(errno > 0);
|
---|
967 | rc = RTErrConvertFromErrno(errno);
|
---|
968 | }
|
---|
969 | if (RT_FAILURE(rc))
|
---|
970 | close(fd);
|
---|
971 | else
|
---|
972 | {
|
---|
973 | Assert(errno == 0);
|
---|
974 | pSelf->mhInotify = fd;
|
---|
975 | }
|
---|
976 | return rc;
|
---|
977 | }
|
---|
978 |
|
---|
979 | static void iwTerm(inotifyWatch *pSelf)
|
---|
980 | {
|
---|
981 | AssertPtrReturnVoid(pSelf);
|
---|
982 | if (pSelf->mhInotify != -1)
|
---|
983 | {
|
---|
984 | close(pSelf->mhInotify);
|
---|
985 | pSelf->mhInotify = -1;
|
---|
986 | }
|
---|
987 | }
|
---|
988 |
|
---|
989 | static int iwGetFD(inotifyWatch *pSelf)
|
---|
990 | {
|
---|
991 | AssertPtrReturn(pSelf, -1);
|
---|
992 | return pSelf->mhInotify;
|
---|
993 | }
|
---|
994 |
|
---|
995 | # define SYSFS_WAKEUP_STRING "Wake up!"
|
---|
996 |
|
---|
997 | class hotplugInotifyImpl : public VBoxMainHotplugWaiterImpl
|
---|
998 | {
|
---|
999 | /** Pipe used to interrupt wait(), the read end. */
|
---|
1000 | int mhWakeupPipeR;
|
---|
1001 | /** Pipe used to interrupt wait(), the write end. */
|
---|
1002 | int mhWakeupPipeW;
|
---|
1003 | /** The inotify watch set */
|
---|
1004 | inotifyWatch mWatches;
|
---|
1005 | /** Flag to mark that the Wait() method is currently being called, and to
|
---|
1006 | * ensure that it isn't called multiple times in parallel. */
|
---|
1007 | volatile uint32_t mfWaiting;
|
---|
1008 | /** The root of the USB devices tree. */
|
---|
1009 | const char *mpcszDevicesRoot;
|
---|
1010 | /** iprt result code from object initialisation. Should be AssertReturn-ed
|
---|
1011 | * on at the start of all methods. I went this way because I didn't want
|
---|
1012 | * to deal with exceptions. */
|
---|
1013 | int mStatus;
|
---|
1014 | /** ID values associates with the wakeup pipe and the FAM socket for polling
|
---|
1015 | */
|
---|
1016 | enum
|
---|
1017 | {
|
---|
1018 | RPIPE_ID = 0,
|
---|
1019 | INOTIFY_ID,
|
---|
1020 | MAX_POLLID
|
---|
1021 | };
|
---|
1022 |
|
---|
1023 | /** Clean up any resources in use, gracefully skipping over any which have
|
---|
1024 | * not yet been allocated or already cleaned up. Intended to be called
|
---|
1025 | * from the destructor or after a failed initialisation. */
|
---|
1026 | void term(void);
|
---|
1027 |
|
---|
1028 | int drainInotify();
|
---|
1029 |
|
---|
1030 | /** Read the wakeup string from the wakeup pipe */
|
---|
1031 | int drainWakeupPipe(void);
|
---|
1032 | public:
|
---|
1033 | hotplugInotifyImpl(const char *pcszDevicesRoot);
|
---|
1034 | virtual ~hotplugInotifyImpl(void)
|
---|
1035 | {
|
---|
1036 | term();
|
---|
1037 | #ifdef DEBUG
|
---|
1038 | /** The first call to term should mark all resources as freed, so this
|
---|
1039 | * should be a semantic no-op. */
|
---|
1040 | term();
|
---|
1041 | #endif
|
---|
1042 | }
|
---|
1043 | /** Is inotify available and working on this system? If so we expect that
|
---|
1044 | * this implementation will be usable. */
|
---|
1045 | /** @todo test the "inotify in glibc but not in the kernel" case. */
|
---|
1046 | static bool Available(void)
|
---|
1047 | {
|
---|
1048 | int (*inotify_init)(void);
|
---|
1049 |
|
---|
1050 | *(void **)(&inotify_init) = dlsym(RTLD_DEFAULT, "inotify_init");
|
---|
1051 | if (!inotify_init)
|
---|
1052 | return false;
|
---|
1053 | int fd = inotify_init();
|
---|
1054 | if (fd == -1)
|
---|
1055 | return false;
|
---|
1056 | close(fd);
|
---|
1057 | return true;
|
---|
1058 | }
|
---|
1059 |
|
---|
1060 | virtual int getStatus(void)
|
---|
1061 | {
|
---|
1062 | return mStatus;
|
---|
1063 | }
|
---|
1064 |
|
---|
1065 | /** @copydoc VBoxMainHotplugWaiter::Wait */
|
---|
1066 | virtual int Wait(RTMSINTERVAL);
|
---|
1067 | /** @copydoc VBoxMainHotplugWaiter::Interrupt */
|
---|
1068 | virtual void Interrupt(void);
|
---|
1069 | };
|
---|
1070 |
|
---|
1071 | /** Simplified version of RTPipeCreate */
|
---|
1072 | static int pipeCreateSimple(int *phPipeRead, int *phPipeWrite)
|
---|
1073 | {
|
---|
1074 | AssertPtrReturn(phPipeRead, VERR_INVALID_POINTER);
|
---|
1075 | AssertPtrReturn(phPipeWrite, VERR_INVALID_POINTER);
|
---|
1076 |
|
---|
1077 | /*
|
---|
1078 | * Create the pipe and set the close-on-exec flag.
|
---|
1079 | */
|
---|
1080 | int aFds[2] = {-1, -1};
|
---|
1081 | if (pipe(aFds))
|
---|
1082 | return RTErrConvertFromErrno(errno);
|
---|
1083 | if ( fcntl(aFds[0], F_SETFD, FD_CLOEXEC) < 0
|
---|
1084 | || fcntl(aFds[1], F_SETFD, FD_CLOEXEC) < 0)
|
---|
1085 | {
|
---|
1086 | int rc = RTErrConvertFromErrno(errno);
|
---|
1087 | close(aFds[0]);
|
---|
1088 | close(aFds[1]);
|
---|
1089 | return rc;
|
---|
1090 | }
|
---|
1091 |
|
---|
1092 | *phPipeRead = aFds[0];
|
---|
1093 | *phPipeWrite = aFds[1];
|
---|
1094 |
|
---|
1095 | /*
|
---|
1096 | * Before we leave, make sure to shut up SIGPIPE.
|
---|
1097 | */
|
---|
1098 | signal(SIGPIPE, SIG_IGN);
|
---|
1099 | return VINF_SUCCESS;
|
---|
1100 | }
|
---|
1101 |
|
---|
1102 | hotplugInotifyImpl::hotplugInotifyImpl(const char *pcszDevicesRoot) :
|
---|
1103 | mhWakeupPipeR(-1), mhWakeupPipeW(-1), mfWaiting(0),
|
---|
1104 | mpcszDevicesRoot(pcszDevicesRoot), mStatus(VERR_WRONG_ORDER)
|
---|
1105 | {
|
---|
1106 | # ifdef DEBUG
|
---|
1107 | /* Excercise the code path (term() on a not-fully-initialised object) as
|
---|
1108 | * well as we can. On an uninitialised object this method is a semantic
|
---|
1109 | * no-op. */
|
---|
1110 | mWatches.mhInotify = -1; /* term will access this variable */
|
---|
1111 | term();
|
---|
1112 | /* For now this probing method should only be used if nothing else is
|
---|
1113 | * available */
|
---|
1114 | # endif
|
---|
1115 | int rc;
|
---|
1116 | do {
|
---|
1117 | if (RT_FAILURE(rc = iwInit(&mWatches)))
|
---|
1118 | break;
|
---|
1119 | if (RT_FAILURE(rc = iwAddWatch(&mWatches, mpcszDevicesRoot)))
|
---|
1120 | break;
|
---|
1121 | if (RT_FAILURE(rc = pipeCreateSimple(&mhWakeupPipeR, &mhWakeupPipeW)))
|
---|
1122 | break;
|
---|
1123 | } while (0);
|
---|
1124 | mStatus = rc;
|
---|
1125 | if (RT_FAILURE(rc))
|
---|
1126 | term();
|
---|
1127 | }
|
---|
1128 |
|
---|
1129 | void hotplugInotifyImpl::term(void)
|
---|
1130 | {
|
---|
1131 | /** This would probably be a pending segfault, so die cleanly */
|
---|
1132 | AssertRelease(!mfWaiting);
|
---|
1133 | if (mhWakeupPipeR != -1)
|
---|
1134 | {
|
---|
1135 | close(mhWakeupPipeR);
|
---|
1136 | mhWakeupPipeR = -1;
|
---|
1137 | }
|
---|
1138 | if (mhWakeupPipeW != -1)
|
---|
1139 | {
|
---|
1140 | close(mhWakeupPipeW);
|
---|
1141 | mhWakeupPipeW = -1;
|
---|
1142 | }
|
---|
1143 | iwTerm(&mWatches);
|
---|
1144 | }
|
---|
1145 |
|
---|
1146 | int hotplugInotifyImpl::drainInotify()
|
---|
1147 | {
|
---|
1148 | char chBuf[RTPATH_MAX + 256]; /* Should always be big enough */
|
---|
1149 | ssize_t cchRead;
|
---|
1150 |
|
---|
1151 | AssertRCReturn(mStatus, VERR_WRONG_ORDER);
|
---|
1152 | errno = 0;
|
---|
1153 | do {
|
---|
1154 | cchRead = read(iwGetFD(&mWatches), chBuf, sizeof(chBuf));
|
---|
1155 | } while (cchRead > 0);
|
---|
1156 | if (cchRead == 0)
|
---|
1157 | return VINF_SUCCESS;
|
---|
1158 | if ( cchRead < 0
|
---|
1159 | && ( errno == EAGAIN
|
---|
1160 | #if EAGAIN != EWOULDBLOCK
|
---|
1161 | || errno == EWOULDBLOCK
|
---|
1162 | #endif
|
---|
1163 | ))
|
---|
1164 | return VINF_SUCCESS;
|
---|
1165 | Assert(errno > 0);
|
---|
1166 | return RTErrConvertFromErrno(errno);
|
---|
1167 | }
|
---|
1168 |
|
---|
1169 | int hotplugInotifyImpl::drainWakeupPipe(void)
|
---|
1170 | {
|
---|
1171 | char szBuf[sizeof(SYSFS_WAKEUP_STRING)];
|
---|
1172 | ssize_t cbRead;
|
---|
1173 |
|
---|
1174 | AssertRCReturn(mStatus, VERR_WRONG_ORDER);
|
---|
1175 | cbRead = read(mhWakeupPipeR, szBuf, sizeof(szBuf));
|
---|
1176 | Assert(cbRead > 0);
|
---|
1177 | NOREF(cbRead);
|
---|
1178 | return VINF_SUCCESS;
|
---|
1179 | }
|
---|
1180 |
|
---|
1181 | int hotplugInotifyImpl::Wait(RTMSINTERVAL aMillies)
|
---|
1182 | {
|
---|
1183 | int rc;
|
---|
1184 | char **ppszEntry;
|
---|
1185 | VECTOR_PTR(char *) vecpchDevs;
|
---|
1186 |
|
---|
1187 | AssertRCReturn(mStatus, VERR_WRONG_ORDER);
|
---|
1188 | bool fEntered = ASMAtomicCmpXchgU32(&mfWaiting, 1, 0);
|
---|
1189 | AssertReturn(fEntered, VERR_WRONG_ORDER);
|
---|
1190 | VEC_INIT_PTR(&vecpchDevs, char *, RTStrFree);
|
---|
1191 | do {
|
---|
1192 | struct pollfd pollFD[MAX_POLLID];
|
---|
1193 |
|
---|
1194 | rc = readFilePaths(mpcszDevicesRoot, &vecpchDevs, false);
|
---|
1195 | if (RT_SUCCESS(rc))
|
---|
1196 | VEC_FOR_EACH(&vecpchDevs, char *, ppszEntry)
|
---|
1197 | if (RT_FAILURE(rc = iwAddWatch(&mWatches, *ppszEntry)))
|
---|
1198 | break;
|
---|
1199 | if (RT_FAILURE(rc))
|
---|
1200 | break;
|
---|
1201 | pollFD[RPIPE_ID].fd = mhWakeupPipeR;
|
---|
1202 | pollFD[RPIPE_ID].events = POLLIN;
|
---|
1203 | pollFD[INOTIFY_ID].fd = iwGetFD(&mWatches);
|
---|
1204 | pollFD[INOTIFY_ID].events = POLLIN | POLLERR | POLLHUP;
|
---|
1205 | errno = 0;
|
---|
1206 | int cPolled = poll(pollFD, RT_ELEMENTS(pollFD), aMillies);
|
---|
1207 | if (cPolled < 0)
|
---|
1208 | {
|
---|
1209 | Assert(errno > 0);
|
---|
1210 | rc = RTErrConvertFromErrno(errno);
|
---|
1211 | }
|
---|
1212 | else if (pollFD[RPIPE_ID].revents)
|
---|
1213 | {
|
---|
1214 | rc = drainWakeupPipe();
|
---|
1215 | if (RT_SUCCESS(rc))
|
---|
1216 | rc = VERR_INTERRUPTED;
|
---|
1217 | break;
|
---|
1218 | }
|
---|
1219 | else if (!(pollFD[INOTIFY_ID].revents))
|
---|
1220 | {
|
---|
1221 | AssertBreakStmt(cPolled == 0, rc = VERR_INTERNAL_ERROR);
|
---|
1222 | rc = VERR_TIMEOUT;
|
---|
1223 | }
|
---|
1224 | Assert(errno == 0 || (RT_FAILURE(rc) && rc != VERR_TIMEOUT));
|
---|
1225 | if (RT_FAILURE(rc))
|
---|
1226 | break;
|
---|
1227 | AssertBreakStmt(cPolled == 1, rc = VERR_INTERNAL_ERROR);
|
---|
1228 | if (RT_FAILURE(rc = drainInotify()))
|
---|
1229 | break;
|
---|
1230 | } while (false);
|
---|
1231 | mfWaiting = 0;
|
---|
1232 | VEC_CLEANUP_PTR(&vecpchDevs);
|
---|
1233 | return rc;
|
---|
1234 | }
|
---|
1235 |
|
---|
1236 | void hotplugInotifyImpl::Interrupt(void)
|
---|
1237 | {
|
---|
1238 | AssertRCReturnVoid(mStatus);
|
---|
1239 | ssize_t cbWritten = write(mhWakeupPipeW, SYSFS_WAKEUP_STRING,
|
---|
1240 | sizeof(SYSFS_WAKEUP_STRING));
|
---|
1241 | if (cbWritten > 0)
|
---|
1242 | fsync(mhWakeupPipeW);
|
---|
1243 | }
|
---|
1244 |
|
---|
1245 | # endif /* VBOX_USB_WITH_INOTIFY */
|
---|
1246 | #endif /* VBOX_USB_WTH_SYSFS */
|
---|
1247 |
|
---|
1248 | VBoxMainHotplugWaiter::VBoxMainHotplugWaiter(const char *pcszDevicesRoot)
|
---|
1249 | {
|
---|
1250 | try
|
---|
1251 | {
|
---|
1252 | #ifdef VBOX_USB_WITH_SYSFS
|
---|
1253 | # ifdef VBOX_USB_WITH_INOTIFY
|
---|
1254 | if (hotplugInotifyImpl::Available())
|
---|
1255 | {
|
---|
1256 | mImpl = new hotplugInotifyImpl(pcszDevicesRoot);
|
---|
1257 | return;
|
---|
1258 | }
|
---|
1259 | # endif /* VBOX_USB_WITH_INOTIFY */
|
---|
1260 | #endif /* VBOX_USB_WITH_SYSFS */
|
---|
1261 | mImpl = new hotplugNullImpl(pcszDevicesRoot);
|
---|
1262 | }
|
---|
1263 | catch(std::bad_alloc &e)
|
---|
1264 | { }
|
---|
1265 | }
|
---|