[VOL-3437] Implement (incremental) flow config removal with according OMCI VLAN configuration and some further code corrections and smaller functional extensions -> version 0.1.13-dev135, now merged with [VOL-3586] und included correction for missing Techprofile configuration at disable/enable procedure
Signed-off-by: mpagenko <michael.pagenkopf@adtran.com>
Change-Id: I438a72867d5da83c505a30169d7d5aba8f8ee8c2
diff --git a/internal/pkg/onuadaptercore/omci_vlan_config.go b/internal/pkg/onuadaptercore/omci_vlan_config.go
index cda4905..b8605e0 100644
--- a/internal/pkg/onuadaptercore/omci_vlan_config.go
+++ b/internal/pkg/onuadaptercore/omci_vlan_config.go
@@ -25,6 +25,7 @@
"sync"
"time"
+ gp "github.com/google/gopacket"
"github.com/looplab/fsm"
"github.com/opencord/omci-lib-go"
me "github.com/opencord/omci-lib-go/generated"
@@ -36,7 +37,8 @@
// internal predefined values
cDefaultDownstreamMode = 0
cDefaultTpid = 0x8100
- cMaxAllowedFlows = 12 //which might be under discussion, for the moment connected to limit of VLAN's within VTFD
+ cVtfdTableSize = 12 //as per G.988
+ cMaxAllowedFlows = cVtfdTableSize //which might be under discussion, for the moment connected to limit of VLAN's within VTFD
)
const (
@@ -75,21 +77,22 @@
const (
// events of config PON ANI port FSM
- vlanEvStart = "vlanEvStart"
- vlanEvWaitTechProf = "vlanEvWaitTechProf"
- vlanEvContinueConfig = "vlanEvContinueConfig"
- vlanEvStartConfig = "vlanEvStartConfig"
- vlanEvRxConfigVtfd = "vlanEvRxConfigVtfd"
- vlanEvRxConfigEvtocd = "vlanEvRxConfigEvtocd"
- vlanEvIncrFlowConfig = "vlanEvIncrFlowConfig"
- //vlanEvCleanupConfig = "vlanEvCleanupConfig"
- //vlanEvRxCleanVtfd = "vlanEvRxCleanVtfd"
- //vlanEvRxCleanEvtocd = "vlanEvRxCleanEvtocd"
+ vlanEvStart = "vlanEvStart"
+ vlanEvWaitTechProf = "vlanEvWaitTechProf"
+ vlanEvContinueConfig = "vlanEvContinueConfig"
+ vlanEvStartConfig = "vlanEvStartConfig"
+ vlanEvRxConfigVtfd = "vlanEvRxConfigVtfd"
+ vlanEvRxConfigEvtocd = "vlanEvRxConfigEvtocd"
+ vlanEvIncrFlowConfig = "vlanEvIncrFlowConfig"
+ vlanEvRemFlowConfig = "vlanEvRemFlowConfig"
+ vlanEvRemFlowDone = "vlanEvRemFlowDone"
+ vlanEvFlowDataRemoved = "vlanEvFlowDataRemoved"
//vlanEvTimeoutSimple = "vlanEvTimeoutSimple"
//vlanEvTimeoutMids = "vlanEvTimeoutMids"
vlanEvReset = "vlanEvReset"
vlanEvRestart = "vlanEvRestart"
)
+
const (
// states of config PON ANI port FSM
vlanStDisabled = "vlanStDisabled"
@@ -99,15 +102,34 @@
vlanStConfigEvtocd = "vlanStConfigEvtocd"
vlanStConfigDone = "vlanStConfigDone"
vlanStConfigIncrFlow = "vlanStConfigIncrFlow"
- vlanStCleanEvtocd = "vlanStCleanEvtocd"
- vlanStCleanVtfd = "vlanStCleanVtfd"
+ vlanStRemoveFlow = "vlanStRemoveFlow"
vlanStCleanupDone = "vlanStCleanupDone"
vlanStResetting = "vlanStResetting"
)
+type uniVlanRuleParams struct {
+ TpID uint16 `json:"tp_id"`
+ MatchVid uint32 `json:"match_vid"` //use uint32 types for allowing immediate bitshifting
+ MatchPcp uint32 `json:"match_pcp"`
+ TagsToRemove uint32 `json:"tags_to_remove"`
+ SetVid uint32 `json:"set_vid"`
+ SetPcp uint32 `json:"set_pcp"`
+}
+
+type uniVlanFlowParams struct {
+ CookieSlice []uint64 `json:"cookie_slice"`
+ VlanRuleParams uniVlanRuleParams `json:"vlan_rule_params"`
+}
+
+type uniRemoveVlanFlowParams struct {
+ cookie uint64 //just the last cookie valid for removal
+ vlanRuleParams uniVlanRuleParams
+}
+
//UniVlanConfigFsm defines the structure for the state machine to config the PON ANI ports of ONU UNI ports via OMCI
type UniVlanConfigFsm struct {
pDeviceHandler *deviceHandler
+ deviceID string
pOmciCC *omciCC
pOnuUniPort *onuUniPort
pUniTechProf *onuUniTechProf
@@ -118,22 +140,27 @@
pAdaptFsm *AdapterFsm
acceptIncrementalEvtoOption bool
mutexFlowParams sync.Mutex
- uniFlowParamsSlice []uniVlanFlowParams
+ uniVlanFlowParamsSlice []uniVlanFlowParams
+ uniRemoveFlowsSlice []uniRemoveVlanFlowParams
numUniFlows uint8 // expected number of flows should be less than 12
configuredUniFlow uint8
+ numRemoveFlows uint8
numVlanFilterEntries uint8
- vlanFilterList [12]uint16
+ vlanFilterList [cVtfdTableSize]uint16
vtfdID uint16
evtocdID uint16
+ pLastTxMeInstance *me.ManagedEntity
}
-//NewUniVlanConfigFsm is the 'constructor' for the state machine to config the PON ANI ports of ONU UNI ports via OMCI
-func NewUniVlanConfigFsm(apDeviceHandler *deviceHandler, apDevOmciCC *omciCC, apUniPort *onuUniPort, apUniTechProf *onuUniTechProf,
- apOnuDB *onuDeviceDB, aTechProfileID uint16, aRequestEvent OnuDeviceEvent, aName string,
- aDeviceID string, aCommChannel chan Message,
- aAcceptIncrementalEvto bool, aMatchVlan uint16, aSetVlan uint16, aSetPcp uint8) *UniVlanConfigFsm {
+//NewUniVlanConfigFsm is the 'constructor' for the state machine to config the PON ANI ports
+// of ONU UNI ports via OMCI
+func NewUniVlanConfigFsm(apDeviceHandler *deviceHandler, apDevOmciCC *omciCC, apUniPort *onuUniPort,
+ apUniTechProf *onuUniTechProf, apOnuDB *onuDeviceDB, aTechProfileID uint16,
+ aRequestEvent OnuDeviceEvent, aName string, aCommChannel chan Message, aAcceptIncrementalEvto bool,
+ aCookieSlice []uint64, aMatchVlan uint16, aSetVlan uint16, aSetPcp uint8) *UniVlanConfigFsm {
instFsm := &UniVlanConfigFsm{
pDeviceHandler: apDeviceHandler,
+ deviceID: apDeviceHandler.deviceID,
pOmciCC: apDevOmciCC,
pOnuUniPort: apUniPort,
pUniTechProf: apUniTechProf,
@@ -143,12 +170,13 @@
acceptIncrementalEvtoOption: aAcceptIncrementalEvto,
numUniFlows: 0,
configuredUniFlow: 0,
+ numRemoveFlows: 0,
}
- instFsm.pAdaptFsm = NewAdapterFsm(aName, aDeviceID, aCommChannel)
+ instFsm.pAdaptFsm = NewAdapterFsm(aName, instFsm.deviceID, aCommChannel)
if instFsm.pAdaptFsm == nil {
logger.Errorw("UniVlanConfigFsm's AdapterFsm could not be instantiated!!", log.Fields{
- "device-id": aDeviceID})
+ "device-id": instFsm.deviceID})
return nil
}
instFsm.pAdaptFsm.pFsm = fsm.NewFSM(
@@ -162,6 +190,9 @@
{Name: vlanEvRxConfigEvtocd, Src: []string{vlanStConfigEvtocd, vlanStConfigIncrFlow},
Dst: vlanStConfigDone},
{Name: vlanEvIncrFlowConfig, Src: []string{vlanStConfigDone}, Dst: vlanStConfigIncrFlow},
+ {Name: vlanEvRemFlowConfig, Src: []string{vlanStConfigDone}, Dst: vlanStRemoveFlow},
+ {Name: vlanEvRemFlowDone, Src: []string{vlanStRemoveFlow}, Dst: vlanStCleanupDone},
+ {Name: vlanEvFlowDataRemoved, Src: []string{vlanStCleanupDone}, Dst: vlanStConfigDone},
/*
{Name: vlanEvTimeoutSimple, Src: []string{
vlanStCreatingDot1PMapper, vlanStCreatingMBPCD, vlanStSettingTconts, vlanStSettingDot1PMapper}, Dst: vlanStStarting},
@@ -171,7 +202,7 @@
// exceptional treatment for all states except vlanStResetting
{Name: vlanEvReset, Src: []string{vlanStStarting, vlanStWaitingTechProf,
vlanStConfigVtfd, vlanStConfigEvtocd, vlanStConfigDone, vlanStConfigIncrFlow,
- vlanStCleanEvtocd, vlanStCleanVtfd, vlanStCleanupDone},
+ vlanStRemoveFlow, vlanStCleanupDone},
Dst: vlanStResetting},
// the only way to get to resource-cleared disabled state again is via "resseting"
{Name: vlanEvRestart, Src: []string{vlanStResetting}, Dst: vlanStDisabled},
@@ -183,8 +214,7 @@
("enter_" + vlanStConfigEvtocd): func(e *fsm.Event) { instFsm.enterConfigEvtocd(e) },
("enter_" + vlanStConfigDone): func(e *fsm.Event) { instFsm.enterVlanConfigDone(e) },
("enter_" + vlanStConfigIncrFlow): func(e *fsm.Event) { instFsm.enterConfigIncrFlow(e) },
- ("enter_" + vlanStCleanVtfd): func(e *fsm.Event) { instFsm.enterCleanVtfd(e) },
- ("enter_" + vlanStCleanEvtocd): func(e *fsm.Event) { instFsm.enterCleanEvtocd(e) },
+ ("enter_" + vlanStRemoveFlow): func(e *fsm.Event) { instFsm.enterRemoveFlow(e) },
("enter_" + vlanStCleanupDone): func(e *fsm.Event) { instFsm.enterVlanCleanupDone(e) },
("enter_" + vlanStResetting): func(e *fsm.Event) { instFsm.enterResetting(e) },
("enter_" + vlanStDisabled): func(e *fsm.Event) { instFsm.enterDisabled(e) },
@@ -192,82 +222,172 @@
)
if instFsm.pAdaptFsm.pFsm == nil {
logger.Errorw("UniVlanConfigFsm's Base FSM could not be instantiated!!", log.Fields{
- "device-id": aDeviceID})
+ "device-id": instFsm.deviceID})
return nil
}
- _ = instFsm.SetUniFlowParams(aTechProfileID, aMatchVlan, aSetVlan, aSetPcp)
+ _ = instFsm.initUniFlowParams(aTechProfileID, aCookieSlice, aMatchVlan, aSetVlan, aSetPcp)
- logger.Infow("UniVlanConfigFsm created", log.Fields{"device-id": aDeviceID,
+ logger.Infow("UniVlanConfigFsm created", log.Fields{"device-id": instFsm.deviceID,
"accIncrEvto": instFsm.acceptIncrementalEvtoOption})
return instFsm
}
-//SetUniFlowParams verifies on existence of flow parameters to be configured
-// and appends a new flow if there is space
-func (oFsm *UniVlanConfigFsm) SetUniFlowParams(aTpID uint16, aMatchVlan uint16, aSetVlan uint16, aSetPcp uint8) error {
- loFlowParams := uniVlanFlowParams{
+//initUniFlowParams is a simplified form of SetUniFlowParams() used for first flow parameters configuration
+func (oFsm *UniVlanConfigFsm) initUniFlowParams(aTpID uint16, aCookieSlice []uint64,
+ aMatchVlan uint16, aSetVlan uint16, aSetPcp uint8) error {
+ loRuleParams := uniVlanRuleParams{
TpID: aTpID,
MatchVid: uint32(aMatchVlan),
SetVid: uint32(aSetVlan),
SetPcp: uint32(aSetPcp),
}
// some automatic adjustments on the filter/treat parameters as not specifically configured/ensured by flow configuration parameters
- loFlowParams.TagsToRemove = 1 //one tag to remove as default setting
- loFlowParams.MatchPcp = cPrioDoNotFilter // do not Filter on prio as default
+ loRuleParams.TagsToRemove = 1 //one tag to remove as default setting
+ loRuleParams.MatchPcp = cPrioDoNotFilter // do not Filter on prio as default
- if loFlowParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
+ if loRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
//then matchVlan is don't care and should be overwritten to 'transparent' here to avoid unneeded multiple flow entries
- loFlowParams.MatchVid = uint32(of.OfpVlanId_OFPVID_PRESENT)
+ loRuleParams.MatchVid = uint32(of.OfpVlanId_OFPVID_PRESENT)
//TODO!!: maybe be needed to be re-checked at flow deletion (but assume all flows are always deleted togehther)
} else {
if !oFsm.acceptIncrementalEvtoOption {
//then matchVlan is don't care and should be overwritten to 'transparent' here to avoid unneeded multiple flow entries
- loFlowParams.MatchVid = uint32(of.OfpVlanId_OFPVID_PRESENT)
+ loRuleParams.MatchVid = uint32(of.OfpVlanId_OFPVID_PRESENT)
}
}
- if loFlowParams.MatchVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
+ if loRuleParams.MatchVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
// no prio/vid filtering requested
- loFlowParams.TagsToRemove = 0 //no tag pop action
- loFlowParams.MatchPcp = cPrioIgnoreTag // no vlan tag filtering
- if loFlowParams.SetPcp == cCopyPrioFromInner {
+ loRuleParams.TagsToRemove = 0 //no tag pop action
+ loRuleParams.MatchPcp = cPrioIgnoreTag // no vlan tag filtering
+ if loRuleParams.SetPcp == cCopyPrioFromInner {
//in case of no filtering and configured PrioCopy ensure default prio setting to 0
// which is required for stacking of untagged, but obviously also ensures prio setting for prio/singletagged
// might collide with NoMatchVid/CopyPrio(/setVid) setting
// this was some precondition setting taken over from py adapter ..
- loFlowParams.SetPcp = 0
+ loRuleParams.SetPcp = 0
}
}
+
+ loFlowParams := uniVlanFlowParams{VlanRuleParams: loRuleParams}
+ loFlowParams.CookieSlice = make([]uint64, 0)
+ loFlowParams.CookieSlice = append(loFlowParams.CookieSlice, aCookieSlice...)
+
+ //no mutex protection is required for initial access and adding the first flow is always possible
+ oFsm.uniVlanFlowParamsSlice = make([]uniVlanFlowParams, 0)
+ oFsm.uniVlanFlowParamsSlice = append(oFsm.uniVlanFlowParamsSlice, loFlowParams)
+ logger.Debugw("first UniVlanConfigFsm flow added", log.Fields{
+ "Cookies": oFsm.uniVlanFlowParamsSlice[0].CookieSlice,
+ "MatchVid": strconv.FormatInt(int64(loRuleParams.MatchVid), 16),
+ "SetVid": strconv.FormatInt(int64(loRuleParams.SetVid), 16),
+ "SetPcp": loRuleParams.SetPcp,
+ "device-id": oFsm.deviceID})
+ oFsm.numUniFlows = 1
+ oFsm.uniRemoveFlowsSlice = make([]uniRemoveVlanFlowParams, 0) //initially nothing to remove
+
+ //permanently store flow config for reconcile case
+ if err := oFsm.pDeviceHandler.storePersUniFlowConfig(oFsm.pOnuUniPort.uniID,
+ &oFsm.uniVlanFlowParamsSlice); err != nil {
+ logger.Errorw(err.Error(), log.Fields{"device-id": oFsm.deviceID})
+ return err
+ }
+
+ return nil
+}
+
+//SetUniFlowParams verifies on existence of flow parameters to be configured,
+// optionally udates the cookie list or appends a new flow if there is space
+// if possible the FSM is trigggerd to start with the processing
+func (oFsm *UniVlanConfigFsm) SetUniFlowParams(aTpID uint16, aCookieSlice []uint64,
+ aMatchVlan uint16, aSetVlan uint16, aSetPcp uint8) error {
+ loRuleParams := uniVlanRuleParams{
+ TpID: aTpID,
+ MatchVid: uint32(aMatchVlan),
+ SetVid: uint32(aSetVlan),
+ SetPcp: uint32(aSetPcp),
+ }
+ // some automatic adjustments on the filter/treat parameters as not specifically configured/ensured by flow configuration parameters
+ loRuleParams.TagsToRemove = 1 //one tag to remove as default setting
+ loRuleParams.MatchPcp = cPrioDoNotFilter // do not Filter on prio as default
+
+ if loRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
+ //then matchVlan is don't care and should be overwritten to 'transparent' here to avoid unneeded multiple flow entries
+ loRuleParams.MatchVid = uint32(of.OfpVlanId_OFPVID_PRESENT)
+ //TODO!!: maybe be needed to be re-checked at flow deletion (but assume all flows are always deleted togehther)
+ } else {
+ if !oFsm.acceptIncrementalEvtoOption {
+ //then matchVlan is don't care and should be overwritten to 'transparent' here to avoid unneeded multiple flow entries
+ loRuleParams.MatchVid = uint32(of.OfpVlanId_OFPVID_PRESENT)
+ }
+ }
+
+ if loRuleParams.MatchVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
+ // no prio/vid filtering requested
+ loRuleParams.TagsToRemove = 0 //no tag pop action
+ loRuleParams.MatchPcp = cPrioIgnoreTag // no vlan tag filtering
+ if loRuleParams.SetPcp == cCopyPrioFromInner {
+ //in case of no filtering and configured PrioCopy ensure default prio setting to 0
+ // which is required for stacking of untagged, but obviously also ensures prio setting for prio/singletagged
+ // might collide with NoMatchVid/CopyPrio(/setVid) setting
+ // this was some precondition setting taken over from py adapter ..
+ loRuleParams.SetPcp = 0
+ }
+ }
+
flowEntryMatch := false
+ flowCookieModify := false
//mutex protection is required for possible concurrent access to FSM members
oFsm.mutexFlowParams.Lock()
defer oFsm.mutexFlowParams.Unlock()
- for _, storedUniFlowParams := range oFsm.uniFlowParamsSlice {
- if storedUniFlowParams == loFlowParams {
+ for flow, storedUniFlowParams := range oFsm.uniVlanFlowParamsSlice {
+ //TODO: Verify if using e.g. hashes for the structures here for comparison may generate
+ // countable run time optimization (perhaps with including the hash in kvStore storage?)
+ if storedUniFlowParams.VlanRuleParams == loRuleParams {
flowEntryMatch = true
- break
+ logger.Debugw("UniVlanConfigFsm flow setting - rule already exists", log.Fields{
+ "device-id": oFsm.deviceID})
+ var cookieMatch bool
+ for _, newCookie := range aCookieSlice { // for all cookies available in the arguments
+ cookieMatch = false
+ for _, cookie := range storedUniFlowParams.CookieSlice {
+ if cookie == newCookie {
+ logger.Debugw("UniVlanConfigFsm flow setting - and cookie already exists", log.Fields{
+ "device-id": oFsm.deviceID, "cookie": cookie})
+ cookieMatch = true
+ break //found new cookie - no further search for this requested cookie
+ }
+ }
+ if !cookieMatch {
+ logger.Debugw("UniVlanConfigFsm flow setting -adding new cookie", log.Fields{
+ "device-id": oFsm.deviceID, "cookie": newCookie})
+ //as range works with copies of the slice we have to write to the original slice!!
+ oFsm.uniVlanFlowParamsSlice[flow].CookieSlice = append(oFsm.uniVlanFlowParamsSlice[flow].CookieSlice,
+ newCookie)
+ flowCookieModify = true
+ }
+ } //for all new cookies
+ break // found rule - no further rule search
}
}
- if flowEntryMatch {
- logger.Debugw("UniVlanConfigFsm flow setting - flow already exists (ignore)", log.Fields{
- "device-id": oFsm.pAdaptFsm.deviceID})
- } else {
+ if !flowEntryMatch { //it is a new rule
if oFsm.numUniFlows < cMaxAllowedFlows {
- oFsm.uniFlowParamsSlice = append(oFsm.uniFlowParamsSlice, loFlowParams)
+ loFlowParams := uniVlanFlowParams{VlanRuleParams: loRuleParams}
+ loFlowParams.CookieSlice = make([]uint64, 0)
+ loFlowParams.CookieSlice = append(loFlowParams.CookieSlice, aCookieSlice...)
+ oFsm.uniVlanFlowParamsSlice = append(oFsm.uniVlanFlowParamsSlice, loFlowParams)
+ logger.Debugw("UniVlanConfigFsm flow add", log.Fields{
+ "Cookies": oFsm.uniVlanFlowParamsSlice[oFsm.numUniFlows].CookieSlice,
+ "MatchVid": strconv.FormatInt(int64(loRuleParams.MatchVid), 16),
+ "SetVid": strconv.FormatInt(int64(loRuleParams.SetVid), 16),
+ "SetPcp": loRuleParams.SetPcp, "numberofFlows": (oFsm.numUniFlows + 1),
+ "device-id": oFsm.deviceID})
+
oFsm.numUniFlows++
- logger.Debugw("UniVlanConfigFsm flow added", log.Fields{
- "MatchVid": strconv.FormatInt(int64(loFlowParams.MatchVid), 16),
- "SetVid": strconv.FormatInt(int64(loFlowParams.SetVid), 16),
- "SetPcp": loFlowParams.SetPcp, "numberofFlows": oFsm.numUniFlows,
- "device-id": oFsm.pAdaptFsm.deviceID})
-
- //permanently store flow config for reconcile case
-
- if err := oFsm.pDeviceHandler.storePersUniFlowConfig(oFsm.pOnuUniPort.uniID, &oFsm.uniFlowParamsSlice); err != nil {
- logger.Errorw(err.Error(), log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
- return err
- }
+ // note: theoretical it would be possible to clear the same rule from the remove slice
+ // (for entries that have not yet been started with removal)
+ // but that is getting quite complicated - maybe a future optimization in case it should prove reasonable
+ // anyway the precondition here is that the FSM checks for rules to delete first and adds new rules afterwards
pConfigVlanStateBaseFsm := oFsm.pAdaptFsm.pFsm
if pConfigVlanStateBaseFsm.Is(vlanStConfigDone) {
@@ -276,22 +396,124 @@
go func(a_pBaseFsm *fsm.FSM) {
_ = a_pBaseFsm.Event(vlanEvIncrFlowConfig)
}(pConfigVlanStateBaseFsm)
- } // in all other states a new entry will be automatically considered later in that state or
- // ignored as not anymore relevant
+ } // if not in the appropriate state a new entry will be automatically considered later
+ // when the configDone state is reached
} else {
logger.Errorw("UniVlanConfigFsm flow limit exceeded", log.Fields{
- "device-id": oFsm.pAdaptFsm.deviceID})
- return fmt.Errorf(" UniVlanConfigFsm flow limit exceeded %s", oFsm.pAdaptFsm.deviceID)
+ "device-id": oFsm.deviceID, "flow-number": oFsm.numUniFlows})
+ return fmt.Errorf(" UniVlanConfigFsm flow limit exceeded %s", oFsm.deviceID)
+ }
+ } //new flow
+
+ if !flowEntryMatch || flowCookieModify { // some change was done to the flow entries
+ //permanently store flow config for reconcile case
+ if err := oFsm.pDeviceHandler.storePersUniFlowConfig(oFsm.pOnuUniPort.uniID, &oFsm.uniVlanFlowParamsSlice); err != nil {
+ logger.Errorw(err.Error(), log.Fields{"device-id": oFsm.deviceID})
+ return err
}
}
return nil
}
+//RemoveUniFlowParams verifies on existence of flow cookie,
+// if found removes cookie from flow cookie list and if this is empty
+// initiates removal of the flow related configuration from the ONU (via OMCI)
+func (oFsm *UniVlanConfigFsm) RemoveUniFlowParams(aCookie uint64) error {
+ flowCookieMatch := false
+ //mutex protection is required for possible concurrent access to FSM members
+ oFsm.mutexFlowParams.Lock()
+ defer oFsm.mutexFlowParams.Unlock()
+ for flow, storedUniFlowParams := range oFsm.uniVlanFlowParamsSlice {
+ for i, cookie := range storedUniFlowParams.CookieSlice {
+ if cookie == aCookie {
+ logger.Debugw("UniVlanConfigFsm flow removal - cookie found", log.Fields{
+ "device-id": oFsm.deviceID, "cookie": cookie})
+ flowCookieMatch = true
+
+ //remove the cookie from the cookie slice and verify it is getting empty
+ if len(storedUniFlowParams.CookieSlice) == 1 {
+ logger.Debugw("UniVlanConfigFsm flow removal - full flow removal", log.Fields{
+ "device-id": oFsm.deviceID})
+ oFsm.numUniFlows--
+
+ //create a new element for the removeVlanFlow slice
+ loRemoveParams := uniRemoveVlanFlowParams{
+ vlanRuleParams: storedUniFlowParams.VlanRuleParams,
+ cookie: storedUniFlowParams.CookieSlice[0],
+ }
+ oFsm.uniRemoveFlowsSlice = append(oFsm.uniRemoveFlowsSlice, loRemoveParams)
+
+ //and remove the actual element from the addVlanFlow slice
+ // oFsm.uniVlanFlowParamsSlice[flow].CookieSlice = nil //automatically done by garbage collector
+ if len(oFsm.uniVlanFlowParamsSlice) <= 1 {
+ oFsm.numUniFlows = 0 //no more flows
+ oFsm.configuredUniFlow = 0 //no more flows configured
+ oFsm.uniVlanFlowParamsSlice = nil //reset the slice
+ logger.Debugw("UniVlanConfigFsm flow removal - no more flows", log.Fields{
+ "device-id": oFsm.deviceID})
+ } else {
+ oFsm.numUniFlows--
+ if oFsm.configuredUniFlow > 0 {
+ oFsm.configuredUniFlow--
+ //TODO!! might be needed to consider still outstanding configure requests ..
+ // so a flow at removal might still not be configured !?!
+ }
+ //cut off the requested flow by slicing out this element
+ oFsm.uniVlanFlowParamsSlice = append(
+ oFsm.uniVlanFlowParamsSlice[:flow], oFsm.uniVlanFlowParamsSlice[flow+1:]...)
+ logger.Debugw("UniVlanConfigFsm flow removal - specific flow removed from data", log.Fields{
+ "device-id": oFsm.deviceID})
+ }
+ //trigger the FSM to remove the relevant rule
+ pConfigVlanStateBaseFsm := oFsm.pAdaptFsm.pFsm
+ if pConfigVlanStateBaseFsm.Is(vlanStConfigDone) {
+ //have to re-trigger the FSM to proceed with outstanding incremental flow configuration
+ // calling some FSM event must be decoupled
+ go func(a_pBaseFsm *fsm.FSM) {
+ _ = a_pBaseFsm.Event(vlanEvRemFlowConfig)
+ }(pConfigVlanStateBaseFsm)
+ } // if not in the appropriate state a new entry will be automatically considered later
+ // when the configDone state is reached
+ } else {
+ logger.Debugw("UniVlanConfigFsm flow removal - flow persists with other cookies", log.Fields{
+ "device-id": oFsm.deviceID})
+ //cut off the requested cookie by slicing out this element
+ oFsm.uniVlanFlowParamsSlice[flow].CookieSlice = append(
+ oFsm.uniVlanFlowParamsSlice[flow].CookieSlice[:i],
+ oFsm.uniVlanFlowParamsSlice[flow].CookieSlice[i+1:]...)
+ logger.Debugw("UniVlanConfigFsm flow removal - still valid cookies for this flow", log.Fields{
+ "device-id": oFsm.deviceID, "cookies": oFsm.uniVlanFlowParamsSlice[flow].CookieSlice})
+ }
+
+ //permanently store the modified flow config for reconcile case
+ if err := oFsm.pDeviceHandler.storePersUniFlowConfig(oFsm.pOnuUniPort.uniID, &oFsm.uniVlanFlowParamsSlice); err != nil {
+ logger.Errorw(err.Error(), log.Fields{"device-id": oFsm.deviceID})
+ return err
+ }
+
+ break //found the cookie - no further search for this requested cookie
+ }
+ }
+ if flowCookieMatch { //cookie already found: no need for further search in other flows
+ break
+ }
+ } //search all flows
+ if !flowCookieMatch { //some cookie remove-request for a cookie that does not exist in the FSM data
+ logger.Warnw("UniVlanConfigFsm flow removal - remove-cookie not found", log.Fields{
+ "device-id": oFsm.deviceID, "remove-cookie": aCookie})
+ // but accept the request with success as no such cookie (flow) does exist
+ return nil
+ } //unknown cookie
+
+ return nil
+}
+
func (oFsm *UniVlanConfigFsm) enterConfigStarting(e *fsm.Event) {
logger.Debugw("UniVlanConfigFsm start", log.Fields{"in state": e.FSM.Current(),
- "device-id": oFsm.pAdaptFsm.deviceID})
+ "device-id": oFsm.deviceID})
// this FSM is not intended for re-start, needs always new creation for a new run
+ // (self-destroying - compare enterDisabled())
oFsm.omciMIdsResponseReceived = make(chan bool)
// start go routine for processing of LockState messages
go oFsm.processOmciVlanMessages()
@@ -321,11 +543,11 @@
func (oFsm *UniVlanConfigFsm) enterConfigVtfd(e *fsm.Event) {
//mutex protection is required for possible concurrent access to FSM members
oFsm.mutexFlowParams.Lock()
- if oFsm.uniFlowParamsSlice[0].SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
+ if oFsm.uniVlanFlowParamsSlice[0].VlanRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
// meaning transparent setup - no specific VTFD setting required
oFsm.mutexFlowParams.Unlock()
logger.Debugw("UniVlanConfigFsm: no VTFD config required", log.Fields{
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
// let the FSM proceed ... (from within this state all internal pointers may be expected to be correct)
// obviously calling some FSM event here directly does not work - so trying to decouple it ...
pConfigVlanStateAFsm := oFsm.pAdaptFsm
@@ -335,10 +557,11 @@
} else {
logger.Debugw("UniVlanConfigFsm create VTFD", log.Fields{
"EntitytId": strconv.FormatInt(int64(oFsm.vtfdID), 16),
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
- oFsm.vlanFilterList[0] = uint16(oFsm.uniFlowParamsSlice[0].SetVid) // setVid is assumed to be masked already by the caller to 12 bit
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
+ // setVid is assumed to be masked already by the caller to 12 bit
+ oFsm.vlanFilterList[0] = uint16(oFsm.uniVlanFlowParamsSlice[0].VlanRuleParams.SetVid)
oFsm.mutexFlowParams.Unlock()
- vtfdFilterList := make([]uint16, 12) //needed for parameter serialization
+ vtfdFilterList := make([]uint16, cVtfdTableSize) //needed for parameter serialization
vtfdFilterList[0] = oFsm.vlanFilterList[0]
oFsm.numVlanFilterEntries = 1
meParams := me.ParamData{
@@ -350,7 +573,7 @@
},
}
logger.Debugw("UniVlanConfigFsm sendcreate VTFD", log.Fields{
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
meInstance := oFsm.pOmciCC.sendCreateVtfdVar(context.TODO(), ConstDefaultOmciTimeout, true,
oFsm.pAdaptFsm.commChan, meParams)
//accept also nil as (error) return value for writing to LastTx
@@ -358,24 +581,31 @@
//TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
// send shall return (dual format) error code that can be used here for immediate error treatment
// (relevant to all used sendXX() methods in this (and other) FSM's)
- oFsm.pOmciCC.pLastTxMeInstance = meInstance
+ oFsm.pLastTxMeInstance = meInstance
}
}
func (oFsm *UniVlanConfigFsm) enterConfigEvtocd(e *fsm.Event) {
logger.Debugw("UniVlanConfigFsm - start config EVTOCD loop", log.Fields{
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
go oFsm.performConfigEvtocdEntries(0)
}
func (oFsm *UniVlanConfigFsm) enterVlanConfigDone(e *fsm.Event) {
logger.Debugw("UniVlanConfigFsm - checking on more flows", log.Fields{
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
- oFsm.configuredUniFlow++ // one (more) flow configured
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
+ pConfigVlanStateBaseFsm := oFsm.pAdaptFsm.pFsm
+ if len(oFsm.uniRemoveFlowsSlice) > 0 {
+ //some further flows are to be removed, removal always starts with the first element
+ // calling some FSM event must be decoupled
+ go func(a_pBaseFsm *fsm.FSM) {
+ _ = a_pBaseFsm.Event(vlanEvRemFlowConfig)
+ }(pConfigVlanStateBaseFsm)
+ return
+ }
if oFsm.numUniFlows > oFsm.configuredUniFlow {
//some further flows are to be configured
// calling some FSM event must be decoupled
- pConfigVlanStateBaseFsm := oFsm.pAdaptFsm.pFsm
go func(a_pBaseFsm *fsm.FSM) {
_ = a_pBaseFsm.Event(vlanEvIncrFlowConfig)
}(pConfigVlanStateBaseFsm)
@@ -383,7 +613,7 @@
}
logger.Debugw("UniVlanConfigFsm - VLAN config done: send dh event notification", log.Fields{
- "device-id": oFsm.pAdaptFsm.deviceID})
+ "device-id": oFsm.deviceID})
// it might appear that some flows are requested also after 'flowPushed' event has been generated ...
// state transition notification is checked in deviceHandler
if oFsm.pDeviceHandler != nil {
@@ -394,23 +624,24 @@
func (oFsm *UniVlanConfigFsm) enterConfigIncrFlow(e *fsm.Event) {
logger.Debugw("UniVlanConfigFsm - start config further incremental flow", log.Fields{
"in state": e.FSM.Current(), "recent flow-number": (oFsm.configuredUniFlow),
- "device-id": oFsm.pAdaptFsm.deviceID})
+ "device-id": oFsm.deviceID})
oFsm.mutexFlowParams.Lock()
- if oFsm.uniFlowParamsSlice[oFsm.configuredUniFlow].SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
+ if oFsm.uniVlanFlowParamsSlice[oFsm.configuredUniFlow].VlanRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
// meaning transparent setup - no specific VTFD setting required
oFsm.mutexFlowParams.Unlock()
logger.Debugw("UniVlanConfigFsm: no VTFD config required", log.Fields{
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
} else {
if oFsm.numVlanFilterEntries == 0 {
//no VTFD yet created
logger.Debugw("UniVlanConfigFsm create VTFD", log.Fields{
"EntitytId": strconv.FormatInt(int64(oFsm.vtfdID), 16),
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
- oFsm.vlanFilterList[0] = uint16(oFsm.uniFlowParamsSlice[oFsm.configuredUniFlow].SetVid) // setVid is assumed to be masked already by the caller to 12 bit
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
+ // setVid is assumed to be masked already by the caller to 12 bit
+ oFsm.vlanFilterList[0] = uint16(oFsm.uniVlanFlowParamsSlice[oFsm.configuredUniFlow].VlanRuleParams.SetVid)
oFsm.mutexFlowParams.Unlock()
- vtfdFilterList := make([]uint16, 12) //needed for parameter serialization
+ vtfdFilterList := make([]uint16, cVtfdTableSize) //needed for parameter serialization
vtfdFilterList[0] = oFsm.vlanFilterList[0]
oFsm.numVlanFilterEntries = 1
meParams := me.ParamData{
@@ -428,18 +659,18 @@
//TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
// send shall return (dual format) error code that can be used here for immediate error treatment
// (relevant to all used sendXX() methods in this (and other) FSM's)
- oFsm.pOmciCC.pLastTxMeInstance = meInstance
+ oFsm.pLastTxMeInstance = meInstance
} else {
//VTFD already exists - just modify by 'set'
//TODO!!: but only if the VID is not already present, skipped by now to test basic working
logger.Debugw("UniVlanConfigFsm set VTFD", log.Fields{
"EntitytId": strconv.FormatInt(int64(oFsm.vtfdID), 16),
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
// setVid is assumed to be masked already by the caller to 12 bit
oFsm.vlanFilterList[oFsm.numVlanFilterEntries] =
- uint16(oFsm.uniFlowParamsSlice[oFsm.configuredUniFlow].SetVid)
+ uint16(oFsm.uniVlanFlowParamsSlice[oFsm.configuredUniFlow].VlanRuleParams.SetVid)
oFsm.mutexFlowParams.Unlock()
- vtfdFilterList := make([]uint16, 12) //needed for parameter serialization
+ vtfdFilterList := make([]uint16, cVtfdTableSize) //needed for parameter serialization
for i := uint8(0); i <= oFsm.numVlanFilterEntries; i++ {
vtfdFilterList[i] = oFsm.vlanFilterList[i]
}
@@ -459,13 +690,13 @@
//TODO!!: refactoring improvement requested, here as an example for [VOL-3457]:
// send shall return (dual format) error code that can be used here for immediate error treatment
// (relevant to all used sendXX() methods in this (and other) FSM's)
- oFsm.pOmciCC.pLastTxMeInstance = meInstance
+ oFsm.pLastTxMeInstance = meInstance
}
//verify response
err := oFsm.waitforOmciResponse()
if err != nil {
logger.Errorw("VTFD create/set failed, aborting VlanConfig FSM!",
- log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ log.Fields{"device-id": oFsm.deviceID})
_ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
return
}
@@ -473,37 +704,141 @@
go oFsm.performConfigEvtocdEntries(oFsm.configuredUniFlow)
}
-func (oFsm *UniVlanConfigFsm) enterCleanVtfd(e *fsm.Event) {
- logger.Debugw("UniVlanConfigFsm Tx Delete::VTFD", log.Fields{
- /*"EntitytId": strconv.FormatInt(int64(oFsm.mapperSP0ID), 16),*/
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
-}
+func (oFsm *UniVlanConfigFsm) enterRemoveFlow(e *fsm.Event) {
+ oFsm.mutexFlowParams.Lock()
+ logger.Debugw("UniVlanConfigFsm - start removing the top remove-flow", log.Fields{
+ "in state": e.FSM.Current(), "with last cookie": oFsm.uniRemoveFlowsSlice[0].cookie,
+ "device-id": oFsm.deviceID})
-func (oFsm *UniVlanConfigFsm) enterCleanEvtocd(e *fsm.Event) {
- logger.Debugw("UniVlanConfigFsm cleanup EVTOCD", log.Fields{
- /*"EntitytId": strconv.FormatInt(int64(oFsm.macBPCD0ID), 16),
- "TPPtr": strconv.FormatInt(int64(oFsm.mapperSP0ID), 16),*/
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
+ loVlanEntryClear := uint8(0)
+ loVlanEntryRmPos := uint8(0x80) //with indication 'invalid' in bit 7
+ //shallow copy is sufficient as no reference variables are used within struct
+ loRuleParams := oFsm.uniRemoveFlowsSlice[0].vlanRuleParams
+ oFsm.mutexFlowParams.Unlock()
+ logger.Debugw("UniVlanConfigFsm - remove-flow parameters are", log.Fields{
+ "match vid": loRuleParams.MatchVid, "match Pcp": loRuleParams.MatchPcp,
+ "set vid": strconv.FormatInt(int64(loRuleParams.SetVid), 16),
+ "device-id": oFsm.deviceID})
+
+ if loRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
+ // meaning transparent setup - no specific VTFD setting required
+ logger.Debugw("UniVlanConfigFsm: no VTFD removal required for transparent flow", log.Fields{
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
+ } else {
+ vtfdFilterList := make([]uint16, cVtfdTableSize) //needed for parameter serialization and 're-copy'
+ if oFsm.numVlanFilterEntries == 1 {
+ //only one active VLAN entry (hopefully the SetVID we want to remove - should be, but not verified ..)
+ // so we can just delete the VTFD entry
+ logger.Debugw("UniVlanConfigFsm: VTFD delete (no more vlan filters)",
+ log.Fields{"current vlan list": oFsm.vlanFilterList,
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
+ loVlanEntryClear = 1 //full VlanFilter clear request
+ meInstance := oFsm.pOmciCC.sendDeleteVtfd(context.TODO(), ConstDefaultOmciTimeout, true,
+ oFsm.pAdaptFsm.commChan, oFsm.vtfdID)
+ oFsm.pLastTxMeInstance = meInstance
+ } else {
+ //many VTFD already should exists - find and remove the one concerned by the actual remove rule
+ // by updating the VTFD per set command with new valid list
+ logger.Debugw("UniVlanConfigFsm: VTFD removal of requested VLAN from the list on OMCI",
+ log.Fields{"current vlan list": oFsm.vlanFilterList,
+ "set-vlan": loRuleParams.SetVid, "device-id": oFsm.deviceID})
+ for i := uint8(0); i < oFsm.numVlanFilterEntries; i++ {
+ if loRuleParams.SetVid == uint32(oFsm.vlanFilterList[i]) {
+ loVlanEntryRmPos = i
+ break //abort search
+ }
+ }
+ if loVlanEntryRmPos < cVtfdTableSize {
+ //valid entry was found - to be eclipsed
+ loVlanEntryClear = 2 //VlanFilter remove request for a specific entry
+ for i := uint8(0); i < oFsm.numVlanFilterEntries; i++ {
+ if i < loVlanEntryRmPos {
+ vtfdFilterList[i] = oFsm.vlanFilterList[i] //copy original
+ } else if i < (cVtfdTableSize - 1) {
+ vtfdFilterList[i] = oFsm.vlanFilterList[i+1] //copy successor (including 0 elements)
+ } else {
+ vtfdFilterList[i] = 0 //set last byte if needed
+ }
+ }
+ logger.Debugw("UniVlanConfigFsm set VTFD", log.Fields{
+ "EntitytId": strconv.FormatInt(int64(oFsm.vtfdID), 16),
+ "new vlan list": vtfdFilterList, "device-id": oFsm.deviceID})
+
+ meParams := me.ParamData{
+ EntityID: oFsm.vtfdID,
+ Attributes: me.AttributeValueMap{
+ "VlanFilterList": vtfdFilterList,
+ "NumberOfEntries": (oFsm.numVlanFilterEntries - 1), //one element less
+ },
+ }
+ meInstance := oFsm.pOmciCC.sendSetVtfdVar(context.TODO(), ConstDefaultOmciTimeout, true,
+ oFsm.pAdaptFsm.commChan, meParams)
+ oFsm.pLastTxMeInstance = meInstance
+ } else {
+ logger.Warnw("UniVlanConfigFsm: requested VLAN for removal not found in list - ignore and continue (no VTFD set)",
+ log.Fields{"device-id": oFsm.deviceID})
+ }
+ }
+ if loVlanEntryClear > 0 {
+ //waiting on response
+ err := oFsm.waitforOmciResponse()
+ if err != nil {
+ logger.Errorw("VTFD delete/reset failed, aborting VlanConfig FSM!",
+ log.Fields{"device-id": oFsm.deviceID})
+ _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
+ return
+ }
+
+ if loVlanEntryClear == 1 {
+ oFsm.vlanFilterList[0] = 0 //first entry is the only that can contain the previous only-one element
+ oFsm.numVlanFilterEntries = 0
+ } else if loVlanEntryClear == 2 {
+ // new VlanFilterList should be one entry smaller now - copy from last configured entry
+ // this loop now includes the 0 element on previous last valid entry
+ for i := uint8(0); i <= oFsm.numVlanFilterEntries; i++ {
+ oFsm.vlanFilterList[i] = vtfdFilterList[i]
+ }
+ oFsm.numVlanFilterEntries--
+ }
+ }
+ }
+
+ go oFsm.removeEvtocdEntries(loRuleParams)
}
func (oFsm *UniVlanConfigFsm) enterVlanCleanupDone(e *fsm.Event) {
- logger.Debugw("UniVlanConfigFsm - VLAN cleanup done", log.Fields{
- "in state": e.FSM.Current(), "device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Debugw("UniVlanConfigFsm - removing the removal data", log.Fields{
+ "in state": e.FSM.Current(), "device-id": oFsm.deviceID})
- //let's reset the state machine in order to release all resources now
+ oFsm.mutexFlowParams.Lock()
+ if len(oFsm.uniRemoveFlowsSlice) <= 1 {
+ oFsm.uniRemoveFlowsSlice = nil //reset the slice
+ logger.Debugw("UniVlanConfigFsm flow removal - last remove-flow deleted", log.Fields{
+ "device-id": oFsm.deviceID})
+ } else {
+ //cut off the actual flow by slicing out the first element
+ oFsm.uniRemoveFlowsSlice = append(
+ oFsm.uniRemoveFlowsSlice[:0],
+ oFsm.uniRemoveFlowsSlice[1:]...)
+ logger.Debugw("UniVlanConfigFsm flow removal - specific flow deleted from data", log.Fields{
+ "device-id": oFsm.deviceID})
+ }
+ oFsm.mutexFlowParams.Unlock()
+
+ //return to the basic config verification state
pConfigVlanStateAFsm := oFsm.pAdaptFsm
if pConfigVlanStateAFsm != nil {
// obviously calling some FSM event here directly does not work - so trying to decouple it ...
go func(a_pAFsm *AdapterFsm) {
if a_pAFsm != nil && a_pAFsm.pFsm != nil {
- _ = a_pAFsm.pFsm.Event(vlanEvReset)
+ _ = a_pAFsm.pFsm.Event(vlanEvFlowDataRemoved)
}
}(pConfigVlanStateAFsm)
}
}
func (oFsm *UniVlanConfigFsm) enterResetting(e *fsm.Event) {
- logger.Debugw("UniVlanConfigFsm resetting", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Debugw("UniVlanConfigFsm resetting", log.Fields{"device-id": oFsm.deviceID})
pConfigVlanStateAFsm := oFsm.pAdaptFsm
if pConfigVlanStateAFsm != nil {
@@ -526,7 +861,8 @@
}
func (oFsm *UniVlanConfigFsm) enterDisabled(e *fsm.Event) {
- logger.Debugw("UniVlanConfigFsm enters disabled state", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Debugw("UniVlanConfigFsm enters disabled state", log.Fields{"device-id": oFsm.deviceID})
+ oFsm.pLastTxMeInstance = nil
if oFsm.pDeviceHandler != nil {
//request removal of 'reference' in the Handler (completely clear the FSM)
go oFsm.pDeviceHandler.RemoveVlanFilterFsm(oFsm.pOnuUniPort)
@@ -534,107 +870,76 @@
}
func (oFsm *UniVlanConfigFsm) processOmciVlanMessages() { //ctx context.Context?
- logger.Debugw("Start UniVlanConfigFsm Msg processing", log.Fields{"for device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Debugw("Start UniVlanConfigFsm Msg processing", log.Fields{"for device-id": oFsm.deviceID})
loop:
for {
// case <-ctx.Done():
- // logger.Info("MibSync Msg", log.Fields{"Message handling canceled via context for device-id": oFsm.pAdaptFsm.deviceID})
+ // logger.Info("MibSync Msg", log.Fields{"Message handling canceled via context for device-id": oFsm.deviceID})
// break loop
message, ok := <-oFsm.pAdaptFsm.commChan
if !ok {
- logger.Info("UniVlanConfigFsm Rx Msg - could not read from channel", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Info("UniVlanConfigFsm Rx Msg - could not read from channel", log.Fields{"device-id": oFsm.deviceID})
// but then we have to ensure a restart of the FSM as well - as exceptional procedure
_ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
break loop
}
- logger.Debugw("UniVlanConfigFsm Rx Msg", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Debugw("UniVlanConfigFsm Rx Msg", log.Fields{"device-id": oFsm.deviceID})
switch message.Type {
case TestMsg:
msg, _ := message.Data.(TestMessage)
if msg.TestMessageVal == AbortMessageProcessing {
- logger.Infow("UniVlanConfigFsm abort ProcessMsg", log.Fields{"for device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Infow("UniVlanConfigFsm abort ProcessMsg", log.Fields{"for device-id": oFsm.deviceID})
break loop
}
- logger.Warnw("UniVlanConfigFsm unknown TestMessage", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID, "MessageVal": msg.TestMessageVal})
+ logger.Warnw("UniVlanConfigFsm unknown TestMessage", log.Fields{"device-id": oFsm.deviceID, "MessageVal": msg.TestMessageVal})
case OMCI:
msg, _ := message.Data.(OmciMessage)
oFsm.handleOmciVlanConfigMessage(msg)
default:
- logger.Warn("UniVlanConfigFsm Rx unknown message", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID,
+ logger.Warn("UniVlanConfigFsm Rx unknown message", log.Fields{"device-id": oFsm.deviceID,
"message.Type": message.Type})
}
}
- logger.Infow("End UniVlanConfigFsm Msg processing", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Infow("End UniVlanConfigFsm Msg processing", log.Fields{"device-id": oFsm.deviceID})
}
func (oFsm *UniVlanConfigFsm) handleOmciVlanConfigMessage(msg OmciMessage) {
- logger.Debugw("Rx OMCI UniVlanConfigFsm Msg", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID,
+ logger.Debugw("Rx OMCI UniVlanConfigFsm Msg", log.Fields{"device-id": oFsm.deviceID,
"msgType": msg.OmciMsg.MessageType})
switch msg.OmciMsg.MessageType {
case omci.CreateResponseType:
- {
- msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeCreateResponse)
- if msgLayer == nil {
- logger.Errorw("Omci Msg layer could not be detected for CreateResponse",
- log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ { // had to shift that to a method to cope with StaticCodeAnalysis restrictions :-(
+ if err := oFsm.handleOmciCreateResponseMessage(msg.OmciPacket); err != nil {
+ logger.Warnw("CreateResponse handling aborted", log.Fields{"err": err})
return
}
- msgObj, msgOk := msgLayer.(*omci.CreateResponse)
- if !msgOk {
- logger.Errorw("Omci Msg layer could not be assigned for CreateResponse",
- log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
- return
- }
- logger.Debugw("CreateResponse Data", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID, "data-fields": msgObj})
- if msgObj.Result != me.Success {
- logger.Errorw("Omci CreateResponse Error - later: drive FSM to abort state ?", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID,
- "Error": msgObj.Result})
- // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
- return
- }
- if msgObj.EntityClass == oFsm.pOmciCC.pLastTxMeInstance.GetClassID() &&
- msgObj.EntityInstance == oFsm.pOmciCC.pLastTxMeInstance.GetEntityID() {
- // maybe we can use just the same eventName for different state transitions like "forward"
- // - might be checked, but so far I go for sure and have to inspect the concrete state events ...
- switch oFsm.pOmciCC.pLastTxMeInstance.GetName() {
- case "VlanTaggingFilterData":
- {
- if oFsm.configuredUniFlow == 0 {
- // Only if CreateResponse is received from first flow entry - let the FSM proceed ...
- _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvRxConfigVtfd)
- } else { // let the MultiEntity config proceed by stopping the wait function
- oFsm.omciMIdsResponseReceived <- true
- }
- }
- }
- }
} //CreateResponseType
case omci.SetResponseType:
- {
+ { //leave that here as direct code as most often used
msgLayer := (*msg.OmciPacket).Layer(omci.LayerTypeSetResponse)
if msgLayer == nil {
- logger.Errorw("UniVlanConfigFsm - Omci Msg layer could not be detected for SetResponse",
- log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Errorw("Omci Msg layer could not be detected for SetResponse",
+ log.Fields{"device-id": oFsm.deviceID})
return
}
msgObj, msgOk := msgLayer.(*omci.SetResponse)
if !msgOk {
- logger.Errorw("UniVlanConfigFsm - Omci Msg layer could not be assigned for SetResponse",
- log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Errorw("Omci Msg layer could not be assigned for SetResponse",
+ log.Fields{"device-id": oFsm.deviceID})
return
}
- logger.Debugw("UniVlanConfigFsm SetResponse Data", log.Fields{"deviceId": oFsm.pAdaptFsm.deviceID, "data-fields": msgObj})
+ logger.Debugw("UniVlanConfigFsm SetResponse Data", log.Fields{"device-id": oFsm.deviceID, "data-fields": msgObj})
if msgObj.Result != me.Success {
- logger.Errorw("UniVlanConfigFsm - Omci SetResponse Error - later: drive FSM to abort state ?",
- log.Fields{"deviceId": oFsm.pAdaptFsm.deviceID, "Error": msgObj.Result})
+ logger.Errorw("UniVlanConfigFsm Omci SetResponse Error - later: drive FSM to abort state ?",
+ log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
// possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
return
}
- if msgObj.EntityClass == oFsm.pOmciCC.pLastTxMeInstance.GetClassID() &&
- msgObj.EntityInstance == oFsm.pOmciCC.pLastTxMeInstance.GetEntityID() {
- switch oFsm.pOmciCC.pLastTxMeInstance.GetName() {
+ if msgObj.EntityClass == oFsm.pLastTxMeInstance.GetClassID() &&
+ msgObj.EntityInstance == oFsm.pLastTxMeInstance.GetEntityID() {
+ switch oFsm.pLastTxMeInstance.GetName() {
case "VlanTaggingFilterData",
"ExtendedVlanTaggingOperationConfigurationData":
{ // let the MultiEntity config proceed by stopping the wait function
@@ -643,15 +948,98 @@
}
}
} //SetResponseType
+ case omci.DeleteResponseType:
+ { // had to shift that to a method to cope with StaticCodeAnalysis restrictions :-(
+ if err := oFsm.handleOmciDeleteResponseMessage(msg.OmciPacket); err != nil {
+ logger.Warnw("DeleteResponse handling aborted", log.Fields{"err": err})
+ return
+ }
+ } //DeleteResponseType
default:
{
- logger.Errorw("UniVlanConfigFsm - Rx OMCI unhandled MsgType",
- log.Fields{"omciMsgType": msg.OmciMsg.MessageType, "deviceId": oFsm.pAdaptFsm.deviceID})
+ logger.Errorw("Rx OMCI unhandled MsgType",
+ log.Fields{"omciMsgType": msg.OmciMsg.MessageType, "device-id": oFsm.deviceID})
return
}
}
}
+func (oFsm *UniVlanConfigFsm) handleOmciCreateResponseMessage(apOmciPacket *gp.Packet) error {
+ msgLayer := (*apOmciPacket).Layer(omci.LayerTypeCreateResponse)
+ if msgLayer == nil {
+ logger.Errorw("Omci Msg layer could not be detected for CreateResponse",
+ log.Fields{"device-id": oFsm.deviceID})
+ return fmt.Errorf("omci msg layer could not be detected for CreateResponse for device-id %x",
+ oFsm.deviceID)
+ }
+ msgObj, msgOk := msgLayer.(*omci.CreateResponse)
+ if !msgOk {
+ logger.Errorw("Omci Msg layer could not be assigned for CreateResponse",
+ log.Fields{"device-id": oFsm.deviceID})
+ return fmt.Errorf("omci msg layer could not be assigned for CreateResponse for device-id %x",
+ oFsm.deviceID)
+ }
+ logger.Debugw("UniVlanConfigFsm CreateResponse Data", log.Fields{"device-id": oFsm.deviceID, "data-fields": msgObj})
+ if msgObj.Result != me.Success {
+ logger.Errorw("Omci CreateResponse Error - later: drive FSM to abort state ?", log.Fields{"device-id": oFsm.deviceID,
+ "Error": msgObj.Result})
+ // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
+ return fmt.Errorf("omci CreateResponse Error for device-id %x",
+ oFsm.deviceID)
+ }
+ if msgObj.EntityClass == oFsm.pLastTxMeInstance.GetClassID() &&
+ msgObj.EntityInstance == oFsm.pLastTxMeInstance.GetEntityID() {
+ // to satisfy StaticCodeAnalysis I had to move the small processing into a separate method :-(
+ switch oFsm.pLastTxMeInstance.GetName() {
+ case "VlanTaggingFilterData":
+ {
+ if oFsm.pAdaptFsm.pFsm.Current() == vlanStConfigVtfd {
+ // Only if CreateResponse is received from first flow entry - let the FSM proceed ...
+ _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvRxConfigVtfd)
+ } else { // let the MultiEntity config proceed by stopping the wait function
+ oFsm.omciMIdsResponseReceived <- true
+ }
+ }
+ }
+ }
+ return nil
+}
+
+func (oFsm *UniVlanConfigFsm) handleOmciDeleteResponseMessage(apOmciPacket *gp.Packet) error {
+ msgLayer := (*apOmciPacket).Layer(omci.LayerTypeDeleteResponse)
+ if msgLayer == nil {
+ logger.Errorw("UniVlanConfigFsm - Omci Msg layer could not be detected for DeleteResponse",
+ log.Fields{"device-id": oFsm.deviceID})
+ return fmt.Errorf("omci msg layer could not be detected for DeleteResponse for device-id %x",
+ oFsm.deviceID)
+ }
+ msgObj, msgOk := msgLayer.(*omci.DeleteResponse)
+ if !msgOk {
+ logger.Errorw("UniVlanConfigFsm - Omci Msg layer could not be assigned for DeleteResponse",
+ log.Fields{"device-id": oFsm.deviceID})
+ return fmt.Errorf("omci msg layer could not be assigned for DeleteResponse for device-id %x",
+ oFsm.deviceID)
+ }
+ logger.Debugw("UniVlanConfigFsm DeleteResponse Data", log.Fields{"device-id": oFsm.deviceID, "data-fields": msgObj})
+ if msgObj.Result != me.Success {
+ logger.Errorw("UniVlanConfigFsm - Omci DeleteResponse Error - later: drive FSM to abort state ?",
+ log.Fields{"device-id": oFsm.deviceID, "Error": msgObj.Result})
+ // possibly force FSM into abort or ignore some errors for some messages? store error for mgmt display?
+ return fmt.Errorf("omci DeleteResponse Error for device-id %x",
+ oFsm.deviceID)
+ }
+ if msgObj.EntityClass == oFsm.pLastTxMeInstance.GetClassID() &&
+ msgObj.EntityInstance == oFsm.pLastTxMeInstance.GetEntityID() {
+ switch oFsm.pLastTxMeInstance.GetName() {
+ case "VlanTaggingFilterData":
+ { // let the MultiEntity config proceed by stopping the wait function
+ oFsm.omciMIdsResponseReceived <- true
+ }
+ }
+ }
+ return nil
+}
+
func (oFsm *UniVlanConfigFsm) performConfigEvtocdEntries(aFlowEntryNo uint8) {
if aFlowEntryNo == 0 {
// EthType set only at first flow element
@@ -660,7 +1048,7 @@
logger.Debugw("UniVlanConfigFsm Tx Set::EVTOCD", log.Fields{
"EntitytId": strconv.FormatInt(int64(oFsm.evtocdID), 16),
"i/oEthType": strconv.FormatInt(int64(cDefaultTpid), 16),
- "device-id": oFsm.pAdaptFsm.deviceID})
+ "device-id": oFsm.deviceID})
meParams := me.ParamData{
EntityID: oFsm.evtocdID,
Attributes: me.AttributeValueMap{
@@ -673,24 +1061,24 @@
oFsm.pAdaptFsm.commChan, meParams)
//accept also nil as (error) return value for writing to LastTx
// - this avoids misinterpretation of new received OMCI messages
- oFsm.pOmciCC.pLastTxMeInstance = meInstance
+ oFsm.pLastTxMeInstance = meInstance
//verify response
err := oFsm.waitforOmciResponse()
if err != nil {
logger.Errorw("Evtocd set TPID failed, aborting VlanConfig FSM!",
- log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ log.Fields{"device-id": oFsm.deviceID})
_ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
return
}
} //first flow element
oFsm.mutexFlowParams.Lock()
- if oFsm.uniFlowParamsSlice[aFlowEntryNo].SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
+ if oFsm.uniVlanFlowParamsSlice[aFlowEntryNo].VlanRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
//transparent transmission required
oFsm.mutexFlowParams.Unlock()
logger.Debugw("UniVlanConfigFsm Tx Set::EVTOCD single tagged transparent rule", log.Fields{
- "device-id": oFsm.pAdaptFsm.deviceID})
+ "device-id": oFsm.deviceID})
sliceEvtocdRule := make([]uint8, 16)
// fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
@@ -725,13 +1113,13 @@
oFsm.pAdaptFsm.commChan, meParams)
//accept also nil as (error) return value for writing to LastTx
// - this avoids misinterpretation of new received OMCI messages
- oFsm.pOmciCC.pLastTxMeInstance = meInstance
+ oFsm.pLastTxMeInstance = meInstance
//verify response
err := oFsm.waitforOmciResponse()
if err != nil {
logger.Errorw("Evtocd set transparent singletagged rule failed, aborting VlanConfig FSM!",
- log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ log.Fields{"device-id": oFsm.deviceID})
_ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
return
}
@@ -740,7 +1128,7 @@
if oFsm.acceptIncrementalEvtoOption {
// this defines VID translation scenario: singletagged->singletagged (if not transparent)
logger.Debugw("UniVlanConfigFsm Tx Set::EVTOCD single tagged translation rule", log.Fields{
- "device-id": oFsm.pAdaptFsm.deviceID})
+ "device-id": oFsm.deviceID})
sliceEvtocdRule := make([]uint8, 16)
// fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
@@ -749,20 +1137,20 @@
cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
- oFsm.uniFlowParamsSlice[aFlowEntryNo].MatchPcp<<cFilterPrioOffset| // either DNFonPrio or ignore tag (default) on innerVLAN
- oFsm.uniFlowParamsSlice[aFlowEntryNo].MatchVid<<cFilterVidOffset| // either DNFonVid or real filter VID
+ oFsm.uniVlanFlowParamsSlice[aFlowEntryNo].VlanRuleParams.MatchPcp<<cFilterPrioOffset| // either DNFonPrio or ignore tag (default) on innerVLAN
+ oFsm.uniVlanFlowParamsSlice[aFlowEntryNo].VlanRuleParams.MatchVid<<cFilterVidOffset| // either DNFonVid or real filter VID
cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:],
- oFsm.uniFlowParamsSlice[aFlowEntryNo].TagsToRemove<<cTreatTTROffset| // either 1 or 0
+ oFsm.uniVlanFlowParamsSlice[aFlowEntryNo].VlanRuleParams.TagsToRemove<<cTreatTTROffset| // either 1 or 0
cDoNotAddPrio<<cTreatPrioOffset| // do not add outer tag
cDontCareVid<<cTreatVidOffset| // Outer VID don't care
cDontCareTpid<<cTreatTpidOffset) // Outer TPID field don't care
binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
- oFsm.uniFlowParamsSlice[aFlowEntryNo].SetPcp<<cTreatPrioOffset| // as configured in flow
- oFsm.uniFlowParamsSlice[aFlowEntryNo].SetVid<<cTreatVidOffset| //as configured in flow
+ oFsm.uniVlanFlowParamsSlice[aFlowEntryNo].VlanRuleParams.SetPcp<<cTreatPrioOffset| // as configured in flow
+ oFsm.uniVlanFlowParamsSlice[aFlowEntryNo].VlanRuleParams.SetVid<<cTreatVidOffset| //as configured in flow
cSetOutputTpidCopyDei<<cTreatTpidOffset) // Set TPID = 0x8100
oFsm.mutexFlowParams.Unlock()
@@ -776,13 +1164,13 @@
oFsm.pAdaptFsm.commChan, meParams)
//accept also nil as (error) return value for writing to LastTx
// - this avoids misinterpretation of new received OMCI messages
- oFsm.pOmciCC.pLastTxMeInstance = meInstance
+ oFsm.pLastTxMeInstance = meInstance
//verify response
err := oFsm.waitforOmciResponse()
if err != nil {
logger.Errorw("Evtocd set singletagged translation rule failed, aborting VlanConfig FSM!",
- log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ log.Fields{"device-id": oFsm.deviceID})
_ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
return
}
@@ -791,7 +1179,7 @@
{ // just for local var's
// this defines stacking scenario: untagged->singletagged
logger.Debugw("UniVlanConfigFsm Tx Set::EVTOCD untagged->singletagged rule", log.Fields{
- "device-id": oFsm.pAdaptFsm.deviceID})
+ "device-id": oFsm.deviceID})
sliceEvtocdRule := make([]uint8, 16)
// fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
@@ -814,7 +1202,7 @@
binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
0<<cTreatPrioOffset| // vlan prio set to 0
// (as done in Py code, maybe better option would be setPcp here, which still could be 0?)
- oFsm.uniFlowParamsSlice[aFlowEntryNo].SetVid<<cTreatVidOffset| // Outer VID don't care
+ oFsm.uniVlanFlowParamsSlice[aFlowEntryNo].VlanRuleParams.SetVid<<cTreatVidOffset| // Outer VID don't care
cSetOutputTpidCopyDei<<cTreatTpidOffset) // Set TPID = 0x8100
oFsm.mutexFlowParams.Unlock()
@@ -828,13 +1216,13 @@
oFsm.pAdaptFsm.commChan, meParams)
//accept also nil as (error) return value for writing to LastTx
// - this avoids misinterpretation of new received OMCI messages
- oFsm.pOmciCC.pLastTxMeInstance = meInstance
+ oFsm.pLastTxMeInstance = meInstance
//verify response
err := oFsm.waitforOmciResponse()
if err != nil {
logger.Errorw("Evtocd set untagged->singletagged rule failed, aborting VlanConfig FSM!",
- log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ log.Fields{"device-id": oFsm.deviceID})
_ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
return
}
@@ -842,7 +1230,7 @@
{ // just for local var's
// this defines 'stacking' scenario: priotagged->singletagged
logger.Debugw("UniVlanConfigFsm Tx Set::EVTOCD priotagged->singletagged rule", log.Fields{
- "device-id": oFsm.pAdaptFsm.deviceID})
+ "device-id": oFsm.deviceID})
sliceEvtocdRule := make([]uint8, 16)
// fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
@@ -866,7 +1254,7 @@
binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
cCopyPrioFromInner<<cTreatPrioOffset| // vlan copy from PrioTag
// (as done in Py code, maybe better option would be setPcp here, which still could be PrioCopy?)
- oFsm.uniFlowParamsSlice[aFlowEntryNo].SetVid<<cTreatVidOffset| // Outer VID as configured
+ oFsm.uniVlanFlowParamsSlice[aFlowEntryNo].VlanRuleParams.SetVid<<cTreatVidOffset| // Outer VID as configured
cSetOutputTpidCopyDei<<cTreatTpidOffset) // Set TPID = 0x8100
oFsm.mutexFlowParams.Unlock()
@@ -880,13 +1268,13 @@
oFsm.pAdaptFsm.commChan, meParams)
//accept also nil as (error) return value for writing to LastTx
// - this avoids misinterpretation of new received OMCI messages
- oFsm.pOmciCC.pLastTxMeInstance = meInstance
+ oFsm.pLastTxMeInstance = meInstance
//verify response
err := oFsm.waitforOmciResponse()
if err != nil {
logger.Errorw("Evtocd set priotagged->singletagged rule failed, aborting VlanConfig FSM!",
- log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ log.Fields{"device-id": oFsm.deviceID})
_ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
return
}
@@ -895,25 +1283,226 @@
}
// if Config has been done for all GemPort instances let the FSM proceed
- logger.Debugw("EVTOCD set loop finished", log.Fields{"device-id": oFsm.pAdaptFsm.deviceID})
+ logger.Debugw("EVTOCD set loop finished", log.Fields{"device-id": oFsm.deviceID})
+ oFsm.configuredUniFlow++ // one (more) flow configured
_ = oFsm.pAdaptFsm.pFsm.Event(vlanEvRxConfigEvtocd)
}
+func (oFsm *UniVlanConfigFsm) removeEvtocdEntries(aRuleParams uniVlanRuleParams) {
+ // configured Input/Output TPID is not modified again - no influence if no filter is applied
+ if aRuleParams.SetVid == uint32(of.OfpVlanId_OFPVID_PRESENT) {
+ //transparent transmission was set
+ //perhaps the config is not needed for removal,
+ // but the specific InnerTpid setting is removed in favor of the real default forwarding rule
+ logger.Debugw("UniVlanConfigFsm Tx Set::EVTOCD reset to default single tagged rule", log.Fields{
+ "device-id": oFsm.deviceID})
+ sliceEvtocdRule := make([]uint8, 16)
+ // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
+ cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
+ cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
+ cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
+
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
+ cPrioDefaultFilter<<cFilterPrioOffset| // default inner-tag rule
+ cDoNotFilterVid<<cFilterVidOffset| // Do not filter on inner vid
+ cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
+ cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
+
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:],
+ 0<<cTreatTTROffset| // Do not pop any tags
+ cDoNotAddPrio<<cTreatPrioOffset| // do not add outer tag
+ cDontCareVid<<cTreatVidOffset| // Outer VID don't care
+ cDontCareTpid<<cTreatTpidOffset) // Outer TPID field don't care
+
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
+ cDoNotAddPrio<<cTreatPrioOffset| // do not add inner tag
+ cDontCareVid<<cTreatVidOffset| // Outer VID don't care
+ cDontCareTpid<<cTreatTpidOffset) // copy TPID and DEI
+
+ meParams := me.ParamData{
+ EntityID: oFsm.evtocdID,
+ Attributes: me.AttributeValueMap{
+ "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
+ },
+ }
+ meInstance := oFsm.pOmciCC.sendSetEvtocdVar(context.TODO(), ConstDefaultOmciTimeout, true,
+ oFsm.pAdaptFsm.commChan, meParams)
+ //accept also nil as (error) return value for writing to LastTx
+ // - this avoids misinterpretation of new received OMCI messages
+ oFsm.pLastTxMeInstance = meInstance
+
+ //verify response
+ err := oFsm.waitforOmciResponse()
+ if err != nil {
+ logger.Errorw("Evtocd reset singletagged rule failed, aborting VlanConfig FSM!",
+ log.Fields{"device-id": oFsm.deviceID})
+ _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
+ return
+ }
+ } else {
+ // according to py-code acceptIncrementalEvto program option decides upon stacking or translation scenario
+ if oFsm.acceptIncrementalEvtoOption {
+ // this defines VID translation scenario: singletagged->singletagged (if not transparent)
+ logger.Debugw("UniVlanConfigFsm Tx Set::EVTOCD clear single tagged translation rule", log.Fields{
+ "device-id": oFsm.deviceID, "match-vlan": aRuleParams.MatchVid})
+ sliceEvtocdRule := make([]uint8, 16)
+ // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
+ cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
+ cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
+ cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
+
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
+ aRuleParams.MatchPcp<<cFilterPrioOffset| // either DNFonPrio or ignore tag (default) on innerVLAN
+ aRuleParams.MatchVid<<cFilterVidOffset| // either DNFonVid or real filter VID
+ cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
+ cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
+
+ // delete indication for the indicated Filter
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:], 0xFFFFFFFF)
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:], 0xFFFFFFFF)
+
+ meParams := me.ParamData{
+ EntityID: oFsm.evtocdID,
+ Attributes: me.AttributeValueMap{
+ "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
+ },
+ }
+ meInstance := oFsm.pOmciCC.sendSetEvtocdVar(context.TODO(), ConstDefaultOmciTimeout, true,
+ oFsm.pAdaptFsm.commChan, meParams)
+ //accept also nil as (error) return value for writing to LastTx
+ // - this avoids misinterpretation of new received OMCI messages
+ oFsm.pLastTxMeInstance = meInstance
+
+ //verify response
+ err := oFsm.waitforOmciResponse()
+ if err != nil {
+ logger.Errorw("Evtocd clear singletagged translation rule failed, aborting VlanConfig FSM!",
+ log.Fields{"device-id": oFsm.deviceID, "match-vlan": aRuleParams.MatchVid})
+ _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
+ return
+ }
+ } else {
+ //not transparent and not acceptIncrementalEvtoOption: untagged/priotagged->singletagged
+ { // just for local var's
+ // this defines stacking scenario: untagged->singletagged
+ //TODO!! in theory there could be different rules running in setting different PCP/VID'S
+ // for untagged/priotagged, last rule wins (and remains the only one), maybe that should be
+ // checked already at flow-add (and rejected) - to be observed if such is possible in Voltha
+ // delete now assumes there is only one such rule!
+ logger.Debugw("UniVlanConfigFsm Tx Set::EVTOCD reset untagged rule to default", log.Fields{
+ "device-id": oFsm.deviceID})
+ sliceEvtocdRule := make([]uint8, 16)
+ // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
+ cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
+ cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
+ cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
+
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
+ cPrioIgnoreTag<<cFilterPrioOffset| // Not an inner-tag rule
+ cDoNotFilterVid<<cFilterVidOffset| // Do not filter on inner vid
+ cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
+ cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
+
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:],
+ 0<<cTreatTTROffset| // Do not pop any tags
+ cDoNotAddPrio<<cTreatPrioOffset| // do not add outer tag
+ cDontCareVid<<cTreatVidOffset| // Outer VID don't care
+ cDontCareTpid<<cTreatTpidOffset) // Outer TPID field don't care
+
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:],
+ cDoNotAddPrio<<cTreatPrioOffset| // do not add inner tag
+ cDontCareVid<<cTreatVidOffset| // Outer VID don't care
+ cDontCareTpid<<cTreatTpidOffset) // copy TPID and DEI
+
+ meParams := me.ParamData{
+ EntityID: oFsm.evtocdID,
+ Attributes: me.AttributeValueMap{
+ "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
+ },
+ }
+ meInstance := oFsm.pOmciCC.sendSetEvtocdVar(context.TODO(), ConstDefaultOmciTimeout, true,
+ oFsm.pAdaptFsm.commChan, meParams)
+ //accept also nil as (error) return value for writing to LastTx
+ // - this avoids misinterpretation of new received OMCI messages
+ oFsm.pLastTxMeInstance = meInstance
+
+ //verify response
+ err := oFsm.waitforOmciResponse()
+ if err != nil {
+ logger.Errorw("Evtocd reset untagged rule to default failed, aborting VlanConfig FSM!",
+ log.Fields{"device-id": oFsm.deviceID})
+ _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
+ return
+ }
+ } // just for local var's
+ { // just for local var's
+ // this defines 'stacking' scenario: priotagged->singletagged
+ logger.Debugw("UniVlanConfigFsm Tx Set::EVTOCD delete priotagged rule", log.Fields{
+ "device-id": oFsm.deviceID})
+ sliceEvtocdRule := make([]uint8, 16)
+ // fill vlan tagging operation table bit fields using network=bigEndian order and using slice offset 0 as highest 'word'
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterOuterOffset:],
+ cPrioIgnoreTag<<cFilterPrioOffset| // Not an outer-tag rule
+ cDoNotFilterVid<<cFilterVidOffset| // Do not filter on outer vid
+ cDoNotFilterTPID<<cFilterTpidOffset) // Do not filter on outer TPID field
+
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cFilterInnerOffset:],
+ cPrioDoNotFilter<<cFilterPrioOffset| // Do not Filter on innerprio
+ 0<<cFilterVidOffset| // filter on inner vid 0 (prioTagged)
+ cDoNotFilterTPID<<cFilterTpidOffset| // Do not filter on inner TPID field
+ cDoNotFilterEtherType<<cFilterEtherTypeOffset) // Do not filter of EtherType
+
+ // delete indication for the indicated Filter
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatOuterOffset:], 0xFFFFFFFF)
+ binary.BigEndian.PutUint32(sliceEvtocdRule[cTreatInnerOffset:], 0xFFFFFFFF)
+
+ meParams := me.ParamData{
+ EntityID: oFsm.evtocdID,
+ Attributes: me.AttributeValueMap{
+ "ReceivedFrameVlanTaggingOperationTable": sliceEvtocdRule,
+ },
+ }
+ meInstance := oFsm.pOmciCC.sendSetEvtocdVar(context.TODO(), ConstDefaultOmciTimeout, true,
+ oFsm.pAdaptFsm.commChan, meParams)
+ //accept also nil as (error) return value for writing to LastTx
+ // - this avoids misinterpretation of new received OMCI messages
+ oFsm.pLastTxMeInstance = meInstance
+
+ //verify response
+ err := oFsm.waitforOmciResponse()
+ if err != nil {
+ logger.Errorw("Evtocd delete priotagged rule failed, aborting VlanConfig FSM!",
+ log.Fields{"device-id": oFsm.deviceID})
+ _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvReset)
+ return
+ }
+ } //just for local var's
+ }
+ }
+
+ // if Config has been done for all GemPort instances let the FSM proceed
+ logger.Debugw("EVTOCD filter remove loop finished", log.Fields{"device-id": oFsm.deviceID})
+ _ = oFsm.pAdaptFsm.pFsm.Event(vlanEvRemFlowDone)
+}
+
func (oFsm *UniVlanConfigFsm) waitforOmciResponse() error {
select {
// maybe be also some outside cancel (but no context modeled for the moment ...)
// case <-ctx.Done():
- // logger.Infow("LockState-bridge-init message reception canceled", log.Fields{"for device-id": oFsm.pAdaptFsm.deviceID})
+ // logger.Infow("LockState-bridge-init message reception canceled", log.Fields{"for device-id": oFsm.deviceID})
case <-time.After(30 * time.Second): //AS FOR THE OTHER OMCI FSM's
- logger.Warnw("UniVlanConfigFsm multi entity timeout", log.Fields{"for device-id": oFsm.pAdaptFsm.deviceID})
- return fmt.Errorf("uniVlanConfigFsm multi entity timeout %s", oFsm.pAdaptFsm.deviceID)
+ logger.Warnw("UniVlanConfigFsm multi entity timeout", log.Fields{"for device-id": oFsm.deviceID})
+ return fmt.Errorf("uniVlanConfigFsm multi entity timeout %s", oFsm.deviceID)
case success := <-oFsm.omciMIdsResponseReceived:
if success {
logger.Debug("UniVlanConfigFsm multi entity response received")
return nil
}
// should not happen so far
- logger.Warnw("UniVlanConfigFsm multi entity response error", log.Fields{"for device-id": oFsm.pAdaptFsm.deviceID})
- return fmt.Errorf("uniVlanConfigFsm multi entity responseError %s", oFsm.pAdaptFsm.deviceID)
+ logger.Warnw("UniVlanConfigFsm multi entity response error", log.Fields{"for device-id": oFsm.deviceID})
+ return fmt.Errorf("uniVlanConfigFsm multi entity responseError %s", oFsm.deviceID)
}
}