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 | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 22 | "encoding/json" |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 23 | "errors" |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 24 | "fmt" |
| 25 | "sync" |
Holger Hildebrandt | 2ff21f1 | 2020-08-13 14:38:02 +0000 | [diff] [blame] | 26 | "time" |
| 27 | |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 28 | "github.com/opencord/omci-lib-go" |
| 29 | me "github.com/opencord/omci-lib-go/generated" |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 30 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 31 | //"sync" |
| 32 | //"time" |
| 33 | |
| 34 | "github.com/looplab/fsm" |
| 35 | "github.com/opencord/voltha-lib-go/v3/pkg/adapters/adapterif" |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 36 | "github.com/opencord/voltha-lib-go/v3/pkg/db" |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 37 | "github.com/opencord/voltha-lib-go/v3/pkg/db/kvstore" |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 38 | |
| 39 | //"github.com/opencord/voltha-lib-go/v3/pkg/kafka" |
| 40 | "github.com/opencord/voltha-lib-go/v3/pkg/log" |
| 41 | //ic "github.com/opencord/voltha-protos/v3/go/inter_container" |
| 42 | //"github.com/opencord/voltha-protos/v3/go/openflow_13" |
| 43 | //"github.com/opencord/voltha-protos/v3/go/voltha" |
| 44 | ) |
| 45 | |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 46 | const ( |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 47 | // events of MibUpload FSM |
| 48 | ulEvStart = "ulEvStart" |
| 49 | ulEvResetMib = "ulEvResetMib" |
| 50 | ulEvGetVendorAndSerial = "ulEvGetVendorAndSerial" |
Himani Chawla | 4d90833 | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 51 | ulEvGetEquipmentID = "ulEvGetEquipmentId" |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 52 | ulEvGetFirstSwVersion = "ulEvGetFirstSwVersion" |
| 53 | ulEvGetSecondSwVersion = "ulEvGetSecondSwVersion" |
| 54 | ulEvGetMacAddress = "ulEvGetMacAddress" |
| 55 | ulEvGetMibTemplate = "ulEvGetMibTemplate" |
| 56 | ulEvUploadMib = "ulEvUploadMib" |
| 57 | ulEvExamineMds = "ulEvExamineMds" |
| 58 | ulEvSuccess = "ulEvSuccess" |
| 59 | ulEvMismatch = "ulEvMismatch" |
| 60 | ulEvAuditMib = "ulEvAuditMib" |
| 61 | ulEvForceResync = "ulEvForceResync" |
| 62 | ulEvDiffsFound = "ulEvDiffsFound" |
| 63 | ulEvTimeout = "ulEvTimeout" |
| 64 | ulEvStop = "ulEvStop" |
| 65 | ) |
| 66 | const ( |
| 67 | // states of MibUpload FSM |
| 68 | ulStDisabled = "ulStDisabled" |
| 69 | ulStStarting = "ulStStarting" |
| 70 | ulStResettingMib = "ulStResettingMib" |
| 71 | ulStGettingVendorAndSerial = "ulStGettingVendorAndSerial" |
Himani Chawla | 4d90833 | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 72 | ulStGettingEquipmentID = "ulStGettingEquipmentID" |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 73 | ulStGettingFirstSwVersion = "ulStGettingFirstSwVersion" |
| 74 | ulStGettingSecondSwVersion = "ulStGettingSecondSwVersion" |
| 75 | ulStGettingMacAddress = "ulStGettingMacAddress" |
| 76 | ulStGettingMibTemplate = "ulStGettingMibTemplate" |
| 77 | ulStUploading = "ulStUploading" |
| 78 | ulStInSync = "ulStInSync" |
| 79 | ulStExaminingMds = "ulStExaminingMds" |
| 80 | ulStResynchronizing = "ulStResynchronizing" |
| 81 | ulStAuditing = "ulStAuditing" |
| 82 | ulStOutOfSync = "ulStOutOfSync" |
| 83 | ) |
| 84 | |
| 85 | const ( |
| 86 | // events of MibDownload FSM |
| 87 | dlEvStart = "dlEvStart" |
| 88 | dlEvCreateGal = "dlEvCreateGal" |
| 89 | dlEvRxGalResp = "dlEvRxGalResp" |
| 90 | dlEvRxOnu2gResp = "dlEvRxOnu2gResp" |
| 91 | dlEvRxBridgeResp = "dlEvRxBridgeResp" |
| 92 | dlEvTimeoutSimple = "dlEvTimeoutSimple" |
| 93 | dlEvTimeoutBridge = "dlEvTimeoutBridge" |
| 94 | dlEvReset = "dlEvReset" |
| 95 | dlEvRestart = "dlEvRestart" |
| 96 | ) |
| 97 | const ( |
| 98 | // states of MibDownload FSM |
| 99 | dlStDisabled = "dlStDisabled" |
| 100 | dlStStarting = "dlStStarting" |
| 101 | dlStCreatingGal = "dlStCreatingGal" |
| 102 | dlStSettingOnu2g = "dlStSettingOnu2g" |
| 103 | dlStBridgeInit = "dlStBridgeInit" |
| 104 | dlStDownloaded = "dlStDownloaded" |
| 105 | dlStResetting = "dlStResetting" |
| 106 | ) |
| 107 | |
| 108 | const ( |
Holger Hildebrandt | 2ff21f1 | 2020-08-13 14:38:02 +0000 | [diff] [blame] | 109 | cBasePathMibTemplateKvStore = "service/voltha/omci_mibs/go_templates" |
mpagenko | af80163 | 2020-07-03 10:00:42 +0000 | [diff] [blame] | 110 | cSuffixMibTemplateKvStore = "%s/%s/%s" |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 111 | cBasePathOnuKVStore = "service/voltha/openonu" |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 112 | ) |
| 113 | |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 114 | // OnuDeviceEvent - event of interest to Device Adapters and OpenOMCI State Machines |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 115 | type OnuDeviceEvent int |
| 116 | |
| 117 | const ( |
| 118 | // Events of interest to Device Adapters and OpenOMCI State Machines |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 119 | |
| 120 | // DeviceStatusInit - default start state |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 121 | DeviceStatusInit OnuDeviceEvent = iota |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 122 | // MibDatabaseSync - MIB database sync (upload done) |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 123 | MibDatabaseSync |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 124 | // OmciCapabilitiesDone - OMCI ME and message type capabilities known |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 125 | OmciCapabilitiesDone |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 126 | // MibDownloadDone - // MIB download done |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 127 | MibDownloadDone |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 128 | // UniLockStateDone - Uni ports admin set to lock |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 129 | UniLockStateDone |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 130 | // UniUnlockStateDone - Uni ports admin set to unlock |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 131 | UniUnlockStateDone |
mpagenko | 900ee4b | 2020-10-12 11:56:34 +0000 | [diff] [blame] | 132 | // UniDisableStateDone - Uni ports admin set to lock based on device disable |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 133 | UniDisableStateDone |
mpagenko | 900ee4b | 2020-10-12 11:56:34 +0000 | [diff] [blame] | 134 | // UniEnableStateDone - Uni ports admin set to unlock based on device re-enable |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 135 | UniEnableStateDone |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 136 | // PortLinkUp - Port link state change |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 137 | PortLinkUp |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 138 | // PortLinkDw - Port link state change |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 139 | PortLinkDw |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 140 | // OmciAniConfigDone - AniSide config according to TechProfile done |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 141 | OmciAniConfigDone |
| 142 | // OmciAniResourceRemoved - AniSide TechProfile related resource (Gem/TCont) removed |
| 143 | OmciAniResourceRemoved // needs to be the successor of OmciAniConfigDone! |
| 144 | // OmciVlanFilterAddDone - Omci Vlan config done according to flow-add |
| 145 | OmciVlanFilterAddDone |
| 146 | // OmciVlanFilterRemDone - Omci Vlan config done according to flow-remove |
| 147 | OmciVlanFilterRemDone // needs to be the successor of OmciVlanFilterAddDone! |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 148 | // Add other events here as needed (alarms separate???) |
| 149 | ) |
| 150 | |
| 151 | type activityDescr struct { |
Himani Chawla | 4d90833 | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 152 | databaseClass func() error |
| 153 | //advertiseEvents bool |
| 154 | auditDelay uint16 |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 155 | //tasks map[string]func() error |
| 156 | } |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 157 | |
| 158 | // OmciDeviceFsms - FSM event mapping to database class and time to wait between audits |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 159 | type OmciDeviceFsms map[string]activityDescr |
| 160 | |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 161 | // AdapterFsm - Adapter FSM details including channel, event and device |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 162 | type AdapterFsm struct { |
| 163 | fsmName string |
| 164 | deviceID string |
| 165 | commChan chan Message |
| 166 | pFsm *fsm.FSM |
| 167 | } |
| 168 | |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 169 | //NewAdapterFsm - FSM details including event, device and channel. |
| 170 | func NewAdapterFsm(aName string, aDeviceID string, aCommChannel chan Message) *AdapterFsm { |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 171 | aFsm := &AdapterFsm{ |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 172 | fsmName: aName, |
| 173 | deviceID: aDeviceID, |
| 174 | commChan: aCommChannel, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 175 | } |
| 176 | return aFsm |
| 177 | } |
| 178 | |
| 179 | //Start starts (logs) the omci agent |
| 180 | func (oo *AdapterFsm) logFsmStateChange(e *fsm.Event) { |
| 181 | logger.Debugw("FSM state change", log.Fields{"device-id": oo.deviceID, "FSM name": oo.fsmName, |
| 182 | "event name": string(e.Event), "src state": string(e.Src), "dst state": string(e.Dst)}) |
| 183 | } |
| 184 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 185 | //OntDeviceEntry structure holds information about the attached FSM'as and their communication |
Holger Hildebrandt | c54939a | 2020-06-17 08:14:27 +0000 | [diff] [blame] | 186 | |
| 187 | const ( |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 188 | firstSwImageMeID = 0 |
| 189 | secondSwImageMeID = 1 |
Holger Hildebrandt | c54939a | 2020-06-17 08:14:27 +0000 | [diff] [blame] | 190 | ) |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 191 | const onugMeID = 0 |
| 192 | const onu2gMeID = 0 |
| 193 | const ipHostConfigDataMeID = 1 |
| 194 | const onugSerialNumberLen = 8 |
| 195 | const omciMacAddressLen = 6 |
Holger Hildebrandt | c54939a | 2020-06-17 08:14:27 +0000 | [diff] [blame] | 196 | |
Holger Hildebrandt | 2fb7089 | 2020-10-28 11:53:18 +0000 | [diff] [blame] | 197 | const cEmptyMacAddrString = "000000000000" |
| 198 | const cEmptySerialNumberString = "0000000000000000" |
| 199 | |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 200 | type swImages struct { |
Holger Hildebrandt | c54939a | 2020-06-17 08:14:27 +0000 | [diff] [blame] | 201 | version string |
| 202 | isActive uint8 |
| 203 | } |
| 204 | |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 205 | type uniPersConfig struct { |
| 206 | PersUniID uint8 `json:"uni_id"` |
| 207 | PersTpPath string `json:"tp_path"` |
mpagenko | 01e726e | 2020-10-23 09:45:29 +0000 | [diff] [blame] | 208 | PersFlowParams []uniVlanFlowParams `json:"flow_params"` //as defined in omci_ani_config.go |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 209 | } |
| 210 | |
| 211 | type onuPersistentData struct { |
| 212 | PersOnuID uint32 `json:"onu_id"` |
| 213 | PersIntfID uint32 `json:"intf_id"` |
| 214 | PersSnr string `json:"serial_number"` |
| 215 | PersAdminState string `json:"admin_state"` |
| 216 | PersOperState string `json:"oper_state"` |
| 217 | PersUniConfig []uniPersConfig `json:"uni_config"` |
| 218 | } |
| 219 | |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 220 | // OnuDeviceEntry - ONU device info and FSM events. |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 221 | type OnuDeviceEntry struct { |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 222 | deviceID string |
| 223 | baseDeviceHandler *deviceHandler |
| 224 | coreProxy adapterif.CoreProxy |
| 225 | adapterProxy adapterif.AdapterProxy |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 226 | PDevOmciCC *omciCC |
| 227 | pOnuDB *onuDeviceDB |
| 228 | mibTemplateKVStore *db.Backend |
| 229 | sOnuPersistentData onuPersistentData |
| 230 | onuKVStoreMutex sync.RWMutex |
| 231 | onuKVStore *db.Backend |
| 232 | onuKVStorePath string |
| 233 | onuKVStoreprocResult error //error indication of processing |
| 234 | chOnuKvProcessingStep chan uint8 |
| 235 | vendorID string |
| 236 | serialNumber string |
| 237 | equipmentID string |
| 238 | swImages [secondSwImageMeID + 1]swImages |
| 239 | activeSwVersion string |
| 240 | macAddress string |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 241 | //lockDeviceEntries sync.RWMutex |
| 242 | mibDbClass func() error |
| 243 | supportedFsms OmciDeviceFsms |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 244 | devState OnuDeviceEvent |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 245 | // for mibUpload |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 246 | mibAuditDelay uint16 |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 247 | |
| 248 | // for mibUpload |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 249 | pMibUploadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later |
| 250 | // for mibDownload |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 251 | pMibDownloadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later |
| 252 | //remark: general usage of pAdapterFsm would require generalization of commChan usage and internal event setting |
| 253 | // within the FSM event procedures |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 254 | omciMessageReceived chan bool //seperate channel needed by DownloadFsm |
| 255 | omciRebootMessageReceivedChannel chan Message // channel needed by Reboot request |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 256 | } |
| 257 | |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 258 | //newOnuDeviceEntry returns a new instance of a OnuDeviceEntry |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 259 | //mib_db (as well as not inluded alarm_db not really used in this code? VERIFY!!) |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 260 | func newOnuDeviceEntry(ctx context.Context, deviceID string, kVStoreHost string, kVStorePort int, kvStoreType string, deviceHandler *deviceHandler, |
Himani Chawla | 26e555c | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 261 | coreProxy adapterif.CoreProxy, adapterProxy adapterif.AdapterProxy, |
| 262 | supportedFsmsPtr *OmciDeviceFsms) *OnuDeviceEntry { |
| 263 | logger.Infow("init-onuDeviceEntry", log.Fields{"device-id": deviceID}) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 264 | var onuDeviceEntry OnuDeviceEntry |
Himani Chawla | 26e555c | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 265 | onuDeviceEntry.deviceID = deviceID |
| 266 | onuDeviceEntry.baseDeviceHandler = deviceHandler |
| 267 | onuDeviceEntry.coreProxy = coreProxy |
| 268 | onuDeviceEntry.adapterProxy = adapterProxy |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 269 | onuDeviceEntry.devState = DeviceStatusInit |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 270 | onuDeviceEntry.sOnuPersistentData.PersUniConfig = make([]uniPersConfig, 0) |
| 271 | onuDeviceEntry.chOnuKvProcessingStep = make(chan uint8) |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 272 | onuDeviceEntry.omciRebootMessageReceivedChannel = make(chan Message, 2048) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 273 | //openomciagent.lockDeviceHandlersMap = sync.RWMutex{} |
| 274 | //OMCI related databases are on a per-agent basis. State machines and tasks |
| 275 | //are per ONU Vendor |
| 276 | // |
| 277 | // MIB Synchronization Database - possible overloading from arguments |
Himani Chawla | 26e555c | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 278 | if supportedFsmsPtr != nil { |
| 279 | onuDeviceEntry.supportedFsms = *supportedFsmsPtr |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 280 | } else { |
| 281 | //var mibSyncFsm = NewMibSynchronizer() |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 282 | // use some internaö defaults, if not defined from outside |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 283 | onuDeviceEntry.supportedFsms = OmciDeviceFsms{ |
| 284 | "mib-synchronizer": { |
| 285 | //mibSyncFsm, // Implements the MIB synchronization state machine |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 286 | onuDeviceEntry.mibDbVolatileDict, // Implements volatile ME MIB database |
Himani Chawla | 4d90833 | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 287 | //true, // Advertise events on OpenOMCI event bus |
| 288 | 60, // Time to wait between MIB audits. 0 to disable audits. |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 289 | // map[string]func() error{ |
| 290 | // "mib-upload": onuDeviceEntry.MibUploadTask, |
| 291 | // "mib-template": onuDeviceEntry.MibTemplateTask, |
| 292 | // "get-mds": onuDeviceEntry.GetMdsTask, |
| 293 | // "mib-audit": onuDeviceEntry.GetMdsTask, |
| 294 | // "mib-resync": onuDeviceEntry.MibResyncTask, |
| 295 | // "mib-reconcile": onuDeviceEntry.MibReconcileTask, |
| 296 | // }, |
| 297 | }, |
| 298 | } |
| 299 | } |
| 300 | onuDeviceEntry.mibDbClass = onuDeviceEntry.supportedFsms["mib-synchronizer"].databaseClass |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 301 | logger.Debug("access2mibDbClass") |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 302 | go onuDeviceEntry.mibDbClass() |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 303 | onuDeviceEntry.mibAuditDelay = onuDeviceEntry.supportedFsms["mib-synchronizer"].auditDelay |
| 304 | logger.Debugw("MibAudit is set to", log.Fields{"Delay": onuDeviceEntry.mibAuditDelay}) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 305 | |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 306 | // Omci related Mib upload sync state machine |
| 307 | mibUploadChan := make(chan Message, 2048) |
Himani Chawla | 26e555c | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 308 | onuDeviceEntry.pMibUploadFsm = NewAdapterFsm("MibUpload", deviceID, mibUploadChan) |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 309 | onuDeviceEntry.pMibUploadFsm.pFsm = fsm.NewFSM( |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 310 | ulStDisabled, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 311 | fsm.Events{ |
| 312 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 313 | {Name: ulEvStart, Src: []string{ulStDisabled}, Dst: ulStStarting}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 314 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 315 | {Name: ulEvResetMib, Src: []string{ulStStarting}, Dst: ulStResettingMib}, |
| 316 | {Name: ulEvGetVendorAndSerial, Src: []string{ulStResettingMib}, Dst: ulStGettingVendorAndSerial}, |
Himani Chawla | 4d90833 | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 317 | {Name: ulEvGetEquipmentID, Src: []string{ulStGettingVendorAndSerial}, Dst: ulStGettingEquipmentID}, |
| 318 | {Name: ulEvGetFirstSwVersion, Src: []string{ulStGettingEquipmentID}, Dst: ulStGettingFirstSwVersion}, |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 319 | {Name: ulEvGetSecondSwVersion, Src: []string{ulStGettingFirstSwVersion}, Dst: ulStGettingSecondSwVersion}, |
| 320 | {Name: ulEvGetMacAddress, Src: []string{ulStGettingSecondSwVersion}, Dst: ulStGettingMacAddress}, |
| 321 | {Name: ulEvGetMibTemplate, Src: []string{ulStGettingMacAddress}, Dst: ulStGettingMibTemplate}, |
Holger Hildebrandt | c54939a | 2020-06-17 08:14:27 +0000 | [diff] [blame] | 322 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 323 | {Name: ulEvUploadMib, Src: []string{ulStGettingMibTemplate}, Dst: ulStUploading}, |
| 324 | {Name: ulEvExamineMds, Src: []string{ulStStarting}, Dst: ulStExaminingMds}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 325 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 326 | {Name: ulEvSuccess, Src: []string{ulStGettingMibTemplate}, Dst: ulStInSync}, |
| 327 | {Name: ulEvSuccess, Src: []string{ulStUploading}, Dst: ulStInSync}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 328 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 329 | {Name: ulEvSuccess, Src: []string{ulStExaminingMds}, Dst: ulStInSync}, |
| 330 | {Name: ulEvMismatch, Src: []string{ulStExaminingMds}, Dst: ulStResynchronizing}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 331 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 332 | {Name: ulEvAuditMib, Src: []string{ulStInSync}, Dst: ulStAuditing}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 333 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 334 | {Name: ulEvSuccess, Src: []string{ulStOutOfSync}, Dst: ulStInSync}, |
| 335 | {Name: ulEvAuditMib, Src: []string{ulStOutOfSync}, Dst: ulStAuditing}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 336 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 337 | {Name: ulEvSuccess, Src: []string{ulStAuditing}, Dst: ulStInSync}, |
| 338 | {Name: ulEvMismatch, Src: []string{ulStAuditing}, Dst: ulStResynchronizing}, |
| 339 | {Name: ulEvForceResync, Src: []string{ulStAuditing}, Dst: ulStResynchronizing}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 340 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 341 | {Name: ulEvSuccess, Src: []string{ulStResynchronizing}, Dst: ulStInSync}, |
| 342 | {Name: ulEvDiffsFound, Src: []string{ulStResynchronizing}, Dst: ulStOutOfSync}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 343 | |
Himani Chawla | 4d90833 | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 344 | {Name: ulEvTimeout, Src: []string{ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentID, ulStGettingFirstSwVersion, |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 345 | ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds, |
| 346 | ulStInSync, ulStOutOfSync, ulStAuditing}, Dst: ulStStarting}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 347 | |
Himani Chawla | 4d90833 | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 348 | {Name: ulEvStop, Src: []string{ulStStarting, ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentID, ulStGettingFirstSwVersion, |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 349 | ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds, |
| 350 | ulStInSync, ulStOutOfSync, ulStAuditing}, Dst: ulStDisabled}, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 351 | }, |
| 352 | |
| 353 | fsm.Callbacks{ |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 354 | "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibUploadFsm.logFsmStateChange(e) }, |
| 355 | ("enter_" + ulStStarting): func(e *fsm.Event) { onuDeviceEntry.enterStartingState(e) }, |
| 356 | ("enter_" + ulStResettingMib): func(e *fsm.Event) { onuDeviceEntry.enterResettingMibState(e) }, |
| 357 | ("enter_" + ulStGettingVendorAndSerial): func(e *fsm.Event) { onuDeviceEntry.enterGettingVendorAndSerialState(e) }, |
Himani Chawla | 4d90833 | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 358 | ("enter_" + ulStGettingEquipmentID): func(e *fsm.Event) { onuDeviceEntry.enterGettingEquipmentIDState(e) }, |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 359 | ("enter_" + ulStGettingFirstSwVersion): func(e *fsm.Event) { onuDeviceEntry.enterGettingFirstSwVersionState(e) }, |
| 360 | ("enter_" + ulStGettingSecondSwVersion): func(e *fsm.Event) { onuDeviceEntry.enterGettingSecondSwVersionState(e) }, |
| 361 | ("enter_" + ulStGettingMacAddress): func(e *fsm.Event) { onuDeviceEntry.enterGettingMacAddressState(e) }, |
| 362 | ("enter_" + ulStGettingMibTemplate): func(e *fsm.Event) { onuDeviceEntry.enterGettingMibTemplate(e) }, |
| 363 | ("enter_" + ulStUploading): func(e *fsm.Event) { onuDeviceEntry.enterUploadingState(e) }, |
| 364 | ("enter_" + ulStExaminingMds): func(e *fsm.Event) { onuDeviceEntry.enterExaminingMdsState(e) }, |
| 365 | ("enter_" + ulStResynchronizing): func(e *fsm.Event) { onuDeviceEntry.enterResynchronizingState(e) }, |
| 366 | ("enter_" + ulStAuditing): func(e *fsm.Event) { onuDeviceEntry.enterAuditingState(e) }, |
| 367 | ("enter_" + ulStOutOfSync): func(e *fsm.Event) { onuDeviceEntry.enterOutOfSyncState(e) }, |
| 368 | ("enter_" + ulStInSync): func(e *fsm.Event) { onuDeviceEntry.enterInSyncState(e) }, |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 369 | }, |
| 370 | ) |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 371 | // Omci related Mib download state machine |
| 372 | mibDownloadChan := make(chan Message, 2048) |
Himani Chawla | 26e555c | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 373 | onuDeviceEntry.pMibDownloadFsm = NewAdapterFsm("MibDownload", deviceID, mibDownloadChan) |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 374 | onuDeviceEntry.pMibDownloadFsm.pFsm = fsm.NewFSM( |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 375 | dlStDisabled, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 376 | fsm.Events{ |
| 377 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 378 | {Name: dlEvStart, Src: []string{dlStDisabled}, Dst: dlStStarting}, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 379 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 380 | {Name: dlEvCreateGal, Src: []string{dlStStarting}, Dst: dlStCreatingGal}, |
| 381 | {Name: dlEvRxGalResp, Src: []string{dlStCreatingGal}, Dst: dlStSettingOnu2g}, |
| 382 | {Name: dlEvRxOnu2gResp, Src: []string{dlStSettingOnu2g}, Dst: dlStBridgeInit}, |
Holger Hildebrandt | dd23cc2 | 2020-05-19 13:32:18 +0000 | [diff] [blame] | 383 | // the bridge state is used for multi ME config for alle UNI related ports |
| 384 | // maybe such could be reflected in the state machine as well (port number parametrized) |
| 385 | // 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] | 386 | {Name: dlEvRxBridgeResp, Src: []string{dlStBridgeInit}, Dst: dlStDownloaded}, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 387 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 388 | {Name: dlEvTimeoutSimple, Src: []string{dlStCreatingGal, dlStSettingOnu2g}, Dst: dlStStarting}, |
| 389 | {Name: dlEvTimeoutBridge, Src: []string{dlStBridgeInit}, Dst: dlStStarting}, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 390 | |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 391 | {Name: dlEvReset, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g, |
| 392 | dlStBridgeInit, dlStDownloaded}, Dst: dlStResetting}, |
| 393 | // exceptional treatment for all states except dlStResetting |
| 394 | {Name: dlEvRestart, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g, |
| 395 | dlStBridgeInit, dlStDownloaded, dlStResetting}, Dst: dlStDisabled}, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 396 | }, |
| 397 | |
| 398 | fsm.Callbacks{ |
mpagenko | 1cc3cb4 | 2020-07-27 15:24:38 +0000 | [diff] [blame] | 399 | "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibDownloadFsm.logFsmStateChange(e) }, |
| 400 | ("enter_" + dlStStarting): func(e *fsm.Event) { onuDeviceEntry.enterDLStartingState(e) }, |
| 401 | ("enter_" + dlStCreatingGal): func(e *fsm.Event) { onuDeviceEntry.enterCreatingGalState(e) }, |
| 402 | ("enter_" + dlStSettingOnu2g): func(e *fsm.Event) { onuDeviceEntry.enterSettingOnu2gState(e) }, |
| 403 | ("enter_" + dlStBridgeInit): func(e *fsm.Event) { onuDeviceEntry.enterBridgeInitState(e) }, |
| 404 | ("enter_" + dlStDownloaded): func(e *fsm.Event) { onuDeviceEntry.enterDownloadedState(e) }, |
| 405 | ("enter_" + dlStResetting): func(e *fsm.Event) { onuDeviceEntry.enterResettingState(e) }, |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 406 | }, |
| 407 | ) |
| 408 | if onuDeviceEntry.pMibDownloadFsm == nil || onuDeviceEntry.pMibDownloadFsm.pFsm == nil { |
Andrea Campanella | 6515c58 | 2020-10-05 11:25:00 +0200 | [diff] [blame] | 409 | logger.Errorw("MibDownloadFsm could not be instantiated", log.Fields{"device-id": deviceID}) |
| 410 | // TODO some specifc error treatment - or waiting for crash ? |
Holger Hildebrandt | 9ac0d0f | 2020-05-13 11:22:02 +0000 | [diff] [blame] | 411 | } |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 412 | |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 413 | onuDeviceEntry.mibTemplateKVStore = onuDeviceEntry.baseDeviceHandler.setBackend(cBasePathMibTemplateKvStore) |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 414 | if onuDeviceEntry.mibTemplateKVStore == nil { |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 415 | logger.Errorw("Can't access mibTemplateKVStore - no backend connection to service", |
| 416 | log.Fields{"device-id": deviceID, "service": cBasePathMibTemplateKvStore}) |
| 417 | } |
| 418 | |
| 419 | onuDeviceEntry.onuKVStorePath = onuDeviceEntry.deviceID |
| 420 | onuDeviceEntry.onuKVStore = onuDeviceEntry.baseDeviceHandler.setBackend(cBasePathOnuKVStore) |
| 421 | if onuDeviceEntry.onuKVStore == nil { |
| 422 | logger.Errorw("Can't access onuKVStore - no backend connection to service", |
| 423 | log.Fields{"device-id": deviceID, "service": cBasePathOnuKVStore}) |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 424 | } |
| 425 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 426 | // Alarm Synchronization Database |
| 427 | //self._alarm_db = None |
| 428 | //self._alarm_database_cls = support_classes['alarm-synchronizer']['database'] |
| 429 | return &onuDeviceEntry |
| 430 | } |
| 431 | |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 432 | //start starts (logs) the omci agent |
| 433 | func (oo *OnuDeviceEntry) start(ctx context.Context) error { |
mpagenko | 900ee4b | 2020-10-12 11:56:34 +0000 | [diff] [blame] | 434 | logger.Infow("OnuDeviceEntry-starting", log.Fields{"for device-id": oo.deviceID}) |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 435 | if oo.PDevOmciCC == nil { |
mpagenko | 900ee4b | 2020-10-12 11:56:34 +0000 | [diff] [blame] | 436 | oo.PDevOmciCC = newOmciCC(ctx, oo, oo.deviceID, oo.baseDeviceHandler, |
| 437 | oo.coreProxy, oo.adapterProxy) |
| 438 | if oo.PDevOmciCC == nil { |
| 439 | logger.Errorw("Could not create devOmciCc - abort", log.Fields{"for device-id": oo.deviceID}) |
| 440 | return fmt.Errorf("could not create devOmciCc %s", oo.deviceID) |
| 441 | } |
Holger Hildebrandt | ccd390c | 2020-05-29 13:49:04 +0000 | [diff] [blame] | 442 | } |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 443 | return nil |
| 444 | } |
| 445 | |
mpagenko | 900ee4b | 2020-10-12 11:56:34 +0000 | [diff] [blame] | 446 | //stop stops/resets the omciCC |
| 447 | func (oo *OnuDeviceEntry) stop(ctx context.Context, abResetOmciCC bool) error { |
| 448 | logger.Debugw("OnuDeviceEntry-stopping", log.Fields{"for device-id": oo.deviceID}) |
| 449 | if abResetOmciCC && (oo.PDevOmciCC != nil) { |
| 450 | _ = oo.PDevOmciCC.stop(ctx) |
| 451 | } |
| 452 | //to allow for all event notifications again when re-using the device and omciCC |
| 453 | oo.devState = DeviceStatusInit |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 454 | return nil |
| 455 | } |
| 456 | |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 457 | func (oo *OnuDeviceEntry) reboot(ctx context.Context) error { |
mpagenko | 900ee4b | 2020-10-12 11:56:34 +0000 | [diff] [blame] | 458 | logger.Debugw("OnuDeviceEntry-rebooting", log.Fields{"for device-id": oo.deviceID}) |
| 459 | if oo.PDevOmciCC != nil { |
| 460 | if err := oo.PDevOmciCC.sendReboot(ctx, ConstDefaultOmciTimeout, true, oo.omciRebootMessageReceivedChannel); err != nil { |
| 461 | logger.Errorw("onu didn't reboot", log.Fields{"for device-id": oo.deviceID}) |
| 462 | return err |
| 463 | } |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 464 | } |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 465 | return nil |
| 466 | } |
| 467 | |
| 468 | func (oo *OnuDeviceEntry) waitForRebootResponse(responseChannel chan Message) error { |
| 469 | select { |
| 470 | case <-time.After(3 * time.Second): //3s was detected to be to less in 8*8 bbsim test with debug Info/Debug |
| 471 | logger.Warnw("Reboot timeout", log.Fields{"for device-id": oo.deviceID}) |
Andrea Campanella | 6515c58 | 2020-10-05 11:25:00 +0200 | [diff] [blame] | 472 | return fmt.Errorf("rebootTimeout") |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 473 | case data := <-responseChannel: |
| 474 | switch data.Data.(OmciMessage).OmciMsg.MessageType { |
| 475 | case omci.RebootResponseType: |
| 476 | { |
| 477 | msgLayer := (*data.Data.(OmciMessage).OmciPacket).Layer(omci.LayerTypeRebootResponse) |
| 478 | if msgLayer == nil { |
Andrea Campanella | 6515c58 | 2020-10-05 11:25:00 +0200 | [diff] [blame] | 479 | return fmt.Errorf("omci Msg layer could not be detected for RebootResponseType") |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 480 | } |
Andrea Campanella | bef4e54 | 2020-10-22 11:01:28 +0200 | [diff] [blame] | 481 | msgObj, msgOk := msgLayer.(*omci.RebootResponse) |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 482 | if !msgOk { |
Andrea Campanella | 6515c58 | 2020-10-05 11:25:00 +0200 | [diff] [blame] | 483 | return fmt.Errorf("omci Msg layer could not be assigned for RebootResponseType %s", oo.deviceID) |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 484 | } |
Andrea Campanella | bef4e54 | 2020-10-22 11:01:28 +0200 | [diff] [blame] | 485 | logger.Debugw("RebootResponse data", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj}) |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 486 | if msgObj.Result != me.Success { |
mpagenko | 01e726e | 2020-10-23 09:45:29 +0000 | [diff] [blame] | 487 | logger.Errorw("Omci RebootResponse result error", log.Fields{"device-id": oo.deviceID, "Error": msgObj.Result}) |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 488 | // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display? |
Andrea Campanella | bef4e54 | 2020-10-22 11:01:28 +0200 | [diff] [blame] | 489 | return fmt.Errorf("omci RebootResponse result error indication %s for device %s", |
Andrea Campanella | 6515c58 | 2020-10-05 11:25:00 +0200 | [diff] [blame] | 490 | msgObj.Result, oo.deviceID) |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 491 | } |
| 492 | return nil |
| 493 | } |
| 494 | } |
mpagenko | 01e726e | 2020-10-23 09:45:29 +0000 | [diff] [blame] | 495 | logger.Warnw("Reboot response message type error", log.Fields{"for device-id": oo.deviceID}) |
Andrea Campanella | 6515c58 | 2020-10-05 11:25:00 +0200 | [diff] [blame] | 496 | return fmt.Errorf("unexpected OmciResponse type received %s", oo.deviceID) |
ozgecanetsia | e11479f | 2020-07-06 09:44:47 +0300 | [diff] [blame] | 497 | } |
| 498 | } |
| 499 | |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 500 | //Relay the InSync message via Handler to Rw core - Status update |
Himani Chawla | 26e555c | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 501 | func (oo *OnuDeviceEntry) transferSystemEvent(devEvent OnuDeviceEvent) { |
| 502 | logger.Debugw("relaying system-event", log.Fields{"Event": devEvent}) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 503 | // decouple the handler transfer from further processing here |
| 504 | // TODO!!! check if really no synch is required within the system e.g. to ensure following steps .. |
Himani Chawla | 26e555c | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 505 | if devEvent == MibDatabaseSync { |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 506 | if oo.devState < MibDatabaseSync { //devState has not been synced yet |
| 507 | oo.devState = MibDatabaseSync |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 508 | go oo.baseDeviceHandler.deviceProcStatusUpdate(devEvent) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 509 | //TODO!!! device control: next step: start MIB capability verification from here ?!!! |
| 510 | } else { |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 511 | logger.Debugw("mibinsync-event in some already synced state - ignored", log.Fields{"state": oo.devState}) |
| 512 | } |
Himani Chawla | 26e555c | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 513 | } else if devEvent == MibDownloadDone { |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 514 | if oo.devState < MibDownloadDone { //devState has not been synced yet |
| 515 | oo.devState = MibDownloadDone |
Himani Chawla | 6d2ae15 | 2020-09-02 13:11:20 +0530 | [diff] [blame] | 516 | go oo.baseDeviceHandler.deviceProcStatusUpdate(devEvent) |
Holger Hildebrandt | 0f9b88d | 2020-04-20 13:33:25 +0000 | [diff] [blame] | 517 | } else { |
| 518 | 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] | 519 | } |
| 520 | } else { |
Himani Chawla | 26e555c | 2020-08-31 12:30:20 +0530 | [diff] [blame] | 521 | logger.Warnw("device-event not yet handled", log.Fields{"state": devEvent}) |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 522 | } |
Holger Hildebrandt | fa07499 | 2020-03-27 15:42:06 +0000 | [diff] [blame] | 523 | } |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 524 | |
| 525 | func (oo *OnuDeviceEntry) restoreDataFromOnuKvStore(ctx context.Context) error { |
| 526 | if oo.onuKVStore == nil { |
| 527 | logger.Debugw("onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID}) |
| 528 | return fmt.Errorf(fmt.Sprintf("onuKVStore-not-set-abort-%s", oo.deviceID)) |
| 529 | } |
| 530 | oo.sOnuPersistentData = onuPersistentData{0, 0, "", "", "", make([]uniPersConfig, 0)} |
| 531 | Value, err := oo.onuKVStore.Get(ctx, oo.onuKVStorePath) |
| 532 | if err == nil { |
| 533 | if Value != nil { |
| 534 | logger.Debugw("ONU-data read", |
| 535 | log.Fields{"Key": Value.Key, "device-id": oo.deviceID}) |
| 536 | tmpBytes, _ := kvstore.ToByte(Value.Value) |
| 537 | |
| 538 | if err = json.Unmarshal(tmpBytes, &oo.sOnuPersistentData); err != nil { |
| 539 | logger.Errorw("unable to unmarshal ONU-data", log.Fields{"error": err, "device-id": oo.deviceID}) |
| 540 | return fmt.Errorf(fmt.Sprintf("unable-to-unmarshal-ONU-data-%s", oo.deviceID)) |
| 541 | } |
| 542 | logger.Debugw("ONU-data", log.Fields{"sOnuPersistentData": oo.sOnuPersistentData, |
| 543 | "device-id": oo.deviceID}) |
| 544 | } else { |
mpagenko | 2418ab0 | 2020-11-12 12:58:06 +0000 | [diff] [blame^] | 545 | logger.Debugw("no ONU-data found", log.Fields{"path": oo.onuKVStorePath, "device-id": oo.deviceID}) |
| 546 | return fmt.Errorf("no-ONU-data-found") |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 547 | } |
| 548 | } else { |
| 549 | logger.Errorw("unable to read from KVstore", log.Fields{"device-id": oo.deviceID}) |
| 550 | return fmt.Errorf(fmt.Sprintf("unable-to-read-from-KVstore-%s", oo.deviceID)) |
| 551 | } |
| 552 | return nil |
| 553 | } |
| 554 | |
| 555 | func (oo *OnuDeviceEntry) deleteDataFromOnuKvStore(ctx context.Context, wg *sync.WaitGroup) { |
| 556 | defer wg.Done() |
| 557 | |
| 558 | if oo.onuKVStore == nil { |
| 559 | logger.Debugw("onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID}) |
| 560 | oo.onuKVStoreprocResult = errors.New("onu-data delete aborted: onuKVStore not set") |
| 561 | return |
| 562 | } |
| 563 | var processingStep uint8 = 1 // used to synchronize the different processing steps with chOnuKvProcessingStep |
| 564 | go oo.deletePersistentData(ctx, processingStep) |
| 565 | if !oo.waitForTimeoutOrCompletion(ctx, oo.chOnuKvProcessingStep, processingStep) { |
| 566 | //timeout or error detected |
| 567 | logger.Debugw("ONU-data not deleted - abort", log.Fields{"device-id": oo.deviceID}) |
| 568 | oo.onuKVStoreprocResult = errors.New("onu-data delete aborted: during kv-access") |
| 569 | return |
| 570 | } |
| 571 | } |
| 572 | |
| 573 | func (oo *OnuDeviceEntry) deletePersistentData(ctx context.Context, aProcessingStep uint8) { |
| 574 | |
mpagenko | 2418ab0 | 2020-11-12 12:58:06 +0000 | [diff] [blame^] | 575 | logger.Debugw("delete and clear internal persistency data", log.Fields{"device-id": oo.deviceID}) |
| 576 | oo.sOnuPersistentData.PersUniConfig = nil //releasing all UniConfig entries to garbage collector |
| 577 | oo.sOnuPersistentData = onuPersistentData{0, 0, "", "", "", make([]uniPersConfig, 0)} //default entry |
| 578 | |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 579 | logger.Debugw("delete ONU-data from KVStore", log.Fields{"device-id": oo.deviceID}) |
| 580 | err := oo.onuKVStore.Delete(ctx, oo.onuKVStorePath) |
| 581 | if err != nil { |
| 582 | logger.Errorw("unable to delete in KVstore", log.Fields{"device-id": oo.deviceID, "err": err}) |
| 583 | oo.chOnuKvProcessingStep <- 0 //error indication |
| 584 | return |
| 585 | } |
| 586 | oo.chOnuKvProcessingStep <- aProcessingStep //done |
| 587 | } |
| 588 | |
| 589 | func (oo *OnuDeviceEntry) updateOnuKvStore(ctx context.Context, wg *sync.WaitGroup) { |
| 590 | defer wg.Done() |
| 591 | |
| 592 | if oo.onuKVStore == nil { |
| 593 | logger.Debugw("onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID}) |
| 594 | oo.onuKVStoreprocResult = errors.New("onu-data update aborted: onuKVStore not set") |
| 595 | return |
| 596 | } |
| 597 | var processingStep uint8 = 1 // used to synchronize the different processing steps with chOnuKvProcessingStep |
| 598 | go oo.storeDataInOnuKvStore(ctx, processingStep) |
| 599 | if !oo.waitForTimeoutOrCompletion(ctx, oo.chOnuKvProcessingStep, processingStep) { |
| 600 | //timeout or error detected |
| 601 | logger.Debugw("ONU-data not written - abort", log.Fields{"device-id": oo.deviceID}) |
| 602 | oo.onuKVStoreprocResult = errors.New("onu-data update aborted: during writing process") |
| 603 | return |
| 604 | } |
| 605 | } |
| 606 | |
| 607 | func (oo *OnuDeviceEntry) storeDataInOnuKvStore(ctx context.Context, aProcessingStep uint8) { |
| 608 | |
| 609 | //assign values which are not already present when newOnuDeviceEntry() is called |
| 610 | oo.sOnuPersistentData.PersOnuID = oo.baseDeviceHandler.pOnuIndication.OnuId |
| 611 | oo.sOnuPersistentData.PersIntfID = oo.baseDeviceHandler.pOnuIndication.IntfId |
| 612 | oo.sOnuPersistentData.PersSnr = oo.baseDeviceHandler.pOnuOmciDevice.serialNumber |
| 613 | //TODO: verify usage of these values during restart UC |
| 614 | oo.sOnuPersistentData.PersAdminState = "up" |
| 615 | oo.sOnuPersistentData.PersOperState = "active" |
| 616 | |
| 617 | logger.Debugw("Update ONU-data in KVStore", log.Fields{"device-id": oo.deviceID, "sOnuPersistentData": oo.sOnuPersistentData}) |
| 618 | |
| 619 | Value, err := json.Marshal(oo.sOnuPersistentData) |
| 620 | if err != nil { |
| 621 | logger.Errorw("unable to marshal ONU-data", log.Fields{"sOnuPersistentData": oo.sOnuPersistentData, |
| 622 | "device-id": oo.deviceID, "err": err}) |
| 623 | oo.chOnuKvProcessingStep <- 0 //error indication |
| 624 | return |
| 625 | } |
| 626 | err = oo.onuKVStore.Put(ctx, oo.onuKVStorePath, Value) |
| 627 | if err != nil { |
| 628 | logger.Errorw("unable to write ONU-data into KVstore", log.Fields{"device-id": oo.deviceID, "err": err}) |
| 629 | oo.chOnuKvProcessingStep <- 0 //error indication |
| 630 | return |
| 631 | } |
| 632 | oo.chOnuKvProcessingStep <- aProcessingStep //done |
| 633 | } |
| 634 | |
| 635 | func (oo *OnuDeviceEntry) updateOnuUniTpPath(aUniID uint8, aPathString string) bool { |
| 636 | /* within some specific InterAdapter processing request write/read access to data is ensured to be sequentially, |
| 637 | as also the complete sequence is ensured to 'run to completion' before some new request is accepted |
| 638 | no specific concurrency protection to sOnuPersistentData is required here |
| 639 | */ |
| 640 | for k, v := range oo.sOnuPersistentData.PersUniConfig { |
| 641 | if v.PersUniID == aUniID { |
| 642 | logger.Debugw("PersUniConfig-entry already exists", log.Fields{"device-id": oo.deviceID, "uniID": aUniID}) |
| 643 | existingPath := oo.sOnuPersistentData.PersUniConfig[k].PersTpPath |
| 644 | if existingPath != aPathString { |
| 645 | if aPathString == "" { |
| 646 | //existing entry to be deleted |
| 647 | logger.Debugw("UniTp delete path value", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString}) |
| 648 | oo.sOnuPersistentData.PersUniConfig[k].PersTpPath = "" |
| 649 | } else { |
| 650 | //existing entry to be modified |
| 651 | logger.Debugw("UniTp modify path value", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString}) |
| 652 | oo.sOnuPersistentData.PersUniConfig[k].PersTpPath = aPathString |
| 653 | } |
| 654 | return true |
| 655 | } |
| 656 | //entry already exists |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 657 | if aPathString == "" { |
| 658 | //no active TechProfile |
| 659 | logger.Debugw("UniTp path has already been removed - no AniSide config to be removed", log.Fields{ |
| 660 | "device-id": oo.deviceID, "uniID": aUniID}) |
| 661 | // attention 201105: this block is at the moment entered for each of subsequent GemPortDeletes and TContDelete |
| 662 | // as the path is already cleared with the first GemPort - this will probably change with the upcoming real |
| 663 | // TechProfile removal (still TODO), but anyway the reasonUpdate initiated here should not harm overall behavior |
| 664 | go oo.baseDeviceHandler.deviceProcStatusUpdate(OmciAniResourceRemoved) |
| 665 | // no flow config pending on 'remove' so far |
| 666 | } else { |
| 667 | //the given TechProfile already exists and is assumed to be active - update devReason as if the config has been done here |
| 668 | //was needed e.g. in voltha POD Tests:Validate authentication on a disabled ONU |
| 669 | // (as here the TechProfile has not been removed with the disable-device before the new enable-device) |
| 670 | logger.Debugw("UniTp path already exists - TechProfile supposed to be active", log.Fields{ |
| 671 | "device-id": oo.deviceID, "uniID": aUniID, "path": aPathString}) |
| 672 | //no deviceReason update (deviceProcStatusUpdate) here to ensure 'omci_flows_pushed' state within disable/enable procedure of ATT scenario |
| 673 | // (during which the flows are removed/re-assigned but the techProf is left active) |
| 674 | //and as the TechProfile is regarded as active we have to verify, if some flow configuration still waits on it |
| 675 | // (should not be the case, but should not harm or be more robust ...) |
mpagenko | 2418ab0 | 2020-11-12 12:58:06 +0000 | [diff] [blame^] | 676 | // and to be sure, that for some reason the corresponding TpDelete was lost somewhere in history |
| 677 | // we also reset a possibly outstanding delete request - repeated TpConfig is regarded as valid for waiting flow config |
| 678 | if oo.baseDeviceHandler.pOnuTP != nil { |
| 679 | oo.baseDeviceHandler.pOnuTP.setProfileToDelete(aUniID, false) |
| 680 | } |
mpagenko | fc4f56e | 2020-11-04 17:17:49 +0000 | [diff] [blame] | 681 | go oo.baseDeviceHandler.VerifyVlanConfigRequest(aUniID) |
| 682 | } |
| 683 | return false //indicate 'no change' - nothing more to do, TechProf inter-adapter message is return with success anyway here |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 684 | } |
| 685 | } |
| 686 | //no entry exists for uniId |
| 687 | |
| 688 | if aPathString == "" { |
| 689 | //delete request in non-existing state , accept as no change |
| 690 | logger.Debugw("UniTp path already removed", log.Fields{"device-id": oo.deviceID, "uniID": aUniID}) |
| 691 | return false |
| 692 | } |
| 693 | //new entry to be created |
| 694 | logger.Debugw("New UniTp path set", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString}) |
| 695 | oo.sOnuPersistentData.PersUniConfig = |
| 696 | append(oo.sOnuPersistentData.PersUniConfig, uniPersConfig{PersUniID: aUniID, PersTpPath: aPathString, PersFlowParams: make([]uniVlanFlowParams, 0)}) |
| 697 | return true |
| 698 | } |
| 699 | |
Holger Hildebrandt | 47555e7 | 2020-09-21 11:07:24 +0000 | [diff] [blame] | 700 | func (oo *OnuDeviceEntry) updateOnuUniFlowConfig(aUniID uint8, aUniVlanFlowParams *[]uniVlanFlowParams) { |
| 701 | |
| 702 | for k, v := range oo.sOnuPersistentData.PersUniConfig { |
| 703 | if v.PersUniID == aUniID { |
| 704 | oo.sOnuPersistentData.PersUniConfig[k].PersFlowParams = make([]uniVlanFlowParams, len(*aUniVlanFlowParams)) |
| 705 | copy(oo.sOnuPersistentData.PersUniConfig[k].PersFlowParams, *aUniVlanFlowParams) |
| 706 | return |
| 707 | } |
| 708 | } |
| 709 | //flow update was faster than tp-config - create PersUniConfig-entry |
| 710 | tmpConfig := uniPersConfig{PersUniID: aUniID, PersTpPath: "", PersFlowParams: make([]uniVlanFlowParams, len(*aUniVlanFlowParams))} |
| 711 | copy(tmpConfig.PersFlowParams, *aUniVlanFlowParams) |
| 712 | oo.sOnuPersistentData.PersUniConfig = append(oo.sOnuPersistentData.PersUniConfig, tmpConfig) |
| 713 | } |
| 714 | |
| 715 | func (oo *OnuDeviceEntry) waitForTimeoutOrCompletion( |
| 716 | ctx context.Context, aChOnuProcessingStep <-chan uint8, aProcessingStep uint8) bool { |
| 717 | select { |
| 718 | case <-ctx.Done(): |
| 719 | logger.Warnw("processing not completed in-time!", |
| 720 | log.Fields{"device-id": oo.deviceID, "error": ctx.Err()}) |
| 721 | return false |
| 722 | case rxStep := <-aChOnuProcessingStep: |
| 723 | if rxStep == aProcessingStep { |
| 724 | return true |
| 725 | } |
| 726 | //all other values are not accepted - including 0 for error indication |
| 727 | logger.Warnw("Invalid processing step received: abort!", |
| 728 | log.Fields{"device-id": oo.deviceID, |
| 729 | "wantedStep": aProcessingStep, "haveStep": rxStep}) |
| 730 | return false |
| 731 | } |
| 732 | } |
| 733 | |
| 734 | func (oo *OnuDeviceEntry) resetKvProcessingErrorIndication() { |
| 735 | oo.onuKVStoreprocResult = nil |
| 736 | } |
| 737 | func (oo *OnuDeviceEntry) getKvProcessingErrorIndication() error { |
| 738 | return oo.onuKVStoreprocResult |
| 739 | } |
| 740 | |
| 741 | func (oo *OnuDeviceEntry) lockOnuKVStoreMutex() { |
| 742 | oo.onuKVStoreMutex.Lock() |
| 743 | } |
| 744 | |
| 745 | func (oo *OnuDeviceEntry) unlockOnuKVStoreMutex() { |
| 746 | oo.onuKVStoreMutex.Unlock() |
| 747 | } |