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