add show methods (#26)

Author: ericphanson

Project.toml

@@ -1,7 +1,7 @@
 name = "AllocArrays"
 uuid = "5c00bae2-1499-4716-9206-27f63fd08a44"
 authors = ["Eric P. Hanson"]
-version = "1.0.0"
+version = "1.1.0"
 
 [deps]
 Bumper = "8ce10254-0962-460f-a3d8-1f77fea1446e"

src/alloc_interface.jl

@@ -123,6 +123,10 @@ By default uses a growable [`AutoscalingAllocBuffer`](@ref) (currently), or a `A
 UncheckedBumperAllocator() = UncheckedBumperAllocator(AutoscalingAllocBuffer())
 UncheckedBumperAllocator(n_bytes::Int) = UncheckedBumperAllocator(AllocBuffer(n_bytes))
 
+function Base.show(io::IO, b::UncheckedBumperAllocator)
+    return print(io, UncheckedBumperAllocator, "(", b.buf, ")")
+end
+
 """
     reset!(B::UncheckedBumperAllocator)
 
@@ -231,6 +235,22 @@ By default uses a growable [`AutoscalingAllocBuffer`](@ref) (currently), or a `A
 BumperAllocator() = BumperAllocator(AutoscalingAllocBuffer())
 BumperAllocator(n_bytes::Int) = BumperAllocator(AllocBuffer(n_bytes))
 
+function Base.show(io::IO, b::BumperAllocator)
+    # pass through the buf, since we auto-wrap with `UncheckedBumperAllocator` in the constructor,
+    # and that's an implementation detail
+    return print(io, BumperAllocator, "(", b.bumper.buf, ")")
+end
+
+function Base.show(io::IO, ::MIME"text/plain", b::BumperAllocator)
+    print(io, b)
+    # for 3-arg show, we'll add a detail about the memory locations if we are tracking any
+    if length(b.mems) > 0
+        plural = length(b.mems) == 1 ? "" : "s"
+        print(io, " (tracking ", length(b.mems), " CheckedAllocArray memory location$plural)")
+    end
+    return nothing
+end
+
 Base.lock(B::BumperAllocator) = lock(B.lock)
 Base.unlock(B::BumperAllocator) = unlock(B.lock)
 

src/autoscaling_alloc_buffer.jl

@@ -9,6 +9,33 @@ mutable struct AutoscalingAllocBuffer
     const max_history_size::Int
 end
 
+function Base.show(io::IO, ::MIME"text/plain", b::AutoscalingAllocBuffer)
+    tot_used = Base.format_bytes(amount_used(b))
+    tot_capacity = Base.format_bytes(total_capacity(b))
+
+    if amount_used(b.main_buffer) == amount_used(b) == 0
+        main_buffer_used_str = ""
+    else
+        main_buffer_used = string(round(100 * (amount_used(b.main_buffer) / amount_used(b));
+                                        digits=1), "%")
+        main_buffer_used_str = " [$main_buffer_used in main buffer]"
+    end
+    main_buffer_capacity = string(round(100 *
+                                        (total_capacity(b.main_buffer) / total_capacity(b));
+                                        digits=1), "%")
+
+    print(io, b)
+    if isempty(b.additional_buffers)
+        print(io, " ($tot_used used, capacity $tot_capacity, all in main buffer)")
+    else
+        plural = length(b.additional_buffers) == 1 ? "" : "s"
+        print(io, " ($tot_used used$main_buffer_used_str, capacity $tot_capacity [$main_buffer_capacity in main buffer] with $(length(b.additional_buffers)) additional buffer$plural)")
+    end
+    return nothing
+end
+
+Base.show(io::IO, ::AutoscalingAllocBuffer) = print(io, AutoscalingAllocBuffer, "()")
+
 """
     AutoscalingAllocBuffer(initial_buffer_size::Int=$DEFAULT_INITIAL_BUFFER_SIZE;
                            max_history_size=$DEFAULT_HISTORY_SIZE)
@@ -23,7 +50,6 @@ This means:
 - for repeated runs of the same size, a single contiguous buffer will be used, which should approximately match the performance of a tuned `AllocBuffer`
 - `AutoscalingAllocBuffer` can reuse allocated memory between runs like `AllocBuffer`, but with safety from overrunning a fixed buffer size and OOMing like `SlabBuffer`. Additionally, `AutoscalingAllocBuffer` separately tracks the memory used by the main buffer vs the additional buffers allocated dynamically, so small unexpected additional allocations don't double the memory consumption (unlike a second slab being allocated).
 
-
 !!! note
     The default `initial_buffer_size` and `max_history_size` are subject to change in non-breaking releases of AllocArrays.jl in order to tune performance in common cases. Additionally, the internal heuristics likewise may change.
 """

test/autoscaling_alloc_buffer.jl

@@ -30,6 +30,10 @@ using Bumper: alloc!, reset_buffer!
     # still not too many additional buffers
     @test length(b.additional_buffers) < 10
 
+    @testset "show" begin
+        @test sprint(show, b) == "AutoscalingAllocBuffer()"
+        @test sprint(show, MIME"text/plain"(), b) == "AutoscalingAllocBuffer() (7.668 MiB used [0.0% in main buffer], capacity 9.690 MiB [0.0% in main buffer] with 7 additional buffers)"
+    end
     # now check reset: we should have more capacity than used last time,
     # while having no additional buffers
     used = amount_used(b)
@@ -46,4 +50,10 @@ using Bumper: alloc!, reset_buffer!
         reset_buffer!(b)
     end
     @test total_capacity(b) < 2n
+
+    @testset "show" begin
+        cap = Base.format_bytes(total_capacity(b))
+        @test sprint(show, b) == "AutoscalingAllocBuffer()"
+        @test sprint(show, MIME"text/plain"(), b) == "AutoscalingAllocBuffer() (0 bytes used, capacity $cap, all in main buffer)"
+    end
 end

test/runtests.jl

@@ -52,4 +52,18 @@ end
     # Constructor does not recurse
     a = AllocArray(1:4)
     @test AllocArray(a).arr === a.arr
+
+    b = BumperAllocator()
+    @test sprint(show, b) == "BumperAllocator(AutoscalingAllocBuffer())"
+    @test sprint(show, MIME"text/plain"(), b) == "BumperAllocator(AutoscalingAllocBuffer())"
+    x = with_allocator(b) do
+        similar(c, 100, 100)
+    end
+    @test sprint(show, b) == "BumperAllocator(AutoscalingAllocBuffer())"
+    @test sprint(show, MIME"text/plain"(), b) == "BumperAllocator(AutoscalingAllocBuffer()) (tracking 1 CheckedAllocArray memory location)"
+
+    b = UncheckedBumperAllocator()
+    @test sprint(show, b) == "UncheckedBumperAllocator(AutoscalingAllocBuffer())"
+    @test sprint(show, MIME"text/plain"(), b) == "UncheckedBumperAllocator(AutoscalingAllocBuffer())"
+
 end