Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
5 changes: 4 additions & 1 deletion bson/marshal.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,10 @@ func Marshal(val interface{}) ([]byte, error) {
}
}()
sw.Reset()
vw := NewDocumentWriter(sw)

vw := getValueWriter(sw)
defer putValueWriter(vw)

enc := encPool.Get().(*Encoder)
defer encPool.Put(enc)
enc.Reset(vw)
Expand Down
2 changes: 2 additions & 0 deletions bson/unmarshal.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ type ValueUnmarshaler interface {
// pointer, the pointer is set to nil without calling UnmarshalBSONValue.
func Unmarshal(data []byte, val interface{}) error {
vr := newDocumentReader(bytes.NewReader(data))
defer releaseDocumentReader(vr)

if l, err := vr.peekLength(); err != nil {
return err
} else if int(l) != len(data) {
Expand Down
71 changes: 56 additions & 15 deletions bson/value_reader.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"fmt"
"io"
"math"
"sync"
)

var _ ValueReader = &valueReader{}
Expand All @@ -29,13 +30,30 @@ type vrState struct {
end int64
}

var bufioReaderPool = sync.Pool{
New: func() interface{} {
return bufio.NewReader(nil)
},
}

var vrPool = sync.Pool{
New: func() interface{} {
return &valueReader{
stack: make([]vrState, 1, 5),
}
},
}

// valueReader is for reading BSON values.
type valueReader struct {
r *bufio.Reader
offset int64
r *bufio.Reader
ra io.ReaderAt // The underlying reader

stack []vrState
frame int64
poolReader bool // Set if r is from bufioReaderPool

offset int64
stack []vrState
frame int64
}

// NewDocumentReader returns a ValueReader using b for the underlying BSON
Expand All @@ -57,14 +75,33 @@ func newValueReader(t Type, r io.Reader) ValueReader {
}

func newDocumentReader(r io.Reader) *valueReader {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

newDocumentReader() is also called where releaseDocumentReader() is not called. It seems we will have to reverse newDocumentReader() and add a reset() for valueReader like what we did for valueWriter.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

stack := make([]vrState, 1, 5)
stack[0] = vrState{
mode: mTopLevel,
}
return &valueReader{
r: bufio.NewReader(r),
stack: stack,
vr := vrPool.Get().(*valueReader)

vr.offset = 0
vr.frame = 0
vr.poolReader = true

vr.stack = vr.stack[:1]
vr.stack[0].mode = mTopLevel
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think of initializing other fields in stack to gain greater peace of mind?
e.g.

vr.stack[0] = vrState{mode: mTopLevel}


br := bufioReaderPool.Get().(*bufio.Reader)
br.Reset(r)
vr.r = br

return vr
}

func releaseDocumentReader(vr *valueReader) {
if !vr.poolReader {
return
}

Copy link

Copilot AI Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider resetting the bufio.Reader (for example, by calling Reset(nil)) before returning it to the pool to clear its internal buffer and help prevent unintended memory retention.

Suggested change
vr.r.Reset(nil) // Clear the internal buffer to prevent memory retention.

Copilot uses AI. Check for mistakes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a dangerous change that could cause OOB errors, e.g:

panic: runtime error: slice bounds out of range [62:0]

bufioReaderPool.Put(vr.r)
vr.r = nil
vr.poolReader = false

vr.ra = nil
vrPool.Put(vr)
}

func (vr *valueReader) advanceFrame() {
Expand Down Expand Up @@ -253,14 +290,18 @@ func (vr *valueReader) appendNextElement(dst []byte) ([]byte, error) {
return nil, err
}

buf := make([]byte, length)
_, err = io.ReadFull(vr.r, buf)
buf, err := vr.r.Peek(int(length))
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Peek only allocates once for the bufio's internal buffer, we can borrow views of it with Peek without touching the heap. And append makes the copy.

if err != nil {
return nil, err
}

dst = append(dst, buf...)
vr.offset += int64(len(buf))
return dst, err
if _, err = vr.r.Discard(int(length)); err != nil {
return nil, err
}

vr.offset += int64(length)
return dst, nil
}

func (vr *valueReader) readValueBytes(dst []byte) (Type, []byte, error) {
Expand Down
10 changes: 10 additions & 0 deletions bson/value_writer.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ var vwPool = sync.Pool{
},
}

func getValueWriter(w io.Writer) *valueWriter {
vw := vwPool.Get().(*valueWriter)

vw.reset(vw.buf)
vw.buf = vw.buf[:0]
vw.w = w

return vw
}

func putValueWriter(vw *valueWriter) {
if vw != nil {
vw.w = nil // don't leak the writer
Expand Down
Loading