add log macros for plugins
[src/app-framework-binder.git] / src / afb-api-so.c
index 38621ec..3cf1fea 100644 (file)
@@ -16,6 +16,7 @@
  */
 
 #define _GNU_SOURCE
+#define NO_PLUGIN_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-evmgr-itf.h"
+#include <afb/afb-plugin.h>
+#include <afb/afb-req-itf.h>
+#include <afb/afb-event-sender-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 "verbose.h"
 
-extern __thread sigjmp_buf *error_handler;
-
+/*
+ * Description of a plugin
+ */
 struct api_so_desc {
        struct AFB_plugin *plugin;      /* descriptor */
-       size_t apilength;
+       size_t apilength;               /* length of the API name */
        void *handle;                   /* context of dlopen */
-       struct AFB_interface interface; /* interface */
+       struct AFB_interface interface; /* interface for the plugin */
 };
 
 static int api_timeout = 15;
 
-static const char plugin_register_function[] = "pluginRegister";
+static const char plugin_register_function_v1[] = "pluginAfbV1Register";
 
-static void afb_api_so_evmgr_push(struct api_so_desc *desc, const char *name, struct json_object *object)
+static void afb_api_so_event_sender_push(struct api_so_desc *desc, const char *name, struct json_object *object)
 {
        size_t length;
        char *event;
@@ -63,75 +62,61 @@ static void afb_api_so_evmgr_push(struct api_so_desc *desc, const char *name, st
        assert(desc->plugin != NULL);
        length = strlen(name);
        event = alloca(length + 2 + desc->apilength);
-       memcpy(event, desc->plugin->prefix, 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_evmgr_itf evmgr_itf = {
-       .push = (void*)afb_api_so_evmgr_push
+static const struct afb_event_sender_itf event_sender_itf = {
+       .push = (void*)afb_api_so_event_sender_push
 };
 
-static struct afb_evmgr afb_api_so_get_evmgr(struct api_so_desc *desc)
+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 void afb_api_so_vverbose(struct api_so_desc *desc, int level, const char *file, int line, const char *fmt, va_list args)
 {
-       return (struct afb_evmgr){ .itf = &evmgr_itf, .closure = desc };
+       char *p;
+
+       if (vasprintf(&p, fmt, args) < 0)
+               vverbose(level, file, line, fmt, args);
+       else {
+               verbose(level, file, line, "%s {plugin %s}", p, desc->plugin->v1.prefix);
+               free(p);
+       }
 }
 
 static const struct afb_daemon_itf daemon_itf = {
-       .get_evmgr = (void*)afb_api_so_get_evmgr,
+       .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
+       .get_system_bus = (void*)afb_common_get_system_bus,
+       .vverbose = (void*)afb_api_so_vverbose
 };
 
+struct monitoring {
+       struct afb_req req;
+       void (*action)(struct afb_req);
+};
 
-static void trapping_call(struct afb_req req, void(*cb)(struct afb_req))
+static void monitored_call(int signum, struct monitoring *data)
 {
-       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);
-       }
-       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;
+       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_restapi *verb)
+static void call_check(struct afb_req req, struct afb_context *context, const struct AFB_verb_desc_v1 *verb)
 {
-       int stag = (int)(verb->session & AFB_SESSION_MASK);
+       struct monitoring data;
+
+       int stag = (int)verb->session;
 
-       if (stag != AFB_SESSION_NONE) {
+       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");
@@ -140,110 +125,140 @@ static void call_check(struct afb_req req, struct afb_context *context, const st
        }
 
        if ((stag & AFB_SESSION_CREATE) != 0) {
-               if (!afb_context_create(context)) {
-                       afb_context_close(context);
+               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)
+       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;
+               }
+       }
 
-       trapping_call(req, verb->callback);
+       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;
+               }
+       }
+
+       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)
 {
-       const struct AFB_restapi *v;
+       const struct AFB_verb_desc_v1 *v;
 
-       v = desc->plugin->apis;
+       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->prefix);
+               afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->plugin->v1.prefix);
 }
 
 int afb_api_so_add_plugin(const char *path)
 {
+       int rc;
+       void *handle;
        struct api_so_desc *desc;
-       struct AFB_plugin *(*pluginRegisterFct) (const struct AFB_interface *interface);
+       struct AFB_plugin *(*pluginAfbV1RegisterFct) (const struct AFB_interface *interface);
 
-       desc = calloc(1, sizeof *desc);
-       if (desc == NULL) {
-               fprintf(stderr, "[%s] out of memory\n", path);
+       // This is a loadable library let's check if it's a plugin
+       rc = 0;
+       handle = dlopen(path, RTLD_NOW | RTLD_LOCAL);
+       if (handle == NULL) {
+               ERROR("plugin [%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 */
+       pluginAfbV1RegisterFct = dlsym(handle, plugin_register_function_v1);
+       if (!pluginAfbV1RegisterFct) {
+               ERROR("plugin [%s] is not an AFB plugin", path);
                goto error2;
        }
+       INFO("plugin [%s] is a valid AFB plugin", 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.daemon.itf = &daemon_itf;
        desc->interface.daemon.closure = desc;
 
        /* init the plugin */
-       desc->plugin = pluginRegisterFct(&desc->interface);
+       desc->plugin = pluginAfbV1RegisterFct(&desc->interface);
        if (desc->plugin == NULL) {
-               fprintf(stderr, "ERROR: plugin [%s] register function failed. continuing...\n", path);
+               ERROR("plugin [%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->plugin->type != AFB_PLUGIN_VERSION_1) {
+               ERROR("plugin [%s] invalid type %d...", path, desc->plugin->type);
                goto error3;
        }
-       if (desc->plugin->prefix == NULL || *desc->plugin->prefix == 0) {
-               fprintf(stderr, "ERROR: plugin [%s] bad prefix...\n", path);
+       if (desc->plugin->v1.prefix == NULL || *desc->plugin->v1.prefix == 0) {
+               ERROR("plugin [%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->plugin->v1.prefix)) {
+               ERROR("plugin [%s] invalid prefix...", path);
                goto error3;
        }
-       if (desc->plugin->apis == NULL) {
-               fprintf(stderr, "ERROR: plugin [%s] no APIs...\n", path);
+       if (desc->plugin->v1.info == NULL || *desc->plugin->v1.info == 0) {
+               ERROR("plugin [%s] bad description...", path);
+               goto error3;
+       }
+       if (desc->plugin->v1.verbs == NULL) {
+               ERROR("plugin [%s] no APIs...", path);
                goto error3;
        }
 
        /* records the plugin */
-       desc->apilength = strlen(desc->plugin->prefix);
-       if (afb_apis_add(desc->plugin->prefix, (struct afb_api){
+       desc->apilength = strlen(desc->plugin->v1.prefix);
+       if (afb_apis_add(desc->plugin->v1.prefix, (struct afb_api){
                        .closure = desc,
                        .call = (void*)call}) < 0) {
-               fprintf(stderr, "ERROR: plugin [%s] can't be registered...\n", path);
+               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;
 
 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)
@@ -255,11 +270,10 @@ 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 plugin directory %s, %m", path);
                return -1;
        }
-       if (verbosity)
-               fprintf(stderr, "Scanning dir=[%s] for plugins\n", path);
+       INFO("Scanning dir=[%s] for plugins", path);
 
        /* scan each entry */
        if (end)
@@ -271,7 +285,7 @@ static int adddirs(char path[PATH_MAX], size_t 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 plugins for %s", ent.d_name);
                        continue;
                }
                memcpy(&path[end], ent.d_name, len+1);
@@ -288,7 +302,8 @@ static int adddirs(char path[PATH_MAX], size_t end)
                        /* case of files */
                        if (!strstr(ent.d_name, ".so"))
                                continue;
-                       afb_api_so_add_plugin(path);
+                       if (afb_api_so_add_plugin(path) < 0)
+                               return -1;
                }
        }
        closedir(dir);
@@ -302,7 +317,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;
        }
 
@@ -317,11 +332,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 plugin path [%s]: %m", path);
        else if (S_ISDIR(st.st_mode))
                rc = afb_api_so_add_directory(path);
-       else
+       else if (strstr(path, ".so"))
                rc = afb_api_so_add_plugin(path);
+       else
+               INFO("not a plugin [%s], skipped", path);
        return rc;
 }
 
@@ -335,7 +352,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;
+       }
 }