Atomic values support. (#1695)

backend.native/compiler/ir/backend.native/src/org/jetbrains/kotlin/backend/konan/descriptors/DescriptorUtils.kt

@@ -83,17 +83,17 @@ internal fun IrSimpleFunction.resolveFakeOverride(): IrSimpleFunction {
 }
 
 private val intrinsicAnnotation = FqName("konan.internal.Intrinsic")
-private val immutableAnnotation = FqName("konan.internal.Immutable")
+private val frozenAnnotation = FqName("konan.internal.Frozen")
 
 // TODO: don't forget to remove descriptor access here.
 internal val FunctionDescriptor.isIntrinsic: Boolean
     get() = this.descriptor.annotations.hasAnnotation(intrinsicAnnotation)
 
-internal val org.jetbrains.kotlin.descriptors.DeclarationDescriptor.isImmutable: Boolean
-    get() = this.annotations.hasAnnotation(immutableAnnotation)
+internal val org.jetbrains.kotlin.descriptors.DeclarationDescriptor.isFrozen: Boolean
+    get() = this.annotations.hasAnnotation(frozenAnnotation)
 
-internal val DeclarationDescriptor.isImmutable: Boolean
-    get() = this.descriptor.isImmutable
+internal val DeclarationDescriptor.isFrozen: Boolean
+    get() = this.descriptor.isFrozen
 
 private val intrinsicTypes = setOf(
         "kotlin.Boolean", "kotlin.Char",

backend.native/compiler/ir/backend.native/src/org/jetbrains/kotlin/backend/konan/llvm/IrToBitcode.kt

@@ -42,7 +42,6 @@ import org.jetbrains.kotlin.ir.visitors.acceptChildrenVoid
 import org.jetbrains.kotlin.ir.visitors.acceptVoid
 import org.jetbrains.kotlin.konan.target.CompilerOutputKind
 import org.jetbrains.kotlin.konan.target.KonanTarget
-import org.jetbrains.kotlin.name.FqName
 import org.jetbrains.kotlin.resolve.descriptorUtil.fqNameUnsafe
 import org.jetbrains.kotlin.types.KotlinType
 import org.jetbrains.kotlin.types.TypeUtils
@@ -1413,7 +1412,7 @@ internal class CodeGeneratorVisitor(val context: Context, val lifetimes: Map<IrE
     private fun needMutationCheck(descriptor: org.jetbrains.kotlin.descriptors.DeclarationDescriptor): Boolean {
         // For now we omit mutation checks on immutable types, as this allows initialization in constructor
         // and it is assumed that API doesn't allow to change them.
-        return !descriptor.isImmutable
+        return !descriptor.isFrozen
     }
 
     private fun evaluateSetField(value: IrSetField): LLVMValueRef {

backend.native/compiler/ir/backend.native/src/org/jetbrains/kotlin/backend/konan/llvm/RTTIGenerator.kt

@@ -20,7 +20,6 @@ import llvm.*
 import org.jetbrains.kotlin.backend.konan.Context
 import org.jetbrains.kotlin.backend.konan.descriptors.*
 import org.jetbrains.kotlin.backend.konan.irasdescriptors.*
-import org.jetbrains.kotlin.descriptors.Modality
 import org.jetbrains.kotlin.ir.declarations.IrField
 import org.jetbrains.kotlin.ir.declarations.IrProperty
 import org.jetbrains.kotlin.name.FqName
@@ -31,7 +30,7 @@ internal class RTTIGenerator(override val context: Context) : ContextUtils {
 
     private fun flagsFromClass(classDescriptor: ClassDescriptor): Int {
         var result = 0
-        if (classDescriptor.isImmutable)
+        if (classDescriptor.isFrozen)
            result = result or 1 /* TF_IMMUTABLE */
         return result
     }

backend.native/tests/build.gradle

@@ -671,6 +671,12 @@ task freeze2(type: RunKonanTest) {
     source = "runtime/workers/freeze2.kt"
 }
 
+task atomic0(type: RunKonanTest) {
+    disabled = (project.testTarget == 'wasm32') // Workers need pthreads.
+    goldValue = "35\n" + "20\n"
+    source = "runtime/workers/atomic0.kt"
+}
+
 task enumIdentity(type: RunKonanTest) {
     disabled = (project.testTarget == 'wasm32') // Workers need pthreads.
     goldValue = "true\n"

backend.native/tests/runtime/workers/atomic0.kt

@@ -0,0 +1,83 @@
+package runtime.workers.atomic0
+
+import kotlin.test.*
+
+import konan.worker.*
+
+fun test1(workers: Array<Worker>) {
+    val atomic = AtomicInt(15)
+    val futures = Array(workers.size, { workerIndex ->
+        workers[workerIndex].schedule(TransferMode.CHECKED, { atomic }) {
+            input -> input.increment()
+        }
+    })
+    futures.forEach {
+        it.result()
+    }
+    println(atomic.get())
+}
+
+fun test2(workers: Array<Worker>) {
+    val atomic = AtomicInt(0)
+    val counter = AtomicInt(0)
+    val futures = Array(workers.size, { workerIndex ->
+        workers[workerIndex].schedule(TransferMode.CHECKED, { Triple(atomic, workerIndex, counter) }) {
+            (place, index, result) ->
+            while (place.compareAndSwap(index, index + 1) != index) {}
+            result.increment() == index + 1
+        }
+    })
+    futures.forEach {
+        assertEquals(it.result(), true)
+    }
+    println(counter.get())
+}
+
+data class Data(val value: Int)
+
+fun test3(workers: Array<Worker>) {
+    val common = AtomicReference<Data>()
+    val futures = Array(workers.size, { workerIndex ->
+        workers[workerIndex].schedule(TransferMode.CHECKED, { Pair(common, workerIndex) }) {
+            (place, index) ->
+            val mine = Data(index).freeze()
+            // Try to publish our own data, until successful, in a tight loop.
+            while (place.compareAndSwap(null, mine) != null) {}
+        }
+    })
+    val seen = mutableSetOf<Data>()
+    for (i in 0 until workers.size) {
+        do {
+            val current = common.get()
+            if (current != null && !seen.contains(current)) {
+                seen += current
+                // Let others publish.
+                assertEquals(common.compareAndSwap(current, null), current)
+                break
+            }
+        } while (true)
+    }
+    futures.forEach {
+        it.result()
+    }
+    assertEquals(seen.size, workers.size)
+}
+
+fun test4() {
+    assertFailsWith<InvalidMutabilityException> {
+        AtomicReference(Data(1))
+    }
+    assertFailsWith<InvalidMutabilityException> {
+        AtomicReference<Data>().compareAndSwap(null, Data(2))
+    }
+}
+
+@Test fun runTest() {
+    val COUNT = 20
+    val workers = Array(COUNT, { _ -> startWorker()})
+
+    test1(workers)
+    test2(workers)
+    test3(workers)
+    test4()
+}

runtime/src/main/cpp/Atomic.cpp

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2010-2018 JetBrains s.r.o.
+ *
+ * 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
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+
+#include "Atomic.h"
+#include "Common.h"
+#include "Types.h"
+
+namespace {
+
+template <typename T> T addAndGetImpl(KRef thiz, T delta) {
+  volatile T* location = reinterpret_cast<volatile T*>(thiz + 1);
+  return atomicAdd(location, delta);
+}
+
+template <typename T> T compareAndSwapImpl(KRef thiz, T expectedValue, T newValue) {
+    volatile T* location = reinterpret_cast<volatile T*>(thiz + 1);
+    return compareAndSwap(location, expectedValue, newValue);
+}
+
+}  // namespace
+
+extern "C" {
+
+RUNTIME_NORETURN void ThrowInvalidMutabilityException();
+
+KInt Kotlin_AtomicInt_addAndGet(KRef thiz, KInt delta) {
+    return addAndGetImpl(thiz, delta);
+}
+
+KInt Kotlin_AtomicInt_compareAndSwap(KRef thiz, KInt expectedValue, KInt newValue) {
+    return compareAndSwapImpl(thiz, expectedValue, newValue);
+}
+
+KLong Kotlin_AtomicLong_addAndGet(KRef thiz, KLong delta) {
+    return addAndGetImpl(thiz, delta);
+}
+
+KLong Kotlin_AtomicLong_compareAndSwap(KRef thiz, KLong expectedValue, KLong newValue) {
+    return compareAndSwapImpl(thiz, expectedValue, newValue);
+}
+
+KNativePtr Kotlin_AtomicNativePtr_compareAndSwap(KRef thiz, KNativePtr expectedValue, KNativePtr newValue) {
+    return compareAndSwapImpl(thiz, expectedValue, newValue);
+}
+
+void Kotlin_AtomicReference_checkIfFrozen(KRef value) {
+    if (value != nullptr && !value->container()->permanentOrFrozen()) {
+        ThrowInvalidMutabilityException();
+    }
+}
+
+KRef Kotlin_AtomicReference_compareAndSwap(KRef thiz, KRef expectedValue, KRef newValue) {
+    Kotlin_AtomicReference_checkIfFrozen(newValue);
+    return compareAndSwapImpl(thiz, expectedValue, newValue);
+}
+
+}  // extern "C"

runtime/src/main/cpp/Atomic.h

@@ -3,7 +3,8 @@
 
 #include "Common.h"
 
-ALWAYS_INLINE inline int atomicAdd(int* where, int what) {
+template <typename T>
+ALWAYS_INLINE inline T atomicAdd(volatile T* where, T what) {
 #ifndef KONAN_NO_THREADS
   return __sync_add_and_fetch(where, what);
 #else
@@ -11,5 +12,18 @@ ALWAYS_INLINE inline int atomicAdd(int* where, int what) {
 #endif
 }
 
+template <typename T>
+ALWAYS_INLINE inline T compareAndSwap(volatile T* where, T expectedValue, T newValue) {
+#ifndef KONAN_NO_THREADS
+  return __sync_val_compare_and_swap(where, expectedValue, newValue);
+#else
+   T oldValue = *where;
+   if (oldValue == expectedValue) {
+        *where = newValue;
+   }
+   return oldValue;
+#endif
+}
+
 
 #endif // RUNTIME_ATOMIC_H

runtime/src/main/cpp/Worker.cpp

@@ -25,9 +25,6 @@
 #if WITH_WORKERS
 #include <pthread.h>
 #include <sys/time.h>
-
-#include <deque>
-#include <unordered_map>
 #endif
 
 #include "Alloc.h"

runtime/src/main/kotlin/konan/BinaryBlob.kt

@@ -22,7 +22,7 @@ import kotlinx.cinterop.*
  * An immutable compile-time array of bytes.
  */
 @ExportTypeInfo("theImmutableBinaryBlobTypeInfo")
-@Immutable
+@Frozen
 public final class ImmutableBinaryBlob private constructor() {
     public val size: Int
         get() = getArrayLength()

runtime/src/main/kotlin/konan/internal/Annotations.kt

@@ -59,8 +59,9 @@ annotation class ExportForCompiler
 annotation class InlineConstructor
 
 /**
- * Class is immutable and is frozen by default.
+ * Class is frozen by default. Also this annotation is (ab)used for marking objects
+ * where mutability checks are not needed, and they are shared, such as atomics.
  */
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.BINARY)
-annotation class Immutable
+internal annotation class Frozen

runtime/src/main/kotlin/konan/internal/Boxing.kt

@@ -41,7 +41,7 @@ external fun getCachedLongBox(value: Long): LongBox
 @SymbolName("inLongBoxCache")
 external fun inLongBoxCache(value: Long): Boolean
 
-@Immutable
+@Frozen
 class BooleanBox(val value: Boolean) : Comparable<Boolean> {
     override fun equals(other: Any?): Boolean {
         if (other !is BooleanBox) {
@@ -65,7 +65,7 @@ fun boxBoolean(value: Boolean) = if (inBooleanBoxCache(value)) {
     BooleanBox(value)
 }
 
-@Immutable
+@Frozen
 class CharBox(val value: Char) : Comparable<Char> {
     override fun equals(other: Any?): Boolean {
         if (other !is CharBox) {
@@ -89,7 +89,7 @@ fun boxChar(value: Char) = if (inCharBoxCache(value)) {
     CharBox(value)
 }
 
-@Immutable
+@Frozen
 class ByteBox(val value: Byte) : Number(), Comparable<Byte> {
     override fun equals(other: Any?): Boolean {
         if (other !is ByteBox) {
@@ -121,7 +121,7 @@ fun boxByte(value: Byte) = if (inByteBoxCache(value)) {
     ByteBox(value)
 }
 
-@Immutable
+@Frozen
 class ShortBox(val value: Short) : Number(), Comparable<Short> {
     override fun equals(other: Any?): Boolean {
         if (other !is ShortBox) {
@@ -153,7 +153,7 @@ fun boxShort(value: Short) = if (inShortBoxCache(value)) {
     ShortBox(value)
 }
 
-@Immutable
+@Frozen
 class IntBox(val value: Int) : Number(), Comparable<Int> {
     override fun equals(other: Any?): Boolean {
         if (other !is IntBox) {
@@ -185,7 +185,7 @@ fun boxInt(value: Int) = if (inIntBoxCache(value)) {
     IntBox(value)
 }
 
-@Immutable
+@Frozen
 class LongBox(val value: Long) : Number(), Comparable<Long> {
     override fun equals(other: Any?): Boolean {
         if (other !is LongBox) {
@@ -217,7 +217,7 @@ fun boxLong(value: Long) = if (inLongBoxCache(value)) {
     LongBox(value)
 }
 
-@Immutable
+@Frozen
 class FloatBox(val value: Float) : Number(), Comparable<Float> {
     override fun equals(other: Any?): Boolean {
         if (other !is FloatBox) {
@@ -245,7 +245,7 @@ class FloatBox(val value: Float) : Number(), Comparable<Float> {
 @ExportForCppRuntime("Kotlin_boxFloat")
 fun boxFloat(value: Float) = FloatBox(value)
 
-@Immutable
+@Frozen
 class DoubleBox(val value: Double) : Number(), Comparable<Double> {
     override fun equals(other: Any?): Boolean {
         if (other !is DoubleBox) {

runtime/src/main/kotlin/konan/internal/InteropBoxing.kt

@@ -18,7 +18,7 @@ package konan.internal
 
 import kotlinx.cinterop.*
 
-@Immutable
+@Frozen
 class NativePtrBox(val value: NativePtr) {
     override fun equals(other: Any?): Boolean {
         if (other !is NativePtrBox) {
@@ -35,7 +35,7 @@ class NativePtrBox(val value: NativePtr) {
 
 fun boxNativePtr(value: NativePtr) = NativePtrBox(value)
 
-@Immutable
+@Frozen
 class NativePointedBox(val value: NativePointed) {
     override fun equals(other: Any?): Boolean {
         if (other !is NativePointedBox) {
@@ -56,7 +56,7 @@ class NativePointedBox(val value: NativePointed) {
 fun boxNativePointed(value: NativePointed?) = if (value != null) NativePointedBox(value) else null
 fun unboxNativePointed(box: NativePointedBox?) = box?.value
 
-@Immutable
+@Frozen
 class CPointerBox(val value: CPointer<CPointed>) : CValuesRef<CPointed>() {
     override fun equals(other: Any?): Boolean {
         if (other !is CPointerBox) {

runtime/src/main/kotlin/konan/worker/Atomics.kt

@@ -0,0 +1,209 @@
+/*
+ * Copyright 2010-2018 JetBrains s.r.o.
+ *
+ * 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
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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 konan.worker
+
+import konan.internal.Frozen
+import konan.SymbolName
+import kotlinx.cinterop.NativePtr
+
+@Frozen
+class AtomicInt(private var value: Int = 0) : Number() {
+    /* Atomic operations. */
+
+    /**
+     * Increments the value by [delta] and returns the new value.
+     */
+    @SymbolName("Kotlin_AtomicInt_addAndGet")
+    external fun addAndGet(delta: Int): Int
+
+    /**
+     * Compares value with [expected] and replaces it with [new] value if values matches.
+     * Returns the old value.
+     */
+    @SymbolName("Kotlin_AtomicInt_compareAndSwap")
+    external fun compareAndSwap(expected: Int, new: Int): Int
+
+    /**
+     * Increments value by one.
+     */
+    fun increment(): Int = addAndGet(1)
+
+    /**
+     * Decrements value by one.
+     */
+    fun decrement(): Int = addAndGet(-1)
+
+    /**
+     * Returns the current value.
+     */
+    fun get(): Int = value
+
+    /* Operations from Number. */
+
+    /**
+     * Returns the value of this number as a [Double], which may involve rounding.
+     */
+    public override fun toDouble(): Double = value.toDouble()
+
+    /**
+     * Returns the value of this number as a [Float], which may involve rounding.
+     */
+    public override fun toFloat(): Float = value.toFloat()
+
+    /**
+     * Returns the value of this number as a [Long], which may involve rounding or truncation.
+     */
+    public override fun toLong(): Long = value.toLong()
+
+    /**
+     * Returns the value of this number as an [Int], which may involve rounding or truncation.
+     */
+    public override fun toInt(): Int = value.toInt()
+
+    /**
+     * Returns the [Char] with the numeric value equal to this number, truncated to 16 bits if appropriate.
+     */
+    public override fun toChar(): Char = value.toChar()
+
+    /**
+     * Returns the value of this number as a [Short], which may involve rounding or truncation.
+     */
+    public override fun toShort(): Short = value.toShort()
+
+    /**
+     * Returns the value of this number as a [Byte], which may involve rounding or truncation.
+     */
+    public override fun toByte(): Byte = value.toByte()
+}
+
+@Frozen
+class AtomicLong(private var value: Long = 0) : Number() {
+    /* Atomic operations. */
+
+    /**
+     * Increments the value by [delta] and returns the new value.
+     */
+    @SymbolName("Kotlin_AtomicLong_addAndGet")
+    external fun addAndGet(delta: Long): Long
+
+    /**
+     * Increments the value by [delta] and returns the new value.
+     */
+    fun addAndGet(delta: Int): Long = addAndGet(delta.toLong())
+
+    /**
+     * Compares value with [expected] and replaces it with [new] value if values matches.
+     * Returns the old value.
+     */
+    @SymbolName("Kotlin_AtomicLong_compareAndSwap")
+    external fun compareAndSwap(expected: Long, new: Long): Long
+
+    /**
+     * Increments value by one.
+     */
+    fun increment(): Long = addAndGet(1L)
+
+    /**
+     * Decrements value by one.
+     */
+    fun decrement(): Long = addAndGet(-1L)
+
+    /**
+     * Returns the current value.
+     */
+    fun get(): Long = value
+
+    /* Operations from Number. */
+
+    /**
+     * Returns the value of this number as a [Double], which may involve rounding.
+     */
+    public override fun toDouble(): Double = value.toDouble()
+
+    /**
+     * Returns the value of this number as a [Float], which may involve rounding.
+     */
+    public override fun toFloat(): Float = value.toFloat()
+
+    /**
+     * Returns the value of this number as a [Long], which may involve rounding or truncation.
+     */
+    public override fun toLong(): Long = value.toLong()
+
+    /**
+     * Returns the value of this number as an [Int], which may involve rounding or truncation.
+     */
+    public override fun toInt(): Int = value.toInt()
+
+    /**
+     * Returns the [Char] with the numeric value equal to this number, truncated to 16 bits if appropriate.
+     */
+    public override fun toChar(): Char = value.toChar()
+
+    /**
+     * Returns the value of this number as a [Short], which may involve rounding or truncation.
+     */
+    public override fun toShort(): Short = value.toShort()
+
+    /**
+     * Returns the value of this number as a [Byte], which may involve rounding or truncation.
+     */
+    public override fun toByte(): Byte = value.toByte()
+}
+
+@Frozen
+class AtomicNativePtr(private var value: NativePtr) {
+    /**
+     * Compares value with [expected] and replaces it with [new] value if values matches.
+     * Returns the old value.
+     */
+    @SymbolName("Kotlin_AtomicNativePtr_compareAndSwap")
+    external fun compareAndSwap(expected: NativePtr, new: NativePtr): NativePtr
+
+    /**
+     * Returns the current value.
+     */
+    fun get(): NativePtr = value
+}
+
+@SymbolName("Kotlin_AtomicReference_checkIfFrozen")
+external private fun checkIfFrozen(ref: Any?)
+
+@Frozen
+class AtomicReference<T>(private var value: T? = null) {
+    /**
+     * Creates a new atomic reference pointing to given [ref]. If reference is not frozen,
+     * @InvalidMutabilityException is thrown.
+     */
+    init {
+        checkIfFrozen(value)
+    }
+
+    /**
+     * Compares value with [expected] and replaces it with [new] value if values matches.
+     * If [new] value is not null, it must be frozen or permanent object, otherwise an
+     * @InvalidMutabilityException is thrown.
+     * Returns the old value.
+     */
+    @SymbolName("Kotlin_AtomicReference_compareAndSwap")
+    external fun compareAndSwap(expected: T?, new: T?): T?
+
+    /**
+     * Returns the current value.
+     */
+    public fun get(): T? = value
+}

runtime/src/main/kotlin/kotlin/String.kt

@@ -17,7 +17,7 @@
 package kotlin
 
 @ExportTypeInfo("theStringTypeInfo")
-@konan.internal.Immutable
+@konan.internal.Frozen
 public final class String : Comparable<String>, CharSequence {
     public companion object {
     }