2 ==================================================================================
3 Copyright (c) 2019 AT&T Intellectual Property.
4 Copyright (c) 2019 Nokia
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.
19 This source code is part of the near-RT RIC (RAN Intelligent Controller)
20 platform project (RICP).
22 ==================================================================================
26 Abstract: Contains RPE (Route Policy Engine) module definitions and generic RPE components
34 "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
35 "routing-manager/pkg/rtmgr"
36 "routing-manager/pkg/sbi"
42 SupportedRpes = []*EngineConfig{
47 Instance: NewRmrPush(),
53 func GetRpe(rpeName string) (Engine, error) {
54 for _, rpe := range SupportedRpes {
55 if rpe.Name == rpeName && rpe.IsAvailable {
56 return rpe.Instance, nil
59 return nil, errors.New("SBI:" + rpeName + " is not supported or still not a available")
65 func getEndpointByName(eps *rtmgr.Endpoints, name string) *rtmgr.Endpoint {
66 for _, ep := range *eps {
68 xapp.Logger.Debug("name: %s", ep.Name)
69 xapp.Logger.Debug("ep: %v", ep)
76 func getEndpointListByName(eps *rtmgr.Endpoints, name string) []rtmgr.Endpoint {
77 var eplist []rtmgr.Endpoint
79 for _, ep := range *eps {
81 xapp.Logger.Debug("name: %s", ep.Name)
82 xapp.Logger.Debug("ep: %v", ep)
83 eplist = append(eplist, *ep)
89 func getEndpointByUuid(uuid string) *rtmgr.Endpoint {
90 endPoints := rtmgr.Eps
91 for _, ep := range endPoints {
93 xapp.Logger.Debug("name: %s", ep.Uuid)
94 xapp.Logger.Debug("ep: %v", ep)
101 func (r *Rpe) addRoute(messageType string, tx *rtmgr.Endpoint, rx *rtmgr.Endpoint, routeTable *rtmgr.RouteTable, subId int32, routeType string) {
102 txList := rtmgr.EndpointList{}
103 rxList := []rtmgr.EndpointList{}
105 if tx == nil && rx == nil {
106 pc, _, _, ok := runtime.Caller(1)
107 details := runtime.FuncForPC(pc)
108 if ok && details != nil {
109 xapp.Logger.Error("Route addition skipped: Either TX or RX endpoint not present. Caller function is %s", details.Name())
113 txList = rtmgr.EndpointList{*tx}
116 rxList = []rtmgr.EndpointList{[]rtmgr.Endpoint{*rx}}
118 messageId := strconv.Itoa(xapp.RICMessageTypes[messageType])
119 route := rtmgr.RouteTableEntry{
120 MessageType: messageId,
124 RouteType: routeType}
125 *routeTable = append(*routeTable, route)
126 // xapp.Logger.Debug("Route added: MessageTyp: %v, Tx: %v, Rx: %v, SubId: %v", messageId, tx.Uuid, rx.Uuid, subId)
127 // xapp.Logger.Trace("Route added: MessageTyp: %v, Tx: %v, Rx: %v, SubId: %v", messageId, tx, rx, subId)
131 func (r *Rpe) addRoute_rx_list(messageType string, tx *rtmgr.Endpoint, rx []rtmgr.Endpoint, routeTable *rtmgr.RouteTable, subId int32, routeType string) {
132 txList := rtmgr.EndpointList{}
133 rxList := []rtmgr.EndpointList{}
136 txList = rtmgr.EndpointList{*tx}
140 for _, item := range rx {
141 ep := []rtmgr.Endpoint{item}
142 rxList = append(rxList, ep)
146 messageId := strconv.Itoa(xapp.RICMessageTypes[messageType])
147 route := rtmgr.RouteTableEntry{
148 MessageType: messageId,
152 RouteType: routeType}
153 *routeTable = append(*routeTable, route)
154 // xapp.Logger.Debug("Route added: MessageTyp: %v, Tx: %v, Rx: %v, SubId: %v", messageId, tx.Uuid, rx.Uuid, subId)
155 // xapp.Logger.Trace("Route added: MessageTyp: %v, Tx: %v, Rx: %v, SubId: %v", messageId, tx, rx, subId)
158 func (r *Rpe) generateXappRoutes(xAppEp *rtmgr.Endpoint, subManEp *rtmgr.Endpoint, routeTable *rtmgr.RouteTable) {
159 xapp.Logger.Debug("rpe.generateXappRoutes invoked")
160 xapp.Logger.Debug("Endpoint: %v, xAppType: %v", xAppEp.Name, xAppEp.XAppType)
161 if xAppEp.XAppType != sbi.PlatformType && (len(xAppEp.TxMessages) > 0 || len(xAppEp.RxMessages) > 0) {
163 //xApp -> Subscription Manager
164 r.addRoute("RIC_SUB_REQ", xAppEp, subManEp, routeTable, -1, "")
165 r.addRoute("RIC_SUB_DEL_REQ", xAppEp, subManEp, routeTable, -1, "")
166 //xApp -> E2 Termination
167 // r.addRoute("RIC_CONTROL_REQ", xAppEp, e2TermEp, routeTable, -1, "")
168 r.addRoute("RIC_CONTROL_REQ", xAppEp, nil, routeTable, -1, "%meid")
169 //E2 Termination -> xApp
170 /// r.addRoute("RIC_CONTROL_ACK", e2TermEp, xAppEp, routeTable, -1, "")
171 /// r.addRoute("RIC_CONTROL_FAILURE", e2TermEp, xAppEp, routeTable, -1, "")
172 r.addRoute("RIC_CONTROL_ACK", nil, xAppEp, routeTable, -1, "")
173 r.addRoute("RIC_CONTROL_FAILURE", nil, xAppEp, routeTable, -1, "")
176 if xAppEp.XAppType != sbi.PlatformType && len(xAppEp.Policies) > 0 {
177 xapp.Logger.Debug("rpe.generateXappRoutes found policies section")
178 for _, policy := range xAppEp.Policies {
179 r.addRoute("A1_POLICY_REQ", nil, xAppEp, routeTable, policy, "")
186 func (r *Rpe) generateXappToXappRoutes(RecvxAppEp *rtmgr.Endpoint, endPointList rtmgr.Endpoints, routeTable *rtmgr.RouteTable) {
187 xapp.Logger.Debug("rpe.generateXappToXappRoutes invoked")
189 for _, rxmsg := range RecvxAppEp.RxMessages {
192 xapp.Logger.Debug("RecvxAppEp.RxMessages Endpoint: %v, xAppType: %v and rxmsg: %v ", RecvxAppEp.Name, RecvxAppEp.XAppType, rxmsg)
193 if (rxmsg != "RIC_SUB_RESP" && rxmsg != "RIC_SUB_FAILURE" && rxmsg != "RIC_SUB_DEL_RESP" && rxmsg != "RIC_SUB_DEL_FAILURE" && rxmsg != "RIC_INDICATION" && rxmsg != "RIC_CONTROL_ACK" && rxmsg != "RIC_CONTROL_FAILURE" && rxmsg != "A1_POLICY_REQ") {
194 for _, SrcxAppEp := range endPointList {
195 if SrcxAppEp.XAppType != sbi.PlatformType && (len(SrcxAppEp.TxMessages) > 0) && SrcxAppEp.Name != RecvxAppEp.Name {
196 for _, txmsg := range SrcxAppEp.TxMessages {
197 if (rxmsg == txmsg) {
198 r.addRoute(rxmsg, SrcxAppEp, RecvxAppEp, routeTable, -1, "")
205 if src_present == false {
206 r.addRoute(rxmsg, nil, RecvxAppEp, routeTable, -1, "")
213 func (r *Rpe) generateSubscriptionRoutes(selectedxAppEp *rtmgr.Endpoint, subManEp *rtmgr.Endpoint, routeTable *rtmgr.RouteTable) {
214 xapp.Logger.Debug("rpe.addSubscriptionRoutes invoked")
215 subscriptionList := &rtmgr.Subs
216 for _, subscription := range *subscriptionList {
217 xapp.Logger.Debug("Subscription: %v", subscription)
218 xAppUuid := subscription.Fqdn + ":" + strconv.Itoa(int(subscription.Port))
219 xapp.Logger.Debug("xApp UUID: %v", xAppUuid)
220 xAppEp := getEndpointByUuid(xAppUuid)
221 if xAppEp.Uuid == selectedxAppEp.Uuid {
222 xapp.Logger.Debug("xApp UUID is matched for selected xApp.UUID: %v and xApp.Name: %v", selectedxAppEp.Uuid, selectedxAppEp.Name)
224 //Subscription Manager -> xApp
225 r.addRoute("RIC_SUB_RESP", subManEp, xAppEp, routeTable, subscription.SubID, "")
226 r.addRoute("RIC_SUB_FAILURE", subManEp, xAppEp, routeTable, subscription.SubID, "")
227 r.addRoute("RIC_SUB_DEL_RESP", subManEp, xAppEp, routeTable, subscription.SubID, "")
228 r.addRoute("RIC_SUB_DEL_FAILURE", subManEp, xAppEp, routeTable, subscription.SubID, "")
229 //E2 Termination -> xApp
230 r.addRoute("RIC_INDICATION", nil, xAppEp, routeTable, subscription.SubID, "")
231 r.addRoute("RIC_CONTROL_ACK", nil, xAppEp, routeTable, subscription.SubID, "")
232 r.addRoute("RIC_CONTROL_FAILURE", nil, xAppEp, routeTable, subscription.SubID, "")
237 func (r *Rpe) generatePlatformRoutes(e2TermEp []rtmgr.Endpoint, subManEp *rtmgr.Endpoint, e2ManEp *rtmgr.Endpoint, rsmEp *rtmgr.Endpoint, a1mediatorEp *rtmgr.Endpoint, routeTable *rtmgr.RouteTable) {
238 xapp.Logger.Debug("rpe.generatePlatformRoutes invoked")
239 //Platform Routes --- Subscription Routes
240 //Subscription Manager -> E2 Termination
241 for _, routes := range *rtmgr.PrsCfg {
242 var sendEp *rtmgr.Endpoint
243 var Ep *rtmgr.Endpoint
244 switch routes.SenderEndPoint {
254 sendEp = a1mediatorEp
256 switch routes.EndPoint {
269 r.addRoute(routes.MessageType, sendEp, Ep, routeTable, routes.SubscriptionId, routes.Meid)
272 if len(e2TermEp) > 0 {
273 r.addRoute_rx_list("RIC_SCTP_CLEAR_ALL", e2ManEp, e2TermEp, routeTable, -1, "")
274 r.addRoute_rx_list("E2_TERM_KEEP_ALIVE_REQ", e2ManEp, e2TermEp, routeTable, -1, "")
275 r.addRoute_rx_list("RIC_E2_SETUP_RESP", e2ManEp, e2TermEp, routeTable, -1, "")
276 r.addRoute_rx_list("RIC_E2_SETUP_FAILURE", e2ManEp, e2TermEp, routeTable, -1, "")
280 func (r *Rpe) generateRouteTable(endPointList rtmgr.Endpoints) *rtmgr.RouteTable {
281 xapp.Logger.Debug("rpe.generateRouteTable invoked")
282 xapp.Logger.Debug("Endpoint List: %v", endPointList)
283 routeTable := &rtmgr.RouteTable{}
284 /*e2TermEp := getEndpointByName(&endPointList, "E2TERM")
286 xapp.Logger.Error("Platform component not found: %v", "E2 Termination")
287 xapp.Logger.Debug("Endpoints: %v", endPointList)
289 subManEp := getEndpointByName(&endPointList, "SUBMAN")
291 xapp.Logger.Error("Platform component not found: %v", "Subscription Manager")
292 xapp.Logger.Debug("Endpoints: %v", endPointList)
294 e2ManEp := getEndpointByName(&endPointList, "E2MAN")
296 xapp.Logger.Error("Platform component not found: %v", "E2 Manager")
297 xapp.Logger.Debug("Endpoints: %v", endPointList)
299 /*ueManEp := getEndpointByName(&endPointList, "UEMAN")
301 xapp.Logger.Error("Platform component not found: %v", "UE Manger")
302 xapp.Logger.Debug("Endpoints: %v", endPointList)
304 rsmEp := getEndpointByName(&endPointList, "RSM")
306 xapp.Logger.Error("Platform component not found: %v", "Resource Status Manager")
307 xapp.Logger.Debug("Endpoints: %v", endPointList)
309 A1MediatorEp := getEndpointByName(&endPointList, "A1MEDIATOR")
310 if A1MediatorEp == nil {
311 xapp.Logger.Error("Platform component not found: %v", "A1Mediator")
312 xapp.Logger.Debug("Endpoints: %v", endPointList)
315 e2TermListEp := getEndpointListByName(&endPointList, "E2TERMINST")
316 if len(e2TermListEp) == 0 {
317 xapp.Logger.Error("Platform component not found: %v", "E2 Termination List")
318 xapp.Logger.Debug("Endpoints: %v", endPointList)
320 r.generatePlatformRoutes(e2TermListEp, subManEp, e2ManEp, rsmEp, A1MediatorEp, routeTable)
322 for _, endPoint := range endPointList {
323 xapp.Logger.Debug("Endpoint: %v, xAppType: %v", endPoint.Name, endPoint.XAppType)
324 if endPoint.XAppType != sbi.PlatformType && (len(endPoint.TxMessages) > 0 || len(endPoint.RxMessages) > 0) {
325 r.generateXappRoutes(endPoint, subManEp, routeTable)
326 r.generateSubscriptionRoutes(endPoint, subManEp, routeTable)
327 r.generateXappToXappRoutes(endPoint, endPointList, routeTable)