E2Manager/managers/e2t_instances_manager.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
  18 package managers
  19
  20 import (
  21         "e2mgr/e2managererrors"
  22         "e2mgr/logger"
  23         "e2mgr/services"
  24         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  25         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  26         "math"
  27         "sync"
  28         "time"
  29 )
  30
  31 type E2TInstancesManager struct {
  32         rnibDataService services.RNibDataService
  33         logger          *logger.Logger
  34         mux             sync.Mutex
  35 }
  36
  37 type IE2TInstancesManager interface {
  38         GetE2TInstance(e2tAddress string) (*entities.E2TInstance, error)
  39         GetE2TInstances() ([]*entities.E2TInstance, error)
  40         GetE2TInstancesNoLogs() ([]*entities.E2TInstance, error)
  41         AddE2TInstance(e2tAddress string) error
  42         RemoveE2TInstance(e2tInstance *entities.E2TInstance) error
  43         SelectE2TInstance() (string, error)
  44         AssociateRan(ranName string, e2tAddress string) error
  45         DissociateRan(ranName string, e2tAddress string) error
  46         ResetKeepAliveTimestamp(e2tAddress string) error
  47 }
  48
  49 func NewE2TInstancesManager(rnibDataService services.RNibDataService, logger *logger.Logger) *E2TInstancesManager {
  50         return &E2TInstancesManager{
  51                 rnibDataService: rnibDataService,
  52                 logger:          logger,
  53         }
  54 }
  55
  56 func (m *E2TInstancesManager) GetE2TInstance(e2tAddress string) (*entities.E2TInstance, error) {
  57         e2tInstance, err := m.rnibDataService.GetE2TInstance(e2tAddress)
  58
  59         if err != nil {
  60
  61                 _, ok := err.(*common.ResourceNotFoundError)
  62
  63                 if !ok {
  64                         m.logger.Errorf("#E2TInstancesManager.GetE2TInstance - E2T Instance address: %s - Failed retrieving E2TInstance. error: %s", e2tAddress, err)
  65                 } else {
  66                         m.logger.Infof("#E2TInstancesManager.GetE2TInstance - E2T Instance address: %s not found on DB", e2tAddress)
  67                 }
  68         }
  69
  70         return e2tInstance, err
  71 }
  72
  73 func (m *E2TInstancesManager) GetE2TInstancesNoLogs() ([]*entities.E2TInstance, error) {
  74         e2tAddresses, err := m.rnibDataService.GetE2TAddressesNoLogs()
  75
  76         if err != nil {
  77                 _, ok := err.(*common.ResourceNotFoundError)
  78
  79                 if !ok {
  80                         m.logger.Errorf("#E2TInstancesManager.GetE2TInstancesNoLogs - Failed retrieving E2T addresses. error: %s", err)
  81                 }
  82                 return nil, err
  83         }
  84
  85         if len(e2tAddresses) == 0 {
  86                 return []*entities.E2TInstance{}, nil
  87         }
  88
  89         e2tInstances, err := m.rnibDataService.GetE2TInstancesNoLogs(e2tAddresses)
  90
  91         if err != nil {
  92                 _, ok := err.(*common.ResourceNotFoundError)
  93
  94                 if !ok {
  95                         m.logger.Errorf("#E2TInstancesManager.GetE2TInstancesNoLogs - Failed retrieving E2T instances list. error: %s", err)
  96                 }
  97                 return e2tInstances, err
  98         }
  99
 100         return e2tInstances, nil
 101 }
 102
 103 func (m *E2TInstancesManager) GetE2TInstances() ([]*entities.E2TInstance, error) {
 104         e2tAddresses, err := m.rnibDataService.GetE2TAddresses()
 105
 106         if err != nil {
 107                 m.logger.Errorf("#E2TInstancesManager.GetE2TInstances - Failed retrieving E2T addresses. error: %s", err)
 108                 return nil, err
 109         }
 110
 111         if len(e2tAddresses) == 0 {
 112                 m.logger.Infof("#E2TInstancesManager.GetE2TInstances - Empty E2T addresses list")
 113                 return []*entities.E2TInstance{}, nil
 114         }
 115
 116         e2tInstances, err := m.rnibDataService.GetE2TInstances(e2tAddresses)
 117
 118         if err != nil {
 119                 m.logger.Errorf("#E2TInstancesManager.GetE2TInstances - Failed retrieving E2T instances list. error: %s", err)
 120                 return e2tInstances, err
 121         }
 122
 123         if len(e2tInstances) == 0 {
 124                 m.logger.Warnf("#E2TInstancesManager.GetE2TInstances - Empty E2T instances list")
 125                 return e2tInstances, nil
 126         }
 127
 128         return e2tInstances, nil
 129 }
 130
 131 func findActiveE2TInstanceWithMinimumAssociatedRans(e2tInstances []*entities.E2TInstance) *entities.E2TInstance {
 132         var minInstance *entities.E2TInstance
 133         minAssociatedRanCount := math.MaxInt32
 134
 135         for _, v := range e2tInstances {
 136                 if v.State == entities.Active && len(v.AssociatedRanList) < minAssociatedRanCount {
 137                         minAssociatedRanCount = len(v.AssociatedRanList)
 138                         minInstance = v
 139                 }
 140         }
 141
 142         return minInstance
 143 }
 144
 145 func (m *E2TInstancesManager) AddE2TInstance(e2tAddress string) error {
 146
 147         m.mux.Lock()
 148         defer m.mux.Unlock()
 149
 150         e2tInstance := entities.NewE2TInstance(e2tAddress)
 151         err := m.rnibDataService.SaveE2TInstance(e2tInstance)
 152
 153         if err != nil {
 154                 m.logger.Errorf("#E2TInstancesManager.AddE2TInstance - E2T Instance address: %s - Failed saving E2T instance. error: %s", e2tInstance.Address, err)
 155                 return err
 156         }
 157
 158
 159         e2tAddresses, err := m.rnibDataService.GetE2TAddresses()
 160
 161         if err != nil {
 162
 163                 _, ok := err.(*common.ResourceNotFoundError)
 164
 165                 if !ok {
 166                         m.logger.Errorf("#E2TInstancesManager.AddE2TInstance - E2T Instance address: %s - Failed retrieving E2T addresses list. error: %s", e2tInstance.Address, err)
 167                         return err
 168                 }
 169         }
 170
 171         e2tAddresses = append(e2tAddresses, e2tInstance.Address)
 172
 173         err = m.rnibDataService.SaveE2TAddresses(e2tAddresses)
 174
 175         if err != nil {
 176                 m.logger.Errorf("#E2TInstancesManager.AddE2TInstance - E2T Instance address: %s - Failed saving E2T addresses list. error: %s", e2tInstance.Address, err)
 177                 return err
 178         }
 179
 180         m.logger.Infof("#E2TInstancesManager.AddE2TInstance - E2T Instance address: %s - successfully added E2T instance", e2tInstance.Address)
 181         return nil
 182 }
 183
 184 func (m *E2TInstancesManager) DissociateRan(ranName string, e2tAddress string) error {
 185
 186         m.mux.Lock()
 187         defer m.mux.Unlock()
 188
 189         e2tInstance, err := m.rnibDataService.GetE2TInstance(e2tAddress)
 190
 191         if err != nil {
 192                 m.logger.Errorf("#E2TInstancesManager.DissociateRan - E2T Instance address: %s - Failed retrieving E2TInstance. error: %s", e2tAddress, err)
 193                 return err
 194         }
 195
 196         i := 0 // output index
 197         for _, v := range e2tInstance.AssociatedRanList {
 198                 if v != ranName {
 199                         // copy and increment index
 200                         e2tInstance.AssociatedRanList[i] = v
 201                         i++
 202                 }
 203         }
 204
 205         e2tInstance.AssociatedRanList = e2tInstance.AssociatedRanList[:i]
 206
 207         err = m.rnibDataService.SaveE2TInstance(e2tInstance)
 208
 209         if err != nil {
 210                 m.logger.Errorf("#E2TInstancesManager.DissociateRan - E2T Instance address: %s - Failed saving E2TInstance. error: %s", e2tAddress, err)
 211                 return err
 212         }
 213
 214         m.logger.Infof("#E2TInstancesManager.DissociateRan - successfully dissociated RAN %s from E2T %s", ranName, e2tInstance.Address)
 215         return nil
 216 }
 217
 218 func (m *E2TInstancesManager) RemoveE2TInstance(e2tInstance *entities.E2TInstance) error {
 219         return nil
 220 }
 221 func (m *E2TInstancesManager) SelectE2TInstance() (string, error) {
 222
 223         e2tInstances, err := m.GetE2TInstances()
 224
 225         if err != nil {
 226                 return "", e2managererrors.NewRnibDbError()
 227         }
 228
 229         if len(e2tInstances) == 0 {
 230                 m.logger.Errorf("#E2TInstancesManager.SelectE2TInstance - No E2T instance found")
 231                 return "", e2managererrors.NewE2TInstanceAbsenceError()
 232         }
 233
 234         min := findActiveE2TInstanceWithMinimumAssociatedRans(e2tInstances)
 235
 236         if min == nil {
 237                 m.logger.Errorf("#E2TInstancesManager.SelectE2TInstance - No active E2T instance found")
 238                 return "", e2managererrors.NewE2TInstanceAbsenceError()
 239         }
 240
 241         m.logger.Infof("#E2TInstancesManager.SelectE2TInstance - successfully selected E2T instance. address: %s", min.Address)
 242         return min.Address, nil
 243 }
 244
 245 func (m *E2TInstancesManager) AssociateRan(ranName string, e2tAddress string) error {
 246
 247         m.mux.Lock()
 248         defer m.mux.Unlock()
 249
 250         e2tInstance, err := m.rnibDataService.GetE2TInstance(e2tAddress)
 251
 252         if err != nil {
 253                 m.logger.Errorf("#E2TInstancesManager.AssociateRan - E2T Instance address: %s - Failed retrieving E2TInstance. error: %s", e2tAddress, err)
 254                 return e2managererrors.NewRnibDbError()
 255         }
 256
 257         e2tInstance.AssociatedRanList = append(e2tInstance.AssociatedRanList, ranName)
 258
 259         err = m.rnibDataService.SaveE2TInstance(e2tInstance)
 260
 261         if err != nil {
 262                 m.logger.Errorf("#E2TInstancesManager.AssociateRan - E2T Instance address: %s - Failed saving E2TInstance. error: %s", e2tAddress, err)
 263                 return e2managererrors.NewRnibDbError()
 264         }
 265
 266         m.logger.Infof("#E2TInstancesManager.AssociateRan - successfully associated RAN %s with E2T %s", ranName, e2tInstance.Address)
 267         return nil
 268 }
 269
 270 func (m *E2TInstancesManager) ResetKeepAliveTimestamp(e2tAddress string) error {
 271
 272         m.mux.Lock()
 273         defer m.mux.Unlock()
 274
 275         e2tInstance, err := m.rnibDataService.GetE2TInstanceNoLogs(e2tAddress)
 276
 277         if err != nil {
 278                 m.logger.Errorf("#E2TInstancesManager.ResetKeepAliveTimestamp - E2T Instance address: %s - Failed retrieving E2TInstance. error: %s", e2tAddress, err)
 279                 return err
 280         }
 281
 282         if e2tInstance.State == entities.ToBeDeleted || e2tInstance.State == entities.RoutingManagerFailure {
 283                 m.logger.Warnf("#E2TInstancesManager.ResetKeepAliveTimestamp - Ignore. This Instance is about to deleted")
 284                 return nil
 285
 286         }
 287
 288         e2tInstance.KeepAliveTimestamp = time.Now().UnixNano()
 289         err = m.rnibDataService.SaveE2TInstanceNoLogs(e2tInstance)
 290
 291         if err != nil {
 292                 m.logger.Errorf("#E2TInstancesManager.ResetKeepAliveTimestamp - E2T Instance address: %s - Failed saving E2TInstance. error: %s", e2tAddress, err)
 293                 return err
 294         }
 295
 296         return nil
 297 }