-
Notifications
You must be signed in to change notification settings - Fork 15
/
Node.go
729 lines (672 loc) · 18.8 KB
/
Node.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
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
/* Node.go: nodes are basic data containers for the state store
*
* Author: J. Lowell Wofford <lowell@lanl.gov>
*
* This software is open source software available under the BSD-3 license.
* Copyright (c) 2018, Triad National Security, LLC
* See LICENSE file for details.
*/
//go:generate protoc -I proto/src -I proto --gogo_out=Mgoogle/protobuf/any.proto=github.com/gogo/protobuf/types,plugins=grpc:proto proto/src/Node.proto
package core
import (
"fmt"
"reflect"
"sync"
"github.com/gogo/protobuf/proto"
ptypes "github.com/gogo/protobuf/types"
pb "github.com/kraken-hpc/kraken/core/proto"
ct "github.com/kraken-hpc/kraken/core/proto/customtypes"
"github.com/kraken-hpc/kraken/lib/types"
"github.com/kraken-hpc/kraken/lib/util"
)
/////////////////
// Node Object /
///////////////
var _ types.Node = (*Node)(nil)
// A Node object is the basic data store of the state engine. It is also a wrapper for a protobuf object.
type Node struct {
pb *pb.Node // data lives here
exts map[string]proto.Message // keeps an index map from extension URL -> extension Proto
srvs map[string]*pb.ServiceInstance // keeps an index map from service ID -> service Proto
mutex *sync.RWMutex
}
// NewNodeWithID creates a new node with an ID pre-set
func NewNodeWithID(id string) *Node {
//n := newNode()
n := NewNodeFromJSON([]byte(nodeFixture))
n.pb.Id = ct.NewNodeID(id)
n.indexServices()
return n
}
// NewNodeFromJSON creates a new node from JSON bytes
func NewNodeFromJSON(j []byte) *Node {
n := newNode()
e := n.pb.UnmarshalJSON(j)
if e != nil {
fmt.Printf("UnmarshJSON failed: %v\n", e)
return nil
}
n.importExtensions()
n.indexServices()
return n
}
// NewNodeFromBinary creates a new node from Binary (proto)
func NewNodeFromBinary(b []byte) *Node {
n := newNode()
e := proto.Unmarshal(b, n.pb)
// this could error out; we return nil if it does
if e != nil {
return nil
}
n.importExtensions()
n.indexServices()
return n
}
// NewNodeFromMessage creats a new node based on a proto message
func NewNodeFromMessage(m *pb.Node) *Node {
n := newNode()
n.pb = m
n.importExtensions()
n.indexServices()
return n
}
// ID returns the NodeID object for the node
// Note: we don't lock on this under the assumption that ID's don't typically change
func (n *Node) ID() types.NodeID {
return n.pb.Id
}
// ParentID returns the NodeID of the parent of this node
func (n *Node) ParentID() (pid types.NodeID) {
n.mutex.RLock()
pid = n.pb.ParentId
n.mutex.RUnlock()
return
}
// String is important, as we can make sure prints on a Node object obey locking
func (n *Node) String() string {
return fmt.Sprintf("Node<%s>", n.ID().String())
}
// JSON returns a JSON representation of the node
func (n *Node) JSON() []byte {
n.mutex.Lock()
defer n.mutex.Unlock()
n.exportExtensions()
b, e := n.pb.MarshalJSON()
if e != nil {
fmt.Printf("error marshalling JSON for node: %v\n", e)
}
n.importExtensions()
return b
}
// Binary returns a Binary representation of the node
func (n *Node) Binary() []byte {
n.mutex.Lock()
defer n.mutex.Unlock()
n.exportExtensions()
// If we're doing our job, this should never error.
b, _ := proto.Marshal(n.pb)
n.importExtensions()
return b
}
// Message returns the proto.Message interface for the node
func (n *Node) Message() proto.Message {
// This is a strange way to do things, but proto.Clone doesn't work with custom types
// TODO: do this better.
bytes := n.Binary()
m := NewNodeFromBinary(bytes)
m.mutex.Lock()
defer m.mutex.Unlock()
m.exportExtensions()
return m.pb
}
// GetValue returns a specific value (reflect.Value) by URL
// note: we can't just wrap everything in a lock because n.GetService will lock too
func (n *Node) GetValue(url string) (v reflect.Value, e error) {
root, sub := util.URLShift(url)
switch root {
case "type.googleapis.com":
fallthrough
case "/type.googleapis.com": // resolve extension
p, sub := util.URLShift(sub)
n.mutex.RLock()
ext, ok := n.exts[util.URLPush(root, p)]
if !ok {
e = fmt.Errorf("node does not have extension: %s", util.URLPush(root, p))
return
}
defer n.mutex.RUnlock()
return util.ResolveURL(sub, reflect.ValueOf(ext))
case "Services":
fallthrough
case "/Services": // resolve service
p, sub := util.URLShift(sub)
srv := n.GetService(p)
if srv == nil {
e = fmt.Errorf("nodes does not have service instance: %s", p)
return
}
n.mutex.RLock()
defer n.mutex.RUnlock()
return util.ResolveURL(sub, reflect.ValueOf(srv))
default: // everything else
n.mutex.RLock()
defer n.mutex.RUnlock()
return util.ResolveURL(url, reflect.ValueOf(n.pb))
}
}
// SetValue sets a specific value (reflect.Value) by URL
// Returns the value, post-set (same if input if all went well)
// note: we can't just wrap everything in a lock because n.GetService will lock too
func (n *Node) SetValue(url string, value reflect.Value) (v reflect.Value, e error) {
var r reflect.Value
root, sub := util.URLShift(url)
switch root {
case "/type.googleapis.com":
fallthrough
case "type.googleapis.com":
p, sub := util.URLShift(sub)
ext, ok := n.exts[util.URLPush(root, p)]
if !ok {
// ok, if this is a type we know, we'll add it
extension, ok := Registry.Extensions[util.URLPush(root, p)]
if !ok {
e = fmt.Errorf("unknown extension: %s", ext)
return
}
if err := n.AddExtension(extension.New()); e != nil {
e = fmt.Errorf("failed to add extension: %v", err)
return
}
// ok, new extension added...
}
n.mutex.Lock()
defer n.mutex.Unlock()
r, e = util.ResolveOrMakeURL(sub, reflect.ValueOf(ext))
case "/Services":
fallthrough
case "Services":
p, sub := util.URLShift(sub)
srv := n.GetService(p)
if srv == nil {
// we don't create services on the fly like this right now
e = fmt.Errorf("node does not have service instance: %s", p)
return
}
n.mutex.Lock()
defer n.mutex.Unlock()
r, e = util.ResolveOrMakeURL(sub, reflect.ValueOf(srv))
default:
n.mutex.Lock()
defer n.mutex.Unlock()
r, e = util.ResolveOrMakeURL(url, reflect.ValueOf(n.pb))
}
if e != nil {
return
}
if !r.IsValid() {
panic(url)
}
if value.Kind() == reflect.Ptr {
value = value.Elem()
}
if r.Type() != value.Type() {
e = fmt.Errorf("type mismatch: %s != %s", value.Type(), r.Type())
return
}
// should already be locked from above
if !r.CanSet() {
e = fmt.Errorf("value %s is not settable", url)
return
}
r.Set(value)
v = r
return
}
// GetValues gets multiple values in one call
func (n *Node) GetValues(urls []string) (v map[string]reflect.Value, e error) {
v = make(map[string]reflect.Value)
for _, url := range urls {
t, e := n.GetValue(url)
if e == nil {
v[url] = t
} else {
e = fmt.Errorf("Error occurred while getting value %v: %v", url, e)
}
}
return
}
// SetValues sets multiple values.
// TODO: Need a way to dynamically added new sub-structs
func (n *Node) SetValues(valmap map[string]reflect.Value) (v map[string]reflect.Value) {
v = make(map[string]reflect.Value)
for url, val := range valmap {
t, e := n.SetValue(url, val)
if e != nil {
v[url] = t
}
}
return
}
// GetExtensionURLs returns a slice of currently added extensions
func (n *Node) GetExtensionURLs() (r []string) {
exts := []string{}
n.mutex.RLock()
defer n.mutex.RUnlock()
for u := range n.exts {
exts = append(exts, u)
}
return exts
}
// GetExtensions returns the exts map
func (n *Node) GetExtensions() (r map[string]proto.Message) {
n.mutex.RLock()
defer n.mutex.RUnlock()
return n.exts
}
// AddExtension adds a new extension to the node. It will fail if marshal fails, or if it's a dupe.
func (n *Node) AddExtension(m proto.Message) (e error) {
any, e := ptypes.MarshalAny(m)
if e != nil {
return e
}
url := any.GetTypeUrl()
n.mutex.Lock()
defer n.mutex.Unlock()
if _, ok := n.exts[url]; ok {
e = fmt.Errorf("duplicate extension: %s", url)
return
}
n.exts[url] = m
return
}
// DelExtension removes an extension from the node. Has no return value, even if extension isn't there.
func (n *Node) DelExtension(url string) {
n.mutex.Lock()
delete(n.exts, url)
n.mutex.Unlock()
}
// HasExtension determines if the node has an extension by URL
func (n *Node) HasExtension(url string) bool {
n.mutex.RLock()
_, ok := n.exts[url]
n.mutex.RUnlock()
return ok
}
// GetServiceIDs returns a slice of service ID strings
func (n *Node) GetServiceIDs() (r []string) {
n.mutex.RLock()
for k := range n.srvs {
r = append(r, k)
}
n.mutex.RUnlock()
return r
}
// GetServices returns a slice of pb.ServiceInstance objects
func (n *Node) GetServices() (r []*pb.ServiceInstance) {
n.mutex.RLock()
for _, srv := range n.srvs {
r = append(r, srv)
}
n.mutex.RUnlock()
return
}
// AddService adds a ServiceInstance to the node, updates the index
func (n *Node) AddService(si *pb.ServiceInstance) (e error) {
n.mutex.Lock()
defer n.mutex.Unlock()
if _, ok := n.srvs[si.Id]; ok {
return fmt.Errorf("duplicate service: %s", si.Id)
}
n.srvs[si.Id] = si
n.pb.Services = append(n.pb.Services, si)
return
}
// DelService removes a ServiceInstance from a node
// This does not error if the instance does not exist
func (n *Node) DelService(id string) {
n.mutex.Lock()
defer n.mutex.Unlock()
if si, ok := n.srvs[id]; ok {
delete(n.srvs, id)
for i, psi := range n.pb.Services {
if psi == si {
// we don't need to preserve order, so we can do a fast (constant time) delete
n.pb.Services[i] = n.pb.Services[len(n.pb.Services)-1]
n.pb.Services = n.pb.Services[:len(n.pb.Services)-1]
break
}
}
}
}
// GetService returns the ServiceInstance by ID
func (n *Node) GetService(id string) (r *pb.ServiceInstance) {
var ok bool
n.mutex.RLock()
defer n.mutex.RUnlock()
if r, ok = n.srvs[id]; ok {
return r
}
return nil
}
// HasService returns a bool stating if a service exists
func (n *Node) HasService(id string) bool {
n.mutex.RLock()
defer n.mutex.RUnlock()
var ok bool
_, ok = n.srvs[id]
return ok
}
// Diff finds URLs that are different between this Node and another
// prefix allows a string prefix to be prepended to diffs
// note: we have to be especially careful about locking in this function
func (n *Node) Diff(node types.Node, prefix string) (r []string, e error) {
if reflect.TypeOf(n) != reflect.TypeOf(node) {
e = fmt.Errorf("cannot diff nodes of different types")
return
}
m := node.(*Node)
// These have to live up here to avoid possible deadlocks
eleft := m.GetExtensionURLs()
eright := n.GetExtensionURLs()
sleft := m.GetServiceIDs()
sright := n.GetServiceIDs()
n.mutex.RLock()
m.mutex.RLock()
defer n.mutex.RUnlock()
defer m.mutex.RUnlock()
// !!!IMPORTANT!!! we can't call any functions that lock after this, or we risk a deadlock
r, e = util.MessageDiff(n.pb, m.pb, prefix)
// handle extensions
for _, u := range eright {
nodeExt, ok := m.exts[u]
if !ok {
r = append(r, fmt.Sprintf("%s%s", prefix, u))
continue
}
d, _ := util.MessageDiff(n.exts[u], nodeExt, fmt.Sprintf("%s%s", prefix, u))
r = append(r, d...)
for i := range eleft {
if eleft[i] == u {
eleft = append(eleft[:i], eleft[i+1:]...)
break
}
}
}
for _, u := range eleft {
r = append(r, fmt.Sprintf("%s%s", prefix, u))
}
// handle services
prefix = util.URLPush(prefix, "Services")
for _, u := range sright {
nodeSrv, ok := m.srvs[u]
if !ok { // new one doesn't have this
r = append(r, util.URLPush(prefix, u))
continue
}
d, _ := util.MessageDiff(n.srvs[u], nodeSrv, util.URLPush(prefix, u))
r = append(r, d...)
for i := range sleft {
if sleft[i] == u {
sleft = append(sleft[:i], sleft[i+1:]...)
break
}
}
}
for _, u := range sleft { // these are new services in m
r = append(r, util.URLPush(prefix, u))
}
return
}
// MergeDiff does a merge if of what is in diff (URLs) only
// it returns a slice of changes made
func (n *Node) MergeDiff(node types.Node, diff []string) (changes []string, e error) {
if reflect.TypeOf(n) != reflect.TypeOf(node) {
e = fmt.Errorf("cannot diff nodes of different types")
return
}
m := node.(*Node)
for _, d := range diff {
var vn, vm reflect.Value
vn, e = n.GetValue(d)
if e != nil {
return
}
vm, e = m.GetValue(d)
if e != nil {
return
}
m.mutex.RLock()
n.mutex.Lock()
if vm.Interface() == vn.Interface() {
m.mutex.RUnlock()
n.mutex.Unlock()
continue
}
vn.Set(vm)
m.mutex.RUnlock()
n.mutex.Unlock()
changes = append(changes, d)
}
return
}
// Merge takes any non-nil values in m into n
// We don't use protobuf's merge because we generally want to know what values changed!
// It returns a slice of URLs to changes made
func (n *Node) Merge(node types.Node, pre string) (changes []string, e error) {
d, e := n.Diff(node, pre)
if e != nil {
return
}
return n.MergeDiff(node, d)
}
////////////////////////
// Unexported methods /
//////////////////////
// newNode creates a new, completely empty Node
// We don't even want a way to have a node with no ID, so we don't export.
// We can assign a Nil ID if we have a really good reason
func newNode() *Node {
n := &Node{}
n.pb = &pb.Node{}
n.exts = make(map[string]proto.Message)
n.srvs = make(map[string]*pb.ServiceInstance)
n.mutex = &sync.RWMutex{}
for _, e := range Registry.Extensions {
n.AddExtension(e.New())
}
n.indexServices()
return n
}
// Assume n.mutex is locked
func (n *Node) importExtensions() {
for _, ext := range n.pb.Extensions {
// any that error just get thrown out
var x proto.Message
var e error
x, e = Registry.Resolve(ext.GetTypeUrl())
e = ptypes.UnmarshalAny(ext, x)
if e == nil {
// we overwrite duplicates
n.exts[ext.GetTypeUrl()] = x
}
}
// now we clear the field
n.pb.Extensions = []*ptypes.Any{}
}
// Assume n.mutex is locked
func (n *Node) exportExtensions() {
n.pb.Extensions = []*ptypes.Any{}
for _, ext := range n.exts {
if any, e := ptypes.MarshalAny(ext); e == nil {
n.pb.Extensions = append(n.pb.Extensions, any)
}
}
}
// indexServices will (re)create the srv index
// Assume n.mutex is locked
func (n *Node) indexServices() {
n.srvs = map[string]*pb.ServiceInstance{}
for _, si := range n.pb.GetServices() {
n.srvs[si.Id] = si
}
// we always want a stub for every service, so add ones that weren't indexed
for i := range Registry.ServiceInstances {
for j := range Registry.ServiceInstances[i] {
si := Registry.ServiceInstances[i][j]
if _, ok := n.srvs[si.ID()]; ok {
continue // we already have this one, skip
}
srv := &pb.ServiceInstance{
Id: si.ID(),
Module: si.Module(),
}
if mc, ok := Registry.Modules[si.Module()].(types.ModuleWithConfig); ok {
cfg, e := Registry.Resolve(mc.ConfigURL())
if e != nil {
fmt.Printf("MarshalAny failure for service config: %v\n", e)
}
cfgType := reflect.ValueOf(cfg).Elem().Type()
any, e := ptypes.MarshalAny(reflect.New(cfgType).Interface().(proto.Message))
if e != nil {
// this shouldn't happen
fmt.Printf("MarshalAny failure for service config: %v\n", e)
continue
}
srv.Config = any
}
n.AddService(srv)
}
}
}
///////////////////////
// Lookup Functions //
/////////////////////
// LookupEnum finds an enum and its value map based on URL
func LookupEnum(url string) (enumName string, enumType reflect.Type, valueMap map[string]int32, err error) {
n := NewNodeWithID("00000000-0000-0000-0000-000000000000")
parts := util.URLToSlice(url)
name := parts[len(parts)-1]
base := util.SliceToURL(parts[:len(parts)-1])
v, err := n.GetValue(base)
if err != nil {
fmt.Println("HERE: " + err.Error())
return
}
switch v.Kind() {
case reflect.Struct:
props := proto.GetProperties(v.Type())
found := false
for _, p := range props.Prop {
if p.Name == name {
// found
if p.Enum == "" {
err = fmt.Errorf("property %s in %s is not an enum", name, base)
return
}
// ok, we found it
enumName = p.Enum
valueMap = proto.EnumValueMap(enumName)
if valueMap == nil {
err = fmt.Errorf("got nil value map for enum %s in %s", name, base)
}
sf := v.FieldByName(name)
enumType = sf.Type()
return
}
}
if !found {
err = fmt.Errorf("not found: no property by name %s in %s", name, base)
return
}
case reflect.Map, reflect.Slice:
err = fmt.Errorf("not found: looking up enums as slice or map elements is not yet supported: %s", url)
return
default:
err = fmt.Errorf("not found: url base is not a valid container type: %s", url)
return
}
return
}
// MustLookupEnum performs LookupEnum, but panics if enum lookup fails
func MustLookupEnum(url string) (enumName string, enumType reflect.Type, valueMap map[string]int32) {
var err error
enumName, enumType, valueMap, err = LookupEnum(url)
if err != nil {
panic(err)
}
return
}
// LookupEnumValue maps an enum value to a reflect.Value based on URL and value string
func LookupEnumValue(url string, value string) (interface{}, error) {
if _, et, vm, err := LookupEnum(url); err == nil {
if v, ok := vm[value]; ok {
return reflect.ValueOf(v).Convert(et).Interface(), nil
} else {
return 0, fmt.Errorf("enum %s has not such value %s", url, value)
}
} else {
return 0, fmt.Errorf("enum %s not found", url)
}
}
// MustLookupEnumValue performs LookupEnumValue, but panics if lookup fails
func MustLookupEnumValue(url string, value string) interface{} {
v, err := LookupEnumValue(url, value)
if err != nil {
panic(err)
}
return v
}
// ValueFromString conversion requires special knowledge of the Node structure, so it lives here
// ValueFromString tries to convert a string to a reflect.Value based on URL
func ValueFromString(url, value string) (v reflect.Value, err error) {
n := NewNodeWithID("00000000-0000-0000-0000-000000000000")
var rv reflect.Value
if rv, err = n.GetValue(url); err != nil {
return
}
nys := fmt.Errorf("valueFromString: type not yet supported")
switch rv.Kind() {
case reflect.Int, reflect.Int32, reflect.Int16, reflect.Int64:
if rv.Kind() == reflect.Int32 {
// might be an enum
if i, err := LookupEnumValue(url, value); err == nil {
return reflect.ValueOf(i), nil
}
}
return v, nys
case reflect.Uint, reflect.Uint32, reflect.Uint16, reflect.Uint64:
return v, nys
case reflect.Float32, reflect.Float64:
return v, nys
case reflect.String:
// the easy one...
return reflect.ValueOf(value), nil
case reflect.Bool:
return v, nys
default:
return v, fmt.Errorf("unsupported kind: %s", rv.Kind())
}
}
// MustValueFromString wraps ValueFromString, but panics on error
func MustValueFromString(url, value string) reflect.Value {
v, err := ValueFromString(url, value)
if err != nil {
panic(fmt.Sprintf("mustValueFromString error: url=%s, value=%s, err=%v", url, value, err))
}
return v
}
//FIXME: hack to get the default extension, need a better way:
const nodeFixture string = `
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"nodename": "",
"runState": "UNKNOWN",
"physState": "PHYS_UNKNOWN",
"arch": "",
"platform": "",
"busy": "FREE",
"extensions": [
]
}
]
}`