Fetch capability of mirror before configuring it #4089

stephenxs · 2025-10-11T09:50:12Z

What I did

Fetch capability of ingress/egress mirror before configuring it and avoid configuring ingress/egress mirror on a platform that does not support it.

How I did it

Check the capability in PORT_INGRESS_MIRROR_CAPABLE and PORT_EGRESS_MIRROR_CAPABLE in STATE_DB table SWITCH_CAPABILITY.
The capability of ingress/egress mirror is inserted to STATE_DB by orchagent during initialization.

How to verify it

Manual test and unit test

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

Signed-off-by: Stephen Sun <[email protected]>

mssonicbld · 2025-10-11T09:50:20Z

/azp run

azure-pipelines · 2025-10-11T09:50:30Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Stephen Sun <[email protected]>

mssonicbld · 2025-10-11T10:10:52Z

/azp run

azure-pipelines · 2025-10-11T10:11:02Z

Azure Pipelines successfully started running 1 pipeline(s).

stephenxs · 2025-10-13T03:57:58Z

Failure is caused by rebasing the commit to the latest master. Investigating.

stephenxs · 2025-10-13T07:11:25Z

Failure is caused by rebasing the commit to the latest master. Investigating.

Depends on sonic-net/sonic-swss#3934

Signed-off-by: Stephen Sun <[email protected]>

mssonicbld · 2025-10-20T04:53:23Z

/azp run

azure-pipelines · 2025-10-20T04:53:33Z

Azure Pipelines successfully started running 1 pipeline(s).

config/main.py

bingwang-ms · 2025-11-04T00:49:40Z

Depends on sonic-net/sonic-swss#3934

bingwang-ms · 2025-11-04T00:49:57Z

@qiluo-msft Can you help review this change? Thanks

qiluo-msft · 2025-11-04T01:07:19Z

config/main.py

+def is_port_mirror_capability_supported(direction, namespace=None):
+    """ Check if port mirror capability is supported for the given direction """
+    try:
+        state_db = SonicV2Connector(host='127.0.0.1')


Could you use unix socket which has better performance?

qiluo-msft · 2025-11-04T01:08:20Z

config/main.py

+                return False
+
+        return True
+    except Exception:


Could you use more specific exception type?

Removed as we do not expect any exception here.

Copilot

Pull Request Overview

This PR adds ASIC capability checking for port mirror direction support before allowing mirror session configuration. The change prevents users from configuring mirror sessions with directions (rx/tx/both) that are not supported by the underlying ASIC hardware.

Added is_port_mirror_capability_supported() function to query STATE_DB for ASIC capabilities
Integrated capability validation into validate_mirror_session_config()
Added comprehensive test coverage for capability checking functionality

Reviewed Changes

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

File	Description
config/main.py	Added capability checking function and validation logic to prevent unsupported mirror directions
tests/config_mirror_session_test.py	Added test cases for capability checking and removed trailing whitespace

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

Copilot · 2025-11-04T01:11:47Z

config/main.py

+def is_port_mirror_capability_supported(direction, namespace=None):
+    """ Check if port mirror capability is supported for the given direction """
+    try:
+        state_db = SonicV2Connector(host='127.0.0.1')


The function accepts a namespace parameter but never uses it. Based on other functions in the codebase (e.g., lines 6188-6190), the namespace should be used when initializing SonicV2Connector. Either use the namespace parameter to create the connector with use_unix_socket_path=True and the appropriate namespace, or remove the unused parameter.

Suggested change

state_db = SonicV2Connector(host='127.0.0.1')

if namespace is not None:

state_db = SonicV2Connector(use_unix_socket_path=True, namespace=namespace)

else:

state_db = SonicV2Connector(host='127.0.0.1')

Copilot · 2025-11-04T01:11:48Z

config/main.py

+
+        # If no direction is specified, check both ingress and egress capabilities
+        if not direction:
+            ingress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_INGRESS_MIRROR_CAPABLE")
+            egress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_EGRESS_MIRROR_CAPABLE")
+            return ingress_supported == "true" and egress_supported == "true"
+
+        if direction in ['rx', 'both']:
+            ingress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_INGRESS_MIRROR_CAPABLE")
+            if ingress_supported != "true":
+                return False
+
+        if direction in ['tx', 'both']:
+            egress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_EGRESS_MIRROR_CAPABLE")
+            if egress_supported != "true":
+                return False
+
+        return True


The state_db connection is never explicitly closed. Based on patterns elsewhere in the codebase (e.g., line 6195), the connection should be closed after use with state_db.close(state_db.STATE_DB) to prevent resource leaks.

Suggested change

# If no direction is specified, check both ingress and egress capabilities

if not direction:

ingress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_INGRESS_MIRROR_CAPABLE")

egress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_EGRESS_MIRROR_CAPABLE")

return ingress_supported == "true" and egress_supported == "true"

if direction in ['rx', 'both']:

ingress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_INGRESS_MIRROR_CAPABLE")

if ingress_supported != "true":

return False

if direction in ['tx', 'both']:

egress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_EGRESS_MIRROR_CAPABLE")

if egress_supported != "true":

return False

return True

try:

# If no direction is specified, check both ingress and egress capabilities

if not direction:

ingress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_INGRESS_MIRROR_CAPABLE")

egress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_EGRESS_MIRROR_CAPABLE")

return ingress_supported == "true" and egress_supported == "true"

if direction in ['rx', 'both']:

ingress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_INGRESS_MIRROR_CAPABLE")

if ingress_supported != "true":

return False

if direction in ['tx', 'both']:

egress_supported = state_db.get(state_db.STATE_DB, entry_name, "PORT_EGRESS_MIRROR_CAPABLE")

if egress_supported != "true":

return False

return True

finally:

state_db.close(state_db.STATE_DB)

Signed-off-by: Stephen Sun <[email protected]>

mssonicbld · 2025-11-04T07:20:03Z

/azp run

azure-pipelines · 2025-11-04T07:20:13Z

Azure Pipelines successfully started running 1 pipeline(s).

stephenxs · 2025-11-04T07:25:02Z

It's weird that pretest passed locally but failed in the github

stephens@675ff3c81f2e:/sonic/src/sonic-utilities/config$ git commit -s
[INFO] Initializing environment for https://github.com/PyCQA/flake8.
[INFO] Installing environment for https://github.com/PyCQA/flake8.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
flake8...................................................................Passed
[detached HEAD 8bf2b0d7] Fix community review comments
 1 file changed, 19 insertions(+), 23 deletions(-)
stephens@675ff3c81f2e:/sonic/src/sonic-utilities/config$ git log

Signed-off-by: Stephen Sun <[email protected]>

mssonicbld · 2025-11-04T07:28:04Z

/azp run

azure-pipelines · 2025-11-04T07:28:14Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Stephen Sun <[email protected]>

mssonicbld · 2025-11-04T08:28:43Z

/azp run

azure-pipelines · 2025-11-04T08:28:54Z

Azure Pipelines successfully started running 1 pipeline(s).

liat-grozovik · 2025-11-09T12:13:41Z

@qiluo-msft can you please check if you are ok with comments handling and approve this PR?

Fetch capability of mirror before configuring it.

9b5a365

Signed-off-by: Stephen Sun <[email protected]>

Fix pre-commit issues

8b63e49

Signed-off-by: Stephen Sun <[email protected]>

Remove problematic test

d232447

Signed-off-by: Stephen Sun <[email protected]>

stephenxs changed the title ~~Fetch capability of mirror before configuring it.~~ Fetch capability of mirror before configuring it Oct 20, 2025

stephenxs mentioned this pull request Oct 20, 2025

Check mirror ingress/egress capability before configuring it or setting it to SAI sonic-net/SONiC#2088

Open

stephenxs marked this pull request as ready for review October 23, 2025 06:03

keboliu approved these changes Oct 23, 2025

View reviewed changes

stephenxs requested a review from bingwang-ms October 24, 2025 06:07

bingwang-ms reviewed Oct 30, 2025

View reviewed changes

config/main.py Outdated Show resolved Hide resolved

bingwang-ms previously approved these changes Nov 4, 2025

View reviewed changes

qiluo-msft reviewed Nov 4, 2025

View reviewed changes

qiluo-msft requested a review from Copilot November 4, 2025 01:08

Copilot AI reviewed Nov 4, 2025

View reviewed changes

Fix community review comments

207af46

Signed-off-by: Stephen Sun <[email protected]>

stephenxs dismissed bingwang-ms’s stale review via 207af46 November 4, 2025 07:19

stephenxs requested a review from qiluo-msft November 4, 2025 07:20

Fix pre-commit failure

8e9996e

Signed-off-by: Stephen Sun <[email protected]>

Fix test

f091152

Signed-off-by: Stephen Sun <[email protected]>

Fetch capability of mirror before configuring it #4089

Are you sure you want to change the base?

Fetch capability of mirror before configuring it #4089

Uh oh!

Conversation

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

Uh oh!

What I did

How I did it

How to verify it

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

Uh oh!

mssonicbld commented Oct 11, 2025

Uh oh!

azure-pipelines bot commented Oct 11, 2025

Uh oh!

mssonicbld commented Oct 11, 2025

Uh oh!

azure-pipelines bot commented Oct 11, 2025

Uh oh!

stephenxs commented Oct 13, 2025

Uh oh!

stephenxs commented Oct 13, 2025

Uh oh!

mssonicbld commented Oct 20, 2025

Uh oh!

azure-pipelines bot commented Oct 20, 2025

Uh oh!

Uh oh!

bingwang-ms commented Nov 4, 2025

Uh oh!

bingwang-ms commented Nov 4, 2025

Uh oh!

qiluo-msft Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

stephenxs Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

stephenxs Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Nov 4, 2025

Uh oh!

azure-pipelines bot commented Nov 4, 2025

Uh oh!

stephenxs commented Nov 4, 2025

Uh oh!

mssonicbld commented Nov 4, 2025

Uh oh!

azure-pipelines bot commented Nov 4, 2025

Uh oh!

mssonicbld commented Nov 4, 2025

Uh oh!

azure-pipelines bot commented Nov 4, 2025

Uh oh!

liat-grozovik commented Nov 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

stephenxs commented Oct 11, 2025 •

edited

Loading