Skip to content

Fix SIL parsing of ownership qualifiers. #39054

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
Aug 26, 2021
Merged

Fix SIL parsing of ownership qualifiers. #39054

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
1 change: 1 addition & 0 deletions include/swift/AST/DiagnosticsParse.def
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,6 +488,7 @@ ERROR(referenced_value_no_accessor,none,
"referenced declaration has no %select{getter|setter}0", (unsigned))
ERROR(expected_sil_value_ownership_kind,none,
"expected value ownership kind in SIL code", ())
ERROR(unrecognized_sil_qualifier,none, "unrecognized SIL qualifier", ())
ERROR(silfunc_and_silarg_have_incompatible_sil_value_ownership,none,
"SILFunction and SILArgument have mismatching ValueOwnershipKinds. "
"Function type specifies: '@%0'. SIL argument specifies: '@%1'.",
Expand Down
171 changes: 80 additions & 91 deletions lib/SIL/Parser/ParseSIL.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,11 @@ namespace {
return parseSILIdentifier(Result, L, Diagnostic(ID, Args...));
}

template <typename T>
bool
parseSILQualifier(Optional<T> &result,
llvm::function_ref<Optional<T>(StringRef)> parseName);

bool parseVerbatim(StringRef identifier);

template <typename T>
Expand Down Expand Up @@ -819,6 +824,38 @@ static bool parseSILOptional(bool &Result, SILParser &SP, StringRef Expected) {
return false;
}

// If the qualifier string is unrecognized, then diagnose and fail.
//
// If the qualifier is absent, then succeed and set the result to None.
// The caller can decide how to proceed with an absent qualifier.
//
// Usage:
// auto parseQualifierName = [](StringRef Str) {
// return llvm::StringSwitch<Optional<SomeQualifier>>(Str)
// .Case("one", SomeQualifier::One)
// .Case("two", SomeQualifier::Two)
// .Default(None);
// };
// if (parseSILQualifier<SomeQualifier>(Qualifier, parseQualifierName))
// return true;
template <typename T>
bool SILParser::parseSILQualifier(
Optional<T> &result, llvm::function_ref<Optional<T>(StringRef)> parseName) {
auto loc = P.Tok.getLoc();
StringRef Str;
// If we do not parse '[' ... ']',
if (!parseSILOptional(Str, *this)) {
result = None;
return false;
}
result = parseName(Str);
if (!result) {
P.diagnose(loc, Diagnostic(diag::unrecognized_sil_qualifier));
return true;
}
return false;
}

/// Remap RequirementReps to Requirements.
void SILParser::convertRequirements(ArrayRef<RequirementRepr> From,
SmallVectorImpl<Requirement> &To) {
Expand Down Expand Up @@ -2010,84 +2047,6 @@ bool SILParser::parseSILDebugLocation(SILLocation &L, SILBuilder &B,
return false;
}

static bool parseLoadOwnershipQualifier(LoadOwnershipQualifier &Result,
SILParser &P) {
StringRef Str;
// If we do not parse '[' ... ']', we have unqualified. Set value and return.
if (!parseSILOptional(Str, P)) {
Result = LoadOwnershipQualifier::Unqualified;
return false;
}

// Then try to parse one of our other qualifiers. We do not support parsing
// unqualified here so we use that as our fail value.
auto Tmp = llvm::StringSwitch<LoadOwnershipQualifier>(Str)
.Case("take", LoadOwnershipQualifier::Take)
.Case("copy", LoadOwnershipQualifier::Copy)
.Case("trivial", LoadOwnershipQualifier::Trivial)
.Default(LoadOwnershipQualifier::Unqualified);

// Thus return true (following the conventions in this file) if we fail.
if (Tmp == LoadOwnershipQualifier::Unqualified)
return true;

// Otherwise, assign Result and return false.
Result = Tmp;
return false;
}

static bool parseStoreOwnershipQualifier(StoreOwnershipQualifier &Result,
SILParser &P) {
StringRef Str;
// If we do not parse '[' ... ']', we have unqualified. Set value and return.
if (!parseSILOptional(Str, P)) {
Result = StoreOwnershipQualifier::Unqualified;
return false;
}

// Then try to parse one of our other qualifiers. We do not support parsing
// unqualified here so we use that as our fail value.
auto Tmp = llvm::StringSwitch<StoreOwnershipQualifier>(Str)
.Case("init", StoreOwnershipQualifier::Init)
.Case("assign", StoreOwnershipQualifier::Assign)
.Case("trivial", StoreOwnershipQualifier::Trivial)
.Default(StoreOwnershipQualifier::Unqualified);

// Thus return true (following the conventions in this file) if we fail.
if (Tmp == StoreOwnershipQualifier::Unqualified)
return true;

// Otherwise, assign Result and return false.
Result = Tmp;
return false;
}

static bool parseAssignOwnershipQualifier(AssignOwnershipQualifier &Result,
SILParser &P) {
StringRef Str;
// If we do not parse '[' ... ']', we have unknown. Set value and return.
if (!parseSILOptional(Str, P)) {
Result = AssignOwnershipQualifier::Unknown;
return false;
}

// Then try to parse one of our other initialization kinds. We do not support
// parsing unknown here so we use that as our fail value.
auto Tmp = llvm::StringSwitch<AssignOwnershipQualifier>(Str)
.Case("reassign", AssignOwnershipQualifier::Reassign)
.Case("reinit", AssignOwnershipQualifier::Reinit)
.Case("init", AssignOwnershipQualifier::Init)
.Default(AssignOwnershipQualifier::Unknown);

// Thus return true (following the conventions in this file) if we fail.
if (Tmp == AssignOwnershipQualifier::Unknown)
return true;

// Otherwise, assign Result and return false.
Result = Tmp;
return false;
}

static bool parseAssignByWrapperMode(AssignByWrapperInst::Mode &Result,
SILParser &P) {
StringRef Str;
Expand Down Expand Up @@ -3252,15 +3211,23 @@ bool SILParser::parseSpecificSILInstruction(SILBuilder &B,
}

case SILInstructionKind::LoadInst: {
LoadOwnershipQualifier Qualifier;
Optional<LoadOwnershipQualifier> Qualifier;
SourceLoc AddrLoc;

if (parseLoadOwnershipQualifier(Qualifier, *this) ||
parseTypedValueRef(Val, AddrLoc, B) ||
parseSILDebugLocation(InstLoc, B))
auto parseLoadOwnership = [](StringRef Str) {
return llvm::StringSwitch<Optional<LoadOwnershipQualifier>>(Str)
.Case("take", LoadOwnershipQualifier::Take)
.Case("copy", LoadOwnershipQualifier::Copy)
.Case("trivial", LoadOwnershipQualifier::Trivial)
.Default(None);
};
if (parseSILQualifier<LoadOwnershipQualifier>(Qualifier, parseLoadOwnership)
|| parseTypedValueRef(Val, AddrLoc, B)
|| parseSILDebugLocation(InstLoc, B)) {
return true;

ResultVal = B.createLoad(InstLoc, Val, Qualifier);
}
if (!Qualifier)
Qualifier = LoadOwnershipQualifier::Unqualified;
ResultVal = B.createLoad(InstLoc, Val, Qualifier.getValue());
break;
}

Expand Down Expand Up @@ -3828,19 +3795,37 @@ bool SILParser::parseSpecificSILInstruction(SILBuilder &B,
SourceLoc ToLoc, AddrLoc;
Identifier ToToken;
SILValue AddrVal;
StoreOwnershipQualifier StoreQualifier;
AssignOwnershipQualifier AssignQualifier;
Optional<StoreOwnershipQualifier> StoreQualifier;
Optional<AssignOwnershipQualifier> AssignQualifier;
bool IsStore = Opcode == SILInstructionKind::StoreInst;
bool IsAssign = Opcode == SILInstructionKind::AssignInst;
if (parseValueName(From) ||
parseSILIdentifier(ToToken, ToLoc, diag::expected_tok_in_sil_instr,
"to"))
return true;

if (IsStore && parseStoreOwnershipQualifier(StoreQualifier, *this))
auto parseStoreOwnership = [](StringRef Str) {
return llvm::StringSwitch<Optional<StoreOwnershipQualifier>>(Str)
.Case("init", StoreOwnershipQualifier::Init)
.Case("assign", StoreOwnershipQualifier::Assign)
.Case("trivial", StoreOwnershipQualifier::Trivial)
.Default(None);
};
if (IsStore
&& parseSILQualifier<StoreOwnershipQualifier>(StoreQualifier,
parseStoreOwnership))
return true;

if (IsAssign && parseAssignOwnershipQualifier(AssignQualifier, *this))
auto parseAssignOwnership = [](StringRef Str) {
return llvm::StringSwitch<Optional<AssignOwnershipQualifier>>(Str)
.Case("reassign", AssignOwnershipQualifier::Reassign)
.Case("reinit", AssignOwnershipQualifier::Reinit)
.Case("init", AssignOwnershipQualifier::Init)
.Default(None);
};
if (IsAssign
&& parseSILQualifier<AssignOwnershipQualifier>(AssignQualifier,
parseAssignOwnership))
return true;

if (parseTypedValueRef(AddrVal, AddrLoc, B) ||
Expand All @@ -3861,15 +3846,19 @@ bool SILParser::parseSpecificSILInstruction(SILBuilder &B,
SILType ValType = AddrVal->getType().getObjectType();

if (IsStore) {
if (!StoreQualifier)
StoreQualifier = StoreOwnershipQualifier::Unqualified;
ResultVal =
B.createStore(InstLoc, getLocalValue(From, ValType, InstLoc, B),
AddrVal, StoreQualifier);
AddrVal, StoreQualifier.getValue());
} else {
assert(IsAssign);
if (!AssignQualifier)
AssignQualifier = AssignOwnershipQualifier::Unknown;

ResultVal =
B.createAssign(InstLoc, getLocalValue(From, ValType, InstLoc, B),
AddrVal, AssignQualifier);
AddrVal, AssignQualifier.getValue());
}

break;
Expand Down