X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=pkg%2Fcontrol%2Fregistry.go;h=29d82a9220447caadcd708d26ce87d86175cb5bb;hb=refs%2Fchanges%2F94%2F7494%2F1;hp=eae870df2419985ba6390c04da0eadab84ab4951;hpb=316d8a176feac5e67dcaa360c0f5996e87b32904;p=ric-plt%2Fsubmgr.git diff --git a/pkg/control/registry.go b/pkg/control/registry.go index eae870d..29d82a9 100644 --- a/pkg/control/registry.go +++ b/pkg/control/registry.go @@ -20,7 +20,9 @@ package control import ( + "encoding/json" "fmt" + "strings" "sync" "time" @@ -34,27 +36,62 @@ import ( //----------------------------------------------------------------------------- type RESTSubscription struct { + Created string + xAppServiceName string xAppRmrEndPoint string Meid string InstanceIds []uint32 + xAppIdToE2Id map[int64]int64 SubReqOngoing bool SubDelReqOngoing bool + lastReqMd5sum string } -func (r *RESTSubscription) AddInstanceId(instanceId uint32) { +func (r *RESTSubscription) AddE2InstanceId(instanceId uint32) { + + for _, v := range r.InstanceIds { + if v == instanceId { + return + } + + } + r.InstanceIds = append(r.InstanceIds, instanceId) } -func (r *RESTSubscription) SetProcessed() { - r.SubReqOngoing = false +func (r *RESTSubscription) AddMd5Sum(md5sum string) { + if md5sum != "" { + r.lastReqMd5sum = md5sum + } else { + xapp.Logger.Error("EMPTY md5sum attempted to be add to subscrition") + } } -func (r *RESTSubscription) DeleteInstanceId(instanceId uint32) { +func (r *RESTSubscription) DeleteE2InstanceId(instanceId uint32) { r.InstanceIds = r.InstanceIds[1:] } +func (r *RESTSubscription) AddXappIdToE2Id(xAppEventInstanceID int64, e2EventInstanceID int64) { + r.xAppIdToE2Id[xAppEventInstanceID] = e2EventInstanceID +} + +func (r *RESTSubscription) GetE2IdFromXappIdToE2Id(xAppEventInstanceID int64) int64 { + return r.xAppIdToE2Id[xAppEventInstanceID] +} + +func (r *RESTSubscription) DeleteXappIdToE2Id(xAppEventInstanceID int64) { + delete(r.xAppIdToE2Id, xAppEventInstanceID) +} + +func (r *RESTSubscription) SetProcessed(err error) { + r.SubReqOngoing = false + if err != nil { + r.lastReqMd5sum = "" + } +} + type Registry struct { - mutex sync.Mutex + mutex *sync.Mutex register map[uint32]*Subscription subIds []uint32 rtmgrClient *RtmgrClient @@ -62,6 +99,7 @@ type Registry struct { } func (r *Registry) Initialize() { + r.mutex = new(sync.Mutex) r.register = make(map[uint32]*Subscription) r.restSubscriptions = make(map[string]*RESTSubscription) @@ -71,39 +109,163 @@ func (r *Registry) Initialize() { } } -func (r *Registry) CreateRESTSubscription(restSubId *string, xAppRmrEndPoint *string, maid *string) (*RESTSubscription, error) { +func (r *Registry) GetAllRestSubscriptionsJson() []byte { + + r.mutex.Lock() + defer r.mutex.Unlock() + restSubscriptionsJson, err := json.Marshal(r.restSubscriptions) + if err != nil { + xapp.Logger.Error("GetAllRestSubscriptions() json.Marshal error: %v", err) + } + return restSubscriptionsJson +} + +func (r *Registry) GetAllE2NodeRestSubscriptionsJson(ranName string) []byte { + + restSubscriptions := r.GetAllE2NodeRestSubscriptions(ranName) + e2NodeRestSubscriptionsJson, err := json.Marshal(restSubscriptions) + if err != nil { + xapp.Logger.Error("GetE2NodeRestSubscriptions() json.Marshal error: %v", err) + } + return e2NodeRestSubscriptionsJson +} + +func (r *Registry) GetAllE2NodeRestSubscriptions(ranName string) map[string]RESTSubscription { + + r.mutex.Lock() + defer r.mutex.Unlock() + var restSubscriptions map[string]RESTSubscription + restSubscriptions = make(map[string]RESTSubscription) + for restSubsId, restSubscription := range r.restSubscriptions { + if restSubscription.Meid == ranName { + restSubscriptions[restSubsId] = *restSubscription + } + } + return restSubscriptions +} + +func (r *Registry) GetAllXappsJson() []byte { + + r.mutex.Lock() + var xappList []string + var xappsMap map[string]string + xappsMap = make(map[string]string) + for _, restSubscription := range r.restSubscriptions { + _, ok := xappsMap[restSubscription.xAppServiceName] + if !ok { + xappsMap[restSubscription.xAppServiceName] = restSubscription.xAppServiceName + xappList = append(xappList, restSubscription.xAppServiceName) + } + } + r.mutex.Unlock() + + xappsJson, err := json.Marshal(xappList) + if err != nil { + xapp.Logger.Error("GetXapps() json.Marshal error: %v", err) + } + return xappsJson +} + +func (r *Registry) GetAllXapps() map[string]string { + + r.mutex.Lock() + defer r.mutex.Unlock() + var xappsMap map[string]string + xappsMap = make(map[string]string) + for _, restSubscription := range r.restSubscriptions { + _, ok := xappsMap[restSubscription.xAppServiceName] + if !ok { + xappsMap[restSubscription.xAppServiceName] = restSubscription.xAppServiceName + } + } + return xappsMap +} + +func (r *Registry) GetAllXappRestSubscriptionsJson(xAppServiceName string) []byte { + + xappRestSubscriptions := r.GetAllXappRestSubscriptions(xAppServiceName) + xappRestSubscriptionsJson, err := json.Marshal(xappRestSubscriptions) + if err != nil { + xapp.Logger.Error("GetXappRestSubscriptions() json.Marshal error: %v", err) + } + return xappRestSubscriptionsJson +} + +func (r *Registry) GetAllXappRestSubscriptions(xAppServiceName string) map[string]RESTSubscription { + + r.mutex.Lock() + defer r.mutex.Unlock() + var xappRestSubscriptions map[string]RESTSubscription + xappRestSubscriptions = make(map[string]RESTSubscription) + for restSubsId, xappRestSubscription := range r.restSubscriptions { + if xappRestSubscription.xAppServiceName == xAppServiceName { + xappRestSubscriptions[restSubsId] = *xappRestSubscription + } + } + return xappRestSubscriptions +} + +func (r *Registry) GetE2SubscriptionsJson(restSubsId string) ([]byte, error) { + + // Get all E2 subscriptions of a REST subscription + restSubs, err := r.GetRESTSubscription(restSubsId, false) + if err != nil { + return nil, err + } + + r.mutex.Lock() + var e2Subscriptions []Subscription + for _, e2SubId := range restSubs.InstanceIds { + e2Subscription, ok := r.register[e2SubId] + if ok { + e2Subscriptions = append(e2Subscriptions, *e2Subscription) + } + } + r.mutex.Unlock() + e2SubscriptionsJson, err := json.Marshal(e2Subscriptions) + if err != nil { + xapp.Logger.Error("GetE2Subscriptions() json.Marshal error: %v", err) + } + return e2SubscriptionsJson, nil +} + +func (r *Registry) CreateRESTSubscription(restSubId *string, xappServiceName *string, xAppRmrEndPoint *string, maid *string) *RESTSubscription { r.mutex.Lock() defer r.mutex.Unlock() newRestSubscription := RESTSubscription{} + newRestSubscription.Created = time.Now().Format("2006-01-02 15:04:05.000") + newRestSubscription.xAppServiceName = *xappServiceName newRestSubscription.xAppRmrEndPoint = *xAppRmrEndPoint newRestSubscription.Meid = *maid newRestSubscription.SubReqOngoing = true newRestSubscription.SubDelReqOngoing = false r.restSubscriptions[*restSubId] = &newRestSubscription - xapp.Logger.Info("Registry: Created REST subscription successfully. restSubId=%v, subscriptionCount=%v, e2apSubscriptionCount=%v", *restSubId, len(r.restSubscriptions), len(r.register)) - return &newRestSubscription, nil + newRestSubscription.xAppIdToE2Id = make(map[int64]int64) + xapp.Logger.Debug("Registry: Created REST subscription successfully. restSubId=%v, subscriptionCount=%v, e2apSubscriptionCount=%v", *restSubId, len(r.restSubscriptions), len(r.register)) + return &newRestSubscription } func (r *Registry) DeleteRESTSubscription(restSubId *string) { r.mutex.Lock() defer r.mutex.Unlock() delete(r.restSubscriptions, *restSubId) - xapp.Logger.Info("Registry: Deleted REST subscription successfully. restSubId=%v, subscriptionCount=%v", *restSubId, len(r.restSubscriptions)) + xapp.Logger.Debug("Registry: Deleted REST subscription successfully. restSubId=%v, subscriptionCount=%v", *restSubId, len(r.restSubscriptions)) } -func (r *Registry) GetRESTSubscription(restSubId string) (*RESTSubscription, error) { +func (r *Registry) GetRESTSubscription(restSubId string, IsDelReqOngoing bool) (*RESTSubscription, error) { r.mutex.Lock() defer r.mutex.Unlock() if restSubscription, ok := r.restSubscriptions[restSubId]; ok { // Subscription deletion is not allowed if prosessing subscription request in not ready if restSubscription.SubDelReqOngoing == false && restSubscription.SubReqOngoing == false { - restSubscription.SubDelReqOngoing = true + if IsDelReqOngoing == true { + restSubscription.SubDelReqOngoing = true + } r.restSubscriptions[restSubId] = restSubscription return restSubscription, nil } else { return restSubscription, fmt.Errorf("Registry: REST request is still ongoing for the endpoint=%v, restSubId=%v, SubDelReqOngoing=%v, SubReqOngoing=%v", restSubscription, restSubId, restSubscription.SubDelReqOngoing, restSubscription.SubReqOngoing) } - return restSubscription, nil } return nil, fmt.Errorf("Registry: No valid subscription found with restSubId=%v", restSubId) } @@ -121,7 +283,7 @@ func (r *Registry) QueryHandler() (models.SubscriptionList, error) { return resp, nil } -func (r *Registry) allocateSubs(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest, resetTestFlag bool) (*Subscription, error) { +func (r *Registry) allocateSubs(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest, resetTestFlag bool, rmrRoutecreated bool) (*Subscription, error) { if len(r.subIds) > 0 { subId := r.subIds[0] r.subIds = r.subIds[1:] @@ -132,19 +294,21 @@ func (r *Registry) allocateSubs(trans *TransactionXapp, subReqMsg *e2ap.E2APSubs subs := &Subscription{ registry: r, Meid: trans.Meid, + RMRRouteCreated: rmrRoutecreated, SubReqMsg: subReqMsg, + OngoingReqCount: 0, + OngoingDelCount: 0, valid: true, + PolicyUpdate: false, RetryFromXapp: false, SubRespRcvd: false, DeleteFromDb: false, NoRespToXapp: false, DoNotWaitSubResp: false, } - subs.ReqId.Id = 123 + subs.ReqId.Id = subReqMsg.RequestId.Id subs.ReqId.InstanceId = subId - if resetTestFlag == true { - subs.DoNotWaitSubResp = true - } + r.SetResetTestFlag(resetTestFlag, subs) if subs.EpList.AddEndpoint(trans.GetEndpoint()) == false { r.subIds = append(r.subIds, subs.ReqId.InstanceId) @@ -189,9 +353,10 @@ func (r *Registry) findExistingSubs(trans *TransactionXapp, subReqMsg *e2ap.E2AP return nil, false } -func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest, resetTestFlag bool, c *Control) (*Subscription, error) { +func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest, resetTestFlag bool, c *Control, createRMRRoute bool) (*Subscription, ErrorInfo, error) { var err error var newAlloc bool + errorInfo := ErrorInfo{} r.mutex.Lock() defer r.mutex.Unlock() @@ -201,7 +366,8 @@ func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap. actionType, err := r.CheckActionTypes(subReqMsg) if err != nil { xapp.Logger.Debug("CREATE %s", err) - return nil, err + err = fmt.Errorf("E2 content validation failed") + return nil, errorInfo, err } // @@ -212,15 +378,19 @@ func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap. xapp.Logger.Debug("CREATE %s. Existing subscription for Policy found.", subs.String()) // Update message data to subscription subs.SubReqMsg = subReqMsg + subs.PolicyUpdate = true subs.SetCachedResponse(nil, true) - return subs, nil + r.SetResetTestFlag(resetTestFlag, subs) + return subs, errorInfo, nil } } subs, endPointFound := r.findExistingSubs(trans, subReqMsg) if subs == nil { - if subs, err = r.allocateSubs(trans, subReqMsg, resetTestFlag); err != nil { - return nil, err + if subs, err = r.allocateSubs(trans, subReqMsg, resetTestFlag, createRMRRoute); err != nil { + xapp.Logger.Error("%s", err.Error()) + err = fmt.Errorf("subscription not allocated") + return nil, errorInfo, err } newAlloc = true } else if endPointFound == true { @@ -228,7 +398,7 @@ func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap. subs.RetryFromXapp = true xapp.Logger.Debug("CREATE subReqMsg.InstanceId=%v. Same subscription %s already exists.", subReqMsg.InstanceId, subs.String()) c.UpdateCounter(cDuplicateE2SubReq) - return subs, nil + return subs, errorInfo, nil } // @@ -238,16 +408,20 @@ func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap. defer subs.mutex.Unlock() epamount := subs.EpList.Size() - xapp.Logger.Info("AssignToSubscription subs.EpList.Size()=%v", subs.EpList.Size()) + xapp.Logger.Debug("AssignToSubscription subs.EpList.Size()=%v", subs.EpList.Size()) r.mutex.Unlock() // // Subscription route updates // - if epamount == 1 { - err = r.RouteCreate(subs, c) + if createRMRRoute == true { + if epamount == 1 { + errorInfo, err = r.RouteCreate(subs, c) + } else { + errorInfo, err = r.RouteCreateUpdate(subs, c) + } } else { - err = r.RouteCreateUpdate(subs, c) + xapp.Logger.Debug("RMR route not created: createRMRRoute=%v", createRMRRoute) } r.mutex.Lock() @@ -257,7 +431,7 @@ func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap. } // Delete already added endpoint for the request subs.EpList.DelEndpoint(trans.GetEndpoint()) - return nil, err + return nil, errorInfo, err } if newAlloc { @@ -265,27 +439,45 @@ func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap. } xapp.Logger.Debug("CREATE %s", subs.String()) xapp.Logger.Debug("Registry: substable=%v", r.register) - return subs, nil + return subs, errorInfo, nil } -func (r *Registry) RouteCreate(subs *Subscription, c *Control) error { +func (r *Registry) RouteCreate(subs *Subscription, c *Control) (ErrorInfo, error) { + errorInfo := ErrorInfo{} subRouteAction := SubRouteInfo{subs.EpList, uint16(subs.ReqId.InstanceId)} err := r.rtmgrClient.SubscriptionRequestCreate(subRouteAction) if err != nil { + if strings.Contains(err.Error(), "status 400") { + errorInfo.TimeoutType = models.SubscriptionInstanceTimeoutTypeRTMGRTimeout + } else { + errorInfo.ErrorSource = models.SubscriptionInstanceErrorSourceRTMGR + } + errorInfo.ErrorCause = err.Error() c.UpdateCounter(cRouteCreateFail) + xapp.Logger.Error("%s", err.Error()) + err = fmt.Errorf("RTMGR route create failure") } - return err + return errorInfo, err } -func (r *Registry) RouteCreateUpdate(subs *Subscription, c *Control) error { +func (r *Registry) RouteCreateUpdate(subs *Subscription, c *Control) (ErrorInfo, error) { + errorInfo := ErrorInfo{} subRouteAction := SubRouteInfo{subs.EpList, uint16(subs.ReqId.InstanceId)} err := r.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) if err != nil { + if strings.Contains(err.Error(), "status 400") { + errorInfo.TimeoutType = models.SubscriptionInstanceTimeoutTypeRTMGRTimeout + } else { + errorInfo.ErrorSource = models.SubscriptionInstanceErrorSourceRTMGR + } + errorInfo.ErrorCause = err.Error() c.UpdateCounter(cRouteCreateUpdateFail) - return err + xapp.Logger.Error("%s", err.Error()) + err = fmt.Errorf("RTMGR route update failure") + return errorInfo, err } c.UpdateCounter(cMergedSubscriptions) - return err + return errorInfo, err } func (r *Registry) CheckActionTypes(subReqMsg *e2ap.E2APSubscriptionRequest) (uint64, error) { @@ -319,9 +511,9 @@ func (r *Registry) CheckActionTypes(subReqMsg *e2ap.E2APSubscriptionRequest) (ui return e2ap.E2AP_ActionTypeInvalid, fmt.Errorf("Invalid action type in RICactions-ToBeSetup-List") } -// TODO: Works with concurrent calls, but check if can be improved func (r *Registry) RemoveFromSubscription(subs *Subscription, trans *TransactionXapp, waitRouteClean time.Duration, c *Control) error { + xapp.Logger.Debug("RemoveFromSubscription %s", idstring(nil, trans, subs, trans)) r.mutex.Lock() defer r.mutex.Unlock() subs.mutex.Lock() @@ -329,48 +521,55 @@ func (r *Registry) RemoveFromSubscription(subs *Subscription, trans *Transaction delStatus := subs.EpList.DelEndpoint(trans.GetEndpoint()) epamount := subs.EpList.Size() - subId := subs.ReqId.InstanceId + subId := subs.ReqId.InstanceId if delStatus == false { return nil } - go func() { - if waitRouteClean > 0 { - xapp.Logger.Debug("Pending %v in order to wait route cleanup", waitRouteClean) - time.Sleep(waitRouteClean) - } + if waitRouteClean > 0 { + // Wait here that response is delivered to xApp via RMR before route is cleaned + xapp.Logger.Debug("Pending %v in order to wait route cleanup", waitRouteClean) + time.Sleep(waitRouteClean) + } - subs.mutex.Lock() - defer subs.mutex.Unlock() - xapp.Logger.Info("CLEAN %s", subs.String()) + xapp.Logger.Debug("CLEAN %s", subs.String()) - if epamount == 0 { - // - // Subscription route delete - // + if epamount == 0 { + // + // Subscription route delete + // + if subs.RMRRouteCreated == true { r.RouteDelete(subs, trans, c) + } - // - // Subscription release - // - r.mutex.Lock() - defer r.mutex.Unlock() + // Not merged subscription is being deleted + xapp.Logger.Debug("Subscription route delete RemoveSubscriptionFromDb") + c.RemoveSubscriptionFromDb(subs) - if _, ok := r.register[subId]; ok { - xapp.Logger.Debug("RELEASE %s", subs.String()) - delete(r.register, subId) - xapp.Logger.Debug("Registry: substable=%v", r.register) - } - r.subIds = append(r.subIds, subId) - } else if subs.EpList.Size() > 0 { - // - // Subscription route update - // + // + // Subscription release + // + + if _, ok := r.register[subId]; ok { + xapp.Logger.Debug("RELEASE %s", subs.String()) + delete(r.register, subId) + xapp.Logger.Debug("Registry: substable=%v", r.register) + } + r.subIds = append(r.subIds, subId) + } else if subs.EpList.Size() > 0 { + // + // Subscription route update + // + if subs.RMRRouteCreated == true { r.RouteDeleteUpdate(subs, c) } - }() + // Endpoint of merged subscription is being deleted + xapp.Logger.Debug("Subscription route update WriteSubscriptionToDb") + c.WriteSubscriptionToDb(subs) + c.UpdateCounter(cUnmergedSubscriptions) + } return nil } @@ -390,26 +589,6 @@ func (r *Registry) RouteDeleteUpdate(subs *Subscription, c *Control) { } } -func (r *Registry) UpdateSubscriptionToDb(subs *Subscription, c *Control) { - r.mutex.Lock() - defer r.mutex.Unlock() - subs.mutex.Lock() - defer subs.mutex.Unlock() - - epamount := subs.EpList.Size() - if epamount == 0 { - if _, ok := r.register[subs.ReqId.InstanceId]; ok { - // Not merged subscription is being deleted - c.RemoveSubscriptionFromDb(subs) - - } - } else if subs.EpList.Size() > 0 { - // Endpoint of merged subscription is being deleted - c.WriteSubscriptionToDb(subs) - c.UpdateCounter(cUnmergedSubscriptions) - } -} - func (r *Registry) GetSubscription(subId uint32) *Subscription { r.mutex.Lock() defer r.mutex.Unlock() @@ -429,3 +608,59 @@ func (r *Registry) GetSubscriptionFirstMatch(subIds []uint32) (*Subscription, er } return nil, fmt.Errorf("No valid subscription found with subIds %v", subIds) } + +func (r *Registry) SetResetTestFlag(resetTestFlag bool, subs *Subscription) { + if resetTestFlag == true { + // This is used in submgr restart unit tests + xapp.Logger.Debug("resetTestFlag == true") + subs.DoNotWaitSubResp = true + } else { + xapp.Logger.Debug("resetTestFlag == false") + } +} + +func (r *Registry) DeleteAllE2Subscriptions(ranName string, c *Control) { + + xapp.Logger.Debug("Registry: DeleteAllE2Subscriptions()") + for subId, subs := range r.register { + if subs.Meid.RanName == ranName { + if subs.OngoingReqCount != 0 || subs.OngoingDelCount != 0 { + // Subscription creation or deletion processes need to be processed gracefully till the end. + // Subscription is deleted at end of the process in both cases. + xapp.Logger.Debug("Registry: E2 subscription under prosessing ongoing cannot delete it yet. subId=%v, OngoingReqCount=%v, OngoingDelCount=%v", subId, subs.OngoingReqCount, subs.OngoingDelCount) + continue + } else { + // Delete route + if subs.RMRRouteCreated == true { + for _, ep := range subs.EpList.Endpoints { + tmpList := xapp.RmrEndpointList{} + tmpList.AddEndpoint(&ep) + subRouteAction := SubRouteInfo{tmpList, uint16(subs.ReqId.InstanceId)} + if err := r.rtmgrClient.SubscriptionRequestDelete(subRouteAction); err != nil { + c.UpdateCounter(cRouteDeleteFail) + } + } + } + // Delete E2 subscription from registry and db + xapp.Logger.Debug("Registry: Subscription delete. subId=%v", subId) + delete(r.register, subId) + r.subIds = append(r.subIds, subId) + c.RemoveSubscriptionFromDb(subs) + } + } + } + + // Delete REST subscription from registry and db + for restSubId, restSubs := range r.restSubscriptions { + if restSubs.Meid == ranName && restSubs.SubReqOngoing == true || restSubs.SubDelReqOngoing == true { + // Subscription creation or deletion processes need to be processed gracefully till the end. + // Subscription is deleted at end of the process in both cases. + xapp.Logger.Debug("Registry: REST subscription under prosessing ongoing cannot delete it yet. RestSubId=%v, SubReqOngoing=%v, SubDelReqOngoing=%v", restSubId, restSubs.SubReqOngoing, restSubs.SubDelReqOngoing) + continue + } else { + xapp.Logger.Debug("Registry: REST subscription delete. subId=%v", restSubId) + delete(r.restSubscriptions, restSubId) + c.RemoveRESTSubscriptionFromDb(restSubId) + } + } +}