[intfsorch]: Retry loopback action update failures by Xichen96 · Pull Request #4766 · sonic-net/sonic-swss

Xichen96 · 2026-07-19T16:56:46Z

What I did

Fixed IntfsOrch handling of loopback_action updates for an existing router interface.

Root cause

IntfsOrch::doTask() called setIntfLoopbackAction() but ignored its return value. The helper already returns false when SAI handling reports task_need_retry, but the caller continued to the final m_toSync.erase(). A transient SAI failure therefore discarded the desired action instead of retaining it for another drain.

An unsupported value such as loopback_action=invalid is different: it is permanent invalid input and must not retain the entire interface SET forever.

Fix

The new flow is:

validate loopback_action
    unsupported value
        -> log and ignore only that field
        -> continue processing other fields

    supported value
        -> set SAI_ROUTER_INTERFACE_ATTR_LOOPBACK_PACKET_ACTION
        -> retryable SAI failure: keep the original task queued
        -> success or terminal handling: consume the task normally

This preserves SWSS retry behavior without letting one invalid field block unrelated valid updates in the same APP_DB row.

Why I did it

A transient SAI resource condition must not silently lose desired state. Conversely, this update must remain usable:

SET Ethernet0
    loopback_action = invalid
    nat_zone        = 7

The invalid action is ignored, while the valid NAT-zone update still converges.

This issue is independent of the interface-removal and VRF-rehome state machines in PRs #4746 and #4764. The branch has been restacked on current master, preserving merged PR #4758 and its regression coverage.

How I verified it

Focused mock coverage in tests/mock_tests/intfsorch_ut.cpp verifies:

IntfsOrchRetriesLoopbackActionSetFailure
- injects one SAI_STATUS_INSUFFICIENT_RESOURCES result for the loopback-action attribute;
- verifies the task remains in m_toSync;
- retries the drain;
- verifies the task is consumed and SAI_PACKET_ACTION_DROP is applied.
IntfsOrchIgnoresInvalidLoopbackActionField
- submits an invalid action with nat_zone=7;
- verifies no loopback action is sent to SAI;
- verifies the task is consumed;
- verifies the NAT-zone update is applied.
Test executor casts are checked before use.
Failure injection is scoped to SAI_ROUTER_INTERFACE_ATTR_LOOPBACK_PACKET_ACTION, so another RIF attribute update cannot consume the injected failure.

Current exact-head master PR build

Head: a6d671f713779bb42824c99425af6d1a7f616cc6
Azure PR build: 1171668
The fresh exact-head build is in progress.
DCO and EasyCLA are green; all Copilot review threads are resolved.
No local build was used; validation is PR-build only.

Prior pre-restack evidence

Head 8e4b4c2df00601c5585a6a986f80d95f8ee4d418
Azure PR build 1171072
All architecture, ASAN, Docker, Trixie, Test vstest, and TestAsan vstest lanes passed.

That build is useful implementation evidence, but the current restacked head requires its own completed result.

202605 PR-build validation

Validation-only PR: #4747
The complete current-202605 stack contains merged PR [intfsorch]Fix race condition between VRF bind and ip address removal #4758 followed by [intfsorch]: Fence new RIF dependencies during interface removal #4746, this PR, [neighorch]: Track remote next hops on inband RIF #4769, [neighorch]: Avoid inserting missing bulk neighbors #4772, [intfsorch]: Retry explicit router interface VRF rehome #4764, and [neighorch]: Retry until inband port is available #4770.
The target-branch resolution preserves both this retry behavior and PR [intfsorch]: Retry explicit router interface VRF rehome #4764's loopback-action state tracking.
Exact validation head: d4b0502ecdac76d56fdf063a633045c0fb0de977
Azure PR build: 1171672 — in progress.
The Tested for 202605 branch label must remain absent until that exact result is complete.

Details if related

Changed files:
- orchagent/intfsorch.cpp
- tests/mock_tests/intfsorch_ut.cpp
Microsoft ADO: 38514061
Merge batch 1. Recheck PR [intfsorch]: Retry explicit router interface VRF rehome #4764 after this PR merges because both touch the same IntfsOrch paths.

mssonicbld · 2026-07-19T16:56:53Z

/azp run

azure-pipelines · 2026-07-19T16:56:54Z

Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run.

azure-pipelines · 2026-07-19T16:57:03Z

Azure Pipelines: Successfully started running 1 pipeline(s).

Xichen96 · 2026-07-19T16:58:33Z

/azp run

azure-pipelines · 2026-07-19T16:58:41Z

Azure Pipelines: Successfully started running 1 pipeline(s).

Copilot

Pull request overview

This PR improves IntfsOrch’s handling of loopback_action updates from APP_INTF_TABLE: it preserves SET tasks in the consumer queue when a retryable SAI failure occurs while updating the RIF loopback packet action, and it treats invalid loopback_action values as a logged no-op so other fields in the same SET can still be applied.

Changes:

Validate loopback_action early in IntfsOrch::doTask() and ignore invalid values (via getSaiLoopbackAction() warning + skipping the field).
If setting the RIF loopback action fails in a retryable way, keep the SET in m_toSync so it will be retried on the next drain.
Add mock unit tests covering (1) retry behavior on SAI set failure and (2) ignoring invalid loopback_action while still applying other fields (e.g., MTU).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
`orchagent/intfsorch.cpp`	Adds `loopback_action` validation and retry behavior so requested loopback action updates aren’t lost on retryable SAI errors.
`tests/mock_tests/intfsorch_ut.cpp`	Adds unit tests to verify retry-on-failure and ignore-invalid-field behavior for `loopback_action`.

mssonicbld · 2026-07-19T17:13:04Z

/azp run

azure-pipelines · 2026-07-19T17:13:14Z

Azure Pipelines: Successfully started running 1 pipeline(s).

Xichen96 · 2026-07-19T17:13:42Z

/azp run

azure-pipelines · 2026-07-19T17:13:51Z

Azure Pipelines: Successfully started running 1 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

mssonicbld · 2026-07-19T18:10:27Z

/azp run

azure-pipelines · 2026-07-19T18:10:37Z

Azure Pipelines: Successfully started running 1 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Xichen96 · 2026-07-21T16:56:35Z

/azpw run

mssonicbld · 2026-07-21T16:56:37Z

⚠️ Notice: /azpw run only runs failed jobs now. If you want to trigger a whole pipline run, please rebase your branch or close and reopen the PR.
💡 Tip: You can also use /azpw retry to retry failed jobs directly.

Retrying failed(or canceled) jobs...

mssonicbld · 2026-07-21T16:56:41Z

Retrying failed(or canceled) stages in build 1169337:

✅Stage TestAsan:

Job vstest: retried.

✅Stage Test:

Job vstest: retried.
Job vstest: retried.

mssonicbld · 2026-07-21T17:15:59Z

/azp run

azure-pipelines · 2026-07-21T17:16:00Z

Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run.

azure-pipelines · 2026-07-21T17:16:10Z

Azure Pipelines: Successfully started running 1 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (2)

tests/mock_tests/intfsorch_ut.cpp:523

dynamic_cast<Consumer*> may return nullptr; this test dereferences consumer immediately, which would crash the test if the executor lookup ever changes. Add an assertion (or ASSERT_NE) before using consumer.

        auto consumer = dynamic_cast<Consumer *>(gIntfsOrch->getExecutor(APP_INTF_TABLE_NAME));
        ASSERT_NE(consumer, nullptr);

tests/mock_tests/intfsorch_ut.cpp:549

dynamic_cast<Consumer*> may return nullptr; this test dereferences consumer immediately, which would crash the test if the executor lookup ever changes. Add an assertion (or ASSERT_NE) before using consumer.

        };
        auto consumer = dynamic_cast<Consumer *>(gIntfsOrch->getExecutor(APP_INTF_TABLE_NAME));

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: b6b568a1-5d2a-4309-b1ac-ef21ca155079 Signed-off-by: Xichen96 <lukelin0907@gmail.com>

mssonicbld · 2026-07-22T07:26:36Z

/azp run

azure-pipelines · 2026-07-22T07:26:47Z

Azure Pipelines: Successfully started running 1 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

tests/mock_tests/intfsorch_ut.cpp:57

The new _ut_set_router_interface_attribute() stub returns SAI_STATUS_SUCCESS for every non-loopback attribute, which can unintentionally mask failures and alter behavior for other tests in this suite (e.g., MAC/MTU/MPLS/NAT-zone attribute sets). Consider delegating to the original SAI set_router_interface_attribute implementation for attributes you are not explicitly testing, and only intercepting/failing the loopback-action attribute.

        return SAI_STATUS_SUCCESS;
    }

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Delegate non-loopback router-interface attribute updates to the original SAI implementation so the retry hook does not mask other unit-test behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: b6b568a1-5d2a-4309-b1ac-ef21ca155079 Signed-off-by: Xichen96 <lukelin0907@gmail.com>

mssonicbld · 2026-07-22T08:08:28Z

/azp run

azure-pipelines · 2026-07-22T08:08:38Z

Azure Pipelines: Successfully started running 1 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

mssonicbld · 2026-07-22T12:20:45Z

This PR has backport request label(s) for branch(es): 202605, but is missing required test information. Please make sure you tick the tested branch(es) in the Tested branch section and provide test evidence (e.g., 202605: <test result>) in the Test result section as well in your PR description.

_{---Powered by SONiC BuildBot}

mssonicbld · 2026-07-22T15:33:45Z

/azp run

azure-pipelines · 2026-07-22T15:33:45Z

Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run.

azure-pipelines · 2026-07-22T15:33:56Z

Azure Pipelines: Successfully started running 1 pipeline(s).

Xichen96 mentioned this pull request Jul 19, 2026

[intfsorch]: Retry explicit router interface VRF rehome #4764

Draft

Xichen96 requested a review from Copilot July 19, 2026 16:58

Copilot started reviewing on behalf of Xichen96 July 19, 2026 16:59 View session

Copilot AI reviewed Jul 19, 2026

View reviewed changes

Comment thread tests/mock_tests/intfsorch_ut.cpp

Comment thread tests/mock_tests/intfsorch_ut.cpp

Xichen96 requested a review from Copilot July 19, 2026 17:13

Copilot started reviewing on behalf of Xichen96 July 19, 2026 17:14 View session

Copilot AI reviewed Jul 19, 2026

View reviewed changes

Xichen96 mentioned this pull request Jul 19, 2026

[202605][intfsorch]: Validate VRF race and loopback fixes #4767

Draft

Xichen96 requested a review from Copilot July 19, 2026 18:10

Copilot started reviewing on behalf of Xichen96 July 19, 2026 18:56 View session

Copilot AI reviewed Jul 19, 2026

View reviewed changes

Xichen96 closed this Jul 21, 2026

Xichen96 reopened this Jul 21, 2026

Copilot AI reviewed Jul 22, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings July 22, 2026 07:13

Copilot started reviewing on behalf of Xichen96 July 22, 2026 07:13 View session

Copilot AI reviewed Jul 22, 2026

View reviewed changes

Comment thread tests/mock_tests/intfsorch_ut.cpp Outdated

[tests]: Scope loopback action failure injection

a6d671f

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: b6b568a1-5d2a-4309-b1ac-ef21ca155079 Signed-off-by: Xichen96 <lukelin0907@gmail.com>

Copilot AI review requested due to automatic review settings July 22, 2026 07:26

Copilot started reviewing on behalf of Xichen96 July 22, 2026 07:26 View session

Copilot AI reviewed Jul 22, 2026

View reviewed changes

This was referenced Jul 22, 2026

[intfsorch]: Fence new RIF dependencies during interface removal #4746

Draft

[neighorch]: Track remote next hops on inband RIF #4769

Open

[202605][intfsorch]: Fence new RIF dependencies during interface removal #4747

Draft

Xichen96 requested a review from Copilot July 22, 2026 07:39

Copilot started reviewing on behalf of Xichen96 July 22, 2026 07:40 View session

Copilot AI reviewed Jul 22, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings July 22, 2026 08:08

Copilot started reviewing on behalf of Xichen96 July 22, 2026 08:08 View session

Copilot AI reviewed Jul 22, 2026

View reviewed changes

Xichen96 added the Request for 202605 Branch label Jul 22, 2026

mssonicbld added the Cherry Pick Conflict_202605 label Jul 22, 2026

Xichen96 closed this Jul 22, 2026

Xichen96 reopened this Jul 22, 2026

Uh oh!

Conversation

Xichen96 commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Root cause

Fix

Current exact-head master PR build

Prior pre-restack evidence

202605 PR-build validation

Uh oh!

mssonicbld commented Jul 19, 2026

Uh oh!

azure-pipelines Bot commented Jul 19, 2026

Uh oh!

azure-pipelines Bot commented Jul 19, 2026

Uh oh!

Xichen96 commented Jul 19, 2026

Uh oh!

azure-pipelines Bot commented Jul 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

mssonicbld commented Jul 19, 2026

Uh oh!

azure-pipelines Bot commented Jul 19, 2026

Uh oh!

Xichen96 commented Jul 19, 2026

Uh oh!

azure-pipelines Bot commented Jul 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

mssonicbld commented Jul 19, 2026

Uh oh!

azure-pipelines Bot commented Jul 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Xichen96 commented Jul 21, 2026

Uh oh!

mssonicbld commented Jul 21, 2026

Uh oh!

mssonicbld commented Jul 21, 2026

Uh oh!

mssonicbld commented Jul 21, 2026

Uh oh!

azure-pipelines Bot commented Jul 21, 2026

Uh oh!

azure-pipelines Bot commented Jul 21, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

mssonicbld commented Jul 22, 2026

Uh oh!

azure-pipelines Bot commented Jul 22, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Xichen96 commented Jul 19, 2026 •

edited

Loading