Updating XML doc comments for hardware intrinsics to include VEX and EVEX forms #84892
Conversation
ghost
assigned 
dotnet-issue-labeler
bot
added
the
needs-area-label
tannergooding
added
area-System.Runtime.Intrinsics
avx512
|
Tagging subscribers to this area: @dotnet/area-system-runtime-intrinsics Issue DetailsAs per the title this is just an update to the XML docs and some minor reordering of the APIs to be alphabetical (which helps when comparing against the instruction manuals, etc). This was done as part of a pre-pass to adding the V512 variants to Avx512F, Avx512BW, Avx512CD, and Avx512DQ. The updated docs simply list out all the possible forms for the instruction (
|
src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/X86/Avx.cs
Outdated
Show resolved
Hide resolved
src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/X86/Avx.cs
Outdated
Show resolved
Hide resolved
...braries/System.Private.CoreLib/src/System/Runtime/Intrinsics/X86/Avx.PlatformNotSupported.cs
Outdated
Show resolved
Hide resolved
...braries/System.Private.CoreLib/src/System/Runtime/Intrinsics/X86/Avx.PlatformNotSupported.cs
Outdated
Show resolved
Hide resolved
| /// __m128 _mm_cmpnge_ss (__m128 a, __m128 b) | ||
| /// CMPSS xmm, xmm/m32, imm8(6) with swapped operands | ||
| /// int _mm_comile_ss (__m128 a, __m128 b) | ||
| /// COMISS xmm1, xmm2/m32 ; PF=0 && (ZF=1 || CF=1) |
There was a problem hiding this comment.
Love the addition of the flags values 👍
Co-authored-by: Clinton Ingram <[email protected]>
| /// The above native signature does not exist. We provide this additional overload for consistency with the other scalar APIs. | ||
| /// </summary> | ||
| public static Vector128<float> SqrtScalar(Vector128<float> upper, Vector128<float> value) { throw new PlatformNotSupportedException(); } | ||
|
|
||
| /// <summary> | ||
| /// void _mm_storeu_ps (float* mem_addr, __m128 a) | ||
| /// MOVUPS m128, xmm1 |
There was a problem hiding this comment.
xmm instead of xmm1 since there is no xmm2? (here and elsewhere)
There was a problem hiding this comment.
The standardized encoding the architecture manuals is to use xmm1, so we follow it here
As per the title this is just an update to the XML docs and some minor reordering of the APIs to be alphabetical (which helps when comparing against the instruction manuals, etc).
This was done as part of a pre-pass to adding the V512 variants to Avx512F, Avx512BW, Avx512CD, and Avx512DQ. The updated docs simply list out all the possible forms for the instruction (
legacy,vex, andevexforms, where previously we often only listed 1 of the 3).