1 /* ====================================================================
2  * Copyright (c) 1998-2011 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    openssl-core@openssl.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This product includes cryptographic software written by Eric Young
50  * (eay@cryptsoft.com).  This product includes software written by Tim
51  * Hudson (tjh@cryptsoft.com). */
52 
53 #ifndef OPENSSL_HEADER_ARM_ARCH_H
54 #define OPENSSL_HEADER_ARM_ARCH_H
55 
56 #if !defined(__ARM_ARCH__)
57 # if defined(__CC_ARM)
58 #  define __ARM_ARCH__ __TARGET_ARCH_ARM
59 #  if defined(__BIG_ENDIAN)
60 #   define __ARMEB__
61 #  else
62 #   define __ARMEL__
63 #  endif
64 # elif defined(__GNUC__)
65 #  if defined(__aarch64__)
66 #    define __ARM_ARCH__ 8
67 #    if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
68 #      define __ARMEB__
69 #    else
70 #      define __ARMEL__
71 #    endif
72   // Why doesn't gcc define __ARM_ARCH__? Instead it defines
73   // bunch of below macros. See all_architectires[] table in
74   // gcc/config/arm/arm.c. On a side note it defines
75   // __ARMEL__/__ARMEB__ for little-/big-endian.
76 #  elif	defined(__ARM_ARCH)
77 #    define __ARM_ARCH__ __ARM_ARCH
78 #  elif	defined(__ARM_ARCH_8A__)
79 #    define __ARM_ARCH__ 8
80 #  elif	defined(__ARM_ARCH_7__)	|| defined(__ARM_ARCH_7A__)	|| \
81 	defined(__ARM_ARCH_7R__)|| defined(__ARM_ARCH_7M__)	|| \
82 	defined(__ARM_ARCH_7EM__)
83 #   define __ARM_ARCH__ 7
84 #  elif	defined(__ARM_ARCH_6__)	|| defined(__ARM_ARCH_6J__)	|| \
85 	defined(__ARM_ARCH_6K__)|| defined(__ARM_ARCH_6M__)	|| \
86 	defined(__ARM_ARCH_6Z__)|| defined(__ARM_ARCH_6ZK__)	|| \
87 	defined(__ARM_ARCH_6T2__)
88 #   define __ARM_ARCH__ 6
89 #  elif	defined(__ARM_ARCH_5__)	|| defined(__ARM_ARCH_5T__)	|| \
90 	defined(__ARM_ARCH_5E__)|| defined(__ARM_ARCH_5TE__)	|| \
91 	defined(__ARM_ARCH_5TEJ__)
92 #   define __ARM_ARCH__ 5
93 #  elif	defined(__ARM_ARCH_4__)	|| defined(__ARM_ARCH_4T__)
94 #   define __ARM_ARCH__ 4
95 #  else
96 #   error "unsupported ARM architecture"
97 #  endif
98 # endif
99 #endif
100 
101 // Even when building for 32-bit ARM, support for aarch64 crypto instructions
102 // will be included.
103 #define __ARM_MAX_ARCH__ 8
104 
105 // ARMV7_NEON is true when a NEON unit is present in the current CPU.
106 #define ARMV7_NEON (1 << 0)
107 
108 // ARMV8_AES indicates support for hardware AES instructions.
109 #define ARMV8_AES (1 << 2)
110 
111 // ARMV8_SHA1 indicates support for hardware SHA-1 instructions.
112 #define ARMV8_SHA1 (1 << 3)
113 
114 // ARMV8_SHA256 indicates support for hardware SHA-256 instructions.
115 #define ARMV8_SHA256 (1 << 4)
116 
117 // ARMV8_PMULL indicates support for carryless multiplication.
118 #define ARMV8_PMULL (1 << 5)
119 
120 #if defined(__ASSEMBLER__)
121 
122 // Support macros for
123 //   - Armv8.3-A Pointer Authentication and
124 //   - Armv8.5-A Branch Target Identification
125 // features which require emitting a .note.gnu.property section with the
126 // appropriate architecture-dependent feature bits set.
127 // Read more: "ELF for the Arm® 64-bit Architecture"
128 
129 #if defined(__ARM_FEATURE_BTI_DEFAULT) && __ARM_FEATURE_BTI_DEFAULT == 1
130 #define GNU_PROPERTY_AARCH64_BTI (1 << 0)   // Has Branch Target Identification
131 #define AARCH64_VALID_CALL_TARGET hint #34  // BTI 'c'
132 #else
133 #define GNU_PROPERTY_AARCH64_BTI 0  // No Branch Target Identification
134 #define AARCH64_VALID_CALL_TARGET
135 #endif
136 
137 #if defined(__ARM_FEATURE_PAC_DEFAULT) && \
138     (__ARM_FEATURE_PAC_DEFAULT & 1) == 1  // Signed with A-key
139 #define GNU_PROPERTY_AARCH64_POINTER_AUTH \
140   (1 << 1)                                       // Has Pointer Authentication
141 #define AARCH64_SIGN_LINK_REGISTER hint #25      // PACIASP
142 #define AARCH64_VALIDATE_LINK_REGISTER hint #29  // AUTIASP
143 #elif defined(__ARM_FEATURE_PAC_DEFAULT) && \
144     (__ARM_FEATURE_PAC_DEFAULT & 2) == 2  // Signed with B-key
145 #define GNU_PROPERTY_AARCH64_POINTER_AUTH \
146   (1 << 1)                                       // Has Pointer Authentication
147 #define AARCH64_SIGN_LINK_REGISTER hint #27      // PACIBSP
148 #define AARCH64_VALIDATE_LINK_REGISTER hint #31  // AUTIBSP
149 #else
150 #define GNU_PROPERTY_AARCH64_POINTER_AUTH 0  // No Pointer Authentication
151 #if GNU_PROPERTY_AARCH64_BTI != 0
152 #define AARCH64_SIGN_LINK_REGISTER AARCH64_VALID_CALL_TARGET
153 #else
154 #define AARCH64_SIGN_LINK_REGISTER
155 #endif
156 #define AARCH64_VALIDATE_LINK_REGISTER
157 #endif
158 
159 #if GNU_PROPERTY_AARCH64_POINTER_AUTH != 0 || GNU_PROPERTY_AARCH64_BTI != 0
160 .pushsection .note.gnu.property, "a";
161 .balign 8;
162 .long 4;
163 .long 0x10;
164 .long 0x5;
165 .asciz "GNU";
166 .long 0xc0000000; /* GNU_PROPERTY_AARCH64_FEATURE_1_AND */
167 .long 4;
168 .long (GNU_PROPERTY_AARCH64_POINTER_AUTH | GNU_PROPERTY_AARCH64_BTI);
169 .long 0;
170 .popsection;
171 #endif
172 
173 #endif  /* defined __ASSEMBLER__ */
174 
175 #endif  // OPENSSL_HEADER_ARM_ARCH_H
176