blob: 26b250eaa8d0a511f43db9f0c8add6d28f7814ba [file] [log] [blame]
Naveen Sampath04696f72022-06-13 15:19:14 +05301/*
2* Copyright 2022-present Open Networking Foundation
3* Licensed under the Apache License, Version 2.0 (the "License");
4* you may not use this file except in compliance with the License.
5* You may obtain a copy of the License at
6*
7* http://www.apache.org/licenses/LICENSE-2.0
8*
9* Unless required by applicable law or agreed to in writing, software
10* distributed under the License is distributed on an "AS IS" BASIS,
11* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12* See the License for the specific language governing permissions and
13* limitations under the License.
vinokuma926cb3e2023-03-29 11:41:06 +053014 */
Naveen Sampath04696f72022-06-13 15:19:14 +053015
16package controller
17
18import (
19 "context"
20 "strconv"
21 "time"
22
23 "voltha-go-controller/internal/pkg/intf"
24 "voltha-go-controller/internal/pkg/of"
25 "voltha-go-controller/internal/pkg/tasks"
26 "voltha-go-controller/internal/pkg/util"
Tinoj Joseph1d108322022-07-13 10:07:39 +053027 "voltha-go-controller/log"
vinokuma926cb3e2023-03-29 11:41:06 +053028
Naveen Sampath04696f72022-06-13 15:19:14 +053029 "github.com/opencord/voltha-protos/v5/go/common"
30 ofp "github.com/opencord/voltha-protos/v5/go/openflow_13"
31 "github.com/opencord/voltha-protos/v5/go/voltha"
32)
33
34var (
35 rcvdGroups map[uint32]*ofp.OfpGroupDesc
36 groupsToAdd []*of.Group
37 groupsToMod []*of.Group
38)
39
40// AuditTablesTask structure
41type AuditTablesTask struct {
Naveen Sampath04696f72022-06-13 15:19:14 +053042 ctx context.Context
43 device *Device
Naveen Sampath04696f72022-06-13 15:19:14 +053044 timestamp string
vinokuma926cb3e2023-03-29 11:41:06 +053045 taskID uint8
46 stop bool
Naveen Sampath04696f72022-06-13 15:19:14 +053047}
48
49// NewAuditTablesTask is constructor for AuditTablesTask
50func NewAuditTablesTask(device *Device) *AuditTablesTask {
51 var att AuditTablesTask
52 att.device = device
53 att.stop = false
54 tstamp := (time.Now()).Format(time.RFC3339Nano)
55 att.timestamp = tstamp
56 return &att
57}
58
59// Name returns name of the task
60func (att *AuditTablesTask) Name() string {
61 return "Audit Table Task"
62}
63
64// TaskID to return task id of the task
65func (att *AuditTablesTask) TaskID() uint8 {
66 return att.taskID
67}
68
69// Timestamp to return timestamp for the task
70func (att *AuditTablesTask) Timestamp() string {
71 return att.timestamp
72}
73
74// Stop to stop the task
75func (att *AuditTablesTask) Stop() {
76 att.stop = true
77}
78
79// Start is called by the framework and is responsible for implementing
80// the actual task.
81func (att *AuditTablesTask) Start(ctx context.Context, taskID uint8) error {
82 logger.Warnw(ctx, "Audit Table Task Triggered", log.Fields{"Context": ctx, "taskId": taskID, "Device": att.device.ID})
83 att.taskID = taskID
84 att.ctx = ctx
85 var errInfo error
86 var err error
87
Tinoj Josephaf37ce82022-12-28 11:59:43 +053088 // Audit ports
89 if err = att.AuditPorts(); err != nil {
90 logger.Errorw(ctx, "Audit Ports Failed", log.Fields{"Reason": err.Error()})
91 errInfo = err
92 }
93
Naveen Sampath04696f72022-06-13 15:19:14 +053094 // Audit the meters
95 if err = att.AuditMeters(); err != nil {
96 logger.Errorw(ctx, "Audit Meters Failed", log.Fields{"Reason": err.Error()})
97 errInfo = err
98 }
99
100 // Audit the Groups
101 if rcvdGroups, err = att.AuditGroups(); err != nil {
102 logger.Errorw(ctx, "Audit Groups Failed", log.Fields{"Reason": err.Error()})
103 errInfo = err
104 }
105
106 // Audit the flows
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530107 if err = att.AuditFlows(ctx); err != nil {
Naveen Sampath04696f72022-06-13 15:19:14 +0530108 logger.Errorw(ctx, "Audit Flows Failed", log.Fields{"Reason": err.Error()})
109 errInfo = err
110 }
111
112 // Triggering deletion of excess groups from device after the corresponding flows are removed
113 // to avoid flow dependency error during group deletion
114 logger.Infow(ctx, "Excess Groups", log.Fields{"Groups": rcvdGroups})
115 att.DelExcessGroups(rcvdGroups)
116 logger.Warnw(ctx, "Audit Table Task Completed", log.Fields{"Context": ctx, "taskId": taskID, "Device": att.device.ID})
117 return errInfo
Naveen Sampath04696f72022-06-13 15:19:14 +0530118}
119
120// AuditMeters : Audit the meters which includes fetching the existing meters at the
121// voltha and identifying the delta between the ones held here and the
122// ones held at VOLTHA. The delta must be cleaned up to keep both the
123// components in sync
124func (att *AuditTablesTask) AuditMeters() error {
Naveen Sampath04696f72022-06-13 15:19:14 +0530125 if att.stop {
126 return tasks.ErrTaskCancelError
127 }
128 var vc voltha.VolthaServiceClient
129 if vc = att.device.VolthaClient(); vc == nil {
130 logger.Error(ctx, "Fetch Device Meters Failed: Voltha Client Unavailable")
131 return nil
132 }
133
134 //-----------------------------
135 // Perform the audit of meters
136 // Fetch the meters
137 ms, err := vc.ListLogicalDeviceMeters(att.ctx, &voltha.ID{Id: att.device.ID})
138 if err != nil {
139 logger.Warnw(ctx, "Audit of flows failed", log.Fields{"Reason": err.Error()})
140 return err
141 }
142
143 // Build the map for easy and faster processing
144 rcvdMeters := make(map[uint32]*ofp.OfpMeterStats)
145 for _, m := range ms.Items {
146 rcvdMeters[m.Stats.MeterId] = m.Stats
147 }
148
149 // Verify all meters that are in the controller but not in the device
150 missingMeters := []*of.Meter{}
151 for _, meter := range att.device.meters {
Naveen Sampath04696f72022-06-13 15:19:14 +0530152 if att.stop {
153 break
154 }
155 logger.Debugw(ctx, "Auditing Meter", log.Fields{"Id": meter.ID})
156
157 if _, ok := rcvdMeters[meter.ID]; ok {
158 // The meter exists in the device too. Just remove it from
159 // the received meters
160 delete(rcvdMeters, meter.ID)
161 } else {
162 // The flow exists at the controller but not at the device
163 // Push the flow to the device
164 logger.Debugw(ctx, "Adding Meter To Missing Meters", log.Fields{"Id": meter.ID})
165 missingMeters = append(missingMeters, meter)
166 }
167 }
168 if !att.stop {
169 att.AddMissingMeters(missingMeters)
170 att.DelExcessMeters(rcvdMeters)
171 } else {
172 err = tasks.ErrTaskCancelError
173 }
174 return err
175}
176
177// AddMissingMeters adds the missing meters detected by AuditMeters
178func (att *AuditTablesTask) AddMissingMeters(meters []*of.Meter) {
179 logger.Debugw(ctx, "Adding missing meters", log.Fields{"Number": len(meters)})
180 for _, meter := range meters {
181 meterMod, err := of.MeterUpdate(att.device.ID, of.MeterCommandAdd, meter)
182 if err != nil {
183 logger.Errorw(ctx, "Update Meter Table Failed", log.Fields{"Reason": err.Error()})
184 continue
185 }
186 if vc := att.device.VolthaClient(); vc != nil {
187 if _, err = vc.UpdateLogicalDeviceMeterTable(att.ctx, meterMod); err != nil {
188 logger.Errorw(ctx, "Update Meter Table Failed", log.Fields{"Reason": err.Error()})
189 }
190 } else {
191 logger.Error(ctx, "Update Meter Table Failed: Voltha Client Unavailable")
192 }
193 }
194}
195
196// DelExcessMeters to delete excess meters
197func (att *AuditTablesTask) DelExcessMeters(meters map[uint32]*ofp.OfpMeterStats) {
198 logger.Debugw(ctx, "Deleting Excess Meters", log.Fields{"Number": len(meters)})
199 for _, meter := range meters {
200 meterMod := &ofp.OfpMeterMod{}
201 meterMod.Command = ofp.OfpMeterModCommand_OFPMC_DELETE
202 meterMod.MeterId = meter.MeterId
203 meterUpd := &ofp.MeterModUpdate{Id: att.device.ID, MeterMod: meterMod}
204 if vc := att.device.VolthaClient(); vc != nil {
205 if _, err := vc.UpdateLogicalDeviceMeterTable(att.ctx, meterUpd); err != nil {
206 logger.Errorw(ctx, "Update Meter Table Failed", log.Fields{"Reason": err.Error()})
207 }
208 } else {
209 logger.Error(ctx, "Update Meter Table Failed: Voltha Client Unavailable")
210 }
211 }
212}
213
214// AuditFlows audit the flows which includes fetching the existing meters at the
215// voltha and identifying the delta between the ones held here and the
216// ones held at VOLTHA. The delta must be cleaned up to keep both the
217// components in sync
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530218func (att *AuditTablesTask) AuditFlows(cntx context.Context) error {
Naveen Sampath04696f72022-06-13 15:19:14 +0530219 if att.stop {
220 return tasks.ErrTaskCancelError
221 }
222
223 var vc voltha.VolthaServiceClient
224 if vc = att.device.VolthaClient(); vc == nil {
225 logger.Error(ctx, "Flow Audit Failed: Voltha Client Unavailable")
226 return nil
227 }
228
229 // ---------------------------------
230 // Perform the audit of flows first
231 // Retrieve the flows from the device
232 f, err := vc.ListLogicalDeviceFlows(att.ctx, &common.ID{Id: att.device.ID})
233 if err != nil {
234 logger.Warnw(ctx, "Audit of flows failed", log.Fields{"Reason": err.Error()})
235 return err
236 }
237
238 defaultSuccessFlowStatus := intf.FlowStatus{
239 Device: att.device.ID,
240 FlowModType: of.CommandAdd,
241 Status: 0,
242 Reason: "",
243 }
244
245 // Build the map for easy and faster processing
246 rcvdFlows := make(map[uint64]*ofp.OfpFlowStats)
247 flowsToAdd := &of.VoltFlow{}
248 flowsToAdd.SubFlows = make(map[uint64]*of.VoltSubFlow)
249 for _, flow := range f.Items {
250 rcvdFlows[flow.Cookie] = flow
251 }
252
253 att.device.flowLock.Lock()
254 // Verify all flows that are in the controller but not in the device
255 for _, flow := range att.device.flows {
Naveen Sampath04696f72022-06-13 15:19:14 +0530256 if att.stop {
257 break
258 }
259
260 logger.Debugw(ctx, "Auditing Flow", log.Fields{"Cookie": flow.Cookie})
261 if _, ok := rcvdFlows[flow.Cookie]; ok {
262 // The flow exists in the device too. Just remove it from
263 // the received flows & trigger flow success indication unless
264 // the flow in del failure/pending state
265
266 if flow.State != of.FlowDelFailure && flow.State != of.FlowDelPending {
267 delete(rcvdFlows, flow.Cookie)
268 }
269 defaultSuccessFlowStatus.Cookie = strconv.FormatUint(flow.Cookie, 10)
270
271 logger.Infow(ctx, "Triggering Internal Flow Notification", log.Fields{"Flow Status": defaultSuccessFlowStatus})
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530272 GetController().ProcessFlowModResultIndication(cntx, defaultSuccessFlowStatus)
Naveen Sampath04696f72022-06-13 15:19:14 +0530273 } else {
274 // The flow exists at the controller but not at the device
275 // Push the flow to the device
276 logger.Debugw(ctx, "Adding Flow To Missing Flows", log.Fields{"Cookie": flow.Cookie})
277 flowsToAdd.SubFlows[flow.Cookie] = flow
278 }
279 }
280 att.device.flowLock.Unlock()
281
282 if !att.stop {
283 // The flows remaining in the received flows are the excess flows at
284 // the device. Delete those flows
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530285 att.DelExcessFlows(cntx, rcvdFlows)
Naveen Sampath04696f72022-06-13 15:19:14 +0530286 // Add the flows missing at the device
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530287 att.AddMissingFlows(cntx, flowsToAdd)
Naveen Sampath04696f72022-06-13 15:19:14 +0530288 } else {
289 err = tasks.ErrTaskCancelError
290 }
291 return err
292}
293
294// AddMissingFlows : The flows missing from the device are reinstalled att the audit
295// The flows are added into a VoltFlow structure.
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530296func (att *AuditTablesTask) AddMissingFlows(cntx context.Context, mflow *of.VoltFlow) {
Naveen Sampath04696f72022-06-13 15:19:14 +0530297 logger.Debugw(ctx, "Add Missing Flows", log.Fields{"Number": len(mflow.SubFlows)})
298 mflow.Command = of.CommandAdd
299 ofFlows := of.ProcessVoltFlow(att.device.ID, mflow.Command, mflow.SubFlows)
300 var vc voltha.VolthaServiceClient
301 var bwConsumedInfo of.BwAvailDetails
302 if vc = att.device.VolthaClient(); vc == nil {
303 logger.Error(ctx, "Update Flow Table Failed: Voltha Client Unavailable")
304 return
305 }
306 for _, flow := range ofFlows {
307 var dbFlow *of.VoltSubFlow
308 var present bool
309 if flow.FlowMod != nil {
310 if dbFlow, present = att.device.GetFlow(flow.FlowMod.Cookie); !present {
Tinoj Joseph1d108322022-07-13 10:07:39 +0530311 logger.Warnw(ctx, "Flow Removed from DB. Ignoring Add Missing Flow", log.Fields{"Device": att.device.ID, "Cookie": flow.FlowMod.Cookie})
Naveen Sampath04696f72022-06-13 15:19:14 +0530312 continue
313 }
314 }
315 var err error
316 if _, err = vc.UpdateLogicalDeviceFlowTable(att.ctx, flow); err != nil {
317 logger.Errorw(ctx, "Update Flow Table Failed", log.Fields{"Reason": err.Error()})
318 }
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530319 att.device.triggerFlowResultNotification(cntx, flow.FlowMod.Cookie, dbFlow, of.CommandAdd, bwConsumedInfo, err)
Naveen Sampath04696f72022-06-13 15:19:14 +0530320 }
321}
322
323// DelExcessFlows delete the excess flows held at the VOLTHA
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530324func (att *AuditTablesTask) DelExcessFlows(cntx context.Context, flows map[uint64]*ofp.OfpFlowStats) {
Naveen Sampath04696f72022-06-13 15:19:14 +0530325 logger.Debugw(ctx, "Deleting Excess Flows", log.Fields{"Number of Flows": len(flows)})
326
327 var vc voltha.VolthaServiceClient
328 if vc = att.device.VolthaClient(); vc == nil {
329 logger.Error(ctx, "Delete Excess Flows Failed: Voltha Client Unavailable")
330 return
331 }
332
333 // Let's cycle through the flows to delete the excess flows
334 for _, flow := range flows {
Naveen Sampath04696f72022-06-13 15:19:14 +0530335 if _, present := att.device.GetFlow(flow.Cookie); present {
Tinoj Joseph1d108322022-07-13 10:07:39 +0530336 logger.Warnw(ctx, "Flow Present in DB. Ignoring Delete Excess Flow", log.Fields{"Device": att.device.ID, "Cookie": flow.Cookie})
Naveen Sampath04696f72022-06-13 15:19:14 +0530337 continue
338 }
339
340 logger.Debugw(ctx, "Deleting Flow", log.Fields{"Cookie": flow.Cookie})
341 // Create the flowMod structure and fill it out
342 flowMod := &ofp.OfpFlowMod{}
343 flowMod.Cookie = flow.Cookie
344 flowMod.TableId = flow.TableId
345 flowMod.Command = ofp.OfpFlowModCommand_OFPFC_DELETE_STRICT
346 flowMod.IdleTimeout = flow.IdleTimeout
347 flowMod.HardTimeout = flow.HardTimeout
348 flowMod.Priority = flow.Priority
349 flowMod.BufferId = of.DefaultBufferID
350 flowMod.OutPort = of.DefaultOutPort
351 flowMod.OutGroup = of.DefaultOutGroup
352 flowMod.Flags = flow.Flags
353 flowMod.Match = flow.Match
354 flowMod.Instructions = flow.Instructions
355
356 // Create FlowTableUpdate
357 flowUpdate := &ofp.FlowTableUpdate{
358 Id: att.device.ID,
359 FlowMod: flowMod,
360 }
361
362 var err error
363 if _, err = vc.UpdateLogicalDeviceFlowTable(att.ctx, flowUpdate); err != nil {
364 logger.Errorw(ctx, "Flow Audit Delete Failed", log.Fields{"Reason": err.Error()})
365 }
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530366 att.device.triggerFlowResultNotification(cntx, flow.Cookie, nil, of.CommandDel, of.BwAvailDetails{}, err)
Naveen Sampath04696f72022-06-13 15:19:14 +0530367 }
368}
369
370// AuditGroups audit the groups which includes fetching the existing groups at the
371// voltha and identifying the delta between the ones held here and the
372// ones held at VOLTHA. The delta must be cleaned up to keep both the
373// components in sync
374func (att *AuditTablesTask) AuditGroups() (map[uint32]*ofp.OfpGroupDesc, error) {
Naveen Sampath04696f72022-06-13 15:19:14 +0530375 // Build the map for easy and faster processing
376 rcvdGroups = make(map[uint32]*ofp.OfpGroupDesc)
377
378 if att.stop {
379 return rcvdGroups, tasks.ErrTaskCancelError
380 }
381
382 var vc voltha.VolthaServiceClient
383 if vc = att.device.VolthaClient(); vc == nil {
384 logger.Error(ctx, "Group Audit Failed: Voltha Client Unavailable")
385 return rcvdGroups, nil
386 }
387
388 // ---------------------------------
389 // Perform the audit of groups first
390 // Retrieve the groups from the device
391 g, err := vc.ListLogicalDeviceFlowGroups(att.ctx, &common.ID{Id: att.device.ID})
392 if err != nil {
393 logger.Warnw(ctx, "Audit of groups failed", log.Fields{"Reason": err.Error()})
394 return rcvdGroups, err
395 }
396
397 groupsToAdd = []*of.Group{}
398 groupsToMod = []*of.Group{}
399 for _, group := range g.Items {
400 rcvdGroups[group.Desc.GroupId] = group.Desc
401 }
402 logger.Infow(ctx, "Received Groups", log.Fields{"Groups": rcvdGroups})
403
404 // Verify all groups that are in the controller but not in the device
405 att.device.groups.Range(att.compareGroupEntries)
406
407 if !att.stop {
408 // Add the groups missing at the device
409 logger.Infow(ctx, "Missing Groups", log.Fields{"Groups": groupsToAdd})
410 att.AddMissingGroups(groupsToAdd)
411
412 // Update groups with group member mismatch
413 logger.Infow(ctx, "Modify Groups", log.Fields{"Groups": groupsToMod})
414 att.UpdateMismatchGroups(groupsToMod)
415
416 // Note: Excess groups will be deleted after ensuring the connected
417 // flows are also removed as part fo audit flows
418 } else {
419 err = tasks.ErrTaskCancelError
420 }
421 // The groups remaining in the received groups are the excess groups at
422 // the device
423 return rcvdGroups, err
424}
425
426// compareGroupEntries to compare the group entries
427func (att *AuditTablesTask) compareGroupEntries(key, value interface{}) bool {
Naveen Sampath04696f72022-06-13 15:19:14 +0530428 if att.stop {
429 return false
430 }
431
432 groupID := key.(uint32)
433 dbGroup := value.(*of.Group)
434 logger.Debugw(ctx, "Auditing Group", log.Fields{"Groupid": groupID})
435 if rcvdGrp, ok := rcvdGroups[groupID]; ok {
436 // The group exists in the device too.
437 // Compare the group members and add to modify list if required
438 compareGroupMembers(dbGroup, rcvdGrp)
439 delete(rcvdGroups, groupID)
440 } else {
441 // The group exists at the controller but not at the device
442 // Push the group to the device
443 logger.Debugw(ctx, "Adding Group To Missing Groups", log.Fields{"GroupId": groupID})
444 groupsToAdd = append(groupsToAdd, value.(*of.Group))
445 }
446 return true
447}
448
449func compareGroupMembers(refGroup *of.Group, rcvdGroup *ofp.OfpGroupDesc) {
Naveen Sampath04696f72022-06-13 15:19:14 +0530450 portList := []uint32{}
451 refPortList := []uint32{}
452
vinokuma926cb3e2023-03-29 11:41:06 +0530453 // Collect port list from response Group Mod structure
454 // If PON is configured even for one group, then only PON shall be considered for compared for all groups
Naveen Sampath04696f72022-06-13 15:19:14 +0530455 for _, bucket := range rcvdGroup.Buckets {
456 for _, actionBucket := range bucket.Actions {
457 if actionBucket.Type == ofp.OfpActionType_OFPAT_OUTPUT {
458 action := actionBucket.GetOutput()
459 portList = append(portList, action.Port)
460 }
461 }
462 }
463
464 refPortList = append(refPortList, refGroup.Buckets...)
465
vinokuma926cb3e2023-03-29 11:41:06 +0530466 // Is port list differs, trigger group update
Naveen Sampath04696f72022-06-13 15:19:14 +0530467 if !util.IsSliceSame(refPortList, portList) {
468 groupsToMod = append(groupsToMod, refGroup)
469 }
470}
471
vinokuma926cb3e2023-03-29 11:41:06 +0530472// AddMissingGroups - addmissing groups to Voltha
Naveen Sampath04696f72022-06-13 15:19:14 +0530473func (att *AuditTablesTask) AddMissingGroups(groupList []*of.Group) {
474 att.PushGroups(groupList, of.GroupCommandAdd)
475}
476
vinokuma926cb3e2023-03-29 11:41:06 +0530477// UpdateMismatchGroups - updates mismatched groups to Voltha
Naveen Sampath04696f72022-06-13 15:19:14 +0530478func (att *AuditTablesTask) UpdateMismatchGroups(groupList []*of.Group) {
479 att.PushGroups(groupList, of.GroupCommandMod)
480}
481
482// PushGroups - The groups missing/to be updated in the device are reinstalled att the audit
483func (att *AuditTablesTask) PushGroups(groupList []*of.Group, grpCommand of.GroupCommand) {
484 logger.Debugw(ctx, "Pushing Groups", log.Fields{"Number": len(groupList), "Command": grpCommand})
485
486 var vc voltha.VolthaServiceClient
487 if vc = att.device.VolthaClient(); vc == nil {
488 logger.Error(ctx, "Update Group Table Failed: Voltha Client Unavailable")
489 return
490 }
491 for _, group := range groupList {
492 group.Command = grpCommand
493 groupUpdate := of.CreateGroupTableUpdate(group)
494 if _, err := vc.UpdateLogicalDeviceFlowGroupTable(att.ctx, groupUpdate); err != nil {
495 logger.Errorw(ctx, "Update Group Table Failed", log.Fields{"Reason": err.Error()})
496 }
497 }
498}
499
500// DelExcessGroups - Delete the excess groups held at the VOLTHA
501func (att *AuditTablesTask) DelExcessGroups(groups map[uint32]*ofp.OfpGroupDesc) {
502 logger.Debugw(ctx, "Deleting Excess Groups", log.Fields{"Number of Groups": len(groups)})
503
504 var vc voltha.VolthaServiceClient
505 if vc = att.device.VolthaClient(); vc == nil {
506 logger.Error(ctx, "Delete Excess Groups Failed: Voltha Client Unavailable")
507 return
508 }
509
510 // Let's cycle through the groups to delete the excess groups
511 for _, groupDesc := range groups {
512 logger.Debugw(ctx, "Deleting Group", log.Fields{"GroupId": groupDesc.GroupId})
513 group := &of.Group{}
514 group.Device = att.device.ID
515 group.GroupID = groupDesc.GroupId
516
vinokuma926cb3e2023-03-29 11:41:06 +0530517 // Group Members should be deleted before triggered group delete
Naveen Sampath04696f72022-06-13 15:19:14 +0530518 group.Command = of.GroupCommandMod
519 groupUpdate := of.CreateGroupTableUpdate(group)
520 if _, err := vc.UpdateLogicalDeviceFlowGroupTable(att.ctx, groupUpdate); err != nil {
521 logger.Errorw(ctx, "Update Group Table Failed", log.Fields{"Reason": err.Error()})
522 }
523
524 group.Command = of.GroupCommandDel
525 groupUpdate = of.CreateGroupTableUpdate(group)
526 if _, err := vc.UpdateLogicalDeviceFlowGroupTable(att.ctx, groupUpdate); err != nil {
527 logger.Errorw(ctx, "Update Group Table Failed", log.Fields{"Reason": err.Error()})
528 }
529 }
530}
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530531
532func (att *AuditTablesTask) AuditPorts() error {
vinokuma926cb3e2023-03-29 11:41:06 +0530533 if att.stop {
534 return tasks.ErrTaskCancelError
535 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530536
vinokuma926cb3e2023-03-29 11:41:06 +0530537 var vc voltha.VolthaServiceClient
538 if vc = att.device.VolthaClient(); vc == nil {
539 logger.Error(ctx, "Flow Audit Failed: Voltha Client Unavailable")
540 return nil
541 }
542 ofpps, err := vc.ListLogicalDevicePorts(att.ctx, &common.ID{Id: att.device.ID})
543 if err != nil {
544 return err
545 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530546
vinokuma926cb3e2023-03-29 11:41:06 +0530547 // Compute the difference between the ports received and ports at VGC
548 // First build a map of all the received ports under missing ports. We
549 // will eliminate the ports that are in the device from the missing ports
550 // so that the elements remaining are missing ports. The ones that are
551 // not in missing ports are added to excess ports which should be deleted
552 // from the VGC.
553 missingPorts := make(map[uint32]*ofp.OfpPort)
554 for _, ofpp := range ofpps.Items {
555 missingPorts[ofpp.OfpPort.PortNo] = ofpp.OfpPort
556 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530557
vinokuma926cb3e2023-03-29 11:41:06 +0530558 var excessPorts []uint32
559 processPortState := func(id uint32, vgcPort *DevicePort) {
560 logger.Debugw(ctx, "Process Port State Ind", log.Fields{"Port No": vgcPort.ID, "Port Name": vgcPort.Name})
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530561
vinokuma926cb3e2023-03-29 11:41:06 +0530562 if ofpPort, ok := missingPorts[id]; ok {
563 if ((vgcPort.State == PortStateDown) && (ofpPort.State == uint32(ofp.OfpPortState_OFPPS_LIVE))) || ((vgcPort.State == PortStateUp) && (ofpPort.State != uint32(ofp.OfpPortState_OFPPS_LIVE))) {
564 // This port exists in the received list and the map at
565 // VGC. This is common so delete it
566 logger.Infow(ctx, "Port State Mismatch", log.Fields{"Port": vgcPort.ID, "OfpPort": ofpPort.PortNo, "ReceivedState": ofpPort.State, "CurrentState": vgcPort.State})
567 att.device.ProcessPortState(ctx, ofpPort.PortNo, ofpPort.State)
568 }
569 delete(missingPorts, id)
570 } else {
571 // This port is missing from the received list. This is an
572 // excess port at VGC. This must be added to excess ports
573 excessPorts = append(excessPorts, id)
574 }
575 logger.Debugw(ctx, "Processed Port State Ind", log.Fields{"Port No": vgcPort.ID, "Port Name": vgcPort.Name})
576 }
577 // 1st process the NNI port before all other ports so that the device state can be updated.
578 if vgcPort, ok := att.device.PortsByID[NNIPortID]; ok {
579 logger.Info(ctx, "Processing NNI port state")
580 processPortState(NNIPortID, vgcPort)
581 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530582
vinokuma926cb3e2023-03-29 11:41:06 +0530583 for id, vgcPort := range att.device.PortsByID {
584 if id == NNIPortID {
585 // NNI port already processed
586 continue
587 }
588 if att.stop {
589 break
590 }
591 processPortState(id, vgcPort)
592 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530593
594 if att.stop {
vinokuma926cb3e2023-03-29 11:41:06 +0530595 logger.Errorw(ctx, "Audit Device Task Canceled", log.Fields{"Context": att.ctx, "Task": att.taskID})
596 return tasks.ErrTaskCancelError
597 }
598 att.AddMissingPorts(ctx, missingPorts)
599 att.DelExcessPorts(ctx, excessPorts)
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530600 return nil
601}
602
603// AddMissingPorts to add the missing ports
604func (att *AuditTablesTask) AddMissingPorts(cntx context.Context, mps map[uint32]*ofp.OfpPort) {
vinokuma926cb3e2023-03-29 11:41:06 +0530605 logger.Debugw(ctx, "Device Audit - Add Missing Ports", log.Fields{"NumPorts": len(mps)})
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530606
vinokuma926cb3e2023-03-29 11:41:06 +0530607 addMissingPort := func(mp *ofp.OfpPort) {
608 logger.Debugw(ctx, "Process Port Add Ind", log.Fields{"Port No": mp.PortNo, "Port Name": mp.Name})
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530609
vinokuma926cb3e2023-03-29 11:41:06 +0530610 // Error is ignored as it only drops duplicate ports
611 logger.Infow(ctx, "Calling AddPort", log.Fields{"No": mp.PortNo, "Name": mp.Name})
612 if err := att.device.AddPort(cntx, mp); err != nil {
613 logger.Warnw(ctx, "AddPort Failed", log.Fields{"No": mp.PortNo, "Name": mp.Name, "Reason": err})
614 }
615 if mp.State == uint32(ofp.OfpPortState_OFPPS_LIVE) {
616 att.device.ProcessPortState(cntx, mp.PortNo, mp.State)
617 }
618 logger.Debugw(ctx, "Processed Port Add Ind", log.Fields{"Port No": mp.PortNo, "Port Name": mp.Name})
619 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530620
vinokuma926cb3e2023-03-29 11:41:06 +0530621 // 1st process the NNI port before all other ports so that the flow provisioning for UNIs can be enabled
622 if mp, ok := mps[NNIPortID]; ok {
623 logger.Info(ctx, "Adding Missing NNI port")
624 addMissingPort(mp)
625 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530626
vinokuma926cb3e2023-03-29 11:41:06 +0530627 for portNo, mp := range mps {
628 if portNo != NNIPortID {
629 addMissingPort(mp)
630 }
631 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530632}
633
634// DelExcessPorts to delete the excess ports
635func (att *AuditTablesTask) DelExcessPorts(cntx context.Context, eps []uint32) {
vinokuma926cb3e2023-03-29 11:41:06 +0530636 logger.Debugw(ctx, "Device Audit - Delete Excess Ports", log.Fields{"NumPorts": len(eps)})
637 for _, id := range eps {
638 // Now delete the port from the device @ VGC
639 logger.Infow(ctx, "Device Audit - Deleting Port", log.Fields{"PortId": id})
640 if err := att.device.DelPort(cntx, id); err != nil {
641 logger.Warnw(ctx, "DelPort Failed", log.Fields{"PortId": id, "Reason": err})
642 }
643 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530644}