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"
"time"
)
+//-----------------------------------------------------------------------------
+//
+//-----------------------------------------------------------------------------
+
var subReqTime time.Duration = 5 * time.Second
var subDelReqTime time.Duration = 5 * time.Second
var maxSubReqTryCount uint64 = 2 // Initial try + retry
type Control struct {
e2ap *E2ap
registry *Registry
- rtmgrClient *RtmgrClient
tracker *Tracker
timerMap *TimerMap
rmrSendMutex sync.Mutex
}
func NewControl() *Control {
+
+ transport := httptransport.New(viper.GetString("rtmgr.HostAddr")+":"+viper.GetString("rtmgr.port"), viper.GetString("rtmgr.baseUrl"), []string{"http"})
+ client := rtmgrclient.New(transport, strfmt.Default)
+ handle := rtmgrhandle.NewProvideXappSubscriptionHandleParamsWithTimeout(10 * time.Second)
+ deleteHandle := rtmgrhandle.NewDeleteXappSubscriptionHandleParamsWithTimeout(10 * time.Second)
+ rtmgrClient := RtmgrClient{client, handle, deleteHandle}
+
registry := new(Registry)
registry.Initialize(seedSN)
+ registry.rtmgrClient = &rtmgrClient
tracker := new(Tracker)
tracker.Init()
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,
}
}
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) 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(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"]:
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
+func (c *Control) handleSubscriptionRequest(params *RMRParams) {
+ xapp.Logger.Info("SubReq from xapp: %s", params.String())
+
+ //
+ //
+ //
+ trans, err := c.tracker.TrackTransaction(NewRmrEndpoint(params.Src),
+ params.Xid,
+ params.Meid,
+ false,
+ true)
- 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)
+ xapp.Logger.Error("SubReq: %s, Dropping this msg. %s", err.Error(), params.String())
return
}
- /* 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)
+ //
+ //
+ //
+ trans.SubReqMsg, err = c.e2ap.UnpackSubscriptionRequest(params.Payload)
+ if err != nil {
+ xapp.Logger.Error("SubReq: %s Dropping this msg. %s", err.Error(), trans)
+ trans.Release()
return
}
- params.SubId = int(subs.Seq)
- err = c.e2ap.SetSubscriptionRequestSequenceNumber(params.Payload, subs.Seq)
+ //
+ //
+ //
+ subs, err := c.registry.ReserveSubscription(&trans.RmrEndpoint, trans.Meid)
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)
+ xapp.Logger.Error("SubReq: %s, Dropping this msg. %s", err.Error(), trans)
+ trans.Release()
return
}
- // 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)
+ err = subs.SetTransaction(trans)
if err != nil {
- xapp.Logger.Error("SubReq: %s, Dropping this msg.", err.Error())
- c.registry.releaseSequenceNumber(subs.Seq)
+ xapp.Logger.Error("SubReq: %s, Dropping this msg. %s", err.Error(), trans)
+ subs.Release()
+ trans.Release()
return
}
- // 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)
+ trans.SubReqMsg.RequestId.Seq = uint32(subs.GetSubId())
- err = c.rtmgrClient.SubscriptionRequestUpdate(subRouteAction)
+ //
+ // TODO: subscription create is in fact owned by subscription and not transaction.
+ // Transaction is toward xapp while Subscription is toward ran.
+ // In merge several xapps may wake transactions, while only one subscription
+ // toward ran occurs -> subscription owns subscription creation toward ran
+ //
+ // This is intermediate solution while improving message handling
+ //
+ trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionRequest(trans.SubReqMsg)
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("SubReq: %s for trans %s", err.Error(), trans)
+ subs.Release()
+ trans.Release()
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)
+ c.rmrSend("SubReq: SubReq to E2T", subs, trans)
+
+ c.timerMap.StartTimer("RIC_SUB_REQ", int(subs.GetSubId()), subReqTime, FirstTry, c.handleSubscriptionRequestTimer)
+ xapp.Logger.Debug("SubReq: Debugging trans table = %v", c.tracker.transactionXappTable)
return
}
-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
+func (c *Control) handleSubscriptionResponse(params *RMRParams) {
+ xapp.Logger.Info("SubResp from E2T: %s", params.String())
- payloadSeqNum, err := c.e2ap.GetSubscriptionResponseSequenceNumber(params.Payload)
+ //
+ //
+ //
+ SubRespMsg, err := c.e2ap.UnpackSubscriptionResponse(params.Payload)
if err != nil {
- xapp.Logger.Error("SubResp: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload)
+ xapp.Logger.Error("SubResp: %s Dropping this msg. %s", err.Error(), params.String())
return
}
- xapp.Logger.Info("SubResp: Received payloadSeqNum: %v", payloadSeqNum)
- subs := c.registry.GetSubscription(payloadSeqNum)
+ //
+ //
+ //
+ subs := c.registry.GetSubscription(uint16(SubRespMsg.RequestId.Seq))
+ if subs == nil && params.SubId > 0 {
+ subs = c.registry.GetSubscription(uint16(params.SubId))
+ }
+
if subs == nil {
- xapp.Logger.Error("SubResp: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
+ xapp.Logger.Error("SubResp: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", SubRespMsg.RequestId.Seq, params.SubId, params.String())
return
}
+ xapp.Logger.Info("SubResp: subscription found payloadSeqNum: %d, SubId: %d", SubRespMsg.RequestId.Seq, subs.GetSubId())
- transaction := subs.GetTransaction()
+ //
+ //
+ //
+ trans := subs.GetTransaction()
+ if trans == nil {
+ xapp.Logger.Error("SubResp: Unknown trans. Dropping this msg. SubId: %d", subs.GetSubId())
+ return
+ }
- c.timerMap.StopTimer("RIC_SUB_REQ", int(payloadSeqNum))
+ trans.SubRespMsg = SubRespMsg
- responseReceived := transaction.CheckResponseReceived()
+ //
+ //
+ //
+ c.timerMap.StopTimer("RIC_SUB_REQ", int(subs.GetSubId()))
+
+ responseReceived := trans.CheckResponseReceived()
if responseReceived == true {
// Subscription timer already received
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)
+ trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionResponse(trans.SubRespMsg)
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("SubResp: %s for trans %s", err.Error(), trans)
+ trans.Release()
+ return
}
- xapp.Logger.Info("SubResp: SubId: %v, from address: %s. Deleting transaction record", payloadSeqNum, transaction.RmrEndpoint)
+ subs.Confirmed()
+ trans.Release()
+ c.rmrReplyToSender("SubResp: SubResp to xapp", subs, trans)
return
}
-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
+func (c *Control) handleSubscriptionFailure(params *RMRParams) {
+ xapp.Logger.Info("SubFail from E2T: %s", params.String())
- payloadSeqNum, err := c.e2ap.GetSubscriptionFailureSequenceNumber(params.Payload)
+ //
+ //
+ //
+ SubFailMsg, err := c.e2ap.UnpackSubscriptionFailure(params.Payload)
if err != nil {
- xapp.Logger.Error("SubFail: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload)
+ xapp.Logger.Error("SubFail: %s Dropping this msg. %s", err.Error(), params.String())
return
}
- xapp.Logger.Info("SubFail: Received payloadSeqNum: %v", payloadSeqNum)
- subs := c.registry.GetSubscription(payloadSeqNum)
+ //
+ //
+ //
+ subs := c.registry.GetSubscription(uint16(SubFailMsg.RequestId.Seq))
+ if subs == nil && params.SubId > 0 {
+ subs = c.registry.GetSubscription(uint16(params.SubId))
+ }
+
if subs == nil {
- xapp.Logger.Error("SubFail: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
+ xapp.Logger.Error("SubFail: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", SubFailMsg.RequestId.Seq, params.SubId, params.String())
return
}
+ xapp.Logger.Info("SubFail: subscription found payloadSeqNum: %d, SubId: %d", SubFailMsg.RequestId.Seq, subs.GetSubId())
- transaction := subs.GetTransaction()
- if transaction == nil {
- xapp.Logger.Error("SubFail: Unknown transaction. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
+ //
+ //
+ //
+ trans := subs.GetTransaction()
+ if trans == nil {
+ xapp.Logger.Error("SubFail: Unknown trans. Dropping this msg. SubId: %d", subs.GetSubId())
return
}
+ trans.SubFailMsg = SubFailMsg
- c.timerMap.StopTimer("RIC_SUB_REQ", int(payloadSeqNum))
+ //
+ //
+ //
+ c.timerMap.StopTimer("RIC_SUB_REQ", int(subs.GetSubId()))
- responseReceived := transaction.CheckResponseReceived()
+ responseReceived := trans.CheckResponseReceived()
if err != nil {
- xapp.Logger.Info("SubFail: Dropping this msg. Err: %v SubId: %v", err, payloadSeqNum)
return
}
// Subscription timer already received
return
}
- xapp.Logger.Info("SubFail: SubId: %v, from address: %s. Forwarding response to xApp", payloadSeqNum, transaction.RmrEndpoint)
- time.Sleep(3 * time.Second)
-
- 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)
+ trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionFailure(trans.SubFailMsg)
+ if err == nil {
+ c.rmrReplyToSender("SubFail: SubFail to xapp", subs, trans)
+ time.Sleep(3 * time.Second)
+ } else {
+ //TODO error handling improvement
+ xapp.Logger.Error("SubFail: %s for trans %s (continuing cleaning)", err.Error(), 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)
- }
+ trans.Release()
+ subs.Release()
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)
+ xapp.Logger.Info("SubReq timeout: subId: %v, tryCount: %v", nbrId, tryCount)
- subs := c.registry.GetSubscription(subId)
+ subs := c.registry.GetSubscription(uint16(nbrId))
if subs == nil {
- xapp.Logger.Error("SubFail: Unknown payloadSeqNum. Dropping this msg. SubId: %v", subId)
+ xapp.Logger.Error("SubReq timeout: Unknown payloadSeqNum. Dropping this msg. SubId: %v", nbrId)
return
}
- transaction := subs.GetTransaction()
- if transaction == nil {
- xapp.Logger.Error("SubFail: Unknown transaction. Dropping this msg. SubId: %v", subId)
+ trans := subs.GetTransaction()
+ if trans == nil {
+ xapp.Logger.Error("SubReq timeout: Unknown trans. Dropping this msg. SubId: %v", subs.GetSubId())
return
}
- responseReceived := transaction.CheckResponseReceived()
+ responseReceived := trans.CheckResponseReceived()
if responseReceived == true {
// Subscription Response or Failure already received
}
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)
+ xapp.Logger.Info("SubReq timeout: subs: %s trans: %s", subs, trans)
- transaction.RetryTransaction()
+ trans.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)
- }
+ c.rmrSend("SubReq timeout: SubReq to E2T", subs, trans)
tryCount++
- c.timerMap.StartTimer("RIC_SUB_REQ", int(subId), subReqTime, tryCount, c.handleSubscriptionRequestTimer)
+ c.timerMap.StartTimer("RIC_SUB_REQ", int(subs.GetSubId()), subReqTime, tryCount, c.handleSubscriptionRequestTimer)
return
}
- var subDelReqPayload []byte
- subDelReqPayload, err := c.e2ap.PackSubscriptionDeleteRequest(transaction.OrigParams.Payload, subId)
+ // Release CREATE transaction
+ trans.Release()
+
+ // Create DELETE transaction (internal and no messages toward xapp)
+ deltrans, err := c.tracker.TrackTransaction(&trans.RmrEndpoint,
+ trans.GetXid(),
+ trans.GetMeid(),
+ false,
+ false)
+
if err != nil {
- xapp.Logger.Error("handleSubTimer: Packing SubDelReq failed. Err: %v", err)
+ xapp.Logger.Error("SubReq timeout: %s, Dropping this msg.", err.Error())
+ //TODO improve error handling. Important at least in merge
+ subs.Release()
return
}
- // 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)
+ deltrans.SubDelReqMsg = &e2ap.E2APSubscriptionDeleteRequest{}
+ deltrans.SubDelReqMsg.RequestId.Id = trans.SubReqMsg.RequestId.Id
+ deltrans.SubDelReqMsg.RequestId.Seq = uint32(subs.GetSubId())
+ deltrans.SubDelReqMsg.FunctionId = trans.SubReqMsg.FunctionId
+ deltrans.Mtype, deltrans.Payload, err = c.e2ap.PackSubscriptionDeleteRequest(deltrans.SubDelReqMsg)
if err != nil {
- xapp.Logger.Error("handleSubTimer: %s, Dropping this msg.", err.Error())
+ xapp.Logger.Error("SubReq timeout: Packing SubDelReq failed. Err: %v", err)
+ //TODO improve error handling. Important at least in merge
+ deltrans.Release()
+ subs.Release()
return
}
- xapp.Logger.Info("handleSubTimer: Sending SubDelReq to E2T: Mtype: %v, SubId: %v, Meid: %v", params.Mtype, params.SubId, params.Meid)
- c.rmrSend(¶ms)
+ err = subs.SetTransaction(deltrans)
if err != nil {
- xapp.Logger.Error("handleSubTimer: Failed to send request to E2T %v. SubId: %v, Xid: %s", err, params.SubId, params.Xid)
+ xapp.Logger.Error("SubReq timeout: %s, Dropping this msg.", err.Error())
+ //TODO improve error handling. Important at least in merge
+ deltrans.Release()
+ return
}
- c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subId), subDelReqTime, FirstTry, c.handleSubscriptionDeleteRequestTimer)
+
+ c.rmrSend("SubReq timer: SubDelReq to E2T", subs, deltrans)
+ c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId()), subDelReqTime, FirstTry, c.handleSubscriptionDeleteRequestTimer)
return
}
-func (act Action) String() string {
- actions := [...]string{
- "CREATE",
- "MERGE",
- "NONE",
- "DELETE",
- }
+func (c *Control) handleSubscriptionDeleteRequest(params *RMRParams) {
+ xapp.Logger.Info("SubDelReq from xapp: %s", params.String())
- if act < CREATE || act > DELETE {
- return "Unknown"
- }
- return actions[act]
-}
+ //
+ //
+ //
+ trans, err := c.tracker.TrackTransaction(NewRmrEndpoint(params.Src),
+ params.Xid,
+ params.Meid,
+ false,
+ true)
-func (act Action) valid() bool {
- switch act {
- case CREATE, MERGE, DELETE:
- return true
- default:
- return false
+ if err != nil {
+ xapp.Logger.Error("SubDelReq: %s, Dropping this msg. %s", err.Error(), params.String())
+ return
}
-}
-
-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)
+ //
+ //
+ //
+ trans.SubDelReqMsg, err = c.e2ap.UnpackSubscriptionDeleteRequest(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("SubDelReq: %s Dropping this msg. %s", err.Error(), trans)
+ trans.Release()
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 := c.registry.GetSubscription(uint16(trans.SubDelReqMsg.RequestId.Seq))
+ if subs == nil && params.SubId > 0 {
+ subs = c.registry.GetSubscription(uint16(params.SubId))
+ }
+
+ if subs == nil {
+ xapp.Logger.Error("SubDelReq: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", trans.SubDelReqMsg.RequestId.Seq, params.SubId, trans)
+ trans.Release()
return
}
+ xapp.Logger.Info("SubDelReq: subscription found payloadSeqNum: %d, SubId: %d. %s", trans.SubDelReqMsg.RequestId.Seq, params.SubId, trans)
- 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)
+ err = subs.SetTransaction(trans)
if err != nil {
- xapp.Logger.Error("SubDelReq: Failed to send request to E2T. Err %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid)
+ xapp.Logger.Error("SubDelReq: %s, Dropping this msg. %s", err.Error(), trans)
+ trans.Release()
+ 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)
+ //
+ // TODO: subscription delete is in fact owned by subscription and not transaction.
+ // Transaction is toward xapp while Subscription is toward ran.
+ // In merge several xapps may wake transactions, while only one subscription
+ // toward ran occurs -> subscription owns subscription creation toward ran
+ //
+ // This is intermediate solution while improving message handling
+ //
+ trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionDeleteRequest(trans.SubDelReqMsg)
if err != nil {
- xapp.Logger.Error("Failed to split source address. Err: %s, SubId: %v, Xid: %s", err, payloadSeqNum, params.Xid)
+ xapp.Logger.Error("SubDelReq: %s for trans %s", err.Error(), trans)
+ trans.Release()
+ return
}
- var respReceived bool = false
- transaction, err = c.tracker.TrackTransaction(subs, RmrEndpoint{*srcAddr, *srcPort}, params, respReceived, forwardRespToXapp)
+
+ subs.UnConfirmed()
+
+ c.rmrSend("SubDelReq: SubDelReq to E2T", subs, trans)
+
+ c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId()), subDelReqTime, FirstTry, c.handleSubscriptionDeleteRequestTimer)
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
+func (c *Control) handleSubscriptionDeleteResponse(params *RMRParams) (err error) {
+ xapp.Logger.Info("SubDelResp from E2T:%s", params.String())
- payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteResponseSequenceNumber(params.Payload)
+ //
+ //
+ //
+ SubDelRespMsg, err := c.e2ap.UnpackSubscriptionDeleteResponse(params.Payload)
if err != nil {
- xapp.Logger.Error("SubDelResp: Unable to get Sequence Number from Payload. Dropping this msg. Err: %v, SubId: %v, Xid: %s, Payload %X", err, params.SubId, params.Xid, params.Payload)
+ xapp.Logger.Error("SubDelResp: %s Dropping this msg. %s", err.Error(), params.String())
return
}
- xapp.Logger.Info("SubDelResp: Received payloadSeqNum: %v", payloadSeqNum)
- subs := c.registry.GetSubscription(payloadSeqNum)
- if subs == nil {
- xapp.Logger.Error("SubDelResp: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
- return
+ //
+ //
+ //
+ subs := c.registry.GetSubscription(uint16(SubDelRespMsg.RequestId.Seq))
+ if subs == nil && params.SubId > 0 {
+ subs = c.registry.GetSubscription(uint16(params.SubId))
}
- transaction := subs.GetTransaction()
- if transaction == nil {
- xapp.Logger.Error("SubDelResp: Unknown transaction. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
+ if subs == nil {
+ xapp.Logger.Error("SubDelResp: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", SubDelRespMsg.RequestId.Seq, params.SubId, params.String())
return
}
+ xapp.Logger.Info("SubDelResp: subscription found payloadSeqNum: %d, SubId: %d", SubDelRespMsg.RequestId.Seq, subs.GetSubId())
- 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 {
+ xapp.Logger.Error("SubDelResp: Unknown trans. Dropping this msg. SubId: %d", subs.GetSubId())
return
}
- transaction.Release()
+ trans.SubDelRespMsg = SubDelRespMsg
- 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)
- }
+ //
+ //
+ //
+ c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId()))
- 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)
- if err != nil {
- xapp.Logger.Error("SubDelResp: Failed to update routing manager. Err: %v, SubId: %v, Xid: %s", err, params.SubId, params.Xid)
+ responseReceived := trans.CheckResponseReceived()
+ if responseReceived == true {
+ // Subscription Delete timer already received
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)
- return
- }
+ c.sendSubscriptionDeleteResponse("SubDelResp", 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
+func (c *Control) handleSubscriptionDeleteFailure(params *RMRParams) {
+ xapp.Logger.Info("SubDelFail from E2T:%s", params.String())
- payloadSeqNum, err := c.e2ap.GetSubscriptionDeleteFailureSequenceNumber(params.Payload)
+ //
+ //
+ //
+ SubDelFailMsg, err := c.e2ap.UnpackSubscriptionDeleteFailure(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("SubDelFail: %s Dropping this msg. %s", err.Error(), params.String())
return
}
- xapp.Logger.Info("SubDelFail: Received payloadSeqNum: %v", payloadSeqNum)
- subs := c.registry.GetSubscription(payloadSeqNum)
+ //
+ //
+ //
+ subs := c.registry.GetSubscription(uint16(SubDelFailMsg.RequestId.Seq))
+ if subs == nil && params.SubId > 0 {
+ subs = c.registry.GetSubscription(uint16(params.SubId))
+ }
+
if subs == nil {
- xapp.Logger.Error("SubDelFail: Unknown payloadSeqNum. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
+ xapp.Logger.Error("SubDelFail: Not valid subscription found payloadSeqNum: %d, SubId: %d. Dropping this msg. %s", SubDelFailMsg.RequestId.Seq, params.SubId, params.String())
return
}
+ xapp.Logger.Info("SubDelFail: subscription found payloadSeqNum: %d, SubId: %d", SubDelFailMsg.RequestId.Seq, subs.GetSubId())
- transaction := subs.GetTransaction()
- if transaction == nil {
- xapp.Logger.Error("SubDelFail: Unknown transaction. Dropping this msg. PayloadSeqNum: %v, SubId: %v", payloadSeqNum, params.SubId)
+ //
+ //
+ //
+ trans := subs.GetTransaction()
+ if trans == nil {
+ xapp.Logger.Error("SubDelFail: Unknown trans. Dropping this msg. SubId: %d", subs.GetSubId())
return
}
+ trans.SubDelFailMsg = SubDelFailMsg
- c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(payloadSeqNum))
+ //
+ //
+ //
+ c.timerMap.StopTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId()))
- responseReceived := transaction.CheckResponseReceived()
+ responseReceived := trans.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)
- 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)
- 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)
- return
- }
+ c.sendSubscriptionDeleteResponse("SubDelFail", 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)
+ xapp.Logger.Info("SubDelReq timeout: subId: %v, tryCount: %v", nbrId, tryCount)
- subs := c.registry.GetSubscription(subId)
+ subs := c.registry.GetSubscription(uint16(nbrId))
if subs == nil {
- xapp.Logger.Error("handleSubDelTimer: Unknown payloadSeqNum. Dropping this msg. SubId: %v", subId)
+ xapp.Logger.Error("SubDelReq timeout: Unknown payloadSeqNum. Dropping this msg. SubId: %v", nbrId)
return
}
- transaction := subs.GetTransaction()
- if transaction == nil {
- xapp.Logger.Error("handleSubDelTimer: Unknown transaction. Dropping this msg. SubId: %v", subId)
+ trans := subs.GetTransaction()
+ if trans == nil {
+ xapp.Logger.Error("SubDelReq timeout: Unknown trans. Dropping this msg. SubId: %v", subs.GetSubId())
return
}
- responseReceived := transaction.CheckResponseReceived()
+ responseReceived := trans.CheckResponseReceived()
if responseReceived == true {
// Subscription Delete Response or Failure already received
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)
- }
-
+ trans.RetryTransaction()
+ c.rmrSend("SubDelReq timeout: SubDelReq to E2T", subs, trans)
tryCount++
- c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subId), subReqTime, tryCount, c.handleSubscriptionDeleteRequestTimer)
+ c.timerMap.StartTimer("RIC_SUB_DEL_REQ", int(subs.GetSubId()), subReqTime, tryCount, c.handleSubscriptionDeleteRequestTimer)
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
- }
+ c.sendSubscriptionDeleteResponse("SubDelReq(timer)", trans, subs)
+ 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)
+func (c *Control) sendSubscriptionDeleteResponse(desc string, trans *Transaction, subs *Subscription) {
+
+ if trans.ForwardRespToXapp == true {
+ //Always generate SubDelResp
+ trans.SubDelRespMsg = &e2ap.E2APSubscriptionDeleteResponse{}
+ trans.SubDelRespMsg.RequestId.Id = trans.SubDelReqMsg.RequestId.Id
+ trans.SubDelRespMsg.RequestId.Seq = uint32(subs.GetSubId())
+ trans.SubDelRespMsg.FunctionId = trans.SubDelReqMsg.FunctionId
+
+ var err error
+ trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionDeleteResponse(trans.SubDelRespMsg)
+ if err == nil {
+ c.rmrReplyToSender(desc+": SubDelResp to xapp", subs, trans)
+ time.Sleep(3 * time.Second)
+ } else {
+ //TODO error handling improvement
+ xapp.Logger.Error("%s: %s for trans %s (continuing cleaning)", desc, err.Error(), trans)
}
-
- 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
}
- 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)
- }
- return
+ trans.Release()
+ subs.Release()
}