-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
lightning: replace grpc gzip compressor with klauspost/compress/gzip (#…
- Loading branch information
1 parent
0a57d81
commit 7d7350f
Showing
5 changed files
with
189 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
// Copyright 2023 PingCAP, Inc. | ||
// | ||
// 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 local | ||
|
||
import ( | ||
"io" | ||
"sync" | ||
|
||
"github.com/klauspost/compress/gzip" // faster than stdlib | ||
"google.golang.org/grpc" | ||
) | ||
|
||
var ( | ||
_ grpc.Compressor = (*gzipCompressor)(nil) | ||
_ grpc.Decompressor = (*gzipDecompressor)(nil) | ||
) | ||
|
||
type gzipCompressor struct{} | ||
|
||
var gzipWriterPool = sync.Pool{ | ||
New: func() any { | ||
return gzip.NewWriter(io.Discard) | ||
}, | ||
} | ||
|
||
func (c *gzipCompressor) Do(w io.Writer, p []byte) error { | ||
z := gzipWriterPool.Get().(*gzip.Writer) | ||
defer gzipWriterPool.Put(z) | ||
z.Reset(w) | ||
if _, err := z.Write(p); err != nil { | ||
return err | ||
} | ||
return z.Close() | ||
} | ||
|
||
func (c *gzipCompressor) Type() string { | ||
return "gzip" | ||
} | ||
|
||
type gzipDecompressor struct{} | ||
|
||
var gzipReaderPool = sync.Pool{ | ||
New: func() any { | ||
return &gzip.Reader{} | ||
}, | ||
} | ||
|
||
func (d *gzipDecompressor) Do(r io.Reader) ([]byte, error) { | ||
z := gzipReaderPool.Get().(*gzip.Reader) | ||
if err := z.Reset(r); err != nil { | ||
gzipReaderPool.Put(z) | ||
return nil, err | ||
} | ||
|
||
defer func() { | ||
_ = z.Close() | ||
gzipReaderPool.Put(z) | ||
}() | ||
return io.ReadAll(z) | ||
} | ||
|
||
func (d *gzipDecompressor) Type() string { | ||
return "gzip" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
package local | ||
|
||
import ( | ||
"bytes" | ||
"compress/gzip" // use standard library to verify the result | ||
"crypto/rand" | ||
"io" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
"google.golang.org/grpc" | ||
) | ||
|
||
func TestGzipCompressor(t *testing.T) { | ||
compressor := &gzipCompressor{} | ||
require.Equal(t, "gzip", compressor.Type()) | ||
|
||
input := make([]byte, 1<<20) | ||
_, err := rand.Read(input) | ||
require.NoError(t, err) | ||
|
||
buf := &bytes.Buffer{} | ||
err = compressor.Do(buf, input) | ||
require.NoError(t, err) | ||
|
||
compressed := buf.Bytes() | ||
z, err := gzip.NewReader(bytes.NewReader(compressed)) | ||
require.NoError(t, err) | ||
uncompressed, err := io.ReadAll(z) | ||
require.NoError(t, err) | ||
require.NoError(t, z.Close()) | ||
|
||
require.Equal(t, input, uncompressed) | ||
} | ||
|
||
func TestGzipDecompressor(t *testing.T) { | ||
decompressor := &gzipDecompressor{} | ||
require.Equal(t, "gzip", decompressor.Type()) | ||
|
||
input := make([]byte, 1<<20) | ||
_, err := rand.Read(input) | ||
require.NoError(t, err) | ||
|
||
buf := &bytes.Buffer{} | ||
z := gzip.NewWriter(buf) | ||
_, err = z.Write(input) | ||
require.NoError(t, err) | ||
require.NoError(t, z.Close()) | ||
|
||
uncompressed, err := decompressor.Do(bytes.NewReader(buf.Bytes())) | ||
require.NoError(t, err) | ||
|
||
require.Equal(t, input, uncompressed) | ||
} | ||
|
||
func BenchmarkGzipCompressor(b *testing.B) { | ||
benchCompressor(b, &gzipCompressor{}) | ||
} | ||
|
||
func BenchmarkGrpcGzipCompressor(b *testing.B) { | ||
benchCompressor(b, grpc.NewGZIPCompressor()) | ||
} | ||
|
||
func benchCompressor(b *testing.B, compressor grpc.Compressor) { | ||
input := make([]byte, 1<<20) | ||
_, err := rand.Read(input) | ||
require.NoError(b, err) | ||
|
||
b.ResetTimer() | ||
for i := 0; i < b.N; i++ { | ||
buf := &bytes.Buffer{} | ||
err = compressor.Do(buf, input) | ||
require.NoError(b, err) | ||
} | ||
} | ||
|
||
func BenchmarkGzipDecompressor(b *testing.B) { | ||
benchDecompressor(b, &gzipDecompressor{}) | ||
} | ||
|
||
func BenchmarkGrpcGzipDecompressor(b *testing.B) { | ||
benchDecompressor(b, grpc.NewGZIPDecompressor()) | ||
} | ||
|
||
func benchDecompressor(b *testing.B, decompressor grpc.Decompressor) { | ||
input := make([]byte, 1<<20) | ||
_, err := rand.Read(input) | ||
require.NoError(b, err) | ||
|
||
buf := &bytes.Buffer{} | ||
z := gzip.NewWriter(buf) | ||
_, err = z.Write(input) | ||
require.NoError(b, err) | ||
require.NoError(b, z.Close()) | ||
|
||
b.ResetTimer() | ||
for i := 0; i < b.N; i++ { | ||
_, err := decompressor.Do(bytes.NewReader(buf.Bytes())) | ||
require.NoError(b, err) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters