mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
4cd1201bab
I am purposely doing this in SILGen rather than at the type system level to
avoid having to have to add a bunch of boilerplate to the type system. Instead
of doing that, I am in SILGen checking for the isNoImplicitCopy bit on the
ParamDecl when we emit arguments. At that point, I set on the specific
SILArgument being emitted the bit that it is no implicit copy. In terms of
printing at the SIL level, I just printed it in front of the function argument
type like @owned, e.x.:
func myFunc(_ x: @_noImplicitCopy T) -> T {
...
}
becomes:
bb0(%0 : @noImplicitCopy @owned $T):
Some notes:
* Just to be explicit, I am making it so that no implicit copy parameters by
default are always passed at +1. The reason why I think this makes sense is
that this is the natural way of working with a move only value.
* As always, one can not write no implicit copy the attribute without passing
the flag -enable-experimental-move-only so this is NFC.
rdar://83957088
500 lines
19 KiB
C++
500 lines
19 KiB
C++
//===--- SILArgument.h - SIL BasicBlock Argument Representation -*- C++ -*-===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_SIL_SILARGUMENT_H
|
|
#define SWIFT_SIL_SILARGUMENT_H
|
|
|
|
#include "swift/Basic/Compiler.h"
|
|
#include "swift/SIL/SILArgumentConvention.h"
|
|
#include "swift/SIL/SILValue.h"
|
|
#include "swift/SIL/SILFunctionConventions.h"
|
|
|
|
namespace swift {
|
|
|
|
class SILBasicBlock;
|
|
class SILModule;
|
|
class SILUndef;
|
|
class TermInst;
|
|
|
|
// Map an argument index onto a SILArgumentConvention.
|
|
inline SILArgumentConvention
|
|
SILFunctionConventions::getSILArgumentConvention(unsigned index) const {
|
|
assert(index <= getNumSILArguments());
|
|
if (index < getNumIndirectSILResults()) {
|
|
assert(silConv.loweredAddresses);
|
|
return SILArgumentConvention::Indirect_Out;
|
|
} else {
|
|
auto param = funcTy->getParameters()[index - getNumIndirectSILResults()];
|
|
return SILArgumentConvention(param.getConvention());
|
|
}
|
|
}
|
|
|
|
struct SILArgumentKind {
|
|
enum innerty : std::underlying_type<ValueKind>::type {
|
|
#define ARGUMENT(ID, PARENT) ID = unsigned(SILNodeKind::ID),
|
|
#define ARGUMENT_RANGE(ID, FIRST, LAST) First_##ID = FIRST, Last_##ID = LAST,
|
|
#include "swift/SIL/SILNodes.def"
|
|
} value;
|
|
|
|
explicit SILArgumentKind(ValueKind kind)
|
|
: value(*SILArgumentKind::fromValueKind(kind)) {}
|
|
SILArgumentKind(innerty value) : value(value) {}
|
|
operator innerty() const { return value; }
|
|
|
|
static Optional<SILArgumentKind> fromValueKind(ValueKind kind) {
|
|
switch (kind) {
|
|
#define ARGUMENT(ID, PARENT) \
|
|
case ValueKind::ID: \
|
|
return SILArgumentKind(ID);
|
|
#include "swift/SIL/SILNodes.def"
|
|
default:
|
|
return None;
|
|
}
|
|
}
|
|
};
|
|
|
|
class SILArgument : public ValueBase {
|
|
friend class SILBasicBlock;
|
|
|
|
SILBasicBlock *parentBlock;
|
|
const ValueDecl *decl;
|
|
|
|
protected:
|
|
SILArgument(ValueKind subClassKind, SILBasicBlock *inputParentBlock,
|
|
SILType type, ValueOwnershipKind ownershipKind,
|
|
const ValueDecl *inputDecl = nullptr);
|
|
|
|
// A special constructor, only intended for use in
|
|
// SILBasicBlock::replacePHIArg and replaceFunctionArg.
|
|
explicit SILArgument(ValueKind subClassKind, SILType type,
|
|
ValueOwnershipKind ownershipKind,
|
|
const ValueDecl *inputDecl = nullptr)
|
|
: ValueBase(subClassKind, type),
|
|
parentBlock(nullptr), decl(inputDecl) {
|
|
Bits.SILArgument.VOKind = static_cast<unsigned>(ownershipKind);
|
|
}
|
|
|
|
public:
|
|
void operator=(const SILArgument &) = delete;
|
|
void operator delete(void *, size_t) = delete;
|
|
|
|
ValueOwnershipKind getOwnershipKind() const {
|
|
return static_cast<ValueOwnershipKind>(Bits.SILArgument.VOKind);
|
|
}
|
|
|
|
void setOwnershipKind(ValueOwnershipKind newKind) {
|
|
Bits.SILArgument.VOKind = static_cast<unsigned>(newKind);
|
|
}
|
|
|
|
SILBasicBlock *getParent() const { return parentBlock; }
|
|
|
|
SILFunction *getFunction();
|
|
const SILFunction *getFunction() const;
|
|
|
|
SILModule &getModule() const;
|
|
|
|
const ValueDecl *getDecl() const { return decl; }
|
|
|
|
static bool classof(const SILInstruction *) = delete;
|
|
static bool classof(const SILUndef *) = delete;
|
|
static bool classof(SILNodePointer node) {
|
|
return node->getKind() >= SILNodeKind::First_SILArgument &&
|
|
node->getKind() <= SILNodeKind::Last_SILArgument;
|
|
}
|
|
|
|
bool isNoImplicitCopy() const;
|
|
|
|
unsigned getIndex() const;
|
|
|
|
/// Return true if this block argument is actually a phi argument as
|
|
/// opposed to a cast or projection.
|
|
bool isPhiArgument() const;
|
|
|
|
/// Return true if this block argument is a terminator result.
|
|
bool isTerminatorResult() const;
|
|
|
|
/// If this argument is a phi, return the incoming phi value for the given
|
|
/// predecessor BB. If this argument is not a phi, return an invalid SILValue.
|
|
SILValue getIncomingPhiValue(SILBasicBlock *predBlock) const;
|
|
|
|
/// If this argument is a phi, populate `OutArray` with the incoming phi
|
|
/// values for each predecessor BB. If this argument is not a phi, return
|
|
/// false.
|
|
bool getIncomingPhiValues(SmallVectorImpl<SILValue> &returnedPhiValues) const;
|
|
|
|
/// If this argument is a phi, populate `OutArray` with each predecessor block
|
|
/// and its incoming phi value. If this argument is not a phi, return false.
|
|
bool
|
|
getIncomingPhiValues(SmallVectorImpl<std::pair<SILBasicBlock *, SILValue>>
|
|
&returnedPredAndPhiValuePairs) const;
|
|
|
|
/// If this argument is a true phi, populate `OutArray` with the operand in
|
|
/// each predecessor block associated with an incoming value.
|
|
bool
|
|
getIncomingPhiOperands(SmallVectorImpl<Operand *> &returnedPhiOperands) const;
|
|
|
|
/// If this argument is a true phi, for each operand in each predecessor block
|
|
/// associated with an incoming value, call visitor(op). Visitor must return
|
|
/// true for iteration to continue. False to stop it.
|
|
///
|
|
/// Returns false if this is not a true phi or that a visitor signaled error
|
|
/// by returning false.
|
|
bool visitIncomingPhiOperands(function_ref<bool(Operand *)> visitor) const;
|
|
|
|
/// Returns true if we were able to find a single terminator operand value for
|
|
/// each predecessor of this arguments basic block. The found values are
|
|
/// stored in OutArray.
|
|
///
|
|
/// Note: this peeks through any projections or cast implied by the
|
|
/// terminator. e.g. the incoming value for a switch_enum payload argument is
|
|
/// the enum itself (the operand of the switch_enum).
|
|
bool getSingleTerminatorOperands(
|
|
SmallVectorImpl<SILValue> &returnedSingleTermOperands) const;
|
|
|
|
/// Returns true if we were able to find single terminator operand values for
|
|
/// each predecessor of this arguments basic block. The found values are
|
|
/// stored in OutArray alongside their predecessor block.
|
|
///
|
|
/// Note: this peeks through any projections or cast implied by the
|
|
/// terminator. e.g. the incoming value for a switch_enum payload argument is
|
|
/// the enum itself (the operand of the switch_enum).
|
|
bool getSingleTerminatorOperands(
|
|
SmallVectorImpl<std::pair<SILBasicBlock *, SILValue>>
|
|
&returnedSingleTermOperands) const;
|
|
|
|
/// If this SILArgument's parent block has a single predecessor whose
|
|
/// terminator has a single operand, return the incoming operand of the
|
|
/// predecessor's terminator. Returns SILValue() otherwise. Note that for
|
|
/// some predecessor terminators the incoming value is not exactly the
|
|
/// argument value. E.g. the incoming value for a switch_enum payload argument
|
|
/// is the enum itself (the operand of the switch_enum).
|
|
SILValue getSingleTerminatorOperand() const;
|
|
|
|
/// If this SILArgument's parent block has a single predecessor whose
|
|
/// terminator has a single operand, return that terminator.
|
|
TermInst *getSingleTerminator() const;
|
|
|
|
/// Return the terminator instruction for which this argument is a result,
|
|
/// otherwise return nullptr.
|
|
TermInst *getTerminatorForResult() const;
|
|
|
|
/// Return the SILArgumentKind of this argument.
|
|
SILArgumentKind getKind() const {
|
|
return SILArgumentKind(ValueBase::getKind());
|
|
}
|
|
|
|
protected:
|
|
void setParent(SILBasicBlock *newParentBlock) {
|
|
parentBlock = newParentBlock;
|
|
}
|
|
};
|
|
|
|
inline SILArgument *castToArgument(SwiftObject argument) {
|
|
return static_cast<SILArgument *>(argument);
|
|
}
|
|
|
|
class SILPhiArgument : public SILArgument {
|
|
friend class SILBasicBlock;
|
|
|
|
SILPhiArgument(SILBasicBlock *parentBlock, SILType type,
|
|
ValueOwnershipKind ownershipKind,
|
|
const ValueDecl *decl = nullptr)
|
|
: SILArgument(ValueKind::SILPhiArgument, parentBlock, type, ownershipKind,
|
|
decl) {}
|
|
// A special constructor, only intended for use in
|
|
// SILBasicBlock::replacePHIArg.
|
|
explicit SILPhiArgument(SILType type, ValueOwnershipKind ownershipKind,
|
|
const ValueDecl *decl = nullptr)
|
|
: SILArgument(ValueKind::SILPhiArgument, type, ownershipKind, decl) {}
|
|
|
|
public:
|
|
/// Return true if this is block argument is actually a phi argument as
|
|
/// opposed to a cast or projection.
|
|
bool isPhiArgument() const;
|
|
|
|
/// Return true if this block argument is a terminator result.
|
|
bool isTerminatorResult() const { return !isPhiArgument(); }
|
|
|
|
/// If this argument is a phi, return the incoming phi value for the given
|
|
/// predecessor BB. If this argument is not a phi, return an invalid SILValue.
|
|
///
|
|
/// FIXME: Once SILPhiArgument actually implies that it is a phi argument,
|
|
/// this will be guaranteed to return a valid SILValue.
|
|
SILValue getIncomingPhiValue(SILBasicBlock *predBlock) const;
|
|
|
|
/// If this argument is a true phi, return the operand in the \p predBLock
|
|
/// associated with an incoming value.
|
|
///
|
|
/// \returns the operand or nullptr if this is not a true phi.
|
|
Operand *getIncomingPhiOperand(SILBasicBlock *predBlock) const;
|
|
|
|
/// If this argument is a phi, populate `OutArray` with the incoming phi
|
|
/// values for each predecessor BB. If this argument is not a phi, return
|
|
/// false.
|
|
///
|
|
/// FIXME: Once SILPhiArgument actually implies that it is a phi argument,
|
|
/// this will always succeed.
|
|
bool getIncomingPhiValues(SmallVectorImpl<SILValue> &returnedPhiValues) const;
|
|
|
|
/// If this argument is a phi, populate `OutArray` with each predecessor block
|
|
/// and its incoming phi value. If this argument is not a phi, return false.
|
|
///
|
|
/// FIXME: Once SILPhiArgument actually implies that it is a phi argument,
|
|
/// this will always succeed.
|
|
bool
|
|
getIncomingPhiValues(SmallVectorImpl<std::pair<SILBasicBlock *, SILValue>>
|
|
&returnedPredAndPhiValuePairs) const;
|
|
|
|
/// If this argument is a true phi, populate `OutArray` with the operand in
|
|
/// each predecessor block associated with an incoming value.
|
|
bool
|
|
getIncomingPhiOperands(SmallVectorImpl<Operand *> &returnedPhiOperands) const;
|
|
|
|
/// If this argument is a phi, call visitor for each passing the operand for
|
|
/// each incoming phi values for each predecessor BB. If this argument is not
|
|
/// a phi, return false.
|
|
///
|
|
/// If visitor returns false, iteration is stopped and we return false.
|
|
bool visitIncomingPhiOperands(function_ref<bool(Operand *)> visitor) const;
|
|
|
|
/// Returns true if we were able to find a single terminator operand value for
|
|
/// each predecessor of this arguments basic block. The found values are
|
|
/// stored in OutArray.
|
|
///
|
|
/// Note: this peeks through any projections or cast implied by the
|
|
/// terminator. e.g. the incoming value for a switch_enum payload argument is
|
|
/// the enum itself (the operand of the switch_enum).
|
|
bool getSingleTerminatorOperands(
|
|
SmallVectorImpl<SILValue> &returnedSingleTermOperands) const;
|
|
|
|
/// Returns true if we were able to find single terminator operand values for
|
|
/// each predecessor of this arguments basic block. The found values are
|
|
/// stored in OutArray alongside their predecessor block.
|
|
///
|
|
/// Note: this peeks through any projections or cast implied by the
|
|
/// terminator. e.g. the incoming value for a switch_enum payload argument is
|
|
/// the enum itself (the operand of the switch_enum).
|
|
bool getSingleTerminatorOperands(
|
|
SmallVectorImpl<std::pair<SILBasicBlock *, SILValue>>
|
|
&returnedSingleTermOperands) const;
|
|
|
|
/// If this SILArgument's parent block has a single predecessor whose
|
|
/// terminator has a single operand, return the incoming operand of the
|
|
/// predecessor's terminator. Returns SILValue() otherwise. Note that for
|
|
/// some predecessor terminators the incoming value is not exactly the
|
|
/// argument value. E.g. the incoming value for a switch_enum payload argument
|
|
/// is the enum itself (the operand of the switch_enum).
|
|
SILValue getSingleTerminatorOperand() const;
|
|
|
|
/// If this SILArgument's parent block has a single predecessor whose
|
|
/// terminator has a single operand, return that terminator.
|
|
TermInst *getSingleTerminator() const;
|
|
|
|
/// Return the terminator instruction for which this argument is a result,
|
|
/// otherwise return nullptr.
|
|
TermInst *getTerminatorForResult() const;
|
|
|
|
static bool classof(const SILInstruction *) = delete;
|
|
static bool classof(const SILUndef *) = delete;
|
|
static bool classof(SILNodePointer node) {
|
|
return node->getKind() == SILNodeKind::SILPhiArgument;
|
|
}
|
|
};
|
|
|
|
class SILFunctionArgument : public SILArgument {
|
|
friend class SILBasicBlock;
|
|
|
|
bool noImplicitCopy = false;
|
|
|
|
SILFunctionArgument(SILBasicBlock *parentBlock, SILType type,
|
|
ValueOwnershipKind ownershipKind,
|
|
const ValueDecl *decl = nullptr,
|
|
bool isNoImplicitCopy = false)
|
|
: SILArgument(ValueKind::SILFunctionArgument, parentBlock, type,
|
|
ownershipKind, decl),
|
|
noImplicitCopy(isNoImplicitCopy) {}
|
|
// A special constructor, only intended for use in
|
|
// SILBasicBlock::replaceFunctionArg.
|
|
explicit SILFunctionArgument(SILType type, ValueOwnershipKind ownershipKind,
|
|
const ValueDecl *decl = nullptr)
|
|
: SILArgument(ValueKind::SILFunctionArgument, type, ownershipKind, decl) {
|
|
}
|
|
|
|
public:
|
|
bool isNoImplicitCopy() const { return noImplicitCopy; }
|
|
|
|
void setNoImplicitCopy(bool newValue) { noImplicitCopy = newValue; }
|
|
|
|
bool isIndirectResult() const;
|
|
|
|
SILArgumentConvention getArgumentConvention() const;
|
|
|
|
/// Given that this is an entry block argument, and given that it does
|
|
/// not correspond to an indirect result, return the corresponding
|
|
/// SILParameterInfo.
|
|
SILParameterInfo getKnownParameterInfo() const;
|
|
|
|
/// Returns true if this SILArgument is the self argument of its
|
|
/// function. This means that this will return false always for SILArguments
|
|
/// of SILFunctions that do not have self argument and for non-function
|
|
/// argument SILArguments.
|
|
bool isSelf() const;
|
|
|
|
/// Returns true if this SILArgument is passed via the given convention.
|
|
bool hasConvention(SILArgumentConvention convention) const {
|
|
return getArgumentConvention() == convention;
|
|
}
|
|
|
|
static bool classof(const SILInstruction *) = delete;
|
|
static bool classof(const SILUndef *) = delete;
|
|
static bool classof(SILNodePointer node) {
|
|
return node->getKind() == SILNodeKind::SILFunctionArgument;
|
|
}
|
|
};
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// Out of line Definitions for SILArgument to avoid Forward Decl issues
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
inline bool SILArgument::isPhiArgument() const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->isPhiArgument();
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return false;
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
inline bool SILArgument::isNoImplicitCopy() const {
|
|
if (auto *fArg = dyn_cast<SILFunctionArgument>(this))
|
|
return fArg->isNoImplicitCopy();
|
|
return false;
|
|
}
|
|
|
|
inline bool SILArgument::isTerminatorResult() const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->isTerminatorResult();
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return false;
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
inline SILValue
|
|
SILArgument::getIncomingPhiValue(SILBasicBlock *predBlock) const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->getIncomingPhiValue(predBlock);
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return SILValue();
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
inline bool SILArgument::getIncomingPhiValues(
|
|
SmallVectorImpl<SILValue> &returnedPhiValues) const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->getIncomingPhiValues(returnedPhiValues);
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return false;
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
inline bool SILArgument::getIncomingPhiValues(
|
|
SmallVectorImpl<std::pair<SILBasicBlock *, SILValue>>
|
|
&returnedPredAndPhiValuePairs) const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->getIncomingPhiValues(
|
|
returnedPredAndPhiValuePairs);
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return false;
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
inline bool SILArgument::getSingleTerminatorOperands(
|
|
SmallVectorImpl<SILValue> &returnedSingleTermOperands) const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->getSingleTerminatorOperands(
|
|
returnedSingleTermOperands);
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return false;
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
inline bool SILArgument::getSingleTerminatorOperands(
|
|
SmallVectorImpl<std::pair<SILBasicBlock *, SILValue>>
|
|
&returnedSingleTermOperands) const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->getSingleTerminatorOperands(
|
|
returnedSingleTermOperands);
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return false;
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
inline TermInst *SILArgument::getSingleTerminator() const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->getSingleTerminator();
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return nullptr;
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
inline TermInst *SILArgument::getTerminatorForResult() const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->getTerminatorForResult();
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return nullptr;
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
inline bool SILArgument::getIncomingPhiOperands(
|
|
SmallVectorImpl<Operand *> &returnedPhiOperands) const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->getIncomingPhiOperands(
|
|
returnedPhiOperands);
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return false;
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
inline bool SILArgument::visitIncomingPhiOperands(
|
|
function_ref<bool(Operand *)> visitor) const {
|
|
switch (getKind()) {
|
|
case SILArgumentKind::SILPhiArgument:
|
|
return cast<SILPhiArgument>(this)->visitIncomingPhiOperands(visitor);
|
|
case SILArgumentKind::SILFunctionArgument:
|
|
return false;
|
|
}
|
|
llvm_unreachable("Covered switch is not covered?!");
|
|
}
|
|
|
|
} // end swift namespace
|
|
|
|
#endif
|