forked from cilium/cilium
-
Notifications
You must be signed in to change notification settings - Fork 7
/
subsystem.go
105 lines (82 loc) · 2.87 KB
/
subsystem.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
// Copyright 2018 Authors of Cilium
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package debug
import (
"fmt"
"github.com/cilium/cilium/pkg/lock"
)
// StatusFunc is a function returning the debug status of a subsytem. It is
// passed into RegisterStatusFunc().
type StatusFunc func() string
// StatusMap is the collection of debug status of all subsystems. The key is
// the subsystem name. The value is the subsystem debug status.
type StatusMap map[string]string
// StatusObject is the interface an object must impelement to be able to be
// passed into RegisterStatusObject().
type StatusObject interface {
// DebugStatus() is the equivalent of StatusFunc. It must return the
// debug status as a string.
DebugStatus() string
}
type functionMap map[string]StatusFunc
type statusFunctions struct {
functions functionMap
mutex lock.RWMutex
}
func newStatusFunctions() statusFunctions {
return statusFunctions{
functions: functionMap{},
}
}
func (s *statusFunctions) register(name string, fn StatusFunc) error {
s.mutex.Lock()
defer s.mutex.Unlock()
if _, ok := s.functions[name]; ok {
return fmt.Errorf("subsystem already registered")
}
s.functions[name] = fn
return nil
}
func (s *statusFunctions) registerStatusObject(name string, obj StatusObject) error {
return s.register(name, func() string { return obj.DebugStatus() })
}
func (s *statusFunctions) collectStatus() StatusMap {
fnCopy := functionMap{}
// Make a copy to not hold the mutex while collecting the status
s.mutex.RLock()
for name, fn := range s.functions {
fnCopy[name] = fn
}
s.mutex.RUnlock()
status := StatusMap{}
for name, fn := range fnCopy {
status[name] = fn()
}
return status
}
var globalStatusFunctions = newStatusFunctions()
// RegisterStatusFunc registers a subsystem and associates a status function to
// call for debug status collection
func RegisterStatusFunc(name string, fn StatusFunc) error {
return globalStatusFunctions.register(name, fn)
}
// RegisterStatusObject registers a subsystem and associated a status object on
// which DebugStatus() is called to collect debug status
func RegisterStatusObject(name string, obj StatusObject) error {
return globalStatusFunctions.registerStatusObject(name, obj)
}
// CollectSubsystemStatus collects the status of all subsystems and returns it
func CollectSubsystemStatus() StatusMap {
return globalStatusFunctions.collectStatus()
}