mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
1d961ba22d
Although I don't plan to bring over new assertions wholesale into the current qualification branch, it's entirely possible that various minor changes in main will use the new assertions; having this basic support in the release branch will simplify that. (This is why I'm adding the includes as a separate pass from rewriting the individual assertions)
134 lines
4.8 KiB
C++
134 lines
4.8 KiB
C++
//===--- ResultPlan.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_SILGEN_RESULTPLAN_H
|
|
#define SWIFT_SILGEN_RESULTPLAN_H
|
|
|
|
#include "Callee.h"
|
|
#include "ExecutorBreadcrumb.h"
|
|
#include "Initialization.h"
|
|
#include "ManagedValue.h"
|
|
#include "swift/AST/Types.h"
|
|
#include "swift/Basic/Assertions.h"
|
|
#include "swift/Basic/LLVM.h"
|
|
#include "swift/SIL/SILLocation.h"
|
|
#include <memory>
|
|
|
|
namespace swift {
|
|
|
|
class CanType;
|
|
class SILValue;
|
|
|
|
namespace Lowering {
|
|
|
|
class AbstractionPattern;
|
|
class Initialization;
|
|
class RValue;
|
|
class SILGenFunction;
|
|
class SGFContext;
|
|
class CalleeTypeInfo;
|
|
|
|
/// An abstract class for working with results.of applies.
|
|
class ResultPlan {
|
|
public:
|
|
virtual RValue finish(SILGenFunction &SGF, SILLocation loc,
|
|
ArrayRef<ManagedValue> &directResults,
|
|
SILValue bridgedForeignError) = 0;
|
|
|
|
virtual void finishAndAddTo(SILGenFunction &SGF, SILLocation loc,
|
|
ArrayRef<ManagedValue> &directResults,
|
|
SILValue bridgedForeignError,
|
|
RValue &result);
|
|
|
|
virtual ~ResultPlan() = default;
|
|
|
|
/// Defers the emission of the given breadcrumb until \p finish is invoked.
|
|
virtual void deferExecutorBreadcrumb(ExecutorBreadcrumb &&breadcrumb) {
|
|
llvm_unreachable("this ResultPlan does not handle deferred breadcrumbs!");
|
|
}
|
|
|
|
virtual void
|
|
gatherIndirectResultAddrs(SILGenFunction &SGF, SILLocation loc,
|
|
SmallVectorImpl<SILValue> &outList) const = 0;
|
|
|
|
virtual std::optional<std::pair<ManagedValue, ManagedValue>>
|
|
emitForeignErrorArgument(SILGenFunction &SGF, SILLocation loc) {
|
|
return std::nullopt;
|
|
}
|
|
|
|
virtual ManagedValue emitForeignAsyncCompletionHandler(
|
|
SILGenFunction &SGF, AbstractionPattern origFormalType, SILLocation loc) {
|
|
return {};
|
|
}
|
|
};
|
|
|
|
using ResultPlanPtr = std::unique_ptr<ResultPlan>;
|
|
|
|
/// The class for building result plans.
|
|
struct ResultPlanBuilder {
|
|
SILGenFunction &SGF;
|
|
SILLocation loc;
|
|
const CalleeTypeInfo &calleeTypeInfo;
|
|
|
|
/// A list of all of the results that we are tracking in reverse order. The
|
|
/// reason that it is in reverse order is to allow us to simply traverse the
|
|
/// list by popping values off the back.
|
|
SmallVector<SILResultInfo, 8> allResults;
|
|
|
|
ResultPlanBuilder(SILGenFunction &SGF, SILLocation loc,
|
|
const CalleeTypeInfo &calleeTypeInfo)
|
|
: SGF(SGF), loc(loc), calleeTypeInfo(calleeTypeInfo),
|
|
// We reverse the order so we can pop values off the back.
|
|
allResults(llvm::reverse(calleeTypeInfo.substFnType->getResults())) {}
|
|
|
|
ResultPlanPtr build(Initialization *emitInto, AbstractionPattern origType,
|
|
CanType substType);
|
|
ResultPlanPtr buildForScalar(Initialization *emitInto,
|
|
AbstractionPattern origType,
|
|
CanType substType,
|
|
SILResultInfo result);
|
|
ResultPlanPtr buildForTuple(Initialization *emitInto,
|
|
AbstractionPattern origType,
|
|
CanType substType);
|
|
ResultPlanPtr
|
|
buildForPackExpansion(std::optional<ArrayRef<Initialization *>> inits,
|
|
AbstractionPattern origExpansionType,
|
|
CanTupleEltTypeArrayRef substTypes);
|
|
ResultPlanPtr buildPackExpansionIntoPack(SILValue packAddr,
|
|
CanPackType formalPackType,
|
|
unsigned componentIndex,
|
|
Initialization *init,
|
|
AbstractionPattern origType);
|
|
ResultPlanPtr buildScalarIntoPack(SILValue packAddr,
|
|
CanPackType formalPackType,
|
|
unsigned componentIndex,
|
|
Initialization *init,
|
|
AbstractionPattern origType);
|
|
|
|
static ResultPlanPtr computeResultPlan(SILGenFunction &SGF,
|
|
const CalleeTypeInfo &calleeTypeInfo,
|
|
SILLocation loc,
|
|
SGFContext evalContext);
|
|
|
|
~ResultPlanBuilder() {
|
|
assert(allResults.empty() && "didn't consume all results!");
|
|
}
|
|
|
|
private:
|
|
ResultPlanPtr buildTopLevelResult(Initialization *init, SILLocation loc);
|
|
};
|
|
|
|
} // end namespace Lowering
|
|
} // end namespace swift
|
|
|
|
#endif
|