pkg/xapp/rmr.go

   1 /*
   2 ==================================================================================
   3   Copyright (c) 2019 AT&T Intellectual Property.
   4   Copyright (c) 2019 Nokia
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 */
  19
  20 package xapp
  21
  22 /*
  23 #include <time.h>
  24 #include <stdlib.h>
  25 #include <stdio.h>
  26 #include <string.h>
  27 #include <rmr/rmr.h>
  28 #include <rmr/RIC_message_types.h>
  29
  30 void write_bytes_array(unsigned char *dst, void *data, int len) {
  31     memcpy((void *)dst, (void *)data, len);
  32 }
  33
  34 #cgo CFLAGS: -I../
  35 #cgo LDFLAGS: -lrmr_nng -lnng
  36 */
  37 import "C"
  38
  39 import (
  40         "github.com/spf13/viper"
  41         "strconv"
  42         "strings"
  43         "time"
  44         "unsafe"
  45 )
  46
  47 var RMRCounterOpts = []CounterOpts{
  48         {Name: "Transmitted", Help: "The total number of transmited RMR messages"},
  49         {Name: "Received", Help: "The total number of received RMR messages"},
  50         {Name: "TransmitError", Help: "The total number of RMR transmission errors"},
  51         {Name: "ReceiveError", Help: "The total number of RMR receive errors"},
  52 }
  53
  54 type RMRParams struct {
  55         Mtype      int
  56         Payload    []byte
  57         PayloadLen int
  58         Meid       *RMRMeid
  59         Xid        string
  60         SubId      int
  61         Src        string
  62         Mbuf       *C.rmr_mbuf_t
  63 }
  64
  65 func NewRMRClient() *RMRClient {
  66         p := C.CString(viper.GetString("rmr.protPort"))
  67         m := C.int(viper.GetInt("rmr.maxSize"))
  68         defer C.free(unsafe.Pointer(p))
  69
  70         ctx := C.rmr_init(p, m, C.int(0))
  71         if ctx == nil {
  72                 Logger.Error("rmrClient: Initializing RMR context failed, bailing out!")
  73         }
  74
  75         return &RMRClient{
  76                 context:   ctx,
  77                 consumers: make([]MessageConsumer, 0),
  78                 stat:      Metric.RegisterCounterGroup(RMRCounterOpts, "RMR"),
  79         }
  80 }
  81
  82 func (m *RMRClient) Start(c MessageConsumer) {
  83         if c != nil {
  84                 m.consumers = append(m.consumers, c)
  85         }
  86
  87         for {
  88                 Logger.Info("rmrClient: Waiting for RMR to be ready ...")
  89
  90                 if m.ready = int(C.rmr_ready(m.context)); m.ready == 1 {
  91                         break
  92                 }
  93                 time.Sleep(10 * time.Second)
  94         }
  95         m.wg.Add(viper.GetInt("rmr.numWorkers"))
  96
  97         if m.readyCb != nil {
  98                 go m.readyCb(m.readyCbParams)
  99         }
 100
 101         for w := 0; w < viper.GetInt("rmr.numWorkers"); w++ {
 102                 go m.Worker("worker-"+strconv.Itoa(w), 0)
 103         }
 104         m.Wait()
 105 }
 106
 107 func (m *RMRClient) Worker(taskName string, msgSize int) {
 108         p := viper.GetString("rmr.protPort")
 109         Logger.Info("rmrClient: '%s': receiving messages on [%s]", taskName, p)
 110
 111         defer m.wg.Done()
 112         for {
 113                 rxBuffer := C.rmr_rcv_msg(m.context, nil)
 114                 if rxBuffer == nil {
 115                         m.UpdateStatCounter("ReceiveError")
 116                         continue
 117                 }
 118                 m.UpdateStatCounter("Received")
 119
 120                 go m.parseMessage(rxBuffer)
 121         }
 122 }
 123
 124 func (m *RMRClient) parseMessage(rxBuffer *C.rmr_mbuf_t) {
 125         if len(m.consumers) == 0 {
 126                 Logger.Info("rmrClient: No message handlers defined, message discarded!")
 127                 return
 128         }
 129
 130         params := &RMRParams{}
 131         params.Mbuf = rxBuffer
 132         params.Mtype = int(rxBuffer.mtype)
 133         params.SubId = int(rxBuffer.sub_id)
 134         params.Meid = &RMRMeid{}
 135
 136         meidBuf := make([]byte, int(C.RMR_MAX_MEID))
 137         if meidCstr := C.rmr_get_meid(rxBuffer, (*C.uchar)(unsafe.Pointer(&meidBuf[0]))); meidCstr != nil {
 138                 params.Meid.RanName = strings.TrimRight(string(meidBuf), "\000")
 139         }
 140
 141         xidBuf := make([]byte, int(C.RMR_MAX_XID))
 142         if xidCstr := C.rmr_get_xact(rxBuffer, (*C.uchar)(unsafe.Pointer(&xidBuf[0]))); xidCstr != nil {
 143                 params.Xid = strings.TrimRight(string(xidBuf[0:32]), "\000")
 144         }
 145
 146         srcBuf := make([]byte, int(C.RMR_MAX_SRC))
 147         if srcStr := C.rmr_get_src(rxBuffer, (*C.uchar)(unsafe.Pointer(&srcBuf[0]))); srcStr != nil {
 148                 params.Src = strings.TrimRight(string(srcBuf[0:64]), "\000")
 149         }
 150
 151         for _, c := range m.consumers {
 152                 cptr := unsafe.Pointer(rxBuffer.payload)
 153                 params.Payload = C.GoBytes(cptr, C.int(rxBuffer.len))
 154                 params.PayloadLen = int(rxBuffer.len)
 155
 156                 err := c.Consume(params)
 157                 if err != nil {
 158                         Logger.Warn("rmrClient: Consumer returned error: %v", err)
 159                 }
 160         }
 161 }
 162
 163 func (m *RMRClient) Allocate() *C.rmr_mbuf_t {
 164         buf := C.rmr_alloc_msg(m.context, 0)
 165         if buf == nil {
 166                 Logger.Error("rmrClient: Allocating message buffer failed!")
 167         }
 168         return buf
 169 }
 170
 171 func (m *RMRClient) Free(mbuf *C.rmr_mbuf_t) {
 172         if mbuf == nil {
 173                 Logger.Error("rmrClient: Can't free mbuffer, given nil pointer")
 174                 return
 175         }
 176         C.rmr_free_msg(mbuf)
 177 }
 178
 179 func (m *RMRClient) SendMsg(params *RMRParams) bool {
 180         return m.SendBuffer(params, false)
 181 }
 182
 183 func (m *RMRClient) SendRts(params *RMRParams) bool {
 184         return m.SendBuffer(params, true)
 185 }
 186
 187 func (m *RMRClient) SendBuffer(params *RMRParams, isRts bool) bool {
 188         defer m.Free(params.Mbuf)
 189         for i := 0; i < 10; i++ {
 190                 errCode := m.Send(params, isRts)
 191                 if errCode == C.RMR_OK {
 192                         m.UpdateStatCounter("Transmitted")
 193                         return true
 194                 }
 195                 if errCode != C.RMR_ERR_RETRY {
 196                         Logger.Error("rmrClient: rmr_send returned hard error - %d", errCode)
 197                         break
 198                 }
 199
 200         }
 201         m.UpdateStatCounter("TransmitError")
 202         return false
 203 }
 204
 205 func (m *RMRClient) Send(params *RMRParams, isRts bool) C.int {
 206         txBuffer := params.Mbuf
 207         if txBuffer == nil {
 208                 txBuffer = m.Allocate()
 209         }
 210
 211         txBuffer.mtype = C.int(params.Mtype)
 212         txBuffer.sub_id = C.int(params.SubId)
 213         txBuffer.len = C.int(len(params.Payload))
 214         if params.PayloadLen != 0 {
 215                 txBuffer.len = C.int(params.PayloadLen)
 216         }
 217         datap := C.CBytes(params.Payload)
 218         defer C.free(datap)
 219
 220         if params != nil {
 221                 if params.Meid != nil {
 222                         b := make([]byte, int(C.RMR_MAX_MEID))
 223                         copy(b, []byte(params.Meid.RanName))
 224                         C.rmr_bytes2meid(txBuffer, (*C.uchar)(unsafe.Pointer(&b[0])), C.int(len(b)))
 225                 }
 226                 xidLen := len(params.Xid)
 227                 if xidLen > 0 && xidLen <= C.RMR_MAX_XID {
 228                         b := make([]byte, int(C.RMR_MAX_MEID))
 229                         copy(b, []byte(params.Xid))
 230                         C.rmr_bytes2xact(txBuffer, (*C.uchar)(unsafe.Pointer(&b[0])), C.int(len(b)))
 231                 }
 232         }
 233         C.write_bytes_array(txBuffer.payload, datap, txBuffer.len)
 234
 235         txBuffer.state = 0
 236         currBuffer := txBuffer
 237         if isRts {
 238                 currBuffer = C.rmr_rts_msg(m.context, txBuffer)
 239         } else {
 240                 currBuffer = C.rmr_send_msg(m.context, txBuffer)
 241         }
 242
 243         if currBuffer != nil {
 244                 return currBuffer.state
 245         }
 246         return -1
 247 }
 248
 249 func (m *RMRClient) UpdateStatCounter(name string) {
 250         m.mux.Lock()
 251         m.stat[name].Inc()
 252         m.mux.Unlock()
 253 }
 254
 255 func (m *RMRClient) RegisterMetrics() {
 256         m.stat = Metric.RegisterCounterGroup(RMRCounterOpts, "RMR")
 257 }
 258
 259 func (m *RMRClient) Wait() {
 260         m.wg.Wait()
 261 }
 262
 263 func (m *RMRClient) IsReady() bool {
 264         return m.ready != 0
 265 }
 266
 267 func (m *RMRClient) SetReadyCB(cb ReadyCB, params interface{}) {
 268         m.readyCb = cb
 269         m.readyCbParams = params
 270 }
 271
 272 func (m *RMRClient) GetRicMessageId(name string) (int, bool) {
 273         id, ok := RICMessageTypes[name]
 274         return id, ok
 275 }
 276
 277 func (m *RMRClient) GetRicMessageName(id int) (s string) {
 278         for k, v := range RICMessageTypes {
 279                 if id == v {
 280                         return k
 281                 }
 282         }
 283         return
 284 }
 285
 286 // To be removed ...
 287 func (m *RMRClient) GetStat() (r RMRStatistics) {
 288         return
 289 }