forked from openconfig/gnmi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
metadata.go
316 lines (280 loc) · 8.52 KB
/
metadata.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
/*
Copyright 2017 Google Inc.
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 metadata describes metadata paths stored in the cache per target.
package metadata
import (
"errors"
"fmt"
"sync"
)
const (
// Root node where metadata is cached.
Root = "meta"
// Per-target metadata
// Sync is a boolean that reports whether all target state is cached.
Sync = "sync"
// Connected is a boolean that reports whether updates are being received.
Connected = "connected"
// ConnectedAddr is a string denoting the last-hop IP address of a connected
// target.
ConnectedAddr = "connectedAddress"
// AddCount is the total number of leaves that have been added.
AddCount = "targetLeavesAdded"
// DelCount is the total number of leaves that have been deleted.
DelCount = "targetLeavesDeleted"
// EmptyCount is the total number of notifications delivered that contain no
// updates or deletes.
EmptyCount = "targetLeavesEmpty"
// LeafCount is the current total leaves stored in the cache.
LeafCount = "targetLeaves"
// UpdateCount is the total number of leaf updates received.
UpdateCount = "targetLeavesUpdated"
// StaleCount is the total number of leaf updates that had timestamp older
// than that cached.
StaleCount = "targetLeavesStale"
// SuppressedCount is the total number of leaf updates that were suppressed
// because the update had the same value as already cached.
SuppressedCount = "targetLeavesSuppressed"
// Size is the total number of bytes used to store all values. This count
// excludes all indexing overhead.
Size = "targetSize"
// LatestTimestamp is the latest timestamp for any update received for the
// target.
LatestTimestamp = "latestTimestamp"
// ConnectError is the error related to connection failure.
ConnectError = "connectError"
)
// IntValue contains the path and other options for an int64 metadata.
type IntValue struct {
Path []string // Path of the int64 metadata
InitZero bool // Whether to initiate to 0 (for counters starting from 0).
}
// RegisterIntValue registers an int64 type metadata whose path and options
// are in val.
func RegisterIntValue(name string, val *IntValue) {
TargetIntValues[name] = val
}
// UnregisterIntValue unregisters an int64 type metadata name.
func UnregisterIntValue(name string) {
delete(TargetIntValues, name)
}
// StrValue contains the valid and the option to reset to emptry string.
type StrValue struct {
Valid bool
InitEmptyStr bool // Whether to initiate to "".
}
var (
// TargetBoolValues is the list of all bool metadata fields.
TargetBoolValues = map[string]bool{
Sync: true,
Connected: true,
}
// TargetIntValues is the list of all int64 metadata fields.
TargetIntValues = map[string]*IntValue{
AddCount: {[]string{Root, AddCount}, true},
DelCount: {[]string{Root, DelCount}, true},
EmptyCount: {[]string{Root, EmptyCount}, true},
LeafCount: {[]string{Root, LeafCount}, true},
UpdateCount: {[]string{Root, UpdateCount}, true},
StaleCount: {[]string{Root, StaleCount}, true},
SuppressedCount: {[]string{Root, SuppressedCount}, true},
Size: {[]string{Root, Size}, true},
LatestTimestamp: {[]string{Root, LatestTimestamp}, true},
}
// TargetStrValues is the list of all string metadata fields.
TargetStrValues = map[string]*StrValue{
ConnectedAddr: {Valid: true, InitEmptyStr: true},
ConnectError: {Valid: true, InitEmptyStr: false},
}
)
// Metadata is the container for all target specific metadata.
type Metadata struct {
mu sync.Mutex
valuesInt map[string]int64
valuesBool map[string]bool
valuesStr map[string]string
}
// Path is a convenience function that will return the full metadata path for
// any valid metadata value. Only metadata values registered above in
// TargetBoolValues, TargetIntValues, and TargetStrValues will return a path.
// An invalid metadata value will return nil.
func Path(value string) []string {
if TargetBoolValues[value] {
return []string{Root, value}
}
if val, ok := TargetStrValues[value]; ok && val.Valid {
return []string{Root, value}
}
if val := TargetIntValues[value]; val != nil {
return val.Path
}
return nil
}
// New returns an initialized Metadata structure. Integer values are
// initialized to 0. Boolean values are initialized to false. String values are
// initialized to empty string.
func New() *Metadata {
m := Metadata{
valuesInt: make(map[string]int64, len(TargetIntValues)),
valuesBool: make(map[string]bool, len(TargetBoolValues)),
valuesStr: make(map[string]string, len(TargetStrValues)),
}
m.Clear()
return &m
}
// ErrInvalidValue is returned when a metadata operation is attempted on a value
// that does not exist.
var ErrInvalidValue = errors.New("invalid metadata value")
func validInt(value string) error {
if val := TargetIntValues[value]; val == nil {
return ErrInvalidValue
}
return nil
}
func validBool(value string) error {
if valid := TargetBoolValues[value]; !valid {
return ErrInvalidValue
}
return nil
}
func validStr(value string) error {
if valid, ok := TargetStrValues[value]; !ok || !valid.Valid {
return ErrInvalidValue
}
return nil
}
// ResetEntry resets metadata entry to zero value. It will be deleted
// if it is Int with InitZero as false, or Str with InitEmptyStr as false.
func (m *Metadata) ResetEntry(entry string) error {
if validBool(entry) == nil {
m.SetBool(entry, false)
return nil
}
if validInt(entry) == nil {
val := TargetIntValues[entry]
if val.InitZero {
m.SetInt(entry, 0)
} else {
m.mu.Lock()
delete(m.valuesInt, entry)
m.mu.Unlock()
}
return nil
}
if validStr(entry) == nil {
val := TargetStrValues[entry]
if val.InitEmptyStr {
m.SetStr(entry, "")
} else {
m.mu.Lock()
delete(m.valuesStr, entry)
m.mu.Unlock()
}
return nil
}
return fmt.Errorf("unsupported entry %q", entry)
}
// Clear sets all metadata values to zero values, except that ConnectError is set to EmptyError.
func (m *Metadata) Clear() {
for k := range TargetBoolValues {
m.ResetEntry(k)
}
for k := range TargetIntValues {
m.ResetEntry(k)
}
for k := range TargetStrValues {
m.ResetEntry(k)
}
}
// AddInt atomically increments the metadata value specified by i.
func (m *Metadata) AddInt(value string, i int64) error {
if err := validInt(value); err != nil {
return err
}
m.mu.Lock()
m.valuesInt[value] += i
m.mu.Unlock()
return nil
}
// SetInt atomically sets the metadata value specified to v.
func (m *Metadata) SetInt(value string, v int64) error {
if err := validInt(value); err != nil {
return err
}
m.mu.Lock()
m.valuesInt[value] = v
m.mu.Unlock()
return nil
}
// ErrUnsetValue is returned when a metadata Get is attempted on a value that
// has not been Set (or Added).
var ErrUnsetValue = errors.New("unset value")
// GetInt atomically retrieves the metadata value specified.
func (m *Metadata) GetInt(value string) (int64, error) {
if err := validInt(value); err != nil {
return 0, err
}
m.mu.Lock()
v, ok := m.valuesInt[value]
m.mu.Unlock()
if !ok {
return 0, ErrUnsetValue
}
return v, nil
}
// SetBool atomically sets the metadata value specified to v.
func (m *Metadata) SetBool(value string, v bool) error {
if err := validBool(value); err != nil {
return err
}
m.mu.Lock()
m.valuesBool[value] = v
m.mu.Unlock()
return nil
}
// GetBool atomically retrieves the metadata value specified.
func (m *Metadata) GetBool(value string) (bool, error) {
if err := validBool(value); err != nil {
return false, err
}
m.mu.Lock()
v, ok := m.valuesBool[value]
m.mu.Unlock()
if !ok {
return false, ErrUnsetValue
}
return v, nil
}
// SetStr atomically sets the metadata value specified to v.
func (m *Metadata) SetStr(value, v string) error {
if err := validStr(value); err != nil {
return err
}
m.mu.Lock()
m.valuesStr[value] = v
m.mu.Unlock()
return nil
}
// GetStr atomically retrieves the metadata value specified.
func (m *Metadata) GetStr(value string) (string, error) {
if err := validStr(value); err != nil {
return "", err
}
m.mu.Lock()
v, ok := m.valuesStr[value]
m.mu.Unlock()
if !ok {
return "", ErrUnsetValue
}
return v, nil
}