X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=pkg%2Fxapp%2Frmr.go;h=0aeced219009dd3d54e3aa8d2477bd94c0ef6f12;hb=refs%2Ftags%2Fv0.4.2;hp=8bbae7b3ee820ce4b249986a9ddfa916935cd4da;hpb=19461e199260b58e24f03c992b27477bb859d691;p=ric-plt%2Fxapp-frame.git diff --git a/pkg/xapp/rmr.go b/pkg/xapp/rmr.go index 8bbae7b..0aeced2 100755 --- a/pkg/xapp/rmr.go +++ b/pkg/xapp/rmr.go @@ -32,11 +32,12 @@ void write_bytes_array(unsigned char *dst, void *data, int len) { } #cgo CFLAGS: -I../ -#cgo LDFLAGS: -lrmr_nng -lnng +#cgo LDFLAGS: -lrmr_si */ 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 @@ -60,58 +81,75 @@ type RMRParams struct { SubId int Src string Mbuf *C.rmr_mbuf_t + Whid int + Callid int + Timeout int + status int } -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, threadType int, statDesc string) *RMRClient { + p := C.CString(protPort) + m := C.int(maxSize) + c := C.int(threadType) defer C.free(unsafe.Pointer(p)) - ctx := C.rmr_init(p, m, C.int(0)) + //ctx := C.rmr_init(p, m, C.int(0)) + //ctx := C.rmr_init(p, m, C.RMRFL_NOTHREAD) + ctx := C.rmr_init(p, m, c) if ctx == nil { Logger.Error("rmrClient: Initializing RMR context failed, bailing out!") } 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"), viper.GetInt("rmr.threadType"), "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 } @@ -148,10 +186,24 @@ func (m *RMRClient) parseMessage(rxBuffer *C.rmr_mbuf_t) { params.Src = strings.TrimRight(string(srcBuf[0:64]), "\000") } + // Default case: a single consumer + if len(m.consumers) == 1 && m.consumers[0] != nil { + params.PayloadLen = int(rxBuffer.len) + params.Payload = (*[1 << 30]byte)(unsafe.Pointer(rxBuffer.payload))[:params.PayloadLen:params.PayloadLen] + err := m.consumers[0].Consume(params) + if err != nil { + Logger.Warn("rmrClient: Consumer returned error: %v", err) + } + return + } + + // Special case for multiple consumers for _, c := range m.consumers { cptr := unsafe.Pointer(rxBuffer.payload) params.Payload = C.GoBytes(cptr, C.int(rxBuffer.len)) params.PayloadLen = int(rxBuffer.len) + params.Mtype = int(rxBuffer.mtype) + params.SubId = int(rxBuffer.sub_id) err := c.Consume(params) if err != nil { @@ -165,10 +217,16 @@ func (m *RMRClient) Allocate() *C.rmr_mbuf_t { if buf == nil { Logger.Error("rmrClient: Allocating message buffer failed!") } - return buf } +func (m *RMRClient) Free(mbuf *C.rmr_mbuf_t) { + if mbuf == nil { + return + } + C.rmr_free_msg(mbuf) +} + func (m *RMRClient) SendMsg(params *RMRParams) bool { return m.Send(params, false) } @@ -177,15 +235,21 @@ func (m *RMRClient) SendRts(params *RMRParams) bool { return m.Send(params, true) } -func (m *RMRClient) Send(params *RMRParams, isRts bool) bool { - buf := params.Mbuf - if buf == nil { - buf = m.Allocate() +func (m *RMRClient) CopyBuffer(params *RMRParams) *C.rmr_mbuf_t { + txBuffer := params.Mbuf + if txBuffer == nil { + txBuffer = m.Allocate() + if txBuffer == nil { + return nil + } } - buf.mtype = C.int(params.Mtype) - buf.sub_id = C.int(params.SubId) - buf.len = C.int(len(params.Payload)) + txBuffer.mtype = C.int(params.Mtype) + txBuffer.sub_id = C.int(params.SubId) + txBuffer.len = C.int(len(params.Payload)) + if params.PayloadLen != 0 { + txBuffer.len = C.int(params.PayloadLen) + } datap := C.CBytes(params.Payload) defer C.free(datap) @@ -193,47 +257,144 @@ func (m *RMRClient) Send(params *RMRParams, isRts bool) bool { if params.Meid != nil { b := make([]byte, int(C.RMR_MAX_MEID)) copy(b, []byte(params.Meid.RanName)) - C.rmr_bytes2meid(buf, (*C.uchar)(unsafe.Pointer(&b[0])), C.int(len(b))) + 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_MEID)) + b := make([]byte, int(C.RMR_MAX_XID)) copy(b, []byte(params.Xid)) - C.rmr_bytes2xact(buf, (*C.uchar)(unsafe.Pointer(&b[0])), C.int(len(b))) + C.rmr_bytes2xact(txBuffer, (*C.uchar)(unsafe.Pointer(&b[0])), C.int(len(b))) } } - C.write_bytes_array(buf.payload, datap, buf.len) + C.write_bytes_array(txBuffer.payload, datap, txBuffer.len) + return txBuffer +} + +func (m *RMRClient) Send(params *RMRParams, isRts bool) bool { - return m.SendBuf(buf, isRts) + txBuffer := m.CopyBuffer(params) + if txBuffer == nil { + return false + } + params.status = m.SendBuf(txBuffer, isRts, params.Whid) + if params.status == int(C.RMR_OK) { + return true + } + return false } -func (m *RMRClient) SendBuf(txBuffer *C.rmr_mbuf_t, isRts bool) bool { - for i := 0; i < 10; i++ { - txBuffer.state = 0 +func (m *RMRClient) SendBuf(txBuffer *C.rmr_mbuf_t, isRts bool, whid int) int { + var ( + currBuffer *C.rmr_mbuf_t + counterName string = "Transmitted" + ) + + txBuffer.state = 0 + if whid != 0 { + currBuffer = C.rmr_wh_send_msg(m.context, C.rmr_whid_t(whid), txBuffer) + } else { if isRts { - txBuffer = C.rmr_rts_msg(m.context, txBuffer) + currBuffer = C.rmr_rts_msg(m.context, txBuffer) } else { - txBuffer = C.rmr_send_msg(m.context, txBuffer) + currBuffer = C.rmr_send_msg(m.context, txBuffer) } + } - if txBuffer == nil { - break - } else if txBuffer.state != C.RMR_OK { - if txBuffer.state != C.RMR_ERR_RETRY { - time.Sleep(100 * time.Microsecond) - m.UpdateStatCounter("TransmitError") - } - for j := 0; j < 100 && txBuffer.state == C.RMR_ERR_RETRY; j++ { - txBuffer = C.rmr_send_msg(m.context, txBuffer) + if currBuffer == nil { + m.UpdateStatCounter("TransmitError") + return m.LogMBufError("SendBuf failed", txBuffer) + } + + // Just quick retry seems to help for K8s issue + maxRetryOnFailure := viper.GetInt("rmr.maxRetryOnFailure") + if maxRetryOnFailure == 0 { + maxRetryOnFailure = 5 + } + + for j := 0; j < maxRetryOnFailure && currBuffer != nil && currBuffer.state == C.RMR_ERR_RETRY; j++ { + if whid != 0 { + currBuffer = C.rmr_wh_send_msg(m.context, C.rmr_whid_t(whid), txBuffer) + } else { + if isRts { + currBuffer = C.rmr_rts_msg(m.context, txBuffer) + } else { + currBuffer = C.rmr_send_msg(m.context, txBuffer) } } + } - if txBuffer.state == C.RMR_OK { - m.UpdateStatCounter("Transmitted") - return true - } + if currBuffer.state != C.RMR_OK { + counterName = "TransmitError" + m.LogMBufError("SendBuf failed", currBuffer) + } + + m.UpdateStatCounter(counterName) + defer m.Free(currBuffer) + + return int(currBuffer.state) +} + +func (m *RMRClient) SendCallMsg(params *RMRParams) (int, string) { + var ( + currBuffer *C.rmr_mbuf_t + counterName string = "Transmitted" + ) + txBuffer := m.CopyBuffer(params) + if txBuffer == nil { + return C.RMR_ERR_INITFAILED, "" + } + + txBuffer.state = 0 + + currBuffer = C.rmr_wh_call(m.context, C.int(params.Whid), txBuffer, C.int(params.Callid), C.int(params.Timeout)) + + if currBuffer == nil { + m.UpdateStatCounter("TransmitError") + return m.LogMBufError("SendBuf failed", txBuffer), "" + } + + if currBuffer.state != C.RMR_OK { + counterName = "TransmitError" + m.LogMBufError("SendBuf failed", currBuffer) + } + + m.UpdateStatCounter(counterName) + defer m.Free(currBuffer) + + cptr := unsafe.Pointer(currBuffer.payload) + payload := C.GoBytes(cptr, C.int(currBuffer.len)) + + return int(currBuffer.state), string(payload) +} + +func (m *RMRClient) Openwh(target string) C.rmr_whid_t { + return m.Wh_open(target) +} + +func (m *RMRClient) Wh_open(target string) C.rmr_whid_t { + endpoint := C.CString(target) + return C.rmr_wh_open(m.context, endpoint) +} + +func (m *RMRClient) Closewh(whid int) { + m.Wh_close(C.rmr_whid_t(whid)) +} + +func (m *RMRClient) Wh_close(whid C.rmr_whid_t) { + C.rmr_wh_close(m.context, whid) +} + +func (m *RMRClient) IsRetryError(params *RMRParams) bool { + if params.status == int(C.RMR_ERR_RETRY) { + return true + } + return false +} + +func (m *RMRClient) IsNoEndPointError(params *RMRParams) bool { + if params.status == int(C.RMR_ERR_NOENDPT) { + return true } - m.UpdateStatCounter("TransmitError") return false } @@ -274,6 +435,11 @@ func (m *RMRClient) GetRicMessageName(id int) (s string) { return } +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