feat: replace synchronization mechanism with kotlinx.atomicfu locks

kosi-libs · Jan 7, 2025 · 33b56c9 · 33b56c9
1 parent 7d4d938
commit 33b56c9
Show file tree

Hide file tree

Showing 11 changed files with 29 additions and 19 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,6 +1,7 @@
 [versions]
 # Core
- kaverit = "2.10.0"
+kaverit = "2.10.0"
+atomicfu="0.26.1"
 # Android
 android-appcompat = "28.0.0"
 androidx-appcompat = "1.7.0"
@@ -64,6 +65,7 @@ junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "jun
 junit = { module = "junit:junit", version.ref = "junit" }
 
 [plugins]
+kotlinx-atomicfu = { id = "org.jetbrains.kotlinx.atomicfu", version.ref = "atomicfu" }
 compose = { id = "org.jetbrains.compose", version.ref = "jbCompose" }
 ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
 openjfx = { id = "org.openjfx.javafxplugin", version.ref = "openjfx" }
diff --git a/kodein-di-conf/build.gradle.kts b/kodein-di-conf/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("org.kodein.library.mpp")
+    alias(libs.plugins.kotlinx.atomicfu)
 }
 
 kotlin.kodein {

diff --git a/kodein-di-conf/src/commonMain/kotlin/org/kodein/di/conf/ConfigurableDI.kt b/kodein-di-conf/src/commonMain/kotlin/org/kodein/di/conf/ConfigurableDI.kt
@@ -1,5 +1,6 @@
 package org.kodein.di.conf
 
+import kotlinx.atomicfu.locks.SynchronizedObject
 import org.kodein.di.Copy
 import org.kodein.di.DI
 import org.kodein.di.DIContainer
@@ -19,7 +20,7 @@ public class ConfigurableDI : DI {
     /** @suppress */
     override val di: DI get() = this
 
-    private val _lock = Any()
+    private val _lock = SynchronizedObject()
 
     /**
      * Whether this Configurabledi can be mutated.

diff --git a/kodein-di/build.gradle.kts b/kodein-di/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     kodein.library.mpp
+    alias(libs.plugins.kotlinx.atomicfu)
 }
 
 kotlin.kodein {

diff --git a/kodein-di/src/commonMain/kotlin/org/kodein/di/bindings/scopes.kt b/kodein-di/src/commonMain/kotlin/org/kodein/di/bindings/scopes.kt
@@ -1,5 +1,6 @@
 package org.kodein.di.bindings
 
+import kotlinx.atomicfu.locks.SynchronizedObject
 import org.kodein.di.DIContext
 import org.kodein.di.DirectDI
 import org.kodein.di.internal.maySynchronized
@@ -53,7 +54,7 @@ public class StandardScopeRegistry : ScopeRegistry() {
 
     private val _cache = newConcurrentMap<RegKey, () -> Any?>()
 
-    private val _lock = Any()
+    private val _lock = SynchronizedObject()
 
     override fun getOrCreate(key: RegKey, sync: Boolean, creator: () -> Reference<Any>): Any {
         return synchronizedIfNull(
@@ -107,7 +108,7 @@ public class StandardScopeRegistry : ScopeRegistry() {
  * If the key changes, the held item will be replaced.
  */
 public class SingleItemScopeRegistry : ScopeRegistry() {
-    private val _lock = Any()
+    private val _lock = SynchronizedObject()
 
     @kotlin.concurrent.Volatile
     private var _pair: Pair<RegKey, () -> Any?>? = null

diff --git a/kodein-di/src/commonMain/kotlin/org/kodein/di/bindings/standardBindings.kt b/kodein-di/src/commonMain/kotlin/org/kodein/di/bindings/standardBindings.kt
@@ -1,5 +1,6 @@
 package org.kodein.di.bindings
 
+import kotlinx.atomicfu.locks.SynchronizedObject
 import org.kodein.di.*
 import org.kodein.di.internal.BindingDIImpl
 import org.kodein.di.internal.synchronizedIfNull
@@ -199,7 +200,7 @@ public class EagerSingleton<T : Any>(
 
     @Volatile
     private var _instance: T? = null
-    private val _lock = Any()
+    private val _lock = SynchronizedObject()
 
     private fun getFactory(di: BindingDI<Any>): (Unit) -> T {
         return { _ ->

diff --git a/kodein-di/src/commonMain/kotlin/org/kodein/di/internal/DIContainerImpl.kt b/kodein-di/src/commonMain/kotlin/org/kodein/di/internal/DIContainerImpl.kt
@@ -1,5 +1,6 @@
 package org.kodein.di.internal
 
+import kotlinx.atomicfu.locks.SynchronizedObject
 import org.kodein.di.AnyDIContext
 import org.kodein.di.BindingsMap
 import org.kodein.di.DI
@@ -43,7 +44,7 @@ internal class DIContainerImpl private constructor(
         if (runCallbacks)
             init()
         else {
-            val lock = Any()
+            val lock = SynchronizedObject()
             initCallbacks = {
                 synchronizedIfNotNull(
                         lock = lock,

diff --git a/kodein-di/src/commonMain/kotlin/org/kodein/di/internal/concurrent.kt b/kodein-di/src/commonMain/kotlin/org/kodein/di/internal/concurrent.kt
@@ -1,9 +1,21 @@
 package org.kodein.di.internal
 
-public expect inline fun <R> maySynchronized(lock: Any?, block: () -> R): R
+import kotlinx.atomicfu.locks.SynchronizedObject
+import kotlinx.atomicfu.locks.synchronized
+
+/**
+ * Using kotlinx-atomicfu may cause some performance issues on native platforms.
+ * @see https://youtrack.jetbrains.com/issue/CMP-1182 and https://youtrack.jetbrains.com/issue/KT-70751
+ */
+public inline fun <R> maySynchronized(lock: SynchronizedObject?, block: () -> R): R =
+    if (lock == null) {
+        block()
+    } else {
+        synchronized(lock, block)
+    }
 
 /** @suppress */
-public inline fun <T: Any, R> synchronizedIfNull(lock: Any?, predicate: () -> T?, ifNotNull: (T) -> R, ifNull: () -> R): R {
+public inline fun <T: Any, R> synchronizedIfNull(lock: SynchronizedObject?, predicate: () -> T?, ifNotNull: (T) -> R, ifNull: () -> R): R {
     predicate()?.let {
         return ifNotNull(it)
     }
@@ -18,7 +30,7 @@ public inline fun <T: Any, R> synchronizedIfNull(lock: Any?, predicate: () -> T?
 }
 
 /** @suppress */
-internal inline fun <T: Any, R> synchronizedIfNotNull(lock: Any?, predicate: () -> T?, ifNull: () -> R, ifNotNull: (T) -> R): R {
+internal inline fun <T: Any, R> synchronizedIfNotNull(lock: SynchronizedObject?, predicate: () -> T?, ifNull: () -> R, ifNotNull: (T) -> R): R {
     if (predicate() == null) {
         return ifNull()
     }

diff --git a/kodein-di/src/jsBasedMain/kotlin/org/kodein/di/internal/lang.kt b/kodein-di/src/jsBasedMain/kotlin/org/kodein/di/internal/lang.kt
@@ -3,5 +3,3 @@ package org.kodein.di.internal
 internal actual fun <K, V> newConcurrentMap(): MutableMap<K, V> = HashMap()
 internal actual fun <T> newLinkedList(): MutableList<T> = ArrayList()
 internal actual fun <T> newLinkedList(c: Collection<T>): MutableList<T> = ArrayList(c)
-
-public actual inline fun <R> maySynchronized(lock: Any?, block: () -> R): R = block()
diff --git a/kodein-di/src/jvmMain/kotlin/org/kodein/di/internal/lang.kt b/kodein-di/src/jvmMain/kotlin/org/kodein/di/internal/lang.kt
@@ -6,9 +6,3 @@ import java.util.concurrent.ConcurrentHashMap
 internal actual fun <K, V> newConcurrentMap(): MutableMap<K, V> = ConcurrentHashMap()
 internal actual fun <T> newLinkedList(): MutableList<T> = LinkedList()
 internal actual fun <T> newLinkedList(c: Collection<T>): MutableList<T> = LinkedList(c)
-
-public actual inline fun <R> maySynchronized(lock: Any?, block: () -> R): R =
-        if (lock == null)
-            block()
-        else
-            synchronized(lock, block)
diff --git a/kodein-di/src/nativeMain/kotlin/org/kodein/di/internal/lang.kt b/kodein-di/src/nativeMain/kotlin/org/kodein/di/internal/lang.kt
@@ -3,5 +3,3 @@ package org.kodein.di.internal
 internal actual fun <K, V> newConcurrentMap(): MutableMap<K, V> = HashMap()
 internal actual fun <T> newLinkedList(): MutableList<T> = ArrayList()
 internal actual fun <T> newLinkedList(c: Collection<T>): MutableList<T> = ArrayList(c)
-
-public actual inline fun <R> maySynchronized(lock: Any?, block: () -> R): R = block()