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.
17 ==================================================================================
21 Abstract: Contains RPE (Route Policy Engine) module definitions and generic RPE components
29 "routing-manager/pkg/rtmgr"
30 "routing-manager/pkg/sbi"
35 SupportedRpes = []*EngineConfig{
40 Instance: NewRmrPush(),
46 func GetRpe(rpeName string) (Engine, error) {
47 for _, rpe := range SupportedRpes {
48 if rpe.Name == rpeName && rpe.IsAvailable {
49 return rpe.Instance, nil
52 return nil, errors.New("SBI:" + rpeName + " is not supported or still not a available")
58 func getEndpointByName(eps *rtmgr.Endpoints, name string) *rtmgr.Endpoint {
59 for _, ep := range *eps {
61 rtmgr.Logger.Debug("name: %s", ep.Name)
62 rtmgr.Logger.Debug("ep: %v", ep)
69 func getEndpointByUuid(uuid string) *rtmgr.Endpoint {
70 endPoints := rtmgr.Eps
71 for _, ep := range endPoints {
73 rtmgr.Logger.Debug("name: %s", ep.Uuid)
74 rtmgr.Logger.Debug("ep: %v", ep)
81 func (r *Rpe) addRoute(messageType string, tx *rtmgr.Endpoint, rx *rtmgr.Endpoint, routeTable *rtmgr.RouteTable, subId int32) {
82 txList := rtmgr.EndpointList{*tx}
83 rxList := []rtmgr.EndpointList{[]rtmgr.Endpoint{*rx}}
84 messageId := rtmgr.MessageTypes[messageType]
85 route := rtmgr.RouteTableEntry{
86 MessageType: messageId,
90 *routeTable = append(*routeTable, route)
91 rtmgr.Logger.Debug("Route added: MessageTyp: %v, Tx: %v, Rx: %v, SubId: %v", messageId, tx.Uuid, rx.Uuid, subId)
92 rtmgr.Logger.Trace("Route added: MessageTyp: %v, Tx: %v, Rx: %v, SubId: %v", messageId, tx, rx, subId)
95 func (r *Rpe) generateXappRoutes(xAppEp *rtmgr.Endpoint, e2TermEp *rtmgr.Endpoint, subManEp *rtmgr.Endpoint, routeTable *rtmgr.RouteTable) {
96 rtmgr.Logger.Debug("rpe.generateXappRoutes invoked")
97 rtmgr.Logger.Debug("Endpoint: %v, xAppType: %v", xAppEp.Name, xAppEp.XAppType)
98 if xAppEp.XAppType != sbi.PlatformType && len(xAppEp.TxMessages) > 0 && len(xAppEp.RxMessages) > 0 {
99 //xApp -> Subscription Manager
100 r.addRoute("RIC_SUB_REQ", xAppEp, subManEp, routeTable, -1)
101 r.addRoute("RIC_SUB_DEL_REQ", xAppEp, subManEp, routeTable, -1)
102 //xApp -> E2 Termination
103 r.addRoute("RIC_CONTROL_REQ", xAppEp, e2TermEp, routeTable, -1)
107 func (r *Rpe) generateSubscriptionRoutes(e2TermEp *rtmgr.Endpoint, subManEp *rtmgr.Endpoint, routeTable *rtmgr.RouteTable) {
108 rtmgr.Logger.Debug("rpe.addSubscriptionRoutes invoked")
109 subscriptionList := &rtmgr.Subs
110 for _, subscription := range *subscriptionList {
111 rtmgr.Logger.Debug("Subscription: %v", subscription)
112 xAppUuid := subscription.Fqdn + ":" + strconv.Itoa(int(subscription.Port))
113 rtmgr.Logger.Debug("xApp UUID: %v", xAppUuid)
114 xAppEp := getEndpointByUuid(xAppUuid)
115 //Subscription Manager -> xApp
116 r.addRoute("RIC_SUB_RESP", subManEp, xAppEp, routeTable, subscription.SubID)
117 r.addRoute("RIC_SUB_FAILURE", subManEp, xAppEp, routeTable, subscription.SubID)
118 r.addRoute("RIC_SUB_DEL_RESP", subManEp, xAppEp, routeTable, subscription.SubID)
119 r.addRoute("RIC_SUB_DEL_FAILURE", subManEp, xAppEp, routeTable, subscription.SubID)
120 //E2 Termination -> xApp
121 r.addRoute("RIC_INDICATION", e2TermEp, xAppEp, routeTable, subscription.SubID)
122 r.addRoute("RIC_CONTROL_ACK", e2TermEp, xAppEp, routeTable, subscription.SubID)
123 r.addRoute("RIC_CONTROL_FAILURE", e2TermEp, xAppEp, routeTable, subscription.SubID)
127 func (r *Rpe) generatePlatformRoutes(e2TermEp *rtmgr.Endpoint, subManEp *rtmgr.Endpoint, e2ManEp *rtmgr.Endpoint, ueManEp *rtmgr.Endpoint, routeTable *rtmgr.RouteTable) {
128 rtmgr.Logger.Debug("rpe.generatePlatformRoutes invoked")
129 //Platform Routes --- Subscription Routes
130 //Subscription Manager -> E2 Termination
131 r.addRoute("RIC_SUB_REQ", subManEp, e2TermEp, routeTable, -1)
132 r.addRoute("RIC_SUB_DEL_REQ", subManEp, e2TermEp, routeTable, -1)
133 //E2 Termination -> Subscription Manager
134 r.addRoute("RIC_SUB_RESP", e2TermEp, subManEp, routeTable, -1)
135 r.addRoute("RIC_SUB_DEL_RESP", e2TermEp, subManEp, routeTable, -1)
136 r.addRoute("RIC_SUB_FAILURE", e2TermEp, subManEp, routeTable, -1)
137 r.addRoute("RIC_SUB_DEL_FAILURE", e2TermEp, subManEp, routeTable, -1)
138 //TODO: UE Man Routes removed (since it is not existing)
139 //UE Manager -> Subscription Manager
140 //r.addRoute("RIC_SUB_REQ", ueManEp, subManEp, routeTable)
141 //r.addRoute("RIC_SUB_DEL_REQ", ueManEp, subManEp, routeTable)
142 ////UE Manager -> E2 Termination
143 //r.addRoute("RIC_CONTROL_REQ", ueManEp, e2TermEp, routeTable)
145 //Platform Routes --- X2 Routes
146 //E2 Manager -> E2 Termination
147 r.addRoute("RIC_X2_SETUP_REQ", e2ManEp, e2TermEp, routeTable, -1)
148 r.addRoute("RIC_X2_SETUP_RESP", e2ManEp, e2TermEp, routeTable, -1)
149 r.addRoute("RIC_X2_SETUP_FAILURE", e2ManEp, e2TermEp, routeTable, -1)
150 r.addRoute("RIC_X2_RESET_RESP", e2ManEp, e2TermEp, routeTable, -1)
151 r.addRoute("RIC_ENDC_X2_SETUP_REQ", e2ManEp, e2TermEp, routeTable, -1)
152 r.addRoute("RIC_ENDC_X2_SETUP_RESP", e2ManEp, e2TermEp, routeTable, -1)
153 r.addRoute("RIC_ENDC_X2_SETUP_FAILURE", e2ManEp, e2TermEp, routeTable, -1)
154 //E2 Termination -> E2 Manager
155 r.addRoute("RIC_X2_SETUP_REQ", e2TermEp, e2ManEp, routeTable, -1)
156 r.addRoute("RIC_X2_SETUP_RESP", e2TermEp, e2ManEp, routeTable, -1)
157 r.addRoute("RIC_X2_RESET", e2TermEp, e2ManEp, routeTable, -1)
158 r.addRoute("RIC_X2_RESOURCE_STATUS_RESPONSE", e2TermEp, e2ManEp, routeTable, -1)
159 r.addRoute("RIC_X2_RESET_RESP", e2TermEp, e2ManEp, routeTable, -1)
160 r.addRoute("RIC_ENDC_X2_SETUP_REQ", e2ManEp, e2TermEp, routeTable, -1)
161 r.addRoute("RIC_ENDC_X2_SETUP_RESP", e2ManEp, e2TermEp, routeTable, -1)
162 r.addRoute("RIC_ENDC_X2_SETUP_FAILURE", e2ManEp, e2TermEp, routeTable, -1)
165 func (r *Rpe) generateRouteTable(endPointList rtmgr.Endpoints) *rtmgr.RouteTable {
166 rtmgr.Logger.Debug("rpe.generateRouteTable invoked")
167 rtmgr.Logger.Debug("Endpoint List: %v", endPointList)
168 routeTable := &rtmgr.RouteTable{}
169 e2TermEp := getEndpointByName(&endPointList, "E2TERM")
171 rtmgr.Logger.Error("Platform component not found: %v", "E2 Termination")
172 rtmgr.Logger.Debug("Endpoints: %v", endPointList)
174 subManEp := getEndpointByName(&endPointList, "SUBMAN")
176 rtmgr.Logger.Error("Platform component not found: %v", "Subscription Manager")
177 rtmgr.Logger.Debug("Endpoints: %v", endPointList)
179 e2ManEp := getEndpointByName(&endPointList, "E2MAN")
181 rtmgr.Logger.Error("Platform component not found: %v", "E2 Manager")
182 rtmgr.Logger.Debug("Endpoints: %v", endPointList)
184 ueManEp := getEndpointByName(&endPointList, "UEMAN")
186 rtmgr.Logger.Error("Platform component not found: %v", "UE Manger")
187 rtmgr.Logger.Debug("Endpoints: %v", endPointList)
189 r.generatePlatformRoutes(e2TermEp, subManEp, e2ManEp, ueManEp, routeTable)
191 for _, endPoint := range endPointList {
192 rtmgr.Logger.Debug("Endpoint: %v, xAppType: %v", endPoint.Name, endPoint.XAppType)
193 if endPoint.XAppType != sbi.PlatformType && len(endPoint.TxMessages) > 0 && len(endPoint.RxMessages) > 0 {
194 r.generateXappRoutes(endPoint, e2TermEp, subManEp, routeTable)
195 r.generateSubscriptionRoutes(e2TermEp, subManEp, routeTable)