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(nodebInfo *entities.NodebInfo) error
48 UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
49 UpdateNodebInfoAndPublish(nodebInfo *entities.NodebInfo) error
50 SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
51 SaveE2TInstance(e2tInstance *entities.E2TInstance) error
52 SaveE2TAddresses(addresses []string) error
53 RemoveE2TInstance(e2tAddress string) error
54 UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error
55 RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error
56 UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, ent string) error
57 SaveGeneralConfiguration(config *entities.GeneralConfiguration) error
58 RemoveEnb(nodebInfo *entities.NodebInfo) error
59 RemoveServedCells(inventoryName string, servedCells []*entities.ServedCellInfo) error
60 UpdateEnb(nodebInfo *entities.NodebInfo, servedCells []*entities.ServedCellInfo) error
61 AddNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error
62 RemoveNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error
63 AddEnb(nodebInfo *entities.NodebInfo) error
67 GetRNibWriter returns reference to RNibWriter
70 func GetRNibWriter(sdl common.ISdlInstance, rnibWriterConfig configuration.RnibWriterConfig) RNibWriter {
71 return &rNibWriterInstance{sdl: sdl, rnibWriterConfig: rnibWriterConfig}
74 func getChannelsAndEventsPair(channel string, ranName string, event string) []string {
75 return []string{channel, fmt.Sprintf("%s_%s", ranName, event)}
78 func (w *rNibWriterInstance) AddNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error {
79 nbIdData, err := proto.Marshal(nbIdentity)
82 return common.NewInternalError(err)
85 err = w.sdl.AddMember(nodeType.String(), nbIdData)
88 return common.NewInternalError(err)
93 func (w *rNibWriterInstance) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
94 cellKeysToRemove := buildServedNRCellKeysToRemove(inventoryName, servedNrCells)
96 err := w.sdl.Remove(cellKeysToRemove)
99 return common.NewInternalError(err)
105 func (w *rNibWriterInstance) RemoveServedCells(inventoryName string, servedCells []*entities.ServedCellInfo) error {
106 cellKeysToRemove := buildServedCellInfoKeysToRemove(inventoryName, servedCells)
108 err := w.sdl.Remove(cellKeysToRemove)
111 return common.NewInternalError(err)
117 func (w *rNibWriterInstance) SaveGeneralConfiguration(config *entities.GeneralConfiguration) error {
119 err := w.SaveWithKeyAndMarshal(common.BuildGeneralConfigurationKey(), config)
122 return common.NewInternalError(err)
129 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
131 func (w *rNibWriterInstance) SaveNodeb(nodebInfo *entities.NodebInfo) error {
133 data, err := proto.Marshal(nodebInfo)
136 return common.NewInternalError(err)
139 var pairs []interface{}
140 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.RanName)
146 pairs = append(pairs, key, data)
148 if nodebInfo.GlobalNbId != nil {
150 key, rNibErr = common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
154 pairs = append(pairs, key, data)
157 if nodebInfo.GetEnb() != nil {
158 pairs, rNibErr = appendEnbCells(nodebInfo.RanName, nodebInfo.GetEnb().GetServedCells(), pairs)
164 if nodebInfo.GetGnb() != nil {
165 pairs, rNibErr = appendGnbCells(nodebInfo.RanName, nodebInfo.GetGnb().GetServedNrCells(), pairs)
171 err = w.sdl.Set(pairs)
174 return common.NewInternalError(err)
180 func (w *rNibWriterInstance) AddEnb(nodebInfo *entities.NodebInfo) error {
182 data, err := proto.Marshal(nodebInfo)
185 return common.NewInternalError(err)
188 var pairs []interface{}
189 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.RanName)
195 pairs = append(pairs, key, data)
197 if nodebInfo.GlobalNbId != nil {
199 key, rNibErr = common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
203 pairs = append(pairs, key, data)
206 pairs, rNibErr = appendEnbCells(nodebInfo.RanName, nodebInfo.GetEnb().GetServedCells(), pairs)
211 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanAddedEvent)
212 err = w.sdl.SetAndPublish(channelsAndEvents, pairs)
214 return common.NewInternalError(err)
220 func (w *rNibWriterInstance) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
222 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
228 pairs, err = appendGnbCells(nodebInfo.RanName, servedNrCells, pairs)
234 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanUpdatedEvent)
235 err = w.sdl.SetAndPublish(channelsAndEvents, pairs)
238 return common.NewInternalError(err)
244 func buildServedNRCellKeysToRemove(inventoryName string, servedNrCellsToRemove []*entities.ServedNRCell) []string {
246 var cellKeysToRemove []string
248 for _, cell := range servedNrCellsToRemove {
250 key, _ := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
253 cellKeysToRemove = append(cellKeysToRemove, key)
256 key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
259 cellKeysToRemove = append(cellKeysToRemove, key)
263 return cellKeysToRemove
266 func buildServedCellInfoKeysToRemove(inventoryName string, servedCellsToRemove []*entities.ServedCellInfo) []string {
268 var cellKeysToRemove []string
270 for _, cell := range servedCellsToRemove {
272 key, _ := common.ValidateAndBuildCellIdKey(cell.GetCellId())
275 cellKeysToRemove = append(cellKeysToRemove, key)
278 key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
281 cellKeysToRemove = append(cellKeysToRemove, key)
285 return cellKeysToRemove
288 func buildUpdateNodebInfoPairs(nodebInfo *entities.NodebInfo) ([]interface{}, error) {
289 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
292 return []interface{}{}, rNibErr
295 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
297 data, err := proto.Marshal(nodebInfo)
300 return []interface{}{}, common.NewInternalError(err)
303 pairs := []interface{}{nodebNameKey, data}
305 if buildNodebIdKeyError == nil {
306 pairs = append(pairs, nodebIdKey, data)
312 func (w *rNibWriterInstance) buildRemoveEnbKeys(nodebInfo *entities.NodebInfo) ([]string, error) {
313 keys := buildServedCellInfoKeysToRemove(nodebInfo.GetRanName(), nodebInfo.GetEnb().GetServedCells())
315 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
318 return []string{}, rNibErr
321 keys = append(keys, nodebNameKey)
323 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
325 if buildNodebIdKeyError == nil {
326 keys = append(keys, nodebIdKey)
332 func (w *rNibWriterInstance) RemoveNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error {
333 nbIdData, err := proto.Marshal(nbIdentity)
335 return common.NewInternalError(err)
337 err = w.sdl.RemoveMember(nodeType.String(), nbIdData)
339 return common.NewInternalError(err)
344 func (w *rNibWriterInstance) updateNodebInfo(nodebInfo *entities.NodebInfo, publish bool) error {
346 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
353 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanUpdatedEvent)
354 err = w.sdl.SetAndPublish(channelsAndEvents, pairs)
356 err = w.sdl.Set(pairs)
360 return common.NewInternalError(err)
369 func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
370 return w.updateNodebInfo(nodebInfo, false)
374 UpdateNodebInfoAndPublish...
376 func (w *rNibWriterInstance) UpdateNodebInfoAndPublish(nodebInfo *entities.NodebInfo) error {
377 return w.updateNodebInfo(nodebInfo, true)
382 SaveRanLoadInformation stores ran load information for the provided ran
384 func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
386 key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
392 data, err := proto.Marshal(ranLoadInformation)
395 return common.NewInternalError(err)
398 var pairs []interface{}
399 pairs = append(pairs, key, data)
401 err = w.sdl.Set(pairs)
404 return common.NewInternalError(err)
410 func (w *rNibWriterInstance) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
412 key, rnibErr := common.ValidateAndBuildE2TInstanceKey(e2tInstance.Address)
418 data, err := json.Marshal(e2tInstance)
421 return common.NewInternalError(err)
424 var pairs []interface{}
425 pairs = append(pairs, key, data)
427 err = w.sdl.Set(pairs)
430 return common.NewInternalError(err)
436 func (w *rNibWriterInstance) SaveE2TAddresses(addresses []string) error {
438 data, err := json.Marshal(addresses)
441 return common.NewInternalError(err)
444 var pairs []interface{}
445 pairs = append(pairs, E2TAddressesKey, data)
447 err = w.sdl.Set(pairs)
450 return common.NewInternalError(err)
456 func (w *rNibWriterInstance) RemoveE2TInstance(address string) error {
457 key, rNibErr := common.ValidateAndBuildE2TInstanceKey(address)
461 err := w.sdl.Remove([]string{key})
464 return common.NewInternalError(err)
469 func (w *rNibWriterInstance) SaveWithKeyAndMarshal(key string, entity interface{}) error {
471 data, err := json.Marshal(entity)
474 return common.NewInternalError(err)
477 var pairs []interface{}
478 pairs = append(pairs, key, data)
480 err = w.sdl.Set(pairs)
483 return common.NewInternalError(err)
490 UpdateNodebInfoOnConnectionStatusInversion...
492 func (w *rNibWriterInstance) UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event string) error {
494 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
500 err = w.sdl.SetAndPublish([]string{w.rnibWriterConfig.StateChangeMessageChannel, event}, pairs)
503 return common.NewInternalError(err)
509 func (w *rNibWriterInstance) RemoveEnb(nodebInfo *entities.NodebInfo) error {
510 keysToRemove, err := w.buildRemoveEnbKeys(nodebInfo)
515 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanDeletedEvent)
516 err = w.sdl.RemoveAndPublish(channelsAndEvents, keysToRemove)
519 return common.NewInternalError(err)
525 func (w *rNibWriterInstance) UpdateEnb(nodebInfo *entities.NodebInfo, servedCells []*entities.ServedCellInfo) error {
527 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
533 pairs, err = appendEnbCells(nodebInfo.RanName, servedCells, pairs)
539 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanUpdatedEvent)
540 err = w.sdl.SetAndPublish(channelsAndEvents, pairs)
543 return common.NewInternalError(err)
556 func appendEnbCells(inventoryName string, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
557 for _, cell := range cells {
558 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
559 cellData, err := proto.Marshal(&cellEntity)
561 return pairs, common.NewInternalError(err)
563 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
565 return pairs, rNibErr
567 pairs = append(pairs, key, cellData)
568 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
570 return pairs, rNibErr
572 pairs = append(pairs, key, cellData)
577 func appendGnbCells(inventoryName string, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
578 for _, cell := range cells {
579 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
580 cellData, err := proto.Marshal(&cellEntity)
582 return pairs, common.NewInternalError(err)
584 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
586 return pairs, rNibErr
588 pairs = append(pairs, key, cellData)
589 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
591 return pairs, rNibErr
593 pairs = append(pairs, key, cellData)