blob: 82963cb85bda8c7f66dbb83d0265be4fd3b2f293 [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"
78 ulStInSync = "ulStInSync"
79 ulStExaminingMds = "ulStExaminingMds"
80 ulStResynchronizing = "ulStResynchronizing"
81 ulStAuditing = "ulStAuditing"
82 ulStOutOfSync = "ulStOutOfSync"
83)
84
85const (
86 // events of MibDownload FSM
87 dlEvStart = "dlEvStart"
88 dlEvCreateGal = "dlEvCreateGal"
89 dlEvRxGalResp = "dlEvRxGalResp"
90 dlEvRxOnu2gResp = "dlEvRxOnu2gResp"
91 dlEvRxBridgeResp = "dlEvRxBridgeResp"
92 dlEvTimeoutSimple = "dlEvTimeoutSimple"
93 dlEvTimeoutBridge = "dlEvTimeoutBridge"
94 dlEvReset = "dlEvReset"
95 dlEvRestart = "dlEvRestart"
96)
97const (
98 // states of MibDownload FSM
99 dlStDisabled = "dlStDisabled"
100 dlStStarting = "dlStStarting"
101 dlStCreatingGal = "dlStCreatingGal"
102 dlStSettingOnu2g = "dlStSettingOnu2g"
103 dlStBridgeInit = "dlStBridgeInit"
104 dlStDownloaded = "dlStDownloaded"
105 dlStResetting = "dlStResetting"
106)
107
108const (
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800109 // NOTE that this hardcoded to service/voltha as the MIB template is shared across stacks
Holger Hildebrandt2ff21f12020-08-13 14:38:02 +0000110 cBasePathMibTemplateKvStore = "service/voltha/omci_mibs/go_templates"
mpagenkoaf801632020-07-03 10:00:42 +0000111 cSuffixMibTemplateKvStore = "%s/%s/%s"
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800112 cBasePathOnuKVStore = "%s/openonu"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000113)
114
Himani Chawla6d2ae152020-09-02 13:11:20 +0530115// OnuDeviceEvent - event of interest to Device Adapters and OpenOMCI State Machines
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000116type OnuDeviceEvent int
117
118const (
119 // Events of interest to Device Adapters and OpenOMCI State Machines
Himani Chawla6d2ae152020-09-02 13:11:20 +0530120
121 // DeviceStatusInit - default start state
mpagenkofc4f56e2020-11-04 17:17:49 +0000122 DeviceStatusInit OnuDeviceEvent = iota
Himani Chawla6d2ae152020-09-02 13:11:20 +0530123 // MibDatabaseSync - MIB database sync (upload done)
mpagenkofc4f56e2020-11-04 17:17:49 +0000124 MibDatabaseSync
Himani Chawla6d2ae152020-09-02 13:11:20 +0530125 // OmciCapabilitiesDone - OMCI ME and message type capabilities known
mpagenkofc4f56e2020-11-04 17:17:49 +0000126 OmciCapabilitiesDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530127 // MibDownloadDone - // MIB download done
mpagenkofc4f56e2020-11-04 17:17:49 +0000128 MibDownloadDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530129 // UniLockStateDone - Uni ports admin set to lock
mpagenkofc4f56e2020-11-04 17:17:49 +0000130 UniLockStateDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530131 // UniUnlockStateDone - Uni ports admin set to unlock
mpagenkofc4f56e2020-11-04 17:17:49 +0000132 UniUnlockStateDone
mpagenko900ee4b2020-10-12 11:56:34 +0000133 // UniDisableStateDone - Uni ports admin set to lock based on device disable
mpagenkofc4f56e2020-11-04 17:17:49 +0000134 UniDisableStateDone
mpagenko900ee4b2020-10-12 11:56:34 +0000135 // UniEnableStateDone - Uni ports admin set to unlock based on device re-enable
mpagenkofc4f56e2020-11-04 17:17:49 +0000136 UniEnableStateDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530137 // PortLinkUp - Port link state change
mpagenkofc4f56e2020-11-04 17:17:49 +0000138 PortLinkUp
Himani Chawla6d2ae152020-09-02 13:11:20 +0530139 // PortLinkDw - Port link state change
mpagenkofc4f56e2020-11-04 17:17:49 +0000140 PortLinkDw
Himani Chawla6d2ae152020-09-02 13:11:20 +0530141 // OmciAniConfigDone - AniSide config according to TechProfile done
mpagenkofc4f56e2020-11-04 17:17:49 +0000142 OmciAniConfigDone
143 // OmciAniResourceRemoved - AniSide TechProfile related resource (Gem/TCont) removed
144 OmciAniResourceRemoved // needs to be the successor of OmciAniConfigDone!
145 // OmciVlanFilterAddDone - Omci Vlan config done according to flow-add
146 OmciVlanFilterAddDone
147 // OmciVlanFilterRemDone - Omci Vlan config done according to flow-remove
148 OmciVlanFilterRemDone // needs to be the successor of OmciVlanFilterAddDone!
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000149 // Add other events here as needed (alarms separate???)
150)
151
152type activityDescr struct {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000153 databaseClass func(context.Context) error
Himani Chawla4d908332020-08-31 12:30:20 +0530154 //advertiseEvents bool
155 auditDelay uint16
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000156 //tasks map[string]func() error
157}
Himani Chawla6d2ae152020-09-02 13:11:20 +0530158
159// OmciDeviceFsms - FSM event mapping to database class and time to wait between audits
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000160type OmciDeviceFsms map[string]activityDescr
161
Himani Chawla6d2ae152020-09-02 13:11:20 +0530162// AdapterFsm - Adapter FSM details including channel, event and device
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000163type AdapterFsm struct {
164 fsmName string
165 deviceID string
166 commChan chan Message
167 pFsm *fsm.FSM
168}
169
Himani Chawla6d2ae152020-09-02 13:11:20 +0530170//NewAdapterFsm - FSM details including event, device and channel.
171func NewAdapterFsm(aName string, aDeviceID string, aCommChannel chan Message) *AdapterFsm {
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000172 aFsm := &AdapterFsm{
Himani Chawla6d2ae152020-09-02 13:11:20 +0530173 fsmName: aName,
174 deviceID: aDeviceID,
175 commChan: aCommChannel,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000176 }
177 return aFsm
178}
179
180//Start starts (logs) the omci agent
dbainbri4d3a0dc2020-12-02 00:33:42 +0000181func (oo *AdapterFsm) logFsmStateChange(ctx context.Context, e *fsm.Event) {
182 logger.Debugw(ctx, "FSM state change", log.Fields{"device-id": oo.deviceID, "FSM name": oo.fsmName,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000183 "event name": string(e.Event), "src state": string(e.Src), "dst state": string(e.Dst)})
184}
185
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000186//OntDeviceEntry structure holds information about the attached FSM'as and their communication
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000187
188const (
Himani Chawla6d2ae152020-09-02 13:11:20 +0530189 firstSwImageMeID = 0
190 secondSwImageMeID = 1
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000191)
Himani Chawla6d2ae152020-09-02 13:11:20 +0530192const onugMeID = 0
193const onu2gMeID = 0
194const ipHostConfigDataMeID = 1
195const onugSerialNumberLen = 8
196const omciMacAddressLen = 6
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000197
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000198const cEmptyMacAddrString = "000000000000"
199const cEmptySerialNumberString = "0000000000000000"
200
Himani Chawla6d2ae152020-09-02 13:11:20 +0530201type swImages struct {
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000202 version string
203 isActive uint8
204}
205
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000206type uniPersConfig struct {
207 PersUniID uint8 `json:"uni_id"`
Girish Gowdra041dcb32020-11-16 16:54:30 -0800208 PersTpPathMap map[uint8]string `json:"PersTpPathMap"` // tp-id to tp-path map
209 PersFlowParams []uniVlanFlowParams `json:"flow_params"` //as defined in omci_ani_config.go
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000210}
211
212type onuPersistentData struct {
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000213 PersOnuID uint32 `json:"onu_id"`
214 PersIntfID uint32 `json:"intf_id"`
215 PersSnr string `json:"serial_number"`
216 PersAdminState string `json:"admin_state"`
217 PersOperState string `json:"oper_state"`
218 PersUniUnlockDone bool `json:"uni_unlock_done"`
219 PersUniDisableDone bool `json:"uni_disable_done"`
220 PersUniConfig []uniPersConfig `json:"uni_config"`
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000221}
222
Himani Chawla6d2ae152020-09-02 13:11:20 +0530223// OnuDeviceEntry - ONU device info and FSM events.
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000224type OnuDeviceEntry struct {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000225 deviceID string
226 baseDeviceHandler *deviceHandler
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000227 pOpenOnuAc *OpenONUAC
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000228 coreProxy adapterif.CoreProxy
229 adapterProxy adapterif.AdapterProxy
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000230 PDevOmciCC *omciCC
231 pOnuDB *onuDeviceDB
232 mibTemplateKVStore *db.Backend
233 sOnuPersistentData onuPersistentData
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000234 mibTemplatePath string
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000235 onuKVStoreMutex sync.RWMutex
236 onuKVStore *db.Backend
237 onuKVStorePath string
238 onuKVStoreprocResult error //error indication of processing
239 chOnuKvProcessingStep chan uint8
240 vendorID string
241 serialNumber string
242 equipmentID string
243 swImages [secondSwImageMeID + 1]swImages
244 activeSwVersion string
245 macAddress string
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000246 //lockDeviceEntries sync.RWMutex
dbainbri4d3a0dc2020-12-02 00:33:42 +0000247 mibDbClass func(context.Context) error
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000248 supportedFsms OmciDeviceFsms
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000249 devState OnuDeviceEvent
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000250 // for mibUpload
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000251 mibAuditDelay uint16
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000252
253 // for mibUpload
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000254 pMibUploadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later
255 // for mibDownload
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000256 pMibDownloadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later
257 //remark: general usage of pAdapterFsm would require generalization of commChan usage and internal event setting
258 // within the FSM event procedures
ozgecanetsiae11479f2020-07-06 09:44:47 +0300259 omciMessageReceived chan bool //seperate channel needed by DownloadFsm
260 omciRebootMessageReceivedChannel chan Message // channel needed by Reboot request
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000261}
262
Himani Chawla6d2ae152020-09-02 13:11:20 +0530263//newOnuDeviceEntry returns a new instance of a OnuDeviceEntry
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000264//mib_db (as well as not inluded alarm_db not really used in this code? VERIFY!!)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000265func newOnuDeviceEntry(ctx context.Context, dh *deviceHandler) *OnuDeviceEntry {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000266 logger.Debugw(ctx, "init-onuDeviceEntry", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000267 var onuDeviceEntry OnuDeviceEntry
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000268 onuDeviceEntry.deviceID = dh.deviceID
269 onuDeviceEntry.baseDeviceHandler = dh
270 onuDeviceEntry.pOpenOnuAc = dh.pOpenOnuAc
271 onuDeviceEntry.coreProxy = dh.coreProxy
272 onuDeviceEntry.adapterProxy = dh.AdapterProxy
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000273 onuDeviceEntry.devState = DeviceStatusInit
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000274 onuDeviceEntry.sOnuPersistentData.PersUniConfig = make([]uniPersConfig, 0)
275 onuDeviceEntry.chOnuKvProcessingStep = make(chan uint8)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300276 onuDeviceEntry.omciRebootMessageReceivedChannel = make(chan Message, 2048)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000277 //openomciagent.lockDeviceHandlersMap = sync.RWMutex{}
278 //OMCI related databases are on a per-agent basis. State machines and tasks
279 //are per ONU Vendor
280 //
281 // MIB Synchronization Database - possible overloading from arguments
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000282 if dh.pOpenOnuAc.pSupportedFsms != nil {
283 onuDeviceEntry.supportedFsms = *dh.pOpenOnuAc.pSupportedFsms
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000284 } else {
285 //var mibSyncFsm = NewMibSynchronizer()
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000286 // use some internaö defaults, if not defined from outside
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000287 onuDeviceEntry.supportedFsms = OmciDeviceFsms{
288 "mib-synchronizer": {
289 //mibSyncFsm, // Implements the MIB synchronization state machine
Himani Chawla6d2ae152020-09-02 13:11:20 +0530290 onuDeviceEntry.mibDbVolatileDict, // Implements volatile ME MIB database
Himani Chawla4d908332020-08-31 12:30:20 +0530291 //true, // Advertise events on OpenOMCI event bus
292 60, // Time to wait between MIB audits. 0 to disable audits.
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000293 // map[string]func() error{
294 // "mib-upload": onuDeviceEntry.MibUploadTask,
295 // "mib-template": onuDeviceEntry.MibTemplateTask,
296 // "get-mds": onuDeviceEntry.GetMdsTask,
297 // "mib-audit": onuDeviceEntry.GetMdsTask,
298 // "mib-resync": onuDeviceEntry.MibResyncTask,
299 // "mib-reconcile": onuDeviceEntry.MibReconcileTask,
300 // },
301 },
302 }
303 }
304 onuDeviceEntry.mibDbClass = onuDeviceEntry.supportedFsms["mib-synchronizer"].databaseClass
dbainbri4d3a0dc2020-12-02 00:33:42 +0000305 logger.Debug(ctx, "access2mibDbClass")
306 go onuDeviceEntry.mibDbClass(ctx)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000307 onuDeviceEntry.mibAuditDelay = onuDeviceEntry.supportedFsms["mib-synchronizer"].auditDelay
dbainbri4d3a0dc2020-12-02 00:33:42 +0000308 logger.Debugw(ctx, "MibAudit is set to", log.Fields{"Delay": onuDeviceEntry.mibAuditDelay})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000309
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000310 // Omci related Mib upload sync state machine
311 mibUploadChan := make(chan Message, 2048)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000312 onuDeviceEntry.pMibUploadFsm = NewAdapterFsm("MibUpload", dh.deviceID, mibUploadChan)
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000313 onuDeviceEntry.pMibUploadFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000314 ulStDisabled,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000315 fsm.Events{
316
mpagenko1cc3cb42020-07-27 15:24:38 +0000317 {Name: ulEvStart, Src: []string{ulStDisabled}, Dst: ulStStarting},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000318
mpagenko1cc3cb42020-07-27 15:24:38 +0000319 {Name: ulEvResetMib, Src: []string{ulStStarting}, Dst: ulStResettingMib},
320 {Name: ulEvGetVendorAndSerial, Src: []string{ulStResettingMib}, Dst: ulStGettingVendorAndSerial},
Himani Chawla4d908332020-08-31 12:30:20 +0530321 {Name: ulEvGetEquipmentID, Src: []string{ulStGettingVendorAndSerial}, Dst: ulStGettingEquipmentID},
322 {Name: ulEvGetFirstSwVersion, Src: []string{ulStGettingEquipmentID}, Dst: ulStGettingFirstSwVersion},
mpagenko1cc3cb42020-07-27 15:24:38 +0000323 {Name: ulEvGetSecondSwVersion, Src: []string{ulStGettingFirstSwVersion}, Dst: ulStGettingSecondSwVersion},
324 {Name: ulEvGetMacAddress, Src: []string{ulStGettingSecondSwVersion}, Dst: ulStGettingMacAddress},
325 {Name: ulEvGetMibTemplate, Src: []string{ulStGettingMacAddress}, Dst: ulStGettingMibTemplate},
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000326
mpagenko1cc3cb42020-07-27 15:24:38 +0000327 {Name: ulEvUploadMib, Src: []string{ulStGettingMibTemplate}, Dst: ulStUploading},
328 {Name: ulEvExamineMds, Src: []string{ulStStarting}, Dst: ulStExaminingMds},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000329
mpagenko1cc3cb42020-07-27 15:24:38 +0000330 {Name: ulEvSuccess, Src: []string{ulStGettingMibTemplate}, Dst: ulStInSync},
331 {Name: ulEvSuccess, Src: []string{ulStUploading}, Dst: ulStInSync},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000332
mpagenko1cc3cb42020-07-27 15:24:38 +0000333 {Name: ulEvSuccess, Src: []string{ulStExaminingMds}, Dst: ulStInSync},
334 {Name: ulEvMismatch, Src: []string{ulStExaminingMds}, Dst: ulStResynchronizing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000335
mpagenko1cc3cb42020-07-27 15:24:38 +0000336 {Name: ulEvAuditMib, Src: []string{ulStInSync}, Dst: ulStAuditing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000337
mpagenko1cc3cb42020-07-27 15:24:38 +0000338 {Name: ulEvSuccess, Src: []string{ulStOutOfSync}, Dst: ulStInSync},
339 {Name: ulEvAuditMib, Src: []string{ulStOutOfSync}, Dst: ulStAuditing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000340
mpagenko1cc3cb42020-07-27 15:24:38 +0000341 {Name: ulEvSuccess, Src: []string{ulStAuditing}, Dst: ulStInSync},
342 {Name: ulEvMismatch, Src: []string{ulStAuditing}, Dst: ulStResynchronizing},
343 {Name: ulEvForceResync, Src: []string{ulStAuditing}, Dst: ulStResynchronizing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000344
mpagenko1cc3cb42020-07-27 15:24:38 +0000345 {Name: ulEvSuccess, Src: []string{ulStResynchronizing}, Dst: ulStInSync},
346 {Name: ulEvDiffsFound, Src: []string{ulStResynchronizing}, Dst: ulStOutOfSync},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000347
Himani Chawla4d908332020-08-31 12:30:20 +0530348 {Name: ulEvTimeout, Src: []string{ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentID, ulStGettingFirstSwVersion,
mpagenko1cc3cb42020-07-27 15:24:38 +0000349 ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds,
350 ulStInSync, ulStOutOfSync, ulStAuditing}, Dst: ulStStarting},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000351
Himani Chawla4d908332020-08-31 12:30:20 +0530352 {Name: ulEvStop, Src: []string{ulStStarting, ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentID, ulStGettingFirstSwVersion,
mpagenko1cc3cb42020-07-27 15:24:38 +0000353 ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds,
354 ulStInSync, ulStOutOfSync, ulStAuditing}, Dst: ulStDisabled},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000355 },
356
357 fsm.Callbacks{
dbainbri4d3a0dc2020-12-02 00:33:42 +0000358 "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibUploadFsm.logFsmStateChange(ctx, e) },
359 "enter_" + ulStStarting: func(e *fsm.Event) { onuDeviceEntry.enterStartingState(ctx, e) },
360 "enter_" + ulStResettingMib: func(e *fsm.Event) { onuDeviceEntry.enterResettingMibState(ctx, e) },
361 "enter_" + ulStGettingVendorAndSerial: func(e *fsm.Event) { onuDeviceEntry.enterGettingVendorAndSerialState(ctx, e) },
362 "enter_" + ulStGettingEquipmentID: func(e *fsm.Event) { onuDeviceEntry.enterGettingEquipmentIDState(ctx, e) },
363 "enter_" + ulStGettingFirstSwVersion: func(e *fsm.Event) { onuDeviceEntry.enterGettingFirstSwVersionState(ctx, e) },
364 "enter_" + ulStGettingSecondSwVersion: func(e *fsm.Event) { onuDeviceEntry.enterGettingSecondSwVersionState(ctx, e) },
365 "enter_" + ulStGettingMacAddress: func(e *fsm.Event) { onuDeviceEntry.enterGettingMacAddressState(ctx, e) },
366 "enter_" + ulStGettingMibTemplate: func(e *fsm.Event) { onuDeviceEntry.enterGettingMibTemplate(ctx, e) },
367 "enter_" + ulStUploading: func(e *fsm.Event) { onuDeviceEntry.enterUploadingState(ctx, e) },
368 "enter_" + ulStExaminingMds: func(e *fsm.Event) { onuDeviceEntry.enterExaminingMdsState(ctx, e) },
369 "enter_" + ulStResynchronizing: func(e *fsm.Event) { onuDeviceEntry.enterResynchronizingState(ctx, e) },
370 "enter_" + ulStAuditing: func(e *fsm.Event) { onuDeviceEntry.enterAuditingState(ctx, e) },
371 "enter_" + ulStOutOfSync: func(e *fsm.Event) { onuDeviceEntry.enterOutOfSyncState(ctx, e) },
372 "enter_" + ulStInSync: func(e *fsm.Event) { onuDeviceEntry.enterInSyncState(ctx, e) },
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000373 },
374 )
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000375 // Omci related Mib download state machine
376 mibDownloadChan := make(chan Message, 2048)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000377 onuDeviceEntry.pMibDownloadFsm = NewAdapterFsm("MibDownload", dh.deviceID, mibDownloadChan)
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000378 onuDeviceEntry.pMibDownloadFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000379 dlStDisabled,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000380 fsm.Events{
381
mpagenko1cc3cb42020-07-27 15:24:38 +0000382 {Name: dlEvStart, Src: []string{dlStDisabled}, Dst: dlStStarting},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000383
mpagenko1cc3cb42020-07-27 15:24:38 +0000384 {Name: dlEvCreateGal, Src: []string{dlStStarting}, Dst: dlStCreatingGal},
385 {Name: dlEvRxGalResp, Src: []string{dlStCreatingGal}, Dst: dlStSettingOnu2g},
386 {Name: dlEvRxOnu2gResp, Src: []string{dlStSettingOnu2g}, Dst: dlStBridgeInit},
Holger Hildebrandtdd23cc22020-05-19 13:32:18 +0000387 // the bridge state is used for multi ME config for alle UNI related ports
388 // maybe such could be reflected in the state machine as well (port number parametrized)
389 // but that looks not straightforward here - so we keep it simple here for the beginning(?)
mpagenko1cc3cb42020-07-27 15:24:38 +0000390 {Name: dlEvRxBridgeResp, Src: []string{dlStBridgeInit}, Dst: dlStDownloaded},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000391
mpagenko1cc3cb42020-07-27 15:24:38 +0000392 {Name: dlEvTimeoutSimple, Src: []string{dlStCreatingGal, dlStSettingOnu2g}, Dst: dlStStarting},
393 {Name: dlEvTimeoutBridge, Src: []string{dlStBridgeInit}, Dst: dlStStarting},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000394
mpagenko1cc3cb42020-07-27 15:24:38 +0000395 {Name: dlEvReset, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g,
396 dlStBridgeInit, dlStDownloaded}, Dst: dlStResetting},
397 // exceptional treatment for all states except dlStResetting
398 {Name: dlEvRestart, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g,
399 dlStBridgeInit, dlStDownloaded, dlStResetting}, Dst: dlStDisabled},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000400 },
401
402 fsm.Callbacks{
dbainbri4d3a0dc2020-12-02 00:33:42 +0000403 "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibDownloadFsm.logFsmStateChange(ctx, e) },
404 "enter_" + dlStStarting: func(e *fsm.Event) { onuDeviceEntry.enterDLStartingState(ctx, e) },
405 "enter_" + dlStCreatingGal: func(e *fsm.Event) { onuDeviceEntry.enterCreatingGalState(ctx, e) },
406 "enter_" + dlStSettingOnu2g: func(e *fsm.Event) { onuDeviceEntry.enterSettingOnu2gState(ctx, e) },
407 "enter_" + dlStBridgeInit: func(e *fsm.Event) { onuDeviceEntry.enterBridgeInitState(ctx, e) },
408 "enter_" + dlStDownloaded: func(e *fsm.Event) { onuDeviceEntry.enterDownloadedState(ctx, e) },
409 "enter_" + dlStResetting: func(e *fsm.Event) { onuDeviceEntry.enterResettingState(ctx, e) },
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000410 },
411 )
412 if onuDeviceEntry.pMibDownloadFsm == nil || onuDeviceEntry.pMibDownloadFsm.pFsm == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000413 logger.Errorw(ctx, "MibDownloadFsm could not be instantiated", log.Fields{"device-id": dh.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200414 // TODO some specifc error treatment - or waiting for crash ?
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000415 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000416
dbainbri4d3a0dc2020-12-02 00:33:42 +0000417 onuDeviceEntry.mibTemplateKVStore = onuDeviceEntry.baseDeviceHandler.setBackend(ctx, cBasePathMibTemplateKvStore)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000418 if onuDeviceEntry.mibTemplateKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000419 logger.Errorw(ctx, "Can't access mibTemplateKVStore - no backend connection to service",
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000420 log.Fields{"device-id": dh.deviceID, "service": cBasePathMibTemplateKvStore})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000421 }
422
423 onuDeviceEntry.onuKVStorePath = onuDeviceEntry.deviceID
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800424 baseKvStorePath := fmt.Sprintf(cBasePathOnuKVStore, dh.pOpenOnuAc.cm.Backend.PathPrefix)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000425 onuDeviceEntry.onuKVStore = onuDeviceEntry.baseDeviceHandler.setBackend(ctx, baseKvStorePath)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000426 if onuDeviceEntry.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000427 logger.Errorw(ctx, "Can't access onuKVStore - no backend connection to service",
Matteo Scandolof1f39a72020-11-24 12:08:11 -0800428 log.Fields{"device-id": dh.deviceID, "service": baseKvStorePath})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000429 }
430
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000431 // Alarm Synchronization Database
432 //self._alarm_db = None
433 //self._alarm_database_cls = support_classes['alarm-synchronizer']['database']
434 return &onuDeviceEntry
435}
436
Himani Chawla6d2ae152020-09-02 13:11:20 +0530437//start starts (logs) the omci agent
438func (oo *OnuDeviceEntry) start(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000439 logger.Debugw(ctx, "OnuDeviceEntry-starting", log.Fields{"for device-id": oo.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000440 if oo.PDevOmciCC == nil {
mpagenko900ee4b2020-10-12 11:56:34 +0000441 oo.PDevOmciCC = newOmciCC(ctx, oo, oo.deviceID, oo.baseDeviceHandler,
442 oo.coreProxy, oo.adapterProxy)
443 if oo.PDevOmciCC == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000444 logger.Errorw(ctx, "Could not create devOmciCc - abort", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000445 return fmt.Errorf("could not create devOmciCc %s", oo.deviceID)
446 }
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000447 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000448 return nil
449}
450
mpagenko900ee4b2020-10-12 11:56:34 +0000451//stop stops/resets the omciCC
452func (oo *OnuDeviceEntry) stop(ctx context.Context, abResetOmciCC bool) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000453 logger.Debugw(ctx, "OnuDeviceEntry-stopping", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000454 if abResetOmciCC && (oo.PDevOmciCC != nil) {
455 _ = oo.PDevOmciCC.stop(ctx)
456 }
457 //to allow for all event notifications again when re-using the device and omciCC
458 oo.devState = DeviceStatusInit
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000459 return nil
460}
461
Himani Chawla6d2ae152020-09-02 13:11:20 +0530462func (oo *OnuDeviceEntry) reboot(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000463 logger.Debugw(ctx, "OnuDeviceEntry-rebooting", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000464 if oo.PDevOmciCC != nil {
465 if err := oo.PDevOmciCC.sendReboot(ctx, ConstDefaultOmciTimeout, true, oo.omciRebootMessageReceivedChannel); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000466 logger.Errorw(ctx, "onu didn't reboot", log.Fields{"for device-id": oo.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +0000467 return err
468 }
ozgecanetsiae11479f2020-07-06 09:44:47 +0300469 }
ozgecanetsiae11479f2020-07-06 09:44:47 +0300470 return nil
471}
472
dbainbri4d3a0dc2020-12-02 00:33:42 +0000473func (oo *OnuDeviceEntry) waitForRebootResponse(ctx context.Context, responseChannel chan Message) error {
ozgecanetsiae11479f2020-07-06 09:44:47 +0300474 select {
475 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 +0000476 logger.Warnw(ctx, "Reboot timeout", log.Fields{"for device-id": oo.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200477 return fmt.Errorf("rebootTimeout")
ozgecanetsiae11479f2020-07-06 09:44:47 +0300478 case data := <-responseChannel:
479 switch data.Data.(OmciMessage).OmciMsg.MessageType {
480 case omci.RebootResponseType:
481 {
482 msgLayer := (*data.Data.(OmciMessage).OmciPacket).Layer(omci.LayerTypeRebootResponse)
483 if msgLayer == nil {
Andrea Campanella6515c582020-10-05 11:25:00 +0200484 return fmt.Errorf("omci Msg layer could not be detected for RebootResponseType")
ozgecanetsiae11479f2020-07-06 09:44:47 +0300485 }
Andrea Campanellabef4e542020-10-22 11:01:28 +0200486 msgObj, msgOk := msgLayer.(*omci.RebootResponse)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300487 if !msgOk {
Andrea Campanella6515c582020-10-05 11:25:00 +0200488 return fmt.Errorf("omci Msg layer could not be assigned for RebootResponseType %s", oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300489 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000490 logger.Debugw(ctx, "RebootResponse data", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300491 if msgObj.Result != me.Success {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000492 logger.Errorw(ctx, "Omci RebootResponse result error", log.Fields{"device-id": oo.deviceID, "Error": msgObj.Result})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300493 // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
Andrea Campanellabef4e542020-10-22 11:01:28 +0200494 return fmt.Errorf("omci RebootResponse result error indication %s for device %s",
Andrea Campanella6515c582020-10-05 11:25:00 +0200495 msgObj.Result, oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300496 }
497 return nil
498 }
499 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000500 logger.Warnw(ctx, "Reboot response message type error", log.Fields{"for device-id": oo.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200501 return fmt.Errorf("unexpected OmciResponse type received %s", oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300502 }
503}
504
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000505//Relay the InSync message via Handler to Rw core - Status update
dbainbri4d3a0dc2020-12-02 00:33:42 +0000506func (oo *OnuDeviceEntry) transferSystemEvent(ctx context.Context, devEvent OnuDeviceEvent) {
507 logger.Debugw(ctx, "relaying system-event", log.Fields{"Event": devEvent})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000508 // decouple the handler transfer from further processing here
509 // TODO!!! check if really no synch is required within the system e.g. to ensure following steps ..
Himani Chawla26e555c2020-08-31 12:30:20 +0530510 if devEvent == MibDatabaseSync {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000511 if oo.devState < MibDatabaseSync { //devState has not been synced yet
512 oo.devState = MibDatabaseSync
dbainbri4d3a0dc2020-12-02 00:33:42 +0000513 go oo.baseDeviceHandler.deviceProcStatusUpdate(ctx, devEvent)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000514 //TODO!!! device control: next step: start MIB capability verification from here ?!!!
515 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000516 logger.Debugw(ctx, "mibinsync-event in some already synced state - ignored", log.Fields{"state": oo.devState})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000517 }
Himani Chawla26e555c2020-08-31 12:30:20 +0530518 } else if devEvent == MibDownloadDone {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000519 if oo.devState < MibDownloadDone { //devState has not been synced yet
520 oo.devState = MibDownloadDone
dbainbri4d3a0dc2020-12-02 00:33:42 +0000521 go oo.baseDeviceHandler.deviceProcStatusUpdate(ctx, devEvent)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000522 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000523 logger.Debugw(ctx, "mibdownloaddone-event was already seen - ignored", log.Fields{"state": oo.devState})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000524 }
525 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000526 logger.Warnw(ctx, "device-event not yet handled", log.Fields{"state": devEvent})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000527 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000528}
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000529
530func (oo *OnuDeviceEntry) restoreDataFromOnuKvStore(ctx context.Context) error {
531 if oo.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000532 logger.Debugw(ctx, "onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000533 return fmt.Errorf(fmt.Sprintf("onuKVStore-not-set-abort-%s", oo.deviceID))
534 }
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000535 oo.sOnuPersistentData = onuPersistentData{0, 0, "", "", "", false, false, make([]uniPersConfig, 0)}
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000536 Value, err := oo.onuKVStore.Get(ctx, oo.onuKVStorePath)
537 if err == nil {
538 if Value != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000539 logger.Debugw(ctx, "ONU-data read",
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000540 log.Fields{"Key": Value.Key, "device-id": oo.deviceID})
541 tmpBytes, _ := kvstore.ToByte(Value.Value)
542
543 if err = json.Unmarshal(tmpBytes, &oo.sOnuPersistentData); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000544 logger.Errorw(ctx, "unable to unmarshal ONU-data", log.Fields{"error": err, "device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000545 return fmt.Errorf(fmt.Sprintf("unable-to-unmarshal-ONU-data-%s", oo.deviceID))
546 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000547 logger.Debugw(ctx, "ONU-data", log.Fields{"sOnuPersistentData": oo.sOnuPersistentData,
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000548 "device-id": oo.deviceID})
549 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000550 logger.Debugw(ctx, "no ONU-data found", log.Fields{"path": oo.onuKVStorePath, "device-id": oo.deviceID})
mpagenko2418ab02020-11-12 12:58:06 +0000551 return fmt.Errorf("no-ONU-data-found")
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000552 }
553 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000554 logger.Errorw(ctx, "unable to read from KVstore", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000555 return fmt.Errorf(fmt.Sprintf("unable-to-read-from-KVstore-%s", oo.deviceID))
556 }
557 return nil
558}
559
560func (oo *OnuDeviceEntry) deleteDataFromOnuKvStore(ctx context.Context, wg *sync.WaitGroup) {
561 defer wg.Done()
562
563 if oo.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000564 logger.Debugw(ctx, "onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000565 oo.onuKVStoreprocResult = errors.New("onu-data delete aborted: onuKVStore not set")
566 return
567 }
568 var processingStep uint8 = 1 // used to synchronize the different processing steps with chOnuKvProcessingStep
569 go oo.deletePersistentData(ctx, processingStep)
570 if !oo.waitForTimeoutOrCompletion(ctx, oo.chOnuKvProcessingStep, processingStep) {
571 //timeout or error detected
dbainbri4d3a0dc2020-12-02 00:33:42 +0000572 logger.Debugw(ctx, "ONU-data not deleted - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000573 oo.onuKVStoreprocResult = errors.New("onu-data delete aborted: during kv-access")
574 return
575 }
576}
577
578func (oo *OnuDeviceEntry) deletePersistentData(ctx context.Context, aProcessingStep uint8) {
579
dbainbri4d3a0dc2020-12-02 00:33:42 +0000580 logger.Debugw(ctx, "delete and clear internal persistency data", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000581 oo.sOnuPersistentData.PersUniConfig = nil //releasing all UniConfig entries to garbage collector
582 oo.sOnuPersistentData = onuPersistentData{0, 0, "", "", "", false, false, make([]uniPersConfig, 0)} //default entry
mpagenko2418ab02020-11-12 12:58:06 +0000583
dbainbri4d3a0dc2020-12-02 00:33:42 +0000584 logger.Debugw(ctx, "delete ONU-data from KVStore", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000585 err := oo.onuKVStore.Delete(ctx, oo.onuKVStorePath)
586 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000587 logger.Errorw(ctx, "unable to delete in KVstore", log.Fields{"device-id": oo.deviceID, "err": err})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000588 oo.chOnuKvProcessingStep <- 0 //error indication
589 return
590 }
591 oo.chOnuKvProcessingStep <- aProcessingStep //done
592}
593
594func (oo *OnuDeviceEntry) updateOnuKvStore(ctx context.Context, wg *sync.WaitGroup) {
595 defer wg.Done()
596
597 if oo.onuKVStore == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000598 logger.Debugw(ctx, "onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000599 oo.onuKVStoreprocResult = errors.New("onu-data update aborted: onuKVStore not set")
600 return
601 }
602 var processingStep uint8 = 1 // used to synchronize the different processing steps with chOnuKvProcessingStep
603 go oo.storeDataInOnuKvStore(ctx, processingStep)
604 if !oo.waitForTimeoutOrCompletion(ctx, oo.chOnuKvProcessingStep, processingStep) {
605 //timeout or error detected
dbainbri4d3a0dc2020-12-02 00:33:42 +0000606 logger.Debugw(ctx, "ONU-data not written - abort", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000607 oo.onuKVStoreprocResult = errors.New("onu-data update aborted: during writing process")
608 return
609 }
610}
611
612func (oo *OnuDeviceEntry) storeDataInOnuKvStore(ctx context.Context, aProcessingStep uint8) {
613
614 //assign values which are not already present when newOnuDeviceEntry() is called
615 oo.sOnuPersistentData.PersOnuID = oo.baseDeviceHandler.pOnuIndication.OnuId
616 oo.sOnuPersistentData.PersIntfID = oo.baseDeviceHandler.pOnuIndication.IntfId
617 oo.sOnuPersistentData.PersSnr = oo.baseDeviceHandler.pOnuOmciDevice.serialNumber
618 //TODO: verify usage of these values during restart UC
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000619 oo.sOnuPersistentData.PersAdminState = oo.baseDeviceHandler.pOnuIndication.AdminState
620 oo.sOnuPersistentData.PersOperState = oo.baseDeviceHandler.pOnuIndication.OperState
dbainbri4d3a0dc2020-12-02 00:33:42 +0000621 logger.Debugw(ctx, "Update ONU-data in KVStore", log.Fields{"device-id": oo.deviceID, "sOnuPersistentData": oo.sOnuPersistentData})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000622
623 Value, err := json.Marshal(oo.sOnuPersistentData)
624 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000625 logger.Errorw(ctx, "unable to marshal ONU-data", log.Fields{"sOnuPersistentData": oo.sOnuPersistentData,
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000626 "device-id": oo.deviceID, "err": err})
627 oo.chOnuKvProcessingStep <- 0 //error indication
628 return
629 }
630 err = oo.onuKVStore.Put(ctx, oo.onuKVStorePath, Value)
631 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000632 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 +0000633 oo.chOnuKvProcessingStep <- 0 //error indication
634 return
635 }
636 oo.chOnuKvProcessingStep <- aProcessingStep //done
637}
638
dbainbri4d3a0dc2020-12-02 00:33:42 +0000639func (oo *OnuDeviceEntry) updateOnuUniTpPath(ctx context.Context, aUniID uint8, aTpID uint8, aPathString string) bool {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000640 /* within some specific InterAdapter processing request write/read access to data is ensured to be sequentially,
641 as also the complete sequence is ensured to 'run to completion' before some new request is accepted
642 no specific concurrency protection to sOnuPersistentData is required here
643 */
644 for k, v := range oo.sOnuPersistentData.PersUniConfig {
645 if v.PersUniID == aUniID {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000646 logger.Debugw(ctx, "PersUniConfig-entry already exists", log.Fields{"device-id": oo.deviceID, "uniID": aUniID})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800647 existingPath, ok := oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID]
648 if !ok {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000649 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 -0800650 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000651 if existingPath != aPathString {
652 if aPathString == "" {
653 //existing entry to be deleted
dbainbri4d3a0dc2020-12-02 00:33:42 +0000654 logger.Debugw(ctx, "UniTp delete path value", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800655 oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID] = ""
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000656 } else {
657 //existing entry to be modified
dbainbri4d3a0dc2020-12-02 00:33:42 +0000658 logger.Debugw(ctx, "UniTp modify path value", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800659 oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID] = aPathString
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000660 }
661 return true
662 }
663 //entry already exists
mpagenkofc4f56e2020-11-04 17:17:49 +0000664 if aPathString == "" {
665 //no active TechProfile
dbainbri4d3a0dc2020-12-02 00:33:42 +0000666 logger.Debugw(ctx, "UniTp path has already been removed - no AniSide config to be removed", log.Fields{
mpagenkofc4f56e2020-11-04 17:17:49 +0000667 "device-id": oo.deviceID, "uniID": aUniID})
668 // attention 201105: this block is at the moment entered for each of subsequent GemPortDeletes and TContDelete
669 // as the path is already cleared with the first GemPort - this will probably change with the upcoming real
670 // TechProfile removal (still TODO), but anyway the reasonUpdate initiated here should not harm overall behavior
dbainbri4d3a0dc2020-12-02 00:33:42 +0000671 go oo.baseDeviceHandler.deviceProcStatusUpdate(ctx, OmciAniResourceRemoved)
mpagenkofc4f56e2020-11-04 17:17:49 +0000672 // no flow config pending on 'remove' so far
673 } else {
674 //the given TechProfile already exists and is assumed to be active - update devReason as if the config has been done here
675 //was needed e.g. in voltha POD Tests:Validate authentication on a disabled ONU
676 // (as here the TechProfile has not been removed with the disable-device before the new enable-device)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000677 logger.Debugw(ctx, "UniTp path already exists - TechProfile supposed to be active", log.Fields{
mpagenkofc4f56e2020-11-04 17:17:49 +0000678 "device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
679 //no deviceReason update (deviceProcStatusUpdate) here to ensure 'omci_flows_pushed' state within disable/enable procedure of ATT scenario
680 // (during which the flows are removed/re-assigned but the techProf is left active)
681 //and as the TechProfile is regarded as active we have to verify, if some flow configuration still waits on it
682 // (should not be the case, but should not harm or be more robust ...)
mpagenko2418ab02020-11-12 12:58:06 +0000683 // and to be sure, that for some reason the corresponding TpDelete was lost somewhere in history
684 // we also reset a possibly outstanding delete request - repeated TpConfig is regarded as valid for waiting flow config
685 if oo.baseDeviceHandler.pOnuTP != nil {
Girish Gowdra041dcb32020-11-16 16:54:30 -0800686 oo.baseDeviceHandler.pOnuTP.setProfileToDelete(aUniID, aTpID, false)
mpagenko2418ab02020-11-12 12:58:06 +0000687 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000688 go oo.baseDeviceHandler.VerifyVlanConfigRequest(ctx, aUniID)
mpagenkofc4f56e2020-11-04 17:17:49 +0000689 }
690 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 +0000691 }
692 }
693 //no entry exists for uniId
694
695 if aPathString == "" {
696 //delete request in non-existing state , accept as no change
dbainbri4d3a0dc2020-12-02 00:33:42 +0000697 logger.Debugw(ctx, "UniTp path already removed", log.Fields{"device-id": oo.deviceID, "uniID": aUniID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000698 return false
699 }
700 //new entry to be created
dbainbri4d3a0dc2020-12-02 00:33:42 +0000701 logger.Debugw(ctx, "New UniTp path set", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800702 perSubTpPathMap := make(map[uint8]string)
703 perSubTpPathMap[aTpID] = aPathString
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000704 oo.sOnuPersistentData.PersUniConfig =
Girish Gowdra041dcb32020-11-16 16:54:30 -0800705 append(oo.sOnuPersistentData.PersUniConfig, uniPersConfig{PersUniID: aUniID, PersTpPathMap: perSubTpPathMap, PersFlowParams: make([]uniVlanFlowParams, 0)})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000706 return true
707}
708
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000709func (oo *OnuDeviceEntry) updateOnuUniFlowConfig(aUniID uint8, aUniVlanFlowParams *[]uniVlanFlowParams) {
710
711 for k, v := range oo.sOnuPersistentData.PersUniConfig {
712 if v.PersUniID == aUniID {
713 oo.sOnuPersistentData.PersUniConfig[k].PersFlowParams = make([]uniVlanFlowParams, len(*aUniVlanFlowParams))
714 copy(oo.sOnuPersistentData.PersUniConfig[k].PersFlowParams, *aUniVlanFlowParams)
715 return
716 }
717 }
718 //flow update was faster than tp-config - create PersUniConfig-entry
Girish Gowdra041dcb32020-11-16 16:54:30 -0800719 tmpConfig := uniPersConfig{PersUniID: aUniID, PersTpPathMap: make(map[uint8]string), PersFlowParams: make([]uniVlanFlowParams, len(*aUniVlanFlowParams))}
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000720 copy(tmpConfig.PersFlowParams, *aUniVlanFlowParams)
721 oo.sOnuPersistentData.PersUniConfig = append(oo.sOnuPersistentData.PersUniConfig, tmpConfig)
722}
723
724func (oo *OnuDeviceEntry) waitForTimeoutOrCompletion(
725 ctx context.Context, aChOnuProcessingStep <-chan uint8, aProcessingStep uint8) bool {
726 select {
727 case <-ctx.Done():
dbainbri4d3a0dc2020-12-02 00:33:42 +0000728 logger.Warnw(ctx, "processing not completed in-time!",
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000729 log.Fields{"device-id": oo.deviceID, "error": ctx.Err()})
730 return false
731 case rxStep := <-aChOnuProcessingStep:
732 if rxStep == aProcessingStep {
733 return true
734 }
735 //all other values are not accepted - including 0 for error indication
dbainbri4d3a0dc2020-12-02 00:33:42 +0000736 logger.Warnw(ctx, "Invalid processing step received: abort!",
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000737 log.Fields{"device-id": oo.deviceID,
738 "wantedStep": aProcessingStep, "haveStep": rxStep})
739 return false
740 }
741}
742
743func (oo *OnuDeviceEntry) resetKvProcessingErrorIndication() {
744 oo.onuKVStoreprocResult = nil
745}
746func (oo *OnuDeviceEntry) getKvProcessingErrorIndication() error {
747 return oo.onuKVStoreprocResult
748}
749
750func (oo *OnuDeviceEntry) lockOnuKVStoreMutex() {
751 oo.onuKVStoreMutex.Lock()
752}
753
754func (oo *OnuDeviceEntry) unlockOnuKVStoreMutex() {
755 oo.onuKVStoreMutex.Unlock()
756}