Do not filter Lincheck events when printing a thread dump if the thre…

…ad has hung in the Lincheck internals.
JetBrains · Feb 6, 2024 · 0887da4 · 0887da4
1 parent 2d0ab4b
commit 0887da4
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 11 deletions.
diff --git a/src/jvm/main/org/jetbrains/kotlinx/lincheck/Reporter.kt b/src/jvm/main/org/jetbrains/kotlinx/lincheck/Reporter.kt
@@ -582,17 +582,24 @@ private fun StringBuilder.appendDeadlockWithDumpFailure(failure: DeadlockWithDum
                     /* fileName = */ it.fileName,
                     /* lineNumber = */ it.lineNumber
                 )
-            }.map { it.toString() }
-                .filter { stackTraceElementLine -> // Remove all stack trace elements related to lincheck
-                    "org.jetbrains.kotlinx.lincheck.strategy" !in stackTraceElementLine
-                            && "org.jetbrains.kotlinx.lincheck.runner" !in stackTraceElementLine
-                            && "org.jetbrains.kotlinx.lincheck.UtilsKt" !in stackTraceElementLine
-                }.forEach { appendLine("\t$it") }
+            }.run {
+                // Remove all the Lincheck internals only if the program
+                // has hung in the user code. Otherwise, print the full
+                // stack trace for easier debugging.
+                if (isEmpty() || first().isLincheckInternals) {
+                    this
+                } else {
+                    filter { !it.isLincheckInternals }
+                }
+            }.forEach { appendLine("\t$it") }
         }
     }
     return this
 }
 
+private val StackTraceElement.isLincheckInternals get() =
+    this.className.startsWith("org.jetbrains.kotlinx.lincheck.")
+
 private fun StringBuilder.appendIncorrectResultsFailure(
     failure: IncorrectResultsFailure,
     exceptionStackTraces: Map<Throwable, ExceptionNumberAndStacktrace>,

diff --git a/src/jvm/main/org/jetbrains/kotlinx/lincheck/runner/FixedActiveThreadsExecutor.kt b/src/jvm/main/org/jetbrains/kotlinx/lincheck/runner/FixedActiveThreadsExecutor.kt
@@ -85,7 +85,7 @@ internal class FixedActiveThreadsExecutor(private val nThreads: Int, runnerHash:
     private fun shutdown() {
         // submit the shutdown tasks
         for (i in 0 until nThreads)
-            submitTask(i, SHUTDOWN)
+            submitTask(i, Shutdown)
     }
 
     private fun submitTask(iThread: Int, task: Any) {
@@ -143,7 +143,7 @@ internal class FixedActiveThreadsExecutor(private val nThreads: Int, runnerHash:
     private fun testThreadRunnable(iThread: Int) = Runnable {
         loop@ while (true) {
             val task = getTask(iThread)
-            if (task === SHUTDOWN) return@Runnable
+            if (task === Shutdown) return@Runnable
             tasks[iThread].value = null // reset task
             val threadExecution = task as TestThreadExecution
             check(threadExecution.iThread == iThread)
@@ -154,7 +154,7 @@ internal class FixedActiveThreadsExecutor(private val nThreads: Int, runnerHash:
                 setResult(iThread, wrapped)
                 continue@loop
             }
-            setResult(iThread, DONE)
+            setResult(iThread, Done)
         }
     }
 
@@ -215,5 +215,6 @@ internal class FixedActiveThreadsExecutor(private val nThreads: Int, runnerHash:
 
 private const val SPINNING_LOOP_ITERATIONS_BEFORE_PARK = 1000_000
 
-private val SHUTDOWN = "SHUTDOWN"
-private val DONE = "DONE"
+// These constants are objects for easier debugging.
+private object Shutdown
+private object Done