Skip to content

Do not use buffer pool when message is not releasable #6881

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

Merged
merged 4 commits into from
Jul 16, 2025
Merged

Do not use buffer pool when message is not releasable #6881

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ceeba13
Do not use buffer pool when message is not releasable
alanprot Jul 14, 2025
ef8ed13
Adding test
alanprot Jul 15, 2025
784cc2f
fix lint
alanprot Jul 15, 2025
7a08c93
fix lint
alanprot Jul 15, 2025
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
19 changes: 14 additions & 5 deletions pkg/cortexpb/codec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import (
// Name is the name registered for the proto codec.
const Name = "proto"

var noOpBufferPool = &mem.NopBufferPool{}

func init() {
encoding.RegisterCodecV2(&cortexCodec{})
}
Expand Down Expand Up @@ -94,10 +96,17 @@ func (c *cortexCodec) Unmarshal(data mem.BufferSlice, v any) error {
return fmt.Errorf("failed to unmarshal, message is %T, want proto.Message", v)
}

// To be in the safe side, we will never automatically release the buffer used to Unmarshal the message automatically.
// This should simulate the same behavior of grpc v1.65.0 and before.
buf := data.MaterializeToBuffer(mem.DefaultBufferPool())
// To be safe, we avoid automatically releasing the buffer used to unmarshal the message.
// Additionally, we avoid using a pooled byte slice unless the message implements ReleasableMessage.
// This mimics the behavior of gRPC versions 1.65.0 and earlier.
rm, ok := v.(ReleasableMessage)
bufferPool := mem.DefaultBufferPool()

if !ok {
bufferPool = noOpBufferPool
}

buf := data.MaterializeToBuffer(bufferPool)
err := proto.Unmarshal(buf.ReadOnlyData(), vv)

if err != nil {
Expand All @@ -106,8 +115,8 @@ func (c *cortexCodec) Unmarshal(data mem.BufferSlice, v any) error {
}

// If v implements ReleasableMessage interface, we add the buff to be freed later when the request is no longer being used
if fm, ok := v.(ReleasableMessage); ok {
fm.RegisterBuffer(buf)
if rm != nil {
rm.RegisterBuffer(buf)
}

return err
Expand Down