Merge pull request #10144 from MathiasVP/swift-extract-this-param-decl

MathiasVP · web-flow · commit cee15277ceb9 · 2022-08-24T11:17:51.000+01:00
Swift: Extract `self` parameter declarations
diff --git a/swift/codegen/schema.yml b/swift/codegen/schema.yml
@@ -81,6 +81,7 @@ AstNode:
 Callable:
   _children:
     params: ParamDecl*
+    self_param: ParamDecl?
     body: BraceStmt?
 
 ConditionElement:
diff --git a/swift/extractor/visitors/DeclVisitor.cpp b/swift/extractor/visitors/DeclVisitor.cpp
@@ -305,6 +305,8 @@ void DeclVisitor::fillAbstractFunctionDecl(const swift::AbstractFunctionDecl& de
   entry.name = !decl.hasName() ? "(unnamed function decl)" : constructName(decl.getName());
   entry.body = dispatcher_.fetchOptionalLabel(decl.getBody());
   entry.params = dispatcher_.fetchRepeatedLabels(*decl.getParameters());
+  auto self = const_cast<swift::ParamDecl* const>(decl.getImplicitSelfDecl());
+  entry.self_param = dispatcher_.fetchOptionalLabel(self);
   fillValueDecl(decl, entry);
   fillGenericContext(decl, entry);
 }
diff --git a/swift/integration-tests/posix-only/cross-references/VarDecls.expected b/swift/integration-tests/posix-only/cross-references/VarDecls.expected
@@ -1,5 +1,9 @@
+| Sources/cross-references/lib.swift:4:5:4:5 | self |
+| Sources/cross-references/lib.swift:5:5:5:5 | self |
 | Sources/cross-references/lib.swift:10:5:10:5 | X |
+| Sources/cross-references/lib.swift:14:8:14:8 | self |
 | Sources/cross-references/lib.swift:17:16:17:19 | v |
 | Sources/cross-references/lib.swift:22:16:22:19 | v |
 | Sources/cross-references/lib.swift:27:8:27:13 | lhs |
 | Sources/cross-references/lib.swift:27:18:27:23 | rhs |
+| Sources/cross-references/main.swift:11:8:11:8 | self |
diff --git a/swift/ql/lib/codeql/swift/controlflow/internal/ControlFlowGraphImpl.qll b/swift/ql/lib/codeql/swift/controlflow/internal/ControlFlowGraphImpl.qll
@@ -993,6 +993,9 @@ module Decls {
     AbstractFunctionDecl getAst() { result = ast }
 
     final override ControlFlowElement getChildElement(int i) {
+      i = -1 and
+      result.asAstNode() = ast.getSelfParam()
+      or
       result.asAstNode() = ast.getParam(i)
       or
       result.asAstNode() = ast.getBody() and
diff --git a/swift/ql/lib/codeql/swift/elements/decl/ParamDecl.qll b/swift/ql/lib/codeql/swift/elements/decl/ParamDecl.qll
@@ -5,6 +5,20 @@ class ParamDecl extends ParamDeclBase {
   /** Gets the function which declares this parameter. */
   Callable getDeclaringFunction() { result.getAParam() = this }
 
-  /** Gets the index of this parameter in its declaring function's parameter list. */
+  /**
+   * Gets the index of this parameter in its declaring function's parameter list,
+   * or -1 if this is `self`.
+   */
   int getIndex() { exists(Callable func | func.getParam(result) = this) }
 }
+
+/** A `self` parameter. */
+class SelfParamDecl extends ParamDecl {
+  Callable call;
+
+  SelfParamDecl() { call.getSelfParam() = this }
+
+  override Callable getDeclaringFunction() { result = call }
+
+  override int getIndex() { result = -1 }
+}
diff --git a/swift/ql/lib/codeql/swift/generated/Callable.qll b/swift/ql/lib/codeql/swift/generated/Callable.qll
@@ -19,6 +19,17 @@ class CallableBase extends Synth::TCallable, Element {
 
   final int getNumberOfParams() { result = count(getAParam()) }
 
+  ParamDecl getImmediateSelfParam() {
+    result =
+      Synth::convertParamDeclFromRaw(Synth::convertCallableToRaw(this)
+            .(Raw::Callable)
+            .getSelfParam())
+  }
+
+  final ParamDecl getSelfParam() { result = getImmediateSelfParam().resolve() }
+
+  final predicate hasSelfParam() { exists(getSelfParam()) }
+
   BraceStmt getImmediateBody() {
     result =
       Synth::convertBraceStmtFromRaw(Synth::convertCallableToRaw(this).(Raw::Callable).getBody())
diff --git a/swift/ql/lib/codeql/swift/generated/GetImmediateParent.qll b/swift/ql/lib/codeql/swift/generated/GetImmediateParent.qll
@@ -15,6 +15,8 @@ Element getAnImmediateChild(Element e) {
   or
   result = e.(Callable).getImmediateParam(_)
   or
+  result = e.(Callable).getImmediateSelfParam()
+  or
   result = e.(Callable).getImmediateBody()
   or
   result = e.(AbstractStorageDecl).getImmediateAccessorDecl(_)
diff --git a/swift/ql/lib/codeql/swift/generated/Raw.qll b/swift/ql/lib/codeql/swift/generated/Raw.qll
@@ -8,6 +8,8 @@ module Raw {
   class Callable extends @callable, Element {
     ParamDecl getParam(int index) { callable_params(this, index, result) }
 
+    ParamDecl getSelfParam() { callable_self_params(this, result) }
+
     BraceStmt getBody() { callable_bodies(this, result) }
   }
 
diff --git a/swift/ql/lib/swift.dbscheme b/swift/ql/lib/swift.dbscheme
@@ -173,6 +173,12 @@ callable_params(
   int param: @param_decl ref
 );
 
+#keyset[id]
+callable_self_params(
+  int id: @callable ref,
+  int self_param: @param_decl ref
+);
+
 #keyset[id]
 callable_bodies(
   int id: @callable ref,
diff --git a/swift/ql/test/extractor-tests/declarations/all.expected b/swift/ql/test/extractor-tests/declarations/all.expected
@@ -1,6 +1,8 @@
 | declarations.swift:1:1:7:1 | Foo |
 | declarations.swift:1:8:1:8 | init |
 | declarations.swift:1:8:1:8 | init |
+| declarations.swift:1:8:1:8 | self |
+| declarations.swift:1:8:1:8 | self |
 | declarations.swift:1:8:1:8 | x |
 | declarations.swift:2:3:2:11 | var ... = ... |
 | declarations.swift:2:7:2:7 | (unnamed function decl) |
@@ -23,6 +25,8 @@
 | declarations.swift:9:1:9:34 | Bar |
 | declarations.swift:9:7:9:7 | deinit |
 | declarations.swift:9:7:9:7 | init |
+| declarations.swift:9:7:9:7 | self |
+| declarations.swift:9:7:9:7 | self |
 | declarations.swift:9:13:9:30 | var ... = ... |
 | declarations.swift:9:17:9:17 | (unnamed function decl) |
 | declarations.swift:9:17:9:17 | get |
@@ -56,13 +60,18 @@
 | declarations.swift:23:5:23:39 | var ... = ... |
 | declarations.swift:23:9:23:9 | (unnamed function decl) |
 | declarations.swift:23:9:23:9 | mustBeSettable |
+| declarations.swift:23:9:23:9 | self |
 | declarations.swift:23:31:23:31 | get |
+| declarations.swift:23:31:23:31 | self |
 | declarations.swift:23:35:23:35 | newValue |
+| declarations.swift:23:35:23:35 | self |
 | declarations.swift:23:35:23:35 | set |
 | declarations.swift:24:5:24:44 | var ... = ... |
 | declarations.swift:24:9:24:9 | doesNotNeedToBeSettable |
 | declarations.swift:24:40:24:40 | get |
+| declarations.swift:24:40:24:40 | self |
 | declarations.swift:25:5:25:22 | random() |
+| declarations.swift:25:10:25:10 | self |
 | declarations.swift:28:1:28:37 | a_function(a_parameter:) |
 | declarations.swift:28:17:28:31 | a_parameter |
 | declarations.swift:30:1:30:18 | var ... = ... |
@@ -90,15 +99,18 @@
 | declarations.swift:46:3:46:3 | self |
 | declarations.swift:46:3:48:3 | deinit |
 | declarations.swift:50:3:52:3 | +-(_:) |
+| declarations.swift:50:22:50:22 | self |
 | declarations.swift:50:26:50:33 | other |
 | declarations.swift:55:8:55:17 | +- |
 | declarations.swift:57:1:62:1 | precedencegroup ... |
 | declarations.swift:64:7:64:16 | +++ |
 | declarations.swift:66:7:66:21 | *** |
 | declarations.swift:68:18:74:1 | ZeroWrapper |
 | declarations.swift:68:25:68:25 | init |
+| declarations.swift:68:25:68:25 | self |
 | declarations.swift:69:3:73:3 | var ... = ... |
 | declarations.swift:69:7:69:7 | wrappedValue |
+| declarations.swift:70:5:70:5 | self |
 | declarations.swift:70:5:72:5 | get |
 | declarations.swift:76:1:79:1 | foo() |
 | declarations.swift:77:16:77:23 | var ... = ... |
@@ -113,18 +125,23 @@
 | declarations.swift:81:8:81:8 | hasWillSet2 |
 | declarations.swift:81:8:81:8 | init |
 | declarations.swift:81:8:81:8 | normalField |
+| declarations.swift:81:8:81:8 | self |
 | declarations.swift:82:3:87:3 | var ... = ... |
 | declarations.swift:82:7:82:7 | (unnamed function decl) |
 | declarations.swift:82:7:82:7 | self |
 | declarations.swift:82:7:82:7 | settableField |
 | declarations.swift:83:5:83:5 | newValue |
+| declarations.swift:83:5:83:5 | self |
 | declarations.swift:83:5:83:11 | set |
+| declarations.swift:84:5:84:5 | self |
 | declarations.swift:84:5:86:5 | get |
 | declarations.swift:91:3:93:3 | var ... = ... |
 | declarations.swift:91:7:91:7 | readOnlyField1 |
+| declarations.swift:91:27:91:27 | self |
 | declarations.swift:91:27:93:3 | get |
 | declarations.swift:96:3:100:3 | var ... = ... |
 | declarations.swift:96:7:96:7 | readOnlyField2 |
+| declarations.swift:97:5:97:5 | self |
 | declarations.swift:97:5:99:5 | get |
 | declarations.swift:102:3:102:21 | var ... = ... |
 | declarations.swift:102:7:102:7 | (unnamed function decl) |
@@ -141,14 +158,17 @@
 | declarations.swift:104:13:104:13 | x |
 | declarations.swift:104:13:104:13 | x |
 | declarations.swift:104:13:104:16 | x |
+| declarations.swift:105:5:105:5 | self |
 | declarations.swift:105:5:107:5 | get |
 | declarations.swift:108:5:108:5 | newValue |
+| declarations.swift:108:5:108:5 | self |
 | declarations.swift:108:5:108:11 | set |
 | declarations.swift:111:3:113:3 | subscript ... |
 | declarations.swift:111:13:111:13 | x |
 | declarations.swift:111:13:111:16 | x |
 | declarations.swift:111:21:111:21 | y |
 | declarations.swift:111:21:111:25 | y |
+| declarations.swift:111:37:111:37 | self |
 | declarations.swift:111:37:113:3 | get |
 | declarations.swift:115:3:117:3 | var ... = ... |
 | declarations.swift:115:7:115:7 | (unnamed function decl) |
@@ -159,6 +179,7 @@
 | declarations.swift:115:7:115:7 | self |
 | declarations.swift:115:7:115:7 | set |
 | declarations.swift:115:7:115:7 | value |
+| declarations.swift:116:5:116:5 | self |
 | declarations.swift:116:5:116:25 | willSet |
 | declarations.swift:116:13:116:13 | newValue |
 | declarations.swift:119:3:121:3 | var ... = ... |
@@ -171,6 +192,7 @@
 | declarations.swift:119:7:119:7 | set |
 | declarations.swift:119:7:119:7 | value |
 | declarations.swift:120:5:120:5 | newValue |
+| declarations.swift:120:5:120:5 | self |
 | declarations.swift:120:5:120:15 | willSet |
 | declarations.swift:123:3:125:3 | var ... = ... |
 | declarations.swift:123:7:123:7 | (unnamed function decl) |
@@ -181,6 +203,7 @@
 | declarations.swift:123:7:123:7 | self |
 | declarations.swift:123:7:123:7 | set |
 | declarations.swift:123:7:123:7 | value |
+| declarations.swift:124:5:124:5 | self |
 | declarations.swift:124:5:124:24 | didSet |
 | declarations.swift:124:12:124:12 | oldValue |
 | declarations.swift:127:3:129:3 | var ... = ... |
@@ -192,6 +215,7 @@
 | declarations.swift:127:7:127:7 | self |
 | declarations.swift:127:7:127:7 | set |
 | declarations.swift:127:7:127:7 | value |
+| declarations.swift:128:5:128:5 | self |
 | declarations.swift:128:5:128:14 | didSet |
 | declarations.swift:131:3:135:3 | var ... = ... |
 | declarations.swift:131:7:131:7 | (unnamed function decl) |
@@ -203,7 +227,9 @@
 | declarations.swift:131:7:131:7 | set |
 | declarations.swift:131:7:131:7 | value |
 | declarations.swift:132:5:132:5 | newValue |
+| declarations.swift:132:5:132:5 | self |
 | declarations.swift:132:5:132:15 | willSet |
+| declarations.swift:134:5:134:5 | self |
 | declarations.swift:134:5:134:14 | didSet |
 | declarations.swift:138:1:142:1 | extension |
 | declarations.swift:139:3:141:3 | id() |
diff --git a/swift/ql/test/extractor-tests/generated/decl/AccessorDecl/AccessorDecl_getSelfParam.expected b/swift/ql/test/extractor-tests/generated/decl/AccessorDecl/AccessorDecl_getSelfParam.expected
@@ -0,0 +1,27 @@
+| accessors.swift:2:9:2:9 | (unnamed function decl) | accessors.swift:2:9:2:9 | self |
+| accessors.swift:2:9:2:9 | get | accessors.swift:2:9:2:9 | self |
+| accessors.swift:2:9:2:9 | set | accessors.swift:2:9:2:9 | self |
+| accessors.swift:3:9:3:9 | (unnamed function decl) | accessors.swift:3:9:3:9 | self |
+| accessors.swift:4:9:4:28 | get | accessors.swift:4:9:4:9 | self |
+| accessors.swift:5:9:5:42 | set | accessors.swift:5:9:5:9 | self |
+| accessors.swift:7:9:7:9 | (unnamed function decl) | accessors.swift:7:9:7:9 | self |
+| accessors.swift:7:9:7:9 | get | accessors.swift:7:9:7:9 | self |
+| accessors.swift:7:9:7:9 | set | accessors.swift:7:9:7:9 | self |
+| accessors.swift:8:9:8:29 | willSet | accessors.swift:8:9:8:9 | self |
+| accessors.swift:11:9:11:9 | (unnamed function decl) | accessors.swift:11:9:11:9 | self |
+| accessors.swift:11:9:11:9 | get | accessors.swift:11:9:11:9 | self |
+| accessors.swift:11:9:11:9 | set | accessors.swift:11:9:11:9 | self |
+| accessors.swift:12:9:12:19 | willSet | accessors.swift:12:9:12:9 | self |
+| accessors.swift:15:9:15:9 | (unnamed function decl) | accessors.swift:15:9:15:9 | self |
+| accessors.swift:15:9:15:9 | get | accessors.swift:15:9:15:9 | self |
+| accessors.swift:15:9:15:9 | set | accessors.swift:15:9:15:9 | self |
+| accessors.swift:16:9:16:28 | didSet | accessors.swift:16:9:16:9 | self |
+| accessors.swift:19:9:19:9 | (unnamed function decl) | accessors.swift:19:9:19:9 | self |
+| accessors.swift:19:9:19:9 | get | accessors.swift:19:9:19:9 | self |
+| accessors.swift:19:9:19:9 | set | accessors.swift:19:9:19:9 | self |
+| accessors.swift:20:9:20:18 | didSet | accessors.swift:20:9:20:9 | self |
+| accessors.swift:23:9:23:9 | (unnamed function decl) | accessors.swift:23:9:23:9 | self |
+| accessors.swift:23:9:23:9 | get | accessors.swift:23:9:23:9 | self |
+| accessors.swift:23:9:23:9 | set | accessors.swift:23:9:23:9 | self |
+| accessors.swift:24:9:24:19 | willSet | accessors.swift:24:9:24:9 | self |
+| accessors.swift:26:9:26:18 | didSet | accessors.swift:26:9:26:9 | self |
diff --git a/swift/ql/test/extractor-tests/generated/decl/AccessorDecl/AccessorDecl_getSelfParam.ql b/swift/ql/test/extractor-tests/generated/decl/AccessorDecl/AccessorDecl_getSelfParam.ql
@@ -0,0 +1,7 @@
+// generated by codegen/codegen.py
+import codeql.swift.elements
+import TestUtils
+
+from AccessorDecl x
+where toBeTested(x) and not x.isUnknown()
+select x, x.getSelfParam()
diff --git a/swift/ql/test/extractor-tests/generated/decl/ConcreteFuncDecl/ConcreteFuncDecl_getSelfParam.expected b/swift/ql/test/extractor-tests/generated/decl/ConcreteFuncDecl/ConcreteFuncDecl_getSelfParam.expected
@@ -0,0 +1 @@
+| functions.swift:10:5:10:28 | noBody(x:) | functions.swift:10:10:10:10 | self |
diff --git a/swift/ql/test/extractor-tests/generated/decl/ConcreteFuncDecl/ConcreteFuncDecl_getSelfParam.ql b/swift/ql/test/extractor-tests/generated/decl/ConcreteFuncDecl/ConcreteFuncDecl_getSelfParam.ql
@@ -0,0 +1,7 @@
+// generated by codegen/codegen.py
+import codeql.swift.elements
+import TestUtils
+
+from ConcreteFuncDecl x
+where toBeTested(x) and not x.isUnknown()
+select x, x.getSelfParam()
diff --git a/swift/ql/test/extractor-tests/generated/decl/ParamDecl/ParamDecl.expected b/swift/ql/test/extractor-tests/generated/decl/ParamDecl/ParamDecl.expected
@@ -2,14 +2,17 @@
 | param_decls.swift:1:18:1:29 | y | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Double | getName: | y | getType: | Double | isInout: | yes |
 | param_decls.swift:2:10:2:13 | _ | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Int | getName: | _ | getType: | Int | isInout: | no |
 | param_decls.swift:2:18:2:29 | y | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Double | getName: | y | getType: | Double | isInout: | yes |
+| param_decls.swift:4:8:4:8 | self | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | S | getName: | self | getType: | S | isInout: | yes |
 | param_decls.swift:5:5:5:5 | self | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | S | getName: | self | getType: | S | isInout: | yes |
 | param_decls.swift:5:15:5:15 | x | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Int | getName: | x | getType: | Int | isInout: | no |
 | param_decls.swift:5:15:5:15 | x | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Int | getName: | x | getType: | Int | isInout: | no |
 | param_decls.swift:5:15:5:18 | x | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Int | getName: | x | getType: | Int | isInout: | no |
 | param_decls.swift:5:23:5:23 | y | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Int | getName: | y | getType: | Int | isInout: | no |
 | param_decls.swift:5:23:5:23 | y | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Int | getName: | y | getType: | Int | isInout: | no |
 | param_decls.swift:5:23:5:26 | y | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Int | getName: | y | getType: | Int | isInout: | no |
+| param_decls.swift:6:9:6:9 | self | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | S | getName: | self | getType: | S | isInout: | no |
 | param_decls.swift:7:9:7:9 | newValue | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Int? | getName: | newValue | getType: | Int? | isInout: | no |
+| param_decls.swift:7:9:7:9 | self | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | S | getName: | self | getType: | S | isInout: | yes |
 | param_decls.swift:12:13:12:22 | s | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | String | getName: | s | getType: | String | isInout: | yes |
 | param_decls.swift:13:13:13:22 | s | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | String | getName: | s | getType: | String | isInout: | yes |
 | param_decls.swift:14:26:14:26 | $0 | getModule: | file://:0:0:0:0 | param_decls | getInterfaceType: | Int | getName: | $0 | getType: | Int | isInout: | no |
diff --git a/swift/ql/test/library-tests/controlflow/graph/Cfg.expected b/swift/ql/test/library-tests/controlflow/graph/Cfg.expected
diff --git a/swift/ql/test/library-tests/dataflow/dataflow/LocalFlow.expected b/swift/ql/test/library-tests/dataflow/dataflow/LocalFlow.expected
diff --git a/swift/ql/test/library-tests/parent/no_double_parents.expected b/swift/ql/test/library-tests/parent/no_double_parents.expected
diff --git a/swift/ql/test/library-tests/parent/parent.expected b/swift/ql/test/library-tests/parent/parent.expected

Original file line number	Diff line number	Diff line change
`@@ -305,6 +305,8 @@ void DeclVisitor::fillAbstractFunctionDecl(const swift::AbstractFunctionDecl& de`
`305`	`305`	`entry.name = !decl.hasName() ? "(unnamed function decl)" : constructName(decl.getName());`
`306`	`306`	`entry.body = dispatcher_.fetchOptionalLabel(decl.getBody());`
`307`	`307`	`entry.params = dispatcher_.fetchRepeatedLabels(*decl.getParameters());`
	`308`	`+ auto self = const_cast<swift::ParamDecl* const>(decl.getImplicitSelfDecl());`
	`309`	`+ entry.self_param = dispatcher_.fetchOptionalLabel(self);`
`308`	`310`	`fillValueDecl(decl, entry);`
`309`	`311`	`fillGenericContext(decl, entry);`
`310`	`312`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@ module Raw {`
`8`	`8`	`class Callable extends @callable, Element {`
`9`	`9`	`ParamDecl getParam(int index) { callable_params(this, index, result) }`
`10`	`10`
	`11`	`+ ParamDecl getSelfParam() { callable_self_params(this, result) }`
	`12`	`+`
`11`	`13`	`BraceStmt getBody() { callable_bodies(this, result) }`
`12`	`14`	`}`
`13`	`15`