Merge newe2 into master
[ric-plt/submgr.git] / pkg / control / control.go
index 1d64f3c..4978a8d 100755 (executable)
@@ -23,11 +23,12 @@ import (
        "fmt"
        "gerrit.o-ran-sc.org/r/ric-plt/e2ap/pkg/e2ap"
        rtmgrclient "gerrit.o-ran-sc.org/r/ric-plt/submgr/pkg/rtmgr_client"
+       "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"
        httptransport "github.com/go-openapi/runtime/client"
        "github.com/go-openapi/strfmt"
        "github.com/spf13/viper"
-       "sync"
        "time"
 )
 
@@ -35,6 +36,25 @@ import (
 //
 //-----------------------------------------------------------------------------
 
+func idstring(err error, entries ...fmt.Stringer) string {
+       var retval string = ""
+       var filler string = ""
+       for _, entry := range entries {
+               retval += filler + entry.String()
+               filler = " "
+       }
+       if err != nil {
+               retval += filler + "err(" + err.Error() + ")"
+               filler = " "
+
+       }
+       return retval
+}
+
+//-----------------------------------------------------------------------------
+//
+//-----------------------------------------------------------------------------
+
 var e2tSubReqTimeout time.Duration = 5 * time.Second
 var e2tSubDelReqTime time.Duration = 5 * time.Second
 var e2tMaxSubReqTryCount uint64 = 2    // Initial try + retry
@@ -43,12 +63,11 @@ var e2tMaxSubDelReqTryCount uint64 = 2 // Initial try + retry
 var e2tRecvMsgTimeout time.Duration = 5 * time.Second
 
 type Control struct {
-       e2ap         *E2ap
-       registry     *Registry
-       tracker      *Tracker
-       timerMap     *TimerMap
-       rmrSendMutex sync.Mutex
-       msgCounter   uint64
+       xapptweaks.XappWrapper
+       e2ap     *E2ap
+       registry *Registry
+       tracker  *Tracker
+       //subscriber *xapp.Subscriber
 }
 
 type RMRMeid struct {
@@ -76,117 +95,125 @@ func NewControl() *Control {
        tracker := new(Tracker)
        tracker.Init()
 
-       timerMap := new(TimerMap)
-       timerMap.Init()
+       //subscriber := xapp.NewSubscriber(viper.GetString("subscription.host"), viper.GetInt("subscription.timeout"))
 
-       return &Control{e2ap: new(E2ap),
-               registry:   registry,
-               tracker:    tracker,
-               timerMap:   timerMap,
-               msgCounter: 0,
+       c := &Control{e2ap: new(E2ap),
+               registry: registry,
+               tracker:  tracker,
+               //subscriber: subscriber,
+       }
+       c.XappWrapper.Init("")
+       go xapp.Subscription.Listen(c.SubscriptionHandler, c.QueryHandler, c.SubscriptionDeleteHandler)
+       //go c.subscriber.Listen(c.SubscriptionHandler, c.QueryHandler)
+       return c
+}
+
+func (c *Control) ReadyCB(data interface{}) {
+       if c.Rmr == nil {
+               c.Rmr = xapp.Rmr
        }
 }
 
 func (c *Control) Run() {
+       xapp.SetReadyCB(c.ReadyCB, nil)
        xapp.Run(c)
 }
 
-func (c *Control) rmrSendRaw(desc string, params *RMRParams) (err error) {
-
-       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)
-               }
-       }
-       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)
-       }
-       return
+//-------------------------------------------------------------------
+//
+//-------------------------------------------------------------------
+func (c *Control) SubscriptionHandler(stype models.SubscriptionType, params interface{}) (*models.SubscriptionResponse, error) {
+       /*
+          switch p := params.(type) {
+          case *models.ReportParams:
+              trans := c.tracker.NewXappTransaction(NewRmrEndpoint(p.ClientEndpoint),"" , 0, &xapp.RMRMeid{RanName: p.Meid})
+              if trans == nil {
+                    xapp.Logger.Error("XAPP-SubReq: %s", idstring(fmt.Errorf("transaction not created"), params))
+                    return
+              }
+              defer trans.Release()
+          case *models.ControlParams:
+          case *models.PolicyParams:
+          }
+       */
+       return &models.SubscriptionResponse{}, fmt.Errorf("Subscription rest interface not implemented")
+}
+
+func (c *Control) SubscriptionDeleteHandler(string) error {
+       return fmt.Errorf("Subscription rest interface not implemented")
 }
 
+func (c *Control) QueryHandler() (models.SubscriptionList, error) {
+       return c.registry.QueryHandler()
+}
+
+//-------------------------------------------------------------------
+//
+//-------------------------------------------------------------------
+
 func (c *Control) rmrSendToE2T(desc string, subs *Subscription, trans *TransactionSubs) (err error) {
-       params := &RMRParams{&xapp.RMRParams{}}
+       params := xapptweaks.NewParams(nil)
        params.Mtype = trans.GetMtype()
-       params.SubId = int(subs.GetReqId().Seq)
+       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
-
-       return c.rmrSendRaw("MSG to E2T:"+desc+":"+trans.String(), params)
+       xapp.Logger.Info("MSG to E2T: %s %s %s", desc, trans.String(), params.String())
+       return c.RmrSend(params, 5)
 }
 
 func (c *Control) rmrSendToXapp(desc string, subs *Subscription, trans *TransactionXapp) (err error) {
 
-       params := &RMRParams{&xapp.RMRParams{}}
+       params := xapptweaks.NewParams(nil)
        params.Mtype = trans.GetMtype()
-       params.SubId = int(subs.GetReqId().Seq)
+       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
-
-       return c.rmrSendRaw("MSG to XAPP:"+desc+":"+trans.String(), params)
+       xapp.Logger.Info("MSG to XAPP: %s %s %s", desc, trans.String(), params.String())
+       return c.RmrSend(params, 5)
 }
 
 func (c *Control) Consume(params *xapp.RMRParams) (err error) {
-       xapp.Rmr.Free(params.Mbuf)
-       params.Mbuf = nil
-       msg := &RMRParams{params}
-       c.msgCounter++
+       msg := xapptweaks.NewParams(params)
+       if c.Rmr == nil {
+               err = fmt.Errorf("Rmr object nil can handle %s", msg.String())
+               xapp.Logger.Error("%s", err.Error())
+               return
+       }
+       c.CntRecvMsg++
+
+       defer c.Rmr.Free(msg.Mbuf)
 
        switch msg.Mtype {
-       case xapp.RICMessageTypes["RIC_SUB_REQ"]:
+       case xapp.RIC_SUB_REQ:
                go c.handleXAPPSubscriptionRequest(msg)
-       case xapp.RICMessageTypes["RIC_SUB_RESP"]:
+       case xapp.RIC_SUB_RESP:
                go c.handleE2TSubscriptionResponse(msg)
-       case xapp.RICMessageTypes["RIC_SUB_FAILURE"]:
+       case xapp.RIC_SUB_FAILURE:
                go c.handleE2TSubscriptionFailure(msg)
-       case xapp.RICMessageTypes["RIC_SUB_DEL_REQ"]:
+       case xapp.RIC_SUB_DEL_REQ:
                go c.handleXAPPSubscriptionDeleteRequest(msg)
-       case xapp.RICMessageTypes["RIC_SUB_DEL_RESP"]:
+       case xapp.RIC_SUB_DEL_RESP:
                go c.handleE2TSubscriptionDeleteResponse(msg)
-       case xapp.RICMessageTypes["RIC_SUB_DEL_FAILURE"]:
+       case xapp.RIC_SUB_DEL_FAILURE:
                go c.handleE2TSubscriptionDeleteFailure(msg)
        default:
                xapp.Logger.Info("Unknown Message Type '%d', discarding", msg.Mtype)
        }
-
-       return nil
-}
-
-func idstring(err error, entries ...fmt.Stringer) string {
-       var retval string = ""
-       var filler string = ""
-       for _, entry := range entries {
-               retval += filler + entry.String()
-               filler = " "
-       }
-       if err != nil {
-               retval += filler + "err(" + err.Error() + ")"
-               filler = " "
-
-       }
-       return retval
+       return
 }
 
 //-------------------------------------------------------------------
 // handle from XAPP Subscription Request
 //------------------------------------------------------------------
-func (c *Control) handleXAPPSubscriptionRequest(params *RMRParams) {
+func (c *Control) handleXAPPSubscriptionRequest(params *xapptweaks.RMRParams) {
        xapp.Logger.Info("MSG from XAPP: %s", params.String())
 
        subReqMsg, err := c.e2ap.UnpackSubscriptionRequest(params.Payload)
@@ -195,7 +222,7 @@ func (c *Control) handleXAPPSubscriptionRequest(params *RMRParams) {
                return
        }
 
-       trans := c.tracker.NewXappTransaction(NewRmrEndpoint(params.Src), params.Xid, &RequestId{subReqMsg.RequestId}, params.Meid)
+       trans := c.tracker.NewXappTransaction(xapptweaks.NewRmrEndpoint(params.Src), params.Xid, subReqMsg.RequestId.InstanceId, params.Meid)
        if trans == nil {
                xapp.Logger.Error("XAPP-SubReq: %s", idstring(fmt.Errorf("transaction not created"), params))
                return
@@ -208,6 +235,7 @@ func (c *Control) handleXAPPSubscriptionRequest(params *RMRParams) {
                return
        }
 
+       //TODO handle subscription toward e2term inside AssignToSubscription / hide handleSubscriptionCreate in it?
        subs, err := c.registry.AssignToSubscription(trans, subReqMsg)
        if err != nil {
                xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans))
@@ -226,6 +254,7 @@ func (c *Control) handleXAPPSubscriptionRequest(params *RMRParams) {
                case *e2ap.E2APSubscriptionResponse:
                        trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionResponse(themsg)
                        if err == nil {
+                               trans.Release()
                                c.rmrSendToXapp("", subs, trans)
                                return
                        }
@@ -239,13 +268,13 @@ func (c *Control) handleXAPPSubscriptionRequest(params *RMRParams) {
                }
        }
        xapp.Logger.Info("XAPP-SubReq: failed %s", idstring(err, trans, subs))
-       go c.registry.RemoveFromSubscription(subs, trans, 5*time.Second)
+       //c.registry.RemoveFromSubscription(subs, trans, 5*time.Second)
 }
 
 //-------------------------------------------------------------------
 // handle from XAPP Subscription Delete Request
 //------------------------------------------------------------------
-func (c *Control) handleXAPPSubscriptionDeleteRequest(params *RMRParams) {
+func (c *Control) handleXAPPSubscriptionDeleteRequest(params *xapptweaks.RMRParams) {
        xapp.Logger.Info("MSG from XAPP: %s", params.String())
 
        subDelReqMsg, err := c.e2ap.UnpackSubscriptionDeleteRequest(params.Payload)
@@ -254,7 +283,7 @@ func (c *Control) handleXAPPSubscriptionDeleteRequest(params *RMRParams) {
                return
        }
 
-       trans := c.tracker.NewXappTransaction(NewRmrEndpoint(params.Src), params.Xid, &RequestId{subDelReqMsg.RequestId}, params.Meid)
+       trans := c.tracker.NewXappTransaction(xapptweaks.NewRmrEndpoint(params.Src), params.Xid, subDelReqMsg.RequestId.InstanceId, params.Meid)
        if trans == nil {
                xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(fmt.Errorf("transaction not created"), params))
                return
@@ -267,7 +296,7 @@ func (c *Control) handleXAPPSubscriptionDeleteRequest(params *RMRParams) {
                return
        }
 
-       subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelReqMsg.RequestId.Seq})
+       subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{trans.GetSubId()})
        if err != nil {
                xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(err, trans))
                return
@@ -283,14 +312,15 @@ func (c *Control) handleXAPPSubscriptionDeleteRequest(params *RMRParams) {
 
        // Whatever is received send ok delete response
        subDelRespMsg := &e2ap.E2APSubscriptionDeleteResponse{}
-       subDelRespMsg.RequestId = subs.SubReqMsg.RequestId
+       subDelRespMsg.RequestId = subs.GetReqId().RequestId
        subDelRespMsg.FunctionId = subs.SubReqMsg.FunctionId
        trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionDeleteResponse(subDelRespMsg)
        if err == nil {
                c.rmrSendToXapp("", subs, trans)
        }
 
-       go c.registry.RemoveFromSubscription(subs, trans, 5*time.Second)
+       //TODO handle subscription toward e2term insiged RemoveFromSubscription / hide handleSubscriptionDelete in it?
+       //c.registry.RemoveFromSubscription(subs, trans, 5*time.Second)
 }
 
 //-------------------------------------------------------------------
@@ -307,22 +337,48 @@ func (c *Control) handleSubscriptionCreate(subs *Subscription, parentTrans *Tran
 
        subRfMsg, valid := subs.GetCachedResponse()
        if subRfMsg == nil && valid == true {
-               event := c.sendE2TSubscriptionRequest(subs, trans, parentTrans)
-               switch event.(type) {
-               case *e2ap.E2APSubscriptionResponse:
-                       subRfMsg, valid = subs.SetCachedResponse(event, true)
-               case *e2ap.E2APSubscriptionFailure:
-                       subRfMsg, valid = subs.SetCachedResponse(event, false)
-               default:
-                       xapp.Logger.Info("SUBS-SubReq: internal delete due event(%s) %s", typeofSubsMessage(event), idstring(nil, trans, subs, parentTrans))
-                       subRfMsg, valid = subs.SetCachedResponse(nil, false)
-                       c.sendE2TSubscriptionDeleteRequest(subs, trans, parentTrans)
+
+               //
+               // In case of failure
+               // - make internal delete
+               // - in case duplicate cause, retry (currently max 1 retry)
+               //
+               maxRetries := uint64(1)
+               doRetry := true
+               for retries := uint64(0); retries <= maxRetries && doRetry; retries++ {
+                       doRetry = false
+
+                       event := c.sendE2TSubscriptionRequest(subs, trans, parentTrans)
+                       switch themsg := event.(type) {
+                       case *e2ap.E2APSubscriptionResponse:
+                               subRfMsg, valid = subs.SetCachedResponse(event, true)
+                       case *e2ap.E2APSubscriptionFailure:
+                               subRfMsg, valid = subs.SetCachedResponse(event, false)
+                               doRetry = true
+                               for _, item := range themsg.ActionNotAdmittedList.Items {
+                                       if item.Cause.Content != e2ap.E2AP_CauseContent_Ric || (item.Cause.Value != e2ap.E2AP_CauseValue_Ric_duplicate_action && item.Cause.Value != e2ap.E2AP_CauseValue_Ric_duplicate_event) {
+                                               doRetry = false
+                                               break
+                                       }
+                               }
+                               xapp.Logger.Info("SUBS-SubReq: internal delete and possible retry due event(%s) retry(%t,%d/%d) %s", typeofSubsMessage(event), doRetry, retries, maxRetries, idstring(nil, trans, subs, parentTrans))
+                               c.sendE2TSubscriptionDeleteRequest(subs, trans, parentTrans)
+                       default:
+                               xapp.Logger.Info("SUBS-SubReq: internal delete due event(%s) %s", typeofSubsMessage(event), idstring(nil, trans, subs, parentTrans))
+                               subRfMsg, valid = subs.SetCachedResponse(nil, false)
+                               c.sendE2TSubscriptionDeleteRequest(subs, trans, parentTrans)
+                       }
                }
+
                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))
        }
 
+       //Now RemoveFromSubscription in here to avoid race conditions (mostly concerns delete)
+       if valid == false {
+               c.registry.RemoveFromSubscription(subs, parentTrans, 5*time.Second)
+       }
        parentTrans.SendEvent(subRfMsg, 0)
 }
 
@@ -347,11 +403,11 @@ func (c *Control) handleSubscriptionDelete(subs *Subscription, parentTrans *Tran
        } else {
                subs.mutex.Unlock()
        }
-
-       subDelRespMsg := &e2ap.E2APSubscriptionDeleteResponse{}
-       subDelRespMsg.RequestId = subs.SubReqMsg.RequestId
-       subDelRespMsg.FunctionId = subs.SubReqMsg.FunctionId
-       parentTrans.SendEvent(subDelRespMsg, 0)
+       //Now RemoveFromSubscription in here to avoid race conditions (mostly concerns delete)
+       //  If parallel deletes ongoing both might pass earlier sendE2TSubscriptionDeleteRequest(...) if
+       //  RemoveFromSubscription locates in caller side (now in handleXAPPSubscriptionDeleteRequest(...))
+       c.registry.RemoveFromSubscription(subs, parentTrans, 5*time.Second)
+       parentTrans.SendEvent(nil, 0)
 }
 
 //-------------------------------------------------------------------
@@ -417,14 +473,14 @@ func (c *Control) sendE2TSubscriptionDeleteRequest(subs *Subscription, trans *Tr
 //-------------------------------------------------------------------
 // handle from E2T Subscription Reponse
 //-------------------------------------------------------------------
-func (c *Control) handleE2TSubscriptionResponse(params *RMRParams) {
+func (c *Control) handleE2TSubscriptionResponse(params *xapptweaks.RMRParams) {
        xapp.Logger.Info("MSG from E2T: %s", params.String())
        subRespMsg, err := c.e2ap.UnpackSubscriptionResponse(params.Payload)
        if err != nil {
                xapp.Logger.Error("MSG-SubResp %s", idstring(err, params))
                return
        }
-       subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subRespMsg.RequestId.Seq})
+       subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subRespMsg.RequestId.InstanceId})
        if err != nil {
                xapp.Logger.Error("MSG-SubResp: %s", idstring(err, params))
                return
@@ -446,14 +502,14 @@ func (c *Control) handleE2TSubscriptionResponse(params *RMRParams) {
 //-------------------------------------------------------------------
 // handle from E2T Subscription Failure
 //-------------------------------------------------------------------
-func (c *Control) handleE2TSubscriptionFailure(params *RMRParams) {
+func (c *Control) handleE2TSubscriptionFailure(params *xapptweaks.RMRParams) {
        xapp.Logger.Info("MSG from E2T: %s", params.String())
        subFailMsg, err := c.e2ap.UnpackSubscriptionFailure(params.Payload)
        if err != nil {
                xapp.Logger.Error("MSG-SubFail %s", idstring(err, params))
                return
        }
-       subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subFailMsg.RequestId.Seq})
+       subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subFailMsg.RequestId.InstanceId})
        if err != nil {
                xapp.Logger.Error("MSG-SubFail: %s", idstring(err, params))
                return
@@ -475,14 +531,14 @@ func (c *Control) handleE2TSubscriptionFailure(params *RMRParams) {
 //-------------------------------------------------------------------
 // handle from E2T Subscription Delete Response
 //-------------------------------------------------------------------
-func (c *Control) handleE2TSubscriptionDeleteResponse(params *RMRParams) (err error) {
+func (c *Control) handleE2TSubscriptionDeleteResponse(params *xapptweaks.RMRParams) (err error) {
        xapp.Logger.Info("MSG from E2T: %s", params.String())
        subDelRespMsg, err := c.e2ap.UnpackSubscriptionDeleteResponse(params.Payload)
        if err != nil {
                xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params))
                return
        }
-       subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelRespMsg.RequestId.Seq})
+       subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelRespMsg.RequestId.InstanceId})
        if err != nil {
                xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params))
                return
@@ -504,14 +560,14 @@ func (c *Control) handleE2TSubscriptionDeleteResponse(params *RMRParams) (err er
 //-------------------------------------------------------------------
 // handle from E2T Subscription Delete Failure
 //-------------------------------------------------------------------
-func (c *Control) handleE2TSubscriptionDeleteFailure(params *RMRParams) {
+func (c *Control) handleE2TSubscriptionDeleteFailure(params *xapptweaks.RMRParams) {
        xapp.Logger.Info("MSG from E2T: %s", params.String())
        subDelFailMsg, err := c.e2ap.UnpackSubscriptionDeleteFailure(params.Payload)
        if err != nil {
                xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params))
                return
        }
-       subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelFailMsg.RequestId.Seq})
+       subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelFailMsg.RequestId.InstanceId})
        if err != nil {
                xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params))
                return