cctest.cc 15.4 KB
Newer Older
1
// Copyright 2008 the V8 project authors. All rights reserved.
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
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

28
#include "test/cctest/cctest.h"
29

30
#include "include/cppgc/platform.h"
31
#include "include/libplatform/libplatform.h"
32 33 34 35 36 37
#include "include/v8-array-buffer.h"
#include "include/v8-context.h"
#include "include/v8-function.h"
#include "include/v8-isolate.h"
#include "include/v8-local-handle.h"
#include "include/v8-locker.h"
38
#include "src/base/strings.h"
39 40
#include "src/codegen/compiler.h"
#include "src/codegen/optimized-compilation-info.h"
41
#include "src/compiler/pipeline.h"
42
#include "src/debug/debug.h"
43
#include "src/flags/flags.h"
44
#include "src/objects/objects-inl.h"
eholk's avatar
eholk committed
45
#include "src/trap-handler/trap-handler.h"
46 47 48
#include "test/cctest/print-extension.h"
#include "test/cctest/profiler-extension.h"
#include "test/cctest/trace-extension.h"
49

50
#ifdef V8_USE_PERFETTO
51
#include "src/tracing/trace-event.h"
52 53
#endif  // V8_USE_PERFETTO

54
#if V8_OS_WIN
55
#include <windows.h>
56
#if V8_CC_MSVC
57
#include <crtdbg.h>
58 59
#endif
#endif
60

61 62
enum InitializationState { kUnset, kUninitialized, kInitialized };
static InitializationState initialization_state_ = kUnset;
63
static bool disable_automatic_dispose_ = false;
64

65
CcTest* CcTest::last_ = nullptr;
66
bool CcTest::initialize_called_ = false;
67
v8::base::Atomic32 CcTest::isolate_used_ = 0;
68 69
v8::ArrayBuffer::Allocator* CcTest::allocator_ = nullptr;
v8::Isolate* CcTest::isolate_ = nullptr;
70

71
CcTest::CcTest(TestFunction* callback, const char* file, const char* name,
72 73 74 75 76 77
               bool enabled, bool initialize)
    : callback_(callback),
      name_(name),
      enabled_(enabled),
      initialize_(initialize),
      prev_(last_) {
78 79 80 81 82 83
  // Find the base name of this test (const_cast required on Windows).
  char *basename = strrchr(const_cast<char *>(file), '/');
  if (!basename) {
    basename = strrchr(const_cast<char *>(file), '\\');
  }
  if (!basename) {
84
    basename = v8::internal::StrDup(file);
85
  } else {
86
    basename = v8::internal::StrDup(basename + 1);
87 88 89 90 91 92
  }
  // Drop the extension, if there is one.
  char *extension = strrchr(basename, '.');
  if (extension) *extension = 0;
  // Install this test in the list of tests
  file_ = basename;
93 94
  prev_ = last_;
  last_ = this;
95 96 97
}


98 99
void CcTest::Run() {
  if (!initialize_) {
100
    CHECK_NE(initialization_state_, kInitialized);
101
    initialization_state_ = kUninitialized;
102
    CHECK_NULL(CcTest::isolate_);
103
  } else {
104
    CHECK_NE(initialization_state_, kUninitialized);
105
    initialization_state_ = kInitialized;
106
    if (isolate_ == nullptr) {
107 108 109
      v8::Isolate::CreateParams create_params;
      create_params.array_buffer_allocator = allocator_;
      isolate_ = v8::Isolate::New(create_params);
110
    }
111
    isolate_->Enter();
112
  }
113 114 115
#ifdef DEBUG
  const size_t active_isolates = i::Isolate::non_disposed_isolates();
#endif  // DEBUG
116
  callback_();
117 118 119 120 121 122 123
#ifdef DEBUG
  // This DCHECK ensures that all Isolates are properly disposed after finishing
  // the test. Stray Isolates lead to stray tasks in the platform which can
  // interact weirdly when swapping in new platforms (for testing) or during
  // shutdown.
  DCHECK_EQ(active_isolates, i::Isolate::non_disposed_isolates());
#endif  // DEBUG
124
  if (initialize_) {
125
    if (v8::Locker::WasEverUsed()) {
126 127 128 129 130
      v8::Locker locker(isolate_);
      EmptyMessageQueues(isolate_);
    } else {
      EmptyMessageQueues(isolate_);
    }
131
    isolate_->Exit();
132 133 134
  }
}

135
i::Heap* CcTest::heap() { return i_isolate()->heap(); }
136 137 138
i::ReadOnlyHeap* CcTest::read_only_heap() {
  return i_isolate()->read_only_heap();
}
139

140 141 142 143 144 145 146 147 148 149
void CcTest::AddGlobalFunction(v8::Local<v8::Context> env, const char* name,
                               v8::FunctionCallback callback) {
  v8::Local<v8::FunctionTemplate> func_template =
      v8::FunctionTemplate::New(isolate_, callback);
  v8::Local<v8::Function> func =
      func_template->GetFunction(env).ToLocalChecked();
  func->SetName(v8_str(name));
  env->Global()->Set(env, v8_str(name), func).FromJust();
}

150 151 152
void CcTest::CollectGarbage(i::AllocationSpace space, i::Isolate* isolate) {
  i::Isolate* iso = isolate ? isolate : i_isolate();
  iso->heap()->CollectGarbage(space, i::GarbageCollectionReason::kTesting);
153 154
}

155 156 157 158
void CcTest::CollectAllGarbage(i::Isolate* isolate) {
  i::Isolate* iso = isolate ? isolate : i_isolate();
  iso->heap()->CollectAllGarbage(i::Heap::kNoGCFlags,
                                 i::GarbageCollectionReason::kTesting);
159 160
}

161 162 163
void CcTest::CollectAllAvailableGarbage(i::Isolate* isolate) {
  i::Isolate* iso = isolate ? isolate : i_isolate();
  iso->heap()->CollectAllAvailableGarbage(i::GarbageCollectionReason::kTesting);
164 165
}

166 167 168 169
void CcTest::PreciseCollectAllGarbage(i::Isolate* isolate) {
  i::Isolate* iso = isolate ? isolate : i_isolate();
  iso->heap()->PreciseCollectAllGarbage(i::Heap::kNoGCFlags,
                                        i::GarbageCollectionReason::kTesting);
170 171
}

172 173 174 175 176 177 178
i::Handle<i::String> CcTest::MakeString(const char* str) {
  i::Isolate* isolate = CcTest::i_isolate();
  i::Factory* factory = isolate->factory();
  return factory->InternalizeUtf8String(str);
}

i::Handle<i::String> CcTest::MakeName(const char* str, int suffix) {
179
  v8::base::EmbeddedVector<char, 128> buffer;
180
  v8::base::SNPrintF(buffer, "%s%d", str, suffix);
181 182 183
  return CcTest::MakeString(buffer.begin());
}

184 185 186 187 188 189 190 191 192
v8::base::RandomNumberGenerator* CcTest::random_number_generator() {
  return InitIsolateOnce()->random_number_generator();
}

v8::Local<v8::Object> CcTest::global() {
  return isolate()->GetCurrentContext()->Global();
}

void CcTest::InitializeVM() {
193
  CHECK(!v8::base::Relaxed_Load(&isolate_used_));
194 195 196 197 198 199 200
  CHECK(!initialize_called_);
  initialize_called_ = true;
  v8::HandleScope handle_scope(CcTest::isolate());
  v8::Context::New(CcTest::isolate())->Enter();
}

void CcTest::TearDown() {
201
  if (isolate_ != nullptr) isolate_->Dispose();
202
}
203

204
v8::Local<v8::Context> CcTest::NewContext(CcTestExtensionFlags extension_flags,
205
                                          v8::Isolate* isolate) {
206 207 208 209 210 211 212 213 214 215 216
  const char* extension_names[kMaxExtensions];
  int extension_count = 0;
  for (int i = 0; i < kMaxExtensions; ++i) {
    if (!extension_flags.contains(static_cast<CcTestExtensionId>(i))) continue;
    extension_names[extension_count] = kExtensionName[i];
    ++extension_count;
  }
  v8::ExtensionConfiguration config(extension_count, extension_names);
  v8::Local<v8::Context> context = v8::Context::New(isolate, &config);
  CHECK(!context.IsEmpty());
  return context;
217 218
}

219
void CcTest::DisableAutomaticDispose() {
220
  CHECK_EQ(kUninitialized, initialization_state_);
221 222 223
  disable_automatic_dispose_ = true;
}

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
LocalContext::~LocalContext() {
  v8::HandleScope scope(isolate_);
  v8::Local<v8::Context>::New(isolate_, context_)->Exit();
  context_.Reset();
}

void LocalContext::Initialize(v8::Isolate* isolate,
                              v8::ExtensionConfiguration* extensions,
                              v8::Local<v8::ObjectTemplate> global_template,
                              v8::Local<v8::Value> global_object) {
  v8::HandleScope scope(isolate);
  v8::Local<v8::Context> context =
      v8::Context::New(isolate, extensions, global_template, global_object);
  context_.Reset(isolate, context);
  context->Enter();
  // We can't do this later perhaps because of a fatal error.
  isolate_ = isolate;
}

// This indirection is needed because HandleScopes cannot be heap-allocated, and
// we don't want any unnecessary #includes in cctest.h.
245
class V8_NODISCARD InitializedHandleScopeImpl {
246 247 248 249 250 251 252 253
 public:
  explicit InitializedHandleScopeImpl(i::Isolate* isolate)
      : handle_scope_(isolate) {}

 private:
  i::HandleScope handle_scope_;
};

254 255
InitializedHandleScope::InitializedHandleScope(i::Isolate* isolate)
    : main_isolate_(isolate ? isolate : CcTest::InitIsolateOnce()),
256 257 258
      initialized_handle_scope_impl_(
          new InitializedHandleScopeImpl(main_isolate_)) {}

259
InitializedHandleScope::~InitializedHandleScope() = default;
260

261 262 263
HandleAndZoneScope::HandleAndZoneScope(bool support_zone_compression)
    : main_zone_(
          new i::Zone(&allocator_, ZONE_NAME, support_zone_compression)) {}
264

265
HandleAndZoneScope::~HandleAndZoneScope() = default;
266

267 268 269
i::Handle<i::JSFunction> Optimize(
    i::Handle<i::JSFunction> function, i::Zone* zone, i::Isolate* isolate,
    uint32_t flags, std::unique_ptr<i::compiler::JSHeapBroker>* out_broker) {
270
  i::Handle<i::SharedFunctionInfo> shared(function->shared(), isolate);
271
  i::IsCompiledScope is_compiled_scope(shared->is_compiled_scope(isolate));
272
  CHECK(is_compiled_scope.is_compiled() ||
273
        i::Compiler::Compile(isolate, function, i::Compiler::CLEAR_EXCEPTION,
274 275 276 277
                             &is_compiled_scope));

  CHECK_NOT_NULL(zone);

278
  i::OptimizedCompilationInfo info(zone, isolate, shared, function,
279
                                   i::CodeKind::TURBOFAN);
280

281
  if (flags & ~i::OptimizedCompilationInfo::kInlining) UNIMPLEMENTED();
282 283
  if (flags & i::OptimizedCompilationInfo::kInlining) {
    info.set_inlining();
284 285 286
  }

  CHECK(info.shared_info()->HasBytecodeArray());
287
  i::JSFunction::EnsureFeedbackVector(function, &is_compiled_scope);
288 289 290 291

  i::Handle<i::Code> code =
      i::compiler::Pipeline::GenerateCodeForTesting(&info, isolate, out_broker)
          .ToHandleChecked();
292
  info.native_context().AddOptimizedCode(*code);
293
  function->set_code(*code, v8::kReleaseStore);
294 295 296 297

  return function;
}

298
static void PrintTestList(CcTest* current) {
299
  if (current == nullptr) return;
300
  PrintTestList(current->prev());
301
  printf("%s/%s\n", current->file(), current->name());
302 303 304
}


305 306 307 308 309 310
static void SuggestTestHarness(int tests) {
  if (tests == 0) return;
  printf("Running multiple tests in sequence is deprecated and may cause "
         "bogus failure.  Consider using tools/run-tests.py instead.\n");
}

311
int main(int argc, char* argv[]) {
312
#if V8_OS_WIN
313 314 315 316
  UINT new_flags =
      SEM_FAILCRITICALERRORS | SEM_NOGPFAULTERRORBOX | SEM_NOOPENFILEERRORBOX;
  UINT existing_flags = SetErrorMode(new_flags);
  SetErrorMode(existing_flags | new_flags);
317
#if V8_CC_MSVC
318 319 320 321 322 323 324
  _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_DEBUG | _CRTDBG_MODE_FILE);
  _CrtSetReportFile(_CRT_WARN, _CRTDBG_FILE_STDERR);
  _CrtSetReportMode(_CRT_ASSERT, _CRTDBG_MODE_DEBUG | _CRTDBG_MODE_FILE);
  _CrtSetReportFile(_CRT_ASSERT, _CRTDBG_FILE_STDERR);
  _CrtSetReportMode(_CRT_ERROR, _CRTDBG_MODE_DEBUG | _CRTDBG_MODE_FILE);
  _CrtSetReportFile(_CRT_ERROR, _CRTDBG_FILE_STDERR);
  _set_error_mode(_OUT_TO_STDERR);
325 326
#endif  // V8_CC_MSVC
#endif  // V8_OS_WIN
327

328 329 330 331 332
  std::string usage = "Usage: " + std::string(argv[0]) + " [--list]" +
                      " [[V8_FLAGS] CCTEST]\n\n" + "Options:\n" +
                      "  --list:   list all cctests\n" +
                      "  CCTEST:   cctest identfier returned by --list\n" +
                      "  V8_FLAGS: see V8 options below\n\n\n";
333

334
#ifdef V8_USE_PERFETTO
335
  // Set up the in-process backend that the tracing controller will connect to.
336 337 338 339 340
  perfetto::TracingInitArgs init_args;
  init_args.backends = perfetto::BackendType::kInProcessBackend;
  perfetto::Tracing::Initialize(init_args);
#endif  // V8_USE_PERFETTO

341
  v8::V8::InitializeICUDefaultLocation(argv[0]);
342 343
  std::unique_ptr<v8::Platform> platform(v8::platform::NewDefaultPlatform());
  v8::V8::InitializePlatform(platform.get());
344 345 346
#ifdef V8_VIRTUAL_MEMORY_CAGE
  CHECK(v8::V8::InitializeVirtualMemoryCage());
#endif
347
  cppgc::InitializeProcess(platform->GetPageAllocator());
348 349 350
  using HelpOptions = v8::internal::FlagList::HelpOptions;
  v8::internal::FlagList::SetFlagsFromCommandLine(
      &argc, argv, true, HelpOptions(HelpOptions::kExit, usage.c_str()));
351
  v8::V8::Initialize();
vogelheim's avatar
vogelheim committed
352
  v8::V8::InitializeExternalStartupData(argv[0]);
353

354
#if V8_ENABLE_WEBASSEMBLY && V8_TRAP_HANDLER_SUPPORTED
355 356 357
  constexpr bool kUseDefaultTrapHandler = true;
  CHECK(v8::V8::EnableWebAssemblyTrapHandler(kUseDefaultTrapHandler));
#endif  // V8_ENABLE_WEBASSEMBLY && V8_TRAP_HANDLER_SUPPORTED
eholk's avatar
eholk committed
358

359 360
  CcTest::set_array_buffer_allocator(
      v8::ArrayBuffer::Allocator::NewDefaultAllocator());
361

362 363 364
  v8::RegisterExtension(std::make_unique<i::PrintExtension>());
  v8::RegisterExtension(std::make_unique<i::ProfilerExtension>());
  v8::RegisterExtension(std::make_unique<i::TraceExtension>());
365

366 367 368 369 370 371 372
  int tests_run = 0;
  bool print_run_count = true;
  for (int i = 1; i < argc; i++) {
    char* arg = argv[i];
    if (strcmp(arg, "--list") == 0) {
      PrintTestList(CcTest::last());
      print_run_count = false;
373

374
    } else {
375
      char* arg_copy = v8::internal::StrDup(arg);
376 377 378 379 380
      char* testname = strchr(arg_copy, '/');
      if (testname) {
        // Split the string in two by nulling the slash and then run
        // exact matches.
        *testname = 0;
381 382 383
        char* file = arg_copy;
        char* name = testname + 1;
        CcTest* test = CcTest::last();
384
        while (test != nullptr) {
385 386 387
          if (test->enabled()
              && strcmp(test->file(), file) == 0
              && strcmp(test->name(), name) == 0) {
388
            SuggestTestHarness(tests_run++);
389 390 391 392 393
            test->Run();
          }
          test = test->prev();
        }

394 395
      } else {
        // Run all tests with the specified file or test name.
396 397
        char* file_or_name = arg_copy;
        CcTest* test = CcTest::last();
398
        while (test != nullptr) {
399 400 401
          if (test->enabled()
              && (strcmp(test->file(), file_or_name) == 0
                  || strcmp(test->name(), file_or_name) == 0)) {
402
            SuggestTestHarness(tests_run++);
403 404 405 406
            test->Run();
          }
          test = test->prev();
        }
407
      }
408
      v8::internal::DeleteArray<char>(arg_copy);
409
    }
410
  }
411 412
  if (print_run_count && tests_run != 1)
    printf("Ran %i tests.\n", tests_run);
413
  CcTest::TearDown();
414
  if (!disable_automatic_dispose_) v8::V8::Dispose();
415
  v8::V8::ShutdownPlatform();
416
  return 0;
417
}
418

419
RegisterThreadedTest* RegisterThreadedTest::first_ = nullptr;
420
int RegisterThreadedTest::count_ = 0;
421 422 423 424

bool IsValidUnwrapObject(v8::Object* object) {
  i::Address addr = *reinterpret_cast<i::Address*>(object);
  auto instance_type = i::Internals::GetInstanceType(addr);
425 426 427 428
  return (v8::base::IsInRange(instance_type,
                              i::Internals::kFirstJSApiObjectType,
                              i::Internals::kLastJSApiObjectType) ||
          instance_type == i::Internals::kJSObjectType ||
429 430
          instance_type == i::Internals::kJSSpecialApiObjectType);
}