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