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.
18 This source code is part of the near-RT RIC (RAN Intelligent Controller)
19 platform project (RICP).
21 ==================================================================================
24 Mnemonic: rtmgr/rtmgr.go
25 Abstract: Contains RTMGR (Routing Manager) module's generic variables and functions
34 "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
35 "github.com/ghodss/yaml"
41 //TODO: temporary solution
42 // CamelCase Message Types are for being able to test with old fashioned admin control xApps
43 // TODO: Add a separate message definition file (Not using the one from RMR to not create dependency on that library).
44 MessageTypes = map[string]string{
45 "HandoverPreparation": "0",
46 "HandoverCancel": "1",
47 "LoadIndication": "2",
48 "ErrorIndication": "3",
49 "SNStatusTransfer": "4",
50 "UEContextRelease": "5",
53 "E2_TERM_INIT": "1100",
54 "E2_TERM_KEEP_ALIVE_REQ": "1101",
55 "E2_TERM_KEEP_ALIVE_RESP": "1102",
56 "RAN_CONNECTED": "1200",
57 "RAN_RESTARTED": "1210",
58 "RAN_RECONFIGURED": "1220",
59 "RIC_SCTP_CLEAR_ALL": "1090",
60 "RIC_SCTP_CONNECTION_FAILURE": "1080",
61 "RIC_X2_SETUP": "10000",
62 "RIC_X2_RESPONSE": "10001",
63 "RIC_X2_RESOURCE_STATUS_REQUEST": "10002",
64 "RIC_X2_RESOURCE_STATUS_RESPONSE": "10003",
65 "RIC_X2_LOAD_INFORMATION": "10004",
66 "RIC_E2_TERMINATION_HC_REQUEST": "10005",
67 "RIC_E2_TERMINATION_HC_RESPONSE": "10006",
68 "RIC_E2_MANAGER_HC_REQUEST": "10007",
69 "RIC_E2_MANAGER_HC_RESPONSE": "10008",
70 "RIC_ENB_LOAD_INFORMATION": "10020",
71 "RIC_ERROR_INDICATION": "10030",
72 "RIC_X2_SETUP_REQ": "10060",
73 "RIC_X2_SETUP_RESP": "10061",
74 "RIC_X2_SETUP_FAILURE": "10062",
75 "RIC_X2_RESET_REQ": "10070",
76 "RIC_X2_RESET_RESP": "10071",
77 "RIC_ENB_CONF_UPDATE": "10080",
78 "RIC_ENB_CONF_UPDATE_ACK": "10081",
79 "RIC_ENB_CONF_UPDATE_FAILURE": "10082",
80 "RIC_RES_STATUS_REQ": "10090",
81 "RIC_RES_STATUS_RESP": "10091",
82 "RIC_RES_STATUS_FAILURE": "10092",
83 "RIC_RESOURCE_STATUS_UPDATE": "10100",
84 "RIC_ENDC_X2_SETUP_REQ": "10360",
85 "RIC_ENDC_X2_SETUP_RESP": "10361",
86 "RIC_ENDC_X2_SETUP_FAILURE": "10362",
87 "RIC_ENDC_CONF_UPDATE": "10370",
88 "RIC_ENDC_CONF_UPDATE_ACK": "10371",
89 "RIC_ENDC_CONF_UPDATE_FAILURE": "10372",
90 "RIC_GNB_STATUS_INDICATION": "10450",
91 "RIC_SUB_REQ": "12010",
92 "RIC_SUB_RESP": "12011",
93 "RIC_SUB_FAILURE": "12012",
94 "RIC_SUB_DEL_REQ": "12020",
95 "RIC_SUB_DEL_RESP": "12021",
96 "RIC_SUB_DEL_FAILURE": "12022",
97 "RIC_CONTROL_REQ": "12040",
98 "RIC_CONTROL_ACK": "12041",
99 "RIC_CONTROL_FAILURE": "12042",
100 "RIC_INDICATION": "12050",
101 "DC_ADM_INT_CONTROL": "20000",
102 "DC_ADM_INT_CONTROL_ACK": "20001",
103 "A1_POLICY_REQ": "20010",
104 "A1_POLICY_RESPONSE": "20011",
105 "A1_POLICY_QUERY": "20012",
106 "RIC_CONTROL_XAPP_CONFIG_REQUEST": "100000",
107 "RIC_CONTROL_XAPP_CONFIG_RESPONSE": "100001",
110 // Messagetype mappings for the platform components.
111 // This implements static default routes needed by the RIC. Needs to be changed in case new components/message types needes to be added/updated.
112 // Representation : {"componentName1": {"tx": <tx message type list>, "rx": <rx message type list>}}
113 PLATFORMMESSAGETYPES = map[string]map[string][]string{
114 "E2TERM": {"tx": []string{"RIC_X2_SETUP_REQ", "RIC_X2_SETUP_RESP", "RIC_X2_SETUP_FAILURE", "RIC_X2_RESET", "RIC_X2_RESET_RESP", "RIC_ENDC_X2_SETUP_REQ", "RIC_ENDC_X2_SETUP_RESP", "RIC_ENDC_X2_SETUP_FAILURE", "RIC_SUB_RESP", "RIC_SUB_FAILURE", "RIC_SUB_DEL_RESP", "RIC_SUB_DEL_FAILURE"}, "rx": []string{"RIC_X2_SETUP_REQ", "RIC_X2_SETUP_RESP", "RIC_X2_SETUP_FAILURE", "RIC_X2_RESET", "RIC_X2_RESET_RESP", "RIC_ENDC_X2_SETUP_REQ", "RIC_ENDC_X2_SETUP_RESP", "RIC_ENDC_X2_SETUP_FAILURE", "RIC_SUB_REQ", "RIC_SUB_DEL_REQ", "RIC_CONTROL_REQ"}},
115 "E2MAN": {"tx": []string{"RIC_X2_SETUP_REQ", "RIC_X2_SETUP_RESP", "RIC_X2_SETUP_FAILURE", "RIC_X2_RESET", "RIC_X2_RESET_RESP", "RIC_ENDC_X2_SETUP_REQ", "RIC_ENDC_X2_SETUP_RESP", "RIC_ENDC_X2_SETUP_FAILURE"}, "rx": []string{"RIC_X2_SETUP_REQ", "RIC_X2_SETUP_RESP", "RIC_X2_SETUP_FAILURE", "RIC_X2_RESET", "RIC_X2_RESET_RESP", "RIC_ENDC_X2_SETUP_REQ", "RIC_ENDC_X2_SETUP_RESP", "RIC_ENDC_X2_SETUP_FAILURE"}},
116 "SUBMAN": {"tx": []string{"RIC_SUB_REQ", "RIC_SUB_DEL_REQ"}, "rx": []string{"RIC_SUB_RESP", "RIC_SUB_FAILURE", "RIC_SUB_DEL_RESP", "RIC_SUB_DEL_FAILURE"}},
117 "UEMAN": {"tx": []string{"RIC_CONTROL_REQ"}, "rx": []string{}},
118 "RSM": {"tx": []string{"RIC_RES_STATUS_REQ"}, "rx": []string{"RAN_CONNECTED", "RAN_RESTARTED", "RAN_RECONFIGURED"}},
119 "A1MEDIATOR": {"tx": []string{}, "rx": []string{"A1_POLICY_QUERY", "A1_POLICY_RESPONSE"}},
123 Subs SubscriptionList
126 func GetPlatformComponents(configfile string) (*PlatformComponents, error) {
127 xapp.Logger.Debug("Invoked rtmgr.GetPlatformComponents(" + configfile + ")")
129 yamlFile, err := os.Open(configfile)
131 return nil, errors.New("cannot open the file due to: " + err.Error())
133 defer yamlFile.Close()
134 byteValue, err := ioutil.ReadAll(yamlFile)
136 return nil, errors.New("cannot read the file due to: " + err.Error())
138 jsonByteValue, err := yaml.YAMLToJSON(byteValue)
140 return nil, errors.New("cannot read the file due to: " + err.Error())
142 err = json.Unmarshal(jsonByteValue, &rcfg)
144 return nil, errors.New("cannot parse data due to: " + err.Error())
146 xapp.Logger.Debug("Platform components read from the configfile: %v", rcfg.Pcs)
147 return &(rcfg.Pcs), nil