<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css" style="display:none;"><!-- P {margin-top:0;margin-bottom:0;} --></style>
</head>
<body dir="ltr">
<div id="divtagdefaultwrapper" dir="ltr" style="font-size:12pt; color:rgb(0,0,0); font-family:Calibri,Helvetica,sans-serif,"EmojiFont","Apple Color Emoji","Segoe UI Emoji",NotoColorEmoji,"Segoe UI Symbol","Android Emoji",EmojiSymbols">
<p style="margin-top:0; margin-bottom:0"></p>
<div>Hi,</div>
<div><br>
</div>
<div>Below is a document detailing changes we'd like to make to Clang/LLVM to improve the usability of the target options for ARM and AArch64.</div>
<div><br>
</div>
<div>To keep things simple the proposed changes are listed at the start and you can find the supporting examples at the end of the document.</div>
<div><br>
</div>
<div>I look forward to your feedback.</div>
<div><br>
</div>
<div>Thanks,</div>
<div>David Spickett.</div>
<div><br>
</div>
<div><br>
</div>
<div><br>
</div>
<div>RFC New Clang target feature selection options for ARM/AArch64<br>
--------------------------------------------------------------<br>
<br>
In this RFC we propose changes to ARM and AArch64 target selection. With the top level goals to:<br>
- validate that given options make sense within architectural restrictions<br>
- make option discovery and documentation easier<br>
- unify the list of extensions that command lines and asm directives use<br>
- bring the options closer to GCC's where appropriate<br>
<br>
Current Options Comparison<br>
--------------------------<br>
<br>
| GCC | Clang |<br>
|-------------------------------|<br>
| ARM | AArch64 | ARM | AArch64 |<br>
|----------------------|-----|---------|-----|---------|<br>
| -march with '+<ext>' | Y | Y | Y | Y |<br>
| checks extensions | Y | N | N | N |<br>
| .arch with '+<ext>' | N | N | N | Y |<br>
| .arch_extension | Y | Y | Y | N |<br>
| .fpu | Y | N | Y | N |<br>
| -mfpu | Y | N | Y | N |<br>
| checks FPUs | N | n/a | N | n/a |<br>
|----------------------|-----|---------|-----|---------|<br>
<br>
Examples of each of these can be found at the end of this document.<br>
<br>
Problems With the Current Options<br>
---------------------------------<br>
<br>
- You cannot select all extensions through an assembly directive, since the AsmParser's list is a separate subset of the complete one in TargetParser.<br>
- Combinations of options are not checked for compatibility.<br>
- Many extensions are tied to their base architecture, though it is valid to add them individually to a previous v8.x-a architecture.<br>
- Users need to work out what FPU they need for ARM, this should be implied by the selected arch and extensions.<br>
- Discovery of valid extensions is difficult, both for the user and for the purposes of generating documentation.<br>
<br>
Proposed solution<br>
------------------<br>
<br>
ARM and AArch64:<br>
- Make the TargetParser the single source for extension names, removing the AsmParser tables.<br>
- Reject unknown extension names with a diagnostic that includes a list of valid extensions for that architecture/CPU.<br>
- Reject invalid combinations of architecture/CPU and extensions with an error diagnostic.<br>
- Add independent subtarget features for each extension so that v8.x+1-a extensions can be used individually with earlier v8.x-a architectures where allowed.<br>
- Emit a warning when a mandatory feature of the base architecture is enabled with '+extension', or disabled with '+noextension'. (and ignore the option)<br>
- Errors caused by the solution above should be able to be downgraded to warnings with the usual -W* options. This applies only to cases where there is a reasonable interpretation of the options chosen.<br>
<br>
ARM:<br>
- Allow all possible ARM extensions in the '.arch_extension' directive, without the '+' syntax<br>
(allow them to be recognised, they could still be rejected for compatibility).<br>
- Add an 'auto' value for -mfpu and make it the default. Meaning that the FPU is implied by mcpu/march. If mfpu is not auto, it should override other options and a warning should be emitted.<br>
- Reject invalid mfpu and march/mcpu combinations with an error diagnostic.<br>
- Reject invalid arch/cpu and extension combinations with an error diagnostic.<br>
<br>
Optional features<br>
-----------------<br>
<br>
AArch64:<br>
- add the '.arch_extension' directive, with the same behaviour as ARM (no '+', one extension per directive). This brings Clang in line with GCC which has this directive for both architectures. Clang does however allow you to achieve the same thing by using
'+' with '.arch'.<br>
<br>
ARM:<br>
- Allow '+' in '.arch' and '.cpu'. GCC does not allow this, but it would make ARM/AArch64 more consistent within Clang.<br>
<br>
Options Comparison With the Proposed Solution<br>
----------------------------------------------<br>
<br>
Anything in brackets has changed from the previous table.<br>
<br>
| GCC | Clang |<br>
|-----------------------------------|<br>
| ARM | AArch64 | ARM | AArch64 |<br>
|----------------------|-----|---------|---------|---------|<br>
| -march with '+<ext>' | Y | Y | Y | Y |<br>
| checks extensions | Y | N | (Y) | (Y) |<br>
| .arch with '+<ext>' | N | N | (Y) | Y | (optional)<br>
| .arch_extension | Y | Y | Y | (Y) | (optional)<br>
| -mfpu | Y | N | Y | N |<br>
| .fpu | Y | N | Y | N |<br>
| checks FPUs | N | n/a | (Y) | n/a |<br>
|----------------------|-----|---------|---------|---------|<br>
<br>
Implementation<br>
--------------<br>
<br>
Use of Table-gen<br>
================<br>
<br>
The current implementation of TargetParser has a number of FIXME comments saying that it should be changed to use tablegen instead of pre processor macros. There are several advantages of porting TargetParser to tablegen:<br>
- more readable than the current macros<br>
- allows default/optional values more easily<br>
- we can generate code and documentation from the same source<br>
- easier to add new properties<br>
<br>
Drawbacks:<br>
- it requires a new tablegen backend to generate the include files<br>
- additional indirection which could make debugging and future changes more difficult<br>
<br>
We think the benefits outweigh the disadvantages in this case.<br>
<br>
To do this, we would need to move TargetParser to break the cyclic dependency of LLVMSupport -> llvm-tblgen -> LLVMSupport. There are 2 options for this:<br>
1. create a new LLVMTargetParser library that contains all parsers for architectures that use it.<br>
2. put the TargetParser for each backend in the library group for that backend. This requires one of:<br>
* Relaxing the requirement that target parsers must be built even if the backend is not.<br>
* Modifying the CMake scripts to build the target parsers even if the backend is not being built.<br>
<br>
Option 1 is simpler but option 2 would allow us to make use of the existing tablegen files in the backends so it is preferred.<br>
<br>
Using existing SubTarget features<br>
=================================<br>
<br>
If we go with option 2 above, we can reuse the existing subtarget features to work out any dependencies.<br>
<br>
We have a prototype that took option 1 above. The command line is converted into a sequence of options and resolved by the LLVM backend. This means that Clang does not know exactly what will be enabled. It needs to know this to output the correct pre processor
feature test macros.<br>
<br>
Consider this AArch64 march:<br>
-march=armv8.4-a+crypto+nosha2<br>
<br>
The base arch is armv8.4-a, the crypto extension turns on AES/SHA2/SHA3/SM4. The nosha2 disables SHA2/SHA3 (since SHA3 is dependant on SHA2). Each of these features has an ACLE feature test macro, so Clang needs to know that nosha2 also disables SHA3.<br>
<br>
New Errors and Warnings<br>
=======================<br>
<br>
Whether these are errors or warnings by default is up for debate. This is a suggestion to begin with.<br>
(these apply to cmd lines and directives unless stated)<br>
<br>
Errors:<br>
- unknown extension in an assembly directive (currently fails silently)<br>
- extension incompatible with base arch, message shows the base arch it requires.<br>
- extension requires another which is disabled later, message shows which one is required.<br>
- extension requires another which is not enabled, message shows requirements.<br>
- ARM mfpu option is not 'auto' and is incompatible with the base arch, message shows list of valid FPUs.<br>
<br>
Warnings:<br>
- ARM mfpu option is not auto and another option implies a different FPU than the mfpu value. The mfpu value will be used, and the message will show what was overridden.<br>
- mandatory feature of the base arch is enabled with '+' (option is redundant so is ignored)<br>
- mandatory feature of a base arch is disabled with '+no<feature>' (option makes no sense so the extension remains enabled)<br>
<br>
Proposed diagnostic names: (in the same order as above)<br>
- "target-feature" (top level group)<br>
- "incompatible-feature"<br>
- "extension-requirement-disabled"<br>
- "extension-requires"<br>
- "incompatible-fpu"<br>
- "implied-fpu-unused"<br>
- "mandatory-feature-ignored"<br>
- "mandatory-feature-disabled"<br>
<br>
"Negative" Backend Features<br>
===========================<br>
<br>
There are a couple of features in ARM which remove capabilities rather than adding them. These are 'd16' (removes the top 16 D registers) and 'fp-only-sp' (removes double precision).<br>
It would simplify the implementation if those were replaced with positive options. As in one that adds the top 16 D registers and one that enables double precision operations.<br>
<br>
This is a relatively simple change to LLVM but it will effect a large number of tests and would be a breaking change for users of LLVM as a library.<br>
<br>
.arch_extension Directive<br>
=========================<br>
<br>
Regardless of '.arch_extension' being added to AArch64, it has some issues that need to be addressed for the rest of these changes.
<br>
<br>
Extensions can now have different meanings based on the base architecture they apply to. For example on AArch64, 'crypto' means different things for v8.{1,2,3}-a than v8.4-a. The former adds 'sha2' and 'aes', the latter adds those and 'sm4' and 'sha3' on top.<br>
<br>
We can handle this in a few of ways:<br>
- Remove .arch_extension in favour of .arch. This conflicts with the option above to add it to AArch64 to bring us in line with GCC, and will break a lot of code written for older versions of Clang.<br>
- Only accept options which do not vary with base architecture. For ARM, only the FPU options vary, and there is the .fpu directive for those. If we do decide to add .arch_extension to AArch64 this will mean that things like crypto will only be valid in .arch.<br>
- Track the current base target, as implied by the command line or the last .arch/.cpu directive. This makes the directives as similar to the command lines as they can be without breaking backwards compatibility.<br>
<br>
The last option makes the most sense to us, certainly if we want to add .arch_extension to AArch64 in a straightforward way.<br>
<br>
ARM Assembly Directives<br>
=======================<br>
<br>
As discussed for AArch64 the ARM assembly directives ('.arch', '.cpu', '.fpu', '.arch_extension') should be updated to use the new target parser. Giving them access to a complete list of features.<br>
<br>
'.arch' and '.cpu' supporting the '+' syntax is mentioned as an optional goal above. This makes ARM/AArch64 consistent within Clang but breaks from GCC's features.<br>
<br>
Current Command Line Option Examples<br>
------------------------------------<br>
<br>
Clang ARM<br>
=========<br>
<br>
Extensions can be used with '+<{no}extension>' syntax on march or mcpu, there is no checking that the combinations are valid. The FPU is selected with -mfpu and this is not validated either.<br>
<br>
$ ./clang --target=arm-arm-none-eabi -march=armv8.2-a -mfpu=none -c /tmp/test.c -o /tmp/test.o<br>
$ ./clang --target=arm-arm-none-eabi -mcpu=cortex-a53+dotprod -c /tmp/test.c -o /tmp/test.o<br>
(can't use dotprod with v8-a)<br>
<br>
$ ./clang --target=arm-arm-none-eabi -march=armv7-m -mfpu=neon-fp16 -c /tmp/test.c -o /tmp/test.o<br>
(should be invalid but is allowed)<br>
<br>
GCC ARM<br>
=======<br>
<br>
For GCC it is the same except that mfpu defaults to 'auto', meaning that the value is implied by other options. Extensions are checked for compatibility with the base architecture but FPUs are not.<br>
<br>
$ ./arm-eabi-gcc -mcpu=cortex-a53 -mfpu=neon -c /tmp/test.c -o /tmp/test.o<br>
$ ./arm-eabi-gcc -march=armv8-a -mfpu=auto -c /tmp/test.c -o /tmp/test.o<br>
<br>
$ ./arm-eabi-gcc -march=armv8-a+dotprod -c /tmp/test.c -o /tmp/test.o<br>
arm-eabi-gcc: error: 'armv8-a' does not support feature 'dotprod'<br>
arm-eabi-gcc: note: valid feature names are: crc simd crypto nocrypto nofp<br>
<br>
$ ./arm-eabi-gcc -march=armv7-m -mfpu=neon-fp16 -c /tmp/test.c -o /tmp/test.o<br>
(same example given for Clang above, should be invalid)<br>
<br>
Clang AArch64<br>
=============<br>
<br>
The '+' syntax still applies but mfpu is replaced with '+' extensions.<br>
<br>
$ ./clang --target=aarch64-arm-none-eabi -march=armv8.2-a -mfpu=none -c /tmp/test.c -o /tmp/test.o<br>
clang-7: warning: argument unused during compilation: '-mfpu=none' [-Wunused-command-line-argument]<br>
$ ./clang --target=aarch64-arm-none-eabi -march=armv8.2-a+nofp -c /tmp/test.c -o /tmp/test.o<br>
$ ./clang --target=aarch64-arm-none-eabi -march=armv8-a+crypto -c /tmp/test.c -o /tmp/test.o<br>
<br>
Dependencies within extensions are not checked. For example crypto requires simd, but it can be disabled in the same march option.<br>
<br>
$ ./clang --target=aarch64-arm-none-eabi -march=armv8-a+crypto+nosimd -c /tmp/test.c -o /tmp/test.o<br>
<br>
Dependencies between an extension and the base arch are not checked either. Dot product cannot be used with v8.0-a but it is allowed.<br>
<br>
$ ./clang --target=aarch64-arm-none-eabi -march=armv8-a+dotprod -c /tmp/test.c -o /tmp/test.o<br>
<br>
GCC AArch64<br>
===========<br>
<br>
For GCC AArch64 mfpu is also dropped in favour of '+' extensions.<br>
<br>
$ ./aarch64-elf-gcc -march=armv8.2-a -mfpu=none -c /tmp/test.c -o /tmp/test.o<br>
aarch64-elf-gcc: error: unrecognized command line option '-mfpu=none'; did you mean '-gz=none'?<br>
<br>
Extensions are rejected if not recognised but not checked for compatibility. Hence the Clang crypto/simd example above is allowed with GCC too.<br>
<br>
$ ./aarch64-elf-gcc -march=armv8.2-a+food -c /tmp/test.c -o /tmp/test.o<br>
cc1: error: invalid feature modifier in '-march=armv8.2-a+food'<br>
$ ./aarch64-elf-gcc -march=armv8.2-a+dotprod -c /tmp/test.c -o /tmp/test.o<br>
$ ./aarch64-elf-gcc -march=armv8-a+dotprod -c /tmp/test.c -o /tmp/test.o<br>
(should not be allowed)<br>
$ ./aarch64-elf-gcc -march=armv8-a+crypto+nosimd -c /tmp/test.c -o /tmp/test.o<br>
(should not be allowed)<br>
<br>
Current Assembly Directive Examples<br>
-----------------------------------<br>
<br>
Clang .arch/.arch_extension<br>
===========================<br>
<br>
AArch64 uses .arch and '+' syntax, ARM uses .arch_extension/.arch and does not support '+' syntax in either.<br>
<br>
In both arches, the list of possible extensions is not complete since it is separate from the one in TargetParser. So there is no way to enable dotprod (amongst other things) with a directive.<br>
<br>
(example is using AArch64)<br>
.arch armv8.2-a # error: instruction requires: dotprod<br>
udot v0.2s, v1.8b, v2.8b<br>
<br>
.arch armv8.2-a+dotprod # error: instruction requires: dotprod<br>
udot v0.2s, v1.8b, v2.8b<br>
<br>
ARM uses the .arch_extension directive which is one extension per use, with no '+'.<br>
<br>
.arch armv7-a #error: instruction requires: crc armv8<br>
CRC32B r0, r1, r2<br>
<br>
.arch armv8-a+crc #error: Unknown arch name<br>
CRC32B r0, r1, r2<br>
<br>
.arch armv8-a # no error<br>
.arch_extension crc<br>
CRC32B r0, r1, r2<br>
<br>
You can see here that though ARM march/mcpu would understand +crc, the assembly directive does not.<br>
<br>
ARM does check validity of extensions provided with '.arch_extension'.<br>
<br>
.arch armv7-a<br>
.arch_extension crc <br>
CRC32B r0, r1, r2<br>
<br>
main.s:20:17: error: architectural extension 'crc' is not allowed for the current base architecture<br>
.arch_extension crc<br>
<br>
AArch64 only rejects known extensions that aren't supported at all.<br>
<br>
.arch armv8-a+pan # unsupported architectural extension: pan<br>
nop<br>
<br>
Neither ARM or AArch64 know about the inter dependencies between extensions. So the example from the command lines applies here too.<br>
<br>
(example is using AArch64)<br>
.arch armv8-a+crypto+nosimd # no error/warning, crypto requires simd<br>
nop<br>
<br>
GCC .arch/.arch_extension<br>
=========================<br>
<br>
GCC is more consistent across the two arches, both use .arch and .arch_extension. Neither understand the '+' syntax.<br>
<br>
.arch armv8-a+crc # invalid<br>
<br>
.arch armv8-a # valid<br>
.arch_extension crc<br>
<br>
.arch_extension crc # valid<br>
.arch_extension crc+crypto #invalid<br>
<br>
For extensions that vary based on base architecture, GCC tracks the last known arch.<br>
<br>
Clang .fpu<br>
==========<br>
<br>
.fpu is only available for ARM. Values are not checked for compatibility, only rejected if completely unknown.<br>
<br>
./clang --target=aarch64-arm-none-eabi -march=armv8-a -c /tmp/test.s -o /tmp/test.o<br>
/tmp/test.s:1:1: error: unknown directive<br>
.fpu neon <br>
^<br>
<br>
$ ./clang --target=arm-arm-none-eabi -march=armv7-m -c /tmp/test.s -o /tmp/test.o<br>
/tmp/test.s:1:6: error: Unknown FPU name<br>
.fpu clearly-not-valid<br>
^<br>
<br>
(same example as 'Clang ARM' command lines, should be invalid)<br>
$ cat /tmp/test.s<br>
.fpu neon-fp16<br>
$ ./clang --target=arm-arm-none-eabi -march=armv7-m -c /tmp/test.s -o /tmp/test.o<br>
<br>
GCC .fpu<br>
========<br>
<br>
.fpu is provided for ARM only and the FPU names are not checked against the base arch or CPU.<br>
<br>
This is correctly rejected from a command line:<br>
$ ./arm-eabi-gcc -march=armv6zk+neon -c /tmp/test.s -o /tmp/test.o<br>
arm-eabi-gcc: error: 'armv6zk' does not support feature 'neon'<br>
arm-eabi-gcc: note: valid feature names are: fp nofp vfpv2<br>
<br>
Whereas the directive is accepted:<br>
$ cat /tmp/test.s<br>
.fpu neon<br>
nop<br>
$ ./arm-eabi-gcc -march=armv6zk -c /tmp/test.s -o /tmp/test.o<br>
<br>
For AArch64 .fpu is removed in favour of .arch_extension. Instead of directly selecting an FPU it is implied by the extensions used.<br>
<br>
$ cat /tmp/test.s<br>
.fpu neon<br>
$ ./aarch64-elf-gcc -march=armv8-a+simd -c /tmp/test.s -o /tmp/test.o<br>
/tmp/test.s: Assembler messages:<br>
/tmp/test.s:1: Error: unknown pseudo-op: `.fpu'<br>
<br>
$ cat /tmp/test.s<br>
.arch_extension simd <br>
$ ./aarch64-elf-gcc -march=armv8-a -c /tmp/test.s -o /tmp/test.o<br>
<br>
References<br>
----------<br>
<br>
Crypto extension requires SIMD: http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0500e/CJHDEBAF.html<br>
GCC ARM options: https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html<br>
GCC ARM directives: https://sourceware.org/binutils/docs/as/ARM-Directives.html<br>
GCC AArch64 options: https://gcc.gnu.org/onlinedocs/gcc/AArch64-Options.html<br>
GCC AArch64 directives: https://sourceware.org/binutils/docs/as/AArch64-Directives.html</div>
<br>
<p></p>
</div>
</body>
</html>