/*
- * Copyright (C) 2016 "IoT.bzh"
+ * Copyright (C) 2016, 2017 "IoT.bzh"
* Author José Bollo <jose.bollo@iot.bzh>
*
* Licensed under the Apache License, Version 2.0 (the "License");
*/
#define _GNU_SOURCE
+#define NO_BINDING_VERBOSE_MACRO
#include <stdio.h>
#include <assert.h>
#include <string.h>
#include <dirent.h>
+#include <errno.h>
#include <dlfcn.h>
#include <unistd.h>
#include <limits.h>
#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-evmgr-itf.h>
+#include <afb/afb-event-itf.h>
-#include "session.h"
+#include "afb-session.h"
#include "afb-common.h"
#include "afb-context.h"
#include "afb-apis.h"
#include "afb-api-so.h"
-#include "afb-sig-handler.h"
+#include "afb-thread.h"
+#include "afb-evt.h"
+#include "afb-svc.h"
#include "verbose.h"
+/*
+ * Description of a binding
+ */
struct api_so_desc {
- struct AFB_plugin *plugin; /* descriptor */
- size_t apilength;
+ struct afb_binding *binding; /* descriptor */
+ size_t apilength; /* length of the API name */
void *handle; /* context of dlopen */
- struct AFB_interface interface; /* interface */
+ struct afb_svc *service; /* handler for service started */
+ struct afb_binding_interface interface; /* interface for the binding */
};
+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;
-static const char plugin_register_function[] = "pluginAfbV1Entry";
+static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name);
+static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object);
+static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args);
+static int afb_api_so_rootdir_get_fd(void *closure);
+static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale);
+
+static const struct afb_daemon_itf daemon_itf = {
+ .event_broadcast = afb_api_so_event_broadcast_cb,
+ .get_event_loop = afb_common_get_event_loop,
+ .get_user_bus = afb_common_get_user_bus,
+ .get_system_bus = afb_common_get_system_bus,
+ .vverbose = afb_api_so_vverbose_cb,
+ .event_make = afb_api_so_event_make_cb,
+ .rootdir_get_fd = afb_api_so_rootdir_get_fd,
+ .rootdir_open_locale = afb_api_so_rootdir_open_locale
+};
-static void afb_api_so_evmgr_push(struct api_so_desc *desc, const char *name, struct json_object *object)
+static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name)
{
size_t length;
char *event;
+ struct api_so_desc *desc = closure;
- assert(desc->plugin != NULL);
+ /* makes the event name */
+ 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);
- ctxClientEventSend(NULL, event, object);
-}
-static const struct afb_evmgr_itf evmgr_itf = {
- .push = (void*)afb_api_so_evmgr_push
-};
+ /* crate the event */
+ return afb_evt_create_event(event);
+}
-static struct afb_evmgr afb_api_so_get_evmgr(struct api_so_desc *desc)
+static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object)
{
- return (struct afb_evmgr){ .itf = &evmgr_itf, .closure = desc };
-}
+ size_t length;
+ char *event;
+ struct api_so_desc *desc = closure;
-static const struct afb_daemon_itf daemon_itf = {
- .get_evmgr = (void*)afb_api_so_get_evmgr,
- .get_event_loop = (void*)afb_common_get_event_loop,
- .get_user_bus = (void*)afb_common_get_user_bus,
- .get_system_bus = (void*)afb_common_get_system_bus
-};
+ /* makes the event name */
+ assert(desc->binding != NULL);
+ length = strlen(name);
+ event = alloca(length + 2 + desc->apilength);
+ memcpy(event, desc->binding->v1.prefix, desc->apilength);
+ event[desc->apilength] = '/';
+ memcpy(event + desc->apilength + 1, name, length + 1);
-struct monitoring {
- struct afb_req req;
- void (*action)(struct afb_req);
-};
+ return afb_evt_broadcast(event, object);
+}
-static void monitored_call(int signum, struct monitoring *data)
+static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args)
{
- if (signum != 0)
- afb_req_fail_f(data->req, "aborted", "signal %s(%d) caught", strsignal(signum), signum);
- else
- data->action(data->req);
+ char *p;
+ struct api_so_desc *desc = closure;
+
+ if (vasprintf(&p, fmt, args) < 0)
+ vverbose(level, file, line, fmt, args);
+ else {
+ verbose(level, file, line, "%s {binding %s}", p, desc->binding->v1.prefix);
+ free(p);
+ }
+}
+
+static int afb_api_so_rootdir_get_fd(void *closure)
+{
+ return afb_common_rootdir_get_fd();
}
-static void call_check(struct afb_req req, struct afb_context *context, const struct AFB_verb_desc_v1 *verb)
+static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale)
{
- struct monitoring data;
+ return afb_common_rootdir_open_locale(filename, flags, locale);
+}
- int stag = (int)(verb->session & AFB_SESSION_MASK);
+static int call_check(struct afb_req req, struct afb_context *context, const struct afb_verb_desc_v1 *verb)
+{
+ int stag = (int)verb->session;
- if (stag != AFB_SESSION_NONE) {
+ if ((stag & (AFB_SESSION_CREATE|AFB_SESSION_CLOSE|AFB_SESSION_RENEW|AFB_SESSION_CHECK|AFB_SESSION_LOA_EQ)) != 0) {
if (!afb_context_check(context)) {
afb_context_close(context);
afb_req_fail(req, "failed", "invalid token's identity");
- return;
- }
+ return 0;
+ }
}
if ((stag & AFB_SESSION_CREATE) != 0) {
- if (!afb_context_create(context)) {
- afb_context_close(context);
+ if (afb_context_check_loa(context, 1)) {
afb_req_fail(req, "failed", "invalid creation state");
- return;
+ return 0;
}
+ afb_context_change_loa(context, 1);
+ afb_context_refresh(context);
}
-
+
if ((stag & (AFB_SESSION_CREATE | AFB_SESSION_RENEW)) != 0)
afb_context_refresh(context);
- if ((stag & AFB_SESSION_CLOSE) != 0)
+ if ((stag & AFB_SESSION_CLOSE) != 0) {
+ afb_context_change_loa(context, 0);
afb_context_close(context);
+ }
+
+ if ((stag & AFB_SESSION_LOA_GE) != 0) {
+ int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
+ if (!afb_context_check_loa(context, loa)) {
+ afb_req_fail(req, "failed", "invalid LOA");
+ return 0;
+ }
+ }
- data.req = req;
- data.action = verb->callback;
- afb_sig_monitor((void*)monitored_call, &data, api_timeout);
+ if ((stag & AFB_SESSION_LOA_LE) != 0) {
+ int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
+ if (afb_context_check_loa(context, loa + 1)) {
+ afb_req_fail(req, "failed", "invalid LOA");
+ return 0;
+ }
+ }
+ return 1;
}
-static void call(struct api_so_desc *desc, struct afb_req req, struct afb_context *context, const char *verb, size_t lenverb)
+static void call_cb(void *closure, struct afb_req req, struct afb_context *context, const char *strverb)
{
- const struct AFB_verb_desc_v1 *v;
+ const struct afb_verb_desc_v1 *verb;
+ struct api_so_desc *desc = closure;
+
+ verb = desc->binding->v1.verbs;
+ while (verb->name && strcasecmp(verb->name, strverb))
+ verb++;
+ if (!verb->name)
+ afb_req_fail_f(req, "unknown-verb", "verb %s unknown within api %s", strverb, desc->binding->v1.prefix);
+ else if (call_check(req, context, verb)) {
+ afb_thread_req_call(req, verb->callback, api_timeout, desc);
+ }
+}
- v = desc->plugin->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);
+static int service_start_cb(void *closure, int share_session, int onneed)
+{
+ int (*init)(struct afb_service service);
+ void (*onevent)(const char *event, struct json_object *object);
+
+ struct api_so_desc *desc = closure;
+
+ /* check state */
+ if (desc->service != NULL) {
+ /* not an error when onneed */
+ if (onneed != 0)
+ return 0;
+
+ /* already started: it is an error */
+ ERROR("Service %s already started", desc->binding->v1.prefix);
+ return -1;
+ }
+
+ /* get the initialisation */
+ 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->binding->v1.prefix);
+ return -1;
+ }
+
+ /* get the event handler if any */
+ 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->binding->v1.prefix);
+ return -1;
+ }
+
+ return 0;
}
-int afb_api_so_add_plugin(const char *path)
+void afb_api_so_set_timeout(int to)
{
- struct api_so_desc *desc;
- struct AFB_plugin *(*pluginAfbV1RegisterFct) (const struct AFB_interface *interface);
+ api_timeout = to;
+}
- desc = calloc(1, sizeof *desc);
- if (desc == NULL) {
- ERROR("out of memory");
+int afb_api_so_add_binding(const char *path)
+{
+ int rc;
+ void *handle;
+ struct api_so_desc *desc;
+ struct afb_binding *(*register_function) (const struct afb_binding_interface *interface);
+ struct afb_verb_desc_v1 fake_verb;
+ struct afb_binding fake_binding;
+
+ // 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("binding [%s] not loadable: %s", path, dlerror());
goto error;
}
- // This is a loadable library let's check if it's a plugin
- desc->handle = dlopen(path, RTLD_NOW | RTLD_LOCAL);
- if (desc->handle == NULL) {
- ERROR("plugin [%s] not loadable", path);
+ /* retrieves the register function */
+ register_function = dlsym(handle, binding_register_function_v1);
+ if (!register_function) {
+ ERROR("binding [%s] is not an AFB binding", path);
goto error2;
}
+ INFO("binding [%s] is a valid AFB binding", path);
+ rc = -1;
- /* retrieves the register function */
- pluginAfbV1RegisterFct = dlsym(desc->handle, plugin_register_function);
- if (!pluginAfbV1RegisterFct) {
- ERROR("plugin [%s] is not an AFB plugin", path);
- goto error3;
+ /* allocates the description */
+ desc = calloc(1, sizeof *desc);
+ if (desc == NULL) {
+ ERROR("out of memory");
+ goto error2;
}
- INFO("plugin [%s] is a valid AFB plugin", path);
+ desc->handle = handle;
/* init the interface */
- desc->interface.verbosity = 0;
+ desc->interface.verbosity = verbosity;
desc->interface.mode = AFB_MODE_LOCAL;
desc->interface.daemon.itf = &daemon_itf;
desc->interface.daemon.closure = desc;
- /* init the plugin */
- desc->plugin = pluginAfbV1RegisterFct(&desc->interface);
- if (desc->plugin == NULL) {
- ERROR("plugin [%s] register function failed. continuing...", path);
+ /* for log purpose, a fake binding is needed here */
+ desc->binding = &fake_binding;
+ fake_binding.type = AFB_BINDING_VERSION_1;
+ fake_binding.v1.info = path;
+ fake_binding.v1.prefix = path;
+ fake_binding.v1.verbs = &fake_verb;
+ fake_verb.name = NULL;
+
+ /* 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->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) {
+ ERROR("binding [%s] bad prefix...", path);
goto error3;
}
- if (desc->plugin->v1.prefix == NULL || *desc->plugin->v1.prefix == 0) {
- ERROR("plugin [%s] bad 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}) < 0) {
- ERROR("plugin [%s] can't be registered...", path);
+ .call = call_cb,
+ .service_start = service_start_cb }) < 0) {
+ 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:
- dlclose(desc->handle);
-error2:
free(desc);
+error2:
+ dlclose(handle);
error:
- return -1;
+ return rc;
}
static int adddirs(char path[PATH_MAX], size_t end)
{
DIR *dir;
- struct dirent ent, *result;
+ struct dirent *dent;
size_t len;
/* 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)
path[end++] = '/';
for (;;) {
- readdir_r(dir, &ent, &result);
- if (result == NULL)
+ errno = 0;
+ dent = readdir(dir);
+ if (dent == NULL) {
+ if (errno != 0)
+ ERROR("read error while scanning directory %.*s: %m", (int)(end - 1), path);
break;
+ }
- len = strlen(ent.d_name);
+ len = strlen(dent->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", dent->d_name);
continue;
}
- memcpy(&path[end], ent.d_name, len+1);
- if (ent.d_type == DT_DIR) {
+ if (dent->d_type == DT_DIR) {
/* case of directories */
- if (ent.d_name[0] == '.') {
+ if (dent->d_name[0] == '.') {
if (len == 1)
continue;
- if (ent.d_name[1] == '.' && len == 2)
+ if (dent->d_name[1] == '.' && len == 2)
continue;
}
+ memcpy(&path[end], dent->d_name, len+1);
adddirs(path, end+len);;
- } else if (ent.d_type == DT_REG) {
+ } else if (dent->d_type == DT_REG) {
/* case of files */
- if (!strstr(ent.d_name, ".so"))
+ if (memcmp(&dent->d_name[len - 3], ".so", 4))
continue;
- afb_api_so_add_plugin(path);
+ memcpy(&path[end], dent->d_name, len+1);
+ if (afb_api_so_add_binding(path) < 0)
+ return -1;
}
}
closedir(dir);
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;
}
p = strsep(&ps, sep);
if (!p)
return 0;
- afb_api_so_add_path(p);
- };
+ if (afb_api_so_add_path(p) < 0)
+ return -1;
+ }
}
Code Review / src / app-framework-binder.git / blobdiff