seaweedfs/weed/storage/volume_info.go

package storage

import (
	"fmt"
	"math"
	"sort"
	"sync"

	"github.com/seaweedfs/seaweedfs/weed/pb/master_pb"
	"github.com/seaweedfs/seaweedfs/weed/storage/needle"
	"github.com/seaweedfs/seaweedfs/weed/storage/super_block"
)

// Held for every volume replica, so the fields are grouped by size rather than
// by meaning: interleaved, each one-byte field rounds up to a whole word.
type VolumeInfo struct {
	Collection string
	DiskType   string
	// The backend a remote volume lives in. Not the key within it: a master
	// decides nothing from the key and would hold one per volume, unique and so
	// unshareable, while the server holding the volume reports it on demand.
	RemoteStorageName string

	ReplicaPlacement *super_block.ReplicaPlacement
	Ttl              *needle.TTL

	Size             uint64
	DeletedByteCount uint64
	ModifiedAtSecond int64

	Id              needle.VolumeId
	DiskId          uint32
	CompactRevision uint32
	// Counted in uint32: a volume is capped well below 4.29 billion needles,
	// and two words per replica is worth more than the headroom.
	FileCount   uint32
	DeleteCount uint32

	Version  needle.Version
	ReadOnly bool
}

// countAsUint32 narrows a reported count without letting it wrap. Nothing
// should reach the ceiling, and a count that pretends to is better pinned
// there than turned into a small number.
func countAsUint32(n uint64) uint32 {
	if n > math.MaxUint32 {
		return math.MaxUint32
	}
	return uint32(n)
}

func NewVolumeInfo(m *master_pb.VolumeInformationMessage) (vi VolumeInfo, err error) {
	vi = VolumeInfo{
		Id:                needle.VolumeId(m.Id),
		Size:              m.Size,
		Collection:        internVolumeString(m.Collection),
		FileCount:         countAsUint32(m.FileCount),
		DeleteCount:       countAsUint32(m.DeleteCount),
		DeletedByteCount:  m.DeletedByteCount,
		ReadOnly:          m.ReadOnly,
		Version:           needle.Version(m.Version),
		CompactRevision:   m.CompactRevision,
		ModifiedAtSecond:  m.ModifiedAtSecond,
		RemoteStorageName: internVolumeString(m.RemoteStorageName),
		DiskType:          internVolumeString(m.DiskType),
		DiskId:            m.DiskId,
	}
	rp, e := super_block.NewReplicaPlacementFromByte(byte(m.ReplicaPlacement))
	if e != nil {
		return vi, e
	}
	vi.ReplicaPlacement = rp
	vi.Ttl = needle.LoadTTLFromUint32(m.Ttl)
	return vi, nil
}

func NewVolumeInfoFromShort(m *master_pb.VolumeShortInformationMessage) (vi VolumeInfo, err error) {
	vi = VolumeInfo{
		Id:         needle.VolumeId(m.Id),
		Collection: internVolumeString(m.Collection),
		Version:    needle.Version(m.Version),
		DiskId:     m.DiskId,
	}
	rp, e := super_block.NewReplicaPlacementFromByte(byte(m.ReplicaPlacement))
	if e != nil {
		return vi, e
	}
	vi.ReplicaPlacement = rp
	vi.Ttl = needle.LoadTTLFromUint32(m.Ttl)
	vi.DiskType = internVolumeString(m.DiskType)
	return vi, nil
}

// internedVolumeStrings holds one copy of each value a cluster repeats across
// its volumes. It only ever grows, which is why it must stay restricted to
// values drawn from a small set: collection, disk type, remote backend. A
// cluster with ten thousand collections keeps a few hundred kilobytes here.
//
// unique.Make would clear entries by weak reference, but its canonical value
// does not survive a collection even while a caller still holds the string it
// returned, so a later volume would get a second copy. Holding them is the
// point.
var (
	internedVolumeStringsLock sync.RWMutex
	internedVolumeStrings     = make(map[string]string)
)

// internVolumeString shares one copy of a repeated value. Decoding a heartbeat
// allocates a fresh string for each, so a master holding a million volumes
// otherwise holds a million copies of the same handful of names.
//
// Never for something unique per volume, such as a remote storage key: that
// would fill the table rather than share anything.
func internVolumeString(s string) string {
	if s == "" {
		return ""
	}
	internedVolumeStringsLock.RLock()
	shared, found := internedVolumeStrings[s]
	internedVolumeStringsLock.RUnlock()
	if found {
		return shared
	}

	internedVolumeStringsLock.Lock()
	defer internedVolumeStringsLock.Unlock()
	if shared, found = internedVolumeStrings[s]; found {
		return shared
	}
	internedVolumeStrings[s] = s
	return s
}

func (vi VolumeInfo) IsRemote() bool {
	return vi.RemoteStorageName != ""
}

func (vi VolumeInfo) String() string {
	s := fmt.Sprintf("Id:%d, Size:%d, ReplicaPlacement:%s, Collection:%s, Version:%v, Ttl:%s, FileCount:%d, DeleteCount:%d, DeletedByteCount:%d, ReadOnly:%v, ModifiedAtSecond:%d",
		vi.Id, vi.Size, vi.ReplicaPlacement, vi.Collection, vi.Version, vi.Ttl.String(), vi.FileCount, vi.DeleteCount, vi.DeletedByteCount, vi.ReadOnly, vi.ModifiedAtSecond)
	if vi.IsRemote() {
		s += fmt.Sprintf(", RemoteStorageName:%s", vi.RemoteStorageName)
	}
	return s
}

func (vi VolumeInfo) GetCollection() string {
	return vi.Collection
}

func (vi VolumeInfo) GetVolumeId() needle.VolumeId {
	return vi.Id
}

func (vi VolumeInfo) GetRemoteStorageName() string {
	return vi.RemoteStorageName
}

func (vi VolumeInfo) ToVolumeInformationMessage() *master_pb.VolumeInformationMessage {
	return &master_pb.VolumeInformationMessage{
		Id:                uint32(vi.Id),
		Size:              uint64(vi.Size),
		Collection:        vi.Collection,
		FileCount:         uint64(vi.FileCount),
		DeleteCount:       uint64(vi.DeleteCount),
		DeletedByteCount:  vi.DeletedByteCount,
		ReadOnly:          vi.ReadOnly,
		ReplicaPlacement:  uint32(vi.ReplicaPlacement.Byte()),
		Version:           uint32(vi.Version),
		Ttl:               vi.Ttl.ToUint32(),
		CompactRevision:   vi.CompactRevision,
		ModifiedAtSecond:  vi.ModifiedAtSecond,
		RemoteStorageName: vi.RemoteStorageName,
		DiskType:          vi.DiskType,
		DiskId:            vi.DiskId,
	}
}

/*VolumesInfo sorting*/

type volumeInfos []*VolumeInfo

func (vis volumeInfos) Len() int {
	return len(vis)
}

func (vis volumeInfos) Less(i, j int) bool {
	return vis[i].Id < vis[j].Id
}

func (vis volumeInfos) Swap(i, j int) {
	vis[i], vis[j] = vis[j], vis[i]
}

func sortVolumeInfos(vis volumeInfos) {
	sort.Sort(vis)
}