"e2mgr/rmrCgo"
"e2mgr/services"
"e2mgr/services/rmrsender"
- "e2mgr/utils"
"encoding/xml"
"errors"
"fmt"
"strings"
)
+var (
+ emptyTagsToReplaceToSelfClosingTags = []string{"reject", "ignore", "transport-resource-unavailable", "om-intervention", "request-id-unknown",
+ "v60s", "v20s", "v10s", "v5s", "v2s", "v1s"}
+ gnbTypesMap = map[string]entities.GnbType{
+ "gnb": entities.GnbType_GNB,
+ "en_gnb": entities.GnbType_EN_GNB,
+ }
+ enbTypesMap = map[string]entities.EnbType{
+ "enB_macro": entities.EnbType_MACRO_ENB,
+ "enB_home": entities.EnbType_HOME_ENB,
+ "enB_shortmacro": entities.EnbType_SHORT_MACRO_ENB,
+ "enB_longmacro": entities.EnbType_LONG_MACRO_ENB,
+ "ng_enB_macro": entities.EnbType_MACRO_NG_ENB,
+ "ng_enB_shortmacro": entities.EnbType_SHORT_MACRO_NG_ENB,
+ "ng_enB_longmacro": entities.EnbType_LONG_MACRO_NG_ENB,
+ }
+)
+
type E2SetupRequestNotificationHandler struct {
- logger *logger.Logger
- config *configuration.Configuration
- e2tInstancesManager managers.IE2TInstancesManager
- rmrSender *rmrsender.RmrSender
- rNibDataService services.RNibDataService
- e2tAssociationManager *managers.E2TAssociationManager
+ logger *logger.Logger
+ config *configuration.Configuration
+ e2tInstancesManager managers.IE2TInstancesManager
+ rmrSender *rmrsender.RmrSender
+ rNibDataService services.RNibDataService
+ e2tAssociationManager *managers.E2TAssociationManager
+ ranConnectStatusChangeManager managers.IRanConnectStatusChangeManager
+ ranListManager managers.RanListManager
}
-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 NewE2SetupRequestNotificationHandler(logger *logger.Logger, config *configuration.Configuration, e2tInstancesManager managers.IE2TInstancesManager, rmrSender *rmrsender.RmrSender, rNibDataService services.RNibDataService, e2tAssociationManager *managers.E2TAssociationManager, ranConnectStatusChangeManager managers.IRanConnectStatusChangeManager, ranListManager managers.RanListManager) *E2SetupRequestNotificationHandler {
+ return &E2SetupRequestNotificationHandler{
+ logger: logger,
+ config: config,
+ e2tInstancesManager: e2tInstancesManager,
+ rmrSender: rmrSender,
+ rNibDataService: rNibDataService,
+ e2tAssociationManager: e2tAssociationManager,
+ ranConnectStatusChangeManager: ranConnectStatusChangeManager,
+ ranListManager: ranListManager,
}
}
-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 - quitting e2 setup flow. error: %s", err)
+ return
+ }
+
+ h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - got general configuration from rnib - enableRic: %t", generalConfiguration.EnableRic)
+
+ 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())
}
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{
+
+ var functionsModified bool
+
+ 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 {
+ if _, ok := err.(*e2managererrors.UnknownSetupRequestRanNameError); ok {
+ cause := models.Cause{RicRequest: &models.CauseRic{RequestIdUnknown: &struct{}{}}}
+ h.handleUnsuccessfulResponse(ranName, request, cause)
+ }
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 {
+
+ functionsModified, err = h.handleExistingRan(ranName, nodebInfo, setupRequest)
+
+ if err != nil {
return
}
}
- err = h.e2tAssociationManager.AssociateRan(e2tIpAddress, nodebInfo)
- if err != nil{
+
+ ranStatusChangePublished, err := h.e2tAssociationManager.AssociateRan(e2tIpAddress, nodebInfo)
+
+ 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{
- h.handleUnsuccessfulResponse(nodebInfo, request)
+ if _, ok := err.(*e2managererrors.RoutingManagerError); ok {
+
+ if err = h.handleUpdateAndPublishNodebInfo(functionsModified, ranStatusChangePublished, nodebInfo); err != nil {
+ return
+ }
+
+ cause := models.Cause{Transport: &models.CauseTransport{TransportResourceUnavailable: &struct{}{}}}
+ h.handleUnsuccessfulResponse(nodebInfo.RanName, request, cause)
}
return
}
+
+ if err = h.handleUpdateAndPublishNodebInfo(functionsModified, ranStatusChangePublished, nodebInfo); err != nil {
+ return
+ }
+
h.handleSuccessfulResponse(ranName, request, setupRequest)
}
-func (h E2SetupRequestNotificationHandler) handleUnsuccessfulResponse(nodebInfo *entities.NodebInfo, req *models.NotificationRequest){
- failureResponse := models.NewE2SetupFailureResponseMessage(models.TimeToWaitEnum.V60s)
+func (h *E2SetupRequestNotificationHandler) handleUpdateAndPublishNodebInfo(functionsModified bool, ranStatusChangePublished bool, nodebInfo *entities.NodebInfo) error {
+
+ if ranStatusChangePublished || !functionsModified {
+ return nil
+ }
+
+ err := h.rNibDataService.UpdateNodebInfoAndPublish(nodebInfo)
+
+ if err != nil {
+ h.logger.Errorf("#E2SetupRequestNotificationHandler.handleUpdateAndPublishNodebInfo - RAN name: %s - Failed at UpdateNodebInfoAndPublish. error: %s", nodebInfo.RanName, err)
+ return err
+ }
+
+ h.logger.Infof("#E2SetupRequestNotificationHandler.handleUpdateAndPublishNodebInfo - RAN name: %s - Successfully executed UpdateNodebInfoAndPublish", nodebInfo.RanName)
+ return nil
+
+}
+
+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 building nodebInfo. Error: %s", ranName, err)
+ return nil, err
+ }
+
+ err = h.rNibDataService.SaveNodeb(nodebInfo)
+ if err != nil {
+ h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed saving nodebInfo. Error: %s", ranName, err)
+ return nil, err
+ }
+
+ nbIdentity := h.buildNbIdentity(ranName, setupRequest)
+
+ err = h.ranListManager.AddNbIdentity(nodebInfo.GetNodeType(), nbIdentity)
+
+ if err != nil {
+ return nil, err
+ }
+
+ return nodebInfo, nil
+}
+
+func (h *E2SetupRequestNotificationHandler) handleExistingRan(ranName string, nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) (bool, 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 false, errors.New("nodeB entity in incorrect state")
+ }
+
+ nodebInfo.SetupFromNetwork = true
+
+ if nodebInfo.NodeType == entities.Node_ENB {
+ return false, nil
+ }
+
+ setupMessageRanFuncs := setupRequest.ExtractRanFunctionsList()
+
+ if setupMessageRanFuncs == nil || (len(setupMessageRanFuncs) == 0 && len(nodebInfo.GetGnb().RanFunctions) == 0) {
+ return false, nil
+ }
+
+ nodebInfo.GetGnb().RanFunctions = setupMessageRanFuncs
+ return true, nil
+}
+
+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", nodebInfo.RanName, responsePayload)
+ if err != nil {
+ h.logger.Warnf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload)
}
responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload)
- msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_FAILURE, nodebInfo.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", nodebInfo.RanName, msg)
+ 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){
+func (h *E2SetupRequestNotificationHandler) handleSuccessfulResponse(ranName string, req *models.NotificationRequest, setupRequest *models.E2SetupRequestMessage) {
- ricNearRtId, err := convertTo20BitString(h.config.GlobalRicId.RicNearRtId)
- if err != nil{
- h.logger.Errorf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - failed to convert RicNearRtId value %s to 20 bit string . Error: %s", ranName, h.config.GlobalRicId.RicNearRtId, err)
+ 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)
+ 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{
+ if err != nil {
h.logger.Warnf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload)
}
responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload)
+ h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - payload: %s", responsePayload)
+
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 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 {
- responseString := strings.NewReplacer(
- "<reject></reject>", "<reject/>",
- "<ignore></ignore>", "<ignore/>",
- "<transport-resource-unavailable></transport-resource-unavailable>", "<transport-resource-unavailable/>",
- "<v60s></v60s>", "<v60s/>",
- "<v20s></v20s>", "<v20s/>",
- "<v10s></v10s>", "<v10s/>",
- "<v5s></v5s>", "<v5s/>",
- "<v2s></v2s>", "<v2s/>",
- "<v1s></v1s>", "<v1s/>",
- ).Replace(string(responsePayload))
+
+ emptyTagVsSelfClosingTagPairs := make([]string, len(emptyTagsToReplaceToSelfClosingTags)*2)
+
+ j := 0
+
+ for i := 0; i < len(emptyTagsToReplaceToSelfClosingTags); i++ {
+ emptyTagVsSelfClosingTagPairs[j] = fmt.Sprintf("<%[1]s></%[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))
}
return setupRequest, e2tIpAddress, nil
}
-func (h E2SetupRequestNotificationHandler) buildNodebInfo(ranName string, e2tAddress string, request *models.E2SetupRequestMessage) (*entities.NodebInfo, error){
- var err 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) {
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(),
- },
+ RanName: ranName,
+ GlobalNbId: h.buildGlobalNbId(request),
+ SetupFromNetwork: true,
+ }
+ err := h.setNodeTypeAndConfiguration(nodebInfo)
+ if err != nil {
+ return nil, err
}
- nodebInfo.GetGnb().RanFunctions, err = request.GetExtractRanFunctionsList()
- return nodebInfo, err
+
+ if nodebInfo.NodeType == entities.Node_ENB {
+ return nodebInfo, nil
+ }
+
+ ranFuncs := request.ExtractRanFunctionsList()
+
+ if ranFuncs != nil {
+ nodebInfo.GetGnb().RanFunctions = ranFuncs
+ }
+
+ return nodebInfo, nil
}
-func (h E2SetupRequestNotificationHandler) buildNbIdentity(ranName string, setupRequest *models.E2SetupRequestMessage)*entities.NbIdentity{
+func (h *E2SetupRequestNotificationHandler) setNodeTypeAndConfiguration(nodebInfo *entities.NodebInfo) error {
+ for k, v := range gnbTypesMap {
+ if strings.HasPrefix(nodebInfo.RanName, k) {
+ nodebInfo.NodeType = entities.Node_GNB
+ nodebInfo.Configuration = &entities.NodebInfo_Gnb{Gnb: &entities.Gnb{GnbType: v}}
+ return nil
+ }
+ }
+ for k, v := range enbTypesMap {
+ if strings.HasPrefix(nodebInfo.RanName, k) {
+ nodebInfo.NodeType = entities.Node_ENB
+ nodebInfo.Configuration = &entities.NodebInfo_Enb{Enb: &entities.Enb{EnbType: v}}
+ return nil
+ }
+ }
+
+ return e2managererrors.NewUnknownSetupRequestRanNameError(nodebInfo.RanName)
+}
+
+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
+}
Code Review / ric-plt / e2mgr.git / blobdiff