#include <rmr/rmr.h>
#include <rmr/RIC_message_types.h>
+
void write_bytes_array(unsigned char *dst, void *data, int len) {
memcpy((void *)dst, (void *)data, len);
}
import "C"
import (
+ "bytes"
+ "crypto/md5"
"fmt"
- "github.com/spf13/viper"
"strings"
"time"
"unsafe"
+
+ "github.com/spf13/viper"
)
var RMRCounterOpts = []CounterOpts{
{Name: "Transmitted", Help: "The total number of transmited RMR messages"},
- {Name: "Received", Help: "The total number of received RMR messages"},
{Name: "TransmitError", Help: "The total number of RMR transmission errors"},
+ {Name: "TransmitRetry", Help: "The total number of transmit retries on failure"},
+ {Name: "Received", Help: "The total number of received RMR messages"},
{Name: "ReceiveError", Help: "The total number of RMR receive errors"},
+ {Name: "SendWithRetryRetry", Help: "SendWithRetry service retries"},
+}
+
+var RMRGaugeOpts = []CounterOpts{
+ {Name: "Enqueued", Help: "The total number of enqueued in RMR library"},
+ {Name: "Dropped", Help: "The total number of dropped in RMR library"},
}
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
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),
+ statc: Metric.RegisterCounterGroup(RMRCounterOpts, params.StatDesc),
+ statg: Metric.RegisterGaugeGroup(RMRGaugeOpts, 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("rmrdata")
+ 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) {
time.Sleep(1 * time.Second)
counter++
}
- m.wg.Add(1)
if m.readyCb != nil {
go m.readyCb(m.readyCbParams)
}
+ m.wg.Add(1)
go func() {
m.contextMux.Lock()
rfd := C.rmr_get_rcvfd(m.context)
defer m.wg.Done()
for {
+
if int(C.wait_epoll(efd, rfd)) == 0 {
continue
}
}
}()
+ m.wg.Add(1)
+ go func() {
+ defer m.wg.Done()
+ for {
+ m.UpdateRmrStats()
+ time.Sleep(1 * time.Second)
+ }
+ }()
+
m.wg.Wait()
}
+func (m *RMRClient) UpdateRmrStats() {
+ param := (*C.rmr_rx_debug_t)(C.malloc(C.size_t(unsafe.Sizeof(C.rmr_rx_debug_t{}))))
+ m.contextMux.Lock()
+ C.rmr_get_rx_debug_info(m.context, param)
+ m.contextMux.Unlock()
+ m.mux.Lock()
+ m.statg["Enqueued"].Set(float64(param.enqueue))
+ m.statg["Dropped"].Set(float64(param.drop))
+ m.mux.Unlock()
+ C.free(unsafe.Pointer(param))
+}
+
func (m *RMRClient) parseMessage(rxBuffer *C.rmr_mbuf_t) {
if len(m.consumers) == 0 {
Logger.Info("rmrClient: No message handlers defined, message discarded!")
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)
+ /*
+ // 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 {
- Logger.Warn("rmrClient: Consumer returned error: %v", err)
+ err := c.Consume(params)
+ if err != nil {
+ Logger.Warn("rmrClient: Consumer returned error: %v", err)
+ }
}
- }
+ */
}
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) {
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 {
+ m.UpdateStatCounter("SendWithRetryRetry")
+ 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)
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
}
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
}
}
func (m *RMRClient) SendBuf(txBuffer *C.rmr_mbuf_t, isRts bool, whid int) int {
- var (
- currBuffer *C.rmr_mbuf_t
- counterName string = "Transmitted"
- )
-
- m.contextMux.Lock()
txBuffer.state = 0
- 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)
- }
- }
- m.contextMux.Unlock()
-
- 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
+ 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; j++ {
m.contextMux.Lock()
if whid != 0 {
- currBuffer = C.rmr_wh_send_msg(m.context, C.rmr_whid_t(whid), txBuffer)
+ txBuffer = C.rmr_wh_send_msg(m.context, C.rmr_whid_t(whid), txBuffer)
} else {
if isRts {
- currBuffer = C.rmr_rts_msg(m.context, txBuffer)
+ txBuffer = C.rmr_rts_msg(m.context, txBuffer)
} else {
- currBuffer = C.rmr_send_msg(m.context, txBuffer)
+ txBuffer = C.rmr_send_msg(m.context, txBuffer)
}
}
m.contextMux.Unlock()
+ if j+1 <= m.maxRetryOnFailure && txBuffer != nil && txBuffer.state == C.RMR_ERR_RETRY {
+ m.UpdateStatCounter("TransmitRetry")
+ continue
+ }
+ break
}
- if currBuffer.state != C.RMR_OK {
- counterName = "TransmitError"
- m.LogMBufError("SendBuf failed", currBuffer)
+ if txBuffer == nil {
+ m.UpdateStatCounter("TransmitError")
+ m.LogMBufError("SendBuf failed", txBuffer)
+ return int(C.RMR_ERR_INITFAILED)
}
- m.UpdateStatCounter(counterName)
- defer m.Free(currBuffer)
+ if txBuffer.state != C.RMR_OK {
+ m.UpdateStatCounter("TransmitError")
+ m.LogMBufError("SendBuf failed", txBuffer)
+ } else {
+ m.UpdateStatCounter("Transmitted")
+ }
+ defer m.Free(txBuffer)
+ return int(txBuffer.state)
- return int(currBuffer.state)
}
func (m *RMRClient) SendCallMsg(params *RMRParams) (int, string) {
func (m *RMRClient) UpdateStatCounter(name string) {
m.mux.Lock()
- m.stat[name].Inc()
+ m.statc[name].Inc()
m.mux.Unlock()
}
func (m *RMRClient) RegisterMetrics() {
- m.stat = Metric.RegisterCounterGroup(RMRCounterOpts, "RMR")
+ m.statc = Metric.RegisterCounterGroup(RMRCounterOpts, "RMR")
+ m.statg = Metric.RegisterGaugeGroup(RMRGaugeOpts, "RMR")
}
func (m *RMRClient) Wait() {
}
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
}