X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fafb-api-so.c;h=74f94f36a18f319e598d143c2b407a00fb37e64c;hb=a758d774aa5dacc07d2840f1b7ccef793863389f;hp=32d097fae9fc6f4523db269d6d5b43d34679e6b0;hpb=83ce3b29a598141f8f28afde655beb07ec78c312;p=src%2Fapp-framework-binder.git diff --git a/src/afb-api-so.c b/src/afb-api-so.c index 32d097fa..74f94f36 100644 --- a/src/afb-api-so.c +++ b/src/afb-api-so.c @@ -1,293 +1,401 @@ /* - * Copyright (C) 2016 "IoT.bzh" - * Author "Fulup Ar Foll" + * Copyright (C) 2016, 2017 "IoT.bzh" * Author José Bollo * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * http://www.apache.org/licenses/LICENSE-2.0 * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - * - * Contain all generic part to handle REST/API - * - * https://www.gnu.org/software/libmicrohttpd/tutorial.html [search 'largepost.c'] + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ #define _GNU_SOURCE +#define NO_BINDING_VERBOSE_MACRO #include #include #include #include +#include #include #include #include #include #include -#include -#include -#include -#include -#include "afb-plugin.h" -#include "afb-req-itf.h" -#include "afb-poll-itf.h" +#include +#include +#include -#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" -#include "utils-upoll.h" +/* + * Description of a binding + */ struct api_so_desc { - struct AFB_plugin *plugin; /* descriptor */ - void *handle; /* context of dlopen */ - struct AFB_interface interface; + 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 int api_timeout = 15; +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 const char plugin_register_function[] = "pluginRegister"; +static int api_timeout = 15; -static const struct afb_poll_itf upoll_itf = { - .on_readable = (void*)upoll_on_readable, - .on_writable = (void*)upoll_on_writable, - .on_hangup = (void*)upoll_on_hangup, - .close = (void*)upoll_close +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_poll itf_poll_open(int fd, void *closure) +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) { - struct afb_poll result; - result.data = upoll_open(fd, closure); - result.itf = result.data ? &upoll_itf : NULL; - return result; + 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); } -static void free_context(struct api_so_desc *desc, void *context) +static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args) { - void (*cb)(void*); + char *p; + struct api_so_desc *desc = closure; - cb = desc->plugin->freeCtxCB; - if (cb) - cb(context); - else - free(context); + 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 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); +} -// Check of apiurl is declare in this plugin and call it -extern __thread sigjmp_buf *error_handler; -static void trapping_call(struct afb_req req, void(*cb)(struct afb_req)) +static int call_check(struct afb_req req, struct afb_context *context, const struct afb_verb_desc_v1 *verb) { - volatile int signum, timerset; - timer_t timerid; - sigjmp_buf jmpbuf, *older; - struct sigevent sevp; - struct itimerspec its; - - // save context before calling the API - timerset = 0; - older = error_handler; - signum = setjmp(jmpbuf); - if (signum != 0) { - afb_req_fail_f(req, "aborted", "signal %d caught", signum); + 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; + } } - 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); + + 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; + } + } - cb(req); + 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; + } } - if (timerset) - timer_delete(timerid); - error_handler = older; + return 1; } -static void call_check(struct afb_req req, const struct AFB_restapi *verb) +static void call_cb(void *closure, struct afb_req req, struct afb_context *context, const char *strverb, size_t lenverb) { - switch(verb->session) { - case AFB_SESSION_CREATE: - if (!afb_req_session_create(req)) - return; - break; - case AFB_SESSION_RENEW: - if (!afb_req_session_check(req, 1)) - return; - break; - case AFB_SESSION_CLOSE: - case AFB_SESSION_CHECK: - if (!afb_req_session_check(req, 0)) - return; - break; - case AFB_SESSION_NONE: - default: - break; + const struct afb_verb_desc_v1 *verb; + struct api_so_desc *desc = closure; + + verb = desc->binding->v1.verbs; + while (verb->name && (strncasecmp(verb->name, strverb, lenverb) || verb->name[lenverb])) + verb++; + if (!verb->name) + afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, strverb, desc->binding->v1.prefix); + else if (call_check(req, context, verb)) { + if (0) + /* not threaded */ + afb_sig_req_timeout(req, verb->callback, api_timeout); + else + /* threaded */ + afb_thread_call(req, verb->callback, api_timeout, desc); } - trapping_call(req, verb->callback); - - if (verb->session == AFB_SESSION_CLOSE) - afb_req_session_close(req); } -static void call(struct api_so_desc *desc, struct afb_req req, const char *verb, size_t lenverb) +static int service_start_cb(void *closure, int share_session, int onneed) { - const struct AFB_restapi *v; + int (*init)(struct afb_service service); + void (*onevent)(const char *event, struct json_object *object); - v = desc->plugin->apis; - while (v->name && (strncasecmp(v->name, verb, lenverb) || v->name[lenverb])) - v++; - if (v->name) - call_check(req, v); - else - afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->plugin->prefix); -} + 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 *(*pluginRegisterFct) (const struct AFB_interface *interface); + api_timeout = to; +} - desc = calloc(1, sizeof *desc); - if (desc == NULL) { - fprintf(stderr, "[%s] out of memory\n", path); +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) { - fprintf(stderr, "[%s] not loadable, continuing...\n", 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 */ - pluginRegisterFct = dlsym(desc->handle, plugin_register_function); - if (!pluginRegisterFct) { - fprintf(stderr, "[%s] not an AFB plugin, continuing...\n", path); - goto error3; + /* allocates the description */ + desc = calloc(1, sizeof *desc); + if (desc == NULL) { + ERROR("out of memory"); + goto error2; } - if (verbosity) - fprintf(stderr, "[%s] is a valid AFB plugin\n", path); + desc->handle = handle; /* init the interface */ - desc->interface.verbosity = 0; + desc->interface.verbosity = verbosity; desc->interface.mode = AFB_MODE_LOCAL; - desc->interface.poll_open = itf_poll_open; - - /* init the plugin */ - desc->plugin = pluginRegisterFct(&desc->interface); - if (desc->plugin == NULL) { - fprintf(stderr, "ERROR: plugin [%s] register function failed. continuing...\n", path); + 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; } /* check the returned structure */ - if (desc->plugin->type != AFB_PLUGIN_JSON) { - fprintf(stderr, "ERROR: plugin [%s] invalid type %d...\n", 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->prefix == NULL || *desc->plugin->prefix == 0) { - fprintf(stderr, "ERROR: plugin [%s] bad prefix...\n", path); + if (desc->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) { + ERROR("binding [%s] bad prefix...", path); goto error3; } - if (desc->plugin->info == NULL || *desc->plugin->info == 0) { - fprintf(stderr, "ERROR: plugin [%s] bad description...\n", path); + if (!afb_apis_is_valid_api_name(desc->binding->v1.prefix)) { + ERROR("binding [%s] invalid prefix...", path); goto error3; } - if (desc->plugin->apis == NULL) { - fprintf(stderr, "ERROR: plugin [%s] no APIs...\n", path); + if (desc->binding->v1.info == NULL || *desc->binding->v1.info == 0) { + ERROR("binding [%s] bad description...", path); + goto error3; + } + if (desc->binding->v1.verbs == NULL) { + ERROR("binding [%s] no APIs...", path); goto error3; } - /* records the plugin */ - if (afb_apis_add(desc->plugin->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, - .free_context = (void*)free_context}) < 0) { - fprintf(stderr, "ERROR: plugin [%s] can't be registered...\n", path); + .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; 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) { - fprintf(stderr, "ERROR in scanning plugin directory %s, %m\n", path); + ERROR("can't scan binding directory %s, %m", path); return -1; } - if (verbosity) - fprintf(stderr, "Scanning dir=[%s] for plugins\n", 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) { - fprintf(stderr, "path too long for %s\n", 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); @@ -301,7 +409,7 @@ int afb_api_so_add_directory(const char *path) length = strlen(path); if (length >= sizeof(buffer)) { - fprintf(stderr, "path too long %lu [%.99s...]\n", (unsigned long)length, path); + ERROR("path too long %lu [%.99s...]", (unsigned long)length, path); return -1; } @@ -316,11 +424,13 @@ int afb_api_so_add_path(const char *path) rc = stat(path, &st); if (rc < 0) - fprintf(stderr, "Invalid plugin path [%s]: %m\n", 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_binding(path); else - rc = afb_api_so_add_plugin(path); + INFO("not a binding [%s], skipped", path); return rc; } @@ -334,27 +444,8 @@ int afb_api_so_add_pathset(const char *pathset) p = strsep(&ps, sep); if (!p) return 0; - afb_api_so_add_path(p); - }; + if (afb_api_so_add_path(p) < 0) + return -1; + } } - - - - - - - - - - - - - - - - - - - -