blob: d3f2712d9395f2b10856699c997f5a963badb39f [file] [log] [blame]
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +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 Hildebrandt4b5e73f2021-08-19 06:51:21 +000017//Package mib provides the utilities for managing the onu mib
18package mib
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000019
20import (
21 "context"
Holger Hildebrandtc54939a2020-06-17 08:14:27 +000022 "encoding/hex"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000023 "encoding/json"
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000024 "errors"
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000025 "fmt"
26 "strconv"
mpagenko3af1f032020-06-10 08:53:41 +000027 "strings"
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000028
29 "github.com/looplab/fsm"
30
divyadesaibbed37c2020-08-28 13:35:20 +053031 "time"
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000032
mpagenko7033f4e2021-11-19 18:04:22 +000033 "github.com/google/gopacket"
mpagenko836a1fd2021-11-01 16:12:42 +000034 "github.com/opencord/omci-lib-go/v2"
35 me "github.com/opencord/omci-lib-go/v2/generated"
khenaidoo7d3c5582021-08-11 18:09:44 -040036 "github.com/opencord/voltha-lib-go/v7/pkg/db/kvstore"
37 "github.com/opencord/voltha-lib-go/v7/pkg/log"
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +000038 cmn "github.com/opencord/voltha-openonu-adapter-go/internal/pkg/common"
39 devdb "github.com/opencord/voltha-openonu-adapter-go/internal/pkg/devdb"
Holger Hildebrandt9afc1582021-11-30 16:10:19 +000040 "github.com/opencord/voltha-protos/v5/go/inter_adapter"
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000041)
42
mpagenko01499812021-03-25 10:37:12 +000043type sLastTxMeParameter struct {
44 lastTxMessageType omci.MessageType
45 pLastTxMeInstance *me.ManagedEntity
46 repeatCount uint8
47}
48
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000049var supportedClassIds = []me.ClassID{
50 me.CardholderClassID, // 5
51 me.CircuitPackClassID, // 6
52 me.SoftwareImageClassID, // 7
53 me.PhysicalPathTerminationPointEthernetUniClassID, // 11
ozgecanetsia124d9732021-09-16 14:31:57 +030054 me.PhysicalPathTerminationPointPotsUniClassID, // 53
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000055 me.OltGClassID, // 131
56 me.OnuPowerSheddingClassID, // 133
57 me.IpHostConfigDataClassID, // 134
58 me.OnuGClassID, // 256
59 me.Onu2GClassID, // 257
60 me.TContClassID, // 262
61 me.AniGClassID, // 263
62 me.UniGClassID, // 264
63 me.PriorityQueueClassID, // 277
64 me.TrafficSchedulerClassID, // 278
65 me.VirtualEthernetInterfacePointClassID, // 329
66 me.EnhancedSecurityControlClassID, // 332
67 me.OnuDynamicPowerManagementControlClassID, // 336
68 // 347 // definitions for ME "IPv6 host config data" are currently missing in omci-lib-go!
69}
70
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +000071var fsmMsg cmn.TestMessageType
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000072
dbainbri4d3a0dc2020-12-02 00:33:42 +000073func (oo *OnuDeviceEntry) enterStartingState(ctx context.Context, e *fsm.Event) {
74 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start processing MibSync-msgs in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +000075 oo.pOnuDB = devdb.NewOnuDeviceDB(log.WithSpanFromContext(context.TODO(), ctx), oo.deviceID)
dbainbri4d3a0dc2020-12-02 00:33:42 +000076 go oo.processMibSyncMessages(ctx)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000077}
78
dbainbri4d3a0dc2020-12-02 00:33:42 +000079func (oo *OnuDeviceEntry) enterResettingMibState(ctx context.Context, e *fsm.Event) {
80 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start MibTemplate processing in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000081
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +000082 if (!oo.IsNewOnu() && !oo.baseDeviceHandler.IsReconciling()) || //use case: re-auditing failed
83 oo.baseDeviceHandler.IsSkipOnuConfigReconciling() { //use case: reconciling without omci-config failed
84 oo.baseDeviceHandler.PrepareReconcilingWithActiveAdapter(ctx)
85 oo.devState = cmn.DeviceStatusInit
Holger Hildebrandt10d98192021-01-27 15:29:31 +000086 }
dbainbri4d3a0dc2020-12-02 00:33:42 +000087 logger.Debugw(ctx, "MibSync FSM", log.Fields{"send mibReset in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +000088 oo.mutexLastTxParamStruct.Lock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +000089 _ = oo.PDevOmciCC.SendMibReset(log.WithSpanFromContext(context.TODO(), ctx), oo.baseDeviceHandler.GetOmciTimeout(), true)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000090 //TODO: needs to handle timeouts
mpagenko01499812021-03-25 10:37:12 +000091 //even though lastTxParameters are currently not used for checking the ResetResponse message we have to ensure
92 // that the lastTxMessageType is correctly set to avoid misinterpreting other responses
93 oo.lastTxParamStruct.lastTxMessageType = omci.MibResetRequestType
94 oo.lastTxParamStruct.repeatCount = 0
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +000095 oo.mutexLastTxParamStruct.Unlock()
Holger Hildebrandtc54939a2020-06-17 08:14:27 +000096}
Holger Hildebrandtccd390c2020-05-29 13:49:04 +000097
dbainbri4d3a0dc2020-12-02 00:33:42 +000098func (oo *OnuDeviceEntry) enterGettingVendorAndSerialState(ctx context.Context, e *fsm.Event) {
99 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start getting VendorId and SerialNumber in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000100 requestedAttributes := me.AttributeValueMap{"VendorId": "", "SerialNumber": 0}
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000101 oo.mutexLastTxParamStruct.Lock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000102 meInstance, err := oo.PDevOmciCC.SendGetMe(log.WithSpanFromContext(context.TODO(), ctx), me.OnuGClassID, cmn.OnugMeID, requestedAttributes, oo.baseDeviceHandler.GetOmciTimeout(), true, oo.PMibUploadFsm.CommChan)
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000103 //accept also nil as (error) return value for writing to LastTx
104 // - this avoids misinterpretation of new received OMCI messages
ozgecanetsiab36ed572021-04-01 10:38:48 +0300105 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000106 oo.mutexLastTxParamStruct.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +0300107 logger.Errorw(ctx, "ONU-G get failed, aborting MibSync FSM", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000108 pMibUlFsm := oo.PMibUploadFsm
ozgecanetsiab36ed572021-04-01 10:38:48 +0300109 if pMibUlFsm != nil {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000110 go func(a_pAFsm *cmn.AdapterFsm) {
111 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
ozgecanetsiab36ed572021-04-01 10:38:48 +0300112 }(pMibUlFsm)
113 }
114 return
115 }
mpagenko01499812021-03-25 10:37:12 +0000116 oo.lastTxParamStruct.lastTxMessageType = omci.GetRequestType
117 oo.lastTxParamStruct.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000118 oo.mutexLastTxParamStruct.Unlock()
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000119}
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000120
dbainbri4d3a0dc2020-12-02 00:33:42 +0000121func (oo *OnuDeviceEntry) enterGettingEquipmentIDState(ctx context.Context, e *fsm.Event) {
122 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start getting EquipmentId in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000123 requestedAttributes := me.AttributeValueMap{"EquipmentId": ""}
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000124 oo.mutexLastTxParamStruct.Lock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000125 meInstance, err := oo.PDevOmciCC.SendGetMe(log.WithSpanFromContext(context.TODO(), ctx), me.Onu2GClassID, cmn.Onu2gMeID, requestedAttributes, oo.baseDeviceHandler.GetOmciTimeout(), true, oo.PMibUploadFsm.CommChan)
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000126 //accept also nil as (error) return value for writing to LastTx
127 // - this avoids misinterpretation of new received OMCI messages
ozgecanetsiab36ed572021-04-01 10:38:48 +0300128 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000129 oo.mutexLastTxParamStruct.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +0300130 logger.Errorw(ctx, "ONU2-G get failed, aborting MibSync FSM!", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000131 pMibUlFsm := oo.PMibUploadFsm
ozgecanetsiab36ed572021-04-01 10:38:48 +0300132 if pMibUlFsm != nil {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000133 go func(a_pAFsm *cmn.AdapterFsm) {
134 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
ozgecanetsiab36ed572021-04-01 10:38:48 +0300135 }(pMibUlFsm)
136 }
137 return
138 }
mpagenko01499812021-03-25 10:37:12 +0000139 oo.lastTxParamStruct.lastTxMessageType = omci.GetRequestType
140 oo.lastTxParamStruct.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000141 oo.mutexLastTxParamStruct.Unlock()
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000142}
143
dbainbri4d3a0dc2020-12-02 00:33:42 +0000144func (oo *OnuDeviceEntry) enterGettingFirstSwVersionState(ctx context.Context, e *fsm.Event) {
145 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start getting IsActive and Version of first SW-image in State": e.FSM.Current(), "device-id": oo.deviceID})
mpagenko15ff4a52021-03-02 10:09:20 +0000146 requestedAttributes := me.AttributeValueMap{"IsCommitted": 0, "IsActive": 0, "Version": ""}
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000147 oo.mutexLastTxParamStruct.Lock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000148 meInstance, err := oo.PDevOmciCC.SendGetMe(log.WithSpanFromContext(context.TODO(), ctx), me.SoftwareImageClassID, cmn.FirstSwImageMeID, requestedAttributes, oo.baseDeviceHandler.GetOmciTimeout(), true, oo.PMibUploadFsm.CommChan)
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000149 //accept also nil as (error) return value for writing to LastTx
150 // - this avoids misinterpretation of new received OMCI messages
ozgecanetsiab36ed572021-04-01 10:38:48 +0300151 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000152 oo.mutexLastTxParamStruct.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +0300153 logger.Errorw(ctx, "SoftwareImage get failed, aborting MibSync FSM", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000154 pMibUlFsm := oo.PMibUploadFsm
ozgecanetsiab36ed572021-04-01 10:38:48 +0300155 if pMibUlFsm != nil {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000156 go func(a_pAFsm *cmn.AdapterFsm) {
157 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
ozgecanetsiab36ed572021-04-01 10:38:48 +0300158 }(pMibUlFsm)
159 }
160 return
161 }
mpagenko01499812021-03-25 10:37:12 +0000162 oo.lastTxParamStruct.lastTxMessageType = omci.GetRequestType
163 oo.lastTxParamStruct.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000164 oo.mutexLastTxParamStruct.Unlock()
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000165}
166
dbainbri4d3a0dc2020-12-02 00:33:42 +0000167func (oo *OnuDeviceEntry) enterGettingSecondSwVersionState(ctx context.Context, e *fsm.Event) {
168 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start getting IsActive and Version of second SW-image in State": e.FSM.Current(), "device-id": oo.deviceID})
mpagenko15ff4a52021-03-02 10:09:20 +0000169 requestedAttributes := me.AttributeValueMap{"IsCommitted": 0, "IsActive": 0, "Version": ""}
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000170 oo.mutexLastTxParamStruct.Lock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000171 meInstance, err := oo.PDevOmciCC.SendGetMe(log.WithSpanFromContext(context.TODO(), ctx), me.SoftwareImageClassID, cmn.SecondSwImageMeID, requestedAttributes, oo.baseDeviceHandler.GetOmciTimeout(), true, oo.PMibUploadFsm.CommChan)
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000172 //accept also nil as (error) return value for writing to LastTx
173 // - this avoids misinterpretation of new received OMCI messages
ozgecanetsiab36ed572021-04-01 10:38:48 +0300174 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000175 oo.mutexLastTxParamStruct.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +0300176 logger.Errorw(ctx, "SoftwareImage get failed, aborting MibSync FSM", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000177 pMibUlFsm := oo.PMibUploadFsm
ozgecanetsiab36ed572021-04-01 10:38:48 +0300178 if pMibUlFsm != nil {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000179 go func(a_pAFsm *cmn.AdapterFsm) {
180 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
ozgecanetsiab36ed572021-04-01 10:38:48 +0300181 }(pMibUlFsm)
182 }
183 return
184 }
mpagenko01499812021-03-25 10:37:12 +0000185 oo.lastTxParamStruct.lastTxMessageType = omci.GetRequestType
186 oo.lastTxParamStruct.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000187 oo.mutexLastTxParamStruct.Unlock()
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000188}
189
dbainbri4d3a0dc2020-12-02 00:33:42 +0000190func (oo *OnuDeviceEntry) enterGettingMacAddressState(ctx context.Context, e *fsm.Event) {
191 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start getting MacAddress in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000192 requestedAttributes := me.AttributeValueMap{"MacAddress": ""}
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000193 oo.mutexLastTxParamStruct.Lock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000194 meInstance, err := oo.PDevOmciCC.SendGetMe(log.WithSpanFromContext(context.TODO(), ctx), me.IpHostConfigDataClassID, cmn.IPHostConfigDataMeID, requestedAttributes, oo.baseDeviceHandler.GetOmciTimeout(), true, oo.PMibUploadFsm.CommChan)
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000195 //accept also nil as (error) return value for writing to LastTx
196 // - this avoids misinterpretation of new received OMCI messages
ozgecanetsiab36ed572021-04-01 10:38:48 +0300197 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000198 oo.mutexLastTxParamStruct.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +0300199 logger.Errorw(ctx, "IpHostConfigData get failed, aborting MibSync FSM", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000200 pMibUlFsm := oo.PMibUploadFsm
ozgecanetsiab36ed572021-04-01 10:38:48 +0300201 if pMibUlFsm != nil {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000202 go func(a_pAFsm *cmn.AdapterFsm) {
203 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
ozgecanetsiab36ed572021-04-01 10:38:48 +0300204 }(pMibUlFsm)
205 }
206 return
207 }
mpagenko01499812021-03-25 10:37:12 +0000208 oo.lastTxParamStruct.lastTxMessageType = omci.GetRequestType
209 oo.lastTxParamStruct.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000210 oo.mutexLastTxParamStruct.Unlock()
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000211}
212
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000213func (oo *OnuDeviceEntry) enterGettingMibTemplateState(ctx context.Context, e *fsm.Event) {
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000214
Holger Hildebrandt05011352021-06-15 09:40:24 +0000215 oo.mutexOnuSwImageIndications.RLock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000216 if oo.onuSwImageIndications.ActiveEntityEntry.Valid {
217 oo.MutexPersOnuConfig.Lock()
218 oo.SOnuPersistentData.PersActiveSwVersion = oo.onuSwImageIndications.ActiveEntityEntry.Version
219 oo.MutexPersOnuConfig.Unlock()
Holger Hildebrandt05011352021-06-15 09:40:24 +0000220 oo.mutexOnuSwImageIndications.RUnlock()
mpagenko15ff4a52021-03-02 10:09:20 +0000221 } else {
Holger Hildebrandt05011352021-06-15 09:40:24 +0000222 oo.mutexOnuSwImageIndications.RUnlock()
mpagenko15ff4a52021-03-02 10:09:20 +0000223 logger.Errorw(ctx, "get-mib-template: no active SW version found, working with empty SW version, which might be untrustworthy",
224 log.Fields{"device-id": oo.deviceID})
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000225 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000226 if oo.getMibFromTemplate(ctx) {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000227 logger.Debug(ctx, "MibSync FSM - valid MEs stored from template")
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000228 oo.pOnuDB.LogMeDb(ctx)
229 fsmMsg = cmn.LoadMibTemplateOk
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000230 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000231 logger.Debug(ctx, "MibSync FSM - no valid MEs stored from template - perform MIB-upload!")
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000232 fsmMsg = cmn.LoadMibTemplateFailed
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000233
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000234 oo.pOpenOnuAc.LockMutexMibTemplateGenerated()
235 if mibTemplateIsGenerated, exist := oo.pOpenOnuAc.GetMibTemplatesGenerated(oo.mibTemplatePath); exist {
Holger Hildebrandt441a0172020-12-10 13:57:08 +0000236 if mibTemplateIsGenerated {
237 logger.Debugw(ctx,
238 "MibSync FSM - template was successfully generated before, but doesn't exist or isn't usable anymore - reset flag in map",
239 log.Fields{"path": oo.mibTemplatePath, "device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000240 oo.pOpenOnuAc.SetMibTemplatesGenerated(oo.mibTemplatePath, false)
Holger Hildebrandt441a0172020-12-10 13:57:08 +0000241 }
242 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000243 oo.pOpenOnuAc.UnlockMutexMibTemplateGenerated()
Holger Hildebrandt441a0172020-12-10 13:57:08 +0000244 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000245 mibSyncMsg := cmn.Message{
246 Type: cmn.TestMsg,
247 Data: cmn.TestMessage{
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000248 TestMessageVal: fsmMsg,
249 },
250 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000251 oo.PMibUploadFsm.CommChan <- mibSyncMsg
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000252}
253
dbainbri4d3a0dc2020-12-02 00:33:42 +0000254func (oo *OnuDeviceEntry) enterUploadingState(ctx context.Context, e *fsm.Event) {
255 logger.Debugw(ctx, "MibSync FSM", log.Fields{"send MibUpload in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000256 _ = oo.PDevOmciCC.SendMibUpload(log.WithSpanFromContext(context.TODO(), ctx), oo.baseDeviceHandler.GetOmciTimeout(), true)
mpagenko01499812021-03-25 10:37:12 +0000257 //even though lastTxParameters are currently not used for checking the ResetResponse message we have to ensure
258 // that the lastTxMessageType is correctly set to avoid misinterpreting other responses
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000259 oo.mutexLastTxParamStruct.Lock()
mpagenko01499812021-03-25 10:37:12 +0000260 oo.lastTxParamStruct.lastTxMessageType = omci.MibUploadRequestType
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000261 oo.mutexLastTxParamStruct.Unlock()
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000262}
263
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000264func (oo *OnuDeviceEntry) enterUploadDoneState(ctx context.Context, e *fsm.Event) {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000265 logger.Debugw(ctx, "MibSync FSM", log.Fields{"send notification to core in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000266 oo.transferSystemEvent(ctx, cmn.MibDatabaseSync)
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000267 go func() {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000268 _ = oo.PMibUploadFsm.PFsm.Event(UlEvSuccess)
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000269 }()
270}
271
272func (oo *OnuDeviceEntry) enterInSyncState(ctx context.Context, e *fsm.Event) {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000273 oo.MutexPersOnuConfig.Lock()
274 oo.SOnuPersistentData.PersMibLastDbSync = uint32(time.Now().Unix())
275 oo.MutexPersOnuConfig.Unlock()
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000276 if oo.mibAuditInterval > 0 {
277 logger.Debugw(ctx, "MibSync FSM", log.Fields{"trigger next Audit in State": e.FSM.Current(), "oo.mibAuditInterval": oo.mibAuditInterval, "device-id": oo.deviceID})
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000278 go func() {
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000279 time.Sleep(oo.mibAuditInterval)
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000280 if err := oo.PMibUploadFsm.PFsm.Event(UlEvAuditMib); err != nil {
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000281 logger.Debugw(ctx, "MibSyncFsm: Can't go to state auditing", log.Fields{"device-id": oo.deviceID, "err": err})
282 }
283 }()
284 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000285}
286
Holger Hildebrandt9afc1582021-11-30 16:10:19 +0000287func (oo *OnuDeviceEntry) enterVerifyingAndStoringTPsState(ctx context.Context, e *fsm.Event) {
288 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start verifying and storing TPs in State": e.FSM.Current(), "device-id": oo.deviceID})
289
290 allTpInstPresent := true
291 oo.MutexPersOnuConfig.Lock()
292 oo.MutexReconciledTpInstances.Lock()
293 for indexUni, uniData := range oo.SOnuPersistentData.PersUniConfig {
294 uniID := uniData.PersUniID
295 oo.ReconciledTpInstances[uniID] = make(map[uint8]inter_adapter.TechProfileDownloadMessage)
296 for tpID, tpPath := range uniData.PersTpPathMap {
297 if tpPath != "" {
298 // Request the TP instance from the openolt adapter
299 iaTechTpInst, err := oo.baseDeviceHandler.GetTechProfileInstanceFromParentAdapter(ctx, uniID, tpPath)
300 if err == nil && iaTechTpInst != nil {
301 logger.Debugw(ctx, "reconciling - store Tp instance", log.Fields{"uniID": uniID, "tpID": tpID,
302 "*iaTechTpInst": iaTechTpInst, "device-id": oo.deviceID})
303 oo.ReconciledTpInstances[uniID][tpID] = *iaTechTpInst
304 } else {
305 // During the absence of the ONU adapter there seem to have been TP specific configurations!
306 // The no longer available TP and the associated flows must be deleted from the ONU KV store
307 // and after a MIB reset a new reconciling attempt with OMCI configuration must be started.
308 allTpInstPresent = false
309 logger.Infow(ctx, "reconciling - can't get tp instance - delete tp and associated flows",
310 log.Fields{"tp-id": tpID, "tpPath": tpPath, "uni-id": uniID, "device-id": oo.deviceID, "err": err})
311 delete(oo.SOnuPersistentData.PersUniConfig[indexUni].PersTpPathMap, tpID)
312 flowSlice := oo.SOnuPersistentData.PersUniConfig[indexUni].PersFlowParams
313 for indexFlow, flowData := range flowSlice {
314 if flowData.VlanRuleParams.TpID == tpID {
315 if len(flowSlice) == 1 {
316 flowSlice = []cmn.UniVlanFlowParams{}
317 } else {
318 flowSlice = append(flowSlice[:indexFlow], flowSlice[indexFlow+1:]...)
319 }
320 oo.SOnuPersistentData.PersUniConfig[indexUni].PersFlowParams = flowSlice
321 }
322 }
323 }
324 }
325 }
326 }
327 oo.MutexReconciledTpInstances.Unlock()
328 oo.MutexPersOnuConfig.Unlock()
329
330 if allTpInstPresent {
331 logger.Debugw(ctx, "MibSync FSM", log.Fields{"reconciling - verifying TPs successful": e.FSM.Current(), "device-id": oo.deviceID})
332 go func() {
333 _ = oo.PMibUploadFsm.PFsm.Event(UlEvSuccess)
334 }()
335 } else {
336 logger.Debugw(ctx, "MibSync FSM", log.Fields{"reconciling - verifying TPs not successful": e.FSM.Current(), "device-id": oo.deviceID})
337 oo.baseDeviceHandler.SetReconcilingReasonUpdate(true)
338 go func() {
339 if err := oo.baseDeviceHandler.StorePersistentData(ctx); err != nil {
340 logger.Warnw(ctx, "reconciling - store persistent data error - continue for now as there will be additional write attempts",
341 log.Fields{"device-id": oo.deviceID, "err": err})
342 }
343 _ = oo.PMibUploadFsm.PFsm.Event(UlEvMismatch)
344 }()
345 }
346}
347
dbainbri4d3a0dc2020-12-02 00:33:42 +0000348func (oo *OnuDeviceEntry) enterExaminingMdsState(ctx context.Context, e *fsm.Event) {
349 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start GetMds processing in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000350 oo.requestMdsValue(ctx)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000351}
352
dbainbri4d3a0dc2020-12-02 00:33:42 +0000353func (oo *OnuDeviceEntry) enterResynchronizingState(ctx context.Context, e *fsm.Event) {
354 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start MibResync processing in State": e.FSM.Current(), "device-id": oo.deviceID})
355 logger.Debug(ctx, "function not implemented yet")
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000356 // TODOs:
357 // VOL-3805 - Provide exclusive OMCI channel for one FSM
358 // VOL-3785 - New event notifications and corresponding performance counters for openonu-adapter-go
359 // VOL-3792 - Support periodical audit via mib resync
360 // VOL-3793 - ONU-reconcile handling after adapter restart based on mib resync
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000361}
362
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000363func (oo *OnuDeviceEntry) enterExaminingMdsSuccessState(ctx context.Context, e *fsm.Event) {
364 logger.Debugw(ctx, "MibSync FSM",
365 log.Fields{"Start processing on examining MDS success in State": e.FSM.Current(), "device-id": oo.deviceID})
366
367 if oo.getMibFromTemplate(ctx) {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000368 oo.baseDeviceHandler.StartReconciling(ctx, true)
369 oo.baseDeviceHandler.AddAllUniPorts(ctx)
Holger Hildebrandt9afc1582021-11-30 16:10:19 +0000370 _ = oo.baseDeviceHandler.ReasonUpdate(ctx, cmn.DrInitialMibDownloaded, oo.baseDeviceHandler.IsReconcilingReasonUpdate())
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000371 oo.baseDeviceHandler.SetReadyForOmciConfig(true)
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000372
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000373 if !oo.baseDeviceHandler.GetCollectorIsRunning() {
Holger Hildebrandtced74e72021-06-10 14:55:53 +0000374 // Start PM collector routine
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000375 go oo.baseDeviceHandler.StartCollector(ctx)
Holger Hildebrandtced74e72021-06-10 14:55:53 +0000376 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000377 if !oo.baseDeviceHandler.GetAlarmManagerIsRunning(ctx) {
378 go oo.baseDeviceHandler.StartAlarmManager(ctx)
Holger Hildebrandtced74e72021-06-10 14:55:53 +0000379 }
Girish Gowdrae95687a2021-09-08 16:30:58 -0700380
381 for _, uniPort := range *oo.baseDeviceHandler.GetUniEntityMap() {
382 // only if this port was enabled for use by the operator at startup
383 if (1<<uniPort.UniID)&oo.baseDeviceHandler.GetUniPortMask() == (1 << uniPort.UniID) {
384 if !oo.baseDeviceHandler.GetFlowMonitoringIsRunning(uniPort.UniID) {
385 go oo.baseDeviceHandler.PerOnuFlowHandlerRoutine(uniPort.UniID)
386 }
387 }
388 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000389 oo.MutexPersOnuConfig.RLock()
390 if oo.SOnuPersistentData.PersUniDisableDone {
391 oo.MutexPersOnuConfig.RUnlock()
392 oo.baseDeviceHandler.DisableUniPortStateUpdate(ctx)
Holger Hildebrandt9afc1582021-11-30 16:10:19 +0000393 _ = oo.baseDeviceHandler.ReasonUpdate(ctx, cmn.DrOmciAdminLock, oo.baseDeviceHandler.IsReconcilingReasonUpdate())
Holger Hildebrandtbdc5f002021-04-19 14:46:21 +0000394 } else {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000395 oo.MutexPersOnuConfig.RUnlock()
396 oo.baseDeviceHandler.EnableUniPortStateUpdate(ctx)
Holger Hildebrandtbdc5f002021-04-19 14:46:21 +0000397 }
Holger Hildebrandtb314f442021-11-24 12:03:10 +0000398
399 // no need to reconcile additional data for MibDownloadFsm, LockStateFsm, or UnlockStateFsm
400
401 if oo.baseDeviceHandler.ReconcileDeviceTechProf(ctx) {
402 // start go routine with select() on reconciling flow channel before
403 // starting flow reconciling process to prevent loss of any signal
Holger Hildebrandtf2fcdd42021-12-15 11:42:19 +0000404 syncChannel := make(chan struct{})
405 go func(aSyncChannel chan struct{}) {
Holger Hildebrandtb314f442021-11-24 12:03:10 +0000406 // In multi-ONU/multi-flow environment stopping reconcilement has to be delayed until
407 // we get a signal that the processing of the last step to rebuild the adapter internal
408 // flow data is finished.
409 expiry := oo.baseDeviceHandler.GetReconcileExpiryVlanConfigAbort()
410 oo.setReconcilingFlows(true)
Holger Hildebrandtf2fcdd42021-12-15 11:42:19 +0000411 aSyncChannel <- struct{}{}
Holger Hildebrandtb314f442021-11-24 12:03:10 +0000412 select {
413 case success := <-oo.chReconcilingFlowsFinished:
414 if success {
415 logger.Debugw(ctx, "reconciling flows has been finished in time",
416 log.Fields{"device-id": oo.deviceID})
417 _ = oo.PMibUploadFsm.PFsm.Event(UlEvSuccess)
418
419 } else {
420 logger.Debugw(ctx, "wait for reconciling flows aborted",
421 log.Fields{"device-id": oo.deviceID})
422 }
423 case <-time.After(expiry):
424 logger.Errorw(ctx, "timeout waiting for reconciling flows to be finished!",
425 log.Fields{"device-id": oo.deviceID, "expiry": expiry})
426 _ = oo.PMibUploadFsm.PFsm.Event(UlEvMismatch)
427 }
428 oo.setReconcilingFlows(false)
Holger Hildebrandtf2fcdd42021-12-15 11:42:19 +0000429 }(syncChannel)
430 // block further processing until the above Go routine has really started
431 // and is ready to receive values from chReconcilingFlowsFinished
432 <-syncChannel
Holger Hildebrandtb314f442021-11-24 12:03:10 +0000433 oo.baseDeviceHandler.ReconcileDeviceFlowConfig(ctx)
434 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000435 } else {
436 logger.Debugw(ctx, "MibSync FSM",
437 log.Fields{"Getting MIB from template not successful": e.FSM.Current(), "device-id": oo.deviceID})
438 go func() {
439 //switch to reconciling with OMCI config
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000440 _ = oo.PMibUploadFsm.PFsm.Event(UlEvMismatch)
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000441 }()
442 }
443}
444
dbainbri4d3a0dc2020-12-02 00:33:42 +0000445func (oo *OnuDeviceEntry) enterAuditingState(ctx context.Context, e *fsm.Event) {
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000446 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start MibAudit processing in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000447 if oo.baseDeviceHandler.CheckAuditStartCondition(ctx, cmn.CUploadFsm) {
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000448 oo.requestMdsValue(ctx)
449 } else {
mpagenkof1fc3862021-02-16 10:09:52 +0000450 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Configuration is ongoing or missing - skip auditing!": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000451 go func() {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000452 _ = oo.PMibUploadFsm.PFsm.Event(UlEvSuccess)
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000453 }()
454 }
455}
456
457func (oo *OnuDeviceEntry) enterReAuditingState(ctx context.Context, e *fsm.Event) {
458 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start retest MdsValue processing in State": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000459 if oo.baseDeviceHandler.CheckAuditStartCondition(ctx, cmn.CUploadFsm) {
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000460 oo.requestMdsValue(ctx)
461 } else {
mpagenkof1fc3862021-02-16 10:09:52 +0000462 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Configuration is ongoing or missing - skip re-auditing!": e.FSM.Current(), "device-id": oo.deviceID})
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000463 go func() {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000464 _ = oo.PMibUploadFsm.PFsm.Event(UlEvSuccess)
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000465 }()
466 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000467}
468
dbainbri4d3a0dc2020-12-02 00:33:42 +0000469func (oo *OnuDeviceEntry) enterOutOfSyncState(ctx context.Context, e *fsm.Event) {
470 logger.Debugw(ctx, "MibSync FSM", log.Fields{"Start MibReconcile processing in State": e.FSM.Current(), "device-id": oo.deviceID})
471 logger.Debug(ctx, "function not implemented yet")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000472}
473
dbainbri4d3a0dc2020-12-02 00:33:42 +0000474func (oo *OnuDeviceEntry) processMibSyncMessages(ctx context.Context) {
475 logger.Debugw(ctx, "MibSync Msg", log.Fields{"Start routine to process OMCI-messages for device-id": oo.deviceID})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000476loop:
477 for {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000478 // case <-ctx.Done():
479 // logger.Info("MibSync Msg", log.Fields{"Message handling canceled via context for device-id": onuDeviceEntry.deviceID})
480 // break loop
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000481 message, ok := <-oo.PMibUploadFsm.CommChan
Himani Chawla4d908332020-08-31 12:30:20 +0530482 if !ok {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000483 logger.Info(ctx, "MibSync Msg", log.Fields{"Message couldn't be read from channel for device-id": oo.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +0530484 break loop
485 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000486 logger.Debugw(ctx, "MibSync Msg", log.Fields{"Received message on ONU MibSyncChan for device-id": oo.deviceID})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000487
Himani Chawla4d908332020-08-31 12:30:20 +0530488 switch message.Type {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000489 case cmn.TestMsg:
490 msg, _ := message.Data.(cmn.TestMessage)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000491 oo.handleTestMsg(ctx, msg)
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000492 case cmn.OMCI:
493 msg, _ := message.Data.(cmn.OmciMessage)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000494 oo.handleOmciMessage(ctx, msg)
Himani Chawla4d908332020-08-31 12:30:20 +0530495 default:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000496 logger.Warn(ctx, "MibSync Msg", log.Fields{"Unknown message type received for device-id": oo.deviceID, "message.Type": message.Type})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000497 }
498 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000499 logger.Info(ctx, "MibSync Msg", log.Fields{"Stopped handling of MibSyncChan for device-id": oo.deviceID})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000500 // TODO: only this action?
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000501 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000502}
503
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000504func (oo *OnuDeviceEntry) handleTestMsg(ctx context.Context, msg cmn.TestMessage) {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000505
dbainbri4d3a0dc2020-12-02 00:33:42 +0000506 logger.Debugw(ctx, "MibSync Msg", log.Fields{"TestMessage received for device-id": oo.deviceID, "msg.TestMessageVal": msg.TestMessageVal})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000507
508 switch msg.TestMessageVal {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000509 case cmn.LoadMibTemplateFailed:
510 _ = oo.PMibUploadFsm.PFsm.Event(UlEvUploadMib)
511 logger.Debugw(ctx, "MibSync Msg", log.Fields{"state": string(oo.PMibUploadFsm.PFsm.Current())})
512 case cmn.LoadMibTemplateOk:
513 _ = oo.PMibUploadFsm.PFsm.Event(UlEvSuccess)
514 logger.Debugw(ctx, "MibSync Msg", log.Fields{"state": string(oo.PMibUploadFsm.PFsm.Current())})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000515 default:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000516 logger.Warn(ctx, "MibSync Msg", log.Fields{"Unknown message type received for device-id": oo.deviceID, "msg.TestMessageVal": msg.TestMessageVal})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000517 }
518}
519
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000520func (oo *OnuDeviceEntry) handleOmciMibResetResponseMessage(ctx context.Context, msg cmn.OmciMessage) {
521 if oo.PMibUploadFsm.PFsm.Is(UlStResettingMib) {
Himani Chawla4d908332020-08-31 12:30:20 +0530522 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeMibResetResponse)
523 if msgLayer != nil {
524 msgObj, msgOk := msgLayer.(*omci.MibResetResponse)
525 if msgOk {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000526 logger.Debugw(ctx, "MibResetResponse Data", log.Fields{"data-fields": msgObj})
Himani Chawla4d908332020-08-31 12:30:20 +0530527 if msgObj.Result == me.Success {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000528 oo.MutexPersOnuConfig.Lock()
529 oo.SOnuPersistentData.PersMibDataSyncAdpt = 0
530 oo.MutexPersOnuConfig.Unlock()
Himani Chawla4d908332020-08-31 12:30:20 +0530531 // trigger retrieval of VendorId and SerialNumber
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000532 _ = oo.PMibUploadFsm.PFsm.Event(UlEvGetVendorAndSerial)
Himani Chawla4d908332020-08-31 12:30:20 +0530533 return
534 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000535 logger.Errorw(ctx, "Omci MibResetResponse Error", log.Fields{"device-id": oo.deviceID, "Error": msgObj.Result})
Himani Chawla4d908332020-08-31 12:30:20 +0530536 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000537 logger.Errorw(ctx, "Omci Msg layer could not be assigned", log.Fields{"device-id": oo.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +0530538 }
539 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000540 logger.Errorw(ctx, "Omci Msg layer could not be detected", log.Fields{"device-id": oo.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +0530541 }
542 } else {
mpagenko01499812021-03-25 10:37:12 +0000543 //in case the last request was MdsGetRequest this issue may appear if the ONU was online before and has received the MIB reset
544 // with Sequence number 0x8000 as last request before - so it may still respond to that
545 // then we may force the ONU to react on the MdsGetRequest with a new message that uses an increased Sequence number
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000546 oo.mutexLastTxParamStruct.Lock()
mpagenko01499812021-03-25 10:37:12 +0000547 if oo.lastTxParamStruct.lastTxMessageType == omci.GetRequestType && oo.lastTxParamStruct.repeatCount == 0 {
548 logger.Debugw(ctx, "MibSync FSM - repeat MdsGetRequest (updated SequenceNumber)", log.Fields{"device-id": oo.deviceID})
549 requestedAttributes := me.AttributeValueMap{"MibDataSync": ""}
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000550 _, err := oo.PDevOmciCC.SendGetMe(log.WithSpanFromContext(context.TODO(), ctx),
551 me.OnuDataClassID, cmn.OnuDataMeID, requestedAttributes, oo.baseDeviceHandler.GetOmciTimeout(), true, oo.PMibUploadFsm.CommChan)
ozgecanetsiab36ed572021-04-01 10:38:48 +0300552 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000553 oo.mutexLastTxParamStruct.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +0300554 logger.Errorw(ctx, "ONUData get failed, aborting MibSync", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000555 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
ozgecanetsiab36ed572021-04-01 10:38:48 +0300556 return
557 }
mpagenko01499812021-03-25 10:37:12 +0000558 //TODO: needs extra handling of timeouts
559 oo.lastTxParamStruct.repeatCount = 1
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000560 oo.mutexLastTxParamStruct.Unlock()
mpagenko01499812021-03-25 10:37:12 +0000561 return
562 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000563 oo.mutexLastTxParamStruct.Unlock()
mpagenko01499812021-03-25 10:37:12 +0000564 logger.Errorw(ctx, "unexpected MibResetResponse - ignoring", log.Fields{"device-id": oo.deviceID})
565 //perhaps some still lingering message from some prior activity, let's wait for the real response
566 return
Himani Chawla4d908332020-08-31 12:30:20 +0530567 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000568 logger.Info(ctx, "MibSync Msg", log.Fields{"Stopped handling of MibSyncChan for device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000569 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
Himani Chawla4d908332020-08-31 12:30:20 +0530570}
571
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000572func (oo *OnuDeviceEntry) handleOmciMibUploadResponseMessage(ctx context.Context, msg cmn.OmciMessage) {
Himani Chawla4d908332020-08-31 12:30:20 +0530573 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeMibUploadResponse)
574 if msgLayer == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000575 logger.Errorw(ctx, "Omci Msg layer could not be detected", log.Fields{"device-id": oo.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +0530576 return
577 }
578 msgObj, msgOk := msgLayer.(*omci.MibUploadResponse)
579 if !msgOk {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000580 logger.Errorw(ctx, "Omci Msg layer could not be assigned", log.Fields{"device-id": oo.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +0530581 return
582 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000583 logger.Debugw(ctx, "MibUploadResponse Data for:", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj})
Himani Chawla4d908332020-08-31 12:30:20 +0530584 /* to be verified / reworked !!! */
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000585 oo.PDevOmciCC.UploadNoOfCmds = msgObj.NumberOfCommands
586 if oo.PDevOmciCC.UploadSequNo < oo.PDevOmciCC.UploadNoOfCmds {
587 _ = oo.PDevOmciCC.SendMibUploadNext(log.WithSpanFromContext(context.TODO(), ctx), oo.baseDeviceHandler.GetOmciTimeout(), true)
mpagenko01499812021-03-25 10:37:12 +0000588 //even though lastTxParameters are currently not used for checking the ResetResponse message we have to ensure
589 // that the lastTxMessageType is correctly set to avoid misinterpreting other responses
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000590 oo.mutexLastTxParamStruct.Lock()
mpagenko01499812021-03-25 10:37:12 +0000591 oo.lastTxParamStruct.lastTxMessageType = omci.MibUploadNextRequestType
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000592 oo.mutexLastTxParamStruct.Unlock()
Himani Chawla4d908332020-08-31 12:30:20 +0530593 } else {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000594 logger.Errorw(ctx, "Invalid number of commands received for:", log.Fields{"device-id": oo.deviceID, "UploadNoOfCmds": oo.PDevOmciCC.UploadNoOfCmds})
Himani Chawla4d908332020-08-31 12:30:20 +0530595 //TODO right action?
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000596 _ = oo.PMibUploadFsm.PFsm.Event(UlEvTimeout)
Himani Chawla4d908332020-08-31 12:30:20 +0530597 }
598}
599
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000600func (oo *OnuDeviceEntry) handleOmciMibUploadNextResponseMessage(ctx context.Context, msg cmn.OmciMessage) {
Himani Chawla4d908332020-08-31 12:30:20 +0530601 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeMibUploadNextResponse)
Andrea Campanella6515c582020-10-05 11:25:00 +0200602
mpagenko7033f4e2021-11-19 18:04:22 +0000603 if msgLayer != nil {
604 msgObj, msgOk := msgLayer.(*omci.MibUploadNextResponse)
605 if !msgOk {
606 logger.Errorw(ctx, "Omci Msg layer could not be assigned", log.Fields{"device-id": oo.deviceID})
607 return
mpagenko836a1fd2021-11-01 16:12:42 +0000608 }
mpagenko7033f4e2021-11-19 18:04:22 +0000609 meName := msgObj.ReportedME.GetName()
610 meClassID := msgObj.ReportedME.GetClassID()
611 meEntityID := msgObj.ReportedME.GetEntityID()
612
613 logger.Debugw(ctx, "MibUploadNextResponse Data for:", log.Fields{"device-id": oo.deviceID, "meName": meName, "data-fields": msgObj})
614
615 if meName == devdb.CUnknownItuG988ManagedEntity || meName == devdb.CUnknownVendorSpecificManagedEntity {
616 oo.pOnuDB.PutUnknownMe(ctx, devdb.UnknownMeName(meName), meClassID, meEntityID, msgObj.ReportedME.GetAttributeMask(), msgObj.BaseLayer.Payload)
617 } else {
618 //with relaxed decoding set in the OMCI-LIB we have the chance to detect if there are some unknown attributes appended which we cannot decode
619 if unknownAttrLayer := (*msg.OmciPacket).Layer(omci.LayerTypeUnknownAttributes); unknownAttrLayer != nil {
620 logger.Warnw(ctx, "MibUploadNextResponse contains unknown attributes", log.Fields{"device-id": oo.deviceID})
621 if unknownAttributes, ok := unknownAttrLayer.(*omci.UnknownAttributes); ok {
622 // provide a loop over several ME's here already in preparation of OMCI extended message format
623 for _, unknown := range unknownAttributes.Attributes {
624 unknownAttrClassID := unknown.EntityClass // ClassID
625 unknownAttrInst := unknown.EntityInstance // uint16
626 unknownAttrMask := unknown.AttributeMask // ui
627 unknownAttrBlob := unknown.AttributeData // []byte
628 logger.Warnw(ctx, "unknown attributes detected for", log.Fields{"device-id": oo.deviceID,
629 "Me-ClassId": unknownAttrClassID, "Me-InstId": unknownAttrInst, "unknown mask": unknownAttrMask,
630 "unknown attributes": unknownAttrBlob})
631 //TODO!!! We have to find a way to put this extra information into the (MIB)DB, see below pOnuDB.PutMe
632 // this probably requires an (add-on) extension in the DB, that should not harm any other (get) processing -> later as a second step
633 } // for all included ME's with unknown attributes
634 } else {
635 logger.Errorw(ctx, "unknownAttrLayer could not be decoded", log.Fields{"device-id": oo.deviceID})
636 }
637 }
638 oo.pOnuDB.PutMe(ctx, meClassID, meEntityID, msgObj.ReportedME.GetAttributeValueMap())
639 }
640 } else {
641 logger.Errorw(ctx, "Omci Msg layer could not be detected", log.Fields{"device-id": oo.deviceID})
642 //as long as omci-lib does not support decoding of table attribute as 'unknown/unspecified' attribute
643 // we have to verify, if this failure is from table attribute and try to go forward with ignoring the complete message
644 errLayer := (*msg.OmciPacket).Layer(gopacket.LayerTypeDecodeFailure)
645 if failure, decodeOk := errLayer.(*gopacket.DecodeFailure); decodeOk {
646 errMsg := failure.String()
647 if !strings.Contains(strings.ToLower(errMsg), "table decode") {
648 //something still unexected happened, needs deeper investigation - stop complete MIB upload process (timeout)
649 return
650 }
651 logger.Warnw(ctx, "Decode issue on received MibUploadNextResponse frame - found table attribute(s) (message ignored)",
652 log.Fields{"device-id": oo.deviceID, "issue": errMsg})
653 }
Himani Chawla4d908332020-08-31 12:30:20 +0530654 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000655 if oo.PDevOmciCC.UploadSequNo < oo.PDevOmciCC.UploadNoOfCmds {
656 _ = oo.PDevOmciCC.SendMibUploadNext(log.WithSpanFromContext(context.TODO(), ctx), oo.baseDeviceHandler.GetOmciTimeout(), true)
mpagenko01499812021-03-25 10:37:12 +0000657 //even though lastTxParameters are currently not used for checking the ResetResponse message we have to ensure
658 // that the lastTxMessageType is correctly set to avoid misinterpreting other responses
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000659 oo.mutexLastTxParamStruct.Lock()
mpagenko01499812021-03-25 10:37:12 +0000660 oo.lastTxParamStruct.lastTxMessageType = omci.MibUploadNextRequestType
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000661 oo.mutexLastTxParamStruct.Unlock()
Himani Chawla4d908332020-08-31 12:30:20 +0530662 } else {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000663 oo.pOnuDB.LogMeDb(ctx)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000664 err := oo.createAndPersistMibTemplate(ctx)
Himani Chawla4d908332020-08-31 12:30:20 +0530665 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000666 logger.Errorw(ctx, "MibSync - MibTemplate - Failed to create and persist the mib template", log.Fields{"error": err, "device-id": oo.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +0530667 }
668
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000669 _ = oo.PMibUploadFsm.PFsm.Event(UlEvSuccess)
Himani Chawla4d908332020-08-31 12:30:20 +0530670 }
671}
672
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000673func (oo *OnuDeviceEntry) handleOmciGetResponseMessage(ctx context.Context, msg cmn.OmciMessage) error {
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000674 var err error = nil
mpagenko01499812021-03-25 10:37:12 +0000675
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000676 oo.mutexLastTxParamStruct.RLock()
mpagenko01499812021-03-25 10:37:12 +0000677 if oo.lastTxParamStruct.lastTxMessageType != omci.GetRequestType ||
678 oo.lastTxParamStruct.pLastTxMeInstance == nil {
679 //in case the last request was MibReset this issue may appear if the ONU was online before and has received the MDS GetRequest
680 // with Sequence number 0x8000 as last request before - so it may still respond to that
681 // then we may force the ONU to react on the MIB reset with a new message that uses an increased Sequence number
682 if oo.lastTxParamStruct.lastTxMessageType == omci.MibResetRequestType && oo.lastTxParamStruct.repeatCount == 0 {
683 logger.Debugw(ctx, "MibSync FSM - repeat mibReset (updated SequenceNumber)", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000684 _ = oo.PDevOmciCC.SendMibReset(log.WithSpanFromContext(context.TODO(), ctx), oo.baseDeviceHandler.GetOmciTimeout(), true)
mpagenko01499812021-03-25 10:37:12 +0000685 //TODO: needs extra handling of timeouts
686 oo.lastTxParamStruct.repeatCount = 1
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000687 oo.mutexLastTxParamStruct.RUnlock()
mpagenko01499812021-03-25 10:37:12 +0000688 return nil
689 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000690 oo.mutexLastTxParamStruct.RUnlock()
mpagenko01499812021-03-25 10:37:12 +0000691 logger.Warnw(ctx, "unexpected GetResponse - ignoring", log.Fields{"device-id": oo.deviceID})
692 //perhaps some still lingering message from some prior activity, let's wait for the real response
693 return nil
694 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000695 oo.mutexLastTxParamStruct.RUnlock()
Himani Chawla4d908332020-08-31 12:30:20 +0530696 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeGetResponse)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000697 if msgLayer == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000698 logger.Errorw(ctx, "omci Msg layer could not be detected for GetResponse - handling of MibSyncChan stopped", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000699 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000700 return fmt.Errorf("omci Msg layer could not be detected for GetResponse - handling of MibSyncChan stopped: %s", oo.deviceID)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000701 }
702 msgObj, msgOk := msgLayer.(*omci.GetResponse)
703 if !msgOk {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000704 logger.Errorw(ctx, "omci Msg layer could not be assigned for GetResponse - handling of MibSyncChan stopped", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000705 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000706 return fmt.Errorf("omci Msg layer could not be assigned for GetResponse - handling of MibSyncChan stopped: %s", oo.deviceID)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000707 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000708 logger.Debugw(ctx, "MibSync FSM - GetResponse Data", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj})
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000709 if msgObj.Result == me.Success {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000710 oo.mutexLastTxParamStruct.RLock()
mpagenko01499812021-03-25 10:37:12 +0000711 entityID := oo.lastTxParamStruct.pLastTxMeInstance.GetEntityID()
712 if msgObj.EntityClass == oo.lastTxParamStruct.pLastTxMeInstance.GetClassID() && msgObj.EntityInstance == entityID {
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000713 meAttributes := msgObj.Attributes
mpagenko01499812021-03-25 10:37:12 +0000714 meInstance := oo.lastTxParamStruct.pLastTxMeInstance.GetName()
dbainbri4d3a0dc2020-12-02 00:33:42 +0000715 logger.Debugf(ctx, "MibSync FSM - GetResponse Data for %s", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj}, meInstance)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000716 switch meInstance {
717 case "OnuG":
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000718 oo.mutexLastTxParamStruct.RUnlock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000719 oo.MutexPersOnuConfig.Lock()
720 oo.SOnuPersistentData.PersVendorID = cmn.TrimStringFromMeOctet(meAttributes["VendorId"])
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000721 snBytes, _ := me.InterfaceToOctets(meAttributes["SerialNumber"])
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000722 if cmn.OnugSerialNumberLen == len(snBytes) {
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000723 snVendorPart := fmt.Sprintf("%s", snBytes[:4])
724 snNumberPart := hex.EncodeToString(snBytes[4:])
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000725 oo.SOnuPersistentData.PersSerialNumber = snVendorPart + snNumberPart
dbainbri4d3a0dc2020-12-02 00:33:42 +0000726 logger.Debugw(ctx, "MibSync FSM - GetResponse Data for Onu-G - VendorId/SerialNumber", log.Fields{"device-id": oo.deviceID,
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000727 "onuDeviceEntry.vendorID": oo.SOnuPersistentData.PersVendorID, "onuDeviceEntry.serialNumber": oo.SOnuPersistentData.PersSerialNumber})
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000728 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000729 logger.Infow(ctx, "MibSync FSM - SerialNumber has wrong length - fill serialNumber with zeros", log.Fields{"device-id": oo.deviceID, "length": len(snBytes)})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000730 oo.SOnuPersistentData.PersSerialNumber = cEmptySerialNumberString
Himani Chawla4d908332020-08-31 12:30:20 +0530731 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000732 oo.MutexPersOnuConfig.Unlock()
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000733 // trigger retrieval of EquipmentId
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000734 _ = oo.PMibUploadFsm.PFsm.Event(UlEvGetEquipmentID)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000735 return nil
736 case "Onu2G":
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000737 oo.mutexLastTxParamStruct.RUnlock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000738 oo.MutexPersOnuConfig.Lock()
739 oo.SOnuPersistentData.PersEquipmentID = cmn.TrimStringFromMeOctet(meAttributes["EquipmentId"])
dbainbri4d3a0dc2020-12-02 00:33:42 +0000740 logger.Debugw(ctx, "MibSync FSM - GetResponse Data for Onu2-G - EquipmentId", log.Fields{"device-id": oo.deviceID,
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000741 "onuDeviceEntry.equipmentID": oo.SOnuPersistentData.PersEquipmentID})
742 oo.MutexPersOnuConfig.Unlock()
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000743 // trigger retrieval of 1st SW-image info
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000744 _ = oo.PMibUploadFsm.PFsm.Event(UlEvGetFirstSwVersion)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000745 return nil
746 case "SoftwareImage":
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000747 oo.mutexLastTxParamStruct.RUnlock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000748 if entityID > cmn.SecondSwImageMeID {
mpagenko15ff4a52021-03-02 10:09:20 +0000749 logger.Errorw(ctx, "mibSync FSM - Failed to GetResponse Data for SoftwareImage with expected EntityId",
750 log.Fields{"device-id": oo.deviceID, "entity-ID": entityID})
751 return fmt.Errorf("mibSync FSM - SwResponse Data with unexpected EntityId: %s %x",
752 oo.deviceID, entityID)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000753 }
mpagenko15ff4a52021-03-02 10:09:20 +0000754 // need to use function for go lint complexity
Holger Hildebrandt94688c72021-12-17 12:13:02 +0000755 oo.HandleSwImageIndications(ctx, entityID, meAttributes)
mpagenko15ff4a52021-03-02 10:09:20 +0000756 return nil
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000757 case "IpHostConfigData":
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000758 oo.mutexLastTxParamStruct.RUnlock()
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000759 macBytes, _ := me.InterfaceToOctets(meAttributes["MacAddress"])
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000760 oo.MutexPersOnuConfig.Lock()
761 if cmn.OmciMacAddressLen == len(macBytes) {
762 oo.SOnuPersistentData.PersMacAddress = hex.EncodeToString(macBytes[:])
dbainbri4d3a0dc2020-12-02 00:33:42 +0000763 logger.Debugw(ctx, "MibSync FSM - GetResponse Data for IpHostConfigData - MacAddress", log.Fields{"device-id": oo.deviceID,
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000764 "macAddress": oo.SOnuPersistentData.PersMacAddress})
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000765 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000766 logger.Infow(ctx, "MibSync FSM - MacAddress wrong length - fill macAddress with zeros", log.Fields{"device-id": oo.deviceID, "length": len(macBytes)})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000767 oo.SOnuPersistentData.PersMacAddress = cEmptyMacAddrString
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000768 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000769 oo.MutexPersOnuConfig.Unlock()
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000770 // trigger retrieval of mib template
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000771 _ = oo.PMibUploadFsm.PFsm.Event(UlEvGetMibTemplate)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000772 return nil
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000773 case "OnuData":
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000774 oo.mutexLastTxParamStruct.RUnlock()
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000775 oo.checkMdsValue(ctx, meAttributes["MibDataSync"].(uint8))
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000776 return nil
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000777 default:
778 oo.mutexLastTxParamStruct.RUnlock()
779 logger.Warnw(ctx, "Unsupported ME name received!",
780 log.Fields{"ME name": meInstance, "device-id": oo.deviceID})
781
Himani Chawla4d908332020-08-31 12:30:20 +0530782 }
Matteo Scandolo20ca10c2021-01-21 14:35:45 -0800783 } else {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000784 oo.mutexLastTxParamStruct.RUnlock()
785 logger.Warnf(ctx, "MibSync FSM - Received GetResponse Data for %s with wrong classID or entityID ",
786 log.Fields{"device-id": oo.deviceID, "data-fields": msgObj}, msgObj.EntityClass)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000787 }
Himani Chawla4d908332020-08-31 12:30:20 +0530788 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000789 if err = oo.handleOmciGetResponseErrors(ctx, msgObj); err == nil {
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000790 return nil
791 }
Himani Chawla4d908332020-08-31 12:30:20 +0530792 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000793 logger.Info(ctx, "MibSync Msg", log.Fields{"Stopped handling of MibSyncChan for device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000794 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000795 return err
Himani Chawla4d908332020-08-31 12:30:20 +0530796}
797
Holger Hildebrandt94688c72021-12-17 12:13:02 +0000798//HandleSwImageIndications updates onuSwImageIndications with the ONU data just received
799func (oo *OnuDeviceEntry) HandleSwImageIndications(ctx context.Context, entityID uint16, meAttributes me.AttributeValueMap) {
mpagenko15ff4a52021-03-02 10:09:20 +0000800 imageIsCommitted := meAttributes["IsCommitted"].(uint8)
801 imageIsActive := meAttributes["IsActive"].(uint8)
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000802 imageVersion := cmn.TrimStringFromMeOctet(meAttributes["Version"])
803 oo.MutexPersOnuConfig.RLock()
mpagenko15ff4a52021-03-02 10:09:20 +0000804 logger.Infow(ctx, "MibSync FSM - GetResponse Data for SoftwareImage",
805 log.Fields{"device-id": oo.deviceID, "entityID": entityID,
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000806 "version": imageVersion, "isActive": imageIsActive, "isCommitted": imageIsCommitted, "SNR": oo.SOnuPersistentData.PersSerialNumber})
807 oo.MutexPersOnuConfig.RUnlock()
808 if cmn.FirstSwImageMeID == entityID {
mpagenko15ff4a52021-03-02 10:09:20 +0000809 //always accept the state of the first image (2nd image info should not yet be available)
Holger Hildebrandt05011352021-06-15 09:40:24 +0000810 oo.mutexOnuSwImageIndications.Lock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000811 if imageIsActive == cmn.SwIsActive {
812 oo.onuSwImageIndications.ActiveEntityEntry.EntityID = entityID
813 oo.onuSwImageIndications.ActiveEntityEntry.Valid = true
814 oo.onuSwImageIndications.ActiveEntityEntry.Version = imageVersion
815 oo.onuSwImageIndications.ActiveEntityEntry.IsCommitted = imageIsCommitted
mpagenko59498c12021-03-18 14:15:15 +0000816 //as the SW version indication may stem from some ONU Down/up event
817 //the complementary image state is to be invalidated
818 // (state of the second image is always expected afterwards or just invalid)
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000819 oo.onuSwImageIndications.InActiveEntityEntry.Valid = false
mpagenko15ff4a52021-03-02 10:09:20 +0000820 } else {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000821 oo.onuSwImageIndications.InActiveEntityEntry.EntityID = entityID
822 oo.onuSwImageIndications.InActiveEntityEntry.Valid = true
823 oo.onuSwImageIndications.InActiveEntityEntry.Version = imageVersion
824 oo.onuSwImageIndications.InActiveEntityEntry.IsCommitted = imageIsCommitted
mpagenko59498c12021-03-18 14:15:15 +0000825 //as the SW version indication may stem form some ONU Down/up event
826 //the complementary image state is to be invalidated
827 // (state of the second image is always expected afterwards or just invalid)
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000828 oo.onuSwImageIndications.ActiveEntityEntry.Valid = false
mpagenko15ff4a52021-03-02 10:09:20 +0000829 }
Holger Hildebrandt05011352021-06-15 09:40:24 +0000830 oo.mutexOnuSwImageIndications.Unlock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000831 _ = oo.PMibUploadFsm.PFsm.Event(UlEvGetSecondSwVersion)
mpagenko15ff4a52021-03-02 10:09:20 +0000832 return
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000833 } else if cmn.SecondSwImageMeID == entityID {
mpagenko15ff4a52021-03-02 10:09:20 +0000834 //2nd image info might conflict with first image info, in which case we priorize first image info!
Holger Hildebrandt05011352021-06-15 09:40:24 +0000835 oo.mutexOnuSwImageIndications.Lock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000836 if imageIsActive == cmn.SwIsActive { //2nd image reported to be active
837 if oo.onuSwImageIndications.ActiveEntityEntry.Valid {
mpagenko15ff4a52021-03-02 10:09:20 +0000838 //conflict exists - state of first image is left active
839 logger.Warnw(ctx, "mibSync FSM - both ONU images are reported as active - assuming 2nd to be inactive",
840 log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000841 oo.onuSwImageIndications.InActiveEntityEntry.EntityID = entityID
842 oo.onuSwImageIndications.InActiveEntityEntry.Valid = true ////to indicate that at least something has been reported
843 oo.onuSwImageIndications.InActiveEntityEntry.Version = imageVersion
844 oo.onuSwImageIndications.InActiveEntityEntry.IsCommitted = imageIsCommitted
mpagenko15ff4a52021-03-02 10:09:20 +0000845 } else { //first image inactive, this one active
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000846 oo.onuSwImageIndications.ActiveEntityEntry.EntityID = entityID
847 oo.onuSwImageIndications.ActiveEntityEntry.Valid = true
848 oo.onuSwImageIndications.ActiveEntityEntry.Version = imageVersion
849 oo.onuSwImageIndications.ActiveEntityEntry.IsCommitted = imageIsCommitted
mpagenko15ff4a52021-03-02 10:09:20 +0000850 }
851 } else { //2nd image reported to be inactive
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000852 if oo.onuSwImageIndications.InActiveEntityEntry.Valid {
mpagenko15ff4a52021-03-02 10:09:20 +0000853 //conflict exists - both images inactive - regard it as ONU failure and assume first image to be active
854 logger.Warnw(ctx, "mibSync FSM - both ONU images are reported as inactive, defining first to be active",
855 log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000856 oo.onuSwImageIndications.ActiveEntityEntry.EntityID = cmn.FirstSwImageMeID
857 oo.onuSwImageIndications.ActiveEntityEntry.Valid = true //to indicate that at least something has been reported
mpagenko15ff4a52021-03-02 10:09:20 +0000858 //copy active commit/version from the previously stored inactive position
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000859 oo.onuSwImageIndications.ActiveEntityEntry.Version = oo.onuSwImageIndications.InActiveEntityEntry.Version
860 oo.onuSwImageIndications.ActiveEntityEntry.IsCommitted = oo.onuSwImageIndications.InActiveEntityEntry.IsCommitted
mpagenko15ff4a52021-03-02 10:09:20 +0000861 }
862 //in any case we indicate (and possibly overwrite) the second image indications as inactive
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000863 oo.onuSwImageIndications.InActiveEntityEntry.EntityID = entityID
864 oo.onuSwImageIndications.InActiveEntityEntry.Valid = true
865 oo.onuSwImageIndications.InActiveEntityEntry.Version = imageVersion
866 oo.onuSwImageIndications.InActiveEntityEntry.IsCommitted = imageIsCommitted
mpagenko15ff4a52021-03-02 10:09:20 +0000867 }
Holger Hildebrandt05011352021-06-15 09:40:24 +0000868 oo.mutexOnuSwImageIndications.Unlock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000869 _ = oo.PMibUploadFsm.PFsm.Event(UlEvGetMacAddress)
mpagenko15ff4a52021-03-02 10:09:20 +0000870 return
871 }
872}
873
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000874func (oo *OnuDeviceEntry) handleOmciMessage(ctx context.Context, msg cmn.OmciMessage) {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000875 logger.Debugw(ctx, "MibSync Msg", log.Fields{"OmciMessage received for device-id": oo.deviceID,
Andrea Campanella6515c582020-10-05 11:25:00 +0200876 "msgType": msg.OmciMsg.MessageType, "msg": msg})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000877 //further analysis could be done here based on msg.OmciMsg.Payload, e.g. verification of error code ...
878 switch msg.OmciMsg.MessageType {
879 case omci.MibResetResponseType:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000880 oo.handleOmciMibResetResponseMessage(ctx, msg)
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000881
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000882 case omci.MibUploadResponseType:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000883 oo.handleOmciMibUploadResponseMessage(ctx, msg)
Himani Chawla4d908332020-08-31 12:30:20 +0530884
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000885 case omci.MibUploadNextResponseType:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000886 oo.handleOmciMibUploadNextResponseMessage(ctx, msg)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000887
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000888 case omci.GetResponseType:
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000889 //TODO: error handling
dbainbri4d3a0dc2020-12-02 00:33:42 +0000890 _ = oo.handleOmciGetResponseMessage(ctx, msg)
Himani Chawla4d908332020-08-31 12:30:20 +0530891
Andrea Campanella6515c582020-10-05 11:25:00 +0200892 default:
dbainbri4d3a0dc2020-12-02 00:33:42 +0000893 logger.Warnw(ctx, "Unknown Message Type", log.Fields{"msgType": msg.OmciMsg.MessageType})
Andrea Campanella6515c582020-10-05 11:25:00 +0200894
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000895 }
896}
897
dbainbri4d3a0dc2020-12-02 00:33:42 +0000898func (oo *OnuDeviceEntry) handleOmciGetResponseErrors(ctx context.Context, msgObj *omci.GetResponse) error {
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000899 var err error = nil
dbainbri4d3a0dc2020-12-02 00:33:42 +0000900 logger.Debugf(ctx, "MibSync FSM - erroneous result in GetResponse Data: %s", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj}, msgObj.Result)
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000901 // Up to now the following erroneous results have been seen for different ONU-types to indicate an unsupported ME
902 if msgObj.Result == me.UnknownInstance || msgObj.Result == me.UnknownEntity || msgObj.Result == me.ProcessingError || msgObj.Result == me.NotSupported {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000903 oo.mutexLastTxParamStruct.RLock()
904 if oo.lastTxParamStruct.pLastTxMeInstance != nil {
905 entityID := oo.lastTxParamStruct.pLastTxMeInstance.GetEntityID()
906 if msgObj.EntityClass == oo.lastTxParamStruct.pLastTxMeInstance.GetClassID() && msgObj.EntityInstance == entityID {
907 meInstance := oo.lastTxParamStruct.pLastTxMeInstance.GetName()
908 switch meInstance {
909 case "IpHostConfigData":
910 oo.mutexLastTxParamStruct.RUnlock()
911 logger.Debugw(ctx, "MibSync FSM - erroneous result for IpHostConfigData received - ONU doesn't support ME - fill macAddress with zeros",
912 log.Fields{"device-id": oo.deviceID, "data-fields": msgObj})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000913 oo.MutexPersOnuConfig.Lock()
914 oo.SOnuPersistentData.PersMacAddress = cEmptyMacAddrString
915 oo.MutexPersOnuConfig.Unlock()
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000916 // trigger retrieval of mib template
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000917 _ = oo.PMibUploadFsm.PFsm.Event(UlEvGetMibTemplate)
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000918 return nil
919 default:
920 oo.mutexLastTxParamStruct.RUnlock()
921 logger.Warnf(ctx, "MibSync FSM - erroneous result for %s received - no exceptional treatment defined", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj}, meInstance)
922 err = fmt.Errorf("erroneous result for %s received - no exceptional treatment defined: %s", meInstance, oo.deviceID)
923 }
924 } else {
925 oo.mutexLastTxParamStruct.RUnlock()
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000926 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000927 } else {
928 oo.mutexLastTxParamStruct.RUnlock()
929 logger.Warnw(ctx, "Pointer to last Tx MeInstance is nil!", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000930 }
931 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000932 logger.Errorf(ctx, "MibSync FSM - erroneous result in GetResponse Data: %s", log.Fields{"device-id": oo.deviceID, "data-fields": msgObj}, msgObj.Result)
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000933 err = fmt.Errorf("erroneous result in GetResponse Data: %s - %s", msgObj.Result, oo.deviceID)
934 }
935 return err
936}
937
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000938// IsNewOnu - TODO: add comment
939func (oo *OnuDeviceEntry) IsNewOnu() bool {
940 oo.MutexPersOnuConfig.RLock()
941 defer oo.MutexPersOnuConfig.RUnlock()
942 return oo.SOnuPersistentData.PersMibLastDbSync == 0
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +0000943}
944
Himani Chawla6d2ae152020-09-02 13:11:20 +0530945func isSupportedClassID(meClassID me.ClassID) bool {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000946 for _, v := range supportedClassIds {
Himani Chawla4d908332020-08-31 12:30:20 +0530947 if v == meClassID {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000948 return true
949 }
950 }
951 return false
952}
953
dbainbri4d3a0dc2020-12-02 00:33:42 +0000954func (oo *OnuDeviceEntry) mibDbVolatileDict(ctx context.Context) error {
955 logger.Debug(ctx, "MibVolatileDict- running from default Entry code")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000956 return errors.New("not_implemented")
957}
958
Himani Chawla6d2ae152020-09-02 13:11:20 +0530959// createAndPersistMibTemplate method creates a mib template for the device id when operator enables the ONU device for the first time.
divyadesaibbed37c2020-08-28 13:35:20 +0530960// We are creating a placeholder for "SerialNumber" for ME Class ID 6 and 256 and "MacAddress" for ME Class ID 134 in the template
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000961// and then storing the template into etcd "service/voltha/omci_mibs/go_templates/verdor_id/equipment_id/software_version" path.
dbainbri4d3a0dc2020-12-02 00:33:42 +0000962func (oo *OnuDeviceEntry) createAndPersistMibTemplate(ctx context.Context) error {
963 logger.Debugw(ctx, "MibSync - MibTemplate - path name", log.Fields{"path": oo.mibTemplatePath,
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000964 "device-id": oo.deviceID})
divyadesaibbed37c2020-08-28 13:35:20 +0530965
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000966 oo.pOpenOnuAc.LockMutexMibTemplateGenerated()
967 if mibTemplateIsGenerated, exist := oo.pOpenOnuAc.GetMibTemplatesGenerated(oo.mibTemplatePath); exist {
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000968 if mibTemplateIsGenerated {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000969 logger.Debugw(ctx, "MibSync - MibTemplate - another thread has already started to generate it - skip",
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000970 log.Fields{"path": oo.mibTemplatePath, "device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000971 oo.pOpenOnuAc.UnlockMutexMibTemplateGenerated()
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000972 return nil
973 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000974 logger.Debugw(ctx, "MibSync - MibTemplate - previous generation attempt seems to be failed - try again",
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000975 log.Fields{"path": oo.mibTemplatePath, "device-id": oo.deviceID})
976 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000977 logger.Debugw(ctx, "MibSync - MibTemplate - first ONU-instance of this kind - start generation",
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000978 log.Fields{"path": oo.mibTemplatePath, "device-id": oo.deviceID})
979 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000980 oo.pOpenOnuAc.SetMibTemplatesGenerated(oo.mibTemplatePath, true)
981 oo.pOpenOnuAc.UnlockMutexMibTemplateGenerated()
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000982
983 currentTime := time.Now()
divyadesaibbed37c2020-08-28 13:35:20 +0530984 templateMap := make(map[string]interface{})
Holger Hildebrandt61b24d02020-11-16 13:36:40 +0000985 templateMap["TemplateName"] = oo.mibTemplatePath
divyadesaibbed37c2020-08-28 13:35:20 +0530986 templateMap["TemplateCreated"] = currentTime.Format("2006-01-02 15:04:05.000000")
987
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000988 firstLevelMap := oo.pOnuDB.MeDb
divyadesaibbed37c2020-08-28 13:35:20 +0530989 for firstLevelKey, firstLevelValue := range firstLevelMap {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000990 logger.Debugw(ctx, "MibSync - MibTemplate - firstLevelKey", log.Fields{"firstLevelKey": firstLevelKey})
Himani Chawla26e555c2020-08-31 12:30:20 +0530991 classID := strconv.Itoa(int(firstLevelKey))
divyadesaibbed37c2020-08-28 13:35:20 +0530992
993 secondLevelMap := make(map[string]interface{})
994 for secondLevelKey, secondLevelValue := range firstLevelValue {
995 thirdLevelMap := make(map[string]interface{})
Himani Chawla26e555c2020-08-31 12:30:20 +0530996 entityID := strconv.Itoa(int(secondLevelKey))
divyadesaibbed37c2020-08-28 13:35:20 +0530997 thirdLevelMap["Attributes"] = secondLevelValue
Himani Chawla26e555c2020-08-31 12:30:20 +0530998 thirdLevelMap["InstanceId"] = entityID
999 secondLevelMap[entityID] = thirdLevelMap
1000 if classID == "6" || classID == "256" {
divyadesaibbed37c2020-08-28 13:35:20 +05301001 forthLevelMap := map[string]interface{}(thirdLevelMap["Attributes"].(me.AttributeValueMap))
1002 delete(forthLevelMap, "SerialNumber")
1003 forthLevelMap["SerialNumber"] = "%SERIAL_NUMBER%"
1004
1005 }
Himani Chawla26e555c2020-08-31 12:30:20 +05301006 if classID == "134" {
divyadesaibbed37c2020-08-28 13:35:20 +05301007 forthLevelMap := map[string]interface{}(thirdLevelMap["Attributes"].(me.AttributeValueMap))
1008 delete(forthLevelMap, "MacAddress")
1009 forthLevelMap["MacAddress"] = "%MAC_ADDRESS%"
1010 }
1011 }
Himani Chawla26e555c2020-08-31 12:30:20 +05301012 secondLevelMap["ClassId"] = classID
1013 templateMap[classID] = secondLevelMap
divyadesaibbed37c2020-08-28 13:35:20 +05301014 }
Holger Hildebrandtf3c7a182021-11-17 13:42:08 +00001015 unknownMeMap := oo.pOnuDB.UnknownMeDb
1016 for unknownMeMapKey := range unknownMeMap {
1017 templateMap[string(unknownMeMapKey)] = unknownMeMap[unknownMeMapKey]
1018 }
divyadesaibbed37c2020-08-28 13:35:20 +05301019 mibTemplate, err := json.Marshal(&templateMap)
1020 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001021 logger.Errorw(ctx, "MibSync - MibTemplate - Failed to marshal mibTemplate", log.Fields{"error": err, "device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001022 oo.pOpenOnuAc.LockMutexMibTemplateGenerated()
1023 oo.pOpenOnuAc.SetMibTemplatesGenerated(oo.mibTemplatePath, false)
1024 oo.pOpenOnuAc.UnlockMutexMibTemplateGenerated()
divyadesaibbed37c2020-08-28 13:35:20 +05301025 return err
1026 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001027 err = oo.mibTemplateKVStore.Put(log.WithSpanFromContext(context.TODO(), ctx), oo.mibTemplatePath, string(mibTemplate))
divyadesaibbed37c2020-08-28 13:35:20 +05301028 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001029 logger.Errorw(ctx, "MibSync - MibTemplate - Failed to store template in etcd", log.Fields{"error": err, "device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001030 oo.pOpenOnuAc.LockMutexMibTemplateGenerated()
1031 oo.pOpenOnuAc.SetMibTemplatesGenerated(oo.mibTemplatePath, false)
1032 oo.pOpenOnuAc.UnlockMutexMibTemplateGenerated()
divyadesaibbed37c2020-08-28 13:35:20 +05301033 return err
1034 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001035 logger.Debugw(ctx, "MibSync - MibTemplate - Stored the template to etcd", log.Fields{"device-id": oo.deviceID})
divyadesaibbed37c2020-08-28 13:35:20 +05301036 return nil
1037}
1038
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +00001039func (oo *OnuDeviceEntry) requestMdsValue(ctx context.Context) {
1040 logger.Debugw(ctx, "Request MDS value", log.Fields{"device-id": oo.deviceID})
1041 requestedAttributes := me.AttributeValueMap{"MibDataSync": ""}
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001042 meInstance, err := oo.PDevOmciCC.SendGetMe(log.WithSpanFromContext(context.TODO(), ctx),
1043 me.OnuDataClassID, cmn.OnuDataMeID, requestedAttributes, oo.baseDeviceHandler.GetOmciTimeout(), true, oo.PMibUploadFsm.CommChan)
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +00001044 //accept also nil as (error) return value for writing to LastTx
1045 // - this avoids misinterpretation of new received OMCI messages
ozgecanetsiab36ed572021-04-01 10:38:48 +03001046 if err != nil {
1047 logger.Errorw(ctx, "ONUData get failed, aborting MibSync FSM!", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001048 pMibUlFsm := oo.PMibUploadFsm
ozgecanetsiab36ed572021-04-01 10:38:48 +03001049 if pMibUlFsm != nil {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001050 go func(a_pAFsm *cmn.AdapterFsm) {
1051 _ = oo.PMibUploadFsm.PFsm.Event(UlEvStop)
ozgecanetsiab36ed572021-04-01 10:38:48 +03001052 }(pMibUlFsm)
1053 }
1054 return
1055 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001056 oo.mutexLastTxParamStruct.Lock()
mpagenko01499812021-03-25 10:37:12 +00001057 oo.lastTxParamStruct.lastTxMessageType = omci.GetRequestType
1058 oo.lastTxParamStruct.pLastTxMeInstance = meInstance
1059 oo.lastTxParamStruct.repeatCount = 0
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001060 oo.mutexLastTxParamStruct.Unlock()
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +00001061}
1062
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001063func (oo *OnuDeviceEntry) checkMdsValue(ctx context.Context, mibDataSyncOnu uint8) {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001064 oo.MutexPersOnuConfig.RLock()
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001065 logger.Debugw(ctx, "MibSync FSM - GetResponse Data for Onu-Data - MibDataSync", log.Fields{"device-id": oo.deviceID,
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001066 "mibDataSyncOnu": mibDataSyncOnu, "PersMibDataSyncAdpt": oo.SOnuPersistentData.PersMibDataSyncAdpt})
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001067
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001068 mdsValuesAreEqual := oo.SOnuPersistentData.PersMibDataSyncAdpt == mibDataSyncOnu
1069 oo.MutexPersOnuConfig.RUnlock()
1070 if oo.PMibUploadFsm.PFsm.Is(UlStAuditing) {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001071 if mdsValuesAreEqual {
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001072 logger.Debugw(ctx, "MibSync FSM - mib audit - MDS check ok", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001073 _ = oo.PMibUploadFsm.PFsm.Event(UlEvSuccess)
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001074 } else {
1075 logger.Warnw(ctx, "MibSync FSM - mib audit - MDS check failed for the first time!", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001076 _ = oo.PMibUploadFsm.PFsm.Event(UlEvMismatch)
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001077 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001078 } else if oo.PMibUploadFsm.PFsm.Is(UlStReAuditing) {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001079 if mdsValuesAreEqual {
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001080 logger.Debugw(ctx, "MibSync FSM - mib reaudit - MDS check ok", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001081 _ = oo.PMibUploadFsm.PFsm.Event(UlEvSuccess)
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001082 } else {
1083 logger.Errorw(ctx, "MibSync FSM - mib audit - MDS check failed for the second time!", log.Fields{"device-id": oo.deviceID})
1084 //TODO: send new event notification "MDS counter mismatch" to the core
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001085 _ = oo.PMibUploadFsm.PFsm.Event(UlEvMismatch)
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001086 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001087 } else if oo.PMibUploadFsm.PFsm.Is(UlStExaminingMds) {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001088 if mdsValuesAreEqual && mibDataSyncOnu != 0 {
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001089 logger.Debugw(ctx, "MibSync FSM - MDS examination ok", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001090 _ = oo.PMibUploadFsm.PFsm.Event(UlEvSuccess)
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001091 } else {
1092 logger.Debugw(ctx, "MibSync FSM - MDS examination failed - new provisioning", log.Fields{"device-id": oo.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001093 _ = oo.PMibUploadFsm.PFsm.Event(UlEvMismatch)
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001094 }
1095 } else {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001096 logger.Warnw(ctx, "wrong state for MDS evaluation!", log.Fields{"state": oo.PMibUploadFsm.PFsm.Current(), "device-id": oo.deviceID})
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001097 }
1098}
mpagenko15ff4a52021-03-02 10:09:20 +00001099
1100//GetActiveImageMeID returns the Omci MeId of the active ONU image together with error code for validity
1101func (oo *OnuDeviceEntry) GetActiveImageMeID(ctx context.Context) (uint16, error) {
Holger Hildebrandt05011352021-06-15 09:40:24 +00001102 oo.mutexOnuSwImageIndications.RLock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001103 if oo.onuSwImageIndications.ActiveEntityEntry.Valid {
1104 value := oo.onuSwImageIndications.ActiveEntityEntry.EntityID
Holger Hildebrandt05011352021-06-15 09:40:24 +00001105 oo.mutexOnuSwImageIndications.RUnlock()
1106 return value, nil
mpagenko15ff4a52021-03-02 10:09:20 +00001107 }
Holger Hildebrandt05011352021-06-15 09:40:24 +00001108 oo.mutexOnuSwImageIndications.RUnlock()
mpagenko15ff4a52021-03-02 10:09:20 +00001109 return 0xFFFF, fmt.Errorf("no valid active image found: %s", oo.deviceID)
1110}
1111
1112//GetInactiveImageMeID returns the Omci MeId of the inactive ONU image together with error code for validity
1113func (oo *OnuDeviceEntry) GetInactiveImageMeID(ctx context.Context) (uint16, error) {
Holger Hildebrandt05011352021-06-15 09:40:24 +00001114 oo.mutexOnuSwImageIndications.RLock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001115 if oo.onuSwImageIndications.InActiveEntityEntry.Valid {
1116 value := oo.onuSwImageIndications.InActiveEntityEntry.EntityID
Holger Hildebrandt05011352021-06-15 09:40:24 +00001117 oo.mutexOnuSwImageIndications.RUnlock()
1118 return value, nil
mpagenko15ff4a52021-03-02 10:09:20 +00001119 }
Holger Hildebrandt05011352021-06-15 09:40:24 +00001120 oo.mutexOnuSwImageIndications.RUnlock()
mpagenko15ff4a52021-03-02 10:09:20 +00001121 return 0xFFFF, fmt.Errorf("no valid inactive image found: %s", oo.deviceID)
1122}
1123
1124//IsImageToBeCommitted returns true if the active image is still uncommitted
1125func (oo *OnuDeviceEntry) IsImageToBeCommitted(ctx context.Context, aImageID uint16) bool {
Holger Hildebrandt05011352021-06-15 09:40:24 +00001126 oo.mutexOnuSwImageIndications.RLock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001127 if oo.onuSwImageIndications.ActiveEntityEntry.Valid {
1128 if oo.onuSwImageIndications.ActiveEntityEntry.EntityID == aImageID {
1129 if oo.onuSwImageIndications.ActiveEntityEntry.IsCommitted == cmn.SwIsUncommitted {
Holger Hildebrandt05011352021-06-15 09:40:24 +00001130 oo.mutexOnuSwImageIndications.RUnlock()
mpagenko15ff4a52021-03-02 10:09:20 +00001131 return true
1132 }
1133 }
1134 }
Holger Hildebrandt05011352021-06-15 09:40:24 +00001135 oo.mutexOnuSwImageIndications.RUnlock()
mpagenko15ff4a52021-03-02 10:09:20 +00001136 return false //all other case are treated as 'nothing to commit
1137}
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001138func (oo *OnuDeviceEntry) getMibFromTemplate(ctx context.Context) bool {
1139
1140 oo.mibTemplatePath = oo.buildMibTemplatePath()
Holger Hildebrandtbdc5f002021-04-19 14:46:21 +00001141 logger.Debugw(ctx, "MibSync FSM - get Mib from template", log.Fields{"path": fmt.Sprintf("%s/%s", cBasePathMibTemplateKvStore, oo.mibTemplatePath),
1142 "device-id": oo.deviceID})
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001143
1144 restoredFromMibTemplate := false
1145 Value, err := oo.mibTemplateKVStore.Get(log.WithSpanFromContext(context.TODO(), ctx), oo.mibTemplatePath)
1146 if err == nil {
1147 if Value != nil {
1148 logger.Debugf(ctx, "MibSync FSM - Mib template read: Key: %s, Value: %s %s", Value.Key, Value.Value)
1149
1150 // swap out tokens with specific data
1151 mibTmpString, _ := kvstore.ToString(Value.Value)
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001152 oo.MutexPersOnuConfig.RLock()
1153 mibTmpString2 := strings.Replace(mibTmpString, "%SERIAL_NUMBER%", oo.SOnuPersistentData.PersSerialNumber, -1)
1154 mibTmpString = strings.Replace(mibTmpString2, "%MAC_ADDRESS%", oo.SOnuPersistentData.PersMacAddress, -1)
1155 oo.MutexPersOnuConfig.RUnlock()
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001156 mibTmpBytes := []byte(mibTmpString)
1157 logger.Debugf(ctx, "MibSync FSM - Mib template tokens swapped out: %s", mibTmpBytes)
1158
1159 var firstLevelMap map[string]interface{}
1160 if err = json.Unmarshal(mibTmpBytes, &firstLevelMap); err != nil {
1161 logger.Errorw(ctx, "MibSync FSM - Failed to unmarshal template", log.Fields{"error": err, "device-id": oo.deviceID})
1162 } else {
1163 for firstLevelKey, firstLevelValue := range firstLevelMap {
1164 //logger.Debugw(ctx, "MibSync FSM - firstLevelKey", log.Fields{"firstLevelKey": firstLevelKey})
1165 if uint16ValidNumber, err := strconv.ParseUint(firstLevelKey, 10, 16); err == nil {
1166 meClassID := me.ClassID(uint16ValidNumber)
1167 //logger.Debugw(ctx, "MibSync FSM - firstLevelKey is a number in uint16-range", log.Fields{"uint16ValidNumber": uint16ValidNumber})
1168 if isSupportedClassID(meClassID) {
1169 //logger.Debugw(ctx, "MibSync FSM - firstLevelKey is a supported classID", log.Fields{"meClassID": meClassID})
1170 secondLevelMap := firstLevelValue.(map[string]interface{})
1171 for secondLevelKey, secondLevelValue := range secondLevelMap {
1172 //logger.Debugw(ctx, "MibSync FSM - secondLevelKey", log.Fields{"secondLevelKey": secondLevelKey})
1173 if uint16ValidNumber, err := strconv.ParseUint(secondLevelKey, 10, 16); err == nil {
1174 meEntityID := uint16(uint16ValidNumber)
1175 //logger.Debugw(ctx, "MibSync FSM - secondLevelKey is a number and a valid EntityId", log.Fields{"meEntityID": meEntityID})
1176 thirdLevelMap := secondLevelValue.(map[string]interface{})
1177 for thirdLevelKey, thirdLevelValue := range thirdLevelMap {
1178 if thirdLevelKey == "Attributes" {
1179 //logger.Debugw(ctx, "MibSync FSM - thirdLevelKey refers to attributes", log.Fields{"thirdLevelKey": thirdLevelKey})
1180 attributesMap := thirdLevelValue.(map[string]interface{})
1181 //logger.Debugw(ctx, "MibSync FSM - attributesMap", log.Fields{"attributesMap": attributesMap})
1182 oo.pOnuDB.PutMe(ctx, meClassID, meEntityID, attributesMap)
1183 restoredFromMibTemplate = true
1184 }
1185 }
1186 }
1187 }
1188 }
1189 }
1190 }
1191 }
1192 } else {
1193 logger.Debugw(ctx, "No MIB template found", log.Fields{"path": oo.mibTemplatePath, "device-id": oo.deviceID})
1194 }
1195 } else {
1196 logger.Errorf(ctx, "Get from kvstore operation failed for path",
1197 log.Fields{"path": oo.mibTemplatePath, "device-id": oo.deviceID})
1198 }
1199 return restoredFromMibTemplate
1200}
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00001201
1202//CancelProcessing terminates potentially running reconciling processes and stops the FSM
1203func (oo *OnuDeviceEntry) CancelProcessing(ctx context.Context) {
1204
mpagenko101ac942021-11-16 15:01:29 +00001205 if oo.isReconcilingFlows() {
Holger Hildebrandtf2fcdd42021-12-15 11:42:19 +00001206 oo.SendChReconcilingFlowsFinished(ctx, false)
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00001207 }
1208 //the MibSync FSM might be active all the ONU-active time,
1209 // hence it must be stopped unconditionally
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001210 pMibUlFsm := oo.PMibUploadFsm.PFsm
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00001211 if pMibUlFsm != nil {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001212 _ = pMibUlFsm.Event(UlEvStop)
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00001213 }
1214}