X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=pkg%2Fcontrol%2Fcontrol.go;h=1d64f3c64bbf17c77fd2be1235800275b732bbd2;hb=83ada00338d2c9fa47d48c406b4a46b9d7888aff;hp=fc45f6f20c04421350bb4347f6060d1490440195;hpb=ff8dccd02d76eebfccc0b509ce0b42a2c1760e12;p=ric-plt%2Fsubmgr.git diff --git a/pkg/control/control.go b/pkg/control/control.go old mode 100644 new mode 100755 index fc45f6f..1d64f3c --- a/pkg/control/control.go +++ b/pkg/control/control.go @@ -19,32 +19,36 @@ 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/xapp-frame/pkg/xapp" httptransport "github.com/go-openapi/runtime/client" "github.com/go-openapi/strfmt" "github.com/spf13/viper" - "math/rand" "sync" "time" ) -var subReqTime time.Duration = 5 * time.Second -var SubDelReqTime time.Duration = 5 * time.Second +//----------------------------------------------------------------------------- +// +//----------------------------------------------------------------------------- + +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 e2tRecvMsgTimeout time.Duration = 5 * time.Second type Control struct { - e2ap *E2ap - registry *Registry - rtmgrClient *RtmgrClient - tracker *Tracker - timerMap *TimerMap - rmrSendMutex sync.Mutex - skipRouteUpdate bool // temp solution to skip routeupdate in unittests + e2ap *E2ap + registry *Registry + tracker *Tracker + timerMap *TimerMap + rmrSendMutex sync.Mutex + msgCounter uint64 } type RMRMeid struct { @@ -53,34 +57,21 @@ type RMRMeid struct { RanName string } -var seedSN uint16 - -const ( - CREATE Action = 0 - MERGE Action = 1 - NONE Action = 2 - DELETE Action = 3 -) - func init() { - xapp.Logger.Info("SUBMGR /ric-plt-submgr:r3-test-v4") + 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 { + + 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() @@ -88,18 +79,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} - return &Control{e2ap: new(E2ap), - registry: registry, - rtmgrClient: &rtmgrClient, - tracker: tracker, - timerMap: timerMap, - skipRouteUpdate: false, + registry: registry, + tracker: tracker, + timerMap: timerMap, + msgCounter: 0, } } @@ -107,521 +91,466 @@ func (c *Control) Run() { xapp.Run(c) } -func (c *Control) rmrSend(params *xapp.RMRParams) (err error) { +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, false) + status = xapp.Rmr.Send(params.RMRParams, false) c.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) + xapp.Logger.Info("rmr.Send() failed. Retry count %d, %s", i, params.String()) time.Sleep(500 * time.Millisecond) } } if status == false { - err = errors.New("rmr.Send() failed") + 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) rmrReplyToSender(params *xapp.RMRParams) (err error) { - c.rmrSend(params) - return +func (c *Control) rmrSendToE2T(desc string, subs *Subscription, trans *TransactionSubs) (err error) { + params := &RMRParams{&xapp.RMRParams{}} + 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 + + return c.rmrSendRaw("MSG to E2T:"+desc+":"+trans.String(), params) +} + +func (c *Control) rmrSendToXapp(desc string, subs *Subscription, trans *TransactionXapp) (err error) { + + params := &RMRParams{&xapp.RMRParams{}} + 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 + + return c.rmrSendRaw("MSG to XAPP:"+desc+":"+trans.String(), params) } -func (c *Control) Consume(msg *xapp.RMRParams) (err error) { +func (c *Control) Consume(params *xapp.RMRParams) (err error) { + xapp.Rmr.Free(params.Mbuf) + params.Mbuf = nil + msg := &RMRParams{params} + c.msgCounter++ + switch msg.Mtype { case xapp.RICMessageTypes["RIC_SUB_REQ"]: - go c.handleSubscriptionRequest(msg) + go c.handleXAPPSubscriptionRequest(msg) case xapp.RICMessageTypes["RIC_SUB_RESP"]: - go c.handleSubscriptionResponse(msg) + go c.handleE2TSubscriptionResponse(msg) case xapp.RICMessageTypes["RIC_SUB_FAILURE"]: - go c.handleSubscriptionFailure(msg) + go c.handleE2TSubscriptionFailure(msg) case xapp.RICMessageTypes["RIC_SUB_DEL_REQ"]: - go c.handleSubscriptionDeleteRequest(msg) + go c.handleXAPPSubscriptionDeleteRequest(msg) case xapp.RICMessageTypes["RIC_SUB_DEL_RESP"]: - go c.handleSubscriptionDeleteResponse(msg) + go c.handleE2TSubscriptionDeleteResponse(msg) case xapp.RICMessageTypes["RIC_SUB_DEL_FAILURE"]: - go c.handleSubscriptionDeleteFailure(msg) + go c.handleE2TSubscriptionDeleteFailure(msg) default: xapp.Logger.Info("Unknown Message Type '%d', discarding", msg.Mtype) } + return nil } -func (c *Control) handleSubscriptionRequest(params *xapp.RMRParams) { - xapp.Logger.Info("SubReq 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 - - /* Reserve a sequence number and set it in the payload */ - newSubId, isIdValid := c.registry.ReserveSequenceNumber() - if isIdValid != true { - xapp.Logger.Error("SubReq: Failed to reserve sequence number. Dropping this msg. SubId: %v, Xid: %s", params.SubId, params.Xid) - return - } - - err := c.e2ap.SetSubscriptionRequestSequenceNumber(params.Payload, newSubId) - if err != nil { - xapp.Logger.Error("SubReq: Unable to set Sequence Number in Payload. Dropping this msg. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return - } - - srcAddr, srcPort, err := c.rtmgrClient.SplitSource(params.Src) - if err != nil { - xapp.Logger.Error("SubReq: Failed to update routing-manager. Dropping this msg. Err: %s, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return +func idstring(err error, entries ...fmt.Stringer) string { + var retval string = "" + var filler string = "" + for _, entry := range entries { + retval += filler + entry.String() + filler = " " } - - /* 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("SubReq: Failed to create transaction record. Dropping this msg. Err: %v SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return - } - - /* Update routing manager about the new subscription*/ - subRouteAction := SubRouteInfo{CREATE, *srcAddr, *srcPort, newSubId} - xapp.Logger.Info("SubReq: Starting routing manager update. SubId: %v, Xid: %s", params.SubId, params.Xid) - - if c.skipRouteUpdate == false { - err = c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) - if err != nil { - xapp.Logger.Error("SubReq: Failed to update routing manager. Dropping this SubReq msg. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return - } - } + retval += filler + "err(" + err.Error() + ")" + filler = " " - // Setting new subscription ID in the RMR header - params.SubId = int(newSubId) - xapp.Logger.Info("Forwarding SubReq 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("SubReq: Failed to send request to E2T %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - } else { - c.timerMap.StartTimer("RIC_SUB_REQ", int(newSubId), subReqTime, c.handleSubscriptionRequestTimer) } - xapp.Logger.Debug("SubReq: Debugging transaction table = %v", c.tracker.transactionTable) - return + return retval } -func (c *Control) handleSubscriptionResponse(params *xapp.RMRParams) { - xapp.Logger.Info("SubResp 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 *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 { - xapp.Logger.Error("SubResp: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v", err, params.SubId) + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, params)) return } - xapp.Logger.Info("SubResp: Received payloadSeqNum: %v", payloadSeqNum) - if !c.registry.IsValidSequenceNumber(payloadSeqNum) { - xapp.Logger.Error("SubResp: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) + trans := c.tracker.NewXappTransaction(NewRmrEndpoint(params.Src), params.Xid, &RequestId{subReqMsg.RequestId}, 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("RIC_SUB_REQ", int(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("SubResp: Failed to retrive transaction record. Dropping this msg. Err: %v, SubId: %v", err, params.SubId) + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) return } - xapp.Logger.Info("SubResp: SubId: %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("SubResp: Forwarding Subscription Response to xApp Mtype: %v, SubId: %v, Meid: %v", params.Mtype, params.SubId, params.Meid) - err = c.rmrReplyToSender(params) + subs, err := c.registry.AssignToSubscription(trans, subReqMsg) if err != nil { - xapp.Logger.Error("SubResp: Failed to send response to xApp. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) + return } - xapp.Logger.Info("SubResp: SubId: %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("SubResp: Failed to delete transaction record. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - 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 { + 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)) + go c.registry.RemoveFromSubscription(subs, trans, 5*time.Second) } -func (c *Control) handleSubscriptionFailure(params *xapp.RMRParams) { - xapp.Logger.Info("SubFail 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 *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 { - xapp.Logger.Error("SubFail: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v", err, params.SubId) + xapp.Logger.Error("XAPP-SubDelReq %s", idstring(err, params)) return } - xapp.Logger.Info("SubFail: Received payloadSeqNum: %v", payloadSeqNum) - c.timerMap.StopTimer("RIC_SUB_REQ", int(payloadSeqNum)) + trans := c.tracker.NewXappTransaction(NewRmrEndpoint(params.Src), params.Xid, &RequestId{subDelReqMsg.RequestId}, params.Meid) + if trans == nil { + xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(fmt.Errorf("transaction not created"), params)) + return + } + defer trans.Release() - var transaction Transaction - transaction, err = c.tracker.RetriveTransaction(payloadSeqNum, CREATE) + err = c.tracker.Track(trans) if err != nil { - xapp.Logger.Error("SubFail: Failed to retrive transaction record. Dropping this msg. Err: %v, SubId: %v", err, params.SubId) + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) return } - xapp.Logger.Info("SubFail: SubId: %v, from address: %v:%v. Forwarding response to xApp", int(payloadSeqNum), transaction.XappInstanceAddress, transaction.XappPort) - - params.SubId = int(payloadSeqNum) - params.Xid = transaction.OrigParams.Xid - xapp.Logger.Info("Forwarding SubFail to xApp: 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{subDelReqMsg.RequestId.Seq}) if err != nil { - xapp.Logger.Error("Failed to send response to xApp. Err: %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 - if c.skipRouteUpdate == false { - xapp.Logger.Info("SubFail: Starting routing manager update. SubId: %v, Xid: %s", params.SubId, params.Xid) - subRouteAction := SubRouteInfo{CREATE, transaction.XappInstanceAddress, transaction.XappPort, payloadSeqNum} - err = c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) - if err != nil { - xapp.Logger.Error("SubFail: Failed to update routing manager. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - } + xapp.Logger.Debug("XAPP-SubDelReq: Handling event %s ", idstring(nil, trans, subs)) + + // Whatever is received send ok delete response + subDelRespMsg := &e2ap.E2APSubscriptionDeleteResponse{} + subDelRespMsg.RequestId = subs.SubReqMsg.RequestId + subDelRespMsg.FunctionId = subs.SubReqMsg.FunctionId + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionDeleteResponse(subDelRespMsg) + if err == nil { + c.rmrSendToXapp("", subs, trans) } - xapp.Logger.Info("SubFail: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - if c.registry.releaseSequenceNumber(payloadSeqNum) { - transaction, err = c.tracker.completeTransaction(payloadSeqNum, CREATE) - if err != nil { - xapp.Logger.Error("SubFail: Failed to delete transaction record. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return + go c.registry.RemoveFromSubscription(subs, trans, 5*time.Second) +} + +//------------------------------------------------------------------- +// 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 { + 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) } + xapp.Logger.Debug("SUBS-SubReq: Handling (e2t response %s) %s", typeofSubsMessage(subRfMsg), idstring(nil, trans, subs, parentTrans)) } else { - xapp.Logger.Error("SubFail: Failed to release sequency number. SubId: %v, Xid: %s", params.SubId, params.Xid) - return + xapp.Logger.Debug("SUBS-SubReq: Handling (cached response %s) %s", typeofSubsMessage(subRfMsg), idstring(nil, trans, subs, parentTrans)) } - return -} -func (c *Control) handleSubscriptionRequestTimer(strId string, nbrId int) { - newSubId := uint16(nbrId) - xapp.Logger.Info("SubReq timer expired. newSubId: %v", newSubId) - // var causeContent uint8 = 1 // just some random cause. To be checked later. Should be no respose or something - // var causeVal uint8 = 1 // just some random val. To be checked later. Should be no respose or something - // c.sendSubscriptionFailure(newSubId, causeContent, causeVal) + parentTrans.SendEvent(subRfMsg, 0) } -/* -func (c *Control) sendSubscriptionFailure(subId uint16, causeContent uint8, causeVal uint8) { - - transaction, err := c.tracker.completeTransaction(subId, CREATE) - if err != nil { - xapp.Logger.Error("SendSubFail: Failed to delete transaction record. Err:%v. SubId: %v", err, subId) - return - } - xapp.Logger.Info("SendSubFail: SubId: %v, Xid %v, Meid: %v", subId, transaction.OrigParams.Xid, transaction.OrigParams.Meid) +//------------------------------------------------------------------- +// SUBS DELETE Handling +//------------------------------------------------------------------- - 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 +func (c *Control) handleSubscriptionDelete(subs *Subscription, parentTrans *TransactionXapp) { -// newPayload, packErr := c.e2ap.PackSubscriptionFailure(transaction.OrigParams.Payload, subId, causeContent, causeVal) -// if packErr != nil { -// xapp.Logger.Error("SendSubFail: PackSubscriptionFailure() due to %v", packErr) -// return -// } + trans := c.tracker.NewSubsTransaction(subs) + subs.WaitTransactionTurn(trans) + defer subs.ReleaseTransactionTurn(trans) + defer trans.Release() - newPayload := []byte("40CA4018000003EA7E00050000010016EA6300020021EA74000200C0") // Temporary solution + xapp.Logger.Debug("SUBS-SubDelReq: Handling %s", idstring(nil, trans, subs, parentTrans)) - params.PayloadLen = len(newPayload) - params.Payload = newPayload - - xapp.Logger.Info("SendSubFail: Forwarding failure to xApp: 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("SendSubFail: Failed to send response to xApp. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) + 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() } - time.Sleep(3 * time.Second) - - xapp.Logger.Info("SendSubFail: SubId: %v, from address: %v:%v. Deleting transaction record", int(subId), transaction.XappInstanceAddress, transaction.XappPort) + subDelRespMsg := &e2ap.E2APSubscriptionDeleteResponse{} + subDelRespMsg.RequestId = subs.SubReqMsg.RequestId + subDelRespMsg.FunctionId = subs.SubReqMsg.FunctionId + parentTrans.SendEvent(subDelRespMsg, 0) +} - xapp.Logger.Info("SubReqTimer: Starting routing manager update. SubId: %v, Xid: %s", params.SubId, params.Xid) - subRouteAction := SubRouteInfo{DELETE, transaction.XappInstanceAddress, transaction.XappPort, subId} - err = c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) +//------------------------------------------------------------------- +// 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("SendSubFail: Failed to update routing manager %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return + xapp.Logger.Error("SUBS-SubReq: %s", idstring(err, trans, subs, parentTrans)) + return event } - xapp.Logger.Info("SendSubFail: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - if c.registry.releaseSequenceNumber(subId) { - transaction, err = c.tracker.completeTransaction(subId, CREATE) - if err != nil { - xapp.Logger.Error("SendSubFail: Failed to delete transaction record. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return + 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 } - } else { - xapp.Logger.Error("SendSubFail: Failed to release sequency number. SubId: %v, Xid: %s", params.SubId, params.Xid) + break } - return + xapp.Logger.Debug("SUBS-SubReq: Response handling event(%s) %s", typeofSubsMessage(event), idstring(nil, trans, subs, parentTrans)) + return event } -*/ -func (act Action) String() string { - actions := [...]string{ - "CREATE", - "MERGE", - "NONE", - "DELETE", - } +//------------------------------------------------------------------- +// send to E2T Subscription Delete Request +//------------------------------------------------------------------- - if act < CREATE || act > DELETE { - return "Unknown" +func (c *Control) sendE2TSubscriptionDeleteRequest(subs *Subscription, trans *TransactionSubs, parentTrans *TransactionXapp) interface{} { + var err error + var event interface{} + var timedOut bool + + 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 { + xapp.Logger.Error("SUBS-SubDelReq: %s", idstring(err, trans, subs, parentTrans)) + return event } - return actions[act] -} -func (act Action) valid() bool { - switch act { - case CREATE, MERGE, DELETE: - return true - default: - return false + 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.Debug("SUBS-SubDelReq: Response handling event(%s) %s", typeofSubsMessage(event), idstring(nil, trans, subs, parentTrans)) + return event } -func (c *Control) handleSubscriptionDeleteRequest(params *xapp.RMRParams) { - xapp.Logger.Info("SubDelReq 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 - - payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteRequestSequenceNumber(params.Payload) +//------------------------------------------------------------------- +// handle from E2T Subscription Reponse +//------------------------------------------------------------------- +func (c *Control) handleE2TSubscriptionResponse(params *RMRParams) { + xapp.Logger.Info("MSG from E2T: %s", params.String()) + subRespMsg, err := c.e2ap.UnpackSubscriptionResponse(params.Payload) if err != nil { - xapp.Logger.Error("SubDelReq: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) + xapp.Logger.Error("MSG-SubResp %s", idstring(err, params)) return } - xapp.Logger.Info("SubDelReq: Received payloadSeqNum: %v", payloadSeqNum) - - if c.registry.IsValidSequenceNumber(payloadSeqNum) { - c.registry.deleteSubscription(payloadSeqNum) - err = c.trackDeleteTransaction(params, payloadSeqNum) - if err != nil { - xapp.Logger.Error("SubDelReq: Failed to create transaction record. Dropping this msg. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return - } - } else { - xapp.Logger.Error("SubDelReq: Not valid sequence number. Dropping this msg. SubId: %v, Xid: %s", params.SubId, params.Xid) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subRespMsg.RequestId.Seq}) + if err != nil { + xapp.Logger.Error("MSG-SubResp: %s", idstring(err, params)) return } - - xapp.Logger.Info("SubDelReq: Forwarding 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("SubDelReq: Failed to send request to E2T. Err %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - } else { - c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(payloadSeqNum), subReqTime, c.handleSubscriptionDeleteRequestTimer) + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubResp: %s", idstring(err, params, subs)) + return } - return -} - -func (c *Control) trackDeleteTransaction(params *xapp.RMRParams, payloadSeqNum uint16) (err error) { - srcAddr, srcPort, err := c.rtmgrClient.SplitSource(params.Src) - if err != nil { - xapp.Logger.Error("SubDelReq: Failed to update routing-manager. Err: %s, SubId: %v, Xid: %s", err, params.SubId, params.Xid) + 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("SubDelResp 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 *RMRParams) { + xapp.Logger.Info("MSG from E2T: %s", params.String()) + subFailMsg, err := c.e2ap.UnpackSubscriptionFailure(params.Payload) if err != nil { - xapp.Logger.Error("SubDelResp: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v", err, params.SubId) + xapp.Logger.Error("MSG-SubFail %s", idstring(err, params)) return } - xapp.Logger.Info("SubDelResp: Received payloadSeqNum: %v", payloadSeqNum) - - c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(payloadSeqNum)) - - var transaction Transaction - transaction, err = c.tracker.RetriveTransaction(payloadSeqNum, DELETE) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subFailMsg.RequestId.Seq}) if err != nil { - xapp.Logger.Error("SubDelResp: Failed to retrive transaction record. Dropping this msg. Err: %v, SubId: %v", err, params.SubId) + xapp.Logger.Error("MSG-SubFail: %s", idstring(err, params)) return } - xapp.Logger.Info("SubDelResp: SubId: %v, from address: %v:%v. Forwarding response to xApp", int(payloadSeqNum), transaction.XappInstanceAddress, transaction.XappPort) - - params.SubId = int(payloadSeqNum) - params.Xid = transaction.OrigParams.Xid - xapp.Logger.Info("Forwarding SubDelResp to xApp: 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("SubDelResp: Failed to send response to xApp. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - // return - } - - time.Sleep(3 * time.Second) - - if c.skipRouteUpdate == false { - xapp.Logger.Info("SubDelResp: Starting routing manager update. SubId: %v, Xid: %s", params.SubId, params.Xid) - subRouteAction := SubRouteInfo{DELETE, transaction.XappInstanceAddress, transaction.XappPort, payloadSeqNum} - err = c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) - if err != nil { - xapp.Logger.Error("SubDelResp: Failed to update routing manager. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return - } - } - - xapp.Logger.Info("SubDelResp: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - if c.registry.releaseSequenceNumber(payloadSeqNum) { - transaction, err = c.tracker.completeTransaction(payloadSeqNum, DELETE) - if err != nil { - xapp.Logger.Error("SubDelResp: Failed to delete transaction record. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return - } - } else { - xapp.Logger.Error("SubDelResp: Failed to release sequency number. SubId: %v, Xid: %s", params.SubId, params.Xid) + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubFail: %s", idstring(err, params, subs)) 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) { - xapp.Logger.Info("SubDelFail 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 *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("SubDelFail: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v", err, params.SubId) + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params)) return } - xapp.Logger.Info("SubDelFail: Received payloadSeqNum: %v", payloadSeqNum) - - c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(payloadSeqNum)) - - var transaction Transaction - transaction, err = c.tracker.RetriveTransaction(payloadSeqNum, DELETE) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelRespMsg.RequestId.Seq}) if err != nil { - xapp.Logger.Error("SubDelFail: Failed to retrive transaction record. Dropping msg. Err %v, SubId: %v", err, params.SubId) + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params)) return } - xapp.Logger.Info("SubDelFail: SubId: %v, from address: %v:%v. Forwarding response to xApp", int(payloadSeqNum), transaction.XappInstanceAddress, transaction.XappPort) - - params.SubId = int(payloadSeqNum) - params.Xid = transaction.OrigParams.Xid - xapp.Logger.Info("Forwarding SubDelFail to xApp: 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 SubDelFail to xApp. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - // return - } - - time.Sleep(3 * time.Second) - - if c.skipRouteUpdate == false { - xapp.Logger.Info("SubDelFail: Starting routing manager update. SubId: %v, Xid: %s", params.SubId, params.Xid) - subRouteAction := SubRouteInfo{DELETE, transaction.XappInstanceAddress, transaction.XappPort, payloadSeqNum} - c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) - if err != nil { - xapp.Logger.Error("SubDelFail: Failed to update routing manager. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return - } - } - - xapp.Logger.Info("SubDelFail: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - if c.registry.releaseSequenceNumber(payloadSeqNum) { - transaction, err = c.tracker.completeTransaction(payloadSeqNum, DELETE) - if err != nil { - xapp.Logger.Error("SubDelFail: Failed to delete transaction record. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return - } - } else { - xapp.Logger.Error("SubDelFail: Failed to release sequency number. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params, subs)) 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(strId string, nbrId int) { - newSubId := uint16(nbrId) - xapp.Logger.Info("SubDelReq timer expired. newSubId: %v", newSubId) - // var causeContent uint8 = 1 // just some random cause. To be checked later. Should be no respose or something - // var causeVal uint8 = 1 // just some random val. To be checked later. Should be no respose or something - // c.sendSubscriptionDeleteFailure(newSubId, causeContent, causeVal) -} - -/* -func (c *Control) sendSubscriptionDeleteFailure(subId uint16, causeContent uint8, causeVal uint8) { - transaction, err := c.tracker.completeTransaction(subId, DELETE) +//------------------------------------------------------------------- +// handle from E2T Subscription Delete Failure +//------------------------------------------------------------------- +func (c *Control) handleE2TSubscriptionDeleteFailure(params *RMRParams) { + xapp.Logger.Info("MSG from E2T: %s", params.String()) + subDelFailMsg, err := c.e2ap.UnpackSubscriptionDeleteFailure(params.Payload) if err != nil { - xapp.Logger.Error("SendSubDelFail: Failed to delete transaction record. Err: %v, newSubId: %v", err, subId) + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params)) return } - xapp.Logger.Info("SendSubDelFail: 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 - -// newPayload, packErr := c.e2ap.PackSubscriptionDeleteFailure(transaction.OrigParams.Payload, subId, causeContent, causeVal) -// if packErr != nil { -// xapp.Logger.Error("SendSubDelFail: PackSubscriptionDeleteFailure(). Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid)) -// return -// } - - newPayload := []byte("40CA4018000003EA7E00050000010016EA6300020021EA74000200C0") // Temporary solution - - params.PayloadLen = len(newPayload) - params.Payload = newPayload - - xapp.Logger.Info("SendSubDelFail: Forwarding failure to xApp: 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("SendSubDelFail: Failed to send response to xApp: Err: %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("SendSubDelFail: SubId: %v, from address: %v:%v. Deleting transaction record", int(subId), transaction.XappInstanceAddress, transaction.XappPort) - - xapp.Logger.Info("SendSubDelFail: Starting routing manager update. SubId: %v, Xid: %s", params.SubId, params.Xid) - subRouteAction := SubRouteInfo{DELETE, transaction.XappInstanceAddress, transaction.XappPort, subId} - err = c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) - if err != nil { - xapp.Logger.Error("SendSubDelFail: Failed to update routing manager. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params, subs)) return } - - xapp.Logger.Info("SendSubDelFail: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - if c.registry.releaseSequenceNumber(subId) { - transaction, err = c.tracker.completeTransaction(subId, DELETE) - if err != nil { - xapp.Logger.Error("SendSubDelFail: Failed to delete transaction record. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - return - } - } else { - xapp.Logger.Error("SendSubDelFail: Failed to release sequency number. SubId: %v, Xid: %s", params.SubId, params.Xid) + 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" + } +}