blob: 53101beb70023769731a3455823f77ede60583a5 [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 Hildebrandtccd390c2020-05-29 13:49:04 +000022 "errors"
ozgecanetsiae11479f2020-07-06 09:44:47 +030023 "github.com/opencord/omci-lib-go"
24 me "github.com/opencord/omci-lib-go/generated"
25 "time"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000026
Holger Hildebrandtfa074992020-03-27 15:42:06 +000027 //"sync"
28 //"time"
29
30 "github.com/looplab/fsm"
31 "github.com/opencord/voltha-lib-go/v3/pkg/adapters/adapterif"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000032 "github.com/opencord/voltha-lib-go/v3/pkg/db"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000033
34 //"github.com/opencord/voltha-lib-go/v3/pkg/kafka"
35 "github.com/opencord/voltha-lib-go/v3/pkg/log"
36 //ic "github.com/opencord/voltha-protos/v3/go/inter_container"
37 //"github.com/opencord/voltha-protos/v3/go/openflow_13"
38 //"github.com/opencord/voltha-protos/v3/go/voltha"
39)
40
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000041const (
mpagenko1cc3cb42020-07-27 15:24:38 +000042 // events of MibUpload FSM
43 ulEvStart = "ulEvStart"
44 ulEvResetMib = "ulEvResetMib"
45 ulEvGetVendorAndSerial = "ulEvGetVendorAndSerial"
46 ulEvGetEquipmentId = "ulEvGetEquipmentId"
47 ulEvGetFirstSwVersion = "ulEvGetFirstSwVersion"
48 ulEvGetSecondSwVersion = "ulEvGetSecondSwVersion"
49 ulEvGetMacAddress = "ulEvGetMacAddress"
50 ulEvGetMibTemplate = "ulEvGetMibTemplate"
51 ulEvUploadMib = "ulEvUploadMib"
52 ulEvExamineMds = "ulEvExamineMds"
53 ulEvSuccess = "ulEvSuccess"
54 ulEvMismatch = "ulEvMismatch"
55 ulEvAuditMib = "ulEvAuditMib"
56 ulEvForceResync = "ulEvForceResync"
57 ulEvDiffsFound = "ulEvDiffsFound"
58 ulEvTimeout = "ulEvTimeout"
59 ulEvStop = "ulEvStop"
60)
61const (
62 // states of MibUpload FSM
63 ulStDisabled = "ulStDisabled"
64 ulStStarting = "ulStStarting"
65 ulStResettingMib = "ulStResettingMib"
66 ulStGettingVendorAndSerial = "ulStGettingVendorAndSerial"
67 ulStGettingEquipmentId = "ulStGettingEquipmentId"
68 ulStGettingFirstSwVersion = "ulStGettingFirstSwVersion"
69 ulStGettingSecondSwVersion = "ulStGettingSecondSwVersion"
70 ulStGettingMacAddress = "ulStGettingMacAddress"
71 ulStGettingMibTemplate = "ulStGettingMibTemplate"
72 ulStUploading = "ulStUploading"
73 ulStInSync = "ulStInSync"
74 ulStExaminingMds = "ulStExaminingMds"
75 ulStResynchronizing = "ulStResynchronizing"
76 ulStAuditing = "ulStAuditing"
77 ulStOutOfSync = "ulStOutOfSync"
78)
79
80const (
81 // events of MibDownload FSM
82 dlEvStart = "dlEvStart"
83 dlEvCreateGal = "dlEvCreateGal"
84 dlEvRxGalResp = "dlEvRxGalResp"
85 dlEvRxOnu2gResp = "dlEvRxOnu2gResp"
86 dlEvRxBridgeResp = "dlEvRxBridgeResp"
87 dlEvTimeoutSimple = "dlEvTimeoutSimple"
88 dlEvTimeoutBridge = "dlEvTimeoutBridge"
89 dlEvReset = "dlEvReset"
90 dlEvRestart = "dlEvRestart"
91)
92const (
93 // states of MibDownload FSM
94 dlStDisabled = "dlStDisabled"
95 dlStStarting = "dlStStarting"
96 dlStCreatingGal = "dlStCreatingGal"
97 dlStSettingOnu2g = "dlStSettingOnu2g"
98 dlStBridgeInit = "dlStBridgeInit"
99 dlStDownloaded = "dlStDownloaded"
100 dlStResetting = "dlStResetting"
101)
102
103const (
mpagenkoaf801632020-07-03 10:00:42 +0000104 cBasePathMibTemplateKvStore = "service/voltha/omci_mibs/templates"
105 cSuffixMibTemplateKvStore = "%s/%s/%s"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000106)
107
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000108type OnuDeviceEvent int
109
110const (
111 // Events of interest to Device Adapters and OpenOMCI State Machines
112 DeviceStatusInit OnuDeviceEvent = 0 // OnuDeviceEntry default start state
113 MibDatabaseSync OnuDeviceEvent = 1 // MIB database sync (upload done)
114 OmciCapabilitiesDone OnuDeviceEvent = 2 // OMCI ME and message type capabilities known
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000115 MibDownloadDone OnuDeviceEvent = 3 // MIB database sync (upload done)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000116 UniLockStateDone OnuDeviceEvent = 4 // Uni ports admin set to lock
117 UniUnlockStateDone OnuDeviceEvent = 5 // Uni ports admin set to unlock
118 UniAdminStateDone OnuDeviceEvent = 6 // Uni ports admin set done - general
119 PortLinkUp OnuDeviceEvent = 7 // Port link state change
120 PortLinkDw OnuDeviceEvent = 8 // Port link state change
mpagenko3dbcdd22020-07-22 07:38:45 +0000121 OmciAniConfigDone OnuDeviceEvent = 9 // AniSide config according to TechProfile done
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000122 // Add other events here as needed (alarms separate???)
123)
124
125type activityDescr struct {
126 databaseClass func() error
127 advertiseEvents bool
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000128 auditDelay uint16
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000129 //tasks map[string]func() error
130}
131type OmciDeviceFsms map[string]activityDescr
132
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000133type AdapterFsm struct {
134 fsmName string
135 deviceID string
136 commChan chan Message
137 pFsm *fsm.FSM
138}
139
140func NewAdapterFsm(a_name string, a_deviceID string, a_commChannel chan Message) *AdapterFsm {
141 aFsm := &AdapterFsm{
142 fsmName: a_name,
143 deviceID: a_deviceID,
144 commChan: a_commChannel,
145 }
146 return aFsm
147}
148
149//Start starts (logs) the omci agent
150func (oo *AdapterFsm) logFsmStateChange(e *fsm.Event) {
151 logger.Debugw("FSM state change", log.Fields{"device-id": oo.deviceID, "FSM name": oo.fsmName,
152 "event name": string(e.Event), "src state": string(e.Src), "dst state": string(e.Dst)})
153}
154
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000155//OntDeviceEntry structure holds information about the attached FSM'as and their communication
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000156
157const (
158 FirstSwImageMeId = 0
159 SecondSwImageMeId = 1
160)
161const OnugMeId = 0
162const Onu2gMeId = 0
163const IpHostConfigDataMeId = 1
164const OnugSerialNumberLen = 8
165const OmciMacAddressLen = 6
166
167type SwImages struct {
168 version string
169 isActive uint8
170}
171
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000172type OnuDeviceEntry struct {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000173 deviceID string
174 baseDeviceHandler *DeviceHandler
175 coreProxy adapterif.CoreProxy
176 adapterProxy adapterif.AdapterProxy
177 started bool
178 PDevOmciCC *OmciCC
179 pOnuDB *OnuDeviceDB
180 mibTemplateKVStore *db.Backend
181 vendorID string
182 serialNumber string
183 equipmentID string
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000184 swImages [SecondSwImageMeId + 1]SwImages
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000185 activeSwVersion string
186 macAddress string
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000187 //lockDeviceEntries sync.RWMutex
188 mibDbClass func() error
189 supportedFsms OmciDeviceFsms
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000190 devState OnuDeviceEvent
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000191 // for mibUpload
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000192 mibAuditDelay uint16
mpagenko1cc3cb42020-07-27 15:24:38 +0000193 mibDebugLevel string
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000194
195 // for mibUpload
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000196 pMibUploadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later
197 // for mibDownload
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000198 pMibDownloadFsm *AdapterFsm //could be handled dynamically and more general as pAdapterFsm - perhaps later
199 //remark: general usage of pAdapterFsm would require generalization of commChan usage and internal event setting
200 // within the FSM event procedures
ozgecanetsiae11479f2020-07-06 09:44:47 +0300201 omciMessageReceived chan bool //seperate channel needed by DownloadFsm
202 omciRebootMessageReceivedChannel chan Message // channel needed by Reboot request
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000203}
204
205//OnuDeviceEntry returns a new instance of a OnuDeviceEntry
206//mib_db (as well as not inluded alarm_db not really used in this code? VERIFY!!)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000207func NewOnuDeviceEntry(ctx context.Context, device_id string, kVStoreHost string, kVStorePort int, kvStoreType string, device_Handler *DeviceHandler,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000208 core_proxy adapterif.CoreProxy, adapter_proxy adapterif.AdapterProxy,
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000209 supported_Fsms_Ptr *OmciDeviceFsms) *OnuDeviceEntry {
210 logger.Infow("init-onuDeviceEntry", log.Fields{"deviceId": device_id})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000211 var onuDeviceEntry OnuDeviceEntry
212 onuDeviceEntry.started = false
213 onuDeviceEntry.deviceID = device_id
214 onuDeviceEntry.baseDeviceHandler = device_Handler
215 onuDeviceEntry.coreProxy = core_proxy
216 onuDeviceEntry.adapterProxy = adapter_proxy
217 onuDeviceEntry.devState = DeviceStatusInit
ozgecanetsiae11479f2020-07-06 09:44:47 +0300218 onuDeviceEntry.omciRebootMessageReceivedChannel = make(chan Message, 2048)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000219 //openomciagent.lockDeviceHandlersMap = sync.RWMutex{}
220 //OMCI related databases are on a per-agent basis. State machines and tasks
221 //are per ONU Vendor
222 //
223 // MIB Synchronization Database - possible overloading from arguments
224 if supported_Fsms_Ptr != nil {
225 onuDeviceEntry.supportedFsms = *supported_Fsms_Ptr
226 } else {
227 //var mibSyncFsm = NewMibSynchronizer()
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000228 // use some internaö defaults, if not defined from outside
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000229 onuDeviceEntry.supportedFsms = OmciDeviceFsms{
230 "mib-synchronizer": {
231 //mibSyncFsm, // Implements the MIB synchronization state machine
232 onuDeviceEntry.MibDbVolatileDict, // Implements volatile ME MIB database
233 true, // Advertise events on OpenOMCI event bus
234 60, // Time to wait between MIB audits. 0 to disable audits.
235 // map[string]func() error{
236 // "mib-upload": onuDeviceEntry.MibUploadTask,
237 // "mib-template": onuDeviceEntry.MibTemplateTask,
238 // "get-mds": onuDeviceEntry.GetMdsTask,
239 // "mib-audit": onuDeviceEntry.GetMdsTask,
240 // "mib-resync": onuDeviceEntry.MibResyncTask,
241 // "mib-reconcile": onuDeviceEntry.MibReconcileTask,
242 // },
243 },
244 }
245 }
246 onuDeviceEntry.mibDbClass = onuDeviceEntry.supportedFsms["mib-synchronizer"].databaseClass
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000247 logger.Debug("access2mibDbClass")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000248 go onuDeviceEntry.mibDbClass()
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000249 onuDeviceEntry.mibAuditDelay = onuDeviceEntry.supportedFsms["mib-synchronizer"].auditDelay
250 logger.Debugw("MibAudit is set to", log.Fields{"Delay": onuDeviceEntry.mibAuditDelay})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000251
mpagenko1cc3cb42020-07-27 15:24:38 +0000252 onuDeviceEntry.mibDebugLevel = "normal" //set to "verbose" if you want to have all output, possibly later also per config option!
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000253 // Omci related Mib upload sync state machine
254 mibUploadChan := make(chan Message, 2048)
255 onuDeviceEntry.pMibUploadFsm = NewAdapterFsm("MibUpload", device_id, mibUploadChan)
256 onuDeviceEntry.pMibUploadFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000257 ulStDisabled,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000258 fsm.Events{
259
mpagenko1cc3cb42020-07-27 15:24:38 +0000260 {Name: ulEvStart, Src: []string{ulStDisabled}, Dst: ulStStarting},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000261
mpagenko1cc3cb42020-07-27 15:24:38 +0000262 {Name: ulEvResetMib, Src: []string{ulStStarting}, Dst: ulStResettingMib},
263 {Name: ulEvGetVendorAndSerial, Src: []string{ulStResettingMib}, Dst: ulStGettingVendorAndSerial},
264 {Name: ulEvGetEquipmentId, Src: []string{ulStGettingVendorAndSerial}, Dst: ulStGettingEquipmentId},
265 {Name: ulEvGetFirstSwVersion, Src: []string{ulStGettingEquipmentId}, Dst: ulStGettingFirstSwVersion},
266 {Name: ulEvGetSecondSwVersion, Src: []string{ulStGettingFirstSwVersion}, Dst: ulStGettingSecondSwVersion},
267 {Name: ulEvGetMacAddress, Src: []string{ulStGettingSecondSwVersion}, Dst: ulStGettingMacAddress},
268 {Name: ulEvGetMibTemplate, Src: []string{ulStGettingMacAddress}, Dst: ulStGettingMibTemplate},
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000269
mpagenko1cc3cb42020-07-27 15:24:38 +0000270 {Name: ulEvUploadMib, Src: []string{ulStGettingMibTemplate}, Dst: ulStUploading},
271 {Name: ulEvExamineMds, Src: []string{ulStStarting}, Dst: ulStExaminingMds},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000272
mpagenko1cc3cb42020-07-27 15:24:38 +0000273 {Name: ulEvSuccess, Src: []string{ulStGettingMibTemplate}, Dst: ulStInSync},
274 {Name: ulEvSuccess, Src: []string{ulStUploading}, Dst: ulStInSync},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000275
mpagenko1cc3cb42020-07-27 15:24:38 +0000276 {Name: ulEvSuccess, Src: []string{ulStExaminingMds}, Dst: ulStInSync},
277 {Name: ulEvMismatch, Src: []string{ulStExaminingMds}, Dst: ulStResynchronizing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000278
mpagenko1cc3cb42020-07-27 15:24:38 +0000279 {Name: ulEvAuditMib, Src: []string{ulStInSync}, Dst: ulStAuditing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000280
mpagenko1cc3cb42020-07-27 15:24:38 +0000281 {Name: ulEvSuccess, Src: []string{ulStOutOfSync}, Dst: ulStInSync},
282 {Name: ulEvAuditMib, Src: []string{ulStOutOfSync}, Dst: ulStAuditing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000283
mpagenko1cc3cb42020-07-27 15:24:38 +0000284 {Name: ulEvSuccess, Src: []string{ulStAuditing}, Dst: ulStInSync},
285 {Name: ulEvMismatch, Src: []string{ulStAuditing}, Dst: ulStResynchronizing},
286 {Name: ulEvForceResync, Src: []string{ulStAuditing}, Dst: ulStResynchronizing},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000287
mpagenko1cc3cb42020-07-27 15:24:38 +0000288 {Name: ulEvSuccess, Src: []string{ulStResynchronizing}, Dst: ulStInSync},
289 {Name: ulEvDiffsFound, Src: []string{ulStResynchronizing}, Dst: ulStOutOfSync},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000290
mpagenko1cc3cb42020-07-27 15:24:38 +0000291 {Name: ulEvTimeout, Src: []string{ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentId, ulStGettingFirstSwVersion,
292 ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds,
293 ulStInSync, ulStOutOfSync, ulStAuditing}, Dst: ulStStarting},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000294
mpagenko1cc3cb42020-07-27 15:24:38 +0000295 {Name: ulEvStop, Src: []string{ulStStarting, ulStResettingMib, ulStGettingVendorAndSerial, ulStGettingEquipmentId, ulStGettingFirstSwVersion,
296 ulStGettingSecondSwVersion, ulStGettingMacAddress, ulStGettingMibTemplate, ulStUploading, ulStResynchronizing, ulStExaminingMds,
297 ulStInSync, ulStOutOfSync, ulStAuditing}, Dst: ulStDisabled},
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000298 },
299
300 fsm.Callbacks{
mpagenko1cc3cb42020-07-27 15:24:38 +0000301 "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibUploadFsm.logFsmStateChange(e) },
302 ("enter_" + ulStStarting): func(e *fsm.Event) { onuDeviceEntry.enterStartingState(e) },
303 ("enter_" + ulStResettingMib): func(e *fsm.Event) { onuDeviceEntry.enterResettingMibState(e) },
304 ("enter_" + ulStGettingVendorAndSerial): func(e *fsm.Event) { onuDeviceEntry.enterGettingVendorAndSerialState(e) },
305 ("enter_" + ulStGettingEquipmentId): func(e *fsm.Event) { onuDeviceEntry.enterGettingEquipmentIdState(e) },
306 ("enter_" + ulStGettingFirstSwVersion): func(e *fsm.Event) { onuDeviceEntry.enterGettingFirstSwVersionState(e) },
307 ("enter_" + ulStGettingSecondSwVersion): func(e *fsm.Event) { onuDeviceEntry.enterGettingSecondSwVersionState(e) },
308 ("enter_" + ulStGettingMacAddress): func(e *fsm.Event) { onuDeviceEntry.enterGettingMacAddressState(e) },
309 ("enter_" + ulStGettingMibTemplate): func(e *fsm.Event) { onuDeviceEntry.enterGettingMibTemplate(e) },
310 ("enter_" + ulStUploading): func(e *fsm.Event) { onuDeviceEntry.enterUploadingState(e) },
311 ("enter_" + ulStExaminingMds): func(e *fsm.Event) { onuDeviceEntry.enterExaminingMdsState(e) },
312 ("enter_" + ulStResynchronizing): func(e *fsm.Event) { onuDeviceEntry.enterResynchronizingState(e) },
313 ("enter_" + ulStAuditing): func(e *fsm.Event) { onuDeviceEntry.enterAuditingState(e) },
314 ("enter_" + ulStOutOfSync): func(e *fsm.Event) { onuDeviceEntry.enterOutOfSyncState(e) },
315 ("enter_" + ulStInSync): func(e *fsm.Event) { onuDeviceEntry.enterInSyncState(e) },
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000316 },
317 )
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000318 // Omci related Mib download state machine
319 mibDownloadChan := make(chan Message, 2048)
320 onuDeviceEntry.pMibDownloadFsm = NewAdapterFsm("MibDownload", device_id, mibDownloadChan)
321 onuDeviceEntry.pMibDownloadFsm.pFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000322 dlStDisabled,
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000323 fsm.Events{
324
mpagenko1cc3cb42020-07-27 15:24:38 +0000325 {Name: dlEvStart, Src: []string{dlStDisabled}, Dst: dlStStarting},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000326
mpagenko1cc3cb42020-07-27 15:24:38 +0000327 {Name: dlEvCreateGal, Src: []string{dlStStarting}, Dst: dlStCreatingGal},
328 {Name: dlEvRxGalResp, Src: []string{dlStCreatingGal}, Dst: dlStSettingOnu2g},
329 {Name: dlEvRxOnu2gResp, Src: []string{dlStSettingOnu2g}, Dst: dlStBridgeInit},
Holger Hildebrandtdd23cc22020-05-19 13:32:18 +0000330 // the bridge state is used for multi ME config for alle UNI related ports
331 // maybe such could be reflected in the state machine as well (port number parametrized)
332 // but that looks not straightforward here - so we keep it simple here for the beginning(?)
mpagenko1cc3cb42020-07-27 15:24:38 +0000333 {Name: dlEvRxBridgeResp, Src: []string{dlStBridgeInit}, Dst: dlStDownloaded},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000334
mpagenko1cc3cb42020-07-27 15:24:38 +0000335 {Name: dlEvTimeoutSimple, Src: []string{dlStCreatingGal, dlStSettingOnu2g}, Dst: dlStStarting},
336 {Name: dlEvTimeoutBridge, Src: []string{dlStBridgeInit}, Dst: dlStStarting},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000337
mpagenko1cc3cb42020-07-27 15:24:38 +0000338 {Name: dlEvReset, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g,
339 dlStBridgeInit, dlStDownloaded}, Dst: dlStResetting},
340 // exceptional treatment for all states except dlStResetting
341 {Name: dlEvRestart, Src: []string{dlStStarting, dlStCreatingGal, dlStSettingOnu2g,
342 dlStBridgeInit, dlStDownloaded, dlStResetting}, Dst: dlStDisabled},
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000343 },
344
345 fsm.Callbacks{
mpagenko1cc3cb42020-07-27 15:24:38 +0000346 "enter_state": func(e *fsm.Event) { onuDeviceEntry.pMibDownloadFsm.logFsmStateChange(e) },
347 ("enter_" + dlStStarting): func(e *fsm.Event) { onuDeviceEntry.enterDLStartingState(e) },
348 ("enter_" + dlStCreatingGal): func(e *fsm.Event) { onuDeviceEntry.enterCreatingGalState(e) },
349 ("enter_" + dlStSettingOnu2g): func(e *fsm.Event) { onuDeviceEntry.enterSettingOnu2gState(e) },
350 ("enter_" + dlStBridgeInit): func(e *fsm.Event) { onuDeviceEntry.enterBridgeInitState(e) },
351 ("enter_" + dlStDownloaded): func(e *fsm.Event) { onuDeviceEntry.enterDownloadedState(e) },
352 ("enter_" + dlStResetting): func(e *fsm.Event) { onuDeviceEntry.enterResettingState(e) },
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +0000353 },
354 )
355 if onuDeviceEntry.pMibDownloadFsm == nil || onuDeviceEntry.pMibDownloadFsm.pFsm == nil {
356 logger.Error("MibDownloadFsm could not be instantiated!!")
357 // some specifc error treatment - or waiting for crash ???
358 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000359
mpagenkoaf801632020-07-03 10:00:42 +0000360 onuDeviceEntry.mibTemplateKVStore = onuDeviceEntry.baseDeviceHandler.SetBackend(cBasePathMibTemplateKvStore)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000361 if onuDeviceEntry.mibTemplateKVStore == nil {
mpagenkoaf801632020-07-03 10:00:42 +0000362 logger.Errorw("Failed to setup mibTemplateKVStore", log.Fields{"deviceID": device_id})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000363 }
364
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000365 // Alarm Synchronization Database
366 //self._alarm_db = None
367 //self._alarm_database_cls = support_classes['alarm-synchronizer']['database']
368 return &onuDeviceEntry
369}
370
371//Start starts (logs) the omci agent
372func (oo *OnuDeviceEntry) Start(ctx context.Context) error {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000373 logger.Info("starting-OnuDeviceEntry")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000374
375 oo.PDevOmciCC = NewOmciCC(ctx, oo, oo.deviceID, oo.baseDeviceHandler,
376 oo.coreProxy, oo.adapterProxy)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000377 if oo.PDevOmciCC == nil {
378 logger.Errorw("Could not create devOmciCc - abort", log.Fields{"for device": oo.deviceID})
379 return errors.New("Could not create devOmciCc")
380 }
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000381
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000382 oo.started = true
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000383 logger.Info("OnuDeviceEntry-started")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000384 return nil
385}
386
387//Stop terminates the session
388func (oo *OnuDeviceEntry) Stop(ctx context.Context) error {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000389 logger.Info("stopping-OnuDeviceEntry")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000390 oo.started = false
391 //oo.exitChannel <- 1
mpagenko3af1f032020-06-10 08:53:41 +0000392 // maybe also the omciCC should be stopped here - for now not as no real processing is expected here - maybe needs consolidation
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000393 logger.Info("OnuDeviceEntry-stopped")
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000394 return nil
395}
396
ozgecanetsiae11479f2020-07-06 09:44:47 +0300397func (oo *OnuDeviceEntry) Reboot(ctx context.Context) error {
398 logger.Info("reboot-OnuDeviceEntry")
399 if err := oo.PDevOmciCC.sendReboot(context.TODO(), ConstDefaultOmciTimeout, true, oo.omciRebootMessageReceivedChannel); err != nil {
400 logger.Errorw("onu didn't reboot", log.Fields{"for device": oo.deviceID})
401 return err
402 }
403 logger.Info("OnuDeviceEntry-reboot")
404 return nil
405}
406
407func (oo *OnuDeviceEntry) waitForRebootResponse(responseChannel chan Message) error {
408 select {
409 case <-time.After(3 * time.Second): //3s was detected to be to less in 8*8 bbsim test with debug Info/Debug
410 logger.Warnw("Reboot timeout", log.Fields{"for device-id": oo.deviceID})
411 return errors.New("RebootTimeout")
412 case data := <-responseChannel:
413 switch data.Data.(OmciMessage).OmciMsg.MessageType {
414 case omci.RebootResponseType:
415 {
416 msgLayer := (*data.Data.(OmciMessage).OmciPacket).Layer(omci.LayerTypeRebootResponse)
417 if msgLayer == nil {
418 return errors.New("Omci Msg layer could not be detected for RebootResponseType")
419 }
420 msgObj, msgOk := msgLayer.(*omci.GetResponse)
421 if !msgOk {
422 return errors.New("Omci Msg layer could not be assigned for RebootResponseType")
423 }
424 logger.Debugw("CreateResponse Data", log.Fields{"deviceId": oo.deviceID, "data-fields": msgObj})
425 if msgObj.Result != me.Success {
426 logger.Errorw("Omci RebootResponseType Error ", log.Fields{"Error": msgObj.Result})
427 // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
428 return errors.New("Omci RebootResponse Result Error indication")
429 }
430 return nil
431 }
432 }
433 logger.Warnw("Reboot response error", log.Fields{"for device-id": oo.deviceID})
434 return errors.New("Unexpected OmciResponse type received")
435 }
436}
437
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000438//Relay the InSync message via Handler to Rw core - Status update
439func (oo *OnuDeviceEntry) transferSystemEvent(dev_Event OnuDeviceEvent) error {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000440 logger.Debugw("relaying system-event", log.Fields{"Event": dev_Event})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000441 // decouple the handler transfer from further processing here
442 // TODO!!! check if really no synch is required within the system e.g. to ensure following steps ..
443 if dev_Event == MibDatabaseSync {
444 if oo.devState < MibDatabaseSync { //devState has not been synced yet
445 oo.devState = MibDatabaseSync
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000446 go oo.baseDeviceHandler.DeviceProcStatusUpdate(dev_Event)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000447 //TODO!!! device control: next step: start MIB capability verification from here ?!!!
448 } else {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000449 logger.Debugw("mibinsync-event in some already synced state - ignored", log.Fields{"state": oo.devState})
450 }
451 } else if dev_Event == MibDownloadDone {
452 if oo.devState < MibDownloadDone { //devState has not been synced yet
453 oo.devState = MibDownloadDone
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000454 go oo.baseDeviceHandler.DeviceProcStatusUpdate(dev_Event)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000455 } else {
456 logger.Debugw("mibdownloaddone-event was already seen - ignored", log.Fields{"state": oo.devState})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000457 }
458 } else {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000459 logger.Warnw("device-event not yet handled", log.Fields{"state": dev_Event})
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000460 }
461 return nil
462}