E2Manager/managers/ran_setup_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/e2managererrors"
  25         "e2mgr/e2pdus"
  26         "e2mgr/logger"
  27         "e2mgr/models"
  28         "e2mgr/rmrCgo"
  29         "e2mgr/services"
  30         "e2mgr/services/rmrsender"
  31         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  32 )
  33
  34 type RanSetupManager struct {
  35         logger          *logger.Logger
  36         rnibDataService services.RNibDataService
  37         rmrSender       *rmrsender.RmrSender
  38 }
  39
  40 type IRanSetupManager interface {
  41         ExecuteSetup(nodebInfo *entities.NodebInfo, status entities.ConnectionStatus) error
  42 }
  43
  44 func NewRanSetupManager(logger *logger.Logger, rmrSender *rmrsender.RmrSender, rnibDataService services.RNibDataService) *RanSetupManager {
  45         return &RanSetupManager{
  46                 logger:          logger,
  47                 rnibDataService: rnibDataService,
  48                 rmrSender:       rmrSender,
  49         }
  50 }
  51
  52 // Update retries and connection status
  53 func (m *RanSetupManager) updateConnectionStatus(nodebInfo *entities.NodebInfo, status entities.ConnectionStatus) error {
  54         // Update retries and connection status
  55         nodebInfo.ConnectionStatus = status
  56         nodebInfo.ConnectionAttempts++
  57         err := m.rnibDataService.UpdateNodebInfo(nodebInfo)
  58         if err != nil {
  59                 m.logger.Errorf("#RanSetupManager.updateConnectionStatus - Ran name: %s - Failed updating RAN's connection status to %v : %s", nodebInfo.RanName, status, err)
  60         } else {
  61                 m.logger.Infof("#RanSetupManager.updateConnectionStatus - Ran name: %s - Successfully updated rNib. RAN's current connection status: %v, RAN's current connection attempts: %d", nodebInfo.RanName, status, nodebInfo.ConnectionAttempts)
  62         }
  63         return err
  64 }
  65
  66 // Decrement retries and connection status (disconnected)
  67 func (m *RanSetupManager) updateConnectionStatusDisconnected(nodebInfo *entities.NodebInfo) error {
  68         // Update retries and connection status
  69         nodebInfo.ConnectionStatus = entities.ConnectionStatus_DISCONNECTED
  70         nodebInfo.ConnectionAttempts--
  71         err := m.rnibDataService.UpdateNodebInfo(nodebInfo)
  72         if err != nil {
  73                 m.logger.Errorf("#RanSetupManager.updateConnectionStatusDisconnected - Ran name: %s - Failed updating RAN's connection status to DISCONNECTED : %s", nodebInfo.RanName, err)
  74         } else {
  75                 m.logger.Infof("#RanSetupManager.updateConnectionStatusDisconnected - Ran name: %s - Successfully updated rNib. RAN's current connection status: DISCONNECTED, RAN's current connection attempts: %d", nodebInfo.RanName, nodebInfo.ConnectionAttempts)
  76         }
  77         return err
  78 }
  79
  80 func (m *RanSetupManager) prepareSetupRequest(nodebInfo *entities.NodebInfo) (int, *models.E2RequestMessage, error) {
  81         // Build the endc/x2 setup request
  82         switch nodebInfo.E2ApplicationProtocol {
  83         case entities.E2ApplicationProtocol_X2_SETUP_REQUEST:
  84                 rmrMsgType := rmrCgo.RIC_X2_SETUP_REQ
  85                 request := models.NewE2RequestMessage(nodebInfo.RanName /*tid*/, nodebInfo.Ip, uint16(nodebInfo.Port), nodebInfo.RanName, e2pdus.PackedX2setupRequest)
  86                 return rmrMsgType, request, nil
  87         case entities.E2ApplicationProtocol_ENDC_X2_SETUP_REQUEST:
  88                 rmrMsgType := rmrCgo.RIC_ENDC_X2_SETUP_REQ
  89                 request := models.NewE2RequestMessage(nodebInfo.RanName /*tid*/, nodebInfo.Ip, uint16(nodebInfo.Port), nodebInfo.RanName, e2pdus.PackedEndcX2setupRequest)
  90                 return rmrMsgType, request, nil
  91         }
  92
  93         m.logger.Errorf("#RanSetupManager.prepareSetupRequest - Unsupported nodebInfo.E2ApplicationProtocol %d ", nodebInfo.E2ApplicationProtocol)
  94         return 0, nil, e2managererrors.NewInternalError()
  95 }
  96
  97 // ExecuteSetup updates the connection status and number of attempts in the nodebInfo and send an endc/x2 setup request to establish a connection with the RAN
  98 func (m *RanSetupManager) ExecuteSetup(nodebInfo *entities.NodebInfo, status entities.ConnectionStatus) error {
  99
 100         // Update retries and connection status
 101         if err := m.updateConnectionStatus(nodebInfo, status); err != nil {
 102                 return e2managererrors.NewRnibDbError()
 103         }
 104
 105         // Build the endc/x2 setup request
 106         rmrMsgType, request, err := m.prepareSetupRequest(nodebInfo)
 107         if err != nil {
 108                 return err
 109         }
 110
 111         // Send the endc/x2 setup request
 112         var xAction []byte
 113         msg := models.NewRmrMessage(rmrMsgType, nodebInfo.RanName, request.GetMessageAsBytes(m.logger), xAction)
 114
 115         err = m.rmrSender.Send(msg)
 116
 117         if err != nil {
 118                 m.logger.Errorf("#RanSetupManager.ExecuteSetup - failed sending setup request to RMR: %s", err)
 119
 120                 err := m.updateConnectionStatusDisconnected(nodebInfo)
 121
 122                 // Decrement retries and connection status (disconnected)
 123                 if err != nil {
 124                         return e2managererrors.NewRnibDbError()
 125                 }
 126
 127                 return e2managererrors.NewRmrError()
 128         }
 129
 130         return nil
 131 }