RIC-194 Setup from RAN: On Routing Manager Failure, return Setup Failure
[ric-plt/e2mgr.git] / 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 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)
18 //  platform project (RICP).
19
20
21 package rmrCgo
22
23 // #cgo LDFLAGS: -L/usr/local/lib -lrmr_si
24 // #include <rmr/rmr.h>
25 // #include <rmr/RIC_message_types.h>
26 // #include <stdlib.h>
27 import "C"
28 import (
29         "e2mgr/logger"
30         "fmt"
31         "unsafe"
32 )
33
34 func NewMBuf(mType int, len int, meid string, payload *[]byte, xAction *[]byte, msgSrc unsafe.Pointer) *MBuf {
35         return &MBuf{
36                 mType,
37                 len,
38                 meid,
39                 payload,
40                 xAction,
41                 msgSrc,
42         }
43 }
44
45 func NewContext(maxMsgSize int, flags int, ctx unsafe.Pointer, logger *logger.Logger) *Context {
46         return &Context{
47                 MaxMsgSize: maxMsgSize,
48                 Flags:      flags,
49                 RmrCtx:     ctx,
50                 Logger:     logger,
51         }
52 }
53
54 //TODO: consider declaring using its own type
55 const (
56         // messages
57         RIC_X2_SETUP_REQ                     = C.RIC_X2_SETUP_REQ
58         RIC_X2_SETUP_RESP                    = C.RIC_X2_SETUP_RESP
59         RIC_X2_SETUP_FAILURE                 = C.RIC_X2_SETUP_FAILURE
60         RIC_ENDC_X2_SETUP_REQ                = C.RIC_ENDC_X2_SETUP_REQ
61         RIC_ENDC_X2_SETUP_RESP               = C.RIC_ENDC_X2_SETUP_RESP
62         RIC_ENDC_X2_SETUP_FAILURE            = C.RIC_ENDC_X2_SETUP_FAILURE
63         RIC_SCTP_CONNECTION_FAILURE          = C.RIC_SCTP_CONNECTION_FAILURE
64         RIC_ENB_LOAD_INFORMATION             = C.RIC_ENB_LOAD_INFORMATION
65         RIC_ENB_CONF_UPDATE                  = C.RIC_ENB_CONF_UPDATE
66         RIC_ENB_CONFIGURATION_UPDATE_ACK     = C.RIC_ENB_CONF_UPDATE_ACK
67         RIC_ENB_CONFIGURATION_UPDATE_FAILURE = C.RIC_ENB_CONF_UPDATE_FAILURE
68         RIC_ENDC_CONF_UPDATE                 = C.RIC_ENDC_CONF_UPDATE
69         RIC_ENDC_CONF_UPDATE_ACK             = C.RIC_ENDC_CONF_UPDATE_ACK
70         RIC_ENDC_CONF_UPDATE_FAILURE         = C.RIC_ENDC_CONF_UPDATE_FAILURE
71         RIC_SCTP_CLEAR_ALL                   = C.RIC_SCTP_CLEAR_ALL
72         RIC_X2_RESET_RESP                    = C.RIC_X2_RESET_RESP
73         RIC_X2_RESET                         = C.RIC_X2_RESET
74         RIC_E2_TERM_INIT                                         = C.E2_TERM_INIT
75         RAN_CONNECTED                                            = C.RAN_CONNECTED
76         RAN_RESTARTED                                            = C.RAN_RESTARTED
77         RAN_RECONFIGURED                                         = C.RAN_RECONFIGURED
78         E2_TERM_KEEP_ALIVE_REQ                           = C.E2_TERM_KEEP_ALIVE_REQ
79         E2_TERM_KEEP_ALIVE_RESP                          = C.E2_TERM_KEEP_ALIVE_RESP
80         RIC_E2_SETUP_REQ                                         = C.RIC_E2_SETUP_REQ
81         RIC_E2_SETUP_RESP                    = C.RIC_E2_SETUP_RESP
82         RIC_E2_SETUP_FAILURE                 = C.RIC_E2_SETUP_FAILURE
83 )
84
85 const (
86         RMR_MAX_XACTION_LEN = int(C.RMR_MAX_XID)
87         RMR_MAX_MEID_LEN    = int(C.RMR_MAX_MEID)
88         RMR_MAX_SRC_LEN                 = int(C.RMR_MAX_SRC)
89
90         //states
91         RMR_OK             = C.RMR_OK
92         RMR_ERR_BADARG     = C.RMR_ERR_BADARG
93         RMR_ERR_NOENDPT    = C.RMR_ERR_NOENDPT
94         RMR_ERR_EMPTY      = C.RMR_ERR_EMPTY
95         RMR_ERR_NOHDR      = C.RMR_ERR_NOHDR
96         RMR_ERR_SENDFAILED = C.RMR_ERR_SENDFAILED
97         RMR_ERR_CALLFAILED = C.RMR_ERR_CALLFAILED
98         RMR_ERR_NOWHOPEN   = C.RMR_ERR_NOWHOPEN
99         RMR_ERR_WHID       = C.RMR_ERR_WHID
100         RMR_ERR_OVERFLOW   = C.RMR_ERR_OVERFLOW
101         RMR_ERR_RETRY      = C.RMR_ERR_RETRY
102         RMR_ERR_RCVFAILED  = C.RMR_ERR_RCVFAILED
103         RMR_ERR_TIMEOUT    = C.RMR_ERR_TIMEOUT
104         RMR_ERR_UNSET      = C.RMR_ERR_UNSET
105         RMR_ERR_TRUNC      = C.RMR_ERR_TRUNC
106         RMR_ERR_INITFAILED = C.RMR_ERR_INITFAILED
107 )
108
109 var states = map[int]string{
110         RMR_OK:             "state is good",
111         RMR_ERR_BADARG:     "argument passd to function was unusable",
112         RMR_ERR_NOENDPT:    "send/call could not find an endpoint based on msg type",
113         RMR_ERR_EMPTY:      "msg received had no payload; attempt to send an empty message",
114         RMR_ERR_NOHDR:      "message didn't contain a valid header",
115         RMR_ERR_SENDFAILED: "send failed; errno has nano reason",
116         RMR_ERR_CALLFAILED: "unable to send call() message",
117         RMR_ERR_NOWHOPEN:   "no wormholes are open",
118         RMR_ERR_WHID:       "wormhole id was invalid",
119         RMR_ERR_OVERFLOW:   "operation would have busted through a buffer/field size",
120         RMR_ERR_RETRY:      "request (send/call/rts) failed, but caller should retry (EAGAIN for wrappers)",
121         RMR_ERR_RCVFAILED:  "receive failed (hard error)",
122         RMR_ERR_TIMEOUT:    "message processing call timed out",
123         RMR_ERR_UNSET:      "the message hasn't been populated with a transport buffer",
124         RMR_ERR_TRUNC:      "received message likely truncated",
125         RMR_ERR_INITFAILED: "initialisation of something (probably message) failed",
126 }
127
128 type MBuf struct {
129         MType   int
130         Len     int
131         Meid    string //Managed entity id (RAN name)
132         Payload *[]byte
133         XAction *[]byte
134         msgSrc  unsafe.Pointer
135 }
136
137 func (m MBuf) String() string {
138         return fmt.Sprintf("{ MType: %d, Len: %d, Meid: %q, Xaction: %q, Payload: [%x] }", m.MType, m.Len, m.Meid, m.XAction, m.Payload)
139 }
140
141 func (m MBuf) GetMsgSrc() unsafe.Pointer {
142         return m.msgSrc
143 }
144
145 type Context struct {
146         MaxMsgSize int
147         Flags      int
148         RmrCtx     unsafe.Pointer
149         Logger     *logger.Logger
150 }
151
152 type RmrMessenger interface {
153         Init(port string, maxMsgSize int, flags int, logger *logger.Logger) RmrMessenger
154         SendMsg(msg *MBuf, printLogs bool) (*MBuf, error)
155         WhSendMsg(msg *MBuf, printLogs bool) (*MBuf, error)
156         RecvMsg() (*MBuf, error)
157         IsReady() bool
158         Close()
159 }