Initial commit

Initial public review release v0.10.0

lib/implementations/placement.go

@@ -0,0 +1,152 @@
+package implementations
+
+import (
+	"context"
+
+	"github.com/multiformats/go-multiaddr"
+	"github.com/nspcc-dev/neofs-api-go/bootstrap"
+	"github.com/nspcc-dev/neofs-api-go/container"
+	"github.com/nspcc-dev/neofs-api-go/object"
+	"github.com/nspcc-dev/neofs-api-go/refs"
+	"github.com/nspcc-dev/neofs-node/internal"
+	"github.com/nspcc-dev/neofs-node/lib/netmap"
+	"github.com/nspcc-dev/neofs-node/lib/placement"
+	"github.com/pkg/errors"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+)
+
+/*
+	File source code includes implementations of placement-related solutions.
+	Highly specialized interfaces give the opportunity to hide placement implementation in a black box for the reasons:
+	  * placement is implementation-tied entity working with graphs, filters, etc.;
+	  * NeoFS components are mostly needed in a small part of the solutions provided by placement;
+	  * direct dependency from placement avoidance helps other components do not touch crucial changes in placement.
+*/
+
+type (
+	// CID is a type alias of
+	// CID from refs package of neofs-api-go.
+	CID = refs.CID
+
+	// SGID is a type alias of
+	// SGID from refs package of neofs-api-go.
+	SGID = refs.SGID
+
+	// ObjectID is a type alias of
+	// ObjectID from refs package of neofs-api-go.
+	ObjectID = refs.ObjectID
+
+	// Object is a type alias of
+	// Object from object package of neofs-api-go.
+	Object = object.Object
+
+	// Address is a type alias of
+	// Address from refs package of neofs-api-go.
+	Address = refs.Address
+
+	// Netmap is a type alias of
+	// NetMap from netmap package.
+	Netmap = netmap.NetMap
+
+	// ObjectPlacer is an interface of placement utility.
+	ObjectPlacer interface {
+		ContainerNodesLister
+		ContainerInvolvementChecker
+		GetNodes(ctx context.Context, addr Address, usePreviousNetMap bool, excl ...multiaddr.Multiaddr) ([]multiaddr.Multiaddr, error)
+		Epoch() uint64
+	}
+
+	// ContainerNodesLister is an interface of container placement vector builder.
+	ContainerNodesLister interface {
+		ContainerNodes(ctx context.Context, cid CID) ([]multiaddr.Multiaddr, error)
+		ContainerNodesInfo(ctx context.Context, cid CID, prev int) ([]bootstrap.NodeInfo, error)
+	}
+
+	// ContainerInvolvementChecker is an interface of container affiliation checker.
+	ContainerInvolvementChecker interface {
+		IsContainerNode(ctx context.Context, addr multiaddr.Multiaddr, cid CID, previousNetMap bool) (bool, error)
+	}
+
+	objectPlacer struct {
+		pl placement.Component
+	}
+)
+
+const errEmptyPlacement = internal.Error("could not create storage lister: empty placement component")
+
+// NewObjectPlacer wraps placement.Component and returns ObjectPlacer interface.
+func NewObjectPlacer(pl placement.Component) (ObjectPlacer, error) {
+	if pl == nil {
+		return nil, errEmptyPlacement
+	}
+
+	return &objectPlacer{pl}, nil
+}
+
+func (v objectPlacer) ContainerNodes(ctx context.Context, cid CID) ([]multiaddr.Multiaddr, error) {
+	graph, err := v.pl.Query(ctx, placement.ContainerID(cid))
+	if err != nil {
+		return nil, errors.Wrap(err, "objectPlacer.ContainerNodes failed on graph query")
+	}
+
+	return graph.NodeList()
+}
+
+func (v objectPlacer) ContainerNodesInfo(ctx context.Context, cid CID, prev int) ([]bootstrap.NodeInfo, error) {
+	graph, err := v.pl.Query(ctx, placement.ContainerID(cid), placement.UsePreviousNetmap(prev))
+	if err != nil {
+		return nil, errors.Wrap(err, "objectPlacer.ContainerNodesInfo failed on graph query")
+	}
+
+	return graph.NodeInfo()
+}
+
+func (v objectPlacer) GetNodes(ctx context.Context, addr Address, usePreviousNetMap bool, excl ...multiaddr.Multiaddr) ([]multiaddr.Multiaddr, error) {
+	queryOptions := make([]placement.QueryOption, 1, 2)
+	queryOptions[0] = placement.ContainerID(addr.CID)
+
+	if usePreviousNetMap {
+		queryOptions = append(queryOptions, placement.UsePreviousNetmap(1))
+	}
+
+	graph, err := v.pl.Query(ctx, queryOptions...)
+	if err != nil {
+		if st, ok := status.FromError(errors.Cause(err)); ok && st.Code() == codes.NotFound {
+			return nil, container.ErrNotFound
+		}
+
+		return nil, errors.Wrap(err, "placer.GetNodes failed on graph query")
+	}
+
+	filter := func(group netmap.SFGroup, bucket *netmap.Bucket) *netmap.Bucket {
+		return bucket
+	}
+
+	if !addr.ObjectID.Empty() {
+		filter = func(group netmap.SFGroup, bucket *netmap.Bucket) *netmap.Bucket {
+			return bucket.GetSelection(group.Selectors, addr.ObjectID.Bytes())
+		}
+	}
+
+	return graph.Exclude(excl).Filter(filter).NodeList()
+}
+
+func (v objectPlacer) IsContainerNode(ctx context.Context, addr multiaddr.Multiaddr, cid CID, previousNetMap bool) (bool, error) {
+	nodes, err := v.GetNodes(ctx, Address{
+		CID: cid,
+	}, previousNetMap)
+	if err != nil {
+		return false, errors.Wrap(err, "placer.FromContainer failed on placer.GetNodes")
+	}
+
+	for i := range nodes {
+		if nodes[i].Equal(addr) {
+			return true, nil
+		}
+	}
+
+	return false, nil
+}
+
+func (v objectPlacer) Epoch() uint64 { return v.pl.NetworkState().Epoch }