blob: 7cd20e5c372619532d72f7a3a234963c219c10a7 [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"
35 "github.com/opencord/voltha-lib-go/v3/pkg/adapters/adapterif"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000036 "github.com/opencord/voltha-lib-go/v3/pkg/db"
Holger Hildebrandt47555e72020-09-21 11:07:24 +000037 "github.com/opencord/voltha-lib-go/v3/pkg/db/kvstore"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000038
39 //"github.com/opencord/voltha-lib-go/v3/pkg/kafka"
40 "github.com/opencord/voltha-lib-go/v3/pkg/log"
41 //ic "github.com/opencord/voltha-protos/v3/go/inter_container"
42 //"github.com/opencord/voltha-protos/v3/go/openflow_13"
43 //"github.com/opencord/voltha-protos/v3/go/voltha"
44)
45
Holger 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 (
Holger Hildebrandt2ff21f12020-08-13 14:38:02 +0000109 cBasePathMibTemplateKvStore = "service/voltha/omci_mibs/go_templates"
mpagenkoaf801632020-07-03 10:00:42 +0000110 cSuffixMibTemplateKvStore = "%s/%s/%s"
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000111 cBasePathOnuKVStore = "service/voltha/openonu"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000112)
113
Himani Chawla6d2ae152020-09-02 13:11:20 +0530114// OnuDeviceEvent - event of interest to Device Adapters and OpenOMCI State Machines
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000115type OnuDeviceEvent int
116
117const (
118 // Events of interest to Device Adapters and OpenOMCI State Machines
Himani Chawla6d2ae152020-09-02 13:11:20 +0530119
120 // DeviceStatusInit - default start state
mpagenkofc4f56e2020-11-04 17:17:49 +0000121 DeviceStatusInit OnuDeviceEvent = iota
Himani Chawla6d2ae152020-09-02 13:11:20 +0530122 // MibDatabaseSync - MIB database sync (upload done)
mpagenkofc4f56e2020-11-04 17:17:49 +0000123 MibDatabaseSync
Himani Chawla6d2ae152020-09-02 13:11:20 +0530124 // OmciCapabilitiesDone - OMCI ME and message type capabilities known
mpagenkofc4f56e2020-11-04 17:17:49 +0000125 OmciCapabilitiesDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530126 // MibDownloadDone - // MIB download done
mpagenkofc4f56e2020-11-04 17:17:49 +0000127 MibDownloadDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530128 // UniLockStateDone - Uni ports admin set to lock
mpagenkofc4f56e2020-11-04 17:17:49 +0000129 UniLockStateDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530130 // UniUnlockStateDone - Uni ports admin set to unlock
mpagenkofc4f56e2020-11-04 17:17:49 +0000131 UniUnlockStateDone
mpagenko900ee4b2020-10-12 11:56:34 +0000132 // UniDisableStateDone - Uni ports admin set to lock based on device disable
mpagenkofc4f56e2020-11-04 17:17:49 +0000133 UniDisableStateDone
mpagenko900ee4b2020-10-12 11:56:34 +0000134 // UniEnableStateDone - Uni ports admin set to unlock based on device re-enable
mpagenkofc4f56e2020-11-04 17:17:49 +0000135 UniEnableStateDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530136 // PortLinkUp - Port link state change
mpagenkofc4f56e2020-11-04 17:17:49 +0000137 PortLinkUp
Himani Chawla6d2ae152020-09-02 13:11:20 +0530138 // PortLinkDw - Port link state change
mpagenkofc4f56e2020-11-04 17:17:49 +0000139 PortLinkDw
Himani Chawla6d2ae152020-09-02 13:11:20 +0530140 // OmciAniConfigDone - AniSide config according to TechProfile done
mpagenkofc4f56e2020-11-04 17:17:49 +0000141 OmciAniConfigDone
142 // OmciAniResourceRemoved - AniSide TechProfile related resource (Gem/TCont) removed
143 OmciAniResourceRemoved // needs to be the successor of OmciAniConfigDone!
144 // OmciVlanFilterAddDone - Omci Vlan config done according to flow-add
145 OmciVlanFilterAddDone
146 // OmciVlanFilterRemDone - Omci Vlan config done according to flow-remove
147 OmciVlanFilterRemDone // needs to be the successor of OmciVlanFilterAddDone!
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000148 // Add other events here as needed (alarms separate???)
149)
150
151type activityDescr struct {
Himani Chawla4d908332020-08-31 12:30:20 +0530152 databaseClass func() error
153 //advertiseEvents bool
154 auditDelay uint16
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000155 //tasks map[string]func() error
156}
Himani Chawla6d2ae152020-09-02 13:11:20 +0530157
158// OmciDeviceFsms - FSM event mapping to database class and time to wait between audits
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000159type OmciDeviceFsms map[string]activityDescr
160
Himani Chawla6d2ae152020-09-02 13:11:20 +0530161// AdapterFsm - Adapter FSM details including channel, event and device
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000162type AdapterFsm struct {
163 fsmName string
164 deviceID string
165 commChan chan Message
166 pFsm *fsm.FSM
167}
168
Himani Chawla6d2ae152020-09-02 13:11:20 +0530169//NewAdapterFsm - FSM details including event, device and channel.
170func NewAdapterFsm(aName string, aDeviceID string, aCommChannel chan Message) *AdapterFsm {
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000171 aFsm := &AdapterFsm{
Himani Chawla6d2ae152020-09-02 13:11:20 +0530172 fsmName: aName,
173 deviceID: aDeviceID,
174 commChan: aCommChannel,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000175 }
176 return aFsm
177}
178
179//Start starts (logs) the omci agent
180func (oo *AdapterFsm) logFsmStateChange(e *fsm.Event) {
181 logger.Debugw("FSM state change", log.Fields{"device-id": oo.deviceID, "FSM name": oo.fsmName,
182 "event name": string(e.Event), "src state": string(e.Src), "dst state": string(e.Dst)})
183}
184
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000185//OntDeviceEntry structure holds information about the attached FSM'as and their communication
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000186
187const (
Himani Chawla6d2ae152020-09-02 13:11:20 +0530188 firstSwImageMeID = 0
189 secondSwImageMeID = 1
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000190)
Himani Chawla6d2ae152020-09-02 13:11:20 +0530191const onugMeID = 0
192const onu2gMeID = 0
193const ipHostConfigDataMeID = 1
194const onugSerialNumberLen = 8
195const omciMacAddressLen = 6
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000196
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000197const cEmptyMacAddrString = "000000000000"
198const cEmptySerialNumberString = "0000000000000000"
199
Himani Chawla6d2ae152020-09-02 13:11:20 +0530200type swImages struct {
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000201 version string
202 isActive uint8
203}
204
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000205type uniPersConfig struct {
206 PersUniID uint8 `json:"uni_id"`
Girish Gowdra041dcb32020-11-16 16:54:30 -0800207 PersTpPathMap map[uint8]string `json:"PersTpPathMap"` // tp-id to tp-path map
208 PersFlowParams []uniVlanFlowParams `json:"flow_params"` //as defined in omci_ani_config.go
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000209}
210
211type onuPersistentData struct {
212 PersOnuID uint32 `json:"onu_id"`
213 PersIntfID uint32 `json:"intf_id"`
214 PersSnr string `json:"serial_number"`
215 PersAdminState string `json:"admin_state"`
216 PersOperState string `json:"oper_state"`
217 PersUniConfig []uniPersConfig `json:"uni_config"`
218}
219
Himani Chawla6d2ae152020-09-02 13:11:20 +0530220// OnuDeviceEntry - ONU device info and FSM events.
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000221type OnuDeviceEntry struct {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000222 deviceID string
223 baseDeviceHandler *deviceHandler
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000224 pOpenOnuAc *OpenONUAC
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000225 coreProxy adapterif.CoreProxy
226 adapterProxy adapterif.AdapterProxy
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000227 PDevOmciCC *omciCC
228 pOnuDB *onuDeviceDB
229 mibTemplateKVStore *db.Backend
230 sOnuPersistentData onuPersistentData
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000231 mibTemplatePath string
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000232 onuKVStoreMutex sync.RWMutex
233 onuKVStore *db.Backend
234 onuKVStorePath string
235 onuKVStoreprocResult error //error indication of processing
236 chOnuKvProcessingStep chan uint8
237 vendorID string
238 serialNumber string
239 equipmentID string
240 swImages [secondSwImageMeID + 1]swImages
241 activeSwVersion string
242 macAddress string
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000243 //lockDeviceEntries sync.RWMutex
244 mibDbClass func() error
245 supportedFsms OmciDeviceFsms
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000246 devState OnuDeviceEvent
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000247 // for mibUpload
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000248 mibAuditDelay uint16
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000249
250 // for mibUpload
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000251 pMibUploadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later
252 // for mibDownload
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000253 pMibDownloadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later
254 //remark: general usage of pAdapterFsm would require generalization of commChan usage and internal event setting
255 // within the FSM event procedures
ozgecanetsiae11479f2020-07-06 09:44:47 +0300256 omciMessageReceived chan bool //seperate channel needed by DownloadFsm
257 omciRebootMessageReceivedChannel chan Message // channel needed by Reboot request
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000258}
259
Himani Chawla6d2ae152020-09-02 13:11:20 +0530260//newOnuDeviceEntry returns a new instance of a OnuDeviceEntry
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000261//mib_db (as well as not inluded alarm_db not really used in this code? VERIFY!!)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000262func newOnuDeviceEntry(ctx context.Context, dh *deviceHandler) *OnuDeviceEntry {
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000263 logger.Debugw("init-onuDeviceEntry", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000264 var onuDeviceEntry OnuDeviceEntry
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000265 onuDeviceEntry.deviceID = dh.deviceID
266 onuDeviceEntry.baseDeviceHandler = dh
267 onuDeviceEntry.pOpenOnuAc = dh.pOpenOnuAc
268 onuDeviceEntry.coreProxy = dh.coreProxy
269 onuDeviceEntry.adapterProxy = dh.AdapterProxy
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000270 onuDeviceEntry.devState = DeviceStatusInit
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000271 onuDeviceEntry.sOnuPersistentData.PersUniConfig = make([]uniPersConfig, 0)
272 onuDeviceEntry.chOnuKvProcessingStep = make(chan uint8)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300273 onuDeviceEntry.omciRebootMessageReceivedChannel = make(chan Message, 2048)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000274 //openomciagent.lockDeviceHandlersMap = sync.RWMutex{}
275 //OMCI related databases are on a per-agent basis. State machines and tasks
276 //are per ONU Vendor
277 //
278 // MIB Synchronization Database - possible overloading from arguments
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000279 if dh.pOpenOnuAc.pSupportedFsms != nil {
280 onuDeviceEntry.supportedFsms = *dh.pOpenOnuAc.pSupportedFsms
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000281 } else {
282 //var mibSyncFsm = NewMibSynchronizer()
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000283 // use some internaö defaults, if not defined from outside
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000284 onuDeviceEntry.supportedFsms = OmciDeviceFsms{
285 "mib-synchronizer": {
286 //mibSyncFsm, // Implements the MIB synchronization state machine
Himani Chawla6d2ae152020-09-02 13:11:20 +0530287 onuDeviceEntry.mibDbVolatileDict, // Implements volatile ME MIB database
Himani Chawla4d908332020-08-31 12:30:20 +0530288 //true, // Advertise events on OpenOMCI event bus
289 60, // Time to wait between MIB audits. 0 to disable audits.
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000290 // map[string]func() error{
291 // "mib-upload": onuDeviceEntry.MibUploadTask,
292 // "mib-template": onuDeviceEntry.MibTemplateTask,
293 // "get-mds": onuDeviceEntry.GetMdsTask,
294 // "mib-audit": onuDeviceEntry.GetMdsTask,
295 // "mib-resync": onuDeviceEntry.MibResyncTask,
296 // "mib-reconcile": onuDeviceEntry.MibReconcileTask,
297 // },
298 },
299 }
300 }
301 onuDeviceEntry.mibDbClass = onuDeviceEntry.supportedFsms["mib-synchronizer"].databaseClass
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000302 logger.Debug("access2mibDbClass")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000303 go onuDeviceEntry.mibDbClass()
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000304 onuDeviceEntry.mibAuditDelay = onuDeviceEntry.supportedFsms["mib-synchronizer"].auditDelay
305 logger.Debugw("MibAudit is set to", log.Fields{"Delay": onuDeviceEntry.mibAuditDelay})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000306
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000307 // Omci related Mib upload sync state machine
308 mibUploadChan := make(chan Message, 2048)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000309 onuDeviceEntry.pMibUploadFsm = NewAdapterFsm("MibUpload", dh.deviceID, mibUploadChan)
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000310 onuDeviceEntry.pMibUploadFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000311 ulStDisabled,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000312 fsm.Events{
313
mpagenko1cc3cb42020-07-27 15:24:38 +0000314 {Name: ulEvStart, Src: []string{ulStDisabled}, Dst: ulStStarting},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000315
mpagenko1cc3cb42020-07-27 15:24:38 +0000316 {Name: ulEvResetMib, Src: []string{ulStStarting}, Dst: ulStResettingMib},
317 {Name: ulEvGetVendorAndSerial, Src: []string{ulStResettingMib}, Dst: ulStGettingVendorAndSerial},
Himani Chawla4d908332020-08-31 12:30:20 +0530318 {Name: ulEvGetEquipmentID, Src: []string{ulStGettingVendorAndSerial}, Dst: ulStGettingEquipmentID},
319 {Name: ulEvGetFirstSwVersion, Src: []string{ulStGettingEquipmentID}, Dst: ulStGettingFirstSwVersion},
mpagenko1cc3cb42020-07-27 15:24:38 +0000320 {Name: ulEvGetSecondSwVersion, Src: []string{ulStGettingFirstSwVersion}, Dst: ulStGettingSecondSwVersion},
321 {Name: ulEvGetMacAddress, Src: []string{ulStGettingSecondSwVersion}, Dst: ulStGettingMacAddress},
322 {Name: ulEvGetMibTemplate, Src: []string{ulStGettingMacAddress}, Dst: ulStGettingMibTemplate},
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000323
mpagenko1cc3cb42020-07-27 15:24:38 +0000324 {Name: ulEvUploadMib, Src: []string{ulStGettingMibTemplate}, Dst: ulStUploading},
325 {Name: ulEvExamineMds, Src: []string{ulStStarting}, Dst: ulStExaminingMds},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000326
mpagenko1cc3cb42020-07-27 15:24:38 +0000327 {Name: ulEvSuccess, Src: []string{ulStGettingMibTemplate}, Dst: ulStInSync},
328 {Name: ulEvSuccess, Src: []string{ulStUploading}, Dst: ulStInSync},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000329
mpagenko1cc3cb42020-07-27 15:24:38 +0000330 {Name: ulEvSuccess, Src: []string{ulStExaminingMds}, Dst: ulStInSync},
331 {Name: ulEvMismatch, Src: []string{ulStExaminingMds}, Dst: ulStResynchronizing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000332
mpagenko1cc3cb42020-07-27 15:24:38 +0000333 {Name: ulEvAuditMib, Src: []string{ulStInSync}, Dst: ulStAuditing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000334
mpagenko1cc3cb42020-07-27 15:24:38 +0000335 {Name: ulEvSuccess, Src: []string{ulStOutOfSync}, Dst: ulStInSync},
336 {Name: ulEvAuditMib, Src: []string{ulStOutOfSync}, Dst: ulStAuditing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000337
mpagenko1cc3cb42020-07-27 15:24:38 +0000338 {Name: ulEvSuccess, Src: []string{ulStAuditing}, Dst: ulStInSync},
339 {Name: ulEvMismatch, Src: []string{ulStAuditing}, Dst: ulStResynchronizing},
340 {Name: ulEvForceResync, Src: []string{ulStAuditing}, Dst: ulStResynchronizing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000341
mpagenko1cc3cb42020-07-27 15:24:38 +0000342 {Name: ulEvSuccess, Src: []string{ulStResynchronizing}, Dst: ulStInSync},
343 {Name: ulEvDiffsFound, Src: []string{ulStResynchronizing}, Dst: ulStOutOfSync},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000344
Himani Chawla4d908332020-08-31 12:30:20 +0530345 {Name: ulEvTimeout, Src: []string{ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentID, ulStGettingFirstSwVersion,
mpagenko1cc3cb42020-07-27 15:24:38 +0000346 ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds,
347 ulStInSync, ulStOutOfSync, ulStAuditing}, Dst: ulStStarting},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000348
Himani Chawla4d908332020-08-31 12:30:20 +0530349 {Name: ulEvStop, Src: []string{ulStStarting, ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentID, ulStGettingFirstSwVersion,
mpagenko1cc3cb42020-07-27 15:24:38 +0000350 ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds,
351 ulStInSync, ulStOutOfSync, ulStAuditing}, Dst: ulStDisabled},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000352 },
353
354 fsm.Callbacks{
Girish Gowdra041dcb32020-11-16 16:54:30 -0800355 "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibUploadFsm.logFsmStateChange(e) },
356 "enter_" + ulStStarting: func(e *fsm.Event) { onuDeviceEntry.enterStartingState(e) },
357 "enter_" + ulStResettingMib: func(e *fsm.Event) { onuDeviceEntry.enterResettingMibState(e) },
358 "enter_" + ulStGettingVendorAndSerial: func(e *fsm.Event) { onuDeviceEntry.enterGettingVendorAndSerialState(e) },
359 "enter_" + ulStGettingEquipmentID: func(e *fsm.Event) { onuDeviceEntry.enterGettingEquipmentIDState(e) },
360 "enter_" + ulStGettingFirstSwVersion: func(e *fsm.Event) { onuDeviceEntry.enterGettingFirstSwVersionState(e) },
361 "enter_" + ulStGettingSecondSwVersion: func(e *fsm.Event) { onuDeviceEntry.enterGettingSecondSwVersionState(e) },
362 "enter_" + ulStGettingMacAddress: func(e *fsm.Event) { onuDeviceEntry.enterGettingMacAddressState(e) },
363 "enter_" + ulStGettingMibTemplate: func(e *fsm.Event) { onuDeviceEntry.enterGettingMibTemplate(e) },
364 "enter_" + ulStUploading: func(e *fsm.Event) { onuDeviceEntry.enterUploadingState(e) },
365 "enter_" + ulStExaminingMds: func(e *fsm.Event) { onuDeviceEntry.enterExaminingMdsState(e) },
366 "enter_" + ulStResynchronizing: func(e *fsm.Event) { onuDeviceEntry.enterResynchronizingState(e) },
367 "enter_" + ulStAuditing: func(e *fsm.Event) { onuDeviceEntry.enterAuditingState(e) },
368 "enter_" + ulStOutOfSync: func(e *fsm.Event) { onuDeviceEntry.enterOutOfSyncState(e) },
369 "enter_" + ulStInSync: func(e *fsm.Event) { onuDeviceEntry.enterInSyncState(e) },
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000370 },
371 )
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000372 // Omci related Mib download state machine
373 mibDownloadChan := make(chan Message, 2048)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000374 onuDeviceEntry.pMibDownloadFsm = NewAdapterFsm("MibDownload", dh.deviceID, mibDownloadChan)
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000375 onuDeviceEntry.pMibDownloadFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000376 dlStDisabled,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000377 fsm.Events{
378
mpagenko1cc3cb42020-07-27 15:24:38 +0000379 {Name: dlEvStart, Src: []string{dlStDisabled}, Dst: dlStStarting},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000380
mpagenko1cc3cb42020-07-27 15:24:38 +0000381 {Name: dlEvCreateGal, Src: []string{dlStStarting}, Dst: dlStCreatingGal},
382 {Name: dlEvRxGalResp, Src: []string{dlStCreatingGal}, Dst: dlStSettingOnu2g},
383 {Name: dlEvRxOnu2gResp, Src: []string{dlStSettingOnu2g}, Dst: dlStBridgeInit},
Holger Hildebrandtdd23cc22020-05-19 13:32:18 +0000384 // the bridge state is used for multi ME config for alle UNI related ports
385 // maybe such could be reflected in the state machine as well (port number parametrized)
386 // but that looks not straightforward here - so we keep it simple here for the beginning(?)
mpagenko1cc3cb42020-07-27 15:24:38 +0000387 {Name: dlEvRxBridgeResp, Src: []string{dlStBridgeInit}, Dst: dlStDownloaded},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000388
mpagenko1cc3cb42020-07-27 15:24:38 +0000389 {Name: dlEvTimeoutSimple, Src: []string{dlStCreatingGal, dlStSettingOnu2g}, Dst: dlStStarting},
390 {Name: dlEvTimeoutBridge, Src: []string{dlStBridgeInit}, Dst: dlStStarting},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000391
mpagenko1cc3cb42020-07-27 15:24:38 +0000392 {Name: dlEvReset, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g,
393 dlStBridgeInit, dlStDownloaded}, Dst: dlStResetting},
394 // exceptional treatment for all states except dlStResetting
395 {Name: dlEvRestart, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g,
396 dlStBridgeInit, dlStDownloaded, dlStResetting}, Dst: dlStDisabled},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000397 },
398
399 fsm.Callbacks{
Girish Gowdra041dcb32020-11-16 16:54:30 -0800400 "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibDownloadFsm.logFsmStateChange(e) },
401 "enter_" + dlStStarting: func(e *fsm.Event) { onuDeviceEntry.enterDLStartingState(e) },
402 "enter_" + dlStCreatingGal: func(e *fsm.Event) { onuDeviceEntry.enterCreatingGalState(e) },
403 "enter_" + dlStSettingOnu2g: func(e *fsm.Event) { onuDeviceEntry.enterSettingOnu2gState(e) },
404 "enter_" + dlStBridgeInit: func(e *fsm.Event) { onuDeviceEntry.enterBridgeInitState(e) },
405 "enter_" + dlStDownloaded: func(e *fsm.Event) { onuDeviceEntry.enterDownloadedState(e) },
406 "enter_" + dlStResetting: func(e *fsm.Event) { onuDeviceEntry.enterResettingState(e) },
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000407 },
408 )
409 if onuDeviceEntry.pMibDownloadFsm == nil || onuDeviceEntry.pMibDownloadFsm.pFsm == nil {
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000410 logger.Errorw("MibDownloadFsm could not be instantiated", log.Fields{"device-id": dh.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200411 // TODO some specifc error treatment - or waiting for crash ?
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000412 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000413
Himani Chawla6d2ae152020-09-02 13:11:20 +0530414 onuDeviceEntry.mibTemplateKVStore = onuDeviceEntry.baseDeviceHandler.setBackend(cBasePathMibTemplateKvStore)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000415 if onuDeviceEntry.mibTemplateKVStore == nil {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000416 logger.Errorw("Can't access mibTemplateKVStore - no backend connection to service",
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000417 log.Fields{"device-id": dh.deviceID, "service": cBasePathMibTemplateKvStore})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000418 }
419
420 onuDeviceEntry.onuKVStorePath = onuDeviceEntry.deviceID
421 onuDeviceEntry.onuKVStore = onuDeviceEntry.baseDeviceHandler.setBackend(cBasePathOnuKVStore)
422 if onuDeviceEntry.onuKVStore == nil {
423 logger.Errorw("Can't access onuKVStore - no backend connection to service",
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000424 log.Fields{"device-id": dh.deviceID, "service": cBasePathOnuKVStore})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000425 }
426
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000427 // Alarm Synchronization Database
428 //self._alarm_db = None
429 //self._alarm_database_cls = support_classes['alarm-synchronizer']['database']
430 return &onuDeviceEntry
431}
432
Himani Chawla6d2ae152020-09-02 13:11:20 +0530433//start starts (logs) the omci agent
434func (oo *OnuDeviceEntry) start(ctx context.Context) error {
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000435 logger.Debugw("OnuDeviceEntry-starting", log.Fields{"for device-id": oo.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000436 if oo.PDevOmciCC == nil {
mpagenko900ee4b2020-10-12 11:56:34 +0000437 oo.PDevOmciCC = newOmciCC(ctx, oo, oo.deviceID, oo.baseDeviceHandler,
438 oo.coreProxy, oo.adapterProxy)
439 if oo.PDevOmciCC == nil {
440 logger.Errorw("Could not create devOmciCc - abort", log.Fields{"for device-id": oo.deviceID})
441 return fmt.Errorf("could not create devOmciCc %s", oo.deviceID)
442 }
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000443 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000444 return nil
445}
446
mpagenko900ee4b2020-10-12 11:56:34 +0000447//stop stops/resets the omciCC
448func (oo *OnuDeviceEntry) stop(ctx context.Context, abResetOmciCC bool) error {
449 logger.Debugw("OnuDeviceEntry-stopping", log.Fields{"for device-id": oo.deviceID})
450 if abResetOmciCC && (oo.PDevOmciCC != nil) {
451 _ = oo.PDevOmciCC.stop(ctx)
452 }
453 //to allow for all event notifications again when re-using the device and omciCC
454 oo.devState = DeviceStatusInit
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000455 return nil
456}
457
Himani Chawla6d2ae152020-09-02 13:11:20 +0530458func (oo *OnuDeviceEntry) reboot(ctx context.Context) error {
mpagenko900ee4b2020-10-12 11:56:34 +0000459 logger.Debugw("OnuDeviceEntry-rebooting", log.Fields{"for device-id": oo.deviceID})
460 if oo.PDevOmciCC != nil {
461 if err := oo.PDevOmciCC.sendReboot(ctx, ConstDefaultOmciTimeout, true, oo.omciRebootMessageReceivedChannel); err != nil {
462 logger.Errorw("onu didn't reboot", log.Fields{"for device-id": oo.deviceID})
463 return err
464 }
ozgecanetsiae11479f2020-07-06 09:44:47 +0300465 }
ozgecanetsiae11479f2020-07-06 09:44:47 +0300466 return nil
467}
468
469func (oo *OnuDeviceEntry) waitForRebootResponse(responseChannel chan Message) error {
470 select {
471 case <-time.After(3 * time.Second): //3s was detected to be to less in 8*8 bbsim test with debug Info/Debug
472 logger.Warnw("Reboot timeout", log.Fields{"for device-id": oo.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200473 return fmt.Errorf("rebootTimeout")
ozgecanetsiae11479f2020-07-06 09:44:47 +0300474 case data := <-responseChannel:
475 switch data.Data.(OmciMessage).OmciMsg.MessageType {
476 case omci.RebootResponseType:
477 {
478 msgLayer := (*data.Data.(OmciMessage).OmciPacket).Layer(omci.LayerTypeRebootResponse)
479 if msgLayer == nil {
Andrea Campanella6515c582020-10-05 11:25:00 +0200480 return fmt.Errorf("omci Msg layer could not be detected for RebootResponseType")
ozgecanetsiae11479f2020-07-06 09:44:47 +0300481 }
Andrea Campanellabef4e542020-10-22 11:01:28 +0200482 msgObj, msgOk := msgLayer.(*omci.RebootResponse)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300483 if !msgOk {
Andrea Campanella6515c582020-10-05 11:25:00 +0200484 return fmt.Errorf("omci Msg layer could not be assigned for RebootResponseType %s", oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300485 }
Andrea Campanellabef4e542020-10-22 11:01:28 +0200486 logger.Debugw("RebootResponse data", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300487 if msgObj.Result != me.Success {
mpagenko01e726e2020-10-23 09:45:29 +0000488 logger.Errorw("Omci RebootResponse result error", log.Fields{"device-id": oo.deviceID, "Error": msgObj.Result})
ozgecanetsiae11479f2020-07-06 09:44:47 +0300489 // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
Andrea Campanellabef4e542020-10-22 11:01:28 +0200490 return fmt.Errorf("omci RebootResponse result error indication %s for device %s",
Andrea Campanella6515c582020-10-05 11:25:00 +0200491 msgObj.Result, oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300492 }
493 return nil
494 }
495 }
mpagenko01e726e2020-10-23 09:45:29 +0000496 logger.Warnw("Reboot response message type error", log.Fields{"for device-id": oo.deviceID})
Andrea Campanella6515c582020-10-05 11:25:00 +0200497 return fmt.Errorf("unexpected OmciResponse type received %s", oo.deviceID)
ozgecanetsiae11479f2020-07-06 09:44:47 +0300498 }
499}
500
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000501//Relay the InSync message via Handler to Rw core - Status update
Himani Chawla26e555c2020-08-31 12:30:20 +0530502func (oo *OnuDeviceEntry) transferSystemEvent(devEvent OnuDeviceEvent) {
503 logger.Debugw("relaying system-event", log.Fields{"Event": devEvent})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000504 // decouple the handler transfer from further processing here
505 // TODO!!! check if really no synch is required within the system e.g. to ensure following steps ..
Himani Chawla26e555c2020-08-31 12:30:20 +0530506 if devEvent == MibDatabaseSync {
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000507 if oo.devState < MibDatabaseSync { //devState has not been synced yet
508 oo.devState = MibDatabaseSync
Himani Chawla6d2ae152020-09-02 13:11:20 +0530509 go oo.baseDeviceHandler.deviceProcStatusUpdate(devEvent)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000510 //TODO!!! device control: next step: start MIB capability verification from here ?!!!
511 } else {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000512 logger.Debugw("mibinsync-event in some already synced state - ignored", log.Fields{"state": oo.devState})
513 }
Himani Chawla26e555c2020-08-31 12:30:20 +0530514 } else if devEvent == MibDownloadDone {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000515 if oo.devState < MibDownloadDone { //devState has not been synced yet
516 oo.devState = MibDownloadDone
Himani Chawla6d2ae152020-09-02 13:11:20 +0530517 go oo.baseDeviceHandler.deviceProcStatusUpdate(devEvent)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000518 } else {
519 logger.Debugw("mibdownloaddone-event was already seen - ignored", log.Fields{"state": oo.devState})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000520 }
521 } else {
Himani Chawla26e555c2020-08-31 12:30:20 +0530522 logger.Warnw("device-event not yet handled", log.Fields{"state": devEvent})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000523 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000524}
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000525
526func (oo *OnuDeviceEntry) restoreDataFromOnuKvStore(ctx context.Context) error {
527 if oo.onuKVStore == nil {
528 logger.Debugw("onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
529 return fmt.Errorf(fmt.Sprintf("onuKVStore-not-set-abort-%s", oo.deviceID))
530 }
531 oo.sOnuPersistentData = onuPersistentData{0, 0, "", "", "", make([]uniPersConfig, 0)}
532 Value, err := oo.onuKVStore.Get(ctx, oo.onuKVStorePath)
533 if err == nil {
534 if Value != nil {
535 logger.Debugw("ONU-data read",
536 log.Fields{"Key": Value.Key, "device-id": oo.deviceID})
537 tmpBytes, _ := kvstore.ToByte(Value.Value)
538
539 if err = json.Unmarshal(tmpBytes, &oo.sOnuPersistentData); err != nil {
540 logger.Errorw("unable to unmarshal ONU-data", log.Fields{"error": err, "device-id": oo.deviceID})
541 return fmt.Errorf(fmt.Sprintf("unable-to-unmarshal-ONU-data-%s", oo.deviceID))
542 }
543 logger.Debugw("ONU-data", log.Fields{"sOnuPersistentData": oo.sOnuPersistentData,
544 "device-id": oo.deviceID})
545 } else {
mpagenko2418ab02020-11-12 12:58:06 +0000546 logger.Debugw("no ONU-data found", log.Fields{"path": oo.onuKVStorePath, "device-id": oo.deviceID})
547 return fmt.Errorf("no-ONU-data-found")
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000548 }
549 } else {
550 logger.Errorw("unable to read from KVstore", log.Fields{"device-id": oo.deviceID})
551 return fmt.Errorf(fmt.Sprintf("unable-to-read-from-KVstore-%s", oo.deviceID))
552 }
553 return nil
554}
555
556func (oo *OnuDeviceEntry) deleteDataFromOnuKvStore(ctx context.Context, wg *sync.WaitGroup) {
557 defer wg.Done()
558
559 if oo.onuKVStore == nil {
560 logger.Debugw("onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
561 oo.onuKVStoreprocResult = errors.New("onu-data delete aborted: onuKVStore not set")
562 return
563 }
564 var processingStep uint8 = 1 // used to synchronize the different processing steps with chOnuKvProcessingStep
565 go oo.deletePersistentData(ctx, processingStep)
566 if !oo.waitForTimeoutOrCompletion(ctx, oo.chOnuKvProcessingStep, processingStep) {
567 //timeout or error detected
568 logger.Debugw("ONU-data not deleted - abort", log.Fields{"device-id": oo.deviceID})
569 oo.onuKVStoreprocResult = errors.New("onu-data delete aborted: during kv-access")
570 return
571 }
572}
573
574func (oo *OnuDeviceEntry) deletePersistentData(ctx context.Context, aProcessingStep uint8) {
575
mpagenko2418ab02020-11-12 12:58:06 +0000576 logger.Debugw("delete and clear internal persistency data", log.Fields{"device-id": oo.deviceID})
577 oo.sOnuPersistentData.PersUniConfig = nil //releasing all UniConfig entries to garbage collector
578 oo.sOnuPersistentData = onuPersistentData{0, 0, "", "", "", make([]uniPersConfig, 0)} //default entry
579
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000580 logger.Debugw("delete ONU-data from KVStore", log.Fields{"device-id": oo.deviceID})
581 err := oo.onuKVStore.Delete(ctx, oo.onuKVStorePath)
582 if err != nil {
583 logger.Errorw("unable to delete in KVstore", log.Fields{"device-id": oo.deviceID, "err": err})
584 oo.chOnuKvProcessingStep <- 0 //error indication
585 return
586 }
587 oo.chOnuKvProcessingStep <- aProcessingStep //done
588}
589
590func (oo *OnuDeviceEntry) updateOnuKvStore(ctx context.Context, wg *sync.WaitGroup) {
591 defer wg.Done()
592
593 if oo.onuKVStore == nil {
594 logger.Debugw("onuKVStore not set - abort", log.Fields{"device-id": oo.deviceID})
595 oo.onuKVStoreprocResult = errors.New("onu-data update aborted: onuKVStore not set")
596 return
597 }
598 var processingStep uint8 = 1 // used to synchronize the different processing steps with chOnuKvProcessingStep
599 go oo.storeDataInOnuKvStore(ctx, processingStep)
600 if !oo.waitForTimeoutOrCompletion(ctx, oo.chOnuKvProcessingStep, processingStep) {
601 //timeout or error detected
602 logger.Debugw("ONU-data not written - abort", log.Fields{"device-id": oo.deviceID})
603 oo.onuKVStoreprocResult = errors.New("onu-data update aborted: during writing process")
604 return
605 }
606}
607
608func (oo *OnuDeviceEntry) storeDataInOnuKvStore(ctx context.Context, aProcessingStep uint8) {
609
610 //assign values which are not already present when newOnuDeviceEntry() is called
611 oo.sOnuPersistentData.PersOnuID = oo.baseDeviceHandler.pOnuIndication.OnuId
612 oo.sOnuPersistentData.PersIntfID = oo.baseDeviceHandler.pOnuIndication.IntfId
613 oo.sOnuPersistentData.PersSnr = oo.baseDeviceHandler.pOnuOmciDevice.serialNumber
614 //TODO: verify usage of these values during restart UC
615 oo.sOnuPersistentData.PersAdminState = "up"
616 oo.sOnuPersistentData.PersOperState = "active"
617
618 logger.Debugw("Update ONU-data in KVStore", log.Fields{"device-id": oo.deviceID, "sOnuPersistentData": oo.sOnuPersistentData})
619
620 Value, err := json.Marshal(oo.sOnuPersistentData)
621 if err != nil {
622 logger.Errorw("unable to marshal ONU-data", log.Fields{"sOnuPersistentData": oo.sOnuPersistentData,
623 "device-id": oo.deviceID, "err": err})
624 oo.chOnuKvProcessingStep <- 0 //error indication
625 return
626 }
627 err = oo.onuKVStore.Put(ctx, oo.onuKVStorePath, Value)
628 if err != nil {
629 logger.Errorw("unable to write ONU-data into KVstore", log.Fields{"device-id": oo.deviceID, "err": err})
630 oo.chOnuKvProcessingStep <- 0 //error indication
631 return
632 }
633 oo.chOnuKvProcessingStep <- aProcessingStep //done
634}
635
Girish Gowdra041dcb32020-11-16 16:54:30 -0800636func (oo *OnuDeviceEntry) updateOnuUniTpPath(aUniID uint8, aTpID uint8, aPathString string) bool {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000637 /* within some specific InterAdapter processing request write/read access to data is ensured to be sequentially,
638 as also the complete sequence is ensured to 'run to completion' before some new request is accepted
639 no specific concurrency protection to sOnuPersistentData is required here
640 */
641 for k, v := range oo.sOnuPersistentData.PersUniConfig {
642 if v.PersUniID == aUniID {
643 logger.Debugw("PersUniConfig-entry already exists", log.Fields{"device-id": oo.deviceID, "uniID": aUniID})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800644 existingPath, ok := oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID]
645 if !ok {
646 logger.Debugw("tp-does-not-exist--to-be-created-afresh", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "tpID": aTpID, "path": aPathString})
647 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000648 if existingPath != aPathString {
649 if aPathString == "" {
650 //existing entry to be deleted
651 logger.Debugw("UniTp delete path value", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800652 oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID] = ""
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000653 } else {
654 //existing entry to be modified
655 logger.Debugw("UniTp modify path value", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800656 oo.sOnuPersistentData.PersUniConfig[k].PersTpPathMap[aTpID] = aPathString
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000657 }
658 return true
659 }
660 //entry already exists
mpagenkofc4f56e2020-11-04 17:17:49 +0000661 if aPathString == "" {
662 //no active TechProfile
663 logger.Debugw("UniTp path has already been removed - no AniSide config to be removed", log.Fields{
664 "device-id": oo.deviceID, "uniID": aUniID})
665 // attention 201105: this block is at the moment entered for each of subsequent GemPortDeletes and TContDelete
666 // as the path is already cleared with the first GemPort - this will probably change with the upcoming real
667 // TechProfile removal (still TODO), but anyway the reasonUpdate initiated here should not harm overall behavior
668 go oo.baseDeviceHandler.deviceProcStatusUpdate(OmciAniResourceRemoved)
669 // no flow config pending on 'remove' so far
670 } else {
671 //the given TechProfile already exists and is assumed to be active - update devReason as if the config has been done here
672 //was needed e.g. in voltha POD Tests:Validate authentication on a disabled ONU
673 // (as here the TechProfile has not been removed with the disable-device before the new enable-device)
674 logger.Debugw("UniTp path already exists - TechProfile supposed to be active", log.Fields{
675 "device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
676 //no deviceReason update (deviceProcStatusUpdate) here to ensure 'omci_flows_pushed' state within disable/enable procedure of ATT scenario
677 // (during which the flows are removed/re-assigned but the techProf is left active)
678 //and as the TechProfile is regarded as active we have to verify, if some flow configuration still waits on it
679 // (should not be the case, but should not harm or be more robust ...)
mpagenko2418ab02020-11-12 12:58:06 +0000680 // and to be sure, that for some reason the corresponding TpDelete was lost somewhere in history
681 // we also reset a possibly outstanding delete request - repeated TpConfig is regarded as valid for waiting flow config
682 if oo.baseDeviceHandler.pOnuTP != nil {
Girish Gowdra041dcb32020-11-16 16:54:30 -0800683 oo.baseDeviceHandler.pOnuTP.setProfileToDelete(aUniID, aTpID, false)
mpagenko2418ab02020-11-12 12:58:06 +0000684 }
mpagenkofc4f56e2020-11-04 17:17:49 +0000685 go oo.baseDeviceHandler.VerifyVlanConfigRequest(aUniID)
686 }
687 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 +0000688 }
689 }
690 //no entry exists for uniId
691
692 if aPathString == "" {
693 //delete request in non-existing state , accept as no change
694 logger.Debugw("UniTp path already removed", log.Fields{"device-id": oo.deviceID, "uniID": aUniID})
695 return false
696 }
697 //new entry to be created
698 logger.Debugw("New UniTp path set", log.Fields{"device-id": oo.deviceID, "uniID": aUniID, "path": aPathString})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800699 perSubTpPathMap := make(map[uint8]string)
700 perSubTpPathMap[aTpID] = aPathString
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000701 oo.sOnuPersistentData.PersUniConfig =
Girish Gowdra041dcb32020-11-16 16:54:30 -0800702 append(oo.sOnuPersistentData.PersUniConfig, uniPersConfig{PersUniID: aUniID, PersTpPathMap: perSubTpPathMap, PersFlowParams: make([]uniVlanFlowParams, 0)})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000703 return true
704}
705
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000706func (oo *OnuDeviceEntry) updateOnuUniFlowConfig(aUniID uint8, aUniVlanFlowParams *[]uniVlanFlowParams) {
707
708 for k, v := range oo.sOnuPersistentData.PersUniConfig {
709 if v.PersUniID == aUniID {
710 oo.sOnuPersistentData.PersUniConfig[k].PersFlowParams = make([]uniVlanFlowParams, len(*aUniVlanFlowParams))
711 copy(oo.sOnuPersistentData.PersUniConfig[k].PersFlowParams, *aUniVlanFlowParams)
712 return
713 }
714 }
715 //flow update was faster than tp-config - create PersUniConfig-entry
Girish Gowdra041dcb32020-11-16 16:54:30 -0800716 tmpConfig := uniPersConfig{PersUniID: aUniID, PersTpPathMap: make(map[uint8]string), PersFlowParams: make([]uniVlanFlowParams, len(*aUniVlanFlowParams))}
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000717 copy(tmpConfig.PersFlowParams, *aUniVlanFlowParams)
718 oo.sOnuPersistentData.PersUniConfig = append(oo.sOnuPersistentData.PersUniConfig, tmpConfig)
719}
720
721func (oo *OnuDeviceEntry) waitForTimeoutOrCompletion(
722 ctx context.Context, aChOnuProcessingStep <-chan uint8, aProcessingStep uint8) bool {
723 select {
724 case <-ctx.Done():
725 logger.Warnw("processing not completed in-time!",
726 log.Fields{"device-id": oo.deviceID, "error": ctx.Err()})
727 return false
728 case rxStep := <-aChOnuProcessingStep:
729 if rxStep == aProcessingStep {
730 return true
731 }
732 //all other values are not accepted - including 0 for error indication
733 logger.Warnw("Invalid processing step received: abort!",
734 log.Fields{"device-id": oo.deviceID,
735 "wantedStep": aProcessingStep, "haveStep": rxStep})
736 return false
737 }
738}
739
740func (oo *OnuDeviceEntry) resetKvProcessingErrorIndication() {
741 oo.onuKVStoreprocResult = nil
742}
743func (oo *OnuDeviceEntry) getKvProcessingErrorIndication() error {
744 return oo.onuKVStoreprocResult
745}
746
747func (oo *OnuDeviceEntry) lockOnuKVStoreMutex() {
748 oo.onuKVStoreMutex.Lock()
749}
750
751func (oo *OnuDeviceEntry) unlockOnuKVStoreMutex() {
752 oo.onuKVStoreMutex.Unlock()
753}