code

Documentation

Overview

Package code is a central repository for all control plane fault codes.

Index

• type Code
  • func (c *Code) UnmarshalJSON(data []byte) (err error)

Types

type Code

type Code int

Code represents a stable fault code.

NB: All control plane errors should register their codes in the following block in order to avoid conflicts.

Also note that new codes should always be added at the bottom of their respective blocks. This ensures stability of fault codes over time.

const (
	Unknown Code = iota
	MissingSoftwareDependency
	BadVersionSoftwareDependency
	PrivilegedHelperNotPrivileged
	PrivilegedHelperNotAvailable
	PrivilegedHelperRequestFailed
	SocketFileInUse
)

general fault codes

const (
	StorageUnknown Code = iota + 100
	StorageAlreadyFormatted
	StorageFilesystemAlreadyMounted
	StorageDeviceAlreadyMounted
	StorageTargetAlreadyMounted
	StoragePathAccessDenied
	StorageDeviceWithFsNoMountpoint
)

generic storage fault codes

const (
	ScmUnknown Code = iota + 200
	ScmFormatInvalidSize
	ScmFormatInvalidDeviceCount
	ScmFormatMissingMountpoint
	ScmFormatMissingDevice
	ScmFormatMissingParam
	ScmFormatConflictingParam
	ScmPathAccessDenied
	ScmDiscoveryFailed
	ScmDuplicatesInDeviceList
	ScmNoDevicesMatchFilter
	ScmNoPMem
	ScmBadRegion
	ScmInvalidPMem
	ScmRamdiskLowMem
	ScmRamdiskBadSize
	ScmConfigTierMissing
)

SCM fault codes

const (
	BdevUnknown Code = iota + 300
	BdevFormatUnknownClass
	BdevFormatFailure
	BdevBadPCIAddress
	BdevNotFound
	BdevDuplicatesInDeviceList
	BdevNoDevicesMatchFilter
	BdevAccelEngineUnknown
	BdevConfigOptFlagUnknown
	BdevConfigTierTypeMismatch
	BdevNonRootVFIODisable
	BdevNoIOMMU
	BdevConfigRolesWithDCPM
	BdevConfigRolesBadNr
	BdevConfigRolesMissing
	BdevConfigMultiTierWithoutRoles
	BdevConfigBadNrTiersWithRoles
	BdevConfigControlMetadataNoRoles
	BdevConfigRolesNoControlMetadata
	BdevConfigRolesWalDataNoMeta
)

Bdev fault codes

const (
	SystemUnknown Code = iota + 400
	SystemBadFaultDomainDepth
	SystemPoolLocked
)

DAOS system fault codes

const (
	ClientUnknown Code = iota + 500
	ClientConfigBadControlPort
	ClientConfigBadAccessPoints
	ClientConfigEmptyHostList
	ClientConnectionBadHost
	ClientConnectionNoRoute
	ClientConnectionRefused
	ClientConnectionClosed
	ClientConnectionTimedOut
	ClientFormatRunningSystem
	ClientRpcTimeout
	ClientConfigVMDImbalance
)

client fault codes

const (
	ServerUnknown Code = iota + 600
	ServerScmUnmanaged
	ServerIommuDisabled
	ServerWrongSystem
	ServerPoolScmTooSmall
	ServerPoolNvmeTooSmall
	ServerPoolInvalidRanks
	ServerPoolInvalidNumRanks
	ServerPoolInvalidServiceReps
	ServerPoolDuplicateLabel
	ServerHarnessNotStarted
	ServerDataPlaneNotStarted
	ServerInstancesNotStopped
	ServerConfigInvalidNetDevClass
	ServerVfioDisabled
	ServerPoolNoLabel
	ServerIncompatibleComponents
	ServerNoCompatibilityInsecure
	ServerPoolHasContainers
	ServerHugepagesDisabled
	ServerPoolMemRatioNoRoles
	ServerBadFaultDomainLabels
)

server fault codes

const (
	ServerConfigUnknown Code = iota + 700
	ServerBadConfig
	ServerNoConfigPath
	ServerConfigBadControlPort
	ServerConfigBadTelemetryPort
	ServerConfigBadAccessPoints
	ServerConfigEvenAccessPoints
	ServerConfigBadProvider
	ServerConfigNoEngines
	ServerConfigDuplicateFabric
	ServerConfigDuplicateLogFile
	ServerConfigDuplicateScmMount
	ServerConfigDuplicateScmDeviceList
	ServerConfigOverlappingBdevDeviceList
	ServerConfigBdevCountMismatch
	ServerConfigTargetCountMismatch
	ServerConfigHelperStreamCountMismatch
	ServerConfigFaultDomainInvalid
	ServerConfigFaultCallbackNotFound
	ServerConfigFaultCallbackInsecure
	ServerConfigFaultCallbackBadPerms
	ServerConfigFaultCallbackFailed
	ServerConfigBothFaultPathAndCb
	ServerConfigFaultCallbackEmpty
	ServerConfigFaultDomainTooManyLayers
	ServerConfigNrHugepagesOutOfRange
	ServerConfigHugepagesDisabledWithBdevs
	ServerConfigVMDSettingDuplicate
	ServerConfigEngineNUMAImbalance
	ServerConfigControlMetadataNoPath
	ServerConfigRamdiskUnderMinMem
	ServerConfigRamdiskOverMaxMem
	ServerConfigScmDiffClass
	ServerConfigEngineBdevRolesMismatch
	ServerConfigSysRsvdZero
)

server config fault codes

const (
	SpdkUnknown Code = iota + 800
	SpdkCtrlrNoHealth
	SpdkBindingRetNull
	SpdkBindingFailed
)

SPDK library bindings codes

const (
	SecurityUnknown Code = iota + 900
	SecurityMissingCertFile
	SecurityUnreadableCertFile
	SecurityInvalidCert
)

security fault codes

const (
	ControlMetadataUnknown Code = iota + 1000
	ControlMetadataBadFilesystem
)

const (
	SystemCheckerUnknown Code = iota + 1100
	SystemCheckerInvalidMemberStates
	SystemCheckerNotEnabled
	SystemCheckerEnabled
)

System Checker codes

func (*Code) UnmarshalJSON

func (c *Code) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON implements a custom unmarshaler to convert an int or string code to a Code.