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).
26 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
27 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
28 "github.com/golang/protobuf/proto"
32 E2TAddressesKey = "E2TAddresses"
33 RanAddedEvent = "ADDED"
34 RanUpdatedEvent = "UPDATED"
35 RanDeletedEvent = "DELETED"
38 type rNibWriterInstance struct {
39 sdl common.ISdlInstance
40 rnibWriterConfig configuration.RnibWriterConfig
44 RNibWriter interface allows saving data to the redis DB
46 type RNibWriter interface {
47 SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error
48 UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
49 SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
50 SaveE2TInstance(e2tInstance *entities.E2TInstance) error
51 SaveE2TAddresses(addresses []string) error
52 RemoveE2TInstance(e2tAddress string) error
53 UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error
54 RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error
55 UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, ent string) error
56 SaveGeneralConfiguration(config *entities.GeneralConfiguration) error
57 RemoveEnb(nodebInfo *entities.NodebInfo) error
58 RemoveServedCells(inventoryName string, servedCells []*entities.ServedCellInfo) error
59 UpdateEnb(nodebInfo *entities.NodebInfo, servedCells []*entities.ServedCellInfo) error
63 GetRNibWriter returns reference to RNibWriter
66 func GetRNibWriter(sdl common.ISdlInstance, rnibWriterConfig configuration.RnibWriterConfig) RNibWriter {
67 return &rNibWriterInstance{sdl: sdl, rnibWriterConfig: rnibWriterConfig}
70 func (w *rNibWriterInstance) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
71 cellKeysToRemove := buildServedNRCellKeysToRemove(inventoryName, servedNrCells)
73 err := w.sdl.Remove(cellKeysToRemove)
76 return common.NewInternalError(err)
82 func (w *rNibWriterInstance) RemoveServedCells(inventoryName string, servedCells []*entities.ServedCellInfo) error {
83 cellKeysToRemove := buildServedCellInfoKeysToRemove(inventoryName, servedCells)
85 err := w.sdl.Remove(cellKeysToRemove)
88 return common.NewInternalError(err)
94 func (w *rNibWriterInstance) SaveGeneralConfiguration(config *entities.GeneralConfiguration) error {
96 err := w.SaveWithKeyAndMarshal(common.BuildGeneralConfigurationKey(), config)
99 return common.NewInternalError(err)
106 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
108 func (w *rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *entities.NodebInfo) error {
109 isNotEmptyIdentity := isNotEmpty(nbIdentity)
111 nodeType := entity.GetNodeType()
113 if isNotEmptyIdentity && nodeType == entities.Node_UNKNOWN {
114 return common.NewValidationError(fmt.Sprintf("#rNibWriter.saveNodeB - Unknown responding node type, entity: %v", entity))
117 data, err := proto.Marshal(entity)
120 return common.NewInternalError(err)
123 var pairs []interface{}
124 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nbIdentity.InventoryName)
130 pairs = append(pairs, key, data)
132 if isNotEmptyIdentity {
134 key, rNibErr = common.ValidateAndBuildNodeBIdKey(nodeType.String(), nbIdentity.GlobalNbId.GetPlmnId(), nbIdentity.GlobalNbId.GetNbId())
138 pairs = append(pairs, key, data)
141 if entity.GetEnb() != nil {
142 pairs, rNibErr = appendEnbCells(nbIdentity.InventoryName, entity.GetEnb().GetServedCells(), pairs)
148 if entity.GetGnb() != nil {
149 pairs, rNibErr = appendGnbCells(nbIdentity.InventoryName, entity.GetGnb().GetServedNrCells(), pairs)
155 if nodeType == entities.Node_ENB {
156 err = w.sdl.SetAndPublish([]string{w.rnibWriterConfig.RanManipulationMessageChannel, fmt.Sprintf("%s_%s", entity.RanName, RanAddedEvent)}, pairs)
158 err = w.sdl.Set(pairs)
162 return common.NewInternalError(err)
165 ranNameIdentity := &entities.NbIdentity{InventoryName: nbIdentity.InventoryName}
167 if isNotEmptyIdentity {
168 err := w.removeNbIdentity(entities.Node_UNKNOWN, ranNameIdentity)
170 return common.NewInternalError(err)
173 nbIdentity = ranNameIdentity
176 nbIdData, err := proto.Marshal(nbIdentity)
179 return common.NewInternalError(err)
182 err = w.sdl.AddMember(nodeType.String(), nbIdData)
185 return common.NewInternalError(err)
190 func (w *rNibWriterInstance) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
192 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
198 pairs, err = appendGnbCells(nodebInfo.RanName, servedNrCells, pairs)
204 err = w.sdl.Set(pairs)
207 return common.NewInternalError(err)
213 func buildServedNRCellKeysToRemove(inventoryName string, servedNrCellsToRemove []*entities.ServedNRCell) []string {
215 var cellKeysToRemove []string
217 for _, cell := range servedNrCellsToRemove {
219 key, _ := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
222 cellKeysToRemove = append(cellKeysToRemove, key)
225 key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
228 cellKeysToRemove = append(cellKeysToRemove, key)
232 return cellKeysToRemove
235 func buildServedCellInfoKeysToRemove(inventoryName string, servedCellsToRemove []*entities.ServedCellInfo) []string {
237 var cellKeysToRemove []string
239 for _, cell := range servedCellsToRemove {
241 key, _ := common.ValidateAndBuildCellIdKey(cell.GetCellId())
244 cellKeysToRemove = append(cellKeysToRemove, key)
247 key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
250 cellKeysToRemove = append(cellKeysToRemove, key)
254 return cellKeysToRemove
257 func buildUpdateNodebInfoPairs(nodebInfo *entities.NodebInfo) ([]interface{}, error) {
258 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
261 return []interface{}{}, rNibErr
264 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
266 data, err := proto.Marshal(nodebInfo)
269 return []interface{}{}, common.NewInternalError(err)
272 pairs := []interface{}{nodebNameKey, data}
274 if buildNodebIdKeyError == nil {
275 pairs = append(pairs, nodebIdKey, data)
281 func (w *rNibWriterInstance) buildRemoveEnbKeys(nodebInfo *entities.NodebInfo) ([]string, error) {
282 keys := buildServedCellInfoKeysToRemove(nodebInfo.GetRanName(), nodebInfo.GetEnb().GetServedCells())
284 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
287 return []string{}, rNibErr
290 keys = append(keys, nodebNameKey)
292 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
294 if buildNodebIdKeyError == nil {
295 keys = append(keys, nodebIdKey)
301 func (w *rNibWriterInstance) removeNbIdentity(nodeType entities.Node_Type ,nbIdentity *entities.NbIdentity) error {
302 nbIdData, err := proto.Marshal(nbIdentity)
304 return common.NewInternalError(err)
306 err = w.sdl.RemoveMember(nodeType.String(), nbIdData)
308 return common.NewInternalError(err)
316 func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
318 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
324 err = w.sdl.Set(pairs)
327 return common.NewInternalError(err)
334 SaveRanLoadInformation stores ran load information for the provided ran
336 func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
338 key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
344 data, err := proto.Marshal(ranLoadInformation)
347 return common.NewInternalError(err)
350 var pairs []interface{}
351 pairs = append(pairs, key, data)
353 err = w.sdl.Set(pairs)
356 return common.NewInternalError(err)
362 func (w *rNibWriterInstance) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
364 key, rnibErr := common.ValidateAndBuildE2TInstanceKey(e2tInstance.Address)
370 data, err := json.Marshal(e2tInstance)
373 return common.NewInternalError(err)
376 var pairs []interface{}
377 pairs = append(pairs, key, data)
379 err = w.sdl.Set(pairs)
382 return common.NewInternalError(err)
388 func (w *rNibWriterInstance) SaveE2TAddresses(addresses []string) error {
390 data, err := json.Marshal(addresses)
393 return common.NewInternalError(err)
396 var pairs []interface{}
397 pairs = append(pairs, E2TAddressesKey, data)
399 err = w.sdl.Set(pairs)
402 return common.NewInternalError(err)
408 func (w *rNibWriterInstance) RemoveE2TInstance(address string) error {
409 key, rNibErr := common.ValidateAndBuildE2TInstanceKey(address)
413 err := w.sdl.Remove([]string{key})
416 return common.NewInternalError(err)
421 func (w *rNibWriterInstance) SaveWithKeyAndMarshal(key string, entity interface{}) error {
423 data, err := json.Marshal(entity)
426 return common.NewInternalError(err)
429 var pairs []interface{}
430 pairs = append(pairs, key, data)
432 err = w.sdl.Set(pairs)
435 return common.NewInternalError(err)
442 UpdateNodebInfoOnConnectionStatusInversion...
444 func (w *rNibWriterInstance) UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event string) error {
446 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
452 err = w.sdl.SetAndPublish([]string{w.rnibWriterConfig.StateChangeMessageChannel, event}, pairs)
455 return common.NewInternalError(err)
461 func (w *rNibWriterInstance) RemoveEnb(nodebInfo *entities.NodebInfo) error {
462 ranNameIdentity := &entities.NbIdentity{InventoryName: nodebInfo.RanName, GlobalNbId: nodebInfo.GetGlobalNbId()}
463 err := w.removeNbIdentity(entities.Node_ENB, ranNameIdentity)
468 keysToRemove, err := w.buildRemoveEnbKeys(nodebInfo)
473 err = w.sdl.RemoveAndPublish([]string{w.rnibWriterConfig.RanManipulationMessageChannel, fmt.Sprintf("%s_%s", nodebInfo.RanName, RanDeletedEvent)}, keysToRemove)
476 return common.NewInternalError(err)
482 func (w *rNibWriterInstance) UpdateEnb(nodebInfo *entities.NodebInfo, servedCells []*entities.ServedCellInfo) error {
484 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
490 pairs, err = appendEnbCells(nodebInfo.RanName, servedCells, pairs)
496 err = w.sdl.SetAndPublish([]string{w.rnibWriterConfig.RanManipulationMessageChannel, fmt.Sprintf("%s_%s", nodebInfo.RanName, RanUpdatedEvent)}, pairs)
499 return common.NewInternalError(err)
511 func appendEnbCells(inventoryName string, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
512 for _, cell := range cells {
513 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
514 cellData, err := proto.Marshal(&cellEntity)
516 return pairs, common.NewInternalError(err)
518 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
520 return pairs, rNibErr
522 pairs = append(pairs, key, cellData)
523 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
525 return pairs, rNibErr
527 pairs = append(pairs, key, cellData)
532 func appendGnbCells(inventoryName string, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
533 for _, cell := range cells {
534 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
535 cellData, err := proto.Marshal(&cellEntity)
537 return pairs, common.NewInternalError(err)
539 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
541 return pairs, rNibErr
543 pairs = append(pairs, key, cellData)
544 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
546 return pairs, rNibErr
548 pairs = append(pairs, key, cellData)
553 func isNotEmpty(nbIdentity *entities.NbIdentity) bool {
554 return nbIdentity.GlobalNbId != nil && nbIdentity.GlobalNbId.PlmnId != "" && nbIdentity.GlobalNbId.NbId != ""