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 #ifndef __TEST_UTILS_H
18 #define __TEST_UTILS_H
19
20 #include <dlfcn.h>
21 #include <fcntl.h>
22 #include <inttypes.h>
23 #include <sys/mman.h>
24 #include <sys/types.h>
25 #include <sys/wait.h>
26 #include <unistd.h>
27
28 #include <atomic>
29 #include <string>
30 #include <regex>
31
32 #include <android-base/file.h>
33 #include <android-base/macros.h>
34 #include <android-base/scopeguard.h>
35 #include <android-base/stringprintf.h>
36
37 #if defined(__LP64__)
38 #define PATH_TO_SYSTEM_LIB "/system/lib64/"
39 #else
40 #define PATH_TO_SYSTEM_LIB "/system/lib/"
41 #endif
42
43 #if defined(__GLIBC__)
44 #define BIN_DIR "/bin/"
45 #else
46 #define BIN_DIR "/system/bin/"
47 #endif
48
49 #if defined(__BIONIC__)
50 #define KNOWN_FAILURE_ON_BIONIC(x) xfail_ ## x
51 #else
52 #define KNOWN_FAILURE_ON_BIONIC(x) x
53 #endif
54
55 // bionic's dlsym doesn't work in static binaries, so we can't access icu,
56 // so any unicode test case will fail.
have_dl()57 static inline bool have_dl() {
58 return (dlopen("libc.so", 0) != nullptr);
59 }
60
61 extern "C" void __hwasan_init() __attribute__((weak));
62
running_with_hwasan()63 static inline bool running_with_hwasan() {
64 return &__hwasan_init != 0;
65 }
66
67 #define SKIP_WITH_HWASAN if (running_with_hwasan()) GTEST_SKIP()
68
untag_address(void * addr)69 static inline void* untag_address(void* addr) {
70 #if defined(__LP64__)
71 if (running_with_hwasan()) {
72 constexpr uintptr_t mask = (static_cast<uintptr_t>(1) << 56) - 1;
73 addr = reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(addr) & mask);
74 }
75 #endif
76 return addr;
77 }
78
79 #if defined(__linux__)
80
81 #include <sys/sysmacros.h>
82
83 struct map_record {
84 uintptr_t addr_start;
85 uintptr_t addr_end;
86
87 int perms;
88
89 size_t offset;
90
91 dev_t device;
92 ino_t inode;
93
94 std::string pathname;
95 };
96
97 class Maps {
98 public:
parse_maps(std::vector<map_record> * maps)99 static bool parse_maps(std::vector<map_record>* maps) {
100 maps->clear();
101
102 std::unique_ptr<FILE, decltype(&fclose)> fp(fopen("/proc/self/maps", "re"), fclose);
103 if (!fp) return false;
104
105 char line[BUFSIZ];
106 while (fgets(line, sizeof(line), fp.get()) != nullptr) {
107 map_record record;
108 uint32_t dev_major, dev_minor;
109 int path_offset;
110 char prot[5]; // sizeof("rwxp")
111 if (sscanf(line, "%" SCNxPTR "-%" SCNxPTR " %4s %" SCNxPTR " %x:%x %lu %n",
112 &record.addr_start, &record.addr_end, prot, &record.offset,
113 &dev_major, &dev_minor, &record.inode, &path_offset) == 7) {
114 record.perms = 0;
115 if (prot[0] == 'r') {
116 record.perms |= PROT_READ;
117 }
118 if (prot[1] == 'w') {
119 record.perms |= PROT_WRITE;
120 }
121 if (prot[2] == 'x') {
122 record.perms |= PROT_EXEC;
123 }
124
125 // TODO: parse shared/private?
126
127 record.device = makedev(dev_major, dev_minor);
128 record.pathname = line + path_offset;
129 if (!record.pathname.empty() && record.pathname.back() == '\n') {
130 record.pathname.pop_back();
131 }
132 maps->push_back(record);
133 }
134 }
135
136 return true;
137 }
138 };
139
140 extern "C" pid_t gettid();
141
142 #endif
143
WaitUntilThreadSleep(std::atomic<pid_t> & tid)144 static inline void WaitUntilThreadSleep(std::atomic<pid_t>& tid) {
145 while (tid == 0) {
146 usleep(1000);
147 }
148 std::string filename = android::base::StringPrintf("/proc/%d/stat", tid.load());
149 std::regex regex {R"(\s+S\s+)"};
150
151 while (true) {
152 std::string content;
153 ASSERT_TRUE(android::base::ReadFileToString(filename, &content));
154 if (std::regex_search(content, regex)) {
155 break;
156 }
157 usleep(1000);
158 }
159 }
160
161 static inline void AssertChildExited(int pid, int expected_exit_status,
162 const std::string* error_msg = nullptr) {
163 int status;
164 std::string error;
165 if (error_msg == nullptr) {
166 error_msg = &error;
167 }
168 ASSERT_EQ(pid, TEMP_FAILURE_RETRY(waitpid(pid, &status, 0))) << *error_msg;
169 if (expected_exit_status >= 0) {
170 ASSERT_TRUE(WIFEXITED(status)) << *error_msg;
171 ASSERT_EQ(expected_exit_status, WEXITSTATUS(status)) << *error_msg;
172 } else {
173 ASSERT_TRUE(WIFSIGNALED(status)) << *error_msg;
174 ASSERT_EQ(-expected_exit_status, WTERMSIG(status)) << *error_msg;
175 }
176 }
177
AssertCloseOnExec(int fd,bool close_on_exec)178 static inline void AssertCloseOnExec(int fd, bool close_on_exec) {
179 int flags = fcntl(fd, F_GETFD);
180 ASSERT_NE(flags, -1);
181 ASSERT_EQ(close_on_exec ? FD_CLOEXEC : 0, flags & FD_CLOEXEC);
182 }
183
184 // The absolute path to the executable
185 const std::string& get_executable_path();
186
187 // Access to argc/argv/envp
188 int get_argc();
189 char** get_argv();
190 char** get_envp();
191
192 // ExecTestHelper is only used in bionic and glibc tests.
193 #ifndef __APPLE__
194 class ExecTestHelper {
195 public:
GetArgs()196 char** GetArgs() {
197 return const_cast<char**>(args_.data());
198 }
GetArg0()199 const char* GetArg0() {
200 return args_[0];
201 }
GetEnv()202 char** GetEnv() {
203 return const_cast<char**>(env_.data());
204 }
GetOutput()205 const std::string& GetOutput() {
206 return output_;
207 }
208
SetArgs(const std::vector<const char * > & args)209 void SetArgs(const std::vector<const char*>& args) {
210 args_ = args;
211 }
SetEnv(const std::vector<const char * > & env)212 void SetEnv(const std::vector<const char*>& env) {
213 env_ = env;
214 }
215
Run(const std::function<void ()> & child_fn,int expected_exit_status,const char * expected_output)216 void Run(const std::function<void()>& child_fn, int expected_exit_status,
217 const char* expected_output) {
218 int fds[2];
219 ASSERT_NE(pipe(fds), -1);
220
221 pid_t pid = fork();
222 ASSERT_NE(pid, -1);
223
224 if (pid == 0) {
225 // Child.
226 close(fds[0]);
227 dup2(fds[1], STDOUT_FILENO);
228 dup2(fds[1], STDERR_FILENO);
229 if (fds[1] != STDOUT_FILENO && fds[1] != STDERR_FILENO) close(fds[1]);
230 child_fn();
231 FAIL();
232 }
233
234 // Parent.
235 close(fds[1]);
236 output_.clear();
237 char buf[BUFSIZ];
238 ssize_t bytes_read;
239 while ((bytes_read = TEMP_FAILURE_RETRY(read(fds[0], buf, sizeof(buf)))) > 0) {
240 output_.append(buf, bytes_read);
241 }
242 close(fds[0]);
243
244 std::string error_msg("Test output:\n" + output_);
245 AssertChildExited(pid, expected_exit_status, &error_msg);
246 if (expected_output != nullptr) {
247 ASSERT_EQ(expected_output, output_);
248 }
249 }
250
251 private:
252 std::vector<const char*> args_;
253 std::vector<const char*> env_;
254 std::string output_;
255 };
256 #endif
257
258 #endif
259