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.
27 #include "afb-api-so.h"
28 #include "afb-api-so-v3.h"
30 #include "sig-monitor.h"
32 #if WITH_LEGACY_BINDING_V1
33 # include "afb-api-so-v1.h"
35 #if WITH_LEGACY_BINDING_VDYN
36 # include "afb-api-so-vdyn.h"
38 #if WITH_LEGACY_BINDING_V2
39 # include "afb-api-so-v2.h"
49 static void safe_dlopen_cb(int sig, void *closure)
51 struct safe_dlopen *sd = closure;
53 sd->handle = dlopen(sd->path, sd->flags);
55 ERROR("dlopen of %s raised signal %s", sd->path, strsignal(sig));
60 static void *safe_dlopen(const char *filename, int flags)
62 struct safe_dlopen sd;
66 sig_monitor(0, safe_dlopen_cb, &sd);
70 static int load_binding(const char *path, int force, struct afb_apiset *declare_set, struct afb_apiset * call_set)
76 // This is a loadable library let's check if it's a binding
78 handle = safe_dlopen(path, RTLD_NOW | RTLD_LOCAL | RTLD_DEEPBIND);
81 ERROR("binding [%s] not loadable: %s", path, dlerror());
83 WARNING("binding [%s] not loadable: %s", path, dlerror());
87 /* try the version 3 */
88 rc = afb_api_so_v3_add(path, handle, declare_set, call_set);
90 /* error when loading a valid v3 binding */
94 return 0; /* yes version 3 */
96 #if WITH_LEGACY_BINDING_V2
97 /* try the version 2 */
98 rc = afb_api_so_v2_add(path, handle, declare_set, call_set);
100 /* error when loading a valid v2 binding */
104 return 0; /* yes version 2 */
106 if (dlsym(handle, "afbBindingV2")) {
107 WARNING("binding [%s]: version 2 not supported", path);
112 #if WITH_LEGACY_BINDING_VDYN
113 /* try the version dyn */
114 rc = afb_api_so_vdyn_add(path, handle, declare_set, call_set);
116 /* error when loading a valid dyn binding */
120 return 0; /* yes version dyn */
122 if (dlsym(handle, "afbBindingVdyn")) {
123 WARNING("binding [%s]: version DYN not supported", path);
128 #if WITH_LEGACY_BINDING_V1
129 /* try the version 1 */
130 rc = afb_api_so_v1_add(path, handle, declare_set, call_set);
132 /* error when loading a valid v1 binding */
136 return 0; /* yes version 1 */
138 if (dlsym(handle, "afbBindingV1Register")) {
139 WARNING("binding [%s]: version 1 not supported", path);
144 /* not a valid binding */
145 _VERBOSE_(force ? Log_Level_Error : Log_Level_Info, "binding [%s] %s",
146 path, obsolete ? "is obsolete" : "isn't an AFB binding");
155 int afb_api_so_add_binding(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set)
157 return load_binding(path, 1, declare_set, call_set);
160 static int adddirs(char path[PATH_MAX], size_t end, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
168 /* open the DIR now */
171 ERROR("can't scan binding directory %s, %m", path);
174 INFO("Scanning dir=[%s] for bindings", path);
176 /* scan each entry */
184 ERROR("read error while scanning directory %.*s: %m", (int)(end - 1), path);
188 /* get the name and inspect dereferenced link instead of the directory entry */
189 len = strlen(dent->d_name);
190 if (len + end >= PATH_MAX) {
191 ERROR("path too long while scanning bindings for %.*s%s", (int)end, path, dent->d_name);
194 memcpy(&path[end], dent->d_name, len+1);
195 rc = stat(path, &st);
197 ERROR("getting status of %s failed: %m", path);
200 else if (S_ISDIR(st.st_mode)) {
201 /* case of directories */
202 if (dent->d_name[0] == '.') {
204 Exclude from the search of bindings any
205 directory starting with a dot (.) by default.
207 It is possible to reactivate the prvious behaviour
208 by defining the following preprocessor variables
210 - AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS
212 When this variable is defined, the directories
213 starting with a dot are searched except
214 if their name is "." or ".." or ".debug"
216 - AFB_API_SO_ACCEPT_DOT_DEBUG_DIRS
218 When this variable is defined and the variable
219 AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS is also defined
220 scans any directory not being "." or "..".
222 The previous behaviour was like difining the 2 variables,
223 meaning that only . and .. were excluded from the search.
225 This change is intended to definitely solve the issue
226 SPEC-662. Yocto installed the debugging symbols in the
227 subdirectory .debug. For example the binding.so also
228 had a .debug/binding.so file attached. Opening that
229 debug file made dlopen crashing.
230 See https://sourceware.org/bugzilla/show_bug.cgi?id=22101
232 #if !defined(AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS) /* not defined by default */
233 continue; /* ignore any directory beginning with a dot */
237 if (dent->d_name[1] == '.' && len == 2)
239 #if !defined(AFB_API_SO_ACCEPT_DOT_DEBUG_DIRS) /* not defined by default */
241 && dent->d_name[1] == 'd'
242 && dent->d_name[2] == 'e'
243 && dent->d_name[3] == 'b'
244 && dent->d_name[4] == 'u'
245 && dent->d_name[5] == 'g')
246 continue; /* .debug */
250 rc = adddirs(path, end+len, declare_set, call_set, failstops);
251 } else if (S_ISREG(st.st_mode)) {
253 if (memcmp(&dent->d_name[len - 3], ".so", 4))
255 rc = load_binding(path, 0, declare_set, call_set);
257 if (rc < 0 && failstops) {
266 int afb_api_so_add_directory(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
269 char buffer[PATH_MAX];
271 length = strlen(path);
272 if (length >= sizeof(buffer)) {
273 ERROR("path too long %lu [%.99s...]", (unsigned long)length, path);
277 memcpy(buffer, path, length + 1);
278 return adddirs(buffer, length, declare_set, call_set, failstops);
281 int afb_api_so_add_path(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
286 rc = stat(path, &st);
288 ERROR("Invalid binding path [%s]: %m", path);
289 else if (S_ISDIR(st.st_mode))
290 rc = afb_api_so_add_directory(path, declare_set, call_set, failstops);
291 else if (strstr(path, ".so"))
292 rc = load_binding(path, 0, declare_set, call_set);
294 INFO("not a binding [%s], skipped", path);
298 int afb_api_so_add_pathset(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
300 static char sep[] = ":";
304 ps = strdupa(pathset);
306 p = strsep(&ps, sep);
309 rc = afb_api_so_add_path(p, declare_set, call_set, failstops);
315 int afb_api_so_add_pathset_fails(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set)
317 return afb_api_so_add_pathset(pathset, declare_set, call_set, 1);
320 int afb_api_so_add_pathset_nofails(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set)
322 return afb_api_so_add_pathset(pathset, declare_set, call_set, 0);