Skip to content
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.

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

Delete unnecessary methods to fix invalidations #904

Merged
merged 1 commit into from
Apr 12, 2024

Conversation

JamesWrigley
Copy link
Contributor

I found these through looking at invalidations from Dagger.jl (CC @jpsamaroo). Before:

julia> include("test/invalidations.jl")                                                                                                                                                                                                        
Precompiling Dagger                                                                                                                                                                                                                            
  2 dependencies successfully precompiled in 25 seconds. 92 already precompiled.                                                                                                                                                               
[ Info: Precompiling GraphVizSimpleExt [8f367522-86d3-5221-bdf5-df974a7b0ff8]                                                                                                                                                                  
length(uinvalidated(invalidations)) = 238                                                                                                                                                                                                      
[ Info: 238 methods invalidated for 27 functions                                                                                                                                                                                               
┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬──────────────────┬───────────────┬─────────────────┐                                                     
│ <file name>:<line number>                                                                                                         │  Function Name   │ Invalidations │ Invalidations % │                                                     
│                                                                                                                                   │                  │               │     (xᵢ/∑x)     │                                                     
├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────┼───────────────┼─────────────────┤                                                     
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/SparseArrays/src/sparsematrix.jl:2377 │       _all       │      3514        │                                                     
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/SparseArrays/src/sparsematrix.jl:2375 │       _any       │      3514        │                                                     
│ /home/james/.julia/packages/DataStructures/jFDPC/src/circular_buffer.jl:157                                                       │      eltype      │      3313        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/SizedArray.jl:88                                                               │     convert      │      2510        │                                                     
│ /home/james/.julia/packages/DataStructures/jFDPC/src/container_loops.jl:233                                                       │       keys       │      239        │                                                     
│ /home/james/.julia/packages/FillArrays/3N7FG/src/FillArrays.jl:708                                                                │ print_matrix_row │      187        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/SArray.jl:71                                                                   │  unsafe_convert  │      166        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/broadcast.jl:25                                                                │      _axes       │      145        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/broadcast.jl:78                                                                │      _bcs1       │      114        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/broadcast.jl:85                                                                │      _bcs1       │      104        │                                                     
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/SparseArrays/src/readonly.jl:33       │     resize!      │       73        │                                                     
│ /home/james/.julia/packages/FillArrays/3N7FG/src/fillalgebra.jl:396                                                               │   reduce_first   │       62        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/SizedArray.jl:82                                                               │     convert      │       42        │                                                     
│ /home/james/.julia/dev/Dagger/src/array/darray.jl:31                                                                              │     getindex     │       31        │                                                     
│ /home/james/.julia/packages/FillArrays/3N7FG/src/fillbroadcast.jl:258                                                             │   broadcasted    │       31        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/abstractarray.jl:178                                                           │      rdims       │       21        │                                                     
│ /home/james/.julia/packages/MemPool/jCpTk/src/read_write_lock.jl:133                                                              │      unlock      │       21        │                                                     
│ /home/james/.julia/packages/MemPool/jCpTk/src/read_write_lock.jl:119                                                              │       lock       │       21        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/abstractarray.jl:177                                                           │      rdims       │       10        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/abstractarray.jl:16                                                            │    eachindex     │       10        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/SOneTo.jl:57                                                                   │   getproperty    │       10        │                                                     
│ /home/james/.julia/packages/DataStructures/jFDPC/src/sparse_int_set.jl:213                                                        │       zip        │       10        │                                                     
│ /home/james/.julia/packages/DataStructures/jFDPC/src/circular_buffer.jl:166                                                       │     convert      │       10        │                                                     
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/SparseArrays/src/readonly.jl:17       │    eachindex     │       10        │                                                     
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/SharedArrays/src/SharedArrays.jl:575  │       map!       │       10        │                                                     
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/indexing.jl:413                                                                │     SubArray     │       00        │                                                     
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/Profile/src/Profile.jl:13             │      lookup      │       00        │                                                     
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴──────────────────┴───────────────┴─────────────────┘ 

After:

julia> include("test/invalidations.jl")
Precompiling Dagger
  10 dependencies successfully precompiled in 30 seconds. 84 already precompiled.
[ Info: Precompiling GraphVizSimpleExt [8f367522-86d3-5221-bdf5-df974a7b0ff8]
length(uinvalidated(invalidations)) = 225
[ Info: 225 methods invalidated for 25 functions
┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬──────────────────┬───────────────┬─────────────────┐
│ <file name>:<line number>                                                                                                         │  Function Name   │ Invalidations │ Invalidations % │
│                                                                                                                                   │                  │               │     (xᵢ/∑x)     │
├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼──────────────────┼───────────────┼─────────────────┤
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/SparseArrays/src/sparsematrix.jl:2377 │       _all       │      3515        │
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/SparseArrays/src/sparsematrix.jl:2375 │       _any       │      3515        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/SizedArray.jl:88                                                               │     convert      │      2611        │
│ /home/james/.julia/dev/DataStructures/src/sorted_container_iteration.jl:620                                                       │       keys       │      2310        │
│ /home/james/.julia/packages/FillArrays/3N7FG/src/FillArrays.jl:708                                                                │ print_matrix_row │      188        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/SArray.jl:71                                                                   │  unsafe_convert  │      167        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/broadcast.jl:25                                                                │      _axes       │      146        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/broadcast.jl:78                                                                │      _bcs1       │      115        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/broadcast.jl:85                                                                │      _bcs1       │      104        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/indexing.jl:413                                                                │     SubArray     │      104        │
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/SparseArrays/src/readonly.jl:33       │     resize!      │       73        │
│ /home/james/.julia/packages/FillArrays/3N7FG/src/fillalgebra.jl:396                                                               │   reduce_first   │       63        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/SizedArray.jl:82                                                               │     convert      │       42        │
│ /home/james/.julia/dev/Dagger/src/array/darray.jl:31                                                                              │     getindex     │       31        │
│ /home/james/.julia/packages/FillArrays/3N7FG/src/fillbroadcast.jl:258                                                             │   broadcasted    │       31        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/abstractarray.jl:178                                                           │      rdims       │       21        │
│ /home/james/.julia/packages/MemPool/jCpTk/src/read_write_lock.jl:133                                                              │      unlock      │       21        │
│ /home/james/.julia/packages/MemPool/jCpTk/src/read_write_lock.jl:119                                                              │       lock       │       21        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/abstractarray.jl:177                                                           │      rdims       │       10        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/abstractarray.jl:16                                                            │    eachindex     │       10        │
│ /home/james/.julia/packages/StaticArrays/EHHaF/src/SOneTo.jl:57                                                                   │   getproperty    │       10        │
│ /home/james/.julia/dev/DataStructures/src/sparse_int_set.jl:213                                                                   │       zip        │       10        │
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/SparseArrays/src/readonly.jl:17       │    eachindex     │       10        │
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/SharedArrays/src/SharedArrays.jl:575  │       map!       │       10        │
│ /cache/build/builder-amdci5-1/julialang/julia-release-1-dot-10/usr/share/julia/stdlib/v1.10/Profile/src/Profile.jl:13             │      lookup      │       00        │
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴──────────────────┴───────────────┴─────────────────┘

There are still some invalidations left, but AFAICT they're necessary and/or would require changes to Base to fix.

- Base.keys() already works on AbstractDict's so we don't need one for
  Accumulator.
- Base.eltype() is already defined for AbstractArray's and CircularBuffer is an
  AbstractVector so it doesn't need to define it again.
- A Base.convert() from AbstractArray to Array is already defined:
  https://github.com/JuliaLang/julia/blob/1ae41a2c0a3ba49d4b39dc4933dddf952b5f7f3c/base/array.jl#L612
@JamesWrigley
Copy link
Contributor Author

Also, damn, nice work on the 97% coverage 👏

@@ -61,8 +61,6 @@ Base.setindex!(ct::Accumulator, x, v) = setindex!(ct.map, x, v)

Base.haskey(ct::Accumulator, x) = haskey(ct.map, x)

Base.keys(ct::Accumulator) = keys(ct.map)
Copy link
Member

Choose a reason for hiding this comment

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

technically this adds a level of indirection but it should optimize out with SROA.

@oxinabox
Copy link
Member

This is good. thank you. Code that doesn't exist is a lower maintainance burdan.

Do you need this backported to 0.18? (we are not likely to be cutting a new release from current #master branch any time soon)

@oxinabox oxinabox merged commit 3be0527 into JuliaCollections:master Apr 12, 2024
9 of 10 checks passed
@JamesWrigley JamesWrigley deleted the invalidations branch April 12, 2024 11:45
@JamesWrigley
Copy link
Contributor Author

Thanks ❤️ Yeah it would be nice if it was backported, I'll make a PR for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants