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