blob: dfd0771901a366ffc422cca4a6b12ca96440e810 [file] [log] [blame]
khenaidoo89b0e942018-10-21 21:11:33 -04001/*
2 * Copyright 2018-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
npujar1d86a522019-11-14 17:11:16 +053017package flowdecomposition
khenaidoo89b0e942018-10-21 21:11:33 -040018
19import (
npujar467fe752020-01-16 20:17:45 +053020 "context"
khenaidoo787224a2020-04-16 18:08:47 -040021 "fmt"
Mahir Gunyeladdb66a2020-04-29 18:08:50 -070022
khenaidoo19d7b632018-10-30 10:49:50 -040023 "github.com/gogo/protobuf/proto"
khenaidoo820197c2020-02-13 16:35:33 -050024 "github.com/opencord/voltha-go/rw_core/route"
Maninderdfadc982020-10-28 14:04:33 +053025 fu "github.com/opencord/voltha-lib-go/v4/pkg/flows"
26 "github.com/opencord/voltha-lib-go/v4/pkg/log"
27 ofp "github.com/opencord/voltha-protos/v4/go/openflow_13"
28 "github.com/opencord/voltha-protos/v4/go/voltha"
khenaidoo820197c2020-02-13 16:35:33 -050029 "google.golang.org/grpc/codes"
30 "google.golang.org/grpc/status"
khenaidoo89b0e942018-10-21 21:11:33 -040031)
32
npujar1d86a522019-11-14 17:11:16 +053033// FlowDecomposer represent flow decomposer attribute
khenaidoo89b0e942018-10-21 21:11:33 -040034type FlowDecomposer struct {
Kent Hagerman6031aad2020-07-29 16:36:33 -040035 getDevice GetDeviceFunc
36}
37
38// DeviceManager represents a generic device manager
39type GetDeviceFunc func(context.Context, string) (*voltha.Device, error)
40
41type LogicalDeviceAgent interface {
42 GetDeviceRoutes() *route.DeviceRoutes
43 GetWildcardInputPorts(ctx context.Context, excludePort uint32) map[uint32]struct{}
44 GetRoute(ctx context.Context, ingressPortNo uint32, egressPortNo uint32) ([]route.Hop, error)
45 GetNNIPorts() map[uint32]struct{}
khenaidoo89b0e942018-10-21 21:11:33 -040046}
47
npujar1d86a522019-11-14 17:11:16 +053048// NewFlowDecomposer creates flow decomposer instance
Kent Hagerman6031aad2020-07-29 16:36:33 -040049func NewFlowDecomposer(getDevice GetDeviceFunc) *FlowDecomposer {
50 return &FlowDecomposer{getDevice: getDevice}
khenaidoo89b0e942018-10-21 21:11:33 -040051}
52
53//DecomposeRules decomposes per-device flows and flow-groups from the flows and groups defined on a logical device
Kent Hagerman6031aad2020-07-29 16:36:33 -040054func (fd *FlowDecomposer) DecomposeRules(ctx context.Context, agent LogicalDeviceAgent, flows map[uint64]*ofp.OfpFlowStats, groups map[uint32]*ofp.OfpGroupEntry) (*fu.DeviceRules, error) {
khenaidoo3306c992019-05-24 16:57:35 -040055 deviceRules := *fu.NewDeviceRules()
khenaidoo2c6a0992019-04-29 13:46:56 -040056 devicesToUpdate := make(map[string]string)
khenaidoo89b0e942018-10-21 21:11:33 -040057
Kent Hagerman433a31a2020-05-20 19:04:48 -040058 for _, flow := range flows {
59 decomposedRules, err := fd.decomposeFlow(ctx, agent, flow, groups)
khenaidoo820197c2020-02-13 16:35:33 -050060 if err != nil {
61 return nil, err
62 }
npujar1d86a522019-11-14 17:11:16 +053063 for deviceID, flowAndGroups := range decomposedRules.Rules {
64 deviceRules.CreateEntryIfNotExist(deviceID)
65 deviceRules.Rules[deviceID].AddFrom(flowAndGroups)
66 devicesToUpdate[deviceID] = deviceID
khenaidoo89b0e942018-10-21 21:11:33 -040067 }
68 }
khenaidoo820197c2020-02-13 16:35:33 -050069 return deviceRules.FilterRules(devicesToUpdate), nil
khenaidoo89b0e942018-10-21 21:11:33 -040070}
71
khenaidoo19d7b632018-10-30 10:49:50 -040072// Handles special case of any controller-bound flow for a parent device
Kent Hagerman6031aad2020-07-29 16:36:33 -040073func (fd *FlowDecomposer) updateOutputPortForControllerBoundFlowForParentDevide(ctx context.Context, dr *fu.DeviceRules) (*fu.DeviceRules, error) {
khenaidoo68c930b2019-05-13 11:46:51 -040074 EAPOL := fu.EthType(0x888e)
Marcos Aurelio Carrero (Furukawa)a61a72c2021-01-28 13:48:20 -030075 PPPoED := fu.EthType(0x8863)
khenaidoo68c930b2019-05-13 11:46:51 -040076 IGMP := fu.IpProto(2)
77 UDP := fu.IpProto(17)
khenaidoo19d7b632018-10-30 10:49:50 -040078
79 newDeviceRules := dr.Copy()
80 // Check whether we are dealing with a parent device
npujar1d86a522019-11-14 17:11:16 +053081 for deviceID, fg := range dr.GetRules() {
Kent Hagerman6031aad2020-07-29 16:36:33 -040082 if device, err := fd.getDevice(ctx, deviceID); err == nil && device.Root {
npujar1d86a522019-11-14 17:11:16 +053083 newDeviceRules.ClearFlows(deviceID)
khenaidoo19d7b632018-10-30 10:49:50 -040084 for i := 0; i < fg.Flows.Len(); i++ {
85 f := fg.GetFlow(i)
86 UpdateOutPortNo := false
khenaidoo68c930b2019-05-13 11:46:51 -040087 for _, field := range fu.GetOfbFields(f) {
khenaidoo19d7b632018-10-30 10:49:50 -040088 UpdateOutPortNo = (field.String() == EAPOL.String())
Marcos Aurelio Carrero (Furukawa)a61a72c2021-01-28 13:48:20 -030089 UpdateOutPortNo = UpdateOutPortNo || (field.String() == PPPoED.String())
khenaidoo19d7b632018-10-30 10:49:50 -040090 UpdateOutPortNo = UpdateOutPortNo || (field.String() == IGMP.String())
91 UpdateOutPortNo = UpdateOutPortNo || (field.String() == UDP.String())
92 if UpdateOutPortNo {
93 break
94 }
95 }
96 if UpdateOutPortNo {
khenaidoo68c930b2019-05-13 11:46:51 -040097 f = fu.UpdateOutputPortByActionType(f, uint32(ofp.OfpInstructionType_OFPIT_APPLY_ACTIONS),
khenaidoo19d7b632018-10-30 10:49:50 -040098 uint32(ofp.OfpPortNo_OFPP_CONTROLLER))
99 }
100 // Update flow Id as a change in the instruction field will result in a new flow ID
Mahir Gunyeladdb66a2020-04-29 18:08:50 -0700101 //var err error
102 //if f.Id, err = fu.HashFlowStats(f); err != nil {
103 //return nil, err
104 //}
npujar1d86a522019-11-14 17:11:16 +0530105 newDeviceRules.AddFlow(deviceID, (proto.Clone(f)).(*ofp.OfpFlowStats))
khenaidoo19d7b632018-10-30 10:49:50 -0400106 }
107 }
108 }
khenaidoo2c6a0992019-04-29 13:46:56 -0400109
Scott Bakerfdea1e32020-02-21 15:35:41 -0800110 return newDeviceRules, nil
khenaidoo19d7b632018-10-30 10:49:50 -0400111}
112
khenaidood20a5852018-10-22 22:09:55 -0400113//processControllerBoundFlow decomposes trap flows
Kent Hagerman6031aad2020-07-29 16:36:33 -0400114func (fd *FlowDecomposer) processControllerBoundFlow(ctx context.Context, agent LogicalDeviceAgent, path []route.Hop,
Scott Bakerfdea1e32020-02-21 15:35:41 -0800115 inPortNo uint32, outPortNo uint32, flow *ofp.OfpFlowStats) (*fu.DeviceRules, error) {
khenaidood20a5852018-10-22 22:09:55 -0400116
Rohan Agrawal31f21802020-06-12 05:38:46 +0000117 logger.Debugw(ctx, "trap-flow", log.Fields{"inPortNo": inPortNo, "outPortNo": outPortNo, "flow": flow})
khenaidood20a5852018-10-22 22:09:55 -0400118 deviceRules := fu.NewDeviceRules()
npujar1d86a522019-11-14 17:11:16 +0530119 meterID := fu.GetMeterIdFromFlow(flow)
Rohan Agrawal31f21802020-06-12 05:38:46 +0000120 metadataFromwriteMetadata := fu.GetMetadataFromWriteMetadataAction(ctx, flow)
khenaidood20a5852018-10-22 22:09:55 -0400121
khenaidoo820197c2020-02-13 16:35:33 -0500122 ingressHop := path[0]
123 egressHop := path[1]
khenaidood20a5852018-10-22 22:09:55 -0400124
Humera Kouser4ff89012019-08-25 19:01:51 -0400125 //case of packet_in from NNI port rule
khenaidoo820197c2020-02-13 16:35:33 -0500126 if agent.GetDeviceRoutes().IsRootPort(inPortNo) {
Humera Kouser4ff89012019-08-25 19:01:51 -0400127 // Trap flow for NNI port
Rohan Agrawal31f21802020-06-12 05:38:46 +0000128 logger.Debug(ctx, "trap-nni")
Humera Kouser4ff89012019-08-25 19:01:51 -0400129
npujar1d86a522019-11-14 17:11:16 +0530130 fa := &fu.FlowArgs{
Humera Kouser4ff89012019-08-25 19:01:51 -0400131 KV: fu.OfpFlowModArgs{"priority": uint64(flow.Priority), "cookie": flow.Cookie},
132 MatchFields: []*ofp.OfpOxmOfbField{
133 fu.InPort(egressHop.Egress),
134 },
135 Actions: fu.GetActions(flow),
136 }
137 // Augment the matchfields with the ofpfields from the flow
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400138 fg := fu.NewFlowsAndGroups()
Humera Kouser4ff89012019-08-25 19:01:51 -0400139 fa.MatchFields = append(fa.MatchFields, fu.GetOfbFields(flow, fu.IN_PORT)...)
Scott Bakerfdea1e32020-02-21 15:35:41 -0800140 fs, err := fu.MkFlowStat(fa)
141 if err != nil {
142 return nil, err
143 }
144 fg.AddFlow(fs)
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400145 deviceRules.AddFlowsAndGroup(egressHop.DeviceID, fg)
khenaidoo89b0e942018-10-21 21:11:33 -0400146 } else {
147 // Trap flow for UNI port
Rohan Agrawal31f21802020-06-12 05:38:46 +0000148 logger.Debug(ctx, "trap-uni")
Girish Gowdra9a50f032020-09-16 13:21:10 -0700149 var setVid, setPcp uint32
150 var setVidOk, setPcpOk bool
Matt Jeannerete75f2842020-03-14 15:45:12 -0400151 //inPortNo is 0 for wildcard input case, do not include upstream port for controller bound flow in input
Kent Hagermanfa9d6d42020-05-25 11:49:40 -0400152 var inPorts = map[uint32]struct{}{inPortNo: {}}
khenaidoo89b0e942018-10-21 21:11:33 -0400153 if inPortNo == 0 {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000154 inPorts = agent.GetWildcardInputPorts(ctx, egressHop.Egress) // exclude egress_hop.egress_port.port_no
khenaidoo89b0e942018-10-21 21:11:33 -0400155 }
Kent Hagermanfa9d6d42020-05-25 11:49:40 -0400156 for inputPort := range inPorts {
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400157 // Upstream flow on parent (olt) device
npujar1d86a522019-11-14 17:11:16 +0530158 faParent := &fu.FlowArgs{
159 KV: fu.OfpFlowModArgs{"priority": uint64(flow.Priority), "cookie": flow.Cookie, "meter_id": uint64(meterID), "write_metadata": metadataFromwriteMetadata},
khenaidoo89b0e942018-10-21 21:11:33 -0400160 MatchFields: []*ofp.OfpOxmOfbField{
khenaidoo68c930b2019-05-13 11:46:51 -0400161 fu.InPort(egressHop.Ingress),
khenaidoo68c930b2019-05-13 11:46:51 -0400162 fu.TunnelId(uint64(inputPort)),
khenaidoo89b0e942018-10-21 21:11:33 -0400163 },
164 Actions: []*ofp.OfpAction{
khenaidoo68c930b2019-05-13 11:46:51 -0400165 fu.Output(egressHop.Egress),
khenaidoo89b0e942018-10-21 21:11:33 -0400166 },
167 }
Girish Gowdra9a50f032020-09-16 13:21:10 -0700168 // Augment the parent device flow matchfields with the ofpfields from the flow
169 faParent.MatchFields = append(faParent.MatchFields, fu.GetOfbFields(flow, fu.IN_PORT, fu.VLAN_VID, fu.VLAN_PCP)...)
170 // Augment the parent device flow matchfields with vlan vid and vlan pcp from action field.
171 // The child device is going to set the vlan and pcp and parent device has to match on them
172 if setVid, setVidOk = fu.GetSetActionField(ctx, flow, fu.VLAN_VID); setVidOk {
173 faParent.MatchFields = append(faParent.MatchFields, fu.VlanVid(setVid))
174 if setPcp, setPcpOk = fu.GetSetActionField(ctx, flow, fu.VLAN_PCP); setPcpOk {
175 faParent.MatchFields = append(faParent.MatchFields, fu.VlanPcp(setPcp))
176 }
177 }
178
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400179 fgParent := fu.NewFlowsAndGroups()
Scott Bakerfdea1e32020-02-21 15:35:41 -0800180 fs, err := fu.MkFlowStat(faParent)
181 if err != nil {
182 return nil, err
183 }
184 fgParent.AddFlow(fs)
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400185 deviceRules.AddFlowsAndGroup(egressHop.DeviceID, fgParent)
Rohan Agrawal31f21802020-06-12 05:38:46 +0000186 logger.Debugw(ctx, "parent-trap-flow-set", log.Fields{"flow": faParent})
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400187
188 // Upstream flow on child (onu) device
189 var actions []*ofp.OfpAction
Girish Gowdra9a50f032020-09-16 13:21:10 -0700190 if setVidOk {
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400191 // have this child push the vlan the parent is matching/trapping on above
192 actions = []*ofp.OfpAction{
193 fu.PushVlan(0x8100),
Girish Gowdra9a50f032020-09-16 13:21:10 -0700194 fu.SetField(fu.VlanVid(setVid)),
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400195 fu.Output(ingressHop.Egress),
196 }
Girish Gowdra9a50f032020-09-16 13:21:10 -0700197 if setPcpOk {
198 actions = append(actions, fu.SetField(fu.VlanPcp(setPcp)))
199 }
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400200 } else {
201 // otherwise just set the egress port
202 actions = []*ofp.OfpAction{
203 fu.Output(ingressHop.Egress),
204 }
205 }
npujar1d86a522019-11-14 17:11:16 +0530206 faChild := &fu.FlowArgs{
207 KV: fu.OfpFlowModArgs{"priority": uint64(flow.Priority), "cookie": flow.Cookie, "meter_id": uint64(meterID), "write_metadata": metadataFromwriteMetadata},
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400208 MatchFields: []*ofp.OfpOxmOfbField{
209 fu.InPort(ingressHop.Ingress),
210 fu.TunnelId(uint64(inputPort)),
211 },
212 Actions: actions,
213 }
214 // Augment the matchfields with the ofpfields from the flow.
215 // If the parent has a match vid and the child is setting that match vid exclude the the match vlan
216 // for the child given it will be setting that vlan and the parent will be matching on it
Girish Gowdra9a50f032020-09-16 13:21:10 -0700217 faChild.MatchFields = append(faChild.MatchFields, fu.GetOfbFields(flow, fu.IN_PORT)...)
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400218 fgChild := fu.NewFlowsAndGroups()
Scott Bakerfdea1e32020-02-21 15:35:41 -0800219 fs, err = fu.MkFlowStat(faChild)
220 if err != nil {
221 return nil, err
222 }
223 fgChild.AddFlow(fs)
Matt Jeanneretb423bad2019-10-10 20:42:19 -0400224 deviceRules.AddFlowsAndGroup(ingressHop.DeviceID, fgChild)
Rohan Agrawal31f21802020-06-12 05:38:46 +0000225 logger.Debugw(ctx, "child-trap-flow-set", log.Fields{"flow": faChild})
khenaidoo89b0e942018-10-21 21:11:33 -0400226 }
227 }
khenaidoo2c6a0992019-04-29 13:46:56 -0400228
Scott Bakerfdea1e32020-02-21 15:35:41 -0800229 return deviceRules, nil
khenaidoo89b0e942018-10-21 21:11:33 -0400230}
231
232// processUpstreamNonControllerBoundFlow processes non-controller bound flow. We assume that anything that is
233// upstream needs to get Q-in-Q treatment and that this is expressed via two flow rules, the first using the
234// goto-statement. We also assume that the inner tag is applied at the ONU, while the outer tag is
235// applied at the OLT
khenaidoo820197c2020-02-13 16:35:33 -0500236func (fd *FlowDecomposer) processUpstreamNonControllerBoundFlow(ctx context.Context,
Scott Bakerfdea1e32020-02-21 15:35:41 -0800237 path []route.Hop, inPortNo uint32, outPortNo uint32, flow *ofp.OfpFlowStats) (*fu.DeviceRules, error) {
khenaidood20a5852018-10-22 22:09:55 -0400238
Rohan Agrawal31f21802020-06-12 05:38:46 +0000239 logger.Debugw(ctx, "upstream-non-controller-bound-flow", log.Fields{"inPortNo": inPortNo, "outPortNo": outPortNo})
khenaidood20a5852018-10-22 22:09:55 -0400240 deviceRules := fu.NewDeviceRules()
241
npujar1d86a522019-11-14 17:11:16 +0530242 meterID := fu.GetMeterIdFromFlow(flow)
Rohan Agrawal31f21802020-06-12 05:38:46 +0000243 metadataFromwriteMetadata := fu.GetMetadataFromWriteMetadataAction(ctx, flow)
Manikkaraj kb1a10922019-07-29 12:10:34 -0400244
khenaidoo820197c2020-02-13 16:35:33 -0500245 ingressHop := path[0]
246 egressHop := path[1]
khenaidood20a5852018-10-22 22:09:55 -0400247
Manikkaraj kb1a10922019-07-29 12:10:34 -0400248 if flow.TableId == 0 && fu.HasNextTable(flow) {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000249 logger.Debugw(ctx, "decomposing-onu-flow-in-upstream-has-next-table", log.Fields{"table_id": flow.TableId})
khenaidoo89b0e942018-10-21 21:11:33 -0400250 if outPortNo != 0 {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000251 logger.Warnw(ctx, "outPort-should-not-be-specified", log.Fields{"outPortNo": outPortNo})
Scott Bakerfdea1e32020-02-21 15:35:41 -0800252 return deviceRules, nil
khenaidoo89b0e942018-10-21 21:11:33 -0400253 }
npujar1d86a522019-11-14 17:11:16 +0530254 fa := &fu.FlowArgs{
255 KV: fu.OfpFlowModArgs{"priority": uint64(flow.Priority), "cookie": flow.Cookie, "meter_id": uint64(meterID), "write_metadata": metadataFromwriteMetadata},
khenaidoo89b0e942018-10-21 21:11:33 -0400256 MatchFields: []*ofp.OfpOxmOfbField{
khenaidoo68c930b2019-05-13 11:46:51 -0400257 fu.InPort(ingressHop.Ingress),
258 fu.TunnelId(uint64(inPortNo)),
khenaidoo89b0e942018-10-21 21:11:33 -0400259 },
khenaidoo68c930b2019-05-13 11:46:51 -0400260 Actions: fu.GetActions(flow),
khenaidoo89b0e942018-10-21 21:11:33 -0400261 }
262 // Augment the matchfields with the ofpfields from the flow
khenaidoo68c930b2019-05-13 11:46:51 -0400263 fa.MatchFields = append(fa.MatchFields, fu.GetOfbFields(flow, fu.IN_PORT)...)
khenaidood20a5852018-10-22 22:09:55 -0400264
265 // Augment the Actions
khenaidoo68c930b2019-05-13 11:46:51 -0400266 fa.Actions = append(fa.Actions, fu.Output(ingressHop.Egress))
khenaidood20a5852018-10-22 22:09:55 -0400267
khenaidoo89b0e942018-10-21 21:11:33 -0400268 fg := fu.NewFlowsAndGroups()
Scott Bakerfdea1e32020-02-21 15:35:41 -0800269 fs, err := fu.MkFlowStat(fa)
270 if err != nil {
271 return nil, err
272 }
273 fg.AddFlow(fs)
khenaidood20a5852018-10-22 22:09:55 -0400274 deviceRules.AddFlowsAndGroup(ingressHop.DeviceID, fg)
Manikkaraj kb1a10922019-07-29 12:10:34 -0400275 } else if flow.TableId == 1 && outPortNo != 0 {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000276 logger.Debugw(ctx, "decomposing-olt-flow-in-upstream-has-next-table", log.Fields{"table_id": flow.TableId})
npujar1d86a522019-11-14 17:11:16 +0530277 fa := &fu.FlowArgs{
278 KV: fu.OfpFlowModArgs{"priority": uint64(flow.Priority), "cookie": flow.Cookie, "meter_id": uint64(meterID), "write_metadata": metadataFromwriteMetadata},
Manikkaraj kb1a10922019-07-29 12:10:34 -0400279 MatchFields: []*ofp.OfpOxmOfbField{
280 fu.InPort(egressHop.Ingress),
281 fu.TunnelId(uint64(inPortNo)),
282 },
khenaidoo89b0e942018-10-21 21:11:33 -0400283 }
Manikkaraj kb1a10922019-07-29 12:10:34 -0400284 // Augment the matchfields with the ofpfields from the flow
285 fa.MatchFields = append(fa.MatchFields, fu.GetOfbFields(flow, fu.IN_PORT)...)
khenaidoo89b0e942018-10-21 21:11:33 -0400286
Manikkaraj kb1a10922019-07-29 12:10:34 -0400287 //Augment the actions
288 filteredAction := fu.GetActions(flow, fu.OUTPUT)
289 filteredAction = append(filteredAction, fu.Output(egressHop.Egress))
290 fa.Actions = filteredAction
khenaidood20a5852018-10-22 22:09:55 -0400291
Manikkaraj kb1a10922019-07-29 12:10:34 -0400292 fg := fu.NewFlowsAndGroups()
Scott Bakerfdea1e32020-02-21 15:35:41 -0800293 fs, err := fu.MkFlowStat(fa)
294 if err != nil {
295 return nil, err
296 }
297 fg.AddFlow(fs)
Manikkaraj kb1a10922019-07-29 12:10:34 -0400298 deviceRules.AddFlowsAndGroup(egressHop.DeviceID, fg)
khenaidoo89b0e942018-10-21 21:11:33 -0400299 }
Scott Bakerfdea1e32020-02-21 15:35:41 -0800300 return deviceRules, nil
khenaidoo89b0e942018-10-21 21:11:33 -0400301}
302
khenaidood20a5852018-10-22 22:09:55 -0400303// processDownstreamFlowWithNextTable decomposes downstream flows containing next table ID instructions
Kent Hagerman6031aad2020-07-29 16:36:33 -0400304func (fd *FlowDecomposer) processDownstreamFlowWithNextTable(ctx context.Context, agent LogicalDeviceAgent, path []route.Hop,
Scott Bakerfdea1e32020-02-21 15:35:41 -0800305 inPortNo uint32, outPortNo uint32, flow *ofp.OfpFlowStats) (*fu.DeviceRules, error) {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000306 logger.Debugw(ctx, "decomposing-olt-flow-in-downstream-flow-with-next-table", log.Fields{"inPortNo": inPortNo, "outPortNo": outPortNo})
khenaidood20a5852018-10-22 22:09:55 -0400307 deviceRules := fu.NewDeviceRules()
npujar1d86a522019-11-14 17:11:16 +0530308 meterID := fu.GetMeterIdFromFlow(flow)
Rohan Agrawal31f21802020-06-12 05:38:46 +0000309 metadataFromwriteMetadata := fu.GetMetadataFromWriteMetadataAction(ctx, flow)
khenaidood20a5852018-10-22 22:09:55 -0400310
khenaidoo89b0e942018-10-21 21:11:33 -0400311 if outPortNo != 0 {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000312 logger.Warnw(ctx, "outPort-should-not-be-specified", log.Fields{"outPortNo": outPortNo})
Scott Bakerfdea1e32020-02-21 15:35:41 -0800313 return deviceRules, nil
khenaidoo89b0e942018-10-21 21:11:33 -0400314 }
Manikkaraj kb1a10922019-07-29 12:10:34 -0400315
316 if flow.TableId != 0 {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000317 logger.Warnw(ctx, "This is not olt pipeline table, so skipping", log.Fields{"tableId": flow.TableId})
Scott Bakerfdea1e32020-02-21 15:35:41 -0800318 return deviceRules, nil
Manikkaraj kb1a10922019-07-29 12:10:34 -0400319 }
320
khenaidoo820197c2020-02-13 16:35:33 -0500321 ingressHop := path[0]
322 egressHop := path[1]
Manikkaraj kb1a10922019-07-29 12:10:34 -0400323 if metadataFromwriteMetadata != 0 {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000324 logger.Debugw(ctx, "creating-metadata-flow", log.Fields{"flow": flow})
325 portNumber := fu.GetEgressPortNumberFromWriteMetadata(ctx, flow)
khenaidoo89b0e942018-10-21 21:11:33 -0400326 if portNumber != 0 {
khenaidoo820197c2020-02-13 16:35:33 -0500327 recalculatedRoute, err := agent.GetRoute(ctx, inPortNo, portNumber)
328 if err != nil {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000329 logger.Errorw(ctx, "no-route-double-tag", log.Fields{"inPortNo": inPortNo, "outPortNo": outPortNo, "metadata": metadataFromwriteMetadata, "error": err})
Scott Bakerfdea1e32020-02-21 15:35:41 -0800330 return deviceRules, nil
khenaidoo820197c2020-02-13 16:35:33 -0500331 }
khenaidoo89b0e942018-10-21 21:11:33 -0400332 switch len(recalculatedRoute) {
333 case 0:
Rohan Agrawal31f21802020-06-12 05:38:46 +0000334 logger.Errorw(ctx, "no-route-double-tag", log.Fields{"inPortNo": inPortNo, "outPortNo": portNumber, "comment": "deleting-flow", "metadata": metadataFromwriteMetadata})
Manikkaraj kb1a10922019-07-29 12:10:34 -0400335 //TODO: Delete flow
Scott Bakerfdea1e32020-02-21 15:35:41 -0800336 return deviceRules, nil
khenaidoo89b0e942018-10-21 21:11:33 -0400337 case 2:
Rohan Agrawal31f21802020-06-12 05:38:46 +0000338 logger.Debugw(ctx, "route-found", log.Fields{"ingressHop": ingressHop, "egressHop": egressHop})
khenaidoo89b0e942018-10-21 21:11:33 -0400339 default:
Rohan Agrawal31f21802020-06-12 05:38:46 +0000340 logger.Errorw(ctx, "invalid-route-length", log.Fields{"routeLen": len(path)})
Scott Bakerfdea1e32020-02-21 15:35:41 -0800341 return deviceRules, nil
khenaidoo89b0e942018-10-21 21:11:33 -0400342 }
343 ingressHop = recalculatedRoute[0]
344 }
Rohan Agrawal31f21802020-06-12 05:38:46 +0000345 innerTag := fu.GetInnerTagFromMetaData(ctx, flow)
khenaidoo89b0e942018-10-21 21:11:33 -0400346 if innerTag == 0 {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000347 logger.Errorw(ctx, "no-inner-route-double-tag", log.Fields{"inPortNo": inPortNo, "outPortNo": portNumber, "comment": "deleting-flow", "metadata": metadataFromwriteMetadata})
Manikkaraj kb1a10922019-07-29 12:10:34 -0400348 //TODO: Delete flow
Scott Bakerfdea1e32020-02-21 15:35:41 -0800349 return deviceRules, nil
khenaidoo89b0e942018-10-21 21:11:33 -0400350 }
npujar1d86a522019-11-14 17:11:16 +0530351 fa := &fu.FlowArgs{
352 KV: fu.OfpFlowModArgs{"priority": uint64(flow.Priority), "cookie": flow.Cookie, "meter_id": uint64(meterID), "write_metadata": metadataFromwriteMetadata},
khenaidoo89b0e942018-10-21 21:11:33 -0400353 MatchFields: []*ofp.OfpOxmOfbField{
khenaidoo68c930b2019-05-13 11:46:51 -0400354 fu.InPort(ingressHop.Ingress),
Manikkaraj kb1a10922019-07-29 12:10:34 -0400355 fu.Metadata_ofp(uint64(innerTag)),
khenaidoo68c930b2019-05-13 11:46:51 -0400356 fu.TunnelId(uint64(portNumber)),
khenaidoo89b0e942018-10-21 21:11:33 -0400357 },
khenaidoo68c930b2019-05-13 11:46:51 -0400358 Actions: fu.GetActions(flow),
khenaidoo89b0e942018-10-21 21:11:33 -0400359 }
360 // Augment the matchfields with the ofpfields from the flow
khenaidoo68c930b2019-05-13 11:46:51 -0400361 fa.MatchFields = append(fa.MatchFields, fu.GetOfbFields(flow, fu.IN_PORT, fu.METADATA)...)
khenaidood20a5852018-10-22 22:09:55 -0400362
363 // Augment the Actions
khenaidoo68c930b2019-05-13 11:46:51 -0400364 fa.Actions = append(fa.Actions, fu.Output(ingressHop.Egress))
khenaidood20a5852018-10-22 22:09:55 -0400365
khenaidoo89b0e942018-10-21 21:11:33 -0400366 fg := fu.NewFlowsAndGroups()
Scott Bakerfdea1e32020-02-21 15:35:41 -0800367 fs, err := fu.MkFlowStat(fa)
368 if err != nil {
369 return nil, err
370 }
371 fg.AddFlow(fs)
khenaidoo89b0e942018-10-21 21:11:33 -0400372 deviceRules.AddFlowsAndGroup(ingressHop.DeviceID, fg)
373 } else { // Create standard flow
Rohan Agrawal31f21802020-06-12 05:38:46 +0000374 logger.Debugw(ctx, "creating-standard-flow", log.Fields{"flow": flow})
npujar1d86a522019-11-14 17:11:16 +0530375 fa := &fu.FlowArgs{
376 KV: fu.OfpFlowModArgs{"priority": uint64(flow.Priority), "cookie": flow.Cookie, "meter_id": uint64(meterID), "write_metadata": metadataFromwriteMetadata},
khenaidoo89b0e942018-10-21 21:11:33 -0400377 MatchFields: []*ofp.OfpOxmOfbField{
khenaidoo68c930b2019-05-13 11:46:51 -0400378 fu.InPort(ingressHop.Ingress),
379 fu.TunnelId(uint64(inPortNo)),
khenaidoo89b0e942018-10-21 21:11:33 -0400380 },
khenaidoo68c930b2019-05-13 11:46:51 -0400381 Actions: fu.GetActions(flow),
khenaidoo89b0e942018-10-21 21:11:33 -0400382 }
383 // Augment the matchfields with the ofpfields from the flow
khenaidoo68c930b2019-05-13 11:46:51 -0400384 fa.MatchFields = append(fa.MatchFields, fu.GetOfbFields(flow, fu.IN_PORT)...)
khenaidood20a5852018-10-22 22:09:55 -0400385
386 // Augment the Actions
khenaidoo68c930b2019-05-13 11:46:51 -0400387 fa.Actions = append(fa.Actions, fu.Output(ingressHop.Egress))
khenaidood20a5852018-10-22 22:09:55 -0400388
khenaidoo89b0e942018-10-21 21:11:33 -0400389 fg := fu.NewFlowsAndGroups()
Scott Bakerfdea1e32020-02-21 15:35:41 -0800390 fs, err := fu.MkFlowStat(fa)
391 if err != nil {
392 return nil, err
393 }
394 fg.AddFlow(fs)
khenaidoo89b0e942018-10-21 21:11:33 -0400395 deviceRules.AddFlowsAndGroup(ingressHop.DeviceID, fg)
396 }
khenaidoo2c6a0992019-04-29 13:46:56 -0400397
Scott Bakerfdea1e32020-02-21 15:35:41 -0800398 return deviceRules, nil
khenaidoo89b0e942018-10-21 21:11:33 -0400399}
400
khenaidood20a5852018-10-22 22:09:55 -0400401// processUnicastFlow decomposes unicast flows
khenaidoo820197c2020-02-13 16:35:33 -0500402func (fd *FlowDecomposer) processUnicastFlow(ctx context.Context, path []route.Hop,
Scott Bakerfdea1e32020-02-21 15:35:41 -0800403 inPortNo uint32, outPortNo uint32, flow *ofp.OfpFlowStats) (*fu.DeviceRules, error) {
khenaidood20a5852018-10-22 22:09:55 -0400404
Rohan Agrawal31f21802020-06-12 05:38:46 +0000405 logger.Debugw(ctx, "decomposing-onu-flow-in-downstream-unicast-flow", log.Fields{"inPortNo": inPortNo, "outPortNo": outPortNo})
khenaidood20a5852018-10-22 22:09:55 -0400406 deviceRules := fu.NewDeviceRules()
407
khenaidoo820197c2020-02-13 16:35:33 -0500408 egressHop := path[1]
khenaidood20a5852018-10-22 22:09:55 -0400409
npujar1d86a522019-11-14 17:11:16 +0530410 meterID := fu.GetMeterIdFromFlow(flow)
Rohan Agrawal31f21802020-06-12 05:38:46 +0000411 metadataFromwriteMetadata := fu.GetMetadataFromWriteMetadataAction(ctx, flow)
npujar1d86a522019-11-14 17:11:16 +0530412 fa := &fu.FlowArgs{
413 KV: fu.OfpFlowModArgs{"priority": uint64(flow.Priority), "cookie": flow.Cookie, "meter_id": uint64(meterID), "write_metadata": metadataFromwriteMetadata},
Manikkaraj kb1a10922019-07-29 12:10:34 -0400414 MatchFields: []*ofp.OfpOxmOfbField{
415 fu.InPort(egressHop.Ingress),
416 },
khenaidoo89b0e942018-10-21 21:11:33 -0400417 }
Manikkaraj kb1a10922019-07-29 12:10:34 -0400418 // Augment the matchfields with the ofpfields from the flow
419 fa.MatchFields = append(fa.MatchFields, fu.GetOfbFields(flow, fu.IN_PORT)...)
khenaidood20a5852018-10-22 22:09:55 -0400420
Manikkaraj kb1a10922019-07-29 12:10:34 -0400421 // Augment the Actions
422 filteredAction := fu.GetActions(flow, fu.OUTPUT)
423 filteredAction = append(filteredAction, fu.Output(egressHop.Egress))
424 fa.Actions = filteredAction
khenaidoo89b0e942018-10-21 21:11:33 -0400425
Manikkaraj kb1a10922019-07-29 12:10:34 -0400426 fg := fu.NewFlowsAndGroups()
Scott Bakerfdea1e32020-02-21 15:35:41 -0800427 fs, err := fu.MkFlowStat(fa)
428 if err != nil {
429 return nil, err
430 }
431 fg.AddFlow(fs)
Manikkaraj kb1a10922019-07-29 12:10:34 -0400432 deviceRules.AddFlowsAndGroup(egressHop.DeviceID, fg)
Scott Bakerfdea1e32020-02-21 15:35:41 -0800433 return deviceRules, nil
khenaidoo89b0e942018-10-21 21:11:33 -0400434}
435
khenaidood20a5852018-10-22 22:09:55 -0400436// processMulticastFlow decompose multicast flows
khenaidoo820197c2020-02-13 16:35:33 -0500437func (fd *FlowDecomposer) processMulticastFlow(ctx context.Context, path []route.Hop,
npujar1d86a522019-11-14 17:11:16 +0530438 inPortNo uint32, outPortNo uint32, flow *ofp.OfpFlowStats, grpID uint32,
khenaidood20a5852018-10-22 22:09:55 -0400439 groupMap map[uint32]*ofp.OfpGroupEntry) *fu.DeviceRules {
440
Rohan Agrawal31f21802020-06-12 05:38:46 +0000441 logger.Debugw(ctx, "multicast-flow", log.Fields{"inPortNo": inPortNo, "outPortNo": outPortNo})
khenaidood20a5852018-10-22 22:09:55 -0400442 deviceRules := fu.NewDeviceRules()
khenaidoo89b0e942018-10-21 21:11:33 -0400443
444 //having no Group yet is the same as having a Group with no buckets
445 var grp *ofp.OfpGroupEntry
446 var ok bool
npujar1d86a522019-11-14 17:11:16 +0530447 if grp, ok = groupMap[grpID]; !ok {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000448 logger.Warnw(ctx, "Group-id-not-present-in-map", log.Fields{"grpId": grpID, "groupMap": groupMap})
khenaidoo89b0e942018-10-21 21:11:33 -0400449 return deviceRules
450 }
451 if grp == nil || grp.Desc == nil {
Rohan Agrawal31f21802020-06-12 05:38:46 +0000452 logger.Warnw(ctx, "Group-or-desc-nil", log.Fields{"grpId": grpID, "grp": grp})
khenaidoo89b0e942018-10-21 21:11:33 -0400453 return deviceRules
454 }
khenaidoo89b0e942018-10-21 21:11:33 -0400455
khenaidoo820197c2020-02-13 16:35:33 -0500456 deviceRules.CreateEntryIfNotExist(path[0].DeviceID)
Esin Karaman09959ae2019-11-29 13:59:58 +0000457 fg := fu.NewFlowsAndGroups()
458 fg.AddFlow(flow)
459 //return the multicast flow without decomposing it
khenaidoo820197c2020-02-13 16:35:33 -0500460 deviceRules.AddFlowsAndGroup(path[0].DeviceID, fg)
khenaidoo89b0e942018-10-21 21:11:33 -0400461 return deviceRules
462}
463
khenaidood20a5852018-10-22 22:09:55 -0400464// decomposeFlow decomposes a flow for a logical device into flows for each physical device
Kent Hagerman6031aad2020-07-29 16:36:33 -0400465func (fd *FlowDecomposer) decomposeFlow(ctx context.Context, agent LogicalDeviceAgent, flow *ofp.OfpFlowStats,
khenaidoo820197c2020-02-13 16:35:33 -0500466 groupMap map[uint32]*ofp.OfpGroupEntry) (*fu.DeviceRules, error) {
khenaidood20a5852018-10-22 22:09:55 -0400467
khenaidoo68c930b2019-05-13 11:46:51 -0400468 inPortNo := fu.GetInPort(flow)
Esin Karaman09959ae2019-11-29 13:59:58 +0000469 if fu.HasGroup(flow) && inPortNo == 0 {
470 //if no in-port specified for a multicast flow, put NNI port as in-port
khenaidoo820197c2020-02-13 16:35:33 -0500471 //so that a valid path can be found for the flow
Esin Karaman09959ae2019-11-29 13:59:58 +0000472 nniPorts := agent.GetNNIPorts()
473 if len(nniPorts) > 0 {
Kent Hagermanfa9d6d42020-05-25 11:49:40 -0400474 for port := range nniPorts {
475 inPortNo = port
476 break
477 }
Rohan Agrawal31f21802020-06-12 05:38:46 +0000478 logger.Debugw(ctx, "assigning-nni-port-as-in-port-for-multicast-flow", log.Fields{"nni": inPortNo, "flow:": flow})
Esin Karaman09959ae2019-11-29 13:59:58 +0000479 }
480 }
khenaidoo68c930b2019-05-13 11:46:51 -0400481 outPortNo := fu.GetOutPort(flow)
khenaidoo89b0e942018-10-21 21:11:33 -0400482 deviceRules := fu.NewDeviceRules()
khenaidoo820197c2020-02-13 16:35:33 -0500483 path, err := agent.GetRoute(ctx, inPortNo, outPortNo)
484 if err != nil {
khenaidoo820197c2020-02-13 16:35:33 -0500485 return deviceRules, err
486 }
khenaidoo2c6a0992019-04-29 13:46:56 -0400487
khenaidoo820197c2020-02-13 16:35:33 -0500488 switch len(path) {
khenaidoo89b0e942018-10-21 21:11:33 -0400489 case 0:
khenaidoo787224a2020-04-16 18:08:47 -0400490 return deviceRules, fmt.Errorf("no route from:%d to:%d :%w", inPortNo, outPortNo, route.ErrNoRoute)
khenaidoo89b0e942018-10-21 21:11:33 -0400491 case 2:
Rohan Agrawal31f21802020-06-12 05:38:46 +0000492 logger.Debugw(ctx, "route-found", log.Fields{"ingressHop": path[0], "egressHop": path[1]})
khenaidoo89b0e942018-10-21 21:11:33 -0400493 default:
khenaidoo787224a2020-04-16 18:08:47 -0400494 return deviceRules, fmt.Errorf("invalid route length %d :%w", len(path), route.ErrNoRoute)
khenaidoo89b0e942018-10-21 21:11:33 -0400495 }
496
khenaidoo89b0e942018-10-21 21:11:33 -0400497 // Process controller bound flow
498 if outPortNo != 0 && (outPortNo&0x7fffffff) == uint32(ofp.OfpPortNo_OFPP_CONTROLLER) {
Scott Bakerfdea1e32020-02-21 15:35:41 -0800499 deviceRules, err = fd.processControllerBoundFlow(ctx, agent, path, inPortNo, outPortNo, flow)
500 if err != nil {
501 return nil, err
502 }
khenaidoo89b0e942018-10-21 21:11:33 -0400503 } else {
khenaidoo297cd252019-02-07 22:10:23 -0500504 var ingressDevice *voltha.Device
505 var err error
Kent Hagerman6031aad2020-07-29 16:36:33 -0400506 if ingressDevice, err = fd.getDevice(ctx, path[0].DeviceID); err != nil {
khenaidoo787224a2020-04-16 18:08:47 -0400507 // This can happen in a race condition where a device is deleted right after we obtain a
508 // route involving the device (GetRoute() above). Handle it as a no route event as well.
509 return deviceRules, fmt.Errorf("get-device-error :%v :%w", err, route.ErrNoRoute)
khenaidoo297cd252019-02-07 22:10:23 -0500510 }
511 isUpstream := !ingressDevice.Root
Manikkaraj kb1a10922019-07-29 12:10:34 -0400512 if isUpstream { // Unicast OLT and ONU UL
Rohan Agrawal31f21802020-06-12 05:38:46 +0000513 logger.Debug(ctx, "process-olt-nd-onu-upstream-noncontrollerbound-unicast-flows", log.Fields{"flows": flow})
Scott Bakerfdea1e32020-02-21 15:35:41 -0800514 deviceRules, err = fd.processUpstreamNonControllerBoundFlow(ctx, path, inPortNo, outPortNo, flow)
515 if err != nil {
516 return nil, err
517 }
Manikkaraj kb1a10922019-07-29 12:10:34 -0400518 } else if fu.HasNextTable(flow) && flow.TableId == 0 { // Unicast OLT flow DL
Rohan Agrawal31f21802020-06-12 05:38:46 +0000519 logger.Debugw(ctx, "process-olt-downstream-noncontrollerbound-flow-with-nexttable", log.Fields{"flows": flow})
Scott Bakerfdea1e32020-02-21 15:35:41 -0800520 deviceRules, err = fd.processDownstreamFlowWithNextTable(ctx, agent, path, inPortNo, outPortNo, flow)
521 if err != nil {
522 return nil, err
523 }
Manikkaraj kb1a10922019-07-29 12:10:34 -0400524 } else if flow.TableId == 1 && outPortNo != 0 { // Unicast ONU flow DL
Rohan Agrawal31f21802020-06-12 05:38:46 +0000525 logger.Debugw(ctx, "process-onu-downstream-unicast-flow", log.Fields{"flows": flow})
Scott Bakerfdea1e32020-02-21 15:35:41 -0800526 deviceRules, err = fd.processUnicastFlow(ctx, path, inPortNo, outPortNo, flow)
527 if err != nil {
528 return nil, err
529 }
npujar1d86a522019-11-14 17:11:16 +0530530 } else if grpID := fu.GetGroup(flow); grpID != 0 && flow.TableId == 0 { //Multicast
Rohan Agrawal31f21802020-06-12 05:38:46 +0000531 logger.Debugw(ctx, "process-multicast-flow", log.Fields{"flows": flow})
khenaidoo820197c2020-02-13 16:35:33 -0500532 deviceRules = fd.processMulticastFlow(ctx, path, inPortNo, outPortNo, flow, grpID, groupMap)
Manikkaraj kb1a10922019-07-29 12:10:34 -0400533 } else {
khenaidoo820197c2020-02-13 16:35:33 -0500534 return deviceRules, status.Errorf(codes.Aborted, "unknown downstream flow %v", *flow)
khenaidoo89b0e942018-10-21 21:11:33 -0400535 }
536 }
Kent Hagerman6031aad2020-07-29 16:36:33 -0400537 deviceRules, err = fd.updateOutputPortForControllerBoundFlowForParentDevide(ctx, deviceRules)
Scott Bakerfdea1e32020-02-21 15:35:41 -0800538 return deviceRules, err
khenaidoo89b0e942018-10-21 21:11:33 -0400539}