Files
swift-mirror/lib/SILOptimizer/UtilityPasses/MemBehaviorDumper.cpp
Erik Eckstein 8828d8e6bf tests: clean-up MemBehavior tests
Add more relevant instructions to dump in MemBehaviorDumper.
Therefore the -enable-mem-behavior-dump-all option can be removed.
Also mem-behavior-all.sil into mem-behavior.sil, because the sil-opt command lines don't differ anymore.
2021-03-24 11:19:00 +01:00

122 lines
4.1 KiB
C++

//===--- MemBehaviorDumper.cpp --------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 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
//
//===----------------------------------------------------------------------===//
#define DEBUG_TYPE "sil-mem-behavior-dumper"
#include "swift/SIL/SILArgument.h"
#include "swift/SIL/SILFunction.h"
#include "swift/SIL/SILValue.h"
#include "swift/SILOptimizer/Analysis/AliasAnalysis.h"
#include "swift/SILOptimizer/Analysis/Analysis.h"
#include "swift/SILOptimizer/Analysis/SideEffectAnalysis.h"
#include "swift/SILOptimizer/PassManager/Passes.h"
#include "swift/SILOptimizer/PassManager/Transforms.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Debug.h"
using namespace swift;
//===----------------------------------------------------------------------===//
// Value Gatherer
//===----------------------------------------------------------------------===//
// Return a list of all instruction values in Fn. Returns true if we have at
// least two values to compare.
static bool gatherValues(SILFunction &Fn, std::vector<SILValue> &Values) {
for (auto &BB : Fn) {
for (auto *Arg : BB.getArguments())
Values.push_back(SILValue(Arg));
for (auto &II : BB) {
for (auto result : II.getResults())
Values.push_back(result);
}
}
return Values.size() > 1;
}
//===----------------------------------------------------------------------===//
// Top Level Driver
//===----------------------------------------------------------------------===//
namespace {
/// Dumps the memory behavior of instructions in a function.
class MemBehaviorDumper : public SILModuleTransform {
// To reduce the amount of output, we only dump the memory behavior of
// selected types of instructions.
static bool shouldTestInstruction(SILInstruction *I) {
switch (I->getKind()) {
case SILInstructionKind::ApplyInst:
case SILInstructionKind::TryApplyInst:
case SILInstructionKind::EndApplyInst:
case SILInstructionKind::BeginApplyInst:
case SILInstructionKind::AbortApplyInst:
case SILInstructionKind::BeginAccessInst:
case SILInstructionKind::EndAccessInst:
case SILInstructionKind::EndCOWMutationInst:
case SILInstructionKind::CopyValueInst:
case SILInstructionKind::DestroyValueInst:
case SILInstructionKind::EndBorrowInst:
case SILInstructionKind::LoadInst:
case SILInstructionKind::StoreInst:
case SILInstructionKind::CopyAddrInst:
return true;
default:
return false;
}
}
void run() override {
for (auto &Fn : *getModule()) {
llvm::outs() << "@" << Fn.getName() << "\n";
// Gather up all Values in Fn.
std::vector<SILValue> Values;
if (!gatherValues(Fn, Values))
continue;
AliasAnalysis *AA = PM->getAnalysis<AliasAnalysis>();
unsigned PairCount = 0;
for (auto &BB : Fn) {
for (auto &I : BB) {
if (shouldTestInstruction(&I)) {
// Print the memory behavior in relation to all other values in the
// function.
for (auto &V : Values) {
if (V->getDefiningInstruction() == &I)
continue;
if (!V->getType().isAddress() && !isa<AddressToPointerInst>(V))
continue;
bool Read = AA->mayReadFromMemory(&I, V);
bool Write = AA->mayWriteToMemory(&I, V);
llvm::outs() << "PAIR #" << PairCount++ << ".\n"
<< " " << I << " " << V
<< " r=" << Read << ",w=" << Write << "\n";
}
}
}
}
llvm::outs() << "\n";
}
}
};
} // end anonymous namespace
SILTransform *swift::createMemBehaviorDumper() {
return new MemBehaviorDumper();
}