Added comments about time budget

UnitTestBot · Nov 1, 2023 · 4043c90 · 4043c90
1 parent 3250b40
commit 4043c90
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/usvm-core/src/main/kotlin/org/usvm/solver/Solver.kt b/usvm-core/src/main/kotlin/org/usvm/solver/Solver.kt
@@ -33,6 +33,7 @@ open class USolverBase<Type>(
     protected val typeSolver: UTypeSolver<Type>,
     protected val translator: UExprTranslator<Type, *>,
     protected val decoder: UModelDecoder<UModelBase<Type>>,
+    // TODO this timeout must not exceed time budget for the MUT
     private val timeout: Duration
 ) : USolver<UPathConstraints<Type>, UModelBase<Type>>(), AutoCloseable {
 

diff --git a/usvm-core/src/main/kotlin/org/usvm/types/SupportTypeStream.kt b/usvm-core/src/main/kotlin/org/usvm/types/SupportTypeStream.kt
@@ -93,6 +93,7 @@ class USupportTypeStream<Type> private constructor(
 
     private fun nextType(iterator: Iterator<Type>): Type =
         runBlocking {
+            // This operation is potentially very long, so it's important to ensure it ends in reasonable time
             withTimeoutOrNull(typeSystem.typeOperationsTimeout) { iterator.next() }
         } ?: error("TODO return typed mock and info that the timeout was exceeded")
 

diff --git a/usvm-core/src/main/kotlin/org/usvm/types/TypeSystem.kt b/usvm-core/src/main/kotlin/org/usvm/types/TypeSystem.kt
@@ -10,6 +10,7 @@ interface UTypeSystem<Type> {
     /**
      * A timeout used for heavy operations with types.
      */
+    // TODO this timeout must not exceed time budget for the MUT
     val typeOperationsTimeout: Duration
 
     /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,6 +10,7 @@ interface UTypeSystem<Type> { @@
         /**
          * A timeout used for heavy operations with types.
          */
+        // TODO this timeout must not exceed time budget for the MUT
         val typeOperationsTimeout: Duration
         /**
@@ Expand Down @@