Xapp-frame, v0.8.1 Rest Subscription Creation /Query /Deletion
[ric-plt/submgr.git] / pkg / control / registry.go
index 5e16c0a..d7f8011 100644 (file)
@@ -21,33 +21,93 @@ package control
 
 import (
        "fmt"
+       "sync"
+       "time"
+
        "gerrit.o-ran-sc.org/r/ric-plt/e2ap/pkg/e2ap"
-       "gerrit.o-ran-sc.org/r/ric-plt/submgr/pkg/xapptweaks"
        "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/models"
        "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
-       "sync"
-       "time"
 )
 
 //-----------------------------------------------------------------------------
 //
 //-----------------------------------------------------------------------------
 
+type RESTSubscription struct {
+       xAppRmrEndPoint  string
+       Meid             string
+       InstanceIds      []uint32
+       SubReqOngoing    bool
+       SubDelReqOngoing bool
+}
+
+func (r *RESTSubscription) AddInstanceId(instanceId uint32) {
+       r.InstanceIds = append(r.InstanceIds, instanceId)
+}
+
+func (r *RESTSubscription) SetProcessed() {
+       r.SubReqOngoing = false
+}
+
+func (r *RESTSubscription) DeleteInstanceId(instanceId uint32) {
+       r.InstanceIds = r.InstanceIds[1:]
+}
+
 type Registry struct {
-       mutex       sync.Mutex
-       register    map[uint32]*Subscription
-       subIds      []uint32
-       rtmgrClient *RtmgrClient
+       mutex             sync.Mutex
+       register          map[uint32]*Subscription
+       subIds            []uint32
+       rtmgrClient       *RtmgrClient
+       restSubscriptions map[string]*RESTSubscription
 }
 
 func (r *Registry) Initialize() {
        r.register = make(map[uint32]*Subscription)
+       r.restSubscriptions = make(map[string]*RESTSubscription)
+
        var i uint32
-       for i = 0; i < 65535; i++ {
-               r.subIds = append(r.subIds, i+1)
+       for i = 1; i < 65535; i++ {
+               r.subIds = append(r.subIds, i)
        }
 }
 
+func (r *Registry) CreateRESTSubscription(restSubId *string, xAppRmrEndPoint *string, maid *string) (*RESTSubscription, error) {
+       r.mutex.Lock()
+       defer r.mutex.Unlock()
+       newRestSubscription := RESTSubscription{}
+       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, e2apCubscriptionCount=%v", *restSubId, len(r.restSubscriptions), len(r.register))
+       return &newRestSubscription, nil
+}
+
+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))
+}
+
+func (r *Registry) GetRESTSubscription(restSubId string) (*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
+                       r.restSubscriptions[restSubId] = restSubscription
+                       return restSubscription, nil
+               } else {
+                       return restSubscription, fmt.Errorf("Registry: REST delete 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)
+}
+
 func (r *Registry) QueryHandler() (models.SubscriptionList, error) {
        r.mutex.Lock()
        defer r.mutex.Unlock()
@@ -55,13 +115,13 @@ func (r *Registry) QueryHandler() (models.SubscriptionList, error) {
        resp := models.SubscriptionList{}
        for _, subs := range r.register {
                subs.mutex.Lock()
-               resp = append(resp, &models.SubscriptionData{SubscriptionID: int64(subs.ReqId.InstanceId), Meid: subs.Meid.RanName, Endpoint: subs.EpList.StringList()})
+               resp = append(resp, &models.SubscriptionData{SubscriptionID: int64(subs.ReqId.InstanceId), Meid: subs.Meid.RanName, ClientEndpoint: subs.EpList.StringList()})
                subs.mutex.Unlock()
        }
        return resp, nil
 }
 
-func (r *Registry) allocateSubs(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest) (*Subscription, error) {
+func (r *Registry) allocateSubs(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest, resetTestFlag bool) (*Subscription, error) {
        if len(r.subIds) > 0 {
                subId := r.subIds[0]
                r.subIds = r.subIds[1:]
@@ -70,25 +130,32 @@ func (r *Registry) allocateSubs(trans *TransactionXapp, subReqMsg *e2ap.E2APSubs
                        return nil, fmt.Errorf("Registry: Failed to reserve subscription exists")
                }
                subs := &Subscription{
-                       registry:  r,
-                       Meid:      trans.Meid,
-                       SubReqMsg: subReqMsg,
-                       valid:     true,
+                       registry:         r,
+                       Meid:             trans.Meid,
+                       SubReqMsg:        subReqMsg,
+                       valid:            true,
+                       RetryFromXapp:    false,
+                       SubRespRcvd:      false,
+                       DeleteFromDb:     false,
+                       NoRespToXapp:     false,
+                       DoNotWaitSubResp: false,
                }
                subs.ReqId.Id = 123
                subs.ReqId.InstanceId = subId
+               if resetTestFlag == true {
+                       subs.DoNotWaitSubResp = true
+               }
 
                if subs.EpList.AddEndpoint(trans.GetEndpoint()) == false {
                        r.subIds = append(r.subIds, subs.ReqId.InstanceId)
                        return nil, fmt.Errorf("Registry: Endpoint existing already in subscription")
                }
-
                return subs, nil
        }
        return nil, fmt.Errorf("Registry: Failed to reserve subscription no free ids")
 }
 
-func (r *Registry) findExistingSubs(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest) *Subscription {
+func (r *Registry) findExistingSubs(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest) (*Subscription, bool) {
 
        for _, subs := range r.register {
                if subs.IsMergeable(trans, subReqMsg) {
@@ -107,21 +174,22 @@ func (r *Registry) findExistingSubs(trans *TransactionXapp, subReqMsg *e2ap.E2AP
                                subs.mutex.Unlock()
                                continue
                        }
-                       // try to add to endpointlist.
+                       // Try to add to endpointlist. Adding fails if endpoint is already in the list
                        if subs.EpList.AddEndpoint(trans.GetEndpoint()) == false {
                                subs.mutex.Unlock()
-                               continue
+                               xapp.Logger.Debug("Registry: Subs with requesting endpoint found. %s for %s", subs.String(), trans.String())
+                               return subs, true
                        }
                        subs.mutex.Unlock()
 
-                       xapp.Logger.Debug("Registry: Mergeable subs found %s for %s", subs.String(), trans.String())
-                       return subs
+                       xapp.Logger.Debug("Registry: Mergeable subs found. %s for %s", subs.String(), trans.String())
+                       return subs, false
                }
        }
-       return nil
+       return nil, false
 }
 
-func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest) (*Subscription, error) {
+func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest, resetTestFlag bool, c *Control) (*Subscription, error) {
        var err error
        var newAlloc bool
        r.mutex.Lock()
@@ -141,19 +209,25 @@ func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap.
        //
        if actionType == e2ap.E2AP_ActionTypePolicy {
                if subs, ok := r.register[trans.GetSubId()]; ok {
-                       xapp.Logger.Debug("CREATE %s. Existing subscription for Policy found", subs.String())
+                       xapp.Logger.Debug("CREATE %s. Existing subscription for Policy found.", subs.String())
+                       // Update message data to subscription
+                       subs.SubReqMsg = subReqMsg
                        subs.SetCachedResponse(nil, true)
                        return subs, nil
                }
        }
 
-       subs := r.findExistingSubs(trans, subReqMsg)
+       subs, endPointFound := r.findExistingSubs(trans, subReqMsg)
        if subs == nil {
-               subs, err = r.allocateSubs(trans, subReqMsg)
-               if err != nil {
+               if subs, err = r.allocateSubs(trans, subReqMsg, resetTestFlag); err != nil {
                        return nil, err
                }
                newAlloc = true
+       } else if endPointFound == true {
+               // Requesting endpoint is already present in existing subscription. This can happen if xApp is restarted.
+               subs.RetryFromXapp = true
+               xapp.Logger.Debug("CREATE: subscription already exists. %s", subs.String())
+               return subs, nil
        }
 
        //
@@ -163,17 +237,16 @@ 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())
 
        r.mutex.Unlock()
        //
        // Subscription route updates
        //
        if epamount == 1 {
-               subRouteAction := SubRouteInfo{subs.EpList, uint16(subs.ReqId.InstanceId)}
-               err = r.rtmgrClient.SubscriptionRequestCreate(subRouteAction)
+               err = r.RouteCreate(subs, c)
        } else {
-               subRouteAction := SubRouteInfo{subs.EpList, uint16(subs.ReqId.InstanceId)}
-               err = r.rtmgrClient.SubscriptionRequestUpdate(subRouteAction)
+               err = r.RouteCreateUpdate(subs, c)
        }
        r.mutex.Lock()
 
@@ -181,6 +254,8 @@ func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap.
                if newAlloc {
                        r.subIds = append(r.subIds, subs.ReqId.InstanceId)
                }
+               // Delete already added endpoint for the request
+               subs.EpList.DelEndpoint(trans.GetEndpoint())
                return nil, err
        }
 
@@ -192,9 +267,30 @@ func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap.
        return subs, nil
 }
 
+func (r *Registry) RouteCreate(subs *Subscription, c *Control) error {
+       subRouteAction := SubRouteInfo{subs.EpList, uint16(subs.ReqId.InstanceId)}
+       err := r.rtmgrClient.SubscriptionRequestCreate(subRouteAction)
+       if err != nil {
+               c.UpdateCounter(cRouteCreateFail)
+       }
+       return err
+}
+
+func (r *Registry) RouteCreateUpdate(subs *Subscription, c *Control) error {
+       subRouteAction := SubRouteInfo{subs.EpList, uint16(subs.ReqId.InstanceId)}
+       err := r.rtmgrClient.SubscriptionRequestUpdate(subRouteAction)
+       if err != nil {
+               c.UpdateCounter(cRouteCreateUpdateFail)
+               return err
+       }
+       c.UpdateCounter(cMergedSubscriptions)
+       return err
+}
+
 func (r *Registry) CheckActionTypes(subReqMsg *e2ap.E2APSubscriptionRequest) (uint64, error) {
        var reportFound bool = false
        var policyFound bool = false
+       var insertFound bool = false
 
        for _, acts := range subReqMsg.ActionSetups {
                if acts.ActionType == e2ap.E2AP_ActionTypeReport {
@@ -203,9 +299,12 @@ func (r *Registry) CheckActionTypes(subReqMsg *e2ap.E2APSubscriptionRequest) (ui
                if acts.ActionType == e2ap.E2AP_ActionTypePolicy {
                        policyFound = true
                }
+               if acts.ActionType == e2ap.E2AP_ActionTypeInsert {
+                       insertFound = true
+               }
        }
-       if reportFound == true && policyFound == true {
-               return e2ap.E2AP_ActionTypeInvalid, fmt.Errorf("Report and Policy in same RICactions-ToBeSetup-List")
+       if reportFound == true && policyFound == true || reportFound == true && insertFound == true || policyFound == true && insertFound == true {
+               return e2ap.E2AP_ActionTypeInvalid, fmt.Errorf("Different action types (Report, Policy or Insert) in same RICactions-ToBeSetup-List")
        }
        if reportFound == true {
                return e2ap.E2AP_ActionTypeReport, nil
@@ -213,11 +312,14 @@ func (r *Registry) CheckActionTypes(subReqMsg *e2ap.E2APSubscriptionRequest) (ui
        if policyFound == true {
                return e2ap.E2AP_ActionTypePolicy, nil
        }
+       if insertFound == true {
+               return e2ap.E2AP_ActionTypeInsert, nil
+       }
        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) error {
+func (r *Registry) RemoveFromSubscription(subs *Subscription, trans *TransactionXapp, waitRouteClean time.Duration, c *Control) error {
 
        r.mutex.Lock()
        defer r.mutex.Unlock()
@@ -245,10 +347,7 @@ func (r *Registry) RemoveFromSubscription(subs *Subscription, trans *Transaction
                        //
                        // Subscription route delete
                        //
-                       tmpList := xapptweaks.RmrEndpointList{}
-                       tmpList.AddEndpoint(trans.GetEndpoint())
-                       subRouteAction := SubRouteInfo{tmpList, uint16(subId)}
-                       r.rtmgrClient.SubscriptionRequestDelete(subRouteAction)
+                       r.RouteDelete(subs, trans, c)
 
                        //
                        // Subscription release
@@ -262,20 +361,53 @@ func (r *Registry) RemoveFromSubscription(subs *Subscription, trans *Transaction
                                xapp.Logger.Debug("Registry: substable=%v", r.register)
                        }
                        r.subIds = append(r.subIds, subId)
-
                } else if subs.EpList.Size() > 0 {
                        //
-                       // Subscription route updates
+                       // Subscription route update
                        //
-                       subRouteAction := SubRouteInfo{subs.EpList, uint16(subId)}
-                       r.rtmgrClient.SubscriptionRequestUpdate(subRouteAction)
+                       r.RouteDeleteUpdate(subs, c)
                }
-
        }()
 
        return nil
 }
 
+func (r *Registry) RouteDelete(subs *Subscription, trans *TransactionXapp, c *Control) {
+       tmpList := xapp.RmrEndpointList{}
+       tmpList.AddEndpoint(trans.GetEndpoint())
+       subRouteAction := SubRouteInfo{tmpList, uint16(subs.ReqId.InstanceId)}
+       if err := r.rtmgrClient.SubscriptionRequestDelete(subRouteAction); err != nil {
+               c.UpdateCounter(cRouteDeleteFail)
+       }
+}
+
+func (r *Registry) RouteDeleteUpdate(subs *Subscription, c *Control) {
+       subRouteAction := SubRouteInfo{subs.EpList, uint16(subs.ReqId.InstanceId)}
+       if err := r.rtmgrClient.SubscriptionRequestUpdate(subRouteAction); err != nil {
+               c.UpdateCounter(cRouteDeleteUpdateFail)
+       }
+}
+
+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()