blob: 2e57a2751148209d1c7c7783f2dea44da5e239ca [file] [log] [blame]
Scott Baker2c1c4822019-10-16 11:02:41 -07001/*
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 */
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 {
Scott Baker2c1c4822019-10-16 11:02:41 -070078 case "etcd":
Neha Sharma94f16a92020-06-26 04:17:55 +000079 return kvstore.NewEtcdClient(ctx, address, timeout, log.WarnLevel)
Scott Baker2c1c4822019-10-16 11:02:41 -070080 }
81 return nil, errors.New("unsupported-kv-store")
82}
83
Neha Sharma94f16a92020-06-26 04:17:55 +000084func (b *Backend) makePath(ctx context.Context, key string) string {
Scott Baker2c1c4822019-10-16 11:02:41 -070085 path := fmt.Sprintf("%s/%s", b.PathPrefix, key)
86 return path
87}
88
Neha Sharma94f16a92020-06-26 04:17:55 +000089func (b *Backend) updateLiveness(ctx context.Context, alive bool) {
Girish Kumarca522102019-11-08 11:26:35 +000090 // Periodically push stream of liveness data to the channel,
91 // so that in a live state, the core does not timeout and
92 // send a forced liveness message. Push alive state if the
93 // last push to channel was beyond livenessChannelInterval
David K. Bainbridge5edd7fb2020-07-29 19:30:48 -070094 b.livenessMutex.Lock()
95 defer b.livenessMutex.Unlock()
Girish Kumarca522102019-11-08 11:26:35 +000096 if b.liveness != nil {
Girish Kumarca522102019-11-08 11:26:35 +000097 if b.alive != alive {
Neha Sharma94f16a92020-06-26 04:17:55 +000098 logger.Debug(ctx, "update-liveness-channel-reason-change")
Girish Kumarca522102019-11-08 11:26:35 +000099 b.liveness <- alive
100 b.lastLivenessTime = time.Now()
David K. Bainbridge7c75cac2020-02-19 08:53:46 -0800101 } else if time.Since(b.lastLivenessTime) > b.LivenessChannelInterval {
Neha Sharma94f16a92020-06-26 04:17:55 +0000102 logger.Debug(ctx, "update-liveness-channel-reason-interval")
Girish Kumarca522102019-11-08 11:26:35 +0000103 b.liveness <- alive
104 b.lastLivenessTime = time.Now()
105 }
106 }
107
108 // Emit log message only for alive state change
109 if b.alive != alive {
Neha Sharma94f16a92020-06-26 04:17:55 +0000110 logger.Debugw(ctx, "change-kvstore-alive-status", log.Fields{"alive": alive})
Girish Kumarca522102019-11-08 11:26:35 +0000111 b.alive = alive
112 }
113}
114
115// Perform a dummy Key Lookup on kvstore to test Connection Liveness and
116// post on Liveness channel
npujar5bf737f2020-01-16 19:35:25 +0530117func (b *Backend) PerformLivenessCheck(ctx context.Context) bool {
118 alive := b.Client.IsConnectionUp(ctx)
Neha Sharma94f16a92020-06-26 04:17:55 +0000119 logger.Debugw(ctx, "kvstore-liveness-check-result", log.Fields{"alive": alive})
Girish Kumarca522102019-11-08 11:26:35 +0000120
Neha Sharma94f16a92020-06-26 04:17:55 +0000121 b.updateLiveness(ctx, alive)
Girish Kumarca522102019-11-08 11:26:35 +0000122 return alive
123}
124
125// Enable the liveness monitor channel. This channel will report
126// a "true" or "false" on every kvstore operation which indicates whether
127// or not the connection is still Live. This channel is then picked up
128// by the service (i.e. rw_core / ro_core) to update readiness status
129// and/or take other actions.
Neha Sharma94f16a92020-06-26 04:17:55 +0000130func (b *Backend) EnableLivenessChannel(ctx context.Context) chan bool {
131 logger.Debug(ctx, "enable-kvstore-liveness-channel")
David K. Bainbridge5edd7fb2020-07-29 19:30:48 -0700132 b.livenessMutex.Lock()
133 defer b.livenessMutex.Unlock()
Girish Kumarca522102019-11-08 11:26:35 +0000134 if b.liveness == nil {
Girish Kumarca522102019-11-08 11:26:35 +0000135 b.liveness = make(chan bool, 10)
Girish Kumarca522102019-11-08 11:26:35 +0000136 b.liveness <- b.alive
137 b.lastLivenessTime = time.Now()
138 }
139
140 return b.liveness
141}
142
143// Extract Alive status of Kvstore based on type of error
Neha Sharma94f16a92020-06-26 04:17:55 +0000144func (b *Backend) isErrorIndicatingAliveKvstore(ctx context.Context, err error) bool {
Girish Kumarca522102019-11-08 11:26:35 +0000145 // Alive unless observed an error indicating so
146 alive := true
147
148 if err != nil {
149
150 // timeout indicates kvstore not reachable/alive
151 if err == context.DeadlineExceeded {
152 alive = false
153 }
154
155 // Need to analyze client-specific errors based on backend type
156 if b.StoreType == "etcd" {
157
158 // For etcd backend, consider not-alive only for errors indicating
159 // timedout request or unavailable/corrupted cluster. For all remaining
160 // error codes listed in https://godoc.org/google.golang.org/grpc/codes#Code,
161 // we would not infer a not-alive backend because such a error may also
162 // occur due to bad client requests or sequence of operations
163 switch status.Code(err) {
164 case codes.DeadlineExceeded:
165 fallthrough
166 case codes.Unavailable:
167 fallthrough
168 case codes.DataLoss:
169 alive = false
170 }
Girish Kumarca522102019-11-08 11:26:35 +0000171 }
172 }
173
174 return alive
175}
176
Scott Baker2c1c4822019-10-16 11:02:41 -0700177// List retrieves one or more items that match the specified key
npujar5bf737f2020-01-16 19:35:25 +0530178func (b *Backend) List(ctx context.Context, key string) (map[string]*kvstore.KVPair, error) {
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000179 span, ctx := log.CreateChildSpan(ctx, "etcd-list")
180 defer span.Finish()
181
Neha Sharma94f16a92020-06-26 04:17:55 +0000182 formattedPath := b.makePath(ctx, key)
183 logger.Debugw(ctx, "listing-key", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700184
npujar5bf737f2020-01-16 19:35:25 +0530185 pair, err := b.Client.List(ctx, formattedPath)
Girish Kumarca522102019-11-08 11:26:35 +0000186
Neha Sharma94f16a92020-06-26 04:17:55 +0000187 b.updateLiveness(ctx, b.isErrorIndicatingAliveKvstore(ctx, err))
Girish Kumarca522102019-11-08 11:26:35 +0000188
189 return pair, err
Scott Baker2c1c4822019-10-16 11:02:41 -0700190}
191
192// Get retrieves an item that matches the specified key
npujar5bf737f2020-01-16 19:35:25 +0530193func (b *Backend) Get(ctx context.Context, key string) (*kvstore.KVPair, error) {
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000194 span, ctx := log.CreateChildSpan(ctx, "etcd-get")
195 defer span.Finish()
196
Neha Sharma94f16a92020-06-26 04:17:55 +0000197 formattedPath := b.makePath(ctx, key)
198 logger.Debugw(ctx, "getting-key", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700199
npujar5bf737f2020-01-16 19:35:25 +0530200 pair, err := b.Client.Get(ctx, formattedPath)
Girish Kumarca522102019-11-08 11:26:35 +0000201
Neha Sharma94f16a92020-06-26 04:17:55 +0000202 b.updateLiveness(ctx, b.isErrorIndicatingAliveKvstore(ctx, err))
Girish Kumarca522102019-11-08 11:26:35 +0000203
204 return pair, err
Scott Baker2c1c4822019-10-16 11:02:41 -0700205}
206
207// Put stores an item value under the specifed key
npujar5bf737f2020-01-16 19:35:25 +0530208func (b *Backend) Put(ctx context.Context, key string, value interface{}) error {
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000209 span, ctx := log.CreateChildSpan(ctx, "etcd-put")
210 defer span.Finish()
211
Neha Sharma94f16a92020-06-26 04:17:55 +0000212 formattedPath := b.makePath(ctx, key)
213 logger.Debugw(ctx, "putting-key", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700214
npujar5bf737f2020-01-16 19:35:25 +0530215 err := b.Client.Put(ctx, formattedPath, value)
Girish Kumarca522102019-11-08 11:26:35 +0000216
Neha Sharma94f16a92020-06-26 04:17:55 +0000217 b.updateLiveness(ctx, b.isErrorIndicatingAliveKvstore(ctx, err))
Girish Kumarca522102019-11-08 11:26:35 +0000218
219 return err
Scott Baker2c1c4822019-10-16 11:02:41 -0700220}
221
222// Delete removes an item under the specified key
npujar5bf737f2020-01-16 19:35:25 +0530223func (b *Backend) Delete(ctx context.Context, key string) error {
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000224 span, ctx := log.CreateChildSpan(ctx, "etcd-delete")
225 defer span.Finish()
226
Neha Sharma94f16a92020-06-26 04:17:55 +0000227 formattedPath := b.makePath(ctx, key)
228 logger.Debugw(ctx, "deleting-key", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700229
npujar5bf737f2020-01-16 19:35:25 +0530230 err := b.Client.Delete(ctx, formattedPath)
Girish Kumarca522102019-11-08 11:26:35 +0000231
Neha Sharma94f16a92020-06-26 04:17:55 +0000232 b.updateLiveness(ctx, b.isErrorIndicatingAliveKvstore(ctx, err))
Girish Kumarca522102019-11-08 11:26:35 +0000233
234 return err
Scott Baker2c1c4822019-10-16 11:02:41 -0700235}
236
Serkant Uluderya198de902020-11-16 20:29:17 +0300237// DeleteWithPrefix removes items having prefix key
238func (b *Backend) DeleteWithPrefix(ctx context.Context, prefixKey string) error {
239 span, ctx := log.CreateChildSpan(ctx, "etcd-delete-with-prefix")
240 defer span.Finish()
241
242 formattedPath := b.makePath(ctx, prefixKey)
243 logger.Debugw(ctx, "deleting-prefix-key", log.Fields{"key": prefixKey, "path": formattedPath})
244
245 err := b.Client.DeleteWithPrefix(ctx, formattedPath)
246
247 b.updateLiveness(ctx, b.isErrorIndicatingAliveKvstore(ctx, err))
248
249 return err
250}
251
Scott Baker2c1c4822019-10-16 11:02:41 -0700252// CreateWatch starts watching events for the specified key
divyadesai8bf96862020-02-07 12:24:26 +0000253func (b *Backend) CreateWatch(ctx context.Context, key string, withPrefix bool) chan *kvstore.Event {
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000254 span, ctx := log.CreateChildSpan(ctx, "etcd-create-watch")
255 defer span.Finish()
256
Neha Sharma94f16a92020-06-26 04:17:55 +0000257 formattedPath := b.makePath(ctx, key)
258 logger.Debugw(ctx, "creating-key-watch", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700259
divyadesai8bf96862020-02-07 12:24:26 +0000260 return b.Client.Watch(ctx, formattedPath, withPrefix)
Scott Baker2c1c4822019-10-16 11:02:41 -0700261}
262
263// DeleteWatch stops watching events for the specified key
Neha Sharma94f16a92020-06-26 04:17:55 +0000264func (b *Backend) DeleteWatch(ctx context.Context, key string, ch chan *kvstore.Event) {
Rohan Agrawalfb1cb352020-08-03 04:59:32 +0000265 span, ctx := log.CreateChildSpan(ctx, "etcd-delete-watch")
266 defer span.Finish()
267
Neha Sharma94f16a92020-06-26 04:17:55 +0000268 formattedPath := b.makePath(ctx, key)
269 logger.Debugw(ctx, "deleting-key-watch", log.Fields{"key": key, "path": formattedPath})
Scott Baker2c1c4822019-10-16 11:02:41 -0700270
Neha Sharma94f16a92020-06-26 04:17:55 +0000271 b.Client.CloseWatch(ctx, formattedPath, ch)
Scott Baker2c1c4822019-10-16 11:02:41 -0700272}