X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=pkg%2Fcontrol%2Fcontrol.go;h=c2b33b765ca87737f2d19ec7a756454c2c4333ad;hb=af91f971681842c22dc0fad165c0cbf7ebaa0e4d;hp=d213c65e1c1179a8261bb4abf43f924e4f9c7cf3;hpb=e6e9432561cb86080cd6a6db0d80622337da1bd7;p=ric-plt%2Fsubmgr.git diff --git a/pkg/control/control.go b/pkg/control/control.go old mode 100644 new mode 100755 index d213c65..c2b33b7 --- a/pkg/control/control.go +++ b/pkg/control/control.go @@ -19,77 +19,538 @@ package control -/* -#include +import ( + "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" + "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" + "sync" + "time" +) -#cgo CFLAGS: -I../ -#cgo LDFLAGS: -lrmr_nng -lnng -*/ -import "C" +//----------------------------------------------------------------------------- +// +//----------------------------------------------------------------------------- +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 -import ( - "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp" - "errors" - "strconv" -) +var e2tRecvMsgTimeout time.Duration = 5 * time.Second type Control struct { - e2ap *E2ap - registry *Registry + e2ap *E2ap + registry *Registry + tracker *Tracker + timerMap *TimerMap + rmrSendMutex sync.Mutex + msgCounter uint64 +} + +type RMRMeid struct { + PlmnID string + EnbID string + RanName string +} + +const ( + CREATE Action = 0 + UPDATE Action = 1 + NONE Action = 2 + DELETE Action = 3 +) + +func init() { + xapp.Logger.Info("SUBMGR") + viper.AutomaticEnv() + viper.SetEnvPrefix("submgr") + viper.AllowEmptyEnv(true) } -func NewControl() Control { - return Control{new(E2ap),new(Registry)} +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() + registry.rtmgrClient = &rtmgrClient + + tracker := new(Tracker) + tracker.Init() + + timerMap := new(TimerMap) + timerMap.Init() + + return &Control{e2ap: new(E2ap), + registry: registry, + tracker: tracker, + timerMap: timerMap, + msgCounter: 0, + } } func (c *Control) Run() { - xapp.Run(c) -} - -func (c *Control) Consume(mtype, sub_id int, len int, payload []byte) (err error) { - switch mtype { - case C.RIC_SUB_REQ: - err = c.handleSubscriptionRequest(&RmrDatagram{mtype, sub_id, payload}) - case C.RIC_SUB_RESP: - err = c.handleSubscriptionResponse(&RmrDatagram{mtype, sub_id, payload}) - default: - err = errors.New("Message Type "+strconv.Itoa(mtype)+" discarded") - } - return -} - -func (c *Control) rmrSend(datagram *RmrDatagram) (err error) { - if !xapp.Rmr.Send(datagram.MessageType, datagram.SubscriptionId, len(datagram.Payload), datagram.Payload) { - err = errors.New("rmr.Send() failed") - } - return -} - -func (c *Control) handleSubscriptionRequest(datagram *RmrDatagram) ( err error) { - /* TODO: removed to being able to integrate with UEMGR - content, err := c.e2ap.GetPayloadContent(datagram.Payload) - */ - xapp.Logger.Info("Subscription Request Message received with ID: %v", datagram.SubscriptionId) - new_sub_id := c.registry.GetSubscriptionId() - /* TODO: removed to being able to integrate with UEMGR - payload, err := c.e2ap.SetSubscriptionSequenceNumber(datagram.Payload, new_sub_id) - if err != nil { - xapp.Logger.Error("Unable to set Subscription Sequence Number in Payload due to: "+ err.Error()) - return - } - */ - xapp.Logger.Info("New Subscription Registered, forwarding to E2T") - c.rmrSend(&RmrDatagram{C.RIC_SUB_REQ , new_sub_id, datagram.Payload}) - return -} - -func (c *Control) handleSubscriptionResponse(datagram *RmrDatagram) ( err error) { - /* TODO: removed to being able to integrate with UEMGR - content, err := c.e2ap.GetPayloadContent(datagram.Payload) - */ - xapp.Logger.Info("Subscription Response Message received with ID: %v", datagram.SubscriptionId) - xapp.Logger.Info("Subscription Response Registered, forwarding to Requestor") - c.rmrSend(&RmrDatagram{C.RIC_SUB_RESP , datagram.SubscriptionId, datagram.Payload}) - return -} \ No newline at end of file + xapp.Run(c) +} + +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.RMRParams, false) + c.rmrSendMutex.Unlock() + if status == false { + xapp.Logger.Info("rmr.Send() failed. Retry count %d, %s", i, params.String()) + time.Sleep(500 * time.Millisecond) + } + } + if status == false { + 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) 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(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.handleXAPPSubscriptionRequest(msg) + case xapp.RICMessageTypes["RIC_SUB_RESP"]: + go c.handleE2TSubscriptionResponse(msg) + case xapp.RICMessageTypes["RIC_SUB_FAILURE"]: + go c.handleE2TSubscriptionFailure(msg) + case xapp.RICMessageTypes["RIC_SUB_DEL_REQ"]: + go c.handleXAPPSubscriptionDeleteRequest(msg) + case xapp.RICMessageTypes["RIC_SUB_DEL_RESP"]: + go c.handleE2TSubscriptionDeleteResponse(msg) + case xapp.RICMessageTypes["RIC_SUB_DEL_FAILURE"]: + go c.handleE2TSubscriptionDeleteFailure(msg) + default: + xapp.Logger.Info("Unknown Message Type '%d', discarding", msg.Mtype) + } + + return nil +} +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 = " " + } + if subs != nil { + retval += filler + subs.String() + filler = " " + } + if err != nil { + retval += filler + "err(" + err.Error() + ")" + filler = " " + + } + return retval +} + +//------------------------------------------------------------------- +// handle from XAPP Subscription Request +//------------------------------------------------------------------ +func (c *Control) handleXAPPSubscriptionRequest(params *RMRParams) { + xapp.Logger.Info("XAPP-SubReq from xapp: %s", params.String()) + + subReqMsg, err := c.e2ap.UnpackSubscriptionRequest(params.Payload) + if err != nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(params, nil, err)) + return + } + + trans, err := c.tracker.TrackTransaction(NewRmrEndpoint(params.Src), params.Xid, params.Meid) + if err != nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(params, nil, err)) + return + } + defer trans.Release() + + subs, err := c.registry.AssignToSubscription(trans, subReqMsg) + if err != nil { + xapp.Logger.Error("XAPP-SubReq: %s", idstring(trans, nil, err)) + return + } + + 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 + } + + // + // Wake subs request + // + go c.handleSubscriptionCreate(subs, trans) + event, _ := trans.WaitEvent(0) //blocked wait as timeout is handled in subs side + + err = nil + if event != nil { + switch themsg := event.(type) { + case *e2ap.E2APSubscriptionResponse: + trans.Mtype, trans.Payload, err = c.e2ap.PackSubscriptionResponse(themsg) + if err == nil { + c.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("XAPP-SubReq: failed %s", idstring(trans, subs, err)) +} + +//------------------------------------------------------------------- +// handle from XAPP Subscription Delete Request +//------------------------------------------------------------------ +func (c *Control) handleXAPPSubscriptionDeleteRequest(params *RMRParams) { + xapp.Logger.Info("XAPP-SubDelReq from xapp: %s", params.String()) + + subDelReqMsg, err := c.e2ap.UnpackSubscriptionDeleteRequest(params.Payload) + if err != nil { + xapp.Logger.Error("XAPP-SubDelReq %s", idstring(params, nil, err)) + return + } + + 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() + + subs, err := c.registry.GetSubscriptionFirstMatch([]uint16{uint16(subDelReqMsg.RequestId.Seq), uint16(params.SubId)}) + if err != nil { + xapp.Logger.Error("XAPP-SubDelReq: %s", idstring(trans, nil, err)) + return + } + + 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 + } + + // + // Wake subs delete + // + go c.handleSubscriptionDelete(subs, trans) + trans.WaitEvent(0) //blocked wait as timeout is handled in subs side + + // 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) + } +} + +//------------------------------------------------------------------- +// SUBS CREATE Handling +//------------------------------------------------------------------- +func (c *Control) handleSubscriptionCreate(subs *Subscription, parentTrans *Transaction) { + + trans := c.tracker.NewTransaction(subs.GetMeid()) + subs.WaitTransactionTurn(trans) + defer subs.ReleaseTransactionTurn(trans) + defer trans.Release() + + xapp.Logger.Debug("SUBS-SubReq: Handling %s parent %s", idstring(trans, subs, nil), parentTrans.String()) + + 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 + } + + 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) + } + + go c.registry.RemoveFromSubscription(subs, parentTrans, 5*time.Second) +} + +//------------------------------------------------------------------- +// SUBS DELETE Handling +//------------------------------------------------------------------- +func (c *Control) handleSubscriptionDelete(subs *Subscription, parentTrans *Transaction) { + + trans := c.tracker.NewTransaction(subs.GetMeid()) + subs.WaitTransactionTurn(trans) + defer subs.ReleaseTransactionTurn(trans) + defer trans.Release() + + xapp.Logger.Debug("SUBS-SubDelReq: Handling %s parent %s", idstring(trans, subs, nil), parentTrans.String()) + + event := c.sendE2TSubscriptionDeleteRequest(subs, trans, parentTrans) + + parentTrans.SendEvent(event, 0) + go c.registry.RemoveFromSubscription(subs, parentTrans, 5*time.Second) +} + +//------------------------------------------------------------------- +// 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 + } + + 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 + } + xapp.Logger.Debug("SUBS-SubReq: Response handling event(%s) %s parent %s", typeofSubsMessage(event), idstring(trans, subs, nil), parentTrans.String()) + return event +} + +//------------------------------------------------------------------- +// send to E2T Subscription Delete Request +//------------------------------------------------------------------- + +func (c *Control) sendE2TSubscriptionDeleteRequest(subs *Subscription, trans *Transaction, parentTrans *Transaction) interface{} { + var err error + var event interface{} + var timedOut bool + + 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("SUBS-SubDelReq: %s parent %s", idstring(trans, subs, err), parentTrans.String()) + return event + } + + 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 + } + break + } + xapp.Logger.Debug("SUBS-SubDelReq: Response handling event(%s) %s parent %s", typeofSubsMessage(event), idstring(trans, subs, nil), parentTrans.String()) + return event +} + +//------------------------------------------------------------------- +// 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("MSG-SubResp %s", idstring(params, nil, err)) + return + } + subs, err := c.registry.GetSubscriptionFirstMatch([]uint16{uint16(subRespMsg.RequestId.Seq), uint16(params.SubId)}) + if err != nil { + xapp.Logger.Error("MSG-SubResp: %s", idstring(params, nil, err)) + return + } + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubResp: %s", idstring(params, subs, err)) + 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 +} + +//------------------------------------------------------------------- +// 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 + } + subs, err := c.registry.GetSubscriptionFirstMatch([]uint16{uint16(subFailMsg.RequestId.Seq), uint16(params.SubId)}) + if err != nil { + xapp.Logger.Error("MSG-SubFail: %s", idstring(params, nil, err)) + return + } + 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 +} + +//------------------------------------------------------------------- +// 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("SUBS-SubDelResp: %s", idstring(params, nil, err)) + return + } + subs, err := c.registry.GetSubscriptionFirstMatch([]uint16{uint16(subDelRespMsg.RequestId.Seq), uint16(params.SubId)}) + if err != nil { + xapp.Logger.Error("SUBS-SubDelResp: %s", idstring(params, nil, err)) + return + } + 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 +} + +//------------------------------------------------------------------- +// 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 + } + 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 + } + trans := subs.GetTransaction() + if trans == nil { + err = fmt.Errorf("Ongoing transaction not found") + xapp.Logger.Error("MSG-SubDelFail: %s", idstring(params, subs, err)) + 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 +} + +//------------------------------------------------------------------- +// +//------------------------------------------------------------------- +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" + } +}