nim-chronos/chronos/debugutils.nim

76 lines
2.4 KiB
Nim

#
# Chronos Debugging Utilities
#
# (c) Copyright 2020-Present Status Research & Development GmbH
#
# Licensed under either of
# Apache License, version 2.0, (LICENSE-APACHEv2)
# MIT license (LICENSE-MIT)
when (NimMajor, NimMinor) < (1, 4):
{.push raises: [Defect].}
else:
{.push raises: [].}
import "."/[asyncloop, config]
export asyncloop
when chronosFutureTracking:
import stew/base10
const
AllFutureStates* = {FutureState.Pending, FutureState.Cancelled,
FutureState.Completed, FutureState.Failed}
WithoutCompleted* = {FutureState.Pending, FutureState.Cancelled,
FutureState.Failed}
OnlyPending* = {FutureState.Pending}
OnlyCompleted* = {FutureState.Completed}
proc dumpPendingFutures*(filter = AllFutureStates): string =
## Dump all `pending` Future[T] objects.
##
## This list will contain:
## 1. Future[T] objects with ``FutureState.Pending`` state (this Futures are
## not yet finished).
## 2. Future[T] objects with ``FutureState.Finished/Cancelled/Failed`` state
## which callbacks are scheduled, but not yet fully processed.
when chronosFutureTracking:
var count = 0'u
var res = ""
for item in pendingFutures():
if item.state in filter:
inc(count)
let loc = item.location[LocCreateIndex][]
let procedure = $loc.procedure
let filename = $loc.file
let procname = if len(procedure) == 0:
"\"unspecified\""
else:
"\"" & procedure & "\""
let item = "Future[" & Base10.toString(item.id) & "] with name " &
$procname & " created at " & "<" & filename & ":" &
Base10.toString(uint(loc.line)) & ">" &
" and state = " & $item.state & "\n"
res.add(item)
Base10.toString(count) & " pending Future[T] objects found:\n" & $res
else:
"0 pending Future[T] objects found\n"
proc pendingFuturesCount*(filter: set[FutureState]): uint =
## Returns number of `pending` Future[T] objects which satisfy the ``filter``
## condition.
##
## If ``filter`` is equal to ``AllFutureStates`` Operation's complexity is
## O(1), otherwise operation's complexity is O(n).
when chronosFutureTracking:
if filter == AllFutureStates:
pendingFuturesCount()
else:
var res = 0'u
for item in pendingFutures():
if item.state in filter:
inc(res)
res
else:
0'u