Update source locations with Revise (#126)

Project.toml

@@ -1,7 +1,7 @@
 name = "ProfileView"
 uuid = "c46f51b8-102a-5cf2-8d2c-8597cb0e0da7"
 author = ["Tim Holy <[email protected]>"]
-version = "0.5.2"
+version = "0.5.3"
 
 [deps]
 Cairo = "159f3aea-2a34-519c-b102-8c37f9878175"

README.md

@@ -166,6 +166,14 @@ Here is the meaning of the different arguments:
 
 - `pruned` is a list of functions (see example) whose call tree will not be displayed. This is useful to control the output of very deep (or recursive) functions. Example: `pruned = [("sort!", "sort.jl"), ("some_function_name", "some_filename.jl")]`
 
+## Source locations & Revise (new in ProfileView 0.5.3)
+
+Profiling and [Revise](https://github.com/timholy/Revise.jl) are natural partners,
+as together they allow you to iteratively improve the performance of your code.
+If you use Revise and are tracking the source files (either as a package or with `includet`),
+the source locations (file and line number) reported by ProfileView
+will match the current code at the time the window is created.
+
 ### Saving profile data manually
 
 If you're using the Gtk backend, the easiest approach is to click on

src/ProfileView.jl

@@ -5,6 +5,27 @@ using Colors
 
 import Base: isequal, show
 
+# This allows Revise to correct the location information in profiles
+if VERSION >= v"1.5.0-DEV.9"
+    using Profile: getdict   # ref https://github.com/JuliaLang/julia/pull/34235
+else
+    # Use the definition of getdict from Julia 1.5.0-DEV.9+
+    function getdict(data::Vector{UInt})
+        # Lookup is expensive, so do it only once per ip.
+        udata = unique(data)
+        dict = Profile.LineInfoDict()
+        for ip in udata
+            st = Profile.lookup(convert(Ptr{Cvoid}, ip))
+            # To correct line numbers for moving code, put it in the form expected by
+            # Base.update_stackframes_callback[]
+            stn = map(x->(x, 1), st)
+            try Base.invokelatest(Base.update_stackframes_callback[], stn) catch end
+            dict[UInt64(ip)] = map(first, stn)
+        end
+        return dict
+    end
+end
+
 export @profview
 
 """
@@ -113,8 +134,8 @@ function prepare_data(data, lidict)
     # Do code address lookups on all unique instruction pointers
     uip = unique(vcat(bt...))
     if lidict == nothing
-        lkup = Vector{StackTraces.StackFrame}[Profile.lookup(ip) for ip in uip]
-        lidict = Dict(zip(uip, lkup))
+        lidict = getdict(uip)
+        lkup = map(ip->lidict[ip], uip)
     else
         lkup = [lidict[ip] for ip in uip]
     end