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.

Sign up for GitHub

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

Add finalizer to BZStream and make TranscodingStreams.finalize a noop #43

Merged
merged 2 commits into from
Dec 18, 2024
Merged

Add finalizer to BZStream and make TranscodingStreams.finalize a noop #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1d9477
add finalizer to BZStream
nhz2 Dec 17, 2024
03e880a
add basic test for memory leak
nhz2 Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 5 additions & 16 deletions src/compression.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Compressor Codec
# ================

mutable struct Bzip2Compressor <: TranscodingStreams.Codec
struct Bzip2Compressor <: TranscodingStreams.Codec
stream::BZStream
blocksize100k::Int
workfactor::Int
Expand Down Expand Up @@ -37,7 +37,9 @@ function Bzip2Compressor(;blocksize100k::Integer=DEFAULT_BLOCKSIZE100K,
elseif !(0 ≤ verbosity ≤ 4)
throw(ArgumentError("verbosity must be within 0..4"))
end
return Bzip2Compressor(BZStream(), blocksize100k, workfactor, verbosity)
stream = BZStream()
finalizer(compress_finalizer!, stream)
return Bzip2Compressor(stream, blocksize100k, workfactor, verbosity)
end

const Bzip2CompressorStream{S} = TranscodingStream{Bzip2Compressor,S} where S<:IO
Expand All @@ -56,23 +58,10 @@ end
# Methods
# -------

function TranscodingStreams.finalize(codec::Bzip2Compressor)
if codec.stream.state != C_NULL
code = compress_end!(codec.stream)
if code != BZ_OK
bzerror(code)
end
end
return
end

function TranscodingStreams.startproc(codec::Bzip2Compressor, ::Symbol, error_ref::Error)
if codec.stream.state != C_NULL
code = compress_end!(codec.stream)
if code != BZ_OK
error_ref[] = BZ2Error(code)
return :error
end
@assert code == BZ_OK
end
code = compress_init!(codec.stream, codec.blocksize100k, codec.verbosity, codec.workfactor)
# errors in compress_init! do not require clean up, so just throw
Expand Down
21 changes: 5 additions & 16 deletions src/decompression.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Decompressor Codec
# ==================

mutable struct Bzip2Decompressor <: TranscodingStreams.Codec
struct Bzip2Decompressor <: TranscodingStreams.Codec
stream::BZStream
small::Bool
verbosity::Int
Expand All @@ -25,7 +25,9 @@ function Bzip2Decompressor(;small::Bool=false, verbosity::Integer=DEFAULT_VERBOS
if !(0 ≤ verbosity ≤ 4)
throw(ArgumentError("verbosity must be within 0..4"))
end
return Bzip2Decompressor(BZStream(), small, verbosity)
stream = BZStream()
finalizer(decompress_finalizer!, stream)
return Bzip2Decompressor(stream, small, verbosity)
end

const Bzip2DecompressorStream{S} = TranscodingStream{Bzip2Decompressor,S} where S<:IO
Expand All @@ -44,23 +46,10 @@ end
# Methods
# -------

function TranscodingStreams.finalize(codec::Bzip2Decompressor)
if codec.stream.state != C_NULL
code = decompress_end!(codec.stream)
if code != BZ_OK
bzerror(code)
end
end
return
end

function TranscodingStreams.startproc(codec::Bzip2Decompressor, ::Symbol, error_ref::Error)
if codec.stream.state != C_NULL
code = decompress_end!(codec.stream)
if code != BZ_OK
error_ref[] = BZ2Error(code)
return :error
end
@assert code == BZ_OK
end
code = decompress_init!(codec.stream, codec.verbosity, codec.small)
# errors in decompress_init! do not require clean up, so just throw
Expand Down
10 changes: 10 additions & 0 deletions src/libbzip2.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,11 @@ function compress_end!(stream::BZStream)
end
end

function compress_finalizer!(stream::BZStream)
compress_end!(stream)
nothing
end

function compress!(stream::BZStream, action::Integer)
if WIN32
return ccall(
Expand Down Expand Up @@ -161,6 +166,11 @@ function decompress_end!(stream::BZStream)
end
end

function decompress_finalizer!(stream::BZStream)
decompress_end!(stream)
nothing
end

function decompress!(stream::BZStream)
if WIN32
return ccall(
Expand Down
10 changes: 10 additions & 0 deletions test/big-mem-tests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@
using Test
using CodecBzip2

@testset "memory leak" begin
function foo()
for i in 1:1000000
c = transcode(Bzip2Compressor(), zeros(UInt8,16))
u = transcode(Bzip2Decompressor(), c)
end
end
foo()
end

@testset "Big Memory Tests" begin
Sys.WORD_SIZE == 64 || error("tests require 64 bit word size")
@info "compressing zeros"
Expand Down
7 changes: 7 additions & 0 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,11 @@ Aqua.test_all(CodecBzip2)
@test sprint(Base.showerror, CodecBzip2.BZ2Error(-100)) ==
"BZ2Error: unknown bzip2 error code: -100"
end
@testset "memory leaks" begin
# issue #27
for i in 1:200000
c = transcode(Bzip2Compressor(), zeros(UInt8,16))
u = transcode(Bzip2Decompressor(), c)
end
end
end
Loading