2 This file is part of PulseAudio.
4 Copyright 2004-2006 Lennart Poettering
5 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
7 PulseAudio is free software; you can redistribute it and/or modify
8 it under the terms of the GNU Lesser General Public License as published
9 by the Free Software Foundation; either version 2.1 of the License,
10 or (at your option) any later version.
12 PulseAudio is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with PulseAudio; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
34 #include <pulse/timeval.h>
35 #include <pulse/xmalloc.h>
36 #include <pulse/proplist.h>
38 #include <pulsecore/core-subscribe.h>
39 #include <pulsecore/log.h>
40 #include <pulsecore/core-util.h>
41 #include <pulsecore/macro.h>
42 #include <pulsecore/ltdl-helper.h>
43 #include <pulsecore/modinfo.h>
47 #define PA_SYMBOL_INIT "pa__init"
48 #define PA_SYMBOL_DONE "pa__done"
49 #define PA_SYMBOL_LOAD_ONCE "pa__load_once"
50 #define PA_SYMBOL_GET_N_USED "pa__get_n_used"
52 pa_module
* pa_module_load(pa_core
*c
, const char *name
, const char *argument
) {
54 pa_bool_t (*load_once
)(void);
60 if (c
->disallow_module_loading
)
63 m
= pa_xnew(pa_module
, 1);
64 m
->name
= pa_xstrdup(name
);
65 m
->argument
= pa_xstrdup(argument
);
67 m
->proplist
= pa_proplist_new();
69 if (!(m
->dl
= lt_dlopenext(name
))) {
70 pa_log("Failed to open module \"%s\": %s", name
, lt_dlerror());
74 if ((load_once
= (pa_bool_t (*)(void)) pa_load_sym(m
->dl
, name
, PA_SYMBOL_LOAD_ONCE
))) {
76 m
->load_once
= load_once();
81 /* OK, the module only wants to be loaded once, let's make sure it is */
83 for (i
= pa_idxset_first(c
->modules
, &idx
); i
; i
= pa_idxset_next(c
->modules
, &idx
)) {
84 if (strcmp(name
, i
->name
) == 0) {
85 pa_log("Module \"%s\" should be loaded once at most. Refusing to load.", name
);
92 if (!(m
->init
= (int (*)(pa_module
*_m
)) pa_load_sym(m
->dl
, name
, PA_SYMBOL_INIT
))) {
93 pa_log("Failed to load module \"%s\": symbol \""PA_SYMBOL_INIT
"\" not found.", name
);
97 m
->done
= (void (*)(pa_module
*_m
)) pa_load_sym(m
->dl
, name
, PA_SYMBOL_DONE
);
98 m
->get_n_used
= (int (*)(pa_module
*_m
)) pa_load_sym(m
->dl
, name
, PA_SYMBOL_GET_N_USED
);
101 m
->unload_requested
= FALSE
;
103 if (m
->init(m
) < 0) {
104 pa_log_error("Failed to load module \"%s\" (argument: \"%s\"): initialization failed.", name
, argument
? argument
: "");
108 pa_assert_se(pa_idxset_put(c
->modules
, m
, &m
->index
) >= 0);
109 pa_assert(m
->index
!= PA_IDXSET_INVALID
);
111 pa_log_info("Loaded \"%s\" (index: #%u; argument: \"%s\").", m
->name
, m
->index
, m
->argument
? m
->argument
: "");
113 pa_subscription_post(c
, PA_SUBSCRIPTION_EVENT_MODULE
|PA_SUBSCRIPTION_EVENT_NEW
, m
->index
);
115 if ((mi
= pa_modinfo_get_by_handle(m
->dl
, name
))) {
117 if (mi
->author
&& !pa_proplist_contains(m
->proplist
, PA_PROP_MODULE_AUTHOR
))
118 pa_proplist_sets(m
->proplist
, PA_PROP_MODULE_AUTHOR
, mi
->author
);
120 if (mi
->description
&& !pa_proplist_contains(m
->proplist
, PA_PROP_MODULE_DESCRIPTION
))
121 pa_proplist_sets(m
->proplist
, PA_PROP_MODULE_DESCRIPTION
, mi
->description
);
123 if (mi
->version
&& !pa_proplist_contains(m
->proplist
, PA_PROP_MODULE_VERSION
))
124 pa_proplist_sets(m
->proplist
, PA_PROP_MODULE_VERSION
, mi
->version
);
135 pa_proplist_free(m
->proplist
);
137 pa_xfree(m
->argument
);
149 static void pa_module_free(pa_module
*m
) {
153 pa_log_info("Unloading \"%s\" (index: #%u).", m
->name
, m
->index
);
159 pa_proplist_free(m
->proplist
);
163 pa_log_info("Unloaded \"%s\" (index: #%u).", m
->name
, m
->index
);
165 pa_subscription_post(m
->core
, PA_SUBSCRIPTION_EVENT_MODULE
|PA_SUBSCRIPTION_EVENT_REMOVE
, m
->index
);
168 pa_xfree(m
->argument
);
172 void pa_module_unload(pa_core
*c
, pa_module
*m
, pa_bool_t force
) {
176 if (m
->core
->disallow_module_loading
&& !force
)
179 if (!(m
= pa_idxset_remove_by_data(c
->modules
, m
, NULL
)))
185 void pa_module_unload_by_index(pa_core
*c
, uint32_t idx
, pa_bool_t force
) {
188 pa_assert(idx
!= PA_IDXSET_INVALID
);
190 if (c
->disallow_module_loading
&& !force
)
193 if (!(m
= pa_idxset_remove_by_index(c
->modules
, idx
)))
199 void pa_module_unload_all(pa_core
*c
) {
203 while ((m
= pa_idxset_steal_first(c
->modules
, NULL
)))
206 if (c
->module_defer_unload_event
) {
207 c
->mainloop
->defer_free(c
->module_defer_unload_event
);
208 c
->module_defer_unload_event
= NULL
;
212 static void defer_cb(pa_mainloop_api
*api
, pa_defer_event
*e
, void *userdata
) {
214 pa_core
*c
= PA_CORE(userdata
);
217 pa_core_assert_ref(c
);
218 api
->defer_enable(e
, 0);
220 while ((m
= pa_idxset_iterate(c
->modules
, &state
, NULL
)))
221 if (m
->unload_requested
)
222 pa_module_unload(c
, m
, TRUE
);
225 void pa_module_unload_request(pa_module
*m
, pa_bool_t force
) {
228 if (m
->core
->disallow_module_loading
&& !force
)
231 m
->unload_requested
= TRUE
;
233 if (!m
->core
->module_defer_unload_event
)
234 m
->core
->module_defer_unload_event
= m
->core
->mainloop
->defer_new(m
->core
->mainloop
, defer_cb
, m
->core
);
236 m
->core
->mainloop
->defer_enable(m
->core
->module_defer_unload_event
, 1);
239 void pa_module_unload_request_by_index(pa_core
*c
, uint32_t idx
, pa_bool_t force
) {
243 if (!(m
= pa_idxset_get_by_index(c
->modules
, idx
)))
246 pa_module_unload_request(m
, force
);
249 int pa_module_get_n_used(pa_module
*m
) {
255 return m
->get_n_used(m
);