blob: d5ce8589f6999194e0037e16ed49ef05d19f3849 [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 {
Akash Sonie863fe42023-11-30 14:35:01 +053082 logger.Debugw(ctx, "Audit Table Task Triggered", log.Fields{"Context": ctx, "taskId": taskID, "Device": att.device.ID})
Naveen Sampath04696f72022-06-13 15:19:14 +053083 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
Akash Soni6168f312023-05-18 20:57:33 +0530114 logger.Debugw(ctx, "Excess Groups", log.Fields{"Groups": rcvdGroups})
Naveen Sampath04696f72022-06-13 15:19:14 +0530115 att.DelExcessGroups(rcvdGroups)
Akash Sonie863fe42023-11-30 14:35:01 +0530116 logger.Debugw(ctx, "Audit Table Task Completed", log.Fields{"Context": ctx, "taskId": taskID, "Device": att.device.ID})
Naveen Sampath04696f72022-06-13 15:19:14 +0530117 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)
Naveen Sampath04696f72022-06-13 15:19:14 +0530270 } else {
271 // The flow exists at the controller but not at the device
272 // Push the flow to the device
273 logger.Debugw(ctx, "Adding Flow To Missing Flows", log.Fields{"Cookie": flow.Cookie})
274 flowsToAdd.SubFlows[flow.Cookie] = flow
275 }
276 }
277 att.device.flowLock.Unlock()
278
279 if !att.stop {
280 // The flows remaining in the received flows are the excess flows at
281 // the device. Delete those flows
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530282 att.DelExcessFlows(cntx, rcvdFlows)
Naveen Sampath04696f72022-06-13 15:19:14 +0530283 // Add the flows missing at the device
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530284 att.AddMissingFlows(cntx, flowsToAdd)
Naveen Sampath04696f72022-06-13 15:19:14 +0530285 } else {
286 err = tasks.ErrTaskCancelError
287 }
288 return err
289}
290
291// AddMissingFlows : The flows missing from the device are reinstalled att the audit
292// The flows are added into a VoltFlow structure.
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530293func (att *AuditTablesTask) AddMissingFlows(cntx context.Context, mflow *of.VoltFlow) {
Naveen Sampath04696f72022-06-13 15:19:14 +0530294 logger.Debugw(ctx, "Add Missing Flows", log.Fields{"Number": len(mflow.SubFlows)})
295 mflow.Command = of.CommandAdd
296 ofFlows := of.ProcessVoltFlow(att.device.ID, mflow.Command, mflow.SubFlows)
297 var vc voltha.VolthaServiceClient
298 var bwConsumedInfo of.BwAvailDetails
299 if vc = att.device.VolthaClient(); vc == nil {
300 logger.Error(ctx, "Update Flow Table Failed: Voltha Client Unavailable")
301 return
302 }
303 for _, flow := range ofFlows {
304 var dbFlow *of.VoltSubFlow
305 var present bool
306 if flow.FlowMod != nil {
307 if dbFlow, present = att.device.GetFlow(flow.FlowMod.Cookie); !present {
Tinoj Joseph1d108322022-07-13 10:07:39 +0530308 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 +0530309 continue
310 }
311 }
312 var err error
313 if _, err = vc.UpdateLogicalDeviceFlowTable(att.ctx, flow); err != nil {
314 logger.Errorw(ctx, "Update Flow Table Failed", log.Fields{"Reason": err.Error()})
315 }
Sridhar Ravindra3ec14232024-01-01 19:11:48 +0530316 att.device.triggerFlowResultNotification(cntx, flow.FlowMod.Cookie, dbFlow, of.CommandAdd, bwConsumedInfo, err, true)
Naveen Sampath04696f72022-06-13 15:19:14 +0530317 }
318}
319
320// DelExcessFlows delete the excess flows held at the VOLTHA
Tinoj Joseph07cc5372022-07-18 22:53:51 +0530321func (att *AuditTablesTask) DelExcessFlows(cntx context.Context, flows map[uint64]*ofp.OfpFlowStats) {
Naveen Sampath04696f72022-06-13 15:19:14 +0530322 logger.Debugw(ctx, "Deleting Excess Flows", log.Fields{"Number of Flows": len(flows)})
323
324 var vc voltha.VolthaServiceClient
325 if vc = att.device.VolthaClient(); vc == nil {
326 logger.Error(ctx, "Delete Excess Flows Failed: Voltha Client Unavailable")
327 return
328 }
329
330 // Let's cycle through the flows to delete the excess flows
331 for _, flow := range flows {
Naveen Sampath04696f72022-06-13 15:19:14 +0530332 if _, present := att.device.GetFlow(flow.Cookie); present {
Tinoj Joseph1d108322022-07-13 10:07:39 +0530333 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 +0530334 continue
335 }
336
Sridhar Ravindra3ec14232024-01-01 19:11:48 +0530337 if flag := GetController().IsFlowDelThresholdReached(cntx, strconv.FormatUint(flow.Cookie, 10), att.device.ID); flag {
338 logger.Warnw(ctx, "Flow delete threshold reached, skipping flow delete", log.Fields{"Device": att.device.ID, "Cookie": flow.Cookie})
339 continue
340 }
341
Naveen Sampath04696f72022-06-13 15:19:14 +0530342 logger.Debugw(ctx, "Deleting Flow", log.Fields{"Cookie": flow.Cookie})
343 // Create the flowMod structure and fill it out
344 flowMod := &ofp.OfpFlowMod{}
345 flowMod.Cookie = flow.Cookie
346 flowMod.TableId = flow.TableId
347 flowMod.Command = ofp.OfpFlowModCommand_OFPFC_DELETE_STRICT
348 flowMod.IdleTimeout = flow.IdleTimeout
349 flowMod.HardTimeout = flow.HardTimeout
350 flowMod.Priority = flow.Priority
351 flowMod.BufferId = of.DefaultBufferID
352 flowMod.OutPort = of.DefaultOutPort
353 flowMod.OutGroup = of.DefaultOutGroup
354 flowMod.Flags = flow.Flags
355 flowMod.Match = flow.Match
356 flowMod.Instructions = flow.Instructions
357
358 // Create FlowTableUpdate
359 flowUpdate := &ofp.FlowTableUpdate{
360 Id: att.device.ID,
361 FlowMod: flowMod,
362 }
363
364 var err error
365 if _, err = vc.UpdateLogicalDeviceFlowTable(att.ctx, flowUpdate); err != nil {
366 logger.Errorw(ctx, "Flow Audit Delete Failed", log.Fields{"Reason": err.Error()})
367 }
Sridhar Ravindra3ec14232024-01-01 19:11:48 +0530368 att.device.triggerFlowResultNotification(cntx, flow.Cookie, nil, of.CommandDel, of.BwAvailDetails{}, err, true)
Naveen Sampath04696f72022-06-13 15:19:14 +0530369 }
370}
371
372// AuditGroups audit the groups which includes fetching the existing groups at the
373// voltha and identifying the delta between the ones held here and the
374// ones held at VOLTHA. The delta must be cleaned up to keep both the
375// components in sync
376func (att *AuditTablesTask) AuditGroups() (map[uint32]*ofp.OfpGroupDesc, error) {
Naveen Sampath04696f72022-06-13 15:19:14 +0530377 // Build the map for easy and faster processing
378 rcvdGroups = make(map[uint32]*ofp.OfpGroupDesc)
379
380 if att.stop {
381 return rcvdGroups, tasks.ErrTaskCancelError
382 }
383
384 var vc voltha.VolthaServiceClient
385 if vc = att.device.VolthaClient(); vc == nil {
386 logger.Error(ctx, "Group Audit Failed: Voltha Client Unavailable")
387 return rcvdGroups, nil
388 }
389
390 // ---------------------------------
391 // Perform the audit of groups first
392 // Retrieve the groups from the device
393 g, err := vc.ListLogicalDeviceFlowGroups(att.ctx, &common.ID{Id: att.device.ID})
394 if err != nil {
395 logger.Warnw(ctx, "Audit of groups failed", log.Fields{"Reason": err.Error()})
396 return rcvdGroups, err
397 }
398
399 groupsToAdd = []*of.Group{}
400 groupsToMod = []*of.Group{}
401 for _, group := range g.Items {
402 rcvdGroups[group.Desc.GroupId] = group.Desc
403 }
Akash Sonie863fe42023-11-30 14:35:01 +0530404 logger.Debugw(ctx, "Received Groups", log.Fields{"Groups": rcvdGroups})
Naveen Sampath04696f72022-06-13 15:19:14 +0530405
406 // Verify all groups that are in the controller but not in the device
407 att.device.groups.Range(att.compareGroupEntries)
408
409 if !att.stop {
410 // Add the groups missing at the device
Akash Sonie863fe42023-11-30 14:35:01 +0530411 logger.Debugw(ctx, "Missing Groups", log.Fields{"Groups": groupsToAdd})
Naveen Sampath04696f72022-06-13 15:19:14 +0530412 att.AddMissingGroups(groupsToAdd)
413
414 // Update groups with group member mismatch
Akash Sonie863fe42023-11-30 14:35:01 +0530415 logger.Debugw(ctx, "Modify Groups", log.Fields{"Groups": groupsToMod})
Naveen Sampath04696f72022-06-13 15:19:14 +0530416 att.UpdateMismatchGroups(groupsToMod)
417
418 // Note: Excess groups will be deleted after ensuring the connected
419 // flows are also removed as part fo audit flows
420 } else {
421 err = tasks.ErrTaskCancelError
422 }
423 // The groups remaining in the received groups are the excess groups at
424 // the device
425 return rcvdGroups, err
426}
427
428// compareGroupEntries to compare the group entries
429func (att *AuditTablesTask) compareGroupEntries(key, value interface{}) bool {
Naveen Sampath04696f72022-06-13 15:19:14 +0530430 if att.stop {
431 return false
432 }
433
434 groupID := key.(uint32)
435 dbGroup := value.(*of.Group)
436 logger.Debugw(ctx, "Auditing Group", log.Fields{"Groupid": groupID})
437 if rcvdGrp, ok := rcvdGroups[groupID]; ok {
438 // The group exists in the device too.
439 // Compare the group members and add to modify list if required
440 compareGroupMembers(dbGroup, rcvdGrp)
441 delete(rcvdGroups, groupID)
442 } else {
443 // The group exists at the controller but not at the device
444 // Push the group to the device
445 logger.Debugw(ctx, "Adding Group To Missing Groups", log.Fields{"GroupId": groupID})
446 groupsToAdd = append(groupsToAdd, value.(*of.Group))
447 }
448 return true
449}
450
451func compareGroupMembers(refGroup *of.Group, rcvdGroup *ofp.OfpGroupDesc) {
Naveen Sampath04696f72022-06-13 15:19:14 +0530452 portList := []uint32{}
453 refPortList := []uint32{}
454
vinokuma926cb3e2023-03-29 11:41:06 +0530455 // Collect port list from response Group Mod structure
456 // 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 +0530457 for _, bucket := range rcvdGroup.Buckets {
458 for _, actionBucket := range bucket.Actions {
459 if actionBucket.Type == ofp.OfpActionType_OFPAT_OUTPUT {
460 action := actionBucket.GetOutput()
461 portList = append(portList, action.Port)
462 }
463 }
464 }
465
466 refPortList = append(refPortList, refGroup.Buckets...)
467
vinokuma926cb3e2023-03-29 11:41:06 +0530468 // Is port list differs, trigger group update
Naveen Sampath04696f72022-06-13 15:19:14 +0530469 if !util.IsSliceSame(refPortList, portList) {
470 groupsToMod = append(groupsToMod, refGroup)
471 }
472}
473
vinokuma926cb3e2023-03-29 11:41:06 +0530474// AddMissingGroups - addmissing groups to Voltha
Naveen Sampath04696f72022-06-13 15:19:14 +0530475func (att *AuditTablesTask) AddMissingGroups(groupList []*of.Group) {
476 att.PushGroups(groupList, of.GroupCommandAdd)
477}
478
vinokuma926cb3e2023-03-29 11:41:06 +0530479// UpdateMismatchGroups - updates mismatched groups to Voltha
Naveen Sampath04696f72022-06-13 15:19:14 +0530480func (att *AuditTablesTask) UpdateMismatchGroups(groupList []*of.Group) {
481 att.PushGroups(groupList, of.GroupCommandMod)
482}
483
484// PushGroups - The groups missing/to be updated in the device are reinstalled att the audit
485func (att *AuditTablesTask) PushGroups(groupList []*of.Group, grpCommand of.GroupCommand) {
486 logger.Debugw(ctx, "Pushing Groups", log.Fields{"Number": len(groupList), "Command": grpCommand})
487
488 var vc voltha.VolthaServiceClient
489 if vc = att.device.VolthaClient(); vc == nil {
490 logger.Error(ctx, "Update Group Table Failed: Voltha Client Unavailable")
491 return
492 }
493 for _, group := range groupList {
494 group.Command = grpCommand
495 groupUpdate := of.CreateGroupTableUpdate(group)
496 if _, err := vc.UpdateLogicalDeviceFlowGroupTable(att.ctx, groupUpdate); err != nil {
497 logger.Errorw(ctx, "Update Group Table Failed", log.Fields{"Reason": err.Error()})
498 }
499 }
500}
501
502// DelExcessGroups - Delete the excess groups held at the VOLTHA
503func (att *AuditTablesTask) DelExcessGroups(groups map[uint32]*ofp.OfpGroupDesc) {
504 logger.Debugw(ctx, "Deleting Excess Groups", log.Fields{"Number of Groups": len(groups)})
505
506 var vc voltha.VolthaServiceClient
507 if vc = att.device.VolthaClient(); vc == nil {
508 logger.Error(ctx, "Delete Excess Groups Failed: Voltha Client Unavailable")
509 return
510 }
511
512 // Let's cycle through the groups to delete the excess groups
513 for _, groupDesc := range groups {
514 logger.Debugw(ctx, "Deleting Group", log.Fields{"GroupId": groupDesc.GroupId})
515 group := &of.Group{}
516 group.Device = att.device.ID
517 group.GroupID = groupDesc.GroupId
518
vinokuma926cb3e2023-03-29 11:41:06 +0530519 // Group Members should be deleted before triggered group delete
Naveen Sampath04696f72022-06-13 15:19:14 +0530520 group.Command = of.GroupCommandMod
521 groupUpdate := of.CreateGroupTableUpdate(group)
522 if _, err := vc.UpdateLogicalDeviceFlowGroupTable(att.ctx, groupUpdate); err != nil {
523 logger.Errorw(ctx, "Update Group Table Failed", log.Fields{"Reason": err.Error()})
524 }
525
526 group.Command = of.GroupCommandDel
527 groupUpdate = of.CreateGroupTableUpdate(group)
528 if _, err := vc.UpdateLogicalDeviceFlowGroupTable(att.ctx, groupUpdate); err != nil {
529 logger.Errorw(ctx, "Update Group Table Failed", log.Fields{"Reason": err.Error()})
530 }
531 }
532}
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530533
534func (att *AuditTablesTask) AuditPorts() error {
vinokuma926cb3e2023-03-29 11:41:06 +0530535 if att.stop {
536 return tasks.ErrTaskCancelError
537 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530538
vinokuma926cb3e2023-03-29 11:41:06 +0530539 var vc voltha.VolthaServiceClient
540 if vc = att.device.VolthaClient(); vc == nil {
541 logger.Error(ctx, "Flow Audit Failed: Voltha Client Unavailable")
542 return nil
543 }
544 ofpps, err := vc.ListLogicalDevicePorts(att.ctx, &common.ID{Id: att.device.ID})
545 if err != nil {
546 return err
547 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530548
vinokuma926cb3e2023-03-29 11:41:06 +0530549 // Compute the difference between the ports received and ports at VGC
550 // First build a map of all the received ports under missing ports. We
551 // will eliminate the ports that are in the device from the missing ports
552 // so that the elements remaining are missing ports. The ones that are
553 // not in missing ports are added to excess ports which should be deleted
554 // from the VGC.
555 missingPorts := make(map[uint32]*ofp.OfpPort)
556 for _, ofpp := range ofpps.Items {
557 missingPorts[ofpp.OfpPort.PortNo] = ofpp.OfpPort
558 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530559
Sridhar Ravindra0bc5dc52023-12-13 19:03:30 +0530560 excessPorts := make(map[uint32]*DevicePort)
vinokuma926cb3e2023-03-29 11:41:06 +0530561 processPortState := func(id uint32, vgcPort *DevicePort) {
562 logger.Debugw(ctx, "Process Port State Ind", log.Fields{"Port No": vgcPort.ID, "Port Name": vgcPort.Name})
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530563
vinokuma926cb3e2023-03-29 11:41:06 +0530564 if ofpPort, ok := missingPorts[id]; ok {
565 if ((vgcPort.State == PortStateDown) && (ofpPort.State == uint32(ofp.OfpPortState_OFPPS_LIVE))) || ((vgcPort.State == PortStateUp) && (ofpPort.State != uint32(ofp.OfpPortState_OFPPS_LIVE))) {
566 // This port exists in the received list and the map at
567 // VGC. This is common so delete it
568 logger.Infow(ctx, "Port State Mismatch", log.Fields{"Port": vgcPort.ID, "OfpPort": ofpPort.PortNo, "ReceivedState": ofpPort.State, "CurrentState": vgcPort.State})
569 att.device.ProcessPortState(ctx, ofpPort.PortNo, ofpPort.State)
570 }
571 delete(missingPorts, id)
572 } else {
573 // This port is missing from the received list. This is an
574 // excess port at VGC. This must be added to excess ports
Sridhar Ravindra0bc5dc52023-12-13 19:03:30 +0530575 excessPorts[id] = vgcPort
vinokuma926cb3e2023-03-29 11:41:06 +0530576 }
577 logger.Debugw(ctx, "Processed Port State Ind", log.Fields{"Port No": vgcPort.ID, "Port Name": vgcPort.Name})
578 }
579 // 1st process the NNI port before all other ports so that the device state can be updated.
580 if vgcPort, ok := att.device.PortsByID[NNIPortID]; ok {
Akash Soni6168f312023-05-18 20:57:33 +0530581 logger.Debugw(ctx, "Processing NNI port state", log.Fields{"Port ID": vgcPort.ID, "Port Name": vgcPort.Name})
vinokuma926cb3e2023-03-29 11:41:06 +0530582 processPortState(NNIPortID, vgcPort)
583 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530584
vinokuma926cb3e2023-03-29 11:41:06 +0530585 for id, vgcPort := range att.device.PortsByID {
586 if id == NNIPortID {
587 // NNI port already processed
588 continue
589 }
590 if att.stop {
591 break
592 }
593 processPortState(id, vgcPort)
594 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530595
596 if att.stop {
Akash Soni6168f312023-05-18 20:57:33 +0530597 logger.Warnw(ctx, "Audit Device Task Canceled", log.Fields{"Context": att.ctx, "Task": att.taskID})
vinokuma926cb3e2023-03-29 11:41:06 +0530598 return tasks.ErrTaskCancelError
599 }
600 att.AddMissingPorts(ctx, missingPorts)
601 att.DelExcessPorts(ctx, excessPorts)
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530602 return nil
603}
604
605// AddMissingPorts to add the missing ports
606func (att *AuditTablesTask) AddMissingPorts(cntx context.Context, mps map[uint32]*ofp.OfpPort) {
Sridhar Ravindra3ec14232024-01-01 19:11:48 +0530607 logger.Debugw(ctx, "Device Audit - Add Missing Ports", log.Fields{"NumPorts": len(mps)})
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530608
vinokuma926cb3e2023-03-29 11:41:06 +0530609 addMissingPort := func(mp *ofp.OfpPort) {
610 logger.Debugw(ctx, "Process Port Add Ind", log.Fields{"Port No": mp.PortNo, "Port Name": mp.Name})
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530611
vinokuma926cb3e2023-03-29 11:41:06 +0530612 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 {
Akash Soni6168f312023-05-18 20:57:33 +0530623 logger.Debugw(ctx, "Adding Missing NNI port", log.Fields{"PortNo": mp.PortNo})
vinokuma926cb3e2023-03-29 11:41:06 +0530624 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
Sridhar Ravindra0bc5dc52023-12-13 19:03:30 +0530635func (att *AuditTablesTask) DelExcessPorts(cntx context.Context, eps map[uint32]*DevicePort) {
vinokuma926cb3e2023-03-29 11:41:06 +0530636 logger.Debugw(ctx, "Device Audit - Delete Excess Ports", log.Fields{"NumPorts": len(eps)})
Sridhar Ravindra0bc5dc52023-12-13 19:03:30 +0530637 for portNo, ep := range eps {
vinokuma926cb3e2023-03-29 11:41:06 +0530638 // Now delete the port from the device @ VGC
Sridhar Ravindra0bc5dc52023-12-13 19:03:30 +0530639 logger.Debugw(ctx, "Device Audit - Deleting Port", log.Fields{"PortId": portNo})
640 if err := att.device.DelPort(cntx, ep.ID, ep.Name); err != nil {
641 logger.Warnw(ctx, "DelPort Failed", log.Fields{"PortId": portNo, "Reason": err})
vinokuma926cb3e2023-03-29 11:41:06 +0530642 }
643 }
Tinoj Josephaf37ce82022-12-28 11:59:43 +0530644}