Add ktLocalFunction relation and tests for local and anonymous classes

tamasvajk · igfoo · commit ef2795c88b51 · 2022-05-10T19:51:11.000+01:00
diff --git a/java/kotlin-extractor/src/main/kotlin/KotlinFileExtractor.kt b/java/kotlin-extractor/src/main/kotlin/KotlinFileExtractor.kt
@@ -662,6 +662,8 @@ open class KotlinFileExtractor(
                 if (s.isLocalFunction()) {
                     val classId = extractGeneratedClass(s, listOf(pluginContext.irBuiltIns.anyType))
                     extractLocalTypeDeclStmt(classId, s, callable, parent, idx)
+                    val ids = getLocallyVisibleFunctionLabels(s)
+                    tw.writeKtLocalFunction(ids.function)
                 } else {
                     logger.warnElement(Severity.ErrorSevere, "Expected to find local function", s)
                 }
diff --git a/java/ql/lib/config/semmlecode.dbscheme b/java/ql/lib/config/semmlecode.dbscheme
@@ -1143,3 +1143,7 @@ ktSyntheticBody(
   // 1: ENUM_VALUES
   // 2: ENUM_VALUEOF
 )
+
+ktLocalFunction(
+  unique int id: @method ref
+)
diff --git a/java/ql/lib/semmle/code/java/Member.qll b/java/ql/lib/semmle/code/java/Member.qll
@@ -463,6 +463,9 @@ class Method extends Callable, @method {
     not this.getDeclaringType().isFinal()
   }
 
+  /** Holds if this method is a Kotlin local function. */
+  predicate isLocal() { ktLocalFunction(this) }
+
   override string getAPrimaryQlClass() { result = "Method" }
 }
 
diff --git a/java/ql/test/kotlin/library-tests/classes/PrintAst.expected b/java/ql/test/kotlin/library-tests/classes/PrintAst.expected
@@ -433,6 +433,109 @@ classes.kt:
 #  127|               1: [ExprStmt] <Expr>;
 #  127|                 0: [ClassInstanceExpr] new (...)
 #  127|                   -3: [TypeAccess] Object
+local_anonymous.kt:
+#    0| [CompilationUnit] local_anonymous
+#    0|   1: [Class] Local_anonymousKt
+#    3|   2: [Class] Class1
+#    3|     1: [Constructor] Class1
+#    3|       5: [BlockStmt] { ... }
+#    3|         0: [SuperConstructorInvocationStmt] super(...)
+#    3|         1: [ExprStmt] <Expr>;
+#    3|           0: [MethodAccess] <obinit>(...)
+#    4|     3: [Method] fn1
+#    4|       5: [BlockStmt] { ... }
+#    5|         0: [ReturnStmt] return ...
+#    5|           0: [StmtExpr] <Stmt>
+#    5|             0: [BlockStmt] { ... }
+#    5|               0: [LocalTypeDeclStmt] class ...
+#    5|                 0: [AnonymousClass,LocalClass] new Object(...) { ... }
+#    5|                   1: [Constructor] 
+#    5|                     5: [BlockStmt] { ... }
+#    5|                       0: [SuperConstructorInvocationStmt] super(...)
+#    5|                       1: [ExprStmt] <Expr>;
+#    5|                         0: [MethodAccess] <obinit>(...)
+#    6|                   3: [Method] fn
+#    6|                     5: [BlockStmt] { ... }
+#    5|               1: [ExprStmt] <Expr>;
+#    5|                 0: [ClassInstanceExpr] new (...)
+#    5|                   -3: [TypeAccess] Object
+#   10|     4: [Method] fn2
+#   10|       5: [BlockStmt] { ... }
+#   11|         0: [LocalTypeDeclStmt] class ...
+#   11|           0: [AnonymousClass,LocalClass] new Object(...) { ... }
+#   11|             1: [Constructor] 
+#   11|               5: [BlockStmt] { ... }
+#   11|                 0: [SuperConstructorInvocationStmt] super(...)
+#   11|             1: [Method] fnLocal
+#   11|               5: [BlockStmt] { ... }
+#   12|         1: [ExprStmt] <Expr>;
+#   12|           0: [MethodAccess] fnLocal(...)
+#   12|             -1: [ClassInstanceExpr] new (...)
+#   12|               -3: [TypeAccess] Object
+#   15|     5: [Method] fn3
+#   15|       5: [BlockStmt] { ... }
+#   16|         0: [LocalVariableDeclStmt] var ...;
+#   16|           1: [LocalVariableDeclExpr] lambda1
+#   16|             0: [LambdaExpr] ...->...
+#   16|               -4: [AnonymousClass] new Function2<Integer,Integer,Integer>(...) { ... }
+#   16|                 1: [Constructor] 
+#   16|                   5: [BlockStmt] { ... }
+#   16|                     0: [SuperConstructorInvocationStmt] super(...)
+#   16|                 1: [Method] invoke
+#-----|                   4: (Parameters)
+#   16|                     0: [Parameter] a
+#   16|                     1: [Parameter] b
+#   16|                   5: [BlockStmt] { ... }
+#   16|                     0: [ReturnStmt] return ...
+#   16|                       0: [AddExpr] ... + ...
+#   16|                         0: [VarAccess] a
+#   16|                         1: [VarAccess] b
+#   16|               -3: [TypeAccess] Function2<Integer,Integer,Integer>
+#   17|         1: [LocalVariableDeclStmt] var ...;
+#   17|           1: [LocalVariableDeclExpr] lambda2
+#   17|             0: [LambdaExpr] ...->...
+#   17|               -4: [AnonymousClass] new Function2<Integer,Integer,Integer>(...) { ... }
+#   17|                 1: [Constructor] 
+#   17|                   5: [BlockStmt] { ... }
+#   17|                     0: [SuperConstructorInvocationStmt] super(...)
+#   17|                 1: [Method] invoke
+#-----|                   4: (Parameters)
+#   17|                     0: [Parameter] a
+#   17|                     1: [Parameter] b
+#   17|                   5: [BlockStmt] { ... }
+#   17|                     0: [ReturnStmt] return ...
+#   17|                       0: [AddExpr] ... + ...
+#   17|                         0: [VarAccess] a
+#   17|                         1: [VarAccess] b
+#   17|               -3: [TypeAccess] Function2<Integer,Integer,Integer>
+#   20|     6: [Method] fn4
+#   20|       5: [BlockStmt] { ... }
+#   21|         0: [LocalVariableDeclStmt] var ...;
+#   21|           1: [LocalVariableDeclExpr] fnRef
+#   21|             0: [MemberRefExpr] ...::...
+#   21|               -4: [AnonymousClass] new Function0<Unit>(...) { ... }
+#   21|                 1: [Constructor] 
+#   21|                   5: [BlockStmt] { ... }
+#   21|                     0: [SuperConstructorInvocationStmt] super(...)
+#   21|                 1: [Method] invoke
+#   21|                   5: [BlockStmt] { ... }
+#   21|                     0: [ReturnStmt] return ...
+#   21|                       0: [MethodAccess] fn3(...)
+#   21|               -3: [TypeAccess] Function0<Unit>
+#   24|     7: [Method] fn5
+#   24|       5: [BlockStmt] { ... }
+#   25|         0: [LocalTypeDeclStmt] class ...
+#   25|           0: [LocalClass] LocalClass
+#   25|             1: [Constructor] LocalClass
+#   25|               5: [BlockStmt] { ... }
+#   25|                 0: [SuperConstructorInvocationStmt] super(...)
+#   25|                 1: [ExprStmt] <Expr>;
+#   25|                   0: [MethodAccess] <obinit>(...)
+#   26|         1: [ExprStmt] <Expr>;
+#   26|           0: [CastExpr] (...)...
+#   26|             0: [TypeAccess] Unit
+#   26|             1: [ClassInstanceExpr] new LocalClass(...)
+#   26|               -3: [TypeAccess] LocalClass
 superChain.kt:
 #    0| [CompilationUnit] superChain
 #    0|   1: [Class] SuperChainKt
diff --git a/java/ql/test/kotlin/library-tests/classes/anonymousClasses.expected b/java/ql/test/kotlin/library-tests/classes/anonymousClasses.expected
@@ -6,3 +6,5 @@
 | classes.kt:85:16:85:25 | new Object(...) { ... } | classes.kt:85:16:85:25 | new (...) |  | classes.kt:85:16:85:25 | Object | classes.kt:85:16:85:25 | class ... |
 | classes.kt:89:16:89:44 | new Interface3<Integer>(...) { ... } | classes.kt:89:16:89:44 | new (...) |  | classes.kt:89:16:89:44 | Interface3<Integer> | classes.kt:89:16:89:44 | class ... |
 | classes.kt:127:16:134:9 | new Object(...) { ... } | classes.kt:127:16:134:9 | new (...) |  | classes.kt:127:16:134:9 | Object | classes.kt:127:16:134:9 | class ... |
+| local_anonymous.kt:5:16:7:9 | new Object(...) { ... } | local_anonymous.kt:5:16:7:9 | new (...) |  | local_anonymous.kt:5:16:7:9 | Object | local_anonymous.kt:5:16:7:9 | class ... |
+| local_anonymous.kt:11:9:11:24 | new Object(...) { ... } | local_anonymous.kt:12:9:12:17 | new (...) |  | local_anonymous.kt:12:9:12:17 | Object | local_anonymous.kt:11:9:11:24 | class ... |
diff --git a/java/ql/test/kotlin/library-tests/classes/classes.expected b/java/ql/test/kotlin/library-tests/classes/classes.expected
@@ -34,6 +34,14 @@
 | classes.kt:119:13:121:13 | Local2 | C1$Local2 | final |
 | classes.kt:127:16:134:9 | new Object(...) { ... } | <anonymous class> | final |
 | classes.kt:129:17:131:17 | Local3 | C1$$Local3 | final |
+| local_anonymous.kt:0:0:0:0 | Local_anonymousKt | LocalAnonymous.Local_anonymousKt |  |
+| local_anonymous.kt:3:1:28:1 | Class1 | LocalAnonymous.Class1 | final, public |
+| local_anonymous.kt:5:16:7:9 | new Object(...) { ... } | <anonymous class> | final |
+| local_anonymous.kt:11:9:11:24 | new Object(...) { ... } | <anonymous class> | final, public, static |
+| local_anonymous.kt:16:23:16:49 | new Function2<Integer,Integer,Integer>(...) { ... } | <anonymous class> | final, public, static |
+| local_anonymous.kt:17:23:17:49 | new Function2<Integer,Integer,Integer>(...) { ... } | <anonymous class> | final, public, static |
+| local_anonymous.kt:21:21:21:31 | new Function0<Unit>(...) { ... } | <anonymous class> | final, public, static |
+| local_anonymous.kt:25:9:25:27 | LocalClass | LocalAnonymous.Class1$LocalClass | final |
 | superChain.kt:0:0:0:0 | SuperChainKt | SuperChainKt |  |
 | superChain.kt:1:1:1:33 | SuperChain1 | SuperChain1 | public |
 | superChain.kt:2:1:2:60 | SuperChain2 | SuperChain2 | public |
diff --git a/java/ql/test/kotlin/library-tests/classes/ctorCalls.expected b/java/ql/test/kotlin/library-tests/classes/ctorCalls.expected
@@ -34,6 +34,13 @@ superCall
 | classes.kt:119:13:121:13 | super(...) |
 | classes.kt:127:16:134:9 | super(...) |
 | classes.kt:129:17:131:17 | super(...) |
+| local_anonymous.kt:3:1:28:1 | super(...) |
+| local_anonymous.kt:5:16:7:9 | super(...) |
+| local_anonymous.kt:11:9:11:24 | super(...) |
+| local_anonymous.kt:16:23:16:49 | super(...) |
+| local_anonymous.kt:17:23:17:49 | super(...) |
+| local_anonymous.kt:21:21:21:31 | super(...) |
+| local_anonymous.kt:25:9:25:27 | super(...) |
 | superChain.kt:1:1:1:33 | super(...) |
 | superChain.kt:2:33:2:57 | super(...) |
 | superChain.kt:3:33:3:57 | super(...) |
diff --git a/java/ql/test/kotlin/library-tests/classes/initBlocks.expected b/java/ql/test/kotlin/library-tests/classes/initBlocks.expected
@@ -38,6 +38,9 @@ initBlocks
 | classes.kt:119:13:121:13 | <obinit> |
 | classes.kt:127:16:134:9 | <obinit> |
 | classes.kt:129:17:131:17 | <obinit> |
+| local_anonymous.kt:3:1:28:1 | <obinit> |
+| local_anonymous.kt:5:16:7:9 | <obinit> |
+| local_anonymous.kt:25:9:25:27 | <obinit> |
 | superChain.kt:1:1:1:33 | <obinit> |
 | superChain.kt:2:1:2:60 | <obinit> |
 | superChain.kt:3:1:3:60 | <obinit> |
@@ -76,6 +79,9 @@ initCall
 | classes.kt:119:13:121:13 | <obinit>(...) |
 | classes.kt:127:16:134:9 | <obinit>(...) |
 | classes.kt:129:17:131:17 | <obinit>(...) |
+| local_anonymous.kt:3:1:28:1 | <obinit>(...) |
+| local_anonymous.kt:5:16:7:9 | <obinit>(...) |
+| local_anonymous.kt:25:9:25:27 | <obinit>(...) |
 | superChain.kt:1:1:1:33 | <obinit>(...) |
 | superChain.kt:2:1:2:60 | <obinit>(...) |
 | superChain.kt:3:1:3:60 | <obinit>(...) |
diff --git a/java/ql/test/kotlin/library-tests/classes/localClass.expected b/java/ql/test/kotlin/library-tests/classes/localClass.expected
@@ -2,3 +2,4 @@
 | classes.kt:118:9:123:9 | class ... | classes.kt:118:9:123:9 |  | classes.kt:117:5:124:5 | fn2 | classes.kt:109:1:136:1 | C1 |
 | classes.kt:119:13:121:13 | class ... | classes.kt:119:13:121:13 | Local2 | classes.kt:118:9:123:9 | localFn | classes.kt:109:1:136:1 | C1 |
 | classes.kt:129:17:131:17 | class ... | classes.kt:129:17:131:17 | Local3 | classes.kt:128:13:133:13 | fn | classes.kt:127:16:134:9 | new Object(...) { ... } |
+| local_anonymous.kt:25:9:25:27 | class ... | local_anonymous.kt:25:9:25:27 | LocalClass | local_anonymous.kt:24:5:27:5 | fn5 | local_anonymous.kt:3:1:28:1 | Class1 |
diff --git a/java/ql/test/kotlin/library-tests/classes/local_anonymous.expected b/java/ql/test/kotlin/library-tests/classes/local_anonymous.expected
@@ -0,0 +1,11 @@
+anonymousObjects
+| local_anonymous.kt:5:16:7:9 | new (...) | local_anonymous.kt:5:16:7:9 | new Object(...) { ... } | anonymous | local |
+localFunctions
+| local_anonymous.kt:11:9:11:24 | fnLocal | local_anonymous.kt:11:9:11:24 | new Object(...) { ... } | anonymous | local |
+lambdas
+| local_anonymous.kt:16:23:16:49 | ...->... | local_anonymous.kt:16:23:16:49 | new Function2<Integer,Integer,Integer>(...) { ... } | anonymous | not local |
+| local_anonymous.kt:17:23:17:49 | ...->... | local_anonymous.kt:17:23:17:49 | new Function2<Integer,Integer,Integer>(...) { ... } | anonymous | not local |
+memberRefs
+| local_anonymous.kt:21:21:21:31 | ...::... | local_anonymous.kt:21:21:21:31 | new Function0<Unit>(...) { ... } | anonymous | not local |
+localClasses
+| local_anonymous.kt:25:9:25:27 | LocalClass | not anonymous | local |
diff --git a/java/ql/test/kotlin/library-tests/classes/local_anonymous.kt b/java/ql/test/kotlin/library-tests/classes/local_anonymous.kt
@@ -0,0 +1,28 @@
+package LocalAnonymous
+
+class Class1 {
+    fun fn1(): Any {
+        return object {
+            fun fn() {}
+        }
+    }
+
+    fun fn2() {
+        fun fnLocal() {}
+        fnLocal()
+    }
+
+    fun fn3() {
+        val lambda1 = { a: Int, b: Int -> a + b }
+        val lambda2 = fun(a: Int, b: Int) = a + b
+    }
+
+    fun fn4() {
+        val fnRef = Class1::fn3
+    }
+
+    fun fn5() {
+        class LocalClass {}
+        LocalClass()
+    }
+}
diff --git a/java/ql/test/kotlin/library-tests/classes/local_anonymous.ql b/java/ql/test/kotlin/library-tests/classes/local_anonymous.ql
@@ -0,0 +1,53 @@
+import java
+
+private predicate filterFile(Top t) {
+  t.getFile().getRelativePath().matches("%/local_anonymous.kt")
+}
+
+private string isAnonymousType(Type t) {
+  if t instanceof AnonymousClass then result = "anonymous" else result = "not anonymous"
+}
+
+private string isLocalType(Type t) {
+  if t instanceof LocalClassOrInterface then result = "local" else result = "not local"
+}
+
+query predicate anonymousObjects(ClassInstanceExpr e, Type t, string anon, string local) {
+  filterFile(e) and
+  exists(AnonymousClass c | e = c.getClassInstanceExpr()) and
+  not exists(LambdaExpr l | l.getType() = t) and
+  not exists(MemberRefExpr mr | mr.getType() = t) and
+  not exists(Method m | m = t.(Class).getAMethod() and m.isLocal()) and
+  t = e.getType() and
+  anon = isAnonymousType(t) and
+  local = isLocalType(t)
+}
+
+query predicate localFunctions(Method m, Type t, string anon, string local) {
+  filterFile(m) and
+  m.isLocal() and
+  t = m.getDeclaringType() and
+  anon = isAnonymousType(t) and
+  local = isLocalType(t)
+}
+
+query predicate lambdas(LambdaExpr e, Type t, string anon, string local) {
+  filterFile(e) and
+  t = e.getType() and
+  anon = isAnonymousType(t) and
+  local = isLocalType(t)
+}
+
+query predicate memberRefs(MemberRefExpr e, Type t, string anon, string local) {
+  filterFile(e) and
+  t = e.getType() and
+  anon = isAnonymousType(t) and
+  local = isLocalType(t)
+}
+
+query predicate localClasses(LocalClass c, string anon, string local) {
+  filterFile(c) and
+  not c instanceof AnonymousClass and
+  anon = isAnonymousType(c) and
+  local = isLocalType(c)
+}
diff --git a/java/ql/test/kotlin/library-tests/classes/superTypes.expected b/java/ql/test/kotlin/library-tests/classes/superTypes.expected
@@ -42,6 +42,16 @@
 | classes.kt:127:16:134:9 | new Object(...) { ... } | file://<external>/Object.class:0:0:0:0 | Object |
 | classes.kt:129:17:131:17 | Local3 | file://<external>/Object.class:0:0:0:0 | Object |
 | classes.kt:129:17:131:17 | Local3<Integer> | file://<external>/Object.class:0:0:0:0 | Object |
+| local_anonymous.kt:3:1:28:1 | Class1 | file://<external>/Object.class:0:0:0:0 | Object |
+| local_anonymous.kt:5:16:7:9 | new Object(...) { ... } | file://<external>/Object.class:0:0:0:0 | Object |
+| local_anonymous.kt:11:9:11:24 | new Object(...) { ... } | file://<external>/Object.class:0:0:0:0 | Object |
+| local_anonymous.kt:16:23:16:49 | new Function2<Integer,Integer,Integer>(...) { ... } | file:///usr/local/Cellar/kotlin/1.5.21/libexec/lib/kotlin-stdlib.jar/kotlin/jvm/functions/Function2.class:0:0:0:0 | Function2<Integer,Integer,Integer> |
+| local_anonymous.kt:16:23:16:49 | new Function2<Integer,Integer,Integer>(...) { ... } | file://<external>/Object.class:0:0:0:0 | Object |
+| local_anonymous.kt:17:23:17:49 | new Function2<Integer,Integer,Integer>(...) { ... } | file:///usr/local/Cellar/kotlin/1.5.21/libexec/lib/kotlin-stdlib.jar/kotlin/jvm/functions/Function2.class:0:0:0:0 | Function2<Integer,Integer,Integer> |
+| local_anonymous.kt:17:23:17:49 | new Function2<Integer,Integer,Integer>(...) { ... } | file://<external>/Object.class:0:0:0:0 | Object |
+| local_anonymous.kt:21:21:21:31 | new Function0<Unit>(...) { ... } | file:///usr/local/Cellar/kotlin/1.5.21/libexec/lib/kotlin-stdlib.jar/kotlin/jvm/functions/Function0.class:0:0:0:0 | Function0<Unit> |
+| local_anonymous.kt:21:21:21:31 | new Function0<Unit>(...) { ... } | file://<external>/Object.class:0:0:0:0 | Object |
+| local_anonymous.kt:25:9:25:27 | LocalClass | file://<external>/Object.class:0:0:0:0 | Object |
 | superChain.kt:1:1:1:33 | SuperChain1 | file://<external>/Object.class:0:0:0:0 | Object |
 | superChain.kt:1:1:1:33 | SuperChain1<T3,String> | file://<external>/Object.class:0:0:0:0 | Object |
 | superChain.kt:1:1:1:33 | SuperChain1<T5,String> | file://<external>/Object.class:0:0:0:0 | Object |

Original file line number	Diff line number	Diff line change
`@@ -662,6 +662,8 @@ open class KotlinFileExtractor(`
`662`	`662`	`if (s.isLocalFunction()) {`
`663`	`663`	`val classId = extractGeneratedClass(s, listOf(pluginContext.irBuiltIns.anyType))`
`664`	`664`	`extractLocalTypeDeclStmt(classId, s, callable, parent, idx)`
	`665`	`+ val ids = getLocallyVisibleFunctionLabels(s)`
	`666`	`+ tw.writeKtLocalFunction(ids.function)`
`665`	`667`	`} else {`
`666`	`668`	`logger.warnElement(Severity.ErrorSevere, "Expected to find local function", s)`
`667`	`669`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1143,3 +1143,7 @@ ktSyntheticBody(`
`1143`	`1143`	`// 1: ENUM_VALUES`
`1144`	`1144`	`// 2: ENUM_VALUEOF`
`1145`	`1145`	`)`
	`1146`	`+`
	`1147`	`+ktLocalFunction(`
	`1148`	`+ unique int id: @method ref`
	`1149`	`+)`
Original file line number	Diff line number	Diff line change
`@@ -463,6 +463,9 @@ class Method extends Callable, @method {`
`463`	`463`	`not this.getDeclaringType().isFinal()`
`464`	`464`	`}`
`465`	`465`
	`466`	`+ /** Holds if this method is a Kotlin local function. */`
	`467`	`+ predicate isLocal() { ktLocalFunction(this) }`
	`468`	`+`
`466`	`469`	`override string getAPrimaryQlClass() { result = "Method" }`
`467`	`470`	`}`
`468`	`471`