code.delx.au - pulseaudio/blob - polyp/module.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of polypaudio.
   5
   6   polypaudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published
   8   by the Free Software Foundation; either version 2 of the License,
   9   or (at your option) any later version.
  10
  11   polypaudio 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.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with polypaudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <limits.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <assert.h>
  30 #include <string.h>
  31 #include <errno.h>
  32
  33 #include "module.h"
  34 #include "xmalloc.h"
  35 #include "subscribe.h"
  36 #include "log.h"
  37
  38 #define PA_SYMBOL_INIT "pa__init"
  39 #define PA_SYMBOL_DONE "pa__done"
  40
  41 #define UNLOAD_POLL_TIME 2
  42
  43 static void timeout_callback(struct pa_mainloop_api *m, struct pa_time_event*e, const struct timeval *tv, void *userdata) {
  44     struct pa_core *c = userdata;
  45     struct timeval ntv;
  46     assert(c && c->mainloop == m && c->module_auto_unload_event == e);
  47
  48     pa_module_unload_unused(c);
  49
  50     gettimeofday(&ntv, NULL);
  51     ntv.tv_sec += UNLOAD_POLL_TIME;
  52     m->time_restart(e, &ntv);
  53 }
  54
  55 struct pa_module* pa_module_load(struct pa_core *c, const char *name, const char *argument) {
  56     struct pa_module *m = NULL;
  57     int r;
  58
  59     assert(c && name);
  60
  61     if (c->disallow_module_loading)
  62         goto fail;
  63
  64     m = pa_xmalloc(sizeof(struct pa_module));
  65
  66     m->name = pa_xstrdup(name);
  67     m->argument = pa_xstrdup(argument);
  68
  69     if (!(m->dl = lt_dlopenext(name))) {
  70         pa_log(__FILE__": Failed to open module \"%s\": %s\n", name, lt_dlerror());
  71         goto fail;
  72     }
  73
  74     if (!(m->init = (int (*)(struct pa_core *c, struct pa_module*m)) lt_dlsym(m->dl, PA_SYMBOL_INIT))) {
  75         pa_log(__FILE__": Failed to load module \"%s\": symbol \""PA_SYMBOL_INIT"\" not found.\n", name);
  76         goto fail;
  77     }
  78
  79     if (!(m->done = (void (*)(struct pa_core *c, struct pa_module*m)) lt_dlsym(m->dl, PA_SYMBOL_DONE))) {
  80         pa_log(__FILE__": Failed to load module \"%s\": symbol \""PA_SYMBOL_DONE"\" not found.\n", name);
  81         goto fail;
  82     }
  83
  84     m->userdata = NULL;
  85     m->core = c;
  86     m->n_used = -1;
  87     m->auto_unload = 0;
  88     m->unload_requested = 0;
  89
  90     assert(m->init);
  91     if (m->init(c, m) < 0) {
  92         pa_log(__FILE__": Failed to load  module \"%s\" (argument: \"%s\"): initialization failed.\n", name, argument ? argument : "");
  93         goto fail;
  94     }
  95
  96     if (!c->modules)
  97         c->modules = pa_idxset_new(NULL, NULL);
  98
  99     if (!c->module_auto_unload_event) {
 100         struct timeval ntv;
 101         gettimeofday(&ntv, NULL);
 102         ntv.tv_sec += UNLOAD_POLL_TIME;
 103         c->module_auto_unload_event = c->mainloop->time_new(c->mainloop, &ntv, timeout_callback, c);
 104     }
 105     assert(c->module_auto_unload_event);
 106
 107     assert(c->modules);
 108     r = pa_idxset_put(c->modules, m, &m->index);
 109     assert(r >= 0 && m->index != PA_IDXSET_INVALID);
 110
 111     pa_log(__FILE__": Loaded \"%s\" (index: #%u; argument: \"%s\").\n", m->name, m->index, m->argument ? m->argument : "");
 112
 113     pa_subscription_post(c, PA_SUBSCRIPTION_EVENT_MODULE|PA_SUBSCRIPTION_EVENT_NEW, m->index);
 114
 115     return m;
 116
 117 fail:
 118
 119     if (m) {
 120         pa_xfree(m->argument);
 121         pa_xfree(m->name);
 122
 123         if (m->dl)
 124             lt_dlclose(m->dl);
 125
 126         pa_xfree(m);
 127     }
 128
 129     return NULL;
 130 }
 131
 132 static void pa_module_free(struct pa_module *m) {
 133     assert(m && m->done && m->core);
 134
 135     if (m->core->disallow_module_loading)
 136         return;
 137
 138     pa_log(__FILE__": Unloading \"%s\" (index: #%u).\n", m->name, m->index);
 139
 140     m->done(m->core, m);
 141
 142     lt_dlclose(m->dl);
 143
 144     pa_log(__FILE__": Unloaded \"%s\" (index: #%u).\n", m->name, m->index);
 145
 146     pa_subscription_post(m->core, PA_SUBSCRIPTION_EVENT_MODULE|PA_SUBSCRIPTION_EVENT_REMOVE, m->index);
 147
 148     pa_xfree(m->name);
 149     pa_xfree(m->argument);
 150     pa_xfree(m);
 151 }
 152
 153 void pa_module_unload(struct pa_core *c, struct pa_module *m) {
 154     assert(c && m);
 155
 156     assert(c->modules);
 157     if (!(m = pa_idxset_remove_by_data(c->modules, m, NULL)))
 158         return;
 159
 160     pa_module_free(m);
 161 }
 162
 163 void pa_module_unload_by_index(struct pa_core *c, uint32_t index) {
 164     struct pa_module *m;
 165     assert(c && index != PA_IDXSET_INVALID);
 166
 167     assert(c->modules);
 168     if (!(m = pa_idxset_remove_by_index(c->modules, index)))
 169         return;
 170
 171     pa_module_free(m);
 172 }
 173
 174 static void free_callback(void *p, void *userdata) {
 175     struct pa_module *m = p;
 176     assert(m);
 177     pa_module_free(m);
 178 }
 179
 180 void pa_module_unload_all(struct pa_core *c) {
 181     assert(c);
 182
 183     if (!c->modules)
 184         return;
 185
 186     pa_idxset_free(c->modules, free_callback, NULL);
 187     c->modules = NULL;
 188
 189     if (c->module_auto_unload_event) {
 190         c->mainloop->time_free(c->module_auto_unload_event);
 191         c->module_auto_unload_event = NULL;
 192     }
 193
 194     if (c->module_defer_unload_event) {
 195         c->mainloop->defer_free(c->module_defer_unload_event);
 196         c->module_defer_unload_event = NULL;
 197     }
 198 }
 199
 200 static int unused_callback(void *p, uint32_t index, int *del, void *userdata) {
 201     struct pa_module *m = p;
 202     time_t *now = userdata;
 203     assert(p && del && now);
 204
 205     if (m->n_used == 0 && m->auto_unload && m->last_used_time+m->core->module_idle_time <= *now) {
 206         pa_module_free(m);
 207         *del = 1;
 208     }
 209
 210     return 0;
 211 }
 212
 213 void pa_module_unload_unused(struct pa_core *c) {
 214     time_t now;
 215     assert(c);
 216
 217     if (!c->modules)
 218         return;
 219
 220     time(&now);
 221     pa_idxset_foreach(c->modules, unused_callback, &now);
 222 }
 223
 224 static int unload_callback(void *p, uint32_t index, int *del, void *userdata) {
 225     struct pa_module *m = p;
 226     assert(m);
 227
 228     if (m->unload_requested) {
 229         pa_module_free(m);
 230         *del = 1;
 231     }
 232
 233     return 0;
 234 }
 235
 236 static void defer_cb(struct pa_mainloop_api*api, struct pa_defer_event *e, void *userdata) {
 237     struct pa_core *core = userdata;
 238     api->defer_enable(e, 0);
 239
 240     if (!core->modules)
 241         return;
 242
 243     pa_idxset_foreach(core->modules, unload_callback, NULL);
 244
 245 }
 246
 247 void pa_module_unload_request(struct pa_module *m) {
 248     assert(m);
 249
 250     m->unload_requested = 1;
 251
 252     if (!m->core->module_defer_unload_event)
 253         m->core->module_defer_unload_event = m->core->mainloop->defer_new(m->core->mainloop, defer_cb, m->core);
 254
 255     m->core->mainloop->defer_enable(m->core->module_defer_unload_event, 1);
 256 }
 257
 258 void pa_module_set_used(struct pa_module*m, int used) {
 259     assert(m);
 260
 261     if (m->n_used != used)
 262         pa_subscription_post(m->core, PA_SUBSCRIPTION_EVENT_MODULE|PA_SUBSCRIPTION_EVENT_CHANGE, m->index);
 263
 264     if (m->n_used != used && used == 0)
 265         time(&m->last_used_time);
 266
 267     m->n_used = used;
 268 }
 269
 270 struct pa_modinfo *pa_module_get_info(struct pa_module *m) {
 271     assert(m);
 272
 273     return pa_modinfo_get_by_handle(m->dl);
 274 }