2021-09-15 13:55:15 +00:00
|
|
|
#
|
|
|
|
|
# Chronos source location utilities
|
|
|
|
|
# (c) Copyright 2018-Present
|
|
|
|
|
# Status Research & Development GmbH
|
|
|
|
|
#
|
|
|
|
|
# Licensed under either of
|
|
|
|
|
# Apache License, version 2.0, (LICENSE-APACHEv2)
|
|
|
|
|
# MIT license (LICENSE-MIT)
|
2023-06-05 20:21:50 +00:00
|
|
|
|
|
|
|
|
{.push raises: [].}
|
|
|
|
|
|
2021-09-15 13:55:15 +00:00
|
|
|
import stew/base10
|
exception tracking (#166)
* exception tracking
This PR adds minimal exception tracking to chronos, moving the goalpost
one step further.
In particular, it becomes invalid to raise exceptions from `callSoon`
callbacks: this is critical for writing correct error handling because
there's no reasonable way that a user of chronos can possibly _reason_
about exceptions coming out of there: the event loop will be in an
indeterminite state when the loop is executing an _random_ callback.
As expected, there are several issues in the error handling of chronos:
in particular, it will end up in an inconsistent internal state whenever
the selector loop operations fail, because the internal state update
functions are not written in an exception-safe way. This PR turns this
into a Defect, which probably is not the optimal way of handling things
- expect more work to be done here.
Some API have no way of reporting back errors to callers - for example,
when something fails in the accept loop, there's not much it can do, and
no way to report it back to the user of the API - this has been fixed
with the new accept flow - the old one should be deprecated.
Finally, there is information loss in the API: in composite operations
like `poll` and `waitFor` there's no way to differentiate internal
errors from user-level errors originating from callbacks.
* store `CatchableError` in future
* annotate proc's with correct raises information
* `selectors2` to avoid non-CatchableError IOSelectorsException
* `$` should never raise
* remove unnecessary gcsafe annotations
* fix exceptions leaking out of timer waits
* fix some imports
* functions must signal raising the union of all exceptions across all
platforms to enable cross-platform code
* switch to unittest2
* add `selectors2` which supercedes the std library version and fixes
several exception handling issues in there
* fixes
* docs, platform-independent eh specifiers for some functions
* add feature flag for strict exception mode
also bump version to 3.0.0 - _most_ existing code should be compatible
with this version of exception handling but some things might need
fixing - callbacks, existing raises specifications etc.
* fix AsyncCheck for non-void T
2021-03-24 09:08:33 +00:00
|
|
|
|
2019-04-08 00:59:49 +00:00
|
|
|
type
|
|
|
|
|
SrcLoc* = object
|
2019-04-08 13:46:22 +00:00
|
|
|
procedure*: cstring
|
2019-04-08 00:59:49 +00:00
|
|
|
file*: cstring
|
|
|
|
|
line*: int
|
|
|
|
|
|
|
|
|
|
proc `$`*(loc: ptr SrcLoc): string =
|
2021-09-15 13:55:15 +00:00
|
|
|
var res = $loc.file
|
|
|
|
|
res.add("(")
|
|
|
|
|
res.add(Base10.toString(uint64(loc.line)))
|
|
|
|
|
res.add(")")
|
|
|
|
|
res.add(" ")
|
2019-04-08 13:46:22 +00:00
|
|
|
if len(loc.procedure) == 0:
|
2021-09-15 13:55:15 +00:00
|
|
|
res.add("[unspecified]")
|
2019-04-08 13:46:22 +00:00
|
|
|
else:
|
2021-09-15 13:55:15 +00:00
|
|
|
res.add($loc.procedure)
|
|
|
|
|
res
|
2019-04-08 00:59:49 +00:00
|
|
|
|
2019-04-08 13:46:22 +00:00
|
|
|
proc srcLocImpl(procedure: static string,
|
|
|
|
|
file: static string, line: static int): ptr SrcLoc =
|
|
|
|
|
var loc {.global.} = SrcLoc(
|
|
|
|
|
file: cstring(file), line: line, procedure: procedure
|
|
|
|
|
)
|
2019-04-08 00:59:49 +00:00
|
|
|
return addr(loc)
|
|
|
|
|
|
2019-04-08 13:46:22 +00:00
|
|
|
template getSrcLocation*(procedure: static string = ""): ptr SrcLoc =
|
|
|
|
|
srcLocImpl(procedure,
|
|
|
|
|
instantiationInfo(-2).filename, instantiationInfo(-2).line)
|
