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.
17 // This source code is part of the near-RT RIC (RAN Intelligent Controller)
18 // platform project (RICP).
25 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
26 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
27 "github.com/golang/protobuf/proto"
30 const E2TAddressesKey = "E2TAddresses"
32 type rNibWriterInstance struct {
33 sdl common.ISdlInstance
37 RNibWriter interface allows saving data to the redis DB
39 type RNibWriter interface {
40 SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error
41 UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
42 SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
43 SaveE2TInstance(e2tInstance *entities.E2TInstance) error
44 SaveE2TAddresses(addresses []string) error
45 RemoveE2TInstance(e2tAddress string) error
46 UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error
47 RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error
51 GetRNibWriter returns reference to RNibWriter
54 func GetRNibWriter(sdl common.ISdlInstance) RNibWriter {
55 return &rNibWriterInstance{sdl: sdl}
59 func (w *rNibWriterInstance) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
60 cellKeysToRemove := buildCellKeysToRemove(inventoryName, servedNrCells)
61 err := w.sdl.Remove(cellKeysToRemove)
64 return common.NewInternalError(err)
71 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
73 func (w *rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *entities.NodebInfo) error {
74 isNotEmptyIdentity := isNotEmpty(nbIdentity)
76 if isNotEmptyIdentity && entity.GetNodeType() == entities.Node_UNKNOWN {
77 return common.NewValidationError(fmt.Sprintf("#rNibWriter.saveNodeB - Unknown responding node type, entity: %v", entity))
79 data, err := proto.Marshal(entity)
81 return common.NewInternalError(err)
83 var pairs []interface{}
84 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nbIdentity.InventoryName)
88 pairs = append(pairs, key, data)
90 if isNotEmptyIdentity {
91 key, rNibErr = common.ValidateAndBuildNodeBIdKey(entity.GetNodeType().String(), nbIdentity.GlobalNbId.GetPlmnId(), nbIdentity.GlobalNbId.GetNbId())
95 pairs = append(pairs, key, data)
98 if entity.GetEnb() != nil {
99 pairs, rNibErr = appendEnbCells(nbIdentity.InventoryName, entity.GetEnb().GetServedCells(), pairs)
104 if entity.GetGnb() != nil {
105 pairs, rNibErr = appendGnbCells(nbIdentity.InventoryName, entity.GetGnb().GetServedNrCells(), pairs)
110 err = w.sdl.Set(pairs)
112 return common.NewInternalError(err)
115 ranNameIdentity := &entities.NbIdentity{InventoryName: nbIdentity.InventoryName}
117 if isNotEmptyIdentity {
118 nbIdData, err := proto.Marshal(ranNameIdentity)
120 return common.NewInternalError(err)
122 err = w.sdl.RemoveMember(entities.Node_UNKNOWN.String(), nbIdData)
124 return common.NewInternalError(err)
127 nbIdentity = ranNameIdentity
130 nbIdData, err := proto.Marshal(nbIdentity)
132 return common.NewInternalError(err)
134 err = w.sdl.AddMember(entity.GetNodeType().String(), nbIdData)
136 return common.NewInternalError(err)
141 func (w *rNibWriterInstance) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
143 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
149 pairs, err = appendGnbCells(nodebInfo.RanName, servedNrCells, pairs)
155 err = w.sdl.Set(pairs)
158 return common.NewInternalError(err)
164 func buildCellKeysToRemove(inventoryName string, servedNrCellsToRemove []*entities.ServedNRCell) []string {
166 cellKeysToRemove := []string{}
168 for _, cell := range servedNrCellsToRemove {
170 key, _ := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
173 cellKeysToRemove = append(cellKeysToRemove, key)
176 key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
179 cellKeysToRemove = append(cellKeysToRemove, key)
183 return cellKeysToRemove
186 func buildUpdateNodebInfoPairs(nodebInfo *entities.NodebInfo) ([]interface{}, error) {
187 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
190 return []interface{}{}, rNibErr
193 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
195 data, err := proto.Marshal(nodebInfo)
198 return []interface{}{}, common.NewInternalError(err)
201 pairs := []interface{}{nodebNameKey, data}
203 if buildNodebIdKeyError == nil {
204 pairs = append(pairs, nodebIdKey, data)
213 func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
215 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
221 err = w.sdl.Set(pairs)
224 return common.NewInternalError(err)
231 SaveRanLoadInformation stores ran load information for the provided ran
233 func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
235 key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
241 data, err := proto.Marshal(ranLoadInformation)
244 return common.NewInternalError(err)
247 var pairs []interface{}
248 pairs = append(pairs, key, data)
250 err = w.sdl.Set(pairs)
253 return common.NewInternalError(err)
259 func (w *rNibWriterInstance) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
261 key, rnibErr := common.ValidateAndBuildE2TInstanceKey(e2tInstance.Address)
267 data, err := json.Marshal(e2tInstance)
270 return common.NewInternalError(err)
273 var pairs []interface{}
274 pairs = append(pairs, key, data)
276 err = w.sdl.Set(pairs)
279 return common.NewInternalError(err)
285 func (w *rNibWriterInstance) SaveE2TAddresses(addresses []string) error {
287 data, err := json.Marshal(addresses)
290 return common.NewInternalError(err)
293 var pairs []interface{}
294 pairs = append(pairs, E2TAddressesKey, data)
296 err = w.sdl.Set(pairs)
299 return common.NewInternalError(err)
305 func (w *rNibWriterInstance) RemoveE2TInstance(address string) error {
306 key, rNibErr := common.ValidateAndBuildE2TInstanceKey(address)
310 err := w.sdl.Remove([]string{key})
313 return common.NewInternalError(err)
325 func appendEnbCells(inventoryName string, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
326 for _, cell := range cells {
327 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
328 cellData, err := proto.Marshal(&cellEntity)
330 return pairs, common.NewInternalError(err)
332 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
334 return pairs, rNibErr
336 pairs = append(pairs, key, cellData)
337 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
339 return pairs, rNibErr
341 pairs = append(pairs, key, cellData)
346 func appendGnbCells(inventoryName string, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
347 for _, cell := range cells {
348 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
349 cellData, err := proto.Marshal(&cellEntity)
351 return pairs, common.NewInternalError(err)
353 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
355 return pairs, rNibErr
357 pairs = append(pairs, key, cellData)
358 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
360 return pairs, rNibErr
362 pairs = append(pairs, key, cellData)
367 func isNotEmpty(nbIdentity *entities.NbIdentity) bool {
368 return nbIdentity.GlobalNbId != nil && nbIdentity.GlobalNbId.PlmnId != "" && nbIdentity.GlobalNbId.NbId != ""