reader/rNibReader.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 package reader
  18
  19 import (
  20         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  21         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  22         "gerrit.o-ran-sc.org/r/ric-plt/sdlgo"
  23         "github.com/golang/protobuf/proto"
  24         "reflect"
  25 )
  26
  27 var readerPool *common.Pool
  28
  29 type rNibReaderInstance struct {
  30         sdl       *common.ISdlInstance
  31         namespace string
  32 }
  33
  34 /*
  35 RNibReader interface allows retrieving data from redis BD by various keys
  36 */
  37 type RNibReader interface {
  38         // GetNodeb retrieves responding nodeb entity from redis DB by nodeb inventory name
  39         GetNodeb(inventoryName string) (*entities.NodebInfo, error)
  40         // GetNodebByGlobalNbId retrieves responding nodeb entity from redis DB by nodeb global Id
  41         GetNodebByGlobalNbId(nodeType entities.Node_Type, globalNbId *entities.GlobalNbId) (*entities.NodebInfo, error)
  42         // GetCellList retrieves the list of cell entities belonging to responding nodeb entity from redis DB by nodeb inventory name
  43         GetCellList(inventoryName string) (*entities.Cells, error)
  44         // GetListGnbIds retrieves the list of gNodeb identity entities
  45         GetListGnbIds() ([]*entities.NbIdentity, error)
  46         // GetListEnbIds retrieves the list of eNodeb identity entities
  47         GetListEnbIds() ([]*entities.NbIdentity, error)
  48         // Close closes reader's pool
  49         GetCountGnbList() (int, error)
  50         // GetCell retrieves the cell entity belonging to responding nodeb from redis DB by nodeb inventory name and cell pci
  51         GetCell(inventoryName string, pci uint32) (*entities.Cell, error)
  52         // GetCellById retrieves the cell entity from redis DB by cell type and cell Id
  53         GetCellById(cellType entities.Cell_Type, cellId string) (*entities.Cell, error)
  54         // GetListNodebIds returns the full list of Nodeb identity entities
  55         GetListNodebIds()([]*entities.NbIdentity, error)
  56         // GetRanLoadInformation retrieves nodeb load information entity from redis DB by nodeb inventory name
  57         GetRanLoadInformation(inventoryName string) (*entities.RanLoadInformation, error)
  58 }
  59
  60 /*
  61  Init initializes the infrastructure required for the RNibReader instance
  62 */
  63 func Init(namespace string, poolSize int) {
  64         initPool(poolSize,
  65                 func() interface{} {
  66                         var sdlI common.ISdlInstance = sdlgo.NewSdlInstance(namespace, sdlgo.NewDatabase())
  67                         return &rNibReaderInstance{sdl: &sdlI, namespace: namespace}
  68                 },
  69                 func(obj interface{}) {
  70                         i, ok := obj.(*rNibReaderInstance)
  71                         if ok{
  72                                 (*i.sdl).Close()
  73                         }
  74                 })
  75 }
  76
  77 func initPool(poolSize int, newObj func() interface{}, destroyObj func(interface{})) {
  78         readerPool = common.NewPool(poolSize, newObj, destroyObj)
  79 }
  80
  81 func (*rNibReaderInstance) GetNodeb(inventoryName string) (*entities.NodebInfo, error) {
  82         w := readerPool.Get().(*rNibReaderInstance)
  83         defer readerPool.Put(w)
  84         key, rNibErr := common.ValidateAndBuildNodeBNameKey(inventoryName)
  85         if rNibErr != nil {
  86                 return nil, rNibErr
  87         }
  88         nbInfo := &entities.NodebInfo{}
  89         err := w.getByKeyAndUnmarshal(key, nbInfo)
  90         if err!= nil{
  91                 return nil, err
  92         }
  93         return nbInfo, nil
  94 }
  95
  96 func (*rNibReaderInstance) GetNodebByGlobalNbId(nodeType entities.Node_Type, globalNbId *entities.GlobalNbId) (*entities.NodebInfo, error) {
  97         w := readerPool.Get().(*rNibReaderInstance)
  98         defer readerPool.Put(w)
  99         key, rNibErr := common.ValidateAndBuildNodeBIdKey(nodeType.String(), globalNbId.GetPlmnId(), globalNbId.GetNbId())
 100         if rNibErr != nil {
 101                 return nil, rNibErr
 102         }
 103         nbInfo := &entities.NodebInfo{}
 104         err := w.getByKeyAndUnmarshal(key, nbInfo)
 105         if err!= nil{
 106                 return nil, err
 107         }
 108         return nbInfo, nil
 109 }
 110
 111 func (w *rNibReaderInstance) GetCellList(inventoryName string) (*entities.Cells, error) {
 112         cells := &entities.Cells{}
 113         nb, err := w.GetNodeb(inventoryName)
 114         if err != nil {
 115                 return nil, err
 116         }
 117         if nb.GetEnb() != nil && len(nb.GetEnb().GetServedCells()) > 0 {
 118                 cells.Type = entities.Cell_LTE_CELL
 119                 cells.List = &entities.Cells_ServedCellInfos{ServedCellInfos: &entities.ServedCellInfoList{ServedCells: nb.GetEnb().GetServedCells()}}
 120                 return cells, nil
 121         }
 122         if nb.GetGnb() != nil && len(nb.GetGnb().GetServedNrCells()) > 0 {
 123                 cells.Type = entities.Cell_NR_CELL
 124                 cells.List = &entities.Cells_ServedNrCells{ServedNrCells: &entities.ServedNRCellList{ServedCells: nb.GetGnb().GetServedNrCells()}}
 125                 return cells, nil
 126         }
 127         return nil, common.NewResourceNotFoundErrorf("#rNibReader.GetCellList - served cells not found. Responding node RAN name: %s.", inventoryName)
 128 }
 129
 130 func (*rNibReaderInstance) GetListGnbIds() ([]*entities.NbIdentity, error) {
 131         w := readerPool.Get().(*rNibReaderInstance)
 132         defer readerPool.Put(w)
 133         return w.getListNodebIdsByType(entities.Node_GNB.String())
 134 }
 135
 136 func (*rNibReaderInstance) GetListEnbIds() ([]*entities.NbIdentity, error) {
 137         w := readerPool.Get().(*rNibReaderInstance)
 138         defer readerPool.Put(w)
 139         return w.getListNodebIdsByType(entities.Node_ENB.String())
 140 }
 141
 142 func (*rNibReaderInstance) GetCountGnbList() (int, error) {
 143         w := readerPool.Get().(*rNibReaderInstance)
 144         defer readerPool.Put(w)
 145         size, err := (*w.sdl).GroupSize(entities.Node_GNB.String())
 146         if err != nil {
 147                 return 0, common.NewInternalError(err)
 148         }
 149         return int(size), nil
 150 }
 151
 152 func (*rNibReaderInstance) GetCell(inventoryName string, pci uint32) (*entities.Cell, error) {
 153         w := readerPool.Get().(*rNibReaderInstance)
 154         defer readerPool.Put(w)
 155         key, rNibErr := common.ValidateAndBuildCellNamePciKey(inventoryName, pci)
 156         if rNibErr != nil {
 157                 return nil, rNibErr
 158         }
 159         cell := &entities.Cell{}
 160         err := w.getByKeyAndUnmarshal(key, cell)
 161         if err!= nil{
 162                 return nil, err
 163         }
 164         return cell, err
 165 }
 166
 167 func (*rNibReaderInstance) GetCellById(cellType entities.Cell_Type, cellId string) (*entities.Cell, error) {
 168         w := readerPool.Get().(*rNibReaderInstance)
 169         defer readerPool.Put(w)
 170         var key string
 171         var rNibErr error
 172         if cellType == entities.Cell_LTE_CELL {
 173                 key, rNibErr = common.ValidateAndBuildCellIdKey(cellId)
 174         } else if cellType == entities.Cell_NR_CELL {
 175                 key, rNibErr = common.ValidateAndBuildNrCellIdKey(cellId)
 176         } else {
 177                 return nil, common.NewValidationErrorf("#rNibReader.GetCellById - invalid cell type: %v", cellType)
 178         }
 179         if rNibErr != nil {
 180                 return nil, rNibErr
 181         }
 182         cell := &entities.Cell{}
 183         err := w.getByKeyAndUnmarshal(key, cell)
 184         if err!= nil{
 185                 return nil, err
 186         }
 187         return cell, err
 188 }
 189
 190 func (*rNibReaderInstance) GetListNodebIds()([]*entities.NbIdentity, error){
 191         w := readerPool.Get().(*rNibReaderInstance)
 192         defer readerPool.Put(w)
 193         dataEnb, err := (*w.sdl).GetMembers(entities.Node_ENB.String())
 194         if err != nil{
 195                 return nil, common.NewInternalError(err)
 196         }
 197         dataGnb, err := (*w.sdl).GetMembers(entities.Node_GNB.String())
 198         if err != nil{
 199                 return nil, common.NewInternalError(err)
 200         }
 201         dataUnknown, err := (*w.sdl).GetMembers(entities.Node_UNKNOWN.String())
 202         if err != nil{
 203                 return nil, common.NewInternalError(err)
 204         }
 205         allIds := append(dataEnb, dataGnb...)
 206         allIds = append(allIds, dataUnknown...)
 207         data, rnibErr := w.unmarshalIdentityList(allIds)
 208         return data, rnibErr
 209 }
 210
 211 func (*rNibReaderInstance) GetRanLoadInformation(inventoryName string) (*entities.RanLoadInformation, error){
 212         w := readerPool.Get().(*rNibReaderInstance)
 213         key, rNibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
 214         if rNibErr != nil {
 215                 return nil, rNibErr
 216         }
 217         loadInfo := &entities.RanLoadInformation{}
 218         err := w.getByKeyAndUnmarshal(key, loadInfo)
 219         if err!= nil{
 220                 return nil, err
 221         }
 222         return loadInfo, err
 223 }
 224
 225 func (w *rNibReaderInstance) getByKeyAndUnmarshal(key string, entity proto.Message)error{
 226         data, err := (*w.sdl).Get([]string{key})
 227         if err != nil {
 228                 return common.NewInternalError(err)
 229         }
 230         if data != nil && data[key] != nil {
 231                 err = proto.Unmarshal([]byte(data[key].(string)), entity)
 232                 if err != nil {
 233                         return common.NewInternalError(err)
 234                 }
 235                 return nil
 236         }
 237         return common.NewResourceNotFoundErrorf("#rNibReader.getByKeyAndUnmarshal - entity of type %s not found. Key: %s", reflect.TypeOf(entity).String(), key)
 238 }
 239
 240 func (w *rNibReaderInstance) getListNodebIdsByType(nbType string) ([]*entities.NbIdentity, error) {
 241         data, err := (*w.sdl).GetMembers(nbType)
 242         if err != nil {
 243                 return nil, common.NewInternalError(err)
 244         }
 245         return w.unmarshalIdentityList(data)
 246 }
 247
 248 func (w *rNibReaderInstance) unmarshalIdentityList(data []string) ([]*entities.NbIdentity, error) {
 249         var members []*entities.NbIdentity
 250         for _, d := range data {
 251                 member := entities.NbIdentity{}
 252                 err := proto.Unmarshal([]byte(d), &member)
 253                 if err != nil {
 254                         return nil, common.NewInternalError(err)
 255                 }
 256                 members = append(members, &member)
 257         }
 258         return members, nil
 259 }
 260
 261 func Close() {
 262         readerPool.Close()
 263 }