blob: 69f37922be427a6f87cb77a615c8c47c001daa1e [file] [log] [blame]
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00001/*
2 * Copyright 2020-present Open Networking Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17//Package adaptercoreonu provides the utility for onu devices, flows and statistics
18package adaptercoreonu
19
20import (
21 "context"
Andrea Campanella6515c582020-10-05 11:25:00 +020022 "fmt"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000023 "time"
24
25 "github.com/looplab/fsm"
26
27 "github.com/opencord/omci-lib-go"
28 me "github.com/opencord/omci-lib-go/generated"
dbainbri4d3a0dc2020-12-02 00:33:42 +000029 "github.com/opencord/voltha-lib-go/v4/pkg/log"
30 //ic "github.com/opencord/voltha-protos/v4/go/inter_container"
31 //"github.com/opencord/voltha-protos/v4/go/openflow_13"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000032)
33
Himani Chawla6d2ae152020-09-02 13:11:20 +053034//lockStateFsm defines the structure for the state machine to lock/unlock the ONU UNI ports via OMCI
35type lockStateFsm struct {
Holger Hildebrandt8165eda2020-09-24 09:39:24 +000036 pDeviceHandler *deviceHandler
mpagenko01e726e2020-10-23 09:45:29 +000037 deviceID string
Himani Chawla6d2ae152020-09-02 13:11:20 +053038 pOmciCC *omciCC
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000039 adminState bool
40 requestEvent OnuDeviceEvent
41 omciLockResponseReceived chan bool //seperate channel needed for checking UNI port OMCi message responses
42 pAdaptFsm *AdapterFsm
mpagenko01e726e2020-10-23 09:45:29 +000043 pLastTxMeInstance *me.ManagedEntity
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000044}
45
mpagenko1cc3cb42020-07-27 15:24:38 +000046const (
47 // events of lock/unlock UNI port FSM
48 uniEvStart = "uniEvStart"
49 uniEvStartAdmin = "uniEvStartAdmin"
50 uniEvRxUnisResp = "uniEvRxUnisResp"
51 uniEvRxOnugResp = "uniEvRxOnugResp"
52 uniEvTimeoutSimple = "uniEvTimeoutSimple"
53 uniEvTimeoutUnis = "uniEvTimeoutUnis"
54 uniEvReset = "uniEvReset"
55 uniEvRestart = "uniEvRestart"
56)
57const (
58 // states of lock/unlock UNI port FSM
59 uniStDisabled = "uniStDisabled"
60 uniStStarting = "uniStStarting"
61 uniStSettingUnis = "uniStSettingUnis"
62 uniStSettingOnuG = "uniStSettingOnuG"
63 uniStAdminDone = "uniStAdminDone"
64 uniStResetting = "uniStResetting"
65)
66
Himani Chawla6d2ae152020-09-02 13:11:20 +053067//newLockStateFsm is the 'constructor' for the state machine to lock/unlock the ONU UNI ports via OMCI
dbainbri4d3a0dc2020-12-02 00:33:42 +000068func newLockStateFsm(ctx context.Context, apDevOmciCC *omciCC, aAdminState bool, aRequestEvent OnuDeviceEvent,
Holger Hildebrandt8165eda2020-09-24 09:39:24 +000069 aName string, apDeviceHandler *deviceHandler, aCommChannel chan Message) *lockStateFsm {
Himani Chawla6d2ae152020-09-02 13:11:20 +053070 instFsm := &lockStateFsm{
Holger Hildebrandt8165eda2020-09-24 09:39:24 +000071 pDeviceHandler: apDeviceHandler,
mpagenko01e726e2020-10-23 09:45:29 +000072 deviceID: apDeviceHandler.deviceID,
Holger Hildebrandt8165eda2020-09-24 09:39:24 +000073 pOmciCC: apDevOmciCC,
74 adminState: aAdminState,
75 requestEvent: aRequestEvent,
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000076 }
mpagenko01e726e2020-10-23 09:45:29 +000077 instFsm.pAdaptFsm = NewAdapterFsm(aName, instFsm.deviceID, aCommChannel)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000078 if instFsm.pAdaptFsm == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +000079 logger.Errorw(ctx, "LockStateFsm's AdapterFsm could not be instantiated!!", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +000080 "device-id": instFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000081 return nil
82 }
Himani Chawla4d908332020-08-31 12:30:20 +053083 if aAdminState { //port locking requested
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000084 instFsm.pAdaptFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +000085 uniStDisabled,
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000086 fsm.Events{
87
mpagenko1cc3cb42020-07-27 15:24:38 +000088 {Name: uniEvStart, Src: []string{uniStDisabled}, Dst: uniStStarting},
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000089
mpagenko1cc3cb42020-07-27 15:24:38 +000090 {Name: uniEvStartAdmin, Src: []string{uniStStarting}, Dst: uniStSettingUnis},
91 // the settingUnis state is used for multi ME config for all UNI related ports
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000092 // maybe such could be reflected in the state machine as well (port number parametrized)
93 // but that looks not straightforward here - so we keep it simple here for the beginning(?)
mpagenko1cc3cb42020-07-27 15:24:38 +000094 {Name: uniEvRxUnisResp, Src: []string{uniStSettingUnis}, Dst: uniStSettingOnuG},
95 {Name: uniEvRxOnugResp, Src: []string{uniStSettingOnuG}, Dst: uniStAdminDone},
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000096
mpagenko1cc3cb42020-07-27 15:24:38 +000097 {Name: uniEvTimeoutSimple, Src: []string{uniStSettingOnuG}, Dst: uniStStarting},
98 {Name: uniEvTimeoutUnis, Src: []string{uniStSettingUnis}, Dst: uniStStarting},
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000099
mpagenko1cc3cb42020-07-27 15:24:38 +0000100 {Name: uniEvReset, Src: []string{uniStStarting, uniStSettingOnuG, uniStSettingUnis,
101 uniStAdminDone}, Dst: uniStResetting},
102 // exceptional treatment for all states except uniStResetting
103 {Name: uniEvRestart, Src: []string{uniStStarting, uniStSettingOnuG, uniStSettingUnis,
104 uniStAdminDone, uniStResetting}, Dst: uniStDisabled},
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000105 },
106
107 fsm.Callbacks{
dbainbri4d3a0dc2020-12-02 00:33:42 +0000108 "enter_state": func(e *fsm.Event) { instFsm.pAdaptFsm.logFsmStateChange(ctx, e) },
109 ("enter_" + uniStStarting): func(e *fsm.Event) { instFsm.enterAdminStartingState(ctx, e) },
110 ("enter_" + uniStSettingOnuG): func(e *fsm.Event) { instFsm.enterSettingOnuGState(ctx, e) },
111 ("enter_" + uniStSettingUnis): func(e *fsm.Event) { instFsm.enterSettingUnisState(ctx, e) },
112 ("enter_" + uniStAdminDone): func(e *fsm.Event) { instFsm.enterAdminDoneState(ctx, e) },
113 ("enter_" + uniStResetting): func(e *fsm.Event) { instFsm.enterResettingState(ctx, e) },
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000114 },
115 )
116 } else { //port unlocking requested
117 instFsm.pAdaptFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000118 uniStDisabled,
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000119 fsm.Events{
120
mpagenko1cc3cb42020-07-27 15:24:38 +0000121 {Name: uniEvStart, Src: []string{uniStDisabled}, Dst: uniStStarting},
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000122
mpagenko1cc3cb42020-07-27 15:24:38 +0000123 {Name: uniEvStartAdmin, Src: []string{uniStStarting}, Dst: uniStSettingOnuG},
124 {Name: uniEvRxOnugResp, Src: []string{uniStSettingOnuG}, Dst: uniStSettingUnis},
125 // the settingUnis state is used for multi ME config for all UNI related ports
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000126 // maybe such could be reflected in the state machine as well (port number parametrized)
127 // but that looks not straightforward here - so we keep it simple here for the beginning(?)
mpagenko1cc3cb42020-07-27 15:24:38 +0000128 {Name: uniEvRxUnisResp, Src: []string{uniStSettingUnis}, Dst: uniStAdminDone},
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000129
mpagenko1cc3cb42020-07-27 15:24:38 +0000130 {Name: uniEvTimeoutSimple, Src: []string{uniStSettingOnuG}, Dst: uniStStarting},
131 {Name: uniEvTimeoutUnis, Src: []string{uniStSettingUnis}, Dst: uniStStarting},
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000132
mpagenko1cc3cb42020-07-27 15:24:38 +0000133 {Name: uniEvReset, Src: []string{uniStStarting, uniStSettingOnuG, uniStSettingUnis,
134 uniStAdminDone}, Dst: uniStResetting},
135 // exceptional treatment for all states except uniStResetting
136 {Name: uniEvRestart, Src: []string{uniStStarting, uniStSettingOnuG, uniStSettingUnis,
137 uniStAdminDone, uniStResetting}, Dst: uniStDisabled},
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000138 },
139
140 fsm.Callbacks{
dbainbri4d3a0dc2020-12-02 00:33:42 +0000141 "enter_state": func(e *fsm.Event) { instFsm.pAdaptFsm.logFsmStateChange(ctx, e) },
142 ("enter_" + uniStStarting): func(e *fsm.Event) { instFsm.enterAdminStartingState(ctx, e) },
143 ("enter_" + uniStSettingOnuG): func(e *fsm.Event) { instFsm.enterSettingOnuGState(ctx, e) },
144 ("enter_" + uniStSettingUnis): func(e *fsm.Event) { instFsm.enterSettingUnisState(ctx, e) },
145 ("enter_" + uniStAdminDone): func(e *fsm.Event) { instFsm.enterAdminDoneState(ctx, e) },
146 ("enter_" + uniStResetting): func(e *fsm.Event) { instFsm.enterResettingState(ctx, e) },
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000147 },
148 )
149 }
150 if instFsm.pAdaptFsm.pFsm == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000151 logger.Errorw(ctx, "LockStateFsm's Base FSM could not be instantiated!!", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000152 "device-id": instFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000153 return nil
154 }
155
dbainbri4d3a0dc2020-12-02 00:33:42 +0000156 logger.Debugw(ctx, "LockStateFsm created", log.Fields{"device-id": instFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000157 return instFsm
158}
159
Himani Chawla6d2ae152020-09-02 13:11:20 +0530160//setSuccessEvent modifies the requested event notified on success
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000161//assumption is that this is only called in the disabled (idle) state of the FSM, hence no sem protection required
Himani Chawla6d2ae152020-09-02 13:11:20 +0530162func (oFsm *lockStateFsm) setSuccessEvent(aEvent OnuDeviceEvent) {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000163 oFsm.requestEvent = aEvent
164}
165
dbainbri4d3a0dc2020-12-02 00:33:42 +0000166func (oFsm *lockStateFsm) enterAdminStartingState(ctx context.Context, e *fsm.Event) {
167 logger.Debugw(ctx, "LockStateFSM start", log.Fields{"in state": e.FSM.Current(),
mpagenko01e726e2020-10-23 09:45:29 +0000168 "device-id": oFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000169 // in case the used channel is not yet defined (can be re-used after restarts)
170 if oFsm.omciLockResponseReceived == nil {
171 oFsm.omciLockResponseReceived = make(chan bool)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000172 logger.Debug(ctx, "LockStateFSM - OMCI UniLock RxChannel defined")
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000173 } else {
174 // as we may 're-use' this instance of FSM and the connected channel
175 // make sure there is no 'lingering' request in the already existing channel:
176 // (simple loop sufficient as we are the only receiver)
177 for len(oFsm.omciLockResponseReceived) > 0 {
178 <-oFsm.omciLockResponseReceived
179 }
180 }
181 // start go routine for processing of LockState messages
dbainbri4d3a0dc2020-12-02 00:33:42 +0000182 go oFsm.processOmciLockMessages(ctx)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000183
184 //let the state machine run forward from here directly
185 pLockStateAFsm := oFsm.pAdaptFsm
186 if pLockStateAFsm != nil {
187 // obviously calling some FSM event here directly does not work - so trying to decouple it ...
188 go func(a_pAFsm *AdapterFsm) {
189 if a_pAFsm != nil && a_pAFsm.pFsm != nil {
Himani Chawla4d908332020-08-31 12:30:20 +0530190 _ = a_pAFsm.pFsm.Event(uniEvStartAdmin)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000191 }
192 }(pLockStateAFsm)
193 }
194}
195
dbainbri4d3a0dc2020-12-02 00:33:42 +0000196func (oFsm *lockStateFsm) enterSettingOnuGState(ctx context.Context, e *fsm.Event) {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000197 var omciAdminState uint8 = 1 //default locked
Himani Chawla4d908332020-08-31 12:30:20 +0530198 if !oFsm.adminState {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000199 omciAdminState = 0
200 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000201 logger.Debugw(ctx, "LockStateFSM Tx Set::ONU-G:admin", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000202 "omciAdmin": omciAdminState, "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000203 requestedAttributes := me.AttributeValueMap{"AdministrativeState": omciAdminState}
dbainbri4d3a0dc2020-12-02 00:33:42 +0000204 meInstance := oFsm.pOmciCC.sendSetOnuGLS(log.WithSpanFromContext(context.TODO(), ctx), ConstDefaultOmciTimeout, true,
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000205 requestedAttributes, oFsm.pAdaptFsm.commChan)
206 //accept also nil as (error) return value for writing to LastTx
207 // - this avoids misinterpretation of new received OMCI messages
208 // we might already abort the processing with nil here, but maybe some auto-recovery may be tried
209 // - may be improved later, for now we just handle it with the Rx timeout or missing next event (stick in state)
mpagenko01e726e2020-10-23 09:45:29 +0000210 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000211}
212
dbainbri4d3a0dc2020-12-02 00:33:42 +0000213func (oFsm *lockStateFsm) enterSettingUnisState(ctx context.Context, e *fsm.Event) {
mpagenko8b5fdd22020-12-17 17:58:32 +0000214 logger.Debugw(ctx, "LockStateFSM - starting UniTP adminState loop", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000215 "in state": e.FSM.Current(), "device-id": oFsm.deviceID, "LockState": oFsm.adminState})
dbainbri4d3a0dc2020-12-02 00:33:42 +0000216 go oFsm.performUniPortAdminSet(ctx)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000217}
218
dbainbri4d3a0dc2020-12-02 00:33:42 +0000219func (oFsm *lockStateFsm) enterAdminDoneState(ctx context.Context, e *fsm.Event) {
220 logger.Debugw(ctx, "LockStateFSM", log.Fields{"send notification to core in State": e.FSM.Current(), "device-id": oFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000221 //use DeviceHandler event notification directly, no need/support to update DeviceEntryState for lock/unlock
dbainbri4d3a0dc2020-12-02 00:33:42 +0000222 oFsm.pDeviceHandler.deviceProcStatusUpdate(ctx, oFsm.requestEvent)
Holger Hildebrandt8165eda2020-09-24 09:39:24 +0000223
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000224 //let's reset the state machine in order to release all resources now
225 pLockStateAFsm := oFsm.pAdaptFsm
226 if pLockStateAFsm != nil {
227 // obviously calling some FSM event here directly does not work - so trying to decouple it ...
228 go func(a_pAFsm *AdapterFsm) {
229 if a_pAFsm != nil && a_pAFsm.pFsm != nil {
Himani Chawla4d908332020-08-31 12:30:20 +0530230 _ = a_pAFsm.pFsm.Event(uniEvReset)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000231 }
232 }(pLockStateAFsm)
233 }
234}
235
dbainbri4d3a0dc2020-12-02 00:33:42 +0000236func (oFsm *lockStateFsm) enterResettingState(ctx context.Context, e *fsm.Event) {
237 logger.Debugw(ctx, "LockStateFSM resetting", log.Fields{"device-id": oFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000238 pLockStateAFsm := oFsm.pAdaptFsm
239 if pLockStateAFsm != nil {
240 // abort running message processing
241 fsmAbortMsg := Message{
242 Type: TestMsg,
243 Data: TestMessage{
244 TestMessageVal: AbortMessageProcessing,
245 },
246 }
247 pLockStateAFsm.commChan <- fsmAbortMsg
248
249 //try to restart the FSM to 'disabled'
250 // see DownloadedState: decouple event transfer
251 go func(a_pAFsm *AdapterFsm) {
252 if a_pAFsm != nil && a_pAFsm.pFsm != nil {
Himani Chawla4d908332020-08-31 12:30:20 +0530253 _ = a_pAFsm.pFsm.Event(uniEvRestart)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000254 }
255 }(pLockStateAFsm)
mpagenko01e726e2020-10-23 09:45:29 +0000256 oFsm.pLastTxMeInstance = nil
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000257 }
258}
259
dbainbri4d3a0dc2020-12-02 00:33:42 +0000260func (oFsm *lockStateFsm) processOmciLockMessages(ctx context.Context) {
261 logger.Debugw(ctx, "Start LockStateFsm Msg processing", log.Fields{"for device-id": oFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000262loop:
263 for {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000264 // case <-ctx.Done():
dbainbri4d3a0dc2020-12-02 00:33:42 +0000265 // logger.Info(ctx,"MibSync Msg", log.Fields{"Message handling canceled via context for device-id": oFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000266 // break loop
Himani Chawla4d908332020-08-31 12:30:20 +0530267 message, ok := <-oFsm.pAdaptFsm.commChan
268 if !ok {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000269 logger.Info(ctx, "LockStateFsm Rx Msg - could not read from channel", log.Fields{"device-id": oFsm.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +0530270 // but then we have to ensure a restart of the FSM as well - as exceptional procedure
271 _ = oFsm.pAdaptFsm.pFsm.Event(uniEvRestart)
272 break loop
273 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000274 logger.Debugw(ctx, "LockStateFsm Rx Msg", log.Fields{"device-id": oFsm.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +0530275
276 switch message.Type {
277 case TestMsg:
278 msg, _ := message.Data.(TestMessage)
279 if msg.TestMessageVal == AbortMessageProcessing {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000280 logger.Debugw(ctx, "LockStateFsm abort ProcessMsg", log.Fields{"for device-id": oFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000281 break loop
282 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000283 logger.Warnw(ctx, "LockStateFsm unknown TestMessage", log.Fields{"device-id": oFsm.deviceID, "MessageVal": msg.TestMessageVal})
Himani Chawla4d908332020-08-31 12:30:20 +0530284 case OMCI:
285 msg, _ := message.Data.(OmciMessage)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000286 oFsm.handleOmciLockStateMessage(ctx, msg)
Himani Chawla4d908332020-08-31 12:30:20 +0530287 default:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000288 logger.Warn(ctx, "LockStateFsm Rx unknown message", log.Fields{"device-id": oFsm.deviceID,
Himani Chawla4d908332020-08-31 12:30:20 +0530289 "message.Type": message.Type})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000290 }
291 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000292 logger.Debugw(ctx, "End LockStateFsm Msg processing", log.Fields{"device-id": oFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000293}
294
dbainbri4d3a0dc2020-12-02 00:33:42 +0000295func (oFsm *lockStateFsm) handleOmciLockStateMessage(ctx context.Context, msg OmciMessage) {
296 logger.Debugw(ctx, "Rx OMCI LockStateFsm Msg", log.Fields{"device-id": oFsm.deviceID,
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000297 "msgType": msg.OmciMsg.MessageType})
298
299 if msg.OmciMsg.MessageType == omci.SetResponseType {
300 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeSetResponse)
301 if msgLayer == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000302 logger.Errorw(ctx, "LockStateFsm - Omci Msg layer could not be detected for SetResponse",
mpagenko01e726e2020-10-23 09:45:29 +0000303 log.Fields{"device-id": oFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000304 return
305 }
306 msgObj, msgOk := msgLayer.(*omci.SetResponse)
307 if !msgOk {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000308 logger.Errorw(ctx, "LockStateFsm - Omci Msg layer could not be assigned for SetResponse",
mpagenko01e726e2020-10-23 09:45:29 +0000309 log.Fields{"device-id": oFsm.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000310 return
311 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000312 logger.Debugw(ctx, "LockStateFsm SetResponse Data", log.Fields{"device-id": oFsm.deviceID, "data-fields": msgObj})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000313 if msgObj.Result != me.Success {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000314 logger.Errorw(ctx, "LockStateFsm - Omci SetResponse Error - later: drive FSM to abort state ?", log.Fields{"Error": msgObj.Result})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000315 // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
316 return
317 }
318 // compare comments above for CreateResponse (apply also here ...)
mpagenko01e726e2020-10-23 09:45:29 +0000319 if msgObj.EntityClass == oFsm.pLastTxMeInstance.GetClassID() &&
320 msgObj.EntityInstance == oFsm.pLastTxMeInstance.GetEntityID() {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000321 //store the created ME into DB //TODO??? obviously the Python code does not store the config ...
322 // if, then something like:
323 //oFsm.pOnuDB.StoreMe(msgObj)
324
mpagenko01e726e2020-10-23 09:45:29 +0000325 switch oFsm.pLastTxMeInstance.GetName() {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000326 case "OnuG":
327 { // let the FSM proceed ...
Himani Chawla4d908332020-08-31 12:30:20 +0530328 _ = oFsm.pAdaptFsm.pFsm.Event(uniEvRxOnugResp)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000329 }
Holger Hildebrandtd1a89222020-12-15 15:32:07 +0000330 case "PhysicalPathTerminationPointEthernetUni", "VirtualEthernetInterfacePoint":
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000331 { // let the PPTP init proceed by stopping the wait function
332 oFsm.omciLockResponseReceived <- true
333 }
334 }
Matteo Scandolob250bec2021-01-27 17:35:45 -0800335 } else {
336 logger.Warnf(ctx, "LockStateFsm - Received SetResponse Data for %s with wrong classID or entityID ",
337 log.Fields{"device-id": oFsm.deviceID, "data-fields": msgObj}, msgObj.EntityClass)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000338 }
339 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000340 logger.Errorw(ctx, "LockStateFsm - Rx OMCI unhandled MsgType", log.Fields{"omciMsgType": msg.OmciMsg.MessageType})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000341 return
342 }
343}
344
dbainbri4d3a0dc2020-12-02 00:33:42 +0000345func (oFsm *lockStateFsm) performUniPortAdminSet(ctx context.Context) {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000346 var omciAdminState uint8 = 1 //default locked
Himani Chawla4d908332020-08-31 12:30:20 +0530347 if !oFsm.adminState {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000348 omciAdminState = 0
349 }
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000350 //set PPTPEthUni or VEIP AdminState
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000351 requestedAttributes := me.AttributeValueMap{"AdministrativeState": omciAdminState}
352
353 for uniNo, uniPort := range oFsm.pOmciCC.pBaseDeviceHandler.uniEntityMap {
mpagenko8b5fdd22020-12-17 17:58:32 +0000354 // only unlock the UniPort in case it is defined for usage (R2.6 limit only one port),
355 // compare also limitation for logical voltha port in dh.enableUniPortStateUpdate()
356 if (omciAdminState == 1) || (1<<uniPort.uniID)&activeUniPortStateUpdateMask == (1<<uniPort.uniID) {
357 var meInstance *me.ManagedEntity
358 if uniPort.portType == uniPPTP {
359 logger.Debugw(ctx, "Setting PPTP admin state", log.Fields{
360 "device-id": oFsm.deviceID, "for PortNo": uniNo, "state (0-unlock)": omciAdminState})
361 meInstance = oFsm.pOmciCC.sendSetPptpEthUniLS(log.WithSpanFromContext(context.TODO(), ctx), uniPort.entityID, ConstDefaultOmciTimeout,
362 true, requestedAttributes, oFsm.pAdaptFsm.commChan)
363 oFsm.pLastTxMeInstance = meInstance
364 } else if uniPort.portType == uniVEIP {
365 logger.Debugw(ctx, "Setting VEIP admin state", log.Fields{
366 "device-id": oFsm.deviceID, "for PortNo": uniNo, "state (0-unlock)": omciAdminState})
367 meInstance = oFsm.pOmciCC.sendSetVeipLS(log.WithSpanFromContext(context.TODO(), ctx), uniPort.entityID, ConstDefaultOmciTimeout,
368 true, requestedAttributes, oFsm.pAdaptFsm.commChan)
369 oFsm.pLastTxMeInstance = meInstance
370 } else {
371 logger.Warnw(ctx, "Unsupported UniTP type - skip",
372 log.Fields{"device-id": oFsm.deviceID, "Port": uniNo})
373 continue
374 }
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000375
mpagenko8b5fdd22020-12-17 17:58:32 +0000376 //verify response
377 err := oFsm.waitforOmciResponse(ctx, meInstance)
378 if err != nil {
379 logger.Errorw(ctx, "UniTP Admin State set failed, aborting LockState set!",
380 log.Fields{"device-id": oFsm.deviceID, "Port": uniNo})
381 _ = oFsm.pAdaptFsm.pFsm.Event(uniEvReset)
382 return
383 }
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000384 }
385 } //for all UNI ports
386 // if Config has been done for all UNI related instances let the FSM proceed
387 // while we did not check here, if there is some port at all - !?
mpagenko8b5fdd22020-12-17 17:58:32 +0000388 logger.Infow(ctx, "UniTP adminState loop finished", log.Fields{"device-id": oFsm.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +0530389 _ = oFsm.pAdaptFsm.pFsm.Event(uniEvRxUnisResp)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000390}
391
dbainbri4d3a0dc2020-12-02 00:33:42 +0000392func (oFsm *lockStateFsm) waitforOmciResponse(ctx context.Context, apMeInstance *me.ManagedEntity) error {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000393 select {
Himani Chawla4d908332020-08-31 12:30:20 +0530394 // maybe be also some outside cancel (but no context modeled for the moment ...)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000395 // case <-ctx.Done():
dbainbri4d3a0dc2020-12-02 00:33:42 +0000396 // logger.Infow(ctx,"LockState-bridge-init message reception canceled", log.Fields{"for device-id": oFsm.deviceID})
mpagenko3af1f032020-06-10 08:53:41 +0000397 case <-time.After(30 * time.Second): //3s was detected to be to less in 8*8 bbsim test with debug Info/Debug
dbainbri4d3a0dc2020-12-02 00:33:42 +0000398 logger.Warnw(ctx, "LockStateFSM uni-set timeout", log.Fields{"for device-id": oFsm.deviceID})
mpagenko01e726e2020-10-23 09:45:29 +0000399 return fmt.Errorf("lockStateFsm uni-set timeout for device-id %s", oFsm.deviceID)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000400 case success := <-oFsm.omciLockResponseReceived:
Himani Chawla4d908332020-08-31 12:30:20 +0530401 if success {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000402 logger.Debug(ctx, "LockStateFSM uni-set response received")
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000403 return nil
404 }
405 // should not happen so far
dbainbri4d3a0dc2020-12-02 00:33:42 +0000406 logger.Warnw(ctx, "LockStateFSM uni-set response error", log.Fields{"for device-id": oFsm.deviceID})
mpagenko01e726e2020-10-23 09:45:29 +0000407 return fmt.Errorf("lockStateFsm uni-set responseError for device-id %s", oFsm.deviceID)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000408 }
409}