/*
- * Copyright (C) 2016 "IoT.bzh"
+ * Copyright (C) 2015-2020 "IoT.bzh"
* Author José Bollo <jose.bollo@iot.bzh>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* limitations under the License.
*/
+#if WITH_DYNAMIC_BINDING
+
#define _GNU_SOURCE
#include <stdio.h>
-#include <assert.h>
+#include <dlfcn.h>
#include <string.h>
#include <dirent.h>
-#include <dlfcn.h>
-#include <unistd.h>
-#include <limits.h>
-#include <sys/types.h>
+#include <errno.h>
#include <sys/stat.h>
-#include <signal.h>
-#include <time.h>
-#include <sys/syscall.h>
-#include <setjmp.h>
-
-#include "afb-plugin.h"
-#include "afb-req-itf.h"
-#include "afb-evmgr-itf.h"
-
-#include "session.h"
-#include "afb-common.h"
-#include "afb-context.h"
-#include "afb-apis.h"
+
#include "afb-api-so.h"
+#include "afb-api-so-v3.h"
#include "verbose.h"
+#include "sig-monitor.h"
-extern __thread sigjmp_buf *error_handler;
-
-struct api_so_desc {
- struct AFB_plugin *plugin; /* descriptor */
- size_t apilength;
- void *handle; /* context of dlopen */
- struct AFB_interface interface; /* interface */
-};
-
-static int api_timeout = 15;
-
-static const char plugin_register_function[] = "pluginRegister";
-
-static void afb_api_so_evmgr_push(struct api_so_desc *desc, const char *name, struct json_object *object)
-{
- size_t length;
- char *event;
-
- assert(desc->plugin != NULL);
- length = strlen(name);
- event = alloca(length + 2 + desc->apilength);
- memcpy(event, desc->plugin->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
-};
+#if WITH_LEGACY_BINDING_V1
+# include "afb-api-so-v1.h"
+#endif
+#if WITH_LEGACY_BINDING_VDYN
+# include "afb-api-so-vdyn.h"
+#endif
+#if WITH_LEGACY_BINDING_V2
+# include "afb-api-so-v2.h"
+#endif
-static struct afb_evmgr afb_api_so_get_evmgr(struct api_so_desc *desc)
+struct safe_dlopen
{
- return (struct afb_evmgr){ .itf = &evmgr_itf, .closure = desc };
-}
-
-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
+ const char *path;
+ void *handle;
+ int flags;
};
-
-static void trapping_call(struct afb_req req, void(*cb)(struct afb_req))
+static void safe_dlopen_cb(int sig, void *closure)
{
- volatile int signum, timerset;
- timer_t timerid;
- sigjmp_buf jmpbuf, *older;
- struct sigevent sevp;
- struct itimerspec its;
-
- timerset = 0;
- older = error_handler;
- signum = setjmp(jmpbuf);
- if (signum != 0) {
- afb_req_fail_f(req, "aborted", "signal %d caught", signum);
- }
+ struct safe_dlopen *sd = closure;
+ if (!sig)
+ sd->handle = dlopen(sd->path, sd->flags);
else {
- error_handler = &jmpbuf;
- if (api_timeout > 0) {
- timerset = 1; /* TODO: check statuses */
- sevp.sigev_notify = SIGEV_THREAD_ID;
- sevp.sigev_signo = SIGALRM;
- sevp.sigev_value.sival_ptr = NULL;
-#if defined(sigev_notify_thread_id)
- sevp.sigev_notify_thread_id = (pid_t)syscall(SYS_gettid);
-#else
- sevp._sigev_un._tid = (pid_t)syscall(SYS_gettid);
-#endif
- timer_create(CLOCK_THREAD_CPUTIME_ID, &sevp, &timerid);
- its.it_interval.tv_sec = 0;
- its.it_interval.tv_nsec = 0;
- its.it_value.tv_sec = api_timeout;
- its.it_value.tv_nsec = 0;
- timer_settime(timerid, 0, &its, NULL);
- }
-
- cb(req);
- }
- if (timerset)
- timer_delete(timerid);
- error_handler = older;
-}
-
-static void call_check(struct afb_req req, struct afb_context *context, const struct AFB_restapi *verb)
-{
- int stag = (int)(verb->session & AFB_SESSION_MASK);
-
- if (stag != AFB_SESSION_NONE) {
- if (!afb_context_check(context)) {
- afb_context_close(context);
- afb_req_fail(req, "failed", "invalid token's identity");
- return;
- }
- }
-
- if ((stag & AFB_SESSION_CREATE) != 0) {
- if (!afb_context_create(context)) {
- afb_context_close(context);
- afb_req_fail(req, "failed", "invalid creation state");
- return;
- }
+ ERROR("dlopen of %s raised signal %s", sd->path, strsignal(sig));
+ sd->handle = NULL;
}
-
- if ((stag & (AFB_SESSION_CREATE | AFB_SESSION_RENEW)) != 0)
- afb_context_refresh(context);
-
- if ((stag & AFB_SESSION_CLOSE) != 0)
- afb_context_close(context);
-
- trapping_call(req, verb->callback);
}
-static void call(struct api_so_desc *desc, struct afb_req req, struct afb_context *context, const char *verb, size_t lenverb)
+static void *safe_dlopen(const char *filename, int flags)
{
- const struct AFB_restapi *v;
-
- v = desc->plugin->apis;
- 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->prefix);
+ struct safe_dlopen sd;
+ sd.path = filename;
+ sd.flags = flags;
+ sd.handle = NULL;
+ sig_monitor(0, safe_dlopen_cb, &sd);
+ return sd.handle;
}
-int afb_api_so_add_plugin(const char *path)
+static int load_binding(const char *path, int force, struct afb_apiset *declare_set, struct afb_apiset * call_set)
{
- struct api_so_desc *desc;
- struct AFB_plugin *(*pluginRegisterFct) (const struct AFB_interface *interface);
-
- desc = calloc(1, sizeof *desc);
- if (desc == NULL) {
- ERROR("out of memory");
+ int obsolete = 0;
+ int rc;
+ void *handle;
+
+ // This is a loadable library let's check if it's a binding
+ rc = -!!force;
+ handle = safe_dlopen(path, RTLD_NOW | RTLD_LOCAL | RTLD_DEEPBIND);
+ if (handle == NULL) {
+ if (force)
+ ERROR("binding [%s] not loadable: %s", path, dlerror());
+ else
+ WARNING("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);
+ /* try the version 3 */
+ rc = afb_api_so_v3_add(path, handle, declare_set, call_set);
+ if (rc < 0) {
+ /* error when loading a valid v3 binding */
goto error2;
}
-
- /* retrieves the register function */
- pluginRegisterFct = dlsym(desc->handle, plugin_register_function);
- if (!pluginRegisterFct) {
- ERROR("plugin [%s] is not an AFB plugin", path);
- goto error3;
+ if (rc)
+ return 0; /* yes version 3 */
+
+#if WITH_LEGACY_BINDING_V2
+ /* try the version 2 */
+ rc = afb_api_so_v2_add(path, handle, declare_set, call_set);
+ if (rc < 0) {
+ /* error when loading a valid v2 binding */
+ goto error2;
}
- INFO("plugin [%s] is a valid AFB plugin", path);
-
- /* init the interface */
- desc->interface.verbosity = 0;
- desc->interface.mode = AFB_MODE_LOCAL;
- desc->interface.daemon.itf = &daemon_itf;
- desc->interface.daemon.closure = desc;
-
- /* init the plugin */
- desc->plugin = pluginRegisterFct(&desc->interface);
- if (desc->plugin == NULL) {
- ERROR("plugin [%s] register function failed. continuing...", path);
- goto error3;
+ if (rc)
+ return 0; /* yes version 2 */
+#else
+ if (dlsym(handle, "afbBindingV2")) {
+ WARNING("binding [%s]: version 2 not supported", path);
+ obsolete = 1;
}
+#endif
- /* check the returned structure */
- if (desc->plugin->type != AFB_PLUGIN_JSON) {
- ERROR("plugin [%s] invalid type %d...", path, desc->plugin->type);
- goto error3;
+#if WITH_LEGACY_BINDING_VDYN
+ /* try the version dyn */
+ rc = afb_api_so_vdyn_add(path, handle, declare_set, call_set);
+ if (rc < 0) {
+ /* error when loading a valid dyn binding */
+ goto error2;
}
- if (desc->plugin->prefix == NULL || *desc->plugin->prefix == 0) {
- ERROR("plugin [%s] bad prefix...", path);
- goto error3;
+ if (rc)
+ return 0; /* yes version dyn */
+#else
+ if (dlsym(handle, "afbBindingVdyn")) {
+ WARNING("binding [%s]: version DYN not supported", path);
+ obsolete = 1;
}
- if (desc->plugin->info == NULL || *desc->plugin->info == 0) {
- ERROR("plugin [%s] bad description...", path);
- goto error3;
+#endif
+
+#if WITH_LEGACY_BINDING_V1
+ /* try the version 1 */
+ rc = afb_api_so_v1_add(path, handle, declare_set, call_set);
+ if (rc < 0) {
+ /* error when loading a valid v1 binding */
+ goto error2;
}
- if (desc->plugin->apis == NULL) {
- ERROR("plugin [%s] no APIs...", path);
- goto error3;
+ if (rc)
+ return 0; /* yes version 1 */
+#else
+ if (dlsym(handle, "afbBindingV1Register")) {
+ WARNING("binding [%s]: version 1 not supported", path);
+ obsolete = 1;
}
+#endif
- /* records the plugin */
- desc->apilength = strlen(desc->plugin->prefix);
- if (afb_apis_add(desc->plugin->prefix, (struct afb_api){
- .closure = desc,
- .call = (void*)call}) < 0) {
- ERROR("plugin [%s] can't be registered...", path);
- goto error3;
- }
- NOTICE("plugin %s loaded with API prefix %s", path, desc->plugin->prefix);
- return 0;
+ /* not a valid binding */
+ _VERBOSE_(force ? Log_Level_Error : Log_Level_Info, "binding [%s] %s",
+ path, obsolete ? "is obsolete" : "isn't an AFB binding");
-error3:
- dlclose(desc->handle);
error2:
- free(desc);
+ dlclose(handle);
error:
- return -1;
+ return rc;
}
-static int adddirs(char path[PATH_MAX], size_t end)
+
+int afb_api_so_add_binding(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set)
+{
+ return load_binding(path, 1, declare_set, call_set);
+}
+
+static int adddirs(char path[PATH_MAX], size_t end, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
{
DIR *dir;
- struct dirent ent, *result;
+ struct dirent *dent;
+ struct stat st;
size_t len;
+ int rc = 0;
/* 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);
+ /* get the name and inspect dereferenced link instead of the directory entry */
+ 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%s", (int)end, path, dent->d_name);
+ continue;
+ }
+ memcpy(&path[end], dent->d_name, len+1);
+ rc = stat(path, &st);
+ if (rc < 0) {
+ ERROR("getting status of %s failed: %m", path);
continue;
}
- memcpy(&path[end], ent.d_name, len+1);
- if (ent.d_type == DT_DIR) {
+ else if (S_ISDIR(st.st_mode)) {
/* case of directories */
- if (ent.d_name[0] == '.') {
+ if (dent->d_name[0] == '.') {
+/*
+Exclude from the search of bindings any
+directory starting with a dot (.) by default.
+
+It is possible to reactivate the prvious behaviour
+by defining the following preprocessor variables
+
+ - AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS
+
+ When this variable is defined, the directories
+ starting with a dot are searched except
+ if their name is "." or ".." or ".debug"
+
+ - AFB_API_SO_ACCEPT_DOT_DEBUG_DIRS
+
+ When this variable is defined and the variable
+ AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS is also defined
+ scans any directory not being "." or "..".
+
+The previous behaviour was like difining the 2 variables,
+meaning that only . and .. were excluded from the search.
+
+This change is intended to definitely solve the issue
+SPEC-662. Yocto installed the debugging symbols in the
+subdirectory .debug. For example the binding.so also
+had a .debug/binding.so file attached. Opening that
+debug file made dlopen crashing.
+See https://sourceware.org/bugzilla/show_bug.cgi?id=22101
+ */
+#if !defined(AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS) /* not defined by default */
+ continue; /* ignore any directory beginning with a dot */
+#else
if (len == 1)
- continue;
- if (ent.d_name[1] == '.' && len == 2)
- continue;
+ continue; /* . */
+ if (dent->d_name[1] == '.' && len == 2)
+ continue; /* .. */
+#if !defined(AFB_API_SO_ACCEPT_DOT_DEBUG_DIRS) /* not defined by default */
+ if (len == 6
+ && dent->d_name[1] == 'd'
+ && dent->d_name[2] == 'e'
+ && dent->d_name[3] == 'b'
+ && dent->d_name[4] == 'u'
+ && dent->d_name[5] == 'g')
+ continue; /* .debug */
+#endif
+#endif
}
- adddirs(path, end+len);;
- } else if (ent.d_type == DT_REG) {
+ rc = adddirs(path, end+len, declare_set, call_set, failstops);
+ } else if (S_ISREG(st.st_mode)) {
/* 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);
+ rc = load_binding(path, 0, declare_set, call_set);
+ }
+ if (rc < 0 && failstops) {
+ closedir(dir);
+ return rc;
}
}
closedir(dir);
return 0;
}
-int afb_api_so_add_directory(const char *path)
+int afb_api_so_add_directory(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
{
size_t length;
char buffer[PATH_MAX];
}
memcpy(buffer, path, length + 1);
- return adddirs(buffer, length);
+ return adddirs(buffer, length, declare_set, call_set, failstops);
}
-int afb_api_so_add_path(const char *path)
+int afb_api_so_add_path(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
{
struct stat st;
int rc;
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);
+ rc = afb_api_so_add_directory(path, declare_set, call_set, failstops);
else if (strstr(path, ".so"))
- rc = afb_api_so_add_plugin(path);
+ rc = load_binding(path, 0, declare_set, call_set);
else
- INFO("not a plugin [%s], skipped", path);
+ INFO("not a binding [%s], skipped", path);
return rc;
}
-int afb_api_so_add_pathset(const char *pathset)
+int afb_api_so_add_pathset(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
{
static char sep[] = ":";
char *ps, *p;
+ int rc;
ps = strdupa(pathset);
for (;;) {
p = strsep(&ps, sep);
if (!p)
return 0;
- afb_api_so_add_path(p);
- };
+ rc = afb_api_so_add_path(p, declare_set, call_set, failstops);
+ if (rc < 0)
+ return rc;
+ }
+}
+
+int afb_api_so_add_pathset_fails(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set)
+{
+ return afb_api_so_add_pathset(pathset, declare_set, call_set, 1);
}
+int afb_api_so_add_pathset_nofails(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set)
+{
+ return afb_api_so_add_pathset(pathset, declare_set, call_set, 0);
+}
+
+#endif
Code Review / src / app-framework-binder.git / blobdiff