Backward compatible with old xApp descriptor
[ric-plt/xapp-frame.git] / pkg / xapp / rmr.go
index 90bc64b..ef8aea5 100755 (executable)
@@ -64,6 +64,8 @@ int wait_epoll(int epoll_fd,int rcv_fd) {
 import "C"
 
 import (
+       "bytes"
+       "crypto/md5"
        "fmt"
        "github.com/spf13/viper"
        "strings"
@@ -98,6 +100,9 @@ var RMRErrors = map[int]string{
        C.RMR_ERR_NOTSUPP:    "the request is not supported, or RMr was not initialized for the request",
 }
 
+//-----------------------------------------------------------------------------
+//
+//-----------------------------------------------------------------------------
 type RMRParams struct {
        Mtype      int
        Payload    []byte
@@ -113,25 +118,73 @@ type RMRParams struct {
        status     int
 }
 
-func NewRMRClientWithParams(protPort string, maxSize int, threadType int, statDesc string) *RMRClient {
-       p := C.CString(protPort)
-       m := C.int(maxSize)
-       c := C.int(threadType)
+func (params *RMRParams) String() string {
+       var b bytes.Buffer
+       fmt.Fprintf(&b, "params(Src=%s Mtype=%d SubId=%d Xid=%s Meid=%s Paylens=%d/%d Paymd5=%x)", params.Src, params.Mtype, params.SubId, params.Xid, params.Meid, params.PayloadLen, len(params.Payload), md5.Sum(params.Payload))
+       return b.String()
+}
+
+//-----------------------------------------------------------------------------
+//
+//-----------------------------------------------------------------------------
+type RMRClientParams struct {
+       StatDesc string
+       RmrData  PortData
+}
+
+func (params *RMRClientParams) String() string {
+       return fmt.Sprintf("ProtPort=%d MaxSize=%d ThreadType=%d StatDesc=%s LowLatency=%t FastAck=%t Policies=%v",
+               params.RmrData.Port, params.RmrData.MaxSize, params.RmrData.ThreadType, params.StatDesc,
+               params.RmrData.LowLatency, params.RmrData.FastAck, params.RmrData.Policies)
+}
+
+//-----------------------------------------------------------------------------
+//
+//-----------------------------------------------------------------------------
+func NewRMRClientWithParams(params *RMRClientParams) *RMRClient {
+       p := C.CString(fmt.Sprintf("%d", params.RmrData.Port))
+       m := C.int(params.RmrData.MaxSize)
+       c := C.int(params.RmrData.ThreadType)
        defer C.free(unsafe.Pointer(p))
        ctx := C.rmr_init(p, m, c)
        if ctx == nil {
                Logger.Error("rmrClient: Initializing RMR context failed, bailing out!")
        }
+
+       Logger.Info("new rmrClient with parameters: %s", params.String())
+
+       if params.RmrData.LowLatency {
+               C.rmr_set_low_latency(ctx)
+       }
+       if params.RmrData.FastAck {
+               C.rmr_set_fack(ctx)
+       }
+
        return &RMRClient{
-               protPort:  protPort,
-               context:   ctx,
-               consumers: make([]MessageConsumer, 0),
-               stat:      Metric.RegisterCounterGroup(RMRCounterOpts, statDesc),
+               context:           ctx,
+               consumers:         make([]MessageConsumer, 0),
+               stat:              Metric.RegisterCounterGroup(RMRCounterOpts, params.StatDesc),
+               maxRetryOnFailure: params.RmrData.MaxRetryOnFailure,
        }
 }
 
 func NewRMRClient() *RMRClient {
-       return NewRMRClientWithParams(viper.GetString("rmr.protPort"), viper.GetInt("rmr.maxSize"), viper.GetInt("rmr.threadType"), "RMR")
+       p := GetPortData("rmr-data")
+       if p.Port == 0 || viper.IsSet("rmr.protPort") {
+               // Old xApp descriptor used, fallback to rmr section
+               fmt.Sscanf(viper.GetString("rmr.protPort"), "tcp:%d", &p.Port)
+               p.MaxSize = viper.GetInt("rmr.maxSize")
+               p.ThreadType = viper.GetInt("rmr.threadType")
+               p.LowLatency = viper.GetBool("rmr.lowLatency")
+               p.FastAck = viper.GetBool("rmr.fastAck")
+               p.MaxRetryOnFailure = viper.GetInt("rmr.maxRetryOnFailure")
+       }
+
+       return NewRMRClientWithParams(
+               &RMRClientParams{
+                       RmrData:  p,
+                       StatDesc: "RMR",
+               })
 }
 
 func (m *RMRClient) Start(c MessageConsumer) {
@@ -244,11 +297,21 @@ func (m *RMRClient) parseMessage(rxBuffer *C.rmr_mbuf_t) {
 func (m *RMRClient) Allocate(size int) *C.rmr_mbuf_t {
        m.contextMux.Lock()
        defer m.contextMux.Unlock()
-       buf := C.rmr_alloc_msg(m.context, C.int(size))
-       if buf == nil {
+       outbuf := C.rmr_alloc_msg(m.context, C.int(size))
+       if outbuf == nil {
+               Logger.Error("rmrClient: Allocating message buffer failed!")
+       }
+       return outbuf
+}
+
+func (m *RMRClient) ReAllocate(inbuf *C.rmr_mbuf_t, size int) *C.rmr_mbuf_t {
+       m.contextMux.Lock()
+       defer m.contextMux.Unlock()
+       outbuf := C.rmr_realloc_msg(inbuf, C.int(size))
+       if outbuf == nil {
                Logger.Error("rmrClient: Allocating message buffer failed!")
        }
-       return buf
+       return outbuf
 }
 
 func (m *RMRClient) Free(mbuf *C.rmr_mbuf_t) {
@@ -268,10 +331,29 @@ func (m *RMRClient) SendRts(params *RMRParams) bool {
        return m.Send(params, true)
 }
 
+func (m *RMRClient) SendWithRetry(params *RMRParams, isRts bool, to time.Duration) (err error) {
+       status := m.Send(params, isRts)
+       i := 0
+       for ; i < int(to)*2 && status == false; i++ {
+               status = m.Send(params, isRts)
+               if status == false {
+                       time.Sleep(500 * time.Millisecond)
+               }
+       }
+       if status == false {
+               err = fmt.Errorf("Failed with retries(%d) %s", i, params.String())
+               if params.Mbuf != nil {
+                       m.Free(params.Mbuf)
+                       params.Mbuf = nil
+               }
+       }
+       return
+}
+
 func (m *RMRClient) CopyBuffer(params *RMRParams) *C.rmr_mbuf_t {
-       if params.Mbuf != nil {
-               m.Free(params.Mbuf)
-               params.Mbuf = nil
+
+       if params == nil {
+               return nil
        }
 
        payLen := len(params.Payload)
@@ -279,7 +361,15 @@ func (m *RMRClient) CopyBuffer(params *RMRParams) *C.rmr_mbuf_t {
                payLen = params.PayloadLen
        }
 
-       txBuffer := m.Allocate(payLen)
+       txBuffer := params.Mbuf
+       params.Mbuf = nil
+
+       if txBuffer != nil {
+               txBuffer = m.ReAllocate(txBuffer, payLen)
+       } else {
+               txBuffer = m.Allocate(payLen)
+       }
+
        if txBuffer == nil {
                return nil
        }
@@ -290,20 +380,21 @@ func (m *RMRClient) CopyBuffer(params *RMRParams) *C.rmr_mbuf_t {
        datap := C.CBytes(params.Payload)
        defer C.free(datap)
 
-       if params != nil {
-               if params.Meid != nil {
-                       b := make([]byte, int(C.RMR_MAX_MEID))
-                       copy(b, []byte(params.Meid.RanName))
-                       C.rmr_bytes2meid(txBuffer, (*C.uchar)(unsafe.Pointer(&b[0])), C.int(len(b)))
-               }
-               xidLen := len(params.Xid)
-               if xidLen > 0 && xidLen <= C.RMR_MAX_XID {
-                       b := make([]byte, int(C.RMR_MAX_XID))
-                       copy(b, []byte(params.Xid))
-                       C.rmr_bytes2xact(txBuffer, (*C.uchar)(unsafe.Pointer(&b[0])), C.int(len(b)))
-               }
+       if params.Meid != nil {
+               b := make([]byte, int(C.RMR_MAX_MEID))
+               copy(b, []byte(params.Meid.RanName))
+               C.rmr_bytes2meid(txBuffer, (*C.uchar)(unsafe.Pointer(&b[0])), C.int(len(b)))
+       }
+
+       xidLen := len(params.Xid)
+       if xidLen > 0 && xidLen <= C.RMR_MAX_XID {
+               b := make([]byte, int(C.RMR_MAX_XID))
+               copy(b, []byte(params.Xid))
+               C.rmr_bytes2xact(txBuffer, (*C.uchar)(unsafe.Pointer(&b[0])), C.int(len(b)))
        }
+
        C.write_bytes_array(txBuffer.payload, datap, txBuffer.len)
+
        return txBuffer
 }
 
@@ -322,8 +413,7 @@ func (m *RMRClient) Send(params *RMRParams, isRts bool) bool {
 
 func (m *RMRClient) SendBuf(txBuffer *C.rmr_mbuf_t, isRts bool, whid int) int {
        var (
-               currBuffer  *C.rmr_mbuf_t
-               counterName string = "Transmitted"
+               currBuffer *C.rmr_mbuf_t
        )
 
        m.contextMux.Lock()
@@ -345,12 +435,11 @@ func (m *RMRClient) SendBuf(txBuffer *C.rmr_mbuf_t, isRts bool, whid int) int {
        }
 
        // Just quick retry seems to help for K8s issue
-       maxRetryOnFailure := viper.GetInt("rmr.maxRetryOnFailure")
-       if maxRetryOnFailure == 0 {
-               maxRetryOnFailure = 5
+       if m.maxRetryOnFailure == 0 {
+               m.maxRetryOnFailure = 5
        }
 
-       for j := 0; j < maxRetryOnFailure && currBuffer != nil && currBuffer.state == C.RMR_ERR_RETRY; j++ {
+       for j := 0; j < m.maxRetryOnFailure && currBuffer != nil && currBuffer.state == C.RMR_ERR_RETRY; j++ {
                m.contextMux.Lock()
                if whid != 0 {
                        currBuffer = C.rmr_wh_send_msg(m.context, C.rmr_whid_t(whid), txBuffer)
@@ -364,15 +453,21 @@ func (m *RMRClient) SendBuf(txBuffer *C.rmr_mbuf_t, isRts bool, whid int) int {
                m.contextMux.Unlock()
        }
 
-       if currBuffer.state != C.RMR_OK {
-               counterName = "TransmitError"
+       if currBuffer == nil {
+               m.UpdateStatCounter("TransmitError")
                m.LogMBufError("SendBuf failed", currBuffer)
+               return int(C.RMR_ERR_INITFAILED)
        }
 
-       m.UpdateStatCounter(counterName)
+       if currBuffer.state != C.RMR_OK {
+               m.UpdateStatCounter("TransmitError")
+               m.LogMBufError("SendBuf failed", currBuffer)
+       } else {
+               m.UpdateStatCounter("Transmitted")
+       }
        defer m.Free(currBuffer)
-
        return int(currBuffer.state)
+
 }
 
 func (m *RMRClient) SendCallMsg(params *RMRParams) (int, string) {
@@ -483,11 +578,10 @@ func (m *RMRClient) GetRicMessageName(id int) (s string) {
 }
 
 func (m *RMRClient) LogMBufError(text string, mbuf *C.rmr_mbuf_t) int {
-       Logger.Debug(fmt.Sprintf("rmrClient: %s -> [tp=%v] %v - %s", text, mbuf.tp_state, mbuf.state, RMRErrors[int(mbuf.state)]))
-       return int(mbuf.state)
-}
-
-// To be removed ...
-func (m *RMRClient) GetStat() (r RMRStatistics) {
-       return
+       if mbuf != nil {
+               Logger.Debug(fmt.Sprintf("rmrClient: %s -> [tp=%v] %v - %s", text, mbuf.tp_state, mbuf.state, RMRErrors[int(mbuf.state)]))
+               return int(mbuf.state)
+       }
+       Logger.Debug(fmt.Sprintf("rmrClient: %s -> mbuf nil", text))
+       return 0
 }