1 /*
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 #pragma once
18
19 #include <dirent.h>
20 #include <dlfcn.h>
21 #include <fcntl.h>
22 #include <gtest/gtest.h>
23 #include <inttypes.h>
24 #include <sys/mman.h>
25 #include <sys/prctl.h>
26 #include <sys/types.h>
27 #include <sys/wait.h>
28 #include <unistd.h>
29
30 #if defined(__BIONIC__)
31 #include <sys/system_properties.h>
32 #endif
33
34 #if defined(__BIONIC__)
35 #include <bionic/macros.h>
36 #else
37 #define untag_address(p) p
38 #endif
39
40 #include <atomic>
41 #include <iomanip>
42 #include <string>
43 #include <regex>
44
45 #include <android-base/file.h>
46 #include <android-base/macros.h>
47 #include <android-base/scopeguard.h>
48 #include <android-base/stringprintf.h>
49
50 #if defined(__LP64__)
51 #define PATH_TO_SYSTEM_LIB "/system/lib64/"
52 #else
53 #define PATH_TO_SYSTEM_LIB "/system/lib/"
54 #endif
55
56 #if defined(__GLIBC__)
57 #define BIN_DIR "/bin/"
58 #else
59 #define BIN_DIR "/system/bin/"
60 #endif
61
62 #if defined(__BIONIC__)
63 #define KNOWN_FAILURE_ON_BIONIC(x) xfail_ ## x
64 #else
65 #define KNOWN_FAILURE_ON_BIONIC(x) x
66 #endif
67
68 // bionic's dlsym doesn't work in static binaries, so we can't access icu,
69 // so any unicode test case will fail.
have_dl()70 static inline bool have_dl() {
71 return (dlopen("libc.so", 0) != nullptr);
72 }
73
running_with_native_bridge()74 static inline bool running_with_native_bridge() {
75 #if defined(__BIONIC__)
76 static const prop_info* pi = __system_property_find("ro.dalvik.vm.isa." ABI_STRING);
77 return pi != nullptr;
78 #endif
79 return false;
80 }
81
82 #define SKIP_WITH_NATIVE_BRIDGE if (running_with_native_bridge()) GTEST_SKIP()
83
84 #if defined(__linux__)
85
86 #include <sys/sysmacros.h>
87
88 struct map_record {
89 uintptr_t addr_start;
90 uintptr_t addr_end;
91
92 int perms;
93
94 size_t offset;
95
96 dev_t device;
97 ino_t inode;
98
99 std::string pathname;
100 };
101
102 class Maps {
103 public:
parse_maps(std::vector<map_record> * maps)104 static bool parse_maps(std::vector<map_record>* maps) {
105 maps->clear();
106
107 std::unique_ptr<FILE, decltype(&fclose)> fp(fopen("/proc/self/maps", "re"), fclose);
108 if (!fp) return false;
109
110 char line[BUFSIZ];
111 while (fgets(line, sizeof(line), fp.get()) != nullptr) {
112 map_record record;
113 uint32_t dev_major, dev_minor;
114 int path_offset;
115 char prot[5]; // sizeof("rwxp")
116 if (sscanf(line, "%" SCNxPTR "-%" SCNxPTR " %4s %" SCNxPTR " %x:%x %lu %n",
117 &record.addr_start, &record.addr_end, prot, &record.offset,
118 &dev_major, &dev_minor, &record.inode, &path_offset) == 7) {
119 record.perms = 0;
120 if (prot[0] == 'r') {
121 record.perms |= PROT_READ;
122 }
123 if (prot[1] == 'w') {
124 record.perms |= PROT_WRITE;
125 }
126 if (prot[2] == 'x') {
127 record.perms |= PROT_EXEC;
128 }
129
130 // TODO: parse shared/private?
131
132 record.device = makedev(dev_major, dev_minor);
133 record.pathname = line + path_offset;
134 if (!record.pathname.empty() && record.pathname.back() == '\n') {
135 record.pathname.pop_back();
136 }
137 maps->push_back(record);
138 }
139 }
140
141 return true;
142 }
143 };
144
145 extern "C" pid_t gettid();
146
147 #endif
148
WaitUntilThreadSleep(std::atomic<pid_t> & tid)149 static inline void WaitUntilThreadSleep(std::atomic<pid_t>& tid) {
150 while (tid == 0) {
151 usleep(1000);
152 }
153 std::string filename = android::base::StringPrintf("/proc/%d/stat", tid.load());
154 std::regex regex {R"(\s+S\s+)"};
155
156 while (true) {
157 std::string content;
158 ASSERT_TRUE(android::base::ReadFileToString(filename, &content));
159 if (std::regex_search(content, regex)) {
160 break;
161 }
162 usleep(1000);
163 }
164 }
165
166 static inline void AssertChildExited(int pid, int expected_exit_status,
167 const std::string* error_msg = nullptr) {
168 int status;
169 std::string error;
170 if (error_msg == nullptr) {
171 error_msg = &error;
172 }
173 ASSERT_EQ(pid, TEMP_FAILURE_RETRY(waitpid(pid, &status, 0))) << *error_msg;
174 if (expected_exit_status >= 0) {
175 ASSERT_TRUE(WIFEXITED(status)) << *error_msg;
176 ASSERT_EQ(expected_exit_status, WEXITSTATUS(status)) << *error_msg;
177 } else {
178 ASSERT_TRUE(WIFSIGNALED(status)) << *error_msg;
179 ASSERT_EQ(-expected_exit_status, WTERMSIG(status)) << *error_msg;
180 }
181 }
182
CloseOnExec(int fd)183 static inline bool CloseOnExec(int fd) {
184 int flags = fcntl(fd, F_GETFD);
185 // This isn't ideal, but the alternatives are worse:
186 // * If we return void and use ASSERT_NE here, we get failures at utils.h:191
187 // rather than in the relevant test.
188 // * If we ignore failures of fcntl(), well, that's obviously a bad idea.
189 if (flags == -1) abort();
190 return flags & FD_CLOEXEC;
191 }
192
193 // The absolute path to the executable
194 const std::string& get_executable_path();
195
196 // Access to argc/argv/envp
197 int get_argc();
198 char** get_argv();
199 char** get_envp();
200
201 // ExecTestHelper is only used in bionic and glibc tests.
202 #ifndef __APPLE__
203 class ExecTestHelper {
204 public:
GetArgs()205 char** GetArgs() {
206 return const_cast<char**>(args_.data());
207 }
GetArg0()208 const char* GetArg0() {
209 return args_[0];
210 }
GetEnv()211 char** GetEnv() {
212 return const_cast<char**>(env_.data());
213 }
GetOutput()214 const std::string& GetOutput() {
215 return output_;
216 }
217
SetArgs(const std::vector<const char * > & args)218 void SetArgs(const std::vector<const char*>& args) {
219 args_ = args;
220 }
SetEnv(const std::vector<const char * > & env)221 void SetEnv(const std::vector<const char*>& env) {
222 env_ = env;
223 }
224
Run(const std::function<void ()> & child_fn,int expected_exit_status,const char * expected_output_regex)225 void Run(const std::function<void()>& child_fn, int expected_exit_status,
226 const char* expected_output_regex) {
227 int fds[2];
228 ASSERT_NE(pipe(fds), -1);
229
230 pid_t pid = fork();
231 ASSERT_NE(pid, -1);
232
233 if (pid == 0) {
234 // Child.
235 close(fds[0]);
236 dup2(fds[1], STDOUT_FILENO);
237 dup2(fds[1], STDERR_FILENO);
238 if (fds[1] != STDOUT_FILENO && fds[1] != STDERR_FILENO) close(fds[1]);
239 child_fn();
240 FAIL();
241 }
242
243 // Parent.
244 close(fds[1]);
245 output_.clear();
246 char buf[BUFSIZ];
247 ssize_t bytes_read;
248 while ((bytes_read = TEMP_FAILURE_RETRY(read(fds[0], buf, sizeof(buf)))) > 0) {
249 output_.append(buf, bytes_read);
250 }
251 close(fds[0]);
252
253 std::string error_msg("Test output:\n" + output_);
254 AssertChildExited(pid, expected_exit_status, &error_msg);
255 if (expected_output_regex != nullptr) {
256 if (!std::regex_search(output_, std::regex(expected_output_regex))) {
257 FAIL() << "regex " << std::quoted(expected_output_regex) << " didn't match " << std::quoted(output_);
258 }
259 }
260 }
261
262 private:
263 std::vector<const char*> args_;
264 std::vector<const char*> env_;
265 std::string output_;
266 };
267
268 void RunGwpAsanTest(const char* test_name);
269 void RunSubtestNoEnv(const char* test_name);
270 #endif
271
272 class FdLeakChecker {
273 public:
FdLeakChecker()274 FdLeakChecker() {
275 }
276
~FdLeakChecker()277 ~FdLeakChecker() {
278 size_t end_count = CountOpenFds();
279 EXPECT_EQ(start_count_, end_count);
280 }
281
282 private:
CountOpenFds()283 static size_t CountOpenFds() {
284 auto fd_dir = std::unique_ptr<DIR, decltype(&closedir)>{ opendir("/proc/self/fd"), closedir };
285 size_t count = 0;
286 dirent* de = nullptr;
287 while ((de = readdir(fd_dir.get())) != nullptr) {
288 if (de->d_type == DT_LNK) {
289 ++count;
290 }
291 }
292 return count;
293 }
294
295 size_t start_count_ = CountOpenFds();
296 };
297
298 // From <benchmark/benchmark.h>.
299 template <class Tp>
DoNotOptimize(Tp const & value)300 static inline void DoNotOptimize(Tp const& value) {
301 asm volatile("" : : "r,m"(value) : "memory");
302 }
303 template <class Tp>
DoNotOptimize(Tp & value)304 static inline void DoNotOptimize(Tp& value) {
305 asm volatile("" : "+r,m"(value) : : "memory");
306 }
307
running_with_mte()308 static inline bool running_with_mte() {
309 #ifdef __aarch64__
310 int level = prctl(PR_GET_TAGGED_ADDR_CTRL, 0, 0, 0, 0);
311 return level >= 0 && (level & PR_TAGGED_ADDR_ENABLE) &&
312 (level & PR_MTE_TCF_MASK) != PR_MTE_TCF_NONE;
313 #else
314 return false;
315 #endif
316 }
317
318 bool IsLowRamDevice();
319
320 int64_t NanoTime();
321
322 class Errno {
323 public:
Errno(int e)324 Errno(int e) : errno_(e) {}
325 int errno_;
326 };
327 void PrintTo(const Errno& e, std::ostream* os);
328 bool operator==(const Errno& lhs, const Errno& rhs);
329 #define ASSERT_ERRNO(expected_errno) ASSERT_EQ(Errno(expected_errno), Errno(errno))
330 #define EXPECT_ERRNO(expected_errno) EXPECT_EQ(Errno(expected_errno), Errno(errno))
331