blob: f842c66ca07b0ed36b05658ec1cafb55551ffc12 [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
Dmitriy Ivanov9aea1642014-09-11 15:16:03 -0700214// ifuncs are only supported on intel and arm64 for now
215#if defined (__aarch64__) || defined(__i386__) || defined(__x86_64__)
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}
259#endif
260
Dmitriy Ivanovb2a30ee2014-09-04 18:23:00 -0700261TEST(dlfcn, dlopen_check_relocation_dt_needed_order) {
262 // This is the structure of the test library and
263 // its dt_needed libraries
264 // libtest_relo_check_dt_needed_order.so
265 // |
266 // +-> libtest_relo_check_dt_needed_order_1.so
267 // |
268 // +-> libtest_relo_check_dt_needed_order_2.so
269 //
270 // The root library references relo_test_get_answer_lib - which is defined
271 // in both dt_needed libraries, the correct relocation should
272 // use the function defined in libtest_relo_check_dt_needed_order_1.so
273 void* handle = nullptr;
Dmitriy Ivanovd9ff7222014-09-08 16:22:22 -0700274 auto guard = make_scope_guard([&]() {
Dmitriy Ivanovb2a30ee2014-09-04 18:23:00 -0700275 dlclose(handle);
276 });
277
278 handle = dlopen("libtest_relo_check_dt_needed_order.so", RTLD_NOW);
279 ASSERT_TRUE(handle != nullptr) << dlerror();
280
281 typedef int (*fn_t) (void);
282 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "relo_test_get_answer"));
283 ASSERT_TRUE(fn != nullptr) << dlerror();
284 ASSERT_EQ(1, fn());
285}
286
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700287TEST(dlfcn, dlopen_check_order_dlsym) {
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700288 // Here is how the test library and its dt_needed
289 // libraries are arranged
290 //
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700291 // libtest_check_order_children.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700292 // |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700293 // +-> ..._1_left.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700294 // | |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700295 // | +-> ..._a.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700296 // | |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700297 // | +-> ...r_b.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700298 // |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700299 // +-> ..._2_right.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700300 // | |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700301 // | +-> ..._d.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700302 // | |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700303 // | +-> ..._b.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700304 // |
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700305 // +-> ..._3_c.so
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700306 //
307 // load order should be (1, 2, 3, a, b, d)
308 //
309 // get_answer() is defined in (2, 3, a, b, c)
310 // get_answer2() is defined in (b, d)
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700311 void* sym = dlsym(RTLD_DEFAULT, "check_order_dlsym_get_answer");
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700312 ASSERT_TRUE(sym == nullptr);
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700313 void* handle = dlopen("libtest_check_order_dlsym.so", RTLD_NOW | RTLD_GLOBAL);
314 ASSERT_TRUE(handle != nullptr) << dlerror();
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700315 typedef int (*fn_t) (void);
316 fn_t fn, fn2;
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700317 fn = reinterpret_cast<fn_t>(dlsym(RTLD_DEFAULT, "check_order_dlsym_get_answer"));
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700318 ASSERT_TRUE(fn != nullptr) << dlerror();
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700319 fn2 = reinterpret_cast<fn_t>(dlsym(RTLD_DEFAULT, "check_order_dlsym_get_answer2"));
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700320 ASSERT_TRUE(fn2 != nullptr) << dlerror();
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700321
322 ASSERT_EQ(42, fn());
323 ASSERT_EQ(43, fn2());
324 dlclose(handle);
325}
326
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700327TEST(dlfcn, dlopen_check_order_reloc_siblings) {
328 // This is how this one works:
329 // we lookup and call get_answer which is defined in '_2.so'
330 // and in turn calls external get_answer_impl() defined in _1.so and in '_[a-f].so'
331 // the correct _impl() is implemented by '_a.so';
332 //
333 // Note that this is test for RTLD_LOCAL (TODO: test for GLOBAL?)
334 //
335 // Here is the picture:
336 //
337 // libtest_check_order_reloc_siblings.so
338 // |
339 // +-> ..._1.so <- empty
340 // | |
341 // | +-> ..._a.so <- exports correct answer_impl()
342 // | |
343 // | +-> ..._b.so <- every other letter exporting incorrect one.
344 // |
345 // +-> ..._2.so <- empty
346 // | |
347 // | +-> ..._c.so
348 // | |
349 // | +-> ..._d.so
350 // |
351 // +-> ..._3.so <- empty
352 // |
353 // +-> ..._e.so
354 // |
355 // +-> ..._f.so <- exports get_answer() that calls get_anser_impl();
356 // implements incorrect get_answer_impl()
357
358 void* handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_NOLOAD);
359 ASSERT_TRUE(handle == nullptr);
360#ifdef __BIONIC__
361 // TODO: glibc returns nullptr on dlerror() here. Is it bug?
362 ASSERT_STREQ("dlopen failed: library \"libtest_check_order_reloc_siblings.so\" wasn't loaded and RTLD_NOLOAD prevented it", dlerror());
363#endif
364
365 handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_LOCAL);
366 ASSERT_TRUE(handle != nullptr) << dlerror();
367
368 typedef int (*fn_t) (void);
369 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "check_order_reloc_get_answer"));
370 ASSERT_TRUE(fn != nullptr) << dlerror();
371 ASSERT_EQ(42, fn());
372
373 ASSERT_EQ(0, dlclose(handle));
374}
375
376TEST(dlfcn, dlopen_check_order_reloc_siblings_with_preload) {
377 // This test uses the same library as dlopen_check_order_reloc_siblings.
378 // Unlike dlopen_check_order_reloc_siblings it preloads
379 // libtest_check_order_reloc_siblings_1.so (first dependency) prior to
380 // dlopen(libtest_check_order_reloc_siblings.so)
381
382 void* handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_NOLOAD);
383 ASSERT_TRUE(handle == nullptr);
384 handle = dlopen("libtest_check_order_reloc_siblings_1.so", RTLD_NOW | RTLD_NOLOAD);
385 ASSERT_TRUE(handle == nullptr);
386
387 void* handle_for_1 = dlopen("libtest_check_order_reloc_siblings_1.so", RTLD_NOW | RTLD_LOCAL);
388 ASSERT_TRUE(handle_for_1 != nullptr) << dlerror();
389
390 handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_LOCAL);
391 ASSERT_TRUE(handle != nullptr) << dlerror();
392
393 ASSERT_EQ(0, dlclose(handle_for_1));
394
395 typedef int (*fn_t) (void);
396 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "check_order_reloc_get_answer"));
397 ASSERT_TRUE(fn != nullptr) << dlerror();
398 ASSERT_EQ(42, fn());
399
400 ASSERT_EQ(0, dlclose(handle));
401}
402
Dmitriy Ivanov7699d132014-11-18 17:26:31 -0800403TEST(dlfcn, dlopen_check_order_reloc_grandchild) {
404 // This is how this one works:
405 // we lookup and call grandchild_get_answer which is defined in '_2.so'
406 // and in turn calls external get_answer_impl() defined in '_c_1.so and _c_2.so'
407 // the correct _impl() is implemented by '_c_1.so';
408 //
409 // Here is the picture of subtree:
410 //
411 // libtest_check_order_reloc_siblings.so
412 // |
413 // +-> ..._2.so <- grandchild_get_answer()
414 // |
415 // +-> ..._c.so <- empty
416 // | |
417 // | +-> _c_1.so <- exports correct answer_impl()
418 // | |
419 // | +-> _c_2.so <- exports incorrect answer_impl()
420 // |
421 // +-> ..._d.so <- empty
422
423 void* handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_NOLOAD);
424 ASSERT_TRUE(handle == nullptr);
425#ifdef __BIONIC__
426 // TODO: glibc returns nullptr on dlerror() here. Is it bug?
427 ASSERT_STREQ("dlopen failed: library \"libtest_check_order_reloc_siblings.so\" wasn't loaded and RTLD_NOLOAD prevented it", dlerror());
428#endif
429
430 handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_LOCAL);
431 ASSERT_TRUE(handle != nullptr) << dlerror();
432
433 typedef int (*fn_t) (void);
434 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "check_order_reloc_grandchild_get_answer"));
435 ASSERT_TRUE(fn != nullptr) << dlerror();
436 ASSERT_EQ(42, fn());
437
438 ASSERT_EQ(0, dlclose(handle));
439}
440
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700441TEST(dlfcn, dlopen_check_order_reloc_nephew) {
442 // This is how this one works:
443 // we lookup and call nephew_get_answer which is defined in '_2.so'
444 // and in turn calls external get_answer_impl() defined in '_[a-f].so'
445 // the correct _impl() is implemented by '_a.so';
446 //
447 // Here is the picture:
448 //
449 // libtest_check_order_reloc_siblings.so
450 // |
451 // +-> ..._1.so <- empty
452 // | |
453 // | +-> ..._a.so <- exports correct answer_impl()
454 // | |
455 // | +-> ..._b.so <- every other letter exporting incorrect one.
456 // |
457 // +-> ..._2.so <- empty
458 // | |
459 // | +-> ..._c.so
460 // | |
461 // | +-> ..._d.so
462 // |
463 // +-> ..._3.so <- nephew_get_answer() that calls get_answer_impl();
464 // |
465 // +-> ..._e.so
466 // |
467 // +-> ..._f.so
468
469 void* handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_NOLOAD);
470 ASSERT_TRUE(handle == nullptr);
471#ifdef __BIONIC__
472 // TODO: glibc returns nullptr on dlerror() here. Is it bug?
473 ASSERT_STREQ("dlopen failed: library \"libtest_check_order_reloc_siblings.so\" wasn't loaded and RTLD_NOLOAD prevented it", dlerror());
474#endif
475
476 handle = dlopen("libtest_check_order_reloc_siblings.so", RTLD_NOW | RTLD_LOCAL);
477 ASSERT_TRUE(handle != nullptr) << dlerror();
478
479 typedef int (*fn_t) (void);
480 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "check_order_reloc_nephew_get_answer"));
481 ASSERT_TRUE(fn != nullptr) << dlerror();
482 ASSERT_EQ(42, fn());
483
484 ASSERT_EQ(0, dlclose(handle));
485}
486
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800487TEST(dlfcn, check_unload_after_reloc) {
488 // This is how this one works:
489 // libtest_two_parents_parent1 <- answer_impl() used by libtest_two_parents_child
490 // |
491 // +-> libtest_two_parents_child
492 //
493 // libtest_two_parents_parent2 <- answer_impl() not used by libtest_two_parents_child
494 // |
495 // +-> libtest_two_parents_child
496 //
497 // Test dlopens parent1 which loads and relocates libtest_two_parents_child.so
498 // as a second step it dlopens parent2 and dlcloses parent1...
499
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700500 void* handle = dlopen("libtest_two_parents_parent1.so", RTLD_NOW | RTLD_LOCAL);
501 ASSERT_TRUE(handle != nullptr) << dlerror();
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800502
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700503 void* handle2 = dlopen("libtest_two_parents_parent2.so", RTLD_NOW | RTLD_LOCAL);
504 ASSERT_TRUE(handle2 != nullptr) << dlerror();
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800505
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700506 typedef int (*fn_t) (void);
507 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle2, "check_order_reloc_get_answer"));
508 ASSERT_TRUE(fn != nullptr) << dlerror();
509 ASSERT_EQ(42, fn());
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800510
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700511 ASSERT_EQ(0, dlclose(handle));
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800512
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700513 handle = dlopen("libtest_two_parents_parent1.so", RTLD_NOW | RTLD_LOCAL | RTLD_NOLOAD);
514 ASSERT_TRUE(handle != nullptr);
515 ASSERT_EQ(0, dlclose(handle));
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800516
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700517 fn = reinterpret_cast<fn_t>(dlsym(handle2, "check_order_reloc_get_answer"));
518 ASSERT_TRUE(fn != nullptr) << dlerror();
519 ASSERT_EQ(42, fn());
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800520
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700521 ASSERT_EQ(0, dlclose(handle2));
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800522
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700523 handle = dlopen("libtest_two_parents_parent1.so", RTLD_NOW | RTLD_LOCAL | RTLD_NOLOAD);
524 ASSERT_TRUE(handle == nullptr);
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800525}
526
Dmitriy Ivanovcfa97f12014-10-21 09:23:18 -0700527extern "C" int check_order_reloc_root_get_answer_impl() {
528 return 42;
529}
530
531TEST(dlfcn, dlopen_check_order_reloc_main_executable) {
532 // This is how this one works:
533 // we lookup and call get_answer3 which is defined in 'root.so'
534 // and in turn calls external root_get_answer_impl() defined in _2.so and
535 // above the correct _impl() is one in the executable.
536 //
537 // libtest_check_order_reloc_root.so
538 // |
539 // +-> ..._1.so <- empty
540 // |
541 // +-> ..._2.so <- gives incorrect answer for answer_main_impl()
542 //
543
544 void* handle = dlopen("libtest_check_order_reloc_root.so", RTLD_NOW | RTLD_NOLOAD);
545 ASSERT_TRUE(handle == nullptr);
546#ifdef __BIONIC__
547 // TODO: glibc returns nullptr on dlerror() here. Is it bug?
548 ASSERT_STREQ("dlopen failed: library \"libtest_check_order_reloc_root.so\" wasn't loaded and RTLD_NOLOAD prevented it", dlerror());
549#endif
550
551 handle = dlopen("libtest_check_order_reloc_root.so", RTLD_NOW | RTLD_LOCAL);
552 ASSERT_TRUE(handle != nullptr) << dlerror();
553
554 typedef int (*fn_t) (void);
555 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "check_order_reloc_root_get_answer"));
556 ASSERT_TRUE(fn != nullptr) << dlerror();
557 ASSERT_EQ(42, fn());
558
559 ASSERT_EQ(0, dlclose(handle));
560}
561
Dmitriy Ivanove8ba50f2014-09-15 17:00:10 -0700562TEST(dlfcn, dlopen_check_rtld_local) {
563 void* sym = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
564 ASSERT_TRUE(sym == nullptr);
565
566 // implicit RTLD_LOCAL
567 void* handle = dlopen("libtest_simple.so", RTLD_NOW);
568 sym = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
569 ASSERT_TRUE(sym == nullptr);
570 ASSERT_SUBSTR("undefined symbol: dlopen_testlib_simple_func", dlerror());
571 sym = dlsym(handle, "dlopen_testlib_simple_func");
572 ASSERT_TRUE(sym != nullptr);
573 ASSERT_TRUE(reinterpret_cast<bool (*)(void)>(sym)());
574 dlclose(handle);
575
576 // explicit RTLD_LOCAL
577 handle = dlopen("libtest_simple.so", RTLD_NOW | RTLD_LOCAL);
578 sym = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
579 ASSERT_TRUE(sym == nullptr);
580 ASSERT_SUBSTR("undefined symbol: dlopen_testlib_simple_func", dlerror());
581 sym = dlsym(handle, "dlopen_testlib_simple_func");
582 ASSERT_TRUE(sym != nullptr);
583 ASSERT_TRUE(reinterpret_cast<bool (*)(void)>(sym)());
584 dlclose(handle);
585}
586
587TEST(dlfcn, dlopen_check_rtld_global) {
588 void* sym = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
589 ASSERT_TRUE(sym == nullptr);
590
591 void* handle = dlopen("libtest_simple.so", RTLD_NOW | RTLD_GLOBAL);
Dmitriy Ivanov1b20daf2014-05-19 15:06:58 -0700592 ASSERT_TRUE(handle != nullptr) << dlerror();
Dmitriy Ivanove8ba50f2014-09-15 17:00:10 -0700593 sym = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
594 ASSERT_TRUE(sym != nullptr) << dlerror();
595 ASSERT_TRUE(reinterpret_cast<bool (*)(void)>(sym)());
596 dlclose(handle);
Dmitriy Ivanov1b20daf2014-05-19 15:06:58 -0700597
598 // RTLD_GLOBAL implies RTLD_NODELETE, let's check that
599 void* sym_after_dlclose = dlsym(RTLD_DEFAULT, "dlopen_testlib_simple_func");
600 ASSERT_EQ(sym, sym_after_dlclose);
Dmitriy Ivanovf439b5a2015-05-30 13:04:39 -0700601
602 // Check if dlsym() for main program's handle searches RTLD_GLOBAL
603 // shared libraries after symbol was not found in the main executable
604 // and dependent libraries.
605 void* handle_for_main_executable = dlopen(nullptr, RTLD_NOW);
606 sym = dlsym(handle_for_main_executable, "dlopen_testlib_simple_func");
607 ASSERT_TRUE(sym != nullptr) << dlerror();
608
609 dlclose(handle_for_main_executable);
Dmitriy Ivanove8ba50f2014-09-15 17:00:10 -0700610}
611
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700612// libtest_with_dependency_loop.so -> libtest_with_dependency_loop_a.so ->
613// libtest_with_dependency_loop_b.so -> libtest_with_dependency_loop_c.so ->
614// libtest_with_dependency_loop_a.so
615TEST(dlfcn, dlopen_check_loop) {
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700616 void* handle = dlopen("libtest_with_dependency_loop.so", RTLD_NOW);
617 ASSERT_TRUE(handle != nullptr) << dlerror();
618 void* f = dlsym(handle, "dlopen_test_loopy_function");
619 ASSERT_TRUE(f != nullptr) << dlerror();
620 EXPECT_TRUE(reinterpret_cast<bool (*)(void)>(f)());
621 ASSERT_EQ(0, dlclose(handle));
Dmitriy Ivanova6ac54a2014-09-09 10:21:42 -0700622
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700623 // dlopen second time to make sure that the library was unloaded correctly
624 handle = dlopen("libtest_with_dependency_loop.so", RTLD_NOW | RTLD_NOLOAD);
625 ASSERT_TRUE(handle == nullptr);
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800626#ifdef __BIONIC__
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700627 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 -0800628#else
629 // TODO: glibc returns nullptr on dlerror() here. Is it bug?
630 ASSERT_TRUE(dlerror() == nullptr);
Dmitriy Ivanoveb27bba2014-09-15 14:13:24 -0700631#endif
Dmitriy Ivanovab972b92014-11-29 13:57:41 -0800632
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700633 handle = dlopen("libtest_with_dependency_a.so", RTLD_NOW | RTLD_NOLOAD);
634 ASSERT_TRUE(handle == nullptr);
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700635}
636
Dmitriy Ivanov1b20daf2014-05-19 15:06:58 -0700637TEST(dlfcn, dlopen_nodelete) {
638 static bool is_unloaded = false;
639
640 void* handle = dlopen("libtest_nodelete_1.so", RTLD_NOW | RTLD_NODELETE);
641 ASSERT_TRUE(handle != nullptr) << dlerror();
642 void (*set_unload_flag_ptr)(bool*);
643 set_unload_flag_ptr = reinterpret_cast<void (*)(bool*)>(dlsym(handle, "dlopen_nodelete_1_set_unload_flag_ptr"));
644 ASSERT_TRUE(set_unload_flag_ptr != nullptr) << dlerror();
645 set_unload_flag_ptr(&is_unloaded);
646
647 uint32_t* taxicab_number = reinterpret_cast<uint32_t*>(dlsym(handle, "dlopen_nodelete_1_taxicab_number"));
648 ASSERT_TRUE(taxicab_number != nullptr) << dlerror();
649 ASSERT_EQ(1729U, *taxicab_number);
650 *taxicab_number = 2;
651
652 dlclose(handle);
653 ASSERT_TRUE(!is_unloaded);
654
655 uint32_t* taxicab_number_after_dlclose = reinterpret_cast<uint32_t*>(dlsym(handle, "dlopen_nodelete_1_taxicab_number"));
656 ASSERT_EQ(taxicab_number_after_dlclose, taxicab_number);
657 ASSERT_EQ(2U, *taxicab_number_after_dlclose);
658
659
660 handle = dlopen("libtest_nodelete_1.so", RTLD_NOW);
661 uint32_t* taxicab_number2 = reinterpret_cast<uint32_t*>(dlsym(handle, "dlopen_nodelete_1_taxicab_number"));
662 ASSERT_EQ(taxicab_number2, taxicab_number);
663
664 ASSERT_EQ(2U, *taxicab_number2);
665
666 dlclose(handle);
667 ASSERT_TRUE(!is_unloaded);
668}
669
670TEST(dlfcn, dlopen_nodelete_on_second_dlopen) {
671 static bool is_unloaded = false;
672
673 void* handle = dlopen("libtest_nodelete_2.so", RTLD_NOW);
674 ASSERT_TRUE(handle != nullptr) << dlerror();
675 void (*set_unload_flag_ptr)(bool*);
676 set_unload_flag_ptr = reinterpret_cast<void (*)(bool*)>(dlsym(handle, "dlopen_nodelete_2_set_unload_flag_ptr"));
677 ASSERT_TRUE(set_unload_flag_ptr != nullptr) << dlerror();
678 set_unload_flag_ptr(&is_unloaded);
679
680 uint32_t* taxicab_number = reinterpret_cast<uint32_t*>(dlsym(handle, "dlopen_nodelete_2_taxicab_number"));
681 ASSERT_TRUE(taxicab_number != nullptr) << dlerror();
682
683 ASSERT_EQ(1729U, *taxicab_number);
684 *taxicab_number = 2;
685
686 // This RTLD_NODELETE should be ignored
687 void* handle1 = dlopen("libtest_nodelete_2.so", RTLD_NOW | RTLD_NODELETE);
688 ASSERT_TRUE(handle1 != nullptr) << dlerror();
689 ASSERT_EQ(handle, handle1);
690
691 dlclose(handle1);
692 dlclose(handle);
693
694 ASSERT_TRUE(is_unloaded);
695}
696
697TEST(dlfcn, dlopen_nodelete_dt_flags_1) {
698 static bool is_unloaded = false;
699
700 void* handle = dlopen("libtest_nodelete_dt_flags_1.so", RTLD_NOW);
701 ASSERT_TRUE(handle != nullptr) << dlerror();
702 void (*set_unload_flag_ptr)(bool*);
703 set_unload_flag_ptr = reinterpret_cast<void (*)(bool*)>(dlsym(handle, "dlopen_nodelete_dt_flags_1_set_unload_flag_ptr"));
704 ASSERT_TRUE(set_unload_flag_ptr != nullptr) << dlerror();
705 set_unload_flag_ptr(&is_unloaded);
706
707 dlclose(handle);
708 ASSERT_TRUE(!is_unloaded);
709}
710
Dmitriy Ivanovd225a5e2014-08-28 14:12:12 -0700711TEST(dlfcn, dlsym_df_1_global) {
Dmitriy Ivanovd225a5e2014-08-28 14:12:12 -0700712 void* handle = dlopen("libtest_dlsym_df_1_global.so", RTLD_NOW);
713 ASSERT_TRUE(handle != nullptr) << dlerror();
714 int (*get_answer)();
715 get_answer = reinterpret_cast<int (*)()>(dlsym(handle, "dl_df_1_global_get_answer"));
716 ASSERT_TRUE(get_answer != nullptr) << dlerror();
717 ASSERT_EQ(42, get_answer());
718 ASSERT_EQ(0, dlclose(handle));
Dmitriy Ivanovd225a5e2014-08-28 14:12:12 -0700719}
720
Elliott Hughese66190d2012-12-18 15:57:55 -0800721TEST(dlfcn, dlopen_failure) {
Elliott Hughes3b297c42012-10-11 16:08:51 -0700722 void* self = dlopen("/does/not/exist", RTLD_NOW);
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700723 ASSERT_TRUE(self == nullptr);
Elliott Hughes063525c2014-05-13 11:19:57 -0700724#if defined(__BIONIC__)
Elliott Hughes3b297c42012-10-11 16:08:51 -0700725 ASSERT_STREQ("dlopen failed: library \"/does/not/exist\" not found", dlerror());
726#else
727 ASSERT_STREQ("/does/not/exist: cannot open shared object file: No such file or directory", dlerror());
728#endif
729}
730
Elliott Hughesad88a082012-10-24 18:37:21 -0700731static void* ConcurrentDlErrorFn(void*) {
Elliott Hughes5419b942012-10-16 15:54:46 -0700732 dlopen("/child/thread", RTLD_NOW);
733 return reinterpret_cast<void*>(strdup(dlerror()));
734}
735
Elliott Hughese66190d2012-12-18 15:57:55 -0800736TEST(dlfcn, dlerror_concurrent) {
Elliott Hughes5419b942012-10-16 15:54:46 -0700737 dlopen("/main/thread", RTLD_NOW);
738 const char* main_thread_error = dlerror();
739 ASSERT_SUBSTR("/main/thread", main_thread_error);
740
741 pthread_t t;
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700742 ASSERT_EQ(0, pthread_create(&t, nullptr, ConcurrentDlErrorFn, nullptr));
Elliott Hughes5419b942012-10-16 15:54:46 -0700743 void* result;
744 ASSERT_EQ(0, pthread_join(t, &result));
745 char* child_thread_error = static_cast<char*>(result);
746 ASSERT_SUBSTR("/child/thread", child_thread_error);
747 free(child_thread_error);
748
749 ASSERT_SUBSTR("/main/thread", main_thread_error);
750}
751
Elliott Hughese66190d2012-12-18 15:57:55 -0800752TEST(dlfcn, dlsym_failures) {
Elliott Hughes3b297c42012-10-11 16:08:51 -0700753 dlerror(); // Clear any pending errors.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700754 void* self = dlopen(nullptr, RTLD_NOW);
755 ASSERT_TRUE(self != nullptr);
756 ASSERT_TRUE(dlerror() == nullptr);
Elliott Hughes3b297c42012-10-11 16:08:51 -0700757
758 void* sym;
759
Dmitriy Ivanov44adf932014-05-22 09:49:24 -0700760#if defined(__BIONIC__) && !defined(__LP64__)
761 // RTLD_DEFAULT in lp32 bionic is not (void*)0
762 // so it can be distinguished from the NULL handle.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700763 sym = dlsym(nullptr, "test");
764 ASSERT_TRUE(sym == nullptr);
Dimitry Ivanov4a2c5aa2015-12-10 16:08:14 -0800765 ASSERT_STREQ("dlsym failed: library handle is null", dlerror());
Elliott Hughes3b297c42012-10-11 16:08:51 -0700766#endif
767
Elliott Hughes3b297c42012-10-11 16:08:51 -0700768 // Symbol that doesn't exist.
769 sym = dlsym(self, "ThisSymbolDoesNotExist");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700770 ASSERT_TRUE(sym == nullptr);
Elliott Hughes3b297c42012-10-11 16:08:51 -0700771 ASSERT_SUBSTR("undefined symbol: ThisSymbolDoesNotExist", dlerror());
Elliott Hughes1a696162012-11-01 13:49:32 -0700772
773 ASSERT_EQ(0, dlclose(self));
Elliott Hughes3b297c42012-10-11 16:08:51 -0700774}
775
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700776TEST(dlfcn, dladdr_executable) {
Elliott Hughes3b297c42012-10-11 16:08:51 -0700777 dlerror(); // Clear any pending errors.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700778 void* self = dlopen(nullptr, RTLD_NOW);
779 ASSERT_TRUE(self != nullptr);
780 ASSERT_TRUE(dlerror() == nullptr);
Elliott Hughes8e15b082012-09-26 11:44:01 -0700781
782 void* sym = dlsym(self, "DlSymTestFunction");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700783 ASSERT_TRUE(sym != nullptr);
Elliott Hughes8e15b082012-09-26 11:44:01 -0700784
785 // Deliberately ask dladdr for an address inside a symbol, rather than the symbol base address.
786 void* addr = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(sym) + 2);
787
788 Dl_info info;
789 int rc = dladdr(addr, &info);
790 ASSERT_NE(rc, 0); // Zero on error, non-zero on success.
791
792 // Get the name of this executable.
Dimitry Ivanovdcaef372016-05-17 13:29:37 -0700793 const std::string& executable_path = get_executable_path();
Elliott Hughes8e15b082012-09-26 11:44:01 -0700794
795 // The filename should be that of this executable.
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700796 char dli_realpath[PATH_MAX];
797 ASSERT_TRUE(realpath(info.dli_fname, dli_realpath) != nullptr);
Dimitry Ivanovdcaef372016-05-17 13:29:37 -0700798 ASSERT_STREQ(executable_path.c_str(), dli_realpath);
Elliott Hughes8e15b082012-09-26 11:44:01 -0700799
800 // The symbol name should be the symbol we looked up.
801 ASSERT_STREQ(info.dli_sname, "DlSymTestFunction");
802
803 // The address should be the exact address of the symbol.
804 ASSERT_EQ(info.dli_saddr, sym);
805
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700806 std::vector<map_record> maps;
807 ASSERT_TRUE(Maps::parse_maps(&maps));
808
809 void* base_address = nullptr;
810 for (const map_record& rec : maps) {
811 if (executable_path == rec.pathname) {
812 base_address = reinterpret_cast<void*>(rec.addr_start);
Elliott Hughes8e15b082012-09-26 11:44:01 -0700813 break;
814 }
815 }
Elliott Hughes8e15b082012-09-26 11:44:01 -0700816
817 // The base address should be the address we were loaded at.
818 ASSERT_EQ(info.dli_fbase, base_address);
Elliott Hughes1a696162012-11-01 13:49:32 -0700819
820 ASSERT_EQ(0, dlclose(self));
Elliott Hughes8e15b082012-09-26 11:44:01 -0700821}
822
Dimitry Ivanovdcaef372016-05-17 13:29:37 -0700823TEST(dlfcn, dlopen_executable_by_absolute_path) {
824 void* handle1 = dlopen(nullptr, RTLD_NOW);
825 ASSERT_TRUE(handle1 != nullptr) << dlerror();
826
827 void* handle2 = dlopen(get_executable_path().c_str(), RTLD_NOW);
828 ASSERT_TRUE(handle2 != nullptr) << dlerror();
829
830#if defined(__BIONIC__)
831 ASSERT_EQ(handle1, handle2);
832#else
833 GTEST_LOG_(INFO) << "Skipping ASSERT_EQ(handle1, handle2) for glibc: "
834 "it loads a separate copy of the main executable "
835 "on dlopen by absolute path.";
836#endif
837}
838
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700839#if defined(__LP64__)
Lazar Trsic6f2d3102015-10-13 16:43:00 +0200840#define PATH_TO_SYSTEM_LIB "/system/lib64/"
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700841#else
Lazar Trsic6f2d3102015-10-13 16:43:00 +0200842#define PATH_TO_SYSTEM_LIB "/system/lib/"
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700843#endif
Lazar Trsic6f2d3102015-10-13 16:43:00 +0200844#define PATH_TO_LIBC PATH_TO_SYSTEM_LIB "libc.so"
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700845
846TEST(dlfcn, dladdr_libc) {
847#if defined(__BIONIC__)
848 Dl_info info;
849 void* addr = reinterpret_cast<void*>(puts); // well-known libc function
850 ASSERT_TRUE(dladdr(addr, &info) != 0);
851
Dmitriy Ivanovef255922015-04-08 11:53:08 -0700852 // /system/lib is symlink when this test is executed on host.
853 char libc_realpath[PATH_MAX];
Lazar Trsic6f2d3102015-10-13 16:43:00 +0200854 ASSERT_TRUE(realpath(PATH_TO_LIBC, libc_realpath) == libc_realpath);
Dmitriy Ivanovef255922015-04-08 11:53:08 -0700855
856 ASSERT_STREQ(libc_realpath, info.dli_fname);
Dmitriy Ivanovaae859c2015-03-31 11:14:03 -0700857 // TODO: add check for dfi_fbase
858 ASSERT_STREQ("puts", info.dli_sname);
859 ASSERT_EQ(addr, info.dli_saddr);
860#else
861 GTEST_LOG_(INFO) << "This test does nothing for glibc. Glibc returns path from ldconfig "
862 "for libc.so, which is symlink itself (not a realpath).\n";
863#endif
864}
865
Elliott Hughese66190d2012-12-18 15:57:55 -0800866TEST(dlfcn, dladdr_invalid) {
Elliott Hughes8e15b082012-09-26 11:44:01 -0700867 Dl_info info;
868
Elliott Hughes3b297c42012-10-11 16:08:51 -0700869 dlerror(); // Clear any pending errors.
870
Elliott Hughes8e15b082012-09-26 11:44:01 -0700871 // No symbol corresponding to NULL.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700872 ASSERT_EQ(dladdr(nullptr, &info), 0); // Zero on error, non-zero on success.
873 ASSERT_TRUE(dlerror() == nullptr); // dladdr(3) doesn't set dlerror(3).
Elliott Hughes8e15b082012-09-26 11:44:01 -0700874
875 // No symbol corresponding to a stack address.
876 ASSERT_EQ(dladdr(&info, &info), 0); // Zero on error, non-zero on success.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700877 ASSERT_TRUE(dlerror() == nullptr); // dladdr(3) doesn't set dlerror(3).
Elliott Hughes8e15b082012-09-26 11:44:01 -0700878}
Elliott Hughes124fae92012-10-31 14:20:03 -0700879
Elliott Hughesa43e9062013-01-07 14:18:22 -0800880// GNU-style ELF hash tables are incompatible with the MIPS ABI.
881// 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 -0800882TEST(dlfcn, dlopen_library_with_only_gnu_hash) {
Dmitriy Ivanovec18ce02014-11-09 19:27:20 -0800883#if !defined(__mips__)
Elliott Hughes124fae92012-10-31 14:20:03 -0700884 dlerror(); // Clear any pending errors.
Dmitriy Ivanovec18ce02014-11-09 19:27:20 -0800885 void* handle = dlopen("libgnu-hash-table-library.so", RTLD_NOW);
886 ASSERT_TRUE(handle != nullptr) << dlerror();
887 auto guard = make_scope_guard([&]() {
888 dlclose(handle);
889 });
890 void* sym = dlsym(handle, "getRandomNumber");
891 ASSERT_TRUE(sym != nullptr) << dlerror();
892 int (*fn)(void);
893 fn = reinterpret_cast<int (*)(void)>(sym);
894 EXPECT_EQ(4, fn());
895
896 Dl_info dlinfo;
897 ASSERT_TRUE(0 != dladdr(reinterpret_cast<void*>(fn), &dlinfo));
898
899 ASSERT_TRUE(fn == dlinfo.dli_saddr);
900 ASSERT_STREQ("getRandomNumber", dlinfo.dli_sname);
Dmitriy Ivanovb3356772014-11-14 11:19:22 -0800901 ASSERT_SUBSTR("libgnu-hash-table-library.so", dlinfo.dli_fname);
Dmitriy Ivanovec18ce02014-11-09 19:27:20 -0800902#else
903 GTEST_LOG_(INFO) << "This test does nothing for mips/mips64; mips toolchain does not support '--hash-style=gnu'\n";
904#endif
Elliott Hughes124fae92012-10-31 14:20:03 -0700905}
Elliott Hughese66190d2012-12-18 15:57:55 -0800906
Dmitriy Ivanovb3356772014-11-14 11:19:22 -0800907TEST(dlfcn, dlopen_library_with_only_sysv_hash) {
908 void* handle = dlopen("libsysv-hash-table-library.so", RTLD_NOW);
909 ASSERT_TRUE(handle != nullptr) << dlerror();
910 auto guard = make_scope_guard([&]() {
911 dlclose(handle);
912 });
913 void* sym = dlsym(handle, "getRandomNumber");
914 ASSERT_TRUE(sym != nullptr) << dlerror();
915 int (*fn)(void);
916 fn = reinterpret_cast<int (*)(void)>(sym);
917 EXPECT_EQ(4, fn());
918
919 Dl_info dlinfo;
920 ASSERT_TRUE(0 != dladdr(reinterpret_cast<void*>(fn), &dlinfo));
921
922 ASSERT_TRUE(fn == dlinfo.dli_saddr);
923 ASSERT_STREQ("getRandomNumber", dlinfo.dli_sname);
924 ASSERT_SUBSTR("libsysv-hash-table-library.so", dlinfo.dli_fname);
925}
926
Elliott Hughese66190d2012-12-18 15:57:55 -0800927TEST(dlfcn, dlopen_bad_flags) {
928 dlerror(); // Clear any pending errors.
929 void* handle;
930
Elliott Hughes063525c2014-05-13 11:19:57 -0700931#if defined(__GLIBC__)
Elliott Hughese66190d2012-12-18 15:57:55 -0800932 // glibc was smart enough not to define RTLD_NOW as 0, so it can detect missing flags.
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700933 handle = dlopen(nullptr, 0);
934 ASSERT_TRUE(handle == nullptr);
Elliott Hughese66190d2012-12-18 15:57:55 -0800935 ASSERT_SUBSTR("invalid", dlerror());
936#endif
937
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700938 handle = dlopen(nullptr, 0xffffffff);
939 ASSERT_TRUE(handle == nullptr);
Elliott Hughese66190d2012-12-18 15:57:55 -0800940 ASSERT_SUBSTR("invalid", dlerror());
941
942 // 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 -0700943 handle = dlopen(nullptr, RTLD_NOW|RTLD_LAZY);
944 ASSERT_TRUE(handle != nullptr);
945 ASSERT_SUBSTR(nullptr, dlerror());
Elliott Hughese66190d2012-12-18 15:57:55 -0800946}
Sergey Melnikovebd506c2013-10-31 18:02:12 +0400947
948TEST(dlfcn, rtld_default_unknown_symbol) {
Elliott Hughes2ed71092013-11-11 15:48:06 -0800949 void* addr = dlsym(RTLD_DEFAULT, "ANY_UNKNOWN_SYMBOL_NAME");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700950 ASSERT_TRUE(addr == nullptr);
Sergey Melnikovebd506c2013-10-31 18:02:12 +0400951}
952
953TEST(dlfcn, rtld_default_known_symbol) {
Elliott Hughes2ed71092013-11-11 15:48:06 -0800954 void* addr = dlsym(RTLD_DEFAULT, "fopen");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700955 ASSERT_TRUE(addr != nullptr);
Elliott Hughes2ed71092013-11-11 15:48:06 -0800956}
957
958TEST(dlfcn, rtld_next_unknown_symbol) {
959 void* addr = dlsym(RTLD_NEXT, "ANY_UNKNOWN_SYMBOL_NAME");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700960 ASSERT_TRUE(addr == nullptr);
Elliott Hughes2ed71092013-11-11 15:48:06 -0800961}
962
963TEST(dlfcn, rtld_next_known_symbol) {
964 void* addr = dlsym(RTLD_NEXT, "fopen");
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700965 ASSERT_TRUE(addr != nullptr);
Sergey Melnikovebd506c2013-10-31 18:02:12 +0400966}
Dmitriy Ivanov7db18092014-05-08 12:27:25 -0700967
Dmitriy Ivanovce441662014-06-17 15:56:38 -0700968TEST(dlfcn, dlsym_weak_func) {
969 dlerror();
Dmitriy Ivanovbfa88bc2014-12-16 11:40:46 -0800970 void* handle = dlopen("libtest_dlsym_weak_func.so", RTLD_NOW);
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700971 ASSERT_TRUE(handle != nullptr);
Dmitriy Ivanovce441662014-06-17 15:56:38 -0700972
973 int (*weak_func)();
974 weak_func = reinterpret_cast<int (*)()>(dlsym(handle, "weak_func"));
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700975 ASSERT_TRUE(weak_func != nullptr) << "dlerror: " << dlerror();
Dmitriy Ivanovce441662014-06-17 15:56:38 -0700976 EXPECT_EQ(42, weak_func());
977 dlclose(handle);
978}
979
Dmitriy Ivanovbfa88bc2014-12-16 11:40:46 -0800980TEST(dlfcn, dlopen_undefined_weak_func) {
Dmitriy Ivanovcb0443c2015-03-16 14:15:46 -0700981 void* handle = dlopen("libtest_dlopen_weak_undefined_func.so", RTLD_NOW);
982 ASSERT_TRUE(handle != nullptr) << dlerror();
983 int (*weak_func)();
984 weak_func = reinterpret_cast<int (*)()>(dlsym(handle, "use_weak_undefined_func"));
985 ASSERT_TRUE(weak_func != nullptr) << dlerror();
986 EXPECT_EQ(6551, weak_func());
987 dlclose(handle);
Dmitriy Ivanovbfa88bc2014-12-16 11:40:46 -0800988}
989
Dmitriy Ivanov7db18092014-05-08 12:27:25 -0700990TEST(dlfcn, dlopen_symlink) {
991 void* handle1 = dlopen("libdlext_test.so", RTLD_NOW);
992 void* handle2 = dlopen("libdlext_test_v2.so", RTLD_NOW);
Dmitriy Ivanovaff18fd2015-06-23 13:58:22 -0700993 ASSERT_TRUE(handle1 != nullptr);
994 ASSERT_TRUE(handle2 != nullptr);
Dmitriy Ivanov7db18092014-05-08 12:27:25 -0700995 ASSERT_EQ(handle1, handle2);
Dmitriy Ivanov319356e2014-09-02 17:31:44 -0700996 dlclose(handle1);
997 dlclose(handle2);
Dmitriy Ivanov7db18092014-05-08 12:27:25 -0700998}
Dmitriy Ivanov279a22f2015-01-23 12:03:53 -0800999
1000// libtest_dlopen_from_ctor_main.so depends on
1001// libtest_dlopen_from_ctor.so which has a constructor
1002// that calls dlopen(libc...). This is to test the situation
1003// described in b/7941716.
1004TEST(dlfcn, dlopen_dlopen_from_ctor) {
1005#if defined(__BIONIC__)
1006 void* handle = dlopen("libtest_dlopen_from_ctor_main.so", RTLD_NOW);
1007 ASSERT_TRUE(handle != nullptr) << dlerror();
1008 dlclose(handle);
1009#else
1010 GTEST_LOG_(INFO) << "This test is disabled for glibc (glibc segfaults if you try to call dlopen from a constructor).\n";
1011#endif
1012}
Dmitriy Ivanov2a815362015-04-09 13:42:33 -07001013
1014TEST(dlfcn, symbol_versioning_use_v1) {
1015 void* handle = dlopen("libtest_versioned_uselibv1.so", RTLD_NOW);
1016 ASSERT_TRUE(handle != nullptr) << dlerror();
1017 typedef int (*fn_t)();
1018 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "get_function_version"));
1019 ASSERT_TRUE(fn != nullptr) << dlerror();
1020 ASSERT_EQ(1, fn());
1021 dlclose(handle);
1022}
1023
1024TEST(dlfcn, symbol_versioning_use_v2) {
1025 void* handle = dlopen("libtest_versioned_uselibv2.so", RTLD_NOW);
1026 ASSERT_TRUE(handle != nullptr) << dlerror();
1027 typedef int (*fn_t)();
1028 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "get_function_version"));
1029 ASSERT_TRUE(fn != nullptr) << dlerror();
1030 ASSERT_EQ(2, fn());
1031 dlclose(handle);
1032}
1033
1034TEST(dlfcn, symbol_versioning_use_other_v2) {
1035 void* handle = dlopen("libtest_versioned_uselibv2_other.so", RTLD_NOW);
1036 ASSERT_TRUE(handle != nullptr) << dlerror();
1037 typedef int (*fn_t)();
1038 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "get_function_version"));
1039 ASSERT_TRUE(fn != nullptr) << dlerror();
1040 ASSERT_EQ(20, fn());
1041 dlclose(handle);
1042}
1043
1044TEST(dlfcn, symbol_versioning_use_other_v3) {
1045 void* handle = dlopen("libtest_versioned_uselibv3_other.so", RTLD_NOW);
1046 ASSERT_TRUE(handle != nullptr) << dlerror();
1047 typedef int (*fn_t)();
1048 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "get_function_version"));
1049 ASSERT_TRUE(fn != nullptr) << dlerror();
1050 ASSERT_EQ(3, fn());
1051 dlclose(handle);
1052}
1053
1054TEST(dlfcn, symbol_versioning_default_via_dlsym) {
1055 void* handle = dlopen("libtest_versioned_lib.so", RTLD_NOW);
1056 ASSERT_TRUE(handle != nullptr) << dlerror();
1057 typedef int (*fn_t)();
1058 fn_t fn = reinterpret_cast<fn_t>(dlsym(handle, "versioned_function"));
1059 ASSERT_TRUE(fn != nullptr) << dlerror();
1060 ASSERT_EQ(3, fn()); // the default version is 3
1061 dlclose(handle);
1062}
1063
Dimitry Ivanov9cf99cb2015-12-11 14:22:24 -08001064TEST(dlfcn, dlvsym_smoke) {
1065 void* handle = dlopen("libtest_versioned_lib.so", RTLD_NOW);
1066 ASSERT_TRUE(handle != nullptr) << dlerror();
1067 typedef int (*fn_t)();
1068
1069 {
1070 fn_t fn = reinterpret_cast<fn_t>(dlvsym(handle, "versioned_function", "nonversion"));
1071 ASSERT_TRUE(fn == nullptr);
1072 ASSERT_SUBSTR("undefined symbol: versioned_function, version nonversion", dlerror());
1073 }
1074
1075 {
1076 fn_t fn = reinterpret_cast<fn_t>(dlvsym(handle, "versioned_function", "TESTLIB_V2"));
1077 ASSERT_TRUE(fn != nullptr) << dlerror();
1078 ASSERT_EQ(2, fn());
1079 }
1080
1081 dlclose(handle);
1082}
1083
Dmitriy Ivanov2a815362015-04-09 13:42:33 -07001084// This preempts the implementation from libtest_versioned_lib.so
1085extern "C" int version_zero_function() {
1086 return 0;
1087}
1088
1089// This preempts the implementation from libtest_versioned_uselibv*.so
1090extern "C" int version_zero_function2() {
1091 return 0;
1092}
Evgenii Stepanov68650822015-06-10 13:38:39 -07001093
Lazar Trsic6f2d3102015-10-13 16:43:00 +02001094TEST(dlfcn, dt_runpath_smoke) {
Evgenii Stepanov68650822015-06-10 13:38:39 -07001095 void* handle = dlopen("libtest_dt_runpath_d.so", RTLD_NOW);
1096 ASSERT_TRUE(handle != nullptr) << dlerror();
1097
1098 typedef void *(* dlopen_b_fn)();
1099 dlopen_b_fn fn = (dlopen_b_fn)dlsym(handle, "dlopen_b");
1100 ASSERT_TRUE(fn != nullptr) << dlerror();
1101
1102 void *p = fn();
Evgenii Stepanov0cdef7e2015-07-06 17:56:31 -07001103 ASSERT_TRUE(p != nullptr);
Evgenii Stepanov68650822015-06-10 13:38:39 -07001104
1105 dlclose(handle);
1106}
Lazar Trsic6f2d3102015-10-13 16:43:00 +02001107
1108TEST(dlfcn, dt_runpath_absolute_path) {
1109 void* handle = dlopen(PATH_TO_SYSTEM_LIB "libtest_dt_runpath_d.so", RTLD_NOW);
1110 ASSERT_TRUE(handle != nullptr) << dlerror();
1111
1112 typedef void *(* dlopen_b_fn)();
1113 dlopen_b_fn fn = (dlopen_b_fn)dlsym(handle, "dlopen_b");
1114 ASSERT_TRUE(fn != nullptr) << dlerror();
1115
1116 void *p = fn();
1117 ASSERT_TRUE(p != nullptr);
1118
1119 dlclose(handle);
1120}