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 <pulsecore/modargs.h>
33 #include <pulsecore/core-error.h>
34 #include <pulsecore/core-util.h>
35 #include <pulsecore/namereg.h>
37 #include "module-udev-detect-symdef.h"
39 PA_MODULE_AUTHOR("Lennart Poettering");
40 PA_MODULE_DESCRIPTION("Detect available audio hardware and load matching drivers");
41 PA_MODULE_VERSION(PACKAGE_VERSION
);
42 PA_MODULE_LOAD_ONCE(TRUE
);
44 "tsched=<enable system timer based scheduling mode?> "
45 "ignore_dB=<ignore dB information from the device?>");
49 pa_bool_t need_verify
;
59 pa_bool_t use_tsched
:1;
60 pa_bool_t ignore_dB
:1;
63 struct udev_monitor
*monitor
;
67 pa_io_event
*inotify_io
;
70 static const char* const valid_modargs
[] = {
76 static int setup_inotify(struct userdata
*u
);
78 static void device_free(struct device
*d
) {
82 pa_xfree(d
->card_name
);
87 static const char *path_get_card_id(const char *path
) {
93 if (!(e
= strrchr(path
, '/')))
96 if (!pa_startswith(e
, "/card"))
102 static pa_bool_t
is_card_busy(const char *id
) {
103 char *card_path
= NULL
, *pcm_path
= NULL
, *sub_status
= NULL
;
104 DIR *card_dir
= NULL
, *pcm_dir
= NULL
;
105 FILE *status_file
= NULL
;
107 struct dirent
*space
= NULL
, *de
;
108 pa_bool_t busy
= FALSE
;
113 card_path
= pa_sprintf_malloc("/proc/asound/card%s", id
);
115 if (!(card_dir
= opendir(card_path
))) {
116 pa_log_warn("Failed to open %s: %s", card_path
, pa_cstrerror(errno
));
120 len
= offsetof(struct dirent
, d_name
) + fpathconf(dirfd(card_dir
), _PC_NAME_MAX
) + 1;
121 space
= pa_xmalloc(len
);
126 if ((r
= readdir_r(card_dir
, space
, &de
)) != 0) {
127 pa_log_warn("readdir_r() failed: %s", pa_cstrerror(r
));
134 if (!pa_startswith(de
->d_name
, "pcm"))
138 pcm_path
= pa_sprintf_malloc("%s/%s", card_path
, de
->d_name
);
143 if (!(pcm_dir
= opendir(pcm_path
))) {
144 pa_log_warn("Failed to open %s: %s", pcm_path
, pa_cstrerror(errno
));
151 if ((r
= readdir_r(pcm_dir
, space
, &de
)) != 0) {
152 pa_log_warn("readdir_r() failed: %s", pa_cstrerror(r
));
159 if (!pa_startswith(de
->d_name
, "sub"))
162 pa_xfree(sub_status
);
163 sub_status
= pa_sprintf_malloc("%s/%s/status", pcm_path
, de
->d_name
);
168 if (!(status_file
= fopen(sub_status
, "r"))) {
169 pa_log_warn("Failed to open %s: %s", sub_status
, pa_cstrerror(errno
));
173 if (!(fgets(line
, sizeof(line
)-1, status_file
))) {
174 pa_log_warn("Failed to read from %s: %s", sub_status
, pa_cstrerror(errno
));
178 if (!pa_streq(line
, "closed\n")) {
189 pa_xfree(sub_status
);
204 static void verify_access(struct userdata
*u
, struct device
*d
) {
207 pa_bool_t accessible
;
212 cd
= pa_sprintf_malloc("%s/snd/controlC%s", udev_get_dev_path(u
->udev
), path_get_card_id(d
->path
));
213 accessible
= access(cd
, R_OK
|W_OK
) >= 0;
214 pa_log_debug("%s is accessible: %s", cd
, pa_yes_no(accessible
));
218 if (d
->module
== PA_INVALID_INDEX
) {
220 /* If we are not loaded, try to load */
226 /* Check if any of the PCM devices that belong to this
227 * card are currently busy. If they are, don't try to load
228 * right now, to make sure the probing phase can
229 * successfully complete. When the current user of the
230 * device closes it we will get another notification via
231 * inotify and can then recheck. */
233 busy
= is_card_busy(path_get_card_id(d
->path
));
234 pa_log_debug("%s is busy: %s", d
->path
, pa_yes_no(busy
));
237 pa_log_debug("Loading module-alsa-card with arguments '%s'", d
->args
);
238 m
= pa_module_load(u
->core
, "module-alsa-card", d
->args
);
241 d
->module
= m
->index
;
242 pa_log_info("Card %s (%s) module loaded.", d
->path
, d
->card_name
);
244 pa_log_info("Card %s (%s) failed to load module.", d
->path
, d
->card_name
);
250 /* If we are already loaded update suspend status with
251 * accessible boolean */
253 if ((card
= pa_namereg_get(u
->core
, d
->card_name
, PA_NAMEREG_CARD
)))
254 pa_card_suspend(card
, !accessible
, PA_SUSPEND_SESSION
);
258 static void card_changed(struct userdata
*u
, struct udev_device
*dev
) {
267 /* Maybe /dev/snd is now available? */
270 path
= udev_device_get_devpath(dev
);
272 if ((d
= pa_hashmap_get(u
->devices
, path
))) {
277 d
= pa_xnew0(struct device
, 1);
278 d
->path
= pa_xstrdup(path
);
279 d
->module
= PA_INVALID_INDEX
;
281 if (!(t
= udev_device_get_property_value(dev
, "PULSE_NAME")))
282 if (!(t
= udev_device_get_property_value(dev
, "ID_ID")))
283 if (!(t
= udev_device_get_property_value(dev
, "ID_PATH")))
284 t
= path_get_card_id(path
);
286 n
= pa_namereg_make_valid_name(t
);
287 d
->card_name
= pa_sprintf_malloc("alsa_card.%s", n
);
288 d
->args
= pa_sprintf_malloc("device_id=\"%s\" "
293 "card_properties=\"module-udev-detect.discovered=1\"",
294 path_get_card_id(path
),
297 pa_yes_no(u
->use_tsched
),
298 pa_yes_no(u
->ignore_dB
));
301 pa_hashmap_put(u
->devices
, d
->path
, d
);
306 static void remove_card(struct userdata
*u
, struct udev_device
*dev
) {
312 if (!(d
= pa_hashmap_remove(u
->devices
, udev_device_get_devpath(dev
))))
315 pa_log_info("Card %s removed.", d
->path
);
317 if (d
->module
!= PA_INVALID_INDEX
)
318 pa_module_unload_request_by_index(u
->core
, d
->module
, TRUE
);
323 static void process_device(struct userdata
*u
, struct udev_device
*dev
) {
324 const char *action
, *ff
;
329 if (udev_device_get_property_value(dev
, "PULSE_IGNORE")) {
330 pa_log_debug("Ignoring %s, because marked so.", udev_device_get_devpath(dev
));
334 if ((ff
= udev_device_get_property_value(dev
, "SOUND_FORM_FACTOR")) &&
335 pa_streq(ff
, "modem")) {
336 pa_log_debug("Ignoring %s, because it is a modem.", udev_device_get_devpath(dev
));
340 action
= udev_device_get_action(dev
);
342 if (action
&& pa_streq(action
, "remove"))
344 else if ((!action
|| pa_streq(action
, "change")) &&
345 udev_device_get_property_value(dev
, "SOUND_INITIALIZED"))
346 card_changed(u
, dev
);
348 /* For an explanation why we don't look for 'add' events here
349 * have a look into /lib/udev/rules.d/78-sound-card.rules! */
352 static void process_path(struct userdata
*u
, const char *path
) {
353 struct udev_device
*dev
;
355 if (!path_get_card_id(path
))
358 if (!(dev
= udev_device_new_from_syspath(u
->udev
, path
))) {
359 pa_log("Failed to get udev device object from udev.");
363 process_device(u
, dev
);
364 udev_device_unref(dev
);
367 static void monitor_cb(
371 pa_io_event_flags_t events
,
374 struct userdata
*u
= userdata
;
375 struct udev_device
*dev
;
379 if (!(dev
= udev_monitor_receive_device(u
->monitor
))) {
380 pa_log("Failed to get udev device object from monitor.");
384 if (!path_get_card_id(udev_device_get_devpath(dev
)))
387 process_device(u
, dev
);
388 udev_device_unref(dev
);
392 a
->io_free(u
->udev_io
);
396 static pa_bool_t
pcm_node_belongs_to_device(
403 cd
= pa_sprintf_malloc("pcmC%sD", path_get_card_id(d
->path
));
404 b
= pa_startswith(node
, cd
);
410 static pa_bool_t
control_node_belongs_to_device(
417 cd
= pa_sprintf_malloc("controlC%s", path_get_card_id(d
->path
));
418 b
= pa_streq(node
, cd
);
424 static void inotify_cb(
428 pa_io_event_flags_t events
,
432 struct inotify_event e
;
435 struct userdata
*u
= userdata
;
437 pa_bool_t deleted
= FALSE
;
443 struct inotify_event
*event
;
446 if ((r
= pa_read(fd
, &buf
, sizeof(buf
), &type
)) <= 0) {
448 if (r
< 0 && errno
== EAGAIN
)
451 pa_log("read() from inotify failed: %s", r
< 0 ? pa_cstrerror(errno
) : "EOF");
459 if ((size_t) r
< sizeof(struct inotify_event
)) {
460 pa_log("read() too short.");
464 len
= sizeof(struct inotify_event
) + event
->len
;
466 if ((size_t) r
< len
) {
467 pa_log("Payload missing.");
471 /* From udev we get the guarantee that the control
472 * device's ACL is changed last. To avoid races when ACLs
473 * are changed we hence watch only the control device */
474 if (((event
->mask
& IN_ATTRIB
) && pa_startswith(event
->name
, "controlC")))
475 PA_HASHMAP_FOREACH(d
, u
->devices
, state
)
476 if (control_node_belongs_to_device(d
, event
->name
))
477 d
->need_verify
= TRUE
;
479 /* ALSA doesn't really give us any guarantee on the closing
480 * order, so let's simply hope */
481 if (((event
->mask
& IN_CLOSE_WRITE
) && pa_startswith(event
->name
, "pcmC")))
482 PA_HASHMAP_FOREACH(d
, u
->devices
, state
)
483 if (pcm_node_belongs_to_device(d
, event
->name
))
484 d
->need_verify
= TRUE
;
486 /* /dev/snd/ might have been removed */
487 if ((event
->mask
& (IN_DELETE_SELF
|IN_MOVE_SELF
)))
490 event
= (struct inotify_event
*) ((uint8_t*) event
+ len
);
495 PA_HASHMAP_FOREACH(d
, u
->devices
, state
)
496 if (d
->need_verify
) {
497 d
->need_verify
= FALSE
;
506 a
->io_free(u
->inotify_io
);
507 u
->inotify_io
= NULL
;
510 if (u
->inotify_fd
>= 0) {
511 pa_close(u
->inotify_fd
);
516 static int setup_inotify(struct userdata
*u
) {
520 if (u
->inotify_fd
>= 0)
523 if ((u
->inotify_fd
= inotify_init1(IN_CLOEXEC
|IN_NONBLOCK
)) < 0) {
524 pa_log("inotify_init1() failed: %s", pa_cstrerror(errno
));
528 dev_snd
= pa_sprintf_malloc("%s/snd", udev_get_dev_path(u
->udev
));
529 r
= inotify_add_watch(u
->inotify_fd
, dev_snd
, IN_ATTRIB
|IN_CLOSE_WRITE
|IN_DELETE_SELF
|IN_MOVE_SELF
);
533 int saved_errno
= errno
;
535 pa_close(u
->inotify_fd
);
538 if (saved_errno
== ENOENT
) {
539 pa_log_debug("/dev/snd/ is apparently not existing yet, retrying to create inotify watch later.");
543 if (saved_errno
== ENOSPC
) {
544 pa_log("You apparently ran out of inotify watches, probably because Tracker/Beagle took them all away. "
545 "I wished people would do their homework first and fix inotify before using it for watching whole "
546 "directory trees which is something the current inotify is certainly not useful for. "
547 "Please make sure to drop the Tracker/Beagle guys a line complaining about their broken use of inotify.");
551 pa_log("inotify_add_watch() failed: %s", pa_cstrerror(saved_errno
));
555 pa_assert_se(u
->inotify_io
= u
->core
->mainloop
->io_new(u
->core
->mainloop
, u
->inotify_fd
, PA_IO_EVENT_INPUT
, inotify_cb
, u
));
560 int pa__init(pa_module
*m
) {
561 struct userdata
*u
= NULL
;
563 struct udev_enumerate
*enumerate
= NULL
;
564 struct udev_list_entry
*item
= NULL
, *first
= NULL
;
566 pa_bool_t use_tsched
= TRUE
, ignore_dB
= FALSE
;
570 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
571 pa_log("Failed to parse module arguments");
575 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
577 u
->devices
= pa_hashmap_new(pa_idxset_string_hash_func
, pa_idxset_string_compare_func
);
580 if (pa_modargs_get_value_boolean(ma
, "tsched", &use_tsched
) < 0) {
581 pa_log("Failed to parse tsched= argument.");
584 u
->use_tsched
= use_tsched
;
586 if (pa_modargs_get_value_boolean(ma
, "ignore_dB", &ignore_dB
) < 0) {
587 pa_log("Failed to parse ignore_dB= argument.");
590 u
->ignore_dB
= ignore_dB
;
592 if (!(u
->udev
= udev_new())) {
593 pa_log("Failed to initialize udev library.");
597 if (setup_inotify(u
) < 0)
600 if (!(u
->monitor
= udev_monitor_new_from_netlink(u
->udev
, "udev"))) {
601 pa_log("Failed to initialize monitor.");
606 if (udev_monitor_enable_receiving(u
->monitor
) < 0) {
607 pa_log("Failed to enable monitor: %s", pa_cstrerror(errno
));
609 pa_log_info("Most likely your kernel is simply too old and "
610 "allows only priviliged processes to listen to device events. "
611 "Please upgrade your kernel to at least 2.6.30.");
615 if ((fd
= udev_monitor_get_fd(u
->monitor
)) < 0) {
616 pa_log("Failed to get udev monitor fd.");
620 pa_assert_se(u
->udev_io
= u
->core
->mainloop
->io_new(u
->core
->mainloop
, fd
, PA_IO_EVENT_INPUT
, monitor_cb
, u
));
622 if (!(enumerate
= udev_enumerate_new(u
->udev
))) {
623 pa_log("Failed to initialize udev enumerator.");
627 if (udev_enumerate_add_match_subsystem(enumerate
, "sound") < 0) {
628 pa_log("Failed to match to subsystem.");
632 if (udev_enumerate_scan_devices(enumerate
) < 0) {
633 pa_log("Failed to scan for devices.");
637 first
= udev_enumerate_get_list_entry(enumerate
);
638 udev_list_entry_foreach(item
, first
)
639 process_path(u
, udev_list_entry_get_name(item
));
641 udev_enumerate_unref(enumerate
);
643 pa_log_info("Found %u cards.", pa_hashmap_size(u
->devices
));
652 udev_enumerate_unref(enumerate
);
662 void pa__done(pa_module
*m
) {
667 if (!(u
= m
->userdata
))
671 m
->core
->mainloop
->io_free(u
->udev_io
);
674 udev_monitor_unref(u
->monitor
);
680 m
->core
->mainloop
->io_free(u
->inotify_io
);
682 if (u
->inotify_fd
>= 0)
683 pa_close(u
->inotify_fd
);
688 while ((d
= pa_hashmap_steal_first(u
->devices
)))
691 pa_hashmap_free(u
->devices
, NULL
, NULL
);