E2Manager/handlers/rmrmsghandlers/x2_reset_response_handler.go

   1 //
   2 // Copyright 2019 AT&T Intellectual Property
   3 // Copyright 2019 Nokia
   4 //
   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
   8 //
   9 //      http://www.apache.org/licenses/LICENSE-2.0
  10 //
  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.
  16
  17 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)
  18 //  platform project (RICP).
  19
  20
  21 package rmrmsghandlers
  22
  23 // #cgo CFLAGS: -I../../3rdparty/asn1codec/inc/ -I../../3rdparty/asn1codec/e2ap_engine/
  24 // #cgo LDFLAGS: -L ../../3rdparty/asn1codec/lib/ -L../../3rdparty/asn1codec/e2ap_engine/ -le2ap_codec -lasncodec
  25 // #include <asn1codec_utils.h>
  26 import "C"
  27 import (
  28         "e2mgr/converters"
  29         "e2mgr/enums"
  30         "e2mgr/logger"
  31         "e2mgr/managers"
  32         "e2mgr/models"
  33         "e2mgr/rmrCgo"
  34         "e2mgr/services"
  35         "e2mgr/utils"
  36         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  37 )
  38
  39 const ResetResponseLogInfoElapsedTime = "#X2ResetResponseHandler.Handle - Summary: elapsed time for receiving and handling reset request message from E2 terminator: %f ms"
  40
  41 type X2ResetResponseHandler struct {
  42         logger                 *logger.Logger
  43         rnibDataService        services.RNibDataService
  44         ranStatusChangeManager managers.IRanStatusChangeManager
  45         extractor              converters.IX2ResetResponseExtractor
  46 }
  47
  48 func NewX2ResetResponseHandler(logger *logger.Logger, rnibDataService services.RNibDataService, ranStatusChangeManager managers.IRanStatusChangeManager, x2ResetResponseExtractor converters.IX2ResetResponseExtractor) X2ResetResponseHandler {
  49         return X2ResetResponseHandler{
  50                 logger:                 logger,
  51                 rnibDataService:        rnibDataService,
  52                 ranStatusChangeManager: ranStatusChangeManager,
  53                 extractor:              x2ResetResponseExtractor,
  54         }
  55 }
  56
  57 func (h X2ResetResponseHandler) Handle(request *models.NotificationRequest) {
  58         ranName := request.RanName
  59         h.logger.Infof("#X2ResetResponseHandler.Handle - RAN name: %s - received reset response. Payload: %x", ranName, request.Payload)
  60
  61         nodebInfo, err := h.rnibDataService.GetNodeb(ranName)
  62         if err != nil {
  63                 h.logger.Errorf("#x2ResetResponseHandler.Handle - RAN name: %s - failed to retrieve nodebInfo entity. Error: %s", ranName, err)
  64                 return
  65         }
  66
  67         if nodebInfo.ConnectionStatus == entities.ConnectionStatus_SHUTTING_DOWN {
  68                 h.logger.Warnf("#X2ResetResponseHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", nodebInfo.RanName, nodebInfo.ConnectionStatus)
  69                 h.logger.Infof(ResetResponseLogInfoElapsedTime, utils.ElapsedTime(request.StartTime))
  70                 return
  71         }
  72
  73         if nodebInfo.ConnectionStatus != entities.ConnectionStatus_CONNECTED {
  74                 h.logger.Errorf("#X2ResetResponseHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", nodebInfo.RanName, nodebInfo.ConnectionStatus)
  75                 h.logger.Infof(ResetResponseLogInfoElapsedTime, utils.ElapsedTime(request.StartTime))
  76                 return
  77         }
  78
  79         isSuccessfulResetResponse, err := h.isSuccessfulResetResponse(ranName, request.Payload)
  80
  81         h.logger.Infof(ResetResponseLogInfoElapsedTime, utils.ElapsedTime(request.StartTime))
  82
  83         if err != nil || !isSuccessfulResetResponse {
  84                 return
  85         }
  86
  87         _ = h.ranStatusChangeManager.Execute(rmrCgo.RAN_RESTARTED, enums.RIC_TO_RAN, nodebInfo)
  88 }
  89
  90 func (h X2ResetResponseHandler) isSuccessfulResetResponse(ranName string, packedBuffer []byte) (bool, error) {
  91
  92         criticalityDiagnostics, err := h.extractor.ExtractCriticalityDiagnosticsFromPdu(packedBuffer)
  93
  94         if err != nil {
  95                 h.logger.Errorf("#X2ResetResponseHandler.isSuccessfulResetResponse - RAN name: %s - Failed extracting pdu: %s", ranName, err)
  96                 return false, err
  97         }
  98
  99         if criticalityDiagnostics != nil {
 100                 h.logger.Errorf("#X2ResetResponseHandler.isSuccessfulResetResponse - RAN name: %s - Unsuccessful RESET response message. Criticality diagnostics: %s", ranName, criticalityDiagnostics)
 101                 return false, nil
 102         }
 103
 104         h.logger.Infof("#X2ResetResponseHandler.isSuccessfulResetResponse - RAN name: %s - Successful RESET response message", ranName)
 105         return true, nil
 106 }