blob: dc24fe65ddd349da1bd8860e2c41beb7ebfba0f7 [file] [log] [blame]
Scott Baker2c1c4822019-10-16 11:02:41 -07001/*
Joey Armstrong9cdee9f2024-01-03 04:56:14 -05002 * Copyright 2018-2024 Open Networking Foundation (ONF) and the ONF Contributors
Scott Baker2c1c4822019-10-16 11:02:41 -07003
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 */
16
sbarbari1e3e29c2019-11-05 10:06:50 -050017package db
Scott Baker2c1c4822019-10-16 11:02:41 -070018
19import (
Girish Kumarca522102019-11-08 11:26:35 +000020 "context"
Scott Baker2c1c4822019-10-16 11:02:41 -070021 "errors"
22 "fmt"
David K. Bainbridge5edd7fb2020-07-29 19:30:48 -070023 "sync"
Girish Kumarca522102019-11-08 11:26:35 +000024 "time"
serkant.uluderyab38671c2019-11-01 09:35:38 -070025
khenaidoo26721882021-08-11 17:42:52 -040026 "github.com/opencord/voltha-lib-go/v7/pkg/db/kvstore"
27 "github.com/opencord/voltha-lib-go/v7/pkg/log"
serkant.uluderyab38671c2019-11-01 09:35:38 -070028 "google.golang.org/grpc/codes"
29 "google.golang.org/grpc/status"
Girish Kumarca522102019-11-08 11:26:35 +000030)
31
32const (
33 // Default Minimal Interval for posting alive state of backend kvstore on Liveness Channel
34 DefaultLivenessChannelInterval = time.Second * 30
Scott Baker2c1c4822019-10-16 11:02:41 -070035)
36
Scott Baker2c1c4822019-10-16 11:02:41 -070037// Backend structure holds details for accessing the kv store
38type Backend struct {
Girish Kumarca522102019-11-08 11:26:35 +000039 Client kvstore.Client
40 StoreType string
Neha Sharma130ac6d2020-04-08 08:46:32 +000041 Timeout time.Duration
Neha Sharmadd9af392020-04-28 09:03:57 +000042 Address string
Girish Kumarca522102019-11-08 11:26:35 +000043 PathPrefix string
David K. Bainbridge5edd7fb2020-07-29 19:30:48 -070044 alive bool // Is this backend connection alive?
45 livenessMutex sync.Mutex
Girish Kumarca522102019-11-08 11:26:35 +000046 liveness chan bool // channel to post alive state
47 LivenessChannelInterval time.Duration // regularly push alive state beyond this interval
48 lastLivenessTime time.Time // Instant of last alive state push
Scott Baker2c1c4822019-10-16 11:02:41 -070049}
50
51// NewBackend creates a new instance of a Backend structure
Neha Sharma94f16a92020-06-26 04:17:55 +000052func NewBackend(ctx context.Context, storeType string, address string, timeout time.Duration, pathPrefix string) *Backend {
Scott Baker2c1c4822019-10-16 11:02:41 -070053 var err error
54
55 b := &Backend{
Girish Kumarca522102019-11-08 11:26:35 +000056 StoreType: storeType,
Neha Sharmadd9af392020-04-28 09:03:57 +000057 Address: address,
Girish Kumarca522102019-11-08 11:26:35 +000058 Timeout: timeout,
59 LivenessChannelInterval: DefaultLivenessChannelInterval,
60 PathPrefix: pathPrefix,
61 alive: false, // connection considered down at start
Scott Baker2c1c4822019-10-16 11:02:41 -070062 }
63
Neha Sharma94f16a92020-06-26 04:17:55 +000064 if b.Client, err = b.newClient(ctx, address, timeout); err != nil {
65 logger.Errorw(ctx, "failed-to-create-kv-client",
Scott Baker2c1c4822019-10-16 11:02:41 -070066 log.Fields{
Neha Sharmadd9af392020-04-28 09:03:57 +000067 "type": storeType, "address": address,
Scott Baker2c1c4822019-10-16 11:02:41 -070068 "timeout": timeout, "prefix": pathPrefix,
69 "error": err.Error(),
70 })
71 }
72
73 return b
74}
75
Neha Sharma94f16a92020-06-26 04:17:55 +000076func (b *Backend) newClient(ctx context.Context, address string, timeout time.Duration) (kvstore.Client, error) {
Scott Baker2c1c4822019-10-16 11:02:41 -070077 switch b.StoreType {
serkant.uluderyae5afeff2021-02-23 18:00:23 +030078 case "redis":
79 return kvstore.NewRedisClient(address, timeout, false)
80 case "redis-sentinel":
81 return kvstore.NewRedisClient(address, timeout, true)
Scott Baker2c1c4822019-10-16 11:02:41 -070082 case "etcd":
Neha Sharma94f16a92020-06-26 04:17:55 +000083 return kvstore.NewEtcdClient(ctx, address, timeout, log.WarnLevel)
Scott Baker2c1c4822019-10-16 11:02:41 -070084 }
85 return nil, errors.New("unsupported-kv-store")
86}
87
Neha Sharma94f16a92020-06-26 04:17:55 +000088func (b *Backend) makePath(ctx context.Context, key string) string {
Scott Baker2c1c4822019-10-16 11:02:41 -070089 path := fmt.Sprintf("%s/%s", b.PathPrefix, key)
90 return path
91}
92
Neha Sharma94f16a92020-06-26 04:17:55 +000093func (b *Backend) updateLiveness(ctx context.Context, alive bool) {
Girish Kumarca522102019-11-08 11:26:35 +000094 // Periodically push stream of liveness data to the channel,
95 // so that in a live state, the core does not timeout and
96 // send a forced liveness message. Push alive state if the
97 // last push to channel was beyond livenessChannelInterval
David K. Bainbridge5edd7fb2020-07-29 19:30:48 -070098 b.livenessMutex.Lock()
99 defer b.livenessMutex.Unlock()
Girish Kumarca522102019-11-08 11:26:35 +0000100 if b.liveness != nil {
Girish Kumarca522102019-11-08 11:26:35 +0000101 if b.alive != alive {
Neha Sharma94f16a92020-06-26 04:17:55 +0000102 logger.Debug(ctx, "update-liveness-channel-reason-change")
Girish Kumarca522102019-11-08 11:26:35 +0000103 b.liveness <- alive
104 b.lastLivenessTime = time.Now()
David K. Bainbridge7c75cac2020-02-19 08:53:46 -0800105 } else if time.Since(b.lastLivenessTime) > b.LivenessChannelInterval {
Neha Sharma94f16a92020-06-26 04:17:55 +0000106 logger.Debug(ctx, "update-liveness-channel-reason-interval")
Girish Kumarca522102019-11-08 11:26:35 +0000107 b.liveness <- alive
108 b.lastLivenessTime = time.Now()
109 }
110 }
111
112 // Emit log message only for alive state change
113 if b.alive != alive {
Neha Sharma94f16a92020-06-26 04:17:55 +0000114 logger.Debugw(ctx, "change-kvstore-alive-status", log.Fields{"alive": alive})
Girish Kumarca522102019-11-08 11:26:35 +0000115 b.alive = alive
116 }
117}
118
119// Perform a dummy Key Lookup on kvstore to test Connection Liveness and
120// post on Liveness channel
npujar5bf737f2020-01-16 19:35:25 +0530121func (b *Backend) PerformLivenessCheck(ctx context.Context) bool {
122 alive := b.Client.IsConnectionUp(ctx)
Neha Sharma94f16a92020-06-26 04:17:55 +0000123 logger.Debugw(ctx, "kvstore-liveness-check-result", log.Fields{"alive": alive})
Girish Kumarca522102019-11-08 11:26:35 +0000124
Neha Sharma94f16a92020-06-26 04:17:55 +0000125 b.updateLiveness(ctx, alive)
Girish Kumarca522102019-11-08 11:26:35 +0000126 return alive
127}
128
129// Enable the liveness monitor channel. This channel will report
130// a "true" or "false" on every kvstore operation which indicates whether
131// or not the connection is still Live. This channel is then picked up
132// by the service (i.e. rw_core / ro_core) to update readiness status
133// and/or take other actions.
Neha Sharma94f16a92020-06-26 04:17:55 +0000134func (b *Backend) EnableLivenessChannel(ctx context.Context) chan bool {
135 logger.Debug(ctx, "enable-kvstore-liveness-channel")
David K. Bainbridge5edd7fb2020-07-29 19:30:48 -0700136 b.livenessMutex.Lock()
137 defer b.livenessMutex.Unlock()
Girish Kumarca522102019-11-08 11:26:35 +0000138 if b.liveness == nil {
Girish Kumarca522102019-11-08 11:26:35 +0000139 b.liveness = make(chan bool, 10)
Girish Kumarca522102019-11-08 11:26:35 +0000140 b.liveness <- b.alive
141 b.lastLivenessTime = time.Now()
142 }
143
144 return b.liveness
145}
146
147// Extract Alive status of Kvstore based on type of error
Neha Sharma94f16a92020-06-26 04:17:55 +0000148func (b *Backend) isErrorIndicatingAliveKvstore(ctx context.Context, err error) bool {
Girish Kumarca522102019-11-08 11:26:35 +0000149 // Alive unless observed an error indicating so
150 alive := true
151
152 if err != nil {
153
154 // timeout indicates kvstore not reachable/alive
155 if err == context.DeadlineExceeded {
156 alive = false
157 }
158
159 // Need to analyze client-specific errors based on backend type
160 if b.StoreType == "etcd" {
161
162 // For etcd backend, consider not-alive only for errors indicating
163 // timedout request or unavailable/corrupted cluster. For all remaining
164 // error codes listed in https://godoc.org/google.golang.org/grpc/codes#Code,
165 // we would not infer a not-alive backend because such a error may also
166 // occur due to bad client requests or sequence of operations
167 switch status.Code(err) {
168 case codes.DeadlineExceeded:
169 fallthrough
170 case codes.Unavailable:
171 fallthrough
172 case codes.DataLoss:
173 alive = false
174 }
Girish Kumarca522102019-11-08 11:26:35 +0000175 }
176 }
177
178 return alive
179}
180
Scott Baker2c1c4822019-10-16 11:02:41 -0700181// List retrieves one or more items that match the specified key
npujar5bf737f2020-01-16 19:35:25 +0530182func (b *Backend) List(ctx context.Context, key string) (map[string]*kvstore.KVPair, error) {
serkant.uluderyae5afeff2021-02-23 18:00:23 +0300183 span, ctx := log.CreateChildSpan(ctx, "kvs-list")
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000184 defer span.Finish()
185
Neha Sharma94f16a92020-06-26 04:17:55 +0000186 formattedPath := b.makePath(ctx, key)
187 logger.Debugw(ctx, "listing-key", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700188
npujar5bf737f2020-01-16 19:35:25 +0530189 pair, err := b.Client.List(ctx, formattedPath)
Girish Kumarca522102019-11-08 11:26:35 +0000190
Neha Sharma94f16a92020-06-26 04:17:55 +0000191 b.updateLiveness(ctx, b.isErrorIndicatingAliveKvstore(ctx, err))
Girish Kumarca522102019-11-08 11:26:35 +0000192
193 return pair, err
Scott Baker2c1c4822019-10-16 11:02:41 -0700194}
195
196// Get retrieves an item that matches the specified key
npujar5bf737f2020-01-16 19:35:25 +0530197func (b *Backend) Get(ctx context.Context, key string) (*kvstore.KVPair, error) {
serkant.uluderyae5afeff2021-02-23 18:00:23 +0300198 span, ctx := log.CreateChildSpan(ctx, "kvs-get")
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000199 defer span.Finish()
200
Neha Sharma94f16a92020-06-26 04:17:55 +0000201 formattedPath := b.makePath(ctx, key)
202 logger.Debugw(ctx, "getting-key", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700203
npujar5bf737f2020-01-16 19:35:25 +0530204 pair, err := b.Client.Get(ctx, formattedPath)
Girish Kumarca522102019-11-08 11:26:35 +0000205
Neha Sharma94f16a92020-06-26 04:17:55 +0000206 b.updateLiveness(ctx, b.isErrorIndicatingAliveKvstore(ctx, err))
Girish Kumarca522102019-11-08 11:26:35 +0000207
208 return pair, err
Scott Baker2c1c4822019-10-16 11:02:41 -0700209}
210
211// Put stores an item value under the specifed key
npujar5bf737f2020-01-16 19:35:25 +0530212func (b *Backend) Put(ctx context.Context, key string, value interface{}) error {
serkant.uluderyae5afeff2021-02-23 18:00:23 +0300213 span, ctx := log.CreateChildSpan(ctx, "kvs-put")
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000214 defer span.Finish()
215
Neha Sharma94f16a92020-06-26 04:17:55 +0000216 formattedPath := b.makePath(ctx, key)
217 logger.Debugw(ctx, "putting-key", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700218
npujar5bf737f2020-01-16 19:35:25 +0530219 err := b.Client.Put(ctx, formattedPath, value)
Girish Kumarca522102019-11-08 11:26:35 +0000220
Neha Sharma94f16a92020-06-26 04:17:55 +0000221 b.updateLiveness(ctx, b.isErrorIndicatingAliveKvstore(ctx, err))
Girish Kumarca522102019-11-08 11:26:35 +0000222
223 return err
Scott Baker2c1c4822019-10-16 11:02:41 -0700224}
225
226// Delete removes an item under the specified key
npujar5bf737f2020-01-16 19:35:25 +0530227func (b *Backend) Delete(ctx context.Context, key string) error {
serkant.uluderyae5afeff2021-02-23 18:00:23 +0300228 span, ctx := log.CreateChildSpan(ctx, "kvs-delete")
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000229 defer span.Finish()
230
Neha Sharma94f16a92020-06-26 04:17:55 +0000231 formattedPath := b.makePath(ctx, key)
232 logger.Debugw(ctx, "deleting-key", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700233
npujar5bf737f2020-01-16 19:35:25 +0530234 err := b.Client.Delete(ctx, formattedPath)
Girish Kumarca522102019-11-08 11:26:35 +0000235
Neha Sharma94f16a92020-06-26 04:17:55 +0000236 b.updateLiveness(ctx, b.isErrorIndicatingAliveKvstore(ctx, err))
Girish Kumarca522102019-11-08 11:26:35 +0000237
238 return err
Scott Baker2c1c4822019-10-16 11:02:41 -0700239}
240
Serkant Uluderya198de902020-11-16 20:29:17 +0300241func (b *Backend) DeleteWithPrefix(ctx context.Context, prefixKey string) error {
serkant.uluderyae5afeff2021-02-23 18:00:23 +0300242 span, ctx := log.CreateChildSpan(ctx, "kvs-delete-with-prefix")
Serkant Uluderya198de902020-11-16 20:29:17 +0300243 defer span.Finish()
244
245 formattedPath := b.makePath(ctx, prefixKey)
246 logger.Debugw(ctx, "deleting-prefix-key", log.Fields{"key": prefixKey, "path": formattedPath})
247
248 err := b.Client.DeleteWithPrefix(ctx, formattedPath)
249
250 b.updateLiveness(ctx, b.isErrorIndicatingAliveKvstore(ctx, err))
251
252 return err
253}
254
Scott Baker2c1c4822019-10-16 11:02:41 -0700255// CreateWatch starts watching events for the specified key
divyadesai8bf96862020-02-07 12:24:26 +0000256func (b *Backend) CreateWatch(ctx context.Context, key string, withPrefix bool) chan *kvstore.Event {
serkant.uluderyae5afeff2021-02-23 18:00:23 +0300257 span, ctx := log.CreateChildSpan(ctx, "kvs-create-watch")
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000258 defer span.Finish()
259
Neha Sharma94f16a92020-06-26 04:17:55 +0000260 formattedPath := b.makePath(ctx, key)
261 logger.Debugw(ctx, "creating-key-watch", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700262
divyadesai8bf96862020-02-07 12:24:26 +0000263 return b.Client.Watch(ctx, formattedPath, withPrefix)
Scott Baker2c1c4822019-10-16 11:02:41 -0700264}
265
266// DeleteWatch stops watching events for the specified key
Neha Sharma94f16a92020-06-26 04:17:55 +0000267func (b *Backend) DeleteWatch(ctx context.Context, key string, ch chan *kvstore.Event) {
serkant.uluderyae5afeff2021-02-23 18:00:23 +0300268 span, ctx := log.CreateChildSpan(ctx, "kvs-delete-watch")
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000269 defer span.Finish()
270
Neha Sharma94f16a92020-06-26 04:17:55 +0000271 formattedPath := b.makePath(ctx, key)
272 logger.Debugw(ctx, "deleting-key-watch", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700273
Neha Sharma94f16a92020-06-26 04:17:55 +0000274 b.Client.CloseWatch(ctx, formattedPath, ch)
Scott Baker2c1c4822019-10-16 11:02:41 -0700275}