blob: 668e7b179d7277b4e2648c618a9dc7370239eab7 [file] [log] [blame]
mpagenko80622a52021-02-09 16:53:23 +00001/*
2 * Copyright 2020-present Open Networking Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +000017//Package swupg provides the utilities for onu sw upgrade
18package swupg
mpagenko80622a52021-02-09 16:53:23 +000019
20import (
21 "context"
mpagenkoc26d4c02021-05-06 14:27:57 +000022 "encoding/binary"
mpagenko80622a52021-02-09 16:53:23 +000023 "fmt"
24 "strconv"
mpagenkoc26d4c02021-05-06 14:27:57 +000025 "sync"
mpagenko80622a52021-02-09 16:53:23 +000026 "time"
27
28 "github.com/boguslaw-wojcik/crc32a"
29 "github.com/looplab/fsm"
30 "github.com/opencord/omci-lib-go"
31 me "github.com/opencord/omci-lib-go/generated"
khenaidoo7d3c5582021-08-11 18:09:44 -040032 "github.com/opencord/voltha-lib-go/v7/pkg/log"
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +000033 cmn "github.com/opencord/voltha-openonu-adapter-go/internal/pkg/common"
34 "github.com/opencord/voltha-openonu-adapter-go/internal/pkg/devdb"
khenaidoo7d3c5582021-08-11 18:09:44 -040035 "github.com/opencord/voltha-protos/v5/go/voltha"
mpagenko80622a52021-02-09 16:53:23 +000036)
37
38const cMaxUint32 = ^uint32(0)
39
40const (
41 // internal predefined values - some off them should later be configurable (perhaps with theses as defaults)
42 cOmciDownloadSectionSize = 31 //in bytes
43 cOmciDownloadWindowSizeLimit = 31 //in sections for window offset (windowSize(32)-1)
44 //cOmciDownloadWindowRetryMax = 2 // max attempts for a specific window
mpagenkoc26d4c02021-05-06 14:27:57 +000045 cOmciSectionInterleaveMilliseconds = 0 //DownloadSection interleave time in milliseconds (0 for no delay)
46 cOmciEndSwDlDelaySeconds = 1 //End Software Download delay after last section (may be also configurable?)
47 cWaitCountEndSwDl = 6 //maximum number of EndSwDl requests
48 cWaitDelayEndSwDlSeconds = 10 //duration, how long is waited before next request on EndSwDl
mpagenko80622a52021-02-09 16:53:23 +000049 //cOmciDownloadCompleteTimeout = 5400 //in s for the complete timeout (may be better scale to image size/ noOfWindows)
50)
51
mpagenko45586762021-10-01 08:30:22 +000052// tEndSwDlResponseResult - Response result from EndSwDownload as used in channel indication
53type tUpgradePhase uint8
54
55const (
56 // undefined phase
57 cUpgradeUndefined tUpgradePhase = iota
58 // downloading image
59 cUpgradeDownloading
60 // image downloaded
61 cUpgradeDownloaded
62 // activating image
63 cUpgradeActivating
64 // image activated
65 cUpgradeActivated
66 // committing image
67 cUpgradeCommitting
68 // image committed
69 cUpgradeCommitted
70)
71
72// tEndSwDlResponseResult - Response result from EndSwDownload as used in channel indication
73type tEndSwDlResponseResult uint8
74
75const (
76 // response success
77 cEndSwDlResponseSuccess tEndSwDlResponseResult = iota
78 // response busy (repeat)
79 cEndSwDlResponseBusy
80 // response error or abort waiting for response
81 cEndSwDlResponseAbort
82)
83
84// upgrade FSM related events
mpagenko80622a52021-02-09 16:53:23 +000085const (
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +000086 UpgradeEvStart = "UpgradeEvStart"
87 UpgradeEvDisable = "UpgradeEvDisable"
88 UpgradeEvAdapterDownload = "UpgradeEvAdapterDownload"
89 UpgradeEvPrepareSwDownload = "UpgradeEvPrepareSwDownload"
90 UpgradeEvRxStartSwDownload = "UpgradeEvRxStartSwDownload"
91 UpgradeEvWaitWindowAck = "UpgradeEvWaitWindowAck"
92 UpgradeEvContinueNextWindow = "UpgradeEvContinueNextWindow"
93 UpgradeEvEndSwDownload = "UpgradeEvEndSwDownload"
94 UpgradeEvWaitEndDownload = "UpgradeEvWaitEndDownload"
95 UpgradeEvContinueFinalize = "UpgradeEvContinueFinalize"
96 UpgradeEvCheckImageName = "UpgradeEvCheckImageName"
97 UpgradeEvWaitForActivate = "UpgradeEvWaitForActivate"
98 UpgradeEvRequestActivate = "UpgradeEvRequestActivate"
99 UpgradeEvActivationDone = "UpgradeEvActivationDone"
100 UpgradeEvWaitForCommit = "UpgradeEvWaitForCommit"
101 UpgradeEvCommitSw = "UpgradeEvCommitSw"
102 UpgradeEvCheckCommitted = "UpgradeEvCheckCommitted"
mpagenko80622a52021-02-09 16:53:23 +0000103
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000104 //UpgradeEvTimeoutSimple = "UpgradeEvTimeoutSimple"
105 //UpgradeEvTimeoutMids = "UpgradeEvTimeoutMids"
106 UpgradeEvReset = "UpgradeEvReset"
107 UpgradeEvAbort = "UpgradeEvAbort"
108 UpgradeEvRestart = "UpgradeEvRestart"
109 UpgradeEvAbortSwDownload = "UpgradeEvAbortSwDownload"
mpagenko80622a52021-02-09 16:53:23 +0000110)
111
mpagenko45586762021-10-01 08:30:22 +0000112// upgrade FSM related states
mpagenko80622a52021-02-09 16:53:23 +0000113const (
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000114 UpgradeStDisabled = "UpgradeStDisabled"
115 UpgradeStStarting = "UpgradeStStarting"
116 UpgradeStWaitingAdapterDL = "UpgradeStWaitingAdapterDL"
117 UpgradeStPreparingDL = "UpgradeStPreparingDL"
118 UpgradeStDLSection = "UpgradeStDLSection"
119 UpgradeStVerifyWindow = "UpgradeStVerifyWindow"
120 UpgradeStFinalizeDL = "UpgradeStFinalizeDL"
121 UpgradeStWaitEndDL = "UpgradeStWaitEndDL"
122 UpgradeStCheckImageName = "UpgradeStCheckImageName"
123 UpgradeStWaitForActivate = "UpgradeStWaitForActivate"
124 UpgradeStRequestingActivate = "UpgradeStRequestingActivate"
125 UpgradeStActivated = "UpgradeStActivated"
126 UpgradeStWaitForCommit = "UpgradeStWaitForCommit"
127 UpgradeStCommitSw = "UpgradeStCommitSw"
128 UpgradeStCheckCommitted = "UpgradeStCheckCommitted"
129 UpgradeStResetting = "UpgradeStResetting"
130 UpgradeStRestarting = "UpgradeStRestarting"
131 UpgradeStAbortingDL = "UpgradeStAbortingDL"
mpagenko80622a52021-02-09 16:53:23 +0000132)
133
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000134//COnuUpgradeFsmIdleState - required definition for IdleState detection for activities on OMCI
135const COnuUpgradeFsmIdleState = UpgradeStWaitForCommit
mpagenko80622a52021-02-09 16:53:23 +0000136
137//OnuUpgradeFsm defines the structure for the state machine to config the PON ANI ports of ONU UNI ports via OMCI
138type OnuUpgradeFsm struct {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000139 pDeviceHandler cmn.IdeviceHandler
140 pDownloadManager *AdapterDownloadManager
141 pFileManager *FileDownloadManager //used from R2.8 with new API version
mpagenko80622a52021-02-09 16:53:23 +0000142 deviceID string
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000143 pDevEntry cmn.IonuDeviceEntry
144 pOmciCC *cmn.OmciCC
145 pOnuDB *devdb.OnuDeviceDB
146 requestEvent cmn.OnuDeviceEvent
mpagenko80622a52021-02-09 16:53:23 +0000147 //omciMIdsResponseReceived chan bool //seperate channel needed for checking multiInstance OMCI message responses
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000148 PAdaptFsm *cmn.AdapterFsm
mpagenkoc26d4c02021-05-06 14:27:57 +0000149 pImageDsc *voltha.ImageDownload
150 imageBuffer []byte
151 origImageLength uint32 //as also limited by OMCI
152 imageCRC uint32 //as per OMCI - ITU I.363.5 crc
153 imageLength uint32 //including last bytes padding
154 omciDownloadWindowSizeLimit uint8 //windowSize-1 in sections
155 omciDownloadWindowSizeLast uint8 //number of sections in last window
156 noOfSections uint32 //uint32 range for sections should be sufficient for very long images
157 nextDownloadSectionsAbsolute uint32 //number of next section to download in overall image
158 nextDownloadSectionsWindow uint8 //number of next section to download within current window
159 noOfWindows uint32 //uint32 range for windows should be sufficient for very long images
160 nextDownloadWindow uint32 //number of next window to download
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000161 InactiveImageMeID uint16 //ME-ID of the inactive image
mpagenkoc26d4c02021-05-06 14:27:57 +0000162 downloadToOnuTimeout4MB time.Duration //timeout for downloading the image to the ONU for a 4MB image slice
163 omciSectionInterleaveDelay time.Duration //DownloadSectionInterleave delay in milliseconds
164 delayEndSwDl bool //flag to provide a delay between last section and EndSwDl
mpagenko45586762021-10-01 08:30:22 +0000165 repeatAbort bool //flag to indicate if OMCI EndSwDownload (abort) is to be repeated
mpagenkoc26d4c02021-05-06 14:27:57 +0000166 pLastTxMeInstance *me.ManagedEntity
167 waitCountEndSwDl uint8 //number, how often is waited for EndSwDl at maximum
168 waitDelayEndSwDl time.Duration //duration, how long is waited before next request on EndSwDl
169 chReceiveExpectedResponse chan bool
mpagenkoaa3afe92021-05-21 16:20:58 +0000170 useAPIVersion43 bool //flag for indication on which API version is used (and accordingly which specific methods)
171 mutexUpgradeParams sync.RWMutex //mutex to protect members for parallel function requests and omci response processing
172 imageVersion string //name of the image as used within OMCI (and on extrenal API interface)
173 imageIdentifier string //name of the image as used in the adapter
mpagenkoc26d4c02021-05-06 14:27:57 +0000174 mutexIsAwaitingAdapterDlResponse sync.RWMutex
175 chAdapterDlReady chan bool
176 isWaitingForAdapterDlResponse bool
mpagenkoc26d4c02021-05-06 14:27:57 +0000177 chOnuDlReady chan bool
mpagenkoc26d4c02021-05-06 14:27:57 +0000178 activateImage bool
179 commitImage bool
mpagenko38662d02021-08-11 09:45:19 +0000180 mutexAbortRequest sync.RWMutex
181 abortRequested voltha.ImageState_ImageFailureReason
182 conditionalCancelRequested bool
mpagenko45586762021-10-01 08:30:22 +0000183 upgradePhase tUpgradePhase
mpagenkoaa3afe92021-05-21 16:20:58 +0000184 volthaDownloadState voltha.ImageState_ImageDownloadState
185 volthaDownloadReason voltha.ImageState_ImageFailureReason
186 volthaImageState voltha.ImageState_ImageActivationState
mpagenko45586762021-10-01 08:30:22 +0000187 downloadReasonCached voltha.ImageState_ImageFailureReason
Holger Hildebrandt288d9472021-09-06 10:47:53 +0000188 isEndSwDlOpen bool
mpagenko45586762021-10-01 08:30:22 +0000189 chReceiveAbortEndSwDlResponse chan tEndSwDlResponseResult
mpagenko80622a52021-02-09 16:53:23 +0000190}
191
192//NewOnuUpgradeFsm is the 'constructor' for the state machine to config the PON ANI ports
193// of ONU UNI ports via OMCI
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000194func NewOnuUpgradeFsm(ctx context.Context, apDeviceHandler cmn.IdeviceHandler,
195 apDevEntry cmn.IonuDeviceEntry, apOnuDB *devdb.OnuDeviceDB,
196 aRequestEvent cmn.OnuDeviceEvent, aName string, aCommChannel chan cmn.Message) *OnuUpgradeFsm {
mpagenko80622a52021-02-09 16:53:23 +0000197 instFsm := &OnuUpgradeFsm{
mpagenko59498c12021-03-18 14:15:15 +0000198 pDeviceHandler: apDeviceHandler,
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000199 deviceID: apDeviceHandler.GetDeviceID(),
mpagenko38662d02021-08-11 09:45:19 +0000200 pDevEntry: apDevEntry,
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000201 pOmciCC: apDevEntry.GetDevOmciCC(),
mpagenko59498c12021-03-18 14:15:15 +0000202 pOnuDB: apOnuDB,
203 requestEvent: aRequestEvent,
204 omciDownloadWindowSizeLimit: cOmciDownloadWindowSizeLimit,
205 omciSectionInterleaveDelay: cOmciSectionInterleaveMilliseconds,
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000206 downloadToOnuTimeout4MB: apDeviceHandler.GetDlToOnuTimeout4M(),
mpagenko59498c12021-03-18 14:15:15 +0000207 waitCountEndSwDl: cWaitCountEndSwDl,
208 waitDelayEndSwDl: cWaitDelayEndSwDlSeconds,
mpagenko45586762021-10-01 08:30:22 +0000209 upgradePhase: cUpgradeUndefined,
210 volthaDownloadState: voltha.ImageState_DOWNLOAD_UNKNOWN,
mpagenkoaa3afe92021-05-21 16:20:58 +0000211 volthaDownloadReason: voltha.ImageState_NO_ERROR,
212 volthaImageState: voltha.ImageState_IMAGE_UNKNOWN,
mpagenko38662d02021-08-11 09:45:19 +0000213 abortRequested: voltha.ImageState_NO_ERROR,
mpagenko80622a52021-02-09 16:53:23 +0000214 }
mpagenko59498c12021-03-18 14:15:15 +0000215 instFsm.chReceiveExpectedResponse = make(chan bool)
mpagenkoc26d4c02021-05-06 14:27:57 +0000216 instFsm.chAdapterDlReady = make(chan bool)
217 instFsm.chOnuDlReady = make(chan bool)
mpagenko45586762021-10-01 08:30:22 +0000218 instFsm.chReceiveAbortEndSwDlResponse = make(chan tEndSwDlResponseResult)
mpagenko80622a52021-02-09 16:53:23 +0000219
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000220 instFsm.PAdaptFsm = cmn.NewAdapterFsm(aName, instFsm.deviceID, aCommChannel)
221 if instFsm.PAdaptFsm == nil {
mpagenko80622a52021-02-09 16:53:23 +0000222 logger.Errorw(ctx, "OnuUpgradeFsm's AdapterFsm could not be instantiated!!", log.Fields{
223 "device-id": instFsm.deviceID})
224 return nil
225 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000226 instFsm.PAdaptFsm.PFsm = fsm.NewFSM(
227 UpgradeStDisabled,
mpagenko80622a52021-02-09 16:53:23 +0000228 fsm.Events{
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000229 {Name: UpgradeEvStart, Src: []string{UpgradeStDisabled}, Dst: UpgradeStStarting},
230 {Name: UpgradeEvAdapterDownload, Src: []string{UpgradeStStarting}, Dst: UpgradeStWaitingAdapterDL},
231 {Name: UpgradeEvPrepareSwDownload, Src: []string{UpgradeStStarting, UpgradeStWaitingAdapterDL}, Dst: UpgradeStPreparingDL},
232 {Name: UpgradeEvRxStartSwDownload, Src: []string{UpgradeStPreparingDL}, Dst: UpgradeStDLSection},
233 {Name: UpgradeEvWaitWindowAck, Src: []string{UpgradeStDLSection}, Dst: UpgradeStVerifyWindow},
234 {Name: UpgradeEvContinueNextWindow, Src: []string{UpgradeStVerifyWindow}, Dst: UpgradeStDLSection},
235 {Name: UpgradeEvEndSwDownload, Src: []string{UpgradeStVerifyWindow}, Dst: UpgradeStFinalizeDL},
236 {Name: UpgradeEvWaitEndDownload, Src: []string{UpgradeStFinalizeDL}, Dst: UpgradeStWaitEndDL},
237 {Name: UpgradeEvContinueFinalize, Src: []string{UpgradeStWaitEndDL}, Dst: UpgradeStFinalizeDL},
238 //UpgradeStCheckImageName only used with useAPIVersion43
239 {Name: UpgradeEvCheckImageName, Src: []string{UpgradeStWaitEndDL}, Dst: UpgradeStCheckImageName},
240 //UpgradeEvWaitForActivate state transitions depend on useAPIVersion43
241 {Name: UpgradeEvWaitForActivate, Src: []string{UpgradeStWaitEndDL, UpgradeStCheckImageName}, Dst: UpgradeStWaitForActivate},
242 //UpgradeEvRequestActivate state transitions depend on useAPIVersion43
243 {Name: UpgradeEvRequestActivate, Src: []string{UpgradeStStarting, UpgradeStWaitEndDL, UpgradeStCheckImageName,
244 UpgradeStWaitForActivate}, Dst: UpgradeStRequestingActivate}, //allows also for direct activation (without download) [TODO!!!]
245 {Name: UpgradeEvActivationDone, Src: []string{UpgradeStRequestingActivate}, Dst: UpgradeStActivated},
246 {Name: UpgradeEvWaitForCommit, Src: []string{UpgradeStRequestingActivate}, Dst: UpgradeStWaitForCommit},
247 {Name: UpgradeEvCommitSw, Src: []string{UpgradeStStarting, UpgradeStRequestingActivate, UpgradeStWaitForCommit,
248 UpgradeStActivated}, Dst: UpgradeStCommitSw}, //allows also for direct commitment (without download) [TODO!!!]
249 {Name: UpgradeEvCheckCommitted, Src: []string{UpgradeStCommitSw}, Dst: UpgradeStCheckCommitted},
mpagenko80622a52021-02-09 16:53:23 +0000250
251 /*
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000252 {Name: UpgradeEvTimeoutSimple, Src: []string{
253 UpgradeStCreatingDot1PMapper, UpgradeStCreatingMBPCD, UpgradeStSettingTconts, UpgradeStSettingDot1PMapper}, Dst: UpgradeStStarting},
254 {Name: UpgradeEvTimeoutMids, Src: []string{
255 UpgradeStCreatingGemNCTPs, UpgradeStCreatingGemIWs, UpgradeStSettingPQs}, Dst: UpgradeStStarting},
mpagenko80622a52021-02-09 16:53:23 +0000256 */
257 // exceptional treatments
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000258 //on UpgradeEvReset: UpgradeStRequestingActivate, UpgradeStWaitForCommit and UpgradeStActivated are not reset
mpagenko1f8e8822021-06-25 14:10:21 +0000259 // (to let the FSM survive the expected OnuDown indication)
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000260 {Name: UpgradeEvReset, Src: []string{UpgradeStStarting, UpgradeStWaitingAdapterDL, UpgradeStPreparingDL, UpgradeStDLSection,
261 UpgradeStVerifyWindow, UpgradeStDLSection, UpgradeStFinalizeDL, UpgradeStWaitEndDL, UpgradeStCheckImageName,
262 UpgradeStWaitForActivate,
mpagenko45586762021-10-01 08:30:22 +0000263 UpgradeStCommitSw, UpgradeStCheckCommitted, UpgradeStAbortingDL},
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000264 Dst: UpgradeStResetting},
265 {Name: UpgradeEvAbort, Src: []string{UpgradeStStarting, UpgradeStWaitingAdapterDL, UpgradeStPreparingDL, UpgradeStDLSection,
266 UpgradeStVerifyWindow, UpgradeStDLSection, UpgradeStFinalizeDL, UpgradeStWaitEndDL, UpgradeStCheckImageName,
267 UpgradeStWaitForActivate,
268 UpgradeStRequestingActivate, UpgradeStActivated, UpgradeStWaitForCommit,
269 UpgradeStCommitSw, UpgradeStCheckCommitted},
270 Dst: UpgradeStResetting},
271 {Name: UpgradeEvAbortSwDownload, Src: []string{UpgradeStResetting}, Dst: UpgradeStAbortingDL},
272 {Name: UpgradeEvRestart, Src: []string{UpgradeStResetting, UpgradeStAbortingDL}, Dst: UpgradeStRestarting},
273 {Name: UpgradeEvDisable, Src: []string{UpgradeStRestarting}, Dst: UpgradeStDisabled},
mpagenko80622a52021-02-09 16:53:23 +0000274 },
275 fsm.Callbacks{
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000276 "enter_state": func(e *fsm.Event) { instFsm.PAdaptFsm.LogFsmStateChange(ctx, e) },
277 "enter_" + UpgradeStStarting: func(e *fsm.Event) { instFsm.enterStarting(ctx, e) },
278 "enter_" + UpgradeStWaitingAdapterDL: func(e *fsm.Event) { instFsm.enterWaitingAdapterDL(ctx, e) },
279 "enter_" + UpgradeStPreparingDL: func(e *fsm.Event) { instFsm.enterPreparingDL(ctx, e) },
280 "enter_" + UpgradeStDLSection: func(e *fsm.Event) { instFsm.enterDownloadSection(ctx, e) },
281 "enter_" + UpgradeStVerifyWindow: func(e *fsm.Event) { instFsm.enterVerifyWindow(ctx, e) },
282 "enter_" + UpgradeStFinalizeDL: func(e *fsm.Event) { instFsm.enterFinalizeDL(ctx, e) },
283 "enter_" + UpgradeStWaitEndDL: func(e *fsm.Event) { instFsm.enterWaitEndDL(ctx, e) },
284 "enter_" + UpgradeStCheckImageName: func(e *fsm.Event) { instFsm.enterCheckImageName(ctx, e) },
285 "enter_" + UpgradeStRequestingActivate: func(e *fsm.Event) { instFsm.enterActivateSw(ctx, e) },
286 "enter_" + UpgradeStCommitSw: func(e *fsm.Event) { instFsm.enterCommitSw(ctx, e) },
287 "enter_" + UpgradeStCheckCommitted: func(e *fsm.Event) { instFsm.enterCheckCommitted(ctx, e) },
288 "enter_" + UpgradeStResetting: func(e *fsm.Event) { instFsm.enterResetting(ctx, e) },
289 "enter_" + UpgradeStAbortingDL: func(e *fsm.Event) { instFsm.enterAbortingDL(ctx, e) },
290 "enter_" + UpgradeStRestarting: func(e *fsm.Event) { instFsm.enterRestarting(ctx, e) },
291 "enter_" + UpgradeStDisabled: func(e *fsm.Event) { instFsm.enterDisabled(ctx, e) },
mpagenko80622a52021-02-09 16:53:23 +0000292 },
293 )
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000294 if instFsm.PAdaptFsm.PFsm == nil {
mpagenko80622a52021-02-09 16:53:23 +0000295 logger.Errorw(ctx, "OnuUpgradeFsm's Base FSM could not be instantiated!!", log.Fields{
296 "device-id": instFsm.deviceID})
297 return nil
298 }
299
300 logger.Debugw(ctx, "OnuUpgradeFsm created", log.Fields{"device-id": instFsm.deviceID})
301 return instFsm
302}
303
304//SetDownloadParams configures the needed parameters for a specific download to the ONU
mpagenkoc26d4c02021-05-06 14:27:57 +0000305// called from 'old' API Activate_image_update()
mpagenko15ff4a52021-03-02 10:09:20 +0000306func (oFsm *OnuUpgradeFsm) SetDownloadParams(ctx context.Context, aInactiveImageID uint16,
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000307 apImageDsc *voltha.ImageDownload, apDownloadManager *AdapterDownloadManager) error {
308 pBaseFsm := oFsm.PAdaptFsm.PFsm
309 if pBaseFsm != nil && pBaseFsm.Is(UpgradeStStarting) {
mpagenkoaa3afe92021-05-21 16:20:58 +0000310 oFsm.mutexUpgradeParams.Lock()
mpagenko80622a52021-02-09 16:53:23 +0000311 logger.Debugw(ctx, "OnuUpgradeFsm Parameter setting", log.Fields{
312 "device-id": oFsm.deviceID, "image-description": apImageDsc})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000313 oFsm.InactiveImageMeID = aInactiveImageID //upgrade state machines run on configured inactive ImageId
mpagenko80622a52021-02-09 16:53:23 +0000314 oFsm.pImageDsc = apImageDsc
315 oFsm.pDownloadManager = apDownloadManager
Holger Hildebrandtac1e0592021-06-03 15:16:49 +0000316 oFsm.activateImage = true
317 oFsm.commitImage = true
mpagenkoaa3afe92021-05-21 16:20:58 +0000318 oFsm.mutexUpgradeParams.Unlock()
mpagenko80622a52021-02-09 16:53:23 +0000319
320 go func(aPBaseFsm *fsm.FSM) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000321 // let the upgrade FSM proceed to PreparingDL
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000322 _ = aPBaseFsm.Event(UpgradeEvPrepareSwDownload)
mpagenko80622a52021-02-09 16:53:23 +0000323 }(pBaseFsm)
324 return nil
325 }
326 logger.Errorw(ctx, "OnuUpgradeFsm abort: invalid FSM base pointer or state", log.Fields{
327 "device-id": oFsm.deviceID})
328 return fmt.Errorf(fmt.Sprintf("OnuUpgradeFsm abort: invalid FSM base pointer or state for device-id: %s", oFsm.deviceID))
329}
330
mpagenkoc26d4c02021-05-06 14:27:57 +0000331//SetDownloadParamsAfterDownload configures the needed parameters for a specific download to the ONU according to
332// updated API interface with R2.8: start download to ONU if the image is downloaded to the adapter
333// called from 'new' API Download_onu_image
334func (oFsm *OnuUpgradeFsm) SetDownloadParamsAfterDownload(ctx context.Context, aInactiveImageID uint16,
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000335 apImageRequest *voltha.DeviceImageDownloadRequest, apDownloadManager *FileDownloadManager,
Holger Hildebrandtac010732021-06-02 13:35:39 +0000336 aImageIdentifier string) error {
mpagenkoc26d4c02021-05-06 14:27:57 +0000337 oFsm.mutexUpgradeParams.Lock()
338 var pBaseFsm *fsm.FSM = nil
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000339 if oFsm.PAdaptFsm != nil {
340 pBaseFsm = oFsm.PAdaptFsm.PFsm
mpagenkoc26d4c02021-05-06 14:27:57 +0000341 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000342 if pBaseFsm != nil && pBaseFsm.Is(UpgradeStStarting) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000343 logger.Debugw(ctx, "OnuUpgradeFsm Parameter setting", log.Fields{
344 "device-id": oFsm.deviceID, "image-description": apImageRequest})
345 oFsm.useAPIVersion43 = true
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000346 oFsm.InactiveImageMeID = aInactiveImageID //upgrade state machines run on configured inactive ImageId
mpagenkoc26d4c02021-05-06 14:27:57 +0000347 oFsm.pFileManager = apDownloadManager
348 oFsm.imageIdentifier = aImageIdentifier
349 oFsm.imageVersion = apImageRequest.Image.Version
350 oFsm.activateImage = apImageRequest.ActivateOnSuccess
351 oFsm.commitImage = apImageRequest.CommitOnSuccess
mpagenko45586762021-10-01 08:30:22 +0000352 oFsm.volthaDownloadState = voltha.ImageState_DOWNLOAD_STARTED //state change indication for download request
mpagenkoc26d4c02021-05-06 14:27:57 +0000353 oFsm.mutexUpgradeParams.Unlock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000354 _ = pBaseFsm.Event(UpgradeEvAdapterDownload) //no need to call the FSM event in background here
mpagenkoc26d4c02021-05-06 14:27:57 +0000355 return nil
356 }
357 oFsm.mutexUpgradeParams.Unlock()
358 logger.Errorw(ctx, "OnuUpgradeFsm abort: invalid FSM base pointer or state", log.Fields{
359 "device-id": oFsm.deviceID})
360 return fmt.Errorf(fmt.Sprintf("OnuUpgradeFsm abort: invalid FSM base pointer or state for device-id: %s", oFsm.deviceID))
361}
362
363//SetActivationParamsRunning sets the activate and commit flags for a running download to the ONU according to adapters rpc call
364// called from 'new' API Activate_onu_image
365func (oFsm *OnuUpgradeFsm) SetActivationParamsRunning(ctx context.Context,
366 aImageIdentifier string, aCommit bool) error {
mpagenko45586762021-10-01 08:30:22 +0000367 logger.Debugw(ctx, "OnuUpgradeFsm activate/commit parameter setting", log.Fields{
368 "device-id": oFsm.deviceID, "image-id": aImageIdentifier, "commit": aCommit})
mpagenkoc26d4c02021-05-06 14:27:57 +0000369 oFsm.mutexUpgradeParams.Lock()
370 //set activate/commit independent from state, if FSM is already beyond concerned states, then it does not matter anyway
371 // (as long as the Imageidentifier is correct)
mpagenkoc26d4c02021-05-06 14:27:57 +0000372 if aImageIdentifier != oFsm.imageIdentifier {
373 logger.Errorw(ctx, "OnuUpgradeFsm abort: mismatching upgrade image", log.Fields{
374 "device-id": oFsm.deviceID, "request-image": aImageIdentifier, "fsm-image": oFsm.imageIdentifier})
375 oFsm.mutexUpgradeParams.Unlock()
376 return fmt.Errorf(fmt.Sprintf("OnuUpgradeFsm params ignored: requested image-name not used in current upgrade for device-id: %s",
377 oFsm.deviceID))
378 }
379 oFsm.activateImage = true
380 oFsm.commitImage = aCommit
mpagenko45586762021-10-01 08:30:22 +0000381 oFsm.mutexUpgradeParams.Unlock()
mpagenkoc26d4c02021-05-06 14:27:57 +0000382 var pBaseFsm *fsm.FSM = nil
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000383 if oFsm.PAdaptFsm != nil {
384 pBaseFsm = oFsm.PAdaptFsm.PFsm
mpagenkoc26d4c02021-05-06 14:27:57 +0000385 }
386 if pBaseFsm != nil {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000387 if pBaseFsm.Is(UpgradeStWaitForActivate) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000388 logger.Debugw(ctx, "OnuUpgradeFsm finish waiting for activate", log.Fields{"device-id": oFsm.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000389 _ = pBaseFsm.Event(UpgradeEvRequestActivate) //no need to call the FSM event in background here
mpagenko38662d02021-08-11 09:45:19 +0000390 } else {
mpagenko38662d02021-08-11 09:45:19 +0000391 logger.Debugw(ctx, "OnuUpgradeFsm not (yet?) waiting for activate", log.Fields{
392 "device-id": oFsm.deviceID, "current FsmState": pBaseFsm.Current()})
mpagenkoc26d4c02021-05-06 14:27:57 +0000393 }
394 return nil
395 }
396 logger.Errorw(ctx, "OnuUpgradeFsm abort: invalid FSM base pointer", log.Fields{
397 "device-id": oFsm.deviceID})
398 return fmt.Errorf(fmt.Sprintf("OnuUpgradeFsm abort: invalid FSM base pointer for device-id: %s", oFsm.deviceID))
399}
400
401//SetActivationParamsStart starts upgrade processing with immediate activation
402// called from 'new' API Activate_onu_image
403func (oFsm *OnuUpgradeFsm) SetActivationParamsStart(ctx context.Context, aImageVersion string, aInactiveImageID uint16, aCommit bool) error {
404 oFsm.mutexUpgradeParams.Lock()
405 var pBaseFsm *fsm.FSM = nil
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000406 if oFsm.PAdaptFsm != nil {
407 pBaseFsm = oFsm.PAdaptFsm.PFsm
mpagenkoc26d4c02021-05-06 14:27:57 +0000408 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000409 if pBaseFsm != nil && pBaseFsm.Is(UpgradeStStarting) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000410 logger.Debugw(ctx, "OnuUpgradeFsm Parameter setting to start with activation", log.Fields{
411 "device-id": oFsm.deviceID, "image-version": aImageVersion})
412 oFsm.useAPIVersion43 = true
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000413 oFsm.InactiveImageMeID = aInactiveImageID //upgrade state machines run on configured inactive ImageId
mpagenkoc26d4c02021-05-06 14:27:57 +0000414 oFsm.imageVersion = aImageVersion
415 oFsm.activateImage = true
416 oFsm.commitImage = aCommit
mpagenko38662d02021-08-11 09:45:19 +0000417 // indicate start of the upgrade activity
mpagenko45586762021-10-01 08:30:22 +0000418 oFsm.volthaImageState = voltha.ImageState_IMAGE_ACTIVATING //state change indication for activate request
mpagenkoc26d4c02021-05-06 14:27:57 +0000419 oFsm.mutexUpgradeParams.Unlock()
420 //directly request the FSM to activate the image
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000421 _ = pBaseFsm.Event(UpgradeEvRequestActivate) //no need to call the FSM event in background here
mpagenkoc26d4c02021-05-06 14:27:57 +0000422 return nil
423 }
424 oFsm.mutexUpgradeParams.Unlock()
425 logger.Errorw(ctx, "OnuUpgradeFsm abort: invalid FSM base pointer or state", log.Fields{
426 "device-id": oFsm.deviceID})
427 return fmt.Errorf(fmt.Sprintf("OnuUpgradeFsm abort: invalid FSM base pointer or state for device-id: %s", oFsm.deviceID))
428}
429
430//SetCommitmentParamsRunning sets the commit flag for a running download to the ONU according to adapters rpc call
431// called from 'new' API Commit_onu_image
mpagenko38662d02021-08-11 09:45:19 +0000432func (oFsm *OnuUpgradeFsm) SetCommitmentParamsRunning(ctx context.Context,
433 aImageIdentifier string, aImageVersion string) error {
mpagenkoc26d4c02021-05-06 14:27:57 +0000434 oFsm.mutexUpgradeParams.Lock()
435 //set commit independent from state, if FSM is already beyond commit state (just ready), then it does not matter anyway
436 // (as long as the Imageidentifier is correct)
437 logger.Debugw(ctx, "OnuUpgradeFsm commit parameter setting", log.Fields{
mpagenkoa2b288f2021-10-21 11:25:27 +0000438 "device-id": oFsm.deviceID, "image-id": aImageIdentifier, "image-version": aImageVersion})
mpagenko38662d02021-08-11 09:45:19 +0000439 if (aImageIdentifier != oFsm.imageIdentifier) && (aImageVersion != oFsm.imageVersion) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000440 logger.Errorw(ctx, "OnuUpgradeFsm abort: mismatching upgrade image", log.Fields{
mpagenko38662d02021-08-11 09:45:19 +0000441 "device-id": oFsm.deviceID, "request-identifier": aImageIdentifier, "fsm-identifier": oFsm.imageIdentifier,
442 "request-version": aImageVersion, "fsm-version": oFsm.imageVersion})
mpagenkoc26d4c02021-05-06 14:27:57 +0000443 oFsm.mutexUpgradeParams.Unlock()
444 return fmt.Errorf(fmt.Sprintf("OnuUpgradeFsm params ignored: requested image-name not used in current upgrade for device-id: %s",
445 oFsm.deviceID))
446 }
447 oFsm.commitImage = true
448 oFsm.mutexUpgradeParams.Unlock()
449 var pBaseFsm *fsm.FSM = nil
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000450 if oFsm.PAdaptFsm != nil {
451 pBaseFsm = oFsm.PAdaptFsm.PFsm
mpagenkoc26d4c02021-05-06 14:27:57 +0000452 }
453 if pBaseFsm != nil {
mpagenko183647c2021-06-08 15:25:04 +0000454 //let the FSM decide if it is ready to process the event
455 logger.Debugw(ctx, "OnuUpgradeFsm requesting commit",
456 log.Fields{"device-id": oFsm.deviceID, "current FsmState": pBaseFsm.Current()})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000457 _ = pBaseFsm.Event(UpgradeEvCommitSw) //no need to call the FSM event in background here
mpagenkoc26d4c02021-05-06 14:27:57 +0000458 return nil
459 }
mpagenko38662d02021-08-11 09:45:19 +0000460 //should never occur
mpagenkoc26d4c02021-05-06 14:27:57 +0000461 logger.Errorw(ctx, "OnuUpgradeFsm abort: invalid FSM base pointer", log.Fields{
462 "device-id": oFsm.deviceID})
463 return fmt.Errorf(fmt.Sprintf("OnuUpgradeFsm abort: invalid FSM base pointer for device-id: %s", oFsm.deviceID))
464}
465
466//SetCommitmentParamsStart starts upgrade processing with immediate commitment
467// called from 'new' API Commit_onu_image
468func (oFsm *OnuUpgradeFsm) SetCommitmentParamsStart(ctx context.Context, aImageVersion string, aActiveImageID uint16) error {
469 oFsm.mutexUpgradeParams.Lock()
470 var pBaseFsm *fsm.FSM = nil
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000471 if oFsm.PAdaptFsm != nil {
472 pBaseFsm = oFsm.PAdaptFsm.PFsm
mpagenkoc26d4c02021-05-06 14:27:57 +0000473 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000474 if pBaseFsm != nil && pBaseFsm.Is(UpgradeStStarting) {
mpagenkoc26d4c02021-05-06 14:27:57 +0000475 logger.Debugw(ctx, "OnuUpgradeFsm Parameter setting to start with commitment", log.Fields{
476 "device-id": oFsm.deviceID, "image-version": aImageVersion})
477 oFsm.useAPIVersion43 = true
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000478 oFsm.InactiveImageMeID = aActiveImageID //upgrade state machines inactive ImageId is the new active ImageId
mpagenkoc26d4c02021-05-06 14:27:57 +0000479 oFsm.imageVersion = aImageVersion
480 oFsm.commitImage = true
mpagenko45586762021-10-01 08:30:22 +0000481 oFsm.volthaImageState = voltha.ImageState_IMAGE_COMMITTING //state change indication for activate request
mpagenkoc26d4c02021-05-06 14:27:57 +0000482 oFsm.mutexUpgradeParams.Unlock()
mpagenko38662d02021-08-11 09:45:19 +0000483 //directly request the FSM to commit the image
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000484 _ = pBaseFsm.Event(UpgradeEvCommitSw) //no need to call the FSM event in background here
mpagenkoc26d4c02021-05-06 14:27:57 +0000485 return nil
486 }
487 oFsm.mutexUpgradeParams.Unlock()
488 logger.Errorw(ctx, "OnuUpgradeFsm abort: invalid FSM base pointer or state", log.Fields{
489 "device-id": oFsm.deviceID})
490 return fmt.Errorf(fmt.Sprintf("OnuUpgradeFsm abort: invalid FSM base pointer or state for device-id: %s", oFsm.deviceID))
491}
492
mpagenko1f8e8822021-06-25 14:10:21 +0000493//GetCommitFlag delivers the commit flag that was configured here
494func (oFsm *OnuUpgradeFsm) GetCommitFlag(ctx context.Context) bool {
495 oFsm.mutexUpgradeParams.RLock()
496 defer oFsm.mutexUpgradeParams.RUnlock()
497 return oFsm.commitImage
498}
499
mpagenko38662d02021-08-11 09:45:19 +0000500//GetImageStates delivers the download/image states as per device proto buf definition
mpagenkoaa3afe92021-05-21 16:20:58 +0000501func (oFsm *OnuUpgradeFsm) GetImageStates(ctx context.Context,
mpagenko38662d02021-08-11 09:45:19 +0000502 aImageIdentifier string, aVersion string) *voltha.ImageState {
mpagenkoaa3afe92021-05-21 16:20:58 +0000503 pImageState := &voltha.ImageState{}
mpagenko38662d02021-08-11 09:45:19 +0000504 pImageState.Version = aVersion //version as requested
mpagenkoaa3afe92021-05-21 16:20:58 +0000505 // check if the request refers to some active image/version of the processing
506 oFsm.mutexUpgradeParams.RLock()
507 if (aImageIdentifier == oFsm.imageIdentifier) || (aVersion == oFsm.imageVersion) {
508 pImageState.DownloadState = oFsm.volthaDownloadState
509 pImageState.Reason = oFsm.volthaDownloadReason
510 pImageState.ImageState = oFsm.volthaImageState
511 } else {
512 pImageState.DownloadState = voltha.ImageState_DOWNLOAD_UNKNOWN
513 pImageState.Reason = voltha.ImageState_NO_ERROR
514 pImageState.ImageState = voltha.ImageState_IMAGE_UNKNOWN
515 }
516 oFsm.mutexUpgradeParams.RUnlock()
mpagenko38662d02021-08-11 09:45:19 +0000517 return pImageState
mpagenkoaa3afe92021-05-21 16:20:58 +0000518}
519
mpagenko38662d02021-08-11 09:45:19 +0000520//SetImageStateActive sets the FSM internal volthaImageState to ImageState_IMAGE_ACTIVE
521func (oFsm *OnuUpgradeFsm) SetImageStateActive(ctx context.Context) {
mpagenko183647c2021-06-08 15:25:04 +0000522 oFsm.mutexUpgradeParams.Lock()
523 defer oFsm.mutexUpgradeParams.Unlock()
mpagenko45586762021-10-01 08:30:22 +0000524 oFsm.upgradePhase = cUpgradeActivated
mpagenko38662d02021-08-11 09:45:19 +0000525 oFsm.volthaImageState = voltha.ImageState_IMAGE_ACTIVE
mpagenko38662d02021-08-11 09:45:19 +0000526}
527
mpagenkoc26d4c02021-05-06 14:27:57 +0000528//CancelProcessing ensures that suspended processing at waiting on some response is aborted and reset of FSM
mpagenko38662d02021-08-11 09:45:19 +0000529func (oFsm *OnuUpgradeFsm) CancelProcessing(ctx context.Context, abCompleteAbort bool,
530 aReason voltha.ImageState_ImageFailureReason) {
mpagenkoa2b288f2021-10-21 11:25:27 +0000531 pAdaptFsm := oFsm.PAdaptFsm
532 if pAdaptFsm == nil || pAdaptFsm.PFsm == nil {
533 logger.Warnw(ctx, "OnuUpgradeFsm cancel, but FSM invalid", log.Fields{
534 "device-id": oFsm.deviceID})
535 return
536 }
537 logger.Debugw(ctx, "OnuUpgradeFsm start canceling", log.Fields{
538 "device-id": oFsm.deviceID, "in fsm-state": pAdaptFsm.PFsm.Current()})
mpagenko38662d02021-08-11 09:45:19 +0000539 oFsm.mutexAbortRequest.Lock()
540 oFsm.abortRequested = aReason //possibly abort the sectionDownload loop
541 oFsm.mutexAbortRequest.Unlock()
mpagenkoc26d4c02021-05-06 14:27:57 +0000542 //mutex protection is required for possible concurrent access to FSM members
543 //attention: for an unbuffered channel the sender is blocked until the value is received (processed)!
544 // accordingly the mutex must be released before sending to channel here (mutex acquired in receiver)
545 oFsm.mutexIsAwaitingAdapterDlResponse.RLock()
546 if oFsm.isWaitingForAdapterDlResponse {
547 oFsm.mutexIsAwaitingAdapterDlResponse.RUnlock()
548 //use channel to indicate that the download response waiting shall be aborted for this device (channel)
549 oFsm.chAdapterDlReady <- false
550 } else {
551 oFsm.mutexIsAwaitingAdapterDlResponse.RUnlock()
552 }
553 //chOnuDlReady is cleared as part of the FSM reset processing (from enterResetting())
554
555 // in any case (even if it might be automatically requested by above cancellation of waiting) ensure resetting the FSM
mpagenko1f8e8822021-06-25 14:10:21 +0000556 // specific here: See definition of state changes: some states are excluded from reset for possible later commit
mpagenkoa2b288f2021-10-21 11:25:27 +0000557 pAdaptFsm = oFsm.PAdaptFsm
mpagenko59862f02021-10-11 08:53:18 +0000558 if pAdaptFsm != nil && pAdaptFsm.PFsm != nil {
mpagenkoc26d4c02021-05-06 14:27:57 +0000559 // calling FSM events in background to avoid blocking of the caller
mpagenko59862f02021-10-11 08:53:18 +0000560 go func(apFsm *fsm.FSM) {
561 if apFsm.Is(UpgradeStWaitEndDL) {
562 oFsm.chReceiveExpectedResponse <- false //which aborts the FSM in WaitEndDL state
563 } else if apFsm.Is(UpgradeStAbortingDL) {
564 oFsm.chReceiveAbortEndSwDlResponse <- cEndSwDlResponseAbort //abort waiting on EndDownloadResponse
565 }
mpagenko38662d02021-08-11 09:45:19 +0000566
mpagenko59862f02021-10-11 08:53:18 +0000567 var err error
568 if abCompleteAbort {
569 // in case of unconditional abort request the ImageState is set immediately
570 oFsm.mutexUpgradeParams.Lock()
571 //any previous lingering conditional cancelRequest is superseded by this abortion
572 oFsm.conditionalCancelRequested = false
573 oFsm.volthaDownloadReason = aReason
574 oFsm.mutexUpgradeParams.Unlock()
575 err = apFsm.Event(UpgradeEvAbort) //as unconditional default FSM cancellation
576 } else {
577 //at conditional abort request the image states are set when reaching the reset state
mpagenkoa2b288f2021-10-21 11:25:27 +0000578 oFsm.mutexUpgradeParams.Lock()
mpagenko59862f02021-10-11 08:53:18 +0000579 oFsm.conditionalCancelRequested = true
mpagenkoa2b288f2021-10-21 11:25:27 +0000580 oFsm.mutexUpgradeParams.Unlock()
mpagenko59862f02021-10-11 08:53:18 +0000581 err = apFsm.Event(UpgradeEvReset) //as state-conditional default FSM cleanup
582 }
583 if err != nil {
584 //error return is expected in case of conditional request and no state transition
585 logger.Debugw(ctx, "onu upgrade fsm could not cancel with abort/reset event", log.Fields{
586 "device-id": oFsm.deviceID, "error": err})
587 }
mpagenkoa2b288f2021-10-21 11:25:27 +0000588 logger.Debugw(ctx, "OnuUpgradeFsm canceling done", log.Fields{
589 "device-id": oFsm.deviceID})
mpagenko59862f02021-10-11 08:53:18 +0000590 }(pAdaptFsm.PFsm)
mpagenkoa2b288f2021-10-21 11:25:27 +0000591 } else { //the FSM seems already to be in some released state
592 logger.Warnw(ctx, "OnuUpgradeFsm canceling without FSM event", log.Fields{
593 "device-id": oFsm.deviceID})
594 }
mpagenkoc26d4c02021-05-06 14:27:57 +0000595}
596
mpagenko80622a52021-02-09 16:53:23 +0000597func (oFsm *OnuUpgradeFsm) enterStarting(ctx context.Context, e *fsm.Event) {
598 logger.Debugw(ctx, "OnuUpgradeFsm start", log.Fields{"in state": e.FSM.Current(),
599 "device-id": oFsm.deviceID})
600
601 // start go routine for processing of LockState messages
602 go oFsm.processOmciUpgradeMessages(ctx)
603}
604
mpagenkoc26d4c02021-05-06 14:27:57 +0000605//enterWaitingAdapterDL state can only be reached with useAPIVersion43
606func (oFsm *OnuUpgradeFsm) enterWaitingAdapterDL(ctx context.Context, e *fsm.Event) {
607 logger.Debugw(ctx, "OnuUpgradeFsm waiting for adapter download", log.Fields{"in state": e.FSM.Current(),
608 "device-id": oFsm.deviceID})
mpagenko38662d02021-08-11 09:45:19 +0000609 syncChannel := make(chan struct{})
610 go oFsm.waitOnDownloadToAdapterReady(ctx, syncChannel, oFsm.chAdapterDlReady)
611 //block until the wait routine is really blocked on chAdapterDlReady
612 <-syncChannel
mpagenkoc26d4c02021-05-06 14:27:57 +0000613 go oFsm.pFileManager.RequestDownloadReady(ctx, oFsm.imageIdentifier, oFsm.chAdapterDlReady)
614}
615
mpagenko80622a52021-02-09 16:53:23 +0000616func (oFsm *OnuUpgradeFsm) enterPreparingDL(ctx context.Context, e *fsm.Event) {
617 logger.Debugw(ctx, "OnuUpgradeFsm prepare Download to Onu", log.Fields{"in state": e.FSM.Current(),
618 "device-id": oFsm.deviceID})
619
mpagenkoc26d4c02021-05-06 14:27:57 +0000620 var fileLen int64
621 var err error
mpagenkoaa3afe92021-05-21 16:20:58 +0000622 oFsm.mutexUpgradeParams.Lock()
mpagenkoc26d4c02021-05-06 14:27:57 +0000623 if oFsm.useAPIVersion43 {
624 //with the new API structure download to adapter is implicit and we have to wait until the image is available
625 fileLen, err = oFsm.pFileManager.GetImageBufferLen(ctx, oFsm.imageIdentifier)
626 } else {
627 fileLen, err = oFsm.pDownloadManager.getImageBufferLen(ctx, oFsm.pImageDsc.Name, oFsm.pImageDsc.LocalDir)
628 }
mpagenko80622a52021-02-09 16:53:23 +0000629 if err != nil || fileLen > int64(cMaxUint32) {
mpagenko39b703e2021-08-25 13:38:40 +0000630 oFsm.volthaDownloadReason = voltha.ImageState_UNKNOWN_ERROR //something like 'LOCAL_FILE_ERROR' would be better (proto)
mpagenkoaa3afe92021-05-21 16:20:58 +0000631 oFsm.mutexUpgradeParams.Unlock()
mpagenko80622a52021-02-09 16:53:23 +0000632 logger.Errorw(ctx, "OnuUpgradeFsm abort: problems getting image buffer length", log.Fields{
633 "device-id": oFsm.deviceID, "error": err, "length": fileLen})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000634 pBaseFsm := oFsm.PAdaptFsm
mpagenko80622a52021-02-09 16:53:23 +0000635 // Can't call FSM Event directly, decoupling it
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000636 go func(a_pAFsm *cmn.AdapterFsm) {
637 _ = a_pAFsm.PFsm.Event(UpgradeEvAbort)
mpagenko80622a52021-02-09 16:53:23 +0000638 }(pBaseFsm)
639 return
640 }
641
mpagenkoc26d4c02021-05-06 14:27:57 +0000642 //copy file content to buffer
mpagenko80622a52021-02-09 16:53:23 +0000643 oFsm.imageBuffer = make([]byte, fileLen)
mpagenkoc26d4c02021-05-06 14:27:57 +0000644 if oFsm.useAPIVersion43 {
645 oFsm.imageBuffer, err = oFsm.pFileManager.GetDownloadImageBuffer(ctx, oFsm.imageIdentifier)
646 } else {
647 oFsm.imageBuffer, err = oFsm.pDownloadManager.getDownloadImageBuffer(ctx, oFsm.pImageDsc.Name, oFsm.pImageDsc.LocalDir)
648 }
mpagenko80622a52021-02-09 16:53:23 +0000649 if err != nil {
mpagenko39b703e2021-08-25 13:38:40 +0000650 oFsm.volthaDownloadReason = voltha.ImageState_UNKNOWN_ERROR //something like 'LOCAL_FILE_ERROR' would be better (proto)
mpagenkoaa3afe92021-05-21 16:20:58 +0000651 oFsm.mutexUpgradeParams.Unlock()
mpagenko80622a52021-02-09 16:53:23 +0000652 logger.Errorw(ctx, "OnuUpgradeFsm abort: can't get image buffer", log.Fields{
653 "device-id": oFsm.deviceID, "error": err})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000654 pBaseFsm := oFsm.PAdaptFsm
mpagenko80622a52021-02-09 16:53:23 +0000655 // Can't call FSM Event directly, decoupling it
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000656 go func(a_pAFsm *cmn.AdapterFsm) {
657 _ = a_pAFsm.PFsm.Event(UpgradeEvAbort)
mpagenko80622a52021-02-09 16:53:23 +0000658 }(pBaseFsm)
659 return
660 }
661
662 oFsm.noOfSections = uint32(fileLen / cOmciDownloadSectionSize)
663 if fileLen%cOmciDownloadSectionSize > 0 {
mpagenkoc26d4c02021-05-06 14:27:57 +0000664 bufferPadding := make([]byte, cOmciDownloadSectionSize-uint32((fileLen)%cOmciDownloadSectionSize))
mpagenko80622a52021-02-09 16:53:23 +0000665 //expand the imageBuffer to exactly fit multiples of cOmciDownloadSectionSize with padding
mpagenkoc26d4c02021-05-06 14:27:57 +0000666 oFsm.imageBuffer = append(oFsm.imageBuffer[:(fileLen)], bufferPadding...)
mpagenko80622a52021-02-09 16:53:23 +0000667 oFsm.noOfSections++
668 }
669 oFsm.origImageLength = uint32(fileLen)
670 oFsm.imageLength = uint32(len(oFsm.imageBuffer))
mpagenko80622a52021-02-09 16:53:23 +0000671 logger.Infow(ctx, "OnuUpgradeFsm starts with StartSwDl values", log.Fields{
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000672 "MeId": oFsm.InactiveImageMeID, "windowSizeLimit": oFsm.omciDownloadWindowSizeLimit,
mpagenko80622a52021-02-09 16:53:23 +0000673 "ImageSize": oFsm.imageLength, "original file size": fileLen})
674 //"NumberOfCircuitPacks": oFsm.numberCircuitPacks, "CircuitPacks MeId": 0}) //parallel circuit packs download not supported
mpagenkoaa3afe92021-05-21 16:20:58 +0000675
676 oFsm.mutexUpgradeParams.Unlock()
mpagenko39b703e2021-08-25 13:38:40 +0000677
mpagenkoa2b288f2021-10-21 11:25:27 +0000678 // flush chOnuDlReady
mpagenko39b703e2021-08-25 13:38:40 +0000679 select {
680 case <-oFsm.chOnuDlReady:
681 logger.Debug(ctx, "flushed OnuDlReady channel")
682 default:
683 }
mpagenkoaa3afe92021-05-21 16:20:58 +0000684 go oFsm.waitOnDownloadToOnuReady(ctx, oFsm.chOnuDlReady) // start supervision of the complete download-to-ONU procedure
685
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000686 err = oFsm.pOmciCC.SendStartSoftwareDownload(log.WithSpanFromContext(context.Background(), ctx), oFsm.pDeviceHandler.GetOmciTimeout(), false,
687 oFsm.PAdaptFsm.CommChan, oFsm.InactiveImageMeID, oFsm.omciDownloadWindowSizeLimit, oFsm.origImageLength)
mpagenko80622a52021-02-09 16:53:23 +0000688 if err != nil {
689 logger.Errorw(ctx, "StartSwDl abort: can't send section", log.Fields{
690 "device-id": oFsm.deviceID, "error": err})
mpagenko45586762021-10-01 08:30:22 +0000691 oFsm.abortOnOmciError(ctx, true)
mpagenko80622a52021-02-09 16:53:23 +0000692 return
693 }
Holger Hildebrandt288d9472021-09-06 10:47:53 +0000694 oFsm.isEndSwDlOpen = true
mpagenko80622a52021-02-09 16:53:23 +0000695}
696
697func (oFsm *OnuUpgradeFsm) enterDownloadSection(ctx context.Context, e *fsm.Event) {
698 logger.Debugw(ctx, "OnuUpgradeFsm start downloading sections", log.Fields{
699 "device-id": oFsm.deviceID, "absolute window": oFsm.nextDownloadWindow})
mpagenkoa2b288f2021-10-21 11:25:27 +0000700 //use a background routine to send the multiple download sections frames in a loop
701 // in order to avoid blocking on synchrounous event calls for the entire (long) processing time
702 go oFsm.runSwDlSectionWindow(ctx)
703}
mpagenko80622a52021-02-09 16:53:23 +0000704
mpagenkoa2b288f2021-10-21 11:25:27 +0000705//runSwDlSectionWindow runs a loop to send all DlSection frames of one window in background
706// may be aborted by parallel change of abortRequested
707func (oFsm *OnuUpgradeFsm) runSwDlSectionWindow(ctx context.Context) {
mpagenko80622a52021-02-09 16:53:23 +0000708 var windowAckRequest uint8 = 0
709 var bufferStartOffset uint32
710 var bufferEndOffset uint32
711 var downloadSection []byte
mpagenkoa2b288f2021-10-21 11:25:27 +0000712 framePrint := false //default no printing of downloadSection frames
mpagenkoaa3afe92021-05-21 16:20:58 +0000713 oFsm.mutexUpgradeParams.Lock()
mpagenko45586762021-10-01 08:30:22 +0000714 oFsm.upgradePhase = cUpgradeDownloading //start of downloading image to ONU
mpagenko80622a52021-02-09 16:53:23 +0000715 if oFsm.nextDownloadSectionsAbsolute == 0 {
716 //debug print of first section frame
mpagenkoa2b288f2021-10-21 11:25:27 +0000717 framePrint = true
mpagenkoaa3afe92021-05-21 16:20:58 +0000718 oFsm.volthaImageState = voltha.ImageState_IMAGE_DOWNLOADING
mpagenko80622a52021-02-09 16:53:23 +0000719 }
mpagenko80622a52021-02-09 16:53:23 +0000720 for {
mpagenko38662d02021-08-11 09:45:19 +0000721 oFsm.mutexAbortRequest.RLock()
722 // this way out of the section download loop on abort request
723 if oFsm.abortRequested != voltha.ImageState_NO_ERROR {
mpagenko45586762021-10-01 08:30:22 +0000724 //states are updated when entering the reset state ...
mpagenko38662d02021-08-11 09:45:19 +0000725 oFsm.volthaDownloadReason = oFsm.abortRequested
726 oFsm.mutexAbortRequest.RUnlock()
727 oFsm.mutexUpgradeParams.Unlock()
mpagenkoa2b288f2021-10-21 11:25:27 +0000728 pUpgradeFsm := oFsm.PAdaptFsm
729 if pUpgradeFsm != nil {
730 _ = pUpgradeFsm.PFsm.Event(UpgradeEvAbort)
731 logger.Debugw(ctx, "aborting runSwDlSectionWindow", log.Fields{
732 "device-id": oFsm.deviceID, "reason": oFsm.volthaDownloadReason})
733 return
734 }
735 logger.Warnw(ctx, "pUpgradeFsm is nil", log.Fields{"device-id": oFsm.deviceID})
mpagenko38662d02021-08-11 09:45:19 +0000736 return
737 }
738 oFsm.mutexAbortRequest.RUnlock()
739
mpagenko80622a52021-02-09 16:53:23 +0000740 bufferStartOffset = oFsm.nextDownloadSectionsAbsolute * cOmciDownloadSectionSize
741 bufferEndOffset = bufferStartOffset + cOmciDownloadSectionSize - 1 //for representing cOmciDownloadSectionSizeLimit values
742 logger.Debugw(ctx, "DlSection values are", log.Fields{
743 "DlSectionNoAbsolute": oFsm.nextDownloadSectionsAbsolute,
744 "DlSectionWindow": oFsm.nextDownloadSectionsWindow,
745 "startOffset": bufferStartOffset, "endOffset": bufferEndOffset})
746 if bufferStartOffset+1 > oFsm.imageLength || bufferEndOffset+1 > oFsm.imageLength { //should never occur in this state
747 logger.Errorw(ctx, "OnuUpgradeFsm buffer error: exceeded length", log.Fields{
748 "device-id": oFsm.deviceID, "bufferStartOffset": bufferStartOffset,
749 "bufferEndOffset": bufferEndOffset, "imageLength": oFsm.imageLength})
mpagenko39b703e2021-08-25 13:38:40 +0000750 oFsm.volthaDownloadReason = voltha.ImageState_UNKNOWN_ERROR //something like 'LOCAL_FILE_ERROR' would be better (proto)
mpagenkoaa3afe92021-05-21 16:20:58 +0000751 oFsm.mutexUpgradeParams.Unlock()
mpagenko80622a52021-02-09 16:53:23 +0000752 //logical error -- reset the FSM
mpagenkoa2b288f2021-10-21 11:25:27 +0000753 pUpgradeFsm := oFsm.PAdaptFsm
754 if pUpgradeFsm != nil {
755 _ = pUpgradeFsm.PFsm.Event(UpgradeEvAbort)
756 return
757 }
758 logger.Warnw(ctx, "pUpgradeFsm is nil", log.Fields{"device-id": oFsm.deviceID})
mpagenko80622a52021-02-09 16:53:23 +0000759 return
760 }
761 downloadSection = oFsm.imageBuffer[bufferStartOffset : bufferEndOffset+1]
762 if oFsm.nextDownloadSectionsWindow == oFsm.omciDownloadWindowSizeLimit {
763 windowAckRequest = 1
764 logger.Debugw(ctx, "DlSection expect Response for complete window", log.Fields{
765 "device-id": oFsm.deviceID, "in window": oFsm.nextDownloadWindow})
766 }
767 if oFsm.nextDownloadSectionsAbsolute+1 >= oFsm.noOfSections {
768 windowAckRequest = 1
mpagenkoa2b288f2021-10-21 11:25:27 +0000769 framePrint = true //debug print of last frame
mpagenko15ff4a52021-03-02 10:09:20 +0000770 oFsm.omciDownloadWindowSizeLast = oFsm.nextDownloadSectionsWindow
771 logger.Infow(ctx, "DlSection expect Response for last window (section)", log.Fields{
mpagenko80622a52021-02-09 16:53:23 +0000772 "device-id": oFsm.deviceID, "DlSectionNoAbsolute": oFsm.nextDownloadSectionsAbsolute})
773 }
mpagenkoaa3afe92021-05-21 16:20:58 +0000774 oFsm.mutexUpgradeParams.Unlock() //unlock here to give other functions some chance to process during/after the send request
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000775 err := oFsm.pOmciCC.SendDownloadSection(log.WithSpanFromContext(context.Background(), ctx), oFsm.pDeviceHandler.GetOmciTimeout(), false,
mpagenkoa2b288f2021-10-21 11:25:27 +0000776 oFsm.PAdaptFsm.CommChan, oFsm.InactiveImageMeID, windowAckRequest, oFsm.nextDownloadSectionsWindow, downloadSection, framePrint)
mpagenko80622a52021-02-09 16:53:23 +0000777 if err != nil {
778 logger.Errorw(ctx, "DlSection abort: can't send section", log.Fields{
mpagenko15ff4a52021-03-02 10:09:20 +0000779 "device-id": oFsm.deviceID, "section absolute": oFsm.nextDownloadSectionsAbsolute, "error": err})
mpagenkoa2b288f2021-10-21 11:25:27 +0000780 oFsm.abortOnOmciError(ctx, false)
mpagenko80622a52021-02-09 16:53:23 +0000781 return
782 }
mpagenkoaa3afe92021-05-21 16:20:58 +0000783 oFsm.mutexUpgradeParams.Lock()
mpagenko80622a52021-02-09 16:53:23 +0000784 oFsm.nextDownloadSectionsAbsolute++ //always increase the absolute section counter after having sent one
785 if windowAckRequest == 1 {
mpagenkoaa3afe92021-05-21 16:20:58 +0000786 oFsm.mutexUpgradeParams.Unlock()
mpagenkoa2b288f2021-10-21 11:25:27 +0000787 pUpgradeFsm := oFsm.PAdaptFsm
788 if pUpgradeFsm != nil {
789 _ = pUpgradeFsm.PFsm.Event(UpgradeEvWaitWindowAck) //state transition to upgradeStVerifyWindow
790 return
791 }
792 logger.Warnw(ctx, "pUpgradeFsm is nil", log.Fields{"device-id": oFsm.deviceID})
mpagenko80622a52021-02-09 16:53:23 +0000793 return
794 }
mpagenkoa2b288f2021-10-21 11:25:27 +0000795 framePrint = false //for the next Section frame (if wanted, can be enabled in logic before sendXXX())
mpagenko80622a52021-02-09 16:53:23 +0000796 oFsm.nextDownloadSectionsWindow++ //increase the window related section counter only if not in the last section
mpagenko59498c12021-03-18 14:15:15 +0000797 if oFsm.omciSectionInterleaveDelay > 0 {
mpagenko80622a52021-02-09 16:53:23 +0000798 //ensure a defined intersection-time-gap to leave space for further processing, other ONU's ...
mpagenkoaa3afe92021-05-21 16:20:58 +0000799 oFsm.mutexUpgradeParams.Unlock() //unlock here to give other functions some chance to process during/after the send request
mpagenko59498c12021-03-18 14:15:15 +0000800 time.Sleep(oFsm.omciSectionInterleaveDelay * time.Millisecond)
mpagenkoaa3afe92021-05-21 16:20:58 +0000801 oFsm.mutexUpgradeParams.Lock()
mpagenko80622a52021-02-09 16:53:23 +0000802 }
803 }
mpagenkoa2b288f2021-10-21 11:25:27 +0000804} //runSwDlSectionWindow
mpagenko80622a52021-02-09 16:53:23 +0000805
806func (oFsm *OnuUpgradeFsm) enterVerifyWindow(ctx context.Context, e *fsm.Event) {
807 logger.Debugw(ctx, "OnuUpgradeFsm verify DL window ack", log.Fields{
808 "for window": oFsm.nextDownloadWindow, "device-id": oFsm.deviceID})
809}
810
811func (oFsm *OnuUpgradeFsm) enterFinalizeDL(ctx context.Context, e *fsm.Event) {
mpagenko80622a52021-02-09 16:53:23 +0000812 logger.Infow(ctx, "OnuUpgradeFsm finalize DL", log.Fields{
mpagenko59498c12021-03-18 14:15:15 +0000813 "device-id": oFsm.deviceID, "crc": strconv.FormatInt(int64(oFsm.imageCRC), 16), "delay": oFsm.delayEndSwDl})
mpagenko80622a52021-02-09 16:53:23 +0000814
mpagenkoaa3afe92021-05-21 16:20:58 +0000815 oFsm.mutexUpgradeParams.RLock()
mpagenko80622a52021-02-09 16:53:23 +0000816 if oFsm.delayEndSwDl {
mpagenkoaa3afe92021-05-21 16:20:58 +0000817 oFsm.mutexUpgradeParams.RUnlock()
mpagenko80622a52021-02-09 16:53:23 +0000818 //give the ONU some time for image evaluation (hoping it does not base that on first EndSwDl itself)
819 // should not be set in case this state is used for real download abort (not yet implemented)
820 time.Sleep(cOmciEndSwDlDelaySeconds * time.Second)
mpagenkoaa3afe92021-05-21 16:20:58 +0000821 } else {
822 oFsm.mutexUpgradeParams.RUnlock()
mpagenko80622a52021-02-09 16:53:23 +0000823 }
824
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000825 pBaseFsm := oFsm.PAdaptFsm
mpagenko59498c12021-03-18 14:15:15 +0000826 if pBaseFsm == nil {
mpagenko38662d02021-08-11 09:45:19 +0000827 logger.Errorw(ctx, "EndSwDl abort: BaseFsm invalid", log.Fields{"device-id": oFsm.deviceID})
828 oFsm.mutexUpgradeParams.Lock()
mpagenko38662d02021-08-11 09:45:19 +0000829 oFsm.volthaDownloadReason = voltha.ImageState_UNKNOWN_ERROR
830 oFsm.mutexUpgradeParams.Unlock()
mpagenko59498c12021-03-18 14:15:15 +0000831 // Can't call FSM Event directly, decoupling it
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000832 go func(a_pAFsm *cmn.AdapterFsm) {
833 _ = a_pAFsm.PFsm.Event(UpgradeEvAbort)
mpagenko59498c12021-03-18 14:15:15 +0000834 }(pBaseFsm)
835 return
836 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000837 err := oFsm.pOmciCC.SendEndSoftwareDownload(log.WithSpanFromContext(context.Background(), ctx), oFsm.pDeviceHandler.GetOmciTimeout(), false,
838 oFsm.PAdaptFsm.CommChan, oFsm.InactiveImageMeID, oFsm.origImageLength, oFsm.imageCRC)
Holger Hildebrandt288d9472021-09-06 10:47:53 +0000839
mpagenko80622a52021-02-09 16:53:23 +0000840 if err != nil {
mpagenkoa2b288f2021-10-21 11:25:27 +0000841 logger.Errorw(ctx, "EndSwDl abort: error sending EndSwDl", log.Fields{
mpagenko80622a52021-02-09 16:53:23 +0000842 "device-id": oFsm.deviceID, "error": err})
mpagenko45586762021-10-01 08:30:22 +0000843 oFsm.abortOnOmciError(ctx, true)
mpagenko80622a52021-02-09 16:53:23 +0000844 return
845 }
mpagenko59498c12021-03-18 14:15:15 +0000846 // go waiting for the EndSwDLResponse and check, if the ONU is ready for activation
847 // Can't call FSM Event directly, decoupling it
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000848 go func(a_pAFsm *cmn.AdapterFsm) {
849 _ = a_pAFsm.PFsm.Event(UpgradeEvWaitEndDownload)
mpagenko59498c12021-03-18 14:15:15 +0000850 }(pBaseFsm)
851}
852
853func (oFsm *OnuUpgradeFsm) enterWaitEndDL(ctx context.Context, e *fsm.Event) {
854 logger.Infow(ctx, "OnuUpgradeFsm WaitEndDl", log.Fields{
855 "device-id": oFsm.deviceID, "wait delay": oFsm.waitDelayEndSwDl * time.Second, "wait count": oFsm.waitCountEndSwDl})
856 if oFsm.waitCountEndSwDl == 0 {
857 logger.Errorw(ctx, "WaitEndDl abort: max limit of EndSwDL reached", log.Fields{
858 "device-id": oFsm.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000859 pBaseFsm := oFsm.PAdaptFsm
mpagenko59498c12021-03-18 14:15:15 +0000860 if pBaseFsm == nil {
861 logger.Errorw(ctx, "WaitEndDl abort: BaseFsm invalid", log.Fields{
862 "device-id": oFsm.deviceID})
863 return
864 }
mpagenko38662d02021-08-11 09:45:19 +0000865 oFsm.mutexUpgradeParams.Lock()
mpagenko45586762021-10-01 08:30:22 +0000866 oFsm.isEndSwDlOpen = false //no need to additionally request abort of download (already finished)
mpagenko39b703e2021-08-25 13:38:40 +0000867 oFsm.volthaDownloadReason = voltha.ImageState_IMAGE_REFUSED_BY_ONU //something like 'END_DOWNLOAD_TIMEOUT' would be better (proto)
mpagenko38662d02021-08-11 09:45:19 +0000868 oFsm.mutexUpgradeParams.Unlock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000869 go func(a_pAFsm *cmn.AdapterFsm) {
870 _ = a_pAFsm.PFsm.Event(UpgradeEvAbort)
mpagenko59498c12021-03-18 14:15:15 +0000871 }(pBaseFsm)
872 return
873 }
874
875 oFsm.waitCountEndSwDl--
876 select {
877 case <-time.After(oFsm.waitDelayEndSwDl * time.Second):
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000878 pBaseFsm := oFsm.PAdaptFsm
mpagenko59498c12021-03-18 14:15:15 +0000879 if pBaseFsm == nil {
880 logger.Errorw(ctx, "WaitEndDl abort: BaseFsm invalid", log.Fields{
881 "device-id": oFsm.deviceID})
882 //FSM may be reset already from somewhere else, nothing we can do here anymore
883 return
884 }
885 //retry End SW DL
mpagenkoaa3afe92021-05-21 16:20:58 +0000886 oFsm.mutexUpgradeParams.Lock()
mpagenko59498c12021-03-18 14:15:15 +0000887 oFsm.delayEndSwDl = false //no more extra delay for the request
mpagenkoaa3afe92021-05-21 16:20:58 +0000888 oFsm.mutexUpgradeParams.Unlock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000889 go func(a_pAFsm *cmn.AdapterFsm) {
890 _ = a_pAFsm.PFsm.Event(UpgradeEvContinueFinalize)
mpagenko59498c12021-03-18 14:15:15 +0000891 }(pBaseFsm)
892 return
893 case success := <-oFsm.chReceiveExpectedResponse:
894 logger.Debugw(ctx, "WaitEndDl stop wait timer", log.Fields{"device-id": oFsm.deviceID})
mpagenko45586762021-10-01 08:30:22 +0000895 oFsm.isEndSwDlOpen = false //no request to abort of download (already finished or immediate abort)
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000896 pBaseFsm := oFsm.PAdaptFsm
mpagenko59498c12021-03-18 14:15:15 +0000897 if pBaseFsm == nil {
898 logger.Errorw(ctx, "WaitEndDl abort: BaseFsm invalid", log.Fields{
899 "device-id": oFsm.deviceID})
900 //FSM may be reset already from somewhere else, nothing we can do here anymore
901 return
902 }
903 if success {
904 //answer received with ready indication
mpagenko38662d02021-08-11 09:45:19 +0000905 //useAPIVersion43 may not conflict in concurrency in this state function
906 if oFsm.useAPIVersion43 { // newer API usage requires verification of downloaded image version
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000907 go func(a_pAFsm *cmn.AdapterFsm) {
908 _ = a_pAFsm.PFsm.Event(UpgradeEvCheckImageName)
mpagenkoc26d4c02021-05-06 14:27:57 +0000909 }(pBaseFsm)
mpagenko38662d02021-08-11 09:45:19 +0000910 } else { // elder API usage does not support image version check -immediately consider download as successful
911 if oFsm.activateImage {
912 //immediate activation requested
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000913 go func(a_pAFsm *cmn.AdapterFsm) {
914 _ = a_pAFsm.PFsm.Event(UpgradeEvRequestActivate)
mpagenko38662d02021-08-11 09:45:19 +0000915 }(pBaseFsm)
916 } else {
917 //have to wait on explicit activation request
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000918 go func(a_pAFsm *cmn.AdapterFsm) {
919 _ = a_pAFsm.PFsm.Event(UpgradeEvWaitForActivate)
mpagenko38662d02021-08-11 09:45:19 +0000920 }(pBaseFsm)
921 }
mpagenkoc26d4c02021-05-06 14:27:57 +0000922 }
mpagenko59498c12021-03-18 14:15:15 +0000923 return
924 }
925 //timer was aborted
mpagenko45586762021-10-01 08:30:22 +0000926 oFsm.abortOnOmciError(ctx, true)
mpagenko59498c12021-03-18 14:15:15 +0000927 return
928 }
mpagenko80622a52021-02-09 16:53:23 +0000929}
930
mpagenko38662d02021-08-11 09:45:19 +0000931func (oFsm *OnuUpgradeFsm) enterCheckImageName(ctx context.Context, e *fsm.Event) {
932 logger.Debugw(ctx, "OnuUpgradeFsm checking downloaded image name", log.Fields{
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000933 "device-id": oFsm.deviceID, "me-id": oFsm.InactiveImageMeID})
mpagenko38662d02021-08-11 09:45:19 +0000934 requestedAttributes := me.AttributeValueMap{"IsCommitted": 0, "IsActive": 0, "Version": ""}
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000935 meInstance, err := oFsm.pOmciCC.SendGetMe(log.WithSpanFromContext(context.Background(), ctx),
936 me.SoftwareImageClassID, oFsm.InactiveImageMeID, requestedAttributes, oFsm.pDeviceHandler.GetOmciTimeout(),
937 false, oFsm.PAdaptFsm.CommChan)
mpagenko38662d02021-08-11 09:45:19 +0000938 if err != nil {
939 logger.Errorw(ctx, "OnuUpgradeFsm get Software Image ME result error",
940 log.Fields{"device-id": oFsm.deviceID, "Error": err})
mpagenko45586762021-10-01 08:30:22 +0000941 oFsm.abortOnOmciError(ctx, true)
mpagenko38662d02021-08-11 09:45:19 +0000942 return
943 }
944 oFsm.pLastTxMeInstance = meInstance
945}
946
mpagenko80622a52021-02-09 16:53:23 +0000947func (oFsm *OnuUpgradeFsm) enterActivateSw(ctx context.Context, e *fsm.Event) {
948 logger.Infow(ctx, "OnuUpgradeFsm activate SW", log.Fields{
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000949 "device-id": oFsm.deviceID, "me-id": oFsm.InactiveImageMeID})
mpagenko80622a52021-02-09 16:53:23 +0000950
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000951 err := oFsm.pOmciCC.SendActivateSoftware(log.WithSpanFromContext(context.Background(), ctx), oFsm.pDeviceHandler.GetOmciTimeout(), false,
952 oFsm.PAdaptFsm.CommChan, oFsm.InactiveImageMeID)
mpagenko80622a52021-02-09 16:53:23 +0000953 if err != nil {
954 logger.Errorw(ctx, "ActivateSw abort: can't send activate frame", log.Fields{
955 "device-id": oFsm.deviceID, "error": err})
mpagenko45586762021-10-01 08:30:22 +0000956 oFsm.abortOnOmciError(ctx, true)
mpagenko80622a52021-02-09 16:53:23 +0000957 return
958 }
mpagenko38662d02021-08-11 09:45:19 +0000959 oFsm.mutexUpgradeParams.Lock()
mpagenko45586762021-10-01 08:30:22 +0000960 oFsm.upgradePhase = cUpgradeActivating //start of image activation for ONU
mpagenko38662d02021-08-11 09:45:19 +0000961 oFsm.volthaImageState = voltha.ImageState_IMAGE_ACTIVATING
962 oFsm.mutexUpgradeParams.Unlock()
mpagenko80622a52021-02-09 16:53:23 +0000963}
964
965func (oFsm *OnuUpgradeFsm) enterCommitSw(ctx context.Context, e *fsm.Event) {
mpagenko38662d02021-08-11 09:45:19 +0000966 logger.Debugw(ctx, "OnuUpgradeFsm start commit SW", log.Fields{
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000967 "device-id": oFsm.deviceID, "me-id": oFsm.InactiveImageMeID})
mpagenko38662d02021-08-11 09:45:19 +0000968 //any abort request (also conditional) is still regarded as valid as the commit indication might not be possible to verify
969 // (which is a bit problematic as the ONU might already be in committed state,
970 // in this case (committing failed) always 'onuimage list' should be used to verify the real state (if ONU is reachable))
971 if activeImageID, err := oFsm.pDevEntry.GetActiveImageMeID(ctx); err == nil {
mpagenkoaa3afe92021-05-21 16:20:58 +0000972 oFsm.mutexUpgradeParams.Lock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000973 if activeImageID == oFsm.InactiveImageMeID {
974 inactiveImageID := oFsm.InactiveImageMeID
mpagenko15ff4a52021-03-02 10:09:20 +0000975 logger.Infow(ctx, "OnuUpgradeFsm commit SW", log.Fields{
mpagenkoaa3afe92021-05-21 16:20:58 +0000976 "device-id": oFsm.deviceID, "me-id": inactiveImageID}) //more efficient activeImageID with above check
977 oFsm.volthaImageState = voltha.ImageState_IMAGE_COMMITTING
mpagenko45586762021-10-01 08:30:22 +0000978 oFsm.upgradePhase = cUpgradeCommitting //start of image commitment for ONU
mpagenkoaa3afe92021-05-21 16:20:58 +0000979 oFsm.mutexUpgradeParams.Unlock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000980 err := oFsm.pOmciCC.SendCommitSoftware(log.WithSpanFromContext(context.Background(), ctx), oFsm.pDeviceHandler.GetOmciTimeout(), false,
981 oFsm.PAdaptFsm.CommChan, inactiveImageID) //more efficient activeImageID with above check
mpagenko15ff4a52021-03-02 10:09:20 +0000982 if err != nil {
983 logger.Errorw(ctx, "CommitSw abort: can't send commit sw frame", log.Fields{
984 "device-id": oFsm.deviceID, "error": err})
mpagenko45586762021-10-01 08:30:22 +0000985 oFsm.abortOnOmciError(ctx, true)
mpagenko15ff4a52021-03-02 10:09:20 +0000986 return
987 }
988 return
989 }
mpagenko38662d02021-08-11 09:45:19 +0000990 oFsm.mutexUpgradeParams.Unlock()
mpagenko15ff4a52021-03-02 10:09:20 +0000991 logger.Errorw(ctx, "OnuUpgradeFsm active ImageId <> IdToCommit", log.Fields{
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +0000992 "device-id": oFsm.deviceID, "active ID": activeImageID, "to commit ID": oFsm.InactiveImageMeID})
mpagenko38662d02021-08-11 09:45:19 +0000993 } else {
994 logger.Errorw(ctx, "OnuUpgradeFsm can't commit, no valid active image", log.Fields{
995 "device-id": oFsm.deviceID})
mpagenko15ff4a52021-03-02 10:09:20 +0000996 }
mpagenko38662d02021-08-11 09:45:19 +0000997 oFsm.mutexUpgradeParams.Lock()
998 oFsm.conditionalCancelRequested = false //any lingering conditional cancelRequest is superseded by this error
mpagenko38662d02021-08-11 09:45:19 +0000999 oFsm.volthaDownloadReason = voltha.ImageState_CANCELLED_ON_ONU_STATE
mpagenko38662d02021-08-11 09:45:19 +00001000 oFsm.mutexUpgradeParams.Unlock()
mpagenko15ff4a52021-03-02 10:09:20 +00001001 //TODO!!!: possibly send event information for aborted upgrade (aborted by omci processing)??
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001002 pBaseFsm := oFsm.PAdaptFsm
mpagenko15ff4a52021-03-02 10:09:20 +00001003 // Can't call FSM Event directly, decoupling it
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001004 go func(a_pAFsm *cmn.AdapterFsm) {
1005 _ = a_pAFsm.PFsm.Event(UpgradeEvAbort)
mpagenko15ff4a52021-03-02 10:09:20 +00001006 }(pBaseFsm)
1007}
1008
1009func (oFsm *OnuUpgradeFsm) enterCheckCommitted(ctx context.Context, e *fsm.Event) {
mpagenko38662d02021-08-11 09:45:19 +00001010 logger.Debugw(ctx, "OnuUpgradeFsm checking committed SW", log.Fields{
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001011 "device-id": oFsm.deviceID, "me-id": oFsm.InactiveImageMeID})
mpagenko15ff4a52021-03-02 10:09:20 +00001012 requestedAttributes := me.AttributeValueMap{"IsCommitted": 0, "IsActive": 0, "Version": ""}
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001013 meInstance, err := oFsm.pOmciCC.SendGetMe(log.WithSpanFromContext(context.Background(), ctx),
1014 me.SoftwareImageClassID, oFsm.InactiveImageMeID, requestedAttributes, oFsm.pDeviceHandler.GetOmciTimeout(), false, oFsm.PAdaptFsm.CommChan)
ozgecanetsiab36ed572021-04-01 10:38:48 +03001015 if err != nil {
1016 logger.Errorw(ctx, "OnuUpgradeFsm get Software Image ME result error",
1017 log.Fields{"device-id": oFsm.deviceID, "Error": err})
mpagenko45586762021-10-01 08:30:22 +00001018 oFsm.abortOnOmciError(ctx, true)
ozgecanetsiab36ed572021-04-01 10:38:48 +03001019 return
1020 }
mpagenko15ff4a52021-03-02 10:09:20 +00001021 oFsm.pLastTxMeInstance = meInstance
mpagenko80622a52021-02-09 16:53:23 +00001022}
1023
1024func (oFsm *OnuUpgradeFsm) enterResetting(ctx context.Context, e *fsm.Event) {
1025 logger.Debugw(ctx, "OnuUpgradeFsm resetting", log.Fields{"device-id": oFsm.deviceID})
1026
mpagenko45586762021-10-01 08:30:22 +00001027 oFsm.stateUpdateOnReset(ctx)
mpagenko38662d02021-08-11 09:45:19 +00001028
mpagenkoa2b288f2021-10-21 11:25:27 +00001029 oFsm.mutexAbortRequest.Lock()
1030 //to be sure to abort a possibly still running runSwDlSectionWindow()
1031 // in case the reset was not received from cancel() and download not finished correctly
1032 oFsm.abortRequested = oFsm.volthaDownloadReason
1033 oFsm.mutexAbortRequest.Unlock()
1034
mpagenkoc26d4c02021-05-06 14:27:57 +00001035 // in case the download-to-ONU timer is still running - cancel it
mpagenko39b703e2021-08-25 13:38:40 +00001036 //use non-blocking channel (to be independent from receiver state)
1037 select {
1038 //use channel to indicate that the download response waiting shall be aborted for this device (channel)
1039 case oFsm.chOnuDlReady <- false:
1040 default:
mpagenkoc26d4c02021-05-06 14:27:57 +00001041 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001042 pConfigUpgradeStateAFsm := oFsm.PAdaptFsm
1043 if pConfigUpgradeStateAFsm != nil {
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001044 var nextEvent string
1045 if oFsm.isEndSwDlOpen {
mpagenko45586762021-10-01 08:30:22 +00001046 if oFsm.repeatAbort {
1047 oFsm.delayEndSwDl = true //run next abort with delay
1048 } else { //initial request
1049 oFsm.delayEndSwDl = false //run next abort with no delay
1050 oFsm.waitCountEndSwDl = cWaitCountEndSwDl //init for possible repetitions
1051 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001052 nextEvent = UpgradeEvAbortSwDownload
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001053 } else {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001054 nextEvent = UpgradeEvRestart
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001055 }
1056 // Can't call FSM Event directly, decoupling it
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001057 go func(a_pAFsm *cmn.AdapterFsm) {
1058 if a_pAFsm != nil && a_pAFsm.PFsm != nil {
1059 _ = a_pAFsm.PFsm.Event(nextEvent)
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001060 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001061 }(pConfigUpgradeStateAFsm)
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001062 }
1063}
mpagenkoc26d4c02021-05-06 14:27:57 +00001064
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001065func (oFsm *OnuUpgradeFsm) enterAbortingDL(ctx context.Context, e *fsm.Event) {
1066 logger.Debugw(ctx, "OnuUpgradeFsm aborting download to ONU", log.Fields{"device-id": oFsm.deviceID})
1067
mpagenko45586762021-10-01 08:30:22 +00001068 oFsm.mutexUpgradeParams.RLock()
1069 if oFsm.delayEndSwDl {
1070 oFsm.mutexUpgradeParams.RUnlock()
1071 //give the ONU some time for image discard activities
1072 time.Sleep(cOmciEndSwDlDelaySeconds * time.Second)
1073 } else {
1074 oFsm.mutexUpgradeParams.RUnlock()
1075 }
1076
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001077 pBaseFsm := oFsm.PAdaptFsm
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001078 if pBaseFsm == nil {
1079 logger.Errorw(ctx, "OnuUpgradeFsm aborting download: BaseFsm invalid", log.Fields{"device-id": oFsm.deviceID})
1080 return
1081 }
1082 // abort the download operation by sending an end software download message with invalid CRC and image size
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001083 err := oFsm.pOmciCC.SendEndSoftwareDownload(log.WithSpanFromContext(context.Background(), ctx), oFsm.pDeviceHandler.GetOmciTimeout(), false,
1084 oFsm.PAdaptFsm.CommChan, oFsm.InactiveImageMeID, 0, 0xFFFFFFFF)
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001085
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001086 if err != nil {
1087 logger.Errorw(ctx, "OnuUpgradeFsm aborting download: can't send EndSwDl request", log.Fields{"device-id": oFsm.deviceID})
1088 // Can't call FSM Event directly, decoupling it
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001089 go func(a_pAFsm *cmn.AdapterFsm) {
1090 if a_pAFsm != nil && a_pAFsm.PFsm != nil {
1091 _ = a_pAFsm.PFsm.Event(UpgradeEvRestart)
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001092 }
1093 }(pBaseFsm)
1094 return
1095 }
mpagenkoa2b288f2021-10-21 11:25:27 +00001096
1097 //avoid waiting in the enterXXX function here,
1098 // otherwise synchronous event calls (like from RxMessage processing) may block and block complete Rx processing then
1099 go oFsm.waitOnAbortEndSwDlResponse(ctx)
mpagenko45586762021-10-01 08:30:22 +00001100}
1101
1102//abortingDlEvaluateResponse waits for a channel indication with decision to proceed the FSM processing
1103func (oFsm *OnuUpgradeFsm) abortingDlEvaluateResponse(ctx context.Context,
1104 pBaseFsm *cmn.AdapterFsm, aResponseResult tEndSwDlResponseResult) bool {
1105 switch aResponseResult {
1106 case cEndSwDlResponseBusy: // indication for device busy, needs repetition
1107 if oFsm.waitCountEndSwDl == 0 {
1108 logger.Errorw(ctx, "aborting download: max limit of EndSwDl reached", log.Fields{
1109 "device-id": oFsm.deviceID})
1110 go func(a_pAFsm *cmn.AdapterFsm) {
1111 if a_pAFsm != nil && a_pAFsm.PFsm != nil {
1112 _ = a_pAFsm.PFsm.Event(UpgradeEvRestart) //give up and let FSM terminate
1113 }
1114 }(pBaseFsm)
1115 } else {
1116 logger.Debugw(ctx, "aborting download: re-trigger sending abort SwDl", log.Fields{
1117 "device-id": oFsm.deviceID, "counter": oFsm.waitCountEndSwDl})
1118 oFsm.waitCountEndSwDl--
1119 oFsm.repeatAbort = true //repeated request in next round
1120 go func(a_pAFsm *cmn.AdapterFsm) {
1121 if a_pAFsm != nil && a_pAFsm.PFsm != nil {
1122 _ = a_pAFsm.PFsm.Event(UpgradeEvReset) //which then re-triggers sending AbortSwDL
1123 }
1124 }(pBaseFsm)
1125 }
1126 return true
1127 case cEndSwDlResponseSuccess: // indication for success response
1128 logger.Infow(ctx, "aborting download: success response, terminating FSM", log.Fields{
1129 "device-id": oFsm.deviceID})
1130 case cEndSwDlResponseAbort: // indication for request to abort waiting for response
1131 logger.Infow(ctx, "aborting download: request to abort waiting, terminating FSM", log.Fields{
1132 "device-id": oFsm.deviceID})
1133 default:
1134 logger.Errorw(ctx, "aborting download: unknown channel indication, terminating FSM", log.Fields{
1135 "device-id": oFsm.deviceID})
1136 } //switch
1137 return false
Holger Hildebrandt288d9472021-09-06 10:47:53 +00001138}
1139
1140func (oFsm *OnuUpgradeFsm) enterRestarting(ctx context.Context, e *fsm.Event) {
1141 logger.Debugw(ctx, "OnuUpgradeFsm restarting", log.Fields{"device-id": oFsm.deviceID})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001142 pConfigUpgradeStateAFsm := oFsm.PAdaptFsm
1143 if pConfigUpgradeStateAFsm != nil {
mpagenko80622a52021-02-09 16:53:23 +00001144 // abort running message processing
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001145 fsmAbortMsg := cmn.Message{
1146 Type: cmn.TestMsg,
1147 Data: cmn.TestMessage{
1148 TestMessageVal: cmn.AbortMessageProcessing,
mpagenko80622a52021-02-09 16:53:23 +00001149 },
1150 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001151 pConfigUpgradeStateAFsm.CommChan <- fsmAbortMsg
mpagenko80622a52021-02-09 16:53:23 +00001152
1153 //try to restart the FSM to 'disabled'
1154 // Can't call FSM Event directly, decoupling it
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001155 go func(a_pAFsm *cmn.AdapterFsm) {
1156 if a_pAFsm != nil && a_pAFsm.PFsm != nil {
1157 _ = a_pAFsm.PFsm.Event(UpgradeEvDisable)
mpagenko80622a52021-02-09 16:53:23 +00001158 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001159 }(pConfigUpgradeStateAFsm)
mpagenko80622a52021-02-09 16:53:23 +00001160 }
1161}
1162
1163func (oFsm *OnuUpgradeFsm) enterDisabled(ctx context.Context, e *fsm.Event) {
1164 logger.Debugw(ctx, "OnuUpgradeFsm enters disabled state", log.Fields{"device-id": oFsm.deviceID})
mpagenkoc26d4c02021-05-06 14:27:57 +00001165 // no need to flush possible channels here, Upgrade FSM will be completely removed, garbage collector should find its way
mpagenko80622a52021-02-09 16:53:23 +00001166 if oFsm.pDeviceHandler != nil {
1167 //request removal of 'reference' in the Handler (completely clear the FSM and its data)
mpagenko38662d02021-08-11 09:45:19 +00001168 pLastUpgradeImageState := &voltha.ImageState{
1169 Version: oFsm.imageVersion,
1170 DownloadState: oFsm.volthaDownloadState,
1171 Reason: oFsm.volthaDownloadReason,
1172 ImageState: oFsm.volthaImageState,
1173 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001174 go oFsm.pDeviceHandler.RemoveOnuUpgradeFsm(ctx, pLastUpgradeImageState)
mpagenko80622a52021-02-09 16:53:23 +00001175 }
1176}
1177
1178func (oFsm *OnuUpgradeFsm) processOmciUpgradeMessages(ctx context.Context) { //ctx context.Context?
1179 logger.Debugw(ctx, "Start OnuUpgradeFsm Msg processing", log.Fields{"for device-id": oFsm.deviceID})
1180loop:
1181 for {
1182 // case <-ctx.Done():
1183 // logger.Info(ctx,"MibSync Msg", log.Fields{"Message handling canceled via context for device-id": oFsm.deviceID})
1184 // break loop
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001185 message, ok := <-oFsm.PAdaptFsm.CommChan
mpagenko80622a52021-02-09 16:53:23 +00001186 if !ok {
1187 logger.Info(ctx, "OnuUpgradeFsm Rx Msg - could not read from channel", log.Fields{"device-id": oFsm.deviceID})
1188 // but then we have to ensure a restart of the FSM as well - as exceptional procedure
mpagenko45586762021-10-01 08:30:22 +00001189 oFsm.abortOnOmciError(ctx, true)
mpagenko80622a52021-02-09 16:53:23 +00001190 break loop
1191 }
1192 logger.Debugw(ctx, "OnuUpgradeFsm Rx Msg", log.Fields{"device-id": oFsm.deviceID})
1193
1194 switch message.Type {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001195 case cmn.TestMsg:
1196 msg, _ := message.Data.(cmn.TestMessage)
1197 if msg.TestMessageVal == cmn.AbortMessageProcessing {
mpagenko80622a52021-02-09 16:53:23 +00001198 logger.Infow(ctx, "OnuUpgradeFsm abort ProcessMsg", log.Fields{"for device-id": oFsm.deviceID})
1199 break loop
1200 }
1201 logger.Warnw(ctx, "OnuUpgradeFsm unknown TestMessage", log.Fields{"device-id": oFsm.deviceID, "MessageVal": msg.TestMessageVal})
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001202 case cmn.OMCI:
1203 msg, _ := message.Data.(cmn.OmciMessage)
mpagenko80622a52021-02-09 16:53:23 +00001204 oFsm.handleOmciOnuUpgradeMessage(ctx, msg)
1205 default:
1206 logger.Warn(ctx, "OnuUpgradeFsm Rx unknown message", log.Fields{"device-id": oFsm.deviceID,
1207 "message.Type": message.Type})
1208 }
1209 }
1210 logger.Infow(ctx, "End OnuUpgradeFsm Msg processing", log.Fields{"device-id": oFsm.deviceID})
1211}
1212
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001213func (oFsm *OnuUpgradeFsm) handleOmciOnuUpgradeMessage(ctx context.Context, msg cmn.OmciMessage) {
mpagenko80622a52021-02-09 16:53:23 +00001214 logger.Debugw(ctx, "Rx OMCI OnuUpgradeFsm Msg", log.Fields{"device-id": oFsm.deviceID,
1215 "msgType": msg.OmciMsg.MessageType})
1216
1217 switch msg.OmciMsg.MessageType {
1218 case omci.StartSoftwareDownloadResponseType:
1219 {
mpagenko45586762021-10-01 08:30:22 +00001220 oFsm.handleRxStartSwDownloadResponse(ctx, msg)
mpagenko80622a52021-02-09 16:53:23 +00001221 return
1222 } //StartSoftwareDownloadResponseType
1223 case omci.DownloadSectionResponseType:
1224 {
mpagenko45586762021-10-01 08:30:22 +00001225 oFsm.handleRxSwSectionResponse(ctx, msg)
mpagenko80622a52021-02-09 16:53:23 +00001226 return
mpagenko80622a52021-02-09 16:53:23 +00001227 } //DownloadSectionResponseType
1228 case omci.EndSoftwareDownloadResponseType:
1229 {
mpagenko45586762021-10-01 08:30:22 +00001230 oFsm.handleRxEndSwDownloadResponse(ctx, msg)
mpagenko80622a52021-02-09 16:53:23 +00001231 return
1232 } //EndSoftwareDownloadResponseType
1233 case omci.ActivateSoftwareResponseType:
1234 {
1235 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeActivateSoftwareResponse)
1236 if msgLayer == nil {
1237 logger.Errorw(ctx, "Omci Msg layer could not be detected for ActivateSw",
1238 log.Fields{"device-id": oFsm.deviceID})
mpagenko45586762021-10-01 08:30:22 +00001239 oFsm.abortOnOmciError(ctx, false)
mpagenko80622a52021-02-09 16:53:23 +00001240 return
1241 }
1242 msgObj, msgOk := msgLayer.(*omci.ActivateSoftwareResponse)
1243 if !msgOk {
1244 logger.Errorw(ctx, "Omci Msg layer could not be assigned for ActivateSw",
1245 log.Fields{"device-id": oFsm.deviceID})
mpagenko45586762021-10-01 08:30:22 +00001246 oFsm.abortOnOmciError(ctx, false)
mpagenko80622a52021-02-09 16:53:23 +00001247 return
1248 }
1249 logger.Debugw(ctx, "OnuUpgradeFsm ActivateSwResponse data", log.Fields{
1250 "device-id": oFsm.deviceID, "data-fields": msgObj})
1251 if msgObj.Result != me.Success {
1252 logger.Errorw(ctx, "OnuUpgradeFsm ActivateSwResponse result error - later: drive FSM to abort state ?",
1253 log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
mpagenko45586762021-10-01 08:30:22 +00001254 oFsm.abortOnOmciError(ctx, false)
mpagenko80622a52021-02-09 16:53:23 +00001255 return
1256 }
mpagenko183647c2021-06-08 15:25:04 +00001257 oFsm.mutexUpgradeParams.Lock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001258 if msgObj.EntityInstance == oFsm.InactiveImageMeID {
mpagenko38662d02021-08-11 09:45:19 +00001259 // the image is regarded as active really only after ONU reboot and according indication (ONU down/up procedure)
mpagenko183647c2021-06-08 15:25:04 +00001260 oFsm.mutexUpgradeParams.Unlock()
1261 logger.Infow(ctx, "Expected ActivateSwResponse received",
1262 log.Fields{"device-id": oFsm.deviceID, "commit": oFsm.commitImage})
1263 if oFsm.commitImage {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001264 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvWaitForCommit)
mpagenko183647c2021-06-08 15:25:04 +00001265 } else {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001266 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvActivationDone) // let the FSM wait for external commit request
mpagenko183647c2021-06-08 15:25:04 +00001267 }
mpagenko80622a52021-02-09 16:53:23 +00001268 return
1269 }
mpagenko183647c2021-06-08 15:25:04 +00001270 oFsm.mutexUpgradeParams.Unlock()
mpagenko80622a52021-02-09 16:53:23 +00001271 logger.Errorw(ctx, "OnuUpgradeFsm ActivateSwResponse wrong ME instance: abort",
1272 log.Fields{"device-id": oFsm.deviceID, "ResponseMeId": msgObj.EntityInstance})
mpagenko45586762021-10-01 08:30:22 +00001273 oFsm.abortOnOmciError(ctx, false)
mpagenko80622a52021-02-09 16:53:23 +00001274 return
1275 } //ActivateSoftwareResponseType
mpagenko15ff4a52021-03-02 10:09:20 +00001276 case omci.CommitSoftwareResponseType:
1277 {
1278 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeCommitSoftwareResponse)
1279 if msgLayer == nil {
1280 logger.Errorw(ctx, "Omci Msg layer could not be detected for CommitResponse",
1281 log.Fields{"device-id": oFsm.deviceID})
mpagenko45586762021-10-01 08:30:22 +00001282 oFsm.abortOnOmciError(ctx, false)
mpagenko15ff4a52021-03-02 10:09:20 +00001283 return
1284 }
1285 msgObj, msgOk := msgLayer.(*omci.CommitSoftwareResponse)
1286 if !msgOk {
1287 logger.Errorw(ctx, "Omci Msg layer could not be assigned for CommitResponse",
1288 log.Fields{"device-id": oFsm.deviceID})
mpagenko45586762021-10-01 08:30:22 +00001289 oFsm.abortOnOmciError(ctx, false)
mpagenko15ff4a52021-03-02 10:09:20 +00001290 return
1291 }
mpagenkobf67a092021-03-17 09:52:28 +00001292 if msgObj.Result != me.Success {
mpagenko15ff4a52021-03-02 10:09:20 +00001293 logger.Errorw(ctx, "OnuUpgradeFsm SwImage CommitResponse result error - later: drive FSM to abort state ?",
1294 log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
mpagenko45586762021-10-01 08:30:22 +00001295 oFsm.abortOnOmciError(ctx, false)
mpagenko15ff4a52021-03-02 10:09:20 +00001296 return
mpagenkobf67a092021-03-17 09:52:28 +00001297 }
mpagenkoaa3afe92021-05-21 16:20:58 +00001298 oFsm.mutexUpgradeParams.RLock()
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001299 if msgObj.EntityInstance == oFsm.InactiveImageMeID {
mpagenkoaa3afe92021-05-21 16:20:58 +00001300 oFsm.mutexUpgradeParams.RUnlock()
mpagenko15ff4a52021-03-02 10:09:20 +00001301 logger.Debugw(ctx, "OnuUpgradeFsm Expected SwImage CommitResponse received", log.Fields{"device-id": oFsm.deviceID})
1302 //verifying committed image
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001303 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvCheckCommitted)
mpagenko15ff4a52021-03-02 10:09:20 +00001304 return
1305 }
mpagenkoaa3afe92021-05-21 16:20:58 +00001306 oFsm.mutexUpgradeParams.RUnlock()
mpagenko15ff4a52021-03-02 10:09:20 +00001307 logger.Errorw(ctx, "OnuUpgradeFsm SwImage CommitResponse wrong ME instance: abort",
1308 log.Fields{"device-id": oFsm.deviceID, "ResponseMeId": msgObj.EntityInstance})
mpagenko45586762021-10-01 08:30:22 +00001309 oFsm.abortOnOmciError(ctx, false)
mpagenko15ff4a52021-03-02 10:09:20 +00001310 return
1311 } //CommitSoftwareResponseType
1312 case omci.GetResponseType:
1313 {
mpagenko45586762021-10-01 08:30:22 +00001314 oFsm.handleRxSwGetResponse(ctx, msg)
mpagenko15ff4a52021-03-02 10:09:20 +00001315 return
1316 } //GetResponseType
mpagenko80622a52021-02-09 16:53:23 +00001317 default:
1318 {
1319 logger.Errorw(ctx, "Rx OMCI unhandled MsgType",
1320 log.Fields{"omciMsgType": msg.OmciMsg.MessageType, "device-id": oFsm.deviceID})
1321 return
1322 }
1323 }
1324}
1325
mpagenko45586762021-10-01 08:30:22 +00001326func (oFsm *OnuUpgradeFsm) handleRxStartSwDownloadResponse(ctx context.Context, msg cmn.OmciMessage) {
1327 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeStartSoftwareDownloadResponse)
1328 if msgLayer == nil {
1329 logger.Errorw(ctx, "Omci Msg layer could not be detected for StartSwDlResponse",
1330 log.Fields{"device-id": oFsm.deviceID})
1331 oFsm.abortOnOmciError(ctx, false)
1332 return
1333 }
1334 msgObj, msgOk := msgLayer.(*omci.StartSoftwareDownloadResponse)
1335 if !msgOk {
1336 logger.Errorw(ctx, "Omci Msg layer could not be assigned for StartSwDlResponse",
1337 log.Fields{"device-id": oFsm.deviceID})
1338 oFsm.abortOnOmciError(ctx, false)
1339 return
1340 }
1341 logger.Debugw(ctx, "OnuUpgradeFsm StartSwDlResponse data", log.Fields{
1342 "device-id": oFsm.deviceID, "data-fields": msgObj})
1343 if msgObj.Result != me.Success {
1344 logger.Errorw(ctx, "OnuUpgradeFsm StartSwDlResponse result error - later: drive FSM to abort state ?",
1345 log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
1346 oFsm.abortOnOmciError(ctx, false)
1347 return
1348 }
1349
1350 oFsm.mutexUpgradeParams.Lock()
1351 if msgObj.EntityInstance == oFsm.InactiveImageMeID {
1352 logger.Debugw(ctx, "Expected StartSwDlResponse received", log.Fields{"device-id": oFsm.deviceID})
1353 if msgObj.WindowSize != oFsm.omciDownloadWindowSizeLimit {
1354 // also response WindowSize = 0 is a valid number for used Window size 1
1355 logger.Debugw(ctx, "different StartSwDlResponse window size requested by ONU", log.Fields{
1356 "acceptedOnuWindowSizeLimit": msgObj.WindowSize, "device-id": oFsm.deviceID})
1357 oFsm.omciDownloadWindowSizeLimit = msgObj.WindowSize
1358 }
1359 oFsm.noOfWindows = oFsm.noOfSections / uint32(oFsm.omciDownloadWindowSizeLimit+1)
1360 if oFsm.noOfSections%uint32(oFsm.omciDownloadWindowSizeLimit+1) > 0 {
1361 oFsm.noOfWindows++
1362 }
1363 logger.Debugw(ctx, "OnuUpgradeFsm will use", log.Fields{
1364 "windows": oFsm.noOfWindows, "sections": oFsm.noOfSections,
1365 "at WindowSizeLimit": oFsm.omciDownloadWindowSizeLimit})
1366 oFsm.nextDownloadSectionsAbsolute = 0
1367 oFsm.nextDownloadSectionsWindow = 0
1368 oFsm.nextDownloadWindow = 0
1369
1370 oFsm.mutexUpgradeParams.Unlock()
1371 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvRxStartSwDownload)
1372 return
1373 }
1374 oFsm.mutexUpgradeParams.Unlock()
1375 logger.Errorw(ctx, "OnuUpgradeFsm StartSwDlResponse wrong ME instance: try again (later)?",
1376 log.Fields{"device-id": oFsm.deviceID, "ResponseMeId": msgObj.EntityInstance})
1377 oFsm.abortOnOmciError(ctx, false)
1378} //handleRxStartSwDownloadResponse
1379
1380func (oFsm *OnuUpgradeFsm) handleRxSwSectionResponse(ctx context.Context, msg cmn.OmciMessage) {
mpagenkoa2b288f2021-10-21 11:25:27 +00001381 if oFsm.PAdaptFsm == nil {
1382 logger.Infow(ctx, "DlSectionResponse received - but FSM not really valid anymore", log.Fields{
1383 "device-id": oFsm.deviceID})
1384 return
1385 }
1386 if !oFsm.PAdaptFsm.PFsm.Is(UpgradeStVerifyWindow) {
1387 //all the processing here is only relevant if the FSM is in state upgradeStVerifyWindow
1388 // otherwise this response can be ignored (may stem from a long-processing window send activity,
1389 // which is not anymore relevant based on intermediate (cancel) state transitions)
1390 logger.Infow(ctx, "DlSectionResponse received - but ignored", log.Fields{
1391 "device-id": oFsm.deviceID, "fsm-state": oFsm.PAdaptFsm.PFsm.Current()})
1392 return
1393 }
mpagenko45586762021-10-01 08:30:22 +00001394 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeDownloadSectionResponse)
1395 if msgLayer == nil {
1396 logger.Errorw(ctx, "Omci Msg layer could not be detected for DlSectionResponse",
1397 log.Fields{"device-id": oFsm.deviceID, "omci-message": msg.OmciMsg})
1398 oFsm.abortOnOmciError(ctx, false)
1399 return
1400 }
1401 msgObj, msgOk := msgLayer.(*omci.DownloadSectionResponse)
1402 if !msgOk {
1403 logger.Errorw(ctx, "Omci Msg layer could not be assigned for DlSectionResponse",
1404 log.Fields{"device-id": oFsm.deviceID})
1405 oFsm.abortOnOmciError(ctx, false)
1406 return
1407 }
1408 logger.Debugw(ctx, "OnuUpgradeFsm DlSectionResponse Data", log.Fields{
1409 "device-id": oFsm.deviceID, "data-fields": msgObj})
1410 if msgObj.Result != me.Success {
1411 logger.Errorw(ctx, "OnuUpgradeFsm DlSectionResponse result error - later: repeat window once?", //TODO!!!
1412 log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
1413 oFsm.abortOnOmciError(ctx, false)
1414 return
1415 }
1416 oFsm.mutexUpgradeParams.Lock()
1417 if msgObj.EntityInstance == oFsm.InactiveImageMeID {
1418 sectionNumber := msgObj.SectionNumber
1419 logger.Infow(ctx, "DlSectionResponse received", log.Fields{
1420 "window section-number": sectionNumber, "window": oFsm.nextDownloadWindow, "device-id": oFsm.deviceID})
1421
1422 oFsm.nextDownloadWindow++
1423 if oFsm.nextDownloadWindow >= oFsm.noOfWindows {
1424 if sectionNumber != oFsm.omciDownloadWindowSizeLast {
1425 logger.Errorw(ctx, "OnuUpgradeFsm DlSectionResponse section error last window - later: repeat window once?", //TODO!!!
1426 log.Fields{"device-id": oFsm.deviceID, "actual section": sectionNumber,
1427 "expected section": oFsm.omciDownloadWindowSizeLast})
1428 oFsm.mutexUpgradeParams.Unlock()
1429 oFsm.abortOnOmciError(ctx, false)
1430 return
1431 }
1432 oFsm.delayEndSwDl = true //ensure a delay for the EndSwDl message
1433 //CRC computation for all data bytes of the file
1434 imageCRC := crc32a.Checksum(oFsm.imageBuffer[:int(oFsm.origImageLength)]) //store internal for multiple usage
1435 //revert the retrieved CRC Byte Order (seems not to deliver NetworkByteOrder)
1436 var byteSlice []byte = make([]byte, 4)
1437 binary.LittleEndian.PutUint32(byteSlice, uint32(imageCRC))
1438 oFsm.imageCRC = binary.BigEndian.Uint32(byteSlice)
1439 oFsm.mutexUpgradeParams.Unlock()
1440 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvEndSwDownload)
1441 return
1442 }
1443 if sectionNumber != oFsm.omciDownloadWindowSizeLimit {
1444 logger.Errorw(ctx, "OnuUpgradeFsm DlSectionResponse section error - later: repeat window once?", //TODO!!!
1445 log.Fields{"device-id": oFsm.deviceID, "actual-section": sectionNumber,
1446 "expected section": oFsm.omciDownloadWindowSizeLimit})
1447 oFsm.mutexUpgradeParams.Unlock()
1448 oFsm.abortOnOmciError(ctx, false)
1449 return
1450 }
1451 oFsm.nextDownloadSectionsWindow = 0
1452 oFsm.mutexUpgradeParams.Unlock()
1453 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvContinueNextWindow)
1454 return
1455 }
1456 oFsm.mutexUpgradeParams.Unlock()
1457 logger.Errorw(ctx, "OnuUpgradeFsm Omci StartSwDlResponse wrong ME instance: try again (later)?",
1458 log.Fields{"device-id": oFsm.deviceID, "ResponseMeId": msgObj.EntityInstance})
1459 oFsm.abortOnOmciError(ctx, false)
1460} //handleRxSwSectionResponse
1461
1462func (oFsm *OnuUpgradeFsm) handleRxEndSwDownloadResponse(ctx context.Context, msg cmn.OmciMessage) {
1463 inAbortingState := oFsm.PAdaptFsm.PFsm.Is(UpgradeStAbortingDL)
1464
1465 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeEndSoftwareDownloadResponse)
1466 if msgLayer == nil {
1467 logger.Errorw(ctx, "Omci Msg layer could not be detected for EndSwDlResponse",
1468 log.Fields{"device-id": oFsm.deviceID})
1469 if !inAbortingState {
1470 oFsm.abortOnOmciError(ctx, false)
1471 } //else using error log and wait for another response or 'aborting' state timeout
1472 return
1473 }
1474 msgObj, msgOk := msgLayer.(*omci.EndSoftwareDownloadResponse)
1475 if !msgOk {
1476 logger.Errorw(ctx, "Omci Msg layer could not be assigned for EndSwDlResponse",
1477 log.Fields{"device-id": oFsm.deviceID})
1478 if !inAbortingState {
1479 oFsm.abortOnOmciError(ctx, false)
1480 } //else using error log and wait for another response or 'aborting' state timeout
1481 return
1482 }
1483 logger.Debugw(ctx, "OnuUpgradeFsm EndSwDlResponse data", log.Fields{
1484 "device-id": oFsm.deviceID, "data-fields": msgObj})
1485 if msgObj.Result != me.Success {
1486 if msgObj.Result == me.DeviceBusy {
1487 //ONU indicates it is still processing the image - let the FSM just wait and then repeat the request
1488 logger.Debugw(ctx, "OnuUpgradeFsm EndSwDlResponse busy: waiting before sending new request", log.Fields{
1489 "device-id": oFsm.deviceID})
1490 if inAbortingState {
1491 //if the EndSwDl was requested from state AbortingDL then use channel to indicate ONU busy/repeat indication
1492 oFsm.chReceiveAbortEndSwDlResponse <- cEndSwDlResponseBusy //repeat abort request
1493 }
1494 oFsm.mutexUpgradeParams.Lock()
1495 oFsm.downloadReasonCached = oFsm.volthaDownloadReason //copy for later reconstruction
1496 oFsm.volthaDownloadReason = voltha.ImageState_DEVICE_BUSY
1497 oFsm.mutexUpgradeParams.Unlock()
1498 return
1499 }
mpagenko45586762021-10-01 08:30:22 +00001500 if inAbortingState {
1501 //if the EndSwDl was requested from state AbortingDL and response is error indication
mpagenkoa2b288f2021-10-21 11:25:27 +00001502 // that would be quite strange ONU behavior, no resolution from OnuAdapter, just let the FSM go on to disabled
1503 logger.Errorw(ctx, "OnuUpgradeFsm EndSwDlResponse result error - aborting anyway",
1504 log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
1505 oFsm.chReceiveAbortEndSwDlResponse <- cEndSwDlResponseAbort //error indication to stop waiting on EndDownloadResponse(abort)
1506 return
1507 }
1508 //else: ONU rejects the previous download, complete upgrade is immediately aborted with error
1509 logger.Errorw(ctx, "OnuUpgradeFsm EndSwDlResponse result error - abort upgrade",
1510 log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
1511 oFsm.mutexUpgradeParams.Lock()
1512 oFsm.conditionalCancelRequested = false //any conditional cancelRequest is superseded by this abortion
1513 oFsm.volthaDownloadReason = voltha.ImageState_CANCELLED_ON_ONU_STATE
1514 oFsm.mutexUpgradeParams.Unlock()
1515 select {
1516 case oFsm.chOnuDlReady <- false:
1517 default:
1518 }
1519 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvAbort)
mpagenko45586762021-10-01 08:30:22 +00001520 return
1521 }
1522 oFsm.mutexUpgradeParams.Lock()
1523 if msgObj.EntityInstance == oFsm.InactiveImageMeID {
1524 logger.Debugw(ctx, "Expected EndSwDlResponse received", log.Fields{"device-id": oFsm.deviceID})
1525 if oFsm.volthaDownloadReason == voltha.ImageState_DEVICE_BUSY { //was temporary on busy
1526 oFsm.volthaDownloadReason = oFsm.downloadReasonCached //recapture from mirror
1527 }
1528 if inAbortingState {
1529 oFsm.mutexUpgradeParams.Unlock()
1530 //if the EndSwDl was requested from state AbortingDL then use channel to indicate abort acceptance
1531 oFsm.chReceiveAbortEndSwDlResponse <- cEndSwDlResponseSuccess //success
1532 return
1533 }
1534 if !oFsm.useAPIVersion43 {
1535 //in the older API version the image version check was not possible
1536 // - assume new loaded image as valid-inactive immediately
1537 oFsm.volthaDownloadState = voltha.ImageState_DOWNLOAD_SUCCEEDED
1538 oFsm.volthaImageState = voltha.ImageState_IMAGE_INACTIVE
1539 oFsm.mutexUpgradeParams.Unlock()
mpagenkoa2b288f2021-10-21 11:25:27 +00001540 //use non-blocking channel (to be independent from receiver state) to indicate that the download to ONU was successful
mpagenko45586762021-10-01 08:30:22 +00001541 select {
mpagenko45586762021-10-01 08:30:22 +00001542 case oFsm.chOnuDlReady <- true:
1543 default:
1544 }
1545 } else {
1546 oFsm.mutexUpgradeParams.Unlock()
1547 }
1548 //use asynchronous channel sending to let the FSM proceed
1549 select {
1550 case oFsm.chReceiveExpectedResponse <- true:
1551 default:
1552 }
1553 return
1554 }
1555 oFsm.mutexUpgradeParams.Unlock()
1556 logger.Errorw(ctx, "OnuUpgradeFsm StartSwDlResponse wrong ME instance: ignoring",
1557 log.Fields{"device-id": oFsm.deviceID, "ResponseMeId": msgObj.EntityInstance})
1558 // no state abort in case of unexpected ImageId, just keep waiting for the correct one
1559} //handleRxEndSwDownloadResponse
1560
1561func (oFsm *OnuUpgradeFsm) handleRxSwGetResponse(ctx context.Context, msg cmn.OmciMessage) {
1562 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeGetResponse)
1563 if msgLayer == nil {
1564 logger.Errorw(ctx, "Omci Msg layer could not be detected for SwImage GetResponse",
1565 log.Fields{"device-id": oFsm.deviceID})
1566 oFsm.abortOnOmciError(ctx, false)
1567 return
1568 }
1569 msgObj, msgOk := msgLayer.(*omci.GetResponse)
1570 if !msgOk {
1571 logger.Errorw(ctx, "Omci Msg layer could not be assigned for SwImage GetResponse",
1572 log.Fields{"device-id": oFsm.deviceID})
1573 oFsm.abortOnOmciError(ctx, false)
1574 return
1575 }
1576 logger.Debugw(ctx, "OnuUpgradeFsm SwImage GetResponse data", log.Fields{
1577 "device-id": oFsm.deviceID, "data-fields": msgObj})
1578 if msgObj.EntityClass == oFsm.pLastTxMeInstance.GetClassID() &&
1579 msgObj.EntityInstance == oFsm.pLastTxMeInstance.GetEntityID() {
1580 if msgObj.Result != me.Success {
1581 logger.Errorw(ctx, "OnuUpgradeFsm SwImage GetResponse result error - later: drive FSM to abort state ?",
1582 log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
1583 oFsm.abortOnOmciError(ctx, false)
1584 return
1585 }
1586 } else {
1587 logger.Warnw(ctx, "OnuUpgradeFsm SwImage unexpected Entity GetResponse data - ignore",
1588 log.Fields{"device-id": oFsm.deviceID})
1589 return
1590 }
1591
1592 meAttributes := msgObj.Attributes
1593 imageIsCommitted := meAttributes["IsCommitted"].(uint8)
1594 imageIsActive := meAttributes["IsActive"].(uint8)
1595 imageVersion := cmn.TrimStringFromMeOctet(meAttributes["Version"])
1596 logger.Debugw(ctx, "OnuUpgradeFsm - GetResponse Data for SoftwareImage",
1597 log.Fields{"device-id": oFsm.deviceID, "entityID": msgObj.EntityInstance,
1598 "version": imageVersion, "isActive": imageIsActive, "isCommitted": imageIsCommitted})
1599
1600 if oFsm.PAdaptFsm.PFsm.Current() == UpgradeStCheckImageName {
1601 //image name check after EndSwDownload, this state (and block) can only be taken if APIVersion43 is used
1602 oFsm.verifyOnuSwStatusAfterDownload(ctx, msgObj.EntityInstance, imageVersion, imageIsActive, imageIsCommitted)
1603 return
1604 }
1605
1606 //assumed only relevant state here is upgradeStCheckCommitted
1607 oFsm.mutexUpgradeParams.Lock()
1608 oFsm.conditionalCancelRequested = false //getting here any set (conditional) cancelRequest is not relevant anymore
1609 if msgObj.EntityInstance == oFsm.InactiveImageMeID && imageIsActive == cmn.SwIsActive {
1610 //a check on the delivered image version is not done, the ONU delivered version might be different from what might have been
1611 // indicated in the download image version string (version must be part of the image content itself)
1612 // so checking that might be quite unreliable
1613 //but with new API this was changed, assumption is that omci image version is known at download request and exactly that is used
1614 // in all the API references, so it can and should be checked here now
1615 if oFsm.useAPIVersion43 {
1616 if imageVersion != oFsm.imageVersion {
1617 //new active version indicated on OMCI from ONU is not the expected version
1618 logger.Errorw(ctx, "OnuUpgradeFsm image-version not matching the requested upgrade",
1619 log.Fields{"device-id": oFsm.deviceID, "ResponseMeId": msgObj.EntityInstance,
1620 "onu-version": imageVersion, "expected-version": oFsm.imageVersion})
1621 // TODO!!!: error treatment?
1622 //TODO!!!: possibly send event information for aborted upgrade (aborted by wrong version)?
1623 oFsm.volthaDownloadReason = voltha.ImageState_CANCELLED_ON_ONU_STATE //something like 'UNEXPECTED_VERSION' would be better - proto def
1624 oFsm.mutexUpgradeParams.Unlock()
1625 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvAbort)
1626 return
1627 }
1628 logger.Debugw(ctx, "OnuUpgradeFsm - expected ONU image version indicated by the ONU",
1629 log.Fields{"device-id": oFsm.deviceID})
1630 }
1631 if imageIsCommitted == cmn.SwIsCommitted {
1632 oFsm.upgradePhase = cUpgradeCommitted
1633 oFsm.volthaImageState = voltha.ImageState_IMAGE_COMMITTED
1634 //store the new commit flag to onuSwImageIndications (to keep them in sync)
1635 oFsm.pDevEntry.ModifySwImageActiveCommit(ctx, imageIsCommitted)
1636 logger.Infow(ctx, "requested SW image committed, releasing OnuUpgrade", log.Fields{"device-id": oFsm.deviceID})
1637 //deviceProcStatusUpdate not used anymore,
1638 // replaced by transferring the last (more) upgrade state information within removeOnuUpgradeFsm
1639 oFsm.mutexUpgradeParams.Unlock()
1640 //releasing the upgrade FSM on success
1641 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvAbort)
1642 return
1643 }
1644 //if not committed, abort upgrade as failed. There is no implementation here that would trigger this test again
1645 }
1646 oFsm.volthaDownloadReason = voltha.ImageState_CANCELLED_ON_ONU_STATE
1647 oFsm.mutexUpgradeParams.Unlock()
1648 logger.Errorw(ctx, "OnuUpgradeFsm SwImage GetResponse indications not matching requested upgrade",
1649 log.Fields{"device-id": oFsm.deviceID, "ResponseMeId": msgObj.EntityInstance})
1650 // TODO!!!: error treatment?
1651 //TODO!!!: possibly send event information for aborted upgrade (aborted by omci processing)??
1652 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvAbort)
1653} //handleRxSwGetResponse
1654
1655func (oFsm *OnuUpgradeFsm) verifyOnuSwStatusAfterDownload(ctx context.Context, aInstanceID uint16,
1656 aImageVersion string, aImageIsActive uint8, aImageIsCommitted uint8) {
1657 oFsm.mutexUpgradeParams.Lock()
1658 if aInstanceID == oFsm.InactiveImageMeID && aImageIsActive == cmn.SwIsInactive &&
1659 aImageIsCommitted == cmn.SwIsUncommitted {
1660 if aImageVersion != oFsm.imageVersion {
1661 //new stored inactive version indicated on OMCI from ONU is not the expected version
1662 logger.Errorw(ctx, "OnuUpgradeFsm SwImage GetResponse version indication not matching requested upgrade",
1663 log.Fields{"device-id": oFsm.deviceID, "ResponseMeId": aInstanceID,
1664 "onu-version": aImageVersion, "expected-version": oFsm.imageVersion})
1665 //download state is set when entering the reset state
1666 oFsm.volthaDownloadReason = voltha.ImageState_CANCELLED_ON_ONU_STATE //something like 'UNEXPECTED_VERSION' would be better - proto def
1667 oFsm.mutexUpgradeParams.Unlock()
1668 //stop the running ONU download timer
1669 //use non-blocking channel (to be independent from receiver state)
1670 select {
1671 //use channel to indicate that the download response waiting shall be aborted for this device (channel)
1672 case oFsm.chOnuDlReady <- false:
1673 default:
1674 }
1675 // TODO!!!: error treatment?
1676 //TODO!!!: possibly send event information for aborted upgrade (aborted by wrong version)?
1677 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvAbort)
1678 return
1679 }
1680 //with APIVersion43 this is the point to consider the newly loaded image as valid (and inactive)
1681 oFsm.upgradePhase = cUpgradeDownloaded
1682 oFsm.volthaDownloadState = voltha.ImageState_DOWNLOAD_SUCCEEDED
1683 oFsm.volthaImageState = voltha.ImageState_IMAGE_INACTIVE
1684 //store the new inactive version to onuSwImageIndications (to keep them in sync)
1685 oFsm.pDevEntry.ModifySwImageInactiveVersion(ctx, oFsm.imageVersion)
1686 //proceed within upgrade FSM
1687 if oFsm.activateImage {
1688 //immediate activation requested
1689 oFsm.mutexUpgradeParams.Unlock()
1690 logger.Debugw(ctx, "OnuUpgradeFsm - expected ONU image version indicated by the ONU, continue with activation",
1691 log.Fields{"device-id": oFsm.deviceID})
1692 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvRequestActivate)
1693 } else {
1694 //have to wait on explicit activation request
1695 oFsm.mutexUpgradeParams.Unlock()
1696 logger.Infow(ctx, "OnuUpgradeFsm - expected ONU image version indicated by the ONU, wait for activate request",
1697 log.Fields{"device-id": oFsm.deviceID})
1698 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvWaitForActivate)
1699 }
1700 //use non-blocking channel (to be independent from receiver state)
1701 select {
1702 //use non-blocking channel to indicate that the download to ONU was successful
1703 case oFsm.chOnuDlReady <- true:
1704 default:
1705 }
1706 return
1707 }
1708 //not the expected image/image state
1709 oFsm.volthaDownloadReason = voltha.ImageState_CANCELLED_ON_ONU_STATE
1710 oFsm.mutexUpgradeParams.Unlock()
1711 logger.Errorw(ctx, "OnuUpgradeFsm SwImage GetResponse indications not matching requested upgrade",
1712 log.Fields{"device-id": oFsm.deviceID, "ResponseMeId": aInstanceID})
1713 // TODO!!!: error treatment?
1714 //TODO!!!: possibly send event information for aborted upgrade (aborted by ONU state indication)?
1715 _ = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvAbort)
1716} //verifyOnuSwStatusAfterDownload
1717
1718//abortOnOmciError aborts the upgrade processing with evAbort
1719// asynchronous/synchronous based on parameter aAsync
1720func (oFsm *OnuUpgradeFsm) abortOnOmciError(ctx context.Context, aAsync bool) {
mpagenko38662d02021-08-11 09:45:19 +00001721 oFsm.mutexUpgradeParams.Lock()
1722 oFsm.conditionalCancelRequested = false //any conditional cancelRequest is superseded by this abortion
mpagenko38662d02021-08-11 09:45:19 +00001723 oFsm.volthaDownloadReason = voltha.ImageState_OMCI_TRANSFER_ERROR
mpagenko38662d02021-08-11 09:45:19 +00001724 oFsm.mutexUpgradeParams.Unlock()
1725 //TODO!!!: possibly send event information for aborted upgrade (aborted by omci processing)??
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001726 if oFsm.PAdaptFsm != nil {
mpagenko38662d02021-08-11 09:45:19 +00001727 var err error
1728 if aAsync { //asynchronous call requested to ensure state transition
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001729 go func(a_pAFsm *cmn.AdapterFsm) {
1730 if a_pAFsm.PFsm != nil {
1731 err = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvAbort)
mpagenko38662d02021-08-11 09:45:19 +00001732 }
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001733 }(oFsm.PAdaptFsm)
mpagenko38662d02021-08-11 09:45:19 +00001734 } else {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001735 if oFsm.PAdaptFsm.PFsm != nil {
1736 err = oFsm.PAdaptFsm.PFsm.Event(UpgradeEvAbort)
mpagenko38662d02021-08-11 09:45:19 +00001737 }
1738 }
1739 if err != nil {
1740 logger.Warnw(ctx, "onu upgrade fsm could not abort on omci error", log.Fields{
1741 "device-id": oFsm.deviceID, "error": err})
1742 }
1743 }
1744}
1745
mpagenkoc26d4c02021-05-06 14:27:57 +00001746//waitOnDownloadToAdapterReady state can only be reached with useAPIVersion43 (usage of pFileManager)
mpagenko38662d02021-08-11 09:45:19 +00001747// precondition: mutexIsAwaitingAdapterDlResponse is lockek on call
1748func (oFsm *OnuUpgradeFsm) waitOnDownloadToAdapterReady(ctx context.Context, aSyncChannel chan<- struct{},
1749 aWaitChannel chan bool) {
mpagenkoc26d4c02021-05-06 14:27:57 +00001750 oFsm.mutexIsAwaitingAdapterDlResponse.Lock()
mpagenko38662d02021-08-11 09:45:19 +00001751 downloadToAdapterTimeout := oFsm.pFileManager.GetDownloadTimeout(ctx)
mpagenkoc26d4c02021-05-06 14:27:57 +00001752 oFsm.isWaitingForAdapterDlResponse = true
1753 oFsm.mutexIsAwaitingAdapterDlResponse.Unlock()
mpagenko38662d02021-08-11 09:45:19 +00001754 aSyncChannel <- struct{}{}
mpagenko80622a52021-02-09 16:53:23 +00001755 select {
1756 // maybe be also some outside cancel (but no context modeled for the moment ...)
1757 // case <-ctx.Done():
mpagenkoc26d4c02021-05-06 14:27:57 +00001758 // logger.Infow("OnuUpgradeFsm-waitOnDownloadToAdapterReady canceled", log.Fields{"for device-id": oFsm.deviceID})
1759 case <-time.After(downloadToAdapterTimeout): //10s should be enough for downloading some image to the adapter
1760 logger.Warnw(ctx, "OnuUpgradeFsm Waiting-adapter-download timeout", log.Fields{
1761 "for device-id": oFsm.deviceID, "image-id": oFsm.imageIdentifier, "timeout": downloadToAdapterTimeout})
1762 oFsm.pFileManager.RemoveReadyRequest(ctx, oFsm.imageIdentifier, aWaitChannel)
mpagenko39b703e2021-08-25 13:38:40 +00001763 //running into timeout here may still have the download to adapter active -> abort
1764 oFsm.pFileManager.CancelDownload(ctx, oFsm.imageIdentifier)
mpagenkoc26d4c02021-05-06 14:27:57 +00001765 oFsm.mutexIsAwaitingAdapterDlResponse.Lock()
1766 oFsm.isWaitingForAdapterDlResponse = false
1767 oFsm.mutexIsAwaitingAdapterDlResponse.Unlock()
mpagenko39b703e2021-08-25 13:38:40 +00001768 oFsm.mutexUpgradeParams.Lock()
mpagenko45586762021-10-01 08:30:22 +00001769 oFsm.conditionalCancelRequested = false //any conditional cancelRequest is superseded by this abortion
mpagenko39b703e2021-08-25 13:38:40 +00001770 oFsm.volthaDownloadReason = voltha.ImageState_UNKNOWN_ERROR //something like 'DOWNLOAD_TO_ADAPTER_TIMEOUT' would be better (proto)
mpagenko39b703e2021-08-25 13:38:40 +00001771 oFsm.mutexUpgradeParams.Unlock()
1772 //TODO!!!: possibly send event information for aborted upgrade (aborted by omci processing)??
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001773 if oFsm.PAdaptFsm != nil && oFsm.PAdaptFsm.PFsm != nil {
1774 err := oFsm.PAdaptFsm.PFsm.Event(UpgradeEvAbort)
mpagenko39b703e2021-08-25 13:38:40 +00001775 if err != nil {
1776 logger.Warnw(ctx, "onu upgrade fsm could not abort on omci error", log.Fields{
1777 "device-id": oFsm.deviceID, "error": err})
1778 }
1779 }
mpagenkoc26d4c02021-05-06 14:27:57 +00001780 return
1781
1782 case success := <-aWaitChannel:
1783 if success {
1784 logger.Debugw(ctx, "OnuUpgradeFsm image-downloaded received", log.Fields{"device-id": oFsm.deviceID})
1785 oFsm.mutexIsAwaitingAdapterDlResponse.Lock()
1786 oFsm.isWaitingForAdapterDlResponse = false
1787 oFsm.mutexIsAwaitingAdapterDlResponse.Unlock()
1788 //let the upgrade process proceed
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001789 pUpgradeFsm := oFsm.PAdaptFsm
mpagenkoc26d4c02021-05-06 14:27:57 +00001790 if pUpgradeFsm != nil {
Holger Hildebrandt4b5e73f2021-08-19 06:51:21 +00001791 _ = pUpgradeFsm.PFsm.Event(UpgradeEvPrepareSwDownload)
mpagenkoc26d4c02021-05-06 14:27:57 +00001792 } else {
1793 logger.Errorw(ctx, "pUpgradeFsm is nil", log.Fields{"device-id": oFsm.deviceID})
1794 }
1795 return
1796 }
mpagenko39b703e2021-08-25 13:38:40 +00001797 // waiting was aborted (assumed here to be caused by
1798 // error detection or cancel at download after upgrade FSM reset/abort with according image states set there)
mpagenkoc26d4c02021-05-06 14:27:57 +00001799 logger.Debugw(ctx, "OnuUpgradeFsm Waiting-adapter-download aborted", log.Fields{"device-id": oFsm.deviceID})
1800 oFsm.pFileManager.RemoveReadyRequest(ctx, oFsm.imageIdentifier, aWaitChannel)
1801 oFsm.mutexIsAwaitingAdapterDlResponse.Lock()
1802 oFsm.isWaitingForAdapterDlResponse = false
1803 oFsm.mutexIsAwaitingAdapterDlResponse.Unlock()
mpagenkoc26d4c02021-05-06 14:27:57 +00001804 return
mpagenko80622a52021-02-09 16:53:23 +00001805 }
1806}
mpagenkoc26d4c02021-05-06 14:27:57 +00001807
1808//waitOnDownloadToOnuReady state can only be reached with useAPIVersion43 (usage of pFileManager)
1809func (oFsm *OnuUpgradeFsm) waitOnDownloadToOnuReady(ctx context.Context, aWaitChannel chan bool) {
1810 downloadToOnuTimeout := time.Duration(1+(oFsm.imageLength/0x400000)) * oFsm.downloadToOnuTimeout4MB
1811 logger.Debugw(ctx, "OnuUpgradeFsm start download-to-ONU timer", log.Fields{"device-id": oFsm.deviceID,
1812 "duration": downloadToOnuTimeout})
mpagenkoc26d4c02021-05-06 14:27:57 +00001813 select {
1814 // maybe be also some outside cancel (but no context modeled for the moment ...)
1815 // case <-ctx.Done():
1816 // logger.Infow("OnuUpgradeFsm-waitOnDownloadToOnuReady canceled", log.Fields{"for device-id": oFsm.deviceID})
1817 case <-time.After(downloadToOnuTimeout): //using an image-size depending timout (in minutes)
1818 logger.Warnw(ctx, "OnuUpgradeFsm Waiting-ONU-download timeout", log.Fields{
1819 "for device-id": oFsm.deviceID, "image-id": oFsm.imageIdentifier, "timeout": downloadToOnuTimeout})
mpagenkoc26d4c02021-05-06 14:27:57 +00001820 //the upgrade process has to be aborted
mpagenko45586762021-10-01 08:30:22 +00001821 oFsm.abortOnOmciError(ctx, false)
mpagenkoc26d4c02021-05-06 14:27:57 +00001822 return
1823
1824 case success := <-aWaitChannel:
1825 if success {
1826 logger.Debugw(ctx, "OnuUpgradeFsm image-downloaded on ONU received", log.Fields{"device-id": oFsm.deviceID})
mpagenkoc26d4c02021-05-06 14:27:57 +00001827 //all fine, let the FSM proceed like defined from the sender of this event
1828 return
1829 }
1830 // waiting was aborted (assumed here to be caused by
mpagenko39b703e2021-08-25 13:38:40 +00001831 // error detection or cancel at download after upgrade FSM reset/abort with according image states set there)
mpagenkoc26d4c02021-05-06 14:27:57 +00001832 logger.Debugw(ctx, "OnuUpgradeFsm Waiting-ONU-download aborted", log.Fields{"device-id": oFsm.deviceID})
mpagenkoc26d4c02021-05-06 14:27:57 +00001833 return
1834 }
1835}
mpagenko45586762021-10-01 08:30:22 +00001836
mpagenkoa2b288f2021-10-21 11:25:27 +00001837//waitOnAbortEndSwDlResponse waits for either abort/success or timeout of EndSwDownload (for abortion)
1838func (oFsm *OnuUpgradeFsm) waitOnAbortEndSwDlResponse(ctx context.Context) {
1839 logger.Debugw(ctx, "OnuUpgradeFsm start wait for EndSwDl response (abort)", log.Fields{"device-id": oFsm.deviceID})
1840 select {
1841 case <-time.After(oFsm.pOmciCC.GetMaxOmciTimeoutWithRetries() * time.Second):
1842 logger.Warnw(ctx, "OnuUpgradeFsm aborting download: timeout - no response received", log.Fields{"device-id": oFsm.deviceID})
1843 pUpgradeFsm := oFsm.PAdaptFsm
1844 if pUpgradeFsm != nil {
1845 _ = pUpgradeFsm.PFsm.Event(UpgradeEvRestart)
1846 } else {
1847 logger.Errorw(ctx, "pUpgradeFsm is nil", log.Fields{"device-id": oFsm.deviceID})
1848 }
1849 return
1850 case response := <-oFsm.chReceiveAbortEndSwDlResponse:
1851 logger.Debugw(ctx, "OnuUpgradeFsm aborting download: response received",
1852 log.Fields{"device-id": oFsm.deviceID, "response": response})
1853 pUpgradeFsm := oFsm.PAdaptFsm
1854 if pUpgradeFsm != nil {
1855 if oFsm.abortingDlEvaluateResponse(ctx, pUpgradeFsm, response) {
1856 return //event sent from function already
1857 }
1858 _ = pUpgradeFsm.PFsm.Event(UpgradeEvRestart)
1859 } else {
1860 logger.Errorw(ctx, "pUpgradeFsm is nil", log.Fields{"device-id": oFsm.deviceID})
1861 }
1862 return
1863 } //select
1864}
1865
mpagenko45586762021-10-01 08:30:22 +00001866//stateUpdateOnReset writes the download and/or image state on entering the reset state according to FSM internal indications
1867func (oFsm *OnuUpgradeFsm) stateUpdateOnReset(ctx context.Context) {
1868 oFsm.mutexUpgradeParams.Lock()
1869 defer oFsm.mutexUpgradeParams.Unlock()
1870 if !oFsm.conditionalCancelRequested {
1871 switch oFsm.upgradePhase {
1872 case cUpgradeUndefined, cUpgradeDownloading: //coming from downloading
1873 //make sure the download state is only changed in case the device has still been downloading
1874 if oFsm.volthaDownloadReason == voltha.ImageState_CANCELLED_ON_REQUEST {
1875 // indication for termination on request
1876 oFsm.volthaDownloadState = voltha.ImageState_DOWNLOAD_CANCELLED
1877 } else if oFsm.volthaDownloadReason != voltha.ImageState_NO_ERROR {
1878 // indication for termination on failure
1879 oFsm.volthaDownloadState = voltha.ImageState_DOWNLOAD_FAILED
1880 }
1881 //reset the image state from Downloading in this case
1882 oFsm.volthaImageState = voltha.ImageState_IMAGE_UNKNOWN //something like 'IMAGE_DOWNLOAD_ABORTED' would be better (proto)
1883 //in all other upgrade phases the last set download state remains valid
1884 case cUpgradeActivating:
1885 //reset the image state from Activating in this case
1886 oFsm.volthaImageState = voltha.ImageState_IMAGE_ACTIVATION_ABORTED
1887 case cUpgradeCommitting: // indication for request to abort waiting for response
1888 //reset the image state from Activating in this case
1889 oFsm.volthaImageState = voltha.ImageState_IMAGE_COMMIT_ABORTED
1890 //default: in all other upgrade phases keep the last set imageState
1891 } //switch
1892 } else {
1893 //when reaching reset state with conditional cancel that can only result from ONU related problems
1894 // (mostly ONU down indication) - derived from resetFsms call
1895 // and it can only be related to the downloading-to-ONU phase (no need to check that additionally)
1896 oFsm.volthaDownloadState = voltha.ImageState_DOWNLOAD_FAILED
1897 oFsm.volthaDownloadReason = voltha.ImageState_CANCELLED_ON_ONU_STATE
1898 //reset the image state from Downloading in this case
1899 oFsm.volthaImageState = voltha.ImageState_IMAGE_UNKNOWN //something like 'IMAGE_DOWNLOAD_ABORTED' would be better (proto)
1900 }
1901}