E2Manager/rNibWriter/rNibWriter.go

   1 //
   2 // Copyright 2019 AT&T Intellectual Property
   3 // Copyright 2019 Nokia
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the "License");
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //      http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 package rNibWriter
  19
  20 import (
  21         "errors"
  22         "fmt"
  23         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  24         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  25         "gerrit.o-ran-sc.org/r/ric-plt/sdlgo"
  26         "github.com/golang/protobuf/proto"
  27 )
  28
  29 var writerPool *common.Pool
  30
  31 type rNibWriterInstance struct {
  32         sdl       *common.ISdlInstance
  33         namespace string
  34 }
  35
  36 /*
  37 RNibWriter interface allows saving data to the redis DB
  38 */
  39 type RNibWriter interface {
  40         SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) common.IRNibError
  41         UpdateNodebInfo(nodebInfo *entities.NodebInfo) common.IRNibError
  42         SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) common.IRNibError
  43 }
  44
  45 /*
  46 Init initializes the infrastructure required for the RNibWriter instance
  47 */
  48 func Init(namespace string, poolSize int) {
  49         initPool(poolSize,
  50                 func() interface{} {
  51                         var sdlI common.ISdlInstance = sdlgo.NewSdlInstance(namespace, sdlgo.NewDatabase())
  52                         return &rNibWriterInstance{sdl: &sdlI, namespace: namespace}
  53                 },
  54                 func(obj interface{}) {
  55                         (*obj.(*rNibWriterInstance).sdl).Close()
  56                 })
  57 }
  58
  59 /*
  60 InitPool initializes the writer's instances pool
  61 */
  62 func initPool(poolSize int, newObj func() interface{}, destroyObj func(interface{})) {
  63         writerPool = common.NewPool(poolSize, newObj, destroyObj)
  64 }
  65
  66 /*
  67 GetRNibWriter returns RNibWriter instance from the pool
  68 */
  69 func GetRNibWriter() RNibWriter {
  70         return writerPool.Get().(RNibWriter)
  71 }
  72
  73 /*
  74 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
  75 */
  76 func (w *rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *entities.NodebInfo) common.IRNibError {
  77
  78         isNotEmptyIdentity := isNotEmpty(nbIdentity)
  79
  80         if isNotEmptyIdentity && entity.GetNodeType() == entities.Node_UNKNOWN {
  81                 return common.NewValidationError(errors.New(fmt.Sprintf("#rNibWriter.saveNodeB - Unknown responding node type, entity: %v", entity)))
  82         }
  83         defer writerPool.Put(w)
  84         data, err := proto.Marshal(entity)
  85         if err != nil {
  86                 return common.NewInternalError(err)
  87         }
  88         var pairs []interface{}
  89         key, rNibErr := common.ValidateAndBuildNodeBNameKey(nbIdentity.InventoryName)
  90         if rNibErr != nil {
  91                 return rNibErr
  92         }
  93         pairs = append(pairs, key, data)
  94
  95         if isNotEmptyIdentity {
  96                 key, rNibErr = common.ValidateAndBuildNodeBIdKey(entity.GetNodeType().String(), nbIdentity.GlobalNbId.GetPlmnId(), nbIdentity.GlobalNbId.GetNbId())
  97                 if rNibErr != nil {
  98                         return rNibErr
  99                 }
 100                 pairs = append(pairs, key, data)
 101         }
 102
 103         if entity.GetEnb() != nil {
 104                 pairs, rNibErr = appendEnbCells(nbIdentity, entity.GetEnb().GetServedCells(), pairs)
 105                 if rNibErr != nil {
 106                         return rNibErr
 107                 }
 108         }
 109         if entity.GetGnb() != nil {
 110                 pairs, rNibErr = appendGnbCells(nbIdentity, entity.GetGnb().GetServedNrCells(), pairs)
 111                 if rNibErr != nil {
 112                         return rNibErr
 113                 }
 114         }
 115         err = (*w.sdl).Set(pairs)
 116         if err != nil {
 117                 return common.NewInternalError(err)
 118         }
 119
 120         ranNameIdentity := &entities.NbIdentity{InventoryName: nbIdentity.InventoryName}
 121
 122         if isNotEmptyIdentity {
 123                 nbIdData, err := proto.Marshal(ranNameIdentity)
 124                 if err != nil {
 125                         return common.NewInternalError(err)
 126                 }
 127                 err = (*w.sdl).RemoveMember(entities.Node_UNKNOWN.String(), nbIdData)
 128                 if err != nil {
 129                         return common.NewInternalError(err)
 130                 }
 131         } else {
 132                 nbIdentity = ranNameIdentity
 133         }
 134
 135         nbIdData, err := proto.Marshal(nbIdentity)
 136         if err != nil {
 137                 return common.NewInternalError(err)
 138         }
 139         err = (*w.sdl).AddMember(entity.GetNodeType().String(), nbIdData)
 140         if err != nil {
 141                 return common.NewInternalError(err)
 142         }
 143         return nil
 144 }
 145
 146 /*
 147 UpdateNodebInfo...
 148 */
 149 func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) common.IRNibError {
 150
 151         defer writerPool.Put(w)
 152
 153         nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
 154
 155         if rNibErr != nil {
 156                 return rNibErr
 157         }
 158
 159         nodebIdKey, rNibErr := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
 160
 161         if rNibErr != nil {
 162                 return rNibErr
 163         }
 164
 165         data, err := proto.Marshal(nodebInfo)
 166
 167         if err != nil {
 168                 return common.NewInternalError(err)
 169         }
 170
 171         var pairs []interface{}
 172         pairs = append(pairs, nodebNameKey, data, nodebIdKey, data)
 173         err = (*w.sdl).Set(pairs)
 174
 175         if err != nil {
 176                 return common.NewInternalError(err)
 177         }
 178
 179         return nil
 180 }
 181
 182 /*
 183 SaveRanLoadInformation stores ran load information for the provided ran
 184 */
 185 func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) common.IRNibError {
 186
 187         defer writerPool.Put(w)
 188
 189         key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
 190
 191         if rnibErr != nil {
 192                 return rnibErr
 193         }
 194
 195         data, err := proto.Marshal(ranLoadInformation)
 196
 197         if err != nil {
 198                 return common.NewInternalError(err)
 199         }
 200
 201         var pairs []interface{}
 202         pairs = append(pairs, key, data)
 203
 204         err = (*w.sdl).Set(pairs)
 205
 206         if err != nil {
 207                 return common.NewInternalError(err)
 208         }
 209
 210         return nil
 211 }
 212
 213 /*
 214 Close closes writer's pool
 215 */
 216 func Close() {
 217         writerPool.Close()
 218 }
 219
 220 func appendEnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, common.IRNibError) {
 221         for _, cell := range cells {
 222                 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
 223                 cellData, err := proto.Marshal(&cellEntity)
 224                 if err != nil {
 225                         return pairs, common.NewInternalError(err)
 226                 }
 227                 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
 228                 if rNibErr != nil {
 229                         return pairs, rNibErr
 230                 }
 231                 pairs = append(pairs, key, cellData)
 232                 key, rNibErr = common.ValidateAndBuildCellNamePciKey(nbIdentity.InventoryName, cell.GetPci())
 233                 if rNibErr != nil {
 234                         return pairs, rNibErr
 235                 }
 236                 pairs = append(pairs, key, cellData)
 237         }
 238         return pairs, nil
 239 }
 240
 241 func appendGnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, common.IRNibError) {
 242         for _, cell := range cells {
 243                 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
 244                 cellData, err := proto.Marshal(&cellEntity)
 245                 if err != nil {
 246                         return pairs, common.NewInternalError(err)
 247                 }
 248                 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
 249                 if rNibErr != nil {
 250                         return pairs, rNibErr
 251                 }
 252                 pairs = append(pairs, key, cellData)
 253                 key, rNibErr = common.ValidateAndBuildCellNamePciKey(nbIdentity.InventoryName, cell.GetServedNrCellInformation().GetNrPci())
 254                 if rNibErr != nil {
 255                         return pairs, rNibErr
 256                 }
 257                 pairs = append(pairs, key, cellData)
 258         }
 259         return pairs, nil
 260 }
 261
 262 func isNotEmpty(nbIdentity *entities.NbIdentity) bool {
 263         return nbIdentity.GlobalNbId != nil && nbIdentity.GlobalNbId.PlmnId != "" && nbIdentity.GlobalNbId.NbId != ""
 264 }