code.delx.au - pulseaudio/blob - src/pulsecore/module.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2006 Lennart Poettering
   5   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   6
   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 of the License,
  10   or (at your option) any later version.
  11
  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.
  16
  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
  20   USA.
  21 ***/
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include <config.h>
  25 #endif
  26
  27 #include <limits.h>
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <errno.h>
  32 #include <ctype.h>
  33
  34 #include <pulse/timeval.h>
  35 #include <pulse/xmalloc.h>
  36
  37 #include <pulsecore/core-subscribe.h>
  38 #include <pulsecore/log.h>
  39 #include <pulsecore/core-util.h>
  40 #include <pulsecore/macro.h>
  41 #include <pulsecore/ltdl-helper.h>
  42
  43 #include "module.h"
  44
  45 #define PA_SYMBOL_INIT "pa__init"
  46 #define PA_SYMBOL_DONE "pa__done"
  47 #define PA_SYMBOL_LOAD_ONCE "pa__load_once"
  48
  49 #define UNLOAD_POLL_TIME 2
  50
  51 static void timeout_callback(pa_mainloop_api *m, pa_time_event*e, PA_GCC_UNUSED const struct timeval *tv, void *userdata) {
  52     pa_core *c = PA_CORE(userdata);
  53     struct timeval ntv;
  54
  55     pa_core_assert_ref(c);
  56     pa_assert(c->mainloop == m);
  57     pa_assert(c->module_auto_unload_event == e);
  58
  59     pa_module_unload_unused(c);
  60
  61     pa_gettimeofday(&ntv);
  62     pa_timeval_add(&ntv, UNLOAD_POLL_TIME*1000000);
  63     m->time_restart(e, &ntv);
  64 }
  65
  66 pa_module* pa_module_load(pa_core *c, const char *name, const char *argument) {
  67     pa_module *m = NULL;
  68     pa_bool_t (*load_once)(void);
  69
  70     pa_assert(c);
  71     pa_assert(name);
  72
  73     if (c->disallow_module_loading)
  74         goto fail;
  75
  76     m = pa_xnew(pa_module, 1);
  77     m->name = pa_xstrdup(name);
  78     m->argument = pa_xstrdup(argument);
  79
  80     if (!(m->dl = lt_dlopenext(name))) {
  81         pa_log("Failed to open module \"%s\": %s", name, lt_dlerror());
  82         goto fail;
  83     }
  84
  85     if ((load_once = (pa_bool_t (*)(void)) pa_load_sym(m->dl, name, PA_SYMBOL_LOAD_ONCE))) {
  86
  87         if (load_once() && c->modules) {
  88             pa_module *i;
  89             uint32_t idx;
  90             /* OK, the module only wants to be loaded once, let's make sure it is */
  91
  92             for (i = pa_idxset_first(c->modules, &idx); i; i = pa_idxset_next(c->modules, &idx)) {
  93                 if (strcmp(name, i->name) == 0) {
  94                     pa_log("Module \"%s\" should be loaded once at most. Refusing to load.", name);
  95                     goto fail;
  96                 }
  97             }
  98         }
  99     }
 100
 101     if (!(m->init = (int (*)(pa_module*_m)) pa_load_sym(m->dl, name, PA_SYMBOL_INIT))) {
 102         pa_log("Failed to load module \"%s\": symbol \""PA_SYMBOL_INIT"\" not found.", name);
 103         goto fail;
 104     }
 105
 106     m->done = (void (*)(pa_module*_m)) pa_load_sym(m->dl, name, PA_SYMBOL_DONE);
 107     m->userdata = NULL;
 108     m->core = c;
 109     m->n_used = -1;
 110     m->auto_unload = FALSE;
 111     m->unload_requested = FALSE;
 112
 113     if (m->init(m) < 0) {
 114         pa_log_error("Failed to load  module \"%s\" (argument: \"%s\"): initialization failed.", name, argument ? argument : "");
 115         goto fail;
 116     }
 117
 118     if (!c->modules)
 119         c->modules = pa_idxset_new(NULL, NULL);
 120
 121     if (m->auto_unload && !c->module_auto_unload_event) {
 122         struct timeval ntv;
 123         pa_gettimeofday(&ntv);
 124         pa_timeval_add(&ntv, UNLOAD_POLL_TIME*1000000);
 125         c->module_auto_unload_event = c->mainloop->time_new(c->mainloop, &ntv, timeout_callback, c);
 126     }
 127
 128     pa_assert_se(pa_idxset_put(c->modules, m, &m->index) >= 0);
 129     pa_assert(m->index != PA_IDXSET_INVALID);
 130
 131     pa_log_info("Loaded \"%s\" (index: #%u; argument: \"%s\").", m->name, m->index, m->argument ? m->argument : "");
 132
 133     pa_subscription_post(c, PA_SUBSCRIPTION_EVENT_MODULE|PA_SUBSCRIPTION_EVENT_NEW, m->index);
 134
 135     return m;
 136
 137 fail:
 138
 139     if (m) {
 140         pa_xfree(m->argument);
 141         pa_xfree(m->name);
 142
 143         if (m->dl)
 144             lt_dlclose(m->dl);
 145
 146         pa_xfree(m);
 147     }
 148
 149     return NULL;
 150 }
 151
 152 static void pa_module_free(pa_module *m) {
 153     pa_assert(m);
 154     pa_assert(m->core);
 155
 156     if (m->core->disallow_module_loading)
 157         return;
 158
 159     pa_log_info("Unloading \"%s\" (index: #%u).", m->name, m->index);
 160
 161     if (m->done)
 162         m->done(m);
 163
 164     lt_dlclose(m->dl);
 165
 166     pa_log_info("Unloaded \"%s\" (index: #%u).", m->name, m->index);
 167
 168     pa_subscription_post(m->core, PA_SUBSCRIPTION_EVENT_MODULE|PA_SUBSCRIPTION_EVENT_REMOVE, m->index);
 169
 170     pa_xfree(m->name);
 171     pa_xfree(m->argument);
 172     pa_xfree(m);
 173 }
 174
 175 void pa_module_unload(pa_core *c, pa_module *m) {
 176     pa_assert(c);
 177     pa_assert(m);
 178
 179     pa_assert(c->modules);
 180     if (!(m = pa_idxset_remove_by_data(c->modules, m, NULL)))
 181         return;
 182
 183     pa_module_free(m);
 184 }
 185
 186 void pa_module_unload_by_index(pa_core *c, uint32_t idx) {
 187     pa_module *m;
 188     pa_assert(c);
 189     pa_assert(idx != PA_IDXSET_INVALID);
 190
 191     if (!(m = pa_idxset_remove_by_index(c->modules, idx)))
 192         return;
 193
 194     pa_module_free(m);
 195 }
 196
 197 static void free_callback(void *p, PA_GCC_UNUSED void *userdata) {
 198     pa_module *m = p;
 199     pa_assert(m);
 200     pa_module_free(m);
 201 }
 202
 203 void pa_module_unload_all(pa_core *c) {
 204     pa_module *m;
 205
 206     pa_assert(c);
 207
 208     if (!c->modules)
 209         return;
 210
 211     while ((m = pa_idxset_first(c->modules, NULL)))
 212         pa_module_unload(c, m);
 213
 214     pa_idxset_free(c->modules, free_callback, NULL);
 215     c->modules = NULL;
 216
 217     if (c->module_auto_unload_event) {
 218         c->mainloop->time_free(c->module_auto_unload_event);
 219         c->module_auto_unload_event = NULL;
 220     }
 221
 222     if (c->module_defer_unload_event) {
 223         c->mainloop->defer_free(c->module_defer_unload_event);
 224         c->module_defer_unload_event = NULL;
 225     }
 226 }
 227
 228 static int unused_callback(void *p, PA_GCC_UNUSED uint32_t idx, int *del, void *userdata) {
 229     pa_module *m = p;
 230     time_t *now = userdata;
 231
 232     pa_assert(m);
 233     pa_assert(del);
 234     pa_assert(now);
 235
 236     if (m->n_used == 0 && m->auto_unload && m->last_used_time+m->core->module_idle_time <= *now) {
 237         pa_module_free(m);
 238         *del = 1;
 239     }
 240
 241     return 0;
 242 }
 243
 244 void pa_module_unload_unused(pa_core *c) {
 245     time_t now;
 246     pa_assert(c);
 247
 248     if (!c->modules)
 249         return;
 250
 251     time(&now);
 252     pa_idxset_foreach(c->modules, unused_callback, &now);
 253 }
 254
 255 static int unload_callback(void *p, PA_GCC_UNUSED uint32_t idx, int *del, PA_GCC_UNUSED void *userdata) {
 256     pa_module *m = p;
 257     pa_assert(m);
 258
 259     if (m->unload_requested) {
 260         pa_module_free(m);
 261         *del = 1;
 262     }
 263
 264     return 0;
 265 }
 266
 267 static void defer_cb(pa_mainloop_api*api, pa_defer_event *e, void *userdata) {
 268     pa_core *core = PA_CORE(userdata);
 269
 270     pa_core_assert_ref(core);
 271     api->defer_enable(e, 0);
 272
 273     if (!core->modules)
 274         return;
 275
 276     pa_idxset_foreach(core->modules, unload_callback, NULL);
 277 }
 278
 279 void pa_module_unload_request(pa_module *m) {
 280     pa_assert(m);
 281
 282     m->unload_requested = TRUE;
 283
 284     if (!m->core->module_defer_unload_event)
 285         m->core->module_defer_unload_event = m->core->mainloop->defer_new(m->core->mainloop, defer_cb, m->core);
 286
 287     m->core->mainloop->defer_enable(m->core->module_defer_unload_event, 1);
 288 }
 289
 290 void pa_module_set_used(pa_module*m, int used) {
 291     pa_assert(m);
 292
 293     if (m->n_used != used)
 294         pa_subscription_post(m->core, PA_SUBSCRIPTION_EVENT_MODULE|PA_SUBSCRIPTION_EVENT_CHANGE, m->index);
 295
 296     if (used == 0 && m->n_used > 0)
 297         time(&m->last_used_time);
 298
 299     m->n_used = used;
 300 }
 301
 302 pa_modinfo *pa_module_get_info(pa_module *m) {
 303     pa_assert(m);
 304
 305     return pa_modinfo_get_by_handle(m->dl, m->name);
 306 }