src/afb-api-so.c

   1 /*
   2  * Copyright (C) 2016 "IoT.bzh"
   3  * Author José Bollo <jose.bollo@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #define _GNU_SOURCE
  19
  20 #include <stdio.h>
  21 #include <assert.h>
  22 #include <string.h>
  23 #include <dirent.h>
  24 #include <dlfcn.h>
  25 #include <unistd.h>
  26 #include <limits.h>
  27 #include <sys/types.h>
  28 #include <sys/stat.h>
  29 #include <signal.h>
  30 #include <time.h>
  31 #include <sys/syscall.h>
  32 #include <setjmp.h>
  33
  34 #include "afb-plugin.h"
  35 #include "afb-req-itf.h"
  36 #include "afb-pollmgr-itf.h"
  37 #include "afb-evmgr-itf.h"
  38
  39 #include "session.h"
  40 #include "afb-apis.h"
  41 #include "afb-api-so.h"
  42 #include "verbose.h"
  43 #include "utils-upoll.h"
  44
  45 extern __thread sigjmp_buf *error_handler;
  46
  47 struct api_so_desc {
  48         struct AFB_plugin *plugin;      /* descriptor */
  49         void *handle;                   /* context of dlopen */
  50         struct AFB_interface interface; /* interface */
  51 };
  52
  53 static int api_timeout = 15;
  54
  55 static const char plugin_register_function[] = "pluginRegister";
  56
  57 static const struct afb_pollmgr_itf pollmgr_itf = {
  58         .wait = (void*)upoll_wait,
  59         .open = (void*)upoll_open,
  60         .on_readable = (void*)upoll_on_readable,
  61         .on_writable = (void*)upoll_on_writable,
  62         .on_hangup = (void*)upoll_on_hangup,
  63         .close = (void*)upoll_close
  64 };
  65
  66 static void afb_api_so_evmgr_push(struct api_so_desc *desc, const char *name, struct json_object *object)
  67 {
  68 }
  69
  70 static const struct afb_evmgr_itf evmgr_itf = {
  71         .push = (void*)afb_api_so_evmgr_push
  72 };
  73
  74 static struct afb_evmgr afb_api_so_get_evmgr(struct api_so_desc *desc)
  75 {
  76         return (struct afb_evmgr){ .itf = &evmgr_itf, .closure = desc };
  77 }
  78
  79 static struct afb_pollmgr afb_api_so_get_pollmgr(struct api_so_desc *desc)
  80 {
  81         return (struct afb_pollmgr){ .itf = &pollmgr_itf, .closure = NULL };
  82 }
  83
  84 static const struct afb_daemon_itf daemon_itf = {
  85         .get_evmgr = (void*)afb_api_so_get_evmgr,
  86         .get_pollmgr = (void*)afb_api_so_get_pollmgr
  87 };
  88
  89 static void free_context(struct api_so_desc *desc, void *context)
  90 {
  91         void (*cb)(void*);
  92
  93         cb = desc->plugin->freeCtxCB;
  94         if (cb)
  95                 cb(context);
  96         else
  97                 free(context);
  98 }
  99
 100 static void trapping_call(struct afb_req req, void(*cb)(struct afb_req))
 101 {
 102         volatile int signum, timerset;
 103         timer_t timerid;
 104         sigjmp_buf jmpbuf, *older;
 105         struct sigevent sevp;
 106         struct itimerspec its;
 107
 108         timerset = 0;
 109         older = error_handler;
 110         signum = setjmp(jmpbuf);
 111         if (signum != 0) {
 112                 afb_req_fail_f(req, "aborted", "signal %d caught", signum);
 113         }
 114         else {
 115                 error_handler = &jmpbuf;
 116                 if (api_timeout > 0) {
 117                         timerset = 1; /* TODO: check statuses */
 118                         sevp.sigev_notify = SIGEV_THREAD_ID;
 119                         sevp.sigev_signo = SIGALRM;
 120                         sevp.sigev_value.sival_ptr = NULL;
 121 #if defined(sigev_notify_thread_id)
 122                         sevp.sigev_notify_thread_id = (pid_t)syscall(SYS_gettid);
 123 #else
 124                         sevp._sigev_un._tid = (pid_t)syscall(SYS_gettid);
 125 #endif
 126                         timer_create(CLOCK_THREAD_CPUTIME_ID, &sevp, &timerid);
 127                         its.it_interval.tv_sec = 0;
 128                         its.it_interval.tv_nsec = 0;
 129                         its.it_value.tv_sec = api_timeout;
 130                         its.it_value.tv_nsec = 0;
 131                         timer_settime(timerid, 0, &its, NULL);
 132                 }
 133
 134                 cb(req);
 135         }
 136         if (timerset)
 137                 timer_delete(timerid);
 138         error_handler = older;
 139 }
 140
 141 static void call_check(struct afb_req req, const struct AFB_restapi *verb)
 142 {
 143         switch(verb->session) {
 144         case AFB_SESSION_CREATE:
 145                 if (!afb_req_session_create(req))
 146                         return;
 147                 break;
 148         case AFB_SESSION_RENEW:
 149                 if (!afb_req_session_check(req, 1))
 150                         return;
 151                 break;
 152         case AFB_SESSION_CLOSE:
 153         case AFB_SESSION_CHECK:
 154                 if (!afb_req_session_check(req, 0))
 155                         return;
 156                 break;
 157         case AFB_SESSION_NONE:
 158         default:
 159                 break;
 160         }
 161         trapping_call(req, verb->callback);
 162
 163         if (verb->session == AFB_SESSION_CLOSE)
 164                 afb_req_session_close(req);
 165 }
 166
 167 static void call(struct api_so_desc *desc, struct afb_req req, const char *verb, size_t lenverb)
 168 {
 169         const struct AFB_restapi *v;
 170
 171         v = desc->plugin->apis;
 172         while (v->name && (strncasecmp(v->name, verb, lenverb) || v->name[lenverb]))
 173                 v++;
 174         if (v->name)
 175                 call_check(req, v);
 176         else
 177                 afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->plugin->prefix);
 178 }
 179
 180 int afb_api_so_add_plugin(const char *path)
 181 {
 182         struct api_so_desc *desc;
 183         struct AFB_plugin *(*pluginRegisterFct) (const struct AFB_interface *interface);
 184
 185         desc = calloc(1, sizeof *desc);
 186         if (desc == NULL) {
 187                 fprintf(stderr, "[%s] out of memory\n", path);
 188                 goto error;
 189         }
 190
 191         // This is a loadable library let's check if it's a plugin
 192         desc->handle = dlopen(path, RTLD_NOW | RTLD_LOCAL);
 193         if (desc->handle == NULL) {
 194                 fprintf(stderr, "[%s] not loadable, continuing...\n", path);
 195                 goto error2;
 196         }
 197
 198         /* retrieves the register function */
 199         pluginRegisterFct = dlsym(desc->handle, plugin_register_function);
 200         if (!pluginRegisterFct) {
 201                 fprintf(stderr, "[%s] not an AFB plugin, continuing...\n", path);
 202                 goto error3;
 203         }
 204         if (verbosity)
 205                 fprintf(stderr, "[%s] is a valid AFB plugin\n", path);
 206
 207         /* init the interface */
 208         desc->interface.verbosity = 0;
 209         desc->interface.mode = AFB_MODE_LOCAL;
 210         desc->interface.daemon.itf = &daemon_itf;
 211         desc->interface.daemon.closure = desc;
 212
 213         /* init the plugin */
 214         desc->plugin = pluginRegisterFct(&desc->interface);
 215         if (desc->plugin == NULL) {
 216                 fprintf(stderr, "ERROR: plugin [%s] register function failed. continuing...\n", path);
 217                 goto error3;
 218         }
 219
 220         /* check the returned structure */
 221         if (desc->plugin->type != AFB_PLUGIN_JSON) {
 222                 fprintf(stderr, "ERROR: plugin [%s] invalid type %d...\n", path, desc->plugin->type);
 223                 goto error3;
 224         }
 225         if (desc->plugin->prefix == NULL || *desc->plugin->prefix == 0) {
 226                 fprintf(stderr, "ERROR: plugin [%s] bad prefix...\n", path);
 227                 goto error3;
 228         }
 229         if (desc->plugin->info == NULL || *desc->plugin->info == 0) {
 230                 fprintf(stderr, "ERROR: plugin [%s] bad description...\n", path);
 231                 goto error3;
 232         }
 233         if (desc->plugin->apis == NULL) {
 234                 fprintf(stderr, "ERROR: plugin [%s] no APIs...\n", path);
 235                 goto error3;
 236         }
 237
 238         /* records the plugin */
 239         if (afb_apis_add(desc->plugin->prefix, (struct afb_api){
 240                         .closure = desc,
 241                         .call = (void*)call,
 242                         .free_context = (void*)free_context}) < 0) {
 243                 fprintf(stderr, "ERROR: plugin [%s] can't be registered...\n", path);
 244                 goto error3;
 245         }
 246
 247         return 0;
 248
 249 error3:
 250         dlclose(desc->handle);
 251 error2:
 252         free(desc);
 253 error:
 254         return -1;
 255 }
 256
 257 static int adddirs(char path[PATH_MAX], size_t end)
 258 {
 259         DIR *dir;
 260         struct dirent ent, *result;
 261         size_t len;
 262
 263         /* open the DIR now */
 264         dir = opendir(path);
 265         if (dir == NULL) {
 266                 fprintf(stderr, "ERROR in scanning plugin directory %s, %m\n", path);
 267                 return -1;
 268         }
 269         if (verbosity)
 270                 fprintf(stderr, "Scanning dir=[%s] for plugins\n", path);
 271
 272         /* scan each entry */
 273         if (end)
 274                 path[end++] = '/';
 275         for (;;) {
 276                 readdir_r(dir, &ent, &result);
 277                 if (result == NULL)
 278                         break;
 279
 280                 len = strlen(ent.d_name);
 281                 if (len + end >= PATH_MAX) {
 282                         fprintf(stderr, "path too long for %s\n", ent.d_name);
 283                         continue;
 284                 }
 285                 memcpy(&path[end], ent.d_name, len+1);
 286                 if (ent.d_type == DT_DIR) {
 287                         /* case of directories */
 288                         if (ent.d_name[0] == '.') {
 289                                 if (len == 1)
 290                                         continue;
 291                                 if (ent.d_name[1] == '.' && len == 2)
 292                                         continue;
 293                         }
 294                         adddirs(path, end+len);;
 295                 } else if (ent.d_type == DT_REG) {
 296                         /* case of files */
 297                         if (!strstr(ent.d_name, ".so"))
 298                                 continue;
 299                         afb_api_so_add_plugin(path);
 300                 }
 301         }
 302         closedir(dir);
 303         return 0;
 304 }
 305
 306 int afb_api_so_add_directory(const char *path)
 307 {
 308         size_t length;
 309         char buffer[PATH_MAX];
 310
 311         length = strlen(path);
 312         if (length >= sizeof(buffer)) {
 313                 fprintf(stderr, "path too long %lu [%.99s...]\n", (unsigned long)length, path);
 314                 return -1;
 315         }
 316
 317         memcpy(buffer, path, length + 1);
 318         return adddirs(buffer, length);
 319 }
 320
 321 int afb_api_so_add_path(const char *path)
 322 {
 323         struct stat st;
 324         int rc;
 325
 326         rc = stat(path, &st);
 327         if (rc < 0)
 328                 fprintf(stderr, "Invalid plugin path [%s]: %m\n", path);
 329         else if (S_ISDIR(st.st_mode))
 330                 rc = afb_api_so_add_directory(path);
 331         else
 332                 rc = afb_api_so_add_plugin(path);
 333         return rc;
 334 }
 335
 336 int afb_api_so_add_pathset(const char *pathset)
 337 {
 338         static char sep[] = ":";
 339         char *ps, *p;
 340
 341         ps = strdupa(pathset);
 342         for (;;) {
 343                 p = strsep(&ps, sep);
 344                 if (!p)
 345                         return 0;
 346                 afb_api_so_add_path(p);
 347         };
 348 }
 349