1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
|
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ART_LIBARTBASE_BASE_COMMON_ART_TEST_H_
#define ART_LIBARTBASE_BASE_COMMON_ART_TEST_H_
#include <gtest/gtest.h>
#include <functional>
#include <string>
#include <sys/wait.h>
#include <android-base/logging.h>
#include "base/file_utils.h"
#include "base/globals.h"
#include "base/memory_tool.h"
#include "base/mutex.h"
#include "base/os.h"
#include "base/unix_file/fd_file.h"
#include "dex/art_dex_file_loader.h"
#include "dex/compact_dex_level.h"
#include "dex/compact_dex_file.h"
namespace art {
using LogSeverity = android::base::LogSeverity;
using ScopedLogSeverity = android::base::ScopedLogSeverity;
class DexFile;
class ScratchDir {
public:
ScratchDir();
~ScratchDir();
const std::string& GetPath() const {
return path_;
}
private:
std::string path_;
DISALLOW_COPY_AND_ASSIGN(ScratchDir);
};
class ScratchFile {
public:
ScratchFile();
explicit ScratchFile(const std::string& filename);
ScratchFile(const ScratchFile& other, const char* suffix);
ScratchFile(ScratchFile&& other) noexcept;
ScratchFile& operator=(ScratchFile&& other) noexcept;
explicit ScratchFile(File* file);
~ScratchFile();
const std::string& GetFilename() const {
return filename_;
}
File* GetFile() const {
return file_.get();
}
int GetFd() const;
void Close();
void Unlink();
private:
std::string filename_;
std::unique_ptr<File> file_;
};
// Close to store a fake dex file and its underlying data.
class FakeDex {
public:
static std::unique_ptr<FakeDex> Create(
const std::string& location,
uint32_t checksum,
uint32_t num_method_ids) {
FakeDex* fake_dex = new FakeDex();
fake_dex->dex = CreateFakeDex(location, checksum, num_method_ids, &fake_dex->storage);
return std::unique_ptr<FakeDex>(fake_dex);
}
static std::unique_ptr<const DexFile> CreateFakeDex(
const std::string& location,
uint32_t checksum,
uint32_t num_method_ids,
std::vector<uint8_t>* storage) {
storage->resize(kPageSize);
CompactDexFile::Header* header =
const_cast<CompactDexFile::Header*>(CompactDexFile::Header::At(storage->data()));
CompactDexFile::WriteMagic(header->magic_);
CompactDexFile::WriteCurrentVersion(header->magic_);
header->data_off_ = 0;
header->data_size_ = storage->size();
header->method_ids_size_ = num_method_ids;
const DexFileLoader dex_file_loader;
std::string error_msg;
std::unique_ptr<const DexFile> dex(dex_file_loader.Open(storage->data(),
storage->size(),
location,
checksum,
/*oat_dex_file=*/nullptr,
/*verify=*/false,
/*verify_checksum=*/false,
&error_msg));
CHECK(dex != nullptr) << error_msg;
return dex;
}
std::unique_ptr<const DexFile>& Dex() {
return dex;
}
private:
std::vector<uint8_t> storage;
std::unique_ptr<const DexFile> dex;
};
// Convenience class to store multiple fake dex files in order to make
// allocation/de-allocation easier in tests.
class FakeDexStorage {
public:
const DexFile* AddFakeDex(
const std::string& location,
uint32_t checksum,
uint32_t num_method_ids) {
fake_dex_files.push_back(FakeDex::Create(location, checksum, num_method_ids));
return fake_dex_files.back()->Dex().get();
}
private:
std::vector<std::unique_ptr<FakeDex>> fake_dex_files;
};
class CommonArtTestImpl {
public:
CommonArtTestImpl() = default;
virtual ~CommonArtTestImpl() = default;
// Set up ANDROID_BUILD_TOP, ANDROID_HOST_OUT, ANDROID_ROOT, ANDROID_I18N_ROOT,
// ANDROID_ART_ROOT, and ANDROID_TZDATA_ROOT environment variables using sensible defaults
// if not already set.
static void SetUpAndroidRootEnvVars();
// Set up the ANDROID_DATA environment variable, creating the directory if required.
// Note: setting up ANDROID_DATA may create a temporary directory. If this is used in a
// non-derived class, be sure to also call the corresponding tear-down below.
static void SetUpAndroidDataDir(std::string& android_data);
static void TearDownAndroidDataDir(const std::string& android_data, bool fail_on_error);
// Get the names of the libcore modules.
virtual std::vector<std::string> GetLibCoreModuleNames() const;
// Gets the paths of the libcore dex files for given modules.
std::vector<std::string> GetLibCoreDexFileNames(const std::vector<std::string>& modules) const;
// Gets the paths of the libcore dex files.
std::vector<std::string> GetLibCoreDexFileNames() const;
// Gets the locations of the libcore dex files for given modules.
std::vector<std::string> GetLibCoreDexLocations(const std::vector<std::string>& modules) const;
// Gets the locations of the libcore dex files.
std::vector<std::string> GetLibCoreDexLocations() const;
static std::string GetClassPathOption(const char* option,
const std::vector<std::string>& class_path);
// Returns bin directory which contains host's prebuild tools.
static std::string GetAndroidHostToolsDir();
// Retuerns the filename for a test dex (i.e. XandY or ManyMethods).
std::string GetTestDexFileName(const char* name) const;
template <typename Mutator>
bool MutateDexFile(File* output_dex, const std::string& input_jar, const Mutator& mutator) {
std::vector<std::unique_ptr<const DexFile>> dex_files;
std::string error_msg;
const ArtDexFileLoader dex_file_loader;
CHECK(dex_file_loader.Open(input_jar.c_str(),
input_jar.c_str(),
/*verify*/ true,
/*verify_checksum*/ true,
&error_msg,
&dex_files)) << error_msg;
EXPECT_EQ(dex_files.size(), 1u) << "Only one input dex is supported";
const std::unique_ptr<const DexFile>& dex = dex_files[0];
CHECK(dex->EnableWrite()) << "Failed to enable write";
DexFile* dex_file = const_cast<DexFile*>(dex.get());
mutator(dex_file);
const_cast<DexFile::Header&>(dex_file->GetHeader()).checksum_ = dex_file->CalculateChecksum();
if (!output_dex->WriteFully(dex->Begin(), dex->Size())) {
return false;
}
if (output_dex->Flush() != 0) {
PLOG(FATAL) << "Could not flush the output file.";
}
return true;
}
struct ForkAndExecResult {
enum Stage {
kLink,
kFork,
kWaitpid,
kFinished,
};
Stage stage;
int status_code;
bool StandardSuccess() {
return stage == kFinished && WIFEXITED(status_code) && WEXITSTATUS(status_code) == 0;
}
};
using OutputHandlerFn = std::function<void(char*, size_t)>;
using PostForkFn = std::function<bool()>;
static ForkAndExecResult ForkAndExec(const std::vector<std::string>& argv,
const PostForkFn& post_fork,
const OutputHandlerFn& handler);
static ForkAndExecResult ForkAndExec(const std::vector<std::string>& argv,
const PostForkFn& post_fork,
std::string* output);
protected:
static bool IsHost() {
return !kIsTargetBuild;
}
// Helper - find directory with the following format:
// ${ANDROID_BUILD_TOP}/${subdir1}/${subdir2}-${version}/${subdir3}/bin/
static std::string GetAndroidToolsDir(const std::string& subdir1,
const std::string& subdir2,
const std::string& subdir3);
// File location to core.art, e.g. $ANDROID_HOST_OUT/system/framework/core.art
static std::string GetCoreArtLocation();
// File location to core.oat, e.g. $ANDROID_HOST_OUT/system/framework/core.oat
static std::string GetCoreOatLocation();
std::unique_ptr<const DexFile> LoadExpectSingleDexFile(const char* location);
void ClearDirectory(const char* dirpath, bool recursive = true);
// Open a file (allows reading of framework jars).
std::vector<std::unique_ptr<const DexFile>> OpenDexFiles(const char* filename);
// Open a single dex file (aborts if there are more than one).
std::unique_ptr<const DexFile> OpenDexFile(const char* filename);
// Open a test file (art-gtest-*.jar).
std::vector<std::unique_ptr<const DexFile>> OpenTestDexFiles(const char* name);
std::unique_ptr<const DexFile> OpenTestDexFile(const char* name);
std::string android_data_;
std::string dalvik_cache_;
virtual void SetUp();
virtual void TearDown();
// Creates the class path string for the given dex files (the list of dex file locations
// separated by ':').
std::string CreateClassPath(const std::vector<std::unique_ptr<const DexFile>>& dex_files);
// Same as CreateClassPath but add the dex file checksum after each location. The separator
// is '*'.
std::string CreateClassPathWithChecksums(
const std::vector<std::unique_ptr<const DexFile>>& dex_files);
static std::string GetCoreFileLocation(const char* suffix);
std::vector<std::unique_ptr<const DexFile>> loaded_dex_files_;
};
template <typename TestType>
class CommonArtTestBase : public TestType, public CommonArtTestImpl {
public:
CommonArtTestBase() {}
virtual ~CommonArtTestBase() {}
protected:
void SetUp() override {
CommonArtTestImpl::SetUp();
}
void TearDown() override {
CommonArtTestImpl::TearDown();
}
};
using CommonArtTest = CommonArtTestBase<testing::Test>;
template <typename Param>
using CommonArtTestWithParam = CommonArtTestBase<testing::TestWithParam<Param>>;
#define TEST_DISABLED_FOR_TARGET() \
if (kIsTargetBuild) { \
printf("WARNING: TEST DISABLED FOR TARGET\n"); \
return; \
}
#define TEST_DISABLED_FOR_NON_STATIC_HOST_BUILDS() \
if (!kHostStaticBuildEnabled) { \
printf("WARNING: TEST DISABLED FOR NON-STATIC HOST BUILDS\n"); \
return; \
}
#define TEST_DISABLED_FOR_MEMORY_TOOL() \
if (kRunningOnMemoryTool) { \
printf("WARNING: TEST DISABLED FOR MEMORY TOOL\n"); \
return; \
}
#define TEST_DISABLED_FOR_HEAP_POISONING() \
if (kPoisonHeapReferences) { \
printf("WARNING: TEST DISABLED FOR HEAP POISONING\n"); \
return; \
}
} // namespace art
#define TEST_DISABLED_FOR_MEMORY_TOOL_WITH_HEAP_POISONING() \
if (kRunningOnMemoryTool && kPoisonHeapReferences) { \
printf("WARNING: TEST DISABLED FOR MEMORY TOOL WITH HEAP POISONING\n"); \
return; \
}
#endif // ART_LIBARTBASE_BASE_COMMON_ART_TEST_H_
|