2 * Copyright (C) 2016, 2017 "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-v1.h"
29 #include "afb-api-so-v2.h"
30 #include "afb-api-so-vdyn.h"
32 #include "sig-monitor.h"
41 static void safe_dlopen_cb(int sig, void *closure)
43 struct safe_dlopen *sd = closure;
45 sd->handle = dlopen(sd->path, sd->flags);
47 ERROR("dlopen of %s raised signal %s", sd->path, strsignal(sig));
52 static void *safe_dlopen(const char *filename, int flags)
54 struct safe_dlopen sd;
58 sig_monitor(0, safe_dlopen_cb, &sd);
62 static int load_binding(const char *path, int force, struct afb_apiset *apiset)
67 // This is a loadable library let's check if it's a binding
69 handle = safe_dlopen(path, RTLD_NOW | RTLD_LOCAL | RTLD_DEEPBIND);
72 ERROR("binding [%s] not loadable: %s", path, dlerror());
74 WARNING("binding [%s] not loadable: %s", path, dlerror());
78 /* try the version 2 */
79 rc = afb_api_so_v2_add(path, handle, apiset);
81 /* error when loading a valid v2 binding */
85 return 0; /* yes version 2 */
87 /* try the version dyn */
88 rc = afb_api_so_vdyn_add(path, handle, apiset);
90 /* error when loading a valid dyn binding */
94 return 0; /* yes version dyn */
96 /* try the version 1 */
97 rc = afb_api_so_v1_add(path, handle, apiset);
99 /* error when loading a valid v1 binding */
103 return 0; /* yes version 1 */
105 /* not a valid binding */
107 ERROR("binding [%s] is not an AFB binding", path);
109 INFO("binding [%s] is not an AFB binding", path);
118 int afb_api_so_add_binding(const char *path, struct afb_apiset *apiset)
120 return load_binding(path, 1, apiset);
123 static int adddirs(char path[PATH_MAX], size_t end, struct afb_apiset *apiset, int failstops)
130 /* open the DIR now */
133 ERROR("can't scan binding directory %s, %m", path);
136 INFO("Scanning dir=[%s] for bindings", path);
138 /* scan each entry */
146 ERROR("read error while scanning directory %.*s: %m", (int)(end - 1), path);
150 len = strlen(dent->d_name);
151 if (len + end >= PATH_MAX) {
152 ERROR("path too long while scanning bindings for %s", dent->d_name);
155 if (dent->d_type == DT_DIR) {
156 /* case of directories */
157 if (dent->d_name[0] == '.') {
159 Exclude from the search of bindings any
160 directory starting with a dot (.) by default.
162 It is possible to reactivate the prvious behaviour
163 by defining the following preprocessor variables
165 - AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS
167 When this variable is defined, the directories
168 starting with a dot are searched except
169 if their name is "." or ".." or ".debug"
171 - AFB_API_SO_ACCEPT_DOT_DEBUG_DIRS
173 When this variable is defined and the variable
174 AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS is also defined
175 scans any directory not being "." or "..".
177 The previous behaviour was like difining the 2 variables,
178 meaning that only . and .. were excluded from the search.
180 This change is intended to definitely solve the issue
181 SPEC-662. Yocto installed the debugging symbols in the
182 subdirectory .debug. For example the binding.so also
183 had a .debug/binding.so file attached. Opening that
184 debug file made dlopen crashing.
185 See https://sourceware.org/bugzilla/show_bug.cgi?id=22101
187 #if !defined(AFB_API_SO_ACCEPT_DOT_PREFIXED_DIRS) /* not defined by default */
188 continue; /* ignore any directory beginnign with a dot */
192 if (dent->d_name[1] == '.' && len == 2)
194 #if !defined(AFB_API_SO_ACCEPT_DOT_DEBUG_DIRS) /* not defined by default */
196 && dent->d_name[1] == 'd'
197 && dent->d_name[2] == 'e'
198 && dent->d_name[3] == 'b'
199 && dent->d_name[4] == 'u'
200 && dent->d_name[5] == 'g')
201 continue; /* .debug */
205 memcpy(&path[end], dent->d_name, len+1);
206 rc = adddirs(path, end+len, apiset, failstops);
207 } else if (dent->d_type == DT_REG) {
209 if (memcmp(&dent->d_name[len - 3], ".so", 4))
211 memcpy(&path[end], dent->d_name, len+1);
212 rc = load_binding(path, 0, apiset);
214 if (rc < 0 && failstops) {
223 int afb_api_so_add_directory(const char *path, struct afb_apiset *apiset, int failstops)
226 char buffer[PATH_MAX];
228 length = strlen(path);
229 if (length >= sizeof(buffer)) {
230 ERROR("path too long %lu [%.99s...]", (unsigned long)length, path);
234 memcpy(buffer, path, length + 1);
235 return adddirs(buffer, length, apiset, failstops);
238 int afb_api_so_add_path(const char *path, struct afb_apiset *apiset, int failstops)
243 rc = stat(path, &st);
245 ERROR("Invalid binding path [%s]: %m", path);
246 else if (S_ISDIR(st.st_mode))
247 rc = afb_api_so_add_directory(path, apiset, failstops);
248 else if (strstr(path, ".so"))
249 rc = load_binding(path, 0, apiset);
251 INFO("not a binding [%s], skipped", path);
255 int afb_api_so_add_pathset(const char *pathset, struct afb_apiset *apiset, int failstops)
257 static char sep[] = ":";
261 ps = strdupa(pathset);
263 p = strsep(&ps, sep);
266 rc = afb_api_so_add_path(p, apiset, failstops);
272 int afb_api_so_add_pathset_fails(const char *pathset, struct afb_apiset *apiset)
274 return afb_api_so_add_pathset(pathset, apiset, 1);
277 int afb_api_so_add_pathset_nofails(const char *pathset, struct afb_apiset *apiset)
279 return afb_api_so_add_pathset(pathset, apiset, 0);