IFDS core refactor

.github/workflows/build-and-test.yml

@@ -2,9 +2,12 @@ name: Build and run tests
 
 on:
   push:
+    branches:
+      - develop
   pull_request:
     branches:
       - develop
+  workflow_dispatch:
 
 permissions:
   contents: read

buildSrc/src/main/kotlin/Dependencies.kt

@@ -20,7 +20,7 @@ object Versions {
     const val jooq = "3.14.16"
     const val juliet = "1.3.2"
     const val junit = "5.9.2"
-    const val kotlin = "1.7.21"
+    const val kotlin = "1.9.0"
     const val kotlin_logging = "1.8.3"
     const val kotlinx_benchmark = "0.4.4"
     const val kotlinx_cli = "0.3.5"

jacodb-analysis/README.md

@@ -1,3 +1,5 @@
+# OUTDATED!
+
 # Module `jacodb-analysis` 
 
 The `jacodb-analysis` module allows launching application dataflow analyses.

jacodb-analysis/actors/build.gradle.kts

@@ -0,0 +1,8 @@
+dependencies {
+    implementation(Libs.kotlin_logging)
+    implementation(Libs.slf4j_simple)
+    implementation(Libs.kotlinx_coroutines_core)
+
+    testImplementation(kotlin("test"))
+    testImplementation(Libs.mockk)
+}

jacodb-analysis/src/main/kotlin/org/jacodb/analysis/taint/Types.kt → jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/Actor.kt

@@ -14,12 +14,15 @@
  *  limitations under the License.
  */
 
-package org.jacodb.analysis.taint
+package org.jacodb.actors.api
 
-import org.jacodb.analysis.ifds.Edge
-import org.jacodb.analysis.ifds.Runner
-import org.jacodb.analysis.ifds.Vertex
+import org.jacodb.actors.api.signal.Signal
 
-typealias TaintVertex = Vertex<TaintDomainFact>
-typealias TaintEdge = Edge<TaintDomainFact>
-typealias TaintRunner = Runner<TaintDomainFact>
+interface Actor<M> {
+    suspend fun receive(message: M)
+    suspend fun receive(signal: Signal) {
+        if (signal is Signal.Exception) {
+            signal.exception.printStackTrace()
+        }
+    }
+}

jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/ActorContext.kt

@@ -0,0 +1,33 @@
+/*
+ *  Copyright 2022 UnitTestBot contributors (utbot.org)
+ * <p>
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ * <p>
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package org.jacodb.actors.api
+
+import mu.KLogger
+import kotlin.time.Duration
+
+interface ActorContext<M> : ActorSpawner {
+    val self: ActorRef<M>
+
+    suspend fun <TargetMessage> ActorRef<TargetMessage>.send(message: TargetMessage)
+
+    suspend fun sendSelfWithDelay(message: M, waitDelay: Duration)
+
+    fun stop()
+    fun resume()
+
+    val logger: KLogger
+}

jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/ActorFactory.kt

@@ -0,0 +1,21 @@
+/*
+ *  Copyright 2022 UnitTestBot contributors (utbot.org)
+ * <p>
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ * <p>
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package org.jacodb.actors.api
+
+fun interface ActorFactory<M> {
+    fun ActorContext<M>.create(): Actor<M>
+}

jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/ActorPath.kt

@@ -0,0 +1,21 @@
+/*
+ *  Copyright 2022 UnitTestBot contributors (utbot.org)
+ * <p>
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ * <p>
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package org.jacodb.actors.api
+
+interface ActorPath {
+    operator fun div(name: String): ActorPath
+}

jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/ActorRef.kt

@@ -0,0 +1,24 @@
+/*
+ *  Copyright 2022 UnitTestBot contributors (utbot.org)
+ * <p>
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ * <p>
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package org.jacodb.actors.api
+
+// Abstract class used instead of interface to support internal abstract functions
+abstract class ActorRef<in M>(
+    val path: ActorPath,
+) {
+    internal abstract suspend fun receive(message: M): Boolean
+}

jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/ActorSpawner.kt

@@ -0,0 +1,33 @@
+/*
+ *  Copyright 2022 UnitTestBot contributors (utbot.org)
+ * <p>
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ * <p>
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package org.jacodb.actors.api
+
+import org.jacodb.actors.api.options.SpawnOptions
+
+interface ActorSpawner {
+    fun <ChildMessage> spawn(
+        name: String,
+        options: SpawnOptions = SpawnOptions.default,
+        actorFactory: ActorFactory<ChildMessage>,
+    ): ActorRef<ChildMessage>
+
+    fun child(name: String): ActorRef<*>?
+    fun children(): Map<String, ActorRef<*>>
+
+    fun stopChild(name: String)
+    fun resumeChild(name: String)
+}

jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/ActorStatus.kt

@@ -0,0 +1,22 @@
+/*
+ *  Copyright 2022 UnitTestBot contributors (utbot.org)
+ * <p>
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ * <p>
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package org.jacodb.actors.api
+
+enum class ActorStatus {
+    IDLE,
+    BUSY
+}

jacodb-analysis/src/main/kotlin/org/jacodb/analysis/sarif/Vulnerability.kt → jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/ActorSystem.kt

@@ -14,18 +14,23 @@
  *  limitations under the License.
  */
 
-package org.jacodb.analysis.sarif
+package org.jacodb.actors.api
 
-import io.github.detekt.sarif4k.Level
-import org.jacodb.analysis.ifds.TraceGraph
+import kotlinx.coroutines.CompletableDeferred
+import mu.KLogger
 
-data class VulnerabilityInstance<Fact>(
-    val traceGraph: TraceGraph<Fact>,
-    val description: VulnerabilityDescription,
-)
+interface ActorSystem<Message> : AutoCloseable {
+    val name: String
 
-data class VulnerabilityDescription(
-    val ruleId: String?,
-    val message: String?,
-    val level: Level = Level.Warning,
-)
+    suspend fun send(message: Message)
+
+    suspend fun <R> ask(messageBuilder: (CompletableDeferred<R>) -> Message): R
+
+    suspend fun awaitCompletion()
+
+    suspend fun resume()
+
+    fun stop()
+
+    val logger: KLogger
+}

jacodb-analysis/src/main/kotlin/org/jacodb/analysis/graph/JcNoopInst.kt → jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/options/ChannelFactory.kt

@@ -14,20 +14,24 @@
  *  limitations under the License.
  */
 
-package org.jacodb.analysis.graph
+package org.jacodb.actors.api.options
 
-import org.jacodb.api.cfg.JcExpr
-import org.jacodb.api.cfg.JcInst
-import org.jacodb.api.cfg.JcInstLocation
-import org.jacodb.api.cfg.JcInstVisitor
+import kotlinx.coroutines.channels.Channel
 
-data class JcNoopInst(override val location: JcInstLocation) : JcInst {
-    override val operands: List<JcExpr>
-        get() = emptyList()
+fun interface ChannelFactory {
+    fun create(): Channel<Any?>
 
-    override fun <T> accept(visitor: JcInstVisitor<T>): T {
-        return visitor.visitExternalJcInst(this)
-    }
+    companion object {
+        fun unlimited() = ChannelFactory {
+            Channel(capacity = Channel.UNLIMITED)
+        }
+
+        fun rendezvous() = ChannelFactory {
+            Channel(capacity = Channel.RENDEZVOUS)
+        }
 
-    override fun toString(): String = "noop"
+        fun buffered(size: Int) = ChannelFactory {
+            Channel(capacity = size)
+        }
+    }
 }

jacodb-analysis/src/main/kotlin/org/jacodb/analysis/taint/Sarif.kt → jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/options/SpawnOptions.kt

@@ -14,20 +14,24 @@
  *  limitations under the License.
  */
 
-package org.jacodb.analysis.taint
+package org.jacodb.actors.api.options
 
-import org.jacodb.analysis.ifds.TraceGraph
-import org.jacodb.analysis.sarif.VulnerabilityDescription
-import org.jacodb.analysis.sarif.VulnerabilityInstance
+import kotlinx.coroutines.channels.Channel
 
-fun TaintVulnerability.toSarif(
-    graph: TraceGraph<TaintDomainFact>,
-): VulnerabilityInstance<TaintDomainFact> {
-    return VulnerabilityInstance(
-        graph,
-        VulnerabilityDescription(
-            ruleId = null,
-            message = rule?.ruleNote
-        )
+class SpawnOptions(
+    val channelFactory: ChannelFactory,
+) {
+    fun channelFactory(channelFactory: ChannelFactory) = SpawnOptions(
+        channelFactory = channelFactory,
+    )
+
+    fun channel(channel: Channel<Any?>) = SpawnOptions(
+        channelFactory = { channel },
     )
+
+    companion object {
+        val default = SpawnOptions(
+            ChannelFactory.unlimited(),
+        )
+    }
 }

jacodb-analysis/actors/src/main/kotlin/org/jacodb/actors/api/signal/Signal.kt

@@ -0,0 +1,23 @@
+/*
+ *  Copyright 2022 UnitTestBot contributors (utbot.org)
+ * <p>
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ * <p>
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package org.jacodb.actors.api.signal
+
+sealed interface Signal {
+    data object Start : Signal
+    data object PostStop : Signal
+    data class Exception(val exception: java.lang.Exception) : Signal
+}