blob: 730cd39fdcf446fac9e163904e81229c40ce688f [file] [log] [blame]
khenaidoobf6e7bb2018-08-14 22:27:29 -04001/*
2 * Copyright 2018-present Open Networking Foundation
3
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7
8 * http://www.apache.org/licenses/LICENSE-2.0
9
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Stephane Barbariedc5022d2018-11-19 15:21:44 -050016
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040017package model
18
19import (
20 "encoding/hex"
21 "encoding/json"
Stephane Barbarie1ab43272018-12-08 21:42:13 -050022 "github.com/golang/protobuf/proto"
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040023 "github.com/google/uuid"
khenaidoob9203542018-09-17 22:56:37 -040024 "github.com/opencord/voltha-go/common/log"
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040025 "reflect"
Stephane Barbariedc5022d2018-11-19 15:21:44 -050026 "sync"
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040027)
28
Stephane Barbariedc5022d2018-11-19 15:21:44 -050029// Root is used to provide an abstraction to the base root structure
Stephane Barbarie06c4a742018-10-01 11:09:32 -040030type Root interface {
31 Node
Stephane Barbariedc5022d2018-11-19 15:21:44 -050032
33 ExecuteCallbacks()
34 AddCallback(callback CallbackFunction, args ...interface{})
35 AddNotificationCallback(callback CallbackFunction, args ...interface{})
Stephane Barbarie06c4a742018-10-01 11:09:32 -040036}
37
Stephane Barbariedc5022d2018-11-19 15:21:44 -050038// root points to the top of the data model tree or sub-tree identified by a proxy
Stephane Barbarie06c4a742018-10-01 11:09:32 -040039type root struct {
Stephane Barbarie126101e2018-10-11 16:18:48 -040040 *node
41
42 Callbacks []CallbackTuple
43 NotificationCallbacks []CallbackTuple
Stephane Barbarie06c4a742018-10-01 11:09:32 -040044
Stephane Barbariedc5022d2018-11-19 15:21:44 -050045 DirtyNodes map[string][]*node
46 KvStore *Backend
47 Loading bool
48 RevisionClass interface{}
49
khenaidoo43c82122018-11-22 18:38:28 -050050 mutex sync.RWMutex
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040051}
52
Stephane Barbariedc5022d2018-11-19 15:21:44 -050053// NewRoot creates an new instance of a root object
Stephane Barbarie06c4a742018-10-01 11:09:32 -040054func NewRoot(initialData interface{}, kvStore *Backend) *root {
55 root := &root{}
Stephane Barbarie126101e2018-10-11 16:18:48 -040056
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040057 root.KvStore = kvStore
Stephane Barbarie06c4a742018-10-01 11:09:32 -040058 root.DirtyNodes = make(map[string][]*node)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040059 root.Loading = false
Stephane Barbarie06c4a742018-10-01 11:09:32 -040060
Stephane Barbariedc5022d2018-11-19 15:21:44 -050061 // If there is no storage in place just revert to
62 // a non persistent mechanism
Stephane Barbarie88fbe7f2018-09-25 12:25:23 -040063 if kvStore != nil {
64 root.RevisionClass = reflect.TypeOf(PersistedRevision{})
65 } else {
66 root.RevisionClass = reflect.TypeOf(NonPersistedRevision{})
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040067 }
Stephane Barbariedc5022d2018-11-19 15:21:44 -050068
Stephane Barbarie694e2b92018-09-07 12:17:36 -040069 root.Callbacks = []CallbackTuple{}
70 root.NotificationCallbacks = []CallbackTuple{}
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040071
Stephane Barbariedc5022d2018-11-19 15:21:44 -050072 root.node = NewNode(root, initialData, false, "")
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040073
74 return root
75}
76
Stephane Barbariedc5022d2018-11-19 15:21:44 -050077// MakeTxBranch creates a new transaction branch
Stephane Barbarie06c4a742018-10-01 11:09:32 -040078func (r *root) MakeTxBranch() string {
Stephane Barbariedc5022d2018-11-19 15:21:44 -050079 txidBin, _ := uuid.New().MarshalBinary()
80 txid := hex.EncodeToString(txidBin)[:12]
81
Stephane Barbarie126101e2018-10-11 16:18:48 -040082 r.DirtyNodes[txid] = []*node{r.node}
Stephane Barbarie06c4a742018-10-01 11:09:32 -040083 r.node.MakeBranch(txid)
Stephane Barbariedc5022d2018-11-19 15:21:44 -050084
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040085 return txid
86}
87
Stephane Barbariedc5022d2018-11-19 15:21:44 -050088// DeleteTxBranch removes a transaction branch
Stephane Barbarie06c4a742018-10-01 11:09:32 -040089func (r *root) DeleteTxBranch(txid string) {
Stephane Barbariee16186c2018-09-11 10:46:34 -040090 for _, dirtyNode := range r.DirtyNodes[txid] {
Stephane Barbarie06c4a742018-10-01 11:09:32 -040091 dirtyNode.DeleteBranch(txid)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040092 }
93 delete(r.DirtyNodes, txid)
94}
95
Stephane Barbariedc5022d2018-11-19 15:21:44 -050096// FoldTxBranch will merge the contents of a transaction branch with the root object
Stephane Barbarie06c4a742018-10-01 11:09:32 -040097func (r *root) FoldTxBranch(txid string) {
Stephane Barbariedc5022d2018-11-19 15:21:44 -050098 // Start by doing a dry run of the merge
99 // If that fails, it bails out and the branch is deleted
100 if _, err := r.node.MergeBranch(txid, true); err != nil {
101 // Merge operation fails
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400102 r.DeleteTxBranch(txid)
103 } else {
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500104 r.node.MergeBranch(txid, false)
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400105 r.ExecuteCallbacks()
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400106 }
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400107}
108
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500109// ExecuteCallbacks will invoke all the callbacks linked to root object
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400110func (r *root) ExecuteCallbacks() {
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500111 r.mutex.Lock()
112 log.Debugf("ExecuteCallbacks has the ROOT lock : %+v", r)
113 defer r.mutex.Unlock()
114 defer log.Debugf("ExecuteCallbacks released the ROOT lock : %+v", r)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400115 for len(r.Callbacks) > 0 {
116 callback := r.Callbacks[0]
117 r.Callbacks = r.Callbacks[1:]
khenaidoo43c82122018-11-22 18:38:28 -0500118 go callback.Execute(nil)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400119 }
120 for len(r.NotificationCallbacks) > 0 {
121 callback := r.NotificationCallbacks[0]
122 r.NotificationCallbacks = r.NotificationCallbacks[1:]
khenaidoo43c82122018-11-22 18:38:28 -0500123 go callback.Execute(nil)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400124 }
125}
126
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500127func (r *root) hasCallbacks() bool {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400128 return len(r.Callbacks) == 0
129}
130
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500131// getCallbacks returns the available callbacks
132func (r *root) GetCallbacks() []CallbackTuple {
133 r.mutex.Lock()
134 log.Debugf("getCallbacks has the ROOT lock : %+v", r)
135 defer r.mutex.Unlock()
136 defer log.Debugf("getCallbacks released the ROOT lock : %+v", r)
137 return r.Callbacks
138}
139
140// getCallbacks returns the available notification callbacks
141func (r *root) GetNotificationCallbacks() []CallbackTuple {
142 r.mutex.Lock()
143 log.Debugf("GetNotificationCallbacks has the ROOT lock : %+v", r)
144 defer r.mutex.Unlock()
145 defer log.Debugf("GetNotificationCallbacks released the ROOT lock : %+v", r)
146 return r.NotificationCallbacks
147}
148
149// AddCallback inserts a new callback with its arguments
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400150func (r *root) AddCallback(callback CallbackFunction, args ...interface{}) {
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500151 r.mutex.Lock()
152 log.Debugf("AddCallback has the ROOT lock : %+v", r)
153 defer r.mutex.Unlock()
154 defer log.Debugf("AddCallback released the ROOT lock : %+v", r)
Stephane Barbarie694e2b92018-09-07 12:17:36 -0400155 r.Callbacks = append(r.Callbacks, CallbackTuple{callback, args})
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400156}
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500157
158// AddNotificationCallback inserts a new notification callback with its arguments
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400159func (r *root) AddNotificationCallback(callback CallbackFunction, args ...interface{}) {
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500160 r.mutex.Lock()
161 log.Debugf("AddNotificationCallback has the ROOT lock : %+v", r)
162 defer r.mutex.Unlock()
163 defer log.Debugf("AddNotificationCallback released the ROOT lock : %+v", r)
Stephane Barbarie694e2b92018-09-07 12:17:36 -0400164 r.NotificationCallbacks = append(r.NotificationCallbacks, CallbackTuple{callback, args})
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400165}
166
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500167func (r *root) syncParent(childRev Revision, txid string) {
168 data := proto.Clone(r.Proxy.ParentNode.Latest().GetData().(proto.Message))
169
170 for fieldName, _ := range ChildrenFields(data) {
171 childDataName, childDataHolder := GetAttributeValue(data, fieldName, 0)
172 if reflect.TypeOf(childRev.GetData()) == reflect.TypeOf(childDataHolder.Interface()) {
173 childDataHolder = reflect.ValueOf(childRev.GetData())
174 reflect.ValueOf(data).Elem().FieldByName(childDataName).Set(childDataHolder)
175 }
176 }
177
178 r.Proxy.ParentNode.Latest().SetConfig(NewDataRevision(r.Proxy.ParentNode.Root, data))
179 r.Proxy.ParentNode.Latest(txid).Finalize(false)
180}
181
182
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500183// Update modifies the content of an object at a given path with the provided data
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400184func (r *root) Update(path string, data interface{}, strict bool, txid string, makeBranch MakeBranchFunction) Revision {
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400185 var result Revision
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400186
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500187 if makeBranch != nil {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400188 // TODO: raise error
189 }
190
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500191 if r.hasCallbacks() {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400192 // TODO: raise error
193 }
194
195 if txid != "" {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400196 trackDirty := func(node *node) *Branch {
Stephane Barbariee16186c2018-09-11 10:46:34 -0400197 r.DirtyNodes[txid] = append(r.DirtyNodes[txid], node)
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400198 return node.MakeBranch(txid)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400199 }
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400200 result = r.node.Update(path, data, strict, txid, trackDirty)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400201 } else {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400202 result = r.node.Update(path, data, strict, "", nil)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400203 }
204
Stephane Barbariee0a4c792019-01-16 11:26:29 -0500205 if result != nil {
206 if r.Proxy.FullPath != r.Proxy.Path {
207 r.syncParent(result, txid)
208 } else {
209 result.Finalize(false)
210 }
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500211 }
212
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500213 r.node.GetRoot().ExecuteCallbacks()
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400214
215 return result
216}
217
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500218// Add creates a new object at the given path with the provided data
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400219func (r *root) Add(path string, data interface{}, txid string, makeBranch MakeBranchFunction) Revision {
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400220 var result Revision
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400221
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500222 if makeBranch != nil {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400223 // TODO: raise error
224 }
225
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500226 if r.hasCallbacks() {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400227 // TODO: raise error
228 }
229
230 if txid != "" {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400231 trackDirty := func(node *node) *Branch {
Stephane Barbariee16186c2018-09-11 10:46:34 -0400232 r.DirtyNodes[txid] = append(r.DirtyNodes[txid], node)
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400233 return node.MakeBranch(txid)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400234 }
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400235 result = r.node.Add(path, data, txid, trackDirty)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400236 } else {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400237 result = r.node.Add(path, data, "", nil)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400238 }
239
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500240 if result != nil {
241 result.Finalize(true)
242 r.node.GetRoot().ExecuteCallbacks()
243 }
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400244 return result
245}
246
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500247// Remove discards an object at a given path
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400248func (r *root) Remove(path string, txid string, makeBranch MakeBranchFunction) Revision {
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400249 var result Revision
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400250
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500251 if makeBranch != nil {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400252 // TODO: raise error
253 }
254
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500255 if r.hasCallbacks() {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400256 // TODO: raise error
257 }
258
259 if txid != "" {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400260 trackDirty := func(node *node) *Branch {
Stephane Barbariee16186c2018-09-11 10:46:34 -0400261 r.DirtyNodes[txid] = append(r.DirtyNodes[txid], node)
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400262 return node.MakeBranch(txid)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400263 }
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400264 result = r.node.Remove(path, txid, trackDirty)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400265 } else {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400266 result = r.node.Remove(path, "", nil)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400267 }
268
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500269 r.node.GetRoot().ExecuteCallbacks()
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400270
271 return result
272}
273
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500274// MakeLatest updates a branch with the latest node revision
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400275func (r *root) MakeLatest(branch *Branch, revision Revision, changeAnnouncement []ChangeTuple) {
276 r.makeLatest(branch, revision, changeAnnouncement)
277}
278
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500279func (r *root) MakeRevision(branch *Branch, data interface{}, children map[string][]Revision) Revision {
280 if r.RevisionClass.(reflect.Type) == reflect.TypeOf(PersistedRevision{}) {
281 return NewPersistedRevision(branch, data, children)
282 }
283
284 return NewNonPersistedRevision(r, branch, data, children)
285}
286
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400287func (r *root) makeLatest(branch *Branch, revision Revision, changeAnnouncement []ChangeTuple) {
288 r.node.makeLatest(branch, revision, changeAnnouncement)
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400289
290 if r.KvStore != nil && branch.Txid == "" {
291 tags := make(map[string]string)
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500292 for k, v := range r.node.Tags {
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400293 tags[k] = v.GetHash()
294 }
295 data := &rootData{
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500296 Latest: branch.GetLatest().GetHash(),
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400297 Tags: tags,
298 }
299 if blob, err := json.Marshal(data); err != nil {
300 // TODO report error
301 } else {
302 log.Debugf("Changing root to : %s", string(blob))
303 if err := r.KvStore.Put("root", blob); err != nil {
304 log.Errorf("failed to properly put value in kvstore - err: %s", err.Error())
305 }
306 }
307 }
308}
309
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400310type rootData struct {
khenaidoob9203542018-09-17 22:56:37 -0400311 Latest string `json:latest`
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400312 Tags map[string]string `json:tags`
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500313}