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