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