Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

KTOR-7729 Add logging for tracking concurrent access in the dev mode #4477

Merged
merged 2 commits into from
Nov 14, 2024
Merged

KTOR-7729 Add logging for tracking concurrent access in the dev mode #4477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ff7cca
KTOR-7729 Add logging for tracking concurrent access in the dev mode
e5l Nov 13, 2024
d31d27a
fixup! KTOR-7729 Add logging for tracking concurrent access in the de…
e5l Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ktor-io/api/ktor-io.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,8 @@ public abstract interface class io/ktor/utils/io/ChannelJob {
}

public final class io/ktor/utils/io/ConcurrentIOException : java/lang/IllegalStateException {
public fun <init> (Ljava/lang/String;)V
public fun <init> (Ljava/lang/String;Ljava/lang/Throwable;)V
public synthetic fun <init> (Ljava/lang/String;Ljava/lang/Throwable;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
}

public final class io/ktor/utils/io/CountedByteReadChannel : io/ktor/utils/io/ByteReadChannel {
Expand Down
2 changes: 1 addition & 1 deletion ktor-io/api/ktor-io.klib.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ final class io.ktor.utils.io/ByteChannel : io.ktor.utils.io/BufferedByteWriteCha
}

final class io.ktor.utils.io/ConcurrentIOException : kotlin/IllegalStateException { // io.ktor.utils.io/ConcurrentIOException|null[0]
constructor <init>(kotlin/String) // io.ktor.utils.io/ConcurrentIOException.<init>|<init>(kotlin.String){}[0]
constructor <init>(kotlin/String, kotlin/Throwable? = ...) // io.ktor.utils.io/ConcurrentIOException.<init>|<init>(kotlin.String;kotlin.Throwable?){}[0]
}

final class io.ktor.utils.io/CountedByteReadChannel : io.ktor.utils.io/ByteReadChannel { // io.ktor.utils.io/CountedByteReadChannel|null[0]
Expand Down
34 changes: 32 additions & 2 deletions ktor-io/common/src/io/ktor/utils/io/ByteChannel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import kotlin.concurrent.Volatile
import kotlin.coroutines.*
import kotlin.jvm.*

internal expect val DEVELOPMENT_MODE: Boolean
internal const val CHANNEL_MAX_SIZE: Int = 1024 * 1024

/**
Expand Down Expand Up @@ -189,13 +190,16 @@ public class ByteChannel(public val autoFlush: Boolean = false) : ByteReadChanne
// Resume the previous task
when (previous) {
is TaskType ->
previous.resume(ConcurrentIOException(slot.taskName()))
previous.resume(ConcurrentIOException(slot.taskName(), previous.created))

is Slot.Task ->
previous.resume()

is Slot.Closed -> {
slot.resume(previous.cause)
return
}

Slot.Empty -> {}
}

Expand All @@ -219,6 +223,8 @@ public class ByteChannel(public val autoFlush: Boolean = false) : ByteReadChanne
data class Closed(val cause: Throwable?) : Slot

sealed interface Task : Slot {
val created: Throwable?

val continuation: Continuation<Unit>

fun taskName(): String
Expand All @@ -231,10 +237,30 @@ public class ByteChannel(public val autoFlush: Boolean = false) : ByteReadChanne
}

class Read(override val continuation: Continuation<Unit>) : Task {
override var created: Throwable? = null

init {
if (DEVELOPMENT_MODE) {
created = Throwable("ReadTask 0x${continuation.hashCode().toString(16)}").also {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'd be nice if we appended some diagnostic info from the coroutine context here too, since sometimes the stacktraces can be hard to follow as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't have it in the init block, let me check what we can do

it.stackTraceToString()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this also { it.stackTraceToString() } doing anything here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, by default the stacktrace is not filled

}
}
}

override fun taskName(): String = "read"
}

class Write(override val continuation: Continuation<Unit>) : Task {
override var created: Throwable? = null

init {
if (DEVELOPMENT_MODE) {
created = Throwable("WriteTask 0x${continuation.hashCode().toString(16)}").also {
it.stackTraceToString()
}
}
}

override fun taskName(): String = "write"
}
}
Expand All @@ -243,4 +269,8 @@ public class ByteChannel(public val autoFlush: Boolean = false) : ByteReadChanne
/**
* Thrown when a coroutine awaiting I/O is replaced by another.
*/
public class ConcurrentIOException(taskName: String) : IllegalStateException("Concurrent $taskName attempts")
public class ConcurrentIOException(
taskName: String,
cause: Throwable? = null
) : IllegalStateException("Concurrent $taskName attempts", cause) {
Comment on lines +272 to +275
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we provide a @Deprecated(HIDDEN) constructor with an old signature for binary compatibility purpose?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, let me add

}
10 changes: 10 additions & 0 deletions ktor-io/jvm/src/io/ktor/utils/io/ByteChannel.jvm.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/*
* Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
*/

package io.ktor.utils.io

private const val DEVELOPMENT_MODE_KEY: String = "io.ktor.development"

internal actual val DEVELOPMENT_MODE: Boolean
get() = System.getProperty(DEVELOPMENT_MODE_KEY)?.toBoolean() == true
8 changes: 8 additions & 0 deletions ktor-io/posix/src/io/ktor/utils/io/ByteChannel.posix.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/*
* Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
*/

package io.ktor.utils.io

internal actual val DEVELOPMENT_MODE: Boolean
get() = false
8 changes: 8 additions & 0 deletions ktor-io/src/jsAndWasmSharedMain/kotlin/io/ktor/utils/io/ByteChannel.jsAndWasmShared.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/*
* Copyright 2014-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
*/

package io.ktor.utils.io

internal actual val DEVELOPMENT_MODE: Boolean
get() = false