types

type CalibratePriority int

type Chunk struct {
	Key  string
	Id   string // Obsoleted, chunk id of the object
	Body []byte
	Size uint64
	Term uint64 // Lineage term of last write operation.
	// Status of the chunk, can be one of CHUNK_AVAILABLE, CHUNK_DELETED, or CHUNK_RECOVERING
	// CHUNK_RECOVERING is only used for ensure atomicity, check Available to ensure recovery status.
	Status    uint32
	Available uint64         // Bytes available now. Used for recovering
	Notifier  sync.WaitGroup // See benchmarks in github.com/ds2-lab/infinistore/common/sync
	Accessed  time.Time
	Bucket    string
	Backup    bool
	BuffIdx   int    // Index in buffer queue
	Note      string // Reason for the status.
}

type CommitOption struct {
	Full               bool
	Snapshotted        bool
	BytesUploaded      uint64
	Checked            bool
	StorageSignalFlags uint32
}

type Lineage interface {
	// Validate validates the lineage, it will call the IsConsistent to check if the lineage is consistent.
	Validate(*LineageMeta) (LineageValidationResult, error)

	// IsConsistent checks if the lineage is consistent.
	IsConsistent(*LineageMeta) (bool, error)

	// ClearBackup clears the backup data.
	ClearBackup()

	// Commit commits the lineage to the COS.
	Commit() (*CommitOption, error)

	// Recover recovers data from the COS by the given lineage.
	Recover(*LineageMeta) (bool, <-chan error)

	// Status returns the status of the lineage.
	// Parameter short: returns simplified status if passes true.
	Status(bool) (confirmed uint64, status LineageStatus)
}

type LineageMeta struct {
	*protocol.Meta
	Consistent   bool
	Type         LineageMetaType
	BackupId     int
	BackupTotal  int
	MaxChunkSize uint64
	Tips         url.Values
}

type LineageMetaType int

type LineageOp struct {
	Op       uint32 // Operation, can be "OP_SET" or "OP_DEL"
	Key      string // Key of the object
	Id       string // Chunk id of the object
	Size     uint64 // Size of the object
	Accessed time.Time
	Bucket   string
	BIdx     int // Index in bufferQueue
}

type LineageStatus []*protocol.Meta

type LineageTerm struct {
	Size uint64      // Storage footprint of storing current term.
	Ops  []LineageOp // Operations of the term.

	// Fields below will be serialized.
	Term     uint64  // Term id, increase on write operation.
	Updates  uint64  // Storage footprint of storing all terms of lineage so far.
	RawOps   []byte  // Serialized "Ops"
	Hash     string  // Hash value for the term.
	DiffRank float64 // For snapshot only, this is supposed to be a moving value.
	Buffered int     // For snapshot only, number of buffered objects.
}

type LineageValidationResult int

type Loggable interface {
	ConfigLogger(int, bool)
}

type OpRet struct {
	// contains filtered or unexported fields
}

type OpWrapper struct {
	LineageOp
	*OpRet
	Body      []byte // For safety of persistence of the SET operation in the case like DEL after SET.
	Chunk     *Chunk
	OpIdx     int
	Persisted bool // Indicate the operation has been persisted.
	Accessed  bool // Indicate the access time should not be changed.
	Sized     bool // Indicate the size of storage has been updated.
}

type PersistentStorage interface {
	Storage

	ConfigS3(string, string)
	SetRecovery(string, string, uint64, int) *OpRet
	StartTracker()
	StopTracker() error
}

type ServerStats interface {
	RTT() time.Duration
}

type Storage interface {
	Id() uint64
	Get(string) (string, []byte, *OpRet)
	GetStream(string) (string, resp.AllReadCloser, *OpRet)
	Set(string, string, []byte) *OpRet
	SetStream(string, string, resp.AllReadCloser) *OpRet
	Del(string, string) *OpRet
	Len() int
	Keys() <-chan string
	Meta() StorageMeta
}

type StorageMeta interface {
	// Capacity is physical memory allowed.
	Capacity() uint64

	// System is real memory used.
	System() uint64

	// Waterline is max memory used.
	Waterline() uint64

	// Effectetive is dynamic capacity calculated.
	Effective() uint64

	// Reserved is reserved capacity configured.
	Reserved() uint64

	// Size is the size stored.
	Size() uint64

	// Calibrate adjusts capacity after each invocation.
	Calibrate()
}