Move _reformat_sp to test suite and fix the typos

JuliaLang · tkf · Nov 18, 2021 · Oct 10, 2021 · Oct 10, 2021 · Oct 10, 2021
commit b51e1987ef3dcb3aba329011de1e66c07253f693
diff --git a/base/error.jl b/base/error.jl
@@ -99,50 +99,6 @@ function _reformat_bt(bt::Array{Ptr{Cvoid},1}, bt2::Array{Any,1})
     ret
 end
 
-"""
-    _reformat_sp(bt_data...) -> sp::Vector{Ptr{Cvoid}}
-
-Convert the output `bt_data` of `jl_backtrace_from_here` with `returnsp` flag set to a
-vector of valid stack pointers `sp`; i.e., `sp` is a subset of `bt_data[3]`.
-
-This function is used only in test.
-"""
-function _reformat_sp(
-    bt_raw::Array{Ptr{Cvoid},1},
-    bt2::Array{Any,1},
-    sp_raw::Array{Ptr{Cvoid},1},
-)
-    bt = _reformat_bt(bt_raw, bt2)
-    sp = empty!(similar(sp_raw))
-    i = j = 0
-    while true
-        # Advacne `i` such that `bt[i] isa Ptr{Cvoid}` (native poitner).
-        local ip
-        while true
-            if i == lastindex(bt)
-                return sp
-            end
-            i += 1
-            x = bt[i]
-            if x isa Ptr{Cvoid}
-                ip = x
-                break
-            end
-        end
-        # Advance `j` such that `bt_raw[j] == bt[i]` to find a valid stack pointer.
-        while true
-            if j == lastindex(bt_raw)
-                return sp
-            end
-            j += 1
-            if bt_raw[j] == ip
-                push!(sp, sp_raw[j])
-                break
-            end
-        end
-    end
-end
-
 """
     backtrace()
 

diff --git a/test/backtrace.jl b/test/backtrace.jl
@@ -258,6 +258,50 @@ let code = """
     @test occursin("InterpreterIP in top-level CodeInfo for Main.A", bt_str)
 end
 
+"""
+    _reformat_sp(bt_data...) -> sp::Vector{Ptr{Cvoid}}
+
+Convert the output `bt_data` of `jl_backtrace_from_here` with `returnsp` flag set to a
+vector of valid stack pointers `sp`; i.e., `sp` is a subset of `bt_data[3]`.
+
+See also `Base._reformat_bt`.
+"""
+function _reformat_sp(
+    bt_raw::Array{Ptr{Cvoid},1},
+    bt2::Array{Any,1},
+    sp_raw::Array{Ptr{Cvoid},1},
+)
+    bt = Base._reformat_bt(bt_raw, bt2)
+    sp = empty!(similar(sp_raw))
+    i = j = 0
+    while true
+        # Advance `i` such that `bt[i] isa Ptr{Cvoid}` (native pointer).
+        local ip
+        while true
+            if i == lastindex(bt)
+                return sp
+            end
+            i += 1
+            x = bt[i]
+            if x isa Ptr{Cvoid}
+                ip = x
+                break
+            end
+        end
+        # Advance `j` such that `bt_raw[j] == bt[i]` to find a valid stack pointer.
+        while true
+            if j == lastindex(bt_raw)
+                return sp
+            end
+            j += 1
+            if bt_raw[j] == ip
+                push!(sp, sp_raw[j])
+                break
+            end
+        end
+    end
+end
+
 """
     withalloca(f, nbytes)
 
@@ -321,7 +365,7 @@ end
 
 @testset "stack pointers" begin
     ptr1, ptr2, bt_data = sandwiched_backtrace()
-    sp = Base._reformat_sp(bt_data...)
+    sp = _reformat_sp(bt_data...)
     @test ptr2 < sp[1] < ptr1
     @test all(diff(Int128.(UInt.(sp))) .> 0)
 end