DUI0472M Armcc User Guide
DUI0472M Armcc User Guide
Version 5.06u3
ARM® Compiler
armcc User Guide
Copyright © 2010-2016 ARM. All rights reserved.
Release Information
Document History
Your access to the information in this document is conditional upon your acceptance that you will not use or permit others to use
the information for the purposes of determining whether implementations infringe any third party patents.
THIS DOCUMENT IS PROVIDED “AS IS”. ARM PROVIDES NO REPRESENTATIONS AND NO WARRANTIES,
EXPRESS, IMPLIED OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, SATISFACTORY QUALITY, NON-INFRINGEMENT OR FITNESS FOR A PARTICULAR PURPOSE
WITH RESPECT TO THE DOCUMENT. For the avoidance of doubt, ARM makes no representation with respect to, and has
undertaken no analysis to identify or understand the scope and content of, third party patents, copyrights, trade secrets, or other
rights.
TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL ARM BE LIABLE FOR ANY DAMAGES,
INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR
CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING
OUT OF ANY USE OF THIS DOCUMENT, EVEN IF ARM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
This document consists solely of commercial items. You shall be responsible for ensuring that any use, duplication or disclosure of
this document complies fully with any relevant export laws and regulations to assure that this document or any portion thereof is
not exported, directly or indirectly, in violation of such export laws. Use of the word “partner” in reference to ARM’s customers is
not intended to create or refer to any partnership relationship with any other company. ARM may make changes to this document at
any time and without notice.
If any of the provisions contained in these terms conflict with any of the provisions of any signed written agreement covering this
document with ARM, then the signed written agreement prevails over and supersedes the conflicting provisions of these terms.
This document may be translated into other languages for convenience, and you agree that if there is any conflict between the
English version of this document and any translation, the terms of the English version of the Agreement shall prevail.
Words and logos marked with ® or ™ are registered trademarks or trademarks of ARM Limited or its affiliates in the EU and/or
elsewhere. All rights reserved. Other brands and names mentioned in this document may be the trademarks of their respective
owners. Please follow ARM’s trademark usage guidelines at http://www.arm.com/about/trademark-usage-guidelines.php
LES-PRE-20349
Additional Notices
Some material in this document is based on IEEE 754-1985 IEEE Standard for Binary Floating-Point Arithmetic. The IEEE
disclaims any responsibility or liability resulting from the placement and use in the described manner.
Confidentiality Status
This document is Non-Confidential. The right to use, copy and disclose this document may be subject to license restrictions in
accordance with the terms of the agreement entered into by ARM and the party that ARM delivered this document to.
Preface
About this book ..................................................... ..................................................... 26
Chapter 7 Using the Inline and Embedded Assemblers of the ARM Compiler
7.1 Compiler support for inline assembly language .......................... .......................... 7-264
7.2 Inline assembler support in the compiler ............................... ............................... 7-265
7.3 Restrictions on inline assembler support in the compiler ................... ................... 7-266
7.4 Inline assembly language syntax with the __asm keyword in C and C++ ...... ...... 7-267
7.5 Inline assembly language syntax with the asm keyword in C++ ............. ............. 7-268
7.6 Inline assembler rules for compiler keywords __asm and asm .............. .............. 7-269
7.7 Restrictions on inline assembly operations in C and C++ code .............. .............. 7-270
7.8 Inline assembler register restrictions in C and C++ code ...................................... 7-271
7.9 Inline assembler processor mode restrictions in C and C++ code ........................ 7-272
7.10 Inline assembler Thumb instruction set restrictions in C and C++ code ................ 7-273
7.11 Inline assembler Vector Floating-Point (VFP) restrictions in C and C++ code ...... 7-274
7.12 Inline assembler instruction restrictions in C and C++ code .................................. 7-275
7.13 Miscellaneous inline assembler restrictions in C and C++ code ............. ............. 7-276
7.14 Inline assembler and register access in C and C++ code .................. .................. 7-277
7.15 Inline assembler and the # constant expression specifier in C and C++ code ...... 7-279
7.16 Inline assembler and instruction expansion in C and C++ code ............................ 7-280
7.17 Expansion of inline assembler instructions that use constants .............. .............. 7-281
7.18 Expansion of inline assembler load and store instructions .................................... 7-282
7.19 Inline assembler effect on processor condition flags in C and C++ code .............. 7-283
7.20 Inline assembler expression operands in C and C++ code ................. ................. 7-284
7.21 Inline assembler register list operands in C and C++ code ................. ................. 7-285
7.22 Inline assembler intermediate operands in C and C++ code ................ ................ 7-286
7.23 Inline assembler function calls and branches in C and C++ code ............ ............ 7-287
7.24 Inline assembler branches and labels in C and C++ code .................................... 7-289
7.25 Inline assembler and virtual registers .................................................................... 7-290
7.26 Embedded assembler support in the compiler ...................................................... 7-291
7.27 Embedded assembler syntax in C and C++ .......................................................... 7-292
7.28 Effect of compiler ARM and Thumb states on embedded assembler ......... ......... 7-293
7.29 Restrictions on embedded assembly language functions in C and C++ code ... ... 7-294
7.30 Compiler generation of embedded assembly language functions ............ ............ 7-295
Glossary
The ARM Glossary is a list of terms used in ARM documentation, together with definitions for those
terms. The ARM Glossary does not contain terms that are industry standard unless the ARM meaning
differs from the generally accepted meaning.
See the ARM Glossary for more information.
Typographic conventions
italic
Introduces special terminology, denotes cross-references, and citations.
bold
Highlights interface elements, such as menu names. Denotes signal names. Also used for terms
in descriptive lists, where appropriate.
monospace
Denotes text that you can enter at the keyboard, such as commands, file and program names,
and source code.
monospace
Denotes a permitted abbreviation for a command or option. You can enter the underlined text
instead of the full command or option name.
monospace italic
Denotes arguments to monospace text where the argument is to be replaced by a specific value.
monospace bold
Denotes language keywords when used outside example code.
<and>
Encloses replaceable terms for assembler syntax where they appear in code or code fragments.
For example:
MRC p15, 0, <Rd>, <CRn>, <CRm>, <Opcode_2>
SMALL CAPITALS
Used in body text for a few terms that have specific technical meanings, that are defined in the
ARM glossary. For example, IMPLEMENTATION DEFINED, IMPLEMENTATION SPECIFIC, UNKNOWN, and
UNPREDICTABLE.
Feedback
Feedback on content
If you have comments on content then send an e-mail to [email protected]. Give:
• The title ARM® Compiler armcc User Guide.
• The number ARM DUI0472M.
• If applicable, the page number(s) to which your comments refer.
• A concise explanation of your comments.
ARM also welcomes general suggestions for additions and improvements.
Note
ARM tests the PDF only in Adobe Acrobat and Acrobat Reader, and cannot guarantee the quality of the
represented document when used with any other PDF reader.
Other information
• ARM Information Center.
• ARM Technical Support Knowledge Articles.
• Support and Maintenance.
• ARM Glossary.
Gives an overview of the ARM compiler, the languages and extensions it supports, and the provided
libraries.
It contains the following sections:
• 1.1 The compiler on page 1-30.
• 1.2 Source language modes of the compiler on page 1-31.
• 1.3 Language extensions on page 1-33.
• 1.4 Language compliance on page 1-34.
• 1.5 The C and C++ libraries on page 1-35.
Note
The command-line option descriptions and related information in the individual ARM Compiler tools
documents describe all the features that ARM Compiler supports. Any features not documented are not
supported and are used at your own risk. You are responsible for making sure that any generated code
using unsupported features is operating correctly.
Related concepts
3.1 NEON technology on page 3-69.
Related information
The DWARF Debugging Standard, http://dwarfstd.org/.
Application Binary Interface (ABI) for the ARM Architecture.
C
Means any of C90, strict C90, C99, strict C99, and Standard C.
C++03
Means ISO C++03, excepting export templates, either with or without the ARM extensions.
Use the compiler option --cpp to compile C++03 code.
Use the compiler options --cpp --cpp_compat to maximize binary compatibility with C++03
code compiled using older compiler versions.
Strict C++03
Means ISO C++03, excepting export templates.
Use the compiler options --cpp --strict to compile strict C++03 code.
C++11
Means ISO C++11, either with or without the ARM extensions.
Use the compiler option --cpp11 to compile C++11 code.
Use the compiler options --cpp11 --cpp_compat to compile a subset of C++11 code that
maximizes compatibility with code compiled to the C++ 2003 standard.
Strict C++11
Means ISO C++11.
Use the compiler options --cpp11 --strict to compile strict C++11 code.
Standard C++
Means strict C++03 or strict C++11 as appropriate.
C++
Means any of C++03, strict C++03, C++11, strict C++11.
Related concepts
5.59 New language features of C99 on page 5-228.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
Related references
1.3 Language extensions on page 1-33.
1.4 Language compliance on page 1-34.
1.3 Language extensions on page 1-33.
1.4 Language compliance on page 1-34.
11.13 C++11 supported features on page 11-814.
15.1 Implementation definition on page 15-892.
16.4 Standard C++ library implementation definition on page 16-916.
Related references
9.6 C99 language features available in C90 on page 9-556.
9.10 C99 language features available in C++ and C90 on page 9-560.
9.15 Standard C language extensions on page 9-565.
9.24 Standard C++ language extensions on page 9-574.
9.32 Standard C and Standard C++ language extensions on page 9-582.
1.4 Language compliance on page 1-34.
9.45 GNU extensions to the C and C++ languages on page 9-595.
Chapter 14 Summary Table of GNU Language Extensions on page 14-887.
Examples
The following examples illustrate combining source language modes with language compliance modes:
• Compiling a .cpp file with the command-line option --strict compiles Standard C++03.
• Compiling a C source file with the command-line option --gnu compiles GNU mode C90.
• Compiling a .c file with the command-line options --strict and --gnu is an error.
Related references
8.93 --gnu on page 8-424.
8.176 --strict, --no_strict on page 8-513.
9.45 GNU extensions to the C and C++ languages on page 9-595.
2.7 Filename suffixes recognized by the compiler on page 2-49.
Chapter 14 Summary Table of GNU Language Extensions on page 14-887.
Related information
ARM DS-5 License Management Guide.
Application Binary Interface (ABI) for the ARM Architecture.
Compliance with the Application Binary Interface (ABI) for the ARM architecture.
The ARM C and C++ Libraries.
where:
options
are compiler command-line options that affect the behavior of the compiler.
source
provides the filenames of one or more text files containing C or C++ source code. By default,
the compiler looks for source files and creates output files in the current directory.
If a source file is an assembly file, that is, one with an extension of .s, the compiler activates the
ARM assembler to process the source file.
When you invoke the compiler, you normally specify one or more source files. However, a
minority of compiler command-line options do not require you to specify a source file. For
example, armcc --version_number.
The compiler accepts one or more input files, for example:
armcc -c [options] input_file_1 ... input_file_n
Specifying a dash - for an input file causes the compiler to read from stdin. To specify that all
subsequent arguments are treated as filenames, not as command switches, use the POSIX option --.
The -c option instructs the compiler to perform the compilation step, but not the link step.
Related concepts
2.2 Compiler command-line options listed by group on page 2-38.
Related references
8.21 -c on page 8-344.
Related information
Rules for specifying command-line options.
Toolchain environment variables.
Note
The following characters are interchangeable:
• Nonprefix hyphens and underscores. For example, --version_number and --version-number.
• Equals signs and spaces. For example, armcc --cpu=list and armcc --cpu list.
This applies to all tools provided with the compiler.
Source languages
• --c90
• --c99
• --compile_all_input, --no_compile_all_input
• --cpp
• --cpp11
• --cpp_compat
• --gnu
• --strict, --no_strict
• --strict_warnings
Search paths
• -Idir[,dir,...]
• -Jdir[,dir,...]
• --kandr_include
• --preinclude=filename
• --reduce_paths, --no_reduce_paths
• --sys_include
• --ignore_missing_headers
Precompiled headers
• --create_pch=filename
• --pch
• --pch_dir=dir
• --pch_messages, --no_pch_messages
• --pch_verbose, --no_pch_verbose
• --use_pch=filename
Preprocessor
• -C
• --code_gen, --no_code_gen
• -Dname[(parm-list)][=def]
• -E
• -M
• --old_style_preprocessing
• -P
• --preprocess_assembly
• --preprocessed
• -Uname
C++
• --allow_null_this
• --anachronisms, --no_anachronisms
• --dep_name, --no_dep_name
• --export_all_vtbl, --no_export_all_vtbl
• --force_new_nothrow, --no_force_new_nothrow
• --friend_injection, --no_friend_injection
• --guiding_decls, --no_guiding_decls
• --implicit_include, --no_implicit_include
• --implicit_include_searches, --no_implicit_include_searches
• --implicit_typename, --no_implicit_typename
• --nonstd_qualifier_deduction, --no_nonstd_qualifier_deduction
• --old_specializations, --no_old_specializations
• --parse_templates, --no_parse_templates
• --pending_instantiations=n
• --rtti, --no_rtti
• --rtti_data
• --type_traits_helpers
• --using_std, --no_using_std
• --vfe, --no_vfe
Output format
• --asm
• --asm_dir
• -c
• --default_extension=ext
• --depend=filename
• --depend_dir
• --depend_format=string
• --depend_single_line
• --depend_system_headers, --no_depend_system_headers
• --depend_target
• --errors
• --info=totals
• --interleave
• --list
• --list_dir
• --list_macros
• --md
• --mm
• -o filename
• --output_dir
• --phony_targets
• -S
• --split_sections
Target architectures and processors
• --arm
• --arm_only
• --compatible=name
• --cpu=list
• --cpu=name
• --fpu=list
• --fpu=name
• --thumb
Floating-point support
• --fp16_format=format
• --fpmode=model
• --fpu=list
• --fpu=name
Debug
• --debug, --no_debug
• --debug_macros, --no_debug_macros
• --dwarf2
• --dwarf3
• -g
• --remove_unneeded_entities, --no_remove_unneeded_entities
• --emit_frame_directives
Code generation
• --allow_fpreg_for_nonfpdata, --no_allow_fpreg_for_nonfpdata
• --alternative_tokens, --no_alternative_tokens
• --bigend
• --bitband
• --branch_tables
• --bss_threshold=num
• --conditionalize, --no_conditionalize
• --default_definition_visibility
• --dllexport_all, --no_dllexport_all
• --dllimport_runtime, --no_dllimport_runtime
• --dollar, --no_dollar
• --enum_is_int
• --exceptions, --no_exceptions
• --exceptions_unwind, --no_exceptions_unwind
• --execute_only
• --float_literal_pools
• --export_all_vtbl, --no_export_all_vtbl
• --export_defs_implicitly, --no_export_defs_implicitly
• --extended_initializers, --no_extended_initializers
• --global_reg
• --gnu_defaults
• --gnu_instrument
• --gnu_version
• --hide_all, --no_hide_all
• --implicit_key_function
• --import_all_vtbl
• --integer_literal_pools
• --interface_enums_are_32_bit
• --littleend
• --locale=lang_country
• --long_long
• --loose_implicit_cast
• --message_locale=lang_country[.codepage]
• --min_array_alignment=opt
• --multibyte_chars, --no_multibyte_chars
• --multiply_latency
• --narrow_volatile_bitfields
• --pointer_alignment=num
• --protect_stack, --no_protect_stack
• --restrict, --no_restrict
• --relaxed_ref_def
• --share_inlineable_strings
• --signed_bitfields, --unsigned_bitfields
• --signed_chars, --unsigned_chars
• --split_ldm
• --string_literal_pools
• --trigraphs
• --unaligned_access, --no_unaligned_access
• --use_frame_pointer
• --vectorize, --no_vectorize
• --visibility_inlines_hidden
• --vla, --no_vla
• --wchar
• --wchar16
• --wchar32
Optimization
• --autoinline, --no_autoinline
• --data_reorder, --no_data_reorder
• --forceinline
• --fpmode=model
• --inline, --no_inline
• --library_interface=lib
• --library_type=lib
• --loop_optimization_level=opt
• --lower_ropi, --no_lower_ropi
• --lower_rwpi, --no_lower_rwpi
• --multifile, --no_multifile
• -Onum
• -Ospace
• -Otime
• --reassociate_saturation
• --retain=option
• --whole_program
Note
Optimization options can limit the debug information generated by the compiler.
Diagnostics
• --brief_diagnostics, --no_brief_diagnostics
• --diag_error=tag[,tag,...]
• --diag_remark=tag[,tag,...]
• --diag_style={arm|ide|gnu}
• --diag_suppress=tag[,tag,...]
• --diag_suppress=optimizations
• --diag_warning=tag[,tag,...]
• --diag_warning=optimizations
• --errors=filename
• --link_all_input
• --remarks
• -W
• --wrap_diagnostics, --no_wrap_diagnostics
Command-line options in a text file
• --via=filename
Linker feedback
• --feedback=filename
Procedure call standard
• --apcs=qualifier...qualifier
Passing options to other tools
• -Aopt
• -Lopt
ARM Linux
• --arm_linux
• --arm_linux_configure
• --arm_linux_config_file=path
• --arm_linux_paths
• --configure_gas
• --configure_gcc=path
• --configure_gcc_version
• --configure_gld=path
• --configure_sysroot=path
• --configure_cpp_headers=path
• --configure_extra_includes=paths
• --configure_extra_libraries=paths
• --execstack
• --shared
• --translate_g++
• --translate_gcc
• --translate_gld
• --use_gas
• -Warmcc,option[,option,...]
• -Warmcc,--gcc_fallback
Related concepts
2.4 Order of compiler command-line options on page 2-45.
Related references
Chapter 8 Compiler Command-line Options on page 8-312.
If you specify files with conflicting file extensions you can force the compiler to compile both files for C
or for C++, regardless of file extension. For example:
armcc -c --cpp test1.c test2.cpp
Where an unrecognized extension begins with .c, for example, filename.cmd, an error message is
generated.
Support for processing Precompiled Header (PCH) files is not available when you specify multiple
source files in a single compilation. If you request PCH processing and specify more than one primary
source file, the compiler issues an error message, and aborts the compilation.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
armcc can in turn invoke armasm and armlink. For example, if your source code contains embedded
assembly code, armasm is called. armcc searches for the armasm and armlink binaries in the following
locations, in this order:
1. The same location as armcc.
2. The PATH locations.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
2.4 Order of compiler command-line options on page 2-45.
2.9 Factors influencing how the compiler searches for header files on page 2-52.
2.11 Compiler search rules and the current place on page 2-54.
2.12 The ARMCC5INC environment variable on page 2-55.
2.2 Compiler command-line options listed by group on page 2-38.
2.1 Compiler command-line syntax on page 2-37.
Related tasks
2.5 Using stdin to input source code to the compiler on page 2-46.
Related references
2.7 Filename suffixes recognized by the compiler on page 2-49.
2.8 Compiler output files on page 2-51.
You can use the environment variable ARMCC5_CCOPT to specify compiler command-line options. Options
specified on the command line take precedence over options specified in the environment variable.
To see how the compiler has processed the command line, use the --show_cmdline option. This shows
nondefault options that the compiler used. The contents of any via files are expanded. In the example
used here, although the compiler executes armcc -O2 -Otime, the output from --show_cmdline does
not include -O2. This is because -O2 is the default optimization level, and --show_cmdline does not
show options that apply by default.
Related concepts
2.2 Compiler command-line options listed by group on page 2-38.
Procedure
1. Invoke the compiler with the command-line options you want to use. The default compiler mode is C.
Use the minus character (-) as the source filename to instruct the compiler to take input from stdin.
For example:
armcc --bigend -c -
If you want an object file to be written, use the -o option. If you want preprocessor output to be sent
to the output stream, use the -E option. If you want the output to be sent to stdout, use the -o-
option. If you want an assembly listing of the keyboard input to be sent to the output stream after
input has been terminated, use none of these options.
2. You cannot input on the same line after the minus character. You must press the return key if you
have not already done so.
The command prompt waits for you to enter more input.
3. Enter your input. For example:
#include <stdio.h>
int main(void)
{ printf("Hello world\n"); }
You can only combine standard input with other source files when you are linking code. If you attempt to
combine standard input with other source files when not linking, the compiler generates an error.
Related concepts
2.1 Compiler command-line syntax on page 2-37.
2.2 Compiler command-line options listed by group on page 2-38.
Related information
Rules for specifying command-line options.
Toolchain environment variables.
Related concepts
2.1 Compiler command-line syntax on page 2-37.
2.2 Compiler command-line options listed by group on page 2-38.
Related information
Rules for specifying command-line options.
Toolchain environment variables.
.C C or C++ source file On UNIX platforms, implies --cpp. On non-UNIX platforms, implies --c90.
.d Dependency list file .d is the default output filename suffix for files output using the --md option.
.pch Precompiled header file .pch is the default output filename suffix for files output using the --pch option.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05
onwards on all platforms. Note that ARM Compiler on Windows 8 never supported PCH
files.
.s ARM, Thumb, or mixed ARM For files in the input file list suffixed with .s, the compiler invokes the assembler,
and Thumb assembly language armasm, to assemble the file.
source file.
.s is the default output filename suffix for files output using either the option -S or --
asm.
.S ARM, Thumb, or mixed ARM On UNIX platforms, for files in the input file list suffixed with .S, the compiler
and Thumb assembly language preprocesses the assembly source before passing that source to the assembler.
source file.
On non-UNIX platforms, .S is equivalent to .s. That is, preprocessing is not performed.
.sx ARM, Thumb, or mixed ARM For files in the input file list suffixed with .sx, the compiler preprocesses the assembly
and Thumb assembly language source before passing that source to the assembler.
source file.
.txt Text file .txt is the default output filename suffix for files output using the -S or --asm option in
combination with the --interleave option.
Related references
8.7 --arm on page 8-326.
8.111 --interleave on page 8-442.
8.118 --list on page 8-450.
8.129 --md on page 8-462.
8.148 --pch on page 8-484.
8.168 -S on page 8-504.
8.29 --compile_all_input, --no_compile_all_input on page 8-353.
11.9 Template instantiation in ARM C++ on page 11-809.
Related information
ELF for the ARM Architecture.
2.9 Factors influencing how the compiler searches for header files
Several factors influence how the compiler searches for #include header files and source files.
• The value of the environment variable ARMCC5INC.
• The value of the environment variable ARMINC.
• The -I and -J compiler options.
• The --kandr_include and --sys_include compiler options.
• Whether the filename is an absolute filename or a relative filename.
• Whether the filename is between angle brackets or double quotes.
Related concepts
2.12 The ARMCC5INC environment variable on page 2-55.
2.11 Compiler search rules and the current place on page 2-54.
Related references
2.10 Compiler command-line options and search paths on page 2-53.
8.100 -Idir[,dir,...] on page 8-431.
8.112 -Jdir[,dir,...] on page 8-443.
8.113 --kandr_include on page 8-444.
8.179 --sys_include on page 8-517.
Related information
Toolchain environment variables.
-Jdir[,dir,...] The directory or directories specified by - 1. The current place on page 2-54.
Jdir[,dir,...]. 2. The directory or directories specified by -
Jdir[,dir,...].
Both -Idir[,dir,...] 1. The directory or directories specified 1. The current place on page 2-54.
and -Jdir[,dir,...] by -Jdir[,dir,...]. 2. The directory or directories specified by -
2. The directory or directories specified Idir[,dir,...].
by -Idir[,dir,...]. 3. The directory or directories specified by -
Jdir[,dir,...].
--sys_include No effect. Removes the current place on page 2-54 from the search
path.
--kandr_include No effect. Uses Kernighan and Ritchie search rules.
Related concepts
2.12 The ARMCC5INC environment variable on page 2-55.
2.11 Compiler search rules and the current place on page 2-54.
2.9 Factors influencing how the compiler searches for header files on page 2-52.
Related references
8.100 -Idir[,dir,...] on page 8-431.
8.112 -Jdir[,dir,...] on page 8-443.
8.113 --kandr_include on page 8-444.
8.179 --sys_include on page 8-517.
You can disable the stacking of current places by using the compiler option --kandr_include. This
option makes the compiler use Kernighan and Ritchie search rules whereby each nonrooted user
#include is searched for relative to the directory containing the source file that is being compiled.
Related concepts
2.12 The ARMCC5INC environment variable on page 2-55.
2.9 Factors influencing how the compiler searches for header files on page 2-52.
Related references
2.10 Compiler command-line options and search paths on page 2-53.
8.100 -Idir[,dir,...] on page 8-431.
8.112 -Jdir[,dir,...] on page 8-443.
8.113 --kandr_include on page 8-444.
8.179 --sys_include on page 8-517.
Related concepts
2.11 Compiler search rules and the current place on page 2-54.
2.9 Factors influencing how the compiler searches for header files on page 2-52.
Related references
2.10 Compiler command-line options and search paths on page 2-53.
8.100 -Idir[,dir,...] on page 8-431.
8.112 -Jdir[,dir,...] on page 8-443.
8.113 --kandr_include on page 8-444.
8.179 --sys_include on page 8-517.
Related information
Toolchain environment variables.
Related references
8.6 --apcs=qualifier...qualifier on page 8-322.
Related information
Procedure Call Standard for the ARM Architecture.
ARM C libraries and multithreading.
BPABI and SysV Shared Libraries and Executables.
Interworking ARM and Thumb.
The whole build is still driven by the build script, makefile, or other infrastructure you are using, and that
does not change. For example, a single compile step might fail when armcc tries to compile that step.
armcc then attempts to perform that single compile step with gcc. If a link step fails, armcc attempts to
perform the link with the GCC toolchain, using GNU ld. When armcc performs a compile or link step,
the include paths, library paths, and Linux libraries it uses are identified in the ARM Linux configuration
file. For fallback, you must either:
• Use the --arm_linux_config_file compiler option to produce the configuration file by configuring
armcc against an existing gcc.
• Provide an explicit path to gcc if you are specifying other configuration options manually.
The GCC toolchain used for fallback is the one that the configuration was created against. Therefore, the
paths and libraries used by armcc and gcc must be equivalent.
If armcc invokes GCC fallback, a warning message is displayed. If gcc also fails, an additional error is
displayed, otherwise you get a message indicating that gcc succeeded. You also see the original error
messages from armcc to inform you of the source file or files that failed to compile, and the cause of the
problem.
Note
• There is no change to what the ARM Compiler tools link with when using GCC fallback. That is, the
tools only link with whatever gcc links with, as identified in the configuration file generated with the
--arm_linux_config_file compiler option. Therefore, it is your responsibility to ensure that
licenses are adhered to, and in particular to check what you are linking with. You might have to
explicitly override this if necessary. To do this, include the GNU options -nostdinc,
-nodefaultlibs, and -nostdlib on the armcc command line.
• armcc invokes the GNU tools in a separate process.
• armcc does not optimize any code in any GCC intermediate representations.
To see the commands that are invoked during GCC fallback, specify the -Warmcc,--echo command-line
option.
The following figure shows a high-level view of the GCC fallback process:
Object files
Source files for
and libraries
compilation
for linking
armcc
driver Error: Pass
command-line
across GCC
ARM Compiler toolchain GCC toolchain
driver
Compile Compile
step step Error
Object
files Stop
Executable
image
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.71 --echo on page 8-399.
8.200 -Warmcc,option[,option,...] on page 8-542.
8.201 -Warmcc,--gcc_fallback on page 8-543.
Related information
GNU Compiler Collection, http://gcc.gnu.org.
Related concepts
2.16 Unused function code on page 2-60.
Related tasks
2.17 Minimizing code size by eliminating unused functions during compilation on page 2-61.
The linker option --feedback=filename creates a feedback file, and the --feedback_type option
controls the different types of feedback generated.
Related tasks
2.17 Minimizing code size by eliminating unused functions during compilation on page 2-61.
Related references
2.15 Linker feedback during compilation on page 2-59.
Procedure
1. Compile your source code.
2. Use the linker option --feedback=filename to create a feedback file.
3. Use the linker option --feedback_type to control which feedback the linker generates.
By default, the linker generates feedback to eliminate unused functions. This is equivalent to
--feedback_type=unused,noiw. The linker can also generate feedback to avoid compiling functions
for interworking that are never used in an interworking context. Use the linker option
--feedback_type=unused,iw to eliminate both types of unused function.
Note
Reduction of compilation required for interworking is only applicable to ARMv4T architectures.
ARMv5T and later processors can interwork without penalty.
4. Re-compile using the compiler option --feedback=filename to feed the feedback file to the
compiler.
The compiler uses the feedback file generated by the linker to compile the source code in a way that
enables the linker to subsequently discard the unused functions.
Note
To obtain maximum benefit from linker feedback, do a full compile and link at least twice. A single
compile and link using feedback from a previous build is normally sufficient to obtain some benefit.
Note
Always ensure that you perform a full clean build immediately before using the linker feedback file. This
minimizes the risk of the feedback file becoming out of date with the source code it was generated from.
You can specify the --feedback=filename option even when no feedback file exists. This enables you
to use the same build commands or makefile regardless of whether a feedback file exists, for example:
armcc -c --feedback=unused.txt test.c -o test.o
armlink --feedback=unused.txt test.o -o test.axf
The first time you build the application, it compiles normally but the compiler warns you that it cannot
read the specified feedback file because it does not exist. The link command then creates the feedback
file and builds the image. Each subsequent compilation step uses the feedback file from the previous link
step to remove any unused functions that are identified.
Related concepts
2.16 Unused function code on page 2-60.
Related references
2.15 Linker feedback during compilation on page 2-59.
8.82 --feedback=filename on page 8-410.
Related information
--feedback_type=type linker option.
About linker feedback.
Interworking ARM and Thumb.
Related tasks
2.18.2 Minimizing compilation build time on page 2-63.
Related references
2.18.3 Minimizing compilation build time with a single armcc invocation on page 2-64.
2.18.4 Effect of --multifile on compilation build time on page 2-64.
2.18.5 Minimizing compilation build time with parallel make on page 2-65.
2.18.6 Compilation build time and operating system choice on page 2-65.
5.13 Methods of reducing debug information in objects and libraries on page 5-170.
Related information
Optimizing license checkouts from a floating license server.
Licensed features of ARM Compiler.
• If you are using a makefile-based build environment, consider using a make tool that can apply some
form of parallelism.
• Consider your choice of operating system for cross-compilation. Linux generally gives better build
speed than Windows, but there are general performance-tuning techniques you can apply on
Windows that might help improve build times.
Related concepts
2.18.1 Compilation build time on page 2-62.
4.24 Precompiled Header (PCH) files on page 4-134.
5.14 Guarding against multiple inclusion of header files on page 5-171.
3.15 Vectorization on loops containing pointers on page 3-84.
Related references
2.18.3 Minimizing compilation build time with a single armcc invocation on page 2-64.
2.18.4 Effect of --multifile on compilation build time on page 2-64.
2.18.5 Minimizing compilation build time with parallel make on page 2-65.
2.18.6 Compilation build time and operating system choice on page 2-65.
5.13 Methods of reducing debug information in objects and libraries on page 5-170.
8.44 --create_pch=filename on page 8-371.
Related information
Licensed features of ARM Compiler.
Instead, you can try modifying your script to compile multiple files within a single invocation of armcc.
For example, armcc file1.c file2.c file3.c ...
For convenience, you can also list all your .c files in a single via file invoked with
armcc -via sources.txt.
Although this mechanism can dramatically reduce license checkouts and loading and unloading of the
compiler to give significant improvements in build time, the following limitations apply:
• All files are compiled with the same options.
• Converting existing build systems could be difficult.
• Usability depends on source file structure and dependencies.
• An IDE might be unable to report which file had compilation errors.
• After detecting an error, the compiler does not compile subsequent files.
Related concepts
2.18.1 Compilation build time on page 2-62.
Related tasks
2.18.2 Minimizing compilation build time on page 2-63.
Related references
8.134 --multifile, --no_multifile on page 8-467.
8.139 -Onum on page 8-473.
8.195 --via=filename on page 8-537.
Related information
Licensed features of ARM Compiler.
reduce compilation time as a result of time recovered from creating (opening and closing) multiple object
files.
Note
• In RVCT 4.0, if you compile with -O3, --multifile is enabled by default.
• In ARM Compiler 4.1 and later, --multifile is disabled by default, regardless of the optimization
level.
Related concepts
2.18.1 Compilation build time on page 2-62.
Related tasks
2.18.2 Minimizing compilation build time on page 2-63.
Related references
8.134 --multifile, --no_multifile on page 8-467.
8.139 -Onum on page 8-473.
Related information
Licensed features of ARM Compiler.
Related concepts
2.18.1 Compilation build time on page 2-62.
Related tasks
2.18.2 Minimizing compilation build time on page 2-63.
Related concepts
2.18.1 Compilation build time on page 2-62.
Related tasks
2.18.2 Minimizing compilation build time on page 2-63.
Related information
On what platforms will my ARM development tools work?.
Introduces the NEON unit and explains how to take advantage of automatic vectorizing features.
It contains the following sections:
• 3.1 NEON technology on page 3-69.
• 3.2 The NEON unit on page 3-70.
• 3.3 Methods of writing code for NEON on page 3-72.
• 3.4 Generating NEON instructions from C or C++ code on page 3-73.
• 3.5 NEON C extensions on page 3-74.
• 3.6 Automatic vectorization on page 3-75.
• 3.7 Data references within a vectorizable loop on page 3-76.
• 3.8 Stride patterns and data accesses on page 3-77.
• 3.9 Factors affecting NEON vectorization performance on page 3-78.
• 3.10 NEON vectorization performance goals on page 3-79.
• 3.11 Recommended loop structure for vectorization on page 3-80.
• 3.12 Data dependency conflicts when vectorizing code on page 3-81.
• 3.13 Carry-around scalar variables and vectorization on page 3-82.
• 3.14 Reduction of a vector to a scalar on page 3-83.
• 3.15 Vectorization on loops containing pointers on page 3-84.
• 3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
• 3.17 Nonvectorization on conditional loop exits on page 3-86.
• 3.18 Vectorizable loop iteration counts on page 3-87.
• 3.19 Indicating loop iteration counts to the compiler with __promise(expr) on page 3-89.
• 3.20 Grouping structure accesses for vectorization on page 3-91.
• 3.21 Vectorization and struct member lengths on page 3-92.
• 3.22 Nonvectorization of function calls to non-inline functions from within loops on page 3-93.
• 3.23 Conditional statements and efficient vectorization on page 3-94.
• 3.24 Vectorization diagnostics to tune code for improved performance on page 3-95.
• 3.25 Vectorizable code example on page 3-97.
• 3.26 DSP vectorizable code example on page 3-99.
• 3.27 What can limit or prevent automatic vectorization on page 3-101.
Note
The NEON register bank is shared with the VFP register bank.
Related concepts
3.2 The NEON unit on page 3-70.
The NEON unit is classified as a vector Single Instruction Multiple Data (SIMD) unit that operates on
multiple elements in a vector register by using one instruction.
For example, array A is a 16-bit integer array with 8 elements.
1 2 3 4 5 6 7 8
80 70 60 50 40 30 20 10
To add these arrays together, fetch each vector into a vector register and use one vector SIMD instruction
to obtain the result.
81 72 63 54 45 36 27 18
The NEON unit can only deal with vectors that are stored consecutively in memory, so it is not possible
to vectorize indirect addressing.
When writing structures, be aware that NEON structure loads require the structure to contain equal-sized
members.
Related concepts
3.3 Methods of writing code for NEON on page 3-72.
Related tasks
3.4 Generating NEON instructions from C or C++ code on page 3-73.
Related references
8.86 --fp16_format=format on page 8-414.
8.87 --fpmode=model on page 8-415.
8.192 --vectorize, --no_vectorize on page 8-534.
Related information
Introducing NEON Development Article.
Related concepts
3.2 The NEON unit on page 3-70.
3.6 Automatic vectorization on page 3-75.
3.8 Stride patterns and data accesses on page 3-77.
3.9 Factors affecting NEON vectorization performance on page 3-78.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.14 Reduction of a vector to a scalar on page 3-83.
3.15 Vectorization on loops containing pointers on page 3-84.
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.18 Vectorizable loop iteration counts on page 3-87.
3.19 Indicating loop iteration counts to the compiler with __promise(expr) on page 3-89.
3.20 Grouping structure accesses for vectorization on page 3-91.
3.21 Vectorization and struct member lengths on page 3-92.
3.22 Nonvectorization of function calls to non-inline functions from within loops on page 3-93.
3.23 Conditional statements and efficient vectorization on page 3-94.
3.24 Vectorization diagnostics to tune code for improved performance on page 3-95.
3.25 Vectorizable code example on page 3-97.
3.26 DSP vectorizable code example on page 3-99.
Related tasks
3.4 Generating NEON instructions from C or C++ code on page 3-73.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
3.5 NEON C extensions on page 3-74.
3.7 Data references within a vectorizable loop on page 3-76.
3.10 NEON vectorization performance goals on page 3-79.
3.11 Recommended loop structure for vectorization on page 3-80.
3.27 What can limit or prevent automatic vectorization on page 3-101.
You can also use --diag_warning=optimizations to obtain useful diagnostics from the compiler on
what it can and cannot optimize or vectorize. For example:
armcc --cpu Cortex-A8 --vectorize -O3 -Otime --diag_warning=optimizations source.c
Note
To run code that contains NEON instructions, you must enable both the FPU and NEON.
Related concepts
5.5 Enabling NEON and FPU for bare-metal on page 5-158.
Related tasks
5.4 Selecting the target processor at compile time on page 5-157.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
8.42 --cpu=list on page 8-367.
8.43 --cpu=name on page 8-368.
3.5 NEON C extensions on page 3-74.
Related information
Licensed features of ARM Compiler.
Related concepts
3.3 Methods of writing code for NEON on page 3-72.
Related references
Chapter 18 Using NEON Support on page 18-923.
Related concepts
3.8 Stride patterns and data accesses on page 3-77.
3.9 Factors affecting NEON vectorization performance on page 3-78.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.14 Reduction of a vector to a scalar on page 3-83.
3.15 Vectorization on loops containing pointers on page 3-84.
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.18 Vectorizable loop iteration counts on page 3-87.
3.19 Indicating loop iteration counts to the compiler with __promise(expr) on page 3-89.
3.20 Grouping structure accesses for vectorization on page 3-91.
3.21 Vectorization and struct member lengths on page 3-92.
3.22 Nonvectorization of function calls to non-inline functions from within loops on page 3-93.
3.23 Conditional statements and efficient vectorization on page 3-94.
3.25 Vectorizable code example on page 3-97.
3.26 DSP vectorizable code example on page 3-99.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
3.7 Data references within a vectorizable loop on page 3-76.
3.10 NEON vectorization performance goals on page 3-79.
3.11 Recommended loop structure for vectorization on page 3-80.
3.27 What can limit or prevent automatic vectorization on page 3-101.
Related concepts
3.8 Stride patterns and data accesses on page 3-77.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
Related references
3.7 Data references within a vectorizable loop on page 3-76.
Related concepts
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.15 Vectorization on loops containing pointers on page 3-84.
3.14 Reduction of a vector to a scalar on page 3-83.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
3.10 NEON vectorization performance goals on page 3-79.
3.11 Recommended loop structure for vectorization on page 3-80.
3.10 NEON vectorization performance goals on page 3-79.
Related concepts
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.15 Vectorization on loops containing pointers on page 3-84.
3.14 Reduction of a vector to a scalar on page 3-83.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
3.9 Factors affecting NEON vectorization performance on page 3-78.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
3.11 Recommended loop structure for vectorization on page 3-80.
Related concepts
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.15 Vectorization on loops containing pointers on page 3-84.
3.14 Reduction of a vector to a scalar on page 3-83.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
3.9 Factors affecting NEON vectorization performance on page 3-78.
3.23 Conditional statements and efficient vectorization on page 3-94.
3.17 Nonvectorization on conditional loop exits on page 3-86.
Related references
3.10 NEON vectorization performance goals on page 3-79.
8.192 --vectorize, --no_vectorize on page 8-534.
Information from other array subscripts is used as part of the analysis of dependencies. The loop in the
following example vectorizes because the nonvector subscripts of the references to array a can never be
equal. They can never be equal because n is not equal to n+1 and so gives no feedback between
iterations. The references to array a use two different pieces of the array, so they do not share data.
float a[99][99], b[99], c[99];
int i, n;
...
for (i = 1; i < 99; i++)
{
a[n][i] = a[n+1][i-1] * b[i] + c[i];
}
Related concepts
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.15 Vectorization on loops containing pointers on page 3-84.
3.14 Reduction of a vector to a scalar on page 3-83.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.9 Factors affecting NEON vectorization performance on page 3-78.
Related references
3.11 Recommended loop structure for vectorization on page 3-80.
3.10 NEON vectorization performance goals on page 3-79.
8.192 --vectorize, --no_vectorize on page 8-534.
A scalar that is used and then set in a loop is called a carry-around scalar. These variables are a problem
for vectorization because the value computed in one pass of the loop is carried forward into the next pass.
In the following example, x is a carry-around scalar.
Nonvectorizable loop
float a[99], b[99], x;
int i, n;
...
for (i = 0; i < n; i++)
{
a[i] = x + b[i];
x = a[i] + 1/x;
};
Related concepts
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.15 Vectorization on loops containing pointers on page 3-84.
3.14 Reduction of a vector to a scalar on page 3-83.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
3.9 Factors affecting NEON vectorization performance on page 3-78.
Related references
3.11 Recommended loop structure for vectorization on page 3-80.
3.10 NEON vectorization performance goals on page 3-79.
8.192 --vectorize, --no_vectorize on page 8-534.
Reduction operations are worth vectorizing because they occur so often. In general, reduction operations
are vectorized by creating a vector of partial reductions that is then reduced into the final resulting scalar.
Related concepts
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.15 Vectorization on loops containing pointers on page 3-84.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
3.9 Factors affecting NEON vectorization performance on page 3-78.
Related references
3.11 Recommended loop structure for vectorization on page 3-80.
3.10 NEON vectorization performance goals on page 3-79.
8.192 --vectorize, --no_vectorize on page 8-534.
The compiler is able to vectorize loops containing pointers if it can determine that the loop is safe. Both
array references and pointer references in loops are analyzed to see if there is any vector access to
memory. In some cases, the compiler creates a run-time test, and executes a vector version or scalar
version of the loop depending on the result of the test.
Often, function arguments are passed as pointers. If several pointer variables are passed to a function, it
is possible that pointing to overlapping sections of memory can occur. Often, at runtime, this is not the
case but the compiler always follows the safe method and avoids optimizing loops that involve pointers
appearing on both the left and right sides of an assignment operator. For example, consider the following
function.
void func (int *pa, int *pb, int x)
{
int i;
for (i = 0; i < 100; i++)
{
*(pa + i) = *(pb + i) + x;
}
};
In this example, if pa and pb overlap in memory in a way that causes results from one loop pass to feed
back to a subsequent loop pass, then vectorization of the loop can give incorrect results. If the function is
called with the following arguments, vectorization might be ambiguous:
int *a;
The compiler performs a runtime test to see if pointer aliasing occurs. If pointer aliasing does not occur,
it executes a vectorized version of the code. If pointer aliasing occurs, the original nonvectorized code
executes instead. This leads to a small cost in runtime efficiency and code size.
In practice, it is very rare for data dependence to exist because of function arguments. Programs that pass
overlapping pointers are very hard to understand and debug, apart from any vectorization concerns.
In the example above, adding restrict to pa is sufficient to avoid the runtime test.
Related concepts
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.14 Reduction of a vector to a scalar on page 3-83.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
3.9 Factors affecting NEON vectorization performance on page 3-78.
Related references
3.11 Recommended loop structure for vectorization on page 3-80.
3.10 NEON vectorization performance goals on page 3-79.
8.192 --vectorize, --no_vectorize on page 8-534.
8.164 --restrict, --no_restrict on page 8-500.
9.13 restrict on page 9-563.
Indirect addressing is not vectorizable with the NEON unit because it can only deal with vectors that are
stored consecutively in memory. If there is indirect addressing and significant calculations in a loop, it
might be more efficient for you to move the indirect addressing into a separate non vector loop. This
enables the calculations to vectorize efficiently.
Related concepts
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.15 Vectorization on loops containing pointers on page 3-84.
3.14 Reduction of a vector to a scalar on page 3-83.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
3.9 Factors affecting NEON vectorization performance on page 3-78.
Related references
3.11 Recommended loop structure for vectorization on page 3-80.
3.10 NEON vectorization performance goals on page 3-79.
8.192 --vectorize, --no_vectorize on page 8-534.
Related concepts
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.15 Vectorization on loops containing pointers on page 3-84.
3.14 Reduction of a vector to a scalar on page 3-83.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
3.9 Factors affecting NEON vectorization performance on page 3-78.
3.23 Conditional statements and efficient vectorization on page 3-94.
Related references
3.11 Recommended loop structure for vectorization on page 3-80.
3.10 NEON vectorization performance goals on page 3-79.
8.192 --vectorize, --no_vectorize on page 8-534.
3.11 Recommended loop structure for vectorization on page 3-80.
/* myprog1.c */ /* myprog2.c */
int a[99], b[99], c[99], i, n; int a[99], b[99], c[99], i, n;
... ...
for (i = 0; i < n; i++) while (i < n)
{ {
a[i] = b[i] + c[i]; a[i] = b[i] + c[i];
} i += a[i];
};
armcc --cpu=Cortex-A8 -O3 -Otime --vectorize myprog1.c - armcc --cpu=Cortex-A8 -O3 -Otime --
o- vectorize myprog2.c -o-
ARM ARM
REQUIRE8 REQUIRE8
PRESERVE8 PRESERVE8
AREA ||.text||, CODE, READONLY, ALIGN=2 AREA ||.text||, CODE, READONLY, ALIGN=2
|L1.56| |L1.36|
VLD1.32 {d0,d1},[r1]! LDR r1,[r12,r0,LSL #2]
SUBS r0,r0,#1 LDR r6,[r4,r0,LSL #2]
VLD1.32 {d2,d3},[r2]! ADD r1,r1,r6
VADD.I32 q0,q0,q1 STR r1,[r5,r0,LSL #2]
VST1.32 {d0,d1},[r3]! ADD r0,r0,r1
BNE |L1.56| CMP r0,r2
STR r0,[r3,#0] ; i
BLT |L1.36|
POP {r4-r6}
BX lr
ENDP
|L1.80|
AND r0,r12,#3
CMP r0,#0
BLE |L1.144|
SUB r0,r12,r0
CMP r0,r12
BGE |L1.144|
LDR r1,|L1.164|
ADD r2,r1,#0x18c
SUB r3,r2,#0x318
|L1.116|
LDR r5,[r1,r0,LSL #2]
LDR r6,[r2,r0,LSL #2]
ADD r5,r5,r6
STR r5,[r3,r0,LSL #2]
ADD r0,r0,#1
CMP r0,r12
BLT |L1.116|
|L1.144|
LDR r0,[r4,#4] ; n
STR r0,[r4,#0] ; i
|L1.152|
POP {r4-r6}
BX lr
ENDP
Related concepts
3.19 Indicating loop iteration counts to the compiler with __promise(expr) on page 3-89.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
The __promise intrinsic is required to enable vectorization if the loop iteration count at the start of the
loop is unknown, providing you can make the promise that you claim to make.
This reduces the size of the generated code and can give a performance improvement.
The disassembled output of the example code below illustrates the difference that __promise makes. The
disassembly is reduced to a simple vectorized loop with the removal of nonvectorized code that would
otherwise have been required for possible additional loop iterations. That is, loop iterations beyond those
that are a multiple of the lanes that can be used for the appropriate data type in a NEON register. (The
additional nonvectorized code is known as a scalar fix-up loop. With the use of the __promise(expr)
intrinsic, the scalar fix-up loop is removed.)
/* promise.c */
void f(int *x, int n)
{
int i;
__promise((n > 0) && ((n & 7) == 0));
for (i=0; i < n; i++) x[i]++;
}
When compiling for a processor that supports NEON, the disassembled output might be similar to the
following, for example:
ARM
REQUIRE8
PRESERVE8
AREA ||.text||, CODE, READONLY, ALIGN=2
f PROC
VMOV.I32 q0,#0x1
ASR r1,r1,#2
|L0.8|
VLD1.32 {d2,d3},[r0]
SUBS r1,r1,#1
VADD.I32 q1,q1,q0
VST1.32 {d2,d3},[r0]!
BNE |L0.8|
BX lr
ENDP
Related concepts
3.18 Vectorizable loop iteration counts on page 3-87.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
8.164 --restrict, --no_restrict on page 8-500.
9.13 restrict on page 9-563.
10.131 __promise intrinsic on page 10-742.
Related concepts
3.21 Vectorization and struct member lengths on page 3-92.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
This code could be rewritten for vectorization by using the same data type throughout the structure. For
example, if the variable b is to be of type int, consider making variables a and c of type int rather than
short.
Related concepts
3.20 Grouping structure accesses for vectorization on page 3-91.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
10.8 __inline on page 10-608.
10.6 __forceinline on page 10-605.
Related concepts
3.17 Nonvectorization on conditional loop exits on page 3-86.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
3.11 Recommended loop structure for vectorization on page 3-80.
The following example shows two functions that implement a simple sum operation on an array. This
code does not vectorize.
int addition(int a, int b)
{
return a + b;
}
void add_int(int *pa, int *pb, unsigned int n, int x)
{
unsigned int i;
for(i = 0; i < n; i++) *(pa + i) = addition(*(pb + i),x);
/* Function calls cannot be vectorized */
}
Using the --diag_warning=optimizations option produces an optimization warning message for the
addition() function:
The final improvement you can make is to indicate the number of loop iterations. In the previous
example, the number of iterations is not fixed and might not be a multiple that can fit exactly into a
NEON register. This means that the compiler must test for remaining iterations to execute using
nonvectored code. If you know that your iteration count is divisible by the number of elements that the
NEON unit can operate on in parallel, you can indicate this to the compiler using the __promise
intrinsic. The following example shows the final code that obtains the best performance from
vectorization.
__inline int addition(int a, int b)
{
return a + b;
}
void add_int(int * __restrict pa, int * __restrict pb, unsigned int n, int x)
{
unsigned int i;
__promise((n % 4) == 0);
/* n is a multiple of 4 */
for(i = 0; i < (n & ~3); i++) *(pa + i) = addition(*(pb + i),x);
}
Related concepts
3.25 Vectorizable code example on page 3-97.
3.26 DSP vectorizable code example on page 3-99.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.164 --restrict, --no_restrict on page 8-500.
9.13 restrict on page 9-563.
Related concepts
3.26 DSP vectorizable code example on page 3-99.
3.24 Vectorization diagnostics to tune code for improved performance on page 3-95.
7.26 Embedded assembler support in the compiler on page 7-291.
3.25 Vectorizable code example on page 3-97.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
8.43 --cpu=name on page 8-368.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
10.161 Predefined macros on page 10-786.
8.164 --restrict, --no_restrict on page 8-500.
9.13 restrict on page 9-563.
Related information
--entry=location linker option.
Related concepts
3.26 DSP vectorizable code example on page 3-99.
3.24 Vectorization diagnostics to tune code for improved performance on page 3-95.
7.26 Embedded assembler support in the compiler on page 7-291.
3.25 Vectorizable code example on page 3-97.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
8.43 --cpu=name on page 8-368.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
10.161 Predefined macros on page 10-786.
8.164 --restrict, --no_restrict on page 8-500.
9.13 restrict on page 9-563.
Related information
--entry=location linker option.
Not having a valid NEON compiler You might require a valid NEON compiler license to generate NEON instructions, depending on
license. your compiler version.
RVCT 3.1 or later, and ARM Compiler 4.1, require a valid NEON compiler license.
ARM Compiler 5.01 and later do not require a separate NEON compiler license.
Source code without loops. Automatic vectorization involves loop analysis. Without loops, automatic vectorization cannot
apply.
Target processor. The target processor (--cpu) must have NEON capability if NEON instructions are to be
generated. For example, Cortex-A7, Cortex-A8, Cortex-A9, Cortex-A12, or Cortex-A15.
Floating-point code. Vectorization of floating-point code does not always occur automatically. For example, loops
that require re-association only vectorize when compiled with --fpmode fast.
--no_vectorize by default. By default, generation of NEON vector instructions directly from C or C++ code is disabled,
and must be enabled with --vectorize.
-Otime not specified. -Otime must be specified to reduce execution time and enable loops to vectorize.
-Onum not set high enough. The optimization level you set must be -O2 or -O3. Loops do not vectorize at -O0 or -O1.
Risk of incorrect results. If there is a risk of an incorrect result, vectorization is not applied where that risk occurs. You
might have to manually tune your code to make it more suitable for automatic vectorization.
Earlier manual optimization Automatic vectorization can be impeded by earlier manual optimization attempts. For example,
attempts. manual loop unrolling in the source code, or complex array accesses.
No vector access pattern. If variables in a loop lack a vector access pattern, the compiler cannot automatically vectorize
the loop.
Data dependencies between Where there is a possibility of the use and storage of arrays overlapping on different iterations of
different iterations of a loop. a loop, there is a data dependency problem. A loop cannot be safely vectorized if the vector
order of operations can change the results, so the compiler leaves the loop in its original form or
only partially vectorizes the loop.
Memory hierarchy. Performing relatively few arithmetic operations on large data sets retrieved from main memory
is limited by the memory bandwidth of the system. Most processors are relatively unbalanced
between memory bandwidth and processor capacity. This can adversely affect the automatic
vectorization process.
Iteration count not fixed at start of For automatic vectorization, it is generally best to write simple loops with iterations that are
loop. fixed at the start of the loop. If a loop does not have a fixed iteration count, automatic addressing
is not possible.
Conditional loop exits. It is best to write loops that do not contain conditional exits from the loop.
Carry-around scalar variables. Carry-around scalar variables are a problem for automatic vectorization because the value
computed in one pass of the loop is carried forward into the next pass.
__promise(expr) not used. Failure to use __promise(expr) where it could make a difference to automatic vectorization
can limit automatic vectorization.
Pointer aliasing. Pointer aliasing prevents the use of automatically vectorized code.
Indirect addressing. Indirect addressing is not vectorizable because the NEON unit can only deal with vectors stored
consecutively in memory.
Separating access to different parts Each part of a structure must be accessed within the same loop for automatic vectorization to
of a structure into separate loops. occur.
Inconsistent length of members If members of a structure are not all the same length, the compiler does not attempt to use vector
within a structure. loads.
Calls to non-inline functions. Calls to non-inline functions from within a loop inhibits vectorization. If such functions are to
be considered for vectorization, they must be marked with the __inline or __forceinline
keywords.
if and switch statements. Extensive use of if and switch statements can affect the efficiency of automatic
vectorization.
You can use --diag_warning=optimizations to obtain compiler diagnostics on what can and cannot
be vectorized.
Related concepts
3.9 Factors affecting NEON vectorization performance on page 3-78.
3.12 Data dependency conflicts when vectorizing code on page 3-81.
3.17 Nonvectorization on conditional loop exits on page 3-86.
3.13 Carry-around scalar variables and vectorization on page 3-82.
3.16 Nonvectorization on loops containing pointers and indirect addressing on page 3-85.
3.18 Vectorizable loop iteration counts on page 3-87.
3.19 Indicating loop iteration counts to the compiler with __promise(expr) on page 3-89.
3.20 Grouping structure accesses for vectorization on page 3-91.
3.21 Vectorization and struct member lengths on page 3-92.
3.22 Nonvectorization of function calls to non-inline functions from within loops on page 3-93.
3.23 Conditional statements and efficient vectorization on page 3-94.
3.24 Vectorization diagnostics to tune code for improved performance on page 3-95.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
3.7 Data references within a vectorizable loop on page 3-76.
3.11 Recommended loop structure for vectorization on page 3-80.
9.13 restrict on page 9-563.
8.42 --cpu=list on page 8-367.
8.43 --cpu=name on page 8-368.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
10.6 __forceinline on page 10-605.
8.87 --fpmode=model on page 8-415.
10.8 __inline on page 10-608.
8.139 -Onum on page 8-473.
8.144 -Otime on page 8-480.
8.164 --restrict, --no_restrict on page 8-500.
10.131 __promise intrinsic on page 10-742.
• 4.23 Using compiler and linker support for symbol versions on page 4-133.
• 4.24 Precompiled Header (PCH) files on page 4-134.
• 4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
• 4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
• 4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
• 4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
• 4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
• 4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file
on page 4-143.
• 4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
• 4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
• 4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
• 4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
• 4.35 Default compiler options that are affected by optimization level on page 4-148.
Using compiler intrinsics, you can achieve more complete coverage of target architecture instructions
than you would from the instruction selection of the compiler.
An intrinsic function has the appearance of a function call in C or C++, but is replaced during
compilation by a specific sequence of low-level instructions. When implemented using an intrinsic, for
example, the saturated add function previous example has the form:
#include <dspfns.h> /* Include ETSI intrinsics */
...
int a, b, result;
...
result = L_add(a, b); /* Saturated add of a and b */
Related concepts
4.5 Compiler intrinsics for controlling IRQ and FIQ interrupts on page 4-109.
4.12 NEON intrinsics provided by the compiler on page 4-118.
4.9 Compiler support for European Telecommunications Standards Institute (ETSI) basic operations
on page 4-114.
4.11 Texas Instruments (TI) C55x intrinsics for optimizing C code on page 4-117.
Related references
4.2 Performance benefits of compiler intrinsics on page 4-106.
4.3 ARM assembler instruction intrinsics on page 4-107.
10.154 ETSI basic operations on page 10-768.
10.105 Instruction intrinsics on page 10-713.
10.155 C55x intrinsics on page 10-770.
Chapter 18 Using NEON Support on page 18-923.
Related concepts
4.1 Compiler intrinsics on page 4-105.
4.5 Compiler intrinsics for controlling IRQ and FIQ interrupts on page 4-109.
4.12 NEON intrinsics provided by the compiler on page 4-118.
4.9 Compiler support for European Telecommunications Standards Institute (ETSI) basic operations
on page 4-114.
4.11 Texas Instruments (TI) C55x intrinsics for optimizing C code on page 4-117.
Related concepts
4.1 Compiler intrinsics on page 4-105.
4.5 Compiler intrinsics for controlling IRQ and FIQ interrupts on page 4-109.
4.12 NEON intrinsics provided by the compiler on page 4-118.
4.9 Compiler support for European Telecommunications Standards Institute (ETSI) basic operations
on page 4-114.
4.11 Texas Instruments (TI) C55x intrinsics for optimizing C code on page 4-117.
4.6 Compiler intrinsics for inserting optimization barriers on page 4-110.
4.8 Compiler intrinsics for Digital Signal Processing (DSP) on page 4-113.
Related references
4.4 Generic intrinsics on page 4-108.
4.7 Compiler intrinsics for inserting native instructions on page 4-112.
Related references
10.106 __breakpoint intrinsic on page 10-714.
10.110 __current_pc intrinsic on page 10-718.
10.111 __current_sp intrinsic on page 10-719.
10.127 __nop intrinsic on page 10-737.
10.137 __return_address intrinsic on page 10-748.
10.140 __semihost intrinsic on page 10-751.
10.160 GNU built-in functions on page 10-778.
Related concepts
4.1 Compiler intrinsics on page 4-105.
4.12 NEON intrinsics provided by the compiler on page 4-118.
4.9 Compiler support for European Telecommunications Standards Institute (ETSI) basic operations
on page 4-114.
4.11 Texas Instruments (TI) C55x intrinsics for optimizing C code on page 4-117.
Related references
4.2 Performance benefits of compiler intrinsics on page 4-106.
4.3 ARM assembler instruction intrinsics on page 4-107.
10.112 __disable_fiq intrinsic on page 10-720.
10.113 __disable_irq intrinsic on page 10-721.
10.116 __enable_fiq intrinsic on page 10-725.
10.117 __enable_irq intrinsic on page 10-726.
__dsb() DSB
__dmb() DMB
__isb() ISB
The memory barrier intrinsic also implicitly adds an optimization barrier intrinsic, and applies an
operand to the inserted instruction. The argument passed to either __dsb(), or __dmb() defines which
optimization barrier is added, and which operand is applied.
1 OSH __force_loads()
2 OSHST __force_stores()
3 OSH __memory_changed()
5 NSH __force_loads()
6 NSHST __force_stores()
7 NSH __memory_changed()
9 ISH __force_loads()
10 ISHST __force_stores()
11 ISH __memory_changed()
13 SY __force_loads()
(continued)
14 ST __force_stores()
15 SY __memory_changed()
Example
__dsb(5) inserts DSB NSH into the instruction stream, and implicitly adds the __force_loads()
optimization barrier intrinsic.
Note
• For__isb(), the only supported operand is SY.
• When compiling for an ARMv7-M target, all intrinsic arguments passed to __isb(), __dmb() and
__dsb() emit the SY operand.
Related references
10.121 __force_stores intrinsic on page 10-730.
10.126 __memory_changed intrinsic on page 10-736.
10.139 __schedule_barrier intrinsic on page 10-750.
10.120 __force_loads intrinsic on page 10-729.
10.122 __isb intrinsic on page 10-731.
10.114 __dmb intrinsic on page 10-723.
10.115 __dsb intrinsic on page 10-724.
Related information
DMB.
DSB.
ISB.
Related references
10.107 __cdp intrinsic on page 10-715.
10.108 __clrex intrinsic on page 10-716.
10.123 __ldrex intrinsic on page 10-732.
10.125 __ldrt intrinsic on page 10-735.
10.128 __pld intrinsic on page 10-739.
10.130 __pli intrinsic on page 10-741.
10.135 __rbit intrinsic on page 10-746.
10.136 __rev intrinsic on page 10-747.
10.138 __ror intrinsic on page 10-749.
10.141 __sev intrinsic on page 10-753.
10.145 __strex intrinsic on page 10-757.
10.147 __strt intrinsic on page 10-761.
10.148 __swp intrinsic on page 10-762.
10.150 __wfe intrinsic on page 10-764.
10.151 __wfi intrinsic on page 10-765.
10.152 __yield intrinsic on page 10-766.
Related references
10.109 __clz intrinsic on page 10-717.
10.118 __fabs intrinsic on page 10-727.
10.119 __fabsf intrinsic on page 10-728.
10.132 __qadd intrinsic on page 10-743.
10.133 __qdbl intrinsic on page 10-744.
10.134 __qsub intrinsic on page 10-745.
10.142 __sqrt intrinsic on page 10-754.
10.143 __sqrtf intrinsic on page 10-755.
10.144 __ssat intrinsic on page 10-756.
10.149 __usat intrinsic on page 10-763.
10.153 ARMv6 SIMD intrinsics on page 10-767.
Note
Version 2.0 of the ETSI collection of basic operations, as described in the ITU-T Software Tool Library
2005 User's manual, introduces new 16-bit, 32-bit and 40 bit-operations. These operations are not
supported in the ARM compilation tools.
The ETSI basic operations serve as a set of primitives for developers publishing codec algorithms, rather
than as a library for use by developers implementing codecs in C or C++.
ARM Compiler 4.1 and later provide support for the ETSI basic operations through the header file
dspfns.h. The dspfns.h header file contains definitions of the ETSI basic operations as a combination
of C code and intrinsics.
See dspfns.h for a complete list of the ETSI basic operations supported in ARM Compiler 4.1 and later.
ARM Compiler 4.1 and later support the original ETSI family of basic operations as described in the
ETSI G.729 recommendation Coding of speech at 8 kbit/s using conjugate-structure algebraic-code-
excited linear prediction (CS-ACELP), including:
• 16-bit and 32-bit saturated arithmetic operations, such as add and sub. For example, add(v1, v2)
adds two 16-bit numbers v1 and v2 together, with overflow control and saturation, returning a 16-bit
result.
• 16-bit and 32-bit multiplication operations, such as mult and L_mult. For example, mult(v1, v2)
multiplies two 16-bit numbers v1 and v2 together, returning a scaled 16-bit result.
• 16-bit arithmetic shift operations, such as shl and shr. For example, the saturating left shift operation
shl(v1, v2) arithmetically shifts the 16-bit input v1 left v2 positions. A negative shift count shifts
v1 right v2 positions.
• 16-bit data conversion operations, such as extract_l, extract_h, and round. For example,
round(L_v1) rounds the lower 16 bits of the 32-bit input L_v1 into the most significant 16 bits with
saturation.
Note
Beware that both the dspfns.h header file and the ISO C99 header file math.h both define (different
versions of) the function round(). Take care to avoid this potential conflict.
Related concepts
4.1 Compiler intrinsics on page 4-105.
4.5 Compiler intrinsics for controlling IRQ and FIQ interrupts on page 4-109.
4.12 NEON intrinsics provided by the compiler on page 4-118.
4.11 Texas Instruments (TI) C55x intrinsics for optimizing C code on page 4-117.
4.10 Overflow and carry status flags for C and C++ code on page 4-116.
Related references
4.2 Performance benefits of compiler intrinsics on page 4-106.
4.3 ARM assembler instruction intrinsics on page 4-107.
10.154 ETSI basic operations on page 10-768.
4.10 Overflow and carry status flags for C and C++ code
The implementation of the European Telecommunications Standards Institute (ETSI) basic operations in
dspfns.h exposes the status flags Overflow and Carry.
These flags are available as global variables for use in your own C or C++ programs. For example:
#include <dspfns.h> /* include ETSI intrinsics */
#include <stdio.h>
...
const int BUFLEN=255;
int a[BUFLEN], b[BUFLEN], c[BUFLEN];
...
Overflow = 0; /* clear overflow flag */
for (i = 0; i < BUFLEN; ++i) {
c[i] = L_add(a[i], b[i]); /* saturated add of a[i] and b[i] */
}
if (Overflow)
{
fprintf(stderr, "Overflow on saturated addition\n");
}
Generally, saturating functions have a sticky effect on overflow. That is, the overflow flag remains set
until it is explicitly cleared.
Related concepts
4.9 Compiler support for European Telecommunications Standards Institute (ETSI) basic operations
on page 4-114.
Related concepts
4.1 Compiler intrinsics on page 4-105.
4.5 Compiler intrinsics for controlling IRQ and FIQ interrupts on page 4-109.
4.12 NEON intrinsics provided by the compiler on page 4-118.
4.9 Compiler support for European Telecommunications Standards Institute (ETSI) basic operations
on page 4-114.
Related references
4.2 Performance benefits of compiler intrinsics on page 4-106.
4.3 ARM assembler instruction intrinsics on page 4-107.
Related information
Texas Instruments, http://www.ti.com.
Related concepts
4.1 Compiler intrinsics on page 4-105.
4.5 Compiler intrinsics for controlling IRQ and FIQ interrupts on page 4-109.
4.9 Compiler support for European Telecommunications Standards Institute (ETSI) basic operations
on page 4-114.
4.11 Texas Instruments (TI) C55x intrinsics for optimizing C code on page 4-117.
3.2 The NEON unit on page 3-70.
3.3 Methods of writing code for NEON on page 3-72.
Related tasks
4.13 Using NEON intrinsics on page 4-119.
Related references
4.2 Performance benefits of compiler intrinsics on page 4-106.
4.3 ARM assembler instruction intrinsics on page 4-107.
Chapter 18 Using NEON Support on page 18-923.
Procedure
1. Create the following example C program source code:
/* neon_example.c - Neon intrinsics example program */
#include <stdint.h>
#include <stdio.h>
#include <assert.h>
#include <arm_neon.h>
/* fill array with increasing integers beginning with 0 */
void fill_array(int16_t *array, int size)
{
int i;
for (i = 0; i < size; i++)
{
array[i] = i;
}
}
/* return the sum of all elements in an array. This works by calculating 4 totals (one
for each lane) and adding those at the end to get the final total */
int sum_array(int16_t *array, int size)
{
/* initialize the accumulator vector to zero */
int16x4_t acc = vdup_n_s16(0);
int32x2_t acc1;
int64x1_t acc2;
/* this implementation assumes the size of the array is a multiple of 4 */
assert((size % 4) == 0);
/* counting backwards gives better code */
for (; size != 0; size -= 4)
{
int16x4_t vec;
/* load 4 values in parallel from the array */
vec = vld1_s16(array);
/* increment the array pointer to the next element */
array += 4;
/* add the vector to the accumulator vector */
acc = vadd_s16(acc, vec);
}
/* calculate the total */
acc1 = vpaddl_s16(acc);
acc2 = vpaddl_s32(acc1);
/* return the total as an integer */
return (int)vget_lane_s64(acc2, 0);
}
/* main function */
int main()
{
int16_t my_array[100];
fill_array(my_array, 100);
printf("Sum was %d\n", sum_array(my_array, 100));
return 0;
}
Related concepts
4.12 NEON intrinsics provided by the compiler on page 4-118.
Related references
8.21 -c on page 8-344.
8.43 --cpu=name on page 8-368.
4.14 Compiler support for accessing registers using named register variables
You can use named register variables to access registers of an ARM architecture-based processor.
Named register variables are declared by combining the register keyword with the __asm keyword.
The __asm keyword takes one parameter, a character string, that names the register. For example, the
following declaration declares R0 as a named register variable for the register r0:
register int R0 __asm("r0");
Any type of the same size as the register being named can be used in the declaration of a named register
variable. The type can be a structure, but bitfield layout is sensitive to endianness.
Note
Writing to the current stack pointer, "r13" or "sp", can give unpredictable results at either compile-time
or run-time.
You must declare core registers as global rather than local named register variables. Your program might
still compile if you declare them locally, but you risk unexpected runtime behavior if you do. There is no
restriction on the scope of named register variables for other registers.
Note
A global named register variable is global to the source file in which it is declared, not global to the
program. It has no effect on other files, unless you use multifile compilation or you declare it in a header
file.
A typical use of named register variables is to access bits in the Application Program Status Register
(APSR). The following example shows how to use named register variables to set the saturation flag Q in
the APSR.
#ifndef __BIG_ENDIAN // bitfield layout of APSR is sensitive to endianness
typedef union
{
struct
{
int mode:5;
int T:1;
int F:1;
int I:1;
int _dnm:19;
int Q:1;
int V:1;
int C:1;
int Z:1;
int N:1;
} b;
unsigned int word;
} PSR;
#else /* __BIG_ENDIAN */
typedef union
{
struct
{
int N:1;
int Z:1;
int C:1;
int V:1;
int Q:1;
int _dnm:19;
int I:1;
int F:1;
int T:1;
int mode:5;
} b;
unsigned int word;
} PSR;
#endif /* __BIG_ENDIAN */
/* Declare PSR as a register variable for the "apsr" register */
register PSR apsr __asm("apsr");
void set_Q(void)
{
apsr.b.Q = 1;
}
The following example shows how to use a named register variable to clear the Q flag in the APSR.
register unsigned int _apsr __asm("apsr");
void ClearQFlag(void)
{
_apsr = _apsr & ~0x08000000; // clear Q flag
}
Compiling this example using --cpu=7-M results in the following assembly code:
ClearQFlag
MRS r0,APSR ; formerly CPSR
BIC r0,r0,#0x80000000
MSR APSR_nzcvq,r0; formerly CPSR_f
BX lr
The following example shows how to use named register variables to set up stack pointers.
register unsigned int _control __asm("control");
register unsigned int _msp __asm("msp");
register unsigned int _psp __asm("psp");
void init(void)
{
_msp = 0x30000000; // set up Main Stack Pointer
_control = _control | 3; // switch to User Mode with Process Stack
_psp = 0x40000000; // set up Process Stack Pointer
}
Compiling this example using --cpu=7-M results in the following assembly code:
init
MOV r0,0x30000000
MSR MSP,r0
MRS r0,CONTROL
ORR r0,r0,#3
MSR CONTROL,r0
MOV r0,#0x40000000
MSR PSP,r0
BX lr
You can also use named register variables to access registers within a coprocessor. The string syntax
within the declaration corresponds to how you intend to use the variable. For example, to declare a
variable that you intend to use with the MCR instruction, look up the instruction syntax for this instruction
and use this syntax when you declare your variable. The following example shows how to use a named
register variable to set bits in a coprocessor register.
register unsigned int PMCR __asm("cp15:0:c9:c12:0");
void __reset_cycle_counter(void)
{
PMCR = 4;
}
Compiling this example using --cpu=7-M results in the following assembly code:
__reset_cycle_counter PROC
MOV r0,#4
MCR p15,#0x0,r0,c9,c12,#0 ; move from r0 to c9
BX lr
ENDP
In the above example, PMCR is declared as a register variable of type unsigned int, that is associated
with the cp15 coprocessor, with CRn = c9, CRm = c12, opcode1 = 0, and opcode2 = 0 in an MCR or MRC
instruction. The MCR encoding in the disassembly corresponds with the register variable declaration.
The physical coprocessor register is specified with a combination of the two register numbers, CRn and
CRm, and two opcode numbers. This maps to a single physical register.
The same principle applies if you want to manipulate individual bits in a register, but you write normal
variable arithmetic in C, and the compiler does a read-modify-write of the coprocessor register. The
following example shows how to manipulate bits in a coprocessor register using a named register
variable
register unsigned int SCTLR __asm("cp15:0:c1:c0:0");
/* Set bit 11 of the system control register */
void enable_branch_prediction(void)
{
SCTLR |= (1 << 11);
}
Compiling this example using --cpu=7-M results in the following assembly code:
__enable_branch_prediction PROC
MRC p15,#0x0,r0,c1,c0,#0
ORR r0,r0,#0x800
MCR p15,#0x0,r0,c1,c0,#0
BX lr
ENDP
Related references
10.5 __asm on page 10-604.
10.159 Named register variables on page 10-774.
Related information
Application Program Status Register.
MRC and MRC2.
Miscellaneous pragmas
• #pragma arm section [section_type_list]
• #pragma import(__use_full_stdio)
• #pragma inline, #pragma no_inline
• #pragma once
• #pragma pack(n)
• #pragma softfp_linkage, #pragma no_softfp_linkage
• #pragma import symbol_name
Related references
10.77 #pragma anon_unions, #pragma no_anon_unions on page 10-682.
10.78 #pragma arm on page 10-683.
10.79 #pragma arm section [section_type_list] on page 10-684.
10.80 #pragma diag_default tag[,tag,...] on page 10-686.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
Related concepts
4.17 Compiler type attribute, __attribute__((bitband)) on page 4-127.
4.18 --bitband compiler command-line option on page 4-128.
4.19 How the compiler handles bit-band objects placed outside bit-band regions on page 4-129.
Related references
10.58 __attribute__((bitband)) type attribute on page 10-663.
10.64 __attribute__((at(address))) variable attribute on page 10-669.
8.17 --bitband on page 8-339.
In the following example, the unplaced bit-banded objects must be relocated into the bit-band region.
This can be achieved by either using an appropriate scatter-loading description file or by using the
--rw_base linker command-line option.
/* foo.c */
typedef struct {
int i : 1;
int j : 2;
int k : 3;
} BB __attribute__((bitband));
BB value; // Unplaced object
void update_value(void)
{
value.i = 1;
value.j = 0;
}
/* end of foo.c */
Alternatively, you can use __attribute__((at())) to place bit-banded objects at a particular address in
the bit-band region, as in the following example:
/* foo.c */
typedef struct {
int i : 1;
int j : 2;
int k : 3;
} BB __attribute((bitband));
BB value __attribute__((at(0x20000040))); // Placed object
void update_value(void)
{
value.i = 1;
value.j = 0;
}
/* end of foo.c */
Related concepts
4.16 Compiler and processor support for bit-banding on page 4-126.
4.18 --bitband compiler command-line option on page 4-128.
4.19 How the compiler handles bit-band objects placed outside bit-band regions on page 4-129.
Related references
10.58 __attribute__((bitband)) type attribute on page 10-663.
10.64 __attribute__((at(address))) variable attribute on page 10-669.
8.17 --bitband on page 8-339.
Related information
Scatter-loading Features.
--rw_base=address linker option.
armcc supports the bit-banding of objects accessed through absolute addresses. When --bitband is
applied to foo.c in the following example, the access to rts is bit-banded.
/* foo.c */
typedef struct {
int rts : 1;
int cts : 1;
unsigned int data;
} uart;
#define com2 (*((volatile uart *)0x20002000))
void put_com2(int n)
{
com2.rts = 1;
com2.data = n;
}
/* end of foo.c */
Related concepts
4.16 Compiler and processor support for bit-banding on page 4-126.
4.17 Compiler type attribute, __attribute__((bitband)) on page 4-127.
4.19 How the compiler handles bit-band objects placed outside bit-band regions on page 4-129.
Related references
10.58 __attribute__((bitband)) type attribute on page 10-663.
10.64 __attribute__((at(address))) variable attribute on page 10-669.
8.17 --bitband on page 8-339.
4.19 How the compiler handles bit-band objects placed outside bit-band regions
Bit-band objects must not be placed outside bit-band regions.
If you do inadvertently place a bit-band object outside a bit-band region, either using the at attribute, or
using an integer pointer to a particular address, the compiler responds as follows:
• If the bitband attribute is applied to an object type and --bitband is not specified on the command
line, the compiler generates an error.
• If the bitband attribute is applied to an object type and --bitband is specified on the command line,
the compiler generates a warning, and ignores the request to bit-band.
• If the bitband attribute is not applied to an object type and --bitband is specified on the command
line, the compiler ignores the request to bit-band.
Related concepts
4.16 Compiler and processor support for bit-banding on page 4-126.
4.17 Compiler type attribute, __attribute__((bitband)) on page 4-127.
4.18 --bitband compiler command-line option on page 4-128.
Related references
10.58 __attribute__((bitband)) type attribute on page 10-663.
10.64 __attribute__((at(address))) variable attribute on page 10-669.
8.17 --bitband on page 8-339.
Related references
10.29 __declspec(thread) on page 10-632.
$a
.text
f
0x00000000: e59f0000 .... LDR r0,[pc,#0] ; [0x8] = 0xdeadbeef
0x00000004: e12fff1e ../. BX lr
$d
0x00000008: deadbeef .... DCD 3735928559 ***
An alternative to using literal pools is to generate the constant in a register with a MOVW/MOVT instruction
pair:
** Section #1 '.text' (SHT_PROGBITS) [SHF_ALLOC + SHF_EXECINSTR]
Size : 12 bytes (alignment 4)
Address: 0x00000000
$a
.text
f
0x00000000: e30b0eef .... MOV r0,#0xbeef
0x00000004: e34d0ead ..M. MOVT r0,#0xdead
0x00000008: e12fff1e ../. BX lr
In most cases, generating literal pools improves performance and code size. However, in some specific
cases you might prefer to generate code without literal pools.
The following compiler options control literal pools:
• --integer_literal_pools.
• --string_literal_pools.
• --branch_tables.
• --float_literal_pools.
Related references
8.109 --integer_literal_pools, --no_integer_literal_pools on page 8-440.
8.178 --string_literal_pools, --no_string_literal_pools on page 8-515.
8.18 --branch_tables, --no_branch_tables on page 8-340.
8.83 --float_literal_pools, --no_float_literal_pools on page 8-411.
Related information
Procedure Call Standard for the ARM Architecture.
Application Binary Interface (ABI) for the ARM Architecture.
Alignment restrictions in load and store element and structure instructions.
alloca().
Section alignment with the linker.
Related references
9.36 Assembler labels on page 9-586.
Related information
Symbol versioning for BPABI models.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
When you compile source files, the included header files are also compiled. If a header file is included in
more than one source file, it is recompiled when each source file is compiled. Also, you might include
header files that introduce many lines of code, but the primary source files that include them are
relatively small. Therefore, it is often desirable to avoid recompiling a set of header files by precompiling
them. These are referred to as PCH files.
The compiler can precompile and use PCH files automatically with the --pch option, or you can use the
--create_pch and --use_pch options to manually control the use of PCH files.
Note
Support for PCH processing is not available when you specify multiple source files in a single
compilation. In such a case, the compiler issues an error message and aborts the compilation.
Note
Do not assume that if a PCH file is available, it is used by the compiler. In some cases, system
configuration issues mean that the compiler might not always be able to use the PCH file. Address Space
Randomization on Red Hat Enterprise Linux 3 (RHE3) is one example of a possible system
configuration issue.
Related concepts
2.4 Order of compiler command-line options on page 2-45.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
Related references
8.150 --pch_messages, --no_pch_messages on page 8-486.
10.87 #pragma hdrstop on page 10-693.
10.92 #pragma no_pch on page 10-698.
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
Automatic PCH file processing means that the compiler automatically looks for a qualifying PCH file,
and reads it if found. Otherwise, the compiler creates one for use on a subsequent compilation.
When the compiler creates a PCH file, it takes the name of the primary source file and replaces the suffix
with .pch. The PCH file is created in the directory of the primary source file unless the --pch_dir
option is specified.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.24 Precompiled Header (PCH) files on page 4-134.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
Related references
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
4.26 Precompiled Header (PCH) file processing and the header stop point
The PCH file contains a snapshot of all the code that precedes a header stop point.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
Typically, the header stop point is the first token in the primary source file that does not belong to a
preprocessing directive. In the following example, the header stop point is int and the PCH file contains
a snapshot that reflects the inclusion of xxx.h and yyy.h:
#include "xxx.h"
#include "yyy.h"
int i;
You can manually specify the header stop point with #pragma hdrstop. If you use this pragma, it must
appear before the first token that does not belong to a preprocessing directive. In this example, it must be
placed before int, as follows:
#include "xxx.h"
#include "yyy.h"
#pragma hdrstop
int i;
If a conditional directive block (#if, #ifdef, or #ifndef) encloses the first non-preprocessor token or
#pragma hdrstop, the header stop point is the outermost enclosing conditional directive.
For example:
#include "xxx.h"
#ifndef YYY_H
#define YYY_H 1
#include "yyy.h"
#endif
#if TEST /* Header stop point lies immediately before #if TEST */
int i;
#endif
In this example, the first token that does not belong to a preprocessing directive is int, but the header
stop point is the start of the #if block containing it. The PCH file reflects the inclusion of xxx.h and,
conditionally, the definition of YYY_H and inclusion of yyy.h. It does not contain the state produced by
#if TEST.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
Related references
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
10.87 #pragma hdrstop on page 10-693.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
Related references
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
8.150 --pch_messages, --no_pch_messages on page 8-486.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
10.87 #pragma hdrstop on page 10-693.
10.92 #pragma no_pch on page 10-698.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
That is, the compiler uses the PCH file representing the most preprocessing directives from the primary
source file.
For example, a primary source file might begin with:
#include "xxx.h"
#include "yyy.h"
#include "zzz.h"
If there is one PCH file for xxx.h and a second for xxx.h and yyy.h, the latter PCH file is selected,
assuming that both apply to the current compilation. Additionally, after the PCH file for the first two
headers is read in and the third is compiled, a new PCH file for all three headers is created if the
requirements for PCH file creation are met.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
The compiler indicates that a PCH file is obsolete, and deletes it, under the following circumstances:
• If the PCH file is based on at least one out-of-date header file but is otherwise applicable for the
current compilation.
• If the PCH file has the same base name as the source file being compiled, for example, xxx.pch and
xxx.c, but is not applicable for the current compilation, for example, because you have used different
command-line options.
These describe some common cases. You must delete other PCH files as required.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH)
file
You can manually specify the filename and location of PCH files for the compiler to create and use.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
Use the following compiler command-line options to specify PCH filenames and locations:
• --create_pch=filename
• --pch_dir=directory
• --use_pch=filename
If you use --create_pch or --use_pch with the --pch_dir option, the indicated filename is appended
to the directory name, unless the filename is an absolute path name.
Note
If multiple options are specified on the same command line, the following rules apply:
• --use_pch takes precedence over --pch.
• --create_pch takes precedence over all other PCH file options.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
Related references
8.44 --create_pch=filename on page 8-371.
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
8.190 --use_pch=filename on page 8-532.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
Use the #pragma hdrstop directive to insert a manual header stop point in the primary source file. Insert
it before the first token that does not belong to a preprocessing directive. This enables you to specify
where the set of header files that is subject to precompilation ends. For example,
#include "xxx.h"
#include "yyy.h"
#pragma hdrstop
#include "zzz.h"
In this example, the PCH file includes the processing state for xxx.h and yyy.h but not for zzz.h. This
is useful if you decide that the information following the #pragma hdrstop does not justify the creation
of another PCH file.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
Related references
10.87 #pragma hdrstop on page 10-693.
10.92 #pragma no_pch on page 10-698.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
You do not have to place this directive at the beginning of the file for it to take effect. For example, no
PCH file is created if you compile the following source code with armcc --create_pch=foo.pch
myprog.c:
#include "xxx.h"
#pragma no_pch
#include "zzz.h"
If you want to selectively enable PCH processing, for example, subject xxx.h to PCH file processing, but
not zzz.h, replace #pragma no_pch with #pragma hdrstop, as follows:
#include "xxx.h"
#pragma hdrstop
#include "zzz.h"
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
Related references
10.87 #pragma hdrstop on page 10-693.
10.92 #pragma no_pch on page 10-698.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
When the compiler creates or uses a PCH file, it displays the following kind of message:
test.c: creating precompiled header file test.pch
You can suppress this message with the compiler command-line option --no_pch_messages.
The --pch_verbose option enables verbose mode. In verbose mode, the compiler displays a message for
each PCH file that it considers but does not use, giving the reason why it cannot be used.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
4.34 Performance issues with Precompiled Header (PCH) files on page 4-147.
Related references
8.150 --pch_messages, --no_pch_messages on page 8-486.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
Note
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
PCH processing might not always be appropriate, for example, where you have an arbitrary set of files
with non-uniform initial sequences of preprocessing directives.
The benefits of PCH processing occur when several source files can share the same PCH file. The more
sharing, the less disk space is consumed. Sharing minimizes the disadvantage of large PCH files, without
giving up the advantage of a significant decrease in compilation times.
Therefore, to take full advantage of header file precompilation, you might have to re-order the #include
sections of your source files, or group #include directives within a commonly used header file.
Different environments and different projects might have differing requirements. Be aware, however, that
making the best use of PCH support might require some experimentation and probably some minor
changes to source code.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.28 Compilation with multiple Precompiled Header (PCH) files on page 4-141.
4.29 Obsolete Precompiled Header (PCH) files on page 4-142.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
Related references
8.15 --autoinline, --no_autoinline on page 8-337.
8.46 --data_reorder, --no_data_reorder on page 8-373.
8.139 -Onum on page 8-473.
Describes programming techniques and practices to help you increase the portability, efficiency and
robustness of your C and C++ source code.
It contains the following sections:
• 5.1 The compiler as an optimizing compiler on page 5-152.
• 5.2 Compiler optimization for code size versus speed on page 5-153.
• 5.3 Compiler optimization levels and the debug view on page 5-154.
• 5.4 Selecting the target processor at compile time on page 5-157.
• 5.5 Enabling NEON and FPU for bare-metal on page 5-158.
• 5.6 Optimization of loop termination in C code on page 5-159.
• 5.7 Loop unrolling in C code on page 5-161.
• 5.8 Compiler optimization and the volatile keyword on page 5-163.
• 5.9 Code metrics on page 5-165.
• 5.10 Code metrics for measurement of code size and data size on page 5-166.
• 5.11 Stack use in C and C++ on page 5-167.
• 5.12 Benefits of reducing debug information in objects and libraries on page 5-169.
• 5.13 Methods of reducing debug information in objects and libraries on page 5-170.
• 5.14 Guarding against multiple inclusion of header files on page 5-171.
• 5.15 Methods of minimizing function parameter passing overhead on page 5-172.
• 5.16 Returning structures from functions through registers on page 5-173.
• 5.17 Functions that return the same result when called with the same arguments on page 5-174.
• 5.18 Comparison of pure and impure functions on page 5-175.
• 5.19 Recommendation of postfix syntax when qualifying functions with ARM function modifiers
on page 5-176.
• 5.20 Inline functions on page 5-177.
• 5.21 Compiler decisions on function inlining on page 5-178.
Related concepts
5.2 Compiler optimization for code size versus speed on page 5-153.
5.3 Compiler optimization levels and the debug view on page 5-154.
5.6 Optimization of loop termination in C code on page 5-159.
5.8 Compiler optimization and the volatile keyword on page 5-163.
Related tasks
5.4 Selecting the target processor at compile time on page 5-157.
Related references
8.15 --autoinline, --no_autoinline on page 8-337.
8.43 --cpu=name on page 8-368.
8.46 --data_reorder, --no_data_reorder on page 8-373.
8.85 --forceinline on page 8-413.
8.87 --fpmode=model on page 8-415.
8.108 --inline, --no_inline on page 8-439.
8.115 --library_interface=lib on page 8-446.
8.116 --library_type=lib on page 8-448.
8.126 --lower_ropi, --no_lower_ropi on page 8-459.
8.127 --lower_rwpi, --no_lower_rwpi on page 8-460.
8.134 --multifile, --no_multifile on page 8-467.
8.139 -Onum on page 8-473.
8.143 -Ospace on page 8-479.
8.144 -Otime on page 8-480.
8.165 --retain=option on page 8-501.
-Ospace
This option causes the compiler to optimize mainly for code size. This is the default option.
-Otime
This option causes the compiler to optimize mainly for speed.
For best results, you must build your application using the most appropriate command-line option.
Note
These command-line options instruct the compiler to use optimizations that deliver the effect wanted in
the vast majority of cases. However, it is not guaranteed that -Otime always generates faster code, or that
-Ospace always generates smaller code.
Related references
8.143 -Ospace on page 8-479.
8.144 -Otime on page 8-480.
0
Minimum optimization. Turns off most optimizations. When debugging is enabled, this option
gives the best possible debug view because the structure of the generated code directly
corresponds to the source code. All optimization that interferes with the debug view is disabled.
In particular:
• Breakpoints can be set on any reachable point, including dead code.
• The value of a variable is available everywhere within its scope, except where it is
uninitialized.
• Backtrace gives the stack of open function activations that is expected from reading the
source.
Note
Although the debug view produced by -O0 corresponds most closely to the source code, users
might prefer the debug view produced by -O1 because this improves the quality of the code
without changing the fundamental structure.
Note
Dead code includes reachable code that has no effect on the result of the program, for example
an assignment to a local variable that is never used. Unreachable code is specifically code that
cannot be reached via any control flow path, for example code that immediately follows a return
statement.
1
Restricted optimization. The compiler only performs optimizations that can be described by
debug information. Removes unused inline functions and unused static functions. Turns off
optimizations that seriously degrade the debug view. If used with --debug, this option gives a
generally satisfactory debug view with good code density.
The differences in the debug view from –O0 are:
• Breakpoints cannot be set on dead code.
• Values of variables might not be available within their scope after they have been initialized.
For example if their assigned location has been reused.
• Functions with no side-effects might be called out of sequence, or might be omitted if the
result is not needed.
• Backtrace might not give the stack of open function activations that is expected from reading
the source because of the presence of tailcalls.
The optimization level –O1 produces good correspondence between source code and object
code, especially when the source code contains no dead code. The generated code can be
significantly smaller than the code at –O0, which can simplify analysis of the object code.
2
High optimization. If used with --debug, the debug view might be less satisfactory because the
mapping of object code to source code is not always clear. The compiler might perform
optimizations that cannot be described by debug information.
This is the default optimization level.
The differences in the debug view from –O1 are:
• The source code to object code mapping might be many to one, because of the possibility of
multiple source code locations mapping to one point of the file, and more aggressive
instruction scheduling.
• Instruction scheduling is allowed to cross sequence points. This can lead to mismatches
between the reported value of a variable at a particular point, and the value you might expect
from reading the source code.
• The compiler automatically inlines functions.
3
Maximum optimization. When debugging is enabled, this option typically gives a poor debug
view. ARM recommends debugging at lower optimization levels.
If you use -O3 and -Otime together, the compiler performs extra optimizations that are more
aggressive, such as:
• High-level scalar optimizations, including loop unrolling. This can give significant
performance benefits at a small code size cost, but at the risk of a longer build time.
• More aggressive inlining and automatic inlining.
These optimizations effectively rewrite the input source code, resulting in object code with the
lowest correspondence to source code and the worst debug view. The
--loop_optimization_level=option controls the amount of loop optimization performed at
–O3 –Otime. The higher the amount of loop optimization the worse the correspondence between
source and object code.
Use of the --vectorize option also lowers the correspondence between source and object code.
For extra information about the high level transformations performed on the source code at
–O3 –Otime use the --remarks command-line option.
Because optimization affects the mapping of object code to source code, the choice of optimization level
with -Ospace and -Otime generally impacts the debug view.
The option -O0 is the best option to use if a simple debug view is required. Selecting -O0 typically
increases the size of the ELF image by 7 to 15%. To reduce the size of your debug tables, use the
--remove_unneeded_entities option.
Related concepts
5.12 Benefits of reducing debug information in objects and libraries on page 5-169.
Related references
5.13 Methods of reducing debug information in objects and libraries on page 5-170.
8.47 --debug, --no_debug on page 8-374.
8.48 --debug_macros, --no_debug_macros on page 8-375.
8.68 --dwarf2 on page 8-396.
8.69 --dwarf3 on page 8-397.
8.139 -Onum on page 8-473.
8.143 -Ospace on page 8-479.
8.144 -Otime on page 8-480.
8.163 --remove_unneeded_entities, --no_remove_unneeded_entities on page 8-499.
Related information
ELF for the ARM Architecture.
Procedure
1. Decide whether the compiled program is to run on a specific ARM architecture-based processor or on
different ARM processors.
2. Obtain the name, or names, of the target processors recognized by the compiler using the following
compiler command-line option:
--cpu=list
3. If the compiled program is to run on a specific ARM architecture-based processor, having obtained
the name of the processor with the --cpu=list option, select the target processor using the
--cpu=name compiler command-line option.
For example, to compile code to run on a Cortex-A9 processor:
armcc --cpu=Cortex-A9 myprog.c
Alternatively, if the compiled program is to run on different ARM processors, choose the lowest
common denominator architecture appropriate for the application and then specify that architecture in
place of the processor name. For example, to compile code for processors supporting the ARMv6
architecture:
armcc --cpu=6 myprog.c
Selecting the target processor using the --cpu=name command-line option lets the compiler:
• Make full use of all available instructions for that particular processor.
• Perform processor-specific optimizations such as instruction scheduling.
--cpu=list lists all the processors and architectures that the compiler supports.
Related references
8.42 --cpu=list on page 8-367.
8.43 --cpu=name on page 8-368.
Related tasks
5.4 Selecting the target processor at compile time on page 5-157.
3.4 Generating NEON instructions from C or C++ code on page 3-73.
Related references
8.43 --cpu=name on page 8-368.
8.89 --fpu=name on page 8-418.
Related information
--startup=symbol, --no_startup linker option.
The following table shows the corresponding disassembly of the machine code produced by the compiler
for each of the sample implementations above, where the C code for both implementations has been
compiled using the options -O2 -Otime.
Comparing the disassemblies shows that the ADD and CMP instruction pair in the incrementing loop
disassembly has been replaced with a single SUBS instruction in the decrementing loop disassembly. This
is because a compare with zero can be used instead.
In addition to saving an instruction in the loop, the variable n does not have to be saved across the loop,
so the use of a register is also saved in the decrementing loop disassembly. This eases register allocation.
It is even more important if the original termination condition involves a function call. For example:
for (...; i < get_limit(); ...);
The technique of initializing the loop counter to the number of iterations required, and then decrementing
down to zero, also applies to while and do statements.
Related concepts
5.7 Loop unrolling in C code on page 5-161.
The advantages and disadvantages of loop unrolling can be illustrated using the two sample routines
shown in the following table. Both routines efficiently test a single bit by extracting the lowest bit and
counting it, after which the bit is shifted out.
The first implementation uses a loop to count bits. The second routine is the first implementation
unrolled four times, with an optimization applied by combining the four shifts of n into one shift.
Unrolling frequently provides new opportunities for optimization.
The following table shows the corresponding disassembly of the machine code produced by the compiler
for each of the sample implementations above, where the C code for each implementation has been
compiled using the option -O2.
On the ARM9 processor, checking a single bit takes six cycles in the disassembly of the bit-counting
loop shown in the leftmost column. The code size is only nine instructions. The unrolled version of the
bit-counting loop checks four bits at a time per loop iteration, taking on average only three cycles per bit.
However, the cost is the larger code size of fifteen instructions.
Related concepts
5.6 Optimization of loop termination in C code on page 5-159.
The two versions of the routine differ only in the way that buffer_full is declared. The first routine
version is incorrect. Notice that the variable buffer_full is not qualified as volatile in this version. In
contrast, the second version of the routine shows the same loop where buffer_full is correctly qualified
as volatile.
The following table shows the corresponding disassembly of the machine code produced by the compiler
for each of the examples above, where the C code for each implementation has been compiled using the
option -O2.
In the disassembly of the nonvolatile version of the buffer loop in the above table, the statement LDR r0,
[r0, #0] loads the value of buffer_full into register r0 outside the loop labeled |L1.12|. Because
buffer_full is not declared as volatile, the compiler assumes that its value cannot be modified
outside the program. Having already read the value of buffer_full into r0, the compiler omits
reloading the variable when optimizations are enabled, because its value cannot change. The result is the
infinite loop labeled |L1.12|.
In contrast, in the disassembly of the volatile version of the buffer loop, the compiler assumes the value
of buffer_full can change outside the program and performs no optimizations. Consequently, the value
of buffer_full is loaded into register r0 inside the loop labeled |L1.8|. As a result, the loop |L1.8| is
implemented correctly in assembly code.
To avoid optimization problems caused by changes to program state external to the implementation, you
must declare variables as volatile whenever their values can change unexpectedly in ways unknown to
the implementation.
In practice, you must declare a variable as volatile whenever you are:
• Accessing memory-mapped peripherals.
• Sharing global variables between multiple threads.
• Accessing global variables in an interrupt routine or signal handler.
The compiler does not optimize the variables you have declared as volatile.
Related concepts
5.10 Code metrics for measurement of code size and data size on page 5-166.
5.11 Stack use in C and C++ on page 5-167.
Related information
--info=topic[,topic,...] fromelf option.
--info=topic[,topic,...] linker option.
--map, --no_map linker option.
--callgraph, --no_callgraph linker option.
5.10 Code metrics for measurement of code size and data size
The compiler, linker, and fromelf image converter let you measure code and data size.
Use the following command-line options:
• --info=sizes (armlink and fromelf).
• --info=totals (armcc, armlink, and fromelf).
• --map (armlink).
Related references
8.107 --info=totals on page 8-438.
Related information
--info=topic[,topic,...] fromelf option.
--info=topic[,topic,...] linker option.
--map, --no_map linker option.
• Several optimizations can introduce new temporary variables to hold intermediate results. The
optimizations include: CSE elimination, live range splitting and structure splitting. The compiler tries
to allocate these temporary variables to registers. If not, it spills them to the stack.
• Generally, code compiled for processors that support only 16-bit encoded Thumb instructions makes
more use of the stack than ARM code and code compiled for processors that support 32-bit encoded
Thumb instructions. This is because 16-bit encoded Thumb instructions have only eight registers
available for allocation, compared to fourteen for ARM code and 32-bit encoded Thumb instructions.
• The AAPCS requires that some function arguments are passed through the stack instead of the
registers, depending on their type, size, and order.
4. After your application has finished executing, examine the stack space of memory to see how
many of the known values have been overwritten. The space has garbage in the used part and the
known values in the remainder.
5. Count the number of garbage values and multiply by four, to give their size, in bytes.
The result of the calculation shows how the size of the stack has grown, in bytes.
• Use RTSM, and define a region of memory where access is not allowed directly below your stack in
memory, with a map file. If the stack overflows into the forbidden region, a data abort occurs, which
can be trapped by the debugger.
Related information
Getting Started with DS-5, ARM DS-5 Product Overview, About Fixed Virtual Platform (FVP).
ARM DS-5 Using the Debugger.
ARM DS-5 EB FVP Reference Guide.
Fixed Virtual Platforms VE and MPS FVP Reference Guide.
Procedure Call Standard for the ARM Architecture.
--info=topic[,topic,...] fromelf option.
--info=topic[,topic,...] linker option.
--callgraph, --no_callgraph linker option.
Related concepts
5.3 Compiler optimization levels and the debug view on page 5-154.
Related references
5.13 Methods of reducing debug information in objects and libraries on page 5-170.
You can use the compiler option --remarks to warn about unguarded header files.
• Compile your code with the --no_debug_macros command-line option to discard preprocessor
macro definitions from debug tables.
• Consider using (or not using) --remove_unneeded_entities.
Caution
Although --remove_unneeded_entities can help to reduce the amount of debug information
generated per file, it has the disadvantage of reducing the number of debug sections that are common
to many files. This reduces the number of common debug sections that the linker is able to remove at
final link time, and can result in a final debug image that is larger than necessary. For this reason, use
--remove_unneeded_entities only when necessary.
Related concepts
2.18.1 Compilation build time on page 2-62.
5.12 Benefits of reducing debug information in objects and libraries on page 5-169.
5.3 Compiler optimization levels and the debug view on page 5-154.
Related tasks
2.18.2 Minimizing compilation build time on page 2-63.
Related references
8.48 --debug_macros, --no_debug_macros on page 8-375.
8.162 --remarks on page 8-498.
8.163 --remove_unneeded_entities, --no_remove_unneeded_entities on page 8-499.
Related references
8.91 -g on page 8-422.
Related concepts
5.16 Returning structures from functions through registers on page 5-173.
You can use __value_in_regs anywhere where multiple values have to be returned from a function.
Examples include:
• Returning multiple values from C and C++ functions.
• Returning multiple values from embedded assembly language functions.
• Making supervisor calls.
• Re-implementing __user_initial_stackheap.
Related concepts
5.15 Methods of minimizing function parameter passing overhead on page 5-172.
Related references
10.19 __value_in_regs on page 10-620.
5.17 Functions that return the same result when called with the same arguments
A function that always returns the same result when called with the same arguments, and does not
change any global data, is referred to as a pure function.
By definition, it is sufficient to evaluate any particular call to a pure function only once. Because the
result of a call to the function is guaranteed to be the same for any identical call, each subsequent call to
the function in code can be replaced with the result of the original call.
Using the keyword __pure when declaring a function indicates that the function is a pure function.
By definition, pure functions cannot have side effects. For example, a pure function cannot read or write
global state by using global variables or indirecting through pointers, because accessing global state can
violate the rule that the function must return the same value each time when called twice with the same
parameters. Therefore, you must use __pure carefully in your programs. Where functions can be
declared __pure, however, the compiler can often perform powerful optimizations, such as Common
Subexpression Eliminations (CSEs).
Related references
10.33 __attribute__((const)) function attribute on page 10-638.
10.48 __attribute__((pure)) function attribute on page 10-653.
5.18 Comparison of pure and impure functions on page 5-175.
10.13 __pure on page 10-614.
The following table shows the corresponding disassembly of the machine code produced by the compiler
for each of the sample implementations above, where the C code for each implementation has been
compiled using the option -O2, and inlining has been suppressed.
In the disassembly where fact() is not qualified as __pure, fact() is called twice because the compiler
does not know that the function is a candidate for Common Subexpression Elimination (CSE). In
contrast, in the disassembly where fact() is qualified as __pure, fact() is called only once, instead of
twice, because the compiler has been able to perform CSE when adding fact(n) + fact(n).
Related concepts
5.17 Functions that return the same result when called with the same arguments on page 5-174.
Related references
10.13 __pure on page 10-614.
These function modifiers all have a common syntax. A function modifier such as __pure can qualify a
function declaration either:
• Before the function declaration. For example:
__pure int foo(int);
• After the closing parenthesis on the parameter list. For example:
int foo(int) __pure;
For simple function declarations, each syntax is unambiguous. However, for a function whose return type
or arguments are function pointers, the prefix syntax is imprecise. For example, the following function
returns a function pointer, but it is not clear whether __pure modifies the function itself or its returned
pointer type:
__pure int (*foo(int)) (int); /* declares 'foo' as a (pure?) function
that returns a pointer to a (pure?)
function.
It is ambiguous which of the two
function types is pure. */
In fact, the single __pure keyword at the front of the declaration of foo modifies both foo itself and the
function pointer type returned by foo.
In contrast, the postfix syntax enables clear distinction between whether __pure applies to the argument,
the return type, or the base function, when declaring a function whose argument and return types are
function pointers. For example:
int (*foo1(int) __pure) (int); /* foo1 is a pure function
returning a pointer to
a normal function */
int (*foo2(int)) (int) __pure; /* foo2 is a function
returning a pointer to
a pure function */
int (*foo3(int) __pure) (int) __pure; /* foo3 is a pure function
returning a pointer to
a pure function */
In this example:
• foo1 and foo3 are modified themselves.
• foo2 and foo3 return a pointer to a modified function.
• The functions foo3 and foo are identical.
Because the postfix syntax is more precise than the prefix syntax, ARM recommends that, where
possible, you make use of the postfix syntax when qualifying functions with ARM function modifiers.
Related references
10.11 __irq on page 10-611.
10.13 __pure on page 10-614.
10.15 __softfp on page 10-616.
10.16 __svc on page 10-617.
10.17 __svc_indirect on page 10-618.
10.19 __value_in_regs on page 10-620.
Related concepts
5.21 Compiler decisions on function inlining on page 5-178.
5.22 Automatic function inlining and static functions on page 5-179.
5.23 Inline functions and removal of unused out-of-line functions at link time on page 5-180.
5.24 Automatic function inlining and multifile compilation on page 5-181.
5.26 Compiler modes and inline functions on page 5-183.
5.27 Inline functions in C++ and C90 mode on page 5-184.
5.28 Inline functions in C99 mode on page 5-185.
5.29 Inline functions and debugging on page 5-187.
Related references
5.25 Restriction on overriding compiler decisions about function inlining on page 5-182.
8.15 --autoinline, --no_autoinline on page 8-337.
8.85 --forceinline on page 8-413.
10.6 __forceinline on page 10-605.
10.8 __inline on page 10-608.
8.108 --inline, --no_inline on page 8-439.
Related information
--inline, --no_inline linker option.
Related concepts
5.20 Inline functions on page 5-177.
5.22 Automatic function inlining and static functions on page 5-179.
5.23 Inline functions and removal of unused out-of-line functions at link time on page 5-180.
5.24 Automatic function inlining and multifile compilation on page 5-181.
5.26 Compiler modes and inline functions on page 5-183.
5.27 Inline functions in C++ and C90 mode on page 5-184.
5.28 Inline functions in C99 mode on page 5-185.
5.29 Inline functions and debugging on page 5-187.
Related references
5.25 Restriction on overriding compiler decisions about function inlining on page 5-182.
8.15 --autoinline, --no_autoinline on page 8-337.
8.85 --forceinline on page 8-413.
10.6 __forceinline on page 10-605.
10.8 __inline on page 10-608.
8.108 --inline, --no_inline on page 8-439.
8.139 -Onum on page 8-473.
8.143 -Ospace on page 8-479.
8.144 -Otime on page 8-480.
Related concepts
5.20 Inline functions on page 5-177.
5.21 Compiler decisions on function inlining on page 5-178.
5.23 Inline functions and removal of unused out-of-line functions at link time on page 5-180.
5.24 Automatic function inlining and multifile compilation on page 5-181.
5.26 Compiler modes and inline functions on page 5-183.
5.27 Inline functions in C++ and C90 mode on page 5-184.
5.28 Inline functions in C99 mode on page 5-185.
5.29 Inline functions and debugging on page 5-187.
Related references
5.25 Restriction on overriding compiler decisions about function inlining on page 5-182.
8.15 --autoinline, --no_autoinline on page 8-337.
8.139 -Onum on page 8-473.
5.23 Inline functions and removal of unused out-of-line functions at link time
The linker cannot remove unused out-of-line functions from an object unless you place the unused out-
of-line functions in their own sections.
Use one of the following methods to place unused out-of-line functions in their own sections:
• --split_sections.
• __attribute__((section("name"))).
• #pragma arm section [section_type_list].
• Linker feedback.
--feedback is typically an easier method of enabling unused function removal.
Related concepts
5.20 Inline functions on page 5-177.
5.21 Compiler decisions on function inlining on page 5-178.
5.22 Automatic function inlining and static functions on page 5-179.
5.24 Automatic function inlining and multifile compilation on page 5-181.
5.26 Compiler modes and inline functions on page 5-183.
5.27 Inline functions in C++ and C90 mode on page 5-184.
5.28 Inline functions in C99 mode on page 5-185.
5.29 Inline functions and debugging on page 5-187.
Related references
5.25 Restriction on overriding compiler decisions about function inlining on page 5-182.
8.82 --feedback=filename on page 8-410.
8.175 --split_sections on page 8-512.
10.69 __attribute__((section("name"))) variable attribute on page 10-674.
10.79 #pragma arm section [section_type_list] on page 10-684.
Related concepts
5.20 Inline functions on page 5-177.
5.21 Compiler decisions on function inlining on page 5-178.
5.22 Automatic function inlining and static functions on page 5-179.
5.23 Inline functions and removal of unused out-of-line functions at link time on page 5-180.
5.26 Compiler modes and inline functions on page 5-183.
5.27 Inline functions in C++ and C90 mode on page 5-184.
5.28 Inline functions in C99 mode on page 5-185.
5.29 Inline functions and debugging on page 5-187.
Related references
5.25 Restriction on overriding compiler decisions about function inlining on page 5-182.
8.15 --autoinline, --no_autoinline on page 8-337.
8.108 --inline, --no_inline on page 8-439.
8.134 --multifile, --no_multifile on page 8-467.
8.139 -Onum on page 8-473.
Related concepts
5.20 Inline functions on page 5-177.
5.21 Compiler decisions on function inlining on page 5-178.
5.22 Automatic function inlining and static functions on page 5-179.
5.23 Inline functions and removal of unused out-of-line functions at link time on page 5-180.
5.24 Automatic function inlining and multifile compilation on page 5-181.
5.26 Compiler modes and inline functions on page 5-183.
5.27 Inline functions in C++ and C90 mode on page 5-184.
5.28 Inline functions in C99 mode on page 5-185.
5.29 Inline functions and debugging on page 5-187.
Related references
8.15 --autoinline, --no_autoinline on page 8-337.
8.85 --forceinline on page 8-413.
10.6 __forceinline on page 10-605.
10.8 __inline on page 10-608.
8.108 --inline, --no_inline on page 8-439.
Related concepts
5.20 Inline functions on page 5-177.
5.21 Compiler decisions on function inlining on page 5-178.
5.22 Automatic function inlining and static functions on page 5-179.
5.23 Inline functions and removal of unused out-of-line functions at link time on page 5-180.
5.24 Automatic function inlining and multifile compilation on page 5-181.
5.27 Inline functions in C++ and C90 mode on page 5-184.
5.28 Inline functions in C99 mode on page 5-185.
5.29 Inline functions and debugging on page 5-187.
Related references
5.25 Restriction on overriding compiler decisions about function inlining on page 5-182.
Related information
GNU Compiler Collection, http://gcc.gnu.org.
Related concepts
5.20 Inline functions on page 5-177.
5.21 Compiler decisions on function inlining on page 5-178.
5.22 Automatic function inlining and static functions on page 5-179.
5.23 Inline functions and removal of unused out-of-line functions at link time on page 5-180.
5.24 Automatic function inlining and multifile compilation on page 5-181.
5.26 Compiler modes and inline functions on page 5-183.
5.28 Inline functions in C99 mode on page 5-185.
5.29 Inline functions and debugging on page 5-187.
Related references
5.25 Restriction on overriding compiler decisions about function inlining on page 5-182.
8.108 --inline, --no_inline on page 8-439.
10.8 __inline on page 10-608.
Related information
Elimination of common groups or sections.
/* example_header.h */
inline int my_function (int i)
{
return i + 42; // inline definition
}
/* file1.c */
#include "example_header.h"
... // uses of my_function()
/* file2.c */
#include "example_header.h"
... // uses of my_function()
/* myfile.c */
#include "example_header.h"
extern inline int my_function(int); // causes external definition.
This is the same strategy that is typically used for C++, but in C++ there is no special external definition,
and no requirement for it.
The definitions of inline functions can be different in different translation units. However, in typical use,
as in the above example, they are identical.
When compiling with --multifile, calls in one translation unit might be inlined using the external
definition in another translation unit.
C99 places some restrictions on inline definitions. They cannot define modifiable local static objects.
They cannot reference identifiers with static linkage.
In C99 mode, as with all other modes, the effects of __inline and inline are identical.
Inline functions with static linkage have the same behavior in C99 as in C++.
Related concepts
5.20 Inline functions on page 5-177.
5.21 Compiler decisions on function inlining on page 5-178.
5.22 Automatic function inlining and static functions on page 5-179.
5.23 Inline functions and removal of unused out-of-line functions at link time on page 5-180.
5.24 Automatic function inlining and multifile compilation on page 5-181.
5.26 Compiler modes and inline functions on page 5-183.
5.27 Inline functions in C++ and C90 mode on page 5-184.
5.29 Inline functions and debugging on page 5-187.
Related references
5.25 Restriction on overriding compiler decisions about function inlining on page 5-182.
8.108 --inline, --no_inline on page 8-439.
Related concepts
5.20 Inline functions on page 5-177.
5.21 Compiler decisions on function inlining on page 5-178.
5.22 Automatic function inlining and static functions on page 5-179.
5.23 Inline functions and removal of unused out-of-line functions at link time on page 5-180.
5.24 Automatic function inlining and multifile compilation on page 5-181.
5.26 Compiler modes and inline functions on page 5-183.
5.27 Inline functions in C++ and C90 mode on page 5-184.
5.28 Inline functions in C99 mode on page 5-185.
Related references
5.25 Restriction on overriding compiler decisions about function inlining on page 5-182.
8.15 --autoinline, --no_autoinline on page 8-337.
8.85 --forceinline on page 8-413.
10.6 __forceinline on page 10-605.
10.8 __inline on page 10-608.
8.108 --inline, --no_inline on page 8-439.
Related information
--inline, --no_inline linker option.
Related concepts
5.31 Advantages of natural data alignment on page 5-189.
5.34 Unaligned data access in C and C++ code on page 5-192.
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
Related references
5.32 Compiler storage of data objects by natural byte alignment on page 5-190.
5.33 Relevance of natural data alignment at compile time on page 5-191.
10.97 #pragma pack(n) on page 10-703.
Related concepts
5.30 Types of data alignment on page 5-188.
5.34 Unaligned data access in C and C++ code on page 5-192.
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
Related references
5.32 Compiler storage of data objects by natural byte alignment on page 5-190.
5.33 Relevance of natural data alignment at compile time on page 5-191.
long long, double, long double 8 Located at an address that is evenly divisible by 8.
Related concepts
5.30 Types of data alignment on page 5-188.
5.31 Advantages of natural data alignment on page 5-189.
5.34 Unaligned data access in C and C++ code on page 5-192.
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
Related references
5.33 Relevance of natural data alignment at compile time on page 5-191.
Related concepts
5.30 Types of data alignment on page 5-188.
5.31 Advantages of natural data alignment on page 5-189.
5.34 Unaligned data access in C and C++ code on page 5-192.
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
Related references
5.32 Compiler storage of data objects by natural byte alignment on page 5-190.
Related concepts
5.30 Types of data alignment on page 5-188.
5.31 Advantages of natural data alignment on page 5-189.
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
Related references
5.32 Compiler storage of data objects by natural byte alignment on page 5-190.
5.33 Relevance of natural data alignment at compile time on page 5-191.
5.35 The __packed qualifier and unaligned data access in C and C++ code
The __packed qualifier sets the alignment of any valid type to 1.
This enables objects of packed type to be read or written using unaligned access.
Examples of objects that can be packed include:
• Structures.
• Unions.
• Pointers.
Related concepts
5.30 Types of data alignment on page 5-188.
5.31 Advantages of natural data alignment on page 5-189.
5.34 Unaligned data access in C and C++ code on page 5-192.
5.36 Unaligned fields in structures on page 5-194.
5.37 Performance penalty associated with marking whole structures as packed on page 5-195.
Related references
5.32 Compiler storage of data objects by natural byte alignment on page 5-190.
5.33 Relevance of natural data alignment at compile time on page 5-191.
10.12 __packed on page 10-612.
10.97 #pragma pack(n) on page 10-703.
Note
The same principles apply to unions. You can declare either an entire union as __packed, or use the
__packed attribute to identify components of the union that are unaligned in memory.
Related concepts
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
5.37 Performance penalty associated with marking whole structures as packed on page 5-195.
5.40 Comparisons of an unpacked struct, a __packed struct, and a struct with individually __packed
fields, and of a __packed struct and a #pragma packed struct on page 5-198.
Related references
10.12 __packed on page 10-612.
10.97 #pragma pack(n) on page 10-703.
Related concepts
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
5.36 Unaligned fields in structures on page 5-194.
5.40 Comparisons of an unpacked struct, a __packed struct, and a struct with individually __packed
fields, and of a __packed struct and a #pragma packed struct on page 5-198.
Related references
10.12 __packed on page 10-612.
10.97 #pragma pack(n) on page 10-703.
When a pointer is declared as __packed, the compiler generates code that correctly accesses the
dereferenced value of the pointer, regardless of its alignment. The generated code consists of a sequence
of byte accesses, or variable alignment-dependent shifting and masking instructions, rather than a simple
LDR instruction. Consequently, declaring a pointer as __packed incurs a performance and code size
penalty.
Related concepts
5.39 Unaligned Load Register (LDR) instructions generated by the compiler on page 5-197.
Related references
10.12 __packed on page 10-612.
8.187 --unaligned_access, --no_unaligned_access on page 8-528.
In particular, the compiler can do this to load halfwords from memory, even where the architecture
supports dedicated halfword load instructions.
For example, to access an unaligned short within a __packed structure, the compiler might load the
required halfword into the top half of a register and then shift it down to the bottom half. This operation
requires only one memory access, whereas performing the same operation using LDRB instructions
requires two memory accesses, plus instructions to merge the two bytes.
Related concepts
5.38 Unaligned pointers in C and C++ code on page 5-196.
Related references
10.12 __packed on page 10-612.
8.187 --unaligned_access, --no_unaligned_access on page 8-528.
Table 5-10 C code for an unpacked struct, a packed struct, and a struct with individually packed fields
In the first implementation, the struct is not packed. In the second implementation, the entire structure
is qualified as __packed. In the third implementation, the __packed attribute is removed from the
structure and the individual field that is not naturally aligned is declared as __packed.
The following table shows the corresponding disassembly of the machine code produced by the compiler
for each of the sample implementations of the preceding table, where the C code for each implementation
has been compiled using the option -O2.
Table 5-11 Disassembly for an unpacked struct, a packed struct, and a struct with individually packed fields
Note
The -Ospace and -Otime compiler options control whether accesses to unaligned elements are made
inline or through a function call. Using -Otime results in inline unaligned accesses. Using -Ospace
results in unaligned accesses made through function calls.
In the disassembly of the unpacked struct example above, the compiler always accesses data on aligned
word or halfword addresses. The compiler is able to do this because the struct is padded so that every
member of the struct lies on its natural size boundary.
In the disassembly of the __packed struct example above, fields one and three are aligned on their
natural size boundaries by default, so the compiler makes aligned accesses. The compiler always carries
out aligned word or halfword accesses for fields it can identify as being aligned. For the unaligned field
Table 5-12 C code for a packed struct and a pragma packed struct
In the first implementation, taking the address of a field in a __packed struct or a __packed field in a
struct yields a __packed pointer, and the compiler generates a type error if you try to implicitly cast
this to a non-__packed pointer. In the second implementation, in contrast, taking the address of a field in
a #pragma packed struct does not yield a __packed-qualified pointer. However, the field might not be
properly aligned for its type, and dereferencing such an unaligned pointer results in Undefined behavior.
Related concepts
5.36 Unaligned fields in structures on page 5-194.
5.37 Performance penalty associated with marking whole structures as packed on page 5-195.
Related references
8.143 -Ospace on page 8-479.
8.144 -Otime on page 8-480.
10.12 __packed on page 10-612.
10.60 __attribute__((packed)) type attribute on page 10-665.
10.68 __attribute__((packed)) variable attribute on page 10-673.
10.97 #pragma pack(n) on page 10-703.
Related information
Application Binary Interface (ABI) for the ARM Architecture.
Code that uses hardware support for floating-point arithmetic is more compact and offers better
performance than code that performs floating-point arithmetic in software. However, hardware support
for floating-point arithmetic requires a VFP coprocessor.
Related concepts
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.48 Half-precision floating-point number format on page 5-211.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.50 Types of floating-point linkage on page 5-213.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
10.100 #pragma softfp_linkage, #pragma no_softfp_linkage on page 10-707.
8.43 --cpu=name on page 8-368.
10.118 __fabs intrinsic on page 10-727.
8.86 --fp16_format=format on page 8-414.
8.87 --fpmode=model on page 8-415.
8.88 --fpu=list on page 8-417.
8.89 --fpu=name on page 8-418.
10.142 __sqrt intrinsic on page 10-754.
10.160 GNU built-in functions on page 10-778.
10.161 Predefined macros on page 10-786.
Related information
Institute of Electrical and Electronics Engineers.
Floating-point Support.
ARM and Thumb floating-point build options (ARMv6 and earlier).
ARM and Thumb floating-point build options (ARMv7 and later).
If you are building ARM Linux applications using --arm_linux or --arm_linux_paths, the default is
always software floating-point linkage. Even if you specify a processor that implies an FPU (for
example, --cpu=ARM1136JF-S), the compiler still defaults to --fpu=softvfp+vfp, not --fpu=vfp.
If a VFP coprocessor is present, VFP instructions are generated. If there is no VFP coprocessor, the
compiler generates code that makes calls to the software floating-point library fplib to carry out
floating-point operations. fplib is available as part of the standard distribution of the ARM compilation
tools suite of C libraries.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.48 Half-precision floating-point number format on page 5-211.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.50 Types of floating-point linkage on page 5-213.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
Related information
Floating-point Support.
When the example C code is compiled with the command-line options --cpu 5TE and --fpu softvfp,
the compiler produces machine code with the disassembly shown below. In this case, floating-point
arithmetic is performed in software through calls to library routines such as __aeabi_fmul.
||foo|| PROC
PUSH {r4-r6, lr}
MOV r4, r1
BL __aeabi_fadd
MOV r5, r0
MOV r1, r4
MOV r0, r4
BL __aeabi_fmul
MOV r1, r5
POP {r4-r6, lr}
B __aeabi_fsub
ENDP
However, when the example C code is compiled with the command-line option --fpu vfp, the compiler
produces machine code with the disassembly shown below. In this case, floating-point arithmetic is
performed in hardware through floating-point arithmetic instructions such as VMUL.F32.
||foo|| PROC
VADD.F32 s2, s0, s1
VMUL.F32 s0, s1, s1
VSUB.F32 s0, s0, s2
BX lr
ENDP
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.48 Half-precision floating-point number format on page 5-211.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.50 Types of floating-point linkage on page 5-213.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
8.43 --cpu=name on page 8-368.
8.42 --cpu=list on page 8-367.
8.88 --fpu=list on page 8-417.
8.89 --fpu=name on page 8-418.
Related information
Application Binary Interface (ABI) for the ARM Architecture.
Note
Particular implementations of the VFP architecture might provide additional implementation-specific
functionality. For example, the VFP coprocessor hardware might include extra registers for describing
exceptional conditions. This extra functionality is known as sub-architecture functionality.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.48 Half-precision floating-point number format on page 5-211.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.50 Types of floating-point linkage on page 5-213.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
Related information
ARM Application Note 133 - Using VFP with RVDS.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.48 Half-precision floating-point number format on page 5-211.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.50 Types of floating-point linkage on page 5-213.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
Related information
Institute of Electrical and Electronics Engineers.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.48 Half-precision floating-point number format on page 5-211.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.50 Types of floating-point linkage on page 5-213.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
8.87 --fpmode=model on page 8-415.
Related information
ARM Application Note 133 - Using VFP with RVDS.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.48 Half-precision floating-point number format on page 5-211.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.50 Types of floating-point linkage on page 5-213.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
8.86 --fp16_format=format on page 8-414.
Related information
C++ ABI for the ARM Architecture.
Floating-point Support.
15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
S E T
Where:
S (bit[15]): Sign bit
E (bits[14:10]): Biased exponent
T (bits[9:0]): Mantissa.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.50 Types of floating-point linkage on page 5-213.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
8.86 --fp16_format=format on page 8-414.
Related information
Institute of Electrical and Electronics Engineers.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.48 Half-precision floating-point number format on page 5-211.
5.50 Types of floating-point linkage on page 5-213.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
10.47 __attribute__((pcs("calling_convention"))) function attribute on page 10-652.
10.15 __softfp on page 10-616.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.48 Half-precision floating-point number format on page 5-211.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
Related information
Procedure Call Standard for the ARM Architecture.
Table 5-13 Compiler options for floating-point linkage and floating-point computations
Linkage Computations
softvfp specifies software floating-point linkage. When software floating-point linkage is used, either:
• The calling function and the called function must be compiled using one of the options --softvfp,
--fpu softvfp+vfpv2, --fpu softvfp+vfpv3, --fpu softvfp+vfpv3_fp16, softvfp+vfpv3_d16,
softvfp+vfpv3_d16_fp16, softvfp+vfpv4, softvfp+vfpv4_d16, or softvfp+fpv4-sp.
• The calling function and the called function must be declared using the __softfp keyword.
Each of the options --fpu softvfp, --fpu softvfp+vfpv2,--fpu softvfp+vfpv3,
--fpu softvfp+vfpv3_fp16, --fpu softvfpv3_d16, --fpu softvfpv3_d16_fp16,
--fpu softvfp+vfpv4, softvfp+vfpv4_d16 and softvfp+fpv4-sp specify software floating-point
linkage across the whole file. In contrast, the __softfp keyword enables software floating-point linkage
to be specified on a function by function basis.
Note
Rather than having separate compiler options to select the type of floating-point linkage you require and
the type of floating-point computations you require, you use one compiler option, --fpu, to select both.
For example, --fpu=softvfp+vfpv2 selects software floating-point linkage, and a hardware coprocessor
for the computations. Whenever you use softvfp, you are specifying software floating-point linkage.
If you use the --fpu option, you must know the VFP architecture version implemented in the target
processor. An alternative to --fpu=softvfp+... is --apcs=/softfp. This gives software linkage with
whatever VFP architecture version is implied by --cpu. --apcs=/softfp and --apcs=/hardfp are
alternative ways of requesting the integer or floating-point variant of the Procedure Call Standard for the
ARM Architecture (AAPCS).
To use hardware floating-point linkage when targeting ARM Linux, you must explicitly specify a --fpu
option that implies hardware floating-point linkage, for example, --fpu=vfpv3, or compile with
--apcs=/hardfp. The ARM Linux ABI does not support hardware floating-point linkage. The compiler
issues a warning to indicate this.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.48 Half-precision floating-point number format on page 5-211.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.50 Types of floating-point linkage on page 5-213.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
8.6 --apcs=qualifier...qualifier on page 8-322.
8.89 --fpu=name on page 8-418.
8.115 --library_interface=lib on page 8-446.
10.15 __softfp on page 10-616.
10.100 #pragma softfp_linkage, #pragma no_softfp_linkage on page 10-707.
Related information
Procedure Call Standard for the ARM Architecture.
softvfp No No No No No No No
softvfp+vfpv2 No Yes No Yes No Yes Yes
softvfp+vfpv3 No Yes Yes Yes No Yes Yes
softvfp No Yes Yes Yes Yes Yes Yes
+vfpv3_fp16
Note
You can specify the floating-point linkage, independently of the VFP architecture, with --apcs.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
Related references
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
8.6 --apcs=qualifier...qualifier on page 8-322.
8.89 --fpu=name on page 8-418.
ARM7TDMI SoftVFP
ARM7TDMI-S SoftVFP
ARM720T SoftVFP
ARM9E-S SoftVFP
ARM9TDMI SoftVFP
ARM920T SoftVFP
ARM922T SoftVFP
ARM926EJ-S SoftVFP
ARM946E-S SoftVFP
ARM966E-S SoftVFP
ARM1020E SoftVFP
ARM1136J-S SoftVFP
ARM1136J-S-rev1 SoftVFP
ARM1136JF-S VFPv2
ARM1136JF-S-rev1 VFPv2
ARM1156T2-S SoftVFP
ARM1176JZ-S SoftVFP
ARM1176JZF-S VFPv2
Cortex-A5 SoftVFP
Cortex-A5.vfp VFPv4_D16
Cortex-A5.neon VFPv4
Cortex-A7 VFPv4
Cortex-A7.no_neon VFPv4_D16
Cortex-A7.no_neon.no_vfp SoftVFP
Cortex-A8 VFPv3
Cortex-A8.no_neon SoftVFP
Cortex-A8NoNeon SoftVFP
Cortex-A9 VFPv3_FP16
Cortex-A9.no_neon VFPv3_D16_FP16
Cortex-A9.no_neon.no_vfp SoftVFP
Cortex-A12 VFPv4
Cortex-A12.no_neon.no_vfp SoftVFP
Cortex-A15 VFPv4
Cortex-A15.no_neon VFPv4_D16
Cortex-A15.no_neon.no_vfp SoftVFP
Cortex-A17 VFPv4
Cortex-A17.no_neon.no_vfp SoftVFP
Cortex-M0 SoftVFP
Cortex-M0plus SoftVFP
Cortex-M1 SoftVFP
Cortex-M1.os_extension SoftVFP
Cortex-M1.no_os_extension SoftVFP
Cortex-M3 SoftVFP
Cortex-M3-rev0 SoftVFP
Cortex-M4 SoftVFP
Cortex-M4.fp.sp FPv4-SP
Cortex-M7 SoftVFP
Cortex-M7.fp.sp FPv5-SP
Cortex-M7.fp.dp FPv5_D16
Cortex-R4 SoftVFP
Cortex-R4F VFPv3_D16
Cortex-R5 SoftVFP
Cortex-R5-rev1 SoftVFP
Cortex-R5F VFPv3_D16
Cortex-R5F-rev1 VFPv3_D16
Cortex-R5F-rev1.sp VFPv3_SP_D16
Cortex-R7 VFPv3_D16_FP16
Cortex-R7.no_vfp SoftVFP
Cortex-R8 VFPv3_D16_FP16
Cortex-R8.no_vfp SoftVFP
MPCore VFPv2
MPCore.no_vfp SoftVFP
MPCoreNoVFP SoftVFP
SC000 SoftVFP
SC300 SoftVFP
PJ4.no_vfp SoftVFP
QSP VFPv3_FP16
QSP.no_neon VFPv3_FP16
QSP.no_neon.no_vfp SoftVFP
Note
You can:
• Specify a different FPU with --fpu.
• Specify the floating-point linkage, independently of the FPU architecture, with --apcs.
• Display the complete expanded command line, including the FPU, with --echo.
Related concepts
5.41 Compiler support for floating-point arithmetic on page 5-200.
5.42 Default selection of hardware or software floating-point support on page 5-202.
5.43 Example of hardware and software support differences for floating-point arithmetic on page 5-203.
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
5.46 Implementation of Vector Floating-Point (VFP) support code on page 5-208.
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
5.48 Half-precision floating-point number format on page 5-211.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
5.50 Types of floating-point linkage on page 5-213.
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
5.52 Floating-point linkage and computational requirements of compiler options on page 5-216.
8.6 --apcs=qualifier...qualifier on page 8-322.
8.71 --echo on page 8-399.
8.89 --fpu=name on page 8-418.
When integer division by zero is detected, a branch to __aeabi_idiv0() is made. To trap the division by
zero, therefore, you only have to place a breakpoint on __aeabi_idiv0().
The library provides two implementations of __aeabi_idiv0(). The default one does nothing, so if
division by zero is detected, the division function returns zero. However, if you use signal handling, an
alternative implementation is selected that calls __rt_raise(SIGFPE, DIVBYZERO).
If you provide your own version of __aeabi_idiv0(), then the division functions call this function. The
function prototype for __aeabi_idiv0() is:
int __aeabi_idiv0(void);
If __aeabi_idiv0() returns a value, that value is used as the quotient returned by the division function.
On entry into __aeabi_idiv0(), the link register LR contains the address of the instruction after the call
to the __aeabi_uidiv() division routine in your application code.
The offending line in the source code can be identified by looking up the line of C code in the debugger
at the address given by LR.
If you want to examine parameters and save them for postmortem debugging when trapping
__aeabi_idiv0, you can use the $Super$$ and $Sub$$ mechanism:
1. Prefix __aeabi_idiv0() with $Super$$ to identify the original unpatched function
__aeabi_idiv0().
2. Use __aeabi_idiv0() prefixed with $Super$$ to call the original function directly.
3. Prefix __aeabi_idiv0() with $Sub$$ to identify the new function to be called in place of the
original version of __aeabi_idiv0().
4. Use __aeabi_idiv0() prefixed with $Sub$$ to add processing before or after the original function
__aeabi_idiv0().
The following example shows how to intercept __aeabi_div0 using the $Super$$ and $Sub$$
mechanism.
extern void $Super$$__aeabi_idiv0(void);
/* this function is called instead of the original __aeabi_idiv0() */
void $Sub$$__aeabi_idiv0()
{
// insert code to process a divide by zero
...
// call the original __aeabi_idiv0 function
$Super$$__aeabi_idiv0();
}
If you re-implement __rt_raise(), then the library automatically provides the signal-handling library
version of __aeabi_idiv0(), which calls __rt_raise(), then that library version of __aeabi_idiv0()
is included in the final image.
In that case, when a divide-by-zero error occurs, __aeabi_idiv0() calls __rt_raise(SIGFPE,
DIVBYZERO). Therefore, if you re-implement __rt_raise(), you must check (signal == SIGFPE) &&
(type == DIVBYZERO) to determine if division by zero has occurred.
Related information
Run-time ABI for the ARM Architecture.
Related concepts
5.56 About trapping software floating-point division-by-zero errors on page 5-224.
5.57 Identification of software floating-point division-by-zero errors on page 5-225.
5.58 Software floating-point division-by-zero debugging on page 5-227.
This traps any division-by-zero errors in code, and untraps all other exceptions, as illustrated in the
following example:
#include <stdio.h>
#include <fenv.h>
int main(void)
{ float a, b, c;
// Trap the Invalid Operation exception and untrap all other
// exceptions:
__ieee_status(FE_IEEE_MASK_ALL_EXCEPT, FE_IEEE_MASK_DIVBYZERO);
c = 0;
a = b / c;
printf("b / c = %f, ", a); // trap division-by-zero error
return 0;
}
Related concepts
5.55 Software floating-point division-by-zero errors in C code on page 5-223.
5.57 Identification of software floating-point division-by-zero errors on page 5-225.
5.58 Software floating-point division-by-zero debugging on page 5-227.
Related information
__ieee_status().
Placing a breakpoint on _fp_trapveneer() and executing the disassembly in the debug monitor
produces:
> run
Execution stopped at breakpoint 1: S:0x0000BAC8
In _fp_trapveneer (no debug info)
S:0x0000BAC8 PUSH {r12,lr}
The address contained in the link register LR is set to 0x8108, the address of the instruction after the
instruction BL __aeabi_fdiv that resulted in the exception.
Related concepts
5.55 Software floating-point division-by-zero errors in C code on page 5-223.
5.56 About trapping software floating-point division-by-zero errors on page 5-224.
5.58 Software floating-point division-by-zero debugging on page 5-227.
Related concepts
5.55 Software floating-point division-by-zero errors in C code on page 5-223.
5.56 About trapping software floating-point division-by-zero errors on page 5-224.
5.57 Identification of software floating-point division-by-zero errors on page 5-225.
Related information
Use of $Super$$ and $Sub$$ to patch symbol definitions.
• Some features available in C++, such as // comments and the ability to mix declarations and
statements.
• Some entirely new features, for example complex numbers, restricted pointers and designated
initializers.
• New keywords and identifiers.
• Extended syntax for the existing C90 language.
A selection of new features in C99 that might be of interest to developers using them for the first time are
documented.
Note
C90 is compatible with Standard C++ in the sense that the language specified by the standard is a subset
of C++, except for a few special cases. New features in the C99 standard mean that C99 is no longer
compatible with C++ in this sense.
Some examples of special cases where the language specified by the C90 standard is not a subset of C++
include support for // comments and merging of the typedef and structure tag namespaces. For example,
in C90 the following code expands to x = a / b - c; because /* hello world */ is deleted, but in C
++ and C99 it expands to x = a - c; because everything from // to the end of the first line is deleted:
x = a //* hello world */ b
- c;
The following code demonstrates how typedef and the structure tag are treated differently between C (90
and 99) and C++ because of their merged namespaces:
typedef int a;
{
struct a { int x, y; };
printf("%d\n", sizeof(a));
}
In C 90 and C99, this code defines two types with separate names whereby a is a typedef for int and
struct a is a structure type containing two integer data types. sizeof(a) evaluates to sizeof(int).
In C++, a structure type can be addressed using only its tag. This means that when the definition of
struct a is in scope, the name a used on its own refers to the structure type rather than the typedef, so
in C++ sizeof(a) is greater than sizeof(int).
Related concepts
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
Many library features that are new to C99 are available in C90 and C++. Some require macros such as
USE_C99_ALL or USE_C99_MATH to be defined before the #include.
Related concepts
5.74 Additional <math.h> library functions in C99 on page 5-244.
5.75 Complex numbers in C99 on page 5-245.
5.76 Boolean type and <stdbool.h> in C99 on page 5-246.
5.77 Extended integer types and functions in <inttypes.h> and <stdint.h> in C99 on page 5-247.
5.78 <fenv.h> floating-point environment access in C99 on page 5-248.
5.79 <stdio.h> snprintf family of functions in C99 on page 5-249.
5.80 <tgmath.h> type-generic math macros in C99 on page 5-250.
5.81 <wchar.h> wide character I/O functions in C99 on page 5-251.
Related concepts
5.59 New language features of C99 on page 5-228.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
Related references
8.176 --strict, --no_strict on page 8-513.
9.7 // comments on page 9-557.
Note
int *y = (int []) {1, 2, 3}; is accepted by the compiler, but int y[] = (int []) {1, 2, 3};
is not accepted as a high-level (global) initialization.
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
Members of an aggregate that are not explicitly initialized are initialized to zero by default.
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
In hexadecimal format the exponent is a decimal number that indicates the power of two by which the
significant part is multiplied. Therefore 0x1.fp3 = 1.9375 * 8 = 1.55e1.
C99 also adds %a and %A format for printf().
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
Note
When a struct has a flexible array member, the entire struct itself has incomplete type.
Flexible array members enable you to mimic dynamic type specification in C in the sense that you can
defer the specification of the array size to runtime. For example:
extern const int n;
typedef struct
{
int len;
char p[];
} str;
void foo(void)
{
size_t str_size = sizeof(str); // equivalent to offsetoff(str, p)
str *s = malloc(str_size + (sizeof(char) * n));
}
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
prints:
This function is called 'foo'.
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
Related references
10.162 Built-in function name variables on page 10-792.
The compiler inlines a function qualified with inline only if it is reasonable to do so. It is free to ignore
the hint if inlining the function adversely affects performance.
Note
The __inline keyword is available in C90.
Note
The semantics of inline in C99 are different to the semantics of inline in Standard C++.
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
5.20 Inline functions on page 5-177.
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
Related references
9.12 long long on page 9-562.
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
5.71 New block scopes for selection and iteration statements in C99
In a for loop, the first expression can be a declaration, like in C++. The scope of the declaration extends
to the body of the loop only.
For example:
extern int max;
for (int n = max - 1; n >= 0; n--)
{
// body of loop
}
is equivalent to:
extern int max;
{
int n = max - 1;
for (; n >= 0; n--)
{
// body of loop
}
}
Note
Unlike in C++, you cannot introduce new declarations in a for-test, if-test or switch-expression.
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
For example:
# define RWDATA(X) PRAGMA(arm section rwdata=#X)
# define PRAGMA(X) _Pragma(#X)
RWDATA(foo) // same as #pragma arm section rwdata="foo"
int y = 1; // y is placed in section "foo"
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.73 Restricted pointers in C99 on page 5-243.
5.75 Complex numbers in C99 on page 5-245.
Pointers qualified with restrict can however point to different arrays, or to different regions within an
array.
It is your responsibility to ensure that restrict-qualified pointers do not point to overlapping regions of
memory.
__restrict, permitted in C90 and C++, is a synonym for restrict.
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.75 Complex numbers in C99 on page 5-245.
Related references
8.164 --restrict, --no_restrict on page 8-500.
New generic function macros found in C99 that are not found in C90 include:
#define isinf(x) // non-zero only if x is positive or negative infinity
#define isnan(x) // non-zero only if x is NaN
#define isless(x, y) // 1 only if x < y and x and y are not NaN, and 0 otherwise
#define isunordered(x, y) // 1 only if either x or y is NaN, and 0 otherwise
New mathematical functions found in C99 that are not found in C90 include:
double acosh(double x); // hyperbolic arccosine of x
double asinh(double x); // hyperbolic arcsine of x
double atanh(double x); // hyperbolic arctangent of x
double erf(double x); // returns the error function of x
double round(double x); // returns x rounded to the nearest integer
double tgamma(double x); // returns the gamma function of x
C99 supports the new mathematical functions for all real floating-point types.
Single precision versions of all existing <math.h> functions are also supported.
Related concepts
5.60 New library features of C99 on page 5-230.
5.75 Complex numbers in C99 on page 5-245.
5.76 Boolean type and <stdbool.h> in C99 on page 5-246.
5.77 Extended integer types and functions in <inttypes.h> and <stdint.h> in C99 on page 5-247.
5.78 <fenv.h> floating-point environment access in C99 on page 5-248.
5.79 <stdio.h> snprintf family of functions in C99 on page 5-249.
5.80 <tgmath.h> type-generic math macros in C99 on page 5-250.
5.81 <wchar.h> wide character I/O functions in C99 on page 5-251.
Related information
Institute of Electrical and Electronics Engineers.
Related concepts
5.59 New language features of C99 on page 5-228.
5.61 // comments in C99 and C90 on page 5-231.
5.62 Compound literals in C99 on page 5-232.
5.63 Designated initializers in C99 on page 5-233.
5.64 Hexadecimal floating-point numbers in C99 on page 5-234.
5.65 Flexible array members in C99 on page 5-235.
5.66 __func__ predefined identifier in C99 on page 5-236.
5.67 inline functions in C99 on page 5-237.
5.68 long long data type in C99 and C90 on page 5-238.
5.69 Macros with a variable number of arguments in C99 on page 5-239.
5.70 Mixed declarations and statements in C99 on page 5-240.
5.71 New block scopes for selection and iteration statements in C99 on page 5-241.
5.72 _Pragma preprocessing operator in C99 on page 5-242.
5.73 Restricted pointers in C99 on page 5-243.
5.60 New library features of C99 on page 5-230.
5.74 Additional <math.h> library functions in C99 on page 5-244.
5.76 Boolean type and <stdbool.h> in C99 on page 5-246.
5.77 Extended integer types and functions in <inttypes.h> and <stdint.h> in C99 on page 5-247.
5.78 <fenv.h> floating-point environment access in C99 on page 5-248.
5.79 <stdio.h> snprintf family of functions in C99 on page 5-249.
5.80 <tgmath.h> type-generic math macros in C99 on page 5-250.
5.81 <wchar.h> wide character I/O functions in C99 on page 5-251.
Note
The C99 semantics for bool are intended to match those of C++.
Related concepts
5.60 New library features of C99 on page 5-230.
5.74 Additional <math.h> library functions in C99 on page 5-244.
5.75 Complex numbers in C99 on page 5-245.
5.77 Extended integer types and functions in <inttypes.h> and <stdint.h> in C99 on page 5-247.
5.78 <fenv.h> floating-point environment access in C99 on page 5-248.
5.79 <stdio.h> snprintf family of functions in C99 on page 5-249.
5.80 <tgmath.h> type-generic math macros in C99 on page 5-250.
5.81 <wchar.h> wide character I/O functions in C99 on page 5-251.
5.77 Extended integer types and functions in <inttypes.h> and <stdint.h> in C99
In C90, the long data type can serve both as the largest integral type, and as a 32-bit container. C99
removes this ambiguity through the new standard library header files <inttypes.h> and <stdint.h>.
The header file <stdint.h> introduces the new types:
• intmax_t and uintmax_t, that are maximum width signed and unsigned integer types.
• intptr_t and unintptr_t, that are integer types capable of holding signed and unsigned object
pointers.
The header file <inttypes.h> provides library functions for manipulating values of type intmax_t,
including:
intmax_t imaxabs(intmax_t x); // absolute value of x
imaxdiv_t imaxdiv(intmax_t x, intmax_t y) // returns the quotient and remainder
// of x / y
Related concepts
5.60 New library features of C99 on page 5-230.
5.74 Additional <math.h> library functions in C99 on page 5-244.
5.75 Complex numbers in C99 on page 5-245.
5.76 Boolean type and <stdbool.h> in C99 on page 5-246.
5.78 <fenv.h> floating-point environment access in C99 on page 5-248.
5.79 <stdio.h> snprintf family of functions in C99 on page 5-249.
5.80 <tgmath.h> type-generic math macros in C99 on page 5-250.
5.81 <wchar.h> wide character I/O functions in C99 on page 5-251.
Related concepts
5.60 New library features of C99 on page 5-230.
5.74 Additional <math.h> library functions in C99 on page 5-244.
5.75 Complex numbers in C99 on page 5-245.
5.76 Boolean type and <stdbool.h> in C99 on page 5-246.
5.77 Extended integer types and functions in <inttypes.h> and <stdint.h> in C99 on page 5-247.
5.79 <stdio.h> snprintf family of functions in C99 on page 5-249.
5.80 <tgmath.h> type-generic math macros in C99 on page 5-250.
5.81 <wchar.h> wide character I/O functions in C99 on page 5-251.
Related information
Institute of Electrical and Electronics Engineers.
the full output of the formatting operation is written into buffer regardless of whether there is enough
space to hold it. Consequently, more characters can be output than might fit in the memory allocated to
the string.
The snprintf functions found in the C99 version of <stdio.h> are safe versions of the sprintf
functions that prevent buffer overrun. In the statement:
snprintf(buffer, size, "Error %d: Cannot open file '%s'", errno, filename);
the variable size specifies the maximum number of characters that can be written to buffer. The buffer
can never be overrun, provided its size is always greater than the size specified by size.
Note
The C standard does not define what should happen if buffer + size exceeds 4GB (the limit of the 32-
bit address space). In this scenario, the ARM implementation of snprintf does not write any data to the
buffer (to prevent wrapping the buffer around the address space) and returns the number of bytes that
would have been written.
Related concepts
5.60 New library features of C99 on page 5-230.
5.74 Additional <math.h> library functions in C99 on page 5-244.
5.75 Complex numbers in C99 on page 5-245.
5.76 Boolean type and <stdbool.h> in C99 on page 5-246.
5.77 Extended integer types and functions in <inttypes.h> and <stdint.h> in C99 on page 5-247.
5.78 <fenv.h> floating-point environment access in C99 on page 5-248.
5.80 <tgmath.h> type-generic math macros in C99 on page 5-250.
5.81 <wchar.h> wide character I/O functions in C99 on page 5-251.
calls the single-precision version of the cos function, as determined by the type of the literal 0.78539f.
Note
Type-generic families of mathematical functions can be defined in C++ using the operator overloading
mechanism. The semantics of type-generic families of functions defined using operator overloading in
C++ are different from the semantics of the corresponding families of type-generic functions defined in
<tgmath.h>.
Related concepts
5.60 New library features of C99 on page 5-230.
5.74 Additional <math.h> library functions in C99 on page 5-244.
5.75 Complex numbers in C99 on page 5-245.
5.76 Boolean type and <stdbool.h> in C99 on page 5-246.
5.77 Extended integer types and functions in <inttypes.h> and <stdint.h> in C99 on page 5-247.
5.78 <fenv.h> floating-point environment access in C99 on page 5-248.
5.79 <stdio.h> snprintf family of functions in C99 on page 5-249.
5.81 <wchar.h> wide character I/O functions in C99 on page 5-251.
Related concepts
5.60 New library features of C99 on page 5-230.
5.74 Additional <math.h> library functions in C99 on page 5-244.
5.75 Complex numbers in C99 on page 5-245.
5.76 Boolean type and <stdbool.h> in C99 on page 5-246.
5.77 Extended integer types and functions in <inttypes.h> and <stdint.h> in C99 on page 5-247.
5.78 <fenv.h> floating-point environment access in C99 on page 5-248.
5.79 <stdio.h> snprintf family of functions in C99 on page 5-249.
5.80 <tgmath.h> type-generic math macros in C99 on page 5-250.
The following example shows how to keep uninitialized data using #pragma arm section:
#pragma arm section zidata = "non_initialized"
int i, j; // uninitialized data in non_initialized section (without the pragma,
// would be in .bss section by default)
#pragma arm section zidata // back to default (.bss section)
int k = 0, l = 0; // zero-initialized data in .bss section
Specify --bss_threshold=0 when compiling this example code, to ensure that k and l are placed in a ZI
data section. If --bss_threshold=0 is not used, section name rwdata must be used instead of zidata.
The non_initialized section is placed into its own UNINIT execution region, as follows:
LOAD_1 0x0
{
EXEC_1 +0
{
* (+RO)
* (+RW)
* (+ZI) ; ZI data gets initialized to zero
}
EXEC_2 +0 UNINIT
{
* (non_initialized) ; ZI data does not get initialized to zero
}
}
Related references
8.93 --gnu on page 8-424.
10.79 #pragma arm section [section_type_list] on page 10-684.
10.69 __attribute__((section("name"))) variable attribute on page 10-674.
8.20 --bss_threshold=num on page 8-343.
Related information
Execution region attributes.
Describes the format of compiler diagnostic messages and how to control the output during compilation.
The compiler issues messages about potential portability problems and other hazards. It is possible to:
• Turn off specific messages. For example, warnings can be turned off if you are in the early stages of
porting a program written in old-style C. In general, however, it is better to check the code than to
turn off messages.
• Change the severity of specific messages.
It contains the following sections:
• 6.1 Severity of compiler diagnostic messages on page 6-254.
• 6.2 Options that change the severity of compiler diagnostic messages on page 6-255.
• 6.3 Controlling compiler diagnostic messages with pragmas on page 6-257.
• 6.4 Prefix letters in compiler diagnostic messages on page 6-259.
• 6.5 Compiler exit status codes and termination messages on page 6-260.
• 6.6 Compiler data flow warnings on page 6-261.
Severity Description
Internal fault Internal faults indicate an internal problem with the compiler. Contact your supplier with feedback.
Error Errors indicate problems that cause the compilation to stop. These errors include command line errors, internal errors,
missing include files, and violations in the syntactic or semantic rules of the C or C++ language. If multiple source files
are specified, no more source files are compiled.
Warning Warnings indicate unusual conditions in your code that might indicate a problem. Compilation continues, and object
code is generated unless any more problems with an Error severity are detected.
Remark Remarks indicate common, but sometimes unconventional, use of C or C++. These diagnostics are not displayed by
default. Compilation continues, and object code is generated unless any more problems with an Error severity are
detected.
Related concepts
6.2 Options that change the severity of compiler diagnostic messages on page 6-255.
6.3 Controlling compiler diagnostic messages with pragmas on page 6-257.
6.4 Prefix letters in compiler diagnostic messages on page 6-259.
6.5 Compiler exit status codes and termination messages on page 6-260.
6.6 Compiler data flow warnings on page 6-261.
Note
tag is the four-digit number, nnnn, with the tool letter prefix, but without the letter suffix indicating the
severity.
Only errors with a suffix of -D following the error number can be downgraded by changing them into
warnings or remarks.
Note
These options also have pragma equivalents.
Related concepts
6.3 Controlling compiler diagnostic messages with pragmas on page 6-257.
6.4 Prefix letters in compiler diagnostic messages on page 6-259.
6.5 Compiler exit status codes and termination messages on page 6-260.
6.6 Compiler data flow warnings on page 6-261.
Related references
6.1 Severity of compiler diagnostic messages on page 6-254.
10.80 #pragma diag_default tag[,tag,...] on page 10-686.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
Examples
The following example shows three identical functions, foo1(), foo2(), and foo3(), all of which would
normally provoke diagnostic message #177-D: variable "x" was declared but never
referenced.
For foo1(), the current pragma state is pushed to the stack and #pragma diag_suppress suppresses the
message. The message is re-enabled by #pragma pop before compiling foo2(). In foo3(), the message
is not suppressed because the #pragma push and #pragma pop do not enclose the full scope responsible
for the generation of the message:
#pragma push
#pragma diag_suppress 177
void foo1( void )
{
/* Here we do not expect a diagnostic, because we suppressed it. */
int x;
}
#pragma pop
Diagnostic messages use the pragma state in place at the time they are generated. If you use pragmas to
control a message in your code, you must be aware of when that message is generated. For example, the
following code is intended to suppress the diagnostic message #177-D: function "dummy" was
declared but never referenced:
#include <stdio.h>
#pragma push
#pragma diag_suppress 177
static int dummy(void)
{
printf("This function is never called.");
return 1;
}
#pragma pop
main(void){
printf("Hello world!\n");
}
However, message 177 is only generated after all functions have been processed. Therefore, the message
is generated after pragma pop restores the pragma state, and message 177 is not suppressed.
Removing pragma push and pragma pop would correctly suppress message 177, but would suppress
messages for all unreferenced functions rather than for only the dummy() function.
Related concepts
6.2 Options that change the severity of compiler diagnostic messages on page 6-255.
6.4 Prefix letters in compiler diagnostic messages on page 6-259.
6.5 Compiler exit status codes and termination messages on page 6-260.
6.6 Compiler data flow warnings on page 6-261.
Related references
6.1 Severity of compiler diagnostic messages on page 6-254.
10.80 #pragma diag_default tag[,tag,...] on page 10-686.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
10.84 #pragma diag_warning tag[, tag, ...] on page 10-690.
10.98 #pragma pop on page 10-705.
10.99 #pragma push on page 10-706.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.64 --diag_warning=optimizations on page 8-392.
C armcc
A armasm
L armlink or armar
Q fromelf
Use the prefix letters to control options that are passed from the compiler to other tools, for example,
include the prefix letter L to specify linker message numbers.
Related concepts
6.2 Options that change the severity of compiler diagnostic messages on page 6-255.
6.3 Controlling compiler diagnostic messages with pragmas on page 6-257.
6.5 Compiler exit status codes and termination messages on page 6-260.
6.6 Compiler data flow warnings on page 6-261.
Related references
6.1 Severity of compiler diagnostic messages on page 6-254.
The signals SIGINT (caused by a user interrupt, like ^C) and SIGTERM (caused by a UNIX kill
command) are trapped by the compiler and cause abnormal termination.
On completion, the compiler returns a value greater than zero if an error is detected. If no error is
detected, a value of zero is returned.
Related concepts
6.2 Options that change the severity of compiler diagnostic messages on page 6-255.
6.3 Controlling compiler diagnostic messages with pragmas on page 6-257.
6.4 Prefix letters in compiler diagnostic messages on page 6-259.
6.6 Compiler data flow warnings on page 6-261.
Related references
6.1 Severity of compiler diagnostic messages on page 6-254.
The results of the analysis vary with the level of optimization used. This means that higher optimization
levels might produce a number of warnings that do not appear at lower levels.
The data flow analysis cannot reliably identify faulty code and any C4017W warnings issued by the
compiler are intended only as an indication of possible problems. For a full analysis of your code, use an
appropriate third-party analysis tool, for example Lint.
Related concepts
6.2 Options that change the severity of compiler diagnostic messages on page 6-255.
6.3 Controlling compiler diagnostic messages with pragmas on page 6-257.
6.4 Prefix letters in compiler diagnostic messages on page 6-259.
6.5 Compiler exit status codes and termination messages on page 6-260.
Related references
6.1 Severity of compiler diagnostic messages on page 6-254.
Describes the optimizing inline assembler and non-optimizing embedded assembler of the ARM
compiler, armcc.
Note
Using intrinsics is generally preferable to using inline or embedded assembly language.
• 7.17 Expansion of inline assembler instructions that use constants on page 7-281.
• 7.18 Expansion of inline assembler load and store instructions on page 7-282.
• 7.19 Inline assembler effect on processor condition flags in C and C++ code on page 7-283.
• 7.20 Inline assembler expression operands in C and C++ code on page 7-284.
• 7.21 Inline assembler register list operands in C and C++ code on page 7-285.
• 7.22 Inline assembler intermediate operands in C and C++ code on page 7-286.
• 7.23 Inline assembler function calls and branches in C and C++ code on page 7-287.
• 7.24 Inline assembler branches and labels in C and C++ code on page 7-289.
• 7.25 Inline assembler and virtual registers on page 7-290.
• 7.26 Embedded assembler support in the compiler on page 7-291.
• 7.27 Embedded assembler syntax in C and C++ on page 7-292.
• 7.28 Effect of compiler ARM and Thumb states on embedded assembler on page 7-293.
• 7.29 Restrictions on embedded assembly language functions in C and C++ code on page 7-294.
• 7.30 Compiler generation of embedded assembly language functions on page 7-295.
• 7.31 Access to C and C++ compile-time constant expressions from embedded assembler
on page 7-297.
• 7.32 Differences between expressions in embedded assembler and C or C++ on page 7-298.
• 7.33 Manual overload resolution in embedded assembler on page 7-299.
• 7.34 __offsetof_base keyword for related base classes in embedded assembler on page 7-300.
• 7.35 Compiler-supported keywords for calling class member functions in embedded assembler
on page 7-301.
• 7.36 __mcall_is_virtual(D, f) on page 7-302.
• 7.37 __mcall_is_in_vbase(D, f) on page 7-303.
• 7.38 __mcall_offsetof_vbase(D, f) on page 7-304.
• 7.39 __mcall_this_offset(D, f) on page 7-305.
• 7.40 __vcall_offsetof_vfunc(D, f) on page 7-306.
• 7.41 Calling nonstatic member functions in embedded assembler on page 7-307.
• 7.42 Calling a nonvirtual member function on page 7-308.
• 7.43 Calling a virtual member function on page 7-309.
• 7.44 Accessing sp (r13), lr (r14), and pc (r15) on page 7-310.
• 7.45 Differences in compiler support for inline and embedded assembly code on page 7-311.
Related concepts
7.2 Inline assembler support in the compiler on page 7-265.
7.3 Restrictions on inline assembler support in the compiler on page 7-266.
7.4 Inline assembly language syntax with the __asm keyword in C and C++ on page 7-267.
7.5 Inline assembly language syntax with the asm keyword in C++ on page 7-268.
7.6 Inline assembler rules for compiler keywords __asm and asm on page 7-269.
7.7 Restrictions on inline assembly operations in C and C++ code on page 7-270.
7.14 Inline assembler and register access in C and C++ code on page 7-277.
7.15 Inline assembler and the # constant expression specifier in C and C++ code on page 7-279.
7.19 Inline assembler effect on processor condition flags in C and C++ code on page 7-283.
7.20 Inline assembler expression operands in C and C++ code on page 7-284.
7.21 Inline assembler register list operands in C and C++ code on page 7-285.
7.22 Inline assembler intermediate operands in C and C++ code on page 7-286.
7.45 Differences in compiler support for inline and embedded assembly code on page 7-311.
7.23 Inline assembler function calls and branches in C and C++ code on page 7-287.
7.24 Inline assembler branches and labels in C and C++ code on page 7-289.
7.16 Inline assembler and instruction expansion in C and C++ code on page 7-280.
Related references
10.159 Named register variables on page 10-774.
Related information
armasm User Guide.
Mixing C, C++, and Assembly Language.
7.4 Inline assembly language syntax with the __asm keyword in C and C++
The inline assembler is invoked with the assembler specifier, __asm, and is followed by a list of
assembler instructions inside braces or parentheses.
You can specify inline assembly code using the following formats:
• On a single line, for example:
__asm("instruction[;instruction]");
__asm{instruction[;instruction]}
This enables you to use macros to generate inline assembly, for example:
#define ADDLSL(x, y, shift) __asm ("ADD " #x ", " #y ", LSL " #shift)
• On multiple lines, for example:
__asm
{
...
instruction
...
}
You can use C or C++ comments anywhere in an inline assembly language block.
You can use an __asm statement wherever a statement is expected.
7.5 Inline assembly language syntax with the asm keyword in C++
When compiling C++, the compiler supports the asm syntax proposed in the ISO C++ Standard.
You can specify inline assembly code using the following formats:
• On a single line, for example:
asm("instruction[;instruction]");
asm{instruction[;instruction]}
This enables you to use macros to generate inline assembly, for example:
#define ADDLSL(x, y, shift) asm ("ADD " #x ", " #y ", LSL " #shift)
• On multiple lines, for example:
asm
{
...
instruction
...
}
You can use C or C++ comments anywhere in an inline assembly language block.
You can use an asm statement wherever a statement is expected.
7.6 Inline assembler rules for compiler keywords __asm and asm
There are a number of rule that apply to the __asm and asm keywords.
These rules are as follows:
• Multiple instructions on the same line must be separated with a semicolon (;).
• If an instruction requires more than one line, line continuation must be specified with the backslash
character (\).
• For the multiple line format, C and C++ comments are permitted anywhere in the inline assembly
language block. However, comments cannot be embedded in a line that contains multiple
instructions.
• The comma (,) is used as a separator in assembly language, so C expressions with the comma
operator must be enclosed in parentheses to distinguish them:
__asm
{
ADD x, y, (f(), z)
}
• Labels must be followed by a colon, :, like C and C++ labels.
• An asm statement must be inside a C++ function. An asm statement can be used anywhere a C++
statement is expected.
• Register names in inline assembly code are treated as C or C++ variables. They do not necessarily
relate to the physical register of the same name. If the register is not declared as a C or C++ variable,
the compiler generates a warning.
• Registers must not be saved and restored in inline assembly code. The compiler does this for you.
Also, the inline assembler does not provide direct access to the physical registers. However, indirect
access is provided through variables that act as virtual registers.
If registers other than ASPR, CPSR, and SPSR are read without being written to, an error message is
issued. For example:
int f(int x)
{
__asm
{
STMFD sp!, {r0} // save r0 - illegal: read before write
ADD r0, x, 1
EOR x, r0, x
LDMFD sp!, {r0} // restore r0 - not needed.
}
return x;
}
Related concepts
7.8 Inline assembler register restrictions in C and C++ code on page 7-271.
7.9 Inline assembler processor mode restrictions in C and C++ code on page 7-272.
7.10 Inline assembler Thumb instruction set restrictions in C and C++ code on page 7-273.
7.11 Inline assembler Vector Floating-Point (VFP) restrictions in C and C++ code on page 7-274.
7.12 Inline assembler instruction restrictions in C and C++ code on page 7-275.
7.13 Miscellaneous inline assembler restrictions in C and C++ code on page 7-276.
Related concepts
7.7 Restrictions on inline assembly operations in C and C++ code on page 7-270.
7.9 Inline assembler processor mode restrictions in C and C++ code on page 7-272.
7.10 Inline assembler Thumb instruction set restrictions in C and C++ code on page 7-273.
7.11 Inline assembler Vector Floating-Point (VFP) restrictions in C and C++ code on page 7-274.
7.12 Inline assembler instruction restrictions in C and C++ code on page 7-275.
7.13 Miscellaneous inline assembler restrictions in C and C++ code on page 7-276.
7.14 Inline assembler and register access in C and C++ code on page 7-277.
Related references
10.110 __current_pc intrinsic on page 10-718.
10.111 __current_sp intrinsic on page 10-719.
10.137 __return_address intrinsic on page 10-748.
Caution
The compiler does not recognize such changes.
Instead of attempting to change processor modes or coprocessor states from within inline assembly code,
see if there are any intrinsics available that provide what you require. If no such intrinsics are available,
use embedded assembly code if absolutely necessary.
Related concepts
7.7 Restrictions on inline assembly operations in C and C++ code on page 7-270.
7.8 Inline assembler register restrictions in C and C++ code on page 7-271.
7.10 Inline assembler Thumb instruction set restrictions in C and C++ code on page 7-273.
7.11 Inline assembler Vector Floating-Point (VFP) restrictions in C and C++ code on page 7-274.
7.12 Inline assembler instruction restrictions in C and C++ code on page 7-275.
7.13 Miscellaneous inline assembler restrictions in C and C++ code on page 7-276.
4.1 Compiler intrinsics on page 4-105.
7.26 Embedded assembler support in the compiler on page 7-291.
Related information
Processor modes, and privileged and unprivileged software execution.
7.10 Inline assembler Thumb instruction set restrictions in C and C++ code
The inline assembler supports Thumb state in ARM architectures v6T2, v6M, and v7. There are a
number of Thumb-specific restrictions.
These restrictions are as follows:
1. TBB, TBH, CBZ, and CBNZ instructions are not supported.
2. In some cases, the compiler can replace IT blocks with branched code.
3. The instruction width specifier .N denotes a preference, but not a requirement, to the compiler. This is
because, in rare cases, optimizations and register allocation can make it inefficient to generate a 16-
bit encoding.
For ARMv6 and lower architectures, the inline assembler does not assemble any Thumb instructions.
Instead, on finding inline assembly while in Thumb state, the compiler switches to ARM state
automatically. Code that relies on this switch is currently supported, but this practice is deprecated. For
ARMv6T2 and higher, the automatic switch from Thumb to ARM state is made if the code is valid ARM
assembly but not Thumb.
ARM state can be set deliberately. Inline assembly language can be included in a source file that contains
code to be compiled for Thumb in ARMv6 and lower, by enclosing the functions containing inline
assembly code between #pragma arm and #pragma thumb statements. For example:
... // Thumb code
#pragma arm // ARM code. Switch code generation to the ARM instruction set so
// that the inline assembler is available for Thumb in ARMv6 and lower.
int add(int i, int j)
{
int res;
__asm
{
ADD res, i, j // add here
}
return res;
}
#pragma thumb // Thumb code. Switch back to the Thumb instruction set.
// The inline assembler is no longer available for Thumb in ARMv6 and
// lower.
The code must also be compiled using the --apcs /interwork compiler command-line option.
Related concepts
7.7 Restrictions on inline assembly operations in C and C++ code on page 7-270.
7.8 Inline assembler register restrictions in C and C++ code on page 7-271.
7.9 Inline assembler processor mode restrictions in C and C++ code on page 7-272.
7.11 Inline assembler Vector Floating-Point (VFP) restrictions in C and C++ code on page 7-274.
7.12 Inline assembler instruction restrictions in C and C++ code on page 7-275.
7.13 Miscellaneous inline assembler restrictions in C and C++ code on page 7-276.
Related references
8.6 --apcs=qualifier...qualifier on page 8-322.
10.76 Pragmas on page 10-681.
Related information
Instruction width specifiers.
IT.
TBB and TBH.
CBZ and CBNZ.
7.11 Inline assembler Vector Floating-Point (VFP) restrictions in C and C++ code
The inline assembler provides direct support for VFPv2 instructions.
For example:
float foo(float f, float g)
{
float h;
__asm
{
VADD h, f, 0.5*g; // h = f + 0.5*g
}
return h;
}
In inline assembly code you cannot use the VFP instruction VMOV to transfer between an ARM register
and half of a doubleword extension register (NEON scalar). Instead, you can use the instruction VMOV to
transfer between an ARM register and a single-precision VFP register.
If you change the FPSCR register using inline assembly code, it produces runtime effects on the inline
VFP code and on subsequent compiler-generated VFP code.
Note
• Do not use inline assembly code to change VFP vector mode. Inline assembly code must not be used
for this purpose, and VFP vector mode is deprecated.
• ARM strongly discourages the use of inline assembly coprocessor instructions to interact with VFP in
any way.
Related concepts
7.7 Restrictions on inline assembly operations in C and C++ code on page 7-270.
7.8 Inline assembler register restrictions in C and C++ code on page 7-271.
7.9 Inline assembler processor mode restrictions in C and C++ code on page 7-272.
7.10 Inline assembler Thumb instruction set restrictions in C and C++ code on page 7-273.
7.12 Inline assembler instruction restrictions in C and C++ code on page 7-275.
7.13 Miscellaneous inline assembler restrictions in C and C++ code on page 7-276.
5.41 Compiler support for floating-point arithmetic on page 5-200.
Related information
VMOV (between an ARM register and a NEON scalar).
VMOV (between one ARM register and single precision VFP).
• LDR Rn, =expression pseudo-instruction. Use MOV Rn, expression instead. (This can generate a
load from a literal pool.)
• LDRT, LDRBT, STRT, and STRBT instructions.
• MUL, MLA, UMULL, UMLAL, SMULL, and SMLAL flag setting instructions.
• MOV or MVN flag-setting instructions where the second operand is a constant.
• The special LDM instructions used in system or supervisor mode to load the user-mode banked
registers, written with a ^ after the register list, such as:
LDMIA sp!, {r0-r12, lr, pc}^
• ADR and ADRL pseudo-instructions.
Note
You can use MOV Rn, &expression; instead of the ADR and ADRL pseudo-instructions.
• ARM recommends not using the LDREX and STREX instructions. This is because the compiler might
generate loads and stores between LDREX and STREX, potentially clearing the exclusive monitor set by
LDREX. This recommendation also applies to the byte, halfword, and doubleword variants LDREXB,
STREXB, LDREXH, STREXH, LDREXD, and STREXD.
Related concepts
7.7 Restrictions on inline assembly operations in C and C++ code on page 7-270.
7.8 Inline assembler register restrictions in C and C++ code on page 7-271.
7.9 Inline assembler processor mode restrictions in C and C++ code on page 7-272.
7.10 Inline assembler Thumb instruction set restrictions in C and C++ code on page 7-273.
7.11 Inline assembler Vector Floating-Point (VFP) restrictions in C and C++ code on page 7-274.
7.13 Miscellaneous inline assembler restrictions in C and C++ code on page 7-276.
Related references
10.106 __breakpoint intrinsic on page 10-714.
Related concepts
7.7 Restrictions on inline assembly operations in C and C++ code on page 7-270.
7.8 Inline assembler register restrictions in C and C++ code on page 7-271.
7.9 Inline assembler processor mode restrictions in C and C++ code on page 7-272.
7.10 Inline assembler Thumb instruction set restrictions in C and C++ code on page 7-273.
7.11 Inline assembler Vector Floating-Point (VFP) restrictions in C and C++ code on page 7-274.
7.12 Inline assembler instruction restrictions in C and C++ code on page 7-275.
The compiler does not implicitly declare variables for any other registers, so you must explicitly declare
variables for registers other than R0 to R12 and r0 to r12 in your C or C++ code. No variables are
declared for the sp (r13), lr (r14), and pc (r15) registers, and they cannot be read or directly modified
in inline assembly code.
There is no virtual Processor Status Register (PSR). Any references to the PSR are always to the physical
PSR.
Any variables that you use in inline assembly code to refer to registers must be explicitly declared in
your C or C++ code, unless they are implicitly declared by the compiler. However, it is better to
explicitly declare them in your C or C++ code. You do not have to declare them to be of the same data
type as the implicit declarations. For example, although the compiler implicitly declares register R0 to be
of type signed int, you can explicitly declare R0 as an unsigned integer variable if required.
It is also better to use C or C++ variables as instruction operands. The compiler generates a warning the
first time a variable or physical register name is used, regardless of whether it is implicitly or explicitly
declared, and only once for each translation unit. For example, if you use register r3 without declaring it,
a warning is displayed. You can suppress the warning with --diag_suppress.
Related concepts
7.18 Expansion of inline assembler load and store instructions on page 7-282.
7.8 Inline assembler register restrictions in C and C++ code on page 7-271.
Related references
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
7.15 Inline assembler and the # constant expression specifier in C and C++ code
The constant expression specifier # is optional. If it is used, the expression following it must be a
constant.
Related concepts
7.17 Expansion of inline assembler instructions that use constants on page 7-281.
7.18 Expansion of inline assembler load and store instructions on page 7-282.
7.1 Compiler support for inline assembly language on page 7-264.
With the exception of coprocessor instructions, all ARM instructions with a constant operand support
instruction expansion. In addition, the MUL instruction can be expanded into a sequence of adds and shifts
when the third operand is a constant.
The effect of updating the CPSR by an expanded instruction is:
• Arithmetic instructions set the NZCV flags correctly.
• Logical instructions:
— Set the NZ flags correctly.
— Do not change the V flag.
— Corrupt the C flag.
Related concepts
7.16 Inline assembler and instruction expansion in C and C++ code on page 7-280.
Related concepts
7.14 Inline assembler and register access in C and C++ code on page 7-277.
7.16 Inline assembler and instruction expansion in C and C++ code on page 7-280.
Related references
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
7.19 Inline assembler effect on processor condition flags in C and C++ code
An inline assembly language instruction might explicitly or implicitly attempt to update the processor
condition flags.
Inline assembly language instructions that involve only virtual register operands or simple expression
operands have predictable behavior. The condition flags are set by the instruction if either an implicit or
an explicit update is specified. The condition flags are unchanged if no update is specified.
If any of the instruction operands are not simple operands, then the condition flags might be corrupted
unless the instruction updates them.
In general, the compiler cannot easily diagnose potential corruption of the condition flags. However, for
operands that require the construction and subsequent destruction of C++ temporaries the compiler gives
a warning if the instruction attempts to update the condition flags. This is because the destruction might
corrupt the condition flags.
Related concepts
7.20 Inline assembler expression operands in C and C++ code on page 7-284.
7.21 Inline assembler register list operands in C and C++ code on page 7-285.
Related concepts
7.21 Inline assembler register list operands in C and C++ code on page 7-285.
7.22 Inline assembler intermediate operands in C and C++ code on page 7-286.
Related information
ARM Architecture Reference Manual.
Related concepts
7.20 Inline assembler expression operands in C and C++ code on page 7-284.
7.22 Inline assembler intermediate operands in C and C++ code on page 7-286.
Related concepts
7.20 Inline assembler expression operands in C and C++ code on page 7-284.
7.21 Inline assembler register list operands in C and C++ code on page 7-285.
7.23 Inline assembler function calls and branches in C and C++ code
The BL and SVC instructions of the inline assembler enable you to specify three optional lists following
the normal instruction fields.
These instructions have the following format:
SVC{cond} svc_num, {input_param_list}, {output_value_list}, {corrupt_reg_list}
BL{cond} function, {input_param_list}, {output_value_list}, {corrupt_reg_list}
Note
RVCT v3.0 renamed the SWI instruction to SVC. The inline assembler still accepts SWI in place of SVC.
If you are compiling for architecture 5TE or later, the linker converts BL function instructions to BLX
function instructions if appropriate. However, you cannot use BLX function instructions directly
within inline assembly code.
• input_param_list specifies the expressions or variables that are the input parameters to the function
call or SVC instruction, and the physical registers that contain the expressions or variables. They are
specified as assignments to physical registers or as physical register names. A single list can contain
both types of input register specification.
The inline assembler ensures that the correct values are present in the specified physical registers
before the BL or SVC instruction is entered. A physical register name that is specified without
assignment ensures that the value in the virtual register of the same name is present in the physical
register. This ensures backwards compatibility with existing inline assembly language code.
For example, the instruction:
BL foo, { r0=expression1, r1=expression2, r2 }
By default, if you do not specify any input_param_list input parameters, registers r0 to r3 are used
as input parameters.
Note
It is not possible to specify the lr, sp, or pc registers in the input parameter list.
• output_value_list specifies the physical registers that contain the output values from the BL or SVC
instruction and where they must be stored. The output values are specified as assignments from
physical registers to modifiable lvalue expressions or as single physical register names.
The inline assembler takes the values from the specified physical registers and assigns them into the
specified expressions. A physical register name specified without assignment causes the virtual
register of the same name to be updated with the value from the physical register.
For example, the instruction:
BL foo, { }, { result1=r0, r1 }
By default, if you do not specify any output_value_list output values, register r0 is used for the
output value.
Note
It is not possible to specify the lr, sp, or pc registers in the output value list.
• corrupt_reg_list specifies the physical registers that are corrupted by the called function. If the
condition flags are modified by the called function, you must specify the PSR in the corrupted register
list.
The BL and SVC instructions always corrupt lr.
If corrupt_reg_list is omitted then for BL and SVC, the registers r0-r3, lr and the PSR are
corrupted.
Only the branch instruction, B, can jump to labels within a single C or C++ function.
By default, if you do not specify any corrupt_reg_list registers, r0 to r3, r14, and the PSR can be
corrupted.
Note
It is not possible to specify the lr, sp, or pc registers in the corrupt register list.
Note
• The BX, BLX, and BXJ instructions are not supported in the inline assembler.
• It is not possible to specify the lr, sp, or pc registers in any of the input, output, or corrupted register
lists.
• The sp register must not be changed by any SVC instruction or function call.
For example:
int foo(int x, int y)
{
__asm
{
SUBS x,x,y
BEQ end
}
return 1;
end:
return 0;
}
Related concepts
7.14 Inline assembler and register access in C and C++ code on page 7-277.
Related concepts
7.27 Embedded assembler syntax in C and C++ on page 7-292.
7.28 Effect of compiler ARM and Thumb states on embedded assembler on page 7-293.
7.29 Restrictions on embedded assembly language functions in C and C++ code on page 7-294.
7.30 Compiler generation of embedded assembly language functions on page 7-295.
7.31 Access to C and C++ compile-time constant expressions from embedded assembler on page 7-297.
7.32 Differences between expressions in embedded assembler and C or C++ on page 7-298.
7.33 Manual overload resolution in embedded assembler on page 7-299.
7.34 __offsetof_base keyword for related base classes in embedded assembler on page 7-300.
7.35 Compiler-supported keywords for calling class member functions in embedded assembler
on page 7-301.
7.41 Calling nonstatic member functions in embedded assembler on page 7-307.
7.42 Calling a nonvirtual member function on page 7-308.
7.43 Calling a virtual member function on page 7-309.
Related information
armasm User Guide.
Mixing C, C++, and Assembly Language.
Note
Argument names are permitted in the parameter list, but they cannot be used in the body of the embedded
assembly function. For example, the following function uses integer i in the body of the function, but
this is not valid in assembly:
__asm int f(int i)
{
ADD i, i, #1 // error
}
The following example shows a string copy routine as a not very optimal embedded assembler routine.
#include <stdio.h>
__asm void my_strcpy(const char *src, char *dst)
{
loop
LDRB r2, [r0], #1
STRB r2, [r1], #1
CMP r2, #0
BNE loop
BX lr
}
int main(void)
{
const char *a = "Hello world!";
char b[20];
my_strcpy (a, b);
printf("Original string: '%s'\n", a);
printf("Copied string: '%s'\n", b);
return 0;
}
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
• __asm functions do not change the ARM Architecture Procedure Call Standard (AAPCS) rules that
apply. This means that all calls between an __asm function and a normal C or C++ function must
adhere to the AAPCS, even though there are no restrictions on the assembly code that an __asm
function can use (for example, change state).
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.34 __offsetof_base keyword for related base classes in embedded assembler on page 7-300.
7.35 Compiler-supported keywords for calling class member functions in embedded assembler
on page 7-301.
7.30 Compiler generation of embedded assembly language functions on page 7-295.
7.31 Access to C and C++ compile-time constant expressions from embedded assembler on page 7-297.
7.35 Compiler-supported keywords for calling class member functions in embedded assembler
on page 7-301.
Note
This means that it is possible for control to pass from one __asm function to another by falling off the end
of the first function into the next __asm function in the file, if the return instruction is omitted.
When you invoke armcc, the object file produced by the assembler is combined with the object file of the
compiler by a partial link that produces a single object file.
The compiler generates an AREA directive for each __asm function, as in the following example:
#include <cstddef>
struct X
{
int x,y;
void addto_y(int);
};
__asm void X::addto_y(int)
{
LDR r2, [r0, #__cpp(offsetof(X, y))]
ADD r1, r2, r1
STR r1, [r0, #__cpp(offsetof(X, y))]
BX lr
}
The use of offsetof must be inside __cpp() because it is the normal offsetof macro from the cstddef
header file.
Ordinary __asm functions are put in an ELF section with the name .emb_text. That is, embedded
assembly functions are never inlined. However, implicitly instantiated template functions and out-of-line
copies of inline functions are placed in an area with a name that is derived from the name of the function,
and an extra attribute that marks them as common. This ensures that the special semantics of these kinds
of functions are maintained.
Note
Because of the special naming of the area for out-of-line copies of inline functions and template
functions, these functions are not in the order of definition, but in an arbitrary order. Therefore, do not
assume that code execution falls out of an inline or template function and into another __asm function.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.29 Restrictions on embedded assembly language functions in C and C++ code on page 7-294.
Related information
ELF for the ARM Architecture.
Names in the __cpp expression are looked up in the C++ context of the __asm function. Any names in
the result of a __cpp expression are mangled as required and automatically have IMPORT statements
generated for them.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.29 Restrictions on embedded assembly language functions in C and C++ code on page 7-294.
7.33 Manual overload resolution in embedded assembler on page 7-299.
7.32 Differences between expressions in embedded assembler and C or C++ on page 7-298.
Note
The embedded assembly rules apply outside __cpp, and the C or C++ rules apply inside __cpp.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.31 Access to C and C++ compile-time constant expressions from embedded assembler on page 7-297.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.31 Access to C and C++ compile-time constant expressions from embedded assembler on page 7-297.
Returns the offset from the beginning of a D object to the start of the B base subobject within it. The
result might be zero. The following example shows the offset (in bytes) that must be added to a D* p to
implement the equivalent of static_cast<B*>(p).
__asm B* my_static_base_cast(D* /*p*/) // equivalent to:
// return static_cast<B*>(p)
{
if __offsetof_base(D, B) <> 0 // optimize zero offset case
ADD r0, r0, #__offsetof_base(D, B)
endif
BX lr
}
The __offsetof_base, __mcall_*, and _vcall_offsetof_vfunc keywords are converted into integer
or logical constants in the assembly source code. You can only use it in __asm functions, not in __cpp
expressions.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.29 Restrictions on embedded assembly language functions in C and C++ code on page 7-294.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.36 __mcall_is_virtual(D, f) on page 7-302.
7.37 __mcall_is_in_vbase(D, f) on page 7-303.
7.38 __mcall_offsetof_vbase(D, f) on page 7-304.
7.39 __mcall_this_offset(D, f) on page 7-305.
7.40 __vcall_offsetof_vfunc(D, f) on page 7-306.
7.41 Calling nonstatic member functions in embedded assembler on page 7-307.
7.29 Restrictions on embedded assembly language functions in C and C++ code on page 7-294.
7.36 __mcall_is_virtual(D, f)
Results in {TRUE} if f is a virtual member function found in D, or a base class of D, otherwise {FALSE}.
If it returns {TRUE} the call can be done using virtual dispatch, otherwise the call must be done directly.
Related concepts
7.35 Compiler-supported keywords for calling class member functions in embedded assembler
on page 7-301.
7.42 Calling a nonvirtual member function on page 7-308.
7.43 Calling a virtual member function on page 7-309.
7.37 __mcall_is_in_vbase(D, f)
Results in {TRUE} if f is a nonstatic member function found in a virtual base class of D, otherwise
{FALSE}.
If it returns {TRUE} the this adjustment must be done using __mcall_offsetof_vbase(D, f),
otherwise it must be done with __mcall_this_offset(D, f).
Related concepts
7.35 Compiler-supported keywords for calling class member functions in embedded assembler
on page 7-301.
7.42 Calling a nonvirtual member function on page 7-308.
7.43 Calling a virtual member function on page 7-309.
7.38 __mcall_offsetof_vbase(D, f)
Returns the negative offset from the value of the vtable pointer of the vtable slot that holds the base
offset (from the beginning of a D object to the start of the base that f is defined in).
Where D is a class type and f is a nonstatic member function defined in a virtual base class of D, in other
words __mcall_is_in_vbase(D,f) returns {TRUE}.
The base offset is the this adjustment necessary when making a call to f with a pointer to a D.
Note
The offset returns a positive number that then has to be subtracted from the value of the vtable pointer.
Related concepts
7.35 Compiler-supported keywords for calling class member functions in embedded assembler
on page 7-301.
7.42 Calling a nonvirtual member function on page 7-308.
7.43 Calling a virtual member function on page 7-309.
7.39 __mcall_this_offset(D, f)
Returns the offset from the beginning of a D object to the start of the base in which f is defined.
This is the this adjustment necessary when making a call to f with a pointer to a D. It is either zero if f
is found in D or the same as __offsetof_base(D,B), where B is a nonvirtual base class of D that contains
f.
Where D is a class type and f is a nonstatic member function defined in D or a nonvirtual base class of D.
If __mcall_this_offset(D,f) is used when f is found in a virtual base class of D it returns an arbitrary
value designed to cause an assembly error if used. This is so that such invalid uses of
__mcall_this_offset can occur in sections of assembly code that are to be skipped.
Related concepts
7.35 Compiler-supported keywords for calling class member functions in embedded assembler
on page 7-301.
7.42 Calling a nonvirtual member function on page 7-308.
7.43 Calling a virtual member function on page 7-309.
7.40 __vcall_offsetof_vfunc(D, f)
Returns the offset of the slot in the vtable that holds the pointer to the virtual function, f.
Where D is a class and f is a virtual function defined in D, or a base class of D.
If __vcall_offsetof_vfunc(D, f) is used when f is not a virtual member function it returns an
arbitrary value designed to cause an assembly error if used.
Related concepts
7.35 Compiler-supported keywords for calling class member functions in embedded assembler
on page 7-301.
7.42 Calling a nonvirtual member function on page 7-308.
7.43 Calling a virtual member function on page 7-309.
There is no __mcall_is_static to detect static member functions because static member functions have
different parameters (that is, no this), so call sites are likely to already be specific to calling a static
member function.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.35 Compiler-supported keywords for calling class member functions in embedded assembler
on page 7-301.
7.42 Calling a nonvirtual member function on page 7-308.
7.43 Calling a virtual member function on page 7-309.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.41 Calling nonstatic member functions in embedded assembler on page 7-307.
7.43 Calling a virtual member function on page 7-309.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.41 Calling nonstatic member functions in embedded assembler on page 7-307.
7.42 Calling a nonvirtual member function on page 7-308.
The second method uses embedded assembly to access physical ARM registers from within a C or C++
source file, for example:
__asm void func()
{
MOV r0, lr
...
BX lr
}
This enables the return address of a function to be captured and displayed, for example, for debugging
purposes, to show the call tree.
Note
The compiler might also inline a function into its caller function. If a function is inlined, then the return
address is the return address of the function that calls the inlined function. Also, a function might be tail
called.
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
Related references
10.137 __return_address intrinsic on page 10-748.
10.110 __current_pc intrinsic on page 10-718.
10.111 __current_sp intrinsic on page 10-719.
7.45 Differences in compiler support for inline and embedded assembly code
There are differences between the ways inline and embedded assembly are compiled.
Specifically:
• Inline assembly code uses a high level of processor abstraction, and is integrated with the C and C++
code during code generation. Therefore, the compiler optimizes the C and C++ code and the
assembly code together.
• Unlike inline assembly code, embedded assembly code is assembled separately from the C and C++
code to produce a compiled object that is then combined with the object from the compilation of the
C or C++ source.
• Inline assembly code can be inlined by the compiler, but embedded assembly code cannot be inlined,
either implicitly or explicitly.
The following table summarizes the main differences between inline assembler and embedded assembler.
ARMv6 instructions All supported. Supports most instructions, with some exceptions, for
example SETEND and some of the system extensions. The
complete set of ARMv6 SIMD instructions is supported.
Register access Specified physical registers are used. Uses virtual registers. Using sp (r13), lr (r14), and pc
You can also use PC, LR and SP. (r15) gives an error.
Return instructions You must add them in your code. Generated automatically. (The BX, BXJ, and BLX instructions
are not supported.)
8.1 -Aopt
Specifies command-line options to pass to the assembler when it is invoked by the compiler to assemble
either .s input files or embedded assembly language functions.
Syntax
-Aopt
Where:
opt
is a command-line option to pass to the assembler.
Note
Some compiler command-line options are passed to the assembler automatically whenever it is
invoked by the compiler. For example, if the option --cpu is specified on the compiler
command line, then this option is passed to the assembler whenever it is invoked to assemble .s
files or embedded assembly code.
To see the compiler command-line options passed by the compiler to the assembler, use the
compiler command-line option -A--show_cmdline.
Restrictions
If an unsupported option is passed through using -A, an error is generated by the assembler.
Example
armcc -A--predefine="NEWVERSION SETL {TRUE}" main.c
Related references
8.114 -Lopt on page 8-445.
8.171 --show_cmdline on page 8-508.
8.7 --arm on page 8-326.
8.28 --compatible=name on page 8-351.
8.42 --cpu=list on page 8-367.
8.43 --cpu=name on page 8-368.
Usage
--allow_fpreg_for_nonfpdata enables the compiler to use VFP and NEON registers and instructions
for data transfer operations on non-VFP and non-NEON data. This is useful when demand for integer
registers is high. For the compiler to use the VFP or NEON registers, the default options for the
processor or the specified options must enable the hardware.
--no_allow_fpreg_for_nonfpdata prevents VFP and NEON registers from being used for non-VFP
and non-NEON data. When this option is specified, the compiler uses VFP and NEON registers for VFP
and NEON data only. This is useful when you want to confine the number of places in your code where
the compiler generates VFP or NEON instructions.
Default
The default is --no_allow_fpreg_for_nonfpdata.
Related references
8.87 --fpmode=model on page 8-415.
8.88 --fpu=list on page 8-417.
8.89 --fpu=name on page 8-418.
Related information
Extension register bank mapping.
NEON views of the register bank.
VFP views of the extension register bank.
Usage
Allowing null this pointers gives well-defined behavior when a nonvirtual member function is called on
a null object pointer.
Disallowing null this pointers enables the compiler to perform optimizations, and conforms with the
C++ standard.
Default
The default is --no_allow_null_this.
Related references
8.94 --gnu_defaults on page 8-425.
Usage
In C and C++, use this option to control recognition of the digraphs. In C++, use this option to control
recognition of operator keywords, for example, and and bitand.
Default
The default is --alternative_tokens.
Mode
This option is effective only if the source language is C++.
Default
The default is --no_anachronisms.
Example
typedef enum { red, white, blue } tricolor;
inline tricolor operator++(tricolor c, int)
{
int i = static_cast<int>(c) + 1;
return static_cast<tricolor>(i);
}
void foo(void)
{
tricolor c = red;
c++; // okay
++c; // anachronism
}
Compiling this code with the option --anachronisms generates a warning message.
Compiling this code without the option --anachronisms generates an error message.
Related references
8.39 --cpp on page 8-363.
8.176 --strict, --no_strict on page 8-513.
8.177 --strict_warnings on page 8-514.
11.8 Anachronisms in ARM C++ on page 11-808.
8.6 --apcs=qualifier...qualifier
Controls interworking and position independence when generating code.
By specifying qualifiers to the --apcs command-line option, you can define the variant of the Procedure
Call Standard for the ARM architecture (AAPCS) used by the compiler.
Syntax
--apcs=qualifier...qualifier
/rwpi
/norwpi
Enables or disables the generation of Read/Write Position-Independent (RWPI) code. The
default is /norwpi.
/[no]pid is an alias for /[no]rwpi.
/fpic
/nofpic
Enables or disables the generation of read-only position-independent code where relative
address references are independent of the location where your program is loaded.
/hardfp
/softfp
Requests hardware or software floating-point linkage. This enables the procedure call standard
to be specified separately from the version of the floating-point hardware available through the
--fpu option. It is still possible to specify the procedure call standard by using the --fpu option,
but ARM recommends that you use --apcs instead.
Note
The / prefix is optional for the first qualifier, but must be present to separate subsequent qualifiers in the
same --apcs option. For example, --apcs=/nointerwork/noropi/norwpi is equivalent to
--apcs=nointerwork/noropi/norwpi.
You can specify multiple qualifiers using either a single --apcs option or multiple --apcs options. For
example, --apcs=/nointerwork/noropi/norwpi is equivalent to --apcs=/nointerwork
--apcs=noropi/norwpi.
Default
If you do not specify an --apcs option, the compiler assumes
--apcs=/nointerwork/noropi/norwpi/nofpic.
Usage
/interwork
/nointerwork
By default, code is generated:
• Without interworking support, that is /nointerwork, unless you specify a --cpu option that
corresponds to architecture ARMv5T or later.
• With interworking support, that is /interwork, on ARMv5T and later. ARMv5T and later
architectures provide direct support to interworking by using instructions such as BLX and
load to program counter instructions.
/ropi
/noropi
If you select the /ropi qualifier to generate ROPI code, the compiler:
• Addresses read-only code and data PC-relative.
• Sets the Position Independent (PI) attribute on read-only output sections.
Note
--apcs=/ropi is not supported when compiling C++.
/rwpi
/norwpi
If you select the /rwpi qualifier to generate RWPI code, the compiler:
• addresses writable data using offsets from the static base register sb. This means that:
— The base address of the RW data region can be fixed at runtime.
— Data can have multiple instances.
— Data can be, but does not have to be, position-independent.
• Sets the PI attribute on read/write output sections.
Note
Because the --lower_rwpi option is the default, code that is not RWPI is automatically
transformed into equivalent code that is RWPI. This static initialization is done at runtime by the
C++ constructor mechanism, even for C.
/fpic
/nofpic
If you select this option, the compiler:
• Accesses all static data using PC-relative addressing.
• Accesses all imported or exported read-write data using a Global Offset Table (GOT) entry
created by the linker.
• Accesses all read-only data relative to the PC.
You must compile your code with /fpic if it uses shared objects. This is because relative
addressing is only implemented when your code makes use of System V shared libraries.
You do not have to compile with /fpic if you are building either a static image or static library.
The use of /fpic is supported when compiling C++. In this case, virtual function tables and
typeinfo are placed in read-write areas so that they can be accessed relative to the location of
the PC.
Note
When building a System V or ARM Linux shared library, use --apcs /fpic together with
--no_hide_all.
/hardfp
If you use /hardfp, the compiler generates code for hardware floating-point linkage. Hardware
floating-point linkage uses the FPU registers to pass the arguments and return values.
/hardfp interacts with or overrides explicit or implicit use of --fpu as follows:
Restrictions
There are restrictions when you compile code with /ropi, or /rwpi, or /fpic.
/ropi
The main restrictions when compiling with /ropi are:
• The use of --apcs=/ropi is not supported when compiling C++. You can compile only the
C subset of C++ with /ropi.
• Some constructs that are legal C do not work when compiled for --apcs=/ropi. For
example:
extern const int ci; // ro
const int *p2 = &ci; // this static initialization
// does not work with --apcs=/ropi
To enable such static initializations to work, compile your code using the --lower_ropi
option. For example:
armcc --apcs=/ropi --lower_ropi
/rwpi
The main restrictions when compiling with /rwpi are:
• Some constructs that are legal C do not work when compiled for --apcs=/rwpi. For
example:
int i; // rw
int *p1 = &i; // this static initialization
// does not work with --apcs=/rwpi
// --no_lower_rwpi
To enable such static initializations to work, compile your code using the --lower_rwpi
option. For example:
armcc --apcs=/rwpi
Note
You do not have to specify --lower_rwpi, because this is the default.
/fpic
The main restrictions when compiling with /fpic are:
• By default, if you use --apcs=/fpic, the compiler exports only functions and data marked
__declspec(dllexport).
• If you use --apcs=/fpic and --no_hide_all on the same command line, the compiler uses
default ELF dynamic visibility for all extern variables and functions that do not use
__declspec(dll*). The compiler disables auto-inlining for functions with default ELF
visibility.
Related concepts
5.51 Compiler options for floating-point linkage and computations on page 5-214.
5.42 Default selection of hardware or software floating-point support on page 5-202.
Related references
8.89 --fpu=name on page 8-418.
8.99 --hide_all, --no_hide_all on page 8-430.
8.126 --lower_ropi, --no_lower_ropi on page 8-459.
8.127 --lower_rwpi, --no_lower_rwpi on page 8-460.
10.23 __declspec(dllexport) on page 10-625.
Related information
Procedure Call Standard for the ARM Architecture.
ARM C libraries and multithreading.
BPABI and SysV Shared Libraries and Executables.
Overview of veneers.
8.7 --arm
Targets the ARM instruction set. The compiler is permitted to generate both ARM and Thumb code, but
recognizes that ARM code is preferred.
Note
This option is not relevant for Thumb-only processors such as Cortex-M4, Cortex-M3, Cortex-M1, and
Cortex-M0.
Default
This is the default option for targets supporting the ARM instruction set.
Related references
8.12 --arm_only on page 8-334.
8.180 --thumb on page 8-518.
10.78 #pragma arm on page 10-683.
8.1 -Aopt on page 8-317.
8.28 --compatible=name on page 8-351.
8.42 --cpu=list on page 8-367.
8.43 --cpu=name on page 8-368.
Related information
ARM architectures supported by the toolchain.
8.8 --arm_linux
Configures a set of other options with defaults that are suitable for ARM Linux compilation.
Usage
These defaults are enabled automatically when you use one of the following ARM Linux options:
• --arm_linux_paths.
• --translate_gcc in full GCC emulation mode.
• --translate_g++ in full GCC emulation mode.
• --translate_gld in full GCC emulation mode.
Typical use of this option is to aid the migration of legacy code. It enables you to simplify the compiler
options used in existing makefiles, while retaining full and explicit control over the header and library
search paths used.
When migrating from a build earlier than RVCT v4.0, you can replace all of these options supplied to the
compiler with a single --arm_linux option.
Default
By default, the configured set of options is:
• --apcs=/interwork.
• --enum_is_int.
• --gnu.
• --library_interface=aeabi_glibc.
• --no_execstack.
• --no_hide_all.
• --preinclude=linux_armcc.h.
• --wchar32.
Example
To apply the default set of options, use --arm_linux.
To override any of the default options, specify them separately. For example, --arm_linux --hide_all.
In this instance, --hide_all overrides the --no_hide_all encompassed by --arm_linux.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.9 --arm_linux_config_file=path
Specifies the location of the configuration file that is created for ARM Linux builds. It enables the use of
standard Linux configuration settings when compiling your code.
Syntax
--arm_linux_config_file=path
Restrictions
You must use this option both when generating the configuration file and when using the configuration
during compilation and linkage.
If you specify an ARM Linux configuration file on the command line and you use --translate_gcc,
--translate_g++, or --translate_gld, you affect the default settings for certain other options. The
default value for --bss_threshold becomes zero, the default for --signed_bitfields and
--unsigned_bitfields becomes --signed_bitfields, and --enum_is_int and --wchar32 are
switched on.
Related references
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
8.73 --enum_is_int on page 8-401.
8.20 --bss_threshold=num on page 8-343.
8.172 --signed_bitfields, --unsigned_bitfields on page 8-509.
8.201 -Warmcc,--gcc_fallback on page 8-543.
8.202 --wchar, --no_wchar on page 8-544.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.10 --arm_linux_configure
Configures the tools for use with ARM Linux by creating a configuration file describing include paths,
library paths, and standard libraries for the GNU C library, glibc.
The created configuration file is used when you build your code.
Usage
Automatic and manual methods of configuration apply. Automatic configuration attempts to
automatically locate an installation of the GNU toolchain on your PATH environment variable, and query
it to determine the configuration settings to use. Manual configuration lets you specify your own
locations for header files and libraries. It can be used if you do not have a complete GNU toolchain
installed.
If you use automatic configuration, the GNU Compiler Collection (GCC) version number of the GNU
toolchain is added to the configuration file. The corresponding --gnu_version=version option is
passed to the compiler from the configuration file when using any of the translation options or
--arm_linux_paths.
where config_file_path is the path and filename of the configuration file that is created. You can
optionally specify the location of the GCC driver, and optionally the location of the GNU linker, to
override the locations determined from the system PATH environment variable.
To perform manual configuration:
• armcc --arm_linux_configure --arm_linux_config_file=path --
configure_cpp_headers=path --configure_sysroot=path
where the paths to the GNU libstdc++ Standard Template Library (STL) header files, and the
system root path that libraries and header files are found from, are specified.
Restrictions
A GNU toolchain must exist on your system to use automatic configuration.
If using the automatic method of configuration, an ARM Linux GCC must be located with the system
PATH environment variable. If you do not have a suitable GCC on your system path, you can either add
one to your path, or use --configure_gcc (and optionally --configure_gld) to manually specify the
location of a suitable GCC.
Default
Automatic configuration applies unless you specify the location of GCC or the GNU linker using
additional options. That is, the compiler attempts to locate an ARM Linux GCC using your system path
environment variable, unless you use additional options to specify otherwise.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.11 --arm_linux_paths
Enables you to build code for ARM Linux.
Usage
You can use this option after you have configured the tools for use with ARM Linux.
This is a compiler option only. It follows the typical GCC usage model, where the compiler driver directs
linkage and selection of standard system object files and libraries.
This option can also aid migration from versions of RVCT earlier than RVCT v4.0. After you have
created a configuration file using --arm_linux_configure, you can modify an existing build by
replacing the list of standard options and search paths with the --arm_linux_paths option. That is,
--arm_linux_paths can replace:
• all of the default options listed for --arm_linux
• Header paths.
• Library paths.
• Standard libraries.
Restrictions
You must specify the location of the configuration file by using --arm_linux_config_file=filename.
Examples
Compile and link application code:
armcc --arm_linux_paths --arm_linux_config_file=my_config_file -o hello -O2 -Otime -g
hello.c
Link two object files, obj1 and obj2, into a shared library called my_shared_lib.so, using the
compiler:
armcc --arm_linux_paths --arm_linux_config_file=my_config_file --shared -o
my_shared_lib.so obj1.o obj2.o
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.12 --arm_only
Enforces ARM-only code. The compiler behaves as if Thumb is absent from the target architecture.
The compiler propagates the --arm_only option to the assembler and the linker.
Default
For targets that support the ARM instruction set, the default is --arm. For targets that do not support the
ARM instruction set, the default is --thumb.
Example
armcc --arm_only myprog.c
Note
If you specify armcc --arm_only --thumb myprog.c, this does not mean that the compiler checks your
code to ensure that no Thumb code is present. It means that --thumb overrides --arm_only, because of
command-line ordering.
Related references
8.7 --arm on page 8-326.
8.180 --thumb on page 8-518.
Related information
--16 assembler option.
--32 assembler option.
Order of options on the command line.
8.13 --asm
Instructs the compiler to write a listing to a file of the disassembly of the machine code generated by the
compiler.
Object code is generated when this option is selected. The link step is also performed, unless the -c
option is chosen.
Note
To produce a disassembly of the machine code generated by the compiler, without generating object
code, select -S instead of --asm.
Usage
The action of --asm, and the full name of the disassembly file produced, depends on the combination of
options used:
--asm -c As for --asm, except that the link step is not performed.
--asm --interleave As for --asm, except that the source code is interleaved with the disassembly.
The disassembly is written to a text file whose name defaults to the name of the input file with the filename
extension .txt.
--asm --multifile As for --asm, except that the compiler produces empty object files for the files merged into the main file.
--asm -o filename As for --asm, except that the object file is named filename.
The disassembly is written to the file filename.s.
The name of the object file must not have the filename extension .s. If the filename extension of the object
file is .s, the disassembly is written over the top of the object file.
Related references
8.21 -c on page 8-344.
8.111 --interleave on page 8-442.
8.134 --multifile, --no_multifile on page 8-467.
8.138 -o filename on page 8-471.
8.168 -S on page 8-504.
2.7 Filename suffixes recognized by the compiler on page 2-49.
8.14 --asm_dir=directory_name
Specifies a directory for disassembly output files created by the --asm and -S options.
Default
If the --asm_dir option is not used, disassembly output is placed in the directory specified by
--output_dir, or if --output_dir is not specified, in the default location (for example, the current
directory).
Note
The --asm_dir option has no effect unless you also specify either the --asm or the -S options.
Example
armcc -c --output_dir=obj --asm f1.c f2.c --asm_dir=asm
Result:
asm/f1.s
asm/f2.s
obj/f1.o
obj/f2.o
Related references
8.13 --asm on page 8-335.
8.53 --depend_dir=directory_name on page 8-380.
8.119 --list_dir=directory_name on page 8-452.
8.145 --output_dir=directory_name on page 8-481.
Usage
Use these options to control the automatic inlining of functions at the highest optimization levels (-O2
and -O3).
Default
For optimization levels -O0 and -O1, the default is --no_autoinline.
For optimization levels -O2 and -O3, the default is --autoinline.
Related concepts
4.35 Default compiler options that are affected by optimization level on page 4-148.
Related references
8.85 --forceinline on page 8-413.
8.108 --inline, --no_inline on page 8-439.
8.139 -Onum on page 8-473.
8.143 -Ospace on page 8-479.
8.144 -Otime on page 8-480.
8.16 --bigend
Generates code suitable for an ARM processor using big-endian memory.
The ARM architecture defines the following big-endian modes:
BE8
Byte Invariant Addressing mode (ARMv6 and later).
BE32
Legacy big-endian mode.
The selection of BE8 versus BE32 is specified at link time.
Default
The compiler assumes --littleend unless --bigend is explicitly specified.
Related references
8.121 --littleend on page 8-454.
Related information
--be8 linker option.
--be32 linker option.
8.17 --bitband
Bit-bands all non const global structure objects. It enables a word of memory to be mapped to a single bit
in the bit-band region. This enables efficient atomic access to single-bit values in SRAM and Peripheral
regions of the memory architecture.
For peripherals that are width sensitive, byte, halfword, and word stores or loads to the alias space are
generated for char, short, and int types of bitfields of bit-banded structs respectively.
Restrictions
The following restrictions apply:
• This option only affects struct types. Any union type or other aggregate type with a union as a
member cannot be bit-banded.
• Members of structs cannot be bit-banded individually.
• Bit-banded accesses are generated only for single-bit bitfields.
• Bit-banded accesses are not generated for const objects, pointers, and local objects.
• Bit-banding is only available on some processors. For example, the Cortex-M4 and Cortex-M3
processors.
Example
In this example, the writes to bitfields i and k are bit-banded when compiled using the --bitband
command-line option.
typedef struct {
int i : 1;
int j : 2;
int k : 1;
} BB;
BB value;
void update_value(void)
{
value.i = 1;
value.k = 1;
}
Related concepts
4.16 Compiler and processor support for bit-banding on page 4-126.
$t
.text
f
0x00000000: b510 .. PUSH {r4,lr}
0x00000002: 2807 .( CMP r0,#7
0x00000004: d21b .. BCS {pc}+0x3a ; 0x3e
0x00000006: e8dff000 .... TBB [pc,r0]
$d
0x0000000a: 0704 .. DCW 1796 ***
0x0000000c: 13100d0a .... DCDU 319819018 ***
0x00000010: 0016 .. DCW 22 ***
$t
0x00000012: 2005 . MOVS r0,#5
0x00000014: f7fffffe .... BL g
The --no_branch_tables option instructs the compiler to insert the branch offset table into a separate
data section instead:
** Section #1 '.text' (SHT_PROGBITS) [SHF_ALLOC + SHF_EXECINSTR]
Size : 72 bytes (alignment 4)
Address: 0x00000000
$t
.text
f
0x00000000: b510 .. PUSH {r4,lr}
0x00000002: 2807 .( CMP r0,#7
0x00000004: d218 .. BCS {pc}+0x34 ; 0x38
0x00000006: 4b0f .K LDR r3,[pc,#60] ; [0x44] = 0
0x00000008: e8d3f000 .... TBB [r3,r0]
0x0000000c: 2005 . MOVS r0,#5
0x0000000e: f7fffffe .... BL g
...
0x000000: 00 03 06 09 0c 0f 12 .......
Default
The default is --branch_tables.
--execute_only implies --no_branch_tables, unless --branch_tables is explicitly specified.
Note
Do not use --execute_only in conjunction with --branch_tables. If you do, then the compiler places
the branch offset table in an unreadable, execute-only code region.
Related concepts
4.21 Compiler support for literal pools on page 4-131.
Related references
8.109 --integer_literal_pools, --no_integer_literal_pools on page 8-440.
Default
The default is --no_brief_diagnostics.
Example
/* main.c */
#include <stdio.h>
int main(void)
{
printf(""Hello, world\n"); // Intentional quotation mark error
return 0;
}
Related references
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
8.20 --bss_threshold=num
Controls the placement of small global ZI data items in sections. A small global ZI data item is an
uninitialized data item that is eight bytes or less in size.
Syntax
--bss_threshold=num
Where:
num
is either:
0
place small global ZI data items in ZI data sections
8
place small global ZI data items in RW data sections.
Usage
In RVCT 2.1 and later, the compiler might place small global ZI data items in RW data sections as an
optimization. In RVCT 2.0.1 and earlier, small global ZI data items were placed in ZI data sections by
default.
Use --bss_threshold=0 to emulate the behavior of RVCT 2.0.1 and earlier with respect to the
placement of small global ZI data items in ZI data sections.
Note
Selecting the option --bss_threshold=0 instructs the compiler to place all small global ZI data items in
the current compilation module in a ZI data section. To place specific variables in:
• A ZI data section, use __attribute__((zero_init)).
• A specific ZI data section, use a combination of __attribute__((section("name"))) and
__attribute__((zero_init)).
Default
If you do not specify a --bss_threshold option, the compiler assumes --bss_threshold=8.
If you specify an ARM Linux configuration file on the command line and you use --translate_gcc or
--translate_g++, the compiler assumes --bss_threshold=0.
Example
int glob1; /* ZI (.bss) in RVCT 2.0.1 and earlier */
/* RW (.data) in RVCT 2.1 and later */
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
10.79 #pragma arm section [section_type_list] on page 10-684.
10.69 __attribute__((section("name"))) variable attribute on page 10-674.
10.75 __attribute__((zero_init)) variable attribute on page 10-680.
8.21 -c
Instructs the compiler to perform the compilation step, but not the link step.
Note
This option is different from the uppercase -C option.
Usage
ARM recommends using the -c option in projects with more than one source file.
Related references
8.13 --asm on page 8-335.
8.118 --list on page 8-450.
8.138 -o filename on page 8-471.
8.168 -S on page 8-504.
8.22 -C
Instructs the compiler to retain comments in preprocessor output.
Choosing this option implicitly selects the option -E.
Note
This option is different from the lowercase -c option.
Related references
8.70 -E on page 8-398.
8.23 --c90
Enables the compilation of C90 source code.
It enforces C only, and C++ syntax is not accepted.
Usage
This option can also be combined with other source language command-line options. For example,
armcc --c90 --gnu.
To ensure conformance with ISO/IEC 9899:1990, the 1990 International Standard for C and ISO/IEC
9899 AM1, the 1995 Normative Addendum 1, you must also use the --strict option.
Default
This option is implicitly selected for files having a suffix of .c, .ac, or .tc.
Note
If you are migrating from RVCT, be aware that filename extensions .ac and .tc are deprecated in ARM
Compiler 4.1 and later.
Related references
8.24 --c99 on page 8-347.
8.93 --gnu on page 8-424.
8.39 --cpp on page 8-363.
8.176 --strict, --no_strict on page 8-513.
8.40 --cpp11 on page 8-364.
8.41 --cpp_compat on page 8-365.
1.2 Source language modes of the compiler on page 1-31.
2.7 Filename suffixes recognized by the compiler on page 2-49.
8.24 --c99
Enables the compilation of C99 source code.
It enforces C only, and C++ syntax is not accepted.
Usage
This option can also be combined with other source language command-line options. For example,
armcc --c99 --gnu.
To ensure conformance with the ISO/IEC 9899:1999, the 1999 International Standard for C, you must
also use the --strict option.
Default
For files having a suffix of .c, .ac, or .tc, --c90 applies by default.
Related references
8.23 --c90 on page 8-346.
8.93 --gnu on page 8-424.
8.39 --cpp on page 8-363.
8.176 --strict, --no_strict on page 8-513.
8.40 --cpp11 on page 8-364.
8.41 --cpp_compat on page 8-365.
1.2 Source language modes of the compiler on page 1-31.
2.7 Filename suffixes recognized by the compiler on page 2-49.
Default
The default is --code_gen.
Usage
Use --no_comment_section to remove the .comment section, to help reduce the object file size.
Default
The default is --comment_section.
Default
The default is --common_functions.
Usage
When --common_functions is used, the required private helper functions are automatically generated in
the output object file. Each helper function is generated in a named common group so that all duplicate
functions are removed at link time.
When --no_common_functions is used, the private helper functions are supplied by a helper library. The
helper library must be supplied if the output object is used in a project that uses a different toolchain.
This option allows alternative implementations of helper library functions to be provided.
Note
The --no_common_functions option also prevents the generation of specialized helper functions, for
example, division by a constant. The implementations of the helper functions in the libraries only handle
the general case.
Related information
Compiler generated and library-resident helper functions.
8.28 --compatible=name
Generates code that is compatible with multiple target architectures or processors.
Syntax
--compatible=name
Where:
name
is the name of a target processor or architecture, or None.
Processor and architecture names are not case-sensitive.
Specifying None generates code only for the processor or architecture specified by --cpu.
If multiple instances of this option are present on the command line, the last one specified
overrides the previous instances. Specify --compatible=None at the end of the command line to
turn off all other instances of the option.
Default
The default is None.
Usage
Using this option avoids having to recompile the same source code for different targets.
See the following table. The valid combinations are:
• --cpu=CPU_from_group1 --compatible=CPU_from_group2.
• --cpu=CPU_from_group2 --compatible=CPU_from_group1.
Group 1 ARM7TDMI, 4T
Group 2 Cortex-M0, Cortex-M1, Cortex-M3, Cortex-M4, 7-M, 6-M, 6S-M, SC300, SC000
Example
To generate code that is compatible with both the ARM7TDMI processor and the Cortex-M4 processor,
specify:
armcc --cpu=arm7tdmi --compatible=cortex-m4 myprog.c
Related references
8.1 -Aopt on page 8-317.
8.7 --arm on page 8-326.
Default
The default is --no_compile_all_input.
Related references
8.117 --link_all_input, --no_link_all_input on page 8-449.
2.7 Filename suffixes recognized by the compiler on page 2-49.
When you compile with --no_conditionalize, the compiler does not generate conditional instructions
such as ADDEQ and LDRGE. It generates conditional branch instructions such as BEQ and BLGE to execute
conditional code. The only instructions that can be conditional are B, BL, BX, BLX, and BXJ.
Default
The default is --conditionalize.
Related information
Conditional instructions.
Condition code suffixes.
Comparison of condition code meanings.
8.31 --configure_cpp_headers=path
Specifies the path to the GNU libstdc++ STL header files, when configuring the tools for use with
ARM Linux.
Syntax
--configure_cpp_headers=path
Where:
path
is the path to the GNU C++ STL header files.
Usage
This option overrides any path that is automatically detected. It can be used as part of a manual approach
to configuring the tools for use with ARM Linux.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.32 --configure_extra_includes=paths
Specifies any additional system include paths when configuring the tools for use with ARM Linux.
Syntax
--configure_extra_includes=paths
Where:
paths
is a comma separated list of pathnames denoting the locations of the additional system include
paths.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.33 --configure_extra_libraries=paths
Specifies any additional system library paths when configuring the tools for use with ARM Linux.
Syntax
--configure_extra_libraries=paths
Where:
paths
is a comma separated list of pathnames denoting the locations of the additional system library
paths.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.34 --configure_gas=path
Specifies the location of the GNU assembler (gas), when configuring the tools for use with ARM Linux.
Usage
To optionally invoke gas rather than armasm when compiling source files ending in .s or .S, you can
either:
• Specify --configure_gas=path when using --arm_linux_configure.
• Rely on the Linux configuration to query GCC for the path to the gas executable.
Specifying --configure_gas=path overrides the Linux configuration querying GCC for the path to the
gas executable.
Related references
8.189 --use_gas on page 8-531.
8.200 -Warmcc,option[,option,...] on page 8-542.
8.35 --configure_gcc=path
Specifies the location of the GCC driver, when configuring the tools for use with ARM Linux.
Syntax
--configure_gcc=path
Where:
path
is the path and filename of the GCC driver.
Usage
Use this option if you want to override the default location of the GCC driver specified during
configuration, or if the automatic configuration method of --arm_linux_configure fails to find the
driver.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
8.201 -Warmcc,--gcc_fallback on page 8-543.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.36 --configure_gcc_version=version
Overrides the GCC version when configuring for ARM Linux.
If you use this option to override the reported version when configuring against a GCC installation, the
compiler gives a warning if the override version you specify is older than the version of the GCC
installation.
Syntax
--configure_gcc_version=version
Where:
version
is a GCC version number of the form N.[N]N.[N]N.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.37 --configure_gld=path
Specifies the location of the GNU linker, ld.
Syntax
--configure_gld=path
Where:
path
is the path and filename of the GNU linker.
Usage
During configuration, the compiler attempts to determine the location of the GNU linker used by GCC. If
the compiler is unable to determine the location, or if you want to override the normal path to the GNU
linker, you can specify its location by using the --configure_gld=path option. The path is the full path
and filename of the GNU ld binary.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.38 --configure_sysroot=path
Specifies the system root path to use when configuring the tools for use with ARM Linux.
Syntax
--configure_sysroot=path
Usage
This option overrides any system root path that is automatically detected. It can be used as part of a
manual approach to configuring the tools for use with ARM Linux if you want to use a different path to
your normal system root path.
The system root path is the base path that libraries and header files are normally found from. On a
standard Linux system, this is typically the root of the file system. In a cross compilation GNU toolchain,
it is usually the parent directory of the GNU C library installation. This directory contains the lib, usr/
lib, and usr/include subdirectories that hold the C libraries and header files.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.8 --arm_linux on page 8-327.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.39 --cpp
Enables the compilation of C++03 source code.
Usage
This option can also be combined with other source language command-line options. For example,
armcc --cpp --cpp_compat.
Default
This option is implicitly selected for files having a suffix of .cpp, .cxx, .c++, .cc, or .CC.
Related references
8.5 --anachronisms, --no_anachronisms on page 8-321.
8.23 --c90 on page 8-346.
8.24 --c99 on page 8-347.
8.93 --gnu on page 8-424.
8.176 --strict, --no_strict on page 8-513.
8.40 --cpp11 on page 8-364.
8.41 --cpp_compat on page 8-365.
1.2 Source language modes of the compiler on page 1-31.
2.7 Filename suffixes recognized by the compiler on page 2-49.
8.40 --cpp11
Enables the compilation of C++11 source code.
Usage
This option can also be combined with other source language command-line options. For example,
armcc --cpp11 --cpp_compat.
When compiling C++11 code you must use the --cpp11 command line option. The default source
language mode when a C++ filename suffix is detected is C++03.
Default
For files with a suffix of .cpp, .cxx, .c++, .cc, or .CC, --cpp applies by default.
Related references
8.23 --c90 on page 8-346.
8.24 --c99 on page 8-347.
8.93 --gnu on page 8-424.
8.39 --cpp on page 8-363.
8.176 --strict, --no_strict on page 8-513.
8.41 --cpp_compat on page 8-365.
1.2 Source language modes of the compiler on page 1-31.
2.7 Filename suffixes recognized by the compiler on page 2-49.
11.13 C++11 supported features on page 11-814.
8.41 --cpp_compat
Compiles C++ code to maximize binary compatibility.
Usage
Use --cpp11 --cpp_compat to compile C++11 source code using a subset of features that maximizes
compatibility with source code compiled with C++03.
Use --cpp --cpp_compat to compile C++03 source code maximizing binary compatibility with C++03
code compiled using older compiler versions.
The --cpp11 --cpp_compat options behave in the same way as --cpp11 with the following restrictions:
• When the --exceptions option is selected, the array new operator with a length not known at
compile time does not perform bounds checking. This means that std::bad_alloc is thrown if there
is an error rather than std::bad_array_new_length.
• When the --exceptions option is selected, the delegating constructors language feature is disabled.
Any use of delegating constructors when the --cpp_compat is selected results in an error message.
armcc passes the --cpp_compat option to armlink if it invokes armlink to perform a final link step.
You can combine the --cpp_compat option with other source language command-line options. For
example:
• armcc --cpp_compat --cpp11
• armcc --cpp_compat --cpp
• armcc --cpp_compat --cpp --gnu
Examples
When compiling with --cpp11 --exceptions, code can catch std::bad_array_new_length:
void variable_length_array_new(unsigned i) {
bool exception_thrown = false;
try {
new int[i + 0x40000000];
} catch (std::bad_array_new_length e)
}
When compiling with --cpp11 --cpp_compat --exceptions, code can only catch std::bad_alloc:
void variable_length_array_new_cpp_compat(unsigned i) {
bool exception_thrown = false;
try {
new int[i + 0x40000000];
} catch (std::bad_alloc e)
}
Default
By default, the --cpp_compat option is not enabled.
For files with a suffix of .cpp, .cxx, .c++, .cc, or .CC, the --cpp option applies by default.
Related references
8.23 --c90 on page 8-346.
8.24 --c99 on page 8-347.
8.93 --gnu on page 8-424.
8.39 --cpp on page 8-363.
8.176 --strict, --no_strict on page 8-513.
8.40 --cpp11 on page 8-364.
1.2 Source language modes of the compiler on page 1-31.
8.42 --cpu=list
Lists the architecture and processor names that are supported by the --cpu=name option.
Syntax
--cpu=list
Related references
8.43 --cpu=name on page 8-368.
5.53 Processors and their implicit Floating-Point Units (FPUs) on page 5-218.
8.43 --cpu=name
Enables code generation for the selected ARM processor or architecture.
Syntax
--cpu=name
Architecture Description
4 ARMv4 without Thumb
4T ARMv4 with Thumb
5T ARMv5 with Thumb and interworking
5TE ARMv5 with Thumb, interworking, DSP multiply, and double-word instructions
5TEJ ARMv5 with Thumb, interworking, DSP multiply, double-word instructions, and Jazelle® extensions
Note
armcc cannot generate Java bytecodes.
6 ARMv6 with Thumb, interworking, DSP multiply, double-word instructions, unaligned and mixed-endian support,
Jazelle, and media extensions.
6-M ARMv6 microcontroller profile with Thumb only, plus processor state instructions.
6S-M ARMv6 microcontroller profile with Thumb only, plus processor state instructions and OS extensions.
6K ARMv6 with SMP extensions.
6T2 ARMv6 with Thumb (Thumb-2 technology).
6Z ARMv6 with Security Extensions.
7 ARMv7 with Thumb (Thumb-2 technology) only, and without hardware divide.
7-A ARMv7 application profile.
7-A.security ARMv7-A architecture profile with the SMC instruction (formerly SMI).
7-R ARMv7 real-time profile.
7-M ARMv7 microcontroller profile.
7E-M ARMv7-M architecture profile with DSP extension.
Note
• ARMv7 is not an actual ARM architecture. --cpu=7 denotes the features that are common to the
ARMv7-A, ARMv7-R, and ARMv7-M architectures. By definition, any given feature used with
--cpu=7 exists on the ARMv7-A, ARMv7-R, and ARMv7-M architectures.
• 7-A.security is not an actual ARM architecture, but rather refers to 7-A plus Security Extensions.
• The full list of supported architectures and processors depends on your license.
Default
armcc assumes --cpu=ARM7TDMI if you do not specify a --cpu option.
Usage
The following general points apply to processor and architecture options:
Processors
• Selecting the processor selects the appropriate architecture, Floating-Point Unit (FPU), and
memory organization.
• The supported --cpu values include all current ARM product names or architecture
versions.
Other ARM architecture-based processors, such as the Marvell Feroceon and the Marvell
XScale, are also supported.
• If you specify a processor for the --cpu option, the generated code is optimized for that
processor. This enables the compiler to use specific coprocessors or instruction scheduling
for optimum performance.
Architectures
• If you specify an architecture name for the --cpu option, the generated code can run on any
processor supporting that architecture. For example, --cpu=5TE produces code that can be
used by the ARM926EJ-S processor.
FPU
• Some specifications of --cpu imply an --fpu selection.
For example, when building with the --arm option, --cpu=ARM1136JF-S implies
--fpu=vfpv2. Similarly, --cpu=Cortex-R4F implies --fpu=vfpv3_d16.
Note
Any explicit FPU, set with --fpu on the command line, overrides an implicit FPU.
ARM/Thumb
• Specifying a processor or architecture that supports Thumb instructions, such as
--cpu=ARM7TDMI, does not make the compiler generate Thumb code. It only enables features
of the processor to be used, such as long multiply. Use the --thumb option to generate
Thumb code, unless the processor is a Thumb-only processor, for example Cortex-M4. In
this case, --thumb is not required.
Note
Specifying the target processor or architecture might make the generated object code
incompatible with other ARM processors. For example, code generated for architecture
ARMv6 might not run on an ARM920T processor, if the generated object code includes
instructions specific to ARMv6. Therefore, you must choose the lowest common
denominator processor suited to your purpose.
• If you are building for mixed ARM/Thumb systems for processors that support ARMv4T or
ARMv5T, then you must specify the interworking option --apcs=/interwork. By default,
this is enabled for processors that support ARMv5T or above.
• If you build for Thumb, that is with the --thumb option on the command line, the compiler
generates as much of the code as possible using the Thumb instruction set. However, the
compiler might generate ARM code for some parts of the compilation. For example, if you
are generating code for a 16-bit Thumb processor and using VFP, any function containing
floating-point operations is compiled for ARM.
• If the architecture only supports Thumb, you do not have to specify --thumb on the
command line. For example, if building for ARMv7-M with --cpu=7-M, you do not have to
specify --thumb on the command line, because ARMv7-M only supports Thumb. Similarly,
ARMv6-M and other Thumb-only architectures.
Restrictions
You cannot specify both a processor and an architecture on the same command-line.
Related references
8.6 --apcs=qualifier...qualifier on page 8-322.
8.42 --cpu=list on page 8-367.
8.89 --fpu=name on page 8-418.
8.180 --thumb on page 8-518.
10.14 __smc on page 10-615.
Related information
SMC.
8.44 --create_pch=filename
Instructs the compiler to create a Precompiled Header (PCH) file with the specified filename.
Note
This option is deprecated.
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
Syntax
--create_pch=filename
Where:
filename
is the name of the PCH file to be created.
Related concepts
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.24 Precompiled Header (PCH) files on page 4-134.
Related references
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
8.150 --pch_messages, --no_pch_messages on page 8-486.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
8.190 --use_pch=filename on page 8-532.
10.87 #pragma hdrstop on page 10-693.
10.92 #pragma no_pch on page 10-698.
8.45 -Dname[(parm-list)][=def]
Defines the macro name.
Syntax
-Dname[(parm-list)][=def]
Where:
name
Is the name of the macro to be defined.
parm-list
Is an optional list of comma-separated macro parameters. By appending a macro parameter list
to the macro name, you can define function-style macros.
The parameter list must be enclosed in parentheses. When specifying multiple parameters, do
not include spaces between commas and parameter names in the list.
Note
Parentheses might require escaping on UNIX systems.
=def
Is an optional macro definition.
If =def is omitted, the compiler defines name as the value 1.
To include characters recognized as tokens on the command line, enclose the macro definition in
double quotes.
Usage
Specifying a macro and a definition with -Dmacro=def has the same effect as placing the text #define
macro def at the head of each source file.
Specifying a macro without a definition with -Dmacro has the same effect as placing the text #define
macro 1 at the head of each source file.
Restrictions
The compiler defines and undefines macros in the following order:
1. Compiler predefined macros.
2. Macros defined explicitly, using -Dname.
3. Macros explicitly undefined, using -Uname.
Example
Specifying the option:
-DMAX(X,Y)="((X > Y) ? X : Y)"
Related references
8.22 -C on page 8-345.
8.70 -E on page 8-398.
8.186 -Uname on page 8-527.
10.161 Predefined macros on page 10-786.
Default
The default is optimization-level dependent:
-O0:
--no_data_reorder
-O1, -O2, -O3:
--data_reorder
Related concepts
4.35 Default compiler options that are affected by optimization level on page 4-148.
Related references
8.139 -Onum on page 8-473.
Default
The default is --no_debug.
Using --debug does not affect optimization settings. By default, using the --debug option alone is
equivalent to:
--debug --dwarf3 --debug_macros
Related references
8.48 --debug_macros, --no_debug_macros on page 8-375.
8.68 --dwarf2 on page 8-396.
8.69 --dwarf3 on page 8-397.
8.139 -Onum on page 8-473.
Usage
Using --no_debug_macros might reduce the size of the debug image.
This option must be used with the --debug option.
Default
The default is --debug_macros.
Related references
8.47 --debug, --no_debug on page 8-374.
8.94 --gnu_defaults on page 8-425.
8.49 --default_definition_visibility=visibility
Controls the default ELF symbol visibility of extern variable and function definitions.
Syntax
--default_definition_visibility=visibility
Where:
visibility
is default, hidden, internal, or protected.
Usage
Use --default_definition_visibility=visibility to force the compiler to use the specified ELF
symbol visibility for all extern variables and functions defined in the source file, if they do not use
__declspec(dll*) or __attribute__((visibility("visibility_type"))). Unlike --hide_all,
--no_hide_all, this does not affect extern references.
Default
By default, --default_definition_visibility=hidden.
Related references
8.99 --hide_all, --no_hide_all on page 8-430.
10.53 __attribute__((visibility("visibility_type"))) function attribute on page 10-658.
10.72 __attribute__((visibility("visibility_type"))) variable attribute on page 10-677.
Related information
Symbol visibility for BPABI models.
8.50 --default_extension=ext
Changes the filename extension for object files from the default extension (.o) to an extension of your
choice.
Syntax
--default_extension=ext
Where:
ext
is the filename extension of your choice.
Default
By default, the filename extension for object files is .o.
Example
The following example creates an object file called test.obj, instead of test.o:
armcc --default_extension=obj -c test.c
Note
The -o filename option overrides this. For example, the following command results in an object file
named test.o:
armcc --default_extension=obj -o test.o -c test.c
Mode
This option is effective only if the source language is C++.
Default
The default is --dep_name.
Restrictions
The option --dep_name cannot be combined with the option --no_parse_templates, because parsing is
done by default when dependent name processing is enabled.
Errors
When the options --dep_name and --no_parse_templates are combined, the compiler generates an
error.
Related references
8.147 --parse_templates, --no_parse_templates on page 8-483.
11.9 Template instantiation in ARM C++ on page 11-809.
8.52 --depend=filename
Writes makefile dependency lines to a file during compilation.
Syntax
--depend=filename
Where:
filename
is the name of the dependency file to be output.
Usage
If you specify multiple source files on the command line then the dependency file accumulates the
dependency lines from each source file. The output file is suitable for use by a make utility. To change
the output format to be compatible with UNIX make utilities, use the --depend_format option.
Related references
8.54 --depend_format=string on page 8-381.
8.53 --depend_dir=directory_name on page 8-380.
8.56 --depend_system_headers, --no_depend_system_headers on page 8-384.
8.57 --depend_target=target on page 8-385.
8.55 --depend_single_line, --no_depend_single_line on page 8-383.
8.153 --phony_targets on page 8-489.
8.101 --ignore_missing_headers on page 8-432.
8.118 --list on page 8-450.
8.128 -M on page 8-461.
8.129 --md on page 8-462.
8.53 --depend_dir=directory_name
Specifies the directory for dependency output files.
Examples
armcc -c --output_dir=obj f1.c f2.c --depend_dir=depend
If you specify a dependency file, --depend=deps, then the dependency file accumulates the dependency
lines from each source file, for example:
armcc -c --output_dir=obj f1.c f2.c --depend_dir=depend --depend=deps
Related references
8.52 --depend=filename on page 8-379.
8.14 --asm_dir=directory_name on page 8-336.
8.119 --list_dir=directory_name on page 8-452.
8.145 --output_dir=directory_name on page 8-481.
8.54 --depend_format=string
Specifies the format of output dependency files, for compatibility with some UNIX make programs.
Syntax
--depend_format=string
Usage
unix
On Windows systems, --depend_format=unix forces the use of UNIX-style path names. That
is, the UNIX-style path separator symbol / is used in place of \.
On UNIX systems, --depend_format=unix has no effect.
unix_escaped
On Windows systems, --depend_format=unix_escaped forces UNIX-style path names, and
escapes spaces with \.
On UNIX systems, --depend_format=unix_escaped with escapes spaces with \.
unix_quoted
On Windows systems, --depend_format=unix_quoted forces UNIX-style path names and
surrounds them with "".
On UNIX systems, --depend_format=unix_quoted surrounds path names with "".
Default
If you do not specify a --depend_format option, then the format of output dependency files depends on
your choice of operating system:
Windows
On Windows systems, the default is to use either Windows-style paths or UNIX-style paths,
whichever is given.
UNIX
On UNIX systems, the default is --depend_format=unix.
Example
On a Windows system, compiling a file main.c containing the line:
#include "..\include\header files\common.h"
main.axf: main.c
main.axf: ../include/header\ files/common.h
Related references
8.52 --depend=filename on page 8-379.
8.56 --depend_system_headers, --no_depend_system_headers on page 8-384.
Default
The default is --no_depend_single_line.
Example
/* hello.c */
#include <stdio.h>
int main(void)
{
printf("Hello, world!\n");
return 0;
}
Related references
8.56 --depend_system_headers, --no_depend_system_headers on page 8-384.
8.52 --depend=filename on page 8-379.
8.54 --depend_format=string on page 8-381.
8.57 --depend_target=target on page 8-385.
8.101 --ignore_missing_headers on page 8-432.
8.128 -M on page 8-461.
8.129 --md on page 8-462.
8.153 --phony_targets on page 8-489.
Default
The default is --depend_system_headers.
Example
/* hello.c */
#include <stdio.h>
int main(void)
{
printf("Hello, world!\n");
return 0;
}
Related references
8.55 --depend_single_line, --no_depend_single_line on page 8-383.
8.52 --depend=filename on page 8-379.
8.54 --depend_format=string on page 8-381.
8.57 --depend_target=target on page 8-385.
8.101 --ignore_missing_headers on page 8-432.
8.128 -M on page 8-461.
8.129 --md on page 8-462.
8.153 --phony_targets on page 8-489.
8.57 --depend_target=target
Specifies the target for makefile dependency generation.
Usage
Use this option to override the default target.
Restriction
This option is analogous to -MT in GCC. However, behavior differs when specifying multiple targets. For
example, gcc -M -MT target1 -MT target2 file.c might give a result of target1 target2:
file.c header.h, whereas --depend_target=target1 --depend_target=target2 treats target2 as
the target.
Related references
8.52 --depend=filename on page 8-379.
8.54 --depend_format=string on page 8-381.
8.56 --depend_system_headers, --no_depend_system_headers on page 8-384.
8.101 --ignore_missing_headers on page 8-432.
8.128 -M on page 8-461.
8.129 --md on page 8-462.
8.153 --phony_targets on page 8-489.
8.58 --diag_error=tag[,tag,...]
Sets diagnostic messages that have a specific tag to Error severity.
Note
This option has the #pragma equivalent #pragma diag_error.
Syntax
--diag_error=tag[,tag,…]
Where tag can be:
• A diagnostic message number to set to error severity. This is the four-digit number, nnnn, with the
tool letter prefix, but without the letter suffix indicating the severity.
• warning, to treat all warnings as errors.
Usage
The severity of the following types of diagnostic messages can be changed:
• Messages with the number format #nnnn-D.
• Warning messages with the number format CnnnnW.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
8.59 --diag_remark=tag[,tag,...]
Sets diagnostic messages that have a specific tag to Remark severity.
The --diag_remark option behaves analogously to --diag_error, except that the compiler sets the
diagnostic messages having the specified tags to Remark severity rather than Error severity.
Note
Remarks are not displayed by default. Use the --remarks option to display these messages.
Note
This option has the #pragma equivalent #pragma diag_remark.
Syntax
--diag_remark=tag[,tag,…]
Where tag is a comma-separated list of diagnostic message numbers. This is the four-digit number,
nnnn, with the tool letter prefix, but without the letter suffix indicating the severity.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
Syntax
--diag_style=string
Default
The default is --diag_style=arm.
Usage
--diag_style=gnu matches the format reported by the GNU Compiler, gcc.
Choosing the option --diag_style=ide implicitly selects the option --brief_diagnostics. Explicitly
selecting --no_brief_diagnostics on the command line overrides the selection of
--brief_diagnostics implied by --diag_style=ide.
Selecting either the option --diag_style=arm or the option --diag_style=gnu does not imply any
selection of --brief_diagnostics.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
8.61 --diag_suppress=tag[,tag,...]
Suppresses diagnostic messages that have a specific tag.
Behaves analogously to --diag_error, except that the compiler suppresses the diagnostic messages
having the specified tags rather than setting them to have Error severity.
Note
This option has the #pragma equivalent #pragma diag_suppress.
Syntax
--diag_suppress=tag[,tag,…]
Where tag can be:
• A diagnostic message number to be suppressed. This is the four-digit number, nnnn, with the tool
letter prefix, but without the letter suffix indicating the severity.
• error, to suppress all errors that can be downgraded.
• warning, to suppress all warnings.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
8.62 --diag_suppress=optimizations
Suppresses diagnostic messages for high-level optimizations.
Default
By default, optimization messages have Remark severity. Specifying --diag_suppress=optimizations
suppresses optimization messages.
Note
Use the --remarks option to see optimization messages having Remark severity.
Usage
The compiler performs certain high-level vector and scalar optimizations when compiling at the
optimization level -O3 -Otime, for example, loop unrolling. Use this option to suppress diagnostic
messages relating to these high-level optimizations.
Example
int factorial(int n)
{
int result=1;
while (n > 0)
result *= n--;
return result;
}
Compiling this code with the options -O3 -Otime --remarks --diag_suppress=optimizations
suppresses optimization messages.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
8.63 --diag_warning=tag[,tag,...]
Sets diagnostic messages that have a specific tag to Warning severity.
The --diag_warning option behaves analogously to --diag_error, except that the compiler sets the
diagnostic messages having the specified tags to warning severity rather than error severity.
Note
This option has the #pragma equivalent #pragma diag_warning.
Syntax
--diag_warning=tag[,tag,…]
Where tag can be:
• A diagnostic message number to set to warning severity. This is the four-digit number, nnnn, with the
tool letter prefix, but without the letter suffix indicating the severity.
• error, to set all errors that can be downgraded to warnings.
Example
--diag_warning=A1234,error causes message A1234 and all downgradable errors to be treated as
warnings, providing changing the severity of A1234 is permitted.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
8.64 --diag_warning=optimizations
Sets high-level optimization diagnostic messages to have Warning severity.
Default
By default, optimization messages have Remark severity.
Usage
The compiler performs certain high-level vector and scalar optimizations when compiling at the
optimization level -O3 -Otime, for example, loop unrolling. Use this option to display diagnostic
messages relating to these high-level optimizations.
Example
int factorial(int n)
{
int result=1;
while (n > 0)
result *= n--;
return result;
}
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
Default
The default is --no_dllexport_all.
Usage
Use the option --dllexport_all to mark all extern definitions as __declspec(dllexport).
Related references
8.6 --apcs=qualifier...qualifier on page 8-322.
10.23 __declspec(dllexport) on page 10-625.
Default
The default is --no_dllimport_runtime.
Usage
Use the option --dllimport_runtime to mark all implicit references as __declspec(dllimport).
Implicit references are references that are not in user source code but are nonetheless used by the
compiler. Implicit references include:
• Library-resident compiler helper functions. For example, helper functions for software floating-point
support.
• RunTime Type Information (RTTI) found in the C++ runtime libraries.
• Any optimized implementation of a user-specified function, for example, printf(), providing that
the non-optimized user-specified version of the function that the optimized implementation is based
on, is marked as __declspec(dllimport). Header files describing which library functions are
exported from DLLs are usually provided with the platform DLL version of the C library.
Related references
8.97 --guiding_decls, --no_guiding_decls on page 8-428.
8.166 --rtti, --no_rtti on page 8-502.
10.24 __declspec(dllimport) on page 10-627.
Default
If the options --strict or --strict_warnings are specified, the default is --no_dollar. Otherwise,
the default is --dollar.
Related references
8.176 --strict, --no_strict on page 8-513.
9.19 Dollar signs in identifiers on page 9-569.
8.177 --strict_warnings on page 8-514.
8.68 --dwarf2
Uses DWARF 2 debug table format.
Default
The compiler assumes --dwarf3 unless --dwarf2 is explicitly specified.
Related references
8.69 --dwarf3 on page 8-397.
Related information
The DWARF Debugging Standard, http://dwarfstd.org/.
8.69 --dwarf3
Uses DWARF 3 debug table format.
Default
The compiler assumes --dwarf3 unless --dwarf2 is explicitly specified.
Related references
8.68 --dwarf2 on page 8-396.
Related information
The DWARF Debugging Standard, http://dwarfstd.org/.
8.70 -E
Executes the preprocessor step only.
By default, output from the preprocessor is sent to the standard output stream and can be redirected to a
file using standard UNIX and MS-DOS notation.
You can also use the -o option to specify a file for the preprocessed output. By default, comments are
stripped from the output. The preprocessor accepts source files with any extension, for example, .o, .s,
and .txt.
To generate interleaved macro definitions and preprocessor output, use -E --list_macros.
Note
C++ implicit inclusion does not take place when using the armcc -E preprocessor. Normally,
compilation expands all explicit #include header files. In addition, some C++ files such as .cc files are
added implicitly. However, using -E prevents implicit inclusion of these files. Therefore, if template
entities are defined in a .cc file, armcc -E fails to include such definitions.
Example
armcc -E source.c > raw.c
Related references
8.22 -C on page 8-345.
8.120 --list_macros on page 8-453.
8.129 --md on page 8-462.
8.138 -o filename on page 8-471.
8.141 --old_style_preprocessing on page 8-477.
8.146 -P on page 8-482.
Related information
Why does armcc -E preprocessing result in linker undefined symbol error?.
8.71 --echo
Displays the complete expanded command line, and any separate commands that invoke other external
applications, such as armasm or armlink.
This command is useful when specifying options that cause multiple command invocations, such as GCC
fallback.
Usage
If you use --echo when performing GCC fallback, you must specify it using -Warmcc,-echo.
Examples
To compile and link:
armcc --echo foo.c -o foo.axf
[armcc --echo -ofoo.axf foo.c]
[armlink -o foo.axf foo.o --fpu=SoftVFP --li]
To compile only:
armcc -c --echo foo.c -o foo.axf
[armcc --echo -c -ofoo.axf foo.c]
Related references
8.200 -Warmcc,option[,option,...] on page 8-542.
8.201 -Warmcc,--gcc_fallback on page 8-543.
Default
The default is --no_emit_frame_directives.
Examples
armcc --asm --emit_frame_directives foo.c
Related references
8.13 --asm on page 8-335.
8.168 -S on page 8-504.
Related information
Frame directives.
8.73 --enum_is_int
Forces the size of all enumeration types to be at least four bytes.
Note
ARM does not recommend the --enum_is_int option for general use.
Default
This option is switched off by default. The smallest data type that can hold the values of all enumerators
is used. However, if you specify an ARM Linux configuration file on the command line, --enum_is_int
is switched on by default.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.110 --interface_enums_are_32_bit on page 8-441.
11.4 Structures, unions, enumerations, and bitfields in ARM C and C++ on page 11-799.
8.74 --errors=filename
Redirects the output of diagnostic messages from stderr to the specified errors file.
Syntax
--errors=filename
Where:
filename
is the name of the file to which errors are to be redirected.
Diagnostics that relate to problems with the command options are not redirected, for example, if you type
an option name incorrectly. However, if you specify an invalid argument to an option, for example
--cpu=999, the related diagnostic is redirected to the specified filename.
Usage
This option is useful on systems where output redirection of files is not well supported.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
Default
The default is --no_exceptions. However, if you specify an ARM Linux configuration file on the
command line and you use --translate_g++, the default changes to --exceptions.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
11.11 C++ exception handling in ARM C++ on page 11-812.
8.76 --exceptions_unwind, --no_exceptions_unwind on page 8-404.
10.85 #pragma exceptions_unwind, #pragma no_exceptions_unwind on page 10-691.
When you use --no_exceptions_unwind and --exceptions then no exception can propagate through
the compiled functions. std::terminate is called instead.
Default
The default is --exceptions_unwind.
Related references
11.11 C++ exception handling in ARM C++ on page 11-812.
8.75 --exceptions, --no_exceptions on page 8-403.
10.85 #pragma exceptions_unwind, #pragma no_exceptions_unwind on page 10-691.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
8.78 --execute_only
Generates execute-only code by adding the EXECONLY attribute to the AREA directive for all code sections,
preventing the compiler from generating any data accesses to code sections.
To keep code and data in separate sections, the compiler disables literal pools and branch tables. That is,
specifying --execute_only implicitly specifies the following compiler options:
• --no_integer_literal_pools.
• --no_float_literal_pools.
• --no_string_literal_pools.
• --no_branch_tables.
Restrictions
Execute-only code must be Thumb code.
Execute-only code is only supported for:
• Processors that support the ARMv7-M architecture, such as Cortex-M3, Cortex-M4, and Cortex-M7.
• Processors that support the ARMv6-M architecture.
Note
ARM has only performed limited testing of execute-only code on ARMv6-M targets.
If your application calls library functions, the library objects included in the image are not execute-only
compliant. You must ensure these objects are not assigned to an execute-only memory region.
Note
ARM does not provide libraries that are built without literal pools. The libraries still use literal pools,
even when you use the various --no_*_literal_pools options.
Related concepts
4.21 Compiler support for literal pools on page 4-131.
Related references
8.109 --integer_literal_pools, --no_integer_literal_pools on page 8-440.
8.178 --string_literal_pools, --no_string_literal_pools on page 8-515.
8.18 --branch_tables, --no_branch_tables on page 8-340.
8.83 --float_literal_pools, --no_float_literal_pools on page 8-411.
Related information
AREA (assembler directive).
Building applications for execute-only memory.
Mode
This option is effective only if the source language is C++.
Default
The default is --no_export_all_vtbl.
Usage
Use the option --export_all_vtbl to export all virtual function tables and RTTI for classes with a key
function. A key function is the first virtual function of a class, in declaration order, that is not inline, and
is not pure virtual.
Note
You can disable export for specific classes by using __declspec(notshared).
Related references
8.106 --import_all_vtbl on page 8-437.
10.28 __declspec(notshared) on page 10-631.
Default
The default is --no_export_defs_implicitly.
Usage
Use the option --export_defs_implicitly to export definitions where the prototype is marked
__declspec(dllimport).
Related references
10.24 __declspec(dllimport) on page 10-627.
When certain nonportable but widely supported constant initializers such as the cast of an address to an
integral type are used, --extended_initializers causes the compiler to produce the same general
warning concerning constant initializers that it normally produces in nonstrict mode, rather than specific
errors stating that the expression must have a constant value or have arithmetic type.
Default
The default is --no_extended_initializers when compiling with --strict or --strict_warnings.
The default is --extended_initializers when compiling in nonstrict mode.
Related references
8.176 --strict, --no_strict on page 8-513.
8.177 --strict_warnings on page 8-514.
9.16 Constant expressions on page 9-566.
8.82 --feedback=filename
Enables the linker to communicate with the compiler to eliminate unused functions.
Syntax
--feedback=filename
Where:
filename
is the feedback file created by a previous execution of the ARM linker.
Usage
You can perform multiple compilations using the same feedback file. The compiler places each unused
function identified in the feedback file into its own ELF section in the corresponding object file.
The feedback file contains information about a previous build. Because of this:
• The feedback file might be out of date. That is, a function previously identified as being unused
might be used in the current source code. The linker removes the code for an unused function only if
it is not used in the current source code.
Note
— For this reason, eliminating unused functions using linker feedback is a safe optimization, but
there might be a small impact on code size.
— The usage requirements for reducing compilation required for interworking are more strict than
for eliminating unused functions. If you are reducing interworking compilation, it is critical that
you keep your feedback file up to date with the source code that it was generated from.
• You have to do a full compile and link at least twice to get the maximum benefit from linker
feedback. However, a single compile and link using feedback from a previous build is usually
sufficient.
Related references
8.175 --split_sections on page 8-512.
2.15 Linker feedback during compilation on page 2-59.
Related information
--feedback_type=type linker option.
With the --no_float_literal_pools option, the compiler generates code that loads these constants
using core instruction set loads and reinterprets them as floats or vectors:
** Section #1 '.text' (SHT_PROGBITS) [SHF_ALLOC + SHF_EXECINSTR]
Size : 16 bytes (alignment 4)
Address: 0x00000000
$a
.text
main
0x00000000: e59f0004 .... LDR r0,[pc,#4] ; [0xc] = 0x42280000
0x00000004: ee000a10 .... VMOV s0,r0
0x00000008: eafffffe .... B f
$d
0x0000000c: 42280000 ..(B DCD 1109917696
If you also specify the --no_integer_literal_pools option, the compiler constructs these constants
with sequences of MOVW and MOVT instructions.
This option also controls integer vectors.
Default
The default is --float_literal_pools.
--execute_only implies --no_float_literal_pools, unless --float_literal_pools is explicitly
specified.
Note
Do not use --execute_only in conjunction with --float_literal_pools. If you do, then the compiler
places the literal pool in an unreadable, execute-only code region.
Related concepts
4.21 Compiler support for literal pools on page 4-131.
Related references
8.109 --integer_literal_pools, --no_integer_literal_pools on page 8-440.
8.178 --string_literal_pools, --no_string_literal_pools on page 8-515.
8.18 --branch_tables, --no_branch_tables on page 8-340.
8.78 --execute_only on page 8-406.
If you use --force_new_nothrow, the compiler treats expressions such as new T(...args...), that use
the global ::operator new or ::operator new[], as if they are new (std::nothrow)
T(...args...).
--force_new_nothrow also causes any class-specific operator new or any overloaded global operator
new to be treated as no throw.
Note
The option --force_new_nothrow is provided only as a migration aid for legacy source code that does
not conform to the C++ standard. ARM does not recommend its use.
Mode
This option is effective only if the source language is C++.
Default
The default is --no_force_new_nothrow.
Example
struct S
{
void* operator new(std::size_t);
void* operator new[](std::size_t);
};
void *operator new(std::size_t, int);
Related references
11.5 Using the ::operator new function in ARM C++ on page 11-805.
8.85 --forceinline
Forces all inline functions to be treated as if they are qualified with __forceinline.
Inline functions are functions that are qualified with inline or __inline. In C++, inline functions are
functions that are defined inside a struct, class, or union definition.
If you use --forceinline, the compiler always attempts to inline those functions, if possible. However,
it does not inline a function if doing so causes problems. For example, a recursive function is never
inlined into itself.
__forceinline behaves like __inline except that the compiler tries harder to do the inlining.
Related references
8.108 --inline, --no_inline on page 8-439.
10.8 __inline on page 10-608.
10.6 __forceinline on page 10-605.
10.32 __attribute__((always_inline)) function attribute on page 10-637.
8.86 --fp16_format=format
Enables the use of half-precision floating-point numbers as an optional extension to the VFPv3
architecture. If a format is not specified, use of the __fp16 data type is faulted by the compiler.
Syntax
--fp16_format=format
Restrictions
The following restrictions apply when you use the __fp16 data type:
• When used in a C or C++ expression, an __fp16 type is promoted to single precision. Subsequent
promotion to double precision can occur if required by one of the operands.
• A single precision value can be converted to __fp16. A double precision value is converted to single
precision and then to __fp16, that could involve double rounding. This reflects the lack of direct
double-to-16-bit conversion in the ARM architecture.
• When using fpmode=fast, no floating-point exceptions are raised when converting to and from half-
precision floating-point format.
• Function formal arguments cannot be of type __fp16. However, pointers to variables of type __fp16
can be used as function formal argument types.
• __fp16 values can be passed as actual function arguments. In this case, they are converted to single-
precision values.
• __fp16 cannot be specified as the return type of a function. However, a pointer to an __fp16 type can
be used as a return type.
• An __fp16 value is converted to a single-precision or double-precision value when used as a return
value for a function that returns a float or double.
Related concepts
5.47 Compiler and library support for half-precision floating-point numbers on page 5-210.
Related references
8.87 --fpmode=model on page 8-415.
18.3 NEON intrinsics on page 18-927.
8.87 --fpmode=model
Specifies floating-point standard conformance. This controls which floating-point optimizations the
compiler can perform, and also influences library selection.
Syntax
--fpmode=model
ieee_fixed
IEEE standard with round-to-nearest and no inexact exceptions.
This defines the symbols:
__FP_IEEE
__FP_FENV_EXCEPTIONS
ieee_no_fenv
IEEE standard with round-to-nearest and no exceptions. This mode is stateless and is compatible
with the Java floating-point arithmetic model.
This defines the symbol __FP_IEEE.
none
The compiler permits --fpmode=none as an alternative to --fpu=none, indicating that source
code is not permitted to use floating-point types of any kind.
std
IEEE finite values with denormals flushed to zero, round-to-nearest, and no exceptions. This is
compatible with standard C and C++ and is the default option.
Normal finite values are as predicted by the IEEE standard. However:
• NaNs and infinities might not be produced in all circumstances defined by the IEEE model.
When they are produced, they might not have the same sign.
• The sign of zero might not be that predicted by the IEEE model.
• Using NaNs in arithmetic operations with --fpmode=std causes undefined behavior.
fast
Perform more aggressive floating-point optimizations that might cause a small loss of accuracy
to provide a significant performance increase. This option defines the symbol __FP_FAST.
This option results in behavior that is not fully compliant with the ISO C or C++ standard.
However, numerically robust floating-point programs are expected to behave correctly.
A number of transformations might be performed, including:
• Double-precision math functions might be converted to single precision equivalents if all
floating-point arguments can be exactly represented as single precision values, and the result
is immediately converted to a single-precision value.
This transformation is only performed when the selected library contains the single-precision
equivalent functions, for example, when the selected library is armcc or aeabi_glibc.
For example:
float f(float a)
{
return sqrt(a);
}
is transformed to
float f(float a)
{
return sqrtf(a);
}
• Double-precision floating-point expressions that are narrowed to single-precision are
evaluated in single-precision when it is beneficial to do so. For example, float y =
(float)(x + 1.0) is evaluated as float y = (float)x + 1.0f.
• Division by a floating-point constant is replaced by multiplication with the inverse. For
example, x / 3.0 is evaluated as x * (1.0 / 3.0).
• It is not guaranteed that the value of errno is compliant with the ISO C or C++ standard
after math functions have been called. This enables the compiler to inline the VFP square
root instructions in place of calls to sqrt() or sqrtf().
Using a NaN with --fpmode=fast can produce undefined behavior.
Note
Initialization code might be required to enable the VFP.
Default
The default is --fpmode=std.
Related concepts
5.45 Limitations on hardware handling of floating-point arithmetic on page 5-207.
Related references
8.89 --fpu=name on page 8-418.
Related information
ARM Application Note 133 - Using VFP with RVDS.
8.88 --fpu=list
Lists the FPU architectures that are supported by the --fpu=name option.
Deprecated options are not listed.
Related references
8.89 --fpu=name on page 8-418.
8.89 --fpu=name
Specifies the target FPU architecture.
If you specify this option, it overrides any implicit FPU option that appears on the command line, for
example, where you use the --cpu option.
The compiler sets a build attribute corresponding to name in the object file. The linker determines
compatibility between object files, and selection of libraries, accordingly.
To obtain a full list of FPU architectures use the --fpu=list option.
Syntax
--fpu=name
vfpv3
Selects a hardware vector floating-point unit conforming to architecture VFPv3. VFPv3 is
backwards compatible with VFPv2 except that VFPv3 cannot trap floating-point exceptions.
vfpv3_fp16
Selects a hardware vector floating-point unit conforming to architecture VFPv3 that also
provides the half-precision extensions.
vfpv3_d16
Selects a hardware vector floating-point unit conforming to VFPv3-D16 architecture.
vfpv3_d16_fp16
Selects a hardware vector floating-point unit conforming to VFPv3-D16 architecture, that also
provides the half-precision extensions.
vfpv4
Selects a hardware floating-point unit conforming to the VFPv4 architecture.
vfpv4_d16
Selects a hardware floating-point unit conforming to the VFPv4-D16 architecture.
fpv4-sp
Selects a hardware floating-point unit conforming to the single precision variant of the FPv4
architecture.
fpv5_d16
Selects a hardware floating-point unit conforming to the FPv5-D16 architecture.
fpv5-sp
Selects a hardware floating-point unit conforming to the single precision variant of the FPv5
architecture.
softvfp
Selects software floating-point support where floating-point operations are performed by a
floating-point library, fplib. This is the default if you do not specify a --fpu option, or if you
select a processor that does not have an FPU.
softvfp+vfpv2
Selects a hardware vector floating-point unit conforming to VFPv2, with software floating-point
linkage. Select this option if you are interworking Thumb code with ARM code on a system that
implements a VFP unit.
If you select this option:
• Building with --thumb behaves in a similar way to --fpu=softvfp except that it links with
floating-point libraries that use VFP instructions.
• Building with --arm behaves in a similar way to --fpu=vfpv2 except that all functions are
given software floating-point linkage. This means that functions pass and return floating-
point arguments and results in the same way as --fpu=softvfp, but use VFP instructions
internally.
Note
If you specify softvfp+vfpv2 with the --arm or --thumb option for C code, it ensures that your
interworking floating-point code is compiled to use software floating-point linkage.
softvfp+vfpv3
Selects a hardware vector floating-point unit conforming to VFPv3, with software floating-point
linkage.
softvfp+vfpv3_fp16
Selects a hardware vector floating-point unit conforming to VFPv3-fp16, with software floating-
point linkage.
softvfp+vfpv3_d16
Selects a hardware vector floating-point unit conforming to VFPv3-D16, with software floating-
point linkage.
softvfp+vfpv3_d16_fp16
Selects a hardware vector floating-point unit conforming to VFPv3-D16-fp16, with software
floating-point linkage.
softvfp+vfpv4
Selects a hardware floating-point unit conforming to FPv4, with software floating-point linkage.
softvfp+vfpv4_d16
Selects a hardware floating-point unit conforming to VFPv4-D16, with software floating-point
linkage.
softvfp+fpv4-sp
Selects a hardware floating-point unit conforming to FPv4-SP, with software floating-point
linkage.
softvfp+fpv5_d16
Selects a hardware floating-point unit conforming to FPv5-D16, with software floating-point
linkage.
softvfp+fpv5-sp
Selects a hardware floating-point unit conforming to FPv5-SP, with software floating-point
linkage.
Usage
Any FPU explicitly selected using the --fpu option always overrides any FPU implicitly selected using
the --cpu option. For example, the option --cpu=ARM1136JF-S --fpu=softvfp generates code that
uses the software floating-point library fplib, even though the choice of processor implies the use of
architecture VFPv2.
To control floating-point linkage without affecting the choice of FPU, you can use --apcs=/softfp or
--apcs=/hardfp.
Restrictions
The compiler only permits hardware VFP architectures (for example, --fpu=vfpv3,
--fpu=softvfp+vfpv2), to be specified when MRRC and MCRR instructions are supported in the processor
instruction set. MRRC and MCRR instructions are not supported in 4, 4T, 5T and 6-M. Therefore, the
compiler does not allow the use of these architectures with hardware VFP architectures.
Other than this, the compiler does not check that --cpu and --fpu combinations are valid. Beyond the
scope of the compiler, additional architectural constraints apply. For example, VFPv3 is not supported
with architectures prior to ARMv7. Therefore, the combination of --fpu and --cpu options permitted by
the compiler does not necessarily translate to the actual device in use.
The compiler only generates scalar floating-point operations. If you want to use VFP vector operations,
you must do this using assembly code.
NEON support is disabled for softvfp.
Default
The default target FPU architecture is derived from the use of the --cpu option.
If the processor specified with --cpu has a VFP coprocessor, the default target FPU architecture is the
VFP architecture for that processor. For example, the option --cpu ARM1136JF-S implies the option
--fpu vfpv2. If a VFP coprocessor is present, VFP instructions are generated.
If you are building ARM Linux applications with --arm_linux or --arm_linux_paths, the default is
always software floating-point linkage. Even if you specify a CPU that implies an FPU (for example,
--cpu=ARM1136JF-S), the compiler still defaults to --fpu=softvfp+vfp, not --fpu=vfp.
If there is no VFP coprocessor, the compiler generates code that makes calls to the software floating-
point library fplib to carry out floating-point operations.
Related concepts
5.44 Vector Floating-Point (VFP) architectures on page 5-205.
5.49 Compiler support for floating-point computations and linkage on page 5-212.
Related references
8.6 --apcs=qualifier...qualifier on page 8-322.
8.7 --arm on page 8-326.
8.43 --cpu=name on page 8-368.
8.87 --fpmode=model on page 8-415.
8.180 --thumb on page 8-518.
10.15 __softfp on page 10-616.
Related information
MRC and MRC2.
ARM and Thumb floating-point build options (ARMv6 and earlier).
ARM and Thumb floating-point build options (ARMv7 and later).
Mode
This option is effective only if the source language is C++.
Default
The default is --no_friend_injection.
Related references
9.27 friend on page 9-577.
8.91 -g
Enables the generation of debug tables.
The compiler produces the same code regardless of whether -g is used. The only difference is the
existence of debug tables.
Using -g does not affect optimization settings.
Default
By default, using the -g option alone is equivalent to:
-g --dwarf3 --debug_macros
Related references
8.47 --debug, --no_debug on page 8-374.
8.48 --debug_macros, --no_debug_macros on page 8-375.
8.68 --dwarf2 on page 8-396.
8.69 --dwarf3 on page 8-397.
8.139 -Onum on page 8-473.
8.92 --global_reg=reg_name[,reg_name,...]
Treats the specified register names as fixed registers, and prevents the compiler from generating code
that uses these registers.
Note
Try to avoid using this option, because it restricts the compiler in terms of register allocation and can
potentially give a negative effect on code generation and performance.
Syntax
--global_reg=reg_name[,reg_name,...]
Where reg_name is the AAPCS name of the register, denoted by an integer value in the range 1 to 8.
Register names 1 to 8 map sequentially onto registers r4 to r11.
If reg_name is unspecified, the compiler faults use of --global_reg.
Restrictions
This option has the same restrictions as the __global_reg storage class specifier.
Example
--global_reg=1,4,5
Related references
10.7 __global_reg on page 10-606.
8.93 --gnu
Enables the GNU compiler extensions that the ARM compiler supports.
The version of GCC the extensions are compatible with can be determined by inspecting the predefined
macros __GNUC__ and __GNUC_MINOR__.
In addition, in GNU mode, the ARM compiler emulates GCC in its conformance to the C/C++ standards,
whether more or less strict.
Usage
This option can also be combined with other source language command-line options. For example,
armcc --c90 --gnu.
Related references
8.23 --c90 on page 8-346.
8.24 --c99 on page 8-347.
8.39 --cpp on page 8-363.
8.176 --strict, --no_strict on page 8-513.
8.40 --cpp11 on page 8-364.
8.41 --cpp_compat on page 8-365.
1.2 Source language modes of the compiler on page 1-31.
2.7 Filename suffixes recognized by the compiler on page 2-49.
8.94 --gnu_defaults on page 8-425.
8.96 --gnu_version=version on page 8-427.
9.45 GNU extensions to the C and C++ languages on page 9-595.
10.161 Predefined macros on page 10-786.
8.94 --gnu_defaults
Alters the default settings of certain other options to match the default behavior found in GCC. Platform-
specific settings, such as those targeting ARM Linux, are unaffected.
Usage
--gnu_defaults does not imply specific targeting of ARM Linux.
Default
When you use --arm_linux and other ARM Linux-targeting options, --gnu_defaults is automatically
implied.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
8.3 --allow_null_this, --no_allow_null_this on page 8-319.
8.48 --debug_macros, --no_debug_macros on page 8-375.
8.93 --gnu on page 8-424.
8.99 --hide_all, --no_hide_all on page 8-430.
8.102 --implicit_include, --no_implicit_include on page 8-433.
8.172 --signed_bitfields, --unsigned_bitfields on page 8-509.
8.202 --wchar, --no_wchar on page 8-544.
Note
The --gnu_instrument option is deprecated from ARM Compiler 5.05 onwards.
Usage
After function entry and before function exit, the following profiling functions are called with the
address of the current function and its call site:
void __cyg_profile_func_enter(void *current_func, void *callsite);
Restrictions
You must provide definitions of __cyg_profile_func_enter() and __cyg_profile_func_exit().
It is necessary to explicitly mark __cyg_profile_func_enter() and __cyg_profile_func_exit()
with __attribute__((no_instrument_function)).
Related references
10.41 __attribute__((no_instrument_function)) function attribute on page 10-646.
8.96 --gnu_version=version
Attempts to make the compiler compatible with a particular version of GCC.
Syntax
--gnu_version=version
Where version is a decimal number denoting the version of GCC that you are attempting to make the
compiler compatible with.
Mode
This option is for when GNU compatibility mode is being used.
Usage
This option is for expert use. It is provided for dealing with legacy code. You are not normally required
to use it.
The maximum supported values for --gnu_version in armcc are as follows:
armcc GCC
Default
In ARM Compiler 5.06, the default is 40700. This corresponds to GCC version 4.7.0.
In ARM Compiler 4.1 through to 5.05, the default is 40200. This corresponds to GCC version 4.2.0.
Example
--gnu_version=30401 makes the compiler compatible with GCC 3.4.1 as far as possible.
Related references
8.93 --gnu on page 8-424.
8.10 --arm_linux_configure on page 8-330.
Mode
This option is effective only if the source language is C++.
Default
The default is --no_guiding_decls.
Example
template <class T> void f(T)
{
...
}
void f(int);
Related references
8.140 --old_specializations, --no_old_specializations on page 8-476.
8.6 --apcs=qualifier...qualifier on page 8-322.
8.98 --help
Displays a summary of the main command-line options.
Default
This is the default if you specify armcc without any options or source files.
Related references
8.171 --show_cmdline on page 8-508.
8.198 --vsn on page 8-540.
Usage
Use --no_hide_all to force the compiler to use STV_DEFAULT visibility for all extern variables and
functions if they do not use __declspec(dll*) or
__attribute__((visibility("visibility_type"))). This also forces them to be pre-emptible at
runtime by a dynamic loader.
When building a System V or ARM Linux shared library, use --no_hide_all together with
--apcs /fpic.
Use --hide_all to set the visibility to STV_HIDDEN, so that symbols cannot be dynamically linked.
Default
The default is --hide_all.
Related references
8.6 --apcs=qualifier...qualifier on page 8-322.
10.53 __attribute__((visibility("visibility_type"))) function attribute on page 10-658.
10.72 __attribute__((visibility("visibility_type"))) variable attribute on page 10-677.
10.23 __declspec(dllexport) on page 10-625.
10.24 __declspec(dllimport) on page 10-627.
8.94 --gnu_defaults on page 8-425.
8.196 --visibility_inlines_hidden on page 8-538.
Related information
--symver_script=filename linker option.
Symbol visibility for BPABI models.
8.100 -Idir[,dir,...]
Adds the specified directory, or comma-separated list of directories, to the list of places that are searched
to find included files.
If you specify more than one directory, the directories are searched in the same order as the -I options
specifying them.
Syntax
-Idir[,dir,...]
Where:
dir[,dir,...]
is a comma-separated list of directories to be searched for included files.
At least one directory must be specified.
When specifying multiple directories, do not include spaces between commas and directory
names in the list.
Related concepts
2.9 Factors influencing how the compiler searches for header files on page 2-52.
Related references
8.112 -Jdir[,dir,...] on page 8-443.
8.113 --kandr_include on page 8-444.
8.155 --preinclude=filename on page 8-491.
8.179 --sys_include on page 8-517.
2.10 Compiler command-line options and search paths on page 2-53.
8.101 --ignore_missing_headers
Prints dependency lines for header files even if the header files are missing.
This option only takes effect when dependency generation options (--md or -M) are specified.
Warning and error messages on missing header files are suppressed, and compilation continues.
Usage
This option is used for automatically updating makefiles. It is analogous to the GCC -MG command-line
option.
Related references
8.52 --depend=filename on page 8-379.
8.54 --depend_format=string on page 8-381.
8.56 --depend_system_headers, --no_depend_system_headers on page 8-384.
8.57 --depend_target=target on page 8-385.
8.128 -M on page 8-461.
8.129 --md on page 8-462.
8.153 --phony_targets on page 8-489.
Mode
This option is effective only if the source language is C++.
Default
The default is --implicit_include.
Related references
8.103 --implicit_include_searches, --no_implicit_include_searches on page 8-434.
8.94 --gnu_defaults on page 8-425.
11.9 Template instantiation in ARM C++ on page 11-809.
Mode
This option is effective only if the source language is C++.
Default
The default is --no_implicit_include_searches.
Related references
8.100 -Idir[,dir,...] on page 8-431.
8.102 --implicit_include, --no_implicit_include on page 8-433.
8.112 -Jdir[,dir,...] on page 8-443.
11.9 Template instantiation in ARM C++ on page 11-809.
2.10 Compiler command-line options and search paths on page 2-53.
Related information
Toolchain environment variables.
Default
The default is --implicit_key_function.
Related references
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.162 --remarks on page 8-498.
Note
The option --implicit_typename is provided only as a migration aid for legacy source code that does
not conform to the C++ standard. ARM does not recommend its use.
Mode
This option is effective only if the source language is C++.
Default
The default is --no_implicit_typename.
Note
The --implicit_typename option has no effect unless you also specify --no_parse_templates.
Related references
8.51 --dep_name, --no_dep_name on page 8-378.
8.147 --parse_templates, --no_parse_templates on page 8-483.
11.9 Template instantiation in ARM C++ on page 11-809.
8.106 --import_all_vtbl
Causes external references to class impedimenta variables (vtables, RTTI, for example) to be marked as
having dynamic linkage.
The --import_all_vtbl option does not cause definitions of class impedimenta to have dynamic
linkage.
Related references
8.79 --export_all_vtbl, --no_export_all_vtbl on page 8-407.
8.107 --info=totals
Reports total sizes of the object code and data for each object file.
The compiler returns the same totals that fromelf returns when fromelf --text -z is used, in a similar
format. The totals include embedded assembly code sizes when embedded assembly exists in the source
code.
Example
Code (inc. data) RO Data RW Data ZI Data Debug File Name
3308 1556 0 44 10200 8402 dhry_1.o
Code (inc. data) RO Data RW Data ZI Data Debug File Name
416 28 0 0 0 7722 dhry_2.o
The (inc. data) column gives the size of constants, string literals, and other data items used as part of
the code. The Code column, shown in the example, includes this value.
Related concepts
5.9 Code metrics on page 5-165.
Related references
8.118 --list on page 8-450.
Related information
--info=topic[,topic,...] fromelf option.
--text fromelf option.
--info=topic[,topic,...] linker option.
Default
The default is --inline.
Related references
8.15 --autoinline, --no_autoinline on page 8-337.
8.139 -Onum on page 8-473.
8.143 -Ospace on page 8-479.
8.144 -Otime on page 8-480.
10.6 __forceinline on page 10-605.
10.8 __inline on page 10-608.
2.15 Linker feedback during compilation on page 2-59.
8.85 --forceinline on page 8-413.
10.8 __inline on page 10-608.
10.6 __forceinline on page 10-605.
10.32 __attribute__((always_inline)) function attribute on page 10-637.
$a
.text
f
0x00000000: e59f0000 .... LDR r0,[pc,#0] ; [0x8] = 0xdeadbeef
0x00000004: e12fff1e ../. BX lr
$d
0x00000008: deadbeef .... DCD 3735928559
The --no_integer_literal_pools option instructs the compiler to use sequences of MOVW and MOVT
instructions to construct these constants:
** Section #1 '.text' (SHT_PROGBITS) [SHF_ALLOC + SHF_EXECINSTR]
Size : 12 bytes (alignment 4)
Address: 0x00000000
$a
.text
f
0x00000000: e30b0eef .... MOV r0,#0xbeef
0x00000004: e34d0ead ..M. MOVT r0,#0xdead
0x00000008: e12fff1e ../. BX lr
64-bit integers are constructed with two MOVW instructions and two MOVT instructions.
Note
You cannot use the --no_integer_literal_pools option with target architectures earlier than v6T2.
Default
The default is --integer_literal_pools.
--execute_only implies --no_integer_literal_pools, unless --integer_literal_pools is
explicitly specified.
Note
Do not use --execute_only in conjunction with --integer_literal_pools. If you do, then the
compiler places the literal pool in an unreadable, execute-only code region.
Related concepts
4.21 Compiler support for literal pools on page 4-131.
Related references
8.178 --string_literal_pools, --no_string_literal_pools on page 8-515.
8.18 --branch_tables, --no_branch_tables on page 8-340.
8.83 --float_literal_pools, --no_float_literal_pools on page 8-411.
8.78 --execute_only on page 8-406.
8.110 --interface_enums_are_32_bit
Helps to provide compatibility between external code interfaces, with regard to the size of enumerated
types.
Usage
It is not possible to link an object file compiled with --enum_is_int, with another object file that is
compiled without --enum_is_int. The linker is unable to determine whether or not the enumerated
types are used in a way that affects the external interfaces, so on detecting these build differences, it
produces a warning or an error. You can avoid this by compiling with --interface_enums_are_32_bit.
The resulting object file can then be linked with any other object file, without the linker-detected conflict
that arises from different enumeration type sizes.
Note
When you use this option, you are making a promise to the compiler that all the enumerated types used
in your external interfaces are 32 bits wide. For example, if you ensure that every enum you declare
includes at least one value larger than 2 to the power of 16, the compiler is forced to make the enum 32
bits wide, whether or not you use --enum_is_int. It is up to you to ensure that the promise you are
making to the compiler is true. (Another method of satisfying this condition is to ensure that you have no
enums in your external interface.)
Default
By default, the smallest data type that can hold the values of all enumerators is used.
Related references
8.73 --enum_is_int on page 8-401.
8.111 --interleave
Interleaves C or C++ source code line by line as comments within the assembly listing.
Usage
Use the --interleave option with the --asm option or -S option.
The action of --interleave depends on the combination of options used:
--asm Writes a listing to a file of the disassembly of the compiled source, interleaving the source code with the
--interleave disassembly.
The link step is also performed, unless the -c option is used.
The disassembly is written to a text file whose name defaults to the name of the input file with the filename
extension .txt
-S --interleave Writes a listing to a file of the disassembly of the compiled source, interleaving the source code with the
disassembly.
The disassembly is written to a text file whose name defaults to the name of the input file with the filename
extension .txt
Restrictions
• You cannot re-assemble an assembly listing generated with --asm --interleave or
-S --interleave.
• Preprocessed source files contain #line directives. When compiling preprocessed files using
--asm --interleave or -S --interleave, the compiler searches for the original files indicated by
any #line directives, and uses the correct lines from those files. This ensures that compiling a
preprocessed file gives exactly the same output and behavior as if the original files were compiled.
If the compiler cannot find the original files, it is unable to interleave the source. Therefore, if you
have preprocessed source files with #line directives, but the original unpreprocessed files are not
present, you must remove all the #line directives before you compile with --interleave.
Related references
8.13 --asm on page 8-335.
8.168 -S on page 8-504.
8.112 -Jdir[,dir,...]
Adds the specified directory, or comma-separated list of directories, to the list of system includes.
Downgradable errors, warnings, and remarks are suppressed, even if --diag_error is used.
Angle-bracketed include files are searched for first in the list of system includes, followed by any include
list specified with the option -I.
Note
On Windows systems, you must enclose ARMCC5INC in double quotes if you specify this environment
variable on the command line, because the default path defined by the variable contains spaces. For
example:
armcc -J"%ARMCC5INC%" -c main.c
Syntax
-Jdir[,dir,...]
Where:
dir[,dir,...]
is a comma-separated list of directories to be added to the list of system includes.
At least one directory must be specified.
When specifying multiple directories, do not include spaces between commas and directory
names in the list.
Related concepts
2.9 Factors influencing how the compiler searches for header files on page 2-52.
Related references
8.100 -Idir[,dir,...] on page 8-431.
8.113 --kandr_include on page 8-444.
8.155 --preinclude=filename on page 8-491.
8.179 --sys_include on page 8-517.
2.10 Compiler command-line options and search paths on page 2-53.
Related information
Toolchain environment variables.
8.113 --kandr_include
Ensures that Kernighan and Ritchie search rules are used for locating included files.
The current place is defined by the original source file and is not stacked.
Default
If you do not specify --kandr_include, Berkeley-style searching applies.
Related concepts
2.9 Factors influencing how the compiler searches for header files on page 2-52.
Related references
8.112 -Jdir[,dir,...] on page 8-443.
8.100 -Idir[,dir,...] on page 8-431.
8.155 --preinclude=filename on page 8-491.
8.179 --sys_include on page 8-517.
2.10 Compiler command-line options and search paths on page 2-53.
8.114 -Lopt
Specifies command-line options to pass to the linker when a link step is being performed after
compilation.
Options can be passed when creating a partially-linked object or an executable image.
Syntax
-Lopt
Where:
opt
is a command-line option to pass to the linker.
Restrictions
If an unsupported linker option is passed to it using -L, an error is generated by the linker.
Example
armcc main.c -L--map
Related references
8.1 -Aopt on page 8-317.
8.171 --show_cmdline on page 8-508.
8.115 --library_interface=lib
Generates code that is compatible with the selected library type.
Syntax
--library_interface=lib
rvct40_c90
Behaves similarly to rvct40. In addition, specifies that the compiler output is compatible with
any ISO C90 library.
Default
If you do not specify --library_interface, the compiler assumes --library_interface=armcc.
Usage
• Use the option --library_interface=armcc to exploit the full range of compiler and library
optimizations when linking.
• Use an option of the form --library_interface=aeabi_* when linking with an ABI-compliant C
library. Options of the form --library_interface=aeabi_* ensure that the compiler does not
generate calls to any optimized functions provided by the ARM C library.
Note
_hardfp options are not supported by ARM C libraries.
Example
If your code calls functions, provided by an embedded operating system, that replace functions provided
by the ARM C library, then compile your code with the option --library_interface=aeabi_clib.
This option disables calls to any special ARM variants of the library functions replaced by the operating
system.
Related information
Compliance with the Application Binary Interface (ABI) for the ARM architecture.
8.116 --library_type=lib
Enables the selected library to be used at link time.
Note
This option can be overridden at link time by providing it to the linker.
Syntax
--library_type=lib
Default
If you do not specify --library_type, the compiler assumes --library_type=standardlib.
Related information
About microlib.
Building an application with microlib.
--library_type=lib linker option.
Default
The default is --no_link_all_input.
Related references
8.29 --compile_all_input, --no_compile_all_input on page 8-353.
2.7 Filename suffixes recognized by the compiler on page 2-49.
8.118 --list
Generates raw listing information for a source file.
The name of the raw listing file defaults to the name of the input file with the filename extension .lst.
If you specify multiple source files on the command line, the compiler generates listings for all of the
source files, writing each to a separate listing file whose name is generated from the corresponding
source file name. However, when --multifile is used, a concatenated listing is written to a single
listing file, whose name is generated from the first source file name.
Usage
Typically, you use raw listing information to generate a formatted listing. The raw listing file contains
raw source lines, information on transitions into and out of include files, and diagnostics generated by the
compiler. Each line of the listing file begins with any of the following key characters that identifies the
type of line:
N
A normal line of source. The rest of the line is the text of the line of source.
X
The expanded form of a normal line of source. The rest of the line is the text of the line. This
line appears following the N line, and only if the line contains nontrivial modifications.
Comments are considered trivial modifications, and macro expansions, line splices, and
trigraphs are considered nontrivial modifications. Comments are replaced by a single space in
the expanded-form line.
S
A line of source skipped by an #if or similar. The rest of the line is text.
Note
The #else, #elseif, or #endif that ends a skip is marked with an N.
L
Indicates a change in source position. That is, the line has a format similar to the # line-
identifying directive output by the preprocessor:
L line-number "filename" key
When a diagnostic message displays a list, for example, all the contending routines when there
is ambiguity on an overloaded call, the initial diagnostic line is followed by one or more lines
with the same overall format. However, the code letter is the lowercase version of the code letter
in the initial line. The source position in these lines is the same as that in the corresponding
initial line.
Example
/* main.c */
#include <stdbool.h>
int main(void)
{
return(true);
}
Compiling this code with the option --list produces the raw listing file:
L 1 "main.c"
N#include <stdbool.h>
L 1 "...\include\...\stdbool.h" 1
N/* stdbool.h */
N
...
N #ifndef __cplusplus /* In C++, 'bool', 'true' and 'false' and keywords */
N #define bool _Bool
N #define true 1
N #define false 0
N #endif
...
L 2 "main.c" 2
N
Nint main(void)
N{
N return(true);
X return(1);
N}
Related references
8.13 --asm on page 8-335.
8.21 -c on page 8-344.
8.52 --depend=filename on page 8-379.
8.54 --depend_format=string on page 8-381.
8.107 --info=totals on page 8-438.
8.111 --interleave on page 8-442.
8.119 --list_dir=directory_name on page 8-452.
8.129 --md on page 8-462.
8.168 -S on page 8-504.
6.1 Severity of compiler diagnostic messages on page 6-254.
8.119 --list_dir=directory_name
Specifies a directory for --list output.
Example
armcc -c --list_dir=lst --list f1.c f2.c
Result:
lst/f1.lst
lst/f2.lst
Related references
8.14 --asm_dir=directory_name on page 8-336.
8.53 --depend_dir=directory_name on page 8-380.
8.118 --list on page 8-450.
8.145 --output_dir=directory_name on page 8-481.
8.120 --list_macros
Lists macro definitions to stdout after processing a specified source file.
The listed output contains macro definitions that are used on the command line, predefined by the
compiler, and found in header and source files, depending on usage.
Usage
To list macros that are defined on the command line, predefined by the compiler, and found in header and
source files, use --list_macros with a non-empty source file.
To list only macros predefined by the compiler and specified on the command line, use --list_macros
with an empty source file.
Restrictions
Code generation is suppressed.
Related references
10.161 Predefined macros on page 10-786.
8.45 -Dname[(parm-list)][=def] on page 8-372.
8.70 -E on page 8-398.
8.171 --show_cmdline on page 8-508.
8.195 --via=filename on page 8-537.
8.121 --littleend
Generates code suitable for an ARM processor using little-endian memory.
With little-endian memory, the least significant byte of a word has the lowest address.
Default
The compiler assumes --littleend unless --bigend is explicitly specified.
Related references
8.16 --bigend on page 8-338.
8.122 --locale=lang_country
Specifies the locale for source files.
Syntax
--locale=lang_country
Where:
lang_country
is the new default locale.
Use this option in combination with --multibyte_chars.
Default
If you do not specify this option, the system locale is used.
Restrictions
The locale name might be case-sensitive, depending on the host platform.
The permitted settings of locale are determined by the host platform.
Ensure that you have installed the appropriate locale support for the host platform.
Note
If the source file encoding is UTF-8 or UTF-16, and the file starts with a byte order mark then the
compiler ignores the --locale and --[no_]multibyte_chars options and interprets the file as UTF-8
or UTF-16.
Example
To compile Japanese source files on an English-based Windows workstation, use:
--multibyte_chars --locale=japanese
Related references
8.130 --message_locale=lang_country[.codepage] on page 8-463.
8.133 --multibyte_chars, --no_multibyte_chars on page 8-466.
8.123 --long_long
Permits use of the long long data type in strict mode.
Example
To successfully compile the following code in strict mode, you must use --strict --long_long.
long long f(long long x, long long y)
{
return x*y;
}
Related references
8.176 --strict, --no_strict on page 8-513.
8.124 --loop_optimization_level=opt
Trades code size for performance by controlling how much loop optimization the compiler performs.
The compiler can use several different techniques for specifically targeting loop optimizations, such as
loop unrolling and inlining. However, these techniques can impact code size.
Syntax
--loop_optimization_level=opt
Restrictions
Non-zero values (1 or 2) can be used when either the -O3 -Otime or -O2 -Otime --vectorize options
are given. For example:
armcc -O3 -Otime --loop_optimization_level=2 ...
Default
The default is 1 for -O3 -Otime and -O2 -Otime --vectorize, otherwise it is 0.
Related concepts
5.20 Inline functions on page 5-177.
5.7 Loop unrolling in C code on page 5-161.
Related references
8.139 -Onum on page 8-473.
8.144 -Otime on page 8-480.
8.125 --loose_implicit_cast
Makes illegal implicit casts legal, such as implicit casts of a nonzero integer to a pointer.
Example
int *p = 0x8000;
Default
The default is --no_lower_ropi.
Note
If you compile with --lower_ropi, then the static initialization is done at runtime by the C++
constructor mechanism for both C and C++ code. This enables these static initializations to work with
ROPI code.
Related concepts
2.13 Code compatibility between separately compiled and assembled modules on page 2-56.
Related references
8.127 --lower_rwpi, --no_lower_rwpi on page 8-460.
8.6 --apcs=qualifier...qualifier on page 8-322.
Default
The default is --lower_rwpi.
Note
If you compile with --lower_rwpi, then the static initialization is done at runtime by the C++
constructor mechanism, even for C. This enables these static initializations to work with RWPI code.
Related concepts
2.13 Code compatibility between separately compiled and assembled modules on page 2-56.
Related references
8.126 --lower_ropi, --no_lower_ropi on page 8-459.
8.6 --apcs=qualifier...qualifier on page 8-322.
8.128 -M
Produces a list of makefile dependency lines suitable for use by a make utility.
The compiler executes only the preprocessor step of the compilation. By default, output is on the
standard output stream.
If you specify multiple source files, a single dependency file is created.
If you specify the -o filename option, the dependency lines generated on standard output make
reference to filename.o, and not to source.o. However, no object file is produced with the combination
of -M -o filename.
Use the --md option to generate dependency lines and object files for each source file.
Example
You can redirect output to a file by using standard UNIX and MS-DOS notation, for example:
armcc -M source.c > Makefile
Related references
8.22 -C on page 8-345.
8.52 --depend=filename on page 8-379.
8.56 --depend_system_headers, --no_depend_system_headers on page 8-384.
8.70 -E on page 8-398.
8.129 --md on page 8-462.
8.55 --depend_single_line, --no_depend_single_line on page 8-383.
8.138 -o filename on page 8-471.
8.129 --md
Creates makefile dependency lists.
Make utilities use makefile dependency lists to determine dependencies between files, for example to
determine header file dependencies.
The compiler names the makefile dependency list filename.d, where filename is the name of the
source file. If you specify multiple source files, a dependency file is created for each source file.
If you want to produce makefile dependencies and preprocessor source file output in a single step, you
can do so using the combination --md -E (or --md -P to suppress line number generation).
Related references
8.52 --depend=filename on page 8-379.
8.54 --depend_format=string on page 8-381.
8.56 --depend_system_headers, --no_depend_system_headers on page 8-384.
8.70 -E on page 8-398.
8.128 -M on page 8-461.
8.55 --depend_single_line, --no_depend_single_line on page 8-383.
8.138 -o filename on page 8-471.
8.130 --message_locale=lang_country[.codepage]
Specifies the language for error and warning messages.
Syntax
--message_locale=lang_country[.codepage]
Where:
lang_country[.codepage]
is the new default language for the display of error and warning messages.
The permitted languages are independent of the host platform.
The following settings are supported:
• en_US.
• ja_JP.
Default
If you do not specify --message_locale, the compiler assumes --message_locale=en_US.
Restrictions
Ensure that you have installed the appropriate locale support for the host platform.
The locale name might be case-sensitive, depending on the host platform.
The ability to specify a codepage, and its meaning, depends on the host platform.
Errors
If you specify a setting that is not supported, the compiler generates an error message.
Example
To display messages in Japanese, use:
--message_locale=ja_JP
Related references
8.122 --locale=lang_country on page 8-455.
8.133 --multibyte_chars, --no_multibyte_chars on page 8-466.
8.131 --min_array_alignment=opt
Specifies the minimum alignment of arrays.
Syntax
--min_array_alignment=opt
Where:
opt
specifies the minimum alignment of arrays. The value of opt is one of:
1
byte alignment, or unaligned
2
two-byte, halfword alignment
4
four-byte, word alignment
8
eight-byte, doubleword alignment.
Usage
ARM does not recommend using this option, unless required in certain specialized cases. For example,
porting code to systems that have different data alignment requirements. Use of this option can result in
increased code size at the higher opt values, and reduced performance at the lower opt values. If you
only want to affect the alignment of specific arrays (rather than all arrays), use the __align keyword
instead.
Default
If you do not use this option, arrays are unaligned (byte aligned).
Example
Compiling the following code with --min_array_alignment=8 gives the alignment described in the
comments:
char arr_c1[1]; // alignment == 8
char c1; // alignment == 1
Related references
10.2 __align on page 10-601.
10.3 __ALIGNOF__ on page 10-602.
8.132 --mm
This option has the same effect as -M --no_depend_system_headers.
Related references
8.128 -M on page 8-461.
8.56 --depend_system_headers, --no_depend_system_headers on page 8-384.
Default
--multibyte_chars is the default, but the option only has an effect in locales that use multibyte
characters.
Usage
Multibyte encodings are used for character sets such as the Japanese Shift-Japanese Industrial Standard
(Shift-JIS).
Note
If the source file encoding is UTF-8 or UTF-16, and the file starts with a byte order mark then the
compiler ignores the --locale and --[no_]multibyte_chars options and interprets the file as UTF-8
or UTF-16.
Related references
8.122 --locale=lang_country on page 8-455.
8.130 --message_locale=lang_country[.codepage] on page 8-463.
Default
The default is --no_multifile.
Usage
When --multifile is selected, the compiler might be able to perform additional optimizations by
compiling across several source files.
There is no limit to the number of source files that can be specified on the command line. However,
depending on the number of source files and structure of the program, the compiler might require
significantly more memory and significantly more compilation time. For the best optimization results,
choose small groups of functionally related source files.
As a guideline, you can expect --multifile to scale well up to modules in the low hundreds of
thousands of lines of code.
Example
armcc -c --multifile test1.c ... testn.c -o test.o
Related references
8.21 -c on page 8-344.
8.50 --default_extension=ext on page 8-377.
8.138 -o filename on page 8-471.
8.139 -Onum on page 8-473.
8.205 --whole_program on page 8-547.
10.161 Predefined macros on page 10-786.
8.135 --multiply_latency=cycles
Tells the compiler the number of cycles used by the hardware multiplier.
Syntax
--multiply_latency=cycles
Usage
Use this option to tell the compiler how many cycles the MUL instruction takes to use the multiplier
block and related parts of the chip. Until finished, these parts of the chip cannot be used for another
instruction and the result of the MUL is not available for any later instructions to use.
It is possible that a processor might have two or more multiplier options that are set for a given hardware
implementation. For example, one implementation might be configured to take one cycle to execute. The
other implementation might take 33 cycles to execute. This option lets you convey the correct number of
cycles for a given processor.
Default
The default number of cycles used by the hardware multiplier is processor-specific. See the Technical
Reference Manual for the processor architecture you are compiling for.
Example
--multiply_latency=33
Related information
MUL.
8.136 --narrow_volatile_bitfields
Accesses volatile bitfields using the smallest access size that contains the entire bitfield.
The AEABI specifies that volatile bitfields are accessed as the size of their container type. However,
some versions of GCC instead use the smallest access size that contains the entire bitfield.
--narrow_volatile_bitfields emulates this non-AEABI compliant behavior.
Related information
Application Binary Interface (ABI) for the ARM Architecture.
Mode
This option is effective only if the source language is C++.
Default
The default is --no_nonstd_qualifier_deduction.
8.138 -o filename
Specifies the name of the output file.
The full name of the output file produced depends on the combination of options used, as described in
the following tables.
Syntax
If you specify a -o option, the compiler names the output file according to the conventions described by
the following table.
Note
This option overrides the --default_extension option.
Default
If you do not specify a -o option, the compiler names the output file according to the conventions
described by the following table.
-c produces an object file whose name defaults to the name of the input file -
with the filename extension .o
-S produces an output file whose name defaults to the name of the input file -
with the filename extension .s
(No option) produces an executable image with the default name of __image.axf none of -o, -c, -E or -S is specified
on the command line
Related references
8.13 --asm on page 8-335.
8.21 -c on page 8-344.
8.50 --default_extension=ext on page 8-377.
8.52 --depend=filename on page 8-379.
8.54 --depend_format=string on page 8-381.
8.70 -E on page 8-398.
8.111 --interleave on page 8-442.
8.118 --list on page 8-450.
8.139 -Onum
Specifies the level of optimization to be used when compiling source files.
Syntax
-Onum
Note
Although the debug view produced by -O0 corresponds most closely to the source code, users
might prefer the debug view produced by -O1 because this improves the quality of the code
without changing the fundamental structure.
Note
Dead code includes reachable code that has no effect on the result of the program, for example
an assignment to a local variable that is never used. Unreachable code is specifically code that
cannot be reached via any control flow path, for example code that immediately follows a return
statement.
1
Restricted optimization. The compiler only performs optimizations that can be described by
debug information. Removes unused inline functions and unused static functions. Turns off
optimizations that seriously degrade the debug view. If used with --debug, this option gives a
generally satisfactory debug view with good code density.
The differences in the debug view from –O0 are:
• Breakpoints cannot be set on dead code.
• Values of variables might not be available within their scope after they have been initialized.
For example if their assigned location has been reused.
• Functions with no side-effects might be called out of sequence, or might be omitted if the
result is not needed.
• Backtrace might not give the stack of open function activations that is expected from reading
the source because of the presence of tailcalls.
The optimization level –O1 produces good correspondence between source code and object
code, especially when the source code contains no dead code. The generated code can be
significantly smaller than the code at –O0, which can simplify analysis of the object code.
2
High optimization. If used with --debug, the debug view might be less satisfactory because the
mapping of object code to source code is not always clear. The compiler might perform
optimizations that cannot be described by debug information.
This is the default optimization level.
The differences in the debug view from –O1 are:
• The source code to object code mapping might be many to one, because of the possibility of
multiple source code locations mapping to one point of the file, and more aggressive
instruction scheduling.
• Instruction scheduling is allowed to cross sequence points. This can lead to mismatches
between the reported value of a variable at a particular point, and the value you might expect
from reading the source code.
• The compiler automatically inlines functions.
3
Maximum optimization. When debugging is enabled, this option typically gives a poor debug
view. ARM recommends debugging at lower optimization levels.
If you use -O3 and -Otime together, the compiler performs extra optimizations that are more
aggressive, such as:
• High-level scalar optimizations, including loop unrolling. This can give significant
performance benefits at a small code size cost, but at the risk of a longer build time.
• More aggressive inlining and automatic inlining.
These optimizations effectively rewrite the input source code, resulting in object code with the
lowest correspondence to source code and the worst debug view. The
--loop_optimization_level=option controls the amount of loop optimization performed at
–O3 –Otime. The higher the amount of loop optimization the worse the correspondence between
source and object code.
Use of the --vectorize option also lowers the correspondence between source and object code.
For extra information about the high level transformations performed on the source code at
–O3 –Otime use the --remarks command-line option.
Note
The performance of floating-point code can be influenced by selecting an appropriate numerical model
using the --fpmode option.
Note
Do not rely on the implementation details of these optimizations, because they might change in future
releases.
Note
By default, the compiler optimizes to reduce image size at the expense of a possible increase in execution
time. That is, -Ospace is the default, rather than -Otime. Note that -Ospace is not affected by the
optimization level -Onum. That is, -O3 -Ospace enables more optimizations than -O2 -Ospace, but does
not perform more aggressive size reduction.
Default
If you do not specify -Onum, the compiler assumes -O2.
Related concepts
5.1 The compiler as an optimizing compiler on page 5-152.
5.3 Compiler optimization levels and the debug view on page 5-154.
Related references
8.15 --autoinline, --no_autoinline on page 8-337.
8.47 --debug, --no_debug on page 8-374.
8.85 --forceinline on page 8-413.
8.87 --fpmode=model on page 8-415.
8.108 --inline, --no_inline on page 8-439.
8.134 --multifile, --no_multifile on page 8-467.
8.143 -Ospace on page 8-479.
8.144 -Otime on page 8-480.
8.124 --loop_optimization_level=opt on page 8-457.
Mode
This option is effective only if the source language is C++.
Default
The default is --no_old_specializations.
8.141 --old_style_preprocessing
Performs preprocessing in the style of legacy compilers that do not follow the ISO C Standard.
Related references
8.70 -E on page 8-398.
Default
The default is --ool_section_name.
Related references
10.79 #pragma arm section [section_type_list] on page 10-684.
8.143 -Ospace
Performs optimizations to reduce image size at the expense of a possible increase in execution time.
Use this option if code size is more critical than performance. For example, when the -Ospace option is
selected, large structure copies are done by out-of-line function calls instead of inline code.
If required, you can compile the time-critical parts of your code with -Otime, and the rest with -Ospace.
Default
If you do not specify either -Ospace or -Otime, the compiler assumes -Ospace.
Related references
10.93 #pragma Onum on page 10-699.
10.96 #pragma Otime on page 10-702.
10.95 #pragma Ospace on page 10-701.
8.139 -Onum on page 8-473.
8.144 -Otime on page 8-480.
8.144 -Otime
Performs optimizations to reduce execution time at the expense of a possible increase in image size.
Use this option if execution time is more critical than code size. If required, you can compile the time-
critical parts of your code with -Otime, and the rest with -Ospace.
Default
If you do not specify -Otime, the compiler assumes -Ospace.
Example
When the -Otime option is selected, the compiler compiles:
while (expression) body;
as:
if (expression)
{
do body;
while (expression);
}
Related references
8.134 --multifile, --no_multifile on page 8-467.
8.139 -Onum on page 8-473.
8.143 -Ospace on page 8-479.
10.93 #pragma Onum on page 10-699.
10.95 #pragma Ospace on page 10-701.
10.96 #pragma Otime on page 10-702.
8.145 --output_dir=directory_name
Specifies an output directory for object files and depending on the other options you use, certain other
types of compiler output.
The directory for assembler output can be specified using --asm_dir. The directory for dependency
output can be specified using --depend_dir. The directory for --list output can be specified using
--list_dir. If these options are not used, the corresponding output is placed in the directory specified
by --output_dir, or if --output_dir is not specified, in the default location (for example, the current
directory).
The executable is placed in the default location.
Example
armcc -c --output_dir=obj f1.c f2.c
Result:
obj/f1.o
obj/f2.o
Related references
8.14 --asm_dir=directory_name on page 8-336.
8.53 --depend_dir=directory_name on page 8-380.
8.119 --list_dir=directory_name on page 8-452.
8.146 -P
Preprocesses source code without compiling, but does not generate line markers in the preprocessed
output.
Usage
This option can be of use when the preprocessed output is destined to be parsed by a separate script or
utility.
Related references
8.70 -E on page 8-398.
Note
The option --no_parse_templates is provided only as a migration aid for legacy source code that does
not conform to the C++ standard. ARM does not recommend its use.
Mode
This option is effective only if the source language is C++.
Default
The default is --parse_templates.
Note
--no_parse_templates cannot be used with --dep_name, because parsing is done by default if
dependent name processing is enabled. Combining these options generates an error.
Related references
8.51 --dep_name, --no_dep_name on page 8-378.
11.9 Template instantiation in ARM C++ on page 11-809.
8.148 --pch
Uses a PCH file if it exists, creates a PCH file otherwise.
Note
This option is deprecated.
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
When the option --pch is specified, the compiler searches for a PCH file with the name filename.pch,
where filename.* is the name of the primary source file. The compiler uses the PCH file filename.pch
if it exists, and creates a PCH file named filename.pch in the same directory as the primary source file
otherwise.
Restrictions
This option has no effect if you include either the option --use_pch=filename or the option
--create_pch=filename on the same command line.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
Related references
8.149 --pch_dir=dir on page 8-485.
8.150 --pch_messages, --no_pch_messages on page 8-486.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
8.44 --create_pch=filename on page 8-371.
8.190 --use_pch=filename on page 8-532.
10.87 #pragma hdrstop on page 10-693.
10.92 #pragma no_pch on page 10-698.
8.149 --pch_dir=dir
Specifies the directory where PCH files are stored.
Note
This option is deprecated.
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
Syntax
--pch_dir=dir
Where:
dir
is the name of the directory where PCH files are stored.
If dir is unspecified, the compiler faults use of --pch_dir.
Errors
If the specified directory dir does not exist, the compiler generates an error.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.25 Automatic Precompiled Header (PCH) file processing on page 4-136.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
Related references
8.44 --create_pch=filename on page 8-371.
8.148 --pch on page 8-484.
8.150 --pch_messages, --no_pch_messages on page 8-486.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
8.190 --use_pch=filename on page 8-532.
10.87 #pragma hdrstop on page 10-693.
10.92 #pragma no_pch on page 10-698.
Note
This option is deprecated.
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
Default
The default is --pch_messages.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
Related references
8.44 --create_pch=filename on page 8-371.
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
8.190 --use_pch=filename on page 8-532.
10.87 #pragma hdrstop on page 10-693.
10.92 #pragma no_pch on page 10-698.
Note
This option is deprecated.
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
In automatic PCH mode, this option ensures that for each PCH file that cannot be used for the current
compilation, a message is displayed giving the reason why the file cannot be used.
Default
The default is --no_pch_verbose.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.33 Message output during Precompiled Header (PCH) processing on page 4-146.
Related references
8.44 --create_pch=filename on page 8-371.
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
8.150 --pch_messages, --no_pch_messages on page 8-486.
8.190 --use_pch=filename on page 8-532.
10.87 #pragma hdrstop on page 10-693.
10.92 #pragma no_pch on page 10-698.
8.152 --pending_instantiations=n
Specifies the maximum number of concurrent instantiations of a template in C++.
Syntax
--pending_instantiations=n
Where:
n
is the maximum number of concurrent instantiations permitted.
If n is zero, there is no limit.
Mode
This option is effective only if the source language is C++.
Default
If you do not specify a --pending_instantiations option, then the compiler assumes
--pending_instantiations=64.
Usage
Use this option to detect runaway recursive instantiations.
8.153 --phony_targets
Emits dummy makefile rules. These rules work around make errors that are generated if you remove
header files without a corresponding update to the makefile.
This option is analogous to the GCC command-line option, -MP.
Example
Example output:
source.o: source.c
source.o: header.h
header.h:
Related references
8.52 --depend=filename on page 8-379.
8.54 --depend_format=string on page 8-381.
8.56 --depend_system_headers, --no_depend_system_headers on page 8-384.
8.57 --depend_target=target on page 8-385.
8.101 --ignore_missing_headers on page 8-432.
8.128 -M on page 8-461.
8.129 --md on page 8-462.
8.154 --pointer_alignment=num
Specifies unaligned pointer support required for an application.
Syntax
--pointer_alignment=num
Usage
This option can help you port source code that has been written for architectures without alignment
requirements. You can achieve finer control of access to unaligned data, with less impact on the quality
of generated code, using the __packed qualifier.
Restrictions
De-aligning pointers might increase the code size, even on processors with unaligned access support.
This is because only a subset of the load and store instructions benefit from unaligned access support.
The compiler is unable to use multiple-word transfers or coprocessor-memory transfers, including
hardware floating-point loads and stores, directly on unaligned memory objects.
Note
• Code size might increase significantly when compiling for processors without hardware support for
unaligned access, for example, pre-v6 architectures.
• This option does not affect the placement of objects in memory, nor the layout and padding of
structures.
Related references
10.12 __packed on page 10-612.
10.97 #pragma pack(n) on page 10-703.
5.32 Compiler storage of data objects by natural byte alignment on page 5-190.
8.155 --preinclude=filename
Includes the source code of the specified file at the beginning of the compilation.
Syntax
--preinclude=filename
Where:
filename
is the name of the file whose source code is to be included.
If filename is unspecified, the compiler faults use of --preinclude.
Usage
Use this option to establish standard macro definitions. The filename is searched for in the directories
on the include search list.
It is possible to repeatedly specify this option on the command line. This results in pre-including the files
in the order specified.
Restrictions
Sub-directories of directories specified on the include search list are not searched unless you use
--arm_linux. If you use --arm_linux, the compiler includes the arm_linux subdirectory in its search
for pre-include files.
Example
armcc --preinclude file1.h --preinclude file2.h -c source.c
Related concepts
2.9 Factors influencing how the compiler searches for header files on page 2-52.
Related references
8.112 -Jdir[,dir,...] on page 8-443.
8.100 -Idir[,dir,...] on page 8-431.
8.113 --kandr_include on page 8-444.
8.179 --sys_include on page 8-517.
2.10 Compiler command-line options and search paths on page 2-53.
8.156 --preprocess_assembly
Relaxes certain rules when producing preprocessed compiler output, to provide greater flexibility when
preprocessing assembly language source code.
Usage
Use this option to relax certain preprocessor rules when generating preprocessed output from assembly
language source files. Specifically, the following special cases are permitted that would normally
produce a compiler error:
• Lines beginning with a '#' character followed by a space and a number, that would normally indicate a
GNU non-standard line marker, are ignored and copied verbatim into the preprocessed output.
• Unrecognized preprocessing directives are ignored and copied verbatim into the preprocessed output.
• Where the token-paste '#' operator is used in a function-like macro, if it is used with a name that is
not a macro parameter, the name is copied verbatim into the preprocessed output together with the
preceding '#' character.
For example if the source file contains:
# define mymacro(arg) foo #bar arg
mymacro(x)
Restrictions
This option is only valid when producing preprocessed output without continuing compilation, for
example when using the -E, -P or -C command line options. It is ignored in other cases.
Related references
8.146 -P on page 8-482.
8.22 -C on page 8-345.
8.70 -E on page 8-398.
8.157 --preprocessed
Forces the preprocessor to handle files with .i filename extensions as if macros have already been
substituted.
Usage
This option gives you the opportunity to use a different preprocessor. Generate your preprocessed code
and then give the preprocessed code to the compiler in the form of a filename.i file, using --
preprocessed to inform the compiler that the file has already been preprocessed.
Restrictions
This option only applies to macros. Trigraphs, line concatenation, comments and all other preprocessor
items are preprocessed by the preprocessor in the normal way.
If you use --compile_all_input, the .i file is treated as a .c file. The preprocessor behaves as if no
prior preprocessing has occurred.
Example
armcc --preprocessed foo.i -c -o foo.o
Related references
8.29 --compile_all_input, --no_compile_all_input on page 8-353.
8.70 -E on page 8-398.
Usage
Use --protect_stack to enable the stack protection feature. Use --no_protect_stack to explicitly
disable this feature. If both options are specified, the last option specified takes effect.
The --protect_stack_all option adds this protection to all functions regardless of their vulnerability.
With stack protection, when a vulnerable function is called, the initial value of its guard variable is taken
from a global variable:
void *__stack_chk_guard;
You must provide this variable with a suitable value, such as a random value. The value can change
during the life of the program. For example, a suitable implementation might be to have the value
constantly changed by another thread. In addition, you must implement this function:
void __stack_chk_fail(void);
It is called by the checking code on detection of corruption of the guard. In general, such a function
would exit, possibly after reporting a fault.
For consistency with GNU tools, the option -fstack-protector is treated identically to
--protect-stack. Similarly, the -fstack-protector-all option is treated identically to
--protect_stack_all.
Default
The default is --no_protect_stack.
Example
In the following function, the array buf is vulnerable and the function is protected when compiled with
--protect_stack:
Usage
Saturating addition is not associative. That is, (x+y)+z might not be equal to x+(y+z). For example, with
a saturating maximum of 50, (40+20)-10 = 40 while 40+(20-10) = 50.
Some compiler optimizations rely on associativity, using re-association to rearrange expressions into a
more efficient sequence.
The --no_reassociate_saturation option prohibits re-association of saturating addition, and therefore
limits the level of optimization on saturating arithmetic.
The --reassociate_saturation option instructs the compiler to re-associate saturating additions,
enabling the following optimizations:
• Vectorization of saturating arithmetic when compiling with --vectorize.
• Other optimizations might be performed when compiling without --vectorize, for example with
-O3 -Otime.
Restriction
Saturating addition is not associative, so enabling --reassociate_saturation could affect the result
with a reduction in accuracy.
Default
The default is --no_reassociate_saturation.
Examples
The following code contains the function L_mac, which performs saturating additions. Therefore the
compiler does not vectorize this code unless --reassociate_saturation and --vectorize are
specified.
#include <dspfns.h>
int f(short *a, short *b)
{
int i;
int r = 0;
for (i = 0; i < 100; i++)
r=L_mac(r,a[i],b[i]);
return r;
}
Related concepts
3.6 Automatic vectorization on page 3-75.
Related references
8.192 --vectorize, --no_vectorize on page 8-534.
Mode
This option is effective on Windows systems only.
Usage
Windows systems impose a 260 character limit on file paths. Where path names exist whose absolute
names expand to longer than 260 characters, you can use the --reduce_paths option to reduce absolute
path name length by matching up directories with corresponding instances of .. and eliminating the
directory/.. sequences in pairs.
Note
ARM recommends that you avoid using long and deeply nested file paths, in preference to minimizing
path lengths using the --reduce_paths option.
Default
The default is --no_reduce_paths.
Example
Compiling the file
..\..\..\xyzzy\xyzzy\objects\file.c
Compiling the same file from the same directory using the option --reduce_paths results in an actual
path of
\foo\bar\baz\xyzzy\xyzzy\objects\file.c
Usage
This option is primarily provided for compatibility with GNU C. ARM does not recommend using this
option for new application code.
Default
The default is strict references and definitions. (Each global variable can only be declared in one object
file.) However, if you specify an ARM Linux configuration file on the command line and you use
--translate_gcc, the default is --relaxed_ref_def.
Restrictions
This option is not available in C++.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.182 --translate_gcc on page 8-521.
8.162 --remarks
Enables the display of remark messages, including any messages redesignated to remark severity using
--diag_remark.
Note
The compiler does not issue remarks by default.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
Usage
Use --remove_unneeded_entities to reduce the amount of debug information in an ELF object. Faster
linkage times can also be achieved.
Caution
Although --remove_unneeded_entities can help to reduce the amount of debug information generated
per file, it has the disadvantage of reducing the number of debug sections that are common to many files.
This reduces the number of common debug sections that the linker is able to remove at final link time,
and can result in a final debug image that is larger than necessary. For this reason, use --
remove_unneeded_entities only when necessary.
Restrictions
The effects of these options are restricted to debug information.
Default
The default is --no_remove_unneeded_entities.
Related information
The DWARF Debugging Standard, http://dwarfstd.org/.
Note
The alternative keywords __restrict and __restrict__ are supported as synonyms for restrict.
These alternative keywords are always available, regardless of the use of the --restrict option.
Default
When compiling ISO C99 source code, use of the C99 keyword restrict is enabled by default.
When compiling ISO C90 or ISO C++ source code, use of the C99 keyword restrict is disabled by
default.
Related references
9.13 restrict on page 9-563.
8.165 --retain=option
Restricts the optimizations performed by the compiler.
Syntax
--retain=option
Usage
This option might be useful when performing validation, debugging, and coverage testing. In most other
cases, it is not required.
Using this option can have a negative effect on code size and performance.
Related references
10.42 __attribute__((nomerge)) function attribute on page 10-647.
10.45 __attribute__((notailcall)) function attribute on page 10-650.
Usage
Use --no_rtti to disable source-level RTTI features such as dynamic_cast.
Note
You are permitted to use dynamic_cast without --rtti in cases where RTTI is not required, such as
dynamic cast to an unambiguous base, and dynamic cast to (void *). If you try to use dynamic_cast
without --rtti in cases where RTTI is required, the compiler generates an error.
Mode
These options are effective only if the source language is C++.
Default
The default is --rtti.
Related references
8.66 --dllimport_runtime, --no_dllimport_runtime on page 8-394.
8.167 --rtti_data, --no_rtti_data on page 8-503.
Usage
Use --no_rtti_data to disable both source-level features and the generation of most RTTI data. Even if
--no_rtti_data is set, RTTI data are generated for exceptions.
Note
In RVCT 4.0 and later, the GCC option -fno-rtti implies --no_rtti_data when using GCC
command-line translation.
Mode
These options are effective only if the source language is C++.
Default
The default is --rtti_data.
Related references
8.66 --dllimport_runtime, --no_dllimport_runtime on page 8-394.
8.75 --exceptions, --no_exceptions on page 8-403.
8.166 --rtti, --no_rtti on page 8-502.
8.181 --translate_g++ on page 8-519.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.168 -S
Outputs the disassembly of the machine code generated by the compiler to a file.
Unlike the --asm option, object modules are not generated. The name of the assembly output file
defaults to filename.s in the current directory, where filename is the name of the source file stripped
of any leading directory names. The default filename can be overridden with the -o option.
You can use armasm to assemble the output file and produce object code. The compiler adds ASSERT
directives for command-line options such as AAPCS variants and byte order to ensure that compatible
compiler and assembler options are used when re-assembling the output. You must specify the same
AAPCS settings to both the assembler and the compiler.
Related references
8.6 --apcs=qualifier...qualifier on page 8-322.
8.13 --asm on page 8-335.
8.21 -c on page 8-344.
8.107 --info=totals on page 8-438.
8.111 --interleave on page 8-442.
8.118 --list on page 8-450.
8.138 -o filename on page 8-471.
Related information
armasm User Guide.
Example
Consider the following example code:
#include <stdio.h>
int a_addr=(int)a;
int b_addr=(int)b;
if (a_addr == b_addr) {
printf("Objects are the same.\n");
} else {
printf("Objects are different.\n");
}
}
By default (that is, with the --share_inlineable_strings option) both instances of the string literal
use a single, shared, object:
armcc --share_inlineable_strings --c99 test.c -o-
Compiling the same code with the --no_share_inlineable_strings option results in multiple string
objects:
armcc --no_share_inlineable_strings --c99 test.c -o-
Related references
8.143 -Ospace on page 8-479.
8.144 -Otime on page 8-480.
8.170 --shared
Enables a shared library to be generated when building for ARM Linux with the --arm_linux_paths
option.
It enables the selection of libraries and initialization code suitable for use in a shared library, based on the
ARM Linux configuration.
Restrictions
You must use this option in conjunction with --arm_linux_paths and --apcs=/fpic.
Example
Link two object files, obj1.o and obj2.o, into a shared library named libexample.o:
armcc --arm_linux_paths --arm_linux_config_file=my_config_file --shared -o libexample.so obj1.o obj2.o
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.171 --show_cmdline
Outputs the command line used by the compiler.
Usage
Shows the command line after processing by the compiler, and can be useful to check:
• The command line a build system is using.
• How the compiler is interpreting the supplied command line, for example, the ordering of command-
line options.
The commands are shown normalized, and the contents of any via files are expanded.
The output is sent to the standard error stream (stderr).
Note
If using this option with the ARM Linux translation options, you must use -Warmcc. For example,
armcc -Warmcc,--show_cmdline --translate_gcc ...
Related references
8.98 --help on page 8-429.
8.1 -Aopt on page 8-317.
8.71 --echo on page 8-399.
8.114 -Lopt on page 8-445.
8.195 --via=filename on page 8-537.
8.200 -Warmcc,option[,option,...] on page 8-542.
Default
The default is --unsigned_bitfields. However, if you specify an ARM Linux configuration file on the
command line and you use --translate_gcc or --translate_g++, the default is --signed_bitfields.
Note
The AAPCS requirement for bitfields to default to unsigned on ARM, is relaxed in version 2.03 of the
standard.
Example
typedef int integer;
struct
{
integer x : 1;
} bf;
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.94 --gnu_defaults on page 8-425.
Related information
Procedure Call Standard for the ARM Architecture.
Default
The default is --unsigned_chars.
Related references
10.161 Predefined macros on page 10-786.
8.174 --split_ldm
Splits LDM and STM instructions performing large numbers of register transfers into multiple LDM or
STM instructions, to help reduce interrupt latency on some ARM systems.
When --split_ldm is selected, the maximum number of register transfers for an LDM or STM instruction
is limited to:
• Five, for all STMs.
• Five, for LDMs that do not load the PC.
• Four, for LDMs that load the PC.
Where register transfers beyond these limits are required, multiple LDM or STM instructions are used.
Usage
The --split_ldm option can reduce interrupt latency on ARM systems that:
• Do not have a cache or a write buffer, for example, a cacheless ARM7TDMI.
• Use zero-wait-state, 32-bit memory.
Note
Using --split_ldm increases code size and decreases performance slightly.
Restrictions
• --split_ldm only works with ARM instructions, but it is not guaranteed to work all the time. It does
not work with Thumb instructions.
• Inline assembler LDM and STM instructions are split by default when --split_ldm is used. However,
the compiler might subsequently recombine the separate instructions into an LDM or STM.
• Only LDM and STM instructions are split when --split_ldm is used.
• Some target hardware does not benefit from code that is built with --split_ldm. For example:
— It has no significant benefit for cached systems, or for processors with a write buffer.
— It has no benefit for systems with non zero-wait-state memory, or for systems with slow
peripheral devices. Interrupt latency in such systems is determined by the number of cycles
required for the slowest memory or peripheral access. Typically, this is much greater than the
latency introduced by multiple register transfers.
Related concepts
7.16 Inline assembler and instruction expansion in C and C++ code on page 7-280.
8.175 --split_sections
Generates one ELF section for each function in the source file.
Output sections are named with the same name as the function that generates the section, but with an i.
prefix.
Note
If you want to place specific data items or structures in separate sections, mark them individually with
__attribute__((section(...))).
If you want to remove unused functions, ARM recommends that you use the linker feedback
optimization in preference to this option. This is because linker feedback produces smaller code by
avoiding the overhead of splitting all sections.
Restrictions
This option reduces the potential for sharing addresses, data, and string literals between functions.
Consequently, it might increase code size slightly for some functions.
Example
int f(int x)
{
return x+1;
}
Related references
8.46 --data_reorder, --no_data_reorder on page 8-373.
8.82 --feedback=filename on page 8-410.
8.134 --multifile, --no_multifile on page 8-467.
10.49 __attribute__((section("name"))) function attribute on page 10-654.
10.79 #pragma arm section [section_type_list] on page 10-684.
2.15 Linker feedback during compilation on page 2-59.
Default
The default is --no_strict.
Usage
--strict enforces compliance with:
ISO C90
• ISO/IEC 9899:1990, the 1990 International Standard for C.
• ISO/IEC 9899 AM1, the 1995 Normative Addendum 1.
ISO C99
ISO/IEC 9899:1999, the 1999 International Standard for C.
ISO C++
ISO/IEC 14822:2003, the 2003 International Standard for C++.
Errors
When --strict is in force and a violation of the relevant ISO standard occurs, the compiler issues an
error message.
The severity of diagnostic messages can be controlled using the --diag_error, --diag_remark, and
--diag_warning options.
Example
void foo(void)
{
long long i; /* okay in nonstrict C90 */
}
Related references
8.5 --anachronisms, --no_anachronisms on page 8-321.
8.23 --c90 on page 8-346.
8.24 --c99 on page 8-347.
8.93 --gnu on page 8-424.
8.39 --cpp on page 8-363.
8.40 --cpp11 on page 8-364.
8.41 --cpp_compat on page 8-365.
1.2 Source language modes of the compiler on page 1-31.
2.7 Filename suffixes recognized by the compiler on page 2-49.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.177 --strict_warnings on page 8-514.
9.19 Dollar signs in identifiers on page 9-569.
8.177 --strict_warnings
Diagnostics that are errors in --strict mode are downgraded to warnings, where possible.
It is sometimes not possible for the compiler to downgrade a strict error, for example, where it cannot
construct a legitimate program to recover.
Errors
When --strict_warnings is in force and a violation of the relevant ISO standard occurs, the compiler
normally issues a warning message.
The severity of diagnostic messages can be controlled using the --diag_error, --diag_remark, and
--diag_warning options.
Note
In some cases, the compiler issues an error message instead of a warning when it detects something that
is strictly illegal, and terminates the compilation. For example:
#ifdef $Super$
extern void $Super$$__aeabi_idiv0(void); /* intercept __aeabi_idiv0 */
#endif
Compiling this code with --strict_warnings generates an error if you do not use the --dollar option.
Example
void foo(void)
{
long long i; /* okay in nonstrict C90 */
}
Related references
8.5 --anachronisms, --no_anachronisms on page 8-321.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.177 --strict_warnings on page 8-514.
9.19 Dollar signs in identifiers on page 9-569.
1.2 Source language modes of the compiler on page 1-31.
$a
.text
main
0x00000000: e92d4010 .@-. PUSH {r4,lr}
0x00000004: e28f0008 .... ADR r0,{pc}+0x10 ; 0x14
0x00000008: ebfffffe .... BL puts
0x0000000c: e3a00000 .... MOV r0,#0
0x00000010: e8bd8010 .... POP {r4,pc}
$d
0x00000014: 6c6c6548 Hell DCD 1819043144
0x00000018: 6f77206f o wo DCD 1870078063
0x0000001c: 00646c72 rld. DCD 6581362
$a
.text
main
0x00000000: e59f000c .... LDR r0,[pc,#12] ; [0x14] = 0
0x00000004: e92d4010 .@-. PUSH {r4,lr}
0x00000008: ebfffffe .... BL puts
0x0000000c: e3a00000 .... MOV r0,#0
0x00000010: e8bd8010 .... POP {r4,pc}
$d
0x00000014: 00000000 .... DCD 0
If you also specify the --no_integer_literal_pools option, the compiler constructs the address of the
character data with a pair of MOVW/MOVT instructions.
Default
The default is --string_literal_pools.
--execute_only implies --no_string_literal_pools, unless --string_literal_pools is explicitly
specified.
Note
Do not use --execute_only in conjunction with --string_literal_pools. If you do, then the
compiler places the literal pool in an unreadable, execute-only code region.
Related concepts
4.21 Compiler support for literal pools on page 4-131.
Related references
8.109 --integer_literal_pools, --no_integer_literal_pools on page 8-440.
8.18 --branch_tables, --no_branch_tables on page 8-340.
8.179 --sys_include
Removes the current place from the include search path.
Quoted include files are treated in a similar way to angle-bracketed include files, except that quoted
include files are always searched for first in the directories specified by -I, and angle-bracketed include
files are searched for first in the -J directories.
Related concepts
2.9 Factors influencing how the compiler searches for header files on page 2-52.
Related references
8.112 -Jdir[,dir,...] on page 8-443.
8.100 -Idir[,dir,...] on page 8-431.
8.113 --kandr_include on page 8-444.
8.155 --preinclude=filename on page 8-491.
2.10 Compiler command-line options and search paths on page 2-53.
8.180 --thumb
Targets the Thumb instruction set.
Default
This is the default option for targets that do not support the ARM instruction set.
Related tasks
5.4 Selecting the target processor at compile time on page 5-157.
Related references
8.7 --arm on page 8-326.
10.78 #pragma arm on page 10-683.
10.101 #pragma thumb on page 10-708.
Related information
ARM architectures supported by the toolchain.
8.181 --translate_g++
Helps to emulate the GNU compiler in C++ mode by enabling the translation of command lines from the
GNU tools.
Usage
You can use this option to provide either of the following:
• A full GCC emulation targeting ARM Linux.
• A subset of full GCC emulation in the form of translating individual GCC command-line arguments
into their ARM compiler equivalents.
To provide a full ARM Linux GCC emulation, you must also use --arm_linux_config_file. This
combination of options selects the appropriate GNU header files and libraries specified by the
configuration file, and includes changes to some default behaviors.
To translate GCC command-line arguments into their ARM compiler equivalents without aiming for full
GCC emulation, use --translate_g++ to emulate g++, but do not use it with
--arm_linux_config_file. Because you are not aiming for full GCC emulation with this method, the
default behavior of the ARM compilation tools is retained, and no defaults are set for targeting ARM
Linux. The library paths and option defaults for the ARM compilation tools remained unchanged.
Specifying multiple GNU translation modes on the same command line is ambiguous to the compiler.
The first specified translation mode is used, and the compiler generates a warning message. For example,
given armcc --translate_g++ --translate_gld, the compiler uses --translate_g++, ignores
--translate_gld, and generates a warning message.
If you specify an ARM Linux configuration file on the command line and you use --translate_g++,
this alters the default settings for:
• --exceptions, --no_exceptions.
• --bss_threshold.
• --relaxed_ref_def, --no_relaxed_ref_def
• --signed_bitfields, --unsigned_bitfields.
To selectively specify options that are not to be translated, use -Warmcc.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
8.20 --bss_threshold=num on page 8-343.
8.75 --exceptions, --no_exceptions on page 8-403.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.182 --translate_gcc
Helps to emulate GCC by enabling the translation of command lines from the GNU tools.
Usage
You can use this option to provide either of the following:
• A full GCC emulation targeting ARM Linux.
• A subset of full GCC emulation in the form of translating individual GCC command-line arguments
into their ARM compiler equivalents.
To provide a full GCC emulation, you must also use --arm_linux_config_file. This combination of
options selects the appropriate GNU header files and libraries specified by the configuration file, and
includes changes to some default behaviors.
To translate individual GCC command-line arguments into their ARM compiler equivalents without
aiming for full GCC emulation, use --translate_gcc to emulate gcc, but do not use it with
--arm_linux_config_file. Because you are not aiming for full GCC emulation with this method, the
default behavior of the ARM compilation tools is retained, and no defaults are set for targeting ARM
Linux. The library paths and option defaults for the ARM compilation tools remained unchanged.
To selectively specify options that are not to be translated, use -Warmcc.
Specifying multiple GNU translation modes on the same command line is ambiguous to the compiler.
The first specified translation mode is used, and the compiler generates a warning message. For example,
given armcc --translate_gcc --translate_gld, the compiler uses --translate_gcc, ignores
--translate_gld, and generates a warning message.
If you specify an ARM Linux configuration file on the command line and you use --translate_gcc,
this alters the default settings for:
• --bss_threshold.
• --relaxed_ref_def, --no_relaxed_ref_def.
• --signed_bitfields, --unsigned_bitfields.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.183 --translate_gld on page 8-523.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
8.20 --bss_threshold=num on page 8-343.
8.75 --exceptions, --no_exceptions on page 8-403.
8.161 --relaxed_ref_def, --no_relaxed_ref_def on page 8-497.
8.172 --signed_bitfields, --unsigned_bitfields on page 8-509.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
8.183 --translate_gld
Helps to emulate GNU ld by enabling the translation of command lines from the GNU tools.
Usage
You can use this option to provide either of the following:
• A full GNU ld emulation targeting ARM Linux
• A subset of full GNU ld emulation in the form of translating individual GNU ld command-line
arguments into their ARM compiler equivalents.
To provide a full GNU ld emulation, you must also use --arm_linux_config_file. This combination
of options selects the appropriate GNU library paths specified by the configuration file, and includes
changes to some default behaviors.
To translate individual GNU ld command-line arguments into their ARM compiler equivalents without
aiming for full GNU ld emulation, use --translate_gld to emulate GNU ld, but do not use it with
--arm_linux_config_file. Because you are not aiming for full GNU ld emulation with this method,
default behavior of the ARM compilation tools is retained, and no defaults are set for targeting ARM
Linux. The library paths and option defaults for the ARM compilation tools remained unchanged.
Note
• --translate_gld is used by invoking armcc as if it were the GNU linker. This is intended only for
use by existing build scripts that involve the GNU linker directly.
• In gcc and g++ modes, armcc reports itself with --translate_gld as the linker it uses. For example,
gcc -print-file-name=ld.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.10 --arm_linux_configure on page 8-330.
8.11 --arm_linux_paths on page 8-332.
8.31 --configure_cpp_headers=path on page 8-355.
8.182 --translate_gcc on page 8-521.
8.32 --configure_extra_includes=paths on page 8-356.
8.33 --configure_extra_libraries=paths on page 8-357.
8.35 --configure_gcc=path on page 8-359.
8.36 --configure_gcc_version=version on page 8-360.
8.37 --configure_gld=path on page 8-361.
8.181 --translate_g++ on page 8-519.
8.94 --gnu_defaults on page 8-425.
8.170 --shared on page 8-507.
8.77 --execstack, --no_execstack on page 8-405.
8.38 --configure_sysroot=path on page 8-362.
8.8 --arm_linux on page 8-327.
8.20 --bss_threshold=num on page 8-343.
8.75 --exceptions, --no_exceptions on page 8-403.
Related information
--search_dynamic_libraries, --no_search_dynamic_libraries linker option.
--library=name linker option.
--arm_linux linker option.
Default
The default is --trigraphs, except in GNU mode, where the default is --no_trigraphs.
Related information
ISO/IEC 9899:TC2.
C++11 provides type traits, a compile-time template-based interface to query the properties and
characteristics of types.
ARM Compiler recognizes the following set of type trait helper pseudo-functions:
• __has_assign
• __has_copy
• __has_nothrow_assign
• __has_nothrow_constructor
• __has_nothrow_copy
• __has_trivial_assign
• __has_trivial_constructor
• __has_trivial_copy
• __has_trivial_destructor
• __has_user_destructor
• __has_virtual_destructor
• __is_abstract
• __is_base_of
• __is_class
• __is_convertible_to
• __is_empty
• __is_enum
• __is_pod
• __is_polymorphic
• __is_union
• __is_trivial
• __is_standard_layout
• __is_trivially_copyable
• __is_literal_type
• __has_trivial_move_constructor
• __has_trivial_move_assign
• __has_nothrow_move_assign
• __is_constructible
• __is_nothrow_constructible
• __is_trivially_constructible
• __is_destructible
• __is_nothrow_destructible
• __is_trivially_destructible
• __is_nothrow_assignable
• __is_trivially_assignable
• __underlying_type
Type traits helpers are enabled in non-GNU C++ mode by default, and in GNU C++ mode when
emulating g++ 4.3 and later.
Specifying --no_type_trait_helpers stops the compiler from recognizing these names as pseudo-
functions. This can avoid name clashes when linking objects from other compilers.
Related references
8.96 --gnu_version=version on page 8-427.
8.186 -Uname
Removes any initial definition of the specified macro.
The macro name can be either:
• A predefined macro.
• A macro specified using the -D option.
Note
Not all compiler predefined macros can be undefined.
Syntax
-Uname
Where:
name
is the name of the macro to be undefined.
Usage
Specifying -Uname has the same effect as placing the text #undef name at the head of each source file.
Restrictions
The compiler defines and undefines macros in the following order:
1. Compiler predefined macros.
2. Macros defined explicitly, using -Dname.
3. Macros explicitly undefined, using -Uname.
Related references
8.22 -C on page 8-345.
8.45 -Dname[(parm-list)][=def] on page 8-372.
8.70 -E on page 8-398.
8.128 -M on page 8-461.
10.161 Predefined macros on page 10-786.
Default
The default is --unaligned_access on ARM-architecture based processors that support unaligned
accesses to data. This includes:
• All ARMv6 architecture-based processors.
• ARMv7-A, ARMv7-R, and ARMv7-M architecture-based processors.
The default is --no_unaligned_access on ARM-architecture based processors that do not support
unaligned accesses to data. This includes:
• All pre-ARMv6 architecture-based processors.
• ARMv6-M architecture-based processors.
Usage
--unaligned_access
Use --unaligned_access on processors that support unaligned accesses to data, for example
--cpu=ARM1136J-S, to speed up accesses to packed structures.
--no_unaligned_access
Use --no_unaligned_access to disable the generation of unaligned word and halfword
accesses on ARMv6 and ARMv7 processors.
To enable modulo four-byte alignment checking on an ARMv6 target without unaligned
accesses, you must:
• Set the A bit, bit 1, of CP15 register 1 in your initialization code.
• Set the U bit, bit 22, of CP15 register 1 in your initialization code.
The initial value of the U bit is determined by the UBITINIT input to the processor.
To enable alignment fault checking in ARMv7:
• In ARMv7-A and ARMv7-R, set the A bit, bit 1, in the SCTLR.
• In ARMv7-M, set the UNALIGN_TRP bit, bit 3, in the CCR.
Note
ARM processors do not provide support for unaligned doubleword accesses, for example
unaligned accesses to long long integers. Doubleword accesses must be either eight-byte or
four-byte aligned.
The libraries include special versions of certain library functions designed to exploit unaligned
accesses. To prevent these enhanced library functions being used when unaligned access support
is disabled, you have to specify --no_unaligned_access on both the compiler command line
and the assembler command line when compiling a mixture of C and C++ source files and
assembly language source files.
Restrictions
Code compiled for processors supporting unaligned accesses to data can run correctly only if the choice
of alignment support in software matches the choice of alignment support on the processor.
Related references
8.43 --cpu=name on page 8-368.
Related information
--unaligned_access, --no_unaligned_access assembler option.
Default
The default is --no_use_frame_pointer. That is, register R11 (or register R7 for Thumb code on older
processors) is available for use as a general-purpose register.
Related information
ARM registers.
General-purpose registers.
8.189 --use_gas
Invokes the GNU assembler (gas) rather than armasm when you compile source files ending in .s or .S.
It is only applicable when using GNU translation (-Warmcc).
Usage
During translation, invoke gas with -Warmcc,--use_gas.
Related references
8.34 --configure_gas=path on page 8-358.
8.200 -Warmcc,option[,option,...] on page 8-542.
8.190 --use_pch=filename
Uses the specified PCH file as part of the current compilation.
Note
This option is deprecated.
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
This option takes precedence if you include --pch on the same command line.
Syntax
--use_pch=filename
Where:
filename
is the PCH file to be used as part of the current compilation.
Restrictions
The effect of this option is negated if you include --create_pch=filename on the same command line.
Errors
If the specified file does not exist, or is not a valid PCH file, the compiler generates an error.
Related concepts
4.30 Manually specifying the filename and location of a Precompiled Header (PCH) file on page 4-143.
4.24 Precompiled Header (PCH) files on page 4-134.
Related references
8.44 --create_pch=filename on page 8-371.
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
8.150 --pch_messages, --no_pch_messages on page 8-486.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
10.87 #pragma hdrstop on page 10-693.
10.92 #pragma no_pch on page 10-698.
Note
This option is provided only as a migration aid for legacy source code that does not conform to the C++
standard. ARM does not recommend its use.
Mode
This option is effective only if the source language is C++.
Default
The default is --no_using_std.
Related references
11.10 Namespaces in ARM C++ on page 11-810.
Default
The default is --no_vectorize.
Restrictions
The following options must be specified for loops to vectorize:
--cpu=name
Target processor must have NEON capability.
-Otime
Type of optimization to reduce execution time.
-Onum
Level of optimization. One of the following must be used:
• -O2 High optimization. This is the default.
• -O3 Maximum optimization.
Example
This example invokes automatic vectorization on the Cortex-A8 processor.
armcc --vectorize --cpu=Cortex-A8 -O3 -Otime -c file.c
Using the command-line options -O3 and -Otime ensures that the code achieves significant performance
benefits in addition to those of vectorization.
Note
You can also compile with -O2 -Otime. However, this does not give the maximum code performance.
Related references
8.43 --cpu=name on page 8-368.
8.139 -Onum on page 8-473.
8.144 -Otime on page 8-480.
8.159 --reassociate_saturation, --no_reassociate_saturation on page 8-495.
Chapter 3 Using the NEON Vectorizing Compiler on page 3-67.
Related information
Introducing NEON Development Article.
8.193 --version_number
Displays the version of armcc you are using.
Usage
The compiler displays the version number in the format nnnbbbb, where:
• nnn is the version number.
• bbbb is the build number.
Example
Version 5.06 build 0019 is displayed as 5060019.
Related references
8.198 --vsn on page 8-540.
8.98 --help on page 8-429.
Mode
This option is effective only if the source language is C++.
Default
The default is --vfe, except for the case where legacy object files compiled with a pre-RVCT v2.1
compiler do not contain VFE information.
Related references
16.2 Calling a pure virtual function on page 16-914.
Related information
Elimination of unused virtual functions.
8.195 --via=filename
Reads an additional list of input filenames and compiler options from filename.
Syntax
--via=filename
Where filename is the name of a via file containing options to be included on the command line.
Usage
You can enter multiple --via options on the compiler command line. The --via options can also be
included within a via file.
Example
Given a source file main.c, a via file apcs.txt containing the line:
--apcs=/rwpi --no_lower_rwpi --via=L_apcs.txt
Related references
13.2 Via file syntax rules on page 13-886.
Related information
Methods of specifying command-line options.
8.196 --visibility_inlines_hidden
Stops inline member functions acquiring dynamic linkage.
Inline member functions stop acquiring dynamic linkage (default visibility) from:
• class __declspec(dllexport).
• A class visibility attribute.
• --no_hide_all.
Non-member functions are not affected.
Related references
10.23 __declspec(dllexport) on page 10-625.
10.53 __attribute__((visibility("visibility_type"))) function attribute on page 10-658.
8.99 --hide_all, --no_hide_all on page 8-430.
Default
C90 and Standard C++ do not support variable length arrays by default. Select the option --vla to
enable support for variable length arrays in C90 or Standard C++.
Variable length arrays are supported both in Standard C and the GNU compiler extensions. The option --
vla is implicitly selected either when the source language is C99 or the option --gnu is specified.
Note
Memory for variable length arrays is allocated at runtime, on the heap.
Example
size_t arr_size(int n)
{
char array[n]; // variable length array, dynamically allocated
return sizeof array; // evaluated at runtime
}
Related references
8.23 --c90 on page 8-346.
8.24 --c99 on page 8-347.
8.39 --cpp on page 8-363.
8.93 --gnu on page 8-424.
8.198 --vsn
Displays the version information and the license details.
Note
--vsn is intended to report the version information for manual inspection. The Component line indicates
the release of ARM Compiler you are using. If you need to access the version in other tools or scripts, for
example in build scripts, use the output from --version_number.
Example
> armcc --vsn
Product: ARM Compiler N.nn
Component: ARM Compiler N.nn (toolchain_build_number)
Tool: armcc [build_number]
license_type
Software supplied by: ARM Limited
Related references
8.98 --help on page 8-429.
8.193 --version_number on page 8-535.
8.199 -W
Suppresses all warning messages.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
8.200 -Warmcc,option[,option,...]
Enables normal compiler command-line options to be passed to the compiler in GCC emulation mode.
The options associated with -Warmcc are passed verbatim to the compiler, that is, without translation.
These options also override any translation options that are specified.
Syntax
-Warmcc,option[,option,...]
Where:
option
is a normal ARM compiler option.
Usage
Use this option to take advantage of features specific to the ARM compilation tools when in GCC
emulation mode.
Example
In this example, -Warmcc enables the command-line options -A and -L to be used for passing options to
the assembler and the linker without translation, while in GCC emulation mode.
armcc --translate_gcc --arm_linux_config_file=linux_config -o example.axf example.s -
Warmcc,-A--predefine="my_variable SETA 20" -Warmcc,-L--inline
Related concepts
2.14 Using GCC fallback when building Linux applications on page 2-57.
Related references
8.9 --arm_linux_config_file=path on page 8-329.
8.1 -Aopt on page 8-317.
8.114 -Lopt on page 8-445.
8.181 --translate_g++ on page 8-519.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
Related information
--predefine directive assembler option.
--inline, --no_inline linker option.
8.201 -Warmcc,--gcc_fallback
Uses GCC to retry a failed build step, when building for ARM Linux.
Usage
When using armcc in GCC emulation mode, GCC incompatibilities might cause a compile, assembly or
link step to fail. Using this option instructs the compiler to automatically retry the failed step using GCC.
Any build step that succeeds with the armcc does not get rebuilt using GCC. Each failed step is retried
using GCC. For example, if you specify this option for all of the source files in your build and one of
them contains an unsupported GNU extension, such as inline assembly code with the GCC syntax, armcc
generates a warning and the compiler retries the failed command lines using the GNU tools.
Note
You must escape the option using -Warmcc, for example -Warmcc,--gcc_fallback.
Restrictions
This option can only be used with a GNU emulation mode (that is when using --translate_gcc,
--translate_g++, or --translate_gld) and an ARM Linux configuration file specified with
--arm_linux_config_file. An existing GNU toolchain must be present (either automatically found on
the PATH environment variable or specified with --configure_gcc) to create the configuration file.
Example
armcc -c --translate_gcc --arm_linux_config_file=linux_config -Warmcc,--gcc_fallback -o
example.o example.c
Related references
8.181 --translate_g++ on page 8-519.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
8.9 --arm_linux_config_file=path on page 8-329.
8.11 --arm_linux_paths on page 8-332.
8.10 --arm_linux_configure on page 8-330.
8.35 --configure_gcc=path on page 8-359.
Usage
Use this option to create an object file that is independent of wchar_t size.
Restrictions
If --no_wchar is specified:
• wchar_t fields in structure declarations are faulted by the compiler, regardless of whether or not the
structure is used.
• wchar_t in a typedef is faulted by the compiler, regardless of whether or not the typedef is used.
Default
The default is --wchar.
Related references
8.203 --wchar16 on page 8-545.
8.204 --wchar32 on page 8-546.
8.203 --wchar16
Changes the type of wchar_t to unsigned short.
Selecting this option modifies both the type of the defined type wchar_t in C and the type of the native
type wchar_t in C++. It also affects the values of WCHAR_MIN and WCHAR_MAX.
Default
The compiler assumes --wchar16 unless --wchar32 is explicitly specified.
Related references
8.202 --wchar, --no_wchar on page 8-544.
8.204 --wchar32 on page 8-546.
10.161 Predefined macros on page 10-786.
8.204 --wchar32
Changes the type of wchar_t to unsigned int.
Selecting this option modifies both the type of the defined type wchar_t in C and the type of the native
type wchar_t in C++. It also affects the values of WCHAR_MIN and WCHAR_MAX.
Default
The compiler assumes --wchar16 unless --wchar32 is explicitly specified, or unless you specify an
ARM Linux configuration file on the command line. Specifying an ARM Linux configuration file on the
command line turns --wchar32 on.
Related references
10.161 Predefined macros on page 10-786.
8.203 --wchar16 on page 8-545.
8.202 --wchar, --no_wchar on page 8-544.
8.94 --gnu_defaults on page 8-425.
8.10 --arm_linux_configure on page 8-330.
8.9 --arm_linux_config_file=path on page 8-329.
8.205 --whole_program
Promises the compiler that the source files specified on the command line form the whole program.
The compiler is then able to apply optimizations based on the knowledge that the source code visible to it
is the complete set of source code for the program being compiled. Without this knowledge, the compiler
is more conservative when applying optimizations to the code.
Usage
Use this option to gain maximum performance from a small program.
Restriction
Do not use this option if you do not have all of the source code to give to the compiler.
Related references
8.134 --multifile, --no_multifile on page 8-467.
Default
The default is --no_wrap_diagnostics.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
Related references
9.2 #assert on page 9-552.
9.3 #include_next on page 9-553.
9.4 #unassert on page 9-554.
9.5 #warning on page 9-555.
9.2 #assert
The #assert preprocessing extensions of System V release 4 are permitted. These enable definition and
testing of predicate names.
Such names are in a namespace distinct from all other names, including macro names.
Syntax
#assert name
#assert name[(token-sequence)]
Where:
name
is a predicate name
token-sequence
is an optional sequence of tokens.
If the token sequence is omitted, name is not given a value.
If the token sequence is included, name is given the value token-sequence.
Usage
You can test a predicate name defined using #assert in a #if expression, for example:
#if #name(token-sequence)
This has the value 1 if a #assert of the name name with the token-sequence token-sequence has
appeared, and 0 otherwise.
A predicate can have multiple values. That is, subsequent assertions do not override preceding assertions.
Example
The following example assigns multiple values and shows the results #if expressions:
#assert foo(one) // Assigns the value "one"
#assert foo(two) // Assigns the value "two"
#assert foo(three) // Assigns the value "three"
#unassert foo(two) // Unassigns the value "two"
#if #foo(one)... // 1
#if #foo(two)... // 0, because of #unassert
#if #foo(three)... // 1
#if #foo(four)... // 0, because this value was never asserted
Related references
9.4 #unassert on page 9-554.
9.3 #include_next
This preprocessor directive is a variant of the #include directive. It searches for the named file only in
the directories on the search path that follow the directory where the current source file is found, that is,
the one containing the #include_next directive.
Note
This preprocessor directive is a GNU compiler extension that the ARM compiler supports.
9.4 #unassert
You can delete a predicate name using the #unassert preprocessing directive.
Syntax
#unassert name
#unassert name[(token-sequence)]
Where:
name
is a predicate name
token-sequence
is an optional sequence of tokens.
If the token sequence is omitted, all definitions of name are removed.
If the token sequence is included, only the indicated definition is removed. All other definitions
are left intact.
Related references
9.2 #assert on page 9-552.
9.5 #warning
The preprocessing directive #warning is supported. Like the #error directive, this produces a user-
defined warning at compilation time. However, it does not halt compilation.
Restrictions
The #warning directive is not available if the --strict option is specified. If used, it produces an error.
Related references
8.176 --strict, --no_strict on page 8-513.
Related references
9.7 // comments on page 9-557.
9.8 Subscripting struct on page 9-558.
9.9 Flexible array members on page 9-559.
9.7 // comments
The character sequence // starts a one line comment, like in C99 or C++.
// comments in C90 have the same semantics as // comments in C99.
Example
// this is a comment
Related concepts
5.59 New language features of C99 on page 5-228.
Example
struct Subscripting_Struct
{
int a[4];
};
extern struct Subscripting_Struct Subscripting_0(void);
int Subscripting_1 (int index)
{
return Subscripting_0().a[index];
}
Example
typedef struct
{
int len;
char p[]; // incomplete array type, for use in a malloc’d data structure
} str;
Related concepts
5.59 New language features of C99 on page 5-228.
Note
Language features of Standard C, for example long long integers, might be similar to the C++ and C90
language extensions. Such features continue to remain available if you are compiling strict Standard C++
or strict C90 using the --strict compiler option.
Related references
9.11 Variadic macros on page 9-561.
9.12 long long on page 9-562.
9.13 restrict on page 9-563.
9.14 Hexadecimal floats on page 9-564.
Example
#define debug(format, ...) fprintf (stderr, format, __VA_ARGS__)
void variadic_macros(void)
{
debug ("a test string is printed out along with %x %x %x\n", 12, 14, 20);
}
Related concepts
5.59 New language features of C99 on page 5-228.
Related references
8.93 --gnu on page 8-424.
They behave analogously to long and unsigned long with respect to the usual arithmetic conversions.
__int64 is a synonym for long long.
This expression evaluates to 0 in strict C and C++, and to 1 in ARM C and C++.
The long long types are accommodated in the usual arithmetic conversions.
Related references
10.9 __int64 on page 10-609.
9.13 restrict
The restrict keyword is a C99 feature. It enables you to convey a declaration of intent to the compiler
that different pointers and function parameter arrays do not point to overlapping regions of memory at
runtime.
This enables the compiler to perform optimizations that can otherwise be prevented because of possible
aliasing.
Usage
The keywords __restrict and __restrict__ are supported as synonyms for restrict and are always
available.
You can specify --restrict to allow the use of the restrict keyword in C90 or C++.
Restrictions
The declaration of intent is effectively a promise to the compiler that, if broken, results in undefined
behavior.
Examples
The following example shows use of the restrict keyword applied to function parameter arrays.
void copy_array(int n, int *restrict a, int *restrict b)
{
while (n-- > 0)
*a++ = *b++;
}
The following example shows use of the restrict keyword applied to different pointers that exist in the
form of local variables.
void copy_bytes(int n, int *a, int *b)
{
int *restrict x;
int *restrict y;
x = a;
y = b;
while (n-- > 0)
*q++ = *s++;
}
Related concepts
5.59 New language features of C99 on page 5-228.
Related references
8.164 --restrict, --no_restrict on page 8-500.
Example
float hex_floats(void)
{
return 0x1.fp3; // 1.55e1
}
Related concepts
5.59 New language features of C99 on page 5-228.
Related references
9.16 Constant expressions on page 9-566.
9.17 Array and pointer extensions on page 9-567.
9.18 Block scope function declarations on page 9-568.
9.19 Dollar signs in identifiers on page 9-569.
9.20 Top-level declarations on page 9-570.
9.21 Benign redeclarations on page 9-571.
9.22 External entities on page 9-572.
9.23 Function prototypes on page 9-573.
Table 9-1 Behavior of constant value initializers in comparison with ISO Standard C
Related references
8.81 --extended_initializers, --no_extended_initializers on page 8-409.
8.176 --strict, --no_strict on page 8-513.
8.177 --strict_warnings on page 8-514.
Example
void f1(void)
{
static void g(void); /* static function declared in local scope */
/* use of static keyword is illegal in strict ISO C */
}
void f2(void)
{
g(); /* uses previous local declaration */
}
static void g(int i)
{ } /* error - conflicts with previous declaration of g */
Note
When compiling with the --strict option, you can use the --dollar command-line option to permit
dollar signs in identifiers.
Example
#define DOLLAR$
Related references
8.67 --dollar, --no_dollar on page 8-395.
8.176 --strict, --no_strict on page 8-513.
Errors
A remark is issued if a C input file contains no top-level declarations.
Note
Remarks are not displayed by default. To see remark messages, use the compiler option --remarks.
Related references
8.162 --remarks on page 8-498.
Example
typedef int INT;
typedef int INT; /* redeclaration */
Errors
The compiler generates a warning if an external entity declared in another scope is visible.
Example
void f1(void)
{
extern void f();
}
void f2(void)
{
f(); /* Out of scope declaration */
}
Errors
The compiler generates a warning message if you use old-style function prototypes.
Example
int function_prototypes(char);
// Old-style function definition.
int function_prototypes(x)
char x;
{
return x == 0;
}
Related references
9.25 ? operator on page 9-575.
9.26 Declaration of a class member on page 9-576.
9.27 friend on page 9-577.
9.28 Read/write constants on page 9-578.
9.29 Scalar type constants on page 9-579.
9.30 Specialization of nonmember function templates on page 9-580.
9.31 Type conversions on page 9-581.
9.25 ? operator
A ? operator whose second and third operands are string literals or wide string literals can be implicitly
converted to char * or wchar_t *.
In C++ string literals are const. There is an implicit conversion that enables conversion of a string literal
to char * or wchar_t *, dropping the const. That conversion, however, applies only to simple string
literals. Permitting it for the result of a ? operation is an extension.
Example
char *p = x ? "abc" : "def";
Errors
A warning is issued if a qualified name is used in the declaration of a class member.
Example
struct A
{
int A::f(); // is the same as int f();
};
9.27 friend
A friend declaration for a class can omit the class keyword.
Access checks are not carried out on friend declarations by default. Use the --strict command-line
option to force access checking.
Example
class B;
class A
{
friend B; // is the same as "friend class B"
};
Related references
8.176 --strict, --no_strict on page 8-513.
Note
The use of "C++:read/write" linkage is only necessary for code compiled with --apcs /rwpi. If you
recompile existing code with this option, you must change the linkage specification for external
constants that are dynamically initialized or have mutable members.
Compiling C++ with the --apcs /rwpi option deviates from the ISO C++ Standard. The declarations in
this example assume that x is in a read-only segment:
extern const T x;
extern "C++" const T x;
extern "C" const T x;
Dynamic initialization of x including user-defined constructors is not possible for constants and T cannot
contain mutable members. The new linkage specification in this example declares that x is in a read/write
segment even if it is initialized with a constant. Dynamic initialization of x is permitted and T can contain
mutable members. The definitions of x, y, and z in another file must have the same linkage
specifications.
extern const int z; // in read-only segment, cannot
// be dynamically initialized
extern "C++:read/write" const int y; // in read/write segment
// can be dynamically
// initialized
extern "C++:read/write"
{
const int i=5; // placed in read-only segment,
// not extern because implicitly
// static
extern const T x=6; // placed in read/write segment
struct S
{
static const T T x; // placed in read/write segment
};
}
Constant objects must not be redeclared with another linkage. The code in the following example
produces a compile error.
extern "C++" const T x;
extern "C++:read/write" const T x; /* error */
Note
Because C does not have the linkage specifications, you cannot use a const object declared in C++ as
extern "C++:read/write" from C.
Related references
8.6 --apcs=qualifier...qualifier on page 8-322.
Errors
A warning is issued if you define a member of constant integral type within a class.
Example
class A
{
const int size = 10; // must be static const int size = 10;
int a[size];
};
Example
extern "C" void f(); // f’s type has extern "C" linkage
void (*pf)() = &f; // pf points to an extern "C++" function
// error unless implicit conversion is allowed
Related references
9.33 Address of a register variable on page 9-583.
9.34 Arguments to functions on page 9-584.
9.35 Anonymous classes, structures and unions on page 9-585.
9.36 Assembler labels on page 9-586.
9.37 Empty declaration on page 9-587.
9.38 Hexadecimal floating-point constants on page 9-588.
9.39 Incomplete enums on page 9-589.
9.40 Integral type extensions on page 9-590.
9.41 Label definitions on page 9-591.
9.42 Long float on page 9-592.
9.43 Nonstatic local variables on page 9-593.
9.44 Structure, union, enum, and bitfield extensions on page 9-594.
Errors
The compiler generates a warning if you take the address of a variable with register storage class.
Example
void foo(void)
{
register int i;
int *j = &i;
}
typedef union {
int i, j;
} U; // U identifies a reusable anonymous union.
struct A {
U; // Okay -- references to A::i and A::j are allowed.
};
Note
The example above does not work in C++.
The extension also enables anonymous classes and anonymous structures, as long as they have no C++
features. For example, no static data members or member functions, no nonpublic members, and no
nested types (except anonymous classes, structures, or unions) are allowed in anonymous classes and
anonymous structures. For example:
#pragma anon_unions
struct A
{
struct
{
int i, j;
}; // Okay -- references to i and j
}; // through class A are allowed.
int foo(int m)
{
A a;
a.i = m;
return a.i;
}
Related references
10.77 #pragma anon_unions, #pragma no_anon_unions on page 10-682.
Related information
Which GNU language extensions are supported by the ARM Compiler?.
This exports the symbol counter_v1 and not the symbol counter.
Related references
10.5 __asm on page 10-604.
Example
; // do nothing
Syntax
The syntax for specifying floating-point constants as IEEE bit patterns is:
0f_n
Interpret an 8-digit hex number n as a float constant. There must be exactly eight digits.
0d_nn
Interpret a 16-digit hex number nn as a double constant. There must be exactly 16 digits.
Example
enum Incomplete_Enums_0;
int Incomplete_Enums_2 (enum Incomplete_Enums_0 * passon)
{
return 0;
}
int Incomplete_Enums_1 (enum Incomplete_Enums_0 * passon)
{
return Incomplete_Enums_2(passon);
}
enum Incomplete_Enums_0 { ALPHA, BETA, GAMMA };
Errors
The compiler generates a warning if a label definition is followed immediately by a right brace.
Example
void foo(char *p)
{
if (p)
{
/* ... */
label:
}
}
Related concepts
5.59 New language features of C99 on page 5-228.
Related references
10.76 Pragmas on page 10-681.
Related references
8.93 --gnu on page 8-424.
1.4 Language compliance on page 1-34.
2.7 Filename suffixes recognized by the compiler on page 2-49.
14.1 Supported GNU extensions on page 14-888.
Related information
Which GNU language extensions are supported by the ARM Compiler?.
Describes compiler-specific features including ARM extensions to the C and C++ Standards, ARM-
specific pragmas and intrinsics, and predefined macros.
It contains the following sections:
• 10.1 Keywords and operators on page 10-600.
• 10.2 __align on page 10-601.
• 10.3 __ALIGNOF__ on page 10-602.
• 10.4 __alignof__ on page 10-603.
• 10.5 __asm on page 10-604.
• 10.6 __forceinline on page 10-605.
• 10.7 __global_reg on page 10-606.
• 10.8 __inline on page 10-608.
• 10.9 __int64 on page 10-609.
• 10.10 __INTADDR__ on page 10-610.
• 10.11 __irq on page 10-611.
• 10.12 __packed on page 10-612.
• 10.13 __pure on page 10-614.
• 10.14 __smc on page 10-615.
• 10.15 __softfp on page 10-616.
• 10.16 __svc on page 10-617.
• 10.17 __svc_indirect on page 10-618.
• 10.18 __svc_indirect_r7 on page 10-619.
• 10.19 __value_in_regs on page 10-620.
• 10.20 __weak on page 10-621.
• 10.21 __writeonly on page 10-623.
• 10.22 __declspec attributes on page 10-624.
Keywords
__inline __smc
10.2 __align
The __align keyword instructs the compiler to align a variable on an n-byte boundary.
__align is a storage class modifier. It does not affect the type of the function.
Syntax
__align(n)
Where:
n
is the alignment boundary.
For local variables, n can take the values 1, 2, 4, or 8.
For global variables, n can take any value up to 0x80000000 in powers of 2.
Usage
__align(n) is useful when the normal alignment of the variable being declared is less than n. Eight-byte
alignment can give a significant performance advantage with VFP instructions.
__align can be used in conjunction with extern and static.
Restrictions
Because __align is a storage class modifier, it cannot be used on:
• Types, including typedefs and structure definitions.
• Function parameters.
You can only overalign. That is, you can make a two-byte object four-byte aligned but you cannot align a
four-byte object at 2 bytes.
Example
__align(8) char buffer[128]; // buffer starts on eight-byte boundary
void foo(void)
{
...
__align(16) int i; // this alignment value is not permitted for
// a local variable
...
}
__align(16) int i; // permitted as a global variable.
Related references
10.65 __attribute__((aligned)) variable attribute on page 10-670.
8.131 --min_array_alignment=opt on page 8-464.
10.3 __ALIGNOF__
The __ALIGNOF__ keyword returns the alignment requirement for a specified type, or for the type of a
specified object.
Syntax
__ALIGNOF__(type)
__ALIGNOF__(expr)
Where:
type
is a type
expr
is an lvalue.
Return value
__ALIGNOF__(type) returns the alignment requirement for the type type, or 1 if there is no alignment
requirement.
__ALIGNOF__(expr) returns the alignment requirement for the type of the lvalue expr, or 1 if there is no
alignment requirement. The lvalue itself is not evaluated.
Example
typedef struct s_foo { int i; short j; } foo;
typedef __packed struct s_bar { int i; short j; } bar;
return __ALIGNOF(struct s_foo); // returns 4
return __ALIGNOF(foo); // returns 4
return __ALIGNOF(bar); // returns 1
Related references
8.131 --min_array_alignment=opt on page 8-464.
10.4 __alignof__ on page 10-603.
10.4 __alignof__
The __alignof__ keyword enables you to inquire about the alignment of a type or variable.
Note
This keyword is a GNU compiler extension that the ARM compiler supports.
Syntax
__alignof__(type)
__alignof__(expr)
Where:
type
is a type
expr
is an lvalue.
Return value
__alignof__(type) returns the alignment requirement for the type type, or 1 if there is no alignment
requirement.
__alignof__(expr) returns the alignment requirement for the type of the lvalue expr, or 1 if there is no
alignment requirement.
Example
int Alignment_0(void)
{
return __alignof__(int);
}
Related references
10.3 __ALIGNOF__ on page 10-602.
10.5 __asm
This keyword passes information from the compiler to the ARM assembler armasm.
The precise action of this keyword depends on its usage.
Usage
Embedded assembly
The __asm keyword can declare or define an embedded assembly function. For example:
__asm void my_strcpy(const char *src, char *dst);
Inline assembly
The __asm keyword can incorporate inline assembly into a function. For example:
int qadd(int i, int j)
{
int res;
__asm
{
QADD res, i, j
}
return res;
}
Assembly labels
The __asm keyword can specify an assembly label for a C symbol. For example:
int count __asm__("count_v1"); // export count_v1, not count
Related concepts
7.26 Embedded assembler support in the compiler on page 7-291.
7.1 Compiler support for inline assembly language on page 7-264.
Related references
10.159 Named register variables on page 10-774.
9.36 Assembler labels on page 9-586.
10.6 __forceinline
The __forceinline keyword forces the compiler to compile a C or C++ function inline.
The semantics of __forceinline are exactly the same as those of the C++ inline keyword. The
compiler attempts to inline the function regardless of its characteristics.
In some circumstances the compiler may choose to ignore the __forceinline keyword and not inline a
function. For example:
• A recursive function is never inlined into itself.
• Functions making use of alloca() are never inlined.
__forceinline is a storage class qualifier. It does not affect the type of a function.
Note
This keyword has the function attribute equivalent __attribute__((always_inline)).
Example
__forceinline static int max(int x, int y)
{
return x > y ? x : y; // always inline if possible
}
Related references
8.85 --forceinline on page 8-413.
10.32 __attribute__((always_inline)) function attribute on page 10-637.
10.7 __global_reg
The __global_reg storage class specifier causes the compiler to reserve a register for a specific global
variable.
Syntax
__global_reg(n) type varName
Where:
n
Is an integer between one and eight.
type
Is one of the following types:
• Any integer type, except long long.
• Any char type.
• Any pointer type.
varName
Is the name of a global variable.
Usage
__global_reg assigns a global variable to a specific register. It prevents the compiler from generating
code that otherwise uses the register, in the same way as the --global_reg command-line option. The
register number specified must be in the range 1-8. This corresponds to a register in the range r4 to r11.
Restrictions
If you use this storage class, you cannot use any additional storage class such as extern, static, or
typedef.
In C, global register variables cannot be qualified or initialized at declaration. In C++, any initialization
is treated as a dynamic initialization.
The number of available registers varies depending on the variant of the AAPCS being used, there are
between five and seven registers available for use as global variable registers.
In practice, ARM recommends that you do not use more than:
• Three global register variables in ARM or Thumb on a processor with Thumb-2 technology.
• One global register variable in Thumb on a processor without Thumb-2 technology.
• Half the number of available floating-point registers as global floating-point register variables.
If you declare too many global variables, code size increases significantly. In some cases, your program
might not compile.
Caution
You must take care when using global register variables because:
• There is no check at link time to ensure that direct calls between different compilation units are
sensible. If possible, define global register variables used in a program in each compilation unit of the
program. In general, it is best to place the definition in a global header file. You must set up the value
in the global register early in your code, before the register is used.
• A global register variable maps to a callee-saved register, so its value is saved and restored across a
call to a function in a compilation unit that does not use it as a global register variable, such as a
library function.
• Calls back into a compilation unit that uses a global register variable are dangerous. For example, if a
function using a global register is called from a compilation unit that does not declare the global
register variable, the function reads the wrong values from its supposed global register variables.
Examples
This example declares a global variable x and reserves r5 for it:
__global_reg(2) int x; // r5 is reserved for x
This example produces an error because global registers must be specified in all declarations of the same
variable:
int x;
__global_reg(1) int x; // error
Related references
8.92 --global_reg=reg_name[,reg_name,...] on page 8-423.
10.8 __inline
The __inline keyword suggests to the compiler that it compiles a C or C++ function inline, if it is
sensible to do so.
The semantics of __inline are exactly the same as those of the inline keyword. However, inline is
not available in C90.
__inline is a storage class qualifier. It does not affect the type of a function.
Example
__inline int f(int x)
{
return x*5+1;
}
int g(int x, int y)
{
return f(x) + f(y);
}
Related concepts
5.20 Inline functions on page 5-177.
Related references
8.85 --forceinline on page 8-413.
8.108 --inline, --no_inline on page 8-439.
10.6 __forceinline on page 10-605.
10.32 __attribute__((always_inline)) function attribute on page 10-637.
10.9 __int64
The __int64 keyword is a synonym for the keyword sequence long long.
__int64 is accepted even when using --strict.
Related references
9.12 long long on page 9-562.
8.176 --strict, --no_strict on page 8-513.
10.10 __INTADDR__
The __INTADDR__ operation treats the enclosed expression as a constant expression, and converts it to an
integer constant.
Note
This is used in the offsetof macro.
Syntax
__INTADDR(expr)
Where:
expr
is an integral constant expression.
Return value
__INTADDR__(expr) returns an integer constant equivalent to expr.
Related concepts
7.29 Restrictions on embedded assembly language functions in C and C++ code on page 7-294.
10.11 __irq
The __irq keyword enables a C or C++ function to be used as an exception handler.
__irq is a function qualifier. It affects the type of the function.
Usage
The __irq keyword causes the compiler to generate a function in a manner that makes it suitable for use
as an exception handler. This means that the compiler makes the function:
• Preserve all processor registers, not only those required to be preserved by the AAPCS. Floating-
point registers are not preserved.
• Return using an instruction that is architecturally defined as causing an exception return.
Restrictions
No arguments or return values can be used with __irq functions. __irq functions are incompatible with
--apcs /rwpi.
Note
In ARMv6-M and ARMv7-M the architectural exception handling mechanism preserves all processor
registers, and a standard function return can cause an exception return. Therefore, specifying __irq does
not affect the behavior of the compiled output. However, ARM recommends using __irq on exception
handlers for clarity and easier software porting.
Note
• For architectures that support ARM and Thumb-2 technology, for example ARMv6T2, ARMv7-A,
and ARMv7-R, functions specified as __irq compile to ARM or Thumb code depending on whether
the compile option or #pragma specify ARM or Thumb.
• For Thumb only architectures, for example ARMv6-M and ARMv7-M, functions specified as __irq
compile to Thumb code.
• For architectures before ARMv6T2, functions specified as __irq compile to ARM code even if you
compile with --thumb or #pragma thumb.
Related references
8.180 --thumb on page 8-518.
8.7 --arm on page 8-326.
10.101 #pragma thumb on page 10-708.
10.78 #pragma arm on page 10-683.
Related information
ARM, Thumb, and ThumbEE instruction sets.
Handling Processor Exceptions.
10.12 __packed
The __packed qualifier is useful to map a structure to an external data structure, or for accessing
unaligned data, but it is generally not useful to save data size because of the relatively high cost of
unaligned access.
Usage
The __packed qualifier sets the alignment of any valid type to 1.
This means that:
• There is no padding inserted to align the packed object.
• Objects of packed type are read or written using unaligned accesses.
The __packed qualifier applies to all members of a structure or union when it is declared using
__packed. There is no padding between members, or at the end of the structure. All substructures of a
packed structure must be declared using __packed. Integral subfields of an unpacked structure can be
packed individually.
Only packing fields in a structure that requires packing can reduce the number of unaligned accesses.
Note
On ARM processors that do not support unaligned access in hardware, for example, pre-ARMv6, access
to unaligned data can be costly in terms of code size and execution speed. Data accesses through packed
structures must be minimized to avoid increase in code size and performance loss.
Restrictions
The following restrictions apply to the use of __packed:
• The __packed qualifier cannot be used on structures that were previously declared without __packed.
• Unlike other type qualifiers you cannot have both a __packed and non-__packed version of the same
structure type.
• The __packed qualifier does not affect local variables of integral type.
• A packed structure or union is not assignment-compatible with the corresponding unpacked structure.
Because the structures have a different memory layout, the only way to assign a packed structure to
an unpacked structure is by a field-by-field copy.
• The effect of casting away __packed is undefined, except on char types. The effect of casting a
nonpacked structure to a packed structure, or a packed structure to a nonpacked structure, is
undefined. A pointer to an integral type that is not packed can be legally cast, explicitly or implicitly,
to a pointer to a packed integral type.
• There are no packed array types. A packed array is an array of objects of packed type. There is no
padding in the array.
Errors
Taking the address of a field in a __packed structure or a __packed-qualified field yields a __packed-
qualified pointer. The compiler produces a type error if you attempt to implicitly cast this pointer to a
non-__packed pointer. This contrasts with its behavior for address-taken fields of a #pragma packed
structure.
Examples
This example shows that a pointer can point to a packed type.
typedef __packed int* PpI; /* pointer to a __packed int */
__packed int *p; /* pointer to a __packed int */
PpI p2; /* 'p2' has the same type as 'p' */
/* __packed is a qualifier */
/* like 'const' or 'volatile' */
typedef int *PI; /* pointer to int */
__packed PI p3; /* a __packed pointer to a normal int */
This example shows that when a packed object is accessed using a pointer, the compiler generates code
that works and that is independent of the pointer alignment.
typedef __packed struct
{
char x; // all fields inherit the __packed qualifier
int y;
} X; // 5 byte structure, natural alignment = 1
int f(X *p)
{
return p->y; // does an unaligned read
}
typedef struct
{
short x;
char y;
__packed int z; // only pack this field
char a;
} Y; // 8 byte structure, natural alignment = 2
int g(Y *p)
{
return p->z + p->x; // only unaligned read for z
}
Related concepts
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
5.40 Comparisons of an unpacked struct, a __packed struct, and a struct with individually __packed
fields, and of a __packed struct and a #pragma packed struct on page 5-198.
Related references
10.60 __attribute__((packed)) type attribute on page 10-665.
10.68 __attribute__((packed)) variable attribute on page 10-673.
10.97 #pragma pack(n) on page 10-703.
11.4 Structures, unions, enumerations, and bitfields in ARM C and C++ on page 11-799.
10.13 __pure
The __pure keyword asserts that a function declaration is pure.
Usage
A function is pure only if:
• The result depends exclusively on the values of its arguments.
• The function has no side effects.
__pure is a function qualifier. It affects the type of a function.
Note
This keyword has the function attribute equivalent __attribute__((const)).
Default
By default, functions are assumed to be impure.
Restrictions
A function that is declared as pure can have no side effects. For example, pure functions:
• Cannot call impure functions.
• Cannot use global variables or dereference pointers, because the compiler assumes that the function
does not access memory, except stack memory.
• Must return the same value each time when called twice with the same parameters.
Example
int factr(int n) __pure
{
int f = 1;
while (n > 0)
f *= n--;
return f;
}
Related concepts
5.17 Functions that return the same result when called with the same arguments on page 5-174.
5.19 Recommendation of postfix syntax when qualifying functions with ARM function modifiers
on page 5-176.
Related references
5.18 Comparison of pure and impure functions on page 5-175.
10.33 __attribute__((const)) function attribute on page 10-638.
10.14 __smc
The __smc keyword declares an SMC (Secure Monitor Call) function.
Syntax
__smc(int smc_num) return-type function-name([argument-list]);
Where:
smc_num
Is a 4-bit immediate value used in the SMC instruction.
The value of smc_num is ignored by the ARM processor, but can be used by the SMC exception
handler to determine what service is being requested.
Usage
A call to the SMC function inserts an SMC instruction into the instruction stream generated by the
compiler at the point of function invocation.
Note
The SMC instruction replaces the SMI instruction used in previous versions of the ARM assembly
language.
Restrictions
The SMC instruction is available for selected ARM architecture-based processors, if they have the
Security Extensions.
The compiler generates an error if you compile source code containing the __smc keyword for an
architecture that does not support the SMC instruction.
Example
__smc(5) void mycall(void); /* declare a name by which SMC #5 can be called */
...
mycall(); /* invoke the function */
Related references
8.43 --cpu=name on page 8-368.
Related information
SMC.
10.15 __softfp
The __softfp keyword asserts that a function uses software floating-point linkage. It is implicitly added
to functions when softfp linkage is used.
__softfp is a function qualifier. It affects the type of the function.
Note
This keyword has the #pragma equivalent #pragma __softfp_linkage.
Usage
Calls to the function pass floating-point arguments in integer registers. If the result is a floating-point
value, the value is returned in integer registers. This duplicates the behavior of compilation targeting
software floating-point.
This keyword enables the same library to be used by sources compiled to use hardware and software
floating-point.
Note
In C++, if a virtual function qualified with the __softfp keyword is to be overridden, the overriding
function must also be declared as __softfp. If the functions do not match, the compiler generates an
error.
Related concepts
5.49 Compiler support for floating-point computations and linkage on page 5-212.
Related references
8.89 --fpu=name on page 8-418.
10.100 #pragma softfp_linkage, #pragma no_softfp_linkage on page 10-707.
10.47 __attribute__((pcs("calling_convention"))) function attribute on page 10-652.
10.16 __svc
The __svc keyword declares a SuperVisor Call (SVC) function taking up to four integer-like arguments
and returning up to four results in a value_in_regs structure.
__svc is a function qualifier. It affects the type of a function.
Syntax
__svc(int svc_num) return-type function-name([argument-list]);
Where:
svc_num
Is the immediate value used in the SVC instruction.
It is an expression evaluating to an integer in the range:
• 0 to 224–1 (a 24-bit value) in an ARM instruction.
• 0-255 (an 8-bit value) in a 16-bit Thumb instruction.
Usage
This causes function invocations to be compiled inline as an AAPCS-compliant operation that behaves
similarly to a normal call to a function.
You can use the __value_in_regs qualifier to specify that a small structure of up to 16 bytes is returned
in registers, rather than by the usual structure-passing mechanism defined in the AAPCS.
Errors
When an ARM architecture variant or ARM architecture-based processor that does not support an SVC
instruction is specified on the command line using the --cpu option, the compiler generates an error.
Example
__svc(42) void terminate_1(int procnum); // terminate_1 returns no results
__svc(42) int terminate_2(int procnum); // terminate_2 returns one result
typedef struct res_type
{
int res_1;
int res_2;
int res_3;
int res_4;
} res_type;
__svc(42) __value_in_regs res_type terminate_3(int procnum);
// terminate_3 returns more than
// one result
Related references
10.17 __svc_indirect on page 10-618.
10.18 __svc_indirect_r7 on page 10-619.
8.43 --cpu=name on page 8-368.
10.19 __value_in_regs on page 10-620.
Related information
SVC.
10.17 __svc_indirect
You can use __svc_indirect to implement indirect SVCs.
Syntax
__svc_indirect(int svc_num) return-type function-name(int real_num[, argument-list]);
Where:
svc_num
Is the immediate value used in the SVC instruction.
It is an expression evaluating to an integer in the range:
• 0 to 224–1 (a 24-bit value) in an ARM instruction.
• 0-255 (an 8-bit value) in a 16-bit Thumb instruction.
real_num
Is the value passed in r12 to the handler to determine the function to perform.
To use the indirect mechanism, your system handlers must make use of the r12 value to select the
required operation.
Usage
The __svc_indirect keyword passes an operation code to the SVC handler in r12.
__svc_indirect is a function qualifier. It affects the type of a function.
Errors
When an ARM architecture variant or ARM architecture-based processor that does not support an SVC
instruction is specified on the command line using the --cpu option, the compiler generates an error.
Example
int __svc_indirect(0) ioctl(int svcino, int fn, void *argp);
Calling:
ioctl(IOCTL+4, RESET, NULL);
Related references
10.16 __svc on page 10-617.
10.18 __svc_indirect_r7 on page 10-619.
8.43 --cpu=name on page 8-368.
10.19 __value_in_regs on page 10-620.
Related information
SVC.
10.18 __svc_indirect_r7
The __svc_indirect_r7 keyword behaves like __svc_indirect, but uses r7 instead of r12.
__svc_indirect_r7 is a function qualifier. It affects the type of a function.
Syntax
__svc_indirect_r7(int svc_num) return-type function-name(int real_num[, argument-
list]);
Where:
svc_num
Is the immediate value used in the SVC instruction.
It is an expression evaluating to an integer in the range:
• 0 to 224–1 (a 24-bit value) in an ARM instruction.
• 0-255 (an 8-bit value) in a 16-bit Thumb instruction.
real_num
Is the value passed in r7 to the handler to determine the function to perform.
Usage
Thumb applications on ARM Linux use __svc_indirect_r7 to make kernel syscalls.
You can also use this feature to implement indirect SVCs.
Example
long __svc_indirect_r7(0) \
SVC_write(unsigned, int fd, const char * buf, size_t count);
#define write(fd, buf, count) SVC_write(4, (fd), (buf), (count))
Calling:
write(fd, buf, count);
Errors
When an ARM architecture variant or ARM architecture-based processor that does not support an SVC
instruction is specified on the command line using the --cpu option, the compiler generates an error.
Related references
10.16 __svc on page 10-617.
10.17 __svc_indirect on page 10-618.
8.43 --cpu=name on page 8-368.
10.19 __value_in_regs on page 10-620.
Related information
SVC.
10.19 __value_in_regs
The __value_in_regs qualifier instructs the compiler to return a structure of up to four integer words in
integer registers or up to four floats or doubles in floating-point registers rather than using memory.
__value_in_regs is a function qualifier. It affects the type of a function.
Syntax
__value_in_regs return-type function-name([argument-list]);
Where:
return-type
is the type of a structure of up to four words in size.
Usage
Declaring a function __value_in_regs can be useful when calling functions that return more than one
result.
Restrictions
A C++ function cannot return a __value_in_regs structure if the structure requires copy constructing.
If a virtual function declared as __value_in_regs is to be overridden, the overriding function must also
be declared as __value_in_regs. If the functions do not match, the compiler generates an error.
Errors
Where the structure returned in a function qualified by __value_in_regs is too big, a warning is
produced and the __value_in_regs structure is then ignored.
Example
typedef struct int64_struct
{
unsigned int lo;
unsigned int hi;
} int64_struct;
__value_in_regs extern
int64_struct mul64(unsigned a, unsigned b);
Related concepts
5.16 Returning structures from functions through registers on page 5-173.
10.20 __weak
This keyword instructs the compiler to export symbols weakly.
The __weak keyword can be applied to function and variable declarations, and to function definitions.
Usage
Functions and variable declarations
For declarations, this storage class specifies an extern object declaration that, even if not
present, does not cause the linker to fault an unresolved reference.
For example:
__weak void f(void);
...
f(); // call f weakly
If the reference to a missing weak function is made from code that compiles to a branch or
branch link instruction, then either:
• The reference is resolved as branching to the next instruction. This effectively makes the
branch a NOP.
• The branch is replaced by a NOP instruction.
Function definitions
Functions defined with __weak export their symbols weakly. A weakly defined function behaves
like a normally defined function unless a nonweakly defined function of the same name is
linked into the same image. If both a nonweakly defined function and a weakly defined function
exist in the same image then all calls to the function resolve to call the nonweak function. If
multiple weak definitions are available, the linker generates an error message, unless the linker
option --muldefweak is used. In this case, the linker chooses one for use by all calls.
Functions declared with __weak and then defined without __weak behave as nonweak functions.
Restrictions
There are restrictions when you qualify function and variable declarations, and function definitions, with
__weak.
It is not possible to use a function or variable weakly from the same compilation that defines the
function or variable. The following code uses f() nonweakly from h():
__weak void f(void);
void h()
{
f();
}
void f() {}
The linker does not load the function or variable from a library unless another compilation uses
the function or variable nonweakly. If the reference remains unresolved, its value is assumed to
be NULL. Unresolved references, however, are not NULL if the reference is from code to a
position-independent section or to a missing __weak function.
Function definitions
Weakly defined functions cannot be inlined.
Example
__weak const int c; // assume 'c' is not present in final link
const int *f1() { return &c; } // '&c' returns non-NULL if
// compiled and linked /ropi
__weak int i; // assume 'i' is not present in final link
int *f2() { return &i; } // '&i' returns non-NULL if
// compiled and linked /rwpi
__weak void f(void); // assume 'f' is not present in final link
typedef void (*FP)(void);
FP g() { return f; } // 'g' returns non-NULL if
// compiled and linked /ropi
Related information
--muldefweak, --no_muldefweak linker option.
10.21 __writeonly
The __writeonly type qualifier indicates that a data object cannot be read from.
In the C and C++ type system it behaves as a cv-qualifier like const or volatile. Its specific effect is
that an lvalue with __writeonly type cannot be converted to an rvalue.
Assignment to a __writeonly bitfield is not allowed if the assignment is implemented as read-modify-
write. This is implementation-dependent.
Example
void foo(__writeonly int *ptr)
{
*ptr = 0; // allowed
printf("ptr value = %d\n", *ptr); // error
}
The following table summarizes the available __declspec attributes. __declspec attributes are storage
class modifiers. They do not affect the type of a function or variable.
Table 10-2 __declspec attributes that the compiler supports, and their equivalents
__declspec(dllexport) -
__declspec(dllimport) -
__declspec(noinline) __attribute__((noinline))
__declspec(noreturn) __attribute__((noreturn))a
__declspec(nothrow) -
__declspec(notshared) -
__declspec(thread) -
10.23 __declspec(dllexport)
The __declspec(dllexport) attribute exports the definition of a symbol through the dynamic symbol
table when building DLL libraries. On classes, it controls the visibility of class impedimenta such as
vtables, construction vtables and RTTI, and sets the default visibility for member function and static data
members.
Usage
You can use __declspec(dllexport) on a function, a class, or on individual members of a class.
When an inline function is marked __declspec(dllexport), the function definition might be inlined,
but an out-of-line instance of the function is always generated and exported in the same way as for a non-
inline function.
When a class is marked __declspec(dllexport), for example, class __declspec(dllexport) S
{ ... }; its static data members and member functions are all exported. When individual static data
members and member functions are marked with __declspec(dllexport), only those members are
exported. vtables, construction vtable tables and RTTI are also exported.
Note
The following declaration is correct:
class __declspec(dllexport) S { ... };
Restrictions
If you mark a class with __declspec(dllexport), you cannot then mark individual members of that
class with __declspec(dllexport).
If you mark a class with __declspec(dllexport), ensure that all of the base classes of that class are
marked __declspec(dllexport).
If you export a virtual function within a class, ensure that you either export all of the virtual functions in
that class, or that you define them inline so that they are visible to the client.
Example
The __declspec() required in a declaration depends on whether or not the definition is in the same
shared library.
/* This is the declaration for use in the same shared library as the */
/* definition */
__declspec(dllexport) extern int mymod_get_version(void);
/* Translation unit containing the definition */
__declspec(dllexport) extern int mymod_get_version(void)
{
return 42;
}
/* This is the declaration for use in a shared library that does not contain */
/* the definition */
__declspec(dllimport) extern int mymod_get_version(void);
As a result of the following macro, a translation unit that does not have the definition in a defining link
unit sees __declspec(dllexport).
/* mymod.h - interface to my module */
#ifdef BUILDING_MYMOD
#define MYMOD_API __declspec(dllexport)
#else /* not BUILDING_MYMOD */
#define MYMOD_API __declspec(dllimport)
#endif
MYMOD_API int mymod_get_version(void);
Related references
10.24 __declspec(dllimport) on page 10-627.
10.28 __declspec(notshared) on page 10-631.
8.79 --export_all_vtbl, --no_export_all_vtbl on page 8-407.
8.196 --visibility_inlines_hidden on page 8-538.
Related information
--use_definition_visibility linker option.
10.24 __declspec(dllimport)
The __declspec(dllimport) attribute imports a symbol through the dynamic symbol table when
linking against DLL libraries.
Usage
When an inline function is marked __declspec(dllimport), the function definition in this compilation
unit might be inlined, but is never generated out-of-line. An out-of-line call or address reference uses the
imported symbol.
__declspec(dllimport) requires the function, variable, or class to have external linkage. You can only
use __declspec(dllimport) on functions, variables, and classes with external linkage.
When a class is marked __declspec(dllimport), its static data members and member functions are all
imported. When individual static data members and member functions are marked with
__declspec(dllimport), only those members are imported.
Restrictions
If you mark a class with __declspec(dllimport), you cannot then mark individual members of that
class with __declspec(dllimport).
Example
__declspec(dllimport) int i;
class __declspec(dllimport) X { void f(); };
Related references
10.23 __declspec(dllexport) on page 10-625.
10.25 __declspec(noinline)
The __declspec(noinline) attribute suppresses the inlining of a function at the call points of the
function.
__declspec(noinline) can also be applied to constant data, to prevent the compiler from using the
value for optimization purposes, without affecting its placement in the object. This is a feature that can
be used for patchable constants, that is, data that is later patched to a different value. It is an error to try
to use such constants in a context where a constant value is required. For example, an array dimension.
Note
This __declspec attribute has the function attribute equivalent __attribute__((noinline)).
Example
/* Prevent y being used for optimization */
__declspec(noinline) const int y = 5;
/* Suppress inlining of foo() wherever foo() is called */
__declspec(noinline) int foo(void);
Related references
10.40 __attribute__((noinline)) function attribute on page 10-645.
10.67 __attribute__((noinline)) constant variable attribute on page 10-672.
10.91 #pragma inline, #pragma no_inline on page 10-697.
10.26 __declspec(noreturn)
Informs the compiler that the function does not return. The compiler can then perform optimizations by
removing code that is never reached.
Note
This attribute has the GNU-style equivalent __attribute__((noreturn)).
If the function reaches an explicit or implicit return, __declspec(noreturn) is ignored and the compiler
generates a warning:
Warning: #1461-D: function declared with "noreturn" does return
Usage
Use this attribute to reduce the cost of calling a function that never returns, such as exit().
Best practice is to always terminate non-returning functions with while(1);.
Example
__declspec(noreturn) void overflow(void); // called on overflow
int negate(int x)
{
if (x == 0x80000000) overflow();
return -x;
}
void overflow(void)
{
__asm {
SVC 0x123; // hypothetical exception-throwing system service
}
while (1);
}
Related references
10.44 __attribute__((noreturn)) function attribute on page 10-649.
10.27 __declspec(nothrow)
The __declspec(nothrow) attribute asserts that a call to a function never results in a C++ exception
being propagated from the callee into the caller.
The ARM library headers automatically add this qualifier to declarations of C functions that, according
to the ISO C Standard, can never throw an exception. However, there are some restrictions on the
unwinding tables produced for the C library functions that might throw an exception in a C++ context,
for example, bsearch and qsort.
Note
This __declspec attribute has the function attribute equivalent __attribute__((nothrow)).
Usage
If the compiler knows that a function can never throw an exception, it might be able to generate smaller
exception-handling tables for callers of that function.
Restrictions
If a call to a function results in a C++ exception being propagated from the callee into the caller, the
behavior is undefined.
This modifier is ignored when not compiling with exceptions enabled.
Example
struct S
{
~S();
};
__declspec(nothrow) extern void f(void);
void g(void)
{
S s;
f();
}
Related references
8.84 --force_new_nothrow, --no_force_new_nothrow on page 8-412.
11.5 Using the ::operator new function in ARM C++ on page 11-805.
10.46 __attribute__((nothrow)) function attribute on page 10-651.
10.28 __declspec(notshared)
The __declspec(notshared) attribute prevents a specific class from having its virtual functions table
and RTTI exported.
This holds true regardless of other options you apply. For example, the use of --export_all_vtbl does
not override __declspec(notshared).
Example
struct __declspec(notshared) X
{
virtual int f();
}; // do not export this
int X::f()
{
return 1;
}
struct Y : X
{
virtual int g();
}; // do export this
int Y::g()
{
return 1;
}
10.29 __declspec(thread)
The __declspec(thread) attribute asserts that variables are thread-local and have thread storage
duration, so that the linker arranges for the storage to be allocated automatically when a thread is created.
Note
The keyword __thread is supported as a synonym for __declspec(thread).
Restrictions
File-scope thread-local variables cannot be dynamically initialized.
Example
__declspec(thread) int i;
__thread int j; // same as __decspec(thread) int j;
For example:
void * Function_Attributes_malloc_0(int b) __attribute__((malloc));
static int b __attribute__((__unused__));
Table 10-3 Function attributes that the compiler supports, and their equivalents
__attribute__((alias)) -
__attribute__((always_inline)) __forceinline
__attribute__((const)) __pure
__attribute__((constructor[(priority)])) -
__attribute__((deprecated)) -
__attribute__((destructor[(priority)])) -
__attribute__((format_arg(string-index))) -
__attribute__((malloc)) -
__attribute__((noinline)) __declspec(noinline)
__attribute__((no_instrument_function)) -
__attribute__((nomerge)) -
__attribute__((nonnull)) -
__attribute__((noreturn)) __declspec(noreturn))
__attribute__((notailcall)) -
__attribute__((nothrow)) __declspec(nothrow))
__attribute__((pcs("calling_convention"))) -
__attribute__((pure)) -
__attribute__((section("name"))) -
__attribute__((unused)) -
__attribute__((used)) -
__attribute__((visibility("visibility_type"))) -
__attribute__((weak)) __weak
__attribute__((weakref("target"))) -
Usage
You can set these function attributes in the declaration, the definition, or both. For example:
void AddGlobals(void) __attribute__((always_inline));
__attribute__((always_inline)) void AddGlobals(void) {...}
When function attributes conflict, the compiler uses the safer or stronger one. For example,
__attribute__((used)) is safer than __attribute__((unused)), and __attribute__((noinline))
is safer than __attribute__((always_inline)).
Note
You cannot specify aliases in block scope. The compiler ignores aliasing attributes attached to local
function definitions and treats the function definition as a normal local definition.
In the output object file, the compiler replaces alias calls with a call to the original function name, and
emits the alias alongside the original name. For example:
static int oldname(int x, int y) {
return x + y;
}
static int newname(int x, int y) __attribute__((alias("oldname")));
int caller(int x, int y) {
return oldname(x,y) + newname(x,y);
}
Note
This function attribute is a GNU compiler extension that the ARM compiler supports.
Note
Variables names might also be aliased using the corresponding variable attribute
__attribute__((alias)).
Syntax
return-type newname([argument-list]) __attribute__((alias("oldname")));
Where:
oldname
is the name of the function to be aliased
newname
is the new name of the aliased function.
Example
#include <stdio.h>
void foo(void)
{
printf("%s\n", __FUNCTION__);
}
void bar(void) __attribute__((alias("foo")));
void gazonk(void)
{
bar(); // calls foo
}
Related references
10.63 __attribute__((alias)) variable attribute on page 10-668.
Note
This function attribute is a GNU compiler extension that the ARM compiler supports. It has the keyword
equivalent __forceinline.
Example
static int max(int x, int y) __attribute__((always_inline));
static int max(int x, int y)
{
return x > y ? x : y; // always inline if possible
}
Related references
8.85 --forceinline on page 8-413.
10.6 __forceinline on page 10-605.
Note
This function attribute is a GNU compiler extension that the ARM compiler supports. It has the keyword
equivalent __pure.
Example
#include <stdio.h>
int main(void) {
int i;
int result;
for (i = 0; i < 10; i++)
{
result = my_double(i);
printf (" i = %d ; result = %d \n", i, result);
}
}
Related concepts
5.17 Functions that return the same result when called with the same arguments on page 5-174.
Related references
10.48 __attribute__((pure)) function attribute on page 10-653.
Note
This attribute is a GNU compiler extension that the ARM compiler supports.
Syntax
__attribute__((constructor[(priority)]))
Where priority is an optional integer value denoting the priority. A constructor with a low integer
value runs before a constructor with a high integer value. A constructor with a priority runs before a
constructor without a priority.
Priority values up to and including 100 are reserved for internal use. If you use these values, the compiler
gives a warning. Priority values above 100 are not reserved.
Usage
You can use this attribute for start-up or initialization code. For example, to specify a function that is to
be called when a DLL is loaded.
This attribute can be preferable to the linker option --init=symbol if you are using GNU makefiles
unmodified to build with the ARM compiler. That is, if you are using --translate_gcc,
--translate_gld, or --translate_g++.
Example
In the following example, the constructor functions are called before execution enters main(), in the
order specified:
int my_constructor(void) __attribute__((constructor));
int my_constructor2(void) __attribute__((constructor(101)));
int my_constructor3(void) __attribute__((constructor(102)));
int my_constructor(void) /* This is the 3rd constructor */
{ /* function to be called */
...
return 0;
}
int my_constructor2(void) /* This is the 1st constructor */
{ /* function to be called */
...
return 0;
}
int my_constructor3(void) /* This is the 2nd constructor */
{ /* function to be called */
...
return 0;
}
Related references
8.181 --translate_g++ on page 8-519.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
Related information
--init=symbol linker option.
Note
This function attribute is a GNU compiler extension that the ARM compiler supports.
In GNU mode, this attribute takes an optional string parameter to appear in the message,
__attribute__((deprecated("message")))
Example
int Function_Attributes_deprecated_0(int b) __attribute__((deprecated));
Note
This attribute is a GNU compiler extension that the ARM compiler supports.
Syntax
__attribute__((destructor[(priority)]))
Where priority is an optional integer value denoting the priority. A destructor with a high integer value
runs before a destructor with a low value. A destructor with a priority runs before a destructor without a
priority.
Priority values up to and including 100 are reserved for internal use. If you use these values, the compiler
gives a warning. Priority values above 100 are not reserved.
Usage
This attribute can be preferable to the linker option --fini=symbol if you are using GNU makefiles
unmodified to build with the ARM compiler. That is, if you are using --translate_gcc,
--translate_gld, or --translate_g++.
Example
int my_destructor(void) __attribute__((destructor));
int my_destructor(void) /* This function is called after main() */
{ /* completes or after exit() is called. */
...
return 0;
}
Related references
8.181 --translate_g++ on page 8-519.
8.182 --translate_gcc on page 8-521.
8.183 --translate_gld on page 8-523.
Related information
--fini=symbol linker option.
Syntax
__attribute__((format(function, string-index, first-to-check)))
string-index specifies the index of the string argument in your function (starting from one).
first-to-check is the index of the first argument to check against the format string.
Example
#include <stdio.h>
extern char *myFormatText1 (const char *, ...);
extern char *myFormatText2 (const char *, ...) __attribute__((format(printf, 1, 2)));
int main(void) {
int a, b;
float c;
a = 5;
b = 6;
c = 9.099999;
myFormatText1("Here are some integers: %d , %d\n", a, b); // No type checking. Types match.
myFormatText1("Here are some integers: %d , %d\n", a, c); // No type checking. Type
mismatch, but no warning.
myFormatText2("Here are some integers: %d , %d\n", a, b); // Type checking. Types match.
myFormatText2("Here are some integers: %d , %d\n", a, c); // Type checking. Warning: 181-D:
argument is incompatible...
}
myFormatText1() is a function that is given a string and two arguments to print. It has no format
checking, so when it is passed a float argument and the function is expecting an integer, there is a silent
type-mismatch.
myFormatText2() is identical to myFormatText1(), except it has __attribute__((format())). When
it receives an argument of an unexpected type, it raises a warning message.
This attribute causes the compiler to perform placeholder type checking on the specified argument when
the output of the function is used in calls to a printf-style function.
Note
This function attribute is a GNU compiler extension that the ARM compiler supports.
Syntax
__attribute__((format_arg(string-index)))
Where string-index specifies the argument that is the format string argument (starting from one).
Example
The following example declares two functions, myFormatText1() and myFormatText2(), that provide
format strings to printf().
The first function, myFormatText1(), does not specify the format_arg attribute. The compiler does not
check the types of the printf arguments for consistency with the format string.
The second function, myFormatText2(), specifies the format_arg attribute. In the subsequent calls to
printf(), the compiler checks that the types of the supplied arguments a and b are consistent with the
format string argument to myFormatText2(). The compiler produces a warning when a float is
provided where an int is expected.
#include <stdio.h>
int main(void) {
int a;
float b;
a = 5;
b = 9.099999;
$ armcc format_arg_test.c -c
"format_arg_test.c", line 18: Warning: #181-D: argument is incompatible with corresponding
format string conversion
printf(myFormatText2("Here is an integer: %d\n"), b);
^
format_arg_test.c: 1 warning, 0 errors
Example
void * foo(int b) __attribute__((malloc));
Note
This function attribute is a GNU compiler extension that the ARM compiler supports. It has the
__declspec equivalent __declspec(noinline).In GNU mode, if this attribute is applied to a type
instead of a function, the result is a warning rather than an error.
Example
int fn(void) __attribute__((noinline));
int fn(void)
{
return 42;
}
Related references
10.67 __attribute__((noinline)) constant variable attribute on page 10-672.
10.91 #pragma inline, #pragma no_inline on page 10-697.
10.25 __declspec(noinline) on page 10-628.
Note
The --gnu_instrument option and this function attribute are deprecated from ARM Compiler 5.05
onwards.
Related references
8.95 --gnu_instrument, --no_gnu_instrument on page 8-426.
Related references
10.45 __attribute__((notailcall)) function attribute on page 10-650.
8.165 --retain=option on page 8-501.
Syntax
__attribute__((nonnull[(arg-index, ...)]))
Examples
The following declarations are equivalent:
void * my_memcpy (void *dest, const void *src, size_t len) __attribute__((nonnull (1, 2)));
void * my_memcpy (void *dest, const void *src, size_t len) __attribute__((nonnull));
Note
This function attribute is a GNU compiler extension that the ARM compiler supports. It has the
__declspec equivalent __declspec(noreturn).
If the function reaches an explicit or implicit return, __attribute__((noreturn)) is ignored and the
compiler generates a warning:
Warning: #1461-D: function declared with "noreturn" does return
Usage
Use this attribute to reduce the cost of calling a function that never returns, such as exit().
Best practice is to always terminate non-returning functions with while(1);.
Example
void overflow(void) __attribute__((noreturn)); // called on overflow
int negate(int x)
{
if (x == 0x80000000) overflow();
return -x;
}
void overflow(void)
{
__asm {
SVC 0x123; // hypothetical exception-throwing system service
}
while (1);
}
Related references
10.26 __declspec(noreturn) on page 10-629.
Related references
10.42 __attribute__((nomerge)) function attribute on page 10-647.
8.165 --retain=option on page 8-501.
Note
This function attribute is a GNU compiler extension that the ARM compiler supports. It has the
__declspec equivalent __declspec(nothrow).
Example
struct S
{
~S();
};
extern void f(void) __attribute__((nothrow));
void g(void)
{
S s;
f();
}
Note
This function attribute is a GNU compiler extension that the ARM compiler supports.
Syntax
__attribute__((pcs("calling_convention")))
Related concepts
5.49 Compiler support for floating-point computations and linkage on page 5-212.
Related references
10.15 __softfp on page 10-616.
Note
This function attribute is a GNU compiler extension that the ARM compiler supports.
Although related, this function attribute is not equivalent to the __pure keyword. The function attribute
equivalent to __pure is __attribute__((const)).
Example
int Function_Attributes_pure_0(int b) __attribute__((pure));
int Function_Attributes_pure_0(int b)
{
return b++;
}
int foo(int b)
{
int aLocal=0;
aLocal += Function_Attributes_pure_0(b);
aLocal += Function_Attributes_pure_0(b);
return 0;
}
The call to Function_Attributes_pure_0 in this example might be eliminated because its result is not
used.
Related concepts
5.17 Functions that return the same result when called with the same arguments on page 5-174.
Related references
10.33 __attribute__((const)) function attribute on page 10-638.
Note
This function attribute is a GNU compiler extension that the ARM compiler supports.
Examples
In the following example, Function_Attributes_section_0 is placed into the RO section
new_section rather than .text.
In the following example, section function attribute overrides the #pragma arm section setting.
#pragma arm section code="foo"
int f2()
{
return 1;
} // into the 'foo' area
__attribute__((section ("bar"))) int f3()
{
return 1;
} // into the 'bar' area
int f4()
{
return 1;
} // into the 'foo' area
#pragma arm section
Related references
10.79 #pragma arm section [section_type_list] on page 10-684.
Syntax
__attribute__ ((sentinel(p)))
Where:
p
is an optional integer position argument. If this argument is supplied, the compiler checks the
parameter at position p counting backwards from the end of the argument list.
By default, the compiler checks the parameter at position zero, the last parameter of the function
call. That is, __attribute__ ((sentinel)) is equivalent to __attribute__
((sentinel(0)))
Note
This function attribute is a GNU compiler extension that the ARM compiler supports.
Example
static int Function_Attributes_unused_0(int b) __attribute__((unused));
Example
static int lose_this(int);
static int keep_this(int) __attribute__((used)); // retained in object file
static int keep_this_too(int) __attribute__((used)); // retained in object file
Related references
10.71 __attribute__((used)) variable attribute on page 10-676.
10.49 __attribute__((section("name"))) function attribute on page 10-654.
Related information
Elimination of unused sections.
Note
This attribute is a GNU compiler extension that the ARM compiler supports.
Syntax
__attribute__((visibility("visibility_type")))
Usage
Except when specifying default visibility, this attribute is intended for use with declarations that would
otherwise have external linkage.
You can apply this attribute to functions and variables in C and C++. In C++, it can also be applied to
class, struct, union, and enum types, and namespace declarations.
Example
void __attribute__((visibility("internal"))) foo()
{
...
}
Related references
10.72 __attribute__((visibility("visibility_type"))) variable attribute on page 10-677.
8.8 --arm_linux on page 8-327.
8.196 --visibility_inlines_hidden on page 8-538.
8.99 --hide_all, --no_hide_all on page 8-430.
10.54 __attribute__((warn_unused_result))
In GNU-mode, warn if a function returns a result that is never used.
Example
extern int Function_Attributes_weak_0 (int b) __attribute__((weak));
Related references
10.73 __attribute__((weak)) variable attribute on page 10-678.
10.20 __weak on page 10-621.
Syntax
__attribute__((weakref("target")))
Example
In the following example, foo() calls y() through a weak reference:
extern void y(void);
static void x(void) __attribute__((weakref("y")));
void foo (void)
{
...
x();
...
}
Restrictions
This attribute can only be used on functions with static linkage.
For example:
void * Function_Attributes_malloc_0(int b) __attribute__((malloc));
static int b __attribute__((__unused__));
Table 10-4 Type attributes that the compiler supports, and their equivalents
__attribute__((bitband)) -
__attribute__((aligned)) __align
__attribute__((packed)) __packedb
__attribute__((transparent_union)) -
For peripherals that are sensitive to the memory access width, byte, halfword, and word stores or loads to
the alias space are generated for char, short, and int types of bitfields of bit-banded structs
respectively.
In the following example, bit-banded access is generated for bb.i.
typedef struct {
char i : 1;
int j : 2;
int k : 3;
} BB __attribute__((bitband));
BB bb __attribute__((at(0x20000004)));
void foo()
{
bb.i = 1;
}
If you do not use __attribute__((at())) to place the bit-banded variable in the bit-band region, you
must relocate it using another method. You can do this by either using an appropriate scatter-loading
description file or by using the --rw_base linker command-line option. See the Linker Reference for
more information.
Restrictions
The following restrictions apply:
• This type attribute can only be used with struct. Any union type or other aggregate type with a
union as a member cannot be bit-banded.
• Members of structs cannot be bit-banded individually.
• Bit-banded accesses are only generated for single-bit bitfields.
• Bit-banded accesses are not generated for const objects, pointers, and local objects.
• Bit-banding is only available on some processors. For example, the Cortex-M3 and Cortex-M4
processors.
Related references
8.17 --bitband on page 8-339.
10.64 __attribute__((at(address))) variable attribute on page 10-669.
Related information
--rw_base=address (linker option).
Note
This type attribute is a GNU compiler extension that the ARM compiler supports.
In non-GNU mode, this attribute is equivalent to __packed, and has stronger constraints than when used
in GNU-mode.
Errors
Taking the address of a field with the packed attribute or in a structure with the packed attribute yields a
__packed-qualified pointer. The compiler produces a type error if you attempt to implicitly cast this
pointer to a non-__packed pointer. This contrasts with its behavior for address-taken fields of a #pragma
packed structure.
The compiler generates a warning message if you use this attribute in a typedef.
Related concepts
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
5.40 Comparisons of an unpacked struct, a __packed struct, and a struct with individually __packed
fields, and of a __packed struct and a #pragma packed struct on page 5-198.
Related references
8.93 --gnu on page 8-424.
10.68 __attribute__((packed)) variable attribute on page 10-673.
10.97 #pragma pack(n) on page 10-703.
10.12 __packed on page 10-612.
11.4 Structures, unions, enumerations, and bitfields in ARM C and C++ on page 11-799.
Mode
Supported in GNU mode only.
Example
typedef union { int i; float f; } U __attribute__((transparent_union));
void foo(U u)
{
static int s;
s += u.i; /* Use the 'int' field */
}
void caller(void)
{
foo(1); /* u.i is set to 1 */
foo(1.0f); /* u.f is set to 1.0f */
}
For example:
void * Function_Attributes_malloc_0(int b) __attribute__((malloc));
static int b __attribute__((__unused__));
Table 10-5 Variable attributes that the compiler supports, and their equivalents
Syntax
type newname __attribute__((alias("oldname")));
Where:
oldname
is the name of the variable to be aliased
newname
is the new name of the aliased variable.
Usage
Aliases must be defined in the same translation unit as the original variable.
Note
You cannot specify aliases in block scope. The compiler ignores aliasing attributes attached to local
variable definitions and treats the variable definition as a normal local definition.
In the output object file, the compiler replaces alias references with a reference to the original variable
name, and emits the alias alongside the original name. For example:
int oldname = 1;
extern int newname __attribute__((alias("oldname")));
If the original variable is defined as static but the alias is defined as extern, then the compiler changes
the original variable to be external.
Note
Function names might also be aliased using the corresponding function attribute
__attribute__((alias)).
Example
#include <stdio.h>
int oldname = 1;
extern int newname __attribute__((alias("oldname"))); // declaration
void foo(void)
{
printf("newname = %d\n", newname); // prints 1
}
Related references
10.31 __attribute__((alias)) function attribute on page 10-635.
Syntax
__attribute__((at(address)))
Where:
address
is the desired address of the variable.
Usage
The variable is placed in its own section, and the section containing the variable is given an appropriate
type by the compiler:
• Read-only variables are placed in a section of type RO.
• Initialized read-write variables are placed in a section of type RW.
Variables explicitly initialized to zero are placed in:
— A section of type ZI in RVCT 4.0 and later.
— A section of type RW (not ZI) in RVCT 3.1 and earlier. Such variables are not candidates for the
ZI-to-RW optimization of the compiler.
• Uninitialized variables are placed in a section of type ZI.
Note
GNU compilers do not support this variable attribute.
Restrictions
The linker is not always able to place sections produced by the at variable attribute.
The compiler faults use of the at attribute when it is used on declarations with incomplete types.
Errors
The linker gives an error message if it is not possible to place a section at a specified address.
Example
const int x1 __attribute__((at(0x10000))) = 10; /* RO */
int x2 __attribute__((at(0x12000))) = 10; /* RW */
int x3 __attribute__((at(0x14000))) = 0; /* RVCT 3.1 and earlier: RW.
* RVCT 4.0 and later: ZI. */
int x4 __attribute__((at(0x16000))); /* ZI */
Related information
Placement of __at sections at a specific address.
Note
This variable attribute is a GNU compiler extension that the ARM compiler supports.
Example
/* Aligns on 16-byte boundary */
int x __attribute__((aligned (16)));
/* In this case, the alignment used is the maximum alignment for a scalar data type. For
ARM, this is 8 bytes. */
short my_array[3] __attribute__((aligned));
Related references
10.2 __align on page 10-601.
Example
extern int Variable_Attributes_deprecated_0 __attribute__((deprecated));
extern int Variable_Attributes_deprecated_1 __attribute__((deprecated));
void Variable_Attributes_deprecated_2()
{
Variable_Attributes_deprecated_0=1;
Variable_Attributes_deprecated_1=2;
}
Example
__attribute__((noinline)) const int m = 1;
Related references
10.40 __attribute__((noinline)) function attribute on page 10-645.
10.91 #pragma inline, #pragma no_inline on page 10-697.
10.25 __declspec(noinline) on page 10-628.
Example
struct
{
char a;
int b __attribute__((packed));
} Variable_Attributes_packed_0;
Related concepts
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
5.40 Comparisons of an unpacked struct, a __packed struct, and a struct with individually __packed
fields, and of a __packed struct and a #pragma packed struct on page 5-198.
Related references
10.60 __attribute__((packed)) type attribute on page 10-665.
10.97 #pragma pack(n) on page 10-703.
10.12 __packed on page 10-612.
11.4 Structures, unions, enumerations, and bitfields in ARM C and C++ on page 11-799.
Example
/* in RO section */
const int descriptor[3] __attribute__((section ("descr"))) = { 1,2,3 };
/* in RW section */
long long rw_initialized[10] __attribute__((section ("INITIALIZED_RW"))) = {5};
/* in RW section */
long long rw[10] __attribute__((section ("RW")));
/* in ZI section */
long long altstack[10] __attribute__((section ("STACK"), zero_init));
Related information
How to find where a symbol is placed when linking.
Note
This variable attribute is a GNU compiler extension that the ARM compiler supports.
Example
void Variable_Attributes_unused_0()
{
static int aStatic =0;
int aUnused __attribute__((unused));
int bUnused;
aStatic++;
}
In this example, the compiler warns that bUnused is declared but never referenced, but does not warn
about aUnused.
Note
The GNU compiler does not give any warning.
Usage
Static variables marked as used are emitted to a single section, in the order they are declared. You can
specify the section that variables are placed in using __attribute__((section("name"))).
Data marked with __attribute__((used)) is tagged in the object file to avoid removal by linker
unused section removal.
Note
This variable attribute is a GNU compiler extension that the ARM compiler supports.
Note
Static functions can also be marked as used using __attribute__((used)).
Example
static int lose_this = 1;
static int keep_this __attribute__((used)) = 2; // retained in object file
static int keep_this_too __attribute__((used)) = 3; // retained in object file
Related references
10.52 __attribute__((used)) function attribute on page 10-657.
10.49 __attribute__((section("name"))) function attribute on page 10-654.
Related information
Elimination of unused sections.
Note
This attribute is a GNU compiler extension that the ARM compiler supports.
Syntax
__attribute__((visibility("visibility_type")))
Usage
Except when specifying default visibility, this attribute is intended for use with declarations that would
otherwise have external linkage.
You can apply this attribute to functions and variables in C and C++. In C++, you can also apply it to
class, struct, union, and enum types, and namespace declarations.
Example
int i __attribute__((visibility("hidden")));
Related references
10.53 __attribute__((visibility("visibility_type"))) function attribute on page 10-658.
8.8 --arm_linux on page 8-327.
8.196 --visibility_inlines_hidden on page 8-538.
8.99 --hide_all, --no_hide_all on page 8-430.
Note
The extern qualifier is required in GNU mode. In non-GNU mode the compiler assumes that if the
variable is not extern then it is treated like any other non weak variable.
Note
This variable attribute is a GNU compiler extension that the ARM compiler supports.
Related references
10.55 __attribute__((weak)) function attribute on page 10-660.
10.20 __weak on page 10-621.
Note
This variable attribute is a GNU compiler extension that the ARM compiler supports.
Syntax
__attribute__((weakref("target")))
Restrictions
This attribute can only be used on variables that are declared as static.
Example
In the following example, a is assigned the value of y through a weak reference:
extern int y;
static int x __attribute__((weakref("y")));
void foo (void)
{
int a = x;
...
}
Example
__attribute__((zero_init)) int x; /* in section ".bss" */
__attribute__((section("mybss"), zero_init)) int y; /* in section "mybss" */
Related references
10.49 __attribute__((section("name"))) function attribute on page 10-654.
10.76 Pragmas
The ARM compiler recognizes a number of ARM-specific pragmas
Note
Pragmas override related command-line options. For example, #pragma arm overrides the command-line
option --thumb.
Pragmas
#pragma diag_error tag[,tag,...] #pragma inline, #pragma no_inline #pragma unroll [(n)]
Default
The default is #pragma no_anon_unions.
Related references
9.35 Anonymous classes, structures and unions on page 9-585.
10.61 __attribute__((transparent_union)) type attribute on page 10-666.
Usage
Use #pragma push and #pragma pop on #pragma arm or #pragma thumb outside of functions, but not
inside of them, to change state. This is because #pragma arm and #pragma thumb only apply at the
function level. Instead, put them around the function definition.
Related references
10.98 #pragma pop on page 10-705.
10.99 #pragma push on page 10-706.
10.101 #pragma thumb on page 10-708.
8.7 --arm on page 8-326.
8.180 --thumb on page 8-518.
Note
You can use __attribute__((section(..))) for functions or variables as an alternative to #pragma
arm section.
Syntax
#pragma arm section [section_type_list]
Where:
section_type_list
specifies an optional list of section names to be used for subsequent functions or objects. The
syntax of section_type_list is:
section_type[[=]"name"] [,section_type="name"]*
Usage
Use #pragma arm section [section_type_list] to place functions and variables in separate named
sections. You can then use the scatter-loading description file to locate these at a particular address in
memory.
Restrictions
This option has no effect on:
• Inline functions and their local static variables if the --no_ool_section_name command-line option
is specified.
• Template instantiations and their local static variables.
• Elimination of unused variables and functions. However, using #pragma arm section might enable
the linker to eliminate a function or variable that might otherwise be kept because it is in the same
section as a used function or variable.
• The order that definitions are written to the object file.
Example
int x1 = 5; // in .data (default)
int y1[100]; // in .bss (default)
int const z1[3] = {1,2,3}; // in .constdata (default)
#pragma arm section rwdata = "foo", rodata = "bar"
int x2 = 5; // in foo (data part of region)
int y2[100]; // in .bss
int const z2[3] = {1,2,3}; // in bar
char *s2 = "abc"; // s2 in foo, "abc" in .conststring
#pragma arm section rodata
int x3 = 5; // in foo
int y3[100]; // in .bss
int const z3[3] = {1,2,3}; // in .constdata
char *s3 = "abc"; // s3 in foo, "abc" in .conststring
#pragma arm section code = "foo"
int add1(int x) // in foo (code part of region)
{
return x+1;
}
#pragma arm section code
Related references
10.49 __attribute__((section("name"))) function attribute on page 10-654.
8.142 --ool_section_name, --no_ool_section_name on page 8-478.
Related information
Scatter-loading Features.
Syntax
#pragma diag_default tag[,tag,...]
Where:
tag[,tag,...]
is a comma-separated list of diagnostic message numbers specifying the messages whose
severities are to be changed. This is the four-digit number, nnnn, without the -D suffix.
At least one diagnostic message number must be specified.
Example
// <stdio.h> not #included deliberately
#pragma diag_error 223
void hello(void)
{
printf("Hello ");
}
#pragma diag_default 223
void world(void)
{
printf("world!\n");
}
Compiling this code with the option --diag_warning=223 generates diagnostic messages to report that
the function printf() is declared implicitly.
The effect of #pragma diag_default 223 is to return the severity of diagnostic message 223 to
Warning severity, as specified by the --diag_warning command-line option.
Related concepts
6.3 Controlling compiler diagnostic messages with pragmas on page 6-257.
Related references
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
10.84 #pragma diag_warning tag[, tag, ...] on page 10-690.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
Syntax
#pragma diag_error tag[,tag,...]
Where:
tag[,tag,...]
is a comma-separated list of diagnostic message numbers specifying the messages whose
severities are to be changed. This is the four-digit number, nnnn, without the -D suffix.
At least one diagnostic message number must be specified.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
Syntax
#pragma diag_remark tag[,tag,...]
Where:
tag[,tag,...]
is a comma-separated list of diagnostic message numbers specifying the messages whose
severities are to be changed. This is the four-digit number, nnnn, without the -D suffix.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
Syntax
#pragma diag_suppress tag[,tag,...]
Where:
tag[,tag,...]
is a comma-separated list of diagnostic message numbers specifying the messages to be
suppressed. This is the four-digit number, nnnn, without the -D suffix.
Related references
8.19 --brief_diagnostics, --no_brief_diagnostics on page 8-342.
8.58 --diag_error=tag[,tag,...] on page 8-386.
8.59 --diag_remark=tag[,tag,...] on page 8-387.
8.60 --diag_style=arm|ide|gnu compiler option on page 8-388.
8.61 --diag_suppress=tag[,tag,...] on page 8-389.
8.62 --diag_suppress=optimizations on page 8-390.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.206 --wrap_diagnostics, --no_wrap_diagnostics on page 8-548.
8.64 --diag_warning=optimizations on page 8-392.
8.74 --errors=filename on page 8-402.
8.199 -W on page 8-541.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
8.162 --remarks on page 8-498.
Chapter 6 Compiler Diagnostic Messages on page 6-253.
Syntax
#pragma diag_warning tag[,tag,...]
Where:
tag[,tag,...]
is a comma-separated list of diagnostic message numbers specifying the messages whose
severities are to be changed. This is the four-digit number, nnnn, without the -D suffix.
Related concepts
6.3 Controlling compiler diagnostic messages with pragmas on page 6-257.
Related references
10.80 #pragma diag_default tag[,tag,...] on page 10-686.
10.81 #pragma diag_error tag[,tag,...] on page 10-687.
10.82 #pragma diag_remark tag[,tag,...] on page 10-688.
10.83 #pragma diag_suppress tag[,tag,...] on page 10-689.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
Usage
The --[no_]exceptions_unwind command-line option sets the default behavior for whether unwind
tables are generated for functions. #pragma [no_]exceptions_unwind overrides this behavior.
Default
The default is #pragma exceptions_unwind.
Related references
11.11 C++ exception handling in ARM C++ on page 11-812.
8.76 --exceptions_unwind, --no_exceptions_unwind on page 8-404.
8.75 --exceptions, --no_exceptions on page 8-403.
Related references
8.93 --gnu on page 8-424.
Note
This pragma is deprecated.
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
This pragma must appear before the first token that does not belong to a preprocessing directive.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.26 Precompiled Header (PCH) file processing and the header stop point on page 4-137.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
Related references
8.44 --create_pch=filename on page 8-371.
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
8.150 --pch_messages, --no_pch_messages on page 8-486.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
8.190 --use_pch=filename on page 8-532.
10.92 #pragma no_pch on page 10-698.
Syntax
#pragma import symbol_name
Where:
symbol_name
is a symbol to be imported.
Usage
You can use this pragma to select certain features of the C library, such as the heap implementation or
real-time division. For example:
#pragma import(__use_realtime_division)
If a feature described in this book requires a symbol reference to be imported, the required symbol is
specified.
Related information
IMPORT and EXTERN (assembler directives).
Using the C library with an application.
Note
Microlib is an alternative library to the default C library. Only use this pragma if you are using microlib.
setvbuf() and setbuf() are guaranteed to fail because all streams are unbuffered.
This version of microlib stdio can be retargeted in the same way as the standardlib stdio functions.
Related references
8.116 --library_type=lib on page 8-448.
Related information
About microlib.
Tailoring input/output functions in the C and C++ libraries.
Default
The default version of memcpy() used by microlib is a larger, but faster, word-by-word implementation
using LDR and STR.
Related references
8.116 --library_type=lib on page 8-448.
Related information
The ARM C Micro-library.
Default
The default is #pragma inline.
Related references
8.108 --inline, --no_inline on page 8-439.
10.40 __attribute__((noinline)) function attribute on page 10-645.
10.67 __attribute__((noinline)) constant variable attribute on page 10-672.
10.25 __declspec(noinline) on page 10-628.
Note
This pragma is deprecated.
Support for Precompiled Header (PCH) files is deprecated from ARM Compiler 5.05 onwards on all
platforms. Note that ARM Compiler on Windows 8 never supported PCH files.
Related concepts
4.24 Precompiled Header (PCH) files on page 4-134.
4.27 Precompiled Header (PCH) file creation requirements on page 4-139.
4.31 Selectively applying Precompiled Header (PCH) file processing on page 4-144.
4.32 Suppressing Precompiled Header (PCH) file processing on page 4-145.
Related references
8.44 --create_pch=filename on page 8-371.
8.148 --pch on page 8-484.
8.149 --pch_dir=dir on page 8-485.
8.150 --pch_messages, --no_pch_messages on page 8-486.
8.151 --pch_verbose, --no_pch_verbose on page 8-487.
8.190 --use_pch=filename on page 8-532.
10.87 #pragma hdrstop on page 10-693.
Syntax
#pragma Onum
Where:
num
is the new optimization level.
The value of num is 0, 1, 2 or 3.
Usage
To assign a new optimization level to all subsequent functions, use #pragma Onum. For example,
compiling with armcc -O1:
void function1(void){
... // Optimized at O1 (from armcc -O1)
}
#pragma O3
void function2(void){
... // Optimized at O3
}
void function3(void){
... // Optimized at O3
}
To assign a new optimization level to an individual function, use #pragma Onum together with #pragma
push and #pragma pop. For example, compiling with armcc -O1:
void function1(void){
... // Optimized at O1 (from armcc -O1)
}
#pragma push
#pragma O3
void function2(void){
... // Optimized at O3
}
#pragma pop
void function3(void){
... // Optimized at O1 (from armcc -O1)
}
Restriction
The pragma must be placed outside a function.
Related references
10.95 #pragma Ospace on page 10-701.
10.96 #pragma Otime on page 10-702.
8.139 -Onum on page 8-473.
Example
The following example shows the placement of a #ifndef guard around the body of the file, with a
#define of the guard variable after the #ifndef.
#ifndef FILE_H
#define FILE_H
#pragma once // optional
... body of the header file ...
#endif
The #pragma once is marked as optional in this example. This is because the compiler recognizes the
#ifndef header guard coding and skips subsequent includes even if #pragma once is absent.
Usage
To optimize all subsequent functions for code size, use #pragma Ospace. For example, when compiling
with armcc -Otime:
void function1(void){
... // Optimized for execution time (from armcc -Otime)
}
#pragma Ospace
void function2(void){
... // Optimized for code size
}
void function3(void){
... // Optimized for code size
}
To optimize an individual function for code size, use #pragma Ospace together with #pragma push and
#pragma pop. For example, when compiling with armcc -Otime:
void function1(void){
... // Optimized for execution time (from armcc -Otime)
}
#pragma push
#pragma Ospace
void function2(void){
... // Optimized for code size
}
#pragma pop
void function3(void){
... // Optimized for execution time (from armcc -Otime)
}
Restriction
The pragma must be placed outside a function.
Related references
8.143 -Ospace on page 8-479.
10.93 #pragma Onum on page 10-699.
10.96 #pragma Otime on page 10-702.
8.139 -Onum on page 8-473.
Usage
To optimize all subsequent functions for execution time, use #pragma Otime. For example, when
compiling with armcc -Ospace (the default):
void function1(void){
... // Optimized for code size (from armcc -Ospace)
}
#pragma Otime
void function2(void){
... // Optimized for execution time
}
void function3(void){
... // Optimized for execution time
}
To optimize an individual function for execution time, use #pragma Otime together with #pragma push
and #pragma pop. For example, when compiling with armcc -Ospace (the default):
void function1(void){
... // Optimized for code size (from armcc -Ospace)
}
#pragma push
#pragma Otime
void function2(void){
... // Optimized for execution time
}
#pragma pop
void function3(void){
... // Optimized for code size (from armcc -Ospace)
}
Restriction
The pragma must be placed outside a function.
Related references
10.93 #pragma Onum on page 10-699.
10.95 #pragma Ospace on page 10-701.
8.139 -Onum on page 8-473.
8.144 -Otime on page 8-480.
Note
This pragma is a GNU compiler extension that the ARM compiler supports.
Syntax
#pragma pack(n)
Where:
n
is the alignment in bytes, valid alignment values being 1, 2, 4 and 8.
Default
The default is #pragma pack(8).
Errors
Taking the address of a field in a #pragma packed struct does not yield a __packed pointer, so the
compiler does not produce an error if you assign this address to a non-__packed pointer. However, the
field might not be properly aligned for its type, and dereferencing such an unaligned pointer results in
undefined behavior.
Example
This example demonstrates how pack(2) aligns integer variable b to a 2-byte boundary.
typedef struct
{
char a;
int b;
} S;
#pragma pack(2)
typedef struct
{
char a;
int b;
} SP;
S var = { 0x11, 0x44444444 };
SP pvar = { 0x11, 0x44444444 };
0 1 2 3
a padding
4 5 6 7
b b b b
Note
In this layout, x denotes one byte of padding.
SP is a 6-byte structure. There is no padding after b.
Related concepts
5.35 The __packed qualifier and unaligned data access in C and C++ code on page 5-193.
5.40 Comparisons of an unpacked struct, a __packed struct, and a struct with individually __packed
fields, and of a __packed struct and a #pragma packed struct on page 5-198.
Related references
10.68 __attribute__((packed)) variable attribute on page 10-673.
10.60 __attribute__((packed)) type attribute on page 10-665.
10.12 __packed on page 10-612.
11.4 Structures, unions, enumerations, and bitfields in ARM C and C++ on page 11-799.
Related concepts
6.3 Controlling compiler diagnostic messages with pragmas on page 6-257.
Related references
10.99 #pragma push on page 10-706.
Related concepts
6.3 Controlling compiler diagnostic messages with pragmas on page 6-257.
Related references
10.98 #pragma pop on page 10-705.
Default
The default floating-point linkage type depends on the target FPU architecture.
Related concepts
5.51 Compiler options for floating-point linkage and computations on page 5-214.
Related references
10.15 __softfp on page 10-616.
Usage
Use #pragma push and #pragma pop on #pragma arm or #pragma thumb outside of functions, but not
inside of them, to change state. This is because #pragma arm and #pragma thumb only apply at the
function level. Instead, put them around the function definition.
#pragma push // in arm state, save current pragma state
#pragma thumb // change to thumb state
void bar(void)
{
__asm
{
NOP
}
}
#pragma pop // restore saved pragma state, back to arm state
int main(void)
{
bar();
}
Related references
8.7 --arm on page 8-326.
8.180 --thumb on page 8-518.
10.78 #pragma arm on page 10-683.
10.98 #pragma pop on page 10-705.
10.99 #pragma push on page 10-706.
Note
Both vectorized and nonvectorized loops can be unrolled using #pragma unroll [(n)]. That is,
#pragma unroll [(n)] applies to both --vectorize and --no_vectorize.
Syntax
#pragma unroll
Where:
n
is an optional value indicating the number of iterations to unroll.
Default
If you do not specify a value for n, the compiler assumes #pragma unroll (4).
Usage
This pragma is only applicable if you are compiling with -O3 -Otime. When compiling with
-O3 -Otime, the compiler automatically unrolls loops where it is beneficial to do so. You can use this
pragma to ask the compiler to unroll a loop that has not been unrolled automatically.
Note
Use this pragma only when you have evidence, for example from --diag_warning=optimizations, that
the compiler is not unrolling loops optimally by itself.
You cannot determine whether this pragma is having any effect unless you compile with
--diag_warning=optimizations or examine the generated assembly code, or both.
Restrictions
This pragma can only take effect when you compile with -O3 -Otime. Even then, the use of this pragma
is a request to the compiler to unroll a loop that has not been unrolled automatically. It does not
guarantee that the loop is unrolled.
#pragma unroll [(n)] can be used only immediately before a for loop, a while loop, or a do ... while
loop.
Example
void matrix_multiply(float ** __restrict dest, float ** __restrict src1,
float ** __restrict src2, unsigned int n)
{
unsigned int i, j, k;
for (i = 0; i < n; i++)
{
for (k = 0; k < n; k++)
{
float sum = 0.0f;
/* #pragma unroll */
for(j = 0; j < n; j++)
sum += src1[i][j] * src2[j][k];
dest[i][k] = sum;
}
}
}
In this example, the compiler does not normally complete its loop analysis because src2 is indexed as
src2[j][k] but the loops are nested in the opposite order, that is, with j inside k. When #pragma
unroll is uncommented in the example, the compiler proceeds to unroll the loop four times.
If the intention is to multiply a matrix that is not a multiple of four in size, for example an n * n matrix,
#pragma unroll (m) might be used instead, where m is some value so that n is an integral multiple of m.
Related concepts
5.7 Loop unrolling in C code on page 5-161.
Related references
10.103 #pragma unroll_completely on page 10-711.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.139 -Onum on page 8-473.
8.144 -Otime on page 8-480.
8.192 --vectorize, --no_vectorize on page 8-534.
Note
Both vectorized and nonvectorized loops can be unrolled using #pragma unroll_completely. That is,
#pragma unroll_completely applies to both --no_vectorize and --vectorize.
Usage
This pragma is only applicable if you are compiling with -O3 -Otime. When compiling with
-O3 -Otime, the compiler automatically unrolls loops where it is beneficial to do so. You can use this
pragma to ask the compiler to completely unroll a loop that has not automatically been unrolled
completely.
Note
Use this #pragma only when you have evidence, for example from --diag_warning=optimizations,
that the compiler is not unrolling loops optimally by itself.
You cannot determine whether this pragma is having any effect unless you compile with
--diag_warning=optimizations or examine the generated assembly code, or both.
Restrictions
This pragma can only take effect when you compile with -O3 -Otime. Even then, the use of this pragma
is a request to the compiler to unroll a loop that has not been unrolled automatically. It does not
guarantee that the loop is unrolled.
#pragma unroll_completely can only be used immediately before a for loop, a while loop, or a do ...
while loop.
Using #pragma unroll_completely on an outer loop can prevent vectorization. On the other hand,
using #pragma unroll_completely on an inner loop might help in some cases.
Related concepts
5.7 Loop unrolling in C code on page 5-161.
Related references
10.102 #pragma unroll [(n)] on page 10-709.
8.63 --diag_warning=tag[,tag,...] on page 8-391.
8.139 -Onum on page 8-473.
8.144 -Otime on page 8-480.
8.192 --vectorize, --no_vectorize on page 8-534.
Example
In the following example, weak_fn is declared as a weak alias of __weak_fn:
extern void weak_fn(int a);
#pragma weak weak_fn = __weak_fn
void __weak_fn(int a)
{
...
}
Related references
10.63 __attribute__((alias)) variable attribute on page 10-668.
10.31 __attribute__((alias)) function attribute on page 10-635.
10.55 __attribute__((weak)) function attribute on page 10-660.
10.73 __attribute__((weak)) variable attribute on page 10-678.
Instruction intrinsics
Syntax
void __breakpoint(int val)
Where:
val
is a compile-time constant integer whose range is:
0 ... 65535
if you are compiling source as ARM code
0 ... 255
if you are compiling source as Thumb code.
Errors
The compiler does not recognize the __breakpoint intrinsic when compiling for a target that does not
support the BKPT instruction. The compiler generates either a warning or an error in this case, depending
on the source language:
• In C code: Warning: #223-D: function "__breakpoint" declared implicitly.
• In C++ code: Error: #20: identifier "__breakpoint" is undefined.
The undefined instruction trap is taken if a BKPT instruction is executed on an architecture that does not
support it.
Example
void func(void)
{
...
__breakpoint(0xF02C);
...
}
Related information
BKPT.
Syntax
__cdp(unsigned int coproc, unsigned int ops, unsigned int regs)
Where:
coproc
Identifies the coprocessor the instruction is for.
coproc must be an integer in the range 0 to 15.
ops
Is an encoding of the two opcodes for the CDP or CDP2 instruction, (opcode1<<4) | opcode2,
where:
• The first opcode, opcode1, occupies the 4-bit coprocessor-specific opcode field in the
instruction.
• The second opcode, opcode2, occupies the 3-bit coprocessor-specific opcode field in the
instruction.
Add 0x100 to ops to generate a CDP2 instruction.
regs
Is an encoding of the coprocessor registers, (CRd<<8) | (CRn<<4) | CRm, where CRd, CRn and
CRm are the coprocessor registers for the CDP or CDP2 instruction.
Usage
The use of these instructions depends on the coprocessor. See your coprocessor documentation for more
information.
Example
void copro_example()
{
const unsigned int ops = 0xA3; // opcode1 = 0xA, opcode2 = 0x3
const unsigned int regs = 0xCDE; // CRd = 0xC (12), CRn = 0xD (13), CRm = 0xE (14)
__cdp(4,ops,regs); // coprocessor number 4
// This intrinsic produces the instruction CDP p4,#0xa,c12,c13,c14,#3
}
Related information
CDP and CDP2.
Syntax
void __clrex(void)
Errors
The compiler does not recognize the __clrex intrinsic when compiling for a target that does not support
the CLREX instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__clrex" declared implicitly.
• In C++ code: Error: #20: identifier "__clrex" is undefined.
Related information
CLREX.
Syntax
unsigned char __clz(unsigned int val)
Where:
val
is an unsigned int.
Return value
The __clz intrinsic returns the number of leading zeros in val.
Related references
10.160 GNU built-in functions on page 10-778.
Related information
CLZ.
Syntax
unsigned int __current_pc(void)
Return value
The __current_pc intrinsic returns the current value of the program counter at the point in the program
where the intrinsic is used.
Related references
10.111 __current_sp intrinsic on page 10-719.
10.137 __return_address intrinsic on page 10-748.
Syntax
unsigned int __current_sp(void)
Return value
The __current_sp intrinsic returns the current value of the stack pointer at the point in the program
where the intrinsic is used.
Related references
10.110 __current_pc intrinsic on page 10-718.
10.137 __return_address intrinsic on page 10-748.
10.160 GNU built-in functions on page 10-778.
Note
Typically, this intrinsic disables FIQ interrupts by setting the F-bit in the CPSR. However, for v7-M it
sets the fault mask register (FAULTMASK). FIQ interrupts are not supported in v6-M.
Syntax
int __disable_fiq(void);
void __disable_fiq(void);
Usage
int __disable_fiq(void); disables fast interrupts and returns the value the FIQ interrupt mask has in
the PSR before disabling interrupts.
void __disable_fiq(void); disables fast interrupts.
Return value
int __disable_fiq(void); returns the value the FIQ interrupt mask has in the PSR before disabling
FIQ interrupts.
Restrictions
int __disable_fiq(void); is not supported when compiling with --cpu=7. This is because of the
difference between the generic ARMv7 architecture and the ARMv7 A, R, and M-profiles in the
exception handling model. This means that when you compile with --cpu=7, the compiler is unable to
generate an instruction sequence that works on all ARMv7 processors and therefore int
__disable_fiq(void); is not supported. You can use the void __disable_fiq(void); function
prototype with --cpu=7.
The __disable_fiq intrinsic can only be executed in privileged modes, that is, in non-user modes. In
User mode this intrinsic does not change the interrupt flags in the CPSR.
Example
void foo(void)
{
int was_masked = __disable_fiq();
/* ... */
if (!was_masked)
__enable_fiq();
}
Related references
10.116 __enable_fiq intrinsic on page 10-725.
Note
Typically, this intrinsic disables IRQ interrupts by setting the I-bit in the CPSR. However, for M-profile it
sets the exception mask register (PRIMASK).
Syntax
int __disable_irq(void);
void __disable_irq(void);
Usage
int __disable_irq(void); disables interrupts and returns the value the IRQ interrupt mask has in the
PSR before disabling interrupts.
Return value
int __disable_irq(void); returns the value the IRQ interrupt mask has in the PSR before disabling
IRQ interrupts.
Example
void foo(void)
{
int was_masked = __disable_irq();
/* ... */
if (!was_masked)
__enable_irq();
}
Restrictions
int __disable_irq(void); is not supported when compiling with --cpu=7. This is because of the
difference between the generic ARMv7 architecture and the ARMv7 A, R, and M-profiles in the
exception handling model. This means that when you compile with --cpu=7, the compiler is unable to
generate an instruction sequence that works on all ARMv7 processors and therefore int
__disable_irq(void); is not supported. You can use the void __disable_irq(void); function
prototype with --cpu=7.
The following example shows the difference between compiling for ARMv7-M and ARMv7-R:
/* test.c */
void DisableIrq(void)
{
__disable_irq();
}
int DisableIrq2(void)
{
return __disable_irq();
}
DisableIrq
0x00000000: b672 r. CPSID i
0x00000002: 4770 pG BX lr
DisableIrq2
0x00000004: f3ef8010 .... MRS r0,PRIMASK
0x00000008: f0000001 .... AND r0,r0,#1
DisableIrq
0x00000000: b672 r. CPSID i
0x00000002: 4770 pG BX lr
DisableIrq2
0x00000004: f3ef8000 .... MRS r0,APSR ; formerly CPSR
0x00000008: f00000080 .... AND r0,r0,#0x80
0x0000000c: b672 r. CPSID i
0x0000000e: 4770 pG BX lr
In all cases, the __disable_irq intrinsic can only be executed in privileged modes, that is, in non-user
modes. In User mode this intrinsic does not change the interrupt flags in the CPSR.
Related references
10.117 __enable_irq intrinsic on page 10-726.
Syntax
void __dmb(unsigned int val)
Where val is a numeric argument indicating the scope and access type of the barrier. See ARM C
Language Extensions for more information.
Related concepts
4.6 Compiler intrinsics for inserting optimization barriers on page 4-110.
Related references
10.126 __memory_changed intrinsic on page 10-736.
10.139 __schedule_barrier intrinsic on page 10-750.
10.121 __force_stores intrinsic on page 10-730.
10.120 __force_loads intrinsic on page 10-729.
10.115 __dsb intrinsic on page 10-724.
10.122 __isb intrinsic on page 10-731.
Related information
ARM C Language Extensions.
Syntax
void __dsb(unsigned int val)
Where val is a numeric argument indicating the scope and access type of the barrier. See ARM C
Language Extensions for more information.
Related concepts
4.6 Compiler intrinsics for inserting optimization barriers on page 4-110.
Related references
10.126 __memory_changed intrinsic on page 10-736.
10.139 __schedule_barrier intrinsic on page 10-750.
10.121 __force_stores intrinsic on page 10-730.
10.114 __dmb intrinsic on page 10-723.
10.120 __force_loads intrinsic on page 10-729.
10.122 __isb intrinsic on page 10-731.
Related information
ARM C Language Extensions.
Note
Typically, this intrinsic enables FIQ interrupts by clearing the F-bit in the CPSR. However, for v7-M, it
clears the fault mask register (FAULTMASK). FIQ interrupts are not supported in v6-M.
Syntax
void __enable_fiq(void)
Restrictions
The __enable_fiq intrinsic can only be executed in privileged modes, that is, in non-user modes. In
User mode this intrinsic does not change the interrupt flags in the CPSR.
Related references
10.112 __disable_fiq intrinsic on page 10-720.
Note
Typically, this intrinsic enables IRQ interrupts by clearing the I-bit in the CPSR. However, for Cortex M-
profile processors, it clears the exception mask register (PRIMASK).
Syntax
void __enable_irq(void)
Restrictions
The __enable_irq intrinsic can only be executed in privileged modes, that is, in non-user modes. In
User mode this intrinsic does not change the interrupt flags in the CPSR.
Related references
10.113 __disable_irq intrinsic on page 10-721.
Note
The __fabs intrinsic is an analog of the standard C library function fabs(). It differs from the standard
library function in that a call to __fabs is guaranteed to be compiled into a single, inline, machine
instruction on an ARM architecture-based processor equipped with a VFP coprocessor.
Syntax
double __fabs(double val)
Where:
val
is a double-precision floating-point value.
Return value
The __fabs intrinsic returns the absolute value of val as a double.
Related references
10.119 __fabsf intrinsic on page 10-728.
Related information
VABS (floating-point).
Syntax
float __fabs(float val)
Related references
10.118 __fabs intrinsic on page 10-727.
Related information
VABS.
Syntax
void __force_loads(void)
Related references
10.126 __memory_changed intrinsic on page 10-736.
10.139 __schedule_barrier intrinsic on page 10-750.
10.121 __force_stores intrinsic on page 10-730.
10.114 __dmb intrinsic on page 10-723.
10.115 __dsb intrinsic on page 10-724.
10.122 __isb intrinsic on page 10-731.
Syntax
void __force_stores(void)
Related references
10.126 __memory_changed intrinsic on page 10-736.
10.139 __schedule_barrier intrinsic on page 10-750.
10.120 __force_loads intrinsic on page 10-729.
10.114 __dmb intrinsic on page 10-723.
10.115 __dsb intrinsic on page 10-724.
10.122 __isb intrinsic on page 10-731.
Syntax
void __isb(unsigned int val)
Where val is a numeric argument indicating the scope and access type of the barrier. The only supported
value for the __isb intrinsic is 15. See ARM C Language Extensions for more information.
Related concepts
4.6 Compiler intrinsics for inserting optimization barriers on page 4-110.
Related references
10.126 __memory_changed intrinsic on page 10-736.
10.139 __schedule_barrier intrinsic on page 10-750.
10.121 __force_stores intrinsic on page 10-730.
10.114 __dmb intrinsic on page 10-723.
10.115 __dsb intrinsic on page 10-724.
10.120 __force_loads intrinsic on page 10-729.
Related information
ARM C Language Extensions.
Note
The compiler does not guarantee to preserve the state of the exclusive monitor. It might generate load
and store instructions between the LDREX instruction generated for the __ldrex intrinsic and the STREX
instruction generated for the __strex intrinsic. Because memory accesses can clear the exclusive
monitor, code using the __ldrex and __strex intrinsics can have unexpected behavior. Where LDREX
and STREX instructions are needed, ARM recommends using embedded assembly.
Syntax
unsigned int __ldrex(volatile void *ptr)
Where:
ptr
points to the address of the data to be loaded from memory. To specify the type of the data to be
loaded, cast the parameter to an appropriate pointer type.
Return value
The __ldrex intrinsic returns the data loaded from the memory address pointed to by ptr.
Errors
The compiler does not recognize the __ldrex intrinsic when compiling for a target that does not support
the LDREX instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__ldrex" declared implicitly.
• In C++ code: Error: #20: identifier "__ldrex" is undefined.
The __ldrex intrinsic does not support access to doubleword data. The compiler generates an error if
you specify an access width that is not supported.
Example
int foo(void)
{
int loc = 0xff;
Related references
10.124 __ldrexd intrinsic on page 10-734.
10.145 __strex intrinsic on page 10-757.
10.146 __strexd intrinsic on page 10-759.
Related information
LDREX.
Note
This intrinsic is deprecated.
Note
The compiler does not guarantee to preserve the state of the exclusive monitor. It might generate load
and store instructions between the LDREXD instruction generated for the __ldrexd intrinsic and the
STREXD instruction generated for the __strexd intrinsic. Because memory accesses can clear the
exclusive monitor, code using the __ldrexd and __strexd intrinsics can have unexpected behavior.
Where LDREXD and STREXD instructions are needed, ARM recommends using embedded assembly.
Syntax
unsigned long long __ldrexd(volatile void *ptr)
Where:
ptr
points to the address of the data to be loaded from memory. To specify the type of the data to be
loaded, cast the parameter to an appropriate pointer type.
Return value
The __ldrexd intrinsic returns the data loaded from the memory address pointed to by ptr.
Errors
The compiler does not recognize the __ldrexd intrinsic when compiling for a target that does not
support the LDREXD instruction. The compiler generates either a warning or an error in this case,
depending on the source language:
• In C code: Warning: #223-D: function "__ldrexd" declared implicitly.
• In C++ code: Error: #20: identifier "__ldrexd" is undefined.
The __ldrexd intrinsic only supports access to doubleword data. The compiler generates an error if you
specify an access width that is not supported.
Related references
10.123 __ldrex intrinsic on page 10-732.
10.145 __strex intrinsic on page 10-757.
10.146 __strexd intrinsic on page 10-759.
Related information
LDREX.
Syntax
unsigned int __ldrt(const volatile void *ptr)
Where:
ptr
Points to the address of the data to be loaded from memory. To specify the size of the data to be
loaded, cast the parameter to an appropriate integral type.
Return value
The __ldrt intrinsic returns the data loaded from the memory address pointed to by ptr.
Errors
The compiler does not recognize the __ldrt intrinsic when compiling for a target that does not support
the LDRT instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__ldrt" declared implicitly.
• In C++ code: Error: #20: identifier "__ldrt" is undefined.
The __ldrt intrinsic does not support access to doubleword data. The compiler generates an error if you
specify an access width that is not supported.
Example
int foo(void)
{
int loc = 0xff;
return __ldrt((const volatile int *)loc);
}
Related references
8.180 --thumb on page 8-518.
Related information
LDR, unprivileged.
c If the target instruction set does not have the listed instruction, the compiler generates a sequence of instructions with equivalent behavior instead.
Syntax
void __memory_changed(void)
Related references
10.121 __force_stores intrinsic on page 10-730.
10.139 __schedule_barrier intrinsic on page 10-750.
10.120 __force_loads intrinsic on page 10-729.
10.114 __dmb intrinsic on page 10-723.
10.115 __dsb intrinsic on page 10-724.
10.122 __isb intrinsic on page 10-731.
Syntax
void __nop(void)
Usage
The compiler does not optimize away the NOP instructions, except for normal unreachable code
elimination. One NOP instruction is generated for each __nop intrinsic in the source.
ARMv6 and previous architectures do not have a NOP instruction, so the compiler generates a MOV r0,r0
instruction instead.
In addition, __nop creates a special sequence point that prevents operations with side effects from
moving past it under all circumstances. Normal sequence points allow operations with side effects past if
they do not affect program behavior. Operations without side effects are not restricted by the intrinsic,
and the compiler can move them past the sequence point. The __schedule_barrier intrinsic also
creates this special sequence point, and at optimization level -O0 emits two NOP instructions. These
instructions are removed at other optimization levels.
Section 5.1.2.3 of the C standard defines operations with side effects as those that change the state of the
execution environment. These operations:
• Access volatile objects.
• Modify a memory location.
• Modify a file.
• Call a function that does any of the above.
Examples
In the following example, the compiler ensures that the read from the volatile variable x is enclosed
between two NOP instructions.
volatile int x;
int z;
int read_variable(int y)
{
int i;
int a = 0;
__nop();
a = x;
__nop();
return z + y;
}
If the __nop intrinsics are removed, and the compilation is performed at -O3 -Otime for
--cpu=Cortex-M3, for example, then the compiler can schedule the read of the non-volatile variable z to
be before the read of variable x.
In the following example, the compiler ensures that the write to variable z is enclosed between two NOP
instructions.
int x;
int z;
int write_variable(int y)
{
int i;
for (i = 0; i < 10; i++)
{
__nop();
z = y;
__nop();
x += y;
}
return z;
}
In this case, if the __nop intrinsics are removed, then with -O3 -Otime --cpu=Cortex-A8, the compiler
can fold away the loop.
In the following example, because pure_func has no side effects, the compiler can move the call to it to
outside of the loop. Still, the compiler ensures that the call to func is enclosed between two NOP
instructions.
int func(int x);
int pure_func(int x) __pure;
int read(int x)
{
int i;
int a=0;
for (i=0; i<10; i++)
{
__nop();
a += pure_func(x) + func(x);
__nop();
}
return a;
}
Note
• You can use the __schedule_barrier intrinsic to insert a scheduling barrier without generating a
NOP instruction.
• In the examples above, the compiler would treat __schedule_barrier in the same way as __nop.
Related references
10.13 __pure on page 10-614.
10.139 __schedule_barrier intrinsic on page 10-750.
4.4 Generic intrinsics on page 4-108.
10.141 __sev intrinsic on page 10-753.
10.150 __wfe intrinsic on page 10-764.
10.151 __wfi intrinsic on page 10-765.
10.152 __yield intrinsic on page 10-766.
Related information
NOP.
Syntax
void __pld(...)
Where:
...
denotes any number of pointer or integer arguments specifying addresses of memory to prefetch.
Restrictions
If the target architecture does not support data prefetching, the compiler generates neither a PLD
instruction nor a NOP instruction, but ignores the intrinsic.
Example
extern int data1;
extern int data2;
volatile int *interrupt = (volatile int *)0x8000;
volatile int *uart = (volatile int *)0x9000;
void get(void)
{
__pld(data1, data2);
while (!*interrupt);
*uart = data1; // trigger uart as soon as interrupt occurs
*(uart+1) = data2;
}
Related references
10.130 __pli intrinsic on page 10-741.
10.129 __pldw intrinsic on page 10-740.
Related information
PLD, PLDW, and PLI.
Syntax
void __pldw(...)
Where:
...
denotes any number of pointer or integer arguments specifying addresses of memory to prefetch.
Restrictions
If the target architecture does not support data prefetching, this intrinsic has no effect.
This intrinsic only takes effect in ARMv7 architectures and above that provide Multiprocessing
Extensions. That is, when the predefined macro __TARGET_FEATURE_MULTIPROCESSING is defined.
Example
void foo(int *bar)
{
__pldw(bar);
}
Related references
10.161 Predefined macros on page 10-786.
10.130 __pli intrinsic on page 10-741.
10.128 __pld intrinsic on page 10-739.
Related information
PLD, PLDW, and PLI.
Syntax
void __pli(...)
Where:
...
denotes any number of pointer or integer arguments specifying addresses of instructions to
prefetch.
Restrictions
If the target architecture does not support instruction prefetching, the compiler generates neither a PLI
instruction nor a NOP instruction, but ignores the intrinsic.
Related references
10.129 __pldw intrinsic on page 10-740.
10.128 __pld intrinsic on page 10-739.
Related information
PLD, PLDW, and PLI.
Syntax
void __promise(expr)
Usage
__promise(expr) is similar but complementary to assert(expr). Unlike assert(expr),
__promise(expr) is effective when NDEBUG is defined.
If assertions are enabled (by including assert.h and not defining NDEBUG) then the promise is checked at
runtime by evaluating expr as part of assert(expr).
Related concepts
3.19 Indicating loop iteration counts to the compiler with __promise(expr) on page 3-89.
Note
The compiler might optimize your code when it detects an opportunity to do so, using equivalent
instructions from the same family to produce fewer instructions.
Syntax
int __qadd(int val1, int val2)
Where:
val1
is the first summand of the saturating add operation
val2
is the second summand of the saturating add operation.
Return value
The __qadd intrinsic returns the saturating add of val1 and val2.
Errors
The compiler does not recognize the __qadd intrinsic when compiling for a target that does not support
the QADD instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__qadd" declared implicitly.
• In C++ code: Error: #20: identifier "__qadd" is undefined.
Related references
10.133 __qdbl intrinsic on page 10-744.
10.134 __qsub intrinsic on page 10-745.
Related information
QADD.
Syntax
int __qdbl(int val)
Where:
val
is the data value to be doubled.
Return value
The __qdbl intrinsic returns the saturating add of val with itself, or equivalently, __qadd(val, val).
Errors
The compiler does not recognize the __qdbl intrinsic when compiling for a target that does not support
the QADD instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__qdbl" declared implicitly.
• In C++ code: Error: #20: identifier "__qdbl" is undefined.
Related references
10.132 __qadd intrinsic on page 10-743.
10.134 __qsub intrinsic on page 10-745.
Note
The compiler might optimize your code when it detects opportunity to do so, using equivalent
instructions from the same family to produce fewer instructions.
Syntax
int __qsub(int val1, int val2)
Where:
val1
is the minuend of the saturating subtraction operation
val2
is the subtrahend of the saturating subtraction operation.
Return value
The __qsub intrinsic returns the saturating subtraction of val1 and val2.
Errors
The compiler does not recognize the __qsub intrinsic when compiling for a target that does not support
the QSUB instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__qsub" declared implicitly.
• In C++ code: Error: #20: identifier "__qsub" is undefined.
Related references
10.132 __qadd intrinsic on page 10-743.
10.133 __qdbl intrinsic on page 10-744.
Related information
QSUB.
Syntax
unsigned int __rbit(unsigned int val)
Where:
val
is the data value whose bit order is to be reversed.
Return value
The __rbit intrinsic returns the value obtained from val by reversing its bit order.
Errors
The compiler does not recognize the __rbit intrinsic when compiling for a target that does not support
the RBIT instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__rbit" declared implicitly.
• In C++ code: Error: #20: identifier "__rbit" is undefined.
Related information
RBIT.
Note
The __rev intrinsic is available irrespective of the target processor or architecture you are compiling for.
However, if the REV instruction is not available on the target, the compiler compensates with an
alternative code sequence that could increase the number of instructions, effectively expanding the
intrinsic into a function.
Note
The compiler introduces REV automatically when it recognizes certain expressions.
Syntax
unsigned int __rev(unsigned int val)
Where:
val
is an unsigned int.
Return value
The __rev intrinsic returns the value obtained from val by reversing its byte order.
Related information
REV.
Syntax
unsigned int __return_address(void)
Return value
The __return_address intrinsic returns the value of the link register that is used in returning from the
current function.
Restrictions
The __return_address intrinsic does not affect the ability of the compiler to perform optimizations
such as inlining, tailcalling, and code sharing. Where optimizations are made, the value returned by
__return_address reflects the optimizations performed:
No optimization
When no optimizations are performed, the value returned by __return_address from within a
function foo() is the return address of foo().
Inline optimization
If a function foo() is inlined into a function bar() then the value returned by
__return_address from within foo() is the return address of bar().
Tail-call optimization
If a function foo() is tail-called from a function bar() then the value returned by
__return_address from within foo() is the return address of bar().
Related references
10.110 __current_pc intrinsic on page 10-718.
10.111 __current_sp intrinsic on page 10-719.
10.160 GNU built-in functions on page 10-778.
Note
The compiler introduces ROR automatically when it recognizes certain expressions.
Syntax
unsigned int __ror(unsigned int val, unsigned int shift)
Where:
val
is the value to be shifted right
shift
is a constant shift in the range 1-31.
Return value
The __ror intrinsic returns the value of val rotated right by shift number of places.
Related information
ROR.
Syntax
void __schedule_barrier(void)
Related references
10.121 __force_stores intrinsic on page 10-730.
10.126 __memory_changed intrinsic on page 10-736.
10.127 __nop intrinsic on page 10-737.
10.120 __force_loads intrinsic on page 10-729.
10.114 __dmb intrinsic on page 10-723.
10.115 __dsb intrinsic on page 10-724.
10.122 __isb intrinsic on page 10-731.
Syntax
int __semihost(int val, const void *ptr)
Where:
val
Is the request code for the semihosting request.
ptr
Is a pointer to an argument/result block.
Return value
The results of semihosting calls are passed either as an explicit return value or as a pointer to a data
block.
Usage
Use this intrinsic from C or C++ to generate the appropriate semihosting call for your target and
instruction set:
0x123456
In ARM state for all architectures.
0xAB
In Thumb state, excluding M-profile architectures. This behavior is not guaranteed on all debug
targets from ARM or from third parties.
0xAB
For M-profile architectures (Thumb only).
Restrictions
ARM processors earlier than ARMv7 use SVC instructions to make semihosting calls. However, if you
are compiling for a Cortex M-profile processor, semihosting is implemented using the BKPT instruction.
Example
char buffer[100];
...
void foo(void)
{
__semihost(0x01, (const void *)buf); // equivalent in thumb state to
// int __svc(0xAB) my_svc(int, int *);
// result = my_svc(0x1, &buffer);
}
Related references
8.42 --cpu=list on page 8-367.
Related information
BKPT.
SVC.
What is Semihosting?.
Syntax
void __sev(void)
Errors
The compiler does not recognize the __sev intrinsic when compiling for a target that does not support
the SEV instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__sev" declared implicitly.
• In C++ code: Error: #20: identifier "__sev" is undefined.
Related references
10.127 __nop intrinsic on page 10-737.
10.150 __wfe intrinsic on page 10-764.
10.151 __wfi intrinsic on page 10-765.
10.152 __yield intrinsic on page 10-766.
Related information
NOP.
SEV.
Note
The __sqrt intrinsic is an analog of the standard C library function sqrt(). It differs from the standard
library function in that a call to __sqrt is guaranteed to be compiled into a single, inline, machine
instruction on an ARM architecture-based processor equipped with a VFP coprocessor.
Syntax
double __sqrt(double val)
Where:
val
is a double-precision floating-point value.
Return value
The __sqrt intrinsic returns the square root of val as a double.
Errors
The compiler does not recognize the __sqrt intrinsic when compiling for a target that is not equipped
with a VFP coprocessor. The compiler generates either a warning or an error in this case, depending on
the source language:
• In C code: Warning: #223-D: function "__sqrt" declared implicitly.
• In C++ code: Error: #20: identifier "__sqrt" is undefined.
Related references
10.143 __sqrtf intrinsic on page 10-755.
Related references
10.142 __sqrt intrinsic on page 10-754.
Syntax
int __ssat(int val, unsigned int sat)
Where:
val
Is the value to be saturated.
sat
Is the bit position to saturate to.
sat must be in the range 1 to 32.
Return value
The __ssat intrinsic returns val saturated to the signed range –2sat–1 ≤ x ≤ 2sat–1 –1.
Errors
The compiler does not recognize the __ssat intrinsic when compiling for a target that does not support
the SSAT instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__ssat" declared implicitly.
• In C++ code: Error: #20: identifier "__ssat" is undefined.
Related references
10.149 __usat intrinsic on page 10-763.
Related information
SSAT.
Note
This intrinsic is deprecated.
Note
The compiler does not guarantee to preserve the state of the exclusive monitor. It might generate load
and store instructions between the LDREX instruction generated for the __ldrex intrinsic and the STREX
instruction generated for the __strex intrinsic. Because memory accesses can clear the exclusive
monitor, code using the __ldrex and __strex intrinsics can have unexpected behavior. Where LDREX
and STREX instructions are needed, ARM recommends using embedded assembly.
Syntax
int __strex(unsigned int val, volatile void *ptr)
Where:
val
is the value to be written to memory.
ptr
points to the address of the data to be written to in memory. To specify the size of the data to be
written, cast the parameter to an appropriate integral type.
Return value
The __strex intrinsic returns:
0
if the STREX instruction succeeds
1
if the STREX instruction is locked out.
Errors
The compiler does not recognize the __strex intrinsic when compiling for a target that does not support
the STREX instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__strex" declared implicitly.
• In C++ code: Error: #20: identifier "__strex" is undefined.
The __strex intrinsic does not support access to doubleword data. The compiler generates an error if
you specify an access width that is not supported.
Example
int foo(void)
{
int loc=0xff;
return(!__strex(0x20, (volatile char *)loc));
}
Related references
10.123 __ldrex intrinsic on page 10-732.
10.124 __ldrexd intrinsic on page 10-734.
10.146 __strexd intrinsic on page 10-759.
Related information
STREX.
Note
This intrinsic is deprecated.
Note
The compiler does not guarantee to preserve the state of the exclusive monitor. It might generate load
and store instructions between the LDREXD instruction generated for the __ldrexd intrinsic and the
STREXD instruction generated for the __strexd intrinsic. Because memory accesses can clear the
exclusive monitor, code using the __ldrexd and __strexd intrinsics can have unexpected behavior.
Where LDREXD and STREXD instructions are needed, ARM recommends using embedded assembly.
Syntax
int __strexd(unsigned long long val, volatile void *ptr)
Where:
val
is the value to be written to memory.
ptr
points to the address of the data to be written to in memory. To specify the size of the data to be
written, cast the parameter to an appropriate integral type.
Return value
The __strexd intrinsic returns:
0
if the STREXD instruction succeeds
1
if the STREXD instruction is locked out.
Errors
The compiler does not recognize the __strexd intrinsic when compiling for a target that does not
support the STREXD instruction. The compiler generates either a warning or an error in this case,
depending on the source language:
• In C code: Warning: #223-D: function "__strexd" declared implicitly.
• In C++ code: Error: #20: identifier "__strexd" is undefined.
The __strexd intrinsic only supports access to doubleword data. The compiler generates an error if you
specify an access width that is not supported.
Related references
10.123 __ldrex intrinsic on page 10-732.
10.124 __ldrexd intrinsic on page 10-734.
10.145 __strex intrinsic on page 10-757.
Related information
STREX.
Syntax
void __strt(unsigned int val, volatile void *ptr)
Where:
val
Is the value to be written to memory.
ptr
Points to the address of the data to be written to in memory. To specify the size of the data to be
written, cast the parameter to an appropriate integral type.
Errors
The compiler does not recognize the __strt intrinsic when compiling for a target that does not support
the STRT instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__strt" declared implicitly.
• In C++ code: Error: #20: identifier "__strt" is undefined.
The __strt intrinsic does not support access either to signed data or to doubleword data. The compiler
generates an error if you specify an access width that is not supported. The unused most-significant bits
of val are ignored when signed data is stored.
Example
void foo(void)
{
int loc=0xff;
__strt(0x20, (volatile char *)loc);
}
Related references
8.180 --thumb on page 8-518.
Related information
STR, unprivileged.
Syntax
unsigned int __swp(unsigned int val, volatile void *ptr)
Where:
val
Is the data value to be written to memory.
ptr
Points to the address of the data to be written to in memory. To specify the size of the data to be
written, cast the parameter to an appropriate integral type.
Return value
The __swp intrinsic returns the data value in the memory address pointed to by ptr immediately before
the SWP instruction overwrites it with val.
Example
int foo(void)
{
int loc=0xff;
return(__swp(0x20, (volatile int *)loc));
}
Related information
SWP and SWPB.
Syntax
int __usat(unsigned int val, unsigned int sat)
Where:
val
Is the value to be saturated.
sat
Is the bit position to saturate to.
usat must be in the range 0 to 31.
Return value
The __usat intrinsic returns val saturated to the unsigned range 0 ≤ x ≤ 2sat –1.
Errors
The compiler does not recognize the __usat intrinsic when compiling for a target that does not support
the USAT instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__usat" declared implicitly.
• In C++ code: Error: #20: identifier "__usat" is undefined.
Related references
10.144 __ssat intrinsic on page 10-756.
Related information
USAT.
Syntax
void __wfe(void)
Errors
The compiler does not recognize the __wfe intrinsic when compiling for a target that does not support
the WFE instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__wfe" declared implicitly.
• In C++ code: Error: #20: identifier "__wfe" is undefined.
Related references
10.141 __sev intrinsic on page 10-753.
10.127 __nop intrinsic on page 10-737.
10.151 __wfi intrinsic on page 10-765.
10.152 __yield intrinsic on page 10-766.
Related information
NOP.
WFE.
Syntax
void __wfi(void)
Errors
The compiler does not recognize the __wfi intrinsic when compiling for a target that does not support
the WFI instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__wfi" declared implicitly.
• In C++ code: Error: #20: identifier "__wfi" is undefined.
Related references
10.141 __sev intrinsic on page 10-753.
10.127 __nop intrinsic on page 10-737.
10.150 __wfe intrinsic on page 10-764.
10.152 __yield intrinsic on page 10-766.
Related information
NOP.
WFI.
Syntax
void __yield(void)
Errors
The compiler does not recognize the __yield intrinsic when compiling for a target that does not support
the YIELD instruction. The compiler generates either a warning or an error in this case, depending on the
source language:
• In C code: Warning: #223-D: function "__yield" declared implicitly.
• In C++ code: Error: #20: identifier "__yield" is undefined.
Related references
10.141 __sev intrinsic on page 10-753.
10.127 __nop intrinsic on page 10-737.
10.150 __wfe intrinsic on page 10-764.
10.151 __wfi intrinsic on page 10-765.
Related information
NOP.
YIELD.
Note
Each ARMv6 SIMD intrinsic is guaranteed to be compiled into a single, inline, machine instruction for
an ARMv6 architecture or processor. However, the compiler might use optimized forms of underlying
instructions when it detects opportunities to do so.
The ARMv6 SIMD instructions can set the GE[3:0] bits in the Application Program Status Register
(APSR). Some SIMD instructions update these flags to indicate the greater than or equal to status of
each 8 or 16-bit slice of an SIMD operation.
The ARM compiler treats the GE[3:0] bits as a global variable. To access these bits from within your C
or C++ program, either:
• Access bits 16-19 of the APSR through a named register variable.
• Use the __sel intrinsic to control a SEL instruction.
Related references
10.159 Named register variables on page 10-774.
Chapter 12 ARMv6 SIMD Instruction Intrinsics on page 12-817.
Related information
SEL.
NEON and VFP Programming.
ARM registers.
Table 10-15 ETSI basic operations that the ARM compilation tools support
Intrinsics
The header file dspfns.h also exposes certain status flags as global variables for use in your C or C++
programs. The status flags exposed by dspfns.h are listed in the following table.
Table 10-16 ETSI status flags exposed in the ARM compilation tools
Example
#include <limits.h>
#include <stdint.h>
#include <dspfns.h> // include ETSI basic operations
int32_t C_L_add(int32_t a, int32_t b)
{
int32_t c = a + b;
if (((a ^ b) & INT_MIN) == 0)
{
if ((c ^ a) & INT_MIN)
{
c = (a < 0) ? INT_MIN : INT_MAX;
}
}
return c;
}
__asm int32_t asm_L_add(int32_t a, int32_t b)
{
qadd r0, r0, r1
bx lr
}
int32_t foo(int32_t a, int32_t b)
{
int32_t c, d, e, f;
Overflow = 0; // set global overflow flag
c = C_L_add(a, b); // C saturating add
d = asm_L_add(a, b); // assembly language saturating add
e = __qadd(a, b); // ARM intrinsic saturating add
f = L_add(a, b); // ETSI saturating add
Related concepts
4.9 Compiler support for European Telecommunications Standards Institute (ETSI) basic operations
on page 4-114.
Related information
ETSI Recommendation G.191: Software tools for speech and audio coding standardization.
ETSI Recommendation G.729: Coding of speech at 8 kbit/s using conjugate-structure algebraic-code-
excited linear prediction (CS-ACELP).
ETSI Recommendation G723.1 : Dual rate speech coder for multimedia communications transmitting at
5.3 and 6.3 kbit/s.
Intrinsics
Restrictions
The C55x intrinsics are only supported on targets that support the __qadd, __qdbl, and __qsub intrinsics.
Otherwise, no error message is generated, instead the compiler silently generates a call to a
corresponding function __qadd, __qdbl, or __qsub.
Example
#include <limits.h>
#include <stdint.h>
#include <c55x.h> // include TI C55x intrinsics
__asm int32_t asm_lsadd(int32_t a, int32_t b)
{
qadd r0, r0, r1
bx lr}
int32_t foo(int32_t a, int32_t b)
{
int32_t c, d, e;
c = asm_lsadd(a, b); // assembly language saturating add
d = __qadd(a, b); // ARM intrinsic saturating add
e = _lsadd(a, b); // TI C55x saturating add
return c == d == e; // returns 1
}
Note
ARM recommends using a named register variable as an alternative method of reading this register. This
provides a more efficient method of access than using the intrinsic.
Related references
10.157 __vfp_status intrinsic on page 10-772.
10.159 Named register variables on page 10-774.
Syntax
unsigned int __vfp_status(unsigned int mask, unsigned int flags);
Usage
Use this intrinsic to read or modify the flags in FPSCR.
The intrinsic returns the value of FPSCR, unmodified, if mask and flags are 0.
You can clear, set, or toggle individual flags in FPSCR using the bits in mask and flags, as shown in the
following table. The intrinsic returns the modified value of FPSCR if mask and flags are not both 0.
Note
If you want to read or modify only the exception flags in FPSCR, then ARM recommends that you use
the standard C99 features in <fenv.h>.
Errors
The compiler generates an error if you attempt to use this intrinsic when compiling for a target that does
not have VFP.
Related concepts
5.78 <fenv.h> floating-point environment access in C99 on page 5-248.
Related information
NEON and VFP system registers.
Note
• These intrinsics are only available in C99 mode.
• They are only supported for the Cortex-A5 and Cortex-M4 processors.
• If compiling for the Cortex-M4 processor, only fmaf() is available.
Syntax
register type var-name __asm(reg);
Where:
type
is the type of the named register variable.
Any type of the same size as the register being named can be used in the declaration of a named
register variable. The type can be a structure, but bitfield layout is sensitive to endianness.
var-name
is the name of the named register variable.
reg
is a character string denoting the name of a register on an ARM architecture-based processor, or
for coprocessor registers, a string syntax that identifies the coprocessor and corresponds with
how you intend to use the variable.
Registers available for use with named register variables on ARM architecture-based processors
are shown in the following table.
On targets with floating-point hardware, the registers listed in the following table are also
available for use with named register variables.
Table 10-20 Named registers available on targets with floating-point hardware (continued)
Note
Some registers are not available on some architectures.
Usage
You must declare core registers as global rather than local named register variables. Your program might
still compile if you declare them locally, but you risk unexpected runtime behavior if you do. There is no
restriction on the scope of named register variables for other registers.
Note
A global named register variable is global to the source file in which it is declared, not global to the
program. It has no effect on other files, unless you use multifile compilation or you declare it in a header
file.
Restrictions
Declaring a core register as a named register variable means that register is not available to the compiler
for other operations. If you declare too many named register variables, code size increases significantly.
In some cases, your program might not compile, for example if there are insufficient registers available
to compute a particular expression.
Register usage defined by the Procedure Call Standard for the ARM Architecture (AAPCS) is not
affected by declaring named register variables. For example, r0 is always used to return result values
from functions even if it is declared as a named register variable.
Named register variables are a compiler-only feature. With the exception of r12, tools such as linkers do
not change register usage in object files. The AAPCS reserves r12 as the inter-procedural scratch
register. You must not declare r12 as a named register variable if you require its value to be preserved
across function calls.
Examples
In the following example, apsr is declared as a named register variable for the "apsr" register:
register unsigned int apsr __asm("apsr");
apsr = ~(~apsr | 0x40);
In the following example, PMCR is declared as a register variable associated with coprocessor cp15, with
CRn = c9, CRm = c12, opcode1 = 0, and opcode2 = 0, in an MCR or an MRC instruction:
In the following example, cp15_control is declared as a register variable for accessing a coprocessor
register. This example enables the MMU using CP15:
register unsigned int cp15_control __asm("cp15:0:c1:c0:0");
cp15_control |= 0x1;
The following example for Cortex-M3 declares _msp, _control and _psp as named register variables to
set up stack pointers:
register unsigned int _control __asm("control");
register unsigned int _msp __asm("msp");
register unsigned int _psp __asm("psp");void init(void)
{
_msp = 0x30000000; // set up Main Stack Pointer
_control = _control | 3; // switch to User Mode with Process Stack
_psp = 0x40000000; // set up Process Stack Pointer
}
Related concepts
4.14 Compiler support for accessing registers using named register variables on page 4-121.
Related information
Procedure Call Standard for the ARM Architecture.
Nonstandard functions
• __builtin_alloca()
• __builtin_bcmp()
• __builtin_exit()
• __builtin_gamma()
• __builtin_gammaf()
• __builtin_gammal()
• __builtin_index()
• __builtin__memcpy_chk()
• __builtin__memmove_chk()
• __builtin_mempcpy()
• __builtin__mempcpy_chk()
• __builtin__memset_chk()
• __builtin_object_size()
• __builtin_rindex()
• __builtin__snprintf_chk()
• __builtin__sprintf_chk()
• __builtin_stpcpy()
• __builtin__stpcpy_chk()
• __builtin_strcat_chk()
• __builtin__strcpy_chk()
• __builtin_strcasecmp()
• __builtin_strncasecmp()
• __builtin__strncat_chk()
• __builtin__strncpy_chk()
• __builtin__vsnprintf_chk()
• __builtin__vsprintf_chk()
C99 functions
• __builtin_exit()
• __builtin_acoshf()
• __builtin_acoshl()
• __builtin_acosh()
• __builtin_asinhf(
• __builtin_asinhl()
• __builtin_asinh()
• __builtin_atanhf()
• __builtin_atanhl()
• __builtin_atanh()
• __builtin_cabsf()
• __builtin_cabsl()
• __builtin_cabs()
• __builtin_cacosf()
• __builtin_cacoshf()
• __builtin_cacoshl()
• __builtin_cacosh()
• __builtin_cacosl()
• __builtin_cacos()
• __builtin_cargf()
• __builtin_cargl()
• __builtin_carg()
• __builtin_casinf()
• __builtin_casinhf()
• __builtin_casinhl()
• __builtin_casinh()
• __builtin_casinl()
• __builtin_casin()
• __builtin_catanf()
• __builtin_catanhf()
• __builtin_catanhl()
• __builtin_catanh()
• __builtin_catanl()
• __builtin_catan()
• __builtin_cbrtf()
• __builtin_cbrtl()
• __builtin_cbrt()
• __builtin_ccosf()
• __builtin_ccoshf()
• __builtin_ccoshl()
• __builtin_ccosh()
• __builtin_ccosl()
• __builtin_ccos()
• __builtin_cexpf()
• __builtin_cexpl()
• __builtin_cexp()
• __builtin_cimagf()
• __builtin_cimagl()
• __builtin_cimag()
• __builtin_clogf()
• __builtin_clogl()
• __builtin_clog()
• __builtin_conjf()
• __builtin_conjl()
• __builtin_conj()
• __builtin_copysignf()
• __builtin_copysignl()
• __builtin_copysign()
• __builtin_cpowf()
• __builtin_cpowl()
• __builtin_cpow()
• __builtin_cprojf()
• __builtin_cprojl()
• __builtin_cproj()
• __builtin_crealf()
• __builtin_creall()
• __builtin_creal()
• __builtin_csinf()
• __builtin_csinhf()
• __builtin_csinhl()
• __builtin_csinh()
• __builtin_csinl()
• __builtin_csin()
• __builtin_csqrtf()
• __builtin_csqrtl()
• __builtin_csqrt()
• __builtin_ctanf()
• __builtin_ctanhf()
• __builtin_ctanhl()
• __builtin_ctanh()
• __builtin_ctanl()
• __builtin_ctan()
• __builtin_erfcf()
• __builtin_erfcl()
• __builtin_erfc()
• __builtin_erff()
• __builtin_erfl()
• __builtin_erf()
• __builtin_exp2f()
• __builtin_exp2l()
• __builtin_exp2()
• __builtin_expm1f()
• __builtin_expm1l()
• __builtin_expm1()
• __builtin_fdimf()
• __builtin_fdiml()
• __builtin_fdim()
• __builtin_fmaf()
• __builtin_fmal()
• __builtin_fmaxf()
• __builtin_fmaxl()
• __builtin_fmax()
• __builtin_fma()
• __builtin_fminf()
• __builtin_fminl()
• __builtin_fmin()
• __builtin_hypotf()
• __builtin_hypotl()
• __builtin_hypot()
• __builtin_ilogbf()
• __builtin_ilogbl()
• __builtin_ilogb()
• __builtin_imaxabs()
• __builtin_isblank()
• __builtin_isfinite()
• __builtin_isinf()
• __builtin_isnan()
• __builtin_isnanf()
• __builtin_isnanl()
• __builtin_isnormal()
• __builtin_iswblank()
• __builtin_lgammaf()
• __builtin_lgammal()
• __builtin_lgamma()
• __builtin_llabs()
• __builtin_llrintf()
• __builtin_llrintl()
• __builtin_llrint()
• __builtin_llroundf()
• __builtin_llroundl()
• __builtin_llround()
• __builtin_log1pf()
• __builtin_log1pl()
• __builtin_log1p()
• __builtin_log2f()
• __builtin_log2l()
• __builtin_log2()
• __builtin_logbf()
• __builtin_logbl()
• __builtin_logb()
• __builtin_lrintf()
• __builtin_lrintl()
• __builtin_lrint()
• __builtin_lroundf()
• __builtin_lroundl()
• __builtin_lround()
• __builtin_nearbyintf()
• __builtin_nearbyintl()
• __builtin_nearbyint()
• __builtin_nextafterf()
• __builtin_nextafterl()
• __builtin_nextafter()
• __builtin_nexttowardf()
• __builtin_nexttowardl()
• __builtin_nexttoward()
• __builtin_remainderf()
• __builtin_remainderl()
• __builtin_remainder()
• __builtin_remquof()
• __builtin_remquol()
• __builtin_remquo()
• __builtin_rintf()
• __builtin_rintl()
• __builtin_rint()
• __builtin_roundf()
• __builtin_roundl()
• __builtin_round()
• __builtin_scalblnf()
• __builtin_scalblnl()
• __builtin_scalbln()
• __builtin_scalbnf()
• __builtin_calbnl()
• __builtin_scalbn()
• __builtin_signbit()
• __builtin_signbitf()
• __builtin_signbitl()
• __builtin_snprintf()
• __builtin_tgammaf()
• __builtin_tgammal()
• __builtin_tgamma()
• __builtin_truncf()
• __builtin_truncl()
• __builtin_trunc()
• __builtin_vfscanf()
• __builtin_vscanf()
• __builtin_vsnprintf()
• __builtin_vsscanf()
C94 functions
• __builtin_swalnum()
• __builtin_iswalpha()
• __builtin_iswcntrl()
• __builtin_iswdigit()
• __builtin_iswgraph()
• __builtin_iswlower()
• __builtin_iswprint()
• __builtin_iswpunct()
• __builtin_iswspace()
• __builtin_iswupper()
• __builtin_iswxdigit()
• __builtin_towlower()
• __builtin_towupper()
C90 functions
• __builtin_abort()
• __builtin_abs()
• __builtin_acos()
• __builtin_asin()
• __builtin_atan2()
• __builtin_atan()
• __builtin_calloc()
• __builtin_cosh()
• __builtin_cos()
• __builtin_exit()
• __builtin_exp()
• __builtin_fabs()
• __builtin_floor()
• __builtin_fmod()
• __builtin_fprintf()
• __builtin_fputc()
• __builtin_fputs()
• __builtin_frexp()
• __builtin_fscanf()
• __builtin_isalnum()
• __builtin_isalpha()
• __builtin_iscntrl()
• __builtin_isdigit()
• __builtin_isgraph()
• __builtin_islower()
• __builtin_isprint()
• __builtin_ispunct()
• __builtin_isspace()
• __builtin_isupper()
• __builtin_isxdigit()
• __builtin_tolower()
• __builtin_toupper()
• __builtin_labs()
• __builtin_ldexp()
• __builtin_log10()
• __builtin_log()
• __builtin_malloc()
• __builtin_memchr()
• __builtin_memcmp()
• __builtin_memcpy()
• __builtin_memset()
• __builtin_modf()
• __builtin_pow()
• __builtin_printf()
• __builtin_putchar()
• __builtin_puts()
• __builtin_scanf()
• __builtin_sinh()
• __builtin_sin()
• __builtin_snprintf()
• __builtin_sprintf()
• __builtin_sqrt()
• __builtin_sscanf()
• __builtin_strcat()
• __builtin_strchr()
• __builtin_strcmp()
• __builtin_strcpy()
• __builtin_strcspn()
• __builtin_strlen()
• __builtin_strncat()
• __builtin_strncmp()
• __builtin_strncpy()
• __builtin_strpbrk()
• __builtin_strrchr()
• __builtin_strspn()
• __builtin_strstr()
• __builtin_tanh()
• __builtin_tan()
• __builtin_va_copy()
• __builtin_va_end()
• __builtin_va_start()
• __builtin_vfprintf()
• __builtin_vprintf()
• __builtin_vsprintf()
The __builtin_va_list type is also supported. It is equivalent to the va_list type declared in
stdarg.h.
• __sync_lock_release()
• __sync_synchronize()
Note
Some architectures, such as ARMv6-M, do not provide the exclusive load and store instructions required
by these intrinsics. Because different users will have different requirements for how these operations
should be performed, the GNU atomic intrinsics are defined for these targets but require you to
implement the __user_cmpxchg_1, __user_cmpxchg_2 and __user_cmpxchg_4 functions.
These functions are defined as follows:
//Compare and exchange word
int __user_cmpxchg_4(unsigned int *ptr, unsigned int old, unsigned int new)
The following is a sample implementation of the __user_cmpxchg_4() function. Note that in a real
implementation, both accesses to *ptr should be atomic, so that no intervening access can change the
value stored in memory.
int __user_cmpxchg_4(unsigned int *ptr, unsigned int old, unsigned int new) {
if (*ptr == old) {
*ptr = new;
return 0;
} else {
return 1;
}
}
• __builtin_ffs()
• __builtin_ffsl()
• __builtin_ffsll()
• __builtin_frame_address()
• __builtin_offsetof()
• __builtin_prefetch()
• __builtin_return_address()
• __builtin_popcount()
• __builtin_signbit()
__arm__ - Always defined for the ARM compiler, even when you specify the
--thumb option.
See also __ARMCC_VERSION.
__ARM_NEON__ - When compiler --cpu and --fpu options indicate that NEON is
available.
Use this macro to conditionally include arm_neon.h, to permit the
use of NEON intrinsics.
Note
Use this macro to distinguish between ARM Compiler 4.1 or later,
and other tools that define __arm__.
__APCS_INTERWORK - When you specify the --apcs /interwork option or set the target
processor architecture to ARMv5T or later.
__APCS_ROPI - When you specify the --apcs /ropi option.
__ARRAY_OPERATORS - In C++ compiler mode, to specify that array new and delete are
enabled.
__BASE_FILE__ name Always defined. Similar to __FILE__, but indicates the primary
source file rather than the current one (that is, when the current file
is an included file).
__BIG_ENDIAN - If compiling for a big-endian target.
_BOOL - In C++ compiler mode, to specify that bool is a keyword.
__EDG_VERSION__ - Always set to an integer value that represents the version number of
the Edison Design Group (EDG) front-end. For example, version 3.8
is represented as 308.
Note
The version number of the EDG front-end does not necessarily
match the version number of the ARM compiler toolchain.
__GNUC__ ver When you specify the --gnu option. It is an integer that shows the
current major version of the GNU mode being used.
__GNUC_MINOR__ ver When you specify the --gnu option. It is an integer that shows the
current minor version of the GNU mode being used.
__GNUG__ ver In GNU mode when you specify the --cpp option. It has the same
value as __GNUC__.
__INTMAX_TYPE__ - In GNU mode. It defines the correct underlying type for the
intmax_t typedef.
__LINE__ num Always set. It is the source line number of the line of code
containing this macro.
__MODULE__ mod Contains the filename part of the value of __FILE__.
__OPTIMISE_LEVEL num Always set to 2 by default, unless you change the optimization level
using the -Onum option.d
d ARM recommends that if you have source code reliant on the __OPTIMISE_LEVEL macro to determine whether or not --multifile is in effect, you change to
using__MULTIFILE.
__PLACEMENT_DELETE - In C++ mode to specify that placement delete (that is, an operator
delete corresponding to a placement operator new, to be called if
the constructor throws an exception) is enabled. This is only relevant
when using exceptions.
__PTRDIFF_TYPE__ - In GNU mode. It defines the correct underlying type for the
ptrdiff_t typedef.
__SIZE_TYPE__ - In GNU mode. It defines the correct underlying type for the size_t
typedef.
__TARGET_ARCH_ARM num The number of the ARM base architecture of the target processor
irrespective of whether the compiler is compiling for ARM or
Thumb. For possible values of __TARGET_ARCH_ARM in relation to
the ARM architecture versions, see the table below.
__TARGET_ARCH_THUMB num The number of the Thumb base architecture of the target processor
irrespective of whether the compiler is compiling for ARM or
Thumb. The value is defined as zero if the target does not support
Thumb. For possible values of __TARGET_ARCH_THUMB in relation
to the ARM architecture versions, see the table below.
__TARGET_ARCH_XX - XX represents the target architecture and its value depends on the
target architecture. For example, if you specify the compiler options
--cpu=4T or --cpu=ARM7TDMI then __TARGET_ARCH_4T is
defined.
• __TARGET_FPU_NONE
• __TARGET_FPU_VFP
• __TARGET_FPU_SOFTVFP
In addition, if compiling with one of the following --fpu options,
the corresponding target name is set:
• --fpu=softvfp+vfpv2, __TARGET_FPU_SOFTVFP_VFPV2
• --fpu=softvfp+vfpv3, __TARGET_FPU_SOFTVFP_VFPV3
• --fpu=softvfp+vfpv3_fp16,
__TARGET_FPU_SOFTVFP_VFPV3_FP16
• --fpu=softvfp+vfpv3_d16,
__TARGET_FPU_SOFTVFP_VFPV3_D16
• --fpu=softvfp+vfpv3_d16_fp16,
__TARGET_FPU_SOFTVFP_VFPV3_D16_FP16
• --fpu=softvfp+vfpv4, __TARGET_FPU_SOFTVFP_VFPV4
• --fpu=softvfp+vfpv4_d16,
__TARGET_FPU_SOFTVFP_VFPV4_D16
• --fpu=softvfp+fpv4-sp,
__TARGET_FPU_SOFTVFP_FPV4_SP
• --fpu=vfp, __TARGET_FPU_VFPV2
• --fpu=vfpv2, __TARGET_FPU_VFPV2
• --fpu=vfpv3, __TARGET_FPU_VFPV3
• --fpu=vfpv3_fp16, __TARGET_FPU_VFPV3_FP16
• --fpu=vfpv3_d16, __TARGET_FPU_VFPV3_D16
• --fpu=vfpv3_d16_fp16,
__TARGET_FPU_VFPV3_D16_FP16
• --fpu=vfpv4, __TARGET_FPU_VFPV4
• --fpu=vfpv4_d16, __TARGET_FPU_VFPV4_D16
• --fpu=fpv4-sp, __TARGET_FPU_FPV4_SP
__thumb__ - When the compiler is in Thumb state. That is, you have either
specified the --thumb option on the command-line or #pragma
thumb in your source code.
Note
• The compiler might generate some ARM code even if it is
compiling for Thumb.
• __thumb and __thumb__ become defined or undefined when
using #pragma thumb or #pragma arm, but do not change in
cases where Thumb functions are generated as ARM code for
other reasons (for example, a function specified as __irq).
__WCHAR_TYPE__ - In GNU mode. It defines the correct underlying type for the
wchar_t typedef.
__WCHAR_UNSIGNED__ - In GNU mode when you specify the --cpp option. It is defined if
and only if wchar_t is an unsigned type.
__WINT_TYPE__ - In GNU mode. It defines the correct underlying type for the wint_t
typedef.
The following table shows the possible values for __TARGET_ARCH_THUMB, and how these values relate to
versions of the ARM architecture.
v4 4 0
v4T 4 1
v6T2 6 4
v6-M, v6S-M 0 3
v7-A, v7-R 7 4
v7-M, v7E-M 0 4
Related references
10.162 Built-in function name variables on page 10-792.
Name Value
__PRETTY_FUNCTION__ Holds the name of the function as it appears pretty printed in a language-specific fashion.
__PRETTY_FUNCTION__ is a constant string literal. You cannot use the preprocessor to join the contents
to other text to form new tokens.
Related references
10.161 Predefined macros on page 10-786.
Describes the language implementation details for the compiler. Some language implementation details
are common to both C and C++, while others are specific to C++.
It contains the following sections:
• 11.1 Character sets and identifiers in ARM C and C++ on page 11-794.
• 11.2 Basic data types in ARM C and C++ on page 11-796.
• 11.3 Operations on basic data types ARM C and C++ on page 11-798.
• 11.4 Structures, unions, enumerations, and bitfields in ARM C and C++ on page 11-799.
• 11.5 Using the ::operator new function in ARM C++ on page 11-805.
• 11.6 Tentative arrays in ARM C++ on page 11-806.
• 11.7 Old-style C parameters in ARM C++ functions on page 11-807.
• 11.8 Anachronisms in ARM C++ on page 11-808.
• 11.9 Template instantiation in ARM C++ on page 11-809.
• 11.10 Namespaces in ARM C++ on page 11-810.
• 11.11 C++ exception handling in ARM C++ on page 11-812.
• 11.12 Extern inline functions in ARM C++ on page 11-813.
• 11.13 C++11 supported features on page 11-814.
\a 7 Attention (bell)
\b 8 Backspace
\t 9 Horizontal tab
\v 11 Vertical tab
\f 12 Form feed
\r 13 Carriage return
Note
Care must be taken when mixing translation units that have been compiled with and without the
--signed_chars and --unsigned_chars options, and that share interfaces or data structures.
The ARM ABI defines char as an unsigned byte, and this is the interpretation used by the C++
libraries supplied with the ARM compilation tools.
• Converting multibyte characters into the corresponding wide characters for a wide character constant
does not use a locale. This is not relevant to the generic implementation.
Integer
Integers are represented in two's complement form. The low word of a long long is at the low address
in little-endian mode, and at the high address in big-endian mode.
Float
Floating-point quantities are stored in IEEE format:
• float values are represented by IEEE single-precision values
• double and long double values are represented by IEEE double-precision values.
For double and long double quantities the word containing the sign, the exponent, and the most
significant part of the mantissa is stored with the lower machine address in big-endian mode and at the
higher address in little-endian mode.
Note
The IEEE 754 standard for floating-point processing states that the default action to an exception is to
proceed without a trap. You can modify floating-point error handling by tailoring the functions and
definitions in fenv.h.
Pointer subtraction
The following statements apply to all pointers in C. They also apply to pointers in C++, other than
pointers to members:
• When one pointer is subtracted from another, the difference is the result of the expression:
((int)a - (int)b) / (int)sizeof(type pointed to)
• If the pointers point to objects whose alignment is the same as their size, this alignment ensures that
division is exact.
• If the pointers point to objects whose alignment is less than their size, such as packed types and most
structs, both pointers must point to elements of the same array.
Unions
When a member of a union is accessed using a member of a different type, the resulting value can be
predicted from the representation of the original type. No error is given.
Enumerations
An object of type enum is implemented in the smallest integral type that contains the range of the enum.
In C mode, and in C++ mode without --enum_is_int, if an enum contains only positive enumerator
values, the storage type of the enum is the first unsigned type from the following list, according to the
range of the enumerators in the enum. In other modes, and in cases where an enum contains any negative
enumerator values, the storage type of the enum is the first of the following, according to the range of the
enumerators in the enum:
• unsigned char if not using --enum_is_int
• signed char if not using --enum_is_int
• unsigned short if not using --enum_is_int
• signed short if not using --enum_is_int
• signed int
• unsigned int except C with --strict
• signed long long except C with --strict
• unsigned long long except C with --strict.
Note
• In RVCT 4.0, the storage type of the enum being the first unsigned type from the list was only
applicable in GNU (--gnu) mode.
• In ARM Compiler 4.1 and later, the storage type of the enum being the first unsigned type from the
list applies irrespective of mode.
Implementing enum in this way can reduce data size. The command-line option --enum_is_int forces
the underlying type of enum to at least as wide as int.
See the description of C language mappings in the Procedure Call Standard for the ARM® Architecture
specification for more information.
Note
Care must be taken when mixing translation units that have been compiled with and without the
--enum_is_int option, and that share interfaces or data structures.
In strict C, enumerator values must be representable as ints. That is, they must be in the range
-2147483648 to +2147483647, inclusive. A warning is issued for out-of-range enumerator values:
#66: enumeration value is out of "int" range
Such values are treated the same way as in C++, that is, they are treated as unsigned int, long long, or
unsigned long long.
To ensure that out-of-range Warnings are reported, use the following command to change them into
Errors:
armcc --diag_error=66 ...
Structures
The following points apply to:
• all C structures
• all C++ structures and classes not using virtual functions or base classes.
Structures can contain padding to ensure that fields are correctly aligned and that the structure itself is
correctly aligned. The following diagram shows an example of a conventional, nonpacked structure.
Bytes 1, 2, and 3 are padded to ensure correct field alignment. Bytes 11 and 12 are padded to ensure
correct structure alignment. The sizeof() function returns the size of the structure including padding.
0 1 2 3
c padding
4 5 7 8
x
9 10 11 12
s padding
However, if you are compiling C, or compiling C++ with the --cpp and--c90 options, an error is
generated.
A packed structure is one where the alignment of the structure, and of the members within it, is always
one. That is, it has no alignment.
__attribute__((packed)), or __packed in non-gnu mode, allows you to pack structures. When used
on a structure, it lowers the alignment of its members to one. When used on a member, it lowers the
alignment of that member to one.
#pragma pack(n) is an alternative to __attribute__((packed)). However when used on a structure, it
lowers the alignment of its members to the minimum of n, and the natural alignment of the type of the
member. If a member has __attribute__((aligned(m))), the member is aligned to the minimum of m
and n.
Bitfields
In nonpacked structures, ARM Compiler allocates bitfields in containers. A container is a correctly
aligned object of a declared type.
Bitfields are allocated so that the first field specified occupies the lowest-addressed bits of the word,
depending on configuration:
Little-endian
Lowest addressed means least significant.
Big-endian
Lowest addressed means most significant.
A bitfield container can be any of the integral types.
Note
In strict 1990 ISO Standard C, the only types permitted for a bit field are int, signed int, and
unsigned int. For non-int bitfields, the compiler displays an error.
A plain bitfield, declared without either signed or unsigned qualifiers, is treated as unsigned. For
example, int x:10 allocates an unsigned integer of 10 bits.
A bitfield is allocated to the first container of the correct type that has a sufficient number of unallocated
bits, for example:
struct X
{
int x:10;
int y:20;
};
The first declaration creates an integer container and allocates 10 bits to x. At the second declaration, the
compiler finds the existing integer container with a sufficient number of unallocated bits, and allocates y
in the same container as x.
A bitfield is wholly contained within its container. A bitfield that does not fit in a container is placed in
the next container of the same type. For example, the declaration of z overflows the container if an
additional bitfield is declared for the structure:
struct X
{
int x:10;
int y:20;
int z:5;
};
The compiler pads the remaining two bits for the first container and assigns a new integer container for z.
Bitfield containers can overlap each other, for example:
struct X
{
int x:10;
char y:2;
};
The first declaration creates an integer container and allocates 10 bits to x. These 10 bits occupy the first
byte and two bits of the second byte of the integer container. At the second declaration, the compiler
checks for a container of type char. There is no suitable container, so the compiler allocates a new
correctly aligned char container.
Because the natural alignment of char is 1, the compiler searches for the first byte that contains a
sufficient number of unallocated bits to completely contain the bitfield. In the example structure, the
second byte of the int container has two bits allocated to x, and six bits unallocated. The compiler
allocates a char container starting at the second byte of the previous int container, skips the first two
bits that are allocated to x, and allocates two bits to y.
If y is declared char y:8, the compiler pads the second byte and allocates a new char container to the
third byte, because the bitfield cannot overflow its container. The following figure shows the bitfield
allocation for the following example structure:
struct X
{
int x:10;
char y:8;
};
Bit number
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 1 1 10 9 8 7 6 5 4 3 2 1 0
unallocated y padding x
Note
The same basic rules apply to bitfield declarations with different container types. For example, adding an
int bitfield to the example structure gives:
struct X
{
int x:10;
char y:8;
int z:5;
}
The compiler allocates an int container starting at the same location as the int x:10 container and
allocates a byte-aligned char and 5-bit bitfield, as follows:
Bit number
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 1 1 10 9 8 7 6 5 4 3 2 1 0
free z y padding x
The alignment of a bitfield member's container is the same as the alignment of that bitfield member. The
size of a bitfield container is the least multiple of the alignment that fully covers the bitfield, but no
larger than the size of the container-type. The following code examples show this:
#pragma pack(2)
/* The container of b must start at a 2 byte alignment boundary, and must
* have a size no larger than the container type, in this case the size of
* a short. The container of b cannot start at offset 0 (overlapping with a)
* as the bitfield b would then start at offset 2, and would not fully lie
* within the container. Therefore the container for b must start at offset
* 2.
*
* Data layout: 0x11 0x00 0x22 0x22
* Container layout:| a | | b |
*/
struct {
char a;
short b : 16;
} var1 = { 0x11, 0x2222 };
Packed bitfield containers, including all bitfield containers in packed structures, have an alignment of 1.
Therefore the maximum bit padding inserted to align a packed bitfield container is 7 bits.
For an unpacked bitfield container, the maximum bit padding is 8*sizeof(container-type)-1 bits.
Tail-padding is always inserted into the structure as necessary to ensure arrays of the structure have their
elements correctly aligned.
A packed bitfield container is only large enough (in bytes) to hold the bitfield that declared it. Non-
packed bitfield containers are the size of their type.
The following examples illustrate these interactions.
struct A { int z:17; }; // sizeof(A) = 4, alignment = 4
struct A { __packed int z:17; }; // sizeof(A) = 3, alignment = 1
__packed struct A { int z:17; }; // sizeof(A) = 3, alignment = 1
struct A { int x; char y:1; int z:32; }; // sizeof(A) = 12, alignment = 4 [1]
struct A { int x; char y:1; __packed int z:32; }; // sizeof(A) = 12, alignment = 4 [2]
__packed struct A { int x; char y:1; int z:32; }; // sizeof(A) = 9, alignment = 1
Note that [1] and [2] are not identical; the location of z within the structure and the tail-padding differ.
struct example1
{
int a : 8; /* 4-byte container at offset 0 */
__packed int b : 8; /* 1-byte container at offset 1 */
__packed int c : 24; /* 3-byte container at offset 2 */
}; /* Total size 8 (3 bytes tail padding) */;
struct example2
{
__packed int a : 8; /* 1-byte container at offset 0 */
__packed int b : 8; /* 1-byte container at offset 1 */
int c : 8; /* 4-byte container at offset 0 */
}; /* Total size 4 (No tail padding) */
struct example3
{
Related references
10.12 __packed on page 10-612.
10.60 __attribute__((packed)) type attribute on page 10-665.
10.68 __attribute__((packed)) variable attribute on page 10-673.
10.97 #pragma pack(n) on page 10-703.
The compiler option --force_new_nothrow turns all new calls in a compilation into calls to ::operator
new(std::size_t, std::nothrow_t&) or ::operator new[](std::size_t, std::nothrow_t&).
However, this does not affect operator new calls in libraries, nor calls to any class-specific operator
new.
Legacy support
In RVCT v2.0, when the ::operator new function ran out of memory, it raised the signal
SIGOUTOFHEAP, instead of throwing a C++ exception.
In the current release, it is possible to install a new_handler to raise a signal and so restore the RVCT
v2.0 behavior.
Note
Do not rely on the implementation details of this behavior, because it might change in future releases.
In the RVCT v2.x compilers or above, you must use the --anachronisms compiler option if your code
contains any old-style parameters in functions. The compiler warns you if it finds any instances.
Note
In C, this code is legal but has a different meaning. A tentative declaration of f is followed by its
definition.
Related references
8.5 --anachronisms, --no_anachronisms on page 8-321.
Implicit inclusion
When implicit inclusion is enabled, the compiler assumes that if it requires a definition to instantiate a
template entity declared in a .h file it can implicitly include the corresponding .cc file to get the source
code for the definition. For example, if a template entity ABC::f is declared in file xyz.h, and an
instantiation of ABC::f is required in a compilation but no definition of ABC::f appears in the source
code processed by the compilation, then the compiler checks to see if a file xyz.cc exists. If this file
exists, the compiler processes the file as if it were included at the end of the main source file.
To find the template definition file for a given template entity the compiler has to know the full path
name of the file where the template is declared and whether the file is included using the system include
syntax, for example, #include <file.h>. This information is not available for preprocessed source
containing #line directives. Consequently, the compiler does not attempt implicit inclusion for source
code containing #line directives.
The compiler looks for the definition-file suffixes .cc and .CC.
You can turn implicit inclusion mode on or off with the command-line options --implicit_include and
--no_implicit_include.
Implicit inclusions are only performed during the normal compilation of a file, that is, when not using the
-E command-line option.
The lookup of names in template instantiations does not conform to the rules in the standard in the
following respects:
• Although only names from the template definition context are considered for names that are not
functions, the lookup is not limited to those names visible at the point where the template is defined.
• Functions from the context where the template is referenced are considered for all function calls in
the template. Functions from the referencing context are only visible for dependent function calls.
Argument-dependent lookup
When argument-dependent lookup is enabled, functions that are made visible using argument-dependent
lookup can overload with those made visible by normal lookup. The standard requires that this
overloading occur even when the name found by normal lookup is a block extern declaration. The
compiler does this overloading, but in default mode, argument-dependent lookup is suppressed when the
normal lookup finds a block extern.
This means a program can have different behavior, depending on whether it is compiled with or without
argument-dependent lookup, even if the program makes no use of namespaces. For example:
struct A { };
A operator+(A, double);
void f()
{
A a1;
A operator+(A, int);
a1 + 1.0; // calls operator+(A, double) with arg-dependent lookup
} // enabled but otherwise calls operator+(A, int);
Note
The Rogue Wave Standard C++ Library is provided with C++ exceptions enabled.
Related references
8.76 --exceptions_unwind, --no_exceptions_unwind on page 8-404.
8.75 --exceptions, --no_exceptions on page 8-403.
10.85 #pragma exceptions_unwind, #pragma no_exceptions_unwind on page 10-691.
8.76 --exceptions_unwind, --no_exceptions_unwind on page 8-404.
Note
__forceinline does not guarantee the function is inlined, since the decision ultimately lies with the
compiler. Using __forceinline provides a hint, telling the compiler to inline the function if possible.
template<class T>
typename remove_reference<T>::type&&
move(T&& a) noexcept
{
typedef typename remove_reference<T>::type&& RvalRef;
return static_cast<RvalRef>(a);
}
template<class T>
T&&
forward(typename remove_reference<T>::type& a) noexcept
{
return static_cast<T&&>(a);
}
}
ARM Compiler does not implement the C++11 value categories such as prvalue, xvalue and glvalue
as described in A Taxonomy of Expression Value Categories. Instead it implements the draft C++0x
definitions of lvalue and rvalue. In rare cases this may result in some differences in behavior from
the C++11 standard when returning rvalue references from functions.
• Initializer lists and uniform initialization.
ARM Compiler supports initializer lists and uniform initialization, but the standard library does not
provide an implementation of std::initializer_list. With a user-supplied implementation of
std::initializer_list initializer lists and uniform initialization can be used.
• Lambda functions
ARM Compiler supports lambda functions. The standard library provided with the ARM Compiler
does not provide an implementation of std::function. This means that lambda functions can only
be used when type deduction is used.
Within a function auto can be used to store the generated lambda function, a lambda can also be
passed as a parameter to a function template, for example:
#include <iostream>
template<typename T> void call_lambda(T lambda)
{
lambda();
}
void function()
{
auto lambda = [] () { std::cout << “Hello World”; };
call_lambda(lambda);
}
• Range-based for loops.
ARM Compiler supports range-based for loops. However an implementation of
std::initializer_list is required for range-based for loops with braced initializers, for example:
Special member functions can be explicitly given default implementation with =default. ARM
Compiler does not support this for the move constructor or move assignment operator special
member functions. All other special member functions are supported. For example:
struct X
{
// The constructor, destructor, copy constructor
// and copy assignment operator are supported
X() = default;
~X() = default;
X(const X&) = default;
X& operator=(const X&) = default;
// The move constructor and move assignment operator are not supported
X(const X&&) = default;
X& operator=(const X&&) = default;
};
Describes the ARMv6 SIMD instruction intrinsics. SIMD instructions allow the processor to operate on
packed 8-bit or 16-bit values in 32-bit registers.
It contains the following sections:
• 12.1 ARMv6 SIMD intrinsics by prefix on page 12-819.
• 12.2 ARMv6 SIMD intrinsics, summary descriptions, byte lanes, affected flags on page 12-821.
• 12.3 ARMv6 SIMD intrinsics, compatible processors and architectures on page 12-824.
• 12.4 ARMv6 SIMD instruction intrinsics and APSR GE flags on page 12-825.
• 12.5 __qadd16 intrinsic on page 12-827.
• 12.6 __qadd8 intrinsic on page 12-828.
• 12.7 __qasx intrinsic on page 12-829.
• 12.8 __qsax intrinsic on page 12-830.
• 12.9 __qsub16 intrinsic on page 12-831.
• 12.10 __qsub8 intrinsic on page 12-832.
• 12.11 __sadd16 intrinsic on page 12-833.
• 12.12 __sadd8 intrinsic on page 12-834.
• 12.13 __sasx intrinsic on page 12-835.
• 12.14 __sel intrinsic on page 12-836.
• 12.15 __shadd16 intrinsic on page 12-837.
• 12.16 __shadd8 intrinsic on page 12-838.
• 12.17 __shasx intrinsic on page 12-839.
• 12.18 __shsax intrinsic on page 12-840.
• 12.19 __shsub16 intrinsic on page 12-841.
• 12.20 __shsub8 intrinsic on page 12-842.
• 12.21 __smlad intrinsic on page 12-843.
• 12.22 __smladx intrinsic on page 12-844.
Exchange halfwords within one operand, add high __sasx __qasx __shasx __uasx __uqasx __uhasx
halfwords, subtract low halfwords
Exchange halfwords within one operand, subtract __ssax __qsax __shsax __usax __uqsax __uhsax
high halfwords, add low halfwords
Sign-extend __sxtb16 - - - - -
12.2 ARMv6 SIMD intrinsics, summary descriptions, byte lanes, affected flags
The following table describes each ARMv6 SIMD intrinsic, providing a summary description together
with information about byte lanes and affected flags.
Table 12-2 ARMv6 SIMD intrinsics, summary descriptions, byte lanes, affected flags
Returns Operands
__qadd16 2 x 16-bit addition, saturated to range -215 ≤ x ≤ 215 - 1. int16x2 int16x2, int16x2 None
__qadd8 4 x 8-bit addition, saturated to range -27 ≤ x ≤ 27 - 1. int8x4 int8x4, int8x4 None
__qasx Exchange halfwords of second operand, add high halfwords, subtract int16x2 int16x2, int16x2 None
low halfwords, saturating in each case.
__qsax Exchange halfwords of second operand, subtract high halfwords, add int16x2 int16x2, int16x2 None
low halfwords, saturating in each case.
__qsub16 2 x 16-bit subtraction with saturation. int16x2 int16x2, int16x2 None
__qsub8 4 x 8-bit subtraction with saturation. int8x4 int8x4, int8x4 None
__sadd16 2 x 16-bit signed addition. int16x2 int16x2, int16x2 APSR.GE bits
__sadd8 4 x 8-bit signed addition. int8x4 int8x4, int8x4 APSR.GE bits
__sasx Exchange halfwords of second operand, add high halfwords, subtract int16x2 int16x2, int16x2 APSR.GE bits
low halfwords.
__sel Select each byte of the result from either the first operand or the uint8x4 uint8x4, uint8x4 None
second operand, according to the values of the GE bits. For each
result byte, if the corresponding GE bit is set, the byte from the first
operand is selected, otherwise the byte from the second operand is
selected. Because of the way that int16x2 operations set two
(duplicate) GE bits per value, the __sel intrinsic works equally well
on (u)int16x2 and (u)int8x4 data.
__shadd16 2x16-bit signed addition, halving the results. int16x2 int16x2, int16x2 None
__shadd8 4x8-bit signed addition, halving the results. int8x4 int8x4, int8x4 None
__shasx Exchange halfwords of the second operand, add high halfwords and int16x2 int16x2, int16x2 None
subtract low halfwords, halving the results.
__shsax Exchange halfwords of the second operand, subtract high halfwords int16x2 int16x2, int16x2 None
and add low halfwords, halving the results.
__shsub16 2x16-bit signed subtraction, halving the results. int16x2 int16x2, int16x2 None
__shsub8 4x8-bit signed subtraction, halving the results. int8x4 int8x4, int8x4 None
__smlad 2x16-bit multiplication, adding both results to third operand. int32 int16x2, int16x2, Q bit
int32
__smladx Exchange halfwords of the second operand, 2x16-bit multiplication, int16x2 int16x2, int16x2 Q bit
adding both results to third operand.
__smlald 2x16-bit multiplication, adding both results to third operand. int64 int16x2, int16x2, None
Overflow in addition is not detected. int64
Table 12-2 ARMv6 SIMD intrinsics, summary descriptions, byte lanes, affected flags (continued)
Returns Operands
__smlaldx Exchange halfwords of second operand, perform 2x16-bit int64 int16x2, int16x2, None
multiplication, adding both results to third operand. Overflow in int64
addition is not detected.
__smlsd 2x16-bit signed multiplications. Take difference of products, subtract int32 int16x2, int16x2, Q bit
high halfword product from low halfword product, add difference to int32
third operand.
__smlsdx Exchange halfwords of second operand, then 2x16-bit signed int32 int16x2, int16x2, Q bit
multiplications. Product difference is added to a third accumulate int32
operand.
__smlsld 2x16-bit signed multiplications. Take difference of products, int64 int16x2, int16x2, None
subtracting high halfword product from low halfword product, and int64
add difference to third operand. Overflow in addition is not detected.
__smlsldx Exchange halfwords of second operand, then 2x16-bit signed int64 int16x2, int16x2, None
multiplications. Take difference of products, subtracting high u64
halfword product from low halfword product, and add difference to
third operand. Overflow in addition is not detected.
__smuad 2x16-bit signed multiplications, adding the products together. int32 int16x2, int16x2 Q bit
__smusd 2x16-bit signed multiplications. Take difference of products, int32 int16x2, int16x2 None
subtracting high halfword product from low halfword product.
__smusdx 2x16-bit signed multiplications. Product of high halfword of first int32 int16x2, int16x2 None
operand and low halfword of second operand is subtracted from
product of low halfword of first operand and high halfword of
second operand, and difference is added to third operand.
__ssat16 2x16-bit signed saturation to a selected width. int16x2 int16x2, / Q bit
*constant*/
unsigned int
__ssax Exchange halfwords of second operand, subtract high halfwords and int16x2 int16x2, int16x2 APSR.GE bits
add low halfwords.
__ssub16 2x16-bit signed subtraction. int16x2 int16x2, int16x2 APSR.GE bits
__ssub8 4x8-bit signed subtraction. int8x4 int8x4 APSR.GE bits
__smuadx Exchange halfwords of second operand, perform 2x16-bit signed int32 int16x2, int16x2 Q bit
multiplications, and add products together.
__sxtab16 Two values at bit positions [23:16][7:0] are extracted from second int16x2 int8x4, int16x2 None
operand, sign-extended to 16 bits, and added to first operand.
__sxtb16 Two values at bit positions [23:16][7:0] are extracted from the int16x2 int8x4 None
operand and sign-extended to 16 bits.
__uadd16 2x16-bit unsigned addition. uint16x2 uint16x2, uint16x2 APSR.GE bits
__uadd8 4x8-bit unsigned addition. uint8x4 uint8x4, uint8x4 APSR.GE bits
__uasx Exchange halfwords of second operand, add high halfwords and uint16x2 uint16x2, uint16x2 APSR.GE bits
subtract low halfwords.
__uhadd16 2x16-bit unsigned addition, halving the results. uint16x2 uint16x2, uint16x2 None
Table 12-2 ARMv6 SIMD intrinsics, summary descriptions, byte lanes, affected flags (continued)
Returns Operands
__uhadd8 4x8-bit unsigned addition, halving the results. uint8x4 uint8x4, uint8x4 None
__uhasx Exchange halfwords of second operand, add high halfwords and uint16x2 uint16x2, uint16x2 None
subtract low halfwords, halving the results.
__uhsax Exchange halfwords of second operand, subtract high halfwords and uint16x2 uint16x2, uint16x2 None
add low halfwords, halving the results.
__uhsub16 2x16-bit unsigned subtraction, halving the results. uint16x2 uint16x2, uint16x2 None
__uhsub8 4x8-bit unsigned subtraction, halving the results. uint8x4 uint8x4 None
__uqadd16 2x16-bit unsigned addition, saturating to range 0 ≤ x ≤ 216 - 1. uint16x2 uint16x2, uint16x2 None
__uqadd8 4x8-bit unsigned addition, saturating to range 0 ≤ x ≤ 28 - 1. uint8x4 uint8x4, uint8x4 None
__uqasx Exchange halfwords of second operand, perform saturating unsigned uint16x2 uint16x2, uint16x2 None
addition on high halfwords and saturating unsigned subtraction on
low halfwords.
__uqsax Exchange halfwords of second operand, perform saturating unsigned uint16x2 uint16x2, uint16x2 None
subtraction on high halfwords and saturating unsigned addition on
low halfwords.
__uqsub16 2x16-bit unsigned subtraction, saturating to range 0 ≤ x ≤ 216 - 1. uint16x2 uint16x2, uint16x2 None
__uqsub8 4x8-bit unsigned subtraction, saturating to range 0 ≤ x ≤ 28 - 1. uint8x4 uint8x4, uint8x4 None
__usad8 4x8-bit unsigned subtraction, add absolute values of the differences uint32 uint8x4, uint8x4 None
together, return result as single unsigned integer.
__usada8 4x8-bit unsigned subtraction, add absolute values of the differences uint32 uint8x4, uint8x4, None
together, and add result to third operand. uint32
__usax Exchange halfwords of second operand, subtract high halfwords and uint16x2 uint16x2, uint16x2 APSR.GE bits
add low halfwords.
__usat16 Saturate two 16-bit values to a selected unsigned range. Input values int16x2 int16x2, / Q flag
are signed and output values are non-negative. *constant*/
unsigned int
__usub16 2x16-bit unsigned subtraction. uint16x2 uint16x2, uint16x2 APSR.GE bits
__usub8 4x8-bit unsigned subtraction. uint8x4 uint8x4, uint8x4 APSR.GE bits
__uxtab16 Two values at bit positions [23:16][7:0] are extracted from the uint16x2 uint8x4, uint16x2 None
second operand, zero-extended to 16 bits, and added to the first
operand.
__uxtb16 Two values at bit positions [23:16][7:0] are extracted from the uint16x2 uint8x4 None
operand and zero-extended to 16 bits.
__qadd16, 6, 6K, 6T2, 6Z, 7-A, 7-R, 7-A.security, Cortex-R4, Cortex-R4F, Cortex-R7, Cortex-
__qadd8, R7.no_vfp, Cortex-R8, Cortex-R8.no_vfp, Cortex-A5, Cortex-A8, Cortex-A8.no_neon,
__qasx Cortex-A8NoNEON, Cortex-A9, Cortex-A9.no_neon, Cortex-A9.no_neon.no_vfp, Cortex-A12,
Cortex-A12.no_neon.no_vfp, Cortex-A15, Cortex-A15.no_neon, Cortex-
A15.no_neon.no_vfp, Cortex-A7, Cortex-A7.no_neon, Cortex-A7.no_neon.no_vfp, Cortex-
A17, Cortex-A17.no_neon.no_vfp, Cortex-M4, Cortex-M4.fp.sp, Cortex-M7, Cortex-
M7.fp.sp, Cortex-M7.fp.dp, ARM1136J-S, ARM1136JF-S, ARM1136J-S-rev1, ARM1136JF-S-
rev1, ARM1156T2-S, ARM1176JZ-S, ARM1176JZF-S, MPCore, MPCore.no_vfp, MPCoreNoVFP,
QSP, QSP.no_neon, QSP.no_neon.no_vfp
Related references
8.42 --cpu=list on page 8-367.
8.43 --cpu=name on page 8-368.
Table 12-4 ARMv6 SIMD instruction intrinsics and APSR GE flags (continued)
Syntax
unsigned int __qadd16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first two 16-bit summands
val2
holds the second two 16-bit summands.
Return value
The __qadd16 intrinsic returns:
• The saturated addition of the low halfwords in the low halfword of the return value
• The saturated addition of the high halfwords in the high halfword of the return value.
The returned results are saturated to the 16-bit signed integer range -215 ≤ x ≤ 215 - 1.
Example
unsigned int add_halfwords(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __qadd16(val1, val2); /* res[15:0] = val1[15:0] + val2[15:0]
res[16:31] = val1[31:16] + val2[31:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
QADD16.
Saturating instructions.
ARM and Thumb instruction summary.
Syntax
unsigned int __qadd8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit summands
val2
holds the other four 8-bit summands.
Return value
The __qadd8 intrinsic returns:
• The saturated addition of the first byte of each operand in the first byte of the return value
• The saturated addition of the second byte of each operand in the second byte of the return value
• The saturated addition of the third byte of each operand in the third byte of the return value
• The saturated addition of the fourth byte of each operand in the fourth byte of the return value.
The returned results are saturated to the 8-bit signed integer range -27 ≤ x ≤ 27 - 1.
Example
unsigned int add_bytes(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __qadd8(val1,val2); /* res[7:0] = val1[7:0] + val2[7:0]
res[15:8] = val1[15:8] + val2[15:8]
res[23:16] = val1[23:16] + val2[23:16]
res[31:24] = val1[31:24] + val2[31:24]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
QADD8.
Saturating instructions.
ARM and Thumb instruction summary.
Syntax
unsigned int __qasx(unsigned int val1, unsigned int val2)
Where:
val1
holds the first operand for the subtraction in the low halfword, and the first operand for the
addition in the high halfword
val2
holds the second operand for the subtraction in the high halfword, and the second operand for
the addition in the low halfword.
Return value
The __qasx intrinsic returns:
• The saturated subtraction of the high halfword in the second operand from the low halfword in the
first operand, in the low halfword of the return value.
• The saturated addition of the high halfword in the first operand and the low halfword in the second
operand, in the high halfword of the return value.
The returned results are saturated to the 16-bit signed integer range -215 ≤ x ≤ 215 - 1.
Example
unsigned int exchange_add_and_subtract(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __qasx(val1,val2); /* res[15:0] = val1[15:0] - val2[31:16]
res[31:16] = val1[31:16] + val2[15:0]
*/
/* Alternative equivalent representation:
val2[15:0][31:16] = val2[31:16][15:0]
res[15:0] = val1[15:0] - val2[15:0]
res[31:16] = val[31:16] + val2[31:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
QASX.
Saturating instructions.
ARM and Thumb instruction summary.
Syntax
unsigned int __qsax(unsigned int val1, unsigned int val2)
Where:
val1
holds the first operand for the addition in the low halfword, and the first operand for the
subtraction in the high halfword
val2
holds the second operand for the addition in the high halfword, and the second operand for the
subtraction in the low halfword.
Return value
The __qsax intrinsic returns:
• The saturated addition of the low halfword of the first operand and the high halfword of the second
operand, in the low halfword of the return value.
• The saturated subtraction of the low halfword of the second operand from the high halfword of the
first operand, in the high halfword of the return value.
The returned results are saturated to the 16-bit signed integer range -215 ≤ x ≤ 215 - 1.
Example
unsigned int exchange_subtract_and_add(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __qsax(val1,val2); /* res[15:0] = val1[15:0] + val2[31:16]
res[31:16] = val1[31:16] - val2[15:0]
*/
/* Alternative equivalent representation:
val2[15:0][31:16] = val2[31:16][15:0]
res[15:0] = val1[15:0] + val2[15:0]
res[31:16] = val[31:16] - val2[31:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
QSAX.
Saturating instructions.
ARM and Thumb instruction summary.
Syntax
unsigned int __qsub16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first halfword operands
val2
holds the second halfword operands.
Return value
The __qsub16 intrinsic returns:
• The saturated subtraction of the low halfword in the second operand from the low halfword in the
first operand, in the low halfword of the returned result.
• The saturated subtraction of the high halfword in the second operand from the high halfword in the
first operand, in the high halfword of the returned result.
The returned results are saturated to the 16-bit signed integer range -215 ≤ x ≤ 215 - 1.
Example
unsigned int subtract_halfwords(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __qsub16(val1,val2); /* res[15:0] = val1[15:0] - val2[15:0]
res[31:16] = val1[31:16] - val2[31:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
QSUB16.
Saturating instructions.
ARM and Thumb instruction summary.
Syntax
unsigned int __qsub8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit operands
val2
holds the second four 8-bit operands.
Return value
The __qsub8 intrinsic returns:
• The subtraction of the first byte in the second operand from the first byte in the first operand, in the
first byte of the return value.
• The subtraction of the second byte in the second operand from the second byte in the first operand, in
the second byte of the return value.
• The subtraction of the third byte in the second operand from the third byte in the first operand, in the
third byte of the return value.
• The subtraction of the fourth byte in the second operand from the fourth byte in the first operand, in
the fourth byte of the return value.
The returned results are saturated to the 8-bit signed integer range -27 ≤ x ≤ 27 - 1.
Example
unsigned int subtract_bytes(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __qsub8(val1,val2); /* res[7:0] = val1[7:0] - val2[7:0]
res[15:8] = val1[15:8] - val2[15:8]
res[23:16] = val1[23:16] - val2[23:16]
res[31:24] = val1[31:24] - val2[31:24]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
QSUB8.
Saturating instructions.
ARM and Thumb instruction summary.
Syntax
unsigned int __sadd16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first two 16-bit summands
val2
holds the second two 16-bit summands.
Return value
The __sadd16 intrinsic returns:
• The addition of the low halfwords in the low halfword of the return value.
• The addition of the high halfwords in the high halfword of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[15:0] ≥ 0 then APSR.GE[1:0] = 11 else 00.
• If res[31:16] ≥ 0 then APSR.GE[3:2] = 11 else 00.
Example
unsigned int add_halfwords(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __sadd16(val1,val2); /* res[15:0] = val1[15:0] + val2[15:0]
res[31:16] = val1[31:16] + val2[31:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
12.14 __sel intrinsic on page 12-836.
Related information
SADD16.
Saturating instructions.
ARM and Thumb instruction summary.
Syntax
unsigned int __sadd8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit summands
val2
holds the second four 8-bit summands.
Return value
The __sadd8 intrinsic returns:
• The addition of the first bytes from each operand, in the first byte of the return value.
• The addition of the second bytes of each operand, in the second byte of the return value.
• The addition of the third bytes of each operand, in the third byte of the return value.
• The addition of the fourth bytes of each operand, in the fourth byte of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[7:0] ≥ 0 then APSR.GE[0] = 1 else 0.
• If res[15:8] ≥ 0 then APSR.GE[1] = 1 else 0.
• If res[23:16] ≥ 0 then APSR.GE[2] = 1 else 0.
• If res[31:24] ≥ 0 then APSR.GE[3] = 1 else 0.
Example
unsigned int add_bytes(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __sadd16(val1,val2); /* res[7:0] = val1[7:0] + val2[7:0]
res[15:8] = val1[15:8] + val2[15:8]
res[23:16] = val1[23:16] + val2[23:16]
res[31:24] = val1[31:24] + val2[31:24]
*/
return res;
}
Related references
12.14 __sel intrinsic on page 12-836.
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SADD8.
Saturating instructions.
ARM and Thumb instruction summary.
Syntax
unsigned int __sasx(unsigned int val1, unsigned int val2)
Where:
val1
holds the first operand for the subtraction in the low halfword, and the first operand for the
addition in the high halfword
val2
holds the second operand for the subtraction in the high halfword, and the second operand for
the addition in the low halfword.
Return value
The __sasx intrinsic returns:
• The subtraction of the high halfword in the second operand from the low halfword in the first
operand, in the low halfword of the return value.
• The addition of the high halfword in the first operand and the low halfword in the second operand, in
the high halfword of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[15:0] ≥ 0 then APSR.GE[1:0] = 11 else 00.
• If res[31:16] ≥ 0 then APSR.GE[3:2] = 11 else 00.
Example
unsigned int exchange_subtract_add(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __sasx(val1,val2); /* res[15:0] = val1[15:0] - val2[31:16]
res[31:16] = val1[31:16] + val2[15:0]
*/
return res;
}
Related references
12.14 __sel intrinsic on page 12-836.
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SASX.
ARM and Thumb instruction summary.
Syntax
unsigned int __sel(unsigned int val1, unsigned int val2)
Where:
val1
holds four selectable bytes
val2
holds four selectable bytes.
Return value
The __sel intrinsic selects bytes from the input parameters and returns them in the return value, res,
according to the following criteria:
if APSR.GE[0] == 1 then res[7:0] = val1[7:0] else res[7:0] = val2[7:0]
if APSR.GE[1] == 1 then res[15:8] = val1[15:8] else res[15:8] = val2[15:8]
if APSR.GE[2] == 1 then res[23:16] = val1[23:16] else res[23:16] = val2[23:16]
if APSR.GE[3] == 1 then res[31:24] = val1[31:24] else res = val2[31:24]
Example
unsigned int ge_filter(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __sel(val1,val2);
return res;
}
unsigned int foo(unsigned int a, unsigned int b)
{
int res;
int filtered_res;
res = __sasx(a,b); /* This intrinsic sets the GE flags */
filtered_res = ge_filter(res); /* Filter the results of the __sasx */
/* intrinsic. Some results are filtered */
/* out based on the GE flags. */
return filtered_res;
}
Related references
12.11 __sadd16 intrinsic on page 12-833.
12.13 __sasx intrinsic on page 12-835.
12.34 __ssax intrinsic on page 12-856.
12.36 __ssub8 intrinsic on page 12-858.
12.35 __ssub16 intrinsic on page 12-857.
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SEL.
ARM and Thumb instruction summary.
Syntax
unsigned int __shadd16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first two 16-bit summands
val2
holds the second two 16-bit summands.
Return value
The __shadd16 intrinsic returns:
• The halved addition of the low halfwords from each operand, in the low halfword of the return value.
• The halved addition of the high halfwords from each operand, in the high halfword of the return
value.
Example
unsigned int add_and_halve(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __shadd16(val1,val2); /* res[15:0] = (val1[15:0] + val2[15:0]) >> 1
res[31:16] = (val1[31:16] + val2[31:16]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SHADD16.
ARM and Thumb instruction summary.
Syntax
unsigned int __shadd8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit summands
val2
holds the second four 8-bit summands.
Return value
The __shadd8 intrinsic returns:
• The halved addition of the first bytes from each operand, in the first byte of the return value.
• The halved addition of the second bytes from each operand, in the second byte of the return value.
• The halved addition of the third bytes from each operand, in the third byte of the return value.
• The halved addition of the fourth bytes from each operand, in the fourth byte of the return value.
Example
unsigned int add_and_halve(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __shadd8(val1,val2); /* res[7:0] = (val1[7:0] + val2[7:0]) >> 1
res[15:8] = (val1[15:8] + val2[15:8]) >> 1
res[23:16] = (val1[23:16] + val2[23:16]) >> 1
res[31:24] = (val1[31:24] + val2[31:24]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SHADD8.
ARM and Thumb instruction summary.
Syntax
unsigned int __shasx(unsigned int val1, unsigned int val2)
Where:
val1
holds the first halfword operands
val2
holds the second halfword operands.
Return value
The __shasx intrinsic returns:
• The halved subtraction of the high halfword in the second operand from the low halfword in the first
operand, in the low halfword of the return value.
• The halved subtraction of the low halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
Example
unsigned int exchange_add_subtract_halve(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __shasx(val1,val2); /* res[15:0] = (val1[15:0] - val2[31:16]) >> 1
res[31:16] = (val1[31:16] - val2[15:0]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SHASX.
ARM and Thumb instruction summary.
Syntax
unsigned int __shsax(unsigned int val1, unsigned int val2)
Where:
val1
holds the first halfword operands
val2
holds the second halfword operands.
Return value
The __shsax intrinsic returns:
• The halved addition of the low halfword in the first operand and the high halfword in the second
operand, in the low halfword of the return value.
• The halved subtraction of the low halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
Example
unsigned int exchange_subtract_add_halve(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __shsax(val1,val2); /* res[15:0] = (val1[15:0] + val2[31:16]) >> 1
res[31:16] = (val1[31:16] - val2[15:0]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SHSAX.
ARM and Thumb instruction summary.
Syntax
unsigned int __shsub16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first halfword operands
val2
holds the second halfword operands.
Return value
The __shsub16 intrinsic returns:
• The halved subtraction of the low halfword in the second operand from the low halfword in the first
operand, in the low halfword of the return value.
• The halved subtraction of the high halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
Example
unsigned int add_and_halve(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __shsub16(val1,val2); /* res[15:0] = (val1[15:0] - val2[15:0]) >> 1
res[31:16] = (val1[31:16] - val2[31:16]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SHSUB16.
ARM and Thumb instruction summary.
Syntax
unsigned int __shsub8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four operands
val2
holds the second four operands.
Return value
The __shsub8 intrinsic returns:
• The halved subtraction of the first byte in the second operand from the first byte in the first operand,
in the first byte of the return value.
• The halved subtraction of the second byte in the second operand from the second byte in the first
operand, in the second byte of the return value.
• The halved subtraction of the third byte in the second operand from the third byte in the first operand,
in the third byte of the return value.
• The halved subtraction of the fourth byte in the second operand from the fourth byte in the first
operand, in the fourth byte of the return value.
Example
unsigned int subtract_and_halve(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __shsub8(val1,val2); /* res[7:0] = (val1[7:0] - val2[7:0]) >> 1
res[15:8] = (val1[15:8] - val2[15:8]) >> 1
res[23:16] = (val1[23:16] - val2[23:16] >> 1
res[31:24] = (val1[31:24] - val2[31:24] >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SHSUB8.
ARM and Thumb instruction summary.
Syntax
unsigned int __smlad(unsigned int val1, unsigned int val2, unsigned int val3)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication
val3
holds the accumulate value.
Return value
The __smlad intrinsic returns the product of each multiplication added to the accumulate value, as a 32-
bit integer.
Example
unsigned int dual_multiply_accumulate(unsigned int val1, unsigned int val2, unsigned int
val3)
{
unsigned int res;
res = __smlad(val1,val2,val3); /* p1 = val1[15:0] × val2[15:0]
p2 = val1[31:16] × val2[31:16]
res[31:0] = p1 + p2 + val3[31:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMLAD.
ARM and Thumb instruction summary.
Syntax
unsigned int __smladx(unsigned int val1, unsigned int val2, unsigned int val3)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication
val3
holds the accumulate value.
Return value
The __smladx intrinsic returns the product of each multiplication added to the accumulate value, as a 32-
bit integer.
Example
unsigned int dual_multiply_accumulate(unsigned int val1, unsigned int val2, unsigned int
val3)
{
unsigned int res;
res = __smladx(val1,val2,val3); /* p1 = val1[15:0] × val2[31:16]
p2 = val1[31:16] × val2[15:0]
res[31:0] = p1 + p2 + val3[31:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMLAD.
ARM and Thumb instruction summary.
Syntax
unsigned long long __smlald(unsigned int val1, unsigned int val2, unsigned long long
val3)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication
val3
holds the accumulate value.
Return value
The __smlald intrinsic returns the product of each multiplication added to the accumulate value.
Example
unsigned int dual_multiply_accumulate(unsigned int val1, unsigned int val2, unsigned int
val3)
{
unsigned int res;
res = __smlald(val1,val2,val3); /* p1 = val1[15:0] × val2[15:0]
p2 = val1[31:16] × val2[31:16]
sum = p1 + p2 + val3[63:32][31:0]
res[63:32] = sum[63:32]
res[31:0] = sum[31:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMLALD.
ARM and Thumb instruction summary.
Syntax
unsigned long long __smlaldx(unsigned int val1, unsigned int val2, unsigned long long
val3)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication
val3
holds the accumulate value.
Return value
The __smlald intrinsic returns the product of each multiplication added to the accumulate value.
Example
unsigned int dual_multiply_accumulate(unsigned int val1, unsigned int val2, unsigned int
val3)
{
unsigned int res;
res = __smlald(val1,val2,val3); /* p1 = val1[15:0] × val2[31:16]
p2 = val1[31:16] × val2[15:0]
sum = p1 + p2 + val3[63:32][31:0]
res[63:32] = sum[63:32]
res[31:0] = sum[31:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMLALDX.
ARM and Thumb instruction summary.
Syntax
unsigned int __smlsd(unsigned int val1, unsigned int val2, unsigned int val3)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication
val3
holds the accumulate value.
Return value
The __smlsd intrinsic returns the difference of the product of each multiplication, added to the
accumulate value.
Example
unsigned int dual_multiply_diff_prods(unsigned int val1, unsigned int val2, unsigned int
val3)
{
unsigned int res;
res = __smlsd(val1,val2,val3); /* p1 = val1[15:0] × val2[15:0]
p2 = val1[31:16] × val2[31:16]
res[31:0] = p1 - p2 + val3[31:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMLSD.
ARM and Thumb instruction summary.
Syntax
unsigned int __smlsdx(unsigned int val1, unsigned int val2, unsigned int val3)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication
val3
holds the accumulate value.
Return value
The __smlsd intrinsic returns the difference of the product of each multiplication, added to the
accumulate value.
Example
unsigned int dual_multiply_diff_prods(unsigned int val1, unsigned int val2, unsigned int
val3)
{
unsigned int res;
res = __smlsd(val1,val2,val3); /* p1 = val1[15:0] × val2[31:16]
p2 = val1[31:16] × val2[15:0]
res[31:0] = p1 - p2 + val3[31:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMLSDX.
ARM and Thumb instruction summary.
Syntax
unsigned long long __smlsld(unsigned int val1, unsigned int val2, unsigned long long
val3)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication
val3
holds the accumulate value.
Return value
The __smlsld intrinsic returns the difference of the product of each multiplication, added to the
accumulate value.
Example
unsigned long long dual_multiply_diff_prods(unsigned int val1, unsigned int val2, unsigned
long long val3)
{
unsigned int res;
res = __smlsld(val1,val2,val3); /* p1 = val1[15:0] × val2[15:0]
p2 = val1[31:16] × val2[31:16]
res[63:0] = p1 - p2 + val3[63:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMLSLD.
ARM and Thumb instruction summary.
Syntax
unsigned long long __smlsldx(unsigned int val1, unsigned int val2, unsigned long long
val3)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication
val3
holds the accumulate value.
Return value
The __smlsld intrinsic returns the difference of the product of each multiplication, added to the
accumulate value.
Example
unsigned long long dual_multiply_diff_prods(unsigned int val1, unsigned int val2, unsigned
long long val3)
{
unsigned int res;
res = __smlsld(val1,val2,val3); /* p1 = val1[15:0] × val2[31:16]
p2 = val1[31:16] × val2[15:0]
res[63:0] = p1 - p2 + val3[63:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMLSLDX.
ARM and Thumb instruction summary.
Syntax
unsigned int __smuad(unsigned int val1, unsigned int val2)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication.
Return value
The __smuad intrinsic returns the products of the two 16-bit signed multiplications.
Example
unsigned int dual_multiply_prods(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __smuad(val1,val2); /* p1 = val1[15:0] × val2[15:0]
p2 = val1[31:16] × val2[31:16]
res[31:0] = p1 + p2
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMUAD.
ARM and Thumb instruction summary.
Syntax
unsigned int __smuadx(unsigned int val1, unsigned int val2)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication.
Return value
The __smuadx intrinsic returns the products of the two 16-bit signed multiplications.
Example
unsigned int exchange_dual_multiply_prods(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __smuadx(val1,val2); /* val2[31:16][15:0] = val2[15:0][31:16]
p1 = val1[15:0] × val2[15:0]
p2 = val1[31:16] × val2[31:16]
res[31:0] = p1 + p2
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMUADX.
ARM and Thumb instruction summary.
Syntax
unsigned int __smusd(unsigned int val1, unsigned int val2)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication.
Return value
The __smusd intrinsic returns the difference of the products of the two 16-bit signed multiplications.
Example
unsigned int dual_multiply_prods(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __smuad(val1,val2); /* p1 = val1[15:0] × val2[15:0]
p2 = val1[31:16] × val2[31:16]
res[31:0] = p1 - p2
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMUSD.
ARM and Thumb instruction summary.
Syntax
unsigned int __smusdx(unsigned int val1, unsigned int val2)
Where:
val1
holds the first halfword operands for each multiplication
val2
holds the second halfword operands for each multiplication.
Return value
The __smusdx intrinsic returns the difference of the products of the two 16-bit signed multiplications.
Example
unsigned int dual_multiply_prods(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __smuad(val1,val2); /* p1 = val1[15:0] × val2[31:16]
p2 = val1[31:16] × val2[15:0]
res[31:0] = p1 - p2
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SMUSDX.
ARM and Thumb instruction summary.
Syntax
unsigned int __saturate_halfwords(unsigned int val1, unsigned int val2)
Where:
val1
holds the two signed 16-bit values to be saturated
val2
is the bit position for saturation, an integral constant expression in the range 1 to 16.
Return value
The __ssat16 intrinsic returns:
• The signed saturation of the low halfword in val1, saturated to the bit position specified in val2 and
returned in the low halfword of the return value.
• The signed saturation of the high halfword in val1, saturated to the bit position specified in val2 and
returned in the high halfword of the return value.
Example
unsigned int saturate_halfwords(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __ssat16(val1,val2); /* Saturate halfwords in val1 to the signed
range specified by the bit position in val2 */
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SSAT16.
Saturating instructions.
ARM and Thumb instruction summary.
Syntax
unsigned int __ssax(unsigned int val1, unsigned int val2)
Where:
val1
holds the first operand for the addition in the low halfword, and the first operand for the
subtraction in the high halfword
val2
holds the second operand for the addition in the high halfword, and the second operand for the
subtraction in the low halfword.
Return value
The __ssax intrinsic returns:
• The addition of the low halfword in the first operand and the high halfword in the second operand, in
the low halfword of the return value.
• The subtraction of the low halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[15:0] ≥ 0 then APSR.GE[1:0] = 11 else 00.
• If res[31:16] ≥ 0 then APSR.GE[3:2] = 11 else 00.
Example
unsigned int exchange_subtract_add(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __ssax(val1,val2); /* res[15:0] = val1[15:0] + val2[31:16]
res[31:16] = val1[31:16] - val2[15:0]
*/
return res;
}
Related references
12.14 __sel intrinsic on page 12-836.
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SSAX.
ARM and Thumb instruction summary.
Syntax
unsigned int __ssub16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first operands of each subtraction in the low and the high halfwords
val2
holds the second operands for each subtraction in the low and the high halfwords.
Return value
The __ssub16 intrinsic returns:
• The subtraction of the low halfword in the second operand from the low halfword in the first operand,
in the low halfword of the return value.
• The subtraction of the high halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[15:0] ≥ 0 then APSR.GE[1:0] = 11 else 00.
• If res[31:16] ≥ 0 then APSR.GE[3:2] = 11 else 00.
Example
unsigned int subtract halfwords(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __ssub16(val1,val2); /* res[15:0] = val1[15:0] - val2[15:0]
res[31:16] = val1[31:16] - val2[31:16]
*/
return res;
}
Related references
12.14 __sel intrinsic on page 12-836.
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SSUB16.
ARM and Thumb instruction summary.
Syntax
unsigned int __ssub8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit operands of each subtraction
val2
holds the second four 8-bit operands of each subtraction.
Return value
The __ssub8 intrinsic returns:
• The subtraction of the first byte in the second operand from the first byte in the first operand, in the
first bytes of the return value.
• The subtraction of the second byte in the second operand from the second byte in the first operand, in
the second byte of the return value.
• The subtraction of the third byte in the second operand from the third byte in the first operand, in the
third byte of the return value.
• The subtraction of the fourth byte in the second operand from the fourth byte in the first operand, in
the fourth byte of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[8:0] ≥ 0 then APSR.GE[0] = 1 else 0.
• If res[15:8] ≥ 0 then APSR.GE[1] = 1 else 0.
• If res[23:16] ≥ 0 then APSR.GE[2] = 1 else 0.
• If res[31:24] ≥ 0 then APSR.GE[3] = 1 else 0.
Example
unsigned int subtract bytes(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __ssub8(val1,val2); /* res[7:0] = val1[7:0] - val2[7:0]
res[15:8] = val1[15:8] - val2[15:8]
res[23:16] = val1[23:16] - val2[23:16]
res[31:24] = val1[31:24] - val2[31:24]
*/
return res;
}
Related references
12.14 __sel intrinsic on page 12-836.
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SSUB8.
ARM and Thumb instruction summary.
Syntax
unsigned int __sxtab16(unsigned int val1, unsigned int val2)
Where:
val1
holds the values that the extracted and sign-extended values are added to
val2
holds the two 8-bit values to be extracted and sign-extended.
Return value
The __sxtab16 intrinsic returns the addition of val1 and val2, where the 8-bit values in val2[7:0] and
val2[23:16] have been extracted and sign-extended before the addition.
Example
unsigned int extract_sign_extend_and_add(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __sxtab16(val1,val2); /* res[15:0]
= val1[15:0] + SignExtended(val2[7:0])
res[31:16]
= val1[31:16] + SignExtended(val2[23:16])
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SXTAB16.
ARM and Thumb instruction summary.
Syntax
unsigned int __sxtb16(unsigned int val)
Where val[7:0] and val[23:16] hold the two 8-bit values to be sign-extended.
Return value
The __sxtb16 intrinsic returns the 8-bit values sign-extended to 16-bit values.
Example
unsigned int sign_extend(unsigned int val)
{
unsigned int res;
res = __sxtb16(val1,val2); /* res[15:0] = SignExtended(val[7:0]
res[31:16] = SignExtended(val[23:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
SXTB16.
ARM and Thumb instruction summary.
Syntax
unsigned int __uadd16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first two halfword summands for each addition
val2
holds the second two halfword summands for each addition.
Return value
The __uadd16 intrinsic returns:
• The addition of the low halfwords in each operand, in the low halfword of the return value.
• The addition of the high halfwords in each operand, in the high halfword of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[15:0] ≥ 0x10000 then APSR.GE[0] = 11 else 00.
• If res[31:16] ≥ 0x10000 then APSR.GE[1] = 11 else 00.
Example
unsigned int add_halfwords(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uadd16(val1,val2); /* res[15:0] = val1[15:0] + val2[15:0]
res[31:16] = val1[31:16] + val2[31:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UADD16.
ARM and Thumb instruction summary.
Syntax
unsigned int __uadd8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit summands for each addition
val2
holds the second four 8-bit summands for each addition.
Return value
The __uadd8 intrinsic returns:
• The addition of the first bytes in each operand, in the first byte of the return value.
• The addition of the second bytes in each operand, in the second byte of the return value.
• The addition of the third bytes in each operand, in the third byte of the return value.
• The addition of the fourth bytes in each operand, in the fourth byte of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[7:0] ≥ 0x100 then APSR.GE[0] = 1 else 0.
• If res[15:8] ≥ 0x100 then APSR.GE[1] = 1 else 0.
• If res[23:16] ≥ 0x100 then APSR.GE[2] = 1 else 0.
• If res[31:24] ≥ 0x100 then APSR.GE[3] = 1 else 0.
Example
unsigned int add_bytes(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uadd8(val1,val2); /* res[7:0] = val1[7:0] + val2[7:0]
res[15:8] = val1[15:8] + val2[15:8]
res[23:16] = val1[23:16] + val2[23:16]
res[31:24] = val1[31:24] + val2[31:24]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UADD8.
ARM and Thumb instruction summary.
Syntax
unsigned int __uasx(unsigned int val1, unsigned int val2)
Where:
val1
holds the first operand for the subtraction in the low halfword, and the first operand for the
addition in the high halfword
val2
holds the second operand for the subtraction in the high halfword and the second operand for the
addition in the low halfword.
Return value
The __uasx intrinsic returns:
• The subtraction of the high halfword in the second operand from the low halfword in the first
operand, in the low halfword of the return value.
• The addition of the high halfword in the first operand and the low halfword in the second operand, in
the high halfword of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[15:0] ≥ 0 then APSR.GE[1:0] = 11 else 00.
• If res[31:16] ≥ 0x10000 then APSR.GE[3:2] = 11 else 00.
Example
unsigned int exchange_add_subtract(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uasx(val1,val2); /* res[15:0] = val1[15:0] - val2[31:16]
res[31:16] = val1[31:16] + val2[15:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UASX.
ARM and Thumb instruction summary.
Syntax
unsigned int __uhadd16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first two 16-bit summands
val2
holds the second two 16-bit summands.
Return value
The __uhadd16 intrinsic returns:
• The halved addition of the low halfwords in each operand, in the low halfword of the return value.
• The halved addition of the high halfwords in each operand, in the high halfword of the return value.
Example
unsigned int add_halfwords_then_halve(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uhadd16(val1,val2); /* res[15:0] = (val1[15:0] + val2[15:0]) >> 1
res[31:16] = (val1[31:16] + val2[31:16]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UHADD16.
ARM and Thumb instruction summary.
Syntax
unsigned int __uhadd8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit summands
val2
holds the second four 8-bit summands.
Return value
The __uhadd8 intrinsic returns:
• The halved addition of the first bytes in each operand, in the first byte of the return value.
• The halved addition of the second bytes in each operand, in the second byte of the return value.
• The halved addition of the third bytes in each operand, in the third byte of the return value.
• The halved addition of the fourth bytes in each operand, in the fourth byte of the return value.
Example
unsigned int add_bytes_then_halve(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uhadd8(val1,val2); /* res[7:0] = (val1[7:0] + val2[7:0]) >> 1
res[15:8] = (val1[15:8] + val2[15:8]) >> 1
res[23:16] = (val1[23:16] + val2[23:16]) >> 1
res[31:24] = (val1[31:24] + val2[31:24]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UHADD8.
ARM and Thumb instruction summary.
Syntax
unsigned int __uhasx(unsigned int val1, unsigned int val2)
Where:
val1
holds the first operand for the subtraction in the low halfword, and the first operand for the
addition in the high halfword
val2
holds the second operand for the subtraction in the high halfword, and the second operand for
the addition in the low halfword.
Return value
The __uhasx intrinsic returns:
• The halved subtraction of the high halfword in the second operand from the low halfword in the first
operand.
• The halved addition of the high halfword in the first operand and the low halfword in the second
operand.
Example
unsigned int exchange_add_subtract(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uhasx(val1,val2); /* res[15:0] = (val1[15:0] - val2[31:16]) >> 1
res[31:16] = (val1[31:16] + val2[15:0]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UHASX.
ARM and Thumb instruction summary.
Syntax
unsigned int __uhsax(unsigned int val1, unsigned int val2)
Where:
val1
holds the first operand for the addition in the low halfword, and the first operand for the
subtraction in the high halfword
val2
holds the second operand for the addition in the high halfword, and the second operand for the
subtraction in the low halfword.
Return value
The __uhsax intrinsic returns:
• The halved addition of the high halfword in the second operand and the low halfword in the first
operand, in the low halfword of the return value.
• The halved subtraction of the low halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
Example
unsigned int exchange_subtract_add(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uhsax(val1,val2); /* res[15:0] = (val1[15:0] + val2[31:16]) >> 1
res[31:16] = (val1[31:16] - val2[15:0]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UHSAX.
ARM and Thumb instruction summary.
Syntax
unsigned int __uhsub16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first two 16-bit operands
val2
holds the second two 16-bit operands.
Return value
The __uhsub16 intrinsic returns:
• The halved subtraction of the low halfword in the second operand from the low halfword in the first
operand, in the low halfword of the return value.
• The halved subtraction of the high halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
Example
unsigned int subtract_and_halve(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uhsub16(val1,val2); /* res[15:0] = (val1[15:0] + val2[15:0]) >> 1
res[31:16] = (val1[31:16] - val2[31:16]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UHSUB16.
ARM and Thumb instruction summary.
Syntax
unsigned int __uhsub8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit operands
val2
holds the second four 8-bit operands.
Return value
The __uhsub8 intrinsic returns:
• The halved subtraction of the first byte in the second operand from the first byte in the first operand,
in the first byte of the return value.
• The halved subtraction of the second byte in the second operand from the second byte in the first
operand, in the second byte of the return value.
• The halved subtraction of the third byte in the second operand from the third byte in the first operand,
in the third byte of the return value.
• The halved subtraction of the fourth byte in the second operand from the fourth byte in the first
operand, in the fourth byte of the return value.
Example
unsigned int subtract_and_halve(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uhsub8(val1,val2); /* res[7:0] = (val1[7:0] - val2[7:0]) >> 1
res[15:8] = (val1[15:8] - val2[15:8]) >> 1
res[23:16] = (val1[23:16] - val2[23:16]) >> 1
res[31:24] = (val1[31:24] - val2[31:24]) >> 1
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UHSUB8.
ARM and Thumb instruction summary.
Syntax
unsigned int __uqadd16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first two halfword summands
val2
holds the second two halfword summands.
Return value
The __uqadd16 intrinsic returns:
• The addition of the low halfword in the first operand and the low halfword in the second operand.
• The addition of the high halfword in the first operand and the high halfword in the second operand, in
the high halfword of the return value.
The results are saturated to the 16-bit unsigned integer range 0 ≤ x ≤ 216 - 1.
Example
unsigned int add_halfwords(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uqadd16(val1,val2); /* res[15:0] = val1[15:0] + val2[15:0]
res[31:16] = val1[31:16] + val2[31:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UQADD16.
ARM and Thumb instruction summary.
Syntax
unsigned int __uqadd8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit summands
val2
holds the second four 8-bit summands.
Return value
The __uqadd8 intrinsic returns:
• The addition of the first bytes in each operand, in the first byte of the return value.
• The addition of the second bytes in each operand, in the second byte of the return value.
• The addition of the third bytes in each operand, in the third byte of the return value.
• The addition of the fourth bytes in each operand, in the fourth byte of the return value.
The results are saturated to the 8-bit unsigned integer range 0 ≤ x ≤ 28 - 1.
Example
unsigned int add_bytes(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uqadd8(val1,val2); /* res[7:0] = val1[7:0] + val2[7:0]
res[15:8] = val1[15:8] + val2[15:8]
res[23:16] = val1[23:16] + val2[23:16]
res[31:24] = val1[31:24] + val2[31:24]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UQADD8.
ARM and Thumb instruction summary.
Syntax
unsigned int __uqasx(unsigned int val1, unsigned int val2)
Where:
val1
holds the first two halfword operands
val2
holds the second two halfword operands.
Return value
The __uqasx intrinsic returns:
• The subtraction of the high halfword in the second operand from the low halfword in the first
operand, in the low halfword of the return value.
• The subtraction of the low halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
The results are saturated to the 16-bit unsigned integer range 0 ≤ x ≤ 216 - 1.
Example
unsigned int exchange_add_subtract(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uqasx(val1,val2); /* res[15:0] = val1[15:0] - val2[31:16]
res[31:16] = val1[31:16] + val2[15:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UQASX.
ARM and Thumb instruction summary.
Syntax
unsigned int __uqsax(unsigned int val1, unsigned int val2)
Where:
val1
holds the first 16-bit operand for the addition in the low halfword, and the first 16-bit operand
for the subtraction in the high halfword
val2
holds the second 16-bit halfword for the addition in the high halfword, and the second 16-bit
halfword for the subtraction in the low halfword.
Return value
The __uqsax intrinsic returns:
• The addition of the low halfword in the first operand and the high halfword in the second operand, in
the low halfword of the return value.
• The subtraction of the low halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
The results are saturated to the 16-bit unsigned integer range 0 ≤ x ≤ 216 - 1.
Example
unsigned int exchange_subtract_add(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uqsax(val1,val2); /* res[15:0] = val1[15:0] + val2[31:16]
res[31:16] = val1[31:16] - val2[15:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UQSAX.
ARM and Thumb instruction summary.
Syntax
unsigned int __uqsub16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first halfword operands for each subtraction
val2
holds the second halfword operands for each subtraction.
Return value
The __uqsub16 intrinsic returns:
• The subtraction of the low halfword in the second operand from the low halfword in the first operand,
in the low halfword of the return value.
• The subtraction of the high halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
The results are saturated to the 16-bit unsigned integer range 0 ≤ x ≤ 216 - 1.
Example
unsigned int subtract_halfwords(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uqsub16(val1,val2); /* res[15:0] = val1[15:0] - val2[15:0]
res[31:16] = val1[31:16] - val2[31:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UQSUB16.
ARM and Thumb instruction summary.
Syntax
unsigned int __uqsub8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit operands
val2
holds the second four 8-bit operands.
Return value
The __uqsub8 intrinsic returns:
• The subtraction of the first byte in the second operand from the first byte in the first operand, in the
first byte of the return value.
• The subtraction of the second byte in the second operand from the second byte in the first operand, in
the second byte of the return value.
• The subtraction of the third byte in the second operand from the third byte in the first operand, in the
third byte of the return value.
• The subtraction of the fourth byte in the second operand from the fourth byte in the first operand, in
the fourth byte of the return value.
The results are saturated to the 8-bit unsigned integer range 0 ≤ x ≤ 28 - 1.
Example
unsigned int subtract_bytes(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uqsub8(val1,val2); /* res[7:0] = val1[7:0] - val2[7:0]
res[15:8] = val1[15:8] - val2[15:8]
res[23:16] = val1[23:16] - val2[23:16]
res[31:24] = val1[31:24] - val2[31:24]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UQSUB8.
ARM and Thumb instruction summary.
Syntax
unsigned int __usad8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit operands for the subtractions
val2
holds the second four 8-bit operands for the subtractions.
Return value
The __usad8 intrinsic returns the sum of the absolute differences of:
• The subtraction of the first byte in the second operand from the first byte in the first operand.
• The subtraction of the second byte in the second operand from the second byte in the first operand.
• The subtraction of the third byte in the second operand from the third byte in the first operand.
• The subtraction of the fourth byte in the second operand from the fourth byte in the first operand.
The sum is returned as a single unsigned integer.
Example
unsigned int subtract_add_abs(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __usad8(val1,val2); /* absdiff1 = val1[7:0] - val2[7:0]
absdiff2 = val1[15:8] - val2[15:8]
absdiff3 = val1[23:16] - val2[23:16]
absdiff4 = val1[31:24] - val2[31:24]
res[31:0] = absdiff1 + absdiff2 + absdiff3
+ absdiff4
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
USAD8.
ARM and Thumb instruction summary.
Syntax
unsigned int __usada8(unsigned int val1, unsigned int val2, unsigned int val3)
Where:
val1
holds the first four 8-bit operands for the subtractions
val2
holds the second four 8-bit operands for the subtractions
val3
holds the accumulation value.
Return value
The __usada8 intrinsic returns the sum of the absolute differences of the following bytes, added to the
accumulation value:
• The subtraction of the first byte in the second operand from the first byte in the first operand.
• The subtraction of the second byte in the second operand from the second byte in the first operand.
• The subtraction of the third byte in the second operand from the third byte in the first operand.
• The subtraction of the fourth byte in the second operand from the fourth byte in the first operand.
Example
unsigned int subtract_add_diff_accumulate(unsigned int val1, unsigned int val2, unsigned int
val3)
{
unsigned int res;
res = __usada8(val1,val2,val3); /* absdiff1 = val1[7:0] - val2[7:0]
absdiff2 = val1[15:8] - val2[15:8]
absdiff3 = val1[23:16] - val2[23:16]
absdiff4 = val1[31:24] - val2[31:24]
sum = absdiff1 + absdiff2 + absdiff3
+ absdiff4
res[31:0] = sum[31:0] + val3[31:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
USADA8.
ARM and Thumb instruction summary.
Syntax
unsigned int __usat16(unsigned int val1, /* constant */ unsigned int val2)
Where:
val1
holds the two 16-bit values that are to be saturated
val2
specifies the bit position for saturation, and must be an integral constant expression.
Return value
The __usat16 intrinsic returns the saturation of the two signed 16-bit values, as non-negative values.
Example
unsigned int saturate_halfwords(unsigned int val1)
{
unsigned int res;
#define VAL2 12
res = __usat16(val1,VAL2); /* Saturate halfwords in val1 to the unsigned
range specified by the bit position in VAL2
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
USAT16.
ARM and Thumb instruction summary.
Syntax
unsigned int __usax(unsigned int val1, unsigned int val2)
Where:
val1
holds the first operand for the addition in the low halfword, and the first operand for the
subtraction in the high halfword
val2
holds the second operand for the addition in the high halfword, and the second operand for the
subtraction in the low halfword.
Return value
The __usax intrinsic returns:
• The addition of the low halfword in the first operand and the high halfword in the second operand, in
the low halfword of the return value.
• The subtraction of the low halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[15:0] ≥ 0x10000 then APSR.GE[1:0] = 11 else 00.
• If res[31:16] ≥ 0 then APSR.GE[3:2] = 11 else 00.
Example
unsigned int exchange_subtract_add(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __usax(val1,val2); /* res[15:0] = val1[15:0] + val2[31:16]
res[31:16] = val1[31:16] - val2[15:0]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
USAX.
ARM and Thumb instruction summary.
Syntax
unsigned int __usub16(unsigned int val1, unsigned int val2)
Where:
val1
holds the first two halfword operands
val2
holds the second two halfword operands.
Return value
The __usub16 intrinsic returns:
• The subtraction of the low halfword in the second operand from the low halfword in the first operand,
in the low halfword of the return value.
• The subtraction of the high halfword in the second operand from the high halfword in the first
operand, in the high halfword of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[15:0] ≥ 0 then APSR.GE[1:0] = 11 else 00.
• If res[31:16] ≥ 0 then APSR.GE[3:2] = 11 else 00.
Example
unsigned int subtract_halfwords(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __usub16(val1,val2); /* res[15:0] = val1[15:0] - val2[15:0]
res[31:16] = val1[31:16] - val2[31:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
USUB16.
ARM and Thumb instruction summary.
Syntax
unsigned int __usub8(unsigned int val1, unsigned int val2)
Where:
val1
holds the first four 8-bit operands
val2
holds the second four 8-bit operands.
Return value
The __usub8 intrinsic returns:
• The subtraction of the first byte in the second operand from the first byte in the first operand, in the
first byte of the return value.
• The subtraction of the second byte in the second operand from the second byte in the first operand, in
the second byte of the return value.
• The subtraction of the third byte in the second operand from the third byte in the first operand, in the
third byte of the return value.
• The subtraction of the fourth byte in the second operand from the fourth byte in the first operand, in
the fourth byte of the return value.
Each bit in APSR.GE is set or cleared for each byte in the return value, depending on the results of the
operation. If res is the return value, then:
• If res[7:0] ≥ 0 then APSR.GE[0] = 1 else 0.
• If res[15:8] ≥ 0 then APSR.GE[1] = 1 else 0.
• If res[23:16] ≥ 0 then APSR.GE[2] = 1 else 0.
• If res[31:24] ≥ 0 then APSR.GE[3] = 1 else 0.
Example
unsigned int subtract(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __usub8(val1,val2); /* res[7:0] = val1[7:0] - val2[7:0]
res[15:8] = val1[15:8] - val2[15:8]
res[23:16] = val1[23:16] - val2[23:16]
res[31:24] = val1[31:24] - val2[31:24]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
USUB8.
ARM and Thumb instruction summary.
Syntax
unsigned int __uxtab16(unsigned int val1, unsigned int val2)
Where val2[7:0] and val2[23:16] hold the two 8-bit values to be zero-extended.
Return value
The __uxtab16 intrinsic returns the 8-bit values in val2, zero-extended to 16-bit values and added to
val1.
Example
unsigned int extend_add(unsigned int val1, unsigned int val2)
{
unsigned int res;
res = __uxtab16(val1,val2); /* res[15:0] = ZeroExt(val2[7:0] to 16 bits)
+ val1[15:0]
res[31:16] = ZeroExt(val2[31:16] to 16 bits)
+ val1[31:16]
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UXTAB16.
ARM and Thumb instruction summary.
Syntax
unsigned int __uxtb16(unsigned int val)
Where val[7:0] and val[23:16] hold the two 8-bit values to be zero-extended.
Return value
The __uxtb16 intrinsic returns the 8-bit values zero-extended to 16-bit values.
Example
unsigned int zero_extend(unsigned int val)
{
unsigned int res;
res = __uxtb16(val1,val2); /* res[15:0] = ZeroExtended(val[7:0])
res[31:16] = ZeroExtended(val[23:16])
*/
return res;
}
Related references
10.153 ARMv6 SIMD intrinsics on page 10-767.
Related information
UXTB16.
ARM and Thumb instruction summary.
Note
In general, you can use a via file to specify any command-line option to a tool, including --via. This
means that you can call multiple nested via files from within a via file.
Related references
13.2 Via file syntax rules on page 13-886.
8.195 --via=filename on page 8-537.
A comment ends at the end of a line, or at the end of the file. There are no multi-line comments, and
there are no part-line comments.
• Lines that include the preprocessor option -Dsymbol="value" must be delimited with a single quote,
either as '-Dsymbol="value"' or as -Dsymbol='"value"'. For example:
-c -DFOO_VALUE='"FOO_VALUE"'
Related concepts
13.1 Overview of via files on page 13-885.
Related references
8.195 --via=filename on page 8-537.
Describes ARM compiler support for GNU extensions to the C and C++ languages.
It contains the following sections:
• 14.1 Supported GNU extensions on page 14-888.
10.4 __alignof__ on page 10-603 GCC-Specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
Aggregate initializer elements for automatic variables Standard C99, C99, C++, GNU C90, GNU C99, GNU C++.
Standard C++.
Assembler labels - C90, C99, C++, GNU C90, GNU C99, GNU
C++.
Character escape sequence GCC-specific. GNU C90, GNU C99, GNU C++.
Compound literals Standard C99. C99, GNU C90, GNU C99, GNU C++.
Conditional statements with omitted operands GCC-specific. GNU C90, GNU C99, GNU C++.
Designated initializers Standard C99. C99, GNU C90, GNU C99, GNU C++.
Dollar signs in identifiers GCC-specific. GNU C90, GNU C99, GNU C++.
Extended lvalues g Standard C++. C++, GNU C90, GNU C99, GNU C++.
10.30 Function attributes on page 10-633 - C90, C99, C++, GNU C90, GNU C99, GNU
C++.
Inline functions Standard C99, C99, C++, GNU C90, GNU C99, GNU C++.
Standard C++.
Pointer arithmetic on void pointers and function pointers GCC-specific. GNU C90, GNU C99.
Unnamed embedded structures or unions GCC-specific. GNU C90, GNU C99, GNU C++.
10.31 __attribute__((alias)) function attribute on page 10-635 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.59 __attribute__((aligned)) type attribute on page 10-664 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.65 __attribute__((aligned)) variable attribute on page 10-670 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.32 __attribute__((always_inline)) function attribute GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
on page 10-637 C++.
f Only basic syntax is supported. That is, asm("assembly code"). GNU extended syntax is not supported.
g Only accepted for certain values of --gnu_version.
10.33 __attribute__((const)) function attribute on page 10-638 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.34 __attribute__((constructor[(priority)])) function attribute GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
on page 10-639 C++.
10.66 __attribute__((deprecated)) variable attribute on page 10-671 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.36 __attribute__((destructor[(priority)])) function attribute GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
on page 10-641 C++.
10.37 __attribute__((format)) function attribute on page 10-642 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.38 __attribute__((format_arg(string-index))) function attribute GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
on page 10-643 C++.
10.39 __attribute__((malloc)) function attribute on page 10-644 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.40 __attribute__((noinline)) function attribute on page 10-645 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.41 __attribute__((no_instrument_function)) function attribute GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
on page 10-646 C++.
10.43 __attribute__((nonnull)) function attribute on page 10-648 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.44 __attribute__((noreturn)) function attribute on page 10-649 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.46 __attribute__((nothrow)) function attribute on page 10-651 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.60 __attribute__((packed)) type attribute on page 10-665 GCC-specific. GNU C90, GNU C99, GNU C++.
10.68 __attribute__((packed)) variable attribute on page 10-673 GCC-specific. C90, C99, GNU C90, GNU C99, GNU C++.
10.48 __attribute__((pure)) function attribute on page 10-653 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.69 __attribute__((section("name"))) variable attribute GCC-specific. C99, GNU C90, GNU C99, GNU C++.
on page 10-674
10.50 __attribute__((sentinel)) function attribute on page 10-655 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.70 __attribute__((unused)) variable attribute on page 10-675 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.71 __attribute__((used)) variable attribute on page 10-676 GCC-specific. C90, C99, GNU C90, GNU C99.
10.72 __attribute__((visibility("visibility_type"))) variable attribute GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
on page 10-677 C++.
10.54 __attribute__((warn_unused_result)) on page 10-659 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.55 __attribute__((weak)) function attribute on page 10-660 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.73 __attribute__((weak)) variable attribute on page 10-678 GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
10.56 __attribute__((weakref("target"))) function attribute GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
on page 10-661 C++.
10.74 __attribute__((weakref("target"))) variable attribute GCC-specific. C90, C99, C++, GNU C90, GNU C99, GNU
on page 10-679 C++.
Variadic macros Standard C99. C90, C99, C++, GNU C90, GNU C99, GNU
C++.
Related references
8.93 --gnu on page 8-424.
Related information
Which GNU language extensions are supported by the ARM Compiler?.
Note
The support for the wctype.h and wchar.h headers excludes wide file operations.
Related references
15.2 Translation on page 15-893.
15.3 Environment on page 15-894.
15.4 Identifiers on page 15-896.
15.5 Characters on page 15-897.
15.6 Integers on page 15-899.
15.7 Floating-point on page 15-900.
15.8 Arrays and pointers on page 15-901.
15.9 Registers on page 15-902.
15.10 Structures, unions, enumerations, and bitfields on page 15-903.
15.11 Qualifiers on page 15-907.
15.12 Expression evaluation on page 15-908.
15.13 Preprocessing directives on page 15-909.
15.14 Library functions on page 15-910.
15.2 Translation
Describes implementation-defined aspects of the ARM C compiler and C library relating to translation,
as required by the ISO C standard.
Diagnostic messages produced by the compiler are of the form:
source-file, line-number: severity: error-code: explanation
Related references
Chapter 6 Compiler Diagnostic Messages on page 6-253.
15.3 Environment
Describes implementation-defined aspects of the ARM C compiler and C library relating to environment,
as required by the ISO C standard requires.
The mapping of a command line from the ARM architecture-based environment into arguments to
main() is implementation-specific. The generic ARM C library supports the following:
main()
The arguments given to main() are the words of the command line not including input/output
redirections, delimited by whitespace, except where the whitespace is contained in double quotes.
Note
• A whitespace character is any character where the result of isspace() is true.
• A double quote or backslash character \ inside double quotes must be preceded by a backslash
character.
• An input/output redirection is not recognized inside double quotes.
Interactive device
In a nonhosted implementation of the ARM C library, the term interactive device might be meaningless.
The generic ARM C library supports a pair of devices, both called :tt, intended to handle keyboard
input and VDU screen output. In the generic implementation:
• stdin, stdout, and stderr connect to :tt by default, but this does not affect how they are buffered.
• If stdin, stdout, and stderr are not redirected, they are line buffered.
• If stdin, stdout, and stderr are redirected, stdin and stdout are line buffered, and stderr is not
line buffered.
• If stderr and stdout are redirected to the same file, neither are line buffered.
2>&1
Writes stderr to the same place as stdout.
>& file
Writes both stdout and stderr to filename.
>> filename
Appends stdout to filename.
>>& filename
Appends both stdout and stderr to filename.
To redirect stdin, stdout, and stderr on the target, you must define:
#pragma import(_main_redirection)
Related references
10.88 #pragma import symbol_name on page 10-694.
15.4 Identifiers
Describes implementation-defined aspects of the ARM C compiler and C library relating to identifiers,
as required by the ISO C standard.
The following point applies to the identifiers expected by the compiler:
• Uppercase and lowercase characters are distinct in all internal and external identifiers. An identifier
can also contain a dollar ($) character unless the --strict compiler option is specified. To permit
dollar signs in identifiers with the --strict option, also use the --dollar command-line option.
15.5 Characters
Describes implementation-defined aspects of the ARM C compiler and C library relating to characters, as
required by the ISO C standard.
The following points apply to the character sets expected by the compiler:
• Calling setlocale(LC_CTYPE, "ISO8859-1") makes the isupper() and islower() functions
behave as expected over the full 8-bit Latin-1 alphabet, rather than over the 7-bit ASCII subset. The
locale must be selected at link time.
• Source files are compiled according to the currently selected locale. You might have to change the
locale using the --locale command-line option if the source file contains non-ASCII characters. If
you do not specify --locale, the system locale is used.
• The compiler supports multibyte character sets, such as Unicode. You can control this support using
the --[no_]multibyte_chars options.
• If the source file encoding is UTF-8 or UTF-16, and the file starts with a byte order mark then the
compiler ignores the --[no_]multibyte_chars and --locale options and interprets the file as
UTF-8 or UTF-16.
• Other properties of the source character set are host-specific.
The properties of the execution character set are target-specific. The ARM C and C++ libraries support
the ISO 8859-1 (Latin-1 Alphabet) character set with the following consequences:
• The execution character set is identical to the source character set.
• There are eight bits in a character in the execution character set.
• There are four characters (bytes) in an int. If the memory system is:
Little-endian
The bytes are ordered from least significant at the lowest address to most significant at the
highest address.
Big-endian
The bytes are ordered from least significant at the highest address to most significant at the
lowest address.
• In C all character constants have type int. In C++ a character constant containing one character has
the type char and a character constant containing more than one character has the type int. Up to
four characters of the constant are represented in the integer value. The last character in the constant
occupies the lowest-order byte of the integer value. Up to three preceding characters are placed at
higher-order bytes. Unused bytes are filled with the NUL (\0) character.
• All integer character constants that contain a single character, or character escape sequence, are
represented in both the source and execution character sets.The following table lists the supported
character escape codes.
\a 7 Attention (bell)
\b 8 Backspace
\t 9 Horizontal tab
\v 11 Vertical tab
\f 12 Form feed
\r 13 Carriage return
Note
Care must be taken when mixing translation units that have been compiled with and without the
--signed_chars and --unsigned_chars options, and that share interfaces or data structures.
The ARM ABI defines char as an unsigned byte, and this is the interpretation used by the C++
libraries supplied with the ARM compilation tools.
• Converting multibyte characters into the corresponding wide characters for a wide character constant
does not use a locale. This is not relevant to the generic implementation.
15.6 Integers
Describes implementation-defined aspects of the ARM C compiler and C library relating to integers, as
required by the ISO C standard.
Integers are represented in two's complement form. The low word of a long long is at the low address
in little-endian mode, and at the high address in big-endian mode.
15.7 Floating-point
Describes implementation-defined aspects of the ARM C compiler and C library relating to floating-
point operations, as required by the ISO C standard.
Floating-point quantities are stored in IEEE format:
• float values are represented by IEEE single-precision values
• double and long double values are represented by IEEE double-precision values.
For double and long double quantities the word containing the sign, the exponent, and the most
significant part of the mantissa is stored with the lower machine address in big-endian mode and at the
higher address in little-endian mode.
15.9 Registers
Describes implementation-defined aspects of the ARM C compiler and C library relating to registers, as
required by the ISO C standard.
Using the ARM compiler, you can declare any number of local objects to have the storage class
register.
Unions
When a member of a union is accessed using a member of a different type, the resulting value can be
predicted from the representation of the original type. No error is given.
Enumerations
An object of type enum is implemented in the smallest integral type that contains the range of the enum.
In C mode, and in C++ mode without --enum_is_int, if an enum contains only positive enumerator
values, the storage type of the enum is the first unsigned type from the following list, according to the
range of the enumerators in the enum. In other modes, and in cases where an enum contains any negative
enumerator values, the storage type of the enum is the first of the following, according to the range of the
enumerators in the enum:
• unsigned char if not using --enum_is_int
• signed char if not using --enum_is_int
• unsigned short if not using --enum_is_int
• signed short if not using --enum_is_int
• signed int
• unsigned int except C with --strict
• signed long long except C with --strict
• unsigned long long except C with --strict.
Note
• In RVCT 4.0, the storage type of the enum being the first unsigned type from the list was only
applicable in GNU (--gnu) mode.
• In ARM Compiler 4.1 and later, the storage type of the enum being the first unsigned type from the
list applies irrespective of mode.
Implementing enum in this way can reduce data size. The command-line option --enum_is_int forces
the underlying type of enum to at least as wide as int.
See the description of C language mappings in the Procedure Call Standard for the ARM® Architecture
specification for more information.
Note
Care must be taken when mixing translation units that have been compiled with and without the
--enum_is_int option, and that share interfaces or data structures.
In strict C, enumerator values must be representable as ints. That is, they must be in the range
-2147483648 to +2147483647, inclusive. A warning is issued for out-of-range enumerator values:
#66: enumeration value is out of "int" range
Such values are treated the same way as in C++, that is, they are treated as unsigned int, long long, or
unsigned long long.
To ensure that out-of-range Warnings are reported, use the following command to change them into
Errors:
armcc --diag_error=66 ...
0 1 2 3
c padding
4 5 7 8
x
9 10 11 12
s padding
However, if you are compiling C, or compiling C++ with the --cpp and--c90 options, an error is
generated.
Bitfields
In nonpacked structures, ARM Compiler allocates bitfields in containers. A container is a correctly
aligned object of a declared type.
Bitfields are allocated so that the first field specified occupies the lowest-addressed bits of the word,
depending on configuration:
Little-endian
Lowest addressed means least significant.
Big-endian
Lowest addressed means most significant.
A bitfield container can be any of the integral types.
Note
In strict 1990 ISO Standard C, the only types permitted for a bit field are int, signed int, and
unsigned int. For non-int bitfields, the compiler displays an error.
A plain bitfield, declared without either signed or unsigned qualifiers, is treated as unsigned. For
example, int x:10 allocates an unsigned integer of 10 bits.
A bitfield is allocated to the first container of the correct type that has a sufficient number of unallocated
bits, for example:
struct X
{
int x:10;
int y:20;
};
The first declaration creates an integer container and allocates 10 bits to x. At the second declaration, the
compiler finds the existing integer container with a sufficient number of unallocated bits, and allocates y
in the same container as x.
A bitfield is wholly contained within its container. A bitfield that does not fit in a container is placed in
the next container of the same type. For example, the declaration of z overflows the container if an
additional bitfield is declared for the structure:
struct X
{
int x:10;
int y:20;
int z:5;
};
The compiler pads the remaining two bits for the first container and assigns a new integer container for z.
Bitfield containers can overlap each other, for example:
struct X
{
int x:10;
char y:2;
};
The first declaration creates an integer container and allocates 10 bits to x. These 10 bits occupy the first
byte and two bits of the second byte of the integer container. At the second declaration, the compiler
checks for a container of type char. There is no suitable container, so the compiler allocates a new
correctly aligned char container.
Because the natural alignment of char is 1, the compiler searches for the first byte that contains a
sufficient number of unallocated bits to completely contain the bitfield. In the example structure, the
second byte of the int container has two bits allocated to x, and six bits unallocated. The compiler
allocates a char container starting at the second byte of the previous int container, skips the first two
bits that are allocated to x, and allocates two bits to y.
If y is declared char y:8, the compiler pads the second byte and allocates a new char container to the
third byte, because the bitfield cannot overflow its container. The following figure shows the bitfield
allocation for the following example structure:
struct X
{
int x:10;
char y:8;
};
Bit number
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 1 1 10 9 8 7 6 5 4 3 2 1 0
unallocated y padding x
Note
The same basic rules apply to bitfield declarations with different container types. For example, adding an
int bitfield to the example structure gives:
struct X
{
int x:10;
char y:8;
int z:5;
}
The compiler allocates an int container starting at the same location as the int x:10 container and
allocates a byte-aligned char and 5-bit bitfield, as follows:
Bit number
31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 1 1 10 9 8 7 6 5 4 3 2 1 0
free z y padding x
15.11 Qualifiers
Describes implementation-defined aspects of the ARM C compiler and C library relating to qualifiers, as
required by the ISO C standard.
An object that has a volatile-qualified type is accessed as a word, halfword, or byte as determined by its
size and alignment. For volatile objects larger than a word, the order of accesses to the parts of the object
is undefined. Updates to volatile bitfields generally require a read-modify-write. Accesses to aligned
word, halfword and byte types are atomic. Other volatile accesses are not necessarily atomic.
Otherwise, reads and writes to volatile qualified objects occur as directly implied by the source code, in
the order implied by the source code.
Between sequence points, the compiler can evaluate expressions in any order, regardless of parentheses.
Therefore, side effects of expressions between sequence points can occur in any order.
The compiler can evaluate function arguments in any order.
Any aspect of evaluation order not prescribed by the relevant standard can be varied by:
• The optimization level you are compiling at.
• The release of the compiler you are using.
Quoted names for includable source files are supported. The compiler accepts host filenames or UNIX
filenames. For UNIX filenames on non-UNIX hosts, the compiler tries to translate the filename to a local
equivalent.
The following C99 pragmas are recognized by the compiler, but ignored:
STDC CX_LIMITED_RANGE
See ISO/IEC 9899:1999/Cor 2:2004, Section 7.3.4.
STDC FENV_ACCESS
See ISO/IEC 9899:1999/Cor 2:2004, Section 7.6.1.
STDC FP_CONTRACT
See ISO/IEC 9899:1999/Cor 2:2004, Section 7.12.2.
Related references
1.2 Source language modes of the compiler on page 1-31.
Note
The behavior of the assert macro depends on the conditions in operation at the most recent
occurrence of #include <assert.h>.
For implementation details of mathematical functions, macros, locale, signals, and input/output see ARM
C and C++ Libraries and Floating-Point Support User Guide.
Related information
The ARM C and C++ Libraries.
Lists the C++ language features defined in the ISO/IEC standard for C++, and states whether or not
ARM C++ supports that language feature.
The ARM compiler supports the majority of the language features described in the standard.
Note
This documentation does not duplicate information that is part of the standard C implementation
Note
When compiling C++ in ISO C mode, the ARM compiler is identical to the ARM C compiler. Where
there is an implementation feature specific to either C or C++, this is noted in the text.
Note
This topic is related to Section 4.7 Integral conversions, in the ISO/IEC standard.
Exceptions 15 Yes.
Libraries 17 to 27 See ARM C and C++ Libraries and Floating-Point Support User Guide.
Related references
11.13 C++11 supported features on page 11-814.
Describes the implementation limits when using the ARM compiler to compile C and C++.
It contains the following sections:
• 17.1 C++ ISO/IEC standard limits on page 17-918.
• 17.2 Limits for integral numbers on page 17-920.
• 17.3 Limits for floating-point numbers on page 17-921.
Nesting levels of compound statements, iteration control structures, and selection control structures. 256 memory
Pointer, array, and function declarators (in any combination) modifying an arithmetic, structure, 256 memory
union, or incomplete type in a declaration.
Characters in a character string literal or wide string literal after concatenation. 65 536 memory
Size of a C or C++ object (including arrays). 262 144 4 294 967 296
Case labels for a switch statement, excluding those for any nested switch statements. 16 384 memory
Levels of nested class, structure, or union definitions in a single struct declaration-list. 256 memory
LDBL_MIN Minimum normalized positive floating-point number value of long double. 2.22507385850720138e–308
LDBL_MAX_EXP Maximum value of base 2 exponent for type long double. 1 024
LDBL_MIN_EXP Minimum value of base 2 exponent for type long double. –1 021
LDBL_MAX_10_EXP Maximum value of base 10 exponent for type long double. 308
LDBL_MIN_10_EXP Minimum value of base 10 exponent for type long double. –307
The following table describes other characteristics of floating-point numbers. These constants are also
defined in the float.h include file.
FLT_EPSILON Smallest positive value of x that 1.0 + x != 1.0 for type float. 1.19209290e–7F
DBL_EPSILON Smallest positive value of x that 1.0 + x != 1.0 for type double. 2.2204460492503131e–16
LDBL_EPSILON Smallest positive value of x that 1.0 + x != 1.0 for type long double. 2.2204460492503131e–16L
Note
• When a floating-point number is converted to a shorter floating-point number, it is rounded to the
nearest representable number.
• Floating-point arithmetic conforms to IEEE 754.
Describes NEON intrinsics support in this release of the ARM compilation tools.
It contains the following sections:
• 18.1 Introduction to NEON intrinsics on page 18-925.
• 18.2 Vector data types on page 18-926.
• 18.3 NEON intrinsics on page 18-927.
• 18.4 NEON intrinsics for addition on page 18-929.
• 18.5 NEON intrinsics for multiplication on page 18-931.
• 18.6 NEON intrinsics for subtraction on page 18-933.
• 18.7 NEON intrinsics for comparison on page 18-935.
• 18.8 NEON intrinsics for absolute difference on page 18-937.
• 18.9 NEON intrinsics for maximum and minimum on page 18-938.
• 18.10 NEON intrinsics for pairwise addition on page 18-939.
• 18.11 NEON intrinsics for folding maximum on page 18-940.
• 18.12 NEON intrinsics for folding minimum on page 18-941.
• 18.13 NEON intrinsics for reciprocal and sqrt on page 18-942.
• 18.14 NEON intrinsics for shifts by signed variable on page 18-943.
• 18.15 NEON intrinsics for shifts by a constant on page 18-945.
• 18.16 NEON intrinsics for shifts with insert on page 18-949.
• 18.17 NEON intrinsics for loading a single vector or lane on page 18-951.
• 18.18 NEON intrinsics for storing a single vector or lane on page 18-953.
• 18.19 NEON intrinsics for loading an N-element structure on page 18-955.
• 18.20 NEON intrinsics for extracting lanes from a vector into a register on page 18-964.
• 18.21 NEON intrinsics for loading a single lane of a vector from a literal on page 18-965.
• 18.22 NEON intrinsics for initializing a vector from a literal bit pattern on page 18-966.
• 18.23 NEON intrinsics for setting all lanes to the same value on page 18-967.
For example, int16x4_t is a vector containing four lanes each containing a signed 16-bit integer.
The following table lists the vector data types.
int8x8_t int8x16_t
int16x4_t int16x8_t
int32x2_t int32x4_t
int64x1_t int64x2_t
uint8x8_t uint8x16_t
uint16x4_t uint16x8_t
uint32x2_t uint32x4_t
uint64x1_t uint64x2_t
float16x4_t float16x8_t
float32x2_t float32x4_t
poly8x8_t poly8x16_t
poly16x4_t poly16x8_t
These types are treated as ordinary C structures containing a single element named val.
An example structure definition is:
struct int16x4x2_t
{
int16x4_t val[2];
};
There are array types defined for array lengths between 2 and 4, with any of the vector types listed in the
following table.
Note
The vector data types and arrays of the vector data types cannot be initialized by direct literal
assignment. You must initialize them using one of the load intrinsics.
The optional q flag specifies that the intrinsic operates on 128-bit vectors.
For example:
• vmul_s16, multiplies two vectors of signed 16-bit values.
Note
The NEON intrinsic function prototypes that use __fp16 are only available for targets that have the
NEON half-precision VFP extension. To enable use of __fp16, use the --fp16_format command-line
option.
Related references
8.86 --fp16_format=format on page 8-414.
18.4 NEON intrinsics for addition on page 18-929.
18.5 NEON intrinsics for multiplication on page 18-931.
18.6 NEON intrinsics for subtraction on page 18-933.
18.7 NEON intrinsics for comparison on page 18-935.
18.8 NEON intrinsics for absolute difference on page 18-937.
18.9 NEON intrinsics for maximum and minimum on page 18-938.
18.10 NEON intrinsics for pairwise addition on page 18-939.
18.11 NEON intrinsics for folding maximum on page 18-940.
18.12 NEON intrinsics for folding minimum on page 18-941.
18.13 NEON intrinsics for reciprocal and sqrt on page 18-942.
18.14 NEON intrinsics for shifts by signed variable on page 18-943.
Note
This topic describes the semantics of the intrinsics, rather than the semantics of the corresponding
instructions.
For example, Vr[i] := Va[i] + Vb[i] * Vc[i] describes the semantics of the vmla{q}_<type>
intrinsic, rather than the VMLA instruction.
The VMLA instruction uses three registers, multiplying the values in the 2 operand registers, adding the
value in the destination register, and placing the final result in the destination register. That is: Va[i] :=
Va[i] + Vb[i] * Vc[i].
However, the result vector Vr may not be the same entity as Va for the corresponding intrinsic. For
example:
int8x8_t f(int8x8_t a, int8x8_t b, int8x8_t c)
{
int8x8_t r = vmla_s8(a, b, c);
return vadd_s8(a, r);
}
Vector subtract
int8x8_t vsub_s8(int8x8_t a, int8x8_t b); // VSUB.I8 d0,d0,d0
int16x4_t vsub_s16(int16x4_t a, int16x4_t b); // VSUB.I16 d0,d0,d0
int32x2_t vsub_s32(int32x2_t a, int32x2_t b); // VSUB.I32 d0,d0,d0
int64x1_t vsub_s64(int64x1_t a, int64x1_t b); // VSUB.I64 d0,d0,d0
float32x2_t vsub_f32(float32x2_t a, float32x2_t b); // VSUB.F32 d0,d0,d0
uint8x8_t vsub_u8(uint8x8_t a, uint8x8_t b); // VSUB.I8 d0,d0,d0
uint16x4_t vsub_u16(uint16x4_t a, uint16x4_t b); // VSUB.I16 d0,d0,d0
uint32x2_t vsub_u32(uint32x2_t a, uint32x2_t b); // VSUB.I32 d0,d0,d0
uint64x1_t vsub_u64(uint64x1_t a, uint64x1_t b); // VSUB.I64 d0,d0,d0
int8x16_t vsubq_s8(int8x16_t a, int8x16_t b); // VSUB.I8 q0,q0,q0
int16x8_t vsubq_s16(int16x8_t a, int16x8_t b); // VSUB.I16 q0,q0,q0
int32x4_t vsubq_s32(int32x4_t a, int32x4_t b); // VSUB.I32 q0,q0,q0
int64x2_t vsubq_s64(int64x2_t a, int64x2_t b); // VSUB.I64 q0,q0,q0
float32x4_t vsubq_f32(float32x4_t a, float32x4_t b); // VSUB.F32 q0,q0,q0
uint8x16_t vsubq_u8(uint8x16_t a, uint8x16_t b); // VSUB.I8 q0,q0,q0
uint16x8_t vsubq_u16(uint16x8_t a, uint16x8_t b); // VSUB.I16 q0,q0,q0
uint32x4_t vsubq_u32(uint32x4_t a, uint32x4_t b); // VSUB.I32 q0,q0,q0
uint64x2_t vsubq_u64(uint64x2_t a, uint64x2_t b); // VSUB.I64 q0,q0,q0
Pairwise add
int8x8_t vpadd_s8(int8x8_t a, int8x8_t b); // VPADD.I8 d0,d0,d0
int16x4_t vpadd_s16(int16x4_t a, int16x4_t b); // VPADD.I16 d0,d0,d0
int32x2_t vpadd_s32(int32x2_t a, int32x2_t b); // VPADD.I32 d0,d0,d0
uint8x8_t vpadd_u8(uint8x8_t a, uint8x8_t b); // VPADD.I8 d0,d0,d0
uint16x4_t vpadd_u16(uint16x4_t a, uint16x4_t b); // VPADD.I16 d0,d0,d0
uint32x2_t vpadd_u32(uint32x2_t a, uint32x2_t b); // VPADD.I32 d0,d0,d0
float32x2_t vpadd_f32(float32x2_t a, float32x2_t b); // VPADD.F32 d0,d0,d0
Vector shift left: vshl{q}_<type>. Vr[i] := Va[i] << Vb[i] (negative values shift right)
int8x8_t vshl_s8(int8x8_t a, int8x8_t b); // VSHL.S8 d0,d0,d0
int16x4_t vshl_s16(int16x4_t a, int16x4_t b); // VSHL.S16 d0,d0,d0
int32x2_t vshl_s32(int32x2_t a, int32x2_t b); // VSHL.S32 d0,d0,d0
int64x1_t vshl_s64(int64x1_t a, int64x1_t b); // VSHL.S64 d0,d0,d0
uint8x8_t vshl_u8(uint8x8_t a, int8x8_t b); // VSHL.U8 d0,d0,d0
uint16x4_t vshl_u16(uint16x4_t a, int16x4_t b); // VSHL.U16 d0,d0,d0
uint32x2_t vshl_u32(uint32x2_t a, int32x2_t b); // VSHL.U32 d0,d0,d0
uint64x1_t vshl_u64(uint64x1_t a, int64x1_t b); // VSHL.U64 d0,d0,d0
int8x16_t vshlq_s8(int8x16_t a, int8x16_t b); // VSHL.S8 q0,q0,q0
int16x8_t vshlq_s16(int16x8_t a, int16x8_t b); // VSHL.S16 q0,q0,q0
int32x4_t vshlq_s32(int32x4_t a, int32x4_t b); // VSHL.S32 q0,q0,q0
int64x2_t vshlq_s64(int64x2_t a, int64x2_t b); // VSHL.S64 q0,q0,q0
uint8x16_t vshlq_u8(uint8x16_t a, int8x16_t b); // VSHL.U8 q0,q0,q0
uint16x8_t vshlq_u16(uint16x8_t a, int16x8_t b); // VSHL.U16 q0,q0,q0
uint32x4_t vshlq_u32(uint32x4_t a, int32x4_t b); // VSHL.U32 q0,q0,q0
uint64x2_t vshlq_u64(uint64x2_t a, int64x2_t b); // VSHL.U64 q0,q0,q0
// VSRA.U64 d0,d0,#64
int8x16_t vsraq_n_s8(int8x16_t a, int8x16_t b, __constrange(1,8) int c);
// VSRA.S8 q0,q0,#8
int16x8_t vsraq_n_s16(int16x8_t a, int16x8_t b, __constrange(1,16) int c);
// VSRA.S16 q0,q0,#16
int32x4_t vsraq_n_s32(int32x4_t a, int32x4_t b, __constrange(1,32) int c);
// VSRA.S32 q0,q0,#32
int64x2_t vsraq_n_s64(int64x2_t a, int64x2_t b, __constrange(1,64) int c);
// VSRA.S64 q0,q0,#64
uint8x16_t vsraq_n_u8(uint8x16_t a, uint8x16_t b, __constrange(1,8) int c);
// VSRA.U8 q0,q0,#8
uint16x8_t vsraq_n_u16(uint16x8_t a, uint16x8_t b, __constrange(1,16) int c);
// VSRA.U16 q0,q0,#16
uint32x4_t vsraq_n_u32(uint32x4_t a, uint32x4_t b,__constrange(1,32) int c);
// VSRA.U32 q0,q0,#32
uint64x2_t vsraq_n_u64(uint64x2_t a, uint64x2_t b, __constrange(1,64) int c);
// VSRA.U64 q0,q0,#64
// VSLI.16 q0,q0,#0
uint32x4_t vsliq_n_u32(uint32x4_t a, uint32x4_t b, __constrange(0,31) int c);
// VSLI.32 q0,q0,#0
uint64x2_t vsliq_n_u64(uint64x2_t a, uint64x2_t b, __constrange(0,63) int c);
// VSLI.64 q0,q0,#0
poly8x16_t vsliq_n_p8(poly8x16_t a, poly8x16_t b, __constrange(0,7) int c);
// VSLI.8 q0,q0,#0
poly16x8_t vsliq_n_p16(poly16x8_t a, poly16x8_t b, __constrange(0,15) int c);
// VSLI.16 q0,q0,#0
Load all lanes of N-element structure with same value from memory
uint8x8x2_t vld2_dup_u8(__transfersize(2) uint8_t const * ptr);
// VLD2.8 {d0[], d1[]}, [r0]
uint16x4x2_t vld2_dup_u16(__transfersize(2) uint16_t const * ptr);
// VLD2.16 {d0[], d1[]}, [r0]
uint32x2x2_t vld2_dup_u32(__transfersize(2) uint32_t const * ptr);
// VLD2.32 {d0[], d1[]}, [r0]
uint64x1x2_t vld2_dup_u64(__transfersize(2) uint64_t const * ptr);
// VLD1.64 {d0, d1}, [r0]
int8x8x2_t vld2_dup_s8(__transfersize(2) int8_t const * ptr);
// VLD2.8 {d0[], d1[]}, [r0]
int16x4x2_t vld2_dup_s16(__transfersize(2) int16_t const * ptr);
// VLD2.16 {d0[], d1[]}, [r0]
int32x2x2_t vld2_dup_s32(__transfersize(2) int32_t const * ptr);
// VLD2.32 {d0[], d1[]}, [r0]
int64x1x2_t vld2_dup_s64(__transfersize(2) int64_t const * ptr);
18.20 NEON intrinsics for extracting lanes from a vector into a register
These intrinsics extract a single lane (element) from a vector.
uint8_t vget_lane_u8(uint8x8_t vec, __constrange(0,7) int lane);
// VMOV.U8 r0, d0[0]
uint16_t vget_lane_u16(uint16x4_t vec, __constrange(0,3) int lane);
// VMOV.U16 r0, d0[0]
uint32_t vget_lane_u32(uint32x2_t vec, __constrange(0,1) int lane);
// VMOV.32 r0, d0[0]
int8_t vget_lane_s8(int8x8_t vec, __constrange(0,7) int lane);
// VMOV.S8 r0, d0[0]
int16_t vget_lane_s16(int16x4_t vec, __constrange(0,3) int lane);
// VMOV.S16 r0, d0[0]
int32_t vget_lane_s32(int32x2_t vec, __constrange(0,1) int lane);
// VMOV.32 r0, d0[0]
poly8_t vget_lane_p8(poly8x8_t vec, __constrange(0,7) int lane);
// VMOV.U8 r0, d0[0]
poly16_t vget_lane_p16(poly16x4_t vec, __constrange(0,3) int lane);
// VMOV.U16 r0, d0[0]
float32_t vget_lane_f32(float32x2_t vec, __constrange(0,1) int lane);
// VMOV.32 r0, d0[0]
uint8_t vgetq_lane_u8(uint8x16_t vec, __constrange(0,15) int lane);
// VMOV.U8 r0, d0[0]
uint16_t vgetq_lane_u16(uint16x8_t vec, __constrange(0,7) int lane);
// VMOV.U16 r0, d0[0]
uint32_t vgetq_lane_u32(uint32x4_t vec, __constrange(0,3) int lane);
// VMOV.32 r0, d0[0]
int8_t vgetq_lane_s8(int8x16_t vec, __constrange(0,15) int lane);
// VMOV.S8 r0, d0[0]
int16_t vgetq_lane_s16(int16x8_t vec, __constrange(0,7) int lane);
// VMOV.S16 r0, d0[0]
int32_t vgetq_lane_s32(int32x4_t vec, __constrange(0,3) int lane);
// VMOV.32 r0, d0[0]
poly8_t vgetq_lane_p8(poly8x16_t vec, __constrange(0,15) int lane);
// VMOV.U8 r0, d0[0]
poly16_t vgetq_lane_p16(poly16x8_t vec, __constrange(0,7) int lane);
// VMOV.U16 r0, d0[0]
float32_t vgetq_lane_f32(float32x4_t vec, __constrange(0,3) int lane);
// VMOV.32 r0, d0[0]
int64_t vget_lane_s64(int64x1_t vec, __constrange(0,0) int lane);
// VMOV r0,r0,d0
uint64_t vget_lane_u64(uint64x1_t vec, __constrange(0,0) int lane);
// VMOV r0,r0,d0
int64_t vgetq_lane_s64(int64x2_t vec, __constrange(0,1) int lane);
// VMOV r0,r0,d0
uint64_t vgetq_lane_u64(uint64x2_t vec, __constrange(0,1) int lane);
// VMOV r0,r0,d0
18.21 NEON intrinsics for loading a single lane of a vector from a literal
These intrinsics set a single lane (element) within a vector.
uint8x8_t vset_lane_u8(uint8_t value, uint8x8_t vec,
__constrange(0,7) int lane); // VMOV.8 d0[0],r0
18.22 NEON intrinsics for initializing a vector from a literal bit pattern
These intrinsics create a vector from a literal bit pattern.
int8x8_t vcreate_s8(uint64_t a); // VMOV d0,r0,r0
int16x4_t vcreate_s16(uint64_t a); // VMOV d0,r0,r0
int32x2_t vcreate_s32(uint64_t a); // VMOV d0,r0,r0
float16x4_t vcreate_f16(uint64_t a); // VMOV d0,r0,r0
float32x2_t vcreate_f32(uint64_t a); // VMOV d0,r0,r0
uint8x8_t vcreate_u8(uint64_t a); // VMOV d0,r0,r0
uint16x4_t vcreate_u16(uint64_t a); // VMOV d0,r0,r0
uint32x2_t vcreate_u32(uint64_t a); // VMOV d0,r0,r0
uint64x1_t vcreate_u64(uint64_t a); // VMOV d0,r0,r0
poly8x8_t vcreate_p8(uint64_t a); // VMOV d0,r0,r0
poly16x4_t vcreate_p16(uint64_t a); // VMOV d0,r0,r0
int64x1_t vcreate_s64(uint64_t a); // VMOV d0,r0,r0
18.23 NEON intrinsics for setting all lanes to the same value
These intrinsics set all lanes to the same value.
// VDUP.16 q0,d0[0]
int32x4_t vdupq_lane_s32(int32x2_t vec, __constrange(0,1) int lane);
// VDUP.32 q0,d0[0]
poly8x16_t vdupq_lane_p8(poly8x8_t vec, __constrange(0,7) int lane);
// VDUP.8 q0,d0[0]
poly16x8_t vdupq_lane_p16(poly16x4_t vec, __constrange(0,3) int lane);
// VDUP.16 q0,d0[0]
float32x4_t vdupq_lane_f32(float32x2_t vec, __constrange(0,1) int lane);
// VDUP.32 q0,d0[0]
int64x1_t vdup_lane_s64(int64x1_t vec, __constrange(0,0) int lane);
// VMOV d0,d0
uint64x1_t vdup_lane_u64(uint64x1_t vec, __constrange(0,0) int lane);
// VMOV d0,d0
int64x2_t vdupq_lane_s64(int64x1_t vec, __constrange(0,0) int lane);
// VMOV q0,q0
uint64x2_t vdupq_lane_u64(uint64x1_t vec, __constrange(0,0) int lane);
// VMOV q0,q0
Convert to float
float32x2_t vcvt_f32_s32(int32x2_t a); // VCVT.F32.S32 d0, d0
float32x2_t vcvt_f32_u32(uint32x2_t a); // VCVT.F32.U32 d0, d0
float32x4_t vcvtq_f32_s32(int32x4_t a); // VCVT.F32.S32 q0, q0
float32x4_t vcvtq_f32_u32(uint32x4_t a); // VCVT.F32.U32 q0, q0
float32x2_t vcvt_n_f32_s32(int32x2_t a, __constrange(1,32) int b);
// VCVT.F32.S32 d0, d0, #32
float32x2_t vcvt_n_f32_u32(uint32x2_t a, __constrange(1,32) int b);
// VCVT.F32.U32 d0, d0, #32
float32x4_t vcvtq_n_f32_s32(int32x4_t a, __constrange(1,32) int b);
// VCVT.F32.S32 q0, q0, #32
float32x4_t vcvtq_n_f32_u32(uint32x4_t a, __constrange(1,32) int b);
// VCVT.F32.U32 q0, q0, #32
Reciprocal estimate
float32x2_t vrecpe_f32(float32x2_t a); // VRECPE.F32 d0,d0
uint32x2_t vrecpe_u32(uint32x2_t a); // VRECPE.U32 d0,d0
float32x4_t vrecpeq_f32(float32x4_t a); // VRECPE.F32 q0,q0
uint32x4_t vrecpeq_u32(uint32x4_t a); // VRECPE.U32 q0,q0
Bitwise NOT
int8x8_t vmvn_s8(int8x8_t a); // VMVN d0,d0
int16x4_t vmvn_s16(int16x4_t a); // VMVN d0,d0
int32x2_t vmvn_s32(int32x2_t a); // VMVN d0,d0
uint8x8_t vmvn_u8(uint8x8_t a); // VMVN d0,d0
uint16x4_t vmvn_u16(uint16x4_t a); // VMVN d0,d0
uint32x2_t vmvn_u32(uint32x2_t a); // VMVN d0,d0
poly8x8_t vmvn_p8(poly8x8_t a); // VMVN d0,d0
int8x16_t vmvnq_s8(int8x16_t a); // VMVN q0,q0
int16x8_t vmvnq_s16(int16x8_t a); // VMVN q0,q0
int32x4_t vmvnq_s32(int32x4_t a); // VMVN q0,q0
uint8x16_t vmvnq_u8(uint8x16_t a); // VMVN q0,q0
uint16x8_t vmvnq_u16(uint16x8_t a); // VMVN q0,q0
uint32x4_t vmvnq_u32(uint32x4_t a); // VMVN q0,q0
poly8x16_t vmvnq_p8(poly8x16_t a); // VMVN q0,q0
Bitwise AND
int8x8_t vand_s8(int8x8_t a, int8x8_t b); // VAND d0,d0,d0
int16x4_t vand_s16(int16x4_t a, int16x4_t b); // VAND d0,d0,d0
int32x2_t vand_s32(int32x2_t a, int32x2_t b); // VAND d0,d0,d0
int64x1_t vand_s64(int64x1_t a, int64x1_t b); // VAND d0,d0,d0
uint8x8_t vand_u8(uint8x8_t a, uint8x8_t b); // VAND d0,d0,d0
uint16x4_t vand_u16(uint16x4_t a, uint16x4_t b); // VAND d0,d0,d0
uint32x2_t vand_u32(uint32x2_t a, uint32x2_t b); // VAND d0,d0,d0
uint64x1_t vand_u64(uint64x1_t a, uint64x1_t b); // VAND d0,d0,d0
int8x16_t vandq_s8(int8x16_t a, int8x16_t b); // VAND q0,q0,q0
int16x8_t vandq_s16(int16x8_t a, int16x8_t b); // VAND q0,q0,q0
int32x4_t vandq_s32(int32x4_t a, int32x4_t b); // VAND q0,q0,q0
int64x2_t vandq_s64(int64x2_t a, int64x2_t b); // VAND q0,q0,q0
uint8x16_t vandq_u8(uint8x16_t a, uint8x16_t b); // VAND q0,q0,q0
uint16x8_t vandq_u16(uint16x8_t a, uint16x8_t b); // VAND q0,q0,q0
uint32x4_t vandq_u32(uint32x4_t a, uint32x4_t b); // VAND q0,q0,q0
uint64x2_t vandq_u64(uint64x2_t a, uint64x2_t b); // VAND q0,q0,q0
Bitwise OR
int8x8_t vorr_s8(int8x8_t a, int8x8_t b); // VORR d0,d0,d0
int16x4_t vorr_s16(int16x4_t a, int16x4_t b); // VORR d0,d0,d0
int32x2_t vorr_s32(int32x2_t a, int32x2_t b); // VORR d0,d0,d0
int64x1_t vorr_s64(int64x1_t a, int64x1_t b); // VORR d0,d0,d0
uint8x8_t vorr_u8(uint8x8_t a, uint8x8_t b); // VORR d0,d0,d0
uint16x4_t vorr_u16(uint16x4_t a, uint16x4_t b); // VORR d0,d0,d0
uint32x2_t vorr_u32(uint32x2_t a, uint32x2_t b); // VORR d0,d0,d0
uint64x1_t vorr_u64(uint64x1_t a, uint64x1_t b); // VORR d0,d0,d0
int8x16_t vorrq_s8(int8x16_t a, int8x16_t b); // VORR q0,q0,q0
int16x8_t vorrq_s16(int16x8_t a, int16x8_t b); // VORR q0,q0,q0
int32x4_t vorrq_s32(int32x4_t a, int32x4_t b); // VORR q0,q0,q0
int64x2_t vorrq_s64(int64x2_t a, int64x2_t b); // VORR q0,q0,q0
uint8x16_t vorrq_u8(uint8x16_t a, uint8x16_t b); // VORR q0,q0,q0
uint16x8_t vorrq_u16(uint16x8_t a, uint16x8_t b); // VORR q0,q0,q0
uint32x4_t vorrq_u32(uint32x4_t a, uint32x4_t b); // VORR q0,q0,q0
uint64x2_t vorrq_u64(uint64x2_t a, uint64x2_t b); // VORR q0,q0,q0
Bit Clear
int8x8_t vbic_s8(int8x8_t a, int8x8_t b); // VBIC d0,d0,d0
int16x4_t vbic_s16(int16x4_t a, int16x4_t b); // VBIC d0,d0,d0
int32x2_t vbic_s32(int32x2_t a, int32x2_t b); // VBIC d0,d0,d0
int64x1_t vbic_s64(int64x1_t a, int64x1_t b); // VBIC d0,d0,d0
uint8x8_t vbic_u8(uint8x8_t a, uint8x8_t b); // VBIC d0,d0,d0
uint16x4_t vbic_u16(uint16x4_t a, uint16x4_t b); // VBIC d0,d0,d0
uint32x2_t vbic_u32(uint32x2_t a, uint32x2_t b); // VBIC d0,d0,d0
uint64x1_t vbic_u64(uint64x1_t a, uint64x1_t b); // VBIC d0,d0,d0
int8x16_t vbicq_s8(int8x16_t a, int8x16_t b); // VBIC q0,q0,q0
int16x8_t vbicq_s16(int16x8_t a, int16x8_t b); // VBIC q0,q0,q0
int32x4_t vbicq_s32(int32x4_t a, int32x4_t b); // VBIC q0,q0,q0
int64x2_t vbicq_s64(int64x2_t a, int64x2_t b); // VBIC q0,q0,q0
uint8x16_t vbicq_u8(uint8x16_t a, uint8x16_t b); // VBIC q0,q0,q0
uint16x8_t vbicq_u16(uint16x8_t a, uint16x8_t b); // VBIC q0,q0,q0
uint32x4_t vbicq_u32(uint32x4_t a, uint32x4_t b); // VBIC q0,q0,q0
uint64x2_t vbicq_u64(uint64x2_t a, uint64x2_t b); // VBIC q0,q0,q0
Bitwise OR complement
int8x8_t vorn_s8(int8x8_t a, int8x8_t b); // VORN d0,d0,d0
int16x4_t vorn_s16(int16x4_t a, int16x4_t b); // VORN d0,d0,d0
int32x2_t vorn_s32(int32x2_t a, int32x2_t b); // VORN d0,d0,d0
int64x1_t vorn_s64(int64x1_t a, int64x1_t b); // VORN d0,d0,d0
uint8x8_t vorn_u8(uint8x8_t a, uint8x8_t b); // VORN d0,d0,d0
uint16x4_t vorn_u16(uint16x4_t a, uint16x4_t b); // VORN d0,d0,d0
uint32x2_t vorn_u32(uint32x2_t a, uint32x2_t b); // VORN d0,d0,d0
uint64x1_t vorn_u64(uint64x1_t a, uint64x1_t b); // VORN d0,d0,d0
int8x16_t vornq_s8(int8x16_t a, int8x16_t b); // VORN q0,q0,q0
int16x8_t vornq_s16(int16x8_t a, int16x8_t b); // VORN q0,q0,q0
int32x4_t vornq_s32(int32x4_t a, int32x4_t b); // VORN q0,q0,q0
int64x2_t vornq_s64(int64x2_t a, int64x2_t b); // VORN q0,q0,q0
uint8x16_t vornq_u8(uint8x16_t a, uint8x16_t b); // VORN q0,q0,q0
uint16x8_t vornq_u16(uint16x8_t a, uint16x8_t b); // VORN q0,q0,q0
uint32x4_t vornq_u32(uint32x4_t a, uint32x4_t b); // VORN q0,q0,q0
uint64x2_t vornq_u64(uint64x2_t a, uint64x2_t b); // VORN q0,q0,q0
Bitwise Select
Note
This intrinsic can compile to any of VBSL/VBIF/VBIT depending on register allocation.
Transpose elements
int8x8x2_t vtrn_s8(int8x8_t a, int8x8_t b); // VTRN.8 d0,d0
int16x4x2_t vtrn_s16(int16x4_t a, int16x4_t b); // VTRN.16 d0,d0
int32x2x2_t vtrn_s32(int32x2_t a, int32x2_t b); // VTRN.32 d0,d0
uint8x8x2_t vtrn_u8(uint8x8_t a, uint8x8_t b); // VTRN.8 d0,d0
uint16x4x2_t vtrn_u16(uint16x4_t a, uint16x4_t b); // VTRN.16 d0,d0
uint32x2x2_t vtrn_u32(uint32x2_t a, uint32x2_t b); // VTRN.32 d0,d0
float32x2x2_t vtrn_f32(float32x2_t a, float32x2_t b); // VTRN.32 d0,d0
poly8x8x2_t vtrn_p8(poly8x8_t a, poly8x8_t b); // VTRN.8 d0,d0
poly16x4x2_t vtrn_p16(poly16x4_t a, poly16x4_t b); // VTRN.16 d0,d0
int8x16x2_t vtrnq_s8(int8x16_t a, int8x16_t b); // VTRN.8 q0,q0
int16x8x2_t vtrnq_s16(int16x8_t a, int16x8_t b); // VTRN.16 q0,q0
int32x4x2_t vtrnq_s32(int32x4_t a, int32x4_t b); // VTRN.32 q0,q0
uint8x16x2_t vtrnq_u8(uint8x16_t a, uint8x16_t b); // VTRN.8 q0,q0
uint16x8x2_t vtrnq_u16(uint16x8_t a, uint16x8_t b); // VTRN.16 q0,q0
uint32x4x2_t vtrnq_u32(uint32x4_t a, uint32x4_t b); // VTRN.32 q0,q0
float32x4x2_t vtrnq_f32(float32x4_t a, float32x4_t b); // VTRN.32 q0,q0
poly8x16x2_t vtrnq_p8(poly8x16_t a, poly8x16_t b); // VTRN.8 q0,q0
poly16x8x2_t vtrnq_p16(poly16x8_t a, poly16x8_t b); // VTRN.16 q0,q0
Interleave elements
int8x8x2_t vzip_s8(int8x8_t a, int8x8_t b); // VZIP.8 d0,d0
int16x4x2_t vzip_s16(int16x4_t a, int16x4_t b); // VZIP.16 d0,d0
uint8x8x2_t vzip_u8(uint8x8_t a, uint8x8_t b); // VZIP.8 d0,d0
uint16x4x2_t vzip_u16(uint16x4_t a, uint16x4_t b); // VZIP.16 d0,d0
float32x2x2_t vzip_f32(float32x2_t a, float32x2_t b); // VZIP.32 d0,d0
poly8x8x2_t vzip_p8(poly8x8_t a, poly8x8_t b); // VZIP.8 d0,d0
poly16x4x2_t vzip_p16(poly16x4_t a, poly16x4_t b); // VZIP.16 d0,d0
int8x16x2_t vzipq_s8(int8x16_t a, int8x16_t b); // VZIP.8 q0,q0
int16x8x2_t vzipq_s16(int16x8_t a, int16x8_t b); // VZIP.16 q0,q0
int32x4x2_t vzipq_s32(int32x4_t a, int32x4_t b); // VZIP.32 q0,q0
uint8x16x2_t vzipq_u8(uint8x16_t a, uint8x16_t b); // VZIP.8 q0,q0
uint16x8x2_t vzipq_u16(uint16x8_t a, uint16x8_t b); // VZIP.16 q0,q0
uint32x4x2_t vzipq_u32(uint32x4_t a, uint32x4_t b); // VZIP.32 q0,q0
float32x4x2_t vzipq_f32(float32x4_t a, float32x4_t b); // VZIP.32 q0,q0
poly8x16x2_t vzipq_p8(poly8x16_t a, poly8x16_t b); // VZIP.8 q0,q0
poly16x8x2_t vzipq_p16(poly16x8_t a, poly16x8_t b); // VZIP.16 q0,q0
De-Interleave elements
int8x8x2_t vuzp_s8(int8x8_t a, int8x8_t b); // VUZP.8 d0,d0
int16x4x2_t vuzp_s16(int16x4_t a, int16x4_t b); // VUZP.16 d0,d0
int32x2x2_t vuzp_s32(int32x2_t a, int32x2_t b); // VUZP.32 d0,d0
uint8x8x2_t vuzp_u8(uint8x8_t a, uint8x8_t b); // VUZP.8 d0,d0
uint16x4x2_t vuzp_u16(uint16x4_t a, uint16x4_t b); // VUZP.16 d0,d0
uint32x2x2_t vuzp_u32(uint32x2_t a, uint32x2_t b); // VUZP.32 d0,d0
float32x2x2_t vuzp_f32(float32x2_t a, float32x2_t b); // VUZP.32 d0,d0
poly8x8x2_t vuzp_p8(poly8x8_t a, poly8x8_t b); // VUZP.8 d0,d0
poly16x4x2_t vuzp_p16(poly16x4_t a, poly16x4_t b); // VUZP.16 d0,d0
int8x16x2_t vuzpq_s8(int8x16_t a, int8x16_t b); // VUZP.8 q0,q0
int16x8x2_t vuzpq_s16(int16x8_t a, int16x8_t b); // VUZP.16 q0,q0
int32x4x2_t vuzpq_s32(int32x4_t a, int32x4_t b); // VUZP.32 q0,q0
uint8x16x2_t vuzpq_u8(uint8x16_t a, uint8x16_t b); // VUZP.8 q0,q0
uint16x8x2_t vuzpq_u16(uint16x8_t a, uint16x8_t b); // VUZP.16 q0,q0
uint32x4x2_t vuzpq_u32(uint32x4_t a, uint32x4_t b); // VUZP.32 q0,q0
float32x4x2_t vuzpq_f32(float32x4_t a, float32x4_t b); // VUZP.32 q0,q0
poly8x16x2_t vuzpq_p8(poly8x16_t a, poly8x16_t b); // VUZP.8 q0,q0
poly16x8x2_t vuzpq_p16(poly16x8_t a, poly16x8_t b); // VUZP.16 q0,q0
Syntax
vreinterpret{q}_dsttype_srctype
Where:
q
Specifies that the conversion operates on 128-bit vectors. If it is not present, the conversion
operates on 64-bit vectors.
dsttype
Represents the type to convert to.
srctype
Represents the type being converted.
The following intrinsic reinterprets a vector of four signed 16-bit integers as a vector of four unsigned
integers:
uint16x4_t vreinterpret_u16_s16(int16x4_t a);
The following intrinsic reinterprets a vector of four 32-bit floating point values integers as a vector of
four signed integers.
int8x16_t vreinterpretq_s8_f32(float32x4_t a);
These conversions do not change the bit pattern represented by the vector.
VBIF The vbsl* intrinsics compile to any of VBSL/VBIF/VBIT depending on register allocation.
VBIT
VLDM The compiler generates these instructions automatically as appropriate for accesses to floating-point and vector
data types.
VLDR
VSTM
VSTR
VMRS Use the named register variable __asm("fpscr") to access the Floating-Point Status and Control Register
(FPSCR). Using the named register variable causes the compiler to emit VMRS/VMSR instructions as required.
VMSR
VPOP These instructions are used for saving and restoring callee-saved registers. The compiler generates them
automatically at function entry and exit as appropriate for the registers used in the function.
VPUSH
VSWP This instruction has no benefit as an intrinsic because intrinsics use variables to encapsulate register allocation
and access. As a result. swapping of variables can be performed using simple C-style variable assignments.
Related references
18.4 NEON intrinsics for addition on page 18-929.
18.5 NEON intrinsics for multiplication on page 18-931.
18.6 NEON intrinsics for subtraction on page 18-933.
18.7 NEON intrinsics for comparison on page 18-935.
18.8 NEON intrinsics for absolute difference on page 18-937.
18.9 NEON intrinsics for maximum and minimum on page 18-938.
18.10 NEON intrinsics for pairwise addition on page 18-939.
18.11 NEON intrinsics for folding maximum on page 18-940.
18.12 NEON intrinsics for folding minimum on page 18-941.
18.13 NEON intrinsics for reciprocal and sqrt on page 18-942.
18.14 NEON intrinsics for shifts by signed variable on page 18-943.
18.15 NEON intrinsics for shifts by a constant on page 18-945.
18.16 NEON intrinsics for shifts with insert on page 18-949.
18.17 NEON intrinsics for loading a single vector or lane on page 18-951.
18.18 NEON intrinsics for storing a single vector or lane on page 18-953.
18.19 NEON intrinsics for loading an N-element structure on page 18-955.
18.20 NEON intrinsics for extracting lanes from a vector into a register on page 18-964.
18.21 NEON intrinsics for loading a single lane of a vector from a literal on page 18-965.
18.22 NEON intrinsics for initializing a vector from a literal bit pattern on page 18-966.
18.23 NEON intrinsics for setting all lanes to the same value on page 18-967.
Describes the technical changes that have been made to the armcc Compiler User Guide.
It contains the following sections:
• A.1 Revisions for armcc Compiler User Guide on page Appx-A-989.
Updated the example to use the predefined macro __TARGET_CPU_ARM7TDMI 10.161 Predefined macros on page 10-786
Added entries for the Cortex-R8. • 5.53 Processors and their implicit Floating-
Point Units (FPUs) on page 5-218
• 12.3 ARMv6 SIMD intrinsics, compatible
processors and architectures on page 12-824
Clarified that --split_ldm does not work with Thumb instructions, and is not 8.174 --split_ldm on page 8-511
always guaranteed to work with ARM instructions.
Clarified that strings can be stored in both .conststring and .constdata. 8.178 --string_literal_pools, --
no_string_literal_pools on page 8-515
Clarified that C++ smart pointers are unsupported. 11.13 C++11 supported features on page 11-814
Specified that CSPR register is not available for Cortex-M series processors 10.159 Named register variables on page 10-774
Updated to state that the default --gnu_version is now 40700. 8.96 --gnu_version=version on page 8-427
Added generic notes about supported features in ARM Compiler and code 1.1 The compiler on page 1-30
generation between releases.
Documented new C++11 support. • 11.13 C++11 supported features on page 11-814
• 8.40 --cpp11 on page 8-364
• 8.41 --cpp_compat on page 8-365
• 1.2 Source language modes of the compiler
on page 1-31
New Cortex-M7 and Cortex-A17 processors. • 5.53 Processors and their implicit Floating-
Point Units (FPUs) on page 5-218
• 12.3 ARMv6 SIMD intrinsics, compatible
processors and architectures on page 12-824
Added a note stating that support for Precompiled Header (PCH) files is Various topics.
deprecated.
Added note about libraries and no literal pools 8.78 --execute_only on page 8-406
Added a note stating that support for the --gnu_instrument option is • 8.95 --gnu_instrument, --no_gnu_instrument
deprecated. on page 8-426
• 10.41 __attribute__((no_instrument_function))
function attribute on page 10-646
Mentioned that compiler data flow warnings are suppressed by default. 6.6 Compiler data flow warnings on page 6-261
Added a Usage section and corrected the comment in the example. 10.7 __global_reg on page 10-606
Mentioned how the compiler handles UTF-8 or UTF-16 encoded source files • 11.1 Character sets and identifiers in ARM C
and clarified the default values for the --locale and and C++ on page 11-794
--[no_]multibyte_chars options. • 8.122 --locale=lang_country on page 8-455
• 8.133 --multibyte_chars, --no_multibyte_chars
on page 8-466
Clarified the guidance on declaring named register variables. • 4.14 Compiler support for accessing registers
using named register variables on page 4-121.
• 10.159 Named register variables
on page 10-774.
The --message_locale option no longer supports zh_CN or ko_KR settings. 8.130 --message_locale=lang_country[.codepage]
on page 8-463.
Added the chapters from the Compiler Reference into the armcc Compiler User • Chapter 8 Compiler Command-line Options
Guide. The Compiler Reference is no longer being provided as a separate on page 8-312.
document. • Chapter 9 Language Extensions on page 9-549.
• Chapter 10 Compiler-specific Features
on page 10-596.
• Chapter 11 C and C++ Implementation Details
on page 11-793.
• Chapter 12 ARMv6 SIMD Instruction Intrinsics
on page 12-817.
• Chapter 13 Via File Syntax on page 13-884.
• Chapter 14 Summary Table of GNU Language
Extensions on page 14-887.
• Chapter 15 Standard C Implementation
Definition on page 15-891.
• Chapter 16 Standard C++ Implementation
Definition on page 16-912.
• Chapter 17 C and C++ Compiler
Implementation Limits on page 17-917.
• Chapter 18 Using NEON Support
on page 18-923.
Added a topic about compiler support for literal pools. 4.21 Compiler support for literal pools
on page 4-131.
Clarified use of --diag_error=warning 6.2 Options that change the severity of compiler
diagnostic messages on page 6-255.
Enhanced information about the impact of -Onum on the debug view. 5.3 Compiler optimization levels and the debug view
on page 5-154.
Added a note stating that the compiler may generate load and store instructions • 10.123 __ldrex intrinsic on page 10-732.
between the instructions generated for __ldrex(d) and __strrex(d) • 10.124 __ldrexd intrinsic on page 10-734.
intrinsics. • 10.145 __strex intrinsic on page 10-757.
• 10.146 __strexd intrinsic on page 10-759.
Clarified that you cannot specify aliases in block scope. • 10.31 __attribute__((alias)) function attribute
on page 10-635.
• 10.63 __attribute__((alias)) variable attribute
on page 10-668.
Added note about possible compiler optimizations when using the __qsub() 10.134 __qsub intrinsic on page 10-745.
intrinsic.
Clarified that variable length arrays are created on the heap. • 5.11 Stack use in C and C++ on page 5-167.
• 8.197 --vla, --no_vla on page 8-539.
Clarified the access width data tables in the intrinsics documentation. Various topics.
Clarified information about __packed bitfields in a structure. 11.4 Structures, unions, enumerations, and bitfields
in ARM C and C++ on page 11-799.
Corrected the implicit FPU listed for Cortex-M4.fp to FPv4-SP. 5.53 Processors and their implicit Floating-Point
Units (FPUs) on page 5-218.
Removed the topic --ltcg. --ltcg (This topic removed from Issue I).
Added information about NEON instructions without equivalent intrinsics. 18.36 NEON instructions without equivalent
intrinsics on page 18-986.
Removed note about --vectorize requiring a special license. 8.192 --vectorize, --no_vectorize on page 8-534.
Removed links to deprecated document Building Linux Applications with the Various topics.
ARM Compiler toolchain and GNU Libraries.
Updated the example to use the --asm argument instead of the deprecated -S 8.14 --asm_dir=directory_name on page 8-336.
argument.
Updated the example to correctly show the interaction between --depend_dir 8.53 --depend_dir=directory_name on page 8-380.
and --depend.
Clarified interaction between --multifile and -o, and clarified relationship 8.134 --multifile, --no_multifile on page 8-467.
between number of source files, code structure, and compilation time.
Updated information about the __irq keyword. 10.11 __irq on page 10-611.
Clarified __attribute__((alias)) function and variable attributes. • 10.31 __attribute__((alias)) function attribute
on page 10-635.
• 10.63 __attribute__((alias)) variable attribute
on page 10-668.
Added a note about overwriting padding bits in bitfield containers. 11.4 Structures, unions, enumerations, and bitfields
in ARM C and C++ on page 11-799.
Removed note about a possible issue caused by overlapping diagnostic message • 8.58 --diag_error=tag[,tag,...] on page 8-386.
number ranges. This is because the affected messages are renumbered in this • 8.59 --diag_remark=tag[,tag,...] on page 8-387.
release, resolving the issue. • 8.61 --diag_suppress=tag[,tag,...]
on page 8-389.
• 8.63 --diag_warning=tag[,tag,...]
on page 8-391.
Added new --loop_optimization_level option to list of compiler options. 2.2 Compiler command-line options listed by group
on page 2-38.
Update modified C3nnn message numbers to C4nnn. • 6.4 Prefix letters in compiler diagnostic
messages on page 6-259.
• 6.6 Compiler data flow warnings on page 6-261.
Fixed command-line option example to use -O2. 2.4 Order of compiler command-line options
on page 2-45.
Removed all mention of LTCG. • 5.24 Automatic function inlining and multifile
compilation on page 5-181.
• 5.28 Inline functions in C99 mode
on page 5-185.
Added information about enabling NEON and FPU for bare-metal. • 5.5 Enabling NEON and FPU for bare-metal
on page 5-158.
• 3.4 Generating NEON instructions from C or C
++ code on page 3-73.
Added information about using pragmas to control diagnostic messages. 6.3 Controlling compiler diagnostic messages with
pragmas on page 6-257.
Where appropriate, changed the terminology that implied that 16-bit Thumb and Various topics.
32-bit Thumb are separate instruction sets.
Modified the description of the generation of RTTI data with 8.167 --rtti_data, --no_rtti_data on page 8-503.
--no_rtti_data.
Clarified the different treatments of functions with side effects compared to • 10.127 __nop intrinsic on page 10-737.
those without them, by intrinsics that set scheduling barriers. • 10.139 __schedule_barrier intrinsic
on page 10-750.
Added a note about a possible issue caused by overlapping diagnostic message • 8.58 --diag_error=tag[,tag,...] on page 8-386.
number ranges. • 8.59 --diag_remark=tag[,tag,...] on page 8-387.
• 8.61 --diag_suppress=tag[,tag,...]
on page 8-389.
• 8.63 --diag_warning=tag[,tag,...]
on page 8-391.
Added information on estimating/measuring stack usage. 5.11 Stack use in C and C++ on page 5-167.
Clarified which LDM instructions are not supported in the inline assembler. 7.12 Inline assembler instruction restrictions in C
and C++ code on page 7-275.
Clarified the difference between __packed and #pragma pack for address- • 10.12 __packed on page 10-612.
taken fields. • 10.60 __attribute__((packed)) type attribute
on page 10-665.
• 10.97 #pragma pack(n) on page 10-703.
Mentioned that the compiler recognizes the pragmas STDC 15.13 Preprocessing directives on page 15-909.
CX_LIMITED_RANGE, STDC FENV_ACCESS, and STDC FP_CONTRACT, but
does not support them.
Where appropriate, rather than 16-bit Thumb or 32-bit Thumb, referred instead Various topics.
to Thumb, or Thumb-2 technology.
Added two entries for VFPv4, under __TARGET_FPU_xx. • 10.161 Predefined macros on page 10-786.
Added restrictions on C55x intrinsic support. 10.155 C55x intrinsics on page 10-770.
Mentioned that GNU mode also affects C/C++ standards compliance. 8.93 --gnu on page 8-424.
Modified the part of the usage section discouraging expressions with side 10.131 __promise intrinsic on page 10-742.
effects, and clarified the text.
Removed a reference to not accessing a physical register directly. 8.188 --use_frame_pointer, --no_use_frame_pointer
on page 8-530.
Modified the usage section for the __weak keyword for cases of multiple weak 10.20 __weak on page 10-621.
definitions.
Mentioned that NaNs used with the --fpmode=std or --fpmode=fast 8.87 --fpmode=model on page 8-415.
option can produce undefined behavior.
Added a usage section for function attributes. 10.30 Function attributes on page 10-633.
Reduced use of 32-bit Thumb in favor of Thumb or Thumb-2 technology. Various topics.
Clarified the difference between __packed and #pragma pack for address- 5.40 Comparisons of an unpacked struct, a
taken fields. __packed struct, and a struct with individually
__packed fields, and of a __packed struct and a
#pragma packed struct on page 5-198.
Where appropriate, rather than 16-bit Thumb or 32-bit Thumb, referred instead Various topics.
to Thumb or Thumb-2 technology.
Added three entries for VFPv4. 5.44 Vector Floating-Point (VFP) architectures
on page 5-205.
Revised the topics related to integer division by zero. • 5.54 Integer division-by-zero errors in C code
on page 5-221.
Added a note about the maximum version of gcc that armcc supports. 8.96 --gnu_version=version on page 8-427.
Mentioned that downgradable errors are also suppressed with -J. 8.112 -Jdir[,dir,...] on page 8-443.
Modified the description for the --version_number option. 8.193 --version_number on page 8-535.
Modified the description for the --vsn option. 8.198 --vsn on page 8-540.
Changed the format description for __ARMCC_VERSION. 10.161 Predefined macros on page 10-786.
Added the encoding details of opcodes and registers. 10.107 __cdp intrinsic on page 10-715.
Added SC000 to the table of --cpu options. 8.43 --cpu=name on page 8-368.
Added SC300 and SC000 to the table of --compatible options. 8.28 --compatible=name on page 8-351.
Changed --depend=filename to say that for multiple files, the generated 8.52 --depend=filename on page 8-379.
dependency file contains dependency lines from all the source files.
Added a caution that volatile is ignored if used with the __global_reg storage 10.7 __global_reg on page 10-606.
class specifier.
Revised the descriptions for topics related to integer division by zero. • 5.54 Integer division-by-zero errors in C code
on page 5-221.
Mentioned that the inline assembler supports VFPv2 instructions. Mentioned • 7.2 Inline assembler support in the compiler
that the inline assembler does not support instructions added in VFPv3 or on page 7-265.
higher. • 7.3 Restrictions on inline assembler support in
the compiler on page 7-266.
• 7.11 Inline assembler Vector Floating-Point
(VFP) restrictions in C and C++ code
on page 7-274.
Changed the description of the restrictions on the inline assembler. • 7.3 Restrictions on inline assembler support in
the compiler on page 7-266.
• 7.10 Inline assembler Thumb instruction set
restrictions in C and C++ code on page 7-273.
• 7.45 Differences in compiler support for inline
and embedded assembly code on page 7-311.
Removed the example of using coprocessor instructions in inline assembler 7.11 Inline assembler Vector Floating-Point (VFP)
because coprocessor instructions in inline assembler are discouraged. Added a restrictions in C and C++ code on page 7-274.
new example for the use of VFP instructions in inline assembler.
Added a row on VFP and NEON for differences between inline and embedded 7.45 Differences in compiler support for inline and
assembler. embedded assembly code on page 7-311.
Added a summary table of intrinsics and their page numbers. 18.36 NEON instructions without equivalent
intrinsics on page 18-986.
Added syntaxes and tables that provide a condensed representation of the 18.3 NEON intrinsics on page 18-927.
intrinsics. Fixed minor errors in the intrinsic prototypes.
Added list of built-in GNU atomic memory access functions. 10.160 GNU built-in functions on page 10-778.
Added Cortex-A15 and Cortex-R7 to the cpu list. • 8.42 --cpu=list on page 8-367.
• 12.3 ARMv6 SIMD intrinsics, compatible
processors and architectures on page 12-824.
• 10.161 Predefined macros on page 10-786.
Changed option from --implicit_using_std to --using_std. 10.161 Predefined macros on page 10-786.
Added v7E-M to table of Thumb architecture versions in relation to ARM 10.161 Predefined macros on page 10-786.
architecture versions.
Added a note that some registers are not available on some architectures. 10.159 Named register variables on page 10-774.
Changed ARM Compiler v4.1 to ARM Compiler 4.1 and later. • Chapter 8 Compiler Command-line Options
on page 8-312.
• 10.161 Predefined macros on page 10-786.
• 11.4 Structures, unions, enumerations, and
bitfields in ARM C and C++ on page 11-799.
• 11.6 Tentative arrays in ARM C++
on page 11-806.
Changed --apcs options to use variable list. 8.6 --apcs=qualifier...qualifier on page 8-322.
Added note that the option is not required if you are using the ARM Compiler • --reinitialize_workdir (This topic removed from
toolchain with DS-5. Issue J).
• --workdir=directory (This topic removed from
Issue J).
• --project=filename, --no_project (This topic
removed from Issue J).
Added link to command line options and search paths. • 8.112 -Jdir[,dir,...] on page 8-443.
• 8.100 -Idir[,dir,...] on page 8-431.
Added const unsigned int for the variable declarations in the __cdp 10.107 __cdp intrinsic on page 10-715.
example. Also changed the value of ops from 0xAB to 0xA3 because the
second opcode must be 3 bits.
Changed the note to say that the __irq function compiles to ARM or Thumb 10.11 __irq on page 10-611.
code when compiling for a processor that supports ARM and 32-bit Thumb.
Added links to --arm, #pragma arm, and ARM, Thumb, and ThumbEE
instruction sets.
Mentioned that PC is set to LR-4 only in architectures other than ARMv6-M 10.11 __irq on page 10-611.
and ARMv7-M. And added note that for ARMv6-M and ARMv7-M, __irq
does not affect the compiled output.
Added note to deprecate --ltcg. Also added links to ltcg topics in Using the -
Compiler.
Added detail about mask and flags bit. Also added note and link to 10.156 VFP status intrinsic on page 10-771.
<fenv.h> topic in Using the Compiler. Changed "preferable" to "ARM
recommends".
Mentioned class, struct, union, and enum types in the Usage section. Also added • 10.53 __attribute__((visibility("visibility_type"))
that you can apply this attribute to functions and variables. ) function attribute on page 10-658.
• 10.72 __attribute__((visibility("visibility_type"))
) variable attribute on page 10-677.
Corrected description of the --depend option when specifying multiple source 8.52 --depend=filename on page 8-379.
files.
Added a topic on using GCC fallback. 2.14 Using GCC fallback when building Linux
applications on page 2-57.
Removed the topics on Profiler-guided optimizations. Chapter 4 Compiler Features on page 4-103.
Removed references to Eclipse Workbench IDE and ARM Profiler. 5.10 Code metrics for measurement of code size and
data size on page 5-166.
Merged the following topics into the topic Stack use in C and C++: 5.11 Stack use in C and C++ on page 5-167.
• Methods of estimating stack usage.
• Methods of reducing stack usage.
• Using a debugger to estimate stack usage.
Changed --info=summary stack to --info=summarystack. Also removed
references to ARM Profiler.
Rephrased branches to function calls.
Removed the note about profiler guided optimizations. 5.20 Inline functions on page 5-177.
Removed reference to --profile. 5.23 Inline functions and removal of unused out-of-
line functions at link time on page 5-180.
Changed ARMCC41* environment variables to ARMCCnn*. And added link to the Various topics.
topic Toolchain environment variables in the Introducing to ARM Compiler
toolchain document.
Changed ARM Compiler 4.1 to ARM Compiler 4.1 and later. • 5.24 Automatic function inlining and multifile
compilation on page 5-181.
• 4.22 Compiler eight-byte alignment features
on page 4-132.
• 4.9 Compiler support for European
Telecommunications Standards Institute (ETSI)
basic operations on page 4-114.
• 3.4 Generating NEON instructions from C or C
++ code on page 3-73.
• 2.18.4 Effect of --multifile on compilation build
time on page 2-64.
• 2.18.2 Minimizing compilation build time
on page 2-63.
Changed onwards to later, and mentioned ARM Compiler 4.1. • 3.2 The NEON unit on page 3-70.
• 4.8 Compiler intrinsics for Digital Signal
Processing (DSP) on page 4-113.
Removed mention of FLEXlm license. 2.18 Compilation build time on page 2-62.
When -J is not specified on the command-line, mention that the compiler 2.10 Compiler command-line options and search
searches ARMCCnnINC, then ARMINC, then ../include. paths on page 2-53.
Added ARMINC to the list of search paths. 2.9 Factors influencing how the compiler searches
for header files on page 2-52.
Added link to Compiler command line options and search paths. 2.12 The ARMCC5INC environment variable
on page 2-55.
Changed description to say that ARMCCnnINC might be initialized. 2.12 The ARMCC5INC environment variable
on page 2-55.
Moved "...is colon separated on UNIX..." to the topic on ARMCCnnINC. 2.12 The ARMCC5INC environment variable
on page 2-55.
Specify the search order when -I and -J are both specified. 2.10 Compiler command-line options and search
paths on page 2-53.
Added note to deprecate --ltcg. 5.24 Automatic function inlining and multifile
compilation on page 5-181.
Inline assembler definitions with __asm and asm can include multiple strings. • 7.4 Inline assembly language syntax with the
__asm keyword in C and C++ on page 7-267.
• 7.5 Inline assembly language syntax with the
asm keyword in C++ on page 7-268.
• 7.6 Inline assembler rules for compiler keywords
__asm and asm on page 7-269.
Updated the Modes supported column, for example changed Standard C90 to 14.1 Supported GNU extensions on page 14-888.
C90. Added GNU C++ to Compound literals. Added C90, C99, C++ to Variadic
macros. Changed the origin of __alignof__ to GCC-specific. Removed GNU
C++ from void pointer arithmetic.
Removed the mention of the modes (C90 and C++) from the list of the Standard 9.45 GNU extensions to the C and C++ languages
C99 features. on page 9-595.
Removed asm keyword from the list of features that are not part of the ISO 9.45 GNU extensions to the C and C++ languages
standard. This is because the asm keyword is part of Standard C++. The asm on page 9-595.
keyword is mentioned separately.
Renamed the column Extension origin to Origin. Mentioned GCC-specific in 14.1 Supported GNU extensions on page 14-888.
the Origin column for the entries on __attribute__*.
Changed the doubleword alignment to be multiples of 8 instead of 4. 5.31 Advantages of natural data alignment
on page 5-189.
Compiler faults use of at attribute when used on declarations with incomplete 10.64 __attribute__((at(address))) variable attribute
types. on page 10-669.
Input parameter descriptions. User guidance that this intrinsic is for expert use 10.107 __cdp intrinsic on page 10-715.
only.
Return value saturated to unsigned range 0 < x < 2sat -1. 10.149 __usat intrinsic on page 10-763.
--ignore_missing_headers only takes effect when dependency generation 8.101 --ignore_missing_headers on page 8-432.
options are specified.
Descriptive clarification for rvct30, rvct30_c90, rvct31, rvct31_c90, 8.115 --library_interface=lib on page 8-446.
rvct40, rvct40_c90.
If using --show_cmdline with ARM Linux translation options, you must use 8.171 --show_cmdline on page 8-508.
-Warmcc.
__declspec(dllimport) imports a symbol through the dynamic symbol 10.24 __declspec(dllimport) on page 10-627.
table when linking against DLL libraries. (Textual clarification only.)
Added APSR, PSR, DSP, MVFR1, MVFR0, FPINST, FPINST2. 10.159 Named register variables on page 10-774.
Additional GNU built-in functions. 10.160 GNU built-in functions on page 10-778.
Clarification to restrictions on use of __packed when casting. 10.12 __packed on page 10-612.
Added ARM v7E-M architecture, example processor Cortex-M4. 8.43 --cpu=name on page 8-368.
New function attribute that is a GNU compiler extension that the ARM 10.38 __attribute__((format_arg(string-index)))
compiler supports. function attribute on page 10-643.
Removed "The keyword __align comes immediately before the variable 10.2 __align on page 10-601.
name", because both of the following are now compilable:
__align(n) static int x;
static __align(n) int x;
GNU extensions to the C and C++ languages. • 9.45 GNU extensions to the C and C++
languages on page 9-595.
• 14.1 Supported GNU extensions on page 14-888.
Default option is independent of the optimization level. 8.134 --multifile, --no_multifile on page 8-467.
Removed from document. Available as knowledgebase articles. See asm keyword, case ranges, cast of a union, character
14.1 Supported GNU extensions on page 14-888. escape sequences, compound literals, conditionals,
designated inits, extended lvalues, initializers, inline
functions, labels as values, pointer arithmetic,
statement expressions, unnamed fields, zero-length
arrays.
Changed the value of the modulo result for four intrinsic functions from • 12.23 __smlald intrinsic on page 12-845.
modulo64 to modulo 264. • 12.24 __smlaldx intrinsic on page 12-846.
• 12.27 __smlsld intrinsic on page 12-849.
• 12.28 __smlsldx intrinsic on page 12-850.
Changed addition to subtraction for both of the val options in the __ssub16 12.35 __ssub16 intrinsic on page 12-857.
intrinsic.
Filename suffixes .i, .ii, .a, .lib, .so added. 2.7 Filename suffixes recognized by the compiler
on page 2-49.
Usage notes for .S suffix. 2.7 Filename suffixes recognized by the compiler
on page 2-49.
Description for .sx suffix. 2.7 Filename suffixes recognized by the compiler
on page 2-49.
Search criteria for armlink and armasm executables. 2.3 Default compiler behavior on page 2-44.
Example code for promise.c. 3.19 Indicating loop iteration counts to the compiler
with __promise(expr) on page 3-89.