X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=pkg%2Fcontrol%2Fcontrol.go;h=98a2474e8920f122671f46c0ae8c237641613461;hb=7348625b9ef03d41dd5a0ca0f6c508376259717e;hp=5dd8f05865f4470227183265a2455cd7955074a5;hpb=0388dd945789dae802aaa93c5062e3ae4c45ddf1;p=ric-plt%2Fsubmgr.git diff --git a/pkg/control/control.go b/pkg/control/control.go index 5dd8f05..98a2474 100755 --- a/pkg/control/control.go +++ b/pkg/control/control.go @@ -20,31 +20,54 @@ 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/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" - "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 +//----------------------------------------------------------------------------- +// +//----------------------------------------------------------------------------- + +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 e2tRecvMsgTimeout time.Duration = 5 * time.Second type Control struct { - e2ap *E2ap - registry *Registry - rtmgrClient *RtmgrClient - tracker *Tracker - timerMap *TimerMap - rmrSendMutex sync.Mutex - msgCounter uint64 + xapptweaks.XappWrapper + e2ap *E2ap + registry *Registry + tracker *Tracker + //subscriber *xapp.Subscriber } type RMRMeid struct { @@ -53,584 +76,537 @@ 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") 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() - 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} - - rtmgrClientPtr := &rtmgrClient - - //TODO: to make this better. Now it is just a hack. - registry.rtmgrClient = rtmgrClientPtr + 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{e2ap: new(E2ap), - registry: registry, - rtmgrClient: rtmgrClientPtr, - tracker: tracker, - timerMap: timerMap, - msgCounter: 0, +func (c *Control) ReadyCB(data interface{}) { + if c.Rmr == nil { + c.Rmr = xapp.Rmr } } func (c *Control) Run() { + xapp.SetReadyCB(c.ReadyCB, nil) xapp.Run(c) } -func (c *Control) rmrSend(params *xapp.RMRParams) (err error) { - status := false - i := 1 - for ; i <= 10 && status == false; i++ { - c.rmrSendMutex.Lock() - status = xapp.Rmr.Send(params, 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) - time.Sleep(500 * time.Millisecond) - } - } - if status == false { - err = errors.New("rmr.Send() failed") - xapp.Rmr.Free(params.Mbuf) - } - return +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +func (c *Control) SubscriptionHandler(stype models.SubscriptionType, params interface{}) (*models.SubscriptionResponse, error) { + /* + switch p := params.(type) { + case *models.ReportParams: + trans := c.tracker.NewXappTransaction(NewRmrEndpoint(p.ClientEndpoint),"" , 0, &xapp.RMRMeid{RanName: p.Meid}) + if trans == nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(fmt.Errorf("transaction not created"), params)) + return + } + defer trans.Release() + case *models.ControlParams: + case *models.PolicyParams: + } + */ + return &models.SubscriptionResponse{}, fmt.Errorf("Subscription rest interface not implemented") } -func (c *Control) 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) Consume(msg *xapp.RMRParams) (err error) { - c.msgCounter++ - 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) - case xapp.RICMessageTypes["RIC_SUB_DEL_FAILURE"]: - go c.handleSubscriptionDeleteFailure(msg) - default: - xapp.Logger.Info("Unknown Message Type '%d', discarding", msg.Mtype) - } - return nil +func (c *Control) QueryHandler() (models.SubscriptionList, error) { + return c.registry.QueryHandler() } -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) +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- + +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) +} - 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 (c *Control) rmrSendToXapp(desc string, subs *Subscription, trans *TransactionXapp) (err error) { - subs, err := c.registry.ReserveSubscription(RmrEndpoint{*srcAddr, *srcPort}, params.Meid) - if err != nil { - xapp.Logger.Error("SubReq: %s, Dropping this msg.", 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) +} - 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.DelSubscription(subs.Seq) +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 } + c.CntRecvMsg++ - // 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.DelSubscription(subs.Seq) - return - } + defer c.Rmr.Free(msg.Mbuf) - // 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) + 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) } - 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 +//------------------------------------------------------------------- +// 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 { - 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(err, params)) return } - xapp.Logger.Info("SubResp: Received payloadSeqNum: %v", payloadSeqNum) - subs := c.registry.GetSubscription(payloadSeqNum) - if subs == nil { - xapp.Logger.Error("SubResp: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) + 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() - transaction := subs.GetTransaction() - - c.timerMap.StopTimer("RIC_SUB_REQ", int(payloadSeqNum)) - - responseReceived := transaction.CheckResponseReceived() - if responseReceived == true { - // Subscription timer already received + err = c.tracker.Track(trans) + if err != nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) return } - xapp.Logger.Info("SubResp: SubId: %v, from address: %s.", payloadSeqNum, transaction.RmrEndpoint) - subs.Confirmed() - transaction.Release() - - 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) + //TODO handle subscription toward e2term inside AssignToSubscription / hide handleSubscriptionCreate in it? + 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 + } + + // + // 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 + } } - - xapp.Logger.Info("SubResp: SubId: %v, from address: %s. Deleting transaction record", payloadSeqNum, transaction.RmrEndpoint) - 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) { - 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 *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 { - 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(err, params)) 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) + 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 } + defer trans.Release() - transaction := subs.GetTransaction() - if transaction == nil { - xapp.Logger.Error("SubFail: Unknown transaction. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) + err = c.tracker.Track(trans) + if err != nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(err, trans)) return } - c.timerMap.StopTimer("RIC_SUB_REQ", int(payloadSeqNum)) - - responseReceived := transaction.CheckResponseReceived() + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{trans.GetSubId()}) if err != nil { - xapp.Logger.Info("SubFail: Dropping this msg. Err: %v SubId: %v", err, payloadSeqNum) + xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(err, trans)) return } - if responseReceived == true { - // Subscription timer already received - return - } - xapp.Logger.Info("SubFail: SubId: %v, from address: %s. Forwarding response to xApp", payloadSeqNum, transaction.RmrEndpoint) + // + // Wake subs delete + // + go c.handleSubscriptionDelete(subs, trans) + trans.WaitEvent(0) //blocked wait as timeout is handled in subs side - time.Sleep(3 * time.Second) + xapp.Logger.Debug("XAPP-SubDelReq: Handling event %s ", idstring(nil, trans, subs)) - xapp.Logger.Info("SubFail: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - transaction.Release() - if !c.registry.DelSubscription(payloadSeqNum) { - xapp.Logger.Error("SubFail: Failed to release sequency number. SubId: %v, Xid: %s", params.SubId, params.Xid) + // 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 -} -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) + //TODO handle subscription toward e2term insiged RemoveFromSubscription / hide handleSubscriptionDelete in it? + //c.registry.RemoveFromSubscription(subs, trans, 5*time.Second) +} - subs := c.registry.GetSubscription(subId) - if subs == nil { - xapp.Logger.Error("SubFail: Unknown payloadSeqNum. Dropping this msg. SubId: %v", subId) - return - } +//------------------------------------------------------------------- +// 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) + } + } - transaction := subs.GetTransaction() - if transaction == nil { - xapp.Logger.Error("SubFail: Unknown transaction. Dropping this msg. SubId: %v", subId) - return + 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)) } - responseReceived := transaction.CheckResponseReceived() - - if responseReceived == true { - // Subscription Response or Failure already received - return + //Now RemoveFromSubscription in here to avoid race conditions (mostly concerns delete) + if valid == false { + c.registry.RemoveFromSubscription(subs, parentTrans, 5*time.Second) } + parentTrans.SendEvent(subRfMsg, 0) +} - 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) +//------------------------------------------------------------------- +// SUBS DELETE Handling +//------------------------------------------------------------------- - transaction.RetryTransaction() +func (c *Control) handleSubscriptionDelete(subs *Subscription, parentTrans *TransactionXapp) { - 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) - } + trans := c.tracker.NewSubsTransaction(subs) + subs.WaitTransactionTurn(trans) + defer subs.ReleaseTransactionTurn(trans) + defer trans.Release() - tryCount++ - c.timerMap.StartTimer("RIC_SUB_REQ", int(subId), subReqTime, tryCount, c.handleSubscriptionRequestTimer) - return - } + xapp.Logger.Debug("SUBS-SubDelReq: Handling %s", idstring(nil, trans, subs, parentTrans)) - 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 + 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() } + //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) +} - // 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 - - // Delete CREATE transaction - transaction.Release() - - // Create DELETE transaction - _, err = c.trackDeleteTransaction(subs, ¶ms, subId, false) +//------------------------------------------------------------------- +// 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("handleSubTimer: %s, Dropping this msg.", err.Error()) - return + xapp.Logger.Error("SUBS-SubReq: %s", idstring(err, trans, subs, parentTrans)) + return event } - 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) + 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 } - c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subId), subDelReqTime, FirstTry, c.handleSubscriptionDeleteRequestTimer) - 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 *xapptweaks.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, Payload %X", err, params.SubId, params.Xid, params.Payload) + xapp.Logger.Error("MSG-SubResp %s", idstring(err, params)) return } - 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 - } - subs.UnConfirmed() - } 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) + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubResp: %s", idstring(err, params, subs)) + return } - c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(payloadSeqNum), subDelReqTime, FirstTry, c.handleSubscriptionDeleteRequestTimer) - return -} - -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) - if err != nil { - xapp.Logger.Error("Failed to split source address. Err: %s, SubId: %v, Xid: %s", err, payloadSeqNum, 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)) } - 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) +//------------------------------------------------------------------- +// 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 { - 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) - 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) + xapp.Logger.Error("MSG-SubFail %s", idstring(err, params)) return } - - transaction := subs.GetTransaction() - if transaction == nil { - xapp.Logger.Error("SubDelResp: Unknown transaction. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subFailMsg.RequestId.Seq}) + if err != nil { + xapp.Logger.Error("MSG-SubFail: %s", idstring(err, params)) return } - - c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(payloadSeqNum)) - - responseReceived := transaction.CheckResponseReceived() - if responseReceived == true { - // Subscription Delete timer already received + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubFail: %s", idstring(err, params, subs)) 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: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - if !c.registry.DelSubscription(payloadSeqNum) { - xapp.Logger.Error("SubDelResp: Failed to release sequency number. SubId: %v, Xid: %s", params.SubId, params.Xid) - 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 *xapptweaks.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, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload) - 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) + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params)) return } - - transaction := subs.GetTransaction() - if transaction == nil { - xapp.Logger.Error("SubDelFail: Unknown transaction. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId) + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelRespMsg.RequestId.Seq}) + if err != nil { + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params)) return } - - c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(payloadSeqNum)) - - responseReceived := transaction.CheckResponseReceived() - if responseReceived == true { - // Subscription Delete timer already received + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubDelResp: %s", idstring(err, params, subs)) 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: Deleting transaction record. SubId: %v, Xid: %s", params.SubId, params.Xid) - transaction.Release() - if !c.registry.DelSubscription(payloadSeqNum) { - xapp.Logger.Error("SubDelFail: Failed to release sequency number. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid) - 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, 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 *xapptweaks.RMRParams) { + xapp.Logger.Info("MSG from E2T: %s", params.String()) + subDelFailMsg, err := c.e2ap.UnpackSubscriptionDeleteFailure(params.Payload) + if err != nil { + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params)) return } - - responseReceived := transaction.CheckResponseReceived() - if responseReceived == true { - // Subscription Delete Response or Failure already received + subs, err := c.registry.GetSubscriptionFirstMatch([]uint32{subDelFailMsg.RequestId.Seq}) + if err != nil { + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(err, params)) 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(err, params, subs)) 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) + 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 +} - xapp.Logger.Info("handleSubDelTimer: Deleting transaction record. SubId: %v, Xid: %s", subId, params.Xid) - transaction.Release() - if !c.registry.DelSubscription(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 }