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.
21 "e2mgr/e2managererrors"
29 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
33 type RanSetupManager struct {
35 rnibWriterProvider func() rNibWriter.RNibWriter
36 rmrService *services.RmrService
39 func NewRanSetupManager(logger *logger.Logger, rmrService *services.RmrService, rnibWriterProvider func() rNibWriter.RNibWriter) *RanSetupManager {
40 return &RanSetupManager{
42 rnibWriterProvider: rnibWriterProvider,
43 rmrService: rmrService,
47 // Update retries and connection status
48 func (m *RanSetupManager) updateConnectionStatus(nodebInfo *entities.NodebInfo, status entities.ConnectionStatus) error {
49 // Update retries and connection status
50 nodebInfo.ConnectionStatus = status
51 nodebInfo.ConnectionAttempts++
52 err := m.rnibWriterProvider().UpdateNodebInfo(nodebInfo)
54 m.logger.Errorf("#RanSetupManager.updateConnectionStatus - Ran name: %s - Failed updating RAN's connection status to %v : %s", nodebInfo.RanName, status.String(), err)
56 m.logger.Infof("#RanSetupManager.updateConnectionStatus - Ran name: %s - Successfully updated rNib. RAN's current connection status: %v, RAN's current connection attempts: %d", nodebInfo.RanName, status.String(), nodebInfo.ConnectionAttempts)
61 // Decrement retries and connection status (disconnected)
62 func (m *RanSetupManager) updateConnectionStatusDisconnected(nodebInfo *entities.NodebInfo) error {
63 // Update retries and connection status
64 nodebInfo.ConnectionStatus = entities.ConnectionStatus_DISCONNECTED
65 nodebInfo.ConnectionAttempts--
66 err := m.rnibWriterProvider().UpdateNodebInfo(nodebInfo)
68 m.logger.Errorf("#RanSetupManager.updateConnectionStatusDisconnected - Ran name: %s - Failed updating RAN's connection status to DISCONNECTED : %s", nodebInfo.RanName, err)
70 m.logger.Infof("#RanSetupManager.updateConnectionStatusDisconnected - Ran name: %s - Successfully updated rNib. RAN's current connection status: DISCONNECTED, RAN's current connection attempts: %d", nodebInfo.RanName, nodebInfo.ConnectionAttempts)
75 func (m *RanSetupManager) prepareSetupRequest(nodebInfo *entities.NodebInfo) (int, *models.E2RequestMessage, error) {
76 // Build the endc/x2 setup request
77 switch nodebInfo.E2ApplicationProtocol {
78 case entities.E2ApplicationProtocol_X2_SETUP_REQUEST:
79 rmrMsgType := rmrCgo.RIC_X2_SETUP_REQ
80 request := models.NewE2RequestMessage(nodebInfo.RanName /*tid*/, nodebInfo.Ip, uint16(nodebInfo.Port), nodebInfo.RanName, e2pdus.PackedX2setupRequest)
81 return rmrMsgType, request, nil
82 case entities.E2ApplicationProtocol_ENDC_X2_SETUP_REQUEST:
83 rmrMsgType := rmrCgo.RIC_ENDC_X2_SETUP_REQ
84 request := models.NewE2RequestMessage(nodebInfo.RanName /*tid*/, nodebInfo.Ip, uint16(nodebInfo.Port), nodebInfo.RanName, e2pdus.PackedEndcX2setupRequest)
85 return rmrMsgType, request, nil
88 m.logger.Errorf("#RanSetupManager.prepareSetupRequest - Unsupported nodebInfo.E2ApplicationProtocol %d ", nodebInfo.E2ApplicationProtocol)
89 return 0, nil, e2managererrors.NewInternalError()
92 // ExecuteSetup updates the connection status and number of attempts in the nodebInfo and send an endc/x2 setup request to establish a connection with the RAN
93 func (m *RanSetupManager) ExecuteSetup(nodebInfo *entities.NodebInfo, status entities.ConnectionStatus) error {
95 //Fill details for the response handler
96 requestDetails := models.SetupRequest{RanName: nodebInfo.RanName, RanPort: uint16(nodebInfo.Port), RanIp: nodebInfo.Ip}
97 m.rmrService.E2sessions[nodebInfo.RanName] = sessions.E2SessionDetails{SessionStart: time.Now(), Request: &requestDetails}
99 // Update retries and connection status
100 if err := m.updateConnectionStatus(nodebInfo, status); err != nil {
101 delete(m.rmrService.E2sessions, nodebInfo.RanName)
102 return e2managererrors.NewRnibDbError()
105 // Build the endc/x2 setup request
106 rmrMsgType, request, err := m.prepareSetupRequest(nodebInfo)
108 delete(m.rmrService.E2sessions, nodebInfo.RanName)
112 // Send the endc/x2 setup request
113 response := &models.NotificationResponse{MgsType: rmrMsgType, RanName: nodebInfo.RanName, Payload: request.GetMessageAsBytes(m.logger)}
114 if err := m.rmrService.SendRmrMessage(response); err != nil {
115 m.logger.Errorf("#RanSetupManager.ExecuteSetup - failed sending setup request to RMR: %s", err)
117 delete(m.rmrService.E2sessions, nodebInfo.RanName)
119 // Decrement retries and connection status (disconnected)
120 if err := m.updateConnectionStatusDisconnected(nodebInfo); err != nil {
121 return e2managererrors.NewRnibDbError()
124 return e2managererrors.NewRmrError()