Skip to content

Fixed long stacktrace printing #28453

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

Merged
merged 4 commits into from
Aug 7, 2018
Merged

Fixed long stacktrace printing #28453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0f0330f
Fixed long stacktrace printing
Liozou Aug 5, 2018
bd00a6c
Add tests
Liozou Aug 5, 2018
b612e91
Fill LAST_SHOWN_LINE_INFOS with updated stackframes
Liozou Aug 5, 2018
1b54f56
Revert to old API, use invokelatetest
Liozou Aug 6, 2018
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
38 changes: 26 additions & 12 deletions base/errorshow.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,17 +458,18 @@ function show_method_candidates(io::IO, ex::MethodError, @nospecialize kwargs=()
end
end

# Contains file name and file number. Gets set when a backtrace
# or methodlist is shown. Used by the REPL to make it possible to open
# the location of a stackframe/method in the editor.
global LAST_SHOWN_LINE_INFOS = Tuple{String, Int}[]

function show_trace_entry(io, frame, n; prefix = "")
push!(LAST_SHOWN_LINE_INFOS, (string(frame.file), frame.line))
print(io, "\n", prefix)
show(io, frame, full_path=true)
n > 1 && print(io, " (repeats ", n, " times)")
end

# Contains file name and file number. Gets set when a backtrace
# or methodlist is shown. Used by the REPL to make it possible to open
# the location of a stackframe/method in the editor.
global LAST_SHOWN_LINE_INFOS = Tuple{String, Int}[]

# In case the line numbers in the source code have changed since the code was compiled,
# allow packages to set a callback function that corrects them.
# (Used by Revise and perhaps other packages.)
Expand All @@ -489,6 +490,10 @@ function show_reduced_backtrace(io::IO, t::Vector, with_prefix::Bool)
frame appears just before. =#

displayed_stackframes = []
repeated_cycle = Tuple{Int,Int,Int}[]
# First: line to introuce the "cycle repetition" message
# Second: length of the cycle
# Third: number of repetitions
frame_counter = 1
while frame_counter < length(t)
(last_frame, n) = t[frame_counter]
Expand All @@ -507,11 +512,10 @@ function show_reduced_backtrace(io::IO, t::Vector, with_prefix::Bool)
while i < length(t) && t[i] == t[j]
i+=1 ; j+=1
end
if j >= frame_counter
if j >= frame_counter-1
Copy link
Member Author

@Liozou Liozou Aug 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fixes the issue with undetected cycles repeated only once.

#= At least one cycle repeated =#
repetitions = div(i - frame_counter + 1, cycle_length)
print(io, "\n ... (the last ", cycle_length, " lines are repeated ",
repetitions, " more time", repetitions>1 ? "s)" : ")")
push!(repeated_cycle, (length(displayed_stackframes), cycle_length, repetitions))
frame_counter += cycle_length * repetitions - 1
break
end
Expand All @@ -524,13 +528,24 @@ function show_reduced_backtrace(io::IO, t::Vector, with_prefix::Bool)

try invokelatest(update_stackframes_callback[], displayed_stackframes) catch end

for (frame, n) in displayed_stackframes
push!(repeated_cycle, (0,0,0)) # repeated_cycle is never empty
frame_counter = 1
for i in 1:length(displayed_stackframes)
(frame, n) = displayed_stackframes[i]
if with_prefix
show_trace_entry(io, frame, n, prefix = string(" [", frame_counter-1, "] "))
push!(LAST_SHOWN_LINE_INFOS, (string(frame.file), frame.line))
show_trace_entry(io, frame, n, prefix = string(" [", frame_counter, "] "))
else
show_trace_entry(io, frame, n)
end
while repeated_cycle[1][1] == i # never empty because of the initial (0,0,0)
cycle_length = repeated_cycle[1][2]
repetitions = repeated_cycle[1][3]
popfirst!(repeated_cycle)
print(io, "\n ... (the last ", cycle_length, " lines are repeated ",
repetitions, " more time", repetitions>1 ? "s)" : ")")
frame_counter += cycle_length * repetitions
end
frame_counter += 1
end
end

Expand All @@ -555,7 +570,6 @@ function show_backtrace(io::IO, t::Vector)
for (last_frame, n) in filtered
frame_counter += 1
show_trace_entry(IOContext(io, :backtrace => true), last_frame, n, prefix = string(" [", frame_counter, "] "))
push!(LAST_SHOWN_LINE_INFOS, (string(last_frame.file), last_frame.line))
end
return
end
Expand Down
15 changes: 15 additions & 0 deletions test/errorshow.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,3 +521,18 @@ end
end
end

# issue #28442
@testset "Long stacktrace printing" begin
f28442(c) = g28442(c + 1)
g28442(c) = c > 10000 ? (return backtrace()) : f28442(c+1)
bt = f28442(1)
io = IOBuffer()
Base.show_backtrace(io, bt)
output = split(String(take!(io)), '\n')
@test output[3][1:4] == " [1]"
@test occursin("g28442", output[3])
@test output[4][1:4] == " [2]"
@test occursin("f28442", output[4])
@test occursin("the last 2 lines are repeated 5000 more times", output[5])
@test output[6][1:8] == " [10003]"
end