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
65 GetRNibWriter returns reference to RNibWriter
68 func GetRNibWriter(sdl common.ISdlInstance, rnibWriterConfig configuration.RnibWriterConfig) RNibWriter {
69 return &rNibWriterInstance{sdl: sdl, rnibWriterConfig: rnibWriterConfig}
72 func getChannelsAndEventsPair(channel string, ranName string, event string) []string {
73 return []string{channel, fmt.Sprintf("%s_%s", ranName, event)}
76 func (w *rNibWriterInstance) AddNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error {
77 nbIdData, err := proto.Marshal(nbIdentity)
80 return common.NewInternalError(err)
83 err = w.sdl.AddMember(nodeType.String(), nbIdData)
86 return common.NewInternalError(err)
91 func (w *rNibWriterInstance) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
92 cellKeysToRemove := buildServedNRCellKeysToRemove(inventoryName, servedNrCells)
94 err := w.sdl.Remove(cellKeysToRemove)
97 return common.NewInternalError(err)
103 func (w *rNibWriterInstance) RemoveServedCells(inventoryName string, servedCells []*entities.ServedCellInfo) error {
104 cellKeysToRemove := buildServedCellInfoKeysToRemove(inventoryName, servedCells)
106 err := w.sdl.Remove(cellKeysToRemove)
109 return common.NewInternalError(err)
115 func (w *rNibWriterInstance) SaveGeneralConfiguration(config *entities.GeneralConfiguration) error {
117 err := w.SaveWithKeyAndMarshal(common.BuildGeneralConfigurationKey(), config)
120 return common.NewInternalError(err)
127 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
129 func (w *rNibWriterInstance) SaveNodeb(nodebInfo *entities.NodebInfo) error {
131 data, err := proto.Marshal(nodebInfo)
134 return common.NewInternalError(err)
137 var pairs []interface{}
138 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.RanName)
144 pairs = append(pairs, key, data)
146 if nodebInfo.GlobalNbId != nil {
148 key, rNibErr = common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
152 pairs = append(pairs, key, data)
155 if nodebInfo.GetEnb() != nil {
156 pairs, rNibErr = appendEnbCells(nodebInfo.RanName, nodebInfo.GetEnb().GetServedCells(), pairs)
162 if nodebInfo.GetGnb() != nil {
163 pairs, rNibErr = appendGnbCells(nodebInfo.RanName, nodebInfo.GetGnb().GetServedNrCells(), pairs)
169 if nodebInfo.GetNodeType() == entities.Node_ENB {
170 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanAddedEvent)
171 err = w.sdl.SetAndPublish(channelsAndEvents, pairs)
173 err = w.sdl.Set(pairs)
177 return common.NewInternalError(err)
183 func (w *rNibWriterInstance) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
185 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
191 pairs, err = appendGnbCells(nodebInfo.RanName, servedNrCells, pairs)
197 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanUpdatedEvent)
198 err = w.sdl.SetAndPublish(channelsAndEvents, pairs)
201 return common.NewInternalError(err)
207 func buildServedNRCellKeysToRemove(inventoryName string, servedNrCellsToRemove []*entities.ServedNRCell) []string {
209 var cellKeysToRemove []string
211 for _, cell := range servedNrCellsToRemove {
213 key, _ := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
216 cellKeysToRemove = append(cellKeysToRemove, key)
219 key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
222 cellKeysToRemove = append(cellKeysToRemove, key)
226 return cellKeysToRemove
229 func buildServedCellInfoKeysToRemove(inventoryName string, servedCellsToRemove []*entities.ServedCellInfo) []string {
231 var cellKeysToRemove []string
233 for _, cell := range servedCellsToRemove {
235 key, _ := common.ValidateAndBuildCellIdKey(cell.GetCellId())
238 cellKeysToRemove = append(cellKeysToRemove, key)
241 key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
244 cellKeysToRemove = append(cellKeysToRemove, key)
248 return cellKeysToRemove
251 func buildUpdateNodebInfoPairs(nodebInfo *entities.NodebInfo) ([]interface{}, error) {
252 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
255 return []interface{}{}, rNibErr
258 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
260 data, err := proto.Marshal(nodebInfo)
263 return []interface{}{}, common.NewInternalError(err)
266 pairs := []interface{}{nodebNameKey, data}
268 if buildNodebIdKeyError == nil {
269 pairs = append(pairs, nodebIdKey, data)
275 func (w *rNibWriterInstance) buildRemoveEnbKeys(nodebInfo *entities.NodebInfo) ([]string, error) {
276 keys := buildServedCellInfoKeysToRemove(nodebInfo.GetRanName(), nodebInfo.GetEnb().GetServedCells())
278 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
281 return []string{}, rNibErr
284 keys = append(keys, nodebNameKey)
286 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
288 if buildNodebIdKeyError == nil {
289 keys = append(keys, nodebIdKey)
295 func (w *rNibWriterInstance) RemoveNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error {
296 nbIdData, err := proto.Marshal(nbIdentity)
298 return common.NewInternalError(err)
300 err = w.sdl.RemoveMember(nodeType.String(), nbIdData)
302 return common.NewInternalError(err)
310 func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
312 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
318 err = w.sdl.Set(pairs)
321 return common.NewInternalError(err)
328 SaveRanLoadInformation stores ran load information for the provided ran
330 func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
332 key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
338 data, err := proto.Marshal(ranLoadInformation)
341 return common.NewInternalError(err)
344 var pairs []interface{}
345 pairs = append(pairs, key, data)
347 err = w.sdl.Set(pairs)
350 return common.NewInternalError(err)
356 func (w *rNibWriterInstance) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
358 key, rnibErr := common.ValidateAndBuildE2TInstanceKey(e2tInstance.Address)
364 data, err := json.Marshal(e2tInstance)
367 return common.NewInternalError(err)
370 var pairs []interface{}
371 pairs = append(pairs, key, data)
373 err = w.sdl.Set(pairs)
376 return common.NewInternalError(err)
382 func (w *rNibWriterInstance) SaveE2TAddresses(addresses []string) error {
384 data, err := json.Marshal(addresses)
387 return common.NewInternalError(err)
390 var pairs []interface{}
391 pairs = append(pairs, E2TAddressesKey, data)
393 err = w.sdl.Set(pairs)
396 return common.NewInternalError(err)
402 func (w *rNibWriterInstance) RemoveE2TInstance(address string) error {
403 key, rNibErr := common.ValidateAndBuildE2TInstanceKey(address)
407 err := w.sdl.Remove([]string{key})
410 return common.NewInternalError(err)
415 func (w *rNibWriterInstance) SaveWithKeyAndMarshal(key string, entity interface{}) error {
417 data, err := json.Marshal(entity)
420 return common.NewInternalError(err)
423 var pairs []interface{}
424 pairs = append(pairs, key, data)
426 err = w.sdl.Set(pairs)
429 return common.NewInternalError(err)
436 UpdateNodebInfoOnConnectionStatusInversion...
438 func (w *rNibWriterInstance) UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event string) error {
440 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
446 err = w.sdl.SetAndPublish([]string{w.rnibWriterConfig.StateChangeMessageChannel, event}, pairs)
449 return common.NewInternalError(err)
455 func (w *rNibWriterInstance) RemoveEnb(nodebInfo *entities.NodebInfo) error {
456 keysToRemove, err := w.buildRemoveEnbKeys(nodebInfo)
461 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanDeletedEvent)
462 err = w.sdl.RemoveAndPublish(channelsAndEvents, keysToRemove)
465 return common.NewInternalError(err)
471 func (w *rNibWriterInstance) UpdateEnb(nodebInfo *entities.NodebInfo, servedCells []*entities.ServedCellInfo) error {
473 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
479 pairs, err = appendEnbCells(nodebInfo.RanName, servedCells, pairs)
485 channelsAndEvents := getChannelsAndEventsPair(w.rnibWriterConfig.RanManipulationMessageChannel, nodebInfo.RanName, RanUpdatedEvent)
486 err = w.sdl.SetAndPublish(channelsAndEvents, pairs)
489 return common.NewInternalError(err)
502 func appendEnbCells(inventoryName string, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
503 for _, cell := range cells {
504 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
505 cellData, err := proto.Marshal(&cellEntity)
507 return pairs, common.NewInternalError(err)
509 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
511 return pairs, rNibErr
513 pairs = append(pairs, key, cellData)
514 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
516 return pairs, rNibErr
518 pairs = append(pairs, key, cellData)
523 func appendGnbCells(inventoryName string, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
524 for _, cell := range cells {
525 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
526 cellData, err := proto.Marshal(&cellEntity)
528 return pairs, common.NewInternalError(err)
530 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
532 return pairs, rNibErr
534 pairs = append(pairs, key, cellData)
535 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
537 return pairs, rNibErr
539 pairs = append(pairs, key, cellData)