2 * Copyright (C) 2016, 2017, 2018 "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-v2.h"
29 #include "afb-api-so-v3.h"
31 #include "sig-monitor.h"
33 #if defined(WITH_LEGACY_BINDING_V1)
34 # include "afb-api-so-v1.h"
36 #if defined(WITH_LEGACY_BINDING_VDYN)
37 # include "afb-api-so-vdyn.h"
47 static void safe_dlopen_cb(int sig, void *closure)
49 struct safe_dlopen *sd = closure;
51 sd->handle = dlopen(sd->path, sd->flags);
53 ERROR("dlopen of %s raised signal %s", sd->path, strsignal(sig));
58 static void *safe_dlopen(const char *filename, int flags)
60 struct safe_dlopen sd;
64 sig_monitor(0, safe_dlopen_cb, &sd);
68 static int load_binding(const char *path, int force, struct afb_apiset *declare_set, struct afb_apiset * call_set)
74 // This is a loadable library let's check if it's a binding
76 handle = safe_dlopen(path, RTLD_NOW | RTLD_LOCAL | RTLD_DEEPBIND);
79 ERROR("binding [%s] not loadable: %s", path, dlerror());
81 WARNING("binding [%s] not loadable: %s", path, dlerror());
85 /* try the version 3 */
86 rc = afb_api_so_v3_add(path, handle, declare_set, call_set);
88 /* error when loading a valid v3 binding */
92 return 0; /* yes version 3 */
94 /* try the version 2 */
95 rc = afb_api_so_v2_add(path, handle, declare_set, call_set);
97 /* error when loading a valid v2 binding */
101 return 0; /* yes version 2 */
103 #if defined(WITH_LEGACY_BINDING_VDYN)
104 /* try the version dyn */
105 rc = afb_api_so_vdyn_add(path, handle, declare_set, call_set);
107 /* error when loading a valid dyn binding */
111 return 0; /* yes version dyn */
113 if (dlsym(handle, "afbBindingVdyn")) {
114 WARNING("binding [%s]: version DYN not supported", path);
119 #if defined(WITH_LEGACY_BINDING_V1)
120 /* try the version 1 */
121 rc = afb_api_so_v1_add(path, handle, declare_set, call_set);
123 /* error when loading a valid v1 binding */
127 return 0; /* yes version 1 */
129 if (dlsym(handle, "afbBindingV1Register")) {
130 WARNING("binding [%s]: version 1 not supported", path);
135 /* not a valid binding */
136 _VERBOSE_(force ? Log_Level_Error : Log_Level_Info, "binding [%s] %s",
137 path, obsolete ? "is obsolete" : "isn't an AFB binding");
146 int afb_api_so_add_binding(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set)
148 return load_binding(path, 1, declare_set, call_set);
151 static int adddirs(char path[PATH_MAX], size_t end, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
159 /* open the DIR now */
162 ERROR("can't scan binding directory %s, %m", path);
165 INFO("Scanning dir=[%s] for bindings", path);
167 /* scan each entry */
175 ERROR("read error while scanning directory %.*s: %m", (int)(end - 1), path);
179 /* get the name and inspect dereferenced link instead of the directory entry */
180 len = strlen(dent->d_name);
181 if (len + end >= PATH_MAX) {
182 ERROR("path too long while scanning bindings for %.*s%s", (int)end, path, dent->d_name);
185 memcpy(&path[end], dent->d_name, len+1);
186 rc = stat(path, &st);
188 ERROR("getting status of %s failed: %m", path);
191 else if (S_ISDIR(st.st_mode)) {
192 /* case of directories */
193 if (dent->d_name[0] == '.') {
195 Exclude from the search of bindings any
196 directory starting with a dot (.) by default.
198 It is possible to reactivate the prvious behaviour
199 by defining the following preprocessor variables
201 - AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS
203 When this variable is defined, the directories
204 starting with a dot are searched except
205 if their name is "." or ".." or ".debug"
207 - AFB_API_SO_ACCEPT_DOT_DEBUG_DIRS
209 When this variable is defined and the variable
210 AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS is also defined
211 scans any directory not being "." or "..".
213 The previous behaviour was like difining the 2 variables,
214 meaning that only . and .. were excluded from the search.
216 This change is intended to definitely solve the issue
217 SPEC-662. Yocto installed the debugging symbols in the
218 subdirectory .debug. For example the binding.so also
219 had a .debug/binding.so file attached. Opening that
220 debug file made dlopen crashing.
221 See https://sourceware.org/bugzilla/show_bug.cgi?id=22101
223 #if !defined(AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS) /* not defined by default */
224 continue; /* ignore any directory beginning with a dot */
228 if (dent->d_name[1] == '.' && len == 2)
230 #if !defined(AFB_API_SO_ACCEPT_DOT_DEBUG_DIRS) /* not defined by default */
232 && dent->d_name[1] == 'd'
233 && dent->d_name[2] == 'e'
234 && dent->d_name[3] == 'b'
235 && dent->d_name[4] == 'u'
236 && dent->d_name[5] == 'g')
237 continue; /* .debug */
241 rc = adddirs(path, end+len, declare_set, call_set, failstops);
242 } else if (S_ISREG(st.st_mode)) {
244 if (memcmp(&dent->d_name[len - 3], ".so", 4))
246 rc = load_binding(path, 0, declare_set, call_set);
248 if (rc < 0 && failstops) {
257 int afb_api_so_add_directory(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
260 char buffer[PATH_MAX];
262 length = strlen(path);
263 if (length >= sizeof(buffer)) {
264 ERROR("path too long %lu [%.99s...]", (unsigned long)length, path);
268 memcpy(buffer, path, length + 1);
269 return adddirs(buffer, length, declare_set, call_set, failstops);
272 int afb_api_so_add_path(const char *path, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
277 rc = stat(path, &st);
279 ERROR("Invalid binding path [%s]: %m", path);
280 else if (S_ISDIR(st.st_mode))
281 rc = afb_api_so_add_directory(path, declare_set, call_set, failstops);
282 else if (strstr(path, ".so"))
283 rc = load_binding(path, 0, declare_set, call_set);
285 INFO("not a binding [%s], skipped", path);
289 int afb_api_so_add_pathset(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set, int failstops)
291 static char sep[] = ":";
295 ps = strdupa(pathset);
297 p = strsep(&ps, sep);
300 rc = afb_api_so_add_path(p, declare_set, call_set, failstops);
306 int afb_api_so_add_pathset_fails(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set)
308 return afb_api_so_add_pathset(pathset, declare_set, call_set, 1);
311 int afb_api_so_add_pathset_nofails(const char *pathset, struct afb_apiset *declare_set, struct afb_apiset * call_set)
313 return afb_api_so_add_pathset(pathset, declare_set, call_set, 0);