pkg/rtmgr/rtmgr.go

   1 /*
   2 ==================================================================================
   3   Copyright (c) 2019 AT&T Intellectual Property.
   4   Copyright (c) 2019 Nokia
   5
   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
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  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 ==================================================================================
  18 */
  19 /*
  20   Mnemonic:     rtmgr/rtmgr.go
  21   Abstract:     Contains RTMGR (Routing Manager) module's generic variables and functions
  22   Date:         26 March 2019
  23 */
  24
  25 package rtmgr
  26
  27 import (
  28         "encoding/json"
  29         "errors"
  30         "github.com/jcelliott/lumber"
  31         "io/ioutil"
  32         "os"
  33         "strings"
  34 )
  35
  36 var (
  37         //TODO: temporary solution
  38         // CamelCase Message Types are for being able to test with old fashioned admin control xApps
  39         // TODO: Add a separate message definition file (Not using the one from RMR to not create dependency on that library).
  40         MessageTypes = map[string]string{
  41                 "HandoverPreparation":              "0",
  42                 "HandoverCancel":                   "1",
  43                 "LoadIndication":                   "2",
  44                 "ErrorIndication":                  "3",
  45                 "SNStatusTransfer":                 "4",
  46                 "UEContextRelease":                 "5",
  47                 "X2Setup":                          "6",
  48                 "Reset":                            "7",
  49                 "E2_TERM_INIT":                     "1100",
  50                 "RIC_SCTP_CLEAR_ALL":               "1090",
  51                 "RIC_SCTP_CONNECTION_FAILURE":      "1080",
  52                 "RIC_X2_SETUP":                     "10000",
  53                 "RIC_X2_RESPONSE":                  "10001",
  54                 "RIC_X2_RESOURCE_STATUS_REQUEST":   "10002",
  55                 "RIC_X2_RESOURCE_STATUS_RESPONSE":  "10003",
  56                 "RIC_X2_LOAD_INFORMATION":          "10004",
  57                 "RIC_E2_TERMINATION_HC_REQUEST":    "10005",
  58                 "RIC_E2_TERMINATION_HC_RESPONSE":   "10006",
  59                 "RIC_E2_MANAGER_HC_REQUEST":        "10007",
  60                 "RIC_E2_MANAGER_HC_RESPONSE":       "10008",
  61                 "RIC_CONTROL_XAPP_CONFIG_REQUEST":  "100000",
  62                 "RIC_CONTROL_XAPP_CONFIG_RESPONSE": "100001",
  63
  64                 "RIC_X2_SETUP_REQ":     "10060",
  65                 "RIC_X2_SETUP_RESP":    "10061",
  66                 "RIC_X2_SETUP_FAILURE": "10062",
  67                 "RIC_X2_RESET":         "10070",
  68                 "RIC_X2_RESET_RESP":    "10071",
  69
  70                 "RIC_SUB_REQ":         "12010",
  71                 "RIC_SUB_RESP":        "12011",
  72                 "RIC_SUB_FAILURE":     "12012",
  73                 "RIC_SUB_DEL_REQ":     "12020",
  74                 "RIC_SUB_DEL_RESP":    "12021",
  75                 "RIC_SUB_DEL_FAILURE": "12022",
  76
  77                 "RIC_CONTROL_REQ":              "12040",
  78                 "RIC_CONTROL_ACK":              "12041",
  79                 "RIC_CONTROL_FAILURE":          "12042",
  80                 "RIC_INDICATION":               "12050",
  81                 "RIC_ENDC_X2_SETUP_REQ":        "10360",
  82                 "RIC_ENDC_X2_SETUP_RESP":       "10361",
  83                 "RIC_ENDC_X2_SETUP_FAILURE":    "10362",
  84                 "RIC_ENDC_CONF_UPDATE":         "10370",
  85                 "RIC_ENDC_CONF_UPDATE_ACK":     "10371",
  86                 "RIC_ENDC_CONF_UPDATE_FAILURE": "10372",
  87                 "RIC_RES_STATUS_REQ":           "10090",
  88                 "RIC_RES_STATUS_RESP":          "10091",
  89                 "RIC_RES_STATUS_FAILURE":       "10092",
  90                 "RIC_ENB_CONF_UPDATE":          "10080",
  91                 "RIC_ENB_CONF_UPDATE_ACK":      "10081",
  92                 "RIC_ENB_CONF_UPDATE_FAILURE":  "10082",
  93                 "RIC_ENB_LOAD_INFORMATION":     "10020",
  94                 "RIC_GNB_STATUS_INDICATION":    "10450",
  95                 "RIC_RESOURCE_STATUS_UPDATE":   "10100",
  96                 "RIC_ERROR_INDICATION":         "10030",
  97                 "DC_ADM_INT_CONTROL":           "20000",
  98                 "DC_ADM_INT_CONTROL_ACK":       "20001",
  99         }
 100
 101         // Messagetype mappings for the platform components.
 102         // This implements static default routes needed by the RIC. Needs to be changed in case new components/message types needes to be added/updated.
 103         // Representation : {"componentName1": {"tx": <tx message type list>, "rx": <rx message type list>}}
 104         PLATFORMMESSAGETYPES = map[string]map[string][]string{
 105                 "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"}},
 106                 "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"}},
 107                 "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"}},
 108                 "UEMAN":  {"tx": []string{"RIC_CONTROL_REQ"}, "rx": []string{}},
 109         }
 110
 111         Logger = lumber.NewConsoleLogger(lumber.INFO)
 112         Eps    Endpoints
 113         Subs   SubscriptionList
 114 )
 115
 116 func SetLogLevel(loglevel string) error {
 117         switch strings.ToUpper(loglevel) {
 118         case "INFO":
 119                 Logger.Level(lumber.INFO)
 120                 return nil
 121         case "WARN":
 122                 Logger.Level(lumber.WARN)
 123                 return nil
 124         case "ERROR":
 125                 Logger.Level(lumber.ERROR)
 126                 return nil
 127         case "DEBUG":
 128                 Logger.Info("Debug mode")
 129                 Logger.Level(lumber.DEBUG)
 130                 return nil
 131         case "TRACE":
 132                 Logger.Info("Trace mode")
 133                 Logger.Level(lumber.TRACE)
 134                 return nil
 135         default:
 136                 Logger.Error("invalid log mode, setting info")
 137                 Logger.Level(lumber.INFO)
 138                 return errors.New("invalid log level, setting info")
 139         }
 140 }
 141
 142 func GetPlatformComponents(configfile string) (*PlatformComponents, error) {
 143         Logger.Debug("Invoked rtmgr.GetPlatformComponents(" + configfile + ")")
 144         var rcfg ConfigRtmgr
 145         jsonFile, err := os.Open(configfile)
 146         if err != nil {
 147                 return nil, errors.New("cannot open the file due to: " + err.Error())
 148         }
 149         defer jsonFile.Close()
 150         byteValue, err := ioutil.ReadAll(jsonFile)
 151         if err != nil {
 152                 return nil, errors.New("cannot read the file due to: " + err.Error())
 153         }
 154         err = json.Unmarshal(byteValue, &rcfg)
 155         if err != nil {
 156                 return nil, errors.New("cannot parse data due to: " + err.Error())
 157         }
 158         Logger.Debug("Platform components read from the configfile:  %v", rcfg.Pcs)
 159         return &(rcfg.Pcs), nil
 160 }