-
Notifications
You must be signed in to change notification settings - Fork 0
/
decoderpool.go
136 lines (116 loc) · 4.01 KB
/
decoderpool.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
// Copyright 2020 Mostyn Bramley-Moore.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package syncpool provides a non-leaky sync.Pool for
// github.com/klauspost/compress/zstd's Encoder and Decoder types,
// using wrappers (EncoderWrapper and DecoderWrapper).
package syncpool
import (
"io"
"runtime"
"sync"
"github.com/klauspost/compress/zstd"
)
// DecoderWrapper is a wrapper that embeds a *zstd.Decoder, and is safe for
// use in a sync.Pool.
type DecoderWrapper struct {
// *zstd.Decoder is not safe for use in a sync.Pool directly, since it
// leaks data and goroutines. Finalizers on the *zstd.Decoder don't help
// because the aforementioned goroutines reference the *zstd.Decoder and
// prevent it from being garbage collected (so the finalizers don't run).
//
// We can work around this by storing this wrapper with an embedded
// *zstd.Decoder in the sync.Pool, and using a finalizer on the wrapper
// to Close the *zstd.Decoder.
*zstd.Decoder
// Instead of Closing a *zstd.Decoder, we can Reset it and return it
// to this pool.
pool *sync.Pool
}
// Close does not close the embedded *zstd.Decoder (once closed, they cannot
// be reused), but instead resets it and places this *DecoderWrapper back in
// the pool.
func (w *DecoderWrapper) Close() {
err := w.Decoder.Reset(nil)
if err == nil {
w.pool.Put(w)
}
}
// IOReadCloser returns an io.ReadCloser that will return this *DecoderWrapper
// to the pool when it is closed.
func (w *DecoderWrapper) IOReadCloser() io.ReadCloser {
return &decoderReadCloser{
dw: w,
Reader: w.Decoder.IOReadCloser(),
}
}
type decoderReadCloser struct {
dw *DecoderWrapper
io.Reader
}
// Close does not close the underlying *zstd.Decoder, but instead returns
// it to the pool it came from.
func (w *decoderReadCloser) Close() error {
w.dw.Close() // Returns the DecoderWrapper to the pool.
return nil
}
// NewDecoderPool returns a sync.Pool that provides DecoderWrapper
// objects, which embed *zstd.Decoders. You probably want to include
// zstd.WithDecoderConcurrency(1) in the list of options.
func NewDecoderPool(options ...zstd.DOption) *sync.Pool {
p := &sync.Pool{}
p.New = func() interface{} {
d, _ := zstd.NewReader(nil, options...)
dw := &DecoderWrapper{
Decoder: d,
pool: p,
}
runtime.SetFinalizer(dw, func(dw *DecoderWrapper) {
dw.Decoder.Close()
})
return dw
}
return p
}
// DecoderPoolWrapper is a convenience wrapper for sync.Pool which only
// accepts and returns *DecoderWrapper's.
type DecoderPoolWrapper struct {
pool *sync.Pool
}
// Get returns a *DecoderWrapper that has been Reset to use r.
func (d *DecoderPoolWrapper) Get(r io.Reader) *DecoderWrapper {
dw := d.pool.Get().(*DecoderWrapper)
err := dw.Reset(r)
if err != nil {
// Decoder.Reset only returns a non-nil error if Close has been
// called. But DecoderWrapper.Close() intentionally doesn't call
// Decoder.Close(), so this can only happen if a *DecoderWrapper
// is type-asserted back to a *Decoder.
panic(err)
}
return dw
}
// Put returns a *DecoderWrapper to the pool.
func (d *DecoderPoolWrapper) Put(w *DecoderWrapper) {
err := w.Reset(nil)
if err == nil {
d.pool.Put(w)
}
}
// NewDecoderPoolWapper returns a *DecoderPoolWrapper that provides
// *DecoderWrapper objects that do not need to be type asserted.
// As with NewDecoderPool, you probably want to include
// zstd.WithDecoderConcurrency(1) in the list of options.
func NewDecoderPoolWrapper(options ...zstd.DOption) *DecoderPoolWrapper {
return &DecoderPoolWrapper{pool: NewDecoderPool(options...)}
}