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
55 func NewE2SetupRequestNotificationHandler(logger *logger.Logger, config *configuration.Configuration, e2tInstancesManager managers.IE2TInstancesManager, rmrSender *rmrsender.RmrSender, rNibDataService services.RNibDataService, e2tAssociationManager *managers.E2TAssociationManager) *E2SetupRequestNotificationHandler {
56 return &E2SetupRequestNotificationHandler{
59 e2tInstancesManager: e2tInstancesManager,
61 rNibDataService: rNibDataService,
62 e2tAssociationManager: e2tAssociationManager,
66 func (h *E2SetupRequestNotificationHandler) Handle(request *models.NotificationRequest) {
67 ranName := request.RanName
68 h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - received E2_SETUP_REQUEST. Payload: %x", ranName, request.Payload)
70 generalConfiguration, err := h.rNibDataService.GetGeneralConfiguration()
73 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - Failed retrieving e2m general configuration. error: %s", err)
77 if !generalConfiguration.EnableRic {
78 cause := models.Cause{Misc: &models.CauseMisc{OmIntervention: &struct{}{}}}
79 h.handleUnsuccessfulResponse(ranName, request, cause)
83 setupRequest, e2tIpAddress, err := h.parseSetupRequest(request.Payload)
85 h.logger.Errorf(err.Error())
89 h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - E2T Address: %s - handling E2_SETUP_REQUEST", e2tIpAddress)
90 h.logger.Debugf("#E2SetupRequestNotificationHandler.Handle - E2_SETUP_REQUEST has been parsed successfully %+v", setupRequest)
92 _, err = h.e2tInstancesManager.GetE2TInstance(e2tIpAddress)
95 h.logger.Errorf("#E2TermInitNotificationHandler.Handle - Failed retrieving E2TInstance. error: %s", err)
99 nodebInfo, err := h.rNibDataService.GetNodeb(ranName)
103 if _, ok := err.(*common.ResourceNotFoundError); !ok {
104 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to retrieve nodebInfo entity. Error: %s", ranName, err)
109 if nodebInfo, err = h.handleNewRan(ranName, e2tIpAddress, setupRequest); err != nil {
114 if err = h.handleExistingRan(ranName, nodebInfo, setupRequest); err != nil {
119 err = h.e2tAssociationManager.AssociateRan(e2tIpAddress, nodebInfo)
123 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to associate E2T to nodeB entity. Error: %s", ranName, err)
124 if _, ok := err.(*e2managererrors.RoutingManagerError); ok {
125 cause := models.Cause{Transport: &models.CauseTransport{TransportResourceUnavailable: &struct{}{}}}
126 h.handleUnsuccessfulResponse(nodebInfo.RanName, request, cause)
131 h.handleSuccessfulResponse(ranName, request, setupRequest)
134 func (h *E2SetupRequestNotificationHandler) handleNewRan(ranName string, e2tIpAddress string, setupRequest *models.E2SetupRequestMessage) (*entities.NodebInfo, error) {
136 nodebInfo, err := h.buildNodebInfo(ranName, e2tIpAddress, setupRequest)
139 h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed to build nodebInfo entity. Error: %s", ranName, err)
143 nbIdentity := h.buildNbIdentity(ranName, setupRequest)
144 err = h.rNibDataService.SaveNodeb(nbIdentity, nodebInfo)
147 h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed to save nodebInfo entity. Error: %s", ranName, err)
151 return nodebInfo, nil
154 func (h *E2SetupRequestNotificationHandler) setGnbFunctions(nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) error {
155 ranFunctions := setupRequest.ExtractRanFunctionsList()
157 if ranFunctions != nil {
158 nodebInfo.GetGnb().RanFunctions = ranFunctions
164 func (h *E2SetupRequestNotificationHandler) handleExistingRan(ranName string, nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) error {
165 if nodebInfo.GetConnectionStatus() == entities.ConnectionStatus_SHUTTING_DOWN {
166 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", ranName, nodebInfo.ConnectionStatus)
167 return errors.New("nodeB entity in incorrect state")
170 err := h.setGnbFunctions(nodebInfo, setupRequest)
174 func (h *E2SetupRequestNotificationHandler) handleUnsuccessfulResponse(ranName string, req *models.NotificationRequest, cause models.Cause) {
175 failureResponse := models.NewE2SetupFailureResponseMessage(models.TimeToWaitEnum.V60s, cause)
176 h.logger.Debugf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", failureResponse)
178 responsePayload, err := xml.Marshal(&failureResponse.E2APPDU)
180 h.logger.Warnf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload)
183 responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload)
185 h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - payload: %s", responsePayload)
186 msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_FAILURE, ranName, responsePayload, req.TransactionId, req.GetMsgSrc())
187 h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg)
188 _ = h.rmrSender.WhSend(msg)
192 func (h *E2SetupRequestNotificationHandler) handleSuccessfulResponse(ranName string, req *models.NotificationRequest, setupRequest *models.E2SetupRequestMessage) {
194 plmnId := buildPlmnId(h.config.GlobalRicId.Mcc, h.config.GlobalRicId.Mnc)
196 ricNearRtId, err := convertTo20BitString(h.config.GlobalRicId.RicId)
200 successResponse := models.NewE2SetupSuccessResponseMessage(plmnId, ricNearRtId, setupRequest)
201 h.logger.Debugf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", successResponse)
203 responsePayload, err := xml.Marshal(&successResponse.E2APPDU)
205 h.logger.Warnf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload)
208 responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload)
210 h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - payload: %s", responsePayload)
212 msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_RESP, ranName, responsePayload, req.TransactionId, req.GetMsgSrc())
213 h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg)
214 _ = h.rmrSender.Send(msg)
217 func buildPlmnId(mmc string, mnc string) string {
218 var b strings.Builder
234 func replaceEmptyTagsWithSelfClosing(responsePayload []byte) []byte {
236 emptyTagVsSelfClosingTagPairs := make([]string, len(emptyTagsToReplaceToSelfClosingTags)*2)
240 for i := 0; i < len(emptyTagsToReplaceToSelfClosingTags); i++ {
241 emptyTagVsSelfClosingTagPairs[j] = fmt.Sprintf("<%[1]s></%[1]s>", emptyTagsToReplaceToSelfClosingTags[i])
242 emptyTagVsSelfClosingTagPairs[j+1] = fmt.Sprintf("<%s/>", emptyTagsToReplaceToSelfClosingTags[i])
245 responseString := strings.NewReplacer(emptyTagVsSelfClosingTagPairs...).Replace(string(responsePayload))
246 return []byte(responseString)
249 func convertTo20BitString(ricNearRtId string) (string, error) {
250 r, err := strconv.ParseUint(ricNearRtId, 16, 32)
254 return fmt.Sprintf("%020b", r)[:20], nil
257 func (h *E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte) (*models.E2SetupRequestMessage, string, error) {
259 pipInd := bytes.IndexByte(payload, '|')
261 return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request failed extract Payload: no | separator found")
264 e2tIpAddress := string(payload[:pipInd])
265 if len(e2tIpAddress) == 0 {
266 return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Empty E2T Address received")
269 h.logger.Infof("#E2SetupRequestNotificationHandler.parseSetupRequest - payload: %s", payload[pipInd+1:])
271 setupRequest := &models.E2SetupRequestMessage{}
272 err := xml.Unmarshal(normalizeXml(payload[pipInd+1:]), &setupRequest.E2APPDU)
274 return nil, "", errors.New(fmt.Sprintf("#E2SetupRequestNotificationHandler.parseSetupRequest - Error unmarshalling E2 Setup Request payload: %x", payload))
277 return setupRequest, e2tIpAddress, nil
280 func normalizeXml(payload []byte) []byte {
281 xmlStr := string(payload)
282 normalized := strings.NewReplacer("<", "<", ">", ">").Replace(xmlStr)
283 return []byte(normalized)
286 func (h E2SetupRequestNotificationHandler) buildNodebInfo(ranName string, e2tAddress string, request *models.E2SetupRequestMessage) (*entities.NodebInfo, error) {
289 nodebInfo := &entities.NodebInfo{
290 AssociatedE2TInstanceAddress: e2tAddress,
291 ConnectionStatus: entities.ConnectionStatus_CONNECTED,
293 NodeType: entities.Node_GNB,
294 Configuration: &entities.NodebInfo_Gnb{Gnb: &entities.Gnb{}},
295 GlobalNbId: h.buildGlobalNbId(request),
298 err = h.setGnbFunctions(nodebInfo, request)
299 return nodebInfo, err
302 func (h E2SetupRequestNotificationHandler) buildGlobalNbId(setupRequest *models.E2SetupRequestMessage) *entities.GlobalNbId {
303 return &entities.GlobalNbId{
304 PlmnId: setupRequest.GetPlmnId(),
305 NbId: setupRequest.GetNbId(),
309 func (h E2SetupRequestNotificationHandler) buildNbIdentity(ranName string, setupRequest *models.E2SetupRequestMessage) *entities.NbIdentity {
310 return &entities.NbIdentity{
311 InventoryName: ranName,
312 GlobalNbId: h.buildGlobalNbId(setupRequest),