mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
118 lines
3.9 KiB
C++
118 lines
3.9 KiB
C++
//===--- GuaranteedPhiVerifierPrivate.h -----------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2020 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_SIL_GUARANTEEDPHIVERIFIER_H
|
|
#define SWIFT_SIL_GUARANTEEDPHIVERIFIER_H
|
|
|
|
#include "LinearLifetimeCheckerPrivate.h"
|
|
|
|
#include "swift/SIL/OwnershipUtils.h"
|
|
#include "swift/SIL/SILInstruction.h"
|
|
#include "swift/SIL/SILValue.h"
|
|
|
|
namespace swift {
|
|
|
|
class DeadEndBlocks;
|
|
|
|
/// GuaranteedPhiVerifier validates the lifetime of the Reborrow or
|
|
/// GuaranteedForwardingPhi lies within the lifetime of its base value. It uses
|
|
/// LinearLifetimeChecker for this.
|
|
///
|
|
/// A GuaranteedForwardingPhi can have different base values on different
|
|
/// control flow paths. Example:
|
|
///
|
|
/// sil [ossa] @test_forwarded_separate_base_values :
|
|
/// bb0(%0 : @owned $Wrapper1):
|
|
/// %1 = begin_borrow %0 : $Wrapper1
|
|
/// cond_br undef, bb1, bb2
|
|
///
|
|
/// bb1:
|
|
/// %3 = begin_borrow %0 : $Wrapper1
|
|
/// %4 = struct_extract %1 : $Wrapper1, #Wrapper1.val1
|
|
/// br bb3(%4 : $Wrapper2, %3 : $Wrapper1)
|
|
///
|
|
/// bb2:
|
|
/// %6 = begin_borrow %0 : $Wrapper1
|
|
/// %7 = struct_extract %6 : $Wrapper1, #Wrapper1.val1
|
|
/// br bb3(%7 : $Wrapper2, %6 : $Wrapper1)
|
|
///
|
|
/// bb3(%9 : @guaranteed $Wrapper2, %10 : @guaranteed $Wrapper1):
|
|
/// end_borrow %10 : $Wrapper1
|
|
/// end_borrow %1 : $Wrapper1
|
|
/// destroy_value %0 : $Wrapper1
|
|
/// %16 = tuple ()
|
|
/// return %16 : $()
|
|
/// }
|
|
///
|
|
/// Here %10 is the base value of %9 on one path and %1 is the base value of %9
|
|
/// on another path.
|
|
/// Similarly, a Reborrow can have different base values on different
|
|
/// control flow paths. Example:
|
|
/// sil [ossa] @test_reborrow_different_base_values :
|
|
/// bb0(%0 : @owned $Wrapper):
|
|
/// cond_br undef, bb1, bb2
|
|
///
|
|
/// bb1:
|
|
/// %2 = copy_value %0 : $Wrapper
|
|
/// %3 = begin_borrow %0 : $Wrapper
|
|
/// br bb3(%3 : $Wrapper, %2 : $Wrapper)
|
|
///
|
|
/// bb2:
|
|
/// %5 = copy_value %0 : $Wrapper
|
|
/// %6 = begin_borrow %5 : $Wrapper
|
|
/// br bb3(%6 : $Wrapper, %5 : $Wrapper)
|
|
///
|
|
/// bb3(%8 : @guaranteed $Wrapper, %9 : @owned $Wrapper):
|
|
/// end_borrow %8 : $Wrapper
|
|
/// destroy_value %9 : $Wrapper
|
|
/// destroy_value %0 : $Wrapper
|
|
/// %13 = tuple ()
|
|
/// return %13 : $()
|
|
/// }
|
|
///
|
|
/// Here %9 is the base value of %8 on path and %0 is the base value on another
|
|
/// path.
|
|
///
|
|
class GuaranteedPhiVerifier {
|
|
/// A cache of dead-end basic blocks that we use to determine if we can
|
|
/// ignore "leaks".
|
|
DeadEndBlocks *deadEndBlocks = nullptr;
|
|
/// The builder that the checker uses to emit error messages, crash if asked
|
|
/// for, or supply back interesting info to the caller.
|
|
LinearLifetimeChecker::ErrorBuilder errorBuilder;
|
|
/// A map of reborrow phi/guaranteed forwarding phi to its base values.
|
|
/// Note that a reborrow phi arg can have different base values based on
|
|
/// different control flow paths.
|
|
llvm::DenseMap<SILPhiArgument *, SmallPtrSet<SILValue, 8>>
|
|
dependentPhiToBaseValueMap;
|
|
|
|
public:
|
|
GuaranteedPhiVerifier(const SILFunction *func, DeadEndBlocks *deadEndBlocks,
|
|
LinearLifetimeChecker::ErrorBuilder errorBuilder)
|
|
: deadEndBlocks(deadEndBlocks), errorBuilder(errorBuilder) {}
|
|
|
|
/// Verify whether all reborrows of \p borrow are within the lifetime of the
|
|
/// borrowed value.
|
|
void verifyReborrows(BeginBorrowInst *borrow);
|
|
/// Verify whether the GuaranteedForwardingPhi uses of \p borrow are within
|
|
/// its lifetime.
|
|
void verifyGuaranteedForwardingPhis(BorrowedValue borrow);
|
|
|
|
private:
|
|
/// Verifies whether the \p phi's lifetime lies within the \p baseValue
|
|
bool verifyDependentPhiLifetime(SILPhiArgument *phi, SILValue baseValue);
|
|
};
|
|
|
|
} // namespace swift
|
|
|
|
#endif
|