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
48 UpdateNodebConnectivityState(nodebInfo *entities.NodebInfo, stateChangeMessageChannel string, event string) error
52 GetRNibWriter returns reference to RNibWriter
55 func GetRNibWriter(sdl common.ISdlInstance) RNibWriter {
56 return &rNibWriterInstance{sdl: sdl}
60 func (w *rNibWriterInstance) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
61 cellKeysToRemove := buildCellKeysToRemove(inventoryName, servedNrCells)
62 err := w.sdl.Remove(cellKeysToRemove)
65 return common.NewInternalError(err)
72 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
74 func (w *rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *entities.NodebInfo) error {
75 isNotEmptyIdentity := isNotEmpty(nbIdentity)
77 if isNotEmptyIdentity && entity.GetNodeType() == entities.Node_UNKNOWN {
78 return common.NewValidationError(fmt.Sprintf("#rNibWriter.saveNodeB - Unknown responding node type, entity: %v", entity))
80 data, err := proto.Marshal(entity)
82 return common.NewInternalError(err)
84 var pairs []interface{}
85 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nbIdentity.InventoryName)
89 pairs = append(pairs, key, data)
91 if isNotEmptyIdentity {
92 key, rNibErr = common.ValidateAndBuildNodeBIdKey(entity.GetNodeType().String(), nbIdentity.GlobalNbId.GetPlmnId(), nbIdentity.GlobalNbId.GetNbId())
96 pairs = append(pairs, key, data)
99 if entity.GetEnb() != nil {
100 pairs, rNibErr = appendEnbCells(nbIdentity.InventoryName, entity.GetEnb().GetServedCells(), pairs)
105 if entity.GetGnb() != nil {
106 pairs, rNibErr = appendGnbCells(nbIdentity.InventoryName, entity.GetGnb().GetServedNrCells(), pairs)
111 err = w.sdl.Set(pairs)
113 return common.NewInternalError(err)
116 ranNameIdentity := &entities.NbIdentity{InventoryName: nbIdentity.InventoryName}
118 if isNotEmptyIdentity {
119 nbIdData, err := proto.Marshal(ranNameIdentity)
121 return common.NewInternalError(err)
123 err = w.sdl.RemoveMember(entities.Node_UNKNOWN.String(), nbIdData)
125 return common.NewInternalError(err)
128 nbIdentity = ranNameIdentity
131 nbIdData, err := proto.Marshal(nbIdentity)
133 return common.NewInternalError(err)
135 err = w.sdl.AddMember(entity.GetNodeType().String(), nbIdData)
137 return common.NewInternalError(err)
142 func (w *rNibWriterInstance) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
144 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
150 pairs, err = appendGnbCells(nodebInfo.RanName, servedNrCells, pairs)
156 err = w.sdl.Set(pairs)
159 return common.NewInternalError(err)
165 func buildCellKeysToRemove(inventoryName string, servedNrCellsToRemove []*entities.ServedNRCell) []string {
167 cellKeysToRemove := []string{}
169 for _, cell := range servedNrCellsToRemove {
171 key, _ := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
174 cellKeysToRemove = append(cellKeysToRemove, key)
177 key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
180 cellKeysToRemove = append(cellKeysToRemove, key)
184 return cellKeysToRemove
187 func buildUpdateNodebInfoPairs(nodebInfo *entities.NodebInfo) ([]interface{}, error) {
188 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
191 return []interface{}{}, rNibErr
194 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
196 data, err := proto.Marshal(nodebInfo)
199 return []interface{}{}, common.NewInternalError(err)
202 pairs := []interface{}{nodebNameKey, data}
204 if buildNodebIdKeyError == nil {
205 pairs = append(pairs, nodebIdKey, data)
214 func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
216 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
222 err = w.sdl.Set(pairs)
225 return common.NewInternalError(err)
232 SaveRanLoadInformation stores ran load information for the provided ran
234 func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
236 key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
242 data, err := proto.Marshal(ranLoadInformation)
245 return common.NewInternalError(err)
248 var pairs []interface{}
249 pairs = append(pairs, key, data)
251 err = w.sdl.Set(pairs)
254 return common.NewInternalError(err)
260 func (w *rNibWriterInstance) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
262 key, rnibErr := common.ValidateAndBuildE2TInstanceKey(e2tInstance.Address)
268 data, err := json.Marshal(e2tInstance)
271 return common.NewInternalError(err)
274 var pairs []interface{}
275 pairs = append(pairs, key, data)
277 err = w.sdl.Set(pairs)
280 return common.NewInternalError(err)
286 func (w *rNibWriterInstance) SaveE2TAddresses(addresses []string) error {
288 data, err := json.Marshal(addresses)
291 return common.NewInternalError(err)
294 var pairs []interface{}
295 pairs = append(pairs, E2TAddressesKey, data)
297 err = w.sdl.Set(pairs)
300 return common.NewInternalError(err)
306 func (w *rNibWriterInstance) RemoveE2TInstance(address string) error {
307 key, rNibErr := common.ValidateAndBuildE2TInstanceKey(address)
311 err := w.sdl.Remove([]string{key})
314 return common.NewInternalError(err)
320 UpdateNodebConnectivityState...
322 func (w *rNibWriterInstance) UpdateNodebConnectivityState(nodebInfo *entities.NodebInfo, stateChangeMessageChannel string, event string) error {
324 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
330 err = w.sdl.SetAndPublish([]string{stateChangeMessageChannel, event}, pairs)
333 return common.NewInternalError(err)
346 func appendEnbCells(inventoryName string, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
347 for _, cell := range cells {
348 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
349 cellData, err := proto.Marshal(&cellEntity)
351 return pairs, common.NewInternalError(err)
353 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
355 return pairs, rNibErr
357 pairs = append(pairs, key, cellData)
358 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
360 return pairs, rNibErr
362 pairs = append(pairs, key, cellData)
367 func appendGnbCells(inventoryName string, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
368 for _, cell := range cells {
369 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
370 cellData, err := proto.Marshal(&cellEntity)
372 return pairs, common.NewInternalError(err)
374 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
376 return pairs, rNibErr
378 pairs = append(pairs, key, cellData)
379 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
381 return pairs, rNibErr
383 pairs = append(pairs, key, cellData)
388 func isNotEmpty(nbIdentity *entities.NbIdentity) bool {
389 return nbIdentity.GlobalNbId != nil && nbIdentity.GlobalNbId.PlmnId != "" && nbIdentity.GlobalNbId.NbId != ""