E2Manager/handlers/rmrmsghandlers/e2_setup_request_notification_handler.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 package rmrmsghandlers
  21
  22 import (
  23         "bytes"
  24         "e2mgr/configuration"
  25         "e2mgr/logger"
  26         "e2mgr/managers"
  27         "e2mgr/models"
  28         "e2mgr/rmrCgo"
  29         "e2mgr/services"
  30         "e2mgr/services/rmrsender"
  31         "e2mgr/utils"
  32         "encoding/xml"
  33         "errors"
  34         "fmt"
  35         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  36         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  37 )
  38
  39 type E2SetupRequestNotificationHandler struct {
  40         logger                 *logger.Logger
  41         config                 *configuration.Configuration
  42         e2tInstancesManager    managers.IE2TInstancesManager
  43         rmrSender              *rmrsender.RmrSender
  44         rNibDataService       services.RNibDataService
  45         e2tAssociationManager *managers.E2TAssociationManager
  46 }
  47
  48 func NewE2SetupRequestNotificationHandler(logger *logger.Logger, config *configuration.Configuration, e2tInstancesManager managers.IE2TInstancesManager, rmrSender *rmrsender.RmrSender, rNibDataService services.RNibDataService, e2tAssociationManager *managers.E2TAssociationManager) E2SetupRequestNotificationHandler {
  49         return E2SetupRequestNotificationHandler{
  50                 logger:                 logger,
  51                 config:                 config,
  52                 e2tInstancesManager:    e2tInstancesManager,
  53                 rmrSender: rmrSender,
  54                 rNibDataService: rNibDataService,
  55                 e2tAssociationManager: e2tAssociationManager,
  56         }
  57 }
  58
  59 func (h E2SetupRequestNotificationHandler) Handle(request *models.NotificationRequest){
  60         ranName := request.RanName
  61         h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - received E2 Setup Request. Payload: %x", ranName, request.Payload)
  62
  63         setupRequest, e2tIpAddress, err := h.parseSetupRequest(request.Payload)
  64         if err != nil {
  65                 h.logger.Errorf(err.Error())
  66                 return
  67         }
  68
  69         h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - E2T Address: %s - handling E2_SETUP_REQUEST", e2tIpAddress)
  70
  71         _, err = h.e2tInstancesManager.GetE2TInstance(e2tIpAddress)
  72
  73         if err != nil {
  74                 h.logger.Errorf("#E2TermInitNotificationHandler.Handle - Failed retrieving E2TInstance. error: %s", err)
  75                 return
  76         }
  77
  78         nodebInfo, err := h.rNibDataService.GetNodeb(ranName)
  79         if err != nil{
  80                 if _, ok := err.(*common.ResourceNotFoundError); ok{
  81                         nbIdentity := h.buildNbIdentity(ranName, setupRequest)
  82                         nodebInfo, err = h.buildNodebInfo(ranName, e2tIpAddress, setupRequest)
  83                         if err != nil{
  84                                 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to build nodebInfo entity. Error: %s", ranName, err)
  85                                 return
  86                         }
  87                         err = h.rNibDataService.SaveNodeb(nbIdentity, nodebInfo)
  88                         if err != nil{
  89                                 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to save nodebInfo entity. Error: %s", ranName, err)
  90                                 return
  91                         }
  92                 } else{
  93                         h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to retrieve nodebInfo entity. Error: %s", ranName, err)
  94                         return
  95                 }
  96
  97         } else {
  98                 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_SHUTTING_DOWN {
  99                         h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", nodebInfo.RanName, nodebInfo.ConnectionStatus)
 100                         h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - Summary: elapsed time for receiving and handling setup request message from E2 terminator: %f ms", utils.ElapsedTime(request.StartTime))
 101                         return
 102                 }
 103                 nodebInfo.GetGnb().RanFunctions, err = setupRequest.GetExtractRanFunctionsList()
 104                 if err != nil{
 105                         h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to update nodebInfo entity. Error: %s", ranName, err)
 106                         return
 107                 }
 108         }
 109         err = h.e2tAssociationManager.AssociateRan(e2tIpAddress, nodebInfo)
 110         if err != nil{
 111                 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to associate E2T to nodeB entity. Error: %s", ranName, err)
 112                 return
 113         }
 114         successResponse := models.NewE2SetupSuccessResponseMessage()
 115         successResponse.SetPlmnId(h.config.RicId.PlmnId)
 116         successResponse.SetRicId(h.config.RicId.RicNearRtId)
 117         successResponse.SetExtractRanFunctionsIDList(setupRequest)
 118         responsePayload, err := xml.Marshal(successResponse)
 119
 120         if err != nil{
 121                 h.logger.Warnf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - Error marshalling E2 Setup Response. Response: %x", ranName, responsePayload)
 122         }
 123         msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_RESP, ranName, responsePayload, request.TransactionId)
 124         h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - E2 Setup Request has been built. Message: %x", ranName, msg)
 125         err = h.rmrSender.Send(msg)
 126 }
 127
 128 func (h E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte)(*models.E2SetupRequestMessage, string, error){
 129
 130         colonInd := bytes.IndexByte(payload, ':')
 131         if colonInd < 0 {
 132                 return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request, failed extract E2T IP Address: no ':' separator found")
 133         }
 134
 135         e2tIpAddress := string(payload[:colonInd])
 136         if len(e2tIpAddress) == 0 {
 137                 return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Empty E2T Address received")
 138         }
 139
 140         pipInd := bytes.IndexByte(payload, '|')
 141         if pipInd < 0 {
 142                 return nil, "", errors.New( "#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request failed extract Payload: no | separator found")
 143         }
 144
 145         setupRequest := &models.E2SetupRequestMessage{}
 146         err := xml.Unmarshal(payload[pipInd + 1:], &setupRequest)
 147         if err != nil {
 148                 return nil, "", errors.New(fmt.Sprintf("#E2SetupRequestNotificationHandler.parseSetupRequest - Error unmarshalling E2 Setup Request payload: %x", payload))
 149         }
 150
 151         return setupRequest, e2tIpAddress, nil
 152 }
 153
 154 func (h E2SetupRequestNotificationHandler) buildNodebInfo(ranName string, e2tAddress string, request *models.E2SetupRequestMessage) (*entities.NodebInfo, error){
 155         var err error
 156         nodebInfo := &entities.NodebInfo{
 157                 AssociatedE2TInstanceAddress: e2tAddress,
 158                 ConnectionStatus: entities.ConnectionStatus_CONNECTED,
 159                 RanName: ranName,
 160                 NodeType: entities.Node_GNB,
 161                 Configuration: &entities.NodebInfo_Gnb{Gnb: &entities.Gnb{}},
 162         }
 163         nodebInfo.GetGnb().RanFunctions, err = request.GetExtractRanFunctionsList()
 164         return nodebInfo, err
 165 }
 166
 167 func (h E2SetupRequestNotificationHandler) buildNbIdentity(ranName string, setupRequest *models.E2SetupRequestMessage)*entities.NbIdentity{
 168         return &entities.NbIdentity{
 169                 InventoryName:ranName,
 170                 GlobalNbId: &entities.GlobalNbId{
 171                         PlmnId: setupRequest.GetPlmnId(),
 172                         NbId:   setupRequest.GetNbId(),
 173                 },
 174         }
 175 }