Rename "armcrypto" implementations to "neon_aes" (#20)

The Arm 64-bit architecture contains a number of architecture extensions
relevant to the AEGIS family of algorithms, however currently libaegis
only checks and exposes FEAT_AES. In particular:

* FEAT_SHA3 contains the Neon EOR3 and BCAX instructions which can be
  useful for e.g. combining pairs of exclusive-or instructions.

* FEAT_SVE_AES provides SVE versions of the existing AESE and AESMC
  instructions. These can be beneficial on micro-architectures with
  longer vectors.

* FEAT_SVE2 provides SVE2 versions of the EOR3 and BCAX instructions,
  mirroring the Neon versions but for SVE vectors.

As a first step towards supporting these new extensions, rename the
existing code to disambiguate away from "armcrypto" and instead refer to
the exact "neon_aes" extension that the code depends on.

Author: georges-arm

build.zig

@@ -31,44 +31,44 @@ pub fn build(b: *std.Build) void {
     const source_files = &.{
         "src/aegis128l/aegis128l_aesni.c",
         "src/aegis128l/aegis128l_altivec.c",
-        "src/aegis128l/aegis128l_armcrypto.c",
+        "src/aegis128l/aegis128l_neon_aes.c",
         "src/aegis128l/aegis128l_soft.c",
         "src/aegis128l/aegis128l.c",
 
         "src/aegis128x2/aegis128x2_aesni.c",
         "src/aegis128x2/aegis128x2_altivec.c",
         "src/aegis128x2/aegis128x2_avx2.c",
-        "src/aegis128x2/aegis128x2_armcrypto.c",
+        "src/aegis128x2/aegis128x2_neon_aes.c",
         "src/aegis128x2/aegis128x2_soft.c",
         "src/aegis128x2/aegis128x2.c",
 
         "src/aegis128x4/aegis128x4_aesni.c",
         "src/aegis128x4/aegis128x4_altivec.c",
         "src/aegis128x4/aegis128x4_avx2.c",
         "src/aegis128x4/aegis128x4_avx512.c",
-        "src/aegis128x4/aegis128x4_armcrypto.c",
-        "src/aegis128x4/aegis128x4_armcrypto.c",
+        "src/aegis128x4/aegis128x4_neon_aes.c",
+        "src/aegis128x4/aegis128x4_neon_aes.c",
         "src/aegis128x4/aegis128x4_soft.c",
         "src/aegis128x4/aegis128x4.c",
 
         "src/aegis256/aegis256_aesni.c",
         "src/aegis256/aegis256_altivec.c",
-        "src/aegis256/aegis256_armcrypto.c",
+        "src/aegis256/aegis256_neon_aes.c",
         "src/aegis256/aegis256_soft.c",
         "src/aegis256/aegis256.c",
 
         "src/aegis256x2/aegis256x2_aesni.c",
         "src/aegis256x2/aegis256x2_altivec.c",
         "src/aegis256x2/aegis256x2_avx2.c",
-        "src/aegis256x2/aegis256x2_armcrypto.c",
+        "src/aegis256x2/aegis256x2_neon_aes.c",
         "src/aegis256x2/aegis256x2_soft.c",
         "src/aegis256x2/aegis256x2.c",
 
         "src/aegis256x4/aegis256x4_aesni.c",
         "src/aegis256x4/aegis256x4_altivec.c",
         "src/aegis256x4/aegis256x4_avx2.c",
         "src/aegis256x4/aegis256x4_avx512.c",
-        "src/aegis256x4/aegis256x4_armcrypto.c",
+        "src/aegis256x4/aegis256x4_neon_aes.c",
         "src/aegis256x4/aegis256x4_soft.c",
         "src/aegis256x4/aegis256x4.c",
 

src/aegis128l/aegis128l.c

@@ -6,14 +6,14 @@
 #include "aegis128l.h"
 #include "aegis128l_aesni.h"
 #include "aegis128l_altivec.h"
-#include "aegis128l_armcrypto.h"
+#include "aegis128l_neon_aes.h"
 
 #ifndef HAS_HW_AES
 #    include "aegis128l_soft.h"
 static const aegis128l_implementation *implementation = &aegis128l_soft_implementation;
 #else
 #    if defined(__aarch64__) || defined(_M_ARM64)
-static const aegis128l_implementation *implementation = &aegis128l_armcrypto_implementation;
+static const aegis128l_implementation *implementation = &aegis128l_neon_aes_implementation;
 #    elif defined(__x86_64__) || defined(__i386__)
 static const aegis128l_implementation *implementation = &aegis128l_aesni_implementation;
 #    elif defined(__ALTIVEC__) && defined(__CRYPTO__)
@@ -232,8 +232,8 @@ aegis128l_pick_best_implementation(void)
 #endif
 
 #if defined(__aarch64__) || defined(_M_ARM64)
-    if (aegis_runtime_has_armcrypto()) {
-        implementation = &aegis128l_armcrypto_implementation;
+    if (aegis_runtime_has_neon_aes()) {
+        implementation = &aegis128l_neon_aes_implementation;
         return 0;
     }
 #endif

src/aegis128l/aegis128l_armcrypto.h

@@ -5,7 +5,7 @@
 
 #    include "../common/common.h"
 #    include "aegis128l.h"
-#    include "aegis128l_armcrypto.h"
+#    include "aegis128l_neon_aes.h"
 
 #    ifndef __ARM_FEATURE_CRYPTO
 #        define __ARM_FEATURE_CRYPTO 1
@@ -52,7 +52,7 @@ aegis128l_update(aes_block_t *const state, const aes_block_t d1, const aes_block
 
 #    include "aegis128l_common.h"
 
-struct aegis128l_implementation aegis128l_armcrypto_implementation = {
+struct aegis128l_implementation aegis128l_neon_aes_implementation = {
     .encrypt_detached              = encrypt_detached,
     .decrypt_detached              = decrypt_detached,
     .encrypt_unauthenticated       = encrypt_unauthenticated,

src/aegis128l/aegis128l_armcrypto.c renamed to src/aegis128l/aegis128l_neon_aes.c

@@ -0,0 +1,9 @@
+#ifndef aegis128l_neon_aes_H
+#define aegis128l_neon_aes_H
+
+#include "../common/common.h"
+#include "implementations.h"
+
+extern struct aegis128l_implementation aegis128l_neon_aes_implementation;
+
+#endif

src/aegis128l/aegis128l_neon_aes.h

@@ -6,15 +6,15 @@
 #include "aegis128x2.h"
 #include "aegis128x2_aesni.h"
 #include "aegis128x2_altivec.h"
-#include "aegis128x2_armcrypto.h"
+#include "aegis128x2_neon_aes.h"
 #include "aegis128x2_avx2.h"
 
 #ifndef HAS_HW_AES
 #    include "aegis128x2_soft.h"
 static const aegis128x2_implementation *implementation = &aegis128x2_soft_implementation;
 #else
 #    if defined(__aarch64__) || defined(_M_ARM64)
-static const aegis128x2_implementation *implementation = &aegis128x2_armcrypto_implementation;
+static const aegis128x2_implementation *implementation = &aegis128x2_neon_aes_implementation;
 #    elif defined(__x86_64__) || defined(__i386__)
 static const aegis128x2_implementation *implementation = &aegis128x2_aesni_implementation;
 #    elif defined(__ALTIVEC__) && defined(__CRYPTO__)
@@ -232,8 +232,8 @@ aegis128x2_pick_best_implementation(void)
 #endif
 
 #if defined(__aarch64__) || defined(_M_ARM64)
-    if (aegis_runtime_has_armcrypto()) {
-        implementation = &aegis128x2_armcrypto_implementation;
+    if (aegis_runtime_has_neon_aes()) {
+        implementation = &aegis128x2_neon_aes_implementation;
         return 0;
     }
 #endif

src/aegis128x2/aegis128x2.c

@@ -5,7 +5,7 @@
 
 #    include "../common/common.h"
 #    include "aegis128x2.h"
-#    include "aegis128x2_armcrypto.h"
+#    include "aegis128x2_neon_aes.h"
 
 #    ifndef __ARM_FEATURE_CRYPTO
 #        define __ARM_FEATURE_CRYPTO 1
@@ -86,7 +86,7 @@ aegis128x2_update(aes_block_t *const state, const aes_block_t d1, const aes_bloc
 
 #    include "aegis128x2_common.h"
 
-struct aegis128x2_implementation aegis128x2_armcrypto_implementation = {
+struct aegis128x2_implementation aegis128x2_neon_aes_implementation = {
     .encrypt_detached              = encrypt_detached,
     .decrypt_detached              = decrypt_detached,
     .encrypt_unauthenticated       = encrypt_unauthenticated,

src/aegis128x2/aegis128x2_armcrypto.h

@@ -0,0 +1,9 @@
+#ifndef aegis128x2_neon_aes_H
+#define aegis128x2_neon_aes_H
+
+#include "../common/common.h"
+#include "implementations.h"
+
+extern struct aegis128x2_implementation aegis128x2_neon_aes_implementation;
+
+#endif

src/aegis128x2/aegis128x2_armcrypto.c renamed to src/aegis128x2/aegis128x2_neon_aes.c

@@ -6,7 +6,7 @@
 #include "aegis128x4.h"
 #include "aegis128x4_aesni.h"
 #include "aegis128x4_altivec.h"
-#include "aegis128x4_armcrypto.h"
+#include "aegis128x4_neon_aes.h"
 #include "aegis128x4_avx2.h"
 #include "aegis128x4_avx512.h"
 
@@ -15,7 +15,7 @@
 static const aegis128x4_implementation *implementation = &aegis128x4_soft_implementation;
 #else
 #    if defined(__aarch64__) || defined(_M_ARM64)
-static const aegis128x4_implementation *implementation = &aegis128x4_armcrypto_implementation;
+static const aegis128x4_implementation *implementation = &aegis128x4_neon_aes_implementation;
 #    elif defined(__x86_64__) || defined(__i386__)
 static const aegis128x4_implementation *implementation = &aegis128x4_aesni_implementation;
 #    elif defined(__ALTIVEC__) && defined(__CRYPTO__)
@@ -233,8 +233,8 @@ aegis128x4_pick_best_implementation(void)
 #endif
 
 #if defined(__aarch64__) || defined(_M_ARM64)
-    if (aegis_runtime_has_armcrypto()) {
-        implementation = &aegis128x4_armcrypto_implementation;
+    if (aegis_runtime_has_neon_aes()) {
+        implementation = &aegis128x4_neon_aes_implementation;
         return 0;
     }
 #endif

src/aegis128x2/aegis128x2_neon_aes.h

@@ -5,7 +5,7 @@
 
 #    include "../common/common.h"
 #    include "aegis128x4.h"
-#    include "aegis128x4_armcrypto.h"
+#    include "aegis128x4_neon_aes.h"
 
 #    ifndef __ARM_FEATURE_CRYPTO
 #        define __ARM_FEATURE_CRYPTO 1
@@ -94,7 +94,7 @@ aegis128x4_update(aes_block_t *const state, const aes_block_t d1, const aes_bloc
 
 #    include "aegis128x4_common.h"
 
-struct aegis128x4_implementation aegis128x4_armcrypto_implementation = {
+struct aegis128x4_implementation aegis128x4_neon_aes_implementation = {
     .encrypt_detached              = encrypt_detached,
     .decrypt_detached              = decrypt_detached,
     .encrypt_unauthenticated       = encrypt_unauthenticated,

src/aegis128x4/aegis128x4.c

@@ -0,0 +1,9 @@
+#ifndef aegis128x4_neon_aes_H
+#define aegis128x4_neon_aes_H
+
+#include "../common/common.h"
+#include "implementations.h"
+
+extern struct aegis128x4_implementation aegis128x4_neon_aes_implementation;
+
+#endif

src/aegis128x4/aegis128x4_armcrypto.h

@@ -6,14 +6,14 @@
 #include "aegis256.h"
 #include "aegis256_aesni.h"
 #include "aegis256_altivec.h"
-#include "aegis256_armcrypto.h"
+#include "aegis256_neon_aes.h"
 
 #ifndef HAS_HW_AES
 #    include "aegis256_soft.h"
 static const aegis256_implementation *implementation = &aegis256_soft_implementation;
 #else
 #    if defined(__aarch64__) || defined(_M_ARM64)
-static const aegis256_implementation *implementation = &aegis256_armcrypto_implementation;
+static const aegis256_implementation *implementation = &aegis256_neon_aes_implementation;
 #    elif defined(__x86_64__) || defined(__i386__)
 static const aegis256_implementation *implementation = &aegis256_aesni_implementation;
 #    elif defined(__ALTIVEC__) && defined(__CRYPTO__)
@@ -231,8 +231,8 @@ aegis256_pick_best_implementation(void)
 #endif
 
 #if defined(__aarch64__) || defined(_M_ARM64)
-    if (aegis_runtime_has_armcrypto()) {
-        implementation = &aegis256_armcrypto_implementation;
+    if (aegis_runtime_has_neon_aes()) {
+        implementation = &aegis256_neon_aes_implementation;
         return 0;
     }
 #endif

src/aegis128x4/aegis128x4_armcrypto.c renamed to src/aegis128x4/aegis128x4_neon_aes.c

@@ -5,7 +5,7 @@
 
 #    include "../common/common.h"
 #    include "aegis256.h"
-#    include "aegis256_armcrypto.h"
+#    include "aegis256_neon_aes.h"
 
 #    ifndef __ARM_FEATURE_CRYPTO
 #        define __ARM_FEATURE_CRYPTO 1
@@ -50,7 +50,7 @@ aegis256_update(aes_block_t *const state, const aes_block_t d)
 
 #    include "aegis256_common.h"
 
-struct aegis256_implementation aegis256_armcrypto_implementation = {
+struct aegis256_implementation aegis256_neon_aes_implementation = {
     .encrypt_detached              = encrypt_detached,
     .decrypt_detached              = decrypt_detached,
     .encrypt_unauthenticated       = encrypt_unauthenticated,

src/aegis128x4/aegis128x4_neon_aes.h

@@ -0,0 +1,9 @@
+#ifndef aegis256_neon_aes_H
+#define aegis256_neon_aes_H
+
+#include "../common/common.h"
+#include "implementations.h"
+
+extern struct aegis256_implementation aegis256_neon_aes_implementation;
+
+#endif

src/aegis256/aegis256.c

@@ -6,15 +6,15 @@
 #include "aegis256x2.h"
 #include "aegis256x2_aesni.h"
 #include "aegis256x2_altivec.h"
-#include "aegis256x2_armcrypto.h"
+#include "aegis256x2_neon_aes.h"
 #include "aegis256x2_avx2.h"
 
 #ifndef HAS_HW_AES
 #    include "aegis256x2_soft.h"
 static const aegis256x2_implementation *implementation = &aegis256x2_soft_implementation;
 #else
 #    if defined(__aarch64__) || defined(_M_ARM64)
-static const aegis256x2_implementation *implementation = &aegis256x2_armcrypto_implementation;
+static const aegis256x2_implementation *implementation = &aegis256x2_neon_aes_implementation;
 #    elif defined(__x86_64__) || defined(__i386__)
 static const aegis256x2_implementation *implementation = &aegis256x2_aesni_implementation;
 #    elif defined(__ALTIVEC__) && defined(__CRYPTO__)
@@ -232,8 +232,8 @@ aegis256x2_pick_best_implementation(void)
 #endif
 
 #if defined(__aarch64__) || defined(_M_ARM64)
-    if (aegis_runtime_has_armcrypto()) {
-        implementation = &aegis256x2_armcrypto_implementation;
+    if (aegis_runtime_has_neon_aes()) {
+        implementation = &aegis256x2_neon_aes_implementation;
         return 0;
     }
 #endif

src/aegis256/aegis256_armcrypto.h

@@ -5,7 +5,7 @@
 
 #    include "../common/common.h"
 #    include "aegis256x2.h"
-#    include "aegis256x2_armcrypto.h"
+#    include "aegis256x2_neon_aes.h"
 
 #    ifndef __ARM_FEATURE_CRYPTO
 #        define __ARM_FEATURE_CRYPTO 1
@@ -84,7 +84,7 @@ aegis256x2_update(aes_block_t *const state, const aes_block_t d)
 
 #    include "aegis256x2_common.h"
 
-struct aegis256x2_implementation aegis256x2_armcrypto_implementation = {
+struct aegis256x2_implementation aegis256x2_neon_aes_implementation = {
     .encrypt_detached              = encrypt_detached,
     .decrypt_detached              = decrypt_detached,
     .encrypt_unauthenticated       = encrypt_unauthenticated,

src/aegis256/aegis256_armcrypto.c renamed to src/aegis256/aegis256_neon_aes.c

@@ -0,0 +1,9 @@
+#ifndef aegis256x2_neon_aes_H
+#define aegis256x2_neon_aes_H
+
+#include "../common/common.h"
+#include "implementations.h"
+
+extern struct aegis256x2_implementation aegis256x2_neon_aes_implementation;
+
+#endif