-
Notifications
You must be signed in to change notification settings - Fork 292
/
types.go
218 lines (181 loc) · 5.87 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
//
// (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.
//
package storage
import (
"bytes"
"fmt"
"sort"
"github.com/inhies/go-bytesize"
"github.com/daos-stack/daos/src/control/common"
)
// ScmState represents the probed state of SCM modules on the system.
//go:generate stringer -type=ScmState
type ScmState int
const (
// ScmStateUnknown represents the default (unknown) state.
ScmStateUnknown ScmState = iota
// ScmStateNoRegions indicates that SCM modules exist, but
// no regions have been created.
ScmStateNoRegions
// ScmStateFreeCapacity indicates that SCM modules exist with
// configured regions that have available capacity.
ScmStateFreeCapacity
// ScmStateNoCapacity indicates that SCM modules exist with
// configured regions but not available capacity.
ScmStateNoCapacity
)
type (
// ScmModule represents a SCM DIMM.
//
// This is a simplified representation of the raw struct used in the ipmctl package.
ScmModule struct {
ChannelID uint32
ChannelPosition uint32
ControllerID uint32
SocketID uint32
PhysicalID uint32
Capacity uint64
}
// ScmModules is a type alias for []ScmModule that implements fmt.Stringer.
ScmModules []ScmModule
// ScmNamespace represents a mapping of AppDirect regions to block device files.
ScmNamespace struct {
UUID string `json:"uuid"`
BlockDevice string `json:"blockdev"`
Name string `json:"dev"`
NumaNode uint32 `json:"numa_node"`
Size uint64 `json:"size"`
}
// ScmNamespaces is a type alias for []ScmNamespace that implements fmt.Stringer.
ScmNamespaces []ScmNamespace
// NvmeDeviceHealth represents a set of health statistics for a NVMe device.
NvmeDeviceHealth struct {
Temp uint32
TempWarnTime uint32
TempCritTime uint32
CtrlBusyTime uint64
PowerCycles uint64
PowerOnHours uint64
UnsafeShutdowns uint64
MediaErrors uint64
ErrorLogEntries uint64
TempWarn bool
AvailSpareWarn bool
ReliabilityWarn bool
ReadOnlyWarn bool
VolatileWarn bool
}
// NvmeNamespace represents an individual NVMe namespace on a device.
NvmeNamespace struct {
ID int32
Size int32
}
// NvmeController represents a NVMe device controller which includes health
// and namespace information.
NvmeController struct {
Model string
Serial string
PciAddr string
FwRev string
SocketID int32
HealthStats *NvmeDeviceHealth
Namespaces []*NvmeNamespace
}
// NvmeControllers is a type alias for []*NvmeController which implements fmt.Stringer.
NvmeControllers []*NvmeController
)
func (m *ScmModule) String() string {
return fmt.Sprintf("PhysicalID:%d Capacity:%s Location:(socket:%d memctrlr:%d "+
"chan:%d pos:%d)", m.PhysicalID, bytesize.New(float64(m.Capacity)),
m.SocketID, m.ControllerID, m.ChannelID, m.ChannelPosition)
}
func (ms ScmModules) String() string {
var buf bytes.Buffer
if len(ms) == 0 {
return "\t\tnone\n"
}
sort.Slice(ms, func(i, j int) bool { return ms[i].PhysicalID < ms[j].PhysicalID })
for _, m := range ms {
fmt.Fprintf(&buf, "\t\t%s\n", &m)
}
return buf.String()
}
// Summary reports accumulated storage space and the number of modules.
func (ms ScmModules) Summary() string {
tCap := bytesize.New(0)
for _, m := range ms {
tCap += bytesize.New(float64(m.Capacity))
}
return fmt.Sprintf("%s (%d %s)",
tCap, len(ms), common.Pluralise("module", len(ms)))
}
func (n *ScmNamespace) String() string {
return fmt.Sprintf("Device:%s Socket:%d Capacity:%s", n.BlockDevice, n.NumaNode,
bytesize.New(float64(n.Size)))
}
func (ns ScmNamespaces) String() string {
var buf bytes.Buffer
if len(ns) == 0 {
return "\t\tnone\n"
}
sort.Slice(ns, func(i, j int) bool { return ns[i].BlockDevice < ns[j].BlockDevice })
for _, n := range ns {
fmt.Fprintf(&buf, "\t\t%s\n", &n)
}
return buf.String()
}
// Summary reports accumulated storage space and the number of namespaces.
func (ns ScmNamespaces) Summary() string {
tCap := bytesize.New(0)
for _, n := range ns {
tCap += bytesize.New(float64(n.Size))
}
return fmt.Sprintf("%s (%d %s)",
tCap, len(ns), common.Pluralise("namespace", len(ns)))
}
// ctrlrDetail provides custom string representation for Controller type
// defined outside this package.
func (ncs NvmeControllers) ctrlrDetail(buf *bytes.Buffer, c *NvmeController) {
if c == nil {
fmt.Fprintf(buf, "<nil>\n")
return
}
tCap := bytesize.New(0)
for _, n := range c.Namespaces {
tCap += bytesize.GB * bytesize.New(float64(n.Size))
}
fmt.Fprintf(buf, "\t\tPCI:%s Model:%s FW:%s Socket:%d Capacity:%s\n",
c.PciAddr, c.Model, c.FwRev, c.SocketID, tCap)
}
func (ncs NvmeControllers) String() string {
buf := bytes.NewBufferString("NVMe controllers and namespaces:\n")
if len(ncs) == 0 {
fmt.Fprint(buf, "\t\tnone\n")
return buf.String()
}
sort.Slice(ncs, func(i, j int) bool { return ncs[i].PciAddr < ncs[j].PciAddr })
for _, ctrlr := range ncs {
ncs.ctrlrDetail(buf, ctrlr)
}
return buf.String()
}