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 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)
  18 //  platform project (RICP).
  19
  20
  21 package services
  22
  23 import (
  24         "e2mgr/configuration"
  25         "e2mgr/logger"
  26         "e2mgr/rNibWriter"
  27         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  28         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  29         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/reader"
  30         "net"
  31         "time"
  32 )
  33
  34 type RNibDataService interface {
  35         SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error
  36         UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
  37         SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
  38         GetNodeb(ranName string) (*entities.NodebInfo, error)
  39         GetListNodebIds() ([]*entities.NbIdentity, error)
  40         PingRnib() bool
  41         GetE2TInstance(address string) (*entities.E2TInstance, error)
  42         GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error)
  43         GetE2TAddresses() ([]string, error)
  44         SaveE2TInstance(e2tInstance *entities.E2TInstance) error
  45         SaveE2TAddresses(addresses []string) error
  46         GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error)
  47         GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error)
  48         SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error
  49         GetE2TAddressesNoLogs() ([]string, error)
  50         RemoveE2TInstance(e2tAddress string) error
  51         UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error
  52 }
  53
  54 type rNibDataService struct {
  55         logger        *logger.Logger
  56         rnibReader    reader.RNibReader
  57         rnibWriter    rNibWriter.RNibWriter
  58         maxAttempts   int
  59         retryInterval time.Duration
  60 }
  61
  62 func NewRnibDataService(logger *logger.Logger, config *configuration.Configuration, rnibReader reader.RNibReader, rnibWriter rNibWriter.RNibWriter) *rNibDataService {
  63         return &rNibDataService{
  64                 logger:        logger,
  65                 rnibReader:    rnibReader,
  66                 rnibWriter:    rnibWriter,
  67                 maxAttempts:   config.MaxRnibConnectionAttempts,
  68                 retryInterval: time.Duration(config.RnibRetryIntervalMs) * time.Millisecond,
  69         }
  70 }
  71
  72 func (w *rNibDataService) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
  73         w.logger.Infof("#RnibDataService.UpdateGnbCells - nodebInfo: %s, servedNrCells: %s", nodebInfo, servedNrCells)
  74
  75         err := w.retry("UpdateGnbCells", func() (err error) {
  76                 err = w.rnibWriter.UpdateGnbCells(nodebInfo, servedNrCells)
  77                 return
  78         })
  79
  80         return err
  81 }
  82
  83 func (w *rNibDataService) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
  84         w.logger.Infof("#RnibDataService.UpdateNodebInfo - nodebInfo: %s", nodebInfo)
  85
  86         err := w.retry("UpdateNodebInfo", func() (err error) {
  87                 err = w.rnibWriter.UpdateNodebInfo(nodebInfo)
  88                 return
  89         })
  90
  91         return err
  92 }
  93
  94 func (w *rNibDataService) SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error {
  95         w.logger.Infof("#RnibDataService.SaveNodeb - nbIdentity: %s, nodebInfo: %s", nbIdentity, nb)
  96
  97         err := w.retry("SaveNodeb", func() (err error) {
  98                 err = w.rnibWriter.SaveNodeb(nbIdentity, nb)
  99                 return
 100         })
 101
 102         return err
 103 }
 104
 105 func (w *rNibDataService) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
 106         w.logger.Infof("#RnibDataService.SaveRanLoadInformation - inventoryName: %s, ranLoadInformation: %s", inventoryName, ranLoadInformation)
 107
 108         err := w.retry("SaveRanLoadInformation", func() (err error) {
 109                 err = w.rnibWriter.SaveRanLoadInformation(inventoryName, ranLoadInformation)
 110                 return
 111         })
 112
 113         return err
 114 }
 115
 116 func (w *rNibDataService) GetNodeb(ranName string) (*entities.NodebInfo, error) {
 117
 118         var nodeb *entities.NodebInfo = nil
 119
 120         err := w.retry("GetNodeb", func() (err error) {
 121                 nodeb, err = w.rnibReader.GetNodeb(ranName)
 122                 return
 123         })
 124
 125         if err == nil {
 126                 w.logger.Infof("#RnibDataService.GetNodeb - RAN name: %s, connection status: %s, associated E2T: %s", nodeb.RanName, nodeb.ConnectionStatus, nodeb.AssociatedE2TInstanceAddress)
 127         }
 128
 129         return nodeb, err
 130 }
 131
 132 func (w *rNibDataService) GetListNodebIds() ([]*entities.NbIdentity, error) {
 133         var nodeIds []*entities.NbIdentity = nil
 134
 135         err := w.retry("GetListNodebIds", func() (err error) {
 136                 nodeIds, err = w.rnibReader.GetListNodebIds()
 137                 return
 138         })
 139
 140         if err == nil {
 141                 w.logger.Infof("#RnibDataService.GetListNodebIds - RANs count: %d", len(nodeIds))
 142         }
 143
 144         return nodeIds, err
 145 }
 146
 147 func (w *rNibDataService) GetE2TInstance(address string) (*entities.E2TInstance, error) {
 148         var e2tInstance *entities.E2TInstance = nil
 149
 150         err := w.retry("GetE2TInstance", func() (err error) {
 151                 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
 152                 return
 153         })
 154
 155         if err == nil {
 156                 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)
 157         }
 158
 159         return e2tInstance, err
 160 }
 161
 162 func (w *rNibDataService) GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error) {
 163         var e2tInstance *entities.E2TInstance = nil
 164
 165         err := w.retry("GetE2TInstance", func() (err error) {
 166                 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
 167                 return
 168         })
 169
 170         return e2tInstance, err
 171 }
 172
 173 func (w *rNibDataService) GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error) {
 174         w.logger.Infof("#RnibDataService.GetE2TInstances - addresses: %s", addresses)
 175         var e2tInstances []*entities.E2TInstance = nil
 176
 177         err := w.retry("GetE2TInstance", func() (err error) {
 178                 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
 179                 return
 180         })
 181
 182         return e2tInstances, err
 183 }
 184
 185 func (w *rNibDataService) GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error) {
 186
 187         var e2tInstances []*entities.E2TInstance = nil
 188
 189         err := w.retry("GetE2TInstance", func() (err error) {
 190                 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
 191                 return
 192         })
 193
 194         return e2tInstances, err
 195 }
 196
 197 func (w *rNibDataService) GetE2TAddresses() ([]string, error) {
 198
 199         var e2tAddresses []string = nil
 200
 201         err := w.retry("GetE2TAddresses", func() (err error) {
 202                 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
 203                 return
 204         })
 205
 206         if err == nil {
 207                 w.logger.Infof("#RnibDataService.GetE2TAddresses - addresses: %s", e2tAddresses)
 208         }
 209
 210         return e2tAddresses, err
 211 }
 212
 213 func (w *rNibDataService) GetE2TAddressesNoLogs() ([]string, error) {
 214
 215         var e2tAddresses []string = nil
 216
 217         err := w.retry("GetE2TAddresses", func() (err error) {
 218                 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
 219                 return
 220         })
 221
 222         return e2tAddresses, err
 223 }
 224
 225 func (w *rNibDataService) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
 226         w.logger.Infof("#RnibDataService.SaveE2TInstance - E2T instance address: %s, podName: %s, state: %s, associated RANs count: %d, keep Alive ts: %d", e2tInstance.Address, e2tInstance.PodName, e2tInstance.State, len(e2tInstance.AssociatedRanList), e2tInstance.KeepAliveTimestamp)
 227
 228         return w.SaveE2TInstanceNoLogs(e2tInstance)
 229 }
 230
 231 func (w *rNibDataService) SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error {
 232
 233         err := w.retry("SaveE2TInstance", func() (err error) {
 234                 err = w.rnibWriter.SaveE2TInstance(e2tInstance)
 235                 return
 236         })
 237
 238         return err
 239 }
 240
 241 func (w *rNibDataService) SaveE2TAddresses(addresses []string) error {
 242         w.logger.Infof("#RnibDataService.SaveE2TAddresses - addresses: %s", addresses)
 243
 244         err := w.retry("SaveE2TAddresses", func() (err error) {
 245                 err = w.rnibWriter.SaveE2TAddresses(addresses)
 246                 return
 247         })
 248
 249         return err
 250 }
 251
 252 func (w *rNibDataService) RemoveE2TInstance(e2tAddress string) error {
 253         w.logger.Infof("#RnibDataService.RemoveE2TInstance - e2tAddress: %s", e2tAddress)
 254
 255         err := w.retry("RemoveE2TInstance", func() (err error) {
 256                 err = w.rnibWriter.RemoveE2TInstance(e2tAddress)
 257                 return
 258         })
 259
 260         return err
 261 }
 262
 263 func (w *rNibDataService) PingRnib() bool {
 264         err := w.retry("GetListNodebIds", func() (err error) {
 265                 _, err = w.rnibReader.GetListNodebIds()
 266                 return
 267         })
 268
 269         return !isRnibConnectionError(err)
 270 }
 271
 272 func (w *rNibDataService) retry(rnibFunc string, f func() error) (err error) {
 273         attempts := w.maxAttempts
 274
 275         for i := 1; ; i++ {
 276                 err = f()
 277                 if err == nil {
 278                         return
 279                 }
 280                 if !isRnibConnectionError(err) {
 281                         return err
 282                 }
 283                 if i >= attempts {
 284                         w.logger.Errorf("#RnibDataService.retry - after %d attempts of %s, last error: %s", attempts, rnibFunc, err)
 285                         return err
 286                 }
 287                 time.Sleep(w.retryInterval)
 288
 289                 w.logger.Infof("#RnibDataService.retry - retrying %d %s after error: %s", i, rnibFunc, err)
 290         }
 291 }
 292
 293 func isRnibConnectionError(err error) bool {
 294         internalErr, ok := err.(*common.InternalError)
 295         if !ok {
 296                 return false
 297         }
 298         _, ok = internalErr.Err.(*net.OpError)
 299
 300         return ok
 301 }