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(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error
35 UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
36 SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
37 GetNodeb(ranName string) (*entities.NodebInfo, error)
38 GetListNodebIds() ([]*entities.NbIdentity, error)
40 GetE2TInstance(address string) (*entities.E2TInstance, error)
41 GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error)
42 GetE2TAddresses() ([]string, error)
43 SaveE2TInstance(e2tInstance *entities.E2TInstance) error
44 SaveE2TAddresses(addresses []string) error
45 GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error)
46 GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error)
47 SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error
48 GetE2TAddressesNoLogs() ([]string, error)
49 RemoveE2TInstance(e2tAddress string) error
50 UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error
51 RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error
52 GetGeneralConfiguration() (*entities.GeneralConfiguration, error)
53 UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event string) error
54 SaveGeneralConfiguration(config *entities.GeneralConfiguration) error
57 type rNibDataService struct {
59 rnibReader reader.RNibReader
60 rnibWriter rNibWriter.RNibWriter
62 retryInterval time.Duration
63 stateChangeMessageChannel string
66 func NewRnibDataService(logger *logger.Logger, config *configuration.Configuration, rnibReader reader.RNibReader, rnibWriter rNibWriter.RNibWriter) *rNibDataService {
67 return &rNibDataService{
69 rnibReader: rnibReader,
70 rnibWriter: rnibWriter,
71 maxAttempts: config.MaxRnibConnectionAttempts,
72 retryInterval: time.Duration(config.RnibRetryIntervalMs) * time.Millisecond,
73 stateChangeMessageChannel: config.StateChangeMessageChannel,
77 func (w *rNibDataService) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
78 err := w.retry("RemoveServedNrCells", func() (err error) {
79 err = w.rnibWriter.RemoveServedNrCells(inventoryName, servedNrCells)
86 func (w *rNibDataService) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
87 w.logger.Infof("#RnibDataService.UpdateGnbCells - nodebInfo: %s, servedNrCells: %s", nodebInfo, servedNrCells)
89 err := w.retry("UpdateGnbCells", func() (err error) {
90 err = w.rnibWriter.UpdateGnbCells(nodebInfo, servedNrCells)
97 func (w *rNibDataService) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
98 w.logger.Infof("#RnibDataService.UpdateNodebInfo - nodebInfo: %s", nodebInfo)
100 err := w.retry("UpdateNodebInfo", func() (err error) {
101 err = w.rnibWriter.UpdateNodebInfo(nodebInfo)
108 func (w *rNibDataService) SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error {
109 w.logger.Infof("#RnibDataService.SaveNodeb - nbIdentity: %s, nodebInfo: %s", nbIdentity, nb)
111 err := w.retry("SaveNodeb", func() (err error) {
112 err = w.rnibWriter.SaveNodeb(nbIdentity, nb)
119 func (w *rNibDataService) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
120 w.logger.Infof("#RnibDataService.SaveRanLoadInformation - inventoryName: %s, ranLoadInformation: %s", inventoryName, ranLoadInformation)
122 err := w.retry("SaveRanLoadInformation", func() (err error) {
123 err = w.rnibWriter.SaveRanLoadInformation(inventoryName, ranLoadInformation)
130 func (w *rNibDataService) GetNodeb(ranName string) (*entities.NodebInfo, error) {
132 var nodeb *entities.NodebInfo = nil
134 err := w.retry("GetNodeb", func() (err error) {
135 nodeb, err = w.rnibReader.GetNodeb(ranName)
140 w.logger.Infof("#RnibDataService.GetNodeb - RAN name: %s, connection status: %s, associated E2T: %s", nodeb.RanName, nodeb.ConnectionStatus, nodeb.AssociatedE2TInstanceAddress)
146 func (w *rNibDataService) GetListNodebIds() ([]*entities.NbIdentity, error) {
147 var nodeIds []*entities.NbIdentity = nil
149 err := w.retry("GetListNodebIds", func() (err error) {
150 nodeIds, err = w.rnibReader.GetListNodebIds()
155 w.logger.Infof("#RnibDataService.GetListNodebIds - RANs count: %d", len(nodeIds))
161 func (w *rNibDataService) GetE2TInstance(address string) (*entities.E2TInstance, error) {
162 var e2tInstance *entities.E2TInstance = nil
164 err := w.retry("GetE2TInstance", func() (err error) {
165 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
170 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)
173 return e2tInstance, err
176 func (w *rNibDataService) GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error) {
177 var e2tInstance *entities.E2TInstance = nil
179 err := w.retry("GetE2TInstance", func() (err error) {
180 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
184 return e2tInstance, err
187 func (w *rNibDataService) GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error) {
188 w.logger.Infof("#RnibDataService.GetE2TInstances - addresses: %s", addresses)
189 var e2tInstances []*entities.E2TInstance = nil
191 err := w.retry("GetE2TInstance", func() (err error) {
192 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
196 return e2tInstances, err
199 func (w *rNibDataService) GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error) {
201 var e2tInstances []*entities.E2TInstance = nil
203 err := w.retry("GetE2TInstance", func() (err error) {
204 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
208 return e2tInstances, err
211 func (w *rNibDataService) GetE2TAddresses() ([]string, error) {
213 var e2tAddresses []string = nil
215 err := w.retry("GetE2TAddresses", func() (err error) {
216 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
221 w.logger.Infof("#RnibDataService.GetE2TAddresses - addresses: %s", e2tAddresses)
224 return e2tAddresses, err
227 func (w *rNibDataService) GetE2TAddressesNoLogs() ([]string, error) {
229 var e2tAddresses []string = nil
231 err := w.retry("GetE2TAddresses", func() (err error) {
232 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
236 return e2tAddresses, err
239 func (w *rNibDataService) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
240 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)
242 return w.SaveE2TInstanceNoLogs(e2tInstance)
245 func (w *rNibDataService) SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error {
247 err := w.retry("SaveE2TInstance", func() (err error) {
248 err = w.rnibWriter.SaveE2TInstance(e2tInstance)
255 func (w *rNibDataService) SaveE2TAddresses(addresses []string) error {
256 w.logger.Infof("#RnibDataService.SaveE2TAddresses - addresses: %s", addresses)
258 err := w.retry("SaveE2TAddresses", func() (err error) {
259 err = w.rnibWriter.SaveE2TAddresses(addresses)
266 func (w *rNibDataService) RemoveE2TInstance(e2tAddress string) error {
267 w.logger.Infof("#RnibDataService.RemoveE2TInstance - e2tAddress: %s", e2tAddress)
269 err := w.retry("RemoveE2TInstance", func() (err error) {
270 err = w.rnibWriter.RemoveE2TInstance(e2tAddress)
277 func (w *rNibDataService) GetGeneralConfiguration() (*entities.GeneralConfiguration, error) {
278 var generalConfiguration *entities.GeneralConfiguration = nil
280 err := w.retry("GetGeneralConfiguration", func() (err error) {
281 generalConfiguration, err = w.rnibReader.GetGeneralConfiguration()
286 w.logger.Infof("#RnibDataService.GetGeneralConfiguration - enableRic: %t", generalConfiguration.EnableRic)
289 return generalConfiguration, err
292 func (w *rNibDataService) SaveGeneralConfiguration(config *entities.GeneralConfiguration) error {
293 w.logger.Infof("#RnibDataService.SaveGeneralConfiguration - configuration: %+v", *config)
295 err := w.retry("SaveGeneralConfiguration", func() (err error) {
296 err = w.rnibWriter.SaveGeneralConfiguration(config)
303 func (w *rNibDataService) PingRnib() bool {
304 err := w.retry("GetListNodebIds", func() (err error) {
305 _, err = w.rnibReader.GetListNodebIds()
309 return !isRnibConnectionError(err)
312 func (w *rNibDataService) UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event string) error {
313 w.logger.Infof("#RnibDataService.UpdateNodebInfoOnConnectionStatusInversion - nodebInfo: %s", nodebInfo)
315 err := w.retry("UpdateNodebInfoOnConnectionStatusInversion", func() (err error) {
316 err = w.rnibWriter.UpdateNodebInfoOnConnectionStatusInversion(nodebInfo, w.stateChangeMessageChannel, event)
323 func (w *rNibDataService) retry(rnibFunc string, f func() error) (err error) {
324 attempts := w.maxAttempts
331 if !isRnibConnectionError(err) {
335 w.logger.Errorf("#RnibDataService.retry - after %d attempts of %s, last error: %s", attempts, rnibFunc, err)
338 time.Sleep(w.retryInterval)
340 w.logger.Infof("#RnibDataService.retry - retrying %d %s after error: %s", i, rnibFunc, err)
344 func isRnibConnectionError(err error) bool {
345 internalErr, ok := err.(*common.InternalError)
349 _, ok = internalErr.Err.(*net.OpError)