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