github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/context/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 context
    22  
    23  import (
    24  	"github.com/m3db/m3/src/x/pool"
    25  )
    26  
    27  type poolOfContexts struct {
    28  	finalizeablesListPool    pool.ObjectPool
    29  	finalizeablesElementPool *finalizeableElementPool
    30  	ctxPool                  pool.ObjectPool
    31  }
    32  
    33  // NewPool creates a new context pool.
    34  func NewPool(opts Options) Pool {
    35  	p := &poolOfContexts{
    36  		finalizeablesListPool:    pool.NewObjectPool(opts.ContextPoolOptions()),
    37  		finalizeablesElementPool: newFinalizeableElementPool(opts.FinalizerPoolOptions()),
    38  		ctxPool:                  pool.NewObjectPool(opts.ContextPoolOptions()),
    39  	}
    40  	p.finalizeablesListPool.Init(func() interface{} {
    41  		return &finalizeableList{Pool: p.finalizeablesElementPool}
    42  	})
    43  	p.ctxPool.Init(func() interface{} {
    44  		return newPooledContext(p)
    45  	})
    46  
    47  	return p
    48  }
    49  
    50  func (p *poolOfContexts) Get() Context {
    51  	return p.ctxPool.Get().(Context)
    52  }
    53  
    54  func (p *poolOfContexts) Put(context Context) {
    55  	p.ctxPool.Put(context)
    56  }
    57  
    58  func (p *poolOfContexts) getFinalizeablesList() *finalizeableList {
    59  	return p.finalizeablesListPool.Get().(*finalizeableList)
    60  }
    61  
    62  func (p *poolOfContexts) putFinalizeablesList(v *finalizeableList) {
    63  	emptyValue := finalizeable{}
    64  	for elem := v.Front(); elem != nil; elem = elem.Next() {
    65  		elem.Value = emptyValue
    66  	}
    67  	v.Reset()
    68  	p.finalizeablesListPool.Put(v)
    69  }