2 // Copyright 2019 AT&T Intellectual Property
3 // Copyright 2019 Nokia
4 // Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.
6 // Licensed under the Apache License, Version 2.0 (the "License");
7 // you may not use this file except in compliance with the License.
8 // You may obtain a copy of the License at
10 // http://www.apache.org/licenses/LICENSE-2.0
12 // Unless required by applicable law or agreed to in writing, software
13 // distributed under the License is distributed on an "AS IS" BASIS,
14 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 // See the License for the specific language governing permissions and
16 // limitations under the License.
18 // This source code is part of the near-RT RIC (RAN Intelligent Controller)
19 // platform project (RICP).
27 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
28 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
29 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/reader"
34 type RNibDataService interface {
35 SaveNodeb(nodebInfo *entities.NodebInfo) error
36 UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
37 UpdateNodebInfoAndPublish(nodebInfo *entities.NodebInfo) error
38 SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
39 GetNodeb(ranName string) (*entities.NodebInfo, error)
40 GetListNodebIds() ([]*entities.NbIdentity, error)
42 GetE2TInstance(address string) (*entities.E2TInstance, error)
43 GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error)
44 GetE2TAddresses() ([]string, error)
45 SaveE2TInstance(e2tInstance *entities.E2TInstance) error
46 SaveE2TAddresses(addresses []string) error
47 GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error)
48 GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error)
49 SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error
50 GetE2TAddressesNoLogs() ([]string, error)
51 RemoveE2TInstance(e2tAddress string) error
52 UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error
53 RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error
54 GetGeneralConfiguration() (*entities.GeneralConfiguration, error)
55 UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event 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
62 AddEnb(nodebInfo *entities.NodebInfo) error
63 UpdateNbIdentity(nodeType entities.Node_Type, oldNbIdentities *entities.NbIdentity, newNbIdentities *entities.NbIdentity) error
64 UpdateNbIdentities(nodeType entities.Node_Type, oldNbIdentities []*entities.NbIdentity, newNbIdentities []*entities.NbIdentity) error
67 type rNibDataService struct {
69 rnibReader reader.RNibReader
70 rnibWriter rNibWriter.RNibWriter
72 retryInterval time.Duration
75 func NewRnibDataService(logger *logger.Logger, config *configuration.Configuration, rnibReader reader.RNibReader, rnibWriter rNibWriter.RNibWriter) *rNibDataService {
76 return &rNibDataService{
78 rnibReader: rnibReader,
79 rnibWriter: rnibWriter,
80 maxAttempts: config.MaxRnibConnectionAttempts,
81 retryInterval: time.Duration(config.RnibRetryIntervalMs) * time.Millisecond,
85 func (w *rNibDataService) AddNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error {
86 w.logger.Infof("#RnibDataService.AddNbIdentity - nbIdentity: %s", nbIdentity)
88 err := w.retry("AddNbIdentity", func() (err error) {
89 err = w.rnibWriter.AddNbIdentity(nodeType, nbIdentity)
96 func (w *rNibDataService) RemoveNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error{
97 w.logger.Infof("#RnibDataService.RemoveNbIdentity - nbIdentity: %s", nbIdentity)
99 err := w.retry("RemoveNbIdentity", func() (err error) {
100 err = w.rnibWriter.RemoveNbIdentity(nodeType, nbIdentity)
107 func (w *rNibDataService) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
108 err := w.retry("RemoveServedNrCells", func() (err error) {
109 err = w.rnibWriter.RemoveServedNrCells(inventoryName, servedNrCells)
116 func (w *rNibDataService) RemoveEnb(nodebInfo *entities.NodebInfo) error {
117 w.logger.Infof("#RnibDataService.RemoveEnb - nodebInfo: %s", nodebInfo)
119 err := w.retry("RemoveEnb", func() (err error) {
120 err = w.rnibWriter.RemoveEnb(nodebInfo)
127 func (w *rNibDataService) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
128 w.logger.Infof("#RnibDataService.UpdateGnbCells - nodebInfo: %s, servedNrCells: %s", nodebInfo, servedNrCells)
130 err := w.retry("UpdateGnbCells", func() (err error) {
131 err = w.rnibWriter.UpdateGnbCells(nodebInfo, servedNrCells)
138 func (w *rNibDataService) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
139 w.logger.Infof("#RnibDataService.UpdateNodebInfo - nodebInfo: %s", nodebInfo)
141 err := w.retry("UpdateNodebInfo", func() (err error) {
142 err = w.rnibWriter.UpdateNodebInfo(nodebInfo)
149 func (w *rNibDataService) UpdateNodebInfoAndPublish(nodebInfo *entities.NodebInfo) error {
150 w.logger.Infof("#RnibDataService.UpdateNodebInfoAndPublish - nodebInfo: %s", nodebInfo)
152 err := w.retry("UpdateNodebInfoAndPublish", func() (err error) {
153 err = w.rnibWriter.UpdateNodebInfoAndPublish(nodebInfo)
160 func (w *rNibDataService) SaveNodeb(nodebInfo *entities.NodebInfo) error {
161 w.logger.Infof("#RnibDataService.SaveNodeb - nodebInfo: %s", nodebInfo)
163 err := w.retry("SaveNodeb", func() (err error) {
164 err = w.rnibWriter.SaveNodeb(nodebInfo)
171 func (w *rNibDataService) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
172 w.logger.Infof("#RnibDataService.SaveRanLoadInformation - inventoryName: %s, ranLoadInformation: %s", inventoryName, ranLoadInformation)
174 err := w.retry("SaveRanLoadInformation", func() (err error) {
175 err = w.rnibWriter.SaveRanLoadInformation(inventoryName, ranLoadInformation)
182 func (w *rNibDataService) GetNodeb(ranName string) (*entities.NodebInfo, error) {
184 var nodeb *entities.NodebInfo = nil
186 err := w.retry("GetNodeb", func() (err error) {
187 nodeb, err = w.rnibReader.GetNodeb(ranName)
192 w.logger.Infof("#RnibDataService.GetNodeb - RAN name: %s, connection status: %s, associated E2T: %s, setup from network: %t", nodeb.RanName, nodeb.ConnectionStatus, nodeb.AssociatedE2TInstanceAddress, nodeb.SetupFromNetwork)
198 func (w *rNibDataService) GetListNodebIds() ([]*entities.NbIdentity, error) {
199 var nodeIds []*entities.NbIdentity = nil
201 err := w.retry("GetListNodebIds", func() (err error) {
202 nodeIds, err = w.rnibReader.GetListNodebIds()
207 w.logger.Infof("#RnibDataService.GetListNodebIds - RANs count: %d", len(nodeIds))
213 func (w *rNibDataService) GetE2TInstance(address string) (*entities.E2TInstance, error) {
214 var e2tInstance *entities.E2TInstance = nil
216 err := w.retry("GetE2TInstance", func() (err error) {
217 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
222 w.logger.Infof("#RnibDataService.GetE2TInstance - E2T instance address: %s, state: %s, associated RANs count: %d, keep Alive ts: %d", e2tInstance.Address, e2tInstance.State, len(e2tInstance.AssociatedRanList), e2tInstance.KeepAliveTimestamp)
225 return e2tInstance, err
228 func (w *rNibDataService) GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error) {
229 var e2tInstance *entities.E2TInstance = nil
231 err := w.retry("GetE2TInstance", func() (err error) {
232 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
236 return e2tInstance, err
239 func (w *rNibDataService) GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error) {
240 w.logger.Infof("#RnibDataService.GetE2TInstances - addresses: %s", addresses)
241 var e2tInstances []*entities.E2TInstance = nil
243 err := w.retry("GetE2TInstance", func() (err error) {
244 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
248 return e2tInstances, err
251 func (w *rNibDataService) GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error) {
253 var e2tInstances []*entities.E2TInstance = nil
255 err := w.retry("GetE2TInstance", func() (err error) {
256 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
260 return e2tInstances, err
263 func (w *rNibDataService) GetE2TAddresses() ([]string, error) {
265 var e2tAddresses []string = nil
267 err := w.retry("GetE2TAddresses", func() (err error) {
268 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
273 w.logger.Infof("#RnibDataService.GetE2TAddresses - addresses: %s", e2tAddresses)
276 return e2tAddresses, err
279 func (w *rNibDataService) GetE2TAddressesNoLogs() ([]string, error) {
281 var e2tAddresses []string = nil
283 err := w.retry("GetE2TAddresses", func() (err error) {
284 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
288 return e2tAddresses, err
291 func (w *rNibDataService) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
292 w.logger.Infof("#RnibDataService.SaveE2TInstance - E2T instance address: %s, podName: %s, state: %s, associated RANs count: %d, keep Alive ts: %d", e2tInstance.Address, e2tInstance.PodName, e2tInstance.State, len(e2tInstance.AssociatedRanList), e2tInstance.KeepAliveTimestamp)
294 return w.SaveE2TInstanceNoLogs(e2tInstance)
297 func (w *rNibDataService) SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error {
299 err := w.retry("SaveE2TInstance", func() (err error) {
300 err = w.rnibWriter.SaveE2TInstance(e2tInstance)
307 func (w *rNibDataService) SaveE2TAddresses(addresses []string) error {
308 w.logger.Infof("#RnibDataService.SaveE2TAddresses - addresses: %s", addresses)
310 err := w.retry("SaveE2TAddresses", func() (err error) {
311 err = w.rnibWriter.SaveE2TAddresses(addresses)
318 func (w *rNibDataService) RemoveE2TInstance(e2tAddress string) error {
319 w.logger.Infof("#RnibDataService.RemoveE2TInstance - e2tAddress: %s", e2tAddress)
321 err := w.retry("RemoveE2TInstance", func() (err error) {
322 err = w.rnibWriter.RemoveE2TInstance(e2tAddress)
329 func (w *rNibDataService) GetGeneralConfiguration() (*entities.GeneralConfiguration, error) {
330 var generalConfiguration *entities.GeneralConfiguration = nil
332 err := w.retry("GetGeneralConfiguration", func() (err error) {
333 generalConfiguration, err = w.rnibReader.GetGeneralConfiguration()
337 return generalConfiguration, err
340 func (w *rNibDataService) SaveGeneralConfiguration(config *entities.GeneralConfiguration) error {
341 err := w.retry("SaveGeneralConfiguration", func() (err error) {
342 err = w.rnibWriter.SaveGeneralConfiguration(config)
349 func (w *rNibDataService) RemoveServedCells(inventoryName string, servedCells []*entities.ServedCellInfo) error {
350 err := w.retry("RemoveServedCells", func() (err error) {
351 err = w.rnibWriter.RemoveServedCells(inventoryName, servedCells)
358 func (w *rNibDataService) UpdateEnb(nodebInfo *entities.NodebInfo, servedCells []*entities.ServedCellInfo) error {
359 err := w.retry("UpdateEnb", func() (err error) {
360 err = w.rnibWriter.UpdateEnb(nodebInfo, servedCells)
367 func (w *rNibDataService) PingRnib() bool {
368 err := w.retry("GetListNodebIds", func() (err error) {
369 _, err = w.rnibReader.GetListNodebIds()
373 return !isRnibConnectionError(err)
376 func (w *rNibDataService) UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event string) error {
377 w.logger.Infof("#RnibDataService.UpdateNodebInfoOnConnectionStatusInversion - event: %s, nodebInfo: %s", event, nodebInfo)
379 err := w.retry("UpdateNodebInfoOnConnectionStatusInversion", func() (err error) {
380 err = w.rnibWriter.UpdateNodebInfoOnConnectionStatusInversion(nodebInfo, event)
387 func (w *rNibDataService) AddEnb(nodebInfo *entities.NodebInfo) error {
388 w.logger.Infof("#RnibDataService.AddEnb - nodebInfo: %s", nodebInfo)
390 err := w.retry("AddEnb", func() (err error) {
391 err = w.rnibWriter.AddEnb(nodebInfo)
398 func (w *rNibDataService) UpdateNbIdentity(nodeType entities.Node_Type, oldNbIdentity *entities.NbIdentity, newNbIdentity *entities.NbIdentity) error {
399 err := w.retry("UpdateNbIdentities", func() (err error) {
400 err = w.rnibWriter.UpdateNbIdentities(nodeType, []*entities.NbIdentity{oldNbIdentity}, []*entities.NbIdentity{newNbIdentity})
407 func (w *rNibDataService) UpdateNbIdentities(nodeType entities.Node_Type, oldNbIdentities []*entities.NbIdentity, newNbIdentities []*entities.NbIdentity) error {
408 err := w.retry("UpdateNbIdentities", func() (err error) {
409 err = w.rnibWriter.UpdateNbIdentities(nodeType, oldNbIdentities, newNbIdentities)
416 func (w *rNibDataService) retry(rnibFunc string, f func() error) (err error) {
417 attempts := w.maxAttempts
424 if !isRnibConnectionError(err) {
428 w.logger.Errorf("#RnibDataService.retry - after %d attempts of %s, last error: %s", attempts, rnibFunc, err)
431 time.Sleep(w.retryInterval)
433 w.logger.Infof("#RnibDataService.retry - retrying %d %s after error: %s", i, rnibFunc, err)
437 func isRnibConnectionError(err error) bool {
438 internalErr, ok := err.(*common.InternalError)
442 _, ok = internalErr.Err.(*net.OpError)