E2Manager/managers/ran_reconnection_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/configuration"
  22         "e2mgr/logger"
  23         "e2mgr/services"
  24         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  25 )
  26
  27 type IRanReconnectionManager interface {
  28         ReconnectRan(inventoryName string) error
  29 }
  30
  31 type RanReconnectionManager struct {
  32         logger              *logger.Logger
  33         config              *configuration.Configuration
  34         rnibDataService     services.RNibDataService
  35         ranSetupManager     *RanSetupManager
  36         e2tInstancesManager IE2TInstancesManager
  37 }
  38
  39 func NewRanReconnectionManager(logger *logger.Logger, config *configuration.Configuration, rnibDataService services.RNibDataService, ranSetupManager *RanSetupManager, e2tInstancesManager IE2TInstancesManager) *RanReconnectionManager {
  40         return &RanReconnectionManager{
  41                 logger:              logger,
  42                 config:              config,
  43                 rnibDataService:     rnibDataService,
  44                 ranSetupManager:     ranSetupManager,
  45                 e2tInstancesManager: e2tInstancesManager,
  46         }
  47 }
  48
  49 func (m *RanReconnectionManager) isRanExceededConnectionAttempts(nodebInfo *entities.NodebInfo) bool {
  50         return int(nodebInfo.GetConnectionAttempts()) >= m.config.MaxConnectionAttempts
  51 }
  52
  53 func (m *RanReconnectionManager) ReconnectRan(inventoryName string) error {
  54         nodebInfo, rnibErr := m.rnibDataService.GetNodeb(inventoryName)
  55
  56         if rnibErr != nil {
  57                 m.logger.Errorf("#RanReconnectionManager.ReconnectRan - RAN name: %s - Failed fetching RAN from rNib. Error: %v", inventoryName, rnibErr)
  58                 return rnibErr
  59         }
  60
  61         m.logger.Infof("#RanReconnectionManager.ReconnectRan - RAN name: %s - RAN's connection status: %s, RAN's connection attempts: %d", nodebInfo.RanName, nodebInfo.ConnectionStatus, nodebInfo.ConnectionAttempts)
  62
  63         if !m.canReconnectRan(nodebInfo) {
  64                 err := m.setConnectionStatusOfUnconnectableRan(nodebInfo)
  65
  66                 if err != nil {
  67                         return err
  68                 }
  69
  70                 if m.isRanExceededConnectionAttempts(nodebInfo) {
  71                         return m.e2tInstancesManager.DeassociateRan(nodebInfo.RanName, nodebInfo.AssociatedE2TInstanceAddress)
  72                 }
  73
  74                 return nil
  75         }
  76
  77         err := m.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
  78
  79         if err != nil {
  80                 m.logger.Errorf("#RanReconnectionManager.ReconnectRan - RAN name: %s - Failed executing setup. Error: %v", inventoryName, err)
  81                 return err
  82         }
  83
  84         return nil
  85 }
  86
  87 func (m *RanReconnectionManager) canReconnectRan(nodebInfo *entities.NodebInfo) bool {
  88         connectionStatus := nodebInfo.GetConnectionStatus()
  89         return connectionStatus != entities.ConnectionStatus_SHUT_DOWN && connectionStatus != entities.ConnectionStatus_SHUTTING_DOWN &&
  90                 int(nodebInfo.GetConnectionAttempts()) < m.config.MaxConnectionAttempts
  91 }
  92
  93 func (m *RanReconnectionManager) updateNodebInfoStatus(nodebInfo *entities.NodebInfo, connectionStatus entities.ConnectionStatus) error {
  94         if nodebInfo.ConnectionStatus == connectionStatus {
  95                 return nil
  96         }
  97
  98         nodebInfo.ConnectionStatus = connectionStatus;
  99         err := m.rnibDataService.UpdateNodebInfo(nodebInfo)
 100
 101         if err != nil {
 102                 m.logger.Errorf("#RanReconnectionManager.updateNodebInfoStatus - RAN name: %s - Failed updating RAN's connection status to %s in rNib. Error: %v", nodebInfo.RanName, connectionStatus, err)
 103                 return err
 104         }
 105
 106         m.logger.Infof("#RanReconnectionManager.updateNodebInfoStatus - RAN name: %s - Successfully updated rNib. RAN's current connection status: %s", nodebInfo.RanName, nodebInfo.ConnectionStatus)
 107         return nil
 108 }
 109
 110 func (m *RanReconnectionManager) setConnectionStatusOfUnconnectableRan(nodebInfo *entities.NodebInfo) error {
 111         connectionStatus := nodebInfo.GetConnectionStatus()
 112
 113         if connectionStatus == entities.ConnectionStatus_SHUT_DOWN {
 114                 m.logger.Warnf("#RanReconnectionManager.ReconnectRan - RAN name: %s - Cannot reconnect RAN. Reason: connection status is SHUT_DOWN", nodebInfo.RanName)
 115                 return nil
 116         }
 117
 118         if connectionStatus == entities.ConnectionStatus_SHUTTING_DOWN {
 119                 m.logger.Warnf("#RanReconnectionManager.ReconnectRan - RAN name: %s - Cannot reconnect RAN. Reason: connection status is SHUTTING_DOWN", nodebInfo.RanName)
 120                 return m.updateNodebInfoStatus(nodebInfo, entities.ConnectionStatus_SHUT_DOWN)
 121         }
 122
 123         if m.isRanExceededConnectionAttempts(nodebInfo) {
 124                 m.logger.Warnf("#RanReconnectionManager.ReconnectRan - RAN name: %s - Cannot reconnect RAN. Reason: RAN's connection attempts exceeded the limit (%d)", nodebInfo.RanName, m.config.MaxConnectionAttempts)
 125                 return m.updateNodebInfoStatus(nodebInfo, entities.ConnectionStatus_DISCONNECTED)
 126         }
 127
 128         return nil
 129 }