Files
swift-mirror/lib/SILOptimizer/UtilityPasses/ConstantEvaluatorTester.cpp
Ravi Kandhadai 22861ec0fd [Constant Evaluator] Pass assert configuartion option to the
evaluator to precisely evaluate Builtin.assert_configuration.

Unify UnknownReason::Trap and UnknownReason::AssertionFailure error
values in the constant evaluator, now that we have 'condfail_message'
SIL instruction, which provides an error message for the traps.
2019-09-18 17:35:46 -07:00

121 lines
3.9 KiB
C++

//===-----ConstantEvaluatorTester.cpp - Test Constant Evaluator -----------===//
//
// 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-constant-evaluation-tester"
#include "swift/AST/DiagnosticsSIL.h"
#include "swift/SIL/SILConstants.h"
#include "swift/SILOptimizer/PassManager/Passes.h"
#include "swift/SILOptimizer/PassManager/Transforms.h"
#include "swift/SILOptimizer/Utils/ConstExpr.h"
using namespace swift;
namespace {
template <typename... T, typename... U>
static InFlightDiagnostic diagnose(ASTContext &Context, SourceLoc loc,
Diag<T...> diag, U &&... args) {
return Context.Diags.diagnose(loc, diag, std::forward<U>(args)...);
}
/// A compiler pass for testing constant evaluator in the step-wise evaluation
/// mode. The pass evaluates SIL functions whose names start with "interpret"
/// and outputs the constant value returned by the function or diagnostics if
/// the evaluation fails.
class ConstantEvaluatorTester : public SILFunctionTransform {
bool shouldInterpret() {
auto *fun = getFunction();
return fun->getName().startswith("interpret");
}
bool shouldSkipInstruction(SILInstruction *inst) {
auto *applyInst = dyn_cast<ApplyInst>(inst);
if (!applyInst)
return false;
auto *callee = applyInst->getReferencedFunctionOrNull();
if (!callee)
return false;
return callee->getName().startswith("skip");
}
void run() override {
SILFunction *fun = getFunction();
if (!shouldInterpret() || fun->empty())
return;
llvm::errs() << "@" << fun->getName() << "\n";
SymbolicValueBumpAllocator allocator;
ConstExprStepEvaluator stepEvaluator(allocator, fun,
getOptions().AssertConfig);
for (auto currI = fun->getEntryBlock()->begin();;) {
auto *inst = &(*currI);
if (auto *returnInst = dyn_cast<ReturnInst>(inst)) {
auto returnVal =
stepEvaluator.lookupConstValue(returnInst->getOperand());
if (!returnVal) {
llvm::errs() << "Returns unknown"
<< "\n";
break;
}
llvm::errs() << "Returns " << returnVal.getValue() << "\n";
break;
}
Optional<SILBasicBlock::iterator> nextInstOpt;
Optional<SymbolicValue> errorVal;
// If the instruction is marked as skip, skip it and make its effects
// non-constant. Otherwise, try evaluating the instruction and if the
// evaluation fails due to a previously skipped instruction,
// skip the current instruction.
if (shouldSkipInstruction(inst)) {
std::tie(nextInstOpt, errorVal) =
stepEvaluator.skipByMakingEffectsNonConstant(currI);
} else {
std::tie(nextInstOpt, errorVal) =
stepEvaluator.tryEvaluateOrElseMakeEffectsNonConstant(currI);
}
// Diagnose errors in the evaluation. Unknown symbolic values produced
// by skipping instructions are not considered errors.
if (errorVal.hasValue() &&
!errorVal->isUnknownDueToUnevaluatedInstructions()) {
errorVal->emitUnknownDiagnosticNotes(inst->getLoc());
break;
}
if (!nextInstOpt) {
diagnose(fun->getASTContext(), inst->getLoc().getSourceLoc(),
diag::constexpr_unknown_control_flow_due_to_skip);
errorVal->emitUnknownDiagnosticNotes(inst->getLoc());
break;
}
currI = nextInstOpt.getValue();
}
}
};
} // end anonymous namespace
SILTransform *swift::createConstantEvaluatorTester() {
return new ConstantEvaluatorTester();
}