E2Manager/services/rnib_data_service.go

   1 //
   2 // Copyright 2019 AT&T Intellectual Property
   3 // Copyright 2019 Nokia
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the "License");
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //      http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 package services
  19
  20 import (
  21         "e2mgr/configuration"
  22         "e2mgr/logger"
  23         "e2mgr/rNibWriter"
  24         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  25         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  26         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/reader"
  27         "net"
  28         "time"
  29 )
  30
  31 type RNibDataService interface {
  32         SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error
  33         UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
  34         SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
  35         GetNodeb(ranName string) (*entities.NodebInfo, error)
  36         GetListNodebIds() ([]*entities.NbIdentity, error)
  37         PingRnib() bool
  38         GetE2TInstance(address string) (*entities.E2TInstance, error)
  39         GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error)
  40         GetE2TAddresses() ([]string, error)
  41         SaveE2TInstance(e2tInstance *entities.E2TInstance) error
  42         SaveE2TAddresses(addresses []string) error
  43         GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error)
  44         GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error)
  45         SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error
  46         GetE2TAddressesNoLogs() ([]string, error)
  47 }
  48
  49 type rNibDataService struct {
  50         logger        *logger.Logger
  51         rnibReader    reader.RNibReader
  52         rnibWriter    rNibWriter.RNibWriter
  53         maxAttempts   int
  54         retryInterval time.Duration
  55 }
  56
  57 func NewRnibDataService(logger *logger.Logger, config *configuration.Configuration, rnibReader reader.RNibReader, rnibWriter rNibWriter.RNibWriter) *rNibDataService {
  58         return &rNibDataService{
  59                 logger:        logger,
  60                 rnibReader:    rnibReader,
  61                 rnibWriter:    rnibWriter,
  62                 maxAttempts:   config.MaxRnibConnectionAttempts,
  63                 retryInterval: time.Duration(config.RnibRetryIntervalMs) * time.Millisecond,
  64         }
  65 }
  66
  67 func (w *rNibDataService) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
  68         w.logger.Infof("#RnibDataService.UpdateNodebInfo - nodebInfo: %s", nodebInfo)
  69
  70         err := w.retry("UpdateNodebInfo", func() (err error) {
  71                 err = w.rnibWriter.UpdateNodebInfo(nodebInfo)
  72                 return
  73         })
  74
  75         return err
  76 }
  77
  78 func (w *rNibDataService) SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error {
  79         w.logger.Infof("#RnibDataService.SaveNodeb - nbIdentity: %s, nodebInfo: %s", nbIdentity, nb)
  80
  81         err := w.retry("SaveNodeb", func() (err error) {
  82                 err = w.rnibWriter.SaveNodeb(nbIdentity, nb)
  83                 return
  84         })
  85
  86         return err
  87 }
  88
  89 func (w *rNibDataService) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
  90         w.logger.Infof("#RnibDataService.SaveRanLoadInformation - inventoryName: %s, ranLoadInformation: %s", inventoryName, ranLoadInformation)
  91
  92         err := w.retry("SaveRanLoadInformation", func() (err error) {
  93                 err = w.rnibWriter.SaveRanLoadInformation(inventoryName, ranLoadInformation)
  94                 return
  95         })
  96
  97         return err
  98 }
  99
 100 func (w *rNibDataService) GetNodeb(ranName string) (*entities.NodebInfo, error) {
 101         w.logger.Infof("#RnibDataService.GetNodeb - RAN name: %s", ranName)
 102
 103         var nodeb *entities.NodebInfo = nil
 104
 105         err := w.retry("GetNodeb", func() (err error) {
 106                 nodeb, err = w.rnibReader.GetNodeb(ranName)
 107                 return
 108         })
 109
 110         return nodeb, err
 111 }
 112
 113 func (w *rNibDataService) GetListNodebIds() ([]*entities.NbIdentity, error) {
 114         w.logger.Infof("#RnibDataService.GetListNodebIds")
 115
 116         var nodeIds []*entities.NbIdentity = nil
 117
 118         err := w.retry("GetListNodebIds", func() (err error) {
 119                 nodeIds, err = w.rnibReader.GetListNodebIds()
 120                 return
 121         })
 122
 123         return nodeIds, err
 124 }
 125
 126 func (w *rNibDataService) GetE2TInstance(address string) (*entities.E2TInstance, error) {
 127         var e2tInstance *entities.E2TInstance = nil
 128
 129         err := w.retry("GetE2TInstance", func() (err error) {
 130                 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
 131                 return
 132         })
 133
 134         if err == nil {
 135                 w.logger.Infof("#RnibDataService.GetE2TInstance - E2T instance address: %s, state: %s, associated RANs count: %d, keep Alive ts: %d", e2tInstance.Address, e2tInstance.State, len(e2tInstance.AssociatedRanList), e2tInstance.KeepAliveTimestamp)
 136         }
 137
 138         return e2tInstance, err
 139 }
 140
 141 func (w *rNibDataService) GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error) {
 142         var e2tInstance *entities.E2TInstance = nil
 143
 144         err := w.retry("GetE2TInstance", func() (err error) {
 145                 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
 146                 return
 147         })
 148
 149         return e2tInstance, err
 150 }
 151
 152 func (w *rNibDataService) GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error) {
 153         w.logger.Infof("#RnibDataService.GetE2TInstances - addresses: %s", addresses)
 154         var e2tInstances []*entities.E2TInstance = nil
 155
 156         err := w.retry("GetE2TInstance", func() (err error) {
 157                 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
 158                 return
 159         })
 160
 161         return e2tInstances, err
 162 }
 163
 164 func (w *rNibDataService) GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error) {
 165
 166         var e2tInstances []*entities.E2TInstance = nil
 167
 168         err := w.retry("GetE2TInstance", func() (err error) {
 169                 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
 170                 return
 171         })
 172
 173         return e2tInstances, err
 174 }
 175
 176 func (w *rNibDataService) GetE2TAddresses() ([]string, error) {
 177
 178         var e2tAddresses []string = nil
 179
 180         err := w.retry("GetE2TAddresses", func() (err error) {
 181                 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
 182                 return
 183         })
 184
 185         if err == nil {
 186                 w.logger.Infof("#RnibDataService.GetE2TAddresses - addresses: %s", e2tAddresses)
 187         }
 188
 189         return e2tAddresses, err
 190 }
 191
 192 func (w *rNibDataService) GetE2TAddressesNoLogs() ([]string, error) {
 193
 194         var e2tAddresses []string = nil
 195
 196         err := w.retry("GetE2TAddresses", func() (err error) {
 197                 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
 198                 return
 199         })
 200
 201         return e2tAddresses, err
 202 }
 203
 204 func (w *rNibDataService) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
 205         w.logger.Infof("#RnibDataService.SaveE2TInstance - E2T instance address: %s, state: %s, associated RANs count: %d, keep Alive ts: %d", e2tInstance.Address, e2tInstance.State, len(e2tInstance.AssociatedRanList), e2tInstance.KeepAliveTimestamp)
 206
 207         return w.SaveE2TInstanceNoLogs(e2tInstance)
 208 }
 209
 210 func (w *rNibDataService) SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error {
 211
 212         err := w.retry("SaveE2TInstance", func() (err error) {
 213                 err = w.rnibWriter.SaveE2TInstance(e2tInstance)
 214                 return
 215         })
 216
 217         return err
 218 }
 219
 220 func (w *rNibDataService) SaveE2TAddresses(addresses []string) error {
 221         w.logger.Infof("#RnibDataService.SaveE2TAddresses - addresses: %s", addresses)
 222
 223         err := w.retry("SaveE2TAddresses", func() (err error) {
 224                 err = w.rnibWriter.SaveE2TAddresses(addresses)
 225                 return
 226         })
 227
 228         return err
 229 }
 230
 231 func (w *rNibDataService) PingRnib() bool {
 232         err := w.retry("GetListNodebIds", func() (err error) {
 233                 _, err = w.rnibReader.GetListNodebIds()
 234                 return
 235         })
 236
 237         return !isRnibConnectionError(err)
 238 }
 239
 240 func (w *rNibDataService) retry(rnibFunc string, f func() error) (err error) {
 241         attempts := w.maxAttempts
 242
 243         for i := 1; ; i++ {
 244                 err = f()
 245                 if err == nil {
 246                         return
 247                 }
 248                 if !isRnibConnectionError(err) {
 249                         return err
 250                 }
 251                 if i >= attempts {
 252                         w.logger.Errorf("#RnibDataService.retry - after %d attempts of %s, last error: %s", attempts, rnibFunc, err)
 253                         return err
 254                 }
 255                 time.Sleep(w.retryInterval)
 256
 257                 w.logger.Infof("#RnibDataService.retry - retrying %d %s after error: %s", i, rnibFunc, err)
 258         }
 259 }
 260
 261 func isRnibConnectionError(err error) bool {
 262         internalErr, ok := err.(*common.InternalError)
 263         if !ok {
 264                 return false
 265         }
 266         _, ok = internalErr.Err.(*net.OpError)
 267
 268         return ok
 269 }