X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=pkg%2Fcontrol%2Fcontrol.go;h=98a2474e8920f122671f46c0ae8c237641613461;hb=7348625b9ef03d41dd5a0ca0f6c508376259717e;hp=d27844eea4e99e049b2834b841fff7e92c8b1383;hpb=1a50344b88201d4620b74d50d658a51117173636;p=ric-plt%2Fsubmgr.git diff --git a/pkg/control/control.go b/pkg/control/control.go old mode 100644 new mode 100755 index d27844e..98a2474 --- a/pkg/control/control.go +++ b/pkg/control/control.go @@ -19,548 +19,594 @@ package control -import "C" - import ( - "errors" + "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" - rtmgrhandle "gerrit.o-ran-sc.org/r/ric-plt/submgr/pkg/rtmgr_client/handle" + "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" - "math/rand" - "strconv" "time" - "sync" ) -var rmrSendMutex = &sync.Mutex{} +//----------------------------------------------------------------------------- +// +//----------------------------------------------------------------------------- + +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 +var e2tMaxSubDelReqTryCount uint64 = 2 // Initial try + retry -var subReqTime time.Duration = 2 * time.Second -var SubDelReqTime time.Duration = 2 * time.Second +var e2tRecvMsgTimeout time.Duration = 5 * time.Second type Control struct { - e2ap *E2ap - registry *Registry - rtmgrClient *RtmgrClient - tracker *Tracker - rcChan chan *xapp.RMRParams - timerMap *TimerMap + xapptweaks.XappWrapper + e2ap *E2ap + registry *Registry + tracker *Tracker + //subscriber *xapp.Subscriber } type RMRMeid struct { - PlmnID string - EnbID string + PlmnID string + EnbID string RanName string } -var seedSN uint16 - -const ( - CREATE Action = 0 - MERGE Action = 1 - DELETE Action = 3 -) - func init() { - xapp.Logger.Info("SUBMGR /ric-plt-submgr:r3-test-v2") + xapp.Logger.Info("SUBMGR") viper.AutomaticEnv() viper.SetEnvPrefix("submgr") viper.AllowEmptyEnv(true) - seedSN = uint16(viper.GetInt("seed_sn")) - if seedSN == 0 { - rand.Seed(time.Now().UnixNano()) - seedSN = uint16(rand.Intn(65535)) - } - if seedSN > 65535 { - seedSN = 0 - } - xapp.Logger.Info("SUBMGR: Initial Sequence Number: %v", seedSN) } -func NewControl() Control { +func NewControl() *Control { + + transport := httptransport.New(viper.GetString("rtmgr.HostAddr")+":"+viper.GetString("rtmgr.port"), viper.GetString("rtmgr.baseUrl"), []string{"http"}) + rtmgrClient := RtmgrClient{rtClient: rtmgrclient.New(transport, strfmt.Default)} + registry := new(Registry) - registry.Initialize(seedSN) + registry.Initialize() + registry.rtmgrClient = &rtmgrClient tracker := new(Tracker) tracker.Init() - timerMap := new(TimerMap) - timerMap.Init() + //subscriber := xapp.NewSubscriber(viper.GetString("subscription.host"), viper.GetInt("subscription.timeout")) - 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} + 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 +} - return Control{new(E2ap), registry, &rtmgrClient, tracker, make(chan *xapp.RMRParams),timerMap} +func (c *Control) ReadyCB(data interface{}) { + if c.Rmr == nil { + c.Rmr = xapp.Rmr + } } func (c *Control) Run() { - go c.controlLoop() + xapp.SetReadyCB(c.ReadyCB, nil) xapp.Run(c) } -func (c *Control) Consume(rp *xapp.RMRParams) (err error) { - c.rcChan <- rp - return -} - -func (c *Control) rmrSend(params *xapp.RMRParams) (err error) { - status := false - i := 1 - for ; i <= 10 && status == false; i++ { - rmrSendMutex.Lock() - status = xapp.Rmr.Send(params, false) - rmrSendMutex.Unlock() - if status == false { - xapp.Logger.Info("rmr.Send() failed. Retry count %v, Mtype: %v, SubId: %v, Xid %s",i, params.Mtype, params.SubId, params.Xid) - time.Sleep(500 * time.Millisecond) - } - } - if status == false { - err = errors.New("rmr.Send() failed") - xapp.Rmr.Free(params.Mbuf) - } - +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) SubscriptionHandler(stype models.SubscriptionType, params interface{}) (*models.SubscriptionResponse, error) { /* - if !xapp.Rmr.Send(params, false) { - err = errors.New("rmr.Send() failed") - xapp.Rmr.Free(params.Mbuf) - } - */ - return + 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) rmrReplyToSender(params *xapp.RMRParams) (err error) { - c.rmrSend(params) - return +func (c *Control) SubscriptionDeleteHandler(string) error { + return fmt.Errorf("Subscription rest interface not implemented") } -func (c *Control) controlLoop() { - for { - msg := <-c.rcChan - switch msg.Mtype { - case xapp.RICMessageTypes["RIC_SUB_REQ"]: - go c.handleSubscriptionRequest(msg) - case xapp.RICMessageTypes["RIC_SUB_RESP"]: - go c.handleSubscriptionResponse(msg) - case xapp.RICMessageTypes["RIC_SUB_FAILURE"]: - go c.handleSubscriptionFailure(msg) - case xapp.RICMessageTypes["RIC_SUB_DEL_REQ"]: - go c.handleSubscriptionDeleteRequest(msg) - case xapp.RICMessageTypes["RIC_SUB_DEL_RESP"]: - go c.handleSubscriptionDeleteResponse(msg) - default: - err := errors.New("Message Type " + strconv.Itoa(msg.Mtype) + " is discarded") - xapp.Logger.Error("Unknown message type: %v", err) - } - } +func (c *Control) QueryHandler() (models.SubscriptionList, error) { + return c.registry.QueryHandler() } -func (c *Control) handleSubscriptionRequest(params *xapp.RMRParams) (err error) { - xapp.Logger.Info("Subscription Request Received from Src: %s, Mtype: %v, SubId: %v, Xid: %s, Meid: %v",params.Src, params.Mtype, params.SubId, params.Xid, params.Meid) - xapp.Rmr.Free(params.Mbuf) +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- + +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.Xid = "" + params.Meid = subs.GetMeid() + params.Src = "" + params.PayloadLen = len(trans.Payload.Buf) + 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, 5) +} - /* Reserve a sequence number and set it in the payload */ - newSubId, isIdValid := c.registry.ReserveSequenceNumber() - if isIdValid != true { - xapp.Logger.Info("Further processing of this SubscriptionRequest stopped. SubId: %v, Xid: %s",params.SubId, params.Xid) - return - } +func (c *Control) rmrSendToXapp(desc string, subs *Subscription, trans *TransactionXapp) (err error) { - err = c.e2ap.SetSubscriptionRequestSequenceNumber(params.Payload, newSubId) - if err != nil { - err = errors.New("Unable to set Subscription Sequence Number in Payload due to: " + err.Error()) - return - } + params := xapptweaks.NewParams(nil) + params.Mtype = trans.GetMtype() + params.SubId = int(subs.GetReqId().Seq) + params.Xid = trans.GetXid() + params.Meid = trans.GetMeid() + params.Src = "" + params.PayloadLen = len(trans.Payload.Buf) + 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, 5) +} - srcAddr, srcPort, err := c.rtmgrClient.SplitSource(params.Src) - if err != nil { - xapp.Logger.Error("Failed to update routing-manager about the subscription request with reason: %s", err) +func (c *Control) Consume(params *xapp.RMRParams) (err error) { + 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 } - - /* Create transatcion records for every subscription request */ - xactKey := TransactionKey{newSubId, CREATE} - xactValue := Transaction{*srcAddr, *srcPort, params} - err = c.tracker.TrackTransaction(xactKey, xactValue) - if err != nil { - xapp.Logger.Error("Failed to create a Subscription Request transaction record due to %v", err) - return + c.CntRecvMsg++ + + defer c.Rmr.Free(msg.Mbuf) + + switch msg.Mtype { + case xapp.RIC_SUB_REQ: + go c.handleXAPPSubscriptionRequest(msg) + case xapp.RIC_SUB_RESP: + go c.handleE2TSubscriptionResponse(msg) + case xapp.RIC_SUB_FAILURE: + go c.handleE2TSubscriptionFailure(msg) + case xapp.RIC_SUB_DEL_REQ: + go c.handleXAPPSubscriptionDeleteRequest(msg) + case xapp.RIC_SUB_DEL_RESP: + go c.handleE2TSubscriptionDeleteResponse(msg) + case xapp.RIC_SUB_DEL_FAILURE: + go c.handleE2TSubscriptionDeleteFailure(msg) + default: + xapp.Logger.Info("Unknown Message Type '%d', discarding", msg.Mtype) } - - /* Update routing manager about the new subscription*/ - subRouteAction := SubRouteInfo{CREATE, *srcAddr, *srcPort, newSubId} - xapp.Logger.Info("Starting routing manager update") - c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) - - //time.Sleep(3 * time.Second) - - // Setting new subscription ID in the RMR header - params.SubId = int(newSubId) - xapp.Logger.Info("Forwarding Subscription Request to E2T: Mtype: %v, SubId: %v, Xid %s, Meid %v",params.Mtype, params.SubId, params.Xid, params.Meid) - err = c.rmrSend(params) - if err != nil { - xapp.Logger.Error("Failed to send request to E2T %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid) - } /*else { - c.timerMap.StartTimer(newSubId, subReqTime, c.handleSubscriptionRequestTimer) - }*/ - xapp.Logger.Debug("--- Debugging transaction table = %v", c.tracker.transactionTable) return } -func (c *Control) handleSubscriptionResponse(params *xapp.RMRParams) (err error) { - xapp.Logger.Info("Subscription Response Received from Src: %s, Mtype: %v, SubId: %v, Meid: %v",params.Src, params.Mtype, params.SubId, params.Meid) - xapp.Rmr.Free(params.Mbuf) - params.Mbuf = nil +//------------------------------------------------------------------- +// handle from XAPP Subscription Request +//------------------------------------------------------------------ +func (c *Control) handleXAPPSubscriptionRequest(params *xapptweaks.RMRParams) { + xapp.Logger.Info("MSG from XAPP: %s", params.String()) - payloadSeqNum, err := c.e2ap.GetSubscriptionResponseSequenceNumber(params.Payload) + subReqMsg, err := c.e2ap.UnpackSubscriptionRequest(params.Payload) if err != nil { - err = errors.New("Unable to get Subscription Sequence Number from Payload due to: " + err.Error()) + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, params)) return } - xapp.Logger.Info("Received payloadSeqNum: %v",payloadSeqNum) - if !c.registry.IsValidSequenceNumber(payloadSeqNum) { - err = errors.New("Unknown Subscription ID: " + strconv.Itoa(int(payloadSeqNum)) + " in Subscritpion Response. Message discarded.") + trans := c.tracker.NewXappTransaction(xapptweaks.NewRmrEndpoint(params.Src), params.Xid, subReqMsg.RequestId.Seq, params.Meid) + if trans == nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(fmt.Errorf("transaction not created"), params)) return } + defer trans.Release() -// c.timerMap.StopTimer(payloadSeqNum) - - c.registry.setSubscriptionToConfirmed(payloadSeqNum) - var transaction Transaction - transaction, err = c.tracker.RetriveTransaction(payloadSeqNum, CREATE) + err = c.tracker.Track(trans) if err != nil { - xapp.Logger.Error("Failed to retrive transaction record. Err: %v", err) - xapp.Logger.Info("Further processing of this Subscription Response stopped. SubId: %v, Xid: %s",params.SubId, params.Xid) + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) return } - xapp.Logger.Info("Subscription ID: %v, from address: %v:%v. Retrieved old subId...", int(payloadSeqNum), transaction.XappInstanceAddress, transaction.XappPort) - params.SubId = int(payloadSeqNum) - params.Xid = transaction.OrigParams.Xid - - xapp.Logger.Info("Forwarding Subscription Response to UEEC: Mtype: %v, SubId: %v, Xid: %s, Meid: %v",params.Mtype, params.SubId, params.Xid, params.Meid) - err = c.rmrReplyToSender(params) + //TODO handle subscription toward e2term inside AssignToSubscription / hide handleSubscriptionCreate in it? + subs, err := c.registry.AssignToSubscription(trans, subReqMsg) if err != nil { - xapp.Logger.Error("Failed to send response to requestor %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid) + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) + return } - xapp.Logger.Info("Subscription ID: %v, from address: %v:%v. Deleting transaction record", int(payloadSeqNum), transaction.XappInstanceAddress, transaction.XappPort) - transaction, err = c.tracker.completeTransaction(payloadSeqNum, CREATE) - if err != nil { - xapp.Logger.Error("Failed to delete a Subscription Request transaction record due to %v", err) - return + // + // Wake subs request + // + go c.handleSubscriptionCreate(subs, trans) + event, _ := trans.WaitEvent(0) //blocked wait as timeout is handled in subs side + + err = nil + if event != nil { + switch themsg := event.(type) { + case *e2ap.E2APSubscriptionResponse: + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionResponse(themsg) + if err == nil { + trans.Release() + c.rmrSendToXapp("", subs, trans) + return + } + case *e2ap.E2APSubscriptionFailure: + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionFailure(themsg) + if err == nil { + c.rmrSendToXapp("", subs, trans) + } + default: + break + } } - return + xapp.Logger.Info("XAPP-SubReq: failed %s", idstring(err, trans, subs)) + //c.registry.RemoveFromSubscription(subs, trans, 5*time.Second) } -func (c *Control) handleSubscriptionFailure(params *xapp.RMRParams) (err error) { - xapp.Logger.Info("Subscription Failure Received from Src: %s, Mtype: %v, SubId: %v, Meid: %v",params.Src, params.Mtype, params.SubId, params.Meid) - xapp.Rmr.Free(params.Mbuf) - params.Mbuf = nil +//------------------------------------------------------------------- +// handle from XAPP Subscription Delete Request +//------------------------------------------------------------------ +func (c *Control) handleXAPPSubscriptionDeleteRequest(params *xapptweaks.RMRParams) { + xapp.Logger.Info("MSG from XAPP: %s", params.String()) - payloadSeqNum, err := c.e2ap.GetSubscriptionFailureSequenceNumber(params.Payload) + subDelReqMsg, err := c.e2ap.UnpackSubscriptionDeleteRequest(params.Payload) if err != nil { - err = errors.New("Unable to get Subscription Sequence Number from Payload due to: " + err.Error()) + xapp.Logger.Error("XAPP-SubDelReq %s", idstring(err, params)) return } - xapp.Logger.Info("Received payloadSeqNum: %v", payloadSeqNum) - - // should here be IsValidSequenceNumber check? - -// c.timerMap.StopTimer(payloadSeqNum) - var transaction Transaction - transaction, err = c.tracker.RetriveTransaction(payloadSeqNum, CREATE) - if err != nil { - xapp.Logger.Error("Failed to retrive transaction record. Err %v", err) - xapp.Logger.Info("Further processing of this Subscription Failure stopped. SubId: %v, Xid: %s",params.SubId, params.Xid) + trans := c.tracker.NewXappTransaction(xapptweaks.NewRmrEndpoint(params.Src), params.Xid, subDelReqMsg.RequestId.Seq, params.Meid) + if trans == nil { + xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(fmt.Errorf("transaction not created"), params)) return } - xapp.Logger.Info("Subscription ID: %v, from address: %v:%v. Forwarding response to requestor...", int(payloadSeqNum), transaction.XappInstanceAddress, transaction.XappPort) + defer trans.Release() - params.SubId = int(payloadSeqNum) - params.Xid = transaction.OrigParams.Xid + err = c.tracker.Track(trans) + if err != nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) + return + } - xapp.Logger.Info("Forwarding Subscription Failure to UEEC: Mtype: %v, SubId: %v, Xid: %v, Meid: %v",params.Mtype, params.SubId, params.Xid, params.Meid) - err = c.rmrReplyToSender(params) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{trans.GetSubId()}) if err != nil { - xapp.Logger.Error("Failed to send response to requestor %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid) + xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(err, trans)) + return } - time.Sleep(3 * time.Second) + // + // Wake subs delete + // + go c.handleSubscriptionDelete(subs, trans) + trans.WaitEvent(0) //blocked wait as timeout is handled in subs side - xapp.Logger.Info("Starting routing manager update") - subRouteAction := SubRouteInfo{CREATE, transaction.XappInstanceAddress, transaction.XappPort, payloadSeqNum} - c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) + xapp.Logger.Debug("XAPP-SubDelReq: Handling event %s ", idstring(nil, trans, subs)) - xapp.Logger.Info("Deleting trancaction record") - if c.registry.releaseSequenceNumber(payloadSeqNum) { - transaction, err = c.tracker.completeTransaction(payloadSeqNum, CREATE) - if err != nil { - xapp.Logger.Error("Failed to delete a Subscription Request transaction record due to %v", err) - return - } + // Whatever is received send ok delete response + subDelRespMsg := &e2ap.E2APSubscriptionDeleteResponse{} + 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) } - return + + //TODO handle subscription toward e2term insiged RemoveFromSubscription / hide handleSubscriptionDelete in it? + //c.registry.RemoveFromSubscription(subs, trans, 5*time.Second) } -func (c *Control) handleSubscriptionRequestTimer(subId uint16) { - xapp.Logger.Info("Subscription Request timer expired. SubId: %v",subId) -/* - transaction, err := c.tracker.completeTransaction(subId, CREATE) - if err != nil { - xapp.Logger.Error("Failed to delete a Subscription Request transaction record due to %v", err) - return - } - xapp.Logger.Info("SubId: %v, Xid %v, Meid: %v",subId, transaction.OrigParams.Xid, transaction.OrigParams.Meid) +//------------------------------------------------------------------- +// SUBS CREATE Handling +//------------------------------------------------------------------- +func (c *Control) handleSubscriptionCreate(subs *Subscription, parentTrans *TransactionXapp) { + + trans := c.tracker.NewSubsTransaction(subs) + subs.WaitTransactionTurn(trans) + defer subs.ReleaseTransactionTurn(trans) + defer trans.Release() + + xapp.Logger.Debug("SUBS-SubReq: Handling %s ", idstring(nil, trans, subs, parentTrans)) + + subRfMsg, valid := subs.GetCachedResponse() + if subRfMsg == nil && valid == true { + + // + // 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) + } + } - var params xapp.RMRParams - params.Mtype = 12012 //xapp.RICMessageTypes["RIC_SUB_FAILURE"] - params.SubId = int(subId) - params.Meid = transaction.OrigParams.Meid - params.Xid = transaction.OrigParams.Xid - payload := []byte("40C9408098000003EA7E00050000010016EA6300020021EA6E00808180EA6F000400000000EA6F000400010040EA6F000400020080EA6F0004000300C0EA6F000400040100EA6F000400050140EA6F000400060180EA6F0004000701C0EA6F000400080200EA6F000400090240EA6F0004000A0280EA6F0004000B02C0EA6F0004000C0300EA6F0004000D0340EA6F0004000E0380EA6F0004000F03C0") - params.PayloadLen = len(payload) - params.Payload = payload + 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)) + } - xapp.Logger.Info("Forwarding Subscription Failure to UEEC: Mtype: %v, SubId: %v, Xid: %s, Meid: %v",params.Mtype, params.SubId, params.Xid, params.Meid) - err = c.rmrReplyToSender(¶ms) - if err != nil { - xapp.Logger.Error("Failed to send response to requestor %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid) + //Now RemoveFromSubscription in here to avoid race conditions (mostly concerns delete) + if valid == false { + c.registry.RemoveFromSubscription(subs, parentTrans, 5*time.Second) } -*/ -/* - time.Sleep(3 * time.Second) + parentTrans.SendEvent(subRfMsg, 0) +} - xapp.Logger.Info("Subscription ID: %v, from address: %v:%v. Deleting transaction record", int(subId), transaction.XappInstanceAddress, transaction.XappPort) +//------------------------------------------------------------------- +// SUBS DELETE Handling +//------------------------------------------------------------------- - xapp.Logger.Info("Starting routing manager update") - subRouteAction := SubRouteInfo{DELETE, transaction.XappInstanceAddress, transaction.XappPort, payloadSeqNum} - c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) +func (c *Control) handleSubscriptionDelete(subs *Subscription, parentTrans *TransactionXapp) { - xapp.Logger.Info("Deleting trancaction record") - if c.registry.releaseSequenceNumber(payloadSeqNum) { - transaction, err = c.tracker.completeTransaction(payloadSeqNum, CREATE) - if err != nil { - xapp.Logger.Error("Failed to delete a Subscription Request transaction record due to %v", err) - return - } + trans := c.tracker.NewSubsTransaction(subs) + subs.WaitTransactionTurn(trans) + defer subs.ReleaseTransactionTurn(trans) + defer trans.Release() + + xapp.Logger.Debug("SUBS-SubDelReq: Handling %s", idstring(nil, trans, subs, parentTrans)) + + subs.mutex.Lock() + if subs.valid && subs.EpList.HasEndpoint(parentTrans.GetEndpoint()) && subs.EpList.Size() == 1 { + subs.valid = false + subs.mutex.Unlock() + c.sendE2TSubscriptionDeleteRequest(subs, trans, parentTrans) + } else { + subs.mutex.Unlock() } -*/ - return + //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) } -func (act Action) String() string { - actions := [...]string{ - "CREATE", - "MERGE", - "DELETE", +//------------------------------------------------------------------- +// send to E2T Subscription Request +//------------------------------------------------------------------- +func (c *Control) sendE2TSubscriptionRequest(subs *Subscription, trans *TransactionSubs, parentTrans *TransactionXapp) interface{} { + var err error + var event interface{} = nil + var timedOut bool = false + + subReqMsg := subs.SubReqMsg + subReqMsg.RequestId = subs.GetReqId().RequestId + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionRequest(subReqMsg) + if err != nil { + xapp.Logger.Error("SUBS-SubReq: %s", idstring(err, trans, subs, parentTrans)) + return event } - if act < CREATE || act > DELETE { - return "Unknown" + for retries := uint64(0); retries < e2tMaxSubReqTryCount; retries++ { + desc := fmt.Sprintf("(retry %d)", retries) + c.rmrSendToE2T(desc, subs, trans) + event, timedOut = trans.WaitEvent(e2tSubReqTimeout) + if timedOut { + continue + } + break } - return actions[act] + xapp.Logger.Debug("SUBS-SubReq: Response handling event(%s) %s", typeofSubsMessage(event), idstring(nil, trans, subs, parentTrans)) + return event } -func (act Action) valid() bool { - switch act { - case CREATE, MERGE, DELETE: - return true - default: - return false - } -} +//------------------------------------------------------------------- +// send to E2T Subscription Delete Request +//------------------------------------------------------------------- -func (c *Control) handleSubscriptionDeleteRequest(params *xapp.RMRParams) (err error) { - xapp.Logger.Info("Subscription Delete Request Received from Src: %s, Mtype: %v, SubId: %v, Xid: %s, Meid: %v",params.Src, params.Mtype, params.SubId, params.Xid, params.Meid) - xapp.Rmr.Free(params.Mbuf) - params.Mbuf = nil +func (c *Control) sendE2TSubscriptionDeleteRequest(subs *Subscription, trans *TransactionSubs, parentTrans *TransactionXapp) interface{} { + var err error + var event interface{} + var timedOut bool - payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteRequestSequenceNumber(params.Payload) + subDelReqMsg := &e2ap.E2APSubscriptionDeleteRequest{} + subDelReqMsg.RequestId = subs.GetReqId().RequestId + subDelReqMsg.FunctionId = subs.SubReqMsg.FunctionId + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionDeleteRequest(subDelReqMsg) if err != nil { - err = errors.New("Unable to get Subscription Sequence Number from Payload due to: " + err.Error()) - return + xapp.Logger.Error("SUBS-SubDelReq: %s", idstring(err, trans, subs, parentTrans)) + return event } - xapp.Logger.Info("Received payloadSeqNum: %v", payloadSeqNum) - if c.registry.IsValidSequenceNumber(payloadSeqNum) { - c.registry.deleteSubscription(payloadSeqNum) - trackErr := c.trackDeleteTransaction(params, payloadSeqNum) - if trackErr != nil { - xapp.Logger.Error("Failed to create a Subscription Delete Request transaction record due to %v", trackErr) - return trackErr + + for retries := uint64(0); retries < e2tMaxSubDelReqTryCount; retries++ { + desc := fmt.Sprintf("(retry %d)", retries) + c.rmrSendToE2T(desc, subs, trans) + event, timedOut = trans.WaitEvent(e2tSubDelReqTime) + if timedOut { + continue } + break } - - xapp.Logger.Info("Forwarding Delete Subscription Request to E2T: Mtype: %v, SubId: %v, Xid: %s, Meid: %v",params.Mtype, params.SubId, params.Xid, params.Meid) - c.rmrSend(params) - if err != nil { - xapp.Logger.Error("Failed to send request to E2T %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid) - } /*else { - c.timerMap.StartTimer(payloadSeqNum, SubDelReqTime, c.handleSubscriptionDeleteRequestTimer) - }*/ - return + xapp.Logger.Debug("SUBS-SubDelReq: Response handling event(%s) %s", typeofSubsMessage(event), idstring(nil, trans, subs, parentTrans)) + return event } -func (c *Control) trackDeleteTransaction(params *xapp.RMRParams, payloadSeqNum uint16) (err error) { - srcAddr, srcPort, err := c.rtmgrClient.SplitSource(params.Src) +//------------------------------------------------------------------- +// handle from E2T Subscription Reponse +//------------------------------------------------------------------- +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("Failed to update routing-manager about the subscription delete request with reason: %s", err) + xapp.Logger.Error("MSG-SubResp %s", idstring(err, params)) + return + } + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subRespMsg.RequestId.Seq}) + if err != nil { + xapp.Logger.Error("MSG-SubResp: %s", idstring(err, params)) + return + } + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubResp: %s", idstring(err, params, subs)) + return + } + sendOk, timedOut := trans.SendEvent(subRespMsg, e2tRecvMsgTimeout) + if sendOk == false { + err = fmt.Errorf("Passing event to transaction failed: sendOk(%t) timedOut(%t)", sendOk, timedOut) + xapp.Logger.Error("MSG-SubResp: %s", idstring(err, trans, subs)) } - xactKey := TransactionKey{payloadSeqNum, DELETE} - xactValue := Transaction{*srcAddr, *srcPort, params} - err = c.tracker.TrackTransaction(xactKey, xactValue) return } -func (c *Control) handleSubscriptionDeleteResponse(params *xapp.RMRParams) (err error) { - xapp.Logger.Info("Subscription Delete Response Received from Src: %s, Mtype: %v, SubId: %v, Meid: %v",params.Src, params.Mtype, params.SubId, params.Meid) - xapp.Rmr.Free(params.Mbuf) - params.Mbuf = nil - - payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteResponseSequenceNumber(params.Payload) +//------------------------------------------------------------------- +// handle from E2T Subscription Failure +//------------------------------------------------------------------- +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 { - err = errors.New("Unable to get Subscription Sequence Number from Payload due to: " + err.Error()) + xapp.Logger.Error("MSG-SubFail %s", idstring(err, params)) return } - xapp.Logger.Info("Received payloadSeqNum: %v", payloadSeqNum) - - // should here be IsValidSequenceNumber check? -// c.timerMap.StopTimer(payloadSeqNum) - - var transaction Transaction - transaction, err = c.tracker.RetriveTransaction(payloadSeqNum, DELETE) - if err != nil { - xapp.Logger.Error("Failed to retrive transaction record. Err %v", err) - xapp.Logger.Info("Further processing of this Subscription Delete Response stopped. SubId: %v, Xid: %s",params.SubId, params.Xid) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subFailMsg.RequestId.Seq}) + if err != nil { + xapp.Logger.Error("MSG-SubFail: %s", idstring(err, params)) return } - xapp.Logger.Info("Subscription ID: %v, from address: %v:%v. Forwarding response to requestor...", int(payloadSeqNum), transaction.XappInstanceAddress, transaction.XappPort) - - params.SubId = int(payloadSeqNum) - params.Xid = transaction.OrigParams.Xid - xapp.Logger.Info("Forwarding Subscription Delete Response to UEEC: Mtype: %v, SubId: %v, Xid: %v, Meid: %v",params.Mtype, params.SubId, params.Xid, params.Meid) - err = c.rmrReplyToSender(params) - if err != nil { - xapp.Logger.Error("Failed to send response to requestor %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid) -// return + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubFail: %s", idstring(err, params, subs)) + return } - - time.Sleep(3 * time.Second) - - xapp.Logger.Info("Starting routing manager update") - subRouteAction := SubRouteInfo{DELETE, transaction.XappInstanceAddress, transaction.XappPort, payloadSeqNum} - c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) - - xapp.Logger.Info("Deleting trancaction record") - if c.registry.releaseSequenceNumber(payloadSeqNum) { - transaction, err = c.tracker.completeTransaction(payloadSeqNum, DELETE) - if err != nil { - xapp.Logger.Error("Failed to delete a Subscription Delete Request transaction record due to %v", err) - return - } + sendOk, timedOut := trans.SendEvent(subFailMsg, e2tRecvMsgTimeout) + if sendOk == false { + err = fmt.Errorf("Passing event to transaction failed: sendOk(%t) timedOut(%t)", sendOk, timedOut) + xapp.Logger.Error("MSG-SubFail: %s", idstring(err, trans, subs)) } return } -func (c *Control) handleSubscriptionDeleteFailure(params *xapp.RMRParams) (err error) { - xapp.Logger.Info("Subscription Delete Failure Received from Src: %s, Mtype: %v, SubId: %v, Meid: %v",params.Src, params.Mtype, params.SubId, params.Meid) - xapp.Rmr.Free(params.Mbuf) - params.Mbuf = nil - - payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteFailureSequenceNumber(params.Payload) +//------------------------------------------------------------------- +// handle from E2T Subscription Delete Response +//------------------------------------------------------------------- +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 { - err = errors.New("Unable to get Subscription Sequence Number from Payload due to: " + err.Error()) + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params)) return } - xapp.Logger.Info("Received payloadSeqNum: %v", payloadSeqNum) - - // should here be IsValidSequenceNumber check? -// c.timerMap.StopTimer(payloadSeqNum) - - var transaction Transaction - transaction, err = c.tracker.RetriveTransaction(payloadSeqNum, DELETE) - if err != nil { - xapp.Logger.Error("Failed to retrive transaction record. Err %v", err) - xapp.Logger.Info("Further processing of this Subscription Delete Failure stopped. SubId: %v, Xid: %s",params.SubId, params.Xid) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelRespMsg.RequestId.Seq}) + if err != nil { + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params)) return } - xapp.Logger.Info("Subscription ID: %v, from address: %v:%v. Forwarding response to requestor...", int(payloadSeqNum), transaction.XappInstanceAddress, transaction.XappPort) - - params.SubId = int(payloadSeqNum) - params.Xid = transaction.OrigParams.Xid - xapp.Logger.Info("Forwarding Subscription Delete Failure to UEEC: Mtype: %v, SubId: %v, Xid: %v, Meid: %v",params.Mtype, params.SubId, params.Xid, params.Meid) - err = c.rmrReplyToSender(params) - if err != nil { - xapp.Logger.Error("Failed to send response to requestor %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid) -// return + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params, subs)) + return } - - time.Sleep(3 * time.Second) - - xapp.Logger.Info("Starting routing manager update") - subRouteAction := SubRouteInfo{DELETE, transaction.XappInstanceAddress, transaction.XappPort, payloadSeqNum} - c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) - - xapp.Logger.Info("Deleting trancaction record") - if c.registry.releaseSequenceNumber(payloadSeqNum) { - transaction, err = c.tracker.completeTransaction(payloadSeqNum, DELETE) - if err != nil { - xapp.Logger.Error("Failed to delete a Subscription Delete Request transaction record due to %v", err) - return - } + sendOk, timedOut := trans.SendEvent(subDelRespMsg, e2tRecvMsgTimeout) + if sendOk == false { + err = fmt.Errorf("Passing event to transaction failed: sendOk(%t) timedOut(%t)", sendOk, timedOut) + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, trans, subs)) } return } -func (c *Control) handleSubscriptionDeleteRequestTimer(subId uint16) { - xapp.Logger.Info("Subscription Delete Request timer expired. SubId: %v",subId) -/* - transaction, err := c.tracker.completeTransaction(subId, DELETE) +//------------------------------------------------------------------- +// handle from E2T Subscription Delete Failure +//------------------------------------------------------------------- +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("Failed to delete a Subscription Delete Request transaction record due to %v", err) + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params)) return } - xapp.Logger.Info("SubId: %v, Xid %v, Meid: %v",subId, transaction.OrigParams.Xid, transaction.OrigParams.Meid) - - var params xapp.RMRParams - params.Mtype = 12022 //xapp.RICMessageTypes["RIC_SUB_DEL_FAILURE"] - params.SubId = int(subId) - params.Meid = transaction.OrigParams.Meid - params.Xid = transaction.OrigParams.Xid - payload := []byte("40CA4018000003EA7E00050000010016EA6300020021EA74000200C0") - params.PayloadLen = len(payload) - params.Payload = payload - - xapp.Logger.Info("Forwarding Subscription Delete Failure to UEEC: Mtype: %v, SubId: %v, Xid: %s, Meid: %v",params.Mtype, params.SubId, params.Xid, params.Meid) - err = c.rmrReplyToSender(¶ms) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelFailMsg.RequestId.Seq}) if err != nil { - xapp.Logger.Error("Failed to send response to requestor %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid) + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params)) + return } -*/ -/* - time.Sleep(3 * time.Second) - xapp.Logger.Info("Subscription ID: %v, from address: %v:%v. Deleting transaction record", int(subId), transaction.XappInstanceAddress, transaction.XappPort) - - xapp.Logger.Info("Starting routing manager update") - subRouteAction := SubRouteInfo{DELETE, transaction.XappInstanceAddress, transaction.XappPort, payloadSeqNum} - c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) - - xapp.Logger.Info("Deleting trancaction record") - if c.registry.releaseSequenceNumber(payloadSeqNum) { - transaction, err = c.tracker.completeTransaction(payloadSeqNum, DELETE) - if err != nil { - xapp.Logger.Error("Failed to delete a Subscription Delete Request transaction record due to %v", err) - return - } + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params, subs)) + return + } + sendOk, timedOut := trans.SendEvent(subDelFailMsg, e2tRecvMsgTimeout) + if sendOk == false { + err = fmt.Errorf("Passing event to transaction failed: sendOk(%t) timedOut(%t)", sendOk, timedOut) + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, trans, subs)) } -*/ return +} + +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func typeofSubsMessage(v interface{}) string { + if v == nil { + return "NIL" + } + switch v.(type) { + case *e2ap.E2APSubscriptionRequest: + return "SubReq" + case *e2ap.E2APSubscriptionResponse: + return "SubResp" + case *e2ap.E2APSubscriptionFailure: + return "SubFail" + case *e2ap.E2APSubscriptionDeleteRequest: + return "SubDelReq" + case *e2ap.E2APSubscriptionDeleteResponse: + return "SubDelResp" + case *e2ap.E2APSubscriptionDeleteFailure: + return "SubDelFail" + default: + return "Unknown" } +}