2 * Copyright (C) 2016-2019 "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.
18 #if WITH_DYNAMIC_BINDING
29 #include "afb-api-so.h"
30 #include "afb-api-so-v3.h"
32 #include "sig-monitor.h"
34 #if WITH_LEGACY_BINDING_V1
35 # include "afb-api-so-v1.h"
37 #if WITH_LEGACY_BINDING_VDYN
38 # include "afb-api-so-vdyn.h"
40 #if WITH_LEGACY_BINDING_V2
41 # include "afb-api-so-v2.h"
51 static void safe_dlopen_cb(int sig, void *closure)
53 struct safe_dlopen *sd = closure;
55 sd->handle = dlopen(sd->path, sd->flags);
57 ERROR("dlopen of %s raised signal %s", sd->path, strsignal(sig));
62 static void *safe_dlopen(const char *filename, int flags)
64 struct safe_dlopen sd;
68 sig_monitor(0, safe_dlopen_cb, &sd);
72 static int load_binding(const char *path, int force, struct afb_apiset *declare_set, struct afb_apiset * call_set)
78 // This is a loadable library let's check if it's a binding
80 handle = safe_dlopen(path, RTLD_NOW | RTLD_LOCAL | RTLD_DEEPBIND);
83 ERROR("binding [%s] not loadable: %s", path, dlerror());
85 WARNING("binding [%s] not loadable: %s", path, dlerror());
89 /* try the version 3 */
90 rc = afb_api_so_v3_add(path, handle, declare_set, call_set);
92 /* error when loading a valid v3 binding */
96 return 0; /* yes version 3 */
98 #if WITH_LEGACY_BINDING_V2
99 /* try the version 2 */
100 rc = afb_api_so_v2_add(path, handle, declare_set, call_set);
102 /* error when loading a valid v2 binding */
106 return 0; /* yes version 2 */
108 if (dlsym(handle, "afbBindingV2")) {
109 WARNING("binding [%s]: version 2 not supported", path);
114 #if WITH_LEGACY_BINDING_VDYN
115 /* try the version dyn */
116 rc = afb_api_so_vdyn_add(path, handle, declare_set, call_set);
118 /* error when loading a valid dyn binding */
122 return 0; /* yes version dyn */
124 if (dlsym(handle, "afbBindingVdyn")) {
125 WARNING("binding [%s]: version DYN not supported", path);
130 #if WITH_LEGACY_BINDING_V1
131 /* try the version 1 */
132 rc = afb_api_so_v1_add(path, handle, declare_set, call_set);
134 /* error when loading a valid v1 binding */
138 return 0; /* yes version 1 */
140 if (dlsym(handle, "afbBindingV1Register")) {
141 WARNING("binding [%s]: version 1 not supported", path);
146 /* not a valid binding */
147 _VERBOSE_(force ? Log_Level_Error : Log_Level_Info, "binding [%s] %s",
148 path, obsolete ? "is obsolete" : "isn't an AFB binding");
157 int afb_api_so_add_binding(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set)
159 return load_binding(path, 1, declare_set, call_set);
162 static int adddirs(char path[PATH_MAX], size_t end, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
170 /* open the DIR now */
173 ERROR("can't scan binding directory %s, %m", path);
176 INFO("Scanning dir=[%s] for bindings", path);
178 /* scan each entry */
186 ERROR("read error while scanning directory %.*s: %m", (int)(end - 1), path);
190 /* get the name and inspect dereferenced link instead of the directory entry */
191 len = strlen(dent->d_name);
192 if (len + end >= PATH_MAX) {
193 ERROR("path too long while scanning bindings for %.*s%s", (int)end, path, dent->d_name);
196 memcpy(&path[end], dent->d_name, len+1);
197 rc = stat(path, &st);
199 ERROR("getting status of %s failed: %m", path);
202 else if (S_ISDIR(st.st_mode)) {
203 /* case of directories */
204 if (dent->d_name[0] == '.') {
206 Exclude from the search of bindings any
207 directory starting with a dot (.) by default.
209 It is possible to reactivate the prvious behaviour
210 by defining the following preprocessor variables
212 - AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS
214 When this variable is defined, the directories
215 starting with a dot are searched except
216 if their name is "." or ".." or ".debug"
218 - AFB_API_SO_ACCEPT_DOT_DEBUG_DIRS
220 When this variable is defined and the variable
221 AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS is also defined
222 scans any directory not being "." or "..".
224 The previous behaviour was like difining the 2 variables,
225 meaning that only . and .. were excluded from the search.
227 This change is intended to definitely solve the issue
228 SPEC-662. Yocto installed the debugging symbols in the
229 subdirectory .debug. For example the binding.so also
230 had a .debug/binding.so file attached. Opening that
231 debug file made dlopen crashing.
232 See https://sourceware.org/bugzilla/show_bug.cgi?id=22101
234 #if !defined(AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS) /* not defined by default */
235 continue; /* ignore any directory beginning with a dot */
239 if (dent->d_name[1] == '.' && len == 2)
241 #if !defined(AFB_API_SO_ACCEPT_DOT_DEBUG_DIRS) /* not defined by default */
243 && dent->d_name[1] == 'd'
244 && dent->d_name[2] == 'e'
245 && dent->d_name[3] == 'b'
246 && dent->d_name[4] == 'u'
247 && dent->d_name[5] == 'g')
248 continue; /* .debug */
252 rc = adddirs(path, end+len, declare_set, call_set, failstops);
253 } else if (S_ISREG(st.st_mode)) {
255 if (memcmp(&dent->d_name[len - 3], ".so", 4))
257 rc = load_binding(path, 0, declare_set, call_set);
259 if (rc < 0 && failstops) {
268 int afb_api_so_add_directory(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
271 char buffer[PATH_MAX];
273 length = strlen(path);
274 if (length >= sizeof(buffer)) {
275 ERROR("path too long %lu [%.99s...]", (unsigned long)length, path);
279 memcpy(buffer, path, length + 1);
280 return adddirs(buffer, length, declare_set, call_set, failstops);
283 int afb_api_so_add_path(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
288 rc = stat(path, &st);
290 ERROR("Invalid binding path [%s]: %m", path);
291 else if (S_ISDIR(st.st_mode))
292 rc = afb_api_so_add_directory(path, declare_set, call_set, failstops);
293 else if (strstr(path, ".so"))
294 rc = load_binding(path, 0, declare_set, call_set);
296 INFO("not a binding [%s], skipped", path);
300 int afb_api_so_add_pathset(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
302 static char sep[] = ":";
306 ps = strdupa(pathset);
308 p = strsep(&ps, sep);
311 rc = afb_api_so_add_path(p, declare_set, call_set, failstops);
317 int afb_api_so_add_pathset_fails(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set)
319 return afb_api_so_add_pathset(pathset, declare_set, call_set, 1);
322 int afb_api_so_add_pathset_nofails(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set)
324 return afb_api_so_add_pathset(pathset, declare_set, call_set, 0);