Skip to content

[IRGen+Runtime] Add layout string support for generic single payload … #66791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 21, 2023
Merged

[IRGen+Runtime] Add layout string support for generic single payload … #66791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions include/swift/Runtime/Enum.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ void swift_initEnumMetadataSinglePayload(EnumMetadata *enumType,
const TypeLayout *payload,
unsigned emptyCases);

SWIFT_RUNTIME_EXPORT
void swift_initEnumMetadataSinglePayloadWithLayoutString(
EnumMetadata *enumType, EnumLayoutFlags flags, const Metadata *payload,
unsigned emptyCases);

using getExtraInhabitantTag_t =
SWIFT_CC(swift) unsigned (const OpaqueValue *value,
unsigned numExtraInhabitants,
Expand Down
12 changes: 12 additions & 0 deletions include/swift/Runtime/RuntimeFunctions.def
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1323,6 +1323,18 @@ FUNCTION(InitEnumMetadataSinglePayload,
ATTRS(NoUnwind, WillReturn),
EFFECT(MetaData))

// void swift_initEnumMetadataSinglePayloadWithLayoutString(Metadata *enumType,
// EnumLayoutFlags flags,
// Metadata *payload,
// unsigned num_empty_cases);
FUNCTION(InitEnumMetadataSinglePayloadWithLayoutString,
swift_initEnumMetadataSinglePayloadWithLayoutString,
C_CC, AlwaysAvailable,
RETURNS(VoidTy),
ARGS(TypeMetadataPtrTy, SizeTy, TypeMetadataPtrTy, Int32Ty),
ATTRS(NoUnwind, WillReturn),
EFFECT(MetaData))

// void swift_initEnumMetadataMultiPayload(Metadata *enumType,
// EnumLayoutFlags layoutFlags,
// size_t numPayloads,
Expand Down
21 changes: 19 additions & 2 deletions lib/IRGen/GenEnum.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3237,8 +3237,25 @@ namespace {
void initializeMetadataWithLayoutString(
IRGenFunction &IGF, llvm::Value *metadata, bool isVWTMutable, SILType T,
MetadataDependencyCollector *collector) const override {
// Not yet supported on this type, so forward to regular method
initializeMetadata(IGF, metadata, isVWTMutable, T, collector);
// Fixed-size enums don't need dynamic witness table initialization.
if (TIK >= Fixed)
return;

// Ask the runtime to do our layout using the payload metadata and number
// of empty cases.
auto payloadTy =
T.getEnumElementType(ElementsWithPayload[0].decl, IGM.getSILModule(),
IGM.getMaximalTypeExpansionContext());

auto request = DynamicMetadataRequest::getNonBlocking(
MetadataState::LayoutComplete, collector);
auto payloadLayout = IGF.emitTypeMetadataRefForLayout(payloadTy, request);
auto emptyCasesVal =
llvm::ConstantInt::get(IGM.Int32Ty, ElementsWithNoPayload.size());
auto flags = emitEnumLayoutFlags(IGM, isVWTMutable);
IGF.Builder.CreateCall(
IGM.getInitEnumMetadataSinglePayloadWithLayoutStringFunctionPointer(),
{metadata, flags, payloadLayout, emptyCasesVal});
}

/// \group Extra inhabitants
Expand Down
8 changes: 1 addition & 7 deletions lib/IRGen/GenMeta.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5736,18 +5736,12 @@ namespace {
return false;
}

auto &strategy = getEnumImplStrategy(IGM, getLoweredType());
bool isSupportedCase = strategy.getElementsWithPayload().size() > 1 ||
(strategy.getElementsWithPayload().size() == 1 &&
strategy.getElementsWithNoPayload().empty());

return !!getLayoutString() ||
(IGM.Context.LangOpts.hasFeature(
Feature::LayoutStringValueWitnessesInstantiation) &&
IGM.getOptions().EnableLayoutStringValueWitnessesInstantiation &&
(HasDependentVWT || HasDependentMetadata) &&
!isa<FixedTypeInfo>(IGM.getTypeInfo(getLoweredType())) &&
isSupportedCase);
!isa<FixedTypeInfo>(IGM.getTypeInfo(getLoweredType())));
}

llvm::Constant *emitNominalTypeDescriptor() {
Expand Down
8 changes: 3 additions & 5 deletions lib/IRGen/GenValueWitness.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -891,11 +891,9 @@ bool isRuntimeInstatiatedLayoutString(IRGenModule &IGM,
IGM.Context.LangOpts.hasFeature(
Feature::LayoutStringValueWitnessesInstantiation) &&
IGM.getOptions().EnableLayoutStringValueWitnessesInstantiation) {
if (auto *enumEntry = typeLayoutEntry->getAsEnum()) {
return enumEntry->isMultiPayloadEnum() || enumEntry->isSingleton();
}
return (typeLayoutEntry->isAlignedGroup() &&
!typeLayoutEntry->isFixedSize(IGM));
return (
(typeLayoutEntry->isAlignedGroup() || typeLayoutEntry->getAsEnum()) &&
!typeLayoutEntry->isFixedSize(IGM));
}

return false;
Expand Down
7 changes: 4 additions & 3 deletions lib/IRGen/TypeLayout.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,12 @@ class LayoutStringBuilder {
SinglePayloadEnumFN = 0x11,
// reserved
// SinglePayloadEnumFNResolved = 0x12,
// SinglePayloadEnumGeneric = 0x13,

MultiPayloadEnumFN = 0x13,
MultiPayloadEnumFN = 0x14,
// reserved
// MultiPayloadEnumFNResolved = 0x14,
// MultiPayloadEnumGeneric = 0x15,
// MultiPayloadEnumFNResolved = 0x15,
// MultiPayloadEnumGeneric = 0x16,

Skip = 0x80,
// We may use the MSB as flag that a count follows,
Expand Down
74 changes: 72 additions & 2 deletions stdlib/public/runtime/BytecodeLayouts.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@ inline static bool handleNextRefCount(const Metadata *metadata,
RefCountingKind::SinglePayloadEnumFNResolved)) {
Handler::handleSinglePayloadEnumFN(typeLayout, offset, true, addrOffset,
std::forward<Params>(params)...);
} else if (SWIFT_UNLIKELY(tag == RefCountingKind::SinglePayloadEnumGeneric)) {
Handler::handleSinglePayloadEnumGeneric(typeLayout, offset, addrOffset,
std::forward<Params>(params)...);
} else if (SWIFT_UNLIKELY(tag == RefCountingKind::MultiPayloadEnumFN)) {
Handler::handleMultiPayloadEnumFN(metadata, typeLayout, offset, false,
addrOffset,
Expand All @@ -126,8 +129,7 @@ inline static bool handleNextRefCount(const Metadata *metadata,
Handler::handleMultiPayloadEnumFN(metadata, typeLayout, offset, true,
addrOffset,
std::forward<Params>(params)...);
} else if (SWIFT_UNLIKELY(tag ==
RefCountingKind::MultiPayloadEnumGeneric)) {
} else if (SWIFT_UNLIKELY(tag == RefCountingKind::MultiPayloadEnumGeneric)) {
Handler::handleMultiPayloadEnumGeneric(metadata, typeLayout, offset,
addrOffset,
std::forward<Params>(params)...);
Expand Down Expand Up @@ -256,6 +258,51 @@ static void handleSinglePayloadEnumFN(const uint8_t *typeLayout, size_t &offset,
}
}

static void handleSinglePayloadEnumGeneric(const uint8_t *typeLayout,
size_t &offset, uint8_t *addr,
uintptr_t &addrOffset) {
auto tagBytesAndOffset = readBytes<uint64_t>(typeLayout, offset);
auto extraTagBytesPattern = (uint8_t)(tagBytesAndOffset >> 62);
auto xiTagBytesOffset =
tagBytesAndOffset & std::numeric_limits<uint32_t>::max();
const Metadata *xiType = nullptr;

if (extraTagBytesPattern) {
auto extraTagBytes = 1 << (extraTagBytesPattern - 1);
auto payloadSize = readBytes<size_t>(typeLayout, offset);
auto tagBytes =
readTagBytes(addr + addrOffset + payloadSize, extraTagBytes);
if (tagBytes) {
offset += sizeof(uint64_t) + sizeof(size_t);
goto noPayload;
}
} else {
offset += sizeof(size_t);
}

xiType = readBytes<const Metadata *>(typeLayout, offset);

if (xiType) {
auto numEmptyCases = readBytes<unsigned>(typeLayout, offset);

auto tag = xiType->vw_getEnumTagSinglePayload(
(const OpaqueValue *)(addr + addrOffset + xiTagBytesOffset),
numEmptyCases);
if (tag == 0) {
offset += sizeof(size_t) * 2;
return;
}
} else {
offset += sizeof(uint64_t) + sizeof(size_t);
}

noPayload:
auto refCountBytes = readBytes<size_t>(typeLayout, offset);
auto skip = readBytes<size_t>(typeLayout, offset);
offset += refCountBytes;
addrOffset += skip;
}

template <typename Handler, typename... Params>
static void handleMultiPayloadEnumFN(const Metadata *metadata,
const uint8_t *typeLayout, size_t &offset,
Expand Down Expand Up @@ -363,6 +410,13 @@ struct DestroyHandler {
::handleSinglePayloadEnumFN(typeLayout, offset, resolved, addr, addrOffset);
}

static inline void handleSinglePayloadEnumGeneric(const uint8_t *typeLayout,
size_t &offset,
uintptr_t &addrOffset,
uint8_t *addr) {
::handleSinglePayloadEnumGeneric(typeLayout, offset, addr, addrOffset);
}

static inline void handleMultiPayloadEnumFN(const Metadata *metadata,
const uint8_t *typeLayout,
size_t &offset, bool resolved,
Expand Down Expand Up @@ -466,6 +520,14 @@ struct CopyHandler {
::handleSinglePayloadEnumFN(typeLayout, offset, resolved, src, addrOffset);
}

static inline void handleSinglePayloadEnumGeneric(const uint8_t *typeLayout,
size_t &offset,
uintptr_t &addrOffset,
uint8_t *dest,
uint8_t *src) {
::handleSinglePayloadEnumGeneric(typeLayout, offset, src, addrOffset);
}

static inline void handleMultiPayloadEnumFN(const Metadata *metadata,
const uint8_t *typeLayout,
size_t &offset, bool resolved,
Expand Down Expand Up @@ -533,6 +595,14 @@ struct TakeHandler {
::handleSinglePayloadEnumFN(typeLayout, offset, resolved, src, addrOffset);
}

static inline void handleSinglePayloadEnumGeneric(const uint8_t *typeLayout,
size_t &offset,
uintptr_t &addrOffset,
uint8_t *dest,
uint8_t *src) {
::handleSinglePayloadEnumGeneric(typeLayout, offset, src, addrOffset);
}

static inline void handleMultiPayloadEnumFN(const Metadata *metadata,
const uint8_t *typeLayout,
size_t &offset, bool resolved,
Expand Down
7 changes: 4 additions & 3 deletions stdlib/public/runtime/BytecodeLayouts.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,11 @@ enum class RefCountingKind : uint8_t {
SinglePayloadEnumSimple = 0x10,
SinglePayloadEnumFN = 0x11,
SinglePayloadEnumFNResolved = 0x12,
SinglePayloadEnumGeneric = 0x13,

MultiPayloadEnumFN = 0x13,
MultiPayloadEnumFNResolved = 0x14,
MultiPayloadEnumGeneric = 0x15,
MultiPayloadEnumFN = 0x14,
MultiPayloadEnumFNResolved = 0x15,
MultiPayloadEnumGeneric = 0x16,

Skip = 0x80,
// We may use the MSB as flag that a count follows,
Expand Down
Loading