github.com/m3db/m3@v1.5.0/src/dbnode/ts/writes/write_batch_pool.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package writes
    22  
    23  import (
    24  	"github.com/m3db/m3/src/x/pool"
    25  )
    26  
    27  const (
    28  	// defaultWritePoolMaxBatchSize is the default maximum size for a writeBatch that the pool
    29  	// will allow to remain in the pool. Any batches larger than that will be discarded to prevent
    30  	// excessive memory use forever in the case of an exceptionally large batch write.
    31  	defaultMaxBatchSize = 10240
    32  )
    33  
    34  // WriteBatchPool is a pool of WriteBatch.
    35  type WriteBatchPool struct {
    36  	pool             pool.ObjectPool
    37  	initialBatchSize int
    38  	maxBatchSize     int
    39  }
    40  
    41  // NewWriteBatchPool constructs a new WriteBatchPool.
    42  func NewWriteBatchPool(
    43  	opts pool.ObjectPoolOptions,
    44  	initialBatchSize int,
    45  	maxBatchSizeOverride *int,
    46  ) *WriteBatchPool {
    47  	maxBatchSize := defaultMaxBatchSize
    48  	if maxBatchSizeOverride != nil {
    49  		maxBatchSize = *maxBatchSizeOverride
    50  	}
    51  
    52  	p := pool.NewObjectPool(opts)
    53  	return &WriteBatchPool{pool: p, initialBatchSize: initialBatchSize, maxBatchSize: maxBatchSize}
    54  }
    55  
    56  // Init initializes a WriteBatchPool.
    57  func (p *WriteBatchPool) Init() {
    58  	p.pool.Init(func() interface{} {
    59  		return NewWriteBatch(p.initialBatchSize, nil, p.Put)
    60  	})
    61  }
    62  
    63  // Get retrieves a WriteBatch from the pool.
    64  func (p *WriteBatchPool) Get() WriteBatch {
    65  	w := p.pool.Get().(WriteBatch)
    66  	return w
    67  }
    68  
    69  // Put stores a WriteBatch in the pool.
    70  func (p *WriteBatchPool) Put(w WriteBatch) {
    71  	if w.cap() > p.maxBatchSize {
    72  		// WriteBatch has grown too large to remain in the pool.
    73  		return
    74  	}
    75  
    76  	p.pool.Put(w)
    77  }