/
storage_nvme.go
422 lines (342 loc) · 12.4 KB
/
storage_nvme.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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
//
// (C) Copyright 2022-2024 Intel Corporation.
//
// SPDX-License-Identifier: BSD-2-Clause-Patent
//
package main
import (
"os/user"
"strings"
"github.com/pkg/errors"
"github.com/daos-stack/daos/src/control/cmd/dmg/pretty"
"github.com/daos-stack/daos/src/control/lib/hardware"
"github.com/daos-stack/daos/src/control/logging"
"github.com/daos-stack/daos/src/control/server/config"
"github.com/daos-stack/daos/src/control/server/storage"
)
const cliPCIAddrSep = ","
type nvmeStorageCmd struct {
Prepare prepareNVMeCmd `command:"prepare" description:"Prepare NVMe SSDs for use by DAOS"`
Reset resetNVMeCmd `command:"reset" description:"Reset NVMe SSDs for use by OS"`
Scan scanNVMeCmd `command:"scan" description:"Scan NVMe SSDs"`
}
func getTargetUser(reqUser string) (string, error) {
if reqUser == "" {
runningUser, err := user.Current()
if err != nil {
return "", errors.Wrap(err, "couldn't lookup running user")
}
if runningUser.Username == "" {
return "", errors.New("empty username returned from current user lookup")
}
return runningUser.Username, nil
}
return reqUser, nil
}
func validateVFIOSetting(targetUser string, reqDisableVFIO bool, iommuEnabled bool) error {
if targetUser != "root" {
if reqDisableVFIO {
return storage.FaultBdevNonRootVFIODisable
}
if !iommuEnabled {
return storage.FaultBdevNoIOMMU
}
}
return nil
}
func nvmeBdevsFromCfg(cfg *config.Server) *storage.BdevDeviceList {
if cfg == nil {
return nil
}
// Combine engine bdev_lists to create total device list.
var bdevCfgs storage.TierConfigs
for _, ec := range cfg.Engines {
bdevCfgs = append(bdevCfgs, ec.Storage.Tiers.BdevConfigs()...)
}
bds := bdevCfgs.NVMeBdevs()
if bds.Len() == 0 {
return nil
}
return bds
}
func updateNVMePrepReqFromConfig(log logging.Logger, cfg *config.Server, req *storage.BdevPrepareRequest) error {
if cfg == nil {
log.Debugf("skip updating request from config")
return nil
}
for idx, ec := range cfg.Engines {
ec.ConvertLegacyStorage(log, idx)
}
if cfg.DisableHugepages {
return errors.New("hugepage usage has been disabled in the config file")
}
req.DisableVFIO = req.DisableVFIO || cfg.DisableVFIO
if req.HugepageCount == 0 && cfg.NrHugepages > 0 {
req.HugepageCount = cfg.NrHugepages
}
if req.PCIAllowList == "" {
allowed := nvmeBdevsFromCfg(cfg)
if allowed.Len() != 0 {
log.Tracef("reading bdev_list entries (%q) from cfg", allowed)
req.PCIAllowList = strings.Join(allowed.Strings(), storage.BdevPciAddrSep)
}
}
if req.PCIBlockList == "" && len(cfg.BdevExclude) > 0 {
blocked, err := hardware.NewPCIAddressSet(cfg.BdevExclude...)
if err != nil {
return errors.Wrap(err, "invalid addresses in pci block list")
}
if blocked.Len() != 0 {
log.Tracef("reading bdev_exclude entries (%q) from cfg", blocked)
req.PCIBlockList = strings.Join(blocked.Strings(), storage.BdevPciAddrSep)
}
}
return nil
}
// Commandline PCI address lists will be comma-separated, sanitize into expected format.
func sanitizePCIAddrLists(req *storage.BdevPrepareRequest) error {
if !strings.Contains(req.PCIAllowList, " ") {
allowed, err := hardware.NewPCIAddressSet(strings.Split(req.PCIAllowList, cliPCIAddrSep)...)
if err != nil {
return errors.Wrap(err, "invalid addresses in pci allow list")
}
req.PCIAllowList = strings.Join(allowed.Strings(), storage.BdevPciAddrSep)
}
if !strings.Contains(req.PCIBlockList, " ") {
blocked, err := hardware.NewPCIAddressSet(strings.Split(req.PCIBlockList, cliPCIAddrSep)...)
if err != nil {
return errors.Wrap(err, "invalid addresses in pci block list")
}
req.PCIBlockList = strings.Join(blocked.Strings(), storage.BdevPciAddrSep)
}
return nil
}
type prepareNVMeCmd struct {
nvmeCmd
PCIBlockList string `long:"pci-block-list" description:"Comma-separated list of PCI devices (by address) to be ignored when unbinding devices from Kernel driver to be used with SPDK (default is no PCI devices)"`
NrHugepages int `short:"p" long:"hugepages" description:"Number of hugepages to allocate for use by SPDK (default 1024)"`
TargetUser string `short:"u" long:"target-user" description:"User that will own hugepage mountpoint directory and vfio groups."`
DisableVFIO bool `long:"disable-vfio" description:"Force SPDK to use the UIO driver for NVMe device access"`
Args struct {
PCIAllowList string `positional-arg-name:"pci-allow-list" description:"Comma-separated list of PCI devices (by address) to be unbound from Kernel driver and used with SPDK (default is all PCI devices)"`
} `positional-args:"yes"`
}
func (cmd *prepareNVMeCmd) WithDisableVFIO(b bool) *prepareNVMeCmd {
cmd.DisableVFIO = b
return cmd
}
func (cmd *prepareNVMeCmd) WithTargetUser(u string) *prepareNVMeCmd {
cmd.TargetUser = u
return cmd
}
func (cmd *prepareNVMeCmd) WithPCIAllowList(al string) *prepareNVMeCmd {
cmd.Args.PCIAllowList = al
return cmd
}
func (cmd *prepareNVMeCmd) WithIgnoreConfig(b bool) *prepareNVMeCmd {
cmd.IgnoreConfig = b
return cmd
}
func isVMDEnabled(cfg *config.Server) bool {
return cfg == nil || cfg.DisableVMD == nil || !*(cfg.DisableVMD)
}
func processNVMePrepReq(log logging.Logger, cfg *config.Server, iommuChecker hardware.IOMMUDetector, req *storage.BdevPrepareRequest) error {
if err := sanitizePCIAddrLists(req); err != nil {
return errors.Wrap(err, "sanitizing cli input pci address lists")
}
if err := updateNVMePrepReqFromConfig(log, cfg, req); err != nil {
return errors.Wrap(err, "updating request parameters with config file settings")
}
iommuEnabled, err := iommuChecker.IsIOMMUEnabled()
if err != nil {
return errors.Wrap(err, "verifying iommu capability on host")
}
targetUser, err := getTargetUser(req.TargetUser)
if err != nil {
return err
}
// Update target user parameter in request.
req.TargetUser = targetUser
if err := validateVFIOSetting(targetUser, req.DisableVFIO, iommuEnabled); err != nil {
return err
}
switch {
case !isVMDEnabled(cfg):
log.Info("VMD not enabled because VMD disabled in config file")
case req.DisableVFIO:
log.Info("VMD not enabled because VFIO disabled in command options")
case !iommuEnabled:
log.Info("VMD not enabled because IOMMU disabled on platform")
default:
// If none of the cases above match, set enable VMD flag in request.
req.EnableVMD = true
}
return nil
}
func prepareNVMe(req storage.BdevPrepareRequest, cmd *nvmeCmd) error {
cmd.Debug("Prepare locally-attached NVMe storage...")
if err := processNVMePrepReq(cmd.Logger, cmd.config, cmd, &req); err != nil {
return errors.Wrap(err, "processing request parameters")
}
cmd.Tracef("nvme prepare request parameters: %+v", req)
// Prepare NVMe device access.
_, err := cmd.ctlSvc.NvmePrepare(req)
return errors.Wrap(err, "nvme prepare backend")
}
func (cmd *prepareNVMeCmd) Execute(_ []string) (err error) {
cmd.Debugf("executing prepare drives command: %+v", cmd)
req := storage.BdevPrepareRequest{
HugepageCount: cmd.NrHugepages,
TargetUser: cmd.TargetUser,
PCIAllowList: cmd.Args.PCIAllowList,
PCIBlockList: cmd.PCIBlockList,
DisableVFIO: cmd.DisableVFIO,
}
return prepareNVMe(req, &cmd.nvmeCmd)
}
type resetNVMeCmd struct {
nvmeCmd
PCIBlockList string `long:"pci-block-list" description:"Comma-separated list of PCI devices (by address) to be ignored when unbinding devices from Kernel driver to be used with SPDK (default is no PCI devices)"`
TargetUser string `short:"u" long:"target-user" description:"User that will own hugepage mountpoint directory and vfio groups."`
DisableVFIO bool `long:"disable-vfio" description:"Force SPDK to use the UIO driver for NVMe device access"`
Args struct {
PCIAllowList string `positional-arg-name:"pci-allow-list" description:"Comma-separated list of PCI devices (by address) to be unbound from Kernel driver and used with SPDK (default is all PCI devices)"`
} `positional-args:"yes"`
}
func (cmd *resetNVMeCmd) WithDisableVFIO(b bool) *resetNVMeCmd {
cmd.DisableVFIO = b
return cmd
}
func (cmd *resetNVMeCmd) WithTargetUser(u string) *resetNVMeCmd {
cmd.TargetUser = u
return cmd
}
func (cmd *resetNVMeCmd) WithPCIAllowList(al string) *resetNVMeCmd {
cmd.Args.PCIAllowList = al
return cmd
}
func (cmd *resetNVMeCmd) WithIgnoreConfig(b bool) *resetNVMeCmd {
cmd.IgnoreConfig = b
return cmd
}
func resetNVMe(resetReq storage.BdevPrepareRequest, cmd *nvmeCmd) error {
cmd.Debug("Reset locally-attached NVMe storage...")
cleanReq := storage.BdevPrepareRequest{
CleanHugepagesOnly: true,
}
msg := "cleanup hugepages before nvme reset"
if resp, err := cmd.ctlSvc.NvmePrepare(cleanReq); err != nil {
cmd.Errorf("%s", errors.Wrap(err, msg))
} else {
cmd.Debugf("%s: %d removed", msg, resp.NrHugepagesRemoved)
}
if err := processNVMePrepReq(cmd.Logger, cmd.config, cmd, &resetReq); err != nil {
return errors.Wrap(err, "processing request parameters")
}
// Apply request parameter field values required specifically for reset operation.
resetReq.HugepageCount = 0
resetReq.HugeNodes = ""
resetReq.CleanHugepagesOnly = false
resetReq.Reset_ = true
cmd.Tracef("nvme reset request parameters: %+v", resetReq)
resetResp, err := cmd.ctlSvc.NvmePrepare(resetReq)
if err != nil {
return errors.Wrap(err, "nvme reset backend")
}
// SPDK-2926: If VMD has been detected, perform an extra SPDK reset (without PCI_ALLOWED)
// to reset dangling NVMe devices left unbound after the DRIVER_OVERRIDE=none
// setup call was used in nvme prepare. This is required in the situation where
// VMD is enabled and PCI_ALLOWED list is set to a subset of VMD controllers
// (as specified in the server config file) then the backing devices of the
// unselected VMD controllers will be bound to no driver and therefore
// inaccessible from both OS and SPDK. Workaround is to run nvme scan
// --ignore-config to reset driver bindings.
if resetResp.VMDPrepared {
resetReq.PCIAllowList = ""
resetReq.PCIBlockList = ""
resetReq.EnableVMD = false // Prevents VMD endpoints being auto populated
cmd.Tracef("vmd second nvme reset request parameters: %+v", resetReq)
if _, err := cmd.ctlSvc.NvmePrepare(resetReq); err != nil {
return errors.Wrap(err, "nvme reset backend")
}
}
return nil
}
func (cmd *resetNVMeCmd) Execute(_ []string) (err error) {
cmd.Debugf("executing reset nvme command: %+v", cmd)
req := storage.BdevPrepareRequest{
TargetUser: cmd.TargetUser,
PCIAllowList: cmd.Args.PCIAllowList,
PCIBlockList: cmd.PCIBlockList,
DisableVFIO: cmd.DisableVFIO,
}
return resetNVMe(req, &cmd.nvmeCmd)
}
type scanNVMeCmd struct {
nvmeCmd
DisableVMD bool `long:"disable-vmd" description:"Disable VMD-aware scan."`
SkipPrep bool `long:"skip-prep" description:"Skip preparation of devices during scan."`
}
func (cmd *scanNVMeCmd) getVMDState() bool {
if cmd.DisableVMD {
return false
}
return isVMDEnabled(cmd.config)
}
func scanNVMe(cmd *scanNVMeCmd) (_ *storage.BdevScanResponse, errOut error) {
if cmd.getVMDState() {
cmd.ctlSvc.WithVMDEnabled()
}
req := storage.BdevScanRequest{}
if cmd.config != nil {
req.DeviceList = nvmeBdevsFromCfg(cmd.config)
if req.DeviceList.Len() > 0 {
cmd.Debugf("applying devices filter derived from config file: %s",
req.DeviceList)
}
}
reqPrep := storage.BdevPrepareRequest{
PCIAllowList: strings.Join(req.DeviceList.Devices(),
storage.BdevPciAddrSep),
}
if !cmd.SkipPrep {
if err := prepareNVMe(reqPrep, &cmd.nvmeCmd); err != nil {
return nil, errors.Wrap(err, "nvme prep before scan failed, try with "+
"--skip-prep after manual nvme prepare")
}
defer func() {
if err := resetNVMe(reqPrep, &cmd.nvmeCmd); err != nil {
err = errors.Wrap(err, "nvme reset after scan failed, "+
"try with --skip-prep before manual nvme reset")
if errOut == nil {
errOut = err
return
}
cmd.Error(err.Error())
}
}()
}
cmd.Info("Scan locally-attached NVMe storage...")
cmd.Tracef("nvme scan request: %+v", req)
return cmd.ctlSvc.NvmeScan(req)
}
func (cmd *scanNVMeCmd) Execute(_ []string) (err error) {
cmd.Debugf("executing scan nvme command: %+v", cmd)
resp, err := scanNVMe(cmd)
if err != nil {
return errors.Wrap(err, "nvme scan backend")
}
cmd.Tracef("scm scan response: %+v", resp)
if cmd.JSONOutputEnabled() {
if err := cmd.OutputJSON(resp.Controllers, nil); err != nil {
return err
}
return nil
}
var bld strings.Builder
if err := pretty.PrintNvmeControllers(resp.Controllers, &bld); err != nil {
return err
}
cmd.Info(bld.String())
return nil
}