mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
Noncopyable types may have user-defined code in their `deinit`s that requires passing the type's generic parameters, so a box for a captured noncopyable type needs to capture the generic environment even when the captured type is fixed- layout. Fixes rdar://138958210.
118 lines
3.8 KiB
C++
118 lines
3.8 KiB
C++
//===--- NecessaryBindings.h - Optimizing archetype bindings ----*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines a utility class for saving and restoring the
|
|
// archetype metadata necessary in order to carry out value operations
|
|
// on a type.
|
|
//
|
|
// This is a supplemental API of GenProto.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_IRGEN_NECESSARYBINDINGS_H
|
|
#define SWIFT_IRGEN_NECESSARYBINDINGS_H
|
|
|
|
#include "GenericRequirement.h"
|
|
#include "llvm/ADT/SetVector.h"
|
|
#include "swift/AST/Types.h"
|
|
|
|
namespace swift {
|
|
class CanType;
|
|
enum class MetadataState : size_t;
|
|
class ProtocolDecl;
|
|
class ProtocolConformanceRef;
|
|
class SpecializedProtocolConformance;
|
|
|
|
namespace irgen {
|
|
class Address;
|
|
class Explosion;
|
|
class IRGenFunction;
|
|
class IRGenModule;
|
|
class Size;
|
|
|
|
/// NecessaryBindings - The set of metadata that must be saved in
|
|
/// order to perform some set of operations on a type.
|
|
class NecessaryBindings {
|
|
llvm::SetVector<GenericRequirement> RequirementsSet;
|
|
SubstitutionMap SubMap;
|
|
bool NoEscape;
|
|
|
|
public:
|
|
NecessaryBindings() {}
|
|
NecessaryBindings(SubstitutionMap subs, bool noEscape)
|
|
: SubMap(subs), NoEscape(noEscape) {}
|
|
|
|
SubstitutionMap getSubstitutionMap() const {
|
|
return SubMap;
|
|
}
|
|
|
|
/// Collect the necessary bindings to invoke a function with the given
|
|
/// signature.
|
|
static NecessaryBindings forPartialApplyForwarder(IRGenModule &IGM,
|
|
CanSILFunctionType origType,
|
|
SubstitutionMap subs,
|
|
bool noEscape,
|
|
bool considerParameterSources);
|
|
|
|
/// Collect the necessary bindings to be able to destroy a value inside of a
|
|
/// fixed-layout boxed allocation.
|
|
static NecessaryBindings forFixedBox(IRGenModule &IGM,
|
|
SILBoxType *box);
|
|
|
|
void addRequirement(GenericRequirement requirement) {
|
|
auto type = requirement.getTypeParameter().subst(SubMap);
|
|
if (!type->hasArchetype())
|
|
return;
|
|
|
|
RequirementsSet.insert(requirement);
|
|
}
|
|
|
|
/// Get the requirement from the bindings at index i.
|
|
const GenericRequirement &operator[](size_t i) const {
|
|
return RequirementsSet[i];
|
|
}
|
|
|
|
size_t size() const { return getRequirements().size(); }
|
|
|
|
/// Is the work to do trivial?
|
|
bool empty() const { return getRequirements().empty(); }
|
|
|
|
/// Returns the required size of the bindings.
|
|
/// Pointer alignment is sufficient.
|
|
Size getBufferSize(IRGenModule &IGM) const;
|
|
|
|
/// Save the necessary bindings to the given buffer.
|
|
///
|
|
/// If `replacementSubs` has a value, then the bindings saved are taken from
|
|
/// the given substitution map instead of the substitutions
|
|
void save(IRGenFunction &IGF, Address buffer,
|
|
std::optional<SubstitutionMap> replacementSubs = std::nullopt)
|
|
const;
|
|
|
|
/// Restore the necessary bindings from the given buffer.
|
|
void restore(IRGenFunction &IGF, Address buffer, MetadataState state) const;
|
|
|
|
const llvm::ArrayRef<GenericRequirement> getRequirements() const {
|
|
return RequirementsSet.getArrayRef();
|
|
}
|
|
|
|
private:
|
|
void computeBindings(IRGenModule &IGM,
|
|
CanSILFunctionType origType,
|
|
bool considerParameterSources);
|
|
};
|
|
|
|
} // end namespace irgen
|
|
} // end namespace swift
|
|
|
|
#endif
|