frostfs-node/pkg/local_object_storage/shard/range.go

package shard

import (
	"github.com/nspcc-dev/neofs-node/pkg/local_object_storage/blobovnicza"
	"github.com/nspcc-dev/neofs-node/pkg/local_object_storage/blobstor"
	"github.com/nspcc-dev/neofs-sdk-go/object"
	addressSDK "github.com/nspcc-dev/neofs-sdk-go/object/address"
)

// RngPrm groups the parameters of GetRange operation.
type RngPrm struct {
	ln uint64

	off uint64

	addr *addressSDK.Address

	skipMeta bool
}

// RngRes groups resulting values of GetRange operation.
type RngRes struct {
	obj     *object.Object
	hasMeta bool
}

// WithAddress is a Rng option to set the address of the requested object.
//
// Option is required.
func (p *RngPrm) WithAddress(addr *addressSDK.Address) *RngPrm {
	if p != nil {
		p.addr = addr
	}

	return p
}

// WithRange is a GetRange option to set range of requested payload data.
func (p *RngPrm) WithRange(off uint64, ln uint64) *RngPrm {
	if p != nil {
		p.off, p.ln = off, ln
	}

	return p
}

// WithIgnoreMeta is a Get option try to fetch object from blobstor directly,
// without accessing metabase.
func (p *RngPrm) WithIgnoreMeta(ignore bool) *RngPrm {
	p.skipMeta = ignore
	return p
}

// Object returns the requested object part.
//
// Instance payload contains the requested range of the original object.
func (r *RngRes) Object() *object.Object {
	return r.obj
}

// HasMeta returns true if info about the object was found in the metabase.
func (r *RngRes) HasMeta() bool {
	return r.hasMeta
}

// GetRange reads part of an object from shard.
//
// Returns any error encountered that
// did not allow to completely read the object part.
//
// Returns ErrRangeOutOfBounds if requested object range is out of bounds.
// Returns an error of type apistatus.ObjectNotFound if requested object is missing.
// Returns an error of type apistatus.ObjectAlreadyRemoved if requested object has been marked as removed in shard.
func (s *Shard) GetRange(prm *RngPrm) (*RngRes, error) {
	var big, small storFetcher

	rng := object.NewRange()
	rng.SetOffset(prm.off)
	rng.SetLength(prm.ln)

	big = func(stor *blobstor.BlobStor, _ *blobovnicza.ID) (*object.Object, error) {
		getRngBigPrm := new(blobstor.GetRangeBigPrm)
		getRngBigPrm.SetAddress(prm.addr)
		getRngBigPrm.SetRange(rng)

		res, err := stor.GetRangeBig(getRngBigPrm)
		if err != nil {
			return nil, err
		}

		obj := object.New()
		obj.SetPayload(res.RangeData())

		return obj, nil
	}

	small = func(stor *blobstor.BlobStor, id *blobovnicza.ID) (*object.Object, error) {
		getRngSmallPrm := new(blobstor.GetRangeSmallPrm)
		getRngSmallPrm.SetAddress(prm.addr)
		getRngSmallPrm.SetRange(rng)
		getRngSmallPrm.SetBlobovniczaID(id)

		res, err := stor.GetRangeSmall(getRngSmallPrm)
		if err != nil {
			return nil, err
		}

		obj := object.New()
		obj.SetPayload(res.RangeData())

		return obj, nil
	}

	obj, hasMeta, err := s.fetchObjectData(prm.addr, prm.skipMeta, big, small)

	return &RngRes{
		obj:     obj,
		hasMeta: hasMeta,
	}, err
}