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-evmgr-itf.h"
  37
  38 #include "session.h"
  39 #include "afb-common.h"
  40 #include "afb-apis.h"
  41 #include "afb-api-so.h"
  42 #include "verbose.h"
  43
  44 extern __thread sigjmp_buf *error_handler;
  45
  46 struct api_so_desc {
  47         struct AFB_plugin *plugin;      /* descriptor */
  48         size_t apilength;
  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 void afb_api_so_evmgr_push(struct api_so_desc *desc, const char *name, struct json_object *object)
  58 {
  59         size_t length;
  60         char *event;
  61
  62         assert(desc->plugin != NULL);
  63         length = strlen(name);
  64         event = alloca(length + 2 + desc->apilength);
  65         memcpy(event, desc->plugin->prefix, desc->apilength);
  66         event[desc->apilength] = '/';
  67         memcpy(event + desc->apilength + 1, name, length + 1);
  68         ctxClientEventSend(NULL, event, object);
  69 }
  70
  71 static const struct afb_evmgr_itf evmgr_itf = {
  72         .push = (void*)afb_api_so_evmgr_push
  73 };
  74
  75 static struct afb_evmgr afb_api_so_get_evmgr(struct api_so_desc *desc)
  76 {
  77         return (struct afb_evmgr){ .itf = &evmgr_itf, .closure = desc };
  78 }
  79
  80 static const struct afb_daemon_itf daemon_itf = {
  81         .get_evmgr = (void*)afb_api_so_get_evmgr,
  82         .get_event_loop = (void*)afb_common_get_event_loop,
  83         .get_user_bus = (void*)afb_common_get_user_bus,
  84         .get_system_bus = (void*)afb_common_get_system_bus
  85 };
  86
  87
  88 static void trapping_call(struct afb_req req, void(*cb)(struct afb_req))
  89 {
  90         volatile int signum, timerset;
  91         timer_t timerid;
  92         sigjmp_buf jmpbuf, *older;
  93         struct sigevent sevp;
  94         struct itimerspec its;
  95
  96         timerset = 0;
  97         older = error_handler;
  98         signum = setjmp(jmpbuf);
  99         if (signum != 0) {
 100                 afb_req_fail_f(req, "aborted", "signal %d caught", signum);
 101         }
 102         else {
 103                 error_handler = &jmpbuf;
 104                 if (api_timeout > 0) {
 105                         timerset = 1; /* TODO: check statuses */
 106                         sevp.sigev_notify = SIGEV_THREAD_ID;
 107                         sevp.sigev_signo = SIGALRM;
 108                         sevp.sigev_value.sival_ptr = NULL;
 109 #if defined(sigev_notify_thread_id)
 110                         sevp.sigev_notify_thread_id = (pid_t)syscall(SYS_gettid);
 111 #else
 112                         sevp._sigev_un._tid = (pid_t)syscall(SYS_gettid);
 113 #endif
 114                         timer_create(CLOCK_THREAD_CPUTIME_ID, &sevp, &timerid);
 115                         its.it_interval.tv_sec = 0;
 116                         its.it_interval.tv_nsec = 0;
 117                         its.it_value.tv_sec = api_timeout;
 118                         its.it_value.tv_nsec = 0;
 119                         timer_settime(timerid, 0, &its, NULL);
 120                 }
 121
 122                 cb(req);
 123         }
 124         if (timerset)
 125                 timer_delete(timerid);
 126         error_handler = older;
 127 }
 128
 129 static void call_check(struct afb_req req, const struct AFB_restapi *verb)
 130 {
 131         switch(verb->session) {
 132         case AFB_SESSION_CREATE:
 133                 if (!afb_req_session_create(req))
 134                         return;
 135                 break;
 136         case AFB_SESSION_RENEW:
 137                 if (!afb_req_session_check(req, 1))
 138                         return;
 139                 break;
 140         case AFB_SESSION_CLOSE:
 141         case AFB_SESSION_CHECK:
 142                 if (!afb_req_session_check(req, 0))
 143                         return;
 144                 break;
 145         case AFB_SESSION_NONE:
 146         default:
 147                 break;
 148         }
 149         trapping_call(req, verb->callback);
 150         if (verb->session == AFB_SESSION_CLOSE)
 151                 afb_req_session_close(req);
 152 }
 153
 154 static void call(struct api_so_desc *desc, struct afb_req req, const char *verb, size_t lenverb)
 155 {
 156         const struct AFB_restapi *v;
 157
 158         v = desc->plugin->apis;
 159         while (v->name && (strncasecmp(v->name, verb, lenverb) || v->name[lenverb]))
 160                 v++;
 161         if (v->name)
 162                 call_check(req, v);
 163         else
 164                 afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->plugin->prefix);
 165 }
 166
 167 int afb_api_so_add_plugin(const char *path)
 168 {
 169         struct api_so_desc *desc;
 170         struct AFB_plugin *(*pluginRegisterFct) (const struct AFB_interface *interface);
 171
 172         desc = calloc(1, sizeof *desc);
 173         if (desc == NULL) {
 174                 fprintf(stderr, "[%s] out of memory\n", path);
 175                 goto error;
 176         }
 177
 178         // This is a loadable library let's check if it's a plugin
 179         desc->handle = dlopen(path, RTLD_NOW | RTLD_LOCAL);
 180         if (desc->handle == NULL) {
 181                 fprintf(stderr, "[%s] not loadable, continuing...\n", path);
 182                 goto error2;
 183         }
 184
 185         /* retrieves the register function */
 186         pluginRegisterFct = dlsym(desc->handle, plugin_register_function);
 187         if (!pluginRegisterFct) {
 188                 fprintf(stderr, "[%s] not an AFB plugin, continuing...\n", path);
 189                 goto error3;
 190         }
 191         if (verbosity)
 192                 fprintf(stderr, "[%s] is a valid AFB plugin\n", path);
 193
 194         /* init the interface */
 195         desc->interface.verbosity = 0;
 196         desc->interface.mode = AFB_MODE_LOCAL;
 197         desc->interface.daemon.itf = &daemon_itf;
 198         desc->interface.daemon.closure = desc;
 199
 200         /* init the plugin */
 201         desc->plugin = pluginRegisterFct(&desc->interface);
 202         if (desc->plugin == NULL) {
 203                 fprintf(stderr, "ERROR: plugin [%s] register function failed. continuing...\n", path);
 204                 goto error3;
 205         }
 206
 207         /* check the returned structure */
 208         if (desc->plugin->type != AFB_PLUGIN_JSON) {
 209                 fprintf(stderr, "ERROR: plugin [%s] invalid type %d...\n", path, desc->plugin->type);
 210                 goto error3;
 211         }
 212         if (desc->plugin->prefix == NULL || *desc->plugin->prefix == 0) {
 213                 fprintf(stderr, "ERROR: plugin [%s] bad prefix...\n", path);
 214                 goto error3;
 215         }
 216         if (desc->plugin->info == NULL || *desc->plugin->info == 0) {
 217                 fprintf(stderr, "ERROR: plugin [%s] bad description...\n", path);
 218                 goto error3;
 219         }
 220         if (desc->plugin->apis == NULL) {
 221                 fprintf(stderr, "ERROR: plugin [%s] no APIs...\n", path);
 222                 goto error3;
 223         }
 224
 225         /* records the plugin */
 226         desc->apilength = strlen(desc->plugin->prefix);
 227         if (afb_apis_add(desc->plugin->prefix, (struct afb_api){
 228                         .closure = desc,
 229                         .call = (void*)call}) < 0) {
 230                 fprintf(stderr, "ERROR: plugin [%s] can't be registered...\n", path);
 231                 goto error3;
 232         }
 233
 234         return 0;
 235
 236 error3:
 237         dlclose(desc->handle);
 238 error2:
 239         free(desc);
 240 error:
 241         return -1;
 242 }
 243
 244 static int adddirs(char path[PATH_MAX], size_t end)
 245 {
 246         DIR *dir;
 247         struct dirent ent, *result;
 248         size_t len;
 249
 250         /* open the DIR now */
 251         dir = opendir(path);
 252         if (dir == NULL) {
 253                 fprintf(stderr, "ERROR in scanning plugin directory %s, %m\n", path);
 254                 return -1;
 255         }
 256         if (verbosity)
 257                 fprintf(stderr, "Scanning dir=[%s] for plugins\n", path);
 258
 259         /* scan each entry */
 260         if (end)
 261                 path[end++] = '/';
 262         for (;;) {
 263                 readdir_r(dir, &ent, &result);
 264                 if (result == NULL)
 265                         break;
 266
 267                 len = strlen(ent.d_name);
 268                 if (len + end >= PATH_MAX) {
 269                         fprintf(stderr, "path too long for %s\n", ent.d_name);
 270                         continue;
 271                 }
 272                 memcpy(&path[end], ent.d_name, len+1);
 273                 if (ent.d_type == DT_DIR) {
 274                         /* case of directories */
 275                         if (ent.d_name[0] == '.') {
 276                                 if (len == 1)
 277                                         continue;
 278                                 if (ent.d_name[1] == '.' && len == 2)
 279                                         continue;
 280                         }
 281                         adddirs(path, end+len);;
 282                 } else if (ent.d_type == DT_REG) {
 283                         /* case of files */
 284                         if (!strstr(ent.d_name, ".so"))
 285                                 continue;
 286                         afb_api_so_add_plugin(path);
 287                 }
 288         }
 289         closedir(dir);
 290         return 0;
 291 }
 292
 293 int afb_api_so_add_directory(const char *path)
 294 {
 295         size_t length;
 296         char buffer[PATH_MAX];
 297
 298         length = strlen(path);
 299         if (length >= sizeof(buffer)) {
 300                 fprintf(stderr, "path too long %lu [%.99s...]\n", (unsigned long)length, path);
 301                 return -1;
 302         }
 303
 304         memcpy(buffer, path, length + 1);
 305         return adddirs(buffer, length);
 306 }
 307
 308 int afb_api_so_add_path(const char *path)
 309 {
 310         struct stat st;
 311         int rc;
 312
 313         rc = stat(path, &st);
 314         if (rc < 0)
 315                 fprintf(stderr, "Invalid plugin path [%s]: %m\n", path);
 316         else if (S_ISDIR(st.st_mode))
 317                 rc = afb_api_so_add_directory(path);
 318         else
 319                 rc = afb_api_so_add_plugin(path);
 320         return rc;
 321 }
 322
 323 int afb_api_so_add_pathset(const char *pathset)
 324 {
 325         static char sep[] = ":";
 326         char *ps, *p;
 327
 328         ps = strdupa(pathset);
 329         for (;;) {
 330                 p = strsep(&ps, sep);
 331                 if (!p)
 332                         return 0;
 333                 afb_api_so_add_path(p);
 334         };
 335 }
 336