src/afb-api-so-v2.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 #include <json-c/json.h>
  27
  28 #include "afb-api.h"
  29 #include "afb-apiset.h"
  30 #include "afb-svc.h"
  31 #include "afb-ditf.h"
  32 #include "afb-evt.h"
  33 #include "afb-common.h"
  34 #include "afb-context.h"
  35 #include "afb-api-so.h"
  36 #include "afb-xreq.h"
  37 #include "verbose.h"
  38
  39 /*
  40  * names of symbols
  41  */
  42 static const char afb_api_so_v2_descriptor[] = "afbBindingV2";
  43
  44 /*
  45  * Description of a binding
  46  */
  47 struct api_so_v2 {
  48         const struct afb_binding_v2 *binding;   /* descriptor */
  49         void *handle;                   /* context of dlopen */
  50         struct afb_svc *service;        /* handler for service started */
  51         struct afb_ditf ditf;           /* daemon interface */
  52 };
  53
  54 static const struct afb_verb_v2 *search(struct api_so_v2 *desc, const char *verb)
  55 {
  56         const struct afb_verb_v2 *result;
  57
  58         result = desc->binding->verbs;
  59         while (result->verb && strcasecmp(result->verb, verb))
  60                 result++;
  61         return result->verb ? result : NULL;
  62 }
  63
  64 static void call_cb(void *closure, struct afb_xreq *xreq)
  65 {
  66         struct api_so_v2 *desc = closure;
  67         const struct afb_verb_v2 *verb;
  68
  69         verb = search(desc, xreq->verb);
  70         if (!verb)
  71                 afb_xreq_fail_unknown_verb(xreq);
  72         else
  73                 if (!xreq_session_check_apply(xreq, verb->session))
  74                         afb_xreq_call(xreq, verb->callback);
  75 }
  76
  77 static int service_start_cb(void *closure, int share_session, int onneed, struct afb_apiset *apiset)
  78 {
  79         int (*start)(const struct afb_binding_interface *interface, struct afb_service service);
  80         void (*onevent)(const char *event, struct json_object *object);
  81
  82         struct api_so_v2 *desc = closure;
  83
  84         /* check state */
  85         if (desc->service != NULL) {
  86                 /* not an error when onneed */
  87                 if (onneed != 0)
  88                         return 0;
  89
  90                 /* already started: it is an error */
  91                 ERROR("Service %s already started", desc->binding->api);
  92                 return -1;
  93         }
  94
  95         /* get the initialisation */
  96         start = desc->binding->start;
  97         if (start == NULL) {
  98                 /* not an error when onneed */
  99                 if (onneed != 0)
 100                         return 0;
 101
 102                 /* no initialisation method */
 103                 ERROR("Binding %s is not a service", desc->binding->api);
 104                 return -1;
 105         }
 106
 107         /* get the event handler if any */
 108         onevent = desc->binding->onevent;
 109         desc->service = afb_svc_create_v2(apiset, share_session, onevent, start, &desc->ditf.interface);
 110         if (desc->service == NULL) {
 111                 /* starting error */
 112                 ERROR("Starting service %s failed", desc->binding->api);
 113                 return -1;
 114         }
 115
 116         return 0;
 117 }
 118
 119 static void update_hooks_cb(void *closure)
 120 {
 121         struct api_so_v2 *desc = closure;
 122         afb_ditf_update_hook(&desc->ditf);
 123 }
 124
 125 static int get_verbosity_cb(void *closure)
 126 {
 127         struct api_so_v2 *desc = closure;
 128         return desc->ditf.interface.verbosity;
 129 }
 130
 131 static void set_verbosity_cb(void *closure, int level)
 132 {
 133         struct api_so_v2 *desc = closure;
 134         desc->ditf.interface.verbosity = level;
 135 }
 136
 137 static struct json_object *describe_cb(void *closure)
 138 {
 139         struct api_so_v2 *desc = closure;
 140         return desc->binding->specification ? json_tokener_parse(desc->binding->specification) : NULL;
 141 }
 142
 143 static struct afb_api_itf so_v2_api_itf = {
 144         .call = call_cb,
 145         .service_start = service_start_cb,
 146         .update_hooks = update_hooks_cb,
 147         .get_verbosity = get_verbosity_cb,
 148         .set_verbosity = set_verbosity_cb,
 149         .describe = describe_cb
 150
 151 };
 152
 153 int afb_api_so_v2_add_binding(const struct afb_binding_v2 *binding, void *handle, struct afb_apiset *apiset)
 154 {
 155         int rc;
 156         struct api_so_v2 *desc;
 157         struct afb_api afb_api;
 158
 159         /* basic checks */
 160         assert(binding->api);
 161         assert(binding->specification);
 162         assert(binding->verbs);
 163
 164         /* allocates the description */
 165         desc = calloc(1, sizeof *desc);
 166         if (desc == NULL) {
 167                 ERROR("out of memory");
 168                 goto error;
 169         }
 170         desc->binding = binding;
 171         desc->handle = handle;
 172
 173         /* init the interface */
 174         afb_ditf_init(&desc->ditf, binding->api);
 175
 176         /* init the binding */
 177         if (binding->init) {
 178                 INFO("binding %s calling init function", binding->api);
 179                 rc = binding->init(&desc->ditf.interface);
 180                 if (rc < 0) {
 181                         ERROR("binding %s initialisation function failed...", binding->api);
 182                         goto error2;
 183                 }
 184         }
 185
 186         /* records the binding */
 187         afb_api.closure = desc;
 188         afb_api.itf = &so_v2_api_itf;
 189         if (afb_apiset_add(apiset, binding->api, afb_api) < 0) {
 190                 ERROR("binding %s can't be registered to set %s...", binding->api, afb_apiset_name(apiset));
 191                 goto error2;
 192         }
 193         NOTICE("binding %s added to set %s", binding->api, afb_apiset_name(apiset));
 194         return 1;
 195
 196 error2:
 197         free(desc);
 198 error:
 199         return -1;
 200 }
 201
 202 int afb_api_so_v2_add(const char *path, void *handle, struct afb_apiset *apiset)
 203 {
 204         const struct afb_binding_v2 *binding;
 205
 206         /* retrieves the register function */
 207         binding = dlsym(handle, afb_api_so_v2_descriptor);
 208         if (!binding)
 209                 return 0;
 210
 211         INFO("binding [%s] looks like an AFB binding V2", path);
 212
 213         /* basic checks */
 214         if (binding->api == NULL || *binding->api == 0) {
 215                 ERROR("binding [%s] bad api name...", path);
 216                 goto error;
 217         }
 218         if (!afb_api_is_valid_name(binding->api)) {
 219                 ERROR("binding [%s] invalid api name...", path);
 220                 goto error;
 221         }
 222         if (binding->specification == NULL || *binding->specification == 0) {
 223                 ERROR("binding [%s] bad specification...", path);
 224                 goto error;
 225         }
 226         if (binding->verbs == NULL) {
 227                 ERROR("binding [%s] no verbs...", path);
 228                 goto error;
 229         }
 230
 231         return afb_api_so_v2_add_binding(binding, handle, apiset);
 232
 233  error:
 234         return -1;
 235 }
 236