Files
swift-mirror/lib/SILOptimizer/ARC/ARCMatchingSet.h
John McCall e249fd680e Destructure result types in SIL function types.
Similarly to how we've always handled parameter types, we
now recursively expand tuples in result types and separately
determine a result convention for each result.

The most important code-generation change here is that
indirect results are now returned separately from each
other and from any direct results.  It is generally far
better, when receiving an indirect result, to receive it
as an independent result; the caller is much more likely
to be able to directly receive the result in the address
they want to initialize, rather than having to receive it
in temporary memory and then copy parts of it into the
target.

The most important conceptual change here that clients and
producers of SIL must be aware of is the new distinction
between a SILFunctionType's *parameters* and its *argument
list*.  The former is just the formal parameters, derived
purely from the parameter types of the original function;
indirect results are no longer in this list.  The latter
includes the indirect result arguments; as always, all
the indirect results strictly precede the parameters.
Apply instructions and entry block arguments follow the
argument list, not the parameter list.

A relatively minor change is that there can now be multiple
direct results, each with its own result convention.
This is a minor change because I've chosen to leave
return instructions as taking a single operand and
apply instructions as producing a single result; when
the type describes multiple results, they are implicitly
bound up in a tuple.  It might make sense to split these
up and allow e.g. return instructions to take a list
of operands; however, it's not clear what to do on the
caller side, and this would be a major change that can
be separated out from this already over-large patch.

Unsurprisingly, the most invasive changes here are in
SILGen; this requires substantial reworking of both call
emission and reabstraction.  It also proved important
to switch several SILGen operations over to work with
RValue instead of ManagedValue, since otherwise they
would be forced to spuriously "implode" buffers.
2016-02-18 01:26:28 -08:00

143 lines
4.5 KiB
C++

//===--- ARCMatchingSet.h ---------------------------------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_SILOPTIMIZER_PASSMANAGER_GLOBALARCPAIRINGANALYSIS_H
#define SWIFT_SILOPTIMIZER_PASSMANAGER_GLOBALARCPAIRINGANALYSIS_H
#include "GlobalARCSequenceDataflow.h"
#include "GlobalLoopARCSequenceDataflow.h"
#include "swift/SIL/SILValue.h"
#include "swift/SILOptimizer/Utils/LoopUtils.h"
#include "swift/SILOptimizer/Analysis/RCIdentityAnalysis.h"
#include "llvm/ADT/SetVector.h"
namespace swift {
class SILInstruction;
class SILFunction;
class AliasAnalysis;
class PostOrderAnalysis;
class LoopRegionFunctionInfo;
class SILLoopInfo;
class RCIdentityFunctionInfo;
/// A set of matching reference count increments, decrements, increment
/// insertion pts, and decrement insertion pts.
struct ARCMatchingSet {
/// The pointer that this ARCMatchingSet is providing matching increment and
/// decrement sets for.
///
/// TODO: This should really be called RCIdentity.
SILValue Ptr;
/// The set of reference count increments that were paired.
llvm::SetVector<SILInstruction *> Increments;
/// An insertion point for an increment means the earliest point in the
/// program after the increment has occurred that the increment can be moved
/// to
/// without moving the increment over an instruction that may decrement a
/// reference count.
llvm::SetVector<SILInstruction *> IncrementInsertPts;
/// The set of reference count decrements that were paired.
llvm::SetVector<SILInstruction *> Decrements;
/// An insertion point for a decrement means the latest point in the program
/// before the decrement that the optimizer conservatively assumes that a
/// reference counted value could be used.
llvm::SetVector<SILInstruction *> DecrementInsertPts;
// This is a data structure that cannot be moved or copied.
ARCMatchingSet() = default;
ARCMatchingSet(const ARCMatchingSet &) = delete;
ARCMatchingSet(ARCMatchingSet &&) = delete;
ARCMatchingSet &operator=(const ARCMatchingSet &) = delete;
ARCMatchingSet &operator=(ARCMatchingSet &&) = delete;
void clear() {
Ptr = SILValue();
Increments.clear();
IncrementInsertPts.clear();
Decrements.clear();
DecrementInsertPts.clear();
}
};
struct MatchingSetFlags {
bool KnownSafe;
bool Partial;
};
static_assert(std::is_pod<MatchingSetFlags>::value,
"MatchingSetFlags should be a pod.");
struct ARCMatchingSetBuilder {
using TDMapTy = BlotMapVector<SILInstruction *, TopDownRefCountState>;
using BUMapTy = BlotMapVector<SILInstruction *, BottomUpRefCountState>;
TDMapTy &TDMap;
BUMapTy &BUMap;
llvm::SmallVector<SILInstruction *, 8> NewIncrements;
llvm::SmallVector<SILInstruction *, 8> NewDecrements;
bool MatchedPair;
ARCMatchingSet MatchSet;
bool PtrIsGuaranteedArg;
RCIdentityFunctionInfo *RCIA;
public:
ARCMatchingSetBuilder(TDMapTy &TDMap, BUMapTy &BUMap,
RCIdentityFunctionInfo *RCIA)
: TDMap(TDMap), BUMap(BUMap), MatchedPair(false),
PtrIsGuaranteedArg(false), RCIA(RCIA) {}
void init(SILInstruction *Inst) {
clear();
MatchSet.Ptr = RCIA->getRCIdentityRoot(Inst->getOperand(0));
// If we have a function argument that is guaranteed, set the guaranteed
// flag so we know that it is always known safe.
if (auto *A = dyn_cast<SILArgument>(MatchSet.Ptr)) {
if (A->isFunctionArg()) {
auto C = A->getArgumentConvention();
PtrIsGuaranteedArg = C == SILArgumentConvention::Direct_Guaranteed;
}
}
NewIncrements.push_back(Inst);
}
void clear() {
MatchSet.clear();
MatchedPair = false;
NewIncrements.clear();
NewDecrements.clear();
}
bool matchUpIncDecSetsForPtr();
// We only allow for get result when this object is invalidated via a move.
ARCMatchingSet &getResult() { return MatchSet; }
bool matchedPair() const { return MatchedPair; }
private:
/// Returns .Some(MatchingSetFlags) on success and .None on failure.
Optional<MatchingSetFlags> matchIncrementsToDecrements();
Optional<MatchingSetFlags> matchDecrementsToIncrements();
};
} // end swift namespace
#endif