Takahiro Suzuki | 241c10e | 2020-12-17 20:17:57 +0900 | [diff] [blame^] | 1 | /* |
| 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 |
| 18 | package adaptercoreonu |
| 19 | |
| 20 | import ( |
| 21 | "context" |
| 22 | "errors" |
| 23 | "time" |
| 24 | |
| 25 | "github.com/looplab/fsm" |
| 26 | |
| 27 | "github.com/opencord/omci-lib-go" |
| 28 | me "github.com/opencord/omci-lib-go/generated" |
| 29 | "github.com/opencord/voltha-lib-go/v3/pkg/log" |
| 30 | ) |
| 31 | |
| 32 | func (onuDeviceEntry *OnuDeviceEntry) enterDLStartingState(e *fsm.Event) { |
| 33 | logger.Debugw("MibDownload FSM", log.Fields{"Start downloading OMCI MIB in state": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 34 | if onuDeviceEntry.omciMessageReceived == nil { |
| 35 | onuDeviceEntry.omciMessageReceived = make(chan bool) |
| 36 | logger.Debug("MibDownload FSM - defining the BridgeInit RxChannel") |
| 37 | } |
| 38 | go onuDeviceEntry.processMibDownloadMessages() |
| 39 | } |
| 40 | |
| 41 | func (onuDeviceEntry *OnuDeviceEntry) enterCreatingGalState(e *fsm.Event) { |
| 42 | logger.Debugw("MibDownload FSM", log.Fields{"Tx create::GAL Ethernet Profile in state": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 43 | meInstance := onuDeviceEntry.PDevOmciCC.sendCreateGalEthernetProfile(context.TODO(), ConstDefaultOmciTimeout, true) |
| 44 | onuDeviceEntry.PDevOmciCC.pLastTxMeInstance = meInstance |
| 45 | } |
| 46 | |
| 47 | func (onuDeviceEntry *OnuDeviceEntry) enterSettingOnu2gState(e *fsm.Event) { |
| 48 | logger.Debugw("MibDownload FSM", log.Fields{"Tx Set::ONU2-G in state": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 49 | meInstance := onuDeviceEntry.PDevOmciCC.sendSetOnu2g(context.TODO(), ConstDefaultOmciTimeout, true) |
| 50 | onuDeviceEntry.PDevOmciCC.pLastTxMeInstance = meInstance |
| 51 | } |
| 52 | |
| 53 | func (onuDeviceEntry *OnuDeviceEntry) enterBridgeInitState(e *fsm.Event) { |
| 54 | logger.Infow("MibDownload FSM - starting bridge config port loop", log.Fields{ |
| 55 | "in state": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 56 | go onuDeviceEntry.performInitialBridgeSetup() |
| 57 | } |
| 58 | |
| 59 | func (onuDeviceEntry *OnuDeviceEntry) enterDownloadedState(e *fsm.Event) { |
| 60 | logger.Debugw("MibDownload FSM", log.Fields{"send notification to core in State": e.FSM.Current(), "device-id": onuDeviceEntry.deviceID}) |
| 61 | onuDeviceEntry.transferSystemEvent(MibDownloadDone) |
| 62 | pMibDlFsm := onuDeviceEntry.pMibDownloadFsm |
| 63 | if pMibDlFsm != nil { |
| 64 | // obviously calling some FSM event here directly does not work - so trying to decouple it ... |
| 65 | go func(a_pAFsm *AdapterFsm) { |
| 66 | if a_pAFsm != nil && a_pAFsm.pFsm != nil { |
| 67 | _ = a_pAFsm.pFsm.Event(dlEvReset) |
| 68 | } |
| 69 | }(pMibDlFsm) |
| 70 | } |
| 71 | } |
| 72 | |
| 73 | func (onuDeviceEntry *OnuDeviceEntry) enterResettingState(e *fsm.Event) { |
| 74 | logger.Debugw("MibDownload FSM resetting", log.Fields{"device-id": onuDeviceEntry.deviceID}) |
| 75 | pMibDlFsm := onuDeviceEntry.pMibDownloadFsm |
| 76 | if pMibDlFsm != nil { |
| 77 | // abort running message processing |
| 78 | fsmAbortMsg := Message{ |
| 79 | Type: TestMsg, |
| 80 | Data: TestMessage{ |
| 81 | TestMessageVal: AbortMessageProcessing, |
| 82 | }, |
| 83 | } |
| 84 | pMibDlFsm.commChan <- fsmAbortMsg |
| 85 | |
| 86 | //try to restart the FSM to 'disabled' |
| 87 | // see DownloadedState: decouple event transfer |
| 88 | go func(a_pAFsm *AdapterFsm) { |
| 89 | if a_pAFsm != nil && a_pAFsm.pFsm != nil { |
| 90 | _ = a_pAFsm.pFsm.Event(dlEvRestart) |
| 91 | } |
| 92 | }(pMibDlFsm) |
| 93 | } |
| 94 | } |
| 95 | |
| 96 | func (onuDeviceEntry *OnuDeviceEntry) processMibDownloadMessages( /*ctx context.Context*/ ) { |
| 97 | logger.Debugw("Start MibDownload Msg processing", log.Fields{"for device-id": onuDeviceEntry.deviceID}) |
| 98 | loop: |
| 99 | for { |
| 100 | // case <-ctx.Done(): |
| 101 | // logger.Info("MibSync Msg", log.Fields{"Message handling canceled via context for device-id": onuDeviceEntry.deviceID}) |
| 102 | // break loop |
| 103 | // unless multiple channels are not involved, we should not use select |
| 104 | message, ok := <-onuDeviceEntry.pMibDownloadFsm.commChan |
| 105 | if !ok { |
| 106 | logger.Info("MibDownload Rx Msg", log.Fields{"Message couldn't be read from channel for device-id": onuDeviceEntry.deviceID}) |
| 107 | // but then we have to ensure a restart of the FSM as well - as exceptional procedure |
| 108 | _ = onuDeviceEntry.pMibDownloadFsm.pFsm.Event(dlEvRestart) |
| 109 | break loop |
| 110 | } |
| 111 | logger.Debugw("MibDownload Rx Msg", log.Fields{"Received message for device-id": onuDeviceEntry.deviceID}) |
| 112 | |
| 113 | switch message.Type { |
| 114 | case TestMsg: |
| 115 | msg, _ := message.Data.(TestMessage) |
| 116 | if msg.TestMessageVal == AbortMessageProcessing { |
| 117 | logger.Infow("MibDownload abort ProcessMsg", log.Fields{"for device-id": onuDeviceEntry.deviceID}) |
| 118 | break loop |
| 119 | } |
| 120 | logger.Warnw("MibDownload unknown TestMessage", log.Fields{"device-id": onuDeviceEntry.deviceID, "MessageVal": msg.TestMessageVal}) |
| 121 | case OMCI: |
| 122 | msg, _ := message.Data.(OmciMessage) |
| 123 | onuDeviceEntry.handleOmciMibDownloadMessage(msg) |
| 124 | default: |
| 125 | logger.Warn("MibDownload Rx Msg", log.Fields{"Unknown message type received for device-id": onuDeviceEntry.deviceID, |
| 126 | "message.Type": message.Type}) |
| 127 | } |
| 128 | |
| 129 | } |
| 130 | logger.Infow("End MibDownload Msg processing", log.Fields{"for device-id": onuDeviceEntry.deviceID}) |
| 131 | } |
| 132 | |
| 133 | func (onuDeviceEntry *OnuDeviceEntry) handleOmciMibDownloadMessage(msg OmciMessage) { |
| 134 | logger.Debugw("Rx OMCI MibDownload Msg", log.Fields{"device-id": onuDeviceEntry.deviceID, |
| 135 | "msgType": msg.OmciMsg.MessageType}) |
| 136 | |
| 137 | switch msg.OmciMsg.MessageType { |
| 138 | case omci.CreateResponseType: |
| 139 | { |
| 140 | msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeCreateResponse) |
| 141 | if msgLayer == nil { |
| 142 | logger.Error("Omci Msg layer could not be detected for CreateResponse") |
| 143 | return |
| 144 | } |
| 145 | msgObj, msgOk := msgLayer.(*omci.CreateResponse) |
| 146 | if !msgOk { |
| 147 | logger.Error("Omci Msg layer could not be assigned for CreateResponse") |
| 148 | return |
| 149 | } |
| 150 | logger.Debugw("CreateResponse Data", log.Fields{"device-id": onuDeviceEntry.deviceID, "data-fields": msgObj}) |
| 151 | if msgObj.Result != me.Success { |
| 152 | logger.Errorw("Omci CreateResponse Error - later: drive FSM to abort state ?", log.Fields{"Error": msgObj.Result}) |
| 153 | // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display? |
| 154 | return |
| 155 | } |
| 156 | // maybe there is a way of pushing the specific create response type generally to the FSM |
| 157 | // and let the FSM verify, if the response was according to current state |
| 158 | // and possibly store the element to DB and progress - maybe some future option ... |
| 159 | // but as that is not straightforward to me I insert the type checkes manually here |
| 160 | // and feed the FSM with only 'pre-defined' events ... |
| 161 | if msgObj.EntityClass == onuDeviceEntry.PDevOmciCC.pLastTxMeInstance.GetClassID() && |
| 162 | msgObj.EntityInstance == onuDeviceEntry.PDevOmciCC.pLastTxMeInstance.GetEntityID() { |
| 163 | //store the created ME into DB //TODO??? obviously the Python code does not store the config ... |
| 164 | // if, then something like: |
| 165 | //onuDeviceEntry.pOnuDB.StoreMe(msgObj) |
| 166 | |
| 167 | // maybe we can use just the same eventName for different state transitions like "forward" |
| 168 | // - might be checked, but so far I go for sure and have to inspect the concrete state events ... |
| 169 | switch onuDeviceEntry.PDevOmciCC.pLastTxMeInstance.GetName() { |
| 170 | case "GalEthernetProfile": |
| 171 | { // let the FSM proceed ... |
| 172 | _ = onuDeviceEntry.pMibDownloadFsm.pFsm.Event(dlEvRxGalResp) |
| 173 | } |
| 174 | case "MacBridgeServiceProfile", |
| 175 | "MacBridgePortConfigurationData", |
| 176 | "ExtendedVlanTaggingOperationConfigurationData": |
| 177 | { // let bridge init proceed by stopping the wait function |
| 178 | onuDeviceEntry.omciMessageReceived <- true |
| 179 | } |
| 180 | } |
| 181 | } |
| 182 | } //CreateResponseType |
| 183 | |
| 184 | case omci.SetResponseType: |
| 185 | { |
| 186 | msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeSetResponse) |
| 187 | if msgLayer == nil { |
| 188 | logger.Error("Omci Msg layer could not be detected for SetResponse") |
| 189 | return |
| 190 | } |
| 191 | msgObj, msgOk := msgLayer.(*omci.SetResponse) |
| 192 | if !msgOk { |
| 193 | logger.Error("Omci Msg layer could not be assigned for SetResponse") |
| 194 | return |
| 195 | } |
| 196 | logger.Debugw("SetResponse Data", log.Fields{"device-id": onuDeviceEntry.deviceID, "data-fields": msgObj}) |
| 197 | if msgObj.Result != me.Success { |
| 198 | logger.Errorw("Omci SetResponse Error - later: drive FSM to abort state ?", log.Fields{"Error": msgObj.Result}) |
| 199 | // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display? |
| 200 | return |
| 201 | } |
| 202 | // compare comments above for CreateResponse (apply also here ...) |
| 203 | if msgObj.EntityClass == onuDeviceEntry.PDevOmciCC.pLastTxMeInstance.GetClassID() && |
| 204 | msgObj.EntityInstance == onuDeviceEntry.PDevOmciCC.pLastTxMeInstance.GetEntityID() { |
| 205 | //store the created ME into DB //TODO??? obviously the Python code does not store the config ... |
| 206 | // if, then something like: |
| 207 | //onuDeviceEntry.pOnuDB.StoreMe(msgObj) |
| 208 | |
| 209 | switch onuDeviceEntry.PDevOmciCC.pLastTxMeInstance.GetName() { |
| 210 | case "Onu2G": |
| 211 | { // let the FSM proceed ... |
| 212 | _ = onuDeviceEntry.pMibDownloadFsm.pFsm.Event(dlEvRxOnu2gResp) |
| 213 | } |
| 214 | //so far that was the only MibDownlad Set Element ... |
| 215 | } |
| 216 | } |
| 217 | } //SetResponseType |
| 218 | default: |
| 219 | { |
| 220 | logger.Errorw("Rx OMCI MibDownload unhandled MsgType", log.Fields{"omciMsgType": msg.OmciMsg.MessageType}) |
| 221 | return |
| 222 | } |
| 223 | } // switch msg.OmciMsg.MessageType |
| 224 | } |
| 225 | |
| 226 | func (onuDeviceEntry *OnuDeviceEntry) performInitialBridgeSetup() { |
| 227 | for uniNo, uniPort := range onuDeviceEntry.baseDeviceHandler.uniEntityMap { |
| 228 | logger.Debugw("Starting IntialBridgeSetup", log.Fields{ |
| 229 | "device-id": onuDeviceEntry.deviceID, "for PortNo": uniNo}) |
| 230 | |
| 231 | //create MBSP |
| 232 | meInstance := onuDeviceEntry.PDevOmciCC.sendCreateMBServiceProfile( |
| 233 | context.TODO(), uniPort, ConstDefaultOmciTimeout, true) |
| 234 | onuDeviceEntry.PDevOmciCC.pLastTxMeInstance = meInstance |
| 235 | //verify response |
| 236 | err := onuDeviceEntry.waitforOmciResponse(meInstance) |
| 237 | if err != nil { |
| 238 | logger.Error("InitialBridgeSetup failed at MBSP, aborting MIB Download!") |
| 239 | _ = onuDeviceEntry.pMibDownloadFsm.pFsm.Event(dlEvReset) |
| 240 | return |
| 241 | } |
| 242 | |
| 243 | //create MBPCD |
| 244 | meInstance = onuDeviceEntry.PDevOmciCC.sendCreateMBPConfigData( |
| 245 | context.TODO(), uniPort, ConstDefaultOmciTimeout, true) |
| 246 | onuDeviceEntry.PDevOmciCC.pLastTxMeInstance = meInstance |
| 247 | //verify response |
| 248 | err = onuDeviceEntry.waitforOmciResponse(meInstance) |
| 249 | if err != nil { |
| 250 | logger.Error("InitialBridgeSetup failed at MBPCD, aborting MIB Download!") |
| 251 | _ = onuDeviceEntry.pMibDownloadFsm.pFsm.Event(dlEvReset) |
| 252 | return |
| 253 | } |
| 254 | |
| 255 | //create EVTOCD |
| 256 | meInstance = onuDeviceEntry.PDevOmciCC.sendCreateEVTOConfigData( |
| 257 | context.TODO(), uniPort, ConstDefaultOmciTimeout, true) |
| 258 | onuDeviceEntry.PDevOmciCC.pLastTxMeInstance = meInstance |
| 259 | //verify response |
| 260 | err = onuDeviceEntry.waitforOmciResponse(meInstance) |
| 261 | if err != nil { |
| 262 | logger.Error("InitialBridgeSetup failed at EVTOCD, aborting MIB Download!") |
| 263 | _ = onuDeviceEntry.pMibDownloadFsm.pFsm.Event(dlEvReset) |
| 264 | return |
| 265 | } |
| 266 | } |
| 267 | logger.Infow("IntialBridgeSetup finished", log.Fields{"device-id": onuDeviceEntry.deviceID}) |
| 268 | _ = onuDeviceEntry.pMibDownloadFsm.pFsm.Event(dlEvRxBridgeResp) |
| 269 | } |
| 270 | |
| 271 | func (onuDeviceEntry *OnuDeviceEntry) waitforOmciResponse(apMeInstance *me.ManagedEntity) error { |
| 272 | select { |
| 273 | case <-time.After(30 * time.Second): //3s was detected to be to less in 8*8 bbsim test with debug Info/Debug |
| 274 | logger.Warnw("MibDownload-bridge-init timeout", log.Fields{"for device-id": onuDeviceEntry.deviceID}) |
| 275 | return errors.New("mibDownloadBridgeInit timeout") |
| 276 | case success := <-onuDeviceEntry.omciMessageReceived: |
| 277 | if success { |
| 278 | logger.Debug("MibDownload-bridge-init response received") |
| 279 | return nil |
| 280 | } |
| 281 | // should not happen so far |
| 282 | logger.Warnw("MibDownload-bridge-init response error", log.Fields{"for device-id": onuDeviceEntry.deviceID}) |
| 283 | return errors.New("mibDownloadBridgeInit responseError") |
| 284 | } |
| 285 | } |