Package: google.golang.org/grpc/internal/mem

package mem Import Path google.golang.org/grpc/internal/mem (on go.dev) Dependency Relation imports 5 packages, and imported by 2 packages

Involved Source Files d buffer_pool.go Package mem provides utilities that facilitate memory reuse in byte slices that are used as buffers.

Package-Level Type Names (total 6, in which 4 are exported)

/* sort exporteds by: alphabet | popularity */

type BinaryTieredBufferPool (struct) BinaryTieredBufferPool is a buffer pool that uses multiple sub-pools with power-of-two sizes. Fields (total 5, none are exported) /* 5 unexporteds ... *//* 5 unexporteds: */ exponentToNextLargestPoolMap []int exponentToNextLargestPoolMap maps a power-of-two exponent (e.g., 12 for 4KB) to the index of the next largest sizedBufferPool. This is used by Get() to find the smallest pool that can satisfy a request for a given size. exponentToPreviousLargestPoolMap []int exponentToPreviousLargestPoolMap maps a power-of-two exponent to the index of the previous largest sizedBufferPool. This is used by Put() to return a buffer to the most appropriate pool based on its capacity. fallbackPool bufferPool maxPoolCap int // Optimization: Cache max capacity sizedPools []bufferPool Methods (total 4, in which 2 are exported) (*BinaryTieredBufferPool) Get(size int) *[]byte Get returns a buffer with specified length from the pool. (*BinaryTieredBufferPool) Put(buf *[]byte) Put returns a buffer to the pool. /* 2 unexporteds ... *//* 2 unexporteds: */ (*BinaryTieredBufferPool) poolForGet(size int) bufferPool (*BinaryTieredBufferPool) poolForPut(bCap int) bufferPool Implements (at least 2, in which 1 is exported) *BinaryTieredBufferPool : google.golang.org/grpc/mem.BufferPool /* at least one unexported ... *//* at least one unexported: */ *BinaryTieredBufferPool : bufferPool As Outputs Of (at least 3, in which 2 are exported) func NewBinaryTieredBufferPool(powerOfTwoExponents ...uint8) (*BinaryTieredBufferPool, error) func NewDirtyBinaryTieredBufferPool(powerOfTwoExponents ...uint8) (*BinaryTieredBufferPool, error) /* at least one unexported ... *//* at least one unexported: */ func newBinaryTiered(sizedPoolFactory func(int) bufferPool, fallbackPool bufferPool, powerOfTwoExponents ...uint8) (*BinaryTieredBufferPool, error)

type NopBufferPool (struct) NopBufferPool is a buffer pool that returns new buffers without pooling. Methods (total 2, both are exported) ( NopBufferPool) Get(length int) *[]byte Get returns a buffer with specified length from the pool. ( NopBufferPool) Put(*[]byte) Put returns a buffer to the pool. Implements (at least 2, in which 1 is exported) NopBufferPool : google.golang.org/grpc/mem.BufferPool /* at least one unexported ... *//* at least one unexported: */ NopBufferPool : bufferPool

type SimpleBufferPool (struct) SimpleBufferPool is an implementation of the mem.BufferPool interface that attempts to pool buffers with a sync.Pool. When Get is invoked, it tries to acquire a buffer from the pool but if that buffer is too small, it returns it to the pool and creates a new one. Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ pool sync.Pool shouldZero bool Methods (total 2, both are exported) (*SimpleBufferPool) Get(size int) *[]byte Get returns a buffer with specified length from the pool. (*SimpleBufferPool) Put(buf *[]byte) Put returns a buffer to the pool. Implements (at least 2, in which 1 is exported) *SimpleBufferPool : google.golang.org/grpc/mem.BufferPool /* at least one unexported ... *//* at least one unexported: */ *SimpleBufferPool : bufferPool As Outputs Of (at least 2, in which 1 is exported) func NewDirtySimplePool() *SimpleBufferPool /* at least one unexported ... *//* at least one unexported: */ func google.golang.org/grpc/internal/transport.ioBufferPool(size int) *SimpleBufferPool As Inputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func google.golang.org/grpc/internal/transport.newBufWriter(conn io.Writer, batchSize int, pool *SimpleBufferPool) *transport.bufWriter

type TieredBufferPool (struct) TieredBufferPool implements the BufferPool interface with multiple tiers of buffer pools for different sizes of buffers. Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ fallbackPool SimpleBufferPool sizedPools []*sizedBufferPool Methods (total 3, in which 2 are exported) (*TieredBufferPool) Get(size int) *[]byte Get returns a buffer with specified length from the pool. (*TieredBufferPool) Put(buf *[]byte) Put returns a buffer to the pool. /* one unexported ... *//* one unexported: */ (*TieredBufferPool) getPool(size int) bufferPool Implements (at least 2, in which 1 is exported) *TieredBufferPool : google.golang.org/grpc/mem.BufferPool /* at least one unexported ... *//* at least one unexported: */ *TieredBufferPool : bufferPool As Outputs Of (at least one exported) func NewTieredBufferPool(poolSizes ...int) *TieredBufferPool

/* 2 unexporteds ... *//* 2 unexporteds: */

type bufferPool (interface) bufferPool is a copy of the public bufferPool interface used to avoid circular dependencies. Methods (total 2, both are exported) ( bufferPool) Get(length int) *[]byte Get returns a buffer with specified length from the pool. ( bufferPool) Put(*[]byte) Put returns a buffer to the pool. The provided pointer must hold a prefix of the buffer obtained via BufferPool.Get to ensure the buffer's entire capacity can be re-used. Implemented By (at least 8, in which 6 are exported) *BinaryTieredBufferPool NopBufferPool *SimpleBufferPool *TieredBufferPool google.golang.org/grpc/mem.BufferPool (interface) google.golang.org/grpc/mem.NopBufferPool /* 2+ unexporteds ... *//* 2+ unexporteds: */ *sizedBufferPool *google.golang.org/grpc/internal/transport/readyreader.constBufferPool Implements (at least one exported) bufferPool : google.golang.org/grpc/mem.BufferPool As Outputs Of (at least 3, none are exported) /* 3+ unexporteds ... *//* 3+ unexporteds: */ func (*BinaryTieredBufferPool).poolForGet(size int) bufferPool func (*BinaryTieredBufferPool).poolForPut(bCap int) bufferPool func (*TieredBufferPool).getPool(size int) bufferPool As Inputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func newBinaryTiered(sizedPoolFactory func(int) bufferPool, fallbackPool bufferPool, powerOfTwoExponents ...uint8) (*BinaryTieredBufferPool, error)

type sizedBufferPool (struct) sizedBufferPool is a BufferPool implementation that is optimized for specific buffer sizes. For example, HTTP/2 frames within gRPC have a default max size of 16kb and a sizedBufferPool can be configured to only return buffers with a capacity of 16kb. Note that however it does not support returning larger buffers and in fact panics if such a buffer is requested. Because of this, this BufferPool implementation is not meant to be used on its own and rather is intended to be embedded in a TieredBufferPool such that Get is only invoked when the required size is smaller than or equal to defaultSize. Fields (total 3, none are exported) /* 3 unexporteds ... *//* 3 unexporteds: */ defaultSize int pool sync.Pool shouldZero bool Methods (total 2, both are exported) (*sizedBufferPool) Get(size int) *[]byte (*sizedBufferPool) Put(buf *[]byte) Implements (at least 2, in which 1 is exported) *sizedBufferPool : google.golang.org/grpc/mem.BufferPool /* at least one unexported ... *//* at least one unexported: */ *sizedBufferPool : bufferPool As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func newSizedBufferPool(size int, zero bool) *sizedBufferPool

Package-Level Functions (total 6, in which 4 are exported)

func NewBinaryTieredBufferPool(powerOfTwoExponents ...uint8) (*BinaryTieredBufferPool, error) NewBinaryTieredBufferPool returns a BufferPool backed by multiple sub-pools. This structure enables O(1) lookup time for Get and Put operations. The arguments provided are the exponents for the buffer capacities (powers of 2), not the raw byte sizes. For example, to create a pool of 16KB buffers (2^14 bytes), pass 14 as the argument.

func NewDirtyBinaryTieredBufferPool(powerOfTwoExponents ...uint8) (*BinaryTieredBufferPool, error) NewDirtyBinaryTieredBufferPool returns a BufferPool backed by multiple sub-pools. It is similar to NewBinaryTieredBufferPool but it does not initialize the buffers before returning them.

func NewDirtySimplePool() *SimpleBufferPool NewDirtySimplePool constructs a [SimpleBufferPool]. It does not initialize the buffers before returning them. Callers must ensure they don't read the buffers before writing data to them.

func NewTieredBufferPool(poolSizes ...int) *TieredBufferPool NewTieredBufferPool returns a BufferPool implementation that uses multiple underlying pools of the given pool sizes.

/* 2 unexporteds ... *//* 2 unexporteds: */

func newBinaryTiered(sizedPoolFactory func(int) bufferPool, fallbackPool bufferPool, powerOfTwoExponents ...uint8) (*BinaryTieredBufferPool, error)

func newSizedBufferPool(size int, zero bool) *sizedBufferPool

Package-Level Variables (only one, which is unexported) /* one unexported ... *//* one unexported: */

var uintSize int // use a variable for mocking during tests.

Package-Level Constants (only one, which is unexported) /* one unexported ... *//* one unexported: */

const goPageSize = 4096 // 4KiB. N.B. this must be a power of 2.