The ARM Optimizing C/C++ Compiler User's Guide explains how to use the following Texas Instruments Code Generation compiler tools:
The TI compiler accepts C and C++ code conforming to the International Organization for Standardization (ISO) standards for these languages. The compiler supports the 1989, 1999, and 2011 versions of the C language and the 2014 version of the C++ language.
This user's guide discusses the characteristics of the TI C/C++ compiler. It assumes that you already know how to write C/C++ programs. The C Programming Language (second edition), by Brian W. Kernighan and Dennis M. Ritchie, describes C based on the ISO C standard. You can use the Kernighan and Ritchie (hereafter referred to as K&R) book as a supplement to this manual. References to K&R C (as opposed to ISO C) in this manual refer to the C language as defined in the first edition of Kernighan and Ritchie's The C Programming Language.
This document uses the following conventions:
#include <stdio.h>
main()
{ printf("Hello World\n");
}
armcl [options] [filenames] [--run_linker [link_options] [object files]] |
armcl --run_linker {--rom_model | --ram_model} filenames [--output_file=name.out] | |
--library=libraryname |
symbol .usect "section name", size in bytes[, alignment] |
You can use the following books to supplement this user's guide:
ANSI X3.159-1989, Programming Language - C (Alternate version of the 1989 C Standard), American National Standards Institute
ISO/IEC 9899:1989, International Standard - Programming Languages - C (The 1989 C Standard), International Organization for Standardization
ISO/IEC 9899:1999, International Standard - Programming Languages - C (The 1999 C Standard), International Organization for Standardization
ISO/IEC 9899:2011, International Standard - Programming Languages - C (The 2011 C Standard), International Organization for Standardization
ISO/IEC 14882-2014, International Standard - Programming Languages - C++ (The 2014 C++ Standard), International Organization for Standardization
The C Programming Language (second edition), by Brian W. Kernighan and Dennis M. Ritchie, published by Prentice-Hall, Englewood Cliffs, New Jersey, 1988
The Annotated C++ Reference Manual, Margaret A. Ellis and Bjarne Stroustrup, published by Addison-Wesley Publishing Company, Reading, Massachusetts, 1990
C: A Reference Manual (fourth edition), by Samuel P. Harbison, and Guy L. Steele Jr., published by Prentice Hall, Englewood Cliffs, New Jersey
Programming Embedded Systems in C and C++, by Michael Barr, Andy Oram (Editor), published by O'Reilly & Associates; ISBN: 1565923545, February 1999
Programming in C, Steve G. Kochan, Hayden Book Company
The C++ Programming Language (second edition), Bjarne Stroustrup, published by Addison-Wesley Publishing Company, Reading, Massachusetts, 1990
Tool Interface Standards (TIS) DWARF Debugging Information Format Specification Version 2.0, TIS Committee, 1995
DWARF Debugging Information Format Version 3, DWARF Debugging Information Format Workgroup, Free Standards Group, 2005 (http://dwarfstd.org)
DWARF Debugging Information Format Version 4, DWARF Debugging Information Format Workgroup, Free Standards Group, 2010 (http://dwarfstd.org)
System V ABI specification (http://www.sco.com/developers/gabi/)
ARM C Language Extensions (ACLE) specification (ACLE Version ACLE Q2 2017)
See the following resources for further information about the TI Code Generation Tools:
You can use the following documents to supplement this user's guide:
Code Composer Studio is a registered trademark of Texas Instruments.
ARM is a registered trademark of ARM Limited.
The ARM® is supported by a set of software development tools, which includes an optimizing C/C++ compiler, an assembler, a linker, and assorted utilities.
This chapter provides an overview of these tools and introduces the features of the optimizing C/C++ compiler. The assembler and linker are discussed in detail in the ARM Assembly Language Tools User's Guide.
Figure 1-1 illustrates the software development flow. The shaded portion of the figure highlights the most common path of software development for C language programs. The other portions are peripheral functions that enhance the development process.
The following list describes the tools that are shown in Figure 1-1:
The library-build utility automatically builds the run-time-support library if compiler and linker options require a custom version of the library. See Section 7.4. Source code for the standard run-time-support library functions for C and C++ is provided in the lib\src subdirectory of the directory where the compiler is installed.
The compiler is a command-line program named armcl. This program can compile, optimize, assemble, and link programs in a single step. Within Code Composer Studio™, the compiler is run automatically to perform the steps needed to build a project.
For more information about compiling a program, see Section 2.1
The compiler has straightforward calling conventions, so you can write assembly and C functions that call each other. For more information about calling conventions, see Section 6.
The compiler supports the 1989, 1999, and 2011 versions of the C language and the 2014 version of the C++ language. The C and C++ language features in the compiler are implemented in conformance with the following ISO standards:
The C compiler supports the 1989, 1999, and 2011 versions of the C language.
The compiler uses the C++14 version of the C++ standard. Previously, C++03 was used. See the C++ Standard ISO/IEC 14882:2014. For a description of unsupported C++ features, see Section 5.2.
The compiler tools come with an extensive run-time library. Library functions conform to the ISO C/C++ library standard unless otherwise stated. The library includes functions for standard input and output, string manipulation, dynamic memory allocation, data conversion, timekeeping, trigonometry, and exponential and hyperbolic functions. Functions for signal handling are not included, because these are target-system specific. For more information, see Section 7.
See Section 5.16 for command line options to select the C or C++ standard your code uses.
The following types of output files are created by the compiler:
COFF object files and the legacy TIABI and TI ARM9 ABI modes are not supported in v15.6.0.STS and later versions of the TI Code Generation Tools. If you would like to produce COFF output files, please use v5.2 of the ARM Code Generation Tools and refer to SPNU151J for documentation.
These features are compiler utilities:
The library-build utility lets you custom-build object libraries from source for any combination of run-time models. For more information, see Section 7.4.
The C++ name demangler (armdem) is a debugging aid that translates each mangled name it detects in compiler-generated assembly code, disassembly output, or compiler diagnostic messages to its original name found in the C++ source code. For more information, see Section 8.
For stand-alone embedded applications, the compiler has the ability to place all code and initialization data into ROM, allowing C/C++ code to run from reset. The ELF files output by the compiler can be converted to EPROM programmer data files by using the hex conversion utility, as described in the ARM Assembly Language Tools User's Guide.
The compiler translates your source program into machine language object code that the ARM can execute. Source code must be compiled, assembled, and linked to create an executable file. All of these steps are executed at once by using the compiler.
The compiler lets you compile, optimize, assemble, and optionally link in one step. The compiler performs the following steps on one or more source modules:
You can compile C, C++, and assembly files in a single command. The compiler uses the filename extensions to distinguish between different file types. See Section 2.3.9 for more information.
NOTE
Invoking the LinkerBy default, the compiler does not invoke the linker. You can invoke the linker by using the --run_linker (-z) compiler option. See Section 4.1.1 for details.
For a complete description of the assembler and the linker, see the ARM Assembly Language Tools User's Guide.
To invoke the compiler, enter:
armcl[options] [filenames] [--run_linker [link_options] object files]] |
armcl | Command that runs the compiler and the assembler. |
options | Options that affect the way the compiler processes input files. The options are listed in Table 2-7 through Table 2-29. |
filenames | One or more C/C++ source files and assembly language source files. |
--run_linker (-z) | Option that invokes the linker. The --run_linker option's short form is -z. See Section 4 for more information. |
link_options | Options that control the linking process. |
object files | Names of the object files for the linking process. |
The arguments to the compiler are of three types:
The --run_linker option indicates linking is to be performed. If the --run_linker option is used, any compiler options must precede the --run_linker option, and all link options must follow the --run_linker option.
Source code filenames must be placed before the --run_linker option. Additional object file filenames can be placed after the --run_linker option.
For example, if you want to compile two files named symtab.c and file.c, assemble a third file named seek.asm, and link to create an executable program called myprogram.out, you will enter:
armcl symtab.c file.c seek.asm --run_linker --library=lnk.cmd
--output_file=myprogram.out
Options control the operation of the compiler. This section provides a description of option conventions and an option summary table. It also provides detailed descriptions of the most frequently used options, including options used for type-checking and assembling.
For a help screen summary of the options, enter armcl with no parameters on the command line.
The following apply to the compiler options:
You can define default options for the compiler by using the TI_ARM_C_OPTION environment variable. For a detailed description of the environment variable, see Section 2.4.1.
Table 2-7 through Table 2-29 summarize all options (including link options). Use the references in the tables for more complete descriptions of the options.
Option | Alias | Effect | Section |
---|---|---|---|
--silicon_version={ 4 | 5e | 6 | 6M0 | 7A8 | 7M3 | 7M4 | 7R4 | 7R5 } | -mv | Selects processor version: ARM V4 (ARM7), ARM V5e (ARM9E), ARM V6 (ARM11), ARM V6M0 (Cortex-M0), ARM V7A8 (Cortex-A8), ARM V7M3 (Cortex-M3), ARM V7M4 (Cortex-M4), ARM V7R4 (Cortex-R4), or ARM V7R5 (Cortex-R5). The default is ARM V4. | Section 2.3.4 |
--code_state={ 16 | 32 } | Designates the ARM compilation mode. | Section 2.3.4 | |
--float_support={ vfpv2 | vfpv3 | vfpv3d16 | fpv4spd16 | none ) | Generates vector floating-point (VFP) coprocessor instructions. | Section 2.14 | |
--little_endian or --endian={ big | little } | -me | Designates little-endian code. The default is big-endian. | Section 2.3.4 |
Option | Alias | Effect | Section |
---|---|---|---|
--opt_level=off | Disables all optimization. | Section 3.1 | |
--opt_level=n | -On | Level 0 (-O0) optimizes register usage only.
Level 1 (-O1) uses Level 0 optimizations and optimizes locally. Level 2 (-O2) uses Level 1 optimizations and optimizes globally. Level 3 (-O3) uses Level 2 optimizations and optimizes the file (default if option not used). Level 4 (-O4) uses Level 3 optimizations and performs link-time optimization. |
Section 3.1, Section 3.3, Section 3.6 |
--opt_for_speed[=n] | -mf | Controls the tradeoff between size and speed (0-5 range). If this option is specified without n, the default value is 4. If this option is not specified, the default setting is 1. | Section 3.2 |
Option | Alias | Effect | Section |
---|---|---|---|
--auto_inline=[size] | -oi | Sets automatic inlining size (--opt_level=3 only). If size is not specified, the default is 1. | Section 3.5 |
--call_assumptions=n | -opn | Level 0 (-op0) specifies that the module contains functions and variables that are called or modified from outside the source code provided to the compiler.
Level 1 (-op1) specifies that the module contains variables modified from outside the source code provided to the compiler but does not use functions called from outside the source code. Level 2 (-op2) specifies that the module contains no functions or variables that are called or modified from outside the source code provided to the compiler (default). Level 3 (-op3) specifies that the module contains functions that are called from outside the source code provided to the compiler but does not use variables modified from outside the source code. |
Section 3.4.1 |
--disable_inlining | Prevents any inlining from occurring. | Section 2.11 | |
--fp_mode={relaxed|strict} | Enables or disables relaxed floating-point mode. | Section 2.3.3 | |
--fp_reassoc={on|off} | Enables or disables the reassociation of floating-point arithmetic. | Section 2.3.3 | |
--gen_opt_info=n | -onn | Level 0 (-on0) disables the optimization information file.
Level 1 (-on2) produces an optimization information file. Level 2 (-on2) produces a verbose optimization information file. |
Section 3.3.1 |
--optimizer_interlist | -os | Interlists optimizer comments with assembly statements. | Section 3.11 |
--program_level_compile | -pm | Combines source files to perform program-level optimization. | Section 3.4 |
--sat_reassoc={on|off} | Enables or disables the reassociation of saturating arithmetic. Default is --sat_reassoc=off. | Section 2.3.3 | |
--aliased_variables | -ma | Indicates that a specific aliasing technique is used. | Section 3.9 |
Option | Alias | Effect | Section |
---|---|---|---|
--symdebug:dwarf | -g | Default behavior. Enables symbolic debugging. The generation of debug information does not impact optimization. Therefore, generating debug information is enabled by default. | Section 2.3.5
Section 3.12 |
--symdebug:dwarf_version=2|3|4 | Specifies the DWARF format version. | Section 2.3.5 | |
--symdebug:none | Disables all symbolic debugging. | Section 2.3.5
Section 3.12 |
|
--symdebug:skeletal | (Deprecated; has no effect.) |
Option | Alias | Effect | Section |
---|---|---|---|
--include_path=directory | -I | Adds the specified directory to the #include search path. | Section 2.5.2.1 |
--preinclude=filename | Includes filename at the beginning of compilation. | Section 2.3.3 |
Option | Alias | Effect | Section |
---|---|---|---|
--advice:power[={all|none|rulespec}] | Enables checking the specified ULP Advisor rules. (Default is all.) | Section 2.3.3 | |
--advice:power_severity={error|
warning|remark|suppress} |
Sets the diagnostic severity for ULP Advisor rules. | Section 2.3.3 |
Option | Alias | Effect | Section |
---|---|---|---|
--compile_only | -c | Disables linking (negates --run_linker). | Section 4.1.3 |
--help | -h | Prints (on the standard output device) a description of the options understood by the compiler. | Section 2.3.2 |
--run_linker | -z | Causes the linker to be invoked from the compiler command line. | Section 2.3.2 |
--skip_assembler | -n | Compiles C/C++ source file, producing an assembly language output file. The assembler is not run and no object file is produced. | Section 2.3.2 |
Option | Alias | Effect | Section |
---|---|---|---|
--c89 | Processes C files according to the ISO C89 standard. | Section 5.16 | |
--c99 | Processes C files according to the ISO C99 standard. | Section 5.16 | |
--c11 | Processes C files according to the ISO C11 standard. | Section 5.16 | |
--c++14 | Processes C++ files according to the ISO C++14 standard.
The --c++03 option has been deprecated. |
Section 5.16 | |
--cpp_default | -fg | Processes all source files with a C extension as C++ source files. | Section 2.3.7 |
--enum_type={int|packed} | Designates the underlying type of an enumeration type. | Section 2.3.4 | |
--exceptions | Enables C++ exception handling. | Section 5.8 | |
--extern_c_can_throw | Allow extern C functions to propagate exceptions. | -- | |
--float_operations_allowed
={none|all|32|64} |
Restricts the types of floating point operations allowed. | Section 2.3.3 | |
--gen_cross_reference | -px | Generates a cross-reference listing file (.crl). | Section 2.9 |
--pending_instantiations=# | Specify the number of template instantiations that may be in progress at any given time. Use 0 to specify an unlimited number. | Section 2.3.4 | |
--plain_char={signed|unsigned} | -mc | Specifies how to treat plain chars, default is unsigned. | Section 2.3.4 |
--printf_support={nofloat|full|
minimal} |
Enables support for smaller, limited versions of the printf function family (sprintf, fprintf, etc.) and the scanf function family (sscanf, fscanf, etc.) run-time-support functions. | Section 2.3.3 | |
--relaxed_ansi | -pr | Enables relaxed mode; ignores strict ISO violations. This is on by default. To disable this mode, use the --strict_ansi option. | Section 5.16.3 |
--rtti | -rtti | Enables C++ run-time type information (RTTI). | –- |
--strict_ansi | -ps | Enables strict ANSI/ISO mode (for C/C++, not for K&R C). In this mode, language extensions that conflict with ANSI/ISO C/C++ are disabled. In strict ANSI/ISO mode, most ANSI/ISO violations are reported as errors. Violations that are considered discretionary may be reported as warnings instead. | Section 5.16.3 |
--wchar_t={32|16} | Sets the size of the C/C++ type wchar_t. Default is 16 bits. | Section 2.3.4 |
Option | Alias | Effect | Section |
---|---|---|---|
--preproc_dependency[=filename] | -ppd | Performs preprocessing only, but instead of writing preprocessed output, writes a list of dependency lines suitable for input to a standard make utility. | Section 2.5.8 |
--preproc_includes[=filename] | -ppi | Performs preprocessing only, but instead of writing preprocessed output, writes a list of files included with the #include directive. | Section 2.5.9 |
--preproc_macros[=filename] | -ppm | Performs preprocessing only. Writes list of predefined and user-defined macros to a file with the same name as the input but with a .pp extension. | Section 2.5.10 |
--preproc_only | -ppo | Performs preprocessing only. Writes preprocessed output to a file with the same name as the input but with a .pp extension. | Section 2.5.4 |
--preproc_with_comment | -ppc | Performs preprocessing only. Writes preprocessed output, keeping the comments, to a file with the same name as the input but with a .pp extension. | Section 2.5.6 |
--preproc_with_compile | -ppa | Continues compilation after preprocessing with any of the -pp<x> options that normally disable compilation. | Section 2.5.5 |
--preproc_with_line | -ppl | Performs preprocessing only. Writes preprocessed output with line-control information (#line directives) to a file with the same name as the input but with a .pp extension. | Section 2.5.7 |
Option | Alias | Effect | Section |
---|---|---|---|
--define=name[=def] | -D | Predefines name. | Section 2.3.2 |
--undefine=name | -U | Undefines name. | Section 2.3.2 |
Option | Alias | Effect | Section |
---|---|---|---|
--compiler_revision | Prints out the compiler release revision and exits. | -- | |
--diag_error=num | -pdse | Categorizes the diagnostic identified by num as an error. | Section 2.7.1 |
--diag_remark=num | -pdsr | Categorizes the diagnostic identified by num as a remark. | Section 2.7.1 |
--diag_suppress=num | -pds | Suppresses the diagnostic identified by num. | Section 2.7.1 |
--diag_warning=num | -pdsw | Categorizes the diagnostic identified by num as a warning. | Section 2.7.1 |
--diag_wrap={on|off} | Wrap diagnostic messages (default is on). Note that this command-line option cannot be used within the Code Composer Studio IDE. | ||
--display_error_number | -pden | Displays a diagnostic's identifiers along with its text. Note that this command-line option cannot be used within the Code Composer Studio IDE. | Section 2.7.1 |
--emit_warnings_as_errors | -pdew | Treat warnings as errors. | Section 2.7.1 |
--gen_func_info_listing | Generate user information file (.aux). | Section 2.3.2 | |
--issue_remarks | -pdr | Issues remarks (non-serious warnings). | Section 2.7.1 |
--no_warnings | -pdw | Suppresses diagnostic warnings (errors are still issued). | Section 2.7.1 |
--quiet | -q | Suppresses progress messages (quiet). | -- |
--set_error_limit=num | -pdel | Sets the error limit to num. The compiler abandons compiling after this number of errors. (The default is 100.) | Section 2.7.1 |
--super_quiet | Super quiet mode. | -- | |
--tool_version | -version | Displays version number for each tool. | -- |
--verbose | Display banner and function progress information. | -- | |
--verbose_diagnostics | -pdv | Provides verbose diagnostic messages that display the original source with line-wrap. Note that this command-line option cannot be used within the Code Composer Studio IDE. | Section 2.7.1 |
--write_diagnostics_file | Generates a diagnostic message information file. Compiler only option. Note that this command-line option cannot be used within the Code Composer Studio IDE. | Section 2.7.1 |
Option | Alias | Effect | Section |
---|---|---|---|
--gen_preprocessor_listing | -pl | Generates a raw listing file (.rl). | Section 2.10 |
--section_sizes={on|off} | Generates section size information, including sizes for sections containing executable code and constants, constant or initialized data (global and static variables), and uninitialized data. (Default is off if this option is not included on the command line. Default is on if this option is used with no value specified.) | Section 2.7.1 |
Option | Alias | Effect | Section |
---|---|---|---|
--common={on|off} | On by default. When on, uninitialized file scope variables are emitted as common symbols. When off, common symbols are not created. | Section 2.3.4 | |
--embedded_constants={on|off} | Controls whether compiler embeds constants in functions. | Section 2.3.4 | |
--gen_data_subsections={on|off} | Place all aggregate data (arrays, structs, and unions) into subsections. This gives the linker more control over removing unused data during the final link step. The default is on. | Section 4.2.2 | |
--global_register={r5|r6|r9} | -rr | Disallows use of rx=[5,6,9] by the compiler. | Section 2.3.4 |
-neon | Enables support for the Cortex-A8 Neon SIMD instruction set. | Section 2.3.4 | |
--ramfunc={on|off} | If set to on, specifies that all functions should be placed in the .TI.ramfunc section, which is placed in RAM. | Section 2.3.4 | |
--unaligned_access={on|off} | Controls generation of unaligned accesses. | Section 2.3.4 | |
--use_dead_funcs_list [=fname] | Places each function listed in the file in a separate section. | Section 2.3.4 |
Option | Alias | Effect | Section |
---|---|---|---|
--entry_hook[=name] | Enables entry hooks. | Section 2.15 | |
--entry_parm={none|name|
address} |
Specifies the parameters to the function to the --entry_hook option. | Section 2.15 | |
--exit_hook[=name] | Enables exit hooks. | Section 2.15 | |
--exit_parm={none|name|address} | Specifies the parameters to the function to the --exit_hook option. | Section 2.15 | |
--remove_hooks_when_inlining | Removes entry/exit hooks for auto-inlined functions. | Section 2.15 |
Option | Alias | Effect | Section |
---|---|---|---|
--analyze=codecov | Generate analysis info from profile data. | Section 3.8.2.2 | |
--analyze_only | Only generate analysis. | Section 3.8.2.2 | |
--gen_profile_info | Generates instrumentation code to collect profile information. | Section 3.7.1.3 | |
--use_profile_info=file1[, file2,...] | Specifies the profile information file(s). | Section 3.7.1.3 |
Option | Alias | Effect | Section |
---|---|---|---|
--keep_asm | -k | Keeps the assembly language (.asm) file. | Section 2.3.11 |
--asm_listing | -al | Generates an assembly listing file. | Section 2.3.11 |
--c_src_interlist | -ss | Interlists C source and assembly statements. | Section 2.12
Section 3.11 |
--src_interlist | -s | Interlists optimizer comments (if available) and assembly source statements; otherwise interlists C and assembly source statements. | Section 2.3.2 |
--absolute_listing | -aa | Enables absolute listing. | Section 2.3.11 |
--asm_define=name[=def] | -ad | Sets the name symbol. | Section 2.3.11 |
--asm_dependency | -apd | Performs preprocessing; lists only assembly dependencies. | Section 2.3.11 |
--asm_includes | -api | Performs preprocessing; lists only included #include files. | Section 2.3.11 |
--asm_undefine=name | -au | Undefines the predefined constant name. | Section 2.3.11 |
--code_state={16|32} | Begins assembling instructions as 16- or 32-bit instructions. | Section 2.3.11 | |
--asm_listing_cross_reference | -ax | Generates the cross-reference file. | Section 2.3.11 |
--include_file=filename | -ahi | Includes the specified file for the assembly module. | Section 2.3.11 |
Option | Alias | Effect | Section |
---|---|---|---|
--asm_file=filename | -fa | Identifies filename as an assembly source file regardless of its extension. By default, the compiler and assembler treat .asm files as assembly source files. | Section 2.3.7 |
--c_file=filename | -fc | Identifies filename as a C source file regardless of its extension. By default, the compiler treats .c files as C source files. | Section 2.3.7 |
--cpp_file=filename | -fp | Identifies filename as a C++ file, regardless of its extension. By default, the compiler treats .C, .cpp, .cc and .cxx files as a C++ files. | Section 2.3.7 |
--obj_file=filename | -fo | Identifies filename as an object code file regardless of its extension. By default, the compiler and linker treat .obj files as object code files, including both *.c.obj and *.cpp.obj files. | Section 2.3.7 |
Option | Alias | Effect | Section |
---|---|---|---|
--abs_directory=directory | -fb | Specifies an absolute listing file directory. By default, the compiler uses the object file directory. | Section 2.3.10 |
--asm_directory=directory | -fs | Specifies an assembly file directory. By default, the compiler uses the current directory. | Section 2.3.10 |
--list_directory=directory | -ff | Specifies an assembly listing file and cross-reference listing file directory By default, the compiler uses the object file directory. | Section 2.3.10 |
--obj_directory=directory | -fr | Specifies an object file directory. By default, the compiler uses the current directory. | Section 2.3.10 |
--output_file=filename | -fe | Specifies a compilation output file name; can override --obj_directory. | Section 2.3.10 |
--pp_directory=dir | Specifies a preprocessor file directory. By default, the compiler uses the current directory. | Section 2.3.10 | |
--temp_directory=directory | -ft | Specifies a temporary file directory. By default, the compiler uses the current directory. | Section 2.3.10 |
Option | Alias | Effect | Section |
---|---|---|---|
--asm_extension=[.]extension | -ea | Sets a default extension for assembly source files.
|
Section 2.3.9 |
--c_extension=[.]extension | -ec | Sets a default extension for C source files. | Section 2.3.9 |
--cpp_extension=[.]extension | -ep | Sets a default extension for C++ source files. | Section 2.3.9 |
--listing_extension=[.]extension | -es | Sets a default extension for listing files. | Section 2.3.9 |
--obj_extension=[.]extension | -eo | Sets a default extension for object files. | Section 2.3.9 |
Option | Alias | Effect | Section |
---|---|---|---|
--cmd_file=filename | -@ | Interprets contents of a file as an extension to the command line. Multiple -@ instances can be used. | Section 2.3.2 |
Option | Alias | Effect | Section |
---|---|---|---|
--check_misra[={all|required|
advisory|none|rulespec}] |
Enables checking of the specified MISRA-C:2004 rules. Default is all. | Section 2.3.3 | |
--misra_advisory={error|warning|
remark|suppress} |
Sets the diagnostic severity for advisory MISRA-C:2004 rules. | Section 2.3.3 | |
--misra_required={error|warning|
remark|suppress} |
Sets the diagnostic severity for required MISRA-C:2004 rules. | Section 2.3.3 |
The following tables list the linker options. See Section 4 of this document and the ARM Assembly Language Tools User's Guide for details on these options.
Option | Alias | Description |
---|---|---|
--run_linker | -z | Enables linking. |
--output_file=file | -o | Names the executable output file. The default filename is a .out file. |
--map_file=file | -m | Produces a map or listing of the input and output sections, including holes, and places the listing in file. |
--stack_size=size | [-]-stack | Sets C system stack size to sizebytes and defines a global symbol that specifies the stack size. Default = 2K bytes. |
--heap_size=size | [-]-heap | Sets heap size (for the dynamic memory allocation in C) to sizebytes and defines a global symbol that specifies the heap size. Default = 2K bytes. |
Option | Alias | Description |
---|---|---|
--library=file | -l | Names an archive library or link command file as linker input. |
--disable_auto_rts | Disables the automatic selection of a run-time-support library. See Section 4.3.1.1. | |
--priority | -priority | Satisfies unresolved references by the first library that contains a definition for that symbol. |
--reread_libs | -x | Forces rereading of libraries, which resolves back references. |
--search_path=pathname |
-I
|
Alters library-search algorithms to look in a directory named with pathname before looking in the default location. This option must appear before the --library option. |
Option | Alias | Description |
---|---|---|
--define=name=value | Predefines name as a preprocessor macro. | |
--undefine=name | Removes the preprocessor macro name. | |
--disable_pp | Disables preprocessing for command files. |
Option | Alias | Description |
---|---|---|
--diag_error=num | Categorizes the diagnostic identified by num as an error. | |
--diag_remark=num | Categorizes the diagnostic identified by num as a remark. | |
--diag_suppress=num | Suppresses the diagnostic identified by num. | |
--diag_warning=num | Categorizes the diagnostic identified by num as a warning. | |
--display_error_number | Displays a diagnostic's identifiers along with its text. | |
--emit_references:file[=file] | Emits a file containing section information. The information includes section size, symbols defined, and references to symbols. | |
--emit_warnings_as_errors | -pdew | Treat warnings as errors. |
--issue_remarks | Issues remarks (non-serious warnings). | |
--no_demangle | Disables demangling of symbol names in diagnostic messages. | |
--no_warnings | Suppresses diagnostic warnings (errors are still issued). | |
--set_error_limit=count | Sets the error limit to count. The linker abandons linking after this number of errors. (The default is 100.) | |
--verbose_diagnostics | Provides verbose diagnostic messages that display the original source with line-wrap. | |
--warn_sections | -w | Displays a message when an undefined output section is created. |
Option | Alias | Description |
---|---|---|
--absolute_exe | -a | Produces an absolute, executable object file. This is the default; if neither --absolute_exe nor --relocatable is specified, the linker acts as if --absolute_exe were specified. |
--ecc={ on | off } | Enable linker-generated Error Correcting Codes (ECC). The default is off. | |
--ecc:data_error | Inject specified errors into the output file for testing. | |
--ecc:ecc_error | Inject specified errors into the Error Correcting Code (ECC) for testing. | |
--generate_dead_funcs_list | Writes a list of the dead functions that were removed by the linker to file fname. | |
--mapfile_contents=attribute | Controls the information that appears in the map file. | |
--relocatable | -r | Produces a nonexecutable, relocatable output object file. |
--rom | Creates a ROM object. | |
--run_abs | -abs | Produces an absolute listing file. |
--xml_link_info=file | Generates a well-formed XML file containing detailed information about the result of a link. |
Option | Alias | Description |
---|---|---|
--entry_point=symbol | -e | Defines a global symbol that specifies the primary entry point for the executable object file. |
--globalize=pattern | Changes the symbol linkage to global for symbols that match pattern. | |
--hide=pattern | Hides symbols that match the specified pattern. | |
--localize=pattern | Make the symbols that match the specified pattern local. | |
--make_global=symbol | -g | Makes symbol global (overrides -h). |
--make_static | -h | Makes all global symbols static. |
--no_symtable | -s | Strips symbol table information and line number entries from the executable object file. |
--retain | Retains a list of sections that otherwise would be discarded. | |
--scan_libraries | -scanlibs | Scans all libraries for duplicate symbol definitions. |
--symbol_map=refname=defname | Specifies a symbol mapping; references to the refname symbol are replaced with references to the defname symbol. The --symbol_map option is supported when used with --opt_level=4.
|
|
--undef_sym=symbol | -u | Adds symbol to the symbol table as an unresolved symbol. |
--unhide=pattern | Excludes symbols that match the specified pattern from being hidden. |
Option | Alias | Description |
---|---|---|
--arg_size=size | --args | Reserve size bytes for the argc/argv memory area. |
--cinit_hold_wdt={on|off} | Link in an RTS auto-initialization routine that either holds (on) or does not hold (off) the watchdog timer during cinit auto-initialization. See Section 4.3.3. | |
-be32 | Forces the linker to generate BE-32 object code. | |
-be8 | Forces the linker to generate BE-8 object code. | |
--cinit_compression[=type] | Specifies the type of compression to apply to the C auto initialization data. The default if this option is specified with no type is lzss for Lempel-Ziv-Storer-Szymanski compression. | |
--copy_compression[=type] | Compresses data copied by linker copy tables. The default if this option is specified with no type is lzss for Lempel-Ziv-Storer-Szymanski compression. | |
--fill_value=value | -f | Sets default fill value for holes within output sections |
--ram_model | -cr | Initializes variables at load time. See Section 4.3.5 for details. |
--rom_model | -c | Autoinitializes variables at run time. See Section 4.3.5 for details. |
--trampolines[=off|on] | Generates far call trampolines (argument is optional, is "on" by default). |
Option | Alias | Description |
---|---|---|
--compress_dwarf[=off|on] | Aggressively reduces the size of DWARF information from input object files. Default is on. | |
--linker_help | [-]-help | Displays information about syntax and available options. |
--minimize_trampolines | Places sections to minimize number of far trampolines required. | |
--preferred_order=function | Prioritizes placement of functions. | |
--strict_compatibility[=off|on] | Performs more conservative and rigorous compatibility checking of input object files. Default is on. | |
--trampoline_min_spacing | When trampoline reservations are spaced more closely than the specified limit, tries to make them adjacent. | |
--unused_section_elimination[=off|on] | Eliminates sections that are not needed in the executable module. Default is on. | |
--zero_init=[off|on] | Controls preinitialization of uninitialized variables. Default is on. Always off if --ram_model is used. |
Following are detailed descriptions of options that you will probably use frequently:
--c_src_interlist | Invokes the interlist feature, which interweaves original C/C++ source with compiler-generated assembly language. The interlisted C statements may appear to be out of sequence. You can use the interlist feature with the optimizer by combining the --optimizer_interlist and --c_src_interlist options. See Section 3.11. The --c_src_interlist option can have a negative performance and/or code size impact. |
--cmd_file=filename | Appends the contents of a file to the option set. You can use this option to avoid limitations on command line length or C style comments imposed by the host operating system. Use a # or ; at the beginning of a line in the command file to include comments. You can also include comments by delimiting them with /* and */. To specify options, surround hyphens with quotation marks. For example, "--"quiet.
You can use the --cmd_file option multiple times to specify multiple files. For instance, the following indicates that file3 should be compiled as source and file1 and file2 are --cmd_file files: armcl --cmd_file=file1 --cmd_file=file2 file3
|
--compile_only | Suppresses the linker and overrides the --run_linker option, which specifies linking. The --compile_only option's short form is -c. Use this option when you have --run_linker specified in the TI_ARM_C_OPTION environment variable and you do not want to link. See Section 4.1.3. |
--define=name[=def] | Predefines the constant name for the preprocessor. This is equivalent to inserting #define name def at the top of each C source file. If the optional[=def] is omitted, the name is set to 1. The --define option's short form is -D.
If you want to define a quoted string and keep the quotation marks, do one of the following:
|
--gen_func_info_listing | Generates a user information file with a .aux file extension. The file contains linker call graph information on a per-file level. |
--help | Displays the syntax for invoking the compiler and lists available options. If the --help option is followed by another option or phrase, detailed information about the option or phrase is displayed. For example, to see information about debugging options use --help debug. |
--include_path=directory | Adds directory to the list of directories that the compiler searches for #include files. The --include_path option's short form is -I. You can use this option several times to define several directories; be sure to separate the --include_path options with spaces. If you do not specify a directory name, the preprocessor ignores the --include_path option. See Section 2.5.2.1. |
--keep_asm | Retains the assembly language output from the compiler or assembly optimizer. Normally, the compiler deletes the output assembly language file after assembly is complete. The --keep_asm option's short form is -k. |
--quiet | Suppresses banners and progress information from all the tools. Only source filenames and error messages are output. The --quiet option's short form is -q. |
--run_linker | Runs the linker on the specified object files. The --run_linker option and its parameters follow all other options on the command line. All arguments that follow --run_linker are passed to the linker. The --run_linker option's short form is -z. See Section 4.1. |
--skip_assembler | Compiles only. The specified source files are compiled but not assembled or linked. The --skip_assembler option's short form is -n. This option overrides --run_linker. The output is assembly language output from the compiler. |
--src_interlist | Invokes the interlist feature, which interweaves optimizer comments or C/C++ source with assembly source. If the optimizer is invoked (--opt_level=n option), optimizer comments are interlisted with the assembly language output of the compiler, which may rearrange code significantly. If the optimizer is not invoked, C/C++ source statements are interlisted with the assembly language output of the compiler, which allows you to inspect the code generated for each C/C++ statement. The --src_interlist option implies the --keep_asm option. The --src_interlist option's short form is -s. |
--tool_version | Prints the version number for each tool in the compiler. No compiling occurs. |
--undefine=name | Undefines the predefined constant name. This option overrides any --define options for the specified constant. The --undefine option's short form is -U. |
--verbose | Displays progress information and toolset version while compiling. Resets the --quiet option. |