X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fafb-api-so-v2.c;h=8403366b364f80cb41da0eca41c1217cdbfe458c;hb=550b36945f2e9eae1fc4b822ea9a00a2a866eb83;hp=4e34e03c4719109bdea288f28d21b774eef6a679;hpb=7effe02be236921437fb77d8fbeb21eb62e35939;p=src%2Fapp-framework-binder.git diff --git a/src/afb-api-so-v2.c b/src/afb-api-so-v2.c index 4e34e03c..8403366b 100644 --- a/src/afb-api-so-v2.c +++ b/src/afb-api-so-v2.c @@ -16,122 +16,54 @@ */ #define _GNU_SOURCE -#define NO_BINDING_VERBOSE_MACRO +#include #include #include #include -#include +#include +#include -#include "afb-apis.h" +#include "afb-api.h" +#include "afb-api-so-v2.h" +#include "afb-apiset.h" #include "afb-svc.h" +#include "afb-ditf.h" #include "afb-evt.h" #include "afb-common.h" #include "afb-context.h" #include "afb-api-so.h" #include "afb-xreq.h" +#include "jobs.h" #include "verbose.h" /* * names of symbols */ static const char afb_api_so_v2_descriptor[] = "afbBindingV2"; +static const char afb_api_so_v2_data[] = "afbBindingV2data"; /* * Description of a binding */ struct api_so_v2 { - struct afb_binding_v2 *binding; /* descriptor */ - size_t apilength; /* length of the API name */ + const struct afb_binding_v2 *binding; /* descriptor */ + struct afb_binding_data_v2 *data; /* data */ void *handle; /* context of dlopen */ struct afb_svc *service; /* handler for service started */ - struct afb_binding_interface interface; /* interface for the binding */ + struct afb_ditf ditf; /* daemon interface */ }; -static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name); -static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object); -static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args); -static int afb_api_so_rootdir_get_fd(void *closure); -static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale); - -static const struct afb_daemon_itf daemon_itf = { - .event_broadcast = afb_api_so_event_broadcast_cb, - .get_event_loop = afb_common_get_event_loop, - .get_user_bus = afb_common_get_user_bus, - .get_system_bus = afb_common_get_system_bus, - .vverbose = afb_api_so_vverbose_cb, - .event_make = afb_api_so_event_make_cb, - .rootdir_get_fd = afb_api_so_rootdir_get_fd, - .rootdir_open_locale = afb_api_so_rootdir_open_locale -}; - -static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name) -{ - size_t length; - char *event; - struct api_so_v2 *desc = closure; - - /* makes the event name */ - assert(desc->binding != NULL); - length = strlen(name); - event = alloca(length + 2 + desc->apilength); - memcpy(event, desc->binding->api, desc->apilength); - event[desc->apilength] = '/'; - memcpy(event + desc->apilength + 1, name, length + 1); - - /* crate the event */ - return afb_evt_create_event(event); -} - -static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object) +static const struct afb_verb_v2 *search(struct api_so_v2 *desc, const char *name) { - size_t length; - char *event; - struct api_so_v2 *desc = closure; - - /* makes the event name */ - assert(desc->binding != NULL); - length = strlen(name); - event = alloca(length + 2 + desc->apilength); - memcpy(event, desc->binding->api, desc->apilength); - event[desc->apilength] = '/'; - memcpy(event + desc->apilength + 1, name, length + 1); - - return afb_evt_broadcast(event, object); -} - -static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args) -{ - char *p; - struct api_so_v2 *desc = closure; - - if (vasprintf(&p, fmt, args) < 0) - vverbose(level, file, line, fmt, args); - else { - verbose(level, file, line, "%s {binding %s}", p, desc->binding->api); - free(p); - } -} - -static int afb_api_so_rootdir_get_fd(void *closure) -{ - return afb_common_rootdir_get_fd(); -} - -static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale) -{ - return afb_common_rootdir_open_locale(filename, flags, locale); -} - -static const struct afb_verb_v2 *search(struct api_so_v2 *desc, const char *verb) -{ - const struct afb_verb_v2 *result; + const struct afb_verb_v2 *verb; - result = desc->binding->verbs; - while (result->verb && strcasecmp(result->verb, verb)) - result++; - return result->verb ? result : NULL; + verb = desc->binding->verbs; + while (verb->verb && strcasecmp(verb->verb, name)) + verb++; + return verb->verb ? verb : NULL; + return NULL; } static void call_cb(void *closure, struct afb_xreq *xreq) @@ -140,15 +72,13 @@ static void call_cb(void *closure, struct afb_xreq *xreq) const struct afb_verb_v2 *verb; verb = search(desc, xreq->verb); - if (!verb) - afb_xreq_fail_f(xreq, "unknown-verb", "verb %s unknown within api %s", xreq->verb, desc->binding->api); - else - afb_xreq_call(xreq, verb->session, verb->callback); + afb_xreq_call_verb_v2(xreq, verb); } -static int service_start_cb(void *closure, int share_session, int onneed) +static int service_start_cb(void *closure, int share_session, int onneed, struct afb_apiset *apiset) { - int (*start)(const struct afb_binding_interface *interface, struct afb_service service); + int rc; + int (*start)(); void (*onevent)(const char *event, struct json_object *object); struct api_so_v2 *desc = closure; @@ -157,67 +87,186 @@ static int service_start_cb(void *closure, int share_session, int onneed) if (desc->service != NULL) { /* not an error when onneed */ if (onneed != 0) - return 0; + goto done; /* already started: it is an error */ - ERROR("Service %s already started", desc->binding->api); + ERROR("Service %s already started", desc->ditf.api); return -1; } /* get the initialisation */ - start = desc->binding->start; - if (start == NULL) { + start = desc->binding->init; + onevent = desc->binding->onevent; + if (start == NULL && onevent == NULL) { /* not an error when onneed */ if (onneed != 0) - return 0; + goto done; /* no initialisation method */ - ERROR("Binding %s is not a service", desc->binding->api); + ERROR("Binding %s is not a service", desc->ditf.api); return -1; } /* get the event handler if any */ - onevent = desc->binding->onevent; - desc->service = afb_svc_create_v2(share_session, onevent, start, &desc->interface); + desc->service = afb_svc_create(desc->ditf.api, apiset, share_session, onevent, &desc->data->service); if (desc->service == NULL) { /* starting error */ - ERROR("Starting service %s failed", desc->binding->api); + ERROR("Starting service %s failed", desc->ditf.api); return -1; } + /* Starts the service */ + desc->ditf.state = Daemon_Init; + rc = afb_svc_start_v2(desc->service, start); + if (rc < 0) { + /* initialisation error */ + ERROR("Initialisation of service %s failed (%d): %m", desc->ditf.api, rc); + afb_svc_destroy(desc->service, &desc->data->service); + desc->service = NULL; + return rc; + } + +done: + desc->ditf.state = Daemon_Run; return 0; } -int afb_api_so_v2_add(const char *path, void *handle) +static void update_hooks_cb(void *closure) { - int rc; - struct api_so_v2 *desc; - struct afb_binding_v2 *binding; + struct api_so_v2 *desc = closure; + afb_ditf_update_hook(&desc->ditf); + if (desc->service) + afb_svc_update_hook(desc->service); +} - /* retrieves the register function */ - binding = dlsym(handle, afb_api_so_v2_descriptor); - if (!binding) - return 0; +static int get_verbosity_cb(void *closure) +{ + struct api_so_v2 *desc = closure; + return desc->data->verbosity; +} - INFO("binding [%s] looks like an AFB binding V2", path); +static void set_verbosity_cb(void *closure, int level) +{ + struct api_so_v2 *desc = closure; + desc->data->verbosity = level; +} - /* basic checks */ - if (binding->api == NULL || *binding->api == 0) { - ERROR("binding [%s] bad api name...", path); - goto error; - } - if (!afb_apis_is_valid_api_name(binding->api)) { - ERROR("binding [%s] invalid api name...", path); - goto error; - } - if (binding->specification == NULL || *binding->specification == 0) { - ERROR("binding [%s] bad specification...", path); - goto error; +static struct json_object *addperm(struct json_object *o, struct json_object *x) +{ + struct json_object *a; + + if (!o) + return x; + + if (!json_object_object_get_ex(o, "allOf", &a)) { + a = json_object_new_array(); + json_object_array_add(a, o); + o = json_object_new_object(); + json_object_object_add(o, "allOf", a); } - if (binding->verbs == NULL) { - ERROR("binding [%s] no verbs...", path); - goto error; + json_object_array_add(a, x); + return o; +} + +static struct json_object *addperm_key_val(struct json_object *o, const char *key, struct json_object *val) +{ + struct json_object *x = json_object_new_object(); + json_object_object_add(x, key, val); + return addperm(o, x); +} + +static struct json_object *addperm_key_valstr(struct json_object *o, const char *key, const char *val) +{ + return addperm_key_val(o, key, json_object_new_string(val)); +} + +static struct json_object *addperm_key_valint(struct json_object *o, const char *key, int val) +{ + return addperm_key_val(o, key, json_object_new_int(val)); +} + +static struct json_object *make_description_openAPIv3(struct api_so_v2 *desc) +{ + char buffer[256]; + const struct afb_verb_v2 *verb; + struct json_object *r, *f, *a, *i, *p, *g; + + r = json_object_new_object(); + json_object_object_add(r, "openapi", json_object_new_string("3.0.0")); + + i = json_object_new_object(); + json_object_object_add(r, "info", i); + json_object_object_add(i, "title", json_object_new_string(desc->ditf.api)); + json_object_object_add(i, "version", json_object_new_string("0.0.0")); + json_object_object_add(i, "description", json_object_new_string(desc->binding->info ?: desc->ditf.api)); + + p = json_object_new_object(); + json_object_object_add(r, "paths", p); + verb = desc->binding->verbs; + while (verb->verb) { + buffer[0] = '/'; + strncpy(buffer + 1, verb->verb, sizeof buffer - 1); + buffer[sizeof buffer - 1] = 0; + f = json_object_new_object(); + json_object_object_add(p, buffer, f); + g = json_object_new_object(); + json_object_object_add(f, "get", g); + + a = NULL; + if (verb->session & AFB_SESSION_CLOSE_V2) + a = addperm_key_valstr(a, "session", "close"); + if (verb->session & AFB_SESSION_CHECK_V2) + a = addperm_key_valstr(a, "session", "check"); + if (verb->session & AFB_SESSION_REFRESH_V2) + a = addperm_key_valstr(a, "token", "refresh"); + if (verb->session & AFB_SESSION_LOA_MASK_V2) + a = addperm_key_valint(a, "LOA", verb->session & AFB_SESSION_LOA_MASK_V2); +#if 0 + if (verb->auth) + a = +#endif + if (a) + json_object_object_add(g, "x-permissions", a); + + a = json_object_new_object(); + json_object_object_add(g, "responses", a); + f = json_object_new_object(); + json_object_object_add(a, "200", f); + json_object_object_add(f, "description", json_object_new_string(verb->info?:verb->verb)); + verb++; } + return r; +} + +static struct json_object *describe_cb(void *closure) +{ + struct api_so_v2 *desc = closure; + struct json_object *r = desc->binding->specification ? json_tokener_parse(desc->binding->specification) : NULL; + if (!r) + r = make_description_openAPIv3(desc); + return r; +} + +static struct afb_api_itf so_v2_api_itf = { + .call = call_cb, + .service_start = service_start_cb, + .update_hooks = update_hooks_cb, + .get_verbosity = get_verbosity_cb, + .set_verbosity = set_verbosity_cb, + .describe = describe_cb +}; + +int afb_api_so_v2_add_binding(const struct afb_binding_v2 *binding, void *handle, struct afb_apiset *apiset, struct afb_binding_data_v2 *data) +{ + int rc; + struct api_so_v2 *desc; + struct afb_api afb_api; + + /* basic checks */ + assert(binding); + assert(binding->api); + assert(binding->verbs); + assert(data); /* allocates the description */ desc = calloc(1, sizeof *desc); @@ -226,36 +275,33 @@ int afb_api_so_v2_add(const char *path, void *handle) goto error; } desc->binding = binding; + desc->data = data; desc->handle = handle; + desc->service = NULL; /* init the interface */ - desc->interface.verbosity = verbosity; - desc->interface.mode = AFB_MODE_LOCAL; - desc->interface.daemon.itf = &daemon_itf; - desc->interface.daemon.closure = desc; - - /* for log purpose, a fake binding is needed here */ + desc->data->verbosity = verbosity; + afb_ditf_init_v2(&desc->ditf, binding->api, data); /* init the binding */ - if (binding->init) { - NOTICE("binding %s [%s] calling init function", binding->api, path); - rc = binding->init(&desc->interface); + if (binding->preinit) { + INFO("binding %s calling preinit function", binding->api); + rc = binding->preinit(); if (rc < 0) { - ERROR("binding %s [%s] initialisation function failed...", binding->api, path); + ERROR("binding %s preinit function failed...", desc->ditf.api); goto error2; } } /* records the binding */ - desc->apilength = strlen(binding->api); - if (afb_apis_add(binding->api, (struct afb_api){ - .closure = desc, - .call = call_cb, - .service_start = service_start_cb }) < 0) { - ERROR("binding [%s] can't be registered...", path); + afb_api.closure = desc; + afb_api.itf = &so_v2_api_itf; + afb_api.noconcurrency = binding->noconcurrency; + if (afb_apiset_add(apiset, desc->ditf.api, afb_api) < 0) { + ERROR("binding %s can't be registered to set %s...", desc->ditf.api, afb_apiset_name(apiset)); goto error2; } - NOTICE("binding %s loaded with API prefix %s", path, binding->api); + INFO("binding %s added to set %s", desc->ditf.api, afb_apiset_name(apiset)); return 1; error2: @@ -264,3 +310,47 @@ error: return -1; } +int afb_api_so_v2_add(const char *path, void *handle, struct afb_apiset *apiset) +{ + const struct afb_binding_v2 *binding; + struct afb_binding_data_v2 *data; + + /* retrieves the register function */ + binding = dlsym(handle, afb_api_so_v2_descriptor); + data = dlsym(handle, afb_api_so_v2_data); + if (!binding && !data) + return 0; + + INFO("binding [%s] looks like an AFB binding V2", path); + + /* basic checks */ + if (!binding || !data) { + ERROR("binding [%s] incomplete symbol set: %s is missing", + path, binding ? afb_api_so_v2_data : afb_api_so_v2_descriptor); + goto error; + } + if (binding->api == NULL || *binding->api == 0) { + ERROR("binding [%s] bad api name...", path); + goto error; + } + if (!afb_api_is_valid_name(binding->api)) { + ERROR("binding [%s] invalid api name...", path); + goto error; + } +#if 0 + if (binding->specification == NULL || *binding->specification == 0) { + ERROR("binding [%s] bad specification...", path); + goto error; + } +#endif + if (binding->verbs == NULL) { + ERROR("binding [%s] no verbs...", path); + goto error; + } + + return afb_api_so_v2_add_binding(binding, handle, apiset, data); + + error: + return -1; +} +