proto

Documentation

Overview

(C) Copyright 2019 Intel Corporation.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

GOVERNMENT LICENSE RIGHTS-OPEN SOURCE SOFTWARE The Government's rights to use, modify, reproduce, release, perform, display, or disclose this software are subject to the terms of the Apache License as provided in Contract No. 8F-30005. Any reproduction of computer software, computer software documentation, or portions thereof marked with this legend must also reproduce the markings.

(C) Copyright 2019 Intel Corporation.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

GOVERNMENT LICENSE RIGHTS-OPEN SOURCE SOFTWARE The Government's rights to use, modify, reproduce, release, perform, display, or disclose this software are subject to the terms of the Apache License as provided in Contract No. 8F-30005. Any reproduction of computer software, computer software documentation, or portions thereof marked with this legend must also reproduce the markings.

Index

• func MockNvmeController(varIdx ...int32) *ctlpb.NvmeController
• func MockNvmeDeviceHealth(varIdx ...int32) *ctlpb.NvmeController_Health
• func MockNvmeNamespace(varIdx ...int32) *ctlpb.NvmeController_Namespace
• func MockPmemDevice() *ctlpb.PmemDevice
• func MockScmModule() *ctlpb.ScmModule
• func MockScmMount() *ctlpb.ScmMount
• func NewMockNvmeController(pciAddr string, fwRev string, model string, serial string, ...) *ctlpb.NvmeController
• type NvmeController
  • func (pb *NvmeController) AsProto() *ctlpb.NvmeController
  • func (pb *NvmeController) FromNative(native *storage.NvmeController) error
  • func (pb *NvmeController) ToNative() (*storage.NvmeController, error)
• type NvmeControllerResults
  • func (ncr NvmeControllerResults) HasErrors() bool
• type NvmeControllers
  • func (pb *NvmeControllers) FromNative(native storage.NvmeControllers) error
  • func (ncs NvmeControllers) String() string
  • func (ncs NvmeControllers) StringHealthStats() string
  • func (ncs NvmeControllers) Summary() string
  • func (pb NvmeControllers) ToNative() (storage.NvmeControllers, error)
• type NvmeDeviceHealth
  • func (pb *NvmeDeviceHealth) AsProto() *ctlpb.NvmeController_Health
  • func (pb *NvmeDeviceHealth) FromNative(native *storage.NvmeDeviceHealth) error
  • func (pb *NvmeDeviceHealth) ToNative() (*storage.NvmeDeviceHealth, error)
• type NvmeNamespace
  • func (pb *NvmeNamespace) AsProto() *ctlpb.NvmeController_Namespace
  • func (pb *NvmeNamespace) FromNative(native *storage.NvmeNamespace) error
  • func (pb *NvmeNamespace) ToNative() (*storage.NvmeNamespace, error)
• type NvmeNamespaces
• type ScmModuleResults
• type ScmModules
• type ScmMountResults
  • func (smr ScmMountResults) HasErrors() bool
• type ScmMounts
• type ScmNamespaces
  • func (pds ScmNamespaces) String() string

Functions

func MockNvmeController

func MockNvmeController(varIdx ...int32) *ctlpb.NvmeController

MockNvmeController is a mock protobuf Controller message used in tests for multiple packages (message contains repeated namespace field).

func MockNvmeDeviceHealth

func MockNvmeDeviceHealth(varIdx ...int32) *ctlpb.NvmeController_Health

MockNvmeDeviceHealth is a mock protobuf Health message used in tests for multiple packages.

func MockNvmeNamespace

func MockNvmeNamespace(varIdx ...int32) *ctlpb.NvmeController_Namespace

MockNvmeNamespace is a mock protobuf Namespace message used in tests for multiple packages.

func MockPmemDevice

func MockPmemDevice() *ctlpb.PmemDevice

MockPmemDevice is a mock protobuf PmemDevice used in tests for multiple packages.

func MockScmModule

func MockScmModule() *ctlpb.ScmModule

MockScmModule is a mock protobuf Module message used in tests for multiple packages.

func MockScmMount

func MockScmMount() *ctlpb.ScmMount

MockScmMount is a mock protobuf Mount message used in tests for multiple packages.

func NewMockNvmeController

func NewMockNvmeController(
	pciAddr string, fwRev string, model string, serial string,
	nss []*ctlpb.NvmeController_Namespace, hs *ctlpb.NvmeController_Health) *ctlpb.NvmeController

NewMockNvmeController generates specific protobuf controller message

Types

type NvmeController

type NvmeController ctlpb.NvmeController

func (*NvmeController) AsProto

func (pb *NvmeController) AsProto() *ctlpb.NvmeController

func (*NvmeController) FromNative

func (pb *NvmeController) FromNative(native *storage.NvmeController) error

func (*NvmeController) ToNative

func (pb *NvmeController) ToNative() (*storage.NvmeController, error)

type NvmeControllerResults

type NvmeControllerResults []*ctlpb.NvmeControllerResult

NvmeControllerResults is an alias for protobuf NvmeControllerResult messages representing operation results on a number of NVMe controllers.

func (NvmeControllerResults) HasErrors

func (ncr NvmeControllerResults) HasErrors() bool

type NvmeControllers

type NvmeControllers []*ctlpb.NvmeController

NvmeControllers is an alias for protobuf NvmeController message slice representing a number of NVMe SSD controllers installed on a storage node.

func (*NvmeControllers) FromNative

func (pb *NvmeControllers) FromNative(native storage.NvmeControllers) error

func (NvmeControllers) String

func (ncs NvmeControllers) String() string

func (NvmeControllers) StringHealthStats

func (ncs NvmeControllers) StringHealthStats() string

StringHealthStats returns full string representation including NVMe health statistics as well as controller and namespace details.

func (NvmeControllers) Summary

func (ncs NvmeControllers) Summary() string

Summary reports accumulated storage space and the number of controllers.

func (NvmeControllers) ToNative

func (pb NvmeControllers) ToNative() (storage.NvmeControllers, error)

type NvmeDeviceHealth

type NvmeDeviceHealth ctlpb.NvmeController_Health

func (*NvmeDeviceHealth) AsProto

func (pb *NvmeDeviceHealth) AsProto() *ctlpb.NvmeController_Health

func (*NvmeDeviceHealth) FromNative

func (pb *NvmeDeviceHealth) FromNative(native *storage.NvmeDeviceHealth) error

func (*NvmeDeviceHealth) ToNative

func (pb *NvmeDeviceHealth) ToNative() (*storage.NvmeDeviceHealth, error)

type NvmeNamespace

type NvmeNamespace ctlpb.NvmeController_Namespace

func (*NvmeNamespace) AsProto

func (pb *NvmeNamespace) AsProto() *ctlpb.NvmeController_Namespace

func (*NvmeNamespace) FromNative

func (pb *NvmeNamespace) FromNative(native *storage.NvmeNamespace) error

func (*NvmeNamespace) ToNative

func (pb *NvmeNamespace) ToNative() (*storage.NvmeNamespace, error)

type NvmeNamespaces

type NvmeNamespaces []*ctlpb.NvmeController_Namespace

NvmeNamespaces is an alias for protobuf NvmeController_Namespace message slice representing namespaces existing on a NVMe SSD.

type ScmModuleResults

type ScmModuleResults []*ctlpb.ScmModuleResult

ScmModuleResults is an alias for protobuf ScmModuleResult message slice representing operation results on a number of SCM modules.

type ScmModules

type ScmModules []*ctlpb.ScmModule

ScmModules is an alias for protobuf ScmModule message slice representing a number of SCM modules installed on a storage node.

type ScmMountResults

type ScmMountResults []*ctlpb.ScmMountResult

ScmMountResults is an alias for protobuf ScmMountResult message slice representing operation results on a number of SCM mounts.

func (ScmMountResults) HasErrors

func (smr ScmMountResults) HasErrors() bool

type ScmMounts

type ScmMounts []*ctlpb.ScmMount

ScmMounts are protobuf representations of mounted SCM namespaces identified by mount points

type ScmNamespaces

type ScmNamespaces []*ctlpb.PmemDevice

ScmNamespaces is an alias for protobuf PmemDevice message slice representing a number of PMEM device files created on SCM namespaces on a storage node.

func (ScmNamespaces) String

func (pds ScmNamespaces) String() string