-
Notifications
You must be signed in to change notification settings - Fork 297
/
server.go
646 lines (532 loc) · 16.5 KB
/
server.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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
//
// (C) Copyright 2018-2023 Intel Corporation.
//
// SPDX-License-Identifier: BSD-2-Clause-Patent
//
package server
import (
"context"
"net"
"os"
"os/signal"
"os/user"
"strings"
"sync"
"syscall"
"time"
"github.com/pkg/errors"
"google.golang.org/grpc"
"github.com/daos-stack/daos/src/control/build"
"github.com/daos-stack/daos/src/control/common"
ctlpb "github.com/daos-stack/daos/src/control/common/proto/ctl"
mgmtpb "github.com/daos-stack/daos/src/control/common/proto/mgmt"
"github.com/daos-stack/daos/src/control/events"
"github.com/daos-stack/daos/src/control/lib/control"
"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/hardware/hwprov"
"github.com/daos-stack/daos/src/control/logging"
"github.com/daos-stack/daos/src/control/security"
"github.com/daos-stack/daos/src/control/server/config"
"github.com/daos-stack/daos/src/control/server/engine"
"github.com/daos-stack/daos/src/control/server/storage"
"github.com/daos-stack/daos/src/control/system"
"github.com/daos-stack/daos/src/control/system/raft"
)
func genFiAffFn(fis *hardware.FabricInterfaceSet) config.EngineAffinityFn {
return func(l logging.Logger, e *engine.Config) (uint, error) {
iface, err := e.Fabric.GetPrimaryInterface()
if err != nil {
return 0, err
}
prov, err := e.Fabric.GetPrimaryProvider()
if err != nil {
return 0, err
}
fi, err := fis.GetInterfaceOnNetDevice(iface, prov)
if err != nil {
return 0, err
}
return fi.NUMANode, nil
}
}
// non-exported package-scope function variable for mocking in unit tests
var osSetenv = os.Setenv
func processConfig(log logging.Logger, cfg *config.Server, fis *hardware.FabricInterfaceSet, mi *common.MemInfo, lookupNetIF ifLookupFn, affSrcs ...config.EngineAffinityFn) error {
processFabricProvider(cfg)
if err := cfg.SetEngineAffinities(log, affSrcs...); err != nil {
return errors.Wrap(err, "failed to set engine affinities")
}
if err := cfg.Validate(log); err != nil {
return errors.Wrapf(err, "%s: validation failed", cfg.Path)
}
if err := cfg.SetNrHugepages(log, mi); err != nil {
return err
}
if err := cfg.SetRamdiskSize(log, mi); err != nil {
return err
}
for _, ec := range cfg.Engines {
fabricIFs, err := ec.Fabric.GetInterfaces()
if err != nil {
return err
}
for _, iface := range fabricIFs {
if err := checkFabricInterface(iface, lookupNetIF); err != nil {
return err
}
}
if err := updateFabricEnvars(log, ec, fis); err != nil {
return errors.Wrap(err, "update engine fabric envars")
}
}
cfg.SaveActiveConfig(log)
if err := setDaosHelperEnvs(cfg, osSetenv); err != nil {
return err
}
return nil
}
func processFabricProvider(cfg *config.Server) error {
providers, err := cfg.Fabric.GetProviders()
if err != nil {
return err
}
for i, p := range providers {
if shouldAppendRXM(p) {
providers[i] = p + ";ofi_rxm"
}
}
cfg.WithFabricProvider(strings.Join(providers, engine.MultiProviderSeparator))
return nil
}
func shouldAppendRXM(provider string) bool {
return provider == "ofi+verbs"
}
// server struct contains state and components of DAOS Server.
type server struct {
log logging.Logger
cfg *config.Server
hostname string
runningUser *user.User
faultDomain *system.FaultDomain
ctlAddr *net.TCPAddr
netDevClass []hardware.NetDevClass
listener net.Listener
harness *EngineHarness
membership *system.Membership
sysdb *raft.Database
pubSub *events.PubSub
evtForwarder *control.EventForwarder
evtLogger *control.EventLogger
ctlSvc *ControlService
mgmtSvc *mgmtSvc
grpcServer *grpc.Server
cbLock sync.Mutex
onEnginesStarted []func(context.Context) error
onShutdown []func()
}
func newServer(log logging.Logger, cfg *config.Server, faultDomain *system.FaultDomain) (*server, error) {
hostname, err := os.Hostname()
if err != nil {
return nil, errors.Wrap(err, "get hostname")
}
cu, err := user.Current()
if err != nil {
return nil, errors.Wrap(err, "get username")
}
harness := NewEngineHarness(log).WithFaultDomain(faultDomain)
return &server{
log: log,
cfg: cfg,
hostname: hostname,
runningUser: cu,
faultDomain: faultDomain,
harness: harness,
}, nil
}
func track(msg string) (string, time.Time) {
return msg, time.Now()
}
func (srv *server) logDuration(msg string, start time.Time) {
srv.log.Debugf("%v: %v\n", msg, time.Since(start))
}
// CreateDatabaseConfig creates a new database configuration.
func CreateDatabaseConfig(cfg *config.Server) (*raft.DatabaseConfig, error) {
dbReplicas, err := cfgGetReplicas(cfg, net.LookupIP)
if err != nil {
return nil, errors.Wrap(err, "unable to retrieve replicas from config")
}
raftDir := cfgGetRaftDir(cfg)
if raftDir == "" {
return nil, errors.New("raft directory not available (missing SCM or control metadata in config?)")
}
return &raft.DatabaseConfig{
Replicas: dbReplicas,
RaftDir: raftDir,
SystemName: cfg.SystemName,
}, nil
}
// newManagementDatabase creates a new instance of the raft-backed management database.
func newManagementDatabase(log logging.Logger, cfg *config.Server) (*raft.Database, error) {
dbCfg, err := CreateDatabaseConfig(cfg)
if err != nil {
return nil, errors.Wrap(err, "unable to create database config")
}
// If this daos_server instance ends up being the MS leader,
// this will record the DAOS system membership.
return raft.NewDatabase(log, dbCfg)
}
// createServices builds scaffolding for rpc and event services.
func (srv *server) createServices(ctx context.Context) (err error) {
srv.sysdb, err = newManagementDatabase(srv.log, srv.cfg)
if err != nil {
return
}
srv.membership = system.NewMembership(srv.log, srv.sysdb)
// Create rpcClient for inter-server communication.
cliCfg := control.DefaultConfig()
cliCfg.TransportConfig = srv.cfg.TransportConfig
rpcClient := control.NewClient(
control.WithClientComponent(build.ComponentServer),
control.WithConfig(cliCfg),
control.WithClientLogger(srv.log))
// Create event distribution primitives.
srv.pubSub = events.NewPubSub(ctx, srv.log)
srv.OnShutdown(srv.pubSub.Close)
srv.evtForwarder = control.NewEventForwarder(rpcClient, srv.cfg.AccessPoints)
srv.evtLogger = control.NewEventLogger(srv.log)
srv.ctlSvc = NewControlService(srv.log, srv.harness, srv.cfg, srv.pubSub,
hwprov.DefaultFabricScanner(srv.log))
srv.mgmtSvc = newMgmtSvc(srv.harness, srv.membership, srv.sysdb, rpcClient, srv.pubSub)
if err := srv.mgmtSvc.systemProps.UpdateCompPropVal(daos.SystemPropertyDaosSystem, func() string {
return srv.cfg.SystemName
}); err != nil {
return err
}
return nil
}
// OnEnginesStarted adds callback functions to be called when all engines have
// started up.
func (srv *server) OnEnginesStarted(fns ...func(context.Context) error) {
srv.cbLock.Lock()
srv.onEnginesStarted = append(srv.onEnginesStarted, fns...)
srv.cbLock.Unlock()
}
// OnShutdown adds callback functions to be called when the server shuts down.
func (srv *server) OnShutdown(fns ...func()) {
srv.cbLock.Lock()
srv.onShutdown = append(srv.onShutdown, fns...)
srv.cbLock.Unlock()
}
func (srv *server) shutdown() {
srv.cbLock.Lock()
onShutdownCbs := srv.onShutdown
srv.cbLock.Unlock()
for _, fn := range onShutdownCbs {
fn()
}
}
func (srv *server) setCoreDumpFilter() error {
if srv.cfg.CoreDumpFilter == 0 {
return nil
}
srv.log.Debugf("setting core dump filter to 0x%x", srv.cfg.CoreDumpFilter)
// Set core dump filter.
if err := writeCoreDumpFilter(srv.log, "/proc/self/coredump_filter", srv.cfg.CoreDumpFilter); err != nil {
return errors.Wrap(err, "failed to set core dump filter")
}
return nil
}
// initNetwork resolves local address and starts TCP listener.
func (srv *server) initNetwork() error {
defer srv.logDuration(track("time to init network"))
ctlAddr, err := getControlAddr(ctlAddrParams{
port: srv.cfg.ControlPort,
replicaAddrSrc: srv.sysdb,
lookupHost: net.LookupIP,
})
if err != nil {
return err
}
listener, err := createListener(ctlAddr, net.Listen)
if err != nil {
return err
}
srv.ctlAddr = ctlAddr
srv.listener = listener
return nil
}
func (srv *server) createEngine(ctx context.Context, idx int, cfg *engine.Config) (*EngineInstance, error) {
// Closure to join an engine instance to a system using control API.
joinFn := func(ctxIn context.Context, req *control.SystemJoinReq) (*control.SystemJoinResp, error) {
req.SetHostList(srv.cfg.AccessPoints)
req.SetSystem(srv.cfg.SystemName)
req.ControlAddr = srv.ctlAddr
return control.SystemJoin(ctxIn, srv.mgmtSvc.rpcClient, req)
}
sp := storage.DefaultProvider(srv.log, idx, &cfg.Storage).
WithVMDEnabled(srv.ctlSvc.storage.IsVMDEnabled())
engine := NewEngineInstance(srv.log, sp, joinFn, engine.NewRunner(srv.log, cfg)).
WithHostFaultDomain(srv.harness.faultDomain)
if idx == 0 {
configureFirstEngine(ctx, engine, srv.sysdb, joinFn)
}
return engine, nil
}
// addEngines creates and adds engine instances to harness then starts goroutine to execute
// callbacks when all engines are started.
func (srv *server) addEngines(ctx context.Context) error {
var allStarted sync.WaitGroup
registerTelemetryCallbacks(ctx, srv)
iommuEnabled, err := hwprov.DefaultIOMMUDetector(srv.log).IsIOMMUEnabled()
if err != nil {
return err
}
// Allocate hugepages and rebind NVMe devices to userspace drivers.
if err := prepBdevStorage(srv, iommuEnabled); err != nil {
return err
}
if len(srv.cfg.Engines) == 0 {
return nil
}
for i, c := range srv.cfg.Engines {
engine, err := srv.createEngine(ctx, i, c)
if err != nil {
return errors.Wrap(err, "creating engine instances")
}
registerEngineEventCallbacks(srv, engine, &allStarted)
if err := srv.harness.AddInstance(engine); err != nil {
return err
}
// increment count of engines waiting to start
allStarted.Add(1)
}
go func() {
srv.log.Debug("waiting for engines to start...")
allStarted.Wait()
srv.log.Debug("engines have started")
srv.cbLock.Lock()
onEnginesStartedCbs := srv.onEnginesStarted
srv.cbLock.Unlock()
for _, cb := range onEnginesStartedCbs {
if err := cb(ctx); err != nil {
srv.log.Errorf("on engines started: %s", err)
}
}
}()
return nil
}
// setupGrpc creates a new grpc server and registers services.
func (srv *server) setupGrpc() error {
srvOpts, err := getGrpcOpts(srv.log, srv.cfg.TransportConfig, srv.sysdb.IsLeader)
if err != nil {
return err
}
srv.grpcServer = grpc.NewServer(srvOpts...)
ctlpb.RegisterCtlSvcServer(srv.grpcServer, srv.ctlSvc)
srxSetting, err := getSrxSetting(srv.cfg)
if err != nil {
return err
}
providers, err := srv.cfg.Fabric.GetProviders()
if err != nil {
return err
}
clientNetHints := make([]*mgmtpb.ClientNetHint, 0, len(providers))
for i, p := range providers {
clientNetHints = append(clientNetHints, &mgmtpb.ClientNetHint{
Provider: p,
CrtTimeout: srv.cfg.Fabric.CrtTimeout,
NetDevClass: uint32(srv.netDevClass[i]),
SrvSrxSet: srxSetting,
ProviderIdx: uint32(i),
EnvVars: srv.cfg.ClientEnvVars,
})
}
srv.mgmtSvc.clientNetworkHint = clientNetHints
mgmtpb.RegisterMgmtSvcServer(srv.grpcServer, srv.mgmtSvc)
tSec, err := security.DialOptionForTransportConfig(srv.cfg.TransportConfig)
if err != nil {
return err
}
if err := srv.sysdb.ConfigureTransport(srv.grpcServer, tSec); err != nil {
return err
}
return nil
}
func (srv *server) registerEvents() {
registerFollowerSubscriptions(srv)
srv.sysdb.OnLeadershipGained(
func(ctx context.Context) error {
srv.log.Infof("MS leader running on %s", srv.hostname)
if err := srv.mgmtSvc.updateFabricProviders([]string{srv.cfg.Fabric.Provider}, srv.pubSub); err != nil {
srv.log.Errorf(err.Error())
return err
}
srv.mgmtSvc.startLeaderLoops(ctx)
registerLeaderSubscriptions(srv)
srv.log.Debugf("requesting immediate GroupUpdate after leader change")
go func() {
for {
select {
case <-ctx.Done():
return
default:
// Wait for at least one engine to be ready to service the
// GroupUpdate request.
for _, ei := range srv.harness.Instances() {
if ei.IsReady() {
srv.mgmtSvc.reqGroupUpdate(ctx, true)
return
}
}
srv.log.Debugf("no engines ready for GroupUpdate; waiting %s", groupUpdateInterval)
time.Sleep(groupUpdateInterval)
}
}
}()
return nil
},
func(ctx context.Context) error {
return srv.mgmtSvc.checkPools(ctx, true)
},
)
srv.sysdb.OnLeadershipLost(func() error {
srv.log.Infof("MS leader no longer running on %s", srv.hostname)
registerFollowerSubscriptions(srv)
return nil
})
}
func (srv *server) start(ctx context.Context) error {
defer srv.logDuration(track("time server was listening"))
go func() {
_ = srv.grpcServer.Serve(srv.listener)
}()
defer srv.grpcServer.Stop()
// noop on release builds
control.StartPProf(srv.log)
srv.log.Infof("%s v%s (pid %d) listening on %s", build.ControlPlaneName,
build.DaosVersion, os.Getpid(), srv.ctlAddr)
drpcSetupReq := &drpcServerSetupReq{
log: srv.log,
sockDir: srv.cfg.SocketDir,
engines: srv.harness.Instances(),
tc: srv.cfg.TransportConfig,
sysdb: srv.sysdb,
events: srv.pubSub,
}
// Single daos_server dRPC server to handle all engine requests
if err := drpcServerSetup(ctx, drpcSetupReq); err != nil {
return errors.WithMessage(err, "dRPC server setup")
}
defer func() {
if err := drpcCleanup(srv.cfg.SocketDir); err != nil {
srv.log.Errorf("error during dRPC cleanup: %s", err)
}
}()
srv.mgmtSvc.startAsyncLoops(ctx)
if srv.cfg.AutoFormat {
srv.log.Notice("--auto flag set on server start so formatting storage now")
if _, err := srv.ctlSvc.StorageFormat(ctx, &ctlpb.StorageFormatReq{}); err != nil {
return errors.WithMessage(err, "attempting to auto format")
}
}
return errors.Wrapf(srv.harness.Start(ctx, srv.sysdb, srv.cfg),
"%s harness exited", build.ControlPlaneName)
}
func waitFabricReady(ctx context.Context, log logging.Logger, cfg *config.Server) error {
ifaces := make([]string, 0, len(cfg.Engines))
for _, eng := range cfg.Engines {
engIfaces, err := eng.Fabric.GetInterfaces()
if err != nil {
return err
}
ifaces = append(ifaces, engIfaces...)
}
// Skip wait if no fabric interfaces specified in config.
if len(ifaces) == 0 {
return nil
}
if err := hardware.WaitFabricReady(ctx, log, hardware.WaitFabricReadyParams{
StateProvider: hwprov.DefaultNetDevStateProvider(log),
FabricIfaces: ifaces,
IterationSleep: time.Second,
}); err != nil {
return err
}
return nil
}
func lookupIF(name string) (netInterface, error) {
iface, err := net.InterfaceByName(name)
if err != nil {
return nil, errors.Wrapf(err,
"unable to retrieve interface %q", name)
}
return iface, nil
}
// Start is the entry point for a daos_server instance.
func Start(log logging.Logger, cfg *config.Server) error {
if err := common.CheckDupeProcess(); err != nil {
return err
}
// Create the root context here. All contexts should inherit from this one so
// that they can be shut down from one place.
ctx, shutdown := context.WithCancel(context.Background())
defer shutdown()
providers, err := cfg.Fabric.GetProviders()
if err != nil {
return err
}
if err := waitFabricReady(ctx, log, cfg); err != nil {
return err
}
scanner := hwprov.DefaultFabricScanner(log)
fis, err := scanner.Scan(ctx, providers...)
if err != nil {
return errors.Wrap(err, "scan fabric")
}
mi, err := common.GetMemInfo()
if err != nil {
return errors.Wrapf(err, "retrieve system memory info")
}
if err = processConfig(log, cfg, fis, mi, lookupIF, genFiAffFn(fis)); err != nil {
return err
}
faultDomain, err := getFaultDomain(cfg)
if err != nil {
return err
}
log.Debugf("fault domain: %s", faultDomain.String())
srv, err := newServer(log, cfg, faultDomain)
if err != nil {
return err
}
defer srv.shutdown()
if err := srv.setCoreDumpFilter(); err != nil {
return err
}
if srv.netDevClass, err = getFabricNetDevClass(cfg, fis); err != nil {
return err
}
if err := srv.createServices(ctx); err != nil {
return err
}
if err := srv.initNetwork(); err != nil {
return err
}
if err := srv.addEngines(ctx); err != nil {
return err
}
if err := srv.setupGrpc(); err != nil {
return err
}
srv.registerEvents()
sigChan := make(chan os.Signal)
signal.Notify(sigChan, syscall.SIGINT, syscall.SIGQUIT, syscall.SIGTERM)
go func() {
sig := <-sigChan
srv.log.Debugf("Caught signal: %s", sig)
shutdown()
}()
return srv.start(ctx)
}