Skip to content

[SYCL][test] Throw if order of ABI symbols is incorrect #20424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 22, 2025
Merged

[SYCL][test] Throw if order of ABI symbols is incorrect #20424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8de0a3b
[SYCL][test] Throw if order of ABI symbols is incorrect
uditagarwal97 Oct 21, 2025
88bbe00
throw error when symbol order differ
uditagarwal97 Oct 21, 2025
e08d593
FIX ABI symbol ordering
uditagarwal97 Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions sycl/test/abi/sycl_symbols_linux.dump
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2985,12 +2985,12 @@ _ZN4sycl3_V121__isgreaterequal_implEdd
_ZN4sycl3_V121__isgreaterequal_implEff
_ZN4sycl3_V122accelerator_selector_vERKNS0_6deviceE
_ZN4sycl3_V128verifyUSMAllocatorPropertiesERKNS0_13property_listE
_ZN4sycl3_V139submit_kernel_direct_without_event_implILi1EEEvRKNS0_5queueERKNS0_8nd_rangeIXT_EEERNS0_6detail17HostKernelRefBaseEPNS9_16DeviceKernelInfoERKNS9_13code_locationEb
_ZN4sycl3_V136submit_kernel_direct_with_event_implILi1EEENS0_5eventERKNS0_5queueERKNS0_8nd_rangeIXT_EEERNS0_6detail17HostKernelRefBaseEPNSA_16DeviceKernelInfoERKNSA_13code_locationEb
_ZN4sycl3_V136submit_kernel_direct_with_event_implILi2EEENS0_5eventERKNS0_5queueERKNS0_8nd_rangeIXT_EEERNS0_6detail17HostKernelRefBaseEPNSA_16DeviceKernelInfoERKNSA_13code_locationEb
_ZN4sycl3_V136submit_kernel_direct_with_event_implILi3EEENS0_5eventERKNS0_5queueERKNS0_8nd_rangeIXT_EEERNS0_6detail17HostKernelRefBaseEPNSA_16DeviceKernelInfoERKNSA_13code_locationEb
_ZN4sycl3_V139submit_kernel_direct_without_event_implILi1EEEvRKNS0_5queueERKNS0_8nd_rangeIXT_EEERNS0_6detail17HostKernelRefBaseEPNS9_16DeviceKernelInfoERKNS9_13code_locationEb
_ZN4sycl3_V139submit_kernel_direct_without_event_implILi2EEEvRKNS0_5queueERKNS0_8nd_rangeIXT_EEERNS0_6detail17HostKernelRefBaseEPNS9_16DeviceKernelInfoERKNS9_13code_locationEb
_ZN4sycl3_V139submit_kernel_direct_without_event_implILi3EEEvRKNS0_5queueERKNS0_8nd_rangeIXT_EEERNS0_6detail17HostKernelRefBaseEPNS9_16DeviceKernelInfoERKNS9_13code_locationEb
_ZN4sycl3_V136submit_kernel_direct_with_event_implILi2EEENS0_5eventERKNS0_5queueERKNS0_8nd_rangeIXT_EEERNS0_6detail17HostKernelRefBaseEPNSA_16DeviceKernelInfoERKNSA_13code_locationEb
_ZN4sycl3_V13ext5intel12experimental9pipe_base13get_pipe_nameB5cxx11EPKv
_ZN4sycl3_V13ext5intel12experimental9pipe_base17wait_non_blockingERKNS0_5eventE
_ZN4sycl3_V13ext5intel12experimental9pipe_base18get_pipe_name_implEPKv
Expand Down Expand Up @@ -3579,6 +3579,7 @@ _ZN4sycl3_V17handler18RangeRoundingTraceEv
_ZN4sycl3_V17handler18ext_oneapi_barrierERKSt6vectorINS0_5eventESaIS3_EE
_ZN4sycl3_V17handler18extractArgsAndReqsEv
_ZN4sycl3_V17handler19getMaxWorkGroups_v2Ev
_ZN4sycl3_V17handler19setDeviceKernelInfoEONS0_6kernelE
_ZN4sycl3_V17handler19supportsUSMMemcpy2DEv
_ZN4sycl3_V17handler19supportsUSMMemset2DEv
_ZN4sycl3_V17handler20DisableRangeRoundingEv
Expand All @@ -3601,7 +3602,6 @@ _ZN4sycl3_V17handler21setKernelWorkGroupMemEm
_ZN4sycl3_V17handler21setUserFacingNodeTypeENS0_3ext6oneapi12experimental9node_typeE
_ZN4sycl3_V17handler22ext_oneapi_fill2d_implEPvmPKvmmm
_ZN4sycl3_V17handler22memcpyFromDeviceGlobalEPvPKvbmm
_ZN4sycl3_V17handler19setDeviceKernelInfoEONS0_6kernelE
_ZN4sycl3_V17handler22setDeviceKernelInfoPtrEPNS0_6detail16DeviceKernelInfoE
_ZN4sycl3_V17handler22setHandlerKernelBundleENS0_6kernelE
_ZN4sycl3_V17handler22setHandlerKernelBundleERKSt10shared_ptrINS0_6detail18kernel_bundle_implEE
Expand Down
6 changes: 3 additions & 3 deletions sycl/test/abi/sycl_symbols_windows.dump
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,10 +288,10 @@
??$is_image_handle_supported@Uunsampled_image_handle@experimental@oneapi@ext@_V1@sycl@@@experimental@oneapi@ext@_V1@sycl@@YA_NAEBUimage_descriptor@01234@W4image_memory_handle_type@01234@AEBVqueue@34@@Z
??$submit_kernel_direct_with_event_impl@$00@_V1@sycl@@YA?AVevent@01@AEBVqueue@01@AEBV?$nd_range@$00@01@AEAVHostKernelRefBase@detail@01@PEAVDeviceKernelInfo@601@AEBUcode_location@601@_N@Z
??$submit_kernel_direct_with_event_impl@$01@_V1@sycl@@YA?AVevent@01@AEBVqueue@01@AEBV?$nd_range@$01@01@AEAVHostKernelRefBase@detail@01@PEAVDeviceKernelInfo@601@AEBUcode_location@601@_N@Z
??$submit_kernel_direct_without_event_impl@$02@_V1@sycl@@YAXAEBVqueue@01@AEBV?$nd_range@$02@01@AEAVHostKernelRefBase@detail@01@PEAVDeviceKernelInfo@501@AEBUcode_location@501@_N@Z
??$submit_kernel_direct_with_event_impl@$02@_V1@sycl@@YA?AVevent@01@AEBVqueue@01@AEBV?$nd_range@$02@01@AEAVHostKernelRefBase@detail@01@PEAVDeviceKernelInfo@601@AEBUcode_location@601@_N@Z
??$submit_kernel_direct_without_event_impl@$00@_V1@sycl@@YAXAEBVqueue@01@AEBV?$nd_range@$00@01@AEAVHostKernelRefBase@detail@01@PEAVDeviceKernelInfo@501@AEBUcode_location@501@_N@Z
??$submit_kernel_direct_without_event_impl@$01@_V1@sycl@@YAXAEBVqueue@01@AEBV?$nd_range@$01@01@AEAVHostKernelRefBase@detail@01@PEAVDeviceKernelInfo@501@AEBUcode_location@501@_N@Z
??$submit_kernel_direct_with_event_impl@$02@_V1@sycl@@YA?AVevent@01@AEBVqueue@01@AEBV?$nd_range@$02@01@AEAVHostKernelRefBase@detail@01@PEAVDeviceKernelInfo@601@AEBUcode_location@601@_N@Z
??$submit_kernel_direct_without_event_impl@$02@_V1@sycl@@YAXAEBVqueue@01@AEBV?$nd_range@$02@01@AEAVHostKernelRefBase@detail@01@PEAVDeviceKernelInfo@501@AEBUcode_location@501@_N@Z
??$update_nd_range@$00@node@experimental@oneapi@ext@_V1@sycl@@QEAAXV?$nd_range@$00@45@@Z
??$update_nd_range@$01@node@experimental@oneapi@ext@_V1@sycl@@QEAAXV?$nd_range@$01@45@@Z
??$update_nd_range@$02@node@experimental@oneapi@ext@_V1@sycl@@QEAAXV?$nd_range@$02@45@@Z
Expand Down Expand Up @@ -4425,8 +4425,8 @@
?setKernelClusterLaunch@handler@_V1@sycl@@AEAAXV?$range@$01@23@@Z
?setKernelClusterLaunch@handler@_V1@sycl@@AEAAXV?$range@$02@23@@Z
?setKernelClusterLaunch@handler@_V1@sycl@@AEAAXV?$range@$02@23@H@Z
?setKernelInfo@handler@_V1@sycl@@AEAAXPEAXHP6A?AUkernel_param_desc_t@detail@23@H@Z_N2@Z
?setKernelFunc@handler@_V1@sycl@@AEAAXPEAX@Z
?setKernelInfo@handler@_V1@sycl@@AEAAXPEAXHP6A?AUkernel_param_desc_t@detail@23@H@Z_N2@Z
?setKernelIsCooperative@handler@_V1@sycl@@AEAAX_N@Z
?setKernelNameBasedCachePtr@handler@_V1@sycl@@AEAAXPEAUKernelNameBasedCacheT@detail@23@@Z
?setKernelWorkGroupMem@handler@_V1@sycl@@AEAAX_K@Z
Expand Down
2 changes: 1 addition & 1 deletion sycl/test/tools/abi_check_positive_dump.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
_start
_Z3foov
_start
main
24 changes: 22 additions & 2 deletions sycl/tools/abi_check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,13 @@ def compare_results(ref_records, records):
missing_records = set(ref_records).difference(set(records))
new_records = set(records).difference(set(ref_records))

return (missing_records, new_records)
is_order_incorrect = False
# If missing_records and new_records is null, check the order of symbols.
if not missing_records and not new_records:
if ref_records != records:
is_order_incorrect = True

return (missing_records, new_records, is_order_incorrect)


# Dumps symbols from from binary at target_path and compares with a snapshot
Expand All @@ -129,8 +135,11 @@ def check_symbols(ref_path, target_path, ignore_new):
]
)
symbols = parse_readobj_output(readobj_out)
symbols.sort()

missing_symbols, new_symbols = compare_results(ref_symbols, symbols)
missing_symbols, new_symbols, is_order_incorrect = compare_results(
ref_symbols, symbols
)

correct_return = True
if missing_symbols:
Expand All @@ -156,6 +165,17 @@ def check_symbols(ref_path, target_path, ignore_new):
print("The following symbols are new to the object file:\n")
print("\n".join(new_symbols))

if is_order_incorrect:
correct_return = False
print(
(
"The order of ABI symbols is incorrect. While it is not a breaking "
"change, please refrain from manually editing the ABI symbol dump file. "
"Refer to sycl/doc/developer/ABIPolicyGuide.md for instructions on automatically "
"updating the ABI symbol dump file."
)
)

if not correct_return:
sys.exit(-1)

Expand Down
Loading