blob: 973d46975f8bf2d1c58c2fed202c25ee3d9fe2d9 [file] [log] [blame]
mpagenkodff5dda2020-08-28 11:52:01 +00001/*
2 * Copyright 2020-present Open Networking Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17//Package adaptercoreonu provides the utility for onu devices, flows and statistics
18package adaptercoreonu
19
20import (
21 "context"
22 "encoding/binary"
mpagenkof582d6a2021-06-18 15:58:10 +000023 "errors"
Andrea Campanella6515c582020-10-05 11:25:00 +020024 "fmt"
ozgecanetsiab5000ef2020-11-27 14:38:20 +030025 "net"
mpagenkodff5dda2020-08-28 11:52:01 +000026 "strconv"
Holger Hildebrandt394c5522020-09-11 11:23:01 +000027 "sync"
mpagenkodff5dda2020-08-28 11:52:01 +000028 "time"
29
ozgecanetsia82b91a62021-05-21 18:54:49 +030030 meters "github.com/opencord/voltha-lib-go/v5/pkg/meters"
31 "github.com/opencord/voltha-protos/v4/go/voltha"
32
mpagenko01e726e2020-10-23 09:45:29 +000033 gp "github.com/google/gopacket"
mpagenkodff5dda2020-08-28 11:52:01 +000034 "github.com/looplab/fsm"
35 "github.com/opencord/omci-lib-go"
36 me "github.com/opencord/omci-lib-go/generated"
Girish Gowdra50e56422021-06-01 16:46:04 -070037 "github.com/opencord/voltha-lib-go/v5/pkg/log"
dbainbri4d3a0dc2020-12-02 00:33:42 +000038 of "github.com/opencord/voltha-protos/v4/go/openflow_13"
mpagenkodff5dda2020-08-28 11:52:01 +000039)
40
41const (
42 // internal predefined values
43 cDefaultDownstreamMode = 0
44 cDefaultTpid = 0x8100
mpagenko01e726e2020-10-23 09:45:29 +000045 cVtfdTableSize = 12 //as per G.988
46 cMaxAllowedFlows = cVtfdTableSize //which might be under discussion, for the moment connected to limit of VLAN's within VTFD
mpagenkodff5dda2020-08-28 11:52:01 +000047)
48
49const (
mpagenkof1fc3862021-02-16 10:09:52 +000050 // internal offsets for requestEvent according to definition in onu_device_entry::OnuDeviceEvent
51 cDeviceEventOffsetAddWithKvStore = 0 //OmciVlanFilterAddDone - OmciVlanFilterAddDone cannot use because of lint
52 cDeviceEventOffsetAddNoKvStore = OmciVlanFilterAddDoneNoKvStore - OmciVlanFilterAddDone
53 cDeviceEventOffsetRemoveWithKvStore = OmciVlanFilterRemDone - OmciVlanFilterAddDone
54 cDeviceEventOffsetRemoveNoKvStore = OmciVlanFilterRemDoneNoKvStore - OmciVlanFilterAddDone
55)
56
57const (
mpagenkodff5dda2020-08-28 11:52:01 +000058 // bit mask offsets for EVTOCD VlanTaggingOperationTable related to 32 bits (4 bytes)
59 cFilterPrioOffset = 28
60 cFilterVidOffset = 15
61 cFilterTpidOffset = 12
62 cFilterEtherTypeOffset = 0
63 cTreatTTROffset = 30
64 cTreatPrioOffset = 16
65 cTreatVidOffset = 3
66 cTreatTpidOffset = 0
67)
68const (
69 // byte offsets for EVTOCD VlanTaggingOperationTable related to overall 16 byte size with slice byte 0 as first Byte (MSB)
70 cFilterOuterOffset = 0
71 cFilterInnerOffset = 4
72 cTreatOuterOffset = 8
73 cTreatInnerOffset = 12
74)
75const (
76 // basic values used within EVTOCD VlanTaggingOperationTable in respect to their bitfields
77 cPrioIgnoreTag uint32 = 15
78 cPrioDefaultFilter uint32 = 14
79 cPrioDoNotFilter uint32 = 8
80 cDoNotFilterVid uint32 = 4096
81 cDoNotFilterTPID uint32 = 0
82 cDoNotFilterEtherType uint32 = 0
83 cDoNotAddPrio uint32 = 15
84 cCopyPrioFromInner uint32 = 8
Himani Chawla4d908332020-08-31 12:30:20 +053085 //cDontCarePrio uint32 = 0
mpagenkodff5dda2020-08-28 11:52:01 +000086 cDontCareVid uint32 = 0
87 cDontCareTpid uint32 = 0
88 cSetOutputTpidCopyDei uint32 = 4
89)
90
91const (
Holger Hildebrandt10d98192021-01-27 15:29:31 +000092 // events of config UNI port VLAN FSM
mpagenko535d6ef2021-02-26 13:15:34 +000093 vlanEvStart = "vlanEvStart"
mpagenkof1d21d12021-06-11 13:14:45 +000094 vlanEvPrepareDone = "vlanEvPrepareDone"
mpagenko535d6ef2021-02-26 13:15:34 +000095 vlanEvWaitTechProf = "vlanEvWaitTechProf"
96 vlanEvCancelOutstandingConfig = "vlanEvCancelOutstandingConfig"
97 vlanEvContinueConfig = "vlanEvContinueConfig"
98 vlanEvStartConfig = "vlanEvStartConfig"
99 vlanEvRxConfigVtfd = "vlanEvRxConfigVtfd"
100 vlanEvRxConfigEvtocd = "vlanEvRxConfigEvtocd"
101 vlanEvWaitTPIncr = "vlanEvWaitTPIncr"
102 vlanEvIncrFlowConfig = "vlanEvIncrFlowConfig"
103 vlanEvRenew = "vlanEvRenew"
104 vlanEvRemFlowConfig = "vlanEvRemFlowConfig"
105 vlanEvRemFlowDone = "vlanEvRemFlowDone"
106 vlanEvFlowDataRemoved = "vlanEvFlowDataRemoved"
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000107 //vlanEvTimeoutSimple = "vlanEvTimeoutSimple"
108 //vlanEvTimeoutMids = "vlanEvTimeoutMids"
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000109 vlanEvReset = "vlanEvReset"
110 vlanEvRestart = "vlanEvRestart"
111 vlanEvSkipOmciConfig = "vlanEvSkipOmciConfig"
112 vlanEvSkipIncFlowConfig = "vlanEvSkipIncFlowConfig"
mpagenkodff5dda2020-08-28 11:52:01 +0000113)
mpagenko01e726e2020-10-23 09:45:29 +0000114
mpagenkodff5dda2020-08-28 11:52:01 +0000115const (
Holger Hildebrandt10d98192021-01-27 15:29:31 +0000116 // states of config UNI port VLAN FSM
mpagenkodff5dda2020-08-28 11:52:01 +0000117 vlanStDisabled = "vlanStDisabled"
mpagenkof1d21d12021-06-11 13:14:45 +0000118 vlanStPreparing = "vlanStPreparing"
mpagenkodff5dda2020-08-28 11:52:01 +0000119 vlanStStarting = "vlanStStarting"
120 vlanStWaitingTechProf = "vlanStWaitingTechProf"
121 vlanStConfigVtfd = "vlanStConfigVtfd"
122 vlanStConfigEvtocd = "vlanStConfigEvtocd"
123 vlanStConfigDone = "vlanStConfigDone"
mpagenko551a4d42020-12-08 18:09:20 +0000124 vlanStIncrFlowWaitTP = "vlanStIncrFlowWaitTP"
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000125 vlanStConfigIncrFlow = "vlanStConfigIncrFlow"
mpagenko01e726e2020-10-23 09:45:29 +0000126 vlanStRemoveFlow = "vlanStRemoveFlow"
mpagenkodff5dda2020-08-28 11:52:01 +0000127 vlanStCleanupDone = "vlanStCleanupDone"
128 vlanStResetting = "vlanStResetting"
129)
mpagenkof1fc3862021-02-16 10:09:52 +0000130const cVlanFsmIdleState = vlanStConfigDone // state where no OMCI activity is done (for a longer time)
131const cVlanFsmConfiguredState = vlanStConfigDone // state that indicates that at least some valid user related VLAN configuration should exist
mpagenkodff5dda2020-08-28 11:52:01 +0000132
mpagenko01e726e2020-10-23 09:45:29 +0000133type uniVlanRuleParams struct {
mpagenko551a4d42020-12-08 18:09:20 +0000134 TpID uint8 `json:"tp_id"`
mpagenko01e726e2020-10-23 09:45:29 +0000135 MatchVid uint32 `json:"match_vid"` //use uint32 types for allowing immediate bitshifting
136 MatchPcp uint32 `json:"match_pcp"`
137 TagsToRemove uint32 `json:"tags_to_remove"`
138 SetVid uint32 `json:"set_vid"`
139 SetPcp uint32 `json:"set_pcp"`
140}
141
142type uniVlanFlowParams struct {
ozgecanetsia82b91a62021-05-21 18:54:49 +0300143 CookieSlice []uint64 `json:"cookie_slice"`
144 VlanRuleParams uniVlanRuleParams `json:"vlan_rule_params"`
145 Meter *voltha.OfpMeterConfig `json:"flow_meter"`
mpagenko01e726e2020-10-23 09:45:29 +0000146}
147
148type uniRemoveVlanFlowParams struct {
mpagenkof1d21d12021-06-11 13:14:45 +0000149 isSuspendedOnAdd bool
150 removeChannel chan bool
151 cookie uint64 //just the last cookie valid for removal
152 vlanRuleParams uniVlanRuleParams
mpagenko01e726e2020-10-23 09:45:29 +0000153}
154
mpagenkobb47bc22021-04-20 13:29:09 +0000155//UniVlanConfigFsm defines the structure for the state machine for configuration of the VLAN related setting via OMCI
156// builds upon 'VLAN rules' that are derived from multiple flows
mpagenkodff5dda2020-08-28 11:52:01 +0000157type UniVlanConfigFsm struct {
Himani Chawla6d2ae152020-09-02 13:11:20 +0530158 pDeviceHandler *deviceHandler
mpagenko01e726e2020-10-23 09:45:29 +0000159 deviceID string
Himani Chawla6d2ae152020-09-02 13:11:20 +0530160 pOmciCC *omciCC
161 pOnuUniPort *onuUniPort
162 pUniTechProf *onuUniTechProf
163 pOnuDB *onuDeviceDB
mpagenkodff5dda2020-08-28 11:52:01 +0000164 requestEvent OnuDeviceEvent
165 omciMIdsResponseReceived chan bool //seperate channel needed for checking multiInstance OMCI message responses
166 pAdaptFsm *AdapterFsm
167 acceptIncrementalEvtoOption bool
mpagenko2418ab02020-11-12 12:58:06 +0000168 clearPersistency bool
mpagenkocf48e452021-04-23 09:23:00 +0000169 isCanceled bool
mpagenko7d6bb022021-03-11 15:07:55 +0000170 isAwaitingResponse bool
171 mutexIsAwaitingResponse sync.RWMutex
mpagenko551a4d42020-12-08 18:09:20 +0000172 mutexFlowParams sync.RWMutex
mpagenkobb47bc22021-04-20 13:29:09 +0000173 chCookieDeleted chan bool //channel to indicate that a specific cookie (related to the active rule) was deleted
mpagenko9a304ea2020-12-16 15:54:01 +0000174 actualUniVlanConfigRule uniVlanRuleParams
ozgecanetsia82b91a62021-05-21 18:54:49 +0300175 actualUniVlanConfigMeter *voltha.OfpMeterConfig
mpagenko01e726e2020-10-23 09:45:29 +0000176 uniVlanFlowParamsSlice []uniVlanFlowParams
177 uniRemoveFlowsSlice []uniRemoveVlanFlowParams
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000178 numUniFlows uint8 // expected number of flows should be less than 12
179 configuredUniFlow uint8
mpagenko01e726e2020-10-23 09:45:29 +0000180 numRemoveFlows uint8
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000181 numVlanFilterEntries uint8
mpagenko01e726e2020-10-23 09:45:29 +0000182 vlanFilterList [cVtfdTableSize]uint16
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000183 evtocdID uint16
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +0000184 mutexPLastTxMeInstance sync.RWMutex
mpagenko01e726e2020-10-23 09:45:29 +0000185 pLastTxMeInstance *me.ManagedEntity
mpagenkofc4f56e2020-11-04 17:17:49 +0000186 requestEventOffset uint8
mpagenko551a4d42020-12-08 18:09:20 +0000187 TpIDWaitingFor uint8
mpagenkobb47bc22021-04-20 13:29:09 +0000188 signalOnFlowDelete bool
189 flowDeleteChannel chan<- bool
mpagenkof1fc3862021-02-16 10:09:52 +0000190 //cookie value that indicates that a rule to add is delayed by waiting for deletion of some other existing rule with the same cookie
191 delayNewRuleCookie uint64
Andrea Campanellaf66ac6e2021-05-24 17:09:20 +0200192 // Used to indicate if the FSM is for a reconciling flow and if it's the last flow to be reconciled
193 // thus notification needs to be sent on chan.
194 lastFlowToReconcile bool
mpagenkodff5dda2020-08-28 11:52:01 +0000195}
196
mpagenko01e726e2020-10-23 09:45:29 +0000197//NewUniVlanConfigFsm is the 'constructor' for the state machine to config the PON ANI ports
198// of ONU UNI ports via OMCI
dbainbri4d3a0dc2020-12-02 00:33:42 +0000199func NewUniVlanConfigFsm(ctx context.Context, apDeviceHandler *deviceHandler, apDevOmciCC *omciCC, apUniPort *onuUniPort,
mpagenko551a4d42020-12-08 18:09:20 +0000200 apUniTechProf *onuUniTechProf, apOnuDB *onuDeviceDB, aTechProfileID uint8,
mpagenko01e726e2020-10-23 09:45:29 +0000201 aRequestEvent OnuDeviceEvent, aName string, aCommChannel chan Message, aAcceptIncrementalEvto bool,
ozgecanetsia82b91a62021-05-21 18:54:49 +0300202 aCookieSlice []uint64, aMatchVlan uint16, aSetVlan uint16, aSetPcp uint8, lastFlowToRec bool, aMeter *voltha.OfpMeterConfig) *UniVlanConfigFsm {
mpagenkodff5dda2020-08-28 11:52:01 +0000203 instFsm := &UniVlanConfigFsm{
204 pDeviceHandler: apDeviceHandler,
mpagenko01e726e2020-10-23 09:45:29 +0000205 deviceID: apDeviceHandler.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +0000206 pOmciCC: apDevOmciCC,
207 pOnuUniPort: apUniPort,
208 pUniTechProf: apUniTechProf,
209 pOnuDB: apOnuDB,
mpagenkodff5dda2020-08-28 11:52:01 +0000210 requestEvent: aRequestEvent,
211 acceptIncrementalEvtoOption: aAcceptIncrementalEvto,
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000212 numUniFlows: 0,
213 configuredUniFlow: 0,
mpagenko01e726e2020-10-23 09:45:29 +0000214 numRemoveFlows: 0,
mpagenko2418ab02020-11-12 12:58:06 +0000215 clearPersistency: true,
Andrea Campanellaf66ac6e2021-05-24 17:09:20 +0200216 lastFlowToReconcile: lastFlowToRec,
mpagenkodff5dda2020-08-28 11:52:01 +0000217 }
218
mpagenko01e726e2020-10-23 09:45:29 +0000219 instFsm.pAdaptFsm = NewAdapterFsm(aName, instFsm.deviceID, aCommChannel)
mpagenkodff5dda2020-08-28 11:52:01 +0000220 if instFsm.pAdaptFsm == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000221 logger.Errorw(ctx, "UniVlanConfigFsm's AdapterFsm could not be instantiated!!", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000222 "device-id": instFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +0000223 return nil
224 }
mpagenkodff5dda2020-08-28 11:52:01 +0000225 instFsm.pAdaptFsm.pFsm = fsm.NewFSM(
226 vlanStDisabled,
227 fsm.Events{
mpagenkof1d21d12021-06-11 13:14:45 +0000228 {Name: vlanEvStart, Src: []string{vlanStDisabled}, Dst: vlanStPreparing},
229 {Name: vlanEvPrepareDone, Src: []string{vlanStPreparing}, Dst: vlanStStarting},
mpagenkodff5dda2020-08-28 11:52:01 +0000230 {Name: vlanEvWaitTechProf, Src: []string{vlanStStarting}, Dst: vlanStWaitingTechProf},
mpagenko535d6ef2021-02-26 13:15:34 +0000231 {Name: vlanEvCancelOutstandingConfig, Src: []string{vlanStWaitingTechProf}, Dst: vlanStConfigDone},
mpagenkodff5dda2020-08-28 11:52:01 +0000232 {Name: vlanEvContinueConfig, Src: []string{vlanStWaitingTechProf}, Dst: vlanStConfigVtfd},
233 {Name: vlanEvStartConfig, Src: []string{vlanStStarting}, Dst: vlanStConfigVtfd},
234 {Name: vlanEvRxConfigVtfd, Src: []string{vlanStConfigVtfd}, Dst: vlanStConfigEvtocd},
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000235 {Name: vlanEvRxConfigEvtocd, Src: []string{vlanStConfigEvtocd, vlanStConfigIncrFlow},
236 Dst: vlanStConfigDone},
mpagenko551a4d42020-12-08 18:09:20 +0000237 {Name: vlanEvRenew, Src: []string{vlanStConfigDone}, Dst: vlanStStarting},
238 {Name: vlanEvWaitTPIncr, Src: []string{vlanStConfigDone}, Dst: vlanStIncrFlowWaitTP},
239 {Name: vlanEvIncrFlowConfig, Src: []string{vlanStConfigDone, vlanStIncrFlowWaitTP},
240 Dst: vlanStConfigIncrFlow},
mpagenko01e726e2020-10-23 09:45:29 +0000241 {Name: vlanEvRemFlowConfig, Src: []string{vlanStConfigDone}, Dst: vlanStRemoveFlow},
242 {Name: vlanEvRemFlowDone, Src: []string{vlanStRemoveFlow}, Dst: vlanStCleanupDone},
243 {Name: vlanEvFlowDataRemoved, Src: []string{vlanStCleanupDone}, Dst: vlanStConfigDone},
mpagenkodff5dda2020-08-28 11:52:01 +0000244 /*
245 {Name: vlanEvTimeoutSimple, Src: []string{
246 vlanStCreatingDot1PMapper, vlanStCreatingMBPCD, vlanStSettingTconts, vlanStSettingDot1PMapper}, Dst: vlanStStarting},
247 {Name: vlanEvTimeoutMids, Src: []string{
248 vlanStCreatingGemNCTPs, vlanStCreatingGemIWs, vlanStSettingPQs}, Dst: vlanStStarting},
249 */
250 // exceptional treatment for all states except vlanStResetting
251 {Name: vlanEvReset, Src: []string{vlanStStarting, vlanStWaitingTechProf,
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000252 vlanStConfigVtfd, vlanStConfigEvtocd, vlanStConfigDone, vlanStConfigIncrFlow,
mpagenko01e726e2020-10-23 09:45:29 +0000253 vlanStRemoveFlow, vlanStCleanupDone},
mpagenkodff5dda2020-08-28 11:52:01 +0000254 Dst: vlanStResetting},
255 // the only way to get to resource-cleared disabled state again is via "resseting"
256 {Name: vlanEvRestart, Src: []string{vlanStResetting}, Dst: vlanStDisabled},
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000257 // transitions for reconcile handling according to VOL-3834
mpagenkof1d21d12021-06-11 13:14:45 +0000258 {Name: vlanEvSkipOmciConfig, Src: []string{vlanStPreparing}, Dst: vlanStConfigDone},
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000259 {Name: vlanEvSkipOmciConfig, Src: []string{vlanStConfigDone}, Dst: vlanStConfigIncrFlow},
260 {Name: vlanEvSkipIncFlowConfig, Src: []string{vlanStConfigIncrFlow}, Dst: vlanStConfigDone},
mpagenkodff5dda2020-08-28 11:52:01 +0000261 },
mpagenkodff5dda2020-08-28 11:52:01 +0000262 fsm.Callbacks{
dbainbri4d3a0dc2020-12-02 00:33:42 +0000263 "enter_state": func(e *fsm.Event) { instFsm.pAdaptFsm.logFsmStateChange(ctx, e) },
mpagenkof1d21d12021-06-11 13:14:45 +0000264 "enter_" + vlanStPreparing: func(e *fsm.Event) { instFsm.enterPreparing(ctx, e) },
dbainbri4d3a0dc2020-12-02 00:33:42 +0000265 "enter_" + vlanStStarting: func(e *fsm.Event) { instFsm.enterConfigStarting(ctx, e) },
266 "enter_" + vlanStConfigVtfd: func(e *fsm.Event) { instFsm.enterConfigVtfd(ctx, e) },
267 "enter_" + vlanStConfigEvtocd: func(e *fsm.Event) { instFsm.enterConfigEvtocd(ctx, e) },
268 "enter_" + vlanStConfigDone: func(e *fsm.Event) { instFsm.enterVlanConfigDone(ctx, e) },
269 "enter_" + vlanStConfigIncrFlow: func(e *fsm.Event) { instFsm.enterConfigIncrFlow(ctx, e) },
270 "enter_" + vlanStRemoveFlow: func(e *fsm.Event) { instFsm.enterRemoveFlow(ctx, e) },
271 "enter_" + vlanStCleanupDone: func(e *fsm.Event) { instFsm.enterVlanCleanupDone(ctx, e) },
272 "enter_" + vlanStResetting: func(e *fsm.Event) { instFsm.enterResetting(ctx, e) },
273 "enter_" + vlanStDisabled: func(e *fsm.Event) { instFsm.enterDisabled(ctx, e) },
mpagenkodff5dda2020-08-28 11:52:01 +0000274 },
275 )
276 if instFsm.pAdaptFsm.pFsm == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000277 logger.Errorw(ctx, "UniVlanConfigFsm's Base FSM could not be instantiated!!", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000278 "device-id": instFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +0000279 return nil
280 }
281
ozgecanetsia82b91a62021-05-21 18:54:49 +0300282 _ = instFsm.initUniFlowParams(ctx, aTechProfileID, aCookieSlice, aMatchVlan, aSetVlan, aSetPcp, aMeter)
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000283
dbainbri4d3a0dc2020-12-02 00:33:42 +0000284 logger.Debugw(ctx, "UniVlanConfigFsm created", log.Fields{"device-id": instFsm.deviceID,
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000285 "accIncrEvto": instFsm.acceptIncrementalEvtoOption})
mpagenkodff5dda2020-08-28 11:52:01 +0000286 return instFsm
287}
288
mpagenko01e726e2020-10-23 09:45:29 +0000289//initUniFlowParams is a simplified form of SetUniFlowParams() used for first flow parameters configuration
mpagenko551a4d42020-12-08 18:09:20 +0000290func (oFsm *UniVlanConfigFsm) initUniFlowParams(ctx context.Context, aTpID uint8, aCookieSlice []uint64,
ozgecanetsia82b91a62021-05-21 18:54:49 +0300291 aMatchVlan uint16, aSetVlan uint16, aSetPcp uint8, aMeter *voltha.OfpMeterConfig) error {
mpagenko01e726e2020-10-23 09:45:29 +0000292 loRuleParams := uniVlanRuleParams{
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000293 TpID: aTpID,
294 MatchVid: uint32(aMatchVlan),
295 SetVid: uint32(aSetVlan),
296 SetPcp: uint32(aSetPcp),
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000297 }
298 // some automatic adjustments on the filter/treat parameters as not specifically configured/ensured by flow configuration parameters
mpagenko01e726e2020-10-23 09:45:29 +0000299 loRuleParams.TagsToRemove = 1 //one tag to remove as default setting
300 loRuleParams.MatchPcp = cPrioDoNotFilter // do not Filter on prio as default
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000301
mpagenko01e726e2020-10-23 09:45:29 +0000302 if loRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000303 //then matchVlan is don't care and should be overwritten to 'transparent' here to avoid unneeded multiple flow entries
mpagenko01e726e2020-10-23 09:45:29 +0000304 loRuleParams.MatchVid = uint32(of.OfpVlanId_OFPVID_PRESENT)
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000305 //TODO!!: maybe be needed to be re-checked at flow deletion (but assume all flows are always deleted togehther)
306 } else {
307 if !oFsm.acceptIncrementalEvtoOption {
308 //then matchVlan is don't care and should be overwritten to 'transparent' here to avoid unneeded multiple flow entries
mpagenko01e726e2020-10-23 09:45:29 +0000309 loRuleParams.MatchVid = uint32(of.OfpVlanId_OFPVID_PRESENT)
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000310 }
311 }
312
mpagenko01e726e2020-10-23 09:45:29 +0000313 if loRuleParams.MatchVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000314 // no prio/vid filtering requested
mpagenko01e726e2020-10-23 09:45:29 +0000315 loRuleParams.TagsToRemove = 0 //no tag pop action
316 loRuleParams.MatchPcp = cPrioIgnoreTag // no vlan tag filtering
317 if loRuleParams.SetPcp == cCopyPrioFromInner {
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000318 //in case of no filtering and configured PrioCopy ensure default prio setting to 0
319 // which is required for stacking of untagged, but obviously also ensures prio setting for prio/singletagged
320 // might collide with NoMatchVid/CopyPrio(/setVid) setting
321 // this was some precondition setting taken over from py adapter ..
mpagenko01e726e2020-10-23 09:45:29 +0000322 loRuleParams.SetPcp = 0
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000323 }
324 }
mpagenko01e726e2020-10-23 09:45:29 +0000325
326 loFlowParams := uniVlanFlowParams{VlanRuleParams: loRuleParams}
327 loFlowParams.CookieSlice = make([]uint64, 0)
328 loFlowParams.CookieSlice = append(loFlowParams.CookieSlice, aCookieSlice...)
ozgecanetsia82b91a62021-05-21 18:54:49 +0300329 if aMeter != nil {
330 loFlowParams.Meter = aMeter
331 }
mpagenko01e726e2020-10-23 09:45:29 +0000332
333 //no mutex protection is required for initial access and adding the first flow is always possible
334 oFsm.uniVlanFlowParamsSlice = make([]uniVlanFlowParams, 0)
335 oFsm.uniVlanFlowParamsSlice = append(oFsm.uniVlanFlowParamsSlice, loFlowParams)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000336 logger.Debugw(ctx, "first UniVlanConfigFsm flow added", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000337 "Cookies": oFsm.uniVlanFlowParamsSlice[0].CookieSlice,
338 "MatchVid": strconv.FormatInt(int64(loRuleParams.MatchVid), 16),
339 "SetVid": strconv.FormatInt(int64(loRuleParams.SetVid), 16),
340 "SetPcp": loRuleParams.SetPcp,
ozgecanetsia82b91a62021-05-21 18:54:49 +0300341 "device-id": oFsm.deviceID, "uni-id": oFsm.pOnuUniPort.uniID})
mpagenko01e726e2020-10-23 09:45:29 +0000342 oFsm.numUniFlows = 1
343 oFsm.uniRemoveFlowsSlice = make([]uniRemoveVlanFlowParams, 0) //initially nothing to remove
344
345 //permanently store flow config for reconcile case
dbainbri4d3a0dc2020-12-02 00:33:42 +0000346 if err := oFsm.pDeviceHandler.storePersUniFlowConfig(ctx, oFsm.pOnuUniPort.uniID,
mpagenkof1fc3862021-02-16 10:09:52 +0000347 &oFsm.uniVlanFlowParamsSlice, true); err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000348 logger.Errorw(ctx, err.Error(), log.Fields{"device-id": oFsm.deviceID})
mpagenko01e726e2020-10-23 09:45:29 +0000349 return err
350 }
351
352 return nil
353}
354
mpagenko7d6bb022021-03-11 15:07:55 +0000355//CancelProcessing ensures that suspended processing at waiting on some response is aborted and reset of FSM
mpagenko73143992021-04-09 15:17:10 +0000356func (oFsm *UniVlanConfigFsm) CancelProcessing(ctx context.Context) {
mpagenko7d6bb022021-03-11 15:07:55 +0000357 //mutex protection is required for possible concurrent access to FSM members
mpagenkocf48e452021-04-23 09:23:00 +0000358 oFsm.mutexIsAwaitingResponse.Lock()
359 oFsm.isCanceled = true
mpagenko7d6bb022021-03-11 15:07:55 +0000360 if oFsm.isAwaitingResponse {
mpagenkocf48e452021-04-23 09:23:00 +0000361 //attention: for an unbuffered channel the sender is blocked until the value is received (processed)!
362 // accordingly the mutex must be released before sending to channel here (mutex acquired in receiver)
363 oFsm.mutexIsAwaitingResponse.Unlock()
mpagenko7d6bb022021-03-11 15:07:55 +0000364 //use channel to indicate that the response waiting shall be aborted
365 oFsm.omciMIdsResponseReceived <- false
mpagenkocf48e452021-04-23 09:23:00 +0000366 } else {
367 oFsm.mutexIsAwaitingResponse.Unlock()
mpagenko7d6bb022021-03-11 15:07:55 +0000368 }
mpagenkocf48e452021-04-23 09:23:00 +0000369
mpagenko7d6bb022021-03-11 15:07:55 +0000370 // in any case (even if it might be automatically requested by above cancellation of waiting) ensure resetting the FSM
371 pAdaptFsm := oFsm.pAdaptFsm
372 if pAdaptFsm != nil {
mpagenkobb47bc22021-04-20 13:29:09 +0000373 if fsmErr := pAdaptFsm.pFsm.Event(vlanEvReset); fsmErr != nil {
mpagenkocf48e452021-04-23 09:23:00 +0000374 logger.Errorw(ctx, "reset-event failed in UniVlanConfigFsm!",
mpagenkobb47bc22021-04-20 13:29:09 +0000375 log.Fields{"fsmState": oFsm.pAdaptFsm.pFsm.Current(), "error": fsmErr, "device-id": oFsm.deviceID})
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +0000376 }
mpagenko7d6bb022021-03-11 15:07:55 +0000377 }
378}
379
mpagenko551a4d42020-12-08 18:09:20 +0000380//GetWaitingTpID returns the TpId that the FSM might be waiting for continuation (0 if none)
381func (oFsm *UniVlanConfigFsm) GetWaitingTpID() uint8 {
382 //mutex protection is required for possible concurrent access to FSM members
383 oFsm.mutexFlowParams.RLock()
384 defer oFsm.mutexFlowParams.RUnlock()
385 return oFsm.TpIDWaitingFor
386}
387
mpagenko2418ab02020-11-12 12:58:06 +0000388//RequestClearPersistency sets the internal flag to not clear persistency data (false=NoClear)
389func (oFsm *UniVlanConfigFsm) RequestClearPersistency(aClear bool) {
390 //mutex protection is required for possible concurrent access to FSM members
mpagenko15ff4a52021-03-02 10:09:20 +0000391 oFsm.mutexFlowParams.Lock()
392 defer oFsm.mutexFlowParams.Unlock()
mpagenko2418ab02020-11-12 12:58:06 +0000393 oFsm.clearPersistency = aClear
394}
395
mpagenko01e726e2020-10-23 09:45:29 +0000396//SetUniFlowParams verifies on existence of flow parameters to be configured,
397// optionally udates the cookie list or appends a new flow if there is space
398// if possible the FSM is trigggerd to start with the processing
mpagenko551a4d42020-12-08 18:09:20 +0000399// ignore complexity by now
400// nolint: gocyclo
401func (oFsm *UniVlanConfigFsm) SetUniFlowParams(ctx context.Context, aTpID uint8, aCookieSlice []uint64,
ozgecanetsia82b91a62021-05-21 18:54:49 +0300402 aMatchVlan uint16, aSetVlan uint16, aSetPcp uint8, lastFlowToReconcile bool, aMeter *voltha.OfpMeterConfig) error {
mpagenko01e726e2020-10-23 09:45:29 +0000403 loRuleParams := uniVlanRuleParams{
404 TpID: aTpID,
405 MatchVid: uint32(aMatchVlan),
406 SetVid: uint32(aSetVlan),
407 SetPcp: uint32(aSetPcp),
408 }
409 // some automatic adjustments on the filter/treat parameters as not specifically configured/ensured by flow configuration parameters
410 loRuleParams.TagsToRemove = 1 //one tag to remove as default setting
411 loRuleParams.MatchPcp = cPrioDoNotFilter // do not Filter on prio as default
mpagenko01e726e2020-10-23 09:45:29 +0000412 if loRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
413 //then matchVlan is don't care and should be overwritten to 'transparent' here to avoid unneeded multiple flow entries
414 loRuleParams.MatchVid = uint32(of.OfpVlanId_OFPVID_PRESENT)
415 //TODO!!: maybe be needed to be re-checked at flow deletion (but assume all flows are always deleted togehther)
416 } else {
417 if !oFsm.acceptIncrementalEvtoOption {
418 //then matchVlan is don't care and should be overwritten to 'transparent' here to avoid unneeded multiple flow entries
419 loRuleParams.MatchVid = uint32(of.OfpVlanId_OFPVID_PRESENT)
420 }
421 }
422
423 if loRuleParams.MatchVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
424 // no prio/vid filtering requested
425 loRuleParams.TagsToRemove = 0 //no tag pop action
426 loRuleParams.MatchPcp = cPrioIgnoreTag // no vlan tag filtering
427 if loRuleParams.SetPcp == cCopyPrioFromInner {
428 //in case of no filtering and configured PrioCopy ensure default prio setting to 0
429 // which is required for stacking of untagged, but obviously also ensures prio setting for prio/singletagged
430 // might collide with NoMatchVid/CopyPrio(/setVid) setting
431 // this was some precondition setting taken over from py adapter ..
432 loRuleParams.SetPcp = 0
433 }
434 }
435
mpagenkof1d21d12021-06-11 13:14:45 +0000436 //check if there is some ongoing delete-request running for this flow. If so, block here until this is finished.
437 // might be accordingly rwCore processing runs into timeout in specific situations - needs to be observed ...
438 // this is to protect uniVlanFlowParams from adding new or re-writing the same cookie to the rule currently under deletion
439 oFsm.mutexFlowParams.RLock()
440 if len(oFsm.uniRemoveFlowsSlice) > 0 {
441 for flow, removeUniFlowParams := range oFsm.uniRemoveFlowsSlice {
442 if removeUniFlowParams.vlanRuleParams == loRuleParams {
443 // the flow to add is the same as the one already in progress of deleting
444 logger.Infow(ctx, "UniVlanConfigFsm flow setting - suspending rule-add due to ongoing removal", log.Fields{
mpagenkof582d6a2021-06-18 15:58:10 +0000445 "device-id": oFsm.deviceID, "cookie": removeUniFlowParams.cookie, "remove-index": flow})
446 if flow >= len(oFsm.uniRemoveFlowsSlice) {
447 logger.Errorw(ctx, "abort UniVlanConfigFsm flow add - inconsistent RemoveFlowsSlice", log.Fields{
448 "device-id": oFsm.deviceID, "slice length": len(oFsm.uniRemoveFlowsSlice)})
449 oFsm.mutexFlowParams.RUnlock()
450 return fmt.Errorf("abort UniVlanConfigFsm flow add - inconsistent RemoveFlowsSlice %s", oFsm.deviceID)
451 }
mpagenkof1d21d12021-06-11 13:14:45 +0000452 pRemoveParams := &oFsm.uniRemoveFlowsSlice[flow] //wants to modify the uniRemoveFlowsSlice element directly!
453 oFsm.mutexFlowParams.RUnlock()
454 if err := oFsm.suspendAddRule(ctx, pRemoveParams); err != nil {
455 logger.Errorw(ctx, "UniVlanConfigFsm suspension on add aborted - abort complete add-request", log.Fields{
456 "device-id": oFsm.deviceID, "cookie": removeUniFlowParams.cookie})
457 return fmt.Errorf("abort UniVlanConfigFsm suspension on add %s", oFsm.deviceID)
458 }
459 oFsm.mutexFlowParams.RLock()
mpagenkof582d6a2021-06-18 15:58:10 +0000460 break //this specific rule should only exist once per uniRemoveFlowsSlice
mpagenkof1d21d12021-06-11 13:14:45 +0000461 }
462 }
463 }
464 oFsm.mutexFlowParams.RUnlock()
465
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000466 flowEntryMatch := false
mpagenko01e726e2020-10-23 09:45:29 +0000467 flowCookieModify := false
mpagenkof1fc3862021-02-16 10:09:52 +0000468 requestAppendRule := false
Andrea Campanellaf66ac6e2021-05-24 17:09:20 +0200469 oFsm.lastFlowToReconcile = lastFlowToReconcile
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000470 //mutex protection is required for possible concurrent access to FSM members
471 oFsm.mutexFlowParams.Lock()
mpagenko01e726e2020-10-23 09:45:29 +0000472 for flow, storedUniFlowParams := range oFsm.uniVlanFlowParamsSlice {
473 //TODO: Verify if using e.g. hashes for the structures here for comparison may generate
474 // countable run time optimization (perhaps with including the hash in kvStore storage?)
475 if storedUniFlowParams.VlanRuleParams == loRuleParams {
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000476 flowEntryMatch = true
dbainbri4d3a0dc2020-12-02 00:33:42 +0000477 logger.Debugw(ctx, "UniVlanConfigFsm flow setting - rule already exists", log.Fields{
ozgecanetsia82b91a62021-05-21 18:54:49 +0300478 "MatchVid": strconv.FormatInt(int64(loRuleParams.MatchVid), 16),
479 "SetVid": strconv.FormatInt(int64(loRuleParams.SetVid), 16),
480 "SetPcp": loRuleParams.SetPcp,
481 "device-id": oFsm.deviceID, " uni-id": oFsm.pOnuUniPort.uniID})
mpagenko01e726e2020-10-23 09:45:29 +0000482 var cookieMatch bool
483 for _, newCookie := range aCookieSlice { // for all cookies available in the arguments
484 cookieMatch = false
485 for _, cookie := range storedUniFlowParams.CookieSlice {
486 if cookie == newCookie {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000487 logger.Debugw(ctx, "UniVlanConfigFsm flow setting - and cookie already exists", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000488 "device-id": oFsm.deviceID, "cookie": cookie})
489 cookieMatch = true
490 break //found new cookie - no further search for this requested cookie
491 }
492 }
493 if !cookieMatch {
mpagenkof1fc3862021-02-16 10:09:52 +0000494 delayedCookie := oFsm.delayNewRuleForCookie(ctx, aCookieSlice)
495 if delayedCookie != 0 {
496 //a delay for adding the cookie to this rule is requested
497 // take care of the mutex which is already locked here, need to unlock/lock accordingly to prevent deadlock in suspension
498 oFsm.mutexFlowParams.Unlock()
499 oFsm.suspendNewRule(ctx)
500 flowCookieModify, requestAppendRule = oFsm.reviseFlowConstellation(ctx, delayedCookie, loRuleParams)
501 oFsm.mutexFlowParams.Lock()
502 } else {
503 logger.Debugw(ctx, "UniVlanConfigFsm flow setting -adding new cookie", log.Fields{
504 "device-id": oFsm.deviceID, "cookie": newCookie})
505 //as range works with copies of the slice we have to write to the original slice!!
506 oFsm.uniVlanFlowParamsSlice[flow].CookieSlice = append(oFsm.uniVlanFlowParamsSlice[flow].CookieSlice,
507 newCookie)
508 flowCookieModify = true
509 }
mpagenko01e726e2020-10-23 09:45:29 +0000510 }
511 } //for all new cookies
512 break // found rule - no further rule search
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000513 }
514 }
mpagenkof1fc3862021-02-16 10:09:52 +0000515 oFsm.mutexFlowParams.Unlock()
516
517 if !flowEntryMatch { //it is (was) a new rule
518 delayedCookie := oFsm.suspendIfRequiredNewRule(ctx, aCookieSlice)
519 requestAppendRule = true //default assumption here is that rule is to be appended
520 flowCookieModify = true //and that the the flow data base is to be updated
521 if delayedCookie != 0 { //it was suspended
522 flowCookieModify, requestAppendRule = oFsm.reviseFlowConstellation(ctx, delayedCookie, loRuleParams)
523 }
524 }
525 kvStoreWrite := false //default setting is to not write to kvStore immediately - will be done on FSM execution finally
526 if requestAppendRule {
527 oFsm.mutexFlowParams.Lock()
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000528 if oFsm.numUniFlows < cMaxAllowedFlows {
mpagenko01e726e2020-10-23 09:45:29 +0000529 loFlowParams := uniVlanFlowParams{VlanRuleParams: loRuleParams}
530 loFlowParams.CookieSlice = make([]uint64, 0)
531 loFlowParams.CookieSlice = append(loFlowParams.CookieSlice, aCookieSlice...)
ozgecanetsia82b91a62021-05-21 18:54:49 +0300532 if aMeter != nil {
533 loFlowParams.Meter = aMeter
534 }
mpagenko01e726e2020-10-23 09:45:29 +0000535 oFsm.uniVlanFlowParamsSlice = append(oFsm.uniVlanFlowParamsSlice, loFlowParams)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000536 logger.Debugw(ctx, "UniVlanConfigFsm flow add", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000537 "Cookies": oFsm.uniVlanFlowParamsSlice[oFsm.numUniFlows].CookieSlice,
538 "MatchVid": strconv.FormatInt(int64(loRuleParams.MatchVid), 16),
539 "SetVid": strconv.FormatInt(int64(loRuleParams.SetVid), 16),
Girish Gowdra041dcb32020-11-16 16:54:30 -0800540 "SetPcp": loRuleParams.SetPcp, "numberofFlows": oFsm.numUniFlows + 1,
ozgecanetsia82b91a62021-05-21 18:54:49 +0300541 "device-id": oFsm.deviceID, "uni-id": oFsm.pOnuUniPort.uniID})
mpagenko01e726e2020-10-23 09:45:29 +0000542
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000543 oFsm.numUniFlows++
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000544 pConfigVlanStateBaseFsm := oFsm.pAdaptFsm.pFsm
545
546 if oFsm.pDeviceHandler.isSkipOnuConfigReconciling() {
547 logger.Debugw(ctx, "reconciling - skip omci-config of additional vlan rule",
548 log.Fields{"fsmState": oFsm.pAdaptFsm.pFsm.Current(), "device-id": oFsm.deviceID})
mpagenkobb47bc22021-04-20 13:29:09 +0000549 //attention: take care to release the mutexFlowParams when calling the FSM directly -
550 // synchronous FSM 'event/state' functions may rely on this mutex
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000551 oFsm.mutexFlowParams.Unlock()
552 if pConfigVlanStateBaseFsm.Is(vlanStConfigDone) {
mpagenkobb47bc22021-04-20 13:29:09 +0000553 if fsmErr := pConfigVlanStateBaseFsm.Event(vlanEvSkipOmciConfig); fsmErr != nil {
554 logger.Errorw(ctx, "error in FsmEvent handling UniVlanConfigFsm!",
555 log.Fields{"fsmState": oFsm.pAdaptFsm.pFsm.Current(), "error": fsmErr, "device-id": oFsm.deviceID})
556 }
Holger Hildebrandtbe523842021-03-10 10:47:18 +0000557 }
558 return nil
559 }
mpagenko01e726e2020-10-23 09:45:29 +0000560 // note: theoretical it would be possible to clear the same rule from the remove slice
561 // (for entries that have not yet been started with removal)
562 // but that is getting quite complicated - maybe a future optimization in case it should prove reasonable
563 // anyway the precondition here is that the FSM checks for rules to delete first and adds new rules afterwards
Holger Hildebrandt47555e72020-09-21 11:07:24 +0000564
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000565 if pConfigVlanStateBaseFsm.Is(vlanStConfigDone) {
566 //have to re-trigger the FSM to proceed with outstanding incremental flow configuration
mpagenko551a4d42020-12-08 18:09:20 +0000567 if oFsm.configuredUniFlow == 0 {
568 // this is a restart with a complete new flow, we can re-use the initial flow config control
569 // including the check, if the related techProfile is (still) available (probably also removed in between)
mpagenkobb47bc22021-04-20 13:29:09 +0000570 //attention: take care to release the mutexFlowParams when calling the FSM directly -
571 // synchronous FSM 'event/state' functions may rely on this mutex
572 oFsm.mutexFlowParams.Unlock()
573 if fsmErr := pConfigVlanStateBaseFsm.Event(vlanEvRenew); fsmErr != nil {
574 logger.Errorw(ctx, "error in FsmEvent handling UniVlanConfigFsm!",
575 log.Fields{"fsmState": pConfigVlanStateBaseFsm.Current(), "error": fsmErr, "device-id": oFsm.deviceID})
576 }
mpagenko551a4d42020-12-08 18:09:20 +0000577 } else {
578 //some further flows are to be configured
mpagenko9a304ea2020-12-16 15:54:01 +0000579 //store the actual rule that shall be worked upon in the following transient states
mpagenkof1d21d12021-06-11 13:14:45 +0000580 if len(oFsm.uniVlanFlowParamsSlice) < int(oFsm.configuredUniFlow) {
581 //check introduced after having observed some panic here
582 logger.Errorw(ctx, "error in FsmEvent handling UniVlanConfigFsm - inconsistent counter",
583 log.Fields{"configuredUniFlow": oFsm.configuredUniFlow,
584 "sliceLen": len(oFsm.uniVlanFlowParamsSlice), "device-id": oFsm.deviceID})
585 oFsm.mutexFlowParams.Unlock()
586 return fmt.Errorf("abort UniVlanConfigFsm on add due to internal counter mismatch %s", oFsm.deviceID)
587 }
mpagenko9a304ea2020-12-16 15:54:01 +0000588 oFsm.actualUniVlanConfigRule = oFsm.uniVlanFlowParamsSlice[oFsm.configuredUniFlow].VlanRuleParams
ozgecanetsia82b91a62021-05-21 18:54:49 +0300589 oFsm.actualUniVlanConfigMeter = oFsm.uniVlanFlowParamsSlice[oFsm.configuredUniFlow].Meter
mpagenko551a4d42020-12-08 18:09:20 +0000590 //tpId of the next rule to be configured
mpagenko9a304ea2020-12-16 15:54:01 +0000591 tpID := oFsm.actualUniVlanConfigRule.TpID
mpagenko551a4d42020-12-08 18:09:20 +0000592 loTechProfDone := oFsm.pUniTechProf.getTechProfileDone(ctx, oFsm.pOnuUniPort.uniID, tpID)
593 oFsm.TpIDWaitingFor = tpID
mpagenko9a304ea2020-12-16 15:54:01 +0000594 logger.Debugw(ctx, "UniVlanConfigFsm - incremental config request (on setConfig)", log.Fields{
595 "device-id": oFsm.deviceID, "uni-id": oFsm.pOnuUniPort.uniID,
596 "set-Vlan": oFsm.actualUniVlanConfigRule.SetVid, "tp-id": tpID, "ProfDone": loTechProfDone})
mpagenkobb47bc22021-04-20 13:29:09 +0000597
598 //attention: take care to release the mutexFlowParams when calling the FSM directly -
599 // synchronous FSM 'event/state' functions may rely on this mutex
600 oFsm.mutexFlowParams.Unlock()
601 var fsmErr error
602 if loTechProfDone {
603 // let the vlan processing continue with next rule
604 fsmErr = pConfigVlanStateBaseFsm.Event(vlanEvIncrFlowConfig)
605 } else {
606 // set to waiting for Techprofile
607 fsmErr = pConfigVlanStateBaseFsm.Event(vlanEvWaitTPIncr)
608 }
609 if fsmErr != nil {
610 logger.Errorw(ctx, "error in FsmEvent handling UniVlanConfigFsm!",
611 log.Fields{"fsmState": pConfigVlanStateBaseFsm.Current(), "error": fsmErr, "device-id": oFsm.deviceID})
612 }
mpagenko551a4d42020-12-08 18:09:20 +0000613 }
mpagenkobb47bc22021-04-20 13:29:09 +0000614 } else {
615 // if not in the appropriate state a new entry will be automatically considered later
616 // when the configDone state is reached
617 oFsm.mutexFlowParams.Unlock()
618 }
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000619 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000620 logger.Errorw(ctx, "UniVlanConfigFsm flow limit exceeded", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000621 "device-id": oFsm.deviceID, "flow-number": oFsm.numUniFlows})
mpagenko15ff4a52021-03-02 10:09:20 +0000622 oFsm.mutexFlowParams.Unlock()
mpagenko01e726e2020-10-23 09:45:29 +0000623 return fmt.Errorf(" UniVlanConfigFsm flow limit exceeded %s", oFsm.deviceID)
624 }
mpagenkofc4f56e2020-11-04 17:17:49 +0000625 } else {
626 // no activity within the FSM for OMCI processing, the deviceReason may be updated immediately
mpagenkof1fc3862021-02-16 10:09:52 +0000627 kvStoreWrite = true // ensure actual data write to kvStore immediately (no FSM activity)
mpagenko15ff4a52021-03-02 10:09:20 +0000628 oFsm.mutexFlowParams.RLock()
mpagenkofc4f56e2020-11-04 17:17:49 +0000629 if oFsm.numUniFlows == oFsm.configuredUniFlow {
630 //all requested rules really have been configured
631 // state transition notification is checked in deviceHandler
mpagenko15ff4a52021-03-02 10:09:20 +0000632 oFsm.mutexFlowParams.RUnlock()
mpagenkofc4f56e2020-11-04 17:17:49 +0000633 if oFsm.pDeviceHandler != nil {
634 //also the related TechProfile was already configured
dbainbri4d3a0dc2020-12-02 00:33:42 +0000635 logger.Debugw(ctx, "UniVlanConfigFsm rule already set - send immediate add-success event for reason update", log.Fields{
mpagenkofc4f56e2020-11-04 17:17:49 +0000636 "device-id": oFsm.deviceID})
mpagenkof1fc3862021-02-16 10:09:52 +0000637 // success indication without the need to write to kvStore (done already below with updated data from storePersUniFlowConfig())
638 go oFsm.pDeviceHandler.deviceProcStatusUpdate(ctx, OnuDeviceEvent(oFsm.requestEvent+cDeviceEventOffsetAddNoKvStore))
mpagenkofc4f56e2020-11-04 17:17:49 +0000639 }
640 } else {
641 // avoid device reason update as the rule config connected to this flow may still be in progress
642 // and the device reason should only be updated on success of rule config
dbainbri4d3a0dc2020-12-02 00:33:42 +0000643 logger.Debugw(ctx, "UniVlanConfigFsm rule already set but configuration ongoing, suppress early add-success event for reason update",
mpagenkofc4f56e2020-11-04 17:17:49 +0000644 log.Fields{"device-id": oFsm.deviceID,
645 "NumberofRules": oFsm.numUniFlows, "Configured rules": oFsm.configuredUniFlow})
mpagenko15ff4a52021-03-02 10:09:20 +0000646 oFsm.mutexFlowParams.RUnlock()
mpagenkofc4f56e2020-11-04 17:17:49 +0000647 }
648 }
mpagenko01e726e2020-10-23 09:45:29 +0000649
mpagenkof1fc3862021-02-16 10:09:52 +0000650 if flowCookieModify { // some change was done to the flow entries
mpagenko01e726e2020-10-23 09:45:29 +0000651 //permanently store flow config for reconcile case
mpagenko15ff4a52021-03-02 10:09:20 +0000652 oFsm.mutexFlowParams.RLock()
mpagenkof1fc3862021-02-16 10:09:52 +0000653 if err := oFsm.pDeviceHandler.storePersUniFlowConfig(ctx, oFsm.pOnuUniPort.uniID,
654 &oFsm.uniVlanFlowParamsSlice, kvStoreWrite); err != nil {
mpagenko15ff4a52021-03-02 10:09:20 +0000655 oFsm.mutexFlowParams.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +0000656 logger.Errorw(ctx, err.Error(), log.Fields{"device-id": oFsm.deviceID})
mpagenko01e726e2020-10-23 09:45:29 +0000657 return err
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000658 }
mpagenko15ff4a52021-03-02 10:09:20 +0000659 oFsm.mutexFlowParams.RUnlock()
Holger Hildebrandt394c5522020-09-11 11:23:01 +0000660 }
661 return nil
662}
663
mpagenkof1d21d12021-06-11 13:14:45 +0000664func (oFsm *UniVlanConfigFsm) suspendAddRule(ctx context.Context, apRemoveFlowParams *uniRemoveVlanFlowParams) error {
665 oFsm.mutexFlowParams.Lock()
666 deleteChannel := apRemoveFlowParams.removeChannel
667 apRemoveFlowParams.isSuspendedOnAdd = true
668 oFsm.mutexFlowParams.Unlock()
669
670 // isSuspendedOnAdd is not reset here-after as the assumption is, that after
671 select {
672 case success := <-deleteChannel:
673 //no need to reset isSuspendedOnAdd as in this case the removeElement will be deleted completely
674 if success {
675 logger.Infow(ctx, "resume adding this rule after having completed deletion", log.Fields{
676 "device-id": oFsm.deviceID})
677 return nil
678 }
679 return fmt.Errorf("suspend aborted, also aborting add-activity: %s", oFsm.deviceID)
680 case <-time.After(oFsm.pOmciCC.GetMaxOmciTimeoutWithRetries() * time.Second):
681 oFsm.mutexFlowParams.Lock()
682 if apRemoveFlowParams != nil {
683 apRemoveFlowParams.isSuspendedOnAdd = false
684 }
685 oFsm.mutexFlowParams.Unlock()
mpagenkof582d6a2021-06-18 15:58:10 +0000686 logger.Errorw(ctx, "timeout waiting for deletion of rule, also aborting add-activity", log.Fields{
mpagenkof1d21d12021-06-11 13:14:45 +0000687 "device-id": oFsm.deviceID})
mpagenkof582d6a2021-06-18 15:58:10 +0000688 return fmt.Errorf("suspend aborted on timeout, also aborting add-activity: %s", oFsm.deviceID)
mpagenkof1d21d12021-06-11 13:14:45 +0000689 }
mpagenkof1d21d12021-06-11 13:14:45 +0000690}
691
mpagenkof1fc3862021-02-16 10:09:52 +0000692// VOL-3828 flow config sequence workaround ########### start ##########
693func (oFsm *UniVlanConfigFsm) delayNewRuleForCookie(ctx context.Context, aCookieSlice []uint64) uint64 {
694 //assumes mutexFlowParams.Lock() protection from caller!
695 if oFsm.delayNewRuleCookie == 0 && len(aCookieSlice) == 1 {
696 // if not already waiting, limitation for this workaround is to just have one overlapping cookie/rule
mpagenkof1d21d12021-06-11 13:14:45 +0000697 // suspend check is done only if there is only one cookie in the request
mpagenkof1fc3862021-02-16 10:09:52 +0000698 // background: more elements only expected in reconcile use case, where no conflicting sequence is to be expected
699 newCookie := aCookieSlice[0]
700 for _, storedUniFlowParams := range oFsm.uniVlanFlowParamsSlice {
701 for _, cookie := range storedUniFlowParams.CookieSlice {
702 if cookie == newCookie {
703 logger.Debugw(ctx, "UniVlanConfigFsm flow setting - new cookie still exists for some rule", log.Fields{
704 "device-id": oFsm.deviceID, "cookie": cookie, "exists with SetVlan": storedUniFlowParams.VlanRuleParams.SetVid})
705 oFsm.delayNewRuleCookie = newCookie
706 return newCookie //found new cookie in some existing rule
707 }
708 } // for all stored cookies of the actual inspected rule
709 } //for all rules
710 }
711 return 0 //no delay requested
712}
713func (oFsm *UniVlanConfigFsm) suspendNewRule(ctx context.Context) {
714 oFsm.mutexFlowParams.RLock()
715 logger.Infow(ctx, "Need to suspend adding this rule as long as the cookie is still connected to some other rule", log.Fields{
716 "device-id": oFsm.deviceID, "cookie": oFsm.delayNewRuleCookie})
717 oFsm.mutexFlowParams.RUnlock()
718 select {
719 case <-oFsm.chCookieDeleted:
720 logger.Infow(ctx, "resume adding this rule after having deleted cookie in some other rule", log.Fields{
721 "device-id": oFsm.deviceID, "cookie": oFsm.delayNewRuleCookie})
Holger Hildebrandt366ef192021-05-05 11:07:44 +0000722 case <-time.After(oFsm.pOmciCC.GetMaxOmciTimeoutWithRetries() * time.Second):
mpagenkof1fc3862021-02-16 10:09:52 +0000723 logger.Errorw(ctx, "timeout waiting for deletion of cookie in some other rule, just try to continue", log.Fields{
724 "device-id": oFsm.deviceID, "cookie": oFsm.delayNewRuleCookie})
725 }
726 oFsm.mutexFlowParams.Lock()
727 oFsm.delayNewRuleCookie = 0
728 oFsm.mutexFlowParams.Unlock()
729}
730func (oFsm *UniVlanConfigFsm) suspendIfRequiredNewRule(ctx context.Context, aCookieSlice []uint64) uint64 {
731 oFsm.mutexFlowParams.Lock()
732 delayedCookie := oFsm.delayNewRuleForCookie(ctx, aCookieSlice)
733 oFsm.mutexFlowParams.Unlock()
734
735 if delayedCookie != 0 {
736 oFsm.suspendNewRule(ctx)
737 }
738 return delayedCookie
739}
740
741//returns flowModified, RuleAppendRequest
742func (oFsm *UniVlanConfigFsm) reviseFlowConstellation(ctx context.Context, aCookie uint64, aUniVlanRuleParams uniVlanRuleParams) (bool, bool) {
743 flowEntryMatch := false
744 oFsm.mutexFlowParams.Lock()
745 defer oFsm.mutexFlowParams.Unlock()
746 for flow, storedUniFlowParams := range oFsm.uniVlanFlowParamsSlice {
747 if storedUniFlowParams.VlanRuleParams == aUniVlanRuleParams {
748 flowEntryMatch = true
749 logger.Debugw(ctx, "UniVlanConfigFsm flow revise - rule already exists", log.Fields{
750 "device-id": oFsm.deviceID})
751 cookieMatch := false
752 for _, cookie := range storedUniFlowParams.CookieSlice {
753 if cookie == aCookie {
754 logger.Debugw(ctx, "UniVlanConfigFsm flow revise - and cookie already exists", log.Fields{
755 "device-id": oFsm.deviceID, "cookie": cookie})
756 cookieMatch = true
757 break //found new cookie - no further search for this requested cookie
758 }
759 }
760 if !cookieMatch {
761 logger.Debugw(ctx, "UniVlanConfigFsm flow revise -adding new cookie", log.Fields{
762 "device-id": oFsm.deviceID, "cookie": aCookie})
763 //as range works with copies of the slice we have to write to the original slice!!
764 oFsm.uniVlanFlowParamsSlice[flow].CookieSlice = append(oFsm.uniVlanFlowParamsSlice[flow].CookieSlice,
765 aCookie)
766 return true, false //flowModified, NoRuleAppend
767 }
768 break // found rule - no further rule search
769 }
770 }
771 if !flowEntryMatch { //it is a new rule
772 return true, true //flowModified, RuleAppend
773 }
774 return false, false //flowNotModified, NoRuleAppend
775}
776
777// VOL-3828 flow config sequence workaround ########### end ##########
778
mpagenko01e726e2020-10-23 09:45:29 +0000779//RemoveUniFlowParams verifies on existence of flow cookie,
780// if found removes cookie from flow cookie list and if this is empty
781// initiates removal of the flow related configuration from the ONU (via OMCI)
dbainbri4d3a0dc2020-12-02 00:33:42 +0000782func (oFsm *UniVlanConfigFsm) RemoveUniFlowParams(ctx context.Context, aCookie uint64) error {
mpagenkof1fc3862021-02-16 10:09:52 +0000783 var deletedCookie uint64
mpagenko01e726e2020-10-23 09:45:29 +0000784 flowCookieMatch := false
785 //mutex protection is required for possible concurrent access to FSM members
786 oFsm.mutexFlowParams.Lock()
787 defer oFsm.mutexFlowParams.Unlock()
mpagenkof1fc3862021-02-16 10:09:52 +0000788remove_loop:
mpagenko01e726e2020-10-23 09:45:29 +0000789 for flow, storedUniFlowParams := range oFsm.uniVlanFlowParamsSlice {
790 for i, cookie := range storedUniFlowParams.CookieSlice {
791 if cookie == aCookie {
dbainbri4d3a0dc2020-12-02 00:33:42 +0000792 logger.Debugw(ctx, "UniVlanConfigFsm flow removal - cookie found", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000793 "device-id": oFsm.deviceID, "cookie": cookie})
mpagenkof1fc3862021-02-16 10:09:52 +0000794 deletedCookie = aCookie
mpagenko01e726e2020-10-23 09:45:29 +0000795 //remove the cookie from the cookie slice and verify it is getting empty
796 if len(storedUniFlowParams.CookieSlice) == 1 {
mpagenkof582d6a2021-06-18 15:58:10 +0000797 // had to shift content to function due to sca complexity
798 flowCookieMatch = oFsm.removeRuleComplete(ctx, storedUniFlowParams, aCookie)
mpagenkodee02a62021-07-21 10:56:10 +0000799 //persistencyData write is now part of removeRuleComplete() (on success)
mpagenko01e726e2020-10-23 09:45:29 +0000800 } else {
mpagenkof582d6a2021-06-18 15:58:10 +0000801 flowCookieMatch = true
mpagenko01e726e2020-10-23 09:45:29 +0000802 //cut off the requested cookie by slicing out this element
803 oFsm.uniVlanFlowParamsSlice[flow].CookieSlice = append(
804 oFsm.uniVlanFlowParamsSlice[flow].CookieSlice[:i],
805 oFsm.uniVlanFlowParamsSlice[flow].CookieSlice[i+1:]...)
mpagenkofc4f56e2020-11-04 17:17:49 +0000806 // no activity within the FSM for OMCI processing, the deviceReason may be updated immediately
807 // state transition notification is checked in deviceHandler
808 if oFsm.pDeviceHandler != nil {
mpagenkof1fc3862021-02-16 10:09:52 +0000809 // success indication without the need to write to kvStore (done already below with updated data from storePersUniFlowConfig())
810 go oFsm.pDeviceHandler.deviceProcStatusUpdate(ctx, OnuDeviceEvent(oFsm.requestEvent+cDeviceEventOffsetRemoveNoKvStore))
mpagenkofc4f56e2020-11-04 17:17:49 +0000811 }
dbainbri4d3a0dc2020-12-02 00:33:42 +0000812 logger.Debugw(ctx, "UniVlanConfigFsm flow removal - rule persists with still valid cookies", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000813 "device-id": oFsm.deviceID, "cookies": oFsm.uniVlanFlowParamsSlice[flow].CookieSlice})
mpagenkof1fc3862021-02-16 10:09:52 +0000814 if deletedCookie == oFsm.delayNewRuleCookie {
815 //the delayedNewCookie is the one that is currently deleted, but the rule still exist with other cookies
816 //as long as there are further cookies for this rule indicate there is still some cookie to be deleted
817 //simply use the first one
818 oFsm.delayNewRuleCookie = oFsm.uniVlanFlowParamsSlice[flow].CookieSlice[0]
819 logger.Debugw(ctx, "UniVlanConfigFsm remaining cookie awaited for deletion before new rule add", log.Fields{
820 "device-id": oFsm.deviceID, "cookie": oFsm.delayNewRuleCookie})
821 }
mpagenkodee02a62021-07-21 10:56:10 +0000822 //permanently store the modified flow config for reconcile case and immediately write to KvStore
823 if oFsm.pDeviceHandler != nil {
824 if err := oFsm.pDeviceHandler.storePersUniFlowConfig(ctx, oFsm.pOnuUniPort.uniID,
825 &oFsm.uniVlanFlowParamsSlice, true); err != nil {
826 logger.Errorw(ctx, err.Error(), log.Fields{"device-id": oFsm.deviceID})
827 return err
828 }
mpagenkofc4f56e2020-11-04 17:17:49 +0000829 }
mpagenko01e726e2020-10-23 09:45:29 +0000830 }
mpagenkof1fc3862021-02-16 10:09:52 +0000831 break remove_loop //found the cookie - no further search for this requested cookie
mpagenko01e726e2020-10-23 09:45:29 +0000832 }
833 }
mpagenko01e726e2020-10-23 09:45:29 +0000834 } //search all flows
835 if !flowCookieMatch { //some cookie remove-request for a cookie that does not exist in the FSM data
dbainbri4d3a0dc2020-12-02 00:33:42 +0000836 logger.Warnw(ctx, "UniVlanConfigFsm flow removal - remove-cookie not found", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +0000837 "device-id": oFsm.deviceID, "remove-cookie": aCookie})
838 // but accept the request with success as no such cookie (flow) does exist
mpagenkofc4f56e2020-11-04 17:17:49 +0000839 // no activity within the FSM for OMCI processing, the deviceReason may be updated immediately
840 // state transition notification is checked in deviceHandler
841 if oFsm.pDeviceHandler != nil {
mpagenkof1fc3862021-02-16 10:09:52 +0000842 // success indication without the need to write to kvStore (no change)
843 go oFsm.pDeviceHandler.deviceProcStatusUpdate(ctx, OnuDeviceEvent(oFsm.requestEvent+cDeviceEventOffsetRemoveNoKvStore))
mpagenkofc4f56e2020-11-04 17:17:49 +0000844 }
mpagenko01e726e2020-10-23 09:45:29 +0000845 return nil
846 } //unknown cookie
847
848 return nil
849}
850
mpagenkof582d6a2021-06-18 15:58:10 +0000851// removeRuleComplete initiates the complete removal of a VLAN rule (from single cookie element)
mpagenkodee02a62021-07-21 10:56:10 +0000852// requires mutexFlowParams to be locked at call
mpagenkof582d6a2021-06-18 15:58:10 +0000853func (oFsm *UniVlanConfigFsm) removeRuleComplete(ctx context.Context,
854 aUniFlowParams uniVlanFlowParams, aCookie uint64) bool {
855 pConfigVlanStateBaseFsm := oFsm.pAdaptFsm.pFsm
856 var cancelPendingConfig bool = false
857 var loRemoveParams uniRemoveVlanFlowParams = uniRemoveVlanFlowParams{}
858 logger.Debugw(ctx, "UniVlanConfigFsm flow removal - full flow removal", log.Fields{
859 "device-id": oFsm.deviceID})
860 //rwCore flow recovery may be the reason for this delete, in which case the flowToBeDeleted may be the same
861 // as the one still waiting in the FSM as toAdd but waiting for TechProfileConfig
862 // so we have to check if we have to abort the outstanding AddRequest and regard the current DelRequest as done
863 // if the Fsm is in some other transient (config) state, we will reach the DelRequest later and correctly process it then
864 if pConfigVlanStateBaseFsm.Is(vlanStWaitingTechProf) {
865 logger.Debugw(ctx, "UniVlanConfigFsm was waiting for TechProf config with add-request, just aborting the outstanding add",
866 log.Fields{"device-id": oFsm.deviceID})
867 cancelPendingConfig = true
868 } else {
869 //create a new element for the removeVlanFlow slice
870 loRemoveParams = uniRemoveVlanFlowParams{
871 vlanRuleParams: aUniFlowParams.VlanRuleParams,
872 cookie: aCookie,
873 }
874 loRemoveParams.removeChannel = make(chan bool)
875 oFsm.uniRemoveFlowsSlice = append(oFsm.uniRemoveFlowsSlice, loRemoveParams)
876 }
877
878 usedTpID := aUniFlowParams.VlanRuleParams.TpID
879 if len(oFsm.uniVlanFlowParamsSlice) <= 1 {
880 //at this point it is evident that no flow anymore will refer to a still possibly active Techprofile
881 //request that this profile gets deleted before a new flow add is allowed (except for some aborted add)
882 if !cancelPendingConfig {
883 logger.Debugw(ctx, "UniVlanConfigFsm flow removal requested - set TechProfile to-delete", log.Fields{
884 "device-id": oFsm.deviceID})
885 if oFsm.pUniTechProf != nil {
886 oFsm.pUniTechProf.setProfileToDelete(oFsm.pOnuUniPort.uniID, usedTpID, true)
887 }
888 }
889 } else {
890 if !cancelPendingConfig {
891 oFsm.updateTechProfileToDelete(ctx, usedTpID)
892 }
893 }
894 //trigger the FSM to remove the relevant rule
895 if cancelPendingConfig {
896 //as the uniFlow parameters are already stored (for add) but no explicit removal is done anymore
897 // the paramSlice has to be updated with rule-removal, which also then updates numUniFlows
898 //call from 'non-configured' state of the rules
899 if err := oFsm.removeFlowFromParamsSlice(ctx, aCookie, false); err != nil {
900 //something quite inconsistent detected, perhaps just try to recover with FSM reset
901 oFsm.mutexFlowParams.Unlock()
902 if fsmErr := pConfigVlanStateBaseFsm.Event(vlanEvReset); fsmErr != nil {
903 logger.Errorw(ctx, "error in FsmEvent handling UniVlanConfigFsm!",
904 log.Fields{"fsmState": pConfigVlanStateBaseFsm.Current(), "error": fsmErr, "device-id": oFsm.deviceID})
905 }
906 return false //data base update could not be done, return like cookie not found
907 }
908
909 oFsm.requestEventOffset = uint8(cDeviceEventOffsetRemoveWithKvStore) //offset for last flow-remove activity (with kvStore request)
910 //attention: take care to release and re-take the mutexFlowParams when calling the FSM directly -
911 // synchronous FSM 'event/state' functions may rely on this mutex
912 oFsm.mutexFlowParams.Unlock()
913 if fsmErr := pConfigVlanStateBaseFsm.Event(vlanEvCancelOutstandingConfig); fsmErr != nil {
914 logger.Errorw(ctx, "error in FsmEvent handling UniVlanConfigFsm!",
915 log.Fields{"fsmState": pConfigVlanStateBaseFsm.Current(), "error": fsmErr, "device-id": oFsm.deviceID})
916 }
917 oFsm.mutexFlowParams.Lock()
918 return true
919 }
920 if pConfigVlanStateBaseFsm.Is(vlanStConfigDone) {
921 logger.Debugw(ctx, "UniVlanConfigFsm rule removal request", log.Fields{
922 "device-id": oFsm.deviceID, "uni-id": oFsm.pOnuUniPort.uniID,
923 "tp-id": loRemoveParams.vlanRuleParams.TpID,
924 "set-Vlan": loRemoveParams.vlanRuleParams.SetVid})
925 //have to re-trigger the FSM to proceed with outstanding incremental flow configuration
926 //attention: take care to release and re-take the mutexFlowParams when calling the FSM directly -
927 // synchronous FSM 'event/state' functions may rely on this mutex
928 oFsm.mutexFlowParams.Unlock()
929 if fsmErr := pConfigVlanStateBaseFsm.Event(vlanEvRemFlowConfig); fsmErr != nil {
930 logger.Errorw(ctx, "error in FsmEvent handling UniVlanConfigFsm!",
931 log.Fields{"fsmState": pConfigVlanStateBaseFsm.Current(), "error": fsmErr, "device-id": oFsm.deviceID})
932 }
933 oFsm.mutexFlowParams.Lock()
934 } // if not in the appropriate state a new entry will be automatically considered later
935 // when the configDone state is reached
936 return true
937}
938
mpagenkof1d21d12021-06-11 13:14:45 +0000939//removeFlowFromParamsSlice removes a flow from stored uniVlanFlowParamsSlice based on the cookie
940// it assumes that adding cookies for this flow (including the actual one to delete) was prevented
941// from the start of the deletion request to avoid to much interference
942// so when called, there can only be one cookie active for this flow
943// requires mutexFlowParams to be locked at call
mpagenkof582d6a2021-06-18 15:58:10 +0000944func (oFsm *UniVlanConfigFsm) removeFlowFromParamsSlice(ctx context.Context, aCookie uint64, aWasConfigured bool) error {
mpagenkof1d21d12021-06-11 13:14:45 +0000945 logger.Debugw(ctx, "UniVlanConfigFsm flow removal from ParamsSlice", log.Fields{
946 "device-id": oFsm.deviceID, "cookie": aCookie})
mpagenkof582d6a2021-06-18 15:58:10 +0000947 cookieFound := false
mpagenkof1d21d12021-06-11 13:14:45 +0000948removeFromSlice_loop:
949 for flow, storedUniFlowParams := range oFsm.uniVlanFlowParamsSlice {
mpagenkof582d6a2021-06-18 15:58:10 +0000950 // if UniFlowParams exists, cookieSlice should always have at least one element
951 cookieSliceLen := len(storedUniFlowParams.CookieSlice)
952 if cookieSliceLen == 1 {
953 if storedUniFlowParams.CookieSlice[0] == aCookie {
954 cookieFound = true
mpagenkof1d21d12021-06-11 13:14:45 +0000955 }
mpagenkof582d6a2021-06-18 15:58:10 +0000956 } else if cookieSliceLen == 0 {
957 errStr := "UniVlanConfigFsm unexpected cookie slice length 0 - removal in uniVlanFlowParamsSlice aborted"
958 logger.Errorw(ctx, errStr, log.Fields{"device-id": oFsm.deviceID})
959 return errors.New(errStr)
960 } else {
961 errStr := "UniVlanConfigFsm flow removal unexpected cookie slice length, but rule removal continued"
962 logger.Errorw(ctx, errStr, log.Fields{
963 "cookieSliceLen": len(oFsm.uniVlanFlowParamsSlice), "device-id": oFsm.deviceID})
964 for _, cookie := range storedUniFlowParams.CookieSlice {
965 if cookie == aCookie {
966 cookieFound = true
967 break
968 }
969 }
970 }
971 if cookieFound {
mpagenkof1d21d12021-06-11 13:14:45 +0000972 logger.Debugw(ctx, "UniVlanConfigFsm flow removal from ParamsSlice - cookie found", log.Fields{
973 "device-id": oFsm.deviceID, "cookie": aCookie})
974 //remove the actual element from the addVlanFlow slice
975 // oFsm.uniVlanFlowParamsSlice[flow].CookieSlice = nil //automatically done by garbage collector
976 if len(oFsm.uniVlanFlowParamsSlice) <= 1 {
977 oFsm.numUniFlows = 0 //no more flows
978 oFsm.configuredUniFlow = 0 //no more flows configured
979 oFsm.uniVlanFlowParamsSlice = nil //reset the slice
980 //at this point it is evident that no flow anymore refers to a still possibly active Techprofile
981 //request that this profile gets deleted before a new flow add is allowed
982 logger.Debugw(ctx, "UniVlanConfigFsm flow removal from ParamsSlice - no more flows", log.Fields{
983 "device-id": oFsm.deviceID})
984 } else {
985 oFsm.numUniFlows--
986 if aWasConfigured && oFsm.configuredUniFlow > 0 {
987 oFsm.configuredUniFlow--
988 }
989 //cut off the requested flow by slicing out this element
990 oFsm.uniVlanFlowParamsSlice = append(
991 oFsm.uniVlanFlowParamsSlice[:flow], oFsm.uniVlanFlowParamsSlice[flow+1:]...)
992 logger.Debugw(ctx, "UniVlanConfigFsm flow removal - specific flow removed from data", log.Fields{
993 "device-id": oFsm.deviceID})
994 }
995 break removeFromSlice_loop //found the cookie - no further search for this requested cookie
996 }
997 } //search all flows
mpagenkof582d6a2021-06-18 15:58:10 +0000998 if !cookieFound {
999 errStr := "UniVlanConfigFsm cookie for removal not found, internal counter not updated"
1000 logger.Errorw(ctx, errStr, log.Fields{"device-id": oFsm.deviceID})
1001 return errors.New(errStr)
1002 }
mpagenkodee02a62021-07-21 10:56:10 +00001003 //if the cookie was found and removed from uniVlanFlowParamsSlice above now write the modified persistency data
1004 // KVStore update will be done after reaching the requested FSM end state (not immediately here)
1005 if err := oFsm.pDeviceHandler.storePersUniFlowConfig(ctx, oFsm.pOnuUniPort.uniID,
1006 &oFsm.uniVlanFlowParamsSlice, false); err != nil {
1007 logger.Errorw(ctx, err.Error(), log.Fields{"device-id": oFsm.deviceID})
1008 return err
1009 }
mpagenkof582d6a2021-06-18 15:58:10 +00001010 return nil
mpagenkof1d21d12021-06-11 13:14:45 +00001011}
1012
1013// requires mutexFlowParams to be locked at call
mpagenkof1fc3862021-02-16 10:09:52 +00001014func (oFsm *UniVlanConfigFsm) updateTechProfileToDelete(ctx context.Context, usedTpID uint8) {
1015 //here we have to check, if there are still other flows referencing to the actual ProfileId
1016 // before we can request that this profile gets deleted before a new flow add is allowed
1017 tpIDInOtherFlows := false
1018 for _, tpUniFlowParams := range oFsm.uniVlanFlowParamsSlice {
1019 if tpUniFlowParams.VlanRuleParams.TpID == usedTpID {
1020 tpIDInOtherFlows = true
1021 break // search loop can be left
1022 }
1023 }
1024 if tpIDInOtherFlows {
1025 logger.Debugw(ctx, "UniVlanConfigFsm tp-id used in deleted flow is still used in other flows", log.Fields{
1026 "device-id": oFsm.deviceID, "tp-id": usedTpID})
1027 } else {
mpagenkof1d21d12021-06-11 13:14:45 +00001028 logger.Debugw(ctx, "UniVlanConfigFsm tp-id used in deleted flow is not used anymore - set TechProfile to-delete", log.Fields{
mpagenkof1fc3862021-02-16 10:09:52 +00001029 "device-id": oFsm.deviceID, "tp-id": usedTpID})
mpagenkof1d21d12021-06-11 13:14:45 +00001030 if oFsm.pUniTechProf != nil {
1031 //request that this profile gets deleted before a new flow add is allowed
1032 oFsm.pUniTechProf.setProfileToDelete(oFsm.pOnuUniPort.uniID, usedTpID, true)
1033 }
mpagenkof1fc3862021-02-16 10:09:52 +00001034 }
1035}
1036
mpagenkof1d21d12021-06-11 13:14:45 +00001037func (oFsm *UniVlanConfigFsm) enterPreparing(ctx context.Context, e *fsm.Event) {
1038 logger.Debugw(ctx, "UniVlanConfigFsm preparing", log.Fields{"device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001039
1040 // this FSM is not intended for re-start, needs always new creation for a new run
mpagenko01e726e2020-10-23 09:45:29 +00001041 // (self-destroying - compare enterDisabled())
mpagenkodff5dda2020-08-28 11:52:01 +00001042 oFsm.omciMIdsResponseReceived = make(chan bool)
mpagenkof1fc3862021-02-16 10:09:52 +00001043 oFsm.chCookieDeleted = make(chan bool)
mpagenkodff5dda2020-08-28 11:52:01 +00001044 // start go routine for processing of LockState messages
dbainbri4d3a0dc2020-12-02 00:33:42 +00001045 go oFsm.processOmciVlanMessages(ctx)
mpagenkodff5dda2020-08-28 11:52:01 +00001046 //let the state machine run forward from here directly
1047 pConfigVlanStateAFsm := oFsm.pAdaptFsm
1048 if pConfigVlanStateAFsm != nil {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001049 if oFsm.pDeviceHandler.isSkipOnuConfigReconciling() {
1050 logger.Debugw(ctx, "reconciling - skip omci-config of vlan rule",
1051 log.Fields{"fsmState": oFsm.pAdaptFsm.pFsm.Current(), "device-id": oFsm.deviceID})
mpagenkof1d21d12021-06-11 13:14:45 +00001052 // Can't call FSM Event directly, decoupling it
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001053 go func(a_pAFsm *AdapterFsm) {
1054 _ = a_pAFsm.pFsm.Event(vlanEvSkipOmciConfig)
1055 }(pConfigVlanStateAFsm)
1056 return
1057 }
mpagenkof1d21d12021-06-11 13:14:45 +00001058 // Can't call FSM Event directly, decoupling it
1059 go func(a_pAFsm *AdapterFsm) {
1060 _ = a_pAFsm.pFsm.Event(vlanEvPrepareDone)
1061 }(pConfigVlanStateAFsm)
1062 return
1063 }
1064 logger.Errorw(ctx, "UniVlanConfigFsm abort: invalid FSM pointer", log.Fields{
1065 "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
1066 //should never happen, else: recovery would be needed from outside the FSM
1067}
1068
1069func (oFsm *UniVlanConfigFsm) enterConfigStarting(ctx context.Context, e *fsm.Event) {
1070 logger.Debugw(ctx, "UniVlanConfigFsm start vlan configuration", log.Fields{"device-id": oFsm.deviceID})
1071 pConfigVlanStateAFsm := oFsm.pAdaptFsm
1072 if pConfigVlanStateAFsm != nil {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001073 oFsm.mutexFlowParams.Lock()
mpagenko9a304ea2020-12-16 15:54:01 +00001074 //possibly the entry is not valid anymore based on intermediate delete requests
1075 //just a basic protection ...
1076 if len(oFsm.uniVlanFlowParamsSlice) == 0 {
1077 oFsm.mutexFlowParams.Unlock()
1078 logger.Debugw(ctx, "UniVlanConfigFsm start: no rule entry anymore available", log.Fields{
1079 "device-id": oFsm.deviceID})
1080 // Can't call FSM Event directly, decoupling it
1081 go func(a_pAFsm *AdapterFsm) {
1082 _ = a_pAFsm.pFsm.Event(vlanEvReset)
1083 }(pConfigVlanStateAFsm)
1084 return
1085 }
mpagenko9a304ea2020-12-16 15:54:01 +00001086 //access to uniVlanFlowParamsSlice is done on first element only here per definition
1087 //store the actual rule that shall be worked upon in the following transient states
1088 oFsm.actualUniVlanConfigRule = oFsm.uniVlanFlowParamsSlice[0].VlanRuleParams
ozgecanetsia82b91a62021-05-21 18:54:49 +03001089 oFsm.actualUniVlanConfigMeter = oFsm.uniVlanFlowParamsSlice[0].Meter
mpagenko9a304ea2020-12-16 15:54:01 +00001090 tpID := oFsm.actualUniVlanConfigRule.TpID
1091 oFsm.TpIDWaitingFor = tpID
Girish Gowdra24dd1132021-07-06 15:25:40 -07001092 //cmp also usage in EVTOCDE create in omci_cc
1093 oFsm.evtocdID = macBridgeServiceProfileEID + uint16(oFsm.pOnuUniPort.macBpNo)
1094 oFsm.mutexFlowParams.Unlock()
1095
mpagenko551a4d42020-12-08 18:09:20 +00001096 loTechProfDone := oFsm.pUniTechProf.getTechProfileDone(ctx, oFsm.pOnuUniPort.uniID, uint8(tpID))
mpagenko9a304ea2020-12-16 15:54:01 +00001097 logger.Debugw(ctx, "UniVlanConfigFsm - start with first rule", log.Fields{
1098 "device-id": oFsm.deviceID, "uni-id": oFsm.pOnuUniPort.uniID,
1099 "set-Vlan": oFsm.actualUniVlanConfigRule.SetVid, "tp-id": tpID, "ProfDone": loTechProfDone})
Girish Gowdra24dd1132021-07-06 15:25:40 -07001100
mpagenko9a304ea2020-12-16 15:54:01 +00001101 // Can't call FSM Event directly, decoupling it
mpagenko551a4d42020-12-08 18:09:20 +00001102 go func(aPAFsm *AdapterFsm, aTechProfDone bool) {
1103 if aPAFsm != nil && aPAFsm.pFsm != nil {
1104 if aTechProfDone {
mpagenkodff5dda2020-08-28 11:52:01 +00001105 // let the vlan processing begin
mpagenko551a4d42020-12-08 18:09:20 +00001106 _ = aPAFsm.pFsm.Event(vlanEvStartConfig)
mpagenkodff5dda2020-08-28 11:52:01 +00001107 } else {
1108 // set to waiting for Techprofile
mpagenko551a4d42020-12-08 18:09:20 +00001109 _ = aPAFsm.pFsm.Event(vlanEvWaitTechProf)
mpagenkodff5dda2020-08-28 11:52:01 +00001110 }
1111 }
mpagenko551a4d42020-12-08 18:09:20 +00001112 }(pConfigVlanStateAFsm, loTechProfDone)
1113 } else {
1114 logger.Errorw(ctx, "UniVlanConfigFsm abort: invalid FSM pointer", log.Fields{
1115 "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
1116 //should never happen, else: recovery would be needed from outside the FSM
1117 return
mpagenkodff5dda2020-08-28 11:52:01 +00001118 }
1119}
1120
dbainbri4d3a0dc2020-12-02 00:33:42 +00001121func (oFsm *UniVlanConfigFsm) enterConfigVtfd(ctx context.Context, e *fsm.Event) {
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001122 //mutex protection is required for possible concurrent access to FSM members
1123 oFsm.mutexFlowParams.Lock()
mpagenko551a4d42020-12-08 18:09:20 +00001124 oFsm.TpIDWaitingFor = 0 //reset indication to avoid misinterpretation
mpagenko9a304ea2020-12-16 15:54:01 +00001125 if oFsm.actualUniVlanConfigRule.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
mpagenkodff5dda2020-08-28 11:52:01 +00001126 // meaning transparent setup - no specific VTFD setting required
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001127 oFsm.mutexFlowParams.Unlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001128 logger.Debugw(ctx, "UniVlanConfigFsm: no VTFD config required", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00001129 "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001130 // let the FSM proceed ... (from within this state all internal pointers may be expected to be correct)
mpagenkodff5dda2020-08-28 11:52:01 +00001131 pConfigVlanStateAFsm := oFsm.pAdaptFsm
mpagenko9a304ea2020-12-16 15:54:01 +00001132 // Can't call FSM Event directly, decoupling it
mpagenkodff5dda2020-08-28 11:52:01 +00001133 go func(a_pAFsm *AdapterFsm) {
Himani Chawla4d908332020-08-31 12:30:20 +05301134 _ = a_pAFsm.pFsm.Event(vlanEvRxConfigVtfd)
mpagenkodff5dda2020-08-28 11:52:01 +00001135 }(pConfigVlanStateAFsm)
1136 } else {
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001137 // This attribute uniquely identifies each instance of this managed entity. Through an identical ID,
1138 // this managed entity is implicitly linked to an instance of the MAC bridge port configuration data ME.
Mahir Gunyel6781f962021-05-16 23:30:08 -07001139 vtfdID, _ := generateANISideMBPCDEID(uint16(oFsm.pOnuUniPort.macBpNo), uint16(oFsm.actualUniVlanConfigRule.TpID))
dbainbri4d3a0dc2020-12-02 00:33:42 +00001140 logger.Debugw(ctx, "UniVlanConfigFsm create VTFD", log.Fields{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001141 "EntitytId": strconv.FormatInt(int64(vtfdID), 16),
Mahir Gunyel6781f962021-05-16 23:30:08 -07001142 "in state": e.FSM.Current(), "device-id": oFsm.deviceID,
1143 "macBpNo": oFsm.pOnuUniPort.macBpNo, "TpID": oFsm.actualUniVlanConfigRule.TpID})
mpagenko01e726e2020-10-23 09:45:29 +00001144 // setVid is assumed to be masked already by the caller to 12 bit
mpagenko9a304ea2020-12-16 15:54:01 +00001145 oFsm.vlanFilterList[0] = uint16(oFsm.actualUniVlanConfigRule.SetVid)
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001146 oFsm.mutexFlowParams.Unlock()
mpagenko01e726e2020-10-23 09:45:29 +00001147 vtfdFilterList := make([]uint16, cVtfdTableSize) //needed for parameter serialization
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001148 vtfdFilterList[0] = oFsm.vlanFilterList[0]
1149 oFsm.numVlanFilterEntries = 1
mpagenkodff5dda2020-08-28 11:52:01 +00001150 meParams := me.ParamData{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001151 EntityID: vtfdID,
mpagenkodff5dda2020-08-28 11:52:01 +00001152 Attributes: me.AttributeValueMap{
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001153 "VlanFilterList": vtfdFilterList, //omci lib wants a slice for serialization
1154 "ForwardOperation": uint8(0x10), //VID investigation
1155 "NumberOfEntries": oFsm.numVlanFilterEntries,
mpagenkodff5dda2020-08-28 11:52:01 +00001156 },
1157 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001158 logger.Debugw(ctx, "UniVlanConfigFsm sendcreate VTFD", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00001159 "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001160 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03001161 meInstance, err := oFsm.pOmciCC.sendCreateVtfdVar(log.WithSpanFromContext(context.TODO(), ctx), oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
mpagenkodff5dda2020-08-28 11:52:01 +00001162 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03001163 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001164 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03001165 logger.Errorw(ctx, "VTFD create failed, aborting UniVlanConfig FSM!",
1166 log.Fields{"device-id": oFsm.deviceID})
1167 pConfigVlanStateAFsm := oFsm.pAdaptFsm
1168 if pConfigVlanStateAFsm != nil {
1169 go func(a_pAFsm *AdapterFsm) {
1170 _ = a_pAFsm.pFsm.Event(vlanEvReset)
1171 }(pConfigVlanStateAFsm)
1172 }
1173 return
1174 }
mpagenkodff5dda2020-08-28 11:52:01 +00001175 //accept also nil as (error) return value for writing to LastTx
1176 // - this avoids misinterpretation of new received OMCI messages
1177 //TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
1178 // send shall return (dual format) error code that can be used here for immediate error treatment
1179 // (relevant to all used sendXX() methods in this (and other) FSM's)
mpagenko01e726e2020-10-23 09:45:29 +00001180 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001181 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkodff5dda2020-08-28 11:52:01 +00001182 }
1183}
1184
dbainbri4d3a0dc2020-12-02 00:33:42 +00001185func (oFsm *UniVlanConfigFsm) enterConfigEvtocd(ctx context.Context, e *fsm.Event) {
1186 logger.Debugw(ctx, "UniVlanConfigFsm - start config EVTOCD loop", log.Fields{
mpagenkof1d21d12021-06-11 13:14:45 +00001187 "device-id": oFsm.deviceID})
mpagenkof1fc3862021-02-16 10:09:52 +00001188 oFsm.requestEventOffset = uint8(cDeviceEventOffsetAddWithKvStore) //0 offset for last flow-add activity
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001189 go func() {
mpagenko9a304ea2020-12-16 15:54:01 +00001190 //using the first element in the slice because it's the first flow per definition here
1191 errEvto := oFsm.performConfigEvtocdEntries(ctx, 0)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001192 //This is correct passing scenario
1193 if errEvto == nil {
mpagenkof1d21d12021-06-11 13:14:45 +00001194 oFsm.mutexFlowParams.RLock()
mpagenko9a304ea2020-12-16 15:54:01 +00001195 tpID := oFsm.actualUniVlanConfigRule.TpID
1196 vlanID := oFsm.actualUniVlanConfigRule.SetVid
dbainbri4d3a0dc2020-12-02 00:33:42 +00001197 for _, gemPort := range oFsm.pUniTechProf.getMulticastGemPorts(ctx, oFsm.pOnuUniPort.uniID, uint8(tpID)) {
1198 logger.Infow(ctx, "Setting multicast MEs, with first flow", log.Fields{"deviceID": oFsm.deviceID,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001199 "techProfile": tpID, "gemPort": gemPort, "vlanID": vlanID, "configuredUniFlow": oFsm.configuredUniFlow})
mpagenkof1d21d12021-06-11 13:14:45 +00001200 oFsm.mutexFlowParams.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001201 errCreateAllMulticastME := oFsm.performSettingMulticastME(ctx, tpID, gemPort,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001202 vlanID)
1203 if errCreateAllMulticastME != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001204 logger.Errorw(ctx, "Multicast ME create failed, aborting AniConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001205 log.Fields{"device-id": oFsm.deviceID})
1206 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
1207 }
mpagenkof1d21d12021-06-11 13:14:45 +00001208 oFsm.mutexFlowParams.RLock()
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001209 }
mpagenkof1d21d12021-06-11 13:14:45 +00001210 oFsm.mutexFlowParams.RUnlock()
ozgecanetsia82b91a62021-05-21 18:54:49 +03001211 //If this first flow contains a meter, then create TD for related gems.
1212 if oFsm.actualUniVlanConfigMeter != nil {
1213 logger.Debugw(ctx, "Creating Traffic Descriptor", log.Fields{"device-id": oFsm.deviceID, "meter": oFsm.actualUniVlanConfigMeter})
1214 for _, gemPort := range oFsm.pUniTechProf.getBidirectionalGemPortIDsForTP(ctx, oFsm.pOnuUniPort.uniID, tpID) {
1215 logger.Debugw(ctx, "Creating Traffic Descriptor for gem", log.Fields{"device-id": oFsm.deviceID, "meter": oFsm.actualUniVlanConfigMeter, "gem": gemPort})
1216 errCreateTrafficDescriptor := oFsm.createTrafficDescriptor(ctx, oFsm.actualUniVlanConfigMeter, tpID,
1217 oFsm.pOnuUniPort.uniID, gemPort)
1218 if errCreateTrafficDescriptor != nil {
1219 logger.Errorw(ctx, "Create Traffic Descriptor create failed, aborting Ani Config FSM!",
1220 log.Fields{"device-id": oFsm.deviceID})
1221 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
1222 }
1223 }
1224 }
1225
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001226 //TODO Possibly insert new state for multicast --> possibly another jira/later time.
1227 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvRxConfigEvtocd)
1228 }
1229 }()
mpagenkodff5dda2020-08-28 11:52:01 +00001230}
1231
dbainbri4d3a0dc2020-12-02 00:33:42 +00001232func (oFsm *UniVlanConfigFsm) enterVlanConfigDone(ctx context.Context, e *fsm.Event) {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001233
mpagenkof1d21d12021-06-11 13:14:45 +00001234 oFsm.mutexFlowParams.Lock()
mpagenko9a304ea2020-12-16 15:54:01 +00001235
mpagenkof1fc3862021-02-16 10:09:52 +00001236 logger.Infow(ctx, "UniVlanConfigFsm config done - checking on more flows", log.Fields{
mpagenkof1d21d12021-06-11 13:14:45 +00001237 "device-id": oFsm.deviceID,
mpagenko551a4d42020-12-08 18:09:20 +00001238 "overall-uni-rules": oFsm.numUniFlows, "configured-uni-rules": oFsm.configuredUniFlow})
1239 pConfigVlanStateAFsm := oFsm.pAdaptFsm
1240 if pConfigVlanStateAFsm == nil {
mpagenkof1d21d12021-06-11 13:14:45 +00001241 oFsm.mutexFlowParams.Unlock()
mpagenko551a4d42020-12-08 18:09:20 +00001242 logger.Errorw(ctx, "UniVlanConfigFsm abort: invalid FSM pointer", log.Fields{
1243 "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
1244 //should never happen, else: recovery would be needed from outside the FSM
1245 return
1246 }
1247 pConfigVlanStateBaseFsm := pConfigVlanStateAFsm.pFsm
mpagenko01e726e2020-10-23 09:45:29 +00001248 if len(oFsm.uniRemoveFlowsSlice) > 0 {
1249 //some further flows are to be removed, removal always starts with the first element
mpagenko9a304ea2020-12-16 15:54:01 +00001250 logger.Debugw(ctx, "UniVlanConfigFsm rule removal from ConfigDone", log.Fields{
1251 "device-id": oFsm.deviceID, "uni-id": oFsm.pOnuUniPort.uniID,
1252 "tp-id": oFsm.uniRemoveFlowsSlice[0].vlanRuleParams.TpID,
1253 "set-Vlan": oFsm.uniRemoveFlowsSlice[0].vlanRuleParams.SetVid})
mpagenkof1d21d12021-06-11 13:14:45 +00001254 oFsm.mutexFlowParams.Unlock()
mpagenko9a304ea2020-12-16 15:54:01 +00001255 // Can't call FSM Event directly, decoupling it
mpagenko01e726e2020-10-23 09:45:29 +00001256 go func(a_pBaseFsm *fsm.FSM) {
1257 _ = a_pBaseFsm.Event(vlanEvRemFlowConfig)
1258 }(pConfigVlanStateBaseFsm)
1259 return
1260 }
Holger Hildebrandt1b8f4ad2021-03-25 15:53:51 +00001261 if oFsm.pDeviceHandler.isSkipOnuConfigReconciling() {
1262 oFsm.configuredUniFlow = oFsm.numUniFlows
Andrea Campanellaf66ac6e2021-05-24 17:09:20 +02001263 if oFsm.lastFlowToReconcile {
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00001264 logger.Debugw(ctx, "reconciling - flow processing finished", log.Fields{"device-id": oFsm.deviceID})
Andrea Campanellaf66ac6e2021-05-24 17:09:20 +02001265 oFsm.pDeviceHandler.setReconcilingFlows(false)
Holger Hildebrandtb4563ab2021-04-14 10:27:20 +00001266 oFsm.pDeviceHandler.chReconcilingFlowsFinished <- true
1267 }
Holger Hildebrandt1b8f4ad2021-03-25 15:53:51 +00001268 logger.Debugw(ctx, "reconciling - skip enterVlanConfigDone processing",
1269 log.Fields{"numUniFlows": oFsm.numUniFlows, "configuredUniFlow": oFsm.configuredUniFlow, "device-id": oFsm.deviceID})
mpagenkof1d21d12021-06-11 13:14:45 +00001270 oFsm.mutexFlowParams.Unlock()
Holger Hildebrandt1b8f4ad2021-03-25 15:53:51 +00001271 return
1272 }
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001273 if oFsm.numUniFlows > oFsm.configuredUniFlow {
mpagenko551a4d42020-12-08 18:09:20 +00001274 if oFsm.configuredUniFlow == 0 {
mpagenkof1d21d12021-06-11 13:14:45 +00001275 oFsm.mutexFlowParams.Unlock()
mpagenko551a4d42020-12-08 18:09:20 +00001276 // this is a restart with a complete new flow, we can re-use the initial flow config control
1277 // including the check, if the related techProfile is (still) available (probably also removed in between)
mpagenko9a304ea2020-12-16 15:54:01 +00001278 // Can't call FSM Event directly, decoupling it
mpagenko551a4d42020-12-08 18:09:20 +00001279 go func(a_pBaseFsm *fsm.FSM) {
1280 _ = a_pBaseFsm.Event(vlanEvRenew)
1281 }(pConfigVlanStateBaseFsm)
1282 return
1283 }
1284
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001285 //some further flows are to be configured
mpagenko9a304ea2020-12-16 15:54:01 +00001286 //store the actual rule that shall be worked upon in the following transient states
mpagenkof1d21d12021-06-11 13:14:45 +00001287 if len(oFsm.uniVlanFlowParamsSlice) < int(oFsm.configuredUniFlow) {
1288 //check introduced after having observed some panic in this processing
1289 logger.Errorw(ctx, "error in FsmEvent handling UniVlanConfigFsm in ConfigDone - inconsistent counter",
1290 log.Fields{"configuredUniFlow": oFsm.configuredUniFlow,
1291 "sliceLen": len(oFsm.uniVlanFlowParamsSlice), "device-id": oFsm.deviceID})
1292 oFsm.mutexFlowParams.Unlock()
1293 go func(a_pAFsm *AdapterFsm) {
1294 _ = a_pAFsm.pFsm.Event(vlanEvReset)
1295 }(pConfigVlanStateAFsm)
1296 return
1297 }
mpagenko9a304ea2020-12-16 15:54:01 +00001298 oFsm.actualUniVlanConfigRule = oFsm.uniVlanFlowParamsSlice[oFsm.configuredUniFlow].VlanRuleParams
ozgecanetsia82b91a62021-05-21 18:54:49 +03001299 oFsm.actualUniVlanConfigMeter = oFsm.uniVlanFlowParamsSlice[oFsm.configuredUniFlow].Meter
mpagenko551a4d42020-12-08 18:09:20 +00001300 //tpId of the next rule to be configured
mpagenko9a304ea2020-12-16 15:54:01 +00001301 tpID := oFsm.actualUniVlanConfigRule.TpID
mpagenko551a4d42020-12-08 18:09:20 +00001302 oFsm.TpIDWaitingFor = tpID
mpagenko551a4d42020-12-08 18:09:20 +00001303 loTechProfDone := oFsm.pUniTechProf.getTechProfileDone(ctx, oFsm.pOnuUniPort.uniID, tpID)
mpagenko9a304ea2020-12-16 15:54:01 +00001304 logger.Debugw(ctx, "UniVlanConfigFsm - incremental config request", log.Fields{
1305 "device-id": oFsm.deviceID, "uni-id": oFsm.pOnuUniPort.uniID,
1306 "set-Vlan": oFsm.actualUniVlanConfigRule.SetVid, "tp-id": tpID, "ProfDone": loTechProfDone})
mpagenkof1d21d12021-06-11 13:14:45 +00001307 oFsm.mutexFlowParams.Unlock()
mpagenko9a304ea2020-12-16 15:54:01 +00001308 // Can't call FSM Event directly, decoupling it
mpagenko551a4d42020-12-08 18:09:20 +00001309 go func(aPBaseFsm *fsm.FSM, aTechProfDone bool) {
1310 if aTechProfDone {
1311 // let the vlan processing continue with next rule
1312 _ = aPBaseFsm.Event(vlanEvIncrFlowConfig)
1313 } else {
1314 // set to waiting for Techprofile
1315 _ = aPBaseFsm.Event(vlanEvWaitTPIncr)
1316 }
1317 }(pConfigVlanStateBaseFsm, loTechProfDone)
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001318 return
1319 }
mpagenkof1d21d12021-06-11 13:14:45 +00001320 oFsm.mutexFlowParams.Unlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001321 logger.Debugw(ctx, "UniVlanConfigFsm - VLAN config done: send dh event notification", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00001322 "device-id": oFsm.deviceID})
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001323 // it might appear that some flows are requested also after 'flowPushed' event has been generated ...
1324 // state transition notification is checked in deviceHandler
mpagenko551a4d42020-12-08 18:09:20 +00001325 // note: 'flowPushed' event is only generated if all 'pending' rules are configured
mpagenkodff5dda2020-08-28 11:52:01 +00001326 if oFsm.pDeviceHandler != nil {
mpagenkofc4f56e2020-11-04 17:17:49 +00001327 //making use of the add->remove successor enum assumption/definition
dbainbri4d3a0dc2020-12-02 00:33:42 +00001328 go oFsm.pDeviceHandler.deviceProcStatusUpdate(ctx, OnuDeviceEvent(uint8(oFsm.requestEvent)+oFsm.requestEventOffset))
mpagenkodff5dda2020-08-28 11:52:01 +00001329 }
1330}
1331
dbainbri4d3a0dc2020-12-02 00:33:42 +00001332func (oFsm *UniVlanConfigFsm) enterConfigIncrFlow(ctx context.Context, e *fsm.Event) {
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001333
1334 if oFsm.pDeviceHandler.isSkipOnuConfigReconciling() {
1335 logger.Debugw(ctx, "reconciling - skip further processing for incremental flow",
1336 log.Fields{"fsmState": oFsm.pAdaptFsm.pFsm.Current(), "device-id": oFsm.deviceID})
1337 go func(a_pBaseFsm *fsm.FSM) {
1338 _ = a_pBaseFsm.Event(vlanEvSkipIncFlowConfig)
1339 }(oFsm.pAdaptFsm.pFsm)
1340 return
1341 }
mpagenko15ff4a52021-03-02 10:09:20 +00001342 oFsm.mutexFlowParams.Lock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001343 logger.Debugw(ctx, "UniVlanConfigFsm - start config further incremental flow", log.Fields{
mpagenkof1d21d12021-06-11 13:14:45 +00001344 "recent flow-number": oFsm.configuredUniFlow,
1345 "device-id": oFsm.deviceID})
mpagenko551a4d42020-12-08 18:09:20 +00001346 oFsm.TpIDWaitingFor = 0 //reset indication to avoid misinterpretation
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001347
mpagenko9a304ea2020-12-16 15:54:01 +00001348 if oFsm.actualUniVlanConfigRule.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001349 // meaning transparent setup - no specific VTFD setting required
dbainbri4d3a0dc2020-12-02 00:33:42 +00001350 logger.Debugw(ctx, "UniVlanConfigFsm: no VTFD config required", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00001351 "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001352 } else {
mpagenkocf48e452021-04-23 09:23:00 +00001353 //TODO!!!: it was not really intended to keep this enter* FSM method waiting on OMCI response (preventing other state transitions)
1354 // so it would be conceptually better to wait for the response in background like for the other multi-entity processing
1355 // but as the OMCI sequence must be ensured, a separate new state would be required - perhaps later
1356 // in practice should have no influence by now as no other state transition is currently accepted (while cancel() is ensured)
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001357 if oFsm.numVlanFilterEntries == 0 {
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001358 // This attribute uniquely identifies each instance of this managed entity. Through an identical ID,
1359 // this managed entity is implicitly linked to an instance of the MAC bridge port configuration data ME.
Mahir Gunyel6781f962021-05-16 23:30:08 -07001360 vtfdID, _ := generateANISideMBPCDEID(uint16(oFsm.pOnuUniPort.macBpNo), uint16(oFsm.actualUniVlanConfigRule.TpID))
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001361 //no VTFD yet created
dbainbri4d3a0dc2020-12-02 00:33:42 +00001362 logger.Debugw(ctx, "UniVlanConfigFsm create VTFD", log.Fields{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001363 "EntitytId": strconv.FormatInt(int64(vtfdID), 16),
mpagenkof1d21d12021-06-11 13:14:45 +00001364 "device-id": oFsm.deviceID,
1365 "macBpNo": oFsm.pOnuUniPort.macBpNo, "TpID": oFsm.actualUniVlanConfigRule.TpID})
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001366 // 'SetVid' below is assumed to be masked already by the caller to 12 bit
mpagenko9a304ea2020-12-16 15:54:01 +00001367 oFsm.vlanFilterList[0] = uint16(oFsm.actualUniVlanConfigRule.SetVid)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001368
mpagenko01e726e2020-10-23 09:45:29 +00001369 vtfdFilterList := make([]uint16, cVtfdTableSize) //needed for parameter serialization
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001370 vtfdFilterList[0] = oFsm.vlanFilterList[0]
1371 oFsm.numVlanFilterEntries = 1
1372 meParams := me.ParamData{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001373 EntityID: vtfdID,
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001374 Attributes: me.AttributeValueMap{
1375 "VlanFilterList": vtfdFilterList,
1376 "ForwardOperation": uint8(0x10), //VID investigation
1377 "NumberOfEntries": oFsm.numVlanFilterEntries,
1378 },
1379 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001380 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03001381 meInstance, err := oFsm.pOmciCC.sendCreateVtfdVar(log.WithSpanFromContext(context.TODO(), ctx), oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001382 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03001383 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001384 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkof1d21d12021-06-11 13:14:45 +00001385 oFsm.mutexFlowParams.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03001386 logger.Errorw(ctx, "VTFD create failed, aborting UniVlanConfig FSM!",
1387 log.Fields{"device-id": oFsm.deviceID})
1388 pConfigVlanStateAFsm := oFsm.pAdaptFsm
1389 if pConfigVlanStateAFsm != nil {
1390 go func(a_pAFsm *AdapterFsm) {
1391 _ = a_pAFsm.pFsm.Event(vlanEvReset)
1392 }(pConfigVlanStateAFsm)
1393 }
1394 return
1395 }
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001396 //accept also nil as (error) return value for writing to LastTx
1397 // - this avoids misinterpretation of new received OMCI messages
1398 //TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
1399 // send shall return (dual format) error code that can be used here for immediate error treatment
1400 // (relevant to all used sendXX() methods in this (and other) FSM's)
mpagenko01e726e2020-10-23 09:45:29 +00001401 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001402 oFsm.mutexPLastTxMeInstance.Unlock()
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001403 } else {
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001404 // This attribute uniquely identifies each instance of this managed entity. Through an identical ID,
1405 // this managed entity is implicitly linked to an instance of the MAC bridge port configuration data ME.
Mahir Gunyel6781f962021-05-16 23:30:08 -07001406 vtfdID, _ := generateANISideMBPCDEID(uint16(oFsm.pOnuUniPort.macBpNo), uint16(oFsm.actualUniVlanConfigRule.TpID))
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001407
dbainbri4d3a0dc2020-12-02 00:33:42 +00001408 logger.Debugw(ctx, "UniVlanConfigFsm set VTFD", log.Fields{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001409 "EntitytId": strconv.FormatInt(int64(vtfdID), 16),
mpagenkof1d21d12021-06-11 13:14:45 +00001410 "device-id": oFsm.deviceID,
1411 "macBpNo": oFsm.pOnuUniPort.macBpNo, "TpID": oFsm.actualUniVlanConfigRule.TpID})
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001412 // setVid is assumed to be masked already by the caller to 12 bit
1413 oFsm.vlanFilterList[oFsm.numVlanFilterEntries] =
mpagenko9a304ea2020-12-16 15:54:01 +00001414 uint16(oFsm.actualUniVlanConfigRule.SetVid)
mpagenko01e726e2020-10-23 09:45:29 +00001415 vtfdFilterList := make([]uint16, cVtfdTableSize) //needed for parameter serialization
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001416
1417 // FIXME: VOL-3685: Issues with resetting a table entry in EVTOCD ME
1418 // VTFD has to be created afresh with a new entity ID that has the same entity ID as the MBPCD ME for every
1419 // new vlan associated with a different TP.
mpagenko9a304ea2020-12-16 15:54:01 +00001420 vtfdFilterList[0] = uint16(oFsm.actualUniVlanConfigRule.SetVid)
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001421
1422 oFsm.numVlanFilterEntries++
1423 meParams := me.ParamData{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001424 EntityID: vtfdID,
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001425 Attributes: me.AttributeValueMap{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001426 "VlanFilterList": vtfdFilterList,
1427 "ForwardOperation": uint8(0x10), //VID investigation
1428 "NumberOfEntries": oFsm.numVlanFilterEntries,
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001429 },
1430 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001431 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03001432 meInstance, err := oFsm.pOmciCC.sendCreateVtfdVar(log.WithSpanFromContext(context.TODO(), ctx), oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001433 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03001434 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001435 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkof1d21d12021-06-11 13:14:45 +00001436 oFsm.mutexFlowParams.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03001437 logger.Errorw(ctx, "UniVlanFsm create Vlan Tagging Filter ME result error",
1438 log.Fields{"device-id": oFsm.deviceID, "Error": err})
1439 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
1440 return
1441 }
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001442 //accept also nil as (error) return value for writing to LastTx
1443 // - this avoids misinterpretation of new received OMCI messages
1444 //TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
1445 // send shall return (dual format) error code that can be used here for immediate error treatment
1446 // (relevant to all used sendXX() methods in this (and other) FSM's)
mpagenko01e726e2020-10-23 09:45:29 +00001447 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001448 oFsm.mutexPLastTxMeInstance.Unlock()
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001449 }
1450 //verify response
dbainbri4d3a0dc2020-12-02 00:33:42 +00001451 err := oFsm.waitforOmciResponse(ctx)
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001452 if err != nil {
mpagenkof1d21d12021-06-11 13:14:45 +00001453 oFsm.mutexFlowParams.Unlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001454 logger.Errorw(ctx, "VTFD create/set failed, aborting VlanConfig FSM!",
mpagenko01e726e2020-10-23 09:45:29 +00001455 log.Fields{"device-id": oFsm.deviceID})
mpagenkofc4f56e2020-11-04 17:17:49 +00001456 pConfigVlanStateBaseFsm := oFsm.pAdaptFsm.pFsm
mpagenko9a304ea2020-12-16 15:54:01 +00001457 // Can't call FSM Event directly, decoupling it
mpagenkofc4f56e2020-11-04 17:17:49 +00001458 go func(a_pBaseFsm *fsm.FSM) {
1459 _ = a_pBaseFsm.Event(vlanEvReset)
1460 }(pConfigVlanStateBaseFsm)
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001461 return
1462 }
1463 }
mpagenkof1d21d12021-06-11 13:14:45 +00001464
mpagenkof1fc3862021-02-16 10:09:52 +00001465 oFsm.requestEventOffset = uint8(cDeviceEventOffsetAddWithKvStore) //0 offset for last flow-add activity
mpagenko15ff4a52021-03-02 10:09:20 +00001466 oFsm.mutexFlowParams.Unlock()
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001467 go func() {
mpagenko15ff4a52021-03-02 10:09:20 +00001468 oFsm.mutexFlowParams.RLock()
mpagenko9a304ea2020-12-16 15:54:01 +00001469 tpID := oFsm.actualUniVlanConfigRule.TpID
mpagenko15ff4a52021-03-02 10:09:20 +00001470 configuredUniFlow := oFsm.configuredUniFlow
1471 oFsm.mutexFlowParams.RUnlock()
1472 errEvto := oFsm.performConfigEvtocdEntries(ctx, configuredUniFlow)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001473 //This is correct passing scenario
1474 if errEvto == nil {
1475 //TODO Possibly insert new state for multicast --> possibly another jira/later time.
dbainbri4d3a0dc2020-12-02 00:33:42 +00001476 for _, gemPort := range oFsm.pUniTechProf.getMulticastGemPorts(ctx, oFsm.pOnuUniPort.uniID, uint8(tpID)) {
mpagenko15ff4a52021-03-02 10:09:20 +00001477 oFsm.mutexFlowParams.RLock()
mpagenko9a304ea2020-12-16 15:54:01 +00001478 vlanID := oFsm.actualUniVlanConfigRule.SetVid
dbainbri4d3a0dc2020-12-02 00:33:42 +00001479 logger.Infow(ctx, "Setting multicast MEs for additional flows", log.Fields{"deviceID": oFsm.deviceID,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001480 "techProfile": tpID, "gemPort": gemPort,
mpagenkof1d21d12021-06-11 13:14:45 +00001481 "vlanID": vlanID, "configuredUniFlow": configuredUniFlow})
mpagenko15ff4a52021-03-02 10:09:20 +00001482 oFsm.mutexFlowParams.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001483 errCreateAllMulticastME := oFsm.performSettingMulticastME(ctx, tpID, gemPort, vlanID)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001484 if errCreateAllMulticastME != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001485 logger.Errorw(ctx, "Multicast ME create failed, aborting AniConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001486 log.Fields{"device-id": oFsm.deviceID})
1487 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
1488 }
1489 }
ozgecanetsia82b91a62021-05-21 18:54:49 +03001490 //If this incremental flow contains a meter, then create TD for related gems.
1491 if oFsm.actualUniVlanConfigMeter != nil {
1492 for _, gemPort := range oFsm.pUniTechProf.getBidirectionalGemPortIDsForTP(ctx, oFsm.pOnuUniPort.uniID, tpID) {
1493 logger.Debugw(ctx, "Creating Traffic Descriptor for gem", log.Fields{"device-id": oFsm.deviceID, "meter": oFsm.actualUniVlanConfigMeter, "gem": gemPort})
1494 errCreateTrafficDescriptor := oFsm.createTrafficDescriptor(ctx, oFsm.actualUniVlanConfigMeter, tpID,
1495 oFsm.pOnuUniPort.uniID, gemPort)
1496 if errCreateTrafficDescriptor != nil {
1497 logger.Errorw(ctx, "Create Traffic Descriptor create failed, aborting Ani Config FSM!",
1498 log.Fields{"device-id": oFsm.deviceID})
1499 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
1500 }
1501 }
1502 }
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001503 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvRxConfigEvtocd)
1504 }
1505 }()
Holger Hildebrandt394c5522020-09-11 11:23:01 +00001506}
1507
dbainbri4d3a0dc2020-12-02 00:33:42 +00001508func (oFsm *UniVlanConfigFsm) enterRemoveFlow(ctx context.Context, e *fsm.Event) {
mpagenko551a4d42020-12-08 18:09:20 +00001509 oFsm.mutexFlowParams.RLock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001510 logger.Debugw(ctx, "UniVlanConfigFsm - start removing the top remove-flow", log.Fields{
mpagenkof1d21d12021-06-11 13:14:45 +00001511 "with last cookie": oFsm.uniRemoveFlowsSlice[0].cookie,
1512 "device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001513
mpagenkofc4f56e2020-11-04 17:17:49 +00001514 pConfigVlanStateBaseFsm := oFsm.pAdaptFsm.pFsm
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001515 loAllowSpecificOmciConfig := oFsm.pDeviceHandler.isReadyForOmciConfig()
mpagenko01e726e2020-10-23 09:45:29 +00001516 loVlanEntryClear := uint8(0)
1517 loVlanEntryRmPos := uint8(0x80) //with indication 'invalid' in bit 7
1518 //shallow copy is sufficient as no reference variables are used within struct
1519 loRuleParams := oFsm.uniRemoveFlowsSlice[0].vlanRuleParams
mpagenko551a4d42020-12-08 18:09:20 +00001520 oFsm.mutexFlowParams.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00001521 logger.Debugw(ctx, "UniVlanConfigFsm - remove-flow parameters are", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00001522 "match vid": loRuleParams.MatchVid, "match Pcp": loRuleParams.MatchPcp,
1523 "set vid": strconv.FormatInt(int64(loRuleParams.SetVid), 16),
1524 "device-id": oFsm.deviceID})
1525
1526 if loRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
1527 // meaning transparent setup - no specific VTFD setting required
dbainbri4d3a0dc2020-12-02 00:33:42 +00001528 logger.Debugw(ctx, "UniVlanConfigFsm: no VTFD removal required for transparent flow", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00001529 "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
1530 } else {
1531 vtfdFilterList := make([]uint16, cVtfdTableSize) //needed for parameter serialization and 're-copy'
1532 if oFsm.numVlanFilterEntries == 1 {
Mahir Gunyel6781f962021-05-16 23:30:08 -07001533 vtfdID, _ := generateANISideMBPCDEID(uint16(oFsm.pOnuUniPort.macBpNo), uint16(loRuleParams.TpID))
mpagenko01e726e2020-10-23 09:45:29 +00001534 //only one active VLAN entry (hopefully the SetVID we want to remove - should be, but not verified ..)
1535 // so we can just delete the VTFD entry
dbainbri4d3a0dc2020-12-02 00:33:42 +00001536 logger.Debugw(ctx, "UniVlanConfigFsm: VTFD delete (no more vlan filters)",
Mahir Gunyel6781f962021-05-16 23:30:08 -07001537 log.Fields{"current vlan list": oFsm.vlanFilterList, "EntitytId": strconv.FormatInt(int64(vtfdID), 16),
mpagenkof1d21d12021-06-11 13:14:45 +00001538 "device-id": oFsm.deviceID,
1539 "macBpNo": oFsm.pOnuUniPort.macBpNo, "TpID": loRuleParams.TpID})
mpagenkofc4f56e2020-11-04 17:17:49 +00001540 loVlanEntryClear = 1 //full VlanFilter clear request
1541 if loAllowSpecificOmciConfig { //specific OMCI config is expected to work acc. to the device state
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001542 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03001543 meInstance, err := oFsm.pOmciCC.sendDeleteVtfd(log.WithSpanFromContext(context.TODO(), ctx), oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001544 oFsm.pAdaptFsm.commChan, vtfdID)
ozgecanetsiab36ed572021-04-01 10:38:48 +03001545 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001546 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03001547 logger.Errorw(ctx, "UniVlanFsm delete Vlan Tagging Filter ME result error",
1548 log.Fields{"device-id": oFsm.deviceID, "Error": err})
1549 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
1550 return
1551 }
mpagenkofc4f56e2020-11-04 17:17:49 +00001552 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001553 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkofc4f56e2020-11-04 17:17:49 +00001554 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001555 logger.Debugw(ctx, "UniVlanConfigFsm delete VTFD OMCI handling skipped based on device state", log.Fields{
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001556 "device-id": oFsm.deviceID, "device-state": oFsm.pDeviceHandler.getDeviceReasonString()})
mpagenkofc4f56e2020-11-04 17:17:49 +00001557 }
mpagenko01e726e2020-10-23 09:45:29 +00001558 } else {
1559 //many VTFD already should exists - find and remove the one concerned by the actual remove rule
1560 // by updating the VTFD per set command with new valid list
dbainbri4d3a0dc2020-12-02 00:33:42 +00001561 logger.Debugw(ctx, "UniVlanConfigFsm: VTFD removal of requested VLAN from the list on OMCI",
mpagenko01e726e2020-10-23 09:45:29 +00001562 log.Fields{"current vlan list": oFsm.vlanFilterList,
1563 "set-vlan": loRuleParams.SetVid, "device-id": oFsm.deviceID})
1564 for i := uint8(0); i < oFsm.numVlanFilterEntries; i++ {
1565 if loRuleParams.SetVid == uint32(oFsm.vlanFilterList[i]) {
1566 loVlanEntryRmPos = i
1567 break //abort search
1568 }
1569 }
1570 if loVlanEntryRmPos < cVtfdTableSize {
Mahir Gunyel6781f962021-05-16 23:30:08 -07001571 vtfdID, _ := generateANISideMBPCDEID(uint16(oFsm.pOnuUniPort.macBpNo), uint16(loRuleParams.TpID))
mpagenko01e726e2020-10-23 09:45:29 +00001572 //valid entry was found - to be eclipsed
1573 loVlanEntryClear = 2 //VlanFilter remove request for a specific entry
1574 for i := uint8(0); i < oFsm.numVlanFilterEntries; i++ {
1575 if i < loVlanEntryRmPos {
1576 vtfdFilterList[i] = oFsm.vlanFilterList[i] //copy original
1577 } else if i < (cVtfdTableSize - 1) {
1578 vtfdFilterList[i] = oFsm.vlanFilterList[i+1] //copy successor (including 0 elements)
1579 } else {
1580 vtfdFilterList[i] = 0 //set last byte if needed
1581 }
1582 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001583 logger.Debugw(ctx, "UniVlanConfigFsm set VTFD", log.Fields{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001584 "EntitytId": strconv.FormatInt(int64(vtfdID), 16),
Mahir Gunyel6781f962021-05-16 23:30:08 -07001585 "new vlan list": vtfdFilterList, "device-id": oFsm.deviceID,
1586 "macBpNo": oFsm.pOnuUniPort.macBpNo, "TpID": loRuleParams.TpID})
mpagenko01e726e2020-10-23 09:45:29 +00001587
mpagenkofc4f56e2020-11-04 17:17:49 +00001588 if loAllowSpecificOmciConfig { //specific OMCI config is expected to work acc. to the device state
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001589 // FIXME: VOL-3685: Issues with resetting a table entry in EVTOCD ME
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001590 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03001591 meInstance, err := oFsm.pOmciCC.sendDeleteVtfd(log.WithSpanFromContext(context.TODO(), ctx), oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001592 oFsm.pAdaptFsm.commChan, vtfdID)
ozgecanetsiab36ed572021-04-01 10:38:48 +03001593 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001594 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03001595 logger.Errorw(ctx, "UniVlanFsm delete Vlan Tagging Filter ME result error",
1596 log.Fields{"device-id": oFsm.deviceID, "Error": err})
1597 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
1598 return
1599 }
mpagenkofc4f56e2020-11-04 17:17:49 +00001600 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001601 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkofc4f56e2020-11-04 17:17:49 +00001602 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001603 logger.Debugw(ctx, "UniVlanConfigFsm set VTFD OMCI handling skipped based on device state", log.Fields{
Holger Hildebrandtbe523842021-03-10 10:47:18 +00001604 "device-id": oFsm.deviceID, "device-state": oFsm.pDeviceHandler.getDeviceReasonString()})
mpagenko01e726e2020-10-23 09:45:29 +00001605 }
mpagenko01e726e2020-10-23 09:45:29 +00001606 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001607 logger.Warnw(ctx, "UniVlanConfigFsm: requested VLAN for removal not found in list - ignore and continue (no VTFD set)",
mpagenko01e726e2020-10-23 09:45:29 +00001608 log.Fields{"device-id": oFsm.deviceID})
1609 }
1610 }
1611 if loVlanEntryClear > 0 {
mpagenkofc4f56e2020-11-04 17:17:49 +00001612 if loAllowSpecificOmciConfig { //specific OMCI config is expected to work acc. to the device state
1613 //waiting on response
dbainbri4d3a0dc2020-12-02 00:33:42 +00001614 err := oFsm.waitforOmciResponse(ctx)
mpagenkofc4f56e2020-11-04 17:17:49 +00001615 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001616 logger.Errorw(ctx, "VTFD delete/reset failed, aborting VlanConfig FSM!",
mpagenkofc4f56e2020-11-04 17:17:49 +00001617 log.Fields{"device-id": oFsm.deviceID})
mpagenko9a304ea2020-12-16 15:54:01 +00001618 // Can't call FSM Event directly, decoupling it
mpagenkofc4f56e2020-11-04 17:17:49 +00001619 go func(a_pBaseFsm *fsm.FSM) {
1620 _ = a_pBaseFsm.Event(vlanEvReset)
1621 }(pConfigVlanStateBaseFsm)
1622 return
1623 }
mpagenko01e726e2020-10-23 09:45:29 +00001624 }
1625
mpagenko15ff4a52021-03-02 10:09:20 +00001626 oFsm.mutexFlowParams.Lock()
mpagenko01e726e2020-10-23 09:45:29 +00001627 if loVlanEntryClear == 1 {
1628 oFsm.vlanFilterList[0] = 0 //first entry is the only that can contain the previous only-one element
1629 oFsm.numVlanFilterEntries = 0
1630 } else if loVlanEntryClear == 2 {
1631 // new VlanFilterList should be one entry smaller now - copy from last configured entry
1632 // this loop now includes the 0 element on previous last valid entry
1633 for i := uint8(0); i <= oFsm.numVlanFilterEntries; i++ {
1634 oFsm.vlanFilterList[i] = vtfdFilterList[i]
1635 }
1636 oFsm.numVlanFilterEntries--
1637 }
mpagenko15ff4a52021-03-02 10:09:20 +00001638 oFsm.mutexFlowParams.Unlock()
mpagenko01e726e2020-10-23 09:45:29 +00001639 }
1640 }
1641
mpagenkofc4f56e2020-11-04 17:17:49 +00001642 if loAllowSpecificOmciConfig { //specific OMCI config is expected to work acc. to the device state
dbainbri4d3a0dc2020-12-02 00:33:42 +00001643 go oFsm.removeEvtocdEntries(ctx, loRuleParams)
mpagenkofc4f56e2020-11-04 17:17:49 +00001644 } else {
1645 // OMCI processing is not done, expectation is to have the ONU in some basic config state accordingly
dbainbri4d3a0dc2020-12-02 00:33:42 +00001646 logger.Debugw(ctx, "UniVlanConfigFsm remove EVTOCD OMCI handling skipped based on device state", log.Fields{
mpagenkofc4f56e2020-11-04 17:17:49 +00001647 "device-id": oFsm.deviceID})
mpagenko9a304ea2020-12-16 15:54:01 +00001648 // Can't call FSM Event directly, decoupling it
mpagenkofc4f56e2020-11-04 17:17:49 +00001649 go func(a_pBaseFsm *fsm.FSM) {
Girish Gowdra26a40922021-01-29 17:14:34 -08001650 _ = a_pBaseFsm.Event(vlanEvRemFlowDone, loRuleParams.TpID)
mpagenkofc4f56e2020-11-04 17:17:49 +00001651 }(pConfigVlanStateBaseFsm)
1652 }
mpagenkodff5dda2020-08-28 11:52:01 +00001653}
1654
dbainbri4d3a0dc2020-12-02 00:33:42 +00001655func (oFsm *UniVlanConfigFsm) enterVlanCleanupDone(ctx context.Context, e *fsm.Event) {
Girish Gowdra26a40922021-01-29 17:14:34 -08001656 var tpID uint8
1657 // Extract the tpID
1658 if len(e.Args) > 0 {
1659 tpID = e.Args[0].(uint8)
1660 logger.Debugw(ctx, "UniVlanConfigFsm - flow removed for tp id", log.Fields{"device-id": oFsm.deviceID, "tpID": e.Args[0].(uint8)})
1661 } else {
1662 logger.Warnw(ctx, "UniVlanConfigFsm - tp id not available", log.Fields{"device-id": oFsm.deviceID})
1663 }
mpagenko01e726e2020-10-23 09:45:29 +00001664 oFsm.mutexFlowParams.Lock()
mpagenkof1fc3862021-02-16 10:09:52 +00001665 deletedCookie := oFsm.uniRemoveFlowsSlice[0].cookie
mpagenkof1d21d12021-06-11 13:14:45 +00001666
mpagenkof582d6a2021-06-18 15:58:10 +00001667 pConfigVlanStateAFsm := oFsm.pAdaptFsm
1668 if pConfigVlanStateAFsm == nil {
1669 logger.Errorw(ctx, "invalid Fsm pointer - unresolvable - abort",
1670 log.Fields{"device-id": oFsm.deviceID})
1671 //would have to be fixed from outside somehow
1672 return
1673 }
1674
mpagenkof1d21d12021-06-11 13:14:45 +00001675 // here we need o finally remove the removed data also from uniVlanFlowParamsSlice and possibly have to
1676 // stop the suspension of a add-activity waiting for the end of removal
mpagenkof582d6a2021-06-18 15:58:10 +00001677 //call from 'configured' state of the rule
1678 if err := oFsm.removeFlowFromParamsSlice(ctx, deletedCookie, true); err != nil {
1679 //something quite inconsistent detected, perhaps just try to recover with FSM reset
1680 oFsm.mutexFlowParams.Unlock()
1681 logger.Errorw(ctx, "UniVlanConfigFsm - could not clear database - abort", log.Fields{"device-id": oFsm.deviceID})
1682 go func(a_pAFsm *AdapterFsm) {
1683 _ = a_pAFsm.pFsm.Event(vlanEvReset)
1684 }(pConfigVlanStateAFsm)
1685 return
1686 }
mpagenkof1d21d12021-06-11 13:14:45 +00001687 if oFsm.uniRemoveFlowsSlice[0].isSuspendedOnAdd {
1688 removeChannel := oFsm.uniRemoveFlowsSlice[0].removeChannel
1689 oFsm.mutexFlowParams.Unlock()
1690 removeChannel <- true
1691 oFsm.mutexFlowParams.Lock()
1692 }
1693
mpagenkof1fc3862021-02-16 10:09:52 +00001694 logger.Debugw(ctx, "UniVlanConfigFsm - removing the removal data", log.Fields{
1695 "in state": e.FSM.Current(), "device-id": oFsm.deviceID,
1696 "removed cookie": deletedCookie, "waitForDeleteCookie": oFsm.delayNewRuleCookie})
1697
mpagenko01e726e2020-10-23 09:45:29 +00001698 if len(oFsm.uniRemoveFlowsSlice) <= 1 {
1699 oFsm.uniRemoveFlowsSlice = nil //reset the slice
dbainbri4d3a0dc2020-12-02 00:33:42 +00001700 logger.Debugw(ctx, "UniVlanConfigFsm flow removal - last remove-flow deleted", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00001701 "device-id": oFsm.deviceID})
1702 } else {
1703 //cut off the actual flow by slicing out the first element
1704 oFsm.uniRemoveFlowsSlice = append(
1705 oFsm.uniRemoveFlowsSlice[:0],
1706 oFsm.uniRemoveFlowsSlice[1:]...)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001707 logger.Debugw(ctx, "UniVlanConfigFsm flow removal - specific flow deleted from data", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00001708 "device-id": oFsm.deviceID})
1709 }
1710 oFsm.mutexFlowParams.Unlock()
1711
mpagenkof1fc3862021-02-16 10:09:52 +00001712 oFsm.requestEventOffset = uint8(cDeviceEventOffsetRemoveWithKvStore) //offset for last flow-remove activity (with kvStore request)
mpagenko01e726e2020-10-23 09:45:29 +00001713 //return to the basic config verification state
mpagenkof582d6a2021-06-18 15:58:10 +00001714 // Can't call FSM Event directly, decoupling it
1715 go func(a_pAFsm *AdapterFsm) {
1716 _ = a_pAFsm.pFsm.Event(vlanEvFlowDataRemoved)
1717 }(pConfigVlanStateAFsm)
Girish Gowdra26a40922021-01-29 17:14:34 -08001718
mpagenkobb47bc22021-04-20 13:29:09 +00001719 oFsm.mutexFlowParams.Lock()
Girish Gowdra26a40922021-01-29 17:14:34 -08001720 noOfFlowRem := len(oFsm.uniRemoveFlowsSlice)
mpagenkof1fc3862021-02-16 10:09:52 +00001721 if deletedCookie == oFsm.delayNewRuleCookie {
1722 // flush the channel CookieDeleted to ensure it is not lingering from some previous (aborted) activity
1723 select {
1724 case <-oFsm.chCookieDeleted:
1725 logger.Debug(ctx, "flushed CookieDeleted")
1726 default:
1727 }
1728 oFsm.chCookieDeleted <- true // let the waiting AddFlow thread continue
1729 }
mpagenkobb47bc22021-04-20 13:29:09 +00001730 // If all pending flow-removes are completed and TP ID is valid go on processing any pending TP delete
1731 if oFsm.signalOnFlowDelete && noOfFlowRem == 0 && tpID > 0 {
1732 logger.Debugw(ctx, "signal flow removal for pending TP delete", log.Fields{"device-id": oFsm.deviceID, "tpID": tpID})
Girish Gowdra26a40922021-01-29 17:14:34 -08001733 // If we are here then all flows are removed.
mpagenkobb47bc22021-04-20 13:29:09 +00001734 if len(oFsm.flowDeleteChannel) == 0 { //channel not yet in use
1735 oFsm.flowDeleteChannel <- true
1736 oFsm.signalOnFlowDelete = false
1737 }
Girish Gowdra26a40922021-01-29 17:14:34 -08001738 }
mpagenkobb47bc22021-04-20 13:29:09 +00001739 oFsm.mutexFlowParams.Unlock()
mpagenkodff5dda2020-08-28 11:52:01 +00001740}
1741
dbainbri4d3a0dc2020-12-02 00:33:42 +00001742func (oFsm *UniVlanConfigFsm) enterResetting(ctx context.Context, e *fsm.Event) {
1743 logger.Debugw(ctx, "UniVlanConfigFsm resetting", log.Fields{"device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001744
1745 pConfigVlanStateAFsm := oFsm.pAdaptFsm
1746 if pConfigVlanStateAFsm != nil {
1747 // abort running message processing
1748 fsmAbortMsg := Message{
1749 Type: TestMsg,
1750 Data: TestMessage{
1751 TestMessageVal: AbortMessageProcessing,
1752 },
1753 }
1754 pConfigVlanStateAFsm.commChan <- fsmAbortMsg
1755
mpagenko9a304ea2020-12-16 15:54:01 +00001756 //try to restart the FSM to 'disabled'
1757 // Can't call FSM Event directly, decoupling it
mpagenkodff5dda2020-08-28 11:52:01 +00001758 go func(a_pAFsm *AdapterFsm) {
1759 if a_pAFsm != nil && a_pAFsm.pFsm != nil {
Himani Chawla4d908332020-08-31 12:30:20 +05301760 _ = a_pAFsm.pFsm.Event(vlanEvRestart)
mpagenkodff5dda2020-08-28 11:52:01 +00001761 }
1762 }(pConfigVlanStateAFsm)
1763 }
1764}
1765
dbainbri4d3a0dc2020-12-02 00:33:42 +00001766func (oFsm *UniVlanConfigFsm) enterDisabled(ctx context.Context, e *fsm.Event) {
1767 logger.Debugw(ctx, "UniVlanConfigFsm enters disabled state", log.Fields{"device-id": oFsm.deviceID})
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001768 oFsm.mutexPLastTxMeInstance.Lock()
mpagenko01e726e2020-10-23 09:45:29 +00001769 oFsm.pLastTxMeInstance = nil
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001770 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkof1d21d12021-06-11 13:14:45 +00001771
1772 oFsm.mutexFlowParams.RLock()
1773 if oFsm.delayNewRuleCookie != 0 {
1774 // looks like the waiting AddFlow is stuck
1775 oFsm.mutexFlowParams.RUnlock()
1776 oFsm.chCookieDeleted <- true // let the waiting AddFlow thread continue/terminate
1777 oFsm.mutexFlowParams.RLock()
1778 }
1779 if len(oFsm.uniRemoveFlowsSlice) > 0 {
1780 for _, removeUniFlowParams := range oFsm.uniRemoveFlowsSlice {
1781 if removeUniFlowParams.isSuspendedOnAdd {
1782 removeChannel := removeUniFlowParams.removeChannel
1783 logger.Debugw(ctx, "UniVlanConfigFsm flow clear-up - abort suspended rule-add", log.Fields{
1784 "device-id": oFsm.deviceID, "cookie": removeUniFlowParams.cookie})
1785 oFsm.mutexFlowParams.RUnlock()
1786 removeChannel <- false
1787 oFsm.mutexFlowParams.RLock()
1788 }
1789 }
1790 }
1791
mpagenkodff5dda2020-08-28 11:52:01 +00001792 if oFsm.pDeviceHandler != nil {
mpagenko2418ab02020-11-12 12:58:06 +00001793 //TODO: to clarify with improved error treatment for VlanConfigFsm (timeout,reception) errors
1794 // current code removes the complete FSM including all flow/rule configuration done so far
1795 // this might be a bit to much, it would require fully new flow config from rwCore (at least on OnuDown/up)
1796 // maybe a more sophisticated approach is possible without clearing the data
1797 if oFsm.clearPersistency {
1798 //permanently remove possibly stored persistent data
1799 if len(oFsm.uniVlanFlowParamsSlice) > 0 {
1800 var emptySlice = make([]uniVlanFlowParams, 0)
mpagenkof1fc3862021-02-16 10:09:52 +00001801 _ = oFsm.pDeviceHandler.storePersUniFlowConfig(ctx, oFsm.pOnuUniPort.uniID, &emptySlice, true) //ignore errors
mpagenko2418ab02020-11-12 12:58:06 +00001802 }
1803 } else {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001804 logger.Debugw(ctx, "UniVlanConfigFsm persistency data not cleared", log.Fields{"device-id": oFsm.deviceID})
mpagenko2418ab02020-11-12 12:58:06 +00001805 }
mpagenko9a304ea2020-12-16 15:54:01 +00001806 oFsm.mutexFlowParams.RUnlock()
mpagenko2418ab02020-11-12 12:58:06 +00001807 //request removal of 'reference' in the Handler (completely clear the FSM and its data)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001808 go oFsm.pDeviceHandler.RemoveVlanFilterFsm(ctx, oFsm.pOnuUniPort)
mpagenkof1d21d12021-06-11 13:14:45 +00001809 return
mpagenkodff5dda2020-08-28 11:52:01 +00001810 }
mpagenkof1d21d12021-06-11 13:14:45 +00001811 oFsm.mutexFlowParams.RUnlock()
mpagenkodff5dda2020-08-28 11:52:01 +00001812}
1813
dbainbri4d3a0dc2020-12-02 00:33:42 +00001814func (oFsm *UniVlanConfigFsm) processOmciVlanMessages(ctx context.Context) { //ctx context.Context?
1815 logger.Debugw(ctx, "Start UniVlanConfigFsm Msg processing", log.Fields{"for device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001816loop:
1817 for {
mpagenkodff5dda2020-08-28 11:52:01 +00001818 // case <-ctx.Done():
dbainbri4d3a0dc2020-12-02 00:33:42 +00001819 // logger.Info(ctx,"MibSync Msg", log.Fields{"Message handling canceled via context for device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001820 // break loop
Himani Chawla4d908332020-08-31 12:30:20 +05301821 message, ok := <-oFsm.pAdaptFsm.commChan
1822 if !ok {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001823 logger.Info(ctx, "UniVlanConfigFsm Rx Msg - could not read from channel", log.Fields{"device-id": oFsm.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +05301824 // but then we have to ensure a restart of the FSM as well - as exceptional procedure
1825 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
1826 break loop
1827 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001828 logger.Debugw(ctx, "UniVlanConfigFsm Rx Msg", log.Fields{"device-id": oFsm.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +05301829
1830 switch message.Type {
1831 case TestMsg:
1832 msg, _ := message.Data.(TestMessage)
1833 if msg.TestMessageVal == AbortMessageProcessing {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001834 logger.Infow(ctx, "UniVlanConfigFsm abort ProcessMsg", log.Fields{"for device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001835 break loop
1836 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001837 logger.Warnw(ctx, "UniVlanConfigFsm unknown TestMessage", log.Fields{"device-id": oFsm.deviceID, "MessageVal": msg.TestMessageVal})
Himani Chawla4d908332020-08-31 12:30:20 +05301838 case OMCI:
1839 msg, _ := message.Data.(OmciMessage)
dbainbri4d3a0dc2020-12-02 00:33:42 +00001840 oFsm.handleOmciVlanConfigMessage(ctx, msg)
Himani Chawla4d908332020-08-31 12:30:20 +05301841 default:
dbainbri4d3a0dc2020-12-02 00:33:42 +00001842 logger.Warn(ctx, "UniVlanConfigFsm Rx unknown message", log.Fields{"device-id": oFsm.deviceID,
Himani Chawla4d908332020-08-31 12:30:20 +05301843 "message.Type": message.Type})
mpagenkodff5dda2020-08-28 11:52:01 +00001844 }
1845 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001846 logger.Infow(ctx, "End UniVlanConfigFsm Msg processing", log.Fields{"device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001847}
1848
dbainbri4d3a0dc2020-12-02 00:33:42 +00001849func (oFsm *UniVlanConfigFsm) handleOmciVlanConfigMessage(ctx context.Context, msg OmciMessage) {
1850 logger.Debugw(ctx, "Rx OMCI UniVlanConfigFsm Msg", log.Fields{"device-id": oFsm.deviceID,
mpagenkodff5dda2020-08-28 11:52:01 +00001851 "msgType": msg.OmciMsg.MessageType})
1852
1853 switch msg.OmciMsg.MessageType {
1854 case omci.CreateResponseType:
mpagenko01e726e2020-10-23 09:45:29 +00001855 { // had to shift that to a method to cope with StaticCodeAnalysis restrictions :-(
dbainbri4d3a0dc2020-12-02 00:33:42 +00001856 if err := oFsm.handleOmciCreateResponseMessage(ctx, msg.OmciPacket); err != nil {
1857 logger.Warnw(ctx, "CreateResponse handling aborted", log.Fields{"err": err})
mpagenkodff5dda2020-08-28 11:52:01 +00001858 return
1859 }
mpagenkodff5dda2020-08-28 11:52:01 +00001860 } //CreateResponseType
1861 case omci.SetResponseType:
mpagenko01e726e2020-10-23 09:45:29 +00001862 { //leave that here as direct code as most often used
mpagenkodff5dda2020-08-28 11:52:01 +00001863 msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeSetResponse)
1864 if msgLayer == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001865 logger.Errorw(ctx, "Omci Msg layer could not be detected for SetResponse",
mpagenko01e726e2020-10-23 09:45:29 +00001866 log.Fields{"device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001867 return
1868 }
1869 msgObj, msgOk := msgLayer.(*omci.SetResponse)
1870 if !msgOk {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001871 logger.Errorw(ctx, "Omci Msg layer could not be assigned for SetResponse",
mpagenko01e726e2020-10-23 09:45:29 +00001872 log.Fields{"device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001873 return
1874 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001875 logger.Debugw(ctx, "UniVlanConfigFsm SetResponse Data", log.Fields{"device-id": oFsm.deviceID, "data-fields": msgObj})
mpagenkodff5dda2020-08-28 11:52:01 +00001876 if msgObj.Result != me.Success {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001877 logger.Errorw(ctx, "UniVlanConfigFsm Omci SetResponse Error - later: drive FSM to abort state ?",
mpagenko01e726e2020-10-23 09:45:29 +00001878 log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
mpagenkodff5dda2020-08-28 11:52:01 +00001879 // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
1880 return
1881 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001882 oFsm.mutexPLastTxMeInstance.RLock()
1883 if oFsm.pLastTxMeInstance != nil {
1884 if msgObj.EntityClass == oFsm.pLastTxMeInstance.GetClassID() &&
1885 msgObj.EntityInstance == oFsm.pLastTxMeInstance.GetEntityID() {
1886 switch oFsm.pLastTxMeInstance.GetName() {
ozgecanetsia82b91a62021-05-21 18:54:49 +03001887 case "VlanTaggingFilterData", "ExtendedVlanTaggingOperationConfigurationData", "MulticastOperationsProfile", "GemPortNetworkCtp":
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001888 { // let the MultiEntity config proceed by stopping the wait function
1889 oFsm.mutexPLastTxMeInstance.RUnlock()
1890 oFsm.omciMIdsResponseReceived <- true
1891 return
1892 }
1893 default:
1894 {
1895 logger.Warnw(ctx, "Unsupported ME name received!",
1896 log.Fields{"ME name": oFsm.pLastTxMeInstance.GetName(), "device-id": oFsm.deviceID})
1897 }
mpagenkodff5dda2020-08-28 11:52:01 +00001898 }
1899 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001900 } else {
1901 logger.Warnw(ctx, "Pointer to last Tx MeInstance is nil!", log.Fields{"device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001902 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001903 oFsm.mutexPLastTxMeInstance.RUnlock()
mpagenkodff5dda2020-08-28 11:52:01 +00001904 } //SetResponseType
mpagenko01e726e2020-10-23 09:45:29 +00001905 case omci.DeleteResponseType:
1906 { // had to shift that to a method to cope with StaticCodeAnalysis restrictions :-(
dbainbri4d3a0dc2020-12-02 00:33:42 +00001907 if err := oFsm.handleOmciDeleteResponseMessage(ctx, msg.OmciPacket); err != nil {
1908 logger.Warnw(ctx, "DeleteResponse handling aborted", log.Fields{"err": err})
mpagenko01e726e2020-10-23 09:45:29 +00001909 return
1910 }
1911 } //DeleteResponseType
mpagenkodff5dda2020-08-28 11:52:01 +00001912 default:
1913 {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001914 logger.Errorw(ctx, "Rx OMCI unhandled MsgType",
mpagenko01e726e2020-10-23 09:45:29 +00001915 log.Fields{"omciMsgType": msg.OmciMsg.MessageType, "device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00001916 return
1917 }
1918 }
1919}
1920
dbainbri4d3a0dc2020-12-02 00:33:42 +00001921func (oFsm *UniVlanConfigFsm) handleOmciCreateResponseMessage(ctx context.Context, apOmciPacket *gp.Packet) error {
mpagenko01e726e2020-10-23 09:45:29 +00001922 msgLayer := (*apOmciPacket).Layer(omci.LayerTypeCreateResponse)
1923 if msgLayer == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001924 logger.Errorw(ctx, "Omci Msg layer could not be detected for CreateResponse",
mpagenko01e726e2020-10-23 09:45:29 +00001925 log.Fields{"device-id": oFsm.deviceID})
1926 return fmt.Errorf("omci msg layer could not be detected for CreateResponse for device-id %x",
1927 oFsm.deviceID)
1928 }
1929 msgObj, msgOk := msgLayer.(*omci.CreateResponse)
1930 if !msgOk {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001931 logger.Errorw(ctx, "Omci Msg layer could not be assigned for CreateResponse",
mpagenko01e726e2020-10-23 09:45:29 +00001932 log.Fields{"device-id": oFsm.deviceID})
1933 return fmt.Errorf("omci msg layer could not be assigned for CreateResponse for device-id %x",
1934 oFsm.deviceID)
1935 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001936 logger.Debugw(ctx, "UniVlanConfigFsm CreateResponse Data", log.Fields{"device-id": oFsm.deviceID, "data-fields": msgObj})
ozgecanetsiab5000ef2020-11-27 14:38:20 +03001937 if msgObj.Result != me.Success && msgObj.Result != me.InstanceExists {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001938 logger.Errorw(ctx, "Omci CreateResponse Error - later: drive FSM to abort state ?", log.Fields{"device-id": oFsm.deviceID,
mpagenko01e726e2020-10-23 09:45:29 +00001939 "Error": msgObj.Result})
1940 // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
1941 return fmt.Errorf("omci CreateResponse Error for device-id %x",
1942 oFsm.deviceID)
1943 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001944 oFsm.mutexPLastTxMeInstance.RLock()
1945 if oFsm.pLastTxMeInstance != nil {
1946 if msgObj.EntityClass == oFsm.pLastTxMeInstance.GetClassID() &&
1947 msgObj.EntityInstance == oFsm.pLastTxMeInstance.GetEntityID() {
1948 // to satisfy StaticCodeAnalysis I had to move the small processing into a separate method :-(
1949 switch oFsm.pLastTxMeInstance.GetName() {
1950 case "VlanTaggingFilterData", "MulticastOperationsProfile",
1951 "MulticastSubscriberConfigInfo", "MacBridgePortConfigurationData",
ozgecanetsia82b91a62021-05-21 18:54:49 +03001952 "ExtendedVlanTaggingOperationConfigurationData", "TrafficDescriptor":
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001953 {
1954 oFsm.mutexPLastTxMeInstance.RUnlock()
1955 if oFsm.pAdaptFsm.pFsm.Current() == vlanStConfigVtfd {
1956 // Only if CreateResponse is received from first flow entry - let the FSM proceed ...
1957 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvRxConfigVtfd)
1958 } else { // let the MultiEntity config proceed by stopping the wait function
1959 oFsm.omciMIdsResponseReceived <- true
1960 }
1961 return nil
1962 }
1963 default:
1964 {
1965 logger.Warnw(ctx, "Unsupported ME name received!",
1966 log.Fields{"ME name": oFsm.pLastTxMeInstance.GetName(), "device-id": oFsm.deviceID})
mpagenko01e726e2020-10-23 09:45:29 +00001967 }
1968 }
1969 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001970 } else {
1971 logger.Warnw(ctx, "Pointer to last Tx MeInstance is nil!", log.Fields{"device-id": oFsm.deviceID})
mpagenko01e726e2020-10-23 09:45:29 +00001972 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00001973 oFsm.mutexPLastTxMeInstance.RUnlock()
mpagenko01e726e2020-10-23 09:45:29 +00001974 return nil
1975}
1976
dbainbri4d3a0dc2020-12-02 00:33:42 +00001977func (oFsm *UniVlanConfigFsm) handleOmciDeleteResponseMessage(ctx context.Context, apOmciPacket *gp.Packet) error {
mpagenko01e726e2020-10-23 09:45:29 +00001978 msgLayer := (*apOmciPacket).Layer(omci.LayerTypeDeleteResponse)
1979 if msgLayer == nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001980 logger.Errorw(ctx, "UniVlanConfigFsm - Omci Msg layer could not be detected for DeleteResponse",
mpagenko01e726e2020-10-23 09:45:29 +00001981 log.Fields{"device-id": oFsm.deviceID})
1982 return fmt.Errorf("omci msg layer could not be detected for DeleteResponse for device-id %x",
1983 oFsm.deviceID)
1984 }
1985 msgObj, msgOk := msgLayer.(*omci.DeleteResponse)
1986 if !msgOk {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001987 logger.Errorw(ctx, "UniVlanConfigFsm - Omci Msg layer could not be assigned for DeleteResponse",
mpagenko01e726e2020-10-23 09:45:29 +00001988 log.Fields{"device-id": oFsm.deviceID})
1989 return fmt.Errorf("omci msg layer could not be assigned for DeleteResponse for device-id %x",
1990 oFsm.deviceID)
1991 }
dbainbri4d3a0dc2020-12-02 00:33:42 +00001992 logger.Debugw(ctx, "UniVlanConfigFsm DeleteResponse Data", log.Fields{"device-id": oFsm.deviceID, "data-fields": msgObj})
mpagenko01e726e2020-10-23 09:45:29 +00001993 if msgObj.Result != me.Success {
dbainbri4d3a0dc2020-12-02 00:33:42 +00001994 logger.Errorw(ctx, "UniVlanConfigFsm - Omci DeleteResponse Error - later: drive FSM to abort state ?",
mpagenko01e726e2020-10-23 09:45:29 +00001995 log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
1996 // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
1997 return fmt.Errorf("omci DeleteResponse Error for device-id %x",
1998 oFsm.deviceID)
1999 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002000 oFsm.mutexPLastTxMeInstance.RLock()
2001 if oFsm.pLastTxMeInstance != nil {
2002 if msgObj.EntityClass == oFsm.pLastTxMeInstance.GetClassID() &&
2003 msgObj.EntityInstance == oFsm.pLastTxMeInstance.GetEntityID() {
2004 switch oFsm.pLastTxMeInstance.GetName() {
ozgecanetsia82b91a62021-05-21 18:54:49 +03002005 case "VlanTaggingFilterData", "ExtendedVlanTaggingOperationConfigurationData", "TrafficDescriptor":
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002006 { // let the MultiEntity config proceed by stopping the wait function
2007 oFsm.mutexPLastTxMeInstance.RUnlock()
2008 oFsm.omciMIdsResponseReceived <- true
2009 return nil
2010 }
2011 default:
2012 {
2013 logger.Warnw(ctx, "Unsupported ME name received!",
2014 log.Fields{"ME name": oFsm.pLastTxMeInstance.GetName(), "device-id": oFsm.deviceID})
2015 }
mpagenko01e726e2020-10-23 09:45:29 +00002016 }
2017 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002018 } else {
2019 logger.Warnw(ctx, "Pointer to last Tx MeInstance is nil!", log.Fields{"device-id": oFsm.deviceID})
mpagenko01e726e2020-10-23 09:45:29 +00002020 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002021 oFsm.mutexPLastTxMeInstance.RUnlock()
mpagenko01e726e2020-10-23 09:45:29 +00002022 return nil
2023}
2024
dbainbri4d3a0dc2020-12-02 00:33:42 +00002025func (oFsm *UniVlanConfigFsm) performConfigEvtocdEntries(ctx context.Context, aFlowEntryNo uint8) error {
mpagenkof1d21d12021-06-11 13:14:45 +00002026 oFsm.mutexFlowParams.RLock()
2027 evtocdID := oFsm.evtocdID
2028 oFsm.mutexFlowParams.RUnlock()
2029
Holger Hildebrandt394c5522020-09-11 11:23:01 +00002030 if aFlowEntryNo == 0 {
2031 // EthType set only at first flow element
mpagenkodff5dda2020-08-28 11:52:01 +00002032 // EVTOCD ME is expected to exist at this point already from MIB-Download (with AssociationType/Pointer)
2033 // we need to extend the configuration by EthType definition and, to be sure, downstream 'inverse' mode
dbainbri4d3a0dc2020-12-02 00:33:42 +00002034 logger.Debugw(ctx, "UniVlanConfigFsm Tx Create::EVTOCD", log.Fields{
mpagenkof1d21d12021-06-11 13:14:45 +00002035 "EntitytId": strconv.FormatInt(int64(evtocdID), 16),
mpagenkodff5dda2020-08-28 11:52:01 +00002036 "i/oEthType": strconv.FormatInt(int64(cDefaultTpid), 16),
mpagenko01e726e2020-10-23 09:45:29 +00002037 "device-id": oFsm.deviceID})
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002038 associationType := 2 // default to uniPPTP
2039 if oFsm.pOnuUniPort.portType == uniVEIP {
2040 associationType = 10
2041 }
2042 // Create the EVTOCD ME
mpagenkodff5dda2020-08-28 11:52:01 +00002043 meParams := me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002044 EntityID: evtocdID,
mpagenkodff5dda2020-08-28 11:52:01 +00002045 Attributes: me.AttributeValueMap{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002046 "AssociationType": uint8(associationType),
2047 "AssociatedMePointer": oFsm.pOnuUniPort.entityID,
mpagenkodff5dda2020-08-28 11:52:01 +00002048 },
2049 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002050 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002051 meInstance, err := oFsm.pOmciCC.sendCreateEvtocdVar(context.TODO(), oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout,
2052 true, oFsm.pAdaptFsm.commChan, meParams)
2053 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002054 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002055 logger.Errorw(ctx, "CreateEvtocdVar create failed, aborting UniVlanConfigFsm!",
2056 log.Fields{"device-id": oFsm.deviceID})
2057 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2058 return fmt.Errorf("evtocd instance create failed %s, error %s", oFsm.deviceID, err)
2059 }
mpagenkodff5dda2020-08-28 11:52:01 +00002060 //accept also nil as (error) return value for writing to LastTx
2061 // - this avoids misinterpretation of new received OMCI messages
mpagenko01e726e2020-10-23 09:45:29 +00002062 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002063 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002064
2065 //verify response
ozgecanetsiab36ed572021-04-01 10:38:48 +03002066 err = oFsm.waitforOmciResponse(ctx)
mpagenkodff5dda2020-08-28 11:52:01 +00002067 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002068 logger.Errorw(ctx, "Evtocd create failed, aborting VlanConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002069 log.Fields{"device-id": oFsm.deviceID})
2070 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2071 return fmt.Errorf("evtocd create failed %s, error %s", oFsm.deviceID, err)
2072 }
2073
2074 // Set the EVTOCD ME default params
2075 meParams = me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002076 EntityID: evtocdID,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002077 Attributes: me.AttributeValueMap{
2078 "InputTpid": uint16(cDefaultTpid), //could be possibly retrieved from flow config one day, by now just like py-code base
2079 "OutputTpid": uint16(cDefaultTpid), //could be possibly retrieved from flow config one day, by now just like py-code base
2080 "DownstreamMode": uint8(cDefaultDownstreamMode),
2081 },
2082 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002083 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002084 meInstance, err = oFsm.pOmciCC.sendSetEvtocdVar(log.WithSpanFromContext(context.TODO(), ctx),
2085 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002086 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002087 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002088 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002089 logger.Errorw(ctx, "SetEvtocdVar set failed, aborting UniVlanConfigFsm!",
2090 log.Fields{"device-id": oFsm.deviceID})
2091 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2092 return fmt.Errorf("evtocd instance set failed %s, error %s", oFsm.deviceID, err)
2093 }
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002094 //accept also nil as (error) return value for writing to LastTx
2095 // - this avoids misinterpretation of new received OMCI messages
2096 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002097 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002098
2099 //verify response
dbainbri4d3a0dc2020-12-02 00:33:42 +00002100 err = oFsm.waitforOmciResponse(ctx)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002101 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002102 logger.Errorw(ctx, "Evtocd set TPID failed, aborting VlanConfig FSM!",
mpagenko01e726e2020-10-23 09:45:29 +00002103 log.Fields{"device-id": oFsm.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +05302104 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002105 return fmt.Errorf("evtocd set TPID failed %s, error %s", oFsm.deviceID, err)
mpagenkodff5dda2020-08-28 11:52:01 +00002106 }
Holger Hildebrandt394c5522020-09-11 11:23:01 +00002107 } //first flow element
mpagenkodff5dda2020-08-28 11:52:01 +00002108
mpagenko551a4d42020-12-08 18:09:20 +00002109 oFsm.mutexFlowParams.RLock()
mpagenko9a304ea2020-12-16 15:54:01 +00002110 if oFsm.actualUniVlanConfigRule.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
mpagenkodff5dda2020-08-28 11:52:01 +00002111 //transparent transmission required
mpagenko551a4d42020-12-08 18:09:20 +00002112 oFsm.mutexFlowParams.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00002113 logger.Debugw(ctx, "UniVlanConfigFsm Tx Set::EVTOCD single tagged transparent rule", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00002114 "device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00002115 sliceEvtocdRule := make([]uint8, 16)
2116 // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
2117 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
2118 cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
2119 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
2120 cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
2121
2122 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
2123 cPrioDefaultFilter<<cFilterPrioOffset| // default inner-tag rule
2124 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on inner vid
2125 cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
2126 cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
2127
2128 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:],
2129 0<<cTreatTTROffset| // Do not pop any tags
2130 cDoNotAddPrio<<cTreatPrioOffset| // do not add outer tag
2131 cDontCareVid<<cTreatVidOffset| // Outer VID don't care
2132 cDontCareTpid<<cTreatTpidOffset) // Outer TPID field don't care
2133
2134 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
2135 cDoNotAddPrio<<cTreatPrioOffset| // do not add inner tag
2136 cDontCareVid<<cTreatVidOffset| // Outer VID don't care
2137 cSetOutputTpidCopyDei<<cTreatTpidOffset) // Set TPID = 0x8100
2138
2139 meParams := me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002140 EntityID: evtocdID,
mpagenkodff5dda2020-08-28 11:52:01 +00002141 Attributes: me.AttributeValueMap{
2142 "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
2143 },
2144 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002145 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002146 meInstance, err := oFsm.pOmciCC.sendSetEvtocdVar(log.WithSpanFromContext(context.TODO(), ctx),
2147 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
mpagenkodff5dda2020-08-28 11:52:01 +00002148 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002149 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002150 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002151 logger.Errorw(ctx, "SetEvtocdVar set failed, aborting UniVlanConfigFsm!",
2152 log.Fields{"device-id": oFsm.deviceID})
2153 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2154 return fmt.Errorf("evtocd instance set failed %s, error %s", oFsm.deviceID, err)
2155 }
mpagenkodff5dda2020-08-28 11:52:01 +00002156 //accept also nil as (error) return value for writing to LastTx
2157 // - this avoids misinterpretation of new received OMCI messages
mpagenko01e726e2020-10-23 09:45:29 +00002158 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002159 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002160
2161 //verify response
ozgecanetsiab36ed572021-04-01 10:38:48 +03002162 err = oFsm.waitforOmciResponse(ctx)
mpagenkodff5dda2020-08-28 11:52:01 +00002163 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002164 logger.Errorw(ctx, "Evtocd set transparent singletagged rule failed, aborting VlanConfig FSM!",
mpagenko01e726e2020-10-23 09:45:29 +00002165 log.Fields{"device-id": oFsm.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +05302166 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002167 return fmt.Errorf("evtocd set transparent singletagged rule failed %s, error %s", oFsm.deviceID, err)
2168
mpagenkodff5dda2020-08-28 11:52:01 +00002169 }
2170 } else {
2171 // according to py-code acceptIncrementalEvto program option decides upon stacking or translation scenario
2172 if oFsm.acceptIncrementalEvtoOption {
mpagenko9a304ea2020-12-16 15:54:01 +00002173 matchPcp := oFsm.actualUniVlanConfigRule.MatchPcp
2174 matchVid := oFsm.actualUniVlanConfigRule.MatchVid
2175 setPcp := oFsm.actualUniVlanConfigRule.SetPcp
2176 setVid := oFsm.actualUniVlanConfigRule.SetVid
mpagenkodff5dda2020-08-28 11:52:01 +00002177 // this defines VID translation scenario: singletagged->singletagged (if not transparent)
dbainbri4d3a0dc2020-12-02 00:33:42 +00002178 logger.Debugw(ctx, "UniVlanConfigFsm Tx Set::EVTOCD single tagged translation rule", log.Fields{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002179 "match-pcp": matchPcp, "match-vid": matchVid, "set-pcp": setPcp, "set-vid:": setVid, "device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00002180 sliceEvtocdRule := make([]uint8, 16)
2181 // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
2182 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
2183 cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
2184 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
2185 cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
2186
2187 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
mpagenko9a304ea2020-12-16 15:54:01 +00002188 oFsm.actualUniVlanConfigRule.MatchPcp<<cFilterPrioOffset| // either DNFonPrio or ignore tag (default) on innerVLAN
2189 oFsm.actualUniVlanConfigRule.MatchVid<<cFilterVidOffset| // either DNFonVid or real filter VID
mpagenkodff5dda2020-08-28 11:52:01 +00002190 cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
2191 cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
2192
2193 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:],
mpagenko9a304ea2020-12-16 15:54:01 +00002194 oFsm.actualUniVlanConfigRule.TagsToRemove<<cTreatTTROffset| // either 1 or 0
mpagenkodff5dda2020-08-28 11:52:01 +00002195 cDoNotAddPrio<<cTreatPrioOffset| // do not add outer tag
2196 cDontCareVid<<cTreatVidOffset| // Outer VID don't care
2197 cDontCareTpid<<cTreatTpidOffset) // Outer TPID field don't care
2198
2199 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
mpagenko9a304ea2020-12-16 15:54:01 +00002200 oFsm.actualUniVlanConfigRule.SetPcp<<cTreatPrioOffset| // as configured in flow
2201 oFsm.actualUniVlanConfigRule.SetVid<<cTreatVidOffset| //as configured in flow
mpagenkodff5dda2020-08-28 11:52:01 +00002202 cSetOutputTpidCopyDei<<cTreatTpidOffset) // Set TPID = 0x8100
mpagenko551a4d42020-12-08 18:09:20 +00002203 oFsm.mutexFlowParams.RUnlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002204
2205 meParams := me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002206 EntityID: evtocdID,
mpagenkodff5dda2020-08-28 11:52:01 +00002207 Attributes: me.AttributeValueMap{
2208 "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
2209 },
2210 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002211 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002212 meInstance, err := oFsm.pOmciCC.sendSetEvtocdVar(log.WithSpanFromContext(context.TODO(), ctx),
2213 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
mpagenkodff5dda2020-08-28 11:52:01 +00002214 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002215 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002216 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002217 logger.Errorw(ctx, "SetEvtocdVar set failed, aborting UniVlanConfigFsm!",
2218 log.Fields{"device-id": oFsm.deviceID})
2219 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2220 return fmt.Errorf("evtocd instance set failed %s, error %s", oFsm.deviceID, err)
2221 }
mpagenkodff5dda2020-08-28 11:52:01 +00002222 //accept also nil as (error) return value for writing to LastTx
2223 // - this avoids misinterpretation of new received OMCI messages
mpagenko01e726e2020-10-23 09:45:29 +00002224 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002225 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002226
2227 //verify response
ozgecanetsiab36ed572021-04-01 10:38:48 +03002228 err = oFsm.waitforOmciResponse(ctx)
mpagenkodff5dda2020-08-28 11:52:01 +00002229 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002230 logger.Errorw(ctx, "Evtocd set singletagged translation rule failed, aborting VlanConfig FSM!",
mpagenko01e726e2020-10-23 09:45:29 +00002231 log.Fields{"device-id": oFsm.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +05302232 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002233 return fmt.Errorf("evtocd set singletagged translation rule failed %s, error %s", oFsm.deviceID, err)
mpagenkodff5dda2020-08-28 11:52:01 +00002234 }
2235 } else {
2236 //not transparent and not acceptIncrementalEvtoOption untagged/priotagged->singletagged
2237 { // just for local var's
2238 // this defines stacking scenario: untagged->singletagged
dbainbri4d3a0dc2020-12-02 00:33:42 +00002239 logger.Debugw(ctx, "UniVlanConfigFsm Tx Set::EVTOCD untagged->singletagged rule", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00002240 "device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00002241 sliceEvtocdRule := make([]uint8, 16)
2242 // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
2243 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
2244 cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
2245 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
2246 cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
2247
2248 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
2249 cPrioIgnoreTag<<cFilterPrioOffset| // Not an inner-tag rule
2250 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on inner vid
2251 cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
2252 cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
2253
2254 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:],
2255 0<<cTreatTTROffset| // Do not pop any tags
2256 cDoNotAddPrio<<cTreatPrioOffset| // do not add outer tag
2257 cDontCareVid<<cTreatVidOffset| // Outer VID don't care
2258 cDontCareTpid<<cTreatTpidOffset) // Outer TPID field don't care
2259
2260 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
2261 0<<cTreatPrioOffset| // vlan prio set to 0
2262 // (as done in Py code, maybe better option would be setPcp here, which still could be 0?)
mpagenko9a304ea2020-12-16 15:54:01 +00002263 oFsm.actualUniVlanConfigRule.SetVid<<cTreatVidOffset| // Outer VID don't care
mpagenkodff5dda2020-08-28 11:52:01 +00002264 cSetOutputTpidCopyDei<<cTreatTpidOffset) // Set TPID = 0x8100
2265
mpagenko551a4d42020-12-08 18:09:20 +00002266 oFsm.mutexFlowParams.RUnlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002267 meParams := me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002268 EntityID: evtocdID,
mpagenkodff5dda2020-08-28 11:52:01 +00002269 Attributes: me.AttributeValueMap{
2270 "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
2271 },
2272 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002273 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002274 meInstance, err := oFsm.pOmciCC.sendSetEvtocdVar(log.WithSpanFromContext(context.TODO(), ctx),
2275 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
mpagenkodff5dda2020-08-28 11:52:01 +00002276 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002277 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002278 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002279 logger.Errorw(ctx, "SetEvtocdVar set failed, aborting UniVlanConfigFsm!",
2280 log.Fields{"device-id": oFsm.deviceID})
2281 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2282 return fmt.Errorf("evtocd instance set failed %s, error %s", oFsm.deviceID, err)
2283 }
mpagenkodff5dda2020-08-28 11:52:01 +00002284 //accept also nil as (error) return value for writing to LastTx
2285 // - this avoids misinterpretation of new received OMCI messages
mpagenko01e726e2020-10-23 09:45:29 +00002286 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002287 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002288
2289 //verify response
ozgecanetsiab36ed572021-04-01 10:38:48 +03002290 err = oFsm.waitforOmciResponse(ctx)
mpagenkodff5dda2020-08-28 11:52:01 +00002291 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002292 logger.Errorw(ctx, "Evtocd set untagged->singletagged rule failed, aborting VlanConfig FSM!",
mpagenko01e726e2020-10-23 09:45:29 +00002293 log.Fields{"device-id": oFsm.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +05302294 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002295 return fmt.Errorf("evtocd set untagged->singletagged rule failed %s, error %s", oFsm.deviceID, err)
2296
mpagenkodff5dda2020-08-28 11:52:01 +00002297 }
Holger Hildebrandt394c5522020-09-11 11:23:01 +00002298 } // just for local var's
mpagenkodff5dda2020-08-28 11:52:01 +00002299 { // just for local var's
2300 // this defines 'stacking' scenario: priotagged->singletagged
dbainbri4d3a0dc2020-12-02 00:33:42 +00002301 logger.Debugw(ctx, "UniVlanConfigFsm Tx Set::EVTOCD priotagged->singletagged rule", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00002302 "device-id": oFsm.deviceID})
mpagenkodff5dda2020-08-28 11:52:01 +00002303 sliceEvtocdRule := make([]uint8, 16)
2304 // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
2305 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
2306 cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
2307 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
2308 cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
2309
2310 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
2311 cPrioDoNotFilter<<cFilterPrioOffset| // Do not Filter on innerprio
2312 0<<cFilterVidOffset| // filter on inner vid 0 (prioTagged)
2313 cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
2314 cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
2315
2316 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:],
2317 1<<cTreatTTROffset| // pop the prio-tag
2318 cDoNotAddPrio<<cTreatPrioOffset| // do not add outer tag
2319 cDontCareVid<<cTreatVidOffset| // Outer VID don't care
2320 cDontCareTpid<<cTreatTpidOffset) // Outer TPID field don't care
2321
mpagenko551a4d42020-12-08 18:09:20 +00002322 oFsm.mutexFlowParams.RLock()
mpagenkodff5dda2020-08-28 11:52:01 +00002323 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
2324 cCopyPrioFromInner<<cTreatPrioOffset| // vlan copy from PrioTag
2325 // (as done in Py code, maybe better option would be setPcp here, which still could be PrioCopy?)
mpagenko9a304ea2020-12-16 15:54:01 +00002326 oFsm.actualUniVlanConfigRule.SetVid<<cTreatVidOffset| // Outer VID as configured
mpagenkodff5dda2020-08-28 11:52:01 +00002327 cSetOutputTpidCopyDei<<cTreatTpidOffset) // Set TPID = 0x8100
mpagenko551a4d42020-12-08 18:09:20 +00002328 oFsm.mutexFlowParams.RUnlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002329
2330 meParams := me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002331 EntityID: evtocdID,
mpagenkodff5dda2020-08-28 11:52:01 +00002332 Attributes: me.AttributeValueMap{
2333 "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
2334 },
2335 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002336 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002337 meInstance, err := oFsm.pOmciCC.sendSetEvtocdVar(log.WithSpanFromContext(context.TODO(), ctx),
2338 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
mpagenkodff5dda2020-08-28 11:52:01 +00002339 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002340 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002341 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002342 logger.Errorw(ctx, "SetEvtocdVar set failed, aborting UniVlanConfigFsm!",
2343 log.Fields{"device-id": oFsm.deviceID})
2344 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2345 return fmt.Errorf("evtocd instance set failed %s, error %s", oFsm.deviceID, err)
2346 }
mpagenkodff5dda2020-08-28 11:52:01 +00002347 //accept also nil as (error) return value for writing to LastTx
2348 // - this avoids misinterpretation of new received OMCI messages
mpagenko01e726e2020-10-23 09:45:29 +00002349 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002350 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002351
2352 //verify response
ozgecanetsiab36ed572021-04-01 10:38:48 +03002353 err = oFsm.waitforOmciResponse(ctx)
mpagenkodff5dda2020-08-28 11:52:01 +00002354 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002355 logger.Errorw(ctx, "Evtocd set priotagged->singletagged rule failed, aborting VlanConfig FSM!",
mpagenko01e726e2020-10-23 09:45:29 +00002356 log.Fields{"device-id": oFsm.deviceID})
Himani Chawla4d908332020-08-31 12:30:20 +05302357 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002358 return fmt.Errorf("evtocd set priotagged->singletagged rule failed %s, error %s", oFsm.deviceID, err)
2359
mpagenkodff5dda2020-08-28 11:52:01 +00002360 }
2361 } //just for local var's
2362 }
2363 }
2364
mpagenkofc4f56e2020-11-04 17:17:49 +00002365 // if Config has been done for all EVTOCD entries let the FSM proceed
dbainbri4d3a0dc2020-12-02 00:33:42 +00002366 logger.Debugw(ctx, "EVTOCD set loop finished", log.Fields{"device-id": oFsm.deviceID})
mpagenkof1d21d12021-06-11 13:14:45 +00002367 oFsm.mutexFlowParams.Lock()
mpagenko01e726e2020-10-23 09:45:29 +00002368 oFsm.configuredUniFlow++ // one (more) flow configured
mpagenkof1d21d12021-06-11 13:14:45 +00002369 oFsm.mutexFlowParams.Unlock()
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002370 return nil
mpagenkodff5dda2020-08-28 11:52:01 +00002371}
2372
dbainbri4d3a0dc2020-12-02 00:33:42 +00002373func (oFsm *UniVlanConfigFsm) removeEvtocdEntries(ctx context.Context, aRuleParams uniVlanRuleParams) {
mpagenkof1d21d12021-06-11 13:14:45 +00002374 oFsm.mutexFlowParams.RLock()
2375 evtocdID := oFsm.evtocdID
2376 oFsm.mutexFlowParams.RUnlock()
2377
mpagenko01e726e2020-10-23 09:45:29 +00002378 // configured Input/Output TPID is not modified again - no influence if no filter is applied
2379 if aRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
2380 //transparent transmission was set
2381 //perhaps the config is not needed for removal,
2382 // but the specific InnerTpid setting is removed in favor of the real default forwarding rule
dbainbri4d3a0dc2020-12-02 00:33:42 +00002383 logger.Debugw(ctx, "UniVlanConfigFsm Tx Set::EVTOCD reset to default single tagged rule", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00002384 "device-id": oFsm.deviceID})
2385 sliceEvtocdRule := make([]uint8, 16)
2386 // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
2387 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
2388 cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
2389 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
2390 cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
2391
2392 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
2393 cPrioDefaultFilter<<cFilterPrioOffset| // default inner-tag rule
2394 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on inner vid
2395 cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
2396 cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
2397
2398 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:],
2399 0<<cTreatTTROffset| // Do not pop any tags
2400 cDoNotAddPrio<<cTreatPrioOffset| // do not add outer tag
2401 cDontCareVid<<cTreatVidOffset| // Outer VID don't care
2402 cDontCareTpid<<cTreatTpidOffset) // Outer TPID field don't care
2403
2404 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
2405 cDoNotAddPrio<<cTreatPrioOffset| // do not add inner tag
2406 cDontCareVid<<cTreatVidOffset| // Outer VID don't care
2407 cDontCareTpid<<cTreatTpidOffset) // copy TPID and DEI
2408
2409 meParams := me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002410 EntityID: evtocdID,
mpagenko01e726e2020-10-23 09:45:29 +00002411 Attributes: me.AttributeValueMap{
2412 "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
2413 },
2414 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002415 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002416 meInstance, err := oFsm.pOmciCC.sendSetEvtocdVar(log.WithSpanFromContext(context.TODO(), ctx),
2417 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
mpagenko01e726e2020-10-23 09:45:29 +00002418 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002419 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002420 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002421 logger.Errorw(ctx, "SetEvtocdVar set failed, aborting UniVlanConfigFsm!",
2422 log.Fields{"device-id": oFsm.deviceID})
2423 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2424 return
2425 }
mpagenko01e726e2020-10-23 09:45:29 +00002426 //accept also nil as (error) return value for writing to LastTx
2427 // - this avoids misinterpretation of new received OMCI messages
2428 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002429 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenko01e726e2020-10-23 09:45:29 +00002430
2431 //verify response
ozgecanetsiab36ed572021-04-01 10:38:48 +03002432 err = oFsm.waitforOmciResponse(ctx)
mpagenko01e726e2020-10-23 09:45:29 +00002433 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002434 logger.Errorw(ctx, "Evtocd reset singletagged rule failed, aborting VlanConfig FSM!",
mpagenko01e726e2020-10-23 09:45:29 +00002435 log.Fields{"device-id": oFsm.deviceID})
2436 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2437 return
2438 }
2439 } else {
2440 // according to py-code acceptIncrementalEvto program option decides upon stacking or translation scenario
mpagenkof1d21d12021-06-11 13:14:45 +00002441 oFsm.mutexFlowParams.RLock()
mpagenko01e726e2020-10-23 09:45:29 +00002442 if oFsm.acceptIncrementalEvtoOption {
mpagenkof1d21d12021-06-11 13:14:45 +00002443 oFsm.mutexFlowParams.RUnlock()
mpagenko01e726e2020-10-23 09:45:29 +00002444 // this defines VID translation scenario: singletagged->singletagged (if not transparent)
dbainbri4d3a0dc2020-12-02 00:33:42 +00002445 logger.Debugw(ctx, "UniVlanConfigFsm Tx Set::EVTOCD clear single tagged translation rule", log.Fields{
mpagenko01e726e2020-10-23 09:45:29 +00002446 "device-id": oFsm.deviceID, "match-vlan": aRuleParams.MatchVid})
2447 sliceEvtocdRule := make([]uint8, 16)
2448 // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
2449 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
2450 cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
2451 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
2452 cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
2453
2454 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
2455 aRuleParams.MatchPcp<<cFilterPrioOffset| // either DNFonPrio or ignore tag (default) on innerVLAN
2456 aRuleParams.MatchVid<<cFilterVidOffset| // either DNFonVid or real filter VID
2457 cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
2458 cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
2459
2460 // delete indication for the indicated Filter
2461 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:], 0xFFFFFFFF)
2462 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:], 0xFFFFFFFF)
2463
2464 meParams := me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002465 EntityID: evtocdID,
mpagenko01e726e2020-10-23 09:45:29 +00002466 Attributes: me.AttributeValueMap{
2467 "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
2468 },
2469 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002470 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002471 meInstance, err := oFsm.pOmciCC.sendSetEvtocdVar(log.WithSpanFromContext(context.TODO(), ctx),
2472 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
mpagenko01e726e2020-10-23 09:45:29 +00002473 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002474 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002475 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002476 logger.Errorw(ctx, "SetEvtocdVar set failed, aborting UniVlanConfigFsm!",
2477 log.Fields{"device-id": oFsm.deviceID})
2478 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2479 return
2480 }
mpagenko01e726e2020-10-23 09:45:29 +00002481 //accept also nil as (error) return value for writing to LastTx
2482 // - this avoids misinterpretation of new received OMCI messages
2483 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002484 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenko01e726e2020-10-23 09:45:29 +00002485
2486 //verify response
ozgecanetsiab36ed572021-04-01 10:38:48 +03002487 err = oFsm.waitforOmciResponse(ctx)
mpagenko01e726e2020-10-23 09:45:29 +00002488 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002489 logger.Errorw(ctx, "Evtocd clear singletagged translation rule failed, aborting VlanConfig FSM!",
mpagenko01e726e2020-10-23 09:45:29 +00002490 log.Fields{"device-id": oFsm.deviceID, "match-vlan": aRuleParams.MatchVid})
2491 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2492 return
2493 }
2494 } else {
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002495 // VOL-3685
2496 // NOTE: With ALPHA ONUs it was seen that just resetting a particular entry in the EVTOCD table
2497 // and re-configuring a new entry would not work. The old entry is removed and new entry is created
2498 // indeed, but the traffic landing upstream would carry old vlan sometimes.
2499 // This is only a WORKAROUND which basically deletes the entire EVTOCD ME and re-creates it again
2500 // later when the flow is being re-installed.
2501 // Of course this is applicable to case only where single service (or single tcont) is in use and
2502 // there is only one service vlan (oFsm.acceptIncrementalEvtoOption is false in this case).
2503 // Interstingly this problem has not been observed in multi-tcont (or multi-service) scenario (in
2504 // which case the oFsm.acceptIncrementalEvtoOption is set to true).
mpagenkof1d21d12021-06-11 13:14:45 +00002505 if oFsm.configuredUniFlow == 1 && !oFsm.acceptIncrementalEvtoOption {
2506 oFsm.mutexFlowParams.RUnlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00002507 logger.Debugw(ctx, "UniVlanConfigFsm Tx Remove::EVTOCD", log.Fields{"device-id": oFsm.deviceID})
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002508 // When there are no more EVTOCD vlan configurations on the ONU and acceptIncrementalEvtoOption
2509 // is not enabled, delete the EVTOCD ME.
mpagenko01e726e2020-10-23 09:45:29 +00002510 meParams := me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002511 EntityID: evtocdID,
mpagenko01e726e2020-10-23 09:45:29 +00002512 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002513 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002514 meInstance, err := oFsm.pOmciCC.sendDeleteEvtocd(log.WithSpanFromContext(context.TODO(), ctx),
2515 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
mpagenko01e726e2020-10-23 09:45:29 +00002516 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002517 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002518 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002519 logger.Errorw(ctx, "DeleteEvtocdVar delete failed, aborting UniVlanConfigFsm!",
2520 log.Fields{"device-id": oFsm.deviceID})
2521 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2522 return
2523 }
mpagenko01e726e2020-10-23 09:45:29 +00002524 //accept also nil as (error) return value for writing to LastTx
2525 // - this avoids misinterpretation of new received OMCI messages
2526 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002527 oFsm.mutexPLastTxMeInstance.Unlock()
mpagenko01e726e2020-10-23 09:45:29 +00002528
2529 //verify response
ozgecanetsiab36ed572021-04-01 10:38:48 +03002530 err = oFsm.waitforOmciResponse(ctx)
mpagenko01e726e2020-10-23 09:45:29 +00002531 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002532 logger.Errorw(ctx, "Evtocd delete rule failed, aborting VlanConfig FSM!",
mpagenko01e726e2020-10-23 09:45:29 +00002533 log.Fields{"device-id": oFsm.deviceID})
2534 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2535 return
2536 }
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002537 } else {
2538 // NOTE : We should ideally never ether this section when oFsm.acceptIncrementalEvtoOption is set to false
2539 // This is true for only ATT/DT workflow
dbainbri4d3a0dc2020-12-02 00:33:42 +00002540 logger.Debugw(ctx, "UniVlanConfigFsm: Remove EVTOCD set operation",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002541 log.Fields{"configured-flow": oFsm.configuredUniFlow, "incremental-evto": oFsm.acceptIncrementalEvtoOption})
mpagenkof1d21d12021-06-11 13:14:45 +00002542 oFsm.mutexFlowParams.RUnlock()
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002543 //not transparent and not acceptIncrementalEvtoOption: untagged/priotagged->singletagged
2544 { // just for local var's
2545 // this defines stacking scenario: untagged->singletagged
2546 //TODO!! in theory there could be different rules running in setting different PCP/VID'S
2547 // for untagged/priotagged, last rule wins (and remains the only one), maybe that should be
2548 // checked already at flow-add (and rejected) - to be observed if such is possible in Voltha
2549 // delete now assumes there is only one such rule!
dbainbri4d3a0dc2020-12-02 00:33:42 +00002550 logger.Debugw(ctx, "UniVlanConfigFsm Tx Set::EVTOCD reset untagged rule to default", log.Fields{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002551 "device-id": oFsm.deviceID})
2552 sliceEvtocdRule := make([]uint8, 16)
2553 // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
2554 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
2555 cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
2556 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
2557 cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
mpagenko01e726e2020-10-23 09:45:29 +00002558
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002559 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
2560 cPrioIgnoreTag<<cFilterPrioOffset| // Not an inner-tag rule
2561 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on inner vid
2562 cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
2563 cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
mpagenko01e726e2020-10-23 09:45:29 +00002564
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002565 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:],
2566 0<<cTreatTTROffset| // Do not pop any tags
2567 cDoNotAddPrio<<cTreatPrioOffset| // do not add outer tag
2568 cDontCareVid<<cTreatVidOffset| // Outer VID don't care
2569 cDontCareTpid<<cTreatTpidOffset) // Outer TPID field don't care
mpagenko01e726e2020-10-23 09:45:29 +00002570
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002571 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
2572 cDoNotAddPrio<<cTreatPrioOffset| // do not add inner tag
2573 cDontCareVid<<cTreatVidOffset| // Outer VID don't care
2574 cDontCareTpid<<cTreatTpidOffset) // copy TPID and DEI
mpagenko01e726e2020-10-23 09:45:29 +00002575
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002576 meParams := me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002577 EntityID: evtocdID,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002578 Attributes: me.AttributeValueMap{
2579 "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
2580 },
2581 }
Girish Gowdra754ffb12021-06-30 16:30:12 -07002582 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002583 meInstance, err := oFsm.pOmciCC.sendSetEvtocdVar(context.TODO(),
2584 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002585 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002586 if err != nil {
Girish Gowdra754ffb12021-06-30 16:30:12 -07002587 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002588 logger.Errorw(ctx, "SetEvtocdVar set failed, aborting UniVlanConfigFsm!",
2589 log.Fields{"device-id": oFsm.deviceID})
2590 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2591 return
2592 }
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002593 //accept also nil as (error) return value for writing to LastTx
2594 // - this avoids misinterpretation of new received OMCI messages
2595 oFsm.pLastTxMeInstance = meInstance
Girish Gowdra754ffb12021-06-30 16:30:12 -07002596 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002597
2598 //verify response
ozgecanetsiab36ed572021-04-01 10:38:48 +03002599 err = oFsm.waitforOmciResponse(ctx)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002600 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002601 logger.Errorw(ctx, "Evtocd reset untagged rule to default failed, aborting VlanConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002602 log.Fields{"device-id": oFsm.deviceID})
2603 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2604 return
2605 }
2606 } // just for local var's
2607 { // just for local var's
2608 // this defines 'stacking' scenario: priotagged->singletagged
dbainbri4d3a0dc2020-12-02 00:33:42 +00002609 logger.Debugw(ctx, "UniVlanConfigFsm Tx Set::EVTOCD delete priotagged rule", log.Fields{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002610 "device-id": oFsm.deviceID})
2611 sliceEvtocdRule := make([]uint8, 16)
2612 // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
2613 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
2614 cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
2615 cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
2616 cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
2617
2618 binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
2619 cPrioDoNotFilter<<cFilterPrioOffset| // Do not Filter on innerprio
2620 0<<cFilterVidOffset| // filter on inner vid 0 (prioTagged)
2621 cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
2622 cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
2623
2624 // delete indication for the indicated Filter
2625 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:], 0xFFFFFFFF)
2626 binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:], 0xFFFFFFFF)
2627
2628 meParams := me.ParamData{
mpagenkof1d21d12021-06-11 13:14:45 +00002629 EntityID: evtocdID,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002630 Attributes: me.AttributeValueMap{
2631 "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
2632 },
2633 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002634 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002635 meInstance, err := oFsm.pOmciCC.sendSetEvtocdVar(log.WithSpanFromContext(context.TODO(), ctx),
2636 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002637 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002638 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002639 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002640 logger.Errorw(ctx, "SetEvtocdVar set failed, aborting UniVlanConfigFsm!",
2641 log.Fields{"device-id": oFsm.deviceID})
2642 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2643 return
2644 }
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002645 //accept also nil as (error) return value for writing to LastTx
2646 // - this avoids misinterpretation of new received OMCI messages
2647 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002648 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002649
2650 //verify response
ozgecanetsiab36ed572021-04-01 10:38:48 +03002651 err = oFsm.waitforOmciResponse(ctx)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002652 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002653 logger.Errorw(ctx, "Evtocd delete priotagged rule failed, aborting VlanConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002654 log.Fields{"device-id": oFsm.deviceID})
2655 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2656 return
2657 }
mpagenko01e726e2020-10-23 09:45:29 +00002658 }
2659 } //just for local var's
2660 }
2661 }
mpagenkofc4f56e2020-11-04 17:17:49 +00002662 // if Config has been done for all EVTOCD entries let the FSM proceed
dbainbri4d3a0dc2020-12-02 00:33:42 +00002663 logger.Debugw(ctx, "EVTOCD filter remove loop finished", log.Fields{"device-id": oFsm.deviceID})
Girish Gowdra26a40922021-01-29 17:14:34 -08002664 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvRemFlowDone, aRuleParams.TpID)
mpagenko01e726e2020-10-23 09:45:29 +00002665}
2666
dbainbri4d3a0dc2020-12-02 00:33:42 +00002667func (oFsm *UniVlanConfigFsm) waitforOmciResponse(ctx context.Context) error {
mpagenko7d6bb022021-03-11 15:07:55 +00002668 oFsm.mutexIsAwaitingResponse.Lock()
mpagenkocf48e452021-04-23 09:23:00 +00002669 if oFsm.isCanceled {
2670 // FSM already canceled before entering wait
2671 logger.Debugw(ctx, "UniVlanConfigFsm wait-for-multi-entity-response aborted (on enter)", log.Fields{"for device-id": oFsm.deviceID})
2672 oFsm.mutexIsAwaitingResponse.Unlock()
2673 return fmt.Errorf(cErrWaitAborted)
2674 }
mpagenko7d6bb022021-03-11 15:07:55 +00002675 oFsm.isAwaitingResponse = true
2676 oFsm.mutexIsAwaitingResponse.Unlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002677 select {
Himani Chawla26e555c2020-08-31 12:30:20 +05302678 // maybe be also some outside cancel (but no context modeled for the moment ...)
mpagenkodff5dda2020-08-28 11:52:01 +00002679 // case <-ctx.Done():
dbainbri4d3a0dc2020-12-02 00:33:42 +00002680 // logger.Infow(ctx,"LockState-bridge-init message reception canceled", log.Fields{"for device-id": oFsm.deviceID})
Holger Hildebrandt366ef192021-05-05 11:07:44 +00002681 case <-time.After(oFsm.pOmciCC.GetMaxOmciTimeoutWithRetries() * time.Second): //AS FOR THE OTHER OMCI FSM's
dbainbri4d3a0dc2020-12-02 00:33:42 +00002682 logger.Warnw(ctx, "UniVlanConfigFsm multi entity timeout", log.Fields{"for device-id": oFsm.deviceID})
mpagenko7d6bb022021-03-11 15:07:55 +00002683 oFsm.mutexIsAwaitingResponse.Lock()
2684 oFsm.isAwaitingResponse = false
2685 oFsm.mutexIsAwaitingResponse.Unlock()
mpagenko01e726e2020-10-23 09:45:29 +00002686 return fmt.Errorf("uniVlanConfigFsm multi entity timeout %s", oFsm.deviceID)
mpagenkodff5dda2020-08-28 11:52:01 +00002687 case success := <-oFsm.omciMIdsResponseReceived:
Himani Chawla4d908332020-08-31 12:30:20 +05302688 if success {
mpagenkocf48e452021-04-23 09:23:00 +00002689 logger.Debugw(ctx, "UniVlanConfigFsm multi entity response received", log.Fields{"for device-id": oFsm.deviceID})
mpagenko7d6bb022021-03-11 15:07:55 +00002690 oFsm.mutexIsAwaitingResponse.Lock()
2691 oFsm.isAwaitingResponse = false
2692 oFsm.mutexIsAwaitingResponse.Unlock()
mpagenkodff5dda2020-08-28 11:52:01 +00002693 return nil
2694 }
mpagenko7d6bb022021-03-11 15:07:55 +00002695 // waiting was aborted (probably on external request)
mpagenkocf48e452021-04-23 09:23:00 +00002696 logger.Debugw(ctx, "UniVlanConfigFsm wait-for-multi-entity-response aborted", log.Fields{"for device-id": oFsm.deviceID})
mpagenko7d6bb022021-03-11 15:07:55 +00002697 oFsm.mutexIsAwaitingResponse.Lock()
2698 oFsm.isAwaitingResponse = false
2699 oFsm.mutexIsAwaitingResponse.Unlock()
2700 return fmt.Errorf(cErrWaitAborted)
mpagenkodff5dda2020-08-28 11:52:01 +00002701 }
2702}
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002703
mpagenko551a4d42020-12-08 18:09:20 +00002704func (oFsm *UniVlanConfigFsm) performSettingMulticastME(ctx context.Context, tpID uint8, multicastGemPortID uint16, vlanID uint32) error {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002705 logger.Debugw(ctx, "Setting Multicast MEs", log.Fields{"device-id": oFsm.deviceID, "tpID": tpID,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002706 "multicastGemPortID": multicastGemPortID, "vlanID": vlanID})
dbainbri4d3a0dc2020-12-02 00:33:42 +00002707 errCreateMOP := oFsm.performCreatingMulticastOperationProfile(ctx)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002708 if errCreateMOP != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002709 logger.Errorw(ctx, "MulticastOperationProfile create failed, aborting AniConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002710 log.Fields{"device-id": oFsm.deviceID})
mpagenko9a304ea2020-12-16 15:54:01 +00002711 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002712 return fmt.Errorf("creatingMulticastSubscriberConfigInfo responseError %s, error %s", oFsm.deviceID, errCreateMOP)
2713 }
2714
dbainbri4d3a0dc2020-12-02 00:33:42 +00002715 errSettingMOP := oFsm.performSettingMulticastOperationProfile(ctx, multicastGemPortID, vlanID)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002716 if errSettingMOP != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002717 logger.Errorw(ctx, "MulticastOperationProfile setting failed, aborting AniConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002718 log.Fields{"device-id": oFsm.deviceID})
mpagenko9a304ea2020-12-16 15:54:01 +00002719 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002720 return fmt.Errorf("creatingMulticastSubscriberConfigInfo responseError %s, error %s", oFsm.deviceID, errSettingMOP)
2721 }
2722
dbainbri4d3a0dc2020-12-02 00:33:42 +00002723 errCreateMSCI := oFsm.performCreatingMulticastSubscriberConfigInfo(ctx)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002724 if errCreateMSCI != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002725 logger.Errorw(ctx, "MulticastOperationProfile setting failed, aborting AniConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002726 log.Fields{"device-id": oFsm.deviceID})
mpagenko9a304ea2020-12-16 15:54:01 +00002727 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002728 return fmt.Errorf("creatingMulticastSubscriberConfigInfo responseError %s, error %s", oFsm.deviceID, errCreateMSCI)
2729 }
Mahir Gunyel6781f962021-05-16 23:30:08 -07002730 macBpCdEID, errMacBpCdEID := generateMcastANISideMBPCDEID(uint16(oFsm.pOnuUniPort.macBpNo))
2731 if errMacBpCdEID != nil {
2732 logger.Errorw(ctx, "MulticastMacBridgePortConfigData entity id generation failed, aborting AniConfig FSM!",
2733 log.Fields{"device-id": oFsm.deviceID})
2734 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2735 return fmt.Errorf("generateMcastANISideMBPCDEID responseError %s, error %s", oFsm.deviceID, errMacBpCdEID)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002736
Mahir Gunyel6781f962021-05-16 23:30:08 -07002737 }
2738 logger.Debugw(ctx, "UniVlanConfigFsm set macBpCdEID for mcast", log.Fields{
2739 "EntitytId": strconv.FormatInt(int64(macBpCdEID), 16), "macBpNo": oFsm.pOnuUniPort.macBpNo,
2740 "in state": oFsm.pAdaptFsm.pFsm.Current(), "device-id": oFsm.deviceID})
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002741 meParams := me.ParamData{
Mahir Gunyel6781f962021-05-16 23:30:08 -07002742 EntityID: macBpCdEID,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002743 Attributes: me.AttributeValueMap{
2744 "BridgeIdPointer": macBridgeServiceProfileEID + uint16(oFsm.pOnuUniPort.macBpNo),
2745 "PortNum": 0xf0, //fixed unique ANI side indication
2746 "TpType": 6, //MCGemIWTP
2747 "TpPointer": multicastGemPortID,
2748 },
2749 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002750 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002751 meInstance, err := oFsm.pOmciCC.sendCreateMBPConfigDataVar(context.TODO(),
2752 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true, oFsm.pAdaptFsm.commChan, meParams)
2753 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002754 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002755 logger.Errorw(ctx, "MBPConfigDataVar create failed, aborting AniConfig FSM!",
2756 log.Fields{"device-id": oFsm.deviceID})
2757 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2758 return fmt.Errorf("creatingMulticastSubscriberConfigInfo createError #{oFsm.deviceID}, error #{err}")
2759 }
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002760 //accept also nil as (error) return value for writing to LastTx
2761 // - this avoids misinterpretation of new received OMCI messages
2762 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002763 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002764 err = oFsm.waitforOmciResponse(ctx)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002765 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002766 logger.Errorw(ctx, "CreateMBPConfigData failed, aborting AniConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002767 log.Fields{"device-id": oFsm.deviceID, "MBPConfigDataID": macBridgeServiceProfileEID})
mpagenko9a304ea2020-12-16 15:54:01 +00002768 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002769 return fmt.Errorf("creatingMulticastSubscriberConfigInfo responseError %s, error %s", oFsm.deviceID, err)
2770 }
2771
2772 // ==> Start creating VTFD for mcast vlan
2773
2774 // This attribute uniquely identifies each instance of this managed entity. Through an identical ID,
2775 // this managed entity is implicitly linked to an instance of the MAC bridge port configuration data ME.
Mahir Gunyel6781f962021-05-16 23:30:08 -07002776 mcastVtfdID := macBpCdEID
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002777
dbainbri4d3a0dc2020-12-02 00:33:42 +00002778 logger.Debugw(ctx, "UniVlanConfigFsm set VTFD for mcast", log.Fields{
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002779 "EntitytId": strconv.FormatInt(int64(mcastVtfdID), 16), "mcastVlanID": vlanID,
2780 "in state": oFsm.pAdaptFsm.pFsm.Current(), "device-id": oFsm.deviceID})
2781 vtfdFilterList := make([]uint16, cVtfdTableSize) //needed for parameter serialization
2782
2783 // FIXME: VOL-3685: Issues with resetting a table entry in EVTOCD ME
2784 // VTFD has to be created afresh with a new entity ID that has the same entity ID as the MBPCD ME for every
2785 // new vlan associated with a different TP.
2786 vtfdFilterList[0] = uint16(vlanID)
2787
2788 meParams = me.ParamData{
2789 EntityID: mcastVtfdID,
2790 Attributes: me.AttributeValueMap{
2791 "VlanFilterList": vtfdFilterList,
2792 "ForwardOperation": uint8(0x10), //VID investigation
2793 "NumberOfEntries": oFsm.numVlanFilterEntries,
2794 },
2795 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002796 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002797 meInstance, err = oFsm.pOmciCC.sendCreateVtfdVar(context.TODO(),
2798 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true, oFsm.pAdaptFsm.commChan, meParams)
2799 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002800 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002801 logger.Errorw(ctx, "CreateVtfdVar create failed, aborting UniVlanConfigFsm!",
2802 log.Fields{"device-id": oFsm.deviceID})
2803 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2804 return fmt.Errorf("createMcastVlanFilterData creationError %s, error %s", oFsm.deviceID, err)
2805 }
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002806 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002807 oFsm.mutexPLastTxMeInstance.Unlock()
dbainbri4d3a0dc2020-12-02 00:33:42 +00002808 err = oFsm.waitforOmciResponse(ctx)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002809 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002810 logger.Errorw(ctx, "CreateMcastVlanFilterData failed, aborting AniConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002811 log.Fields{"device-id": oFsm.deviceID, "mcastVtfdID": mcastVtfdID})
mpagenko9a304ea2020-12-16 15:54:01 +00002812 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002813 return fmt.Errorf("createMcastVlanFilterData responseError %s, error %s", oFsm.deviceID, err)
2814 }
2815
2816 return nil
2817}
2818
dbainbri4d3a0dc2020-12-02 00:33:42 +00002819func (oFsm *UniVlanConfigFsm) performCreatingMulticastSubscriberConfigInfo(ctx context.Context) error {
Mahir Gunyel6781f962021-05-16 23:30:08 -07002820 instID, err := generateUNISideMBPCDEID(uint16(oFsm.pOnuUniPort.macBpNo))
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002821 if err != nil {
Mahir Gunyel6781f962021-05-16 23:30:08 -07002822 logger.Errorw(ctx, "error generrating me instance id",
2823 log.Fields{"device-id": oFsm.deviceID, "error": err})
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002824 return err
2825 }
Mahir Gunyel6781f962021-05-16 23:30:08 -07002826 logger.Debugw(ctx, "UniVlanConfigFsm create MulticastSubscriberConfigInfo",
2827 log.Fields{"device-id": oFsm.deviceID, "EntityId": instID})
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002828 meParams := me.ParamData{
2829 EntityID: instID,
2830 Attributes: me.AttributeValueMap{
2831 "MeType": 0,
2832 //Direct reference to the Operation profile
2833 //TODO ANI side used on UNI side, not the clearest option.
ozgecanetsia5c88b762021-03-23 10:27:15 +03002834 "MulticastOperationsProfilePointer": instID,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002835 },
2836 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002837 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002838 meInstance, err := oFsm.pOmciCC.sendCreateMulticastSubConfigInfoVar(context.TODO(),
2839 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002840 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002841 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002842 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002843 logger.Errorw(ctx, "CreateMulticastSubConfigInfoVar create failed, aborting UniVlanConfigFSM!",
2844 log.Fields{"device-id": oFsm.deviceID})
2845 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2846 return fmt.Errorf("creatingMulticastSubscriberConfigInfo interface creationError %s, error %s",
2847 oFsm.deviceID, err)
2848 }
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002849 //accept also nil as (error) return value for writing to LastTx
2850 // - this avoids misinterpretation of new received OMCI messages
2851 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002852 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002853 //verify response
dbainbri4d3a0dc2020-12-02 00:33:42 +00002854 err = oFsm.waitforOmciResponse(ctx)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002855 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002856 logger.Errorw(ctx, "CreateMulticastSubConfigInfo create failed, aborting AniConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002857 log.Fields{"device-id": oFsm.deviceID, "MulticastSubConfigInfo": instID})
2858 return fmt.Errorf("creatingMulticastSubscriberConfigInfo responseError %s", oFsm.deviceID)
2859 }
2860 return nil
2861}
2862
dbainbri4d3a0dc2020-12-02 00:33:42 +00002863func (oFsm *UniVlanConfigFsm) performCreatingMulticastOperationProfile(ctx context.Context) error {
ozgecanetsia72e1c9f2021-05-26 17:26:29 +03002864 instID, err := generateUNISideMBPCDEID(uint16(oFsm.pOnuUniPort.macBpNo))
ozgecanetsia5c88b762021-03-23 10:27:15 +03002865 if err != nil {
ozgecanetsia72e1c9f2021-05-26 17:26:29 +03002866 logger.Errorw(ctx, "error generating me instance id",
2867 log.Fields{"device-id": oFsm.deviceID, "error": err})
ozgecanetsia5c88b762021-03-23 10:27:15 +03002868 return err
2869 }
Mahir Gunyel6781f962021-05-16 23:30:08 -07002870 logger.Debugw(ctx, "UniVlanConfigFsm create MulticastOperationProfile",
2871 log.Fields{"device-id": oFsm.deviceID, "EntityId": instID})
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002872 meParams := me.ParamData{
2873 EntityID: instID,
2874 Attributes: me.AttributeValueMap{
2875 "IgmpVersion": 2,
2876 "IgmpFunction": 0,
2877 //0 means false
2878 "ImmediateLeave": 0,
2879 "Robustness": 2,
2880 "QuerierIp": 0,
2881 "QueryInterval": 125,
2882 "QuerierMaxResponseTime": 100,
2883 "LastMemberResponseTime": 10,
2884 //0 means false
2885 "UnauthorizedJoinBehaviour": 0,
2886 },
2887 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002888 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002889 meInstance, err := oFsm.pOmciCC.sendCreateMulticastOperationProfileVar(context.TODO(),
2890 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002891 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002892 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002893 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002894 logger.Errorw(ctx, "CreateMulticastOperationProfileVar create failed, aborting UniVlanConfigFsm!",
2895 log.Fields{"device-id": oFsm.deviceID})
2896 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2897 return fmt.Errorf("createMulticastOperationProfileVar responseError %s, error %s", oFsm.deviceID, err)
2898 }
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002899 //accept also nil as (error) return value for writing to LastTx
2900 // - this avoids misinterpretation of new received OMCI messages
2901 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002902 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002903 //verify response
ozgecanetsia5c88b762021-03-23 10:27:15 +03002904 err = oFsm.waitforOmciResponse(ctx)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002905 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002906 logger.Errorw(ctx, "CreateMulticastOperationProfile create failed, aborting AniConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002907 log.Fields{"device-id": oFsm.deviceID, "MulticastOperationProfileID": instID})
ozgecanetsiab36ed572021-04-01 10:38:48 +03002908 return fmt.Errorf("createMulticastOperationProfile responseError %s, error %s", oFsm.deviceID, err)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002909 }
2910 return nil
2911}
2912
dbainbri4d3a0dc2020-12-02 00:33:42 +00002913func (oFsm *UniVlanConfigFsm) performSettingMulticastOperationProfile(ctx context.Context, multicastGemPortID uint16, vlanID uint32) error {
ozgecanetsia72e1c9f2021-05-26 17:26:29 +03002914 instID, err := generateUNISideMBPCDEID(uint16(oFsm.pOnuUniPort.macBpNo))
ozgecanetsia5c88b762021-03-23 10:27:15 +03002915 if err != nil {
ozgecanetsia72e1c9f2021-05-26 17:26:29 +03002916 logger.Errorw(ctx, "error generating me instance id",
2917 log.Fields{"device-id": oFsm.deviceID, "error": err})
ozgecanetsia5c88b762021-03-23 10:27:15 +03002918 return err
2919 }
Mahir Gunyel6781f962021-05-16 23:30:08 -07002920 logger.Debugw(ctx, "UniVlanConfigFsm set MulticastOperationProfile",
2921 log.Fields{"device-id": oFsm.deviceID, "EntityId": instID})
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002922 //TODO check that this is correct
2923 // Table control
2924 //setCtrl = 1
2925 //rowPartId = 0
2926 //test = 0
2927 //rowKey = 0
2928 tableCtrlStr := "0100000000000000"
2929 tableCtrl := AsByteSlice(tableCtrlStr)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002930 dynamicAccessCL := make([]uint8, 24)
2931 copy(dynamicAccessCL, tableCtrl)
2932 //Multicast GemPortId
2933 binary.BigEndian.PutUint16(dynamicAccessCL[2:], multicastGemPortID)
2934 // python version waits for installation of flows, see line 723 onward of
2935 // brcm_openomci_onu_handler.py
2936 binary.BigEndian.PutUint16(dynamicAccessCL[4:], uint16(vlanID))
2937 //Source IP all to 0
2938 binary.BigEndian.PutUint32(dynamicAccessCL[6:], IPToInt32(net.IPv4(0, 0, 0, 0)))
2939 //TODO start and end are hardcoded, get from TP
2940 // Destination IP address start of range
2941 binary.BigEndian.PutUint32(dynamicAccessCL[10:], IPToInt32(net.IPv4(225, 0, 0, 0)))
2942 // Destination IP address end of range
2943 binary.BigEndian.PutUint32(dynamicAccessCL[14:], IPToInt32(net.IPv4(239, 255, 255, 255)))
2944 //imputed group bandwidth
2945 binary.BigEndian.PutUint16(dynamicAccessCL[18:], 0)
2946
2947 meParams := me.ParamData{
2948 EntityID: instID,
2949 Attributes: me.AttributeValueMap{
2950 "DynamicAccessControlListTable": dynamicAccessCL,
2951 },
2952 }
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002953 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002954 meInstance, err := oFsm.pOmciCC.sendSetMulticastOperationProfileVar(context.TODO(),
2955 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true,
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002956 oFsm.pAdaptFsm.commChan, meParams)
ozgecanetsiab36ed572021-04-01 10:38:48 +03002957 if err != nil {
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002958 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab36ed572021-04-01 10:38:48 +03002959 logger.Errorw(ctx, "SetMulticastOperationProfileVar set failed, aborting UniVlanConfigFsm!",
2960 log.Fields{"device-id": oFsm.deviceID})
2961 _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
2962 return fmt.Errorf("setMulticastOperationProfile responseError %s, error %s", oFsm.deviceID, err)
2963 }
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002964 //accept also nil as (error) return value for writing to LastTx
2965 // - this avoids misinterpretation of new received OMCI messages
2966 oFsm.pLastTxMeInstance = meInstance
Holger Hildebrandt0da7e6f2021-05-12 13:08:43 +00002967 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002968 //verify response
ozgecanetsia5c88b762021-03-23 10:27:15 +03002969 err = oFsm.waitforOmciResponse(ctx)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002970 if err != nil {
dbainbri4d3a0dc2020-12-02 00:33:42 +00002971 logger.Errorw(ctx, "CreateMulticastOperationProfile create failed, aborting AniConfig FSM!",
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002972 log.Fields{"device-id": oFsm.deviceID, "MulticastOperationProfileID": instID})
ozgecanetsiab36ed572021-04-01 10:38:48 +03002973 return fmt.Errorf("createMulticastOperationProfile responseError %s, error %s", oFsm.deviceID, err)
ozgecanetsiab5000ef2020-11-27 14:38:20 +03002974 }
2975 return nil
2976}
Girish Gowdra26a40922021-01-29 17:14:34 -08002977
ozgecanetsia82b91a62021-05-21 18:54:49 +03002978func (oFsm *UniVlanConfigFsm) createTrafficDescriptor(ctx context.Context, aMeter *voltha.OfpMeterConfig,
2979 tpID uint8, uniID uint8, gemPortID uint16) error {
2980 logger.Infow(ctx, "Starting create traffic descriptor", log.Fields{"device-id": oFsm.deviceID, "uniID": uniID, "tpID": tpID})
2981 // uniTPKey generate id to Traffic Descriptor ME. We need to create two of them. They should be unique. Because of that
2982 // I created unique TD ID by flow direction.
2983 // TODO! Traffic descriptor ME ID will check
2984 trafficDescriptorID := gemPortID
2985 if aMeter == nil {
2986 return fmt.Errorf("meter not found %s", oFsm.deviceID)
2987 }
2988 trafficShapingInfo, err := meters.GetTrafficShapingInfo(ctx, aMeter)
2989 if err != nil {
2990 logger.Errorw(ctx, "Traffic Shaping Info get failed", log.Fields{"device-id": oFsm.deviceID})
2991 return err
2992 }
2993 cir := trafficShapingInfo.Cir + trafficShapingInfo.Gir
2994 cbs := trafficShapingInfo.Cbs
2995 pir := trafficShapingInfo.Pir
2996 pbs := trafficShapingInfo.Pbs
2997
2998 logger.Infow(ctx, "cir-pir-cbs-pbs", log.Fields{"device-id": oFsm.deviceID, "cir": cir, "pir": pir, "cbs": cbs, "pbs": pbs})
2999 meParams := me.ParamData{
3000 EntityID: trafficDescriptorID,
3001 Attributes: me.AttributeValueMap{
3002 "Cir": cir,
3003 "Pir": pir,
3004 "Cbs": cbs,
3005 "Pbs": pbs,
3006 "ColourMode": 1,
3007 "IngressColourMarking": 3,
3008 "EgressColourMarking": 3,
3009 "MeterType": 1,
3010 },
3011 }
Girish Gowdra754ffb12021-06-30 16:30:12 -07003012 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsia82b91a62021-05-21 18:54:49 +03003013 meInstance, errCreateTD := oFsm.pOmciCC.sendCreateTDVar(log.WithSpanFromContext(context.TODO(), ctx), oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout,
3014 true, oFsm.pAdaptFsm.commChan, meParams)
3015 if errCreateTD != nil {
Girish Gowdra754ffb12021-06-30 16:30:12 -07003016 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsia82b91a62021-05-21 18:54:49 +03003017 logger.Errorw(ctx, "Traffic Descriptor create failed", log.Fields{"device-id": oFsm.deviceID})
3018 return err
3019 }
3020 oFsm.pLastTxMeInstance = meInstance
Girish Gowdra754ffb12021-06-30 16:30:12 -07003021 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsia82b91a62021-05-21 18:54:49 +03003022 err = oFsm.waitforOmciResponse(ctx)
3023 if err != nil {
3024 logger.Errorw(ctx, "Traffic Descriptor create failed, aborting VlanConfig FSM!", log.Fields{"device-id": oFsm.deviceID})
3025 return err
3026 }
3027
3028 err = oFsm.setTrafficDescriptorToGemPortNWCTP(ctx, gemPortID)
3029 if err != nil {
3030 logger.Errorw(ctx, "Traffic Descriptor set failed to Gem Port Network CTP, aborting VlanConfig FSM!", log.Fields{"device-id": oFsm.deviceID})
3031 return err
3032 }
3033 logger.Infow(ctx, "Set TD Info to GemPortNWCTP successfully", log.Fields{"device-id": oFsm.deviceID, "gem-port-id": gemPortID, "td-id": trafficDescriptorID})
3034
3035 return nil
3036}
3037
3038func (oFsm *UniVlanConfigFsm) setTrafficDescriptorToGemPortNWCTP(ctx context.Context, gemPortID uint16) error {
3039 logger.Debugw(ctx, "Starting Set Traffic Descriptor to GemPortNWCTP", log.Fields{"device-id": oFsm.deviceID, "gem-port-id": gemPortID})
3040 meParams := me.ParamData{
3041 EntityID: gemPortID,
3042 Attributes: me.AttributeValueMap{
3043 "TrafficManagementPointerForUpstream": gemPortID,
3044 },
3045 }
Girish Gowdra754ffb12021-06-30 16:30:12 -07003046 oFsm.mutexPLastTxMeInstance.Lock()
ozgecanetsia82b91a62021-05-21 18:54:49 +03003047 meInstance, err := oFsm.pOmciCC.sendSetGemNCTPVar(log.WithSpanFromContext(context.TODO(), ctx),
3048 oFsm.pDeviceHandler.pOpenOnuAc.omciTimeout, true, oFsm.pAdaptFsm.commChan, meParams)
3049 if err != nil {
Girish Gowdra754ffb12021-06-30 16:30:12 -07003050 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsia82b91a62021-05-21 18:54:49 +03003051 logger.Errorw(ctx, "GemNCTP set failed", log.Fields{"device-id": oFsm.deviceID})
3052 return err
3053 }
3054 oFsm.pLastTxMeInstance = meInstance
Girish Gowdra754ffb12021-06-30 16:30:12 -07003055 oFsm.mutexPLastTxMeInstance.Unlock()
ozgecanetsia82b91a62021-05-21 18:54:49 +03003056 err = oFsm.waitforOmciResponse(ctx)
3057 if err != nil {
3058 logger.Errorw(ctx, "Upstream Traffic Descriptor set failed, aborting VlanConfig FSM!", log.Fields{"device-id": oFsm.deviceID})
3059 return err
3060 }
3061 return nil
3062}
3063
Girish Gowdra26a40922021-01-29 17:14:34 -08003064// IsFlowRemovePending returns true if there are pending flows to remove, else false.
mpagenkobb47bc22021-04-20 13:29:09 +00003065func (oFsm *UniVlanConfigFsm) IsFlowRemovePending(aFlowDeleteChannel chan<- bool) bool {
3066 oFsm.mutexFlowParams.Lock()
3067 defer oFsm.mutexFlowParams.Unlock()
3068 if len(oFsm.uniRemoveFlowsSlice) > 0 {
3069 //flow removal is still ongoing/pending
3070 oFsm.signalOnFlowDelete = true
3071 oFsm.flowDeleteChannel = aFlowDeleteChannel
3072 return true
3073 }
3074 return false
Girish Gowdra26a40922021-01-29 17:14:34 -08003075}