common_runtime_test.cc revision 5b8e6e36e96d6d1921dd356fa46191d1e6a18082
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#include "common_runtime_test.h" 18 19#include <dirent.h> 20#include <dlfcn.h> 21#include <fcntl.h> 22#include <ScopedLocalRef.h> 23 24#include "../../external/icu/icu4c/source/common/unicode/uvernum.h" 25#include "base/macros.h" 26#include "base/logging.h" 27#include "base/stl_util.h" 28#include "base/stringprintf.h" 29#include "base/unix_file/fd_file.h" 30#include "class_linker.h" 31#include "compiler_callbacks.h" 32#include "dex_file.h" 33#include "gc_root-inl.h" 34#include "gc/heap.h" 35#include "gtest/gtest.h" 36#include "jni_internal.h" 37#include "mirror/class_loader.h" 38#include "noop_compiler_callbacks.h" 39#include "os.h" 40#include "runtime-inl.h" 41#include "scoped_thread_state_change.h" 42#include "thread.h" 43#include "well_known_classes.h" 44 45int main(int argc, char **argv) { 46 art::InitLogging(argv); 47 LOG(INFO) << "Running main() from common_runtime_test.cc..."; 48 testing::InitGoogleTest(&argc, argv); 49 return RUN_ALL_TESTS(); 50} 51 52namespace art { 53 54ScratchFile::ScratchFile() { 55 // ANDROID_DATA needs to be set 56 CHECK_NE(static_cast<char*>(nullptr), getenv("ANDROID_DATA")) << 57 "Are you subclassing RuntimeTest?"; 58 filename_ = getenv("ANDROID_DATA"); 59 filename_ += "/TmpFile-XXXXXX"; 60 int fd = mkstemp(&filename_[0]); 61 CHECK_NE(-1, fd); 62 file_.reset(new File(fd, GetFilename(), true)); 63} 64 65ScratchFile::ScratchFile(const ScratchFile& other, const char* suffix) { 66 filename_ = other.GetFilename(); 67 filename_ += suffix; 68 int fd = open(filename_.c_str(), O_RDWR | O_CREAT, 0666); 69 CHECK_NE(-1, fd); 70 file_.reset(new File(fd, GetFilename(), true)); 71} 72 73ScratchFile::ScratchFile(File* file) { 74 CHECK(file != NULL); 75 filename_ = file->GetPath(); 76 file_.reset(file); 77} 78 79ScratchFile::~ScratchFile() { 80 Unlink(); 81} 82 83int ScratchFile::GetFd() const { 84 return file_->Fd(); 85} 86 87void ScratchFile::Close() { 88 if (file_.get() != nullptr) { 89 if (file_->FlushCloseOrErase() != 0) { 90 PLOG(WARNING) << "Error closing scratch file."; 91 } 92 } 93} 94 95void ScratchFile::Unlink() { 96 if (!OS::FileExists(filename_.c_str())) { 97 return; 98 } 99 Close(); 100 int unlink_result = unlink(filename_.c_str()); 101 CHECK_EQ(0, unlink_result); 102} 103 104CommonRuntimeTest::CommonRuntimeTest() {} 105CommonRuntimeTest::~CommonRuntimeTest() {} 106 107void CommonRuntimeTest::SetUpAndroidRoot() { 108 if (IsHost()) { 109 // $ANDROID_ROOT is set on the device, but not necessarily on the host. 110 // But it needs to be set so that icu4c can find its locale data. 111 const char* android_root_from_env = getenv("ANDROID_ROOT"); 112 if (android_root_from_env == nullptr) { 113 // Use ANDROID_HOST_OUT for ANDROID_ROOT if it is set. 114 const char* android_host_out = getenv("ANDROID_HOST_OUT"); 115 if (android_host_out != nullptr) { 116 setenv("ANDROID_ROOT", android_host_out, 1); 117 } else { 118 // Build it from ANDROID_BUILD_TOP or cwd 119 std::string root; 120 const char* android_build_top = getenv("ANDROID_BUILD_TOP"); 121 if (android_build_top != nullptr) { 122 root += android_build_top; 123 } else { 124 // Not set by build server, so default to current directory 125 char* cwd = getcwd(nullptr, 0); 126 setenv("ANDROID_BUILD_TOP", cwd, 1); 127 root += cwd; 128 free(cwd); 129 } 130#if defined(__linux__) 131 root += "/out/host/linux-x86"; 132#elif defined(__APPLE__) 133 root += "/out/host/darwin-x86"; 134#else 135#error unsupported OS 136#endif 137 setenv("ANDROID_ROOT", root.c_str(), 1); 138 } 139 } 140 setenv("LD_LIBRARY_PATH", ":", 0); // Required by java.lang.System.<clinit>. 141 142 // Not set by build server, so default 143 if (getenv("ANDROID_HOST_OUT") == nullptr) { 144 setenv("ANDROID_HOST_OUT", getenv("ANDROID_ROOT"), 1); 145 } 146 } 147} 148 149void CommonRuntimeTest::SetUpAndroidData(std::string& android_data) { 150 // On target, Cannot use /mnt/sdcard because it is mounted noexec, so use subdir of dalvik-cache 151 if (IsHost()) { 152 const char* tmpdir = getenv("TMPDIR"); 153 if (tmpdir != nullptr && tmpdir[0] != 0) { 154 android_data = tmpdir; 155 } else { 156 android_data = "/tmp"; 157 } 158 } else { 159 android_data = "/data/dalvik-cache"; 160 } 161 android_data += "/art-data-XXXXXX"; 162 if (mkdtemp(&android_data[0]) == nullptr) { 163 PLOG(FATAL) << "mkdtemp(\"" << &android_data[0] << "\") failed"; 164 } 165 setenv("ANDROID_DATA", android_data.c_str(), 1); 166} 167 168void CommonRuntimeTest::TearDownAndroidData(const std::string& android_data, bool fail_on_error) { 169 if (fail_on_error) { 170 ASSERT_EQ(rmdir(android_data.c_str()), 0); 171 } else { 172 rmdir(android_data.c_str()); 173 } 174} 175 176 177const DexFile* CommonRuntimeTest::LoadExpectSingleDexFile(const char* location) { 178 std::vector<const DexFile*> dex_files; 179 std::string error_msg; 180 if (!DexFile::Open(location, location, &error_msg, &dex_files)) { 181 LOG(FATAL) << "Could not open .dex file '" << location << "': " << error_msg << "\n"; 182 return nullptr; 183 } else { 184 CHECK_EQ(1U, dex_files.size()) << "Expected only one dex file in " << location; 185 return dex_files[0]; 186 } 187} 188 189void CommonRuntimeTest::SetUp() { 190 SetUpAndroidRoot(); 191 SetUpAndroidData(android_data_); 192 dalvik_cache_.append(android_data_.c_str()); 193 dalvik_cache_.append("/dalvik-cache"); 194 int mkdir_result = mkdir(dalvik_cache_.c_str(), 0700); 195 ASSERT_EQ(mkdir_result, 0); 196 197 MemMap::Init(); // For LoadExpectSingleDexFile 198 199 std::string error_msg; 200 201 java_lang_dex_file_ = nullptr; 202 for (const std::string &core_dex_file_name : GetLibCoreDexFileNames()) { 203 const DexFile* dex_file = LoadExpectSingleDexFile(core_dex_file_name.c_str()); 204 boot_class_path_.push_back(dex_file); 205 // Store the first dex file in java_lang_dex_file_ 206 if (java_lang_dex_file_ == nullptr) { 207 java_lang_dex_file_ = dex_file; 208 } 209 } 210 211 std::string min_heap_string(StringPrintf("-Xms%zdm", gc::Heap::kDefaultInitialSize / MB)); 212 std::string max_heap_string(StringPrintf("-Xmx%zdm", gc::Heap::kDefaultMaximumSize / MB)); 213 214 callbacks_.reset(new NoopCompilerCallbacks()); 215 216 RuntimeOptions options; 217 options.push_back(std::make_pair("bootclasspath", &boot_class_path_)); 218 options.push_back(std::make_pair("-Xcheck:jni", nullptr)); 219 options.push_back(std::make_pair(min_heap_string.c_str(), nullptr)); 220 options.push_back(std::make_pair(max_heap_string.c_str(), nullptr)); 221 options.push_back(std::make_pair("compilercallbacks", callbacks_.get())); 222 SetUpRuntimeOptions(&options); 223 if (!Runtime::Create(options, false)) { 224 LOG(FATAL) << "Failed to create runtime"; 225 return; 226 } 227 runtime_.reset(Runtime::Current()); 228 class_linker_ = runtime_->GetClassLinker(); 229 class_linker_->FixupDexCaches(runtime_->GetResolutionMethod()); 230 class_linker_->RunRootClinits(); 231 232 // Runtime::Create acquired the mutator_lock_ that is normally given away when we 233 // Runtime::Start, give it away now and then switch to a more managable ScopedObjectAccess. 234 Thread::Current()->TransitionFromRunnableToSuspended(kNative); 235 236 // We're back in native, take the opportunity to initialize well known classes. 237 WellKnownClasses::Init(Thread::Current()->GetJniEnv()); 238 239 // Create the heap thread pool so that the GC runs in parallel for tests. Normally, the thread 240 // pool is created by the runtime. 241 runtime_->GetHeap()->CreateThreadPool(); 242 runtime_->GetHeap()->VerifyHeap(); // Check for heap corruption before the test 243} 244 245void CommonRuntimeTest::ClearDirectory(const char* dirpath) { 246 ASSERT_TRUE(dirpath != nullptr); 247 DIR* dir = opendir(dirpath); 248 ASSERT_TRUE(dir != nullptr); 249 dirent* e; 250 struct stat s; 251 while ((e = readdir(dir)) != nullptr) { 252 if ((strcmp(e->d_name, ".") == 0) || (strcmp(e->d_name, "..") == 0)) { 253 continue; 254 } 255 std::string filename(dirpath); 256 filename.push_back('/'); 257 filename.append(e->d_name); 258 int stat_result = lstat(filename.c_str(), &s); 259 ASSERT_EQ(0, stat_result) << "unable to stat " << filename; 260 if (S_ISDIR(s.st_mode)) { 261 ClearDirectory(filename.c_str()); 262 int rmdir_result = rmdir(filename.c_str()); 263 ASSERT_EQ(0, rmdir_result) << filename; 264 } else { 265 int unlink_result = unlink(filename.c_str()); 266 ASSERT_EQ(0, unlink_result) << filename; 267 } 268 } 269 closedir(dir); 270} 271 272void CommonRuntimeTest::TearDown() { 273 const char* android_data = getenv("ANDROID_DATA"); 274 ASSERT_TRUE(android_data != nullptr); 275 ClearDirectory(dalvik_cache_.c_str()); 276 int rmdir_cache_result = rmdir(dalvik_cache_.c_str()); 277 ASSERT_EQ(0, rmdir_cache_result); 278 TearDownAndroidData(android_data_, true); 279 280 // icu4c has a fixed 10-element array "gCommonICUDataArray". 281 // If we run > 10 tests, we fill that array and u_setCommonData fails. 282 // There's a function to clear the array, but it's not public... 283 typedef void (*IcuCleanupFn)(); 284 void* sym = dlsym(RTLD_DEFAULT, "u_cleanup_" U_ICU_VERSION_SHORT); 285 CHECK(sym != nullptr) << dlerror(); 286 IcuCleanupFn icu_cleanup_fn = reinterpret_cast<IcuCleanupFn>(sym); 287 (*icu_cleanup_fn)(); 288 289 STLDeleteElements(&opened_dex_files_); 290 291 Runtime::Current()->GetHeap()->VerifyHeap(); // Check for heap corruption after the test 292} 293 294std::vector<std::string> CommonRuntimeTest::GetLibCoreDexFileNames() { 295 return std::vector<std::string>({GetDexFileName("core-oj"), GetDexFileName("core-libart")}); 296} 297 298std::string CommonRuntimeTest::GetDexFileName(const std::string& jar_prefix) { 299 if (IsHost()) { 300 const char* host_dir = getenv("ANDROID_HOST_OUT"); 301 CHECK(host_dir != nullptr); 302 return StringPrintf("%s/framework/%s-hostdex.jar", host_dir, jar_prefix.c_str()); 303 } 304 return StringPrintf("%s/framework/%s.jar", GetAndroidRoot(), jar_prefix.c_str()); 305} 306 307std::string CommonRuntimeTest::GetTestAndroidRoot() { 308 if (IsHost()) { 309 const char* host_dir = getenv("ANDROID_HOST_OUT"); 310 CHECK(host_dir != nullptr); 311 return host_dir; 312 } 313 return GetAndroidRoot(); 314} 315 316// Check that for target builds we have ART_TARGET_NATIVETEST_DIR set. 317#ifdef ART_TARGET 318#ifndef ART_TARGET_NATIVETEST_DIR 319#error "ART_TARGET_NATIVETEST_DIR not set." 320#endif 321// Wrap it as a string literal. 322#define ART_TARGET_NATIVETEST_DIR_STRING STRINGIFY(ART_TARGET_NATIVETEST_DIR) "/" 323#else 324#define ART_TARGET_NATIVETEST_DIR_STRING "" 325#endif 326 327std::vector<const DexFile*> CommonRuntimeTest::OpenTestDexFiles(const char* name) { 328 CHECK(name != nullptr); 329 std::string filename; 330 if (IsHost()) { 331 filename += getenv("ANDROID_HOST_OUT"); 332 filename += "/framework/"; 333 } else { 334 filename += ART_TARGET_NATIVETEST_DIR_STRING; 335 } 336 filename += "art-gtest-"; 337 filename += name; 338 filename += ".jar"; 339 std::string error_msg; 340 std::vector<const DexFile*> dex_files; 341 bool success = DexFile::Open(filename.c_str(), filename.c_str(), &error_msg, &dex_files); 342 CHECK(success) << "Failed to open '" << filename << "': " << error_msg; 343 for (const DexFile* dex_file : dex_files) { 344 CHECK_EQ(PROT_READ, dex_file->GetPermissions()); 345 CHECK(dex_file->IsReadOnly()); 346 } 347 opened_dex_files_.insert(opened_dex_files_.end(), dex_files.begin(), dex_files.end()); 348 return dex_files; 349} 350 351const DexFile* CommonRuntimeTest::OpenTestDexFile(const char* name) { 352 std::vector<const DexFile*> vector = OpenTestDexFiles(name); 353 EXPECT_EQ(1U, vector.size()); 354 return vector[0]; 355} 356 357jobject CommonRuntimeTest::LoadDex(const char* dex_name) { 358 std::vector<const DexFile*> dex_files = OpenTestDexFiles(dex_name); 359 CHECK_NE(0U, dex_files.size()); 360 for (const DexFile* dex_file : dex_files) { 361 class_linker_->RegisterDexFile(*dex_file); 362 } 363 ScopedObjectAccessUnchecked soa(Thread::Current()); 364 ScopedLocalRef<jobject> class_loader_local(soa.Env(), 365 soa.Env()->AllocObject(WellKnownClasses::dalvik_system_PathClassLoader)); 366 jobject class_loader = soa.Env()->NewGlobalRef(class_loader_local.get()); 367 soa.Self()->SetClassLoaderOverride(soa.Decode<mirror::ClassLoader*>(class_loader_local.get())); 368 Runtime::Current()->SetCompileTimeClassPath(class_loader, dex_files); 369 return class_loader; 370} 371 372CheckJniAbortCatcher::CheckJniAbortCatcher() : vm_(Runtime::Current()->GetJavaVM()) { 373 vm_->check_jni_abort_hook = Hook; 374 vm_->check_jni_abort_hook_data = &actual_; 375} 376 377CheckJniAbortCatcher::~CheckJniAbortCatcher() { 378 vm_->check_jni_abort_hook = nullptr; 379 vm_->check_jni_abort_hook_data = nullptr; 380 EXPECT_TRUE(actual_.empty()) << actual_; 381} 382 383void CheckJniAbortCatcher::Check(const char* expected_text) { 384 EXPECT_TRUE(actual_.find(expected_text) != std::string::npos) << "\n" 385 << "Expected to find: " << expected_text << "\n" 386 << "In the output : " << actual_; 387 actual_.clear(); 388} 389 390void CheckJniAbortCatcher::Hook(void* data, const std::string& reason) { 391 // We use += because when we're hooking the aborts like this, multiple problems can be found. 392 *reinterpret_cast<std::string*>(data) += reason; 393} 394 395} // namespace art 396 397namespace std { 398 399template <typename T> 400std::ostream& operator<<(std::ostream& os, const std::vector<T>& rhs) { 401os << ::art::ToString(rhs); 402return os; 403} 404 405} // namespace std 406