base_index_step.go

// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package bootstrapper

import (
	"github.com/m3db/m3/src/dbnode/storage/bootstrap"
	"github.com/m3db/m3/src/dbnode/storage/bootstrap/result"
	"github.com/m3db/m3/src/dbnode/storage/namespace"
	xlog "github.com/m3db/m3x/log"
)

type bootstrapIndexStep interface {
	bootstrapStep
	result() result.IndexBootstrapResult
}

type bootstrapIndex struct {
	namespace    namespace.Metadata
	curr         bootstrap.Source
	next         bootstrap.Bootstrapper
	opts         bootstrap.RunOptions
	currResult   result.IndexBootstrapResult
	nextResult   result.IndexBootstrapResult
	mergedResult result.IndexBootstrapResult
}

func newBootstrapIndexStep(
	namespace namespace.Metadata,
	curr bootstrap.Source,
	next bootstrap.Bootstrapper,
	opts bootstrap.RunOptions,
) bootstrapIndexStep {
	return &bootstrapIndex{
		namespace: namespace,
		curr:      curr,
		next:      next,
		opts:      opts,
	}
}

func (s *bootstrapIndex) prepare(
	totalRanges result.ShardTimeRanges,
) bootstrapStepPreparedResult {
	return bootstrapStepPreparedResult{
		currAvailable: s.curr.AvailableIndex(s.namespace, totalRanges),
	}
}

func (s *bootstrapIndex) runCurrStep(
	targetRanges result.ShardTimeRanges,
) (bootstrapStepStatus, error) {
	var (
		requested = targetRanges.Copy()
		fulfilled result.ShardTimeRanges
		logFields []xlog.Field
		err       error
	)
	s.currResult, err = s.curr.ReadIndex(s.namespace, targetRanges, s.opts)
	if result := s.currResult; result != nil {
		fulfilled = requested
		fulfilled.Subtract(result.Unfulfilled())

		blocks := 0
		segments := 0
		for _, block := range result.IndexResults() {
			blocks++
			segments += len(block.Segments())
		}
		logFields = append(logFields, xlog.NewField("numBlocks", blocks),
			xlog.NewField("numSegments", segments))
	}
	return bootstrapStepStatus{
		fulfilled: fulfilled,
		logFields: logFields,
	}, err
}

func (s *bootstrapIndex) runNextStep(
	targetRanges result.ShardTimeRanges,
) (bootstrapStepStatus, error) {
	var (
		requested = targetRanges.Copy()
		fulfilled result.ShardTimeRanges
		err       error
	)
	s.nextResult, err = s.next.BootstrapIndex(s.namespace, targetRanges, s.opts)
	if result := s.nextResult; result != nil {
		fulfilled = requested
		fulfilled.Subtract(result.Unfulfilled())
	}
	return bootstrapStepStatus{
		fulfilled: fulfilled,
	}, err
}

func (s *bootstrapIndex) mergeResults(
	totalUnfulfilled result.ShardTimeRanges,
) {
	if s.mergedResult == nil {
		s.mergedResult = result.NewIndexBootstrapResult()
	}
	if s.currResult != nil {
		// Merge the curr results in
		s.mergedResult.IndexResults().AddResults(s.currResult.IndexResults())
		s.currResult = nil
	}
	if s.nextResult != nil {
		// Merge the next results in
		s.mergedResult.IndexResults().AddResults(s.nextResult.IndexResults())
		s.nextResult = nil
	}
	s.mergedResult.SetUnfulfilled(totalUnfulfilled)
}

func (s *bootstrapIndex) result() result.IndexBootstrapResult {
	return s.mergedResult
}