crypto/armcap.c

   1 /*
   2  * Copyright 2011-2021 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <stdio.h>
  11 #include <stdlib.h>
  12 #include <string.h>
  13 #include <setjmp.h>
  14 #include <signal.h>
  15 #include <openssl/crypto.h>
  16 #ifdef __APPLE__
  17 #include <sys/sysctl.h>
  18 #endif
  19 #include "internal/cryptlib.h"
  20
  21 #include "arm_arch.h"
  22
  23 unsigned int OPENSSL_armcap_P = 0;
  24 unsigned int OPENSSL_arm_midr = 0;
  25 unsigned int OPENSSL_armv8_rsa_neonized = 0;
  26
  27 #if __ARM_MAX_ARCH__<7
  28 void OPENSSL_cpuid_setup(void)
  29 {
  30 }
  31
  32 uint32_t OPENSSL_rdtsc(void)
  33 {
  34     return 0;
  35 }
  36 #else
  37 static sigset_t all_masked;
  38
  39 static sigjmp_buf ill_jmp;
  40 static void ill_handler(int sig)
  41 {
  42     siglongjmp(ill_jmp, sig);
  43 }
  44
  45 /*
  46  * Following subroutines could have been inlined, but it's not all
  47  * ARM compilers support inline assembler...
  48  */
  49 void _armv7_neon_probe(void);
  50 void _armv8_aes_probe(void);
  51 void _armv8_sha1_probe(void);
  52 void _armv8_sha256_probe(void);
  53 void _armv8_pmull_probe(void);
  54 # ifdef __aarch64__
  55 void _armv8_sha512_probe(void);
  56 unsigned int _armv8_cpuid_probe(void);
  57 # endif
  58 uint32_t _armv7_tick(void);
  59
  60 uint32_t OPENSSL_rdtsc(void)
  61 {
  62     if (OPENSSL_armcap_P & ARMV7_TICK)
  63         return _armv7_tick();
  64     else
  65         return 0;
  66 }
  67
  68 # if defined(__GNUC__) && __GNUC__>=2
  69 void OPENSSL_cpuid_setup(void) __attribute__ ((constructor));
  70 # endif
  71
  72 # if defined(__GLIBC__) && defined(__GLIBC_PREREQ)
  73 #  if __GLIBC_PREREQ(2, 16)
  74 #   include <sys/auxv.h>
  75 #   define OSSL_IMPLEMENT_GETAUXVAL
  76 #  endif
  77 # endif
  78 # if defined(__FreeBSD__)
  79 #  include <sys/param.h>
  80 #  if __FreeBSD_version >= 1200000
  81 #   include <sys/auxv.h>
  82 #   define OSSL_IMPLEMENT_GETAUXVAL
  83
  84 static unsigned long getauxval(unsigned long key)
  85 {
  86   unsigned long val = 0ul;
  87
  88   if (elf_aux_info((int)key, &val, sizeof(val)) != 0)
  89     return 0ul;
  90
  91   return val;
  92 }
  93 #  endif
  94 # endif
  95
  96 /*
  97  * Android: according to https://developer.android.com/ndk/guides/cpu-features,
  98  * getauxval is supported starting with API level 18
  99  */
 100 #  if defined(__ANDROID__) && defined(__ANDROID_API__) && __ANDROID_API__ >= 18
 101 #   include <sys/auxv.h>
 102 #   define OSSL_IMPLEMENT_GETAUXVAL
 103 #  endif
 104
 105 /*
 106  * ARM puts the feature bits for Crypto Extensions in AT_HWCAP2, whereas
 107  * AArch64 used AT_HWCAP.
 108  */
 109 # if defined(__arm__) || defined (__arm)
 110 #  define HWCAP                  16
 111                                   /* AT_HWCAP */
 112 #  define HWCAP_NEON             (1 << 12)
 113
 114 #  define HWCAP_CE               26
 115                                   /* AT_HWCAP2 */
 116 #  define HWCAP_CE_AES           (1 << 0)
 117 #  define HWCAP_CE_PMULL         (1 << 1)
 118 #  define HWCAP_CE_SHA1          (1 << 2)
 119 #  define HWCAP_CE_SHA256        (1 << 3)
 120 # elif defined(__aarch64__)
 121 #  define HWCAP                  16
 122                                   /* AT_HWCAP */
 123 #  define HWCAP_NEON             (1 << 1)
 124
 125 #  define HWCAP_CE               HWCAP
 126 #  define HWCAP_CE_AES           (1 << 3)
 127 #  define HWCAP_CE_PMULL         (1 << 4)
 128 #  define HWCAP_CE_SHA1          (1 << 5)
 129 #  define HWCAP_CE_SHA256        (1 << 6)
 130 #  define HWCAP_CPUID            (1 << 11)
 131 #  define HWCAP_CE_SHA512        (1 << 21)
 132 # endif
 133
 134 void OPENSSL_cpuid_setup(void)
 135 {
 136     const char *e;
 137     struct sigaction ill_oact, ill_act;
 138     sigset_t oset;
 139     static int trigger = 0;
 140
 141     if (trigger)
 142         return;
 143     trigger = 1;
 144
 145     OPENSSL_armcap_P = 0;
 146
 147     if ((e = getenv("OPENSSL_armcap"))) {
 148         OPENSSL_armcap_P = (unsigned int)strtoul(e, NULL, 0);
 149         return;
 150     }
 151
 152 # if defined(__APPLE__)
 153 #   if !defined(__aarch64__)
 154     /*
 155      * Capability probing by catching SIGILL appears to be problematic
 156      * on iOS. But since Apple universe is "monocultural", it's actually
 157      * possible to simply set pre-defined processor capability mask.
 158      */
 159     if (1) {
 160         OPENSSL_armcap_P = ARMV7_NEON;
 161         return;
 162     }
 163     /*
 164      * One could do same even for __aarch64__ iOS builds. It's not done
 165      * exclusively for reasons of keeping code unified across platforms.
 166      * Unified code works because it never triggers SIGILL on Apple
 167      * devices...
 168      */
 169 #   else
 170     {
 171         unsigned int sha512;
 172         size_t len = sizeof(sha512);
 173
 174         if (sysctlbyname("hw.optional.armv8_2_sha512", &sha512, &len, NULL, 0) == 0 && sha512 == 1)
 175             OPENSSL_armcap_P |= ARMV8_SHA512;
 176     }
 177 #   endif
 178 # endif
 179
 180 # ifdef OSSL_IMPLEMENT_GETAUXVAL
 181     if (getauxval(HWCAP) & HWCAP_NEON) {
 182         unsigned long hwcap = getauxval(HWCAP_CE);
 183
 184         OPENSSL_armcap_P |= ARMV7_NEON;
 185
 186         if (hwcap & HWCAP_CE_AES)
 187             OPENSSL_armcap_P |= ARMV8_AES;
 188
 189         if (hwcap & HWCAP_CE_PMULL)
 190             OPENSSL_armcap_P |= ARMV8_PMULL;
 191
 192         if (hwcap & HWCAP_CE_SHA1)
 193             OPENSSL_armcap_P |= ARMV8_SHA1;
 194
 195         if (hwcap & HWCAP_CE_SHA256)
 196             OPENSSL_armcap_P |= ARMV8_SHA256;
 197
 198 #  ifdef __aarch64__
 199         if (hwcap & HWCAP_CE_SHA512)
 200             OPENSSL_armcap_P |= ARMV8_SHA512;
 201
 202         if (hwcap & HWCAP_CPUID)
 203             OPENSSL_armcap_P |= ARMV8_CPUID;
 204 #  endif
 205     }
 206 # endif
 207
 208     sigfillset(&all_masked);
 209     sigdelset(&all_masked, SIGILL);
 210     sigdelset(&all_masked, SIGTRAP);
 211     sigdelset(&all_masked, SIGFPE);
 212     sigdelset(&all_masked, SIGBUS);
 213     sigdelset(&all_masked, SIGSEGV);
 214
 215     memset(&ill_act, 0, sizeof(ill_act));
 216     ill_act.sa_handler = ill_handler;
 217     ill_act.sa_mask = all_masked;
 218
 219     sigprocmask(SIG_SETMASK, &ill_act.sa_mask, &oset);
 220     sigaction(SIGILL, &ill_act, &ill_oact);
 221
 222     /* If we used getauxval, we already have all the values */
 223 # ifndef OSSL_IMPLEMENT_GETAUXVAL
 224     if (sigsetjmp(ill_jmp, 1) == 0) {
 225         _armv7_neon_probe();
 226         OPENSSL_armcap_P |= ARMV7_NEON;
 227         if (sigsetjmp(ill_jmp, 1) == 0) {
 228             _armv8_pmull_probe();
 229             OPENSSL_armcap_P |= ARMV8_PMULL | ARMV8_AES;
 230         } else if (sigsetjmp(ill_jmp, 1) == 0) {
 231             _armv8_aes_probe();
 232             OPENSSL_armcap_P |= ARMV8_AES;
 233         }
 234         if (sigsetjmp(ill_jmp, 1) == 0) {
 235             _armv8_sha1_probe();
 236             OPENSSL_armcap_P |= ARMV8_SHA1;
 237         }
 238         if (sigsetjmp(ill_jmp, 1) == 0) {
 239             _armv8_sha256_probe();
 240             OPENSSL_armcap_P |= ARMV8_SHA256;
 241         }
 242 #  if defined(__aarch64__) && !defined(__APPLE__)
 243         if (sigsetjmp(ill_jmp, 1) == 0) {
 244             _armv8_sha512_probe();
 245             OPENSSL_armcap_P |= ARMV8_SHA512;
 246         }
 247 #  endif
 248     }
 249 # endif
 250
 251     /* Things that getauxval didn't tell us */
 252     if (sigsetjmp(ill_jmp, 1) == 0) {
 253         _armv7_tick();
 254         OPENSSL_armcap_P |= ARMV7_TICK;
 255     }
 256
 257     sigaction(SIGILL, &ill_oact, NULL);
 258     sigprocmask(SIG_SETMASK, &oset, NULL);
 259
 260 # ifdef __aarch64__
 261     if (OPENSSL_armcap_P & ARMV8_CPUID)
 262         OPENSSL_arm_midr = _armv8_cpuid_probe();
 263
 264     if ((MIDR_IS_CPU_MODEL(OPENSSL_arm_midr, ARM_CPU_IMP_ARM, ARM_CPU_PART_CORTEX_A72) ||
 265          MIDR_IS_CPU_MODEL(OPENSSL_arm_midr, ARM_CPU_IMP_ARM, ARM_CPU_PART_N1)) &&
 266         (OPENSSL_armcap_P & ARMV7_NEON)) {
 267             OPENSSL_armv8_rsa_neonized = 1;
 268     }
 269 # endif
 270 }
 271 #endif