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 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/reader"
33 type RNibDataService interface {
34 SaveNodeb(nodebInfo *entities.NodebInfo) error
35 UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
36 UpdateNodebInfoAndPublish(nodebInfo *entities.NodebInfo) error
37 SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
38 GetNodeb(ranName string) (*entities.NodebInfo, error)
39 GetListNodebIds() ([]*entities.NbIdentity, error)
41 GetE2TInstance(address string) (*entities.E2TInstance, error)
42 GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error)
43 GetE2TAddresses() ([]string, error)
44 SaveE2TInstance(e2tInstance *entities.E2TInstance) error
45 SaveE2TAddresses(addresses []string) error
46 GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error)
47 GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error)
48 SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error
49 GetE2TAddressesNoLogs() ([]string, error)
50 RemoveE2TInstance(e2tAddress string) error
51 UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error
52 RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error
53 GetGeneralConfiguration() (*entities.GeneralConfiguration, error)
54 UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event string) error
55 SaveGeneralConfiguration(config *entities.GeneralConfiguration) error
56 RemoveEnb(nodebInfo *entities.NodebInfo) error
57 RemoveServedCells(inventoryName string, servedCells []*entities.ServedCellInfo) error
58 UpdateEnb(nodebInfo *entities.NodebInfo, servedCells []*entities.ServedCellInfo) error
59 AddNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error
60 RemoveNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error
61 AddEnb(nodebInfo *entities.NodebInfo) error
64 type rNibDataService struct {
66 rnibReader reader.RNibReader
67 rnibWriter rNibWriter.RNibWriter
69 retryInterval time.Duration
72 func NewRnibDataService(logger *logger.Logger, config *configuration.Configuration, rnibReader reader.RNibReader, rnibWriter rNibWriter.RNibWriter) *rNibDataService {
73 return &rNibDataService{
75 rnibReader: rnibReader,
76 rnibWriter: rnibWriter,
77 maxAttempts: config.MaxRnibConnectionAttempts,
78 retryInterval: time.Duration(config.RnibRetryIntervalMs) * time.Millisecond,
82 func (w *rNibDataService) AddNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error {
83 w.logger.Infof("#RnibDataService.AddNbIdentity - nbIdentity: %s", nbIdentity)
85 err := w.retry("AddNbIdentity", func() (err error) {
86 err = w.rnibWriter.AddNbIdentity(nodeType, nbIdentity)
93 func (w *rNibDataService) RemoveNbIdentity(nodeType entities.Node_Type, nbIdentity *entities.NbIdentity) error{
94 w.logger.Infof("#RnibDataService.RemoveNbIdentity - nbIdentity: %s", nbIdentity)
96 err := w.retry("RemoveNbIdentity", func() (err error) {
97 err = w.rnibWriter.RemoveNbIdentity(nodeType, nbIdentity)
104 func (w *rNibDataService) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
105 err := w.retry("RemoveServedNrCells", func() (err error) {
106 err = w.rnibWriter.RemoveServedNrCells(inventoryName, servedNrCells)
113 func (w *rNibDataService) RemoveEnb(nodebInfo *entities.NodebInfo) error {
114 w.logger.Infof("#RnibDataService.RemoveEnb - nodebInfo: %s", nodebInfo)
116 err := w.retry("RemoveEnb", func() (err error) {
117 err = w.rnibWriter.RemoveEnb(nodebInfo)
124 func (w *rNibDataService) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
125 w.logger.Infof("#RnibDataService.UpdateGnbCells - nodebInfo: %s, servedNrCells: %s", nodebInfo, servedNrCells)
127 err := w.retry("UpdateGnbCells", func() (err error) {
128 err = w.rnibWriter.UpdateGnbCells(nodebInfo, servedNrCells)
135 func (w *rNibDataService) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
136 w.logger.Infof("#RnibDataService.UpdateNodebInfo - nodebInfo: %s", nodebInfo)
138 err := w.retry("UpdateNodebInfo", func() (err error) {
139 err = w.rnibWriter.UpdateNodebInfo(nodebInfo)
146 func (w *rNibDataService) UpdateNodebInfoAndPublish(nodebInfo *entities.NodebInfo) error {
147 w.logger.Infof("#RnibDataService.UpdateNodebInfoAndPublish - nodebInfo: %s", nodebInfo)
149 err := w.retry("UpdateNodebInfoAndPublish", func() (err error) {
150 err = w.rnibWriter.UpdateNodebInfoAndPublish(nodebInfo)
157 func (w *rNibDataService) SaveNodeb(nodebInfo *entities.NodebInfo) error {
158 w.logger.Infof("#RnibDataService.SaveNodeb - nodebInfo: %s", nodebInfo)
160 err := w.retry("SaveNodeb", func() (err error) {
161 err = w.rnibWriter.SaveNodeb(nodebInfo)
168 func (w *rNibDataService) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
169 w.logger.Infof("#RnibDataService.SaveRanLoadInformation - inventoryName: %s, ranLoadInformation: %s", inventoryName, ranLoadInformation)
171 err := w.retry("SaveRanLoadInformation", func() (err error) {
172 err = w.rnibWriter.SaveRanLoadInformation(inventoryName, ranLoadInformation)
179 func (w *rNibDataService) GetNodeb(ranName string) (*entities.NodebInfo, error) {
181 var nodeb *entities.NodebInfo = nil
183 err := w.retry("GetNodeb", func() (err error) {
184 nodeb, err = w.rnibReader.GetNodeb(ranName)
189 w.logger.Infof("#RnibDataService.GetNodeb - RAN name: %s, connection status: %s, associated E2T: %s", nodeb.RanName, nodeb.ConnectionStatus, nodeb.AssociatedE2TInstanceAddress)
195 func (w *rNibDataService) GetListNodebIds() ([]*entities.NbIdentity, error) {
196 var nodeIds []*entities.NbIdentity = nil
198 err := w.retry("GetListNodebIds", func() (err error) {
199 nodeIds, err = w.rnibReader.GetListNodebIds()
204 w.logger.Infof("#RnibDataService.GetListNodebIds - RANs count: %d", len(nodeIds))
210 func (w *rNibDataService) GetE2TInstance(address string) (*entities.E2TInstance, error) {
211 var e2tInstance *entities.E2TInstance = nil
213 err := w.retry("GetE2TInstance", func() (err error) {
214 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
219 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)
222 return e2tInstance, err
225 func (w *rNibDataService) GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error) {
226 var e2tInstance *entities.E2TInstance = nil
228 err := w.retry("GetE2TInstance", func() (err error) {
229 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
233 return e2tInstance, err
236 func (w *rNibDataService) GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error) {
237 w.logger.Infof("#RnibDataService.GetE2TInstances - addresses: %s", addresses)
238 var e2tInstances []*entities.E2TInstance = nil
240 err := w.retry("GetE2TInstance", func() (err error) {
241 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
245 return e2tInstances, err
248 func (w *rNibDataService) GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error) {
250 var e2tInstances []*entities.E2TInstance = nil
252 err := w.retry("GetE2TInstance", func() (err error) {
253 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
257 return e2tInstances, err
260 func (w *rNibDataService) GetE2TAddresses() ([]string, error) {
262 var e2tAddresses []string = nil
264 err := w.retry("GetE2TAddresses", func() (err error) {
265 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
270 w.logger.Infof("#RnibDataService.GetE2TAddresses - addresses: %s", e2tAddresses)
273 return e2tAddresses, err
276 func (w *rNibDataService) GetE2TAddressesNoLogs() ([]string, error) {
278 var e2tAddresses []string = nil
280 err := w.retry("GetE2TAddresses", func() (err error) {
281 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
285 return e2tAddresses, err
288 func (w *rNibDataService) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
289 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)
291 return w.SaveE2TInstanceNoLogs(e2tInstance)
294 func (w *rNibDataService) SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error {
296 err := w.retry("SaveE2TInstance", func() (err error) {
297 err = w.rnibWriter.SaveE2TInstance(e2tInstance)
304 func (w *rNibDataService) SaveE2TAddresses(addresses []string) error {
305 w.logger.Infof("#RnibDataService.SaveE2TAddresses - addresses: %s", addresses)
307 err := w.retry("SaveE2TAddresses", func() (err error) {
308 err = w.rnibWriter.SaveE2TAddresses(addresses)
315 func (w *rNibDataService) RemoveE2TInstance(e2tAddress string) error {
316 w.logger.Infof("#RnibDataService.RemoveE2TInstance - e2tAddress: %s", e2tAddress)
318 err := w.retry("RemoveE2TInstance", func() (err error) {
319 err = w.rnibWriter.RemoveE2TInstance(e2tAddress)
326 func (w *rNibDataService) GetGeneralConfiguration() (*entities.GeneralConfiguration, error) {
327 var generalConfiguration *entities.GeneralConfiguration = nil
329 err := w.retry("GetGeneralConfiguration", func() (err error) {
330 generalConfiguration, err = w.rnibReader.GetGeneralConfiguration()
334 return generalConfiguration, err
337 func (w *rNibDataService) SaveGeneralConfiguration(config *entities.GeneralConfiguration) error {
338 err := w.retry("SaveGeneralConfiguration", func() (err error) {
339 err = w.rnibWriter.SaveGeneralConfiguration(config)
346 func (w *rNibDataService) RemoveServedCells(inventoryName string, servedCells []*entities.ServedCellInfo) error {
347 err := w.retry("RemoveServedCells", func() (err error) {
348 err = w.rnibWriter.RemoveServedCells(inventoryName, servedCells)
355 func (w *rNibDataService) UpdateEnb(nodebInfo *entities.NodebInfo, servedCells []*entities.ServedCellInfo) error {
356 err := w.retry("UpdateEnb", func() (err error) {
357 err = w.rnibWriter.UpdateEnb(nodebInfo, servedCells)
364 func (w *rNibDataService) PingRnib() bool {
365 err := w.retry("GetListNodebIds", func() (err error) {
366 _, err = w.rnibReader.GetListNodebIds()
370 return !isRnibConnectionError(err)
373 func (w *rNibDataService) UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event string) error {
374 w.logger.Infof("#RnibDataService.UpdateNodebInfoOnConnectionStatusInversion - event: %s, nodebInfo: %s", event, nodebInfo)
376 err := w.retry("UpdateNodebInfoOnConnectionStatusInversion", func() (err error) {
377 err = w.rnibWriter.UpdateNodebInfoOnConnectionStatusInversion(nodebInfo, event)
384 func (w *rNibDataService) AddEnb(nodebInfo *entities.NodebInfo) error {
385 w.logger.Infof("#RnibDataService.AddEnb - nodebInfo: %s", nodebInfo)
387 err := w.retry("AddEnb", func() (err error) {
388 err = w.rnibWriter.AddEnb(nodebInfo)
395 func (w *rNibDataService) retry(rnibFunc string, f func() error) (err error) {
396 attempts := w.maxAttempts
403 if !isRnibConnectionError(err) {
407 w.logger.Errorf("#RnibDataService.retry - after %d attempts of %s, last error: %s", attempts, rnibFunc, err)
410 time.Sleep(w.retryInterval)
412 w.logger.Infof("#RnibDataService.retry - retrying %d %s after error: %s", i, rnibFunc, err)
416 func isRnibConnectionError(err error) bool {
417 internalErr, ok := err.(*common.InternalError)
421 _, ok = internalErr.Err.(*net.OpError)