Skip to content

Commit 7752a38

Browse files
MathiasVPMathiasVP
authored
Merge pull request #9274 from MathiasVP/swift-extract-semantics-and-accessor-kinds
Swift: Extract semantics and accessor kinds
2 parents be45314 + 21641eb commit 7752a38

File tree

23 files changed

+902
-38
lines changed

23 files changed

+902
-38
lines changed

‎swift/codegen/schema.yml‎

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,9 @@ DeclRefExpr:
327327
_extends: Expr
328328
decl: Decl
329329
replacement_types: Type*
330+
has_direct_to_storage_semantics: predicate
331+
has_direct_to_implementation_semantics: predicate
332+
has_ordinary_semantics: predicate
330333

331334
DefaultArgumentExpr:
332335
_extends: Expr
@@ -404,6 +407,8 @@ LiteralExpr:
404407

405408
LookupExpr:
406409
_extends: Expr
410+
base_expr: Expr
411+
member: Decl
407412

408413
MakeTemporarilyEscapableExpr:
409414
_extends: Expr
@@ -653,6 +658,7 @@ AbstractFunctionDecl:
653658

654659
AbstractStorageDecl:
655660
_extends: ValueDecl
661+
accessor_decls: AccessorDecl*
656662

657663
EnumElementDecl:
658664
_extends: ValueDecl
@@ -840,14 +846,17 @@ DynamicLookupExpr:
840846

841847
MemberRefExpr:
842848
_extends: LookupExpr
843-
base_expr: Expr
849+
has_direct_to_storage_semantics: predicate
850+
has_direct_to_implementation_semantics: predicate
851+
has_ordinary_semantics: predicate
844852

845853
SubscriptExpr:
846854
_extends:
847-
- GenericContext
848855
- LookupExpr
849-
base_expr: Expr
850856
arguments: Argument*
857+
has_direct_to_storage_semantics: predicate
858+
has_direct_to_implementation_semantics: predicate
859+
has_ordinary_semantics: predicate
851860

852861
OverloadedDeclRefExpr:
853862
_extends: OverloadSetRefExpr
@@ -927,7 +936,11 @@ FuncDecl:
927936
_extends: AbstractFunctionDecl
928937

929938
SubscriptDecl:
930-
_extends: AbstractStorageDecl
939+
_extends:
940+
- AbstractStorageDecl
941+
- GenericContext
942+
params: ParamDecl*
943+
element_type: Type
931944

932945
VarDecl:
933946
_extends: AbstractStorageDecl
@@ -1002,6 +1015,10 @@ WhileStmt:
10021015

10031016
AccessorDecl:
10041017
_extends: FuncDecl
1018+
is_getter: predicate
1019+
is_setter: predicate
1020+
is_will_set: predicate
1021+
is_did_set: predicate
10051022

10061023
ConcreteFuncDecl:
10071024
_extends: FuncDecl

‎swift/extractor/visitors/DeclVisitor.h‎

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,39 @@ class DeclVisitor : public AstVisitorBase<DeclVisitor> {
157157
emitTypeDecl(decl, label);
158158
}
159159

160+
void visitAccessorDecl(swift::AccessorDecl* decl) {
161+
auto label = dispatcher_.assignNewLabel(decl);
162+
dispatcher_.emit(AccessorDeclsTrap{label});
163+
switch (decl->getAccessorKind()) {
164+
case swift::AccessorKind::Get:
165+
dispatcher_.emit(AccessorDeclIsGetterTrap{label});
166+
break;
167+
case swift::AccessorKind::Set:
168+
dispatcher_.emit(AccessorDeclIsSetterTrap{label});
169+
break;
170+
case swift::AccessorKind::WillSet:
171+
dispatcher_.emit(AccessorDeclIsWillSetTrap{label});
172+
break;
173+
case swift::AccessorKind::DidSet:
174+
dispatcher_.emit(AccessorDeclIsDidSetTrap{label});
175+
break;
176+
}
177+
emitAccessorDecl(decl, label);
178+
}
179+
180+
void visitSubscriptDecl(swift::SubscriptDecl* decl) {
181+
auto label = dispatcher_.assignNewLabel(decl);
182+
auto elementTypeLabel = dispatcher_.fetchLabel(decl->getElementInterfaceType());
183+
dispatcher_.emit(SubscriptDeclsTrap{label, elementTypeLabel});
184+
if (auto indices = decl->getIndices()) {
185+
for (auto i = 0u; i < indices->size(); ++i) {
186+
dispatcher_.emit(
187+
SubscriptDeclParamsTrap{label, i, dispatcher_.fetchLabel(indices->get(i))});
188+
}
189+
}
190+
emitAbstractStorageDecl(decl, label);
191+
}
192+
160193
private:
161194
void emitConstructorDecl(swift::ConstructorDecl* decl, TrapLabel<ConstructorDeclTag> label) {
162195
emitAbstractFunctionDecl(decl, label);
@@ -168,9 +201,9 @@ class DeclVisitor : public AstVisitorBase<DeclVisitor> {
168201

169202
void emitAbstractFunctionDecl(swift::AbstractFunctionDecl* decl,
170203
TrapLabel<AbstractFunctionDeclTag> label) {
171-
assert(decl->hasName() && "Expect functions to have name");
172204
assert(decl->hasParameterList() && "Expect functions to have a parameter list");
173-
auto name = decl->getName().isSpecial() ? "(unnamed function decl)" : decl->getNameStr().str();
205+
auto name = !decl->hasName() || decl->getName().isSpecial() ? "(unnamed function decl)"
206+
: decl->getNameStr().str();
174207
dispatcher_.emit(AbstractFunctionDeclsTrap{label, name});
175208
if (auto body = decl->getBody()) {
176209
dispatcher_.emit(AbstractFunctionDeclBodiesTrap{label, dispatcher_.fetchLabel(body)});
@@ -226,7 +259,7 @@ class DeclVisitor : public AstVisitorBase<DeclVisitor> {
226259
VarDeclAttachedPropertyWrapperTypesTrap{label, dispatcher_.fetchLabel(propertyType)});
227260
}
228261
}
229-
emitValueDecl(decl, label);
262+
emitAbstractStorageDecl(decl, label);
230263
}
231264

232265
void emitNominalTypeDecl(swift::NominalTypeDecl* decl, TrapLabel<NominalTypeDeclTag> label) {
@@ -251,6 +284,20 @@ class DeclVisitor : public AstVisitorBase<DeclVisitor> {
251284
assert(decl->getInterfaceType() && "Expect ValueDecl to have InterfaceType");
252285
dispatcher_.emit(ValueDeclsTrap{label, dispatcher_.fetchLabel(decl->getInterfaceType())});
253286
}
287+
288+
void emitAccessorDecl(swift::AccessorDecl* decl, TrapLabel<AccessorDeclTag> label) {
289+
emitAbstractFunctionDecl(decl, label);
290+
}
291+
292+
void emitAbstractStorageDecl(const swift::AbstractStorageDecl* decl,
293+
TrapLabel<AbstractStorageDeclTag> label) {
294+
auto i = 0u;
295+
for (auto acc : decl->getAllAccessors()) {
296+
dispatcher_.emit(
297+
AbstractStorageDeclAccessorDeclsTrap{label, i++, dispatcher_.fetchLabel(acc)});
298+
}
299+
emitValueDecl(decl, label);
300+
}
254301
};
255302

256303
} // namespace codeql

‎swift/extractor/visitors/ExprVisitor.h‎

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ class ExprVisitor : public AstVisitorBase<ExprVisitor> {
8585
void visitDeclRefExpr(swift::DeclRefExpr* expr) {
8686
auto label = dispatcher_.assignNewLabel(expr);
8787
dispatcher_.emit(DeclRefExprsTrap{label, dispatcher_.fetchLabel(expr->getDecl())});
88+
emitAccessorSemantics<DeclRefExprHasDirectToStorageSemanticsTrap,
89+
DeclRefExprHasDirectToImplementationSemanticsTrap,
90+
DeclRefExprHasOrdinarySemanticsTrap>(expr, label);
8891
auto i = 0u;
8992
for (auto t : expr->getDeclRef().getSubstitutions().getReplacementTypes()) {
9093
dispatcher_.emit(DeclRefExprReplacementTypesTrap{label, i++, dispatcher_.fetchLabel(t)});
@@ -398,16 +401,24 @@ class ExprVisitor : public AstVisitorBase<ExprVisitor> {
398401
emitExplicitCastExpr(expr, label);
399402
}
400403

404+
void visitLookupExpr(swift::LookupExpr* expr) {
405+
auto label = dispatcher_.assignNewLabel(expr);
406+
emitLookupExpr(expr, label);
407+
}
408+
401409
void visitSubscriptExpr(swift::SubscriptExpr* expr) {
402410
auto label = dispatcher_.assignNewLabel(expr);
403-
assert(expr->getBase() && "SubscriptExpr has getBase()");
404-
auto baseLabel = dispatcher_.fetchLabel(expr->getBase());
405-
dispatcher_.emit(SubscriptExprsTrap{label, baseLabel});
411+
dispatcher_.emit(SubscriptExprsTrap{label});
412+
413+
emitAccessorSemantics<SubscriptExprHasDirectToStorageSemanticsTrap,
414+
SubscriptExprHasDirectToImplementationSemanticsTrap,
415+
SubscriptExprHasOrdinarySemanticsTrap>(expr, label);
406416

407417
auto i = 0u;
408418
for (const auto& arg : *expr->getArgs()) {
409419
dispatcher_.emit(SubscriptExprArgumentsTrap{label, i++, emitArgument(arg)});
410420
}
421+
emitLookupExpr(expr, label);
411422
}
412423

413424
void visitDictionaryExpr(swift::DictionaryExpr* expr) {
@@ -434,10 +445,13 @@ class ExprVisitor : public AstVisitorBase<ExprVisitor> {
434445

435446
void visitMemberRefExpr(swift::MemberRefExpr* expr) {
436447
auto label = dispatcher_.assignNewLabel(expr);
437-
assert(expr->getBase() && "MemberRefExpr has getBase()");
448+
dispatcher_.emit(MemberRefExprsTrap{label});
438449

439-
auto baseLabel = dispatcher_.fetchLabel(expr->getBase());
440-
dispatcher_.emit(MemberRefExprsTrap{label, baseLabel});
450+
emitAccessorSemantics<MemberRefExprHasDirectToStorageSemanticsTrap,
451+
MemberRefExprHasDirectToImplementationSemanticsTrap,
452+
MemberRefExprHasOrdinarySemanticsTrap>(expr, label);
453+
454+
emitLookupExpr(expr, label);
441455
}
442456

443457
void visitDerivedToBaseExpr(swift::DerivedToBaseExpr* expr) {
@@ -542,6 +556,38 @@ class ExprVisitor : public AstVisitorBase<ExprVisitor> {
542556
dispatcher_.emit(SelfApplyExprsTrap{label, baseLabel});
543557
emitApplyExpr(expr, label);
544558
}
559+
560+
void emitLookupExpr(const swift::LookupExpr* expr, TrapLabel<LookupExprTag> label) {
561+
assert(expr->getBase() && "LookupExpr has getBase()");
562+
auto baseLabel = dispatcher_.fetchLabel(expr->getBase());
563+
assert(expr->hasDecl() && "LookupExpr has decl");
564+
auto declLabel = dispatcher_.fetchLabel(expr->getDecl().getDecl());
565+
dispatcher_.emit(LookupExprsTrap{label, baseLabel, declLabel});
566+
}
567+
568+
/*
569+
* `DirectToStorage`, `DirectToImplementation`, and `DirectToImplementation` must be
570+
* constructable from a `Label` argument, and values of `T` must have a
571+
* `getAccessSemantics` member that returns a `swift::AccessSemantics`.
572+
*/
573+
template <typename DirectToStorage,
574+
typename DirectToImplementation,
575+
typename Ordinary,
576+
typename T,
577+
typename Label>
578+
void emitAccessorSemantics(T* ast, Label label) {
579+
switch (ast->getAccessSemantics()) {
580+
case swift::AccessSemantics::DirectToStorage:
581+
dispatcher_.emit(DirectToStorage{label});
582+
break;
583+
case swift::AccessSemantics::DirectToImplementation:
584+
dispatcher_.emit(DirectToImplementation{label});
585+
break;
586+
case swift::AccessSemantics::Ordinary:
587+
dispatcher_.emit(Ordinary{label});
588+
break;
589+
}
590+
}
545591
};
546592

547593
} // namespace codeql

‎swift/ql/lib/codeql/swift/generated/decl/AbstractStorageDecl.qll‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
11
// generated by codegen/codegen.py
2+
import codeql.swift.elements.decl.AccessorDecl
23
import codeql.swift.elements.decl.ValueDecl
34

4-
class AbstractStorageDeclBase extends @abstract_storage_decl, ValueDecl { }
5+
class AbstractStorageDeclBase extends @abstract_storage_decl, ValueDecl {
6+
AccessorDecl getAccessorDecl(int index) {
7+
exists(AccessorDecl x |
8+
abstract_storage_decl_accessor_decls(this, index, x) and
9+
result = x.resolve()
10+
)
11+
}
12+
13+
AccessorDecl getAnAccessorDecl() { result = getAccessorDecl(_) }
14+
15+
int getNumberOfAccessorDecls() { result = count(getAnAccessorDecl()) }
16+
}

‎swift/ql/lib/codeql/swift/generated/decl/AccessorDecl.qll‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,12 @@ import codeql.swift.elements.decl.FuncDecl
33

44
class AccessorDeclBase extends @accessor_decl, FuncDecl {
55
override string getAPrimaryQlClass() { result = "AccessorDecl" }
6+
7+
predicate isGetter() { accessor_decl_is_getter(this) }
8+
9+
predicate isSetter() { accessor_decl_is_setter(this) }
10+
11+
predicate isWillSet() { accessor_decl_is_will_set(this) }
12+
13+
predicate isDidSet() { accessor_decl_is_did_set(this) }
614
}

‎swift/ql/lib/codeql/swift/generated/decl/SubscriptDecl.qll‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
// generated by codegen/codegen.py
22
import codeql.swift.elements.decl.AbstractStorageDecl
3+
import codeql.swift.elements.decl.GenericContext
4+
import codeql.swift.elements.decl.ParamDecl
5+
import codeql.swift.elements.type.Type
36

4-
class SubscriptDeclBase extends @subscript_decl, AbstractStorageDecl {
7+
class SubscriptDeclBase extends @subscript_decl, AbstractStorageDecl, GenericContext {
58
override string getAPrimaryQlClass() { result = "SubscriptDecl" }
9+
10+
ParamDecl getParam(int index) {
11+
exists(ParamDecl x |
12+
subscript_decl_params(this, index, x) and
13+
result = x.resolve()
14+
)
15+
}
16+
17+
ParamDecl getAParam() { result = getParam(_) }
18+
19+
int getNumberOfParams() { result = count(getAParam()) }
20+
21+
Type getElementType() {
22+
exists(Type x |
23+
subscript_decls(this, x) and
24+
result = x.resolve()
25+
)
26+
}
627
}

‎swift/ql/lib/codeql/swift/generated/expr/DeclRefExpr.qll‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,12 @@ class DeclRefExprBase extends @decl_ref_expr, Expr {
2323
Type getAReplacementType() { result = getReplacementType(_) }
2424

2525
int getNumberOfReplacementTypes() { result = count(getAReplacementType()) }
26+
27+
predicate hasDirectToStorageSemantics() { decl_ref_expr_has_direct_to_storage_semantics(this) }
28+
29+
predicate hasDirectToImplementationSemantics() {
30+
decl_ref_expr_has_direct_to_implementation_semantics(this)
31+
}
32+
33+
predicate hasOrdinarySemantics() { decl_ref_expr_has_ordinary_semantics(this) }
2634
}

‎swift/ql/lib/codeql/swift/generated/expr/LookupExpr.qll‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
11
// generated by codegen/codegen.py
2+
import codeql.swift.elements.decl.Decl
23
import codeql.swift.elements.expr.Expr
34

4-
class LookupExprBase extends @lookup_expr, Expr { }
5+
class LookupExprBase extends @lookup_expr, Expr {
6+
Expr getBaseExpr() {
7+
exists(Expr x |
8+
lookup_exprs(this, x, _) and
9+
result = x.resolve()
10+
)
11+
}
12+
13+
Decl getMember() {
14+
exists(Decl x |
15+
lookup_exprs(this, _, x) and
16+
result = x.resolve()
17+
)
18+
}
19+
}

‎swift/ql/lib/codeql/swift/generated/expr/MemberRefExpr.qll‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
// generated by codegen/codegen.py
2-
import codeql.swift.elements.expr.Expr
32
import codeql.swift.elements.expr.LookupExpr
43

54
class MemberRefExprBase extends @member_ref_expr, LookupExpr {
65
override string getAPrimaryQlClass() { result = "MemberRefExpr" }
76

8-
Expr getBaseExpr() {
9-
exists(Expr x |
10-
member_ref_exprs(this, x) and
11-
result = x.resolve()
12-
)
7+
predicate hasDirectToStorageSemantics() { member_ref_expr_has_direct_to_storage_semantics(this) }
8+
9+
predicate hasDirectToImplementationSemantics() {
10+
member_ref_expr_has_direct_to_implementation_semantics(this)
1311
}
12+
13+
predicate hasOrdinarySemantics() { member_ref_expr_has_ordinary_semantics(this) }
1414
}

‎swift/ql/lib/codeql/swift/generated/expr/SubscriptExpr.qll‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
11
// generated by codegen/codegen.py
22
import codeql.swift.elements.expr.Argument
3-
import codeql.swift.elements.expr.Expr
4-
import codeql.swift.elements.decl.GenericContext
53
import codeql.swift.elements.expr.LookupExpr
64

7-
class SubscriptExprBase extends @subscript_expr, GenericContext, LookupExpr {
5+
class SubscriptExprBase extends @subscript_expr, LookupExpr {
86
override string getAPrimaryQlClass() { result = "SubscriptExpr" }
97

10-
Expr getBaseExpr() {
11-
exists(Expr x |
12-
subscript_exprs(this, x) and
13-
result = x.resolve()
14-
)
15-
}
16-
178
Argument getArgument(int index) {
189
exists(Argument x |
1910
subscript_expr_arguments(this, index, x) and
@@ -24,4 +15,12 @@ class SubscriptExprBase extends @subscript_expr, GenericContext, LookupExpr {
2415
Argument getAnArgument() { result = getArgument(_) }
2516

2617
int getNumberOfArguments() { result = count(getAnArgument()) }
18+
19+
predicate hasDirectToStorageSemantics() { subscript_expr_has_direct_to_storage_semantics(this) }
20+
21+
predicate hasDirectToImplementationSemantics() {
22+
subscript_expr_has_direct_to_implementation_semantics(this)
23+
}
24+
25+
predicate hasOrdinarySemantics() { subscript_expr_has_ordinary_semantics(this) }
2726
}

0 commit comments

Comments
 (0)