Add plugin support infrastructure

This commit is contained in:
Marcel Holtmann 2009-04-26 21:28:48 +02:00
parent e059f43fae
commit ed08e2adee
8 changed files with 289 additions and 3 deletions

View File

@ -76,5 +76,5 @@ AC_SUBST(DBUS_DATADIR)
AC_SUBST([GDBUS_CFLAGS], ['$(DBUS_CFLAGS) -I$(top_srcdir)/gdbus'])
AC_SUBST([GDBUS_LIBS], ['$(top_builddir)/gdbus/libgdbus.la $(DBUS_LIBS)'])
AC_OUTPUT(Makefile gdbus/Makefile include/Makefile
AC_OUTPUT(Makefile gdbus/Makefile include/Makefile include/version.h
src/Makefile plugins/Makefile)

View File

@ -1,7 +1,9 @@
includedir = @includedir@/ofono
include_HEADERS = log.h
include_HEADERS = log.h plugin.h
nodist_include_HEADERS = version.h
MAINTAINERCLEANFILES = Makefile.in
@ -10,6 +12,8 @@ all-local:
mkdir ofono; \
list='$(include_HEADERS)'; for i in $$list; \
do $(LN_S) $(abs_top_srcdir)/include/$$i ofono/$$i; done; \
list='$(nodist_include_HEADERS)'; for i in $$list; \
do $(LN_S) $(abs_top_builddir)/include/$$i ofono/$$i; done; \
fi
clean-local:

76
include/plugin.h Normal file
View File

@ -0,0 +1,76 @@
/*
*
* oFono - Open Telephony stack for Linux
*
* Copyright (C) 2008-2009 Intel Corporation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef __OFONO_PLUGIN_H
#define __OFONO_PLUGIN_H
#include <ofono/version.h>
#ifdef __cplusplus
extern "C" {
#endif
#ifndef OFONO_API_SUBJECT_TO_CHANGE
#error "Please define OFONO_API_SUBJECT_TO_CHANGE to acknowledge your \
understanding that oFono hasn't reached a stable API."
#endif
#define OFONO_PLUGIN_PRIORITY_LOW -100
#define OFONO_PLUGIN_PRIORITY_DEFAULT 0
#define OFONO_PLUGIN_PRIORITY_HIGH 100
/**
* SECTION:plugin
* @title: Plugin premitives
* @short_description: Functions for declaring plugins
*/
struct ofono_plugin_desc {
const char *name;
const char *description;
const char *version;
int priority;
int (*init) (void);
void (*exit) (void);
};
/**
* OFONO_PLUGIN_DEFINE:
* @name: plugin name
* @description: plugin description
* @version: plugin version string
* @init: init function called on plugin loading
* @exit: exit function called on plugin removal
*
* Macro for defining a plugin descriptor
*/
#define OFONO_PLUGIN_DEFINE(name, description, version, priority, init, exit) \
extern struct ofono_plugin_desc ofono_plugin_desc \
__attribute__ ((visibility("default"))); \
struct ofono_plugin_desc ofono_plugin_desc = { \
#name, description, version, priority, init, exit \
};
#ifdef __cplusplus
}
#endif
#endif /* __OFONO_PLUGIN_H */

35
include/version.h.in Normal file
View File

@ -0,0 +1,35 @@
/*
*
* oFono - Open Telephony stack for Linux
*
* Copyright (C) 2008-2009 Intel Corporation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef __OFONO_VERSION_H
#define __OFONO_VERSION_H
#ifdef __cplusplus
extern "C" {
#endif
#define OFONO_VERSION "@VERSION@"
#ifdef __cplusplus
}
#endif
#endif /* __OFONO_VERSION_H */

View File

@ -1,7 +1,7 @@
sbin_PROGRAMS = ofonod
ofonod_SOURCES = main.c ofono.h log.c
ofonod_SOURCES = main.c ofono.h log.c plugin.c
ofonod_LDADD = @GDBUS_LIBS@ @GLIB_LIBS@ @GTHREAD_LIBS@ -ldl

View File

@ -29,6 +29,10 @@ int main(int argc, char *argv[])
{
__ofono_log_init();
__ofono_plugin_init(NULL, NULL);
__ofono_plugin_cleanup();
__ofono_log_cleanup();
return 0;

View File

@ -27,3 +27,8 @@
int __ofono_log_init(void);
void __ofono_log_cleanup(void);
#include <ofono/plugin.h>
int __ofono_plugin_init(const char *pattern, const char *exclude);
void __ofono_plugin_cleanup(void);

162
src/plugin.c Normal file
View File

@ -0,0 +1,162 @@
/*
*
* oFono - Open Telephony stack for Linux
*
* Copyright (C) 2008-2009 Intel Corporation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <dlfcn.h>
#include <glib.h>
#include "ofono.h"
static GSList *plugins = NULL;
struct ofono_plugin {
void *handle;
gboolean active;
struct ofono_plugin_desc *desc;
};
static gint compare_priority(gconstpointer a, gconstpointer b)
{
const struct ofono_plugin *plugin1 = a;
const struct ofono_plugin *plugin2 = b;
return plugin2->desc->priority - plugin1->desc->priority;
}
static gboolean add_plugin(void *handle, struct ofono_plugin_desc *desc)
{
struct ofono_plugin *plugin;
if (desc->init == NULL)
return FALSE;
if (g_str_equal(desc->version, OFONO_VERSION) == FALSE) {
DBG("version mismatch for %s", desc->description);
return FALSE;
}
plugin = g_try_new0(struct ofono_plugin, 1);
if (plugin == NULL)
return FALSE;
plugin->handle = handle;
plugin->active = FALSE;
plugin->desc = desc;
plugins = g_slist_insert_sorted(plugins, plugin, compare_priority);
return TRUE;
}
int __ofono_plugin_init(const char *pattern, const char *exclude)
{
GSList *list;
GDir *dir;
const gchar *file;
gchar *filename;
DBG("");
dir = g_dir_open(PLUGINDIR, 0, NULL);
if (dir != NULL) {
while ((file = g_dir_read_name(dir)) != NULL) {
void *handle;
struct ofono_plugin_desc *desc;
if (g_str_has_prefix(file, "lib") == TRUE ||
g_str_has_suffix(file, ".so") == FALSE)
continue;
filename = g_build_filename(PLUGINDIR, file, NULL);
handle = dlopen(filename, RTLD_NOW);
if (handle == NULL) {
g_warning("Can't load %s: %s", filename,
dlerror());
g_free(filename);
continue;
}
g_free(filename);
desc = dlsym(handle, "ofono_plugin_desc");
if (desc == NULL) {
g_warning("Can't load symbol: %s", dlerror());
dlclose(handle);
continue;
}
if (exclude != NULL && g_pattern_match_simple(exclude,
desc->name) == TRUE) {
DBG("excluding %s", desc->description);
dlclose(handle);
continue;
}
if (pattern != NULL && g_pattern_match_simple(pattern,
desc->name) == FALSE) {
DBG("ignoring %s", desc->description);
dlclose(handle);
continue;
}
if (add_plugin(handle, desc) == FALSE)
dlclose(handle);
}
g_dir_close(dir);
}
for (list = plugins; list; list = list->next) {
struct ofono_plugin *plugin = list->data;
if (plugin->desc->init() < 0)
continue;
plugin->active = TRUE;
}
return 0;
}
void __ofono_plugin_cleanup(void)
{
GSList *list;
DBG("");
for (list = plugins; list; list = list->next) {
struct ofono_plugin *plugin = list->data;
if (plugin->active == TRUE && plugin->desc->exit)
plugin->desc->exit();
dlclose(plugin->handle);
g_free(plugin);
}
g_slist_free(plugins);
}