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