2 This file is part of PulseAudio.
4 Copyright 2009 Lennart Poettering
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.
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.
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
29 #include <sys/inotify.h>
32 #include <pulse/timeval.h>
34 #include <pulsecore/modargs.h>
35 #include <pulsecore/core-error.h>
36 #include <pulsecore/core-util.h>
37 #include <pulsecore/namereg.h>
38 #include <pulsecore/ratelimit.h>
40 #include "module-udev-detect-symdef.h"
42 PA_MODULE_AUTHOR("Lennart Poettering");
43 PA_MODULE_DESCRIPTION("Detect available audio hardware and load matching drivers");
44 PA_MODULE_VERSION(PACKAGE_VERSION);
45 PA_MODULE_LOAD_ONCE(TRUE);
47 "tsched=<enable system timer based scheduling mode?> "
48 "ignore_dB=<ignore dB information from the device?> "
49 "sync_volume=<syncronize sw and hw voluchanges in IO-thread?>");
53 pa_bool_t need_verify;
57 pa_ratelimit ratelimit;
64 pa_bool_t use_tsched:1;
65 pa_bool_t ignore_dB:1;
66 pa_bool_t sync_volume:1;
69 struct udev_monitor *monitor;
73 pa_io_event *inotify_io;
76 static const char* const valid_modargs[] = {
83 static int setup_inotify(struct userdata *u);
85 static void device_free(struct device *d) {
89 pa_xfree(d->card_name);
94 static const char *path_get_card_id(const char *path) {
100 if (!(e = strrchr(path, '/')))
103 if (!pa_startswith(e, "/card"))
109 static char *card_get_sysattr(const char *card_idx, const char *name) {
111 struct udev_device *card = NULL;
118 if (!(udev = udev_new())) {
119 pa_log_error("Failed to allocate udev context.");
123 t = pa_sprintf_malloc("%s/class/sound/card%s", udev_get_sys_path(udev), card_idx);
124 card = udev_device_new_from_syspath(udev, t);
128 pa_log_error("Failed to get card object.");
132 if ((v = udev_device_get_sysattr_value(card, name)) && *v)
138 udev_device_unref(card);
146 static pa_bool_t pcm_is_modem(const char *card_idx, const char *pcm) {
147 char *sysfs_path, *pcm_class;
153 /* Check /sys/class/sound/card.../pcmC...../pcm_class. An HDA
154 * modem can be used simultaneously with generic
155 * playback/record. */
157 sysfs_path = pa_sprintf_malloc("pcmC%sD%s/pcm_class", card_idx, pcm);
158 pcm_class = card_get_sysattr(card_idx, sysfs_path);
159 is_modem = pcm_class && pa_streq(pcm_class, "modem");
161 pa_xfree(sysfs_path);
166 static pa_bool_t is_card_busy(const char *id) {
167 char *card_path = NULL, *pcm_path = NULL, *sub_status = NULL;
168 DIR *card_dir = NULL, *pcm_dir = NULL;
169 FILE *status_file = NULL;
171 struct dirent *space = NULL, *de;
172 pa_bool_t busy = FALSE;
177 /* This simply uses /proc/asound/card.../pcm.../sub.../status to
178 * check whether there is still a process using this audio device. */
180 card_path = pa_sprintf_malloc("/proc/asound/card%s", id);
182 if (!(card_dir = opendir(card_path))) {
183 pa_log_warn("Failed to open %s: %s", card_path, pa_cstrerror(errno));
187 len = offsetof(struct dirent, d_name) + fpathconf(dirfd(card_dir), _PC_NAME_MAX) + 1;
188 space = pa_xmalloc(len);
193 if ((r = readdir_r(card_dir, space, &de)) != 0) {
194 pa_log_warn("readdir_r() failed: %s", pa_cstrerror(r));
201 if (!pa_startswith(de->d_name, "pcm"))
204 if (pcm_is_modem(id, de->d_name + 3))
208 pcm_path = pa_sprintf_malloc("%s/%s", card_path, de->d_name);
213 if (!(pcm_dir = opendir(pcm_path))) {
214 pa_log_warn("Failed to open %s: %s", pcm_path, pa_cstrerror(errno));
221 if ((r = readdir_r(pcm_dir, space, &de)) != 0) {
222 pa_log_warn("readdir_r() failed: %s", pa_cstrerror(r));
229 if (!pa_startswith(de->d_name, "sub"))
232 pa_xfree(sub_status);
233 sub_status = pa_sprintf_malloc("%s/%s/status", pcm_path, de->d_name);
238 if (!(status_file = pa_fopen_cloexec(sub_status, "r"))) {
239 pa_log_warn("Failed to open %s: %s", sub_status, pa_cstrerror(errno));
243 if (!(fgets(line, sizeof(line)-1, status_file))) {
244 pa_log_warn("Failed to read from %s: %s", sub_status, pa_cstrerror(errno));
248 if (!pa_streq(line, "closed\n")) {
259 pa_xfree(sub_status);
274 static void verify_access(struct userdata *u, struct device *d) {
277 pa_bool_t accessible;
282 cd = pa_sprintf_malloc("%s/snd/controlC%s", udev_get_dev_path(u->udev), path_get_card_id(d->path));
283 accessible = access(cd, R_OK|W_OK) >= 0;
284 pa_log_debug("%s is accessible: %s", cd, pa_yes_no(accessible));
288 if (d->module == PA_INVALID_INDEX) {
290 /* If we are not loaded, try to load */
296 /* Check if any of the PCM devices that belong to this
297 * card are currently busy. If they are, don't try to load
298 * right now, to make sure the probing phase can
299 * successfully complete. When the current user of the
300 * device closes it we will get another notification via
301 * inotify and can then recheck. */
303 busy = is_card_busy(path_get_card_id(d->path));
304 pa_log_debug("%s is busy: %s", d->path, pa_yes_no(busy));
308 /* So, why do we rate limit here? It's certainly ugly,
309 * but there seems to be no other way. Problem is
310 * this: if we are unable to configure/probe an audio
311 * device after opening it we will close it again and
312 * the module initialization will fail. This will then
313 * cause an inotify event on the device node which
314 * will be forwarded to us. We then try to reopen the
315 * audio device again, practically entering a busy
318 * A clean fix would be if we would be able to ignore
319 * our own inotify close events. However, inotify
320 * lacks such functionality. Also, during probing of
321 * the device we cannot really distuingish between
322 * other processes causing EBUSY or ourselves, which
323 * means we have no way to figure out if the probing
324 * during opening was canceled by a "try again"
325 * failure or a "fatal" failure. */
327 if (pa_ratelimit_test(&d->ratelimit)) {
328 pa_log_debug("Loading module-alsa-card with arguments '%s'", d->args);
329 m = pa_module_load(u->core, "module-alsa-card", d->args);
332 d->module = m->index;
333 pa_log_info("Card %s (%s) module loaded.", d->path, d->card_name);
335 pa_log_info("Card %s (%s) failed to load module.", d->path, d->card_name);
337 pa_log_warn("Tried to configure %s (%s) more often than %u times in %llus",
341 (long long unsigned) (d->ratelimit.interval / PA_USEC_PER_SEC));
347 /* If we are already loaded update suspend status with
348 * accessible boolean */
350 if ((card = pa_namereg_get(u->core, d->card_name, PA_NAMEREG_CARD)))
351 pa_card_suspend(card, !accessible, PA_SUSPEND_SESSION);
355 static void card_changed(struct userdata *u, struct udev_device *dev) {
364 /* Maybe /dev/snd is now available? */
367 path = udev_device_get_devpath(dev);
369 if ((d = pa_hashmap_get(u->devices, path))) {
374 d = pa_xnew0(struct device, 1);
375 d->path = pa_xstrdup(path);
376 d->module = PA_INVALID_INDEX;
377 PA_INIT_RATELIMIT(d->ratelimit, 10*PA_USEC_PER_SEC, 5);
379 if (!(t = udev_device_get_property_value(dev, "PULSE_NAME")))
380 if (!(t = udev_device_get_property_value(dev, "ID_ID")))
381 if (!(t = udev_device_get_property_value(dev, "ID_PATH")))
382 t = path_get_card_id(path);
384 n = pa_namereg_make_valid_name(t);
385 d->card_name = pa_sprintf_malloc("alsa_card.%s", n);
386 d->args = pa_sprintf_malloc("device_id=\"%s\" "
389 "namereg_fail=false "
393 "card_properties=\"module-udev-detect.discovered=1\"",
394 path_get_card_id(path),
397 pa_yes_no(u->use_tsched),
398 pa_yes_no(u->ignore_dB),
399 pa_yes_no(u->sync_volume));
402 pa_hashmap_put(u->devices, d->path, d);
407 static void remove_card(struct userdata *u, struct udev_device *dev) {
413 if (!(d = pa_hashmap_remove(u->devices, udev_device_get_devpath(dev))))
416 pa_log_info("Card %s removed.", d->path);
418 if (d->module != PA_INVALID_INDEX)
419 pa_module_unload_request_by_index(u->core, d->module, TRUE);
424 static void process_device(struct userdata *u, struct udev_device *dev) {
425 const char *action, *ff;
430 if (udev_device_get_property_value(dev, "PULSE_IGNORE")) {
431 pa_log_debug("Ignoring %s, because marked so.", udev_device_get_devpath(dev));
435 if ((ff = udev_device_get_property_value(dev, "SOUND_CLASS")) &&
436 pa_streq(ff, "modem")) {
437 pa_log_debug("Ignoring %s, because it is a modem.", udev_device_get_devpath(dev));
441 action = udev_device_get_action(dev);
443 if (action && pa_streq(action, "remove"))
445 else if ((!action || pa_streq(action, "change")) &&
446 udev_device_get_property_value(dev, "SOUND_INITIALIZED"))
447 card_changed(u, dev);
449 /* For an explanation why we don't look for 'add' events here
450 * have a look into /lib/udev/rules.d/78-sound-card.rules! */
453 static void process_path(struct userdata *u, const char *path) {
454 struct udev_device *dev;
456 if (!path_get_card_id(path))
459 if (!(dev = udev_device_new_from_syspath(u->udev, path))) {
460 pa_log("Failed to get udev device object from udev.");
464 process_device(u, dev);
465 udev_device_unref(dev);
468 static void monitor_cb(
472 pa_io_event_flags_t events,
475 struct userdata *u = userdata;
476 struct udev_device *dev;
480 if (!(dev = udev_monitor_receive_device(u->monitor))) {
481 pa_log("Failed to get udev device object from monitor.");
485 if (!path_get_card_id(udev_device_get_devpath(dev))) {
486 udev_device_unref(dev);
490 process_device(u, dev);
491 udev_device_unref(dev);
495 a->io_free(u->udev_io);
499 static pa_bool_t pcm_node_belongs_to_device(
506 cd = pa_sprintf_malloc("pcmC%sD", path_get_card_id(d->path));
507 b = pa_startswith(node, cd);
513 static pa_bool_t control_node_belongs_to_device(
520 cd = pa_sprintf_malloc("controlC%s", path_get_card_id(d->path));
521 b = pa_streq(node, cd);
527 static void inotify_cb(
531 pa_io_event_flags_t events,
535 struct inotify_event e;
538 struct userdata *u = userdata;
540 pa_bool_t deleted = FALSE;
546 struct inotify_event *event;
549 if ((r = pa_read(fd, &buf, sizeof(buf), &type)) <= 0) {
551 if (r < 0 && errno == EAGAIN)
554 pa_log("read() from inotify failed: %s", r < 0 ? pa_cstrerror(errno) : "EOF");
562 if ((size_t) r < sizeof(struct inotify_event)) {
563 pa_log("read() too short.");
567 len = sizeof(struct inotify_event) + event->len;
569 if ((size_t) r < len) {
570 pa_log("Payload missing.");
574 /* From udev we get the guarantee that the control
575 * device's ACL is changed last. To avoid races when ACLs
576 * are changed we hence watch only the control device */
577 if (((event->mask & IN_ATTRIB) && pa_startswith(event->name, "controlC")))
578 PA_HASHMAP_FOREACH(d, u->devices, state)
579 if (control_node_belongs_to_device(d, event->name))
580 d->need_verify = TRUE;
582 /* ALSA doesn't really give us any guarantee on the closing
583 * order, so let's simply hope */
584 if (((event->mask & IN_CLOSE_WRITE) && pa_startswith(event->name, "pcmC")))
585 PA_HASHMAP_FOREACH(d, u->devices, state)
586 if (pcm_node_belongs_to_device(d, event->name))
587 d->need_verify = TRUE;
589 /* /dev/snd/ might have been removed */
590 if ((event->mask & (IN_DELETE_SELF|IN_MOVE_SELF)))
593 event = (struct inotify_event*) ((uint8_t*) event + len);
598 PA_HASHMAP_FOREACH(d, u->devices, state)
599 if (d->need_verify) {
600 d->need_verify = FALSE;
609 a->io_free(u->inotify_io);
610 u->inotify_io = NULL;
613 if (u->inotify_fd >= 0) {
614 pa_close(u->inotify_fd);
619 static int setup_inotify(struct userdata *u) {
623 if (u->inotify_fd >= 0)
626 if ((u->inotify_fd = inotify_init1(IN_CLOEXEC|IN_NONBLOCK)) < 0) {
627 pa_log("inotify_init1() failed: %s", pa_cstrerror(errno));
631 dev_snd = pa_sprintf_malloc("%s/snd", udev_get_dev_path(u->udev));
632 r = inotify_add_watch(u->inotify_fd, dev_snd, IN_ATTRIB|IN_CLOSE_WRITE|IN_DELETE_SELF|IN_MOVE_SELF);
636 int saved_errno = errno;
638 pa_close(u->inotify_fd);
641 if (saved_errno == ENOENT) {
642 pa_log_debug("/dev/snd/ is apparently not existing yet, retrying to create inotify watch later.");
646 if (saved_errno == ENOSPC) {
647 pa_log("You apparently ran out of inotify watches, probably because Tracker/Beagle took them all away. "
648 "I wished people would do their homework first and fix inotify before using it for watching whole "
649 "directory trees which is something the current inotify is certainly not useful for. "
650 "Please make sure to drop the Tracker/Beagle guys a line complaining about their broken use of inotify.");
654 pa_log("inotify_add_watch() failed: %s", pa_cstrerror(saved_errno));
658 pa_assert_se(u->inotify_io = u->core->mainloop->io_new(u->core->mainloop, u->inotify_fd, PA_IO_EVENT_INPUT, inotify_cb, u));
663 int pa__init(pa_module *m) {
664 struct userdata *u = NULL;
666 struct udev_enumerate *enumerate = NULL;
667 struct udev_list_entry *item = NULL, *first = NULL;
669 pa_bool_t use_tsched = TRUE, ignore_dB = FALSE, sync_volume = m->core->sync_volume;
674 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
675 pa_log("Failed to parse module arguments");
679 m->userdata = u = pa_xnew0(struct userdata, 1);
681 u->devices = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
684 if (pa_modargs_get_value_boolean(ma, "tsched", &use_tsched) < 0) {
685 pa_log("Failed to parse tsched= argument.");
688 u->use_tsched = use_tsched;
690 if (pa_modargs_get_value_boolean(ma, "ignore_dB", &ignore_dB) < 0) {
691 pa_log("Failed to parse ignore_dB= argument.");
694 u->ignore_dB = ignore_dB;
696 if (pa_modargs_get_value_boolean(ma, "sync_volume", &sync_volume) < 0) {
697 pa_log("Failed to parse sync_volume= argument.");
700 u->sync_volume = sync_volume;
702 if (!(u->udev = udev_new())) {
703 pa_log("Failed to initialize udev library.");
707 if (setup_inotify(u) < 0)
710 if (!(u->monitor = udev_monitor_new_from_netlink(u->udev, "udev"))) {
711 pa_log("Failed to initialize monitor.");
715 if (udev_monitor_filter_add_match_subsystem_devtype(u->monitor, "sound", NULL) < 0) {
716 pa_log("Failed to subscribe to sound devices.");
721 if (udev_monitor_enable_receiving(u->monitor) < 0) {
722 pa_log("Failed to enable monitor: %s", pa_cstrerror(errno));
724 pa_log_info("Most likely your kernel is simply too old and "
725 "allows only priviliged processes to listen to device events. "
726 "Please upgrade your kernel to at least 2.6.30.");
730 if ((fd = udev_monitor_get_fd(u->monitor)) < 0) {
731 pa_log("Failed to get udev monitor fd.");
735 pa_assert_se(u->udev_io = u->core->mainloop->io_new(u->core->mainloop, fd, PA_IO_EVENT_INPUT, monitor_cb, u));
737 if (!(enumerate = udev_enumerate_new(u->udev))) {
738 pa_log("Failed to initialize udev enumerator.");
742 if (udev_enumerate_add_match_subsystem(enumerate, "sound") < 0) {
743 pa_log("Failed to match to subsystem.");
747 if (udev_enumerate_scan_devices(enumerate) < 0) {
748 pa_log("Failed to scan for devices.");
752 first = udev_enumerate_get_list_entry(enumerate);
753 udev_list_entry_foreach(item, first)
754 process_path(u, udev_list_entry_get_name(item));
756 udev_enumerate_unref(enumerate);
758 pa_log_info("Found %u cards.", pa_hashmap_size(u->devices));
767 udev_enumerate_unref(enumerate);
777 void pa__done(pa_module *m) {
782 if (!(u = m->userdata))
786 m->core->mainloop->io_free(u->udev_io);
789 udev_monitor_unref(u->monitor);
795 m->core->mainloop->io_free(u->inotify_io);
797 if (u->inotify_fd >= 0)
798 pa_close(u->inotify_fd);
803 while ((d = pa_hashmap_steal_first(u->devices)))
806 pa_hashmap_free(u->devices, NULL, NULL);