X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=pkg%2Fcontrol%2Fcontrol.go;h=4c0cf9a460b7342c532ca143a0c34a86327380e4;hb=6bd579175aaa85f1dd864ad10fe4209ed6b450ea;hp=0567ad6264773da1dceddb8ab9bbe5799c952721;hpb=aafee7f742a73f11ab3f49056ade4eda9f2d87d0;p=ric-plt%2Fsubmgr.git diff --git a/pkg/control/control.go b/pkg/control/control.go index 0567ad6..4c0cf9a 100755 --- a/pkg/control/control.go +++ b/pkg/control/control.go @@ -21,35 +21,73 @@ package control import ( "fmt" + "net/http" + "sync" + "time" + "gerrit.o-ran-sc.org/r/ric-plt/e2ap/pkg/e2ap" rtmgrclient "gerrit.o-ran-sc.org/r/ric-plt/submgr/pkg/rtmgr_client" - rtmgrhandle "gerrit.o-ran-sc.org/r/ric-plt/submgr/pkg/rtmgr_client/handle" + "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/models" + "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/restapi/operations/common" "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp" httptransport "github.com/go-openapi/runtime/client" "github.com/go-openapi/strfmt" + "github.com/segmentio/ksuid" "github.com/spf13/viper" - "math/rand" - "sync" - "time" ) //----------------------------------------------------------------------------- // //----------------------------------------------------------------------------- -var subReqTime time.Duration = 5 * time.Second -var subDelReqTime time.Duration = 5 * time.Second -var maxSubReqTryCount uint64 = 2 // Initial try + retry -var maxSubDelReqTryCount uint64 = 2 // Initial try + retry +func idstring(err error, entries ...fmt.Stringer) string { + var retval string = "" + var filler string = "" + for _, entry := range entries { + if entry != nil { + retval += filler + entry.String() + filler = " " + } else { + retval += filler + "(NIL)" + } + } + if err != nil { + retval += filler + "err(" + err.Error() + ")" + filler = " " + } + return retval +} + +//----------------------------------------------------------------------------- +// +//----------------------------------------------------------------------------- + +var e2tSubReqTimeout time.Duration +var e2tSubDelReqTime time.Duration +var e2tRecvMsgTimeout time.Duration +var waitRouteCleanup_ms time.Duration +var e2tMaxSubReqTryCount uint64 // Initial try + retry +var e2tMaxSubDelReqTryCount uint64 // Initial try + retry +var checkE2State string +var readSubsFromDb string +var dbRetryForever string +var dbTryCount int type Control struct { - e2ap *E2ap - registry *Registry - rtmgrClient *RtmgrClient - tracker *Tracker - timerMap *TimerMap - rmrSendMutex sync.Mutex - msgCounter uint64 + *xapp.RMRClient + e2ap *E2ap + registry *Registry + tracker *Tracker + restDuplicateCtrl *DuplicateCtrl + e2IfState *E2IfState + e2IfStateDb XappRnibInterface + e2SubsDb Sdlnterface + restSubsDb Sdlnterface + CntRecvMsg uint64 + ResetTestFlag bool + Counters map[string]xapp.Counter + LoggerLevel int + UTTesting bool } type RMRMeid struct { @@ -58,636 +96,1493 @@ type RMRMeid struct { RanName string } -var seedSN uint16 +type SubmgrRestartTestEvent struct{} +type SubmgrRestartUpEvent struct{} +type PackSubscriptionRequestErrortEvent struct { + ErrorInfo ErrorInfo +} + +func (p *PackSubscriptionRequestErrortEvent) SetEvent(errorInfo *ErrorInfo) { + p.ErrorInfo = *errorInfo +} -const ( - CREATE Action = 0 - MERGE Action = 1 - NONE Action = 2 - DELETE Action = 3 -) +type SDLWriteErrortEvent struct { + ErrorInfo ErrorInfo +} + +func (s *SDLWriteErrortEvent) SetEvent(errorInfo *ErrorInfo) { + s.ErrorInfo = *errorInfo +} func init() { - xapp.Logger.Info("SUBMGR") + xapp.Logger.Debug("SUBMGR") viper.AutomaticEnv() viper.SetEnvPrefix("submgr") viper.AllowEmptyEnv(true) - seedSN = uint16(viper.GetInt("seed_sn")) - if seedSN == 0 { - rand.Seed(time.Now().UnixNano()) - seedSN = uint16(rand.Intn(65535)) - } - if seedSN > 65535 { - seedSN = 0 - } - xapp.Logger.Info("SUBMGR: Initial Sequence Number: %v", seedSN) } func NewControl() *Control { + transport := httptransport.New(viper.GetString("rtmgr.HostAddr")+":"+viper.GetString("rtmgr.port"), viper.GetString("rtmgr.baseUrl"), []string{"http"}) + rtmgrClient := RtmgrClient{rtClient: rtmgrclient.New(transport, strfmt.Default)} + registry := new(Registry) - registry.Initialize(seedSN) + registry.Initialize() + registry.rtmgrClient = &rtmgrClient tracker := new(Tracker) tracker.Init() - timerMap := new(TimerMap) - timerMap.Init() + restDuplicateCtrl := new(DuplicateCtrl) + restDuplicateCtrl.Init() + + e2IfState := new(E2IfState) + + c := &Control{e2ap: new(E2ap), + registry: registry, + tracker: tracker, + restDuplicateCtrl: restDuplicateCtrl, + e2IfState: e2IfState, + e2IfStateDb: CreateXappRnibIfInstance(), + e2SubsDb: CreateSdl(), + restSubsDb: CreateRESTSdl(), + Counters: xapp.Metric.RegisterCounterGroup(GetMetricsOpts(), "SUBMGR"), + LoggerLevel: 1, + } + + e2IfState.Init(c) + c.ReadConfigParameters("") - transport := httptransport.New(viper.GetString("rtmgr.HostAddr")+":"+viper.GetString("rtmgr.port"), viper.GetString("rtmgr.baseUrl"), []string{"http"}) - client := rtmgrclient.New(transport, strfmt.Default) - handle := rtmgrhandle.NewProvideXappSubscriptionHandleParamsWithTimeout(10 * time.Second) - deleteHandle := rtmgrhandle.NewDeleteXappSubscriptionHandleParamsWithTimeout(10 * time.Second) - rtmgrClient := RtmgrClient{client, handle, deleteHandle} + // Register REST handler for testing support + xapp.Resource.InjectRoute("/ric/v1/symptomdata", c.SymptomDataHandler, "GET") + xapp.Resource.InjectRoute("/ric/v1/test/{testId}", c.TestRestHandler, "POST") + xapp.Resource.InjectRoute("/ric/v1/restsubscriptions", c.GetAllRestSubscriptions, "GET") - rtmgrClientPtr := &rtmgrClient + xapp.Resource.InjectRoute("/ric/v1/get_all_e2nodes", c.GetAllE2Nodes, "GET") + xapp.Resource.InjectRoute("/ric/v1/get_e2node_rest_subscriptions/{ranName}", c.GetAllE2NodeRestSubscriptions, "GET") - //TODO: to make this better. Now it is just a hack. - registry.rtmgrClient = rtmgrClientPtr + xapp.Resource.InjectRoute("/ric/v1/get_all_xapps", c.GetAllXapps, "GET") + xapp.Resource.InjectRoute("/ric/v1/get_xapp_rest_restsubscriptions/{xappServiceName}", c.GetAllXappRestSubscriptions, "GET") + xapp.Resource.InjectRoute("/ric/v1/get_e2subscriptions/{restId}", c.GetE2Subscriptions, "GET") - return &Control{e2ap: new(E2ap), - registry: registry, - rtmgrClient: rtmgrClientPtr, - tracker: tracker, - timerMap: timerMap, - msgCounter: 0, + xapp.Resource.InjectRoute("/ric/v1/delete_all_e2node_subscriptions/{ranName}", c.DeleteAllE2nodeSubscriptions, "DELETE") + xapp.Resource.InjectRoute("/ric/v1/delete_all_xapp_subscriptions/{xappServiceName}", c.DeleteAllXappSubscriptions, "DELETE") + + if readSubsFromDb == "true" { + // Read subscriptions from db + c.ReadE2Subscriptions() + c.ReadRESTSubscriptions() } + + go xapp.Subscription.Listen(c.RESTSubscriptionHandler, c.RESTQueryHandler, c.RESTSubscriptionDeleteHandler) + return c } -func (c *Control) Run() { - xapp.Run(c) +func (c *Control) SymptomDataHandler(w http.ResponseWriter, r *http.Request) { + subscriptions, _ := c.registry.QueryHandler() + xapp.Resource.SendSymptomDataJson(w, r, subscriptions, "platform/subscriptions.json") } -func (c *Control) rmrSendRaw(desc string, params *RMRParams) (err error) { +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) RESTQueryHandler() (models.SubscriptionList, error) { + xapp.Logger.Debug("RESTQueryHandler() called") + + c.CntRecvMsg++ - xapp.Logger.Info("%s: %s", desc, params.String()) - status := false - i := 1 - for ; i <= 10 && status == false; i++ { - c.rmrSendMutex.Lock() - status = xapp.Rmr.Send(params.RMRParams, false) - c.rmrSendMutex.Unlock() - if status == false { - xapp.Logger.Info("rmr.Send() failed. Retry count %d, %s", i, params.String()) - time.Sleep(500 * time.Millisecond) + return c.registry.QueryHandler() +} + +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) ReadE2Subscriptions() error { + var err error + var subIds []uint32 + var register map[uint32]*Subscription + for i := 0; dbRetryForever == "true" || i < dbTryCount; i++ { + xapp.Logger.Debug("Reading E2 subscriptions from db") + subIds, register, err = c.ReadAllSubscriptionsFromSdl() + if err != nil { + xapp.Logger.Error("%v", err) + <-time.After(1 * time.Second) + } else { + c.registry.subIds = subIds + c.registry.register = register + go c.HandleUncompletedSubscriptions(register) + return nil } } - if status == false { - err = fmt.Errorf("rmr.Send() failed. Retry count %d, %s", i, params.String()) - xapp.Logger.Error("%s: %s", desc, err.Error()) - xapp.Rmr.Free(params.Mbuf) + xapp.Logger.Debug("Continuing without retring") + return err +} + +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) ReadRESTSubscriptions() error { + + xapp.Logger.Debug("ReadRESTSubscriptions()") + var err error + var restSubscriptions map[string]*RESTSubscription + for i := 0; dbRetryForever == "true" || i < dbTryCount; i++ { + xapp.Logger.Debug("Reading REST subscriptions from db") + restSubscriptions, err = c.ReadAllRESTSubscriptionsFromSdl() + if err != nil { + xapp.Logger.Error("%v", err) + <-time.After(1 * time.Second) + } else { + // Fix REST subscriptions ongoing status after restart + for restSubId, restSubscription := range restSubscriptions { + restSubscription.SubReqOngoing = false + restSubscription.SubDelReqOngoing = false + c.WriteRESTSubscriptionToSdl(restSubId, restSubscription) + } + c.registry.restSubscriptions = restSubscriptions + return nil + } } - return + xapp.Logger.Debug("Continuing without retring") + return err } -func (c *Control) rmrSend(desc string, subs *Subscription, trans *Transaction, payload []byte, payloadLen int) (err error) { - params := &RMRParams{&xapp.RMRParams{}} - params.Mtype = trans.GetMtype() - params.SubId = int(subs.GetSubId()) - params.Xid = "" - params.Meid = subs.GetMeid() - params.Src = "" - params.PayloadLen = payloadLen - params.Payload = payload - params.Mbuf = nil +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) ReadConfigParameters(f string) { + + xapp.Logger.Debug("ReadConfigParameters") + + c.LoggerLevel = int(xapp.Logger.GetLevel()) + xapp.Logger.Info("LoggerLevel = %v", c.LoggerLevel) + c.e2ap.SetASN1DebugPrintStatus(c.LoggerLevel) + + // viper.GetDuration returns nanoseconds + e2tSubReqTimeout = viper.GetDuration("controls.e2tSubReqTimeout_ms") * 1000000 + if e2tSubReqTimeout == 0 { + e2tSubReqTimeout = 2000 * 1000000 + xapp.Logger.Debug("WARNING: Using hard coded default value for e2tSubReqTimeout") + } + xapp.Logger.Debug("e2tSubReqTimeout= %v", e2tSubReqTimeout) + + e2tSubDelReqTime = viper.GetDuration("controls.e2tSubDelReqTime_ms") * 1000000 + if e2tSubDelReqTime == 0 { + e2tSubDelReqTime = 2000 * 1000000 + xapp.Logger.Debug("WARNING: Using hard coded default value for e2tSubDelReqTime") + } + xapp.Logger.Debug("e2tSubDelReqTime= %v", e2tSubDelReqTime) + + e2tRecvMsgTimeout = viper.GetDuration("controls.e2tRecvMsgTimeout_ms") * 1000000 + if e2tRecvMsgTimeout == 0 { + e2tRecvMsgTimeout = 2000 * 1000000 + xapp.Logger.Debug("WARNING: Using hard coded default value for e2tRecvMsgTimeout") + } + xapp.Logger.Debug("e2tRecvMsgTimeout= %v", e2tRecvMsgTimeout) + + e2tMaxSubReqTryCount = viper.GetUint64("controls.e2tMaxSubReqTryCount") + if e2tMaxSubReqTryCount == 0 { + e2tMaxSubReqTryCount = 1 + xapp.Logger.Debug("WARNING: Using hard coded default value for e2tMaxSubReqTryCount") + } + xapp.Logger.Debug("e2tMaxSubReqTryCount= %v", e2tMaxSubReqTryCount) + + e2tMaxSubDelReqTryCount = viper.GetUint64("controls.e2tMaxSubDelReqTryCount") + if e2tMaxSubDelReqTryCount == 0 { + e2tMaxSubDelReqTryCount = 1 + xapp.Logger.Debug("WARNING: Using hard coded default value for e2tMaxSubDelReqTryCount") + } + xapp.Logger.Debug("e2tMaxSubDelReqTryCount= %v", e2tMaxSubDelReqTryCount) - return c.rmrSendRaw(desc, params) + checkE2State = viper.GetString("controls.checkE2State") + if checkE2State == "" { + checkE2State = "true" + xapp.Logger.Debug("WARNING: Using hard coded default value for checkE2State") + } + xapp.Logger.Debug("checkE2State= %v", checkE2State) + + readSubsFromDb = viper.GetString("controls.readSubsFromDb") + if readSubsFromDb == "" { + readSubsFromDb = "true" + xapp.Logger.Debug("WARNING: Using hard coded default value for readSubsFromDb") + } + xapp.Logger.Debug("readSubsFromDb= %v", readSubsFromDb) + + dbTryCount = viper.GetInt("controls.dbTryCount") + if dbTryCount == 0 { + dbTryCount = 200 + xapp.Logger.Debug("WARNING: Using hard coded default value for dbTryCount") + } + xapp.Logger.Debug("dbTryCount= %v", dbTryCount) + + dbRetryForever = viper.GetString("controls.dbRetryForever") + if dbRetryForever == "" { + dbRetryForever = "true" + xapp.Logger.Debug("WARNING: Using hard coded default value for dbRetryForever") + } + xapp.Logger.Debug("dbRetryForever= %v", dbRetryForever) + + // Internal cfg parameter, used to define a wait time for RMR route clean-up. None default + // value 100ms used currently only in unittests. + waitRouteCleanup_ms = viper.GetDuration("controls.waitRouteCleanup_ms") * 1000000 + if waitRouteCleanup_ms == 0 { + waitRouteCleanup_ms = 5000 * 1000000 + xapp.Logger.Debug("WARNING: Using hard coded default value for waitRouteCleanup_ms") + } + xapp.Logger.Debug("waitRouteCleanup= %v", waitRouteCleanup_ms) } -func (c *Control) rmrReplyToSender(desc string, subs *Subscription, trans *Transaction, mType int, payload []byte, payloadLen int) (err error) { - params := &RMRParams{&xapp.RMRParams{}} - params.Mtype = mType - params.SubId = int(subs.GetSubId()) - params.Xid = trans.GetXid() - params.Meid = trans.GetMeid() - params.Src = "" - params.PayloadLen = payloadLen - params.Payload = payload - params.Mbuf = nil +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) HandleUncompletedSubscriptions(register map[uint32]*Subscription) { + + xapp.Logger.Debug("HandleUncompletedSubscriptions. len(register) = %v", len(register)) + for subId, subs := range register { + if subs.SubRespRcvd == false { + // If policy subscription has already been made successfully unsuccessful update should not be deleted. + if subs.PolicyUpdate == false { + subs.NoRespToXapp = true + xapp.Logger.Debug("SendSubscriptionDeleteReq. subId = %v", subId) + c.SendSubscriptionDeleteReq(subs) + } + } + } +} - return c.rmrSendRaw(desc, params) +func (c *Control) ReadyCB(data interface{}) { + if c.RMRClient == nil { + c.RMRClient = xapp.Rmr + } } -func (c *Control) Consume(params *xapp.RMRParams) (err error) { - xapp.Rmr.Free(params.Mbuf) - params.Mbuf = nil - msg := &RMRParams{params} - c.msgCounter++ - switch msg.Mtype { - case xapp.RICMessageTypes["RIC_SUB_REQ"]: - go c.handleSubscriptionRequest(msg) - case xapp.RICMessageTypes["RIC_SUB_RESP"]: - go c.handleSubscriptionResponse(msg) - case xapp.RICMessageTypes["RIC_SUB_FAILURE"]: - go c.handleSubscriptionFailure(msg) - case xapp.RICMessageTypes["RIC_SUB_DEL_REQ"]: - go c.handleSubscriptionDeleteRequest(msg) - case xapp.RICMessageTypes["RIC_SUB_DEL_RESP"]: - go c.handleSubscriptionDeleteResponse(msg) - case xapp.RICMessageTypes["RIC_SUB_DEL_FAILURE"]: - go c.handleSubscriptionDeleteFailure(msg) - default: - xapp.Logger.Info("Unknown Message Type '%d', discarding", msg.Mtype) +func (c *Control) Run() { + xapp.SetReadyCB(c.ReadyCB, nil) + xapp.AddConfigChangeListener(c.ReadConfigParameters) + xapp.Run(c) +} + +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) GetOrCreateRestSubscription(p *models.SubscriptionParams, md5sum string, xAppRmrEndpoint string, xAppServiceName string) (*RESTSubscription, string, error) { + + var restSubId string + var restSubscription *RESTSubscription + var err error + + prevRestSubsId, exists := c.restDuplicateCtrl.GetLastKnownRestSubsIdBasedOnMd5sum(md5sum) + if p.SubscriptionID == "" { + // Subscription does not contain REST subscription Id + if exists { + restSubscription, err = c.registry.GetRESTSubscription(prevRestSubsId, false) + if restSubscription != nil { + // Subscription not found + restSubId = prevRestSubsId + if err == nil { + xapp.Logger.Debug("Existing restSubId %s found by MD5sum %s for a request without subscription ID - using previous subscription", prevRestSubsId, md5sum) + } else { + xapp.Logger.Debug("Existing restSubId %s found by MD5sum %s for a request without subscription ID - Note: %s", prevRestSubsId, md5sum, err.Error()) + } + } else { + xapp.Logger.Debug("None existing restSubId %s referred by MD5sum %s for a request without subscription ID - deleting cached entry", prevRestSubsId, md5sum) + c.restDuplicateCtrl.DeleteLastKnownRestSubsIdBasedOnMd5sum(md5sum) + } + } + + if restSubscription == nil { + restSubId = ksuid.New().String() + restSubscription = c.registry.CreateRESTSubscription(&restSubId, &xAppServiceName, &xAppRmrEndpoint, p.Meid) + } + } else { + // Subscription contains REST subscription Id + restSubId = p.SubscriptionID + + xapp.Logger.Debug("RestSubscription ID %s provided via REST request", restSubId) + restSubscription, err = c.registry.GetRESTSubscription(restSubId, false) + if err != nil { + // Subscription with id in REST request does not exist + xapp.Logger.Error("%s", err.Error()) + c.UpdateCounter(cRestSubFailToXapp) + return nil, "", err + } + + if !exists { + xapp.Logger.Debug("Existing restSubscription found for ID %s, new request based on md5sum", restSubId) + } else { + xapp.Logger.Debug("Existing restSubscription found for ID %s(%s), re-transmission based on md5sum match with previous request", prevRestSubsId, restSubId) + } } - return nil + return restSubscription, restSubId, nil } -func (c *Control) handleSubscriptionRequest(params *RMRParams) { - xapp.Logger.Info("SubReq from xapp: %s", params.String()) +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) RESTSubscriptionHandler(params interface{}) (*models.SubscriptionResponse, int) { - // - // - // - trans, err := c.tracker.TrackTransaction(NewRmrEndpoint(params.Src), - params.Mtype, - params.Xid, - params.Meid, - false, - true) + c.CntRecvMsg++ + c.UpdateCounter(cRestSubReqFromXapp) + + subResp := models.SubscriptionResponse{} + p := params.(*models.SubscriptionParams) + + if c.LoggerLevel > 2 { + c.PrintRESTSubscriptionRequest(p) + } + + if c.e2IfState.IsE2ConnectionUp(p.Meid) == false { + xapp.Logger.Error("No E2 connection for ranName %v", *p.Meid) + c.UpdateCounter(cRestReqRejDueE2Down) + return nil, common.SubscribeServiceUnavailableCode + } + if p.ClientEndpoint == nil { + err := fmt.Errorf("ClientEndpoint == nil") + xapp.Logger.Error("%v", err) + c.UpdateCounter(cRestSubFailToXapp) + return nil, common.SubscribeBadRequestCode + } + + e2SubscriptionDirectives, err := c.GetE2SubscriptionDirectives(p) if err != nil { - xapp.Logger.Error("SubReq: %s, Dropping this msg. %s", err.Error(), params.String()) - return + xapp.Logger.Error("%s", err) + c.UpdateCounter(cRestSubFailToXapp) + return nil, common.SubscribeBadRequestCode + } + _, xAppRmrEndpoint, err := ConstructEndpointAddresses(*p.ClientEndpoint) + if err != nil { + xapp.Logger.Error("%s", err.Error()) + c.UpdateCounter(cRestSubFailToXapp) + return nil, common.SubscribeBadRequestCode } - // - // - // - trans.SubReqMsg, err = c.e2ap.UnpackSubscriptionRequest(params.Payload) + md5sum, err := CalculateRequestMd5sum(params) if err != nil { - xapp.Logger.Error("SubReq: %s Dropping this msg. %s", err.Error(), trans) - trans.Release() - return + xapp.Logger.Error("Failed to generate md5sum from incoming request - %s", err.Error()) } - // - // - // - subs, err := c.registry.ReserveSubscription(&trans.RmrEndpoint, trans.Meid) + restSubscription, restSubId, err := c.GetOrCreateRestSubscription(p, md5sum, xAppRmrEndpoint, p.ClientEndpoint.Host) if err != nil { - xapp.Logger.Error("SubReq: %s, Dropping this msg. %s", err.Error(), trans) - trans.Release() - return + xapp.Logger.Error("Subscription with id in REST request does not exist") + return nil, common.SubscribeNotFoundCode } - err = subs.SetTransaction(trans) + subResp.SubscriptionID = &restSubId + subReqList := e2ap.SubscriptionRequestList{} + err = c.e2ap.FillSubscriptionReqMsgs(params, &subReqList, restSubscription) if err != nil { - xapp.Logger.Error("SubReq: %s, Dropping this msg. %s", err.Error(), trans) - c.registry.DelSubscription(subs.Seq) - trans.Release() - return + xapp.Logger.Error("%s", err.Error()) + c.restDuplicateCtrl.DeleteLastKnownRestSubsIdBasedOnMd5sum(md5sum) + c.registry.DeleteRESTSubscription(&restSubId) + c.UpdateCounter(cRestSubFailToXapp) + return nil, common.SubscribeBadRequestCode } - trans.SubReqMsg.RequestId.Seq = uint32(subs.GetSubId()) + duplicate := c.restDuplicateCtrl.IsDuplicateToOngoingTransaction(restSubId, md5sum) + if duplicate { + err := fmt.Errorf("Retransmission blocker direct ACK for request of restSubsId %s restSubId MD5sum %s as retransmission", restSubId, md5sum) + xapp.Logger.Debug("%s", err) + c.registry.DeleteRESTSubscription(&restSubId) + c.UpdateCounter(cRestSubRespToXapp) + return &subResp, common.SubscribeCreatedCode + } - // - // TODO: subscription create is in fact owned by subscription and not transaction. - // Transaction is toward xapp while Subscription is toward ran. - // In merge several xapps may wake transactions, while only one subscription - // toward ran occurs -> subscription owns subscription creation toward ran - // - // This is intermediate solution while improving message handling - // - packedData, err := c.e2ap.PackSubscriptionRequest(trans.SubReqMsg) - if err != nil { - xapp.Logger.Error("SubReq: %s for trans %s", err.Error(), trans) - c.registry.DelSubscription(subs.Seq) - trans.Release() - return + c.WriteRESTSubscriptionToDb(restSubId, restSubscription) + go c.processSubscriptionRequests(restSubscription, &subReqList, p.ClientEndpoint, p.Meid, &restSubId, xAppRmrEndpoint, md5sum, e2SubscriptionDirectives) + + c.UpdateCounter(cRestSubRespToXapp) + return &subResp, common.SubscribeCreatedCode +} + +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) GetE2SubscriptionDirectives(p *models.SubscriptionParams) (*E2SubscriptionDirectives, error) { + + e2SubscriptionDirectives := &E2SubscriptionDirectives{} + if p == nil || p.E2SubscriptionDirectives == nil { + e2SubscriptionDirectives.E2TimeoutTimerValue = e2tSubReqTimeout + e2SubscriptionDirectives.E2MaxTryCount = int64(e2tMaxSubReqTryCount) + e2SubscriptionDirectives.CreateRMRRoute = true + xapp.Logger.Debug("p == nil || p.E2SubscriptionDirectives == nil. Using default values for E2TimeoutTimerValue = %v and E2RetryCount = %v RMRRoutingNeeded = true", e2tSubReqTimeout, e2tMaxSubReqTryCount) + } else { + if p.E2SubscriptionDirectives.E2TimeoutTimerValue >= 1 && p.E2SubscriptionDirectives.E2TimeoutTimerValue <= 10 { + e2SubscriptionDirectives.E2TimeoutTimerValue = time.Duration(p.E2SubscriptionDirectives.E2TimeoutTimerValue) * 1000000000 // Duration type cast returns nano seconds + } else { + return nil, fmt.Errorf("p.E2SubscriptionDirectives.E2TimeoutTimerValue out of range (1-10 seconds): %v", p.E2SubscriptionDirectives.E2TimeoutTimerValue) + } + if p.E2SubscriptionDirectives.E2RetryCount == nil { + xapp.Logger.Error("p.E2SubscriptionDirectives.E2RetryCount == nil. Using default value") + e2SubscriptionDirectives.E2MaxTryCount = int64(e2tMaxSubReqTryCount) + } else { + if *p.E2SubscriptionDirectives.E2RetryCount >= 0 && *p.E2SubscriptionDirectives.E2RetryCount <= 10 { + e2SubscriptionDirectives.E2MaxTryCount = *p.E2SubscriptionDirectives.E2RetryCount + 1 // E2MaxTryCount = First sending plus two retries + } else { + return nil, fmt.Errorf("p.E2SubscriptionDirectives.E2RetryCount out of range (0-10): %v", *p.E2SubscriptionDirectives.E2RetryCount) + } + } + e2SubscriptionDirectives.CreateRMRRoute = p.E2SubscriptionDirectives.RMRRoutingNeeded } + xapp.Logger.Debug("e2SubscriptionDirectives.E2TimeoutTimerValue: %v", e2SubscriptionDirectives.E2TimeoutTimerValue) + xapp.Logger.Debug("e2SubscriptionDirectives.E2MaxTryCount: %v", e2SubscriptionDirectives.E2MaxTryCount) + xapp.Logger.Debug("e2SubscriptionDirectives.CreateRMRRoute: %v", e2SubscriptionDirectives.CreateRMRRoute) + return e2SubscriptionDirectives, nil +} - //Optimize and store packed message to be sent (for retransmission). Again owned by subscription? - trans.Payload = packedData.Buf - trans.PayloadLen = len(packedData.Buf) +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- - c.rmrSend("SubReq to E2T", subs, trans, packedData.Buf, len(packedData.Buf)) +func (c *Control) processSubscriptionRequests(restSubscription *RESTSubscription, subReqList *e2ap.SubscriptionRequestList, + clientEndpoint *models.SubscriptionParamsClientEndpoint, meid *string, restSubId *string, xAppRmrEndpoint string, md5sum string, e2SubscriptionDirectives *E2SubscriptionDirectives) { - c.timerMap.StartTimer("RIC_SUB_REQ", int(subs.GetSubId()), subReqTime, FirstTry, c.handleSubscriptionRequestTimer) - xapp.Logger.Debug("SubReq: Debugging trans table = %v", c.tracker.transactionXappTable) - return + c.SubscriptionProcessingStartDelay() + xapp.Logger.Debug("E2 SubscriptionRequest count = %v ", len(subReqList.E2APSubscriptionRequests)) + + var xAppEventInstanceID int64 + var e2EventInstanceID int64 + errorInfo := &ErrorInfo{} + + defer c.restDuplicateCtrl.SetMd5sumFromLastOkRequest(*restSubId, md5sum) + + for index := 0; index < len(subReqList.E2APSubscriptionRequests); index++ { + subReqMsg := subReqList.E2APSubscriptionRequests[index] + xAppEventInstanceID = (int64)(subReqMsg.RequestId.Id) + + trans := c.tracker.NewXappTransaction(xapp.NewRmrEndpoint(xAppRmrEndpoint), *restSubId, subReqMsg.RequestId, &xapp.RMRMeid{RanName: *meid}) + if trans == nil { + // Send notification to xApp that prosessing of a Subscription Request has failed. + err := fmt.Errorf("Tracking failure") + errorInfo.ErrorCause = err.Error() + c.sendUnsuccesfullResponseNotification(restSubId, restSubscription, xAppEventInstanceID, err, clientEndpoint, trans, errorInfo) + continue + } + + xapp.Logger.Debug("Handle SubscriptionRequest index=%v, %s", index, idstring(nil, trans)) + + subRespMsg, errorInfo, err := c.handleSubscriptionRequest(trans, &subReqMsg, meid, *restSubId, e2SubscriptionDirectives) + + xapp.Logger.Debug("Handled SubscriptionRequest index=%v, %s", index, idstring(nil, trans)) + trans.Release() + + if err != nil { + if err.Error() == "TEST: restart event received" { + // This is just for UT cases. Stop here subscription processing + return + } + c.sendUnsuccesfullResponseNotification(restSubId, restSubscription, xAppEventInstanceID, err, clientEndpoint, trans, errorInfo) + } else { + e2EventInstanceID = (int64)(subRespMsg.RequestId.InstanceId) + restSubscription.AddMd5Sum(md5sum) + xapp.Logger.Debug("SubscriptionRequest index=%v processed successfullyfor %s. endpoint=%v:%v, XappEventInstanceID=%v, E2EventInstanceID=%v, %s", + index, *restSubId, clientEndpoint.Host, *clientEndpoint.HTTPPort, xAppEventInstanceID, e2EventInstanceID, idstring(nil, trans)) + c.sendSuccesfullResponseNotification(restSubId, restSubscription, xAppEventInstanceID, e2EventInstanceID, clientEndpoint, trans, errorInfo) + } + } } -func (c *Control) handleSubscriptionResponse(params *RMRParams) { - xapp.Logger.Info("SubResp from E2T: %s", params.String()) +//------------------------------------------------------------------- +// +//------------------------------------------------------------------ +func (c *Control) SubscriptionProcessingStartDelay() { + if c.UTTesting == true { + // This is temporary fix for the UT problem that notification arrives before subscription response + // Correct fix would be to allow notification come before response and process it correctly + xapp.Logger.Debug("Setting 50 ms delay before starting processing Subscriptions") + <-time.After(time.Millisecond * 50) + xapp.Logger.Debug("Continuing after delay") + } +} - // - // - // - SubRespMsg, err := c.e2ap.UnpackSubscriptionResponse(params.Payload) +//------------------------------------------------------------------- +// +//------------------------------------------------------------------ +func (c *Control) handleSubscriptionRequest(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest, meid *string, + restSubId string, e2SubscriptionDirectives *E2SubscriptionDirectives) (*e2ap.E2APSubscriptionResponse, *ErrorInfo, error) { + + errorInfo := ErrorInfo{} + + err := c.tracker.Track(trans) if err != nil { - xapp.Logger.Error("SubDelReq: %s Dropping this msg. %s", err.Error(), params.String()) - return + xapp.Logger.Error("XAPP-SubReq Tracking error: %s", idstring(err, trans)) + errorInfo.ErrorCause = err.Error() + err = fmt.Errorf("Tracking failure") + return nil, &errorInfo, err + } + + subs, errorInfo, err := c.registry.AssignToSubscription(trans, subReqMsg, c.ResetTestFlag, c, e2SubscriptionDirectives.CreateRMRRoute) + if err != nil { + xapp.Logger.Error("XAPP-SubReq Assign error: %s", idstring(err, trans)) + return nil, &errorInfo, err } // + // Wake subs request // - // - subs := c.registry.GetSubscription(uint16(SubRespMsg.RequestId.Seq)) - if subs == nil && params.SubId > 0 { - subs = c.registry.GetSubscription(uint16(params.SubId)) + subs.OngoingReqCount++ + go c.handleSubscriptionCreate(subs, trans, e2SubscriptionDirectives, 0) + event, _ := trans.WaitEvent(0) //blocked wait as timeout is handled in subs side + subs.OngoingReqCount-- + + err = nil + if event != nil { + switch themsg := event.(type) { + case *e2ap.E2APSubscriptionResponse: + trans.Release() + if c.e2IfState.IsE2ConnectionUp(meid) == true { + errorInfo = c.e2ap.CheckActionNotAdmittedList(xapp.RIC_SUB_RESP, themsg.ActionNotAdmittedList, c) + return themsg, &errorInfo, nil + } else { + c.registry.RemoveFromSubscription(subs, trans, waitRouteCleanup_ms, c) + c.RemoveSubscriptionFromDb(subs) + err = fmt.Errorf("E2 interface down") + errorInfo.SetInfo(err.Error(), models.SubscriptionInstanceErrorSourceE2Node, "") + } + case *e2ap.E2APSubscriptionFailure: + err = fmt.Errorf("RICSubscriptionFailure. E2NodeCause: (Cause:%v, Value %v)", themsg.Cause.Content, themsg.Cause.Value) + errorInfo.SetInfo(err.Error(), models.SubscriptionInstanceErrorSourceE2Node, "") + case *PackSubscriptionRequestErrortEvent: + err = fmt.Errorf("E2 RICSubscriptionRequest pack failure") + errorInfo = themsg.ErrorInfo + case *SDLWriteErrortEvent: + err = fmt.Errorf("SDL write failure") + errorInfo = themsg.ErrorInfo + case *SubmgrRestartTestEvent: + err = fmt.Errorf("TEST: restart event received") + xapp.Logger.Debug("%s", err) + return nil, &errorInfo, err + default: + err = fmt.Errorf("Unexpected E2 subscription response received") + errorInfo.SetInfo(err.Error(), models.SubscriptionInstanceErrorSourceE2Node, "") + break + } + } else { + // Timer expiry + err = fmt.Errorf("E2 RICSubscriptionResponse timeout") + errorInfo.SetInfo(err.Error(), "", models.SubscriptionInstanceTimeoutTypeE2Timeout) + if subs.PolicyUpdate == true { + return nil, &errorInfo, err + } } - if subs == nil { - xapp.Logger.Error("SubResp: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", SubRespMsg.RequestId.Seq, params.SubId, params.String()) - return - } - xapp.Logger.Info("SubResp: subscription found payloadSeqNum: %d, SubId: %d", SubRespMsg.RequestId.Seq, subs.GetSubId()) + xapp.Logger.Error("XAPP-SubReq E2 subscription failed %s", idstring(err, trans, subs)) + c.registry.RemoveFromSubscription(subs, trans, waitRouteCleanup_ms, c) + return nil, &errorInfo, err +} - // - // - // - trans := subs.GetTransaction() - if trans == nil { - xapp.Logger.Error("SubResp: Unknown trans. Dropping this msg. SubId: %d", subs.GetSubId()) - return +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) sendUnsuccesfullResponseNotification(restSubId *string, restSubscription *RESTSubscription, xAppEventInstanceID int64, err error, + clientEndpoint *models.SubscriptionParamsClientEndpoint, trans *TransactionXapp, errorInfo *ErrorInfo) { + + // Send notification to xApp that prosessing of a Subscription Request has failed. + e2EventInstanceID := (int64)(0) + if errorInfo.ErrorSource == "" { + // Submgr is default source of error + errorInfo.ErrorSource = models.SubscriptionInstanceErrorSourceSUBMGR + } + resp := &models.SubscriptionResponse{ + SubscriptionID: restSubId, + SubscriptionInstances: []*models.SubscriptionInstance{ + &models.SubscriptionInstance{E2EventInstanceID: &e2EventInstanceID, + ErrorCause: errorInfo.ErrorCause, + ErrorSource: errorInfo.ErrorSource, + TimeoutType: errorInfo.TimeoutType, + XappEventInstanceID: &xAppEventInstanceID}, + }, + } + // Mark REST subscription request processed. + restSubscription.SetProcessed(err) + c.UpdateRESTSubscriptionInDB(*restSubId, restSubscription, false) + if trans != nil { + xapp.Logger.Debug("Sending unsuccessful REST notification: ErrorCause:%s, ErrorSource:%s, TimeoutType:%s, to Endpoint=%v:%v, XappEventInstanceID=%v, E2EventInstanceID=%v, %s", + errorInfo.ErrorCause, errorInfo.ErrorSource, errorInfo.TimeoutType, clientEndpoint.Host, *clientEndpoint.HTTPPort, xAppEventInstanceID, e2EventInstanceID, idstring(nil, trans)) + } else { + xapp.Logger.Debug("Sending unsuccessful REST notification: ErrorCause:%s, ErrorSource:%s, TimeoutType:%s, to Endpoint=%v:%v, XappEventInstanceID=%v, E2EventInstanceID=%v", + errorInfo.ErrorCause, errorInfo.ErrorSource, errorInfo.TimeoutType, clientEndpoint.Host, *clientEndpoint.HTTPPort, xAppEventInstanceID, e2EventInstanceID) } - trans.SubRespMsg = SubRespMsg + c.UpdateCounter(cRestSubFailNotifToXapp) + xapp.Subscription.Notify(resp, *clientEndpoint) - // - // - // - c.timerMap.StopTimer("RIC_SUB_REQ", int(subs.GetSubId())) + // E2 is down. Delete completely processed request safely now + if c.e2IfState.IsE2ConnectionUp(&restSubscription.Meid) == false && restSubscription.SubReqOngoing == false { + c.registry.DeleteRESTSubscription(restSubId) + c.RemoveRESTSubscriptionFromDb(*restSubId) + } +} - responseReceived := trans.CheckResponseReceived() - if responseReceived == true { - // Subscription timer already received - return +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) sendSuccesfullResponseNotification(restSubId *string, restSubscription *RESTSubscription, xAppEventInstanceID int64, e2EventInstanceID int64, + clientEndpoint *models.SubscriptionParamsClientEndpoint, trans *TransactionXapp, errorInfo *ErrorInfo) { + + // Store successfully processed InstanceId for deletion + restSubscription.AddE2InstanceId((uint32)(e2EventInstanceID)) + restSubscription.AddXappIdToE2Id(xAppEventInstanceID, e2EventInstanceID) + + // Send notification to xApp that a Subscription Request has been processed. + resp := &models.SubscriptionResponse{ + SubscriptionID: restSubId, + SubscriptionInstances: []*models.SubscriptionInstance{ + &models.SubscriptionInstance{E2EventInstanceID: &e2EventInstanceID, + ErrorCause: errorInfo.ErrorCause, + ErrorSource: errorInfo.ErrorSource, + XappEventInstanceID: &xAppEventInstanceID}, + }, + } + // Mark REST subscription request processesd. + restSubscription.SetProcessed(nil) + c.UpdateRESTSubscriptionInDB(*restSubId, restSubscription, false) + xapp.Logger.Debug("Sending successful REST notification: ErrorCause:%s, ErrorSource:%s, TimeoutType:%s, to Endpoint=%v:%v, XappEventInstanceID=%v, E2EventInstanceID=%v, %s", + errorInfo.ErrorCause, errorInfo.ErrorSource, errorInfo.TimeoutType, clientEndpoint.Host, *clientEndpoint.HTTPPort, xAppEventInstanceID, e2EventInstanceID, idstring(nil, trans)) + c.UpdateCounter(cRestSubNotifToXapp) + xapp.Subscription.Notify(resp, *clientEndpoint) + + // E2 is down. Delete completely processed request safely now + if c.e2IfState.IsE2ConnectionUp(&restSubscription.Meid) == false && restSubscription.SubReqOngoing == false { + c.registry.DeleteRESTSubscription(restSubId) + c.RemoveRESTSubscriptionFromDb(*restSubId) } +} + +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) RESTSubscriptionDeleteHandler(restSubId string) int { - packedData, err := c.e2ap.PackSubscriptionResponse(trans.SubRespMsg) + c.CntRecvMsg++ + c.UpdateCounter(cRestSubDelReqFromXapp) + + xapp.Logger.Debug("SubscriptionDeleteRequest from XAPP") + + restSubscription, err := c.registry.GetRESTSubscription(restSubId, true) if err != nil { - xapp.Logger.Error("SubResp: %s for trans %s", err.Error(), trans) - trans.Release() - return + xapp.Logger.Error("%s", err.Error()) + if restSubscription == nil { + // Subscription was not found + c.UpdateCounter(cRestSubDelRespToXapp) + return common.UnsubscribeNoContentCode + } else { + if restSubscription.SubReqOngoing == true { + err := fmt.Errorf("Handling of the REST Subscription Request still ongoing %s", restSubId) + xapp.Logger.Error("%s", err.Error()) + c.UpdateCounter(cRestSubDelFailToXapp) + return common.UnsubscribeBadRequestCode + } else if restSubscription.SubDelReqOngoing == true { + // Previous request for same restSubId still ongoing + c.UpdateCounter(cRestSubDelRespToXapp) + return common.UnsubscribeNoContentCode + } + } } - //Optimize and store packed message to be sent. - trans.Payload = packedData.Buf - trans.PayloadLen = len(packedData.Buf) + xAppRmrEndPoint := restSubscription.xAppRmrEndPoint + go func() { + xapp.Logger.Debug("Deleteting handler: processing instances = %v", restSubscription.InstanceIds) + for _, instanceId := range restSubscription.InstanceIds { + xAppEventInstanceID, err := c.SubscriptionDeleteHandler(&restSubId, &xAppRmrEndPoint, &restSubscription.Meid, instanceId, 0) + + if err != nil { + xapp.Logger.Error("%s", err.Error()) + } + xapp.Logger.Debug("Deleteting instanceId = %v", instanceId) + restSubscription.DeleteXappIdToE2Id(xAppEventInstanceID) + restSubscription.DeleteE2InstanceId(instanceId) + } + c.restDuplicateCtrl.DeleteLastKnownRestSubsIdBasedOnMd5sum(restSubscription.lastReqMd5sum) + c.registry.DeleteRESTSubscription(&restSubId) + c.RemoveRESTSubscriptionFromDb(restSubId) + }() - subs.Confirmed() - trans.Release() - c.rmrReplyToSender("SubResp to xapp", subs, trans, 12011, trans.Payload, trans.PayloadLen) - return + c.UpdateCounter(cRestSubDelRespToXapp) + return common.UnsubscribeNoContentCode } -func (c *Control) handleSubscriptionFailure(params *RMRParams) { - xapp.Logger.Info("SubFail from E2T: %s", params.String()) +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) SubscriptionDeleteHandler(restSubId *string, endPoint *string, meid *string, instanceId uint32, waitRouteCleanupTime time.Duration) (int64, error) { - payloadSeqNum, err := c.e2ap.GetSubscriptionFailureSequenceNumber(params.Payload) + var xAppEventInstanceID int64 + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{instanceId}) if err != nil { - xapp.Logger.Error("SubFail: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload) - return + xapp.Logger.Debug("Subscription Delete Handler subscription for restSubId=%v, E2EventInstanceID=%v not found %s", + restSubId, instanceId, idstring(err, nil)) + return xAppEventInstanceID, nil } - xapp.Logger.Info("SubFail: Received payloadSeqNum: %v", payloadSeqNum) - subs := c.registry.GetSubscription(payloadSeqNum) - if subs == nil { - xapp.Logger.Error("SubFail: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) - return + xAppEventInstanceID = int64(subs.ReqId.Id) + trans := c.tracker.NewXappTransaction(xapp.NewRmrEndpoint(*endPoint), *restSubId, e2ap.RequestId{subs.ReqId.Id, 0}, &xapp.RMRMeid{RanName: *meid}) + if trans == nil { + err := fmt.Errorf("XAPP-SubDelReq transaction not created. restSubId %s, endPoint %s, meid %s, instanceId %v", *restSubId, *endPoint, *meid, instanceId) + xapp.Logger.Error("%s", err.Error()) } + defer trans.Release() - trans := subs.GetTransaction() - if trans == nil { - xapp.Logger.Error("SubFail: Unknown trans. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) - return + err = c.tracker.Track(trans) + if err != nil { + err := fmt.Errorf("XAPP-SubDelReq %s:", idstring(err, trans)) + xapp.Logger.Error("%s", err.Error()) + return xAppEventInstanceID, &time.ParseError{} } + // + // Wake subs delete + // + subs.OngoingDelCount++ + go c.handleSubscriptionDelete(subs, trans, waitRouteCleanupTime) + trans.WaitEvent(0) //blocked wait as timeout is handled in subs side + subs.OngoingDelCount-- + + xapp.Logger.Debug("XAPP-SubDelReq: Handling event %s ", idstring(nil, trans, subs)) - c.timerMap.StopTimer("RIC_SUB_REQ", int(payloadSeqNum)) + c.registry.RemoveFromSubscription(subs, trans, waitRouteCleanup_ms, c) - responseReceived := trans.CheckResponseReceived() + return xAppEventInstanceID, nil +} + +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- + +func (c *Control) rmrSendToE2T(desc string, subs *Subscription, trans *TransactionSubs) (err error) { + params := &xapp.RMRParams{} + params.Mtype = trans.GetMtype() + params.SubId = int(subs.GetReqId().InstanceId) + params.Xid = "" + params.Meid = subs.GetMeid() + params.Src = "" + params.PayloadLen = len(trans.Payload.Buf) + params.Payload = trans.Payload.Buf + params.Mbuf = nil + xapp.Logger.Debug("MSG to E2T: %s %s %s", desc, trans.String(), params.String()) + err = c.SendWithRetry(params, false, 5) if err != nil { - xapp.Logger.Info("SubFail: Dropping this msg. Err: %v SubId: %v", err, payloadSeqNum) - return + xapp.Logger.Error("rmrSendToE2T: Send failed: %+v", err) + } + return err +} + +func (c *Control) rmrSendToXapp(desc string, subs *Subscription, trans *TransactionXapp) (err error) { + + params := &xapp.RMRParams{} + params.Mtype = trans.GetMtype() + params.SubId = int(subs.GetReqId().InstanceId) + params.Xid = trans.GetXid() + params.Meid = trans.GetMeid() + params.Src = "" + params.PayloadLen = len(trans.Payload.Buf) + params.Payload = trans.Payload.Buf + params.Mbuf = nil + xapp.Logger.Debug("MSG to XAPP: %s %s %s", desc, trans.String(), params.String()) + err = c.SendWithRetry(params, false, 5) + if err != nil { + xapp.Logger.Error("rmrSendToXapp: Send failed: %+v", err) } + return err +} - if responseReceived == true { - // Subscription timer already received +func (c *Control) Consume(msg *xapp.RMRParams) (err error) { + if c.RMRClient == nil { + err = fmt.Errorf("Rmr object nil can handle %s", msg.String()) + xapp.Logger.Error("%s", err.Error()) return } - xapp.Logger.Info("SubFail: SubId: %v, from address: %s. Forwarding response to xApp", payloadSeqNum, trans.RmrEndpoint) + c.CntRecvMsg++ - c.rmrReplyToSender("SubFail to xapp", subs, trans, params.Mtype, params.Payload, params.PayloadLen) + defer c.RMRClient.Free(msg.Mbuf) - time.Sleep(3 * time.Second) + // xapp-frame might use direct access to c buffer and + // when msg.Mbuf is freed, someone might take it into use + // and payload data might be invalid inside message handle function + // + // subscriptions won't load system a lot so there is no + // real performance hit by cloning buffer into new go byte slice + cPay := append(msg.Payload[:0:0], msg.Payload...) + msg.Payload = cPay + msg.PayloadLen = len(cPay) - xapp.Logger.Info("SubFail: Deleting trans record. SubId: %v, Xid: %s", params.SubId, params.Xid) - trans.Release() - if !c.registry.DelSubscription(payloadSeqNum) { - xapp.Logger.Error("SubFail: Failed to release sequency number. SubId: %v, Xid: %s", params.SubId, params.Xid) + switch msg.Mtype { + case xapp.RIC_SUB_REQ: + go c.handleXAPPSubscriptionRequest(msg) + case xapp.RIC_SUB_RESP: + go c.handleE2TSubscriptionResponse(msg) + case xapp.RIC_SUB_FAILURE: + go c.handleE2TSubscriptionFailure(msg) + case xapp.RIC_SUB_DEL_REQ: + go c.handleXAPPSubscriptionDeleteRequest(msg) + case xapp.RIC_SUB_DEL_RESP: + go c.handleE2TSubscriptionDeleteResponse(msg) + case xapp.RIC_SUB_DEL_FAILURE: + go c.handleE2TSubscriptionDeleteFailure(msg) + default: + xapp.Logger.Debug("Unknown Message Type '%d', discarding", msg.Mtype) } return } -func (c *Control) handleSubscriptionRequestTimer(strId string, nbrId int, tryCount uint64) { - xapp.Logger.Info("SubReq timeout: subId: %v, tryCount: %v", nbrId, tryCount) +//------------------------------------------------------------------- +// handle from XAPP Subscription Request +//------------------------------------------------------------------ +func (c *Control) handleXAPPSubscriptionRequest(params *xapp.RMRParams) { + xapp.Logger.Debug("MSG from XAPP: %s", params.String()) + c.UpdateCounter(cSubReqFromXapp) - subs := c.registry.GetSubscription(uint16(nbrId)) - if subs == nil { - xapp.Logger.Error("SubReq timeout: Unknown payloadSeqNum. Dropping this msg. SubId: %v", nbrId) + if c.e2IfState.IsE2ConnectionUp(¶ms.Meid.RanName) == false { + xapp.Logger.Error("No E2 connection for ranName %v", params.Meid.RanName) return } - trans := subs.GetTransaction() + subReqMsg, err := c.e2ap.UnpackSubscriptionRequest(params.Payload) + if err != nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, params)) + return + } + + trans := c.tracker.NewXappTransaction(xapp.NewRmrEndpoint(params.Src), params.Xid, subReqMsg.RequestId, params.Meid) if trans == nil { - xapp.Logger.Error("SubReq timeout: Unknown trans. Dropping this msg. SubId: %v", subs.GetSubId()) + xapp.Logger.Error("XAPP-SubReq: %s", idstring(fmt.Errorf("transaction not created"), params)) return } + defer trans.Release() - responseReceived := trans.CheckResponseReceived() + if err = c.tracker.Track(trans); err != nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) + return + } - if responseReceived == true { - // Subscription Response or Failure already received + subs, _, err := c.registry.AssignToSubscription(trans, subReqMsg, c.ResetTestFlag, c, true) + if err != nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) return } - if tryCount < maxSubReqTryCount { - xapp.Logger.Info("SubReq timeout: Resending SubReq to E2T: Mtype: %v, SubId: %v, Xid %s, Meid %v", trans.GetMtype(), subs.GetSubId(), trans.GetXid(), trans.GetMeid()) + c.wakeSubscriptionRequest(subs, trans) +} - trans.RetryTransaction() +//------------------------------------------------------------------- +// Wake Subscription Request to E2node +//------------------------------------------------------------------ +func (c *Control) wakeSubscriptionRequest(subs *Subscription, trans *TransactionXapp) { + + e2SubscriptionDirectives, _ := c.GetE2SubscriptionDirectives(nil) + subs.OngoingReqCount++ + go c.handleSubscriptionCreate(subs, trans, e2SubscriptionDirectives, waitRouteCleanup_ms) + event, _ := trans.WaitEvent(0) //blocked wait as timeout is handled in subs side + subs.OngoingReqCount-- + var err error + if event != nil { + switch themsg := event.(type) { + case *e2ap.E2APSubscriptionResponse: + themsg.RequestId.Id = trans.RequestId.Id + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionResponse(themsg) + if err == nil { + trans.Release() + c.UpdateCounter(cSubRespToXapp) + c.rmrSendToXapp("", subs, trans) + return + } + case *e2ap.E2APSubscriptionFailure: + themsg.RequestId.Id = trans.RequestId.Id + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionFailure(themsg) + if err == nil { + c.UpdateCounter(cSubFailToXapp) + c.rmrSendToXapp("", subs, trans) + } + default: + break + } + } + xapp.Logger.Debug("XAPP-SubReq: failed %s", idstring(err, trans, subs)) +} - c.rmrSend("SubReq(SubReq timer) to E2T", subs, trans, trans.Payload, trans.PayloadLen) +//------------------------------------------------------------------- +// handle from XAPP Subscription Delete Request +//------------------------------------------------------------------ +func (c *Control) handleXAPPSubscriptionDeleteRequest(params *xapp.RMRParams) { + xapp.Logger.Debug("MSG from XAPP: %s", params.String()) + c.UpdateCounter(cSubDelReqFromXapp) - tryCount++ - c.timerMap.StartTimer("RIC_SUB_REQ", int(subs.GetSubId()), subReqTime, tryCount, c.handleSubscriptionRequestTimer) + if c.e2IfState.IsE2ConnectionUp(¶ms.Meid.RanName) == false { + xapp.Logger.Error("No E2 connection for ranName %v", params.Meid.RanName) return } - // Delete CREATE transaction - trans.Release() - - // Create DELETE transaction (internal and no messages toward xapp) - deltrans, err := c.tracker.TrackTransaction(&trans.RmrEndpoint, - 12020, // RIC SUBSCRIPTION DELETE - trans.GetXid(), - trans.GetMeid(), - false, - false) - + subDelReqMsg, err := c.e2ap.UnpackSubscriptionDeleteRequest(params.Payload) if err != nil { - xapp.Logger.Error("SubReq timeout: %s, Dropping this msg.", err.Error()) - //TODO improve error handling. Important at least in merge - c.registry.DelSubscription(subs.GetSubId()) + xapp.Logger.Error("XAPP-SubDelReq %s", idstring(err, params)) return } - deltrans.SubDelReqMsg = &e2ap.E2APSubscriptionDeleteRequest{} - deltrans.SubDelReqMsg.RequestId.Id = trans.SubReqMsg.RequestId.Id - deltrans.SubDelReqMsg.RequestId.Seq = uint32(subs.GetSubId()) - deltrans.SubDelReqMsg.FunctionId = trans.SubReqMsg.FunctionId - packedData, err := c.e2ap.PackSubscriptionDeleteRequest(deltrans.SubDelReqMsg) - if err != nil { - xapp.Logger.Error("SubReq timeout: Packing SubDelReq failed. Err: %v", err) - //TODO improve error handling. Important at least in merge - deltrans.Release() - c.registry.DelSubscription(subs.GetSubId()) + trans := c.tracker.NewXappTransaction(xapp.NewRmrEndpoint(params.Src), params.Xid, subDelReqMsg.RequestId, params.Meid) + if trans == nil { + xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(fmt.Errorf("transaction not created"), params)) return } - deltrans.PayloadLen = len(packedData.Buf) - deltrans.Payload = packedData.Buf + defer trans.Release() - err = subs.SetTransaction(deltrans) + err = c.tracker.Track(trans) if err != nil { - xapp.Logger.Error("SubReq timeout: %s, Dropping this msg.", err.Error()) - //TODO improve error handling. Important at least in merge - deltrans.Release() + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) return } - c.rmrSend("SubDelReq(SubReq timer) to E2T", subs, deltrans, deltrans.Payload, deltrans.PayloadLen) - - c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId()), subDelReqTime, FirstTry, c.handleSubscriptionDeleteRequestTimer) - return -} - -func (c *Control) handleSubscriptionDeleteRequest(params *RMRParams) { - xapp.Logger.Info("SubDelReq from xapp: %s", params.String()) - - // - // - // - trans, err := c.tracker.TrackTransaction(NewRmrEndpoint(params.Src), - params.Mtype, - params.Xid, - params.Meid, - false, - true) - + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{trans.GetSubId()}) if err != nil { - xapp.Logger.Error("SubDelReq: %s, Dropping this msg. %s", err.Error(), params.String()) + xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(err, trans)) return } // + // Wake subs delete // - // - trans.SubDelReqMsg, err = c.e2ap.UnpackSubscriptionDeleteRequest(params.Payload) - if err != nil { - xapp.Logger.Error("SubDelReq: %s Dropping this msg. %s", err.Error(), trans) - trans.Release() + subs.OngoingDelCount++ + go c.handleSubscriptionDelete(subs, trans, waitRouteCleanup_ms) + trans.WaitEvent(0) //blocked wait as timeout is handled in subs side + subs.OngoingDelCount-- + + xapp.Logger.Debug("XAPP-SubDelReq: Handling event %s ", idstring(nil, trans, subs)) + + if subs.NoRespToXapp == true { + // Do no send delete responses to xapps due to submgr restart is deleting uncompleted subscriptions + xapp.Logger.Debug("XAPP-SubDelReq: subs.NoRespToXapp == true") return } - // - // - // - subs := c.registry.GetSubscription(uint16(trans.SubDelReqMsg.RequestId.Seq)) - if subs == nil && params.SubId > 0 { - subs = c.registry.GetSubscription(uint16(params.SubId)) + // Whatever is received success, fail or timeout, send successful delete response + subDelRespMsg := &e2ap.E2APSubscriptionDeleteResponse{} + subDelRespMsg.RequestId.Id = trans.RequestId.Id + subDelRespMsg.RequestId.InstanceId = subs.GetReqId().RequestId.InstanceId + subDelRespMsg.FunctionId = subs.SubReqMsg.FunctionId + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionDeleteResponse(subDelRespMsg) + if err == nil { + c.UpdateCounter(cSubDelRespToXapp) + c.rmrSendToXapp("", subs, trans) } +} - if subs == nil { - xapp.Logger.Error("SubDelReq: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", trans.SubDelReqMsg.RequestId.Seq, params.SubId, trans) - trans.Release() - return +//------------------------------------------------------------------- +// SUBS CREATE Handling +//------------------------------------------------------------------- +func (c *Control) handleSubscriptionCreate(subs *Subscription, parentTrans *TransactionXapp, e2SubscriptionDirectives *E2SubscriptionDirectives, waitRouteCleanupTime time.Duration) { + + var event interface{} = nil + var removeSubscriptionFromDb bool = false + trans := c.tracker.NewSubsTransaction(subs) + subs.WaitTransactionTurn(trans) + defer subs.ReleaseTransactionTurn(trans) + defer trans.Release() + + xapp.Logger.Debug("SUBS-SubReq: Handling %s ", idstring(nil, trans, subs, parentTrans)) + + subRfMsg, valid := subs.GetCachedResponse() + if subRfMsg == nil && valid == true { + event = c.sendE2TSubscriptionRequest(subs, trans, parentTrans, e2SubscriptionDirectives) + switch event.(type) { + case *e2ap.E2APSubscriptionResponse: + subRfMsg, valid = subs.SetCachedResponse(event, true) + subs.SubRespRcvd = true + case *e2ap.E2APSubscriptionFailure: + subRfMsg, valid = subs.SetCachedResponse(event, false) + xapp.Logger.Debug("SUBS-SubReq: internal delete due failure event(%s) %s", typeofSubsMessage(event), idstring(nil, trans, subs, parentTrans)) + case *SubmgrRestartTestEvent: + // This is used to simulate that no response has been received and after restart, subscriptions are restored from db + xapp.Logger.Debug("Test restart flag is active. Dropping this transaction to test restart case") + subRfMsg, valid = subs.SetCachedResponse(event, false) + parentTrans.SendEvent(subRfMsg, 0) + return + case *PackSubscriptionRequestErrortEvent, *SDLWriteErrortEvent: + subRfMsg, valid = subs.SetCachedResponse(event, false) + default: + // Timer expiry + if subs.PolicyUpdate == false { + xapp.Logger.Debug("SUBS-SubReq: internal delete due default event(%s) %s", typeofSubsMessage(event), idstring(nil, trans, subs, parentTrans)) + subRfMsg, valid = subs.SetCachedResponse(nil, false) + c.sendE2TSubscriptionDeleteRequest(subs, trans, parentTrans) + } else { + subRfMsg, valid = subs.SetCachedResponse(nil, true) + } + } + xapp.Logger.Debug("SUBS-SubReq: Handling (e2t response %s) %s", typeofSubsMessage(subRfMsg), idstring(nil, trans, subs, parentTrans)) + } else { + xapp.Logger.Debug("SUBS-SubReq: Handling (cached response %s) %s", typeofSubsMessage(subRfMsg), idstring(nil, trans, subs, parentTrans)) + } + if valid == false { + removeSubscriptionFromDb = true } - xapp.Logger.Info("SubDelReq: subscription found payloadSeqNum: %d, SubId: %d. %s", trans.SubDelReqMsg.RequestId.Seq, params.SubId, trans) - err = subs.SetTransaction(trans) + err := c.UpdateSubscriptionInDB(subs, removeSubscriptionFromDb) if err != nil { - xapp.Logger.Error("SubDelReq: %s, Dropping this msg. %s", err.Error(), trans) - trans.Release() - return + valid = false + c.sendE2TSubscriptionDeleteRequest(subs, trans, parentTrans) } - // - // TODO: subscription delete is in fact owned by subscription and not transaction. - // Transaction is toward xapp while Subscription is toward ran. - // In merge several xapps may wake transactions, while only one subscription - // toward ran occurs -> subscription owns subscription creation toward ran - // - // This is intermediate solution while improving message handling - // - packedData, err := c.e2ap.PackSubscriptionDeleteRequest(trans.SubDelReqMsg) + // Now RemoveFromSubscription in here to avoid race conditions (mostly concerns delete) + if valid == false { + c.registry.RemoveFromSubscription(subs, parentTrans, waitRouteCleanupTime, c) + } + + parentTrans.SendEvent(subRfMsg, 0) +} + +//------------------------------------------------------------------- +// SUBS DELETE Handling +//------------------------------------------------------------------- + +func (c *Control) handleSubscriptionDelete(subs *Subscription, parentTrans *TransactionXapp, waitRouteCleanupTime time.Duration) { + + trans := c.tracker.NewSubsTransaction(subs) + subs.WaitTransactionTurn(trans) + defer subs.ReleaseTransactionTurn(trans) + defer trans.Release() + + xapp.Logger.Debug("SUBS-SubDelReq: Handling %s", idstring(nil, trans, subs, parentTrans)) + + subs.mutex.Lock() + + if subs.valid && subs.EpList.HasEndpoint(parentTrans.GetEndpoint()) && subs.EpList.Size() == 1 { + subs.valid = false + subs.mutex.Unlock() + c.sendE2TSubscriptionDeleteRequest(subs, trans, parentTrans) + } else { + subs.mutex.Unlock() + } + + // Now RemoveFromSubscription in here to avoid race conditions (mostly concerns delete) + c.registry.RemoveFromSubscription(subs, parentTrans, waitRouteCleanupTime, c) + parentTrans.SendEvent(nil, 0) +} + +//------------------------------------------------------------------- +// send to E2T Subscription Request +//------------------------------------------------------------------- +func (c *Control) sendE2TSubscriptionRequest(subs *Subscription, trans *TransactionSubs, parentTrans *TransactionXapp, e2SubscriptionDirectives *E2SubscriptionDirectives) interface{} { + var err error + var event interface{} = nil + var timedOut bool = false + const ricRequestorId = 123 + + subReqMsg := subs.SubReqMsg + subReqMsg.RequestId = subs.GetReqId().RequestId + subReqMsg.RequestId.Id = ricRequestorId + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionRequest(subReqMsg) if err != nil { - xapp.Logger.Error("SubDelReq: %s for trans %s", err.Error(), trans) - trans.Release() - return + xapp.Logger.Error("SUBS-SubReq ASN1 pack error: %s", idstring(err, trans, subs, parentTrans)) + return &PackSubscriptionRequestErrortEvent{ + ErrorInfo{ + ErrorSource: models.SubscriptionInstanceErrorSourceASN1, + ErrorCause: err.Error(), + }, + } } - //Optimize and store packed message to be sent (for retransmission). Again owned by subscription? - trans.Payload = packedData.Buf - trans.PayloadLen = len(packedData.Buf) + // Write uncompleted subscrition in db. If no response for subscrition it need to be re-processed (deleted) after restart + err = c.WriteSubscriptionToDb(subs) + if err != nil { + return &SDLWriteErrortEvent{ + ErrorInfo{ + ErrorSource: models.SubscriptionInstanceErrorSourceDBAAS, + ErrorCause: err.Error(), + }, + } + } - subs.UnConfirmed() + for retries := int64(0); retries < e2SubscriptionDirectives.E2MaxTryCount; retries++ { + desc := fmt.Sprintf("(retry %d)", retries) + if retries == 0 { + c.UpdateCounter(cSubReqToE2) + } else { + c.UpdateCounter(cSubReReqToE2) + } + c.rmrSendToE2T(desc, subs, trans) + if subs.DoNotWaitSubResp == false { + event, timedOut = trans.WaitEvent(e2SubscriptionDirectives.E2TimeoutTimerValue) + if timedOut { + c.UpdateCounter(cSubReqTimerExpiry) + continue + } + } else { + // Simulating case where subscrition request has been sent but response has not been received before restart + event = &SubmgrRestartTestEvent{} + xapp.Logger.Debug("Restart event, DoNotWaitSubResp == true") + } + break + } + xapp.Logger.Debug("SUBS-SubReq: Response handling event(%s) %s", typeofSubsMessage(event), idstring(nil, trans, subs, parentTrans)) + return event +} - c.rmrSend("SubDelReq to E2T", subs, trans, trans.Payload, trans.PayloadLen) +//------------------------------------------------------------------- +// send to E2T Subscription Delete Request +//------------------------------------------------------------------- + +func (c *Control) sendE2TSubscriptionDeleteRequest(subs *Subscription, trans *TransactionSubs, parentTrans *TransactionXapp) interface{} { + var err error + var event interface{} + var timedOut bool + const ricRequestorId = 123 + + subDelReqMsg := &e2ap.E2APSubscriptionDeleteRequest{} + subDelReqMsg.RequestId = subs.GetReqId().RequestId + subDelReqMsg.RequestId.Id = ricRequestorId + subDelReqMsg.FunctionId = subs.SubReqMsg.FunctionId + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionDeleteRequest(subDelReqMsg) + if err != nil { + xapp.Logger.Error("SUBS-SubDelReq: %s", idstring(err, trans, subs, parentTrans)) + return event + } - c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId()), subDelReqTime, FirstTry, c.handleSubscriptionDeleteRequestTimer) - return + for retries := uint64(0); retries < e2tMaxSubDelReqTryCount; retries++ { + desc := fmt.Sprintf("(retry %d)", retries) + if retries == 0 { + c.UpdateCounter(cSubDelReqToE2) + } else { + c.UpdateCounter(cSubDelReReqToE2) + } + c.rmrSendToE2T(desc, subs, trans) + event, timedOut = trans.WaitEvent(e2tSubDelReqTime) + if timedOut { + c.UpdateCounter(cSubDelReqTimerExpiry) + continue + } + break + } + xapp.Logger.Debug("SUBS-SubDelReq: Response handling event(%s) %s", typeofSubsMessage(event), idstring(nil, trans, subs, parentTrans)) + return event } -func (c *Control) handleSubscriptionDeleteResponse(params *RMRParams) (err error) { - xapp.Logger.Info("SubDelResp from E2T:%s", params.String()) +//------------------------------------------------------------------- +// handle from E2T Subscription Response +//------------------------------------------------------------------- +func (c *Control) handleE2TSubscriptionResponse(params *xapp.RMRParams) { + xapp.Logger.Debug("MSG from E2T: %s", params.String()) + c.UpdateCounter(cSubRespFromE2) - payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteResponseSequenceNumber(params.Payload) + subRespMsg, err := c.e2ap.UnpackSubscriptionResponse(params.Payload) if err != nil { - xapp.Logger.Error("SubDelResp: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload) + xapp.Logger.Error("MSG-SubResp %s", idstring(err, params)) return } - xapp.Logger.Info("SubDelResp: Received payloadSeqNum: %v", payloadSeqNum) - - subs := c.registry.GetSubscription(payloadSeqNum) - if subs == nil { - xapp.Logger.Error("SubDelResp: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subRespMsg.RequestId.InstanceId}) + if err != nil { + xapp.Logger.Error("MSG-SubResp: %s", idstring(err, params)) return } - trans := subs.GetTransaction() if trans == nil { - xapp.Logger.Error("SubDelResp: Unknown trans. Dropping this msg. PayloadSeqNum: %v, SubId: %v", subs.GetSubId(), params.SubId) + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubResp: %s", idstring(err, params, subs)) return } + xapp.Logger.Debug("SUBS-SubResp: Sending event, trans= %v", trans) + sendOk, timedOut := trans.SendEvent(subRespMsg, e2tRecvMsgTimeout) + if sendOk == false { + err = fmt.Errorf("Passing event to transaction failed: sendOk(%t) timedOut(%t)", sendOk, timedOut) + xapp.Logger.Error("MSG-SubResp: %s", idstring(err, trans, subs)) + } + return +} - c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId())) - - responseReceived := trans.CheckResponseReceived() - if responseReceived == true { - // Subscription Delete timer already received +//------------------------------------------------------------------- +// handle from E2T Subscription Failure +//------------------------------------------------------------------- +func (c *Control) handleE2TSubscriptionFailure(params *xapp.RMRParams) { + xapp.Logger.Debug("MSG from E2T: %s", params.String()) + c.UpdateCounter(cSubFailFromE2) + subFailMsg, err := c.e2ap.UnpackSubscriptionFailure(params.Payload) + if err != nil { + xapp.Logger.Error("MSG-SubFail %s", idstring(err, params)) return } - - trans.Release() - - if trans.ForwardRespToXapp == true { - c.rmrReplyToSender("SubDelResp to xapp", subs, trans, params.Mtype, params.Payload, params.PayloadLen) - time.Sleep(3 * time.Second) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subFailMsg.RequestId.InstanceId}) + if err != nil { + xapp.Logger.Error("MSG-SubFail: %s", idstring(err, params)) + return } - - xapp.Logger.Info("SubDelResp: Deleting trans record. SubId: %v, Xid: %s", subs.GetSubId(), trans.GetXid()) - if !c.registry.DelSubscription(subs.GetSubId()) { - xapp.Logger.Error("SubDelResp: Failed to release sequency number. SubId: %v, Xid: %s", subs.GetSubId(), trans.GetXid()) + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubFail: %s", idstring(err, params, subs)) return } + sendOk, timedOut := trans.SendEvent(subFailMsg, e2tRecvMsgTimeout) + if sendOk == false { + err = fmt.Errorf("Passing event to transaction failed: sendOk(%t) timedOut(%t)", sendOk, timedOut) + xapp.Logger.Error("MSG-SubFail: %s", idstring(err, trans, subs)) + } return } -func (c *Control) handleSubscriptionDeleteFailure(params *RMRParams) { - xapp.Logger.Info("SubDelFail from E2T:%s", params.String()) - - payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteFailureSequenceNumber(params.Payload) +//------------------------------------------------------------------- +// handle from E2T Subscription Delete Response +//------------------------------------------------------------------- +func (c *Control) handleE2TSubscriptionDeleteResponse(params *xapp.RMRParams) (err error) { + xapp.Logger.Debug("MSG from E2T: %s", params.String()) + c.UpdateCounter(cSubDelRespFromE2) + subDelRespMsg, err := c.e2ap.UnpackSubscriptionDeleteResponse(params.Payload) if err != nil { - xapp.Logger.Error("SubDelFail: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, %s", err, params.String()) + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params)) return } - xapp.Logger.Info("SubDelFail: Received payloadSeqNum: %v", payloadSeqNum) - - subs := c.registry.GetSubscription(payloadSeqNum) - if subs == nil { - xapp.Logger.Error("SubDelFail: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelRespMsg.RequestId.InstanceId}) + if err != nil { + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params)) return } - trans := subs.GetTransaction() if trans == nil { - xapp.Logger.Error("SubDelFail: Unknown trans. Dropping this msg. PayloadSeqNum: %v, SubId: %v", subs.GetSubId(), params.SubId) + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params, subs)) return } + sendOk, timedOut := trans.SendEvent(subDelRespMsg, e2tRecvMsgTimeout) + if sendOk == false { + err = fmt.Errorf("Passing event to transaction failed: sendOk(%t) timedOut(%t)", sendOk, timedOut) + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, trans, subs)) + } + return +} - c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId())) - - responseReceived := trans.CheckResponseReceived() - if responseReceived == true { - // Subscription Delete timer already received +//------------------------------------------------------------------- +// handle from E2T Subscription Delete Failure +//------------------------------------------------------------------- +func (c *Control) handleE2TSubscriptionDeleteFailure(params *xapp.RMRParams) { + xapp.Logger.Debug("MSG from E2T: %s", params.String()) + c.UpdateCounter(cSubDelFailFromE2) + subDelFailMsg, err := c.e2ap.UnpackSubscriptionDeleteFailure(params.Payload) + if err != nil { + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params)) return } - if trans.ForwardRespToXapp == true { - var subDelRespPayload []byte - subDelRespPayload, err = c.e2ap.PackSubscriptionDeleteResponseFromSubDelReq(trans.Payload, subs.GetSubId()) - if err != nil { - xapp.Logger.Error("SubDelFail:Packing SubDelResp failed. Err: %v", err) - return - } - - // RIC SUBSCRIPTION DELETE RESPONSE - c.rmrReplyToSender("SubDelFail to xapp", subs, trans, 12021, subDelRespPayload, len(subDelRespPayload)) - time.Sleep(3 * time.Second) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelFailMsg.RequestId.InstanceId}) + if err != nil { + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params)) + return } - - xapp.Logger.Info("SubDelFail: Deleting trans record. SubId: %v, Xid: %s", subs.GetSubId(), trans.GetXid()) - trans.Release() - if !c.registry.DelSubscription(subs.GetSubId()) { - xapp.Logger.Error("SubDelFail: Failed to release sequency number. Err: %v, SubId: %v, Xid: %s", err, subs.GetSubId(), trans.GetXid()) + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params, subs)) return } + sendOk, timedOut := trans.SendEvent(subDelFailMsg, e2tRecvMsgTimeout) + if sendOk == false { + err = fmt.Errorf("Passing event to transaction failed: sendOk(%t) timedOut(%t)", sendOk, timedOut) + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, trans, subs)) + } return } -func (c *Control) handleSubscriptionDeleteRequestTimer(strId string, nbrId int, tryCount uint64) { - xapp.Logger.Info("SubDelReq timeout: subId: %v, tryCount: %v", nbrId, tryCount) +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func typeofSubsMessage(v interface{}) string { + if v == nil { + return "NIL" + } + switch v.(type) { + //case *e2ap.E2APSubscriptionRequest: + // return "SubReq" + case *e2ap.E2APSubscriptionResponse: + return "SubResp" + case *e2ap.E2APSubscriptionFailure: + return "SubFail" + //case *e2ap.E2APSubscriptionDeleteRequest: + // return "SubDelReq" + case *e2ap.E2APSubscriptionDeleteResponse: + return "SubDelResp" + case *e2ap.E2APSubscriptionDeleteFailure: + return "SubDelFail" + default: + return "Unknown" + } +} + +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) WriteSubscriptionToDb(subs *Subscription) error { + xapp.Logger.Debug("WriteSubscriptionToDb() subId = %v", subs.ReqId.InstanceId) + err := c.WriteSubscriptionToSdl(subs.ReqId.InstanceId, subs) + if err != nil { + xapp.Logger.Error("%v", err) + return err + } + return nil +} - subs := c.registry.GetSubscription(uint16(nbrId)) - if subs == nil { - xapp.Logger.Error("SubDelReq timeout: Unknown payloadSeqNum. Dropping this msg. SubId: %v", nbrId) - return +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) UpdateSubscriptionInDB(subs *Subscription, removeSubscriptionFromDb bool) error { + + if removeSubscriptionFromDb == true { + // Subscription was written in db already when subscription request was sent to BTS, except for merged request + c.RemoveSubscriptionFromDb(subs) + } else { + // Update is needed for successful response and merge case here + if subs.RetryFromXapp == false { + err := c.WriteSubscriptionToDb(subs) + return err + } } + subs.RetryFromXapp = false + return nil +} - trans := subs.GetTransaction() - if trans == nil { - xapp.Logger.Error("SubDelReq timeout: Unknown trans. Dropping this msg. SubId: %v", subs.GetSubId()) - return +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) RemoveSubscriptionFromDb(subs *Subscription) { + xapp.Logger.Debug("RemoveSubscriptionFromDb() subId = %v", subs.ReqId.InstanceId) + err := c.RemoveSubscriptionFromSdl(subs.ReqId.InstanceId) + if err != nil { + xapp.Logger.Error("%v", err) } +} - responseReceived := trans.CheckResponseReceived() - if responseReceived == true { - // Subscription Delete Response or Failure already received - return +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) WriteRESTSubscriptionToDb(restSubId string, restSubs *RESTSubscription) { + xapp.Logger.Debug("WriteRESTSubscriptionToDb() restSubId = %s", restSubId) + err := c.WriteRESTSubscriptionToSdl(restSubId, restSubs) + if err != nil { + xapp.Logger.Error("%v", err) } +} - if tryCount < maxSubDelReqTryCount { - xapp.Logger.Info("SubDelReq timeout: Resending SubDelReq to E2T: Mtype: %v, SubId: %v, Xid %s, Meid %v", trans.GetMtype(), subs.GetSubId(), trans.GetXid(), trans.GetMeid()) - // Set possible to handle new response for the subId +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) UpdateRESTSubscriptionInDB(restSubId string, restSubs *RESTSubscription, removeRestSubscriptionFromDb bool) { + + if removeRestSubscriptionFromDb == true { + // Subscription was written in db already when subscription request was sent to BTS, except for merged request + c.RemoveRESTSubscriptionFromDb(restSubId) + } else { + c.WriteRESTSubscriptionToDb(restSubId, restSubs) + } +} - trans.RetryTransaction() +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) RemoveRESTSubscriptionFromDb(restSubId string) { + xapp.Logger.Debug("RemoveRESTSubscriptionFromDb() restSubId = %s", restSubId) + err := c.RemoveRESTSubscriptionFromSdl(restSubId) + if err != nil { + xapp.Logger.Error("%v", err) + } +} - c.rmrSend("SubDelReq(SubDelReq timer) to E2T", subs, trans, trans.Payload, trans.PayloadLen) +func (c *Control) SendSubscriptionDeleteReq(subs *Subscription) { - tryCount++ - c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId()), subReqTime, tryCount, c.handleSubscriptionDeleteRequestTimer) - return + if c.UTTesting == true { + // Reqistry mutex is not locked after real restart but it can be when restart is simulated in unit tests + c.registry.mutex = new(sync.Mutex) } - if trans.ForwardRespToXapp == true { - var subDelRespPayload []byte - subDelRespPayload, err := c.e2ap.PackSubscriptionDeleteResponseFromSubDelReq(trans.Payload, subs.GetSubId()) + const ricRequestorId = 123 + xapp.Logger.Debug("Sending subscription delete due to restart. subId = %v", subs.ReqId.InstanceId) + + // Send delete for every endpoint in the subscription + if subs.PolicyUpdate == false { + subDelReqMsg := &e2ap.E2APSubscriptionDeleteRequest{} + subDelReqMsg.RequestId = subs.GetReqId().RequestId + subDelReqMsg.RequestId.Id = ricRequestorId + subDelReqMsg.FunctionId = subs.SubReqMsg.FunctionId + mType, payload, err := c.e2ap.PackSubscriptionDeleteRequest(subDelReqMsg) if err != nil { - xapp.Logger.Error("SubDelReq timeout: Unable to pack payload. Dropping this this msg. Err: %v, SubId: %v, Xid: %s, Payload %x", err, subs.GetSubId(), trans.GetXid(), trans.Payload) + xapp.Logger.Error("SendSubscriptionDeleteReq() %s", idstring(err)) return } + for _, endPoint := range subs.EpList.Endpoints { + params := &xapp.RMRParams{} + params.Mtype = mType + params.SubId = int(subs.GetReqId().InstanceId) + params.Xid = "" + params.Meid = subs.Meid + params.Src = endPoint.String() + params.PayloadLen = len(payload.Buf) + params.Payload = payload.Buf + params.Mbuf = nil + subs.DeleteFromDb = true + c.handleXAPPSubscriptionDeleteRequest(params) + } + } +} - // RIC SUBSCRIPTION DELETE RESPONSE - c.rmrReplyToSender("SubDelResp(SubDelReq timer) to xapp", subs, trans, 12021, subDelRespPayload, len(subDelRespPayload)) +func (c *Control) PrintRESTSubscriptionRequest(p *models.SubscriptionParams) { - time.Sleep(3 * time.Second) + fmt.Println("CRESTSubscriptionRequest") + if p == nil { + return } - xapp.Logger.Info("SubDelReq timeout: Deleting trans record. SubId: %v, Xid: %s", subs.GetSubId(), trans.GetXid()) - trans.Release() - if !c.registry.DelSubscription(subs.GetSubId()) { - xapp.Logger.Error("SubDelReq timeout: Failed to release sequency number. SubId: %v, Xid: %s", subs.GetSubId(), trans.GetXid()) + if p.SubscriptionID != "" { + fmt.Println(" SubscriptionID = ", p.SubscriptionID) + } else { + fmt.Println(" SubscriptionID = ''") + } + + fmt.Printf(" ClientEndpoint.Host = %s\n", p.ClientEndpoint.Host) + + if p.ClientEndpoint.HTTPPort != nil { + fmt.Printf(" ClientEndpoint.HTTPPort = %v\n", *p.ClientEndpoint.HTTPPort) + } else { + fmt.Println(" ClientEndpoint.HTTPPort = nil") + } + + if p.ClientEndpoint.RMRPort != nil { + fmt.Printf(" ClientEndpoint.RMRPort = %v\n", *p.ClientEndpoint.RMRPort) + } else { + fmt.Println(" ClientEndpoint.RMRPort = nil") + } + + if p.Meid != nil { + fmt.Printf(" Meid = %s\n", *p.Meid) + } else { + fmt.Println(" Meid = nil") + } + + if p.E2SubscriptionDirectives == nil { + fmt.Println(" E2SubscriptionDirectives = nil") + } else { + fmt.Println(" E2SubscriptionDirectives") + if p.E2SubscriptionDirectives.E2RetryCount == nil { + fmt.Println(" E2RetryCount == nil") + } else { + fmt.Printf(" E2RetryCount = %v\n", *p.E2SubscriptionDirectives.E2RetryCount) + } + fmt.Printf(" E2TimeoutTimerValue = %v\n", p.E2SubscriptionDirectives.E2TimeoutTimerValue) + fmt.Printf(" RMRRoutingNeeded = %v\n", p.E2SubscriptionDirectives.RMRRoutingNeeded) + } + for _, subscriptionDetail := range p.SubscriptionDetails { + if p.RANFunctionID != nil { + fmt.Printf(" RANFunctionID = %v\n", *p.RANFunctionID) + } else { + fmt.Println(" RANFunctionID = nil") + } + fmt.Printf(" SubscriptionDetail.XappEventInstanceID = %v\n", *subscriptionDetail.XappEventInstanceID) + fmt.Printf(" SubscriptionDetail.EventTriggers = %v\n", subscriptionDetail.EventTriggers) + + for _, actionToBeSetup := range subscriptionDetail.ActionToBeSetupList { + fmt.Printf(" SubscriptionDetail.ActionToBeSetup.ActionID = %v\n", *actionToBeSetup.ActionID) + fmt.Printf(" SubscriptionDetail.ActionToBeSetup.ActionType = %s\n", *actionToBeSetup.ActionType) + fmt.Printf(" SubscriptionDetail.ActionToBeSetup.ActionDefinition = %v\n", actionToBeSetup.ActionDefinition) + + if actionToBeSetup.SubsequentAction != nil { + fmt.Printf(" SubscriptionDetail.ActionToBeSetup.SubsequentAction.SubsequentActionType = %s\n", *actionToBeSetup.SubsequentAction.SubsequentActionType) + fmt.Printf(" SubscriptionDetail.ActionToBeSetup..SubsequentAction.TimeToWait = %s\n", *actionToBeSetup.SubsequentAction.TimeToWait) + } else { + fmt.Println(" SubscriptionDetail.ActionToBeSetup.SubsequentAction = nil") + } + } } - return }