RICPLT-2983 SubDelResp go asn into use
[ric-plt/submgr.git] / pkg / control / control.go
index cfe3dfb..55f05e7 100755 (executable)
@@ -45,7 +45,6 @@ var maxSubDelReqTryCount uint64 = 2 // Initial try + retry
 type Control struct {
        e2ap         *E2ap
        registry     *Registry
-       rtmgrClient  *RtmgrClient
        tracker      *Tracker
        timerMap     *TimerMap
        rmrSendMutex sync.Mutex
@@ -85,8 +84,15 @@ func init() {
 
 func NewControl() *Control {
 
+       transport := httptransport.New(viper.GetString("rtmgr.HostAddr")+":"+viper.GetString("rtmgr.port"), viper.GetString("rtmgr.baseUrl"), []string{"http"})
+       client := rtmgrclient.New(transport, strfmt.Default)
+       handle := rtmgrhandle.NewProvideXappSubscriptionHandleParamsWithTimeout(10 * time.Second)
+       deleteHandle := rtmgrhandle.NewDeleteXappSubscriptionHandleParamsWithTimeout(10 * time.Second)
+       rtmgrClient := RtmgrClient{client, handle, deleteHandle}
+
        registry := new(Registry)
        registry.Initialize(seedSN)
+       registry.rtmgrClient = &rtmgrClient
 
        tracker := new(Tracker)
        tracker.Init()
@@ -94,23 +100,11 @@ func NewControl() *Control {
        timerMap := new(TimerMap)
        timerMap.Init()
 
-       transport := httptransport.New(viper.GetString("rtmgr.HostAddr")+":"+viper.GetString("rtmgr.port"), viper.GetString("rtmgr.baseUrl"), []string{"http"})
-       client := rtmgrclient.New(transport, strfmt.Default)
-       handle := rtmgrhandle.NewProvideXappSubscriptionHandleParamsWithTimeout(10 * time.Second)
-       deleteHandle := rtmgrhandle.NewDeleteXappSubscriptionHandleParamsWithTimeout(10 * time.Second)
-       rtmgrClient := RtmgrClient{client, handle, deleteHandle}
-
-       rtmgrClientPtr := &rtmgrClient
-
-       //TODO: to make this better. Now it is just a hack.
-       registry.rtmgrClient = rtmgrClientPtr
-
        return &Control{e2ap: new(E2ap),
-               registry:    registry,
-               rtmgrClient: rtmgrClientPtr,
-               tracker:     tracker,
-               timerMap:    timerMap,
-               msgCounter:  0,
+               registry:   registry,
+               tracker:    tracker,
+               timerMap:   timerMap,
+               msgCounter: 0,
        }
 }
 
@@ -234,7 +228,7 @@ func (c *Control) handleSubscriptionRequest(params *RMRParams) {
        err = subs.SetTransaction(trans)
        if err != nil {
                xapp.Logger.Error("SubReq: %s, Dropping this msg. %s", err.Error(), trans)
-               c.registry.DelSubscription(subs.Seq)
+               subs.Release()
                trans.Release()
                return
        }
@@ -252,7 +246,7 @@ func (c *Control) handleSubscriptionRequest(params *RMRParams) {
        packedData, err := c.e2ap.PackSubscriptionRequest(trans.SubReqMsg)
        if err != nil {
                xapp.Logger.Error("SubReq: %s for trans %s", err.Error(), trans)
-               c.registry.DelSubscription(subs.Seq)
+               subs.Release()
                trans.Release()
                return
        }
@@ -263,7 +257,7 @@ func (c *Control) handleSubscriptionRequest(params *RMRParams) {
 
        c.rmrSend("SubReq to E2T", subs, trans, packedData.Buf, len(packedData.Buf))
 
-       c.timerMap.StartTimer("RIC_SUB_REQ", int(subs.Seq), subReqTime, FirstTry, c.handleSubscriptionRequestTimer)
+       c.timerMap.StartTimer("RIC_SUB_REQ", int(subs.GetSubId()), subReqTime, FirstTry, c.handleSubscriptionRequestTimer)
        xapp.Logger.Debug("SubReq: Debugging trans table = %v", c.tracker.transactionXappTable)
        return
 }
@@ -271,22 +265,44 @@ func (c *Control) handleSubscriptionRequest(params *RMRParams) {
 func (c *Control) handleSubscriptionResponse(params *RMRParams) {
        xapp.Logger.Info("SubResp from E2T: %s", params.String())
 
-       payloadSeqNum, err := c.e2ap.GetSubscriptionResponseSequenceNumber(params.Payload)
+       //
+       //
+       //
+       SubRespMsg, err := c.e2ap.UnpackSubscriptionResponse(params.Payload)
        if err != nil {
-               xapp.Logger.Error("SubResp: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload)
+               xapp.Logger.Error("SubDelReq: %s Dropping this msg. %s", err.Error(), params.String())
                return
        }
-       xapp.Logger.Info("SubResp: Received payloadSeqNum: %v", payloadSeqNum)
 
-       subs := c.registry.GetSubscription(payloadSeqNum)
+       //
+       //
+       //
+       subs := c.registry.GetSubscription(uint16(SubRespMsg.RequestId.Seq))
+       if subs == nil && params.SubId > 0 {
+               subs = c.registry.GetSubscription(uint16(params.SubId))
+       }
+
        if subs == nil {
-               xapp.Logger.Error("SubResp: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
+               xapp.Logger.Error("SubResp: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", SubRespMsg.RequestId.Seq, params.SubId, params.String())
                return
        }
+       xapp.Logger.Info("SubResp: subscription found payloadSeqNum: %d, SubId: %d", SubRespMsg.RequestId.Seq, subs.GetSubId())
 
+       //
+       //
+       //
        trans := subs.GetTransaction()
+       if trans == nil {
+               xapp.Logger.Error("SubResp: Unknown trans. Dropping this msg. SubId: %d", subs.GetSubId())
+               return
+       }
 
-       c.timerMap.StopTimer("RIC_SUB_REQ", int(payloadSeqNum))
+       trans.SubRespMsg = SubRespMsg
+
+       //
+       //
+       //
+       c.timerMap.StopTimer("RIC_SUB_REQ", int(subs.GetSubId()))
 
        responseReceived := trans.CheckResponseReceived()
        if responseReceived == true {
@@ -294,40 +310,66 @@ func (c *Control) handleSubscriptionResponse(params *RMRParams) {
                return
        }
 
+       packedData, err := c.e2ap.PackSubscriptionResponse(trans.SubRespMsg)
+       if err != nil {
+               xapp.Logger.Error("SubResp: %s for trans %s", err.Error(), trans)
+               trans.Release()
+               return
+       }
+
+       //Optimize and store packed message to be sent.
+       trans.Payload = packedData.Buf
+       trans.PayloadLen = len(packedData.Buf)
+
        subs.Confirmed()
        trans.Release()
-       c.rmrReplyToSender("SubResp to xapp", subs, trans, params.Mtype, params.Payload, params.PayloadLen)
-       xapp.Logger.Info("SubResp: SubId: %v, from address: %s. Deleting trans record", payloadSeqNum, trans.RmrEndpoint)
+       c.rmrReplyToSender("SubResp to xapp", subs, trans, 12011, trans.Payload, trans.PayloadLen)
        return
 }
 
 func (c *Control) handleSubscriptionFailure(params *RMRParams) {
        xapp.Logger.Info("SubFail from E2T: %s", params.String())
 
-       payloadSeqNum, err := c.e2ap.GetSubscriptionFailureSequenceNumber(params.Payload)
+       //
+       //
+       //
+       SubFailMsg, err := c.e2ap.UnpackSubscriptionFailure(params.Payload)
        if err != nil {
-               xapp.Logger.Error("SubFail: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload)
+               xapp.Logger.Error("SubFail: %s Dropping this msg. %s", err.Error(), params.String())
                return
        }
-       xapp.Logger.Info("SubFail: Received payloadSeqNum: %v", payloadSeqNum)
 
-       subs := c.registry.GetSubscription(payloadSeqNum)
+       //
+       //
+       //
+       subs := c.registry.GetSubscription(uint16(SubFailMsg.RequestId.Seq))
+       if subs == nil && params.SubId > 0 {
+               subs = c.registry.GetSubscription(uint16(params.SubId))
+       }
+
        if subs == nil {
-               xapp.Logger.Error("SubFail: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
+               xapp.Logger.Error("SubFail: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", SubFailMsg.RequestId.Seq, params.SubId, params.String())
                return
        }
+       xapp.Logger.Info("SubFail: subscription found payloadSeqNum: %d, SubId: %d", SubFailMsg.RequestId.Seq, subs.GetSubId())
 
+       //
+       //
+       //
        trans := subs.GetTransaction()
        if trans == nil {
-               xapp.Logger.Error("SubFail: Unknown trans. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
+               xapp.Logger.Error("SubFail: Unknown trans. Dropping this msg. SubId: %d", subs.GetSubId())
                return
        }
+       trans.SubFailMsg = SubFailMsg
 
-       c.timerMap.StopTimer("RIC_SUB_REQ", int(payloadSeqNum))
+       //
+       //
+       //
+       c.timerMap.StopTimer("RIC_SUB_REQ", int(subs.GetSubId()))
 
        responseReceived := trans.CheckResponseReceived()
        if err != nil {
-               xapp.Logger.Info("SubFail: Dropping this msg. Err: %v SubId: %v", err, payloadSeqNum)
                return
        }
 
@@ -335,17 +377,21 @@ func (c *Control) handleSubscriptionFailure(params *RMRParams) {
                // Subscription timer already received
                return
        }
-       xapp.Logger.Info("SubFail: SubId: %v, from address: %s. Forwarding response to xApp", payloadSeqNum, trans.RmrEndpoint)
-
-       c.rmrReplyToSender("SubFail to xapp", subs, trans, params.Mtype, params.Payload, params.PayloadLen)
 
-       time.Sleep(3 * time.Second)
+       packedData, err := c.e2ap.PackSubscriptionFailure(trans.SubFailMsg)
+       if err != nil {
+               //TODO error handling improvement
+               xapp.Logger.Error("SubFail: %s for trans %s (continuing cleaning)", err.Error(), trans)
+       } else {
+               //Optimize and store packed message to be sent.
+               trans.Payload = packedData.Buf
+               trans.PayloadLen = len(packedData.Buf)
+               c.rmrReplyToSender("SubFail to xapp", subs, trans, 12012, trans.Payload, trans.PayloadLen)
+               time.Sleep(3 * time.Second)
+       }
 
-       xapp.Logger.Info("SubFail: Deleting trans record. SubId: %v, Xid: %s", params.SubId, params.Xid)
        trans.Release()
-       if !c.registry.DelSubscription(payloadSeqNum) {
-               xapp.Logger.Error("SubFail: Failed to release sequency number. SubId: %v, Xid: %s", params.SubId, params.Xid)
-       }
+       subs.Release()
        return
 }
 
@@ -376,7 +422,7 @@ func (c *Control) handleSubscriptionRequestTimer(strId string, nbrId int, tryCou
 
                trans.RetryTransaction()
 
-               c.rmrSend("SubReq(SubReq timer) to E2T", subs, trans, trans.Payload, trans.PayloadLen)
+               c.rmrSend("SubReq(SubReq timer retransmit) to E2T", subs, trans, trans.Payload, trans.PayloadLen)
 
                tryCount++
                c.timerMap.StartTimer("RIC_SUB_REQ", int(subs.GetSubId()), subReqTime, tryCount, c.handleSubscriptionRequestTimer)
@@ -397,7 +443,7 @@ func (c *Control) handleSubscriptionRequestTimer(strId string, nbrId int, tryCou
        if err != nil {
                xapp.Logger.Error("SubReq timeout: %s, Dropping this msg.", err.Error())
                //TODO improve error handling. Important at least in merge
-               c.registry.DelSubscription(subs.GetSubId())
+               subs.Release()
                return
        }
 
@@ -410,7 +456,7 @@ func (c *Control) handleSubscriptionRequestTimer(strId string, nbrId int, tryCou
                xapp.Logger.Error("SubReq timeout: Packing SubDelReq failed. Err: %v", err)
                //TODO improve error handling. Important at least in merge
                deltrans.Release()
-               c.registry.DelSubscription(subs.GetSubId())
+               subs.Release()
                return
        }
        deltrans.PayloadLen = len(packedData.Buf)
@@ -431,10 +477,11 @@ func (c *Control) handleSubscriptionRequestTimer(strId string, nbrId int, tryCou
 }
 
 func (c *Control) handleSubscriptionDeleteRequest(params *RMRParams) {
-       var subs *Subscription
-
        xapp.Logger.Info("SubDelReq from xapp: %s", params.String())
 
+       //
+       //
+       //
        trans, err := c.tracker.TrackTransaction(NewRmrEndpoint(params.Src),
                params.Mtype,
                params.Xid,
@@ -447,23 +494,30 @@ func (c *Control) handleSubscriptionDeleteRequest(params *RMRParams) {
                return
        }
 
-       payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteRequestSequenceNumber(params.Payload)
-       if err == nil {
-               subs = c.registry.GetSubscription(payloadSeqNum)
+       //
+       //
+       //
+       trans.SubDelReqMsg, err = c.e2ap.UnpackSubscriptionDeleteRequest(params.Payload)
+       if err != nil {
+               xapp.Logger.Error("SubDelReq: %s Dropping this msg. %s", err.Error(), trans)
+               trans.Release()
+               return
        }
+
+       //
+       //
+       //
+       subs := c.registry.GetSubscription(uint16(trans.SubDelReqMsg.RequestId.Seq))
        if subs == nil && params.SubId > 0 {
                subs = c.registry.GetSubscription(uint16(params.SubId))
        }
 
        if subs == nil {
-               xapp.Logger.Error("SubDelReq: Not valid subscription found payloadSeqNum: %d. Dropping this msg. %s", payloadSeqNum, trans)
+               xapp.Logger.Error("SubDelReq: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", trans.SubDelReqMsg.RequestId.Seq, params.SubId, trans)
                trans.Release()
                return
        }
-       xapp.Logger.Info("SubDelReq: subscription found payloadSeqNum: %d. %s", payloadSeqNum, trans)
-
-       trans.PayloadLen = params.PayloadLen
-       trans.Payload = params.Payload
+       xapp.Logger.Info("SubDelReq: subscription found payloadSeqNum: %d, SubId: %d. %s", trans.SubDelReqMsg.RequestId.Seq, params.SubId, trans)
 
        err = subs.SetTransaction(trans)
        if err != nil {
@@ -472,6 +526,25 @@ func (c *Control) handleSubscriptionDeleteRequest(params *RMRParams) {
                return
        }
 
+       //
+       // TODO: subscription delete is in fact owned by subscription and not transaction.
+       //       Transaction is toward xapp while Subscription is toward ran.
+       //       In merge several xapps may wake transactions, while only one subscription
+       //       toward ran occurs -> subscription owns subscription creation toward ran
+       //
+       //       This is intermediate solution while improving message handling
+       //
+       packedData, err := c.e2ap.PackSubscriptionDeleteRequest(trans.SubDelReqMsg)
+       if err != nil {
+               xapp.Logger.Error("SubDelReq: %s for trans %s", err.Error(), trans)
+               trans.Release()
+               return
+       }
+
+       //Optimize and store packed message to be sent (for retransmission). Again owned by subscription?
+       trans.Payload = packedData.Buf
+       trans.PayloadLen = len(packedData.Buf)
+
        subs.UnConfirmed()
 
        c.rmrSend("SubDelReq to E2T", subs, trans, trans.Payload, trans.PayloadLen)
@@ -483,25 +556,43 @@ func (c *Control) handleSubscriptionDeleteRequest(params *RMRParams) {
 func (c *Control) handleSubscriptionDeleteResponse(params *RMRParams) (err error) {
        xapp.Logger.Info("SubDelResp from E2T:%s", params.String())
 
-       payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteResponseSequenceNumber(params.Payload)
+       //
+       //
+       //
+       SubDelRespMsg, err := c.e2ap.UnpackSubscriptionDeleteResponse(params.Payload)
        if err != nil {
-               xapp.Logger.Error("SubDelResp: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload)
+               xapp.Logger.Error("SubDelResp: %s Dropping this msg. %s", err.Error(), params.String())
                return
        }
-       xapp.Logger.Info("SubDelResp: Received payloadSeqNum: %v", payloadSeqNum)
 
-       subs := c.registry.GetSubscription(payloadSeqNum)
+       //
+       //
+       //
+       subs := c.registry.GetSubscription(uint16(SubDelRespMsg.RequestId.Seq))
+       if subs == nil && params.SubId > 0 {
+               subs = c.registry.GetSubscription(uint16(params.SubId))
+       }
+
        if subs == nil {
-               xapp.Logger.Error("SubDelResp: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
+               xapp.Logger.Error("SubDelResp: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", SubDelRespMsg.RequestId.Seq, params.SubId, params.String())
                return
        }
+       xapp.Logger.Info("SubDelResp: subscription found payloadSeqNum: %d, SubId: %d", SubDelRespMsg.RequestId.Seq, subs.GetSubId())
 
+       //
+       //
+       //
        trans := subs.GetTransaction()
        if trans == nil {
-               xapp.Logger.Error("SubDelResp: Unknown trans. Dropping this msg. PayloadSeqNum: %v, SubId: %v", subs.GetSubId(), params.SubId)
+               xapp.Logger.Error("SubDelResp: Unknown trans. Dropping this msg. SubId: %d", subs.GetSubId())
                return
        }
 
+       trans.SubDelRespMsg = SubDelRespMsg
+
+       //
+       //
+       //
        c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId()))
 
        responseReceived := trans.CheckResponseReceived()
@@ -510,18 +601,23 @@ func (c *Control) handleSubscriptionDeleteResponse(params *RMRParams) (err error
                return
        }
 
-       trans.Release()
+       packedData, err := c.e2ap.PackSubscriptionDeleteResponse(trans.SubDelRespMsg)
+       if err != nil {
+               xapp.Logger.Error("SubDelResp: %s for trans %s (continuing cleaning)", err.Error(), trans)
+       } else {
+               //Optimize and store packed message to be sent.
+               trans.Payload = packedData.Buf
+               trans.PayloadLen = len(packedData.Buf)
+
+               if trans.ForwardRespToXapp == true {
+                       c.rmrReplyToSender("SubDelResp to xapp", subs, trans, 12021, trans.Payload, trans.PayloadLen)
+                       time.Sleep(3 * time.Second)
+               }
 
-       if trans.ForwardRespToXapp == true {
-               c.rmrReplyToSender("SubDelResp to xapp", subs, trans, params.Mtype, params.Payload, params.PayloadLen)
-               time.Sleep(3 * time.Second)
        }
 
-       xapp.Logger.Info("SubDelResp: Deleting trans record. SubId: %v, Xid: %s", subs.GetSubId(), trans.GetXid())
-       if !c.registry.DelSubscription(subs.GetSubId()) {
-               xapp.Logger.Error("SubDelResp: Failed to release sequency number. SubId: %v, Xid: %s", subs.GetSubId(), trans.GetXid())
-               return
-       }
+       trans.Release()
+       subs.Release()
        return
 }
 
@@ -567,12 +663,8 @@ func (c *Control) handleSubscriptionDeleteFailure(params *RMRParams) {
                time.Sleep(3 * time.Second)
        }
 
-       xapp.Logger.Info("SubDelFail: Deleting trans record. SubId: %v, Xid: %s", subs.GetSubId(), trans.GetXid())
        trans.Release()
-       if !c.registry.DelSubscription(subs.GetSubId()) {
-               xapp.Logger.Error("SubDelFail: Failed to release sequency number. Err: %v, SubId: %v, Xid: %s", err, subs.GetSubId(), trans.GetXid())
-               return
-       }
+       subs.Release()
        return
 }
 
@@ -598,13 +690,9 @@ func (c *Control) handleSubscriptionDeleteRequestTimer(strId string, nbrId int,
        }
 
        if tryCount < maxSubDelReqTryCount {
-               xapp.Logger.Info("SubDelReq timeout: Resending SubDelReq to E2T: Mtype: %v, SubId: %v, Xid %s, Meid %v", trans.GetMtype(), subs.GetSubId(), trans.GetXid(), trans.GetMeid())
                // Set possible to handle new response for the subId
-
                trans.RetryTransaction()
-
-               c.rmrSend("SubDelReq(SubDelReq timer) to E2T", subs, trans, trans.Payload, trans.PayloadLen)
-
+               c.rmrSend("SubDelReq(SubDelReq timer retransmit) to E2T", subs, trans, trans.Payload, trans.PayloadLen)
                tryCount++
                c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId()), subReqTime, tryCount, c.handleSubscriptionDeleteRequestTimer)
                return
@@ -624,11 +712,7 @@ func (c *Control) handleSubscriptionDeleteRequestTimer(strId string, nbrId int,
                time.Sleep(3 * time.Second)
 
        }
-
-       xapp.Logger.Info("SubDelReq timeout: Deleting trans record. SubId: %v, Xid: %s", subs.GetSubId(), trans.GetXid())
        trans.Release()
-       if !c.registry.DelSubscription(subs.GetSubId()) {
-               xapp.Logger.Error("SubDelReq timeout: Failed to release sequency number. SubId: %v, Xid: %s", subs.GetSubId(), trans.GetXid())
-       }
+       subs.Release()
        return
 }