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 "fixed_latency_range=<disable latency range changes on underrun?> "
49 "ignore_dB=<ignore dB information from the device?> "
50 "deferred_volume=<syncronize sw and hw volume changes in IO-thread?> "
51 "use_ucm=<use ALSA UCM for card configuration?>");
55 pa_bool_t need_verify
;
59 pa_ratelimit ratelimit
;
66 pa_bool_t use_tsched
:1;
67 pa_bool_t fixed_latency_range
:1;
68 pa_bool_t ignore_dB
:1;
69 pa_bool_t deferred_volume
:1;
73 struct udev_monitor
*monitor
;
77 pa_io_event
*inotify_io
;
80 static const char* const valid_modargs
[] = {
82 "fixed_latency_range",
89 static int setup_inotify(struct userdata
*u
);
91 static void device_free(struct device
*d
) {
95 pa_xfree(d
->card_name
);
100 static const char *path_get_card_id(const char *path
) {
106 if (!(e
= strrchr(path
, '/')))
109 if (!pa_startswith(e
, "/card"))
115 static char *card_get_sysattr(const char *card_idx
, const char *name
) {
117 struct udev_device
*card
= NULL
;
124 if (!(udev
= udev_new())) {
125 pa_log_error("Failed to allocate udev context.");
129 t
= pa_sprintf_malloc("/sys/class/sound/card%s", card_idx
);
130 card
= udev_device_new_from_syspath(udev
, t
);
134 pa_log_error("Failed to get card object.");
138 if ((v
= udev_device_get_sysattr_value(card
, name
)) && *v
)
144 udev_device_unref(card
);
152 static pa_bool_t
pcm_is_modem(const char *card_idx
, const char *pcm
) {
153 char *sysfs_path
, *pcm_class
;
159 /* Check /sys/class/sound/card.../pcmC...../pcm_class. An HDA
160 * modem can be used simultaneously with generic
161 * playback/record. */
163 sysfs_path
= pa_sprintf_malloc("pcmC%sD%s/pcm_class", card_idx
, pcm
);
164 pcm_class
= card_get_sysattr(card_idx
, sysfs_path
);
165 is_modem
= pcm_class
&& pa_streq(pcm_class
, "modem");
167 pa_xfree(sysfs_path
);
172 static pa_bool_t
is_card_busy(const char *id
) {
173 char *card_path
= NULL
, *pcm_path
= NULL
, *sub_status
= NULL
;
174 DIR *card_dir
= NULL
, *pcm_dir
= NULL
;
175 FILE *status_file
= NULL
;
177 struct dirent
*space
= NULL
, *de
;
178 pa_bool_t busy
= FALSE
;
183 /* This simply uses /proc/asound/card.../pcm.../sub.../status to
184 * check whether there is still a process using this audio device. */
186 card_path
= pa_sprintf_malloc("/proc/asound/card%s", id
);
188 if (!(card_dir
= opendir(card_path
))) {
189 pa_log_warn("Failed to open %s: %s", card_path
, pa_cstrerror(errno
));
193 len
= offsetof(struct dirent
, d_name
) + fpathconf(dirfd(card_dir
), _PC_NAME_MAX
) + 1;
194 space
= pa_xmalloc(len
);
199 if ((r
= readdir_r(card_dir
, space
, &de
)) != 0) {
200 pa_log_warn("readdir_r() failed: %s", pa_cstrerror(r
));
207 if (!pa_startswith(de
->d_name
, "pcm"))
210 if (pcm_is_modem(id
, de
->d_name
+ 3))
214 pcm_path
= pa_sprintf_malloc("%s/%s", card_path
, de
->d_name
);
219 if (!(pcm_dir
= opendir(pcm_path
))) {
220 pa_log_warn("Failed to open %s: %s", pcm_path
, pa_cstrerror(errno
));
227 if ((r
= readdir_r(pcm_dir
, space
, &de
)) != 0) {
228 pa_log_warn("readdir_r() failed: %s", pa_cstrerror(r
));
235 if (!pa_startswith(de
->d_name
, "sub"))
238 pa_xfree(sub_status
);
239 sub_status
= pa_sprintf_malloc("%s/%s/status", pcm_path
, de
->d_name
);
244 if (!(status_file
= pa_fopen_cloexec(sub_status
, "r"))) {
245 pa_log_warn("Failed to open %s: %s", sub_status
, pa_cstrerror(errno
));
249 if (!(fgets(line
, sizeof(line
)-1, status_file
))) {
250 pa_log_warn("Failed to read from %s: %s", sub_status
, pa_cstrerror(errno
));
254 if (!pa_streq(line
, "closed\n")) {
265 pa_xfree(sub_status
);
280 static void verify_access(struct userdata
*u
, struct device
*d
) {
283 pa_bool_t accessible
;
288 cd
= pa_sprintf_malloc("/dev/snd/controlC%s", path_get_card_id(d
->path
));
289 accessible
= access(cd
, R_OK
|W_OK
) >= 0;
290 pa_log_debug("%s is accessible: %s", cd
, pa_yes_no(accessible
));
294 if (d
->module
== PA_INVALID_INDEX
) {
296 /* If we are not loaded, try to load */
302 /* Check if any of the PCM devices that belong to this
303 * card are currently busy. If they are, don't try to load
304 * right now, to make sure the probing phase can
305 * successfully complete. When the current user of the
306 * device closes it we will get another notification via
307 * inotify and can then recheck. */
309 busy
= is_card_busy(path_get_card_id(d
->path
));
310 pa_log_debug("%s is busy: %s", d
->path
, pa_yes_no(busy
));
314 /* So, why do we rate limit here? It's certainly ugly,
315 * but there seems to be no other way. Problem is
316 * this: if we are unable to configure/probe an audio
317 * device after opening it we will close it again and
318 * the module initialization will fail. This will then
319 * cause an inotify event on the device node which
320 * will be forwarded to us. We then try to reopen the
321 * audio device again, practically entering a busy
324 * A clean fix would be if we would be able to ignore
325 * our own inotify close events. However, inotify
326 * lacks such functionality. Also, during probing of
327 * the device we cannot really distinguish between
328 * other processes causing EBUSY or ourselves, which
329 * means we have no way to figure out if the probing
330 * during opening was canceled by a "try again"
331 * failure or a "fatal" failure. */
333 if (pa_ratelimit_test(&d
->ratelimit
, PA_LOG_DEBUG
)) {
334 pa_log_debug("Loading module-alsa-card with arguments '%s'", d
->args
);
335 m
= pa_module_load(u
->core
, "module-alsa-card", d
->args
);
338 d
->module
= m
->index
;
339 pa_log_info("Card %s (%s) module loaded.", d
->path
, d
->card_name
);
341 pa_log_info("Card %s (%s) failed to load module.", d
->path
, d
->card_name
);
343 pa_log_warn("Tried to configure %s (%s) more often than %u times in %llus",
347 (long long unsigned) (d
->ratelimit
.interval
/ PA_USEC_PER_SEC
));
353 /* If we are already loaded update suspend status with
354 * accessible boolean */
356 if ((card
= pa_namereg_get(u
->core
, d
->card_name
, PA_NAMEREG_CARD
))) {
357 pa_log_debug("%s all sinks and sources of card %s.", accessible
? "Resuming" : "Suspending", d
->card_name
);
358 pa_card_suspend(card
, !accessible
, PA_SUSPEND_SESSION
);
363 static void card_changed(struct userdata
*u
, struct udev_device
*dev
) {
372 /* Maybe /dev/snd is now available? */
375 path
= udev_device_get_devpath(dev
);
377 if ((d
= pa_hashmap_get(u
->devices
, path
))) {
382 d
= pa_xnew0(struct device
, 1);
383 d
->path
= pa_xstrdup(path
);
384 d
->module
= PA_INVALID_INDEX
;
385 PA_INIT_RATELIMIT(d
->ratelimit
, 10*PA_USEC_PER_SEC
, 5);
387 if (!(t
= udev_device_get_property_value(dev
, "PULSE_NAME")))
388 if (!(t
= udev_device_get_property_value(dev
, "ID_ID")))
389 if (!(t
= udev_device_get_property_value(dev
, "ID_PATH")))
390 t
= path_get_card_id(path
);
392 n
= pa_namereg_make_valid_name(t
);
393 d
->card_name
= pa_sprintf_malloc("alsa_card.%s", n
);
394 d
->args
= pa_sprintf_malloc("device_id=\"%s\" "
397 "namereg_fail=false "
399 "fixed_latency_range=%s "
401 "deferred_volume=%s "
403 "card_properties=\"module-udev-detect.discovered=1\"",
404 path_get_card_id(path
),
407 pa_yes_no(u
->use_tsched
),
408 pa_yes_no(u
->fixed_latency_range
),
409 pa_yes_no(u
->ignore_dB
),
410 pa_yes_no(u
->deferred_volume
),
411 pa_yes_no(u
->use_ucm
));
414 pa_hashmap_put(u
->devices
, d
->path
, d
);
419 static void remove_card(struct userdata
*u
, struct udev_device
*dev
) {
425 if (!(d
= pa_hashmap_remove(u
->devices
, udev_device_get_devpath(dev
))))
428 pa_log_info("Card %s removed.", d
->path
);
430 if (d
->module
!= PA_INVALID_INDEX
)
431 pa_module_unload_request_by_index(u
->core
, d
->module
, TRUE
);
436 static void process_device(struct userdata
*u
, struct udev_device
*dev
) {
437 const char *action
, *ff
;
442 if (udev_device_get_property_value(dev
, "PULSE_IGNORE")) {
443 pa_log_debug("Ignoring %s, because marked so.", udev_device_get_devpath(dev
));
447 if ((ff
= udev_device_get_property_value(dev
, "SOUND_CLASS")) &&
448 pa_streq(ff
, "modem")) {
449 pa_log_debug("Ignoring %s, because it is a modem.", udev_device_get_devpath(dev
));
453 action
= udev_device_get_action(dev
);
455 if (action
&& pa_streq(action
, "remove"))
457 else if ((!action
|| pa_streq(action
, "change")) && udev_device_get_property_value(dev
, "SOUND_INITIALIZED"))
458 card_changed(u
, dev
);
460 /* For an explanation why we don't look for 'add' events here
461 * have a look into /lib/udev/rules.d/78-sound-card.rules! */
464 static void process_path(struct userdata
*u
, const char *path
) {
465 struct udev_device
*dev
;
467 if (!path_get_card_id(path
))
470 if (!(dev
= udev_device_new_from_syspath(u
->udev
, path
))) {
471 pa_log("Failed to get udev device object from udev.");
475 process_device(u
, dev
);
476 udev_device_unref(dev
);
479 static void monitor_cb(
483 pa_io_event_flags_t events
,
486 struct userdata
*u
= userdata
;
487 struct udev_device
*dev
;
491 if (!(dev
= udev_monitor_receive_device(u
->monitor
))) {
492 pa_log("Failed to get udev device object from monitor.");
496 if (!path_get_card_id(udev_device_get_devpath(dev
))) {
497 udev_device_unref(dev
);
501 process_device(u
, dev
);
502 udev_device_unref(dev
);
506 a
->io_free(u
->udev_io
);
510 static pa_bool_t
pcm_node_belongs_to_device(
517 cd
= pa_sprintf_malloc("pcmC%sD", path_get_card_id(d
->path
));
518 b
= pa_startswith(node
, cd
);
524 static pa_bool_t
control_node_belongs_to_device(
531 cd
= pa_sprintf_malloc("controlC%s", path_get_card_id(d
->path
));
532 b
= pa_streq(node
, cd
);
538 static void inotify_cb(
542 pa_io_event_flags_t events
,
546 struct inotify_event e
;
549 struct userdata
*u
= userdata
;
551 pa_bool_t deleted
= FALSE
;
557 struct inotify_event
*event
;
560 if ((r
= pa_read(fd
, &buf
, sizeof(buf
), &type
)) <= 0) {
562 if (r
< 0 && errno
== EAGAIN
)
565 pa_log("read() from inotify failed: %s", r
< 0 ? pa_cstrerror(errno
) : "EOF");
573 if ((size_t) r
< sizeof(struct inotify_event
)) {
574 pa_log("read() too short.");
578 len
= sizeof(struct inotify_event
) + event
->len
;
580 if ((size_t) r
< len
) {
581 pa_log("Payload missing.");
585 /* From udev we get the guarantee that the control
586 * device's ACL is changed last. To avoid races when ACLs
587 * are changed we hence watch only the control device */
588 if (((event
->mask
& IN_ATTRIB
) && pa_startswith(event
->name
, "controlC")))
589 PA_HASHMAP_FOREACH(d
, u
->devices
, state
)
590 if (control_node_belongs_to_device(d
, event
->name
))
591 d
->need_verify
= TRUE
;
593 /* ALSA doesn't really give us any guarantee on the closing
594 * order, so let's simply hope */
595 if (((event
->mask
& IN_CLOSE_WRITE
) && pa_startswith(event
->name
, "pcmC")))
596 PA_HASHMAP_FOREACH(d
, u
->devices
, state
)
597 if (pcm_node_belongs_to_device(d
, event
->name
))
598 d
->need_verify
= TRUE
;
600 /* /dev/snd/ might have been removed */
601 if ((event
->mask
& (IN_DELETE_SELF
|IN_MOVE_SELF
)))
604 event
= (struct inotify_event
*) ((uint8_t*) event
+ len
);
609 PA_HASHMAP_FOREACH(d
, u
->devices
, state
)
610 if (d
->need_verify
) {
611 d
->need_verify
= FALSE
;
620 a
->io_free(u
->inotify_io
);
621 u
->inotify_io
= NULL
;
624 if (u
->inotify_fd
>= 0) {
625 pa_close(u
->inotify_fd
);
630 static int setup_inotify(struct userdata
*u
) {
633 if (u
->inotify_fd
>= 0)
636 if ((u
->inotify_fd
= inotify_init1(IN_CLOEXEC
|IN_NONBLOCK
)) < 0) {
637 pa_log("inotify_init1() failed: %s", pa_cstrerror(errno
));
641 r
= inotify_add_watch(u
->inotify_fd
, "/dev/snd", IN_ATTRIB
|IN_CLOSE_WRITE
|IN_DELETE_SELF
|IN_MOVE_SELF
);
644 int saved_errno
= errno
;
646 pa_close(u
->inotify_fd
);
649 if (saved_errno
== ENOENT
) {
650 pa_log_debug("/dev/snd/ is apparently not existing yet, retrying to create inotify watch later.");
654 if (saved_errno
== ENOSPC
) {
655 pa_log("You apparently ran out of inotify watches, probably because Tracker/Beagle took them all away. "
656 "I wished people would do their homework first and fix inotify before using it for watching whole "
657 "directory trees which is something the current inotify is certainly not useful for. "
658 "Please make sure to drop the Tracker/Beagle guys a line complaining about their broken use of inotify.");
662 pa_log("inotify_add_watch() failed: %s", pa_cstrerror(saved_errno
));
666 pa_assert_se(u
->inotify_io
= u
->core
->mainloop
->io_new(u
->core
->mainloop
, u
->inotify_fd
, PA_IO_EVENT_INPUT
, inotify_cb
, u
));
671 int pa__init(pa_module
*m
) {
672 struct userdata
*u
= NULL
;
674 struct udev_enumerate
*enumerate
= NULL
;
675 struct udev_list_entry
*item
= NULL
, *first
= NULL
;
677 pa_bool_t use_tsched
= TRUE
, fixed_latency_range
= FALSE
, ignore_dB
= FALSE
, deferred_volume
= m
->core
->deferred_volume
;
682 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
683 pa_log("Failed to parse module arguments");
687 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
689 u
->devices
= pa_hashmap_new(pa_idxset_string_hash_func
, pa_idxset_string_compare_func
);
692 if (pa_modargs_get_value_boolean(ma
, "tsched", &use_tsched
) < 0) {
693 pa_log("Failed to parse tsched= argument.");
696 u
->use_tsched
= use_tsched
;
698 if (pa_modargs_get_value_boolean(ma
, "fixed_latency_range", &fixed_latency_range
) < 0) {
699 pa_log("Failed to parse fixed_latency_range= argument.");
702 u
->fixed_latency_range
= fixed_latency_range
;
704 if (pa_modargs_get_value_boolean(ma
, "ignore_dB", &ignore_dB
) < 0) {
705 pa_log("Failed to parse ignore_dB= argument.");
708 u
->ignore_dB
= ignore_dB
;
710 if (pa_modargs_get_value_boolean(ma
, "deferred_volume", &deferred_volume
) < 0) {
711 pa_log("Failed to parse deferred_volume= argument.");
714 u
->deferred_volume
= deferred_volume
;
716 if (pa_modargs_get_value_boolean(ma
, "use_ucm", &use_ucm
) < 0) {
717 pa_log("Failed to parse use_ucm= argument.");
720 u
->use_ucm
= use_ucm
;
722 if (!(u
->udev
= udev_new())) {
723 pa_log("Failed to initialize udev library.");
727 if (setup_inotify(u
) < 0)
730 if (!(u
->monitor
= udev_monitor_new_from_netlink(u
->udev
, "udev"))) {
731 pa_log("Failed to initialize monitor.");
735 if (udev_monitor_filter_add_match_subsystem_devtype(u
->monitor
, "sound", NULL
) < 0) {
736 pa_log("Failed to subscribe to sound devices.");
741 if (udev_monitor_enable_receiving(u
->monitor
) < 0) {
742 pa_log("Failed to enable monitor: %s", pa_cstrerror(errno
));
744 pa_log_info("Most likely your kernel is simply too old and "
745 "allows only privileged processes to listen to device events. "
746 "Please upgrade your kernel to at least 2.6.30.");
750 if ((fd
= udev_monitor_get_fd(u
->monitor
)) < 0) {
751 pa_log("Failed to get udev monitor fd.");
755 pa_assert_se(u
->udev_io
= u
->core
->mainloop
->io_new(u
->core
->mainloop
, fd
, PA_IO_EVENT_INPUT
, monitor_cb
, u
));
757 if (!(enumerate
= udev_enumerate_new(u
->udev
))) {
758 pa_log("Failed to initialize udev enumerator.");
762 if (udev_enumerate_add_match_subsystem(enumerate
, "sound") < 0) {
763 pa_log("Failed to match to subsystem.");
767 if (udev_enumerate_scan_devices(enumerate
) < 0) {
768 pa_log("Failed to scan for devices.");
772 first
= udev_enumerate_get_list_entry(enumerate
);
773 udev_list_entry_foreach(item
, first
)
774 process_path(u
, udev_list_entry_get_name(item
));
776 udev_enumerate_unref(enumerate
);
778 pa_log_info("Found %u cards.", pa_hashmap_size(u
->devices
));
787 udev_enumerate_unref(enumerate
);
797 void pa__done(pa_module
*m
) {
802 if (!(u
= m
->userdata
))
806 m
->core
->mainloop
->io_free(u
->udev_io
);
809 udev_monitor_unref(u
->monitor
);
815 m
->core
->mainloop
->io_free(u
->inotify_io
);
817 if (u
->inotify_fd
>= 0)
818 pa_close(u
->inotify_fd
);
821 pa_hashmap_free(u
->devices
, (pa_free_cb_t
) device_free
);