2 // Copyright 2019 AT&T Intellectual Property
3 // Copyright 2019 Nokia
4 // Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.
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
10 // http://www.apache.org/licenses/LICENSE-2.0
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.
18 // This source code is part of the near-RT RIC (RAN Intelligent Controller)
19 // platform project (RICP).
24 // #cgo LDFLAGS: -L/usr/local/lib -lrmr_si
25 // #include <rmr/rmr.h>
26 // #include <rmr/RIC_message_types.h>
27 // #include <stdlib.h>
35 func NewMBuf(mType int, len int, meid string, payload *[]byte, xAction *[]byte, msgSrc unsafe.Pointer) *MBuf {
46 func NewContext(maxMsgSize int, flags int, ctx unsafe.Pointer, logger *logger.Logger) *Context {
48 MaxMsgSize: maxMsgSize,
55 //TODO: consider declaring using its own type
58 RIC_X2_SETUP_REQ = C.RIC_X2_SETUP_REQ
59 RIC_X2_SETUP_RESP = C.RIC_X2_SETUP_RESP
60 RIC_X2_SETUP_FAILURE = C.RIC_X2_SETUP_FAILURE
61 RIC_ENDC_X2_SETUP_REQ = C.RIC_ENDC_X2_SETUP_REQ
62 RIC_ENDC_X2_SETUP_RESP = C.RIC_ENDC_X2_SETUP_RESP
63 RIC_ENDC_X2_SETUP_FAILURE = C.RIC_ENDC_X2_SETUP_FAILURE
64 RIC_SCTP_CONNECTION_FAILURE = C.RIC_SCTP_CONNECTION_FAILURE
65 RIC_ENB_LOAD_INFORMATION = C.RIC_ENB_LOAD_INFORMATION
66 RIC_ENB_CONF_UPDATE = C.RIC_ENB_CONF_UPDATE
67 RIC_ENB_CONFIGURATION_UPDATE_ACK = C.RIC_ENB_CONF_UPDATE_ACK
68 RIC_ENB_CONFIGURATION_UPDATE_FAILURE = C.RIC_ENB_CONF_UPDATE_FAILURE
69 RIC_ENDC_CONF_UPDATE = C.RIC_ENDC_CONF_UPDATE
70 RIC_ENDC_CONF_UPDATE_ACK = C.RIC_ENDC_CONF_UPDATE_ACK
71 RIC_ENDC_CONF_UPDATE_FAILURE = C.RIC_ENDC_CONF_UPDATE_FAILURE
72 RIC_SCTP_CLEAR_ALL = C.RIC_SCTP_CLEAR_ALL
73 RIC_X2_RESET_RESP = C.RIC_X2_RESET_RESP
74 RIC_X2_RESET = C.RIC_X2_RESET
75 RIC_E2_TERM_INIT = C.E2_TERM_INIT
76 RAN_CONNECTED = C.RAN_CONNECTED
77 RAN_RESTARTED = C.RAN_RESTARTED
78 RAN_RECONFIGURED = C.RAN_RECONFIGURED
79 E2_TERM_KEEP_ALIVE_REQ = C.E2_TERM_KEEP_ALIVE_REQ
80 E2_TERM_KEEP_ALIVE_RESP = C.E2_TERM_KEEP_ALIVE_RESP
81 RIC_E2_SETUP_REQ = C.RIC_E2_SETUP_REQ
82 RIC_E2_SETUP_RESP = C.RIC_E2_SETUP_RESP
83 RIC_E2_SETUP_FAILURE = C.RIC_E2_SETUP_FAILURE
84 RIC_SERVICE_QUERY = C.RIC_SERVICE_QUERY
85 RIC_SERVICE_UPDATE = C.RIC_SERVICE_UPDATE
86 RIC_SERVICE_UPDATE_ACK = C.RIC_SERVICE_UPDATE_ACK
87 RIC_SERVICE_UPDATE_FAILURE = C.RIC_SERVICE_UPDATE_FAILURE
91 RMR_MAX_XACTION_LEN = int(C.RMR_MAX_XID)
92 RMR_MAX_MEID_LEN = int(C.RMR_MAX_MEID)
93 RMR_MAX_SRC_LEN = int(C.RMR_MAX_SRC)
97 RMR_ERR_BADARG = C.RMR_ERR_BADARG
98 RMR_ERR_NOENDPT = C.RMR_ERR_NOENDPT
99 RMR_ERR_EMPTY = C.RMR_ERR_EMPTY
100 RMR_ERR_NOHDR = C.RMR_ERR_NOHDR
101 RMR_ERR_SENDFAILED = C.RMR_ERR_SENDFAILED
102 RMR_ERR_CALLFAILED = C.RMR_ERR_CALLFAILED
103 RMR_ERR_NOWHOPEN = C.RMR_ERR_NOWHOPEN
104 RMR_ERR_WHID = C.RMR_ERR_WHID
105 RMR_ERR_OVERFLOW = C.RMR_ERR_OVERFLOW
106 RMR_ERR_RETRY = C.RMR_ERR_RETRY
107 RMR_ERR_RCVFAILED = C.RMR_ERR_RCVFAILED
108 RMR_ERR_TIMEOUT = C.RMR_ERR_TIMEOUT
109 RMR_ERR_UNSET = C.RMR_ERR_UNSET
110 RMR_ERR_TRUNC = C.RMR_ERR_TRUNC
111 RMR_ERR_INITFAILED = C.RMR_ERR_INITFAILED
114 var states = map[int]string{
115 RMR_OK: "state is good",
116 RMR_ERR_BADARG: "argument passd to function was unusable",
117 RMR_ERR_NOENDPT: "send/call could not find an endpoint based on msg type",
118 RMR_ERR_EMPTY: "msg received had no payload; attempt to send an empty message",
119 RMR_ERR_NOHDR: "message didn't contain a valid header",
120 RMR_ERR_SENDFAILED: "send failed; errno has nano reason",
121 RMR_ERR_CALLFAILED: "unable to send call() message",
122 RMR_ERR_NOWHOPEN: "no wormholes are open",
123 RMR_ERR_WHID: "wormhole id was invalid",
124 RMR_ERR_OVERFLOW: "operation would have busted through a buffer/field size",
125 RMR_ERR_RETRY: "request (send/call/rts) failed, but caller should retry (EAGAIN for wrappers)",
126 RMR_ERR_RCVFAILED: "receive failed (hard error)",
127 RMR_ERR_TIMEOUT: "message processing call timed out",
128 RMR_ERR_UNSET: "the message hasn't been populated with a transport buffer",
129 RMR_ERR_TRUNC: "received message likely truncated",
130 RMR_ERR_INITFAILED: "initialisation of something (probably message) failed",
136 Meid string //Managed entity id (RAN name)
139 msgSrc unsafe.Pointer
142 func (m MBuf) String() string {
143 return fmt.Sprintf("{ MType: %d, Len: %d, Meid: %q, Xaction: %q, Payload: [%x] }", m.MType, m.Len, m.Meid, m.XAction, m.Payload)
146 func (m MBuf) GetMsgSrc() unsafe.Pointer {
150 type Context struct {
153 RmrCtx unsafe.Pointer
154 Logger *logger.Logger
157 type RmrMessenger interface {
158 Init(port string, maxMsgSize int, flags int, logger *logger.Logger) RmrMessenger
159 SendMsg(msg *MBuf, printLogs bool) (*MBuf, error)
160 WhSendMsg(msg *MBuf, printLogs bool) (*MBuf, error)
161 RecvMsg() (*MBuf, error)