github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/storage/bootstrap/bootstrapper/commitlog/commit_log.go (about)

     1  // Copyright (c) 2016 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 commitlog implements commit log bootstrapping.
    22  package commitlog
    23  
    24  import (
    25  	"github.com/m3db/m3/src/dbnode/persist/fs"
    26  	"github.com/m3db/m3/src/dbnode/storage/bootstrap"
    27  	"github.com/m3db/m3/src/dbnode/storage/bootstrap/bootstrapper"
    28  )
    29  
    30  const (
    31  	// CommitLogBootstrapperName is the name of the commit log bootstrapper.
    32  	CommitLogBootstrapperName = "commitlog"
    33  )
    34  
    35  type commitLogBootstrapperProvider struct {
    36  	opts       Options
    37  	inspection fs.Inspection
    38  	next       bootstrap.BootstrapperProvider
    39  }
    40  
    41  // NewCommitLogBootstrapperProvider creates a new bootstrapper provider
    42  // to bootstrap from commit log files.
    43  func NewCommitLogBootstrapperProvider(
    44  	opts Options,
    45  	inspection fs.Inspection,
    46  	next bootstrap.BootstrapperProvider,
    47  ) (bootstrap.BootstrapperProvider, error) {
    48  	if err := opts.Validate(); err != nil {
    49  		return nil, err
    50  	}
    51  	return commitLogBootstrapperProvider{
    52  		opts:       opts,
    53  		inspection: inspection,
    54  		next:       next,
    55  	}, nil
    56  }
    57  
    58  func (p commitLogBootstrapperProvider) Provide() (bootstrap.Bootstrapper, error) {
    59  	var (
    60  		src  = newCommitLogSource(p.opts, p.inspection)
    61  		b    = &commitLogBootstrapper{}
    62  		next bootstrap.Bootstrapper
    63  		err  error
    64  	)
    65  	if p.next != nil {
    66  		next, err = p.next.Provide()
    67  		if err != nil {
    68  			return nil, err
    69  		}
    70  	}
    71  	return bootstrapper.NewBaseBootstrapper(b.String(),
    72  		src, p.opts.ResultOptions(), next)
    73  }
    74  
    75  func (p commitLogBootstrapperProvider) String() string {
    76  	return CommitLogBootstrapperName
    77  }
    78  
    79  type commitLogBootstrapper struct {
    80  	bootstrap.Bootstrapper
    81  }
    82  
    83  func (*commitLogBootstrapper) String() string {
    84  	return CommitLogBootstrapperName
    85  }