Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [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 | |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 17 | //Package adaptercoreonu provides the utility for onu devices, flows and statistics |
| 18 | package adaptercoreonu |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 19 | |
| 20 | import ( |
| 21 | "context" |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 22 | "errors" |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame^] | 23 | "github.com/opencord/omci-lib-go" |
| 24 | me "github.com/opencord/omci-lib-go/generated" |
| 25 | "time" |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 26 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 27 | //"sync" |
| 28 | //"time" |
| 29 | |
| 30 | "github.com/looplab/fsm" |
| 31 | "github.com/opencord/voltha-lib-go/v3/pkg/adapters/adapterif" |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 32 | "github.com/opencord/voltha-lib-go/v3/pkg/db" |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 33 | |
| 34 | //"github.com/opencord/voltha-lib-go/v3/pkg/kafka" |
| 35 | "github.com/opencord/voltha-lib-go/v3/pkg/log" |
| 36 | //ic "github.com/opencord/voltha-protos/v3/go/inter_container" |
| 37 | //"github.com/opencord/voltha-protos/v3/go/openflow_13" |
| 38 | //"github.com/opencord/voltha-protos/v3/go/voltha" |
| 39 | ) |
| 40 | |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 41 | const ( |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 42 | // events of MibUpload FSM |
| 43 | ulEvStart = "ulEvStart" |
| 44 | ulEvResetMib = "ulEvResetMib" |
| 45 | ulEvGetVendorAndSerial = "ulEvGetVendorAndSerial" |
| 46 | ulEvGetEquipmentId = "ulEvGetEquipmentId" |
| 47 | ulEvGetFirstSwVersion = "ulEvGetFirstSwVersion" |
| 48 | ulEvGetSecondSwVersion = "ulEvGetSecondSwVersion" |
| 49 | ulEvGetMacAddress = "ulEvGetMacAddress" |
| 50 | ulEvGetMibTemplate = "ulEvGetMibTemplate" |
| 51 | ulEvUploadMib = "ulEvUploadMib" |
| 52 | ulEvExamineMds = "ulEvExamineMds" |
| 53 | ulEvSuccess = "ulEvSuccess" |
| 54 | ulEvMismatch = "ulEvMismatch" |
| 55 | ulEvAuditMib = "ulEvAuditMib" |
| 56 | ulEvForceResync = "ulEvForceResync" |
| 57 | ulEvDiffsFound = "ulEvDiffsFound" |
| 58 | ulEvTimeout = "ulEvTimeout" |
| 59 | ulEvStop = "ulEvStop" |
| 60 | ) |
| 61 | const ( |
| 62 | // states of MibUpload FSM |
| 63 | ulStDisabled = "ulStDisabled" |
| 64 | ulStStarting = "ulStStarting" |
| 65 | ulStResettingMib = "ulStResettingMib" |
| 66 | ulStGettingVendorAndSerial = "ulStGettingVendorAndSerial" |
| 67 | ulStGettingEquipmentId = "ulStGettingEquipmentId" |
| 68 | ulStGettingFirstSwVersion = "ulStGettingFirstSwVersion" |
| 69 | ulStGettingSecondSwVersion = "ulStGettingSecondSwVersion" |
| 70 | ulStGettingMacAddress = "ulStGettingMacAddress" |
| 71 | ulStGettingMibTemplate = "ulStGettingMibTemplate" |
| 72 | ulStUploading = "ulStUploading" |
| 73 | ulStInSync = "ulStInSync" |
| 74 | ulStExaminingMds = "ulStExaminingMds" |
| 75 | ulStResynchronizing = "ulStResynchronizing" |
| 76 | ulStAuditing = "ulStAuditing" |
| 77 | ulStOutOfSync = "ulStOutOfSync" |
| 78 | ) |
| 79 | |
| 80 | const ( |
| 81 | // events of MibDownload FSM |
| 82 | dlEvStart = "dlEvStart" |
| 83 | dlEvCreateGal = "dlEvCreateGal" |
| 84 | dlEvRxGalResp = "dlEvRxGalResp" |
| 85 | dlEvRxOnu2gResp = "dlEvRxOnu2gResp" |
| 86 | dlEvRxBridgeResp = "dlEvRxBridgeResp" |
| 87 | dlEvTimeoutSimple = "dlEvTimeoutSimple" |
| 88 | dlEvTimeoutBridge = "dlEvTimeoutBridge" |
| 89 | dlEvReset = "dlEvReset" |
| 90 | dlEvRestart = "dlEvRestart" |
| 91 | ) |
| 92 | const ( |
| 93 | // states of MibDownload FSM |
| 94 | dlStDisabled = "dlStDisabled" |
| 95 | dlStStarting = "dlStStarting" |
| 96 | dlStCreatingGal = "dlStCreatingGal" |
| 97 | dlStSettingOnu2g = "dlStSettingOnu2g" |
| 98 | dlStBridgeInit = "dlStBridgeInit" |
| 99 | dlStDownloaded = "dlStDownloaded" |
| 100 | dlStResetting = "dlStResetting" |
| 101 | ) |
| 102 | |
| 103 | const ( |
mpagenko | af80163 | 2020-07-03 10:00:42 +0000 | [diff] [blame] | 104 | cBasePathMibTemplateKvStore = "service/voltha/omci_mibs/templates" |
| 105 | cSuffixMibTemplateKvStore = "%s/%s/%s" |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 106 | ) |
| 107 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 108 | type OnuDeviceEvent int |
| 109 | |
| 110 | const ( |
| 111 | // Events of interest to Device Adapters and OpenOMCI State Machines |
| 112 | DeviceStatusInit OnuDeviceEvent = 0 // OnuDeviceEntry default start state |
| 113 | MibDatabaseSync OnuDeviceEvent = 1 // MIB database sync (upload done) |
| 114 | OmciCapabilitiesDone OnuDeviceEvent = 2 // OMCI ME and message type capabilities known |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 115 | MibDownloadDone OnuDeviceEvent = 3 // MIB database sync (upload done) |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 116 | UniLockStateDone OnuDeviceEvent = 4 // Uni ports admin set to lock |
| 117 | UniUnlockStateDone OnuDeviceEvent = 5 // Uni ports admin set to unlock |
| 118 | UniAdminStateDone OnuDeviceEvent = 6 // Uni ports admin set done - general |
| 119 | PortLinkUp OnuDeviceEvent = 7 // Port link state change |
| 120 | PortLinkDw OnuDeviceEvent = 8 // Port link state change |
mpagenko | 3dbcdd2 | 2020-07-22 07:38:45 +0000 | [diff] [blame] | 121 | OmciAniConfigDone OnuDeviceEvent = 9 // AniSide config according to TechProfile done |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 122 | // Add other events here as needed (alarms separate???) |
| 123 | ) |
| 124 | |
| 125 | type activityDescr struct { |
| 126 | databaseClass func() error |
| 127 | advertiseEvents bool |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 128 | auditDelay uint16 |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 129 | //tasks map[string]func() error |
| 130 | } |
| 131 | type OmciDeviceFsms map[string]activityDescr |
| 132 | |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 133 | type AdapterFsm struct { |
| 134 | fsmName string |
| 135 | deviceID string |
| 136 | commChan chan Message |
| 137 | pFsm *fsm.FSM |
| 138 | } |
| 139 | |
| 140 | func NewAdapterFsm(a_name string, a_deviceID string, a_commChannel chan Message) *AdapterFsm { |
| 141 | aFsm := &AdapterFsm{ |
| 142 | fsmName: a_name, |
| 143 | deviceID: a_deviceID, |
| 144 | commChan: a_commChannel, |
| 145 | } |
| 146 | return aFsm |
| 147 | } |
| 148 | |
| 149 | //Start starts (logs) the omci agent |
| 150 | func (oo *AdapterFsm) logFsmStateChange(e *fsm.Event) { |
| 151 | logger.Debugw("FSM state change", log.Fields{"device-id": oo.deviceID, "FSM name": oo.fsmName, |
| 152 | "event name": string(e.Event), "src state": string(e.Src), "dst state": string(e.Dst)}) |
| 153 | } |
| 154 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 155 | //OntDeviceEntry structure holds information about the attached FSM'as and their communication |
Holger Hildebrandt | c54939a | 2020-06-17 08:14:27 +0000 | [diff] [blame] | 156 | |
| 157 | const ( |
| 158 | FirstSwImageMeId = 0 |
| 159 | SecondSwImageMeId = 1 |
| 160 | ) |
| 161 | const OnugMeId = 0 |
| 162 | const Onu2gMeId = 0 |
| 163 | const IpHostConfigDataMeId = 1 |
| 164 | const OnugSerialNumberLen = 8 |
| 165 | const OmciMacAddressLen = 6 |
| 166 | |
| 167 | type SwImages struct { |
| 168 | version string |
| 169 | isActive uint8 |
| 170 | } |
| 171 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 172 | type OnuDeviceEntry struct { |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 173 | deviceID string |
| 174 | baseDeviceHandler *DeviceHandler |
| 175 | coreProxy adapterif.CoreProxy |
| 176 | adapterProxy adapterif.AdapterProxy |
| 177 | started bool |
| 178 | PDevOmciCC *OmciCC |
| 179 | pOnuDB *OnuDeviceDB |
| 180 | mibTemplateKVStore *db.Backend |
| 181 | vendorID string |
| 182 | serialNumber string |
| 183 | equipmentID string |
Holger Hildebrandt | c54939a | 2020-06-17 08:14:27 +0000 | [diff] [blame] | 184 | swImages [SecondSwImageMeId + 1]SwImages |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 185 | activeSwVersion string |
| 186 | macAddress string |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 187 | //lockDeviceEntries sync.RWMutex |
| 188 | mibDbClass func() error |
| 189 | supportedFsms OmciDeviceFsms |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 190 | devState OnuDeviceEvent |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 191 | // for mibUpload |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 192 | mibAuditDelay uint16 |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 193 | mibDebugLevel string |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 194 | |
| 195 | // for mibUpload |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 196 | pMibUploadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later |
| 197 | // for mibDownload |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 198 | pMibDownloadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later |
| 199 | //remark: general usage of pAdapterFsm would require generalization of commChan usage and internal event setting |
| 200 | // within the FSM event procedures |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame^] | 201 | omciMessageReceived chan bool //seperate channel needed by DownloadFsm |
| 202 | omciRebootMessageReceivedChannel chan Message // channel needed by Reboot request |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 203 | } |
| 204 | |
| 205 | //OnuDeviceEntry returns a new instance of a OnuDeviceEntry |
| 206 | //mib_db (as well as not inluded alarm_db not really used in this code? VERIFY!!) |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 207 | func NewOnuDeviceEntry(ctx context.Context, device_id string, kVStoreHost string, kVStorePort int, kvStoreType string, device_Handler *DeviceHandler, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 208 | core_proxy adapterif.CoreProxy, adapter_proxy adapterif.AdapterProxy, |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 209 | supported_Fsms_Ptr *OmciDeviceFsms) *OnuDeviceEntry { |
| 210 | logger.Infow("init-onuDeviceEntry", log.Fields{"deviceId": device_id}) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 211 | var onuDeviceEntry OnuDeviceEntry |
| 212 | onuDeviceEntry.started = false |
| 213 | onuDeviceEntry.deviceID = device_id |
| 214 | onuDeviceEntry.baseDeviceHandler = device_Handler |
| 215 | onuDeviceEntry.coreProxy = core_proxy |
| 216 | onuDeviceEntry.adapterProxy = adapter_proxy |
| 217 | onuDeviceEntry.devState = DeviceStatusInit |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame^] | 218 | onuDeviceEntry.omciRebootMessageReceivedChannel = make(chan Message, 2048) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 219 | //openomciagent.lockDeviceHandlersMap = sync.RWMutex{} |
| 220 | //OMCI related databases are on a per-agent basis. State machines and tasks |
| 221 | //are per ONU Vendor |
| 222 | // |
| 223 | // MIB Synchronization Database - possible overloading from arguments |
| 224 | if supported_Fsms_Ptr != nil { |
| 225 | onuDeviceEntry.supportedFsms = *supported_Fsms_Ptr |
| 226 | } else { |
| 227 | //var mibSyncFsm = NewMibSynchronizer() |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 228 | // use some internaö defaults, if not defined from outside |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 229 | onuDeviceEntry.supportedFsms = OmciDeviceFsms{ |
| 230 | "mib-synchronizer": { |
| 231 | //mibSyncFsm, // Implements the MIB synchronization state machine |
| 232 | onuDeviceEntry.MibDbVolatileDict, // Implements volatile ME MIB database |
| 233 | true, // Advertise events on OpenOMCI event bus |
| 234 | 60, // Time to wait between MIB audits. 0 to disable audits. |
| 235 | // map[string]func() error{ |
| 236 | // "mib-upload": onuDeviceEntry.MibUploadTask, |
| 237 | // "mib-template": onuDeviceEntry.MibTemplateTask, |
| 238 | // "get-mds": onuDeviceEntry.GetMdsTask, |
| 239 | // "mib-audit": onuDeviceEntry.GetMdsTask, |
| 240 | // "mib-resync": onuDeviceEntry.MibResyncTask, |
| 241 | // "mib-reconcile": onuDeviceEntry.MibReconcileTask, |
| 242 | // }, |
| 243 | }, |
| 244 | } |
| 245 | } |
| 246 | onuDeviceEntry.mibDbClass = onuDeviceEntry.supportedFsms["mib-synchronizer"].databaseClass |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 247 | logger.Debug("access2mibDbClass") |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 248 | go onuDeviceEntry.mibDbClass() |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 249 | onuDeviceEntry.mibAuditDelay = onuDeviceEntry.supportedFsms["mib-synchronizer"].auditDelay |
| 250 | logger.Debugw("MibAudit is set to", log.Fields{"Delay": onuDeviceEntry.mibAuditDelay}) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 251 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 252 | onuDeviceEntry.mibDebugLevel = "normal" //set to "verbose" if you want to have all output, possibly later also per config option! |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 253 | // Omci related Mib upload sync state machine |
| 254 | mibUploadChan := make(chan Message, 2048) |
| 255 | onuDeviceEntry.pMibUploadFsm = NewAdapterFsm("MibUpload", device_id, mibUploadChan) |
| 256 | onuDeviceEntry.pMibUploadFsm.pFsm = fsm.NewFSM( |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 257 | ulStDisabled, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 258 | fsm.Events{ |
| 259 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 260 | {Name: ulEvStart, Src: []string{ulStDisabled}, Dst: ulStStarting}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 261 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 262 | {Name: ulEvResetMib, Src: []string{ulStStarting}, Dst: ulStResettingMib}, |
| 263 | {Name: ulEvGetVendorAndSerial, Src: []string{ulStResettingMib}, Dst: ulStGettingVendorAndSerial}, |
| 264 | {Name: ulEvGetEquipmentId, Src: []string{ulStGettingVendorAndSerial}, Dst: ulStGettingEquipmentId}, |
| 265 | {Name: ulEvGetFirstSwVersion, Src: []string{ulStGettingEquipmentId}, Dst: ulStGettingFirstSwVersion}, |
| 266 | {Name: ulEvGetSecondSwVersion, Src: []string{ulStGettingFirstSwVersion}, Dst: ulStGettingSecondSwVersion}, |
| 267 | {Name: ulEvGetMacAddress, Src: []string{ulStGettingSecondSwVersion}, Dst: ulStGettingMacAddress}, |
| 268 | {Name: ulEvGetMibTemplate, Src: []string{ulStGettingMacAddress}, Dst: ulStGettingMibTemplate}, |
Holger Hildebrandt | c54939a | 2020-06-17 08:14:27 +0000 | [diff] [blame] | 269 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 270 | {Name: ulEvUploadMib, Src: []string{ulStGettingMibTemplate}, Dst: ulStUploading}, |
| 271 | {Name: ulEvExamineMds, Src: []string{ulStStarting}, Dst: ulStExaminingMds}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 272 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 273 | {Name: ulEvSuccess, Src: []string{ulStGettingMibTemplate}, Dst: ulStInSync}, |
| 274 | {Name: ulEvSuccess, Src: []string{ulStUploading}, Dst: ulStInSync}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 275 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 276 | {Name: ulEvSuccess, Src: []string{ulStExaminingMds}, Dst: ulStInSync}, |
| 277 | {Name: ulEvMismatch, Src: []string{ulStExaminingMds}, Dst: ulStResynchronizing}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 278 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 279 | {Name: ulEvAuditMib, Src: []string{ulStInSync}, Dst: ulStAuditing}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 280 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 281 | {Name: ulEvSuccess, Src: []string{ulStOutOfSync}, Dst: ulStInSync}, |
| 282 | {Name: ulEvAuditMib, Src: []string{ulStOutOfSync}, Dst: ulStAuditing}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 283 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 284 | {Name: ulEvSuccess, Src: []string{ulStAuditing}, Dst: ulStInSync}, |
| 285 | {Name: ulEvMismatch, Src: []string{ulStAuditing}, Dst: ulStResynchronizing}, |
| 286 | {Name: ulEvForceResync, Src: []string{ulStAuditing}, Dst: ulStResynchronizing}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 287 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 288 | {Name: ulEvSuccess, Src: []string{ulStResynchronizing}, Dst: ulStInSync}, |
| 289 | {Name: ulEvDiffsFound, Src: []string{ulStResynchronizing}, Dst: ulStOutOfSync}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 290 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 291 | {Name: ulEvTimeout, Src: []string{ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentId, ulStGettingFirstSwVersion, |
| 292 | ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds, |
| 293 | ulStInSync, ulStOutOfSync, ulStAuditing}, Dst: ulStStarting}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 294 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 295 | {Name: ulEvStop, Src: []string{ulStStarting, ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentId, ulStGettingFirstSwVersion, |
| 296 | ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds, |
| 297 | ulStInSync, ulStOutOfSync, ulStAuditing}, Dst: ulStDisabled}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 298 | }, |
| 299 | |
| 300 | fsm.Callbacks{ |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 301 | "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibUploadFsm.logFsmStateChange(e) }, |
| 302 | ("enter_" + ulStStarting): func(e *fsm.Event) { onuDeviceEntry.enterStartingState(e) }, |
| 303 | ("enter_" + ulStResettingMib): func(e *fsm.Event) { onuDeviceEntry.enterResettingMibState(e) }, |
| 304 | ("enter_" + ulStGettingVendorAndSerial): func(e *fsm.Event) { onuDeviceEntry.enterGettingVendorAndSerialState(e) }, |
| 305 | ("enter_" + ulStGettingEquipmentId): func(e *fsm.Event) { onuDeviceEntry.enterGettingEquipmentIdState(e) }, |
| 306 | ("enter_" + ulStGettingFirstSwVersion): func(e *fsm.Event) { onuDeviceEntry.enterGettingFirstSwVersionState(e) }, |
| 307 | ("enter_" + ulStGettingSecondSwVersion): func(e *fsm.Event) { onuDeviceEntry.enterGettingSecondSwVersionState(e) }, |
| 308 | ("enter_" + ulStGettingMacAddress): func(e *fsm.Event) { onuDeviceEntry.enterGettingMacAddressState(e) }, |
| 309 | ("enter_" + ulStGettingMibTemplate): func(e *fsm.Event) { onuDeviceEntry.enterGettingMibTemplate(e) }, |
| 310 | ("enter_" + ulStUploading): func(e *fsm.Event) { onuDeviceEntry.enterUploadingState(e) }, |
| 311 | ("enter_" + ulStExaminingMds): func(e *fsm.Event) { onuDeviceEntry.enterExaminingMdsState(e) }, |
| 312 | ("enter_" + ulStResynchronizing): func(e *fsm.Event) { onuDeviceEntry.enterResynchronizingState(e) }, |
| 313 | ("enter_" + ulStAuditing): func(e *fsm.Event) { onuDeviceEntry.enterAuditingState(e) }, |
| 314 | ("enter_" + ulStOutOfSync): func(e *fsm.Event) { onuDeviceEntry.enterOutOfSyncState(e) }, |
| 315 | ("enter_" + ulStInSync): func(e *fsm.Event) { onuDeviceEntry.enterInSyncState(e) }, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 316 | }, |
| 317 | ) |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 318 | // Omci related Mib download state machine |
| 319 | mibDownloadChan := make(chan Message, 2048) |
| 320 | onuDeviceEntry.pMibDownloadFsm = NewAdapterFsm("MibDownload", device_id, mibDownloadChan) |
| 321 | onuDeviceEntry.pMibDownloadFsm.pFsm = fsm.NewFSM( |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 322 | dlStDisabled, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 323 | fsm.Events{ |
| 324 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 325 | {Name: dlEvStart, Src: []string{dlStDisabled}, Dst: dlStStarting}, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 326 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 327 | {Name: dlEvCreateGal, Src: []string{dlStStarting}, Dst: dlStCreatingGal}, |
| 328 | {Name: dlEvRxGalResp, Src: []string{dlStCreatingGal}, Dst: dlStSettingOnu2g}, |
| 329 | {Name: dlEvRxOnu2gResp, Src: []string{dlStSettingOnu2g}, Dst: dlStBridgeInit}, |
Holger Hildebrandt | dd23cc2 | 2020-05-19 13:32:18 +0000 | [diff] [blame] | 330 | // the bridge state is used for multi ME config for alle UNI related ports |
| 331 | // maybe such could be reflected in the state machine as well (port number parametrized) |
| 332 | // but that looks not straightforward here - so we keep it simple here for the beginning(?) |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 333 | {Name: dlEvRxBridgeResp, Src: []string{dlStBridgeInit}, Dst: dlStDownloaded}, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 334 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 335 | {Name: dlEvTimeoutSimple, Src: []string{dlStCreatingGal, dlStSettingOnu2g}, Dst: dlStStarting}, |
| 336 | {Name: dlEvTimeoutBridge, Src: []string{dlStBridgeInit}, Dst: dlStStarting}, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 337 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 338 | {Name: dlEvReset, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g, |
| 339 | dlStBridgeInit, dlStDownloaded}, Dst: dlStResetting}, |
| 340 | // exceptional treatment for all states except dlStResetting |
| 341 | {Name: dlEvRestart, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g, |
| 342 | dlStBridgeInit, dlStDownloaded, dlStResetting}, Dst: dlStDisabled}, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 343 | }, |
| 344 | |
| 345 | fsm.Callbacks{ |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 346 | "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibDownloadFsm.logFsmStateChange(e) }, |
| 347 | ("enter_" + dlStStarting): func(e *fsm.Event) { onuDeviceEntry.enterDLStartingState(e) }, |
| 348 | ("enter_" + dlStCreatingGal): func(e *fsm.Event) { onuDeviceEntry.enterCreatingGalState(e) }, |
| 349 | ("enter_" + dlStSettingOnu2g): func(e *fsm.Event) { onuDeviceEntry.enterSettingOnu2gState(e) }, |
| 350 | ("enter_" + dlStBridgeInit): func(e *fsm.Event) { onuDeviceEntry.enterBridgeInitState(e) }, |
| 351 | ("enter_" + dlStDownloaded): func(e *fsm.Event) { onuDeviceEntry.enterDownloadedState(e) }, |
| 352 | ("enter_" + dlStResetting): func(e *fsm.Event) { onuDeviceEntry.enterResettingState(e) }, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 353 | }, |
| 354 | ) |
| 355 | if onuDeviceEntry.pMibDownloadFsm == nil || onuDeviceEntry.pMibDownloadFsm.pFsm == nil { |
| 356 | logger.Error("MibDownloadFsm could not be instantiated!!") |
| 357 | // some specifc error treatment - or waiting for crash ??? |
| 358 | } |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 359 | |
mpagenko | af80163 | 2020-07-03 10:00:42 +0000 | [diff] [blame] | 360 | onuDeviceEntry.mibTemplateKVStore = onuDeviceEntry.baseDeviceHandler.SetBackend(cBasePathMibTemplateKvStore) |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 361 | if onuDeviceEntry.mibTemplateKVStore == nil { |
mpagenko | af80163 | 2020-07-03 10:00:42 +0000 | [diff] [blame] | 362 | logger.Errorw("Failed to setup mibTemplateKVStore", log.Fields{"deviceID": device_id}) |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 363 | } |
| 364 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 365 | // Alarm Synchronization Database |
| 366 | //self._alarm_db = None |
| 367 | //self._alarm_database_cls = support_classes['alarm-synchronizer']['database'] |
| 368 | return &onuDeviceEntry |
| 369 | } |
| 370 | |
| 371 | //Start starts (logs) the omci agent |
| 372 | func (oo *OnuDeviceEntry) Start(ctx context.Context) error { |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 373 | logger.Info("starting-OnuDeviceEntry") |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 374 | |
| 375 | oo.PDevOmciCC = NewOmciCC(ctx, oo, oo.deviceID, oo.baseDeviceHandler, |
| 376 | oo.coreProxy, oo.adapterProxy) |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 377 | if oo.PDevOmciCC == nil { |
| 378 | logger.Errorw("Could not create devOmciCc - abort", log.Fields{"for device": oo.deviceID}) |
| 379 | return errors.New("Could not create devOmciCc") |
| 380 | } |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 381 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 382 | oo.started = true |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 383 | logger.Info("OnuDeviceEntry-started") |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 384 | return nil |
| 385 | } |
| 386 | |
| 387 | //Stop terminates the session |
| 388 | func (oo *OnuDeviceEntry) Stop(ctx context.Context) error { |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 389 | logger.Info("stopping-OnuDeviceEntry") |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 390 | oo.started = false |
| 391 | //oo.exitChannel <- 1 |
mpagenko | 3af1f03 | 2020-06-10 08:53:41 +0000 | [diff] [blame] | 392 | // maybe also the omciCC should be stopped here - for now not as no real processing is expected here - maybe needs consolidation |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 393 | logger.Info("OnuDeviceEntry-stopped") |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 394 | return nil |
| 395 | } |
| 396 | |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame^] | 397 | func (oo *OnuDeviceEntry) Reboot(ctx context.Context) error { |
| 398 | logger.Info("reboot-OnuDeviceEntry") |
| 399 | if err := oo.PDevOmciCC.sendReboot(context.TODO(), ConstDefaultOmciTimeout, true, oo.omciRebootMessageReceivedChannel); err != nil { |
| 400 | logger.Errorw("onu didn't reboot", log.Fields{"for device": oo.deviceID}) |
| 401 | return err |
| 402 | } |
| 403 | logger.Info("OnuDeviceEntry-reboot") |
| 404 | return nil |
| 405 | } |
| 406 | |
| 407 | func (oo *OnuDeviceEntry) waitForRebootResponse(responseChannel chan Message) error { |
| 408 | select { |
| 409 | case <-time.After(3 * time.Second): //3s was detected to be to less in 8*8 bbsim test with debug Info/Debug |
| 410 | logger.Warnw("Reboot timeout", log.Fields{"for device-id": oo.deviceID}) |
| 411 | return errors.New("RebootTimeout") |
| 412 | case data := <-responseChannel: |
| 413 | switch data.Data.(OmciMessage).OmciMsg.MessageType { |
| 414 | case omci.RebootResponseType: |
| 415 | { |
| 416 | msgLayer := (*data.Data.(OmciMessage).OmciPacket).Layer(omci.LayerTypeRebootResponse) |
| 417 | if msgLayer == nil { |
| 418 | return errors.New("Omci Msg layer could not be detected for RebootResponseType") |
| 419 | } |
| 420 | msgObj, msgOk := msgLayer.(*omci.GetResponse) |
| 421 | if !msgOk { |
| 422 | return errors.New("Omci Msg layer could not be assigned for RebootResponseType") |
| 423 | } |
| 424 | logger.Debugw("CreateResponse Data", log.Fields{"deviceId": oo.deviceID, "data-fields": msgObj}) |
| 425 | if msgObj.Result != me.Success { |
| 426 | logger.Errorw("Omci RebootResponseType Error ", log.Fields{"Error": msgObj.Result}) |
| 427 | // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display? |
| 428 | return errors.New("Omci RebootResponse Result Error indication") |
| 429 | } |
| 430 | return nil |
| 431 | } |
| 432 | } |
| 433 | logger.Warnw("Reboot response error", log.Fields{"for device-id": oo.deviceID}) |
| 434 | return errors.New("Unexpected OmciResponse type received") |
| 435 | } |
| 436 | } |
| 437 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 438 | //Relay the InSync message via Handler to Rw core - Status update |
| 439 | func (oo *OnuDeviceEntry) transferSystemEvent(dev_Event OnuDeviceEvent) error { |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 440 | logger.Debugw("relaying system-event", log.Fields{"Event": dev_Event}) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 441 | // decouple the handler transfer from further processing here |
| 442 | // TODO!!! check if really no synch is required within the system e.g. to ensure following steps .. |
| 443 | if dev_Event == MibDatabaseSync { |
| 444 | if oo.devState < MibDatabaseSync { //devState has not been synced yet |
| 445 | oo.devState = MibDatabaseSync |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 446 | go oo.baseDeviceHandler.DeviceProcStatusUpdate(dev_Event) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 447 | //TODO!!! device control: next step: start MIB capability verification from here ?!!! |
| 448 | } else { |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 449 | logger.Debugw("mibinsync-event in some already synced state - ignored", log.Fields{"state": oo.devState}) |
| 450 | } |
| 451 | } else if dev_Event == MibDownloadDone { |
| 452 | if oo.devState < MibDownloadDone { //devState has not been synced yet |
| 453 | oo.devState = MibDownloadDone |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 454 | go oo.baseDeviceHandler.DeviceProcStatusUpdate(dev_Event) |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 455 | } else { |
| 456 | logger.Debugw("mibdownloaddone-event was already seen - ignored", log.Fields{"state": oo.devState}) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 457 | } |
| 458 | } else { |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 459 | logger.Warnw("device-event not yet handled", log.Fields{"state": dev_Event}) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 460 | } |
| 461 | return nil |
| 462 | } |