blob: 56df1a660442ad16087f11066643498004ac8d10 [file] [log] [blame]
jeffhaoacf5aa72012-09-12 17:25:30 -07001/*
2 * Copyright (C) 2012 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include <gtest/gtest.h>
18
19#include <dlfcn.h>
Elliott Hughes8e15b082012-09-26 11:44:01 -070020#include <libgen.h>
21#include <limits.h>
22#include <stdio.h>
23#include <stdint.h>
24
Dmitriy Ivanovb2a30ee2014-09-04 18:23:00 -070025#include "private/ScopeGuard.h"
26
Elliott Hughes8e15b082012-09-26 11:44:01 -070027#include <string>
jeffhaoacf5aa72012-09-12 17:25:30 -070028
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -070029#include "utils.h"
30
Elliott Hughes3b297c42012-10-11 16:08:51 -070031#define ASSERT_SUBSTR(needle, haystack) \
32 ASSERT_PRED_FORMAT2(::testing::IsSubstring, needle, haystack)
33
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -070034
Elliott Hughes1728b232014-05-14 10:02:03 -070035static bool g_called = false;
jeffhaoacf5aa72012-09-12 17:25:30 -070036extern "C" void DlSymTestFunction() {
Elliott Hughes1728b232014-05-14 10:02:03 -070037 g_called = true;
jeffhaoacf5aa72012-09-12 17:25:30 -070038}
39
Dmitriy Ivanovf8846a42014-07-08 21:21:34 -070040static int g_ctor_function_called = 0;
41
42extern "C" void ctor_function() __attribute__ ((constructor));
43
44extern "C" void ctor_function() {
45 g_ctor_function_called = 17;
46}
47
48TEST(dlfcn, ctor_function_call) {
49 ASSERT_EQ(17, g_ctor_function_called);
50}
51
Dmitriy Ivanov76ac1ac2015-04-01 14:45:10 -070052TEST(dlfcn, dlsym_in_executable) {
Elliott Hughes3b297c42012-10-11 16:08:51 -070053 dlerror(); // Clear any pending errors.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -070054 void* self = dlopen(nullptr, RTLD_NOW);
55 ASSERT_TRUE(self != nullptr);
56 ASSERT_TRUE(dlerror() == nullptr);
jeffhaoacf5aa72012-09-12 17:25:30 -070057
58 void* sym = dlsym(self, "DlSymTestFunction");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -070059 ASSERT_TRUE(sym != nullptr);
jeffhaoacf5aa72012-09-12 17:25:30 -070060
61 void (*function)() = reinterpret_cast<void(*)()>(sym);
62
Elliott Hughes1728b232014-05-14 10:02:03 -070063 g_called = false;
jeffhaoacf5aa72012-09-12 17:25:30 -070064 function();
Elliott Hughes1728b232014-05-14 10:02:03 -070065 ASSERT_TRUE(g_called);
Elliott Hughes1a696162012-11-01 13:49:32 -070066
67 ASSERT_EQ(0, dlclose(self));
jeffhaoacf5aa72012-09-12 17:25:30 -070068}
Elliott Hughes8e15b082012-09-26 11:44:01 -070069
Dmitriy Ivanov76ac1ac2015-04-01 14:45:10 -070070TEST(dlfcn, dlsym_from_sofile) {
71 void* handle = dlopen("libtest_dlsym_from_this.so", RTLD_LAZY | RTLD_LOCAL);
72 ASSERT_TRUE(handle != nullptr) << dlerror();
73
Dmitriy Ivanov697bd9f2015-05-12 11:12:27 -070074 // check that we can't find '_test_dlsym_symbol' via dlsym(RTLD_DEFAULT)
Dmitriy Ivanov76ac1ac2015-04-01 14:45:10 -070075 void* symbol = dlsym(RTLD_DEFAULT, "test_dlsym_symbol");
76 ASSERT_TRUE(symbol == nullptr);
77 ASSERT_SUBSTR("undefined symbol: test_dlsym_symbol", dlerror());
78
79 typedef int* (*fn_t)();
Dmitriy Ivanov697bd9f2015-05-12 11:12:27 -070080 fn_t lookup_dlsym_symbol_using_RTLD_DEFAULT =
81 reinterpret_cast<fn_t>(dlsym(handle, "lookup_dlsym_symbol_using_RTLD_DEFAULT"));
82 ASSERT_TRUE(lookup_dlsym_symbol_using_RTLD_DEFAULT != nullptr) << dlerror();
Dmitriy Ivanov76ac1ac2015-04-01 14:45:10 -070083
Dmitriy Ivanov697bd9f2015-05-12 11:12:27 -070084 int* ptr = lookup_dlsym_symbol_using_RTLD_DEFAULT();
Dmitriy Ivanov76ac1ac2015-04-01 14:45:10 -070085 ASSERT_TRUE(ptr != nullptr) << dlerror();
86 ASSERT_EQ(42, *ptr);
87
Dmitriy Ivanov697bd9f2015-05-12 11:12:27 -070088 fn_t lookup_dlsym_symbol2_using_RTLD_DEFAULT =
89 reinterpret_cast<fn_t>(dlsym(handle, "lookup_dlsym_symbol2_using_RTLD_DEFAULT"));
90 ASSERT_TRUE(lookup_dlsym_symbol2_using_RTLD_DEFAULT != nullptr) << dlerror();
91
92 ptr = lookup_dlsym_symbol2_using_RTLD_DEFAULT();
93 ASSERT_TRUE(ptr != nullptr) << dlerror();
94 ASSERT_EQ(44, *ptr);
95
96 fn_t lookup_dlsym_symbol_using_RTLD_NEXT =
97 reinterpret_cast<fn_t>(dlsym(handle, "lookup_dlsym_symbol_using_RTLD_NEXT"));
98 ASSERT_TRUE(lookup_dlsym_symbol_using_RTLD_NEXT != nullptr) << dlerror();
99
100 ptr = lookup_dlsym_symbol_using_RTLD_NEXT();
101 ASSERT_TRUE(ptr != nullptr) << dlerror();
102 ASSERT_EQ(43, *ptr);
103
Dmitriy Ivanov76ac1ac2015-04-01 14:45:10 -0700104 dlclose(handle);
105}
106
Dmitriy Ivanov697bd9f2015-05-12 11:12:27 -0700107TEST(dlfcn, dlsym_from_sofile_with_preload) {
108 void* preload = dlopen("libtest_dlsym_from_this_grandchild.so", RTLD_NOW | RTLD_LOCAL);
109 ASSERT_TRUE(preload != nullptr) << dlerror();
110
111 void* handle = dlopen("libtest_dlsym_from_this.so", RTLD_NOW | RTLD_LOCAL);
112 ASSERT_TRUE(handle != nullptr) << dlerror();
113
114 // check that we can't find '_test_dlsym_symbol' via dlsym(RTLD_DEFAULT)
115 void* symbol = dlsym(RTLD_DEFAULT, "test_dlsym_symbol");
116 ASSERT_TRUE(symbol == nullptr);
117 ASSERT_SUBSTR("undefined symbol: test_dlsym_symbol", dlerror());
118
119 typedef int* (*fn_t)();
120 fn_t lookup_dlsym_symbol_using_RTLD_DEFAULT =
121 reinterpret_cast<fn_t>(dlsym(handle, "lookup_dlsym_symbol_using_RTLD_DEFAULT"));
122 ASSERT_TRUE(lookup_dlsym_symbol_using_RTLD_DEFAULT != nullptr) << dlerror();
123
124 int* ptr = lookup_dlsym_symbol_using_RTLD_DEFAULT();
125 ASSERT_TRUE(ptr != nullptr) << dlerror();
126 ASSERT_EQ(42, *ptr);
127
128 fn_t lookup_dlsym_symbol2_using_RTLD_DEFAULT =
129 reinterpret_cast<fn_t>(dlsym(handle, "lookup_dlsym_symbol2_using_RTLD_DEFAULT"));
130 ASSERT_TRUE(lookup_dlsym_symbol2_using_RTLD_DEFAULT != nullptr) << dlerror();
131
132 ptr = lookup_dlsym_symbol2_using_RTLD_DEFAULT();
133 ASSERT_TRUE(ptr != nullptr) << dlerror();
134 ASSERT_EQ(44, *ptr);
135
136 fn_t lookup_dlsym_symbol_using_RTLD_NEXT =
137 reinterpret_cast<fn_t>(dlsym(handle, "lookup_dlsym_symbol_using_RTLD_NEXT"));
138 ASSERT_TRUE(lookup_dlsym_symbol_using_RTLD_NEXT != nullptr) << dlerror();
139
140 ptr = lookup_dlsym_symbol_using_RTLD_NEXT();
141 ASSERT_TRUE(ptr != nullptr) << dlerror();
142 ASSERT_EQ(43, *ptr);
143
144 dlclose(handle);
145 dlclose(preload);
146}
147
Dmitriy Ivanovf439b5a2015-05-30 13:04:39 -0700148TEST(dlfcn, dlsym_handle_global_sym) {
149 // check that we do not look into global group
150 // when looking up symbol by handle
151 void* handle = dlopen("libtest_empty.so", RTLD_NOW);
152 dlopen("libtest_with_dependency.so", RTLD_NOW | RTLD_GLOBAL);
153 void* sym = dlsym(handle, "getRandomNumber");
154 ASSERT_TRUE(sym == nullptr);
155 ASSERT_SUBSTR("undefined symbol: getRandomNumber", dlerror());
156
157 sym = dlsym(handle, "DlSymTestFunction");
158 ASSERT_TRUE(sym == nullptr);
159 ASSERT_SUBSTR("undefined symbol: DlSymTestFunction", dlerror());
160 dlclose(handle);
161}
162
Dmitriy Ivanovaa0f2bd2014-07-28 17:32:20 -0700163TEST(dlfcn, dlsym_with_dependencies) {
164 void* handle = dlopen("libtest_with_dependency.so", RTLD_NOW);
Dmitriy Ivanovf439b5a2015-05-30 13:04:39 -0700165 ASSERT_TRUE(handle != nullptr);
Dmitriy Ivanovaa0f2bd2014-07-28 17:32:20 -0700166 dlerror();
167 // This symbol is in DT_NEEDED library.
168 void* sym = dlsym(handle, "getRandomNumber");
Dmitriy Ivanovf439b5a2015-05-30 13:04:39 -0700169 ASSERT_TRUE(sym != nullptr) << dlerror();
Dmitriy Ivanovaa0f2bd2014-07-28 17:32:20 -0700170 int (*fn)(void);
171 fn = reinterpret_cast<int (*)(void)>(sym);
172 EXPECT_EQ(4, fn());
173 dlclose(handle);
174}
175
Dmitriy Ivanovb648a8a2014-05-19 15:06:58 -0700176TEST(dlfcn, dlopen_noload) {
177 void* handle = dlopen("libtest_simple.so", RTLD_NOW | RTLD_NOLOAD);
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700178 ASSERT_TRUE(handle == nullptr);
Dmitriy Ivanovb648a8a2014-05-19 15:06:58 -0700179 handle = dlopen("libtest_simple.so", RTLD_NOW);
180 void* handle2 = dlopen("libtest_simple.so", RTLD_NOW | RTLD_NOLOAD);
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700181 ASSERT_TRUE(handle != nullptr);
182 ASSERT_TRUE(handle2 != nullptr);
Dmitriy Ivanovb648a8a2014-05-19 15:06:58 -0700183 ASSERT_TRUE(handle == handle2);
184 ASSERT_EQ(0, dlclose(handle));
185 ASSERT_EQ(0, dlclose(handle2));
186}
187
Dmitriy Ivanov618f1a32015-03-17 20:06:36 -0700188TEST(dlfcn, dlopen_by_soname) {
189 static const char* soname = "libdlext_test_soname.so";
190 static const char* filename = "libdlext_test_different_soname.so";
191 // 1. Make sure there is no library with soname in default search path
192 void* handle = dlopen(soname, RTLD_NOW);
193 ASSERT_TRUE(handle == nullptr);
194
195 // 2. Load a library using filename
196 handle = dlopen(filename, RTLD_NOW);
197 ASSERT_TRUE(handle != nullptr) << dlerror();
198
199 // 3. Find library by soname
200 void* handle_soname = dlopen(soname, RTLD_NOW | RTLD_NOLOAD);
201 ASSERT_TRUE(handle_soname != nullptr) << dlerror();
202 ASSERT_EQ(handle, handle_soname);
203
204 // 4. RTLD_NOLOAD should still work with filename
205 void* handle_filename = dlopen(filename, RTLD_NOW | RTLD_NOLOAD);
206 ASSERT_TRUE(handle_filename != nullptr) << dlerror();
207 ASSERT_EQ(handle, handle_filename);
208
209 dlclose(handle_filename);
210 dlclose(handle_soname);
211 dlclose(handle);
212}
213
Dimitry Ivanov0a2ab022016-04-05 17:12:01 -0700214// mips doesn't support ifuncs
215#if !defined(__mips__)
Brigid Smithc5a13ef2014-07-23 11:22:25 -0700216TEST(dlfcn, ifunc) {
Dmitriy Ivanov9598b8c2014-08-21 13:54:03 -0700217 typedef const char* (*fn_ptr)();
Brigid Smithc5a13ef2014-07-23 11:22:25 -0700218
219 // ifunc's choice depends on whether IFUNC_CHOICE has a value
220 // first check the set case
221 setenv("IFUNC_CHOICE", "set", 1);
222 void* handle = dlopen("libtest_ifunc.so", RTLD_NOW);
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700223 ASSERT_TRUE(handle != nullptr);
Dmitriy Ivanov9598b8c2014-08-21 13:54:03 -0700224 fn_ptr foo_ptr = reinterpret_cast<fn_ptr>(dlsym(handle, "foo"));
225 fn_ptr foo_library_ptr = reinterpret_cast<fn_ptr>(dlsym(handle, "foo_library"));
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700226 ASSERT_TRUE(foo_ptr != nullptr);
227 ASSERT_TRUE(foo_library_ptr != nullptr);
Dmitriy Ivanov9598b8c2014-08-21 13:54:03 -0700228 ASSERT_EQ(strncmp("set", foo_ptr(), 3), 0);
229 ASSERT_EQ(strncmp("set", foo_library_ptr(), 3), 0);
Brigid Smithc5a13ef2014-07-23 11:22:25 -0700230 dlclose(handle);
231
232 // then check the unset case
233 unsetenv("IFUNC_CHOICE");
234 handle = dlopen("libtest_ifunc.so", RTLD_NOW);
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700235 ASSERT_TRUE(handle != nullptr);
Dmitriy Ivanov9598b8c2014-08-21 13:54:03 -0700236 foo_ptr = reinterpret_cast<fn_ptr>(dlsym(handle, "foo"));
237 foo_library_ptr = reinterpret_cast<fn_ptr>(dlsym(handle, "foo_library"));
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700238 ASSERT_TRUE(foo_ptr != nullptr);
239 ASSERT_TRUE(foo_library_ptr != nullptr);
Dmitriy Ivanov9598b8c2014-08-21 13:54:03 -0700240 ASSERT_EQ(strncmp("unset", foo_ptr(), 5), 0);
241 ASSERT_EQ(strncmp("unset", foo_library_ptr(), 3), 0);
242 dlclose(handle);
243}
244
245TEST(dlfcn, ifunc_ctor_call) {
246 typedef const char* (*fn_ptr)();
247
248 void* handle = dlopen("libtest_ifunc.so", RTLD_NOW);
Dmitriy Ivanov9aea1642014-09-11 15:16:03 -0700249 ASSERT_TRUE(handle != nullptr) << dlerror();
250 fn_ptr is_ctor_called = reinterpret_cast<fn_ptr>(dlsym(handle, "is_ctor_called_irelative"));
251 ASSERT_TRUE(is_ctor_called != nullptr) << dlerror();
252 ASSERT_STREQ("false", is_ctor_called());
253
254 is_ctor_called = reinterpret_cast<fn_ptr>(dlsym(handle, "is_ctor_called_jump_slot"));
255 ASSERT_TRUE(is_ctor_called != nullptr) << dlerror();
Dmitriy Ivanov9598b8c2014-08-21 13:54:03 -0700256 ASSERT_STREQ("true", is_ctor_called());
Brigid Smithc5a13ef2014-07-23 11:22:25 -0700257 dlclose(handle);
258}
Dimitry Ivanovba35b2d2016-04-08 11:47:53 -0700259
260TEST(dlfcn, ifunc_ctor_call_rtld_lazy) {
261 typedef const char* (*fn_ptr)();
262
263 void* handle = dlopen("libtest_ifunc.so", RTLD_LAZY);
264 ASSERT_TRUE(handle != nullptr) << dlerror();
265 fn_ptr is_ctor_called = reinterpret_cast<fn_ptr>(dlsym(handle, "is_ctor_called_irelative"));
266 ASSERT_TRUE(is_ctor_called != nullptr) << dlerror();
267 ASSERT_STREQ("false", is_ctor_called());
268
269 is_ctor_called = reinterpret_cast<fn_ptr>(dlsym(handle, "is_ctor_called_jump_slot"));
270 ASSERT_TRUE(is_ctor_called != nullptr) << dlerror();
271 ASSERT_STREQ("true", is_ctor_called());
272 dlclose(handle);
273}
Dimitry Ivanov0a2ab022016-04-05 17:12:01 -0700274#endif
Brigid Smithc5a13ef2014-07-23 11:22:25 -0700275
Dmitriy Ivanovb2a30ee2014-09-04 18:23:00 -0700276TEST(dlfcn, dlopen_check_relocation_dt_needed_order) {
277 // This is the structure of the test library and
278 // its dt_needed libraries
279 // libtest_relo_check_dt_needed_order.so
280 // |
281 // +-> libtest_relo_check_dt_needed_order_1.so
282 // |
283 // +-> libtest_relo_check_dt_needed_order_2.so
284 //
285 // The root library references relo_test_get_answer_lib - which is defined
286 // in both dt_needed libraries, the correct relocation should
287 // use the function defined in libtest_relo_check_dt_needed_order_1.so
288 void* handle = nullptr;
Dmitriy Ivanovd9ff7222014-09-08 16:22:22 -0700289 auto guard = make_scope_guard([&]() {
Dmitriy Ivanovb2a30ee2014-09-04 18:23:00 -0700290 dlclose(handle);
291 });
292
293 handle = dlopen("libtest_relo_check_dt_needed_order.so", RTLD_NOW);
294 ASSERT_TRUE(handle != nullptr) << dlerror();
295
296 typedef int (*fn_t) (void);
297 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "relo_test_get_answer"));
298 ASSERT_TRUE(fn != nullptr) << dlerror();
299 ASSERT_EQ(1, fn());
300}
301
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700302TEST(dlfcn, dlopen_check_order_dlsym) {
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700303 // Here is how the test library and its dt_needed
304 // libraries are arranged
305 //
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700306 // libtest_check_order_children.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700307 // |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700308 // +-> ..._1_left.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700309 // | |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700310 // | +-> ..._a.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700311 // | |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700312 // | +-> ...r_b.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700313 // |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700314 // +-> ..._2_right.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700315 // | |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700316 // | +-> ..._d.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700317 // | |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700318 // | +-> ..._b.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700319 // |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700320 // +-> ..._3_c.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700321 //
322 // load order should be (1, 2, 3, a, b, d)
323 //
324 // get_answer() is defined in (2, 3, a, b, c)
325 // get_answer2() is defined in (b, d)
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700326 void* sym = dlsym(RTLD_DEFAULT, "check_order_dlsym_get_answer");
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700327 ASSERT_TRUE(sym == nullptr);
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700328 void* handle = dlopen("libtest_check_order_dlsym.so", RTLD_NOW | RTLD_GLOBAL);
329 ASSERT_TRUE(handle != nullptr) << dlerror();
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700330 typedef int (*fn_t) (void);
331 fn_t fn, fn2;
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700332 fn = reinterpret_cast<fn_t>(dlsym(RTLD_DEFAULT, "check_order_dlsym_get_answer"));
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700333 ASSERT_TRUE(fn != nullptr) << dlerror();
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700334 fn2 = reinterpret_cast<fn_t>(dlsym(RTLD_DEFAULT, "check_order_dlsym_get_answer2"));
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700335 ASSERT_TRUE(fn2 != nullptr) << dlerror();
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700336
337 ASSERT_EQ(42, fn());
338 ASSERT_EQ(43, fn2());
339 dlclose(handle);
340}
341
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700342TEST(dlfcn, dlopen_check_order_reloc_siblings) {
343 // This is how this one works:
344 // we lookup and call get_answer which is defined in '_2.so'
345 // and in turn calls external get_answer_impl() defined in _1.so and in '_[a-f].so'
346 // the correct _impl() is implemented by '_a.so';
347 //
348 // Note that this is test for RTLD_LOCAL (TODO: test for GLOBAL?)
349 //
350 // Here is the picture:
351 //
352 // libtest_check_order_reloc_siblings.so
353 // |
354 // +-> ..._1.so <- empty
355 // | |
356 // | +-> ..._a.so <- exports correct answer_impl()
357 // | |
358 // | +-> ..._b.so <- every other letter exporting incorrect one.
359 // |
360 // +-> ..._2.so <- empty
361 // | |
362 // | +-> ..._c.so
363 // | |
364 // | +-> ..._d.so
365 // |
366 // +-> ..._3.so <- empty
367 // |
368 // +-> ..._e.so
369 // |
370 // +-> ..._f.so <- exports get_answer() that calls get_anser_impl();
371 // implements incorrect get_answer_impl()
372
373 void* handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_NOLOAD);
374 ASSERT_TRUE(handle == nullptr);
375#ifdef __BIONIC__
376 // TODO: glibc returns nullptr on dlerror() here. Is it bug?
377 ASSERT_STREQ("dlopen failed: library \"libtest_check_order_reloc_siblings.so\" wasn't loaded and RTLD_NOLOAD prevented it", dlerror());
378#endif
379
380 handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_LOCAL);
381 ASSERT_TRUE(handle != nullptr) << dlerror();
382
383 typedef int (*fn_t) (void);
384 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "check_order_reloc_get_answer"));
385 ASSERT_TRUE(fn != nullptr) << dlerror();
386 ASSERT_EQ(42, fn());
387
388 ASSERT_EQ(0, dlclose(handle));
389}
390
391TEST(dlfcn, dlopen_check_order_reloc_siblings_with_preload) {
392 // This test uses the same library as dlopen_check_order_reloc_siblings.
393 // Unlike dlopen_check_order_reloc_siblings it preloads
394 // libtest_check_order_reloc_siblings_1.so (first dependency) prior to
395 // dlopen(libtest_check_order_reloc_siblings.so)
396
397 void* handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_NOLOAD);
398 ASSERT_TRUE(handle == nullptr);
399 handle = dlopen("libtest_check_order_reloc_siblings_1.so", RTLD_NOW | RTLD_NOLOAD);
400 ASSERT_TRUE(handle == nullptr);
401
402 void* handle_for_1 = dlopen("libtest_check_order_reloc_siblings_1.so", RTLD_NOW | RTLD_LOCAL);
403 ASSERT_TRUE(handle_for_1 != nullptr) << dlerror();
404
405 handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_LOCAL);
406 ASSERT_TRUE(handle != nullptr) << dlerror();
407
408 ASSERT_EQ(0, dlclose(handle_for_1));
409
410 typedef int (*fn_t) (void);
411 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "check_order_reloc_get_answer"));
412 ASSERT_TRUE(fn != nullptr) << dlerror();
413 ASSERT_EQ(42, fn());
414
415 ASSERT_EQ(0, dlclose(handle));
416}
417
Dmitriy Ivanov7699d132014-11-18 17:26:31 -0800418TEST(dlfcn, dlopen_check_order_reloc_grandchild) {
419 // This is how this one works:
420 // we lookup and call grandchild_get_answer which is defined in '_2.so'
421 // and in turn calls external get_answer_impl() defined in '_c_1.so and _c_2.so'
422 // the correct _impl() is implemented by '_c_1.so';
423 //
424 // Here is the picture of subtree:
425 //
426 // libtest_check_order_reloc_siblings.so
427 // |
428 // +-> ..._2.so <- grandchild_get_answer()
429 // |
430 // +-> ..._c.so <- empty
431 // | |
432 // | +-> _c_1.so <- exports correct answer_impl()
433 // | |
434 // | +-> _c_2.so <- exports incorrect answer_impl()
435 // |
436 // +-> ..._d.so <- empty
437
438 void* handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_NOLOAD);
439 ASSERT_TRUE(handle == nullptr);
440#ifdef __BIONIC__
441 // TODO: glibc returns nullptr on dlerror() here. Is it bug?
442 ASSERT_STREQ("dlopen failed: library \"libtest_check_order_reloc_siblings.so\" wasn't loaded and RTLD_NOLOAD prevented it", dlerror());
443#endif
444
445 handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_LOCAL);
446 ASSERT_TRUE(handle != nullptr) << dlerror();
447
448 typedef int (*fn_t) (void);
449 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "check_order_reloc_grandchild_get_answer"));
450 ASSERT_TRUE(fn != nullptr) << dlerror();
451 ASSERT_EQ(42, fn());
452
453 ASSERT_EQ(0, dlclose(handle));
454}
455
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700456TEST(dlfcn, dlopen_check_order_reloc_nephew) {
457 // This is how this one works:
458 // we lookup and call nephew_get_answer which is defined in '_2.so'
459 // and in turn calls external get_answer_impl() defined in '_[a-f].so'
460 // the correct _impl() is implemented by '_a.so';
461 //
462 // Here is the picture:
463 //
464 // libtest_check_order_reloc_siblings.so
465 // |
466 // +-> ..._1.so <- empty
467 // | |
468 // | +-> ..._a.so <- exports correct answer_impl()
469 // | |
470 // | +-> ..._b.so <- every other letter exporting incorrect one.
471 // |
472 // +-> ..._2.so <- empty
473 // | |
474 // | +-> ..._c.so
475 // | |
476 // | +-> ..._d.so
477 // |
478 // +-> ..._3.so <- nephew_get_answer() that calls get_answer_impl();
479 // |
480 // +-> ..._e.so
481 // |
482 // +-> ..._f.so
483
484 void* handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_NOLOAD);
485 ASSERT_TRUE(handle == nullptr);
486#ifdef __BIONIC__
487 // TODO: glibc returns nullptr on dlerror() here. Is it bug?
488 ASSERT_STREQ("dlopen failed: library \"libtest_check_order_reloc_siblings.so\" wasn't loaded and RTLD_NOLOAD prevented it", dlerror());
489#endif
490
491 handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_LOCAL);
492 ASSERT_TRUE(handle != nullptr) << dlerror();
493
494 typedef int (*fn_t) (void);
495 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "check_order_reloc_nephew_get_answer"));
496 ASSERT_TRUE(fn != nullptr) << dlerror();
497 ASSERT_EQ(42, fn());
498
499 ASSERT_EQ(0, dlclose(handle));
500}
501
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800502TEST(dlfcn, check_unload_after_reloc) {
503 // This is how this one works:
504 // libtest_two_parents_parent1 <- answer_impl() used by libtest_two_parents_child
505 // |
506 // +-> libtest_two_parents_child
507 //
508 // libtest_two_parents_parent2 <- answer_impl() not used by libtest_two_parents_child
509 // |
510 // +-> libtest_two_parents_child
511 //
512 // Test dlopens parent1 which loads and relocates libtest_two_parents_child.so
513 // as a second step it dlopens parent2 and dlcloses parent1...
514
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700515 void* handle = dlopen("libtest_two_parents_parent1.so", RTLD_NOW | RTLD_LOCAL);
516 ASSERT_TRUE(handle != nullptr) << dlerror();
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800517
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700518 void* handle2 = dlopen("libtest_two_parents_parent2.so", RTLD_NOW | RTLD_LOCAL);
519 ASSERT_TRUE(handle2 != nullptr) << dlerror();
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800520
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700521 typedef int (*fn_t) (void);
522 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle2, "check_order_reloc_get_answer"));
523 ASSERT_TRUE(fn != nullptr) << dlerror();
524 ASSERT_EQ(42, fn());
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800525
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700526 ASSERT_EQ(0, dlclose(handle));
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800527
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700528 handle = dlopen("libtest_two_parents_parent1.so", RTLD_NOW | RTLD_LOCAL | RTLD_NOLOAD);
529 ASSERT_TRUE(handle != nullptr);
530 ASSERT_EQ(0, dlclose(handle));
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800531
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700532 fn = reinterpret_cast<fn_t>(dlsym(handle2, "check_order_reloc_get_answer"));
533 ASSERT_TRUE(fn != nullptr) << dlerror();
534 ASSERT_EQ(42, fn());
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800535
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700536 ASSERT_EQ(0, dlclose(handle2));
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800537
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700538 handle = dlopen("libtest_two_parents_parent1.so", RTLD_NOW | RTLD_LOCAL | RTLD_NOLOAD);
539 ASSERT_TRUE(handle == nullptr);
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800540}
541
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700542extern "C" int check_order_reloc_root_get_answer_impl() {
543 return 42;
544}
545
546TEST(dlfcn, dlopen_check_order_reloc_main_executable) {
547 // This is how this one works:
548 // we lookup and call get_answer3 which is defined in 'root.so'
549 // and in turn calls external root_get_answer_impl() defined in _2.so and
550 // above the correct _impl() is one in the executable.
551 //
552 // libtest_check_order_reloc_root.so
553 // |
554 // +-> ..._1.so <- empty
555 // |
556 // +-> ..._2.so <- gives incorrect answer for answer_main_impl()
557 //
558
559 void* handle = dlopen("libtest_check_order_reloc_root.so", RTLD_NOW | RTLD_NOLOAD);
560 ASSERT_TRUE(handle == nullptr);
561#ifdef __BIONIC__
562 // TODO: glibc returns nullptr on dlerror() here. Is it bug?
563 ASSERT_STREQ("dlopen failed: library \"libtest_check_order_reloc_root.so\" wasn't loaded and RTLD_NOLOAD prevented it", dlerror());
564#endif
565
566 handle = dlopen("libtest_check_order_reloc_root.so", RTLD_NOW | RTLD_LOCAL);
567 ASSERT_TRUE(handle != nullptr) << dlerror();
568
569 typedef int (*fn_t) (void);
570 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "check_order_reloc_root_get_answer"));
571 ASSERT_TRUE(fn != nullptr) << dlerror();
572 ASSERT_EQ(42, fn());
573
574 ASSERT_EQ(0, dlclose(handle));
575}
576
Dmitriy Ivanove8ba50f2014-09-15 17:00:10 -0700577TEST(dlfcn, dlopen_check_rtld_local) {
578 void* sym = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
579 ASSERT_TRUE(sym == nullptr);
580
581 // implicit RTLD_LOCAL
582 void* handle = dlopen("libtest_simple.so", RTLD_NOW);
583 sym = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
584 ASSERT_TRUE(sym == nullptr);
585 ASSERT_SUBSTR("undefined symbol: dlopen_testlib_simple_func", dlerror());
586 sym = dlsym(handle, "dlopen_testlib_simple_func");
587 ASSERT_TRUE(sym != nullptr);
588 ASSERT_TRUE(reinterpret_cast<bool (*)(void)>(sym)());
589 dlclose(handle);
590
591 // explicit RTLD_LOCAL
592 handle = dlopen("libtest_simple.so", RTLD_NOW | RTLD_LOCAL);
593 sym = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
594 ASSERT_TRUE(sym == nullptr);
595 ASSERT_SUBSTR("undefined symbol: dlopen_testlib_simple_func", dlerror());
596 sym = dlsym(handle, "dlopen_testlib_simple_func");
597 ASSERT_TRUE(sym != nullptr);
598 ASSERT_TRUE(reinterpret_cast<bool (*)(void)>(sym)());
599 dlclose(handle);
600}
601
602TEST(dlfcn, dlopen_check_rtld_global) {
603 void* sym = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
604 ASSERT_TRUE(sym == nullptr);
605
606 void* handle = dlopen("libtest_simple.so", RTLD_NOW | RTLD_GLOBAL);
Dmitriy Ivanov1b20daf2014-05-19 15:06:58 -0700607 ASSERT_TRUE(handle != nullptr) << dlerror();
Dmitriy Ivanove8ba50f2014-09-15 17:00:10 -0700608 sym = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
609 ASSERT_TRUE(sym != nullptr) << dlerror();
610 ASSERT_TRUE(reinterpret_cast<bool (*)(void)>(sym)());
611 dlclose(handle);
Dmitriy Ivanov1b20daf2014-05-19 15:06:58 -0700612
613 // RTLD_GLOBAL implies RTLD_NODELETE, let's check that
614 void* sym_after_dlclose = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
615 ASSERT_EQ(sym, sym_after_dlclose);
Dmitriy Ivanovf439b5a2015-05-30 13:04:39 -0700616
617 // Check if dlsym() for main program's handle searches RTLD_GLOBAL
618 // shared libraries after symbol was not found in the main executable
619 // and dependent libraries.
620 void* handle_for_main_executable = dlopen(nullptr, RTLD_NOW);
621 sym = dlsym(handle_for_main_executable, "dlopen_testlib_simple_func");
622 ASSERT_TRUE(sym != nullptr) << dlerror();
623
624 dlclose(handle_for_main_executable);
Dmitriy Ivanove8ba50f2014-09-15 17:00:10 -0700625}
626
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700627// libtest_with_dependency_loop.so -> libtest_with_dependency_loop_a.so ->
628// libtest_with_dependency_loop_b.so -> libtest_with_dependency_loop_c.so ->
629// libtest_with_dependency_loop_a.so
630TEST(dlfcn, dlopen_check_loop) {
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700631 void* handle = dlopen("libtest_with_dependency_loop.so", RTLD_NOW);
632 ASSERT_TRUE(handle != nullptr) << dlerror();
633 void* f = dlsym(handle, "dlopen_test_loopy_function");
634 ASSERT_TRUE(f != nullptr) << dlerror();
635 EXPECT_TRUE(reinterpret_cast<bool (*)(void)>(f)());
636 ASSERT_EQ(0, dlclose(handle));
Dmitriy Ivanova6ac54a2014-09-09 10:21:42 -0700637
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700638 // dlopen second time to make sure that the library was unloaded correctly
639 handle = dlopen("libtest_with_dependency_loop.so", RTLD_NOW | RTLD_NOLOAD);
640 ASSERT_TRUE(handle == nullptr);
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800641#ifdef __BIONIC__
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700642 ASSERT_STREQ("dlopen failed: library \"libtest_with_dependency_loop.so\" wasn't loaded and RTLD_NOLOAD prevented it", dlerror());
Dimitry Ivanov9cf99cb2015-12-11 14:22:24 -0800643#else
644 // TODO: glibc returns nullptr on dlerror() here. Is it bug?
645 ASSERT_TRUE(dlerror() == nullptr);
Dmitriy Ivanoveb27bba2014-09-15 14:13:24 -0700646#endif
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800647
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700648 handle = dlopen("libtest_with_dependency_a.so", RTLD_NOW | RTLD_NOLOAD);
649 ASSERT_TRUE(handle == nullptr);
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700650}
651
Dmitriy Ivanov1b20daf2014-05-19 15:06:58 -0700652TEST(dlfcn, dlopen_nodelete) {
653 static bool is_unloaded = false;
654
655 void* handle = dlopen("libtest_nodelete_1.so", RTLD_NOW | RTLD_NODELETE);
656 ASSERT_TRUE(handle != nullptr) << dlerror();
657 void (*set_unload_flag_ptr)(bool*);
658 set_unload_flag_ptr = reinterpret_cast<void (*)(bool*)>(dlsym(handle, "dlopen_nodelete_1_set_unload_flag_ptr"));
659 ASSERT_TRUE(set_unload_flag_ptr != nullptr) << dlerror();
660 set_unload_flag_ptr(&is_unloaded);
661
662 uint32_t* taxicab_number = reinterpret_cast<uint32_t*>(dlsym(handle, "dlopen_nodelete_1_taxicab_number"));
663 ASSERT_TRUE(taxicab_number != nullptr) << dlerror();
664 ASSERT_EQ(1729U, *taxicab_number);
665 *taxicab_number = 2;
666
667 dlclose(handle);
668 ASSERT_TRUE(!is_unloaded);
669
670 uint32_t* taxicab_number_after_dlclose = reinterpret_cast<uint32_t*>(dlsym(handle, "dlopen_nodelete_1_taxicab_number"));
671 ASSERT_EQ(taxicab_number_after_dlclose, taxicab_number);
672 ASSERT_EQ(2U, *taxicab_number_after_dlclose);
673
674
675 handle = dlopen("libtest_nodelete_1.so", RTLD_NOW);
676 uint32_t* taxicab_number2 = reinterpret_cast<uint32_t*>(dlsym(handle, "dlopen_nodelete_1_taxicab_number"));
677 ASSERT_EQ(taxicab_number2, taxicab_number);
678
679 ASSERT_EQ(2U, *taxicab_number2);
680
681 dlclose(handle);
682 ASSERT_TRUE(!is_unloaded);
683}
684
685TEST(dlfcn, dlopen_nodelete_on_second_dlopen) {
686 static bool is_unloaded = false;
687
688 void* handle = dlopen("libtest_nodelete_2.so", RTLD_NOW);
689 ASSERT_TRUE(handle != nullptr) << dlerror();
690 void (*set_unload_flag_ptr)(bool*);
691 set_unload_flag_ptr = reinterpret_cast<void (*)(bool*)>(dlsym(handle, "dlopen_nodelete_2_set_unload_flag_ptr"));
692 ASSERT_TRUE(set_unload_flag_ptr != nullptr) << dlerror();
693 set_unload_flag_ptr(&is_unloaded);
694
695 uint32_t* taxicab_number = reinterpret_cast<uint32_t*>(dlsym(handle, "dlopen_nodelete_2_taxicab_number"));
696 ASSERT_TRUE(taxicab_number != nullptr) << dlerror();
697
698 ASSERT_EQ(1729U, *taxicab_number);
699 *taxicab_number = 2;
700
701 // This RTLD_NODELETE should be ignored
702 void* handle1 = dlopen("libtest_nodelete_2.so", RTLD_NOW | RTLD_NODELETE);
703 ASSERT_TRUE(handle1 != nullptr) << dlerror();
704 ASSERT_EQ(handle, handle1);
705
706 dlclose(handle1);
707 dlclose(handle);
708
709 ASSERT_TRUE(is_unloaded);
710}
711
712TEST(dlfcn, dlopen_nodelete_dt_flags_1) {
713 static bool is_unloaded = false;
714
715 void* handle = dlopen("libtest_nodelete_dt_flags_1.so", RTLD_NOW);
716 ASSERT_TRUE(handle != nullptr) << dlerror();
717 void (*set_unload_flag_ptr)(bool*);
718 set_unload_flag_ptr = reinterpret_cast<void (*)(bool*)>(dlsym(handle, "dlopen_nodelete_dt_flags_1_set_unload_flag_ptr"));
719 ASSERT_TRUE(set_unload_flag_ptr != nullptr) << dlerror();
720 set_unload_flag_ptr(&is_unloaded);
721
722 dlclose(handle);
723 ASSERT_TRUE(!is_unloaded);
724}
725
Dmitriy Ivanovd225a5e2014-08-28 14:12:12 -0700726TEST(dlfcn, dlsym_df_1_global) {
Dmitriy Ivanovd225a5e2014-08-28 14:12:12 -0700727 void* handle = dlopen("libtest_dlsym_df_1_global.so", RTLD_NOW);
728 ASSERT_TRUE(handle != nullptr) << dlerror();
729 int (*get_answer)();
730 get_answer = reinterpret_cast<int (*)()>(dlsym(handle, "dl_df_1_global_get_answer"));
731 ASSERT_TRUE(get_answer != nullptr) << dlerror();
732 ASSERT_EQ(42, get_answer());
733 ASSERT_EQ(0, dlclose(handle));
Dmitriy Ivanovd225a5e2014-08-28 14:12:12 -0700734}
735
Elliott Hughese66190d2012-12-18 15:57:55 -0800736TEST(dlfcn, dlopen_failure) {
Elliott Hughes3b297c42012-10-11 16:08:51 -0700737 void* self = dlopen("/does/not/exist", RTLD_NOW);
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700738 ASSERT_TRUE(self == nullptr);
Elliott Hughes063525c2014-05-13 11:19:57 -0700739#if defined(__BIONIC__)
Elliott Hughes3b297c42012-10-11 16:08:51 -0700740 ASSERT_STREQ("dlopen failed: library \"/does/not/exist\" not found", dlerror());
741#else
742 ASSERT_STREQ("/does/not/exist: cannot open shared object file: No such file or directory", dlerror());
743#endif
744}
745
Elliott Hughesad88a082012-10-24 18:37:21 -0700746static void* ConcurrentDlErrorFn(void*) {
Elliott Hughes5419b942012-10-16 15:54:46 -0700747 dlopen("/child/thread", RTLD_NOW);
748 return reinterpret_cast<void*>(strdup(dlerror()));
749}
750
Elliott Hughese66190d2012-12-18 15:57:55 -0800751TEST(dlfcn, dlerror_concurrent) {
Elliott Hughes5419b942012-10-16 15:54:46 -0700752 dlopen("/main/thread", RTLD_NOW);
753 const char* main_thread_error = dlerror();
754 ASSERT_SUBSTR("/main/thread", main_thread_error);
755
756 pthread_t t;
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700757 ASSERT_EQ(0, pthread_create(&t, nullptr, ConcurrentDlErrorFn, nullptr));
Elliott Hughes5419b942012-10-16 15:54:46 -0700758 void* result;
759 ASSERT_EQ(0, pthread_join(t, &result));
760 char* child_thread_error = static_cast<char*>(result);
761 ASSERT_SUBSTR("/child/thread", child_thread_error);
762 free(child_thread_error);
763
764 ASSERT_SUBSTR("/main/thread", main_thread_error);
765}
766
Elliott Hughese66190d2012-12-18 15:57:55 -0800767TEST(dlfcn, dlsym_failures) {
Elliott Hughes3b297c42012-10-11 16:08:51 -0700768 dlerror(); // Clear any pending errors.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700769 void* self = dlopen(nullptr, RTLD_NOW);
770 ASSERT_TRUE(self != nullptr);
771 ASSERT_TRUE(dlerror() == nullptr);
Elliott Hughes3b297c42012-10-11 16:08:51 -0700772
773 void* sym;
774
Dmitriy Ivanov44adf932014-05-22 09:49:24 -0700775#if defined(__BIONIC__) && !defined(__LP64__)
776 // RTLD_DEFAULT in lp32 bionic is not (void*)0
777 // so it can be distinguished from the NULL handle.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700778 sym = dlsym(nullptr, "test");
779 ASSERT_TRUE(sym == nullptr);
Dimitry Ivanov4a2c5aa2015-12-10 16:08:14 -0800780 ASSERT_STREQ("dlsym failed: library handle is null", dlerror());
Elliott Hughes3b297c42012-10-11 16:08:51 -0700781#endif
782
Elliott Hughes3b297c42012-10-11 16:08:51 -0700783 // Symbol that doesn't exist.
784 sym = dlsym(self, "ThisSymbolDoesNotExist");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700785 ASSERT_TRUE(sym == nullptr);
Elliott Hughes3b297c42012-10-11 16:08:51 -0700786 ASSERT_SUBSTR("undefined symbol: ThisSymbolDoesNotExist", dlerror());
Elliott Hughes1a696162012-11-01 13:49:32 -0700787
788 ASSERT_EQ(0, dlclose(self));
Elliott Hughes3b297c42012-10-11 16:08:51 -0700789}
790
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700791TEST(dlfcn, dladdr_executable) {
Elliott Hughes3b297c42012-10-11 16:08:51 -0700792 dlerror(); // Clear any pending errors.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700793 void* self = dlopen(nullptr, RTLD_NOW);
794 ASSERT_TRUE(self != nullptr);
795 ASSERT_TRUE(dlerror() == nullptr);
Elliott Hughes8e15b082012-09-26 11:44:01 -0700796
797 void* sym = dlsym(self, "DlSymTestFunction");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700798 ASSERT_TRUE(sym != nullptr);
Elliott Hughes8e15b082012-09-26 11:44:01 -0700799
800 // Deliberately ask dladdr for an address inside a symbol, rather than the symbol base address.
801 void* addr = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(sym) + 2);
802
803 Dl_info info;
804 int rc = dladdr(addr, &info);
805 ASSERT_NE(rc, 0); // Zero on error, non-zero on success.
806
807 // Get the name of this executable.
Dimitry Ivanov2ba1cf32016-05-17 13:29:37 -0700808 const std::string& executable_path = get_executable_path();
Elliott Hughes8e15b082012-09-26 11:44:01 -0700809
810 // The filename should be that of this executable.
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700811 char dli_realpath[PATH_MAX];
812 ASSERT_TRUE(realpath(info.dli_fname, dli_realpath) != nullptr);
Dimitry Ivanov2ba1cf32016-05-17 13:29:37 -0700813 ASSERT_STREQ(executable_path.c_str(), dli_realpath);
Elliott Hughes8e15b082012-09-26 11:44:01 -0700814
815 // The symbol name should be the symbol we looked up.
816 ASSERT_STREQ(info.dli_sname, "DlSymTestFunction");
817
818 // The address should be the exact address of the symbol.
819 ASSERT_EQ(info.dli_saddr, sym);
820
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700821 std::vector<map_record> maps;
822 ASSERT_TRUE(Maps::parse_maps(&maps));
823
824 void* base_address = nullptr;
825 for (const map_record& rec : maps) {
826 if (executable_path == rec.pathname) {
827 base_address = reinterpret_cast<void*>(rec.addr_start);
Elliott Hughes8e15b082012-09-26 11:44:01 -0700828 break;
829 }
830 }
Elliott Hughes8e15b082012-09-26 11:44:01 -0700831
832 // The base address should be the address we were loaded at.
833 ASSERT_EQ(info.dli_fbase, base_address);
Elliott Hughes1a696162012-11-01 13:49:32 -0700834
835 ASSERT_EQ(0, dlclose(self));
Elliott Hughes8e15b082012-09-26 11:44:01 -0700836}
837
Dimitry Ivanov2ba1cf32016-05-17 13:29:37 -0700838TEST(dlfcn, dlopen_executable_by_absolute_path) {
839 void* handle1 = dlopen(nullptr, RTLD_NOW);
840 ASSERT_TRUE(handle1 != nullptr) << dlerror();
841
842 void* handle2 = dlopen(get_executable_path().c_str(), RTLD_NOW);
843 ASSERT_TRUE(handle2 != nullptr) << dlerror();
844
845#if defined(__BIONIC__)
846 ASSERT_EQ(handle1, handle2);
847#else
848 GTEST_LOG_(INFO) << "Skipping ASSERT_EQ(handle1, handle2) for glibc: "
849 "it loads a separate copy of the main executable "
850 "on dlopen by absolute path.";
851#endif
852}
853
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700854#if defined(__LP64__)
Lazar Trsic6f2d3102015-10-13 16:43:00 +0200855#define PATH_TO_SYSTEM_LIB "/system/lib64/"
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700856#else
Lazar Trsic6f2d3102015-10-13 16:43:00 +0200857#define PATH_TO_SYSTEM_LIB "/system/lib/"
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700858#endif
Lazar Trsic6f2d3102015-10-13 16:43:00 +0200859#define PATH_TO_LIBC PATH_TO_SYSTEM_LIB "libc.so"
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700860
861TEST(dlfcn, dladdr_libc) {
862#if defined(__BIONIC__)
863 Dl_info info;
864 void* addr = reinterpret_cast<void*>(puts); // well-known libc function
865 ASSERT_TRUE(dladdr(addr, &info) != 0);
866
Dmitriy Ivanovef255922015-04-08 11:53:08 -0700867 // /system/lib is symlink when this test is executed on host.
868 char libc_realpath[PATH_MAX];
Lazar Trsic6f2d3102015-10-13 16:43:00 +0200869 ASSERT_TRUE(realpath(PATH_TO_LIBC, libc_realpath) == libc_realpath);
Dmitriy Ivanovef255922015-04-08 11:53:08 -0700870
871 ASSERT_STREQ(libc_realpath, info.dli_fname);
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700872 // TODO: add check for dfi_fbase
873 ASSERT_STREQ("puts", info.dli_sname);
874 ASSERT_EQ(addr, info.dli_saddr);
875#else
876 GTEST_LOG_(INFO) << "This test does nothing for glibc. Glibc returns path from ldconfig "
877 "for libc.so, which is symlink itself (not a realpath).\n";
878#endif
879}
880
Elliott Hughese66190d2012-12-18 15:57:55 -0800881TEST(dlfcn, dladdr_invalid) {
Elliott Hughes8e15b082012-09-26 11:44:01 -0700882 Dl_info info;
883
Elliott Hughes3b297c42012-10-11 16:08:51 -0700884 dlerror(); // Clear any pending errors.
885
Elliott Hughes8e15b082012-09-26 11:44:01 -0700886 // No symbol corresponding to NULL.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700887 ASSERT_EQ(dladdr(nullptr, &info), 0); // Zero on error, non-zero on success.
888 ASSERT_TRUE(dlerror() == nullptr); // dladdr(3) doesn't set dlerror(3).
Elliott Hughes8e15b082012-09-26 11:44:01 -0700889
890 // No symbol corresponding to a stack address.
891 ASSERT_EQ(dladdr(&info, &info), 0); // Zero on error, non-zero on success.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700892 ASSERT_TRUE(dlerror() == nullptr); // dladdr(3) doesn't set dlerror(3).
Elliott Hughes8e15b082012-09-26 11:44:01 -0700893}
Elliott Hughes124fae92012-10-31 14:20:03 -0700894
Elliott Hughesa43e9062013-01-07 14:18:22 -0800895// GNU-style ELF hash tables are incompatible with the MIPS ABI.
896// MIPS requires .dynsym to be sorted to match the GOT but GNU-style requires sorting by hash code.
Elliott Hughese66190d2012-12-18 15:57:55 -0800897TEST(dlfcn, dlopen_library_with_only_gnu_hash) {
Dmitriy Ivanovec18ce02014-11-09 19:27:20 -0800898#if !defined(__mips__)
Elliott Hughes124fae92012-10-31 14:20:03 -0700899 dlerror(); // Clear any pending errors.
Dmitriy Ivanovec18ce02014-11-09 19:27:20 -0800900 void* handle = dlopen("libgnu-hash-table-library.so", RTLD_NOW);
901 ASSERT_TRUE(handle != nullptr) << dlerror();
902 auto guard = make_scope_guard([&]() {
903 dlclose(handle);
904 });
905 void* sym = dlsym(handle, "getRandomNumber");
906 ASSERT_TRUE(sym != nullptr) << dlerror();
907 int (*fn)(void);
908 fn = reinterpret_cast<int (*)(void)>(sym);
909 EXPECT_EQ(4, fn());
910
911 Dl_info dlinfo;
912 ASSERT_TRUE(0 != dladdr(reinterpret_cast<void*>(fn), &dlinfo));
913
914 ASSERT_TRUE(fn == dlinfo.dli_saddr);
915 ASSERT_STREQ("getRandomNumber", dlinfo.dli_sname);
Dmitriy Ivanovb3356772014-11-14 11:19:22 -0800916 ASSERT_SUBSTR("libgnu-hash-table-library.so", dlinfo.dli_fname);
Dmitriy Ivanovec18ce02014-11-09 19:27:20 -0800917#else
918 GTEST_LOG_(INFO) << "This test does nothing for mips/mips64; mips toolchain does not support '--hash-style=gnu'\n";
919#endif
Elliott Hughes124fae92012-10-31 14:20:03 -0700920}
Elliott Hughese66190d2012-12-18 15:57:55 -0800921
Dmitriy Ivanovb3356772014-11-14 11:19:22 -0800922TEST(dlfcn, dlopen_library_with_only_sysv_hash) {
923 void* handle = dlopen("libsysv-hash-table-library.so", RTLD_NOW);
924 ASSERT_TRUE(handle != nullptr) << dlerror();
925 auto guard = make_scope_guard([&]() {
926 dlclose(handle);
927 });
928 void* sym = dlsym(handle, "getRandomNumber");
929 ASSERT_TRUE(sym != nullptr) << dlerror();
930 int (*fn)(void);
931 fn = reinterpret_cast<int (*)(void)>(sym);
932 EXPECT_EQ(4, fn());
933
934 Dl_info dlinfo;
935 ASSERT_TRUE(0 != dladdr(reinterpret_cast<void*>(fn), &dlinfo));
936
937 ASSERT_TRUE(fn == dlinfo.dli_saddr);
938 ASSERT_STREQ("getRandomNumber", dlinfo.dli_sname);
939 ASSERT_SUBSTR("libsysv-hash-table-library.so", dlinfo.dli_fname);
940}
941
Elliott Hughese66190d2012-12-18 15:57:55 -0800942TEST(dlfcn, dlopen_bad_flags) {
943 dlerror(); // Clear any pending errors.
944 void* handle;
945
Elliott Hughes063525c2014-05-13 11:19:57 -0700946#if defined(__GLIBC__)
Elliott Hughese66190d2012-12-18 15:57:55 -0800947 // glibc was smart enough not to define RTLD_NOW as 0, so it can detect missing flags.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700948 handle = dlopen(nullptr, 0);
949 ASSERT_TRUE(handle == nullptr);
Elliott Hughese66190d2012-12-18 15:57:55 -0800950 ASSERT_SUBSTR("invalid", dlerror());
951#endif
952
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700953 handle = dlopen(nullptr, 0xffffffff);
954 ASSERT_TRUE(handle == nullptr);
Elliott Hughese66190d2012-12-18 15:57:55 -0800955 ASSERT_SUBSTR("invalid", dlerror());
956
957 // glibc actually allows you to choose both RTLD_NOW and RTLD_LAZY at the same time, and so do we.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700958 handle = dlopen(nullptr, RTLD_NOW|RTLD_LAZY);
959 ASSERT_TRUE(handle != nullptr);
960 ASSERT_SUBSTR(nullptr, dlerror());
Elliott Hughese66190d2012-12-18 15:57:55 -0800961}
Sergey Melnikovebd506c2013-10-31 18:02:12 +0400962
963TEST(dlfcn, rtld_default_unknown_symbol) {
Elliott Hughes2ed71092013-11-11 15:48:06 -0800964 void* addr = dlsym(RTLD_DEFAULT, "ANY_UNKNOWN_SYMBOL_NAME");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700965 ASSERT_TRUE(addr == nullptr);
Sergey Melnikovebd506c2013-10-31 18:02:12 +0400966}
967
968TEST(dlfcn, rtld_default_known_symbol) {
Elliott Hughes2ed71092013-11-11 15:48:06 -0800969 void* addr = dlsym(RTLD_DEFAULT, "fopen");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700970 ASSERT_TRUE(addr != nullptr);
Elliott Hughes2ed71092013-11-11 15:48:06 -0800971}
972
973TEST(dlfcn, rtld_next_unknown_symbol) {
974 void* addr = dlsym(RTLD_NEXT, "ANY_UNKNOWN_SYMBOL_NAME");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700975 ASSERT_TRUE(addr == nullptr);
Elliott Hughes2ed71092013-11-11 15:48:06 -0800976}
977
978TEST(dlfcn, rtld_next_known_symbol) {
979 void* addr = dlsym(RTLD_NEXT, "fopen");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700980 ASSERT_TRUE(addr != nullptr);
Sergey Melnikovebd506c2013-10-31 18:02:12 +0400981}
Dmitriy Ivanov7db18092014-05-08 12:27:25 -0700982
Dmitriy Ivanovce441662014-06-17 15:56:38 -0700983TEST(dlfcn, dlsym_weak_func) {
984 dlerror();
Dmitriy Ivanovbfa88bc2014-12-16 11:40:46 -0800985 void* handle = dlopen("libtest_dlsym_weak_func.so", RTLD_NOW);
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700986 ASSERT_TRUE(handle != nullptr);
Dmitriy Ivanovce441662014-06-17 15:56:38 -0700987
988 int (*weak_func)();
989 weak_func = reinterpret_cast<int (*)()>(dlsym(handle, "weak_func"));
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700990 ASSERT_TRUE(weak_func != nullptr) << "dlerror: " << dlerror();
Dmitriy Ivanovce441662014-06-17 15:56:38 -0700991 EXPECT_EQ(42, weak_func());
992 dlclose(handle);
993}
994
Dmitriy Ivanovbfa88bc2014-12-16 11:40:46 -0800995TEST(dlfcn, dlopen_undefined_weak_func) {
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700996 void* handle = dlopen("libtest_dlopen_weak_undefined_func.so", RTLD_NOW);
997 ASSERT_TRUE(handle != nullptr) << dlerror();
998 int (*weak_func)();
999 weak_func = reinterpret_cast<int (*)()>(dlsym(handle, "use_weak_undefined_func"));
1000 ASSERT_TRUE(weak_func != nullptr) << dlerror();
1001 EXPECT_EQ(6551, weak_func());
1002 dlclose(handle);
Dmitriy Ivanovbfa88bc2014-12-16 11:40:46 -08001003}
1004
Dmitriy Ivanov7db18092014-05-08 12:27:25 -07001005TEST(dlfcn, dlopen_symlink) {
1006 void* handle1 = dlopen("libdlext_test.so", RTLD_NOW);
1007 void* handle2 = dlopen("libdlext_test_v2.so", RTLD_NOW);
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -07001008 ASSERT_TRUE(handle1 != nullptr);
1009 ASSERT_TRUE(handle2 != nullptr);
Dmitriy Ivanov7db18092014-05-08 12:27:25 -07001010 ASSERT_EQ(handle1, handle2);
Dmitriy Ivanov319356e2014-09-02 17:31:44 -07001011 dlclose(handle1);
1012 dlclose(handle2);
Dmitriy Ivanov7db18092014-05-08 12:27:25 -07001013}
Dmitriy Ivanov279a22f2015-01-23 12:03:53 -08001014
1015// libtest_dlopen_from_ctor_main.so depends on
1016// libtest_dlopen_from_ctor.so which has a constructor
1017// that calls dlopen(libc...). This is to test the situation
1018// described in b/7941716.
1019TEST(dlfcn, dlopen_dlopen_from_ctor) {
1020#if defined(__BIONIC__)
1021 void* handle = dlopen("libtest_dlopen_from_ctor_main.so", RTLD_NOW);
1022 ASSERT_TRUE(handle != nullptr) << dlerror();
1023 dlclose(handle);
1024#else
1025 GTEST_LOG_(INFO) << "This test is disabled for glibc (glibc segfaults if you try to call dlopen from a constructor).\n";
1026#endif
1027}
Dmitriy Ivanov2a815362015-04-09 13:42:33 -07001028
1029TEST(dlfcn, symbol_versioning_use_v1) {
1030 void* handle = dlopen("libtest_versioned_uselibv1.so", RTLD_NOW);
1031 ASSERT_TRUE(handle != nullptr) << dlerror();
1032 typedef int (*fn_t)();
1033 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "get_function_version"));
1034 ASSERT_TRUE(fn != nullptr) << dlerror();
1035 ASSERT_EQ(1, fn());
1036 dlclose(handle);
1037}
1038
1039TEST(dlfcn, symbol_versioning_use_v2) {
1040 void* handle = dlopen("libtest_versioned_uselibv2.so", RTLD_NOW);
1041 ASSERT_TRUE(handle != nullptr) << dlerror();
1042 typedef int (*fn_t)();
1043 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "get_function_version"));
1044 ASSERT_TRUE(fn != nullptr) << dlerror();
1045 ASSERT_EQ(2, fn());
1046 dlclose(handle);
1047}
1048
1049TEST(dlfcn, symbol_versioning_use_other_v2) {
1050 void* handle = dlopen("libtest_versioned_uselibv2_other.so", RTLD_NOW);
1051 ASSERT_TRUE(handle != nullptr) << dlerror();
1052 typedef int (*fn_t)();
1053 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "get_function_version"));
1054 ASSERT_TRUE(fn != nullptr) << dlerror();
1055 ASSERT_EQ(20, fn());
1056 dlclose(handle);
1057}
1058
1059TEST(dlfcn, symbol_versioning_use_other_v3) {
1060 void* handle = dlopen("libtest_versioned_uselibv3_other.so", RTLD_NOW);
1061 ASSERT_TRUE(handle != nullptr) << dlerror();
1062 typedef int (*fn_t)();
1063 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "get_function_version"));
1064 ASSERT_TRUE(fn != nullptr) << dlerror();
1065 ASSERT_EQ(3, fn());
1066 dlclose(handle);
1067}
1068
1069TEST(dlfcn, symbol_versioning_default_via_dlsym) {
1070 void* handle = dlopen("libtest_versioned_lib.so", RTLD_NOW);
1071 ASSERT_TRUE(handle != nullptr) << dlerror();
1072 typedef int (*fn_t)();
1073 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "versioned_function"));
1074 ASSERT_TRUE(fn != nullptr) << dlerror();
1075 ASSERT_EQ(3, fn()); // the default version is 3
1076 dlclose(handle);
1077}
1078
Dimitry Ivanov9cf99cb2015-12-11 14:22:24 -08001079TEST(dlfcn, dlvsym_smoke) {
1080 void* handle = dlopen("libtest_versioned_lib.so", RTLD_NOW);
1081 ASSERT_TRUE(handle != nullptr) << dlerror();
1082 typedef int (*fn_t)();
1083
1084 {
1085 fn_t fn = reinterpret_cast<fn_t>(dlvsym(handle, "versioned_function", "nonversion"));
1086 ASSERT_TRUE(fn == nullptr);
1087 ASSERT_SUBSTR("undefined symbol: versioned_function, version nonversion", dlerror());
1088 }
1089
1090 {
1091 fn_t fn = reinterpret_cast<fn_t>(dlvsym(handle, "versioned_function", "TESTLIB_V2"));
1092 ASSERT_TRUE(fn != nullptr) << dlerror();
1093 ASSERT_EQ(2, fn());
1094 }
1095
1096 dlclose(handle);
1097}
1098
Dmitriy Ivanov2a815362015-04-09 13:42:33 -07001099// This preempts the implementation from libtest_versioned_lib.so
1100extern "C" int version_zero_function() {
1101 return 0;
1102}
1103
1104// This preempts the implementation from libtest_versioned_uselibv*.so
1105extern "C" int version_zero_function2() {
1106 return 0;
1107}
Evgenii Stepanov68650822015-06-10 13:38:39 -07001108
Lazar Trsic6f2d3102015-10-13 16:43:00 +02001109TEST(dlfcn, dt_runpath_smoke) {
Evgenii Stepanov68650822015-06-10 13:38:39 -07001110 void* handle = dlopen("libtest_dt_runpath_d.so", RTLD_NOW);
1111 ASSERT_TRUE(handle != nullptr) << dlerror();
1112
1113 typedef void *(* dlopen_b_fn)();
1114 dlopen_b_fn fn = (dlopen_b_fn)dlsym(handle, "dlopen_b");
1115 ASSERT_TRUE(fn != nullptr) << dlerror();
1116
1117 void *p = fn();
Evgenii Stepanov0cdef7e2015-07-06 17:56:31 -07001118 ASSERT_TRUE(p != nullptr);
Evgenii Stepanov68650822015-06-10 13:38:39 -07001119
1120 dlclose(handle);
1121}
Lazar Trsic6f2d3102015-10-13 16:43:00 +02001122
1123TEST(dlfcn, dt_runpath_absolute_path) {
1124 void* handle = dlopen(PATH_TO_SYSTEM_LIB "libtest_dt_runpath_d.so", RTLD_NOW);
1125 ASSERT_TRUE(handle != nullptr) << dlerror();
1126
1127 typedef void *(* dlopen_b_fn)();
1128 dlopen_b_fn fn = (dlopen_b_fn)dlsym(handle, "dlopen_b");
1129 ASSERT_TRUE(fn != nullptr) << dlerror();
1130
1131 void *p = fn();
1132 ASSERT_TRUE(p != nullptr);
1133
1134 dlclose(handle);
1135}