Skip to content

fix: add runtime check for AVX512-FP16 support instead of relying on compiler version#28236

Open
PriscillaJCorn wants to merge 3 commits intomicrosoft:mainfrom
PriscillaJCorn:main
Open

fix: add runtime check for AVX512-FP16 support instead of relying on compiler version#28236
PriscillaJCorn wants to merge 3 commits intomicrosoft:mainfrom
PriscillaJCorn:main

Conversation

@PriscillaJCorn
Copy link
Copy Markdown

Description

It is inappropriate to merely guess whether the AVX512-FP16 instruction is supported based on the compiler's version information, as this can lead to numerous exceptions. Therefore, before starting, I have added a simple and practical check, which involves testing the compiler's support for the instruction through a small case study.

Motivation and Context

Fix #22519 and #24025
The current logic determines AVX512-FP16 support based on compiler version heuristics.
This is not reliable, since compiler version alone does not guarantee that the target
toolchain or hardware fully supports the instruction set.

As a result, this may lead to incorrect feature enablement, causing build failures or
runtime exceptions on certain environments.

This change improves robustness by replacing the heuristic with a compile-time check,
ensuring that AVX512-FP16 is only enabled when it is actually supported.

@PriscillaJCorn
Copy link
Copy Markdown
Author

@PriscillaJCorn please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree

@hariharans29
Copy link
Copy Markdown
Member

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline

@azure-pipelines
Copy link
Copy Markdown

No pipelines are associated with this pull request.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves MLAS AVX512-FP16 feature enablement by replacing compiler-version heuristics with an actual compile-time capability check, so AVX512-FP16 codepaths are only enabled when the toolchain can assemble the required instructions (addressing build failures reported in #22519 and #24025).

Changes:

  • Replace _MSC_VER/__GNUC__ version heuristics in MLAS runtime dispatch with a build-defined capability macro (MLAS_SUPPORTS_AVX512FP16).
  • Add a CMake compile test for AVX512-FP16 instruction support and conditionally include the AVX512-FP16 conversion assembly.
  • Minor whitespace cleanup in ARM FP16 kernel selection code.

Reviewed changes

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

File Description
onnxruntime/core/mlas/lib/platform.cpp Switches runtime AVX512-FP16 dispatch gating to a build-time macro instead of compiler-version checks.
cmake/onnxruntime_mlas.cmake Adds a compile-time probe for AVX512-FP16 instruction support and conditionally enables related assembly + a preprocessor define.

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

Comment on lines 529 to +537
#ifndef __APPLE__
#if (defined(_MSC_VER) && (_MSC_VER >= 1933)) || (defined(__GNUC__) && (__GNUC__ >= 13))
#if defined(MLAS_SUPPORTS_AVX512FP16)
//
// Check if the processor supports AVX NE CONVERT.
//
if ((Cpuid7_1[3] & (0b1 << 5)) != 0) {
this->CastF16ToF32Kernel = &MlasCastF16ToF32KernelAvx;
}
#endif // (defined(_MSC_VER) && (_MSC_VER >= 1933)) || (defined(__GNUC__) && (__GNUC__ >= 13))
#endif // MLAS_SUPPORTS_AVX512FP16
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MLAS_SUPPORTS_AVX512FP16 now gates enabling CastF16ToF32Kernel, but that macro is only defined in the non-MSVC CMake path. On Windows/MSVC, setup_mlas_source_for_windows() can still add amd64/cvtfp16Avx.asm (MSVC_VERSION>=1933), yet this block will never run, so AVX512-FP16 support may be silently disabled at runtime even when the kernel is built. Consider defining MLAS_SUPPORTS_AVX512FP16 in the MSVC path when cvtfp16Avx.asm is enabled (or reintroduce an MSVC-specific compile-time guard).

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot apply changes based on this feedback Yes, in func setup_mlas_source_for_windows() , we should define MLAS_SUPPORTS_AVX512FP16 in the MSVC path when cvtfp16Avx.asm is enabled.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this comment addressed ?

Comment thread cmake/onnxruntime_mlas.cmake Outdated
Comment thread cmake/onnxruntime_mlas.cmake
Comment thread cmake/onnxruntime_mlas.cmake Outdated
@hariharans29
Copy link
Copy Markdown
Member

Thanks for the contribution - can you please check if copilot's review comments are relevant ?

PriscillaJCorn and others added 2 commits April 28, 2026 10:49
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@hariharans29
Copy link
Copy Markdown
Member

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline

@azure-pipelines
Copy link
Copy Markdown

No pipelines are associated with this pull request.

@PriscillaJCorn
Copy link
Copy Markdown
Author

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline
@hariharans29 Please check and re-runthis CI. It seems that some packages failed to download during the build process.

@hariharans29 hariharans29 requested a review from Copilot April 29, 2026 17:18
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

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


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

Comment on lines +799 to 800
list(APPEND mlas_private_compile_definitions MLAS_SUPPORTS_AVX512FP16)
endif()
Copy link

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The probe is hardwired to GCC/Clang-style flags (-mavx512fp16) and GNU inline asm syntax, which will fail under MSVC (and some clang-cl configurations). This can silently disable the FP16 path on Windows even when the toolchain supports it, changing behavior vs the prior _MSC_VER branch. Consider branching on CMAKE_CXX_COMPILER_ID and using a C++-based probe with compiler-appropriate flags (e.g., MSVC /arch: equivalent or a clang-cl compatible approach), so the macro is correctly set across supported toolchains.

Copilot uses AI. Check for mistakes.
)
if(CMAKE_CXX_COMPILER_VERSION GREATER_EQUAL 13.1 AND NOT(APPLE))

include(CheckCSourceCompiles)
Copy link

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feature is consumed by C++ sources (platform.cpp), but the probe uses CheckCSourceCompiles. Using CheckCXXSourceCompiles (and the corresponding include) makes the probe match the actual compilation environment (C++ compiler, flags, and frontend), and avoids coupling this logic to the presence/configuration of the C language in the build.

Copilot uses AI. Check for mistakes.
Comment on lines +530 to +537
#if defined(MLAS_SUPPORTS_AVX512FP16)
//
// Check if the processor supports AVX NE CONVERT.
//
if ((Cpuid7_1[3] & (0b1 << 5)) != 0) {
this->CastF16ToF32Kernel = &MlasCastF16ToF32KernelAvx;
}
#endif // (defined(_MSC_VER) && (_MSC_VER >= 1933)) || (defined(__GNUC__) && (__GNUC__ >= 13))
#endif // MLAS_SUPPORTS_AVX512FP16
Copy link

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The compile-time guard name MLAS_SUPPORTS_AVX512FP16 doesn’t match the runtime check/comment (“AVX NE CONVERT”) and the instruction used in the CMake probe (vcvtneeph2ps). Please align terminology so it’s clear what’s actually being required (e.g., rename the macro/probe variable to reflect AVX-NE-CONVERT, or update the comment/probe to match AVX512-FP16 if that’s the intended feature).

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Build] compilation error: invalid instruction mnemonic 'vcvtneeph2ps'

3 participants