forked from neuvector/neuvector
/
dispatcher.go
520 lines (452 loc) · 15.9 KB
/
dispatcher.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
package kv
import (
"fmt"
"sync"
log "github.com/sirupsen/logrus"
"github.com/neuvector/neuvector/share"
"github.com/neuvector/neuvector/share/cluster"
"github.com/neuvector/neuvector/share/utils"
)
// A kv dispatcher for the "push-config" profile distributions
// (1) WorkloadJoin(): add node-cache, workload(container id), update custom-groups for dispatcher
// (2) WorkloadLeave(): remove workloads, if its count reach zero in a node, remove learned/custom(no more referece) groups from the node
// (3) NodeLeave: remove node-cache, purge node from group2nodes
// (4) CustomGroupUpdate: handle custom group additions/updates/removes(criteria changes) to maintain group2nodes
// (5) CustomGroupDelete: remove entries in the group2nodes
// (6) PutProfile: dispatch "kv put" operatios, based on group2nodes
// (7) IsGroupAdded: a reference for outsiders (performance)
// Two major types of "profile" groups in the dispatcher
// (1) Service groups: learned containers/pods (from workloads); like: nodes, fed.nodes, nv.pods
// (2) Custom (user-defined) groups: associated criteria with Service groups; like: containers, fed.containers, fed.custom, custom.pods
type DispatcherHelper interface {
WorkloadJoin(node, group, id string, customGrps utils.Set, bLeader bool)
WorkloadLeave(node, group, id string, customGrps utils.Set, bLeader bool)
NodeLeave(node string, bLeader bool)
CustomGroupUpdate(group string, serviceGrps utils.Set, bLeader bool)
CustomGroupDelete(group string, bLeader bool)
PutProfile(group, subkey string, value []byte, txn *cluster.ClusterTransact, bPutIfNotExist bool) error
IsGroupAdded(group string) bool
}
// a simple mapping to speed up process
// FROM object store: object/config/(type)/name
// TO profile store: node/<nodeID>/profile/(type)/name
type keyMappingHelper struct {
obj string // object/config/(ept)/
prf string // profiles/(ept)/
}
// counting (profile) workloads on a node
type nodeMemberCache struct {
node string // nodeID
members map[string]utils.Set // [group]: containerID
}
type FuncIsGroupMember func(name, id string) bool
type FuncGetConfigKVData func(key string) ([]byte, bool)
type kvDispatcher struct {
mutex sync.RWMutex
nodes utils.Set // debug purpose: keep a record of all nodes
customs utils.Set // reserved: purge custom groups
node2groups map[string]*nodeMemberCache // accounting purpose: [nodeID] => {group-members}
group2nodes map[string]utils.Set // dispatching purpose: [group] => {nodes}
profileKeys []keyMappingHelper // utility: profile keys in the object/ store
matchedGrpFunc FuncIsGroupMember // help purging custom groups when workloads leave.
getKvDataFunc FuncGetConfigKVData
}
//////////////////////////////////
func (dpt *kvDispatcher) lockR() {
dpt.mutex.RLock()
}
func (dpt *kvDispatcher) unlockR() {
dpt.mutex.RUnlock()
}
func (dpt *kvDispatcher) lock() {
dpt.mutex.Lock()
}
func (dpt *kvDispatcher) unlock() {
dpt.mutex.Unlock()
}
func (dpt *kvDispatcher) dump() {
log.WithFields(log.Fields{"nodes-group": len(dpt.node2groups), "nodes": dpt.nodes.Cardinality(), "groups": len(dpt.group2nodes)}).Debug("DPT:")
for node, cache := range dpt.node2groups {
log.WithFields(log.Fields{"node": node}).Debug("DPT:")
for group, ids := range cache.members {
log.WithFields(log.Fields{"group": group, "count": ids.Cardinality()}).Debug("DPT:")
}
}
for group, nodes := range dpt.group2nodes {
log.WithFields(log.Fields{"group": group, "nodes": nodes.String(), "count": nodes.Cardinality()}).Debug("DPT:")
}
}
/// reserved: future periodical purge procedure, returns expired custom groups
func (dpt *kvDispatcher) purgeCustomGroupsByNode(node string) utils.Set {
log.WithFields(log.Fields{"node": node}).Debug("DPT: reserved")
exCustomGrps := utils.NewSet()
// search this node
if nodeCache, ok := dpt.node2groups[node]; ok {
for customGrp := range dpt.customs.Iter() {
custom := customGrp.(string)
if nodes, ok := dpt.group2nodes[custom]; ok && nodes.Contains(node) {
found := false
// search groups by one of its workload(id)
for _, ids := range nodeCache.members {
if dpt.matchedGrpFunc(custom, ids.Any().(string)) {
found = true
break // leave nodeCache
}
}
if !found {
exCustomGrps.Add(custom)
nodes.Remove(node)
}
}
}
}
return exCustomGrps
}
func (dpt *kvDispatcher) purgeCustomGroupsByNodeGroups(node string, customGrps utils.Set) utils.Set {
exCustomGrps := utils.NewSet()
// search this node
if nodeCache, ok := dpt.node2groups[node]; ok {
for customGrp := range customGrps.Iter() {
custom := customGrp.(string)
// log.WithFields(log.Fields{"custom": custom}).Debug("DPT:")
found := false
// search groups by one of its workload(id)
for _, ids := range nodeCache.members {
if dpt.matchedGrpFunc(custom, ids.Any().(string)) {
// log.WithFields(log.Fields{"group": group, "custom": custom}).Debug("DPT: found")
found = true
break // leave nodeCache
}
}
if !found {
exCustomGrps.Add(custom)
if nodes, ok := dpt.group2nodes[custom]; ok {
nodes.Remove(node)
}
}
}
}
return exCustomGrps
}
func (dpt *kvDispatcher) refreshServiceGroup2Nodes(group, node, id string, bRemoved bool) bool {
nodeCache, ok1 := dpt.node2groups[node]
if !ok1 {
// should not be here
log.WithFields(log.Fields{"node": node, "group": group}).Debug("DPT: node not found")
return false
}
nodes, ok2 := dpt.group2nodes[group]
if !ok2 {
// should not be here
log.WithFields(log.Fields{"node": node, "group": group}).Debug("DPT: group not found")
return false
}
var bGroupChanged bool
if bRemoved {
if ids, ok := nodeCache.members[group]; ok {
ids.Remove(id)
// log.WithFields(log.Fields{"group": group, "cnt": ids.Cardinality()}).Debug("DPT:")
if ids.Cardinality() == 0 {
bGroupChanged = true // removed
delete(nodeCache.members, group)
nodes.Remove(node)
if nodes.Cardinality() == 0 {
delete(dpt.group2nodes, group) // remove reference to save memory
}
}
}
} else {
// Add:
if ids, ok := nodeCache.members[group]; !ok {
bGroupChanged = true // newly added
nodeCache.members[group] = utils.NewSet(id)
} else {
ids.Add(id)
}
nodes.Add(node)
}
return bGroupChanged
}
func (dpt *kvDispatcher) refreshCustomGroups(name string, serviceGrps utils.Set, bRemoved bool) {
// refresh: only care the group2nodes shortcuts
if bRemoved {
delete(dpt.group2nodes, name)
dpt.customs.Remove(name) // reserved
return
}
// Add:
// log.WithFields(log.Fields{"name": name, "service_grp_cnt": serviceGrps.Cardinality()}).Debug("DPT:")
// recalculate every node from group2nodes
targetNodes := utils.NewSet()
for serviceGrp := range serviceGrps.Iter() {
serviceGroup := serviceGrp.(string)
// log.WithFields(log.Fields{"serviceGroup": serviceGroup}).Debug("DPT:")
if nodes, ok := dpt.group2nodes[serviceGroup]; ok {
targetNodes = targetNodes.Union(nodes)
} else {
// should not be here
log.WithFields(log.Fields{"name": name, "serviceGroup": serviceGroup}).Debug("DPT: not found")
}
}
// the user defined groups are stored in the group2nodes
dpt.group2nodes[name] = targetNodes
dpt.customs.Add(name) // reserved
}
func (dpt *kvDispatcher) copyProfileKeys(node, group string, txn *cluster.ClusterTransact) {
var value []byte
var ok bool
var err error
for _, m := range dpt.profileKeys {
from := fmt.Sprintf("%s%s", m.obj, group)
to := fmt.Sprintf("%s%s/%s%s", share.CLUSNodeStore, node, m.prf, group)
value, ok = dpt.getKvDataFunc(from)
if !ok { // 2nd chance
if value, err = cluster.Get(from); err != nil {
continue
}
}
txn.PutQuiet(to, utils.GzipBytes(value))
}
}
func (dpt *kvDispatcher) removeProfileKeys(node, group string, txn *cluster.ClusterTransact) {
// log.WithFields(log.Fields{"group": group, "node": node}).Debug("DPT: ")
for _, m := range dpt.profileKeys {
key := fmt.Sprintf("%s%s/%s%s", share.CLUSNodeStore, node, m.prf, group)
// log.WithFields(log.Fields{"key": key}).Debug("DPT:")
txn.Delete(key)
}
}
func (dpt *kvDispatcher) buildCustomGroups(node string, customGrps utils.Set, txn *cluster.ClusterTransact) {
// custom groups only, its reference map is group2nodes[]
for customGroup := range customGrps.Iter() {
custom := customGroup.(string)
bExist := false
// log.WithFields(log.Fields{"custom": custom}).Debug("DPT:")
if nodes, ok := dpt.group2nodes[custom]; ok {
bExist = nodes.Contains(node)
} else {
// custom group does not exist here, build it
dpt.group2nodes[custom] = utils.NewSet()
}
if !bExist {
dpt.group2nodes[custom].Add(node)
dpt.copyProfileKeys(node, custom, txn)
}
}
}
// from cacher
func (dpt *kvDispatcher) WorkloadJoin(node, group, id string, customGrps utils.Set, bLeader bool) {
// log.WithFields(log.Fields{"node": node, "group": group, "id": id, "customs": customGrps.String()}).Debug("DPT:")
dpt.lock()
defer dpt.unlock()
// check node
var bNewNode, bNewGroup bool
if _, ok := dpt.node2groups[node]; !ok {
bNewNode = true // a new node
dpt.nodes.Add(node)
nodeCache := &nodeMemberCache {
node: node,
members: make(map[string]utils.Set),
}
nodeCache.members[group] = utils.NewSet()
dpt.node2groups[node] = nodeCache
}
// check group
if _, ok := dpt.group2nodes[group]; !ok {
bNewGroup = true
dpt.group2nodes[group] = utils.NewSet()
}
bBuildLocalGroup := dpt.refreshServiceGroup2Nodes(group, node, id, false)
// dpt.dump()
if bLeader {
txn := cluster.Transact()
dpt.buildCustomGroups(node, customGrps, txn)
if bBuildLocalGroup || bNewGroup || bNewNode { // add a group on the node
// log.WithFields(log.Fields{"group": group, "node": node}).Debug("DPT: local group")
dpt.copyProfileKeys(node, group, txn)
}
if ok, err := txn.Apply(); err != nil || !ok {
log.WithFields(log.Fields{"ok": ok, "error": err, "group": group, "node": node}).Error("write failed")
}
txn.Close()
}
}
// from cacher
// Two options:
// (1) (current) purge the custom groups immediately(it needs the validatation of all other groups/workloads).
// (2) a 30-minutes timer to purge the unaffected custom groups
func (dpt *kvDispatcher) WorkloadLeave(node, group, id string, customGrps utils.Set, bLeader bool) {
// log.WithFields(log.Fields{"node": node, "group": group, "id": id, "customs": customGrps.String()}).Debug("DPT:")
dpt.lock()
defer dpt.unlock()
removeCustomGrp := utils.NewSet()
bRemoveGroup := dpt.refreshServiceGroup2Nodes(group, node, id, true)
// efficient enough?
if bRemoveGroup {
removeCustomGrp = dpt.purgeCustomGroupsByNodeGroups(node, customGrps)
// log.WithFields(log.Fields{"groups": removeCustomGrp.String()}).Debug("DPT: rm")
}
// dpt.dump()
if bLeader {
if bRemoveGroup {
txn := cluster.Transact()
dpt.removeProfileKeys(node, group, txn)
for custom := range removeCustomGrp.Iter() {
dpt.removeProfileKeys(node, custom.(string), txn)
}
if _, err := txn.Apply(); err != nil {
log.WithFields(log.Fields{"error": err, "group": group}).Error("delete failed")
}
txn.Close()
}
}
}
// from event trigger
func (dpt *kvDispatcher) NodeLeave(node string, bLeader bool) {
log.WithFields(log.Fields{"node": node}).Debug("DPT:")
dpt.lock()
defer dpt.unlock()
dpt.nodes.Remove(node)
delete(dpt.node2groups, node)
for _, nodes := range dpt.group2nodes {
nodes.Remove(node)
}
// dpt.dump()
if bLeader {
// delete the kv tree under the node
cluster.DeleteTree(share.CLUSNodeProfileStoreKey(node))
}
}
// from cacher
func (dpt *kvDispatcher) CustomGroupUpdate(group string, serviceGrps utils.Set, bLeader bool) {
// log.WithFields(log.Fields{"group": group}).Debug("DPT:")
dpt.lock()
defer dpt.unlock()
olds := utils.NewSet()
if nodes, ok := dpt.group2nodes[group]; ok {
olds = nodes.Clone()
}
// recalculate target nodes
dpt.refreshCustomGroups(group, serviceGrps, false)
// dpt.dump()
if bLeader {
curs, _ := dpt.group2nodes[group]
deletes := olds.Difference(curs)
creates := curs.Difference(olds)
txn := cluster.Transact()
for n := range creates.Iter() {
// log.WithFields(log.Fields{"group": group, "node": n.(string)}).Debug("DPT: add")
dpt.copyProfileKeys(n.(string), group, txn)
}
for n := range deletes.Iter() {
// log.WithFields(log.Fields{"group": group, "node": n.(string)}).Debug("DPT: rm")
dpt.removeProfileKeys(n.(string), group, txn)
}
if _, err := txn.Apply(); err != nil {
log.WithFields(log.Fields{"error": err, "group": group}).Error("delete failed")
}
txn.Close()
}
}
// from event trigger
func (dpt *kvDispatcher) CustomGroupDelete(group string, bLeader bool) {
//log.WithFields(log.Fields{"group": group}).Debug("DPT:")
dpt.lock()
defer dpt.unlock()
removes := utils.NewSet()
if nodes, ok := dpt.group2nodes[group]; ok {
removes = nodes.Clone()
dpt.refreshCustomGroups(group, nil, true)
}
// dpt.dump()
if bLeader {
// delete it in all assigned nodes
txn := cluster.Transact()
for n := range removes.Iter() {
dpt.removeProfileKeys(n.(string), group, txn)
}
if _, err := txn.Apply(); err != nil {
log.WithFields(log.Fields{"error": err, "group": group}).Error("delete failed")
}
txn.Close()
}
}
// sample: nodes/ubuntu:2YZB:5T5K:....../profiles/process/containers
// subkey includes the profile/ + <type> /+ <group name>
func (dpt *kvDispatcher) PutProfile(group, subkey string, value []byte, txn *cluster.ClusterTransact, bPutIfNotExist bool) error {
var err error
// if nodes, put them into profile/
if utils.IsGroupNodes(group) {
key := fmt.Sprintf("%s%s", share.CLUSNodeCommonStoreKey, subkey)
// log.WithFields(log.Fields{"key": key}).Debug("DPT: common")
if txn != nil {
txn.PutQuiet(key, value)
} else {
if bPutIfNotExist {
err = cluster.PutIfNotExist(key, value, true)
} else {
err = cluster.PutQuiet(key, value)
}
}
return err
}
var bExternalTxnReq = (txn != nil)
if !bExternalTxnReq {
// make it locally
txn = cluster.Transact()
defer txn.Close()
}
dpt.lockR()
defer dpt.unlockR()
if nodes, ok := dpt.group2nodes[group]; ok {
for node := range nodes.Iter() {
key := share.CLUSNodeProfileKey(node.(string), subkey)
// log.WithFields(log.Fields{"key": key}).Debug("DPT:")
if bPutIfNotExist && cluster.Exist(key) {
// txn.PutRev(0): not suitable because txn rollbacks if there is any existing key.
continue
}
txn.PutQuiet(key, value)
}
// local request
if !bExternalTxnReq && txn != nil {
_, err = txn.Apply()
}
if err != nil {
log.WithFields(log.Fields{"group": group, "key": subkey, "error": err, "bPutIfNotExist": bPutIfNotExist}).Error("DPT:")
}
}
return err
}
// for leader check only
func (dpt *kvDispatcher) IsGroupAdded(group string) bool {
// log.WithFields(log.Fields{"group": group}).Debug("DPT:")
dpt.lockR()
defer dpt.unlockR()
_, ok := dpt.group2nodes[group]
return ok
}
///////////////////////////////////////////////
var dispatcher *kvDispatcher
///////////////////////////////////////////////
func initDispatcher(matcher FuncIsGroupMember, getter FuncGetConfigKVData) {
dispatcher = &kvDispatcher{
nodes: utils.NewSet(), // reference
customs: utils.NewSet(),
node2groups: make(map[string]*nodeMemberCache),
group2nodes: make(map[string]utils.Set),
matchedGrpFunc: matcher,
getKvDataFunc: getter,
}
// like "object/config/group"
dispatcher.profileKeys = []keyMappingHelper{
keyMappingHelper{obj: share.CLUSConfigGroupStore, prf: share.ProfileGroupStore}, // at first
keyMappingHelper{obj: share.CLUSConfigProcessProfileStore, prf: share.ProfileProcessStore},
keyMappingHelper{obj: share.CLUSConfigFileAccessRuleStore, prf: share.ProfileFileAccessStore},
keyMappingHelper{obj: share.CLUSConfigFileMonitorStore, prf: share.ProfileFileMonitorStore},
keyMappingHelper{obj: share.CLUSConfigScriptStore, prf: share.ProfileFileScriptStore},
}
}
func GetDispatchHelper() DispatcherHelper {
return dispatcher
}