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 }
  51
  52 type rNibDataService struct {
  53         logger        *logger.Logger
  54         rnibReader    reader.RNibReader
  55         rnibWriter    rNibWriter.RNibWriter
  56         maxAttempts   int
  57         retryInterval time.Duration
  58 }
  59
  60 func NewRnibDataService(logger *logger.Logger, config *configuration.Configuration, rnibReader reader.RNibReader, rnibWriter rNibWriter.RNibWriter) *rNibDataService {
  61         return &rNibDataService{
  62                 logger:        logger,
  63                 rnibReader:    rnibReader,
  64                 rnibWriter:    rnibWriter,
  65                 maxAttempts:   config.MaxRnibConnectionAttempts,
  66                 retryInterval: time.Duration(config.RnibRetryIntervalMs) * time.Millisecond,
  67         }
  68 }
  69
  70 func (w *rNibDataService) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
  71         w.logger.Infof("#RnibDataService.UpdateNodebInfo - nodebInfo: %s", nodebInfo)
  72
  73         err := w.retry("UpdateNodebInfo", func() (err error) {
  74                 err = w.rnibWriter.UpdateNodebInfo(nodebInfo)
  75                 return
  76         })
  77
  78         return err
  79 }
  80
  81 func (w *rNibDataService) SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error {
  82         w.logger.Infof("#RnibDataService.SaveNodeb - nbIdentity: %s, nodebInfo: %s", nbIdentity, nb)
  83
  84         err := w.retry("SaveNodeb", func() (err error) {
  85                 err = w.rnibWriter.SaveNodeb(nbIdentity, nb)
  86                 return
  87         })
  88
  89         return err
  90 }
  91
  92 func (w *rNibDataService) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
  93         w.logger.Infof("#RnibDataService.SaveRanLoadInformation - inventoryName: %s, ranLoadInformation: %s", inventoryName, ranLoadInformation)
  94
  95         err := w.retry("SaveRanLoadInformation", func() (err error) {
  96                 err = w.rnibWriter.SaveRanLoadInformation(inventoryName, ranLoadInformation)
  97                 return
  98         })
  99
 100         return err
 101 }
 102
 103 func (w *rNibDataService) GetNodeb(ranName string) (*entities.NodebInfo, error) {
 104         w.logger.Infof("#RnibDataService.GetNodeb - RAN name: %s", ranName)
 105
 106         var nodeb *entities.NodebInfo = nil
 107
 108         err := w.retry("GetNodeb", func() (err error) {
 109                 nodeb, err = w.rnibReader.GetNodeb(ranName)
 110                 return
 111         })
 112
 113         return nodeb, err
 114 }
 115
 116 func (w *rNibDataService) GetListNodebIds() ([]*entities.NbIdentity, error) {
 117         w.logger.Infof("#RnibDataService.GetListNodebIds")
 118
 119         var nodeIds []*entities.NbIdentity = nil
 120
 121         err := w.retry("GetListNodebIds", func() (err error) {
 122                 nodeIds, err = w.rnibReader.GetListNodebIds()
 123                 return
 124         })
 125
 126         return nodeIds, err
 127 }
 128
 129 func (w *rNibDataService) GetE2TInstance(address string) (*entities.E2TInstance, error) {
 130         var e2tInstance *entities.E2TInstance = nil
 131
 132         err := w.retry("GetE2TInstance", func() (err error) {
 133                 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
 134                 return
 135         })
 136
 137         if err == nil {
 138                 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)
 139         }
 140
 141         return e2tInstance, err
 142 }
 143
 144 func (w *rNibDataService) GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error) {
 145         var e2tInstance *entities.E2TInstance = nil
 146
 147         err := w.retry("GetE2TInstance", func() (err error) {
 148                 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
 149                 return
 150         })
 151
 152         return e2tInstance, err
 153 }
 154
 155 func (w *rNibDataService) GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error) {
 156         w.logger.Infof("#RnibDataService.GetE2TInstances - addresses: %s", addresses)
 157         var e2tInstances []*entities.E2TInstance = nil
 158
 159         err := w.retry("GetE2TInstance", func() (err error) {
 160                 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
 161                 return
 162         })
 163
 164         return e2tInstances, err
 165 }
 166
 167 func (w *rNibDataService) GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error) {
 168
 169         var e2tInstances []*entities.E2TInstance = nil
 170
 171         err := w.retry("GetE2TInstance", func() (err error) {
 172                 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
 173                 return
 174         })
 175
 176         return e2tInstances, err
 177 }
 178
 179 func (w *rNibDataService) GetE2TAddresses() ([]string, error) {
 180
 181         var e2tAddresses []string = nil
 182
 183         err := w.retry("GetE2TAddresses", func() (err error) {
 184                 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
 185                 return
 186         })
 187
 188         if err == nil {
 189                 w.logger.Infof("#RnibDataService.GetE2TAddresses - addresses: %s", e2tAddresses)
 190         }
 191
 192         return e2tAddresses, err
 193 }
 194
 195 func (w *rNibDataService) GetE2TAddressesNoLogs() ([]string, error) {
 196
 197         var e2tAddresses []string = nil
 198
 199         err := w.retry("GetE2TAddresses", func() (err error) {
 200                 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
 201                 return
 202         })
 203
 204         return e2tAddresses, err
 205 }
 206
 207 func (w *rNibDataService) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
 208         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)
 209
 210         return w.SaveE2TInstanceNoLogs(e2tInstance)
 211 }
 212
 213 func (w *rNibDataService) SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error {
 214
 215         err := w.retry("SaveE2TInstance", func() (err error) {
 216                 err = w.rnibWriter.SaveE2TInstance(e2tInstance)
 217                 return
 218         })
 219
 220         return err
 221 }
 222
 223 func (w *rNibDataService) SaveE2TAddresses(addresses []string) error {
 224         w.logger.Infof("#RnibDataService.SaveE2TAddresses - addresses: %s", addresses)
 225
 226         err := w.retry("SaveE2TAddresses", func() (err error) {
 227                 err = w.rnibWriter.SaveE2TAddresses(addresses)
 228                 return
 229         })
 230
 231         return err
 232 }
 233
 234 func (w *rNibDataService) PingRnib() bool {
 235         err := w.retry("GetListNodebIds", func() (err error) {
 236                 _, err = w.rnibReader.GetListNodebIds()
 237                 return
 238         })
 239
 240         return !isRnibConnectionError(err)
 241 }
 242
 243 func (w *rNibDataService) retry(rnibFunc string, f func() error) (err error) {
 244         attempts := w.maxAttempts
 245
 246         for i := 1; ; i++ {
 247                 err = f()
 248                 if err == nil {
 249                         return
 250                 }
 251                 if !isRnibConnectionError(err) {
 252                         return err
 253                 }
 254                 if i >= attempts {
 255                         w.logger.Errorf("#RnibDataService.retry - after %d attempts of %s, last error: %s", attempts, rnibFunc, err)
 256                         return err
 257                 }
 258                 time.Sleep(w.retryInterval)
 259
 260                 w.logger.Infof("#RnibDataService.retry - retrying %d %s after error: %s", i, rnibFunc, err)
 261         }
 262 }
 263
 264 func isRnibConnectionError(err error) bool {
 265         internalErr, ok := err.(*common.InternalError)
 266         if !ok {
 267                 return false
 268         }
 269         _, ok = internalErr.Err.(*net.OpError)
 270
 271         return ok
 272 }