/*
* Copyright (C) 2016 "IoT.bzh"
- * Author "Fulup Ar Foll"
* Author José Bollo <jose.bollo@iot.bzh>
*
- * 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 <http://www.gnu.org/licenses/>.
- *
- * 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 <stdio.h>
#include <assert.h>
#include <limits.h>
#include <sys/types.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-poll-itf.h"
+#include <afb/afb-binding.h>
+#include <afb/afb-req-itf.h>
+#include <afb/afb-event-itf.h>
#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-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;
+struct monitoring {
+ struct afb_req req;
+ void (*action)(struct afb_req);
+};
+
+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(struct api_so_desc *desc, const char *name);
+static int afb_api_so_event_broadcast(struct api_so_desc *desc, const char *name, struct json_object *object);
+static void afb_api_so_vverbose(struct api_so_desc *desc, int level, const char *file, int line, const char *fmt, va_list args);
+
+static const struct afb_daemon_itf daemon_itf = {
+ .event_broadcast = (void*)afb_api_so_event_broadcast,
+ .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,
+ .vverbose = (void*)afb_api_so_vverbose,
+ .event_make = (void*)afb_api_so_event_make
};
-static struct afb_poll itf_poll_open(int fd, void *closure)
+static struct afb_event afb_api_so_event_make(struct api_so_desc *desc, const char *name)
{
- struct afb_poll result;
- result.data = upoll_open(fd, closure);
- result.itf = result.data ? &upoll_itf : NULL;
- return result;
+ size_t length;
+ char *event;
+
+ /* 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 void free_context(struct api_so_desc *desc, void *context)
+static int afb_api_so_event_broadcast(struct api_so_desc *desc, const char *name, struct json_object *object)
{
- void (*cb)(void*);
+ size_t length;
+ char *event;
- cb = desc->plugin->freeCtxCB;
- if (cb)
- cb(context);
- else
- free(context);
-}
+ /* 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);
+}
-// 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 void afb_api_so_vverbose(struct api_so_desc *desc, int level, const char *file, int line, const char *fmt, va_list args)
{
- 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);
- }
- 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);
- }
+ char *p;
- cb(req);
+ 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);
}
- if (timerset)
- timer_delete(timerid);
- error_handler = older;
}
-static void call_check(struct afb_req req, const struct AFB_restapi *verb)
+static void monitored_call(int signum, struct monitoring *data)
{
- switch(verb->session) {
- case AFB_SESSION_CREATE:
- if (!afb_req_session_create(req))
+ 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;
- break;
- case AFB_SESSION_RENEW:
- if (!afb_req_session_check(req, 1))
+ }
+ 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;
- break;
- case AFB_SESSION_CLOSE:
- case AFB_SESSION_CHECK:
- if (!afb_req_session_check(req, 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;
- break;
- case AFB_SESSION_NONE:
- default:
- break;
+ }
}
- trapping_call(req, verb->callback);
- if (verb->session == AFB_SESSION_CLOSE)
- afb_req_session_close(req);
+ 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, const char *verb, size_t lenverb)
+static void call(struct api_so_desc *desc, struct afb_req req, struct afb_context *context, const char *verb, size_t lenverb)
{
- const struct AFB_restapi *v;
+ const struct afb_verb_desc_v1 *v;
- v = desc->plugin->apis;
+ v = desc->binding->v1.verbs;
while (v->name && (strncasecmp(v->name, verb, lenverb) || v->name[lenverb]))
v++;
if (v->name)
- call_check(req, v);
+ 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);
+ afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->binding->v1.prefix);
}
+static int service_start(struct api_so_desc *desc, int share_session, int onneed)
+{
+ int (*init)(struct afb_service service);
+ void (*onevent)(const char *event, struct json_object *object);
+
+ /* 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", path);
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->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) {
+ ERROR("binding [%s] bad prefix...", path);
goto error3;
}
- if (desc->plugin->prefix == NULL || *desc->plugin->prefix == 0) {
- fprintf(stderr, "ERROR: plugin [%s] bad prefix...\n", path);
+ if (!afb_apis_is_valid_api_name(desc->binding->v1.prefix)) {
+ ERROR("binding [%s] invalid prefix...", path);
goto error3;
}
- if (desc->plugin->info == NULL || *desc->plugin->info == 0) {
- fprintf(stderr, "ERROR: plugin [%s] bad description...\n", path);
+ if (desc->binding->v1.info == NULL || *desc->binding->v1.info == 0) {
+ ERROR("binding [%s] bad description...", path);
goto error3;
}
- if (desc->plugin->apis == NULL) {
- fprintf(stderr, "ERROR: plugin [%s] no APIs...\n", path);
+ 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);
+ .service_start = (void*)service_start }) < 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)
/* 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)
len = strlen(ent.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", ent.d_name);
continue;
}
memcpy(&path[end], ent.d_name, len+1);
/* case of files */
if (!strstr(ent.d_name, ".so"))
continue;
- afb_api_so_add_plugin(path);
+ if (afb_api_so_add_binding(path) < 0)
+ return -1;
}
}
closedir(dir);
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;
}
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;
}
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