[API Proposal]: Arm64: FEAT_SVE_AES

[a74nh]

FEAT_SVE_AES provides SVE versions of the Cryptographic Extension instructions provided by FEAT_AES.

APIs already exist for FEAT_AES - see Aes.cs. The SVE instructions match in functionality.

namespace System.Runtime.Intrinsics.Arm

/// VectorT Summary
public abstract class SveAes : AdvSimd /// Feature: FEAT_SVE_AES
{

  public static unsafe Vector<byte> InverseMixColumns(Vector<byte> value); // AESIMC

  public static unsafe Vector<byte> MixColumns(Vector<byte> value); // AESMC

  public static unsafe Vector<byte> Decrypt(Vector<byte> left, Vector<byte> right); // AESD

  public static unsafe Vector<byte> Encrypt(Vector<byte> left, Vector<byte> right); // AESE

  public static unsafe Vector<ulong> PolynomialMultiplyWideningLower(Vector<ulong> left, Vector<ulong> right); // PMULLB

  public static unsafe Vector<ulong> PolynomialMultiplyWideningUpper(Vector<ulong> left, Vector<ulong> right); // PMULLT
}
  /// total method signatures: 6

  /// Optional Entries:
public abstract class SveAes : AdvSimd /// Feature: FEAT_SVE_AES
{
  public static unsafe Vector<ulong> PolynomialMultiplyWideningLower(Vector<ulong> left, ulong right); // PMULLB

  public static unsafe Vector<ulong> PolynomialMultiplyWideningUpper(Vector<ulong> left, ulong right); // PMULLT

  /// total optional method signatures: 2

}

/// Full API
public abstract class SveAes : AdvSimd /// Feature: FEAT_SVE_AES
{
    /// AesInverseMixColumns : AES inverse mix columns

    /// svuint8_t svaesimc[_u8](svuint8_t op) : "AESIMC Ztied.B, Ztied.B"
  public static unsafe Vector<byte> InverseMixColumns(Vector<byte> value);


    /// AesMixColumns : AES mix columns

    /// svuint8_t svaesmc[_u8](svuint8_t op) : "AESMC Ztied.B, Ztied.B"
  public static unsafe Vector<byte> MixColumns(Vector<byte> value);


    /// AesSingleRoundDecryption : AES single round decryption

    /// svuint8_t svaesd[_u8](svuint8_t op1, svuint8_t op2) : "AESD Ztied1.B, Ztied1.B, Zop2.B" or "AESD Ztied2.B, Ztied2.B, Zop1.B"
  public static unsafe Vector<byte> Decrypt(Vector<byte> left, Vector<byte> right);


    /// AesSingleRoundEncryption : AES single round encryption

    /// svuint8_t svaese[_u8](svuint8_t op1, svuint8_t op2) : "AESE Ztied1.B, Ztied1.B, Zop2.B" or "AESE Ztied2.B, Ztied2.B, Zop1.B"
  public static unsafe Vector<byte> Encrypt(Vector<byte> left, Vector<byte> right);


    /// PolynomialMultiplyWideningLower : Polynomial multiply long (bottom)

    /// svuint64_t svpmullb_pair[_u64](svuint64_t op1, svuint64_t op2) : "PMULLB Zresult.Q, Zop1.D, Zop2.D"
  public static unsafe Vector<ulong> PolynomialMultiplyWideningLower(Vector<ulong> left, Vector<ulong> right);


    /// PolynomialMultiplyWideningUpper : Polynomial multiply long (top)

    /// svuint64_t svpmullt_pair[_u64](svuint64_t op1, svuint64_t op2) : "PMULLT Zresult.Q, Zop1.D, Zop2.D"
  public static unsafe Vector<ulong> PolynomialMultiplyWideningUpper(Vector<ulong> left, Vector<ulong> right);


  /// total method signatures: 6
  /// total method names:      6
}

  /// Optional Entries:
  ///   public static unsafe Vector<ulong> PolynomialMultiplyWideningLower(Vector<ulong> left, ulong right); // svpmullb_pair[_n_u64]
  ///   public static unsafe Vector<ulong> PolynomialMultiplyWideningUpper(Vector<ulong> left, ulong right); // svpmullt_pair[_n_u64]
  ///   Total Maybe: 2

  /// Total ACLE covered across API:      8

Tagging subscribers to this area: @dotnet/area-system-runtime-intrinsics
See info in area-owners.md if you want to be subscribed.

Issue Details

---

namespace System.Runtime.Intrinsics.Arm

/// VectorT Summary
public abstract class SveAes : AdvSimd /// Feature: FEAT_SVE_AES
{

  public static unsafe Vector<byte> AesInverseMixColumns(Vector<byte> value); // AESIMC

  public static unsafe Vector<byte> AesMixColumns(Vector<byte> value); // AESMC

  public static unsafe Vector<byte> AesSingleRoundDecryption(Vector<byte> left, Vector<byte> right); // AESD

  public static unsafe Vector<byte> AesSingleRoundEncryption(Vector<byte> left, Vector<byte> right); // AESE

  public static unsafe Vector<ulong> PolynomialMultiplyWideningLower(Vector<ulong> left, Vector<ulong> right); // PMULLB

  public static unsafe Vector<ulong> PolynomialMultiplyWideningUpper(Vector<ulong> left, Vector<ulong> right); // PMULLT

  /// total method signatures: 6


  /// Optional Entries:

  public static unsafe Vector<ulong> PolynomialMultiplyWideningLower(Vector<ulong> left, ulong right); // PMULLB

  public static unsafe Vector<ulong> PolynomialMultiplyWideningUpper(Vector<ulong> left, ulong right); // PMULLT

  /// total optional method signatures: 2

}


/// Full API
public abstract class SveAes : AdvSimd /// Feature: FEAT_SVE_AES
{
    /// AesInverseMixColumns : AES inverse mix columns

    /// svuint8_t svaesimc[_u8](svuint8_t op) : "AESIMC Ztied.B, Ztied.B"
  public static unsafe Vector<byte> AesInverseMixColumns(Vector<byte> value);


    /// AesMixColumns : AES mix columns

    /// svuint8_t svaesmc[_u8](svuint8_t op) : "AESMC Ztied.B, Ztied.B"
  public static unsafe Vector<byte> AesMixColumns(Vector<byte> value);


    /// AesSingleRoundDecryption : AES single round decryption

    /// svuint8_t svaesd[_u8](svuint8_t op1, svuint8_t op2) : "AESD Ztied1.B, Ztied1.B, Zop2.B" or "AESD Ztied2.B, Ztied2.B, Zop1.B"
  public static unsafe Vector<byte> AesSingleRoundDecryption(Vector<byte> left, Vector<byte> right);


    /// AesSingleRoundEncryption : AES single round encryption

    /// svuint8_t svaese[_u8](svuint8_t op1, svuint8_t op2) : "AESE Ztied1.B, Ztied1.B, Zop2.B" or "AESE Ztied2.B, Ztied2.B, Zop1.B"
  public static unsafe Vector<byte> AesSingleRoundEncryption(Vector<byte> left, Vector<byte> right);


    /// PolynomialMultiplyWideningLower : Polynomial multiply long (bottom)

    /// svuint64_t svpmullb_pair[_u64](svuint64_t op1, svuint64_t op2) : "PMULLB Zresult.Q, Zop1.D, Zop2.D"
  public static unsafe Vector<ulong> PolynomialMultiplyWideningLower(Vector<ulong> left, Vector<ulong> right);


    /// PolynomialMultiplyWideningUpper : Polynomial multiply long (top)

    /// svuint64_t svpmullt_pair[_u64](svuint64_t op1, svuint64_t op2) : "PMULLT Zresult.Q, Zop1.D, Zop2.D"
  public static unsafe Vector<ulong> PolynomialMultiplyWideningUpper(Vector<ulong> left, Vector<ulong> right);


  /// total method signatures: 6
  /// total method names:      6
}

  /// Optional Entries:
  ///   public static unsafe Vector<ulong> PolynomialMultiplyWideningLower(Vector<ulong> left, ulong right); // svpmullb_pair[_n_u64]
  ///   public static unsafe Vector<ulong> PolynomialMultiplyWideningUpper(Vector<ulong> left, ulong right); // svpmullt_pair[_n_u64]
  ///   Total Maybe: 2

  /// Total ACLE covered across API:      8

Author:	a74nh
Assignees:	-
Labels:	area-System.Runtime.Intrinsics
Milestone:	-

[a74nh]

This contributes to #93095

It covers all of the instructions in FEAT_SVE_AES.
This list was auto generated from the C ACLE for SVE, and is in three parts:

The methods list reduced down to Vector versions. All possible varaints of T are given above the method.
The complete list of all methods. The corresponding ACLE methods and SVE instructions are given above the method.
All rejected ACLE methods. These are methods we have agreed that do not need including in C#.
Where possible, existing C# naming conventions have been matched.

Many of the C functions include predicate argument(s), of type svbool_t as the first argument. These are missing from the C# method. It is expected that the Jit will create predicates where required, or combine with uses of conditionalSelect(). For more discussion see #88140 comment.