src/afb-api-so-v1.c

   1 /*
   2  * Copyright (C) 2016, 2017 "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 #define NO_BINDING_VERBOSE_MACRO
  20
  21 #include <string.h>
  22 #include <dlfcn.h>
  23 #include <assert.h>
  24
  25 #include <afb/afb-binding.h>
  26
  27 #include "afb-api.h"
  28 #include "afb-apiset.h"
  29 #include "afb-svc.h"
  30 #include "afb-evt.h"
  31 #include "afb-common.h"
  32 #include "afb-context.h"
  33 #include "afb-api-so.h"
  34 #include "afb-xreq.h"
  35 #include "afb-ditf.h"
  36 #include "verbose.h"
  37
  38 /*
  39  * names of symbols
  40  */
  41 static const char afb_api_so_v1_register[] = "afbBindingV1Register";
  42 static const char afb_api_so_v1_service_init[] = "afbBindingV1ServiceInit";
  43 static const char afb_api_so_v1_service_event[] = "afbBindingV1ServiceEvent";
  44
  45 /*
  46  * Description of a binding
  47  */
  48 struct api_so_v1 {
  49         struct afb_binding *binding;    /* descriptor */
  50         void *handle;                   /* context of dlopen */
  51         struct afb_svc *service;        /* handler for service started */
  52         struct afb_ditf ditf;           /* daemon interface */
  53 };
  54
  55 static const struct afb_verb_desc_v1 *search(struct api_so_v1 *desc, const char *name)
  56 {
  57         const struct afb_verb_desc_v1 *verb;
  58
  59         verb = desc->binding->v1.verbs;
  60         while (verb->name && strcasecmp(verb->name, name))
  61                 verb++;
  62         return verb->name ? verb : NULL;
  63 }
  64
  65 static void call_cb(void *closure, struct afb_xreq *xreq)
  66 {
  67         const struct afb_verb_desc_v1 *verb;
  68         struct api_so_v1 *desc = closure;
  69
  70         verb = search(desc, xreq->verb);
  71         if (!verb)
  72                 afb_xreq_fail_unknown_verb(xreq);
  73         else
  74                 if (!xreq_session_check_apply(xreq, verb->session))
  75                         afb_xreq_call(xreq, verb->callback);
  76 }
  77
  78 static int service_start_cb(void *closure, int share_session, int onneed, struct afb_apiset *apiset)
  79 {
  80         int (*init)(struct afb_service service);
  81         void (*onevent)(const char *event, struct json_object *object);
  82
  83         struct api_so_v1 *desc = closure;
  84
  85         /* check state */
  86         if (desc->service != NULL) {
  87                 /* not an error when onneed */
  88                 if (onneed != 0)
  89                         return 0;
  90
  91                 /* already started: it is an error */
  92                 ERROR("Service %s already started", desc->binding->v1.prefix);
  93                 return -1;
  94         }
  95
  96         /* get the initialisation */
  97         init = dlsym(desc->handle, afb_api_so_v1_service_init);
  98         if (init == NULL) {
  99                 /* not an error when onneed */
 100                 if (onneed != 0)
 101                         return 0;
 102
 103                 /* no initialisation method */
 104                 ERROR("Binding %s is not a service", desc->binding->v1.prefix);
 105                 return -1;
 106         }
 107
 108         /* get the event handler if any */
 109         onevent = dlsym(desc->handle, afb_api_so_v1_service_event);
 110         desc->service = afb_svc_create(apiset, share_session, init, onevent);
 111         if (desc->service == NULL) {
 112                 /* starting error */
 113                 ERROR("Starting service %s failed", desc->binding->v1.prefix);
 114                 return -1;
 115         }
 116
 117         return 0;
 118 }
 119
 120 static void update_hooks_cb(void *closure)
 121 {
 122         struct api_so_v1 *desc = closure;
 123         afb_ditf_update_hook(&desc->ditf);
 124 }
 125
 126 static int get_verbosity_cb(void *closure)
 127 {
 128         struct api_so_v1 *desc = closure;
 129         return desc->ditf.interface.verbosity;
 130 }
 131
 132 static void set_verbosity_cb(void *closure, int level)
 133 {
 134         struct api_so_v1 *desc = closure;
 135         desc->ditf.interface.verbosity = level;
 136 }
 137
 138 static struct afb_api_itf so_v1_api_itf = {
 139         .call = call_cb,
 140         .service_start = service_start_cb,
 141         .update_hooks = update_hooks_cb,
 142         .get_verbosity = get_verbosity_cb,
 143         .set_verbosity = set_verbosity_cb
 144 };
 145
 146 int afb_api_so_v1_add(const char *path, void *handle, struct afb_apiset *apiset)
 147 {
 148         struct api_so_v1 *desc;
 149         struct afb_binding *(*register_function) (const struct afb_binding_interface *interface);
 150         struct afb_api afb_api;
 151
 152         /* retrieves the register function */
 153         register_function = dlsym(handle, afb_api_so_v1_register);
 154         if (!register_function)
 155                 return 0;
 156         INFO("binding [%s] is a valid AFB binding V1", path);
 157
 158         /* allocates the description */
 159         desc = calloc(1, sizeof *desc);
 160         if (desc == NULL) {
 161                 ERROR("out of memory");
 162                 goto error;
 163         }
 164         desc->handle = handle;
 165
 166         /* init the interface */
 167         afb_ditf_init(&desc->ditf, path);
 168
 169         /* init the binding */
 170         NOTICE("binding [%s] calling registering function %s", path, afb_api_so_v1_register);
 171         desc->binding = register_function(&desc->ditf.interface);
 172         if (desc->binding == NULL) {
 173                 ERROR("binding [%s] register function failed. continuing...", path);
 174                 goto error2;
 175         }
 176
 177         /* check the returned structure */
 178         if (desc->binding->type != AFB_BINDING_VERSION_1) {
 179                 ERROR("binding [%s] invalid type %d...", path, desc->binding->type);
 180                 goto error2;
 181         }
 182         if (desc->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) {
 183                 ERROR("binding [%s] bad prefix...", path);
 184                 goto error2;
 185         }
 186         if (!afb_api_is_valid_name(desc->binding->v1.prefix)) {
 187                 ERROR("binding [%s] invalid prefix...", path);
 188                 goto error2;
 189         }
 190         if (desc->binding->v1.info == NULL || *desc->binding->v1.info == 0) {
 191                 ERROR("binding [%s] bad description...", path);
 192                 goto error2;
 193         }
 194         if (desc->binding->v1.verbs == NULL) {
 195                 ERROR("binding [%s] no APIs...", path);
 196                 goto error2;
 197         }
 198
 199         /* records the binding */
 200         afb_ditf_rename(&desc->ditf, desc->binding->v1.prefix);
 201         afb_api.closure = desc;
 202         afb_api.itf = &so_v1_api_itf;
 203         if (afb_apiset_add(apiset, desc->binding->v1.prefix, afb_api) < 0) {
 204                 ERROR("binding [%s] can't be registered...", path);
 205                 goto error2;
 206         }
 207         NOTICE("binding %s loaded with API prefix %s", path, desc->binding->v1.prefix);
 208         return 1;
 209
 210 error2:
 211         free(desc);
 212 error:
 213         return -1;
 214 }
 215