Activity

1. ghost added

   needs-area-labelAn area label is needed to ensure this gets routed to the appropriate area ownersAn area label is needed to ensure this gets routed to the appropriate area owners

   on Mar 19, 2024
2. dotnet-policy-service

   added

   untriagedNew issue has not been triaged by the area ownerNew issue has not been triaged by the area owner

   on Mar 19, 2024
3. a74nh commented on Mar 19, 2024

   

   a74nh

   on Mar 19, 2024

   Last edited by kunalspathak

   Contributor

   More actions

   Recommendation for how to implement.
   Examples of this can be found in 100134

   API

   • src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Sve.PlatformNotSupported.cs
   • src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Sve.cs
   • src/libraries/System.Runtime.Intrinsics/ref/System.Runtime.Intrinsics.cs

   Copy/paste contents from files in https://github.com/a74nh/runtime/tree/api_github/sve_api/out_cs_api/ . There should be no need to edit these changes. Keep alphabetical ordering.

   The same files have been given additional annotation and can be found in https://github.com/a74nh/runtime/tree/api_github/sve_api/out_helper_api . These are for development use only and are not for commiting.

   HW Intrinsics

   • src/coreclr/jit/hwintrinsiclistarm64sve.h

   Copy/paste from https://github.com/a74nh/runtime/blob/api_github/sve_api/out_hwintrinsiclistarm64sve.h
   For entries with multiple instructions for a single type, this will need fixing via a special code path.
   The flags and category columns will probably need manually fixing.
   Flags that are not automatically detected:

   • HW_Flag_LowMaskedOperation : The predicate in arg1 is 0-7
   • HW_Flag_HasRMWSemantics : src1 and dest use the same register.
   • HW_Flag_EmbeddedMaskedOperation : APIs that have just have "predicated" version. These APIs are converted into ConditionalSelect(AllTrue, CALL_API(operands...), Zero) to get the effect of "predicate" registers. E.g. Abs, Divide.
   • HW_Flag_OptionalEmbeddedMaskedOperation : APIs that have both "predicated" and "unpredicated" version. These APIs can be used stand alone, for which "unpredicated" version of the instruction will be generated. They can also be wrapped in ConditionalSelect in a user code and in which case, "predicated" version of the instruction will be emitted. E.g. Add, Multiply, etc.
   • HW_Flag_ExplicitMaskedOperation : These APIs take "mask" explicitly as the first argument. E.g. ConditionalSelect
   • HW_Flag_Scalable : All APIs have this flag to identify that they operate on scalable vector length.
   • Any other restrictions on the register number.

   For any special case where there is no flag, you have options:

   1. Add a new flag. Add code in hwintrinsics to use the flag. There is limited space for new flags, so only do this where there are many instructions that would require it.
   2. If changes need making in codegen, then mark as HW_Flag_SpecialCodeGen and add a new case to CodeGen::genHWIntrinsic().
   3. If changes need making at the import stage then mark as HW_Category_Special and add a new case to Compiler::impSpecialIntrinsic()
   4. Mark as both HW_Flag_SpecialCodeGen and HW_Category_Special

   Testing

   • src/tests/Common/GenerateHWIntrinsicTests/GenerateHWIntrinsicTests_Arm.cs

   Copy/paste from https://raw.githubusercontent.com/a74nh/runtime/api_github/sve_api/out_GenerateHWIntrinsicTests_Arm.cs
   Rename the template (first column) to a more generic template. We want as few new templates as possible. Existing AdvSimd templates can be copied and then edited to include extra Sve parts.
   The ValidateIterResult and NextValueOpN entires will need editing to fit the template.
   Use existing entires as a guide.

   Linux

   Tests can be build using:

   rm -fr ./artifacts/tests/coreclr/obj/linux.arm64.Checked/Managed/JIT/HardwareIntrinsics/Arm/Sve/
   ./src/tests/build.sh checked -test:JIT/HardwareIntrinsics/HardwareIntrinsics_Arm_ro.csproj
   

   Tests can then be run:

   ./artifacts/tests/coreclr/linux.arm64.Checked/JIT/HardwareIntrinsics/HardwareIntrinsics_Arm_ro/HardwareIntrinsics_Arm_ro.sh
   

   Generated C# files are in artifacts/tests/coreclr/obj/linux.arm64.Checked/Managed/JIT/HardwareIntrinsics/Arm/Sve/Sve_ro/Sve_ro/gen/

   There are a lot of tests that will be run. To make life easier run the .dll directly and pass it the name of the test (a substring will do). Eg:

   $CORE_ROOT/corerun ./artifacts/tests/coreclr/linux.arm64.Checked/JIT/HardwareIntrinsics/HardwareIntrinsics_Arm_ro/HardwareIntrinsics_Arm_ro.dll Sve_Add_uint
   $CORE_ROOT/corerun ./artifacts/tests/coreclr/linux.arm64.Checked/JIT/HardwareIntrinsics/HardwareIntrinsics_Arm_ro/HardwareIntrinsics_Arm_ro.dll Sve
   

   Windows

   Tests can be build using:

   del /F /S /Q repo\artifacts\tests\coreclr\obj\windows.arm64.Release\Managed\JIT\HardwareIntrinsics\Arm\Sve\
   pushd repo\src\tests\
   build.cmd Release -test JIT\HardwareIntrinsics\HardwareIntrinsics_Arm_r.csproj /p:TargetArchitecture=arm64
   build.cmd Release -test JIT\HardwareIntrinsics\HardwareIntrinsics_Arm_ro.csproj /p:TargetArchitecture=arm64
   

   Tests can then be run:

   pushd repo\artifacts\tests\coreclr\windows.arm64.Release\JIT\HardwareIntrinsics\HardwareIntrinsics_Arm_r
   HardwareIntrinsics_Arm_r.cmd
   

   Generated C# files are in artifacts\tests\coreclr\obj\windows.arm64.Release\Managed\JIT\HardwareIntrinsics\Arm\Sve\Sve_ro\Sve_ro\gen\

   There are a lot of tests that will be run. To make life easier run the .dll directly and pass it the name of the test (a substring will do). Eg:

   $CORE_ROOT\corerun .\artifacts\tests\coreclr\windows.arm64.Release\JIT\HardwareIntrinsics\HardwareIntrinsics_Arm_ro\HardwareIntrinsics_Arm_ro.dll Sve_Add_uint
   $CORE_ROOT\corerun .\artifacts\tests\coreclr\windows.arm64.Release\JIT\HardwareIntrinsics\HardwareIntrinsics_Arm_ro\HardwareIntrinsics_Arm_ro.dll Sve
   

   Altjit

   All the testing works as usual using AltJit* environment variables. Only thing to remember is to set additional environment variable DOTNET_MaxVectorTBitWidth=128 to avoid getting asserts assert(size == info.compCompHnd->getClassSize(typeHnd));

   Stress testing

   All the tests should be run using all the various stress modes.
   https://github.com/a74nh/runtime/blob/api_github/sve_api/stress_tester.py is used to run your test in the various modes. Pass it the full command line for running your test. Eg:

   stress_tester.py $CORE_ROOT/corerun ./artifacts/tests/coreclr/linux.arm64.Checked/JIT/HardwareIntrinsics/HardwareIntrinsics_Arm_ro/HardwareIntrinsics_Arm_ro.dll Sve_Add_uint
   
   

   Writing Tests

   • Once the .cs files have been created, you can edit then manually and rebuild. Copy the changes back to the template once the test works. This can save time fiddling with template params.
   • Where possible, we want to avoid calling other API calls within a test. This stops dependencies building up in the tests. For bonus points, write your test functions once without additional API calls and once with.
   • When an API call uses a mask (either input or return) the type of that mask is a vector<T>, this means you can treat it like a normal vector and itterate through it, set values etc. A mask should only contain the values 0 or 1. Within the jit it will be converted to/from a vector of boolean value so that they can be placed in the SVE predicate registers (p0 to p15).
4. a74nh commented on Mar 19, 2024

   

   a74nh

   on Mar 19, 2024

   Contributor

   More actions

   For choosing APIs.

   • For now, only pick APIs that do not have an embedded mask (ie: Those where the Arm instruction takes in a Predicate register as arg2, but does not expose the mask at the API level. For example most of the Sve Maths methods).
     • Support for embedded masks is ongoing.
     • the helper API files indicate which methods have embedded masks with the label "Embedded arg1 mask predicate". Alternatively, see the flag HW_Flag_EmbeddedMaskedOperation in out_hwintrinsiclistarm64sve.h
   • Sve is highest priority, then Sve2, then all of the smaller extensions.
     • I recommend starting with the loads and stores
5. kunalspathak

   added

   area-CodeGen-coreclrCLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMICLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI

   User StoryA single user-facing feature. Can be grouped under an epic.A single user-facing feature. Can be grouped under an epic.

   on Mar 19, 2024
6. vcsjones

   removed

   needs-area-labelAn area label is needed to ensure this gets routed to the appropriate area ownersAn area label is needed to ensure this gets routed to the appropriate area owners

   on Mar 20, 2024
7. JulieLeeMSFT

   removed

   User StoryA single user-facing feature. Can be grouped under an epic.A single user-facing feature. Can be grouped under an epic.

   on Mar 22, 2024
8. JulieLeeMSFT

   added this to the 9.0.0 milestone on Mar 22, 2024
9. JulieLeeMSFT

   assigned

   kunalspathak

   on Mar 22, 2024
10. dotnet-policy-service

    removed

    untriagedNew issue has not been triaged by the area ownerNew issue has not been triaged by the area owner

    on Mar 22, 2024
11. a74nh commented on Mar 25, 2024

    

    a74nh

    on Mar 25, 2024

    Contributor

    More actions

    As the testing grows it will increasingly become difficult to test just a single API. this is ok during CI, but painful during development and bug fixing.

    I recommend someone writes a patch so that a testname can be passed in as an argument so that only that test will run. Eg:
    HardwareIntrinsics_Arm_ro.sh Sve.Add.uint
12. kunalspathak commented on Mar 25, 2024

    

    kunalspathak

    on Mar 25, 2024

    ContributorAuthor

    More actions

    I recommend someone writes a patch so that a testname can be passed in as an argument so that only that test will run. Eg: HardwareIntrinsics_Arm_ro.sh Sve.Add.uint

    I agree. I have asked @TIHan to come up with a design for this. @TIHan - any update on this?
13. TIHan commented on Mar 25, 2024

    

    TIHan

    on Mar 25, 2024

    Contributor

    More actions

    I have not looked at this yet, but can this week.
14. tannergooding commented on Mar 25, 2024

    

    tannergooding

    on Mar 25, 2024

    Member

    More actions

    Just noting such support should already exist if you invoke the underlying dll directly, this may just be something missing from the .sh file.

    The exact argument that matches a filter may be a bit different due to it now using the underlying xunit filtering mechanic, but it should largely just work.

    ---

    https://github.com/dotnet/runtime/blob/main/docs/workflow/testing/coreclr/testing.md#running-individual-tests

    You can then see some of the logic that gets setup via https://github.com/dotnet/runtime/blob/main/src/tests/Common/XUnitWrapperGenerator/XUnitWrapperGenerator.cs and the corresponding logic of how the test filtering works here: https://github.com/dotnet/runtime/blob/main/src/tests/Common/XUnitWrapperLibrary/TestFilter.cs

    The actual filter is constructed like:

    System.Collections.Generic.Dictionary<string, string> testExclusionTable = XUnitWrapperLibrary.TestFilter.LoadTestExclusionTable();
    XUnitWrapperLibrary.TestFilter filter = new (args, testExclusionTable);

    A given TestExecutor then uses it like:

    void TestExecutor1(System.IO.StreamWriter tempLogSw, System.IO.StreamWriter statsCsvSw)
    {
        if (filter is null || filter.ShouldRunTest(@"JIT.HardwareIntrinsics.Arm._AdvSimd.Program.AddDouble", "_AdvSimd_r::JIT.HardwareIntrinsics.Arm._AdvSimd.Program.AddDouble()"))
        {
            System.TimeSpan testStart = stopwatch.Elapsed;
            try
            {
                summary.ReportStartingTest("_AdvSimd_r::JIT.HardwareIntrinsics.Arm._AdvSimd.Program.AddDouble()", System.Console.Out);
                outputRecorder.ResetTestOutput();
                _AdvSimd_r::JIT.HardwareIntrinsics.Arm._AdvSimd.Program.AddDouble();
                summary.ReportPassedTest("_AdvSimd_r::JIT.HardwareIntrinsics.Arm._AdvSimd.Program.AddDouble()", "JIT.HardwareIntrinsics.Arm._AdvSimd.Program", @"AddDouble", stopwatch.Elapsed - testStart, outputRecorder.GetTestOutput(), System.Console.Out, tempLogSw, statsCsvSw);
            }
            catch (System.Exception ex)
            {
                summary.ReportFailedTest("_AdvSimd_r::JIT.HardwareIntrinsics.Arm._AdvSimd.Program.AddDouble()", "JIT.HardwareIntrinsics.Arm._AdvSimd.Program", @"AddDouble", stopwatch.Elapsed - testStart, ex, outputRecorder.GetTestOutput(), System.Console.Out, tempLogSw, statsCsvSw);
            }
        }
        else
        {
            string reason = filter.GetTestExclusionReason("_AdvSimd_r::JIT.HardwareIntrinsics.Arm._AdvSimd.Program.AddDouble()");
            summary.ReportSkippedTest("_AdvSimd_r::JIT.HardwareIntrinsics.Arm._AdvSimd.Program.AddDouble()", "JIT.HardwareIntrinsics.Arm._AdvSimd.Program", @"AddDouble", System.TimeSpan.Zero, reason, tempLogSw, statsCsvSw);
        }
    }

    where ShouldRunTest basically just does a stringToSearch.Contains(filter) check at the most basic level
15. kunalspathak commented on Mar 25, 2024

    

    kunalspathak

    on Mar 25, 2024

    ContributorAuthor

    More actions

    Just noting such support should already exist if you invoke the underlying dll directly, this may just be something missing from the .sh file.

    If that's the case, can you or @TIHan can come up with the exact command line that is needed to run a particular case. I don't want engineer to hack around a test to make it working for every API.
16. a74nh commented on Mar 25, 2024

    

    a74nh

    on Mar 25, 2024

    Contributor

    More actions

    It appears to work:

    ❯ $CORE_ROOT/corerun ./artifacts/tests/coreclr/linux.arm64.Checked/JIT/HardwareIntrinsics/HardwareIntrinsics_Arm_ro/HardwareIntrinsics_Arm_ro.dll Sve_Add_uint
    16:34:55.071 Running test: _Sve_ro::JIT.HardwareIntrinsics.Arm._Sve.Program.Sve_Add_uint()
    Supported ISAs:
      AdvSimd:   True
      Aes:       True
      ArmBase:   True
      Crc32:     True
      Dp:        True
      Rdm:       True
      Sha1:      True
      Sha256:    True
      Sve:       True
    
    Beginning scenario: RunBasicScenario_UnsafeRead
    Beginning scenario: RunBasicScenario_Load
    Beginning scenario: RunReflectionScenario_UnsafeRead
    Beginning scenario: RunLclVarScenario_UnsafeRead
    Beginning scenario: RunClassFldScenario
    Beginning scenario: RunStructLclFldScenario
    Beginning scenario: RunStructFldScenario
    16:34:55.177 Passed test: _Sve_ro::JIT.HardwareIntrinsics.Arm._Sve.Program.Sve_Add_uint()
    

    I'm happy with this as a solution then!

    🎉React with 🎉1Reacted by Kunal Pathak
17. a74nh commented on Apr 24, 2024

    

    a74nh

    on Apr 24, 2024

    Contributor

    More actions

    Updated the implementation instructions with stress testing and how to write the tests.

    ❤️React with ❤️1Reacted by Kunal Pathak
18. kunalspathak commented on Apr 25, 2024

    

    kunalspathak

    on Apr 25, 2024

    ContributorAuthor

    More actions

    Updated the implementation instructions with stress testing and how to write the tests.

    Updated for Windows.
19. kunalspathak commented on May 10, 2024

    

    kunalspathak

    on May 10, 2024

    ContributorAuthor

    More actions

    Updated #99957 (comment) with meanings of various HWIntrinsicFlag values used in the table and their meaning.
20. kunalspathak

    added

    arm-sveWork related to arm64 SVE/SVE2 supportWork related to arm64 SVE/SVE2 support

    on May 30, 2024
21. JulieLeeMSFT

    added this to .NET Core CodeGenon Jun 5, 2024
22. JulieLeeMSFT

    moved this to Team User Stories in .NET Core CodeGenon Jun 5, 2024
23. JulieLeeMSFT commented on Aug 14, 2024

    

    JulieLeeMSFT

    on Aug 14, 2024

    Member

    More actions

    Closing this as completed. Will open a new issue for items that will be included in .NET 10.
24. JulieLeeMSFT

    closed this as completedon Aug 14, 2024
25. github-project-automation

    moved this from Team User Stories to Done in .NET Core CodeGenon Aug 14, 2024
26. github-actions

    locked and limited conversation to collaborators on Sep 14, 2024