src/modules/module-udev-detect.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2009 Lennart Poettering
   5
   6   PulseAudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU Lesser General Public License as
   8   published by the Free Software Foundation; either version 2.1 of the
   9   License, or (at your option) any later version.
  10
  11   PulseAudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public
  17   License along with PulseAudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <errno.h>
  27 #include <limits.h>
  28 #include <sys/inotify.h>
  29 #include <libudev.h>
  30
  31 #include <pulsecore/modargs.h>
  32 #include <pulsecore/core-error.h>
  33 #include <pulsecore/core-util.h>
  34 #include <pulsecore/namereg.h>
  35
  36 #include "module-udev-detect-symdef.h"
  37
  38 PA_MODULE_AUTHOR("Lennart Poettering");
  39 PA_MODULE_DESCRIPTION("Detect available audio hardware and load matching drivers");
  40 PA_MODULE_VERSION(PACKAGE_VERSION);
  41 PA_MODULE_LOAD_ONCE(TRUE);
  42 PA_MODULE_USAGE(
  43         "tsched=<enable system timer based scheduling mode?> "
  44         "ignore_dB=<ignore dB information from the device?>");
  45
  46 struct device {
  47     char *path;
  48     pa_bool_t accessible:1;
  49     pa_bool_t need_verify:1;
  50     char *card_name;
  51     char *args;
  52     uint32_t module;
  53 };
  54
  55 struct userdata {
  56     pa_core *core;
  57     pa_hashmap *devices;
  58
  59     pa_bool_t use_tsched:1;
  60     pa_bool_t ignore_dB:1;
  61
  62     struct udev* udev;
  63     struct udev_monitor *monitor;
  64     pa_io_event *udev_io;
  65
  66     int inotify_fd;
  67     pa_io_event *inotify_io;
  68 };
  69
  70 static const char* const valid_modargs[] = {
  71     "tsched",
  72     "ignore_dB",
  73     NULL
  74 };
  75
  76 static int setup_inotify(struct userdata *u);
  77
  78 static void device_free(struct device *d) {
  79     pa_assert(d);
  80
  81     pa_xfree(d->path);
  82     pa_xfree(d->card_name);
  83     pa_xfree(d->args);
  84     pa_xfree(d);
  85 }
  86
  87 static const char *path_get_card_id(const char *path) {
  88     const char *e;
  89
  90     if (!path)
  91         return NULL;
  92
  93     if (!(e = strrchr(path, '/')))
  94         return NULL;
  95
  96     if (!pa_startswith(e, "/card"))
  97         return NULL;
  98
  99     return e + 5;
 100 }
 101
 102 static void verify_access(struct userdata *u, struct device *d) {
 103     char *cd;
 104     pa_card *card;
 105
 106     pa_assert(u);
 107     pa_assert(d);
 108
 109     cd = pa_sprintf_malloc("%s/snd/controlC%s", udev_get_dev_path(u->udev), path_get_card_id(d->path));
 110     d->accessible = access(cd, R_OK|W_OK) >= 0;
 111
 112     pa_log_info("%s is accessible: %s", cd, pa_yes_no(d->accessible));
 113     pa_xfree(cd);
 114
 115     if (d->module == PA_INVALID_INDEX) {
 116
 117         /* If we not loaded, try to load */
 118
 119         if (d->accessible) {
 120             pa_module *m;
 121
 122             pa_log_debug("Loading module-alsa-card with arguments '%s'", d->args);
 123             m = pa_module_load(u->core, "module-alsa-card", d->args);
 124
 125             if (m) {
 126                 d->module = m->index;
 127                 pa_log_info("Card %s (%s) module loaded.", d->path, d->card_name);
 128             } else
 129                 pa_log_info("Card %s (%s) failed to load module.", d->path, d->card_name);
 130         }
 131
 132     } else {
 133
 134         /* If we are already loaded update suspend status with
 135          * accessible boolean */
 136
 137         if ((card = pa_namereg_get(u->core, d->card_name, PA_NAMEREG_CARD)))
 138             pa_card_suspend(card, !d->accessible, PA_SUSPEND_SESSION);
 139     }
 140 }
 141
 142 static void card_changed(struct userdata *u, struct udev_device *dev) {
 143     struct device *d;
 144     const char *path;
 145     const char *t;
 146     char *n;
 147
 148     pa_assert(u);
 149     pa_assert(dev);
 150
 151     /* Maybe /dev/snd is now available? */
 152     setup_inotify(u);
 153
 154     path = udev_device_get_devpath(dev);
 155
 156     if ((d = pa_hashmap_get(u->devices, path))) {
 157         verify_access(u, d);
 158         return;
 159     }
 160
 161     d = pa_xnew0(struct device, 1);
 162     d->path = pa_xstrdup(path);
 163     d->accessible = TRUE;
 164     d->module = PA_INVALID_INDEX;
 165
 166     if (!(t = udev_device_get_property_value(dev, "PULSE_NAME")))
 167         if (!(t = udev_device_get_property_value(dev, "ID_ID")))
 168             if (!(t = udev_device_get_property_value(dev, "ID_PATH")))
 169                 t = path_get_card_id(path);
 170
 171     n = pa_namereg_make_valid_name(t);
 172     d->card_name = pa_sprintf_malloc("alsa_card.%s", n);
 173     d->args = pa_sprintf_malloc("device_id=\"%s\" "
 174                                 "name=\"%s\" "
 175                                 "card_name=\"%s\" "
 176                                 "tsched=%s "
 177                                 "ignore_dB=%s "
 178                                 "card_properties=\"module-udev-detect.discovered=1\"",
 179                                 path_get_card_id(path),
 180                                 n,
 181                                 d->card_name,
 182                                 pa_yes_no(u->use_tsched),
 183                                 pa_yes_no(u->ignore_dB));
 184     pa_xfree(n);
 185
 186     pa_hashmap_put(u->devices, d->path, d);
 187
 188     verify_access(u, d);
 189 }
 190
 191 static void remove_card(struct userdata *u, struct udev_device *dev) {
 192     struct device *d;
 193
 194     pa_assert(u);
 195     pa_assert(dev);
 196
 197     if (!(d = pa_hashmap_remove(u->devices, udev_device_get_devpath(dev))))
 198         return;
 199
 200     pa_log_info("Card %s removed.", d->path);
 201
 202     if (d->module != PA_INVALID_INDEX)
 203         pa_module_unload_request_by_index(u->core, d->module, TRUE);
 204
 205     device_free(d);
 206 }
 207
 208 static void process_device(struct userdata *u, struct udev_device *dev) {
 209     const char *action, *ff;
 210
 211     pa_assert(u);
 212     pa_assert(dev);
 213
 214     if (udev_device_get_property_value(dev, "PULSE_IGNORE")) {
 215         pa_log_debug("Ignoring %s, because marked so.", udev_device_get_devpath(dev));
 216         return;
 217     }
 218
 219     if ((ff = udev_device_get_property_value(dev, "SOUND_FORM_FACTOR")) &&
 220         pa_streq(ff, "modem")) {
 221         pa_log_debug("Ignoring %s, because it is a modem.", udev_device_get_devpath(dev));
 222         return;
 223     }
 224
 225     action = udev_device_get_action(dev);
 226
 227     if (action && pa_streq(action, "remove"))
 228         remove_card(u, dev);
 229     else if ((!action || pa_streq(action, "change")) &&
 230              udev_device_get_property_value(dev, "SOUND_INITIALIZED"))
 231         card_changed(u, dev);
 232
 233     /* For an explanation why we don't look for 'add' events here
 234      * have a look into /lib/udev/rules.d/78-sound-card.rules! */
 235 }
 236
 237 static void process_path(struct userdata *u, const char *path) {
 238     struct udev_device *dev;
 239
 240     if (!path_get_card_id(path))
 241         return;
 242
 243     if (!(dev = udev_device_new_from_syspath(u->udev, path))) {
 244         pa_log("Failed to get udev device object from udev.");
 245         return;
 246     }
 247
 248     process_device(u, dev);
 249     udev_device_unref(dev);
 250 }
 251
 252 static void monitor_cb(
 253         pa_mainloop_api*a,
 254         pa_io_event* e,
 255         int fd,
 256         pa_io_event_flags_t events,
 257         void *userdata) {
 258
 259     struct userdata *u = userdata;
 260     struct udev_device *dev;
 261
 262     pa_assert(a);
 263
 264     if (!(dev = udev_monitor_receive_device(u->monitor))) {
 265         pa_log("Failed to get udev device object from monitor.");
 266         goto fail;
 267     }
 268
 269     if (!path_get_card_id(udev_device_get_devpath(dev)))
 270         return;
 271
 272     process_device(u, dev);
 273     udev_device_unref(dev);
 274     return;
 275
 276 fail:
 277     a->io_free(u->udev_io);
 278     u->udev_io = NULL;
 279 }
 280
 281 static pa_bool_t pcm_node_belongs_to_device(
 282         struct device *d,
 283         const char *node) {
 284
 285     char *cd;
 286     pa_bool_t b;
 287
 288     cd = pa_sprintf_malloc("pcmC%sD", path_get_card_id(d->path));
 289     b = pa_startswith(node, cd);
 290     pa_xfree(cd);
 291
 292     return b;
 293 }
 294
 295 static pa_bool_t control_node_belongs_to_device(
 296         struct device *d,
 297         const char *node) {
 298
 299     char *cd;
 300     pa_bool_t b;
 301
 302     cd = pa_sprintf_malloc("controlC%s", path_get_card_id(d->path));
 303     b = pa_streq(node, cd);
 304     pa_xfree(cd);
 305
 306     return b;
 307 }
 308
 309 static void inotify_cb(
 310         pa_mainloop_api*a,
 311         pa_io_event* e,
 312         int fd,
 313         pa_io_event_flags_t events,
 314         void *userdata) {
 315
 316     struct {
 317         struct inotify_event e;
 318         char name[NAME_MAX];
 319     } buf;
 320     struct userdata *u = userdata;
 321     static int type = 0;
 322     pa_bool_t deleted = FALSE;
 323     struct device *d;
 324     void *state;
 325
 326     for (;;) {
 327         ssize_t r;
 328
 329         pa_zero(buf);
 330         if ((r = pa_read(fd, &buf, sizeof(buf), &type)) <= 0) {
 331
 332             if (r < 0 && errno == EAGAIN)
 333                 break;
 334
 335             pa_log("read() from inotify failed: %s", r < 0 ? pa_cstrerror(errno) : "EOF");
 336             goto fail;
 337         }
 338
 339         /* From udev we get the guarantee that the control
 340          * device's ACL is changes last. To avoid races when ACLs
 341          * are changed we hence watch only the control device */
 342         if (((buf.e.mask & IN_ATTRIB) && pa_startswith(buf.e.name, "controlC")))
 343             PA_HASHMAP_FOREACH(d, u->devices, state)
 344                 if (control_node_belongs_to_device(d, buf.e.name))
 345                     d->need_verify = TRUE;
 346
 347         /* ALSA doesn't really give us any guarantee on the closing
 348          * order, so let's simply hope */
 349         if (((buf.e.mask & IN_CLOSE_WRITE) && pa_startswith(buf.e.name, "pcmC")))
 350             PA_HASHMAP_FOREACH(d, u->devices, state)
 351                 if (pcm_node_belongs_to_device(d, buf.e.name))
 352                     d->need_verify = TRUE;
 353
 354         if ((buf.e.mask & (IN_DELETE_SELF|IN_MOVE_SELF)))
 355             deleted = TRUE;
 356     }
 357
 358     PA_HASHMAP_FOREACH(d, u->devices, state)
 359         if (d->need_verify) {
 360             d->need_verify = FALSE;
 361             verify_access(u, d);
 362         }
 363
 364     if (!deleted)
 365         return;
 366
 367 fail:
 368     if (u->inotify_io) {
 369         a->io_free(u->inotify_io);
 370         u->inotify_io = NULL;
 371     }
 372
 373     if (u->inotify_fd >= 0) {
 374         pa_close(u->inotify_fd);
 375         u->inotify_fd = -1;
 376     }
 377 }
 378
 379 static int setup_inotify(struct userdata *u) {
 380     char *dev_snd;
 381     int r;
 382
 383     if (u->inotify_fd >= 0)
 384         return 0;
 385
 386     if ((u->inotify_fd = inotify_init1(IN_CLOEXEC|IN_NONBLOCK)) < 0) {
 387         pa_log("inotify_init1() failed: %s", pa_cstrerror(errno));
 388         return -1;
 389     }
 390
 391     dev_snd = pa_sprintf_malloc("%s/snd", udev_get_dev_path(u->udev));
 392     r = inotify_add_watch(u->inotify_fd, dev_snd, IN_CLOSE_WRITE|IN_DELETE_SELF|IN_MOVE_SELF);
 393     pa_xfree(dev_snd);
 394
 395     if (r < 0) {
 396         int saved_errno = errno;
 397
 398         pa_close(u->inotify_fd);
 399         u->inotify_fd = -1;
 400
 401         if (saved_errno == ENOENT) {
 402             pa_log_debug("/dev/snd/ is apparently not existing yet, retrying to create inotify watch later.");
 403             return 0;
 404         }
 405
 406         if (saved_errno == ENOSPC) {
 407             pa_log("You apparently ran out of inotify watches, probably because Tracker/Beagle took them all away. "
 408                    "I wished people would do their homework first and fix inotify before using it for watching whole "
 409                    "directory trees which is something the current inotify is certainly not useful for. "
 410                    "Please make sure to drop the Tracker/Beagle guys a line complaining about their broken use of inotify.");
 411             return 0;
 412         }
 413
 414         pa_log("inotify_add_watch() failed: %s", pa_cstrerror(saved_errno));
 415         return -1;
 416     }
 417
 418     pa_assert_se(u->inotify_io = u->core->mainloop->io_new(u->core->mainloop, u->inotify_fd, PA_IO_EVENT_INPUT, inotify_cb, u));
 419
 420     return 0;
 421 }
 422
 423 int pa__init(pa_module *m) {
 424     struct userdata *u = NULL;
 425     pa_modargs *ma;
 426     struct udev_enumerate *enumerate = NULL;
 427     struct udev_list_entry *item = NULL, *first = NULL;
 428     int fd;
 429     pa_bool_t use_tsched = TRUE, ignore_dB = FALSE;
 430
 431     pa_assert(m);
 432
 433     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 434         pa_log("Failed to parse module arguments");
 435         goto fail;
 436     }
 437
 438     m->userdata = u = pa_xnew0(struct userdata, 1);
 439     u->core = m->core;
 440     u->devices = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
 441     u->inotify_fd = -1;
 442
 443     if (pa_modargs_get_value_boolean(ma, "tsched", &use_tsched) < 0) {
 444         pa_log("Failed to parse tsched= argument.");
 445         goto fail;
 446     }
 447     u->use_tsched = use_tsched;
 448
 449     if (pa_modargs_get_value_boolean(ma, "ignore_dB", &ignore_dB) < 0) {
 450         pa_log("Failed to parse ignore_dB= argument.");
 451         goto fail;
 452     }
 453     u->ignore_dB = ignore_dB;
 454
 455     if (!(u->udev = udev_new())) {
 456         pa_log("Failed to initialize udev library.");
 457         goto fail;
 458     }
 459
 460     if (setup_inotify(u) < 0)
 461         goto fail;
 462
 463     if (!(u->monitor = udev_monitor_new_from_netlink(u->udev, "udev"))) {
 464         pa_log("Failed to initialize monitor.");
 465         goto fail;
 466     }
 467
 468     errno = 0;
 469     if (udev_monitor_enable_receiving(u->monitor) < 0) {
 470         pa_log("Failed to enable monitor: %s", pa_cstrerror(errno));
 471         if (errno == EPERM)
 472             pa_log_info("Most likely your kernel is simply too old and "
 473                         "allows only priviliged processes to listen to device events. "
 474                         "Please upgrade your kernel to at least 2.6.30.");
 475         goto fail;
 476     }
 477
 478     if ((fd = udev_monitor_get_fd(u->monitor)) < 0) {
 479         pa_log("Failed to get udev monitor fd.");
 480         goto fail;
 481     }
 482
 483     pa_assert_se(u->udev_io = u->core->mainloop->io_new(u->core->mainloop, fd, PA_IO_EVENT_INPUT, monitor_cb, u));
 484
 485     if (!(enumerate = udev_enumerate_new(u->udev))) {
 486         pa_log("Failed to initialize udev enumerator.");
 487         goto fail;
 488     }
 489
 490     if (udev_enumerate_add_match_subsystem(enumerate, "sound") < 0) {
 491         pa_log("Failed to match to subsystem.");
 492         goto fail;
 493     }
 494
 495     if (udev_enumerate_scan_devices(enumerate) < 0) {
 496         pa_log("Failed to scan for devices.");
 497         goto fail;
 498     }
 499
 500     first = udev_enumerate_get_list_entry(enumerate);
 501     udev_list_entry_foreach(item, first)
 502         process_path(u, udev_list_entry_get_name(item));
 503
 504     udev_enumerate_unref(enumerate);
 505
 506     pa_log_info("Found %u cards.", pa_hashmap_size(u->devices));
 507
 508     pa_modargs_free(ma);
 509
 510     return 0;
 511
 512 fail:
 513
 514     if (enumerate)
 515         udev_enumerate_unref(enumerate);
 516
 517     if (ma)
 518         pa_modargs_free(ma);
 519
 520     pa__done(m);
 521
 522     return -1;
 523 }
 524
 525 void pa__done(pa_module *m) {
 526     struct userdata *u;
 527
 528     pa_assert(m);
 529
 530     if (!(u = m->userdata))
 531         return;
 532
 533     if (u->udev_io)
 534         m->core->mainloop->io_free(u->udev_io);
 535
 536     if (u->monitor)
 537         udev_monitor_unref(u->monitor);
 538
 539     if (u->udev)
 540         udev_unref(u->udev);
 541
 542     if (u->inotify_io)
 543         m->core->mainloop->io_free(u->inotify_io);
 544
 545     if (u->inotify_fd >= 0)
 546         pa_close(u->inotify_fd);
 547
 548     if (u->devices) {
 549         struct device *d;
 550
 551         while ((d = pa_hashmap_steal_first(u->devices)))
 552             device_free(d);
 553
 554         pa_hashmap_free(u->devices, NULL, NULL);
 555     }
 556
 557     pa_xfree(u);
 558 }