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.
22 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
23 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
24 "gerrit.o-ran-sc.org/r/ric-plt/sdlgo"
25 "github.com/golang/protobuf/proto"
28 var writerPool *common.Pool
30 type rNibWriterInstance struct {
31 sdl *common.ISdlInstance
36 RNibWriter interface allows saving data to the redis DB
38 type RNibWriter interface {
39 SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error
40 UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
41 SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
45 Init initializes the infrastructure required for the RNibWriter instance
47 func Init(namespace string, poolSize int) {
50 var sdlI common.ISdlInstance = sdlgo.NewSdlInstance(namespace, sdlgo.NewDatabase())
51 return &rNibWriterInstance{sdl: &sdlI, namespace: namespace}
53 func(obj interface{}) {
54 (*obj.(*rNibWriterInstance).sdl).Close()
59 InitPool initializes the writer's instances pool
61 func initPool(poolSize int, newObj func() interface{}, destroyObj func(interface{})) {
62 writerPool = common.NewPool(poolSize, newObj, destroyObj)
65 GetRNibWriter returns reference to RNibWriter
67 func GetRNibWriter() RNibWriter {
68 return &rNibWriterInstance{}
71 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
73 func (*rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *entities.NodebInfo) error {
74 w := writerPool.Get().(*rNibWriterInstance)
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 defer writerPool.Put(w)
81 data, err := proto.Marshal(entity)
83 return common.NewInternalError(err)
85 var pairs []interface{}
86 key, rNibErr := common.ValidateAndBuildNodeBNameKey(nbIdentity.InventoryName)
90 pairs = append(pairs, key, data)
92 if isNotEmptyIdentity {
93 key, rNibErr = common.ValidateAndBuildNodeBIdKey(entity.GetNodeType().String(), nbIdentity.GlobalNbId.GetPlmnId(), nbIdentity.GlobalNbId.GetNbId())
97 pairs = append(pairs, key, data)
100 if entity.GetEnb() != nil {
101 pairs, rNibErr = appendEnbCells(nbIdentity, entity.GetEnb().GetServedCells(), pairs)
106 if entity.GetGnb() != nil {
107 pairs, rNibErr = appendGnbCells(nbIdentity, entity.GetGnb().GetServedNrCells(), pairs)
112 err = (*w.sdl).Set(pairs)
114 return common.NewInternalError(err)
117 ranNameIdentity := &entities.NbIdentity{InventoryName: nbIdentity.InventoryName}
119 if isNotEmptyIdentity {
120 nbIdData, err := proto.Marshal(ranNameIdentity)
122 return common.NewInternalError(err)
124 err = (*w.sdl).RemoveMember(entities.Node_UNKNOWN.String(), nbIdData)
126 return common.NewInternalError(err)
129 nbIdentity = ranNameIdentity
132 nbIdData, err := proto.Marshal(nbIdentity)
134 return common.NewInternalError(err)
136 err = (*w.sdl).AddMember(entity.GetNodeType().String(), nbIdData)
138 return common.NewInternalError(err)
146 func (*rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
147 w := writerPool.Get().(*rNibWriterInstance)
148 defer writerPool.Put(w)
150 nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
156 nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
158 data, err := proto.Marshal(nodebInfo)
161 return common.NewInternalError(err)
164 var pairs []interface{}
165 pairs = append(pairs, nodebNameKey, data)
167 if buildNodebIdKeyError == nil {
168 pairs = append(pairs, nodebIdKey, data)
171 err = (*w.sdl).Set(pairs)
174 return common.NewInternalError(err)
181 SaveRanLoadInformation stores ran load information for the provided ran
183 func (*rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
184 w := writerPool.Get().(*rNibWriterInstance)
185 defer writerPool.Put(w)
187 key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
193 data, err := proto.Marshal(ranLoadInformation)
196 return common.NewInternalError(err)
199 var pairs []interface{}
200 pairs = append(pairs, key, data)
202 err = (*w.sdl).Set(pairs)
205 return common.NewInternalError(err)
212 Close closes writer's pool
218 func appendEnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
219 for _, cell := range cells {
220 cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
221 cellData, err := proto.Marshal(&cellEntity)
223 return pairs, common.NewInternalError(err)
225 key, rNibErr := common.ValidateAndBuildCellIdKey(cell.GetCellId())
227 return pairs, rNibErr
229 pairs = append(pairs, key, cellData)
230 key, rNibErr = common.ValidateAndBuildCellNamePciKey(nbIdentity.InventoryName, cell.GetPci())
232 return pairs, rNibErr
234 pairs = append(pairs, key, cellData)
239 func appendGnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
240 for _, cell := range cells {
241 cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
242 cellData, err := proto.Marshal(&cellEntity)
244 return pairs, common.NewInternalError(err)
246 key, rNibErr := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
248 return pairs, rNibErr
250 pairs = append(pairs, key, cellData)
251 key, rNibErr = common.ValidateAndBuildCellNamePciKey(nbIdentity.InventoryName, cell.GetServedNrCellInformation().GetNrPci())
253 return pairs, rNibErr
255 pairs = append(pairs, key, cellData)
260 func isNotEmpty(nbIdentity *entities.NbIdentity) bool {
261 return nbIdentity.GlobalNbId != nil && nbIdentity.GlobalNbId.PlmnId != "" && nbIdentity.GlobalNbId.NbId != ""