Add @allocations macro for getting number of allocations
#47367
Conversation
base/timing.jl
Outdated
| and [`@elapsed`](@ref). | ||
| ```julia-repl | ||
| julia> @allocs rand(10^6) |
There was a problem hiding this comment.
i just copied the example from @allocated, happy to change or add others if people prefer... it's not obvious to me why the answer here is 2 not 1 😂 which may make it a good or a bad example depending on your point of view
test/misc.jl
Outdated
|
|
||
| # sanity check `@allocs` returns what we expect in some very simple cases | ||
| @test (@alloc "a") == 0 | ||
| @test (@alloc "a" * "b") == 1 |
There was a problem hiding this comment.
i didn't see any tests for @allocated so wasn't sure how to approach testing... advice appreciated!
base/timing.jl
Outdated
| end | ||
|
|
||
| """ | ||
| @allocs |
There was a problem hiding this comment.
name suggestions welcome, this just felt obvious/easy
There was a problem hiding this comment.
maybe @nallocs similar to ndigits ?
There was a problem hiding this comment.
changed to @allocations for now, as it leads to a less bad name in BenchmarkTools.jl (where the corresponding name would be @ballocations)
There was a problem hiding this comment.
Yeah, would have been unfortunate
nickrobinson251
changed the title
@allocs macro for getting number of allocations@allocations macro for getting number of allocations
|
Any more comments on this (naming-related or otherwise) before we merge this? |
4 participants
Adds an
@allocs@allocationsmacro (name TBD) which behaves similarly to@allocatedexcept for returning a count of the allocations during evaluation of the expression rather than the total size in bytes of the memory allocated.This uses
Base.gc_alloc_countso returns a single number combining all types of allocations (malloc, realloc, poolalloc, bigalloc), like what is printed via@time. The more granular break down is still available from@timed(or printed via@timev). i think the single number is useful for some cases (when you're happy to treat all allocations as equal).The motivation is to make it just as easy to get number of allocations as it is to get number of bytes allocated. For example, at RAI we have some people investigating sources of allocations and are often more concerned about the number of allocations than the size of memory allocated, yet i still see people reach for
@allocatedto get a single-number sumarry, because it's just a much easier and more discoverable interface than something likeBase.gc_alloc_count((@timed foo()).gcstats).Opened this as a PR as it wasn't too much harder than opening an issue - discussion welcome! Would appreciate pointers on implementation and testing too, if we're happy with this in prospect. Thanks!