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"
41 type E2SetupRequestNotificationHandler struct {
43 config *configuration.Configuration
44 e2tInstancesManager managers.IE2TInstancesManager
45 rmrSender *rmrsender.RmrSender
46 rNibDataService services.RNibDataService
47 e2tAssociationManager *managers.E2TAssociationManager
50 func NewE2SetupRequestNotificationHandler(logger *logger.Logger, config *configuration.Configuration, e2tInstancesManager managers.IE2TInstancesManager, rmrSender *rmrsender.RmrSender, rNibDataService services.RNibDataService, e2tAssociationManager *managers.E2TAssociationManager) E2SetupRequestNotificationHandler {
51 return E2SetupRequestNotificationHandler{
54 e2tInstancesManager: e2tInstancesManager,
56 rNibDataService: rNibDataService,
57 e2tAssociationManager: e2tAssociationManager,
61 func (h E2SetupRequestNotificationHandler) Handle(request *models.NotificationRequest) {
62 ranName := request.RanName
63 h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - received E2_SETUP_REQUEST. Payload: %x", ranName, request.Payload)
65 setupRequest, e2tIpAddress, err := h.parseSetupRequest(request.Payload)
67 h.logger.Errorf(err.Error())
71 h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - E2T Address: %s - handling E2_SETUP_REQUEST", e2tIpAddress)
72 h.logger.Debugf("#E2SetupRequestNotificationHandler.Handle - E2_SETUP_REQUEST has been parsed successfully %+v", setupRequest)
74 _, err = h.e2tInstancesManager.GetE2TInstance(e2tIpAddress)
77 h.logger.Errorf("#E2TermInitNotificationHandler.Handle - Failed retrieving E2TInstance. error: %s", err)
81 nodebInfo, err := h.rNibDataService.GetNodeb(ranName)
85 if _, ok := err.(*common.ResourceNotFoundError); !ok {
86 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to retrieve nodebInfo entity. Error: %s", ranName, err)
91 if nodebInfo, err = h.handleNewRan(ranName, e2tIpAddress, setupRequest); err != nil {
96 if err = h.handleExistingRan(ranName, nodebInfo, setupRequest); err != nil {
101 err = h.e2tAssociationManager.AssociateRan(e2tIpAddress, nodebInfo)
105 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to associate E2T to nodeB entity. Error: %s", ranName, err)
106 if _, ok := err.(*e2managererrors.RoutingManagerError); ok {
107 h.handleUnsuccessfulResponse(nodebInfo, request)
112 h.handleSuccessfulResponse(ranName, request, setupRequest)
115 func (h E2SetupRequestNotificationHandler) handleNewRan(ranName string, e2tIpAddress string, setupRequest *models.E2SetupRequestMessage) (*entities.NodebInfo, error) {
117 nodebInfo, err := h.buildNodebInfo(ranName, e2tIpAddress, setupRequest)
120 h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed to build nodebInfo entity. Error: %s", ranName, err)
124 nbIdentity := h.buildNbIdentity(ranName, setupRequest)
125 err = h.rNibDataService.SaveNodeb(nbIdentity, nodebInfo)
128 h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed to save nodebInfo entity. Error: %s", ranName, err)
132 return nodebInfo, nil
135 func (h E2SetupRequestNotificationHandler) setGnbFunctions(nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) error {
136 ranFunctions := setupRequest.ExtractRanFunctionsList()
138 if ranFunctions != nil {
139 nodebInfo.GetGnb().RanFunctions = ranFunctions
145 func (h E2SetupRequestNotificationHandler) handleExistingRan(ranName string, nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) error {
146 if nodebInfo.GetConnectionStatus() == entities.ConnectionStatus_SHUTTING_DOWN {
147 h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", ranName, nodebInfo.ConnectionStatus)
148 return errors.New("nodeB entity in incorrect state")
151 err := h.setGnbFunctions(nodebInfo, setupRequest)
155 func (h E2SetupRequestNotificationHandler) handleUnsuccessfulResponse(nodebInfo *entities.NodebInfo, req *models.NotificationRequest) {
156 failureResponse := models.NewE2SetupFailureResponseMessage(models.TimeToWaitEnum.V60s)
157 h.logger.Debugf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", failureResponse)
159 responsePayload, err := xml.Marshal(&failureResponse.E2APPDU)
161 h.logger.Warnf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", nodebInfo.RanName, responsePayload)
164 responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload)
166 h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - payload: %s", responsePayload)
168 msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_FAILURE, nodebInfo.RanName, responsePayload, req.TransactionId, req.GetMsgSrc())
169 h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", nodebInfo.RanName, msg)
170 _ = h.rmrSender.WhSend(msg)
174 func (h E2SetupRequestNotificationHandler) handleSuccessfulResponse(ranName string, req *models.NotificationRequest, setupRequest *models.E2SetupRequestMessage) {
176 plmnId := buildPlmnId(h.config.GlobalRicId.Mcc, h.config.GlobalRicId.Mnc)
178 ricNearRtId, err := convertTo20BitString(h.config.GlobalRicId.RicId)
182 successResponse := models.NewE2SetupSuccessResponseMessage(plmnId, ricNearRtId, setupRequest)
183 h.logger.Debugf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", successResponse)
185 responsePayload, err := xml.Marshal(&successResponse.E2APPDU)
187 h.logger.Warnf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload)
190 responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload)
192 h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - payload: %s", responsePayload)
194 msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_RESP, ranName, responsePayload, req.TransactionId, req.GetMsgSrc())
195 h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg)
196 _ = h.rmrSender.Send(msg)
199 func buildPlmnId(mmc string, mnc string) string{
200 var b strings.Builder
216 func replaceEmptyTagsWithSelfClosing(responsePayload []byte) []byte {
217 responseString := strings.NewReplacer(
218 "<reject></reject>", "<reject/>",
219 "<ignore></ignore>", "<ignore/>",
220 "<transport-resource-unavailable></transport-resource-unavailable>", "<transport-resource-unavailable/>",
221 "<v60s></v60s>", "<v60s/>",
222 "<v20s></v20s>", "<v20s/>",
223 "<v10s></v10s>", "<v10s/>",
224 "<v5s></v5s>", "<v5s/>",
225 "<v2s></v2s>", "<v2s/>",
226 "<v1s></v1s>", "<v1s/>",
227 ).Replace(string(responsePayload))
228 return []byte(responseString)
231 func convertTo20BitString(ricNearRtId string) (string, error) {
232 r, err := strconv.ParseUint(ricNearRtId, 16, 32)
236 return fmt.Sprintf("%020b", r)[:20], nil
239 func (h E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte) (*models.E2SetupRequestMessage, string, error) {
241 pipInd := bytes.IndexByte(payload, '|')
243 return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request failed extract Payload: no | separator found")
246 e2tIpAddress := string(payload[:pipInd])
247 if len(e2tIpAddress) == 0 {
248 return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Empty E2T Address received")
251 h.logger.Infof("#E2SetupRequestNotificationHandler.parseSetupRequest - payload: %s", payload[pipInd+1:])
253 setupRequest := &models.E2SetupRequestMessage{}
254 err := xml.Unmarshal(normalizeXml(payload[pipInd+1:]), &setupRequest.E2APPDU)
256 return nil, "", errors.New(fmt.Sprintf("#E2SetupRequestNotificationHandler.parseSetupRequest - Error unmarshalling E2 Setup Request payload: %x", payload))
259 return setupRequest, e2tIpAddress, nil
262 func normalizeXml(payload []byte) []byte {
263 xmlStr := string(payload)
264 normalized := strings.NewReplacer("<", "<", ">", ">").Replace(xmlStr)
265 return []byte(normalized)
268 func (h E2SetupRequestNotificationHandler) buildNodebInfo(ranName string, e2tAddress string, request *models.E2SetupRequestMessage) (*entities.NodebInfo, error) {
271 nodebInfo := &entities.NodebInfo{
272 AssociatedE2TInstanceAddress: e2tAddress,
273 ConnectionStatus: entities.ConnectionStatus_CONNECTED,
275 NodeType: entities.Node_GNB,
276 Configuration: &entities.NodebInfo_Gnb{Gnb: &entities.Gnb{}},
277 GlobalNbId: h.buildGlobalNbId(request),
280 err = h.setGnbFunctions(nodebInfo, request)
281 return nodebInfo, err
284 func (h E2SetupRequestNotificationHandler) buildGlobalNbId(setupRequest *models.E2SetupRequestMessage) *entities.GlobalNbId {
285 return &entities.GlobalNbId{
286 PlmnId: setupRequest.GetPlmnId(),
287 NbId: setupRequest.GetNbId(),
291 func (h E2SetupRequestNotificationHandler) buildNbIdentity(ranName string, setupRequest *models.E2SetupRequestMessage) *entities.NbIdentity {
292 return &entities.NbIdentity{
293 InventoryName: ranName,
294 GlobalNbId: h.buildGlobalNbId(setupRequest),