2 // Copyright 2019 AT&T Intellectual Property
3 // Copyright 2019 Nokia
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
9 // http://www.apache.org/licenses/LICENSE-2.0
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.
22 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
23 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
24 "github.com/golang/protobuf/proto"
27 type rNibWriterInstance struct {
28 sdl common.ISdlInstance
32 RNibWriter interface allows saving data to the redis DB
34 type RNibWriter interface {
35 SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error
36 UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
37 SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
41 GetRNibWriter returns reference to RNibWriter
44 func GetRNibWriter(sdl common.ISdlInstance) RNibWriter {
45 return &rNibWriterInstance{sdl: sdl}
49 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
51 func (w *rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *entities.NodebInfo) error {
52 isNotEmptyIdentity := isNotEmpty(nbIdentity)
54 if isNotEmptyIdentity && entity.GetNodeType() == entities.Node_UNKNOWN {
55 return common.NewValidationError(fmt.Sprintf("#rNibWriter.saveNodeB - Unknown responding node type, entity: %v", entity))
57 data, err := proto.Marshal(entity)
59 return common.NewInternalError(err)
61 var pairs []interface{}
62 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nbIdentity.InventoryName)
66 pairs = append(pairs, key, data)
68 if isNotEmptyIdentity {
69 key, rNibErr = common.ValidateAndBuildNodeBIdKey(entity.GetNodeType().String(), nbIdentity.GlobalNbId.GetPlmnId(), nbIdentity.GlobalNbId.GetNbId())
73 pairs = append(pairs, key, data)
76 if entity.GetEnb() != nil {
77 pairs, rNibErr = appendEnbCells(nbIdentity, entity.GetEnb().GetServedCells(), pairs)
82 if entity.GetGnb() != nil {
83 pairs, rNibErr = appendGnbCells(nbIdentity, entity.GetGnb().GetServedNrCells(), pairs)
88 err = w.sdl.Set(pairs)
90 return common.NewInternalError(err)
93 ranNameIdentity := &entities.NbIdentity{InventoryName: nbIdentity.InventoryName}
95 if isNotEmptyIdentity {
96 nbIdData, err := proto.Marshal(ranNameIdentity)
98 return common.NewInternalError(err)
100 err = w.sdl.RemoveMember(entities.Node_UNKNOWN.String(), nbIdData)
102 return common.NewInternalError(err)
105 nbIdentity = ranNameIdentity
108 nbIdData, err := proto.Marshal(nbIdentity)
110 return common.NewInternalError(err)
112 err = w.sdl.AddMember(entity.GetNodeType().String(), nbIdData)
114 return common.NewInternalError(err)
122 func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
124 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
130 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
132 data, err := proto.Marshal(nodebInfo)
135 return common.NewInternalError(err)
138 var pairs []interface{}
139 pairs = append(pairs, nodebNameKey, data)
141 if buildNodebIdKeyError == nil {
142 pairs = append(pairs, nodebIdKey, data)
145 err = w.sdl.Set(pairs)
148 return common.NewInternalError(err)
155 SaveRanLoadInformation stores ran load information for the provided ran
157 func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
159 key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
165 data, err := proto.Marshal(ranLoadInformation)
168 return common.NewInternalError(err)
171 var pairs []interface{}
172 pairs = append(pairs, key, data)
174 err = w.sdl.Set(pairs)
177 return common.NewInternalError(err)
190 func appendEnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
191 for _, cell := range cells {
192 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
193 cellData, err := proto.Marshal(&cellEntity)
195 return pairs, common.NewInternalError(err)
197 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
199 return pairs, rNibErr
201 pairs = append(pairs, key, cellData)
202 key, rNibErr = common.ValidateAndBuildCellNamePciKey(nbIdentity.InventoryName, cell.GetPci())
204 return pairs, rNibErr
206 pairs = append(pairs, key, cellData)
211 func appendGnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
212 for _, cell := range cells {
213 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
214 cellData, err := proto.Marshal(&cellEntity)
216 return pairs, common.NewInternalError(err)
218 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
220 return pairs, rNibErr
222 pairs = append(pairs, key, cellData)
223 key, rNibErr = common.ValidateAndBuildCellNamePciKey(nbIdentity.InventoryName, cell.GetServedNrCellInformation().GetNrPci())
225 return pairs, rNibErr
227 pairs = append(pairs, key, cellData)
232 func isNotEmpty(nbIdentity *entities.NbIdentity) bool {
233 return nbIdentity.GlobalNbId != nil && nbIdentity.GlobalNbId.PlmnId != "" && nbIdentity.GlobalNbId.NbId != ""