diff options
author | José Bollo <jose.bollo@iot.bzh> | 2016-06-23 20:34:57 +0200 |
---|---|---|
committer | José Bollo <jose.bollo@iot.bzh> | 2016-06-23 20:42:57 +0200 |
commit | 7059e59cddc1c81321639875636e88895bc14309 (patch) | |
tree | 2e857745ae2dd18814bdfe2d6e3806151a51a43e /src | |
parent | ef908d903929988ad01f9df94415fc9c3ddebcac (diff) |
vocabulary: moving from 'plugin' to 'binding'
Change-Id: Ic9e118df2bede1fefbb591f8ae7887266b7324ca
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'src')
-rw-r--r-- | src/CMakeLists.txt | 2 | ||||
-rw-r--r-- | src/afb-api-dbus.c | 1 | ||||
-rw-r--r-- | src/afb-api-so.c | 114 | ||||
-rw-r--r-- | src/afb-api-so.h | 2 | ||||
-rw-r--r-- | src/main.c | 32 |
5 files changed, 75 insertions, 76 deletions
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 6abc8736..915da89d 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -1,7 +1,7 @@ INCLUDE(FindPkgConfig) -ADD_DEFINITIONS(-DPLUGIN_INSTALL_DIR="${plugin_install_dir}") +ADD_DEFINITIONS(-DBINDING_INSTALL_DIR="${binding_install_dir}") CHECK_INCLUDE_FILES(magic.h HAVE_MAGIC_H) CHECK_LIBRARY_EXISTS(magic magic_load "" HAVE_LIBMAGIC_SO) diff --git a/src/afb-api-dbus.c b/src/afb-api-dbus.c index 4c5d9083..b781f54f 100644 --- a/src/afb-api-dbus.c +++ b/src/afb-api-dbus.c @@ -26,7 +26,6 @@ #include <systemd/sd-bus.h> #include <json-c/json.h> -#include <afb/afb-plugin.h> #include <afb/afb-req-itf.h> #include "afb-common.h" diff --git a/src/afb-api-so.c b/src/afb-api-so.c index 168d9a6d..39a6e9b1 100644 --- a/src/afb-api-so.c +++ b/src/afb-api-so.c @@ -16,7 +16,7 @@ */ #define _GNU_SOURCE -#define NO_PLUGIN_VERBOSE_MACRO +#define NO_BINDING_VERBOSE_MACRO #include <stdio.h> #include <assert.h> @@ -28,7 +28,7 @@ #include <sys/types.h> #include <sys/stat.h> -#include <afb/afb-plugin.h> +#include <afb/afb-binding.h> #include <afb/afb-req-itf.h> #include <afb/afb-event-itf.h> @@ -43,14 +43,14 @@ #include "verbose.h" /* - * Description of a plugin + * Description of a binding */ struct api_so_desc { - struct AFB_plugin *plugin; /* descriptor */ + struct afb_binding *binding; /* descriptor */ size_t apilength; /* length of the API name */ void *handle; /* context of dlopen */ struct afb_svc *service; /* handler for service started */ - struct AFB_interface interface; /* interface for the plugin */ + struct afb_binding_interface interface; /* interface for the binding */ }; struct monitoring { @@ -58,9 +58,9 @@ struct monitoring { void (*action)(struct afb_req); }; -static const char plugin_register_function_v1[] = "pluginAfbV1Register"; -static const char plugin_service_init_function_v1[] = "pluginAfbV1ServiceInit"; -static const char plugin_service_event_function_v1[] = "pluginAfbV1ServiceEvent"; +static const char binding_register_function_v1[] = "afbBindingV1Register"; +static const char binding_service_init_function_v1[] = "afbBindingV1ServiceInit"; +static const char binding_service_event_function_v1[] = "afbBindingV1ServiceEvent"; static int api_timeout = 15; @@ -83,10 +83,10 @@ static struct afb_event afb_api_so_event_make(struct api_so_desc *desc, const ch char *event; /* makes the event name */ - assert(desc->plugin != NULL); + assert(desc->binding != NULL); length = strlen(name); event = alloca(length + 2 + desc->apilength); - memcpy(event, desc->plugin->v1.prefix, desc->apilength); + memcpy(event, desc->binding->v1.prefix, desc->apilength); event[desc->apilength] = '/'; memcpy(event + desc->apilength + 1, name, length + 1); @@ -100,10 +100,10 @@ static int afb_api_so_event_broadcast(struct api_so_desc *desc, const char *name char *event; /* makes the event name */ - assert(desc->plugin != NULL); + assert(desc->binding != NULL); length = strlen(name); event = alloca(length + 2 + desc->apilength); - memcpy(event, desc->plugin->v1.prefix, desc->apilength); + memcpy(event, desc->binding->v1.prefix, desc->apilength); event[desc->apilength] = '/'; memcpy(event + desc->apilength + 1, name, length + 1); @@ -117,7 +117,7 @@ static void afb_api_so_vverbose(struct api_so_desc *desc, int level, const char if (vasprintf(&p, fmt, args) < 0) vverbose(level, file, line, fmt, args); else { - verbose(level, file, line, "%s {plugin %s}", p, desc->plugin->v1.prefix); + verbose(level, file, line, "%s {binding %s}", p, desc->binding->v1.prefix); free(p); } } @@ -130,7 +130,7 @@ static void monitored_call(int signum, struct monitoring *data) data->action(data->req); } -static void call_check(struct afb_req req, struct afb_context *context, const struct AFB_verb_desc_v1 *verb) +static void call_check(struct afb_req req, struct afb_context *context, const struct afb_verb_desc_v1 *verb) { struct monitoring data; @@ -184,15 +184,15 @@ static void call_check(struct afb_req req, struct afb_context *context, const st static void call(struct api_so_desc *desc, struct afb_req req, struct afb_context *context, const char *verb, size_t lenverb) { - const struct AFB_verb_desc_v1 *v; + const struct afb_verb_desc_v1 *v; - v = desc->plugin->v1.verbs; + v = desc->binding->v1.verbs; while (v->name && (strncasecmp(v->name, verb, lenverb) || v->name[lenverb])) v++; if (v->name) call_check(req, context, v); else - afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->plugin->v1.prefix); + afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->binding->v1.prefix); } static int service_start(struct api_so_desc *desc, int share_session, int onneed) @@ -207,28 +207,28 @@ static int service_start(struct api_so_desc *desc, int share_session, int onneed return 0; /* already started: it is an error */ - ERROR("Service %s already started", desc->plugin->v1.prefix); + ERROR("Service %s already started", desc->binding->v1.prefix); return -1; } /* get the initialisation */ - init = dlsym(desc->handle, plugin_service_init_function_v1); + init = dlsym(desc->handle, binding_service_init_function_v1); if (init == NULL) { /* not an error when onneed */ if (onneed != 0) return 0; /* no initialisation method */ - ERROR("Binding %s is not a service", desc->plugin->v1.prefix); + ERROR("Binding %s is not a service", desc->binding->v1.prefix); return -1; } /* get the event handler if any */ - onevent = dlsym(desc->handle, plugin_service_event_function_v1); + onevent = dlsym(desc->handle, binding_service_event_function_v1); desc->service = afb_svc_create(share_session, init, onevent); if (desc->service == NULL) { /* starting error */ - ERROR("Starting service %s failed", desc->plugin->v1.prefix); + ERROR("Starting service %s failed", desc->binding->v1.prefix); return -1; } @@ -240,28 +240,28 @@ void afb_api_so_set_timeout(int to) api_timeout = to; } -int afb_api_so_add_plugin(const char *path) +int afb_api_so_add_binding(const char *path) { int rc; void *handle; struct api_so_desc *desc; - struct AFB_plugin *(*pluginAfbV1RegisterFct) (const struct AFB_interface *interface); + struct afb_binding *(*register_function) (const struct afb_binding_interface *interface); - // This is a loadable library let's check if it's a plugin + // This is a loadable library let's check if it's a binding rc = 0; handle = dlopen(path, RTLD_NOW | RTLD_LOCAL); if (handle == NULL) { - ERROR("plugin [%s] not loadable", path); + ERROR("binding [%s] not loadable", path); goto error; } /* retrieves the register function */ - pluginAfbV1RegisterFct = dlsym(handle, plugin_register_function_v1); - if (!pluginAfbV1RegisterFct) { - ERROR("plugin [%s] is not an AFB plugin", path); + register_function = dlsym(handle, binding_register_function_v1); + if (!register_function) { + ERROR("binding [%s] is not an AFB binding", path); goto error2; } - INFO("plugin [%s] is a valid AFB plugin", path); + INFO("binding [%s] is a valid AFB binding", path); rc = -1; /* allocates the description */ @@ -278,46 +278,46 @@ int afb_api_so_add_plugin(const char *path) desc->interface.daemon.itf = &daemon_itf; desc->interface.daemon.closure = desc; - /* init the plugin */ - NOTICE("plugin [%s] calling registering function %s", path, plugin_register_function_v1); - desc->plugin = pluginAfbV1RegisterFct(&desc->interface); - if (desc->plugin == NULL) { - ERROR("plugin [%s] register function failed. continuing...", path); + /* init the binding */ + NOTICE("binding [%s] calling registering function %s", path, binding_register_function_v1); + desc->binding = register_function(&desc->interface); + if (desc->binding == NULL) { + ERROR("binding [%s] register function failed. continuing...", path); goto error3; } /* check the returned structure */ - if (desc->plugin->type != AFB_PLUGIN_VERSION_1) { - ERROR("plugin [%s] invalid type %d...", path, desc->plugin->type); + if (desc->binding->type != AFB_BINDING_VERSION_1) { + ERROR("binding [%s] invalid type %d...", path, desc->binding->type); goto error3; } - if (desc->plugin->v1.prefix == NULL || *desc->plugin->v1.prefix == 0) { - ERROR("plugin [%s] bad prefix...", path); + if (desc->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) { + ERROR("binding [%s] bad prefix...", path); goto error3; } - if (!afb_apis_is_valid_api_name(desc->plugin->v1.prefix)) { - ERROR("plugin [%s] invalid prefix...", path); + if (!afb_apis_is_valid_api_name(desc->binding->v1.prefix)) { + ERROR("binding [%s] invalid prefix...", path); goto error3; } - if (desc->plugin->v1.info == NULL || *desc->plugin->v1.info == 0) { - ERROR("plugin [%s] bad description...", path); + if (desc->binding->v1.info == NULL || *desc->binding->v1.info == 0) { + ERROR("binding [%s] bad description...", path); goto error3; } - if (desc->plugin->v1.verbs == NULL) { - ERROR("plugin [%s] no APIs...", path); + if (desc->binding->v1.verbs == NULL) { + ERROR("binding [%s] no APIs...", path); goto error3; } - /* records the plugin */ - desc->apilength = strlen(desc->plugin->v1.prefix); - if (afb_apis_add(desc->plugin->v1.prefix, (struct afb_api){ + /* records the binding */ + desc->apilength = strlen(desc->binding->v1.prefix); + if (afb_apis_add(desc->binding->v1.prefix, (struct afb_api){ .closure = desc, .call = (void*)call, .service_start = (void*)service_start }) < 0) { - ERROR("plugin [%s] can't be registered...", path); + ERROR("binding [%s] can't be registered...", path); goto error3; } - NOTICE("plugin %s loaded with API prefix %s", path, desc->plugin->v1.prefix); + NOTICE("binding %s loaded with API prefix %s", path, desc->binding->v1.prefix); return 0; error3: @@ -337,10 +337,10 @@ static int adddirs(char path[PATH_MAX], size_t end) /* open the DIR now */ dir = opendir(path); if (dir == NULL) { - ERROR("can't scan plugin directory %s, %m", path); + ERROR("can't scan binding directory %s, %m", path); return -1; } - INFO("Scanning dir=[%s] for plugins", path); + INFO("Scanning dir=[%s] for bindings", path); /* scan each entry */ if (end) @@ -352,7 +352,7 @@ static int adddirs(char path[PATH_MAX], size_t end) len = strlen(ent.d_name); if (len + end >= PATH_MAX) { - ERROR("path too long while scanning plugins for %s", ent.d_name); + ERROR("path too long while scanning bindings for %s", ent.d_name); continue; } memcpy(&path[end], ent.d_name, len+1); @@ -369,7 +369,7 @@ static int adddirs(char path[PATH_MAX], size_t end) /* case of files */ if (!strstr(ent.d_name, ".so")) continue; - if (afb_api_so_add_plugin(path) < 0) + if (afb_api_so_add_binding(path) < 0) return -1; } } @@ -399,13 +399,13 @@ int afb_api_so_add_path(const char *path) rc = stat(path, &st); if (rc < 0) - ERROR("Invalid plugin path [%s]: %m", path); + ERROR("Invalid binding path [%s]: %m", path); else if (S_ISDIR(st.st_mode)) rc = afb_api_so_add_directory(path); else if (strstr(path, ".so")) - rc = afb_api_so_add_plugin(path); + rc = afb_api_so_add_binding(path); else - INFO("not a plugin [%s], skipped", path); + INFO("not a binding [%s], skipped", path); return rc; } diff --git a/src/afb-api-so.h b/src/afb-api-so.h index 143b7a05..d2ffbc8f 100644 --- a/src/afb-api-so.h +++ b/src/afb-api-so.h @@ -20,7 +20,7 @@ extern void afb_api_so_set_timeout(int to); -extern int afb_api_so_add_plugin(const char *path); +extern int afb_api_so_add_binding(const char *path); extern int afb_api_so_add_directory(const char *path); @@ -17,7 +17,7 @@ */ #define _GNU_SOURCE -#define NO_PLUGIN_VERBOSE_MACRO +#define NO_BINDING_VERBOSE_MACRO #include <stdlib.h> #include <stdio.h> @@ -42,10 +42,10 @@ #include "verbose.h" #include "afb-common.h" -#include <afb/afb-plugin.h> +#include <afb/afb-binding.h> -#if !defined(PLUGIN_INSTALL_DIR) -#error "you should define PLUGIN_INSTALL_DIR" +#if !defined(BINDING_INSTALL_DIR) +#error "you should define BINDING_INSTALL_DIR" #endif #define AFB_VERSION "0.5" @@ -77,7 +77,7 @@ #define DBUS_CLIENT 20 #define DBUS_SERVICE 21 -#define SO_PLUGIN 22 +#define SO_BINDING 22 #define SET_SESSIONMAX 23 @@ -103,13 +103,13 @@ static AFB_options cliOptions [] = { {SET_ROOT_API ,1,"rootapi" , "HTML Root API URL [default /api]"}, {SET_ALIAS ,1,"alias" , "Muliple url map outside of rootdir [eg: --alias=/icons:/usr/share/icons]"}, - {SET_APITIMEOUT ,1,"apitimeout" , "Plugin API timeout in seconds [default 10]"}, + {SET_APITIMEOUT ,1,"apitimeout" , "Binding API timeout in seconds [default 10]"}, {SET_CNTXTIMEOUT ,1,"cntxtimeout" , "Client Session Context Timeout [default 900]"}, {SET_CACHE_TIMEOUT,1,"cache-eol" , "Client cache end of live [default 3600]"}, {SET_SESSION_DIR ,1,"sessiondir" , "Sessions file path [default rootdir/sessions]"}, - {SET_LDPATH ,1,"ldpaths" , "Load Plugins from dir1:dir2:... [default = PLUGIN_INSTALL_DIR"}, + {SET_LDPATH ,1,"ldpaths" , "Load bindingss from dir1:dir2:... [default = "BINDING_INSTALL_DIR"]"}, {SET_AUTH_TOKEN ,1,"token" , "Initial Secret [default=no-session, --token="" for session without authentication]"}, {DISPLAY_VERSION ,0,"version" , "Display version and copyright"}, @@ -120,7 +120,7 @@ static AFB_options cliOptions [] = { {DBUS_CLIENT ,1,"dbus-client" , "bind to an afb service through dbus"}, {DBUS_SERVICE ,1,"dbus-server" , "provides an afb service through dbus"}, - {SO_PLUGIN ,1,"plugin" , "load the plugin of path"}, + {SO_BINDING ,1,"binding" , "load the binding of path"}, {SET_SESSIONMAX ,1,"session-max" , "max count of session simultaneously [default 10]"}, @@ -164,7 +164,7 @@ static void printHelp(FILE *file, const char *name) fprintf (file, " --%-15s %s\n", command, cliOptions[ind].help); } } - fprintf (file, "Example:\n %s\\\n --verbose --port=1234 --token='azerty' --ldpaths=build/plugins:/usr/lib64/agl/plugins\n", name); + fprintf (file, "Example:\n %s\\\n --verbose --port=1234 --token='azerty' --ldpaths=build/bindings:/usr/lib64/agl/bindings\n", name); } // load config from disk and merge with CLI option @@ -174,7 +174,7 @@ static void config_set_default (struct afb_config * config) if (config->httpdPort == 0) config->httpdPort = 1234; - // default Plugin API timeout + // default binding API timeout if (config->apiTimeout == 0) config->apiTimeout = DEFLT_API_TIMEOUT; @@ -213,7 +213,7 @@ static void config_set_default (struct afb_config * config) config->rootapi = "/api"; if (config->ldpaths == NULL) - config->ldpaths = PLUGIN_INSTALL_DIR; + config->ldpaths = BINDING_INSTALL_DIR; // if no session dir create a default path from rootdir if (config->sessiondir == NULL) { @@ -384,7 +384,7 @@ static void parse_arguments(int argc, char *argv[], struct afb_config *config) case DBUS_CLIENT: case DBUS_SERVICE: - case SO_PLUGIN: + case SO_BINDING: if (optarg == 0) goto needValueForOption; add_item(config, optc, optarg); break; @@ -559,9 +559,9 @@ static void start_items(struct afb_config_item *item) exit(1); } break; - case SO_PLUGIN: - if (afb_api_so_add_plugin(item->value) < 0) { - ERROR("can't start the plugin of path %s",item->value); + case SO_BINDING: + if (afb_api_so_add_binding(item->value) < 0) { + ERROR("can't start the binding of path %s",item->value); exit(1); } break; @@ -601,7 +601,7 @@ int main(int argc, char *argv[]) { afb_api_so_set_timeout(config->apiTimeout); if (config->ldpaths) { if (afb_api_so_add_pathset(config->ldpaths) < 0) { - ERROR("initialisation of plugins within %s failed", config->ldpaths); + ERROR("initialisation of bindings within %s failed", config->ldpaths); exit(1); } } |