Allow state db to take modified entries made to the tunnel decap table by developfast · Pull Request #3960 · sonic-net/sonic-swss

developfast · 2025-10-28T23:27:58Z

What I did
Allow state db to take modified entries made to the tunnel decap table

Why I did it
Prevent DB inconsistency between state, asic and appl db

How I verified it
redis-cli -n 6 HGETALL "TUNNEL_DECAP_TABLE|IPINIP_V6_TUNNEL"

"tunnel_type"
"IPINIP"
"dscp_mode"
"pipe"
"ecn_mode"
"standard"
"ttl_mode"
"pipe"

/var/log/syslog.1:2025 Nov 10 19:18:32.730385 bjw-can-2700-2 NOTICE swss#orchagent: :- doDecapTunnelTask: Fields for TUNNEL_DECAP_TABLE entry 'IPINIP_TUNNEL' have been synchronised in STATE_DB
/var/log/syslog.1:2025 Nov 10 19:18:32.740298 bjw-can-2700-2 NOTICE swss#orchagent: :- doDecapTunnelTask: Fields for TUNNEL_DECAP_TABLE entry 'IPINIP_V6_TUNNEL' have been synchronised in STATE_DB

Added comprehensive unit tests too which pass

make  check-TESTS
make[1]: Entering directory '/home/devojha/data/sonic-swss/tests/mock_tests'
make[2]: Entering directory '/home/devojha/data/sonic-swss/tests/mock_tests'
PASS: tests
PASS: tests_intfmgrd
PASS: tests_teammgrd
PASS: tests_portsyncd
PASS: tests_fpmsyncd
PASS: tests_response_publisher
============================================================================
Testsuite summary for sonic-swss 1.0
============================================================================
# TOTAL: 6
# PASS:  6
# SKIP:  0
# XFAIL: 0
# FAIL:  0
# XPASS: 0
# ERROR: 0
============================================================================
make[2]: Leaving directory '/home/devojha/data/sonic-swss/tests/mock_tests'
make[1]: Leaving directory '/home/devojha/data/sonic-swss/tests/mock_tests'

Details if related

mssonicbld · 2025-10-28T23:28:05Z

/azp run

azure-pipelines · 2025-10-28T23:28:16Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-10-28T23:32:48Z

/azp run

azure-pipelines · 2025-10-28T23:32:58Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-11-14T04:33:54Z

/azp run

azure-pipelines · 2025-11-14T04:34:04Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

This PR enables synchronization of tunnel decap table modifications to STATE_DB, preventing database inconsistencies between STATE_DB, ASIC_DB, and APPL_DB. The implementation tracks field changes via a state_changed flag and publishes updates to STATE_DB when modifications occur to existing tunnel entries.

Key Changes

Added state_changed flag tracking in doDecapTunnelTask() to detect when tunnel fields are modified
Set the flag when modifiable fields (dscp_mode, ttl_mode, QoS maps) are updated on existing tunnels
Added STATE_DB synchronization call when changes are detected

Reviewed Changes

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

File	Description
orchagent/tunneldecaporch.cpp	Implements state change tracking and STATE_DB synchronization for tunnel decap table modifications
tests/mock_tests/tunneldecaporch_ut.cpp	Adds comprehensive unit tests for TunnelDecapOrch functionality including creation, modification, and deletion scenarios
tests/mock_tests/Makefile.am	Registers the new tunneldecaporch_ut.cpp test file in the build system

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

orchagent/tunneldecaporch.cpp

mssonicbld · 2025-11-14T19:45:02Z

/azp run

azure-pipelines · 2025-11-14T19:45:13Z

Azure Pipelines successfully started running 1 pipeline(s).

developfast · 2025-11-15T00:27:52Z

@kperumalbfn can you pls check why the checks won't run? The agents don't seem to be grabbing the workers before the 45 min timeout

developfast · 2025-11-15T00:29:07Z

@prsunny @kperumalbfn can you pls review?

prsunny · 2025-11-17T22:42:40Z

orchagent/tunneldecaporch.cpp

                }
            }

+            if (exists && state_changed) {


Why you want an addition 'state_changed variable? why not simply check 'exists' and set STATE_DB?

If none of the fields were updated, then there's no point updating the state db which this state_changed variable keeps track of

Its fine, the current check is 'if exists' its anyways setting the SAI attribute.

not necessarily, some attributes like ecn are not set since they are not supported in SAI and still have the exists keyword check; the state_changed variable ensures that if the SAI attribute is not being changed, then the state db does not take in a false change

Could you add a comment that ECN_MODE SET attribute is not supported in SAI, so that we will revisit this check after updating SAI headers.

also, this is not a frequent operation of setting the fields, so imo, if 'exists' its still ok to just update STATE_DB. it will be a no-op

mssonicbld · 2025-11-18T16:18:45Z

/azp run

azure-pipelines · 2025-11-18T16:18:56Z

Azure Pipelines successfully started running 1 pipeline(s).

tests/mock_tests/tunneldecaporch_ut.cpp

mssonicbld · 2025-11-19T21:24:53Z

/azp run

azure-pipelines · 2025-11-19T21:24:59Z

Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command.

mssonicbld · 2025-11-19T21:25:35Z

/azp run

azure-pipelines · 2025-11-19T21:25:45Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-11-19T22:37:34Z

/azp run

azure-pipelines · 2025-11-19T22:37:45Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-11-19T23:13:02Z

/azp run

azure-pipelines · 2025-11-19T23:13:18Z

Azure Pipelines successfully started running 1 pipeline(s).

prsunny · 2025-11-19T23:28:59Z

orchagent/tunneldecaporch.cpp

                }
            }

+            if (exists) {


if (valid && exists)

{ -> new line

no need for valid since multiple attributes can be changed in a single call to this function. for instance, dscp and ecn value can be in SET mode where dscp set is allowed and SAI change is made to change asic attribute but ecn mode set is not allowed and the valid flag is set to false. in this case, I still want the dscp mode change to be reflected in the state db. Moreover, state db changes are only reflected if the cached tunnel table has changes to it which doesn't happen when valid = false.

ok, i was thinking of this specific case - SWSS_LOG_ERROR("unknown decap tunnel table attribute '%s'.", fvField(i).c_str()); where valid will be false. But agree with you considering the current code flow of setting valid field

mssonicbld · 2025-11-20T00:36:27Z

/azp run

azure-pipelines · 2025-11-20T00:36:37Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-11-20T17:35:20Z

/azp run

azure-pipelines · 2025-11-20T17:35:30Z

Azure Pipelines successfully started running 1 pipeline(s).

…cap table (sonic-net#3960)" This reverts commit 820eb74.

sonic-net#3960) What I did Allow state db to take modified entries made to the tunnel decap table Why I did it Prevent DB inconsistency between state, asic and appl db How I verified it redis-cli -n 6 HGETALL "TUNNEL_DECAP_TABLE|IPINIP_V6_TUNNEL" "tunnel_type" "IPINIP" "dscp_mode" "pipe" "ecn_mode" "standard" "ttl_mode" "pipe" /var/log/syslog.1:2025 Nov 10 19:18:32.730385 bjw-can-2700-2 NOTICE swss#orchagent: :- doDecapTunnelTask: Fields for TUNNEL_DECAP_TABLE entry 'IPINIP_TUNNEL' have been synchronised in STATE_DB /var/log/syslog.1:2025 Nov 10 19:18:32.740298 bjw-can-2700-2 NOTICE swss#orchagent: :- doDecapTunnelTask: Fields for TUNNEL_DECAP_TABLE entry 'IPINIP_V6_TUNNEL' have been synchronised in STATE_DB Signed-off-by: Kalash Nainwal <kalash@nexthop.ai>

sonic-net#3960) What I did Allow state db to take modified entries made to the tunnel decap table Why I did it Prevent DB inconsistency between state, asic and appl db How I verified it redis-cli -n 6 HGETALL "TUNNEL_DECAP_TABLE|IPINIP_V6_TUNNEL" "tunnel_type" "IPINIP" "dscp_mode" "pipe" "ecn_mode" "standard" "ttl_mode" "pipe" /var/log/syslog.1:2025 Nov 10 19:18:32.730385 bjw-can-2700-2 NOTICE swss#orchagent: :- doDecapTunnelTask: Fields for TUNNEL_DECAP_TABLE entry 'IPINIP_TUNNEL' have been synchronised in STATE_DB /var/log/syslog.1:2025 Nov 10 19:18:32.740298 bjw-can-2700-2 NOTICE swss#orchagent: :- doDecapTunnelTask: Fields for TUNNEL_DECAP_TABLE entry 'IPINIP_V6_TUNNEL' have been synchronised in STATE_DB

sonic-net#3960) What I did Allow state db to take modified entries made to the tunnel decap table Why I did it Prevent DB inconsistency between state, asic and appl db How I verified it redis-cli -n 6 HGETALL "TUNNEL_DECAP_TABLE|IPINIP_V6_TUNNEL" "tunnel_type" "IPINIP" "dscp_mode" "pipe" "ecn_mode" "standard" "ttl_mode" "pipe" /var/log/syslog.1:2025 Nov 10 19:18:32.730385 bjw-can-2700-2 NOTICE swss#orchagent: :- doDecapTunnelTask: Fields for TUNNEL_DECAP_TABLE entry 'IPINIP_TUNNEL' have been synchronised in STATE_DB /var/log/syslog.1:2025 Nov 10 19:18:32.740298 bjw-can-2700-2 NOTICE swss#orchagent: :- doDecapTunnelTask: Fields for TUNNEL_DECAP_TABLE entry 'IPINIP_V6_TUNNEL' have been synchronised in STATE_DB Signed-off-by: Lawrence Lee <lawlee@microsoft.com>

sonic-net#3960) What I did Allow state db to take modified entries made to the tunnel decap table Why I did it Prevent DB inconsistency between state, asic and appl db How I verified it redis-cli -n 6 HGETALL "TUNNEL_DECAP_TABLE|IPINIP_V6_TUNNEL" "tunnel_type" "IPINIP" "dscp_mode" "pipe" "ecn_mode" "standard" "ttl_mode" "pipe" /var/log/syslog.1:2025 Nov 10 19:18:32.730385 bjw-can-2700-2 NOTICE swss#orchagent: :- doDecapTunnelTask: Fields for TUNNEL_DECAP_TABLE entry 'IPINIP_TUNNEL' have been synchronised in STATE_DB /var/log/syslog.1:2025 Nov 10 19:18:32.740298 bjw-can-2700-2 NOTICE swss#orchagent: :- doDecapTunnelTask: Fields for TUNNEL_DECAP_TABLE entry 'IPINIP_V6_TUNNEL' have been synchronised in STATE_DB Signed-off-by: Baorong Liu <96146196+baorliu@users.noreply.github.com>

developfast force-pushed the dev/tunnel-decap-mod-state-db branch from 3fe4837 to 93a087a Compare October 28, 2025 23:32

developfast marked this pull request as ready for review November 14, 2025 04:37

developfast requested a review from prsunny as a code owner November 14, 2025 04:37

Copilot AI review requested due to automatic review settings November 14, 2025 04:37

Copilot started reviewing on behalf of developfast November 14, 2025 04:37 View session

Copilot finished reviewing on behalf of developfast November 14, 2025 04:39

Copilot AI reviewed Nov 14, 2025

View reviewed changes

orchagent/tunneldecaporch.cpp Show resolved Hide resolved

developfast force-pushed the dev/tunnel-decap-mod-state-db branch from 191dc36 to 03d3d78 Compare November 14, 2025 19:44

developfast requested a review from kperumalbfn November 15, 2025 00:29

prsunny reviewed Nov 17, 2025

View reviewed changes

developfast force-pushed the dev/tunnel-decap-mod-state-db branch from 03d3d78 to c1b78ce Compare November 18, 2025 16:18

kperumalbfn reviewed Nov 19, 2025

View reviewed changes

tests/mock_tests/tunneldecaporch_ut.cpp Show resolved Hide resolved

developfast added 4 commits November 19, 2025 13:25

modify state db on tunnel decap field mod

3426646

add log on completion of state db sync

ea99bc0

added unit tests

1b636f8

remove state changed var

daf18ae

add more state db specific unit tests

5c6bfe0

developfast force-pushed the dev/tunnel-decap-mod-state-db branch from 84ef20b to 5c6bfe0 Compare November 19, 2025 21:25

add private var separation

3017b37

set private public for private funcs

d556aea

prsunny reviewed Nov 19, 2025

View reviewed changes

remove duplicate test and add new line

aa116e7

prsunny approved these changes Nov 20, 2025

View reviewed changes

kperumalbfn approved these changes Nov 20, 2025

View reviewed changes

Merge branch 'master' into dev/tunnel-decap-mod-state-db

0380803

prsunny merged commit 820eb74 into sonic-net:master Nov 20, 2025
15 checks passed

yijingyan2 added a commit to yijingyan2/sonic-swss that referenced this pull request Dec 3, 2025

Revert "Allow state db to take modified entries made to the tunnel de…

c202f30

…cap table (sonic-net#3960)" This reverts commit 820eb74.

Conversation

developfast commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mssonicbld commented Oct 28, 2025

Uh oh!

azure-pipelines bot commented Oct 28, 2025

Uh oh!

mssonicbld commented Oct 28, 2025

Uh oh!

azure-pipelines bot commented Oct 28, 2025

Uh oh!

mssonicbld commented Nov 14, 2025

Uh oh!

azure-pipelines bot commented Nov 14, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Uh oh!

mssonicbld commented Nov 14, 2025

Uh oh!

azure-pipelines bot commented Nov 14, 2025

Uh oh!

developfast commented Nov 15, 2025

Uh oh!

developfast commented Nov 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Nov 18, 2025

Uh oh!

azure-pipelines bot commented Nov 18, 2025

Uh oh!

Uh oh!

mssonicbld commented Nov 19, 2025

Uh oh!

azure-pipelines bot commented Nov 19, 2025

Uh oh!

mssonicbld commented Nov 19, 2025

Uh oh!

azure-pipelines bot commented Nov 19, 2025

Uh oh!

mssonicbld commented Nov 19, 2025

Uh oh!

azure-pipelines bot commented Nov 19, 2025

Uh oh!

mssonicbld commented Nov 19, 2025

Uh oh!

azure-pipelines bot commented Nov 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

developfast Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Nov 20, 2025

Uh oh!

azure-pipelines bot commented Nov 20, 2025

Uh oh!

mssonicbld commented Nov 20, 2025

Uh oh!

developfast commented Oct 28, 2025 •

edited

Loading

developfast Nov 20, 2025 •

edited

Loading