Merge branch 'context-elements-opto' into release-candidate

# Conflicts:
#	common/kotlinx-coroutines-core-common/src/Dispatched.kt

Author: qwwdfsad

benchmarks/src/jmh/kotlin/benchmarks/ChannelSinkBenchmark.kt

@@ -10,19 +10,39 @@ import org.openjdk.jmh.annotations.*
 import java.util.concurrent.*
 import kotlin.coroutines.*
 
-@Warmup(iterations = 10, time = 1)
-@Measurement(iterations = 10, time = 1)
+@Warmup(iterations = 5, time = 1)
+@Measurement(iterations = 5, time = 1)
 @BenchmarkMode(Mode.AverageTime)
 @OutputTimeUnit(TimeUnit.MILLISECONDS)
 @State(Scope.Benchmark)
-@Fork(2)
+@Fork(1)
 open class ChannelSinkBenchmark {
+    private val tl = ThreadLocal.withInitial({ 42 })
+    private val tl2 = ThreadLocal.withInitial({ 239 })
+
+    private val unconfined = Dispatchers.Unconfined
+    private val unconfinedOneElement = Dispatchers.Unconfined + tl.asContextElement()
+    private val unconfinedTwoElements = Dispatchers.Unconfined + tl.asContextElement() + tl2.asContextElement()
 
     @Benchmark
     fun channelPipeline(): Int = runBlocking {
-        Channel
-            .range(1, 1_000_000, Dispatchers.Unconfined)
-            .filter(Dispatchers.Unconfined) { it % 4 == 0 }
+        run(unconfined)
+    }
+
+    @Benchmark
+    fun channelPipelineOneThreadLocal(): Int = runBlocking {
+        run(unconfinedOneElement)
+    }
+
+    @Benchmark
+    fun channelPipelineTwoThreadLocals(): Int = runBlocking {
+        run(unconfinedTwoElements)
+    }
+
+    private suspend inline fun run(context: CoroutineContext): Int {
+        return Channel
+            .range(1, 1_000_000, context)
+            .filter(context) { it % 4 == 0 }
             .fold(0) { a, b -> a + b }
     }
 

common/kotlinx-coroutines-core-common/src/Builders.common.kt

@@ -138,7 +138,7 @@ public suspend fun <T> withContext(
     if (newContext[ContinuationInterceptor] == oldContext[ContinuationInterceptor]) {
         val coroutine = UndispatchedCoroutine(newContext, uCont) // MODE_UNDISPATCHED
         // There are changes in the context, so this thread needs to be updated
-        withCoroutineContext(newContext) {
+        withCoroutineContext(newContext, null) {
             return@sc coroutine.startUndispatchedOrReturn(coroutine, block)
         }
     }

common/kotlinx-coroutines-core-common/src/CoroutineContext.common.kt

@@ -17,6 +17,7 @@ internal expect fun createDefaultDispatcher(): CoroutineDispatcher
 @Suppress("PropertyName")
 internal expect val DefaultDelay: Delay
 
-internal expect inline fun <T> withCoroutineContext(context: CoroutineContext, block: () -> T): T
+// countOrElement -- pre-cached value for ThreadContext.kt
+internal expect inline fun <T> withCoroutineContext(context: CoroutineContext, countOrElement: Any?, block: () -> T): T
 internal expect fun Continuation<*>.toDebugString(): String
 internal expect val CoroutineContext.coroutineName: String?

common/kotlinx-coroutines-core-common/src/Dispatched.kt

@@ -72,6 +72,8 @@ internal class DispatchedContinuation<in T>(
     @Suppress("PropertyName")
     internal var _state: Any? = UNDEFINED
     public override var resumeMode: Int = 0
+    @JvmField // pre-cached value to avoid ctx.fold on every resumption
+    internal val countOrElement = threadContextElements(context)
 
     override fun takeState(): Any? {
         val state = _state
@@ -92,7 +94,7 @@ internal class DispatchedContinuation<in T>(
             dispatcher.dispatch(context, this)
         } else {
             UndispatchedEventLoop.execute(this, state, MODE_ATOMIC_DEFAULT) {
-                withCoroutineContext(this.context) {
+                withCoroutineContext(this.context, countOrElement) {
                     continuation.resumeWith(result)
                 }
             }
@@ -144,14 +146,14 @@ internal class DispatchedContinuation<in T>(
 
     @Suppress("NOTHING_TO_INLINE") // we need it inline to save us an entry on the stack
     inline fun resumeUndispatched(value: T) {
-        withCoroutineContext(context) {
+        withCoroutineContext(context, countOrElement) {
             continuation.resume(value)
         }
     }
 
     @Suppress("NOTHING_TO_INLINE") // we need it inline to save us an entry on the stack
     inline fun resumeUndispatchedWithException(exception: Throwable) {
-        withCoroutineContext(context) {
+        withCoroutineContext(context, countOrElement) {
             continuation.resumeWithException(exception)
         }
     }
@@ -208,7 +210,7 @@ internal interface DispatchedTask<in T> : Runnable {
             val context = continuation.context
             val job = if (resumeMode.isCancellableMode) context[Job] else null
             val state = takeState() // NOTE: Must take state in any case, even if cancelled
-            withCoroutineContext(context) {
+            withCoroutineContext(context, delegate.countOrElement) {
                 if (job != null && !job.isActive)
                     continuation.resumeWithException(job.getCancellationException())
                 else {

common/kotlinx-coroutines-core-common/src/ResumeMode.kt

@@ -43,7 +43,7 @@ internal fun <T> Continuation<T>.resumeUninterceptedMode(value: T, mode: Int) {
         MODE_ATOMIC_DEFAULT -> intercepted().resume(value)
         MODE_CANCELLABLE -> intercepted().resumeCancellable(value)
         MODE_DIRECT -> resume(value)
-        MODE_UNDISPATCHED -> withCoroutineContext(context) { resume(value) }
+        MODE_UNDISPATCHED -> withCoroutineContext(context, null) { resume(value) }
         MODE_IGNORE -> {}
         else -> error("Invalid mode $mode")
     }
@@ -54,7 +54,7 @@ internal fun <T> Continuation<T>.resumeUninterceptedWithExceptionMode(exception:
         MODE_ATOMIC_DEFAULT -> intercepted().resumeWithException(exception)
         MODE_CANCELLABLE -> intercepted().resumeCancellableWithException(exception)
         MODE_DIRECT -> resumeWithException(exception)
-        MODE_UNDISPATCHED -> withCoroutineContext(context) { resumeWithException(exception) }
+        MODE_UNDISPATCHED -> withCoroutineContext(context, null) { resumeWithException(exception) }
         MODE_IGNORE -> {}
         else -> error("Invalid mode $mode")
     }

common/kotlinx-coroutines-core-common/src/internal/ThreadContext.common.kt

@@ -0,0 +1,9 @@
+/*
+ * Copyright 2016-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package kotlinx.coroutines.internal
+
+import kotlin.coroutines.*
+
+internal expect fun threadContextElements(context: CoroutineContext): Any

common/kotlinx-coroutines-core-common/src/intrinsics/Undispatched.kt

@@ -37,7 +37,7 @@ internal fun <R, T> (suspend (R) -> T).startCoroutineUnintercepted(receiver: R,
  */
 internal fun <T> (suspend () -> T).startCoroutineUndispatched(completion: Continuation<T>) {
     startDirect(completion) {
-        withCoroutineContext(completion.context) {
+        withCoroutineContext(completion.context, null) {
             startCoroutineUninterceptedOrReturn(completion)
         }
     }
@@ -50,7 +50,7 @@ internal fun <T> (suspend () -> T).startCoroutineUndispatched(completion: Contin
  */
 internal fun <R, T> (suspend (R) -> T).startCoroutineUndispatched(receiver: R, completion: Continuation<T>) {
     startDirect(completion) {
-        withCoroutineContext(completion.context) {
+        withCoroutineContext(completion.context, null) {
             startCoroutineUninterceptedOrReturn(receiver, completion)
         }
     }

core/kotlinx-coroutines-core/src/CoroutineContext.kt

@@ -63,8 +63,8 @@ public actual fun CoroutineScope.newCoroutineContext(context: CoroutineContext):
 /**
  * Executes a block using a given coroutine context.
  */
-internal actual inline fun <T> withCoroutineContext(context: CoroutineContext, block: () -> T): T {
-    val oldValue = updateThreadContext(context)
+internal actual inline fun <T> withCoroutineContext(context: CoroutineContext, countOrElement: Any?, block: () -> T): T {
+    val oldValue = updateThreadContext(context, countOrElement)
     try {
         return block()
     } finally {

core/kotlinx-coroutines-core/src/internal/ThreadContext.kt

@@ -57,20 +57,24 @@ private val restoreState =
         return state
     }
 
-internal fun updateThreadContext(context: CoroutineContext): Any? {
-    val count = context.fold(0, countAll)
+internal actual fun threadContextElements(context: CoroutineContext): Any = context.fold(0, countAll)!!
+
+// countOrElement is pre-cached in dispatched continuation
+internal fun updateThreadContext(context: CoroutineContext, countOrElement: Any?): Any? {
+    @Suppress("NAME_SHADOWING")
+    val countOrElement = countOrElement ?: threadContextElements(context)
     @Suppress("IMPLICIT_BOXING_IN_IDENTITY_EQUALS")
     return when {
-        count === 0 -> ZERO // very fast path when there are no active ThreadContextElements
+        countOrElement === 0 -> ZERO // very fast path when there are no active ThreadContextElements
         //    ^^^ identity comparison for speed, we know zero always has the same identity
-        count is Int -> {
+        countOrElement is Int -> {
             // slow path for multiple active ThreadContextElements, allocates ThreadState for multiple old values
-            context.fold(ThreadState(context, count), updateState)
+            context.fold(ThreadState(context, countOrElement), updateState)
         }
         else -> {
             // fast path for one ThreadContextElement (no allocations, no additional context scan)
             @Suppress("UNCHECKED_CAST")
-            val element = count as ThreadContextElement<Any?>
+            val element = countOrElement as ThreadContextElement<Any?>
             element.updateThreadContext(context)
         }
     }

js/kotlinx-coroutines-core-js/src/CoroutineContext.kt

@@ -34,6 +34,6 @@ public actual fun CoroutineScope.newCoroutineContext(context: CoroutineContext):
 }
 
 // No debugging facilities on JS
-internal actual inline fun <T> withCoroutineContext(context: CoroutineContext, block: () -> T): T = block()
+internal actual inline fun <T> withCoroutineContext(context: CoroutineContext, countOrElement: Any?, block: () -> T): T = block()
 internal actual fun Continuation<*>.toDebugString(): String = toString()
 internal actual val CoroutineContext.coroutineName: String? get() = null // not supported on JS