/
ctl_ranks_rpc.go
405 lines (349 loc) · 11.3 KB
/
ctl_ranks_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
//
// (C) Copyright 2020-2023 Intel Corporation.
//
// SPDX-License-Identifier: BSD-2-Clause-Patent
//
package server
import (
"context"
"syscall"
"time"
"github.com/pkg/errors"
"google.golang.org/protobuf/proto"
"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/events"
"github.com/daos-stack/daos/src/control/lib/daos"
"github.com/daos-stack/daos/src/control/lib/ranklist"
"github.com/daos-stack/daos/src/control/server/engine"
"github.com/daos-stack/daos/src/control/system"
)
const (
// instanceUpdateDelay is the polling time period
instanceUpdateDelay = 500 * time.Millisecond
)
// pollInstanceState waits for either context to be cancelled/timeout or for the
// provided validate function to return true for each of the provided instances.
//
// Returns true if all instances return true from the validate function, false
// if context is cancelled before.
func pollInstanceState(ctx context.Context, instances []Engine, validate func(Engine) bool) error {
ready := make(chan struct{})
go func() {
for {
select {
case <-ctx.Done():
return
default:
}
success := true
for _, ei := range instances {
if !validate(ei) {
success = false
}
}
if success {
close(ready)
return
}
time.Sleep(instanceUpdateDelay)
}
}()
select {
case <-ctx.Done():
return ctx.Err()
case <-ready:
return nil
}
}
// PrepShutdownRanks implements the method defined for the Management Service.
//
// Prepare data-plane instance(s) managed by control-plane for a controlled shutdown,
// identified by unique rank(s).
//
// Iterate over local instances, issue PrepShutdown dRPCs and record results.
func (svc *ControlService) PrepShutdownRanks(ctx context.Context, req *ctlpb.RanksReq) (*ctlpb.RanksResp, error) {
if req == nil {
return nil, errors.New("nil request")
}
if len(req.GetRanks()) == 0 {
return nil, errors.New("no ranks specified in request")
}
// iterate over local instances issuing dRPC requests in parallel and return system member
// results when all have been received.
instances, err := svc.harness.FilterInstancesByRankSet(req.GetRanks())
if err != nil {
return nil, errors.Wrap(err, "filtering instances by rank set")
}
ch := make(chan *system.MemberResult, len(instances))
for _, ei := range instances {
if !ei.IsReady() {
rank, err := ei.GetRank()
svc.log.Debugf("skip prep-shutdown as rank %d is dead", rank)
// If rank is already dead, return successful result.
ch <- system.NewMemberResult(rank, err, system.MemberStateStopped)
continue
}
go func(ctx context.Context, e Engine) {
select {
case <-ctx.Done():
ch <- nil
case ch <- e.tryDrpc(ctx, drpc.MethodPrepShutdown):
}
}(ctx, ei)
}
results := make(system.MemberResults, 0, len(instances))
for len(results) < len(instances) {
select {
case <-ctx.Done():
return nil, ctx.Err()
case result := <-ch:
if result == nil {
return nil, errors.New("tryDrpc returned nil result")
}
results = append(results, result)
}
}
resp := &ctlpb.RanksResp{}
if err := convert.Types(results, &resp.Results); err != nil {
return nil, err
}
return resp, nil
}
// memberStateResults returns system member results reflecting whether the state
// of the given member is equivalent to the supplied desired state value.
func (svc *ControlService) memberStateResults(instances []Engine, tgtState system.MemberState, okMsg, failMsg string) (system.MemberResults, error) {
results := make(system.MemberResults, 0, len(instances))
for _, ei := range instances {
rank, err := ei.GetRank()
if err != nil {
svc.log.Debugf("skip MemberResult, Instance %d GetRank(): %s", ei.Index(), err)
continue
}
state := ei.LocalState()
if state != tgtState {
results = append(results, system.NewMemberResult(rank, errors.Errorf(failMsg),
system.MemberStateErrored))
continue
}
res := system.NewMemberResult(rank, nil, state)
res.Msg = okMsg
results = append(results, res)
}
return results, nil
}
// StopRanks implements the method defined for the Management Service.
//
// Stop data-plane instance(s) managed by control-plane identified by unique
// rank(s). After attempting to stop instances through harness (when either all
// instances are stopped or timeout has occurred), populate response results
// based on local instance state.
func (svc *ControlService) StopRanks(ctx context.Context, req *ctlpb.RanksReq) (*ctlpb.RanksResp, error) {
if req == nil {
return nil, errors.New("nil request")
}
if len(req.GetRanks()) == 0 {
return nil, errors.New("no ranks specified in request")
}
signal := syscall.SIGINT
if req.Force {
signal = syscall.SIGKILL
}
instances, err := svc.harness.FilterInstancesByRankSet(req.GetRanks())
if err != nil {
return nil, err
}
// don't publish rank down events whilst performing controlled shutdown
svc.events.DisableEventIDs(events.RASEngineDied)
defer svc.events.EnableEventIDs(events.RASEngineDied)
for _, ei := range instances {
if !ei.IsStarted() {
continue
}
if err := ei.Stop(signal); err != nil {
return nil, errors.Wrapf(err, "sending %s", signal)
}
}
// ignore poll results as we gather state immediately after
pollFn := func(e Engine) bool { return !e.IsStarted() }
if err := pollInstanceState(ctx, instances, pollFn); err != nil {
return nil, errors.Wrap(err, "waiting for engines to stop")
}
results, err := svc.memberStateResults(instances, system.MemberStateStopped, "system stop",
"system stop: rank failed to stop")
if err != nil {
return nil, err
}
resp := &ctlpb.RanksResp{}
if err := convert.Types(results, &resp.Results); err != nil {
return nil, err
}
return resp, nil
}
// ResetFormatRanks implements the method defined for the Management Service.
//
// Reset storage format of data-plane instances (DAOS system members) managed
// by harness.
//
// Reset formatted state of data-plane instance(s) managed by control-plane
// identified by unique rank(s). After attempting to reset instances through
// harness (when either all instances are awaiting format or timeout has
// occurred), populate response results based on local instance state.
func (svc *ControlService) ResetFormatRanks(ctx context.Context, req *ctlpb.RanksReq) (*ctlpb.RanksResp, error) {
if req == nil {
return nil, errors.New("nil request")
}
if len(req.GetRanks()) == 0 {
return nil, errors.New("no ranks specified in request")
}
instances, err := svc.harness.FilterInstancesByRankSet(req.GetRanks())
if err != nil {
return nil, err
}
savedRanks := make(map[uint32]ranklist.Rank) // instance idx to system rank
for _, ei := range instances {
rank, err := ei.GetRank()
if err != nil {
return nil, err
}
savedRanks[ei.Index()] = rank
if ei.IsStarted() {
return nil, FaultInstancesNotStopped("reset format", rank)
}
if err := ei.RemoveSuperblock(); err != nil {
return nil, err
}
ei.requestStart(ctx)
}
// ignore poll results as we gather state immediately after
pollFn := func(e Engine) bool { return e.isAwaitingFormat() }
if err := pollInstanceState(ctx, instances, pollFn); err != nil {
return nil, errors.Wrap(err, "waiting for engines to await format")
}
// rank cannot be pulled from superblock so use saved value
results := make(system.MemberResults, 0, len(instances))
for _, ei := range instances {
var err error
state := ei.LocalState()
if state != system.MemberStateAwaitFormat {
err = errors.Errorf("want %s, got %s", system.MemberStateAwaitFormat, state)
}
results = append(results, system.NewMemberResult(savedRanks[ei.Index()], err, state))
}
resp := &ctlpb.RanksResp{}
if err := convert.Types(results, &resp.Results); err != nil {
return nil, err
}
return resp, nil
}
// StartRanks implements the method defined for the Management Service.
//
// Start data-plane instance(s) managed by control-plane identified by unique
// rank(s). After attempting to start instances through harness (when either all
// instances are in ready state or timeout has occurred), populate response results
// based on local instance state.
func (svc *ControlService) StartRanks(ctx context.Context, req *ctlpb.RanksReq) (*ctlpb.RanksResp, error) {
if req == nil {
return nil, errors.New("nil request")
}
if len(req.GetRanks()) == 0 {
return nil, errors.New("no ranks specified in request")
}
instances, err := svc.harness.FilterInstancesByRankSet(req.GetRanks())
if err != nil {
return nil, err
}
for _, ei := range instances {
ei.SetCheckerMode(req.CheckMode)
if ei.IsStarted() {
continue
}
ei.requestStart(ctx)
}
// ignore poll results as we gather state immediately after
pollFn := func(e Engine) bool { return e.IsReady() }
if err := pollInstanceState(ctx, instances, pollFn); err != nil {
return nil, errors.Wrap(err, "waiting for engines to be ready to receive drpcs")
}
// instances will update state to "Started" through join or
// bootstrap in membership, here just make sure instances are "Ready"
results, err := svc.memberStateResults(instances, system.MemberStateReady, "system start",
"system start: rank failed to start")
if err != nil {
return nil, err
}
resp := &ctlpb.RanksResp{}
if err := convert.Types(results, &resp.Results); err != nil {
return nil, err
}
return resp, nil
}
// If reset flags are set, pull values from config before merging DD_SUBSYS into D_LOG_MASK and
// setting the result in the request.
func updateSetLogMasksReq(cfg *engine.Config, req *ctlpb.SetLogMasksReq) error {
msg := "request"
if req.ResetMasks {
msg = "config"
req.Masks = cfg.LogMask
}
if req.Masks == "" {
return errors.Errorf("empty log masks in %s", msg)
}
if req.ResetStreams {
streams, err := cfg.ReadLogDbgStreams()
if err != nil {
return err
}
req.Streams = streams
}
if req.ResetSubsystems {
subsystems, err := cfg.ReadLogSubsystems()
if err != nil {
return err
}
req.Subsystems = subsystems
}
newMasks, err := engine.MergeLogEnvVars(req.Masks, req.Subsystems)
if err != nil {
return err
}
req.Masks = newMasks
req.Subsystems = ""
return nil
}
// SetEngineLogMasks calls into each engine over dRPC to set loglevel at runtime.
func (svc *ControlService) SetEngineLogMasks(ctx context.Context, req *ctlpb.SetLogMasksReq) (*ctlpb.SetLogMasksResp, error) {
if req == nil {
return nil, errors.New("nil request")
}
resp := new(ctlpb.SetLogMasksResp)
instances := svc.harness.Instances()
resp.Errors = make([]string, len(instances))
for idx, ei := range instances {
eReq := *req // local per-engine copy
if int(ei.Index()) != idx {
svc.log.Errorf("engine instance index %d doesn't match engine.Index %d",
idx, ei.Index())
}
if err := updateSetLogMasksReq(svc.srvCfg.Engines[idx], &eReq); err != nil {
resp.Errors[idx] = err.Error()
continue
}
svc.log.Debugf("setting engine %d log masks %q, streams %q and subsystems %q",
ei.Index(), eReq.Masks, eReq.Streams, eReq.Subsystems)
dresp, err := ei.CallDrpc(ctx, drpc.MethodSetLogMasks, &eReq)
if err != nil {
resp.Errors[idx] = err.Error()
continue
}
engineResp := new(ctlpb.SetLogMasksResp)
if err = proto.Unmarshal(dresp.Body, engineResp); err != nil {
return nil, err
}
if engineResp.Status != 0 {
resp.Errors[idx] = daos.Status(engineResp.Status).Error()
}
}
return resp, nil
}