pmdmanager

type Capacity struct {
	// MaxVolumeSize is the size of the largest volume that
	// currently can be created, considering alignment and
	// fragmentation.
	MaxVolumeSize uint64
	// Available is the sum of all PMEM that could be used for
	// volumes.
	Available uint64
	// Managed is all PMEM that is managed by the driver.
	Managed uint64
	// Total is all PMEM found by the driver.
	Total uint64
}

type CapacityCollector struct {
	PmemDeviceCapacity
}

type PmemDeviceCapacity interface {
	// GetCapacity returns information about local capacity.
	GetCapacity(ctx context.Context) (Capacity, error)
}

type PmemDeviceInfo struct {
	// VolumeId is a unique identifier created by PMEM-CSI for the volume.
	// It is returned by CreateDevice and passed into NodeStageVolume
	// and NodePublishVolume.
	VolumeId string

	// Path is the actual device path (for example, /dev/pmem0.1).
	// As a special case, if the path starts with FakeDevicePathPrefix,
	// then the volume doesn't have a backing store.
	Path string

	// Size allocated for block device in bytes.
	Size uint64
}

type PmemDeviceManager interface {
	PmemDeviceCapacity

	// GetName returns current device manager's operation mode
	GetMode() api.DeviceMode

	// CreateDevice creates a new block device with give name, size and namespace mode.
	// It returns the actual volume size which will always be at least as large as requested.
	// Possible errors: ErrNotEnoughSpace, ErrDeviceExists
	CreateDevice(ctx context.Context, name string, size uint64, usage parameters.Usage) (uint64, error)

	// GetDevice returns the block device information for given name
	// Possible errors: ErrDeviceNotFound
	GetDevice(ctx context.Context, name string) (*PmemDeviceInfo, error)

	// DeleteDevice deletes an existing block device with give name.
	// If 'flush' is 'true', then the device data is zeroed before deleting the device
	// Possible errors: ErrDeviceInUse
	DeleteDevice(ctx context.Context, name string, flush bool) error

	// ListDevices returns all the block devices information that was created by this device manager
	ListDevices(ctx context.Context) ([]*PmemDeviceInfo, error)
}