blob: b65b055f3a0bc942f330dfe230bc73b7b9bdf8b1 [file] [log] [blame]
Holger Hildebrandtfa074992020-03-27 15:42:06 +00001/*
2 * Copyright 2020-present Open Networking Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000017//Package adaptercoreonu provides the utility for onu devices, flows and statistics
18package adaptercoreonu
Holger Hildebrandtfa074992020-03-27 15:42:06 +000019
20import (
21 "context"
Holger Hildebrandt47555e72020-09-21 11:07:24 +000022 "encoding/json"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000023 "errors"
Holger Hildebrandt47555e72020-09-21 11:07:24 +000024 "fmt"
25 "sync"
Holger Hildebrandt2ff21f12020-08-13 14:38:02 +000026 "time"
27
ozgecanetsiae11479f2020-07-06 09:44:47 +030028 "github.com/opencord/omci-lib-go"
29 me "github.com/opencord/omci-lib-go/generated"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000030
Holger Hildebrandtfa074992020-03-27 15:42:06 +000031 //"sync"
32 //"time"
33
34 "github.com/looplab/fsm"
dbainbri4d3a0dc2020-12-02 00:33:42 +000035 "github.com/opencord/voltha-lib-go/v4/pkg/adapters/adapterif"
36 "github.com/opencord/voltha-lib-go/v4/pkg/db"
37 "github.com/opencord/voltha-lib-go/v4/pkg/db/kvstore"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000038
dbainbri4d3a0dc2020-12-02 00:33:42 +000039 //"github.com/opencord/voltha-lib-go/v4/pkg/kafka"
40 "github.com/opencord/voltha-lib-go/v4/pkg/log"
41 //ic "github.com/opencord/voltha-protos/v4/go/inter_container"
42 //"github.com/opencord/voltha-protos/v4/go/openflow_13"
43 //"github.com/opencord/voltha-protos/v4/go/voltha"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000044)
45
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000046const (
mpagenko1cc3cb42020-07-27 15:24:38 +000047 // events of MibUpload FSM
48 ulEvStart = "ulEvStart"
49 ulEvResetMib = "ulEvResetMib"
50 ulEvGetVendorAndSerial = "ulEvGetVendorAndSerial"
Himani Chawla4d908332020-08-31 12:30:20 +053051 ulEvGetEquipmentID = "ulEvGetEquipmentId"
mpagenko1cc3cb42020-07-27 15:24:38 +000052 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)
66const (
67 // states of MibUpload FSM
68 ulStDisabled = "ulStDisabled"
69 ulStStarting = "ulStStarting"
70 ulStResettingMib = "ulStResettingMib"
71 ulStGettingVendorAndSerial = "ulStGettingVendorAndSerial"
Himani Chawla4d908332020-08-31 12:30:20 +053072 ulStGettingEquipmentID = "ulStGettingEquipmentID"
mpagenko1cc3cb42020-07-27 15:24:38 +000073 ulStGettingFirstSwVersion = "ulStGettingFirstSwVersion"
74 ulStGettingSecondSwVersion = "ulStGettingSecondSwVersion"
75 ulStGettingMacAddress = "ulStGettingMacAddress"
76 ulStGettingMibTemplate = "ulStGettingMibTemplate"
77 ulStUploading = "ulStUploading"
Holger Hildebrandt10d98192021-01-27 15:29:31 +000078 ulStUploadDone = "ulStUploadDone"
mpagenko1cc3cb42020-07-27 15:24:38 +000079 ulStInSync = "ulStInSync"
80 ulStExaminingMds = "ulStExaminingMds"
81 ulStResynchronizing = "ulStResynchronizing"
82 ulStAuditing = "ulStAuditing"
Holger Hildebrandt10d98192021-01-27 15:29:31 +000083 ulStReAuditing = "ulStReAuditing"
mpagenko1cc3cb42020-07-27 15:24:38 +000084 ulStOutOfSync = "ulStOutOfSync"
85)
Holger Hildebrandt10d98192021-01-27 15:29:31 +000086const cMibUlFsmIdleState = ulStInSync
mpagenko1cc3cb42020-07-27 15:24:38 +000087
88const (
89 // events of MibDownload FSM
90 dlEvStart = "dlEvStart"
91 dlEvCreateGal = "dlEvCreateGal"
92 dlEvRxGalResp = "dlEvRxGalResp"
93 dlEvRxOnu2gResp = "dlEvRxOnu2gResp"
94 dlEvRxBridgeResp = "dlEvRxBridgeResp"
95 dlEvTimeoutSimple = "dlEvTimeoutSimple"
96 dlEvTimeoutBridge = "dlEvTimeoutBridge"
97 dlEvReset = "dlEvReset"
98 dlEvRestart = "dlEvRestart"
99)
100const (
101 // states of MibDownload FSM
102 dlStDisabled = "dlStDisabled"
103 dlStStarting = "dlStStarting"
104 dlStCreatingGal = "dlStCreatingGal"
105 dlStSettingOnu2g = "dlStSettingOnu2g"
106 dlStBridgeInit = "dlStBridgeInit"
107 dlStDownloaded = "dlStDownloaded"
108 dlStResetting = "dlStResetting"
109)
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000110const cMibDlFsmIdleState = dlStDisabled
mpagenko1cc3cb42020-07-27 15:24:38 +0000111
112const (
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800113 // NOTE that this hardcoded to service/voltha as the MIB template is shared across stacks
Holger Hildebrandt2ff21f12020-08-13 14:38:02 +0000114 cBasePathMibTemplateKvStore = "service/voltha/omci_mibs/go_templates"
mpagenkoaf801632020-07-03 10:00:42 +0000115 cSuffixMibTemplateKvStore = "%s/%s/%s"
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800116 cBasePathOnuKVStore = "%s/openonu"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000117)
118
Himani Chawla6d2ae152020-09-02 13:11:20 +0530119// OnuDeviceEvent - event of interest to Device Adapters and OpenOMCI State Machines
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000120type OnuDeviceEvent int
121
122const (
123 // Events of interest to Device Adapters and OpenOMCI State Machines
Himani Chawla6d2ae152020-09-02 13:11:20 +0530124
125 // DeviceStatusInit - default start state
mpagenkofc4f56e2020-11-04 17:17:49 +0000126 DeviceStatusInit OnuDeviceEvent = iota
Himani Chawla6d2ae152020-09-02 13:11:20 +0530127 // MibDatabaseSync - MIB database sync (upload done)
mpagenkofc4f56e2020-11-04 17:17:49 +0000128 MibDatabaseSync
Himani Chawla6d2ae152020-09-02 13:11:20 +0530129 // OmciCapabilitiesDone - OMCI ME and message type capabilities known
mpagenkofc4f56e2020-11-04 17:17:49 +0000130 OmciCapabilitiesDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530131 // MibDownloadDone - // MIB download done
mpagenkofc4f56e2020-11-04 17:17:49 +0000132 MibDownloadDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530133 // UniLockStateDone - Uni ports admin set to lock
mpagenkofc4f56e2020-11-04 17:17:49 +0000134 UniLockStateDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530135 // UniUnlockStateDone - Uni ports admin set to unlock
mpagenkofc4f56e2020-11-04 17:17:49 +0000136 UniUnlockStateDone
mpagenko900ee4b2020-10-12 11:56:34 +0000137 // UniDisableStateDone - Uni ports admin set to lock based on device disable
mpagenkofc4f56e2020-11-04 17:17:49 +0000138 UniDisableStateDone
mpagenko900ee4b2020-10-12 11:56:34 +0000139 // UniEnableStateDone - Uni ports admin set to unlock based on device re-enable
mpagenkofc4f56e2020-11-04 17:17:49 +0000140 UniEnableStateDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530141 // PortLinkUp - Port link state change
mpagenkofc4f56e2020-11-04 17:17:49 +0000142 PortLinkUp
Himani Chawla6d2ae152020-09-02 13:11:20 +0530143 // PortLinkDw - Port link state change
mpagenkofc4f56e2020-11-04 17:17:49 +0000144 PortLinkDw
Himani Chawla6d2ae152020-09-02 13:11:20 +0530145 // OmciAniConfigDone - AniSide config according to TechProfile done
mpagenkofc4f56e2020-11-04 17:17:49 +0000146 OmciAniConfigDone
147 // OmciAniResourceRemoved - AniSide TechProfile related resource (Gem/TCont) removed
148 OmciAniResourceRemoved // needs to be the successor of OmciAniConfigDone!
149 // OmciVlanFilterAddDone - Omci Vlan config done according to flow-add
150 OmciVlanFilterAddDone
151 // OmciVlanFilterRemDone - Omci Vlan config done according to flow-remove
152 OmciVlanFilterRemDone // needs to be the successor of OmciVlanFilterAddDone!
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000153 // Add other events here as needed (alarms separate???)
154)
155
156type activityDescr struct {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000157 databaseClass func(context.Context) error
Himani Chawla4d908332020-08-31 12:30:20 +0530158 //advertiseEvents bool
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000159 auditInterval time.Duration
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000160 //tasks map[string]func() error
161}
Himani Chawla6d2ae152020-09-02 13:11:20 +0530162
163// OmciDeviceFsms - FSM event mapping to database class and time to wait between audits
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000164type OmciDeviceFsms map[string]activityDescr
165
Himani Chawla6d2ae152020-09-02 13:11:20 +0530166// AdapterFsm - Adapter FSM details including channel, event and device
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000167type AdapterFsm struct {
168 fsmName string
169 deviceID string
170 commChan chan Message
171 pFsm *fsm.FSM
172}
173
Himani Chawla6d2ae152020-09-02 13:11:20 +0530174//NewAdapterFsm - FSM details including event, device and channel.
175func NewAdapterFsm(aName string, aDeviceID string, aCommChannel chan Message) *AdapterFsm {
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000176 aFsm := &AdapterFsm{
Himani Chawla6d2ae152020-09-02 13:11:20 +0530177 fsmName: aName,
178 deviceID: aDeviceID,
179 commChan: aCommChannel,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000180 }
181 return aFsm
182}
183
184//Start starts (logs) the omci agent
dbainbri4d3a0dc2020-12-02 00:33:42 +0000185func (oo *AdapterFsm) logFsmStateChange(ctx context.Context, e *fsm.Event) {
186 logger.Debugw(ctx, "FSM state change", log.Fields{"device-id": oo.deviceID, "FSM name": oo.fsmName,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000187 "event name": string(e.Event), "src state": string(e.Src), "dst state": string(e.Dst)})
188}
189
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000190//OntDeviceEntry structure holds information about the attached FSM'as and their communication
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000191
192const (
Himani Chawla6d2ae152020-09-02 13:11:20 +0530193 firstSwImageMeID = 0
194 secondSwImageMeID = 1
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000195)
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000196const onuDataMeID = 0
Himani Chawla6d2ae152020-09-02 13:11:20 +0530197const onugMeID = 0
198const onu2gMeID = 0
199const ipHostConfigDataMeID = 1
200const onugSerialNumberLen = 8
201const omciMacAddressLen = 6
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000202
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000203const cEmptyMacAddrString = "000000000000"
204const cEmptySerialNumberString = "0000000000000000"
205
Himani Chawla6d2ae152020-09-02 13:11:20 +0530206type swImages struct {
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000207 version string
208 isActive uint8
209}
210
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000211type uniPersConfig struct {
212 PersUniID uint8 `json:"uni_id"`
Girish Gowdra041dcb32020-11-16 16:54:30 -0800213 PersTpPathMap map[uint8]string `json:"PersTpPathMap"` // tp-id to tp-path map
214 PersFlowParams []uniVlanFlowParams `json:"flow_params"` //as defined in omci_ani_config.go
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000215}
216
217type onuPersistentData struct {
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000218 PersOnuID uint32 `json:"onu_id"`
219 PersIntfID uint32 `json:"intf_id"`
220 PersSnr string `json:"serial_number"`
221 PersAdminState string `json:"admin_state"`
222 PersOperState string `json:"oper_state"`
223 PersUniUnlockDone bool `json:"uni_unlock_done"`
224 PersUniDisableDone bool `json:"uni_disable_done"`
225 PersMibAuditInterval time.Duration `json:"mib_audit_interval"`
226 PersMibLastDbSync uint32 `json:"mib_last_db_sync"`
227 PersMibDataSyncAdpt uint8 `json:"mib_data_sync_adpt"`
228 PersUniConfig []uniPersConfig `json:"uni_config"`
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000229}
230
Himani Chawla6d2ae152020-09-02 13:11:20 +0530231// OnuDeviceEntry - ONU device info and FSM events.
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000232type OnuDeviceEntry struct {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000233 deviceID string
234 baseDeviceHandler *deviceHandler
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000235 pOpenOnuAc *OpenONUAC
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000236 coreProxy adapterif.CoreProxy
237 adapterProxy adapterif.AdapterProxy
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000238 PDevOmciCC *omciCC
239 pOnuDB *onuDeviceDB
240 mibTemplateKVStore *db.Backend
241 sOnuPersistentData onuPersistentData
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000242 mibTemplatePath string
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000243 onuKVStoreMutex sync.RWMutex
244 onuKVStore *db.Backend
245 onuKVStorePath string
246 onuKVStoreprocResult error //error indication of processing
247 chOnuKvProcessingStep chan uint8
248 vendorID string
249 serialNumber string
250 equipmentID string
251 swImages [secondSwImageMeID + 1]swImages
252 activeSwVersion string
253 macAddress string
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000254 //lockDeviceEntries sync.RWMutex
dbainbri4d3a0dc2020-12-02 00:33:42 +0000255 mibDbClass func(context.Context) error
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000256 supportedFsms OmciDeviceFsms
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000257 devState OnuDeviceEvent
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000258 // Audit and MDS
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000259 mibAuditInterval time.Duration
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000260 // TODO: periodical mib resync will be implemented with story VOL-3792
261 //mibNextDbResync uint32
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000262
263 // for mibUpload
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000264 pMibUploadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later
265 // for mibDownload
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000266 pMibDownloadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later
267 //remark: general usage of pAdapterFsm would require generalization of commChan usage and internal event setting
268 // within the FSM event procedures
ozgecanetsiae11479f2020-07-06 09:44:47 +0300269 omciMessageReceived chan bool //seperate channel needed by DownloadFsm
270 omciRebootMessageReceivedChannel chan Message // channel needed by Reboot request
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000271}
272
Himani Chawla6d2ae152020-09-02 13:11:20 +0530273//newOnuDeviceEntry returns a new instance of a OnuDeviceEntry
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000274//mib_db (as well as not inluded alarm_db not really used in this code? VERIFY!!)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000275func newOnuDeviceEntry(ctx context.Context, dh *deviceHandler) *OnuDeviceEntry {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000276 logger.Debugw(ctx, "init-onuDeviceEntry", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000277 var onuDeviceEntry OnuDeviceEntry
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000278 onuDeviceEntry.deviceID = dh.deviceID
279 onuDeviceEntry.baseDeviceHandler = dh
280 onuDeviceEntry.pOpenOnuAc = dh.pOpenOnuAc
281 onuDeviceEntry.coreProxy = dh.coreProxy
282 onuDeviceEntry.adapterProxy = dh.AdapterProxy
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000283 onuDeviceEntry.devState = DeviceStatusInit
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000284 onuDeviceEntry.sOnuPersistentData.PersUniConfig = make([]uniPersConfig, 0)
285 onuDeviceEntry.chOnuKvProcessingStep = make(chan uint8)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300286 onuDeviceEntry.omciRebootMessageReceivedChannel = make(chan Message, 2048)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000287 //openomciagent.lockDeviceHandlersMap = sync.RWMutex{}
288 //OMCI related databases are on a per-agent basis. State machines and tasks
289 //are per ONU Vendor
290 //
291 // MIB Synchronization Database - possible overloading from arguments
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000292 if dh.pOpenOnuAc.pSupportedFsms != nil {
293 onuDeviceEntry.supportedFsms = *dh.pOpenOnuAc.pSupportedFsms
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000294 } else {
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000295 // This branch is currently not used and is for potential future usage of alternative MIB Sync FSMs only!
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000296 //var mibSyncFsm = NewMibSynchronizer()
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000297 // use some internal defaults, if not defined from outside
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000298 onuDeviceEntry.supportedFsms = OmciDeviceFsms{
299 "mib-synchronizer": {
300 //mibSyncFsm, // Implements the MIB synchronization state machine
Himani Chawla6d2ae152020-09-02 13:11:20 +0530301 onuDeviceEntry.mibDbVolatileDict, // Implements volatile ME MIB database
Himani Chawla4d908332020-08-31 12:30:20 +0530302 //true, // Advertise events on OpenOMCI event bus
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000303 dh.pOpenOnuAc.mibAuditInterval, // Time to wait between MIB audits. 0 to disable audits.
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000304 // map[string]func() error{
305 // "mib-upload": onuDeviceEntry.MibUploadTask,
306 // "mib-template": onuDeviceEntry.MibTemplateTask,
307 // "get-mds": onuDeviceEntry.GetMdsTask,
308 // "mib-audit": onuDeviceEntry.GetMdsTask,
309 // "mib-resync": onuDeviceEntry.MibResyncTask,
310 // "mib-reconcile": onuDeviceEntry.MibReconcileTask,
311 // },
312 },
313 }
314 }
315 onuDeviceEntry.mibDbClass = onuDeviceEntry.supportedFsms["mib-synchronizer"].databaseClass
dbainbri4d3a0dc2020-12-02 00:33:42 +0000316 logger.Debug(ctx, "access2mibDbClass")
317 go onuDeviceEntry.mibDbClass(ctx)
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000318 if !dh.reconciling {
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000319 onuDeviceEntry.mibAuditInterval = onuDeviceEntry.supportedFsms["mib-synchronizer"].auditInterval
320 onuDeviceEntry.sOnuPersistentData.PersMibAuditInterval = onuDeviceEntry.mibAuditInterval
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000321 } else {
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000322 logger.Debugw(ctx, "reconciling - take audit interval from persistent data", log.Fields{"device-id": dh.deviceID})
323 // TODO: This is a preparation for VOL-VOL-3811 to preserve config history in case of
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000324 // vendor- or deviceID-specific configurations via voltctl-commands
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000325 onuDeviceEntry.mibAuditInterval = onuDeviceEntry.sOnuPersistentData.PersMibAuditInterval
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000326 }
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000327 logger.Debugw(ctx, "MibAudit is set to", log.Fields{"Interval": onuDeviceEntry.mibAuditInterval})
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000328 // TODO: periodical mib resync will be implemented with story VOL-3792
329 //onuDeviceEntry.mibNextDbResync = 0
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000330
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000331 // Omci related Mib upload sync state machine
332 mibUploadChan := make(chan Message, 2048)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000333 onuDeviceEntry.pMibUploadFsm = NewAdapterFsm("MibUpload", dh.deviceID, mibUploadChan)
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000334 onuDeviceEntry.pMibUploadFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000335 ulStDisabled,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000336 fsm.Events{
337
mpagenko1cc3cb42020-07-27 15:24:38 +0000338 {Name: ulEvStart, Src: []string{ulStDisabled}, Dst: ulStStarting},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000339
mpagenko1cc3cb42020-07-27 15:24:38 +0000340 {Name: ulEvResetMib, Src: []string{ulStStarting}, Dst: ulStResettingMib},
341 {Name: ulEvGetVendorAndSerial, Src: []string{ulStResettingMib}, Dst: ulStGettingVendorAndSerial},
Himani Chawla4d908332020-08-31 12:30:20 +0530342 {Name: ulEvGetEquipmentID, Src: []string{ulStGettingVendorAndSerial}, Dst: ulStGettingEquipmentID},
343 {Name: ulEvGetFirstSwVersion, Src: []string{ulStGettingEquipmentID}, Dst: ulStGettingFirstSwVersion},
mpagenko1cc3cb42020-07-27 15:24:38 +0000344 {Name: ulEvGetSecondSwVersion, Src: []string{ulStGettingFirstSwVersion}, Dst: ulStGettingSecondSwVersion},
345 {Name: ulEvGetMacAddress, Src: []string{ulStGettingSecondSwVersion}, Dst: ulStGettingMacAddress},
346 {Name: ulEvGetMibTemplate, Src: []string{ulStGettingMacAddress}, Dst: ulStGettingMibTemplate},
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000347
mpagenko1cc3cb42020-07-27 15:24:38 +0000348 {Name: ulEvUploadMib, Src: []string{ulStGettingMibTemplate}, Dst: ulStUploading},
349 {Name: ulEvExamineMds, Src: []string{ulStStarting}, Dst: ulStExaminingMds},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000350
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000351 {Name: ulEvSuccess, Src: []string{ulStGettingMibTemplate}, Dst: ulStUploadDone},
352 {Name: ulEvSuccess, Src: []string{ulStUploading}, Dst: ulStUploadDone},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000353
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000354 {Name: ulEvSuccess, Src: []string{ulStUploadDone}, Dst: ulStInSync},
mpagenko1cc3cb42020-07-27 15:24:38 +0000355 {Name: ulEvSuccess, Src: []string{ulStExaminingMds}, Dst: ulStInSync},
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000356 // TODO: As long as mib-resynchronizing is not implemented, failed MDS-examination triggers
357 // mib-reset and new provisioning at this point
358 //{Name: ulEvMismatch, Src: []string{ulStExaminingMds}, Dst: ulStResynchronizing},
359 {Name: ulEvMismatch, Src: []string{ulStExaminingMds}, Dst: ulStResettingMib},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000360
mpagenko1cc3cb42020-07-27 15:24:38 +0000361 {Name: ulEvAuditMib, Src: []string{ulStInSync}, Dst: ulStAuditing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000362
mpagenko1cc3cb42020-07-27 15:24:38 +0000363 {Name: ulEvSuccess, Src: []string{ulStOutOfSync}, Dst: ulStInSync},
364 {Name: ulEvAuditMib, Src: []string{ulStOutOfSync}, Dst: ulStAuditing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000365
mpagenko1cc3cb42020-07-27 15:24:38 +0000366 {Name: ulEvSuccess, Src: []string{ulStAuditing}, Dst: ulStInSync},
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000367 {Name: ulEvMismatch, Src: []string{ulStAuditing}, Dst: ulStReAuditing},
mpagenko1cc3cb42020-07-27 15:24:38 +0000368 {Name: ulEvForceResync, Src: []string{ulStAuditing}, Dst: ulStResynchronizing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000369
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000370 {Name: ulEvSuccess, Src: []string{ulStReAuditing}, Dst: ulStInSync},
371 {Name: ulEvMismatch, Src: []string{ulStReAuditing}, Dst: ulStResettingMib},
372
mpagenko1cc3cb42020-07-27 15:24:38 +0000373 {Name: ulEvSuccess, Src: []string{ulStResynchronizing}, Dst: ulStInSync},
374 {Name: ulEvDiffsFound, Src: []string{ulStResynchronizing}, Dst: ulStOutOfSync},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000375
Himani Chawla4d908332020-08-31 12:30:20 +0530376 {Name: ulEvTimeout, Src: []string{ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentID, ulStGettingFirstSwVersion,
mpagenko1cc3cb42020-07-27 15:24:38 +0000377 ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds,
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000378 ulStUploadDone, ulStInSync, ulStOutOfSync, ulStAuditing, ulStReAuditing}, Dst: ulStStarting},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000379
Himani Chawla4d908332020-08-31 12:30:20 +0530380 {Name: ulEvStop, Src: []string{ulStStarting, ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentID, ulStGettingFirstSwVersion,
mpagenko1cc3cb42020-07-27 15:24:38 +0000381 ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds,
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000382 ulStUploadDone, ulStInSync, ulStOutOfSync, ulStAuditing, ulStReAuditing}, Dst: ulStDisabled},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000383 },
384
385 fsm.Callbacks{
dbainbri4d3a0dc2020-12-02 00:33:42 +0000386 "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibUploadFsm.logFsmStateChange(ctx, e) },
387 "enter_" + ulStStarting: func(e *fsm.Event) { onuDeviceEntry.enterStartingState(ctx, e) },
388 "enter_" + ulStResettingMib: func(e *fsm.Event) { onuDeviceEntry.enterResettingMibState(ctx, e) },
389 "enter_" + ulStGettingVendorAndSerial: func(e *fsm.Event) { onuDeviceEntry.enterGettingVendorAndSerialState(ctx, e) },
390 "enter_" + ulStGettingEquipmentID: func(e *fsm.Event) { onuDeviceEntry.enterGettingEquipmentIDState(ctx, e) },
391 "enter_" + ulStGettingFirstSwVersion: func(e *fsm.Event) { onuDeviceEntry.enterGettingFirstSwVersionState(ctx, e) },
392 "enter_" + ulStGettingSecondSwVersion: func(e *fsm.Event) { onuDeviceEntry.enterGettingSecondSwVersionState(ctx, e) },
393 "enter_" + ulStGettingMacAddress: func(e *fsm.Event) { onuDeviceEntry.enterGettingMacAddressState(ctx, e) },
394 "enter_" + ulStGettingMibTemplate: func(e *fsm.Event) { onuDeviceEntry.enterGettingMibTemplate(ctx, e) },
395 "enter_" + ulStUploading: func(e *fsm.Event) { onuDeviceEntry.enterUploadingState(ctx, e) },
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000396 "enter_" + ulStUploadDone: func(e *fsm.Event) { onuDeviceEntry.enterUploadDoneState(ctx, e) },
dbainbri4d3a0dc2020-12-02 00:33:42 +0000397 "enter_" + ulStExaminingMds: func(e *fsm.Event) { onuDeviceEntry.enterExaminingMdsState(ctx, e) },
398 "enter_" + ulStResynchronizing: func(e *fsm.Event) { onuDeviceEntry.enterResynchronizingState(ctx, e) },
399 "enter_" + ulStAuditing: func(e *fsm.Event) { onuDeviceEntry.enterAuditingState(ctx, e) },
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000400 "enter_" + ulStReAuditing: func(e *fsm.Event) { onuDeviceEntry.enterReAuditingState(ctx, e) },
dbainbri4d3a0dc2020-12-02 00:33:42 +0000401 "enter_" + ulStOutOfSync: func(e *fsm.Event) { onuDeviceEntry.enterOutOfSyncState(ctx, e) },
402 "enter_" + ulStInSync: func(e *fsm.Event) { onuDeviceEntry.enterInSyncState(ctx, e) },
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000403 },
404 )
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000405 // Omci related Mib download state machine
406 mibDownloadChan := make(chan Message, 2048)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000407 onuDeviceEntry.pMibDownloadFsm = NewAdapterFsm("MibDownload", dh.deviceID, mibDownloadChan)
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000408 onuDeviceEntry.pMibDownloadFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000409 dlStDisabled,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000410 fsm.Events{
411
mpagenko1cc3cb42020-07-27 15:24:38 +0000412 {Name: dlEvStart, Src: []string{dlStDisabled}, Dst: dlStStarting},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000413
mpagenko1cc3cb42020-07-27 15:24:38 +0000414 {Name: dlEvCreateGal, Src: []string{dlStStarting}, Dst: dlStCreatingGal},
415 {Name: dlEvRxGalResp, Src: []string{dlStCreatingGal}, Dst: dlStSettingOnu2g},
416 {Name: dlEvRxOnu2gResp, Src: []string{dlStSettingOnu2g}, Dst: dlStBridgeInit},
Holger Hildebrandtdd23cc22020-05-19 13:32:18 +0000417 // the bridge state is used for multi ME config for alle UNI related ports
418 // maybe such could be reflected in the state machine as well (port number parametrized)
419 // but that looks not straightforward here - so we keep it simple here for the beginning(?)
mpagenko1cc3cb42020-07-27 15:24:38 +0000420 {Name: dlEvRxBridgeResp, Src: []string{dlStBridgeInit}, Dst: dlStDownloaded},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000421
mpagenko1cc3cb42020-07-27 15:24:38 +0000422 {Name: dlEvTimeoutSimple, Src: []string{dlStCreatingGal, dlStSettingOnu2g}, Dst: dlStStarting},
423 {Name: dlEvTimeoutBridge, Src: []string{dlStBridgeInit}, Dst: dlStStarting},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000424
mpagenko1cc3cb42020-07-27 15:24:38 +0000425 {Name: dlEvReset, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g,
426 dlStBridgeInit, dlStDownloaded}, Dst: dlStResetting},
427 // exceptional treatment for all states except dlStResetting
428 {Name: dlEvRestart, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g,
429 dlStBridgeInit, dlStDownloaded, dlStResetting}, Dst: dlStDisabled},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000430 },
431
432 fsm.Callbacks{
dbainbri4d3a0dc2020-12-02 00:33:42 +0000433 "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibDownloadFsm.logFsmStateChange(ctx, e) },
434 "enter_" + dlStStarting: func(e *fsm.Event) { onuDeviceEntry.enterDLStartingState(ctx, e) },
435 "enter_" + dlStCreatingGal: func(e *fsm.Event) { onuDeviceEntry.enterCreatingGalState(ctx, e) },
436 "enter_" + dlStSettingOnu2g: func(e *fsm.Event) { onuDeviceEntry.enterSettingOnu2gState(ctx, e) },
437 "enter_" + dlStBridgeInit: func(e *fsm.Event) { onuDeviceEntry.enterBridgeInitState(ctx, e) },
438 "enter_" + dlStDownloaded: func(e *fsm.Event) { onuDeviceEntry.enterDownloadedState(ctx, e) },
439 "enter_" + dlStResetting: func(e *fsm.Event) { onuDeviceEntry.enterResettingState(ctx, e) },
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000440 },
441 )
442 if onuDeviceEntry.pMibDownloadFsm == nil || onuDeviceEntry.pMibDownloadFsm.pFsm == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000443 logger.Errorw(ctx, "MibDownloadFsm could not be instantiated", log.Fields{"device-id": dh.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200444 // TODO some specifc error treatment - or waiting for crash ?
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000445 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000446
dbainbri4d3a0dc2020-12-02 00:33:42 +0000447 onuDeviceEntry.mibTemplateKVStore = onuDeviceEntry.baseDeviceHandler.setBackend(ctx, cBasePathMibTemplateKvStore)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000448 if onuDeviceEntry.mibTemplateKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000449 logger.Errorw(ctx, "Can't access mibTemplateKVStore - no backend connection to service",
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000450 log.Fields{"device-id": dh.deviceID, "service": cBasePathMibTemplateKvStore})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000451 }
452
453 onuDeviceEntry.onuKVStorePath = onuDeviceEntry.deviceID
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800454 baseKvStorePath := fmt.Sprintf(cBasePathOnuKVStore, dh.pOpenOnuAc.cm.Backend.PathPrefix)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000455 onuDeviceEntry.onuKVStore = onuDeviceEntry.baseDeviceHandler.setBackend(ctx, baseKvStorePath)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000456 if onuDeviceEntry.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000457 logger.Errorw(ctx, "Can't access onuKVStore - no backend connection to service",
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800458 log.Fields{"device-id": dh.deviceID, "service": baseKvStorePath})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000459 }
460
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000461 // Alarm Synchronization Database
462 //self._alarm_db = None
463 //self._alarm_database_cls = support_classes['alarm-synchronizer']['database']
464 return &onuDeviceEntry
465}
466
Himani Chawla6d2ae152020-09-02 13:11:20 +0530467//start starts (logs) the omci agent
468func (oo *OnuDeviceEntry) start(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000469 logger.Debugw(ctx, "OnuDeviceEntry-starting", log.Fields{"for device-id": oo.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000470 if oo.PDevOmciCC == nil {
mpagenko900ee4b2020-10-12 11:56:34 +0000471 oo.PDevOmciCC = newOmciCC(ctx, oo, oo.deviceID, oo.baseDeviceHandler,
472 oo.coreProxy, oo.adapterProxy)
473 if oo.PDevOmciCC == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000474 logger.Errorw(ctx, "Could not create devOmciCc - abort", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000475 return fmt.Errorf("could not create devOmciCc %s", oo.deviceID)
476 }
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000477 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000478 return nil
479}
480
mpagenko900ee4b2020-10-12 11:56:34 +0000481//stop stops/resets the omciCC
482func (oo *OnuDeviceEntry) stop(ctx context.Context, abResetOmciCC bool) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000483 logger.Debugw(ctx, "OnuDeviceEntry-stopping", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000484 if abResetOmciCC && (oo.PDevOmciCC != nil) {
485 _ = oo.PDevOmciCC.stop(ctx)
486 }
487 //to allow for all event notifications again when re-using the device and omciCC
488 oo.devState = DeviceStatusInit
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000489 return nil
490}
491
Himani Chawla6d2ae152020-09-02 13:11:20 +0530492func (oo *OnuDeviceEntry) reboot(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000493 logger.Debugw(ctx, "OnuDeviceEntry-rebooting", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000494 if oo.PDevOmciCC != nil {
495 if err := oo.PDevOmciCC.sendReboot(ctx, ConstDefaultOmciTimeout, true, oo.omciRebootMessageReceivedChannel); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000496 logger.Errorw(ctx, "onu didn't reboot", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000497 return err
498 }
ozgecanetsiae11479f2020-07-06 09:44:47 +0300499 }
ozgecanetsiae11479f2020-07-06 09:44:47 +0300500 return nil
501}
502
dbainbri4d3a0dc2020-12-02 00:33:42 +0000503func (oo *OnuDeviceEntry) waitForRebootResponse(ctx context.Context, responseChannel chan Message) error {
ozgecanetsiae11479f2020-07-06 09:44:47 +0300504 select {
505 case <-time.After(3 * time.Second): //3s was detected to be to less in 8*8 bbsim test with debug Info/Debug
dbainbri4d3a0dc2020-12-02 00:33:42 +0000506 logger.Warnw(ctx, "Reboot timeout", log.Fields{"for device-id": oo.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200507 return fmt.Errorf("rebootTimeout")
ozgecanetsiae11479f2020-07-06 09:44:47 +0300508 case data := <-responseChannel:
509 switch data.Data.(OmciMessage).OmciMsg.MessageType {
510 case omci.RebootResponseType:
511 {
512 msgLayer := (*data.Data.(OmciMessage).OmciPacket).Layer(omci.LayerTypeRebootResponse)
513 if msgLayer == nil {
Andrea Campanella6515c582020-10-05 11:25:00 +0200514 return fmt.Errorf("omci Msg layer could not be detected for RebootResponseType")
ozgecanetsiae11479f2020-07-06 09:44:47 +0300515 }
Andrea Campanellabef4e542020-10-22 11:01:28 +0200516 msgObj, msgOk := msgLayer.(*omci.RebootResponse)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300517 if !msgOk {
Andrea Campanella6515c582020-10-05 11:25:00 +0200518 return fmt.Errorf("omci Msg layer could not be assigned for RebootResponseType %s", oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300519 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000520 logger.Debugw(ctx, "RebootResponse data", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300521 if msgObj.Result != me.Success {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000522 logger.Errorw(ctx, "Omci RebootResponse result error", log.Fields{"device-id": oo.deviceID, "Error": msgObj.Result})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300523 // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
Andrea Campanellabef4e542020-10-22 11:01:28 +0200524 return fmt.Errorf("omci RebootResponse result error indication %s for device %s",
Andrea Campanella6515c582020-10-05 11:25:00 +0200525 msgObj.Result, oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300526 }
527 return nil
528 }
529 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000530 logger.Warnw(ctx, "Reboot response message type error", log.Fields{"for device-id": oo.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200531 return fmt.Errorf("unexpected OmciResponse type received %s", oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300532 }
533}
534
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000535//Relay the InSync message via Handler to Rw core - Status update
dbainbri4d3a0dc2020-12-02 00:33:42 +0000536func (oo *OnuDeviceEntry) transferSystemEvent(ctx context.Context, devEvent OnuDeviceEvent) {
537 logger.Debugw(ctx, "relaying system-event", log.Fields{"Event": devEvent})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000538 // decouple the handler transfer from further processing here
539 // TODO!!! check if really no synch is required within the system e.g. to ensure following steps ..
Himani Chawla26e555c2020-08-31 12:30:20 +0530540 if devEvent == MibDatabaseSync {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000541 if oo.devState < MibDatabaseSync { //devState has not been synced yet
542 oo.devState = MibDatabaseSync
dbainbri4d3a0dc2020-12-02 00:33:42 +0000543 go oo.baseDeviceHandler.deviceProcStatusUpdate(ctx, devEvent)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000544 //TODO!!! device control: next step: start MIB capability verification from here ?!!!
545 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000546 logger.Debugw(ctx, "mibinsync-event in some already synced state - ignored", log.Fields{"state": oo.devState})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000547 }
Himani Chawla26e555c2020-08-31 12:30:20 +0530548 } else if devEvent == MibDownloadDone {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000549 if oo.devState < MibDownloadDone { //devState has not been synced yet
550 oo.devState = MibDownloadDone
dbainbri4d3a0dc2020-12-02 00:33:42 +0000551 go oo.baseDeviceHandler.deviceProcStatusUpdate(ctx, devEvent)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000552 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000553 logger.Debugw(ctx, "mibdownloaddone-event was already seen - ignored", log.Fields{"state": oo.devState})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000554 }
555 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000556 logger.Warnw(ctx, "device-event not yet handled", log.Fields{"state": devEvent})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000557 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000558}
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000559
560func (oo *OnuDeviceEntry) restoreDataFromOnuKvStore(ctx context.Context) error {
561 if oo.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000562 logger.Debugw(ctx, "onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000563 return fmt.Errorf(fmt.Sprintf("onuKVStore-not-set-abort-%s", oo.deviceID))
564 }
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000565 oo.sOnuPersistentData = onuPersistentData{0, 0, "", "", "", false, false, oo.mibAuditInterval, 0, 0, make([]uniPersConfig, 0)}
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000566 Value, err := oo.onuKVStore.Get(ctx, oo.onuKVStorePath)
567 if err == nil {
568 if Value != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000569 logger.Debugw(ctx, "ONU-data read",
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000570 log.Fields{"Key": Value.Key, "device-id": oo.deviceID})
571 tmpBytes, _ := kvstore.ToByte(Value.Value)
572
573 if err = json.Unmarshal(tmpBytes, &oo.sOnuPersistentData); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000574 logger.Errorw(ctx, "unable to unmarshal ONU-data", log.Fields{"error": err, "device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000575 return fmt.Errorf(fmt.Sprintf("unable-to-unmarshal-ONU-data-%s", oo.deviceID))
576 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000577 logger.Debugw(ctx, "ONU-data", log.Fields{"sOnuPersistentData": oo.sOnuPersistentData,
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000578 "device-id": oo.deviceID})
579 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000580 logger.Debugw(ctx, "no ONU-data found", log.Fields{"path": oo.onuKVStorePath, "device-id": oo.deviceID})
mpagenko2418ab02020-11-12 12:58:06 +0000581 return fmt.Errorf("no-ONU-data-found")
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000582 }
583 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000584 logger.Errorw(ctx, "unable to read from KVstore", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000585 return fmt.Errorf(fmt.Sprintf("unable-to-read-from-KVstore-%s", oo.deviceID))
586 }
587 return nil
588}
589
590func (oo *OnuDeviceEntry) deleteDataFromOnuKvStore(ctx context.Context, wg *sync.WaitGroup) {
591 defer wg.Done()
592
593 if oo.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000594 logger.Debugw(ctx, "onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000595 oo.onuKVStoreprocResult = errors.New("onu-data delete aborted: onuKVStore not set")
596 return
597 }
598 var processingStep uint8 = 1 // used to synchronize the different processing steps with chOnuKvProcessingStep
599 go oo.deletePersistentData(ctx, processingStep)
600 if !oo.waitForTimeoutOrCompletion(ctx, oo.chOnuKvProcessingStep, processingStep) {
601 //timeout or error detected
dbainbri4d3a0dc2020-12-02 00:33:42 +0000602 logger.Debugw(ctx, "ONU-data not deleted - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000603 oo.onuKVStoreprocResult = errors.New("onu-data delete aborted: during kv-access")
604 return
605 }
606}
607
608func (oo *OnuDeviceEntry) deletePersistentData(ctx context.Context, aProcessingStep uint8) {
609
dbainbri4d3a0dc2020-12-02 00:33:42 +0000610 logger.Debugw(ctx, "delete and clear internal persistency data", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000611 oo.sOnuPersistentData.PersUniConfig = nil //releasing all UniConfig entries to garbage collector
612 oo.sOnuPersistentData = onuPersistentData{0, 0, "", "", "", false, false, oo.mibAuditInterval, 0, 0, make([]uniPersConfig, 0)} //default entry
mpagenko2418ab02020-11-12 12:58:06 +0000613
dbainbri4d3a0dc2020-12-02 00:33:42 +0000614 logger.Debugw(ctx, "delete ONU-data from KVStore", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000615 err := oo.onuKVStore.Delete(ctx, oo.onuKVStorePath)
616 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000617 logger.Errorw(ctx, "unable to delete in KVstore", log.Fields{"device-id": oo.deviceID, "err": err})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000618 oo.chOnuKvProcessingStep <- 0 //error indication
619 return
620 }
621 oo.chOnuKvProcessingStep <- aProcessingStep //done
622}
623
624func (oo *OnuDeviceEntry) updateOnuKvStore(ctx context.Context, wg *sync.WaitGroup) {
625 defer wg.Done()
626
627 if oo.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000628 logger.Debugw(ctx, "onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000629 oo.onuKVStoreprocResult = errors.New("onu-data update aborted: onuKVStore not set")
630 return
631 }
632 var processingStep uint8 = 1 // used to synchronize the different processing steps with chOnuKvProcessingStep
633 go oo.storeDataInOnuKvStore(ctx, processingStep)
634 if !oo.waitForTimeoutOrCompletion(ctx, oo.chOnuKvProcessingStep, processingStep) {
635 //timeout or error detected
dbainbri4d3a0dc2020-12-02 00:33:42 +0000636 logger.Debugw(ctx, "ONU-data not written - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000637 oo.onuKVStoreprocResult = errors.New("onu-data update aborted: during writing process")
638 return
639 }
640}
641
642func (oo *OnuDeviceEntry) storeDataInOnuKvStore(ctx context.Context, aProcessingStep uint8) {
643
644 //assign values which are not already present when newOnuDeviceEntry() is called
645 oo.sOnuPersistentData.PersOnuID = oo.baseDeviceHandler.pOnuIndication.OnuId
646 oo.sOnuPersistentData.PersIntfID = oo.baseDeviceHandler.pOnuIndication.IntfId
647 oo.sOnuPersistentData.PersSnr = oo.baseDeviceHandler.pOnuOmciDevice.serialNumber
648 //TODO: verify usage of these values during restart UC
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000649 oo.sOnuPersistentData.PersAdminState = oo.baseDeviceHandler.pOnuIndication.AdminState
650 oo.sOnuPersistentData.PersOperState = oo.baseDeviceHandler.pOnuIndication.OperState
dbainbri4d3a0dc2020-12-02 00:33:42 +0000651 logger.Debugw(ctx, "Update ONU-data in KVStore", log.Fields{"device-id": oo.deviceID, "sOnuPersistentData": oo.sOnuPersistentData})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000652
653 Value, err := json.Marshal(oo.sOnuPersistentData)
654 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000655 logger.Errorw(ctx, "unable to marshal ONU-data", log.Fields{"sOnuPersistentData": oo.sOnuPersistentData,
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000656 "device-id": oo.deviceID, "err": err})
657 oo.chOnuKvProcessingStep <- 0 //error indication
658 return
659 }
660 err = oo.onuKVStore.Put(ctx, oo.onuKVStorePath, Value)
661 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000662 logger.Errorw(ctx, "unable to write ONU-data into KVstore", log.Fields{"device-id": oo.deviceID, "err": err})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000663 oo.chOnuKvProcessingStep <- 0 //error indication
664 return
665 }
666 oo.chOnuKvProcessingStep <- aProcessingStep //done
667}
668
dbainbri4d3a0dc2020-12-02 00:33:42 +0000669func (oo *OnuDeviceEntry) updateOnuUniTpPath(ctx context.Context, aUniID uint8, aTpID uint8, aPathString string) bool {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000670 /* within some specific InterAdapter processing request write/read access to data is ensured to be sequentially,
671 as also the complete sequence is ensured to 'run to completion' before some new request is accepted
672 no specific concurrency protection to sOnuPersistentData is required here
673 */
674 for k, v := range oo.sOnuPersistentData.PersUniConfig {
675 if v.PersUniID == aUniID {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000676 logger.Debugw(ctx, "PersUniConfig-entry already exists", log.Fields{"device-id": oo.deviceID, "uniID": aUniID})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800677 existingPath, ok := oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID]
678 if !ok {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000679 logger.Debugw(ctx, "tp-does-not-exist--to-be-created-afresh", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "tpID": aTpID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800680 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000681 if existingPath != aPathString {
682 if aPathString == "" {
683 //existing entry to be deleted
dbainbri4d3a0dc2020-12-02 00:33:42 +0000684 logger.Debugw(ctx, "UniTp delete path value", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800685 oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID] = ""
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000686 } else {
687 //existing entry to be modified
dbainbri4d3a0dc2020-12-02 00:33:42 +0000688 logger.Debugw(ctx, "UniTp modify path value", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800689 oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID] = aPathString
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000690 }
691 return true
692 }
693 //entry already exists
mpagenkofc4f56e2020-11-04 17:17:49 +0000694 if aPathString == "" {
695 //no active TechProfile
dbainbri4d3a0dc2020-12-02 00:33:42 +0000696 logger.Debugw(ctx, "UniTp path has already been removed - no AniSide config to be removed", log.Fields{
mpagenkofc4f56e2020-11-04 17:17:49 +0000697 "device-id": oo.deviceID, "uniID": aUniID})
698 // attention 201105: this block is at the moment entered for each of subsequent GemPortDeletes and TContDelete
699 // as the path is already cleared with the first GemPort - this will probably change with the upcoming real
700 // TechProfile removal (still TODO), but anyway the reasonUpdate initiated here should not harm overall behavior
dbainbri4d3a0dc2020-12-02 00:33:42 +0000701 go oo.baseDeviceHandler.deviceProcStatusUpdate(ctx, OmciAniResourceRemoved)
mpagenkofc4f56e2020-11-04 17:17:49 +0000702 // no flow config pending on 'remove' so far
703 } else {
704 //the given TechProfile already exists and is assumed to be active - update devReason as if the config has been done here
705 //was needed e.g. in voltha POD Tests:Validate authentication on a disabled ONU
706 // (as here the TechProfile has not been removed with the disable-device before the new enable-device)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000707 logger.Debugw(ctx, "UniTp path already exists - TechProfile supposed to be active", log.Fields{
mpagenkofc4f56e2020-11-04 17:17:49 +0000708 "device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
709 //no deviceReason update (deviceProcStatusUpdate) here to ensure 'omci_flows_pushed' state within disable/enable procedure of ATT scenario
710 // (during which the flows are removed/re-assigned but the techProf is left active)
711 //and as the TechProfile is regarded as active we have to verify, if some flow configuration still waits on it
712 // (should not be the case, but should not harm or be more robust ...)
mpagenko2418ab02020-11-12 12:58:06 +0000713 // and to be sure, that for some reason the corresponding TpDelete was lost somewhere in history
714 // we also reset a possibly outstanding delete request - repeated TpConfig is regarded as valid for waiting flow config
715 if oo.baseDeviceHandler.pOnuTP != nil {
Girish Gowdra041dcb32020-11-16 16:54:30 -0800716 oo.baseDeviceHandler.pOnuTP.setProfileToDelete(aUniID, aTpID, false)
mpagenko2418ab02020-11-12 12:58:06 +0000717 }
mpagenko551a4d42020-12-08 18:09:20 +0000718 go oo.baseDeviceHandler.VerifyVlanConfigRequest(ctx, aUniID, aTpID)
mpagenkofc4f56e2020-11-04 17:17:49 +0000719 }
720 return false //indicate 'no change' - nothing more to do, TechProf inter-adapter message is return with success anyway here
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000721 }
722 }
723 //no entry exists for uniId
724
725 if aPathString == "" {
726 //delete request in non-existing state , accept as no change
dbainbri4d3a0dc2020-12-02 00:33:42 +0000727 logger.Debugw(ctx, "UniTp path already removed", log.Fields{"device-id": oo.deviceID, "uniID": aUniID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000728 return false
729 }
730 //new entry to be created
dbainbri4d3a0dc2020-12-02 00:33:42 +0000731 logger.Debugw(ctx, "New UniTp path set", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800732 perSubTpPathMap := make(map[uint8]string)
733 perSubTpPathMap[aTpID] = aPathString
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000734 oo.sOnuPersistentData.PersUniConfig =
Girish Gowdra041dcb32020-11-16 16:54:30 -0800735 append(oo.sOnuPersistentData.PersUniConfig, uniPersConfig{PersUniID: aUniID, PersTpPathMap: perSubTpPathMap, PersFlowParams: make([]uniVlanFlowParams, 0)})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000736 return true
737}
738
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000739func (oo *OnuDeviceEntry) updateOnuUniFlowConfig(aUniID uint8, aUniVlanFlowParams *[]uniVlanFlowParams) {
740
741 for k, v := range oo.sOnuPersistentData.PersUniConfig {
742 if v.PersUniID == aUniID {
743 oo.sOnuPersistentData.PersUniConfig[k].PersFlowParams = make([]uniVlanFlowParams, len(*aUniVlanFlowParams))
744 copy(oo.sOnuPersistentData.PersUniConfig[k].PersFlowParams, *aUniVlanFlowParams)
745 return
746 }
747 }
748 //flow update was faster than tp-config - create PersUniConfig-entry
Girish Gowdra041dcb32020-11-16 16:54:30 -0800749 tmpConfig := uniPersConfig{PersUniID: aUniID, PersTpPathMap: make(map[uint8]string), PersFlowParams: make([]uniVlanFlowParams, len(*aUniVlanFlowParams))}
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000750 copy(tmpConfig.PersFlowParams, *aUniVlanFlowParams)
751 oo.sOnuPersistentData.PersUniConfig = append(oo.sOnuPersistentData.PersUniConfig, tmpConfig)
752}
753
754func (oo *OnuDeviceEntry) waitForTimeoutOrCompletion(
755 ctx context.Context, aChOnuProcessingStep <-chan uint8, aProcessingStep uint8) bool {
756 select {
757 case <-ctx.Done():
dbainbri4d3a0dc2020-12-02 00:33:42 +0000758 logger.Warnw(ctx, "processing not completed in-time!",
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000759 log.Fields{"device-id": oo.deviceID, "error": ctx.Err()})
760 return false
761 case rxStep := <-aChOnuProcessingStep:
762 if rxStep == aProcessingStep {
763 return true
764 }
765 //all other values are not accepted - including 0 for error indication
dbainbri4d3a0dc2020-12-02 00:33:42 +0000766 logger.Warnw(ctx, "Invalid processing step received: abort!",
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000767 log.Fields{"device-id": oo.deviceID,
768 "wantedStep": aProcessingStep, "haveStep": rxStep})
769 return false
770 }
771}
772
773func (oo *OnuDeviceEntry) resetKvProcessingErrorIndication() {
774 oo.onuKVStoreprocResult = nil
775}
776func (oo *OnuDeviceEntry) getKvProcessingErrorIndication() error {
777 return oo.onuKVStoreprocResult
778}
779
780func (oo *OnuDeviceEntry) lockOnuKVStoreMutex() {
781 oo.onuKVStoreMutex.Lock()
782}
783
784func (oo *OnuDeviceEntry) unlockOnuKVStoreMutex() {
785 oo.onuKVStoreMutex.Unlock()
786}
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000787
788func (oo *OnuDeviceEntry) incrementMibDataSync(ctx context.Context) {
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000789 if oo.sOnuPersistentData.PersMibDataSyncAdpt < 255 {
790 oo.sOnuPersistentData.PersMibDataSyncAdpt++
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000791 } else {
792 // per G.984 and G.988 overflow starts over at 1 given 0 is reserved for reset
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000793 oo.sOnuPersistentData.PersMibDataSyncAdpt = 1
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000794 }
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000795 logger.Debugf(ctx, "mibDataSync updated - mds: %d - device-id: %s", oo.sOnuPersistentData.PersMibDataSyncAdpt, oo.deviceID)
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000796}