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