E2Manager/handlers/rmrmsghandlers/e2_reset_request_handler.go

   1 //\r
   2 // Copyright (c) 2023 Samsung Electronics Co., Ltd. All Rights Reserved.\r
   3 //\r
   4 // Licensed under the Apache License, Version 2.0 (the "License");\r
   5 // you may not use this file except in compliance with the License.\r
   6 // You may obtain a copy of the License at\r
   7 //\r
   8 //      http://www.apache.org/licenses/LICENSE-2.0\r
   9 //\r
  10 // Unless required by applicable law or agreed to in writing, software\r
  11 // distributed under the License is distributed on an "AS IS" BASIS,\r
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13 // See the License for the specific language governing permissions and\r
  14 // limitations under the License.\r
  15 \r
  16 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)\r
  17 //  platform project (RICP).\r
  18 \r
  19 package rmrmsghandlers\r
  20 \r
  21 import (\r
  22         "e2mgr/configuration"\r
  23         "e2mgr/logger"\r
  24         "e2mgr/models"\r
  25         "e2mgr/rmrCgo"\r
  26         "e2mgr/services"\r
  27         "e2mgr/services/rmrsender"\r
  28         "e2mgr/utils"\r
  29         "encoding/xml"\r
  30         "time"\r
  31 \r
  32         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"\r
  33 )\r
  34 \r
  35 const E2ResetRequestLogInfoElapsedTime = "#E2ResetRequestNotificationHandler.Handle - Summary: elapsed time for receiving and handling reset request message from E2 terminator: %f ms"\r
  36 \r
  37 var (\r
  38         resetRequestEmptyTagsToReplaceToSelfClosingTags = []string{"reject", "ignore", "protocolIEs", "procedureCode", "ResetResponse", "ResetResponseIEs", "id", "criticality", "TransactionID"}\r
  39 )\r
  40 \r
  41 type E2ResetRequestNotificationHandler struct {\r
  42         logger          *logger.Logger\r
  43         rnibDataService services.RNibDataService\r
  44         config          *configuration.Configuration\r
  45         rmrSender       *rmrsender.RmrSender\r
  46 }\r
  47 \r
  48 func NewE2ResetRequestNotificationHandler(logger *logger.Logger, rnibDataService services.RNibDataService, config *configuration.Configuration, rmrSender *rmrsender.RmrSender) *E2ResetRequestNotificationHandler {\r
  49         return &E2ResetRequestNotificationHandler{\r
  50                 logger:          logger,\r
  51                 rnibDataService: rnibDataService,\r
  52                 config:          config,\r
  53                 rmrSender:       rmrSender,\r
  54         }\r
  55 }\r
  56 \r
  57 func (e *E2ResetRequestNotificationHandler) Handle(request *models.NotificationRequest) {\r
  58 \r
  59         e.logger.Infof("#E2ResetRequestNotificationHandler.Handle - RAN name: %s - received E2_Reset. Payload: %x", request.RanName, request.Payload)\r
  60 \r
  61         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - RIC_E2_Node_Reset parsed successfully ")\r
  62 \r
  63         nodebInfo, err := e.getNodebInfo(request.RanName)\r
  64         if err != nil {\r
  65                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - failed to retrieve nodeB entity. RanName: %s. Error: %s", request.RanName, err.Error())\r
  66                 e.logger.Infof(E2ResetRequestLogInfoElapsedTime, utils.ElapsedTime(request.StartTime))\r
  67                 return\r
  68         }\r
  69 \r
  70         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - nodeB entity retrieved. RanName %s, ConnectionStatus %s", nodebInfo.RanName, nodebInfo.ConnectionStatus)\r
  71 \r
  72         nodebInfo.ConnectionStatus = entities.ConnectionStatus_UNDER_RESET\r
  73 \r
  74         err = e.rnibDataService.UpdateNodebInfoAndPublish(nodebInfo)\r
  75 \r
  76         if err != nil {\r
  77                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - failed to update connection status of nodeB entity. RanName: %s. Error: %s", request.RanName, err.Error())\r
  78         }\r
  79 \r
  80         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - nodeB entity under reset state. RanName %s, ConnectionStatus %s", nodebInfo.RanName, nodebInfo.ConnectionStatus)\r
  81 \r
  82         e.logger.Infof(E2ResetRequestLogInfoElapsedTime, utils.ElapsedTime(request.StartTime))\r
  83 \r
  84         e.waitfortimertimeout(request)\r
  85 \r
  86         ranName := request.RanName\r
  87         resetRequest, err := e.parseE2ResetMessage(request.Payload)\r
  88         if err != nil {\r
  89                 e.logger.Errorf(err.Error())\r
  90                 return\r
  91         }\r
  92         e.logger.Infof("#E2ResetRequestNotificationHandler.Handle - RIC_RESET_REQUEST has been parsed successfully %+v", resetRequest)\r
  93         e.handleSuccessfulResponse(ranName, request, resetRequest)\r
  94 \r
  95         nodebInfo.ConnectionStatus = entities.ConnectionStatus_CONNECTED\r
  96 \r
  97         err = e.rnibDataService.UpdateNodebInfoAndPublish(nodebInfo)\r
  98 \r
  99         if err != nil {\r
 100                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - failed to update connection status of nodeB entity. RanName: %s. Error: %s", request.RanName, err.Error())\r
 101         }\r
 102 \r
 103         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - nodeB entity connected state. RanName %s, ConnectionStatus %s", nodebInfo.RanName, nodebInfo.ConnectionStatus)\r
 104 \r
 105 }\r
 106 \r
 107 func (e *E2ResetRequestNotificationHandler) getNodebInfo(ranName string) (*entities.NodebInfo, error) {\r
 108 \r
 109         nodebInfo, err := e.rnibDataService.GetNodeb(ranName)\r
 110         if err != nil {\r
 111                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - failed to retrieve nodeB entity. RanName: %s. Error: %s", ranName, err.Error())\r
 112                 return nil, err\r
 113         }\r
 114         return nodebInfo, err\r
 115 }\r
 116 \r
 117 func (e *E2ResetRequestNotificationHandler) waitfortimertimeout(request *models.NotificationRequest) {\r
 118         timeout := e.config.E2ResetTimeOutSec\r
 119         for {\r
 120                 timeElapsed := utils.ElapsedTime(request.StartTime)\r
 121                 e.logger.Infof(E2ResetRequestLogInfoElapsedTime, utils.ElapsedTime(request.StartTime))\r
 122                 if int(timeElapsed) > timeout {\r
 123                         break\r
 124                 }\r
 125                 time.Sleep(time.Duration(timeout/100) * time.Millisecond)\r
 126         }\r
 127 }\r
 128 \r
 129 func (e *E2ResetRequestNotificationHandler) parseE2ResetMessage(payload []byte) (*models.E2ResetRequestMessage, error) {\r
 130         e2resetMessage := models.E2ResetRequestMessage{}\r
 131         err := xml.Unmarshal(utils.NormalizeXml(payload), &(e2resetMessage.E2APPDU))\r
 132 \r
 133         if err != nil {\r
 134                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - error in parsing request message: %+v", err)\r
 135                 return nil, err\r
 136         }\r
 137         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - Unmarshalling is successful %v", e2resetMessage.E2APPDU.InitiatingMessage.ProcedureCode)\r
 138         return &e2resetMessage, nil\r
 139 }\r
 140 \r
 141 func (h *E2ResetRequestNotificationHandler) handleSuccessfulResponse(ranName string, req *models.NotificationRequest, resetRequest *models.E2ResetRequestMessage) {\r
 142 \r
 143         successResponse := models.NewE2ResetResponseMessage(resetRequest)\r
 144         h.logger.Debugf("#E2ResetRequestNotificationHandler.handleSuccessfulResponse - E2_RESET_RESPONSE has been built successfully %+v", successResponse)\r
 145 \r
 146         responsePayload, err := xml.Marshal(&successResponse.E2ApPdu)\r
 147         if err != nil {\r
 148                 h.logger.Warnf("#E2ResetRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_RESET_RESP. Payload: %s", ranName, responsePayload)\r
 149         }\r
 150 \r
 151         responsePayload = utils.ReplaceEmptyTagsWithSelfClosing(responsePayload, resetRequestEmptyTagsToReplaceToSelfClosingTags)\r
 152 \r
 153         h.logger.Infof("#E2ResetRequestNotificationHandler.handleSuccessfulResponse - payload: %s", responsePayload)\r
 154 \r
 155         msg := models.NewRmrMessage(rmrCgo.RIC_E2_RESET_RESP, ranName, responsePayload, req.TransactionId, req.GetMsgSrc())\r
 156         h.logger.Infof("#E2ResetRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - RIC_E2_RESET_RESP message has been built successfully. Message: %x", ranName, msg)\r
 157         err = h.rmrSender.Send(msg)\r
 158         if err != nil {\r
 159                 h.logger.Errorf("#E2ResetRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error sending e2 success response %+v", ranName, msg)\r
 160         }\r
 161 }\r