-
Notifications
You must be signed in to change notification settings - Fork 291
/
ctl_smd_rpc.go
532 lines (451 loc) · 14.2 KB
/
ctl_smd_rpc.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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
//
// (C) Copyright 2020-2023 Intel Corporation.
//
// SPDX-License-Identifier: BSD-2-Clause-Patent
//
package server
import (
"context"
"fmt"
"sort"
"strings"
"time"
uuid "github.com/google/uuid"
"github.com/pkg/errors"
"google.golang.org/protobuf/proto"
"github.com/daos-stack/daos/src/control/common"
"github.com/daos-stack/daos/src/control/common/proto/convert"
ctlpb "github.com/daos-stack/daos/src/control/common/proto/ctl"
"github.com/daos-stack/daos/src/control/drpc"
"github.com/daos-stack/daos/src/control/lib/daos"
"github.com/daos-stack/daos/src/control/lib/hardware"
"github.com/daos-stack/daos/src/control/lib/ranklist"
"github.com/daos-stack/daos/src/control/logging"
)
// Set as variables so can be overwritten during unit testing.
var (
baseDevReplaceBackoff = 250 * time.Millisecond
maxDevReplaceBackoffFactor = 7 // 8s
maxDevReplaceRetries = 20
)
func queryRank(reqRank uint32, engineRank ranklist.Rank) bool {
rr := ranklist.Rank(reqRank)
if rr.Equals(ranklist.NilRank) {
return true
}
return rr.Equals(engineRank)
}
func (svc *ControlService) querySmdDevices(ctx context.Context, req *ctlpb.SmdQueryReq, resp *ctlpb.SmdQueryResp) error {
if req == nil {
return errors.New("nil request")
}
for _, ei := range svc.harness.Instances() {
if !ei.IsReady() {
svc.log.Debugf("skipping not-ready instance")
continue
}
engineRank, err := ei.GetRank()
if err != nil {
return err
}
if !queryRank(req.GetRank(), engineRank) {
svc.log.Debugf("skipping rank %d not specified in request", engineRank)
continue
}
rResp, err := smdQueryEngine(ctx, ei, req)
if err != nil {
return err
}
resp.Ranks = append(resp.Ranks, rResp)
}
return nil
}
func (svc *ControlService) querySmdPools(ctx context.Context, req *ctlpb.SmdQueryReq, resp *ctlpb.SmdQueryResp) error {
for _, ei := range svc.harness.Instances() {
if !ei.IsReady() {
svc.log.Debugf("skipping not-ready instance")
continue
}
engineRank, err := ei.GetRank()
if err != nil {
return err
}
if !queryRank(req.GetRank(), engineRank) {
svc.log.Debugf("skipping rank %d not specified in request", engineRank)
continue
}
rResp := new(ctlpb.SmdQueryResp_RankResp)
rResp.Rank = engineRank.Uint32()
dresp, err := ei.CallDrpc(ctx, drpc.MethodSmdPools, new(ctlpb.SmdPoolReq))
if err != nil {
return err
}
rankDevResp := new(ctlpb.SmdPoolResp)
if err = proto.Unmarshal(dresp.Body, rankDevResp); err != nil {
return errors.Wrap(err, "unmarshal SmdListPools response")
}
if rankDevResp.Status != 0 {
return errors.Wrapf(daos.Status(rankDevResp.Status),
"rank %d ListPools failed", engineRank)
}
if err := convert.Types(rankDevResp.Pools, &rResp.Pools); err != nil {
return errors.Wrap(err, "failed to convert pool list")
}
resp.Ranks = append(resp.Ranks, rResp)
if req.Uuid != "" {
found := false
for _, pool := range rResp.Pools {
if pool.Uuid == req.Uuid {
rResp.Pools = []*ctlpb.SmdQueryResp_Pool{pool}
found = true
break
}
}
if !found {
rResp.Pools = nil
}
}
}
return nil
}
// SmdQuery implements the method defined for the Management Service.
//
// Query SMD info for pools or devices.
func (svc *ControlService) SmdQuery(ctx context.Context, req *ctlpb.SmdQueryReq) (*ctlpb.SmdQueryResp, error) {
if !svc.harness.isStarted() {
return nil, FaultHarnessNotStarted
}
if len(svc.harness.readyRanks()) == 0 {
return nil, FaultDataPlaneNotStarted
}
if req.Uuid != "" && (!req.OmitDevices && !req.OmitPools) {
return nil, errors.New("UUID is ambiguous when querying both pools and devices")
}
resp := new(ctlpb.SmdQueryResp)
if !req.OmitDevices {
if err := svc.querySmdDevices(ctx, req, resp); err != nil {
return nil, err
}
}
if !req.OmitPools {
if err := svc.querySmdPools(ctx, req, resp); err != nil {
return nil, err
}
}
return resp, nil
}
type idMap map[string]bool
func (im idMap) Keys() (keys []string) {
for k := range im {
keys = append(keys, k)
}
return
}
// Split IDs in comma separated string and assign each token to relevant return list.
func extractReqIDs(log logging.Logger, ids string, addrs idMap, uuids idMap) error {
tokens := strings.Split(ids, ",")
for _, token := range tokens {
if addr, e := hardware.NewPCIAddress(token); e == nil && addr.IsVMDBackingAddress() {
addrs[addr.String()] = true
continue
}
if uuid, e := uuid.Parse(token); e == nil {
uuids[uuid.String()] = true
continue
}
return errors.Errorf("req id entry %q is neither a valid vmd backing device pci "+
"address or uuid", token)
}
return nil
}
// Union type containing either traddr or uuid.
type devID struct {
trAddr string
uuid string
}
func (id *devID) String() string {
if id.trAddr != "" {
return id.trAddr
}
return id.uuid
}
type devIDMap map[string]devID
func (dim devIDMap) getFirst() *devID {
if len(dim) == 0 {
return nil
}
var keys []string
for key := range dim {
keys = append(keys, key)
}
sort.Strings(keys)
d := dim[keys[0]]
return &d
}
type engineDevMap map[Engine]devIDMap
func (edm engineDevMap) add(e Engine, id devID) {
if _, exists := edm[e]; !exists {
edm[e] = make(devIDMap)
}
if _, exists := edm[e][id.String()]; !exists {
edm[e][id.String()] = id
}
}
// Map requested device IDs provided in comma-separated string to the engine that controls the given
// device. Device can be identified either by UUID or transport (PCI) address.
func (svc *ControlService) mapIDsToEngine(ctx context.Context, ids string, useTrAddr bool) (engineDevMap, error) {
trAddrs := make(idMap)
devUUIDs := make(idMap)
matchAll := false
if ids == "" {
// Selecting all is not supported unless using transport addresses.
if !useTrAddr {
return nil, errors.New("empty id string")
}
matchAll = true
} else {
// Extract transport addresses and device UUIDs from IDs string.
if err := extractReqIDs(svc.log, ids, trAddrs, devUUIDs); err != nil {
return nil, err
}
}
req := &ctlpb.SmdQueryReq{Rank: uint32(ranklist.NilRank)}
resp := new(ctlpb.SmdQueryResp)
if err := svc.querySmdDevices(ctx, req, resp); err != nil {
return nil, err
}
edm := make(engineDevMap)
for _, rr := range resp.Ranks {
engines, err := svc.harness.FilterInstancesByRankSet(fmt.Sprintf("%d", rr.Rank))
if err != nil {
return nil, err
}
if len(engines) == 0 {
return nil, errors.Errorf("failed to retrieve instance for rank %d",
rr.Rank)
}
engine := engines[0]
for _, dev := range rr.Devices {
if dev == nil {
return nil, errors.New("nil device in smd query resp")
}
if dev.Ctrlr.PciAddr == "" {
svc.log.Errorf("No transport address associated with device %s",
dev.Uuid)
}
matchUUID := dev.Uuid != "" && devUUIDs[dev.Uuid]
// Where possible specify the TrAddr over UUID as there may be multiple
// UUIDs mapping to the same TrAddr.
if useTrAddr && dev.Ctrlr.PciAddr != "" {
if matchAll || matchUUID || trAddrs[dev.Ctrlr.PciAddr] {
// If UUID matches, add by TrAddr rather than UUID which
// should avoid duplicate UUID entries for the same TrAddr.
edm.add(engine, devID{trAddr: dev.Ctrlr.PciAddr})
delete(trAddrs, dev.Ctrlr.PciAddr)
delete(devUUIDs, dev.Uuid)
continue
}
}
if matchUUID {
// Only add UUID entry if TrAddr is not available for a device.
edm.add(engine, devID{uuid: dev.Uuid})
delete(devUUIDs, dev.Uuid)
}
}
}
// Check all input IDs have been matched.
missingKeys := append(devUUIDs.Keys(), trAddrs.Keys()...)
if len(missingKeys) > 0 {
return nil, errors.Errorf("ids requested but not found: %v", missingKeys)
}
return edm, nil
}
func sendManageReq(c context.Context, e Engine, m drpc.Method, b proto.Message) (*ctlpb.SmdManageResp_Result, error) {
if !e.IsReady() {
return &ctlpb.SmdManageResp_Result{
Status: daos.Unreachable.Int32(),
}, nil
}
dResp, err := e.CallDrpc(c, m, b)
if err != nil {
return nil, errors.Wrap(err, "call drpc")
}
mResp := new(ctlpb.DevManageResp)
if err = proto.Unmarshal(dResp.Body, mResp); err != nil {
return nil, errors.Wrapf(err, "unmarshal %T response", mResp)
}
return &ctlpb.SmdManageResp_Result{
Status: mResp.Status, Device: mResp.Device,
}, nil
}
func addManageRespIDOnFail(log logging.Logger, res *ctlpb.SmdManageResp_Result, dev *devID) {
if res == nil || dev == nil || res.Status == 0 {
return
}
log.Errorf("drpc returned status %q on dev %+v", daos.Status(res.Status), dev)
if res.Device == nil {
// Populate id so failure can be mapped to a device.
res.Device = &ctlpb.SmdDevice{
Ctrlr: &ctlpb.NvmeController{
PciAddr: dev.trAddr,
},
Uuid: dev.uuid,
}
}
}
// Retry dev-replace requests as state propagation may take some time after set-faulty call has
// been made to manually trigger a faulty device state.
func replaceDevRetryBusy(ctx context.Context, log logging.Logger, e Engine, req proto.Message) (res *ctlpb.SmdManageResp_Result, err error) {
for try := 0; try < maxDevReplaceRetries; try++ {
res, err = sendManageReq(ctx, e, drpc.MethodReplaceStorage, req)
if err != nil {
return
}
if daos.Status(res.Status) != daos.Busy || try == maxDevReplaceRetries-1 {
break
}
backoff := common.ExpBackoff(baseDevReplaceBackoff, uint64(try),
uint64(maxDevReplaceBackoffFactor))
log.Debugf("retrying dev-replace drpc request after %s", backoff)
select {
case <-ctx.Done():
err = ctx.Err()
return
case <-time.After(backoff):
}
}
return
}
func (svc *ControlService) singleDevSmdManage(ctx context.Context, req *ctlpb.SmdManageReq, id string) ([]*ctlpb.SmdManageResp_RankResp, error) {
// Evaluate which engine(s) to send requests to.
engineDevMap, err := svc.mapIDsToEngine(ctx, id, false)
if err != nil {
return nil, errors.Wrap(err, "mapping device identifiers to engine")
}
if len(engineDevMap) != 1 {
return nil, errors.Errorf("%T request expects only one engine in device map",
req.Op)
}
var engine Engine
for engine, _ = range engineDevMap {
break
}
devs := engineDevMap[engine]
if len(devs) != 1 {
return nil, errors.Errorf("%T request expects only one device in map", req.Op)
}
rank, err := engine.GetRank()
if err != nil {
return nil, errors.Wrap(err, "retrieving engine rank")
}
var devRes *ctlpb.SmdManageResp_Result
msg := fmt.Sprintf("CtlSvc.SmdManage dispatch, rank %d", rank)
// Extract request from oneof field and execute dRPC.
switch req.Op.(type) {
case *ctlpb.SmdManageReq_Replace:
dReq := req.GetReplace()
msg := fmt.Sprintf("%s dev-replace", msg)
devRes, err = replaceDevRetryBusy(ctx, svc.log, engine, dReq)
svc.log.Tracef("%s: req %+v, resp %+v", msg, dReq, devRes)
case *ctlpb.SmdManageReq_Faulty:
dReq := req.GetFaulty()
msg := fmt.Sprintf("%s set-faulty", msg)
devRes, err = sendManageReq(ctx, engine, drpc.MethodSetFaultyState, dReq)
svc.log.Tracef("%s: req %+v, resp %+v", msg, dReq, devRes)
default:
return nil, errors.Errorf("unexpected smd manage request type, want "+
"SmdManageReq_(Replace|Faulty) got %T", req.Op)
}
if err != nil {
return nil, errors.Wrap(err, msg)
}
return []*ctlpb.SmdManageResp_RankResp{
{
Rank: rank.Uint32(), Results: []*ctlpb.SmdManageResp_Result{
{Status: devRes.Status},
},
},
}, nil
}
func (svc *ControlService) multiDevSmdManage(ctx context.Context, req *ctlpb.SmdManageReq, ids string) ([]*ctlpb.SmdManageResp_RankResp, error) {
// Only LED manage requests currently support operation over multiple devices.
if _, ok := req.Op.(*ctlpb.SmdManageReq_Led); !ok {
return nil, errors.Errorf("unexpected smd manage request type, want "+
"SmdManageReq_Led got %T", req.Op)
}
// Evaluate which engine(s) to send requests to. The last bool param indicates that the
// Device-UUID can be replaced with its parent NVMe controller address during processing of
// the request.
engineDevMap, err := svc.mapIDsToEngine(ctx, ids, true)
if err != nil {
return nil, errors.Wrap(err, "mapping device identifiers to engine")
}
if len(engineDevMap) == 0 {
return nil, errors.Errorf("%T request expects at least one engine in device map",
req.Op)
}
var rankResps []*ctlpb.SmdManageResp_RankResp
for engine, devs := range engineDevMap {
devResults := []*ctlpb.SmdManageResp_Result{}
if len(devs) == 0 {
return nil, errors.Errorf("%T request expects at least one device in map",
req.Op)
}
rank, err := engine.GetRank()
if err != nil {
return nil, errors.Wrap(err, "retrieving engine rank")
}
msg := fmt.Sprintf("CtlSvc.SmdManage dispatch, rank %d led-manage", rank)
// Multiple addresses are supported in LED request.
for _, dev := range devs {
dReq := req.GetLed()
// ID should by now have been resolved to a transport (PCI) address.
if dev.trAddr == "" {
return nil, errors.Errorf("device UUID %s not resolved to a PCI "+
"address", dev.uuid)
}
dReq.Ids = dev.trAddr
devRes, err := sendManageReq(ctx, engine, drpc.MethodLedManage, dReq)
if err != nil {
return nil, errors.Wrap(err, msg)
}
addManageRespIDOnFail(svc.log, devRes, &dev)
svc.log.Tracef("%s: req %+v, resp %+v", msg, dReq, devRes)
devResults = append(devResults, devRes)
}
rankResps = append(rankResps, &ctlpb.SmdManageResp_RankResp{
Rank: rank.Uint32(), Results: devResults,
})
}
sort.Slice(rankResps, func(i, j int) bool {
return rankResps[i].Rank < rankResps[j].Rank
})
return rankResps, nil
}
// SmdManage implements the method defined for the Management Service.
//
// Manage SMD devices.
func (svc *ControlService) SmdManage(ctx context.Context, req *ctlpb.SmdManageReq) (*ctlpb.SmdManageResp, error) {
if !svc.harness.isStarted() {
return nil, FaultHarnessNotStarted
}
if len(svc.harness.readyRanks()) == 0 {
return nil, FaultDataPlaneNotStarted
}
var rankResps []*ctlpb.SmdManageResp_RankResp
var err error
switch req.Op.(type) {
case *ctlpb.SmdManageReq_Replace:
rankResps, err = svc.singleDevSmdManage(ctx, req, req.GetReplace().OldDevUuid)
case *ctlpb.SmdManageReq_Faulty:
rankResps, err = svc.singleDevSmdManage(ctx, req, req.GetFaulty().Uuid)
case *ctlpb.SmdManageReq_Led:
rankResps, err = svc.multiDevSmdManage(ctx, req, req.GetLed().Ids)
default:
return nil, errors.Errorf("Unrecognized operation in SmdManageReq: %+v", req.Op)
}
if err != nil {
return nil, err
}
return &ctlpb.SmdManageResp{Ranks: rankResps}, nil
}