import (
"fmt"
+ "gerrit.o-ran-sc.org/r/ric-plt/e2ap/pkg/e2ap"
+ "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 Registry struct {
mutex sync.Mutex
- register map[uint16]*Subscription
- counter uint16
+ register map[uint32]*Subscription
+ subIds []uint32
rtmgrClient *RtmgrClient
}
-// This method should run as a constructor
-func (r *Registry) Initialize(seedsn uint16) {
- r.register = make(map[uint16]*Subscription)
- r.counter = seedsn
+func (r *Registry) Initialize() {
+ r.register = make(map[uint32]*Subscription)
+ var i uint32
+ for i = 1; i < 65535; i++ {
+ r.subIds = append(r.subIds, i)
+ }
}
-// Reserves and returns the next free sequence number
-func (r *Registry) ReserveSubscription(endPoint RmrEndpoint, meid *xapp.RMRMeid) (*Subscription, error) {
- // Check is current SequenceNumber valid
- // Allocate next SequenceNumber value and retry N times
+func (r *Registry) QueryHandler() (models.SubscriptionList, error) {
r.mutex.Lock()
defer r.mutex.Unlock()
- var subs *Subscription = nil
- var retrytimes uint16 = 1000
- for ; subs == nil && retrytimes > 0; retrytimes-- {
- sequenceNumber := r.counter
- if r.counter == 65535 {
- r.counter = 0
- } else {
- r.counter++
+
+ 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()})
+ subs.mutex.Unlock()
+ }
+ return resp, nil
+}
+
+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:]
+ if _, ok := r.register[subId]; ok == true {
+ r.subIds = append(r.subIds, subId)
+ return nil, fmt.Errorf("Registry: Failed to reserve subscription exists")
+ }
+ subs := &Subscription{
+ 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")
}
- if _, ok := r.register[sequenceNumber]; ok == false {
- subs := &Subscription{
- Seq: sequenceNumber,
- Active: false,
- RmrEndpoint: endPoint,
- Meid: meid,
- Trans: nil,
+ 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, bool) {
+
+ for _, subs := range r.register {
+ if subs.IsMergeable(trans, subReqMsg) {
+
+ //
+ // check if there has been race conditions
+ //
+ subs.mutex.Lock()
+ //subs has been set to invalid
+ if subs.valid == false {
+ subs.mutex.Unlock()
+ continue
}
- r.register[sequenceNumber] = subs
+ // If size is zero, entry is to be deleted
+ if subs.EpList.Size() == 0 {
+ subs.mutex.Unlock()
+ continue
+ }
+ // Try to add to endpointlist. Adding fails if endpoint is already in the list
+ if subs.EpList.AddEndpoint(trans.GetEndpoint()) == false {
+ subs.mutex.Unlock()
+ 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, false
+ }
+ }
+ return nil, false
+}
+
+func (r *Registry) AssignToSubscription(trans *TransactionXapp, subReqMsg *e2ap.E2APSubscriptionRequest, resetTestFlag bool) (*Subscription, error) {
+ var err error
+ var newAlloc bool
+ r.mutex.Lock()
+ defer r.mutex.Unlock()
+
+ //
+ // Check validity of subscription action types
+ //
+ actionType, err := r.CheckActionTypes(subReqMsg)
+ if err != nil {
+ xapp.Logger.Debug("CREATE %s", err)
+ return nil, err
+ }
+
+ //
+ // Find possible existing Policy subscription
+ //
+ 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())
+ // Update message data to subscription
+ subs.SubReqMsg = subReqMsg
+ subs.SetCachedResponse(nil, true)
+ return subs, nil
+ }
+ }
- // Update routing
- r.mutex.Unlock()
- err := subs.UpdateRoute(CREATE, r.rtmgrClient)
+ subs, endPointFound := r.findExistingSubs(trans, subReqMsg)
+ if subs == nil {
+ subs, err = r.allocateSubs(trans, subReqMsg, resetTestFlag)
+ if 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())
+ //xapp.Logger.Debug("Registry: substable=%v", r.register)
+ return subs, nil
+ }
+
+ //
+ // Add to subscription
+ //
+ subs.mutex.Lock()
+ defer subs.mutex.Unlock()
+
+ epamount := 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)
+ } else {
+ subRouteAction := SubRouteInfo{subs.EpList, uint16(subs.ReqId.InstanceId)}
+ err = r.rtmgrClient.SubscriptionRequestUpdate(subRouteAction)
+ }
+ r.mutex.Lock()
+
+ if err != nil {
+ if newAlloc {
+ r.subIds = append(r.subIds, subs.ReqId.InstanceId)
+ }
+ return nil, err
+ }
+
+ if newAlloc {
+ r.register[subs.ReqId.InstanceId] = subs
+ }
+ xapp.Logger.Debug("CREATE %s", subs.String())
+ xapp.Logger.Debug("Registry: substable=%v", r.register)
+ return subs, nil
+}
+
+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 {
+ reportFound = true
+ }
+ if acts.ActionType == e2ap.E2AP_ActionTypePolicy {
+ policyFound = true
+ }
+ if acts.ActionType == e2ap.E2AP_ActionTypeInsert {
+ insertFound = true
+ }
+ }
+ 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
+ }
+ 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, c *Control) error {
+
+ r.mutex.Lock()
+ defer r.mutex.Unlock()
+ subs.mutex.Lock()
+ defer subs.mutex.Unlock()
+
+ delStatus := subs.EpList.DelEndpoint(trans.GetEndpoint())
+ epamount := subs.EpList.Size()
+ subId := subs.ReqId.InstanceId
+
+ if delStatus == false {
+ return nil
+ }
+
+ go func() {
+ if waitRouteClean > 0 {
+ time.Sleep(waitRouteClean)
+ }
+
+ subs.mutex.Lock()
+ defer subs.mutex.Unlock()
+ xapp.Logger.Info("CLEAN %s", subs.String())
+
+ if epamount == 0 {
+ //
+ // Subscription route delete
+ //
+ tmpList := xapp.RmrEndpointList{}
+ tmpList.AddEndpoint(trans.GetEndpoint())
+ subRouteAction := SubRouteInfo{tmpList, uint16(subId)}
+ r.rtmgrClient.SubscriptionRequestDelete(subRouteAction)
+
+ //
+ // Subscription release
+ //
r.mutex.Lock()
- if err != nil {
- if _, ok := r.register[sequenceNumber]; ok {
- delete(r.register, sequenceNumber)
- }
- return nil, err
+ defer r.mutex.Unlock()
+
+ 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)
}
- return subs, nil
+ r.subIds = append(r.subIds, subId)
+ } else if subs.EpList.Size() > 0 {
+ //
+ // Subscription route updates
+ //
+ subRouteAction := SubRouteInfo{subs.EpList, uint16(subId)}
+ r.rtmgrClient.SubscriptionRequestUpdate(subRouteAction)
}
+ }()
+
+ return nil
+}
+
+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)
}
- return nil, fmt.Errorf("Registry: Failed to reserves subcription. RmrEndpoint: %s, Meid: %s", endPoint, meid.RanName)
}
-func (r *Registry) GetSubscription(sn uint16) *Subscription {
+func (r *Registry) GetSubscription(subId uint32) *Subscription {
r.mutex.Lock()
defer r.mutex.Unlock()
- xapp.Logger.Debug("Registry map: %v", r.register)
- if _, ok := r.register[sn]; ok {
- return r.register[sn]
+ if _, ok := r.register[subId]; ok {
+ return r.register[subId]
}
return nil
}
-func (r *Registry) DelSubscription(sn uint16) bool {
+func (r *Registry) GetSubscriptionFirstMatch(subIds []uint32) (*Subscription, error) {
r.mutex.Lock()
defer r.mutex.Unlock()
- if _, ok := r.register[sn]; ok {
- subs := r.register[sn]
- delete(r.register, sn)
-
- // Update routing
- r.mutex.Unlock()
- err := subs.UpdateRoute(DELETE, r.rtmgrClient)
- r.mutex.Lock()
- if err != nil {
- xapp.Logger.Error("Registry: Failed to del route. SubId: %d, RmrEndpoint: %s", subs.Seq, subs.RmrEndpoint)
+ for _, subId := range subIds {
+ if _, ok := r.register[subId]; ok {
+ return r.register[subId], nil
}
- return true
}
- return false
+ return nil, fmt.Errorf("No valid subscription found with subIds %v", subIds)
}
Code Review / ric-plt / submgr.git / blobdiff