X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fafb-api-so.c;h=4b574879d92842d0eebeeaff324c349d00bbd3dd;hb=65353dce81a629e042800bb7b86fcd869a76727e;hp=78d6d1b61b4983d85bb70250f44520e77617004b;hpb=cd438c6c7074c9c279f15dd9e5c69b90b412b8a5;p=src%2Fapp-framework-binder.git diff --git a/src/afb-api-so.c b/src/afb-api-so.c index 78d6d1b6..4b574879 100644 --- a/src/afb-api-so.c +++ b/src/afb-api-so.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016 "IoT.bzh" + * Copyright (C) 2015-2020 "IoT.bzh" * Author José Bollo * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -15,285 +15,257 @@ * limitations under the License. */ +#if WITH_DYNAMIC_BINDING + #define _GNU_SOURCE #include -#include +#include #include #include -#include -#include -#include -#include +#include #include -#include -#include -#include - -#include "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-api-so-v3.h" #include "verbose.h" - -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[] = "pluginAfbV1Register"; - -static void afb_api_so_event_sender_push(struct api_so_desc *desc, const char *name, struct json_object *object) +#include "sig-monitor.h" + +#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 + +struct safe_dlopen { - size_t length; - char *event; - - assert(desc->plugin != NULL); - length = strlen(name); - event = alloca(length + 2 + desc->apilength); - memcpy(event, desc->plugin->v1.prefix, desc->apilength); - event[desc->apilength] = '/'; - memcpy(event + desc->apilength + 1, name, length + 1); - ctxClientEventSend(NULL, event, object); -} - -static const struct afb_event_sender_itf event_sender_itf = { - .push = (void*)afb_api_so_event_sender_push -}; - -static struct afb_event_sender afb_api_so_get_event_sender(struct api_so_desc *desc) -{ - return (struct afb_event_sender){ .itf = &event_sender_itf, .closure = desc }; -} - -static const struct afb_daemon_itf daemon_itf = { - .get_event_sender = (void*)afb_api_so_get_event_sender, - .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 -}; - -struct monitoring { - struct afb_req req; - void (*action)(struct afb_req); + const char *path; + void *handle; + int flags; }; -static void monitored_call(int signum, struct monitoring *data) +static void safe_dlopen_cb(int sig, void *closure) { - if (signum != 0) - afb_req_fail_f(data->req, "aborted", "signal %s(%d) caught", strsignal(signum), signum); - else - data->action(data->req); -} - -static void call_check(struct afb_req req, struct afb_context *context, const struct AFB_verb_desc_v1 *verb) -{ - struct monitoring data; - - int stag = (int)verb->session; - - 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; - } - } - - if ((stag & AFB_SESSION_CREATE) != 0) { - if (afb_context_check_loa(context, 1)) { - afb_req_fail(req, "failed", "invalid creation state"); - return; - } - 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) { - 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; - } - } - - 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; - } + struct safe_dlopen *sd = closure; + if (!sig) + sd->handle = dlopen(sd->path, sd->flags); + else { + ERROR("dlopen of %s raised signal %s", sd->path, strsignal(sig)); + sd->handle = NULL; } - - data.req = req; - data.action = verb->callback; - afb_sig_monitor((void*)monitored_call, &data, api_timeout); } -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_verb_desc_v1 *v; - - 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); + 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) { + int obsolete = 0; int rc; void *handle; - struct api_so_desc *desc; - struct AFB_plugin *(*pluginAfbV1RegisterFct) (const struct AFB_interface *interface); - // This is a loadable library let's check if it's a plugin - rc = 0; - handle = dlopen(path, RTLD_NOW | RTLD_LOCAL); + // 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) { - ERROR("plugin [%s] not loadable", path); + if (force) + ERROR("binding [%s] not loadable: %s", path, dlerror()); + else + WARNING("binding [%s] not loadable: %s", path, dlerror()); goto error; } - /* retrieves the register function */ - pluginAfbV1RegisterFct = dlsym(handle, plugin_register_function); - if (!pluginAfbV1RegisterFct) { - ERROR("plugin [%s] is not an AFB plugin", 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; } - INFO("plugin [%s] is a valid AFB plugin", path); - rc = -1; - - /* allocates the description */ - desc = calloc(1, sizeof *desc); - if (desc == NULL) { - ERROR("out of memory"); + 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; } - desc->handle = handle; - - /* 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 = pluginAfbV1RegisterFct(&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_VERSION_1) { - ERROR("plugin [%s] invalid type %d...", path, desc->plugin->type); - goto error3; - } - if (desc->plugin->v1.prefix == NULL || *desc->plugin->v1.prefix == 0) { - ERROR("plugin [%s] bad prefix...", path); - 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 (!afb_apis_is_valid_api_name(desc->plugin->v1.prefix)) { - ERROR("plugin [%s] invalid 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->v1.info == NULL || *desc->plugin->v1.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->v1.verbs == 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->v1.prefix); - if (afb_apis_add(desc->plugin->v1.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->v1.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: - free(desc); error2: dlclose(handle); error: 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; - if (afb_api_so_add_plugin(path) < 0) - return -1; + 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]; @@ -305,38 +277,51 @@ int afb_api_so_add_directory(const char *path) } 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; - if (afb_api_so_add_path(p) < 0) - return -1; + 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