RMR params payload points to params msgbuf. Make sure that freed memory is not used
[ric-plt/submgr.git] / pkg / control / control.go
index 094e020..35e39f4 100755 (executable)
@@ -24,6 +24,7 @@ import (
        "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"
@@ -66,7 +67,7 @@ type Control struct {
        e2ap     *E2ap
        registry *Registry
        tracker  *Tracker
-       timerMap *TimerMap
+       //subscriber *xapp.Subscriber
 }
 
 type RMRMeid struct {
@@ -94,15 +95,16 @@ func NewControl() *Control {
        tracker := new(Tracker)
        tracker.Init()
 
-       timerMap := new(TimerMap)
-       timerMap.Init()
+       //subscriber := xapp.NewSubscriber(viper.GetString("subscription.host"), viper.GetInt("subscription.timeout"))
 
        c := &Control{e2ap: new(E2ap),
                registry: registry,
                tracker:  tracker,
-               timerMap: timerMap,
+               //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
 }
 
@@ -117,10 +119,42 @@ func (c *Control) Run() {
        xapp.Run(c)
 }
 
+//-------------------------------------------------------------------
+//
+//-------------------------------------------------------------------
+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 := 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 = ""
@@ -128,14 +162,14 @@ func (c *Control) rmrSendToE2T(desc string, subs *Subscription, trans *Transacti
        params.Payload = trans.Payload.Buf
        params.Mbuf = nil
        xapp.Logger.Info("MSG to E2T: %s %s %s", desc, trans.String(), params.String())
-       return c.RmrSend(params)
+       return c.RmrSend(params, 5)
 }
 
 func (c *Control) rmrSendToXapp(desc string, subs *Subscription, trans *TransactionXapp) (err error) {
 
        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 = ""
@@ -143,7 +177,7 @@ func (c *Control) rmrSendToXapp(desc string, subs *Subscription, trans *Transact
        params.Payload = trans.Payload.Buf
        params.Mbuf = nil
        xapp.Logger.Info("MSG to XAPP: %s %s %s", desc, trans.String(), params.String())
-       return c.RmrSend(params)
+       return c.RmrSend(params, 5)
 }
 
 func (c *Control) Consume(params *xapp.RMRParams) (err error) {
@@ -157,18 +191,28 @@ func (c *Control) Consume(params *xapp.RMRParams) (err error) {
 
        defer c.Rmr.Free(msg.Mbuf)
 
+       // 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)
+
        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)
@@ -188,7 +232,7 @@ func (c *Control) handleXAPPSubscriptionRequest(params *xapptweaks.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
@@ -201,6 +245,7 @@ func (c *Control) handleXAPPSubscriptionRequest(params *xapptweaks.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))
@@ -219,6 +264,7 @@ func (c *Control) handleXAPPSubscriptionRequest(params *xapptweaks.RMRParams) {
                case *e2ap.E2APSubscriptionResponse:
                        trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionResponse(themsg)
                        if err == nil {
+                               trans.Release()
                                c.rmrSendToXapp("", subs, trans)
                                return
                        }
@@ -232,7 +278,7 @@ func (c *Control) handleXAPPSubscriptionRequest(params *xapptweaks.RMRParams) {
                }
        }
        xapp.Logger.Info("XAPP-SubReq: failed %s", idstring(err, trans, subs))
-       c.registry.RemoveFromSubscription(subs, trans, 5*time.Second)
+       //c.registry.RemoveFromSubscription(subs, trans, 5*time.Second)
 }
 
 //-------------------------------------------------------------------
@@ -247,7 +293,7 @@ func (c *Control) handleXAPPSubscriptionDeleteRequest(params *xapptweaks.RMRPara
                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
@@ -260,7 +306,7 @@ func (c *Control) handleXAPPSubscriptionDeleteRequest(params *xapptweaks.RMRPara
                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
@@ -276,14 +322,15 @@ func (c *Control) handleXAPPSubscriptionDeleteRequest(params *xapptweaks.RMRPara
 
        // 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)
        }
 
-       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)
 }
 
 //-------------------------------------------------------------------
@@ -300,22 +347,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)
 }
 
@@ -340,11 +413,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,7 +490,7 @@ func (c *Control) handleE2TSubscriptionResponse(params *xapptweaks.RMRParams) {
                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,7 +519,7 @@ func (c *Control) handleE2TSubscriptionFailure(params *xapptweaks.RMRParams) {
                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,7 +548,7 @@ func (c *Control) handleE2TSubscriptionDeleteResponse(params *xapptweaks.RMRPara
                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,7 +577,7 @@ func (c *Control) handleE2TSubscriptionDeleteFailure(params *xapptweaks.RMRParam
                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