types

Documentation

Index

• Constants
• Variables
• type Backend
• type BackendFactory
• type Controller
• type DataProcessor
• type DiffDisk
• type DiskInfo
• type Frontend
• type HoleChannelOps
• type IOStats
• type IOs
• type Interface
• type Mode
• type MonitorChannel
• type PeerDetails
• type ReaderWriterAt
• type RegReplica
• type Replica
• type ReplicaInfo
• type Server
• type Snapshot
• type State
• type Stats
• type SyncInfo
• type Target
• type VolUsage

Constants

const (
	WO     = Mode("WO")
	RW     = Mode("RW")
	ERR    = Mode("ERR")
	INIT   = Mode("INIT")
	CLOSED = Mode("CLOSED")

	StateUp   = State("Up")
	StateDown = State("Down")

	RebuildPending           = "Pending"
	RebuildInProgress        = "InProgress"
	RebuildCompleted         = "Completed"
	SyncHTTPClientTimeoutKey = "SYNC_HTTP_CLIENT_TIMEOUT"
)

Variables

var (
	// RPCReadTimeout ...
	RPCReadTimeout time.Duration
	// RPCWriteTimeout ...
	RPCWriteTimeout time.Duration
)

var MaxChainLength int

var (
	// ShouldPunchHoles is a flag used to verify if
	// we should punch holes.
	ShouldPunchHoles bool
)

Types

type Backend

type Backend interface {
	IOs
	Snapshot(name string, userCreated bool, created string) error
	GetReplicaChain() ([]string, error)
	SetCheckpoint(snapshotName string) error
	Resize(name string, size string) error
	Size() (int64, error)
	SectorSize() (int64, error)
	RemainSnapshots() (int, error)
	GetRevisionCounter() (int64, error)
	GetCloneStatus() (string, error)
	GetVolUsage() (VolUsage, error)
	SetReplicaMode(mode Mode) error
	SetRevisionCounter(counter int64) error
	SetRebuilding(rebuilding bool) error
	GetMonitorChannel() MonitorChannel
	StopMonitoring()
}

type BackendFactory

type BackendFactory interface {
	Create(address string) (Backend, error)
	SignalToAdd(string, string) error
}

type Controller

type Controller interface {
	AddReplica(address string) error
	RemoveReplica(address string) error
	SetReplicaMode(address string, mode Mode) error
	ListReplicas() []Replica
	Start(address ...string) error
	Shutdown() error
}

type DataProcessor

type DataProcessor interface {
	IOs
	PingResponse() error
}

type DiffDisk

type DiffDisk interface {
	ReaderWriterAt
	io.Closer
	Fd() uintptr
}

type DiskInfo

type DiskInfo struct {
	Name            string   `json:"name"`
	Parent          string   `json:"parent"`
	Children        []string `json:"children"`
	Removed         bool     `json:"removed"`
	UserCreated     bool     `json:"usercreated"`
	Created         string   `json:"created"`
	Size            string   `json:"size"`
	RevisionCounter int64    `json:"revisionCount"`
}

type Frontend

type Frontend interface {
	Startup(name string, frontendIP string, clusterIP string, size, sectorSize int64, rw IOs) error
	Shutdown() error
	State() State
	Stats() Stats
	Resize(uint64) error
}

type HoleChannelOps

type HoleChannelOps int

HoleChannelOps is the operation that has to be performed on HoleCreatorChan such as DrainStart, DrainDone for draining the chan and notify the caller if drain is done.

const (
	// DrainStart flag is used to notify CreateHoles goroutine
	// for draining the data in HoleCreatorChan
	DrainStart HoleChannelOps = iota + 1
	// DrainDone flag is used to notify the s.Close that data
	// from HoleCreatorChan has been flushed
	DrainDone
)

var DrainOps HoleChannelOps

DrainOps is flag used for various operations on HoleCreatorChan

type IOStats

type IOStats struct {
	IOPS        int64
	Throughput  int64
	Latency     float32
	AvBlockSize float32
}

type IOs

type IOs interface {
	ReaderWriterAt
	io.Closer
	Sync() (int, error)
	Unmap(int64, int64) (int, error)
}

type Interface

type Interface interface{}

type Mode

type Mode string

type MonitorChannel

type MonitorChannel chan error

type PeerDetails

type PeerDetails struct {
	ReplicaCount       int
	QuorumReplicaCount int
}

type ReaderWriterAt

type ReaderWriterAt interface {
	io.ReaderAt
	io.WriterAt
}

type RegReplica

type RegReplica struct {
	Address  string
	UpTime   time.Duration
	RevCount int64
	RepType  string
	RepState string
}

type Replica

type Replica struct {
	Address string `json:"Address"`
	Mode    Mode   `json:"Mode"`
}

type ReplicaInfo

type ReplicaInfo struct {
	Dirty             bool                `json:"dirty"`
	Rebuilding        bool                `json:"rebuilding"`
	Head              string              `json:"head"`
	Parent            string              `json:"parent"`
	Size              string              `json:"size"`
	SectorSize        int64               `json:"sectorSize"`
	State             string              `json:"state"`
	Chain             []string            `json:"chain"`
	Disks             map[string]DiskInfo `json:"disks"`
	RemainSnapshots   int                 `json:"remainsnapshots"`
	ReplicaMode       string              `json:"replicamode"`
	RevisionCounter   string              `json:"revisioncounter"`
	UsedLogicalBlocks string              `json:"usedlogicalblocks"`
	UsedBlocks        string              `json:"usedblocks"`
	CloneStatus       string              `json:"clonestatus"`
	Checkpoint        string              `json:"checkpoint"`
}

type Server

type Server interface {
	ReaderWriterAt
	Controller
}

type Snapshot

type Snapshot struct {
	Name   string `json:"name,omitempty"`
	RWSize string `json:"rwsize,omitempty"`
	WOSize string `json:"wosize,omitempty"`
	Status string `json:"status,omitempty"`
}

Snapshot holds the information of snapshot size of RW and WO replicas and status of rebuild progress.

type State

type State string

type Stats

type Stats struct {
	IsClientConnected bool
	RevisionCounter   int64
	ReplicaCounter    int64
	SCSIIOCount       map[int]int64

	ReadIOPS            int64
	TotalReadTime       int64
	TotalReadBlockCount int64

	WriteIOPS            int64
	TotalWriteTime       int64
	TotalWriteBlockCount int64

	UsedLogicalBlocks int64
	UsedBlocks        int64
	SectorSize        int64
}

type SyncInfo

type SyncInfo struct {
	// Snapshots holds the map of snapshot names and their details
	Snapshots []Snapshot `json:"snapshots,omitempty"`
	RWReplica string     `json:"rwreplica,omitempty"`
	WOReplica string     `json:"woreplica,omitempty"`
	// RWSnapshotsTotalSize holds the total size consumed by the snapshots
	// in RW replica
	RWSnapshotsTotalSize string `json:"rwreplicatotalsize,omitempty"`
	// WOSnapshotsTotalSize holds the total size consumed by the snapshots
	// in WO replica
	WOSnapshotsTotalSize string `json:"woreplicatotalsize,omitempty"`
}

SyncInfo holds the information of snapshots and its progress during rebuilding.

type Target

type Target struct {
	ClusterIP  string
	FrontendIP string
}

Target ...

type VolUsage

type VolUsage struct {
	RevisionCounter   int64
	UsedLogicalBlocks int64
	UsedBlocks        int64
	SectorSize        int64
}