mirror of
https://github.com/grafana/loki.git
synced 2026-03-13 09:33:58 +08:00
a237444f0d
Originally, the dataobj package was a higher-level API around sections. This design caused it to become a bottleneck: * Implementing any new public behaviour for a section required bubbling it up to the dataobj API for it to be exposed, making it tedious to add new sections or update existing ones. * The `dataobj.Builder` pattern was focused on constructing dataobjs for storing log data, which will cause friction as we build objects around other use cases. This PR builds on top of the foundation laid out by #17704 and #17708, fully inverting the dependency between dataobj and sections: * The `dataobj` package has no knowledge of what sections exist, and can now be used for writing and reading generic sections. Section packages now create higher-level APIs around the abstractions provided by `dataobj`. * Section packages are now public, and callers interact directly with these packages for writing and reading section-specific data. * All logic for a section (encoding, decoding, buffering, reading) is now fully self-contained inside the section package. Previously, the implementation of each section was spread across three packages (`pkg/dataobj/internal/encoding`, `pkg/dataobj/internal/sections/SECTION`, `pkg/dataobj`). * Cutting a section is now a decision made by the caller rather than the section implementation. Previously, the logs section builder would create multiple sections. For the most part, this change is a no-op, with two exceptions: 1. Section cutting is now performed by the caller; however, this shouldn't result in any issues. 2. Removing the high-level `dataobj.Stream` and `dataobj.Record` types will temporarily reduce the allocation gains from #16988. I will address this after this PR is merged.
63 lines
1.4 KiB
Go
63 lines
1.4 KiB
Go
// Package bufpool offers a pool of [*bytes.Buffer] objects that are placed
|
|
// into exponentially sized buckets.
|
|
//
|
|
// Bucketing prevents the memory cost of a pool from permanently increasing
|
|
// when a large buffer is placed into the pool.
|
|
package bufpool
|
|
|
|
import (
|
|
"bytes"
|
|
)
|
|
|
|
// Get returns a buffer from the pool for the given size. Returned buffers are
|
|
// reset and ready for writes.
|
|
//
|
|
// The capacity of the returned buffer is guaranteed to be at least size.
|
|
func Get(size int) *bytes.Buffer {
|
|
if size < 0 {
|
|
size = 0
|
|
}
|
|
|
|
b := findBucket(uint64(size))
|
|
|
|
buf := b.pool.Get().(*bytes.Buffer)
|
|
buf.Reset()
|
|
buf.Grow(size)
|
|
return buf
|
|
}
|
|
|
|
// Put returns a buffer to the pool. The buffer is placed into an appropriate
|
|
// bucket based on its current capacity.
|
|
func Put(buf *bytes.Buffer) {
|
|
if buf == nil {
|
|
return
|
|
}
|
|
|
|
b := findBucket(uint64(buf.Cap()))
|
|
if b == nil {
|
|
return
|
|
}
|
|
b.pool.Put(buf)
|
|
}
|
|
|
|
// GetUnsized returns a buffer from the unsized pool. Returned buffers are
|
|
// reset and ready for writes.
|
|
//
|
|
// Buffers retrieved by GetUnsized should be returned to the pool with
|
|
// [PutUnsized].
|
|
func GetUnsized() *bytes.Buffer {
|
|
buf := unsizedPool.Get().(*bytes.Buffer)
|
|
buf.Reset()
|
|
return buf
|
|
}
|
|
|
|
// PutUnsized returns a buffer to the unsized pool. PutUnsized should only be
|
|
// used for buffers retrieved by [GetUnsized].
|
|
func PutUnsized(buf *bytes.Buffer) {
|
|
if buf == nil {
|
|
return
|
|
}
|
|
|
|
unsizedPool.Put(buf)
|
|
}
|