X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=E2Manager%2Fhandlers%2Frmrmsghandlers%2Fe2_setup_request_notification_handler.go;h=7420a29197a649cd4e1d4bb343ee2ef9c1b61c04;hb=a07b8597afc9d063a7f37a376a5bcf29ba29b557;hp=405d30d27502e63aaaf850a771db4907f63c11de;hpb=1d12f828b526e4de1d764461f36b8d434277469a;p=ric-plt%2Fe2mgr.git diff --git a/E2Manager/handlers/rmrmsghandlers/e2_setup_request_notification_handler.go b/E2Manager/handlers/rmrmsghandlers/e2_setup_request_notification_handler.go index 405d30d..7420a29 100644 --- a/E2Manager/handlers/rmrmsghandlers/e2_setup_request_notification_handler.go +++ b/E2Manager/handlers/rmrmsghandlers/e2_setup_request_notification_handler.go @@ -22,13 +22,13 @@ package rmrmsghandlers import ( "bytes" "e2mgr/configuration" + "e2mgr/e2managererrors" "e2mgr/logger" "e2mgr/managers" "e2mgr/models" "e2mgr/rmrCgo" "e2mgr/services" "e2mgr/services/rmrsender" - "e2mgr/utils" "encoding/xml" "errors" "fmt" @@ -38,30 +38,48 @@ import ( "strings" ) +var ( + emptyTagsToReplaceToSelfClosingTags = []string{"reject", "ignore", "transport-resource-unavailable", "om-intervention", + "v60s", "v20s", "v10s", "v5s", "v2s", "v1s"} +) + type E2SetupRequestNotificationHandler struct { - logger *logger.Logger - config *configuration.Configuration - e2tInstancesManager managers.IE2TInstancesManager - rmrSender *rmrsender.RmrSender + logger *logger.Logger + config *configuration.Configuration + e2tInstancesManager managers.IE2TInstancesManager + rmrSender *rmrsender.RmrSender rNibDataService services.RNibDataService e2tAssociationManager *managers.E2TAssociationManager } -func NewE2SetupRequestNotificationHandler(logger *logger.Logger, config *configuration.Configuration, e2tInstancesManager managers.IE2TInstancesManager, rmrSender *rmrsender.RmrSender, rNibDataService services.RNibDataService, e2tAssociationManager *managers.E2TAssociationManager) E2SetupRequestNotificationHandler { - return E2SetupRequestNotificationHandler{ - logger: logger, - config: config, - e2tInstancesManager: e2tInstancesManager, - rmrSender: rmrSender, - rNibDataService: rNibDataService, +func NewE2SetupRequestNotificationHandler(logger *logger.Logger, config *configuration.Configuration, e2tInstancesManager managers.IE2TInstancesManager, rmrSender *rmrsender.RmrSender, rNibDataService services.RNibDataService, e2tAssociationManager *managers.E2TAssociationManager) *E2SetupRequestNotificationHandler { + return &E2SetupRequestNotificationHandler{ + logger: logger, + config: config, + e2tInstancesManager: e2tInstancesManager, + rmrSender: rmrSender, + rNibDataService: rNibDataService, e2tAssociationManager: e2tAssociationManager, } } -func (h E2SetupRequestNotificationHandler) Handle(request *models.NotificationRequest){ +func (h *E2SetupRequestNotificationHandler) Handle(request *models.NotificationRequest) { ranName := request.RanName h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - received E2_SETUP_REQUEST. Payload: %x", ranName, request.Payload) + generalConfiguration, err := h.rNibDataService.GetGeneralConfiguration() + + if err != nil { + h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - Failed retrieving e2m general configuration. error: %s", err) + return + } + + if !generalConfiguration.EnableRic { + cause := models.Cause{Misc: &models.CauseMisc{OmIntervention: &struct{}{}}} + h.handleUnsuccessfulResponse(ranName, request, cause) + return + } + setupRequest, e2tIpAddress, err := h.parseSetupRequest(request.Payload) if err != nil { h.logger.Errorf(err.Error()) @@ -79,90 +97,179 @@ func (h E2SetupRequestNotificationHandler) Handle(request *models.NotificationRe } nodebInfo, err := h.rNibDataService.GetNodeb(ranName) - if err != nil{ - if _, ok := err.(*common.ResourceNotFoundError); ok{ - nbIdentity := h.buildNbIdentity(ranName, setupRequest) - nodebInfo, err = h.buildNodebInfo(ranName, e2tIpAddress, setupRequest) - if err != nil{ - h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to build nodebInfo entity. Error: %s", ranName, err) - return - } - err = h.rNibDataService.SaveNodeb(nbIdentity, nodebInfo) - if err != nil{ - h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to save nodebInfo entity. Error: %s", ranName, err) - return - } - } else{ + + if err != nil { + + if _, ok := err.(*common.ResourceNotFoundError); !ok { h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to retrieve nodebInfo entity. Error: %s", ranName, err) return + } - } else { - if nodebInfo.ConnectionStatus == entities.ConnectionStatus_SHUTTING_DOWN { - h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", nodebInfo.RanName, nodebInfo.ConnectionStatus) - h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - Summary: elapsed time for receiving and handling setup request message from E2 terminator: %f ms", utils.ElapsedTime(request.StartTime)) + if nodebInfo, err = h.handleNewRan(ranName, e2tIpAddress, setupRequest); err != nil { return } - nodebInfo.GetGnb().RanFunctions, err = setupRequest.GetExtractRanFunctionsList() - if err != nil{ - h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to update nodebInfo entity. Error: %s", ranName, err) + + } else { + if err = h.handleExistingRan(ranName, nodebInfo, setupRequest); err != nil { return } } - nodebInfo.ConnectionStatus = entities.ConnectionStatus_CONNECTED + err = h.e2tAssociationManager.AssociateRan(e2tIpAddress, nodebInfo) - if err != nil{ + + if err != nil { + h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to associate E2T to nodeB entity. Error: %s", ranName, err) + if _, ok := err.(*e2managererrors.RoutingManagerError); ok { + cause := models.Cause{Transport: &models.CauseTransport{TransportResourceUnavailable: &struct{}{}}} + h.handleUnsuccessfulResponse(nodebInfo.RanName, request, cause) + } return } - ricNearRtId, err := convertTo20BitString(h.config.GlobalRicId.RicNearRtId) - if err != nil{ - h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to convert RicNearRtId value %s to 20 bit string . Error: %s", ranName, h.config.GlobalRicId.RicNearRtId, err) + h.handleSuccessfulResponse(ranName, request, setupRequest) +} + +func (h *E2SetupRequestNotificationHandler) handleNewRan(ranName string, e2tIpAddress string, setupRequest *models.E2SetupRequestMessage) (*entities.NodebInfo, error) { + + nodebInfo, err := h.buildNodebInfo(ranName, e2tIpAddress, setupRequest) + + if err != nil { + h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed to build nodebInfo entity. Error: %s", ranName, err) + return nil, err + } + + nbIdentity := h.buildNbIdentity(ranName, setupRequest) + err = h.rNibDataService.SaveNodeb(nbIdentity, nodebInfo) + + if err != nil { + h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed to save nodebInfo entity. Error: %s", ranName, err) + return nil, err + } + + return nodebInfo, nil +} + +func (h *E2SetupRequestNotificationHandler) setGnbFunctions(nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) error { + ranFunctions := setupRequest.ExtractRanFunctionsList() + + if ranFunctions != nil { + nodebInfo.GetGnb().RanFunctions = ranFunctions + } + + return nil +} + +func (h *E2SetupRequestNotificationHandler) handleExistingRan(ranName string, nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) error { + if nodebInfo.GetConnectionStatus() == entities.ConnectionStatus_SHUTTING_DOWN { + h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", ranName, nodebInfo.ConnectionStatus) + return errors.New("nodeB entity in incorrect state") + } + + err := h.setGnbFunctions(nodebInfo, setupRequest) + return err +} + +func (h *E2SetupRequestNotificationHandler) handleUnsuccessfulResponse(ranName string, req *models.NotificationRequest, cause models.Cause) { + failureResponse := models.NewE2SetupFailureResponseMessage(models.TimeToWaitEnum.V60s, cause) + h.logger.Debugf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", failureResponse) + + responsePayload, err := xml.Marshal(&failureResponse.E2APPDU) + if err != nil { + h.logger.Warnf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload) + } + + responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload) + + h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - payload: %s", responsePayload) + msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_FAILURE, ranName, responsePayload, req.TransactionId, req.GetMsgSrc()) + h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg) + _ = h.rmrSender.WhSend(msg) + +} + +func (h *E2SetupRequestNotificationHandler) handleSuccessfulResponse(ranName string, req *models.NotificationRequest, setupRequest *models.E2SetupRequestMessage) { + + plmnId := buildPlmnId(h.config.GlobalRicId.Mcc, h.config.GlobalRicId.Mnc) + + ricNearRtId, err := convertTo20BitString(h.config.GlobalRicId.RicId) + if err != nil { return } - successResponse := models.NewE2SetupSuccessResponseMessage(h.config.GlobalRicId.PlmnId, ricNearRtId,setupRequest) - h.logger.Debugf("#E2SetupRequestNotificationHandler.Handle - E2_SETUP_RESPONSE has been built successfully %+v", successResponse) + successResponse := models.NewE2SetupSuccessResponseMessage(plmnId, ricNearRtId, setupRequest) + h.logger.Debugf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", successResponse) responsePayload, err := xml.Marshal(&successResponse.E2APPDU) - if err != nil{ - h.logger.Warnf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload) + if err != nil { + h.logger.Warnf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload) } - responsePayload = replaceCriticalityTagsWithSelfClosing(responsePayload) + responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload) + + h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - payload: %s", responsePayload) - msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_RESP, ranName, responsePayload, request.TransactionId) - h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg) + msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_RESP, ranName, responsePayload, req.TransactionId, req.GetMsgSrc()) + h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg) _ = h.rmrSender.Send(msg) } -func replaceCriticalityTagsWithSelfClosing(responsePayload []byte) []byte { - responseString := strings.Replace(string(responsePayload), "", "", -1) - responseString = strings.Replace(responseString, "", "", -1) +func buildPlmnId(mmc string, mnc string) string { + var b strings.Builder + + b.WriteByte(mmc[1]) + b.WriteByte(mmc[0]) + if len(mnc) == 2 { + b.WriteString("F") + } else { + b.WriteByte(mnc[2]) + } + b.WriteByte(mmc[2]) + b.WriteByte(mnc[1]) + b.WriteByte(mnc[0]) + + return b.String() +} + +func replaceEmptyTagsWithSelfClosing(responsePayload []byte) []byte { + + emptyTagVsSelfClosingTagPairs := make([]string, len(emptyTagsToReplaceToSelfClosingTags)*2) + + j := 0 + + for i := 0; i < len(emptyTagsToReplaceToSelfClosingTags); i++ { + emptyTagVsSelfClosingTagPairs[j] = fmt.Sprintf("<%[1]s>", emptyTagsToReplaceToSelfClosingTags[i]) + emptyTagVsSelfClosingTagPairs[j+1] = fmt.Sprintf("<%s/>", emptyTagsToReplaceToSelfClosingTags[i]) + j += 2 + } + responseString := strings.NewReplacer(emptyTagVsSelfClosingTagPairs...).Replace(string(responsePayload)) return []byte(responseString) } -func convertTo20BitString(ricNearRtId string) (string, error){ +func convertTo20BitString(ricNearRtId string) (string, error) { r, err := strconv.ParseUint(ricNearRtId, 16, 32) - if err != nil{ + if err != nil { return "", err } return fmt.Sprintf("%020b", r)[:20], nil } -func (h E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte)(*models.E2SetupRequestMessage, string, error){ +func (h *E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte) (*models.E2SetupRequestMessage, string, error) { pipInd := bytes.IndexByte(payload, '|') if pipInd < 0 { - return nil, "", errors.New( "#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request failed extract Payload: no | separator found") + return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request failed extract Payload: no | separator found") } e2tIpAddress := string(payload[:pipInd]) if len(e2tIpAddress) == 0 { return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Empty E2T Address received") } + + h.logger.Infof("#E2SetupRequestNotificationHandler.parseSetupRequest - payload: %s", payload[pipInd+1:]) + setupRequest := &models.E2SetupRequestMessage{} - err := xml.Unmarshal(payload[pipInd + 1:], &setupRequest.E2APPDU) + err := xml.Unmarshal(normalizeXml(payload[pipInd+1:]), &setupRequest.E2APPDU) if err != nil { return nil, "", errors.New(fmt.Sprintf("#E2SetupRequestNotificationHandler.parseSetupRequest - Error unmarshalling E2 Setup Request payload: %x", payload)) } @@ -170,29 +277,38 @@ func (h E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte)(*mo return setupRequest, e2tIpAddress, nil } -func (h E2SetupRequestNotificationHandler) buildNodebInfo(ranName string, e2tAddress string, request *models.E2SetupRequestMessage) (*entities.NodebInfo, error){ +func normalizeXml(payload []byte) []byte { + xmlStr := string(payload) + normalized := strings.NewReplacer("<", "<", ">", ">").Replace(xmlStr) + return []byte(normalized) +} + +func (h E2SetupRequestNotificationHandler) buildNodebInfo(ranName string, e2tAddress string, request *models.E2SetupRequestMessage) (*entities.NodebInfo, error) { + var err error nodebInfo := &entities.NodebInfo{ AssociatedE2TInstanceAddress: e2tAddress, - ConnectionStatus: entities.ConnectionStatus_CONNECTED, - RanName: ranName, - NodeType: entities.Node_GNB, - Configuration: &entities.NodebInfo_Gnb{Gnb: &entities.Gnb{}}, - GlobalNbId: &entities.GlobalNbId{ - PlmnId: request.GetPlmnId(), - NbId: request.GetNbId(), - }, - } - nodebInfo.GetGnb().RanFunctions, err = request.GetExtractRanFunctionsList() + ConnectionStatus: entities.ConnectionStatus_CONNECTED, + RanName: ranName, + NodeType: entities.Node_GNB, + Configuration: &entities.NodebInfo_Gnb{Gnb: &entities.Gnb{}}, + GlobalNbId: h.buildGlobalNbId(request), + } + + err = h.setGnbFunctions(nodebInfo, request) return nodebInfo, err } -func (h E2SetupRequestNotificationHandler) buildNbIdentity(ranName string, setupRequest *models.E2SetupRequestMessage)*entities.NbIdentity{ +func (h E2SetupRequestNotificationHandler) buildGlobalNbId(setupRequest *models.E2SetupRequestMessage) *entities.GlobalNbId { + return &entities.GlobalNbId{ + PlmnId: setupRequest.GetPlmnId(), + NbId: setupRequest.GetNbId(), + } +} + +func (h E2SetupRequestNotificationHandler) buildNbIdentity(ranName string, setupRequest *models.E2SetupRequestMessage) *entities.NbIdentity { return &entities.NbIdentity{ - InventoryName:ranName, - GlobalNbId: &entities.GlobalNbId{ - PlmnId: setupRequest.GetPlmnId(), - NbId: setupRequest.GetNbId(), - }, + InventoryName: ranName, + GlobalNbId: h.buildGlobalNbId(setupRequest), } -} \ No newline at end of file +}