Skip to content

Commit

Permalink
Merge branch 'main' into vc/compress
Browse files Browse the repository at this point in the history
  • Loading branch information
NHDaly authored Oct 6, 2023
2 parents e9ecbae + 59de789 commit 5cd1aa0
Show file tree
Hide file tree
Showing 7 changed files with 129 additions and 17 deletions.
7 changes: 7 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
10 changes: 6 additions & 4 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ on:
pull_request:
push:
branches:
- master
- main
tags: '*'
jobs:
test:
Expand All @@ -23,12 +23,14 @@ jobs:
arch:
- x64
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
fetch-depth: 0 # To support cross-branch testing in regression tests
- uses: julia-actions/setup-julia@v1
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: actions/cache@v1
- uses: actions/cache@v3
env:
cache-name: cache-artifacts
with:
Expand All @@ -41,6 +43,6 @@ jobs:
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-runtest@v1
- uses: julia-actions/julia-processcoverage@v1
- uses: codecov/codecov-action@v1
- uses: codecov/codecov-action@v3
with:
file: lcov.info
4 changes: 3 additions & 1 deletion Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ pprof_jll = "0.1, 1"
CodecZlib = "0.7"

[extras]
Revise = "295af30f-e4ad-537b-8983-00126c2a3abe"
InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[targets]
test = ["Test"]
test = ["InteractiveUtils", "Revise", "Test"]
15 changes: 10 additions & 5 deletions src/Allocs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,10 @@ function pprof(alloc_profile::Profile.Allocs.AllocResults = Profile.Allocs.fetch
functions = Vector{Function}()

# NOTE: It's a bug to use the actual StackFrame itself as a key in a dictionary, since
# different StackFrames can compare the same sometimes! 🙀 So we use its string
# different StackFrames can compare the same sometimes! 🙀 So we manually compute an ID
# representation as the key. See: https://github.com/JuliaPerf/PProf.jl/issues/69
locs_map = Dict{String, UInt64}()
# (We previously stringified the function, but that is very slow.)
locs_map = Dict{Any, UInt64}()
locations = Vector{Location}()
samples = Vector{Sample}()

Expand All @@ -82,13 +83,17 @@ function pprof(alloc_profile::Profile.Allocs.AllocResults = Profile.Allocs.fetch

function maybe_add_location(frame::StackFrame)::UInt64
# See: https://github.com/JuliaPerf/PProf.jl/issues/69
frame_key = string(frame)
function_key = method_instance_id(frame)
line_number = frame.line
# For allocations profile, we uniquely identify each frame position by
# (function,line_number) pairs. That identifies a position in the code.
frame_key = (function_key, line_number)
return get!(locs_map, frame_key) do
loc_id = UInt64(length(locations) + 1)

# Extract info from the location frame
(function_name, file_name, line_number) =
string(frame.func), string(frame.file), frame.line
(function_name, file_name) =
string(frame.func), string(frame.file)

# Use a unique function id for the frame:
function_key = method_instance_id(frame)
Expand Down
8 changes: 1 addition & 7 deletions src/PProf.jl
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,7 @@ NOTE: We must use Int64 throughout this package (regardless of system word-size)
proto file specifies 64-bit integers.
"""
function _enter!(dict::OrderedDict{T, Int64}, key::T) where T
if haskey(dict, key)
return dict[key]
else
l = Int64(length(dict))
dict[key] = l
return l
end
return get!(dict, key, Int64(length(dict)))
end

using Base.StackTraces: StackFrame
Expand Down
98 changes: 98 additions & 0 deletions test/golden/regression_test.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# This file will test that your changes produce the same profiles as it did on main.
# It can be a bit hard to tell if a change is going to affect the profiles or not, so this
# file can act as a sanity test.
# It requires you to have committed your changes before running.

# Here is an example of what a failure looks like, where I purposefully reintroduced the bug
# fixed in #70. You can see that the bug is that some method instances have been incorrectly
# replaced with other methods of the same function:
#=
Main binary filename not available.
Alloc Profiles golden testing: Test Failed at /Users/nathandaly/.julia/dev/PProf/test/golden/regression_test.jl:25
Expression: nodiff
Stacktrace:
[1] macro expansion
@ ~/builds/julia-1.8/usr/share/julia/stdlib/v1.8/Test/src/Test.jl:464 [inlined]
[2] compare_profiles(name::String)
@ Main ~/.julia/dev/PProf/test/golden/regression_test.jl:25
┌ Info: Got diff!:
│ Type: allocs
│ Showing nodes accounting for 0, 0% of 1355 total
│ flat flat% sum% cum cum%
│ 0 0% 0% 1 0.074% Core.Compiler.IdDict{Int64, Int64}(::Core.Compiler.Generator{Core.Compiler.Iterators.Filter{Core.Compiler.var\"#375#382\", Core.Compiler.Pairs{Int64, Int64, Core.Compiler.LinearIndices{1, Tuple{Core.Compiler.OneTo{Int64}}}, Vector{Int64}}}, Core.Compiler.var\"#374#381\"})
│ 0 0% 0% -1 0.074% Core.Compiler.IdDict{Union{Core.Compiler.NewSSAValue, Core.Compiler.OldSSAValue, Core.SSAValue}, Int64}(::Core.Compiler.Generator{Core.Compiler.Iterators.Enumerate{Vector{Union{Core.Compiler.NewSSAValue, Core.Compiler.OldSSAValue, Core.SSAValue}}}, Core.Compiler.var\"#419#421\"})
│ 0 0% 0% -1 0.074% _collect(::Type{Int64}, ::Core.Compiler.Generator{Core.Compiler.Iterators.Filter{Core.Compiler.var\"#377#384\"{Core.Compiler.IdDict{Int64, Int64}}, Vector{Int64}}, Core.Compiler.var\"#376#383\"{Int64, Core.Compiler.IdDict{Int64, Int64}, Vector{Int64}}}, ::Core.Compiler.SizeUnknown)
│ 0 0% 0% 1 0.074% _collect(::Type{Int64}, ::Core.Compiler.Generator{Core.Compiler.Iterators.Filter{Core.Compiler.var\"#379#386\"{Core.Compiler.IdDict{Int64, Int64}}, Vector{Int64}}, Core.Compiler.var\"#378#385\"{Int64, Core.Compiler.IdDict{Int64, Int64}, Vector{Int64}}}, ::Core.Compiler.SizeUnknown)
│ 0 0% 0% 1 0.074% anymap(::Core.Compiler.var\"#261#262\", ::Vector{Any})
│ 0 0% 0% -1 0.074% anymap(::typeof(Core.Compiler.widenconditional), ::Vector{Any})
│ 0 0% 0% -1 0.074% append!(::Vector{Any}, ::Vector{Any})
│ 0 0% 0% 1 0.074% append!(::Vector{Core.Compiler.BasicBlock}, ::Vector{Core.Compiler.BasicBlock})
│ 0 0% 0% 11 0.81% argextype(::Any, ::Core.Compiler.IRCode, ::Vector{Any}, ::Vector{Any})
│ 0 0% 0% -11 0.81% argextype(::Any, ::Core.Compiler.IncrementalCompact, ::Vector{Any}, ::Vector{Any})
│ 0 0% 0% 8 0.59% copy!(::Vector{Core.Compiler.DomTreeNode}, ::Vector{Core.Compiler.DomTreeNode})
│ 0 0% 0% -8 0.59% copy!(::Vector{Int64}, ::Vector{Int64})
│ 0 0% 0% -1 0.074% setindex!(::Core.Compiler.IdDict{Any, Union{Nothing, Core.Compiler.LiftedValue}}, ::Any, ::Any)
│ 0 0% 0% 6 0.44% setindex!(::Core.Compiler.IdDict{Core.Compiler.MethodMatchKey, Union{Core.Compiler.Missing, Core.Compiler.MethodMatchResult}}, ::Any, ::Any)
│ 0 0% 0% -3 0.22% setindex!(::Core.Compiler.IdDict{Int64, Int64}, ::Any, ::Any)
│ 0 0% 0% -1 0.074% setindex!(::Core.Compiler.IdDict{Union{Core.Compiler.NewSSAValue, Core.Compiler.OldSSAValue, Core.SSAValue}, Any}, ::Any, ::Any)
│ 0 0% 0% -1 0.074% setindex!(::Core.Compiler.IdDict{Union{Core.Compiler.NewSSAValue, Core.Compiler.OldSSAValue, Core.SSAValue}, Int64}, ::Any, ::Any)
│ 0 0% 0% 3 0.22% sort
└ 0 0% 0% -3 0.22% sort##kw
Test Summary: | Pass Fail Total Time
Alloc Profiles golden testing | 1 2 3 19.8s
ERROR: LoadError: Some tests did not pass: 1 passed, 2 failed, 0 errored, 0 broken.
in expression starting at /Users/nathandaly/.julia/dev/PProf/test/golden/regression_test.jl:32
=#

using Profile, PProf
using Test, Revise
using InteractiveUtils: peakflops

# Make sure that there's no local diffs (grep returns -1 if empty)
@assert !success(pipeline(`git status --porcelain=v1`,`grep -v '^??'`))

dir1 = mktempdir()
dir2 = mktempdir()

function compare_profiles(name)
run(`git checkout main`)
Revise.revise()
@time @eval PProf.Allocs.pprof(web=false, out="$dir1/$($name).pb.gz")
run(`git checkout -`)
Revise.revise()
@time @eval PProf.Allocs.pprof(web=false, out="$dir2/$($name).pb.gz")
# Assert that there's no diff:
lines = readlines(`$(PProf.pprof_jll.pprof()) -top -diff_base=$dir1/$name.pb.gz $dir2/$name.pb.gz`)
nodiff = (lines[end] === " flat flat% sum% cum cum%")
@test nodiff
if !nodiff
@info "Got diff!: \n$(join(lines, "\n"))"
end
#@assert success(`diff $dir1/$name.pb.gz $dir2/$name.pb.gz`) "DIFF: $name"
end

@testset "Alloc Profiles golden testing" begin

Profile.Allocs.clear(); peakflops(); Profile.Allocs.@profile sample_rate=1 begin
for _ in 1:10 peakflops() end
end
compare_profiles("1")


my_function() = length(collect(Iterators.flatten(Any[1:500 for _ in 1:1000])))

Profile.Allocs.clear(); my_function(); Profile.Allocs.@profile sample_rate=0.0001 begin
my_function()
end

compare_profiles("2")

# Compilation
@eval my_function2() = length(collect(Iterators.flatten(Any[1:5 for _ in 1:10])))
@eval Profile.Allocs.clear(); Profile.Allocs.@profile sample_rate=0.1 begin
@eval (while false end; my_function2())
end

compare_profiles("3")

end
4 changes: 4 additions & 0 deletions test/runtests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,8 @@ end
@testset "Allocs.jl" begin
include("Allocs.jl")
end

@testset "Regression tests" begin
include("golden/regression_test.jl")
end
end

0 comments on commit 5cd1aa0

Please sign in to comment.