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
56 type rNibDataService struct {
58 rnibReader reader.RNibReader
59 rnibWriter rNibWriter.RNibWriter
61 retryInterval time.Duration
62 stateChangeMessageChannel string
65 func NewRnibDataService(logger *logger.Logger, config *configuration.Configuration, rnibReader reader.RNibReader, rnibWriter rNibWriter.RNibWriter) *rNibDataService {
66 return &rNibDataService{
68 rnibReader: rnibReader,
69 rnibWriter: rnibWriter,
70 maxAttempts: config.MaxRnibConnectionAttempts,
71 retryInterval: time.Duration(config.RnibRetryIntervalMs) * time.Millisecond,
72 stateChangeMessageChannel: config.StateChangeMessageChannel,
76 func (w *rNibDataService) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
77 err := w.retry("RemoveServedNrCells", func() (err error) {
78 err = w.rnibWriter.RemoveServedNrCells(inventoryName, servedNrCells)
85 func (w *rNibDataService) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
86 w.logger.Infof("#RnibDataService.UpdateGnbCells - nodebInfo: %s, servedNrCells: %s", nodebInfo, servedNrCells)
88 err := w.retry("UpdateGnbCells", func() (err error) {
89 err = w.rnibWriter.UpdateGnbCells(nodebInfo, servedNrCells)
96 func (w *rNibDataService) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
97 w.logger.Infof("#RnibDataService.UpdateNodebInfo - nodebInfo: %s", nodebInfo)
99 err := w.retry("UpdateNodebInfo", func() (err error) {
100 err = w.rnibWriter.UpdateNodebInfo(nodebInfo)
107 func (w *rNibDataService) SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error {
108 w.logger.Infof("#RnibDataService.SaveNodeb - nbIdentity: %s, nodebInfo: %s", nbIdentity, nb)
110 err := w.retry("SaveNodeb", func() (err error) {
111 err = w.rnibWriter.SaveNodeb(nbIdentity, nb)
118 func (w *rNibDataService) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
119 w.logger.Infof("#RnibDataService.SaveRanLoadInformation - inventoryName: %s, ranLoadInformation: %s", inventoryName, ranLoadInformation)
121 err := w.retry("SaveRanLoadInformation", func() (err error) {
122 err = w.rnibWriter.SaveRanLoadInformation(inventoryName, ranLoadInformation)
129 func (w *rNibDataService) GetNodeb(ranName string) (*entities.NodebInfo, error) {
131 var nodeb *entities.NodebInfo = nil
133 err := w.retry("GetNodeb", func() (err error) {
134 nodeb, err = w.rnibReader.GetNodeb(ranName)
139 w.logger.Infof("#RnibDataService.GetNodeb - RAN name: %s, connection status: %s, associated E2T: %s", nodeb.RanName, nodeb.ConnectionStatus, nodeb.AssociatedE2TInstanceAddress)
145 func (w *rNibDataService) GetListNodebIds() ([]*entities.NbIdentity, error) {
146 var nodeIds []*entities.NbIdentity = nil
148 err := w.retry("GetListNodebIds", func() (err error) {
149 nodeIds, err = w.rnibReader.GetListNodebIds()
154 w.logger.Infof("#RnibDataService.GetListNodebIds - RANs count: %d", len(nodeIds))
160 func (w *rNibDataService) GetE2TInstance(address string) (*entities.E2TInstance, error) {
161 var e2tInstance *entities.E2TInstance = nil
163 err := w.retry("GetE2TInstance", func() (err error) {
164 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
169 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)
172 return e2tInstance, err
175 func (w *rNibDataService) GetE2TInstanceNoLogs(address string) (*entities.E2TInstance, error) {
176 var e2tInstance *entities.E2TInstance = nil
178 err := w.retry("GetE2TInstance", func() (err error) {
179 e2tInstance, err = w.rnibReader.GetE2TInstance(address)
183 return e2tInstance, err
186 func (w *rNibDataService) GetE2TInstances(addresses []string) ([]*entities.E2TInstance, error) {
187 w.logger.Infof("#RnibDataService.GetE2TInstances - addresses: %s", addresses)
188 var e2tInstances []*entities.E2TInstance = nil
190 err := w.retry("GetE2TInstance", func() (err error) {
191 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
195 return e2tInstances, err
198 func (w *rNibDataService) GetE2TInstancesNoLogs(addresses []string) ([]*entities.E2TInstance, error) {
200 var e2tInstances []*entities.E2TInstance = nil
202 err := w.retry("GetE2TInstance", func() (err error) {
203 e2tInstances, err = w.rnibReader.GetE2TInstances(addresses)
207 return e2tInstances, err
210 func (w *rNibDataService) GetE2TAddresses() ([]string, error) {
212 var e2tAddresses []string = nil
214 err := w.retry("GetE2TAddresses", func() (err error) {
215 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
220 w.logger.Infof("#RnibDataService.GetE2TAddresses - addresses: %s", e2tAddresses)
223 return e2tAddresses, err
226 func (w *rNibDataService) GetE2TAddressesNoLogs() ([]string, error) {
228 var e2tAddresses []string = nil
230 err := w.retry("GetE2TAddresses", func() (err error) {
231 e2tAddresses, err = w.rnibReader.GetE2TAddresses()
235 return e2tAddresses, err
238 func (w *rNibDataService) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
239 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)
241 return w.SaveE2TInstanceNoLogs(e2tInstance)
244 func (w *rNibDataService) SaveE2TInstanceNoLogs(e2tInstance *entities.E2TInstance) error {
246 err := w.retry("SaveE2TInstance", func() (err error) {
247 err = w.rnibWriter.SaveE2TInstance(e2tInstance)
254 func (w *rNibDataService) SaveE2TAddresses(addresses []string) error {
255 w.logger.Infof("#RnibDataService.SaveE2TAddresses - addresses: %s", addresses)
257 err := w.retry("SaveE2TAddresses", func() (err error) {
258 err = w.rnibWriter.SaveE2TAddresses(addresses)
265 func (w *rNibDataService) RemoveE2TInstance(e2tAddress string) error {
266 w.logger.Infof("#RnibDataService.RemoveE2TInstance - e2tAddress: %s", e2tAddress)
268 err := w.retry("RemoveE2TInstance", func() (err error) {
269 err = w.rnibWriter.RemoveE2TInstance(e2tAddress)
276 func (w *rNibDataService) GetGeneralConfiguration() (*entities.GeneralConfiguration, error) {
277 var generalConfiguration *entities.GeneralConfiguration = nil
279 err := w.retry("GetGeneralConfiguration", func() (err error) {
280 generalConfiguration, err = w.rnibReader.GetGeneralConfiguration()
285 w.logger.Infof("#RnibDataService.GetGeneralConfiguration - enableRic: %t", generalConfiguration.EnableRic)
288 return generalConfiguration, err
291 func (w *rNibDataService) PingRnib() bool {
292 err := w.retry("GetListNodebIds", func() (err error) {
293 _, err = w.rnibReader.GetListNodebIds()
297 return !isRnibConnectionError(err)
300 func (w *rNibDataService) UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, event string) error {
301 w.logger.Infof("#RnibDataService.UpdateNodebInfoOnConnectionStatusInversion - nodebInfo: %s", nodebInfo)
303 err := w.retry("UpdateNodebInfoOnConnectionStatusInversion", func() (err error) {
304 err = w.rnibWriter.UpdateNodebInfoOnConnectionStatusInversion(nodebInfo, w.stateChangeMessageChannel, event)
311 func (w *rNibDataService) retry(rnibFunc string, f func() error) (err error) {
312 attempts := w.maxAttempts
319 if !isRnibConnectionError(err) {
323 w.logger.Errorf("#RnibDataService.retry - after %d attempts of %s, last error: %s", attempts, rnibFunc, err)
326 time.Sleep(w.retryInterval)
328 w.logger.Infof("#RnibDataService.retry - retrying %d %s after error: %s", i, rnibFunc, err)
332 func isRnibConnectionError(err error) bool {
333 internalErr, ok := err.(*common.InternalError)
337 _, ok = internalErr.Err.(*net.OpError)