ndctl

type Bus interface {
	// Provider returns the bus provider.
	Provider() string
	// DeviceName returns the bus device name.
	DeviceName() string
	// Dimms returns the dimms provided by the bus.
	Dimms() []Dimm
	// ActiveRegions returns all active regions in the bus.
	ActiveRegions() []Region
	// AllRegions returns all regions in the bus including disabled regions.
	AllRegions() []Region
	// GetRegionByPhysicalAddress finds a region by physical address.
	GetRegionByPhysicalAddress(address uint64) Region
}

type Context interface {
	// Free destroys the context.
	Free()
	// GetBuses returns all available buses.
	GetBuses() []Bus
}

type CreateNamespaceOpts struct {
	Name       string
	Size       uint64
	SectorSize uint64
	Type       NamespaceType
	Mode       NamespaceMode
	Location   MapLocation
}

type Dimm interface {
	// Enabled returns if the dimm is enabled.
	Enabled() bool
	// Active returns if the the device is active.
	Active() bool
	// ID returns the dimm's unique identifier string.
	ID() string
	// PhysicalID returns the dimm's physical id number.
	PhysicalID() int
	// DeviceName returns the dimm's device name.
	DeviceName() string
	// Handle returns the dimm's handle.
	Handle() int16
}

type MapLocation string

type Mapping interface {
	// Offset returns the offset within the region.
	Offset() uint64
	// Length returns the mapping's length.
	Length() uint64
	// Position returns the mapping's position.
	Position() int
	// Region gets the associated region.
	Region() Region
	// Dimm gets the associated dimm.
	Dimm() Dimm
}

type Namespace interface {
	// ID returns the namespace id.
	ID() uint
	// Name returns the name of the namespace.
	Name() string
	// DeviceName returns the device name of the namespace.
	DeviceName() string
	// BlockDeviceName returns the block device name of the namespace.
	BlockDeviceName() string
	// Size returns the size of the device provided by the namespace.
	Size() uint64
	// RawSize returns the amount of PMEM used by the namespace
	// in the underlying region, which is more than Size().
	RawSize() uint64
	// Mode returns the namespace mode.
	Mode() NamespaceMode
	// Type returns the namespace type.
	Type() NamespaceType
	// Enabled return true if the namespace is enabled.
	Enabled() bool
	// Active returns true if the namespace is active.
	Active() bool
	// UUID returns the uuid of the namespace.
	UUID() uuid.UUID
	// Location returns the namespace mapping location.
	Location() MapLocation
	// Region returns reference to the region that contains the namespace.
	Region() Region

	// SetAltName changes the alternative name of the namespace.
	SetAltName(name string) error
	// SetSize changes the size of the namespace.
	SetSize(size uint64) error
	// SetUUID changes the uuid of the namespace.
	SetUUID(uid uuid.UUID) error
	// SetSectorSize changes the sector size of the namespace.
	SetSectorSize(sectorSize uint64) error
	// SetEnforceMode changes how the namespace mode.
	SetEnforceMode(mode NamespaceMode) error
	// Enable activates the namespace.
	Enable() error
	// Disable deactivates the namespace.
	Disable() error
	// RawMode enables or disables direct access to the block device.
	SetRawMode(raw bool) error
	// SetPfnSeed creates a PFN for the namespace.
	SetPfnSeed(loc MapLocation, align uint64) error
}

type NamespaceMode string

type NamespaceType string

type Region interface {
	// ID returns region id.
	ID() uint
	// DeviceName returns region name.
	DeviceName() string
	// Size returns the total size of the region.
	Size() uint64
	// AvailableSize returns the size of remaining available space in the region.
	AvailableSize() uint64
	// MaxAvailableExtent returns max available extent size in the region.
	MaxAvailableExtent() uint64
	// Type identifies the kind of region.
	Type() RegionType
	// TypeName returns the name for the region type.
	TypeName() string
	// Enabled returns true if the region is enabled.
	Enabled() bool
	// Readonly returns true if the region is read/only.
	Readonly() bool
	// InterleaveWays returns the interleaving of the region.
	InterleaveWays() uint64
	// ActiveNamespaces returns all active namespaces in the region.
	ActiveNamespaces() []Namespace
	// AllNamespaces returns all non-zero sized namespaces in the region
	// as sometime a deleted namespace also lies around with size zero, we can ignore
	// such namespace.
	AllNamespaces() []Namespace
	// Bus returns the bus associated with the region.
	Bus() Bus
	// Mappings returns all available mappings in the region.
	Mappings() []Mapping
	// SeedNamespace returns the initial namespace in the region.
	SeedNamespace() Namespace
	// CreateNamespace creates a new namespace in the region.
	CreateNamespace(ctx gocontext.Context, opts CreateNamespaceOpts) (Namespace, error)
	// DestroyNamespace destroys the given namespace in the region.
	DestroyNamespace(ns Namespace, force bool) error
	// FsdaxAlignment returns the default alignment for an fsdax namespace.
	// It always returns a non-zero value.
	FsdaxAlignment() uint64
	// GetAlign returns region alignment. 0 if unknown.
	GetAlign() uint64
}

type RegionType string