blob: 73a3d485cb1a27e81e4dea4aee476cc4f219dc52 [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
17//Package adaptercoreonu provides the utility for onu devices, flows and statistics
18package adaptercoreonu
19
20import (
21 "context"
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000022 "errors"
23 "fmt"
Holger Hildebrandt24d51952020-05-04 14:03:42 +000024 "strconv"
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000025 "sync"
26 "time"
27
28 "github.com/gogo/protobuf/proto"
29 "github.com/golang/protobuf/ptypes"
30 "github.com/looplab/fsm"
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +000031 me "github.com/opencord/omci-lib-go/generated"
dbainbri4d3a0dc2020-12-02 00:33:42 +000032 "github.com/opencord/voltha-lib-go/v4/pkg/adapters/adapterif"
33 "github.com/opencord/voltha-lib-go/v4/pkg/db"
Himani Chawlac07fda02020-12-09 16:21:21 +053034 "github.com/opencord/voltha-lib-go/v4/pkg/events/eventif"
dbainbri4d3a0dc2020-12-02 00:33:42 +000035 flow "github.com/opencord/voltha-lib-go/v4/pkg/flows"
36 "github.com/opencord/voltha-lib-go/v4/pkg/log"
37 vc "github.com/opencord/voltha-protos/v4/go/common"
kesavandfdf77632021-01-26 23:40:33 -050038 "github.com/opencord/voltha-protos/v4/go/extension"
dbainbri4d3a0dc2020-12-02 00:33:42 +000039 ic "github.com/opencord/voltha-protos/v4/go/inter_container"
40 "github.com/opencord/voltha-protos/v4/go/openflow_13"
41 of "github.com/opencord/voltha-protos/v4/go/openflow_13"
42 ofp "github.com/opencord/voltha-protos/v4/go/openflow_13"
43 oop "github.com/opencord/voltha-protos/v4/go/openolt"
44 "github.com/opencord/voltha-protos/v4/go/voltha"
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000045)
46
47/*
48// Constants for number of retries and for timeout
49const (
50 MaxRetry = 10
51 MaxTimeOutInMs = 500
52)
53*/
54
mpagenko1cc3cb42020-07-27 15:24:38 +000055const (
56 // events of Device FSM
57 devEvDeviceInit = "devEvDeviceInit"
58 devEvGrpcConnected = "devEvGrpcConnected"
59 devEvGrpcDisconnected = "devEvGrpcDisconnected"
60 devEvDeviceUpInd = "devEvDeviceUpInd"
61 devEvDeviceDownInd = "devEvDeviceDownInd"
62)
63const (
64 // states of Device FSM
65 devStNull = "devStNull"
66 devStDown = "devStDown"
67 devStInit = "devStInit"
68 devStConnected = "devStConnected"
69 devStUp = "devStUp"
70)
71
Holger Hildebrandt24d51952020-05-04 14:03:42 +000072//Event category and subcategory definitions - same as defiend for OLT in eventmgr.go - should be done more centrally
73const (
Himani Chawla4d908332020-08-31 12:30:20 +053074 pon = voltha.EventSubCategory_PON
75 //olt = voltha.EventSubCategory_OLT
76 //ont = voltha.EventSubCategory_ONT
77 //onu = voltha.EventSubCategory_ONU
78 //nni = voltha.EventSubCategory_NNI
79 //service = voltha.EventCategory_SERVICE
80 //security = voltha.EventCategory_SECURITY
81 equipment = voltha.EventCategory_EQUIPMENT
82 //processing = voltha.EventCategory_PROCESSING
83 //environment = voltha.EventCategory_ENVIRONMENT
84 //communication = voltha.EventCategory_COMMUNICATION
Holger Hildebrandt24d51952020-05-04 14:03:42 +000085)
86
87const (
88 cEventObjectType = "ONU"
89)
90const (
91 cOnuActivatedEvent = "ONU_ACTIVATED"
92)
93
Holger Hildebrandt10d98192021-01-27 15:29:31 +000094type usedOmciConfigFsms int
95
96const (
97 cUploadFsm usedOmciConfigFsms = iota
98 cDownloadFsm
99 cUniLockFsm
100 cUniUnLockFsm
101 cAniConfigFsm
102 cUniVlanConfigFsm
Girish Gowdrae0140f02021-02-02 16:55:09 -0800103 cL2PmFsm
mpagenko80622a52021-02-09 16:53:23 +0000104 cOnuUpgradeFsm
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000105)
106
mpagenkof1fc3862021-02-16 10:09:52 +0000107type omciIdleCheckStruct struct {
108 omciIdleCheckFunc func(*deviceHandler, context.Context, usedOmciConfigFsms, string) bool
109 omciIdleState string
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000110}
111
mpagenkof1fc3862021-02-16 10:09:52 +0000112var fsmOmciIdleStateFuncMap = map[usedOmciConfigFsms]omciIdleCheckStruct{
113 cUploadFsm: {(*deviceHandler).isFsmInOmciIdleStateDefault, cMibUlFsmIdleState},
114 cDownloadFsm: {(*deviceHandler).isFsmInOmciIdleStateDefault, cMibDlFsmIdleState},
115 cUniLockFsm: {(*deviceHandler).isFsmInOmciIdleStateDefault, cUniFsmIdleState},
116 cUniUnLockFsm: {(*deviceHandler).isFsmInOmciIdleStateDefault, cUniFsmIdleState},
117 cAniConfigFsm: {(*deviceHandler).isAniConfigFsmInOmciIdleState, cAniFsmIdleState},
118 cUniVlanConfigFsm: {(*deviceHandler).isUniVlanConfigFsmInOmciIdleState, cVlanFsmIdleState},
119 cL2PmFsm: {(*deviceHandler).isFsmInOmciIdleStateDefault, cL2PmFsmIdleState},
mpagenko80622a52021-02-09 16:53:23 +0000120 cOnuUpgradeFsm: {(*deviceHandler).isFsmInOmciIdleStateDefault, cOnuUpgradeFsmIdleState},
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000121}
122
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000123const (
124 // device reasons
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000125 drUnset = 0
126 drActivatingOnu = 1
127 drStartingOpenomci = 2
128 drDiscoveryMibsyncComplete = 3
129 drInitialMibDownloaded = 4
130 drTechProfileConfigDownloadSuccess = 5
131 drOmciFlowsPushed = 6
132 drOmciAdminLock = 7
133 drOnuReenabled = 8
134 drStoppingOpenomci = 9
135 drRebooting = 10
136 drOmciFlowsDeleted = 11
137 drTechProfileConfigDeleteSuccess = 12
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000138)
139
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000140var deviceReasonMap = map[uint8]string{
141 drUnset: "unset",
142 drActivatingOnu: "activating-onu",
143 drStartingOpenomci: "starting-openomci",
144 drDiscoveryMibsyncComplete: "discovery-mibsync-complete",
145 drInitialMibDownloaded: "initial-mib-downloaded",
146 drTechProfileConfigDownloadSuccess: "tech-profile-config-download-success",
147 drOmciFlowsPushed: "omci-flows-pushed",
148 drOmciAdminLock: "omci-admin-lock",
149 drOnuReenabled: "onu-reenabled",
150 drStoppingOpenomci: "stopping-openomci",
151 drRebooting: "rebooting",
152 drOmciFlowsDeleted: "omci-flows-deleted",
153 drTechProfileConfigDeleteSuccess: "tech-profile-config-delete-success",
154}
155
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000156const (
157 cNoReconciling = iota
158 cOnuConfigReconciling
159 cSkipOnuConfigReconciling
160)
161
Himani Chawla6d2ae152020-09-02 13:11:20 +0530162//deviceHandler will interact with the ONU ? device.
163type deviceHandler struct {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000164 deviceID string
165 DeviceType string
166 adminState string
167 device *voltha.Device
168 logicalDeviceID string
169 ProxyAddressID string
170 ProxyAddressType string
Himani Chawla4d908332020-08-31 12:30:20 +0530171 parentID string
Holger Hildebrandt24d51952020-05-04 14:03:42 +0000172 ponPortNumber uint32
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000173
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000174 coreProxy adapterif.CoreProxy
175 AdapterProxy adapterif.AdapterProxy
Himani Chawlac07fda02020-12-09 16:21:21 +0530176 EventProxy eventif.EventProxy
Holger Hildebrandtc54939a2020-06-17 08:14:27 +0000177
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800178 pmConfigs *voltha.PmConfigs
Girish Gowdrae09a6202021-01-12 18:10:59 -0800179
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000180 pOpenOnuAc *OpenONUAC
181 pDeviceStateFsm *fsm.FSM
Himani Chawla4d908332020-08-31 12:30:20 +0530182 //pPonPort *voltha.Port
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000183 deviceEntrySet chan bool //channel for DeviceEntry set event
184 pOnuOmciDevice *OnuDeviceEntry
185 pOnuTP *onuUniTechProf
186 pOnuMetricsMgr *onuMetricsManager
187 pAlarmMgr *onuAlarmManager
Girish Gowdra6afb56a2021-04-27 17:47:57 -0700188 pSelfTestHdlr *selfTestControlBlock
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000189 exitChannel chan int
190 lockDevice sync.RWMutex
191 pOnuIndication *oop.OnuIndication
192 deviceReason uint8
193 mutexDeviceReason sync.RWMutex
194 pLockStateFsm *lockStateFsm
195 pUnlockStateFsm *lockStateFsm
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000196
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000197 //flowMgr *OpenOltFlowMgr
198 //eventMgr *OpenOltEventMgr
199 //resourceMgr *rsrcMgr.OpenOltResourceMgr
200
201 //discOnus sync.Map
202 //onus sync.Map
203 //portStats *OpenOltStatisticsMgr
Holger Hildebrandtff05b682021-03-16 15:02:05 +0000204 collectorIsRunning bool
205 mutexCollectorFlag sync.RWMutex
206 stopCollector chan bool
207 alarmManagerIsRunning bool
208 mutextAlarmManagerFlag sync.RWMutex
209 stopAlarmManager chan bool
210 stopHeartbeatCheck chan bool
211 uniEntityMap map[uint32]*onuUniPort
212 mutexKvStoreContext sync.Mutex
213 lockVlanConfig sync.RWMutex
214 UniVlanConfigFsmMap map[uint8]*UniVlanConfigFsm
215 lockUpgradeFsm sync.RWMutex
216 pOnuUpradeFsm *OnuUpgradeFsm
217 reconciling uint8
218 mutexReconcilingFlag sync.RWMutex
219 chReconcilingFinished chan bool //channel to indicate that reconciling has been finished
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +0000220 reconcilingFlows bool
221 mutexReconcilingFlowsFlag sync.RWMutex
222 chReconcilingFlowsFinished chan bool //channel to indicate that reconciling of flows has been finished
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000223 mutexReadyForOmciConfig sync.RWMutex
224 readyForOmciConfig bool
Holger Hildebrandtff05b682021-03-16 15:02:05 +0000225 deletionInProgress bool
226 mutexDeletionInProgressFlag sync.RWMutex
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000227}
228
Himani Chawla6d2ae152020-09-02 13:11:20 +0530229//newDeviceHandler creates a new device handler
Himani Chawlac07fda02020-12-09 16:21:21 +0530230func newDeviceHandler(ctx context.Context, cp adapterif.CoreProxy, ap adapterif.AdapterProxy, ep eventif.EventProxy, device *voltha.Device, adapter *OpenONUAC) *deviceHandler {
Himani Chawla6d2ae152020-09-02 13:11:20 +0530231 var dh deviceHandler
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000232 dh.coreProxy = cp
233 dh.AdapterProxy = ap
234 dh.EventProxy = ep
235 cloned := (proto.Clone(device)).(*voltha.Device)
236 dh.deviceID = cloned.Id
237 dh.DeviceType = cloned.Type
238 dh.adminState = "up"
239 dh.device = cloned
240 dh.pOpenOnuAc = adapter
241 dh.exitChannel = make(chan int, 1)
242 dh.lockDevice = sync.RWMutex{}
mpagenko3af1f032020-06-10 08:53:41 +0000243 dh.deviceEntrySet = make(chan bool, 1)
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000244 dh.collectorIsRunning = false
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000245 dh.stopCollector = make(chan bool, 2)
Himani Chawla4c1d4c72021-02-18 12:14:31 +0530246 dh.alarmManagerIsRunning = false
Himani Chawlaac1f5ad2021-02-04 21:21:54 +0530247 dh.stopAlarmManager = make(chan bool, 2)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000248 dh.stopHeartbeatCheck = make(chan bool, 2)
249 //dh.metrics = pmmetrics.NewPmMetrics(cloned.Id, pmmetrics.Frequency(150), pmmetrics.FrequencyOverride(false), pmmetrics.Grouped(false), pmmetrics.Metrics(pmNames))
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000250 //TODO initialize the support classes.
Himani Chawla6d2ae152020-09-02 13:11:20 +0530251 dh.uniEntityMap = make(map[uint32]*onuUniPort)
mpagenkof1fc3862021-02-16 10:09:52 +0000252 dh.lockVlanConfig = sync.RWMutex{}
mpagenko80622a52021-02-09 16:53:23 +0000253 dh.lockUpgradeFsm = sync.RWMutex{}
mpagenkodff5dda2020-08-28 11:52:01 +0000254 dh.UniVlanConfigFsmMap = make(map[uint8]*UniVlanConfigFsm)
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000255 dh.reconciling = cNoReconciling
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +0000256 dh.chReconcilingFinished = make(chan bool)
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +0000257 dh.reconcilingFlows = false
258 dh.chReconcilingFlowsFinished = make(chan bool)
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000259 dh.readyForOmciConfig = false
Holger Hildebrandtff05b682021-03-16 15:02:05 +0000260 dh.deletionInProgress = false
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000261
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800262 if dh.device.PmConfigs != nil { // can happen after onu adapter restart
263 dh.pmConfigs = cloned.PmConfigs
264 } /* else {
265 // will be populated when onu_metrics_mananger is initialized.
266 }*/
Girish Gowdrae09a6202021-01-12 18:10:59 -0800267
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000268 // Device related state machine
269 dh.pDeviceStateFsm = fsm.NewFSM(
mpagenko1cc3cb42020-07-27 15:24:38 +0000270 devStNull,
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000271 fsm.Events{
mpagenko1cc3cb42020-07-27 15:24:38 +0000272 {Name: devEvDeviceInit, Src: []string{devStNull, devStDown}, Dst: devStInit},
273 {Name: devEvGrpcConnected, Src: []string{devStInit}, Dst: devStConnected},
274 {Name: devEvGrpcDisconnected, Src: []string{devStConnected, devStDown}, Dst: devStInit},
275 {Name: devEvDeviceUpInd, Src: []string{devStConnected, devStDown}, Dst: devStUp},
276 {Name: devEvDeviceDownInd, Src: []string{devStUp}, Dst: devStDown},
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000277 },
278 fsm.Callbacks{
dbainbri4d3a0dc2020-12-02 00:33:42 +0000279 "before_event": func(e *fsm.Event) { dh.logStateChange(ctx, e) },
280 ("before_" + devEvDeviceInit): func(e *fsm.Event) { dh.doStateInit(ctx, e) },
281 ("after_" + devEvDeviceInit): func(e *fsm.Event) { dh.postInit(ctx, e) },
282 ("before_" + devEvGrpcConnected): func(e *fsm.Event) { dh.doStateConnected(ctx, e) },
283 ("before_" + devEvGrpcDisconnected): func(e *fsm.Event) { dh.doStateInit(ctx, e) },
284 ("after_" + devEvGrpcDisconnected): func(e *fsm.Event) { dh.postInit(ctx, e) },
285 ("before_" + devEvDeviceUpInd): func(e *fsm.Event) { dh.doStateUp(ctx, e) },
286 ("before_" + devEvDeviceDownInd): func(e *fsm.Event) { dh.doStateDown(ctx, e) },
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000287 },
288 )
mpagenkoaf801632020-07-03 10:00:42 +0000289
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000290 return &dh
291}
292
Himani Chawla6d2ae152020-09-02 13:11:20 +0530293// start save the device to the data model
294func (dh *deviceHandler) start(ctx context.Context) {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000295 logger.Debugw(ctx, "starting-device-handler", log.Fields{"device": dh.device, "device-id": dh.deviceID})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000296 // Add the initial device to the local model
dbainbri4d3a0dc2020-12-02 00:33:42 +0000297 logger.Debug(ctx, "device-handler-started")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000298}
299
Himani Chawla4d908332020-08-31 12:30:20 +0530300/*
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000301// stop stops the device dh. Not much to do for now
Himani Chawla6d2ae152020-09-02 13:11:20 +0530302func (dh *deviceHandler) stop(ctx context.Context) {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000303 logger.Debug("stopping-device-handler")
304 dh.exitChannel <- 1
305}
Himani Chawla4d908332020-08-31 12:30:20 +0530306*/
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000307
308// ##########################################################################################
Himani Chawla6d2ae152020-09-02 13:11:20 +0530309// deviceHandler methods that implement the adapters interface requests ##### begin #########
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000310
Girish Gowdrae0140f02021-02-02 16:55:09 -0800311//adoptOrReconcileDevice adopts the ONU device
Himani Chawla6d2ae152020-09-02 13:11:20 +0530312func (dh *deviceHandler) adoptOrReconcileDevice(ctx context.Context, device *voltha.Device) {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000313 logger.Debugw(ctx, "Adopt_or_reconcile_device", log.Fields{"device-id": device.Id, "Address": device.GetHostAndPort()})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000314
dbainbri4d3a0dc2020-12-02 00:33:42 +0000315 logger.Debugw(ctx, "Device FSM: ", log.Fields{"state": string(dh.pDeviceStateFsm.Current())})
mpagenko1cc3cb42020-07-27 15:24:38 +0000316 if dh.pDeviceStateFsm.Is(devStNull) {
317 if err := dh.pDeviceStateFsm.Event(devEvDeviceInit); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000318 logger.Errorw(ctx, "Device FSM: Can't go to state DeviceInit", log.Fields{"err": err})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000319 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000320 logger.Debugw(ctx, "Device FSM: ", log.Fields{"state": string(dh.pDeviceStateFsm.Current())})
Girish Gowdraaf0ad632021-01-27 13:00:01 -0800321 // device.PmConfigs is not nil in cases when adapter restarts. We should not re-set the core again.
322 if device.PmConfigs == nil {
Girish Gowdra5a7c4922021-01-22 18:33:41 -0800323 // Now, set the initial PM configuration for that device
324 if err := dh.coreProxy.DevicePMConfigUpdate(ctx, dh.pmConfigs); err != nil {
325 logger.Errorw(ctx, "error updating pm config to core", log.Fields{"device-id": dh.deviceID, "err": err})
326 }
Girish Gowdrae09a6202021-01-12 18:10:59 -0800327 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000328 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000329 logger.Debugw(ctx, "AdoptOrReconcileDevice: Agent/device init already done", log.Fields{"device-id": device.Id})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000330 }
331
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000332}
333
mpagenko057889c2021-01-21 16:51:58 +0000334func (dh *deviceHandler) processInterAdapterOMCIReceiveMessage(ctx context.Context, msg *ic.InterAdapterMessage) error {
Himani Chawla26e555c2020-08-31 12:30:20 +0530335 msgBody := msg.GetBody()
336 omciMsg := &ic.InterAdapterOmciMessage{}
337 if err := ptypes.UnmarshalAny(msgBody, omciMsg); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000338 logger.Warnw(ctx, "cannot-unmarshal-omci-msg-body", log.Fields{
Himani Chawla26e555c2020-08-31 12:30:20 +0530339 "device-id": dh.deviceID, "error": err})
340 return err
341 }
342
mpagenko80622a52021-02-09 16:53:23 +0000343 /* msg print moved symmetrically to omci_cc, if wanted here as additional debug, than perhaps only based on additional debug setting!
Himani Chawla26e555c2020-08-31 12:30:20 +0530344 //assuming omci message content is hex coded!
345 // with restricted output of 16(?) bytes would be ...omciMsg.Message[:16]
dbainbri4d3a0dc2020-12-02 00:33:42 +0000346 logger.Debugw(ctx, "inter-adapter-recv-omci", log.Fields{
Himani Chawla26e555c2020-08-31 12:30:20 +0530347 "device-id": dh.deviceID, "RxOmciMessage": hex.EncodeToString(omciMsg.Message)})
mpagenko80622a52021-02-09 16:53:23 +0000348 */
dbainbri4d3a0dc2020-12-02 00:33:42 +0000349 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
Himani Chawla26e555c2020-08-31 12:30:20 +0530350 if pDevEntry != nil {
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000351 if pDevEntry.PDevOmciCC != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000352 return pDevEntry.PDevOmciCC.receiveMessage(log.WithSpanFromContext(context.TODO(), ctx), omciMsg.Message)
Holger Hildebrandt2fb70892020-10-28 11:53:18 +0000353 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000354 logger.Debugw(ctx, "omciCC not ready to receive omci messages - incoming omci message ignored", log.Fields{"rxMsg": omciMsg.Message})
Himani Chawla26e555c2020-08-31 12:30:20 +0530355 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000356 logger.Errorw(ctx, "No valid OnuDevice -aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000357 return fmt.Errorf("no valid OnuDevice: %s", dh.deviceID)
Himani Chawla26e555c2020-08-31 12:30:20 +0530358}
359
Himani Chawla6d2ae152020-09-02 13:11:20 +0530360func (dh *deviceHandler) processInterAdapterTechProfileDownloadReqMessage(
dbainbri4d3a0dc2020-12-02 00:33:42 +0000361 ctx context.Context,
Himani Chawla26e555c2020-08-31 12:30:20 +0530362 msg *ic.InterAdapterMessage) error {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000363
dbainbri4d3a0dc2020-12-02 00:33:42 +0000364 logger.Infow(ctx, "tech-profile-download-request", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000365
dbainbri4d3a0dc2020-12-02 00:33:42 +0000366 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000367 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000368 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000369 return fmt.Errorf("no valid OnuDevice: %s", dh.deviceID)
370 }
Himani Chawla26e555c2020-08-31 12:30:20 +0530371 if dh.pOnuTP == nil {
372 //should normally not happen ...
dbainbri4d3a0dc2020-12-02 00:33:42 +0000373 logger.Errorw(ctx, "onuTechProf instance not set up for DLMsg request - ignoring request",
Himani Chawla26e555c2020-08-31 12:30:20 +0530374 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000375 return fmt.Errorf("techProfile DLMsg request while onuTechProf instance not setup: %s", dh.deviceID)
Himani Chawla26e555c2020-08-31 12:30:20 +0530376 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000377 if !dh.isReadyForOmciConfig() {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000378 logger.Errorw(ctx, "TechProf-set rejected: improper device state", log.Fields{"device-id": dh.deviceID,
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000379 "device-state": dh.getDeviceReasonString()})
380 return fmt.Errorf("improper device state %s on device %s", dh.getDeviceReasonString(), dh.deviceID)
Himani Chawla26e555c2020-08-31 12:30:20 +0530381 }
mpagenkofc4f56e2020-11-04 17:17:49 +0000382 //previous state test here was just this one, now extended for more states to reject the SetRequest:
383 // at least 'mib-downloaded' should be reached for processing of this specific ONU configuration
384 // if (dh.deviceReason == "stopping-openomci") || (dh.deviceReason == "omci-admin-lock")
Himani Chawla26e555c2020-08-31 12:30:20 +0530385
386 msgBody := msg.GetBody()
387 techProfMsg := &ic.InterAdapterTechProfileDownloadMessage{}
388 if err := ptypes.UnmarshalAny(msgBody, techProfMsg); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000389 logger.Warnw(ctx, "cannot-unmarshal-techprof-msg-body", log.Fields{
Himani Chawla26e555c2020-08-31 12:30:20 +0530390 "device-id": dh.deviceID, "error": err})
391 return err
392 }
393
394 // we have to lock access to TechProfile processing based on different messageType calls or
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000395 // even to fast subsequent calls of the same messageType as well as OnuKVStore processing due
396 // to possible concurrent access by flow processing
Himani Chawla26e555c2020-08-31 12:30:20 +0530397 dh.pOnuTP.lockTpProcMutex()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000398 defer dh.pOnuTP.unlockTpProcMutex()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000399
400 if techProfMsg.UniId > 255 {
401 return fmt.Errorf(fmt.Sprintf("received UniId value exceeds range: %d, device-id: %s",
402 techProfMsg.UniId, dh.deviceID))
403 }
404 uniID := uint8(techProfMsg.UniId)
Girish Gowdra041dcb32020-11-16 16:54:30 -0800405 tpID, err := GetTpIDFromTpPath(techProfMsg.Path)
406 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000407 logger.Errorw(ctx, "error-parsing-tpid-from-tppath", log.Fields{"err": err, "tp-path": techProfMsg.Path})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800408 return err
409 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000410
dbainbri4d3a0dc2020-12-02 00:33:42 +0000411 if bTpModify := pDevEntry.updateOnuUniTpPath(ctx, uniID, uint8(tpID), techProfMsg.Path); bTpModify {
Himani Chawla26e555c2020-08-31 12:30:20 +0530412 // if there has been some change for some uni TechProfilePath
413 //in order to allow concurrent calls to other dh instances we do not wait for execution here
414 //but doing so we can not indicate problems to the caller (who does what with that then?)
415 //by now we just assume straightforward successful execution
416 //TODO!!! Generally: In this scheme it would be good to have some means to indicate
417 // possible problems to the caller later autonomously
418
419 // deadline context to ensure completion of background routines waited for
420 //20200721: 10s proved to be less in 8*8 ONU test on local vbox machine with debug, might be further adapted
Himani Chawlad96df182020-09-28 11:12:02 +0530421 deadline := time.Now().Add(dh.pOpenOnuAc.maxTimeoutInterAdapterComm) //allowed run time to finish before execution
Himani Chawla26e555c2020-08-31 12:30:20 +0530422 dctx, cancel := context.WithDeadline(context.Background(), deadline)
423
Girish Gowdra041dcb32020-11-16 16:54:30 -0800424 dh.pOnuTP.resetTpProcessingErrorIndication(uniID, tpID)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000425 pDevEntry.resetKvProcessingErrorIndication()
426
Himani Chawla26e555c2020-08-31 12:30:20 +0530427 var wg sync.WaitGroup
428 wg.Add(2) // for the 2 go routines to finish
429 // attention: deadline completion check and wg.Done is to be done in both routines
dbainbri4d3a0dc2020-12-02 00:33:42 +0000430 go dh.pOnuTP.configureUniTp(log.WithSpanFromContext(dctx, ctx), uniID, techProfMsg.Path, &wg)
431 go pDevEntry.updateOnuKvStore(log.WithSpanFromContext(dctx, ctx), &wg)
432 dh.waitForCompletion(ctx, cancel, &wg, "TechProfDwld") //wait for background process to finish
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000433
Girish Gowdra041dcb32020-11-16 16:54:30 -0800434 return dh.combineErrorStrings(dh.pOnuTP.getTpProcessingErrorIndication(uniID, tpID), pDevEntry.getKvProcessingErrorIndication())
Himani Chawla26e555c2020-08-31 12:30:20 +0530435 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000436 // no change, nothing really to do - return success
Himani Chawla26e555c2020-08-31 12:30:20 +0530437 return nil
438}
439
Himani Chawla6d2ae152020-09-02 13:11:20 +0530440func (dh *deviceHandler) processInterAdapterDeleteGemPortReqMessage(
dbainbri4d3a0dc2020-12-02 00:33:42 +0000441 ctx context.Context,
Himani Chawla26e555c2020-08-31 12:30:20 +0530442 msg *ic.InterAdapterMessage) error {
443
dbainbri4d3a0dc2020-12-02 00:33:42 +0000444 logger.Infow(ctx, "delete-gem-port-request", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000445
dbainbri4d3a0dc2020-12-02 00:33:42 +0000446 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000447 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000448 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000449 return fmt.Errorf("no valid OnuDevice: %s", dh.deviceID)
450 }
Himani Chawla26e555c2020-08-31 12:30:20 +0530451 if dh.pOnuTP == nil {
452 //should normally not happen ...
dbainbri4d3a0dc2020-12-02 00:33:42 +0000453 logger.Warnw(ctx, "onuTechProf instance not set up for DelGem request - ignoring request",
Himani Chawla26e555c2020-08-31 12:30:20 +0530454 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000455 return fmt.Errorf("techProfile DelGem request while onuTechProf instance not setup: %s", dh.deviceID)
Himani Chawla26e555c2020-08-31 12:30:20 +0530456 }
457
458 msgBody := msg.GetBody()
459 delGemPortMsg := &ic.InterAdapterDeleteGemPortMessage{}
460 if err := ptypes.UnmarshalAny(msgBody, delGemPortMsg); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000461 logger.Warnw(ctx, "cannot-unmarshal-delete-gem-msg-body", log.Fields{
Himani Chawla26e555c2020-08-31 12:30:20 +0530462 "device-id": dh.deviceID, "error": err})
463 return err
464 }
465
466 //compare TECH_PROFILE_DOWNLOAD_REQUEST
467 dh.pOnuTP.lockTpProcMutex()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000468 defer dh.pOnuTP.unlockTpProcMutex()
Himani Chawla26e555c2020-08-31 12:30:20 +0530469
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000470 if delGemPortMsg.UniId > 255 {
471 return fmt.Errorf(fmt.Sprintf("received UniId value exceeds range: %d, device-id: %s",
472 delGemPortMsg.UniId, dh.deviceID))
473 }
474 uniID := uint8(delGemPortMsg.UniId)
Girish Gowdra041dcb32020-11-16 16:54:30 -0800475 tpID, err := GetTpIDFromTpPath(delGemPortMsg.TpPath)
476 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000477 logger.Errorw(ctx, "error-extracting-tp-id-from-tp-path", log.Fields{"err": err, "tp-path": delGemPortMsg.TpPath})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800478 return err
479 }
Himani Chawla26e555c2020-08-31 12:30:20 +0530480
mpagenkofc4f56e2020-11-04 17:17:49 +0000481 //a removal of some GemPort would never remove the complete TechProfile entry (done on T-Cont)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000482
mpagenkofc4f56e2020-11-04 17:17:49 +0000483 // deadline context to ensure completion of background routines waited for
484 deadline := time.Now().Add(dh.pOpenOnuAc.maxTimeoutInterAdapterComm) //allowed run time to finish before execution
485 dctx, cancel := context.WithDeadline(context.Background(), deadline)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000486
Girish Gowdra041dcb32020-11-16 16:54:30 -0800487 dh.pOnuTP.resetTpProcessingErrorIndication(uniID, tpID)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000488
mpagenkofc4f56e2020-11-04 17:17:49 +0000489 var wg sync.WaitGroup
490 wg.Add(1) // for the 1 go routine to finish
dbainbri4d3a0dc2020-12-02 00:33:42 +0000491 go dh.pOnuTP.deleteTpResource(log.WithSpanFromContext(dctx, ctx), uniID, tpID, delGemPortMsg.TpPath,
mpagenkofc4f56e2020-11-04 17:17:49 +0000492 cResourceGemPort, delGemPortMsg.GemPortId, &wg)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000493 dh.waitForCompletion(ctx, cancel, &wg, "GemDelete") //wait for background process to finish
mpagenkofc4f56e2020-11-04 17:17:49 +0000494
Girish Gowdra041dcb32020-11-16 16:54:30 -0800495 return dh.pOnuTP.getTpProcessingErrorIndication(uniID, tpID)
Himani Chawla26e555c2020-08-31 12:30:20 +0530496}
497
Himani Chawla6d2ae152020-09-02 13:11:20 +0530498func (dh *deviceHandler) processInterAdapterDeleteTcontReqMessage(
dbainbri4d3a0dc2020-12-02 00:33:42 +0000499 ctx context.Context,
Himani Chawla26e555c2020-08-31 12:30:20 +0530500 msg *ic.InterAdapterMessage) error {
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000501
dbainbri4d3a0dc2020-12-02 00:33:42 +0000502 logger.Infow(ctx, "delete-tcont-request", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000503
dbainbri4d3a0dc2020-12-02 00:33:42 +0000504 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000505 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000506 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000507 return fmt.Errorf("no valid OnuDevice: %s", dh.deviceID)
508 }
Himani Chawla26e555c2020-08-31 12:30:20 +0530509 if dh.pOnuTP == nil {
510 //should normally not happen ...
dbainbri4d3a0dc2020-12-02 00:33:42 +0000511 logger.Warnw(ctx, "onuTechProf instance not set up for DelTcont request - ignoring request",
Himani Chawla26e555c2020-08-31 12:30:20 +0530512 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000513 return fmt.Errorf("techProfile DelTcont request while onuTechProf instance not setup: %s", dh.deviceID)
Himani Chawla26e555c2020-08-31 12:30:20 +0530514 }
515
516 msgBody := msg.GetBody()
517 delTcontMsg := &ic.InterAdapterDeleteTcontMessage{}
518 if err := ptypes.UnmarshalAny(msgBody, delTcontMsg); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000519 logger.Warnw(ctx, "cannot-unmarshal-delete-tcont-msg-body", log.Fields{
Himani Chawla26e555c2020-08-31 12:30:20 +0530520 "device-id": dh.deviceID, "error": err})
521 return err
522 }
523
524 //compare TECH_PROFILE_DOWNLOAD_REQUEST
525 dh.pOnuTP.lockTpProcMutex()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000526 defer dh.pOnuTP.unlockTpProcMutex()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000527
528 if delTcontMsg.UniId > 255 {
529 return fmt.Errorf(fmt.Sprintf("received UniId value exceeds range: %d, device-id: %s",
530 delTcontMsg.UniId, dh.deviceID))
531 }
532 uniID := uint8(delTcontMsg.UniId)
Girish Gowdra041dcb32020-11-16 16:54:30 -0800533 tpPath := delTcontMsg.TpPath
534 tpID, err := GetTpIDFromTpPath(tpPath)
535 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000536 logger.Errorw(ctx, "error-extracting-tp-id-from-tp-path", log.Fields{"err": err, "tp-path": tpPath})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800537 return err
538 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000539
dbainbri4d3a0dc2020-12-02 00:33:42 +0000540 if bTpModify := pDevEntry.updateOnuUniTpPath(ctx, uniID, tpID, ""); bTpModify {
Himani Chawla26e555c2020-08-31 12:30:20 +0530541 // deadline context to ensure completion of background routines waited for
Himani Chawlad96df182020-09-28 11:12:02 +0530542 deadline := time.Now().Add(dh.pOpenOnuAc.maxTimeoutInterAdapterComm) //allowed run time to finish before execution
Himani Chawla26e555c2020-08-31 12:30:20 +0530543 dctx, cancel := context.WithDeadline(context.Background(), deadline)
544
Girish Gowdra041dcb32020-11-16 16:54:30 -0800545 dh.pOnuTP.resetTpProcessingErrorIndication(uniID, tpID)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000546 pDevEntry.resetKvProcessingErrorIndication()
547
Himani Chawla26e555c2020-08-31 12:30:20 +0530548 var wg sync.WaitGroup
549 wg.Add(2) // for the 2 go routines to finish
dbainbri4d3a0dc2020-12-02 00:33:42 +0000550 go dh.pOnuTP.deleteTpResource(log.WithSpanFromContext(dctx, ctx), uniID, tpID, delTcontMsg.TpPath,
Himani Chawla26e555c2020-08-31 12:30:20 +0530551 cResourceTcont, delTcontMsg.AllocId, &wg)
552 // Removal of the tcont/alloc id mapping represents the removal of the tech profile
dbainbri4d3a0dc2020-12-02 00:33:42 +0000553 go pDevEntry.updateOnuKvStore(log.WithSpanFromContext(dctx, ctx), &wg)
554 dh.waitForCompletion(ctx, cancel, &wg, "TContDelete") //wait for background process to finish
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000555
Girish Gowdra041dcb32020-11-16 16:54:30 -0800556 return dh.combineErrorStrings(dh.pOnuTP.getTpProcessingErrorIndication(uniID, tpID), pDevEntry.getKvProcessingErrorIndication())
Himani Chawla26e555c2020-08-31 12:30:20 +0530557 }
Himani Chawla26e555c2020-08-31 12:30:20 +0530558 return nil
559}
560
Himani Chawla6d2ae152020-09-02 13:11:20 +0530561//processInterAdapterMessage sends the proxied messages to the target device
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000562// If the proxy address is not found in the unmarshalled message, it first fetches the onu device for which the message
563// is meant, and then send the unmarshalled omci message to this onu
dbainbri4d3a0dc2020-12-02 00:33:42 +0000564func (dh *deviceHandler) processInterAdapterMessage(ctx context.Context, msg *ic.InterAdapterMessage) error {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000565 msgID := msg.Header.Id
566 msgType := msg.Header.Type
567 fromTopic := msg.Header.FromTopic
568 toTopic := msg.Header.ToTopic
569 toDeviceID := msg.Header.ToDeviceId
570 proxyDeviceID := msg.Header.ProxyDeviceId
dbainbri4d3a0dc2020-12-02 00:33:42 +0000571 logger.Debugw(ctx, "InterAdapter message header", log.Fields{"msgID": msgID, "msgType": msgType,
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000572 "fromTopic": fromTopic, "toTopic": toTopic, "toDeviceID": toDeviceID, "proxyDeviceID": proxyDeviceID})
573
574 switch msgType {
Holger Hildebrandt6c1fb0a2020-11-25 15:41:01 +0000575 // case ic.InterAdapterMessageType_ONU_IND_REQUEST: was handled by OpenONUAC already - see comments there
mpagenko057889c2021-01-21 16:51:58 +0000576 //OMCI_RESPONSE also accepted acc. to VOL-3756 (OMCI_REQUEST request was legacy code)
577 case ic.InterAdapterMessageType_OMCI_RESPONSE, ic.InterAdapterMessageType_OMCI_REQUEST:
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000578 {
mpagenko057889c2021-01-21 16:51:58 +0000579 return dh.processInterAdapterOMCIReceiveMessage(ctx, msg)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000580 }
mpagenkoaf801632020-07-03 10:00:42 +0000581 case ic.InterAdapterMessageType_TECH_PROFILE_DOWNLOAD_REQUEST:
582 {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000583 return dh.processInterAdapterTechProfileDownloadReqMessage(ctx, msg)
mpagenkoaf801632020-07-03 10:00:42 +0000584 }
585 case ic.InterAdapterMessageType_DELETE_GEM_PORT_REQUEST:
586 {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000587 return dh.processInterAdapterDeleteGemPortReqMessage(ctx, msg)
mpagenkoaf801632020-07-03 10:00:42 +0000588
mpagenkoaf801632020-07-03 10:00:42 +0000589 }
590 case ic.InterAdapterMessageType_DELETE_TCONT_REQUEST:
591 {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000592 return dh.processInterAdapterDeleteTcontReqMessage(ctx, msg)
mpagenkoaf801632020-07-03 10:00:42 +0000593 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000594 default:
595 {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000596 logger.Errorw(ctx, "inter-adapter-unhandled-type", log.Fields{
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000597 "msgType": msg.Header.Type, "device-id": dh.deviceID})
598 return fmt.Errorf("inter-adapter-unhandled-type: %d, %s", msg.Header.Type, dh.deviceID)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000599 }
600 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000601}
602
mpagenkodff5dda2020-08-28 11:52:01 +0000603//FlowUpdateIncremental removes and/or adds the flow changes on a given device
dbainbri4d3a0dc2020-12-02 00:33:42 +0000604func (dh *deviceHandler) FlowUpdateIncremental(ctx context.Context,
605 apOfFlowChanges *openflow_13.FlowChanges,
mpagenkodff5dda2020-08-28 11:52:01 +0000606 apOfGroupChanges *openflow_13.FlowGroupChanges, apFlowMetaData *voltha.FlowMetadata) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000607 logger.Debugw(ctx, "FlowUpdateIncremental started", log.Fields{"device-id": dh.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +0000608
mpagenko01e726e2020-10-23 09:45:29 +0000609 var retError error = nil
610 //Remove flows (always remove flows first - remove old and add new with same cookie may be part of the same request)
mpagenkodff5dda2020-08-28 11:52:01 +0000611 if apOfFlowChanges.ToRemove != nil {
612 for _, flowItem := range apOfFlowChanges.ToRemove.Items {
mpagenkodff5dda2020-08-28 11:52:01 +0000613 if flowItem.GetCookie() == 0 {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000614 logger.Warnw(ctx, "flow-remove no cookie: ignore and continuing on checking further flows", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000615 "device-id": dh.deviceID})
616 retError = fmt.Errorf("flow-remove no cookie, device-id %s", dh.deviceID)
mpagenkodff5dda2020-08-28 11:52:01 +0000617 continue
618 }
619 flowInPort := flow.GetInPort(flowItem)
620 if flowInPort == uint32(of.OfpPortNo_OFPP_INVALID) {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000621 logger.Warnw(ctx, "flow-remove inPort invalid: ignore and continuing on checking further flows", log.Fields{"device-id": dh.deviceID})
mpagenko01e726e2020-10-23 09:45:29 +0000622 retError = fmt.Errorf("flow-remove inPort invalid, device-id %s", dh.deviceID)
623 continue
624 //return fmt.Errorf("flow inPort invalid: %s", dh.deviceID)
mpagenkodff5dda2020-08-28 11:52:01 +0000625 } else if flowInPort == dh.ponPortNumber {
mpagenko01e726e2020-10-23 09:45:29 +0000626 //this is some downstream flow, not regarded as error, just ignored
dbainbri4d3a0dc2020-12-02 00:33:42 +0000627 logger.Debugw(ctx, "flow-remove for downstream: ignore and continuing on checking further flows", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000628 "device-id": dh.deviceID, "inPort": flowInPort})
mpagenkodff5dda2020-08-28 11:52:01 +0000629 continue
630 } else {
631 // this is the relevant upstream flow
Himani Chawla6d2ae152020-09-02 13:11:20 +0530632 var loUniPort *onuUniPort
mpagenkodff5dda2020-08-28 11:52:01 +0000633 if uniPort, exist := dh.uniEntityMap[flowInPort]; exist {
634 loUniPort = uniPort
635 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000636 logger.Warnw(ctx, "flow-remove inPort not found in UniPorts: ignore and continuing on checking further flows",
mpagenko01e726e2020-10-23 09:45:29 +0000637 log.Fields{"device-id": dh.deviceID, "inPort": flowInPort})
638 retError = fmt.Errorf("flow-remove inPort not found in UniPorts, inPort %d, device-id %s",
639 flowInPort, dh.deviceID)
640 continue
mpagenkodff5dda2020-08-28 11:52:01 +0000641 }
642 flowOutPort := flow.GetOutPort(flowItem)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000643 logger.Debugw(ctx, "flow-remove port indications", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000644 "device-id": dh.deviceID, "inPort": flowInPort, "outPort": flowOutPort,
mpagenkodff5dda2020-08-28 11:52:01 +0000645 "uniPortName": loUniPort.name})
dbainbri4d3a0dc2020-12-02 00:33:42 +0000646 err := dh.removeFlowItemFromUniPort(ctx, flowItem, loUniPort)
mpagenko01e726e2020-10-23 09:45:29 +0000647 //try next flow after processing error
mpagenkodff5dda2020-08-28 11:52:01 +0000648 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000649 logger.Warnw(ctx, "flow-remove processing error: continuing on checking further flows",
mpagenko01e726e2020-10-23 09:45:29 +0000650 log.Fields{"device-id": dh.deviceID, "error": err})
651 retError = err
652 continue
653 //return err
654 } else { // if last setting succeeds, overwrite possibly previously set error
655 retError = nil
mpagenkodff5dda2020-08-28 11:52:01 +0000656 }
657 }
658 }
659 }
mpagenko01e726e2020-10-23 09:45:29 +0000660 if apOfFlowChanges.ToAdd != nil {
661 for _, flowItem := range apOfFlowChanges.ToAdd.Items {
662 if flowItem.GetCookie() == 0 {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000663 logger.Debugw(ctx, "incremental flow-add no cookie: ignore and continuing on checking further flows", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000664 "device-id": dh.deviceID})
665 retError = fmt.Errorf("flow-add no cookie, device-id %s", dh.deviceID)
666 continue
667 }
668 flowInPort := flow.GetInPort(flowItem)
669 if flowInPort == uint32(of.OfpPortNo_OFPP_INVALID) {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000670 logger.Warnw(ctx, "flow-add inPort invalid: ignore and continuing on checking further flows", log.Fields{"device-id": dh.deviceID})
mpagenko01e726e2020-10-23 09:45:29 +0000671 retError = fmt.Errorf("flow-add inPort invalid, device-id %s", dh.deviceID)
672 continue
673 //return fmt.Errorf("flow inPort invalid: %s", dh.deviceID)
674 } else if flowInPort == dh.ponPortNumber {
675 //this is some downstream flow
dbainbri4d3a0dc2020-12-02 00:33:42 +0000676 logger.Debugw(ctx, "flow-add for downstream: ignore and continuing on checking further flows", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000677 "device-id": dh.deviceID, "inPort": flowInPort})
678 continue
679 } else {
680 // this is the relevant upstream flow
681 var loUniPort *onuUniPort
682 if uniPort, exist := dh.uniEntityMap[flowInPort]; exist {
683 loUniPort = uniPort
684 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000685 logger.Warnw(ctx, "flow-add inPort not found in UniPorts: ignore and continuing on checking further flows",
mpagenko01e726e2020-10-23 09:45:29 +0000686 log.Fields{"device-id": dh.deviceID, "inPort": flowInPort})
687 retError = fmt.Errorf("flow-add inPort not found in UniPorts, inPort %d, device-id %s",
688 flowInPort, dh.deviceID)
689 continue
690 //return fmt.Errorf("flow-parameter inPort %d not found in internal UniPorts", flowInPort)
691 }
mpagenkofc4f56e2020-11-04 17:17:49 +0000692 // let's still assume that we receive the flow-add only in some 'active' device state (as so far observed)
693 // if not, we just throw some error here to have an indication about that, if we really need to support that
694 // then we would need to create some means to activate the internal stored flows
695 // after the device gets active automatically (and still with its dependency to the TechProfile)
696 // for state checking compare also code here: processInterAdapterTechProfileDownloadReqMessage
697 // also abort for the other still possible flows here
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000698 if !dh.isReadyForOmciConfig() {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000699 logger.Errorw(ctx, "flow-add rejected: improper device state", log.Fields{"device-id": dh.deviceID,
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000700 "last device-reason": dh.getDeviceReasonString()})
mpagenkofc4f56e2020-11-04 17:17:49 +0000701 return fmt.Errorf("improper device state on device %s", dh.deviceID)
702 }
703
mpagenko01e726e2020-10-23 09:45:29 +0000704 flowOutPort := flow.GetOutPort(flowItem)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000705 logger.Debugw(ctx, "flow-add port indications", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000706 "device-id": dh.deviceID, "inPort": flowInPort, "outPort": flowOutPort,
707 "uniPortName": loUniPort.name})
dbainbri4d3a0dc2020-12-02 00:33:42 +0000708 err := dh.addFlowItemToUniPort(ctx, flowItem, loUniPort)
mpagenko01e726e2020-10-23 09:45:29 +0000709 //try next flow after processing error
710 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000711 logger.Warnw(ctx, "flow-add processing error: continuing on checking further flows",
mpagenko01e726e2020-10-23 09:45:29 +0000712 log.Fields{"device-id": dh.deviceID, "error": err})
713 retError = err
714 continue
715 //return err
716 } else { // if last setting succeeds, overwrite possibly previously set error
717 retError = nil
718 }
719 }
720 }
721 }
722 return retError
mpagenkodff5dda2020-08-28 11:52:01 +0000723}
724
Himani Chawla6d2ae152020-09-02 13:11:20 +0530725//disableDevice locks the ONU and its UNI/VEIP ports (admin lock via OMCI)
mpagenkofc4f56e2020-11-04 17:17:49 +0000726//following are the expected device states after this activity:
727//Device Admin-State : down (on rwCore), Port-State: UNKNOWN, Conn-State: REACHABLE, Reason: omci-admin-lock
728// (Conn-State: REACHABLE might conflict with some previous ONU Down indication - maybe to be resolved later)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000729func (dh *deviceHandler) disableDevice(ctx context.Context, device *voltha.Device) {
730 logger.Debugw(ctx, "disable-device", log.Fields{"device-id": device.Id, "SerialNumber": device.SerialNumber})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000731
mpagenko900ee4b2020-10-12 11:56:34 +0000732 //admin-lock reason can also be used uniquely for setting the DeviceState accordingly
mpagenkofc4f56e2020-11-04 17:17:49 +0000733 //note that disableDevice sequences in some 'ONU active' state may yield also
734 // "tech...delete-success" or "omci-flow-deleted" according to further received requests in the end
mpagenko900ee4b2020-10-12 11:56:34 +0000735 // - inblock state checking to prevent possibly unneeded processing (on command repitition)
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000736 if dh.getDeviceReason() != drOmciAdminLock {
mpagenkofc4f56e2020-11-04 17:17:49 +0000737 //disable-device shall be just a UNi/ONU-G related admin state setting
738 //all other configurations/FSM's shall not be impacted and shall execute as required by the system
mpagenko900ee4b2020-10-12 11:56:34 +0000739
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000740 if dh.isReadyForOmciConfig() {
mpagenko01e726e2020-10-23 09:45:29 +0000741 // disable UNI ports/ONU
742 // *** should generate UniDisableStateDone event - used to disable the port(s) on success
743 if dh.pLockStateFsm == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000744 dh.createUniLockFsm(ctx, true, UniDisableStateDone)
mpagenko01e726e2020-10-23 09:45:29 +0000745 } else { //LockStateFSM already init
746 dh.pLockStateFsm.setSuccessEvent(UniDisableStateDone)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000747 dh.runUniLockFsm(ctx, true)
mpagenko01e726e2020-10-23 09:45:29 +0000748 }
749 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000750 logger.Debugw(ctx, "DeviceStateUpdate upon disable", log.Fields{"ConnectStatus": voltha.ConnectStatus_REACHABLE,
mpagenko01e726e2020-10-23 09:45:29 +0000751 "OperStatus": voltha.OperStatus_UNKNOWN, "device-id": dh.deviceID})
dbainbri4d3a0dc2020-12-02 00:33:42 +0000752 if err := dh.coreProxy.DeviceStateUpdate(log.WithSpanFromContext(context.TODO(), ctx),
mpagenko01e726e2020-10-23 09:45:29 +0000753 dh.deviceID, voltha.ConnectStatus_REACHABLE, voltha.OperStatus_UNKNOWN); err != nil {
754 //TODO with VOL-3045/VOL-3046: return the error and stop further processing
dbainbri4d3a0dc2020-12-02 00:33:42 +0000755 logger.Errorw(ctx, "error-updating-device-state", log.Fields{"device-id": dh.deviceID, "error": err})
mpagenko01e726e2020-10-23 09:45:29 +0000756 }
mpagenko01e726e2020-10-23 09:45:29 +0000757 // DeviceReason to update acc.to modified py code as per beginning of Sept 2020
Holger Hildebrandt80129db2020-11-23 10:49:32 +0000758
759 //TODO with VOL-3045/VOL-3046: catch and return error, valid for all occurrences in the codebase
dbainbri4d3a0dc2020-12-02 00:33:42 +0000760 _ = dh.deviceReasonUpdate(ctx, drOmciAdminLock, true)
mpagenko3af1f032020-06-10 08:53:41 +0000761 }
ozgecanetsiafce57b12020-05-25 14:39:35 +0300762 }
763}
764
Himani Chawla6d2ae152020-09-02 13:11:20 +0530765//reEnableDevice unlocks the ONU and its UNI/VEIP ports (admin unlock via OMCI)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000766func (dh *deviceHandler) reEnableDevice(ctx context.Context, device *voltha.Device) {
767 logger.Debugw(ctx, "reenable-device", log.Fields{"device-id": device.Id, "SerialNumber": device.SerialNumber})
mpagenko3af1f032020-06-10 08:53:41 +0000768
mpagenkofc4f56e2020-11-04 17:17:49 +0000769 //setting ReadyForSpecificOmciConfig here is just a workaround for BBSIM testing in the sequence
770 // OnuSoftReboot-disable-enable, because BBSIM does not generate a new OnuIndication-Up event after SoftReboot
771 // which is the assumption for real ONU's, where the ready-state is then set according to the following MibUpload/Download
772 // for real ONU's that should have nearly no influence
773 // Note that for real ONU's there is anyway a problematic situation with following sequence:
774 // OnuIndication-Dw (or not active at all) (- disable) - enable: here already the LockFsm may run into timeout (no OmciResponse)
775 // but that anyway is hopefully resolved by some OnuIndication-Up event (maybe to be tested)
776 // one could also argue, that a device-enable should also enable attempts for specific omci configuration
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000777 dh.setReadyForOmciConfig(true) //needed to allow subsequent flow/techProf config (on BBSIM)
mpagenkofc4f56e2020-11-04 17:17:49 +0000778
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000779 // enable ONU/UNI ports
mpagenko900ee4b2020-10-12 11:56:34 +0000780 // *** should generate UniEnableStateDone event - used to disable the port(s) on success
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000781 if dh.pUnlockStateFsm == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000782 dh.createUniLockFsm(ctx, false, UniEnableStateDone)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000783 } else { //UnlockStateFSM already init
mpagenko900ee4b2020-10-12 11:56:34 +0000784 dh.pUnlockStateFsm.setSuccessEvent(UniEnableStateDone)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000785 dh.runUniLockFsm(ctx, false)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +0000786 }
ozgecanetsiafce57b12020-05-25 14:39:35 +0300787}
788
dbainbri4d3a0dc2020-12-02 00:33:42 +0000789func (dh *deviceHandler) reconcileDeviceOnuInd(ctx context.Context) {
790 logger.Debugw(ctx, "reconciling - simulate onu indication", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000791
dbainbri4d3a0dc2020-12-02 00:33:42 +0000792 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000793 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000794 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000795 return
796 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000797 if err := pDevEntry.restoreDataFromOnuKvStore(log.WithSpanFromContext(context.TODO(), ctx)); err != nil {
mpagenko2418ab02020-11-12 12:58:06 +0000798 if err == fmt.Errorf("no-ONU-data-found") {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000799 logger.Debugw(ctx, "no persistent data found - abort reconciling", log.Fields{"device-id": dh.deviceID})
mpagenko2418ab02020-11-12 12:58:06 +0000800 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000801 logger.Errorw(ctx, "reconciling - restoring OnuTp-data failed - abort", log.Fields{"err": err, "device-id": dh.deviceID})
mpagenko2418ab02020-11-12 12:58:06 +0000802 }
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +0000803 dh.stopReconciling(ctx)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000804 return
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000805 }
Himani Chawla4d908332020-08-31 12:30:20 +0530806 var onuIndication oop.OnuIndication
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000807 pDevEntry.mutexPersOnuConfig.RLock()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000808 onuIndication.IntfId = pDevEntry.sOnuPersistentData.PersIntfID
809 onuIndication.OnuId = pDevEntry.sOnuPersistentData.PersOnuID
810 onuIndication.OperState = pDevEntry.sOnuPersistentData.PersOperState
811 onuIndication.AdminState = pDevEntry.sOnuPersistentData.PersAdminState
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000812 pDevEntry.mutexPersOnuConfig.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +0000813 _ = dh.createInterface(ctx, &onuIndication)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000814}
815
dbainbri4d3a0dc2020-12-02 00:33:42 +0000816func (dh *deviceHandler) reconcileDeviceTechProf(ctx context.Context) {
817 logger.Debugw(ctx, "reconciling - trigger tech profile config", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000818
dbainbri4d3a0dc2020-12-02 00:33:42 +0000819 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000820 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000821 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt7e9de862021-03-26 14:01:49 +0000822 if !dh.isSkipOnuConfigReconciling() {
823 dh.stopReconciling(ctx)
824 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000825 return
826 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000827 dh.pOnuTP.lockTpProcMutex()
828 defer dh.pOnuTP.unlockTpProcMutex()
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000829 pDevEntry.mutexPersOnuConfig.RLock()
830 defer pDevEntry.mutexPersOnuConfig.RUnlock()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000831
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000832 if len(pDevEntry.sOnuPersistentData.PersUniConfig) == 0 {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000833 logger.Debugw(ctx, "reconciling - no uni-configs have been stored before adapter restart - terminate reconcilement",
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000834 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt7e9de862021-03-26 14:01:49 +0000835 if !dh.isSkipOnuConfigReconciling() {
836 dh.stopReconciling(ctx)
837 }
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000838 return
839 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000840 techProfsFound := false
841 flowsFound := false
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000842 for _, uniData := range pDevEntry.sOnuPersistentData.PersUniConfig {
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000843 //TODO: check for uni-port specific reconcilement in case of multi-uni-port-per-onu-support
844 if len(uniData.PersTpPathMap) == 0 {
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000845 logger.Debugw(ctx, "reconciling - no TPs stored for uniID",
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000846 log.Fields{"uni-id": uniData.PersUniID, "device-id": dh.deviceID})
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000847 continue
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000848 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000849 techProfsFound = true
Girish Gowdra041dcb32020-11-16 16:54:30 -0800850 for tpID := range uniData.PersTpPathMap {
851 // deadline context to ensure completion of background routines waited for
852 //20200721: 10s proved to be less in 8*8 ONU test on local vbox machine with debug, might be further adapted
853 deadline := time.Now().Add(dh.pOpenOnuAc.maxTimeoutInterAdapterComm) //allowed run time to finish before execution
dbainbri4d3a0dc2020-12-02 00:33:42 +0000854 dctx, cancel := context.WithDeadline(ctx, deadline)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000855
Girish Gowdra041dcb32020-11-16 16:54:30 -0800856 dh.pOnuTP.resetTpProcessingErrorIndication(uniData.PersUniID, tpID)
857 var wg sync.WaitGroup
858 wg.Add(1) // for the 1 go routine to finish
dbainbri4d3a0dc2020-12-02 00:33:42 +0000859 go dh.pOnuTP.configureUniTp(log.WithSpanFromContext(dctx, ctx), uniData.PersUniID, uniData.PersTpPathMap[tpID], &wg)
860 dh.waitForCompletion(ctx, cancel, &wg, "TechProfReconcile") //wait for background process to finish
Girish Gowdra041dcb32020-11-16 16:54:30 -0800861 if err := dh.pOnuTP.getTpProcessingErrorIndication(uniData.PersUniID, tpID); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000862 logger.Errorw(ctx, err.Error(), log.Fields{"device-id": dh.deviceID})
Girish Gowdra041dcb32020-11-16 16:54:30 -0800863 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000864 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000865 if len(uniData.PersFlowParams) != 0 {
866 flowsFound = true
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000867 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000868 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000869 if !techProfsFound {
870 logger.Debugw(ctx, "reconciling - no TPs have been stored before adapter restart - terminate reconcilement",
871 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt7e9de862021-03-26 14:01:49 +0000872 if !dh.isSkipOnuConfigReconciling() {
873 dh.stopReconciling(ctx)
874 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000875 return
876 }
877 if dh.isSkipOnuConfigReconciling() {
878 dh.setDeviceReason(drTechProfileConfigDownloadSuccess)
879 }
880 if !flowsFound {
881 logger.Debugw(ctx, "reconciling - no flows have been stored before adapter restart - terminate reconcilement",
882 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt7e9de862021-03-26 14:01:49 +0000883 if !dh.isSkipOnuConfigReconciling() {
884 dh.stopReconciling(ctx)
885 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000886 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000887}
888
dbainbri4d3a0dc2020-12-02 00:33:42 +0000889func (dh *deviceHandler) reconcileDeviceFlowConfig(ctx context.Context) {
890 logger.Debugw(ctx, "reconciling - trigger flow config", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000891
dbainbri4d3a0dc2020-12-02 00:33:42 +0000892 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000893 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000894 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt7e9de862021-03-26 14:01:49 +0000895 if !dh.isSkipOnuConfigReconciling() {
896 dh.stopReconciling(ctx)
897 }
Holger Hildebrandtf41a1602020-08-19 09:52:50 +0000898 return
899 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000900 pDevEntry.mutexPersOnuConfig.RLock()
901 defer pDevEntry.mutexPersOnuConfig.RUnlock()
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000902
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000903 if len(pDevEntry.sOnuPersistentData.PersUniConfig) == 0 {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000904 logger.Debugw(ctx, "reconciling - no uni-configs have been stored before adapter restart - terminate reconcilement",
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000905 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt7e9de862021-03-26 14:01:49 +0000906 if !dh.isSkipOnuConfigReconciling() {
907 dh.stopReconciling(ctx)
908 }
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000909 return
910 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000911 flowsFound := false
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000912 for _, uniData := range pDevEntry.sOnuPersistentData.PersUniConfig {
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000913 //TODO: check for uni-port specific reconcilement in case of multi-uni-port-per-onu-support
914 if len(uniData.PersFlowParams) == 0 {
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000915 logger.Debugw(ctx, "reconciling - no flows stored for uniID",
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000916 log.Fields{"uni-id": uniData.PersUniID, "device-id": dh.deviceID})
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000917 continue
918 }
919 if len(uniData.PersTpPathMap) == 0 {
920 logger.Warnw(ctx, "reconciling - flows but no TPs stored for uniID",
921 log.Fields{"uni-id": uniData.PersUniID, "device-id": dh.deviceID})
Holger Hildebrandt7e9de862021-03-26 14:01:49 +0000922 // It doesn't make sense to configure any flows if no TPs are available
923 continue
Holger Hildebrandt3a644642020-12-02 09:46:18 +0000924 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000925 var uniPort *onuUniPort
926 var exist bool
dbainbri4d3a0dc2020-12-02 00:33:42 +0000927 uniNo := mkUniPortNum(ctx, dh.pOnuIndication.GetIntfId(), dh.pOnuIndication.GetOnuId(), uint32(uniData.PersUniID))
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000928 if uniPort, exist = dh.uniEntityMap[uniNo]; !exist {
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000929 logger.Errorw(ctx, "reconciling - onuUniPort data not found - terminate reconcilement",
930 log.Fields{"uniNo": uniNo, "device-id": dh.deviceID})
Holger Hildebrandt7e9de862021-03-26 14:01:49 +0000931 if !dh.isSkipOnuConfigReconciling() {
932 dh.stopReconciling(ctx)
933 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000934 return
935 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000936 flowsFound = true
937 flowsProcessed := 0
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +0000938 dh.setReconcilingFlows(true)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000939 for _, flowData := range uniData.PersFlowParams {
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000940 logger.Debugw(ctx, "reconciling - add flow with cookie slice", log.Fields{"device-id": dh.deviceID, "cookies": flowData.CookieSlice})
mpagenko01e726e2020-10-23 09:45:29 +0000941 //the slice can be passed 'by value' here, - which internally passes its reference copy
mpagenkof1fc3862021-02-16 10:09:52 +0000942 dh.lockVlanConfig.RLock()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000943 if _, exist = dh.UniVlanConfigFsmMap[uniData.PersUniID]; exist {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000944 if err := dh.UniVlanConfigFsmMap[uniData.PersUniID].SetUniFlowParams(ctx, flowData.VlanRuleParams.TpID,
mpagenko01e726e2020-10-23 09:45:29 +0000945 flowData.CookieSlice, uint16(flowData.VlanRuleParams.MatchVid), uint16(flowData.VlanRuleParams.SetVid),
946 uint8(flowData.VlanRuleParams.SetPcp)); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000947 logger.Errorw(ctx, err.Error(), log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000948 }
mpagenkof1fc3862021-02-16 10:09:52 +0000949 dh.lockVlanConfig.RUnlock()
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000950 } else {
mpagenkof1fc3862021-02-16 10:09:52 +0000951 dh.lockVlanConfig.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +0000952 if err := dh.createVlanFilterFsm(ctx, uniPort, flowData.VlanRuleParams.TpID, flowData.CookieSlice,
mpagenko01e726e2020-10-23 09:45:29 +0000953 uint16(flowData.VlanRuleParams.MatchVid), uint16(flowData.VlanRuleParams.SetVid),
mpagenkofc4f56e2020-11-04 17:17:49 +0000954 uint8(flowData.VlanRuleParams.SetPcp), OmciVlanFilterAddDone); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000955 logger.Errorw(ctx, err.Error(), log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000956 }
957 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000958 flowsProcessed++
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000959 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000960 logger.Debugw(ctx, "reconciling - flows processed", log.Fields{"device-id": dh.deviceID, "flowsProcessed": flowsProcessed,
961 "numUniFlows": dh.UniVlanConfigFsmMap[uniData.PersUniID].numUniFlows,
962 "configuredUniFlow": dh.UniVlanConfigFsmMap[uniData.PersUniID].configuredUniFlow})
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +0000963 dh.setReconcilingFlows(false)
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000964 }
965 if !flowsFound {
966 logger.Debugw(ctx, "reconciling - no flows have been stored before adapter restart - terminate reconcilement",
967 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt7e9de862021-03-26 14:01:49 +0000968 if !dh.isSkipOnuConfigReconciling() {
969 dh.stopReconciling(ctx)
970 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000971 return
972 }
973 if dh.isSkipOnuConfigReconciling() {
974 dh.setDeviceReason(drOmciFlowsPushed)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000975 }
976}
977
Holger Hildebrandt1b8f4ad2021-03-25 15:53:51 +0000978func (dh *deviceHandler) reconcileEnd(ctx context.Context) {
979 logger.Debugw(ctx, "reconciling - completed!", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +0000980 dh.stopReconciling(ctx)
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000981}
982
dbainbri4d3a0dc2020-12-02 00:33:42 +0000983func (dh *deviceHandler) deleteDevicePersistencyData(ctx context.Context) error {
984 logger.Debugw(ctx, "delete device persistency data", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000985
dbainbri4d3a0dc2020-12-02 00:33:42 +0000986 pDevEntry := dh.getOnuDeviceEntry(ctx, false)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000987 if pDevEntry == nil {
mpagenko2418ab02020-11-12 12:58:06 +0000988 //IfDevEntry does not exist here, no problem - no persistent data should have been stored
dbainbri4d3a0dc2020-12-02 00:33:42 +0000989 logger.Debugw(ctx, "OnuDevice does not exist - nothing to delete", log.Fields{"device-id": dh.deviceID})
mpagenko2418ab02020-11-12 12:58:06 +0000990 return nil
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +0000991 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000992
993 // deadline context to ensure completion of background routines waited for
994 //20200721: 10s proved to be less in 8*8 ONU test on local vbox machine with debug, might be further adapted
Himani Chawlad96df182020-09-28 11:12:02 +0530995 deadline := time.Now().Add(dh.pOpenOnuAc.maxTimeoutInterAdapterComm) //allowed run time to finish before execution
dbainbri4d3a0dc2020-12-02 00:33:42 +0000996 dctx, cancel := context.WithDeadline(ctx, deadline)
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000997
998 pDevEntry.resetKvProcessingErrorIndication()
999
1000 var wg sync.WaitGroup
1001 wg.Add(1) // for the 1 go routine to finish
dbainbri4d3a0dc2020-12-02 00:33:42 +00001002 go pDevEntry.deleteDataFromOnuKvStore(log.WithSpanFromContext(dctx, ctx), &wg)
1003 dh.waitForCompletion(ctx, cancel, &wg, "DeleteDevice") //wait for background process to finish
Holger Hildebrandt47555e72020-09-21 11:07:24 +00001004
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +00001005 // TODO: further actions - stop metrics and FSMs, remove device ...
Holger Hildebrandt47555e72020-09-21 11:07:24 +00001006 return pDevEntry.getKvProcessingErrorIndication()
Holger Hildebrandt9ca8b132020-08-07 14:45:03 +00001007}
1008
mpagenko15ff4a52021-03-02 10:09:20 +00001009//func (dh *deviceHandler) rebootDevice(ctx context.Context, device *voltha.Device) error {
1010// before this change here return like this was used:
1011// return fmt.Errorf("device-unreachable: %s, %s", dh.deviceID, device.SerialNumber)
1012//was and is called in background - error return does not make sense
1013func (dh *deviceHandler) rebootDevice(ctx context.Context, aCheckDeviceState bool, device *voltha.Device) {
1014 logger.Infow(ctx, "reboot-device", log.Fields{"device-id": dh.deviceID, "SerialNumber": dh.device.SerialNumber})
1015 if aCheckDeviceState && device.ConnectStatus != voltha.ConnectStatus_REACHABLE {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001016 logger.Errorw(ctx, "device-unreachable", log.Fields{"device-id": device.Id, "SerialNumber": device.SerialNumber})
mpagenko15ff4a52021-03-02 10:09:20 +00001017 return
ozgecanetsiae11479f2020-07-06 09:44:47 +03001018 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001019 if err := dh.pOnuOmciDevice.reboot(log.WithSpanFromContext(context.TODO(), ctx)); err != nil {
Himani Chawla4d908332020-08-31 12:30:20 +05301020 //TODO with VOL-3045/VOL-3046: return the error and stop further processing
dbainbri4d3a0dc2020-12-02 00:33:42 +00001021 logger.Errorw(ctx, "error-rebooting-device", log.Fields{"device-id": dh.deviceID, "error": err})
mpagenko15ff4a52021-03-02 10:09:20 +00001022 return
Himani Chawla4d908332020-08-31 12:30:20 +05301023 }
mpagenko01e726e2020-10-23 09:45:29 +00001024
1025 //transfer the possibly modified logical uni port state
dbainbri4d3a0dc2020-12-02 00:33:42 +00001026 dh.disableUniPortStateUpdate(ctx)
mpagenko01e726e2020-10-23 09:45:29 +00001027
dbainbri4d3a0dc2020-12-02 00:33:42 +00001028 logger.Debugw(ctx, "call DeviceStateUpdate upon reboot", log.Fields{"ConnectStatus": voltha.ConnectStatus_REACHABLE,
Holger Hildebrandt8165eda2020-09-24 09:39:24 +00001029 "OperStatus": voltha.OperStatus_DISCOVERED, "device-id": dh.deviceID})
dbainbri4d3a0dc2020-12-02 00:33:42 +00001030 if err := dh.coreProxy.DeviceStateUpdate(log.WithSpanFromContext(context.TODO(), ctx), dh.deviceID, voltha.ConnectStatus_REACHABLE,
ozgecanetsiae11479f2020-07-06 09:44:47 +03001031 voltha.OperStatus_DISCOVERED); err != nil {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001032 //TODO with VOL-3045/VOL-3046: return the error and stop further processing
dbainbri4d3a0dc2020-12-02 00:33:42 +00001033 logger.Errorw(ctx, "error-updating-device-state", log.Fields{"device-id": dh.deviceID, "error": err})
mpagenko15ff4a52021-03-02 10:09:20 +00001034 return
ozgecanetsiae11479f2020-07-06 09:44:47 +03001035 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001036 if err := dh.deviceReasonUpdate(ctx, drRebooting, true); err != nil {
mpagenko15ff4a52021-03-02 10:09:20 +00001037 return
ozgecanetsiae11479f2020-07-06 09:44:47 +03001038 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001039 dh.setReadyForOmciConfig(false)
mpagenko8b07c1b2020-11-26 10:36:31 +00001040 //no specific activity to synchronize any internal FSM to the 'rebooted' state is explicitly done here
1041 // the expectation ids for a real device, that it will be synced with the expected following 'down' indication
1042 // as BBSIM does not support this testing requires explicite disable/enable device calls in which sequence also
1043 // all other FSM's should be synchronized again
ozgecanetsiae11479f2020-07-06 09:44:47 +03001044}
1045
mpagenkoc8bba412021-01-15 15:38:44 +00001046//doOnuSwUpgrade initiates the SW download transfer to the ONU and on success activates the (inactive) image
mpagenko80622a52021-02-09 16:53:23 +00001047func (dh *deviceHandler) doOnuSwUpgrade(ctx context.Context, apImageDsc *voltha.ImageDownload,
1048 apDownloadManager *adapterDownloadManager) error {
1049 logger.Debugw(ctx, "onuSwUpgrade requested", log.Fields{
mpagenkoc8bba412021-01-15 15:38:44 +00001050 "device-id": dh.deviceID, "image-name": (*apImageDsc).Name})
mpagenko80622a52021-02-09 16:53:23 +00001051
1052 var err error
mpagenko15ff4a52021-03-02 10:09:20 +00001053 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
1054 if pDevEntry == nil {
1055 logger.Errorw(ctx, "start Onu SW upgrade rejected: no valid OnuDevice", log.Fields{"device-id": dh.deviceID})
1056 return fmt.Errorf("start Onu SW upgrade rejected: no valid OnuDevice for device-id: %s", dh.deviceID)
1057 }
1058
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001059 if dh.isReadyForOmciConfig() {
mpagenko15ff4a52021-03-02 10:09:20 +00001060 var inactiveImageID uint16
1061 if inactiveImageID, err = pDevEntry.GetInactiveImageMeID(ctx); err == nil {
1062 dh.lockUpgradeFsm.Lock()
1063 defer dh.lockUpgradeFsm.Unlock()
1064 if dh.pOnuUpradeFsm == nil {
1065 err = dh.createOnuUpgradeFsm(ctx, pDevEntry, OmciOnuSwUpgradeDone)
1066 if err == nil {
1067 if err = dh.pOnuUpradeFsm.SetDownloadParams(ctx, inactiveImageID, apImageDsc, apDownloadManager); err != nil {
1068 logger.Errorw(ctx, "onu upgrade fsm could not set parameters", log.Fields{
1069 "device-id": dh.deviceID, "error": err})
1070 }
1071 } else {
1072 logger.Errorw(ctx, "onu upgrade fsm could not be created", log.Fields{
mpagenko80622a52021-02-09 16:53:23 +00001073 "device-id": dh.deviceID, "error": err})
1074 }
mpagenko15ff4a52021-03-02 10:09:20 +00001075 } else { //OnuSw upgrade already running - restart (with possible abort of running)
1076 logger.Debugw(ctx, "Onu SW upgrade already running - abort", log.Fields{"device-id": dh.deviceID})
1077 pUpgradeStatemachine := dh.pOnuUpradeFsm.pAdaptFsm.pFsm
1078 if pUpgradeStatemachine != nil {
1079 if err = pUpgradeStatemachine.Event(upgradeEvAbort); err != nil {
1080 logger.Errorw(ctx, "onu upgrade fsm could not abort a running processing", log.Fields{
1081 "device-id": dh.deviceID, "error": err})
1082 }
1083 err = fmt.Errorf("aborted Onu SW upgrade but not automatically started, try again, device-id: %s", dh.deviceID)
1084 //TODO!!!: wait for 'ready' to start and configure - see above SetDownloadParams()
1085 // for now a second start of download should work again
1086 } else { //should never occur
1087 logger.Errorw(ctx, "onu upgrade fsm inconsistent setup", log.Fields{
1088 "device-id": dh.deviceID})
1089 err = fmt.Errorf("onu upgrade fsm inconsistent setup, baseFsm invalid for device-id: %s", dh.deviceID)
mpagenko80622a52021-02-09 16:53:23 +00001090 }
mpagenko80622a52021-02-09 16:53:23 +00001091 }
mpagenko15ff4a52021-03-02 10:09:20 +00001092 } else {
1093 logger.Errorw(ctx, "start Onu SW upgrade rejected: no inactive image", log.Fields{
1094 "device-id": dh.deviceID, "error": err})
mpagenko80622a52021-02-09 16:53:23 +00001095 }
1096 } else {
mpagenko15ff4a52021-03-02 10:09:20 +00001097 logger.Errorw(ctx, "start Onu SW upgrade rejected: no active OMCI connection", log.Fields{"device-id": dh.deviceID})
1098 err = fmt.Errorf("start Onu SW upgrade rejected: no active OMCI connection for device-id: %s", dh.deviceID)
mpagenko80622a52021-02-09 16:53:23 +00001099 }
1100 return err
mpagenkoc8bba412021-01-15 15:38:44 +00001101}
1102
mpagenkoc26d4c02021-05-06 14:27:57 +00001103//onuSwUpgradeAfterDownload initiates the SW download transfer to the ONU with activate and commit options
1104// after the OnuImage has been downloaded to the adapter, called in background
1105func (dh *deviceHandler) onuSwUpgradeAfterDownload(ctx context.Context, apImageRequest *voltha.DeviceImageDownloadRequest,
1106 apDownloadManager *fileDownloadManager, aImageIdentifier string) {
1107
1108 var err error
1109 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
1110 if pDevEntry == nil {
1111 logger.Errorw(ctx, "start Onu SW upgrade rejected: no valid OnuDevice", log.Fields{"device-id": dh.deviceID})
1112 return
1113 }
1114
1115 var inactiveImageID uint16
1116 if inactiveImageID, err = pDevEntry.GetInactiveImageMeID(ctx); err == nil {
1117 logger.Debugw(ctx, "onuSwUpgrade requested", log.Fields{
1118 "device-id": dh.deviceID, "image-version": apImageRequest.Image.Version, "to onu-image": inactiveImageID})
1119 dh.lockUpgradeFsm.Lock()
1120 defer dh.lockUpgradeFsm.Unlock()
1121 if dh.pOnuUpradeFsm == nil {
1122 //OmciOnuSwUpgradeDone could be used to create some Kafka event with information on upgrade completion,
1123 // but none yet defined
1124 err = dh.createOnuUpgradeFsm(ctx, pDevEntry, OmciOnuSwUpgradeDone)
1125 if err == nil {
1126 if err = dh.pOnuUpradeFsm.SetDownloadParamsAfterDownload(ctx, inactiveImageID,
1127 apImageRequest, apDownloadManager, aImageIdentifier, dh.pOpenOnuAc.dlToOnuTimeout4M); err != nil {
1128 logger.Errorw(ctx, "onu upgrade fsm could not set parameters", log.Fields{
1129 "device-id": dh.deviceID, "error": err})
1130 return
1131 }
1132 } else {
1133 logger.Errorw(ctx, "onu upgrade fsm could not be created", log.Fields{
1134 "device-id": dh.deviceID, "error": err})
1135 }
1136 return
1137 }
1138 //OnuSw upgrade already running - restart (with possible abort of running)
1139 logger.Debugw(ctx, "Onu SW upgrade already running - abort", log.Fields{"device-id": dh.deviceID})
1140 pUpgradeStatemachine := dh.pOnuUpradeFsm.pAdaptFsm.pFsm
1141 if pUpgradeStatemachine != nil {
1142 if err = pUpgradeStatemachine.Event(upgradeEvAbort); err != nil {
1143 logger.Errorw(ctx, "onu upgrade fsm could not abort a running processing", log.Fields{
1144 "device-id": dh.deviceID, "error": err})
1145 return
1146 }
1147 //TODO!!!: wait for 'ready' to start and configure - see above SetDownloadParams()
1148 // for now a second start of download should work again - must still be initiated by user
1149 } else { //should never occur
1150 logger.Errorw(ctx, "onu upgrade fsm inconsistent setup", log.Fields{
1151 "device-id": dh.deviceID})
1152 }
1153 return
1154 }
1155 logger.Errorw(ctx, "start Onu SW upgrade rejected: no inactive image", log.Fields{
1156 "device-id": dh.deviceID, "error": err})
1157}
1158
1159//onuSwActivateRequest ensures activation of the requested image with commit options
1160func (dh *deviceHandler) onuSwActivateRequest(ctx context.Context, aVersion string, aCommitRequest bool) {
1161 var err error
1162 //SW activation for the ONU image may have two use cases, one of them is selected here according to following prioritization:
1163 // 1.) activation of the image for a started upgrade process (in case the running upgrade runs on the requested image)
1164 // 2.) activation of the inactive image
1165
1166 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
1167 if pDevEntry == nil {
1168 logger.Errorw(ctx, "Onu image activation rejected: no valid OnuDevice", log.Fields{"device-id": dh.deviceID})
1169 return
1170 }
1171 dh.lockUpgradeFsm.RLock()
1172 if dh.pOnuUpradeFsm != nil {
1173 dh.lockUpgradeFsm.RUnlock()
1174 onuVolthaDevice, getErr := dh.coreProxy.GetDevice(log.WithSpanFromContext(context.TODO(), ctx),
1175 dh.deviceID, dh.deviceID)
1176 if getErr != nil || onuVolthaDevice == nil {
1177 logger.Errorw(ctx, "Failed to fetch Onu device for image activation", log.Fields{"device-id": dh.deviceID, "err": getErr})
1178 return
1179 }
1180 // use the OnuVendor identification from this device for the internal unique name
1181 imageIdentifier := onuVolthaDevice.VendorId + aVersion //head on vendor ID of the ONU
1182 // 1.) check a started upgrade process and rely the activation request to it
1183 if err = dh.pOnuUpradeFsm.SetActivationParamsRunning(ctx, imageIdentifier, aCommitRequest); err != nil {
1184 logger.Errorw(ctx, "onu upgrade fsm did not accept activation while running", log.Fields{
1185 "device-id": dh.deviceID, "error": err})
1186 } else {
1187 logger.Debugw(ctx, "image activation acknowledged by onu upgrade processing", log.Fields{
1188 "device-id": dh.deviceID, "image-id": imageIdentifier})
1189 }
1190 //if some ONU upgrade is ongoing we do not accept some explicit ONU image-version related activation
1191 // (even though parameter setting is not accepted)
1192 return
1193 } //else
1194 dh.lockUpgradeFsm.RUnlock()
1195
1196 // 2.) check if requested image-version equals the inactive one and start its activation
1197 // (image version is not [yet] checked - would be possible, but with increased effort ...)
1198 var inactiveImageID uint16
1199 if inactiveImageID, err = pDevEntry.GetInactiveImageMeID(ctx); err != nil || inactiveImageID > 1 {
1200 logger.Errorw(ctx, "get inactive image failed", log.Fields{
1201 "device-id": dh.deviceID, "err": err, "image-id": inactiveImageID})
1202 return
1203 }
1204 err = dh.createOnuUpgradeFsm(ctx, pDevEntry, OmciOnuSwUpgradeDone)
1205 if err == nil {
1206 if err = dh.pOnuUpradeFsm.SetActivationParamsStart(ctx, aVersion,
1207 inactiveImageID, aCommitRequest); err != nil {
1208 logger.Errorw(ctx, "onu upgrade fsm did not accept activation to start", log.Fields{
1209 "device-id": dh.deviceID, "error": err})
1210 return
1211 }
1212 logger.Debugw(ctx, "inactive image activation acknowledged by onu upgrade", log.Fields{
1213 "device-id": dh.deviceID, "image-version": aVersion})
1214 return
1215 } //else
1216 logger.Errorw(ctx, "onu upgrade fsm could not be created", log.Fields{
1217 "device-id": dh.deviceID, "error": err})
1218}
1219
1220//onuSwCommitRequest ensures commitment of the requested image
1221func (dh *deviceHandler) onuSwCommitRequest(ctx context.Context, aVersion string) {
1222 var err error
1223 //SW commitment for the ONU image may have two use cases, one of them is selected here according to following prioritization:
1224 // 1.) commitment of the image for a started upgrade process (in case the running upgrade runs on the requested image)
1225 // 2.) commitment of the active image
1226
1227 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
1228 if pDevEntry == nil {
1229 logger.Errorw(ctx, "Onu image commitment rejected: no valid OnuDevice", log.Fields{"device-id": dh.deviceID})
1230 return
1231 }
1232 dh.lockUpgradeFsm.RLock()
1233 if dh.pOnuUpradeFsm != nil {
1234 dh.lockUpgradeFsm.RUnlock()
1235 onuVolthaDevice, getErr := dh.coreProxy.GetDevice(log.WithSpanFromContext(context.TODO(), ctx),
1236 dh.deviceID, dh.deviceID)
1237 if getErr != nil || onuVolthaDevice == nil {
1238 logger.Errorw(ctx, "Failed to fetch Onu device for image commitment", log.Fields{"device-id": dh.deviceID, "err": getErr})
1239 return
1240 }
1241 // use the OnuVendor identification from this device for the internal unique name
1242 imageIdentifier := onuVolthaDevice.VendorId + aVersion //head on vendor ID of the ONU
1243 // 1.) check a started upgrade process and rely the commitment request to it
1244 if err = dh.pOnuUpradeFsm.SetCommitmentParamsRunning(ctx, imageIdentifier); err != nil {
1245 logger.Errorw(ctx, "onu upgrade fsm did not accept commitment while running", log.Fields{
1246 "device-id": dh.deviceID, "error": err})
1247 } else {
1248 logger.Debugw(ctx, "image commitment acknowledged by onu upgrade processing", log.Fields{
1249 "device-id": dh.deviceID, "image-id": imageIdentifier})
1250 }
1251 //if some ONU upgrade is ongoing we do not accept some explicit ONU image-version related commitment
1252 // (even though parameter setting is not accepted)
1253 return
1254 } //else
1255 dh.lockUpgradeFsm.RUnlock()
1256
1257 // 2.) check if requested image-version equals the inactive one and start its commitment
1258 var activeImageID uint16
1259 if activeImageID, err = pDevEntry.GetActiveImageMeID(ctx); err != nil || activeImageID > 1 {
1260 logger.Errorw(ctx, "get active image failed", log.Fields{
1261 "device-id": dh.deviceID, "err": err, "image-id": activeImageID})
1262 return
1263 }
1264 err = dh.createOnuUpgradeFsm(ctx, pDevEntry, OmciOnuSwUpgradeDone)
1265 if err == nil {
1266 if err = dh.pOnuUpradeFsm.SetCommitmentParamsStart(ctx, aVersion, activeImageID); err != nil {
1267 logger.Errorw(ctx, "onu upgrade fsm did not accept commitment to start", log.Fields{
1268 "device-id": dh.deviceID, "error": err})
1269 return
1270 }
1271 logger.Debugw(ctx, "active image commitment acknowledged by onu upgrade", log.Fields{
1272 "device-id": dh.deviceID, "image-version": aVersion})
1273 return
1274 } //else
1275 logger.Errorw(ctx, "onu upgrade fsm could not be created", log.Fields{
1276 "device-id": dh.deviceID, "error": err})
1277}
1278
Himani Chawla6d2ae152020-09-02 13:11:20 +05301279// deviceHandler methods that implement the adapters interface requests## end #########
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001280// #####################################################################################
1281
1282// ################ to be updated acc. needs of ONU Device ########################
Himani Chawla6d2ae152020-09-02 13:11:20 +05301283// deviceHandler StateMachine related state transition methods ##### begin #########
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001284
dbainbri4d3a0dc2020-12-02 00:33:42 +00001285func (dh *deviceHandler) logStateChange(ctx context.Context, e *fsm.Event) {
1286 logger.Debugw(ctx, "Device FSM: ", log.Fields{"event name": string(e.Event), "src state": string(e.Src), "dst state": string(e.Dst), "device-id": dh.deviceID})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001287}
1288
1289// doStateInit provides the device update to the core
dbainbri4d3a0dc2020-12-02 00:33:42 +00001290func (dh *deviceHandler) doStateInit(ctx context.Context, e *fsm.Event) {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001291
dbainbri4d3a0dc2020-12-02 00:33:42 +00001292 logger.Debug(ctx, "doStateInit-started")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001293 var err error
1294
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001295 // populate what we know. rest comes later after mib sync
1296 dh.device.Root = false
1297 dh.device.Vendor = "OpenONU"
1298 dh.device.Model = "go"
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001299 dh.device.Reason = deviceReasonMap[drActivatingOnu]
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001300 dh.setDeviceReason(drActivatingOnu)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001301
Holger Hildebrandt24d51952020-05-04 14:03:42 +00001302 dh.logicalDeviceID = dh.deviceID // really needed - what for ??? //TODO!!!
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001303
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00001304 if !dh.isReconciling() {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001305 logger.Infow(ctx, "DeviceUpdate", log.Fields{"deviceReason": dh.device.Reason, "device-id": dh.deviceID})
1306 _ = dh.coreProxy.DeviceUpdate(log.WithSpanFromContext(context.TODO(), ctx), dh.device)
Himani Chawlac07fda02020-12-09 16:21:21 +05301307 //TODO Need to Update Device Reason To CORE as part of device update userstory
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001308 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001309 logger.Debugw(ctx, "reconciling - don't notify core about DeviceUpdate",
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001310 log.Fields{"device-id": dh.deviceID})
1311 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001312
Himani Chawla4d908332020-08-31 12:30:20 +05301313 dh.parentID = dh.device.ParentId
Holger Hildebrandt24d51952020-05-04 14:03:42 +00001314 dh.ponPortNumber = dh.device.ParentPortNo
1315
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001316 // store proxy parameters for later communication - assumption: invariant, else they have to be requested dynamically!!
1317 dh.ProxyAddressID = dh.device.ProxyAddress.GetDeviceId()
1318 dh.ProxyAddressType = dh.device.ProxyAddress.GetDeviceType()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001319 logger.Debugw(ctx, "device-updated", log.Fields{"device-id": dh.deviceID, "proxyAddressID": dh.ProxyAddressID,
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001320 "proxyAddressType": dh.ProxyAddressType, "SNR": dh.device.SerialNumber,
Himani Chawla4d908332020-08-31 12:30:20 +05301321 "ParentId": dh.parentID, "ParentPortNo": dh.ponPortNumber})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001322
1323 /*
1324 self._pon = PonPort.create(self, self._pon_port_number)
1325 self._pon.add_peer(self.parent_id, self._pon_port_number)
1326 self.logger.debug('adding-pon-port-to-agent',
1327 type=self._pon.get_port().type,
1328 admin_state=self._pon.get_port().admin_state,
1329 oper_status=self._pon.get_port().oper_status,
1330 )
1331 */
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00001332 if !dh.isReconciling() {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001333 logger.Debugw(ctx, "adding-pon-port", log.Fields{"device-id": dh.deviceID, "ponPortNo": dh.ponPortNumber})
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001334 var ponPortNo uint32 = 1
1335 if dh.ponPortNumber != 0 {
1336 ponPortNo = dh.ponPortNumber
1337 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001338
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001339 pPonPort := &voltha.Port{
1340 PortNo: ponPortNo,
1341 Label: fmt.Sprintf("pon-%d", ponPortNo),
1342 Type: voltha.Port_PON_ONU,
1343 OperStatus: voltha.OperStatus_ACTIVE,
Himani Chawla4d908332020-08-31 12:30:20 +05301344 Peers: []*voltha.Port_PeerPort{{DeviceId: dh.parentID, // Peer device is OLT
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001345 PortNo: ponPortNo}}, // Peer port is parent's port number
1346 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001347 if err = dh.coreProxy.PortCreated(log.WithSpanFromContext(context.TODO(), ctx), dh.deviceID, pPonPort); err != nil {
1348 logger.Fatalf(ctx, "Device FSM: PortCreated-failed-%s", err)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001349 e.Cancel(err)
1350 return
1351 }
1352 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001353 logger.Debugw(ctx, "reconciling - pon-port already added", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001354 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001355 logger.Debug(ctx, "doStateInit-done")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001356}
1357
1358// postInit setups the DeviceEntry for the conerned device
dbainbri4d3a0dc2020-12-02 00:33:42 +00001359func (dh *deviceHandler) postInit(ctx context.Context, e *fsm.Event) {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001360
dbainbri4d3a0dc2020-12-02 00:33:42 +00001361 logger.Debug(ctx, "postInit-started")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001362 var err error
1363 /*
1364 dh.Client = oop.NewOpenoltClient(dh.clientCon)
1365 dh.pTransitionMap.Handle(ctx, GrpcConnected)
1366 return nil
1367 */
dbainbri4d3a0dc2020-12-02 00:33:42 +00001368 if err = dh.addOnuDeviceEntry(log.WithSpanFromContext(context.TODO(), ctx)); err != nil {
1369 logger.Fatalf(ctx, "Device FSM: addOnuDeviceEntry-failed-%s", err)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001370 e.Cancel(err)
1371 return
1372 }
1373
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00001374 if dh.isReconciling() {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001375 go dh.reconcileDeviceOnuInd(ctx)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001376 // reconcilement will be continued after mib download is done
1377 }
Girish Gowdrae09a6202021-01-12 18:10:59 -08001378
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001379 /*
1380 ############################################################################
1381 # Setup Alarm handler
1382 self.events = AdapterEvents(self.core_proxy, device.id, self.logical_device_id,
1383 device.serial_number)
1384 ############################################################################
1385 # Setup PM configuration for this device
1386 # Pass in ONU specific options
1387 kwargs = {
1388 OnuPmMetrics.DEFAULT_FREQUENCY_KEY: OnuPmMetrics.DEFAULT_ONU_COLLECTION_FREQUENCY,
1389 'heartbeat': self.heartbeat,
1390 OnuOmciPmMetrics.OMCI_DEV_KEY: self._onu_omci_device
1391 }
1392 self.logger.debug('create-pm-metrics', device_id=device.id, serial_number=device.serial_number)
1393 self._pm_metrics = OnuPmMetrics(self.events, self.core_proxy, self.device_id,
1394 self.logical_device_id, device.serial_number,
1395 grouped=True, freq_override=False, **kwargs)
1396 pm_config = self._pm_metrics.make_proto()
1397 self._onu_omci_device.set_pm_config(self._pm_metrics.omci_pm.openomci_interval_pm)
1398 self.logger.info("initial-pm-config", device_id=device.id, serial_number=device.serial_number)
1399 yield self.core_proxy.device_pm_config_update(pm_config, init=True)
1400
1401 # Note, ONU ID and UNI intf set in add_uni_port method
1402 self._onu_omci_device.alarm_synchronizer.set_alarm_params(mgr=self.events,
1403 ani_ports=[self._pon])
1404
1405 # Code to Run OMCI Test Action
1406 kwargs_omci_test_action = {
1407 OmciTestRequest.DEFAULT_FREQUENCY_KEY:
1408 OmciTestRequest.DEFAULT_COLLECTION_FREQUENCY
1409 }
1410 serial_number = device.serial_number
1411 self._test_request = OmciTestRequest(self.core_proxy,
1412 self.omci_agent, self.device_id,
1413 AniG, serial_number,
1414 self.logical_device_id,
1415 exclusive=False,
1416 **kwargs_omci_test_action)
1417
1418 self.enabled = True
1419 else:
1420 self.logger.info('onu-already-activated')
1421 */
Girish Gowdrae09a6202021-01-12 18:10:59 -08001422
dbainbri4d3a0dc2020-12-02 00:33:42 +00001423 logger.Debug(ctx, "postInit-done")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001424}
1425
1426// doStateConnected get the device info and update to voltha core
1427// for comparison of the original method (not that easy to uncomment): compare here:
1428// voltha-openolt-adapter/adaptercore/device_handler.go
1429// -> this one obviously initiates all communication interfaces of the device ...?
dbainbri4d3a0dc2020-12-02 00:33:42 +00001430func (dh *deviceHandler) doStateConnected(ctx context.Context, e *fsm.Event) {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001431
dbainbri4d3a0dc2020-12-02 00:33:42 +00001432 logger.Debug(ctx, "doStateConnected-started")
Himani Chawla4d908332020-08-31 12:30:20 +05301433 err := errors.New("device FSM: function not implemented yet")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001434 e.Cancel(err)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001435 logger.Debug(ctx, "doStateConnected-done")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001436}
1437
1438// doStateUp handle the onu up indication and update to voltha core
dbainbri4d3a0dc2020-12-02 00:33:42 +00001439func (dh *deviceHandler) doStateUp(ctx context.Context, e *fsm.Event) {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001440
dbainbri4d3a0dc2020-12-02 00:33:42 +00001441 logger.Debug(ctx, "doStateUp-started")
Himani Chawla4d908332020-08-31 12:30:20 +05301442 err := errors.New("device FSM: function not implemented yet")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001443 e.Cancel(err)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001444 logger.Debug(ctx, "doStateUp-done")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001445
1446 /*
1447 // Synchronous call to update device state - this method is run in its own go routine
1448 if err := dh.coreProxy.DeviceStateUpdate(ctx, dh.device.Id, voltha.ConnectStatus_REACHABLE,
1449 voltha.OperStatus_ACTIVE); err != nil {
mpagenko01e726e2020-10-23 09:45:29 +00001450 logger.Errorw("Failed to update device with OLT UP indication", log.Fields{"device-id": dh.device.Id, "error": err})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001451 return err
1452 }
1453 return nil
1454 */
1455}
1456
1457// doStateDown handle the onu down indication
dbainbri4d3a0dc2020-12-02 00:33:42 +00001458func (dh *deviceHandler) doStateDown(ctx context.Context, e *fsm.Event) {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001459
dbainbri4d3a0dc2020-12-02 00:33:42 +00001460 logger.Debug(ctx, "doStateDown-started")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001461 var err error
1462
Holger Hildebrandt24d51952020-05-04 14:03:42 +00001463 device := dh.device
1464 if device == nil {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001465 /*TODO: needs to handle error scenarios */
dbainbri4d3a0dc2020-12-02 00:33:42 +00001466 logger.Errorw(ctx, "Failed to fetch handler device", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001467 e.Cancel(err)
1468 return
1469 }
1470
1471 cloned := proto.Clone(device).(*voltha.Device)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001472 logger.Debugw(ctx, "do-state-down", log.Fields{"ClonedDeviceID": cloned.Id})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001473 /*
1474 // Update the all ports state on that device to disable
1475 if er := dh.coreProxy.PortsStateUpdate(ctx, cloned.Id, voltha.OperStatus_UNKNOWN); er != nil {
mpagenko01e726e2020-10-23 09:45:29 +00001476 logger.Errorw("updating-ports-failed", log.Fields{"device-id": device.Id, "error": er})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001477 return er
1478 }
1479
1480 //Update the device oper state and connection status
1481 cloned.OperStatus = voltha.OperStatus_UNKNOWN
1482 cloned.ConnectStatus = common.ConnectStatus_UNREACHABLE
1483 dh.device = cloned
1484
1485 if er := dh.coreProxy.DeviceStateUpdate(ctx, cloned.Id, cloned.ConnectStatus, cloned.OperStatus); er != nil {
mpagenko01e726e2020-10-23 09:45:29 +00001486 logger.Errorw("error-updating-device-state", log.Fields{"device-id": device.Id, "error": er})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001487 return er
1488 }
1489
1490 //get the child device for the parent device
1491 onuDevices, err := dh.coreProxy.GetChildDevices(ctx, dh.device.Id)
1492 if err != nil {
mpagenko01e726e2020-10-23 09:45:29 +00001493 logger.Errorw("failed to get child devices information", log.Fields{"device-id": dh.device.Id, "error": err})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001494 return err
1495 }
1496 for _, onuDevice := range onuDevices.Items {
1497
1498 // Update onu state as down in onu adapter
1499 onuInd := oop.OnuIndication{}
1500 onuInd.OperState = "down"
1501 er := dh.AdapterProxy.SendInterAdapterMessage(ctx, &onuInd, ic.InterAdapterMessageType_ONU_IND_REQUEST,
1502 "openolt", onuDevice.Type, onuDevice.Id, onuDevice.ProxyAddress.DeviceId, "")
1503 if er != nil {
1504 logger.Errorw("Failed to send inter-adapter-message", log.Fields{"OnuInd": onuInd,
mpagenko01e726e2020-10-23 09:45:29 +00001505 "From Adapter": "openolt", "DevieType": onuDevice.Type, "device-id": onuDevice.Id})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001506 //Do not return here and continue to process other ONUs
1507 }
1508 }
1509 // * Discovered ONUs entries need to be cleared , since after OLT
1510 // is up, it starts sending discovery indications again* /
1511 dh.discOnus = sync.Map{}
mpagenko01e726e2020-10-23 09:45:29 +00001512 logger.Debugw("do-state-down-end", log.Fields{"device-id": device.Id})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001513 return nil
1514 */
Himani Chawla4d908332020-08-31 12:30:20 +05301515 err = errors.New("device FSM: function not implemented yet")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001516 e.Cancel(err)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001517 logger.Debug(ctx, "doStateDown-done")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001518}
1519
Himani Chawla6d2ae152020-09-02 13:11:20 +05301520// deviceHandler StateMachine related state transition methods ##### end #########
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001521// #################################################################################
1522
1523// ###################################################
Himani Chawla6d2ae152020-09-02 13:11:20 +05301524// deviceHandler utility methods ##### begin #########
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001525
Holger Hildebrandt47555e72020-09-21 11:07:24 +00001526//getOnuDeviceEntry gets the ONU device entry and may wait until its value is defined
dbainbri4d3a0dc2020-12-02 00:33:42 +00001527func (dh *deviceHandler) getOnuDeviceEntry(ctx context.Context, aWait bool) *OnuDeviceEntry {
mpagenko3af1f032020-06-10 08:53:41 +00001528 dh.lockDevice.RLock()
1529 pOnuDeviceEntry := dh.pOnuOmciDevice
1530 if aWait && pOnuDeviceEntry == nil {
1531 //keep the read sema short to allow for subsequent write
1532 dh.lockDevice.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001533 logger.Debugw(ctx, "Waiting for DeviceEntry to be set ...", log.Fields{"device-id": dh.deviceID})
mpagenko3af1f032020-06-10 08:53:41 +00001534 // based on concurrent processing the deviceEntry setup may not yet be finished at his point
1535 // so it might be needed to wait here for that event with some timeout
1536 select {
1537 case <-time.After(60 * time.Second): //timer may be discussed ...
dbainbri4d3a0dc2020-12-02 00:33:42 +00001538 logger.Errorw(ctx, "No valid DeviceEntry set after maxTime", log.Fields{"device-id": dh.deviceID})
mpagenko3af1f032020-06-10 08:53:41 +00001539 return nil
1540 case <-dh.deviceEntrySet:
dbainbri4d3a0dc2020-12-02 00:33:42 +00001541 logger.Debugw(ctx, "devicEntry ready now - continue", log.Fields{"device-id": dh.deviceID})
mpagenko3af1f032020-06-10 08:53:41 +00001542 // if written now, we can return the written value without sema
1543 return dh.pOnuOmciDevice
1544 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001545 }
mpagenko3af1f032020-06-10 08:53:41 +00001546 dh.lockDevice.RUnlock()
1547 return pOnuDeviceEntry
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001548}
1549
Himani Chawla6d2ae152020-09-02 13:11:20 +05301550//setOnuDeviceEntry sets the ONU device entry within the handler
1551func (dh *deviceHandler) setOnuDeviceEntry(
Girish Gowdra6afb56a2021-04-27 17:47:57 -07001552 apDeviceEntry *OnuDeviceEntry, apOnuTp *onuUniTechProf, apOnuMetricsMgr *onuMetricsManager, apOnuAlarmMgr *onuAlarmManager, apSelfTestHdlr *selfTestControlBlock) {
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001553 dh.lockDevice.Lock()
1554 defer dh.lockDevice.Unlock()
mpagenkoaf801632020-07-03 10:00:42 +00001555 dh.pOnuOmciDevice = apDeviceEntry
1556 dh.pOnuTP = apOnuTp
Girish Gowdrae09a6202021-01-12 18:10:59 -08001557 dh.pOnuMetricsMgr = apOnuMetricsMgr
Himani Chawlaac1f5ad2021-02-04 21:21:54 +05301558 dh.pAlarmMgr = apOnuAlarmMgr
Girish Gowdra6afb56a2021-04-27 17:47:57 -07001559 dh.pSelfTestHdlr = apSelfTestHdlr
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001560}
1561
Himani Chawla6d2ae152020-09-02 13:11:20 +05301562//addOnuDeviceEntry creates a new ONU device or returns the existing
1563func (dh *deviceHandler) addOnuDeviceEntry(ctx context.Context) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001564 logger.Debugw(ctx, "adding-deviceEntry", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001565
dbainbri4d3a0dc2020-12-02 00:33:42 +00001566 deviceEntry := dh.getOnuDeviceEntry(ctx, false)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001567 if deviceEntry == nil {
1568 /* costum_me_map in python code seems always to be None,
1569 we omit that here first (declaration unclear) -> todo at Adapter specialization ...*/
1570 /* also no 'clock' argument - usage open ...*/
1571 /* and no alarm_db yet (oo.alarm_db) */
Holger Hildebrandt61b24d02020-11-16 13:36:40 +00001572 deviceEntry = newOnuDeviceEntry(ctx, dh)
mpagenko01e726e2020-10-23 09:45:29 +00001573 onuTechProfProc := newOnuUniTechProf(ctx, dh)
Girish Gowdrae09a6202021-01-12 18:10:59 -08001574 onuMetricsMgr := newonuMetricsManager(ctx, dh)
Himani Chawlaac1f5ad2021-02-04 21:21:54 +05301575 onuAlarmManager := newAlarmManager(ctx, dh)
Girish Gowdra6afb56a2021-04-27 17:47:57 -07001576 selfTestHdlr := newSelfTestMsgHandlerCb(ctx, dh)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001577 //error treatment possible //TODO!!!
Girish Gowdra6afb56a2021-04-27 17:47:57 -07001578 dh.setOnuDeviceEntry(deviceEntry, onuTechProfProc, onuMetricsMgr, onuAlarmManager, selfTestHdlr)
mpagenko3af1f032020-06-10 08:53:41 +00001579 // fire deviceEntry ready event to spread to possibly waiting processing
1580 dh.deviceEntrySet <- true
dbainbri4d3a0dc2020-12-02 00:33:42 +00001581 logger.Debugw(ctx, "onuDeviceEntry-added", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001582 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001583 logger.Debugw(ctx, "onuDeviceEntry-add: Device already exists", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001584 }
1585 // might be updated with some error handling !!!
1586 return nil
1587}
1588
dbainbri4d3a0dc2020-12-02 00:33:42 +00001589func (dh *deviceHandler) createInterface(ctx context.Context, onuind *oop.OnuIndication) error {
1590 logger.Debugw(ctx, "create_interface-started", log.Fields{"OnuId": onuind.GetOnuId(),
Holger Hildebrandt24d51952020-05-04 14:03:42 +00001591 "OnuIntfId": onuind.GetIntfId(), "OnuSerialNumber": onuind.GetSerialNumber()})
1592
1593 dh.pOnuIndication = onuind // let's revise if storing the pointer is sufficient...
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001594
dbainbri4d3a0dc2020-12-02 00:33:42 +00001595 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001596 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001597 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001598 return fmt.Errorf("no valid OnuDevice: %s", dh.deviceID)
1599 }
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00001600 if !dh.isReconciling() {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001601 if err := dh.storePersistentData(ctx); err != nil {
1602 logger.Warnw(ctx, "store persistent data error - continue as there will be additional write attempts",
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001603 log.Fields{"device-id": dh.deviceID, "err": err})
1604 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001605 logger.Debugw(ctx, "call DeviceStateUpdate upon create interface", log.Fields{"ConnectStatus": voltha.ConnectStatus_REACHABLE,
Holger Hildebrandt8165eda2020-09-24 09:39:24 +00001606 "OperStatus": voltha.OperStatus_ACTIVATING, "device-id": dh.deviceID})
dbainbri4d3a0dc2020-12-02 00:33:42 +00001607 if err := dh.coreProxy.DeviceStateUpdate(log.WithSpanFromContext(context.TODO(), ctx), dh.deviceID,
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001608 voltha.ConnectStatus_REACHABLE, voltha.OperStatus_ACTIVATING); err != nil {
1609 //TODO with VOL-3045/VOL-3046: return the error and stop further processing
dbainbri4d3a0dc2020-12-02 00:33:42 +00001610 logger.Errorw(ctx, "error-updating-device-state", log.Fields{"device-id": dh.deviceID, "error": err})
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001611 }
1612 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001613 logger.Debugw(ctx, "reconciling - don't notify core about DeviceStateUpdate to ACTIVATING",
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001614 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001615
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001616 pDevEntry.mutexPersOnuConfig.RLock()
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001617 if !pDevEntry.sOnuPersistentData.PersUniUnlockDone {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001618 pDevEntry.mutexPersOnuConfig.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001619 logger.Debugw(ctx, "reconciling - uni-ports were not unlocked before adapter restart - resume with a normal start-up",
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001620 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00001621 dh.stopReconciling(ctx)
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001622 } else {
1623 pDevEntry.mutexPersOnuConfig.RUnlock()
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001624 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001625 }
Holger Hildebrandt24d51952020-05-04 14:03:42 +00001626 // It does not look to me as if makes sense to work with the real core device here, (not the stored clone)?
1627 // in this code the GetDevice would just make a check if the DeviceID's Device still exists in core
1628 // in python code it looks as the started onu_omci_device might have been updated with some new instance state of the core device
mpagenkoaf801632020-07-03 10:00:42 +00001629 // but I would not know why, and the go code anyway does not work with the device directly anymore in the OnuDeviceEntry
Holger Hildebrandt24d51952020-05-04 14:03:42 +00001630 // so let's just try to keep it simple ...
1631 /*
dbainbri4d3a0dc2020-12-02 00:33:42 +00001632 device, err := dh.coreProxy.GetDevice(log.WithSpanFromContext(context.TODO(), ctx), dh.device.Id, dh.device.Id)
Holger Hildebrandt24d51952020-05-04 14:03:42 +00001633 if err != nil || device == nil {
1634 //TODO: needs to handle error scenarios
1635 logger.Errorw("Failed to fetch device device at creating If", log.Fields{"err": err})
1636 return errors.New("Voltha Device not found")
1637 }
1638 */
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001639
dbainbri4d3a0dc2020-12-02 00:33:42 +00001640 if err := pDevEntry.start(log.WithSpanFromContext(context.TODO(), ctx)); err != nil {
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001641 return err
mpagenko3af1f032020-06-10 08:53:41 +00001642 }
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001643
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00001644 _ = dh.deviceReasonUpdate(ctx, drStartingOpenomci, !dh.isReconciling())
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001645
1646 /* this might be a good time for Omci Verify message? */
1647 verifyExec := make(chan bool)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001648 omciVerify := newOmciTestRequest(log.WithSpanFromContext(context.TODO(), ctx),
mpagenko3af1f032020-06-10 08:53:41 +00001649 dh.device.Id, pDevEntry.PDevOmciCC,
mpagenko900ee4b2020-10-12 11:56:34 +00001650 true, true) //exclusive and allowFailure (anyway not yet checked)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001651 omciVerify.performOmciTest(log.WithSpanFromContext(context.TODO(), ctx), verifyExec)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001652
1653 /* give the handler some time here to wait for the OMCi verification result
1654 after Timeout start and try MibUpload FSM anyway
1655 (to prevent stopping on just not supported OMCI verification from ONU) */
1656 select {
Holger Hildebrandt366ef192021-05-05 11:07:44 +00001657 case <-time.After(pDevEntry.PDevOmciCC.GetMaxOmciTimeoutWithRetries() * time.Second):
dbainbri4d3a0dc2020-12-02 00:33:42 +00001658 logger.Warn(ctx, "omci start-verification timed out (continue normal)")
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001659 case testresult := <-verifyExec:
dbainbri4d3a0dc2020-12-02 00:33:42 +00001660 logger.Infow(ctx, "Omci start verification done", log.Fields{"result": testresult})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001661 }
1662
1663 /* In py code it looks earlier (on activate ..)
1664 # Code to Run OMCI Test Action
1665 kwargs_omci_test_action = {
1666 OmciTestRequest.DEFAULT_FREQUENCY_KEY:
1667 OmciTestRequest.DEFAULT_COLLECTION_FREQUENCY
1668 }
1669 serial_number = device.serial_number
1670 self._test_request = OmciTestRequest(self.core_proxy,
1671 self.omci_agent, self.device_id,
1672 AniG, serial_number,
1673 self.logical_device_id,
1674 exclusive=False,
1675 **kwargs_omci_test_action)
1676 ...
1677 # Start test requests after a brief pause
1678 if not self._test_request_started:
1679 self._test_request_started = True
1680 tststart = _STARTUP_RETRY_WAIT * (random.randint(1, 5))
1681 reactor.callLater(tststart, self._test_request.start_collector)
1682
1683 */
1684 /* which is then: in omci_test_request.py : */
1685 /*
1686 def start_collector(self, callback=None):
1687 """
1688 Start the collection loop for an adapter if the frequency > 0
1689
1690 :param callback: (callable) Function to call to collect PM data
1691 """
1692 self.logger.info("starting-pm-collection", device_name=self.name, default_freq=self.default_freq)
1693 if callback is None:
1694 callback = self.perform_test_omci
1695
1696 if self.lc is None:
1697 self.lc = LoopingCall(callback)
1698
1699 if self.default_freq > 0:
1700 self.lc.start(interval=self.default_freq / 10)
1701
1702 def perform_test_omci(self):
1703 """
1704 Perform the initial test request
1705 """
1706 ani_g_entities = self._device.configuration.ani_g_entities
1707 ani_g_entities_ids = list(ani_g_entities.keys()) if ani_g_entities \
1708 is not None else None
1709 self._entity_id = ani_g_entities_ids[0]
1710 self.logger.info('perform-test', entity_class=self._entity_class,
1711 entity_id=self._entity_id)
1712 try:
1713 frame = MEFrame(self._entity_class, self._entity_id, []).test()
1714 result = yield self._device.omci_cc.send(frame)
1715 if not result.fields['omci_message'].fields['success_code']:
1716 self.logger.info('Self-Test Submitted Successfully',
1717 code=result.fields[
1718 'omci_message'].fields['success_code'])
1719 else:
1720 raise TestFailure('Test Failure: {}'.format(
1721 result.fields['omci_message'].fields['success_code']))
1722 except TimeoutError as e:
1723 self.deferred.errback(failure.Failure(e))
1724
1725 except Exception as e:
1726 self.logger.exception('perform-test-Error', e=e,
1727 class_id=self._entity_class,
1728 entity_id=self._entity_id)
1729 self.deferred.errback(failure.Failure(e))
1730
1731 */
1732
1733 // PM related heartbeat??? !!!TODO....
1734 //self._heartbeat.enabled = True
1735
mpagenko1cc3cb42020-07-27 15:24:38 +00001736 /* Note: Even though FSM calls look 'synchronous' here, FSM is running in background with the effect that possible errors
1737 * within the MibUpload are not notified in the OnuIndication response, this might be acceptable here,
1738 * as further OltAdapter processing may rely on the deviceReason event 'MibUploadDone' as a result of the FSM processing
Himani Chawla4d908332020-08-31 12:30:20 +05301739 * otherwise some processing synchronization would be required - cmp. e.g TechProfile processing
mpagenko1cc3cb42020-07-27 15:24:38 +00001740 */
1741 //call MibUploadFSM - transition up to state ulStInSync
mpagenko3af1f032020-06-10 08:53:41 +00001742 pMibUlFsm := pDevEntry.pMibUploadFsm.pFsm
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +00001743 if pMibUlFsm != nil {
mpagenko1cc3cb42020-07-27 15:24:38 +00001744 if pMibUlFsm.Is(ulStDisabled) {
1745 if err := pMibUlFsm.Event(ulEvStart); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001746 logger.Errorw(ctx, "MibSyncFsm: Can't go to state starting", log.Fields{"device-id": dh.deviceID, "err": err})
Holger Hildebrandt47555e72020-09-21 11:07:24 +00001747 return fmt.Errorf("can't go to state starting: %s", dh.deviceID)
Himani Chawla4d908332020-08-31 12:30:20 +05301748 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001749 logger.Debugw(ctx, "MibSyncFsm", log.Fields{"state": string(pMibUlFsm.Current())})
Himani Chawla4d908332020-08-31 12:30:20 +05301750 //Determine ONU status and start/re-start MIB Synchronization tasks
1751 //Determine if this ONU has ever synchronized
Holger Hildebrandt0bd45f82021-01-11 13:29:37 +00001752 if pDevEntry.isNewOnu() {
Himani Chawla4d908332020-08-31 12:30:20 +05301753 if err := pMibUlFsm.Event(ulEvResetMib); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001754 logger.Errorw(ctx, "MibSyncFsm: Can't go to state resetting_mib", log.Fields{"device-id": dh.deviceID, "err": err})
Holger Hildebrandt47555e72020-09-21 11:07:24 +00001755 return fmt.Errorf("can't go to state resetting_mib: %s", dh.deviceID)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001756 }
Himani Chawla4d908332020-08-31 12:30:20 +05301757 } else {
1758 if err := pMibUlFsm.Event(ulEvExamineMds); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001759 logger.Errorw(ctx, "MibSyncFsm: Can't go to state examine_mds", log.Fields{"device-id": dh.deviceID, "err": err})
Holger Hildebrandt47555e72020-09-21 11:07:24 +00001760 return fmt.Errorf("can't go to examine_mds: %s", dh.deviceID)
Himani Chawla4d908332020-08-31 12:30:20 +05301761 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001762 logger.Debugw(ctx, "state of MibSyncFsm", log.Fields{"state": string(pMibUlFsm.Current())})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001763 }
Holger Hildebrandt9ac0d0f2020-05-13 11:22:02 +00001764 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001765 logger.Errorw(ctx, "wrong state of MibSyncFsm - want: disabled", log.Fields{"have": string(pMibUlFsm.Current()),
mpagenko01e726e2020-10-23 09:45:29 +00001766 "device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +00001767 return fmt.Errorf("wrong state of MibSyncFsm: %s", dh.deviceID)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001768 }
1769 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001770 logger.Errorw(ctx, "MibSyncFsm invalid - cannot be executed!!", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +00001771 return fmt.Errorf("can't execute MibSync: %s", dh.deviceID)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001772 }
Girish Gowdrae09a6202021-01-12 18:10:59 -08001773
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001774 if !dh.getCollectorIsRunning() {
1775 // Start PM collector routine
1776 go dh.startCollector(ctx)
1777 }
Himani Chawla1472c682021-03-17 17:11:14 +05301778 if !dh.getAlarmManagerIsRunning(ctx) {
Himani Chawla4c1d4c72021-02-18 12:14:31 +05301779 go dh.startAlarmManager(ctx)
1780 }
Himani Chawlaac1f5ad2021-02-04 21:21:54 +05301781
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001782 return nil
1783}
1784
dbainbri4d3a0dc2020-12-02 00:33:42 +00001785func (dh *deviceHandler) updateInterface(ctx context.Context, onuind *oop.OnuIndication) error {
mpagenko3af1f032020-06-10 08:53:41 +00001786 //state checking to prevent unneeded processing (eg. on ONU 'unreachable' and 'down')
mpagenkofc4f56e2020-11-04 17:17:49 +00001787 // (but note that the deviceReason may also have changed to e.g. TechProf*Delete_Success in between)
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001788 if dh.getDeviceReason() != drStoppingOpenomci {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001789 logger.Debugw(ctx, "updateInterface-started - stopping-device", log.Fields{"device-id": dh.deviceID})
mpagenko2418ab02020-11-12 12:58:06 +00001790
mpagenko900ee4b2020-10-12 11:56:34 +00001791 //stop all running FSM processing - make use of the DH-state as mirrored in the deviceReason
1792 //here no conflict with aborted FSM's should arise as a complete OMCI initialization is assumed on ONU-Up
1793 //but that might change with some simple MDS check on ONU-Up treatment -> attention!!!
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001794 if err := dh.resetFsms(ctx, true); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001795 logger.Errorw(ctx, "error-updateInterface at FSM stop",
mpagenko900ee4b2020-10-12 11:56:34 +00001796 log.Fields{"device-id": dh.deviceID, "error": err})
1797 // abort: system behavior is just unstable ...
1798 return err
1799 }
mpagenkoa40e99a2020-11-17 13:50:39 +00001800 //all stored persistent data are not valid anymore (loosing knowledge about the connected ONU)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001801 _ = dh.deleteDevicePersistencyData(ctx) //ignore possible errors here and continue, hope is that data is synchronized with new ONU-Up
mpagenko900ee4b2020-10-12 11:56:34 +00001802
1803 //deviceEntry stop without omciCC reset here, regarding the OMCI_CC still valid for this ONU
1804 // - in contrary to disableDevice - compare with processUniDisableStateDoneEvent
1805 //stop the device entry which resets the attached omciCC
dbainbri4d3a0dc2020-12-02 00:33:42 +00001806 pDevEntry := dh.getOnuDeviceEntry(ctx, false)
mpagenko3af1f032020-06-10 08:53:41 +00001807 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001808 logger.Errorw(ctx, "No valid OnuDevice -aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +00001809 return fmt.Errorf("no valid OnuDevice: %s", dh.deviceID)
mpagenko3af1f032020-06-10 08:53:41 +00001810 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001811 _ = pDevEntry.stop(log.WithSpanFromContext(context.TODO(), ctx), false)
mpagenko3af1f032020-06-10 08:53:41 +00001812
1813 //TODO!!! remove existing traffic profiles
1814 /* from py code, if TP's exist, remove them - not yet implemented
1815 self._tp = dict()
1816 # Let TP download happen again
1817 for uni_id in self._tp_service_specific_task:
1818 self._tp_service_specific_task[uni_id].clear()
1819 for uni_id in self._tech_profile_download_done:
1820 self._tech_profile_download_done[uni_id].clear()
1821 */
1822
dbainbri4d3a0dc2020-12-02 00:33:42 +00001823 dh.disableUniPortStateUpdate(ctx)
mpagenko3af1f032020-06-10 08:53:41 +00001824
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001825 dh.setReadyForOmciConfig(false)
mpagenkofc4f56e2020-11-04 17:17:49 +00001826
dbainbri4d3a0dc2020-12-02 00:33:42 +00001827 if err := dh.deviceReasonUpdate(ctx, drStoppingOpenomci, true); err != nil {
mpagenko3af1f032020-06-10 08:53:41 +00001828 // abort: system behavior is just unstable ...
1829 return err
1830 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001831 logger.Debugw(ctx, "call DeviceStateUpdate upon update interface", log.Fields{"ConnectStatus": voltha.ConnectStatus_UNREACHABLE,
Holger Hildebrandt8165eda2020-09-24 09:39:24 +00001832 "OperStatus": voltha.OperStatus_DISCOVERED, "device-id": dh.deviceID})
dbainbri4d3a0dc2020-12-02 00:33:42 +00001833 if err := dh.coreProxy.DeviceStateUpdate(log.WithSpanFromContext(context.TODO(), ctx), dh.deviceID,
mpagenko3af1f032020-06-10 08:53:41 +00001834 voltha.ConnectStatus_UNREACHABLE, voltha.OperStatus_DISCOVERED); err != nil {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00001835 //TODO with VOL-3045/VOL-3046: return the error and stop further processing
dbainbri4d3a0dc2020-12-02 00:33:42 +00001836 logger.Errorw(ctx, "error-updating-device-state unreachable-discovered",
divyadesai4d299552020-08-18 07:13:49 +00001837 log.Fields{"device-id": dh.deviceID, "error": err})
mpagenko3af1f032020-06-10 08:53:41 +00001838 // abort: system behavior is just unstable ...
1839 return err
1840 }
1841 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001842 logger.Debugw(ctx, "updateInterface - device already stopped", log.Fields{"device-id": dh.deviceID})
mpagenko3af1f032020-06-10 08:53:41 +00001843 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00001844 return nil
1845}
1846
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001847func (dh *deviceHandler) resetFsms(ctx context.Context, includingMibSyncFsm bool) error {
mpagenko900ee4b2020-10-12 11:56:34 +00001848 //all possible FSM's are stopped or reset here to ensure their transition to 'disabled'
1849 //it is not sufficient to stop/reset the latest running FSM as done in previous versions
1850 // as after down/up procedures all FSM's might be active/ongoing (in theory)
1851 // and using the stop/reset event should never harm
1852
dbainbri4d3a0dc2020-12-02 00:33:42 +00001853 pDevEntry := dh.getOnuDeviceEntry(ctx, false)
mpagenko900ee4b2020-10-12 11:56:34 +00001854 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001855 logger.Errorw(ctx, "No valid OnuDevice -aborting", log.Fields{"device-id": dh.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +00001856 return fmt.Errorf("no valid OnuDevice: %s", dh.deviceID)
1857 }
Holger Hildebrandtc8ece362021-05-17 12:01:10 +00001858 if pDevEntry.PDevOmciCC != nil {
1859 pDevEntry.PDevOmciCC.CancelRequestMonitoring()
1860 }
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001861 if includingMibSyncFsm {
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00001862 pDevEntry.CancelProcessing(ctx)
mpagenko900ee4b2020-10-12 11:56:34 +00001863 }
1864 //MibDownload may run
1865 pMibDlFsm := pDevEntry.pMibDownloadFsm.pFsm
1866 if pMibDlFsm != nil {
1867 _ = pMibDlFsm.Event(dlEvReset)
1868 }
1869 //port lock/unlock FSM's may be active
1870 if dh.pUnlockStateFsm != nil {
1871 _ = dh.pUnlockStateFsm.pAdaptFsm.pFsm.Event(uniEvReset)
1872 }
1873 if dh.pLockStateFsm != nil {
1874 _ = dh.pLockStateFsm.pAdaptFsm.pFsm.Event(uniEvReset)
1875 }
1876 //techProfile related PonAniConfigFsm FSM may be active
1877 if dh.pOnuTP != nil {
1878 // should always be the case here
1879 // FSM stop maybe encapsulated as OnuTP method - perhaps later in context of module splitting
1880 if dh.pOnuTP.pAniConfigFsm != nil {
Girish Gowdra041dcb32020-11-16 16:54:30 -08001881 for uniTP := range dh.pOnuTP.pAniConfigFsm {
mpagenko73143992021-04-09 15:17:10 +00001882 dh.pOnuTP.pAniConfigFsm[uniTP].CancelProcessing(ctx)
Girish Gowdra041dcb32020-11-16 16:54:30 -08001883 }
mpagenko900ee4b2020-10-12 11:56:34 +00001884 }
1885 for _, uniPort := range dh.uniEntityMap {
mpagenko900ee4b2020-10-12 11:56:34 +00001886 // reset the possibly existing VlanConfigFsm
mpagenkof1fc3862021-02-16 10:09:52 +00001887 dh.lockVlanConfig.RLock()
mpagenko900ee4b2020-10-12 11:56:34 +00001888 if pVlanFilterFsm, exist := dh.UniVlanConfigFsmMap[uniPort.uniID]; exist {
1889 //VlanFilterFsm exists and was already started
mpagenko7d6bb022021-03-11 15:07:55 +00001890 dh.lockVlanConfig.RUnlock()
1891 //reset of all Fsm is always accompanied by global persistency data removal
1892 // no need to remove specific data
1893 pVlanFilterFsm.RequestClearPersistency(false)
1894 //ensure the FSM processing is stopped in case waiting for some response
mpagenko73143992021-04-09 15:17:10 +00001895 pVlanFilterFsm.CancelProcessing(ctx)
mpagenkof1fc3862021-02-16 10:09:52 +00001896 } else {
1897 dh.lockVlanConfig.RUnlock()
mpagenko900ee4b2020-10-12 11:56:34 +00001898 }
1899 }
1900 }
Holger Hildebrandt10d98192021-01-27 15:29:31 +00001901 if dh.getCollectorIsRunning() {
1902 // Stop collector routine
1903 dh.stopCollector <- true
1904 }
Himani Chawla1472c682021-03-17 17:11:14 +05301905 if dh.getAlarmManagerIsRunning(ctx) {
Himani Chawla4c1d4c72021-02-18 12:14:31 +05301906 dh.stopAlarmManager <- true
1907 }
1908
mpagenko80622a52021-02-09 16:53:23 +00001909 //reset a possibly running upgrade FSM
mpagenkoc26d4c02021-05-06 14:27:57 +00001910 // (note the Upgrade FSM may stay alive e.g. in state upgradeStWaitForCommit to endure the ONU reboot)
mpagenko80622a52021-02-09 16:53:23 +00001911 dh.lockUpgradeFsm.RLock()
1912 if dh.pOnuUpradeFsm != nil {
mpagenkoc26d4c02021-05-06 14:27:57 +00001913 dh.pOnuUpradeFsm.CancelProcessing(ctx)
mpagenko80622a52021-02-09 16:53:23 +00001914 }
1915 dh.lockUpgradeFsm.RUnlock()
1916
mpagenko7d6bb022021-03-11 15:07:55 +00001917 logger.Infow(ctx, "resetFsms done", log.Fields{"device-id": dh.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +00001918 return nil
1919}
1920
dbainbri4d3a0dc2020-12-02 00:33:42 +00001921func (dh *deviceHandler) processMibDatabaseSyncEvent(ctx context.Context, devEvent OnuDeviceEvent) {
1922 logger.Debugw(ctx, "MibInSync event received, adding uni ports and locking the ONU interfaces", log.Fields{"device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05301923
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001924 // store persistent data collected during MIB upload processing
1925 if err := dh.storePersistentData(ctx); err != nil {
1926 logger.Warnw(ctx, "store persistent data error - continue as there will be additional write attempts",
1927 log.Fields{"device-id": dh.deviceID, "err": err})
1928 }
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00001929 _ = dh.deviceReasonUpdate(ctx, drDiscoveryMibsyncComplete, !dh.isReconciling())
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001930 dh.addAllUniPorts(ctx)
1931
mpagenkoa40e99a2020-11-17 13:50:39 +00001932 /* 200605: lock processing after initial MIBUpload removed now as the ONU should be in the lock state per default here */
1933 /* 201117: build_dt-berlin-pod-openonugo_1T8GEM_voltha_DT_openonugo_master_test runs into error TC
1934 * 'Test Disable ONUs and OLT Then Delete ONUs and OLT for DT' with Sercom ONU, which obviously needs
1935 * disable/enable toggling here to allow traffic
1936 * but moreover it might be useful for tracking the interface operState changes if this will be implemented,
1937 * like the py comment says:
1938 * # start by locking all the unis till mib sync and initial mib is downloaded
1939 * # this way we can capture the port down/up events when we are ready
1940 */
Himani Chawla26e555c2020-08-31 12:30:20 +05301941
mpagenkoa40e99a2020-11-17 13:50:39 +00001942 // Init Uni Ports to Admin locked state
1943 // *** should generate UniLockStateDone event *****
1944 if dh.pLockStateFsm == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001945 dh.createUniLockFsm(ctx, true, UniLockStateDone)
mpagenkoa40e99a2020-11-17 13:50:39 +00001946 } else { //LockStateFSM already init
1947 dh.pLockStateFsm.setSuccessEvent(UniLockStateDone)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001948 dh.runUniLockFsm(ctx, true)
mpagenkoa40e99a2020-11-17 13:50:39 +00001949 }
1950}
1951
dbainbri4d3a0dc2020-12-02 00:33:42 +00001952func (dh *deviceHandler) processUniLockStateDoneEvent(ctx context.Context, devEvent OnuDeviceEvent) {
1953 logger.Infow(ctx, "UniLockStateDone event: Starting MIB download", log.Fields{"device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05301954 /* Mib download procedure -
1955 ***** should run over 'downloaded' state and generate MibDownloadDone event *****
1956 */
dbainbri4d3a0dc2020-12-02 00:33:42 +00001957 pDevEntry := dh.getOnuDeviceEntry(ctx, false)
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001958 if pDevEntry == nil {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001959 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt3a644642020-12-02 09:46:18 +00001960 return
1961 }
Himani Chawla26e555c2020-08-31 12:30:20 +05301962 pMibDlFsm := pDevEntry.pMibDownloadFsm.pFsm
1963 if pMibDlFsm != nil {
1964 if pMibDlFsm.Is(dlStDisabled) {
1965 if err := pMibDlFsm.Event(dlEvStart); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001966 logger.Errorw(ctx, "MibDownloadFsm: Can't go to state starting", log.Fields{"device-id": dh.deviceID, "err": err})
Himani Chawla26e555c2020-08-31 12:30:20 +05301967 // maybe try a FSM reset and then again ... - TODO!!!
1968 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001969 logger.Debugw(ctx, "MibDownloadFsm", log.Fields{"state": string(pMibDlFsm.Current())})
Himani Chawla26e555c2020-08-31 12:30:20 +05301970 // maybe use more specific states here for the specific download steps ...
1971 if err := pMibDlFsm.Event(dlEvCreateGal); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001972 logger.Errorw(ctx, "MibDownloadFsm: Can't start CreateGal", log.Fields{"device-id": dh.deviceID, "err": err})
Himani Chawla26e555c2020-08-31 12:30:20 +05301973 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001974 logger.Debugw(ctx, "state of MibDownloadFsm", log.Fields{"state": string(pMibDlFsm.Current())})
Himani Chawla26e555c2020-08-31 12:30:20 +05301975 //Begin MIB data download (running autonomously)
1976 }
1977 }
1978 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001979 logger.Errorw(ctx, "wrong state of MibDownloadFsm - want: disabled", log.Fields{"have": string(pMibDlFsm.Current()),
mpagenko01e726e2020-10-23 09:45:29 +00001980 "device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05301981 // maybe try a FSM reset and then again ... - TODO!!!
1982 }
1983 /***** Mib download started */
1984 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001985 logger.Errorw(ctx, "MibDownloadFsm invalid - cannot be executed!!", log.Fields{"device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05301986 }
1987}
1988
dbainbri4d3a0dc2020-12-02 00:33:42 +00001989func (dh *deviceHandler) processMibDownloadDoneEvent(ctx context.Context, devEvent OnuDeviceEvent) {
1990 logger.Debugw(ctx, "MibDownloadDone event received, unlocking the ONU interfaces", log.Fields{"device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05301991 //initiate DevStateUpdate
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00001992 if !dh.isReconciling() {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001993 logger.Debugw(ctx, "call DeviceStateUpdate upon mib-download done", log.Fields{"ConnectStatus": voltha.ConnectStatus_REACHABLE,
Holger Hildebrandt8165eda2020-09-24 09:39:24 +00001994 "OperStatus": voltha.OperStatus_ACTIVE, "device-id": dh.deviceID})
mpagenko15ff4a52021-03-02 10:09:20 +00001995 //we allow a possible OnuSw image commit only in the normal startup, not at reconciling
1996 // in case of adapter restart connected to an ONU upgrade I would not rely on the image quality
1997 // maybe some 'forced' commitment can be done in this situation from system management (or upgrade restarted)
1998 dh.checkOnOnuImageCommit(ctx)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001999 if err := dh.coreProxy.DeviceStateUpdate(log.WithSpanFromContext(context.TODO(), ctx), dh.deviceID,
Himani Chawla26e555c2020-08-31 12:30:20 +05302000 voltha.ConnectStatus_REACHABLE, voltha.OperStatus_ACTIVE); err != nil {
2001 //TODO with VOL-3045/VOL-3046: return the error and stop further processing
dbainbri4d3a0dc2020-12-02 00:33:42 +00002002 logger.Errorw(ctx, "error-updating-device-state", log.Fields{"device-id": dh.deviceID, "error": err})
Himani Chawla26e555c2020-08-31 12:30:20 +05302003 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002004 logger.Debugw(ctx, "dev state updated to 'Oper.Active'", log.Fields{"device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05302005 }
2006 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002007 logger.Debugw(ctx, "reconciling - don't notify core about DeviceStateUpdate to ACTIVE",
Himani Chawla26e555c2020-08-31 12:30:20 +05302008 log.Fields{"device-id": dh.deviceID})
2009 }
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00002010 _ = dh.deviceReasonUpdate(ctx, drInitialMibDownloaded, !dh.isReconciling())
Girish Gowdrae0140f02021-02-02 16:55:09 -08002011
Girish Gowdra7b0ee5c2021-03-19 21:48:15 -07002012 if !dh.getCollectorIsRunning() {
2013 // Start PM collector routine
2014 go dh.startCollector(ctx)
2015 }
2016 if !dh.getAlarmManagerIsRunning(ctx) {
2017 go dh.startAlarmManager(ctx)
2018 }
2019
Girish Gowdrae0140f02021-02-02 16:55:09 -08002020 // Initialize classical L2 PM Interval Counters
2021 if err := dh.pOnuMetricsMgr.pAdaptFsm.pFsm.Event(l2PmEventInit); err != nil {
2022 // There is no way we should be landing here, but if we do then
2023 // there is nothing much we can do about this other than log error
2024 logger.Errorw(ctx, "error starting l2 pm fsm", log.Fields{"device-id": dh.device.Id, "err": err})
2025 }
2026
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002027 dh.setReadyForOmciConfig(true)
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002028
2029 pDevEntry := dh.getOnuDeviceEntry(ctx, false)
2030 if pDevEntry == nil {
2031 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
2032 return
2033 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002034 pDevEntry.mutexPersOnuConfig.RLock()
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002035 if dh.isReconciling() && pDevEntry.sOnuPersistentData.PersUniDisableDone {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002036 pDevEntry.mutexPersOnuConfig.RUnlock()
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002037 logger.Debugw(ctx, "reconciling - uni-ports were disabled by admin before adapter restart - keep the ports locked",
2038 log.Fields{"device-id": dh.deviceID})
2039 go dh.reconcileDeviceTechProf(ctx)
2040 // reconcilement will be continued after ani config is done
2041 } else {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002042 pDevEntry.mutexPersOnuConfig.RUnlock()
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002043 // *** should generate UniUnlockStateDone event *****
2044 if dh.pUnlockStateFsm == nil {
2045 dh.createUniLockFsm(ctx, false, UniUnlockStateDone)
2046 } else { //UnlockStateFSM already init
2047 dh.pUnlockStateFsm.setSuccessEvent(UniUnlockStateDone)
2048 dh.runUniLockFsm(ctx, false)
2049 }
Himani Chawla26e555c2020-08-31 12:30:20 +05302050 }
2051}
2052
dbainbri4d3a0dc2020-12-02 00:33:42 +00002053func (dh *deviceHandler) processUniUnlockStateDoneEvent(ctx context.Context, devEvent OnuDeviceEvent) {
2054 dh.enableUniPortStateUpdate(ctx) //cmp python yield self.enable_ports()
Himani Chawla26e555c2020-08-31 12:30:20 +05302055
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00002056 if !dh.isReconciling() {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002057 logger.Infow(ctx, "UniUnlockStateDone event: Sending OnuUp event", log.Fields{"device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05302058 raisedTs := time.Now().UnixNano()
dbainbri4d3a0dc2020-12-02 00:33:42 +00002059 go dh.sendOnuOperStateEvent(ctx, voltha.OperStatus_ACTIVE, dh.deviceID, raisedTs) //cmp python onu_active_event
2060 pDevEntry := dh.getOnuDeviceEntry(ctx, false)
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002061 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002062 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002063 return
2064 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002065 pDevEntry.mutexPersOnuConfig.Lock()
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002066 pDevEntry.sOnuPersistentData.PersUniUnlockDone = true
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002067 pDevEntry.mutexPersOnuConfig.Unlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00002068 if err := dh.storePersistentData(ctx); err != nil {
2069 logger.Warnw(ctx, "store persistent data error - continue for now as there will be additional write attempts",
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002070 log.Fields{"device-id": dh.deviceID, "err": err})
2071 }
Himani Chawla26e555c2020-08-31 12:30:20 +05302072 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002073 logger.Debugw(ctx, "reconciling - don't notify core that onu went to active but trigger tech profile config",
Himani Chawla26e555c2020-08-31 12:30:20 +05302074 log.Fields{"device-id": dh.deviceID})
dbainbri4d3a0dc2020-12-02 00:33:42 +00002075 go dh.reconcileDeviceTechProf(ctx)
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002076 // reconcilement will be continued after ani config is done
Himani Chawla26e555c2020-08-31 12:30:20 +05302077 }
2078}
2079
dbainbri4d3a0dc2020-12-02 00:33:42 +00002080func (dh *deviceHandler) processUniDisableStateDoneEvent(ctx context.Context, devEvent OnuDeviceEvent) {
2081 logger.Debugw(ctx, "DeviceStateUpdate upon disable", log.Fields{"ConnectStatus": voltha.ConnectStatus_REACHABLE,
mpagenko900ee4b2020-10-12 11:56:34 +00002082 "OperStatus": voltha.OperStatus_UNKNOWN, "device-id": dh.deviceID})
dbainbri4d3a0dc2020-12-02 00:33:42 +00002083 if err := dh.coreProxy.DeviceStateUpdate(log.WithSpanFromContext(context.TODO(), ctx),
mpagenko900ee4b2020-10-12 11:56:34 +00002084 dh.deviceID, voltha.ConnectStatus_REACHABLE, voltha.OperStatus_UNKNOWN); err != nil {
2085 //TODO with VOL-3045/VOL-3046: return the error and stop further processing
dbainbri4d3a0dc2020-12-02 00:33:42 +00002086 logger.Errorw(ctx, "error-updating-device-state", log.Fields{"device-id": dh.deviceID, "error": err})
mpagenko900ee4b2020-10-12 11:56:34 +00002087 }
2088
dbainbri4d3a0dc2020-12-02 00:33:42 +00002089 logger.Debugw(ctx, "DeviceReasonUpdate upon disable", log.Fields{"reason": deviceReasonMap[drOmciAdminLock], "device-id": dh.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +00002090 // DeviceReason to update acc.to modified py code as per beginning of Sept 2020
dbainbri4d3a0dc2020-12-02 00:33:42 +00002091 _ = dh.deviceReasonUpdate(ctx, drOmciAdminLock, true)
mpagenko900ee4b2020-10-12 11:56:34 +00002092
2093 //transfer the modified logical uni port state
dbainbri4d3a0dc2020-12-02 00:33:42 +00002094 dh.disableUniPortStateUpdate(ctx)
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002095
dbainbri4d3a0dc2020-12-02 00:33:42 +00002096 pDevEntry := dh.getOnuDeviceEntry(ctx, false)
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002097 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002098 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002099 return
2100 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002101 pDevEntry.mutexPersOnuConfig.Lock()
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002102 pDevEntry.sOnuPersistentData.PersUniDisableDone = true
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002103 pDevEntry.mutexPersOnuConfig.Unlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00002104 if err := dh.storePersistentData(ctx); err != nil {
2105 logger.Warnw(ctx, "store persistent data error - continue for now as there will be additional write attempts",
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002106 log.Fields{"device-id": dh.deviceID, "err": err})
2107 }
mpagenko900ee4b2020-10-12 11:56:34 +00002108}
2109
dbainbri4d3a0dc2020-12-02 00:33:42 +00002110func (dh *deviceHandler) processUniEnableStateDoneEvent(ctx context.Context, devEvent OnuDeviceEvent) {
2111 logger.Debugw(ctx, "DeviceStateUpdate upon re-enable", log.Fields{"ConnectStatus": voltha.ConnectStatus_REACHABLE,
mpagenko900ee4b2020-10-12 11:56:34 +00002112 "OperStatus": voltha.OperStatus_ACTIVE, "device-id": dh.deviceID})
dbainbri4d3a0dc2020-12-02 00:33:42 +00002113 if err := dh.coreProxy.DeviceStateUpdate(log.WithSpanFromContext(context.TODO(), ctx), dh.deviceID, voltha.ConnectStatus_REACHABLE,
mpagenko900ee4b2020-10-12 11:56:34 +00002114 voltha.OperStatus_ACTIVE); err != nil {
2115 //TODO with VOL-3045/VOL-3046: return the error and stop further processing
dbainbri4d3a0dc2020-12-02 00:33:42 +00002116 logger.Errorw(ctx, "error-updating-device-state", log.Fields{"device-id": dh.deviceID, "error": err})
mpagenko900ee4b2020-10-12 11:56:34 +00002117 }
2118
dbainbri4d3a0dc2020-12-02 00:33:42 +00002119 logger.Debugw(ctx, "DeviceReasonUpdate upon re-enable", log.Fields{
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002120 "reason": deviceReasonMap[drOnuReenabled], "device-id": dh.deviceID})
mpagenko900ee4b2020-10-12 11:56:34 +00002121 // DeviceReason to update acc.to modified py code as per beginning of Sept 2020
dbainbri4d3a0dc2020-12-02 00:33:42 +00002122 _ = dh.deviceReasonUpdate(ctx, drOnuReenabled, true)
mpagenko900ee4b2020-10-12 11:56:34 +00002123
2124 //transfer the modified logical uni port state
dbainbri4d3a0dc2020-12-02 00:33:42 +00002125 dh.enableUniPortStateUpdate(ctx)
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002126
dbainbri4d3a0dc2020-12-02 00:33:42 +00002127 pDevEntry := dh.getOnuDeviceEntry(ctx, false)
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002128 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002129 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002130 return
2131 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002132 pDevEntry.mutexPersOnuConfig.Lock()
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002133 pDevEntry.sOnuPersistentData.PersUniDisableDone = false
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002134 pDevEntry.mutexPersOnuConfig.Unlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00002135 if err := dh.storePersistentData(ctx); err != nil {
2136 logger.Warnw(ctx, "store persistent data error - continue for now as there will be additional write attempts",
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002137 log.Fields{"device-id": dh.deviceID, "err": err})
2138 }
mpagenko900ee4b2020-10-12 11:56:34 +00002139}
2140
dbainbri4d3a0dc2020-12-02 00:33:42 +00002141func (dh *deviceHandler) processOmciAniConfigDoneEvent(ctx context.Context, devEvent OnuDeviceEvent) {
mpagenkofc4f56e2020-11-04 17:17:49 +00002142 if devEvent == OmciAniConfigDone {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002143 logger.Debugw(ctx, "OmciAniConfigDone event received", log.Fields{"device-id": dh.deviceID})
mpagenkofc4f56e2020-11-04 17:17:49 +00002144 // attention: the device reason update is done based on ONU-UNI-Port related activity
2145 // - which may cause some inconsistency
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002146 if dh.getDeviceReason() != drTechProfileConfigDownloadSuccess {
mpagenkofc4f56e2020-11-04 17:17:49 +00002147 // which may be the case from some previous actvity even on this UNI Port (but also other UNI ports)
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00002148 _ = dh.deviceReasonUpdate(ctx, drTechProfileConfigDownloadSuccess, !dh.isReconciling())
Himani Chawla26e555c2020-08-31 12:30:20 +05302149 }
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00002150 if dh.isReconciling() {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002151 go dh.reconcileDeviceFlowConfig(ctx)
mpagenkofc4f56e2020-11-04 17:17:49 +00002152 }
2153 } else { // should be the OmciAniResourceRemoved block
dbainbri4d3a0dc2020-12-02 00:33:42 +00002154 logger.Debugw(ctx, "OmciAniResourceRemoved event received", log.Fields{"device-id": dh.deviceID})
mpagenkofc4f56e2020-11-04 17:17:49 +00002155 // attention: the device reason update is done based on ONU-UNI-Port related activity
2156 // - which may cause some inconsistency
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002157 if dh.getDeviceReason() != drTechProfileConfigDeleteSuccess {
mpagenkofc4f56e2020-11-04 17:17:49 +00002158 // which may be the case from some previous actvity even on this ONU port (but also other UNI ports)
dbainbri4d3a0dc2020-12-02 00:33:42 +00002159 _ = dh.deviceReasonUpdate(ctx, drTechProfileConfigDeleteSuccess, true)
mpagenkofc4f56e2020-11-04 17:17:49 +00002160 }
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002161 }
Himani Chawla26e555c2020-08-31 12:30:20 +05302162}
2163
dbainbri4d3a0dc2020-12-02 00:33:42 +00002164func (dh *deviceHandler) processOmciVlanFilterDoneEvent(ctx context.Context, aDevEvent OnuDeviceEvent) {
2165 logger.Debugw(ctx, "OmciVlanFilterDone event received",
mpagenkofc4f56e2020-11-04 17:17:49 +00002166 log.Fields{"device-id": dh.deviceID, "event": aDevEvent})
Himani Chawla26e555c2020-08-31 12:30:20 +05302167 // attention: the device reason update is done based on ONU-UNI-Port related activity
2168 // - which may cause some inconsistency
Himani Chawla26e555c2020-08-31 12:30:20 +05302169
mpagenkof1fc3862021-02-16 10:09:52 +00002170 if aDevEvent == OmciVlanFilterAddDone || aDevEvent == OmciVlanFilterAddDoneNoKvStore {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002171 if dh.getDeviceReason() != drOmciFlowsPushed {
mpagenkofc4f56e2020-11-04 17:17:49 +00002172 // which may be the case from some previous actvity on another UNI Port of the ONU
2173 // or even some previous flow add activity on the same port
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00002174 _ = dh.deviceReasonUpdate(ctx, drOmciFlowsPushed, !dh.isReconciling())
2175 if dh.isReconciling() {
Holger Hildebrandt1b8f4ad2021-03-25 15:53:51 +00002176 go dh.reconcileEnd(ctx)
mpagenkofc4f56e2020-11-04 17:17:49 +00002177 }
2178 }
2179 } else {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002180 if dh.getDeviceReason() != drOmciFlowsDeleted {
mpagenkofc4f56e2020-11-04 17:17:49 +00002181 //not relevant for reconcile
dbainbri4d3a0dc2020-12-02 00:33:42 +00002182 _ = dh.deviceReasonUpdate(ctx, drOmciFlowsDeleted, true)
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002183 }
Himani Chawla26e555c2020-08-31 12:30:20 +05302184 }
mpagenkof1fc3862021-02-16 10:09:52 +00002185
2186 if aDevEvent == OmciVlanFilterAddDone || aDevEvent == OmciVlanFilterRemDone {
2187 //events that request KvStore write
2188 if err := dh.storePersistentData(ctx); err != nil {
2189 logger.Warnw(ctx, "store persistent data error - continue for now as there will be additional write attempts",
2190 log.Fields{"device-id": dh.deviceID, "err": err})
2191 }
2192 } else {
2193 logger.Debugw(ctx, "OmciVlanFilter*Done* - write to KvStore not requested",
2194 log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt10d98192021-01-27 15:29:31 +00002195 }
Himani Chawla26e555c2020-08-31 12:30:20 +05302196}
2197
Himani Chawla6d2ae152020-09-02 13:11:20 +05302198//deviceProcStatusUpdate evaluates possible processing events and initiates according next activities
dbainbri4d3a0dc2020-12-02 00:33:42 +00002199func (dh *deviceHandler) deviceProcStatusUpdate(ctx context.Context, devEvent OnuDeviceEvent) {
Himani Chawla4d908332020-08-31 12:30:20 +05302200 switch devEvent {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002201 case MibDatabaseSync:
2202 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002203 dh.processMibDatabaseSyncEvent(ctx, devEvent)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002204 }
mpagenkoa40e99a2020-11-17 13:50:39 +00002205 case UniLockStateDone:
2206 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002207 dh.processUniLockStateDoneEvent(ctx, devEvent)
mpagenkoa40e99a2020-11-17 13:50:39 +00002208 }
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002209 case MibDownloadDone:
2210 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002211 dh.processMibDownloadDoneEvent(ctx, devEvent)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002212 }
2213 case UniUnlockStateDone:
2214 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002215 dh.processUniUnlockStateDoneEvent(ctx, devEvent)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002216 }
mpagenko900ee4b2020-10-12 11:56:34 +00002217 case UniEnableStateDone:
2218 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002219 dh.processUniEnableStateDoneEvent(ctx, devEvent)
mpagenko900ee4b2020-10-12 11:56:34 +00002220 }
2221 case UniDisableStateDone:
2222 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002223 dh.processUniDisableStateDoneEvent(ctx, devEvent)
mpagenko900ee4b2020-10-12 11:56:34 +00002224 }
mpagenkofc4f56e2020-11-04 17:17:49 +00002225 case OmciAniConfigDone, OmciAniResourceRemoved:
mpagenko3dbcdd22020-07-22 07:38:45 +00002226 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002227 dh.processOmciAniConfigDoneEvent(ctx, devEvent)
mpagenko3dbcdd22020-07-22 07:38:45 +00002228 }
mpagenkof1fc3862021-02-16 10:09:52 +00002229 case OmciVlanFilterAddDone, OmciVlanFilterAddDoneNoKvStore, OmciVlanFilterRemDone, OmciVlanFilterRemDoneNoKvStore:
mpagenkodff5dda2020-08-28 11:52:01 +00002230 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002231 dh.processOmciVlanFilterDoneEvent(ctx, devEvent)
mpagenkodff5dda2020-08-28 11:52:01 +00002232 }
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002233 default:
2234 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002235 logger.Debugw(ctx, "unhandled-device-event", log.Fields{"device-id": dh.deviceID, "event": devEvent})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002236 }
2237 } //switch
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00002238}
2239
dbainbri4d3a0dc2020-12-02 00:33:42 +00002240func (dh *deviceHandler) addUniPort(ctx context.Context, aUniInstNo uint16, aUniID uint8, aPortType uniPortType) {
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002241 // parameters are IntfId, OnuId, uniId
dbainbri4d3a0dc2020-12-02 00:33:42 +00002242 uniNo := mkUniPortNum(ctx, dh.pOnuIndication.GetIntfId(), dh.pOnuIndication.GetOnuId(),
Himani Chawla4d908332020-08-31 12:30:20 +05302243 uint32(aUniID))
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002244 if _, present := dh.uniEntityMap[uniNo]; present {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002245 logger.Warnw(ctx, "onuUniPort-add: Port already exists", log.Fields{"for InstanceId": aUniInstNo})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00002246 } else {
Himani Chawla4d908332020-08-31 12:30:20 +05302247 //with arguments aUniID, a_portNo, aPortType
dbainbri4d3a0dc2020-12-02 00:33:42 +00002248 pUniPort := newOnuUniPort(ctx, aUniID, uniNo, aUniInstNo, aPortType)
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00002249 if pUniPort == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002250 logger.Warnw(ctx, "onuUniPort-add: Could not create Port", log.Fields{"for InstanceId": aUniInstNo})
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00002251 } else {
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002252 //store UniPort with the System-PortNumber key
2253 dh.uniEntityMap[uniNo] = pUniPort
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00002254 if !dh.isReconciling() {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00002255 // create announce the UniPort to the core as VOLTHA Port object
dbainbri4d3a0dc2020-12-02 00:33:42 +00002256 if err := pUniPort.createVolthaPort(ctx, dh); err == nil {
2257 logger.Infow(ctx, "onuUniPort-added", log.Fields{"for PortNo": uniNo})
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00002258 } //error logging already within UniPort method
2259 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002260 logger.Debugw(ctx, "reconciling - onuUniPort already added", log.Fields{"for PortNo": uniNo, "device-id": dh.deviceID})
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00002261 }
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +00002262 }
2263 }
2264}
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002265
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002266func (dh *deviceHandler) addAllUniPorts(ctx context.Context) {
2267 pDevEntry := dh.getOnuDeviceEntry(ctx, false)
2268 if pDevEntry == nil {
2269 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
2270 return
2271 }
2272 i := uint8(0) //UNI Port limit: see MaxUnisPerOnu (by now 16) (OMCI supports max 255 p.b.)
2273 if pptpInstKeys := pDevEntry.pOnuDB.getSortedInstKeys(
2274 ctx, me.PhysicalPathTerminationPointEthernetUniClassID); len(pptpInstKeys) > 0 {
2275 for _, mgmtEntityID := range pptpInstKeys {
2276 logger.Debugw(ctx, "Add PPTPEthUni port for MIB-stored instance:", log.Fields{
2277 "device-id": dh.deviceID, "PPTPEthUni EntityID": mgmtEntityID})
2278 dh.addUniPort(ctx, mgmtEntityID, i, uniPPTP)
2279 i++
2280 }
2281 } else {
2282 logger.Debugw(ctx, "No PPTP instances found", log.Fields{"device-id": dh.deviceID})
2283 }
2284 if veipInstKeys := pDevEntry.pOnuDB.getSortedInstKeys(
2285 ctx, me.VirtualEthernetInterfacePointClassID); len(veipInstKeys) > 0 {
2286 for _, mgmtEntityID := range veipInstKeys {
2287 logger.Debugw(ctx, "Add VEIP for MIB-stored instance:", log.Fields{
2288 "device-id": dh.deviceID, "VEIP EntityID": mgmtEntityID})
2289 dh.addUniPort(ctx, mgmtEntityID, i, uniVEIP)
2290 i++
2291 }
2292 } else {
2293 logger.Debugw(ctx, "No VEIP instances found", log.Fields{"device-id": dh.deviceID})
2294 }
2295 if i == 0 {
2296 logger.Warnw(ctx, "No UniG instances found", log.Fields{"device-id": dh.deviceID})
2297 }
2298}
2299
mpagenko3af1f032020-06-10 08:53:41 +00002300// enableUniPortStateUpdate enables UniPortState and update core port state accordingly
dbainbri4d3a0dc2020-12-02 00:33:42 +00002301func (dh *deviceHandler) enableUniPortStateUpdate(ctx context.Context) {
Holger Hildebrandtbe674422020-05-05 13:05:30 +00002302 // py code was updated 2003xx to activate the real ONU UNI ports per OMCI (VEIP or PPTP)
Himani Chawla4d908332020-08-31 12:30:20 +05302303 // but towards core only the first port active state is signaled
Holger Hildebrandtbe674422020-05-05 13:05:30 +00002304 // with following remark:
2305 // # TODO: for now only support the first UNI given no requirement for multiple uni yet. Also needed to reduce flow
2306 // # load on the core
2307
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002308 // lock_ports(false) as done in py code here is shifted to separate call from device event processing
Holger Hildebrandtbe674422020-05-05 13:05:30 +00002309
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002310 for uniNo, uniPort := range dh.uniEntityMap {
mpagenko3af1f032020-06-10 08:53:41 +00002311 // only if this port is validated for operState transfer
Himani Chawla6d2ae152020-09-02 13:11:20 +05302312 if (1<<uniPort.uniID)&activeUniPortStateUpdateMask == (1 << uniPort.uniID) {
Holger Hildebrandtbdc5f002021-04-19 14:46:21 +00002313 logger.Infow(ctx, "onuUniPort-forced-OperState-ACTIVE", log.Fields{"for PortNo": uniNo, "device-id": dh.deviceID})
Himani Chawla6d2ae152020-09-02 13:11:20 +05302314 uniPort.setOperState(vc.OperStatus_ACTIVE)
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00002315 if !dh.isReconciling() {
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00002316 //maybe also use getter functions on uniPort - perhaps later ...
dbainbri4d3a0dc2020-12-02 00:33:42 +00002317 go dh.coreProxy.PortStateUpdate(log.WithSpanFromContext(context.TODO(), ctx), dh.deviceID, voltha.Port_ETHERNET_UNI, uniPort.portNo, uniPort.operState)
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00002318 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002319 logger.Debugw(ctx, "reconciling - don't notify core about PortStateUpdate", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtf41a1602020-08-19 09:52:50 +00002320 }
mpagenko3af1f032020-06-10 08:53:41 +00002321 }
2322 }
2323}
2324
2325// Disable UniPortState and update core port state accordingly
dbainbri4d3a0dc2020-12-02 00:33:42 +00002326func (dh *deviceHandler) disableUniPortStateUpdate(ctx context.Context) {
mpagenko3af1f032020-06-10 08:53:41 +00002327 // compare enableUniPortStateUpdate() above
2328 // -> use current restriction to operate only on first UNI port as inherited from actual Py code
2329 for uniNo, uniPort := range dh.uniEntityMap {
2330 // only if this port is validated for operState transfer
Himani Chawla6d2ae152020-09-02 13:11:20 +05302331 if (1<<uniPort.uniID)&activeUniPortStateUpdateMask == (1 << uniPort.uniID) {
Holger Hildebrandtbdc5f002021-04-19 14:46:21 +00002332 logger.Infow(ctx, "onuUniPort-forced-OperState-UNKNOWN", log.Fields{"for PortNo": uniNo, "device-id": dh.deviceID})
Himani Chawla6d2ae152020-09-02 13:11:20 +05302333 uniPort.setOperState(vc.OperStatus_UNKNOWN)
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002334 if !dh.isReconciling() {
2335 //maybe also use getter functions on uniPort - perhaps later ...
2336 go dh.coreProxy.PortStateUpdate(log.WithSpanFromContext(context.TODO(), ctx), dh.deviceID, voltha.Port_ETHERNET_UNI, uniPort.portNo, uniPort.operState)
2337 } else {
2338 logger.Debugw(ctx, "reconciling - don't notify core about PortStateUpdate", log.Fields{"device-id": dh.deviceID})
2339 }
2340
Holger Hildebrandtbe674422020-05-05 13:05:30 +00002341 }
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002342 }
2343}
2344
2345// ONU_Active/Inactive announcement on system KAFKA bus
2346// tried to re-use procedure of oltUpDownIndication from openolt_eventmgr.go with used values from Py code
dbainbri4d3a0dc2020-12-02 00:33:42 +00002347func (dh *deviceHandler) sendOnuOperStateEvent(ctx context.Context, aOperState vc.OperStatus_Types, aDeviceID string, raisedTs int64) {
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002348 var de voltha.DeviceEvent
2349 eventContext := make(map[string]string)
2350 //Populating event context
2351 // assume giving ParentId in GetDevice twice really gives the ParentDevice (there is no GetParentDevice()...)
dbainbri4d3a0dc2020-12-02 00:33:42 +00002352 parentDevice, err := dh.coreProxy.GetDevice(log.WithSpanFromContext(context.TODO(), ctx), dh.parentID, dh.parentID)
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002353 if err != nil || parentDevice == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002354 logger.Errorw(ctx, "Failed to fetch parent device for OnuEvent",
Himani Chawla4d908332020-08-31 12:30:20 +05302355 log.Fields{"parentID": dh.parentID, "err": err})
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002356 }
2357 oltSerialNumber := parentDevice.SerialNumber
2358
2359 eventContext["pon-id"] = strconv.FormatUint(uint64(dh.pOnuIndication.IntfId), 10)
2360 eventContext["onu-id"] = strconv.FormatUint(uint64(dh.pOnuIndication.OnuId), 10)
2361 eventContext["serial-number"] = dh.device.SerialNumber
ssiddiqui1221d1a2021-02-15 11:12:51 +05302362 eventContext["olt-serial-number"] = oltSerialNumber
2363 eventContext["device-id"] = aDeviceID
2364 eventContext["registration-id"] = aDeviceID //py: string(device_id)??
dbainbri4d3a0dc2020-12-02 00:33:42 +00002365 logger.Debugw(ctx, "prepare ONU_ACTIVATED event",
mpagenko01e726e2020-10-23 09:45:29 +00002366 log.Fields{"device-id": aDeviceID, "EventContext": eventContext})
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002367
2368 /* Populating device event body */
2369 de.Context = eventContext
Himani Chawla4d908332020-08-31 12:30:20 +05302370 de.ResourceId = aDeviceID
2371 if aOperState == voltha.OperStatus_ACTIVE {
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002372 de.DeviceEventName = fmt.Sprintf("%s_%s", cOnuActivatedEvent, "RAISE_EVENT")
2373 de.Description = fmt.Sprintf("%s Event - %s - %s",
2374 cEventObjectType, cOnuActivatedEvent, "Raised")
2375 } else {
2376 de.DeviceEventName = fmt.Sprintf("%s_%s", cOnuActivatedEvent, "CLEAR_EVENT")
2377 de.Description = fmt.Sprintf("%s Event - %s - %s",
2378 cEventObjectType, cOnuActivatedEvent, "Cleared")
2379 }
2380 /* Send event to KAFKA */
dbainbri4d3a0dc2020-12-02 00:33:42 +00002381 if err := dh.EventProxy.SendDeviceEvent(ctx, &de, equipment, pon, raisedTs); err != nil {
2382 logger.Warnw(ctx, "could not send ONU_ACTIVATED event",
Himani Chawla4d908332020-08-31 12:30:20 +05302383 log.Fields{"device-id": aDeviceID, "error": err})
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002384 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00002385 logger.Debugw(ctx, "ctx, ONU_ACTIVATED event sent to KAFKA",
Himani Chawla4d908332020-08-31 12:30:20 +05302386 log.Fields{"device-id": aDeviceID, "with-EventName": de.DeviceEventName})
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002387}
2388
Himani Chawla4d908332020-08-31 12:30:20 +05302389// createUniLockFsm initializes and runs the UniLock FSM to transfer the OMCI related commands for port lock/unlock
dbainbri4d3a0dc2020-12-02 00:33:42 +00002390func (dh *deviceHandler) createUniLockFsm(ctx context.Context, aAdminState bool, devEvent OnuDeviceEvent) {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002391 chLSFsm := make(chan Message, 2048)
2392 var sFsmName string
Himani Chawla4d908332020-08-31 12:30:20 +05302393 if aAdminState {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002394 logger.Debugw(ctx, "createLockStateFSM", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002395 sFsmName = "LockStateFSM"
2396 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002397 logger.Debugw(ctx, "createUnlockStateFSM", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002398 sFsmName = "UnLockStateFSM"
2399 }
mpagenko3af1f032020-06-10 08:53:41 +00002400
dbainbri4d3a0dc2020-12-02 00:33:42 +00002401 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
mpagenko3af1f032020-06-10 08:53:41 +00002402 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002403 logger.Errorw(ctx, "No valid OnuDevice -aborting", log.Fields{"device-id": dh.deviceID})
mpagenko3af1f032020-06-10 08:53:41 +00002404 return
2405 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00002406 pLSFsm := newLockStateFsm(ctx, pDevEntry.PDevOmciCC, aAdminState, devEvent,
Holger Hildebrandt8165eda2020-09-24 09:39:24 +00002407 sFsmName, dh, chLSFsm)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002408 if pLSFsm != nil {
Himani Chawla4d908332020-08-31 12:30:20 +05302409 if aAdminState {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002410 dh.pLockStateFsm = pLSFsm
2411 } else {
2412 dh.pUnlockStateFsm = pLSFsm
2413 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00002414 dh.runUniLockFsm(ctx, aAdminState)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002415 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002416 logger.Errorw(ctx, "LockStateFSM could not be created - abort!!", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002417 }
2418}
2419
2420// runUniLockFsm starts the UniLock FSM to transfer the OMCI related commands for port lock/unlock
dbainbri4d3a0dc2020-12-02 00:33:42 +00002421func (dh *deviceHandler) runUniLockFsm(ctx context.Context, aAdminState bool) {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002422 /* Uni Port lock/unlock procedure -
2423 ***** should run via 'adminDone' state and generate the argument requested event *****
2424 */
2425 var pLSStatemachine *fsm.FSM
Himani Chawla4d908332020-08-31 12:30:20 +05302426 if aAdminState {
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002427 pLSStatemachine = dh.pLockStateFsm.pAdaptFsm.pFsm
2428 //make sure the opposite FSM is not running and if so, terminate it as not relevant anymore
2429 if (dh.pUnlockStateFsm != nil) &&
mpagenko1cc3cb42020-07-27 15:24:38 +00002430 (dh.pUnlockStateFsm.pAdaptFsm.pFsm.Current() != uniStDisabled) {
Himani Chawla4d908332020-08-31 12:30:20 +05302431 _ = dh.pUnlockStateFsm.pAdaptFsm.pFsm.Event(uniEvReset)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002432 }
2433 } else {
2434 pLSStatemachine = dh.pUnlockStateFsm.pAdaptFsm.pFsm
2435 //make sure the opposite FSM is not running and if so, terminate it as not relevant anymore
2436 if (dh.pLockStateFsm != nil) &&
mpagenko1cc3cb42020-07-27 15:24:38 +00002437 (dh.pLockStateFsm.pAdaptFsm.pFsm.Current() != uniStDisabled) {
Himani Chawla4d908332020-08-31 12:30:20 +05302438 _ = dh.pLockStateFsm.pAdaptFsm.pFsm.Event(uniEvReset)
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002439 }
2440 }
2441 if pLSStatemachine != nil {
mpagenko1cc3cb42020-07-27 15:24:38 +00002442 if pLSStatemachine.Is(uniStDisabled) {
2443 if err := pLSStatemachine.Event(uniEvStart); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002444 logger.Warnw(ctx, "LockStateFSM: can't start", log.Fields{"err": err})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002445 // maybe try a FSM reset and then again ... - TODO!!!
2446 } else {
2447 /***** LockStateFSM started */
dbainbri4d3a0dc2020-12-02 00:33:42 +00002448 logger.Debugw(ctx, "LockStateFSM started", log.Fields{
divyadesai4d299552020-08-18 07:13:49 +00002449 "state": pLSStatemachine.Current(), "device-id": dh.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002450 }
2451 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002452 logger.Warnw(ctx, "wrong state of LockStateFSM - want: disabled", log.Fields{
divyadesai4d299552020-08-18 07:13:49 +00002453 "have": pLSStatemachine.Current(), "device-id": dh.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002454 // maybe try a FSM reset and then again ... - TODO!!!
2455 }
2456 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002457 logger.Errorw(ctx, "LockStateFSM StateMachine invalid - cannot be executed!!", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandtccd390c2020-05-29 13:49:04 +00002458 // maybe try a FSM reset and then again ... - TODO!!!
2459 }
2460}
2461
mpagenko80622a52021-02-09 16:53:23 +00002462// createOnuUpgradeFsm initializes and runs the Onu Software upgrade FSM
mpagenko15ff4a52021-03-02 10:09:20 +00002463func (dh *deviceHandler) createOnuUpgradeFsm(ctx context.Context, apDevEntry *OnuDeviceEntry, aDevEvent OnuDeviceEvent) error {
mpagenko80622a52021-02-09 16:53:23 +00002464 //in here lockUpgradeFsm is already locked
2465 chUpgradeFsm := make(chan Message, 2048)
2466 var sFsmName = "OnuSwUpgradeFSM"
2467 logger.Debugw(ctx, "create OnuSwUpgradeFSM", log.Fields{"device-id": dh.deviceID})
mpagenko15ff4a52021-03-02 10:09:20 +00002468 if apDevEntry.PDevOmciCC == nil {
2469 logger.Errorw(ctx, "no valid OnuDevice or omciCC - abort", log.Fields{"device-id": dh.deviceID})
2470 return fmt.Errorf(fmt.Sprintf("no valid omciCC - abort for device-id: %s", dh.device.Id))
mpagenko80622a52021-02-09 16:53:23 +00002471 }
mpagenko15ff4a52021-03-02 10:09:20 +00002472 dh.pOnuUpradeFsm = NewOnuUpgradeFsm(ctx, dh, apDevEntry, apDevEntry.pOnuDB, aDevEvent,
mpagenko80622a52021-02-09 16:53:23 +00002473 sFsmName, chUpgradeFsm)
2474 if dh.pOnuUpradeFsm != nil {
2475 pUpgradeStatemachine := dh.pOnuUpradeFsm.pAdaptFsm.pFsm
2476 if pUpgradeStatemachine != nil {
2477 if pUpgradeStatemachine.Is(upgradeStDisabled) {
2478 if err := pUpgradeStatemachine.Event(upgradeEvStart); err != nil {
2479 logger.Errorw(ctx, "OnuSwUpgradeFSM: can't start", log.Fields{"err": err})
2480 // maybe try a FSM reset and then again ... - TODO!!!
2481 return fmt.Errorf(fmt.Sprintf("OnuSwUpgradeFSM could not be started for device-id: %s", dh.device.Id))
2482 }
2483 /***** LockStateFSM started */
2484 logger.Debugw(ctx, "OnuSwUpgradeFSM started", log.Fields{
2485 "state": pUpgradeStatemachine.Current(), "device-id": dh.deviceID})
2486 } else {
2487 logger.Errorw(ctx, "wrong state of OnuSwUpgradeFSM to start - want: disabled", log.Fields{
2488 "have": pUpgradeStatemachine.Current(), "device-id": dh.deviceID})
2489 // maybe try a FSM reset and then again ... - TODO!!!
2490 return fmt.Errorf(fmt.Sprintf("OnuSwUpgradeFSM could not be started for device-id: %s, wrong internal state", dh.device.Id))
2491 }
2492 } else {
2493 logger.Errorw(ctx, "OnuSwUpgradeFSM internal FSM invalid - cannot be executed!!", log.Fields{"device-id": dh.deviceID})
2494 // maybe try a FSM reset and then again ... - TODO!!!
2495 return fmt.Errorf(fmt.Sprintf("OnuSwUpgradeFSM internal FSM could not be created for device-id: %s", dh.device.Id))
2496 }
2497 } else {
2498 logger.Errorw(ctx, "OnuSwUpgradeFSM could not be created - abort", log.Fields{"device-id": dh.deviceID})
2499 return fmt.Errorf(fmt.Sprintf("OnuSwUpgradeFSM could not be created - abort for device-id: %s", dh.device.Id))
2500 }
2501 return nil
2502}
2503
2504// removeOnuUpgradeFsm clears the Onu Software upgrade FSM
2505func (dh *deviceHandler) removeOnuUpgradeFsm(ctx context.Context) {
2506 logger.Debugw(ctx, "remove OnuSwUpgradeFSM StateMachine", log.Fields{
2507 "device-id": dh.deviceID})
2508 dh.lockUpgradeFsm.Lock()
2509 defer dh.lockUpgradeFsm.Unlock()
2510 dh.pOnuUpradeFsm = nil //resource clearing is left to garbage collector
2511}
2512
mpagenko15ff4a52021-03-02 10:09:20 +00002513// checkOnOnuImageCommit verifies if the ONU is in some upgrade state that allows for image commit and if tries to commit
2514func (dh *deviceHandler) checkOnOnuImageCommit(ctx context.Context) {
2515 pDevEntry := dh.getOnuDeviceEntry(ctx, false)
2516 if pDevEntry == nil {
2517 logger.Errorw(ctx, "No valid OnuDevice -aborting checkOnOnuImageCommit", log.Fields{"device-id": dh.deviceID})
2518 return
2519 }
2520
2521 dh.lockUpgradeFsm.RLock()
2522 defer dh.lockUpgradeFsm.RUnlock()
2523 if dh.pOnuUpradeFsm != nil {
2524 pUpgradeStatemachine := dh.pOnuUpradeFsm.pAdaptFsm.pFsm
2525 if pUpgradeStatemachine != nil {
2526 // commit is only processed in case out upgrade FSM indicates the according state (for automatic commit)
2527 // (some manual forced commit could do without)
2528 if pUpgradeStatemachine.Is(upgradeStWaitForCommit) {
mpagenko59498c12021-03-18 14:15:15 +00002529 if pDevEntry.IsImageToBeCommitted(ctx, dh.pOnuUpradeFsm.inactiveImageMeID) {
mpagenko15ff4a52021-03-02 10:09:20 +00002530 if err := pUpgradeStatemachine.Event(upgradeEvCommitSw); err != nil {
2531 logger.Errorw(ctx, "OnuSwUpgradeFSM: can't call commit event", log.Fields{"err": err})
2532 return
2533 }
2534 logger.Debugw(ctx, "OnuSwUpgradeFSM commit image requested", log.Fields{
2535 "state": pUpgradeStatemachine.Current(), "device-id": dh.deviceID})
2536 } else {
2537 logger.Errorw(ctx, "OnuSwUpgradeFSM waiting to commit, but nothing to commit on ONU - abort upgrade",
2538 log.Fields{"device-id": dh.deviceID})
2539 _ = pUpgradeStatemachine.Event(upgradeEvAbort)
2540 return
2541 }
2542 }
2543 }
2544 } else {
2545 logger.Debugw(ctx, "no ONU image to be committed", log.Fields{"device-id": dh.deviceID})
2546 }
2547}
2548
Himani Chawla6d2ae152020-09-02 13:11:20 +05302549//setBackend provides a DB backend for the specified path on the existing KV client
dbainbri4d3a0dc2020-12-02 00:33:42 +00002550func (dh *deviceHandler) setBackend(ctx context.Context, aBasePathKvStore string) *db.Backend {
Matteo Scandolo127c59d2021-01-28 11:31:18 -08002551
2552 logger.Debugw(ctx, "SetKVStoreBackend", log.Fields{"IpTarget": dh.pOpenOnuAc.KVStoreAddress,
divyadesai4d299552020-08-18 07:13:49 +00002553 "BasePathKvStore": aBasePathKvStore, "device-id": dh.deviceID})
mpagenkoaf801632020-07-03 10:00:42 +00002554 kvbackend := &db.Backend{
2555 Client: dh.pOpenOnuAc.kvClient,
2556 StoreType: dh.pOpenOnuAc.KVStoreType,
2557 /* address config update acc. to [VOL-2736] */
Matteo Scandolo127c59d2021-01-28 11:31:18 -08002558 Address: dh.pOpenOnuAc.KVStoreAddress,
mpagenkoaf801632020-07-03 10:00:42 +00002559 Timeout: dh.pOpenOnuAc.KVStoreTimeout,
2560 PathPrefix: aBasePathKvStore}
Holger Hildebrandtc54939a2020-06-17 08:14:27 +00002561
mpagenkoaf801632020-07-03 10:00:42 +00002562 return kvbackend
Holger Hildebrandt24d51952020-05-04 14:03:42 +00002563}
dbainbri4d3a0dc2020-12-02 00:33:42 +00002564func (dh *deviceHandler) getFlowOfbFields(ctx context.Context, apFlowItem *ofp.OfpFlowStats, loMatchVlan *uint16,
Himani Chawla26e555c2020-08-31 12:30:20 +05302565 loAddPcp *uint8, loIPProto *uint32) {
mpagenkodff5dda2020-08-28 11:52:01 +00002566
mpagenkodff5dda2020-08-28 11:52:01 +00002567 for _, field := range flow.GetOfbFields(apFlowItem) {
2568 switch field.Type {
2569 case of.OxmOfbFieldTypes_OFPXMT_OFB_ETH_TYPE:
2570 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002571 logger.Debugw(ctx, "flow type EthType", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002572 "EthType": strconv.FormatInt(int64(field.GetEthType()), 16)})
2573 }
mpagenko01e726e2020-10-23 09:45:29 +00002574 /* TT related temporary workaround - should not be needed anymore
mpagenkodff5dda2020-08-28 11:52:01 +00002575 case of.OxmOfbFieldTypes_OFPXMT_OFB_IP_PROTO:
2576 {
Himani Chawla26e555c2020-08-31 12:30:20 +05302577 *loIPProto = field.GetIpProto()
mpagenko01e726e2020-10-23 09:45:29 +00002578 logger.Debugw("flow type IpProto", log.Fields{"device-id": dh.deviceID,
Himani Chawla26e555c2020-08-31 12:30:20 +05302579 "IpProto": strconv.FormatInt(int64(*loIPProto), 16)})
2580 if *loIPProto == 2 {
mpagenkodff5dda2020-08-28 11:52:01 +00002581 // some workaround for TT workflow at proto == 2 (IGMP trap) -> ignore the flow
2582 // avoids installing invalid EVTOCD rule
mpagenko01e726e2020-10-23 09:45:29 +00002583 logger.Debugw("flow type IpProto 2: TT workaround: ignore flow",
2584 log.Fields{"device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05302585 return
mpagenkodff5dda2020-08-28 11:52:01 +00002586 }
2587 }
mpagenko01e726e2020-10-23 09:45:29 +00002588 */
mpagenkodff5dda2020-08-28 11:52:01 +00002589 case of.OxmOfbFieldTypes_OFPXMT_OFB_VLAN_VID:
2590 {
Himani Chawla26e555c2020-08-31 12:30:20 +05302591 *loMatchVlan = uint16(field.GetVlanVid())
mpagenkodff5dda2020-08-28 11:52:01 +00002592 loMatchVlanMask := uint16(field.GetVlanVidMask())
Himani Chawla26e555c2020-08-31 12:30:20 +05302593 if !(*loMatchVlan == uint16(of.OfpVlanId_OFPVID_PRESENT) &&
mpagenkodff5dda2020-08-28 11:52:01 +00002594 loMatchVlanMask == uint16(of.OfpVlanId_OFPVID_PRESENT)) {
Himani Chawla26e555c2020-08-31 12:30:20 +05302595 *loMatchVlan = *loMatchVlan & 0xFFF // not transparent: copy only ID bits
mpagenkodff5dda2020-08-28 11:52:01 +00002596 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00002597 logger.Debugw(ctx, "flow field type", log.Fields{"device-id": dh.deviceID,
Himani Chawla26e555c2020-08-31 12:30:20 +05302598 "VID": strconv.FormatInt(int64(*loMatchVlan), 16)})
mpagenkodff5dda2020-08-28 11:52:01 +00002599 }
2600 case of.OxmOfbFieldTypes_OFPXMT_OFB_VLAN_PCP:
2601 {
Himani Chawla26e555c2020-08-31 12:30:20 +05302602 *loAddPcp = uint8(field.GetVlanPcp())
dbainbri4d3a0dc2020-12-02 00:33:42 +00002603 logger.Debugw(ctx, "flow field type", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002604 "PCP": loAddPcp})
2605 }
2606 case of.OxmOfbFieldTypes_OFPXMT_OFB_UDP_DST:
2607 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002608 logger.Debugw(ctx, "flow field type", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002609 "UDP-DST": strconv.FormatInt(int64(field.GetUdpDst()), 16)})
2610 }
2611 case of.OxmOfbFieldTypes_OFPXMT_OFB_UDP_SRC:
2612 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002613 logger.Debugw(ctx, "flow field type", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002614 "UDP-SRC": strconv.FormatInt(int64(field.GetUdpSrc()), 16)})
2615 }
2616 case of.OxmOfbFieldTypes_OFPXMT_OFB_IPV4_DST:
2617 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002618 logger.Debugw(ctx, "flow field type", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002619 "IPv4-DST": field.GetIpv4Dst()})
2620 }
2621 case of.OxmOfbFieldTypes_OFPXMT_OFB_IPV4_SRC:
2622 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002623 logger.Debugw(ctx, "flow field type", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002624 "IPv4-SRC": field.GetIpv4Src()})
2625 }
2626 case of.OxmOfbFieldTypes_OFPXMT_OFB_METADATA:
2627 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002628 logger.Debugw(ctx, "flow field type", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002629 "Metadata": field.GetTableMetadata()})
2630 }
2631 /*
2632 default:
2633 {
2634 //all other entires ignored
2635 }
2636 */
2637 }
2638 } //for all OfbFields
Himani Chawla26e555c2020-08-31 12:30:20 +05302639}
mpagenkodff5dda2020-08-28 11:52:01 +00002640
dbainbri4d3a0dc2020-12-02 00:33:42 +00002641func (dh *deviceHandler) getFlowActions(ctx context.Context, apFlowItem *ofp.OfpFlowStats, loSetPcp *uint8, loSetVlan *uint16) {
mpagenkodff5dda2020-08-28 11:52:01 +00002642 for _, action := range flow.GetActions(apFlowItem) {
2643 switch action.Type {
2644 /* not used:
2645 case of.OfpActionType_OFPAT_OUTPUT:
2646 {
mpagenko01e726e2020-10-23 09:45:29 +00002647 logger.Debugw("flow action type", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002648 "Output": action.GetOutput()})
2649 }
2650 */
2651 case of.OfpActionType_OFPAT_PUSH_VLAN:
2652 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002653 logger.Debugw(ctx, "flow action type", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002654 "PushEthType": strconv.FormatInt(int64(action.GetPush().Ethertype), 16)})
2655 }
2656 case of.OfpActionType_OFPAT_SET_FIELD:
2657 {
2658 pActionSetField := action.GetSetField()
2659 if pActionSetField.Field.OxmClass != of.OfpOxmClass_OFPXMC_OPENFLOW_BASIC {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002660 logger.Warnw(ctx, "flow action SetField invalid OxmClass (ignored)", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002661 "OxcmClass": pActionSetField.Field.OxmClass})
2662 }
2663 if pActionSetField.Field.GetOfbField().Type == of.OxmOfbFieldTypes_OFPXMT_OFB_VLAN_VID {
Himani Chawla26e555c2020-08-31 12:30:20 +05302664 *loSetVlan = uint16(pActionSetField.Field.GetOfbField().GetVlanVid())
dbainbri4d3a0dc2020-12-02 00:33:42 +00002665 logger.Debugw(ctx, "flow Set VLAN from SetField action", log.Fields{"device-id": dh.deviceID,
Himani Chawla26e555c2020-08-31 12:30:20 +05302666 "SetVlan": strconv.FormatInt(int64(*loSetVlan), 16)})
mpagenkodff5dda2020-08-28 11:52:01 +00002667 } else if pActionSetField.Field.GetOfbField().Type == of.OxmOfbFieldTypes_OFPXMT_OFB_VLAN_PCP {
Himani Chawla26e555c2020-08-31 12:30:20 +05302668 *loSetPcp = uint8(pActionSetField.Field.GetOfbField().GetVlanPcp())
dbainbri4d3a0dc2020-12-02 00:33:42 +00002669 logger.Debugw(ctx, "flow Set PCP from SetField action", log.Fields{"device-id": dh.deviceID,
Himani Chawla26e555c2020-08-31 12:30:20 +05302670 "SetPcp": *loSetPcp})
mpagenkodff5dda2020-08-28 11:52:01 +00002671 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002672 logger.Warnw(ctx, "flow action SetField invalid FieldType", log.Fields{"device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002673 "Type": pActionSetField.Field.GetOfbField().Type})
2674 }
2675 }
2676 /*
2677 default:
2678 {
2679 //all other entires ignored
2680 }
2681 */
2682 }
2683 } //for all Actions
Himani Chawla26e555c2020-08-31 12:30:20 +05302684}
2685
2686//addFlowItemToUniPort parses the actual flow item to add it to the UniPort
dbainbri4d3a0dc2020-12-02 00:33:42 +00002687func (dh *deviceHandler) addFlowItemToUniPort(ctx context.Context, apFlowItem *ofp.OfpFlowStats, apUniPort *onuUniPort) error {
Himani Chawla26e555c2020-08-31 12:30:20 +05302688 var loSetVlan uint16 = uint16(of.OfpVlanId_OFPVID_NONE) //noValidEntry
2689 var loMatchVlan uint16 = uint16(of.OfpVlanId_OFPVID_PRESENT) //reserved VLANID entry
2690 var loAddPcp, loSetPcp uint8
2691 var loIPProto uint32
2692 /* the TechProfileId is part of the flow Metadata - compare also comment within
2693 * OLT-Adapter:openolt_flowmgr.go
2694 * Metadata 8 bytes:
2695 * Most Significant 2 Bytes = Inner VLAN
2696 * Next 2 Bytes = Tech Profile ID(TPID)
2697 * Least Significant 4 Bytes = Port ID
2698 * Flow Metadata carries Tech-Profile (TP) ID and is mandatory in all
2699 * subscriber related flows.
2700 */
2701
dbainbri4d3a0dc2020-12-02 00:33:42 +00002702 metadata := flow.GetMetadataFromWriteMetadataAction(ctx, apFlowItem)
Himani Chawla26e555c2020-08-31 12:30:20 +05302703 if metadata == 0 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002704 logger.Debugw(ctx, "flow-add invalid metadata - abort",
Himani Chawla26e555c2020-08-31 12:30:20 +05302705 log.Fields{"device-id": dh.deviceID})
mpagenko01e726e2020-10-23 09:45:29 +00002706 return fmt.Errorf("flow-add invalid metadata: %s", dh.deviceID)
Himani Chawla26e555c2020-08-31 12:30:20 +05302707 }
mpagenko551a4d42020-12-08 18:09:20 +00002708 loTpID := uint8(flow.GetTechProfileIDFromWriteMetaData(ctx, metadata))
mpagenko01e726e2020-10-23 09:45:29 +00002709 loCookie := apFlowItem.GetCookie()
2710 loCookieSlice := []uint64{loCookie}
dbainbri4d3a0dc2020-12-02 00:33:42 +00002711 logger.Debugw(ctx, "flow-add base indications", log.Fields{"device-id": dh.deviceID,
mpagenko01e726e2020-10-23 09:45:29 +00002712 "TechProf-Id": loTpID, "cookie": loCookie})
Himani Chawla26e555c2020-08-31 12:30:20 +05302713
dbainbri4d3a0dc2020-12-02 00:33:42 +00002714 dh.getFlowOfbFields(ctx, apFlowItem, &loMatchVlan, &loAddPcp, &loIPProto)
mpagenko01e726e2020-10-23 09:45:29 +00002715 /* TT related temporary workaround - should not be needed anymore
Himani Chawla26e555c2020-08-31 12:30:20 +05302716 if loIPProto == 2 {
2717 // some workaround for TT workflow at proto == 2 (IGMP trap) -> ignore the flow
2718 // avoids installing invalid EVTOCD rule
mpagenko01e726e2020-10-23 09:45:29 +00002719 logger.Debugw("flow-add type IpProto 2: TT workaround: ignore flow",
2720 log.Fields{"device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05302721 return nil
2722 }
mpagenko01e726e2020-10-23 09:45:29 +00002723 */
dbainbri4d3a0dc2020-12-02 00:33:42 +00002724 dh.getFlowActions(ctx, apFlowItem, &loSetPcp, &loSetVlan)
mpagenkodff5dda2020-08-28 11:52:01 +00002725
2726 if loSetVlan == uint16(of.OfpVlanId_OFPVID_NONE) && loMatchVlan != uint16(of.OfpVlanId_OFPVID_PRESENT) {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002727 logger.Errorw(ctx, "flow-add aborted - SetVlanId undefined, but MatchVid set", log.Fields{
mpagenkodff5dda2020-08-28 11:52:01 +00002728 "device-id": dh.deviceID, "UniPort": apUniPort.portNo,
2729 "set_vid": strconv.FormatInt(int64(loSetVlan), 16),
2730 "match_vid": strconv.FormatInt(int64(loMatchVlan), 16)})
2731 //TODO!!: Use DeviceId within the error response to rwCore
2732 // likewise also in other error response cases to calling components as requested in [VOL-3458]
mpagenko01e726e2020-10-23 09:45:29 +00002733 return fmt.Errorf("flow-add Set/Match VlanId inconsistent: %s", dh.deviceID)
mpagenkodff5dda2020-08-28 11:52:01 +00002734 }
2735 if loSetVlan == uint16(of.OfpVlanId_OFPVID_NONE) && loMatchVlan == uint16(of.OfpVlanId_OFPVID_PRESENT) {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002736 logger.Debugw(ctx, "flow-add vlan-any/copy", log.Fields{"device-id": dh.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00002737 loSetVlan = loMatchVlan //both 'transparent' (copy any)
2738 } else {
2739 //looks like OMCI value 4097 (copyFromOuter - for Uni double tagged) is not supported here
2740 if loSetVlan != uint16(of.OfpVlanId_OFPVID_PRESENT) {
2741 // not set to transparent
Himani Chawla26e555c2020-08-31 12:30:20 +05302742 loSetVlan &= 0x0FFF //mask VID bits as prerequisite for vlanConfigFsm
mpagenkodff5dda2020-08-28 11:52:01 +00002743 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00002744 logger.Debugw(ctx, "flow-add vlan-set", log.Fields{"device-id": dh.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00002745 }
mpagenko9a304ea2020-12-16 15:54:01 +00002746
2747 //mutex protection as the update_flow rpc maybe running concurrently for different flows, perhaps also activities
mpagenkof1fc3862021-02-16 10:09:52 +00002748 dh.lockVlanConfig.RLock()
mpagenko9a304ea2020-12-16 15:54:01 +00002749 logger.Debugw(ctx, "flow-add got lock", log.Fields{"device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05302750 if _, exist := dh.UniVlanConfigFsmMap[apUniPort.uniID]; exist {
mpagenkof1fc3862021-02-16 10:09:52 +00002751 err := dh.UniVlanConfigFsmMap[apUniPort.uniID].SetUniFlowParams(ctx, loTpID, loCookieSlice,
mpagenko01e726e2020-10-23 09:45:29 +00002752 loMatchVlan, loSetVlan, loSetPcp)
mpagenkof1fc3862021-02-16 10:09:52 +00002753 dh.lockVlanConfig.RUnlock()
2754 return err
mpagenkodff5dda2020-08-28 11:52:01 +00002755 }
mpagenkof1fc3862021-02-16 10:09:52 +00002756 dh.lockVlanConfig.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00002757 return dh.createVlanFilterFsm(ctx, apUniPort, loTpID, loCookieSlice,
mpagenkofc4f56e2020-11-04 17:17:49 +00002758 loMatchVlan, loSetVlan, loSetPcp, OmciVlanFilterAddDone)
mpagenko01e726e2020-10-23 09:45:29 +00002759}
2760
2761//removeFlowItemFromUniPort parses the actual flow item to remove it from the UniPort
dbainbri4d3a0dc2020-12-02 00:33:42 +00002762func (dh *deviceHandler) removeFlowItemFromUniPort(ctx context.Context, apFlowItem *ofp.OfpFlowStats, apUniPort *onuUniPort) error {
mpagenko01e726e2020-10-23 09:45:29 +00002763 //optimization and assumption: the flow cookie uniquely identifies the flow and with that the internal rule
2764 //hence only the cookie is used here to find the relevant flow and possibly remove the rule
2765 //no extra check is done on the rule parameters
2766 //accordingly the removal is done only once - for the first found flow with that cookie, even though
2767 // at flow creation is not assured, that the same cookie is not configured for different flows - just assumed
2768 //additionally it is assumed here, that removal can only be done for one cookie per flow in a sequence (different
2769 // from addFlow - where at reconcilement multiple cookies per flow ) can be configured in one sequence)
mpagenkofc4f56e2020-11-04 17:17:49 +00002770 // - some possible 'delete-all' sequence would have to be implemented separately (where the cookies are don't care anyway)
mpagenko01e726e2020-10-23 09:45:29 +00002771 loCookie := apFlowItem.GetCookie()
dbainbri4d3a0dc2020-12-02 00:33:42 +00002772 logger.Debugw(ctx, "flow-remove base indications", log.Fields{"device-id": dh.deviceID, "cookie": loCookie})
mpagenko01e726e2020-10-23 09:45:29 +00002773
2774 /* TT related temporary workaround - should not be needed anymore
2775 for _, field := range flow.GetOfbFields(apFlowItem) {
2776 if field.Type == of.OxmOfbFieldTypes_OFPXMT_OFB_IP_PROTO {
2777 loIPProto := field.GetIpProto()
mpagenko551a4d42020-12-08 18:09:20 +00002778 logger.Debugw(ctx, "flow type IpProto", log.Fields{"device-id": dh.deviceID,
mpagenko01e726e2020-10-23 09:45:29 +00002779 "IpProto": strconv.FormatInt(int64(loIPProto), 16)})
2780 if loIPProto == 2 {
2781 // some workaround for TT workflow on proto == 2 (IGMP trap) -> the flow was not added, no need to remove
mpagenko551a4d42020-12-08 18:09:20 +00002782 logger.Debugw(ctx, "flow-remove type IpProto 2: TT workaround: ignore flow",
mpagenko01e726e2020-10-23 09:45:29 +00002783 log.Fields{"device-id": dh.deviceID})
2784 return nil
2785 }
2786 }
2787 } //for all OfbFields
2788 */
2789
mpagenko9a304ea2020-12-16 15:54:01 +00002790 //mutex protection as the update_flow rpc maybe running concurrently for different flows, perhaps also activities
mpagenkof1fc3862021-02-16 10:09:52 +00002791 dh.lockVlanConfig.RLock()
2792 defer dh.lockVlanConfig.RUnlock()
mpagenko01e726e2020-10-23 09:45:29 +00002793 if _, exist := dh.UniVlanConfigFsmMap[apUniPort.uniID]; exist {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002794 return dh.UniVlanConfigFsmMap[apUniPort.uniID].RemoveUniFlowParams(ctx, loCookie)
mpagenko01e726e2020-10-23 09:45:29 +00002795 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00002796 logger.Debugw(ctx, "flow-remove called, but no flow is configured (no VlanConfigFsm, flow already removed) ",
mpagenko01e726e2020-10-23 09:45:29 +00002797 log.Fields{"device-id": dh.deviceID})
2798 //but as we regard the flow as not existing = removed we respond just ok
mpagenkofc4f56e2020-11-04 17:17:49 +00002799 // and treat the reason accordingly (which in the normal removal procedure is initiated by the FSM)
dbainbri4d3a0dc2020-12-02 00:33:42 +00002800 go dh.deviceProcStatusUpdate(ctx, OmciVlanFilterRemDone)
mpagenkofc4f56e2020-11-04 17:17:49 +00002801
mpagenko01e726e2020-10-23 09:45:29 +00002802 return nil
mpagenkodff5dda2020-08-28 11:52:01 +00002803}
2804
Himani Chawla26e555c2020-08-31 12:30:20 +05302805// createVlanFilterFsm initializes and runs the VlanFilter FSM to transfer OMCI related VLAN config
mpagenko9a304ea2020-12-16 15:54:01 +00002806// if this function is called from possibly concurrent processes it must be mutex-protected from the caller!
mpagenko551a4d42020-12-08 18:09:20 +00002807func (dh *deviceHandler) createVlanFilterFsm(ctx context.Context, apUniPort *onuUniPort, aTpID uint8, aCookieSlice []uint64,
mpagenko01e726e2020-10-23 09:45:29 +00002808 aMatchVlan uint16, aSetVlan uint16, aSetPcp uint8, aDevEvent OnuDeviceEvent) error {
mpagenkodff5dda2020-08-28 11:52:01 +00002809 chVlanFilterFsm := make(chan Message, 2048)
2810
dbainbri4d3a0dc2020-12-02 00:33:42 +00002811 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
mpagenkodff5dda2020-08-28 11:52:01 +00002812 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002813 logger.Errorw(ctx, "No valid OnuDevice -aborting", log.Fields{"device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05302814 return fmt.Errorf("no valid OnuDevice for device-id %x - aborting", dh.deviceID)
mpagenkodff5dda2020-08-28 11:52:01 +00002815 }
2816
dbainbri4d3a0dc2020-12-02 00:33:42 +00002817 pVlanFilterFsm := NewUniVlanConfigFsm(ctx, dh, pDevEntry.PDevOmciCC, apUniPort, dh.pOnuTP,
mpagenko01e726e2020-10-23 09:45:29 +00002818 pDevEntry.pOnuDB, aTpID, aDevEvent, "UniVlanConfigFsm", chVlanFilterFsm,
2819 dh.pOpenOnuAc.AcceptIncrementalEvto, aCookieSlice, aMatchVlan, aSetVlan, aSetPcp)
mpagenkodff5dda2020-08-28 11:52:01 +00002820 if pVlanFilterFsm != nil {
mpagenkof1fc3862021-02-16 10:09:52 +00002821 dh.lockVlanConfig.Lock()
mpagenko7d6bb022021-03-11 15:07:55 +00002822 //ensure the mutex is locked throughout the state transition to 'starting' to prevent unintended (ignored) events to be sent there
2823 // (from parallel processing)
2824 defer dh.lockVlanConfig.Unlock()
Himani Chawla26e555c2020-08-31 12:30:20 +05302825 dh.UniVlanConfigFsmMap[apUniPort.uniID] = pVlanFilterFsm
mpagenkodff5dda2020-08-28 11:52:01 +00002826 pVlanFilterStatemachine := pVlanFilterFsm.pAdaptFsm.pFsm
2827 if pVlanFilterStatemachine != nil {
2828 if pVlanFilterStatemachine.Is(vlanStDisabled) {
2829 if err := pVlanFilterStatemachine.Event(vlanEvStart); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002830 logger.Warnw(ctx, "UniVlanConfigFsm: can't start", log.Fields{"err": err})
Himani Chawla26e555c2020-08-31 12:30:20 +05302831 return fmt.Errorf("can't start UniVlanConfigFsm for device-id %x", dh.deviceID)
mpagenkodff5dda2020-08-28 11:52:01 +00002832 }
Himani Chawla26e555c2020-08-31 12:30:20 +05302833 /***** UniVlanConfigFsm started */
dbainbri4d3a0dc2020-12-02 00:33:42 +00002834 logger.Debugw(ctx, "UniVlanConfigFsm started", log.Fields{
Himani Chawla26e555c2020-08-31 12:30:20 +05302835 "state": pVlanFilterStatemachine.Current(), "device-id": dh.deviceID,
2836 "UniPort": apUniPort.portNo})
mpagenkodff5dda2020-08-28 11:52:01 +00002837 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002838 logger.Warnw(ctx, "wrong state of UniVlanConfigFsm - want: disabled", log.Fields{
mpagenkodff5dda2020-08-28 11:52:01 +00002839 "have": pVlanFilterStatemachine.Current(), "device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05302840 return fmt.Errorf("uniVlanConfigFsm not in expected disabled state for device-id %x", dh.deviceID)
mpagenkodff5dda2020-08-28 11:52:01 +00002841 }
2842 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002843 logger.Errorw(ctx, "UniVlanConfigFsm StateMachine invalid - cannot be executed!!", log.Fields{
mpagenkodff5dda2020-08-28 11:52:01 +00002844 "device-id": dh.deviceID})
Himani Chawla26e555c2020-08-31 12:30:20 +05302845 return fmt.Errorf("uniVlanConfigFsm invalid for device-id %x", dh.deviceID)
mpagenkodff5dda2020-08-28 11:52:01 +00002846 }
2847 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002848 logger.Errorw(ctx, "UniVlanConfigFsm could not be created - abort!!", log.Fields{
mpagenkodff5dda2020-08-28 11:52:01 +00002849 "device-id": dh.deviceID, "UniPort": apUniPort.portNo})
Himani Chawla26e555c2020-08-31 12:30:20 +05302850 return fmt.Errorf("uniVlanConfigFsm could not be created for device-id %x", dh.deviceID)
mpagenkodff5dda2020-08-28 11:52:01 +00002851 }
2852 return nil
2853}
2854
mpagenkofc4f56e2020-11-04 17:17:49 +00002855//VerifyVlanConfigRequest checks on existence of a given uniPort
2856// and starts verification of flow config based on that
mpagenko551a4d42020-12-08 18:09:20 +00002857func (dh *deviceHandler) VerifyVlanConfigRequest(ctx context.Context, aUniID uint8, aTpID uint8) {
mpagenkofc4f56e2020-11-04 17:17:49 +00002858 //ensure that the given uniID is available (configured) in the UniPort class (used for OMCI entities)
2859 var pCurrentUniPort *onuUniPort
2860 for _, uniPort := range dh.uniEntityMap {
2861 // only if this port is validated for operState transfer
2862 if uniPort.uniID == uint8(aUniID) {
2863 pCurrentUniPort = uniPort
2864 break //found - end search loop
2865 }
2866 }
2867 if pCurrentUniPort == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002868 logger.Debugw(ctx, "VerifyVlanConfig aborted: requested uniID not found in PortDB",
mpagenkofc4f56e2020-11-04 17:17:49 +00002869 log.Fields{"device-id": dh.deviceID, "uni-id": aUniID})
2870 return
2871 }
mpagenko551a4d42020-12-08 18:09:20 +00002872 dh.verifyUniVlanConfigRequest(ctx, pCurrentUniPort, aTpID)
mpagenkofc4f56e2020-11-04 17:17:49 +00002873}
2874
mpagenkodff5dda2020-08-28 11:52:01 +00002875//verifyUniVlanConfigRequest checks on existence of flow configuration and starts it accordingly
mpagenko551a4d42020-12-08 18:09:20 +00002876func (dh *deviceHandler) verifyUniVlanConfigRequest(ctx context.Context, apUniPort *onuUniPort, aTpID uint8) {
mpagenkodff5dda2020-08-28 11:52:01 +00002877 //TODO!! verify and start pending flow configuration
2878 //some pending config request my exist in case the UniVlanConfig FSM was already started - with internal data -
2879 //but execution was set to 'on hold' as first the TechProfile config had to be applied
mpagenkof1fc3862021-02-16 10:09:52 +00002880
2881 dh.lockVlanConfig.RLock()
Himani Chawla26e555c2020-08-31 12:30:20 +05302882 if pVlanFilterFsm, exist := dh.UniVlanConfigFsmMap[apUniPort.uniID]; exist {
mpagenkof1fc3862021-02-16 10:09:52 +00002883 dh.lockVlanConfig.RUnlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002884 //VlanFilterFsm exists and was already started (assumed to wait for TechProfile execution here)
2885 pVlanFilterStatemachine := pVlanFilterFsm.pAdaptFsm.pFsm
2886 if pVlanFilterStatemachine != nil {
mpagenko551a4d42020-12-08 18:09:20 +00002887 //if this was an event of the TP processing that was waited for in the VlanFilterFsm
2888 if pVlanFilterFsm.GetWaitingTpID() == aTpID {
2889 if pVlanFilterStatemachine.Is(vlanStWaitingTechProf) {
2890 if err := pVlanFilterStatemachine.Event(vlanEvContinueConfig); err != nil {
2891 logger.Warnw(ctx, "UniVlanConfigFsm: can't continue processing", log.Fields{"err": err,
2892 "device-id": dh.deviceID, "UniPort": apUniPort.portNo})
2893 } else {
2894 /***** UniVlanConfigFsm continued */
2895 logger.Debugw(ctx, "UniVlanConfigFsm continued", log.Fields{
2896 "state": pVlanFilterStatemachine.Current(), "device-id": dh.deviceID,
2897 "UniPort": apUniPort.portNo})
2898 }
2899 } else if pVlanFilterStatemachine.Is(vlanStIncrFlowWaitTP) {
2900 if err := pVlanFilterStatemachine.Event(vlanEvIncrFlowConfig); err != nil {
2901 logger.Warnw(ctx, "UniVlanConfigFsm: can't continue processing", log.Fields{"err": err,
2902 "device-id": dh.deviceID, "UniPort": apUniPort.portNo})
2903 } else {
2904 /***** UniVlanConfigFsm continued */
2905 logger.Debugw(ctx, "UniVlanConfigFsm continued with incremental flow", log.Fields{
2906 "state": pVlanFilterStatemachine.Current(), "device-id": dh.deviceID,
2907 "UniPort": apUniPort.portNo})
2908 }
mpagenkodff5dda2020-08-28 11:52:01 +00002909 } else {
mpagenko551a4d42020-12-08 18:09:20 +00002910 logger.Debugw(ctx, "no state of UniVlanConfigFsm to be continued", log.Fields{
2911 "have": pVlanFilterStatemachine.Current(), "device-id": dh.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00002912 "UniPort": apUniPort.portNo})
2913 }
2914 } else {
mpagenko551a4d42020-12-08 18:09:20 +00002915 logger.Debugw(ctx, "TechProfile Ready event for TpId that was not waited for in the VlanConfigFsm - continue waiting", log.Fields{
2916 "state": pVlanFilterStatemachine.Current(), "device-id": dh.deviceID,
2917 "UniPort": apUniPort.portNo, "techprofile-id (done)": aTpID})
mpagenkodff5dda2020-08-28 11:52:01 +00002918 }
2919 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002920 logger.Debugw(ctx, "UniVlanConfigFsm StateMachine does not exist, no flow processing", log.Fields{
mpagenko551a4d42020-12-08 18:09:20 +00002921 "device-id": dh.deviceID, "UniPort": apUniPort.portNo})
mpagenkodff5dda2020-08-28 11:52:01 +00002922 }
mpagenkof1fc3862021-02-16 10:09:52 +00002923 } else {
2924 dh.lockVlanConfig.RUnlock()
2925 }
mpagenkodff5dda2020-08-28 11:52:01 +00002926}
2927
2928//RemoveVlanFilterFsm deletes the stored pointer to the VlanConfigFsm
2929// intention is to provide this method to be called from VlanConfigFsm itself, when resources (and methods!) are cleaned up
dbainbri4d3a0dc2020-12-02 00:33:42 +00002930func (dh *deviceHandler) RemoveVlanFilterFsm(ctx context.Context, apUniPort *onuUniPort) {
2931 logger.Debugw(ctx, "remove UniVlanConfigFsm StateMachine", log.Fields{
mpagenkodff5dda2020-08-28 11:52:01 +00002932 "device-id": dh.deviceID, "uniPort": apUniPort.portNo})
2933 //save to do, even if entry dows not exist
mpagenkof1fc3862021-02-16 10:09:52 +00002934 dh.lockVlanConfig.Lock()
Himani Chawla26e555c2020-08-31 12:30:20 +05302935 delete(dh.UniVlanConfigFsmMap, apUniPort.uniID)
mpagenkof1fc3862021-02-16 10:09:52 +00002936 dh.lockVlanConfig.Unlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002937}
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002938
mpagenkof1fc3862021-02-16 10:09:52 +00002939//startWritingOnuDataToKvStore initiates the KVStore write of ONU persistent data
2940func (dh *deviceHandler) startWritingOnuDataToKvStore(ctx context.Context, aPDevEntry *OnuDeviceEntry) error {
2941 dh.mutexKvStoreContext.Lock() //this write routine may (could) be called with the same context,
2942 defer dh.mutexKvStoreContext.Unlock() //this write routine may (could) be called with the same context,
2943 // obviously then parallel processing on the cancel must be avoided
2944 // deadline context to ensure completion of background routines waited for
2945 //20200721: 10s proved to be less in 8*8 ONU test on local vbox machine with debug, might be further adapted
2946 deadline := time.Now().Add(dh.pOpenOnuAc.maxTimeoutInterAdapterComm) //allowed run time to finish before execution
2947 dctx, cancel := context.WithDeadline(context.Background(), deadline)
2948
2949 aPDevEntry.resetKvProcessingErrorIndication()
2950 var wg sync.WaitGroup
2951 wg.Add(1) // for the 1 go routine to finish
2952
2953 go aPDevEntry.updateOnuKvStore(log.WithSpanFromContext(dctx, ctx), &wg)
2954 dh.waitForCompletion(ctx, cancel, &wg, "UpdateKvStore") //wait for background process to finish
2955
2956 return aPDevEntry.getKvProcessingErrorIndication()
2957}
2958
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002959//storePersUniFlowConfig updates local storage of OnuUniFlowConfig and writes it into kv-store afterwards to have it
2960//available for potential reconcilement
mpagenkof1fc3862021-02-16 10:09:52 +00002961func (dh *deviceHandler) storePersUniFlowConfig(ctx context.Context, aUniID uint8,
2962 aUniVlanFlowParams *[]uniVlanFlowParams, aWriteToKvStore bool) error {
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002963
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00002964 if dh.isReconciling() {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002965 logger.Debugw(ctx, "reconciling - don't store persistent UniFlowConfig", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002966 return nil
2967 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00002968 logger.Debugw(ctx, "Store or clear persistent UniFlowConfig", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002969
dbainbri4d3a0dc2020-12-02 00:33:42 +00002970 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002971 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002972 logger.Errorw(ctx, "No valid OnuDevice - aborting", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002973 return fmt.Errorf("no valid OnuDevice: %s", dh.deviceID)
2974 }
2975 pDevEntry.updateOnuUniFlowConfig(aUniID, aUniVlanFlowParams)
2976
mpagenkof1fc3862021-02-16 10:09:52 +00002977 if aWriteToKvStore {
2978 return dh.startWritingOnuDataToKvStore(ctx, pDevEntry)
2979 }
2980 return nil
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002981}
2982
dbainbri4d3a0dc2020-12-02 00:33:42 +00002983func (dh *deviceHandler) waitForCompletion(ctx context.Context, cancel context.CancelFunc, wg *sync.WaitGroup, aCallerIdent string) {
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002984 defer cancel() //ensure termination of context (may be pro forma)
2985 wg.Wait()
dbainbri4d3a0dc2020-12-02 00:33:42 +00002986 logger.Debugw(ctx, "WaitGroup processing completed", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00002987 "device-id": dh.deviceID, "called from": aCallerIdent})
Holger Hildebrandt47555e72020-09-21 11:07:24 +00002988}
2989
dbainbri4d3a0dc2020-12-02 00:33:42 +00002990func (dh *deviceHandler) deviceReasonUpdate(ctx context.Context, deviceReason uint8, notifyCore bool) error {
Holger Hildebrandt80129db2020-11-23 10:49:32 +00002991
Holger Hildebrandtbe523842021-03-10 10:47:18 +00002992 dh.setDeviceReason(deviceReason)
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002993 if notifyCore {
Holger Hildebrandt80129db2020-11-23 10:49:32 +00002994 //TODO with VOL-3045/VOL-3046: return the error and stop further processing at calling position
dbainbri4d3a0dc2020-12-02 00:33:42 +00002995 if err := dh.coreProxy.DeviceReasonUpdate(log.WithSpanFromContext(context.TODO(), ctx), dh.deviceID, deviceReasonMap[deviceReason]); err != nil {
2996 logger.Errorf(ctx, "DeviceReasonUpdate error: %s",
Holger Hildebrandt3a644642020-12-02 09:46:18 +00002997 log.Fields{"device-id": dh.deviceID, "error": err}, deviceReasonMap[deviceReason])
Holger Hildebrandt80129db2020-11-23 10:49:32 +00002998 return err
2999 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00003000 logger.Infof(ctx, "DeviceReasonUpdate success: %s - device-id: %s", deviceReasonMap[deviceReason], dh.deviceID)
Holger Hildebrandt80129db2020-11-23 10:49:32 +00003001 return nil
3002 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00003003 logger.Infof(ctx, "Don't notify core about DeviceReasonUpdate: %s - device-id: %s", deviceReasonMap[deviceReason], dh.deviceID)
Holger Hildebrandt3a644642020-12-02 09:46:18 +00003004 return nil
3005}
3006
dbainbri4d3a0dc2020-12-02 00:33:42 +00003007func (dh *deviceHandler) storePersistentData(ctx context.Context) error {
3008 pDevEntry := dh.getOnuDeviceEntry(ctx, true)
Holger Hildebrandt3a644642020-12-02 09:46:18 +00003009 if pDevEntry == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00003010 logger.Warnw(ctx, "No valid OnuDevice", log.Fields{"device-id": dh.deviceID})
Holger Hildebrandt3a644642020-12-02 09:46:18 +00003011 return fmt.Errorf("no valid OnuDevice: %s", dh.deviceID)
3012 }
mpagenkof1fc3862021-02-16 10:09:52 +00003013 return dh.startWritingOnuDataToKvStore(ctx, pDevEntry)
Holger Hildebrandt80129db2020-11-23 10:49:32 +00003014}
3015
Holger Hildebrandt47555e72020-09-21 11:07:24 +00003016func (dh *deviceHandler) combineErrorStrings(errS ...error) error {
3017 var errStr string = ""
3018 for _, err := range errS {
3019 if err != nil {
3020 errStr = errStr + err.Error() + " "
3021 }
3022 }
3023 if errStr != "" {
3024 return fmt.Errorf("%s: %s", errStr, dh.deviceID)
3025 }
3026 return nil
3027}
ozgecanetsiab5000ef2020-11-27 14:38:20 +03003028
3029// getUniPortMEEntityID takes uniPortNo as the input and returns the Entity ID corresponding to this UNI-G ME Instance
3030func (dh *deviceHandler) getUniPortMEEntityID(uniPortNo uint32) (uint16, error) {
3031 dh.lockDevice.RLock()
3032 defer dh.lockDevice.RUnlock()
3033 if uniPort, ok := dh.uniEntityMap[uniPortNo]; ok {
3034 return uniPort.entityID, nil
3035 }
3036 return 0, errors.New("error-fetching-uni-port")
3037}
Girish Gowdrae09a6202021-01-12 18:10:59 -08003038
3039// updatePmConfig updates the pm metrics config.
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003040func (dh *deviceHandler) updatePmConfig(ctx context.Context, pmConfigs *voltha.PmConfigs) error {
3041 var errorsList []error
3042 logger.Infow(ctx, "update-pm-config", log.Fields{"device-id": dh.device.Id, "new-pm-configs": pmConfigs, "old-pm-config": dh.pmConfigs})
Girish Gowdrae09a6202021-01-12 18:10:59 -08003043
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003044 errorsList = append(dh.handleGlobalPmConfigUpdates(ctx, pmConfigs), errorsList...)
3045 errorsList = append(dh.handleGroupPmConfigUpdates(ctx, pmConfigs), errorsList...)
3046 errorsList = append(dh.handleStandalonePmConfigUpdates(ctx, pmConfigs), errorsList...)
3047
3048 // Note that if more than one pm config field is updated in a given call, it is possible that partial pm config is handled
3049 // successfully.
3050 // TODO: Although it is possible to revert to old config in case of partial failure, the code becomes quite complex. Needs more investigation
3051 // Is it possible the rw-core reverts to old config on partial failure but adapter retains a partial new config?
3052 if len(errorsList) > 0 {
3053 logger.Errorw(ctx, "one-or-more-pm-config-failed", log.Fields{"device-id": dh.deviceID, "pmConfig": dh.pmConfigs})
3054 return fmt.Errorf("errors-handling-one-or-more-pm-config, errors:%v", errorsList)
Girish Gowdrae09a6202021-01-12 18:10:59 -08003055 }
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003056 logger.Infow(ctx, "pm-config-updated", log.Fields{"device-id": dh.deviceID, "pmConfig": dh.pmConfigs})
3057 return nil
Girish Gowdrae09a6202021-01-12 18:10:59 -08003058}
3059
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003060func (dh *deviceHandler) handleGlobalPmConfigUpdates(ctx context.Context, pmConfigs *voltha.PmConfigs) []error {
3061 var err error
3062 var errorsList []error
Girish Gowdra36ccf7d2021-02-25 20:42:51 -08003063 logger.Infow(ctx, "handling-global-pm-config-params - start", log.Fields{"device-id": dh.device.Id})
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003064
3065 if pmConfigs.DefaultFreq != dh.pmConfigs.DefaultFreq {
3066 if err = dh.pOnuMetricsMgr.updateDefaultFrequency(ctx, pmConfigs); err != nil {
3067 errorsList = append(errorsList, err)
3068 }
3069 }
Girish Gowdra36ccf7d2021-02-25 20:42:51 -08003070 logger.Infow(ctx, "handling-global-pm-config-params - done", log.Fields{"device-id": dh.device.Id})
mpagenko15ff4a52021-03-02 10:09:20 +00003071
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003072 return errorsList
3073}
3074
3075func (dh *deviceHandler) handleGroupPmConfigUpdates(ctx context.Context, pmConfigs *voltha.PmConfigs) []error {
3076 var err error
3077 var errorsList []error
Girish Gowdra36ccf7d2021-02-25 20:42:51 -08003078 logger.Debugw(ctx, "handling-group-pm-config-params - start", log.Fields{"device-id": dh.device.Id})
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003079 // Check if group metric related config is updated
3080 for _, v := range pmConfigs.Groups {
3081 dh.pOnuMetricsMgr.onuMetricsManagerLock.RLock()
3082 m, ok := dh.pOnuMetricsMgr.groupMetricMap[v.GroupName]
3083 dh.pOnuMetricsMgr.onuMetricsManagerLock.RUnlock()
3084
3085 if ok && m.frequency != v.GroupFreq {
3086 if err = dh.pOnuMetricsMgr.updateGroupFreq(ctx, v.GroupName, pmConfigs); err != nil {
3087 errorsList = append(errorsList, err)
3088 }
3089 }
3090 if ok && m.enabled != v.Enabled {
3091 if err = dh.pOnuMetricsMgr.updateGroupSupport(ctx, v.GroupName, pmConfigs); err != nil {
3092 errorsList = append(errorsList, err)
3093 }
3094 }
3095 }
Girish Gowdra36ccf7d2021-02-25 20:42:51 -08003096 logger.Debugw(ctx, "handling-group-pm-config-params - done", log.Fields{"device-id": dh.device.Id})
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003097 return errorsList
3098}
3099
3100func (dh *deviceHandler) handleStandalonePmConfigUpdates(ctx context.Context, pmConfigs *voltha.PmConfigs) []error {
3101 var err error
3102 var errorsList []error
Girish Gowdra36ccf7d2021-02-25 20:42:51 -08003103 logger.Debugw(ctx, "handling-individual-pm-config-params - start", log.Fields{"device-id": dh.device.Id})
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003104 // Check if standalone metric related config is updated
3105 for _, v := range pmConfigs.Metrics {
3106 dh.pOnuMetricsMgr.onuMetricsManagerLock.RLock()
Girish Gowdraaf0ad632021-01-27 13:00:01 -08003107 m, ok := dh.pOnuMetricsMgr.standaloneMetricMap[v.Name]
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003108 dh.pOnuMetricsMgr.onuMetricsManagerLock.RUnlock()
3109
3110 if ok && m.frequency != v.SampleFreq {
3111 if err = dh.pOnuMetricsMgr.updateMetricFreq(ctx, v.Name, pmConfigs); err != nil {
3112 errorsList = append(errorsList, err)
3113 }
3114 }
3115 if ok && m.enabled != v.Enabled {
3116 if err = dh.pOnuMetricsMgr.updateMetricSupport(ctx, v.Name, pmConfigs); err != nil {
3117 errorsList = append(errorsList, err)
3118 }
3119 }
3120 }
Girish Gowdra36ccf7d2021-02-25 20:42:51 -08003121 logger.Debugw(ctx, "handling-individual-pm-config-params - done", log.Fields{"device-id": dh.device.Id})
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003122 return errorsList
3123}
3124
3125// nolint: gocyclo
Girish Gowdrae09a6202021-01-12 18:10:59 -08003126func (dh *deviceHandler) startCollector(ctx context.Context) {
3127 logger.Debugf(ctx, "startingCollector")
3128
3129 // Start routine to process OMCI GET Responses
3130 go dh.pOnuMetricsMgr.processOmciMessages(ctx)
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003131 // Initialize the next metric collection time.
3132 // Normally done when the onu_metrics_manager is initialized the first time, but needed again later when ONU is
3133 // reset like onu rebooted.
3134 dh.pOnuMetricsMgr.initializeMetricCollectionTime(ctx)
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003135 dh.setCollectorIsRunning(true)
Girish Gowdrae09a6202021-01-12 18:10:59 -08003136 for {
3137 select {
3138 case <-dh.stopCollector:
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003139 dh.setCollectorIsRunning(false)
Girish Gowdrae09a6202021-01-12 18:10:59 -08003140 logger.Debugw(ctx, "stopping-collector-for-onu", log.Fields{"device-id": dh.device.Id})
Girish Gowdrae0140f02021-02-02 16:55:09 -08003141 // Stop the L2 PM FSM
3142 go func() {
3143 if dh.pOnuMetricsMgr.pAdaptFsm != nil && dh.pOnuMetricsMgr.pAdaptFsm.pFsm != nil {
3144 if err := dh.pOnuMetricsMgr.pAdaptFsm.pFsm.Event(l2PmEventStop); err != nil {
3145 logger.Errorw(ctx, "error calling event", log.Fields{"device-id": dh.deviceID, "err": err})
3146 }
3147 } else {
3148 logger.Errorw(ctx, "metrics manager fsm not initialized", log.Fields{"device-id": dh.deviceID})
3149 }
3150 }()
Girish Gowdra7b0ee5c2021-03-19 21:48:15 -07003151 if dh.pOnuMetricsMgr.getOmciProcessingStatus() {
3152 dh.pOnuMetricsMgr.stopProcessingOmciResponses <- true // Stop the OMCI GET response processing routine
3153 }
3154 if dh.pOnuMetricsMgr.getTickGenerationStatus() {
3155 dh.pOnuMetricsMgr.stopTicks <- true
3156 }
Girish Gowdrae0140f02021-02-02 16:55:09 -08003157
Girish Gowdrae09a6202021-01-12 18:10:59 -08003158 return
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003159 case <-time.After(time.Duration(FrequencyGranularity) * time.Second): // Check every FrequencyGranularity to see if it is time for collecting metrics
3160 if !dh.pmConfigs.FreqOverride { // If FreqOverride is false, then nextGlobalMetricCollectionTime applies
3161 // If the current time is eqaul to or greater than the nextGlobalMetricCollectionTime, collect the group and standalone metrics
3162 if time.Now().Equal(dh.pOnuMetricsMgr.nextGlobalMetricCollectionTime) || time.Now().After(dh.pOnuMetricsMgr.nextGlobalMetricCollectionTime) {
3163 go dh.pOnuMetricsMgr.collectAllGroupAndStandaloneMetrics(ctx)
Girish Gowdraaf0ad632021-01-27 13:00:01 -08003164 // Update the next metric collection time.
3165 dh.pOnuMetricsMgr.nextGlobalMetricCollectionTime = time.Now().Add(time.Duration(dh.pmConfigs.DefaultFreq) * time.Second)
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003166 }
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003167 } else {
3168 if dh.pmConfigs.Grouped { // metrics are managed as a group
3169 // parse through the group and standalone metrics to see it is time to collect their metrics
3170 dh.pOnuMetricsMgr.onuMetricsManagerLock.RLock() // Rlock as we are reading groupMetricMap and standaloneMetricMap
Girish Gowdrae09a6202021-01-12 18:10:59 -08003171
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003172 for n, g := range dh.pOnuMetricsMgr.groupMetricMap {
3173 // If the group is enabled AND (current time is equal to OR after nextCollectionInterval, collect the group metric)
Girish Gowdrae0140f02021-02-02 16:55:09 -08003174 // Since the L2 PM counters are collected in a separate FSM, we should avoid those counters in the check.
3175 if g.enabled && !g.isL2PMCounter && (time.Now().Equal(g.nextCollectionInterval) || time.Now().After(g.nextCollectionInterval)) {
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003176 go dh.pOnuMetricsMgr.collectGroupMetric(ctx, n)
3177 }
3178 }
3179 for n, m := range dh.pOnuMetricsMgr.standaloneMetricMap {
3180 // If the standalone is enabled AND (current time is equal to OR after nextCollectionInterval, collect the metric)
3181 if m.enabled && (time.Now().Equal(m.nextCollectionInterval) || time.Now().After(m.nextCollectionInterval)) {
3182 go dh.pOnuMetricsMgr.collectStandaloneMetric(ctx, n)
3183 }
3184 }
3185 dh.pOnuMetricsMgr.onuMetricsManagerLock.RUnlock()
3186
3187 // parse through the group and update the next metric collection time
3188 dh.pOnuMetricsMgr.onuMetricsManagerLock.Lock() // Lock as we are writing the next metric collection time
3189 for _, g := range dh.pOnuMetricsMgr.groupMetricMap {
3190 // If group enabled, and the nextCollectionInterval is old (before or equal to current time), update the next collection time stamp
Girish Gowdrae0140f02021-02-02 16:55:09 -08003191 // Since the L2 PM counters are collected and managed in a separate FSM, we should avoid those counters in the check.
3192 if g.enabled && !g.isL2PMCounter && (g.nextCollectionInterval.Before(time.Now()) || g.nextCollectionInterval.Equal(time.Now())) {
Girish Gowdra5a7c4922021-01-22 18:33:41 -08003193 g.nextCollectionInterval = time.Now().Add(time.Duration(g.frequency) * time.Second)
3194 }
3195 }
3196 // parse through the standalone metrics and update the next metric collection time
3197 for _, m := range dh.pOnuMetricsMgr.standaloneMetricMap {
3198 // If standalone metrics enabled, and the nextCollectionInterval is old (before or equal to current time), update the next collection time stamp
3199 if m.enabled && (m.nextCollectionInterval.Before(time.Now()) || m.nextCollectionInterval.Equal(time.Now())) {
3200 m.nextCollectionInterval = time.Now().Add(time.Duration(m.frequency) * time.Second)
3201 }
3202 }
3203 dh.pOnuMetricsMgr.onuMetricsManagerLock.Unlock()
3204 } /* else { // metrics are not managed as a group
3205 // TODO: We currently do not have standalone metrics. When available, add code here to fetch the metric.
3206 } */
3207 }
Girish Gowdrae09a6202021-01-12 18:10:59 -08003208 }
3209 }
3210}
kesavandfdf77632021-01-26 23:40:33 -05003211
3212func (dh *deviceHandler) getUniPortStatus(ctx context.Context, uniInfo *extension.GetOnuUniInfoRequest) *extension.SingleGetValueResponse {
3213
3214 portStatus := NewUniPortStatus(dh.pOnuOmciDevice.PDevOmciCC)
3215 return portStatus.getUniPortStatus(ctx, uniInfo.UniIndex)
3216}
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003217
mpagenkof1fc3862021-02-16 10:09:52 +00003218func (dh *deviceHandler) isFsmInOmciIdleState(ctx context.Context, pFsm *fsm.FSM, wantedState string) bool {
3219 if pFsm == nil {
3220 return true //FSM not active - so there is no activity on omci
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003221 }
mpagenkof1fc3862021-02-16 10:09:52 +00003222 return pFsm.Current() == wantedState
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003223}
3224
mpagenkof1fc3862021-02-16 10:09:52 +00003225func (dh *deviceHandler) isFsmInOmciIdleStateDefault(ctx context.Context, omciFsm usedOmciConfigFsms, wantedState string) bool {
3226 var pFsm *fsm.FSM
3227 //note/TODO!!: might be that access to all these specific FSM; pointers need a semaphore protection as well, cmp lockUpgradeFsm
3228 switch omciFsm {
3229 case cUploadFsm:
3230 {
3231 pFsm = dh.pOnuOmciDevice.pMibUploadFsm.pFsm
3232 }
3233 case cDownloadFsm:
3234 {
3235 pFsm = dh.pOnuOmciDevice.pMibDownloadFsm.pFsm
3236 }
3237 case cUniLockFsm:
3238 {
3239 pFsm = dh.pLockStateFsm.pAdaptFsm.pFsm
3240 }
3241 case cUniUnLockFsm:
3242 {
3243 pFsm = dh.pUnlockStateFsm.pAdaptFsm.pFsm
3244 }
3245 case cL2PmFsm:
3246 {
3247 if dh.pOnuMetricsMgr != nil && dh.pOnuMetricsMgr.pAdaptFsm != nil {
3248 pFsm = dh.pOnuMetricsMgr.pAdaptFsm.pFsm
3249 } else {
3250 return true //FSM not active - so there is no activity on omci
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003251 }
3252 }
mpagenko80622a52021-02-09 16:53:23 +00003253 case cOnuUpgradeFsm:
3254 {
3255 dh.lockUpgradeFsm.RLock()
3256 defer dh.lockUpgradeFsm.RUnlock()
3257 pFsm = dh.pOnuUpradeFsm.pAdaptFsm.pFsm
3258 }
mpagenkof1fc3862021-02-16 10:09:52 +00003259 default:
3260 {
3261 logger.Errorw(ctx, "invalid stateMachine selected for idle check", log.Fields{
3262 "device-id": dh.deviceID, "selectedFsm number": omciFsm})
3263 return false //logical error in FSM check, do not not indicate 'idle' - we can't be sure
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003264 }
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003265 }
mpagenkof1fc3862021-02-16 10:09:52 +00003266 return dh.isFsmInOmciIdleState(ctx, pFsm, wantedState)
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003267}
3268
mpagenkof1fc3862021-02-16 10:09:52 +00003269func (dh *deviceHandler) isAniConfigFsmInOmciIdleState(ctx context.Context, omciFsm usedOmciConfigFsms, idleState string) bool {
3270 for _, v := range dh.pOnuTP.pAniConfigFsm {
3271 if !dh.isFsmInOmciIdleState(ctx, v.pAdaptFsm.pFsm, idleState) {
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003272 return false
3273 }
3274 }
3275 return true
3276}
3277
mpagenkof1fc3862021-02-16 10:09:52 +00003278func (dh *deviceHandler) isUniVlanConfigFsmInOmciIdleState(ctx context.Context, omciFsm usedOmciConfigFsms, idleState string) bool {
3279 dh.lockVlanConfig.RLock()
3280 defer dh.lockVlanConfig.RUnlock()
3281 for _, v := range dh.UniVlanConfigFsmMap {
3282 if !dh.isFsmInOmciIdleState(ctx, v.pAdaptFsm.pFsm, idleState) {
3283 return false
3284 }
3285 }
3286 return true //FSM not active - so there is no activity on omci
3287}
3288
3289func (dh *deviceHandler) checkUserServiceExists(ctx context.Context) bool {
3290 dh.lockVlanConfig.RLock()
3291 defer dh.lockVlanConfig.RUnlock()
3292 for _, v := range dh.UniVlanConfigFsmMap {
3293 if v.pAdaptFsm.pFsm != nil {
3294 if v.pAdaptFsm.pFsm.Is(cVlanFsmConfiguredState) {
3295 return true //there is at least one VLAN FSM with some active configuration
3296 }
3297 }
3298 }
3299 return false //there is no VLAN FSM with some active configuration
3300}
3301
3302func (dh *deviceHandler) checkAuditStartCondition(ctx context.Context, callingFsm usedOmciConfigFsms) bool {
3303 for fsmName, fsmStruct := range fsmOmciIdleStateFuncMap {
3304 if fsmName != callingFsm && !fsmStruct.omciIdleCheckFunc(dh, ctx, fsmName, fsmStruct.omciIdleState) {
3305 return false
3306 }
3307 }
3308 // a further check is done to identify, if at least some data traffic related configuration exists
3309 // so that a user of this ONU could be 'online' (otherwise it makes no sense to check the MDS [with the intention to keep the user service up])
3310 return dh.checkUserServiceExists(ctx)
3311}
3312
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003313func (dh *deviceHandler) prepareReconcilingWithActiveAdapter(ctx context.Context) {
3314 logger.Debugw(ctx, "prepare to reconcile the ONU with adapter using persistency data", log.Fields{"device-id": dh.device.Id})
3315 if err := dh.resetFsms(ctx, false); err != nil {
3316 logger.Errorw(ctx, "reset of FSMs failed!", log.Fields{"device-id": dh.deviceID, "error": err})
3317 // TODO: fatal error reset ONU, delete deviceHandler!
3318 return
3319 }
3320 if !dh.getCollectorIsRunning() {
3321 // Start PM collector routine
3322 go dh.startCollector(ctx)
3323 }
Himani Chawla1472c682021-03-17 17:11:14 +05303324 if !dh.getAlarmManagerIsRunning(ctx) {
Himani Chawla4c1d4c72021-02-18 12:14:31 +05303325 go dh.startAlarmManager(ctx)
3326 }
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003327 dh.uniEntityMap = make(map[uint32]*onuUniPort)
Holger Hildebrandtbe523842021-03-10 10:47:18 +00003328 dh.startReconciling(ctx, false)
Holger Hildebrandt10d98192021-01-27 15:29:31 +00003329}
3330
3331func (dh *deviceHandler) setCollectorIsRunning(flagValue bool) {
3332 dh.mutexCollectorFlag.Lock()
3333 dh.collectorIsRunning = flagValue
3334 dh.mutexCollectorFlag.Unlock()
3335}
3336
3337func (dh *deviceHandler) getCollectorIsRunning() bool {
3338 dh.mutexCollectorFlag.RLock()
3339 flagValue := dh.collectorIsRunning
3340 dh.mutexCollectorFlag.RUnlock()
3341 return flagValue
3342}
Himani Chawlaac1f5ad2021-02-04 21:21:54 +05303343
Himani Chawla4c1d4c72021-02-18 12:14:31 +05303344func (dh *deviceHandler) setAlarmManagerIsRunning(flagValue bool) {
3345 dh.mutextAlarmManagerFlag.Lock()
3346 dh.alarmManagerIsRunning = flagValue
3347 dh.mutextAlarmManagerFlag.Unlock()
3348}
3349
Himani Chawla1472c682021-03-17 17:11:14 +05303350func (dh *deviceHandler) getAlarmManagerIsRunning(ctx context.Context) bool {
Himani Chawla4c1d4c72021-02-18 12:14:31 +05303351 dh.mutextAlarmManagerFlag.RLock()
3352 flagValue := dh.alarmManagerIsRunning
Himani Chawla1472c682021-03-17 17:11:14 +05303353 logger.Debugw(ctx, "alarm-manager-is-running", log.Fields{"flag": dh.alarmManagerIsRunning})
Himani Chawla4c1d4c72021-02-18 12:14:31 +05303354 dh.mutextAlarmManagerFlag.RUnlock()
3355 return flagValue
3356}
3357
Himani Chawlaac1f5ad2021-02-04 21:21:54 +05303358func (dh *deviceHandler) startAlarmManager(ctx context.Context) {
3359 logger.Debugf(ctx, "startingAlarmManager")
3360
3361 // Start routine to process OMCI GET Responses
3362 go dh.pAlarmMgr.startOMCIAlarmMessageProcessing(ctx)
Himani Chawla4c1d4c72021-02-18 12:14:31 +05303363 dh.setAlarmManagerIsRunning(true)
Himani Chawlaac1f5ad2021-02-04 21:21:54 +05303364 if stop := <-dh.stopAlarmManager; stop {
3365 logger.Debugw(ctx, "stopping-collector-for-onu", log.Fields{"device-id": dh.device.Id})
Himani Chawla4c1d4c72021-02-18 12:14:31 +05303366 dh.setAlarmManagerIsRunning(false)
Himani Chawlad3dac422021-03-13 02:31:31 +05303367 go func() {
Himani Chawla1472c682021-03-17 17:11:14 +05303368 if dh.pAlarmMgr.alarmSyncFsm != nil && dh.pAlarmMgr.alarmSyncFsm.pFsm != nil {
3369 _ = dh.pAlarmMgr.alarmSyncFsm.pFsm.Event(asEvStop)
3370 }
Himani Chawlad3dac422021-03-13 02:31:31 +05303371 }()
Himani Chawlad3dac422021-03-13 02:31:31 +05303372 dh.pAlarmMgr.stopProcessingOmciMessages <- true // Stop the OMCI routines if any(This will stop the fsms also)
Himani Chawla1472c682021-03-17 17:11:14 +05303373 dh.pAlarmMgr.stopAlarmAuditTimer <- struct{}{}
3374 logger.Debugw(ctx, "sent-all-stop-signals-to-alarm-manager", log.Fields{"device-id": dh.device.Id})
Himani Chawlaac1f5ad2021-02-04 21:21:54 +05303375 }
3376}
Holger Hildebrandt38985dc2021-02-18 16:25:20 +00003377
Holger Hildebrandtbe523842021-03-10 10:47:18 +00003378func (dh *deviceHandler) startReconciling(ctx context.Context, skipOnuConfig bool) {
Holger Hildebrandtbdc5f002021-04-19 14:46:21 +00003379 logger.Debugw(ctx, "start reconciling", log.Fields{"skipOnuConfig": skipOnuConfig, "device-id": dh.deviceID})
Holger Hildebrandtbe523842021-03-10 10:47:18 +00003380
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00003381 if !dh.isReconciling() {
3382 go func() {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00003383 logger.Debugw(ctx, "wait for channel signal or timeout",
3384 log.Fields{"timeout": dh.pOpenOnuAc.maxTimeoutReconciling, "device-id": dh.deviceID})
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00003385 select {
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00003386 case success := <-dh.chReconcilingFinished:
3387 if success {
Maninderb5187552021-03-23 22:23:42 +05303388 if onuDevEntry := dh.getOnuDeviceEntry(ctx, true); onuDevEntry == nil {
3389 logger.Errorw(ctx, "No valid OnuDevice - aborting Core DeviceStateUpdate",
3390 log.Fields{"device-id": dh.deviceID})
3391 } else {
3392 connectStatus := voltha.ConnectStatus_UNREACHABLE
3393 operState := voltha.OperStatus_UNKNOWN
3394 if onuDevEntry.sOnuPersistentData.PersOperState == "up" {
3395 connectStatus = voltha.ConnectStatus_REACHABLE
3396 if !onuDevEntry.sOnuPersistentData.PersUniDisableDone {
3397 if onuDevEntry.sOnuPersistentData.PersUniUnlockDone {
3398 operState = voltha.OperStatus_ACTIVE
3399 } else {
3400 operState = voltha.OperStatus_ACTIVATING
3401 }
3402 }
3403 } else if onuDevEntry.sOnuPersistentData.PersOperState == "down" ||
3404 onuDevEntry.sOnuPersistentData.PersOperState == "unknown" ||
3405 onuDevEntry.sOnuPersistentData.PersOperState == "" {
3406 operState = voltha.OperStatus_DISCOVERED
3407 }
3408
3409 logger.Debugw(ctx, "Core DeviceStateUpdate", log.Fields{"connectStatus": connectStatus, "operState": operState})
3410 if err := dh.coreProxy.DeviceStateUpdate(ctx, dh.deviceID, connectStatus, operState); err != nil {
3411 logger.Errorw(ctx, "unable to update device state to core",
3412 log.Fields{"OperState": onuDevEntry.sOnuPersistentData.PersOperState, "Err": err})
3413 }
3414 }
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00003415 logger.Debugw(ctx, "reconciling has been finished in time",
3416 log.Fields{"device-id": dh.deviceID})
3417 } else {
Maninderb5187552021-03-23 22:23:42 +05303418 logger.Errorw(ctx, "wait for reconciling aborted",
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00003419 log.Fields{"device-id": dh.deviceID})
3420 }
Holger Hildebrandt38985dc2021-02-18 16:25:20 +00003421 case <-time.After(dh.pOpenOnuAc.maxTimeoutReconciling):
Maninderb5187552021-03-23 22:23:42 +05303422 //TODO: handle notification to core if reconciling timed out
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00003423 logger.Errorw(ctx, "timeout waiting for reconciling to be finished!",
3424 log.Fields{"device-id": dh.deviceID})
3425 }
3426 dh.mutexReconcilingFlag.Lock()
Holger Hildebrandtbe523842021-03-10 10:47:18 +00003427 dh.reconciling = cNoReconciling
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00003428 dh.mutexReconcilingFlag.Unlock()
3429 }()
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00003430 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +00003431 dh.mutexReconcilingFlag.Lock()
3432 if skipOnuConfig {
3433 dh.reconciling = cSkipOnuConfigReconciling
3434 } else {
3435 dh.reconciling = cOnuConfigReconciling
3436 }
3437 dh.mutexReconcilingFlag.Unlock()
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00003438}
3439
3440func (dh *deviceHandler) stopReconciling(ctx context.Context) {
3441 logger.Debugw(ctx, "stop reconciling", log.Fields{"device-id": dh.deviceID})
3442 if dh.isReconciling() {
3443 dh.chReconcilingFinished <- true
3444 } else {
3445 logger.Infow(ctx, "reconciling is not running", log.Fields{"device-id": dh.deviceID})
3446 }
3447}
3448
3449func (dh *deviceHandler) isReconciling() bool {
3450 dh.mutexReconcilingFlag.RLock()
Holger Hildebrandtbe523842021-03-10 10:47:18 +00003451 defer dh.mutexReconcilingFlag.RUnlock()
3452 return dh.reconciling != cNoReconciling
3453}
3454
3455func (dh *deviceHandler) isSkipOnuConfigReconciling() bool {
3456 dh.mutexReconcilingFlag.RLock()
3457 defer dh.mutexReconcilingFlag.RUnlock()
3458 return dh.reconciling == cSkipOnuConfigReconciling
3459}
3460
3461func (dh *deviceHandler) setDeviceReason(value uint8) {
3462 dh.mutexDeviceReason.Lock()
3463 dh.deviceReason = value
3464 dh.mutexDeviceReason.Unlock()
3465}
3466
3467func (dh *deviceHandler) getDeviceReason() uint8 {
3468 dh.mutexDeviceReason.RLock()
3469 value := dh.deviceReason
3470 dh.mutexDeviceReason.RUnlock()
Holger Hildebrandtf37b3d72021-02-17 10:25:22 +00003471 return value
3472}
Holger Hildebrandtbe523842021-03-10 10:47:18 +00003473
3474func (dh *deviceHandler) getDeviceReasonString() string {
3475 return deviceReasonMap[dh.getDeviceReason()]
3476}
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00003477
3478func (dh *deviceHandler) setReconcilingFlows(value bool) {
3479 dh.mutexReconcilingFlowsFlag.Lock()
3480 dh.reconcilingFlows = value
3481 dh.mutexReconcilingFlowsFlag.Unlock()
3482}
3483
3484func (dh *deviceHandler) isReconcilingFlows() bool {
3485 dh.mutexReconcilingFlowsFlag.RLock()
3486 value := dh.reconcilingFlows
3487 dh.mutexReconcilingFlowsFlag.RUnlock()
3488 return value
3489}
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00003490
3491func (dh *deviceHandler) setReadyForOmciConfig(flagValue bool) {
3492 dh.mutexReadyForOmciConfig.Lock()
3493 dh.readyForOmciConfig = flagValue
3494 dh.mutexReadyForOmciConfig.Unlock()
3495}
3496
3497func (dh *deviceHandler) isReadyForOmciConfig() bool {
3498 dh.mutexReadyForOmciConfig.RLock()
3499 flagValue := dh.readyForOmciConfig
3500 dh.mutexReadyForOmciConfig.RUnlock()
3501 return flagValue
3502}