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 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
60 AddNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error
61 RemoveNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error
62 AddEnb(nodebInfo *entities.NodebInfo) error
66 GetRNibWriter returns reference to RNibWriter
69 func GetRNibWriter(sdl common.ISdlInstance, rnibWriterConfig configuration.RnibWriterConfig) RNibWriter {
70 return &rNibWriterInstance{sdl: sdl, rnibWriterConfig: rnibWriterConfig}
73 func getChannelsAndEventsPair(channel string, ranName string, event string) []string {
74 return []string{channel, fmt.Sprintf("%s_%s", ranName, event)}
77 func (w *rNibWriterInstance) AddNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error {
78 nbIdData, err := proto.Marshal(nbIdentity)
81 return common.NewInternalError(err)
84 err = w.sdl.AddMember(nodeType.String(), nbIdData)
87 return common.NewInternalError(err)
92 func (w *rNibWriterInstance) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
93 cellKeysToRemove := buildServedNRCellKeysToRemove(inventoryName, servedNrCells)
95 err := w.sdl.Remove(cellKeysToRemove)
98 return common.NewInternalError(err)
104 func (w *rNibWriterInstance) RemoveServedCells(inventoryName string, servedCells []*entities.ServedCellInfo) error {
105 cellKeysToRemove := buildServedCellInfoKeysToRemove(inventoryName, servedCells)
107 err := w.sdl.Remove(cellKeysToRemove)
110 return common.NewInternalError(err)
116 func (w *rNibWriterInstance) SaveGeneralConfiguration(config *entities.GeneralConfiguration) error {
118 err := w.SaveWithKeyAndMarshal(common.BuildGeneralConfigurationKey(), config)
121 return common.NewInternalError(err)
128 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
130 func (w *rNibWriterInstance) SaveNodeb(nodebInfo *entities.NodebInfo) error {
132 data, err := proto.Marshal(nodebInfo)
135 return common.NewInternalError(err)
138 var pairs []interface{}
139 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.RanName)
145 pairs = append(pairs, key, data)
147 if nodebInfo.GlobalNbId != nil {
149 key, rNibErr = common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
153 pairs = append(pairs, key, data)
156 if nodebInfo.GetEnb() != nil {
157 pairs, rNibErr = appendEnbCells(nodebInfo.RanName, nodebInfo.GetEnb().GetServedCells(), pairs)
163 if nodebInfo.GetGnb() != nil {
164 pairs, rNibErr = appendGnbCells(nodebInfo.RanName, nodebInfo.GetGnb().GetServedNrCells(), pairs)
170 err = w.sdl.Set(pairs)
173 return common.NewInternalError(err)
179 func (w *rNibWriterInstance) AddEnb(nodebInfo *entities.NodebInfo) error {
181 data, err := proto.Marshal(nodebInfo)
184 return common.NewInternalError(err)
187 var pairs []interface{}
188 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.RanName)
194 pairs = append(pairs, key, data)
196 if nodebInfo.GlobalNbId != nil {
198 key, rNibErr = common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
202 pairs = append(pairs, key, data)
205 pairs, rNibErr = appendEnbCells(nodebInfo.RanName, nodebInfo.GetEnb().GetServedCells(), pairs)
210 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanAddedEvent)
211 err = w.sdl.SetAndPublish(channelsAndEvents, pairs)
213 return common.NewInternalError(err)
219 func (w *rNibWriterInstance) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
221 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
227 pairs, err = appendGnbCells(nodebInfo.RanName, servedNrCells, pairs)
233 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanUpdatedEvent)
234 err = w.sdl.SetAndPublish(channelsAndEvents, pairs)
237 return common.NewInternalError(err)
243 func buildServedNRCellKeysToRemove(inventoryName string, servedNrCellsToRemove []*entities.ServedNRCell) []string {
245 var cellKeysToRemove []string
247 for _, cell := range servedNrCellsToRemove {
249 key, _ := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
252 cellKeysToRemove = append(cellKeysToRemove, key)
255 key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
258 cellKeysToRemove = append(cellKeysToRemove, key)
262 return cellKeysToRemove
265 func buildServedCellInfoKeysToRemove(inventoryName string, servedCellsToRemove []*entities.ServedCellInfo) []string {
267 var cellKeysToRemove []string
269 for _, cell := range servedCellsToRemove {
271 key, _ := common.ValidateAndBuildCellIdKey(cell.GetCellId())
274 cellKeysToRemove = append(cellKeysToRemove, key)
277 key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
280 cellKeysToRemove = append(cellKeysToRemove, key)
284 return cellKeysToRemove
287 func buildUpdateNodebInfoPairs(nodebInfo *entities.NodebInfo) ([]interface{}, error) {
288 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
291 return []interface{}{}, rNibErr
294 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
296 data, err := proto.Marshal(nodebInfo)
299 return []interface{}{}, common.NewInternalError(err)
302 pairs := []interface{}{nodebNameKey, data}
304 if buildNodebIdKeyError == nil {
305 pairs = append(pairs, nodebIdKey, data)
311 func (w *rNibWriterInstance) buildRemoveEnbKeys(nodebInfo *entities.NodebInfo) ([]string, error) {
312 keys := buildServedCellInfoKeysToRemove(nodebInfo.GetRanName(), nodebInfo.GetEnb().GetServedCells())
314 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
317 return []string{}, rNibErr
320 keys = append(keys, nodebNameKey)
322 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
324 if buildNodebIdKeyError == nil {
325 keys = append(keys, nodebIdKey)
331 func (w *rNibWriterInstance) RemoveNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error {
332 nbIdData, err := proto.Marshal(nbIdentity)
334 return common.NewInternalError(err)
336 err = w.sdl.RemoveMember(nodeType.String(), nbIdData)
338 return common.NewInternalError(err)
346 func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
348 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
354 err = w.sdl.Set(pairs)
357 return common.NewInternalError(err)
364 SaveRanLoadInformation stores ran load information for the provided ran
366 func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
368 key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
374 data, err := proto.Marshal(ranLoadInformation)
377 return common.NewInternalError(err)
380 var pairs []interface{}
381 pairs = append(pairs, key, data)
383 err = w.sdl.Set(pairs)
386 return common.NewInternalError(err)
392 func (w *rNibWriterInstance) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
394 key, rnibErr := common.ValidateAndBuildE2TInstanceKey(e2tInstance.Address)
400 data, err := json.Marshal(e2tInstance)
403 return common.NewInternalError(err)
406 var pairs []interface{}
407 pairs = append(pairs, key, data)
409 err = w.sdl.Set(pairs)
412 return common.NewInternalError(err)
418 func (w *rNibWriterInstance) SaveE2TAddresses(addresses []string) error {
420 data, err := json.Marshal(addresses)
423 return common.NewInternalError(err)
426 var pairs []interface{}
427 pairs = append(pairs, E2TAddressesKey, data)
429 err = w.sdl.Set(pairs)
432 return common.NewInternalError(err)
438 func (w *rNibWriterInstance) RemoveE2TInstance(address string) error {
439 key, rNibErr := common.ValidateAndBuildE2TInstanceKey(address)
443 err := w.sdl.Remove([]string{key})
446 return common.NewInternalError(err)
451 func (w *rNibWriterInstance) SaveWithKeyAndMarshal(key string, entity interface{}) error {
453 data, err := json.Marshal(entity)
456 return common.NewInternalError(err)
459 var pairs []interface{}
460 pairs = append(pairs, key, data)
462 err = w.sdl.Set(pairs)
465 return common.NewInternalError(err)
472 UpdateNodebInfoOnConnectionStatusInversion...
474 func (w *rNibWriterInstance) UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event string) error {
476 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
482 err = w.sdl.SetAndPublish([]string{w.rnibWriterConfig.StateChangeMessageChannel, event}, pairs)
485 return common.NewInternalError(err)
491 func (w *rNibWriterInstance) RemoveEnb(nodebInfo *entities.NodebInfo) error {
492 keysToRemove, err := w.buildRemoveEnbKeys(nodebInfo)
497 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanDeletedEvent)
498 err = w.sdl.RemoveAndPublish(channelsAndEvents, keysToRemove)
501 return common.NewInternalError(err)
507 func (w *rNibWriterInstance) UpdateEnb(nodebInfo *entities.NodebInfo, servedCells []*entities.ServedCellInfo) error {
509 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
515 pairs, err = appendEnbCells(nodebInfo.RanName, servedCells, pairs)
521 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanUpdatedEvent)
522 err = w.sdl.SetAndPublish(channelsAndEvents, pairs)
525 return common.NewInternalError(err)
538 func appendEnbCells(inventoryName string, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
539 for _, cell := range cells {
540 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
541 cellData, err := proto.Marshal(&cellEntity)
543 return pairs, common.NewInternalError(err)
545 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
547 return pairs, rNibErr
549 pairs = append(pairs, key, cellData)
550 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
552 return pairs, rNibErr
554 pairs = append(pairs, key, cellData)
559 func appendGnbCells(inventoryName string, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
560 for _, cell := range cells {
561 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
562 cellData, err := proto.Marshal(&cellEntity)
564 return pairs, common.NewInternalError(err)
566 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
568 return pairs, rNibErr
570 pairs = append(pairs, key, cellData)
571 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
573 return pairs, rNibErr
575 pairs = append(pairs, key, cellData)