blob: 8f9e0015b4b42aa2915849203daa4216b5ef25bc [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)
Stephane Barbarie1039ec42019-02-04 10:43:16 -050094 delete(r.node.Branches, txid)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -040095}
96
Stephane Barbariedc5022d2018-11-19 15:21:44 -050097// FoldTxBranch will merge the contents of a transaction branch with the root object
Stephane Barbarie06c4a742018-10-01 11:09:32 -040098func (r *root) FoldTxBranch(txid string) {
Stephane Barbariedc5022d2018-11-19 15:21:44 -050099 // Start by doing a dry run of the merge
100 // If that fails, it bails out and the branch is deleted
101 if _, err := r.node.MergeBranch(txid, true); err != nil {
102 // Merge operation fails
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400103 r.DeleteTxBranch(txid)
104 } else {
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500105 r.node.MergeBranch(txid, false)
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400106 r.ExecuteCallbacks()
Stephane Barbarie260a5632019-02-26 16:12:49 -0500107 r.DeleteTxBranch(txid)
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400108 }
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400109}
110
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500111// ExecuteCallbacks will invoke all the callbacks linked to root object
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400112func (r *root) ExecuteCallbacks() {
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500113 r.mutex.Lock()
114 log.Debugf("ExecuteCallbacks has the ROOT lock : %+v", r)
115 defer r.mutex.Unlock()
116 defer log.Debugf("ExecuteCallbacks released the ROOT lock : %+v", r)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400117 for len(r.Callbacks) > 0 {
118 callback := r.Callbacks[0]
119 r.Callbacks = r.Callbacks[1:]
khenaidoo43c82122018-11-22 18:38:28 -0500120 go callback.Execute(nil)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400121 }
122 for len(r.NotificationCallbacks) > 0 {
123 callback := r.NotificationCallbacks[0]
124 r.NotificationCallbacks = r.NotificationCallbacks[1:]
khenaidoo43c82122018-11-22 18:38:28 -0500125 go callback.Execute(nil)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400126 }
127}
128
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500129func (r *root) hasCallbacks() bool {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400130 return len(r.Callbacks) == 0
131}
132
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500133// getCallbacks returns the available callbacks
134func (r *root) GetCallbacks() []CallbackTuple {
135 r.mutex.Lock()
136 log.Debugf("getCallbacks has the ROOT lock : %+v", r)
137 defer r.mutex.Unlock()
138 defer log.Debugf("getCallbacks released the ROOT lock : %+v", r)
139 return r.Callbacks
140}
141
142// getCallbacks returns the available notification callbacks
143func (r *root) GetNotificationCallbacks() []CallbackTuple {
144 r.mutex.Lock()
145 log.Debugf("GetNotificationCallbacks has the ROOT lock : %+v", r)
146 defer r.mutex.Unlock()
147 defer log.Debugf("GetNotificationCallbacks released the ROOT lock : %+v", r)
148 return r.NotificationCallbacks
149}
150
151// AddCallback inserts a new callback with its arguments
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400152func (r *root) AddCallback(callback CallbackFunction, args ...interface{}) {
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500153 r.mutex.Lock()
154 log.Debugf("AddCallback has the ROOT lock : %+v", r)
155 defer r.mutex.Unlock()
156 defer log.Debugf("AddCallback released the ROOT lock : %+v", r)
Stephane Barbarie694e2b92018-09-07 12:17:36 -0400157 r.Callbacks = append(r.Callbacks, CallbackTuple{callback, args})
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400158}
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500159
160// AddNotificationCallback inserts a new notification callback with its arguments
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400161func (r *root) AddNotificationCallback(callback CallbackFunction, args ...interface{}) {
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500162 r.mutex.Lock()
163 log.Debugf("AddNotificationCallback has the ROOT lock : %+v", r)
164 defer r.mutex.Unlock()
165 defer log.Debugf("AddNotificationCallback released the ROOT lock : %+v", r)
Stephane Barbarie694e2b92018-09-07 12:17:36 -0400166 r.NotificationCallbacks = append(r.NotificationCallbacks, CallbackTuple{callback, args})
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400167}
168
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500169func (r *root) syncParent(childRev Revision, txid string) {
170 data := proto.Clone(r.Proxy.ParentNode.Latest().GetData().(proto.Message))
171
172 for fieldName, _ := range ChildrenFields(data) {
173 childDataName, childDataHolder := GetAttributeValue(data, fieldName, 0)
174 if reflect.TypeOf(childRev.GetData()) == reflect.TypeOf(childDataHolder.Interface()) {
175 childDataHolder = reflect.ValueOf(childRev.GetData())
176 reflect.ValueOf(data).Elem().FieldByName(childDataName).Set(childDataHolder)
177 }
178 }
179
180 r.Proxy.ParentNode.Latest().SetConfig(NewDataRevision(r.Proxy.ParentNode.Root, data))
181 r.Proxy.ParentNode.Latest(txid).Finalize(false)
182}
183
184
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500185// Update modifies the content of an object at a given path with the provided data
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400186func (r *root) Update(path string, data interface{}, strict bool, txid string, makeBranch MakeBranchFunction) Revision {
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400187 var result Revision
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400188
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500189 if makeBranch != nil {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400190 // TODO: raise error
191 }
192
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500193 if r.hasCallbacks() {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400194 // TODO: raise error
195 }
196
197 if txid != "" {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400198 trackDirty := func(node *node) *Branch {
Stephane Barbariee16186c2018-09-11 10:46:34 -0400199 r.DirtyNodes[txid] = append(r.DirtyNodes[txid], node)
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400200 return node.MakeBranch(txid)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400201 }
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400202 result = r.node.Update(path, data, strict, txid, trackDirty)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400203 } else {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400204 result = r.node.Update(path, data, strict, "", nil)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400205 }
206
Stephane Barbariee0a4c792019-01-16 11:26:29 -0500207 if result != nil {
208 if r.Proxy.FullPath != r.Proxy.Path {
209 r.syncParent(result, txid)
210 } else {
211 result.Finalize(false)
212 }
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500213 }
214
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500215 r.node.GetRoot().ExecuteCallbacks()
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400216
217 return result
218}
219
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500220// Add creates a new object at the given path with the provided data
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400221func (r *root) Add(path string, data interface{}, txid string, makeBranch MakeBranchFunction) Revision {
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400222 var result Revision
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400223
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500224 if makeBranch != nil {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400225 // TODO: raise error
226 }
227
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500228 if r.hasCallbacks() {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400229 // TODO: raise error
230 }
231
232 if txid != "" {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400233 trackDirty := func(node *node) *Branch {
Stephane Barbariee16186c2018-09-11 10:46:34 -0400234 r.DirtyNodes[txid] = append(r.DirtyNodes[txid], node)
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400235 return node.MakeBranch(txid)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400236 }
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400237 result = r.node.Add(path, data, txid, trackDirty)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400238 } else {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400239 result = r.node.Add(path, data, "", nil)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400240 }
241
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500242 if result != nil {
243 result.Finalize(true)
244 r.node.GetRoot().ExecuteCallbacks()
245 }
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400246 return result
247}
248
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500249// Remove discards an object at a given path
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400250func (r *root) Remove(path string, txid string, makeBranch MakeBranchFunction) Revision {
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400251 var result Revision
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400252
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500253 if makeBranch != nil {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400254 // TODO: raise error
255 }
256
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500257 if r.hasCallbacks() {
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400258 // TODO: raise error
259 }
260
261 if txid != "" {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400262 trackDirty := func(node *node) *Branch {
Stephane Barbariee16186c2018-09-11 10:46:34 -0400263 r.DirtyNodes[txid] = append(r.DirtyNodes[txid], node)
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400264 return node.MakeBranch(txid)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400265 }
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400266 result = r.node.Remove(path, txid, trackDirty)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400267 } else {
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400268 result = r.node.Remove(path, "", nil)
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400269 }
270
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500271 r.node.GetRoot().ExecuteCallbacks()
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400272
273 return result
274}
275
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500276// MakeLatest updates a branch with the latest node revision
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400277func (r *root) MakeLatest(branch *Branch, revision Revision, changeAnnouncement []ChangeTuple) {
278 r.makeLatest(branch, revision, changeAnnouncement)
279}
280
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500281func (r *root) MakeRevision(branch *Branch, data interface{}, children map[string][]Revision) Revision {
282 if r.RevisionClass.(reflect.Type) == reflect.TypeOf(PersistedRevision{}) {
283 return NewPersistedRevision(branch, data, children)
284 }
285
286 return NewNonPersistedRevision(r, branch, data, children)
287}
288
Stephane Barbarie06c4a742018-10-01 11:09:32 -0400289func (r *root) makeLatest(branch *Branch, revision Revision, changeAnnouncement []ChangeTuple) {
290 r.node.makeLatest(branch, revision, changeAnnouncement)
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400291
292 if r.KvStore != nil && branch.Txid == "" {
293 tags := make(map[string]string)
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500294 for k, v := range r.node.Tags {
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400295 tags[k] = v.GetHash()
296 }
297 data := &rootData{
Stephane Barbariedc5022d2018-11-19 15:21:44 -0500298 Latest: branch.GetLatest().GetHash(),
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400299 Tags: tags,
300 }
301 if blob, err := json.Marshal(data); err != nil {
302 // TODO report error
303 } else {
304 log.Debugf("Changing root to : %s", string(blob))
305 if err := r.KvStore.Put("root", blob); err != nil {
306 log.Errorf("failed to properly put value in kvstore - err: %s", err.Error())
307 }
308 }
309 }
310}
311
Stephane Barbarie4a2564d2018-07-26 11:02:58 -0400312type rootData struct {
khenaidoob9203542018-09-17 22:56:37 -0400313 Latest string `json:latest`
Stephane Barbarieec0919b2018-09-05 14:14:29 -0400314 Tags map[string]string `json:tags`
Stephane Barbarie1ab43272018-12-08 21:42:13 -0500315}