2 // Copyright 2019 AT&T Intellectual Property
3 // Copyright 2019 Nokia
4 // Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.
5 // Copyright 2023 Capgemini
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 // This source code is part of the near-RT RIC (RAN Intelligent Controller)
20 // platform project (RICP).
22 package rmrmsghandlers
27 "e2mgr/e2managererrors"
33 "e2mgr/services/rmrsender"
42 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
43 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
46 const cleanUpDurationNanoSec uint64 = 10000000000 // cleanUpDuration = 10sec (value in nanoSecond=10000000000)
49 emptyTagsToReplaceToSelfClosingTags = []string{"reject", "ignore", "transport-resource-unavailable", "om-intervention", "request-id-unknown",
50 "unspecified", "message-not-compatible-with-receiver-state", "control-processing-overload",
51 "v60s", "v20s", "v10s", "v5s", "v2s", "v1s", "ng", "xn", "e1", "f1", "w1", "s1", "x2", "success", "failure"}
52 gnbTypesMap = map[string]entities.GnbType{
53 "gnb": entities.GnbType_GNB,
54 "en_gnb": entities.GnbType_EN_GNB,
56 enbTypesMap = map[string]entities.EnbType{
57 "enB_macro": entities.EnbType_MACRO_ENB,
58 "enB_home": entities.EnbType_HOME_ENB,
59 "enB_shortmacro": entities.EnbType_SHORT_MACRO_ENB,
60 "enB_longmacro": entities.EnbType_LONG_MACRO_ENB,
61 "ng_enB_macro": entities.EnbType_MACRO_NG_ENB,
62 "ng_enB_shortmacro": entities.EnbType_SHORT_MACRO_NG_ENB,
63 "ng_enB_longmacro": entities.EnbType_LONG_MACRO_NG_ENB,
67 type E2SetupRequestNotificationHandler struct {
69 config *configuration.Configuration
70 e2tInstancesManager managers.IE2TInstancesManager
71 rmrSender *rmrsender.RmrSender
72 rNibDataService services.RNibDataService
73 e2tAssociationManager *managers.E2TAssociationManager
74 ranConnectStatusChangeManager managers.IRanConnectStatusChangeManager
75 ranListManager managers.RanListManager
78 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 {
79 return &E2SetupRequestNotificationHandler{
82 e2tInstancesManager: e2tInstancesManager,
84 rNibDataService: rNibDataService,
85 e2tAssociationManager: e2tAssociationManager,
86 ranConnectStatusChangeManager: ranConnectStatusChangeManager,
87 ranListManager: ranListManager,
91 func (h *E2SetupRequestNotificationHandler) Handle(request *models.NotificationRequest) {
92 ranName := request.RanName
93 models.UpdateProcedureType(ranName, models.E2SetupProcedureNotInitiated)
94 h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - received E2_SETUP_REQUEST. Payload: %x", ranName, request.Payload)
96 generalConfiguration, err := h.rNibDataService.GetGeneralConfiguration()
99 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - Failed retrieving e2m general configuration - quitting e2 setup flow. error: %s", err)
103 setupRequest, e2tIpAddress, err := h.parseSetupRequest(request.Payload)
105 h.logger.Errorf(err.Error())
109 h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - E2T Address: %s - handling E2_SETUP_REQUEST", e2tIpAddress)
110 h.logger.Debugf("#E2SetupRequestNotificationHandler.Handle - E2_SETUP_REQUEST has been parsed successfully %+v", setupRequest)
112 h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - got general configuration from rnib - enableRic: %t", generalConfiguration.EnableRic)
114 if !generalConfiguration.EnableRic {
115 cause := models.Cause{Misc: &models.CauseMisc{OmIntervention: &struct{}{}}}
116 h.handleUnsuccessfulResponse(ranName, request, cause, setupRequest)
117 models.UpdateProcedureType(ranName, models.E2SetupProcedureFailure)
121 _, err = h.e2tInstancesManager.GetE2TInstance(e2tIpAddress)
124 h.logger.Errorf("#E2TermInitNotificationHandler.Handle - Failed retrieving E2TInstance. error: %s", err)
128 nodebInfo, err := h.rNibDataService.GetNodeb(ranName)
130 var functionsModified bool
134 if _, ok := err.(*common.ResourceNotFoundError); !ok {
135 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to retrieve nodebInfo entity. Error: %s", ranName, err)
139 if nodebInfo, err = h.handleNewRan(ranName, e2tIpAddress, setupRequest); err != nil {
140 if _, ok := err.(*e2managererrors.UnknownSetupRequestRanNameError); ok {
141 cause := models.Cause{RicRequest: &models.CauseRic{RequestIdUnknown: &struct{}{}}}
142 h.handleUnsuccessfulResponse(ranName, request, cause, setupRequest)
143 models.UpdateProcedureType(ranName, models.E2SetupProcedureFailure)
150 functionsModified, err = h.handleExistingRan(ranName, nodebInfo, setupRequest)
153 h.fillCauseAndSendUnsuccessfulResponse(nodebInfo, request, setupRequest)
154 models.UpdateProcedureType(ranName, models.E2SetupProcedureFailure)
158 models.UpdateProcedureType(ranName, models.E2SetupProcedureOngoing)
160 ranStatusChangePublished, err := h.e2tAssociationManager.AssociateRan(e2tIpAddress, nodebInfo)
164 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to associate E2T to nodeB entity. Error: %s", ranName, err)
165 if _, ok := err.(*e2managererrors.RoutingManagerError); ok {
167 if err = h.handleUpdateAndPublishNodebInfo(functionsModified, ranStatusChangePublished, nodebInfo); err != nil {
171 cause := models.Cause{Transport: &models.CauseTransport{TransportResourceUnavailable: &struct{}{}}}
172 h.handleUnsuccessfulResponse(nodebInfo.RanName, request, cause, setupRequest)
173 models.UpdateProcedureType(ranName, models.E2SetupProcedureFailure)
178 if err = h.handleUpdateAndPublishNodebInfo(functionsModified, ranStatusChangePublished, nodebInfo); err != nil {
182 h.handleSuccessfulResponse(ranName, request, setupRequest)
183 models.UpdateProcedureType(ranName, models.E2SetupProcedureCompleted)
184 h.logger.Debugf("#E2SetupRequestNotificationHandler.Handle - updating the enum value to e2setup request completed")
187 func (h *E2SetupRequestNotificationHandler) handleUpdateAndPublishNodebInfo(functionsModified bool, ranStatusChangePublished bool, nodebInfo *entities.NodebInfo) error {
189 if ranStatusChangePublished || !functionsModified {
193 err := h.rNibDataService.UpdateNodebInfoAndPublish(nodebInfo)
196 h.logger.Errorf("#E2SetupRequestNotificationHandler.handleUpdateAndPublishNodebInfo - RAN name: %s - Failed at UpdateNodebInfoAndPublish. error: %s", nodebInfo.RanName, err)
200 h.logger.Infof("#E2SetupRequestNotificationHandler.handleUpdateAndPublishNodebInfo - RAN name: %s - Successfully executed UpdateNodebInfoAndPublish", nodebInfo.RanName)
205 func (h *E2SetupRequestNotificationHandler) handleNewRan(ranName string, e2tIpAddress string, setupRequest *models.E2SetupRequestMessage) (*entities.NodebInfo, error) {
207 nodebInfo, err := h.buildNodebInfo(ranName, e2tIpAddress, setupRequest)
209 h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed building nodebInfo. Error: %s", ranName, err)
213 err = h.rNibDataService.SaveNodeb(nodebInfo)
215 h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed saving nodebInfo. Error: %s", ranName, err)
219 nbIdentity := h.buildNbIdentity(ranName, setupRequest)
221 err = h.ranListManager.AddNbIdentity(nodebInfo.GetNodeType(), nbIdentity)
227 return nodebInfo, nil
230 func (h *E2SetupRequestNotificationHandler) handleExistingRan(ranName string, nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) (bool, error) {
231 if nodebInfo.GetConnectionStatus() == entities.ConnectionStatus_DISCONNECTED {
232 delta_in_nano := uint64(time.Now().UnixNano()) - nodebInfo.StatusUpdateTimeStamp
233 //The duration from last Disconnection for which a new request is to be rejected (currently 10 sec)
234 if delta_in_nano < cleanUpDurationNanoSec {
235 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity disconnection in progress", ranName, nodebInfo.ConnectionStatus)
236 return false, errors.New("nodeB entity disconnection in progress")
238 h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in disconnected state", ranName, nodebInfo.ConnectionStatus)
239 } else if nodebInfo.GetConnectionStatus() == entities.ConnectionStatus_SHUTTING_DOWN {
240 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", ranName, nodebInfo.ConnectionStatus)
241 return false, errors.New("nodeB entity in incorrect state")
244 nodebInfo.SetupFromNetwork = true
246 e2NodeConfig := setupRequest.ExtractE2NodeConfigList()
247 if e2NodeConfig == nil {
248 return false, errors.New("Empty E2nodeComponentConfigAddition-List")
251 if nodebInfo.NodeType == entities.Node_ENB {
252 if len(e2NodeConfig) == 0 && len(nodebInfo.GetEnb().GetNodeConfigs()) == 0 {
253 return false, errors.New("Empty E2nodeComponentConfigAddition-List")
255 nodebInfo.GetEnb().NodeConfigs = e2NodeConfig
260 if len(e2NodeConfig) == 0 && len(nodebInfo.GetGnb().GetNodeConfigs()) == 0 {
261 return false, errors.New("Empty E2nodeComponentConfigAddition-List")
263 nodebInfo.GetGnb().NodeConfigs = e2NodeConfig
265 setupMessageRanFuncs := setupRequest.ExtractRanFunctionsList()
267 if setupMessageRanFuncs == nil || (len(setupMessageRanFuncs) == 0 && len(nodebInfo.GetGnb().RanFunctions) == 0) {
271 nodebInfo.GetGnb().RanFunctions = setupMessageRanFuncs
275 func (h *E2SetupRequestNotificationHandler) handleUnsuccessfulResponse(ranName string, req *models.NotificationRequest, cause models.Cause, setupRequest *models.E2SetupRequestMessage) {
276 failureResponse := models.NewE2SetupFailureResponseMessage(models.TimeToWaitEnum.V60s, cause, setupRequest)
277 h.logger.Debugf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", failureResponse)
279 responsePayload, err := xml.Marshal(&failureResponse.E2APPDU)
281 h.logger.Warnf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload)
284 responsePayload = utils.ReplaceEmptyTagsWithSelfClosing(responsePayload, emptyTagsToReplaceToSelfClosingTags)
286 h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - payload: %s", responsePayload)
287 msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_FAILURE, ranName, responsePayload, req.TransactionId, req.GetMsgSrc())
288 h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg)
289 _ = h.rmrSender.WhSend(msg)
293 func (h *E2SetupRequestNotificationHandler) handleSuccessfulResponse(ranName string, req *models.NotificationRequest, setupRequest *models.E2SetupRequestMessage) {
295 plmnId := buildPlmnId(h.config.GlobalRicId.Mcc, h.config.GlobalRicId.Mnc)
297 ricNearRtId, err := convertTo20BitString(h.config.GlobalRicId.RicId)
301 successResponse := models.NewE2SetupSuccessResponseMessage(plmnId, ricNearRtId, setupRequest)
302 h.logger.Debugf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", successResponse)
304 responsePayload, err := xml.Marshal(&successResponse.E2APPDU)
306 h.logger.Warnf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload)
309 responsePayload = utils.ReplaceEmptyTagsWithSelfClosing(responsePayload, emptyTagsToReplaceToSelfClosingTags)
311 h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - payload: %s", responsePayload)
313 msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_RESP, ranName, responsePayload, req.TransactionId, req.GetMsgSrc())
314 h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg)
315 _ = h.rmrSender.Send(msg)
318 func buildPlmnId(mmc string, mnc string) string {
319 var b strings.Builder
335 func convertTo20BitString(ricNearRtId string) (string, error) {
336 r, err := strconv.ParseUint(ricNearRtId, 16, 32)
340 return fmt.Sprintf("%020b", r)[:20], nil
343 func (h *E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte) (*models.E2SetupRequestMessage, string, error) {
345 pipInd := bytes.IndexByte(payload, '|')
347 return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request failed extract Payload: no | separator found")
350 e2tIpAddress := string(payload[:pipInd])
351 if len(e2tIpAddress) == 0 {
352 return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Empty E2T Address received")
355 h.logger.Infof("#E2SetupRequestNotificationHandler.parseSetupRequest - payload: %s", payload[pipInd+1:])
357 setupRequest := &models.E2SetupRequestMessage{}
358 err := xml.Unmarshal(utils.NormalizeXml(payload[pipInd+1:]), &setupRequest.E2APPDU)
360 return nil, "", errors.New(fmt.Sprintf("#E2SetupRequestNotificationHandler.parseSetupRequest - Error unmarshalling E2 Setup Request payload: %x", payload))
363 return setupRequest, e2tIpAddress, nil
366 func (h *E2SetupRequestNotificationHandler) buildNodebInfo(ranName string, e2tAddress string, request *models.E2SetupRequestMessage) (*entities.NodebInfo, error) {
367 nodebInfo := &entities.NodebInfo{
368 AssociatedE2TInstanceAddress: e2tAddress,
370 GlobalNbId: h.buildGlobalNbId(request),
371 SetupFromNetwork: true,
373 err := h.setNodeTypeAndConfiguration(nodebInfo)
378 e2NodeConfig := request.ExtractE2NodeConfigList()
379 if e2NodeConfig == nil {
380 return nil, errors.New("Empty E2nodeComponentConfigAddition-List")
383 if nodebInfo.NodeType == entities.Node_ENB {
384 if len(e2NodeConfig) == 0 && len(nodebInfo.GetEnb().GetNodeConfigs()) == 0 {
385 return nil, errors.New("Empty E2nodeComponentConfigAddition-List")
387 nodebInfo.GetEnb().NodeConfigs = e2NodeConfig
389 return nodebInfo, nil
392 if len(e2NodeConfig) == 0 && len(nodebInfo.GetGnb().GetNodeConfigs()) == 0 {
393 return nil, errors.New("Empty E2nodeComponentConfigAddition-List")
395 nodebInfo.GetGnb().NodeConfigs = e2NodeConfig
397 if nodebInfo.NodeType == entities.Node_GNB {
398 h.logger.Debugf("#E2SetupRequestNotificationHandler buildNodebInfo - entities.Node_GNB %d", entities.Node_GNB)
400 gnbNodetype := h.setGnbNodeType(request)
401 h.logger.Debugf("#E2SetupRequestNotificationHandler buildNodebInfo -gnbNodetype %s", gnbNodetype)
402 nodebInfo.GnbNodeType = gnbNodetype
403 nodebInfo.CuUpId = request.GetCuupId()
404 nodebInfo.DuId = request.GetDuId()
405 h.logger.Debugf("#E2SetupRequestNotificationHandler buildNodebInfo -cuupid%s", request.GetCuupId())
406 h.logger.Debugf("#E2SetupRequestNotificationHandler buildNodebInfo -duid %s", request.GetDuId())
409 ranFuncs := request.ExtractRanFunctionsList()
412 nodebInfo.GetGnb().RanFunctions = ranFuncs
415 return nodebInfo, nil
419 func (h *E2SetupRequestNotificationHandler) setGnbNodeType(setupRequest *models.E2SetupRequestMessage) string {
421 /*Note: Deployment where CU-UP and DU are combined
422 (but do not include the CP-CP) and have a single E2 connection
423 is not supported. The combination of CU-CP, CU-UP, and DU will be
424 treated as a single gNB and expect it to have only the
425 global gNB ID in its E2 Setup ID*/
426 if setupRequest.GetCuupId() != "" && setupRequest.GetDuId() != "" {
428 } else if setupRequest.GetCuupId() != "" {
429 gnbNodetype = "gNB_CU_UP"
430 } else if setupRequest.GetDuId() != "" {
431 gnbNodetype = "gNB_DU"
436 func (h *E2SetupRequestNotificationHandler) setNodeTypeAndConfiguration(nodebInfo *entities.NodebInfo) error {
437 for k, v := range gnbTypesMap {
438 if strings.HasPrefix(nodebInfo.RanName, k) {
439 nodebInfo.NodeType = entities.Node_GNB
440 nodebInfo.Configuration = &entities.NodebInfo_Gnb{Gnb: &entities.Gnb{GnbType: v}}
444 for k, v := range enbTypesMap {
445 if strings.HasPrefix(nodebInfo.RanName, k) {
446 nodebInfo.NodeType = entities.Node_ENB
447 nodebInfo.Configuration = &entities.NodebInfo_Enb{Enb: &entities.Enb{EnbType: v}}
452 return e2managererrors.NewUnknownSetupRequestRanNameError(nodebInfo.RanName)
455 func (h *E2SetupRequestNotificationHandler) buildGlobalNbId(setupRequest *models.E2SetupRequestMessage) *entities.GlobalNbId {
456 return &entities.GlobalNbId{
457 PlmnId: setupRequest.GetPlmnId(),
458 NbId: setupRequest.GetNbId(),
462 func (h *E2SetupRequestNotificationHandler) buildNbIdentity(ranName string, setupRequest *models.E2SetupRequestMessage) *entities.NbIdentity {
463 return &entities.NbIdentity{
464 InventoryName: ranName,
465 GlobalNbId: h.buildGlobalNbId(setupRequest),
469 func (h *E2SetupRequestNotificationHandler) fillCauseAndSendUnsuccessfulResponse(nodebInfo *entities.NodebInfo, request *models.NotificationRequest, setupRequest *models.E2SetupRequestMessage) {
470 ranName := request.RanName
471 if nodebInfo.GetConnectionStatus() == entities.ConnectionStatus_DISCONNECTED {
472 cause := models.Cause{Misc: &models.CauseMisc{ControlProcessingOverload: &struct{}{}}}
473 h.handleUnsuccessfulResponse(nodebInfo.RanName, request, cause, setupRequest)
474 models.UpdateProcedureType(ranName, models.E2SetupProcedureFailure)