2 * Copyright (C) 2016, 2017 "IoT.bzh"
3 * Author José Bollo <jose.bollo@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #define NO_BINDING_VERBOSE_MACRO
29 #include <sys/types.h>
32 #include <afb/afb-binding.h>
33 #include <afb/afb-req-itf.h>
34 #include <afb/afb-event-itf.h>
36 #include "afb-session.h"
37 #include "afb-common.h"
38 #include "afb-context.h"
40 #include "afb-api-so.h"
41 #include "afb-sig-handler.h"
42 #include "afb-thread.h"
48 * Description of a binding
51 struct afb_binding *binding; /* descriptor */
52 size_t apilength; /* length of the API name */
53 void *handle; /* context of dlopen */
54 struct afb_svc *service; /* handler for service started */
55 struct afb_binding_interface interface; /* interface for the binding */
58 static const char binding_register_function_v1[] = "afbBindingV1Register";
59 static const char binding_service_init_function_v1[] = "afbBindingV1ServiceInit";
60 static const char binding_service_event_function_v1[] = "afbBindingV1ServiceEvent";
62 static int api_timeout = 15;
64 static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name);
65 static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object);
66 static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args);
67 static int afb_api_so_rootdir_get_fd(void *closure);
68 static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale);
70 static const struct afb_daemon_itf daemon_itf = {
71 .event_broadcast = afb_api_so_event_broadcast_cb,
72 .get_event_loop = afb_common_get_event_loop,
73 .get_user_bus = afb_common_get_user_bus,
74 .get_system_bus = afb_common_get_system_bus,
75 .vverbose = afb_api_so_vverbose_cb,
76 .event_make = afb_api_so_event_make_cb,
77 .rootdir_get_fd = afb_api_so_rootdir_get_fd,
78 .rootdir_open_locale = afb_api_so_rootdir_open_locale
81 static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name)
85 struct api_so_desc *desc = closure;
87 /* makes the event name */
88 assert(desc->binding != NULL);
89 length = strlen(name);
90 event = alloca(length + 2 + desc->apilength);
91 memcpy(event, desc->binding->v1.prefix, desc->apilength);
92 event[desc->apilength] = '/';
93 memcpy(event + desc->apilength + 1, name, length + 1);
96 return afb_evt_create_event(event);
99 static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object)
103 struct api_so_desc *desc = closure;
105 /* makes the event name */
106 assert(desc->binding != NULL);
107 length = strlen(name);
108 event = alloca(length + 2 + desc->apilength);
109 memcpy(event, desc->binding->v1.prefix, desc->apilength);
110 event[desc->apilength] = '/';
111 memcpy(event + desc->apilength + 1, name, length + 1);
113 return afb_evt_broadcast(event, object);
116 static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args)
119 struct api_so_desc *desc = closure;
121 if (vasprintf(&p, fmt, args) < 0)
122 vverbose(level, file, line, fmt, args);
124 verbose(level, file, line, "%s {binding %s}", p, desc->binding->v1.prefix);
129 static int afb_api_so_rootdir_get_fd(void *closure)
131 return afb_common_rootdir_get_fd();
134 static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale)
136 return afb_common_rootdir_open_locale(filename, flags, locale);
139 static int call_check(struct afb_req req, struct afb_context *context, const struct afb_verb_desc_v1 *verb)
141 int stag = (int)verb->session;
143 if ((stag & (AFB_SESSION_CREATE|AFB_SESSION_CLOSE|AFB_SESSION_RENEW|AFB_SESSION_CHECK|AFB_SESSION_LOA_EQ)) != 0) {
144 if (!afb_context_check(context)) {
145 afb_context_close(context);
146 afb_req_fail(req, "failed", "invalid token's identity");
151 if ((stag & AFB_SESSION_CREATE) != 0) {
152 if (afb_context_check_loa(context, 1)) {
153 afb_req_fail(req, "failed", "invalid creation state");
156 afb_context_change_loa(context, 1);
157 afb_context_refresh(context);
160 if ((stag & (AFB_SESSION_CREATE | AFB_SESSION_RENEW)) != 0)
161 afb_context_refresh(context);
163 if ((stag & AFB_SESSION_CLOSE) != 0) {
164 afb_context_change_loa(context, 0);
165 afb_context_close(context);
168 if ((stag & AFB_SESSION_LOA_GE) != 0) {
169 int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
170 if (!afb_context_check_loa(context, loa)) {
171 afb_req_fail(req, "failed", "invalid LOA");
176 if ((stag & AFB_SESSION_LOA_LE) != 0) {
177 int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
178 if (afb_context_check_loa(context, loa + 1)) {
179 afb_req_fail(req, "failed", "invalid LOA");
186 static void call_cb(void *closure, struct afb_req req, struct afb_context *context, const char *strverb, size_t lenverb)
188 const struct afb_verb_desc_v1 *verb;
189 struct api_so_desc *desc = closure;
191 verb = desc->binding->v1.verbs;
192 while (verb->name && (strncasecmp(verb->name, strverb, lenverb) || verb->name[lenverb]))
195 afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, strverb, desc->binding->v1.prefix);
196 else if (call_check(req, context, verb)) {
199 afb_sig_req_timeout(req, verb->callback, api_timeout);
202 afb_thread_call(req, verb->callback, api_timeout, desc);
206 static int service_start_cb(void *closure, int share_session, int onneed)
208 int (*init)(struct afb_service service);
209 void (*onevent)(const char *event, struct json_object *object);
211 struct api_so_desc *desc = closure;
214 if (desc->service != NULL) {
215 /* not an error when onneed */
219 /* already started: it is an error */
220 ERROR("Service %s already started", desc->binding->v1.prefix);
224 /* get the initialisation */
225 init = dlsym(desc->handle, binding_service_init_function_v1);
227 /* not an error when onneed */
231 /* no initialisation method */
232 ERROR("Binding %s is not a service", desc->binding->v1.prefix);
236 /* get the event handler if any */
237 onevent = dlsym(desc->handle, binding_service_event_function_v1);
238 desc->service = afb_svc_create(share_session, init, onevent);
239 if (desc->service == NULL) {
241 ERROR("Starting service %s failed", desc->binding->v1.prefix);
248 void afb_api_so_set_timeout(int to)
253 int afb_api_so_add_binding(const char *path)
257 struct api_so_desc *desc;
258 struct afb_binding *(*register_function) (const struct afb_binding_interface *interface);
259 struct afb_verb_desc_v1 fake_verb;
260 struct afb_binding fake_binding;
262 // This is a loadable library let's check if it's a binding
264 handle = dlopen(path, RTLD_NOW | RTLD_LOCAL);
265 if (handle == NULL) {
266 ERROR("binding [%s] not loadable: %s", path, dlerror());
270 /* retrieves the register function */
271 register_function = dlsym(handle, binding_register_function_v1);
272 if (!register_function) {
273 ERROR("binding [%s] is not an AFB binding", path);
276 INFO("binding [%s] is a valid AFB binding", path);
279 /* allocates the description */
280 desc = calloc(1, sizeof *desc);
282 ERROR("out of memory");
285 desc->handle = handle;
287 /* init the interface */
288 desc->interface.verbosity = verbosity;
289 desc->interface.mode = AFB_MODE_LOCAL;
290 desc->interface.daemon.itf = &daemon_itf;
291 desc->interface.daemon.closure = desc;
293 /* for log purpose, a fake binding is needed here */
294 desc->binding = &fake_binding;
295 fake_binding.type = AFB_BINDING_VERSION_1;
296 fake_binding.v1.info = path;
297 fake_binding.v1.prefix = path;
298 fake_binding.v1.verbs = &fake_verb;
299 fake_verb.name = NULL;
301 /* init the binding */
302 NOTICE("binding [%s] calling registering function %s", path, binding_register_function_v1);
303 desc->binding = register_function(&desc->interface);
304 if (desc->binding == NULL) {
305 ERROR("binding [%s] register function failed. continuing...", path);
309 /* check the returned structure */
310 if (desc->binding->type != AFB_BINDING_VERSION_1) {
311 ERROR("binding [%s] invalid type %d...", path, desc->binding->type);
314 if (desc->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) {
315 ERROR("binding [%s] bad prefix...", path);
318 if (!afb_apis_is_valid_api_name(desc->binding->v1.prefix)) {
319 ERROR("binding [%s] invalid prefix...", path);
322 if (desc->binding->v1.info == NULL || *desc->binding->v1.info == 0) {
323 ERROR("binding [%s] bad description...", path);
326 if (desc->binding->v1.verbs == NULL) {
327 ERROR("binding [%s] no APIs...", path);
331 /* records the binding */
332 desc->apilength = strlen(desc->binding->v1.prefix);
333 if (afb_apis_add(desc->binding->v1.prefix, (struct afb_api){
336 .service_start = service_start_cb }) < 0) {
337 ERROR("binding [%s] can't be registered...", path);
340 NOTICE("binding %s loaded with API prefix %s", path, desc->binding->v1.prefix);
351 static int adddirs(char path[PATH_MAX], size_t end)
357 /* open the DIR now */
360 ERROR("can't scan binding directory %s, %m", path);
363 INFO("Scanning dir=[%s] for bindings", path);
365 /* scan each entry */
373 ERROR("read error while scanning directory %.*s: %m", (int)(end - 1), path);
377 len = strlen(dent->d_name);
378 if (len + end >= PATH_MAX) {
379 ERROR("path too long while scanning bindings for %s", dent->d_name);
382 if (dent->d_type == DT_DIR) {
383 /* case of directories */
384 if (dent->d_name[0] == '.') {
387 if (dent->d_name[1] == '.' && len == 2)
390 memcpy(&path[end], dent->d_name, len+1);
391 adddirs(path, end+len);;
392 } else if (dent->d_type == DT_REG) {
394 if (memcmp(&dent->d_name[len - 3], ".so", 4))
396 memcpy(&path[end], dent->d_name, len+1);
397 if (afb_api_so_add_binding(path) < 0)
405 int afb_api_so_add_directory(const char *path)
408 char buffer[PATH_MAX];
410 length = strlen(path);
411 if (length >= sizeof(buffer)) {
412 ERROR("path too long %lu [%.99s...]", (unsigned long)length, path);
416 memcpy(buffer, path, length + 1);
417 return adddirs(buffer, length);
420 int afb_api_so_add_path(const char *path)
425 rc = stat(path, &st);
427 ERROR("Invalid binding path [%s]: %m", path);
428 else if (S_ISDIR(st.st_mode))
429 rc = afb_api_so_add_directory(path);
430 else if (strstr(path, ".so"))
431 rc = afb_api_so_add_binding(path);
433 INFO("not a binding [%s], skipped", path);
437 int afb_api_so_add_pathset(const char *pathset)
439 static char sep[] = ":";
442 ps = strdupa(pathset);
444 p = strsep(&ps, sep);
447 if (afb_api_so_add_path(p) < 0)