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

generic stack trace overriding mechanism #12922

Merged
merged 3 commits into from
Dec 29, 2019
Merged

generic stack trace overriding mechanism #12922

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8d74a8
libbacktrace support
stefantalpalaru Dec 18, 2019
39ab691
switch to a generic stack trace overriding mechanism
stefantalpalaru Dec 18, 2019
69f22a6
make the StackTraceOverrideProc {.noinline.}
stefantalpalaru Dec 21, 2019
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
43 changes: 33 additions & 10 deletions lib/system/excpt.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,23 @@ proc closureIterSetupExc(e: ref Exception) {.compilerproc, inline.} =
const
nativeStackTraceSupported* = (defined(macosx) or defined(linux)) and
not NimStackTrace
hasSomeStackTrace = NimStackTrace or
defined(nativeStackTrace) and nativeStackTraceSupported
hasSomeStackTrace = NimStackTrace or defined(nimStackTraceOverride) or
(defined(nativeStackTrace) and nativeStackTraceSupported)

when defined(nimStackTraceOverride):
type StackTraceOverrideProc* = proc (): string {.nimcall, noinline, benign, raises: [], tags: [].}
## Procedure type for overriding the default stack trace.

var stackTraceOverrideGetTraceback: StackTraceOverrideProc = proc(): string {.noinline.} =
result = "Stack trace override procedure not registered.\n"

proc registerStackTraceOverride*(overrideProc: StackTraceOverrideProc) =
## Override the default stack trace inside rawWriteStackTrace() with your
## own procedure.
stackTraceOverrideGetTraceback = overrideProc

proc auxWriteStackTraceWithOverride(s: var string) =
add(s, stackTraceOverrideGetTraceback())

when defined(nativeStacktrace) and nativeStackTraceSupported:
type
Expand Down Expand Up @@ -289,7 +304,10 @@ proc stackTraceAvailable*(): bool

when hasSomeStackTrace:
proc rawWriteStackTrace(s: var string) =
when NimStackTrace:
when defined(nimStackTraceOverride):
add(s, "Traceback (most recent call last, using override)\n")
auxWriteStackTraceWithOverride(s)
elif NimStackTrace:
if framePtr == nil:
add(s, "No stack traceback available\n")
else:
Expand All @@ -308,7 +326,9 @@ when hasSomeStackTrace:
s = @[]

proc stackTraceAvailable(): bool =
when NimStackTrace:
when defined(nimStackTraceOverride):
result = true
elif NimStackTrace:
if framePtr == nil:
result = false
else:
Expand Down Expand Up @@ -443,12 +463,15 @@ proc raiseExceptionEx(e: sink(ref Exception), ename, procname, filename: cstring
line: int) {.compilerRtl, nodestroy.} =
if e.name.isNil: e.name = ename
when hasSomeStackTrace:
if e.trace.len == 0:
rawWriteStackTrace(e.trace)
elif framePtr != nil:
e.trace.add reraisedFrom(reraisedFromBegin)
auxWriteStackTrace(framePtr, e.trace)
e.trace.add reraisedFrom(reraisedFromEnd)
when defined(nimStackTraceOverride):
e.trace = @[]
Araq marked this conversation as resolved.
Show resolved Hide resolved
elif NimStackTrace:
if e.trace.len == 0:
rawWriteStackTrace(e.trace)
elif framePtr != nil:
e.trace.add reraisedFrom(reraisedFromBegin)
auxWriteStackTrace(framePtr, e.trace)
e.trace.add reraisedFrom(reraisedFromEnd)
else:
if procname != nil and filename != nil:
e.trace.add StackTraceEntry(procname: procname, filename: filename, line: line)
Expand Down