node_device_udev.c 55.5 KB
Newer Older
1 2 3
/*
 * node_device_udev.c: node device enumeration - libudev implementation
 *
4
 * Copyright (C) 2009-2015 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with this library.  If not, see
O
Osier Yang 已提交
18
 * <http://www.gnu.org/licenses/>.
19 20 21 22
 */

#include <config.h>
#include <libudev.h>
23
#include <pciaccess.h>
24 25 26
#include <scsi/scsi.h>
#include <c-ctype.h>

27
#include "dirname.h"
28
#include "node_device_conf.h"
29
#include "node_device_event.h"
30
#include "node_device_driver.h"
31 32
#include "node_device_udev.h"
#include "virerror.h"
33 34
#include "driver.h"
#include "datatypes.h"
35
#include "virlog.h"
36
#include "viralloc.h"
37
#include "viruuid.h"
38
#include "virbuffer.h"
39
#include "virfile.h"
40
#include "virpci.h"
41
#include "virstring.h"
42
#include "virnetdev.h"
43
#include "virmdev.h"
44 45 46

#define VIR_FROM_THIS VIR_FROM_NODEDEV

47 48
VIR_LOG_INIT("node_device.node_device_udev");

49 50 51 52
#ifndef TYPE_RAID
# define TYPE_RAID 12
#endif

53 54 55 56 57 58
typedef struct _udevEventData udevEventData;
typedef udevEventData *udevEventDataPtr;

struct _udevEventData {
    virObjectLockable parent;

59 60
    struct udev_monitor *udev_monitor;
    int watch;
61 62 63 64 65 66

    /* Thread data */
    virThread th;
    virCond threadCond;
    bool threadQuit;
    bool dataReady;
67 68
};

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
static virClassPtr udevEventDataClass;

static void
udevEventDataDispose(void *obj)
{
    struct udev *udev = NULL;
    udevEventDataPtr priv = obj;

    if (priv->watch != -1)
        virEventRemoveHandle(priv->watch);

    if (!priv->udev_monitor)
        return;

    udev = udev_monitor_get_udev(priv->udev_monitor);
    udev_monitor_unref(priv->udev_monitor);
    udev_unref(udev);
86 87

    virCondDestroy(&priv->threadCond);
88 89 90 91 92 93
}


static int
udevEventDataOnceInit(void)
{
94
    if (!VIR_CLASS_NEW(udevEventData, virClassForObjectLockable()))
95 96 97 98 99
        return -1;

    return 0;
}

100
VIR_ONCE_GLOBAL_INIT(udevEventData);
101 102 103 104 105 106 107 108 109 110 111 112

static udevEventDataPtr
udevEventDataNew(void)
{
    udevEventDataPtr ret = NULL;

    if (udevEventDataInitialize() < 0)
        return NULL;

    if (!(ret = virObjectLockableNew(udevEventDataClass)))
        return NULL;

113 114 115 116 117
    if (virCondInit(&ret->threadCond) < 0) {
        virObjectUnref(ret);
        return NULL;
    }

118 119 120 121
    ret->watch = -1;
    return ret;
}

122

J
Ján Tomko 已提交
123 124 125 126 127 128 129 130 131 132 133
static bool
udevHasDeviceProperty(struct udev_device *dev,
                      const char *key)
{
    if (udev_device_get_property_value(dev, key))
        return true;

    return false;
}


134 135 136
static const char *
udevGetDeviceProperty(struct udev_device *udev_device,
                      const char *property_key)
137
{
138
    const char *ret = NULL;
139

140
    ret = udev_device_get_property_value(udev_device, property_key);
141

142 143
    VIR_DEBUG("Found property key '%s' value '%s' for device with sysname '%s'",
              property_key, NULLSTR(ret), udev_device_get_sysname(udev_device));
144 145 146 147 148

    return ret;
}


149 150 151 152
static int
udevGetStringProperty(struct udev_device *udev_device,
                      const char *property_key,
                      char **value)
153
{
154 155
    if (VIR_STRDUP(*value,
                   udevGetDeviceProperty(udev_device, property_key)) < 0)
156
        return -1;
157

158
    return 0;
159 160 161
}


162 163 164 165 166
static int
udevGetIntProperty(struct udev_device *udev_device,
                   const char *property_key,
                   int *value,
                   int base)
167
{
168
    const char *str = NULL;
169

170
    str = udevGetDeviceProperty(udev_device, property_key);
171

172
    if (str && virStrToLong_i(str, NULL, base, value) < 0) {
173 174
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Failed to convert '%s' to int"), str);
175
        return -1;
176
    }
177
    return 0;
178 179 180
}


181 182 183 184 185
static int
udevGetUintProperty(struct udev_device *udev_device,
                    const char *property_key,
                    unsigned int *value,
                    int base)
186
{
187
    const char *str = NULL;
188

189
    str = udevGetDeviceProperty(udev_device, property_key);
190

191
    if (str && virStrToLong_ui(str, NULL, base, value) < 0) {
192 193
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Failed to convert '%s' to int"), str);
194
        return -1;
195
    }
196
    return 0;
197 198 199
}


200 201 202
static const char *
udevGetDeviceSysfsAttr(struct udev_device *udev_device,
                       const char *attr_name)
203
{
204
    const char *ret = NULL;
205

206
    ret = udev_device_get_sysattr_value(udev_device, attr_name);
207 208

    VIR_DEBUG("Found sysfs attribute '%s' value '%s' "
209
              "for device with sysname '%s'",
210
              attr_name, NULLSTR(ret),
211 212 213 214 215
              udev_device_get_sysname(udev_device));
    return ret;
}


216 217 218 219
static int
udevGetStringSysfsAttr(struct udev_device *udev_device,
                       const char *attr_name,
                       char **value)
220
{
221
    if (VIR_STRDUP(*value, udevGetDeviceSysfsAttr(udev_device, attr_name)) < 0)
222
        return -1;
223

224
    virStringStripControlChars(*value);
225

226 227
    if (*value != NULL && (STREQ(*value, "")))
        VIR_FREE(*value);
228

229
    return 0;
230 231 232
}


233 234 235 236 237
static int
udevGetIntSysfsAttr(struct udev_device *udev_device,
                    const char *attr_name,
                    int *value,
                    int base)
238
{
239
    const char *str = NULL;
240

241
    str = udevGetDeviceSysfsAttr(udev_device, attr_name);
242

243
    if (str && virStrToLong_i(str, NULL, base, value) < 0) {
244 245
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Failed to convert '%s' to int"), str);
246
        return -1;
247 248
    }

249
    return 0;
250 251 252
}


253 254 255 256 257
static int
udevGetUintSysfsAttr(struct udev_device *udev_device,
                     const char *attr_name,
                     unsigned int *value,
                     int base)
258
{
259
    const char *str = NULL;
260

261
    str = udevGetDeviceSysfsAttr(udev_device, attr_name);
262

263
    if (str && virStrToLong_ui(str, NULL, base, value) < 0) {
264 265
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Failed to convert '%s' to unsigned int"), str);
266
        return -1;
267 268
    }

269
    return 0;
270 271 272
}


273 274 275 276
static int
udevGetUint64SysfsAttr(struct udev_device *udev_device,
                       const char *attr_name,
                       unsigned long long *value)
277
{
278
    const char *str = NULL;
279

280
    str = udevGetDeviceSysfsAttr(udev_device, attr_name);
281

282
    if (str && virStrToLong_ull(str, NULL, 0, value) < 0) {
283 284
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Failed to convert '%s' to unsigned long long"), str);
J
Ján Tomko 已提交
285
        return -1;
286 287
    }

J
Ján Tomko 已提交
288
    return 0;
289 290 291
}


292 293 294 295
static int
udevGenerateDeviceName(struct udev_device *device,
                       virNodeDeviceDefPtr def,
                       const char *s)
296
{
297
    size_t i;
298 299
    virBuffer buf = VIR_BUFFER_INITIALIZER;

300
    virBufferAsprintf(&buf, "%s_%s",
301 302 303
                      udev_device_get_subsystem(device),
                      udev_device_get_sysname(device));

304
    if (s != NULL)
305
        virBufferAsprintf(&buf, "_%s", s);
306

307 308
    if (virBufferCheckError(&buf) < 0)
        return -1;
309 310 311

    def->name = virBufferContentAndReset(&buf);

312
    for (i = 0; i < strlen(def->name); i++) {
313
        if (!(c_isalnum(*(def->name + i))))
314 315 316
            *(def->name + i) = '_';
    }

317
    return 0;
318 319
}

320

321
#if HAVE_UDEV_LOGGING
322 323 324 325 326 327 328 329
typedef void
(*udevLogFunctionPtr)(struct udev *udev,
                      int priority,
                      const char *file,
                      int line,
                      const char *fn,
                      const char *format,
                      va_list args);
J
Ján Tomko 已提交
330 331

static void
332
ATTRIBUTE_FMT_PRINTF(6, 0)
J
Ján Tomko 已提交
333 334 335 336 337 338 339
udevLogFunction(struct udev *udev ATTRIBUTE_UNUSED,
                int priority,
                const char *file,
                int line,
                const char *fn,
                const char *fmt,
                va_list args)
340
{
J
Ján Tomko 已提交
341
    virBuffer buf = VIR_BUFFER_INITIALIZER;
342
    char *format = NULL;
J
Ján Tomko 已提交
343 344 345 346 347 348

    virBufferAdd(&buf, fmt, -1);
    virBufferTrim(&buf, "\n", -1);

    format = virBufferContentAndReset(&buf);

349
    virLogVMessage(&virLogSelf,
J
Ján Tomko 已提交
350 351 352 353
                   virLogPriorityFromSyslog(priority),
                   file, line, fn, NULL, format ? format : fmt, args);

    VIR_FREE(format);
354
}
355
#endif
356 357


358 359 360 361 362
static int
udevTranslatePCIIds(unsigned int vendor,
                    unsigned int product,
                    char **vendor_string,
                    char **product_string)
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
{
    struct pci_id_match m;
    const char *vendor_name = NULL, *device_name = NULL;

    m.vendor_id = vendor;
    m.device_id = product;
    m.subvendor_id = PCI_MATCH_ANY;
    m.subdevice_id = PCI_MATCH_ANY;
    m.device_class = 0;
    m.device_class_mask = 0;
    m.match_data = 0;

    /* pci_get_strings returns void */
    pci_get_strings(&m,
                    &device_name,
378
                    &vendor_name,
379 380 381
                    NULL,
                    NULL);

382
    if (VIR_STRDUP(*vendor_string, vendor_name) < 0 ||
383
        VIR_STRDUP(*product_string, device_name) < 0)
384
        return -1;
385

386
    return 0;
387 388 389
}


390 391 392
static int
udevProcessPCI(struct udev_device *device,
               virNodeDeviceDefPtr def)
393
{
394
    virNodeDevCapPCIDevPtr pci_dev = &def->caps->data.pci_dev;
395 396
    virPCIEDeviceInfoPtr pci_express = NULL;
    virPCIDevicePtr pciDev = NULL;
397
    int ret = -1;
398
    char *p;
399 400 401 402 403
    bool privileged;

    nodeDeviceLock();
    privileged = driver->privileged;
    nodeDeviceUnlock();
404

405
    if (udevGetUintProperty(device, "PCI_CLASS", &pci_dev->class, 16) < 0)
406
        goto cleanup;
407

408
    if ((p = strrchr(def->sysfs_path, '/')) == NULL ||
409 410 411 412
        virStrToLong_ui(p + 1, &p, 16, &pci_dev->domain) < 0 || p == NULL ||
        virStrToLong_ui(p + 1, &p, 16, &pci_dev->bus) < 0 || p == NULL ||
        virStrToLong_ui(p + 1, &p, 16, &pci_dev->slot) < 0 || p == NULL ||
        virStrToLong_ui(p + 1, &p, 16, &pci_dev->function) < 0) {
413 414
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("failed to parse the PCI address from sysfs path: '%s'"),
415
                       def->sysfs_path);
416
        goto cleanup;
417 418
    }

419
    if (udevGetUintSysfsAttr(device, "vendor", &pci_dev->vendor, 16) < 0)
420
        goto cleanup;
421

422
    if (udevGetUintSysfsAttr(device, "device", &pci_dev->product, 16) < 0)
423
        goto cleanup;
424

425 426 427 428
    if (udevTranslatePCIIds(pci_dev->vendor,
                            pci_dev->product,
                            &pci_dev->vendor_name,
                            &pci_dev->product_name) != 0) {
429
        goto cleanup;
430
    }
431

432
    if (udevGenerateDeviceName(device, def, NULL) != 0)
433
        goto cleanup;
434

435 436
    /* The default value is -1, because it can't be 0
     * as zero is valid node number. */
437
    pci_dev->numa_node = -1;
438
    if (udevGetIntSysfsAttr(device, "numa_node",
439
                            &pci_dev->numa_node, 10) < 0)
440
        goto cleanup;
441

442
    if (virNodeDeviceGetPCIDynamicCaps(def->sysfs_path, pci_dev) < 0)
443
        goto cleanup;
444

445 446 447 448
    if (!(pciDev = virPCIDeviceNew(pci_dev->domain,
                                   pci_dev->bus,
                                   pci_dev->slot,
                                   pci_dev->function)))
449
        goto cleanup;
450

451
    /* We need to be root to read PCI device configs */
452
    if (privileged) {
453
        if (virPCIGetHeaderType(pciDev, &pci_dev->hdrType) < 0)
454
            goto cleanup;
455

456 457
        if (virPCIDeviceIsPCIExpress(pciDev) > 0) {
            if (VIR_ALLOC(pci_express) < 0)
458
                goto cleanup;
459

460 461 462
            if (virPCIDeviceHasPCIExpressLink(pciDev) > 0) {
                if (VIR_ALLOC(pci_express->link_cap) < 0 ||
                    VIR_ALLOC(pci_express->link_sta) < 0)
463
                    goto cleanup;
464 465 466 467 468 469 470

                if (virPCIDeviceGetLinkCapSta(pciDev,
                                              &pci_express->link_cap->port,
                                              &pci_express->link_cap->speed,
                                              &pci_express->link_cap->width,
                                              &pci_express->link_sta->speed,
                                              &pci_express->link_sta->width) < 0)
471
                    goto cleanup;
472 473 474

                pci_express->link_sta->port = -1; /* PCIe can't negotiate port. Yet :) */
            }
475 476
            pci_dev->flags |= VIR_NODE_DEV_CAP_FLAG_PCIE;
            pci_dev->pci_express = pci_express;
477
            pci_express = NULL;
478 479 480
        }
    }

481 482
    ret = 0;

483
 cleanup:
484
    virPCIDeviceFree(pciDev);
485
    virPCIEDeviceInfoFree(pci_express);
486 487 488
    return ret;
}

489 490 491

static int
drmGetMinorType(int minor)
M
Marc-André Lureau 已提交
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
{
    int type = minor >> 6;

    if (minor < 0)
        return -1;

    switch (type) {
    case VIR_NODE_DEV_DRM_PRIMARY:
    case VIR_NODE_DEV_DRM_CONTROL:
    case VIR_NODE_DEV_DRM_RENDER:
        return type;
    default:
        return -1;
    }
}

508 509 510 511

static int
udevProcessDRMDevice(struct udev_device *device,
                     virNodeDeviceDefPtr def)
M
Marc-André Lureau 已提交
512
{
513
    virNodeDevCapDRMPtr drm = &def->caps->data.drm;
M
Marc-André Lureau 已提交
514 515 516 517 518 519 520 521 522 523 524
    int minor;

    if (udevGenerateDeviceName(device, def, NULL) != 0)
        return -1;

    if (udevGetIntProperty(device, "MINOR", &minor, 10) < 0)
        return -1;

    if ((minor = drmGetMinorType(minor)) == -1)
        return -1;

525
    drm->type = minor;
M
Marc-André Lureau 已提交
526 527 528

    return 0;
}
529

530 531 532 533

static int
udevProcessUSBDevice(struct udev_device *device,
                     virNodeDeviceDefPtr def)
534
{
535
    virNodeDevCapUSBDevPtr usb_dev = &def->caps->data.usb_dev;
536

537
    if (udevGetUintProperty(device, "BUSNUM", &usb_dev->bus, 10) < 0)
538
        return -1;
539
    if (udevGetUintProperty(device, "DEVNUM", &usb_dev->device, 10) < 0)
540
        return -1;
541
    if (udevGetUintProperty(device, "ID_VENDOR_ID", &usb_dev->vendor, 16) < 0)
542
        return -1;
543

544 545
    if (udevGetStringProperty(device,
                              "ID_VENDOR_FROM_DATABASE",
546
                              &usb_dev->vendor_name) < 0)
547
        return -1;
548

549
    if (!usb_dev->vendor_name &&
550
        udevGetStringSysfsAttr(device, "manufacturer",
551
                               &usb_dev->vendor_name) < 0)
552
        return -1;
553

554
    if (udevGetUintProperty(device, "ID_MODEL_ID", &usb_dev->product, 16) < 0)
555
        return -1;
556

557 558
    if (udevGetStringProperty(device,
                              "ID_MODEL_FROM_DATABASE",
559
                              &usb_dev->product_name) < 0)
560
        return -1;
561

562
    if (!usb_dev->product_name &&
563
        udevGetStringSysfsAttr(device, "product",
564
                               &usb_dev->product_name) < 0)
565
        return -1;
566

567
    if (udevGenerateDeviceName(device, def, NULL) != 0)
568
        return -1;
569

570
    return 0;
571 572 573
}


574 575 576
static int
udevProcessUSBInterface(struct udev_device *device,
                        virNodeDeviceDefPtr def)
577
{
578
    virNodeDevCapUSBIfPtr usb_if = &def->caps->data.usb_if;
579

580
    if (udevGetUintSysfsAttr(device, "bInterfaceNumber",
581
                             &usb_if->number, 16) < 0)
582
        return -1;
583

584
    if (udevGetUintSysfsAttr(device, "bInterfaceClass",
585
                             &usb_if->_class, 16) < 0)
586
        return -1;
587

588
    if (udevGetUintSysfsAttr(device, "bInterfaceSubClass",
589
                             &usb_if->subclass, 16) < 0)
590
        return -1;
591

592
    if (udevGetUintSysfsAttr(device, "bInterfaceProtocol",
593
                             &usb_if->protocol, 16) < 0)
594
        return -1;
595

596
    if (udevGenerateDeviceName(device, def, NULL) != 0)
597
        return -1;
598

599
    return 0;
600 601 602
}


603 604 605
static int
udevProcessNetworkInterface(struct udev_device *device,
                            virNodeDeviceDefPtr def)
606
{
D
David Allan 已提交
607
    const char *devtype = udev_device_get_devtype(device);
608
    virNodeDevCapNetPtr net = &def->caps->data.net;
609

D
David Allan 已提交
610
    if (devtype && STREQ(devtype, "wlan")) {
611
        net->subtype = VIR_NODE_DEV_CAP_NET_80211;
D
David Allan 已提交
612
    } else {
613
        net->subtype = VIR_NODE_DEV_CAP_NET_80203;
D
David Allan 已提交
614 615
    }

616 617
    if (udevGetStringProperty(device,
                              "INTERFACE",
618
                              &net->ifname) < 0)
619
        return -1;
620

621
    if (udevGetStringSysfsAttr(device, "address",
622
                               &net->address) < 0)
623
        return -1;
624

625
    if (udevGetUintSysfsAttr(device, "addr_len", &net->address_len, 0) < 0)
626
        return -1;
627

628
    if (udevGenerateDeviceName(device, def, net->address) != 0)
629
        return -1;
630

631
    if (virNetDevGetLinkInfo(net->ifname, &net->lnk) < 0)
632
        return -1;
633

634
    if (virNetDevGetFeatures(net->ifname, &net->features) < 0)
635
        return -1;
636

637
    return 0;
638 639 640
}


641 642 643
static int
udevProcessSCSIHost(struct udev_device *device ATTRIBUTE_UNUSED,
                    virNodeDeviceDefPtr def)
644
{
645
    virNodeDevCapSCSIHostPtr scsi_host = &def->caps->data.scsi_host;
646
    char *filename = NULL;
J
Ján Tomko 已提交
647
    char *str;
648

649
    filename = last_component(def->sysfs_path);
650

651
    if (!(str = STRSKIP(filename, "host")) ||
652
        virStrToLong_ui(str, NULL, 0, &scsi_host->host) < 0) {
653 654 655
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("failed to parse SCSI host '%s'"),
                       filename);
656
        return -1;
657 658
    }

659
    virNodeDeviceGetSCSIHostCaps(&def->caps->data.scsi_host);
660

661
    if (udevGenerateDeviceName(device, def, NULL) != 0)
662
        return -1;
663

664
    return 0;
665 666 667
}


668 669 670
static int
udevProcessSCSITarget(struct udev_device *device,
                      virNodeDeviceDefPtr def)
D
David Allan 已提交
671 672
{
    const char *sysname = NULL;
673
    virNodeDevCapSCSITargetPtr scsi_target = &def->caps->data.scsi_target;
D
David Allan 已提交
674 675 676

    sysname = udev_device_get_sysname(device);

677
    if (VIR_STRDUP(scsi_target->name, sysname) < 0)
678
        return -1;
D
David Allan 已提交
679

680
    virNodeDeviceGetSCSITargetCaps(def->sysfs_path, &def->caps->data.scsi_target);
681

682
    if (udevGenerateDeviceName(device, def, NULL) != 0)
683
        return -1;
D
David Allan 已提交
684

685
    return 0;
D
David Allan 已提交
686 687 688
}


689 690 691 692
static int
udevGetSCSIType(virNodeDeviceDefPtr def ATTRIBUTE_UNUSED,
                unsigned int type,
                char **typestring)
693 694 695 696 697 698 699 700
{
    int ret = 0;
    int foundtype = 1;

    *typestring = NULL;

    switch (type) {
    case TYPE_DISK:
701
        ignore_value(VIR_STRDUP(*typestring, "disk"));
702 703
        break;
    case TYPE_TAPE:
704
        ignore_value(VIR_STRDUP(*typestring, "tape"));
705 706
        break;
    case TYPE_PROCESSOR:
707
        ignore_value(VIR_STRDUP(*typestring, "processor"));
708 709
        break;
    case TYPE_WORM:
710
        ignore_value(VIR_STRDUP(*typestring, "worm"));
711 712
        break;
    case TYPE_ROM:
713
        ignore_value(VIR_STRDUP(*typestring, "cdrom"));
714 715
        break;
    case TYPE_SCANNER:
716
        ignore_value(VIR_STRDUP(*typestring, "scanner"));
717 718
        break;
    case TYPE_MOD:
719
        ignore_value(VIR_STRDUP(*typestring, "mod"));
720 721
        break;
    case TYPE_MEDIUM_CHANGER:
722
        ignore_value(VIR_STRDUP(*typestring, "changer"));
723 724
        break;
    case TYPE_ENCLOSURE:
725
        ignore_value(VIR_STRDUP(*typestring, "enclosure"));
726
        break;
727
    case TYPE_RAID:
728
        ignore_value(VIR_STRDUP(*typestring, "raid"));
729
        break;
730 731 732 733 734 735 736 737 738 739
    case TYPE_NO_LUN:
    default:
        foundtype = 0;
        break;
    }

    if (*typestring == NULL) {
        if (foundtype == 1) {
            ret = -1;
        } else {
740 741
            VIR_DEBUG("Failed to find SCSI device type %d for %s",
                      type, def->sysfs_path);
742 743 744 745 746 747 748
        }
    }

    return ret;
}


749 750 751
static int
udevProcessSCSIDevice(struct udev_device *device ATTRIBUTE_UNUSED,
                      virNodeDeviceDefPtr def)
752 753 754
{
    int ret = -1;
    unsigned int tmp = 0;
755
    virNodeDevCapSCSIPtr scsi = &def->caps->data.scsi;
756 757
    char *filename = NULL, *p = NULL;

758
    filename = last_component(def->sysfs_path);
759

760 761 762 763
    if (virStrToLong_ui(filename, &p, 10, &scsi->host) < 0 || p == NULL ||
        virStrToLong_ui(p + 1, &p, 10, &scsi->bus) < 0 || p == NULL ||
        virStrToLong_ui(p + 1, &p, 10, &scsi->target) < 0 || p == NULL ||
        virStrToLong_ui(p + 1, &p, 10, &scsi->lun) < 0) {
764 765 766 767
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("failed to parse the SCSI address from filename: '%s'"),
                       filename);
        return -1;
768 769
    }

770 771
    if (udev_device_get_sysattr_value(device, "type")) {
        if (udevGetUintSysfsAttr(device, "type", &tmp, 0) < 0)
772
            goto cleanup;
773

774
        if (udevGetSCSIType(def, tmp, &scsi->type) < 0)
775
            goto cleanup;
776 777
    }

778
    if (udevGenerateDeviceName(device, def, NULL) != 0)
779
        goto cleanup;
780 781 782

    ret = 0;

783
 cleanup:
784
    if (ret != 0) {
785 786 787
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Failed to process SCSI device with sysfs path '%s'"),
                       def->sysfs_path);
788 789 790 791 792
    }
    return ret;
}


793 794 795
static int
udevProcessDisk(struct udev_device *device,
                virNodeDeviceDefPtr def)
796
{
797
    virNodeDevCapStoragePtr storage = &def->caps->data.storage;
798

799
    if (udevGetUint64SysfsAttr(device, "size", &storage->num_blocks) < 0)
800
        return -1;
801

J
Ján Tomko 已提交
802
    if (udevGetUint64SysfsAttr(device, "queue/logical_block_size",
803
                               &storage->logical_block_size) < 0)
804
        return -1;
805

806
    storage->size = storage->num_blocks * storage->logical_block_size;
807

808
    return 0;
809 810 811
}


812 813 814 815
static int
udevProcessRemoveableMedia(struct udev_device *device,
                           virNodeDeviceDefPtr def,
                           int has_media)
816
{
817
    virNodeDevCapStoragePtr storage = &def->caps->data.storage;
J
Ján Tomko 已提交
818
    int is_removable = 0;
819

820 821 822
    if (udevGetIntSysfsAttr(device, "removable", &is_removable, 0) < 0)
        return -1;
    if (is_removable == 1)
823 824
        def->caps->data.storage.flags |= VIR_NODE_DEV_CAP_STORAGE_REMOVABLE;

J
Ján Tomko 已提交
825 826
    if (!has_media)
        return 0;
827

J
Ján Tomko 已提交
828 829
    def->caps->data.storage.flags |=
        VIR_NODE_DEV_CAP_STORAGE_REMOVABLE_MEDIA_AVAILABLE;
830

J
Ján Tomko 已提交
831
    if (udevGetStringProperty(device, "ID_FS_LABEL",
832
                              &storage->media_label) < 0)
J
Ján Tomko 已提交
833
        return -1;
834

J
Ján Tomko 已提交
835
    if (udevGetUint64SysfsAttr(device, "size",
836
                               &storage->num_blocks) < 0)
J
Ján Tomko 已提交
837
        return -1;
838

J
Ján Tomko 已提交
839
    if (udevGetUint64SysfsAttr(device, "queue/logical_block_size",
840
                               &storage->logical_block_size) < 0)
J
Ján Tomko 已提交
841
        return -1;
842

J
Ján Tomko 已提交
843 844 845 846 847 848 849
    /* XXX This calculation is wrong for the qemu virtual cdrom
     * which reports the size in 512 byte blocks, but the logical
     * block size as 2048.  I don't have a physical cdrom on a
     * devel system to see how they behave. */
    def->caps->data.storage.removable_media_size =
        def->caps->data.storage.num_blocks *
        def->caps->data.storage.logical_block_size;
850

J
Ján Tomko 已提交
851
    return 0;
852 853
}

854 855 856 857

static int
udevProcessCDROM(struct udev_device *device,
                 virNodeDeviceDefPtr def)
858 859 860 861 862 863 864 865
{
    int has_media = 0;

    /* NB: the drive_type string provided by udev is different from
     * that provided by HAL; now it's "cd" instead of "cdrom" We
     * change it to cdrom to preserve compatibility with earlier
     * versions of libvirt.  */
    VIR_FREE(def->caps->data.storage.drive_type);
866
    if (VIR_STRDUP(def->caps->data.storage.drive_type, "cdrom") < 0)
867
        return -1;
868

869 870
    if (udevHasDeviceProperty(device, "ID_CDROM_MEDIA") &&
        udevGetIntProperty(device, "ID_CDROM_MEDIA", &has_media, 0) < 0)
871
        return -1;
872

873
    return udevProcessRemoveableMedia(device, def, has_media);
874 875
}

876 877 878 879

static int
udevProcessFloppy(struct udev_device *device,
                  virNodeDeviceDefPtr def)
880 881 882
{
    int has_media = 0;

883
    if (udevHasDeviceProperty(device, "ID_CDROM_MEDIA")) {
884
        /* USB floppy */
885 886
        if (udevGetIntProperty(device, "DKD_MEDIA_AVAILABLE", &has_media, 0) < 0)
            return -1;
887
    } else if (udevHasDeviceProperty(device, "ID_FS_LABEL")) {
888 889 890 891 892 893
        /* Legacy floppy */
        has_media = 1;
    }

    return udevProcessRemoveableMedia(device, def, has_media);
}
894

895

896 897 898
static int
udevProcessSD(struct udev_device *device,
              virNodeDeviceDefPtr def)
899
{
900
    virNodeDevCapStoragePtr storage = &def->caps->data.storage;
901

J
Ján Tomko 已提交
902
    if (udevGetUint64SysfsAttr(device, "size",
903
                               &storage->num_blocks) < 0)
904
        return -1;
905

J
Ján Tomko 已提交
906
    if (udevGetUint64SysfsAttr(device, "queue/logical_block_size",
907
                               &storage->logical_block_size) < 0)
908
        return -1;
909

910
    storage->size = storage->num_blocks * storage->logical_block_size;
911

912
    return 0;
913 914 915
}


916 917 918 919
/* This function exists to deal with the case in which a driver does
 * not provide a device type in the usual place, but udev told us it's
 * a storage device, and we can make a good guess at what kind of
 * storage device it is from other information that is provided. */
920 921
static int
udevKludgeStorageType(virNodeDeviceDefPtr def)
922
{
923 924 925
    VIR_DEBUG("Could not find definitive storage type for device "
              "with sysfs path '%s', trying to guess it",
              def->sysfs_path);
926

927 928 929
    /* virtio disk */
    if (STRPREFIX(def->caps->data.storage.block, "/dev/vd") &&
        VIR_STRDUP(def->caps->data.storage.drive_type, "disk") > 0) {
930
        VIR_DEBUG("Found storage type '%s' for device "
931
                  "with sysfs path '%s'",
932 933
                  def->caps->data.storage.drive_type,
                  def->sysfs_path);
934
        return 0;
935
    }
936 937 938
    VIR_DEBUG("Could not determine storage type "
              "for device with sysfs path '%s'", def->sysfs_path);
    return -1;
939 940 941
}


942 943 944
static int
udevProcessStorage(struct udev_device *device,
                   virNodeDeviceDefPtr def)
945
{
946
    virNodeDevCapStoragePtr storage = &def->caps->data.storage;
947
    int ret = -1;
948
    const char* devnode;
949

950
    devnode = udev_device_get_devnode(device);
951
    if (!devnode) {
952
        VIR_DEBUG("No devnode for '%s'", udev_device_get_devpath(device));
953
        goto cleanup;
954
    }
955

956
    if (VIR_STRDUP(storage->block, devnode) < 0)
957
        goto cleanup;
958

959
    if (udevGetStringProperty(device, "ID_BUS", &storage->bus) < 0)
960
        goto cleanup;
961
    if (udevGetStringProperty(device, "ID_SERIAL", &storage->serial) < 0)
962
        goto cleanup;
963

964
    if (udevGetStringSysfsAttr(device, "device/vendor", &storage->vendor) < 0)
965
        goto cleanup;
966 967 968
    if (def->caps->data.storage.vendor)
        virTrimSpaces(def->caps->data.storage.vendor, NULL);

969
    if (udevGetStringSysfsAttr(device, "device/model", &storage->model) < 0)
970
        goto cleanup;
971 972
    if (def->caps->data.storage.model)
        virTrimSpaces(def->caps->data.storage.model, NULL);
973 974 975 976 977
    /* There is no equivalent of the hotpluggable property in libudev,
     * but storage is going toward a world in which hotpluggable is
     * expected, so I don't see a problem with not having a property
     * for it. */

978
    if (udevGetStringProperty(device, "ID_TYPE", &storage->drive_type) < 0)
979
        goto cleanup;
980

981
    if (!storage->drive_type ||
982
        STREQ(def->caps->data.storage.drive_type, "generic")) {
983 984
        int val = 0;
        const char *str = NULL;
985 986 987

        /* All floppy drives have the ID_DRIVE_FLOPPY prop. This is
         * needed since legacy floppies don't have a drive_type */
988
        if (udevGetIntProperty(device, "ID_DRIVE_FLOPPY", &val, 0) < 0)
989
            goto cleanup;
990 991
        else if (val == 1)
            str = "floppy";
992

993
        if (!str) {
994
            if (udevGetIntProperty(device, "ID_CDROM", &val, 0) < 0)
995
                goto cleanup;
996 997 998
            else if (val == 1)
                str = "cd";
        }
999

1000
        if (!str) {
1001
            if (udevGetIntProperty(device, "ID_DRIVE_FLASH_SD", &val, 0) < 0)
1002
                goto cleanup;
1003 1004 1005
            if (val == 1)
                str = "sd";
        }
1006

1007
        if (str) {
1008
            if (VIR_STRDUP(storage->drive_type, str) < 0)
1009
                goto cleanup;
1010 1011
        } else {
            /* If udev doesn't have it, perhaps we can guess it. */
1012
            if (udevKludgeStorageType(def) != 0)
1013
                goto cleanup;
1014 1015 1016 1017 1018 1019 1020
        }
    }

    if (STREQ(def->caps->data.storage.drive_type, "cd")) {
        ret = udevProcessCDROM(device, def);
    } else if (STREQ(def->caps->data.storage.drive_type, "disk")) {
        ret = udevProcessDisk(device, def);
1021 1022
    } else if (STREQ(def->caps->data.storage.drive_type, "floppy")) {
        ret = udevProcessFloppy(device, def);
1023 1024
    } else if (STREQ(def->caps->data.storage.drive_type, "sd")) {
        ret = udevProcessSD(device, def);
1025
    } else {
1026 1027
        VIR_DEBUG("Unsupported storage type '%s'",
                  def->caps->data.storage.drive_type);
1028
        goto cleanup;
1029 1030
    }

1031
    if (udevGenerateDeviceName(device, def, storage->serial) != 0)
1032
        goto cleanup;
1033

1034
 cleanup:
1035
    VIR_DEBUG("Storage ret=%d", ret);
1036 1037 1038
    return ret;
}

1039

1040
static int
1041
udevProcessSCSIGeneric(struct udev_device *dev,
1042 1043
                       virNodeDeviceDefPtr def)
{
1044 1045
    if (udevGetStringProperty(dev, "DEVNAME", &def->caps->data.sg.path) < 0 ||
        !def->caps->data.sg.path)
1046 1047 1048 1049 1050 1051 1052 1053
        return -1;

    if (udevGenerateDeviceName(dev, def, NULL) != 0)
        return -1;

    return 0;
}

1054

1055 1056 1057 1058 1059 1060 1061 1062
static int
udevProcessMediatedDevice(struct udev_device *dev,
                          virNodeDeviceDefPtr def)
{
    int ret = -1;
    const char *uuidstr = NULL;
    int iommugrp = -1;
    char *linkpath = NULL;
1063
    char *canonicalpath = NULL;
1064 1065
    virNodeDevCapMdevPtr data = &def->caps->data.mdev;

1066 1067 1068 1069 1070 1071 1072 1073
    /* Because of a kernel uevent race, we might get the 'add' event prior to
     * the sysfs tree being ready, so any attempt to access any sysfs attribute
     * would result in ENOENT and us dropping the device, so let's work around
     * it by waiting for the attributes to become available.
     */

    if (virAsprintf(&linkpath, "%s/mdev_type",
                    udev_device_get_syspath(dev)) < 0)
1074 1075
        goto cleanup;

1076 1077 1078 1079 1080 1081 1082
    if (virFileWaitForExists(linkpath, 1, 100) < 0) {
        virReportSystemError(errno,
                             _("failed to wait for file '%s' to appear"),
                             linkpath);
        goto cleanup;
    }

1083 1084
    if (virFileResolveLink(linkpath, &canonicalpath) < 0) {
        virReportSystemError(errno, _("failed to resolve '%s'"), linkpath);
1085
        goto cleanup;
1086
    }
1087

1088
    if (VIR_STRDUP(data->type, last_component(canonicalpath)) < 0)
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
        goto cleanup;

    uuidstr = udev_device_get_sysname(dev);
    if ((iommugrp = virMediatedDeviceGetIOMMUGroupNum(uuidstr)) < 0)
        goto cleanup;

    if (udevGenerateDeviceName(dev, def, NULL) != 0)
        goto cleanup;

    data->iommuGroupNumber = iommugrp;

    ret = 0;
 cleanup:
    VIR_FREE(linkpath);
1103
    VIR_FREE(canonicalpath);
1104 1105 1106
    return ret;
}

B
Bjoern Walk 已提交
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136

static int
udevProcessCCW(struct udev_device *device,
               virNodeDeviceDefPtr def)
{
    int online;
    char *p;
    virNodeDevCapDataPtr data = &def->caps->data;

    /* process only online devices to keep the list sane */
    if (udevGetIntSysfsAttr(device, "online", &online, 0) < 0 || online != 1)
        return -1;

    if ((p = strrchr(def->sysfs_path, '/')) == NULL ||
        virStrToLong_ui(p + 1, &p, 16, &data->ccw_dev.cssid) < 0 || p == NULL ||
        virStrToLong_ui(p + 1, &p, 16, &data->ccw_dev.ssid) < 0 || p == NULL ||
        virStrToLong_ui(p + 1, &p, 16, &data->ccw_dev.devno) < 0) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("failed to parse the CCW address from sysfs path: '%s'"),
                       def->sysfs_path);
        return -1;
    }

    if (udevGenerateDeviceName(device, def, NULL) != 0)
        return -1;

    return 0;
}


1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
static int
udevGetDeviceNodes(struct udev_device *device,
                   virNodeDeviceDefPtr def)
{
    const char *devnode = NULL;
    struct udev_list_entry *list_entry = NULL;
    int n = 0;

    devnode = udev_device_get_devnode(device);

    if (VIR_STRDUP(def->devnode, devnode) < 0)
        return -1;

    udev_list_entry_foreach(list_entry, udev_device_get_devlinks_list_entry(device))
        n++;

    if (VIR_ALLOC_N(def->devlinks, n + 1) < 0)
        return -1;

    n = 0;
    udev_list_entry_foreach(list_entry, udev_device_get_devlinks_list_entry(device)) {
        if (VIR_STRDUP(def->devlinks[n++], udev_list_entry_get_name(list_entry)) < 0)
            return -1;
    }

    return 0;
}

1165

1166 1167
static int
udevGetDeviceType(struct udev_device *device,
1168
                  virNodeDevCapType *type)
1169 1170
{
    const char *devtype = NULL;
1171
    char *subsystem = NULL;
1172
    int ret = -1;
D
David Allan 已提交
1173

1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
    devtype = udev_device_get_devtype(device);
    *type = 0;

    if (devtype) {
        if (STREQ(devtype, "usb_device"))
            *type = VIR_NODE_DEV_CAP_USB_DEV;
        else if (STREQ(devtype, "usb_interface"))
            *type = VIR_NODE_DEV_CAP_USB_INTERFACE;
        else if (STREQ(devtype, "scsi_host"))
            *type = VIR_NODE_DEV_CAP_SCSI_HOST;
        else if (STREQ(devtype, "scsi_target"))
            *type = VIR_NODE_DEV_CAP_SCSI_TARGET;
        else if (STREQ(devtype, "scsi_device"))
            *type = VIR_NODE_DEV_CAP_SCSI;
        else if (STREQ(devtype, "disk"))
            *type = VIR_NODE_DEV_CAP_STORAGE;
        else if (STREQ(devtype, "wlan"))
            *type = VIR_NODE_DEV_CAP_NET;
M
Marc-André Lureau 已提交
1192 1193
        else if (STREQ(devtype, "drm_minor"))
            *type = VIR_NODE_DEV_CAP_DRM;
1194 1195
    } else {
        /* PCI devices don't set the DEVTYPE property. */
1196
        if (udevHasDeviceProperty(device, "PCI_CLASS"))
1197
            *type = VIR_NODE_DEV_CAP_PCI_DEV;
1198

1199 1200 1201 1202
        /* Wired network interfaces don't set the DEVTYPE property,
         * USB devices also have an INTERFACE property, but they do
         * set DEVTYPE, so if devtype is NULL and the INTERFACE
         * property exists, we have a network device. */
1203
        if (udevHasDeviceProperty(device, "INTERFACE"))
1204
            *type = VIR_NODE_DEV_CAP_NET;
1205

B
Bjoern Walk 已提交
1206 1207
        /* The following devices do not set the DEVTYPE property, therefore
         * we need to rely on the SUBSYSTEM property */
1208 1209 1210 1211
        if (udevGetStringProperty(device, "SUBSYSTEM", &subsystem) < 0)
            return -1;

        if (STREQ_NULLABLE(subsystem, "scsi_generic"))
1212
            *type = VIR_NODE_DEV_CAP_SCSI_GENERIC;
1213 1214
        else if (STREQ_NULLABLE(subsystem, "mdev"))
            *type = VIR_NODE_DEV_CAP_MDEV;
B
Bjoern Walk 已提交
1215 1216
        else if (STREQ_NULLABLE(subsystem, "ccw"))
            *type = VIR_NODE_DEV_CAP_CCW_DEV;
1217

1218
        VIR_FREE(subsystem);
1219 1220
    }

1221 1222 1223 1224 1225 1226
    if (!*type)
        VIR_DEBUG("Could not determine device type for device "
                  "with sysfs name '%s'",
                  udev_device_get_sysname(device));
    else
        ret = 0;
1227 1228 1229 1230 1231

    return ret;
}


1232 1233 1234
static int
udevGetDeviceDetails(struct udev_device *device,
                     virNodeDeviceDefPtr def)
1235
{
1236
    switch (def->caps->data.type) {
1237
    case VIR_NODE_DEV_CAP_PCI_DEV:
1238
        return udevProcessPCI(device, def);
1239
    case VIR_NODE_DEV_CAP_USB_DEV:
1240
        return udevProcessUSBDevice(device, def);
1241
    case VIR_NODE_DEV_CAP_USB_INTERFACE:
1242
        return udevProcessUSBInterface(device, def);
1243
    case VIR_NODE_DEV_CAP_NET:
1244
        return udevProcessNetworkInterface(device, def);
1245
    case VIR_NODE_DEV_CAP_SCSI_HOST:
1246
        return udevProcessSCSIHost(device, def);
D
David Allan 已提交
1247
    case VIR_NODE_DEV_CAP_SCSI_TARGET:
1248
        return udevProcessSCSITarget(device, def);
1249
    case VIR_NODE_DEV_CAP_SCSI:
1250
        return udevProcessSCSIDevice(device, def);
1251
    case VIR_NODE_DEV_CAP_STORAGE:
1252
        return udevProcessStorage(device, def);
1253
    case VIR_NODE_DEV_CAP_SCSI_GENERIC:
1254
        return udevProcessSCSIGeneric(device, def);
M
Marc-André Lureau 已提交
1255
    case VIR_NODE_DEV_CAP_DRM:
1256
        return udevProcessDRMDevice(device, def);
1257
    case VIR_NODE_DEV_CAP_MDEV:
1258
        return udevProcessMediatedDevice(device, def);
B
Bjoern Walk 已提交
1259 1260
    case VIR_NODE_DEV_CAP_CCW_DEV:
        return udevProcessCCW(device, def);
1261
    case VIR_NODE_DEV_CAP_MDEV_TYPES:
1262 1263 1264 1265
    case VIR_NODE_DEV_CAP_SYSTEM:
    case VIR_NODE_DEV_CAP_FC_HOST:
    case VIR_NODE_DEV_CAP_VPORTS:
    case VIR_NODE_DEV_CAP_LAST:
1266 1267 1268
        break;
    }

1269
    return 0;
1270 1271 1272
}


1273 1274
static int
udevRemoveOneDevice(struct udev_device *device)
1275
{
1276
    virNodeDeviceObjPtr obj = NULL;
1277
    virNodeDeviceDefPtr def;
1278
    virObjectEventPtr event = NULL;
1279 1280 1281
    const char *name = NULL;

    name = udev_device_get_syspath(device);
1282
    if (!(obj = virNodeDeviceObjListFindBySysfsPath(driver->devs, name))) {
1283 1284
        VIR_DEBUG("Failed to find device to remove that has udev name '%s'",
                  name);
1285
        return -1;
1286
    }
1287
    def = virNodeDeviceObjGetDef(obj);
1288

1289
    event = virNodeDeviceEventLifecycleNew(def->name,
1290 1291 1292 1293
                                           VIR_NODE_DEVICE_EVENT_DELETED,
                                           0);

    VIR_DEBUG("Removing device '%s' with sysfs path '%s'",
1294
              def->name, name);
1295
    virNodeDeviceObjListRemove(driver->devs, obj);
1296
    virObjectUnref(obj);
1297

1298
    virObjectEventStateQueue(driver->nodeDeviceEventState, event);
1299
    return 0;
1300 1301 1302
}


1303 1304 1305
static int
udevSetParent(struct udev_device *device,
              virNodeDeviceDefPtr def)
1306 1307 1308
{
    struct udev_device *parent_device = NULL;
    const char *parent_sysfs_path = NULL;
1309
    virNodeDeviceObjPtr obj = NULL;
1310
    virNodeDeviceDefPtr objdef;
1311 1312
    int ret = -1;

1313 1314
    parent_device = device;
    do {
1315

1316
        parent_device = udev_device_get_parent(parent_device);
1317
        if (parent_device == NULL)
1318
            break;
1319

1320 1321
        parent_sysfs_path = udev_device_get_syspath(parent_device);
        if (parent_sysfs_path == NULL) {
1322 1323 1324
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("Could not get syspath for parent of '%s'"),
                           udev_device_get_syspath(parent_device));
1325
            goto cleanup;
1326 1327
        }

1328 1329
        if ((obj = virNodeDeviceObjListFindBySysfsPath(driver->devs,
                                                       parent_sysfs_path))) {
1330
            objdef = virNodeDeviceObjGetDef(obj);
1331
            if (VIR_STRDUP(def->parent, objdef->name) < 0) {
1332
                virNodeDeviceObjEndAPI(&obj);
1333
                goto cleanup;
1334
            }
1335
            virNodeDeviceObjEndAPI(&obj);
1336

1337
            if (VIR_STRDUP(def->parent_sysfs_path, parent_sysfs_path) < 0)
1338
                goto cleanup;
1339 1340 1341 1342
        }

    } while (def->parent == NULL && parent_device != NULL);

1343
    if (!def->parent && VIR_STRDUP(def->parent, "computer") < 0)
1344
        goto cleanup;
1345 1346 1347

    ret = 0;

1348
 cleanup:
1349 1350 1351 1352
    return ret;
}


1353 1354
static int
udevAddOneDevice(struct udev_device *device)
1355 1356
{
    virNodeDeviceDefPtr def = NULL;
1357
    virNodeDeviceObjPtr obj = NULL;
1358
    virNodeDeviceDefPtr objdef;
1359 1360
    virObjectEventPtr event = NULL;
    bool new_device = true;
1361 1362
    int ret = -1;

1363
    if (VIR_ALLOC(def) != 0)
1364
        goto cleanup;
1365

1366
    if (VIR_STRDUP(def->sysfs_path, udev_device_get_syspath(device)) < 0)
1367
        goto cleanup;
1368

1369
    if (udevGetStringProperty(device, "DRIVER", &def->driver) < 0)
1370
        goto cleanup;
1371

1372
    if (VIR_ALLOC(def->caps) != 0)
1373
        goto cleanup;
1374

1375
    if (udevGetDeviceType(device, &def->caps->data.type) != 0)
1376
        goto cleanup;
1377

1378 1379 1380
    if (udevGetDeviceNodes(device, def) != 0)
        goto cleanup;

1381
    if (udevGetDeviceDetails(device, def) != 0)
1382
        goto cleanup;
1383

1384
    if (udevSetParent(device, def) != 0)
1385
        goto cleanup;
1386

1387
    if ((obj = virNodeDeviceObjListFindByName(driver->devs, def->name))) {
1388
        virNodeDeviceObjEndAPI(&obj);
1389 1390 1391
        new_device = false;
    }

1392 1393
    /* If this is a device change, the old definition will be freed
     * and the current definition will take its place. */
1394
    if (!(obj = virNodeDeviceObjListAssignDef(driver->devs, def)))
1395
        goto cleanup;
1396
    objdef = virNodeDeviceObjGetDef(obj);
1397

1398
    if (new_device)
1399
        event = virNodeDeviceEventLifecycleNew(objdef->name,
1400 1401
                                               VIR_NODE_DEVICE_EVENT_CREATED,
                                               0);
1402
    else
1403
        event = virNodeDeviceEventUpdateNew(objdef->name);
1404

1405
    virNodeDeviceObjEndAPI(&obj);
1406 1407 1408

    ret = 0;

1409
 cleanup:
1410
    virObjectEventStateQueue(driver->nodeDeviceEventState, event);
1411

1412
    if (ret != 0) {
1413
        VIR_DEBUG("Discarding device %d %p %s", ret, def,
1414
                  def ? NULLSTR(def->sysfs_path) : "");
1415 1416 1417
        virNodeDeviceDefFree(def);
    }

1418 1419 1420 1421
    return ret;
}


1422 1423 1424
static int
udevProcessDeviceListEntry(struct udev *udev,
                           struct udev_list_entry *list_entry)
1425 1426 1427 1428 1429 1430 1431 1432
{
    struct udev_device *device;
    const char *name = NULL;
    int ret = -1;

    name = udev_list_entry_get_name(list_entry);

    device = udev_device_new_from_syspath(udev, name);
1433

1434 1435
    if (device != NULL) {
        if (udevAddOneDevice(device) != 0) {
1436 1437
            VIR_DEBUG("Failed to create node device for udev device '%s'",
                      name);
1438 1439 1440 1441
        }
        ret = 0;
    }

1442 1443
    udev_device_unref(device);

1444 1445 1446 1447
    return ret;
}


1448 1449 1450 1451 1452 1453 1454 1455
/* We do not care about every device (see udevGetDeviceType).
 * Do not bother enumerating over subsystems that do not
 * contain interesting devices.
 */
const char *subsystem_blacklist[] = {
    "acpi", "tty", "vc", "i2c",
};

1456 1457
static int
udevEnumerateAddMatches(struct udev_enumerate *udev_enumerate)
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471
{
    size_t i;

    for (i = 0; i < ARRAY_CARDINALITY(subsystem_blacklist); i++) {
        const char *s = subsystem_blacklist[i];
        if (udev_enumerate_add_nomatch_subsystem(udev_enumerate, s) < 0) {
            virReportSystemError(errno, "%s", _("failed to add susbsystem filter"));
            return -1;
        }
    }
    return 0;
}


1472 1473
static int
udevEnumerateDevices(struct udev *udev)
1474 1475 1476
{
    struct udev_enumerate *udev_enumerate = NULL;
    struct udev_list_entry *list_entry = NULL;
1477
    int ret = -1;
1478 1479

    udev_enumerate = udev_enumerate_new(udev);
1480 1481
    if (udevEnumerateAddMatches(udev_enumerate) < 0)
        goto cleanup;
1482

1483 1484
    if (udev_enumerate_scan_devices(udev_enumerate) < 0)
        VIR_WARN("udev scan devices failed");
1485 1486 1487 1488 1489 1490 1491

    udev_list_entry_foreach(list_entry,
                            udev_enumerate_get_list_entry(udev_enumerate)) {

        udevProcessDeviceListEntry(udev, list_entry);
    }

1492
    ret = 0;
1493
 cleanup:
1494 1495 1496 1497 1498
    udev_enumerate_unref(udev_enumerate);
    return ret;
}


1499 1500
static void
udevPCITranslateDeinit(void)
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
{
#if defined __s390__ || defined __s390x_
    /* Nothing was initialized, nothing needs to be cleaned up */
#else
    /* pci_system_cleanup returns void */
    pci_system_cleanup();
#endif
    return;
}


1512 1513
static int
nodeStateCleanup(void)
1514
{
1515 1516
    udevEventDataPtr priv = NULL;

J
Ján Tomko 已提交
1517 1518
    if (!driver)
        return -1;
1519

1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
    priv = driver->privateData;
    if (priv) {
        virObjectLock(priv);
        priv->threadQuit = true;
        virCondSignal(&priv->threadCond);
        virObjectUnlock(priv);
        virThreadJoin(&priv->th);
    }

    virObjectUnref(priv);
1530
    virObjectUnref(driver->nodeDeviceEventState);
1531

1532
    virNodeDeviceObjListFree(driver->devs);
J
Ján Tomko 已提交
1533 1534
    virMutexDestroy(&driver->lock);
    VIR_FREE(driver);
1535

J
Ján Tomko 已提交
1536 1537
    udevPCITranslateDeinit();
    return 0;
1538 1539 1540
}


1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
static int
udevHandleOneDevice(struct udev_device *device)
{
    const char *action = udev_device_get_action(device);

    VIR_DEBUG("udev action: '%s'", action);

    if (STREQ(action, "add") || STREQ(action, "change"))
        return udevAddOneDevice(device);

    if (STREQ(action, "remove"))
        return udevRemoveOneDevice(device);

    return 0;
}


1558 1559 1560
/* the caller must be holding the udevEventData object lock prior to calling
 * this function
 */
1561
static bool
1562
udevEventMonitorSanityCheck(udevEventDataPtr priv,
1563
                            int fd)
1564
{
1565
    int rc = -1;
1566

1567
    rc = udev_monitor_get_fd(priv->udev_monitor);
1568
    if (fd != rc) {
1569 1570 1571
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("File descriptor returned by udev %d does not "
                         "match node device file descriptor %d"),
1572
                       fd, rc);
1573 1574 1575 1576 1577 1578 1579 1580

        /* this is a non-recoverable error, let's remove the handle, so that we
         * don't get in here again because of some spurious behaviour and report
         * the same error multiple times
         */
        virEventRemoveHandle(priv->watch);
        priv->watch = -1;

1581
        return false;
1582 1583
    }

1584 1585 1586 1587
    return true;
}


1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
/**
 * udevEventHandleThread
 * @opaque: unused
 *
 * Thread to handle the udevEventHandleCallback processing when udev
 * tells us there's a device change for us (add, modify, delete, etc).
 *
 * Once notified there is data to be processed, the actual @device
 * data retrieval by libudev may be delayed due to how threads are
 * scheduled. In fact, the event loop could be scheduled earlier than
 * the handler thread, thus potentially emitting the very same event
 * the handler thread is currently trying to process, simply because
 * the data hadn't been retrieved from the socket.
 *
 * NB: Some older distros, such as CentOS 6, libudev opens sockets
 * without the NONBLOCK flag which might cause issues with event
 * based algorithm. Although the issue can be mitigated by resetting
 * priv->dataReady for each event found; however, the scheduler issues
 * would still come into play.
 */
1608
static void
1609
udevEventHandleThread(void *opaque ATTRIBUTE_UNUSED)
1610
{
1611
    udevEventDataPtr priv = driver->privateData;
1612 1613
    struct udev_device *device = NULL;

1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
    /* continue rather than break from the loop on non-fatal errors */
    while (1) {
        virObjectLock(priv);
        while (!priv->dataReady && !priv->threadQuit) {
            if (virCondWait(&priv->threadCond, &priv->parent.lock)) {
                virReportSystemError(errno, "%s",
                                     _("handler failed to wait on condition"));
                virObjectUnlock(priv);
                return;
            }
        }

        if (priv->threadQuit) {
            virObjectUnlock(priv);
            return;
        }
1630

1631 1632
        errno = 0;
        device = udev_monitor_receive_device(priv->udev_monitor);
1633 1634
        virObjectUnlock(priv);

1635 1636 1637 1638 1639 1640
        if (!device) {
            if (errno == 0) {
                virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                               _("failed to receive device from udev monitor"));
                return;
            }
1641

1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
            /* POSIX allows both EAGAIN and EWOULDBLOCK to be used
             * interchangeably when the read would block or timeout was fired
             */
            VIR_WARNINGS_NO_WLOGICALOP_EQUAL_EXPR
            if (errno != EAGAIN && errno != EWOULDBLOCK) {
            VIR_WARNINGS_RESET
                virReportSystemError(errno, "%s",
                                     _("failed to receive device from udev "
                                       "monitor"));
                return;
            }
1653

1654 1655 1656
            /* Trying to move the reset of the @priv->dataReady flag to
             * after the udev_monitor_receive_device wouldn't help much
             * due to event mgmt and scheduler timing. */
1657 1658 1659 1660 1661 1662 1663 1664 1665
            virObjectLock(priv);
            priv->dataReady = false;
            virObjectUnlock(priv);

            continue;
        }

        udevHandleOneDevice(device);
        udev_device_unref(device);
1666 1667 1668 1669 1670

        /* Instead of waiting for the next event after processing @device
         * data, let's keep reading from the udev monitor and only wait
         * for the next event once either a EAGAIN or a EWOULDBLOCK error
         * is encountered. */
1671
    }
1672 1673 1674
}


1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
static void
udevEventHandleCallback(int watch ATTRIBUTE_UNUSED,
                        int fd,
                        int events ATTRIBUTE_UNUSED,
                        void *data ATTRIBUTE_UNUSED)
{
    udevEventDataPtr priv = driver->privateData;

    virObjectLock(priv);

1685 1686 1687 1688 1689 1690 1691
    if (!udevEventMonitorSanityCheck(priv, fd))
        priv->threadQuit = true;
    else
        priv->dataReady = true;

    virCondSignal(&priv->threadCond);
    virObjectUnlock(priv);
1692 1693 1694
}


1695 1696
/* DMI is intel-compatible specific */
#if defined(__x86_64__) || defined(__i386__) || defined(__amd64__)
1697
static void
1698
udevGetDMIData(virNodeDevCapSystemPtr syscap)
1699
{
1700
    udevEventDataPtr priv = driver->privateData;
1701 1702
    struct udev *udev = NULL;
    struct udev_device *device = NULL;
1703 1704
    virNodeDevCapSystemHardwarePtr hardware = &syscap->hardware;
    virNodeDevCapSystemFirmwarePtr firmware = &syscap->firmware;
1705

1706
    virObjectLock(priv);
1707
    udev = udev_monitor_get_udev(priv->udev_monitor);
1708

1709 1710
    device = udev_device_new_from_syspath(udev, DMI_DEVPATH);
    if (device == NULL) {
1711 1712
        device = udev_device_new_from_syspath(udev, DMI_DEVPATH_FALLBACK);
        if (device == NULL) {
1713 1714 1715
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("Failed to get udev device for syspath '%s' or '%s'"),
                           DMI_DEVPATH, DMI_DEVPATH_FALLBACK);
1716
            virObjectUnlock(priv);
1717
            return;
1718
        }
1719
    }
1720
    virObjectUnlock(priv);
1721

1722
    if (udevGetStringSysfsAttr(device, "product_name",
1723
                               &syscap->product_name) < 0)
1724
        goto cleanup;
1725
    if (udevGetStringSysfsAttr(device, "sys_vendor",
1726
                               &hardware->vendor_name) < 0)
1727
        goto cleanup;
1728
    if (udevGetStringSysfsAttr(device, "product_version",
1729
                               &hardware->version) < 0)
1730
        goto cleanup;
1731
    if (udevGetStringSysfsAttr(device, "product_serial",
1732
                               &hardware->serial) < 0)
1733
        goto cleanup;
1734

1735
    if (virGetHostUUID(hardware->uuid))
1736
        goto cleanup;
1737

1738
    if (udevGetStringSysfsAttr(device, "bios_vendor",
1739
                               &firmware->vendor_name) < 0)
1740
        goto cleanup;
1741
    if (udevGetStringSysfsAttr(device, "bios_version",
1742
                               &firmware->version) < 0)
1743
        goto cleanup;
1744
    if (udevGetStringSysfsAttr(device, "bios_date",
1745
                               &firmware->release_date) < 0)
1746
        goto cleanup;
1747

1748
 cleanup:
1749
    if (device != NULL)
1750 1751 1752
        udev_device_unref(device);
    return;
}
1753
#endif
1754 1755


1756 1757
static int
udevSetupSystemDev(void)
1758 1759
{
    virNodeDeviceDefPtr def = NULL;
1760
    virNodeDeviceObjPtr obj = NULL;
1761 1762
    int ret = -1;

1763 1764
    if (VIR_ALLOC(def) < 0)
        return -1;
1765

1766
    if (VIR_STRDUP(def->name, "computer") < 0)
1767
        goto cleanup;
1768

1769
    if (VIR_ALLOC(def->caps) != 0)
1770
        goto cleanup;
1771

1772
#if defined(__x86_64__) || defined(__i386__) || defined(__amd64__)
1773
    udevGetDMIData(&def->caps->data.system);
1774
#endif
1775

1776
    if (!(obj = virNodeDeviceObjListAssignDef(driver->devs, def)))
1777
        goto cleanup;
1778

1779
    virNodeDeviceObjEndAPI(&obj);
1780 1781 1782

    ret = 0;

1783
 cleanup:
1784
    if (ret == -1)
1785 1786
        virNodeDeviceDefFree(def);

1787 1788 1789
    return ret;
}

1790

1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809
static void
nodeStateInitializeEnumerate(void *opaque)
{
    struct udev *udev = opaque;
    udevEventDataPtr priv = driver->privateData;

    /* Populate with known devices */
    if (udevEnumerateDevices(udev) != 0)
        goto error;

    return;

 error:
    virObjectLock(priv);
    priv->threadQuit = true;
    virObjectUnlock(priv);
}


1810 1811
static int
udevPCITranslateInit(bool privileged ATTRIBUTE_UNUSED)
1812
{
1813 1814 1815 1816
#if defined __s390__ || defined __s390x_
    /* On s390(x) system there is no PCI bus.
     * Therefore there is nothing to initialize here. */
#else
1817
    int rc;
1818

1819
    if ((rc = pci_system_init()) != 0) {
1820 1821 1822
        /* Ignore failure as non-root; udev is not as helpful in that
         * situation, but a non-privileged user won't benefit much
         * from udev in the first place.  */
1823
        if (errno != ENOENT && (privileged  || errno != EACCES)) {
1824 1825
            virReportSystemError(rc, "%s",
                                 _("Failed to initialize libpciaccess"));
1826
            return -1;
1827
        }
1828
    }
1829
#endif
1830 1831 1832
    return 0;
}

1833 1834 1835 1836 1837

static int
nodeStateInitialize(bool privileged,
                    virStateInhibitCallback callback ATTRIBUTE_UNUSED,
                    void *opaque ATTRIBUTE_UNUSED)
1838
{
1839
    udevEventDataPtr priv = NULL;
1840
    struct udev *udev = NULL;
1841
    virThread enumThread;
1842

1843
    if (VIR_ALLOC(driver) < 0)
1844
        return -1;
1845

1846
    if (virMutexInit(&driver->lock) < 0) {
1847 1848
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("Unable to initialize mutex"));
1849
        VIR_FREE(driver);
1850
        return -1;
1851 1852
    }

1853 1854
    driver->privileged = privileged;

1855 1856
    if (!(driver->devs = virNodeDeviceObjListNew()) ||
        !(priv = udevEventDataNew()))
1857
        goto cleanup;
1858

1859
    driver->privateData = priv;
1860
    driver->nodeDeviceEventState = virObjectEventStateNew();
1861

1862
    if (udevPCITranslateInit(privileged) < 0)
1863
        goto cleanup;
1864

1865
    udev = udev_new();
1866 1867 1868
    if (!udev) {
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("failed to create udev context"));
1869
        goto cleanup;
1870
    }
1871
#if HAVE_UDEV_LOGGING
J
Ján Tomko 已提交
1872 1873
    /* cast to get rid of missing-format-attribute warning */
    udev_set_log_fn(udev, (udevLogFunctionPtr) udevLogFunction);
1874
#endif
1875

1876 1877
    virObjectLock(priv);

1878
    priv->udev_monitor = udev_monitor_new_from_netlink(udev, "udev");
1879
    if (!priv->udev_monitor) {
1880 1881
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("udev_monitor_new_from_netlink returned NULL"));
1882
        goto unlock;
1883 1884
    }

1885
    udev_monitor_enable_receiving(priv->udev_monitor);
1886

1887
#if HAVE_UDEV_MONITOR_SET_RECEIVE_BUFFER_SIZE
1888 1889 1890 1891 1892 1893
    /* mimic udevd's behaviour and override the systems rmem_max limit in case
     * there's a significant number of device 'add' events
     */
    if (geteuid() == 0)
        udev_monitor_set_receive_buffer_size(priv->udev_monitor,
                                             128 * 1024 * 1024);
1894
#endif
1895

1896 1897 1898 1899 1900 1901
    if (virThreadCreate(&priv->th, true, udevEventHandleThread, NULL) < 0) {
        virReportSystemError(errno, "%s",
                             _("failed to create udev handler thread"));
        goto unlock;
    }

1902 1903 1904 1905 1906 1907 1908 1909
    /* We register the monitor with the event callback so we are
     * notified by udev of device changes before we enumerate existing
     * devices because libvirt will simply recreate the device if we
     * try to register it twice, i.e., if the device appears between
     * the time we register the callback and the time we begin
     * enumeration.  The alternative is to register the callback after
     * we enumerate, in which case we will fail to create any devices
     * that appear while the enumeration is taking place.  */
1910 1911 1912
    priv->watch = virEventAddHandle(udev_monitor_get_fd(priv->udev_monitor),
                                    VIR_EVENT_HANDLE_READABLE,
                                    udevEventHandleCallback, NULL, NULL);
1913
    if (priv->watch == -1)
1914
        goto unlock;
1915

1916 1917
    virObjectUnlock(priv);

1918
    /* Create a fictional 'computer' device to root the device tree. */
1919
    if (udevSetupSystemDev() != 0)
1920
        goto cleanup;
1921

1922 1923 1924 1925
    if (virThreadCreate(&enumThread, false, nodeStateInitializeEnumerate,
                        udev) < 0) {
        virReportSystemError(errno, "%s",
                             _("failed to create udev enumerate thread"));
1926
        goto cleanup;
1927
    }
1928

1929
    return 0;
1930

1931
 cleanup:
1932 1933
    nodeStateCleanup();
    return -1;
1934 1935

 unlock:
1936
    virObjectUnlock(priv);
1937
    goto cleanup;
1938 1939 1940
}


1941 1942
static int
nodeStateReload(void)
1943 1944 1945 1946 1947
{
    return 0;
}


1948
static virNodeDeviceDriver udevNodeDeviceDriver = {
1949
    .name = "udev",
1950 1951
    .nodeNumOfDevices = nodeNumOfDevices, /* 0.7.3 */
    .nodeListDevices = nodeListDevices, /* 0.7.3 */
1952
    .connectListAllNodeDevices = nodeConnectListAllNodeDevices, /* 0.10.2 */
1953 1954
    .connectNodeDeviceEventRegisterAny = nodeConnectNodeDeviceEventRegisterAny, /* 2.2.0 */
    .connectNodeDeviceEventDeregisterAny = nodeConnectNodeDeviceEventDeregisterAny, /* 2.2.0 */
1955 1956 1957 1958 1959 1960 1961 1962
    .nodeDeviceLookupByName = nodeDeviceLookupByName, /* 0.7.3 */
    .nodeDeviceLookupSCSIHostByWWN = nodeDeviceLookupSCSIHostByWWN, /* 1.0.2 */
    .nodeDeviceGetXMLDesc = nodeDeviceGetXMLDesc, /* 0.7.3 */
    .nodeDeviceGetParent = nodeDeviceGetParent, /* 0.7.3 */
    .nodeDeviceNumOfCaps = nodeDeviceNumOfCaps, /* 0.7.3 */
    .nodeDeviceListCaps = nodeDeviceListCaps, /* 0.7.3 */
    .nodeDeviceCreateXML = nodeDeviceCreateXML, /* 0.7.3 */
    .nodeDeviceDestroy = nodeDeviceDestroy, /* 0.7.3 */
1963 1964
};

1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976

static virHypervisorDriver udevHypervisorDriver = {
    .name = "nodedev",
    .connectOpen = nodeConnectOpen, /* 4.1.0 */
    .connectClose = nodeConnectClose, /* 4.1.0 */
    .connectIsEncrypted = nodeConnectIsEncrypted, /* 4.1.0 */
    .connectIsSecure = nodeConnectIsSecure, /* 4.1.0 */
    .connectIsAlive = nodeConnectIsAlive, /* 4.1.0 */
};


static virConnectDriver udevConnectDriver = {
1977
    .localOnly = true,
1978
    .uriSchemes = (const char *[]){ "nodedev", NULL },
1979 1980 1981 1982 1983
    .hypervisorDriver = &udevHypervisorDriver,
    .nodeDeviceDriver = &udevNodeDeviceDriver,
};


1984
static virStateDriver udevStateDriver = {
M
Matthias Bolte 已提交
1985
    .name = "udev",
1986 1987 1988
    .stateInitialize = nodeStateInitialize, /* 0.7.3 */
    .stateCleanup = nodeStateCleanup, /* 0.7.3 */
    .stateReload = nodeStateReload, /* 0.7.3 */
1989 1990
};

1991 1992 1993

int
udevNodeRegister(void)
1994
{
1995
    VIR_DEBUG("Registering udev node device backend");
1996

1997 1998
    if (virRegisterConnectDriver(&udevConnectDriver, false) < 0)
        return -1;
1999
    if (virSetSharedNodeDeviceDriver(&udevNodeDeviceDriver) < 0)
2000 2001 2002 2003
        return -1;

    return virRegisterStateDriver(&udevStateDriver);
}