642675125e
Performance benchmarks can be found below. Obviously, a 8 KiB
request/response is tailored to showcase this improvement as this is
where codec buffer reuse shines, but I've run other benchmarks too (like
1-byte requests and responses) and there's no discernable impact on
performance.
We do not allow reuse of buffers when stat handlers or binlogs are
turned on. This is because those two may need access to the data and
payload even after the data has been written to the wire. In such cases,
we never return the data back to the pool.
A buffer reuse threshold of 1 KiB was determined after several
experiments. There's diminished returns when buffer reuse is enabled for
smaller messages (actually, a negative impact).
unary-networkMode_none-bufConn_false-keepalive_false-benchTime_40s-trace_false-latency_0s-kbps_0-MTU_0-maxConcurrentCalls_6-reqSize_8192B-respSize_8192B-compressor_off-channelz_false-preloader_false
Title Before After Percentage
TotalOps 839638 906223 7.93%
SendOps 0 0 NaN%
RecvOps 0 0 NaN%
Bytes/op 103788.29 80592.47 -22.35%
Allocs/op 183.33 189.30 3.27%
ReqT/op 1375662899.20 1484755763.20 7.93%
RespT/op 1375662899.20 1484755763.20 7.93%
50th-Lat 238.746µs 225.019µs -5.75%
90th-Lat 514.253µs 456.439µs -11.24%
99th-Lat 711.083µs 702.466µs -1.21%
Avg-Lat 285.45µs 264.456µs -7.35%
65 lines
2.2 KiB
Go
65 lines
2.2 KiB
Go
/*
|
|
*
|
|
* Copyright 2014 gRPC authors.
|
|
*
|
|
* 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 grpc
|
|
|
|
import (
|
|
"google.golang.org/grpc/encoding"
|
|
_ "google.golang.org/grpc/encoding/proto" // to register the Codec for "proto"
|
|
)
|
|
|
|
// baseCodec contains the functionality of both Codec and encoding.Codec, but
|
|
// omits the name/string, which vary between the two and are not needed for
|
|
// anything besides the registry in the encoding package.
|
|
type baseCodec interface {
|
|
Marshal(v interface{}) ([]byte, error)
|
|
Unmarshal(data []byte, v interface{}) error
|
|
}
|
|
|
|
// A bufferReturner requires a ReturnBuffer method to be implemented. Once a
|
|
// Marshal caller is done with the returned byte buffer, they can choose to
|
|
// return it back to the encoding library for re-use using this method.
|
|
type bufferReturner interface {
|
|
// If implemented in a codec, this function may be called with the byte
|
|
// buffer returned by Marshal after gRPC is done with the buffer.
|
|
//
|
|
// gRPC will not call ReturnBuffer after it's done with the buffer if any of
|
|
// the following is true:
|
|
// 1. Stats handlers are used.
|
|
// 2. Binlogs are enabled.
|
|
ReturnBuffer(buf []byte)
|
|
}
|
|
|
|
var _ baseCodec = Codec(nil)
|
|
var _ baseCodec = encoding.Codec(nil)
|
|
|
|
// Codec defines the interface gRPC uses to encode and decode messages.
|
|
// Note that implementations of this interface must be thread safe;
|
|
// a Codec's methods can be called from concurrent goroutines.
|
|
//
|
|
// Deprecated: use encoding.Codec instead.
|
|
type Codec interface {
|
|
// Marshal returns the wire format of v.
|
|
Marshal(v interface{}) ([]byte, error)
|
|
// Unmarshal parses the wire format into v.
|
|
Unmarshal(data []byte, v interface{}) error
|
|
// String returns the name of the Codec implementation. This is unused by
|
|
// gRPC.
|
|
String() string
|
|
}
|