Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / kotlinx.coroutines / ab30d7241ac02a3521e143a16d49a4bc9a230bf5
commitab30d7241ac02a3521e143a16d49a4bc9a230bf5[log] [tgz]
authorVsevolod Tolstopyatov <qwwdfsad@gmail.com>Thu Oct 17 16:02:36 2019 +0300
committerVsevolod Tolstopyatov <qwwdfsad@gmail.com>Thu Dec 12 14:03:20 2019 +0300
treeb053ff25c0511445ce4ad40b12674ab2081f6f3c
parent4236c8c5b0b6296bd3bdde7a5dccd77ff48bdf24 [diff]
New deterministic algorithm for working with blocking tasks

Invariants:

    * Steal only one task per attempt to avoid missing steals that potentially may block the progress (check-park-check may miss tasks that are being stolen)
    * New WorkQueue.add invariant: bufferSize < capacity => add is always successful
    * Re-visited tests that expose a lot of problems
    * Ability to steal from the middle of work queue in order to steal blocking tasks with ABA prevention

Changes:

    * Instead of "blocking workers" use "blocking tasks" state that is incremented on each blocking submit and decrement only when task is completed
    * On each work signalling try to compensate blocking tasks by enforcinf invariant "created threads == blocking tasks + up to core size workers"
    * Now if worker was not spuriously woken up, it has a task dedicated for him that should be found. For that reason attempt to steal blocking tasks
      (that may be in the middle of the work queue). Additionally, instead of scanning the whole global queue, just split it in two (one for blocking, one for regular tasks)
    * Get rid of conditional remove from the global queue
    * Avoid excessive unparks for threads that are not yet able to steal the task due to workstealing resolution: do not add such workers to the stack
17 files changed
tree: b053ff25c0511445ce4ad40b12674ab2081f6f3c
  1. benchmarks/
  2. binary-compatibility-validator/
  3. docs/
  4. gradle/
  5. integration/
  6. js/
  7. knit/
  8. kotlinx-coroutines-bom/
  9. kotlinx-coroutines-core/
  10. kotlinx-coroutines-debug/
  11. kotlinx-coroutines-test/
  12. license/
  13. publication-validator/
  14. reactive/
  15. site/
  16. stdlib-stubs/
  17. ui/
  18. .gitignore
  19. build.gradle
  20. bump-version.sh
  21. CHANGES.md
  22. CODE_OF_CONDUCT.md
  23. coroutines-guide.md
  24. gradle.properties
  25. gradlew
  26. gradlew.bat
  27. LICENSE.txt
  28. README.md
  29. RELEASE.md
  30. settings.gradle
README.md

kotlinx.coroutines

official JetBrains project GitHub license Download

Library support for Kotlin coroutines with multiplatform support. This is a companion version for Kotlin 1.3.60 release.

suspend fun main() = coroutineScope {
    launch { 
       delay(1000)
       println("Kotlin Coroutines World!") 
    }
    println("Hello")
}

Play with coroutines online here

Modules

Documentation

Using in your projects

The libraries are published to kotlinx bintray repository, linked to JCenter and pushed to Maven Central.

Maven

Add dependencies (you can also add other modules that you need):

<dependency>
    <groupId>org.jetbrains.kotlinx</groupId>
    <artifactId>kotlinx-coroutines-core</artifactId>
    <version>1.3.2</version>
</dependency>

And make sure that you use the latest Kotlin version:

<properties>
    <kotlin.version>1.3.60</kotlin.version>
</properties>

Gradle

Add dependencies (you can also add other modules that you need):

dependencies {
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.2'
}

And make sure that you use the latest Kotlin version:

buildscript {
    ext.kotlin_version = '1.3.60'
}

Make sure that you have either jcenter() or mavenCentral() in the list of repositories:

repository {
    jcenter()
}

Gradle Kotlin DSL

Add dependencies (you can also add other modules that you need):

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.2")
}

And make sure that you use the latest Kotlin version:

plugins {
    kotlin("jvm") version "1.3.60"
}

Make sure that you have either jcenter() or mavenCentral() in the list of repositories.

Multiplatform

Core modules of kotlinx.coroutines are also available for Kotlin/JS and Kotlin/Native. In common code that should get compiled for different platforms, add dependency to
kotlinx-coroutines-core-common
(follow the link to get the dependency declaration snippet).

Android

Add kotlinx-coroutines-android module as dependency when using kotlinx.coroutines on Android:

implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.2'

This gives you access to Android Dispatchers.Main coroutine dispatcher and also makes sure that in case of crashed coroutine with unhandled exception this exception is logged before crashing Android application, similarly to the way uncaught exceptions in threads are handled by Android runtime.

R8 and ProGuard

For R8 no actions required, it will take obfuscation rules from the jar.

For Proguard you need to add options from coroutines.pro to your rules manually.

R8 is a replacement for ProGuard in Android ecosystem, it is enabled by default since Android gradle plugin 3.4.0 (3.3.0-beta also had it enabled).

JS

Kotlin/JS version of kotlinx.coroutines is published as kotlinx-coroutines-core-js (follow the link to get the dependency declaration snippet).

You can also use kotlinx-coroutines-core package via NPM.

Native

Kotlin/Native version of kotlinx.coroutines is published as kotlinx-coroutines-core-native (follow the link to get the dependency declaration snippet).

Only single-threaded code (JS-style) on Kotlin/Native is currently supported. Kotlin/Native supports only Gradle version 4.10 and you need to enable Gradle metadata in your settings.gradle file:

enableFeaturePreview('GRADLE_METADATA')

Since Kotlin/Native does not generally provide binary compatibility between versions, you should use the same version of Kotlin/Native compiler as was used to build kotlinx.coroutines.

Building

This library is built with Gradle. To build it, use ./gradlew build. You can import this project into IDEA, but you have to delegate build actions to Gradle (in Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle -> Runner)

Requirements

  • JDK >= 1.8 referred to by the JAVA_HOME environment variable.
  • JDK 1.6 referred to by the JDK_16 environment variable. It is okay to have JDK_16 pointing to JAVA_HOME for external contributions.

Contributions and releases

All development (both new features and bug fixes) is performed in develop branch. This way master sources always contain sources of the most recently released version. Please send PRs with bug fixes to develop branch. Fixes to documentation in markdown files are an exception to this rule. They are updated directly in master.

The develop branch is pushed to master during release.

  • Full release procedure checklist is here.
  • Steps for contributing new integration modules are explained here.