Files
swift-mirror/lib/SIL/Utils/Test.cpp
Nate Chandler 73d57c9012 [Test] Avoid LSAN report of leaked FunctionTest.
Avoid heap-allocating an immortal FunctionTest with `new` because it
results in LSAN reporting a leak.

In fact, the "leaked" value wasn't leaked: a reference to it was stored
in a global map when the type's constructor ran.  It was only a leak in
the sense that it was never freed, not that there was a dangling
allocation which couldn't be freed.

Work around this by storing the global instances themselves in a second
static structure.  Store pointers to the instances into the global map
as before.

rdar://118134637
2023-11-14 15:05:18 -08:00

127 lines
3.9 KiB
C++

//===- ParseTestSpecification.h - Parsing for test instructions -*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// This file defines test::FunctionTest.
//
//===----------------------------------------------------------------------===//
#include "swift/SIL/Test.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/Support/raw_ostream.h"
using namespace llvm;
using namespace swift;
using namespace swift::test;
namespace {
class Registry {
DenseMap<StringRef, FunctionTest *> registeredTests;
SwiftNativeFunctionTestThunk thunk;
public:
static Registry &get() {
static Registry registry;
return registry;
}
void registerFunctionTest(FunctionTest *test, StringRef name) {
auto inserted = registeredTests.insert({name, test}).second;
assert(inserted);
(void)inserted;
}
void registerFunctionTestThunk(SwiftNativeFunctionTestThunk thunk) {
this->thunk = thunk;
}
SwiftNativeFunctionTestThunk getFunctionTestThunk() { return thunk; }
FunctionTest *getFunctionTest(StringRef name) {
auto *res = registeredTests[name];
if (!res) {
llvm::errs() << "Found no test named " << name << "!\n";
print(llvm::errs());
}
return res;
}
void print(raw_ostream &OS) const {
OS << "test::Registry(" << this << ") with " << registeredTests.size()
<< " entries: {{\n";
for (auto pair : registeredTests) {
OS << "\t" << pair.getFirst() << " -> " << pair.getSecond() << "\n";
}
OS << "}} test::Registry(" << this << ")\n";
}
void dump() const { print(llvm::dbgs()); }
};
} // end anonymous namespace
void registerFunctionTestThunk(SwiftNativeFunctionTestThunk thunk) {
Registry::get().registerFunctionTestThunk(thunk);
}
FunctionTest::FunctionTest(StringRef name, Invocation invocation)
: invocation(invocation), pass(nullptr), function(nullptr),
dependencies(nullptr) {
Registry::get().registerFunctionTest(this, name);
}
FunctionTest::FunctionTest(StringRef name, NativeSwiftInvocation invocation)
: invocation(invocation), pass(nullptr), function(nullptr),
dependencies(nullptr) {}
void FunctionTest::createNativeSwiftFunctionTest(
StringRef name, NativeSwiftInvocation invocation) {
/// Statically allocate the tests to avoid triggering LSAN's "leak" detection.
static SmallVector<FunctionTest, 4> tests;
auto &test = tests.emplace_back(name, invocation);
Registry::get().registerFunctionTest(&test, name);
}
FunctionTest *FunctionTest::get(StringRef name) {
return Registry::get().getFunctionTest(name);
}
void FunctionTest::run(SILFunction &function, Arguments &arguments,
SILFunctionTransform &pass, Dependencies &dependencies) {
this->pass = &pass;
this->function = &function;
this->dependencies = &dependencies;
if (invocation.isa<Invocation>()) {
auto fn = invocation.get<Invocation>();
fn(function, arguments, *this);
} else {
llvm::outs().flush();
auto *fn = invocation.get<NativeSwiftInvocation>();
Registry::get().getFunctionTestThunk()(fn, {&function}, {&arguments},
{getSwiftPassInvocation()});
}
this->pass = nullptr;
this->function = nullptr;
this->dependencies = nullptr;
}
DominanceInfo *FunctionTest::getDominanceInfo() {
return dependencies->getDominanceInfo();
}
SILPassManager *FunctionTest::getPassManager() {
return dependencies->getPassManager();
}
SwiftPassInvocation *FunctionTest::getSwiftPassInvocation() {
return dependencies->getSwiftPassInvocation();
}