X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fafb-api-so.c;h=4b574879d92842d0eebeeaff324c349d00bbd3dd;hb=65353dce81a629e042800bb7b86fcd869a76727e;hp=daa353347cb5ed8f0c5cde939e9097ec68ecb3a1;hpb=44f21bd2a3b50f92669223cdafe79993654c1e19;p=src%2Fapp-framework-binder.git diff --git a/src/afb-api-so.c b/src/afb-api-so.c index daa35334..4b574879 100644 --- a/src/afb-api-so.c +++ b/src/afb-api-so.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016, 2017 "IoT.bzh" + * Copyright (C) 2015-2020 "IoT.bzh" * Author José Bollo * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -15,338 +15,157 @@ * limitations under the License. */ +#if WITH_DYNAMIC_BINDING + #define _GNU_SOURCE -#define NO_BINDING_VERBOSE_MACRO #include -#include +#include #include #include #include -#include -#include -#include -#include #include -#include -#include -#include - -#include "afb-session.h" -#include "afb-common.h" -#include "afb-context.h" -#include "afb-apis.h" #include "afb-api-so.h" -#include "afb-thread.h" -#include "afb-evt.h" -#include "afb-svc.h" +#include "afb-api-so-v3.h" #include "verbose.h" - -/* - * Description of a binding - */ -struct api_so_desc { - 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_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 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 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; - - /* 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); - - /* crate the event */ - return afb_evt_create_event(event); -} - -static int afb_api_so_event_broadcast_cb(void *closure, 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; - struct api_so_desc *desc = closure; - - /* 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); - - return afb_evt_broadcast(event, object); -} + const char *path; + void *handle; + int flags; +}; -static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args) +static void safe_dlopen_cb(int sig, void *closure) { - char *p; - struct api_so_desc *desc = closure; - - if (vasprintf(&p, fmt, args) < 0) - vverbose(level, file, line, fmt, args); + struct safe_dlopen *sd = closure; + if (!sig) + sd->handle = dlopen(sd->path, sd->flags); 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 int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale) -{ - return afb_common_rootdir_open_locale(filename, flags, locale); -} - -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_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 0; - } - } - - if ((stag & AFB_SESSION_CREATE) != 0) { - if (afb_context_check_loa(context, 1)) { - afb_req_fail(req, "failed", "invalid creation state"); - 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) { - 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; - } - } - - 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_cb(void *closure, struct afb_req req, struct afb_context *context, const char *strverb) -{ - 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); - } -} - -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; + ERROR("dlopen of %s raised signal %s", sd->path, strsignal(sig)); + sd->handle = NULL; } - - /* 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; } -void afb_api_so_set_timeout(int to) +static void *safe_dlopen(const char *filename, int flags) { - api_timeout = to; + 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_binding(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_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); + rc = -!!force; + handle = safe_dlopen(path, RTLD_NOW | RTLD_LOCAL | RTLD_DEEPBIND); if (handle == NULL) { - ERROR("binding [%s] not loadable: %s", path, dlerror()); + 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 */ - register_function = dlsym(handle, binding_register_function_v1); - if (!register_function) { - ERROR("binding [%s] is not an AFB binding", 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("binding [%s] is a valid AFB binding", 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 = verbosity; - desc->interface.mode = AFB_MODE_LOCAL; - desc->interface.daemon.itf = &daemon_itf; - desc->interface.daemon.closure = desc; - - /* 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; + 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->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 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->binding->v1.prefix)) { - ERROR("binding [%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->binding->v1.info == NULL || *desc->binding->v1.info == 0) { - ERROR("binding [%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->binding->v1.verbs == NULL) { - ERROR("binding [%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 binding */ - desc->apilength = strlen(desc->binding->v1.prefix); - if (afb_apis_add(desc->binding->v1.prefix, (struct afb_api){ - .closure = desc, - .call = call_cb, - .service_start = service_start_cb }) < 0) { - ERROR("binding [%s] can't be registered...", path); - goto error3; - } - NOTICE("binding %s loaded with API prefix %s", path, desc->binding->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 *dent; + struct stat st; size_t len; + int rc = 0; /* open the DIR now */ dir = opendir(path); @@ -368,35 +187,85 @@ static int adddirs(char path[PATH_MAX], size_t end) break; } + /* 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 bindings for %s", dent->d_name); + ERROR("path too long while scanning bindings for %.*s%s", (int)end, path, dent->d_name); continue; } - if (dent->d_type == DT_DIR) { + memcpy(&path[end], dent->d_name, len+1); + rc = stat(path, &st); + if (rc < 0) { + ERROR("getting status of %s failed: %m", path); + continue; + } + else if (S_ISDIR(st.st_mode)) { /* case of directories */ 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; + continue; /* . */ if (dent->d_name[1] == '.' && len == 2) - continue; + 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 } - memcpy(&path[end], dent->d_name, len+1); - adddirs(path, end+len);; - } else if (dent->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 (memcmp(&dent->d_name[len - 3], ".so", 4)) continue; - memcpy(&path[end], dent->d_name, len+1); - if (afb_api_so_add_binding(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]; @@ -408,10 +277,10 @@ 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; @@ -420,26 +289,39 @@ int afb_api_so_add_path(const char *path) if (rc < 0) 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_binding(path); + rc = load_binding(path, 0, declare_set, call_set); else 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