gdb 调试提示
这个对象会在 julia
会话中展示,而不是在 gdb 会话中。这是一种行之有效的方式来发现由 Julia 的 C 代码操控的对象的类型和值。
同样,如果你在调试一些 Julia 内部的东西 (比如 compiler.jl
),你可以通过使用这些来打印 obj
:
ccall(:jl_, Cvoid, (Any,), obj)
这是一种很好的方法,可以避免 Julia 的输出流初始化顺序引起的问题。
Julia的 flisp 解释器使用 value_t
对象;能够通过 call fl_print(fl_ctx, ios_stdout, obj)
来展示。
有用的用于检查的 Julia 变量
While the addresses of many variables, like singletons, can be useful to print for many failures, there are a number of additional variables (see julia.h
for a complete list) that are even more useful.
- (when in
jl_apply_generic
)mfunc
andjl_uncompress_ast(mfunc->def, mfunc->code)
:: for figuring out a bit about the call-stack jl_lineno
andjl_filename
:: for figuring out what line in a test to go start debugging from (or figure out how far into a file has been parsed)$1
:: not really a variable, but still a useful shorthand for referring to the result of the last gdb command (such asprint
)jl_uv_stderr
:: because who doesn’t like to be able to interact with stdio
Useful Julia functions for Inspecting those variables
jl_gdblookup($rip)
:: For looking up the current function and line. (use$eip
on i686 platforms)jlbacktrace()
:: For dumping the current Julia backtrace stack to stderr. Only usable afterrecord_backtrace()
has been called.jl_dump_llvm_value(Value*)
:: For invokingValue->dump()
in gdb, where it doesn’t work natively. For example,f->linfo->functionObject
,f->linfo->specFunctionObject
, andto_function(f->linfo)
.Type->dump()
:: only works in lldb. Note: add something like;1
to prevent lldb from printing its prompt over the outputjl_eval_string("expr")
:: for invoking side-effects to modify the current state or to lookup symbolsjl_typeof(jl_value_t*)
:: for extracting the type tag of a Julia value (in gdb, callmacro define jl_typeof jl_typeof
first, or pick something short likety
for the first arg to define a shorthand)
In your gdb
session, set a breakpoint in like so:
(gdb) break jl_breakpoint
Then within your Julia code, insert a call to jl_breakpoint
by adding
ccall(:jl_breakpoint, Cvoid, (Any,), obj)
where obj
can be any variable or tuple you want to be accessible in the breakpoint.
It’s particularly helpful to back up to the jl_apply
frame, from which you can display the arguments to a function using, e.g.,
(gdb) call jl_(args[0])
#2 0x00007ffff7928bf7 in to_function (li=0x2812060, cstyle=false) at codegen.cpp:584
584 abort();
(gdb) p jl_(jl_uncompress_ast(li, li->ast))
Inserting breakpoints upon certain conditions
Let’s say the file is sysimg.jl
:
(gdb) break jl_apply_generic if strcmp((char*)(jl_symbol_name)(jl_gf_mtable(F)->name), "method_to_break")==0
Since this function is used for every call, you will make everything 1000x slower if you do this.
Dealing with signals
Julia requires a few signal to function property. The profiler uses SIGUSR2
for sampling and the garbage collector uses SIGSEGV
for threads synchronization. If you are debugging some code that uses the profiler or multiple threads, you may want to let the debugger ignore these signals since they can be triggered very often during normal operations. The command to do this in GDB is (replace SIGSEGV
with SIGUSRS
or other signals you want to ignore):
(gdb) handle SIGSEGV noprint nostop pass
The corresponding LLDB command is (after the process is started):
(lldb) pro hand -p true -s false -n false SIGSEGV
If you are debugging a segfault with threaded code, you can set a breakpoint on jl_critical_error
(sigdie_handler
should also work on Linux and BSD) in order to only catch the actual segfault rather than the GC synchronization points.
Errors that occur during make
need special handling. Julia is built in two stages, constructing sys0
and sys.ji
. To see what commands are running at the time of failure, use make VERBOSE=1
.
At the time of this writing, you can debug build errors during the sys0
phase from the base
directory using:
You might need to delete all the files in usr/lib/julia/
to get this to work.
You can debug the sys.ji
phase using:
julia/base$ gdb --args ../usr/bin/julia-debug -C native --build ../usr/lib/julia/sys -J ../usr/lib/julia/sys0.ji sysimg.jl
Once an error is caught, a useful technique is to walk up the stack and examine the function by inspecting the related call to jl_apply
. To take a real-world example:
The most recent jl_apply
is at frame #3, so we can go back there and look at the AST for the function julia_convert_16886
. This is the uniqued name for some method of convert
. f
in this frame is a jl_function_t*
, so we can look at the type signature, if any, from the specTypes
field:
(gdb) f 3
#3 0x00007ffff6541154 in jl_apply (f=0x7ffdf367f630, args=0x7fffffffc2b0, nargs=2) at julia.h:1281
1281 return f->fptr((jl_value_t*)f, args, nargs);
(gdb) p f->linfo->specTypes
$4 = (jl_tupletype_t *) 0x7ffdf39b1030
(gdb) p jl_( f->linfo->specTypes )
Tuple{Type{Float32}, Float64} # <-- type signature for julia_convert_16886
Then, we can look at the AST for this function:
(gdb) p jl_( jl_uncompress_ast(f->linfo, f->linfo->ast) )
Expr(:lambda, Array{Any, 1}[:#s29, :x], Array{Any, 1}[Array{Any, 1}[], Array{Any, 1}[Array{Any, 1}[:#s29, :Any, 0], Array{Any, 1}[:x, :Any, 0]], Array{Any, 1}[], 0], Expr(:body,
Expr(:line, 90, :float.jl)::Any,
Expr(:return, Expr(:call, :box, :Float32, Expr(:call, :fptrunc, :Float32, :x)::Any)::Any)::Any)::Any)::Any
Finally, and perhaps most usefully, we can force the function to be recompiled in order to step through the codegen process. To do this, clear the cached functionObject
from the jl_lamdbda_info_t*
:
(gdb) p f->linfo->functionObject
$8 = (void *) 0x1289d070
(gdb) set f->linfo->functionObject = NULL
Then, set a breakpoint somewhere useful (e.g. emit_function
, emit_expr
, emit_call
, etc.), and run codegen:
(gdb) p jl_compile(f)
Debugging precompilation errors
Module precompilation spawns a separate Julia process to precompile each module. Setting a breakpoint or catching failures in a precompile worker requires attaching a debugger to the worker. The easiest approach is to set the debugger watch for new process launches matching a given name. For example:
(gdb) attach -w -n julia-debug
or:
Then run a script/command to start precompilation. As described earlier, use conditional breakpoints in the parent process to catch specific file-loading events and narrow the debugging window. (some operating systems may require alternative approaches, such as following each fork
from the parent process)
Mozilla’s Record and Replay Framework (rr))
Julia now works out of the box with , the lightweight recording and deterministic debugging framework from Mozilla. This allows you to replay the trace of an execution deterministically. The replayed execution’s address spaces, register contents, syscall data etc are exactly the same in every run.
rr simulates a single-threaded machine by default. In order to debug concurrent code you can use rr record --chaos
which will cause rr to simulate between one to eight cores, chosen randomly. You might therefore want to set JULIA_NUM_THREADS=8
and rerun your code under rr until you have caught your bug.