Merge "Adding scope of RICPlatform that are under Apache License"

[ric-plt/rtmgr.git] / pkg / rtmgr / rtmgr.go

diff --git a/pkg/rtmgr/rtmgr.go b/pkg/rtmgr/rtmgr.go
index d5d3fc5..83af71a 100644 (file)
--- a/pkg/rtmgr/rtmgr.go
+++ b/pkg/rtmgr/rtmgr.go
@@ -14,24 +14,35 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

+
+   This source code is part of the near-RT RIC (RAN Intelligent Controller)
+   platform project (RICP).
+

 ==================================================================================
 */
 /*
   Mnemonic:    rtmgr/rtmgr.go
 ==================================================================================
 */
 /*
   Mnemonic:    rtmgr/rtmgr.go

-  Abstract:    Containes RTMGR (Routing Manager) module's generic variables and functions
+  Abstract:    Contains RTMGR (Routing Manager) module's generic variables and functions

   Date:                26 March 2019
 */
 
 package rtmgr
 
 import (
   Date:                26 March 2019
 */
 
 package rtmgr
 
 import (

+       "encoding/json"
+       "errors"
+       "io/ioutil"
+       "os"
+       "strings"
+

        "github.com/jcelliott/lumber"
 )
 
 var (
        //TODO: temporary solution
        "github.com/jcelliott/lumber"
 )
 
 var (
        //TODO: temporary solution

-       // CamelCase Message Types are for being able to test with old fashioned admin controll xApps
-       MESSAGETYPES = map[string]string{
+       // CamelCase Message Types are for being able to test with old fashioned admin control xApps
+       // TODO: Add a separate message definition file (Not using the one from RMR to not create dependency on that library).
+       MessageTypes = map[string]string{

                "HandoverPreparation":              "0",
                "HandoverCancel":                   "1",
                "LoadIndication":                   "2",
                "HandoverPreparation":              "0",
                "HandoverCancel":                   "1",
                "LoadIndication":                   "2",


@@ -40,6 +51,12 @@ var (
                "UEContextRelease":                 "5",
                "X2Setup":                          "6",
                "Reset":                            "7",
                "UEContextRelease":                 "5",
                "X2Setup":                          "6",
                "Reset":                            "7",

+               "E2_TERM_INIT":                     "1100",
+               "RAN_CONNECTED":                    "1200",
+               "RAN_RESTARTED":                    "1210",
+               "RAN_RECONFIGURED":                 "1220",
+               "RIC_SCTP_CLEAR_ALL":               "1090",
+               "RIC_SCTP_CONNECTION_FAILURE":      "1080",

                "RIC_X2_SETUP":                     "10000",
                "RIC_X2_RESPONSE":                  "10001",
                "RIC_X2_RESOURCE_STATUS_REQUEST":   "10002",
                "RIC_X2_SETUP":                     "10000",
                "RIC_X2_RESPONSE":                  "10001",
                "RIC_X2_RESOURCE_STATUS_REQUEST":   "10002",


@@ -49,22 +66,101 @@ var (
                "RIC_E2_TERMINATION_HC_RESPONSE":   "10006",
                "RIC_E2_MANAGER_HC_REQUEST":        "10007",
                "RIC_E2_MANAGER_HC_RESPONSE":       "10008",
                "RIC_E2_TERMINATION_HC_RESPONSE":   "10006",
                "RIC_E2_MANAGER_HC_REQUEST":        "10007",
                "RIC_E2_MANAGER_HC_RESPONSE":       "10008",

+               "RIC_ENB_LOAD_INFORMATION":         "10020",
+               "RIC_ERROR_INDICATION":             "10030",
+               "RIC_X2_SETUP_REQ":                 "10060",
+               "RIC_X2_SETUP_RESP":                "10061",
+               "RIC_X2_SETUP_FAILURE":             "10062",
+               "RIC_X2_RESET_REQ":                 "10070",
+               "RIC_X2_RESET_RESP":                "10071",
+               "RIC_ENB_CONF_UPDATE":              "10080",
+               "RIC_ENB_CONF_UPDATE_ACK":          "10081",
+               "RIC_ENB_CONF_UPDATE_FAILURE":      "10082",
+               "RIC_RES_STATUS_REQ":               "10090",
+               "RIC_RES_STATUS_RESP":              "10091",
+               "RIC_RES_STATUS_FAILURE":           "10092",
+               "RIC_RESOURCE_STATUS_UPDATE":       "10100",
+               "RIC_ENDC_X2_SETUP_REQ":            "10360",
+               "RIC_ENDC_X2_SETUP_RESP":           "10361",
+               "RIC_ENDC_X2_SETUP_FAILURE":        "10362",
+               "RIC_ENDC_CONF_UPDATE":             "10370",
+               "RIC_ENDC_CONF_UPDATE_ACK":         "10371",
+               "RIC_ENDC_CONF_UPDATE_FAILURE":     "10372",
+               "RIC_GNB_STATUS_INDICATION":        "10450",
+               "RIC_SUB_REQ":                      "12010",
+               "RIC_SUB_RESP":                     "12011",
+               "RIC_SUB_FAILURE":                  "12012",
+               "RIC_SUB_DEL_REQ":                  "12020",
+               "RIC_SUB_DEL_RESP":                 "12021",
+               "RIC_SUB_DEL_FAILURE":              "12022",
+               "RIC_CONTROL_REQ":                  "12040",
+               "RIC_CONTROL_ACK":                  "12041",
+               "RIC_CONTROL_FAILURE":              "12042",
+               "RIC_INDICATION":                   "12050",
+               "DC_ADM_INT_CONTROL":               "20000",
+               "DC_ADM_INT_CONTROL_ACK":           "20001",

                "RIC_CONTROL_XAPP_CONFIG_REQUEST":  "100000",
                "RIC_CONTROL_XAPP_CONFIG_RESPONSE": "100001",
        }
                "RIC_CONTROL_XAPP_CONFIG_REQUEST":  "100000",
                "RIC_CONTROL_XAPP_CONFIG_RESPONSE": "100001",
        }

+
+       // Messagetype mappings for the platform components.
+       // This implements static default routes needed by the RIC. Needs to be changed in case new components/message types needes to be added/updated.
+       // Representation : {"componentName1": {"tx": <tx message type list>, "rx": <rx message type list>}}
+       PLATFORMMESSAGETYPES = map[string]map[string][]string{
+               "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"}},
+               "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"}},
+               "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"}},
+               "UEMAN":  {"tx": []string{"RIC_CONTROL_REQ"}, "rx": []string{}},
+               "RSM":    {"tx": []string{"RIC_RES_STATUS_REQ"}, "rx": []string{"RAN_CONNECTED", "RAN_RESTARTED", "RAN_RECONFIGURED"}},
+       }
+

        Logger = lumber.NewConsoleLogger(lumber.INFO)
        Logger = lumber.NewConsoleLogger(lumber.INFO)

+       Eps    Endpoints
+       Subs   SubscriptionList

 )
 
 )
 

-func SetLogLevel(loglevel string) {
-       switch loglevel {
+func SetLogLevel(loglevel string) error {
+       switch strings.ToUpper(loglevel) {

        case "INFO":
                Logger.Level(lumber.INFO)
        case "INFO":
                Logger.Level(lumber.INFO)

+               return nil

        case "WARN":
                Logger.Level(lumber.WARN)
        case "WARN":
                Logger.Level(lumber.WARN)

+               return nil

        case "ERROR":
                Logger.Level(lumber.ERROR)
        case "ERROR":
                Logger.Level(lumber.ERROR)

+               return nil

        case "DEBUG":
        case "DEBUG":

-               Logger.Info("debugmode")
+               Logger.Info("Debug mode")

                Logger.Level(lumber.DEBUG)
                Logger.Level(lumber.DEBUG)

+               return nil
+       case "TRACE":
+               Logger.Info("Trace mode")
+               Logger.Level(lumber.TRACE)
+               return nil
+       default:
+               Logger.Error("invalid log mode, setting info")
+               Logger.Level(lumber.INFO)
+               return errors.New("invalid log level, setting info")
+       }
+}
+
+func GetPlatformComponents(configfile string) (*PlatformComponents, error) {
+       Logger.Debug("Invoked rtmgr.GetPlatformComponents(" + configfile + ")")
+       var rcfg ConfigRtmgr
+       jsonFile, err := os.Open(configfile)
+       if err != nil {
+               return nil, errors.New("cannot open the file due to: " + err.Error())
+       }
+       defer jsonFile.Close()
+       byteValue, err := ioutil.ReadAll(jsonFile)
+       if err != nil {
+               return nil, errors.New("cannot read the file due to: " + err.Error())
+       }
+       err = json.Unmarshal(byteValue, &rcfg)
+       if err != nil {
+               return nil, errors.New("cannot parse data due to: " + err.Error())

        }
        }

+       Logger.Debug("Platform components read from the configfile:  %v", rcfg.Pcs)
+       return &(rcfg.Pcs), nil

 }
 }