blob: a49441879ae38fd4120c4ce687eea3675d7d9dc0 [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"
Holger Hildebrandtbe523842021-03-10 10:47:18 +000082 ulStExaminingMdsSuccess = "ulStExaminingMdsSuccess"
mpagenko1cc3cb42020-07-27 15:24:38 +000083 ulStAuditing = "ulStAuditing"
Holger Hildebrandt10d98192021-01-27 15:29:31 +000084 ulStReAuditing = "ulStReAuditing"
mpagenko1cc3cb42020-07-27 15:24:38 +000085 ulStOutOfSync = "ulStOutOfSync"
86)
Holger Hildebrandt10d98192021-01-27 15:29:31 +000087const cMibUlFsmIdleState = ulStInSync
mpagenko1cc3cb42020-07-27 15:24:38 +000088
89const (
90 // events of MibDownload FSM
91 dlEvStart = "dlEvStart"
92 dlEvCreateGal = "dlEvCreateGal"
93 dlEvRxGalResp = "dlEvRxGalResp"
94 dlEvRxOnu2gResp = "dlEvRxOnu2gResp"
95 dlEvRxBridgeResp = "dlEvRxBridgeResp"
96 dlEvTimeoutSimple = "dlEvTimeoutSimple"
97 dlEvTimeoutBridge = "dlEvTimeoutBridge"
98 dlEvReset = "dlEvReset"
99 dlEvRestart = "dlEvRestart"
100)
101const (
102 // states of MibDownload FSM
103 dlStDisabled = "dlStDisabled"
104 dlStStarting = "dlStStarting"
105 dlStCreatingGal = "dlStCreatingGal"
106 dlStSettingOnu2g = "dlStSettingOnu2g"
107 dlStBridgeInit = "dlStBridgeInit"
108 dlStDownloaded = "dlStDownloaded"
109 dlStResetting = "dlStResetting"
110)
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000111const cMibDlFsmIdleState = dlStDisabled
mpagenko1cc3cb42020-07-27 15:24:38 +0000112
113const (
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800114 // NOTE that this hardcoded to service/voltha as the MIB template is shared across stacks
Holger Hildebrandt2ff21f12020-08-13 14:38:02 +0000115 cBasePathMibTemplateKvStore = "service/voltha/omci_mibs/go_templates"
mpagenkoaf801632020-07-03 10:00:42 +0000116 cSuffixMibTemplateKvStore = "%s/%s/%s"
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800117 cBasePathOnuKVStore = "%s/openonu"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000118)
119
Himani Chawla6d2ae152020-09-02 13:11:20 +0530120// OnuDeviceEvent - event of interest to Device Adapters and OpenOMCI State Machines
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000121type OnuDeviceEvent int
122
123const (
124 // Events of interest to Device Adapters and OpenOMCI State Machines
Himani Chawla6d2ae152020-09-02 13:11:20 +0530125
126 // DeviceStatusInit - default start state
mpagenkofc4f56e2020-11-04 17:17:49 +0000127 DeviceStatusInit OnuDeviceEvent = iota
Himani Chawla6d2ae152020-09-02 13:11:20 +0530128 // MibDatabaseSync - MIB database sync (upload done)
mpagenkofc4f56e2020-11-04 17:17:49 +0000129 MibDatabaseSync
Himani Chawla6d2ae152020-09-02 13:11:20 +0530130 // OmciCapabilitiesDone - OMCI ME and message type capabilities known
mpagenkofc4f56e2020-11-04 17:17:49 +0000131 OmciCapabilitiesDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530132 // MibDownloadDone - // MIB download done
mpagenkofc4f56e2020-11-04 17:17:49 +0000133 MibDownloadDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530134 // UniLockStateDone - Uni ports admin set to lock
mpagenkofc4f56e2020-11-04 17:17:49 +0000135 UniLockStateDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530136 // UniUnlockStateDone - Uni ports admin set to unlock
mpagenkofc4f56e2020-11-04 17:17:49 +0000137 UniUnlockStateDone
mpagenko900ee4b2020-10-12 11:56:34 +0000138 // UniDisableStateDone - Uni ports admin set to lock based on device disable
mpagenkofc4f56e2020-11-04 17:17:49 +0000139 UniDisableStateDone
mpagenko900ee4b2020-10-12 11:56:34 +0000140 // UniEnableStateDone - Uni ports admin set to unlock based on device re-enable
mpagenkofc4f56e2020-11-04 17:17:49 +0000141 UniEnableStateDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530142 // PortLinkUp - Port link state change
mpagenkofc4f56e2020-11-04 17:17:49 +0000143 PortLinkUp
Himani Chawla6d2ae152020-09-02 13:11:20 +0530144 // PortLinkDw - Port link state change
mpagenkofc4f56e2020-11-04 17:17:49 +0000145 PortLinkDw
Himani Chawla6d2ae152020-09-02 13:11:20 +0530146 // OmciAniConfigDone - AniSide config according to TechProfile done
mpagenkofc4f56e2020-11-04 17:17:49 +0000147 OmciAniConfigDone
148 // OmciAniResourceRemoved - AniSide TechProfile related resource (Gem/TCont) removed
149 OmciAniResourceRemoved // needs to be the successor of OmciAniConfigDone!
mpagenkof1fc3862021-02-16 10:09:52 +0000150 // OmciVlanFilterAddDone - Omci Vlan config done according to flow-add with request to write kvStore
mpagenkofc4f56e2020-11-04 17:17:49 +0000151 OmciVlanFilterAddDone
mpagenkof1fc3862021-02-16 10:09:52 +0000152 // OmciVlanFilterAddDoneNoKvStore - Omci Vlan config done according to flow-add without writing kvStore
153 OmciVlanFilterAddDoneNoKvStore // needs to be the successor of OmciVlanFilterAddDone!
154 // OmciVlanFilterRemDone - Omci Vlan config done according to flow-remove with request to write kvStore
155 OmciVlanFilterRemDone // needs to be the successor of OmciVlanFilterAddDoneNoKvStore!
156 // OmciVlanFilterRemDoneNoKvStore - Omci Vlan config done according to flow-remove without writing kvStore
157 OmciVlanFilterRemDoneNoKvStore // needs to be the successor of OmciVlanFilterRemDone!
mpagenko80622a52021-02-09 16:53:23 +0000158 // OmciOnuSwUpgradeDone - SoftwareUpgrade to ONU finished
159 OmciOnuSwUpgradeDone
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000160 // Add other events here as needed (alarms separate???)
161)
162
mpagenko7d6bb022021-03-11 15:07:55 +0000163//AdapterFsm related error string
164//error string could be checked on waitforOmciResponse() e.g. to avoid misleading error log
165// but not used that way so far (permit error log even for wanted cancellation)
166const cErrWaitAborted = "waitResponse aborted"
167
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000168type activityDescr struct {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000169 databaseClass func(context.Context) error
Himani Chawla4d908332020-08-31 12:30:20 +0530170 //advertiseEvents bool
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000171 auditInterval time.Duration
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000172 //tasks map[string]func() error
173}
Himani Chawla6d2ae152020-09-02 13:11:20 +0530174
175// OmciDeviceFsms - FSM event mapping to database class and time to wait between audits
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000176type OmciDeviceFsms map[string]activityDescr
177
Himani Chawla6d2ae152020-09-02 13:11:20 +0530178// AdapterFsm - Adapter FSM details including channel, event and device
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000179type AdapterFsm struct {
180 fsmName string
181 deviceID string
182 commChan chan Message
183 pFsm *fsm.FSM
184}
185
Himani Chawla6d2ae152020-09-02 13:11:20 +0530186//NewAdapterFsm - FSM details including event, device and channel.
187func NewAdapterFsm(aName string, aDeviceID string, aCommChannel chan Message) *AdapterFsm {
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000188 aFsm := &AdapterFsm{
Himani Chawla6d2ae152020-09-02 13:11:20 +0530189 fsmName: aName,
190 deviceID: aDeviceID,
191 commChan: aCommChannel,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000192 }
193 return aFsm
194}
195
196//Start starts (logs) the omci agent
dbainbri4d3a0dc2020-12-02 00:33:42 +0000197func (oo *AdapterFsm) logFsmStateChange(ctx context.Context, e *fsm.Event) {
198 logger.Debugw(ctx, "FSM state change", log.Fields{"device-id": oo.deviceID, "FSM name": oo.fsmName,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000199 "event name": string(e.Event), "src state": string(e.Src), "dst state": string(e.Dst)})
200}
201
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000202//OntDeviceEntry structure holds information about the attached FSM'as and their communication
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000203
204const (
Himani Chawla6d2ae152020-09-02 13:11:20 +0530205 firstSwImageMeID = 0
206 secondSwImageMeID = 1
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000207)
mpagenko15ff4a52021-03-02 10:09:20 +0000208const ( //definitions as per G.988 softwareImage::IsCommitted
209 swIsUncommitted = 0
210 swIsCommitted = 1
211)
212const ( //definitions as per G.988 softwareImage::IsActive
213 //swIsInactive = 0 not yet used
214 swIsActive = 1
215)
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000216const onuDataMeID = 0
Himani Chawla6d2ae152020-09-02 13:11:20 +0530217const onugMeID = 0
218const onu2gMeID = 0
219const ipHostConfigDataMeID = 1
220const onugSerialNumberLen = 8
221const omciMacAddressLen = 6
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000222
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000223const cEmptyMacAddrString = "000000000000"
224const cEmptySerialNumberString = "0000000000000000"
225
mpagenko15ff4a52021-03-02 10:09:20 +0000226type sEntrySwImageIndication struct {
227 valid bool
228 entityID uint16
229 version string
230 isCommitted uint8
231}
232type sSwImageIndications struct {
233 activeEntityEntry sEntrySwImageIndication
234 inactiveEntityEntry sEntrySwImageIndication
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000235}
236
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000237type uniPersConfig struct {
238 PersUniID uint8 `json:"uni_id"`
Girish Gowdra041dcb32020-11-16 16:54:30 -0800239 PersTpPathMap map[uint8]string `json:"PersTpPathMap"` // tp-id to tp-path map
240 PersFlowParams []uniVlanFlowParams `json:"flow_params"` //as defined in omci_ani_config.go
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000241}
242
243type onuPersistentData struct {
Himani Chawla075f1642021-03-15 19:23:24 +0530244 PersOnuID uint32 `json:"onu_id"`
245 PersIntfID uint32 `json:"intf_id"`
246 PersSerialNumber string `json:"serial_number"`
247 PersMacAddress string `json:"mac_address"`
248 PersVendorID string `json:"vendor_id"`
249 PersEquipmentID string `json:"equipment_id"`
250 PersActiveSwVersion string `json:"active_sw_version"`
251 PersAdminState string `json:"admin_state"`
252 PersOperState string `json:"oper_state"`
253 PersUniUnlockDone bool `json:"uni_unlock_done"`
254 PersUniDisableDone bool `json:"uni_disable_done"`
255 PersMibAuditInterval time.Duration `json:"mib_audit_interval"`
256 PersMibLastDbSync uint32 `json:"mib_last_db_sync"`
257 PersMibDataSyncAdpt uint8 `json:"mib_data_sync_adpt"`
258 PersUniConfig []uniPersConfig `json:"uni_config"`
259 PersAlarmAuditInterval time.Duration `json:"alarm_audit_interval"`
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000260}
261
Himani Chawla6d2ae152020-09-02 13:11:20 +0530262// OnuDeviceEntry - ONU device info and FSM events.
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000263type OnuDeviceEntry struct {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000264 deviceID string
265 baseDeviceHandler *deviceHandler
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000266 pOpenOnuAc *OpenONUAC
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000267 coreProxy adapterif.CoreProxy
268 adapterProxy adapterif.AdapterProxy
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000269 PDevOmciCC *omciCC
270 pOnuDB *onuDeviceDB
271 mibTemplateKVStore *db.Backend
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000272 persUniConfigMutex sync.RWMutex
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000273 sOnuPersistentData onuPersistentData
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000274 mibTemplatePath string
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000275 onuKVStoreMutex sync.RWMutex
276 onuKVStore *db.Backend
277 onuKVStorePath string
278 onuKVStoreprocResult error //error indication of processing
279 chOnuKvProcessingStep chan uint8
mpagenko15ff4a52021-03-02 10:09:20 +0000280 onuSwImageIndications sSwImageIndications
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000281 //lockDeviceEntries sync.RWMutex
dbainbri4d3a0dc2020-12-02 00:33:42 +0000282 mibDbClass func(context.Context) error
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000283 supportedFsms OmciDeviceFsms
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000284 devState OnuDeviceEvent
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000285 // Audit and MDS
Himani Chawla075f1642021-03-15 19:23:24 +0530286 mibAuditInterval time.Duration
287 alarmAuditInterval time.Duration
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000288 // TODO: periodical mib resync will be implemented with story VOL-3792
289 //mibNextDbResync uint32
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000290
291 // for mibUpload
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000292 pMibUploadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later
293 // for mibDownload
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000294 pMibDownloadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later
295 //remark: general usage of pAdapterFsm would require generalization of commChan usage and internal event setting
296 // within the FSM event procedures
ozgecanetsiae11479f2020-07-06 09:44:47 +0300297 omciMessageReceived chan bool //seperate channel needed by DownloadFsm
298 omciRebootMessageReceivedChannel chan Message // channel needed by Reboot request
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000299}
300
Himani Chawla6d2ae152020-09-02 13:11:20 +0530301//newOnuDeviceEntry returns a new instance of a OnuDeviceEntry
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000302//mib_db (as well as not inluded alarm_db not really used in this code? VERIFY!!)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000303func newOnuDeviceEntry(ctx context.Context, dh *deviceHandler) *OnuDeviceEntry {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000304 logger.Debugw(ctx, "init-onuDeviceEntry", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000305 var onuDeviceEntry OnuDeviceEntry
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000306 onuDeviceEntry.deviceID = dh.deviceID
307 onuDeviceEntry.baseDeviceHandler = dh
308 onuDeviceEntry.pOpenOnuAc = dh.pOpenOnuAc
309 onuDeviceEntry.coreProxy = dh.coreProxy
310 onuDeviceEntry.adapterProxy = dh.AdapterProxy
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000311 onuDeviceEntry.devState = DeviceStatusInit
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000312 onuDeviceEntry.sOnuPersistentData.PersUniConfig = make([]uniPersConfig, 0)
313 onuDeviceEntry.chOnuKvProcessingStep = make(chan uint8)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300314 onuDeviceEntry.omciRebootMessageReceivedChannel = make(chan Message, 2048)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000315 //openomciagent.lockDeviceHandlersMap = sync.RWMutex{}
316 //OMCI related databases are on a per-agent basis. State machines and tasks
317 //are per ONU Vendor
318 //
319 // MIB Synchronization Database - possible overloading from arguments
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000320 if dh.pOpenOnuAc.pSupportedFsms != nil {
321 onuDeviceEntry.supportedFsms = *dh.pOpenOnuAc.pSupportedFsms
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000322 } else {
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000323 // 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 +0000324 //var mibSyncFsm = NewMibSynchronizer()
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000325 // use some internal defaults, if not defined from outside
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000326 onuDeviceEntry.supportedFsms = OmciDeviceFsms{
327 "mib-synchronizer": {
328 //mibSyncFsm, // Implements the MIB synchronization state machine
Himani Chawla6d2ae152020-09-02 13:11:20 +0530329 onuDeviceEntry.mibDbVolatileDict, // Implements volatile ME MIB database
Himani Chawla4d908332020-08-31 12:30:20 +0530330 //true, // Advertise events on OpenOMCI event bus
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000331 dh.pOpenOnuAc.mibAuditInterval, // Time to wait between MIB audits. 0 to disable audits.
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000332 // map[string]func() error{
333 // "mib-upload": onuDeviceEntry.MibUploadTask,
334 // "mib-template": onuDeviceEntry.MibTemplateTask,
335 // "get-mds": onuDeviceEntry.GetMdsTask,
336 // "mib-audit": onuDeviceEntry.GetMdsTask,
337 // "mib-resync": onuDeviceEntry.MibResyncTask,
338 // "mib-reconcile": onuDeviceEntry.MibReconcileTask,
339 // },
340 },
341 }
342 }
343 onuDeviceEntry.mibDbClass = onuDeviceEntry.supportedFsms["mib-synchronizer"].databaseClass
dbainbri4d3a0dc2020-12-02 00:33:42 +0000344 logger.Debug(ctx, "access2mibDbClass")
345 go onuDeviceEntry.mibDbClass(ctx)
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +0000346 if !dh.isReconciling() {
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000347 onuDeviceEntry.mibAuditInterval = onuDeviceEntry.supportedFsms["mib-synchronizer"].auditInterval
348 onuDeviceEntry.sOnuPersistentData.PersMibAuditInterval = onuDeviceEntry.mibAuditInterval
Himani Chawla075f1642021-03-15 19:23:24 +0530349 onuDeviceEntry.alarmAuditInterval = dh.pOpenOnuAc.alarmAuditInterval
350 onuDeviceEntry.sOnuPersistentData.PersAlarmAuditInterval = onuDeviceEntry.alarmAuditInterval
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000351 } else {
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000352 logger.Debugw(ctx, "reconciling - take audit interval from persistent data", log.Fields{"device-id": dh.deviceID})
353 // TODO: This is a preparation for VOL-VOL-3811 to preserve config history in case of
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000354 // vendor- or deviceID-specific configurations via voltctl-commands
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000355 onuDeviceEntry.mibAuditInterval = onuDeviceEntry.sOnuPersistentData.PersMibAuditInterval
Himani Chawla075f1642021-03-15 19:23:24 +0530356 onuDeviceEntry.alarmAuditInterval = onuDeviceEntry.sOnuPersistentData.PersAlarmAuditInterval
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000357 }
Himani Chawla075f1642021-03-15 19:23:24 +0530358 logger.Debugw(ctx, "MibAuditInterval and AlarmAuditInterval is set to", log.Fields{"mib-audit-interval": onuDeviceEntry.mibAuditInterval,
359 "alarm-audit-interval": onuDeviceEntry.alarmAuditInterval})
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000360 // TODO: periodical mib resync will be implemented with story VOL-3792
361 //onuDeviceEntry.mibNextDbResync = 0
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000362
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000363 // Omci related Mib upload sync state machine
364 mibUploadChan := make(chan Message, 2048)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000365 onuDeviceEntry.pMibUploadFsm = NewAdapterFsm("MibUpload", dh.deviceID, mibUploadChan)
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000366 onuDeviceEntry.pMibUploadFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000367 ulStDisabled,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000368 fsm.Events{
369
mpagenko1cc3cb42020-07-27 15:24:38 +0000370 {Name: ulEvStart, Src: []string{ulStDisabled}, Dst: ulStStarting},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000371
mpagenko1cc3cb42020-07-27 15:24:38 +0000372 {Name: ulEvResetMib, Src: []string{ulStStarting}, Dst: ulStResettingMib},
373 {Name: ulEvGetVendorAndSerial, Src: []string{ulStResettingMib}, Dst: ulStGettingVendorAndSerial},
Himani Chawla4d908332020-08-31 12:30:20 +0530374 {Name: ulEvGetEquipmentID, Src: []string{ulStGettingVendorAndSerial}, Dst: ulStGettingEquipmentID},
375 {Name: ulEvGetFirstSwVersion, Src: []string{ulStGettingEquipmentID}, Dst: ulStGettingFirstSwVersion},
mpagenko1cc3cb42020-07-27 15:24:38 +0000376 {Name: ulEvGetSecondSwVersion, Src: []string{ulStGettingFirstSwVersion}, Dst: ulStGettingSecondSwVersion},
377 {Name: ulEvGetMacAddress, Src: []string{ulStGettingSecondSwVersion}, Dst: ulStGettingMacAddress},
378 {Name: ulEvGetMibTemplate, Src: []string{ulStGettingMacAddress}, Dst: ulStGettingMibTemplate},
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000379
mpagenko1cc3cb42020-07-27 15:24:38 +0000380 {Name: ulEvUploadMib, Src: []string{ulStGettingMibTemplate}, Dst: ulStUploading},
381 {Name: ulEvExamineMds, Src: []string{ulStStarting}, Dst: ulStExaminingMds},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000382
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000383 {Name: ulEvSuccess, Src: []string{ulStGettingMibTemplate}, Dst: ulStUploadDone},
384 {Name: ulEvSuccess, Src: []string{ulStUploading}, Dst: ulStUploadDone},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000385
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000386 {Name: ulEvSuccess, Src: []string{ulStUploadDone}, Dst: ulStInSync},
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000387 //{Name: ulEvSuccess, Src: []string{ulStExaminingMds}, Dst: ulStInSync},
388 {Name: ulEvSuccess, Src: []string{ulStExaminingMds}, Dst: ulStExaminingMdsSuccess},
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000389 // TODO: As long as mib-resynchronizing is not implemented, failed MDS-examination triggers
390 // mib-reset and new provisioning at this point
391 //{Name: ulEvMismatch, Src: []string{ulStExaminingMds}, Dst: ulStResynchronizing},
392 {Name: ulEvMismatch, Src: []string{ulStExaminingMds}, Dst: ulStResettingMib},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000393
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000394 {Name: ulEvSuccess, Src: []string{ulStExaminingMdsSuccess}, Dst: ulStInSync},
395 {Name: ulEvMismatch, Src: []string{ulStExaminingMdsSuccess}, Dst: ulStResettingMib},
396
mpagenko1cc3cb42020-07-27 15:24:38 +0000397 {Name: ulEvAuditMib, Src: []string{ulStInSync}, Dst: ulStAuditing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000398
mpagenko1cc3cb42020-07-27 15:24:38 +0000399 {Name: ulEvSuccess, Src: []string{ulStOutOfSync}, Dst: ulStInSync},
400 {Name: ulEvAuditMib, Src: []string{ulStOutOfSync}, Dst: ulStAuditing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000401
mpagenko1cc3cb42020-07-27 15:24:38 +0000402 {Name: ulEvSuccess, Src: []string{ulStAuditing}, Dst: ulStInSync},
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000403 {Name: ulEvMismatch, Src: []string{ulStAuditing}, Dst: ulStReAuditing},
mpagenko1cc3cb42020-07-27 15:24:38 +0000404 {Name: ulEvForceResync, Src: []string{ulStAuditing}, Dst: ulStResynchronizing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000405
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000406 {Name: ulEvSuccess, Src: []string{ulStReAuditing}, Dst: ulStInSync},
407 {Name: ulEvMismatch, Src: []string{ulStReAuditing}, Dst: ulStResettingMib},
408
mpagenko1cc3cb42020-07-27 15:24:38 +0000409 {Name: ulEvSuccess, Src: []string{ulStResynchronizing}, Dst: ulStInSync},
410 {Name: ulEvDiffsFound, Src: []string{ulStResynchronizing}, Dst: ulStOutOfSync},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000411
Himani Chawla4d908332020-08-31 12:30:20 +0530412 {Name: ulEvTimeout, Src: []string{ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentID, ulStGettingFirstSwVersion,
mpagenko1cc3cb42020-07-27 15:24:38 +0000413 ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds,
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000414 ulStUploadDone, ulStInSync, ulStOutOfSync, ulStAuditing, ulStReAuditing}, Dst: ulStStarting},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000415
Himani Chawla4d908332020-08-31 12:30:20 +0530416 {Name: ulEvStop, Src: []string{ulStStarting, ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentID, ulStGettingFirstSwVersion,
mpagenko1cc3cb42020-07-27 15:24:38 +0000417 ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds,
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000418 ulStUploadDone, ulStInSync, ulStOutOfSync, ulStAuditing, ulStReAuditing}, Dst: ulStDisabled},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000419 },
420
421 fsm.Callbacks{
dbainbri4d3a0dc2020-12-02 00:33:42 +0000422 "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibUploadFsm.logFsmStateChange(ctx, e) },
423 "enter_" + ulStStarting: func(e *fsm.Event) { onuDeviceEntry.enterStartingState(ctx, e) },
424 "enter_" + ulStResettingMib: func(e *fsm.Event) { onuDeviceEntry.enterResettingMibState(ctx, e) },
425 "enter_" + ulStGettingVendorAndSerial: func(e *fsm.Event) { onuDeviceEntry.enterGettingVendorAndSerialState(ctx, e) },
426 "enter_" + ulStGettingEquipmentID: func(e *fsm.Event) { onuDeviceEntry.enterGettingEquipmentIDState(ctx, e) },
427 "enter_" + ulStGettingFirstSwVersion: func(e *fsm.Event) { onuDeviceEntry.enterGettingFirstSwVersionState(ctx, e) },
428 "enter_" + ulStGettingSecondSwVersion: func(e *fsm.Event) { onuDeviceEntry.enterGettingSecondSwVersionState(ctx, e) },
429 "enter_" + ulStGettingMacAddress: func(e *fsm.Event) { onuDeviceEntry.enterGettingMacAddressState(ctx, e) },
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000430 "enter_" + ulStGettingMibTemplate: func(e *fsm.Event) { onuDeviceEntry.enterGettingMibTemplateState(ctx, e) },
dbainbri4d3a0dc2020-12-02 00:33:42 +0000431 "enter_" + ulStUploading: func(e *fsm.Event) { onuDeviceEntry.enterUploadingState(ctx, e) },
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000432 "enter_" + ulStUploadDone: func(e *fsm.Event) { onuDeviceEntry.enterUploadDoneState(ctx, e) },
dbainbri4d3a0dc2020-12-02 00:33:42 +0000433 "enter_" + ulStExaminingMds: func(e *fsm.Event) { onuDeviceEntry.enterExaminingMdsState(ctx, e) },
434 "enter_" + ulStResynchronizing: func(e *fsm.Event) { onuDeviceEntry.enterResynchronizingState(ctx, e) },
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000435 "enter_" + ulStExaminingMdsSuccess: func(e *fsm.Event) { onuDeviceEntry.enterExaminingMdsSuccessState(ctx, e) },
dbainbri4d3a0dc2020-12-02 00:33:42 +0000436 "enter_" + ulStAuditing: func(e *fsm.Event) { onuDeviceEntry.enterAuditingState(ctx, e) },
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000437 "enter_" + ulStReAuditing: func(e *fsm.Event) { onuDeviceEntry.enterReAuditingState(ctx, e) },
dbainbri4d3a0dc2020-12-02 00:33:42 +0000438 "enter_" + ulStOutOfSync: func(e *fsm.Event) { onuDeviceEntry.enterOutOfSyncState(ctx, e) },
439 "enter_" + ulStInSync: func(e *fsm.Event) { onuDeviceEntry.enterInSyncState(ctx, e) },
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000440 },
441 )
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000442 // Omci related Mib download state machine
443 mibDownloadChan := make(chan Message, 2048)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000444 onuDeviceEntry.pMibDownloadFsm = NewAdapterFsm("MibDownload", dh.deviceID, mibDownloadChan)
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000445 onuDeviceEntry.pMibDownloadFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000446 dlStDisabled,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000447 fsm.Events{
448
mpagenko1cc3cb42020-07-27 15:24:38 +0000449 {Name: dlEvStart, Src: []string{dlStDisabled}, Dst: dlStStarting},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000450
mpagenko1cc3cb42020-07-27 15:24:38 +0000451 {Name: dlEvCreateGal, Src: []string{dlStStarting}, Dst: dlStCreatingGal},
452 {Name: dlEvRxGalResp, Src: []string{dlStCreatingGal}, Dst: dlStSettingOnu2g},
453 {Name: dlEvRxOnu2gResp, Src: []string{dlStSettingOnu2g}, Dst: dlStBridgeInit},
Holger Hildebrandtdd23cc22020-05-19 13:32:18 +0000454 // the bridge state is used for multi ME config for alle UNI related ports
455 // maybe such could be reflected in the state machine as well (port number parametrized)
456 // but that looks not straightforward here - so we keep it simple here for the beginning(?)
mpagenko1cc3cb42020-07-27 15:24:38 +0000457 {Name: dlEvRxBridgeResp, Src: []string{dlStBridgeInit}, Dst: dlStDownloaded},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000458
mpagenko1cc3cb42020-07-27 15:24:38 +0000459 {Name: dlEvTimeoutSimple, Src: []string{dlStCreatingGal, dlStSettingOnu2g}, Dst: dlStStarting},
460 {Name: dlEvTimeoutBridge, Src: []string{dlStBridgeInit}, Dst: dlStStarting},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000461
mpagenko1cc3cb42020-07-27 15:24:38 +0000462 {Name: dlEvReset, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g,
463 dlStBridgeInit, dlStDownloaded}, Dst: dlStResetting},
464 // exceptional treatment for all states except dlStResetting
465 {Name: dlEvRestart, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g,
466 dlStBridgeInit, dlStDownloaded, dlStResetting}, Dst: dlStDisabled},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000467 },
468
469 fsm.Callbacks{
dbainbri4d3a0dc2020-12-02 00:33:42 +0000470 "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibDownloadFsm.logFsmStateChange(ctx, e) },
471 "enter_" + dlStStarting: func(e *fsm.Event) { onuDeviceEntry.enterDLStartingState(ctx, e) },
472 "enter_" + dlStCreatingGal: func(e *fsm.Event) { onuDeviceEntry.enterCreatingGalState(ctx, e) },
473 "enter_" + dlStSettingOnu2g: func(e *fsm.Event) { onuDeviceEntry.enterSettingOnu2gState(ctx, e) },
474 "enter_" + dlStBridgeInit: func(e *fsm.Event) { onuDeviceEntry.enterBridgeInitState(ctx, e) },
475 "enter_" + dlStDownloaded: func(e *fsm.Event) { onuDeviceEntry.enterDownloadedState(ctx, e) },
476 "enter_" + dlStResetting: func(e *fsm.Event) { onuDeviceEntry.enterResettingState(ctx, e) },
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000477 },
478 )
479 if onuDeviceEntry.pMibDownloadFsm == nil || onuDeviceEntry.pMibDownloadFsm.pFsm == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000480 logger.Errorw(ctx, "MibDownloadFsm could not be instantiated", log.Fields{"device-id": dh.deviceID})
mpagenko15ff4a52021-03-02 10:09:20 +0000481 // TODO some specific error treatment - or waiting for crash ?
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000482 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000483
dbainbri4d3a0dc2020-12-02 00:33:42 +0000484 onuDeviceEntry.mibTemplateKVStore = onuDeviceEntry.baseDeviceHandler.setBackend(ctx, cBasePathMibTemplateKvStore)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000485 if onuDeviceEntry.mibTemplateKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000486 logger.Errorw(ctx, "Can't access mibTemplateKVStore - no backend connection to service",
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000487 log.Fields{"device-id": dh.deviceID, "service": cBasePathMibTemplateKvStore})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000488 }
489
490 onuDeviceEntry.onuKVStorePath = onuDeviceEntry.deviceID
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800491 baseKvStorePath := fmt.Sprintf(cBasePathOnuKVStore, dh.pOpenOnuAc.cm.Backend.PathPrefix)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000492 onuDeviceEntry.onuKVStore = onuDeviceEntry.baseDeviceHandler.setBackend(ctx, baseKvStorePath)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000493 if onuDeviceEntry.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000494 logger.Errorw(ctx, "Can't access onuKVStore - no backend connection to service",
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800495 log.Fields{"device-id": dh.deviceID, "service": baseKvStorePath})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000496 }
497
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000498 // Alarm Synchronization Database
Himani Chawlaac1f5ad2021-02-04 21:21:54 +0530499
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000500 //self._alarm_db = None
501 //self._alarm_database_cls = support_classes['alarm-synchronizer']['database']
502 return &onuDeviceEntry
503}
504
Himani Chawla6d2ae152020-09-02 13:11:20 +0530505//start starts (logs) the omci agent
506func (oo *OnuDeviceEntry) start(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000507 logger.Debugw(ctx, "OnuDeviceEntry-starting", log.Fields{"for device-id": oo.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000508 if oo.PDevOmciCC == nil {
mpagenko900ee4b2020-10-12 11:56:34 +0000509 oo.PDevOmciCC = newOmciCC(ctx, oo, oo.deviceID, oo.baseDeviceHandler,
510 oo.coreProxy, oo.adapterProxy)
511 if oo.PDevOmciCC == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000512 logger.Errorw(ctx, "Could not create devOmciCc - abort", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000513 return fmt.Errorf("could not create devOmciCc %s", oo.deviceID)
514 }
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000515 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000516 return nil
517}
518
mpagenko900ee4b2020-10-12 11:56:34 +0000519//stop stops/resets the omciCC
520func (oo *OnuDeviceEntry) stop(ctx context.Context, abResetOmciCC bool) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000521 logger.Debugw(ctx, "OnuDeviceEntry-stopping", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000522 if abResetOmciCC && (oo.PDevOmciCC != nil) {
523 _ = oo.PDevOmciCC.stop(ctx)
524 }
525 //to allow for all event notifications again when re-using the device and omciCC
526 oo.devState = DeviceStatusInit
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000527 return nil
528}
529
Himani Chawla6d2ae152020-09-02 13:11:20 +0530530func (oo *OnuDeviceEntry) reboot(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000531 logger.Debugw(ctx, "OnuDeviceEntry-rebooting", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000532 if oo.PDevOmciCC != nil {
Girish Gowdra0b235842021-03-09 13:06:46 -0800533 if err := oo.PDevOmciCC.sendReboot(ctx, oo.pOpenOnuAc.omciTimeout, true, oo.omciRebootMessageReceivedChannel); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000534 logger.Errorw(ctx, "onu didn't reboot", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000535 return err
536 }
ozgecanetsiae11479f2020-07-06 09:44:47 +0300537 }
ozgecanetsiae11479f2020-07-06 09:44:47 +0300538 return nil
539}
540
dbainbri4d3a0dc2020-12-02 00:33:42 +0000541func (oo *OnuDeviceEntry) waitForRebootResponse(ctx context.Context, responseChannel chan Message) error {
ozgecanetsiae11479f2020-07-06 09:44:47 +0300542 select {
543 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 +0000544 logger.Warnw(ctx, "Reboot timeout", log.Fields{"for device-id": oo.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200545 return fmt.Errorf("rebootTimeout")
ozgecanetsiae11479f2020-07-06 09:44:47 +0300546 case data := <-responseChannel:
547 switch data.Data.(OmciMessage).OmciMsg.MessageType {
548 case omci.RebootResponseType:
549 {
550 msgLayer := (*data.Data.(OmciMessage).OmciPacket).Layer(omci.LayerTypeRebootResponse)
551 if msgLayer == nil {
Andrea Campanella6515c582020-10-05 11:25:00 +0200552 return fmt.Errorf("omci Msg layer could not be detected for RebootResponseType")
ozgecanetsiae11479f2020-07-06 09:44:47 +0300553 }
Andrea Campanellabef4e542020-10-22 11:01:28 +0200554 msgObj, msgOk := msgLayer.(*omci.RebootResponse)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300555 if !msgOk {
Andrea Campanella6515c582020-10-05 11:25:00 +0200556 return fmt.Errorf("omci Msg layer could not be assigned for RebootResponseType %s", oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300557 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000558 logger.Debugw(ctx, "RebootResponse data", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300559 if msgObj.Result != me.Success {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000560 logger.Errorw(ctx, "Omci RebootResponse result error", log.Fields{"device-id": oo.deviceID, "Error": msgObj.Result})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300561 // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
Andrea Campanellabef4e542020-10-22 11:01:28 +0200562 return fmt.Errorf("omci RebootResponse result error indication %s for device %s",
Andrea Campanella6515c582020-10-05 11:25:00 +0200563 msgObj.Result, oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300564 }
565 return nil
566 }
567 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000568 logger.Warnw(ctx, "Reboot response message type error", log.Fields{"for device-id": oo.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200569 return fmt.Errorf("unexpected OmciResponse type received %s", oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300570 }
571}
572
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000573//Relay the InSync message via Handler to Rw core - Status update
dbainbri4d3a0dc2020-12-02 00:33:42 +0000574func (oo *OnuDeviceEntry) transferSystemEvent(ctx context.Context, devEvent OnuDeviceEvent) {
575 logger.Debugw(ctx, "relaying system-event", log.Fields{"Event": devEvent})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000576 // decouple the handler transfer from further processing here
577 // TODO!!! check if really no synch is required within the system e.g. to ensure following steps ..
Himani Chawla26e555c2020-08-31 12:30:20 +0530578 if devEvent == MibDatabaseSync {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000579 if oo.devState < MibDatabaseSync { //devState has not been synced yet
580 oo.devState = MibDatabaseSync
dbainbri4d3a0dc2020-12-02 00:33:42 +0000581 go oo.baseDeviceHandler.deviceProcStatusUpdate(ctx, devEvent)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000582 //TODO!!! device control: next step: start MIB capability verification from here ?!!!
583 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000584 logger.Debugw(ctx, "mibinsync-event in some already synced state - ignored", log.Fields{"state": oo.devState})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000585 }
Himani Chawla26e555c2020-08-31 12:30:20 +0530586 } else if devEvent == MibDownloadDone {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000587 if oo.devState < MibDownloadDone { //devState has not been synced yet
588 oo.devState = MibDownloadDone
dbainbri4d3a0dc2020-12-02 00:33:42 +0000589 go oo.baseDeviceHandler.deviceProcStatusUpdate(ctx, devEvent)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000590 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000591 logger.Debugw(ctx, "mibdownloaddone-event was already seen - ignored", log.Fields{"state": oo.devState})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000592 }
593 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000594 logger.Warnw(ctx, "device-event not yet handled", log.Fields{"state": devEvent})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000595 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000596}
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000597
598func (oo *OnuDeviceEntry) restoreDataFromOnuKvStore(ctx context.Context) error {
599 if oo.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000600 logger.Debugw(ctx, "onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000601 return fmt.Errorf(fmt.Sprintf("onuKVStore-not-set-abort-%s", oo.deviceID))
602 }
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000603 oo.persUniConfigMutex.Lock()
604 defer oo.persUniConfigMutex.Unlock()
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000605 oo.sOnuPersistentData =
Himani Chawla075f1642021-03-15 19:23:24 +0530606 onuPersistentData{0, 0, "", "", "", "", "", "", "", false, false, oo.mibAuditInterval, 0, 0, make([]uniPersConfig, 0), oo.alarmAuditInterval}
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000607 oo.onuKVStoreMutex.RLock()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000608 Value, err := oo.onuKVStore.Get(ctx, oo.onuKVStorePath)
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000609 oo.onuKVStoreMutex.RUnlock()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000610 if err == nil {
611 if Value != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000612 logger.Debugw(ctx, "ONU-data read",
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000613 log.Fields{"Key": Value.Key, "device-id": oo.deviceID})
614 tmpBytes, _ := kvstore.ToByte(Value.Value)
615
616 if err = json.Unmarshal(tmpBytes, &oo.sOnuPersistentData); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000617 logger.Errorw(ctx, "unable to unmarshal ONU-data", log.Fields{"error": err, "device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000618 return fmt.Errorf(fmt.Sprintf("unable-to-unmarshal-ONU-data-%s", oo.deviceID))
619 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000620 logger.Debugw(ctx, "ONU-data", log.Fields{"sOnuPersistentData": oo.sOnuPersistentData,
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000621 "device-id": oo.deviceID})
622 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000623 logger.Debugw(ctx, "no ONU-data found", log.Fields{"path": oo.onuKVStorePath, "device-id": oo.deviceID})
mpagenko2418ab02020-11-12 12:58:06 +0000624 return fmt.Errorf("no-ONU-data-found")
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000625 }
626 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000627 logger.Errorw(ctx, "unable to read from KVstore", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000628 return fmt.Errorf(fmt.Sprintf("unable-to-read-from-KVstore-%s", oo.deviceID))
629 }
630 return nil
631}
632
633func (oo *OnuDeviceEntry) deleteDataFromOnuKvStore(ctx context.Context, wg *sync.WaitGroup) {
634 defer wg.Done()
635
636 if oo.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000637 logger.Debugw(ctx, "onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000638 oo.onuKVStoreprocResult = errors.New("onu-data delete aborted: onuKVStore not set")
639 return
640 }
641 var processingStep uint8 = 1 // used to synchronize the different processing steps with chOnuKvProcessingStep
642 go oo.deletePersistentData(ctx, processingStep)
643 if !oo.waitForTimeoutOrCompletion(ctx, oo.chOnuKvProcessingStep, processingStep) {
644 //timeout or error detected
dbainbri4d3a0dc2020-12-02 00:33:42 +0000645 logger.Debugw(ctx, "ONU-data not deleted - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000646 oo.onuKVStoreprocResult = errors.New("onu-data delete aborted: during kv-access")
647 return
648 }
649}
650
651func (oo *OnuDeviceEntry) deletePersistentData(ctx context.Context, aProcessingStep uint8) {
652
dbainbri4d3a0dc2020-12-02 00:33:42 +0000653 logger.Debugw(ctx, "delete and clear internal persistency data", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000654
655 oo.persUniConfigMutex.Lock()
656 defer oo.persUniConfigMutex.Unlock()
657
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000658 oo.sOnuPersistentData.PersUniConfig = nil //releasing all UniConfig entries to garbage collector default entry
659 oo.sOnuPersistentData =
Himani Chawla075f1642021-03-15 19:23:24 +0530660 onuPersistentData{0, 0, "", "", "", "", "", "", "", false, false, oo.mibAuditInterval, 0, 0, make([]uniPersConfig, 0), oo.alarmAuditInterval}
dbainbri4d3a0dc2020-12-02 00:33:42 +0000661 logger.Debugw(ctx, "delete ONU-data from KVStore", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000662 oo.onuKVStoreMutex.Lock()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000663 err := oo.onuKVStore.Delete(ctx, oo.onuKVStorePath)
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000664 oo.onuKVStoreMutex.Unlock()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000665 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000666 logger.Errorw(ctx, "unable to delete in KVstore", log.Fields{"device-id": oo.deviceID, "err": err})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000667 oo.chOnuKvProcessingStep <- 0 //error indication
668 return
669 }
670 oo.chOnuKvProcessingStep <- aProcessingStep //done
671}
672
673func (oo *OnuDeviceEntry) updateOnuKvStore(ctx context.Context, wg *sync.WaitGroup) {
674 defer wg.Done()
675
676 if oo.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000677 logger.Debugw(ctx, "onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000678 oo.onuKVStoreprocResult = errors.New("onu-data update aborted: onuKVStore not set")
679 return
680 }
681 var processingStep uint8 = 1 // used to synchronize the different processing steps with chOnuKvProcessingStep
682 go oo.storeDataInOnuKvStore(ctx, processingStep)
683 if !oo.waitForTimeoutOrCompletion(ctx, oo.chOnuKvProcessingStep, processingStep) {
684 //timeout or error detected
dbainbri4d3a0dc2020-12-02 00:33:42 +0000685 logger.Debugw(ctx, "ONU-data not written - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000686 oo.onuKVStoreprocResult = errors.New("onu-data update aborted: during writing process")
687 return
688 }
689}
690
691func (oo *OnuDeviceEntry) storeDataInOnuKvStore(ctx context.Context, aProcessingStep uint8) {
692
693 //assign values which are not already present when newOnuDeviceEntry() is called
694 oo.sOnuPersistentData.PersOnuID = oo.baseDeviceHandler.pOnuIndication.OnuId
695 oo.sOnuPersistentData.PersIntfID = oo.baseDeviceHandler.pOnuIndication.IntfId
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000696 //TODO: verify usage of these values during restart UC
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000697 oo.sOnuPersistentData.PersAdminState = oo.baseDeviceHandler.pOnuIndication.AdminState
698 oo.sOnuPersistentData.PersOperState = oo.baseDeviceHandler.pOnuIndication.OperState
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000699
700 oo.persUniConfigMutex.RLock()
701 defer oo.persUniConfigMutex.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +0000702 logger.Debugw(ctx, "Update ONU-data in KVStore", log.Fields{"device-id": oo.deviceID, "sOnuPersistentData": oo.sOnuPersistentData})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000703
704 Value, err := json.Marshal(oo.sOnuPersistentData)
705 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000706 logger.Errorw(ctx, "unable to marshal ONU-data", log.Fields{"sOnuPersistentData": oo.sOnuPersistentData,
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000707 "device-id": oo.deviceID, "err": err})
708 oo.chOnuKvProcessingStep <- 0 //error indication
709 return
710 }
Holger Hildebrandtff05b682021-03-16 15:02:05 +0000711 oo.pOpenOnuAc.lockDeviceHandlersMap.RLock()
712 if _, exist := oo.pOpenOnuAc.deviceHandlers[oo.deviceID]; !exist {
713 logger.Debugw(ctx, "delete_device in progress - skip write request", log.Fields{"device-id": oo.deviceID})
714 oo.chOnuKvProcessingStep <- aProcessingStep
715 oo.pOpenOnuAc.lockDeviceHandlersMap.RUnlock()
716 return
717 }
718 oo.baseDeviceHandler.mutexDeletionInProgressFlag.RLock()
719 if oo.baseDeviceHandler.deletionInProgress {
720 logger.Debugw(ctx, "delete_device in progress - skip write request", log.Fields{"device-id": oo.deviceID})
721 oo.chOnuKvProcessingStep <- aProcessingStep
722 oo.pOpenOnuAc.lockDeviceHandlersMap.RUnlock()
723 oo.baseDeviceHandler.mutexDeletionInProgressFlag.RUnlock()
724 return
725 }
726 oo.pOpenOnuAc.lockDeviceHandlersMap.RUnlock()
727 oo.baseDeviceHandler.mutexDeletionInProgressFlag.RUnlock()
728
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000729 oo.onuKVStoreMutex.Lock()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000730 err = oo.onuKVStore.Put(ctx, oo.onuKVStorePath, Value)
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000731 oo.onuKVStoreMutex.Unlock()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000732 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000733 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 +0000734 oo.chOnuKvProcessingStep <- 0 //error indication
735 return
736 }
737 oo.chOnuKvProcessingStep <- aProcessingStep //done
738}
739
dbainbri4d3a0dc2020-12-02 00:33:42 +0000740func (oo *OnuDeviceEntry) updateOnuUniTpPath(ctx context.Context, aUniID uint8, aTpID uint8, aPathString string) bool {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000741 /* within some specific InterAdapter processing request write/read access to data is ensured to be sequentially,
742 as also the complete sequence is ensured to 'run to completion' before some new request is accepted
743 no specific concurrency protection to sOnuPersistentData is required here
744 */
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000745 oo.persUniConfigMutex.Lock()
746 defer oo.persUniConfigMutex.Unlock()
747
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000748 for k, v := range oo.sOnuPersistentData.PersUniConfig {
749 if v.PersUniID == aUniID {
mpagenko30f28442021-03-24 09:24:04 +0000750 logger.Debugw(ctx, "PersUniConfig-entry exists", log.Fields{"device-id": oo.deviceID, "uniID": aUniID})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800751 existingPath, ok := oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID]
752 if !ok {
mpagenko30f28442021-03-24 09:24:04 +0000753 logger.Debugw(ctx, "tp-does-not-exist", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "tpID": aTpID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800754 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000755 if existingPath != aPathString {
756 if aPathString == "" {
757 //existing entry to be deleted
dbainbri4d3a0dc2020-12-02 00:33:42 +0000758 logger.Debugw(ctx, "UniTp delete path value", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800759 oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID] = ""
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000760 } else {
761 //existing entry to be modified
dbainbri4d3a0dc2020-12-02 00:33:42 +0000762 logger.Debugw(ctx, "UniTp modify path value", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800763 oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID] = aPathString
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000764 }
765 return true
766 }
767 //entry already exists
mpagenkofc4f56e2020-11-04 17:17:49 +0000768 if aPathString == "" {
769 //no active TechProfile
dbainbri4d3a0dc2020-12-02 00:33:42 +0000770 logger.Debugw(ctx, "UniTp path has already been removed - no AniSide config to be removed", log.Fields{
mpagenkofc4f56e2020-11-04 17:17:49 +0000771 "device-id": oo.deviceID, "uniID": aUniID})
mpagenkofc4f56e2020-11-04 17:17:49 +0000772 } else {
773 //the given TechProfile already exists and is assumed to be active - update devReason as if the config has been done here
774 //was needed e.g. in voltha POD Tests:Validate authentication on a disabled ONU
775 // (as here the TechProfile has not been removed with the disable-device before the new enable-device)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000776 logger.Debugw(ctx, "UniTp path already exists - TechProfile supposed to be active", log.Fields{
mpagenkofc4f56e2020-11-04 17:17:49 +0000777 "device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
778 //no deviceReason update (deviceProcStatusUpdate) here to ensure 'omci_flows_pushed' state within disable/enable procedure of ATT scenario
779 // (during which the flows are removed/re-assigned but the techProf is left active)
780 //and as the TechProfile is regarded as active we have to verify, if some flow configuration still waits on it
781 // (should not be the case, but should not harm or be more robust ...)
mpagenko2418ab02020-11-12 12:58:06 +0000782 // and to be sure, that for some reason the corresponding TpDelete was lost somewhere in history
783 // we also reset a possibly outstanding delete request - repeated TpConfig is regarded as valid for waiting flow config
784 if oo.baseDeviceHandler.pOnuTP != nil {
Girish Gowdra041dcb32020-11-16 16:54:30 -0800785 oo.baseDeviceHandler.pOnuTP.setProfileToDelete(aUniID, aTpID, false)
mpagenko2418ab02020-11-12 12:58:06 +0000786 }
mpagenko551a4d42020-12-08 18:09:20 +0000787 go oo.baseDeviceHandler.VerifyVlanConfigRequest(ctx, aUniID, aTpID)
mpagenkofc4f56e2020-11-04 17:17:49 +0000788 }
789 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 +0000790 }
791 }
792 //no entry exists for uniId
793
794 if aPathString == "" {
795 //delete request in non-existing state , accept as no change
dbainbri4d3a0dc2020-12-02 00:33:42 +0000796 logger.Debugw(ctx, "UniTp path already removed", log.Fields{"device-id": oo.deviceID, "uniID": aUniID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000797 return false
798 }
799 //new entry to be created
dbainbri4d3a0dc2020-12-02 00:33:42 +0000800 logger.Debugw(ctx, "New UniTp path set", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800801 perSubTpPathMap := make(map[uint8]string)
802 perSubTpPathMap[aTpID] = aPathString
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000803 oo.sOnuPersistentData.PersUniConfig =
Girish Gowdra041dcb32020-11-16 16:54:30 -0800804 append(oo.sOnuPersistentData.PersUniConfig, uniPersConfig{PersUniID: aUniID, PersTpPathMap: perSubTpPathMap, PersFlowParams: make([]uniVlanFlowParams, 0)})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000805 return true
806}
807
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000808func (oo *OnuDeviceEntry) updateOnuUniFlowConfig(aUniID uint8, aUniVlanFlowParams *[]uniVlanFlowParams) {
809
Holger Hildebrandtdaf0f722021-02-12 11:50:30 +0000810 oo.persUniConfigMutex.Lock()
811 defer oo.persUniConfigMutex.Unlock()
812
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000813 for k, v := range oo.sOnuPersistentData.PersUniConfig {
814 if v.PersUniID == aUniID {
815 oo.sOnuPersistentData.PersUniConfig[k].PersFlowParams = make([]uniVlanFlowParams, len(*aUniVlanFlowParams))
816 copy(oo.sOnuPersistentData.PersUniConfig[k].PersFlowParams, *aUniVlanFlowParams)
817 return
818 }
819 }
820 //flow update was faster than tp-config - create PersUniConfig-entry
mpagenko30f28442021-03-24 09:24:04 +0000821 //TODO!!: following activity to 'add' some new uni entry might not be quite correct if this function is called to clear the data
822 // (e.g after flow removal from RemoveUniFlowParams()).
823 // This has the effect of misleading indication that there is still some active UNI entry, even though there might be only some nil flow entry
824 // The effect of this flaw is that at TechProfile removal there is an additional attempt to remove the entry even though no techProfile exists anymore
825 // The code is not changed here because of the current release lane, changes might have unexpected secondary effects, perhaps later with more elaborate tests
Girish Gowdra041dcb32020-11-16 16:54:30 -0800826 tmpConfig := uniPersConfig{PersUniID: aUniID, PersTpPathMap: make(map[uint8]string), PersFlowParams: make([]uniVlanFlowParams, len(*aUniVlanFlowParams))}
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000827 copy(tmpConfig.PersFlowParams, *aUniVlanFlowParams)
828 oo.sOnuPersistentData.PersUniConfig = append(oo.sOnuPersistentData.PersUniConfig, tmpConfig)
829}
830
831func (oo *OnuDeviceEntry) waitForTimeoutOrCompletion(
832 ctx context.Context, aChOnuProcessingStep <-chan uint8, aProcessingStep uint8) bool {
833 select {
834 case <-ctx.Done():
dbainbri4d3a0dc2020-12-02 00:33:42 +0000835 logger.Warnw(ctx, "processing not completed in-time!",
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000836 log.Fields{"device-id": oo.deviceID, "error": ctx.Err()})
837 return false
838 case rxStep := <-aChOnuProcessingStep:
839 if rxStep == aProcessingStep {
840 return true
841 }
842 //all other values are not accepted - including 0 for error indication
dbainbri4d3a0dc2020-12-02 00:33:42 +0000843 logger.Warnw(ctx, "Invalid processing step received: abort!",
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000844 log.Fields{"device-id": oo.deviceID,
845 "wantedStep": aProcessingStep, "haveStep": rxStep})
846 return false
847 }
848}
849
850func (oo *OnuDeviceEntry) resetKvProcessingErrorIndication() {
851 oo.onuKVStoreprocResult = nil
852}
853func (oo *OnuDeviceEntry) getKvProcessingErrorIndication() error {
854 return oo.onuKVStoreprocResult
855}
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000856func (oo *OnuDeviceEntry) incrementMibDataSync(ctx context.Context) {
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000857 if oo.sOnuPersistentData.PersMibDataSyncAdpt < 255 {
858 oo.sOnuPersistentData.PersMibDataSyncAdpt++
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000859 } else {
860 // per G.984 and G.988 overflow starts over at 1 given 0 is reserved for reset
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000861 oo.sOnuPersistentData.PersMibDataSyncAdpt = 1
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000862 }
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000863 logger.Debugf(ctx, "mibDataSync updated - mds: %d - device-id: %s", oo.sOnuPersistentData.PersMibDataSyncAdpt, oo.deviceID)
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000864}
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000865
866func (oo *OnuDeviceEntry) buildMibTemplatePath() string {
867 return fmt.Sprintf(cSuffixMibTemplateKvStore, oo.sOnuPersistentData.PersVendorID, oo.sOnuPersistentData.PersEquipmentID, oo.sOnuPersistentData.PersActiveSwVersion)
868}