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