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
  50 //TODO: consider declaring using its own type
  51 const (
  52         // messages
  53         RIC_X2_SETUP_REQ                     = C.RIC_X2_SETUP_REQ
  54         RIC_X2_SETUP_RESP                    = C.RIC_X2_SETUP_RESP
  55         RIC_X2_SETUP_FAILURE                 = C.RIC_X2_SETUP_FAILURE
  56         RIC_ENDC_X2_SETUP_REQ                = C.RIC_ENDC_X2_SETUP_REQ
  57         RIC_ENDC_X2_SETUP_RESP               = C.RIC_ENDC_X2_SETUP_RESP
  58         RIC_ENDC_X2_SETUP_FAILURE            = C.RIC_ENDC_X2_SETUP_FAILURE
  59         RIC_SCTP_CONNECTION_FAILURE          = C.RIC_SCTP_CONNECTION_FAILURE
  60         RIC_ENB_LOAD_INFORMATION             = C.RIC_ENB_LOAD_INFORMATION
  61         RIC_ENB_CONF_UPDATE                  = C.RIC_ENB_CONF_UPDATE
  62         RIC_ENB_CONFIGURATION_UPDATE_ACK     = C.RIC_ENB_CONF_UPDATE_ACK
  63         RIC_ENB_CONFIGURATION_UPDATE_FAILURE = C.RIC_ENB_CONF_UPDATE_FAILURE
  64         RIC_ENDC_CONF_UPDATE                 = C.RIC_ENDC_CONF_UPDATE
  65         RIC_ENDC_CONF_UPDATE_ACK             = C.RIC_ENDC_CONF_UPDATE_ACK
  66         RIC_ENDC_CONF_UPDATE_FAILURE         = C.RIC_ENDC_CONF_UPDATE_FAILURE
  67         RIC_SCTP_CLEAR_ALL                   = C.RIC_SCTP_CLEAR_ALL
  68         RIC_X2_RESET_RESP                    = C.RIC_X2_RESET_RESP
  69         RIC_X2_RESET                         = C.RIC_X2_RESET
  70 )
  71
  72 const (
  73         RMR_MAX_XACTION_LEN = int(C.RMR_MAX_XID)
  74         RMR_MAX_MEID_LEN    = int(C.RMR_MAX_MEID)
  75
  76         //states
  77         RMR_OK             = C.RMR_OK
  78         RMR_ERR_BADARG     = C.RMR_ERR_BADARG
  79         RMR_ERR_NOENDPT    = C.RMR_ERR_NOENDPT
  80         RMR_ERR_EMPTY      = C.RMR_ERR_EMPTY
  81         RMR_ERR_NOHDR      = C.RMR_ERR_NOHDR
  82         RMR_ERR_SENDFAILED = C.RMR_ERR_SENDFAILED
  83         RMR_ERR_CALLFAILED = C.RMR_ERR_CALLFAILED
  84         RMR_ERR_NOWHOPEN   = C.RMR_ERR_NOWHOPEN
  85         RMR_ERR_WHID       = C.RMR_ERR_WHID
  86         RMR_ERR_OVERFLOW   = C.RMR_ERR_OVERFLOW
  87         RMR_ERR_RETRY      = C.RMR_ERR_RETRY
  88         RMR_ERR_RCVFAILED  = C.RMR_ERR_RCVFAILED
  89         RMR_ERR_TIMEOUT    = C.RMR_ERR_TIMEOUT
  90         RMR_ERR_UNSET      = C.RMR_ERR_UNSET
  91         RMR_ERR_TRUNC      = C.RMR_ERR_TRUNC
  92         RMR_ERR_INITFAILED = C.RMR_ERR_INITFAILED
  93 )
  94
  95 var states = map[int]string{
  96         RMR_OK:             "state is good",
  97         RMR_ERR_BADARG:     "argument passd to function was unusable",
  98         RMR_ERR_NOENDPT:    "send/call could not find an endpoint based on msg type",
  99         RMR_ERR_EMPTY:      "msg received had no payload; attempt to send an empty message",
 100         RMR_ERR_NOHDR:      "message didn't contain a valid header",
 101         RMR_ERR_SENDFAILED: "send failed; errno has nano reason",
 102         RMR_ERR_CALLFAILED: "unable to send call() message",
 103         RMR_ERR_NOWHOPEN:   "no wormholes are open",
 104         RMR_ERR_WHID:       "wormhole id was invalid",
 105         RMR_ERR_OVERFLOW:   "operation would have busted through a buffer/field size",
 106         RMR_ERR_RETRY:      "request (send/call/rts) failed, but caller should retry (EAGAIN for wrappers)",
 107         RMR_ERR_RCVFAILED:  "receive failed (hard error)",
 108         RMR_ERR_TIMEOUT:    "message processing call timed out",
 109         RMR_ERR_UNSET:      "the message hasn't been populated with a transport buffer",
 110         RMR_ERR_TRUNC:      "received message likely truncated",
 111         RMR_ERR_INITFAILED: "initialisation of something (probably message) failed",
 112 }
 113
 114 type MBuf struct {
 115         MType   int
 116         Len     int
 117         Meid    string //Managed entity id (RAN name)
 118         Payload *[]byte
 119         XAction *[]byte
 120 }
 121
 122 func (m MBuf) String() string {
 123         return fmt.Sprintf("{ MType: %d, Len: %d, Meid: %q, Xaction: %q, Payload: [%x] }", m.MType, m.Len, m.Meid, m.XAction, m.Payload)
 124 }
 125
 126 type Context struct {
 127         MaxMsgSize int
 128         Flags      int
 129         RmrCtx     unsafe.Pointer
 130         Logger     *logger.Logger
 131 }
 132
 133 type RmrMessenger interface {
 134         Init(port string, maxMsgSize int, flags int, logger *logger.Logger) *RmrMessenger
 135         SendMsg(msg *MBuf, maxMsgSize int) (*MBuf, error)
 136         RecvMsg() (*MBuf, error)
 137         RtsMsg(msg *MBuf)
 138         IsReady() bool
 139         Close()
 140 }