Files
swift-mirror/lib/SILOptimizer/ARC/ARCMatchingSet.h
Evan Wilde f3ff561c6f [NFC] add llvm namespace to Optional and None
This is phase-1 of switching from llvm::Optional to std::optional in the
next rebranch. llvm::Optional was removed from upstream LLVM, so we need
to migrate off rather soon. On Darwin, std::optional, and llvm::Optional
have the same layout, so we don't need to be as concerned about ABI
beyond the name mangling. `llvm::Optional` is only returned from one
function in
```
getStandardTypeSubst(StringRef TypeName,
                     bool allowConcurrencyManglings);
```
It's the return value, so it should not impact the mangling of the
function, and the layout is the same as `std::optional`, so it should be
mostly okay. This function doesn't appear to have users, and the ABI was
already broken 2 years ago for concurrency and no one seemed to notice
so this should be "okay".

I'm doing the migration incrementally so that folks working on main can
cherry-pick back to the release/5.9 branch. Once 5.9 is done and locked
away, then we can go through and finish the replacement. Since `None`
and `Optional` show up in contexts where they are not `llvm::None` and
`llvm::Optional`, I'm preparing the work now by going through and
removing the namespace unwrapping and making the `llvm` namespace
explicit. This should make it fairly mechanical to go through and
replace llvm::Optional with std::optional, and llvm::None with
std::nullopt. It's also a change that can be brought onto the
release/5.9 with minimal impact. This should be an NFC change.
2023-06-27 09:03:52 -07:00

127 lines
3.9 KiB
C++

//===--- ARCMatchingSet.h ---------------------------------------*- 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_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;
/// The set of reference count decrements that were paired.
llvm::SetVector<SILInstruction *> Decrements;
// 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();
Decrements.clear();
}
};
struct MatchingSetFlags {
bool KnownSafe;
bool CodeMotionSafe;
};
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<SILFunctionArgument>(MatchSet.Ptr)) {
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.
llvm::Optional<MatchingSetFlags> matchIncrementsToDecrements();
llvm::Optional<MatchingSetFlags> matchDecrementsToIncrements();
};
} // end swift namespace
#endif