X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=pkg%2Fcontrol%2Fcontrol.go;h=c2b33b765ca87737f2d19ec7a756454c2c4333ad;hb=af91f971681842c22dc0fad165c0cbf7ebaa0e4d;hp=5a38656ff77cac99ea7f8e175c0d5f89844a2b58;hpb=0d064ecdb5239a875857b5910f7f6e83f827d7a6;p=ric-plt%2Fsubmgr.git diff --git a/pkg/control/control.go b/pkg/control/control.go index 5a38656..c2b33b7 100755 --- a/pkg/control/control.go +++ b/pkg/control/control.go @@ -20,27 +20,31 @@ package control 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 maxSubReqTryCount uint64 = 2 // Initial try + retry -var maxSubDelReqTryCount uint64 = 2 // Initial try + retry +//----------------------------------------------------------------------------- +// +//----------------------------------------------------------------------------- + +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 @@ -53,11 +57,9 @@ type RMRMeid struct { RanName string } -var seedSN uint16 - const ( CREATE Action = 0 - MERGE Action = 1 + UPDATE Action = 1 NONE Action = 2 DELETE Action = 3 ) @@ -67,20 +69,16 @@ func init() { 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 +86,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, - msgCounter: 0, + registry: registry, + tracker: tracker, + timerMap: timerMap, + msgCounter: 0, } } @@ -107,567 +98,459 @@ 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) rmrSend(desc string, subs *Subscription, trans *Transaction) (err error) { + params := &RMRParams{&xapp.RMRParams{}} + params.Mtype = trans.GetMtype() + params.SubId = int(subs.GetSubId()) + 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(desc, params) } -func (c *Control) Consume(msg *xapp.RMRParams) (err error) { +func (c *Control) rmrReplyToSender(desc string, subs *Subscription, trans *Transaction) (err error) { + params := &RMRParams{&xapp.RMRParams{}} + params.Mtype = trans.GetMtype() + params.SubId = int(subs.GetSubId()) + 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(desc, params) +} + +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 - - 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(trans fmt.Stringer, subs fmt.Stringer, err error) string { + var retval string = "" + var filler string = "" + if trans != nil { + retval += filler + trans.String() + filler = " " } - - /* Reserve a sequence number and set it in the payload */ - subs := c.registry.ReserveSubscription(RmrEndpoint{*srcAddr, *srcPort}, params.Meid) - if subs == nil { - xapp.Logger.Error("SubReq: Failed to reserve sequence number. Dropping this msg. SubId: %v, Xid: %s", params.SubId, params.Xid) - return + if subs != nil { + retval += filler + subs.String() + filler = " " } - - params.SubId = int(subs.Seq) - err = c.e2ap.SetSubscriptionRequestSequenceNumber(params.Payload, subs.Seq) if err != nil { - xapp.Logger.Error("SubReq: 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) - c.registry.releaseSequenceNumber(subs.Seq) - return - } + retval += filler + "err(" + err.Error() + ")" + filler = " " - // Create transatcion record for every subscription request - var forwardRespToXapp bool = true - var responseReceived bool = false - _, err = c.tracker.TrackTransaction(subs, RmrEndpoint{*srcAddr, *srcPort}, params, responseReceived, forwardRespToXapp) - if err != nil { - xapp.Logger.Error("SubReq: %s, Dropping this msg.", err.Error()) - c.registry.releaseSequenceNumber(subs.Seq) - return } + return retval +} - // Update routing manager about the new subscription - subRouteAction := subs.SubRouteInfo(CREATE) - xapp.Logger.Info("SubReq: Starting routing manager update. SubId: %v, Xid: %s", params.SubId, params.Xid) +//------------------------------------------------------------------- +// handle from XAPP Subscription Request +//------------------------------------------------------------------ +func (c *Control) handleXAPPSubscriptionRequest(params *RMRParams) { + xapp.Logger.Info("XAPP-SubReq from xapp: %s", params.String()) - err = c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) + subReqMsg, err := c.e2ap.UnpackSubscriptionRequest(params.Payload) if err != nil { - xapp.Logger.Error("SubReq: Failed to update routing manager. Dropping this msg. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - c.registry.releaseSequenceNumber(subs.Seq) + xapp.Logger.Error("XAPP-SubReq: %s", idstring(params, nil, err)) return } - // Setting new subscription ID in the RMR header - xapp.Logger.Info("SubReq: 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) - } - c.timerMap.StartTimer("RIC_SUB_REQ", int(subs.Seq), subReqTime, FirstTry, c.handleSubscriptionRequestTimer) - xapp.Logger.Debug("SubReq: Debugging transaction table = %v", c.tracker.transactionXappTable) - return -} - -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 - - payloadSeqNum, err := c.e2ap.GetSubscriptionResponseSequenceNumber(params.Payload) + trans, err := c.tracker.TrackTransaction(NewRmrEndpoint(params.Src), params.Xid, params.Meid) 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("XAPP-SubReq: %s", idstring(params, nil, err)) return } - xapp.Logger.Info("SubResp: Received payloadSeqNum: %v", payloadSeqNum) + defer trans.Release() - subs := c.registry.GetSubscription(payloadSeqNum) - if subs == nil { - xapp.Logger.Error("SubResp: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) + subs, err := c.registry.AssignToSubscription(trans, subReqMsg) + if err != nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(trans, nil, err)) return } - transaction := subs.GetTransaction() - - c.timerMap.StopTimer("RIC_SUB_REQ", int(payloadSeqNum)) - - responseReceived := transaction.CheckResponseReceived() - if responseReceived == true { - // Subscription timer already received + if subs.IsTransactionReserved() { + err := fmt.Errorf("Currently parallel or queued transactions are not allowed") + xapp.Logger.Error("XAPP-SubReq: %s", idstring(trans, subs, err)) return } - xapp.Logger.Info("SubResp: SubId: %v, from address: %s.", payloadSeqNum, transaction.RmrEndpoint) - subs.Confirmed() - transaction.Release() + // + // Wake subs request + // + go c.handleSubscriptionCreate(subs, trans) + event, _ := trans.WaitEvent(0) //blocked wait as timeout is handled in subs side - 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) - if err != nil { - xapp.Logger.Error("SubResp: Failed to send response to xApp. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) + 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.rmrReplyToSender("XAPP-SubReq: SubResp to xapp", subs, trans) + return + } + case *e2ap.E2APSubscriptionFailure: + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionFailure(themsg) + if err == nil { + c.rmrReplyToSender("XAPP-SubReq: SubFail to xapp", subs, trans) + } + return + default: + break + } } - - xapp.Logger.Info("SubResp: SubId: %v, from address: %s. Deleting transaction record", payloadSeqNum, transaction.RmrEndpoint) - return + xapp.Logger.Info("XAPP-SubReq: failed %s", idstring(trans, subs, err)) } -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("XAPP-SubDelReq 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, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload) + xapp.Logger.Error("XAPP-SubDelReq %s", idstring(params, nil, err)) return } - xapp.Logger.Info("SubFail: Received payloadSeqNum: %v", payloadSeqNum) - subs := c.registry.GetSubscription(payloadSeqNum) - if subs == nil { - xapp.Logger.Error("SubFail: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) - return - } - - transaction := subs.GetTransaction() - if transaction == nil { - xapp.Logger.Error("SubFail: Unknown transaction. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) + trans, err := c.tracker.TrackTransaction(NewRmrEndpoint(params.Src), params.Xid, params.Meid) + if err != nil { + xapp.Logger.Error("XAPP-SubDelReq %s", idstring(params, nil, err)) return } + defer trans.Release() - c.timerMap.StopTimer("RIC_SUB_REQ", int(payloadSeqNum)) - - responseReceived := transaction.CheckResponseReceived() + subs, err := c.registry.GetSubscriptionFirstMatch([]uint16{uint16(subDelReqMsg.RequestId.Seq), uint16(params.SubId)}) if err != nil { - xapp.Logger.Info("SubFail: Dropping this msg. Err: %v SubId: %v", err, payloadSeqNum) + xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(trans, nil, err)) return } - if responseReceived == true { - // Subscription timer already received + if subs.IsTransactionReserved() { + err := fmt.Errorf("Currently parallel or queued transactions are not allowed") + xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(trans, subs, err)) return } - xapp.Logger.Info("SubFail: SubId: %v, from address: %s. Forwarding response to xApp", payloadSeqNum, transaction.RmrEndpoint) - 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("SubFail: Starting routing manager update. SubId: %v, Xid: %s", params.SubId, params.Xid) - subRouteAction := subs.SubRouteInfo(DELETE) - 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) + // Whatever is received send ok delete response + subDelRespMsg := &e2ap.E2APSubscriptionDeleteResponse{} + subDelRespMsg.RequestId.Id = subs.SubReqMsg.RequestId.Id + subDelRespMsg.RequestId.Seq = uint32(subs.GetSubId()) + subDelRespMsg.FunctionId = subs.SubReqMsg.FunctionId + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionDeleteResponse(subDelRespMsg) + if err == nil { + c.rmrReplyToSender("XAPP-SubDelReq: SubDelResp to xapp", subs, trans) } - - xapp.Logger.Info("SubFail: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - transaction.Release() - if !c.registry.releaseSequenceNumber(payloadSeqNum) { - xapp.Logger.Error("SubFail: Failed to release sequency number. SubId: %v, Xid: %s", params.SubId, params.Xid) - } - return } -func (c *Control) handleSubscriptionRequestTimer(strId string, nbrId int, tryCount uint64) { - subId := uint16(nbrId) - xapp.Logger.Info("handleSubTimer: SubReq timer expired. subId: %v, tryCount: %v", subId, tryCount) +//------------------------------------------------------------------- +// SUBS CREATE Handling +//------------------------------------------------------------------- +func (c *Control) handleSubscriptionCreate(subs *Subscription, parentTrans *Transaction) { - subs := c.registry.GetSubscription(subId) - if subs == nil { - xapp.Logger.Error("SubFail: Unknown payloadSeqNum. Dropping this msg. SubId: %v", subId) - return - } + trans := c.tracker.NewTransaction(subs.GetMeid()) + subs.WaitTransactionTurn(trans) + defer subs.ReleaseTransactionTurn(trans) + defer trans.Release() - transaction := subs.GetTransaction() - if transaction == nil { - xapp.Logger.Error("SubFail: Unknown transaction. Dropping this msg. SubId: %v", subId) - return - } - - responseReceived := transaction.CheckResponseReceived() + xapp.Logger.Debug("SUBS-SubReq: Handling %s parent %s", idstring(trans, subs, nil), parentTrans.String()) - if responseReceived == true { - // Subscription Response or Failure already received + if subs.SubRespMsg != nil { + xapp.Logger.Debug("SUBS-SubReq: Handling (immediate response) %s parent %s", idstring(nil, subs, nil), parentTrans.String()) + parentTrans.SendEvent(subs.SubRespMsg, 0) return } - if tryCount < maxSubReqTryCount { - xapp.Logger.Info("handleSubTimer: Resending SubReq to E2T: Mtype: %v, SubId: %v, Xid %s, Meid %v", transaction.OrigParams.Mtype, transaction.OrigParams.SubId, transaction.OrigParams.Xid, transaction.OrigParams.Meid) - - transaction.RetryTransaction() - - err := c.rmrSend(transaction.OrigParams) - if err != nil { - xapp.Logger.Error("handleSubTimer: Failed to send request to E2T %v, SubId: %v, Xid: %s", err, transaction.OrigParams.SubId, transaction.OrigParams.Xid) - } - - tryCount++ - c.timerMap.StartTimer("RIC_SUB_REQ", int(subId), subReqTime, tryCount, c.handleSubscriptionRequestTimer) + event := c.sendE2TSubscriptionRequest(subs, trans, parentTrans) + switch themsg := event.(type) { + case *e2ap.E2APSubscriptionResponse: + subs.SubRespMsg = themsg + parentTrans.SendEvent(event, 0) return + case *e2ap.E2APSubscriptionFailure: + //TODO: Possible delete and one retry for subs req + parentTrans.SendEvent(event, 0) + default: + xapp.Logger.Info("SUBS-SubReq: internal delete due event(%s) %s", typeofSubsMessage(event), idstring(trans, subs, nil)) + c.sendE2TSubscriptionDeleteRequest(subs, trans, parentTrans) + parentTrans.SendEvent(nil, 0) } - var subDelReqPayload []byte - subDelReqPayload, err := c.e2ap.PackSubscriptionDeleteRequest(transaction.OrigParams.Payload, subId) - if err != nil { - xapp.Logger.Error("handleSubTimer: Packing SubDelReq failed. Err: %v", err) - return - } + go c.registry.RemoveFromSubscription(subs, parentTrans, 5*time.Second) +} - // Cancel failed subscription - var params xapp.RMRParams - params.Mtype = 12020 // RIC SUBSCRIPTION DELETE - params.SubId = int(subId) - params.Xid = transaction.OrigParams.Xid - params.Meid = transaction.OrigParams.Meid - params.Src = transaction.OrigParams.Src - params.PayloadLen = len(subDelReqPayload) - params.Payload = subDelReqPayload - params.Mbuf = nil +//------------------------------------------------------------------- +// SUBS DELETE Handling +//------------------------------------------------------------------- +func (c *Control) handleSubscriptionDelete(subs *Subscription, parentTrans *Transaction) { - // Delete CREATE transaction - transaction.Release() + trans := c.tracker.NewTransaction(subs.GetMeid()) + subs.WaitTransactionTurn(trans) + defer subs.ReleaseTransactionTurn(trans) + defer trans.Release() - // Create DELETE transaction - _, err = c.trackDeleteTransaction(subs, ¶ms, subId, false) - if err != nil { - xapp.Logger.Error("handleSubTimer: %s, Dropping this msg.", err.Error()) - return - } + xapp.Logger.Debug("SUBS-SubDelReq: Handling %s parent %s", idstring(trans, subs, nil), parentTrans.String()) - xapp.Logger.Info("handleSubTimer: Sending SubDelReq to E2T: Mtype: %v, SubId: %v, Meid: %v", params.Mtype, params.SubId, params.Meid) - c.rmrSend(¶ms) - if err != nil { - xapp.Logger.Error("handleSubTimer: Failed to send request to E2T %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid) - } - c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subId), subDelReqTime, FirstTry, c.handleSubscriptionDeleteRequestTimer) - return + event := c.sendE2TSubscriptionDeleteRequest(subs, trans, parentTrans) + + parentTrans.SendEvent(event, 0) + go c.registry.RemoveFromSubscription(subs, parentTrans, 5*time.Second) } -func (act Action) String() string { - actions := [...]string{ - "CREATE", - "MERGE", - "NONE", - "DELETE", +//------------------------------------------------------------------- +// send to E2T Subscription Request +//------------------------------------------------------------------- +func (c *Control) sendE2TSubscriptionRequest(subs *Subscription, trans *Transaction, parentTrans *Transaction) interface{} { + var err error + var event interface{} = nil + var timedOut bool = false + + subReqMsg := subs.SubReqMsg + subReqMsg.RequestId.Id = 123 + subReqMsg.RequestId.Seq = uint32(subs.GetSubId()) + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionRequest(subReqMsg) + if err != nil { + xapp.Logger.Error("SUBS-SubReq: %s parent %s", idstring(trans, subs, err), parentTrans.String()) + return event } - if act < CREATE || act > DELETE { - return "Unknown" + for retries := uint64(0); retries < e2tMaxSubReqTryCount; retries++ { + desc := fmt.Sprintf("SUBS-SubReq: SubReq to E2T (retry %d)", retries) + c.rmrSend(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 parent %s", typeofSubsMessage(event), idstring(trans, subs, nil), parentTrans.String()) + 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) { - 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 +func (c *Control) sendE2TSubscriptionDeleteRequest(subs *Subscription, trans *Transaction, parentTrans *Transaction) interface{} { + var err error + var event interface{} + var timedOut bool - payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteRequestSequenceNumber(params.Payload) + subDelReqMsg := &e2ap.E2APSubscriptionDeleteRequest{} + subDelReqMsg.RequestId.Id = 123 + subDelReqMsg.RequestId.Seq = uint32(subs.GetSubId()) + subDelReqMsg.FunctionId = subs.SubReqMsg.FunctionId + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionDeleteRequest(subDelReqMsg) if err != nil { - xapp.Logger.Error("SubDelReq: 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) - return + xapp.Logger.Error("SUBS-SubDelReq: %s parent %s", idstring(trans, subs, err), parentTrans.String()) + return event } - xapp.Logger.Info("SubDelReq: Received payloadSeqNum: %v", payloadSeqNum) - subs := c.registry.GetSubscription(payloadSeqNum) - if subs != nil { - var forwardRespToXapp bool = true - _, err = c.trackDeleteTransaction(subs, params, payloadSeqNum, forwardRespToXapp) - if err != nil { - xapp.Logger.Error("SubDelReq: %s, Dropping this msg.", err.Error()) - return + for retries := uint64(0); retries < e2tMaxSubDelReqTryCount; retries++ { + desc := fmt.Sprintf("SUBS-SubDelReq: SubDelReq to E2T (retry %d)", retries) + c.rmrSend(desc, subs, trans) + event, timedOut = trans.WaitEvent(e2tSubDelReqTime) + if timedOut { + continue } - subs.UnConfirmed() - } else { - xapp.Logger.Error("SubDelReq: Not valid sequence number. Dropping this msg. SubId: %v, Xid: %s", params.SubId, params.Xid) - return + break } - - 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) - } - c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(payloadSeqNum), subDelReqTime, FirstTry, c.handleSubscriptionDeleteRequestTimer) - return + xapp.Logger.Debug("SUBS-SubDelReq: Response handling event(%s) %s parent %s", typeofSubsMessage(event), idstring(trans, subs, nil), parentTrans.String()) + return event } -func (c *Control) trackDeleteTransaction(subs *Subscription, params *xapp.RMRParams, payloadSeqNum uint16, forwardRespToXapp bool) (transaction *Transaction, err error) { - srcAddr, srcPort, err := c.rtmgrClient.SplitSource(params.Src) +//------------------------------------------------------------------- +// handle from E2T Subscription Reponse +//------------------------------------------------------------------- +func (c *Control) handleE2TSubscriptionResponse(params *RMRParams) { + xapp.Logger.Info("MSG-SubResp from E2T: %s", params.String()) + subRespMsg, err := c.e2ap.UnpackSubscriptionResponse(params.Payload) if err != nil { - xapp.Logger.Error("Failed to split source address. Err: %s, SubId: %v, Xid: %s", err, payloadSeqNum, params.Xid) + xapp.Logger.Error("MSG-SubResp %s", idstring(params, nil, err)) + return } - var respReceived bool = false - transaction, err = c.tracker.TrackTransaction(subs, RmrEndpoint{*srcAddr, *srcPort}, params, respReceived, forwardRespToXapp) - 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) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint16{uint16(subRespMsg.RequestId.Seq), uint16(params.SubId)}) 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("MSG-SubResp: %s", idstring(params, nil, err)) return } - xapp.Logger.Info("SubDelResp: Received payloadSeqNum: %v", payloadSeqNum) - - subs := c.registry.GetSubscription(payloadSeqNum) - if subs == nil { - xapp.Logger.Error("SubDelResp: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubResp: %s", idstring(params, subs, err)) return } - - transaction := subs.GetTransaction() - if transaction == nil { - xapp.Logger.Error("SubDelResp: Unknown transaction. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) - 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(trans, subs, err)) } + return +} - c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(payloadSeqNum)) - - responseReceived := transaction.CheckResponseReceived() - if responseReceived == true { - // Subscription Delete timer already received +//------------------------------------------------------------------- +// handle from E2T Subscription Failure +//------------------------------------------------------------------- +func (c *Control) handleE2TSubscriptionFailure(params *RMRParams) { + xapp.Logger.Info("MSG-SubFail from E2T: %s", params.String()) + subFailMsg, err := c.e2ap.UnpackSubscriptionFailure(params.Payload) + if err != nil { + xapp.Logger.Error("MSG-SubFail %s", idstring(params, nil, err)) return } - - transaction.Release() - - xapp.Logger.Info("SubDelResp: SubId: %v, from address: %s. Forwarding response to xApp", payloadSeqNum, transaction.RmrEndpoint) - if transaction.ForwardRespToXapp == true { - 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) - } - - time.Sleep(3 * time.Second) - } - - xapp.Logger.Info("SubDelResp: Starting routing manager update. SubId: %v, Xid: %s", params.SubId, params.Xid) - subRouteAction := subs.SubRouteInfo(DELETE) - err = c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint16{uint16(subFailMsg.RequestId.Seq), uint16(params.SubId)}) if err != nil { - xapp.Logger.Error("SubDelResp: Failed to update routing manager. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) + xapp.Logger.Error("MSG-SubFail: %s", idstring(params, nil, err)) return } - - xapp.Logger.Info("SubDelResp: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - if !c.registry.releaseSequenceNumber(payloadSeqNum) { - 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(params, subs, 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(trans, subs, err)) + } 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("SUBS-SubDelResp 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, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload) + xapp.Logger.Error("SUBS-SubDelResp: %s", idstring(params, nil, err)) return } - xapp.Logger.Info("SubDelFail: Received payloadSeqNum: %v", payloadSeqNum) - - subs := c.registry.GetSubscription(payloadSeqNum) - if subs == nil { - xapp.Logger.Error("SubDelFail: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) - return - } - - transaction := subs.GetTransaction() - if transaction == nil { - xapp.Logger.Error("SubDelFail: Unknown transaction. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) - return - } - - c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(payloadSeqNum)) - - responseReceived := transaction.CheckResponseReceived() - if responseReceived == true { - // Subscription Delete timer already received - return - } - xapp.Logger.Info("SubDelFail: SubId: %v, from address: %s. Forwarding response to xApp", payloadSeqNum, transaction.RmrEndpoint) - - if transaction.ForwardRespToXapp == true { - var subDelRespPayload []byte - subDelRespPayload, err = c.e2ap.PackSubscriptionDeleteResponse(transaction.OrigParams.Payload, payloadSeqNum) - if err != nil { - xapp.Logger.Error("SubDelFail:Packing SubDelResp failed. Err: %v", err) - return - } - - params.Mtype = 12021 // RIC SUBSCRIPTION DELETE RESPONSE - params.SubId = int(payloadSeqNum) - params.Xid = transaction.OrigParams.Xid - params.Meid = transaction.OrigParams.Meid - params.Src = transaction.OrigParams.Src - params.PayloadLen = len(subDelRespPayload) - params.Payload = subDelRespPayload - params.Mbuf = nil - xapp.Logger.Info("SubDelFail: 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("SubDelFail: Failed to send SubDelFail to xApp. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - } - - time.Sleep(3 * time.Second) - } - - xapp.Logger.Info("SubDelFail: Starting routing manager update. SubId: %v, Xid: %s", params.SubId, params.Xid) - subRouteAction := subs.SubRouteInfo(DELETE) - err = c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint16{uint16(subDelRespMsg.RequestId.Seq), uint16(params.SubId)}) if err != nil { - xapp.Logger.Error("SubDelFail: Failed to update routing manager. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) + xapp.Logger.Error("SUBS-SubDelResp: %s", idstring(params, nil, err)) return } - - xapp.Logger.Info("SubDelFail: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - transaction.Release() - if !c.registry.releaseSequenceNumber(payloadSeqNum) { - 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("SUBS-SubDelResp: %s", idstring(params, subs, 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(trans, subs, err)) + } return } -func (c *Control) handleSubscriptionDeleteRequestTimer(strId string, nbrId int, tryCount uint64) { - subId := uint16(nbrId) - xapp.Logger.Info("handleSubDelTimer: SubDelReq timer expired. subId: %v, tryCount: %v", subId, tryCount) - - subs := c.registry.GetSubscription(subId) - if subs == nil { - xapp.Logger.Error("handleSubDelTimer: Unknown payloadSeqNum. Dropping this msg. SubId: %v", subId) - return - } - - transaction := subs.GetTransaction() - if transaction == nil { - xapp.Logger.Error("handleSubDelTimer: Unknown transaction. Dropping this msg. SubId: %v", subId) +//------------------------------------------------------------------- +// handle from E2T Subscription Delete Failure +//------------------------------------------------------------------- +func (c *Control) handleE2TSubscriptionDeleteFailure(params *RMRParams) { + xapp.Logger.Info("MSG-SubDelFail from E2T:%s", params.String()) + subDelFailMsg, err := c.e2ap.UnpackSubscriptionDeleteFailure(params.Payload) + if err != nil { + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(params, nil, err)) return } - - responseReceived := transaction.CheckResponseReceived() - if responseReceived == true { - // Subscription Delete Response or Failure already received + subs, err := c.registry.GetSubscriptionFirstMatch([]uint16{uint16(subDelFailMsg.RequestId.Seq), uint16(params.SubId)}) + if err != nil { + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(params, nil, err)) return } - - if tryCount < maxSubDelReqTryCount { - xapp.Logger.Info("handleSubDelTimer: Resending SubDelReq to E2T: Mtype: %v, SubId: %v, Xid %s, Meid %v", transaction.OrigParams.Mtype, transaction.OrigParams.SubId, transaction.OrigParams.Xid, transaction.OrigParams.Meid) - // Set possible to handle new response for the subId - - transaction.RetryTransaction() - - err := c.rmrSend(transaction.OrigParams) - if err != nil { - xapp.Logger.Error("handleSubDelTimer: Failed to send request to E2T %v, SubId: %v, Xid: %s", err, transaction.OrigParams.SubId, transaction.OrigParams.Xid) - } - - tryCount++ - c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subId), subReqTime, tryCount, c.handleSubscriptionDeleteRequestTimer) + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(params, subs, err)) return } - - var params xapp.RMRParams - if transaction.ForwardRespToXapp == true { - var subDelRespPayload []byte - subDelRespPayload, err := c.e2ap.PackSubscriptionDeleteResponse(transaction.OrigParams.Payload, subId) - if err != nil { - xapp.Logger.Error("handleSubDelTimer: Unable to pack payload. Dropping this timer action. Err: %v, SubId: %v, Xid: %s, Payload %x", err, subId, transaction.OrigParams.Xid, transaction.OrigParams.Payload) - return - } - - params.Mtype = 12021 // RIC SUBSCRIPTION DELETE RESPONSE - params.SubId = int(subId) - params.Meid = transaction.OrigParams.Meid - params.Xid = transaction.OrigParams.Xid - params.Src = transaction.OrigParams.Src - params.PayloadLen = len(subDelRespPayload) - params.Payload = subDelRespPayload - params.Mbuf = nil - - xapp.Logger.Info("handleSubDelTimer: Sending SubDelResp 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("handleSubDelTimer: Failed to send response to xApp: Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - } - - time.Sleep(3 * time.Second) - } - - xapp.Logger.Info("handleSubDelTimer: Starting routing manager update. SubId: %v, Xid: %s", subId, params.Xid) - subRouteAction := subs.SubRouteInfo(DELETE) - err := c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction) - if err != nil { - xapp.Logger.Error("handleSubDelTimer: Failed to update routing manager. Err: %v, SubId: %v, Xid: %s", err, subId, params.Xid) - 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(trans, subs, err)) } + return +} - xapp.Logger.Info("handleSubDelTimer: Deleting transaction record. SubId: %v, Xid: %s", subId, params.Xid) - transaction.Release() - if !c.registry.releaseSequenceNumber(subId) { - xapp.Logger.Error("handleSubDelTimer: Failed to release sequency number. SubId: %v, Xid: %s", subId, params.Xid) +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +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" } - return }