1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
// Need InlineOnly for efficient bytecode on Android
@file:Suppress("INVISIBLE_REFERENCE", "INVISIBLE_MEMBER")
package kotlinx.coroutines
import kotlinx.coroutines.internal.*
import java.util.concurrent.atomic.*
import kotlin.internal.InlineOnly
/**
* Name of the property that controls coroutine debugging.
*
* ### Debugging facilities
*
* In debug mode every coroutine is assigned a unique consecutive identifier.
* Every thread that executes a coroutine has its name modified to include the name and identifier of
* the currently running coroutine.
*
* Enable debugging facilities with "`kotlinx.coroutines.debug`" ([DEBUG_PROPERTY_NAME]) system property,
* use the following values:
*
* * "`auto`" (default mode, [DEBUG_PROPERTY_VALUE_AUTO]) -- enabled when assertions are enabled with "`-ea`" JVM option.
* * "`on`" ([DEBUG_PROPERTY_VALUE_ON]) or empty string -- enabled.
* * "`off`" ([DEBUG_PROPERTY_VALUE_OFF]) -- disabled.
*
* Coroutine name can be explicitly assigned using [CoroutineName] context element.
* The string "coroutine" is used as a default name.
*
* Debugging facilities are implemented by [newCoroutineContext][CoroutineScope.newCoroutineContext] function that
* is used in all coroutine builders to create context of a new coroutine.
*/
public const val DEBUG_PROPERTY_NAME: String = "kotlinx.coroutines.debug"
/**
* Name of the boolean property that controls stacktrace recovery (enabled by default) on JVM.
* Stacktrace recovery is enabled if both debug and stacktrace recovery modes are enabled.
*
* Stacktrace recovery mode wraps every exception into the exception of the same type with original exception
* as cause, but with stacktrace of the current coroutine.
* Exception is instantiated using reflection by using no-arg, cause or cause and message constructor.
*
* This mechanism is currently supported for channels, [async], [launch], [coroutineScope], [supervisorScope]
* and [withContext] builders.
*/
internal const val STACKTRACE_RECOVERY_PROPERTY_NAME = "kotlinx.coroutines.stacktrace.recovery"
/**
* Automatic debug configuration value for [DEBUG_PROPERTY_NAME].
*/
public const val DEBUG_PROPERTY_VALUE_AUTO: String = "auto"
/**
* Debug turned on value for [DEBUG_PROPERTY_NAME].
*/
public const val DEBUG_PROPERTY_VALUE_ON: String = "on"
/**
* Debug turned off value for [DEBUG_PROPERTY_NAME].
*/
public const val DEBUG_PROPERTY_VALUE_OFF: String = "off"
// @JvmField: Don't use JvmField here to enable R8 optimizations via "assumenosideeffects"
internal val ASSERTIONS_ENABLED = CoroutineId::class.java.desiredAssertionStatus()
// @JvmField: Don't use JvmField here to enable R8 optimizations via "assumenosideeffects"
internal actual val DEBUG = systemProp(DEBUG_PROPERTY_NAME).let { value ->
when (value) {
DEBUG_PROPERTY_VALUE_AUTO, null -> ASSERTIONS_ENABLED
DEBUG_PROPERTY_VALUE_ON, "" -> true
DEBUG_PROPERTY_VALUE_OFF -> false
else -> error("System property '$DEBUG_PROPERTY_NAME' has unrecognized value '$value'")
}
}
// Note: stack-trace recovery is enabled only in debug mode
// @JvmField: Don't use JvmField here to enable R8 optimizations via "assumenosideeffects"
@PublishedApi
internal actual val RECOVER_STACK_TRACES: Boolean =
DEBUG && systemProp(STACKTRACE_RECOVERY_PROPERTY_NAME, true)
// It is used only in debug mode
internal val COROUTINE_ID = AtomicLong(0)
// for tests only
internal fun resetCoroutineId() {
COROUTINE_ID.set(0)
}
@InlineOnly
internal actual inline fun assert(value: () -> Boolean) {
if (ASSERTIONS_ENABLED && !value()) throw AssertionError()
}
|
