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/managers"\r
  25         "e2mgr/models"\r
  26         "e2mgr/rmrCgo"\r
  27         "e2mgr/services"\r
  28         "e2mgr/services/rmrsender"\r
  29         "e2mgr/utils"\r
  30         "encoding/xml"\r
  31         "time"\r
  32 \r
  33         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"\r
  34 )\r
  35 \r
  36 const E2ResetRequestLogInfoElapsedTime = "#E2ResetRequestNotificationHandler.Handle - Summary: elapsed time for receiving and handling reset request message from E2 terminator: %f ms"\r
  37 \r
  38 var (\r
  39         resetRequestEmptyTagsToReplaceToSelfClosingTags = []string{"reject", "ignore", "protocolIEs", "procedureCode", "ResetResponse", "ResetResponseIEs", "id", "criticality", "TransactionID"}\r
  40 )\r
  41 \r
  42 type E2ResetRequestNotificationHandler struct {\r
  43         logger          *logger.Logger\r
  44         rnibDataService services.RNibDataService\r
  45         config          *configuration.Configuration\r
  46         rmrSender       *rmrsender.RmrSender\r
  47         ranResetManager *managers.RanResetManager\r
  48 }\r
  49 \r
  50 func NewE2ResetRequestNotificationHandler(logger *logger.Logger, rnibDataService services.RNibDataService, config *configuration.Configuration, rmrSender *rmrsender.RmrSender, ranResetManager *managers.RanResetManager) *E2ResetRequestNotificationHandler {\r
  51         return &E2ResetRequestNotificationHandler{\r
  52                 logger:          logger,\r
  53                 rnibDataService: rnibDataService,\r
  54                 config:          config,\r
  55                 rmrSender:       rmrSender,\r
  56                 ranResetManager: ranResetManager,\r
  57         }\r
  58 }\r
  59 \r
  60 func (e *E2ResetRequestNotificationHandler) Handle(request *models.NotificationRequest) {\r
  61 \r
  62         e.logger.Infof("#E2ResetRequestNotificationHandler.Handle - RAN name: %s - received E2_Reset. Payload: %x", request.RanName, request.Payload)\r
  63 \r
  64         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - RIC_E2_Node_Reset parsed successfully ")\r
  65 \r
  66         nodebInfo, err := e.getNodebInfo(request.RanName)\r
  67         if err != nil {\r
  68                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - failed to retrieve nodeB entity. RanName: %s. Error: %s", request.RanName, err.Error())\r
  69                 e.logger.Infof(E2ResetRequestLogInfoElapsedTime, utils.ElapsedTime(request.StartTime))\r
  70                 return\r
  71         }\r
  72 \r
  73         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - nodeB entity retrieved. RanName %s, ConnectionStatus %s", nodebInfo.RanName, nodebInfo.ConnectionStatus)\r
  74 \r
  75         nodebInfo.ConnectionStatus = entities.ConnectionStatus_UNDER_RESET\r
  76 \r
  77         ranName := request.RanName\r
  78         isResetDone, err := e.ranResetManager.ResetRan(ranName)\r
  79         if err != nil {\r
  80                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - failed to update and notify connection status of nodeB entity. RanName: %s. Error: %s", request.RanName, err.Error())\r
  81         } else {\r
  82                 if isResetDone {\r
  83                         nodebInfoupdated, err1 := e.getNodebInfo(request.RanName)\r
  84                         if err1 != nil {\r
  85                                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - failed to get updated nodeB entity. RanName: %s. Error: %s", request.RanName, err1.Error())\r
  86                         }\r
  87                         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - Reset Done Successfully ran: %s , Connection status updated : %s", ranName, nodebInfoupdated.ConnectionStatus)\r
  88                 } else {\r
  89                         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - Reset Failed")\r
  90                 }\r
  91         }\r
  92 \r
  93         if err != nil {\r
  94                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - failed to update connection status of nodeB entity. RanName: %s. Error: %s", request.RanName, err.Error())\r
  95         }\r
  96 \r
  97         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - nodeB entity under reset state. RanName %s, ConnectionStatus %s", nodebInfo.RanName, nodebInfo.ConnectionStatus)\r
  98 \r
  99         e.logger.Infof(E2ResetRequestLogInfoElapsedTime, utils.ElapsedTime(request.StartTime))\r
 100 \r
 101         e.waitfortimertimeout(request)\r
 102 \r
 103         resetRequest, err := e.parseE2ResetMessage(request.Payload)\r
 104         if err != nil {\r
 105                 e.logger.Errorf(err.Error())\r
 106                 return\r
 107         }\r
 108         e.logger.Infof("#E2ResetRequestNotificationHandler.Handle - RIC_RESET_REQUEST has been parsed successfully %+v", resetRequest)\r
 109         e.handleSuccessfulResponse(ranName, request, resetRequest)\r
 110 \r
 111         nodebInfo.ConnectionStatus = entities.ConnectionStatus_CONNECTED\r
 112 \r
 113         err = e.rnibDataService.UpdateNodebInfoAndPublish(nodebInfo)\r
 114 \r
 115         if err != nil {\r
 116                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - failed to update connection status of nodeB entity. RanName: %s. Error: %s", request.RanName, err.Error())\r
 117         }\r
 118 \r
 119         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - nodeB entity connected state. RanName %s, ConnectionStatus %s", nodebInfo.RanName, nodebInfo.ConnectionStatus)\r
 120 \r
 121 }\r
 122 \r
 123 func (e *E2ResetRequestNotificationHandler) getNodebInfo(ranName string) (*entities.NodebInfo, error) {\r
 124 \r
 125         nodebInfo, err := e.rnibDataService.GetNodeb(ranName)\r
 126         if err != nil {\r
 127                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - failed to retrieve nodeB entity. RanName: %s. Error: %s", ranName, err.Error())\r
 128                 return nil, err\r
 129         }\r
 130         return nodebInfo, err\r
 131 }\r
 132 \r
 133 func (e *E2ResetRequestNotificationHandler) waitfortimertimeout(request *models.NotificationRequest) {\r
 134         timeout := e.config.E2ResetTimeOutSec\r
 135         for {\r
 136                 timeElapsed := utils.ElapsedTime(request.StartTime)\r
 137                 e.logger.Infof(E2ResetRequestLogInfoElapsedTime, utils.ElapsedTime(request.StartTime))\r
 138                 if int(timeElapsed) > timeout {\r
 139                         break\r
 140                 }\r
 141                 time.Sleep(time.Duration(timeout/100) * time.Millisecond)\r
 142         }\r
 143 }\r
 144 \r
 145 func (e *E2ResetRequestNotificationHandler) parseE2ResetMessage(payload []byte) (*models.E2ResetRequestMessage, error) {\r
 146         e2resetMessage := models.E2ResetRequestMessage{}\r
 147         err := xml.Unmarshal(utils.NormalizeXml(payload), &(e2resetMessage.E2APPDU))\r
 148 \r
 149         if err != nil {\r
 150                 e.logger.Errorf("#E2ResetRequestNotificationHandler.Handle - error in parsing request message: %+v", err)\r
 151                 return nil, err\r
 152         }\r
 153         e.logger.Debugf("#E2ResetRequestNotificationHandler.Handle - Unmarshalling is successful %v", e2resetMessage.E2APPDU.InitiatingMessage.ProcedureCode)\r
 154         return &e2resetMessage, nil\r
 155 }\r
 156 \r
 157 func (h *E2ResetRequestNotificationHandler) handleSuccessfulResponse(ranName string, req *models.NotificationRequest, resetRequest *models.E2ResetRequestMessage) {\r
 158 \r
 159         successResponse := models.NewE2ResetResponseMessage(resetRequest)\r
 160         h.logger.Debugf("#E2ResetRequestNotificationHandler.handleSuccessfulResponse - E2_RESET_RESPONSE has been built successfully %+v", successResponse)\r
 161 \r
 162         responsePayload, err := xml.Marshal(&successResponse.E2ApPdu)\r
 163         if err != nil {\r
 164                 h.logger.Warnf("#E2ResetRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_RESET_RESP. Payload: %s", ranName, responsePayload)\r
 165         }\r
 166 \r
 167         responsePayload = utils.ReplaceEmptyTagsWithSelfClosing(responsePayload, resetRequestEmptyTagsToReplaceToSelfClosingTags)\r
 168 \r
 169         h.logger.Infof("#E2ResetRequestNotificationHandler.handleSuccessfulResponse - payload: %s", responsePayload)\r
 170 \r
 171         msg := models.NewRmrMessage(rmrCgo.RIC_E2_RESET_RESP, ranName, responsePayload, req.TransactionId, req.GetMsgSrc())\r
 172         h.logger.Infof("#E2ResetRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - RIC_E2_RESET_RESP message has been built successfully. Message: %x", ranName, msg)\r
 173         err = h.rmrSender.Send(msg)\r
 174         if err != nil {\r
 175                 h.logger.Errorf("#E2ResetRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error sending e2 success response %+v", ranName, msg)\r
 176         }\r
 177 }\r