Skip to content

Commit 2180221

Browse files
meg-guptameg-gupta
committed
Serialize/deserialize LifetimeDependenceInfo
1 parent 3141dfa commit 2180221

13 files changed

+262
-4
lines changed

‎include/swift/AST/Decl.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7797,6 +7797,9 @@ class FuncDecl : public AbstractFunctionDecl {
77977797
SourceRange getSourceRange() const;
77987798

77997799
TypeRepr *getResultTypeRepr() const { return FnRetType.getTypeRepr(); }
7800+
7801+
void setDeserializedResultTypeLoc(TypeLoc ResultTyR);
7802+
78007803
SourceRange getResultTypeSourceRange() const {
78017804
return FnRetType.getSourceRange();
78027805
}

‎include/swift/AST/LifetimeDependence.h

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,16 @@ class LifetimeDependenceInfo {
164164
mutateLifetimeParamIndices == nullptr;
165165
}
166166

167+
bool hasInheritLifetimeParamIndices() const {
168+
return inheritLifetimeParamIndices != nullptr;
169+
}
170+
bool hasBorrowLifetimeParamIndices() const {
171+
return borrowLifetimeParamIndices != nullptr;
172+
}
173+
bool hasMutateLifetimeParamIndices() const {
174+
return mutateLifetimeParamIndices != nullptr;
175+
}
176+
167177
std::string getString() const;
168178
void Profile(llvm::FoldingSetNodeID &ID) const;
169179
void getConcatenatedData(SmallVectorImpl<bool> &concatenatedData) const;

‎lib/AST/Decl.cpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9976,6 +9976,10 @@ void FuncDecl::setResultInterfaceType(Type type) {
99769976
std::move(type));
99779977
}
99789978

9979+
void FuncDecl::setDeserializedResultTypeLoc(TypeLoc ResultTyR) {
9980+
FnRetType = ResultTyR;
9981+
}
9982+
99799983
FuncDecl *FuncDecl::createImpl(ASTContext &Context,
99809984
SourceLoc StaticLoc,
99819985
StaticSpellingKind StaticSpelling,

‎lib/Sema/LifetimeDependence.cpp

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ void LifetimeDependenceInfo::getConcatenatedData(
9393
}
9494
assert(!paramIndices->isEmpty());
9595

96-
for (auto i = 0; i < paramIndices->getCapacity(); i++) {
96+
for (unsigned i = 0; i < paramIndices->getCapacity(); i++) {
9797
if (paramIndices->contains(i)) {
9898
concatenatedData.push_back(true);
9999
continue;
@@ -208,9 +208,19 @@ LifetimeDependenceInfo::fromTypeRepr(AbstractFunctionDecl *afd, Type resultType,
208208
paramIndex);
209209
return llvm::None;
210210
}
211+
if (paramIndex == 0) {
212+
if (!afd->hasImplicitSelfDecl()) {
213+
diags.diagnose(specifier.getLoc(),
214+
diag::lifetime_dependence_invalid_self);
215+
return llvm::None;
216+
}
217+
}
218+
auto ownership =
219+
paramIndex == 0
220+
? afd->getImplicitSelfDecl()->getValueOwnership()
221+
: afd->getParameters()->get(paramIndex - 1)->getValueOwnership();
211222
if (updateLifetimeDependenceInfo(
212-
specifier, /*paramIndexToSet*/ specifier.getIndex() + 1,
213-
afd->getParameters()->get(paramIndex)->getValueOwnership())) {
223+
specifier, /*paramIndexToSet*/ specifier.getIndex(), ownership)) {
214224
return llvm::None;
215225
}
216226
break;

‎lib/Serialization/DeclTypeRecordNodes.def

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,8 @@ OTHER(ERROR_FLAG, 155)
212212
TRAILING_INFO(CONDITIONAL_SUBSTITUTION)
213213
TRAILING_INFO(CONDITIONAL_SUBSTITUTION_COND)
214214

215+
OTHER(LIFETIME_DEPENDENCE, 158)
216+
215217
#ifndef DECL_ATTR
216218
#define DECL_ATTR(NAME, CLASS, OPTIONS, CODE) RECORD_VAL(CLASS##_DECL_ATTR, 180+CODE)
217219
#endif

‎lib/Serialization/Deserialization.cpp

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4105,6 +4105,13 @@ class DeclDeserializer {
41054105

41064106
ParameterList *paramList = MF.readParameterList();
41074107
fn->setParameters(paramList);
4108+
SmallVector<LifetimeDependenceSpecifier> specifierList;
4109+
if (MF.maybeReadLifetimeDependence(specifierList, paramList->size())) {
4110+
auto typeRepr = new (ctx) FixedTypeRepr(resultType, SourceLoc());
4111+
auto lifetimeTypeRepr =
4112+
LifetimeDependentReturnTypeRepr::create(ctx, typeRepr, specifierList);
4113+
fn->setDeserializedResultTypeLoc(TypeLoc(lifetimeTypeRepr, resultType));
4114+
}
41084115

41094116
if (auto errorConvention = MF.maybeReadForeignErrorConvention())
41104117
fn->setForeignErrorConvention(*errorConvention);
@@ -8548,3 +8555,58 @@ ModuleFile::maybeReadForeignAsyncConvention() {
85488555
completionHandlerErrorFlagParamIndex,
85498556
errorFlagPolarity);
85508557
}
8558+
8559+
bool ModuleFile::maybeReadLifetimeDependence(
8560+
SmallVectorImpl<LifetimeDependenceSpecifier> &specifierList,
8561+
unsigned numParams) {
8562+
using namespace decls_block;
8563+
SmallVector<uint64_t, 8> scratch;
8564+
8565+
BCOffsetRAII restoreOffset(DeclTypeCursor);
8566+
8567+
llvm::BitstreamEntry next =
8568+
fatalIfUnexpected(DeclTypeCursor.advance(AF_DontPopBlockAtEnd));
8569+
if (next.Kind != llvm::BitstreamEntry::Record)
8570+
return false;
8571+
8572+
unsigned recKind =
8573+
fatalIfUnexpected(DeclTypeCursor.readRecord(next.ID, scratch));
8574+
switch (recKind) {
8575+
case LIFETIME_DEPENDENCE:
8576+
restoreOffset.reset();
8577+
break;
8578+
8579+
default:
8580+
return false;
8581+
}
8582+
8583+
bool hasInheritLifetimeParamIndices, hasBorrowLifetimeParamIndices,
8584+
hasMutateLifetimeParamIndices;
8585+
ArrayRef<uint64_t> lifetimeDependenceData;
8586+
LifetimeDependenceLayout::readRecord(
8587+
scratch, hasInheritLifetimeParamIndices, hasBorrowLifetimeParamIndices,
8588+
hasMutateLifetimeParamIndices, lifetimeDependenceData);
8589+
8590+
unsigned startIndex = 0;
8591+
auto pushData = [&](LifetimeDependenceKind kind) {
8592+
for (unsigned i = 0; i < numParams + 1; i++) {
8593+
if (lifetimeDependenceData[startIndex + i]) {
8594+
specifierList.push_back(
8595+
LifetimeDependenceSpecifier::getOrderedLifetimeDependenceSpecifier(
8596+
SourceLoc(), kind, i));
8597+
}
8598+
}
8599+
startIndex += numParams + 1;
8600+
};
8601+
8602+
if (hasInheritLifetimeParamIndices) {
8603+
pushData(LifetimeDependenceKind::Consume);
8604+
}
8605+
if (hasBorrowLifetimeParamIndices) {
8606+
pushData(LifetimeDependenceKind::Borrow);
8607+
}
8608+
if (hasMutateLifetimeParamIndices) {
8609+
pushData(LifetimeDependenceKind::Mutate);
8610+
}
8611+
return true;
8612+
}

‎lib/Serialization/ModuleFile.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1060,6 +1060,10 @@ class ModuleFile
10601060
/// Reads a foreign async convention from \c DeclTypeCursor, if present.
10611061
llvm::Optional<ForeignAsyncConvention> maybeReadForeignAsyncConvention();
10621062

1063+
bool maybeReadLifetimeDependence(
1064+
SmallVectorImpl<LifetimeDependenceSpecifier> &specifierList,
1065+
unsigned numParams);
1066+
10631067
/// Reads inlinable body text from \c DeclTypeCursor, if present.
10641068
llvm::Optional<StringRef> maybeReadInlinableBodyText();
10651069

‎lib/Serialization/ModuleFormat.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ const uint16_t SWIFTMODULE_VERSION_MAJOR = 0;
5858
/// describe what change you made. The content of this comment isn't important;
5959
/// it just ensures a conflict if two people change the module format.
6060
/// Don't worry about adhering to the 80-column limit for this line.
61-
const uint16_t SWIFTMODULE_VERSION_MINOR = 846; // always trigger mismatch for NoncopyableGenerics
61+
const uint16_t SWIFTMODULE_VERSION_MINOR = 847; // add LifetimeDependence
6262

6363
/// A standard hash seed used for all string hashes in a serialized module.
6464
///
@@ -2174,6 +2174,14 @@ namespace decls_block {
21742174
BCFixed<1> // completion handler error flag polarity
21752175
>;
21762176

2177+
using LifetimeDependenceLayout =
2178+
BCRecordLayout<LIFETIME_DEPENDENCE,
2179+
BCFixed<1>, // hasInheritLifetimeParamIndices
2180+
BCFixed<1>, // hasBorrowLifetimeParamIndices
2181+
BCFixed<1>, // hasMutateLifetimeParamIndices
2182+
BCArray<BCFixed<1>> // concatenated param indices
2183+
>;
2184+
21772185
using AbstractClosureExprLayout = BCRecordLayout<
21782186
ABSTRACT_CLOSURE_EXPR_CONTEXT,
21792187
TypeIDField, // type

‎lib/Serialization/Serialization.cpp

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3509,6 +3509,20 @@ class Serializer::DeclSerializer : public DeclVisitor<DeclSerializer> {
35093509
fac.completionHandlerFlagIsErrorOnZero());
35103510
}
35113511

3512+
void
3513+
writeLifetimeDependenceInfo(LifetimeDependenceInfo lifetimeDependenceInfo) {
3514+
using namespace decls_block;
3515+
SmallVector<bool> paramIndices;
3516+
lifetimeDependenceInfo.getConcatenatedData(paramIndices);
3517+
3518+
auto abbrCode = S.DeclTypeAbbrCodes[LifetimeDependenceLayout::Code];
3519+
LifetimeDependenceLayout::emitRecord(
3520+
S.Out, S.ScratchRecord, abbrCode,
3521+
lifetimeDependenceInfo.hasInheritLifetimeParamIndices(),
3522+
lifetimeDependenceInfo.hasBorrowLifetimeParamIndices(),
3523+
lifetimeDependenceInfo.hasMutateLifetimeParamIndices(), paramIndices);
3524+
}
3525+
35123526
void writeGenericParams(const GenericParamList *genericParams) {
35133527
using namespace decls_block;
35143528

@@ -4482,6 +4496,12 @@ class Serializer::DeclSerializer : public DeclVisitor<DeclSerializer> {
44824496
// Write the body parameters.
44834497
writeParameterList(fn->getParameters());
44844498

4499+
auto fnType = ty->getAs<FunctionType>();
4500+
if (fnType && fnType->hasLifetimeDependenceInfo()) {
4501+
assert(!fnType->getLifetimeDependenceInfo().empty());
4502+
writeLifetimeDependenceInfo(fnType->getLifetimeDependenceInfo());
4503+
}
4504+
44854505
if (auto errorConvention = fn->getForeignErrorConvention())
44864506
writeForeignErrorConvention(*errorConvention);
44874507
if (auto asyncConvention = fn->getForeignAsyncConvention())
@@ -5949,6 +5969,7 @@ void Serializer::writeAllDeclsAndTypes() {
59495969

59505970
registerDeclTypeAbbr<ForeignErrorConventionLayout>();
59515971
registerDeclTypeAbbr<ForeignAsyncConventionLayout>();
5972+
registerDeclTypeAbbr<LifetimeDependenceLayout>();
59525973
registerDeclTypeAbbr<AbstractClosureExprLayout>();
59535974
registerDeclTypeAbbr<PatternBindingInitializerLayout>();
59545975
registerDeclTypeAbbr<DefaultArgumentInitializerLayout>();

‎test/Serialization/Inputs/def_explicit_lifetime_dependence.swift

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
public struct BufferView : ~Escapable {
2+
let ptr: UnsafeRawBufferPointer
3+
@_unsafeNonescapableResult
4+
public init(_ ptr: UnsafeRawBufferPointer) {
5+
self.ptr = ptr
6+
}
7+
}
8+
9+
public struct MutableBufferView : ~Escapable, ~Copyable {
10+
let ptr: UnsafeMutableRawBufferPointer
11+
@_unsafeNonescapableResult
12+
public init(_ ptr: UnsafeMutableRawBufferPointer) {
13+
self.ptr = ptr
14+
}
15+
}
16+
17+
public func derive(_ x: borrowing BufferView) -> _borrow(x) BufferView {
18+
return BufferView(x.ptr)
19+
}
20+
21+
public func use(_ x: borrowing BufferView) {}
22+
23+
public func borrowAndCreate(_ view: borrowing BufferView) -> _borrow(view) BufferView {
24+
return BufferView(view.ptr)
25+
}
26+
27+
public func consumeAndCreate(_ view: consuming BufferView) -> _consume(view) BufferView {
28+
return BufferView(view.ptr)
29+
}
30+
31+
public func deriveThisOrThat(_ this: borrowing BufferView, _ that: borrowing BufferView) -> _borrow(this, that) BufferView {
32+
if (Int.random(in: 1..<100) == 0) {
33+
return BufferView(this.ptr)
34+
}
35+
return BufferView(that.ptr)
36+
}
37+

‎test/Serialization/Inputs/def_implicit_lifetime_dependence.swift

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
public struct BufferView : ~Escapable {
2+
let ptr: UnsafeRawBufferPointer
3+
@_unsafeNonescapableResult
4+
public init(_ ptr: UnsafeRawBufferPointer) {
5+
self.ptr = ptr
6+
}
7+
}
8+
9+
public struct MutableBufferView : ~Escapable, ~Copyable {
10+
let ptr: UnsafeMutableRawBufferPointer
11+
@_unsafeNonescapableResult
12+
public init(_ ptr: UnsafeMutableRawBufferPointer) {
13+
self.ptr = ptr
14+
}
15+
}
16+
17+
public func derive(_ x: borrowing BufferView) -> BufferView {
18+
return BufferView(x.ptr)
19+
}
20+
21+
public func use(_ x: borrowing BufferView) {}
22+
23+
public func borrowAndCreate(_ view: borrowing BufferView) -> BufferView {
24+
return BufferView(view.ptr)
25+
}
26+
27+
public func consumeAndCreate(_ view: consuming BufferView) -> BufferView {
28+
return BufferView(view.ptr)
29+
}
30+

‎test/Serialization/explicit_lifetime_dependence.swift

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// RUN: %empty-directory(%t)
2+
// RUN: %target-swift-frontend -emit-module -o %t %S/Inputs/def_explicit_lifetime_dependence.swift \
3+
// RUN: -enable-experimental-feature NonescapableTypes \
4+
// RUN: -disable-experimental-parser-round-trip \
5+
// RUN: -enable-experimental-feature NoncopyableGenerics
6+
7+
// RUN: llvm-bcanalyzer %t/def_explicit_lifetime_dependence.swiftmodule
8+
9+
// RUN: %target-swift-frontend -module-name lifetime-dependence -emit-silgen -I %t %s \
10+
// RUN: -enable-experimental-feature NonescapableTypes \
11+
// RUN: -disable-experimental-parser-round-trip \
12+
// RUN: -enable-experimental-feature NoncopyableGenerics | %FileCheck %s
13+
14+
// REQUIRES: noncopyable_generics
15+
16+
import def_explicit_lifetime_dependence
17+
18+
func testBasic() {
19+
let capacity = 4
20+
let a = Array(0..<capacity)
21+
a.withUnsafeBytes {
22+
let view = BufferView($0)
23+
let derivedView = derive(view)
24+
let consumedView = consumeAndCreate(derivedView)
25+
let borrowedView = borrowAndCreate(consumedView)
26+
let mysteryView = deriveThisOrThat(borrowedView, consumedView)
27+
use(mysteryView)
28+
}
29+
}
30+
31+
// CHECK: sil @$s32def_explicit_lifetime_dependence6deriveyAA10BufferViewVADF : $@convention(thin) (@guaranteed BufferView) -> _borrow(1) @owned BufferView
32+
// CHECK: sil @$s32def_explicit_lifetime_dependence16consumeAndCreateyAA10BufferViewVADnF : $@convention(thin) (@owned BufferView) -> _inherit(1) @owned BufferView
33+
// CHECK: sil @$s32def_explicit_lifetime_dependence15borrowAndCreateyAA10BufferViewVADF : $@convention(thin) (@guaranteed BufferView) -> _borrow(1) @owned BufferView
34+
// CHECK: sil @$s32def_explicit_lifetime_dependence16deriveThisOrThatyAA10BufferViewVAD_ADtF : $@convention(thin) (@guaranteed BufferView, @guaranteed BufferView) -> _borrow(1, 2) @owned BufferView

‎test/Serialization/implicit_lifetime_dependence.swift

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// RUN: %empty-directory(%t)
2+
// RUN: %target-swift-frontend -emit-module -o %t %S/Inputs/def_implicit_lifetime_dependence.swift \
3+
// RUN: -enable-experimental-feature NonescapableTypes \
4+
// RUN: -disable-experimental-parser-round-trip \
5+
// RUN: -enable-experimental-feature NoncopyableGenerics
6+
7+
// RUN: llvm-bcanalyzer %t/def_implicit_lifetime_dependence.swiftmodule
8+
9+
// RUN: %target-swift-frontend -module-name lifetime-dependence -emit-silgen -I %t %s \
10+
// RUN: -enable-experimental-feature NonescapableTypes \
11+
// RUN: -disable-experimental-parser-round-trip \
12+
// RUN: -enable-experimental-feature NoncopyableGenerics | %FileCheck %s
13+
14+
// REQUIRES: noncopyable_generics
15+
16+
import def_implicit_lifetime_dependence
17+
18+
func testBasic() {
19+
let capacity = 4
20+
let a = Array(0..<capacity)
21+
a.withUnsafeBytes {
22+
let view = BufferView($0)
23+
let derivedView = derive(view)
24+
let consumedView = consumeAndCreate(derivedView)
25+
let borrowedView = borrowAndCreate(consumedView)
26+
use(borrowedView)
27+
}
28+
}
29+
30+
// CHECK: sil @$s32def_implicit_lifetime_dependence6deriveyAA10BufferViewVADF : $@convention(thin) (@guaranteed BufferView) -> _borrow(1) @owned BufferView
31+
// CHECK: sil @$s32def_implicit_lifetime_dependence16consumeAndCreateyAA10BufferViewVADnF : $@convention(thin) (@owned BufferView) -> _inherit(1) @owned BufferView
32+
// CHECK: sil @$s32def_implicit_lifetime_dependence15borrowAndCreateyAA10BufferViewVADF : $@convention(thin) (@guaranteed BufferView) -> _borrow(1) @owned BufferView
33+

0 commit comments

Comments
 (0)