saiserver: default switch_id on neighbor/route entries when omitted by nicholasching · Pull Request #2300 · opencomputeproject/SAI

nicholasching · 2026-06-22T19:36:51Z

Context / motivation

Part of the SAIVPP unit-test framework (see PR 1 / our docker-sai-test-vpp/devdocs/). When running the OCP sai_test suite against the VPP SAI backend, neighbor- and route-create tests failed at create time with SAI_STATUS_INVALID_PARAMETER (-5):

ERROR: meta_generic_validation_create: switch id is NULL for SAI_OBJECT_TYPE_NEIGHBOR_ENTRY

Root cause

sai_thrift_neighbor_entry_t / sai_thrift_route_entry_t carry a switch_id, but many OCP tests build these entries with only rif_id (+ ip_address / destination) and omit switch_id. The saithriftv2 RPC server copied the thrift switch_id straight through, so meta validation received switch_id == 0 and rejected the create. (Tests that pass through the common-config path, which sets switch_id explicitly, succeeded — only entries that omit it failed.)

What this change does

meta/templates/sai_rpc_server_helper_functions.tt — custom sai_thrift_parse_neighbor_entry() / sai_thrift_parse_route_entry() that, when the thrift switch_id is 0, fall back to the RPC-global switch_id (the OID returned by sai_thrift_create_switch) and then gSwitchId. (The auto-generated struct copies for these two entry types are skipped in favor of these.)
test/saithrift/src/switch_sai.thrift, switch_sai_rpc_server.cpp — the same switch_id field + fallback in the legacy v1 thrift server, for parity.
test/sai_test/config/route_configer.py — pass switch_id=self.dut.switch_id explicitly on the route entries the common config builds, so the persisted T0 config is consistent regardless of the fallback.

This mirrors how a real ASIC SAI shim behaves (the switch is unambiguous), and unblocks the neighbor/route-create-on-RIF tests.

Scope / risk

4 files, +79/−18 — RPC-server parsing for two entry types (+ v1 parity) and explicit switch_id in the test common config.
No change to SAI behavior for callers that already pass switch_id — the fallback only triggers when it is 0/omitted.
Server-side only; no packet-path or test-logic change.

Dependencies
None. Related to #2299, however, their edits are isolated and each target master.

Signed-off-by: Nicholas Ching <nicholaslching@gmail.com>

azure-pipelines · 2026-06-23T20:37:36Z

Commenter does not have sufficient privileges for PR 2300 in repo opencomputeproject/SAI

nicholasching · 2026-06-24T13:46:19Z

@tjchadaga please run azure pipeline when possible; this PR is needed for an upstream feature at Cisco ASAP, thanks!

yue-fred-gao · 2026-06-24T20:25:13Z

  }

  void sai_thrift_parse_neighbor_entry(const sai_thrift_neighbor_entry_t &thrift_neighbor_entry, sai_neighbor_entry_t *neighbor_entry) {
-      neighbor_entry->switch_id = gSwitchId;


I don't quite understand about this change. From my reading of the code, saiserver stores switch_id in gSwitchId (

SAI/test/saithrift/src/saiserver.cpp

Line 438 in c0203c0

status = sai_switch_api->create_switch(&gSwitchId, attrSz, attr);

). Subsequent calls can use the gSwitchId if it is not in the RPC request, such as neighbor entries. Is there a case that gSwitchId is invalid?

Yes, that is correct; for v1, gSwitchId is always valid so the change is not needed here. I made it to maintain feature parity w/saithriftv2.

Edits to saithriftv2 were needed because gSwitchId in saiserver.cpp is only declared and not assigned on the RPC path.

SAI/test/saithriftv2/src/saiserver.cpp

Line 43 in 9e90412

sai_object_id_t gSwitchId; ///< SAI switch global object ID.

Instead, sai_thrift_create_switch() stores the OID in the RPC-global switch_id.

So when tests created a neighbor or route over RPC, and did not send switch_id, saithriftv2 would pass switch_id=0 to SAI, resulting in switch id is NULL error (-5). The change to saithriftv2 adds a fallback for when switch_id is not passed in (0): first to the RPC path switch_id set by create_switch (which resolves the -5), then to gSwitchId as backup.

Should I keep this change for feature parity or remove to avoid touching v1?

I see. Didn't know there are 2 versions of saithrift. I think we can undo the change. Leave v1 as is

yue-fred-gao · 2026-06-26T14:21:30Z

 struct sai_thrift_neighbor_entry_t {
-    1: sai_thrift_object_id_t rif_id;
-    2: sai_thrift_ip_address_t ip_address;
+    1: sai_thrift_object_id_t switch_id;


I think this is not needed. We should keep the original design. let sai rpc server assign switch_id use the stored RPC scoped switch_id variable. Then the changes in route_configer.py are also not needed.

I agree, since issue was fixed by RPC-scoped switch_id fallback, no need for tests to pass in switch_id

yue-fred-gao · 2026-06-26T14:25:48Z

+    } else if (switch_id != SAI_NULL_OBJECT_ID) {
+        neighbor_entry->switch_id = switch_id;
+    } else if (gSwitchId != SAI_NULL_OBJECT_ID) {
+        neighbor_entry->switch_id = gSwitchId;


same as above, we probably can remove this line.

yue-fred-gao · 2026-06-26T14:26:29Z

 [%- ######################################################################## -%]

 [%- BLOCK special_helper_functions -%]
+extern sai_object_id_t gSwitchId;


In thrift v2, gSwitchId is never set, right? We probably can remove this line.

Yes, that is correct; gSwitchId is never set in v2. I will remove the line.

yue-fred-gao · 2026-06-26T14:28:08Z

  }

  void sai_thrift_parse_neighbor_entry(const sai_thrift_neighbor_entry_t &thrift_neighbor_entry, sai_neighbor_entry_t *neighbor_entry) {
-      neighbor_entry->switch_id = gSwitchId;


I see. Didn't know there are 2 versions of saithrift. I think we can undo the change. Leave v1 as is

Signed-off-by: Nicholas Ching <nicholaslching@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>

nicholasching · 2026-06-26T15:43:07Z

Hi @yue-fred-gao! I've made the requested changes on latest; now only fallback to RPC-scoped switch_id. Changes for this PR are much cleaner now, only touching 1 file; thanks!

yue-fred-gao · 2026-06-26T15:58:41Z

+
+    // OCP sai_test often omits switch_id on neighbor_entry; fall back to the
+    // RPC-global switch_id set by sai_thrift_create_switch.
+    if (thrift_neighbor_entry.switch_id != 0) {


does sai_thrift_neighbor_entry_t have switch_id?

Yes, thesai_thrift_neighbor_entry_t in thriftv2 is generated from the SAI header sai_neighbor_entry_t, of which switch_id is a member.

SAI/inc/saineighbor.h

Lines 185 to 192 in c0203c0

typedef struct _sai_neighbor_entry_t

{

/**

* @brief Switch ID

*

* @objects SAI_OBJECT_TYPE_SWITCH

*/

sai_object_id_t switch_id;

I see. The previous change to sai_thrift_neighbor_entry_t is actually for v1. v2 always generate sai thrift from SAI headers.

nicholasching · 2026-07-07T20:14:02Z

@kcudnik, could you please invoke azure pipelines to run checks, please. I do not have the permissions to do so.

kcudnik · 2026-07-07T20:45:45Z

/azp run

azure-pipelines · 2026-07-07T20:45:54Z

Azure Pipelines successfully started running 1 pipeline(s).

nicholasching · 2026-07-13T15:23:36Z

Hi @kcudnik, the changes in this PR have been reviewed by @yue-fred-gao and are passing checks. When you have a chance, could you please take a quick look and help us merge into master for upstream feature in sonic-sairedis? Thanks!

kcudnik · 2026-07-13T17:53:24Z

/azp run

azure-pipelines · 2026-07-13T17:53:34Z

Azure Pipelines successfully started running 1 pipeline(s).

…tdevs for standalone benches (#2316) Context / motivation Part of the SAIVPP unit-test framework (see the sonic-sairedis docker-sai-test-vpp harness). When the OCP sai_test T0 suite runs against a SAI backend on a standalone bench with no SONiC control plane, there is no teamd to create PortChannel netdevs and no IntfMgr to assign LAG/SVI interface IPs — which some backends (e.g. the VPP virtual switch) rely on for LAG bring-up and routed-to-LAG/SVI forwarding. This adds an opt-in way for the test setup to emulate that. What this change does test/sai_test/config/simulate_sonic.py (new). Opt-in helper, active only when SIMULATE_SONIC=1; every entry point is a no-op otherwise. test/sai_test/config/lag_configer.py — create_lag(). When enabled, create the PortChannel<N> netdev teamd would provide, before the SAI LAG create. test/sai_test/config/route_configer.py — create_router_interface(). When enabled, assign the connected IPs IntfMgr would set on a LAG or VLAN(SVI) router interface. Vendor-neutral by construction. PortChannel netdevs use generic Linux ip … type bond; LAG RIF IPs use ip addr add. A VLAN SVI has no host-interface netdev to mirror from, so its address is programmed via command templates supplied by the caller (SVI_RIF_SET_IP_CMD / SVI_RIF_PROBE_CMD, with {ifname}/{addr} placeholders) — no backend-specific tooling is hardcoded in sai_test. All interface-name prefixes and address patterns are env-overridable. Scope / risk 3 files (one new module + two setUp-path hooks) — test-config helpers only; no change to SAI/backend code or packet semantics. Fully opt-in with default-off: with SIMULATE_SONIC unset, all entry points no-op, so real-HW and other OCP consumers are unchanged unless they opt in. Dependencies None. Independent of #2299 / #2300 / #2301 (edits different functions); targets master.

…ix v4/v6 NHG port-list aliasing (#2301) Context / motivation Part of the SAIVPP unit-test framework (see PR 1 / our docker-sai-test-vpp/devdocs/, esp. the 6-19 entry). Three independent correctness/robustness fixes in the OCP sai_test config helpers that the suite needs when run against the VPP SAI backend. What this change does test/sai_test/config/port_configer.py — drop bridge_id on create_bridge_port. Passing bridge_id to sai_thrift_create_bridge_port caused a create failure in our backend; the default 1Q bridge is used, so the argument is redundant. Removing it lets bridge-port creation succeed. test/sai_test/config/port_configer.py — env-gated, bounded port bring-up wait. turn_up_and_get_checked_ports() waited per port, serially (retries × sleep) for oper-status UP. On a 32-port topology where oper-status is slow to settle, this is ~60s+ of dead time per common-config build. The wait is now tunable via env (SAI_PORT_UP_RETRIES, SAI_PORT_UP_POLL_INTERVAL, SAI_PORT_UP_SHARED_WAIT) and can poll all ports together in one bounded window. Defaults preserve the original behavior (per-port wait), so real-HW/other OCP consumers are unchanged unless they opt in; only our harness sets the fast values. test/sai_test/config/route_configer.py — give v4/v6 NHGs independent member_port_indexs. create_nexthop_group_by_nexthops() constructed the v4 and v6 NexthopGroup objects sharing one Python list object for member_port_indexs. A mutation on one group (member remove/re-add tests) then corrupted the other's port list (ValueError: list.remove(x): x not in list). Each group now gets its own list(...) copy. (Latent aliasing bug, independent of any harness specifics.) Scope / risk 2 files, +64/−25 — test-config helpers only; no change to SAI/backend code or packet semantics. The port-up change is opt-in via env with original defaults, so it does not alter timing for existing consumers. The bridge_id removal relies on the default 1Q bridge (already how these tests are used). Dependencies None. Related to #2299 and #2300, however, their edits are isolated and each target master.

nicholasching added 2 commits June 22, 2026 11:59

fix: switch_id on route + neighbor entries

3e94e74

Signed-off-by: Nicholas Ching <nicholaslching@gmail.com>

fix: -5 error, switch-id-NULL on neighbor/route create test

51d2647

Signed-off-by: Nicholas Ching <nicholaslching@gmail.com>

nicholasching mentioned this pull request Jun 22, 2026

sai_test config: drop redundant bridge_id, env-gated port bring-up, fix v4/v6 NHG port-list aliasing #2301

Merged

yue-fred-gao reviewed Jun 24, 2026

View reviewed changes

yue-fred-gao reviewed Jun 26, 2026

View reviewed changes

fix: fall back only to RPC-scoped switch_id

1c9832a

Signed-off-by: Nicholas Ching <nicholaslching@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>

yue-fred-gao reviewed Jun 26, 2026

View reviewed changes

yue-fred-gao approved these changes Jun 26, 2026

View reviewed changes

nicholasching mentioned this pull request Jul 6, 2026

sai_test: add opt-in SIMULATE_SONIC to emulate SONiC teamd/IntfMgr netdevs for standalone benches #2316

Merged

kcudnik approved these changes Jul 13, 2026

View reviewed changes

kcudnik merged commit 64d4b84 into opencomputeproject:master Jul 13, 2026
3 checks passed

	typedef struct _sai_neighbor_entry_t
	{
	/**
	* @brief Switch ID
	*
	* @objects SAI_OBJECT_TYPE_SWITCH
	*/
	sai_object_id_t switch_id;

Uh oh!

Conversation

nicholasching commented Jun 22, 2026

Uh oh!

azure-pipelines Bot commented Jun 23, 2026

Uh oh!

nicholasching commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicholasching Jun 25, 2026 • 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!

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!

Choose a reason for hiding this comment

Uh oh!

nicholasching commented Jun 26, 2026

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!

nicholasching commented Jul 7, 2026

Uh oh!

kcudnik commented Jul 7, 2026

Uh oh!

azure-pipelines Bot commented Jul 7, 2026

Uh oh!

nicholasching commented Jul 13, 2026

Uh oh!

kcudnik commented Jul 13, 2026

Uh oh!

azure-pipelines Bot commented Jul 13, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nicholasching commented Jun 24, 2026 •

edited

Loading

nicholasching Jun 25, 2026 •

edited

Loading