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
50 GetRNibWriter returns reference to RNibWriter
53 func GetRNibWriter(sdl common.ISdlInstance) RNibWriter {
54 return &rNibWriterInstance{sdl: sdl}
58 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
60 func (w *rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *entities.NodebInfo) error {
61 isNotEmptyIdentity := isNotEmpty(nbIdentity)
63 if isNotEmptyIdentity && entity.GetNodeType() == entities.Node_UNKNOWN {
64 return common.NewValidationError(fmt.Sprintf("#rNibWriter.saveNodeB - Unknown responding node type, entity: %v", entity))
66 data, err := proto.Marshal(entity)
68 return common.NewInternalError(err)
70 var pairs []interface{}
71 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nbIdentity.InventoryName)
75 pairs = append(pairs, key, data)
77 if isNotEmptyIdentity {
78 key, rNibErr = common.ValidateAndBuildNodeBIdKey(entity.GetNodeType().String(), nbIdentity.GlobalNbId.GetPlmnId(), nbIdentity.GlobalNbId.GetNbId())
82 pairs = append(pairs, key, data)
85 if entity.GetEnb() != nil {
86 pairs, rNibErr = appendEnbCells(nbIdentity.InventoryName, entity.GetEnb().GetServedCells(), pairs)
91 if entity.GetGnb() != nil {
92 pairs, rNibErr = appendGnbCells(nbIdentity.InventoryName, entity.GetGnb().GetServedNrCells(), pairs)
97 err = w.sdl.Set(pairs)
99 return common.NewInternalError(err)
102 ranNameIdentity := &entities.NbIdentity{InventoryName: nbIdentity.InventoryName}
104 if isNotEmptyIdentity {
105 nbIdData, err := proto.Marshal(ranNameIdentity)
107 return common.NewInternalError(err)
109 err = w.sdl.RemoveMember(entities.Node_UNKNOWN.String(), nbIdData)
111 return common.NewInternalError(err)
114 nbIdentity = ranNameIdentity
117 nbIdData, err := proto.Marshal(nbIdentity)
119 return common.NewInternalError(err)
121 err = w.sdl.AddMember(entity.GetNodeType().String(), nbIdData)
123 return common.NewInternalError(err)
128 func (w *rNibWriterInstance) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
130 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
136 pairs, err = appendGnbCells(nodebInfo.RanName, servedNrCells, pairs)
142 err = w.sdl.Set(pairs)
145 return common.NewInternalError(err)
151 func buildUpdateNodebInfoPairs(nodebInfo *entities.NodebInfo) ([]interface{}, error) {
152 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
155 return []interface{}{}, rNibErr
158 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
160 data, err := proto.Marshal(nodebInfo)
163 return []interface{}{}, common.NewInternalError(err)
166 pairs := []interface{}{nodebNameKey, data}
168 if buildNodebIdKeyError == nil {
169 pairs = append(pairs, nodebIdKey, data)
178 func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
180 pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
186 err = w.sdl.Set(pairs)
189 return common.NewInternalError(err)
196 SaveRanLoadInformation stores ran load information for the provided ran
198 func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
200 key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
206 data, err := proto.Marshal(ranLoadInformation)
209 return common.NewInternalError(err)
212 var pairs []interface{}
213 pairs = append(pairs, key, data)
215 err = w.sdl.Set(pairs)
218 return common.NewInternalError(err)
224 func (w *rNibWriterInstance) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
226 key, rnibErr := common.ValidateAndBuildE2TInstanceKey(e2tInstance.Address)
232 data, err := json.Marshal(e2tInstance)
235 return common.NewInternalError(err)
238 var pairs []interface{}
239 pairs = append(pairs, key, data)
241 err = w.sdl.Set(pairs)
244 return common.NewInternalError(err)
250 func (w *rNibWriterInstance) SaveE2TAddresses(addresses []string) error {
252 data, err := json.Marshal(addresses)
255 return common.NewInternalError(err)
258 var pairs []interface{}
259 pairs = append(pairs, E2TAddressesKey, data)
261 err = w.sdl.Set(pairs)
264 return common.NewInternalError(err)
270 func (w *rNibWriterInstance) RemoveE2TInstance(address string) error {
271 key, rNibErr := common.ValidateAndBuildE2TInstanceKey(address)
275 err := w.sdl.Remove([]string{key})
278 return common.NewInternalError(err)
290 func appendEnbCells(inventoryName string, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
291 for _, cell := range cells {
292 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
293 cellData, err := proto.Marshal(&cellEntity)
295 return pairs, common.NewInternalError(err)
297 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
299 return pairs, rNibErr
301 pairs = append(pairs, key, cellData)
302 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
304 return pairs, rNibErr
306 pairs = append(pairs, key, cellData)
311 func appendGnbCells(inventoryName string, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
312 for _, cell := range cells {
313 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
314 cellData, err := proto.Marshal(&cellEntity)
316 return pairs, common.NewInternalError(err)
318 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
320 return pairs, rNibErr
322 pairs = append(pairs, key, cellData)
323 key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
325 return pairs, rNibErr
327 pairs = append(pairs, key, cellData)
332 func isNotEmpty(nbIdentity *entities.NbIdentity) bool {
333 return nbIdentity.GlobalNbId != nil && nbIdentity.GlobalNbId.PlmnId != "" && nbIdentity.GlobalNbId.NbId != ""