Update README and example xApp

[ric-plt/xapp-frame.git] / pkg / xapp / rmr.go

diff --git a/pkg/xapp/rmr.go b/pkg/xapp/rmr.go
index 07ce55b..3a52c97 100755 (executable)
--- a/pkg/xapp/rmr.go
+++ b/pkg/xapp/rmr.go
@@ -37,6 +37,7 @@ void write_bytes_array(unsigned char *dst, void *data, int len) {
 import "C"
 
 import (
+       "fmt"
        "github.com/spf13/viper"
        "strconv"
        "strings"
@@ -51,6 +52,26 @@ var RMRCounterOpts = []CounterOpts{
        {Name: "ReceiveError", Help: "The total number of RMR receive errors"},
 }
 
+var RMRErrors = map[int]string{
+       C.RMR_OK:             "state is good",
+       C.RMR_ERR_BADARG:     "argument passed to function was unusable",
+       C.RMR_ERR_NOENDPT:    "send/call could not find an endpoint based on msg type",
+       C.RMR_ERR_EMPTY:      "msg received had no payload; attempt to send an empty message",
+       C.RMR_ERR_NOHDR:      "message didn't contain a valid header",
+       C.RMR_ERR_SENDFAILED: "send failed; errno has nano reason",
+       C.RMR_ERR_CALLFAILED: "unable to send call() message",
+       C.RMR_ERR_NOWHOPEN:   "no wormholes are open",
+       C.RMR_ERR_WHID:       "wormhole id was invalid",
+       C.RMR_ERR_OVERFLOW:   "operation would have busted through a buffer/field size",
+       C.RMR_ERR_RETRY:      "request (send/call/rts) failed, but caller should retry (EAGAIN for wrappers)",
+       C.RMR_ERR_RCVFAILED:  "receive failed (hard error)",
+       C.RMR_ERR_TIMEOUT:    "message processing call timed out",
+       C.RMR_ERR_UNSET:      "the message hasn't been populated with a transport buffer",
+       C.RMR_ERR_TRUNC:      "received message likely truncated",
+       C.RMR_ERR_INITFAILED: "initialization of something (probably message) failed",
+       C.RMR_ERR_NOTSUPP:    "the request is not supported, or RMr was not initialized for the request",
+}
+
 type RMRParams struct {
        Mtype      int
        Payload    []byte
@@ -62,9 +83,9 @@ type RMRParams struct {
        Mbuf       *C.rmr_mbuf_t
 }
 
-func NewRMRClient() *RMRClient {
-       p := C.CString(viper.GetString("rmr.protPort"))
-       m := C.int(viper.GetInt("rmr.maxSize"))
+func NewRMRClientWithParams(protPort string, maxSize int, numWorkers int, statDesc string) *RMRClient {
+       p := C.CString(protPort)
+       m := C.int(maxSize)
        defer C.free(unsafe.Pointer(p))
 
        ctx := C.rmr_init(p, m, C.int(0))
@@ -73,45 +94,55 @@ func NewRMRClient() *RMRClient {
        }
 
        return &RMRClient{
-               context:   ctx,
-               consumers: make([]MessageConsumer, 0),
-               stat:      Metric.RegisterCounterGroup(RMRCounterOpts, "RMR"),
+               protPort:   protPort,
+               numWorkers: numWorkers,
+               context:    ctx,
+               consumers:  make([]MessageConsumer, 0),
+               stat:       Metric.RegisterCounterGroup(RMRCounterOpts, statDesc),
        }
 }
 
+func NewRMRClient() *RMRClient {
+       return NewRMRClientWithParams(viper.GetString("rmr.protPort"), viper.GetInt("rmr.maxSize"), viper.GetInt("rmr.numWorkers"), "RMR")
+}
+
 func (m *RMRClient) Start(c MessageConsumer) {
        if c != nil {
                m.consumers = append(m.consumers, c)
        }
 
+       var counter int = 0
        for {
-               Logger.Info("rmrClient: Waiting for RMR to be ready ...")
-
                if m.ready = int(C.rmr_ready(m.context)); m.ready == 1 {
+                       Logger.Info("rmrClient: RMR is ready after %d seconds waiting...", counter)
                        break
                }
-               time.Sleep(10 * time.Second)
+               if counter%10 == 0 {
+                       Logger.Info("rmrClient: Waiting for RMR to be ready ...")
+               }
+               time.Sleep(1 * time.Second)
+               counter++
        }
-       m.wg.Add(viper.GetInt("rmr.numWorkers"))
+       m.wg.Add(m.numWorkers)
 
        if m.readyCb != nil {
                go m.readyCb(m.readyCbParams)
        }
 
-       for w := 0; w < viper.GetInt("rmr.numWorkers"); w++ {
+       for w := 0; w < m.numWorkers; w++ {
                go m.Worker("worker-"+strconv.Itoa(w), 0)
        }
        m.Wait()
 }
 
 func (m *RMRClient) Worker(taskName string, msgSize int) {
-       p := viper.GetString("rmr.protPort")
-       Logger.Info("rmrClient: '%s': receiving messages on [%s]", taskName, p)
+       Logger.Info("rmrClient: '%s': receiving messages on [%s]", taskName, m.protPort)
 
        defer m.wg.Done()
        for {
                rxBuffer := C.rmr_rcv_msg(m.context, nil)
                if rxBuffer == nil {
+                       m.LogMBufError("RecvMsg failed", rxBuffer)
                        m.UpdateStatCounter("ReceiveError")
                        continue
                }
@@ -187,6 +218,9 @@ func (m *RMRClient) Send(params *RMRParams, isRts bool) bool {
        txBuffer := params.Mbuf
        if txBuffer == nil {
                txBuffer = m.Allocate()
+               if txBuffer == nil {
+                       return false
+               }
        }
 
        txBuffer.mtype = C.int(params.Mtype)
@@ -206,7 +240,7 @@ func (m *RMRClient) Send(params *RMRParams, isRts bool) bool {
                }
                xidLen := len(params.Xid)
                if xidLen > 0 && xidLen <= C.RMR_MAX_XID {
-                       b := make([]byte, int(C.RMR_MAX_MEID))
+                       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)))
                }
@@ -232,7 +266,7 @@ func (m *RMRClient) SendBuf(txBuffer *C.rmr_mbuf_t, isRts bool) bool {
 
        if currBuffer == nil {
                m.UpdateStatCounter("TransmitError")
-               return false
+               return m.LogMBufError("SendBuf failed", txBuffer)
        }
 
        // Just quick retry seems to help for K8s issue
@@ -245,8 +279,8 @@ func (m *RMRClient) SendBuf(txBuffer *C.rmr_mbuf_t, isRts bool) bool {
        }
 
        if currBuffer.state != C.RMR_OK {
-               state = false
                counterName = "TransmitError"
+               state = m.LogMBufError("SendBuf failed", currBuffer)
        }
 
        m.UpdateStatCounter(counterName)
@@ -291,6 +325,11 @@ func (m *RMRClient) GetRicMessageName(id int) (s string) {
        return
 }
 
+func (m *RMRClient) LogMBufError(text string, mbuf *C.rmr_mbuf_t) bool {
+       Logger.Debug(fmt.Sprintf("rmrClient: %s -> [tp=%v] %v - %s", text, mbuf.tp_state, mbuf.state, RMRErrors[int(mbuf.state)]))
+       return false
+}
+
 // To be removed ...
 func (m *RMRClient) GetStat() (r RMRStatistics) {
        return