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.
27 #include <sys/types.h>
31 #include <sys/syscall.h>
34 #include "afb-plugin.h"
35 #include "afb-req-itf.h"
36 #include "afb-pollmgr-itf.h"
37 #include "afb-evmgr-itf.h"
41 #include "afb-api-so.h"
43 #include "utils-upoll.h"
45 extern __thread sigjmp_buf *error_handler;
48 struct AFB_plugin *plugin; /* descriptor */
50 void *handle; /* context of dlopen */
51 struct AFB_interface interface; /* interface */
54 static int api_timeout = 15;
56 static const char plugin_register_function[] = "pluginRegister";
58 static const struct afb_pollmgr_itf pollmgr_itf = {
59 .wait = (void*)upoll_wait,
60 .open = (void*)upoll_open,
61 .on_readable = (void*)upoll_on_readable,
62 .on_writable = (void*)upoll_on_writable,
63 .on_hangup = (void*)upoll_on_hangup,
64 .close = (void*)upoll_close
67 static void afb_api_so_evmgr_push(struct api_so_desc *desc, const char *name, struct json_object *object)
72 assert(desc->plugin != NULL);
73 length = strlen(name);
74 event = alloca(length + 2 + desc->apilength);
75 memcpy(event, desc->plugin->prefix, desc->apilength);
76 event[desc->apilength] = '/';
77 memcpy(event + desc->apilength + 1, name, length + 1);
78 ctxClientEventSend(NULL, event, object);
81 static const struct afb_evmgr_itf evmgr_itf = {
82 .push = (void*)afb_api_so_evmgr_push
85 static struct afb_evmgr afb_api_so_get_evmgr(struct api_so_desc *desc)
87 return (struct afb_evmgr){ .itf = &evmgr_itf, .closure = desc };
90 static struct afb_pollmgr afb_api_so_get_pollmgr(struct api_so_desc *desc)
92 return (struct afb_pollmgr){ .itf = &pollmgr_itf, .closure = NULL };
95 static const struct afb_daemon_itf daemon_itf = {
96 .get_evmgr = (void*)afb_api_so_get_evmgr,
97 .get_pollmgr = (void*)afb_api_so_get_pollmgr
100 static void trapping_call(struct afb_req req, void(*cb)(struct afb_req))
102 volatile int signum, timerset;
104 sigjmp_buf jmpbuf, *older;
105 struct sigevent sevp;
106 struct itimerspec its;
109 older = error_handler;
110 signum = setjmp(jmpbuf);
112 afb_req_fail_f(req, "aborted", "signal %d caught", signum);
115 error_handler = &jmpbuf;
116 if (api_timeout > 0) {
117 timerset = 1; /* TODO: check statuses */
118 sevp.sigev_notify = SIGEV_THREAD_ID;
119 sevp.sigev_signo = SIGALRM;
120 sevp.sigev_value.sival_ptr = NULL;
121 #if defined(sigev_notify_thread_id)
122 sevp.sigev_notify_thread_id = (pid_t)syscall(SYS_gettid);
124 sevp._sigev_un._tid = (pid_t)syscall(SYS_gettid);
126 timer_create(CLOCK_THREAD_CPUTIME_ID, &sevp, &timerid);
127 its.it_interval.tv_sec = 0;
128 its.it_interval.tv_nsec = 0;
129 its.it_value.tv_sec = api_timeout;
130 its.it_value.tv_nsec = 0;
131 timer_settime(timerid, 0, &its, NULL);
137 timer_delete(timerid);
138 error_handler = older;
141 static void call_check(struct afb_req req, const struct AFB_restapi *verb)
143 switch(verb->session) {
144 case AFB_SESSION_CREATE:
145 if (!afb_req_session_create(req))
148 case AFB_SESSION_RENEW:
149 if (!afb_req_session_check(req, 1))
152 case AFB_SESSION_CLOSE:
153 case AFB_SESSION_CHECK:
154 if (!afb_req_session_check(req, 0))
157 case AFB_SESSION_NONE:
161 trapping_call(req, verb->callback);
162 if (verb->session == AFB_SESSION_CLOSE)
163 afb_req_session_close(req);
166 static void call(struct api_so_desc *desc, struct afb_req req, const char *verb, size_t lenverb)
168 const struct AFB_restapi *v;
170 v = desc->plugin->apis;
171 while (v->name && (strncasecmp(v->name, verb, lenverb) || v->name[lenverb]))
176 afb_req_fail_f(req, "unknown-verb", "verb %.*s unknown within api %s", (int)lenverb, verb, desc->plugin->prefix);
179 int afb_api_so_add_plugin(const char *path)
181 struct api_so_desc *desc;
182 struct AFB_plugin *(*pluginRegisterFct) (const struct AFB_interface *interface);
184 desc = calloc(1, sizeof *desc);
186 fprintf(stderr, "[%s] out of memory\n", path);
190 // This is a loadable library let's check if it's a plugin
191 desc->handle = dlopen(path, RTLD_NOW | RTLD_LOCAL);
192 if (desc->handle == NULL) {
193 fprintf(stderr, "[%s] not loadable, continuing...\n", path);
197 /* retrieves the register function */
198 pluginRegisterFct = dlsym(desc->handle, plugin_register_function);
199 if (!pluginRegisterFct) {
200 fprintf(stderr, "[%s] not an AFB plugin, continuing...\n", path);
204 fprintf(stderr, "[%s] is a valid AFB plugin\n", path);
206 /* init the interface */
207 desc->interface.verbosity = 0;
208 desc->interface.mode = AFB_MODE_LOCAL;
209 desc->interface.daemon.itf = &daemon_itf;
210 desc->interface.daemon.closure = desc;
212 /* init the plugin */
213 desc->plugin = pluginRegisterFct(&desc->interface);
214 if (desc->plugin == NULL) {
215 fprintf(stderr, "ERROR: plugin [%s] register function failed. continuing...\n", path);
219 /* check the returned structure */
220 if (desc->plugin->type != AFB_PLUGIN_JSON) {
221 fprintf(stderr, "ERROR: plugin [%s] invalid type %d...\n", path, desc->plugin->type);
224 if (desc->plugin->prefix == NULL || *desc->plugin->prefix == 0) {
225 fprintf(stderr, "ERROR: plugin [%s] bad prefix...\n", path);
228 if (desc->plugin->info == NULL || *desc->plugin->info == 0) {
229 fprintf(stderr, "ERROR: plugin [%s] bad description...\n", path);
232 if (desc->plugin->apis == NULL) {
233 fprintf(stderr, "ERROR: plugin [%s] no APIs...\n", path);
237 /* records the plugin */
238 desc->apilength = strlen(desc->plugin->prefix);
239 if (afb_apis_add(desc->plugin->prefix, (struct afb_api){
241 .call = (void*)call}) < 0) {
242 fprintf(stderr, "ERROR: plugin [%s] can't be registered...\n", path);
249 dlclose(desc->handle);
256 static int adddirs(char path[PATH_MAX], size_t end)
259 struct dirent ent, *result;
262 /* open the DIR now */
265 fprintf(stderr, "ERROR in scanning plugin directory %s, %m\n", path);
269 fprintf(stderr, "Scanning dir=[%s] for plugins\n", path);
271 /* scan each entry */
275 readdir_r(dir, &ent, &result);
279 len = strlen(ent.d_name);
280 if (len + end >= PATH_MAX) {
281 fprintf(stderr, "path too long for %s\n", ent.d_name);
284 memcpy(&path[end], ent.d_name, len+1);
285 if (ent.d_type == DT_DIR) {
286 /* case of directories */
287 if (ent.d_name[0] == '.') {
290 if (ent.d_name[1] == '.' && len == 2)
293 adddirs(path, end+len);;
294 } else if (ent.d_type == DT_REG) {
296 if (!strstr(ent.d_name, ".so"))
298 afb_api_so_add_plugin(path);
305 int afb_api_so_add_directory(const char *path)
308 char buffer[PATH_MAX];
310 length = strlen(path);
311 if (length >= sizeof(buffer)) {
312 fprintf(stderr, "path too long %lu [%.99s...]\n", (unsigned long)length, path);
316 memcpy(buffer, path, length + 1);
317 return adddirs(buffer, length);
320 int afb_api_so_add_path(const char *path)
325 rc = stat(path, &st);
327 fprintf(stderr, "Invalid plugin path [%s]: %m\n", path);
328 else if (S_ISDIR(st.st_mode))
329 rc = afb_api_so_add_directory(path);
331 rc = afb_api_so_add_plugin(path);
335 int afb_api_so_add_pathset(const char *pathset)
337 static char sep[] = ":";
340 ps = strdupa(pathset);
342 p = strsep(&ps, sep);
345 afb_api_so_add_path(p);