2 * Copyright (C) 2016 "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
28 #include <sys/types.h>
31 #include <afb/afb-binding.h>
32 #include <afb/afb-req-itf.h>
33 #include <afb/afb-event-itf.h>
36 #include "afb-common.h"
37 #include "afb-context.h"
39 #include "afb-api-so.h"
40 #include "afb-sig-handler.h"
46 * Description of a binding
49 struct afb_binding *binding; /* descriptor */
50 size_t apilength; /* length of the API name */
51 void *handle; /* context of dlopen */
52 struct afb_svc *service; /* handler for service started */
53 struct afb_binding_interface interface; /* interface for the binding */
58 void (*action)(struct afb_req);
61 static const char binding_register_function_v1[] = "afbBindingV1Register";
62 static const char binding_service_init_function_v1[] = "afbBindingV1ServiceInit";
63 static const char binding_service_event_function_v1[] = "afbBindingV1ServiceEvent";
65 static int api_timeout = 15;
67 static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name);
68 static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object);
69 static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args);
70 static int afb_api_so_rootdir_get_fd(void *closure);
71 static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale);
73 static const struct afb_daemon_itf daemon_itf = {
74 .event_broadcast = afb_api_so_event_broadcast_cb,
75 .get_event_loop = afb_common_get_event_loop,
76 .get_user_bus = afb_common_get_user_bus,
77 .get_system_bus = afb_common_get_system_bus,
78 .vverbose = afb_api_so_vverbose_cb,
79 .event_make = afb_api_so_event_make_cb,
80 .rootdir_get_fd = afb_api_so_rootdir_get_fd,
81 .rootdir_open_locale = afb_api_so_rootdir_open_locale
84 static struct afb_event afb_api_so_event_make_cb(void *closure, const char *name)
88 struct api_so_desc *desc = closure;
90 /* makes the event name */
91 assert(desc->binding != NULL);
92 length = strlen(name);
93 event = alloca(length + 2 + desc->apilength);
94 memcpy(event, desc->binding->v1.prefix, desc->apilength);
95 event[desc->apilength] = '/';
96 memcpy(event + desc->apilength + 1, name, length + 1);
99 return afb_evt_create_event(event);
102 static int afb_api_so_event_broadcast_cb(void *closure, const char *name, struct json_object *object)
106 struct api_so_desc *desc = closure;
108 /* makes the event name */
109 assert(desc->binding != NULL);
110 length = strlen(name);
111 event = alloca(length + 2 + desc->apilength);
112 memcpy(event, desc->binding->v1.prefix, desc->apilength);
113 event[desc->apilength] = '/';
114 memcpy(event + desc->apilength + 1, name, length + 1);
116 return afb_evt_broadcast(event, object);
119 static void afb_api_so_vverbose_cb(void *closure, int level, const char *file, int line, const char *fmt, va_list args)
122 struct api_so_desc *desc = closure;
124 if (vasprintf(&p, fmt, args) < 0)
125 vverbose(level, file, line, fmt, args);
127 verbose(level, file, line, "%s {binding %s}", p, desc->binding->v1.prefix);
132 static int afb_api_so_rootdir_get_fd(void *closure)
134 return afb_common_rootdir_get_fd();
137 static int afb_api_so_rootdir_open_locale(void *closure, const char *filename, int flags, const char *locale)
139 return afb_common_rootdir_open_locale(filename, flags, locale);
142 static void monitored_call(int signum, void *arg)
144 struct monitoring *data = arg;
146 afb_req_fail_f(data->req, "aborted", "signal %s(%d) caught", strsignal(signum), signum);
148 data->action(data->req);
151 static void call_check(struct afb_req req, struct afb_context *context, const struct afb_verb_desc_v1 *verb)
153 struct monitoring data;
155 int stag = (int)verb->session;
157 if ((stag & (AFB_SESSION_CREATE|AFB_SESSION_CLOSE|AFB_SESSION_RENEW|AFB_SESSION_CHECK|AFB_SESSION_LOA_EQ)) != 0) {
158 if (!afb_context_check(context)) {
159 afb_context_close(context);
160 afb_req_fail(req, "failed", "invalid token's identity");
165 if ((stag & AFB_SESSION_CREATE) != 0) {
166 if (afb_context_check_loa(context, 1)) {
167 afb_req_fail(req, "failed", "invalid creation state");
170 afb_context_change_loa(context, 1);
171 afb_context_refresh(context);
174 if ((stag & (AFB_SESSION_CREATE | AFB_SESSION_RENEW)) != 0)
175 afb_context_refresh(context);
177 if ((stag & AFB_SESSION_CLOSE) != 0) {
178 afb_context_change_loa(context, 0);
179 afb_context_close(context);
182 if ((stag & AFB_SESSION_LOA_GE) != 0) {
183 int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
184 if (!afb_context_check_loa(context, loa)) {
185 afb_req_fail(req, "failed", "invalid LOA");
190 if ((stag & AFB_SESSION_LOA_LE) != 0) {
191 int loa = (stag >> AFB_SESSION_LOA_SHIFT) & AFB_SESSION_LOA_MASK;
192 if (afb_context_check_loa(context, loa + 1)) {
193 afb_req_fail(req, "failed", "invalid LOA");
199 data.action = verb->callback;
200 afb_sig_monitor(monitored_call, &data, api_timeout);
203 static void call_cb(void *closure, struct afb_req req, struct afb_context *context, const char *verb, size_t lenverb)
205 const struct afb_verb_desc_v1 *v;
206 struct api_so_desc *desc = closure;
208 v = desc->binding->v1.verbs;
209 while (v->name && (strncasecmp(v->name, verb, lenverb) || v->name[lenverb]))
212 call_check(req, context, v);
214 afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->binding->v1.prefix);
217 static int service_start_cb(void *closure, int share_session, int onneed)
219 int (*init)(struct afb_service service);
220 void (*onevent)(const char *event, struct json_object *object);
222 struct api_so_desc *desc = closure;
225 if (desc->service != NULL) {
226 /* not an error when onneed */
230 /* already started: it is an error */
231 ERROR("Service %s already started", desc->binding->v1.prefix);
235 /* get the initialisation */
236 init = dlsym(desc->handle, binding_service_init_function_v1);
238 /* not an error when onneed */
242 /* no initialisation method */
243 ERROR("Binding %s is not a service", desc->binding->v1.prefix);
247 /* get the event handler if any */
248 onevent = dlsym(desc->handle, binding_service_event_function_v1);
249 desc->service = afb_svc_create(share_session, init, onevent);
250 if (desc->service == NULL) {
252 ERROR("Starting service %s failed", desc->binding->v1.prefix);
259 void afb_api_so_set_timeout(int to)
264 int afb_api_so_add_binding(const char *path)
268 struct api_so_desc *desc;
269 struct afb_binding *(*register_function) (const struct afb_binding_interface *interface);
270 struct afb_verb_desc_v1 fake_verb;
271 struct afb_binding fake_binding;
273 // This is a loadable library let's check if it's a binding
275 handle = dlopen(path, RTLD_NOW | RTLD_LOCAL);
276 if (handle == NULL) {
277 ERROR("binding [%s] not loadable", path);
281 /* retrieves the register function */
282 register_function = dlsym(handle, binding_register_function_v1);
283 if (!register_function) {
284 ERROR("binding [%s] is not an AFB binding", path);
287 INFO("binding [%s] is a valid AFB binding", path);
290 /* allocates the description */
291 desc = calloc(1, sizeof *desc);
293 ERROR("out of memory");
296 desc->handle = handle;
298 /* init the interface */
299 desc->interface.verbosity = verbosity;
300 desc->interface.mode = AFB_MODE_LOCAL;
301 desc->interface.daemon.itf = &daemon_itf;
302 desc->interface.daemon.closure = desc;
304 /* for log purpose, a fake binding is needed here */
305 desc->binding = &fake_binding;
306 fake_binding.type = AFB_BINDING_VERSION_1;
307 fake_binding.v1.info = path;
308 fake_binding.v1.prefix = path;
309 fake_binding.v1.verbs = &fake_verb;
310 fake_verb.name = NULL;
312 /* init the binding */
313 NOTICE("binding [%s] calling registering function %s", path, binding_register_function_v1);
314 desc->binding = register_function(&desc->interface);
315 if (desc->binding == NULL) {
316 ERROR("binding [%s] register function failed. continuing...", path);
320 /* check the returned structure */
321 if (desc->binding->type != AFB_BINDING_VERSION_1) {
322 ERROR("binding [%s] invalid type %d...", path, desc->binding->type);
325 if (desc->binding->v1.prefix == NULL || *desc->binding->v1.prefix == 0) {
326 ERROR("binding [%s] bad prefix...", path);
329 if (!afb_apis_is_valid_api_name(desc->binding->v1.prefix)) {
330 ERROR("binding [%s] invalid prefix...", path);
333 if (desc->binding->v1.info == NULL || *desc->binding->v1.info == 0) {
334 ERROR("binding [%s] bad description...", path);
337 if (desc->binding->v1.verbs == NULL) {
338 ERROR("binding [%s] no APIs...", path);
342 /* records the binding */
343 desc->apilength = strlen(desc->binding->v1.prefix);
344 if (afb_apis_add(desc->binding->v1.prefix, (struct afb_api){
347 .service_start = service_start_cb }) < 0) {
348 ERROR("binding [%s] can't be registered...", path);
351 NOTICE("binding %s loaded with API prefix %s", path, desc->binding->v1.prefix);
362 static int adddirs(char path[PATH_MAX], size_t end)
365 struct dirent ent, *result;
368 /* open the DIR now */
371 ERROR("can't scan binding directory %s, %m", path);
374 INFO("Scanning dir=[%s] for bindings", path);
376 /* scan each entry */
380 readdir_r(dir, &ent, &result);
384 len = strlen(ent.d_name);
385 if (len + end >= PATH_MAX) {
386 ERROR("path too long while scanning bindings for %s", ent.d_name);
389 memcpy(&path[end], ent.d_name, len+1);
390 if (ent.d_type == DT_DIR) {
391 /* case of directories */
392 if (ent.d_name[0] == '.') {
395 if (ent.d_name[1] == '.' && len == 2)
398 adddirs(path, end+len);;
399 } else if (ent.d_type == DT_REG) {
401 if (!strstr(ent.d_name, ".so"))
403 if (afb_api_so_add_binding(path) < 0)
411 int afb_api_so_add_directory(const char *path)
414 char buffer[PATH_MAX];
416 length = strlen(path);
417 if (length >= sizeof(buffer)) {
418 ERROR("path too long %lu [%.99s...]", (unsigned long)length, path);
422 memcpy(buffer, path, length + 1);
423 return adddirs(buffer, length);
426 int afb_api_so_add_path(const char *path)
431 rc = stat(path, &st);
433 ERROR("Invalid binding path [%s]: %m", path);
434 else if (S_ISDIR(st.st_mode))
435 rc = afb_api_so_add_directory(path);
436 else if (strstr(path, ".so"))
437 rc = afb_api_so_add_binding(path);
439 INFO("not a binding [%s], skipped", path);
443 int afb_api_so_add_pathset(const char *pathset)
445 static char sep[] = ":";
448 ps = strdupa(pathset);
450 p = strsep(&ps, sep);
453 if (afb_api_so_add_path(p) < 0)