2 // Copyright 2019 AT&T Intellectual Property
3 // Copyright 2019 Nokia
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
9 // http://www.apache.org/licenses/LICENSE-2.0
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.
17 // This source code is part of the near-RT RIC (RAN Intelligent Controller)
18 // platform project (RICP).
20 package rmrmsghandlers
25 "e2mgr/e2managererrors"
31 "e2mgr/services/rmrsender"
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"
42 emptyTagsToReplaceToSelfClosingTags = []string{"reject", "ignore", "transport-resource-unavailable", "om-intervention",
43 "v60s", "v20s", "v10s", "v5s", "v2s", "v1s"}
46 type E2SetupRequestNotificationHandler struct {
48 config *configuration.Configuration
49 e2tInstancesManager managers.IE2TInstancesManager
50 rmrSender *rmrsender.RmrSender
51 rNibDataService services.RNibDataService
52 e2tAssociationManager *managers.E2TAssociationManager
53 ranConnectStatusChangeManager managers.IRanConnectStatusChangeManager
56 func NewE2SetupRequestNotificationHandler(logger *logger.Logger, config *configuration.Configuration, e2tInstancesManager managers.IE2TInstancesManager, rmrSender *rmrsender.RmrSender, rNibDataService services.RNibDataService, e2tAssociationManager *managers.E2TAssociationManager, ranConnectStatusChangeManager managers.IRanConnectStatusChangeManager) *E2SetupRequestNotificationHandler {
57 return &E2SetupRequestNotificationHandler{
60 e2tInstancesManager: e2tInstancesManager,
62 rNibDataService: rNibDataService,
63 e2tAssociationManager: e2tAssociationManager,
64 ranConnectStatusChangeManager: ranConnectStatusChangeManager,
68 func (h *E2SetupRequestNotificationHandler) Handle(request *models.NotificationRequest) {
69 ranName := request.RanName
70 h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - received E2_SETUP_REQUEST. Payload: %x", ranName, request.Payload)
72 generalConfiguration, err := h.rNibDataService.GetGeneralConfiguration()
75 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - Failed retrieving e2m general configuration - quitting e2 setup flow. error: %s", err)
79 if !generalConfiguration.EnableRic {
80 cause := models.Cause{Misc: &models.CauseMisc{OmIntervention: &struct{}{}}}
81 h.handleUnsuccessfulResponse(ranName, request, cause)
85 setupRequest, e2tIpAddress, err := h.parseSetupRequest(request.Payload)
87 h.logger.Errorf(err.Error())
91 h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - E2T Address: %s - handling E2_SETUP_REQUEST", e2tIpAddress)
92 h.logger.Debugf("#E2SetupRequestNotificationHandler.Handle - E2_SETUP_REQUEST has been parsed successfully %+v", setupRequest)
94 _, err = h.e2tInstancesManager.GetE2TInstance(e2tIpAddress)
97 h.logger.Errorf("#E2TermInitNotificationHandler.Handle - Failed retrieving E2TInstance. error: %s", err)
101 nodebInfo, err := h.rNibDataService.GetNodeb(ranName)
105 if _, ok := err.(*common.ResourceNotFoundError); !ok {
106 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to retrieve nodebInfo entity. Error: %s", ranName, err)
111 if nodebInfo, err = h.handleNewRan(ranName, e2tIpAddress, setupRequest); err != nil {
116 if err = h.handleExistingRan(ranName, nodebInfo, setupRequest); err != nil {
121 err = h.e2tAssociationManager.AssociateRan(e2tIpAddress, nodebInfo)
125 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to associate E2T to nodeB entity. Error: %s", ranName, err)
126 if _, ok := err.(*e2managererrors.RoutingManagerError); ok {
127 cause := models.Cause{Transport: &models.CauseTransport{TransportResourceUnavailable: &struct{}{}}}
128 h.handleUnsuccessfulResponse(nodebInfo.RanName, request, cause)
133 h.handleSuccessfulResponse(ranName, request, setupRequest)
136 func (h *E2SetupRequestNotificationHandler) handleNewRan(ranName string, e2tIpAddress string, setupRequest *models.E2SetupRequestMessage) (*entities.NodebInfo, error) {
138 nodebInfo, err := h.buildNodebInfo(ranName, e2tIpAddress, setupRequest)
141 h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed to build nodebInfo entity. Error: %s", ranName, err)
145 nbIdentity := h.buildNbIdentity(ranName, setupRequest)
146 err = h.rNibDataService.SaveNodeb(nbIdentity, nodebInfo)
149 h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed to save nodebInfo entity. Error: %s", ranName, err)
153 err = h.ranConnectStatusChangeManager.ChangeStatus(nodebInfo, entities.ConnectionStatus_CONNECTED)
159 return nodebInfo, nil
162 func (h *E2SetupRequestNotificationHandler) setGnbFunctions(nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) {
163 ranFunctions := setupRequest.ExtractRanFunctionsList()
165 if ranFunctions != nil {
166 nodebInfo.GetGnb().RanFunctions = ranFunctions
170 func (h *E2SetupRequestNotificationHandler) handleExistingRan(ranName string, nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) error {
171 if nodebInfo.GetConnectionStatus() == entities.ConnectionStatus_SHUTTING_DOWN {
172 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", ranName, nodebInfo.ConnectionStatus)
173 return errors.New("nodeB entity in incorrect state")
176 h.setGnbFunctions(nodebInfo, setupRequest)
178 return h.rNibDataService.UpdateNodebInfo(nodebInfo)
181 func (h *E2SetupRequestNotificationHandler) handleUnsuccessfulResponse(ranName string, req *models.NotificationRequest, cause models.Cause) {
182 failureResponse := models.NewE2SetupFailureResponseMessage(models.TimeToWaitEnum.V60s, cause)
183 h.logger.Debugf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", failureResponse)
185 responsePayload, err := xml.Marshal(&failureResponse.E2APPDU)
187 h.logger.Warnf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload)
190 responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload)
192 h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - payload: %s", responsePayload)
193 msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_FAILURE, ranName, responsePayload, req.TransactionId, req.GetMsgSrc())
194 h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg)
195 _ = h.rmrSender.WhSend(msg)
199 func (h *E2SetupRequestNotificationHandler) handleSuccessfulResponse(ranName string, req *models.NotificationRequest, setupRequest *models.E2SetupRequestMessage) {
201 plmnId := buildPlmnId(h.config.GlobalRicId.Mcc, h.config.GlobalRicId.Mnc)
203 ricNearRtId, err := convertTo20BitString(h.config.GlobalRicId.RicId)
207 successResponse := models.NewE2SetupSuccessResponseMessage(plmnId, ricNearRtId, setupRequest)
208 h.logger.Debugf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", successResponse)
210 responsePayload, err := xml.Marshal(&successResponse.E2APPDU)
212 h.logger.Warnf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload)
215 responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload)
217 h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - payload: %s", responsePayload)
219 msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_RESP, ranName, responsePayload, req.TransactionId, req.GetMsgSrc())
220 h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg)
221 _ = h.rmrSender.Send(msg)
224 func buildPlmnId(mmc string, mnc string) string {
225 var b strings.Builder
241 func replaceEmptyTagsWithSelfClosing(responsePayload []byte) []byte {
243 emptyTagVsSelfClosingTagPairs := make([]string, len(emptyTagsToReplaceToSelfClosingTags)*2)
247 for i := 0; i < len(emptyTagsToReplaceToSelfClosingTags); i++ {
248 emptyTagVsSelfClosingTagPairs[j] = fmt.Sprintf("<%[1]s></%[1]s>", emptyTagsToReplaceToSelfClosingTags[i])
249 emptyTagVsSelfClosingTagPairs[j+1] = fmt.Sprintf("<%s/>", emptyTagsToReplaceToSelfClosingTags[i])
252 responseString := strings.NewReplacer(emptyTagVsSelfClosingTagPairs...).Replace(string(responsePayload))
253 return []byte(responseString)
256 func convertTo20BitString(ricNearRtId string) (string, error) {
257 r, err := strconv.ParseUint(ricNearRtId, 16, 32)
261 return fmt.Sprintf("%020b", r)[:20], nil
264 func (h *E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte) (*models.E2SetupRequestMessage, string, error) {
266 pipInd := bytes.IndexByte(payload, '|')
268 return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request failed extract Payload: no | separator found")
271 e2tIpAddress := string(payload[:pipInd])
272 if len(e2tIpAddress) == 0 {
273 return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Empty E2T Address received")
276 h.logger.Infof("#E2SetupRequestNotificationHandler.parseSetupRequest - payload: %s", payload[pipInd+1:])
278 setupRequest := &models.E2SetupRequestMessage{}
279 err := xml.Unmarshal(normalizeXml(payload[pipInd+1:]), &setupRequest.E2APPDU)
281 return nil, "", errors.New(fmt.Sprintf("#E2SetupRequestNotificationHandler.parseSetupRequest - Error unmarshalling E2 Setup Request payload: %x", payload))
284 return setupRequest, e2tIpAddress, nil
287 func normalizeXml(payload []byte) []byte {
288 xmlStr := string(payload)
289 normalized := strings.NewReplacer("<", "<", ">", ">").Replace(xmlStr)
290 return []byte(normalized)
293 func (h *E2SetupRequestNotificationHandler) buildNodebInfo(ranName string, e2tAddress string, request *models.E2SetupRequestMessage) (*entities.NodebInfo, error) {
296 nodebInfo := &entities.NodebInfo{
297 AssociatedE2TInstanceAddress: e2tAddress,
299 NodeType: entities.Node_GNB,
300 Configuration: &entities.NodebInfo_Gnb{Gnb: &entities.Gnb{}},
301 GlobalNbId: h.buildGlobalNbId(request),
304 h.setGnbFunctions(nodebInfo, request)
305 return nodebInfo, err
308 func (h *E2SetupRequestNotificationHandler) buildGlobalNbId(setupRequest *models.E2SetupRequestMessage) *entities.GlobalNbId {
309 return &entities.GlobalNbId{
310 PlmnId: setupRequest.GetPlmnId(),
311 NbId: setupRequest.GetNbId(),
315 func (h *E2SetupRequestNotificationHandler) buildNbIdentity(ranName string, setupRequest *models.E2SetupRequestMessage) *entities.NbIdentity {
316 return &entities.NbIdentity{
317 InventoryName: ranName,
318 GlobalNbId: h.buildGlobalNbId(setupRequest),