E2Manager/rmrCgo/rmrCgoTypes.go

   1 //
   2 // Copyright 2019 AT&T Intellectual Property
   3 // Copyright 2019 Nokia
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the "License");
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //      http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 package rmrCgo
  19
  20 // #cgo LDFLAGS: -L/usr/local/lib -lrmr_nng -lnng
  21 // #include <rmr/rmr.h>
  22 // #include <rmr/RIC_message_types.h>
  23 // #include <stdlib.h>
  24 import "C"
  25 import (
  26         "e2mgr/logger"
  27         "fmt"
  28         "unsafe"
  29 )
  30
  31 func NewMBuf(mType int, len int, meid string, payload *[]byte, xAction *[]byte) *MBuf {
  32         return &MBuf{
  33                 MType:   mType,
  34                 Len:     len,
  35                 Meid:    meid,
  36                 Payload: payload,
  37                 XAction: xAction,
  38         }
  39 }
  40
  41 func NewContext(maxMsgSize int, flags int, ctx unsafe.Pointer, logger *logger.Logger) *Context {
  42         return &Context{
  43                 MaxMsgSize: maxMsgSize,
  44                 Flags:      flags,
  45                 RmrCtx:     ctx,
  46                 Logger:     logger,
  47         }
  48 }
  49 //TODO: consider declaring using its own type
  50 const (
  51         // messages
  52         RIC_X2_SETUP_REQ            = C.RIC_X2_SETUP_REQ
  53         RIC_X2_SETUP_RESP           = C.RIC_X2_SETUP_RESP
  54         RIC_X2_SETUP_FAILURE        = C.RIC_X2_SETUP_FAILURE
  55         RIC_ENDC_X2_SETUP_REQ       = C.RIC_ENDC_X2_SETUP_REQ
  56         RIC_ENDC_X2_SETUP_RESP      =C.RIC_ENDC_X2_SETUP_RESP
  57         RIC_ENDC_X2_SETUP_FAILURE   = C.RIC_ENDC_X2_SETUP_FAILURE
  58         RIC_SCTP_CONNECTION_FAILURE = C.RIC_SCTP_CONNECTION_FAILURE
  59         RIC_ENB_LOAD_INFORMATION    = C.RIC_ENB_LOAD_INFORMATION
  60         RIC_ENB_CONF_UPDATE             = C.RIC_ENB_CONF_UPDATE
  61         RIC_ENB_CONFIGURATION_UPDATE_ACK = C.RIC_ENB_CONF_UPDATE_ACK
  62         RIC_ENB_CONFIGURATION_UPDATE_FAILURE = C.RIC_ENB_CONF_UPDATE_FAILURE
  63         RIC_ENDC_CONF_UPDATE            = C.RIC_ENDC_CONF_UPDATE
  64         RIC_ENDC_CONF_UPDATE_ACK = C.RIC_ENDC_CONF_UPDATE_ACK
  65         RIC_ENDC_CONF_UPDATE_FAILURE = C.RIC_ENDC_CONF_UPDATE_FAILURE
  66         RIC_SCTP_CLEAR_ALL                      = C.RIC_SCTP_CLEAR_ALL
  67         RIC_X2_RESET_RESP                       = C.RIC_X2_RESET_RESP
  68 )
  69
  70 const (
  71         RMR_MAX_XACTION_LEN = int(C.RMR_MAX_XID)
  72         RMR_MAX_MEID_LEN    = int(C.RMR_MAX_MEID)
  73
  74         //states
  75     RMR_OK                              = C.RMR_OK
  76     RMR_ERR_BADARG              = C.RMR_ERR_BADARG
  77     RMR_ERR_NOENDPT             = C.RMR_ERR_NOENDPT
  78     RMR_ERR_EMPTY               = C.RMR_ERR_EMPTY
  79     RMR_ERR_NOHDR               = C.RMR_ERR_NOHDR
  80     RMR_ERR_SENDFAILED  = C.RMR_ERR_SENDFAILED
  81     RMR_ERR_CALLFAILED  = C.RMR_ERR_CALLFAILED
  82     RMR_ERR_NOWHOPEN    = C.RMR_ERR_NOWHOPEN
  83     RMR_ERR_WHID                = C.RMR_ERR_WHID
  84     RMR_ERR_OVERFLOW    = C.RMR_ERR_OVERFLOW
  85     RMR_ERR_RETRY               = C.RMR_ERR_RETRY
  86     RMR_ERR_RCVFAILED   = C.RMR_ERR_RCVFAILED
  87     RMR_ERR_TIMEOUT             = C.RMR_ERR_TIMEOUT
  88     RMR_ERR_UNSET       = C.RMR_ERR_UNSET
  89     RMR_ERR_TRUNC       = C.RMR_ERR_TRUNC
  90     RMR_ERR_INITFAILED  = C.RMR_ERR_INITFAILED
  91 )
  92
  93 var states = map[int]string {
  94         RMR_OK                          :       "state is good",
  95         RMR_ERR_BADARG          :       "argument passd to function was unusable",
  96         RMR_ERR_NOENDPT         :       "send/call could not find an endpoint based on msg type",
  97         RMR_ERR_EMPTY           :       "msg received had no payload; attempt to send an empty message",
  98         RMR_ERR_NOHDR           :       "message didn't contain a valid header",
  99         RMR_ERR_SENDFAILED      :       "send failed; errno has nano reason",
 100         RMR_ERR_CALLFAILED      :       "unable to send call() message",
 101         RMR_ERR_NOWHOPEN        :       "no wormholes are open",
 102         RMR_ERR_WHID            :       "wormhole id was invalid",
 103         RMR_ERR_OVERFLOW        :       "operation would have busted through a buffer/field size",
 104         RMR_ERR_RETRY           :       "request (send/call/rts) failed, but caller should retry (EAGAIN for wrappers)",
 105         RMR_ERR_RCVFAILED       :       "receive failed (hard error)",
 106         RMR_ERR_TIMEOUT         :       "message processing call timed out",
 107         RMR_ERR_UNSET       :   "the message hasn't been populated with a transport buffer",
 108         RMR_ERR_TRUNC       :   "received message likely truncated",
 109         RMR_ERR_INITFAILED  :   "initialisation of something (probably message) failed",
 110 }
 111
 112 type MBuf struct {
 113         MType   int
 114         Len     int
 115         Meid    string //Managed entity id (RAN name)
 116         Payload *[]byte
 117         XAction *[]byte
 118 }
 119
 120 func (m MBuf) String () string {
 121         return fmt.Sprintf("{ MType: %d, Len: %d, Meid: %q, Xaction: %q, Payload: [%x] }", m.MType, m.Len, m.Meid, m.XAction, m.Payload)
 122 }
 123
 124 type Context struct {
 125         MaxMsgSize     int
 126         Flags          int
 127         RmrCtx         unsafe.Pointer
 128         Logger         *logger.Logger
 129 }
 130
 131 type RmrMessenger interface {
 132         Init(port string, maxMsgSize int, flags int, logger *logger.Logger) *RmrMessenger
 133         SendMsg(msg *MBuf, maxMsgSize int) (*MBuf, error)
 134         RecvMsg() (*MBuf, error)
 135         RtsMsg(msg *MBuf)
 136         IsReady() bool
 137         Close()
 138 }