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"
31 const E2TAddressesKey = "E2TAddresses"
33 type rNibWriterInstance struct {
34 sdl common.ISdlInstance
38 RNibWriter interface allows saving data to the redis DB
40 type RNibWriter interface {
41 SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error
42 UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
43 SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
44 SaveE2TInstance(e2tInstance *entities.E2TInstance) error
45 SaveE2TAddresses(addresses []string) error
49 GetRNibWriter returns reference to RNibWriter
52 func GetRNibWriter(sdl common.ISdlInstance) RNibWriter {
53 return &rNibWriterInstance{sdl: sdl}
57 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
59 func (w *rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *entities.NodebInfo) error {
60 isNotEmptyIdentity := isNotEmpty(nbIdentity)
62 if isNotEmptyIdentity && entity.GetNodeType() == entities.Node_UNKNOWN {
63 return common.NewValidationError(fmt.Sprintf("#rNibWriter.saveNodeB - Unknown responding node type, entity: %v", entity))
65 data, err := proto.Marshal(entity)
67 return common.NewInternalError(err)
69 var pairs []interface{}
70 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nbIdentity.InventoryName)
74 pairs = append(pairs, key, data)
76 if isNotEmptyIdentity {
77 key, rNibErr = common.ValidateAndBuildNodeBIdKey(entity.GetNodeType().String(), nbIdentity.GlobalNbId.GetPlmnId(), nbIdentity.GlobalNbId.GetNbId())
81 pairs = append(pairs, key, data)
84 if entity.GetEnb() != nil {
85 pairs, rNibErr = appendEnbCells(nbIdentity, entity.GetEnb().GetServedCells(), pairs)
90 if entity.GetGnb() != nil {
91 pairs, rNibErr = appendGnbCells(nbIdentity, entity.GetGnb().GetServedNrCells(), pairs)
96 err = w.sdl.Set(pairs)
98 return common.NewInternalError(err)
101 ranNameIdentity := &entities.NbIdentity{InventoryName: nbIdentity.InventoryName}
103 if isNotEmptyIdentity {
104 nbIdData, err := proto.Marshal(ranNameIdentity)
106 return common.NewInternalError(err)
108 err = w.sdl.RemoveMember(entities.Node_UNKNOWN.String(), nbIdData)
110 return common.NewInternalError(err)
113 nbIdentity = ranNameIdentity
116 nbIdData, err := proto.Marshal(nbIdentity)
118 return common.NewInternalError(err)
120 err = w.sdl.AddMember(entity.GetNodeType().String(), nbIdData)
122 return common.NewInternalError(err)
130 func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
132 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
138 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
140 data, err := proto.Marshal(nodebInfo)
143 return common.NewInternalError(err)
146 var pairs []interface{}
147 pairs = append(pairs, nodebNameKey, data)
149 if buildNodebIdKeyError == nil {
150 pairs = append(pairs, nodebIdKey, data)
153 err = w.sdl.Set(pairs)
156 return common.NewInternalError(err)
163 SaveRanLoadInformation stores ran load information for the provided ran
165 func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
167 key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
173 data, err := proto.Marshal(ranLoadInformation)
176 return common.NewInternalError(err)
179 var pairs []interface{}
180 pairs = append(pairs, key, data)
182 err = w.sdl.Set(pairs)
185 return common.NewInternalError(err)
191 func (w *rNibWriterInstance) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
193 key, rnibErr := common.ValidateAndBuildE2TInstanceKey(e2tInstance.Address)
199 data, err := json.Marshal(e2tInstance)
202 return common.NewInternalError(err)
205 var pairs []interface{}
206 pairs = append(pairs, key, data)
208 err = w.sdl.Set(pairs)
211 return common.NewInternalError(err)
217 func (w *rNibWriterInstance) SaveE2TAddresses(addresses []string) error {
219 data, err := json.Marshal(addresses)
222 return common.NewInternalError(err)
225 var pairs []interface{}
226 pairs = append(pairs, E2TAddressesKey, data)
228 err = w.sdl.Set(pairs)
231 return common.NewInternalError(err)
244 func appendEnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
245 for _, cell := range cells {
246 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
247 cellData, err := proto.Marshal(&cellEntity)
249 return pairs, common.NewInternalError(err)
251 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
253 return pairs, rNibErr
255 pairs = append(pairs, key, cellData)
256 key, rNibErr = common.ValidateAndBuildCellNamePciKey(nbIdentity.InventoryName, cell.GetPci())
258 return pairs, rNibErr
260 pairs = append(pairs, key, cellData)
265 func appendGnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
266 for _, cell := range cells {
267 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
268 cellData, err := proto.Marshal(&cellEntity)
270 return pairs, common.NewInternalError(err)
272 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
274 return pairs, rNibErr
276 pairs = append(pairs, key, cellData)
277 key, rNibErr = common.ValidateAndBuildCellNamePciKey(nbIdentity.InventoryName, cell.GetServedNrCellInformation().GetNrPci())
279 return pairs, rNibErr
281 pairs = append(pairs, key, cellData)
286 func isNotEmpty(nbIdentity *entities.NbIdentity) bool {
287 return nbIdentity.GlobalNbId != nil && nbIdentity.GlobalNbId.PlmnId != "" && nbIdentity.GlobalNbId.NbId != ""