| @c Copyright (C) 1988-2026 Free Software Foundation, Inc. | |
| @c This is part of the GCC manual. | |
| @c For copying conditions, see the file gcc.texi. | |
| @ignore | |
| @c man begin INCLUDE | |
| @include gcc-vers.texi | |
| @c man end | |
| @c man begin COPYRIGHT | |
| Copyright @copyright{} 1988-2026 Free Software Foundation, Inc. | |
| Permission is granted to copy, distribute and/or modify this document | |
| under the terms of the GNU Free Documentation License, Version 1.3 or | |
| any later version published by the Free Software Foundation; with the | |
| Invariant Sections being ``GNU General Public License'' and ``Funding | |
| Free Software'', the Front-Cover texts being (a) (see below), and with | |
| the Back-Cover Texts being (b) (see below). A copy of the license is | |
| included in the gfdl(7) man page. | |
| (a) The FSF's Front-Cover Text is: | |
| A GNU Manual | |
| (b) The FSF's Back-Cover Text is: | |
| You have freedom to copy and modify this GNU Manual, like GNU | |
| software. Copies published by the Free Software Foundation raise | |
| funds for GNU development. | |
| @c man end | |
| @c Set file name and title for the man page. | |
| @setfilename gcc | |
| @settitle GNU project C and C++ compiler | |
| @c man begin SYNOPSIS | |
| gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}] | |
| [@option{-g}] [@option{-pg}] [@option{-O}@var{level}] | |
| [@option{-W}@var{warn}@dots{}] [@option{-Wpedantic}] | |
| [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}] | |
| [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}] | |
| [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}] | |
| [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{} | |
| Only the most useful options are listed here; see below for the | |
| remainder. @command{g++} accepts mostly the same options as @command{gcc}. | |
| @c man end | |
| @c man begin SEEALSO | |
| gpl(7), gfdl(7), fsf-funding(7), | |
| cpp(1), gcov(1), as(1), ld(1), gdb(1) | |
| and the Info entries for @file{gcc}, @file{cpp}, @file{as}, | |
| @file{ld}, @file{binutils} and @file{gdb}. | |
| @c man end | |
| @c man begin BUGS | |
| For instructions on reporting bugs, see | |
| @w{@value{BUGURL}}. | |
| @c man end | |
| @c man begin AUTHOR | |
| See the Info entry for @command{gcc}, or | |
| @w{@uref{https://gcc.gnu.org/onlinedocs/gcc/Contributors.html}}, | |
| for contributors to GCC@. | |
| @c man end | |
| @end ignore | |
| @node Invoking GCC | |
| @chapter GCC Command Options | |
| @cindex GCC command options | |
| @cindex command options | |
| @cindex options, GCC command | |
| @c man begin DESCRIPTION | |
| When you invoke GCC, it normally does preprocessing, compilation, | |
| assembly and linking. The ``overall options'' allow you to stop this | |
| process at an intermediate stage. For example, the @option{-c} option | |
| says not to run the linker. Then the output consists of object files | |
| output by the assembler. | |
| @xref{Overall Options,,Options Controlling the Kind of Output}. | |
| Other options are passed on to one or more stages of processing. Some options | |
| control the preprocessor and others the compiler itself. Yet other | |
| options control the assembler and linker; most of these are not | |
| documented here, since you rarely need to use any of them. | |
| @cindex C compilation options | |
| Most of the command-line options that you can use with GCC are useful | |
| for C programs; when an option is only useful with another language | |
| (usually C++), the explanation says so explicitly. If the description | |
| for a particular option does not mention a source language, you can use | |
| that option with all supported languages. | |
| @cindex cross compiling | |
| @cindex specifying machine version | |
| @cindex specifying compiler version and target machine | |
| @cindex compiler version, specifying | |
| @cindex target machine, specifying | |
| The usual way to run GCC is to run the executable called @command{gcc}, or | |
| @command{@var{machine}-gcc} when cross-compiling, or | |
| @command{@var{machine}-gcc-@var{version}} to run a specific version of GCC. | |
| When you compile C++ programs, you should invoke GCC as @command{g++} | |
| instead. @xref{Invoking G++,,Compiling C++ Programs}, | |
| for information about the differences in behavior between @command{gcc} | |
| and @command{g++} when compiling C++ programs. | |
| @cindex grouping options | |
| @cindex options, grouping | |
| The @command{gcc} program accepts options and file names as operands. Many | |
| options have multi-letter names; therefore multiple single-letter options | |
| may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d | |
| -v}}. | |
| @cindex order of options | |
| @cindex options, order | |
| You can mix options and other arguments. For the most part, the order | |
| you use doesn't matter. Order does matter when you use several | |
| options of the same kind; for example, if you specify @option{-L} more | |
| than once, the directories are searched in the order specified. Also, | |
| the placement of the @option{-l} option is significant. | |
| Many options have long names starting with @samp{-f} or with | |
| @samp{-W}---for example, | |
| @option{-fmove-loop-invariants}, @option{-Wformat} and so on. Most of | |
| these have both positive and negative forms; the negative form of | |
| @option{-ffoo} is @option{-fno-foo}. This manual documents | |
| only one of these two forms, whichever one is not the default. | |
| Some options take one or more arguments typically separated either | |
| by a space or by the equals sign (@samp{=}) from the option name. | |
| Unless documented otherwise, an argument can be either numeric or | |
| a string. Numeric arguments must typically be small unsigned decimal | |
| or hexadecimal integers. Hexadecimal arguments must begin with | |
| the @samp{0x} prefix. Arguments to options that specify a size | |
| threshold of some sort may be arbitrarily large decimal or hexadecimal | |
| integers followed by a byte size suffix designating a multiple of bytes | |
| such as @code{kB} and @code{KiB} for kilobyte and kibibyte, respectively, | |
| @code{MB} and @code{MiB} for megabyte and mebibyte, @code{GB} and | |
| @code{GiB} for gigabyte and gigibyte, and so on. Such arguments are | |
| designated by @var{byte-size} in the following text. Refer to the NIST, | |
| IEC, and other relevant national and international standards for the full | |
| listing and explanation of the binary and decimal byte size prefixes. | |
| @c man end | |
| @xref{Option Index}, for an index to GCC's options. | |
| @menu | |
| * Option Summary:: Brief list of all options, without explanations. | |
| * Overall Options:: Controlling the kind of output: | |
| an executable, object files, assembler files, | |
| or preprocessed source. | |
| * Invoking G++:: Compiling C++ programs. | |
| * C Dialect Options:: Controlling the variant of C language compiled. | |
| * C++ Dialect Options:: Variations on C++. | |
| * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C | |
| and Objective-C++. | |
| * OpenMP and OpenACC Options:: Controlling multiprocessing and offloading. | |
| * Diagnostic Message Formatting Options:: Controlling how diagnostics should | |
| be formatted. | |
| * Warning Options:: How picky should the compiler be? | |
| * Static Analyzer Options:: More expensive warnings. | |
| * Debugging Options:: Producing debuggable code. | |
| * Optimize Options:: How much optimization? | |
| * Instrumentation Options:: Enabling profiling and extra run-time error checking. | |
| * Preprocessor Options:: Controlling header files and macro definitions. | |
| Also, getting dependency information for Make. | |
| * Assembler Options:: Passing options to the assembler. | |
| * Link Options:: Specifying libraries and so on. | |
| * Directory Options:: Where to find header files and libraries. | |
| Where to find the compiler executable files. | |
| * Code Gen Options:: Specifying conventions for function calls, data layout | |
| and register usage. | |
| * Developer Options:: Printing GCC configuration info, statistics, and | |
| debugging dumps. | |
| * Target-Specific Options:: Options specific to particular architectures or | |
| runtime environments. | |
| * Environment Variables:: Env vars that affect GCC. | |
| * Precompiled Headers:: Compiling a header once, and using it many times. | |
| * C++ Modules:: Experimental C++20 module system. | |
| @end menu | |
| @c man begin OPTIONS | |
| @node Option Summary | |
| @section Option Summary | |
| Here is a summary of all the options, grouped by type. Explanations are | |
| in the following sections. | |
| @table @emph | |
| @item Overall Options | |
| @xref{Overall Options,,Options Controlling the Kind of Output}. | |
| @gccoptlist{-c -S -E -o @var{file} | |
| -dumpbase @var{dumpbase} -dumpbase-ext @var{auxdropsuf} | |
| -dumpdir @var{dumppfx} -x @var{language} | |
| -v -### --help@r{[}=@var{class}@r{[},@dots{}@r{]]} --target-help --version | |
| -pass-exit-codes -pipe -wrapper | |
| @@@var{file} -ffile-prefix-map=@var{old}=@var{new} -fcanon-prefix-map | |
| -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg} | |
| -fdump-ada-spec@r{[}-slim@r{]} -fada-spec-parent=@var{unit} | |
| -fdump-go-spec=@var{file} | |
| --assemble --compile --dumpbase @var{dumpbase} | |
| --dumpbase-ext @var{auxdropsuf} --dumpdir @var{dumppfx} | |
| --language=@var{language} --output=@var{file} --pass-exit-codes | |
| --pipe --preprocess --verbose} | |
| @item C Language Options | |
| @xref{C Dialect Options,,Options Controlling C Dialect}. | |
| @gccoptlist{-ansi --ansi -std=@var{standard} -aux-info @var{filename} | |
| -fno-asm -fno-builtin -fno-builtin-@var{function} -fcond-mismatch | |
| -fdeps-file=@var{file} -fdeps-format=@var{format} -fdeps-target=@var{file} | |
| -ffreestanding -fgimple -fgnu-tm -fgnu89-inline -fhosted | |
| -flax-vector-conversions -fms-extensions | |
| -fpermitted-flt-eval-methods=@var{standard} | |
| -fplan9-extensions -fsigned-bitfields -funsigned-bitfields | |
| -fsigned-char -funsigned-char -fsso-struct=@var{endianness} | |
| -fstrict-flex-arrays[=@var{n}]} | |
| @item C++ Language Options | |
| @xref{C++ Dialect Options,,Options Controlling C++ Dialect}. | |
| @gccoptlist{--compile-std-module | |
| -fabi-compat-version=@var{n} -fabi-version=@var{n} | |
| -fno-access-control -faligned-new=@r{[}@var{n}@r{]} | |
| -fno-assume-sane-operators-new-delete | |
| -fchar8_t -fcheck-new | |
| -fconcepts -fconcepts-diagnostics-depth=@var{n} | |
| -fconstexpr-depth=@var{n} -fconstexpr-cache-depth=@var{n} | |
| -fconstexpr-loop-limit=@var{n} -fconstexpr-ops-limit=@var{n} | |
| -fcontracts | |
| -fcontract-evaluation-semantic=@r{[}ignore@r{|}observe@r{|}enforce@r{|}quick_enforce@r{]} | |
| -fcontracts-conservative-ipa -fcontract-checks-outlined | |
| -fcontract-disable-optimized-checks | |
| -fcontracts-client-check=@r{[}none@r{|}pre@r{|}all@r{]} | |
| -fcontracts-definition-check=@r{[}on@r{|}off@r{]} | |
| -fcoroutines -fdiagnostics-all-candidates | |
| -fno-elide-constructors | |
| -fno-enforce-eh-specs | |
| -fext-numeric-literals | |
| -fno-gnu-keywords | |
| -fno-immediate-escalation | |
| -fno-implement-inlines | |
| -fimplicit-constexpr | |
| -fno-implicit-inline-templates | |
| -fno-implicit-templates | |
| -fmodule-header@r{[}=@var{kind}@r{]} | |
| -fmodule-implicit-inline | |
| -fno-module-include-translate | |
| -fno-module-lazy | |
| -fmodule-mapper=@var{specification} | |
| -fmodule-only | |
| -fmodules | |
| -fms-extensions | |
| -fnew-inheriting-ctors | |
| -fnew-ttp-matching | |
| -fno-nonansi-builtins -fnothrow-opt -fno-operator-names | |
| -fno-optional-diags | |
| -fno-pretty-templates -frange-for-ext-temps -freflection | |
| -fno-rtti -fsized-deallocation | |
| -fstrict-enums -fstrong-eval-order@r{[}=@var{kind}@r{]} | |
| -ftemplate-backtrace-limit=@var{n} | |
| -ftemplate-depth=@var{n} | |
| -fno-threadsafe-statics -fuse-cxa-atexit -fno-use-cxa-get-exception-ptr | |
| -fno-weak -nostdinc++ | |
| -fvisibility-inlines-hidden | |
| -fvisibility-ms-compat | |
| -flang-info-include-translate@r{[}=@var{header}@r{]} | |
| -flang-info-include-translate-not | |
| -flang-info-module-cmi@r{[}=@var{module}@r{]} | |
| -stdlib=@var{libstdc++,libc++} | |
| -Wabbreviated-auto-in-template-arg | |
| -Wabi-tag -Waligned-new@r{[}=@var{kind}@r{]} | |
| -Wcatch-value -Wcatch-value=@var{n} | |
| -Wno-class-conversion -Wclass-memaccess | |
| -Wcomma-subscript -Wconditionally-supported | |
| -Wno-conversion-null -Wctad-maybe-unsupported | |
| -Wctor-dtor-privacy -Wdangling-reference | |
| -Wno-defaulted-function-deleted | |
| -Wno-delete-incomplete | |
| -Wdelete-non-virtual-dtor -Wno-deprecated-array-compare | |
| -Wdeprecated-copy -Wdeprecated-copy-dtor | |
| -Wno-deprecated-enum-enum-conversion -Wno-deprecated-enum-float-conversion | |
| -Wno-deprecated-literal-operator -Wdeprecated-variadic-comma-omission | |
| -Weffc++ -Wno-elaborated-enum-base | |
| -Wno-exceptions -Wno-expose-global-module-tu-local -Wno-external-tu-local | |
| -Wextra-semi -Wno-global-module -Wno-inaccessible-base | |
| -Wno-inherited-variadic-ctor -Wno-init-list-lifetime | |
| -Winvalid-constexpr -Winvalid-imported-macros | |
| -Wno-invalid-offsetof -Wno-invalid-specialization -Wno-literal-suffix | |
| -Wmismatched-new-delete -Wmismatched-tags | |
| -Wmultiple-inheritance -Wnamespaces -Wnarrowing | |
| -Wnoexcept -Wnoexcept-type -Wnon-virtual-dtor | |
| -Wpessimizing-move -Wno-placement-new -Wplacement-new=@var{n} | |
| -Wrange-loop-construct -Wredundant-move -Wredundant-tags | |
| -Wreorder -Wregister -Wno-sfinae-incomplete | |
| -Wstrict-null-sentinel -Wno-subobject-linkage -Wtemplates | |
| -Wno-non-c-typedef-for-linkage -Wno-non-template-friend -Wold-style-cast | |
| -Woverloaded-virtual -Wno-pmf-conversions -Wself-move -Wsign-promo | |
| -Wsized-deallocation -Wsuggest-final-methods | |
| -Wsuggest-final-types -Wsuggest-override -Wno-template-body | |
| -Wno-template-id-cdtor -Wtemplate-names-tu-local | |
| -Wno-terminate -Wno-vexing-parse -Wvirtual-inheritance | |
| -Wno-virtual-move-assign -Wvolatile} | |
| @item Objective-C and Objective-C++ Language Options | |
| @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling | |
| Objective-C and Objective-C++ Dialects}. | |
| @gccoptlist{-fconstant-string-class=@var{class-name} | |
| -fgnu-runtime -fnext-runtime | |
| -fno-nil-receivers | |
| -fobjc-abi-version=@var{n} | |
| -fobjc-call-cxx-cdtors | |
| -fobjc-direct-dispatch | |
| -fobjc-exceptions | |
| -fobjc-gc | |
| -fobjc-nilcheck | |
| -fobjc-std=objc1 | |
| -fno-local-ivars | |
| -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} | |
| -freplace-objc-classes | |
| -fzero-link | |
| -gen-decls | |
| -Wassign-intercept -Wno-property-assign-default | |
| -Wno-protocol -Wobjc-root-class -Wselector | |
| -Wstrict-selector-match | |
| -Wundeclared-selector} | |
| @item OpenMP and OpenACC Options | |
| @xref{OpenMP and OpenACC Options,,Options Controlling OpenMP and OpenACC}. | |
| @gccoptlist{-foffload=@var{arg} -foffload-options=@var{arg} | |
| -fopenacc -fopenacc-dim=@var{geom} | |
| -fopenmp -fopenmp-simd -fopenmp-ompt@r{[}=@var{level}@r{]} | |
| -fopenmp-target-simd-clone@r{[}=@var{device-type}@r{]}} | |
| @item Diagnostic Message Formatting Options | |
| @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}. | |
| @gccoptlist{-fmessage-length=@var{n} | |
| -fdiagnostics-plain-output | |
| -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]} | |
| -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]} | |
| -fdiagnostics-urls=@r{[}auto@r{|}never@r{|}always@r{]} | |
| -fdiagnostics-format=@r{[}text@r{|}sarif-stderr@r{|}sarif-file@r{]} | |
| -fdiagnostics-add-output=@var{DIAGNOSTICS-OUTPUT-SPEC} | |
| -fdiagnostics-set-output=@var{DIAGNOSTICS-OUTPUT-SPEC} | |
| -fno-diagnostics-json-formatting | |
| -fno-diagnostics-show-option -fno-diagnostics-show-caret | |
| -fno-diagnostics-show-event-links | |
| -fno-diagnostics-show-labels -fno-diagnostics-show-line-numbers | |
| -fno-diagnostics-show-cwe | |
| -fno-diagnostics-show-rules | |
| -fno-diagnostics-show-highlight-colors | |
| -fno-diagnostics-show-nesting | |
| -fno-diagnostics-show-nesting-locations | |
| -fdiagnostics-show-nesting-levels | |
| -fdiagnostics-minimum-margin-width=@var{width} | |
| -fdiagnostics-parseable-fixits -fdiagnostics-generate-patch | |
| -fdiagnostics-show-template-tree -fno-elide-type | |
| -fdiagnostics-path-format=@r{[}none@r{|}separate-events@r{|}inline-events@r{]} | |
| -fdiagnostics-show-path-depths | |
| -fno-show-column | |
| -fdiagnostics-column-unit=@r{[}display@r{|}byte@r{]} | |
| -fdiagnostics-column-origin=@var{origin} | |
| -fdiagnostics-escape-format=@r{[}unicode@r{|}bytes@r{]} | |
| -fdiagnostics-text-art-charset=@r{[}none@r{|}ascii@r{|}unicode@r{|}emoji@r{]} | |
| -fdiagnostics-show-context@r{[}=@var{depth}@r{]}} | |
| @item Warning Options | |
| @xref{Warning Options,,Options to Request or Suppress Warnings}. | |
| @gccoptlist{-fsyntax-only -fmax-errors=@var{n} -Wpedantic | |
| -pedantic-errors -fpermissive | |
| -w -Wextra -Wall -Wabi=@var{n} | |
| -Waddress -Wno-address-of-packed-member -Waggregate-return | |
| -Walloc-size -Walloc-size-larger-than=@var{byte-size} -Walloc-zero | |
| -Walloca -Walloca-larger-than=@var{byte-size} -Wauto-profile | |
| -Wno-aggressive-loop-optimizations | |
| -Warith-conversion | |
| -Warray-bounds -Warray-bounds=@var{n} -Warray-compare | |
| -Warray-parameter -Warray-parameter=@var{n} | |
| -Wno-attributes -Wattribute-alias=@var{n} -Wno-attribute-alias | |
| -Wno-attribute-warning | |
| -Wbidi-chars=@r{[}none@r{|}unpaired@r{|}any@r{|}ucn@r{]} | |
| -Wbool-compare -Wbool-operation | |
| -Wno-builtin-declaration-mismatch | |
| -Wno-builtin-macro-redefined -Wc90-c99-compat -Wc99-c11-compat | |
| -Wc11-c23-compat -Wc23-c2y-compat | |
| -Wc++-compat -Wc++11-compat -Wc++14-compat -Wc++17-compat | |
| -Wc++20-compat -Wc++26-compat | |
| -Wno-c++11-extensions -Wno-c++14-extensions -Wno-c++17-extensions | |
| -Wno-c++20-extensions -Wno-c++23-extensions | |
| -Wcalloc-transposed-args -Wcannot-profile | |
| -Wcast-align -Wcast-align=strict -Wcast-function-type -Wcast-qual | |
| -Wchar-subscripts | |
| -Wclobbered -Wcomment | |
| -Wcompare-distinct-pointer-types | |
| -Wno-complain-wrong-lang -Wconstant-logical-operand | |
| -Wconversion -Wno-coverage-mismatch -Wno-cpp | |
| -Wdangling-else -Wdangling-pointer -Wdangling-pointer=@var{n} | |
| -Wdate-time | |
| -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init | |
| -Wno-deprecated-openmp | |
| -Wdisabled-optimization | |
| -Wno-discarded-array-qualifiers -Wno-discarded-qualifiers | |
| -Wno-div-by-zero -Wdouble-promotion | |
| -Wduplicated-branches -Wduplicated-cond | |
| -Wempty-body -Wno-endif-labels -Wenum-compare -Wenum-conversion | |
| -Wenum-int-mismatch | |
| -Werror -Werror=* -Wexpansion-to-defined -Wfatal-errors | |
| -Wflex-array-member-not-at-end | |
| -Wfloat-conversion -Wfloat-equal -Wformat -Wformat=2 | |
| -Wno-format-contains-nul -Wno-format-diag -Wno-format-extra-args | |
| -Wformat-nonliteral -Wformat-overflow=@var{n} | |
| -Wformat-security -Wformat-signedness -Wformat-truncation=@var{n} | |
| -Wformat-y2k -Wframe-address | |
| -Wframe-larger-than=@var{byte-size} -Wno-free-nonheap-object | |
| -Wheader-guard -Wno-if-not-aligned -Wno-ignored-attributes | |
| -Wignored-qualifiers -Wno-incompatible-pointer-types -Whardened | |
| -Wimplicit -Wimplicit-fallthrough -Wimplicit-fallthrough=@var{n} | |
| -Wno-implicit-function-declaration -Wno-implicit-int | |
| -Winfinite-recursion | |
| -Winit-self -Winline -Wno-int-conversion -Wint-in-bool-context | |
| -Wno-int-to-pointer-cast -Wno-invalid-memory-model | |
| -Winvalid-pch -Winvalid-utf8 -Wno-unicode -Wjump-misses-init | |
| -Wkeyword-macro | |
| -Wlarger-than=@var{byte-size} -Wleading-whitespace=@var{kind} | |
| -Wlogical-not-parentheses -Wlogical-op | |
| -Wlong-long -Wno-lto-type-mismatch -Wmain -Wmaybe-uninitialized | |
| -Wmemset-elt-size -Wmemset-transposed-args | |
| -Wmisleading-indentation -Wmissing-attributes -Wmissing-braces | |
| -Wmissing-field-initializers -Wmissing-format-attribute | |
| -Wmissing-include-dirs -Wmissing-noreturn -Wmusttail-local-addr | |
| -Wmaybe-musttail-local-addr -Wno-missing-profile | |
| -Wno-multichar -Wmultistatement-macros -Wnonnull -Wnonnull-compare | |
| -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} | |
| -Wnull-dereference -Wno-odr | |
| -Wopenacc-parallelism | |
| -Wopenmp -Wopenmp-simd | |
| -Wno-overflow -Woverlength-strings -Wno-override-init-side-effects | |
| -Wpacked -Wno-packed-bitfield-compat -Wpacked-not-aligned -Wpadded | |
| -Wparentheses -Wno-pedantic-ms-format | |
| -Wpointer-arith -Wno-pointer-compare -Wno-pointer-to-int-cast | |
| -Wno-pragmas -Wno-pragma-once-outside-header -Wno-prio-ctor-dtor | |
| -Wno-psabi | |
| -Wredundant-decls -Wrestrict | |
| -Wno-return-local-addr -Wreturn-type | |
| -Wno-scalar-storage-order -Wsequence-point | |
| -Wshadow -Wshadow=global -Wshadow=local -Wshadow=compatible-local | |
| -Wno-shadow-ivar | |
| -Wno-shift-count-negative -Wno-shift-count-overflow | |
| -Wshift-negative-value -Wno-shift-overflow -Wshift-overflow=@var{n} | |
| -Wsign-compare -Wsign-conversion | |
| -Wno-sizeof-array-argument | |
| -Wsizeof-array-div | |
| -Wsizeof-pointer-div -Wsizeof-pointer-memaccess | |
| -Wstack-protector -Wstack-usage=@var{byte-size} -Wstrict-aliasing | |
| -Wstrict-aliasing=@var{n} | |
| -Wstring-compare | |
| -Wno-stringop-overflow -Wno-stringop-overread | |
| -Wno-stringop-truncation -Wstrict-flex-arrays | |
| -Wsuggest-attribute=@var{attribute-name} | |
| -Wswitch -Wno-switch-bool -Wswitch-default -Wswitch-enum | |
| -Wno-switch-outside-range -Wno-switch-unreachable -Wsync-nand | |
| -Wsystem-headers -Wtautological-compare -Wtrailing-whitespace | |
| -Wtrailing-whitespace=@var{kind} -Wtrampolines -Wtrigraphs | |
| -Wtrivial-auto-var-init -Wno-tsan -Wtype-limits -Wundef | |
| -Wuninitialized -Wunknown-pragmas | |
| -Wunsuffixed-float-constants | |
| -Wunterminated-string-initialization | |
| -Wunused | |
| -Wunused-but-set-parameter -Wunused-but-set-parameter=@var{n} | |
| -Wunused-but-set-variable -Wunused-but-set-variable=@var{n} | |
| -Wunused-const-variable -Wunused-const-variable=@var{n} | |
| -Wunused-function -Wunused-label -Wunused-local-typedefs | |
| -Wunused-macros | |
| -Wunused-parameter -Wno-unused-result | |
| -Wunused-value -Wunused-variable | |
| -Wuse-after-free -Wuse-after-free=@var{n} -Wuseless-cast | |
| -Wno-varargs -Wvariadic-macros | |
| -Wvector-operation-performance | |
| -Wvla -Wvla-larger-than=@var{byte-size} -Wno-vla-larger-than | |
| -Wvolatile-register-var -Wwrite-strings | |
| -Wno-xor-used-as-pow | |
| -Wzero-as-null-pointer-constant | |
| -Wzero-length-bounds | |
| -Wzero-init-padding-bits=@var{value} | |
| --all-warnings --extra-warnings --no-warnings | |
| --pedantic --pedantic-errors} | |
| @item Static Analyzer Options | |
| @gccoptlist{ | |
| -fanalyzer | |
| -fanalyzer-assume-nothrow | |
| -fanalyzer-call-summaries | |
| -fanalyzer-checker=@var{name} | |
| -fno-analyzer-feasibility | |
| -fanalyzer-show-events-in-system-headers | |
| -fno-analyzer-state-merge | |
| -fno-analyzer-state-purge | |
| -fno-analyzer-suppress-followups | |
| -fanalyzer-transitivity | |
| -fno-analyzer-undo-inlining | |
| -fanalyzer-verbose-edges | |
| -fanalyzer-verbose-state-changes | |
| -fanalyzer-verbosity=@var{level} | |
| -fdump-analyzer | |
| -fdump-analyzer-callgraph | |
| -fdump-analyzer-exploded-graph | |
| -fdump-analyzer-exploded-nodes | |
| -fdump-analyzer-exploded-nodes-2 | |
| -fdump-analyzer-exploded-nodes-3 | |
| -fdump-analyzer-exploded-paths | |
| -fdump-analyzer-feasibility | |
| -fdump-analyzer-infinite-loop | |
| -fdump-analyzer-json | |
| -fdump-analyzer-state-purge | |
| -fdump-analyzer-stderr | |
| -fdump-analyzer-supergraph | |
| -fdump-analyzer-untracked | |
| -Wno-analyzer-double-fclose | |
| -Wno-analyzer-double-free | |
| -Wno-analyzer-exposure-through-output-file | |
| -Wno-analyzer-exposure-through-uninit-copy | |
| -Wno-analyzer-fd-access-mode-mismatch | |
| -Wno-analyzer-fd-double-close | |
| -Wno-analyzer-fd-leak | |
| -Wno-analyzer-fd-phase-mismatch | |
| -Wno-analyzer-fd-type-mismatch | |
| -Wno-analyzer-fd-use-after-close | |
| -Wno-analyzer-fd-use-without-check | |
| -Wno-analyzer-file-leak | |
| -Wno-analyzer-free-of-non-heap | |
| -Wno-analyzer-imprecise-fp-arithmetic | |
| -Wno-analyzer-infinite-loop | |
| -Wno-analyzer-infinite-recursion | |
| -Wno-analyzer-jump-through-null | |
| -Wno-analyzer-malloc-leak | |
| -Wno-analyzer-mismatching-deallocation | |
| -Wno-analyzer-mkostemp-redundant-flags | |
| -Wno-analyzer-mktemp-missing-placeholder | |
| -Wno-analyzer-mktemp-of-string-literal | |
| -Wno-analyzer-null-argument | |
| -Wno-analyzer-null-dereference | |
| -Wno-analyzer-out-of-bounds | |
| -Wno-analyzer-overlapping-buffers | |
| -Wno-analyzer-possible-null-argument | |
| -Wno-analyzer-possible-null-dereference | |
| -Wno-analyzer-putenv-of-auto-var | |
| -Wno-analyzer-shift-count-negative | |
| -Wno-analyzer-shift-count-overflow | |
| -Wno-analyzer-stale-setjmp-buffer | |
| -Wno-analyzer-tainted-allocation-size | |
| -Wno-analyzer-tainted-assertion | |
| -Wno-analyzer-tainted-array-index | |
| -Wno-analyzer-tainted-divisor | |
| -Wno-analyzer-tainted-offset | |
| -Wno-analyzer-tainted-size | |
| -Wno-analyzer-throw-of-unexpected-type | |
| -Wanalyzer-symbol-too-complex | |
| -Wanalyzer-too-complex | |
| -Wno-analyzer-undefined-behavior-ptrdiff | |
| -Wno-analyzer-undefined-behavior-strtok | |
| -Wno-analyzer-unsafe-call-within-signal-handler | |
| -Wno-analyzer-use-after-free | |
| -Wno-analyzer-use-of-pointer-in-stale-stack-frame | |
| -Wno-analyzer-use-of-uninitialized-value | |
| -Wno-analyzer-va-arg-type-mismatch | |
| -Wno-analyzer-va-list-exhausted | |
| -Wno-analyzer-va-list-leak | |
| -Wno-analyzer-va-list-use-after-va-end | |
| -Wno-analyzer-write-to-const | |
| -Wno-analyzer-write-to-string-literal | |
| } | |
| @item C and Objective-C-only Warning Options | |
| @gccoptlist{-Wbad-function-cast -Wdeprecated-non-prototype -Wfree-labels | |
| -Wmissing-declarations -Wmissing-parameter-name -Wmissing-parameter-type | |
| -Wdeclaration-missing-parameter-type -Wmissing-prototypes | |
| -Wmissing-variable-declarations | |
| -Wmultiple-parameter-fwd-decl-lists | |
| -Wnested-externs -Wold-style-declaration | |
| -Wold-style-definition -Wstrict-prototypes -Wtraditional | |
| -Wtraditional-conversion -Wdeclaration-after-statement -Wpointer-sign} | |
| @item Debugging Options | |
| @xref{Debugging Options,,Options for Debugging Your Program}. | |
| @gccoptlist{-g -g@var{level} -gdwarf -gdwarf-@var{version} | |
| -gbtf -gctf -gctf@var{level} | |
| -gno-prune-btf -ggdb -gno-record-gcc-switches | |
| -gstrict-dwarf -gas-loc-support -gas-locview-support | |
| -gcodeview -gcolumn-info -gdwarf32 -gdwarf64 | |
| -gno-statement-frontiers | |
| -gno-variable-location-views -gvariable-location-views=incompat5 | |
| -ginternal-reset-location-views -ginline-points | |
| -gvms -gz@r{[}=@var{type}@r{]} | |
| -gsplit-dwarf -gdescribe-dies | |
| -fdebug-prefix-map=@var{old}=@var{new} -fdebug-types-section | |
| -fno-eliminate-unused-debug-types | |
| -femit-struct-debug-baseonly -femit-struct-debug-reduced | |
| -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} | |
| -fno-eliminate-unused-debug-symbols -femit-class-debug-always | |
| -fno-merge-debug-strings -fno-dwarf2-cfi-asm | |
| -fvar-tracking -fvar-tracking-assignments -fvar-tracking-uninit | |
| --debug} | |
| @item Optimization Options | |
| @xref{Optimize Options,,Options that Control Optimization}. | |
| @gccoptlist{-faggressive-loop-optimizations | |
| -falign-functions[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] | |
| -falign-jumps[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] | |
| -falign-labels[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] | |
| -falign-loops[=@var{n}[:@var{m}:[@var{n2}[:@var{m2}]]]] | |
| -fmin-function-alignment=[@var{n}] | |
| -fno-allocation-dce -fallow-store-data-races | |
| -fassociative-math -fauto-profile -fauto-profile[=@var{path}] | |
| -fauto-profile-inlining -fauto-inc-dec -fbranch-probabilities | |
| -fcaller-saves | |
| -fcombine-stack-adjustments -fconserve-stack | |
| -ffold-mem-offsets | |
| -fcompare-elim -fcprop-registers -fcrossjumping | |
| -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules | |
| -fcx-limited-range -fcx-method | |
| -fdata-sections -fdce -fdelayed-branch | |
| -fdelete-null-pointer-checks -fdep-fusion -fdevirtualize | |
| -fdevirtualize-speculatively -fdevirtualize-at-ltrans -fdse | |
| -fduplicate-switch-dispatch | |
| -fearly-inlining -fexcess-precision=@var{style} | |
| -fexpensive-optimizations -fext-dce | |
| -ffast-math -ffat-lto-objects -ffinite-loops | |
| -ffinite-math-only -ffloat-store | |
| -fforward-propagate -ffp-contract=@var{style} -ffp-int-builtin-inexact | |
| -ffunction-sections -ffuse-ops-with-volatile-access | |
| -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity | |
| -fgcse-sm -fhoist-adjacent-loads -fif-conversion | |
| -fif-conversion2 -findirect-inlining | |
| -finline-atomics -finline-functions -finline-functions-called-once | |
| -finline-limit=@var{n} -finline-small-functions | |
| -finline-stringops@r{[}=@var{fn}@r{]} | |
| -fipa-modref -fipa-cp -fipa-cp-clone | |
| -fipa-bit-cp -fipa-vrp -fipa-pta -fipa-profile -fipa-pure-const | |
| -fipa-reference -fipa-reference-addressable -fipa-reorder-for-locality | |
| -fipa-sra -fipa-stack-alignment | |
| -fipa-icf -fipa-icf-functions -fipa-icf-variables | |
| -fira-algorithm=@var{algorithm} | |
| -flate-combine-instructions -flifetime-dse -flive-patching=@var{level} | |
| -fira-region=@var{region} -fira-hoist-pressure | |
| -fira-loop-pressure -fno-ira-share-save-slots | |
| -fno-ira-share-spill-slots | |
| -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute | |
| -fivopts -fkeep-inline-functions -fkeep-static-functions | |
| -fkeep-static-consts -flimit-function-alignment -flive-range-shrinkage | |
| -floop-block -floop-interchange -floop-strip-mine | |
| -floop-unroll-and-jam -floop-nest-optimize | |
| -floop-parallelize-all -flra-remat -flto -flto-compression-level=@var{n} | |
| -flto-toplevel-asm-heuristics | |
| -flto-partition=@var{alg} -flto-incremental=@var{path} | |
| -flto-incremental-cache-size=@var{n} -fmalloc-dce -fmerge-all-constants | |
| -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves | |
| -fmove-loop-invariants -fmove-loop-stores -fno-branch-count-reg | |
| -fno-defer-pop -fno-function-cse | |
| -fno-guess-branch-probability -fno-inline -fno-math-errno -fno-peephole | |
| -fno-peephole2 -fno-printf-return-value -fno-sched-interblock | |
| -fno-sched-spec -fno-signed-zeros | |
| -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss | |
| -fomit-frame-pointer -foptimize-crc -foptimize-sibling-calls | |
| -fpartial-inlining -fpeel-loops -fpredictive-commoning | |
| -fprefetch-loop-arrays | |
| -fprofile-correction | |
| -fprofile-use -fprofile-use=@var{path} -fprofile-partial-training | |
| -fprofile-values -fprofile-reorder-functions | |
| -freciprocal-math -free -frename-registers -freorder-blocks | |
| -freorder-blocks-algorithm=@var{algorithm} | |
| -freorder-blocks-and-partition -freorder-functions | |
| -frerun-cse-after-loop -freschedule-modulo-scheduled-loops | |
| -frounding-math -fsave-optimization-record | |
| -fsched2-use-superblocks -fsched-pressure | |
| -fsched-spec-load -fsched-spec-load-dangerous | |
| -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] | |
| -fsched-group-heuristic -fsched-critical-path-heuristic | |
| -fsched-spec-insn-heuristic -fsched-rank-heuristic | |
| -fsched-last-insn-heuristic -fsched-dep-count-heuristic | |
| -fschedule-fusion | |
| -fschedule-insns -fschedule-insns2 -fsection-anchors | |
| -fselective-scheduling -fselective-scheduling2 | |
| -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops | |
| -fsemantic-interposition -fshrink-wrap -fshrink-wrap-separate | |
| -fsignaling-nans | |
| -fsingle-precision-constant -fsplit-ivs-in-unroller -fsplit-loops | |
| -fspeculatively-call-stored-functions | |
| -fsplit-wide-types -fsplit-wide-types-early -fssa-backprop -fssa-phiopt | |
| -fstdarg-opt -fstore-merging -fstrict-aliasing -fipa-strict-aliasing | |
| -fthread-jumps -ftracer -ftree-bit-ccp | |
| -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-coalesce-vars | |
| -ftree-copy-prop -ftree-cselim -ftree-dce -ftree-dominator-opts | |
| -ftree-dse -ftree-forwprop -ftree-fre -fcode-hoisting -ftree-loop-im | |
| -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns | |
| -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize | |
| -ftree-loop-vectorize | |
| -ftree-parallelize-loops[=@var{n}] -ftree-pre -ftree-partial-pre -ftree-pta | |
| -ftree-reassoc -ftree-scev-cprop -ftree-sink -ftree-slsr -ftree-sra | |
| -ftree-switch-conversion -ftree-tail-merge | |
| -ftree-ter -ftree-vectorize -ftree-vrp -ftrivial-auto-var-init | |
| -funconstrained-commons -funit-at-a-time -funroll-all-loops | |
| -funroll-loops -funsafe-math-optimizations -funswitch-loops | |
| -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt | |
| -fweb -fwhole-program -fwpa -fuse-linker-plugin -fzero-call-used-regs | |
| -O -O0 -O1 -O2 -O3 -Os -Ofast -Og -Oz --optimize} | |
| @item Program Instrumentation Options | |
| @xref{Instrumentation Options,,Program Instrumentation Options}. | |
| @gccoptlist{-p -pg -fprofile-arcs -coverage -ftest-coverage | |
| -fcondition-coverage | |
| -fpath-coverage | |
| -fprofile -fprofile-abs-path | |
| -fprofile-dir=@var{path} -fprofile-generate -fprofile-generate=@var{path} | |
| -fprofile-info-section -fprofile-info-section=@var{name} | |
| -fprofile-note=@var{path} -fprofile-prefix-path=@var{path} | |
| -fprofile-update=@var{method} -fprofile-filter-files=@var{regex} | |
| -fprofile-exclude-files=@var{regex} | |
| -fprofile-reproducible=@r{[}multithreaded@r{|}parallel-runs@r{|}serial@r{]} | |
| -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} | |
| -fsanitize-trap -fsanitize-trap=@var{style} | |
| -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... | |
| -fsanitize-undefined-trap-on-error -fcf-protection | |
| -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{|}check@r{]} | |
| -fharden-compares -fharden-conditional-branches -fhardened | |
| -fharden-control-flow-redundancy -fhardcfr-skip-leaf | |
| -fhardcfr-check-exceptions -fhardcfr-check-returning-calls | |
| -fhardcfr-check-noreturn-calls=@r{[}always@r{|}no-xthrow@r{|}nothrow@r{|}never@r{]} | |
| -fstack-protector -fstack-protector-all -fstack-protector-strong | |
| -fstack-protector-explicit -fstack-check | |
| -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} | |
| -fno-stack-limit -fsplit-stack | |
| -fstrub=disable -fstrub=strict -fstrub=relaxed | |
| -fstrub=all -fstrub=at-calls -fstrub=internal | |
| -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} | |
| -fvtv-counts -fvtv-debug | |
| -finstrument-functions -finstrument-functions-once | |
| -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} | |
| -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} | |
| -fprofile-prefix-map=@var{old}=@var{new} | |
| -fpatchable-function-entry=@var{N}@r{[},@var{M}@r{]} | |
| --coverage --profile} | |
| @item Preprocessor Options | |
| @xref{Preprocessor Options,,Options Controlling the Preprocessor}. | |
| @gccoptlist{-C -CC -D@var{macro}@r{[}=@var{defn}@r{]} | |
| -dD -dI -dM -dN -dU | |
| -fdebug-cpp -fdirectives-only -fdollars-in-identifiers | |
| -fexec-charset=@var{charset} -fextended-identifiers | |
| -finput-charset=@var{charset} | |
| -fmacro-prefix-map=@var{old}=@var{new} -fmax-include-depth=@var{depth} | |
| -fno-canonical-system-headers -fpch-deps -fpch-preprocess | |
| -fpreprocessed -ftabstop=@var{width} -ftrack-macro-expansion | |
| -fwide-exec-charset=@var{charset} -fworking-directory | |
| -H -imacros @var{file} -include @var{file} | |
| -M -MD -MF -MG -MM -MMD -MP -MQ -MT -Mno-modules | |
| -no-integrated-cpp -P -pthread -remap | |
| -traditional -traditional-cpp -trigraphs | |
| -U@var{macro} -undef | |
| -Wp,@var{option} -Xpreprocessor @var{option} | |
| --comments --comments-in-macros | |
| --define-macro=@var{macro}@r{[}=@var{defn}@r{]} | |
| --dependencies --dump=@var{letters} | |
| --imacros=@var{file} --include=@var{file} | |
| --no-integrated-cpp --no-line-commands | |
| --print-missing-file-dependencies | |
| --traditional --traditional-cpp --trigraphs --trace-includes | |
| --undefine-macro=@var{macro} | |
| --user-dependencies --write-dependencies --write-user-dependencies | |
| } | |
| @item Assembler Options | |
| @xref{Assembler Options,,Passing Options to the Assembler}. | |
| @gccoptlist{-Wa,@var{option} -Xassembler @var{option} | |
| --for-assembler=@var{option}} | |
| @item Linker Options | |
| @xref{Link Options,,Options for Linking}. | |
| @gccoptlist{@var{object-file-name} -flink-libatomic -fuse-ld=@var{linker} -l@var{library} | |
| -nostartfiles -nodefaultlibs -nolibc -nostdlib -nostdlib++ | |
| -e @var{entry} | |
| -pie -pthread -r -rdynamic | |
| -s -static -static-pie -static-libgcc -static-libstdc++ | |
| -static-libasan -static-libhwasan -static-liblsan | |
| -static-libtsan -static-libubsan | |
| -shared -shared-libgcc -symbolic | |
| -T @var{script} -Wl,@var{option} -Xlinker @var{option} | |
| -u @var{symbol} | |
| -Tbss=@var{addr} -Tdata=@var{addr} -Ttext=@var{addr} | |
| -N -n -t -Z -z @var{keyword} | |
| --entry=@var{entry} --for-linker=@var{option} | |
| --force-link=@var{symbol} --no-standard-library | |
| --pie --static --static-pie --symbolic} | |
| @item Directory Options | |
| @xref{Directory Options,,Options for Directory Search}. | |
| @gccoptlist{-B@var{prefix} -I@var{dir} -I- | |
| -idirafter @var{dir} | |
| -imacros @var{file} -imultilib @var{dir} -imultiarch @var{dir} | |
| -iplugindir=@var{dir} -iprefix @var{file} | |
| -iquote @var{dir} -isysroot @var{dir} -isystem @var{dir} | |
| -iwithprefix @var{dir} -iwithprefixbefore @var{dir} | |
| -L@var{dir} -no-canonical-prefixes --no-sysroot-suffix | |
| -nostdinc -nostdinc++ | |
| --embed-dir=@var{dir} --embed-directory=@var{dir} | |
| --include-barrier --include-directory=@var{dir} | |
| --include-directory-after=@var{dir} --include-prefix=@var{prefix} | |
| --include-with-prefix=@var{prefix} --include-with-prefix-after=@var{prefix} | |
| --include-with-prefix-before=@var{prefix} | |
| --no-canonical-prefixes --no-standard-includes | |
| --prefix=@var{prefix} --sysroot=@var{dir}} | |
| @item Code Generation Options | |
| @xref{Code Gen Options,,Options for Code Generation Conventions}. | |
| @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} | |
| -ffixed-@var{reg} -fexceptions | |
| -fnon-call-exceptions -fdelete-dead-exceptions -funwind-tables | |
| -fasynchronous-unwind-tables | |
| -fno-gnu-unique | |
| -finhibit-size-directive -fcommon -fno-ident | |
| -fpcc-struct-return -fpic -fPIC -fpie -fPIE -fno-plt | |
| -fno-jump-tables -fno-bit-tests | |
| -frecord-gcc-switches | |
| -freg-struct-return -fshort-enums -fshort-wchar | |
| -fverbose-asm -fpack-struct[=@var{n}] | |
| -fleading-underscore -ftls-model=@var{model} | |
| -fstack-reuse=@var{reuse_level} | |
| -ftrampolines -ftrampoline-impl=@r{[}stack@r{|}heap@r{]} | |
| -ftrapv -fwrapv -fwrapv-pointer | |
| -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} | |
| -fstrict-volatile-bitfields -fsync-libcalls | |
| -fzero-init-padding-bits=@var{value} | |
| -Qy -Qn} | |
| @item Developer Options | |
| @xref{Developer Options,,GCC Developer Options}. | |
| @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion | |
| -dumpfullversion -fcallgraph-info@r{[}=su,da@r{]} | |
| -fchecking -fchecking=@var{n} | |
| -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} | |
| -fdisable-ipa-@var{pass_name} | |
| -fdisable-rtl-@var{pass_name} | |
| -fdisable-rtl-@var{pass-name}=@var{range-list} | |
| -fdisable-tree-@var{pass_name} | |
| -fdisable-tree-@var{pass-name}=@var{range-list} | |
| -fdump-debug -fdump-earlydebug | |
| -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links | |
| -fdump-final-insns@r{[}=@var{file}@r{]} | |
| -fdump-internal-locations | |
| -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline | |
| -fdump-lang-all | |
| -fdump-lang-@var{switch} | |
| -fdump-lang-@var{switch}-@var{options} | |
| -fdump-lang-@var{switch}-@var{options}=@var{filename} | |
| -fdump-passes | |
| -fdump-rtl-@var{pass} -fdump-rtl-@var{pass}=@var{filename} | |
| -fdump-statistics | |
| -fdump-tree-all | |
| -fdump-tree-@var{switch} | |
| -fdump-tree-@var{switch}-@var{options} | |
| -fdump-tree-@var{switch}-@var{options}=@var{filename} | |
| -fcompare-debug@r{[}=@var{opts}@r{]} -fcompare-debug-second | |
| -fenable-@var{kind}-@var{pass} | |
| -fenable-@var{kind}-@var{pass}=@var{range-list} | |
| -fira-verbose=@var{n} | |
| -flto-report -flto-report-wpa -fmem-report-wpa | |
| -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report | |
| -fopt-info -fopt-info-@var{options}@r{[}=@var{file}@r{]} | |
| -fmultiflags -fprofile-report | |
| -frandom-seed=@var{string} -fsched-verbose=@var{n} | |
| -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose | |
| -fstats -fstack-usage -ftime-report -ftime-report-details | |
| -fvar-tracking-assignments-toggle -gtoggle | |
| -print-autofdo-gcov-version | |
| -print-file-name=@var{library} -print-libgcc-file-name | |
| -print-multi-directory -print-multi-lib -print-multi-os-directory | |
| -print-multiarch | |
| -print-prog-name=@var{program} -print-search-dirs -Q | |
| -print-sysroot -print-sysroot-headers-suffix | |
| -save-temps -save-temps=cwd -save-temps=obj | |
| -specs=@var{file} -time@r{[}=@var{file}@r{]} | |
| --dump=@var{letters} | |
| --print-autofdo-gcov-version | |
| --print-file-name=@var{library} --print-libgcc-file-file-name | |
| --print-multi-directory --print-multi-lib --print-multi-os-directory | |
| --print-multiarch --print-prog-name=@var{program} | |
| --print-search-dirs --print-sysroot --print-sysroot-headers-suffix | |
| --save-temps --specs=@var{file} | |
| --param @var{name}=@var{value} | |
| } | |
| @item Target-Specific Options | |
| @xref{Target-Specific Options}. | |
| @c This list is ordered alphanumerically by subsection name. | |
| @c Try and put the significant identifier (CPU or system) first, | |
| @c so users have a clue at guessing where the ones they want will be. | |
| @emph{AArch64 Options} (@ref{AArch64 Options}) | |
| @gccoptlist{-mabi=@var{name} -mbig-endian -mlittle-endian | |
| -menable-sysreg-checking | |
| -mgeneral-regs-only | |
| -mcmodel=tiny -mcmodel=small -mcmodel=large | |
| -mstrict-align -momit-leaf-frame-pointer | |
| -mtls-dialect=desc -mtls-dialect=traditional | |
| -mtls-size=@var{size} -mtp=@var{name} | |
| -mfix-cortex-a53-835769 -mfix-cortex-a53-843419 | |
| -mlow-precision-recip-sqrt -mlow-precision-sqrt -mlow-precision-div | |
| -mmax-vectorization -mautovec-preference=@var{name} | |
| -mpc-relative-literal-loads | |
| -msign-return-address=@var{scope} | |
| -mbranch-protection=@var{features} | |
| -mharden-sls=@var{opts} | |
| -march=@var{name} -mcpu=@var{name} -mtune=@var{name} | |
| -moverride=@var{string} | |
| -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{sysreg} | |
| -mstack-protector-guard-offset=@var{offset} -mtrack-speculation | |
| -moutline-atomics -mearly-ra -mearly-ldp-fusion -mlate-ldp-fusion -mnarrow-gp-writes | |
| -msve-vector-bits=@var{bits}} | |
| @emph{Adapteva Epiphany Options} (@ref{Adapteva Epiphany Options}) | |
| @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs | |
| -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf | |
| -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} | |
| -mround-nearest -mlong-calls -mshort-calls -msmall16 | |
| -mfp-mode=@var{mode} -mmay-round-for-trunc -mfp-iarith | |
| -mvect-double -max-vect-align=@var{num} | |
| -msplit-vecmove-early -m1reg-@var{reg}} | |
| @emph{AMD GCN Options} (@ref{AMD GCN Options}) | |
| @gccoptlist{-march=@var{gpu} -mtune=@var{gpu} | |
| -mgang-private-size=@var{bytes} | |
| -msram-ecc=@r{[}on@r{|}off@r{|}any@r{]} | |
| -mxnack=@r{[}on@r{|}off@r{|}any@r{]} | |
| -Wopenacc-dims} | |
| @emph{ARC Options} (@ref{ARC Options}) | |
| @gccoptlist{-mbarrel-shifter -mjli-always | |
| -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 | |
| -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr | |
| -mea -mmul32x16 -mmul64 -matomic | |
| -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap | |
| -mlock -mswape | |
| -mxy -misize -marclinux -marclinux_prof | |
| -mlong-calls -mmedium-calls -msdata -mirq-ctrl-saved | |
| -mrgf-banked-regs -mlpc-width=@var{width} -G @var{num} | |
| -mvolatile-cache -mtp-regno=@var{regno} | |
| -mbitops -mcmem -munaligned-access | |
| -mauto-modify-reg -mno-brcc | |
| -mcase-vector-pcrel -mno-cond-exec -mearly-cbranchsi | |
| -mindexed-loads -mlra-priority-none | |
| -mlra-priority-compact -mlra-priority-noncompact -mmillicode | |
| -msize-level=@var{level} | |
| -mtune=@var{cpu} -mmultcost=@var{num} -mcode-density-frame | |
| -mmpy-option=@var{multo} | |
| -mdiv-rem -mcode-density -mll64 -mfpu=@var{fpu} -mrf16 -mbranch-index} | |
| @emph{ARM Options} (@ref{ARM Options}) | |
| @gccoptlist{-mapcs-frame -mapcs | |
| -mabi=@var{name} | |
| -mgeneral-regs-only -mno-sched-prolog | |
| -mlittle-endian -mbig-endian | |
| -mbe8 -mbe32 | |
| -mfloat-abi=@var{name} | |
| -mfp16-format=@var{name} | |
| -mthumb-interwork | |
| -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} -mtune=@var{name} | |
| -mstructure-size-boundary=@var{n} | |
| -mabort-on-noreturn -mlong-calls | |
| -msingle-pic-base -mpic-register=@var{reg} | |
| -mpic-data-is-text-relative | |
| -mnop-fun-dllimport | |
| -mpoke-function-name | |
| -mthumb -marm | |
| -mtpcs-frame -mtpcs-leaf-frame | |
| -mcaller-super-interworking -mcallee-super-interworking | |
| -mtp=@var{name} -mtls-dialect=@var{dialect} | |
| -mword-relocations | |
| -mfix-cortex-m3-ldrd | |
| -mfix-cortex-a57-aes-1742098 | |
| -mfix-cortex-a72-aes-1655431 | |
| -munaligned-access | |
| -mslow-flash-data | |
| -masm-syntax-unified | |
| -mrestrict-it | |
| -mpure-code | |
| -mcmse | |
| -mfix-cmse-cve-2021-35465 | |
| -mstack-protector-guard=@var{guard} | |
| -mstack-protector-guard-offset=@var{offset} | |
| -mfdpic | |
| -mbranch-protection=@var{features} | |
| -mvectorize-with-neon-quad -mvectorize-with-neon-double} | |
| @emph{AVR Options} (@ref{AVR Options}) | |
| @gccoptlist{-mmcu=@var{mcu} -mabsdata -maccumulate-args -masm-len-notes | |
| -mbranch-cost=@var{cost} -mcvt -mdemote-switch -mfuse-add=@var{level} | |
| -mfuse-ifelse -mfuse-move=@var{level} -mfuse-move2 | |
| -mcall-prologues -mgas-isr-prologues -mint8 -mflmap | |
| -mdouble=@var{bits} -mlong-double=@var{bits} -mno-call-main | |
| -mn_flash=@var{size} -mfract-convert-truncate -mno-interrupts | |
| -mmain-is-OS_task -moptimize -mrelax -mpmem-wrap-around -mprune-vectab | |
| -mrmw -mstrict-addr-space-subsets -mstrict-X -mtiny-stack | |
| -mrodata-in-ram -msplit-bit-shift -msplit-ldst -mshort-calls | |
| -mskip-bug -muse-nonzero-bits -nodevicelib -nodevicespecs | |
| -Wasm-len-notes -Waddr-space-convert -Wmisspelled-isr} | |
| @emph{Blackfin Options} (@ref{Blackfin Options}) | |
| @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} | |
| -msim -momit-leaf-frame-pointer | |
| -mspecld-anomaly -mcsync-anomaly | |
| -mlow-64k -mstack-check-l1 -mid-shared-library | |
| -mleaf-id-shared-library | |
| -mshared-library-id=@var{n} | |
| -msep-data -mlong-calls | |
| -mfast-fp -minline-plt -mmulticore -mcorea -mcoreb -msdram | |
| -micplb} | |
| @emph{C6X Options} (@ref{C6X Options}) | |
| @gccoptlist{-mbig-endian -mlittle-endian -march=@var{cpu} | |
| -msim -msdata=@var{sdata-type} -mdsbt -mlong-calls} | |
| @emph{CRIS Options} (@ref{CRIS Options}) | |
| @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} | |
| -mtune=@var{cpu} -mmax-stackframe=@var{n} | |
| -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects | |
| -mstack-align -mdata-align -mconst-align | |
| -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue | |
| -mbest-lib-options -moverride-best-lib-options | |
| -mtrap-using-break8 -mtrap-unaligned-atomic | |
| -munaligned-atomic-may-use-library | |
| -sim -sim2 | |
| -mmul-bug-workaround} | |
| @emph{C-SKY Options} (@ref{C-SKY Options}) | |
| @gccoptlist{-march=@var{arch} -mcpu=@var{cpu} | |
| -mbig-endian -mlittle-endian | |
| -mfpu=@var{fpu} -mdouble-float -mfdivdu | |
| -mfloat-abi=@var{name} | |
| -melrw -mistack -mmp -mcp -mcache -msecurity -mtrust | |
| -mdsp -medsp -mvdsp | |
| -mdiv -msmart -mhigh-registers -manchor | |
| -mpushpop -mmultiple-stld -mconstpool -mstack-size -mccrt | |
| -mbranch-cost=@var{n} -msched-prolog -msim} | |
| @emph{Cygwin and MinGW Options} (@ref{Cygwin and MinGW Options}) | |
| @gccoptlist{-mconsole -mcrtdll=@var{library} -mdll | |
| -mnop-fun-dllimport -mthreads | |
| -municode -mwin32 -mwindows -fno-set-stack-executable | |
| -fwritable-relocated-rdata -mpe-aligned-commons | |
| -muse-libstdc-wrappers} | |
| @emph{Darwin Options} (@ref{Darwin Options}) | |
| @gccoptlist{-all_load -allowable_client -arch @var{name} | |
| -arch_errors_fatal -asm_macosx_version_min=@var{version} | |
| -bind_at_load -bundle -bundle_loader | |
| -client_name -compatibility_version -current_version | |
| -dead_strip | |
| -dependency-file -dylib_file -dylinker -dylinker_install_name | |
| -dynamic -dynamiclib -exported_symbols_list | |
| -fapple-kext -fconstant-cfstrings -ffix-and-continue | |
| -filelist -findirect-data -flat_namespace -force_cpusubtype_ALL | |
| -force_flat_namespace -framework @var{name} -gfull -gused | |
| -headerpad_max_install_names -iframework | |
| -image_base -init @var{symbol-name} -install_name -keep_private_externs | |
| -matt-stubs -mconstant-cfstrings -mdynamic-no-pic | |
| -mfix-and-continue -mkernel -mmacosx-version-min=@var{version} | |
| -mone-byte-bool -msymbol-stubs -mtarget-linker@r{[}=@r{]}@var{version} | |
| -nodefaultexport -nodefaultrpaths | |
| -pagezero_size -preload -read_only_relocs | |
| -sectalign -sectcreate | |
| -seg_addr_table | |
| -seg1addr -segaddr | |
| -segprot -segs_read_only_addr -segs_read_write_addr | |
| -sub_library -sub_umbrella | |
| -twolevel_namespace -twolevel_namespace_hints | |
| -umbrella -undefined -unexported_symbols_list | |
| -weak_framework @var{name} -weak_reference_mismatches | |
| -whatsloaded -whyload | |
| -F -ObjC -ObjC++ -Wnonportable-cfstrings} | |
| @emph{DEC Alpha Options} (@ref{DEC Alpha Options}) | |
| @gccoptlist{-mno-fp-regs -msoft-float | |
| -mieee -mieee-with-inexact -mieee-conformant | |
| -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} | |
| -mtrap-precision=@var{mode} -mbuild-constants | |
| -mcpu=@var{cpu-type} -mtune=@var{cpu-type} | |
| -mbwx -mmax -mfix -mcix | |
| -msafe-bwa -msafe-partial | |
| -mfloat-vax -mfloat-ieee | |
| -mexplicit-relocs -msmall-data -mlarge-data | |
| -msmall-text -mlarge-text | |
| -mmemory-latency=@var{time} | |
| -mtls-kernel -mtls-size=@var{bitsize} | |
| -mlong-double-128 -mlong-double-64} | |
| @emph{eBPF Options} (@ref{eBPF Options}) | |
| @gccoptlist{-mbig-endian -mlittle-endian | |
| -mframe-limit=@var{bytes} -mxbpf -mco-re -mjmpext -mjmp32 | |
| -malu32 -mv3-atomics -mbswap -msdiv -msmov -mcallx -mcpu=@var{version} | |
| -masm=@var{dialect} -minline-memops-threshold=@var{bytes} | |
| -Wco-re} | |
| @emph{FR30 Options} (@ref{FR30 Options}) | |
| @gccoptlist{-msmall-model -mno-lsim} | |
| @emph{FRV Options} (@ref{FRV Options}) | |
| @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 | |
| -mhard-float -msoft-float | |
| -malloc-cc -mfixed-cc -mdword -mdouble -mmedia -mmuladd | |
| -mfdpic -minline-plt -mgprel-ro -multilib-library-pic | |
| -mlinked-fp -mlong-calls -malign-labels | |
| -mlibrary-pic -macc-4 -macc-8 | |
| -mpack -mno-eflags -mno-cond-move | |
| -mno-optimize-membar -mno-scc -mno-cond-exec | |
| -mno-vliw-branch -mno-multi-cond-exec -mno-nested-cond-exec | |
| -mtomcat-stats | |
| -mTLS -mtls | |
| -mcpu=@var{cpu}} | |
| @emph{FT32 Options} (@ref{FT32 Options}) | |
| @gccoptlist{-msim -mnodiv -mft32b -mcompress -mnopm} | |
| @emph{GNU/Linux Options} (@ref{GNU/Linux Options}) | |
| @gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid | |
| -tno-android-cc -tno-android-ld} | |
| @emph{H8/300 Options} (@ref{H8/300 Options}) | |
| @gccoptlist{-mrelax -mh -ms -mn -msx -ms2600 | |
| -mquickcall -mslowbyte -mexr -mint32 -malign-300} | |
| @emph{HPPA Options} (@ref{HPPA Options}) | |
| @gccoptlist{-march=@var{architecture-type} | |
| -mno-atomic-libcalls | |
| -mcaller-copies -mdisable-fpregs -mdisable-indexing | |
| -mordered -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld | |
| -mfixed-range=@var{register-range} | |
| -mcoherent-ldcw -mlinker-opt -mlong-calls | |
| -mlong-load-store | |
| -mno-space-regs -msoft-float -mpa-risc-1-0 | |
| -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime | |
| -mschedule=@var{cpu-type} -msoft-mult -msio -mwsio | |
| -munix=@var{unix-std} -nolibdld -static -threads} | |
| @emph{IA-64 Options} (@ref{IA-64 Options}) | |
| @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic | |
| -mvolatile-asm-stop -mregister-names -msdata | |
| -mconstant-gp -mauto-pic | |
| -minline-float-divide-min-latency | |
| -minline-float-divide-max-throughput | |
| -mno-inline-float-divide | |
| -minline-int-divide-min-latency | |
| -minline-int-divide-max-throughput | |
| -mno-inline-int-divide | |
| -minline-sqrt-min-latency -minline-sqrt-max-throughput | |
| -mno-inline-sqrt | |
| -mdwarf2-asm -mearly-stop-bits | |
| -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} | |
| -mtune=@var{cpu-type} -milp32 -mlp64 | |
| -msched-br-data-spec -msched-ar-data-spec -msched-control-spec | |
| -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec | |
| -msched-spec-ldc -msched-spec-control-ldc | |
| -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path | |
| -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost | |
| -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}} | |
| @emph{LM32 Options} (@ref{LM32 Options}) | |
| @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled | |
| -msign-extend-enabled -muser-enabled} | |
| @emph{LoongArch Options} (@ref{LoongArch Options}) | |
| @gccoptlist{-march=@var{arch-type} -mtune=@var{tune-type} -mabi=@var{base-abi-type} | |
| -mfpu=@var{fpu-type} -msimd=@var{simd-type} | |
| -msoft-float -msingle-float -mdouble-float -mlsx -mlasx | |
| -mbranch-cost=@var{n} -maddr-reg-reg-cost=@var{n} -mcheck-zero-division | |
| -mbreak-code=@var{code} | |
| -mcond-move-int -mcond-move-float | |
| -memcpy -mstrict-align -G @var{num} | |
| -mmax-inline-memcpy-size=@var{n} | |
| -mexplicit-relocs=@var{style} -mexplicit-relocs -mno-explicit-relocs | |
| -mdirect-extern-access | |
| -mcmodel=@var{code-model} -mrelax -mpass-mrelax-to-as | |
| -mrecip -mrecip=@var{opt} -mfrecipe -mdiv32 | |
| -mlam-bh -mlamcas -mld-seq-sa | |
| -mscq -mtls-dialect=@var{opt} | |
| -mannotate-tablejump} | |
| @emph{LynxOS Options} (@ref{LynxOS Options}) | |
| @gccoptlist{-mshared -mthreads -mlegacy-threads} | |
| @emph{M32R/D Options} (@ref{M32R/D Options}) | |
| @gccoptlist{-m32r2 -m32rx -m32r | |
| -mdebug | |
| -malign-loops | |
| -missue-rate=@var{number} | |
| -mbranch-cost=@var{number} | |
| -mmodel=@var{code-size-model-type} | |
| -msdata=@var{sdata-type} | |
| -mno-flush-func -mflush-func=@var{name} | |
| -mno-flush-trap -mflush-trap=@var{number} | |
| -G @var{num}} | |
| @emph{M680x0 Options} (@ref{M680x0 Options}) | |
| @gccoptlist{-march=@var{arch} -mcpu=@var{cpu} -mtune=@var{tune} | |
| -m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 | |
| -m68060 -m68302 -m68332 -m68851 | |
| -mcpu32 -mfidoa -m5200 -m5206e -m528x -m5307 -m5407 | |
| -mcfv4e -mbitfield -mc68000 -mc68020 | |
| -mrtd -mdiv -mshort | |
| -mhard-float -m68881 -msoft-float -mpcrel | |
| -malign-int -mstrict-align -msep-data | |
| -mshared-library-id=@var{n} -mid-shared-library | |
| -mxgot -mxtls -mlong-jump-table-offsets} | |
| @emph{MCore Options} (@ref{MCore Options}) | |
| @gccoptlist{-mhardlit -mdiv -mrelax-immediates | |
| -mwide-bitfields | |
| -m4byte-functions -mcallgraph-data | |
| -mslow-bytes -mno-lsim | |
| -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment} | |
| @emph{MicroBlaze Options} (@ref{MicroBlaze Options}) | |
| @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} | |
| -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift | |
| -mxl-pattern-compare -mxl-gp-opt | |
| -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt | |
| -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model} | |
| -mxl-prefetch -mpic-data-is-text-relative} | |
| @emph{MIPS Options} (@ref{MIPS Options}) | |
| @gccoptlist{-EL -EB -mel -meb -march=@var{arch} -mtune=@var{arch} | |
| -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips32r3 -mips32r5 | |
| -mips32r6 -mips64 -mips64r2 -mips64r3 -mips64r5 -mips64r6 | |
| -mips16 -mmips16e2 -mflip-mips16 | |
| -minterlink-compressed -minterlink-mips16 | |
| -mabi=@var{abi} -mabicalls -mshared -mplt -mxgot | |
| -mgp32 -mgp64 -mfp32 -mfpxx -mfp64 -mhard-float -msoft-float | |
| -mno-float -msingle-float -mdouble-float -modd-spreg | |
| -mabs=@var{mode} -mnan=@var{encoding} | |
| -mdsp -mdspr2 -mmcu -meva -mvirt -mxpa -mcrc -mginv | |
| -mmicromips -mmsa | |
| -mloongson-mmi -mloongson-ext -mloongson-ext2 | |
| -mfpu=@var{fpu-type} | |
| -msmartmips -mpaired-single -mdmx -mips3d -mmt -mllsc | |
| -mlong64 -mlong32 -msym32 | |
| -G@var{num} -mno-local-sdata -mno-extern-sdata -mno-gopt | |
| -membedded-data -muninit-const-in-rodata | |
| -mcode-readable=@var{setting} -mno-data-in-code -mcode-xonly | |
| -msplit-addresses -mexplicit-relocs -mexplicit-relocs=@var{release} | |
| -mno-check-zero-division -mdivide-traps -mdivide-breaks | |
| -mno-load-store-pairs | |
| -mstrict-align -mno-unaligned-access | |
| -mmemcpy -mlong-calls | |
| -mmad -mimadd -mno-fused-madd -nocpp | |
| -mfix-24k -mfix-r4000 -mfix-r4400 -mfix-r5900 | |
| -mfix-r10000 -mfix-rm7000 -mfix-vr4120 -mfix-vr4130 -mfix-sb1 | |
| -mfix4300 -mr10k-cache-barrier=@var{setting} | |
| -mflush-func=@var{func} -mno-flush-func | |
| -mbranch-cost=@var{num} -mbranch-likely | |
| -mcompact-branches=@var{policy} | |
| -mno-fp-exceptions -mvr4130-align -msynci -mno-lxc1-sxc1 -mno-madd4 | |
| -mno-relax-pic-calls -mmcount-ra-address | |
| -mframe-header-opt} | |
| @emph{MMIX Options} (@ref{MMIX Options}) | |
| @gccoptlist{-mlibfuncs -mepsilon -mabi=gnu -mabi=mmixware | |
| -mzero-extend -mknuthdiv -mtoplevel-symbols | |
| -melf -mbranch-predict -mbase-addresses | |
| -msingle-exit -mset-data-start=@var{address} | |
| -mset-program-start=@var{address} -mno-set-program-start} | |
| @emph{MN10300 Options} (@ref{MN10300 Options}) | |
| @gccoptlist{-mmult-bug -mno-mult-bug | |
| -mam33 -mam33-2 -mam34 | |
| -mtune=@var{cpu-type} | |
| -mno-return-pointer-on-d0 | |
| -mno-crt0 -mrelax -mno-liw -mno-setlb} | |
| @emph{Moxie Options} (@ref{Moxie Options}) | |
| @gccoptlist{-meb -mel -mmul.x -mno-crt0} | |
| @emph{MSP430 Options} (@ref{MSP430 Options}) | |
| @gccoptlist{-msim -masm-hex -mmcu=@var{name} -mlarge -msmall -mrelax | |
| -mwarn-mcu -mwarn-devices-csv | |
| -mcode-region=@var{where} -mdata-region=@var{where} | |
| -muse-lower-region-prefix | |
| -msilicon-errata=@var{name}@r{[},@var{name}@dots{}@r{]} | |
| -msilicon-errata-warn=@var{name}@r{[},@var{name}@dots{}@r{]} | |
| -mhwmult=@var{type} -minrt -mtiny-printf -mmax-inline-shift=@var{n}} | |
| @emph{NDS32 Options} (@ref{NDS32 Options}) | |
| @gccoptlist{-mbig-endian -mlittle-endian -EB -EL | |
| -mabi=@var{name} -mfloat-abi=@var{name} | |
| -mreduced-regs -mfull-regs | |
| -malways-align -malign-functions | |
| -mfp-as-gp -mcmov -mhw-abs | |
| -mext-perf -mext-perf2 -mext-string -mext-dsp | |
| -mext-fpu-fma -mext-fpu-sp -mext-fpu-dp | |
| -mv3push -m16-bit -mvh | |
| -misr-vector-size=@var{num} -misr-secure=@var{num} | |
| -mcache-block-size=@var{num} | |
| -march=@var{arch} -mcpu=@var{cpu} | |
| -mconfig-fpu=@var{num} -mconfig-mul=@var{type} | |
| -mconfig-register-ports=@var{kind} | |
| -mcmodel=@var{code-model} | |
| -mctor-dtor -mrelax -mrelax-hint | |
| -msched-prolog-epilog -mno-ret-in-naked-func | |
| -malways-save-lp -munaligned-access -minline-asm-r15} | |
| @emph{Nvidia PTX Options} (@ref{Nvidia PTX Options}) | |
| @gccoptlist{-m64 -march=@var{arch} -misa=@var{arch} -march-map=@var{arch} | |
| -mptx=@var{version} -mmainkernel -moptimize | |
| -msoft-stack -msoft-stack-reserve-local=@var{size} | |
| -muniform-simt -mgomp} | |
| @emph{OpenRISC Options} (@ref{OpenRISC Options}) | |
| @gccoptlist{-mboard=@var{name} -mhard-mul -mhard-div | |
| -msoft-mul -msoft-div | |
| -msoft-float -mhard-float -mdouble-float -munordered-float | |
| -mcmov -mror -mrori -msext -msfimm -mshftimm | |
| -mcmodel=@var{code-model}} | |
| @emph{PDP-11 Options} (@ref{PDP-11 Options}) | |
| @gccoptlist{-mfpu -msoft-float -mac0 -m40 -m45 -m10 | |
| -mint32 -mint16 | |
| -msplit -munix-asm -mdec-asm -mgnu-asm -mlra} | |
| @emph{Picolibc Options} (@ref{Picolibc Options}) | |
| @gccoptlist{--oslib=@var{library} --crt0=@r{[}none@r{|}minimal@r{|}hosted@r{|}semihost@r{]} | |
| --printf=@r{[}d@r{|}f@r{|}l@r{|}i@r{|}m@r{]} --scanf=@r{[}d@r{|}f@r{|}l@r{|}i@r{|}m@r{]}} | |
| @emph{PowerPC Options} | |
| See RS/6000 and PowerPC Options. | |
| @emph{PRU Options} (@ref{PRU Options}) | |
| @gccoptlist{-mmcu=@var{mcu} -minrt -mno-relax -mloop | |
| -mmul -mfillzero -mabi=@var{variant}} | |
| @emph{RISC-V Options} (@ref{RISC-V Options}) | |
| @gccoptlist{-mbranch-cost=@var{N-instruction} | |
| -mabi=@var{ABI-string} | |
| -mfdiv -mdiv | |
| -mno-fence-tso | |
| -misa-spec=@var{ISA-spec-string} | |
| -march=@r{[}@var{ISA}@r{|}@var{Profile}@r{|}@var{Profile_ISA}@r{|}@var{processor-string}@r{]} | |
| -mcpu=@var{processor-string} -mtune=@var{processor-string} | |
| -mpreferred-stack-boundary=@var{num} | |
| -msmall-data-limit=@var{N-bytes} | |
| -msave-restore -mno-shorten-memrefs | |
| -mstrict-align -mscalar-strict-align -mno-vector-strict-align | |
| -mzilsd-word-align -mzilsd-strict-align | |
| -mcmodel=medlow -mcmodel=medany -mcmodel=large | |
| -mexplicit-relocs -mrelax -mriscv-attribute | |
| -malign-data=@var{type} | |
| -mbig-endian -mlittle-endian | |
| -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} | |
| -mstack-protector-guard-offset=@var{offset} | |
| -mcsr-check -momit-leaf-frame-pointer -mmovcc | |
| -mno-inline-atomics -mno-inline-strlen | |
| -mno-inline-strcmp -mno-inline-strncmp | |
| -mstringop-strategy=@var{strategy} | |
| -munroll-only-small-loops -mno-unroll-only-small-loops | |
| -mtls-dialect=desc -mtls-dialect=trad | |
| -mrvv-vector-bits=@var{value} -mrvv-max-lmul=@var{value} | |
| -madjust-lmul-cost -mmax-vectorization -mno-autovec-segment} | |
| @emph{RL78 Options} (@ref{RL78 Options}) | |
| @gccoptlist{-msim -mallregs -mrelax -mes0 | |
| -mmul=none -mmul=g13 -mmul=g14 -mmul=rl78 | |
| -mcpu=g10 -mcpu=g13 -mcpu=g14 -mcpu=rl78 | |
| -mg10 -mg13 -mg14 -mrl78 | |
| -msave-mduc-in-interrupts} | |
| @emph{RS/6000 and PowerPC Options} (@ref{RS/6000 and PowerPC Options}) | |
| @gccoptlist{-mcpu=@var{cpu-type} | |
| -mtune=@var{cpu-type} | |
| -mcmodel=@var{code-model} -mprofile-kernel | |
| -mpowerpc64 | |
| -maltivec | |
| -mpowerpc-gpopt -mpowerpc-gfxopt -mmfcrf -mpopcntb -mpopcntd | |
| -mfprnd -mcmpb -mhard-dfp | |
| -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc | |
| -maix64 -maix32 -m64 -m32 -mxl-compat -mpe | |
| -malign-power -malign-natural | |
| -msoft-float -mhard-float -mmultiple -mupdate | |
| -mavoid-indexed-addresses | |
| -mfused-madd -mbit-align -mbit-word | |
| -mstrict-align -mrelocatable -mrelocatable-lib | |
| -mlittle -mlittle-endian -mbig -mbig-endian | |
| -mdynamic-no-pic -msingle-pic-base | |
| -mprioritize-restricted-insns=@var{priority} | |
| -msched-costly-dep=@var{dependence_type} | |
| -minsert-sched-nops=@var{scheme} | |
| -mcall-aixdesc -mcall-eabi -mcall-freebsd | |
| -mcall-linux -mcall-netbsd -mcall-openbsd | |
| -mcall-sysv -mcall-sysv-eabi -mcall-sysv-noeabi | |
| -mtraceback=@var{traceback_type} | |
| -maix-struct-return -msvr4-struct-return | |
| -mabi=@var{abi-type} -msecure-plt -mbss-plt | |
| -msplit-patch-nops | |
| -mregnames -mlongcall -mpltseq -mtls-markers | |
| -mblock-move-inline-limit=@var{num} | |
| -mblock-compare-inline-limit=@var{num} | |
| -mblock-compare-inline-loop-limit=@var{num} | |
| -mblock-ops-unaligned-vsx | |
| -mstring-compare-inline-limit=@var{num} | |
| -misel -mvsx -mvrsave -mmulhw -mdlmzb -mprototype | |
| -msim -mmvme -mads -myellowknife -memb -meabi -msdata | |
| -msdata=@var{opt} -mreadonly-in-sdata -mvxworks -G @var{num} | |
| -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision | |
| -mveclibabi=@var{type} -mfriz | |
| -mpointers-to-nested-functions -msave-toc-indirect -mpower8-fusion | |
| -mcrypto -mhtm -mquad-memory -mquad-memory-atomic | |
| -mcompat-align-parm | |
| -mfloat128 -mfloat128-hardware | |
| -mgnu-attribute | |
| -mstack-protector-guard=@var{guard} -mstack-protector-guard-reg=@var{reg} | |
| -mstack-protector-guard-offset=@var{offset} -mprefixed | |
| -mpcrel -mmma -mdense-math -mrop-protect -mprivileged | |
| -mno-splat-word-constant -mno-splat-float-constant | |
| -mno-ieee128-constant -mno-warn-altivec-long} | |
| @emph{RX Options} (@ref{RX Options}) | |
| @gccoptlist{-m64bit-doubles -m32bit-doubles -fpu -nofpu | |
| -mcpu=@var{name} | |
| -mbig-endian-data -mlittle-endian-data | |
| -msmall-data-limit=@var{N} | |
| -msim -mas100-syntax -mrelax | |
| -mmax-constant-size=@var{N} -mint-register=@var{N} | |
| -mpid -mno-allow-string-insns -mjsr | |
| -mno-warn-multiple-fast-interrupts -msave-acc-in-interrupts | |
| -mlra} | |
| @emph{S/390 and zSeries Options} (@ref{S/390 and zSeries Options}) | |
| @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} | |
| -mhard-float -msoft-float -mhard-dfp | |
| -mlong-double-64 -mlong-double-128 | |
| -mbackchain -mpacked-stack | |
| -msmall-exec -mmvcle | |
| -m64 -mdebug -mzarch | |
| -mhtm -mvx -mzvector | |
| -mtpf-trace -mtpf-trace-skip -mmain | |
| -mfused-madd -mno-fused-madd | |
| -mwarn-framesize=@var{framesize} -mwarn-dynamicstack | |
| -mstack-size=@var{stack-size} -mno-stack-size | |
| -mstack-guard=@var{stack-guard} -mno-stack-guard | |
| -mstack-protector-guard=@var{guard} | |
| -mstack-protector-guard-record | |
| -mhotpatch=@var{pre-halfwords},@var{post-halfwords} | |
| -mno-pic-data-is-text-relative | |
| -mindirect-branch=@var{choice} | |
| -mindirect-branch-jump=@var{choice} -mindirect-branch-call=@var{choice} | |
| -mfunction-return=@var{choice} | |
| -mfunction-return-mem=@var{choice} -mfunction-return-reg=@var{choice} | |
| -mindirect-branch-table | |
| -mfentry -mrecord-mcount -mnop-mcount | |
| -mpreserve-args -munaliged-symbols} | |
| @emph{SH Options} (@ref{SH Options}) | |
| @gccoptlist{-m1 -m2 -m2e | |
| -m2a -m2a-nofpu -m2a-single -m2a-single-only | |
| -m3 -m3e | |
| -m4 -m4-nofpu -m4-single -m4-single-only | |
| -m4-100 -m4-100-nofpu -m4-100-single -m4-100-single-only | |
| -m4-200 -m4-200-nofpu -m4-200-single -m4-200-single-only | |
| -m4-300 -m4-300-nofpu -m4-300-single -m4-300-single-only | |
| -m4-340 -m4-400 -m4-500 | |
| -m4a -m4al -m4a-nofpu -m4a-single -m4a-single-only | |
| -mb -ml -mdalign -mrelax | |
| -mbigtable -mbitops -mfmovd -mrenesas -mnomacsave | |
| -mieee -misize -minline-ic_invalidate | |
| -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} | |
| -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} | |
| -maccumulate-outgoing-args | |
| -matomic-model=@var{atomic-model} | |
| -mbranch-cost=@var{num} -mzdcbranch | |
| -mcbranch-force-delay-slot | |
| -mfsca -mfsrra | |
| -mpretend-cmove -mfdpic -mtas} | |
| @emph{Solaris 2 Options} (@ref{Solaris 2 Options}) | |
| @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text -mno-impure-text | |
| -gsctf} | |
| @emph{SPARC Options} (@ref{SPARC Options}) | |
| @gccoptlist{-mcpu=@var{cpu-type} | |
| -mtune=@var{cpu-type} | |
| -mcmodel=@var{code-model} | |
| -mmemory-model=@var{mem-model} | |
| -m32 -m64 -mptr32 -mptr64 -mapp-regs | |
| -mfaster-structs -mflat | |
| -mfpu -mhard-float -msoft-float | |
| -mhard-quad-float -msoft-quad-float | |
| -mstack-bias -mstd-struct-return | |
| -munaligned-doubles -muser-mode | |
| -mv8plus -mvis | |
| -mvis2 -mvis3 -mvis3b -mvis4 -mvis4b | |
| -mcbcond -mfmaf -mfsmuld -mpopc -msubxc | |
| -mfix-at697f -mfix-ut699 -mfix-ut700 -mfix-gr712rc} | |
| @emph{System V Options} (@ref{System V Options}) | |
| @gccoptlist{-YP,@var{paths} -Ym,@var{dir}} | |
| @emph{V850 Options} (@ref{V850 Options}) | |
| @gccoptlist{-mlong-calls -mep | |
| -mprolog-function -mspace | |
| -mtda=@var{n} -msda=@var{n} -mzda=@var{n} | |
| -mv850 -mv850e3v5 -m850e2v4 -mv850e2v3 | |
| -mv850e2 -mv850e1 -mv850es -mv850e | |
| -mdisable-callt -mrelax -mlong-jumps | |
| -msoft-float -mhard-float -mloop | |
| -mrh850-abi -mghs -mgcc-abi | |
| -m8byte-align -mbig-switch -mapp-regs -msmall-sld | |
| -mno-strict-align -mjump-tables-in-data-section} | |
| @emph{VAX Options} (@ref{VAX Options}) | |
| @gccoptlist{-munix -mgnu -md -md-float -mg -mg-float -mlra | |
| -mvaxc-alignment -mqmath} | |
| @emph{Visium Options} (@ref{Visium Options}) | |
| @gccoptlist{-mdebug -msim -mfpu -mhard-float -msoft-float | |
| -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode} | |
| @emph{VMS Options} (@ref{VMS Options}) | |
| @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 | |
| -mpointer-size=@var{size}} | |
| @emph{VxWorks Options} (@ref{VxWorks Options}) | |
| @gccoptlist{-mrtp -msmp -mvthreads -non-static -Bstatic -Bdynamic | |
| -Xbind-lazy -Xbind-now} | |
| @emph{x86 Options} (@ref{x86 Options}) | |
| @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} | |
| -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default | |
| -mfpmath=@var{unit} | |
| -masm=@var{dialect} -mno-fancy-math-387 | |
| -mno-fp-ret-in-387 -m80387 -mhard-float -msoft-float -mieee-fp | |
| -mrtd -malign-double | |
| -mpreferred-stack-boundary=@var{num} | |
| -mincoming-stack-boundary=@var{num} | |
| -mcld -mcx16 -msahf -mmovbe -mcrc32 -mmwait | |
| -mrecip -mrecip=@var{opt} | |
| -mvzeroupper -mstv -mprefer-avx128 -mprefer-vector-width=@var{opt} | |
| -mpartial-vector-fp-math | |
| -mmove-max=@var{bits} -mstore-max=@var{bits} | |
| -mnoreturn-no-callee-saved-registers | |
| -mmmx -msse -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx | |
| -mavx2 -mavx512f -mavx512cd -mavx512vl | |
| -mavx512bw -mavx512dq -mavx512ifma -mavx512vbmi -msha -maes | |
| -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mpconfig -mwbnoinvd | |
| -mptwrite -mclflushopt -mclwb -mxsavec -mxsaves | |
| -msse4a -m3dnow -m3dnowa -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop | |
| -madx -mlzcnt -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mhle -mlwp | |
| -mmwaitx -mclzero -mpku -mgfni -mvaes -mwaitpkg | |
| -mshstk -mmanual-endbr -mcet-switch -mforce-indirect-call | |
| -mavx512vbmi2 -mavx512bf16 -menqcmd | |
| -mvpclmulqdq -mavx512bitalg -mmovdiri -mmovdir64b -mavx512vpopcntdq | |
| -mavx512vnni -mprfchw -mrdpid | |
| -mrdseed -msgx -mavx512vp2intersect -mserialize -mtsxldtrk | |
| -mamx-tile -mamx-int8 -mamx-bf16 -muintr -mhreset | |
| -mavxvnni -mamx-fp8 -mavx512fp16 -mavxifma -mavxvnniint8 | |
| -mavxneconvert -mcmpccxadd -mamx-fp16 -mprefetchi -mraoint | |
| -mamx-complex -mavxvnniint16 -msm3 -msha512 -msm4 -mapxf | |
| -musermsr -mavx10.1 -mavx10.2 -mamx-avx512 -mmovrs -mamx-movrs | |
| -mavx512bmm -mavx10v2aux -macev1 -mavx10v1aux | |
| -mcldemote -mms-bitfields -mno-align-stringops -minline-all-stringops | |
| -minline-stringops-dynamically -mstringop-strategy=@var{alg} | |
| -mkl -mwidekl | |
| -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} | |
| -mpush-args -maccumulate-outgoing-args -m128bit-long-double | |
| -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 | |
| -mregparm=@var{num} -msseregparm | |
| -mveclibabi=@var{type} -mvect8-ret-in-mem | |
| -mpc32 -mpc64 -mpc80 -mdaz-ftz -mstackrealign -mstack-arg-probe | |
| -momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs | |
| -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} | |
| -m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} | |
| -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv | |
| -minstrument-return=@var{type} -mrecord-return | |
| -mfentry-name=@var{name} -mfentry-section=@var{name} | |
| -mskip-rax-setup | |
| -mavx256-split-unaligned-load -mavx256-split-unaligned-store | |
| -malign-data=@var{type} -mstack-protector-guard=@var{guard} | |
| -mstack-protector-guard-reg=@var{reg} | |
| -mstack-protector-guard-offset=@var{offset} | |
| -mstack-protector-guard-symbol=@var{symbol} | |
| -mgeneral-regs-only -mcall-ms2sysv-xlogues -mtls-dialect=@var{type} | |
| -m128bit-atomic -mrelax-cmpxchg-loop | |
| -mindirect-branch=@var{choice} -mfunction-return=@var{choice} | |
| -mindirect-branch-register -mharden-sls=@var{choice} | |
| -mindirect-branch-cs-prefix -mapx-inline-asm-use-gpr32 | |
| -mgather -mscatter | |
| -mneeded -mno-direct-extern-access | |
| -munroll-only-small-loops -mdispatch-scheduler -mlam=@var{choice}} | |
| @emph{x86 Windows Options} | |
| See Cygwin and MinGW Options. | |
| @emph{Xstormy16 Options} (@ref{Xstormy16 Options}) | |
| @gccoptlist{-msim} | |
| @emph{Xtensa Options} (@ref{Xtensa Options}) | |
| @gccoptlist{-mconst16 -mforce-no-pic -mno-serialize-volatile | |
| -mtext-section-literals -mauto-litpools -mno-target-align | |
| -mlongcalls -mabi=@var{abi-type} | |
| -mextra-l32r-costs=@var{cycles} -mstrict-align -mforce-l32} | |
| @emph{zSeries Options} | |
| See S/390 and zSeries Options. | |
| @end table | |
| @node Overall Options | |
| @section Options Controlling the Kind of Output | |
| Compilation can involve up to four stages: preprocessing, compilation | |
| proper, assembly and linking, always in that order. GCC is capable of | |
| preprocessing and compiling several files either into several | |
| assembler input files, or into one assembler input file; then each | |
| assembler input file produces an object file, and linking combines all | |
| the object files (those newly compiled, and those specified as input) | |
| into an executable file. | |
| @cindex file name suffix | |
| For any given input file, the file name suffix determines what kind of | |
| compilation is done: | |
| @table @gcctabopt | |
| @item @var{file}.c | |
| C source code that must be preprocessed. | |
| @item @var{file}.i | |
| C source code that should not be preprocessed. | |
| @item @var{file}.ii | |
| C++ source code that should not be preprocessed. | |
| @item @var{file}.m | |
| Objective-C source code. Note that you must link with the @file{libobjc} | |
| library to make an Objective-C program work. | |
| @item @var{file}.mi | |
| Objective-C source code that should not be preprocessed. | |
| @item @var{file}.mm | |
| @itemx @var{file}.M | |
| Objective-C++ source code. Note that you must link with the @file{libobjc} | |
| library to make an Objective-C++ program work. Note that @samp{.M} refers | |
| to a literal capital M@. | |
| @item @var{file}.mii | |
| Objective-C++ source code that should not be preprocessed. | |
| @item @var{file}.h | |
| C, C++, Objective-C or Objective-C++ header file to be turned into a | |
| precompiled header (default), or C, C++ header file to be turned into an | |
| Ada spec (via the @option{-fdump-ada-spec} switch). | |
| @item @var{file}.cc | |
| @itemx @var{file}.cp | |
| @itemx @var{file}.cxx | |
| @itemx @var{file}.cpp | |
| @itemx @var{file}.CPP | |
| @itemx @var{file}.c++ | |
| @itemx @var{file}.C | |
| C++ source code that must be preprocessed. Note that in @samp{.cxx}, | |
| the last two letters must both be literally @samp{x}. Likewise, | |
| @samp{.C} refers to a literal capital C@. | |
| @item @var{file}.mm | |
| @itemx @var{file}.M | |
| Objective-C++ source code that must be preprocessed. | |
| @item @var{file}.mii | |
| Objective-C++ source code that should not be preprocessed. | |
| @item @var{file}.hh | |
| @itemx @var{file}.H | |
| @itemx @var{file}.hp | |
| @itemx @var{file}.hxx | |
| @itemx @var{file}.hpp | |
| @itemx @var{file}.HPP | |
| @itemx @var{file}.h++ | |
| @itemx @var{file}.tcc | |
| C++ header file to be turned into a precompiled header or Ada spec. | |
| @item @var{file}.f | |
| @itemx @var{file}.for | |
| @itemx @var{file}.ftn | |
| @itemx @var{file}.fi | |
| Fixed form Fortran source code that should not be preprocessed. | |
| @item @var{file}.F | |
| @itemx @var{file}.FOR | |
| @itemx @var{file}.fpp | |
| @itemx @var{file}.FPP | |
| @itemx @var{file}.FTN | |
| Fixed form Fortran source code that must be preprocessed (with the traditional | |
| preprocessor). | |
| @item @var{file}.f90 | |
| @itemx @var{file}.f95 | |
| @itemx @var{file}.f03 | |
| @itemx @var{file}.f08 | |
| @itemx @var{file}.fii | |
| Free form Fortran source code that should not be preprocessed. | |
| @item @var{file}.F90 | |
| @itemx @var{file}.F95 | |
| @itemx @var{file}.F03 | |
| @itemx @var{file}.F08 | |
| Free form Fortran source code that must be preprocessed (with the | |
| traditional preprocessor). | |
| @item @var{file}.cob | |
| @item @var{file}.COB | |
| @item @var{file}.cbl | |
| @item @var{file}.CBL | |
| COBOL source code. | |
| @item @var{file}.go | |
| Go source code. | |
| @item @var{file}.d | |
| D source code. | |
| @item @var{file}.di | |
| D interface file. | |
| @item @var{file}.dd | |
| D documentation code (Ddoc). | |
| @item @var{file}.ads | |
| Ada source code file that contains a library unit declaration (a | |
| declaration of a package, subprogram, or generic, or a generic | |
| instantiation), or a library unit renaming declaration (a package, | |
| generic, or subprogram renaming declaration). Such files are also | |
| called @dfn{specs}. | |
| @item @var{file}.adb | |
| Ada source code file containing a library unit body (a subprogram or | |
| package body). Such files are also called @dfn{bodies}. | |
| @c GCC also knows about some suffixes for languages not yet included: | |
| @c Ratfor: | |
| @c @var{file}.r | |
| @item @var{file}.s | |
| Assembler code. | |
| @item @var{file}.S | |
| @itemx @var{file}.sx | |
| Assembler code that must be preprocessed. | |
| @item @var{other} | |
| An object file to be fed straight into linking. | |
| Any file name with no recognized suffix is treated this way. | |
| @end table | |
| @opindex x | |
| @opindex language | |
| You can specify the input language explicitly with the @option{-x} option: | |
| @table @gcctabopt | |
| @item -x @var{language} | |
| @itemx --language=@var{language} | |
| @itemx --language @var{language} | |
| Specify explicitly the @var{language} for the following input files | |
| (rather than letting the compiler choose a default based on the file | |
| name suffix). This option applies to all following input files until | |
| the next @option{-x} option. Possible values for @var{language} are: | |
| @smallexample | |
| c c-header cpp-output | |
| c++ c++-header c++-system-header c++-user-header c++-cpp-output | |
| c++-system-module | |
| objective-c objective-c-header objective-c-cpp-output objc-cpp-output | |
| objective-c++ objective-c++-header objective-c++-cpp-output | |
| objc++-cpp-output | |
| assembler assembler-with-cpp | |
| ada adascil adawhy | |
| cobol | |
| d | |
| f77 f77-cpp-input f95 f95-cpp-input | |
| go | |
| modula-2 modula-2-cpp-output | |
| rust | |
| algol68 | |
| lto | |
| @end smallexample | |
| Note that @option{-x} does not imply a particular language standard. | |
| For example @option{-x f77} may also require @option{-std=legacy} for some older | |
| source codes. | |
| @item -x none | |
| Turn off any specification of a language, so that subsequent files are | |
| handled according to their file name suffixes (as if @option{-x} | |
| has not been used at all). | |
| @end table | |
| If you only want some of the stages of compilation, you can use | |
| @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and | |
| one of the options @option{-c}, @option{-S}, or @option{-E} to say where | |
| @command{gcc} is to stop. Note that some combinations (for example, | |
| @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all. | |
| @table @gcctabopt | |
| @opindex c | |
| @opindex compile | |
| @item -c | |
| @itemx --compile | |
| Compile or assemble the source files, but do not link. The linking | |
| stage simply is not done. The ultimate output is in the form of an | |
| object file for each source file. | |
| By default, the object file name for a source file is made by replacing | |
| the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}. | |
| Unrecognized input files, not requiring compilation or assembly, are | |
| ignored. | |
| @opindex S | |
| @opindex assemble | |
| @item -S | |
| @itemx --assemble | |
| Stop after the stage of compilation proper; do not assemble. The output | |
| is in the form of an assembler code file for each non-assembler input | |
| file specified. | |
| By default, the assembler file name for a source file is made by | |
| replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}. | |
| Input files that don't require compilation are ignored. | |
| @opindex E | |
| @opindex preprocess | |
| @item -E | |
| @itemx --preprocess | |
| Stop after the preprocessing stage; do not run the compiler proper. The | |
| output is in the form of preprocessed source code, which is sent to the | |
| standard output. | |
| Input files that don't require preprocessing are ignored. | |
| @cindex output file option | |
| @opindex o | |
| @opindex output | |
| @item -o @var{file} | |
| @itemx --output=@var{file} | |
| @itemx --output @var{file} | |
| Place the primary output in file @var{file}. This applies to whatever | |
| sort of output is being produced, whether it be an executable file, an | |
| object file, an assembler file or preprocessed C code. | |
| If @option{-o} is not specified, the default is to put an executable | |
| file in @file{a.out}, the object file for | |
| @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its | |
| assembler file in @file{@var{source}.s}, a precompiled header file in | |
| @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on | |
| standard output. | |
| Though @option{-o} names only the primary output, it also affects the | |
| naming of auxiliary and dump outputs. See the examples below. Unless | |
| overridden, both auxiliary outputs and dump outputs are placed in the | |
| same directory as the primary output. In auxiliary outputs, the suffix | |
| of the input file is replaced with that of the auxiliary output file | |
| type; in dump outputs, the suffix of the dump file is appended to the | |
| input file suffix. In compilation commands, the base name of both | |
| auxiliary and dump outputs is that of the primary output; in compile and | |
| link commands, the primary output name, minus the executable suffix, is | |
| combined with the input file name. If both share the same base name, | |
| disregarding the suffix, the result of the combination is that base | |
| name, otherwise, they are concatenated, separated by a dash. | |
| @smallexample | |
| gcc -c foo.c ... | |
| @end smallexample | |
| will use @file{foo.o} as the primary output, and place aux outputs and | |
| dumps next to it, e.g., aux file @file{foo.dwo} for | |
| @option{-gsplit-dwarf}, and dump file @file{foo.c.???r.final} for | |
| @option{-fdump-rtl-final}. | |
| If a non-linker output file is explicitly specified, aux and dump files | |
| by default take the same base name: | |
| @smallexample | |
| gcc -c foo.c -o dir/foobar.o ... | |
| @end smallexample | |
| will name aux outputs @file{dir/foobar.*} and dump outputs | |
| @file{dir/foobar.c.*}. | |
| A linker output will instead prefix aux and dump outputs: | |
| @smallexample | |
| gcc foo.c bar.c -o dir/foobar ... | |
| @end smallexample | |
| will generally name aux outputs @file{dir/foobar-foo.*} and | |
| @file{dir/foobar-bar.*}, and dump outputs @file{dir/foobar-foo.c.*} and | |
| @file{dir/foobar-bar.c.*}. | |
| The one exception to the above is when the executable shares the base | |
| name with the single input: | |
| @smallexample | |
| gcc foo.c -o dir/foo ... | |
| @end smallexample | |
| in which case aux outputs are named @file{dir/foo.*} and dump outputs | |
| named @file{dir/foo.c.*}. | |
| The location and the names of auxiliary and dump outputs can be adjusted | |
| by the options @option{-dumpbase}, @option{-dumpbase-ext}, | |
| @option{-dumpdir}, @option{-save-temps=cwd}, and | |
| @option{-save-temps=obj}. | |
| @opindex dumpbase | |
| @item -dumpbase @var{dumpbase} | |
| @item --dumpbase @var{dumpbase} | |
| This option sets the base name for auxiliary and dump output files. It | |
| does not affect the name of the primary output file. Intermediate | |
| outputs, when preserved, are not regarded as primary outputs, but as | |
| auxiliary outputs: | |
| @smallexample | |
| gcc -save-temps -S foo.c | |
| @end smallexample | |
| saves the (no longer) temporary preprocessed file in @file{foo.i}, and | |
| then compiles to the (implied) output file @file{foo.s}, whereas: | |
| @smallexample | |
| gcc -save-temps -dumpbase save-foo -c foo.c | |
| @end smallexample | |
| preprocesses to in @file{save-foo.i}, compiles to @file{save-foo.s} (now | |
| an intermediate, thus auxiliary output), and then assembles to the | |
| (implied) output file @file{foo.o}. | |
| Absent this option, dump and aux files take their names from the input | |
| file, or from the (non-linker) output file, if one is explicitly | |
| specified: dump output files (e.g. those requested by @option{-fdump-*} | |
| options) with the input name suffix, and aux output files (those | |
| requested by other non-dump options, e.g. @code{-save-temps}, | |
| @code{-gsplit-dwarf}, @code{-fcallgraph-info}) without it. | |
| Similar suffix differentiation of dump and aux outputs can be attained | |
| for explicitly-given @option{-dumpbase basename.suf} by also specifying | |
| @option{-dumpbase-ext .suf}. | |
| If @var{dumpbase} is explicitly specified with any directory component, | |
| any @var{dumppfx} specification (e.g. @option{-dumpdir} or | |
| @option{-save-temps=*}) is ignored, and instead of appending to it, | |
| @var{dumpbase} fully overrides it: | |
| @smallexample | |
| gcc foo.c -c -o dir/foo.o -dumpbase alt/foo \ | |
| -dumpdir pfx- -save-temps=cwd ... | |
| @end smallexample | |
| creates auxiliary and dump outputs named @file{alt/foo.*}, disregarding | |
| @file{dir/} in @option{-o}, the @file{./} prefix implied by | |
| @option{-save-temps=cwd}, and @file{pfx-} in @option{-dumpdir}. | |
| When @option{-dumpbase} is specified in a command that compiles multiple | |
| inputs, or that compiles and then links, it may be combined with | |
| @var{dumppfx}, as specified under @option{-dumpdir}. Then, each input | |
| file is compiled using the combined @var{dumppfx}, and default values | |
| for @var{dumpbase} and @var{auxdropsuf} are computed for each input | |
| file: | |
| @smallexample | |
| gcc foo.c bar.c -c -dumpbase main ... | |
| @end smallexample | |
| creates @file{foo.o} and @file{bar.o} as primary outputs, and avoids | |
| overwriting the auxiliary and dump outputs by using the @var{dumpbase} | |
| as a prefix, creating auxiliary and dump outputs named @file{main-foo.*} | |
| and @file{main-bar.*}. | |
| An empty string specified as @var{dumpbase} avoids the influence of the | |
| output basename in the naming of auxiliary and dump outputs during | |
| compilation, computing default values : | |
| @smallexample | |
| gcc -c foo.c -o dir/foobar.o -dumpbase '' ... | |
| @end smallexample | |
| will name aux outputs @file{dir/foo.*} and dump outputs | |
| @file{dir/foo.c.*}. Note how their basenames are taken from the input | |
| name, but the directory still defaults to that of the output. | |
| The empty-string dumpbase does not prevent the use of the output | |
| basename for outputs during linking: | |
| @smallexample | |
| gcc foo.c bar.c -o dir/foobar -dumpbase '' -flto ... | |
| @end smallexample | |
| The compilation of the source files will name auxiliary outputs | |
| @file{dir/foo.*} and @file{dir/bar.*}, and dump outputs | |
| @file{dir/foo.c.*} and @file{dir/bar.c.*}. LTO recompilation during | |
| linking will use @file{dir/foobar.} as the prefix for dumps and | |
| auxiliary files. | |
| @opindex dumpbase-ext | |
| @item -dumpbase-ext @var{auxdropsuf} | |
| @itemx --dumpbase-ext @var{auxdropsuf} | |
| When forming the name of an auxiliary (but not a dump) output file, drop | |
| trailing @var{auxdropsuf} from @var{dumpbase} before appending any | |
| suffixes. If not specified, this option defaults to the suffix of a | |
| default @var{dumpbase}, i.e., the suffix of the input file when | |
| @option{-dumpbase} is not present in the command line, or @var{dumpbase} | |
| is combined with @var{dumppfx}. | |
| @smallexample | |
| gcc foo.c -c -o dir/foo.o -dumpbase x-foo.c -dumpbase-ext .c ... | |
| @end smallexample | |
| creates @file{dir/foo.o} as the main output, and generates auxiliary | |
| outputs in @file{dir/x-foo.*}, taking the location of the primary | |
| output, and dropping the @file{.c} suffix from the @var{dumpbase}. Dump | |
| outputs retain the suffix: @file{dir/x-foo.c.*}. | |
| This option is disregarded if it does not match the suffix of a | |
| specified @var{dumpbase}, except as an alternative to the executable | |
| suffix when appending the linker output base name to @var{dumppfx}, as | |
| specified below: | |
| @smallexample | |
| gcc foo.c bar.c -o main.out -dumpbase-ext .out ... | |
| @end smallexample | |
| creates @file{main.out} as the primary output, and avoids overwriting | |
| the auxiliary and dump outputs by using the executable name minus | |
| @var{auxdropsuf} as a prefix, creating auxiliary outputs named | |
| @file{main-foo.*} and @file{main-bar.*} and dump outputs named | |
| @file{main-foo.c.*} and @file{main-bar.c.*}. | |
| @opindex dumpdir | |
| @item -dumpdir @var{dumppfx} | |
| @itemx --dumpdir @var{dumppfx} | |
| When forming the name of an auxiliary or dump output file, use | |
| @var{dumppfx} as a prefix: | |
| @smallexample | |
| gcc -dumpdir pfx- -c foo.c ... | |
| @end smallexample | |
| creates @file{foo.o} as the primary output, and auxiliary outputs named | |
| @file{pfx-foo.*}, combining the given @var{dumppfx} with the default | |
| @var{dumpbase} derived from the default primary output, derived in turn | |
| from the input name. Dump outputs also take the input name suffix: | |
| @file{pfx-foo.c.*}. | |
| If @var{dumppfx} is to be used as a directory name, it must end with a | |
| directory separator: | |
| @smallexample | |
| gcc -dumpdir dir/ -c foo.c -o obj/bar.o ... | |
| @end smallexample | |
| creates @file{obj/bar.o} as the primary output, and auxiliary outputs | |
| named @file{dir/bar.*}, combining the given @var{dumppfx} with the | |
| default @var{dumpbase} derived from the primary output name. Dump | |
| outputs also take the input name suffix: @file{dir/bar.c.*}. | |
| It defaults to the location of the output file, unless the output | |
| file is a special file like @code{/dev/null}. Options | |
| @option{-save-temps=cwd} and @option{-save-temps=obj} override this | |
| default, just like an explicit @option{-dumpdir} option. In case | |
| multiple such options are given, the last one prevails: | |
| @smallexample | |
| gcc -dumpdir pfx- -c foo.c -save-temps=obj ... | |
| @end smallexample | |
| outputs @file{foo.o}, with auxiliary outputs named @file{foo.*} because | |
| @option{-save-temps=*} overrides the @var{dumppfx} given by the earlier | |
| @option{-dumpdir} option. It does not matter that @option{=obj} is the | |
| default for @option{-save-temps}, nor that the output directory is | |
| implicitly the current directory. Dump outputs are named | |
| @file{foo.c.*}. | |
| When compiling from multiple input files, if @option{-dumpbase} is | |
| specified, @var{dumpbase}, minus a @var{auxdropsuf} suffix, and a dash | |
| are appended to (or override, if containing any directory components) an | |
| explicit or defaulted @var{dumppfx}, so that each of the multiple | |
| compilations gets differently-named aux and dump outputs. | |
| @smallexample | |
| gcc foo.c bar.c -c -dumpdir dir/pfx- -dumpbase main ... | |
| @end smallexample | |
| outputs auxiliary dumps to @file{dir/pfx-main-foo.*} and | |
| @file{dir/pfx-main-bar.*}, appending @var{dumpbase}- to @var{dumppfx}. | |
| Dump outputs retain the input file suffix: @file{dir/pfx-main-foo.c.*} | |
| and @file{dir/pfx-main-bar.c.*}, respectively. Contrast with the | |
| single-input compilation: | |
| @smallexample | |
| gcc foo.c -c -dumpdir dir/pfx- -dumpbase main ... | |
| @end smallexample | |
| that, applying @option{-dumpbase} to a single source, does not compute | |
| and append a separate @var{dumpbase} per input file. Its auxiliary and | |
| dump outputs go in @file{dir/pfx-main.*}. | |
| When compiling and then linking from multiple input files, a defaulted | |
| or explicitly specified @var{dumppfx} also undergoes the @var{dumpbase}- | |
| transformation above (e.g. the compilation of @file{foo.c} and | |
| @file{bar.c} above, but without @option{-c}). If neither | |
| @option{-dumpdir} nor @option{-dumpbase} are given, the linker output | |
| base name, minus @var{auxdropsuf}, if specified, or the executable | |
| suffix otherwise, plus a dash is appended to the default @var{dumppfx} | |
| instead. Note, however, that unlike earlier cases of linking: | |
| @smallexample | |
| gcc foo.c bar.c -dumpdir dir/pfx- -o main ... | |
| @end smallexample | |
| does not append the output name @file{main} to @var{dumppfx}, because | |
| @option{-dumpdir} is explicitly specified. The goal is that the | |
| explicitly-specified @var{dumppfx} may contain the specified output name | |
| as part of the prefix, if desired; only an explicitly-specified | |
| @option{-dumpbase} would be combined with it, in order to avoid simply | |
| discarding a meaningful option. | |
| When compiling and then linking from a single input file, the linker | |
| output base name will only be appended to the default @var{dumppfx} as | |
| above if it does not share the base name with the single input file | |
| name. This has been covered in single-input linking cases above, but | |
| not with an explicit @option{-dumpdir} that inhibits the combination, | |
| even if overridden by @option{-save-temps=*}: | |
| @smallexample | |
| gcc foo.c -dumpdir alt/pfx- -o dir/main.exe -save-temps=cwd ... | |
| @end smallexample | |
| Auxiliary outputs are named @file{foo.*}, and dump outputs | |
| @file{foo.c.*}, in the current working directory as ultimately requested | |
| by @option{-save-temps=cwd}. | |
| Summing it all up for an intuitive though slightly imprecise data flow: | |
| the primary output name is broken into a directory part and a basename | |
| part; @var{dumppfx} is set to the former, unless overridden by | |
| @option{-dumpdir} or @option{-save-temps=*}, and @var{dumpbase} is set | |
| to the latter, unless overridden by @option{-dumpbase}. If there are | |
| multiple inputs or linking, this @var{dumpbase} may be combined with | |
| @var{dumppfx} and taken from each input file. Auxiliary output names | |
| for each input are formed by combining @var{dumppfx}, @var{dumpbase} | |
| minus suffix, and the auxiliary output suffix; dump output names are | |
| only different in that the suffix from @var{dumpbase} is retained. | |
| When it comes to auxiliary and dump outputs created during LTO | |
| recompilation, a combination of @var{dumppfx} and @var{dumpbase}, as | |
| given or as derived from the linker output name but not from inputs, | |
| even in cases in which this combination would not otherwise be used as | |
| such, is passed down with a trailing period replacing the compiler-added | |
| dash, if any, as a @option{-dumpdir} option to @command{lto-wrapper}; | |
| being involved in linking, this program does not normally get any | |
| @option{-dumpbase} and @option{-dumpbase-ext}, and it ignores them. | |
| When running sub-compilers, @command{lto-wrapper} appends LTO stage | |
| names to the received @var{dumppfx}, ensures it contains a directory | |
| component so that it overrides any @option{-dumpdir}, and passes that as | |
| @option{-dumpbase} to sub-compilers. | |
| @opindex v | |
| @opindex verbose | |
| @item -v | |
| @itemx --verbose | |
| Print (on standard error output) the commands executed to run the stages | |
| of compilation. Also print the version number of the compiler driver | |
| program and of the preprocessor and the compiler proper. | |
| @opindex ### | |
| @item -### | |
| Like @option{-v} except the commands are not executed and arguments | |
| are quoted unless they contain only alphanumeric characters or @code{./-_}. | |
| This is useful for shell scripts to capture the driver-generated command lines. | |
| @opindex help | |
| @item --help | |
| Print (on the standard output) a description of the command-line options | |
| understood by @command{gcc}. If the @option{-v} option is also specified | |
| then @option{--help} is also passed on to the various processes | |
| invoked by @command{gcc}, so that they can display the command-line options | |
| they accept. If the @option{-Wextra} option has also been specified | |
| (prior to the @option{--help} option), then command-line options that | |
| have no documentation associated with them are also displayed. | |
| @opindex target-help | |
| @item --target-help | |
| Print (on the standard output) a description of target-specific command-line | |
| options for each tool. For some targets extra target-specific | |
| information may also be printed. | |
| @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]} | |
| Print (on the standard output) a description of the command-line | |
| options understood by the compiler that fit into all specified classes | |
| and qualifiers. These are the supported classes: | |
| @table @asis | |
| @item @samp{optimizers} | |
| Display all of the optimization options supported by the | |
| compiler. | |
| @item @samp{warnings} | |
| Display all of the options controlling warning messages | |
| produced by the compiler. | |
| @item @samp{target} | |
| Display target-specific options. Unlike the | |
| @option{--target-help} option however, target-specific options of the | |
| linker and assembler are not displayed. This is because those | |
| tools do not currently support the extended @option{--help=} syntax. | |
| @item @samp{params} | |
| Display the values recognized by the @option{--param} | |
| option. | |
| @item @var{language} | |
| Display the options supported for @var{language}, where | |
| @var{language} is the name of one of the languages supported in this | |
| version of GCC@. If an option is supported by all languages, one needs | |
| to select @samp{common} class. | |
| @item @samp{common} | |
| Display the options that are common to all languages. | |
| @end table | |
| These are the supported qualifiers: | |
| @table @asis | |
| @item @samp{undocumented} | |
| Display only those options that are undocumented. | |
| @item @samp{joined} | |
| Display options taking an argument that appears after an equal | |
| sign in the same continuous piece of text, such as: | |
| @samp{--help=target}. | |
| @item @samp{separate} | |
| Display options taking an argument that appears as a separate word | |
| following the original option, such as: @samp{-o output-file}. | |
| @end table | |
| Thus for example to display all the undocumented target-specific | |
| switches supported by the compiler, use: | |
| @smallexample | |
| --help=target,undocumented | |
| @end smallexample | |
| The sense of a qualifier can be inverted by prefixing it with the | |
| @samp{^} character, so for example to display all binary warning | |
| options (i.e., ones that are either on or off and that do not take an | |
| argument) that have a description, use: | |
| @smallexample | |
| --help=warnings,^joined,^undocumented | |
| @end smallexample | |
| The argument to @option{--help=} should not consist solely of inverted | |
| qualifiers. | |
| Combining several classes is possible, although this usually | |
| restricts the output so much that there is nothing to display. One | |
| case where it does work, however, is when one of the classes is | |
| @var{target}. For example, to display all the target-specific | |
| optimization options, use: | |
| @smallexample | |
| --help=target,optimizers | |
| @end smallexample | |
| The @option{--help=} option can be repeated on the command line. Each | |
| successive use displays its requested class of options, skipping | |
| those that have already been displayed. If @option{--help} is also | |
| specified anywhere on the command line then this takes precedence | |
| over any @option{--help=} option. | |
| @opindex Q | |
| If the @option{-Q} option appears on the command line before the | |
| @option{--help=} option, then the descriptive text displayed by | |
| @option{--help=} is changed. Instead of describing the displayed | |
| options, an indication is given as to whether the option is enabled, | |
| disabled or set to a specific value (assuming that the compiler | |
| knows this at the point where the @option{--help=} option is used). | |
| Here is a truncated example from the ARM port of @command{gcc}: | |
| @smallexample | |
| % gcc -Q -mabi=2 --help=target -c | |
| The following options are target specific: | |
| -mabi= 2 | |
| -mabort-on-noreturn [disabled] | |
| -mapcs [disabled] | |
| @end smallexample | |
| The output is sensitive to the effects of previous command-line | |
| options, so for example it is possible to find out which optimizations | |
| are enabled at @option{-O2} by using: | |
| @smallexample | |
| -Q -O2 --help=optimizers | |
| @end smallexample | |
| Alternatively you can discover which binary optimizations are enabled | |
| by @option{-O3} by using: | |
| @smallexample | |
| gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts | |
| gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts | |
| diff /tmp/O2-opts /tmp/O3-opts | grep enabled | |
| @end smallexample | |
| @opindex version | |
| @item --version | |
| Display the version number and copyrights of the invoked GCC@. | |
| @opindex pass-exit-codes | |
| @item -pass-exit-codes | |
| @itemx --pass-exit-codes | |
| Normally the @command{gcc} program exits with the code of 1 if any | |
| phase of the compiler returns a non-success return code. If you specify | |
| @option{-pass-exit-codes}, the @command{gcc} program instead returns with | |
| the numerically highest error produced by any phase returning an error | |
| indication. The C, C++, and Fortran front ends return 4 if an internal | |
| compiler error is encountered. | |
| @opindex pipe | |
| @item -pipe | |
| @itemx --pipe | |
| Use pipes rather than temporary files for communication between the | |
| various stages of compilation. This fails to work on some systems where | |
| the assembler is unable to read from a pipe; but the GNU assembler has | |
| no trouble. | |
| @opindex wrapper | |
| @item -wrapper | |
| Invoke all subcommands under a wrapper program. The name of the | |
| wrapper program and its parameters are passed as a comma separated | |
| list. | |
| @smallexample | |
| gcc -c t.c -wrapper gdb,--args | |
| @end smallexample | |
| @noindent | |
| This invokes all subprograms of @command{gcc} under | |
| @samp{gdb --args}, thus the invocation of @command{cc1} is | |
| @samp{gdb --args cc1 @dots{}}. | |
| @opindex ffile-prefix-map | |
| @item -ffile-prefix-map=@var{old}=@var{new} | |
| When compiling files residing in directory @file{@var{old}}, record | |
| any references to them in the result of the compilation as if the | |
| files resided in directory @file{@var{new}} instead. Specifying this | |
| option is equivalent to specifying all the individual | |
| @option{-f*-prefix-map} options. This can be used to make reproducible | |
| builds that are location independent. Directories referenced by | |
| directives are not affected by these options. See also | |
| @option{-fmacro-prefix-map}, @option{-fdebug-prefix-map}, | |
| @option{-fprofile-prefix-map} and @option{-fcanon-prefix-map}. | |
| @opindex fcanon-prefix-map | |
| @opindex fno-canon-prefix-map | |
| @item -fcanon-prefix-map | |
| For the @option{-f*-prefix-map} options normally comparison | |
| of @file{@var{old}} prefix against the filename that would be normally | |
| referenced in the result of the compilation is done using textual | |
| comparison of the prefixes, or ignoring character case for case insensitive | |
| filesystems and considering slashes and backslashes as equal on DOS based | |
| filesystems. The @option{-fcanon-prefix-map} causes such comparisons | |
| to be done on canonicalized paths of @file{@var{old}} | |
| and the referenced filename. | |
| @opindex fplugin | |
| @item -fplugin=@var{name}.so | |
| Load the plugin code in file @var{name}.so, assumed to be a | |
| shared object to be dlopen'd by the compiler. The base name of | |
| the shared object file is used to identify the plugin for the | |
| purposes of argument parsing (See | |
| @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below). | |
| Each plugin should define the callback functions specified in the | |
| Plugins API. | |
| @opindex fplugin-arg | |
| @item -fplugin-arg-@var{name}-@var{key}=@var{value} | |
| Define an argument called @var{key} with a value of @var{value} | |
| for the plugin called @var{name}. | |
| @opindex fdump-ada-spec | |
| @opindex fdump-ada-spec-slim | |
| @item -fdump-ada-spec@r{[}-slim@r{]} | |
| For C and C++ source and include files, generate corresponding Ada specs. | |
| @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn, | |
| GNAT User's Guide}, which provides detailed documentation on this feature. | |
| @opindex fada-spec-parent | |
| @item -fada-spec-parent=@var{unit} | |
| In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate | |
| Ada specs as child units of parent @var{unit}. | |
| @opindex fdump-go-spec | |
| @item -fdump-go-spec=@var{file} | |
| For input files in any language, generate corresponding Go | |
| declarations in @var{file}. This generates Go @code{const}, | |
| @code{type}, @code{var}, and @code{func} declarations which may be a | |
| useful way to start writing a Go interface to code written in some | |
| other language. | |
| @include @value{srcdir}/../libiberty/at-file.texi | |
| @end table | |
| @node Invoking G++ | |
| @section Compiling C++ Programs | |
| @cindex suffixes for C++ source | |
| @cindex C++ source file suffixes | |
| C++ source files conventionally use one of the suffixes @samp{.C}, | |
| @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or | |
| @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp}, | |
| @samp{.H}, or (for shared template code) @samp{.tcc}; | |
| preprocessed C++ files use the suffix @samp{.ii}; and C++20 module interface | |
| units sometimes use @samp{.ixx}, @samp{.cppm}, @samp{.cxxm}, @samp{.c++m}, | |
| or @samp{.ccm}. | |
| GCC recognizes files with these names and compiles them as C++ programs even if you | |
| call the compiler the same way as for compiling C programs (usually | |
| with the name @command{gcc}). | |
| @findex g++ | |
| @findex c++ | |
| However, the use of @command{gcc} does not add the C++ library. | |
| @command{g++} is a program that calls GCC and automatically specifies linking | |
| against the C++ library. It treats @samp{.c}, | |
| @samp{.h} and @samp{.i} files as C++ source files instead of C source | |
| files unless @option{-x} is used. This program is also useful when | |
| precompiling a C header file with a @samp{.h} extension for use in C++ | |
| compilations. On many systems, @command{g++} is also installed with | |
| the name @command{c++}. | |
| @cindex invoking @command{g++} | |
| When you compile C++ programs, you may specify many of the same | |
| command-line options that you use for compiling programs in any | |
| language; or command-line options meaningful for C and related | |
| languages; or options that are meaningful only for C++ programs. | |
| @xref{C Dialect Options,,Options Controlling C Dialect}, for | |
| explanations of options for languages related to C@. | |
| @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for | |
| explanations of options that are meaningful only for C++ programs. | |
| @node C Dialect Options | |
| @section Options Controlling C Dialect | |
| @cindex dialect options | |
| @cindex language dialect options | |
| @cindex options, dialect | |
| The following options control the dialect of C (or languages derived | |
| from C, such as C++, Objective-C and Objective-C++) that the compiler | |
| accepts: | |
| @table @gcctabopt | |
| @cindex ANSI support | |
| @cindex ISO support | |
| @opindex ansi | |
| @item -ansi | |
| @itemx --ansi | |
| In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is | |
| equivalent to @option{-std=c++98}. | |
| @opindex std | |
| @item -std= | |
| Determine the language standard. @xref{Standards,,Language Standards | |
| Supported by GCC}, for details of these standard versions. This option | |
| is currently only supported when compiling C or C++. | |
| The compiler can accept several base standards, such as @samp{c90} or | |
| @samp{c++98}, and GNU dialects of those standards, such as | |
| @samp{gnu90} or @samp{gnu++98}. When a base standard is specified, the | |
| compiler accepts all programs following that standard plus those | |
| using GNU extensions that do not contradict it. For example, | |
| @option{-std=c90} turns off certain features of GCC that are | |
| incompatible with ISO C90, such as the @code{asm} and @code{typeof} | |
| keywords, but not other GNU extensions that do not have a meaning in | |
| ISO C90, such as omitting the middle term of a @code{?:} | |
| expression. On the other hand, when a GNU dialect of a standard is | |
| specified, all features supported by the compiler are enabled, even when | |
| those features change the meaning of the base standard. As a result, some | |
| strict-conforming programs may be rejected. The particular standard | |
| is used by @option{-Wpedantic} to identify which features are GNU | |
| extensions given that version of the standard. For example | |
| @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//} | |
| comments, while @option{-std=gnu99 -Wpedantic} does not. | |
| A value for this option must be provided; possible values are | |
| @table @samp | |
| @item c90 | |
| @itemx c89 | |
| @itemx iso9899:1990 | |
| Support all ISO C90 programs (certain GNU extensions that conflict | |
| with ISO C90 are disabled). Same as @option{-ansi} for C code. | |
| @item iso9899:199409 | |
| ISO C90 as modified in amendment 1. | |
| @item c99 | |
| @itemx c9x | |
| @itemx iso9899:1999 | |
| @itemx iso9899:199x | |
| ISO C99. This standard is substantially completely supported, modulo | |
| bugs and floating-point issues | |
| (mainly but not entirely relating to optional C99 features from | |
| Annexes F and G). See | |
| @w{@uref{https://gcc.gnu.org/projects/c-status.html}} for more information. | |
| The names @samp{c9x} and @samp{iso9899:199x} are deprecated. | |
| @item c11 | |
| @itemx c1x | |
| @itemx iso9899:2011 | |
| ISO C11, the 2011 revision of the ISO C standard. This standard is | |
| substantially completely supported, modulo bugs, floating-point issues | |
| (mainly but not entirely relating to optional C11 features from | |
| Annexes F and G) and the optional Annexes K (Bounds-checking | |
| interfaces) and L (Analyzability). The name @samp{c1x} is deprecated. | |
| @item c17 | |
| @itemx c18 | |
| @itemx iso9899:2017 | |
| @itemx iso9899:2018 | |
| ISO C17, the 2017 revision of the ISO C standard | |
| (published in 2018). This standard is | |
| same as C11 except for corrections of defects (all of which are also | |
| applied with @option{-std=c11}) and a new value of | |
| @code{__STDC_VERSION__}, and so is supported to the same extent as C11. | |
| @item c23 | |
| @itemx c2x | |
| @itemx iso9899:2024 | |
| ISO C23, the 2023 revision of the ISO C standard (published in 2024). The | |
| name @samp{c2x} is deprecated. | |
| @item c2y | |
| The next version of the ISO C standard, still under development. The | |
| support for this version is experimental and incomplete. | |
| @item gnu90 | |
| @itemx gnu89 | |
| GNU dialect of ISO C90 (including some C99 features). | |
| @item gnu99 | |
| @itemx gnu9x | |
| GNU dialect of ISO C99. The name @samp{gnu9x} is deprecated. | |
| @item gnu11 | |
| @itemx gnu1x | |
| GNU dialect of ISO C11. | |
| The name @samp{gnu1x} is deprecated. | |
| @item gnu17 | |
| @itemx gnu18 | |
| GNU dialect of ISO C17. | |
| @item gnu23 | |
| @itemx gnu2x | |
| GNU dialect of ISO C23. This is the default for C code. The name | |
| @samp{gnu2x} is deprecated. | |
| @item gnu2y | |
| The next version of the ISO C standard, still under development, plus | |
| GNU extensions. The support for this version is experimental and | |
| incomplete. The name @samp{gnu2x} is deprecated. | |
| @item c++98 | |
| @itemx c++03 | |
| The 1998 ISO C++ standard plus the 2003 technical corrigendum and some | |
| additional defect reports. Same as @option{-ansi} for C++ code. | |
| @item gnu++98 | |
| @itemx gnu++03 | |
| GNU dialect of @option{-std=c++98}. | |
| @item c++11 | |
| @itemx c++0x | |
| The 2011 ISO C++ standard plus amendments. | |
| The name @samp{c++0x} is deprecated. | |
| @item gnu++11 | |
| @itemx gnu++0x | |
| GNU dialect of @option{-std=c++11}. | |
| The name @samp{gnu++0x} is deprecated. | |
| @item c++14 | |
| @itemx c++1y | |
| The 2014 ISO C++ standard plus amendments. | |
| The name @samp{c++1y} is deprecated. | |
| @item gnu++14 | |
| @itemx gnu++1y | |
| GNU dialect of @option{-std=c++14}. | |
| The name @samp{gnu++1y} is deprecated. | |
| @item c++17 | |
| @itemx c++1z | |
| The 2017 ISO C++ standard plus amendments. | |
| The name @samp{c++1z} is deprecated. | |
| @item gnu++17 | |
| @itemx gnu++1z | |
| GNU dialect of @option{-std=c++17}. | |
| The name @samp{gnu++1z} is deprecated. | |
| @item c++20 | |
| @itemx c++2a | |
| The 2020 ISO C++ standard plus amendments. | |
| C++20 modules support is still experimental and needs to be | |
| enabled with @option{-fmodules} option. | |
| The name @samp{c++2a} is deprecated. | |
| @item gnu++20 | |
| @itemx gnu++2a | |
| GNU dialect of @option{-std=c++20}. | |
| This is the default for C++ code. | |
| C++20 modules support is still experimental and needs to be | |
| enabled with @option{-fmodules} option. | |
| The name @samp{gnu++2a} is deprecated. | |
| @item c++23 | |
| @itemx c++2b | |
| The 2023 ISO C++ standard plus amendments (published in 2024). | |
| Support is experimental, and could change in incompatible ways in | |
| future releases. | |
| The name @samp{c++2b} is deprecated. | |
| @item gnu++23 | |
| @itemx gnu++2b | |
| GNU dialect of @option{-std=c++23}. | |
| Support is experimental, and could change in incompatible ways in | |
| future releases. | |
| The name @samp{gnu++2b} is deprecated. | |
| @item c++26 | |
| @itemx c++2c | |
| The next revision of the ISO C++ standard, planned for | |
| 2026. Support is highly experimental, and will almost certainly | |
| change in incompatible ways in future releases. | |
| @item gnu++26 | |
| @itemx gnu++2c | |
| GNU dialect of @option{-std=c++26}. Support is highly experimental, | |
| and will almost certainly change in incompatible ways in future | |
| releases. | |
| @item c++29 | |
| @itemx c++2d | |
| The upcoming revision of the ISO C++ standard, planned for | |
| 2029. Support is highly experimental, and will almost certainly | |
| change in incompatible ways in future releases. | |
| @item gnu++29 | |
| @itemx gnu++2d | |
| GNU dialect of @option{-std=c++29}. Support is highly experimental, | |
| and will almost certainly change in incompatible ways in future | |
| releases. | |
| @end table | |
| @opindex aux-info | |
| @item -aux-info @var{filename} | |
| Output to the given filename prototyped declarations for all functions | |
| declared and/or defined in a translation unit, including those in header | |
| files. This option is silently ignored in any language other than C@. | |
| Besides declarations, the file indicates, in comments, the origin of | |
| each declaration (source file and line), whether the declaration was | |
| implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or | |
| @samp{O} for old, respectively, in the first character after the line | |
| number and the colon), and whether it came from a declaration or a | |
| definition (@samp{C} or @samp{F}, respectively, in the following | |
| character). In the case of function definitions, a K&R-style list of | |
| arguments followed by their declarations is also provided, inside | |
| comments, after the declaration. | |
| @opindex fno-asm | |
| @opindex fasm | |
| @item -fno-asm | |
| Do not recognize @code{asm}, @code{inline} or @code{typeof} as a | |
| keyword, so that code can use these words as identifiers. You can use | |
| the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__} | |
| instead. In C, @option{-ansi} implies @option{-fno-asm}. | |
| In C++, @code{inline} is a standard keyword and is not affected by | |
| this switch. You may want to use the @option{-fno-gnu-keywords} flag | |
| instead, which disables @code{typeof} but not @code{asm} and | |
| @code{inline}. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), | |
| this switch only affects the @code{asm} and @code{typeof} keywords, | |
| since @code{inline} is a standard keyword in ISO C99. In C23 mode | |
| (@option{-std=c23} or @option{-std=gnu23}), this switch only affects | |
| the @code{asm} keyword, since @code{typeof} is a standard keyword in | |
| ISO C23. | |
| @opindex fno-builtin | |
| @opindex fbuiltin | |
| @cindex built-in functions | |
| @item -fno-builtin | |
| @itemx -fno-builtin-@var{function} | |
| Don't recognize built-in functions that do not begin with | |
| @samp{__builtin_} as prefix. @xref{Library Builtins}, | |
| for details of the functions affected, | |
| including those which are not built-in functions when @option{-ansi} or | |
| @option{-std} options for strict ISO C conformance are used because they | |
| do not have an ISO standard meaning. | |
| GCC normally generates special code to handle certain built-in functions | |
| more efficiently; for instance, calls to @code{alloca} may become single | |
| instructions which adjust the stack directly, and calls to @code{memcpy} | |
| may become inline copy loops. The resulting code is often both smaller | |
| and faster, but since the function calls no longer appear as such, you | |
| cannot set a breakpoint on those calls, nor can you change the behavior | |
| of the functions by linking with a different library. In addition, | |
| when a function is recognized as a built-in function, GCC may use | |
| information about that function to warn about problems with calls to | |
| that function, or to generate more efficient code, even if the | |
| resulting code still contains calls to that function. For example, | |
| warnings are given with @option{-Wformat} for bad calls to | |
| @code{printf} when @code{printf} is built in and @code{strlen} is | |
| known not to modify global memory. | |
| With the @option{-fno-builtin-@var{function}} option | |
| only the built-in function @var{function} is | |
| disabled. @var{function} must not begin with @samp{__builtin_}. If a | |
| function is named that is not built-in in this version of GCC, this | |
| option is ignored. There is no corresponding | |
| @option{-fbuiltin-@var{function}} option; if you wish to enable | |
| built-in functions selectively when using @option{-fno-builtin} or | |
| @option{-ffreestanding}, you may define macros such as: | |
| @smallexample | |
| #define abs(n) __builtin_abs ((n)) | |
| #define strcpy(d, s) __builtin_strcpy ((d), (s)) | |
| @end smallexample | |
| @opindex fcond-mismatch | |
| @opindex fno-cond-mismatch | |
| @item -fcond-mismatch | |
| Allow conditional expressions with mismatched types in the second and | |
| third arguments. The value of such an expression is void. This option | |
| is not supported for C++. | |
| @opindex fdeps- | |
| @opindex fdeps-file | |
| @opindex fdeps-format | |
| @opindex fdeps-target | |
| @item -fdeps-file=@var{file} | |
| @itemx -fdeps-format=@var{format} | |
| @itemx -fdeps-target=@var{file} | |
| The @samp{-fdeps-*} options are used to extract structured dependency | |
| information for a source file. This involves determining what | |
| resources provided by other source files are required to compile | |
| the source as well as what resources are provided by the source. This | |
| information can be used to add required dependencies between | |
| compilation rules of dependent sources based on their contents rather | |
| than requiring such information be reflected within the build tools as | |
| well. | |
| @option{-fdeps-file=@var{file}} specifies where to write structured | |
| dependency information. | |
| @option{-fdeps-format=@var{format}} specifies the format to use for | |
| structured dependency information. | |
| @uref{https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p1689r5.html, | |
| @samp{p1689r5}} is the only supported format right now. | |
| Note that when this argument is specified, the | |
| output of @samp{-MF} is stripped of some information (namely C++ modules) so | |
| that it does not use extended makefile syntax not understood by most tools. | |
| @option{-fdeps-target=@var{file}} is analogous to @option{-MT}, | |
| but for structured dependency information. This | |
| indicates the target of the build rule for the source file | |
| that is currently being processed for dynamic dependencies, and is used to | |
| associate the dependency information with that target in the output. | |
| Normally this is the name of the @samp{.o} file generated during compilation. | |
| @opindex ffreestanding | |
| @opindex fno-freestanding | |
| @cindex hosted environment | |
| @item -ffreestanding | |
| Assert that compilation targets a freestanding environment. This | |
| implies @option{-fno-builtin}. A freestanding environment | |
| is one in which the standard library may not exist, and program startup may | |
| not necessarily be at @code{main}. The most obvious example is an OS kernel. | |
| This is equivalent to @option{-fno-hosted}. | |
| @xref{Standards,,Language Standards Supported by GCC}, for details of | |
| freestanding and hosted environments. | |
| @opindex fgimple | |
| @opindex fno-gimple | |
| @item -fgimple | |
| Enable parsing of function definitions marked with @code{__GIMPLE}. | |
| This is an experimental feature that allows unit testing of GIMPLE | |
| passes. | |
| @opindex fgnu-tm | |
| @opindex fno-gnu-tm | |
| @item -fgnu-tm | |
| When the option @option{-fgnu-tm} is specified, the compiler | |
| generates code for the Linux variant of Intel's current Transactional | |
| Memory ABI specification document (Revision 1.1, May 6 2009). This is | |
| an experimental feature whose interface may change in future versions | |
| of GCC, as the official specification changes. Please note that not | |
| all architectures are supported for this feature. | |
| For more information on GCC's support for transactional memory, | |
| @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU | |
| Transactional Memory Library}. | |
| Note that the transactional memory feature is not supported with | |
| non-call exceptions (@option{-fnon-call-exceptions}). | |
| @opindex fgnu89-inline | |
| @opindex fno-gnu89-inline | |
| @item -fgnu89-inline | |
| The option @option{-fgnu89-inline} tells GCC to use the traditional | |
| GNU semantics for @code{inline} functions when in C99 mode. | |
| @xref{Inline,,An Inline Function is As Fast As a Macro}. | |
| Using this option is roughly equivalent to adding the | |
| @code{gnu_inline} function attribute to all inline functions | |
| (@pxref{Common Attributes}). | |
| The option @option{-fno-gnu89-inline} explicitly tells GCC to use the | |
| C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it | |
| specifies the default behavior). | |
| This option is not supported in @option{-std=c90} or | |
| @option{-std=gnu90} mode. | |
| The preprocessor macros @code{__GNUC_GNU_INLINE__} and | |
| @code{__GNUC_STDC_INLINE__} may be used to check which semantics are | |
| in effect for @code{inline} functions. @xref{Common Predefined | |
| Macros,,,cpp,The C Preprocessor}. | |
| @opindex fhosted | |
| @opindex fno-hosted | |
| @cindex hosted environment | |
| @item -fhosted | |
| Assert that compilation targets a hosted environment. This implies | |
| @option{-fbuiltin}. A hosted environment is one in which the | |
| entire standard library is available, and in which @code{main} has a return | |
| type of @code{int}. Examples are nearly everything except a kernel. | |
| This is equivalent to @option{-fno-freestanding}. | |
| @opindex flax-vector-conversions | |
| @opindex fno-lax-vector-conversions | |
| @item -flax-vector-conversions | |
| Allow implicit conversions between vectors with differing numbers of | |
| elements and/or incompatible element types. This option should not be | |
| used for new code. | |
| @opindex fms-extensions | |
| @opindex fno-ms-extensions | |
| @item -fms-extensions | |
| Accept some non-standard constructs used in Microsoft header files. | |
| In C++ code, this allows member names in structures to be similar | |
| to previous types declarations. | |
| @smallexample | |
| typedef int UOW; | |
| struct ABC @{ | |
| UOW UOW; | |
| @}; | |
| @end smallexample | |
| Some cases of unnamed fields in structures and unions are only | |
| accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union | |
| fields within structs/unions}, for details. | |
| Note that this option is off for all targets except for x86 | |
| targets using ms-abi. | |
| @opindex fpermitted-flt-eval-methods | |
| @opindex fpermitted-flt-eval-methods=c11 | |
| @opindex fpermitted-flt-eval-methods=ts-18661-3 | |
| @item -fpermitted-flt-eval-methods=@var{style} | |
| ISO/IEC TS 18661-3 defines new permissible values for | |
| @code{FLT_EVAL_METHOD} that indicate that operations and constants with | |
| a semantic type that is an interchange or extended format should be | |
| evaluated to the precision and range of that type. These new values are | |
| a superset of those permitted under C99/C11, which does not specify the | |
| meaning of other positive values of @code{FLT_EVAL_METHOD}. As such, code | |
| conforming to C11 may not have been written expecting the possibility of | |
| the new values. | |
| @option{-fpermitted-flt-eval-methods} specifies whether the compiler | |
| should allow only the values of @code{FLT_EVAL_METHOD} specified in C99/C11, | |
| or the extended set of values specified in ISO/IEC TS 18661-3. | |
| @var{style} is either @code{c11} or @code{ts-18661-3} as appropriate. | |
| The default when in a standards compliant mode (@option{-std=c11} or similar) | |
| is @option{-fpermitted-flt-eval-methods=c11}. The default when in a GNU | |
| dialect (@option{-std=gnu11} or similar) is | |
| @option{-fpermitted-flt-eval-methods=ts-18661-3}. | |
| @opindex fplan9-extensions | |
| @opindex fno-plan9-extensions | |
| @item -fplan9-extensions | |
| Accept some non-standard constructs used in Plan 9 code. | |
| This enables @option{-fms-extensions}, permits passing pointers to | |
| structures with anonymous fields to functions that expect pointers to | |
| elements of the type of the field, and permits referring to anonymous | |
| fields declared using a typedef. @xref{Unnamed Fields,,Unnamed | |
| struct/union fields within structs/unions}, for details. This is only | |
| supported for C, not C++. | |
| @opindex fsigned-bitfields | |
| @opindex funsigned-bitfields | |
| @opindex fno-signed-bitfields | |
| @opindex fno-unsigned-bitfields | |
| @item -fsigned-bitfields | |
| @itemx -funsigned-bitfields | |
| @itemx -fno-signed-bitfields | |
| @itemx -fno-unsigned-bitfields | |
| These options control whether a bit-field is signed or unsigned, when the | |
| declaration does not use either @code{signed} or @code{unsigned}. By | |
| default, such a bit-field is signed, because this is consistent: the | |
| basic integer types such as @code{int} are signed types. | |
| @anchor{@code{char} type signedness} | |
| @cindex @code{char} type signedness | |
| @cindex signedness of @code{char} type | |
| @opindex fsigned-char | |
| @opindex fno-signed-char | |
| @opindex funsigned-char | |
| @opindex fno-unsigned-char | |
| @item -fsigned-char | |
| @itemx -funsigned-char | |
| @option{-fsigned-char} lets the type @code{char} be signed, | |
| like @code{signed char}, while @option{-funsigned-char} lets | |
| the type @code{char} be unsigned, like @code{unsigned char}. | |
| Note that @option{-fsigned-char} | |
| is equivalent to @option{-fno-unsigned-char}, which is | |
| the negative form of @option{-funsigned-char}. Likewise, the option | |
| @option{-fno-signed-char} is equivalent to @option{-funsigned-char}. | |
| Each target supported by GCC has a default for what @code{char} should | |
| be, which is typically specified in the processor-specific ABI | |
| document for that target. It is either like @code{unsigned char} by | |
| default or like @code{signed char} by default. | |
| Ideally, a portable program should always use @code{signed char} or | |
| @code{unsigned char} when it depends on the signedness of an object. | |
| But many programs have been written to use plain @code{char} and | |
| expect it to be signed, or expect it to be unsigned, depending on the | |
| machines they were written for. These options let you | |
| make such a program work with the opposite default. | |
| The type @code{char} is always a distinct type from each of | |
| @code{signed char} or @code{unsigned char}, even though its behavior | |
| is always just like one of those two. | |
| @opindex fsso-struct | |
| @item -fsso-struct=@var{endianness} | |
| Set the default scalar storage order of structures and unions to the | |
| specified endianness. The accepted values are @samp{big-endian}, | |
| @samp{little-endian} and @samp{native} for the native endianness of | |
| the target (the default). This option is not supported for C++. | |
| @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate | |
| code that is not binary compatible with code generated without it if the | |
| specified endianness is not the native endianness of the target. | |
| @opindex fstrict-flex-arrays | |
| @opindex fno-strict-flex-arrays | |
| @opindex fstrict-flex-arrays=@var{level} | |
| @item -fstrict-flex-arrays @r{(C and C++ only)} | |
| @itemx -fstrict-flex-arrays=@var{level} @r{(C and C++ only)} | |
| Control when to treat the trailing array of a structure as a flexible array | |
| member for the purpose of accessing the elements of such an array. The value | |
| of @var{level} controls the level of strictness. | |
| @option{-fstrict-flex-arrays} is equivalent to | |
| @option{-fstrict-flex-arrays=3}, which is the strictest; | |
| a trailing array is treated as a flexible array member only when | |
| it is declared as a flexible array member per C99 standard onwards. | |
| The negative form @option{-fno-strict-flex-arrays} is equivalent to | |
| @option{-fstrict-flex-arrays=0}, which is the least strict. In this | |
| case all trailing arrays of structures are treated as flexible array members. | |
| There are two more levels in between 0 and 3, which are provided to | |
| support older code that uses the GCC zero-length array extension | |
| (@samp{[0]}) or one-element array as flexible array members | |
| (@samp{[1]}). When @var{level} is 1, the trailing array is treated as | |
| a flexible array member when it is declared as either @samp{[]}, | |
| @samp{[0]}, or @samp{[1]}. When @var{level} is 2, the trailing array | |
| is treated as a flexible array member when it is declared as either | |
| @samp{[]}, or @samp{[0]}. | |
| You can control this behavior for a specific trailing array field of a | |
| structure by using the variable attribute @code{strict_flex_array} attribute | |
| (@pxref{Common Attributes}). | |
| The @option{-fstrict_flex_arrays} option interacts with the | |
| @option{-Wstrict-flex-arrays} option. @xref{Warning Options}, for more | |
| information. | |
| @end table | |
| @node C++ Dialect Options | |
| @section Options Controlling C++ Dialect | |
| @cindex compiler options, C++ | |
| @cindex C++ options, command-line | |
| @cindex options, C++ | |
| This section describes the command-line options that are only meaningful | |
| for C++ programs. You can also use most of the GNU compiler options | |
| regardless of what language your program is in. For example, you | |
| might compile a file @file{firstClass.C} like this: | |
| @smallexample | |
| g++ -g -fstrict-enums -O -c firstClass.C | |
| @end smallexample | |
| @noindent | |
| In this example, only @option{-fstrict-enums} is an option meant | |
| only for C++ programs; you can use the other options with any | |
| language supported by GCC@. | |
| Some options for compiling C programs, such as @option{-std}, are also | |
| relevant for C++ programs. | |
| @xref{C Dialect Options,,Options Controlling C Dialect}. | |
| Here is a list of options that are @emph{only} for compiling C++ programs: | |
| @table @gcctabopt | |
| @opindex compile-std-module | |
| @item --compile-std-module | |
| Build the compiled module interfaces (@pxref{C++ Modules}) for the | |
| @samp{<bits/stdc++.h>} header unit and the @samp{std} and | |
| @samp{std.compat} modules before compiling any source files explicitly | |
| specified on the command line. This is intended to be useful for | |
| building simple programs that use @samp{import std;} with a single | |
| command. | |
| @opindex fabi-version | |
| @item -fabi-version=@var{n} | |
| Use version @var{n} of the C++ ABI@. The default is version 0. | |
| Version 0 refers to the version conforming most closely to | |
| the C++ ABI specification. Therefore, the ABI obtained using version 0 | |
| will change in different versions of G++ as ABI bugs are fixed. | |
| Version 1 is the version of the C++ ABI that first appeared in G++ 3.2. | |
| Version 2 is the version of the C++ ABI that first appeared in G++ | |
| 3.4, and was the default through G++ 4.9. | |
| Version 3 corrects an error in mangling a constant address as a | |
| template argument. | |
| Version 4, which first appeared in G++ 4.5, implements a standard | |
| mangling for vector types. | |
| Version 5, which first appeared in G++ 4.6, corrects the mangling of | |
| attribute const/volatile on function pointer types, decltype of a | |
| plain decl, and use of a function parameter in the declaration of | |
| another parameter. | |
| Version 6, which first appeared in G++ 4.7, corrects the promotion | |
| behavior of C++11 scoped enums and the mangling of template argument | |
| packs, const/static_cast, prefix ++ and --, and a class scope function | |
| used as a template argument. | |
| Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a | |
| builtin type and corrects the mangling of lambdas in default argument | |
| scope. | |
| Version 8, which first appeared in G++ 4.9, corrects the substitution | |
| behavior of function types with function-cv-qualifiers. | |
| Version 9, which first appeared in G++ 5.2, corrects the alignment of | |
| @code{nullptr_t}. | |
| Version 10, which first appeared in G++ 6.1, adds mangling of | |
| attributes that affect type identity, such as ia32 calling convention | |
| attributes (e.g.@: @samp{stdcall}). | |
| Version 11, which first appeared in G++ 7, corrects the mangling of | |
| sizeof... expressions and operator names. For multiple entities with | |
| the same name within a function, that are declared in different scopes, | |
| the mangling now changes starting with the twelfth occurrence. It also | |
| implies @option{-fnew-inheriting-ctors}. | |
| Version 12, which first appeared in G++ 8, corrects the calling | |
| conventions for empty classes on the x86_64 target and for classes | |
| with only deleted copy/move constructors. It accidentally changes the | |
| calling convention for classes with a deleted copy constructor and a | |
| trivial move constructor. | |
| Version 13, which first appeared in G++ 8.2, fixes the accidental | |
| change in version 12. | |
| Version 14, which first appeared in G++ 10, corrects the mangling of | |
| the nullptr expression. | |
| Version 15, which first appeared in G++ 10.3, corrects G++ 10 ABI | |
| tag regression. | |
| Version 16, which first appeared in G++ 11, changes the mangling of | |
| @code{__alignof__} to be distinct from that of @code{alignof}, and | |
| dependent operator names. | |
| Version 17, which first appeared in G++ 12, fixes layout of classes | |
| that inherit from aggregate classes with default member initializers | |
| in C++14 and up. | |
| Version 18, which first appeared in G++ 13, fixes manglings of lambdas | |
| that have additional context. | |
| Version 19, which first appeared in G++ 14, fixes manglings of | |
| structured bindings to include ABI tags, handling of cv-qualified | |
| [[no_unique_address]] members, and adds mangling of C++20 constraints | |
| on function templates. | |
| Version 20, which first appeared in G++ 15, fixes manglings of lambdas | |
| in static data member initializers. | |
| Version 21, which first appeared in G++ 16, fixes unnecessary captures | |
| in noexcept lambdas (c++/119764), layout of a base class with all explicitly | |
| defaulted constructors (c++/120012), and mangling of class and array | |
| objects with implicitly zero-initialized non-trailing subobjects (c++/121231). | |
| See also @option{-Wabi}. | |
| @opindex fabi-compat-version | |
| @item -fabi-compat-version=@var{n} | |
| On targets that support strong aliases, G++ | |
| works around mangling changes by creating an alias with the correct | |
| mangled name when defining a symbol with an incorrect mangled name. | |
| This switch specifies which ABI version to use for the alias. | |
| With @option{-fabi-version=0} (the default), this defaults to 13 (GCC 8.2 | |
| compatibility). If another ABI version is explicitly selected, this | |
| defaults to 0. For compatibility with GCC versions 3.2 through 4.9, | |
| use @option{-fabi-compat-version=2}. | |
| If this option is not provided but @option{-Wabi=@var{n}} is, that | |
| version is used for compatibility aliases. If this option is provided | |
| along with @option{-Wabi} (without the version), the version from this | |
| option is used for the warning. | |
| @opindex fno-access-control | |
| @opindex faccess-control | |
| @item -fno-access-control | |
| Turn off all access checking. This switch is mainly useful for working | |
| around bugs in the access control code. | |
| @opindex faligned-new | |
| @opindex fno-aligned-new | |
| @item -faligned-new | |
| @itemx -faligned-new=@var{alignment} | |
| Enable support for C++17 @code{new} of types that require more | |
| alignment than @code{void* ::operator new(std::size_t)} provides. A | |
| numeric argument such as @code{-faligned-new=32} can be used to | |
| specify how much alignment (in bytes) is provided by that function, | |
| but few users will need to override the default of | |
| @code{alignof(std::max_align_t)}. | |
| This flag is enabled by default for @option{-std=c++17}. | |
| @opindex fno-assume-sane-operators-new-delete | |
| @opindex fassume-sane-operators-new-delete | |
| @item -fno-assume-sane-operators-new | |
| The C++ standard allows replacing the global @code{new}, @code{new[]}, | |
| @code{delete} and @code{delete[]} operators, though a lot of C++ programs | |
| don't replace them and just use the implementation provided version. | |
| Furthermore, the C++ standard allows omitting those calls if they are | |
| made from new or delete expressions (and by extension the same is | |
| assumed if @code{__builtin_operator_new} or @code{__builtin_operator_delete} | |
| functions are used). | |
| This option allows control over some optimizations around calls | |
| to those operators. | |
| With @code{-fassume-sane-operators-new-delete} option GCC may assume that | |
| calls to the replaceable global operators from new or delete expressions or | |
| from @code{__builtin_operator_new} or @code{__builtin_operator_delete} calls | |
| don't read or modify any global variables or variables whose address could | |
| escape to the operators (global state; except for @code{errno} for the | |
| @code{new} and @code{new[]} operators). | |
| This allows most optimizations across those calls and is something that | |
| the implementation provided operators satisfy unless @code{malloc} | |
| implementation details are observable in the code or unless @code{malloc} | |
| hooks are used, but might not be satisfied if a program replaces those | |
| operators. This behavior is enabled by default. | |
| With @code{-fno-assume-sane-operators-new-delete} option GCC must | |
| assume all these calls (whether from new or delete expressions or called | |
| directly) may read and write global state unless proven otherwise (e.g.@: | |
| when GCC compiles their implementation). Use this option if those | |
| operators are or may be replaced and code needs to expect such behavior. | |
| @opindex fchar8_t | |
| @opindex fno-char8_t | |
| @item -fchar8_t | |
| @itemx -fno-char8_t | |
| Enable support for @code{char8_t} as adopted for C++20. This includes | |
| the addition of a new @code{char8_t} fundamental type, changes to the | |
| types of UTF-8 string and character literals, new signatures for | |
| user-defined literals, associated standard library updates, and new | |
| @code{__cpp_char8_t} and @code{__cpp_lib_char8_t} feature test macros. | |
| This option enables functions to be overloaded for ordinary and UTF-8 | |
| strings: | |
| @smallexample | |
| int f(const char *); // #1 | |
| int f(const char8_t *); // #2 | |
| int v1 = f("text"); // Calls #1 | |
| int v2 = f(u8"text"); // Calls #2 | |
| @end smallexample | |
| @noindent | |
| and introduces new signatures for user-defined literals: | |
| @smallexample | |
| int operator""_udl1(char8_t); | |
| int v3 = u8'x'_udl1; | |
| int operator""_udl2(const char8_t*, std::size_t); | |
| int v4 = u8"text"_udl2; | |
| template<typename T, T...> int operator""_udl3(); | |
| int v5 = u8"text"_udl3; | |
| @end smallexample | |
| @noindent | |
| The change to the types of UTF-8 string and character literals introduces | |
| incompatibilities with ISO C++11 and later standards. For example, the | |
| following code is well-formed under ISO C++11, but is ill-formed when | |
| @option{-fchar8_t} is specified. | |
| @smallexample | |
| const char *cp = u8"xx";// error: invalid conversion from | |
| // `const char8_t*' to `const char*' | |
| int f(const char*); | |
| auto v = f(u8"xx"); // error: invalid conversion from | |
| // `const char8_t*' to `const char*' | |
| std::string s@{u8"xx"@}; // error: no matching function for call to | |
| // `std::basic_string<char>::basic_string()' | |
| using namespace std::literals; | |
| s = u8"xx"s; // error: conversion from | |
| // `basic_string<char8_t>' to non-scalar | |
| // type `basic_string<char>' requested | |
| @end smallexample | |
| @opindex fcheck-new | |
| @opindex fno-check-new | |
| @item -fcheck-new | |
| Check that the pointer returned by @code{operator new} is non-null | |
| before attempting to modify the storage allocated. This check is | |
| normally unnecessary because the C++ standard specifies that | |
| @code{operator new} only returns @code{0} if it is declared | |
| @code{throw()}, in which case the compiler always checks the | |
| return value even without this option. In all other cases, when | |
| @code{operator new} has a non-empty exception specification, memory | |
| exhaustion is signalled by throwing @code{std::bad_alloc}. See also | |
| @samp{new (nothrow)}. | |
| @opindex fconcepts | |
| @opindex fno-concepts | |
| @item -fconcepts | |
| Enable support for the C++ Concepts feature for constraining template | |
| arguments. With @option{-std=c++20} and above, Concepts are part of | |
| the language standard, so @option{-fconcepts} defaults to on. | |
| Some constructs that were allowed by the earlier C++ Extensions for | |
| Concepts Technical Specification, ISO 19217 (2015), but didn't make it | |
| into the standard, could additionally be enabled by | |
| @option{-fconcepts-ts}. The option @option{-fconcepts-ts} was deprecated | |
| in GCC 14 and removed in GCC 15; users are expected to convert their code | |
| to C++20 concepts. | |
| @opindex fconcepts-diagnostics-depth | |
| @item -fconcepts-diagnostics-depth=@var{n} | |
| Specify maximum error replay depth during recursive diagnosis of a constraint | |
| satisfaction failure. The default is 1. | |
| @opindex fconstexpr-depth | |
| @item -fconstexpr-depth=@var{n} | |
| Set the maximum nested evaluation depth for C++11 constexpr functions | |
| to @var{n}. A limit is needed to detect endless recursion during | |
| constant expression evaluation. The minimum specified by the standard | |
| is 512. | |
| @opindex fconstexpr-cache-depth | |
| @item -fconstexpr-cache-depth=@var{n} | |
| Set the maximum level of nested evaluation depth for C++11 constexpr | |
| functions that will be cached to @var{n}. This is a heuristic that | |
| trades off compilation speed (when the cache avoids repeated | |
| calculations) against memory consumption (when the cache grows very | |
| large from highly recursive evaluations). The default is 8. Very few | |
| users are likely to want to adjust it, but if your code does heavy | |
| constexpr calculations you might want to experiment to find which | |
| value works best for you. | |
| @opindex fconstexpr-fp-except | |
| @opindex fno-constexpr-fp-except | |
| @item -fconstexpr-fp-except | |
| Annex F of the C standard specifies that IEC559 floating point | |
| exceptions encountered at compile time should not stop compilation. | |
| C++ compilers have historically not followed this guidance, instead | |
| treating floating point division by zero as non-constant even though | |
| it has a well defined value. This flag tells the compiler to give | |
| Annex F priority over other rules saying that a particular operation | |
| is undefined. | |
| @smallexample | |
| constexpr float inf = 1./0.; // OK with -fconstexpr-fp-except | |
| @end smallexample | |
| @opindex fconstexpr-loop-limit | |
| @item -fconstexpr-loop-limit=@var{n} | |
| Set the maximum number of iterations for a loop in C++14 constexpr functions | |
| to @var{n}. A limit is needed to detect infinite loops during | |
| constant expression evaluation. The default is 262144 (1<<18). | |
| @opindex fconstexpr-ops-limit | |
| @item -fconstexpr-ops-limit=@var{n} | |
| Set the maximum number of operations during a single constexpr evaluation. | |
| Even when number of iterations of a single loop is limited with the above limit, | |
| if there are several nested loops and each of them has many iterations but still | |
| smaller than the above limit, or if in a body of some loop or even outside | |
| of a loop too many expressions need to be evaluated, the resulting constexpr | |
| evaluation might take too long. | |
| The default is 33554432 (1<<25). | |
| @opindex fcontracts | |
| @opindex fno-contracts | |
| @item -fcontracts | |
| Enable support for the C++ Contracts feature, as specified in the C++26 | |
| working draft (N5003). | |
| On violation of an enforced or observed contract (see @option{-fcontract-evaluation-semantic} | |
| below), a violation handler is called; the standard library provides a default | |
| handler that emits information about the contract that failed. | |
| Users can replace the default violation handler by defining | |
| @smallexample | |
| void | |
| handle_contract_violation (const std::contracts::contract_violation&); | |
| @end smallexample | |
| @opindex fcontract-evaluation-semantic | |
| @item -fcontract-evaluation-semantic=@var{semantic} | |
| Set the semantic with which contracts will be evaluated to @var{semantic}. | |
| Available values for the evaluation mode are: | |
| '@code{ignored}' The contract checks will be elided, with no checking added at | |
| either compile or runtime. | |
| '@code{observed}' The contract checks are performed (at runtime) and, if one | |
| fails, a handler is called that allows actions such as logging or emitting | |
| run-time warnings. When the handler returns, the execution of the code will | |
| continue. At compile-time the checks are performed for @code{constexpr} | |
| evaluations, in this case a diagnostic is emitted if the check fails. | |
| '@code{enforce}' The contract checks are performed and the handler is called if | |
| one fails. When the handler returns the execution of the code is terminated | |
| preventing it from continuing past the failed case. At compile-time the checks | |
| are applied to @code{constexpr} and, if one fails, the program is ill-formed; | |
| an error will be emitted. | |
| '@code{quick_enforce}' The contract checks are performed (at runtime) and, if one | |
| fails, the execution is terminated immediately (without calling any handler). | |
| At compile-time there is no difference in behaviour between this option and | |
| the @code{enforce} case, since no handler is invoked at compile time. | |
| @opindex fcontracts-conservative-ipa | |
| @opindex fno-contracts-conservative-ipa | |
| @item -fcontracts-conservative-ipa | |
| This prevents inter-procedural analysis from taking action when the body | |
| of an inline function is visible in a given TU. This allows for the case | |
| that contract evaluation conditions are permitted to differ between TUs which | |
| means that such actions would be potentially incorrect. | |
| @opindex fcontract-checks-outlined | |
| @opindex fno-contract-checks-outlined | |
| @item -fcontract-checks-outlined | |
| By default, contract checks for @code{pre} and @code{post} condition checks are | |
| expanded in-line into function bodies. This option causes a small function to | |
| be created instead (containing the checks) that is called in the relevant | |
| position. This permits different criteria to be applied to the compilation of | |
| the checking and the remainder of the function body. | |
| @opindex fcontract-disable-optimized-checks | |
| @opindex fno-contract-disable-optimized-checks | |
| @item -fcontract-disable-optimized-checks | |
| When @code{pre} and @code{post} condition checks are outlined (using | |
| @option{-fcontract-checks-outlined}), this option disables the optimisation | |
| steps for those functions which can avoid unwanted elision of checking steps. | |
| @opindex fcontracts-client-check | |
| @item -fcontracts-client-check=@var{mode} | |
| This option enables insertion of checks at call sites (caller-side checking). | |
| The value of @var{mode} determines which contract checks are made: | |
| '@code{none}' No caller/client side checking (default) | |
| '@code{pre}' Preconditions are checked at the caller/client side. | |
| '@code{all}' Both pre and post-conditions are checked at the caller/client side. | |
| @opindex fcontracts-definition-check | |
| @item -fcontracts-definition-check=@var{mode} | |
| This option introduces the ability to disable callee/definition-side checks, | |
| which are otherwise enabled by default when the contracts feature is active. | |
| The variable @var{mode} has the values '@code{on}' and '@code{off}'. | |
| @opindex fcoroutines | |
| @opindex fno-coroutines | |
| @item -fcoroutines | |
| Enable support for the C++ coroutines extension. With @option{-std=c++20} | |
| and above, coroutines are part of the language standard, so | |
| @option{-fcoroutines} defaults to on. | |
| @opindex fdiagnostics-all-candidates | |
| @opindex fno-diagnostics-all-candidates | |
| @item -fdiagnostics-all-candidates | |
| Permit the C++ front end to note all candidates during overload resolution | |
| failure, including when a deleted function is selected. | |
| @item -fdump-lang- | |
| @itemx -fdump-lang-@var{switch} | |
| @itemx -fdump-lang-@var{switch}-@var{options} | |
| @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename} | |
| Control the dumping of C++-specific information. The @var{options} | |
| and @var{filename} portions behave as described in the | |
| @option{-fdump-tree} option. The following @var{switch} values are | |
| accepted: | |
| @table @samp | |
| @item all | |
| Enable all of the below. | |
| @opindex fdump-lang-class | |
| @item class | |
| Dump class hierarchy information. Virtual table information is emitted | |
| unless '@option{slim}' is specified. | |
| @opindex fdump-lang-module | |
| @item module | |
| Dump module information. Options @option{lineno} (locations), | |
| @option{graph} (reachability), @option{blocks} (clusters), | |
| @option{uid} (serialization), @option{alias} (mergeable), | |
| @option{asmname} (Elrond), @option{eh} (mapper) & @option{vops} | |
| (macros) may provide additional information. | |
| @opindex fdump-lang-raw | |
| @item raw | |
| Dump the raw internal tree data. | |
| @opindex fdump-lang-tinst | |
| @item tinst | |
| Dump the sequence of template instantiations, indented to show the | |
| depth of recursion. The @option{lineno} option adds the source | |
| location where the instantiation was triggered, and the | |
| @option{details} option also dumps pre-instantiation substitutions | |
| such as those performed during template argument deduction. | |
| Lines in the .tinst dump start with @samp{I} for an instantiation, | |
| @samp{S} for another substitution, and @samp{R[IS]} for the reopened | |
| context of a deferred instantiation. | |
| @end table | |
| @opindex fno-elide-constructors | |
| @opindex felide-constructors | |
| @item -fno-elide-constructors | |
| The C++ standard allows an implementation to omit creating a temporary | |
| that is only used to initialize another object of the same type. | |
| Specifying this option disables that optimization, and forces G++ to | |
| call the copy constructor in all cases. This option also causes G++ | |
| to call trivial member functions which otherwise would be expanded inline. | |
| In C++17, the compiler is required to omit these temporaries, but this | |
| option still affects trivial member functions. | |
| @opindex fno-enforce-eh-specs | |
| @opindex fenforce-eh-specs | |
| @item -fno-enforce-eh-specs | |
| Don't generate code to check for violation of exception specifications | |
| at run time. This option violates the C++ standard, but may be useful | |
| for reducing code size in production builds, much like defining | |
| @code{NDEBUG}. This does not give user code permission to throw | |
| exceptions in violation of the exception specifications; the compiler | |
| still optimizes based on the specifications, so throwing an | |
| unexpected exception results in undefined behavior at run time. | |
| @opindex fextern-tls-init | |
| @opindex fno-extern-tls-init | |
| @item -fextern-tls-init | |
| @itemx -fno-extern-tls-init | |
| The C++11 and OpenMP standards allow @code{thread_local} and | |
| @code{threadprivate} variables to have dynamic (runtime) | |
| initialization. To support this, any use of such a variable goes | |
| through a wrapper function that performs any necessary initialization. | |
| When the use and definition of the variable are in the same | |
| translation unit, this overhead can be optimized away, but when the | |
| use is in a different translation unit there is significant overhead | |
| even if the variable doesn't actually need dynamic initialization. If | |
| the programmer can be sure that no use of the variable in a | |
| non-defining TU needs to trigger dynamic initialization (either | |
| because the variable is statically initialized, or a use of the | |
| variable in the defining TU will be executed before any uses in | |
| another TU), they can avoid this overhead with the | |
| @option{-fno-extern-tls-init} option. | |
| On targets that support symbol aliases, the default is | |
| @option{-fextern-tls-init}. On targets that do not support symbol | |
| aliases, the default is @option{-fno-extern-tls-init}. | |
| @opindex ffold-simple-inlines | |
| @opindex fno-fold-simple-inlines | |
| @item -ffold-simple-inlines | |
| @itemx -fno-fold-simple-inlines | |
| Permit the C++ frontend to fold calls to @code{std::move}, @code{std::forward}, | |
| @code{std::addressof}, @code{std::to_underlying} | |
| and @code{std::as_const}. In contrast to inlining, this | |
| means no debug information will be generated for such calls. Since these | |
| functions are rarely interesting to debug, this flag is enabled by default | |
| unless @option{-fno-inline} is active. | |
| @opindex fno-gnu-keywords | |
| @opindex fgnu-keywords | |
| @item -fno-gnu-keywords | |
| Do not recognize @code{typeof} as a keyword, so that code can use this | |
| word as an identifier. You can use the keyword @code{__typeof__} instead. | |
| This option is implied by the strict ISO C++ dialects: @option{-ansi}, | |
| @option{-std=c++98}, @option{-std=c++11}, etc. | |
| @opindex fno-immediate-escalation | |
| @opindex fimmediate-escalation | |
| @item -fno-immediate-escalation | |
| Do not enable immediate function escalation whereby certain functions | |
| can be promoted to consteval, as specified in P2564R3. For example: | |
| @example | |
| consteval int id(int i) @{ return i; @} | |
| constexpr int f(auto t) | |
| @{ | |
| return t + id(t); // id causes f<int> to be promoted to consteval | |
| @} | |
| void g(int i) | |
| @{ | |
| f (3); | |
| @} | |
| @end example | |
| compiles in C++20: @code{f} is an immediate-escalating function (due to | |
| the @code{auto} it is a function template and is declared @code{constexpr}) | |
| and @code{id(t)} is an immediate-escalating expression, so @code{f} is | |
| promoted to @code{consteval}. Consequently, the call to @code{id(t)} | |
| is in an immediate context, so doesn't have to produce a constant (that | |
| is the mechanism allowing consteval function composition). However, | |
| with @option{-fno-immediate-escalation}, @code{f} is not promoted to | |
| @code{consteval}, and since the call to consteval function @code{id(t)} | |
| is not a constant expression, the compiler rejects the code. | |
| This option is turned on by default; it is only effective in C++20 mode | |
| or later. | |
| @opindex fimplicit-constexpr | |
| @opindex fno-implicit-constexpr | |
| @item -fimplicit-constexpr | |
| Make inline functions implicitly constexpr, if they satisfy the | |
| requirements for a constexpr function. This option can be used in | |
| C++14 mode or later. This can result in initialization changing from | |
| dynamic to static and other optimizations. | |
| @opindex fno-implicit-templates | |
| @opindex fimplicit-templates | |
| @item -fno-implicit-templates | |
| Never emit code for non-inline templates that are instantiated | |
| implicitly (i.e.@: by use); only emit code for explicit instantiations. | |
| If you use this option, you must take care to structure your code to | |
| include all the necessary explicit instantiations to avoid getting | |
| undefined symbols at link time. | |
| @xref{Template Instantiation}, for more information. | |
| @opindex fno-implicit-inline-templates | |
| @opindex fimplicit-inline-templates | |
| @item -fno-implicit-inline-templates | |
| Don't emit code for implicit instantiations of inline templates, either. | |
| The default is to handle inlines differently so that compiles with and | |
| without optimization need the same set of explicit instantiations. | |
| @opindex fno-implement-inlines | |
| @opindex fimplement-inlines | |
| @item -fno-implement-inlines | |
| To save space, do not emit out-of-line copies of inline functions | |
| controlled by @code{#pragma implementation}. This causes linker | |
| errors if these functions are not inlined everywhere they are called. | |
| @opindex fmodules | |
| @opindex fno-modules | |
| @item -fmodules | |
| @itemx -fno-modules | |
| Enable support for C++20 modules (@pxref{C++ Modules}). The | |
| @option{-fno-modules} is usually not needed, as that is the | |
| default. Even though this is a C++20 feature, it is not currently | |
| implicitly enabled by selecting that standard version. | |
| @opindex fmodule-header | |
| @item -fmodule-header | |
| @itemx -fmodule-header=user | |
| @itemx -fmodule-header=system | |
| Compile a header file to create an importable header unit. | |
| @opindex fmodule-implicit-inline | |
| @opindex fno-module-implicit-inline | |
| @item -fmodule-implicit-inline | |
| Member functions defined in their class definitions are not implicitly | |
| inline for modular code. This is different to traditional C++ | |
| behavior, for good reasons. However, it may result in a difficulty | |
| during code porting. This option makes such function definitions | |
| implicitly inline. It does however generate an ABI incompatibility, | |
| so you must use it everywhere or nowhere. (Such definitions outside | |
| of a named module remain implicitly inline, regardless.) | |
| @opindex fmodule-include-translate | |
| @opindex fno-module-include-translate | |
| @item -fno-module-include-translate | |
| Do not treat #include of a header with a corresponding compiled header | |
| unit as import. | |
| @opindex fno-module-lazy | |
| @opindex fmodule-lazy | |
| @item -fno-module-lazy | |
| Disable lazy module importing and module mapper creation. | |
| @vindex CXX_MODULE_MAPPER @r{environment variable} | |
| @opindex fmodule-mapper | |
| @item -fmodule-mapper=@r{[}@var{hostname}@r{]}:@var{port}@r{[}?@var{ident}@r{]} | |
| @itemx -fmodule-mapper=|@var{program}@r{[}?@var{ident}@r{]} @var{args...} | |
| @itemx -fmodule-mapper==@var{socket}@r{[}?@var{ident}@r{]} | |
| @itemx -fmodule-mapper=<>@r{[}@var{inout}@r{]}@r{[}?@var{ident}@r{]} | |
| @itemx -fmodule-mapper=<@var{in}>@var{out}@r{[}?@var{ident}@r{]} | |
| @itemx -fmodule-mapper=@var{file}@r{[}?@var{ident}@r{]} | |
| An oracle to query for module name to filename mappings. If | |
| unspecified the @env{CXX_MODULE_MAPPER} environment variable is used, | |
| and if that is unset, an in-process default is provided. | |
| @opindex fmodule-only | |
| @item -fmodule-only | |
| Only emit the Compiled Module Interface, inhibiting any object file. | |
| @opindex fms-extensions | |
| @opindex fno-ms-extensions | |
| @item -fms-extensions | |
| Disable Wpedantic warnings about constructs used in MFC, such as implicit | |
| int and getting a pointer to member function via non-standard syntax. | |
| @opindex fnew-inheriting-ctors | |
| @opindex fno-new-inheriting-ctors | |
| @item -fnew-inheriting-ctors | |
| Enable the P0136 adjustment to the semantics of C++11 constructor | |
| inheritance. This is part of C++17 but also considered to be a Defect | |
| Report against C++11 and C++14. This flag is enabled by default | |
| unless @option{-fabi-version=10} or lower is specified. | |
| @opindex fnew-ttp-matching | |
| @opindex fno-new-ttp-matching | |
| @item -fnew-ttp-matching | |
| Enable the P0522 resolution to Core issue 150, template template | |
| parameters and default arguments: this allows a template with default | |
| template arguments as an argument for a template template parameter | |
| with fewer template parameters. This flag is enabled by default for | |
| @option{-std=c++17}. | |
| @opindex fno-nonansi-builtins | |
| @opindex fnonansi-builtins | |
| @item -fno-nonansi-builtins | |
| Disable built-in declarations of functions that are not mandated by | |
| ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit}, | |
| @code{index}, @code{bzero}, @code{conjf}, and other related functions. | |
| @opindex fnothrow-opt | |
| @opindex fno-nothrow-opt | |
| @item -fnothrow-opt | |
| Treat a @code{throw()} exception specification as if it were a | |
| @code{noexcept} specification to reduce or eliminate the text size | |
| overhead relative to a function with no exception specification. If | |
| the function has local variables of types with non-trivial | |
| destructors, the exception specification actually makes the | |
| function smaller because the EH cleanups for those variables can be | |
| optimized away. The semantic effect is that an exception thrown out of | |
| a function with such an exception specification results in a call | |
| to @code{terminate} rather than @code{unexpected}. | |
| @opindex fno-operator-names | |
| @opindex foperator-names | |
| @item -fno-operator-names | |
| Do not treat the operator name keywords @code{and}, @code{bitand}, | |
| @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as | |
| synonyms as keywords. | |
| @opindex fno-optional-diags | |
| @opindex foptional-diags | |
| @item -fno-optional-diags | |
| Disable diagnostics that the standard says a compiler does not need to | |
| issue. Currently, the only such diagnostic issued by G++ is the one for | |
| a name having multiple meanings within a class. | |
| @opindex fno-pretty-templates | |
| @opindex fpretty-templates | |
| @item -fno-pretty-templates | |
| When an error message refers to a specialization of a function | |
| template, the compiler normally prints the signature of the | |
| template followed by the template arguments and any typedefs or | |
| typenames in the signature (e.g.@: @code{void f(T) [with T = int]} | |
| rather than @code{void f(int)}) so that it's clear which template is | |
| involved. When an error message refers to a specialization of a class | |
| template, the compiler omits any template arguments that match | |
| the default template arguments for that template. If either of these | |
| behaviors make it harder to understand the error message rather than | |
| easier, you can use @option{-fno-pretty-templates} to disable them. | |
| @opindex frange-for-ext-temps | |
| @opindex fno-range-for-ext-temps | |
| @item -frange-for-ext-temps | |
| Enable lifetime extension of C++ range based for temporaries. | |
| With @option{-std=c++23} and above this is part of the language standard, | |
| so lifetime of the temporaries is extended until the end of the loop | |
| by default. This option allows enabling that behavior also | |
| in earlier versions of the standard. | |
| @opindex freflection | |
| @item -freflection | |
| Enable experimental C++26 Reflection. | |
| @opindex fno-rtti | |
| @opindex frtti | |
| @item -fno-rtti | |
| Disable generation of information about every class with virtual | |
| functions for use by the C++ run-time type identification features | |
| (@code{dynamic_cast} and @code{typeid}). If you don't use those parts | |
| of the language, you can save some space by using this flag. Note that | |
| exception handling uses the same information, but G++ generates it as | |
| needed. The @code{dynamic_cast} operator can still be used for casts that | |
| do not require run-time type information, i.e.@: casts to @code{void *} or to | |
| unambiguous base classes. | |
| Mixing code compiled with @option{-frtti} with that compiled with | |
| @option{-fno-rtti} may not work. For example, programs may | |
| fail to link if a class compiled with @option{-fno-rtti} is used as a base | |
| for a class compiled with @option{-frtti}. | |
| @opindex fsized-deallocation | |
| @opindex fno-sized-deallocation | |
| @item -fsized-deallocation | |
| Enable the built-in global declarations | |
| @smallexample | |
| void operator delete (void *, std::size_t) noexcept; | |
| void operator delete[] (void *, std::size_t) noexcept; | |
| @end smallexample | |
| as introduced in C++14. This is useful for user-defined replacement | |
| deallocation functions that, for example, use the size of the object | |
| to make deallocation faster. Enabled by default under | |
| @option{-std=c++14} and above. The flag @option{-Wsized-deallocation} | |
| warns about places that might want to add a definition. | |
| @opindex fstrict-enums | |
| @opindex fno-strict-enums | |
| @item -fstrict-enums | |
| Allow the compiler to optimize using the assumption that a value of | |
| enumerated type can only be one of the values of the enumeration (as | |
| defined in the C++ standard; basically, a value that can be | |
| represented in the minimum number of bits needed to represent all the | |
| enumerators). This assumption may not be valid if the program uses a | |
| cast to convert an arbitrary integer value to the enumerated type. | |
| This option has no effect for an enumeration type with a fixed underlying | |
| type. | |
| @opindex fstrong-eval-order | |
| @opindex fno-strong-eval-order | |
| @item -fstrong-eval-order | |
| @itemx -fstrong-eval-order=@var{kind} | |
| Evaluate member access, array subscripting, and shift expressions in | |
| left-to-right order, and evaluate assignment in right-to-left order, | |
| as adopted for C++17. @option{-fstrong-eval-order} is equivalent to | |
| @option{-fstrong-eval-order=all}, | |
| and is enabled by default with @option{-std=c++17} or later. | |
| @option{-fstrong-eval-order=some} enables just the ordering of member | |
| access and shift expressions, and is the default for C++ dialects prior to | |
| C++17. | |
| @option{-fstrong-eval-order=none} is equivalent to | |
| @option{-fno-strong-eval-order}. | |
| @opindex ftemplate-backtrace-limit | |
| @item -ftemplate-backtrace-limit=@var{n} | |
| Set the maximum number of template instantiation notes for a single | |
| warning or error to @var{n}. The default value is 10. | |
| @opindex ftemplate-depth | |
| @item -ftemplate-depth=@var{n} | |
| Set the maximum instantiation depth for template classes to @var{n}. | |
| A limit on the template instantiation depth is needed to detect | |
| endless recursions during template class instantiation. ANSI/ISO C++ | |
| conforming programs must not rely on a maximum depth greater than 17 | |
| (changed to 1024 in C++11). The default value is 900, as the compiler | |
| can run out of stack space before hitting 1024 in some situations. | |
| @opindex fno-threadsafe-statics | |
| @opindex fthreadsafe-statics | |
| @item -fno-threadsafe-statics | |
| Do not emit the extra code to use the routines specified in the C++ | |
| ABI for thread-safe initialization of local statics. You can use this | |
| option to reduce code size slightly in code that doesn't need to be | |
| thread-safe. | |
| @opindex fuse-cxa-atexit | |
| @opindex fno-use-cxa-atexit | |
| @item -fuse-cxa-atexit | |
| Register destructors for objects with static storage duration with the | |
| @code{__cxa_atexit} function rather than the @code{atexit} function. | |
| This option is required for fully standards-compliant handling of static | |
| destructors, but only works if your C library supports | |
| @code{__cxa_atexit}. | |
| @opindex fno-use-cxa-get-exception-ptr | |
| @opindex fuse-cxa-get-exception-ptr | |
| @item -fno-use-cxa-get-exception-ptr | |
| Don't use the @code{__cxa_get_exception_ptr} runtime routine. This | |
| causes @code{std::uncaught_exception} to be incorrect, but is necessary | |
| if the runtime routine is not available. | |
| @opindex fvisibility-inlines-hidden | |
| @opindex fno-visibility-inlines-hidden | |
| @item -fvisibility-inlines-hidden | |
| This switch declares that the user does not attempt to compare | |
| pointers to inline functions or methods where the addresses of the two functions | |
| are taken in different shared objects. | |
| The effect of this is that GCC may, effectively, mark inline methods with | |
| @code{__attribute__ ((visibility ("hidden")))} so that they do not | |
| appear in the export table of a DSO and do not require a PLT indirection | |
| when used within the DSO@. Enabling this option can have a dramatic effect | |
| on load and link times of a DSO as it massively reduces the size of the | |
| dynamic export table when the library makes heavy use of templates. | |
| The behavior of this switch is not quite the same as marking the | |
| methods as hidden directly, because it does not affect static variables | |
| local to the function or cause the compiler to deduce that | |
| the function is defined in only one shared object. | |
| You may mark a method as having a visibility explicitly to negate the | |
| effect of the switch for that method. For example, if you do want to | |
| compare pointers to a particular inline method, you might mark it as | |
| having default visibility. Marking the enclosing class with explicit | |
| visibility has no effect. | |
| Explicitly instantiated inline methods are unaffected by this option | |
| as their linkage might otherwise cross a shared library boundary. | |
| @xref{Template Instantiation}. | |
| @opindex fvisibility-ms-compat | |
| @opindex fno-visibility-ms-compat | |
| @item -fvisibility-ms-compat | |
| This flag attempts to use visibility settings to make GCC's C++ | |
| linkage model compatible with that of Microsoft Visual Studio. | |
| The flag makes these changes to GCC's linkage model: | |
| @enumerate | |
| @item | |
| It sets the default visibility to @code{hidden}, like | |
| @option{-fvisibility=hidden}. | |
| @item | |
| Types, but not their members, are not hidden by default. | |
| @item | |
| The One Definition Rule is relaxed for types without explicit | |
| visibility specifications that are defined in more than one | |
| shared object: those declarations are permitted if they are | |
| permitted when this option is not used. | |
| @end enumerate | |
| In new code it is better to use @option{-fvisibility=hidden} and | |
| export those classes that are intended to be externally visible. | |
| Unfortunately it is possible for code to rely, perhaps accidentally, | |
| on the Visual Studio behavior. | |
| Among the consequences of these changes are that static data members | |
| of the same type with the same name but defined in different shared | |
| objects are different, so changing one does not change the other; | |
| and that pointers to function members defined in different shared | |
| objects may not compare equal. When this flag is given, it is a | |
| violation of the ODR to define types with the same name differently. | |
| @opindex fno-weak | |
| @opindex fweak | |
| @item -fno-weak | |
| Do not use weak symbol support, even if it is provided by the linker. | |
| By default, G++ uses weak symbols if they are available. This | |
| option exists only for testing, and should not be used by end-users; | |
| it results in inferior code and has no benefits. This option may | |
| be removed in a future release of G++. | |
| @opindex fext-numeric-literals | |
| @opindex fno-ext-numeric-literals | |
| @item -fext-numeric-literals @r{(C++ and Objective-C++ only)} | |
| Accept imaginary, fixed-point, or machine-defined | |
| literal number suffixes as GNU extensions. | |
| When this option is turned off these suffixes are treated | |
| as C++11 user-defined literal numeric suffixes. | |
| This is on by default for all pre-C++11 dialects and all GNU dialects: | |
| @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11}, | |
| @option{-std=gnu++14}. | |
| This option is off by default | |
| for ISO C++11 onwards (@option{-std=c++11}, ...). | |
| @opindex nostdinc++ | |
| @item -nostdinc++ | |
| Do not search for header files in the standard directories specific to | |
| C++, but do still search the other standard directories. (This option | |
| is used when building the C++ library.) | |
| @opindex flang-info-include-translate | |
| @opindex fno-lang-info-include-translate | |
| @opindex flang-info-include-translate-not | |
| @opindex fno-lang-info-include-translate-not | |
| @item -flang-info-include-translate | |
| @itemx -flang-info-include-translate-not | |
| @itemx -flang-info-include-translate=@var{header} | |
| Inform of include translation events. The first will note accepted | |
| include translations, the second will note declined include | |
| translations. The @var{header} form will inform of include | |
| translations relating to that specific header. If @var{header} is of | |
| the form @code{"user"} or @code{<system>} it will be resolved to a | |
| specific user or system header using the include path. | |
| @opindex flang-info-module-cmi | |
| @opindex fno-lang-info-module-cmi | |
| @item -flang-info-module-cmi | |
| @itemx -flang-info-module-cmi=@var{module} | |
| Inform of Compiled Module Interface pathnames. The first will note | |
| all read CMI pathnames. The @var{module} form will note reading a | |
| specific module's CMI. @var{module} may be a named module or a | |
| header-unit (the latter indicated by either being a pathname containing | |
| directory separators or enclosed in @code{<>} or @code{""}). | |
| @opindex stdlib | |
| @item -stdlib=@var{libstdc++,libc++} | |
| When G++ is configured to support this option, it allows specification of | |
| alternate C++ runtime libraries. Two options are available: @var{libstdc++} | |
| (the default, native C++ runtime for G++) and @var{libc++} which is the | |
| C++ runtime installed on some operating systems (e.g. Darwin versions from | |
| Darwin11 onwards). The option switches G++ to use the headers from the | |
| specified library and to emit @code{-lstdc++} or @code{-lc++} respectively, | |
| when a C++ runtime is required for linking. | |
| @end table | |
| In addition, these warning options have meanings only for C++ programs: | |
| @table @gcctabopt | |
| @opindex Wabi-tag | |
| @opindex Wno-abi-tag | |
| @item -Wabi-tag @r{(C++ and Objective-C++ only)} | |
| Warn when a type with an ABI tag is used in a context that does not | |
| have that ABI tag. See @ref{C++ Attributes} for more information | |
| about ABI tags. | |
| @opindex Wabbreviated-auto-in-template-arg | |
| @opindex Wno-abbreviated-auto-in-template-arg | |
| @item -Wno-abbreviated-auto-in-template-arg | |
| Disable the error for an @code{auto} placeholder type used within a | |
| template argument list to declare a C++20 abbreviated function | |
| template, e.g. | |
| @smallexample | |
| void f(S<auto>); | |
| @end smallexample | |
| This feature was proposed in the Concepts TS, but was not adopted into | |
| C++20; in the standard, a placeholder in a parameter declaration must | |
| appear as a decl-specifier. The error can also be reduced to a | |
| warning by @option{-fpermissive} or | |
| @option{-Wno-error=abbreviated-auto-in-template-arg}. | |
| @opindex Wcomma-subscript | |
| @opindex Wno-comma-subscript | |
| @item -Wcomma-subscript @r{(C++ and Objective-C++ only)} | |
| Warn about uses of a comma expression within a subscripting expression. | |
| This usage was deprecated in C++20 and is going to be removed in C++23. | |
| However, a comma expression wrapped in @code{( )} is not deprecated. Example: | |
| @smallexample | |
| @group | |
| void f(int *a, int b, int c) @{ | |
| a[b,c]; // deprecated in C++20, invalid in C++23 | |
| a[(b,c)]; // OK | |
| @} | |
| @end group | |
| @end smallexample | |
| In C++23 it is valid to have comma separated expressions in a subscript | |
| when an overloaded subscript operator is found and supports the right | |
| number and types of arguments. G++ will accept the formerly valid syntax | |
| for code that is not valid in C++23 but used to be valid but deprecated | |
| in C++20 with a pedantic warning that can be disabled with | |
| @option{-Wno-comma-subscript}. | |
| Enabled by default with @option{-std=c++20} unless | |
| @option{-Wno-deprecated}, and after @option{-std=c++23} regardless of | |
| @option{-Wno-deprecated}. Before @option{-std=c++20}, enabled with | |
| explicit @option{-Wdeprecated}. | |
| This warning is upgraded to an error by @option{-pedantic-errors} in | |
| C++23 mode or later. | |
| @opindex Wctad-maybe-unsupported | |
| @opindex Wno-ctad-maybe-unsupported | |
| @item -Wctad-maybe-unsupported @r{(C++ and Objective-C++ only)} | |
| Warn when performing class template argument deduction (CTAD) on a type with | |
| no explicitly written deduction guides. This warning will point out cases | |
| where CTAD succeeded only because the compiler synthesized the implicit | |
| deduction guides, which might not be what the programmer intended. Certain | |
| style guides allow CTAD only on types that specifically "opt-in"; i.e., on | |
| types that are designed to support CTAD. This warning can be suppressed with | |
| the following pattern: | |
| @smallexample | |
| struct allow_ctad_t; // any name works | |
| template <typename T> struct S @{ | |
| S(T) @{ @} | |
| @}; | |
| // Guide with incomplete parameter type will never be considered. | |
| S(allow_ctad_t) -> S<void>; | |
| @end smallexample | |
| @opindex Wctor-dtor-privacy | |
| @opindex Wno-ctor-dtor-privacy | |
| @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)} | |
| Warn when a class seems unusable because all the constructors or | |
| destructors in that class are private, and it has neither friends nor | |
| public static member functions. Also warn if there are no non-private | |
| methods, and there's at least one private member function that isn't | |
| a constructor or destructor. | |
| @opindex Wdangling-reference | |
| @opindex Wno-dangling-reference | |
| @item -Wdangling-reference @r{(C++ and Objective-C++ only)} | |
| Warn when a reference is bound to a temporary whose lifetime has ended. | |
| For example: | |
| @smallexample | |
| int n = 1; | |
| const int& r = std::max(n - 1, n + 1); // r is dangling | |
| @end smallexample | |
| In the example above, two temporaries are created, one for each | |
| argument, and a reference to one of the temporaries is returned. | |
| However, both temporaries are destroyed at the end of the full | |
| expression, so the reference @code{r} is dangling. This warning | |
| also detects dangling references in member initializer lists: | |
| @smallexample | |
| const int& f(const int& i) @{ return i; @} | |
| struct S @{ | |
| const int &r; // r is dangling | |
| S() : r(f(10)) @{ @} | |
| @}; | |
| @end smallexample | |
| Member functions are checked as well, but only their object argument: | |
| @smallexample | |
| struct S @{ | |
| const S& self () @{ return *this; @} | |
| @}; | |
| const S& s = S().self(); // s is dangling | |
| @end smallexample | |
| Certain functions are safe in this respect, for example @code{std::use_facet}: | |
| they take and return a reference, but they don't return one of its arguments, | |
| which can fool the warning. Such functions can be excluded from the warning | |
| by wrapping them in a @code{#pragma}: | |
| @smallexample | |
| #pragma GCC diagnostic push | |
| #pragma GCC diagnostic ignored "-Wdangling-reference" | |
| const T& foo (const T&) @{ @dots{} @} | |
| #pragma GCC diagnostic pop | |
| @end smallexample | |
| The @code{#pragma} can also surround the class; in that case, the warning | |
| will be disabled for all the member functions. | |
| @option{-Wdangling-reference} also warns about code like | |
| @smallexample | |
| auto p = std::minmax(1, 2); | |
| @end smallexample | |
| where @code{std::minmax} returns @code{std::pair<const int&, const int&>}, and | |
| both references dangle after the end of the full expression that contains | |
| the call to @code{std::minmax}. | |
| The warning does not warn for @code{std::span}-like classes. We consider | |
| classes of the form: | |
| @smallexample | |
| template<typename T> | |
| struct Span @{ | |
| T* data_; | |
| std::size len_; | |
| @}; | |
| @end smallexample | |
| as @code{std::span}-like; that is, the class is a non-union class | |
| that has a pointer data member and a trivial destructor. | |
| The warning can be disabled by using the @code{gnu::no_dangling} attribute | |
| (@pxref{C++ Attributes}). | |
| This warning is enabled by @option{-Wextra}. | |
| @opindex Wdelete-non-virtual-dtor | |
| @opindex Wno-delete-non-virtual-dtor | |
| @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)} | |
| Warn when @code{delete} is used to destroy an instance of a class that | |
| has virtual functions and non-virtual destructor. It is unsafe to delete | |
| an instance of a derived class through a pointer to a base class if the | |
| base class does not have a virtual destructor. This warning is enabled | |
| by @option{-Wall}. | |
| @opindex Wdeprecated-copy | |
| @opindex Wno-deprecated-copy | |
| @item -Wdeprecated-copy @r{(C++ and Objective-C++ only)} | |
| Warn that the implicit declaration of a copy constructor or copy | |
| assignment operator is deprecated if the class has a user-provided | |
| copy constructor or copy assignment operator, in C++11 and up. This | |
| warning is enabled by @option{-Wextra}. | |
| @opindex Wdeprecated-copy-dtor | |
| @opindex Wno-deprecated-copy-dtor | |
| @item -Wdeprecated-copy-dtor @r{(C++ and Objective-C++ only)} | |
| Similar to @option{-Wdeprecated-copy}, but also deprecate if the class has a | |
| user-provided destructor. | |
| @opindex Wdeprecated-enum-enum-conversion | |
| @opindex Wno-deprecated-enum-enum-conversion | |
| @item -Wno-deprecated-enum-enum-conversion @r{(C++ and Objective-C++ only)} | |
| Disable the warning about the case when the usual arithmetic conversions | |
| are applied on operands where one is of enumeration type and the other is | |
| of a different enumeration type. This conversion was deprecated in C++20. | |
| For example: | |
| @smallexample | |
| enum E1 @{ e @}; | |
| enum E2 @{ f @}; | |
| int k = f - e; | |
| @end smallexample | |
| @option{-Wdeprecated-enum-enum-conversion} is enabled by default with | |
| @option{-std=c++20}. In pre-C++20 dialects, this warning can be enabled | |
| by @option{-Wenum-conversion} or @option{-Wdeprecated}. | |
| @opindex Wdeprecated-enum-float-conversion | |
| @opindex Wno-deprecated-enum-float-conversion | |
| @item -Wno-deprecated-enum-float-conversion @r{(C++ and Objective-C++ only)} | |
| Disable the warning about the case when the usual arithmetic conversions | |
| are applied on operands where one is of enumeration type and the other is | |
| of a floating-point type. This conversion was deprecated in C++20. For | |
| example: | |
| @smallexample | |
| enum E1 @{ e @}; | |
| enum E2 @{ f @}; | |
| bool b = e <= 3.7; | |
| @end smallexample | |
| @option{-Wdeprecated-enum-float-conversion} is enabled by default with | |
| @option{-std=c++20}. In pre-C++20 dialects, this warning can be enabled | |
| by @option{-Wenum-conversion} or @option{-Wdeprecated}. | |
| @opindex Wdeprecated-literal-operator | |
| @opindex Wno-deprecated-literal-operator | |
| @item -Wdeprecated-literal-operator @r{(C++ and Objective-C++ only)} | |
| Warn that the declaration of a user-defined literal operator with a | |
| space before the suffix is deprecated. This warning is enabled by | |
| default in C++23, or with explicit @option{-Wdeprecated}. | |
| @smallexample | |
| string operator "" _i18n(const char*, std::size_t); // deprecated | |
| string operator ""_i18n(const char*, std::size_t); // preferred | |
| @end smallexample | |
| @opindex Wdeprecated-variadic-comma-omission | |
| @opindex Wno-deprecated-variadic-comma-omission | |
| @item -Wdeprecated-variadic-comma-omission @r{(C++ and Objective-C++ only)} | |
| Warn that omitting a comma before the varargs @code{...} at the end of | |
| a function parameter list is deprecated. This warning is enabled by | |
| default in C++26, or with explicit @option{-Wdeprecated}. | |
| @smallexample | |
| void f1(int...); // deprecated | |
| void f1(int, ...); // preferred | |
| template <typename ...T> | |
| void f2(T...); // ok | |
| template <typename ...T> | |
| void f3(T......); // deprecated | |
| @end smallexample | |
| @opindex Welaborated-enum-base | |
| @opindex Wno-elaborated-enum-base | |
| @item -Wno-elaborated-enum-base | |
| For C++11 and above, warn if an (invalid) additional enum-base is used | |
| in an elaborated-type-specifier. That is, if an enum with given | |
| underlying type and no enumerator list is used in a declaration other | |
| than just a standalone declaration of the enum. Enabled by default. This | |
| warning is upgraded to an error with -pedantic-errors. | |
| @opindex Winit-list-lifetime | |
| @opindex Wno-init-list-lifetime | |
| @item -Wno-init-list-lifetime @r{(C++ and Objective-C++ only)} | |
| Do not warn about uses of @code{std::initializer_list} that are likely | |
| to result in dangling pointers. Since the underlying array for an | |
| @code{initializer_list} is handled like a normal C++ temporary object, | |
| it is easy to inadvertently keep a pointer to the array past the end | |
| of the array's lifetime. For example: | |
| @itemize @bullet | |
| @item | |
| If a function returns a temporary @code{initializer_list}, or a local | |
| @code{initializer_list} variable, the array's lifetime ends at the end | |
| of the return statement, so the value returned has a dangling pointer. | |
| @item | |
| If a new-expression creates an @code{initializer_list}, the array only | |
| lives until the end of the enclosing full-expression, so the | |
| @code{initializer_list} in the heap has a dangling pointer. | |
| @item | |
| When an @code{initializer_list} variable is assigned from a | |
| brace-enclosed initializer list, the temporary array created for the | |
| right side of the assignment only lives until the end of the | |
| full-expression, so at the next statement the @code{initializer_list} | |
| variable has a dangling pointer. | |
| @smallexample | |
| // li's initial underlying array lives as long as li | |
| std::initializer_list<int> li = @{ 1,2,3 @}; | |
| // assignment changes li to point to a temporary array | |
| li = @{ 4, 5 @}; | |
| // now the temporary is gone and li has a dangling pointer | |
| int i = li.begin()[0] // undefined behavior | |
| @end smallexample | |
| @item | |
| When a list constructor stores the @code{begin} pointer from the | |
| @code{initializer_list} argument, this doesn't extend the lifetime of | |
| the array, so if a class variable is constructed from a temporary | |
| @code{initializer_list}, the pointer is left dangling by the end of | |
| the variable declaration statement. | |
| @end itemize | |
| @opindex Winvalid-constexpr | |
| @opindex Wno-invalid-constexpr | |
| @item -Winvalid-constexpr | |
| Warn when a function never produces a constant expression. In C++20 | |
| and earlier, for every @code{constexpr} function and function template, | |
| there must be at least one set of function arguments in at least one | |
| instantiation such that an invocation of the function or constructor | |
| could be an evaluated subexpression of a core constant expression. | |
| C++23 removed this restriction, so it's possible to have a function | |
| or a function template marked @code{constexpr} for which no invocation | |
| satisfies the requirements of a core constant expression. | |
| This warning is enabled as a pedantic warning by default in C++20 and | |
| earlier. In C++23, @option{-Winvalid-constexpr} can be turned on, in | |
| which case it will be an ordinary warning. For example: | |
| @smallexample | |
| void f (int& i); | |
| constexpr void | |
| g (int& i) | |
| @{ | |
| // Warns by default in C++20, in C++23 only with -Winvalid-constexpr. | |
| f(i); | |
| @} | |
| @end smallexample | |
| @opindex Winvalid-imported-macros | |
| @opindex Wno-invalid-imported-macros | |
| @item -Winvalid-imported-macros | |
| Verify all imported macro definitions are valid at the end of | |
| compilation. This is not enabled by default, as it requires | |
| additional processing to determine. It may be useful when preparing | |
| sets of header-units to ensure consistent macros. | |
| @opindex Winvalid-specialization | |
| @opindex Wno-invalid-specialization | |
| @item -Wno-invalid-specialization @r{(C++ and Objective-C++ only)} | |
| Do not error on explicit specializations of templates marked with the | |
| @code{no_specializations} attribute. This diagnostics is enabled | |
| by default, and @option{-Wno-invalid-specialization} or | |
| @code{#pragma GCC ignored "-Winvalid-specializations"} can disable | |
| that diagnostics. | |
| @opindex Wliteral-suffix | |
| @opindex Wno-literal-suffix | |
| @item -Wno-literal-suffix @r{(C++ and Objective-C++ only)} | |
| Do not warn when a string or character literal is followed by a | |
| ud-suffix which does not begin with an underscore. As a conforming | |
| extension, GCC treats such suffixes as separate preprocessing tokens | |
| in order to maintain backwards compatibility with code that uses | |
| formatting macros from @code{<inttypes.h>}. For example: | |
| @smallexample | |
| #define __STDC_FORMAT_MACROS | |
| #include <inttypes.h> | |
| #include <stdio.h> | |
| int main() @{ | |
| int64_t i64 = 123; | |
| printf("My int64: %" PRId64"\n", i64); | |
| @} | |
| @end smallexample | |
| In this case, @code{PRId64} is treated as a separate preprocessing token. | |
| This option also controls warnings when a user-defined literal | |
| operator is declared with a literal suffix identifier that doesn't | |
| begin with an underscore. Literal suffix identifiers that don't begin | |
| with an underscore are reserved for future standardization. | |
| These warnings are enabled by default. | |
| @opindex Wnarrowing | |
| @opindex Wno-narrowing | |
| @item -Wno-narrowing @r{(C++ and Objective-C++ only)} | |
| For C++11 and later standards, narrowing conversions are diagnosed by default, | |
| as required by the standard. A narrowing conversion from a constant produces | |
| an error, and a narrowing conversion from a non-constant produces a warning, | |
| but @option{-Wno-narrowing} suppresses the diagnostic. | |
| Note that this does not affect the meaning of well-formed code; | |
| narrowing conversions are still considered ill-formed in SFINAE contexts. | |
| With @option{-Wnarrowing} in C++98, warn when a narrowing | |
| conversion prohibited by C++11 occurs within | |
| @samp{@{ @}}, e.g. | |
| @smallexample | |
| int i = @{ 2.2 @}; // error: narrowing from double to int | |
| @end smallexample | |
| This flag is included in @option{-Wall} and @option{-Wc++11-compat}. | |
| @opindex Wnoexcept | |
| @opindex Wno-noexcept | |
| @item -Wnoexcept @r{(C++ and Objective-C++ only)} | |
| Warn when a noexcept-expression evaluates to false because of a call | |
| to a function that does not have a non-throwing exception | |
| specification (i.e. @code{throw()} or @code{noexcept}) but is known by | |
| the compiler to never throw an exception. | |
| @opindex Wnoexcept-type | |
| @opindex Wno-noexcept-type | |
| @item -Wnoexcept-type @r{(C++ and Objective-C++ only)} | |
| Warn if the C++17 feature making @code{noexcept} part of a function | |
| type changes the mangled name of a symbol relative to C++14. Enabled | |
| by @option{-Wabi} and @option{-Wc++17-compat}. | |
| As an example: | |
| @smallexample | |
| template <class T> void f(T t) @{ t(); @}; | |
| void g() noexcept; | |
| void h() @{ f(g); @} | |
| @end smallexample | |
| @noindent | |
| In C++14, @code{f} calls @code{f<void(*)()>}, but in | |
| C++17 it calls @code{f<void(*)()noexcept>}. | |
| @opindex Wclass-memaccess | |
| @opindex Wno-class-memaccess | |
| @item -Wclass-memaccess @r{(C++ and Objective-C++ only)} | |
| Warn when the destination of a call to a raw memory function such as | |
| @code{memset} or @code{memcpy} is an object of class type, and when writing | |
| into such an object might bypass the class non-trivial or deleted constructor | |
| or copy assignment, violate const-correctness or encapsulation, or corrupt | |
| virtual table pointers. Modifying the representation of such objects may | |
| violate invariants maintained by member functions of the class. For example, | |
| the call to @code{memset} below is undefined because it modifies a non-trivial | |
| class object and is, therefore, diagnosed. The safe way to either initialize | |
| or clear the storage of objects of such types is by using the appropriate | |
| constructor or assignment operator, if one is available. | |
| @smallexample | |
| std::string str = "abc"; | |
| memset (&str, 0, sizeof str); | |
| @end smallexample | |
| The @option{-Wclass-memaccess} option is enabled by @option{-Wall}. | |
| Explicitly casting the pointer to the class object to @code{void *} or | |
| to a type that can be safely accessed by the raw memory function suppresses | |
| the warning. | |
| @opindex Wnon-virtual-dtor | |
| @opindex Wno-non-virtual-dtor | |
| @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)} | |
| Warn when a class has virtual functions and an accessible non-virtual | |
| destructor itself or in an accessible polymorphic base class, in which | |
| case it is possible but unsafe to delete an instance of a derived | |
| class through a pointer to the class itself or base class. This | |
| warning is automatically enabled if @option{-Weffc++} is specified. | |
| The @option{-Wdelete-non-virtual-dtor} option (enabled by @option{-Wall}) | |
| should be preferred because it warns about the unsafe cases without false | |
| positives. | |
| @opindex Wregister | |
| @opindex Wno-register | |
| @item -Wregister @r{(C++ and Objective-C++ only)} | |
| Warn on uses of the @code{register} storage class specifier, except | |
| when it is part of the GNU @ref{Explicit Register Variables} extension. | |
| The use of the @code{register} keyword as storage class specifier has | |
| been deprecated in C++11 and removed in C++17. | |
| Enabled by default with @option{-std=c++17}. | |
| @opindex Wreorder | |
| @opindex Wno-reorder | |
| @cindex reordering, warning | |
| @cindex warning for reordering of member initializers | |
| @item -Wreorder @r{(C++ and Objective-C++ only)} | |
| Warn when the order of member initializers given in the code does not | |
| match the order in which they must be executed. For instance: | |
| @smallexample | |
| struct A @{ | |
| int i; | |
| int j; | |
| A(): j (0), i (1) @{ @} | |
| @}; | |
| @end smallexample | |
| @noindent | |
| The compiler rearranges the member initializers for @code{i} | |
| and @code{j} to match the declaration order of the members, emitting | |
| a warning to that effect. This warning is enabled by @option{-Wall}. | |
| @opindex Wpessimizing-move | |
| @opindex Wno-pessimizing-move | |
| @item -Wno-pessimizing-move @r{(C++ and Objective-C++ only)} | |
| This warning warns when a call to @code{std::move} prevents copy | |
| elision. A typical scenario when copy elision can occur is when returning in | |
| a function with a class return type, when the expression being returned is the | |
| name of a non-volatile automatic object, and is not a function parameter, and | |
| has the same type as the function return type. | |
| @smallexample | |
| struct T @{ | |
| @dots{} | |
| @}; | |
| T fn() | |
| @{ | |
| T t; | |
| @dots{} | |
| return std::move (t); | |
| @} | |
| @end smallexample | |
| But in this example, the @code{std::move} call prevents copy elision. | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wredundant-move | |
| @opindex Wno-redundant-move | |
| @item -Wno-redundant-move @r{(C++ and Objective-C++ only)} | |
| This warning warns about redundant calls to @code{std::move}; that is, when | |
| a move operation would have been performed even without the @code{std::move} | |
| call. This happens because the compiler is forced to treat the object as if | |
| it were an rvalue in certain situations such as returning a local variable, | |
| where copy elision isn't applicable. Consider: | |
| @smallexample | |
| struct T @{ | |
| @dots{} | |
| @}; | |
| T fn(T t) | |
| @{ | |
| @dots{} | |
| return std::move (t); | |
| @} | |
| @end smallexample | |
| Here, the @code{std::move} call is redundant. Because G++ implements Core | |
| Issue 1579, another example is: | |
| @smallexample | |
| struct T @{ // convertible to U | |
| @dots{} | |
| @}; | |
| struct U @{ | |
| @dots{} | |
| @}; | |
| U fn() | |
| @{ | |
| T t; | |
| @dots{} | |
| return std::move (t); | |
| @} | |
| @end smallexample | |
| In this example, copy elision isn't applicable because the type of the | |
| expression being returned and the function return type differ, yet G++ | |
| treats the return value as if it were designated by an rvalue. | |
| This warning is enabled by @option{-Wextra}. | |
| @opindex Wrange-loop-construct | |
| @opindex Wno-range-loop-construct | |
| @item -Wrange-loop-construct @r{(C++ and Objective-C++ only)} | |
| This warning warns when a C++ range-based for-loop is creating an unnecessary | |
| copy. This can happen when the range declaration is not a reference, but | |
| probably should be. For example: | |
| @smallexample | |
| struct S @{ char arr[128]; @}; | |
| void fn () @{ | |
| S arr[5]; | |
| for (const auto x : arr) @{ @dots{} @} | |
| @} | |
| @end smallexample | |
| It does not warn when the type being copied is a trivially copy constructible | |
| type whose size is less than 64 bytes. | |
| This warning also warns when a loop variable in a range-based for-loop is | |
| initialized with a value of a different type resulting in a copy. For example: | |
| @smallexample | |
| void fn() @{ | |
| int arr[10]; | |
| for (const double &x : arr) @{ @dots{} @} | |
| @} | |
| @end smallexample | |
| In the example above, in every iteration of the loop a temporary value of | |
| type @code{double} is created and destroyed, to which the reference | |
| @code{const double &} is bound. | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wredundant-tags | |
| @opindex Wno-redundant-tags | |
| @item -Wredundant-tags @r{(C++ and Objective-C++ only)} | |
| Warn about redundant class-key and enum-key in references to class types | |
| and enumerated types in contexts where the key can be eliminated without | |
| causing an ambiguity. For example: | |
| @smallexample | |
| struct foo; | |
| struct foo *p; // warn that keyword struct can be eliminated | |
| @end smallexample | |
| @noindent | |
| On the other hand, in this example there is no warning: | |
| @smallexample | |
| struct foo; | |
| void foo (); // "hides" struct foo | |
| void bar (struct foo&); // no warning, keyword struct is necessary | |
| @end smallexample | |
| @opindex Wsubobject-linkage | |
| @opindex Wno-subobject-linkage | |
| @item -Wno-subobject-linkage @r{(C++ and Objective-C++ only)} | |
| Do not warn | |
| if a class type has a base or a field whose type uses the anonymous | |
| namespace or depends on a type with no linkage. If a type A depends on | |
| a type B with no or internal linkage, defining it in multiple | |
| translation units would be an ODR violation because the meaning of B | |
| is different in each translation unit. If A only appears in a single | |
| translation unit, the best way to silence the warning is to give it | |
| internal linkage by putting it in an anonymous namespace as well. The | |
| compiler doesn't give this warning for types defined in the main .C | |
| file, as those are unlikely to have multiple definitions. | |
| @option{-Wsubobject-linkage} is enabled by default. | |
| @opindex Weffc++ | |
| @opindex Wno-effc++ | |
| @item -Weffc++ @r{(C++ and Objective-C++ only)} | |
| Warn about violations of the following style guidelines from Scott Meyers' | |
| @cite{Effective C++} series of books: | |
| @itemize @bullet | |
| @item | |
| Define a copy constructor and an assignment operator for classes | |
| with dynamically-allocated memory. | |
| @item | |
| Prefer initialization to assignment in constructors. | |
| @item | |
| Have @code{operator=} return a reference to @code{*this}. | |
| @item | |
| Don't try to return a reference when you must return an object. | |
| @item | |
| Distinguish between prefix and postfix forms of increment and | |
| decrement operators. | |
| @item | |
| Never overload @code{&&}, @code{||}, or @code{,}. | |
| @end itemize | |
| This option also enables @option{-Wnon-virtual-dtor}, which is also | |
| one of the effective C++ recommendations. However, the check is | |
| extended to warn about the lack of virtual destructor in accessible | |
| non-polymorphic bases classes too. | |
| When selecting this option, be aware that the standard library | |
| headers do not obey all of these guidelines; use @samp{grep -v} | |
| to filter out those warnings. | |
| @opindex Wexceptions | |
| @opindex Wno-exceptions | |
| @item -Wno-exceptions @r{(C++ and Objective-C++ only)} | |
| Disable the warning about the case when an exception handler is shadowed by | |
| another handler, which can point out a wrong ordering of exception handlers. | |
| @opindex Wsfinae-incomplete | |
| @opindex Wno-sfinae-incomplete | |
| @item -Wsfinae-incomplete @r{(C++ and Objective-C++ only)} | |
| Warn about a class that is found to be incomplete, or a function with | |
| auto return type that has not yet been deduced, in a context where | |
| that causes substitution failure rather than an error, and then the | |
| class or function is defined later in the translation unit. This is | |
| problematic because template instantiations or concept checks could | |
| have different results if they first occur either before or after the | |
| definition. | |
| This warning is enabled by default. @option{-Wsfinae-incomplete=2} | |
| adds a warning at the point of substitution failure, to make it easier | |
| to track down problems flagged by the default mode. | |
| @opindex Wstrict-null-sentinel | |
| @opindex Wno-strict-null-sentinel | |
| @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)} | |
| Warn about the use of an uncasted @code{NULL} as sentinel. When | |
| compiling only with GCC this is a valid sentinel, as @code{NULL} is defined | |
| to @code{__null}. Although it is a null pointer constant rather than a | |
| null pointer, it is guaranteed to be of the same size as a pointer. | |
| But this use is not portable across different compilers. | |
| @opindex Wno-non-c-typedef-for-linkage | |
| @opindex Wnon-c-typedef-for-linkage | |
| @item -Wno-non-c-typedef-for-linkage @r{(C++ and Objective-C++ only)} | |
| Disable pedwarn for unnamed classes with a typedef name for linkage purposes | |
| containing C++ specific members, base classes, default member initializers | |
| or lambda expressions, including those on nested member classes. | |
| @smallexample | |
| typedef struct @{ | |
| int a; // non-static data members are ok | |
| struct T @{ int b; @}; // member classes too | |
| enum E @{ E1, E2, E3 @}; // member enumerations as well | |
| int c = 42; // default member initializers are not ok | |
| struct U : A @{ int c; @}; // classes with base classes are not ok | |
| typedef int V; // typedef is not ok | |
| using W = int; // using declaration is not ok | |
| decltype([]()@{@}) x; // lambda expressions not ok | |
| @} S; | |
| @end smallexample | |
| In all these cases, the tag name S should be added after the struct keyword. | |
| @opindex Wno-non-template-friend | |
| @opindex Wnon-template-friend | |
| @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)} | |
| Disable warnings when non-template friend functions are declared | |
| within a template. In very old versions of GCC that predate implementation | |
| of the ISO standard, declarations such as | |
| @samp{friend int foo(int)}, where the name of the friend is an unqualified-id, | |
| could be interpreted as a particular specialization of a template | |
| function; the warning exists to diagnose compatibility problems, | |
| and is enabled by default. | |
| @opindex Wold-style-cast | |
| @opindex Wno-old-style-cast | |
| @item -Wold-style-cast @r{(C++ and Objective-C++ only)} | |
| Warn if an old-style (C-style) cast to a non-void type is used within | |
| a C++ program. The new-style casts (@code{dynamic_cast}, | |
| @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are | |
| less vulnerable to unintended effects and much easier to search for. | |
| @opindex Woverloaded-virtual | |
| @opindex Wno-overloaded-virtual | |
| @cindex overloaded virtual function, warning | |
| @cindex warning for overloaded virtual function | |
| @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)} | |
| @itemx -Woverloaded-virtual=@var{n} | |
| Warn when a function declaration hides virtual functions from a | |
| base class. For example, in: | |
| @smallexample | |
| struct A @{ | |
| virtual void f(); | |
| @}; | |
| struct B: public A @{ | |
| void f(int); // does not override | |
| @}; | |
| @end smallexample | |
| the @code{A} class version of @code{f} is hidden in @code{B}, and code | |
| like: | |
| @smallexample | |
| B* b; | |
| b->f(); | |
| @end smallexample | |
| @noindent | |
| fails to compile. | |
| In cases where the different signatures are not an accident, the | |
| simplest solution is to add a using-declaration to the derived class | |
| to un-hide the base function, e.g. add @code{using A::f;} to @code{B}. | |
| The optional level suffix controls the behavior when all the | |
| declarations in the derived class override virtual functions in the | |
| base class, even if not all of the base functions are overridden: | |
| @smallexample | |
| struct C @{ | |
| virtual void f(); | |
| virtual void f(int); | |
| @}; | |
| struct D: public C @{ | |
| void f(int); // does override | |
| @} | |
| @end smallexample | |
| This pattern is less likely to be a mistake; if D is only used | |
| virtually, the user might have decided that the base class semantics | |
| for some of the overloads are fine. | |
| At level 1, this case does not warn; at level 2, it does. | |
| @option{-Woverloaded-virtual} by itself selects level 2. Level 1 is | |
| included in @option{-Wall}. | |
| @opindex Wno-pmf-conversions | |
| @opindex Wpmf-conversions | |
| @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)} | |
| Disable the diagnostic for converting a bound pointer to member function | |
| to a plain pointer. | |
| @opindex Wsign-promo | |
| @opindex Wno-sign-promo | |
| @item -Wsign-promo @r{(C++ and Objective-C++ only)} | |
| Warn when overload resolution chooses a promotion from unsigned or | |
| enumerated type to a signed type, over a conversion to an unsigned type of | |
| the same size. Previous versions of G++ tried to preserve | |
| unsignedness, but the standard mandates the current behavior. | |
| @opindex Wtemplates | |
| @opindex Wno-templates | |
| @item -Wtemplates @r{(C++ and Objective-C++ only)} | |
| Warn when a primary template declaration is encountered. Some coding | |
| rules disallow templates, and this may be used to enforce that rule. | |
| The warning is inactive inside a system header file, such as the STL, so | |
| one can still use the STL. One may also instantiate or specialize | |
| templates. | |
| @opindex Wmismatched-new-delete | |
| @opindex Wno-mismatched-new-delete | |
| @item -Wmismatched-new-delete @r{(C++ and Objective-C++ only)} | |
| Warn for mismatches between calls to @code{operator new} or @code{operator | |
| delete} and the corresponding call to the allocation or deallocation function. | |
| This includes invocations of C++ @code{operator delete} with pointers | |
| returned from either mismatched forms of @code{operator new}, or from other | |
| functions that allocate objects for which the @code{operator delete} isn't | |
| a suitable deallocator, as well as calls to other deallocation functions | |
| with pointers returned from @code{operator new} for which the deallocation | |
| function isn't suitable. | |
| For example, the @code{delete} expression in the function below is diagnosed | |
| because it doesn't match the array form of the @code{new} expression | |
| the pointer argument was returned from. Similarly, the call to @code{free} | |
| is also diagnosed. | |
| @smallexample | |
| void f () | |
| @{ | |
| int *a = new int[n]; | |
| delete a; // warning: mismatch in array forms of expressions | |
| char *p = new char[n]; | |
| free (p); // warning: mismatch between new and free | |
| @} | |
| @end smallexample | |
| The related option @option{-Wmismatched-dealloc} diagnoses mismatches | |
| involving allocation and deallocation functions other than @code{operator | |
| new} and @code{operator delete}. | |
| @option{-Wmismatched-new-delete} is included in @option{-Wall}. | |
| @opindex Wmismatched-tags | |
| @opindex Wno-mismatched-tags | |
| @item -Wmismatched-tags @r{(C++ and Objective-C++ only)} | |
| Warn for declarations of structs, classes, and class templates and their | |
| specializations with a class-key that does not match either the definition | |
| or the first declaration if no definition is provided. | |
| For example, the declaration of @code{struct Object} in the argument list | |
| of @code{draw} triggers the warning. To avoid it, either remove the redundant | |
| class-key @code{struct} or replace it with @code{class} to match its definition. | |
| @smallexample | |
| class Object @{ | |
| public: | |
| virtual ~Object () = 0; | |
| @}; | |
| void draw (struct Object*); | |
| @end smallexample | |
| It is not wrong to declare a class with the class-key @code{struct} as | |
| the example above shows. The @option{-Wmismatched-tags} option is intended | |
| to help achieve a consistent style of class declarations. In code that is | |
| intended to be portable to Windows-based compilers the warning helps prevent | |
| unresolved references due to the difference in the mangling of symbols | |
| declared with different class-keys. The option can be used either on its | |
| own or in conjunction with @option{-Wredundant-tags}. | |
| @opindex Wmultiple-inheritance | |
| @opindex Wno-multiple-inheritance | |
| @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)} | |
| Warn when a class is defined with multiple direct base classes. Some | |
| coding rules disallow multiple inheritance, and this may be used to | |
| enforce that rule. The warning is inactive inside a system header file, | |
| such as the STL, so one can still use the STL. One may also define | |
| classes that indirectly use multiple inheritance. | |
| @opindex Wvirtual-inheritance | |
| @opindex Wno-virtual-inheritance | |
| @item -Wvirtual-inheritance | |
| Warn when a class is defined with a virtual direct base class. Some | |
| coding rules disallow multiple inheritance, and this may be used to | |
| enforce that rule. The warning is inactive inside a system header file, | |
| such as the STL, so one can still use the STL. One may also define | |
| classes that indirectly use virtual inheritance. | |
| @opindex Wvirtual-move-assign | |
| @opindex Wno-virtual-move-assign | |
| @item -Wno-virtual-move-assign | |
| Suppress warnings about inheriting from a virtual base with a | |
| non-trivial C++11 move assignment operator. This is dangerous because | |
| if the virtual base is reachable along more than one path, it is | |
| moved multiple times, which can mean both objects end up in the | |
| moved-from state. If the move assignment operator is written to avoid | |
| moving from a moved-from object, this warning can be disabled. | |
| @opindex Wnamespaces | |
| @opindex Wno-namespaces | |
| @item -Wnamespaces | |
| Warn when a namespace definition is opened. Some coding rules disallow | |
| namespaces, and this may be used to enforce that rule. The warning is | |
| inactive inside a system header file, such as the STL, so one can still | |
| use the STL. One may also use using directives and qualified names. | |
| @opindex Wtemplate-body | |
| @opindex Wno-template-body | |
| @item -Wno-template-body @r{(C++ and Objective-C++ only)} | |
| Disable diagnosing errors when parsing a template, and instead issue an | |
| error only upon instantiation of the template. This flag can also be | |
| used to downgrade such errors into warnings with @option{Wno-error=} or | |
| @option{-fpermissive}. | |
| @opindex Wtemplate-id-cdtor | |
| @opindex Wno-template-id-cdtor | |
| @item -Wno-template-id-cdtor @r{(C++ and Objective-C++ only)} | |
| Disable the warning about the use of simple-template-id as the declarator-id | |
| of a constructor or destructor, which became invalid in C++20 via DR 2237. | |
| For example: | |
| @smallexample | |
| template<typename T> struct S @{ | |
| S<T>(); // should be S(); | |
| ~S<T>(); // should be ~S(); | |
| @}; | |
| @end smallexample | |
| @option{-Wtemplate-id-cdtor} is enabled by default with | |
| @option{-std=c++20}; it is also enabled by @option{-Wc++20-compat}. | |
| @opindex Wtemplate-names-tu-local | |
| @opindex Wno-template-names-tu-local | |
| @item -Wtemplate-names-tu-local | |
| Warn when a template body hides an exposure of a translation-unit-local | |
| entity. In most cases, referring to a translation-unit-local entity | |
| (such as an internal linkage declaration) within an entity that is | |
| emitted into a module's CMI is an error. However, within the | |
| initializer of a variable, or in the body of a non-inline function, | |
| this is not an exposure and no error is emitted. | |
| This can cause variable or function templates to accidentally become | |
| unusable if they reference such an entity, because other translation | |
| units that import the template will never be able to instantiate it. | |
| This warning attempts to detect cases where this might occur. | |
| The presence of an explicit instantiation silences the warning. | |
| This flag is enabled by @option{-Wextra}. | |
| @opindex Wexpose-global-module-tu-local | |
| @opindex Wno-expose-global-module-tu-local | |
| @item -Wno-expose-global-module-tu-local | |
| An exposure of a translation-unit-local entity from a module interface is | |
| invalid, as this may cause ODR violations and manifest in link errors or other | |
| unexpected behaviour. However, many existing libraries declare TU-local | |
| entities in their interface, and avoiding exposures of these entities may be | |
| difficult in some cases. | |
| As an extension, GCC allows exposures of internal variables and functions that | |
| were declared in the global module fragment. This warning indicates when such | |
| an invalid exposure has occurred, and can be silenced using diagnostic pragmas | |
| either at the site of the exposure, or at the point of declaration of the | |
| internal declaration. This also applies to @code{export using} declarations | |
| naming such entities. | |
| When combined with @option{-Wtemplate-names-tu-local}, GCC will also warn about | |
| non-exposure references to TU-local entities in template bodies. Such templates | |
| can still be instantiated in other TUs but the above risks regarding exposures | |
| of translation-unit-local entities apply. | |
| This warning is enabled by default, and is upgraded to an error by | |
| @option{-pedantic-errors}. | |
| @opindex Wexternal-tu-local | |
| @opindex Wno-external-tu-local | |
| @item -Wno-external-tu-local | |
| Warn when naming a TU-local entity outside of the translation unit it | |
| was declared in. Such declarations will be ignored during name lookup. | |
| This can occur when performing ADL from a template declared in the same | |
| TU as the internal function: | |
| @smallexample | |
| export module M; | |
| template <typename T> void foo(T t) @{ | |
| bar(t); | |
| @} | |
| struct S @{@} s; | |
| static void bar(S) @{@} // internal linkage | |
| // instantiating foo(s) from outside this TU can see ::bar, | |
| // but naming it there is ill-formed. | |
| @end smallexample | |
| This can be worked around by making @code{bar} attached to the global | |
| module, using @code{extern "C++"}. | |
| This warning is enabled by default, and is upgraded to an error by | |
| @option{-pedantic-errors}. | |
| @opindex Wterminate | |
| @opindex Wno-terminate | |
| @item -Wno-terminate @r{(C++ and Objective-C++ only)} | |
| Disable the warning about a throw-expression that will immediately | |
| result in a call to @code{terminate}. | |
| @opindex Wvexing-parse | |
| @opindex Wno-vexing-parse | |
| @item -Wno-vexing-parse @r{(C++ and Objective-C++ only)} | |
| Warn about the most vexing parse syntactic ambiguity. This warns about | |
| the cases when a declaration looks like a variable definition, but the | |
| C++ language requires it to be interpreted as a function declaration. | |
| For instance: | |
| @smallexample | |
| void f(double a) @{ | |
| int i(); // extern int i (void); | |
| int n(int(a)); // extern int n (int); | |
| @} | |
| @end smallexample | |
| Another example: | |
| @smallexample | |
| struct S @{ S(int); @}; | |
| void f(double a) @{ | |
| S x(int(a)); // extern struct S x (int); | |
| S y(int()); // extern struct S y (int (*) (void)); | |
| S z(); // extern struct S z (void); | |
| @} | |
| @end smallexample | |
| The warning will suggest options how to deal with such an ambiguity; e.g., | |
| it can suggest removing the parentheses or using braces instead. | |
| This warning is enabled by default. | |
| @opindex Wno-class-conversion | |
| @opindex Wclass-conversion | |
| @item -Wno-class-conversion @r{(C++ and Objective-C++ only)} | |
| Do not warn when a conversion function converts an | |
| object to the same type, to a base class of that type, or to void; such | |
| a conversion function will never be called. | |
| @opindex Wvolatile | |
| @opindex Wno-volatile | |
| @item -Wvolatile @r{(C++ and Objective-C++ only)} | |
| Warn about deprecated uses of the @code{volatile} qualifier. This includes | |
| postfix and prefix @code{++} and @code{--} expressions of | |
| @code{volatile}-qualified types, using simple assignments where the left | |
| operand is a @code{volatile}-qualified non-class type for their value, | |
| compound assignments where the left operand is a @code{volatile}-qualified | |
| non-class type, @code{volatile}-qualified function return type, | |
| @code{volatile}-qualified parameter type, and structured bindings of a | |
| @code{volatile}-qualified type. This usage was deprecated in C++20. | |
| Enabled by default with @option{-std=c++20}. Before | |
| @option{-std=c++20}, enabled with explicit @option{-Wdeprecated}. | |
| @opindex Waligned-new | |
| @opindex Wno-aligned-new | |
| @item -Waligned-new | |
| @itemx -Waligned-new=@r{[}none@r{|}global@r{|}all@r{]} | |
| Warn about a new-expression of a type that requires greater alignment | |
| than the @code{alignof(std::max_align_t)} but uses an allocation | |
| function without an explicit alignment parameter. This option is | |
| enabled by @option{-Wall}. | |
| Normally this only warns about global allocation functions, but | |
| @option{-Waligned-new=all} also warns about class member allocation | |
| functions. | |
| @opindex Wplacement-new | |
| @opindex Wno-placement-new | |
| @item -Wno-placement-new | |
| @itemx -Wplacement-new=@var{n} | |
| Warn about placement new expressions with undefined behavior, such as | |
| constructing an object in a buffer that is smaller than the type of | |
| the object. For example, the placement new expression below is diagnosed | |
| because it attempts to construct an array of 64 integers in a buffer only | |
| 64 bytes large. | |
| @smallexample | |
| char buf [64]; | |
| new (buf) int[64]; | |
| @end smallexample | |
| This warning is enabled by default. | |
| @table @gcctabopt | |
| @item -Wplacement-new=1 | |
| This is the default warning level of @option{-Wplacement-new}. At this | |
| level the warning is not issued for some strictly undefined constructs that | |
| GCC allows as extensions for compatibility with legacy code. For example, | |
| the following @code{new} expression is not diagnosed at this level even | |
| though it has undefined behavior according to the C++ standard because | |
| it writes past the end of the one-element array. | |
| @smallexample | |
| struct S @{ int n, a[1]; @}; | |
| S *s = (S *)malloc (sizeof *s + 31 * sizeof s->a[0]); | |
| new (s->a)int [32](); | |
| @end smallexample | |
| @item -Wplacement-new=2 | |
| At this level, in addition to diagnosing all the same constructs as at level | |
| 1, a diagnostic is also issued for placement new expressions that construct | |
| an object in the last member of structure whose type is an array of a single | |
| element and whose size is less than the size of the object being constructed. | |
| While the previous example would be diagnosed, the following construct makes | |
| use of the flexible member array extension to avoid the warning at level 2. | |
| @smallexample | |
| struct S @{ int n, a[]; @}; | |
| S *s = (S *)malloc (sizeof *s + 32 * sizeof s->a[0]); | |
| new (s->a)int [32](); | |
| @end smallexample | |
| @end table | |
| @opindex Wcatch-value | |
| @opindex Wno-catch-value | |
| @item -Wcatch-value | |
| @itemx -Wcatch-value=@var{n} @r{(C++ and Objective-C++ only)} | |
| Warn about catch handlers that do not catch via reference. | |
| With @option{-Wcatch-value=1} (or @option{-Wcatch-value} for short) | |
| warn about polymorphic class types that are caught by value. | |
| With @option{-Wcatch-value=2} warn about all class types that are caught | |
| by value. With @option{-Wcatch-value=3} warn about all types that are | |
| not caught by reference. @option{-Wcatch-value} is enabled by @option{-Wall}. | |
| @opindex Wconditionally-supported | |
| @opindex Wno-conditionally-supported | |
| @item -Wconditionally-supported @r{(C++ and Objective-C++ only)} | |
| Warn for conditionally-supported (C++11 [intro.defs]) constructs. | |
| @opindex Wdefaulted-function-deleted | |
| @opindex Wno-defaulted-function-deleted | |
| @item -Wno-defaulted-function-deleted @r{(C++ and Objective-C++ only)} | |
| Warn when an explicitly defaulted function is deleted by the compiler. | |
| That can occur when the function's declared type does not match the type | |
| of the function that would have been implicitly declared. This warning | |
| is enabled by default. | |
| @opindex Wdelete-incomplete | |
| @opindex Wno-delete-incomplete | |
| @item -Wno-delete-incomplete @r{(C++ and Objective-C++ only)} | |
| Do not warn when deleting a pointer to incomplete type, which may cause | |
| undefined behavior at runtime. This warning is enabled by default. | |
| @opindex Wextra-semi | |
| @opindex Wno-extra-semi | |
| @item -Wextra-semi @r{(C++, Objective-C++ only)} | |
| Warn about redundant semicolons. There are various contexts in which an extra | |
| semicolon can occur. One is a semicolon after in-class function definitions, | |
| which is valid in all C++ dialects (and is never a pedwarn): | |
| @smallexample | |
| struct S @{ | |
| void foo () @{@}; | |
| @}; | |
| @end smallexample | |
| Another is an extra semicolon at namespace scope, which has been allowed | |
| since C++11 (therefore is a pedwarn in C++98): | |
| @smallexample | |
| struct S @{ | |
| @}; | |
| ; | |
| @end smallexample | |
| And yet another is an extra semicolon in class definitions, which has been | |
| allowed since C++11 (therefore is a pedwarn in C++98): | |
| @smallexample | |
| struct S @{ | |
| int a; | |
| ; | |
| @}; | |
| @end smallexample | |
| @opindex Wno-global-module | |
| @opindex Wglobal-module | |
| @item -Wno-global-module @r{(C++ and Objective-C++ only)} | |
| Disable the diagnostic for when the global module fragment of a module | |
| unit does not consist only of preprocessor directives. | |
| @opindex Winaccessible-base | |
| @opindex Wno-inaccessible-base | |
| @item -Wno-inaccessible-base @r{(C++, Objective-C++ only)} | |
| This option controls warnings | |
| when a base class is inaccessible in a class derived from it due to | |
| ambiguity. The warning is enabled by default. | |
| Note that the warning for ambiguous virtual | |
| bases is enabled by the @option{-Wextra} option. | |
| @smallexample | |
| @group | |
| struct A @{ int a; @}; | |
| struct B : A @{ @}; | |
| struct C : B, A @{ @}; | |
| @end group | |
| @end smallexample | |
| @opindex Winherited-variadic-ctor | |
| @opindex Wno-inherited-variadic-ctor | |
| @item -Wno-inherited-variadic-ctor | |
| Suppress warnings about use of C++11 inheriting constructors when the | |
| base class inherited from has a C variadic constructor; the warning is | |
| on by default because the ellipsis is not inherited. | |
| @opindex Wno-invalid-offsetof | |
| @opindex Winvalid-offsetof | |
| @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)} | |
| Suppress warnings from applying the @code{offsetof} macro to a non-POD | |
| type. According to the 2014 ISO C++ standard, applying @code{offsetof} | |
| to a non-standard-layout type is undefined. In existing C++ implementations, | |
| however, @code{offsetof} typically gives meaningful results. | |
| This flag is for users who are aware that they are | |
| writing nonportable code and who have deliberately chosen to ignore the | |
| warning about it. | |
| The restrictions on @code{offsetof} may be relaxed in a future version | |
| of the C++ standard. | |
| @opindex Wsized-deallocation | |
| @opindex Wno-sized-deallocation | |
| @item -Wsized-deallocation @r{(C++ and Objective-C++ only)} | |
| Warn about a definition of an unsized deallocation function | |
| @smallexample | |
| void operator delete (void *) noexcept; | |
| void operator delete[] (void *) noexcept; | |
| @end smallexample | |
| without a definition of the corresponding sized deallocation function | |
| @smallexample | |
| void operator delete (void *, std::size_t) noexcept; | |
| void operator delete[] (void *, std::size_t) noexcept; | |
| @end smallexample | |
| or vice versa. Enabled by @option{-Wextra} along with | |
| @option{-fsized-deallocation}. | |
| @opindex Wno-suggest-final-types | |
| @opindex Wsuggest-final-types | |
| @item -Wsuggest-final-types | |
| Warn about types with virtual methods where code quality would be improved | |
| if the type were declared with the C++11 @code{final} specifier, | |
| or, if possible, | |
| declared in an anonymous namespace. This allows GCC to more aggressively | |
| devirtualize the polymorphic calls. This warning is more effective with | |
| link-time optimization, | |
| where the information about the class hierarchy graph is | |
| more complete. | |
| @opindex Wno-suggest-final-methods | |
| @opindex Wsuggest-final-methods | |
| @item -Wsuggest-final-methods | |
| Warn about virtual methods where code quality would be improved if the method | |
| were declared with the C++11 @code{final} specifier, | |
| or, if possible, its type were | |
| declared in an anonymous namespace or with the @code{final} specifier. | |
| This warning is | |
| more effective with link-time optimization, where the information about the | |
| class hierarchy graph is more complete. It is recommended to first consider | |
| suggestions of @option{-Wsuggest-final-types} and then rebuild with new | |
| annotations. | |
| @opindex Wsuggest-override | |
| @opindex Wno-suggest-override | |
| @item -Wsuggest-override | |
| Warn about overriding virtual functions that are not marked with the | |
| @code{override} keyword. | |
| @opindex Wconversion-null | |
| @opindex Wno-conversion-null | |
| @item -Wno-conversion-null @r{(C++ and Objective-C++ only)} | |
| Do not warn for conversions between @code{NULL} and non-pointer | |
| types. @option{-Wconversion-null} is enabled by default. | |
| @end table | |
| @node Objective-C and Objective-C++ Dialect Options | |
| @section Options Controlling Objective-C and Objective-C++ Dialects | |
| @cindex compiler options, Objective-C and Objective-C++ | |
| @cindex Objective-C and Objective-C++ options, command-line | |
| @cindex options, Objective-C and Objective-C++ | |
| (NOTE: This manual does not describe the Objective-C and Objective-C++ | |
| languages themselves. @xref{Standards,,Language Standards | |
| Supported by GCC}, for references.) | |
| This section describes the command-line options that are only meaningful | |
| for Objective-C and Objective-C++ programs. You can also use most of | |
| the language-independent GNU compiler options. | |
| For example, you might compile a file @file{some_class.m} like this: | |
| @smallexample | |
| gcc -g -fgnu-runtime -O -c some_class.m | |
| @end smallexample | |
| @noindent | |
| In this example, @option{-fgnu-runtime} is an option meant only for | |
| Objective-C and Objective-C++ programs; you can use the other options with | |
| any language supported by GCC@. | |
| Note that since Objective-C is an extension of the C language, Objective-C | |
| compilations may also use options specific to the C front-end (e.g., | |
| @option{-Wtraditional}). Similarly, Objective-C++ compilations may use | |
| C++-specific options (e.g., @option{-Wabi}). | |
| Here is a list of options that are @emph{only} for compiling Objective-C | |
| and Objective-C++ programs: | |
| @table @gcctabopt | |
| @opindex fconstant-string-class | |
| @item -fconstant-string-class=@var{class-name} | |
| Use @var{class-name} as the name of the class to instantiate for each | |
| literal string specified with the syntax @code{@@"@dots{}"}. The default | |
| class name is @code{NXConstantString} if the GNU runtime is being used, and | |
| @code{NSConstantString} if the NeXT runtime is being used (see below). On | |
| Darwin / macOS platforms, the @option{-fconstant-cfstrings} option, if | |
| also present, overrides the @option{-fconstant-string-class} setting and cause | |
| @code{@@"@dots{}"} literals to be laid out as constant CoreFoundation strings. | |
| Note that @option{-fconstant-cfstrings} is an alias for the target-specific | |
| @option{-mconstant-cfstrings} equivalent. | |
| @opindex fgnu-runtime | |
| @item -fgnu-runtime | |
| Generate object code compatible with the standard GNU Objective-C | |
| runtime. This is the default for most types of systems. | |
| @opindex fnext-runtime | |
| @item -fnext-runtime | |
| Generate output compatible with the NeXT runtime. This is the default | |
| for NeXT-based systems, including Darwin / macOS. The macro | |
| @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is | |
| used. | |
| @opindex fno-nil-receivers | |
| @opindex fnil-receivers | |
| @item -fno-nil-receivers | |
| Assume that all Objective-C message dispatches (@code{[receiver | |
| message:arg]}) in this translation unit ensure that the receiver is | |
| not @code{nil}. This allows for more efficient entry points in the | |
| runtime to be used. This option is only available in conjunction with | |
| the NeXT runtime and ABI version 0 or 1. | |
| @opindex fobjc-abi-version | |
| @item -fobjc-abi-version=@var{n} | |
| Use version @var{n} of the Objective-C ABI for the selected runtime. | |
| This option is currently supported only for the NeXT runtime. In that | |
| case, Version 0 is the traditional (32-bit) ABI without support for | |
| properties and other Objective-C 2.0 additions. Version 1 is the | |
| traditional (32-bit) ABI with support for properties and other | |
| Objective-C 2.0 additions. Version 2 is the modern (64-bit) ABI. If | |
| nothing is specified, the default is Version 0 on 32-bit target | |
| machines, and Version 2 on 64-bit target machines. | |
| @opindex fobjc-call-cxx-cdtors | |
| @opindex fno-objc-call-cxx-cdtors | |
| @item -fobjc-call-cxx-cdtors | |
| For each Objective-C class, check if any of its instance variables is a | |
| C++ object with a non-trivial default constructor. If so, synthesize a | |
| special @code{- (id) .cxx_construct} instance method which runs | |
| non-trivial default constructors on any such instance variables, in order, | |
| and then return @code{self}. Similarly, check if any instance variable | |
| is a C++ object with a non-trivial destructor, and if so, synthesize a | |
| special @code{- (void) .cxx_destruct} method which runs | |
| all such default destructors, in reverse order. | |
| The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct} | |
| methods thusly generated only operate on instance variables | |
| declared in the current Objective-C class, and not those inherited | |
| from superclasses. It is the responsibility of the Objective-C | |
| runtime to invoke all such methods in an object's inheritance | |
| hierarchy. The @code{- (id) .cxx_construct} methods are invoked | |
| by the runtime immediately after a new object instance is allocated; | |
| the @code{- (void) .cxx_destruct} methods are invoked immediately | |
| before the runtime deallocates an object instance. | |
| As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has | |
| support for invoking the @code{- (id) .cxx_construct} and | |
| @code{- (void) .cxx_destruct} methods. | |
| @opindex fobjc-direct-dispatch | |
| @opindex fno-objc-direct-dispatch | |
| @item -fobjc-direct-dispatch | |
| Allow fast jumps to the message dispatcher. On Darwin this is | |
| accomplished via the comm page. | |
| @opindex fobjc-exceptions | |
| @opindex fno-objc-exceptions | |
| @item -fobjc-exceptions | |
| Enable syntactic support for structured exception handling in | |
| Objective-C, similar to what is offered by C++. This option | |
| is required to use the Objective-C keywords @code{@@try}, | |
| @code{@@throw}, @code{@@catch}, @code{@@finally} and | |
| @code{@@synchronized}. This option is available with both the GNU | |
| runtime and the NeXT runtime (but not available in conjunction with | |
| the NeXT runtime on Mac OS X 10.2 and earlier). | |
| @opindex fobjc-gc | |
| @opindex fno-objc-gc | |
| @item -fobjc-gc | |
| Enable garbage collection (GC) in Objective-C and Objective-C++ | |
| programs. This option is only available with the NeXT runtime; the | |
| GNU runtime has a different garbage collection implementation that | |
| does not require special compiler flags. | |
| @opindex fobjc-nilcheck | |
| @opindex fno-objc-nilcheck | |
| @item -fobjc-nilcheck | |
| For the NeXT runtime with version 2 of the ABI, check for a nil | |
| receiver in method invocations before doing the actual method call. | |
| This is the default and can be disabled using | |
| @option{-fno-objc-nilcheck}. Class methods and super calls are never | |
| checked for nil in this way no matter what this flag is set to. | |
| Currently this flag does nothing when the GNU runtime, or an older | |
| version of the NeXT runtime ABI, is used. | |
| @opindex fobjc-std | |
| @item -fobjc-std=objc1 | |
| Conform to the language syntax of Objective-C 1.0, the language | |
| recognized by GCC 4.0. This only affects the Objective-C additions to | |
| the C/C++ language; it does not affect conformance to C/C++ standards, | |
| which is controlled by the separate C/C++ dialect option flags. When | |
| this option is used with the Objective-C or Objective-C++ compiler, | |
| any Objective-C syntax that is not recognized by GCC 4.0 is rejected. | |
| This is useful if you need to make sure that your Objective-C code can | |
| be compiled with older versions of GCC@. | |
| @opindex freplace-objc-classes | |
| @opindex fno-replace-objc-classes | |
| @item -freplace-objc-classes | |
| Emit a special marker instructing @command{ld(1)} not to statically link in | |
| the resulting object file, and allow @command{dyld(1)} to load it in at | |
| run time instead. This is used in conjunction with the Fix-and-Continue | |
| debugging mode, where the object file in question may be recompiled and | |
| dynamically reloaded in the course of program execution, without the need | |
| to restart the program itself. Currently, Fix-and-Continue functionality | |
| is only available in conjunction with the NeXT runtime on Mac OS X 10.3 | |
| and later. | |
| @opindex fzero-link | |
| @opindex fno-zero-link | |
| @item -fzero-link | |
| When compiling for the NeXT runtime, the compiler ordinarily replaces calls | |
| to @code{objc_getClass("@dots{}")} (when the name of the class is known at | |
| compile time) with static class references that get initialized at load time, | |
| which improves run-time performance. Specifying the @option{-fzero-link} flag | |
| suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")} | |
| to be retained. This is useful in Zero-Link debugging mode, since it allows | |
| for individual class implementations to be modified during program execution. | |
| The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")} | |
| regardless of command-line options. | |
| @opindex fno-local-ivars | |
| @opindex flocal-ivars | |
| @item -fno-local-ivars | |
| By default instance variables in Objective-C can be accessed as if | |
| they were local variables from within the methods of the class they're | |
| declared in. This can lead to shadowing between instance variables | |
| and other variables declared either locally inside a class method or | |
| globally with the same name. Specifying the @option{-fno-local-ivars} | |
| flag disables this behavior thus avoiding variable shadowing issues. | |
| @opindex fivar-visibility | |
| @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} | |
| Set the default instance variable visibility to the specified option | |
| so that instance variables declared outside the scope of any access | |
| modifier directives default to the specified visibility. | |
| @opindex gen-decls | |
| @item -gen-decls | |
| Dump interface declarations for all classes seen in the source file to a | |
| file named @file{@var{sourcename}.decl}. | |
| @opindex Wassign-intercept | |
| @opindex Wno-assign-intercept | |
| @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)} | |
| Warn whenever an Objective-C assignment is being intercepted by the | |
| garbage collector. | |
| @opindex Wproperty-assign-default | |
| @opindex Wno-property-assign-default | |
| @item -Wno-property-assign-default @r{(Objective-C and Objective-C++ only)} | |
| Do not warn if a property for an Objective-C object has no assign | |
| semantics specified. | |
| @opindex Wno-protocol | |
| @opindex Wprotocol | |
| @item -Wno-protocol @r{(Objective-C and Objective-C++ only)} | |
| If a class is declared to implement a protocol, a warning is issued for | |
| every method in the protocol that is not implemented by the class. The | |
| default behavior is to issue a warning for every method not explicitly | |
| implemented in the class, even if a method implementation is inherited | |
| from the superclass. If you use the @option{-Wno-protocol} option, then | |
| methods inherited from the superclass are considered to be implemented, | |
| and no warning is issued for them. | |
| @opindex Wobjc-root-class | |
| @opindex Wno-objc-root-class | |
| @item -Wobjc-root-class @r{(Objective-C and Objective-C++ only)} | |
| Warn if a class interface lacks a superclass. Most classes will inherit | |
| from @code{NSObject} (or @code{Object}) for example. When declaring | |
| classes intended to be root classes, the warning can be suppressed by | |
| marking their interfaces with @code{__attribute__((objc_root_class))}. | |
| @opindex Wselector | |
| @opindex Wno-selector | |
| @item -Wselector @r{(Objective-C and Objective-C++ only)} | |
| Warn if multiple methods of different types for the same selector are | |
| found during compilation. The check is performed on the list of methods | |
| in the final stage of compilation. Additionally, a check is performed | |
| for each selector appearing in a @code{@@selector(@dots{})} | |
| expression, and a corresponding method for that selector has been found | |
| during compilation. Because these checks scan the method table only at | |
| the end of compilation, these warnings are not produced if the final | |
| stage of compilation is not reached, for example because an error is | |
| found during compilation, or because the @option{-fsyntax-only} option is | |
| being used. | |
| @opindex Wstrict-selector-match | |
| @opindex Wno-strict-selector-match | |
| @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)} | |
| Warn if multiple methods with differing argument and/or return types are | |
| found for a given selector when attempting to send a message using this | |
| selector to a receiver of type @code{id} or @code{Class}. When this flag | |
| is off (which is the default behavior), the compiler omits such warnings | |
| if any differences found are confined to types that share the same size | |
| and alignment. | |
| @opindex Wundeclared-selector | |
| @opindex Wno-undeclared-selector | |
| @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)} | |
| Warn if a @code{@@selector(@dots{})} expression referring to an | |
| undeclared selector is found. A selector is considered undeclared if no | |
| method with that name has been declared before the | |
| @code{@@selector(@dots{})} expression, either explicitly in an | |
| @code{@@interface} or @code{@@protocol} declaration, or implicitly in | |
| an @code{@@implementation} section. This option always performs its | |
| checks as soon as a @code{@@selector(@dots{})} expression is found, | |
| while @option{-Wselector} only performs its checks in the final stage of | |
| compilation. This also enforces the coding style convention | |
| that methods and selectors must be declared before being used. | |
| @opindex print-objc-runtime-info | |
| @item -print-objc-runtime-info | |
| Generate C header describing the largest structure that is passed by | |
| value, if any. | |
| @end table | |
| @node OpenMP and OpenACC Options | |
| @section Options Controlling OpenMP and OpenACC | |
| @cindex OpenMP options | |
| @cindex OpenACC options | |
| GCC supports OpenMP extensions to the C, C++, and Fortran languages | |
| with the @option{-fopenmp} option. Similarly, OpenACC extensions are | |
| supported in all three languages with @option{-fopenacc}. | |
| @xref{OpenMP} and @ref{OpenACC} for an overview of these extensions. | |
| @table @gcctabopt | |
| @opindex foffload | |
| @cindex Offloading targets | |
| @cindex OpenACC offloading targets | |
| @cindex OpenMP offloading targets | |
| @item -foffload=disable | |
| @itemx -foffload=default | |
| @itemx -foffload=@var{target-list} | |
| Specify for which OpenMP and OpenACC offload targets code should be generated. | |
| The default behavior, equivalent to @option{-foffload=default}, is to generate | |
| code for all supported offload targets. The @option{-foffload=disable} form | |
| generates code only for the host fallback, while | |
| @option{-foffload=@var{target-list}} generates code only for the specified | |
| comma-separated list of offload targets. | |
| Offload targets are specified in GCC's internal target-triplet format. You can | |
| run the compiler with @option{-v} to show the list of configured offload targets | |
| under @code{OFFLOAD_TARGET_NAMES}. | |
| @opindex foffload-options | |
| @cindex Offloading options | |
| @cindex OpenACC offloading options | |
| @cindex OpenMP offloading options | |
| @item -foffload-options=@var{options} | |
| @itemx -foffload-options=@var{target-triplet-list}=@var{options} | |
| With @option{-foffload-options=@var{options}}, GCC passes the specified | |
| @var{options} to the compilers for all enabled offloading targets. You can | |
| specify options that apply only to a specific target or targets by using | |
| the @option{-foffload-options=@var{target-list}=@var{options}} form. The | |
| @var{target-list} is a comma-separated list in the same format as for the | |
| @option{-foffload=} option. | |
| Typical command lines are | |
| @smallexample | |
| -foffload-options='-fno-math-errno -ffinite-math-only' \ | |
| -foffload-options=nvptx-none=-latomic | |
| -foffload-options=amdgcn-amdhsa=-march=gfx906 | |
| @end smallexample | |
| @opindex fopenacc | |
| @opindex fno-openacc | |
| @cindex OpenACC accelerator programming | |
| @item -fopenacc | |
| Enable handling of OpenACC directives @samp{#pragma acc} in C/C++ and | |
| @samp{!$acc} in free-form Fortran and @samp{!$acc}, @samp{c$acc} and | |
| @samp{*$acc} in fixed-form Fortran. This option | |
| implies @option{-pthread}, and thus is only supported on targets that | |
| have support for @option{-pthread}. | |
| @opindex fopenacc-dim | |
| @item -fopenacc-dim=@var{geom} | |
| Specify default compute dimensions for parallel offload regions that do | |
| not explicitly specify them. The @var{geom} value is a triple of | |
| @samp{:}-separated sizes, in order @var{gang}, @var{worker}, and @var{vector}. | |
| A size can be omitted, to use a target-specific default value. | |
| @opindex fopenmp | |
| @opindex fno-openmp | |
| @cindex OpenMP parallel | |
| @item -fopenmp | |
| Enable handling of OpenMP directives @samp{#pragma omp}, | |
| @samp{[[omp::decl(...)]]}, @samp{[[omp::directive(...)]]}, | |
| and @samp{[[omp::sequence(...)]]} in C/C++. In Fortran, it enables | |
| @samp{!$omp} and the conditional compilation sentinel @samp{!$}. | |
| In fixed source form Fortran, the sentinels can also start with | |
| @samp{c} or @samp{*}. | |
| This option implies @option{-pthread}, and thus is only supported on | |
| targets that have support for @option{-pthread}. @option{-fopenmp} | |
| implies @option{-fopenmp-simd}. | |
| @opindex fopenmp-simd | |
| @opindex fno-openmp-simd | |
| @cindex OpenMP SIMD | |
| @cindex SIMD | |
| @item -fopenmp-simd | |
| Enable handling of OpenMP's @code{simd}, @code{declare simd}, | |
| @code{declare reduction}, @code{assume}, @code{ordered}, @code{scan} | |
| and @code{loop} directive, and of combined or composite directives with | |
| @code{simd} as constituent with @code{#pragma omp}, | |
| @code{[[omp::directive(...)]]}, @code{[[omp::sequence(...)]]} and | |
| @code{[[omp::decl(...)]]} in C/C++ and @code{!$omp} in Fortran. It | |
| additionally enables the conditional compilation sentinel @samp{!$} in | |
| Fortran. In fixed source form Fortran, the sentinels can also start with | |
| @samp{c} or @samp{*}. Other OpenMP directives are ignored. Unless | |
| @option{-fopenmp} is additionally specified, the @code{loop} region binds | |
| to the current task region, independent of the specified @code{bind} clause. | |
| @opindex fopenmp-ompt | |
| @cindex OpenMP OMPT | |
| @item -fopenmp-ompt | |
| @itemx -fopenmp-ompt=@var{level} | |
| Control how much detail GCC reports to an @dfn{OMPT} tool---a tool | |
| that registers callbacks with the OpenMP runtime to observe events | |
| such as when a parallel region or worksharing construct starts and | |
| ends. The @var{level} argument is one of @samp{minimal}, @samp{basic}, | |
| or @samp{extended}; @option{-fopenmp-ompt} without an argument is | |
| equivalent to @option{-fopenmp-ompt=basic}. OMPT support itself is | |
| always present with @option{-fopenmp}; this option only changes how | |
| much is reported and at what runtime cost. Requires | |
| @option{-fopenmp}. | |
| @table @samp | |
| @item minimal | |
| The level used when @option{-fopenmp-ompt} is not specified. Some | |
| OpenMP constructs are reported to an OMPT tool as a single combined | |
| ``encountered'' event, so a tool cannot tell how long the construct's | |
| region actually ran. No extra runtime calls are generated beyond | |
| what the construct's semantics already require. | |
| @item basic | |
| For the @code{single}, @code{masked}, and @code{master} constructs, | |
| and for @code{distribute} and worksharing-loop (@code{for}/@code{do}) | |
| constructs that use static scheduling, GCC instead reports a separate | |
| ``begin'' event when the region is entered and an ``end'' event when | |
| it is left. This lets an OMPT tool measure the time actually spent in | |
| those regions, at the cost of one extra runtime call per region. | |
| @item extended | |
| In addition to what @samp{basic} reports, report a ``dispatch'' event | |
| each time a new chunk of loop iterations begins within a statically | |
| scheduled @code{distribute} or worksharing-loop construct (a | |
| @dfn{chunk} is the contiguous run of iterations handed to one thread | |
| or team at a time). This lets an OMPT tool see how work is actually | |
| split across threads, but adds a runtime call for every chunk, which | |
| can be measurably slower for loops with many small chunks. | |
| @end table | |
| There is no @option{-fno-openmp-ompt}: the lowest available level is | |
| @option{-fopenmp-ompt=minimal}, since OMPT support cannot be disabled | |
| outright once @option{-fopenmp} is in effect. | |
| @opindex fopenmp-target-simd-clone | |
| @opindex fno-openmp-target-simd-clone | |
| @cindex OpenMP target SIMD clone | |
| @item -fopenmp-target-simd-clone | |
| @item -fopenmp-target-simd-clone=@var{device-type} | |
| In addition to generating SIMD clones for functions marked with the | |
| @code{declare simd} directive, GCC also generates clones | |
| for functions marked with the OpenMP @code{declare target} directive | |
| that are suitable for vectorization when this option is in effect. The | |
| @var{device-type} may be one of @code{none}, @code{host}, @code{nohost}, | |
| and @code{any}, which correspond to keywords for the @code{device_type} | |
| clause of the @code{declare target} directive; clones are generated for | |
| the intersection of devices specified. | |
| @option{-fopenmp-target-simd-clone} is equivalent to | |
| @option{-fopenmp-target-simd-clone=any} and | |
| @option{-fno-openmp-target-simd-clone} is equivalent to | |
| @option{-fopenmp-target-simd-clone=none}. | |
| At @option{-O2} and higher (but not @option{-Os} or @option{-Og}) this | |
| optimization defaults to @option{-fopenmp-target-simd-clone=nohost}; otherwise | |
| it is disabled by default. | |
| @end table | |
| @node Diagnostic Message Formatting Options | |
| @section Options to Control Diagnostic Messages Formatting | |
| @cindex options to control diagnostics formatting | |
| @cindex diagnostic messages | |
| @cindex message formatting | |
| Traditionally, diagnostic messages have been formatted irrespective of | |
| the output device's aspect (e.g.@: its width, @dots{}). You can use the | |
| options described below | |
| to control the formatting algorithm for diagnostic messages, | |
| e.g.@: how many characters per line, how often source location | |
| information should be reported. Note that some language front ends may not | |
| honor these options. | |
| @table @gcctabopt | |
| @opindex fmessage-length | |
| @item -fmessage-length=@var{n} | |
| Try to format error messages so that they fit on lines of about | |
| @var{n} characters. If @var{n} is zero, then no line-wrapping is | |
| done; each error message appears on a single line. This is the | |
| default for all front ends. | |
| Note - this option also affects the display of the @samp{#error} and | |
| @samp{#warning} pre-processor directives, and the @samp{deprecated} | |
| function/type/variable attribute. It does not however affect the | |
| @samp{pragma GCC warning} and @samp{pragma GCC error} pragmas. | |
| @opindex fdiagnostics-plain-output | |
| @item -fdiagnostics-plain-output | |
| This option requests that diagnostic output look as plain as possible, which | |
| may be useful when running @command{dejagnu} or other utilities that need to | |
| parse diagnostics output and prefer that it remain more stable over time. | |
| @option{-fdiagnostics-plain-output} is currently equivalent to the following | |
| options: | |
| @gccoptlist{-fno-diagnostics-show-caret | |
| -fno-diagnostics-show-line-numbers | |
| -fdiagnostics-color=never | |
| -fdiagnostics-urls=never | |
| -fdiagnostics-path-format=separate-events | |
| -fdiagnostics-text-art-charset=none | |
| -fno-diagnostics-show-event-links | |
| -fno-diagnostics-show-nesting} | |
| In the future, if GCC changes the default appearance of its diagnostics, the | |
| corresponding option to disable the new behavior will be added to this list. | |
| @opindex fdiagnostics-show-location | |
| @item -fdiagnostics-show-location=once | |
| Only meaningful in line-wrapping mode. Instructs the diagnostic messages | |
| reporter to emit source location information @emph{once}; that is, in | |
| case the message is too long to fit on a single physical line and has to | |
| be wrapped, the source location won't be emitted (as prefix) again, | |
| over and over, in subsequent continuation lines. This is the default | |
| behavior. | |
| @item -fdiagnostics-show-location=every-line | |
| Only meaningful in line-wrapping mode. Instructs the diagnostic | |
| messages reporter to emit the same source location information (as | |
| prefix) for physical lines that result from the process of breaking | |
| a message which is too long to fit on a single line. | |
| @opindex fdiagnostics-color | |
| @opindex fno-diagnostics-color | |
| @cindex highlight, color | |
| @vindex GCC_COLORS @r{environment variable} | |
| @item -fdiagnostics-color[=@var{WHEN}] | |
| @itemx -fno-diagnostics-color | |
| Use color in diagnostics. @var{WHEN} is @samp{never}, @samp{always}, | |
| or @samp{auto}. The default depends on how the compiler has been configured, | |
| it can be any of the above @var{WHEN} options or also @samp{never} | |
| if @env{GCC_COLORS} environment variable isn't present in the environment, | |
| and @samp{auto} otherwise. | |
| @samp{auto} makes GCC use color only when the standard error is a terminal, | |
| and when not executing in an emacs shell. | |
| The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are | |
| aliases for @option{-fdiagnostics-color=always} and | |
| @option{-fdiagnostics-color=never}, respectively. | |
| The colors are defined by the environment variable @env{GCC_COLORS}. | |
| Its value is a colon-separated list of capabilities and Select Graphic | |
| Rendition (SGR) substrings. SGR commands are interpreted by the | |
| terminal or terminal emulator. (See the section in the documentation | |
| of your text terminal for permitted values and their meanings as | |
| character attributes.) These substring values are integers in decimal | |
| representation and can be concatenated with semicolons. | |
| Common values to concatenate include | |
| @samp{1} for bold, | |
| @samp{4} for underline, | |
| @samp{5} for blink, | |
| @samp{7} for inverse, | |
| @samp{39} for default foreground color, | |
| @samp{30} to @samp{37} for foreground colors, | |
| @samp{90} to @samp{97} for 16-color mode foreground colors, | |
| @samp{38;5;0} to @samp{38;5;255} | |
| for 88-color and 256-color modes foreground colors, | |
| @samp{49} for default background color, | |
| @samp{40} to @samp{47} for background colors, | |
| @samp{100} to @samp{107} for 16-color mode background colors, | |
| and @samp{48;5;0} to @samp{48;5;255} | |
| for 88-color and 256-color modes background colors. | |
| The default @env{GCC_COLORS} is | |
| @smallexample | |
| error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\ | |
| quote=01:path=01;36:fixit-insert=32:fixit-delete=31:\ | |
| diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32:\ | |
| type-diff=01;32:fnname=01;32:targs=35:valid=01;31:invalid=01;32:\ | |
| highlight-a=01;32:highlight-b=01;34 | |
| @end smallexample | |
| @noindent | |
| where @samp{01;31} is bold red, @samp{01;35} is bold magenta, | |
| @samp{01;36} is bold cyan, @samp{32} is green, @samp{34} is blue, | |
| @samp{01} is bold, and @samp{31} is red. | |
| Setting @env{GCC_COLORS} to the empty string disables colors. | |
| Supported capabilities are as follows. | |
| @table @code | |
| @vindex error GCC_COLORS @r{capability} | |
| @item error= | |
| SGR substring for error: markers. | |
| @vindex warning GCC_COLORS @r{capability} | |
| @item warning= | |
| SGR substring for warning: markers. | |
| @vindex note GCC_COLORS @r{capability} | |
| @item note= | |
| SGR substring for note: markers. | |
| @vindex path GCC_COLORS @r{capability} | |
| @item path= | |
| SGR substring for colorizing paths of control-flow events as printed | |
| via @option{-fdiagnostics-path-format=}, such as the identifiers of | |
| individual events and lines indicating interprocedural calls and returns. | |
| @vindex range1 GCC_COLORS @r{capability} | |
| @item range1= | |
| SGR substring for first additional range. | |
| @vindex range2 GCC_COLORS @r{capability} | |
| @item range2= | |
| SGR substring for second additional range. | |
| @vindex locus GCC_COLORS @r{capability} | |
| @item locus= | |
| SGR substring for location information, @samp{file:line} or | |
| @samp{file:line:column} etc. | |
| @vindex quote GCC_COLORS @r{capability} | |
| @item quote= | |
| SGR substring for information printed within quotes. | |
| @vindex fnname GCC_COLORS @r{capability} | |
| @item fnname= | |
| SGR substring for names of C++ functions. | |
| @vindex targs GCC_COLORS @r{capability} | |
| @item targs= | |
| SGR substring for C++ function template parameter bindings. | |
| @vindex fixit-insert GCC_COLORS @r{capability} | |
| @item fixit-insert= | |
| SGR substring for fix-it hints suggesting text to | |
| be inserted or replaced. | |
| @vindex fixit-delete GCC_COLORS @r{capability} | |
| @item fixit-delete= | |
| SGR substring for fix-it hints suggesting text to | |
| be deleted. | |
| @vindex diff-filename GCC_COLORS @r{capability} | |
| @item diff-filename= | |
| SGR substring for filename headers within generated patches. | |
| @vindex diff-hunk GCC_COLORS @r{capability} | |
| @item diff-hunk= | |
| SGR substring for the starts of hunks within generated patches. | |
| @vindex diff-delete GCC_COLORS @r{capability} | |
| @item diff-delete= | |
| SGR substring for deleted lines within generated patches. | |
| @vindex diff-insert GCC_COLORS @r{capability} | |
| @item diff-insert= | |
| SGR substring for inserted lines within generated patches. | |
| @vindex type-diff GCC_COLORS @r{capability} | |
| @item type-diff= | |
| SGR substring for highlighting mismatching types within template | |
| arguments in the C++ frontend. | |
| @vindex valid GCC_COLORS @r{capability} | |
| @item valid= | |
| SGR substring for highlighting valid elements within text art diagrams. | |
| @vindex invalid GCC_COLORS @r{capability} | |
| @item invalid= | |
| SGR substring for highlighting invalid elements within text art diagrams. | |
| @vindex highlight-a GCC_COLORS @r{capability} | |
| @vindex highlight-b GCC_COLORS @r{capability} | |
| @item highlight-a= | |
| @item highlight-b= | |
| SGR substrings for contrasting two different things within diagnostics, | |
| such as a pair of mismatching types. | |
| See @option{-fdiagnostics-show-highlight-colors}. | |
| @end table | |
| @opindex fdiagnostics-urls | |
| @cindex urls | |
| @vindex GCC_URLS @r{environment variable} | |
| @vindex TERM_URLS @r{environment variable} | |
| @item -fdiagnostics-urls[=@var{WHEN}] | |
| Use escape sequences to embed URLs in diagnostics. For example, when | |
| @option{-fdiagnostics-show-option} emits text showing the command-line | |
| option controlling a diagnostic, embed a URL for documentation of that | |
| option. | |
| @var{WHEN} is @samp{never}, @samp{always}, or @samp{auto}. | |
| @samp{auto} makes GCC use URL escape sequences only when the standard error | |
| is a terminal, and when not executing in an emacs shell or any graphical | |
| terminal which is known to be incompatible with this feature, see below. | |
| The default depends on how the compiler has been configured. | |
| It can be any of the above @var{WHEN} options. | |
| GCC can also be configured (via the | |
| @option{--with-diagnostics-urls=auto-if-env} configure-time option) | |
| so that the default is affected by environment variables. | |
| Under such a configuration, GCC defaults to using @samp{auto} | |
| if either @env{GCC_URLS} or @env{TERM_URLS} environment variables are | |
| present and non-empty in the environment of the compiler, or @samp{never} | |
| if neither are. | |
| However, even with @option{-fdiagnostics-urls=always} the behavior is | |
| dependent on those environment variables: | |
| If @env{GCC_URLS} is set to empty or @samp{no}, do not embed URLs in | |
| diagnostics. If set to @samp{st}, URLs use ST escape sequences. | |
| If set to @samp{bel}, the default, URLs use BEL escape sequences. | |
| Any other non-empty value enables the feature. | |
| If @env{GCC_URLS} is not set, use @env{TERM_URLS} as a fallback. | |
| Note: ST is an ANSI escape sequence, string terminator @samp{ESC \}, | |
| BEL is an ASCII character, CTRL-G that usually sounds like a beep. | |
| At this time GCC tries to detect also a few terminals that are known to | |
| not implement the URL feature, and have bugs or at least had bugs in | |
| some versions that are still in use, where the URL escapes are likely | |
| to misbehave, i.e. print garbage on the screen. | |
| That list is currently xfce4-terminal, certain known to be buggy | |
| gnome-terminal versions, the linux console, and mingw. | |
| This check can be skipped with the @option{-fdiagnostics-urls=always}. | |
| @opindex fno-diagnostics-show-option | |
| @opindex fdiagnostics-show-option | |
| @item -fno-diagnostics-show-option | |
| By default, each diagnostic emitted includes text indicating the | |
| command-line option that directly controls the diagnostic (if such an | |
| option is known to the diagnostic machinery). Specifying the | |
| @option{-fno-diagnostics-show-option} flag suppresses that behavior. | |
| @opindex fno-diagnostics-show-caret | |
| @opindex fdiagnostics-show-caret | |
| @item -fno-diagnostics-show-caret | |
| By default, each diagnostic emitted includes the original source line | |
| and a caret @samp{^} indicating the column. This option suppresses this | |
| information. The source line is truncated to @var{n} characters, if | |
| the @option{-fmessage-length=n} option is given. When the output is done | |
| to the terminal, the width is limited to the width given by the | |
| @env{COLUMNS} environment variable or, if not set, to the terminal width. | |
| @opindex fno-diagnostics-show-labels | |
| @opindex fdiagnostics-show-labels | |
| @item -fno-diagnostics-show-labels | |
| By default, when printing source code (via @option{-fdiagnostics-show-caret}), | |
| diagnostics can label ranges of source code with pertinent information, such | |
| as the types of expressions: | |
| @smallexample | |
| printf ("foo %s bar", long_i + long_j); | |
| ~^ ~~~~~~~~~~~~~~~ | |
| | | | |
| char * long int | |
| @end smallexample | |
| This option suppresses the printing of these labels (in the example above, | |
| the vertical bars and the ``char *'' and ``long int'' text). | |
| @opindex fno-diagnostics-show-event-links | |
| @opindex fdiagnostics-show-event-links | |
| @item -fno-diagnostics-show-event-links | |
| By default, when printing execution paths (via | |
| @option{-fdiagnostics-path-format=inline-events}), GCC will print lines | |
| connecting related events, such as the line connecting events 1 and 2 in: | |
| @smallexample | |
| 3 | if (p) | |
| | ^ | |
| | | | |
| | (1) following `false' branch (when `p' is NULL)... ->-+ | |
| | | | |
| | | | |
| |+------------------------------------------------------------+ | |
| 4 || return 0; | |
| 5 || return *p; | |
| || ~ | |
| || | | |
| |+-------->(2) ...to here | |
| | (3) dereference of NULL `p' | |
| @end smallexample | |
| This option suppresses the printing of such connector lines. | |
| @opindex fno-diagnostics-show-cwe | |
| @opindex fdiagnostics-show-cwe | |
| @item -fno-diagnostics-show-cwe | |
| Diagnostic messages can optionally have an associated | |
| @uref{https://cwe.mitre.org/index.html, CWE} identifier. | |
| GCC itself only provides such metadata for some of the @option{-fanalyzer} | |
| diagnostics. GCC plugins may also provide diagnostics with such metadata. | |
| By default, if this information is present, it will be printed with | |
| the diagnostic. This option suppresses the printing of this metadata. | |
| @opindex fno-diagnostics-show-rules | |
| @opindex fdiagnostics-show-rules | |
| @item -fno-diagnostics-show-rules | |
| Diagnostic messages can optionally have rules associated with them, such | |
| as from a coding standard, or a specification. | |
| GCC itself does not do this for any of its diagnostics, but plugins may do so. | |
| By default, if this information is present, it will be printed with | |
| the diagnostic. This option suppresses the printing of this metadata. | |
| @opindex fno-diagnostics-show-highlight-colors | |
| @opindex fdiagnostics-show-highlight-colors | |
| @item -fno-diagnostics-show-highlight-colors | |
| GCC can use color for emphasis and contrast when printing diagnostic | |
| messages and quoting the user's source. | |
| For example, in | |
| @smallexample | |
| demo.c: In function `test_bad_format_string_args': | |
| ../../src/demo.c:25:18: warning: format `%i' expects argument of type `int', but argument 2 has type `const char *' [-Wformat=] | |
| 25 | printf("hello %i", msg); | |
| | ~^ ~~~ | |
| | | | | |
| | int const char * | |
| | %s | |
| @end smallexample | |
| @itemize @bullet | |
| @item | |
| the @code{%i} and @code{int} in the message and the @code{int} in the | |
| quoted source are colored using @code{highlight-a} (bold green by default), | |
| and | |
| @item | |
| the @code{const char *} in the message and in the quoted source are both | |
| colored using @code{highlight-b} (bold blue by default). | |
| @end itemize | |
| The intent is to draw the reader's eyes to the relationships between the | |
| various aspects of the diagnostic message and the source, using color | |
| to group related elements and distinguish between mismatching ones. | |
| This additional colorization is enabled by default if color printing | |
| is enabled (as per @option{-fdiagnostics-color=}), but it can be separately | |
| disabled via @option{-fno-diagnostics-show-highlight-colors}. | |
| @opindex fno-diagnostics-show-line-numbers | |
| @opindex fdiagnostics-show-line-numbers | |
| @item -fno-diagnostics-show-line-numbers | |
| By default, when printing source code (via @option{-fdiagnostics-show-caret}), | |
| a left margin is printed, showing line numbers. This option suppresses this | |
| left margin. | |
| @opindex fdiagnostics-minimum-margin-width | |
| @item -fdiagnostics-minimum-margin-width=@var{width} | |
| This option controls the minimum width of the left margin printed by | |
| @option{-fdiagnostics-show-line-numbers}. It defaults to 6. | |
| @opindex fdiagnostics-show-context | |
| @opindex fno-diagnostics-show-context | |
| @item -fdiagnostics-show-context[=@var{depth}] | |
| @itemx -fno-diagnostics-show-context | |
| With this option, the compiler might print the interesting control flow | |
| chain that guards the basic block of the statement which has the warning. | |
| @var{depth} is the maximum depth of the control flow chain. | |
| Currently, The list of the impacted warning options includes: | |
| @option{-Warray-bounds}, @option{-Wstringop-overflow}, | |
| @option{-Wstringop-overread}, @option{-Wstringop-truncation}. | |
| and @option{-Wrestrict}. | |
| More warning options might be added to this list in future releases. | |
| The forms @option{-fdiagnostics-show-context} and | |
| @option{-fno-diagnostics-show-context} are aliases for | |
| @option{-fdiagnostics-show-context=1} and | |
| @option{-fdiagnostics-show-context=0}, respectively. | |
| @opindex fdiagnostics-parseable-fixits | |
| @opindex fno-diagnostics-parseable-fixits | |
| @item -fdiagnostics-parseable-fixits | |
| Emit fix-it hints in a machine-parseable format, suitable for consumption | |
| by IDEs. For each fix-it, a line will be printed after the relevant | |
| diagnostic, starting with the string ``fix-it:''. For example: | |
| @smallexample | |
| fix-it:"test.c":@{45:3-45:21@}:"gtk_widget_show_all" | |
| @end smallexample | |
| The location is expressed as a half-open range, expressed as a count of | |
| bytes, starting at byte 1 for the initial column. In the above example, | |
| bytes 3 through 20 of line 45 of ``test.c'' are to be replaced with the | |
| given string: | |
| @smallexample | |
| 00000000011111111112222222222 | |
| 12345678901234567890123456789 | |
| gtk_widget_showall (dlg); | |
| ^^^^^^^^^^^^^^^^^^ | |
| gtk_widget_show_all | |
| @end smallexample | |
| The filename and replacement string escape backslash as ``\\", tab as ``\t'', | |
| newline as ``\n'', double quotes as ``\"'', non-printable characters as octal | |
| (e.g. vertical tab as ``\013''). | |
| An empty replacement string indicates that the given range is to be removed. | |
| An empty range (e.g. ``45:3-45:3'') indicates that the string is to | |
| be inserted at the given position. | |
| @opindex fdiagnostics-generate-patch | |
| @opindex fno-diagnostics-generate-patch | |
| @item -fdiagnostics-generate-patch | |
| Print fix-it hints to stderr in unified diff format, after any diagnostics | |
| are printed. For example: | |
| @smallexample | |
| --- test.c | |
| +++ test.c | |
| @@ -42,5 +42,5 @@ | |
| void show_cb(GtkDialog *dlg) | |
| @{ | |
| - gtk_widget_showall(dlg); | |
| + gtk_widget_show_all(dlg); | |
| @} | |
| @end smallexample | |
| The diff may or may not be colorized, following the same rules | |
| as for diagnostics (see @option{-fdiagnostics-color}). | |
| @opindex fdiagnostics-show-template-tree | |
| @opindex fno-diagnostics-show-template-tree | |
| @item -fdiagnostics-show-template-tree | |
| In the C++ frontend, when printing diagnostics showing mismatching | |
| template types, such as: | |
| @smallexample | |
| could not convert 'std::map<int, std::vector<double> >()' | |
| from 'map<[...],vector<double>>' to 'map<[...],vector<float>> | |
| @end smallexample | |
| the @option{-fdiagnostics-show-template-tree} flag enables printing a | |
| tree-like structure showing the common and differing parts of the types, | |
| such as: | |
| @smallexample | |
| map< | |
| [...], | |
| vector< | |
| [double != float]>> | |
| @end smallexample | |
| The parts that differ are highlighted with color (``double'' and | |
| ``float'' in this case). | |
| @opindex fno-elide-type | |
| @opindex felide-type | |
| @item -fno-elide-type | |
| By default when the C++ frontend prints diagnostics showing mismatching | |
| template types, common parts of the types are printed as ``[...]'' to | |
| simplify the error message. For example: | |
| @smallexample | |
| could not convert 'std::map<int, std::vector<double> >()' | |
| from 'map<[...],vector<double>>' to 'map<[...],vector<float>> | |
| @end smallexample | |
| Specifying the @option{-fno-elide-type} flag suppresses that behavior. | |
| This flag also affects the output of the | |
| @option{-fdiagnostics-show-template-tree} flag. | |
| @opindex fdiagnostics-path-format | |
| @item -fdiagnostics-path-format=@var{KIND} | |
| Specify how to print paths of control-flow events for diagnostics that | |
| have such a path associated with them. | |
| @var{KIND} is @samp{none}, @samp{separate-events}, or @samp{inline-events}, | |
| the default. | |
| @samp{none} means to not print diagnostic paths. | |
| @samp{separate-events} means to print a separate ``note'' diagnostic for | |
| each event within the diagnostic. For example: | |
| @smallexample | |
| test.c:29:5: error: passing NULL as argument 1 to 'PyList_Append' which requires a non-NULL parameter | |
| test.c:25:10: note: (1) when 'PyList_New' fails, returning NULL | |
| test.c:27:3: note: (2) when 'i < count' | |
| test.c:29:5: note: (3) when calling 'PyList_Append', passing NULL from (1) as argument 1 | |
| @end smallexample | |
| @samp{inline-events} means to print the events ``inline'' within the source | |
| code. This view attempts to consolidate the events into runs of | |
| sufficiently-close events, printing them as labelled ranges within the source. | |
| For example, the same events as above might be printed as: | |
| @smallexample | |
| 'test': events 1-3 | |
| 25 | list = PyList_New(0); | |
| | ^~~~~~~~~~~~~ | |
| | | | |
| | (1) when 'PyList_New' fails, returning NULL | |
| 26 | | |
| 27 | for (i = 0; i < count; i++) @{ | |
| | ~~~ | |
| | | | |
| | (2) when 'i < count' | |
| 28 | item = PyLong_FromLong(random()); | |
| 29 | PyList_Append(list, item); | |
| | ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| | | | |
| | (3) when calling 'PyList_Append', passing NULL from (1) as argument 1 | |
| @end smallexample | |
| Interprocedural control flow is shown by grouping the events by stack frame, | |
| and using indentation to show how stack frames are nested, pushed, and popped. | |
| For example: | |
| @smallexample | |
| 'test': events 1-2 | |
| | | |
| | 133 | @{ | |
| | | ^ | |
| | | | | |
| | | (1) entering 'test' | |
| | 134 | boxed_int *obj = make_boxed_int (i); | |
| | | ~~~~~~~~~~~~~~~~~~ | |
| | | | | |
| | | (2) calling 'make_boxed_int' | |
| | | |
| +--> 'make_boxed_int': events 3-4 | |
| | | |
| | 120 | @{ | |
| | | ^ | |
| | | | | |
| | | (3) entering 'make_boxed_int' | |
| | 121 | boxed_int *result = (boxed_int *)wrapped_malloc (sizeof (boxed_int)); | |
| | | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| | | | | |
| | | (4) calling 'wrapped_malloc' | |
| | | |
| +--> 'wrapped_malloc': events 5-6 | |
| | | |
| | 7 | @{ | |
| | | ^ | |
| | | | | |
| | | (5) entering 'wrapped_malloc' | |
| | 8 | return malloc (size); | |
| | | ~~~~~~~~~~~~~ | |
| | | | | |
| | | (6) calling 'malloc' | |
| | | |
| <-------------+ | |
| | | |
| 'test': event 7 | |
| | | |
| | 138 | free_boxed_int (obj); | |
| | | ^~~~~~~~~~~~~~~~~~~~ | |
| | | | | |
| | | (7) calling 'free_boxed_int' | |
| | | |
| (etc) | |
| @end smallexample | |
| @opindex fdiagnostics-show-path-depths | |
| @opindex fno-diagnostics-show-path-depths | |
| @item -fdiagnostics-show-path-depths | |
| This option provides additional information when printing control-flow paths | |
| associated with a diagnostic. | |
| If this is option is provided then the stack depth will be printed for | |
| each run of events within @option{-fdiagnostics-path-format=inline-events}. | |
| If provided with @option{-fdiagnostics-path-format=separate-events}, then | |
| the stack depth and function declaration will be appended when printing | |
| each event. | |
| This is intended for use by GCC developers and plugin developers when | |
| debugging diagnostics that report interprocedural control flow. | |
| @opindex fno-show-column | |
| @opindex fshow-column | |
| @item -fno-show-column | |
| Do not print column numbers in diagnostics. This may be necessary if | |
| diagnostics are being scanned by a program that does not understand the | |
| column numbers, such as @command{dejagnu}. | |
| @opindex fdiagnostics-column-unit | |
| @item -fdiagnostics-column-unit=@var{UNIT} | |
| Select the units for the column number. This affects traditional diagnostics | |
| (in the absence of @option{-fno-show-column}). | |
| The default @var{UNIT}, @samp{display}, considers the number of display | |
| columns occupied by each character. This may be larger than the number | |
| of bytes required to encode the character, in the case of tab | |
| characters, or it may be smaller, in the case of multibyte characters. | |
| For example, the character ``GREEK SMALL LETTER PI (U+03C0)'' occupies one | |
| display column, and its UTF-8 encoding requires two bytes; the character | |
| ``SLIGHTLY SMILING FACE (U+1F642)'' occupies two display columns, and | |
| its UTF-8 encoding requires four bytes. | |
| Setting @var{UNIT} to @samp{byte} changes the column number to the raw byte | |
| count in all cases, as was traditionally output by GCC prior to version 11.1.0. | |
| @opindex fdiagnostics-column-origin | |
| @item -fdiagnostics-column-origin=@var{ORIGIN} | |
| Select the origin for column numbers, i.e. the column number assigned to the | |
| first column. The default value of 1 corresponds to traditional GCC | |
| behavior and to the GNU style guide. Some utilities may perform better with an | |
| origin of 0; any non-negative value may be specified. | |
| @opindex fdiagnostics-escape-format | |
| @item -fdiagnostics-escape-format=@var{FORMAT} | |
| When GCC prints pertinent source lines for a diagnostic it normally attempts | |
| to print the source bytes directly. However, some diagnostics relate to encoding | |
| issues in the source file, such as malformed UTF-8, or issues with Unicode | |
| normalization. These diagnostics are flagged so that GCC will escape bytes | |
| that are not printable ASCII when printing their pertinent source lines. | |
| This option controls how such bytes should be escaped. | |
| The default @var{FORMAT}, @samp{unicode} displays Unicode characters that | |
| are not printable ASCII in the form @samp{<U+XXXX>}, and bytes that do not | |
| correspond to a Unicode character validly-encoded in UTF-8-encoded will be | |
| displayed as hexadecimal in the form @samp{<XX>}. | |
| For example, a source line containing the string @samp{before} followed by the | |
| Unicode character U+03C0 (``GREEK SMALL LETTER PI'', with UTF-8 encoding | |
| 0xCF 0x80) followed by the byte 0xBF (a stray UTF-8 trailing byte), followed by | |
| the string @samp{after} will be printed for such a diagnostic as: | |
| @smallexample | |
| before<U+03C0><BF>after | |
| @end smallexample | |
| Setting @var{FORMAT} to @samp{bytes} will display all non-printable-ASCII bytes | |
| in the form @samp{<XX>}, thus showing the underlying encoding of non-ASCII | |
| Unicode characters. For the example above, the following will be printed: | |
| @smallexample | |
| before<CF><80><BF>after | |
| @end smallexample | |
| @opindex fdiagnostics-text-art-charset | |
| @item -fdiagnostics-text-art-charset=@var{CHARSET} | |
| Some diagnostics can contain ``text art'' diagrams: visualizations created | |
| from text, intended to be viewed in a monospaced font. | |
| This option selects which characters should be used for printing such | |
| diagrams, if any. @var{CHARSET} is @samp{none}, @samp{ascii}, @samp{unicode}, | |
| or @samp{emoji}. | |
| The @samp{none} value suppresses the printing of such diagrams. | |
| The @samp{ascii} value will ensure that such diagrams are pure ASCII | |
| (``ASCII art''). The @samp{unicode} value will allow for conservative use of | |
| unicode drawing characters (such as box-drawing characters). The @samp{emoji} | |
| value further adds the possibility of emoji in the output (such as emitting | |
| U+26A0 WARNING SIGN followed by U+FE0F VARIATION SELECTOR-16 to select the | |
| emoji variant of the character). | |
| The default is @samp{emoji}, except when the environment variable @env{LANG} | |
| is set to @samp{C}, in which case the default is @samp{ascii}. | |
| @opindex fno-diagnostics-show-nesting | |
| @opindex fdiagnostics-show-nesting | |
| @item -fno-diagnostics-show-nesting | |
| Some GCC diagnostics have an internal tree-like structure of nested | |
| sub-diagnostics, such as for problems when instantiating C++ templates. | |
| By default GCC uses indentation and bullet points in its text output to | |
| show the nesting structure of these diagnostics, moves location | |
| information to separate lines to make the structure clearer, and | |
| eliminates redundant repeated information. | |
| Selecting @option{-fno-diagnostics-show-nesting} suppresses this | |
| indentation, reformatting, and elision, restoring an older `look'' for the | |
| diagnostics. | |
| @opindex fno-diagnostics-show-nesting-locations | |
| @opindex fdiagnostics-show-nesting-locations | |
| @item -fno-diagnostics-show-nesting-locations | |
| When @option{fdiagnostics-show-nesting} is enabled, file names and | |
| line- and column- numbers are displayed on separate lines from the | |
| messages. This location information can be disabled altogether with | |
| @option{-fno-diagnostics-show-nesting-locations}. | |
| This option exists for use by GCC developers, for writing DejaGnu test cases. | |
| @opindex fdiagnostics-show-nesting-levels | |
| @opindex fno-diagnostics-show-nesting-levels | |
| @item -fdiagnostics-show-nesting-levels | |
| When @option{fdiagnostics-show-nesting} is enabled, use | |
| @option{fdiagnostics-show-nesting-levels} to also display numbers | |
| showing the depth of the nesting. | |
| This option exists for use by GCC developers for debugging nested | |
| diagnostics, but may be of use to plugin authors. | |
| @opindex fdiagnostics-format | |
| @opindex fdiagnostics-format=text | |
| @opindex fdiagnostics-format=sarif-stderr | |
| @opindex fdiagnostics-format=sarif-file | |
| @item -fdiagnostics-format=@var{FORMAT} | |
| Select a different format for printing diagnostics. | |
| @var{FORMAT} is @samp{text}, @samp{sarif-stderr} or @samp{sarif-file}. | |
| Using this option replaces any additional ``output sinks'' added by | |
| @option{-fdiagnostics-add-output=}, or that set by | |
| @option{-fdiagnostics-set-output=}. | |
| The default is @samp{text}. | |
| @cindex diagnostic output formats, sarif-stderr | |
| @cindex diagnostic output formats, sarif-file | |
| The @samp{sarif-stderr} and @samp{sarif-file} formats both emit | |
| diagnostics in SARIF Version 2.1.0 format, either to stderr, or to a file | |
| named @file{@var{source}.sarif}, respectively. | |
| @opindex fdiagnostics-add-output | |
| @item -fdiagnostics-add-output=@var{DIAGNOSTICS-OUTPUT-SPEC} | |
| Add an additional ``output sink'' for emitting diagnostics. | |
| @var{DIAGNOSTICS-OUTPUT-SPEC} should specify a scheme, optionally followed | |
| by @code{:} and one or more @var{KEY}=@var{VALUE} pairs, in this form: | |
| @smallexample | |
| @var{SCHEME} | |
| @var{SCHEME}:@var{KEY}=@var{VALUE} | |
| @var{SCHEME}:@var{KEY}=@var{VALUE},@var{KEY2}=@var{VALUE2} | |
| @end smallexample | |
| etc. | |
| Schemes, keys, or values with a name prefixed ``experimental'' may change | |
| or be removed without notice. Keys can be per-scheme, or related to GCC | |
| as a whole. | |
| @var{SCHEME} can be | |
| @table @gcctabopt | |
| @opindex fdiagnostics-add-output=text | |
| @item text | |
| Emit diagnostics to stderr using GCC's classic text output format. | |
| Supported keys for the @code{text} scheme are: | |
| @table @gcctabopt | |
| @item color=@r{[}yes@r{|}no@r{]} | |
| Override colorization settings from @option{-fdiagnostics-color} for this | |
| text output. | |
| @item show-nesting=@r{[}yes@r{|}no@r{]} | |
| Enable a mode that emphasizes hierarchical relationships | |
| within diagnostics messages, as per @option{-fdiagnostics-show-nesting}. | |
| Defaults to @code{yes}. | |
| @item show-nesting-locations=@r{[}yes@r{|}no@r{]} | |
| If @code{show-nesting=yes}, then by default locations are | |
| shown; set this key to @code{no} to disable printing such locations. | |
| This exists for use by GCC developers, for writing DejaGnu test cases. | |
| @item show-nesting-levels=@r{[}yes@r{|}no@r{]} | |
| This is a debugging option for use with @code{show-nesting=yes}. | |
| Set this key to @code{yes} to print explicit nesting levels in the output. | |
| This exists for use by GCC developers. | |
| @end table | |
| @cindex SARIF file output sink | |
| @opindex fdiagnostics-add-output=sarif | |
| @item sarif | |
| Emit diagnostics to a file in SARIF format. | |
| Supported keys for the @code{sarif} scheme are: | |
| @table @gcctabopt | |
| @item file=@var{FILENAME} | |
| Specify the filename to write the SARIF output to, potentially with a | |
| leading absolute or relative path. If not specified, it defaults to | |
| @file{@var{source}.sarif}. | |
| @item serialization=@r{[}json@r{]} | |
| Specify the serialization format to use when writing out the SARIF. | |
| Currently this can only be @code{json}, but is present as an | |
| extension point for experimenting with other serializations. | |
| @item version=@r{[}2.1@r{|}2.2-prerelease@r{]} | |
| Specify the version of SARIF to use for the output. If not specified, | |
| defaults to 2.1. @code{2.2-prerelease} uses an unofficial draft of the | |
| future SARIF 2.2 specification and should only be used for experimentation | |
| in this release. | |
| @end table | |
| There is also this key intended for use by GCC developers, rather than | |
| end-users, and subject to change or removal without notice: | |
| @table @gcctabopt | |
| @item state-graphs=@r{[}yes@r{|}no@r{]} | |
| This is a debugging feature and defaults to @code{no}. | |
| If @code{state-graphs=yes}, then attempt to capture detailed state | |
| information from @option{-fanalyzer} in the generated SARIF. | |
| @item analyzer-graphs=@r{[}yes@r{|}no@r{]} | |
| This is a debugging feature and defaults to @code{no}. | |
| If @code{analyzer-graphs=yes}, then attempt to capture detailed | |
| information about the analysis by @option{-fanalyzer} in the | |
| generated SARIF. | |
| @end table | |
| @opindex fdiagnostics-add-output=experimental-html | |
| @item experimental-html | |
| Emit diagnostics to a file in HTML format. This scheme is experimental, | |
| and may go away in future GCC releases. The keys and details of the output | |
| are also subject to change. | |
| Supported keys for the @code{experimental-html} scheme are: | |
| @table @gcctabopt | |
| @item css=@r{[}yes@r{|}no@r{]} | |
| Add an embedded <style> to the generated HTML. Defaults to yes. | |
| @item file=@var{FILENAME} | |
| Specify the filename to write the HTML output to, potentially with a | |
| leading absolute or relative path. If not specified, it defaults to | |
| @file{@var{source}.html}. | |
| @item javascript=@r{[}yes@r{|}no@r{]} | |
| Add an embedded <script> to the generated HTML providing a barebones UI | |
| for viewing results. Defaults to yes. | |
| @end table | |
| There are also these keys intended for use by GCC developers, rather than | |
| end-users, and subject to change or removal without notice: | |
| @table @gcctabopt | |
| @item show-state-diagrams=@r{[}yes@r{|}no@r{]} | |
| This is a debugging feature and defaults to @code{no}. | |
| If @code{show-state-diagrams=yes}, then attempt to use @command{dot} to | |
| generate SVG diagrams in the generated HTML, visualizing the state at each | |
| event in a diagnostic path. | |
| These are visible by pressing ``j'' and ``k'' to single-step forward and | |
| backward through events. Enabling this option will slow down | |
| HTML generation. | |
| @item show-graph-dot-src=@r{[}yes@r{|}no@r{]} | |
| This is a debugging feature and defaults to @code{no}. | |
| If @code{show-graph-dot-src=yes} | |
| then if @code{show-state-diagrams=yes}, | |
| the generated state diagrams will also show the .dot source input to | |
| GraphViz used for the diagram. | |
| @item show-graph-sarif=@r{[}yes@r{|}no@r{]} | |
| This is a debugging feature and defaults to @code{no}. | |
| If @code{show-graph-sarif=yes} | |
| then if @code{show-state-diagrams=yes}, the generated state diagrams will | |
| also show a SARIF representation of the state. | |
| @end table | |
| @end table | |
| As well as scheme-specific keys, the following GCC-related key is usable | |
| on sinks of any scheme: | |
| @table @gcctabopt | |
| @item cfgs=@r{[}yes@r{|}no@r{]} | |
| If @code{cfgs=yes} for a sink, then GCC will attempt to send information | |
| to that sink about the control flow graphs for the functions it is compiling. | |
| Text sinks ignore the information. SARIF sinks will add the graphs within | |
| @code{theRun.graphs}. HTML sinks will generate SVG displaying the graphs. | |
| The precise form of the information is subject to change without notice. | |
| @end table | |
| For example, | |
| @smallexample | |
| -fdiagnostics-add-output=sarif:version=2.1,file=foo.2.1.sarif | |
| -fdiagnostics-add-output=sarif:version=2.2-prerelease,file=foo.2.2.sarif | |
| @end smallexample | |
| would add a pair of outputs, each writing to a different file, using | |
| versions 2.1 and 2.2 of the SARIF standard respectively. | |
| In EBNF: | |
| @smallexample | |
| @var{diagnostics-output-specifier} = @var{diagnostics-output-name} | |
| | @var{diagnostics-output-name}, ":", @var{key-value-pairs}; | |
| @var{diagnostics-output-name} = "text" | "sarif" | "experimental-html"; | |
| @var{key-value-pairs} = @var{key-value-pair} | |
| | @var{key-value-pair} "," @var{key-value-pairs}; | |
| @var{key-value-pair} = @var{key} "=" @var{value}; | |
| @var{key} = ? string without a '=' ? ; | |
| @var{value} = ? string without a ',' ? ; | |
| @end smallexample | |
| @opindex fdiagnostics-set-output | |
| @item -fdiagnostics-set-output=@var{DIAGNOSTICS-OUTPUT-SPEC} | |
| This works in a similar way to @option{-fdiagnostics-add-output=} except | |
| that instead of adding an additional ``output sink'' for diagnostics, it | |
| replaces all existing output sinks, such as from @option{-fdiagnostics-format=}, | |
| @option{-fdiagnostics-add-output=}, or a prior call to | |
| @option{-fdiagnostics-set-output=}. | |
| @opindex fno-diagnostics-json-formatting | |
| @opindex fdiagnostics-json-formatting | |
| @item -fno-diagnostics-json-formatting | |
| By default, when JSON is emitted for diagnostics (via | |
| @option{-fdiagnostics-format=sarif-stderr} or | |
| @option{-fdiagnostics-format=sarif-file}), | |
| GCC will add newlines and indentation to visually emphasize the | |
| hierarchical structure of the JSON. | |
| Use @option{-fno-diagnostics-json-formatting} to suppress this whitespace. | |
| It must be passed before the option it is to affect. | |
| This is intended for compatibility with tools that do not expect the output | |
| to contain newlines, such as that emitted by older GCC releases. | |
| @end table | |
| @node Warning Options | |
| @section Options to Request or Suppress Warnings | |
| @cindex options to control warnings | |
| @cindex warning messages | |
| @cindex messages, warning | |
| @cindex suppressing warnings | |
| Warnings are diagnostic messages that report constructions that | |
| are not inherently erroneous but that are risky or suggest there | |
| may have been an error. | |
| The following language-independent options do not enable specific | |
| warnings but control the kinds of diagnostics produced by GCC@. | |
| @table @gcctabopt | |
| @cindex syntax checking | |
| @opindex fsyntax-only | |
| @opindex fno-syntax-only | |
| @item -fsyntax-only | |
| Check the code for syntax errors, but don't do anything beyond that. | |
| @opindex fmax-errors | |
| @item -fmax-errors=@var{n} | |
| Limits the maximum number of error messages to @var{n}, at which point | |
| GCC bails out rather than attempting to continue processing the source | |
| code. If @var{n} is 0 (the default), there is no limit on the number | |
| of error messages produced. If @option{-Wfatal-errors} is also | |
| specified, then @option{-Wfatal-errors} takes precedence over this | |
| option. | |
| @opindex w | |
| @opindex no-warnings | |
| @item -w | |
| @itemx --no-warnings | |
| Inhibit all warning messages. | |
| @opindex Werror | |
| @opindex Wno-error | |
| @item -Werror | |
| Turn all warnings into errors. | |
| @opindex Werror= | |
| @opindex Wno-error= | |
| @item -Werror= | |
| Turn the specified warning into an error. The specifier for a warning | |
| is appended; for example @option{-Werror=switch} turns the warnings | |
| controlled by @option{-Wswitch} into errors. This switch takes a | |
| negative form, to be used to negate @option{-Werror} for specific | |
| warnings; for example @option{-Wno-error=switch} makes | |
| @option{-Wswitch} warnings not be errors, even when @option{-Werror} | |
| is in effect. | |
| The warning message for each controllable warning includes the | |
| option that controls the warning. That option can then be used with | |
| @option{-Werror=} and @option{-Wno-error=} as described above. | |
| (Printing of the option in the warning message can be disabled using the | |
| @option{-fno-diagnostics-show-option} flag.) | |
| Note that specifying @option{-Werror=}@var{foo} automatically implies | |
| @option{-W}@var{foo}. However, @option{-Wno-error=}@var{foo} does not | |
| imply anything. | |
| @opindex Wfatal-errors | |
| @opindex Wno-fatal-errors | |
| @item -Wfatal-errors | |
| This option causes the compiler to abort compilation on the first error | |
| occurred rather than trying to keep going and printing further error | |
| messages. | |
| @end table | |
| You can request many specific warnings with options beginning with | |
| @samp{-W}, for example @option{-Wunused-variable} to request warnings on | |
| declarations of variables that are never used. | |
| Each of these specific warning options also | |
| has a negative form beginning with @samp{-Wno-} to turn off warnings; for | |
| example, @option{-Wno-unused-variable}. This manual lists only one of the | |
| two forms, whichever is not the default. For further | |
| language-specific options also refer to @ref{C++ Dialect Options} and | |
| @ref{Objective-C and Objective-C++ Dialect Options}. | |
| Additional warnings can be produced by enabling the static analyzer; | |
| @xref{Static Analyzer Options}. | |
| Some options, such as @option{-Wall} and @option{-Wextra}, turn on other | |
| options, such as @option{-Wunused}, which may turn on further options, | |
| such as @option{-Wunused-variable}. The combined effect of positive and | |
| negative forms is that more specific options have priority over less | |
| specific ones, independently of their position in the command line. For | |
| options of the same specificity, the last one takes effect. Options | |
| enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect | |
| as if they appeared at the end of the command line. | |
| When an unrecognized warning option is requested (e.g., | |
| @option{-Wunknown-warning}), GCC gives an error stating | |
| that the option is not recognized. However, if the @option{-Wno-} form | |
| is used, the behavior is slightly different: no diagnostic is | |
| produced for @option{-Wno-unknown-warning} unless other diagnostics | |
| are being produced. This allows the use of new @option{-Wno-} options | |
| with old compilers, but if something goes wrong, the compiler | |
| warns that an unrecognized option is present. | |
| The effectiveness of some warnings depends on optimizations also being | |
| enabled. For example, @option{-Wsuggest-final-types} is more effective | |
| with link-time optimization. Some other warnings may | |
| not be issued at all unless optimization is enabled. While optimization | |
| in general improves the efficacy of warnings about control and data-flow | |
| problems, in some cases it may also cause false positives. | |
| @table @gcctabopt | |
| @opindex pedantic | |
| @opindex Wpedantic | |
| @opindex Wno-pedantic | |
| @item -Wpedantic | |
| @itemx -pedantic | |
| @itemx --pedantic | |
| Issue all the warnings demanded by strict ISO C and ISO C++; | |
| diagnose all programs that use forbidden extensions, and some other | |
| programs that do not follow ISO C and ISO C++. This follows the version | |
| of the ISO C or C++ standard specified by any @option{-std} option used. | |
| Valid ISO C and ISO C++ programs should compile properly with or without | |
| this option (though a rare few require @option{-ansi} or a | |
| @option{-std} option specifying the version of the standard)@. However, | |
| without this option, certain GNU extensions and traditional C and C++ | |
| features are supported as well. With this option, they are diagnosed | |
| (or rejected with @option{-pedantic-errors}). | |
| @option{-Wpedantic} does not cause warning messages for use of the | |
| alternate keywords whose names begin and end with @samp{__}. This alternate | |
| format can also be used to disable warnings for non-ISO @samp{__intN} types, | |
| i.e. @samp{__intN__}. | |
| Pedantic warnings are also disabled in the expression that follows | |
| @code{__extension__}. However, only system header files should use | |
| these escape routes; application programs should avoid them. | |
| @xref{Alternate Keywords}. | |
| Some warnings about non-conforming programs are controlled by options | |
| other than @option{-Wpedantic}; in many cases they are implied by | |
| @option{-Wpedantic} but can be disabled separately by their specific | |
| option, e.g. @option{-Wpedantic -Wno-pointer-sign}. | |
| Where the standard specified with @option{-std} represents a GNU | |
| extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a | |
| corresponding @dfn{base standard}, the version of ISO C on which the GNU | |
| extended dialect is based. Warnings from @option{-Wpedantic} are given | |
| where they are required by the base standard. (It does not make sense | |
| for such warnings to be given only for features not in the specified GNU | |
| C dialect, since by definition the GNU dialects of C include all | |
| features the compiler supports with the given option, and there would be | |
| nothing to warn about.) | |
| @opindex pedantic-errors | |
| @item -pedantic-errors | |
| @itemx --pedantic-errors | |
| Give an error whenever the @dfn{base standard} (see @option{-Wpedantic}) | |
| requires a diagnostic, in some cases where there is undefined behavior | |
| at compile-time and in some other cases that do not prevent compilation | |
| of programs that are valid according to the standard. This is not | |
| equivalent to @option{-Werror=pedantic}: the latter option is unlikely to be | |
| useful, as it only makes errors of the diagnostics that are controlled by | |
| @option{-Wpedantic}, whereas this option also affects required diagnostics that | |
| are always enabled or controlled by options other than @option{-Wpedantic}. | |
| If you want the required diagnostics that are warnings by default to | |
| be errors instead, but don't also want to enable the @option{-Wpedantic} | |
| diagnostics, you can specify @option{-pedantic-errors -Wno-pedantic} | |
| (or @option{-pedantic-errors -Wno-error=pedantic} to enable them but | |
| only as warnings). | |
| Some required diagnostics are errors by default, but can be reduced to | |
| warnings using @option{-fpermissive} or their specific warning option, | |
| e.g. @option{-Wno-error=narrowing}. | |
| Some diagnostics for non-ISO practices are controlled by specific | |
| warning options other than @option{-Wpedantic}, but are also made | |
| errors by @option{-pedantic-errors}. For instance: | |
| @gccoptlist{ | |
| -Wattributes @r{(for standard attributes)} | |
| -Wchanges-meaning @r{(C++)} | |
| -Wcomma-subscript @r{(C++23 or later)} | |
| -Wdeclaration-after-statement @r{(C90 or earlier)} | |
| -Welaborated-enum-base @r{(C++11 or later)} | |
| -Wimplicit-int @r{(C99 or later)} | |
| -Wimplicit-function-declaration @r{(C99 or later)} | |
| -Wincompatible-pointer-types | |
| -Wint-conversion | |
| -Wlong-long @r{(C90 or earlier)} | |
| -Wmain | |
| -Wnarrowing @r{(C++11 or later)} | |
| -Wpointer-arith | |
| -Wpointer-sign | |
| -Wincompatible-pointer-types | |
| -Wregister @r{(C++17 or later)} | |
| -Wvla @r{(C90 or earlier)} | |
| -Wwrite-strings @r{(C++11 or later)} | |
| } | |
| @opindex fpermissive | |
| @opindex fno-permissive | |
| @item -fpermissive | |
| Downgrade some required diagnostics about nonconformant code from | |
| errors to warnings. Thus, using @option{-fpermissive} allows some | |
| nonconforming code to compile. Some C++ diagnostics are controlled | |
| only by this flag, but it also downgrades some C and C++ diagnostics | |
| that have their own flag: | |
| @gccoptlist{ | |
| -Wabbreviated-auto-in-template-arg @r{(C++ and Objective-C++ only)} | |
| -Wdeclaration-missing-parameter-type @r{(C and Objective-C only)} | |
| -Wimplicit-function-declaration @r{(C and Objective-C only)} | |
| -Wimplicit-int @r{(C and Objective-C only)} | |
| -Wincompatible-pointer-types @r{(C and Objective-C only)} | |
| -Wint-conversion @r{(C and Objective-C only)} | |
| -Wnarrowing @r{(C++ and Objective-C++ only)} | |
| -Wreturn-mismatch @r{(C and Objective-C only)} | |
| -Wtemplate-body @r{(C++ and Objective-C++ only)} | |
| } | |
| The @option{-fpermissive} option is the default for historic C language | |
| modes (@option{-std=c89}, @option{-std=gnu89}, @option{-std=c90}, | |
| @option{-std=gnu90}). | |
| @opindex Wall | |
| @opindex Wno-all | |
| @opindex all-warnings | |
| @item -Wall | |
| @itemx --all-warnings | |
| This enables all the warnings about constructions that some users | |
| consider questionable, and that are easy to avoid (or modify to | |
| prevent the warning), even in conjunction with macros. This also | |
| enables some language-specific warnings described in @ref{C++ Dialect | |
| Options} and @ref{Objective-C and Objective-C++ Dialect Options}. | |
| @option{-Wall} turns on the following warning flags: | |
| @gccoptlist{-Waddress | |
| -Waligned-new @r{(C++ and Objective-C++ only)} | |
| -Warray-bounds=1 @r{(only with} @option{-O2}@r{)} | |
| -Warray-compare | |
| -Warray-parameter=2 | |
| -Wbool-compare | |
| -Wbool-operation | |
| -Wc++11-compat -Wc++14-compat -Wc++17compat -Wc++20compat | |
| -Wcatch-value @r{(C++ and Objective-C++ only)} | |
| -Wchar-subscripts | |
| -Wclass-memaccess @r{(C++ and Objective-C++ only)} | |
| -Wcomment | |
| -Wdangling-else | |
| -Wdangling-pointer=2 | |
| -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)} | |
| -Wduplicate-decl-specifier @r{(C and Objective-C only)} | |
| -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} | |
| -Wenum-int-mismatch @r{(C and Objective-C only)} | |
| -Wformat=1 | |
| -Wformat-contains-nul | |
| -Wformat-diag | |
| -Wformat-extra-args | |
| -Wformat-overflow=1 | |
| -Wformat-truncation=1 | |
| -Wformat-zero-length | |
| -Wframe-address | |
| -Wimplicit @r{(C and Objective-C only)} | |
| -Wimplicit-function-declaration @r{(C and Objective-C only)} | |
| -Wimplicit-int @r{(C and Objective-C only)} | |
| -Winfinite-recursion | |
| -Winit-self @r{(C++ and Objective-C++ only)} | |
| -Wint-in-bool-context | |
| -Wlogical-not-parentheses | |
| -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)} | |
| -Wmaybe-uninitialized | |
| -Wmemset-elt-size | |
| -Wmemset-transposed-args | |
| -Wmisleading-indentation @r{(only for C/C++)} | |
| -Wmismatched-dealloc | |
| -Wmismatched-new-delete @r{(C++ and Objective-C++ only)} | |
| -Wmissing-attributes | |
| -Wmissing-braces @r{(only for C/ObjC)} | |
| -Wmultistatement-macros | |
| -Wnarrowing @r{(C++ and Objective-C++ only)} | |
| -Wnonnull | |
| -Wnonnull-compare | |
| -Wopenmp-simd @r{(C and C++ only)} | |
| -Woverloaded-virtual=1 @r{(C++ and Objective-C++ only)} | |
| -Wpacked-not-aligned | |
| -Wparentheses | |
| -Wpessimizing-move @r{(C++ and Objective-C++ only)} | |
| -Wpointer-sign @r{(only for C/ObjC)} | |
| -Wrange-loop-construct @r{(C++ and Objective-C++ only)} | |
| -Wreorder @r{(C++ and Objective-C++ only)} | |
| -Wrestrict | |
| -Wreturn-type | |
| -Wself-move @r{(C++ and Objective-C++ only)} | |
| -Wsequence-point | |
| -Wsign-compare @r{(C++ and Objective-C++ only)} | |
| -Wsizeof-array-div | |
| -Wsizeof-pointer-div | |
| -Wsizeof-pointer-memaccess | |
| -Wstrict-aliasing | |
| -Wswitch | |
| -Wtautological-compare | |
| -Wtrigraphs | |
| -Wuninitialized | |
| -Wunknown-pragmas | |
| -Wunused | |
| -Wunused-but-set-variable | |
| -Wunused-const-variable=1 @r{(only for C/ObjC)} | |
| -Wunused-function | |
| -Wunused-label | |
| -Wunused-local-typedefs | |
| -Wunused-value | |
| -Wunused-variable | |
| -Wuse-after-free=2 | |
| -Wvla-parameter | |
| -Wvolatile-register-var | |
| -Wzero-length-bounds} | |
| Note that some warning flags are not implied by @option{-Wall}. Some of | |
| them warn about constructions that users generally do not consider | |
| questionable, but which occasionally you might wish to check for; | |
| others warn about constructions that are necessary or hard to avoid in | |
| some cases, and there is no simple way to modify the code to suppress | |
| the warning. Some of them are enabled by @option{-Wextra} but many of | |
| them must be enabled individually. | |
| @opindex W | |
| @opindex Wextra | |
| @opindex Wno-extra | |
| @opindex extra-warnings | |
| @item -Wextra | |
| @itemx --extra-warnings | |
| This enables some extra warning flags that are not enabled by | |
| @option{-Wall}. (This option used to be called @option{-W}. The older | |
| name is still supported, but the newer name is more descriptive.) | |
| @gccoptlist{-Wabsolute-value @r{(only for C/ObjC)} | |
| -Walloc-size | |
| -Wcalloc-transposed-args | |
| -Wcast-function-type | |
| -Wclobbered | |
| -Wdangling-reference @r{(C++ only)} | |
| -Wdeprecated-copy @r{(C++ and Objective-C++ only)} | |
| -Wempty-body | |
| -Wenum-conversion @r{(only for C/ObjC)} | |
| -Wexpansion-to-defined | |
| -Wignored-qualifiers @r{(only for C/C++)} | |
| -Wimplicit-fallthrough=3 | |
| -Wmaybe-uninitialized | |
| -Wmissing-field-initializers | |
| -Wmissing-parameter-name @r{(C/ObjC only)} | |
| -Wmissing-parameter-type @r{(C/ObjC only)} | |
| -Wold-style-declaration @r{(C/ObjC only)} | |
| -Wmultiple-parameter-fwd-decl-lists @r{(C/ObjC only)} | |
| -Woverride-init @r{(C/ObjC only)} | |
| -Wredundant-move @r{(C++ and Objective-C++ only)} | |
| -Wshift-negative-value @r{(in C++11 to C++17 and in C99 and newer)} | |
| -Wsign-compare @r{(C++ and Objective-C++ only)} | |
| -Wsized-deallocation @r{(C++ and Objective-C++ only)} | |
| -Wstring-compare | |
| -Wtype-limits | |
| -Wuninitialized | |
| -Wunterminated-string-initialization @r{(C/ObjC only)} | |
| -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} | |
| -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}} | |
| The option @option{-Wextra} also prints warning messages for the | |
| following cases: | |
| @itemize @bullet | |
| @item | |
| A pointer is compared against integer zero with @code{<}, @code{<=}, | |
| @code{>}, or @code{>=}. | |
| @item | |
| (C++ only) An enumerator and a non-enumerator both appear in a | |
| conditional expression. | |
| @item | |
| (C++ only) Ambiguous virtual bases. | |
| @item | |
| (C++ only) Subscripting an array that has been declared @code{register}. | |
| @item | |
| (C++ only) Taking the address of a variable that has been declared | |
| @code{register}. | |
| @item | |
| (C++ only) A base class is not initialized in the copy constructor | |
| of a derived class. | |
| @end itemize | |
| @opindex Wabi | |
| @opindex Wno-abi | |
| @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)} | |
| Warn about code affected by ABI changes. This includes code that may | |
| not be compatible with the vendor-neutral C++ ABI as well as the psABI | |
| for the particular target. The latter warnings are also controlled | |
| separately by @option{-Wpsabi}, which is implied by @option{-Wabi}. | |
| Since G++ now defaults to updating the ABI with each major release, | |
| normally @option{-Wabi} warns only about C++ ABI compatibility | |
| problems if there is a check added later in a release series for an | |
| ABI issue discovered since the initial release. @option{-Wabi} warns | |
| about more things if an older ABI version is selected (with | |
| @option{-fabi-version=@var{n}}). | |
| @option{-Wabi} can also be used with an explicit version number to | |
| warn about C++ ABI compatibility with a particular @option{-fabi-version} | |
| level, e.g.@: @option{-Wabi=2} to warn about changes relative to | |
| @option{-fabi-version=2}. | |
| If an explicit version number is provided and | |
| @option{-fabi-compat-version} is not specified, the version number | |
| from this option is used for compatibility aliases. If no explicit | |
| version number is provided with this option, but | |
| @option{-fabi-compat-version} is specified, that version number is | |
| used for C++ ABI warnings. | |
| Although an effort has been made to warn about | |
| all such cases, there are probably some cases that are not warned about, | |
| even though G++ is generating incompatible code. There may also be | |
| cases where warnings are emitted even though the code that is generated | |
| is compatible. | |
| You should rewrite your code to avoid these warnings if you are | |
| concerned about the fact that code generated by G++ may not be binary | |
| compatible with code generated by other compilers. | |
| Known incompatibilities in @option{-fabi-version=2} (which was the | |
| default from GCC 3.4 to 4.9) include: | |
| @itemize @bullet | |
| @item | |
| A template with a non-type template parameter of reference type was | |
| mangled incorrectly: | |
| @smallexample | |
| extern int N; | |
| template <int &> struct S @{@}; | |
| void n (S<N>) @{2@} | |
| @end smallexample | |
| This was fixed in @option{-fabi-version=3}. | |
| @item | |
| SIMD vector types declared using @code{__attribute ((vector_size))} were | |
| mangled in a non-standard way that does not allow for overloading of | |
| functions taking vectors of different sizes. | |
| The mangling was changed in @option{-fabi-version=4}. | |
| @item | |
| @code{__attribute ((const))} and @code{noreturn} were mangled as type | |
| qualifiers, and @code{decltype} of a plain declaration was folded away. | |
| These mangling issues were fixed in @option{-fabi-version=5}. | |
| @item | |
| Scoped enumerators passed as arguments to a variadic function are | |
| promoted like unscoped enumerators, causing @code{va_arg} to complain. | |
| On most targets this does not actually affect the parameter passing | |
| ABI, as there is no way to pass an argument smaller than @code{int}. | |
| Also, the ABI changed the mangling of template argument packs, | |
| @code{const_cast}, @code{static_cast}, prefix increment/decrement, and | |
| a class scope function used as a template argument. | |
| These issues were corrected in @option{-fabi-version=6}. | |
| @item | |
| Lambdas in default argument scope were mangled incorrectly, and the | |
| ABI changed the mangling of @code{nullptr_t}. | |
| These issues were corrected in @option{-fabi-version=7}. | |
| @item | |
| When mangling a function type with function-cv-qualifiers, the | |
| un-qualified function type was incorrectly treated as a substitution | |
| candidate. | |
| This was fixed in @option{-fabi-version=8}, the default for GCC 5.1. | |
| @item | |
| @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to | |
| unaligned accesses. Note that this did not affect the ABI of a | |
| function with a @code{nullptr_t} parameter, as parameters have a | |
| minimum alignment. | |
| This was fixed in @option{-fabi-version=9}, the default for GCC 5.2. | |
| @item | |
| Target-specific attributes that affect the identity of a type, such as | |
| ia32 calling conventions on a function type (stdcall, regparm, etc.), | |
| did not affect the mangled name, leading to name collisions when | |
| function pointers were used as template arguments. | |
| This was fixed in @option{-fabi-version=10}, the default for GCC 6.1. | |
| @end itemize | |
| @opindex Wpsabi | |
| @opindex Wno-psabi | |
| @item -Wpsabi @r{(C, Objective-C, C++ and Objective-C++ only)} | |
| @option{-Wpsabi} enables warnings about processor-specific ABI | |
| changes, such as changes in alignment requirements or how function | |
| arguments are passed. On several targets, including AArch64, ARM, | |
| x86, MIPS, RS6000/PowerPC, and S/390, these details have changed | |
| between different versions of GCC and/or different versions of the C | |
| or C++ language standards in ways that affect binary compatibility of | |
| compiled code. With @option{-Wpsabi}, GCC can detect potentially | |
| incompatible usages and warn you about them. | |
| @option{-Wpsabi} is enabled by default, and is also implied by | |
| @option{-Wabi}. | |
| @opindex Wchanges-meaning | |
| @opindex Wno-changes-meaning | |
| @item -Wno-changes-meaning @r{(C++ and Objective-C++ only)} | |
| C++ requires that unqualified uses of a name within a class have the | |
| same meaning in the complete scope of the class, so declaring the name | |
| after using it is ill-formed: | |
| @smallexample | |
| struct A; | |
| struct B1 @{ A a; typedef A A; @}; // warning, 'A' changes meaning | |
| struct B2 @{ A a; struct A @{ @}; @}; // error, 'A' changes meaning | |
| @end smallexample | |
| By default, the B1 case is only a warning because the two declarations | |
| have the same type, while the B2 case is an error. Both diagnostics | |
| can be disabled with @option{-Wno-changes-meaning}. Alternately, the | |
| error case can be reduced to a warning with | |
| @option{-Wno-error=changes-meaning} or @option{-fpermissive}. | |
| Both diagnostics are also suppressed by @option{-fms-extensions}. | |
| @opindex Wchar-subscripts | |
| @opindex Wno-char-subscripts | |
| @item -Wchar-subscripts | |
| Warn if an array subscript has type @code{char}. This is a common cause | |
| of error, as programmers often forget that this type is signed on some | |
| machines. @xref{Characters implementation}, and | |
| @ref{@code{char} type signedness}. | |
| This warning is enabled by @option{-Wall}. When enabled, the warning | |
| is given regardless of whether @code{char} is unsigned by default on | |
| the target, and it is also not affected by the @option{-fsigned-char} | |
| or @option{-funsigned-char} options. | |
| @opindex Wno-coverage-mismatch | |
| @opindex Wcoverage-mismatch | |
| @item -Wno-coverage-mismatch | |
| Warn if feedback profiles do not match when using the | |
| @option{-fprofile-use} option. | |
| If a source file is changed between compiling with @option{-fprofile-generate} | |
| and with @option{-fprofile-use}, the files with the profile feedback can fail | |
| to match the source file and GCC cannot use the profile feedback | |
| information. By default, this warning is enabled and is treated as an | |
| error. @option{-Wno-coverage-mismatch} can be used to disable the | |
| warning or @option{-Wno-error=coverage-mismatch} can be used to | |
| disable the error. Disabling the error for this warning can result in | |
| poorly optimized code and is useful only in the | |
| case of very minor changes such as bug fixes to an existing code-base. | |
| Completely disabling the warning is not recommended. | |
| @opindex Wno-coverage-too-many-conditions | |
| @opindex Wcoverage-too-many-conditions | |
| @item -Wno-coverage-too-many-conditions | |
| Warn if @option{-fcondition-coverage} is used and an expression have too many | |
| terms and GCC gives up coverage. Coverage is given up when there are more | |
| terms in the conditional than there are bits in a @code{gcov_type_unsigned}. | |
| This warning is enabled by default. | |
| @opindex Wno-coverage-too-many-paths | |
| @opindex Wcoverage-too-many-paths | |
| @item -Wno-coverage-too-many-paths | |
| Warn if @option{-fpath-coverage} is used and a function has too many | |
| paths and GCC gives up coverage. Giving up is controlled by | |
| @option{-fpath-coverage-limit}. This warning is enabled by default. | |
| @opindex Wno-coverage-invalid-line-number | |
| @opindex Wcoverage-invalid-line-number | |
| @item -Wno-coverage-invalid-line-number | |
| Warn in case a function ends earlier than it begins due | |
| to an invalid linenum macros. The warning is emitted only | |
| with @option{--coverage} enabled. | |
| By default, this warning is enabled and is treated as an | |
| error. @option{-Wno-coverage-invalid-line-number} can be used to disable the | |
| warning or @option{-Wno-error=coverage-invalid-line-number} can be used to | |
| disable the error. | |
| @opindex Wno-cpp | |
| @opindex Wcpp | |
| @item -Wno-cpp @r{(C, Objective-C, C++, Objective-C++ and Fortran only)} | |
| Suppress warning messages emitted by @code{#warning} directives. | |
| @opindex Wdouble-promotion | |
| @opindex Wno-double-promotion | |
| @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)} | |
| Give a warning when a value of type @code{float} is implicitly | |
| promoted to @code{double}. CPUs with a 32-bit ``single-precision'' | |
| floating-point unit implement @code{float} in hardware, but emulate | |
| @code{double} in software. On such a machine, doing computations | |
| using @code{double} values is much more expensive because of the | |
| overhead required for software emulation. | |
| It is easy to accidentally do computations with @code{double} because | |
| floating-point literals are implicitly of type @code{double}. For | |
| example, in: | |
| @smallexample | |
| @group | |
| float area(float radius) | |
| @{ | |
| return 3.14159 * radius * radius; | |
| @} | |
| @end group | |
| @end smallexample | |
| the compiler performs the entire computation with @code{double} | |
| because the floating-point literal is a @code{double}. | |
| @opindex Wduplicate-decl-specifier | |
| @opindex Wno-duplicate-decl-specifier | |
| @item -Wduplicate-decl-specifier @r{(C and Objective-C only)} | |
| Warn if a declaration has a duplicate @code{const}, @code{volatile}, | |
| @code{restrict} or @code{_Atomic} specifier. This warning is enabled by | |
| @option{-Wall}. | |
| @opindex Wformat | |
| @opindex Wno-format | |
| @opindex ffreestanding | |
| @opindex fno-freestanding | |
| @opindex fno-builtin | |
| @opindex Wformat= | |
| @item -Wformat | |
| @itemx -Wformat=@var{n} | |
| Check calls to @code{printf} and @code{scanf}, etc., to make sure that | |
| the arguments supplied have types appropriate to the format string | |
| specified, and that the conversions specified in the format string make | |
| sense. This includes standard functions, and others specified by format | |
| attributes (@pxref{Common Attributes}), in the @code{printf}, | |
| @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension, | |
| not in the C standard) families (or other target-specific families). | |
| Which functions are checked without format attributes having been | |
| specified depends on the standard version selected, and such checks of | |
| functions without the attribute specified are disabled by | |
| @option{-ffreestanding} or @option{-fno-builtin}. | |
| The formats are checked against the format features supported by GNU | |
| libc version 2.2. These include all ISO C90 and C99 features, as well | |
| as features from the Single Unix Specification and some BSD and GNU | |
| extensions. Other library implementations may not support all these | |
| features; GCC does not support warning about features that go beyond a | |
| particular library's limitations. However, if @option{-Wpedantic} is used | |
| with @option{-Wformat}, warnings are given about format features not | |
| in the selected standard version (but not for @code{strfmon} formats, | |
| since those are not in any version of the C standard). @xref{C Dialect | |
| Options,,Options Controlling C Dialect}. | |
| @table @gcctabopt | |
| @opindex Wformat | |
| @opindex Wformat=1 | |
| @item -Wformat=1 | |
| @itemx -Wformat | |
| Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and | |
| @option{-Wno-format} is equivalent to @option{-Wformat=0}. Since | |
| @option{-Wformat} also checks for null format arguments for several | |
| functions, @option{-Wformat} also implies @option{-Wnonnull}. Some | |
| aspects of this level of format checking can be disabled by the | |
| options: @option{-Wno-format-contains-nul}, @option{-Wno-format-diag}, | |
| @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}. | |
| @option{-Wformat} is enabled by @option{-Wall}. | |
| @opindex Wformat=2 | |
| @item -Wformat=2 | |
| Enable @option{-Wformat} plus additional format checks. Currently | |
| equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security | |
| -Wformat-y2k}. | |
| @end table | |
| @opindex Wno-format-contains-nul | |
| @opindex Wformat-contains-nul | |
| @item -Wno-format-contains-nul | |
| If @option{-Wformat} is specified, do not warn about format strings that | |
| contain NUL bytes. | |
| @opindex Wno-format-diag | |
| @opindex Wformat-diag | |
| @item -Wno-format-diag | |
| If @option{-Wformat} is specified, do not warn about format strings that | |
| are unsuitable for GCC diagnostics. | |
| @opindex Wno-format-extra-args | |
| @opindex Wformat-extra-args | |
| @item -Wno-format-extra-args | |
| If @option{-Wformat} is specified, do not warn about excess arguments to a | |
| @code{printf} or @code{scanf} format function. The C standard specifies | |
| that such arguments are ignored. | |
| Where the unused arguments lie between used arguments that are | |
| specified with @samp{$} operand number specifications, normally | |
| warnings are still given, since the implementation could not know what | |
| type to pass to @code{va_arg} to skip the unused arguments. However, | |
| in the case of @code{scanf} formats, this option suppresses the | |
| warning if the unused arguments are all pointers, since the Single | |
| Unix Specification says that such unused arguments are allowed. | |
| @opindex Wformat-overflow | |
| @opindex Wno-format-overflow | |
| @item -Wformat-overflow | |
| @itemx -Wformat-overflow=@var{level} | |
| Warn about calls to formatted input/output functions such as @code{sprintf} | |
| and @code{vsprintf} that might overflow the destination buffer. When the | |
| exact number of bytes written by a format directive cannot be determined | |
| at compile-time it is estimated based on heuristics that depend on the | |
| @var{level} argument and on optimization. While enabling optimization | |
| will in most cases improve the accuracy of the warning, it may also | |
| result in false positives. | |
| @table @gcctabopt | |
| @opindex Wformat-overflow | |
| @opindex Wno-format-overflow | |
| @item -Wformat-overflow | |
| @itemx -Wformat-overflow=1 | |
| Level @var{1} of @option{-Wformat-overflow} enabled by @option{-Wformat} | |
| employs a conservative approach that warns only about calls that most | |
| likely overflow the buffer. At this level, numeric arguments to format | |
| directives with unknown values are assumed to have the value of one, and | |
| strings of unknown length to be empty. Numeric arguments that are known | |
| to be bounded to a subrange of their type, or string arguments whose output | |
| is bounded either by their directive's precision or by a finite set of | |
| string literals, are assumed to take on the value within the range that | |
| results in the most bytes on output. For example, the call to @code{sprintf} | |
| below is diagnosed because even with both @var{a} and @var{b} equal to zero, | |
| the terminating NUL character (@code{'\0'}) appended by the function | |
| to the destination buffer will be written past its end. Increasing | |
| the size of the buffer by a single byte is sufficient to avoid the | |
| warning, though it may not be sufficient to avoid the overflow. | |
| @smallexample | |
| void f (int a, int b) | |
| @{ | |
| char buf [13]; | |
| sprintf (buf, "a = %i, b = %i\n", a, b); | |
| @} | |
| @end smallexample | |
| @item -Wformat-overflow=2 | |
| Level @var{2} warns also about calls that might overflow the destination | |
| buffer given an argument of sufficient length or magnitude. At level | |
| @var{2}, unknown numeric arguments are assumed to have the minimum | |
| representable value for signed types with a precision greater than 1, and | |
| the maximum representable value otherwise. Unknown string arguments whose | |
| length cannot be assumed to be bounded either by the directive's precision, | |
| or by a finite set of string literals they may evaluate to, or the character | |
| array they may point to, are assumed to be 1 character long. | |
| At level @var{2}, the call in the example above is again diagnosed, but | |
| this time because with @var{a} equal to a 32-bit @code{INT_MIN} the first | |
| @code{%i} directive will write some of its digits beyond the end of | |
| the destination buffer. To make the call safe regardless of the values | |
| of the two variables, the size of the destination buffer must be increased | |
| to at least 34 bytes. GCC includes the minimum size of the buffer in | |
| an informational note following the warning. | |
| An alternative to increasing the size of the destination buffer is to | |
| constrain the range of formatted values. The maximum length of string | |
| arguments can be bounded by specifying the precision in the format | |
| directive. When numeric arguments of format directives can be assumed | |
| to be bounded by less than the precision of their type, choosing | |
| an appropriate length modifier to the format specifier will reduce | |
| the required buffer size. For example, if @var{a} and @var{b} in the | |
| example above can be assumed to be within the precision of | |
| the @code{short int} type then using either the @code{%hi} format | |
| directive or casting the argument to @code{short} reduces the maximum | |
| required size of the buffer to 24 bytes. | |
| @smallexample | |
| void f (int a, int b) | |
| @{ | |
| char buf [23]; | |
| sprintf (buf, "a = %hi, b = %i\n", a, (short)b); | |
| @} | |
| @end smallexample | |
| @end table | |
| @opindex Wno-format-zero-length | |
| @opindex Wformat-zero-length | |
| @item -Wno-format-zero-length | |
| If @option{-Wformat} is specified, do not warn about zero-length formats. | |
| The C standard specifies that zero-length formats are allowed. | |
| @opindex Wformat-nonliteral | |
| @opindex Wno-format-nonliteral | |
| @item -Wformat-nonliteral | |
| If @option{-Wformat} is specified, also warn if the format string is not a | |
| string literal and so cannot be checked, unless the format function | |
| takes its format arguments as a @code{va_list}. | |
| @opindex Wformat-security | |
| @opindex Wno-format-security | |
| @item -Wformat-security | |
| If @option{-Wformat} is specified, also warn about uses of format | |
| functions that represent possible security problems. At present, this | |
| warns about calls to @code{printf} and @code{scanf} functions where the | |
| format string is not a string literal and there are no format arguments, | |
| as in @code{printf (foo);}. This may be a security hole if the format | |
| string came from untrusted input and contains @samp{%n}. (This is | |
| currently a subset of what @option{-Wformat-nonliteral} warns about, but | |
| in future warnings may be added to @option{-Wformat-security} that are not | |
| included in @option{-Wformat-nonliteral}.) | |
| @opindex Wformat-signedness | |
| @opindex Wno-format-signedness | |
| @item -Wformat-signedness | |
| If @option{-Wformat} is specified, also warn if the format string | |
| requires an unsigned argument and the argument is signed and vice versa. | |
| @opindex Wformat-truncation | |
| @opindex Wno-format-truncation | |
| @item -Wformat-truncation | |
| @itemx -Wformat-truncation=@var{level} | |
| Warn about calls to formatted input/output functions such as @code{snprintf} | |
| and @code{vsnprintf} that might result in output truncation. When the exact | |
| number of bytes written by a format directive cannot be determined at | |
| compile time it is estimated based on heuristics that depend on | |
| the @var{level} argument and on optimization. While enabling optimization | |
| will in most cases improve the accuracy of the warning, it may also result | |
| in false positives. Except as noted otherwise, the option uses the same | |
| logic @option{-Wformat-overflow}. | |
| @table @gcctabopt | |
| @opindex Wformat-truncation | |
| @opindex Wno-format-truncation | |
| @item -Wformat-truncation | |
| @itemx -Wformat-truncation=1 | |
| Level @var{1} of @option{-Wformat-truncation} enabled by @option{-Wformat} | |
| employs a conservative approach that warns only about calls to bounded | |
| functions whose return value is unused and that will most likely result | |
| in output truncation. | |
| @item -Wformat-truncation=2 | |
| Level @var{2} warns also about calls to bounded functions whose return | |
| value is used and that might result in truncation given an argument of | |
| sufficient length or magnitude. | |
| @end table | |
| @opindex Wformat-y2k | |
| @opindex Wno-format-y2k | |
| @item -Wformat-y2k | |
| If @option{-Wformat} is specified, also warn about @code{strftime} | |
| formats that may yield only a two-digit year. | |
| @opindex Wnonnull | |
| @opindex Wno-nonnull | |
| @item -Wnonnull | |
| Warn about passing a null pointer for arguments marked as | |
| requiring a non-null value by the @code{nonnull} function attribute. | |
| @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It | |
| can be disabled with the @option{-Wno-nonnull} option. | |
| @opindex Wnonnull-compare | |
| @opindex Wno-nonnull-compare | |
| @item -Wnonnull-compare | |
| Warn when comparing an argument marked with the @code{nonnull} | |
| function attribute against null inside the function. | |
| @option{-Wnonnull-compare} is included in @option{-Wall}. It | |
| can be disabled with the @option{-Wno-nonnull-compare} option. | |
| @opindex Wnull-dereference | |
| @opindex Wno-null-dereference | |
| @item -Wnull-dereference | |
| Warn if the compiler detects paths that trigger erroneous or | |
| undefined behavior due to dereferencing a null pointer. This option | |
| is only active when @option{-fdelete-null-pointer-checks} is active, | |
| which is enabled by optimizations in most targets. The precision of | |
| the warnings depends on the optimization options used. | |
| @opindex Wno-musttail-local-addr | |
| @opindex Wmusttail-local-addr | |
| @item -Wno-musttail-local-addr | |
| Do not warn about passing a pointer (or in C++, a reference) to a | |
| local variable or label to argument of a @code{musttail} call. Those | |
| variables go out of scope before the tail call instruction. | |
| @opindex Wmaybe-musttail-local-addr | |
| @opindex Wno-maybe-musttail-local-addr | |
| @item -Wmaybe-musttail-local-addr | |
| Warn when address of a local variable can escape to a @code{musttail} | |
| call, unless it goes out of scope already before the @code{musttail} | |
| call. | |
| @smallexample | |
| int foo (int *); | |
| int | |
| bar (int *x) | |
| @{ | |
| if (x[0] == 1) | |
| @{ | |
| int a = 42; | |
| foo (&a); | |
| /* Without the @code{musttail} attribute this call would not | |
| be tail called, because address of the @code{a} variable escapes | |
| and the second foo call could dereference it. With the attribute | |
| the local variables are assumed to go out of scope immediately | |
| before the tail call instruction and the compiler warns about | |
| this. */ | |
| [[gnu::musttail]] return foo (nullptr); | |
| @} | |
| else | |
| @{ | |
| @{ | |
| int a = 42; | |
| foo (&a); | |
| @} | |
| /* The @code{a} variable isn't already in scope, so even when it | |
| escaped, even without @code{musttail} attribute it would be | |
| undefined behavior to dereference it and the compiler could | |
| turn this into a tail call. No warning is diagnosed here. */ | |
| [[gnu::musttail]] return foo (nullptr); | |
| @} | |
| @} | |
| @end smallexample | |
| This warning is enabled by @option{-Wextra}. | |
| @opindex Wnrvo | |
| @opindex Wno-nrvo | |
| @item -Wnrvo @r{(C++ and Objective-C++ only)} | |
| Warn if the compiler does not elide the copy from a local variable to | |
| the return value of a function in a context where it is allowed by | |
| [class.copy.elision]. This elision is commonly known as the Named | |
| Return Value Optimization. For instance, in the example below the | |
| compiler cannot elide copies from both v1 and v2, so it elides neither. | |
| @smallexample | |
| std::vector<int> f() | |
| @{ | |
| std::vector<int> v1, v2; | |
| // ... | |
| if (cond) return v1; | |
| else return v2; // warning: not eliding copy | |
| @} | |
| @end smallexample | |
| @opindex Winfinite-recursion | |
| @opindex Wno-infinite-recursion | |
| @item -Winfinite-recursion | |
| Warn about infinitely recursive calls. The warning is effective at all | |
| optimization levels but requires optimization in order to detect infinite | |
| recursion in calls between two or more functions. | |
| @option{-Winfinite-recursion} is included in @option{-Wall}. | |
| Compare with @option{-Wanalyzer-infinite-recursion} which provides a | |
| similar diagnostic, but is implemented in a different way (as part of | |
| @option{-fanalyzer}). | |
| @opindex Winit-self | |
| @opindex Wno-init-self | |
| @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)} | |
| Warn about uninitialized variables that are initialized with themselves. | |
| Note this option can only be used with the @option{-Wuninitialized} option. | |
| For example, GCC warns about @code{i} being uninitialized in the | |
| following snippet only when @option{-Winit-self} has been specified: | |
| @smallexample | |
| @group | |
| int f() | |
| @{ | |
| int i = i; | |
| return i; | |
| @} | |
| @end group | |
| @end smallexample | |
| This warning is enabled by @option{-Wall} in C++. | |
| @opindex Wimplicit-int | |
| @opindex Wno-implicit-int | |
| @item -Wno-implicit-int @r{(C and Objective-C only)} | |
| This option controls warnings when a declaration does not specify a type. | |
| This warning is enabled by default, as an error, in C99 and later | |
| dialects of C, and also by @option{-Wall}. The error can be downgraded | |
| to a warning using @option{-fpermissive} (along with certain other | |
| errors), or for this error alone, with @option{-Wno-error=implicit-int}. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wimplicit-function-declaration | |
| @opindex Wno-implicit-function-declaration | |
| @item -Wno-implicit-function-declaration @r{(C and Objective-C only)} | |
| This option controls warnings when a function is used before being declared. | |
| This warning is enabled by default, as an error, in C99 and later | |
| dialects of C, and also by @option{-Wall}. The error can be downgraded | |
| to a warning using @option{-fpermissive} (along with certain other | |
| errors), or for this error alone, with | |
| @option{-Wno-error=implicit-function-declaration}. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wimplicit | |
| @opindex Wno-implicit | |
| @item -Wimplicit @r{(C and Objective-C only)} | |
| Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}. | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Whardened | |
| @opindex Wno-hardened | |
| @item -Whardened | |
| Warn when @option{-fhardened} did not enable an option from its set (for | |
| which see @option{-fhardened}). For instance, using @option{-fhardened} | |
| and @option{-fstack-protector} at the same time on the command line causes | |
| @option{-Whardened} to warn because @option{-fstack-protector-strong} will | |
| not be enabled by @option{-fhardened}. | |
| This warning is enabled by default and has effect only when @option{-fhardened} | |
| is enabled. | |
| @opindex Wimplicit-fallthrough | |
| @opindex Wno-implicit-fallthrough | |
| @item -Wimplicit-fallthrough | |
| @option{-Wimplicit-fallthrough} is the same as @option{-Wimplicit-fallthrough=3} | |
| and @option{-Wno-implicit-fallthrough} is the same as | |
| @option{-Wimplicit-fallthrough=0}. | |
| @opindex Wimplicit-fallthrough= | |
| @item -Wimplicit-fallthrough=@var{n} | |
| Warn when a switch case falls through. For example: | |
| @smallexample | |
| @group | |
| switch (cond) | |
| @{ | |
| case 1: | |
| a = 1; | |
| break; | |
| case 2: | |
| a = 2; | |
| case 3: | |
| a = 3; | |
| break; | |
| @} | |
| @end group | |
| @end smallexample | |
| This warning does not warn when the last statement of a case cannot | |
| fall through, e.g. when there is a return statement or a call to function | |
| declared with the noreturn attribute. @option{-Wimplicit-fallthrough=} | |
| also takes into account control flow statements, such as ifs, and only | |
| warns when appropriate. E.g.@: | |
| @smallexample | |
| @group | |
| switch (cond) | |
| @{ | |
| case 1: | |
| if (i > 3) @{ | |
| bar (5); | |
| break; | |
| @} else if (i < 1) @{ | |
| bar (0); | |
| @} else | |
| return; | |
| default: | |
| @dots{} | |
| @} | |
| @end group | |
| @end smallexample | |
| Since there are occasions where a switch case fall through is desirable, | |
| GCC provides an attribute, @code{__attribute__ ((fallthrough))}, that is | |
| to be used along with a null statement to suppress this warning that | |
| would normally occur: | |
| @smallexample | |
| @group | |
| switch (cond) | |
| @{ | |
| case 1: | |
| bar (0); | |
| __attribute__ ((fallthrough)); | |
| default: | |
| @dots{} | |
| @} | |
| @end group | |
| @end smallexample | |
| C++17 and C23 provide a standard way to suppress the @option{-Wimplicit-fallthrough} | |
| warning using @code{[[fallthrough]];} instead of the GNU attribute. In C++11 | |
| or C++14 users can use @code{[[gnu::fallthrough]];}, which is a GNU extension. | |
| Instead of these attributes, it is also possible to add a fallthrough comment | |
| to silence the warning. The whole body of the C or C++ style comment should | |
| match the given regular expressions listed below. The option argument @var{n} | |
| specifies what kind of comments are accepted: | |
| @itemize @bullet | |
| @item @option{-Wimplicit-fallthrough=0} disables the warning altogether. | |
| @item @option{-Wimplicit-fallthrough=1} matches @code{.*} regular | |
| expression, any comment is used as fallthrough comment. | |
| @item @option{-Wimplicit-fallthrough=2} case insensitively matches | |
| @code{.*falls?[ \t-]*thr(ough|u).*} regular expression. | |
| @item @option{-Wimplicit-fallthrough=3} case sensitively matches one of the | |
| following regular expressions: | |
| @itemize @bullet | |
| @item @code{-fallthrough} | |
| @item @code{@@fallthrough@@} | |
| @item @code{lint -fallthrough[ \t]*} | |
| @item @code{[ \t.!]*(ELSE,? |INTENTIONAL(LY)? )?@*FALL(S | |-)?THR(OUGH|U)[ \t.!]*(-[^\n\r]*)?} | |
| @item @code{[ \t.!]*(Else,? |Intentional(ly)? )?@*Fall((s | |-)[Tt]|t)hr(ough|u)[ \t.!]*(-[^\n\r]*)?} | |
| @item @code{[ \t.!]*([Ee]lse,? |[Ii]ntentional(ly)? )?@*fall(s | |-)?thr(ough|u)[ \t.!]*(-[^\n\r]*)?} | |
| @end itemize | |
| @item @option{-Wimplicit-fallthrough=4} case sensitively matches one of the | |
| following regular expressions: | |
| @itemize @bullet | |
| @item @code{-fallthrough} | |
| @item @code{@@fallthrough@@} | |
| @item @code{lint -fallthrough[ \t]*} | |
| @item @code{[ \t]*FALLTHR(OUGH|U)[ \t]*} | |
| @end itemize | |
| @item @option{-Wimplicit-fallthrough=5} doesn't recognize any comments as | |
| fallthrough comments, only attributes disable the warning. | |
| @end itemize | |
| The comment needs to be followed after optional whitespace and other comments | |
| by @code{case} or @code{default} keywords or by a user label that precedes some | |
| @code{case} or @code{default} label. | |
| @smallexample | |
| @group | |
| switch (cond) | |
| @{ | |
| case 1: | |
| bar (0); | |
| /* FALLTHRU */ | |
| default: | |
| @dots{} | |
| @} | |
| @end group | |
| @end smallexample | |
| The @option{-Wimplicit-fallthrough=3} warning is enabled by @option{-Wextra}. | |
| @opindex Wif-not-aligned | |
| @opindex Wno-if-not-aligned | |
| @item -Wno-if-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)} | |
| Control if warnings triggered by the @code{warn_if_not_aligned} attribute | |
| should be issued. These warnings are enabled by default. | |
| @opindex Wignored-qualifiers | |
| @opindex Wno-ignored-qualifiers | |
| @item -Wignored-qualifiers @r{(C and C++ only)} | |
| Warn if the return type of a function has a type qualifier | |
| such as @code{const}. For ISO C such a type qualifier has no effect, | |
| since the value returned by a function is not an lvalue. | |
| For C++, the warning is only emitted for scalar types or @code{void}. | |
| ISO C prohibits qualified @code{void} return types on function | |
| definitions, so such return types always receive a warning | |
| even without this option. | |
| This warning is also enabled by @option{-Wextra}. | |
| @opindex Wignored-attributes | |
| @opindex Wno-ignored-attributes | |
| @item -Wno-ignored-attributes @r{(C and C++ only)} | |
| This option controls warnings when an attribute is ignored. | |
| This is different from the | |
| @option{-Wattributes} option in that it warns whenever the compiler decides | |
| to drop an attribute, not that the attribute is either unknown, used in a | |
| wrong place, etc. This warning is enabled by default. | |
| @opindex Wmain | |
| @opindex Wno-main | |
| @item -Wmain | |
| Warn if the type of @code{main} is suspicious. @code{main} should be | |
| a function with external linkage, returning int, taking either zero | |
| arguments, two, or three arguments of appropriate types. This warning | |
| is enabled by default in C++ and is enabled by either @option{-Wall} | |
| or @option{-Wpedantic}. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wmisleading-indentation | |
| @opindex Wno-misleading-indentation | |
| @item -Wmisleading-indentation @r{(C and C++ only)} | |
| Warn when the indentation of the code does not reflect the block structure. | |
| Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and | |
| @code{for} clauses with a guarded statement that does not use braces, | |
| followed by an unguarded statement with the same indentation. | |
| In the following example, the call to ``bar'' is misleadingly indented as | |
| if it were guarded by the ``if'' conditional. | |
| @smallexample | |
| if (some_condition ()) | |
| foo (); | |
| bar (); /* Gotcha: this is not guarded by the "if". */ | |
| @end smallexample | |
| In the case of mixed tabs and spaces, the warning uses the | |
| @option{-ftabstop=} option to determine if the statements line up | |
| (defaulting to 8). | |
| The warning is not issued for code involving multiline preprocessor logic | |
| such as the following example. | |
| @smallexample | |
| if (flagA) | |
| foo (0); | |
| #if SOME_CONDITION_THAT_DOES_NOT_HOLD | |
| if (flagB) | |
| #endif | |
| foo (1); | |
| @end smallexample | |
| The warning is not issued after a @code{#line} directive, since this | |
| typically indicates autogenerated code, and no assumptions can be made | |
| about the layout of the file that the directive references. | |
| This warning is enabled by @option{-Wall} in C and C++. | |
| @opindex Wmissing-attributes | |
| @opindex Wno-missing-attributes | |
| @item -Wmissing-attributes | |
| Warn when a declaration of a function is missing one or more attributes | |
| that a related function is declared with and whose absence may adversely | |
| affect the correctness or efficiency of generated code. For example, | |
| the warning is issued for declarations of aliases that use attributes | |
| to specify less restrictive requirements than those of their targets. | |
| This typically represents a potential optimization opportunity. | |
| By contrast, the @option{-Wattribute-alias=2} option controls warnings | |
| issued when the alias is more restrictive than the target, which could | |
| lead to incorrect code generation. | |
| Attributes considered include @code{alloc_align}, @code{alloc_size}, | |
| @code{cold}, @code{const}, @code{hot}, @code{leaf}, @code{malloc}, | |
| @code{nonnull}, @code{noreturn}, @code{nothrow}, @code{pure}, | |
| @code{returns_nonnull}, and @code{returns_twice}. | |
| In C++, the warning is issued when an explicit specialization of a primary | |
| template declared with attribute @code{alloc_align}, @code{alloc_size}, | |
| @code{assume_aligned}, @code{format}, @code{format_arg}, @code{malloc}, | |
| or @code{nonnull} is declared without it. Attributes @code{deprecated}, | |
| @code{error}, and @code{warning} suppress the warning. | |
| (@pxref{Common Attributes}). | |
| You can use the @code{copy} attribute to apply the same | |
| set of attributes to a declaration as that on another declaration without | |
| explicitly enumerating the attributes. This attribute can be applied | |
| to declarations of functions, variables, or types. @ref{Common Attributes}. | |
| @option{-Wmissing-attributes} is enabled by @option{-Wall}. | |
| For example, since the declaration of the primary function template | |
| below makes use of both attribute @code{malloc} and @code{alloc_size} | |
| the declaration of the explicit specialization of the template is | |
| diagnosed because it is missing one of the attributes. | |
| @smallexample | |
| template <class T> | |
| T* __attribute__ ((malloc, alloc_size (1))) | |
| allocate (size_t); | |
| template <> | |
| void* __attribute__ ((malloc)) // missing alloc_size | |
| allocate<void> (size_t); | |
| @end smallexample | |
| @opindex Wmissing-braces | |
| @opindex Wno-missing-braces | |
| @item -Wmissing-braces | |
| Warn if an aggregate or union initializer is not fully bracketed. In | |
| the following example, the initializer for @code{a} is not fully | |
| bracketed, but that for @code{b} is fully bracketed. | |
| @smallexample | |
| int a[2][2] = @{ 0, 1, 2, 3 @}; | |
| int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @}; | |
| @end smallexample | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wmissing-include-dirs | |
| @opindex Wno-missing-include-dirs | |
| @item -Wmissing-include-dirs @r{(C, C++, Objective-C, Objective-C++ and Fortran only)} | |
| Warn if a user-supplied include directory does not exist. This option is disabled | |
| by default for C, C++, Objective-C and Objective-C++. For Fortran, it is partially | |
| enabled by default by warning for -I and -J, only. | |
| @opindex Wmissing-profile | |
| @opindex Wno-missing-profile | |
| @item -Wno-missing-profile | |
| This option controls warnings if feedback profiles are missing when using the | |
| @option{-fprofile-use} option. | |
| This option diagnoses those cases where a new function or a new file is added | |
| between compiling with @option{-fprofile-generate} and with | |
| @option{-fprofile-use}, without regenerating the profiles. | |
| In these cases, the profile feedback data files do not contain any | |
| profile feedback information for | |
| the newly added function or file respectively. Also, in the case when profile | |
| count data (.gcda) files are removed, GCC cannot use any profile feedback | |
| information. In all these cases, warnings are issued to inform you that a | |
| profile generation step is due. | |
| Ignoring the warning can result in poorly optimized code. | |
| @option{-Wno-missing-profile} can be used to | |
| disable the warning, but this is not recommended and should be done only | |
| when non-existent profile data is justified. | |
| @opindex Wmismatched-dealloc | |
| @opindex Wno-mismatched-dealloc | |
| @item -Wmismatched-dealloc | |
| Warn for calls to deallocation functions with pointer arguments returned | |
| from allocation functions for which the former isn't a suitable | |
| deallocator. A pair of functions can be associated as matching allocators | |
| and deallocators by use of attribute @code{malloc}. Unless disabled by | |
| the @option{-fno-builtin} option the standard functions @code{calloc}, | |
| @code{malloc}, @code{realloc}, and @code{free}, as well as the corresponding | |
| forms of C++ @code{operator new} and @code{operator delete} are implicitly | |
| associated as matching allocators and deallocators. In the following | |
| example @code{mydealloc} is the deallocator for pointers returned from | |
| @code{myalloc}. | |
| @smallexample | |
| void mydealloc (void*); | |
| __attribute__ ((malloc (mydealloc, 1))) void* | |
| myalloc (size_t); | |
| void f (void) | |
| @{ | |
| void *p = myalloc (32); | |
| // @dots{}use p@dots{} | |
| free (p); // warning: not a matching deallocator for myalloc | |
| mydealloc (p); // ok | |
| @} | |
| @end smallexample | |
| In C++, the related option @option{-Wmismatched-new-delete} diagnoses | |
| mismatches involving either @code{operator new} or @code{operator delete}. | |
| Option @option{-Wmismatched-dealloc} is included in @option{-Wall}. | |
| @opindex Wmultistatement-macros | |
| @opindex Wno-multistatement-macros | |
| @item -Wmultistatement-macros | |
| Warn about unsafe multiple statement macros that appear to be guarded | |
| by a clause such as @code{if}, @code{else}, @code{for}, @code{switch}, or | |
| @code{while}, in which only the first statement is actually guarded after | |
| the macro is expanded. | |
| For example: | |
| @smallexample | |
| #define DOIT x++; y++ | |
| if (c) | |
| DOIT; | |
| @end smallexample | |
| will increment @code{y} unconditionally, not just when @code{c} holds. | |
| The can usually be fixed by wrapping the macro in a do-while loop: | |
| @smallexample | |
| #define DOIT do @{ x++; y++; @} while (0) | |
| if (c) | |
| DOIT; | |
| @end smallexample | |
| This warning is enabled by @option{-Wall} in C and C++. | |
| @opindex Wparentheses | |
| @opindex Wno-parentheses | |
| @item -Wparentheses | |
| Warn if parentheses are omitted in certain contexts, such | |
| as when there is an assignment in a context where a truth value | |
| is expected, or when operators are nested whose precedence people | |
| often get confused about. | |
| Also warn if a comparison like @code{x<=y<=z} appears; this is | |
| equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different | |
| interpretation from that of ordinary mathematical notation. | |
| Also warn for dangerous uses of the GNU extension to | |
| @code{?:} with omitted middle operand. When the condition | |
| in the @code{?}: operator is a boolean expression, the omitted value is | |
| always 1. Often programmers expect it to be a value computed | |
| inside the conditional expression instead. | |
| For C++ this also warns for some cases of unnecessary parentheses in | |
| declarations, which can indicate an attempt at a function call instead | |
| of a declaration: | |
| @smallexample | |
| @{ | |
| // Declares a local variable called mymutex. | |
| std::unique_lock<std::mutex> (mymutex); | |
| // User meant std::unique_lock<std::mutex> lock (mymutex); | |
| @} | |
| @end smallexample | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wself-move | |
| @opindex Wno-self-move | |
| @item -Wno-self-move @r{(C++ and Objective-C++ only)} | |
| This warning warns when a value is moved to itself with @code{std::move}. | |
| Such a @code{std::move} typically has no effect. | |
| @smallexample | |
| struct T @{ | |
| @dots{} | |
| @}; | |
| void fn() | |
| @{ | |
| T t; | |
| @dots{} | |
| t = std::move (t); | |
| @} | |
| @end smallexample | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wsequence-point | |
| @opindex Wno-sequence-point | |
| @item -Wsequence-point | |
| Warn about code that may have undefined semantics because of violations | |
| of sequence point rules in the C and C++ standards. | |
| The C and C++ standards define the order in which expressions in a C/C++ | |
| program are evaluated in terms of @dfn{sequence points}, which represent | |
| a partial ordering between the execution of parts of the program: those | |
| executed before the sequence point, and those executed after it. These | |
| occur after the evaluation of a full expression (one which is not part | |
| of a larger expression), after the evaluation of the first operand of a | |
| @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a | |
| function is called (but after the evaluation of its arguments and the | |
| expression denoting the called function), and in certain other places. | |
| Other than as expressed by the sequence point rules, the order of | |
| evaluation of subexpressions of an expression is not specified. All | |
| these rules describe only a partial order rather than a total order, | |
| since, for example, if two functions are called within one expression | |
| with no sequence point between them, the order in which the functions | |
| are called is not specified. However, the standards committee have | |
| ruled that function calls do not overlap. | |
| It is not specified when between sequence points modifications to the | |
| values of objects take effect. Programs whose behavior depends on this | |
| have undefined behavior; the C and C++ standards specify that ``Between | |
| the previous and next sequence point an object shall have its stored | |
| value modified at most once by the evaluation of an expression. | |
| Furthermore, the prior value shall be read only to determine the value | |
| to be stored.''. If a program breaks these rules, the results on any | |
| particular implementation are entirely unpredictable. | |
| Examples of code with undefined behavior are @code{a = a++;}, @code{a[n] | |
| = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not | |
| diagnosed by this option, and it may give an occasional false positive | |
| result, but in general it has been found fairly effective at detecting | |
| this sort of problem in programs. | |
| The C++17 standard will define the order of evaluation of operands in | |
| more cases: in particular it requires that the right-hand side of an | |
| assignment be evaluated before the left-hand side, so the above | |
| examples are no longer undefined. But this option will still warn | |
| about them, to help people avoid writing code that is undefined in C | |
| and earlier revisions of C++. | |
| The standard is worded confusingly, therefore there is some debate | |
| over the precise meaning of the sequence point rules in subtle cases. | |
| Links to discussions of the problem, including proposed formal | |
| definitions, may be found on the GCC readings page, at | |
| @uref{https://gcc.gnu.org/@/readings.html}. | |
| This warning is enabled by @option{-Wall} for C and C++. | |
| @opindex Wno-return-local-addr | |
| @opindex Wreturn-local-addr | |
| @item -Wno-return-local-addr | |
| Do not warn about returning a pointer (or in C++, a reference) to a | |
| variable that goes out of scope after the function returns. | |
| @opindex Wreturn-mismatch | |
| @opindex Wno-return-mismatch | |
| @item -Wreturn-mismatch | |
| Warn about return statements without an expressions in functions which | |
| do not return @code{void}. Also warn about a @code{return} statement | |
| with an expression in a function whose return type is @code{void}, | |
| unless the expression type is also @code{void}. As a GNU extension, the | |
| latter case is accepted without a warning unless @option{-Wpedantic} is | |
| used. | |
| Attempting to use the return value of a non-@code{void} function other | |
| than @code{main} that flows off the end by reaching the closing curly | |
| brace that terminates the function is undefined. | |
| This warning is specific to C and enabled by default. In C99 and later | |
| language dialects, it is treated as an error. It can be downgraded | |
| to a warning using @option{-fpermissive} (along with other warnings), | |
| or for just this warning, with @option{-Wno-error=return-mismatch}. | |
| @opindex Wreturn-type | |
| @opindex Wno-return-type | |
| @item -Wreturn-type | |
| Warn whenever a function is defined with a return type that defaults to | |
| @code{int} (unless @option{-Wimplicit-int} is active, which takes | |
| precedence). Also warn if execution may reach the end of the function | |
| body, or if the function does not contain any return statement at all. | |
| Attempting to use the return value of a non-@code{void} function other | |
| than @code{main} that flows off the end by reaching the closing curly | |
| brace that terminates the function is undefined. | |
| Unlike in C, in C++, flowing off the end of a non-@code{void} function other | |
| than @code{main} results in undefined behavior even when the value of | |
| the function is not used. | |
| This warning is enabled by default in C++ and by @option{-Wall} otherwise. | |
| @opindex Wshift-count-negative | |
| @opindex Wno-shift-count-negative | |
| @item -Wno-shift-count-negative | |
| Controls warnings if a shift count is negative. | |
| This warning is enabled by default. | |
| @opindex Wshift-count-overflow | |
| @opindex Wno-shift-count-overflow | |
| @item -Wno-shift-count-overflow | |
| Controls warnings if a shift count is greater than or equal to the bit width | |
| of the type. This warning is enabled by default. | |
| @opindex Wshift-negative-value | |
| @opindex Wno-shift-negative-value | |
| @item -Wshift-negative-value | |
| Warn if left shifting a negative value. This warning is enabled by | |
| @option{-Wextra} in C99 (and newer) and C++11 to C++17 modes. | |
| @opindex Wshift-overflow | |
| @opindex Wno-shift-overflow | |
| @item -Wno-shift-overflow | |
| @itemx -Wshift-overflow=@var{n} | |
| These options control warnings about left shift overflows. | |
| @table @gcctabopt | |
| @item -Wshift-overflow=1 | |
| This is the warning level of @option{-Wshift-overflow} and is enabled | |
| by default in C99 and C++11 modes (and newer). This warning level does | |
| not warn about left-shifting 1 into the sign bit. (However, in C, such | |
| an overflow is still rejected in contexts where an integer constant expression | |
| is required.) No warning is emitted in C++20 mode (and newer), as signed left | |
| shifts always wrap. | |
| @item -Wshift-overflow=2 | |
| This warning level also warns about left-shifting 1 into the sign bit, | |
| unless C++14 mode (or newer) is active. | |
| @end table | |
| @opindex Wswitch | |
| @opindex Wno-switch | |
| @item -Wswitch | |
| Warn whenever a @code{switch} statement has an index of enumerated type | |
| and lacks a @code{case} for one or more of the named codes of that | |
| enumeration. (The presence of a @code{default} label prevents this | |
| warning.) @code{case} labels that do not correspond to enumerators also | |
| provoke warnings when this option is used, unless the enumeration is marked | |
| with the @code{flag_enum} attribute. | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wswitch-default | |
| @opindex Wno-switch-default | |
| @item -Wswitch-default | |
| Warn whenever a @code{switch} statement does not have a @code{default} | |
| case. | |
| @opindex Wswitch-enum | |
| @opindex Wno-switch-enum | |
| @item -Wswitch-enum | |
| Warn whenever a @code{switch} statement has an index of enumerated type | |
| and lacks a @code{case} for one or more of the named codes of that | |
| enumeration. @code{case} labels that do not correspond to enumerators also | |
| provoke warnings when this option is used, unless the enumeration is marked | |
| with the @code{flag_enum} attribute. The only difference | |
| between @option{-Wswitch} and this option is that this option gives a | |
| warning about an omitted enumeration code even if there is a | |
| @code{default} label. | |
| @opindex Wswitch-bool | |
| @opindex Wno-switch-bool | |
| @item -Wno-switch-bool | |
| Do not warn when a @code{switch} statement has an index of boolean type | |
| and the case values are outside the range of a boolean type. | |
| It is possible to suppress this warning by casting the controlling | |
| expression to a type other than @code{bool}. For example: | |
| @smallexample | |
| @group | |
| switch ((int) (a == 4)) | |
| @{ | |
| @dots{} | |
| @} | |
| @end group | |
| @end smallexample | |
| This warning is enabled by default for C and C++ programs. | |
| @opindex Wswitch-outside-range | |
| @opindex Wno-switch-outside-range | |
| @item -Wno-switch-outside-range | |
| This option controls warnings when a @code{switch} case has a value | |
| that is outside of its | |
| respective type range. This warning is enabled by default for | |
| C and C++ programs. | |
| @opindex Wswitch-unreachable | |
| @opindex Wno-switch-unreachable | |
| @item -Wno-switch-unreachable | |
| Do not warn when a @code{switch} statement contains statements between the | |
| controlling expression and the first case label, which will never be | |
| executed. For example: | |
| @smallexample | |
| @group | |
| switch (cond) | |
| @{ | |
| i = 15; | |
| @dots{} | |
| case 5: | |
| @dots{} | |
| @} | |
| @end group | |
| @end smallexample | |
| @option{-Wswitch-unreachable} does not warn if the statement between the | |
| controlling expression and the first case label is just a declaration: | |
| @smallexample | |
| @group | |
| switch (cond) | |
| @{ | |
| int i; | |
| @dots{} | |
| case 5: | |
| i = 5; | |
| @dots{} | |
| @} | |
| @end group | |
| @end smallexample | |
| This warning is enabled by default for C and C++ programs. | |
| @opindex Wsync-nand | |
| @opindex Wno-sync-nand | |
| @item -Wsync-nand @r{(C and C++ only)} | |
| Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch} | |
| built-in functions are used. These functions changed semantics in GCC 4.4. | |
| @opindex Wtrivial-auto-var-init | |
| @opindex Wno-trivial-auto-var-init | |
| @item -Wtrivial-auto-var-init | |
| Warn when @code{-ftrivial-auto-var-init} cannot initialize the automatic | |
| variable. A common situation is an automatic variable that is declared | |
| between the controlling expression and the first case label of a @code{switch} | |
| statement. | |
| @opindex Wunused-but-set-parameter | |
| @opindex Wno-unused-but-set-parameter | |
| @item -Wunused-but-set-parameter | |
| @option{-Wunused-but-set-parameter} is the same as | |
| @option{-Wunused-but-set-parameter=3} and | |
| @option{-Wno-unused-but-set-parameter} is the same as | |
| @option{-Wunused-but-set-parameter=0}. | |
| @opindex Wunused-but-set-parameter= | |
| @item -Wunused-but-set-parameter=@var{n} | |
| Warn whenever a function parameter is assigned to, but otherwise unused | |
| (aside from its declaration). | |
| To suppress this warning use the @code{unused} attribute | |
| (@pxref{Common Attributes}). | |
| @option{-Wunused-but-set-parameter=0} disables the warning. | |
| With @option{-Wunused-but-set-parameter=1} all uses except initialization | |
| and left hand side of assignment which is not further used disable the | |
| warning. | |
| With @option{-Wunused-but-set-parameter=2} additionally uses of parameter | |
| in @code{++} and @code{--} operators don't count as uses. | |
| And finally with @option{-Wunused-but-set-parameter=3} additionally | |
| uses in @var{parm} @code{@var{@@}=} @var{rhs} outside of @var{rhs} don't | |
| count as uses. See @option{-Wunused-but-set-variable=@var{n}} option for | |
| examples. | |
| This @option{-Wunused-but-set-parameter=3} warning is also enabled by | |
| @option{-Wunused} together with @option{-Wextra}. | |
| @opindex Wunused-but-set-variable | |
| @opindex Wno-unused-but-set-variable | |
| @item -Wunused-but-set-variable | |
| @option{-Wunused-but-set-variable} is the same as | |
| @option{-Wunused-but-set-variable=3} and | |
| @option{-Wno-unused-but-set-variable} is the same as | |
| @option{-Wunused-but-set-variable=0}. | |
| @opindex Wunused-but-set-variable= | |
| @item -Wunused-but-set-variable=@var{n} | |
| Warn whenever a local variable is assigned to, but otherwise unused | |
| (aside from its declaration). | |
| This @option{-Wunused-but-set-variable=3} warning is enabled by @option{-Wall}. | |
| To suppress this warning use the @code{unused} attribute | |
| (@pxref{Common Attributes}). | |
| @option{-Wunused-but-set-variable=0} disables the warning. | |
| With @option{-Wunused-but-set-variable=1} all uses except initialization | |
| and left hand side of assignment which is not further used disable the | |
| warning. | |
| With @option{-Wunused-but-set-variable=2} additionally uses of variable | |
| in @code{++} and @code{--} operators don't count as uses. | |
| And finally with @option{-Wunused-but-set-variable=3} additionally | |
| uses in @var{parm} @code{@var{@@}=} @var{rhs} outside of @var{rhs} don't | |
| count as uses. | |
| This @option{-Wunused-but-set-variable=3} warning is also enabled by | |
| @option{-Wunused}, which is enabled by @option{-Wall}. | |
| @smallexample | |
| void foo (void) | |
| @{ | |
| int a = 1; // @option{-Wunused-variable} warning | |
| int b = 0; // Warning for @var{n} >= 1 | |
| b = 1; b = 2; | |
| int c = 0; // Warning for @var{n} >= 2 | |
| ++c; c--; --c; c++; | |
| int d = 0; // Warning for @var{n} >= 3 | |
| d += 4; | |
| int e = 0; // No warning, cast to void | |
| (void) e; | |
| int f = 0; // No warning, f used | |
| int g = f = 5; | |
| (void) g; | |
| int h = 0; // No warning, preincrement result used | |
| int i = ++h; | |
| (void) i; | |
| int j = 0; // No warning, postdecrement result used | |
| int k = j--; | |
| (void) k; | |
| int l = 0; // No warning, l used | |
| int m = l |= 2; | |
| (void) m; | |
| @} | |
| @end smallexample | |
| @opindex Wunused-function | |
| @opindex Wno-unused-function | |
| @item -Wunused-function | |
| Warn whenever a static function is declared but not defined or a | |
| non-inline static function is unused. | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wunused-label | |
| @opindex Wno-unused-label | |
| @item -Wunused-label | |
| Warn whenever a label is declared but not used. | |
| This warning is enabled by @option{-Wall}. | |
| To suppress this warning use the @code{unused} attribute | |
| (@pxref{Common Attributes}). | |
| @opindex Wunused-local-typedefs | |
| @opindex Wno-unused-local-typedefs | |
| @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)} | |
| Warn when a typedef locally defined in a function is not used. | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wunused-parameter | |
| @opindex Wno-unused-parameter | |
| @item -Wunused-parameter | |
| Warn whenever a function parameter is unused aside from its declaration. | |
| This option is not enabled by @code{-Wunused} unless @code{-Wextra} is also | |
| specified. | |
| To suppress this warning use the @code{unused} attribute | |
| (@pxref{Common Attributes}). | |
| @opindex Wunused-result | |
| @opindex Wno-unused-result | |
| @item -Wno-unused-result | |
| Do not warn if a caller of a function marked with attribute | |
| @code{warn_unused_result} (@pxref{Common Attributes}) does not use | |
| its return value. The default is @option{-Wunused-result}. | |
| @opindex Wunused-variable | |
| @opindex Wno-unused-variable | |
| @item -Wunused-variable | |
| Warn whenever a local or static variable is unused aside from its | |
| declaration. This option implies @option{-Wunused-const-variable=1} for C, | |
| but not for C++. This warning is enabled by @option{-Wall}. | |
| To suppress this warning use the @code{unused} attribute | |
| (@pxref{Common Attributes}). | |
| @opindex Wunused-const-variable | |
| @opindex Wno-unused-const-variable | |
| @item -Wunused-const-variable | |
| @itemx -Wunused-const-variable=@var{n} | |
| Warn whenever a constant static variable is unused aside from its declaration. | |
| To suppress this warning use the @code{unused} attribute | |
| (@pxref{Common Attributes}). | |
| @table @gcctabopt | |
| @item -Wunused-const-variable=1 | |
| Warn about unused static const variables defined in the main | |
| compilation unit, but not about static const variables declared in any | |
| header included. | |
| @option{-Wunused-const-variable=1} is enabled by either | |
| @option{-Wunused-variable} or @option{-Wunused} for C, but not for | |
| C++. In C, this declares variable storage, but in C++, this is not an | |
| error since const variables take the place of @code{#define}s. | |
| @item -Wunused-const-variable=2 | |
| This warning level also warns for unused constant static variables in | |
| headers (excluding system headers). It is equivalent to the short form | |
| @option{-Wunused-const-variable}. This level must be explicitly | |
| requested in both C and C++ because it might be hard to clean up all | |
| headers included. | |
| @end table | |
| @opindex Wunused-value | |
| @opindex Wno-unused-value | |
| @item -Wunused-value | |
| Warn whenever a statement computes a result that is explicitly not | |
| used. To suppress this warning cast the unused expression to | |
| @code{void}. This includes an expression-statement or the left-hand | |
| side of a comma expression that contains no side effects. For example, | |
| an expression such as @code{x[i,j]} causes a warning, while | |
| @code{x[(void)i,j]} does not. | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wunused | |
| @opindex Wno-unused | |
| @item -Wunused | |
| All the above @option{-Wunused} options combined, except those documented | |
| as needing to be specified explicitly. | |
| In order to get a warning about an unused function parameter, you must | |
| either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies | |
| @option{-Wunused}), or separately specify @option{-Wunused-parameter} and/or | |
| @option{-Wunused-but-set-parameter}. | |
| @option{-Wunused} enables only @option{-Wunused-const-variable=1} rather than | |
| @option{-Wunused-const-variable}, and only for C, not C++. | |
| @opindex Wuse-after-free | |
| @opindex Wno-use-after-free | |
| @item -Wuse-after-free @r{(C, Objective-C, C++ and Objective-C++ only)} | |
| @itemx -Wuse-after-free=@var{n} | |
| Warn about uses of pointers to dynamically allocated objects that have | |
| been rendered indeterminate by a call to a deallocation function. | |
| The warning is enabled at all optimization levels but may yield different | |
| results with optimization than without. | |
| @option{-Wuse-after-free} is equivalent to @option{-Wuse-after-free=1}. | |
| @table @gcctabopt | |
| @item -Wuse-after-free=1 | |
| At level 1 the warning attempts to diagnose only unconditional uses | |
| of pointers made indeterminate by a deallocation call or a successful | |
| call to @code{realloc}, regardless of whether or not the call resulted | |
| in an actual reallocation of memory. This includes double-@code{free} | |
| calls as well as uses in arithmetic and relational expressions. Although | |
| undefined, uses of indeterminate pointers in equality (or inequality) | |
| expressions are not diagnosed at this level. | |
| @item -Wuse-after-free=2 | |
| At level 2, in addition to unconditional uses, the warning also diagnoses | |
| conditional uses of pointers made indeterminate by a deallocation call. | |
| As at level 2, uses in equality (or inequality) expressions are not | |
| diagnosed. For example, the second call to @code{free} in the following | |
| function is diagnosed at this level: | |
| @smallexample | |
| struct A @{ int refcount; void *data; @}; | |
| void release (struct A *p) | |
| @{ | |
| int refcount = --p->refcount; | |
| free (p); | |
| if (refcount == 0) | |
| free (p->data); // warning: p may be used after free | |
| @} | |
| @end smallexample | |
| @item -Wuse-after-free=3 | |
| At level 3, the warning also diagnoses uses of indeterminate pointers in | |
| equality expressions. All uses of indeterminate pointers are undefined | |
| but equality tests sometimes appear after calls to @code{realloc} as | |
| an attempt to determine whether the call resulted in relocating the object | |
| to a different address. They are diagnosed at a separate level to aid | |
| gradually transitioning legacy code to safe alternatives. For example, | |
| the equality test in the function below is diagnosed at this level: | |
| @smallexample | |
| void adjust_pointers (int**, int); | |
| void grow (int **p, int n) | |
| @{ | |
| int **q = (int**)realloc (p, n *= 2); | |
| if (q == p) | |
| return; | |
| adjust_pointers ((int**)q, n); | |
| @} | |
| @end smallexample | |
| To avoid the warning at this level, store offsets into allocated memory | |
| instead of pointers. This approach obviates needing to adjust the stored | |
| pointers after reallocation. | |
| @end table | |
| @option{-Wuse-after-free=2} is included in @option{-Wall}. | |
| @opindex Wuseless-cast | |
| @opindex Wno-useless-cast | |
| @item -Wuseless-cast @r{(C, Objective-C, C++ and Objective-C++ only)} | |
| Warn when an expression is cast to its own type. This warning does not | |
| occur when a class object is converted to a non-reference type as that | |
| is a way to create a temporary: | |
| @smallexample | |
| struct S @{ @}; | |
| void g (S&&); | |
| void f (S&& arg) | |
| @{ | |
| g (S(arg)); // make arg prvalue so that it can bind to S&& | |
| @} | |
| @end smallexample | |
| @opindex Wuninitialized | |
| @opindex Wno-uninitialized | |
| @item -Wuninitialized | |
| Warn if an object with automatic or allocated storage duration is used | |
| without having been initialized. In C++, also warn if a non-static | |
| reference or non-static @code{const} member appears in a class without | |
| constructors. | |
| In addition, passing a pointer (or in C++, a reference) to an uninitialized | |
| object to a @code{const}-qualified argument of a built-in function known to | |
| read the object is also diagnosed by this warning. | |
| (@option{-Wmaybe-uninitialized} is issued for ordinary functions.) | |
| If you want to warn about code that uses the uninitialized value of the | |
| variable in its own initializer, use the @option{-Winit-self} option. | |
| These warnings occur for individual uninitialized elements of | |
| structure, union or array variables as well as for variables that are | |
| uninitialized as a whole. They do not occur for variables or elements | |
| declared @code{volatile}. Because these warnings depend on | |
| optimization, the exact variables or elements for which there are | |
| warnings depend on the precise optimization options and version of GCC | |
| used. | |
| Note that there may be no warning about a variable that is used only | |
| to compute a value that itself is never used, because such | |
| computations may be deleted by data flow analysis before the warnings | |
| are printed. | |
| In C++, this warning also warns about using uninitialized objects in | |
| member-initializer-lists. For example, GCC warns about @code{b} being | |
| uninitialized in the following snippet: | |
| @smallexample | |
| struct A @{ | |
| int a; | |
| int b; | |
| A() : a(b) @{ @} | |
| @}; | |
| @end smallexample | |
| @opindex Winvalid-memory-model | |
| @opindex Wno-invalid-memory-model | |
| @item -Wno-invalid-memory-model | |
| This option controls warnings | |
| for invocations of @ref{__atomic Builtins}, @ref{__sync Builtins}, | |
| and the C11 atomic generic functions with a memory consistency argument | |
| that is either invalid for the operation or outside the range of values | |
| of the @code{memory_order} enumeration. For example, since the | |
| @code{__atomic_store} and @code{__atomic_store_n} built-ins are only | |
| defined for the relaxed, release, and sequentially consistent memory | |
| orders the following code is diagnosed: | |
| @smallexample | |
| void store (int *i) | |
| @{ | |
| __atomic_store_n (i, 0, memory_order_consume); | |
| @} | |
| @end smallexample | |
| @option{-Winvalid-memory-model} is enabled by default. | |
| @opindex Wmaybe-uninitialized | |
| @opindex Wno-maybe-uninitialized | |
| @item -Wmaybe-uninitialized | |
| For an object with automatic or allocated storage duration, if there exists | |
| a path from the function entry to a use of the object that is initialized, | |
| but there exist some other paths for which the object is not initialized, | |
| the compiler emits a warning if it cannot prove the uninitialized paths | |
| are not executed at run time. | |
| In addition, passing a pointer (or in C++, a reference) to an uninitialized | |
| object to a @code{const}-qualified function argument is also diagnosed by | |
| this warning. (@option{-Wuninitialized} is issued for built-in functions | |
| known to read the object.) Annotating the function with attribute | |
| @code{access (none)} indicates that the argument isn't used to access | |
| the object and avoids the warning (@pxref{Common Attributes}). | |
| These warnings are only possible in optimizing compilation, because otherwise | |
| GCC does not keep track of the state of variables. On the other hand, | |
| @option{-Wmaybe-uninitialized} is known not to warn in many situations | |
| (false negatives) due to optimizations taking advantage of undefinedness | |
| of uninitialized uses like constant propagation. | |
| These warnings are made optional because GCC may not be able to determine when | |
| the code is correct in spite of appearing to have an error. Here is one | |
| example of how this can happen: | |
| @smallexample | |
| @group | |
| @{ | |
| int x; | |
| switch (y) | |
| @{ | |
| case 1: x = 1; | |
| break; | |
| case 2: x = 4; | |
| break; | |
| case 3: x = 5; | |
| @} | |
| foo (x); | |
| @} | |
| @end group | |
| @end smallexample | |
| @noindent | |
| If the value of @code{y} is always 1, 2 or 3, then @code{x} is | |
| always initialized, but GCC doesn't know this. To suppress the | |
| warning, you need to provide a default case with assert(0) or | |
| similar code. | |
| @cindex @code{longjmp} warnings | |
| This option also warns when a non-volatile automatic variable might be | |
| changed by a call to @code{longjmp}. | |
| The compiler sees only the calls to @code{setjmp}. It cannot know | |
| where @code{longjmp} will be called; in fact, a signal handler could | |
| call it at any point in the code. As a result, you may get a warning | |
| even when there is in fact no problem because @code{longjmp} cannot | |
| in fact be called at the place that would cause a problem. | |
| Some spurious warnings can be avoided if you declare all the functions | |
| you use that never return as @code{noreturn}. @xref{Common Attributes}. | |
| This warning is enabled by @option{-Wall} or @option{-Wextra}. | |
| @opindex Wunknown-pragmas | |
| @opindex Wno-unknown-pragmas | |
| @cindex warning for unknown pragmas | |
| @cindex unknown pragmas, warning | |
| @cindex pragmas, warning of unknown | |
| @item -Wunknown-pragmas | |
| Warn when a @code{#pragma} directive is encountered that is not understood by | |
| GCC@. If this command-line option is used, warnings are even issued | |
| for unknown pragmas in system header files. This is not the case if | |
| the warnings are only enabled by the @option{-Wall} command-line option. | |
| @opindex Wno-pragmas | |
| @opindex Wpragmas | |
| @item -Wno-pragmas | |
| Do not warn about misuses of pragmas, such as incorrect parameters, | |
| invalid syntax, or conflicts between pragmas. See also | |
| @option{-Wunknown-pragmas}. | |
| @opindex Wno-pragma-once-outside-header | |
| @opindex Wpragma-once-outside-header | |
| @item -Wno-pragma-once-outside-header | |
| Do not warn when @code{#pragma once} is used in a file that is not a header | |
| file, such as a main file. | |
| @opindex Wno-prio-ctor-dtor | |
| @opindex Wprio-ctor-dtor | |
| @item -Wno-prio-ctor-dtor | |
| Do not warn if a priority from 0 to 100 is used for constructor or destructor. | |
| The use of constructor and destructor attributes allow you to assign a | |
| priority to the constructor/destructor to control its order of execution | |
| before @code{main} is called or after it returns. The priority values must be | |
| greater than 100 as the compiler reserves priority values between 0--100 for | |
| the implementation. | |
| @opindex Wstrict-aliasing | |
| @opindex Wno-strict-aliasing | |
| @item -Wstrict-aliasing | |
| This option warns about code that might break the strict aliasing rules | |
| that the compiler uses for optimization. The type-based checking done | |
| in the front end is performed even when @option{-fstrict-aliasing} is | |
| not active, provided @option{-Wstrict-aliasing} is requested explicitly; | |
| it is not performed for @option{-fno-strict-aliasing -Wall} alone. When | |
| optimization is enabled, the warning also runs in the back end, where it | |
| handles multiple-statement cases using flow-sensitive points-to | |
| information. The warning does not catch all cases, but does attempt to | |
| catch the more common pitfalls. It is included in @option{-Wall}. | |
| It is equivalent to @option{-Wstrict-aliasing=3}. | |
| @item -Wstrict-aliasing=@var{n} | |
| This option warns about code that might break the strict aliasing rules | |
| that the compiler uses for optimization. The type-based checking done | |
| in the front end is performed even when @option{-fstrict-aliasing} is | |
| not active, provided @option{-Wstrict-aliasing} is requested explicitly. | |
| When optimization is enabled, the warning also runs in the back end, | |
| where it handles multiple-statement cases using flow-sensitive points-to | |
| information. | |
| Higher levels correspond to higher accuracy (fewer false positives). | |
| Higher levels also correspond to more effort, similar to the way @option{-O} | |
| works. | |
| @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}. | |
| Level 1: Most aggressive, quick, least accurate. | |
| Possibly useful when higher levels | |
| do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few | |
| false negatives. However, it has many false positives. | |
| Warns for all pointer conversions between possibly incompatible types, | |
| even if never dereferenced. Runs in the front end only. | |
| Level 2: Aggressive, quick, not too precise. | |
| May still have many false positives (not as many as level 1 though), | |
| and few false negatives (but possibly more than level 1). | |
| Unlike level 1, it only warns when an address is taken. Warns about | |
| incomplete types. Runs in the front end only. | |
| Level 3 (default for @option{-Wstrict-aliasing}): | |
| Should have very few false positives and few false | |
| negatives. Slightly slower than levels 1 or 2 when optimization is enabled. | |
| Takes care of the common pun+dereference pattern in the front end: | |
| @code{*(int*)&some_float}. | |
| If optimization is enabled, it also runs in the back end, where it deals | |
| with multiple statement cases using flow-sensitive points-to information. | |
| Only warns when the converted pointer is dereferenced. | |
| Does not warn about incomplete types. | |
| @opindex Wstrict-overflow | |
| @opindex Wno-strict-overflow | |
| @item -Wstrict-overflow | |
| @itemx -Wstrict-overflow=@var{n} | |
| Does nothing. Preserved for backward compatibility. | |
| @table @gcctabopt | |
| @item -Wstrict-overflow=1 | |
| Does nothing. Preserved for backward compatibility. | |
| @item -Wstrict-overflow=2 | |
| Does nothing. Preserved for backward compatibility. | |
| @item -Wstrict-overflow=3 | |
| Does nothing. Preserved for backward compatibility. | |
| @item -Wstrict-overflow=4 | |
| Does nothing. Preserved for backward compatibility. | |
| @item -Wstrict-overflow=5 | |
| Does nothing. Preserved for backward compatibility. | |
| @end table | |
| @opindex Wstring-compare | |
| @opindex Wno-string-compare | |
| @item -Wstring-compare | |
| Warn for calls to @code{strcmp} and @code{strncmp} whose result is | |
| determined to be either zero or non-zero in tests for such equality | |
| owing to the length of one argument being greater than the size of | |
| the array the other argument is stored in (or the bound in the case | |
| of @code{strncmp}). Such calls could be mistakes. For example, | |
| the call to @code{strcmp} below is diagnosed because its result is | |
| necessarily non-zero irrespective of the contents of the array @code{a}. | |
| @smallexample | |
| extern char a[4]; | |
| void f (char *d) | |
| @{ | |
| strcpy (d, "string"); | |
| @dots{} | |
| if (0 == strcmp (a, d)) // cannot be true | |
| puts ("a and d are the same"); | |
| @} | |
| @end smallexample | |
| @option{-Wstring-compare} is enabled by @option{-Wextra}. | |
| @opindex Wstringop-overflow | |
| @opindex Wno-stringop-overflow | |
| @item -Wno-stringop-overflow | |
| @item -Wstringop-overflow | |
| @itemx -Wstringop-overflow=@var{type} | |
| Warn for code that can be statically determined to cause buffer overflows or | |
| memory overruns, such as calls to @code{memcpy} and | |
| @code{strcpy} that overflow the destination buffer. The | |
| optional argument is one greater than the type of Object Size Checking to | |
| perform to determine the size of the destination. @xref{Object Size Checking}. | |
| The argument is meaningful only for string functions | |
| that operate on character arrays; raw memory functions like @code{memcpy} | |
| always use type-zero Object Size Checking. | |
| The option also warns for calls that specify a size | |
| in excess of the largest possible object or at most @code{SIZE_MAX / 2} bytes. | |
| The option produces the best results with optimization enabled but can detect | |
| a small subset of simple buffer overflows even without optimization in | |
| calls to the GCC built-in functions like @code{__builtin_memcpy} that | |
| correspond to the standard functions. In any case, the option warns about | |
| just a subset of buffer overflows detected by the corresponding overflow | |
| checking built-ins, such as @code{__builtin___memcpy_chk}, which can perform | |
| run-time checking if the access cannot be identified as safe | |
| at compile time. | |
| For example, the option issues a warning for | |
| the @code{strcpy} call below because it copies at least 5 characters | |
| (the string @code{"blue"} including the terminating NUL) into the buffer | |
| of size 4. | |
| @smallexample | |
| enum Color @{ blue, purple, yellow @}; | |
| const char* f (enum Color clr) | |
| @{ | |
| static char buf [4]; | |
| const char *str; | |
| switch (clr) | |
| @{ | |
| case blue: str = "blue"; break; | |
| case purple: str = "purple"; break; | |
| case yellow: str = "yellow"; break; | |
| @} | |
| return strcpy (buf, str); // warning here | |
| @} | |
| @end smallexample | |
| The effect of this option is not limited to string or memory | |
| manipulation functions. In this example, a warning is diagnosed | |
| because a 1-element array is passed to a function requiring at least a | |
| 4-element array argument: | |
| @smallexample | |
| void f (int[static 4]); | |
| void g (void) | |
| @{ | |
| int *p = (int *) malloc (1 * sizeof(int)); | |
| f (p); // warning here | |
| @} | |
| @end smallexample | |
| Option @option{-Wstringop-overflow=2} is enabled by default. | |
| @table @gcctabopt | |
| @opindex Wstringop-overflow | |
| @opindex Wno-stringop-overflow | |
| @item -Wstringop-overflow | |
| @itemx -Wstringop-overflow=1 | |
| The @option{-Wstringop-overflow=1} option uses type-zero Object Size Checking | |
| to determine the sizes of destination objects. At this setting the option | |
| does not warn for writes past the end of subobjects of larger objects accessed | |
| by pointers unless the size of the largest surrounding object is known. When | |
| the destination may be one of several objects it is assumed to be the largest | |
| one of them. On Linux systems, when optimization is enabled at this setting | |
| the option warns for the same code as when the @code{_FORTIFY_SOURCE} macro | |
| is defined to a non-zero value. | |
| @item -Wstringop-overflow=2 | |
| The @option{-Wstringop-overflow=2} option uses type-one Object Size Checking | |
| to determine the sizes of destination objects. At this setting the option | |
| warns about overflows when writing to members of the largest complete | |
| objects whose exact size is known. However, it does not warn for excessive | |
| writes to the same members of unknown objects referenced by pointers since | |
| they may point to arrays containing unknown numbers of elements. This is | |
| the default setting of the option. | |
| @item -Wstringop-overflow=3 | |
| The @option{-Wstringop-overflow=3} option uses type-two Object Size Checking | |
| to determine the sizes of destination objects. At this setting the option | |
| warns about overflowing the smallest object or data member. This is the | |
| most restrictive setting of the option that may result in warnings for safe | |
| code. | |
| @item -Wstringop-overflow=4 | |
| The @option{-Wstringop-overflow=4} option uses type-three Object Size Checking | |
| to determine the sizes of destination objects. At this setting the option | |
| warns about overflowing any data members, and when the destination is | |
| one of several objects it uses the size of the largest of them to decide | |
| whether to issue a warning. Similarly to @option{-Wstringop-overflow=3} this | |
| setting of the option may result in warnings for benign code. | |
| @end table | |
| @opindex Wstringop-overread | |
| @opindex Wno-stringop-overread | |
| @item -Wno-stringop-overread | |
| Warn for calls to string manipulation functions such as @code{memchr}, or | |
| @code{strcpy} that are determined to read past the end of the source | |
| sequence. | |
| Option @option{-Wstringop-overread} is enabled by default. | |
| @opindex Wstringop-truncation | |
| @opindex Wno-stringop-truncation | |
| @item -Wno-stringop-truncation | |
| Do not warn for calls to bounded string manipulation functions | |
| such as @code{strncat}, | |
| @code{strncpy}, and @code{stpncpy} that may either truncate the copied string | |
| or leave the destination unchanged. | |
| In the following example, the call to @code{strncat} specifies a bound that | |
| is less than the length of the source string. As a result, the copy of | |
| the source will be truncated and so the call is diagnosed. To avoid the | |
| warning use @code{bufsize - strlen (buf) - 1)} as the bound. | |
| @smallexample | |
| void append (char *buf, size_t bufsize) | |
| @{ | |
| strncat (buf, ".txt", 3); | |
| @} | |
| @end smallexample | |
| As another example, the following call to @code{strncpy} results in copying | |
| to @code{d} just the characters preceding the terminating NUL, without | |
| appending the NUL to the end. Assuming the result of @code{strncpy} is | |
| necessarily a NUL-terminated string is a common mistake, and so the call | |
| is diagnosed. To avoid the warning when the result is not expected to be | |
| NUL-terminated, call @code{memcpy} instead. | |
| @smallexample | |
| void copy (char *d, const char *s) | |
| @{ | |
| strncpy (d, s, strlen (s)); | |
| @} | |
| @end smallexample | |
| In the following example, the call to @code{strncpy} specifies the size | |
| of the destination buffer as the bound. If the length of the source | |
| string is equal to or greater than this size the result of the copy will | |
| not be NUL-terminated. Therefore, the call is also diagnosed. To avoid | |
| the warning, specify @code{sizeof buf - 1} as the bound and set the last | |
| element of the buffer to @code{NUL}. | |
| @smallexample | |
| void copy (const char *s) | |
| @{ | |
| char buf[80]; | |
| strncpy (buf, s, sizeof buf); | |
| @dots{} | |
| @} | |
| @end smallexample | |
| In situations where a character array is intended to store a sequence | |
| of bytes with no terminating @code{NUL} such an array may be annotated | |
| with attribute @code{nonstring} to avoid this warning. Such arrays, | |
| however, are not suitable arguments to functions that expect | |
| @code{NUL}-terminated strings. To help detect accidental misuses of | |
| such arrays GCC issues warnings unless it can prove that the use is | |
| safe. @xref{Common Attributes}. | |
| @opindex Wstrict-flex-arrays | |
| @opindex Wno-strict-flex-arrays | |
| @item -Wstrict-flex-arrays @r{(C and C++ only)} | |
| Warn about improper usages of flexible array members | |
| according to the @var{level} of the @code{strict_flex_array (@var{level})} | |
| attribute attached to the trailing array field of a structure if it's | |
| available, otherwise according to the @var{level} of the option | |
| @option{-fstrict-flex-arrays=@var{level}}. @xref{Common Attributes}, | |
| for more information about the attribute, and @ref{C Dialect Options} for | |
| more information about the option. @code{-Wstrict-flex-arrays} | |
| is effective only when @var{level} is greater than 0. | |
| When @var{level}=1, warnings are issued for a trailing array reference | |
| of a structure that have 2 or more elements if the trailing array is referenced | |
| as a flexible array member. | |
| When @var{level}=2, in addition to @var{level}=1, additional warnings are | |
| issued for a trailing one-element array reference of a structure | |
| if the array is referenced as a flexible array member. | |
| When @var{level}=3, in addition to @var{level}=2, additional warnings are | |
| issued for a trailing zero-length array reference of a structure | |
| if the array is referenced as a flexible array member. | |
| This option is more effective when @option{-ftree-vrp} is active (the | |
| default for @option{-O2} and above) but some warnings may be diagnosed | |
| even without optimization. | |
| @opindex Wsuggest-attribute= | |
| @opindex Wno-suggest-attribute= | |
| @item -Wsuggest-attribute=@var{attribute-name} | |
| Warn for cases where adding an attribute may be beneficial. The | |
| @var{attribute-name}s currently supported are listed below. | |
| @table @gcctabopt | |
| @opindex Wsuggest-attribute=pure | |
| @opindex Wno-suggest-attribute=pure | |
| @opindex Wsuggest-attribute=const | |
| @opindex Wno-suggest-attribute=const | |
| @opindex Wsuggest-attribute=noreturn | |
| @opindex Wno-suggest-attribute=noreturn | |
| @opindex Wmissing-noreturn | |
| @opindex Wno-missing-noreturn | |
| @opindex Wsuggest-attribute=malloc | |
| @opindex Wno-suggest-attribute=malloc | |
| @opindex Wsuggest-attribute=returns_nonnull | |
| @opindex Wno-suggest-attribute=returns_nonnull | |
| @item -Wsuggest-attribute=pure | |
| @itemx -Wsuggest-attribute=const | |
| @itemx -Wsuggest-attribute=noreturn | |
| @itemx -Wmissing-noreturn | |
| @itemx -Wsuggest-attribute=malloc | |
| @itemx -Wsuggest-attribute=returns_nonnull | |
| Warn about functions that might be candidates for attributes | |
| @code{pure}, @code{const}, @code{noreturn}, @code{malloc} or | |
| @code{returns_nonnull}. The compiler | |
| only warns for functions visible in other compilation units or (in the case of | |
| @code{pure} and @code{const}) if it cannot prove that the function returns | |
| normally. A function returns normally if it doesn't contain an infinite loop or | |
| return abnormally by throwing, calling @code{abort} or trapping. This analysis | |
| requires option @option{-fipa-pure-const}, which is enabled by default at | |
| @option{-O} and higher. Higher optimization levels improve the accuracy | |
| of the analysis. | |
| @opindex Wsuggest-attribute=format | |
| @opindex Wmissing-format-attribute | |
| @opindex Wno-suggest-attribute=format | |
| @opindex Wno-missing-format-attribute | |
| @opindex Wformat | |
| @opindex Wno-format | |
| @item -Wsuggest-attribute=format | |
| @itemx -Wmissing-format-attribute | |
| Warn about function pointers that might be candidates for @code{format} | |
| attributes. Note these are only possible candidates, not absolute ones. | |
| GCC guesses that function pointers with @code{format} attributes that | |
| are used in assignment, initialization, parameter passing or return | |
| statements should have a corresponding @code{format} attribute in the | |
| resulting type. I.e.@: the left-hand side of the assignment or | |
| initialization, the type of the parameter variable, or the return type | |
| of the containing function respectively should also have a @code{format} | |
| attribute to avoid the warning. | |
| GCC also warns about function definitions that might be | |
| candidates for @code{format} attributes. Again, these are only | |
| possible candidates. GCC guesses that @code{format} attributes | |
| might be appropriate for any function that calls a function like | |
| @code{vprintf} or @code{vscanf}, but this might not always be the | |
| case, and some functions for which @code{format} attributes are | |
| appropriate may not be detected. | |
| @opindex Wsuggest-attribute=cold | |
| @opindex Wno-suggest-attribute=cold | |
| @item -Wsuggest-attribute=cold | |
| Warn about functions that might be candidates for @code{cold} attribute. This | |
| is based on static detection and generally only warns about functions which | |
| always leads to a call to another @code{cold} function such as wrappers of | |
| C++ @code{throw} or fatal error reporting functions leading to @code{abort}. | |
| @end table | |
| @opindex Wno-alloc-size | |
| @opindex Walloc-size | |
| @item -Walloc-size | |
| Warn about calls to allocation functions decorated with attribute | |
| @code{alloc_size} that specify insufficient size for the target type of | |
| the pointer the result is assigned to, including those to the built-in | |
| forms of the functions @code{aligned_alloc}, @code{alloca}, | |
| @code{calloc}, @code{malloc}, and @code{realloc}. | |
| @opindex Wno-alloc-zero | |
| @opindex Walloc-zero | |
| @item -Walloc-zero | |
| Warn about calls to allocation functions decorated with attribute | |
| @code{alloc_size} that specify zero bytes, including those to the built-in | |
| forms of the functions @code{aligned_alloc}, @code{alloca}, @code{calloc}, | |
| @code{malloc}, and @code{realloc}. Because the behavior of these functions | |
| when called with a zero size differs among implementations (and in the case | |
| of @code{realloc} has been deprecated) relying on it may result in subtle | |
| portability bugs and should be avoided. | |
| @opindex Wcalloc-transposed-args | |
| @opindex Wno-calloc-transposed-args | |
| @item -Wcalloc-transposed-args | |
| Warn about calls to allocation functions decorated with attribute | |
| @code{alloc_size} with two arguments, which use @code{sizeof} operator | |
| as the earlier size argument and don't use it as the later size argument. | |
| This is a coding style warning. The first argument to @code{calloc} is | |
| documented to be number of elements in array, while the second argument | |
| is size of each element, so @code{calloc (@var{n}, sizeof (int))} is preferred | |
| over @code{calloc (sizeof (int), @var{n})}. If @code{sizeof} in the earlier | |
| argument and not the latter is intentional, the warning can be suppressed | |
| by using @code{calloc (sizeof (struct @var{S}) + 0, n)} or | |
| @code{calloc (1 * sizeof (struct @var{S}), 4)} or using @code{sizeof} in the | |
| later argument as well. | |
| @opindex Walloc-size-larger-than= | |
| @opindex Wno-alloc-size-larger-than | |
| @item -Walloc-size-larger-than=@var{byte-size} | |
| Warn about calls to functions decorated with attribute @code{alloc_size} | |
| that attempt to allocate objects larger than the specified number of bytes, | |
| or where the result of the size computation in an integer type with infinite | |
| precision would exceed the value of @samp{PTRDIFF_MAX} on the target. | |
| @option{-Walloc-size-larger-than=}@samp{PTRDIFF_MAX} is enabled by default. | |
| Warnings controlled by the option can be disabled either by specifying | |
| @var{byte-size} of @samp{SIZE_MAX} or more or by | |
| @option{-Wno-alloc-size-larger-than}. | |
| @xref{Common Attributes}. | |
| @opindex Wno-alloc-size-larger-than | |
| @item -Wno-alloc-size-larger-than | |
| Disable @option{-Walloc-size-larger-than=} warnings. The option is | |
| equivalent to @option{-Walloc-size-larger-than=}@samp{SIZE_MAX} or | |
| larger. | |
| @opindex Wno-alloca | |
| @opindex Walloca | |
| @item -Walloca | |
| Warn on all uses of @code{alloca} in the source. | |
| @opindex Wno-auto-profile | |
| @opindex Wauto-profile | |
| @item -Wauto-profile | |
| Output warnings about auto-profile inconsistencies. | |
| @opindex Wcannot-profile | |
| @opindex Wno-cannot-profile | |
| @item -Wcannot-profile | |
| Warn when profiling instrumentation was requested, but could not be applied to | |
| a certain function. | |
| @opindex Walloca-larger-than= | |
| @opindex Wno-alloca-larger-than | |
| @item -Walloca-larger-than=@var{byte-size} | |
| Warns on calls to @code{alloca} with an integer argument whose | |
| value is either zero, or that is not bounded by a controlling predicate | |
| that limits its value to at most @var{byte-size}. It also warns for calls | |
| to @code{alloca} where the bound value is unknown. Arguments of non-integer | |
| types are considered unbounded even if they appear to be constrained to | |
| the expected range. | |
| For example, a bounded case of @code{alloca} could be: | |
| @smallexample | |
| void func (size_t n) | |
| @{ | |
| void *p; | |
| if (n <= 1000) | |
| p = alloca (n); | |
| else | |
| p = malloc (n); | |
| f (p); | |
| @} | |
| @end smallexample | |
| In the above example, passing @code{-Walloca-larger-than=1000} would not | |
| issue a warning because the call to @code{alloca} is known to be at most | |
| 1000 bytes. However, if @code{-Walloca-larger-than=500} were passed, | |
| the compiler would emit a warning. | |
| Unbounded uses, on the other hand, are uses of @code{alloca} with no | |
| controlling predicate constraining its integer argument. For example: | |
| @smallexample | |
| void func () | |
| @{ | |
| void *p = alloca (n); | |
| f (p); | |
| @} | |
| @end smallexample | |
| If @code{-Walloca-larger-than=500} were passed, the above would trigger | |
| a warning, but this time because of the lack of bounds checking. | |
| Note, that even seemingly correct code involving signed integers could | |
| cause a warning: | |
| @smallexample | |
| void func (signed int n) | |
| @{ | |
| if (n < 500) | |
| @{ | |
| p = alloca (n); | |
| f (p); | |
| @} | |
| @} | |
| @end smallexample | |
| In the above example, @var{n} could be negative, causing a larger than | |
| expected argument to be implicitly cast into the @code{alloca} call. | |
| This option also warns when @code{alloca} is used in a loop. | |
| @option{-Walloca-larger-than=}@samp{PTRDIFF_MAX} is enabled by default | |
| but is usually only effective when @option{-ftree-vrp} is active (default | |
| for @option{-O2} and above). | |
| See also @option{-Wvla-larger-than=}@samp{byte-size}. | |
| @opindex Wno-alloca-larger-than | |
| @item -Wno-alloca-larger-than | |
| Disable @option{-Walloca-larger-than=} warnings. The option is | |
| equivalent to @option{-Walloca-larger-than=}@samp{SIZE_MAX} or larger. | |
| @opindex Warith-conversion | |
| @opindex Wno-arith-conversion | |
| @item -Warith-conversion | |
| Do warn about implicit conversions from arithmetic operations even | |
| when conversion of the operands to the same type cannot change their | |
| values. This affects warnings from @option{-Wconversion}, | |
| @option{-Wfloat-conversion}, and @option{-Wsign-conversion}. | |
| @smallexample | |
| @group | |
| void f (char c, int i) | |
| @{ | |
| c = c + i; // warns with @option{-Wconversion} | |
| c = c + 1; // only warns with @option{-Warith-conversion} | |
| @} | |
| @end group | |
| @end smallexample | |
| @opindex Wno-array-bounds | |
| @opindex Warray-bounds | |
| @item -Warray-bounds | |
| @itemx -Warray-bounds=@var{n} | |
| Warn about out of bounds subscripts or offsets into arrays. This warning | |
| is enabled by @option{-Wall}. It is more effective when @option{-ftree-vrp} | |
| is active (the default for @option{-O2} and above) but a subset of instances | |
| are issued even without optimization. | |
| By default, the trailing array of a structure will be treated as a flexible | |
| array member by @option{-Warray-bounds} or @option{-Warray-bounds=@var{n}} | |
| if it is declared as either a flexible array member per C99 standard onwards | |
| (@samp{[]}), a GCC zero-length array extension (@samp{[0]}), or an one-element | |
| array (@samp{[1]}). As a result, out of bounds subscripts or offsets into | |
| zero-length arrays or one-element arrays are not warned by default. | |
| You can add the option @option{-fstrict-flex-arrays} or | |
| @option{-fstrict-flex-arrays=@var{level}} to control how this | |
| option treat trailing array of a structure as a flexible array member: | |
| when @var{level}<=1, no change to the default behavior. | |
| when @var{level}=2, additional warnings will be issued for out of bounds | |
| subscripts or offsets into one-element arrays; | |
| when @var{level}=3, in addition to @var{level}=2, additional warnings will be | |
| issued for out of bounds subscripts or offsets into zero-length arrays. | |
| @table @gcctabopt | |
| @item -Warray-bounds=1 | |
| This is the default warning level of @option{-Warray-bounds} and is enabled | |
| by @option{-Wall}; higher levels are not, and must be explicitly requested. | |
| @item -Warray-bounds=2 | |
| This warning level also warns about the intermediate results of pointer | |
| arithmetic that may yield out of bounds values. This warning level may | |
| give a larger number of false positives and is deactivated by default. | |
| @end table | |
| @opindex Wunterminated-string-initialization | |
| @opindex Wno-unterminated-string-initialization | |
| @item -Wunterminated-string-initialization @r{(C and Objective-C only)} | |
| Warn about character arrays initialized as unterminated character sequences | |
| with a string literal, unless the declaration being initialized has | |
| the @code{nonstring} attribute. | |
| For example: | |
| @smallexample | |
| char arr[3] = "foo"; /* Warning. */ | |
| char arr2[3] __attribute__((nonstring)) = "bar"; /* No warning. */ | |
| @end smallexample | |
| This warning is enabled by @option{-Wextra}. If @option{-Wc++-compat} | |
| is enabled, the warning has slightly different wording and warns even | |
| if the declaration being initialized has the @code{nonstring} warning, | |
| as in C++ such initializations are an error. | |
| @opindex Warray-compare | |
| @opindex Wno-array-compare | |
| @item -Warray-compare | |
| Warn about equality and relational comparisons between two operands of array | |
| type. This comparison was deprecated in C++20. For example: | |
| @smallexample | |
| int arr1[5]; | |
| int arr2[5]; | |
| bool same = arr1 == arr2; | |
| @end smallexample | |
| @option{-Warray-compare} is enabled by @option{-Wall}. | |
| @opindex Wno-array-parameter | |
| @opindex Warray-parameter | |
| @item -Warray-parameter | |
| @itemx -Warray-parameter=@var{n} | |
| Warn about redeclarations of functions involving parameters of array or | |
| pointer types of inconsistent kinds or forms, and enable the detection | |
| of out-of-bounds accesses to such parameters by warnings such as | |
| @option{-Warray-bounds}. | |
| If the first function declaration uses the array form for a parameter | |
| declaration, the bound specified | |
| in the array is assumed to be the minimum number of elements expected to | |
| be provided in calls to the function and the maximum number of elements | |
| accessed by it. Failing to provide arguments of sufficient size or accessing | |
| more than the maximum number of elements may be diagnosed by warnings such | |
| as @option{-Warray-bounds} or @option{-Wstringop-overflow}. | |
| At level 1, the warning diagnoses inconsistencies | |
| involving array parameters declared using the @code{T[static N]} form. | |
| For example, the warning triggers for the second declaration of @code{f} | |
| because the first one with the keyword @code{static} specifies that | |
| the array argument must have at least four elements, while the second | |
| allows an array of any size to be passed to @code{f}. | |
| @smallexample | |
| void f (int[static 4]); | |
| void f (int[]); // warning (inconsistent array form) | |
| void g (void) | |
| @{ | |
| int *p = (int *)malloc (1 * sizeof (int)); | |
| f (p); // warning (array too small) | |
| @dots{} | |
| @} | |
| @end smallexample | |
| At level 2 the warning also triggers for redeclarations involving any other | |
| inconsistency in array or pointer argument forms denoting array sizes. | |
| Pointers and arrays of unspecified bound are considered equivalent and do | |
| not trigger a warning. | |
| @smallexample | |
| void g (int*); | |
| void g (int[]); // no warning | |
| void g (int[8]); // warning (inconsistent array bound) | |
| @end smallexample | |
| @option{-Warray-parameter=2} is included in @option{-Wall}. The | |
| @option{-Wvla-parameter} option triggers warnings for similar inconsistencies | |
| involving Variable Length Array arguments. | |
| The short form of the option @option{-Warray-parameter} is equivalent to | |
| @option{-Warray-parameter=2}. The negative form @option{-Wno-array-parameter} | |
| is equivalent to @option{-Warray-parameter=0}. | |
| @opindex Wattribute-alias | |
| @opindex Wno-attribute-alias | |
| @item -Wattribute-alias=@var{n} | |
| @itemx -Wno-attribute-alias | |
| Warn about declarations using the @code{alias} and similar attributes whose | |
| target is incompatible with the type of the alias. | |
| @xref{Common Attributes}. | |
| @table @gcctabopt | |
| @item -Wattribute-alias=1 | |
| The default warning level of the @option{-Wattribute-alias} option diagnoses | |
| incompatibilities between the type of the alias declaration and that of its | |
| target. Such incompatibilities are typically indicative of bugs. | |
| @item -Wattribute-alias=2 | |
| At this level @option{-Wattribute-alias} also diagnoses cases where | |
| the attributes of the alias declaration are more restrictive than the | |
| attributes applied to its target. These mismatches can potentially | |
| result in incorrect code generation. In other cases they may be | |
| benign and could be resolved simply by adding the missing attribute to | |
| the target. For comparison, see the @option{-Wmissing-attributes} | |
| option, which controls diagnostics when the alias declaration is less | |
| restrictive than the target, rather than more restrictive. | |
| Attributes considered include @code{alloc_align}, @code{alloc_size}, | |
| @code{cold}, @code{const}, @code{hot}, @code{leaf}, @code{malloc}, | |
| @code{nonnull}, @code{noreturn}, @code{nothrow}, @code{pure}, | |
| @code{returns_nonnull}, and @code{returns_twice}. | |
| @end table | |
| @option{-Wattribute-alias} is equivalent to @option{-Wattribute-alias=1}. | |
| This is the default. You can disable these warnings with either | |
| @option{-Wno-attribute-alias} or @option{-Wattribute-alias=0}. | |
| @opindex Wbidi-chars= | |
| @opindex Wbidi-chars | |
| @opindex Wno-bidi-chars | |
| @item -Wbidi-chars=@r{[}none@r{|}unpaired@r{|}any@r{|}ucn@r{]} | |
| Warn about possibly misleading UTF-8 bidirectional control characters in | |
| comments, string literals, character constants, and identifiers. Such | |
| characters can change left-to-right writing direction into right-to-left | |
| (and vice versa), which can cause confusion between the logical order and | |
| visual order. This may be dangerous; for instance, it may seem that a piece | |
| of code is not commented out, whereas it in fact is. | |
| There are three levels of warning supported by GCC@. The default is | |
| @option{-Wbidi-chars=unpaired}, which warns about improperly terminated | |
| bidi contexts. @option{-Wbidi-chars=none} turns the warning off. | |
| @option{-Wbidi-chars=any} warns about any use of bidirectional control | |
| characters. | |
| By default, this warning does not warn about UCNs. It is, however, possible | |
| to turn on such checking by using @option{-Wbidi-chars=unpaired,ucn} or | |
| @option{-Wbidi-chars=any,ucn}. Using @option{-Wbidi-chars=ucn} is valid, | |
| and is equivalent to @option{-Wbidi-chars=unpaired,ucn}, if no previous | |
| @option{-Wbidi-chars=any} was specified. | |
| @opindex Wno-bool-compare | |
| @opindex Wbool-compare | |
| @item -Wbool-compare | |
| Warn about boolean expression compared with an integer value different from | |
| @code{true}/@code{false}. For instance, the following comparison is | |
| always false: | |
| @smallexample | |
| int n = 5; | |
| @dots{} | |
| if ((n > 1) == 2) @{ @dots{} @} | |
| @end smallexample | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wno-bool-operation | |
| @opindex Wbool-operation | |
| @item -Wbool-operation | |
| Warn about suspicious operations on expressions of a boolean type. For | |
| instance, bitwise negation of a boolean is very likely a bug in the program. | |
| For C, this warning also warns about incrementing or decrementing a boolean, | |
| which rarely makes sense. (In C++, decrementing a boolean is always invalid. | |
| Incrementing a boolean is invalid in C++17, and deprecated otherwise.) | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wno-duplicated-branches | |
| @opindex Wduplicated-branches | |
| @item -Wduplicated-branches | |
| Warn when an if-else has identical branches. This warning detects cases like | |
| @smallexample | |
| if (p != NULL) | |
| return 0; | |
| else | |
| return 0; | |
| @end smallexample | |
| It doesn't warn when both branches contain just a null statement. This warning | |
| also warn for conditional operators: | |
| @smallexample | |
| int i = x ? *p : *p; | |
| @end smallexample | |
| @opindex Wno-duplicated-cond | |
| @opindex Wduplicated-cond | |
| @item -Wduplicated-cond | |
| Warn about duplicated conditions in an if-else-if chain. For instance, | |
| warn for the following code: | |
| @smallexample | |
| if (p->q != NULL) @{ @dots{} @} | |
| else if (p->q != NULL) @{ @dots{} @} | |
| @end smallexample | |
| @opindex Wno-frame-address | |
| @opindex Wframe-address | |
| @item -Wframe-address | |
| Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address} | |
| is called with an argument greater than 0. Such calls may return indeterminate | |
| values or crash the program. The warning is included in @option{-Wall}. | |
| @opindex Wno-discarded-qualifiers | |
| @opindex Wdiscarded-qualifiers | |
| @item -Wno-discarded-qualifiers @r{(C and Objective-C only)} | |
| Do not warn if type qualifiers on pointers are being discarded. | |
| Typically, the compiler warns if a @code{const char *} variable is | |
| passed to a function that takes a @code{char *} parameter. This option | |
| can be used to suppress such a warning. | |
| @opindex Wno-discarded-array-qualifiers | |
| @opindex Wdiscarded-array-qualifiers | |
| @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)} | |
| Do not warn if type qualifiers on arrays which are pointer targets | |
| are being discarded. Typically, the compiler warns if a | |
| @code{const int (*)[]} variable is passed to a function that | |
| takes a @code{int (*)[]} parameter. This option can be used to | |
| suppress such a warning. | |
| @opindex Wno-incompatible-pointer-types | |
| @opindex Wincompatible-pointer-types | |
| @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)} | |
| Do not warn when there is a conversion between pointers that have incompatible | |
| types. This warning is for cases not covered by @option{-Wno-pointer-sign}, | |
| which warns for pointer argument passing or assignment with different | |
| signedness. | |
| By default, in C99 and later dialects of C, GCC treats this issue as an | |
| error. The error can be downgraded to a warning using | |
| @option{-fpermissive} (along with certain other errors), or for this | |
| error alone, with @option{-Wno-error=incompatible-pointer-types}. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wno-int-conversion | |
| @opindex Wint-conversion | |
| @item -Wno-int-conversion @r{(C and Objective-C only)} | |
| Do not warn about incompatible integer to pointer and pointer to integer | |
| conversions. This warning is about implicit conversions; for explicit | |
| conversions the warnings @option{-Wno-int-to-pointer-cast} and | |
| @option{-Wno-pointer-to-int-cast} may be used. | |
| By default, in C99 and later dialects of C, GCC treats this issue as an | |
| error. The error can be downgraded to a warning using | |
| @option{-fpermissive} (along with certain other errors), or for this | |
| error alone, with @option{-Wno-error=int-conversion}. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wzero-as-null-pointer-constant | |
| @opindex Wno-zero-as-null-pointer-constant | |
| @item -Wzero-as-null-pointer-constant | |
| Warn when a literal @samp{0} is used as null pointer constant. | |
| @opindex Wzero-length-bounds | |
| @opindex Wno-zero-length-bounds | |
| @item -Wzero-length-bounds | |
| Warn about accesses to elements of zero-length array members that might | |
| overlap other members of the same object. Declaring interior zero-length | |
| arrays is discouraged because accesses to them are undefined. | |
| @xref{Zero Length}. | |
| For example, the first two stores in function @code{bad} are diagnosed | |
| because the array elements overlap the subsequent members @code{b} and | |
| @code{c}. The third store is diagnosed by @option{-Warray-bounds} | |
| because it is beyond the bounds of the enclosing object. | |
| @smallexample | |
| struct X @{ int a[0]; int b, c; @}; | |
| struct X x; | |
| void bad (void) | |
| @{ | |
| x.a[0] = 0; // -Wzero-length-bounds | |
| x.a[1] = 1; // -Wzero-length-bounds | |
| x.a[2] = 2; // -Warray-bounds | |
| @} | |
| @end smallexample | |
| Option @option{-Wzero-length-bounds} is enabled by @option{-Warray-bounds}. | |
| @opindex Wno-div-by-zero | |
| @opindex Wdiv-by-zero | |
| @item -Wno-div-by-zero | |
| Do not warn about compile-time integer division by zero. Floating-point | |
| division by zero is not warned about, as it can be a legitimate way of | |
| obtaining infinities and NaNs. | |
| @opindex Wsystem-headers | |
| @opindex Wno-system-headers | |
| @cindex warnings from system headers | |
| @cindex system headers, warnings from | |
| @item -Wsystem-headers | |
| Print warning messages for constructs found in system header files. | |
| Warnings from system headers are normally suppressed, on the assumption | |
| that they usually do not indicate real problems and would only make the | |
| compiler output harder to read. Using this command-line option tells | |
| GCC to emit warnings from system headers as if they occurred in user | |
| code. However, note that using @option{-Wall} in conjunction with this | |
| option does @emph{not} warn about unknown pragmas in system | |
| headers---for that, @option{-Wunknown-pragmas} must also be used. | |
| @opindex Wtautological-compare | |
| @opindex Wno-tautological-compare | |
| @item -Wtautological-compare | |
| Warn if a self-comparison always evaluates to true or false. This | |
| warning detects various mistakes such as: | |
| @smallexample | |
| int i = 1; | |
| @dots{} | |
| if (i > i) @{ @dots{} @} | |
| @end smallexample | |
| This warning also warns about bitwise comparisons that always evaluate | |
| to true or false, for instance: | |
| @smallexample | |
| if ((a & 16) == 10) @{ @dots{} @} | |
| @end smallexample | |
| will always be false. | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wtrailing-whitespace | |
| @opindex Wno-trailing-whitespace | |
| @opindex Wtrailing-whitespace= | |
| @item -Wtrailing-whitespace | |
| @itemx -Wtrailing-whitespace=@var{kind} | |
| Warn about trailing whitespace at the end of lines, including inside of | |
| comments, but excluding trailing whitespace in raw string literals. | |
| @code{-Wtrailing-whitespace} is equivalent to | |
| @code{-Wtrailing-whitespace=blanks} and warns just about trailing space and | |
| horizontal tab characters. @code{-Wtrailing-whitespace=any} warns about | |
| those or trailing form feed or vertical tab characters. | |
| @code{-Wno-trailing-whitespace} or @code{-Wtrailing-whitespace=none} | |
| disables the warning, which is the default. | |
| This is a coding style warning. | |
| @opindex Wleading-whitespace= | |
| @item -Wleading-whitespace=@var{kind} | |
| Warn about style issues in leading whitespace, but not about the amount of | |
| indentation. Some projects use coding styles where only spaces are used | |
| for indentation, others use only tabs, others use zero or more tabs (for | |
| multiples of @code{-ftabstop=@var{n}}) followed by zero or fewer than @var{n} | |
| spaces. No warning is emitted on lines which contain solely whitespace | |
| (although @code{-Wtrailing-whitespace=} warning might be emitted), no | |
| warnings are emitted inside of raw string literals. Warnings are also emitted | |
| for leading whitespace inside of multi-line comments. | |
| @code{-Wleading-whitespace=spaces} warns about leading whitespace other than | |
| spaces for projects which want to indent just by spaces. | |
| @code{-Wleading-whitespace=tabs} warns about leading whitespace other than | |
| horizontal tabs for projects which want to indent just by horizontal tabs. | |
| @code{-Wleading-whitespace=blanks} warns about leading whitespace other than | |
| spaces and horizontal tabs, or about horizontal tab after a space in the | |
| leading whitespace, or about @var{n} or more consecutive spaces in leading | |
| whitespace (where @var{n} is argument of @code{-ftabstop=@var{n}}, 8 by | |
| default). | |
| @code{-Wleading-whitespace=none} disables the warning, which is the default. | |
| This is a coding style warning. | |
| @opindex Wtrampolines | |
| @opindex Wno-trampolines | |
| @item -Wtrampolines | |
| Warn about trampolines generated for pointers to nested functions. | |
| A trampoline is a small piece of data or code that is created at run | |
| time on the stack when the address of a nested function is taken, and is | |
| used to call the nested function indirectly. For some targets, it is | |
| made up of data only and thus requires no special treatment. But, for | |
| most targets, it is made up of code and thus requires the stack to be | |
| made executable in order for the program to work properly. | |
| @opindex Wfloat-equal | |
| @opindex Wno-float-equal | |
| @item -Wfloat-equal | |
| Warn if floating-point values are used in equality comparisons. | |
| The idea behind this is that sometimes it is convenient (for the | |
| programmer) to consider floating-point values as approximations to | |
| infinitely precise real numbers. If you are doing this, then you need | |
| to compute (by analyzing the code, or in some other way) the maximum or | |
| likely maximum error that the computation introduces, and allow for it | |
| when performing comparisons (and when producing output, but that's a | |
| different problem). In particular, instead of testing for equality, you | |
| should check to see whether the two values have ranges that overlap; and | |
| this is done with the relational operators, so equality comparisons are | |
| probably mistaken. | |
| @opindex Wtraditional | |
| @opindex Wno-traditional | |
| @item -Wtraditional @r{(C and Objective-C only)} | |
| Warn about certain constructs that behave differently in traditional and | |
| ISO C@. Also warn about ISO C constructs that have no traditional C | |
| equivalent, and/or problematic constructs that should be avoided. | |
| @itemize @bullet | |
| @item | |
| Macro parameters that appear within string literals in the macro body. | |
| In traditional C macro replacement takes place within string literals, | |
| but in ISO C it does not. | |
| @item | |
| In traditional C, some preprocessor directives did not exist. | |
| Traditional preprocessors only considered a line to be a directive | |
| if the @samp{#} appeared in column 1 on the line. Therefore | |
| @option{-Wtraditional} warns about directives that traditional C | |
| understands but ignores because the @samp{#} does not appear as the | |
| first character on the line. It also suggests you hide directives like | |
| @code{#pragma} not understood by traditional C by indenting them. Some | |
| traditional implementations do not recognize @code{#elif}, so this option | |
| suggests avoiding it altogether. | |
| @item | |
| A function-like macro that appears without arguments. | |
| @item | |
| The unary plus operator. | |
| @item | |
| The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point | |
| constant suffixes. (Traditional C does support the @samp{L} suffix on integer | |
| constants.) Note, these suffixes appear in macros defined in the system | |
| headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}. | |
| Use of these macros in user code might normally lead to spurious | |
| warnings, however GCC's integrated preprocessor has enough context to | |
| avoid warning in these cases. | |
| @item | |
| A function declared external in one block and then used after the end of | |
| the block. | |
| @item | |
| A @code{switch} statement has an operand of type @code{long}. | |
| @item | |
| A non-@code{static} function declaration follows a @code{static} one. | |
| This construct is not accepted by some traditional C compilers. | |
| @item | |
| The ISO type of an integer constant has a different width or | |
| signedness from its traditional type. This warning is only issued if | |
| the base of the constant is ten. I.e.@: hexadecimal or octal values, which | |
| typically represent bit patterns, are not warned about. | |
| @item | |
| Usage of ISO string concatenation is detected. | |
| @item | |
| Initialization of automatic aggregates. | |
| @item | |
| Identifier conflicts with labels. Traditional C lacks a separate | |
| namespace for labels. | |
| @item | |
| Initialization of unions. If the initializer is zero, the warning is | |
| omitted. This is done under the assumption that the zero initializer in | |
| user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing | |
| initializer warnings and relies on default initialization to zero in the | |
| traditional C case. | |
| @item | |
| Conversions by prototypes between fixed/floating-point values and vice | |
| versa. The absence of these prototypes when compiling with traditional | |
| C causes serious problems. This is a subset of the possible | |
| conversion warnings; for the full set use @option{-Wtraditional-conversion}. | |
| @item | |
| Use of ISO C style function definitions. This warning intentionally is | |
| @emph{not} issued for prototype declarations or variadic functions | |
| because these ISO C features appear in your code when using | |
| libiberty's traditional C compatibility macros, @code{PARAMS} and | |
| @code{VPARAMS}. This warning is also bypassed for nested functions | |
| because that feature is already a GCC extension and thus not relevant to | |
| traditional C compatibility. | |
| @end itemize | |
| @opindex Wtraditional-conversion | |
| @opindex Wno-traditional-conversion | |
| @item -Wtraditional-conversion @r{(C and Objective-C only)} | |
| Warn if a prototype causes a type conversion that is different from what | |
| would happen to the same argument in the absence of a prototype. This | |
| includes conversions of fixed point to floating and vice versa, and | |
| conversions changing the width or signedness of a fixed-point argument | |
| except when the same as the default promotion. | |
| @opindex Wdeclaration-after-statement | |
| @opindex Wno-declaration-after-statement | |
| @item -Wdeclaration-after-statement @r{(C and Objective-C only)} | |
| Warn when a declaration is found after a statement in a block. This | |
| construct, known from C++, was introduced with ISO C99 and is by default | |
| allowed in GCC@. It is not supported by ISO C90. @xref{Mixed Labels and Declarations}. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wshadow | |
| @opindex Wno-shadow | |
| @item -Wshadow | |
| Warn whenever a local variable or type declaration shadows another | |
| variable, parameter, type, class member (in C++), or instance variable | |
| (in Objective-C) or whenever a built-in function is shadowed. Note | |
| that in C++, the compiler warns if a local variable shadows an | |
| explicit typedef, but not if it shadows a struct/class/enum. | |
| If this warning is enabled, it includes also all instances of | |
| local shadowing. This means that @option{-Wno-shadow=local} | |
| and @option{-Wno-shadow=compatible-local} are ignored when | |
| @option{-Wshadow} is used. | |
| Same as @option{-Wshadow=global}. | |
| @opindex Wno-shadow-ivar | |
| @opindex Wshadow-ivar | |
| @item -Wno-shadow-ivar @r{(Objective-C only)} | |
| Do not warn whenever a local variable shadows an instance variable in an | |
| Objective-C method. | |
| @opindex Wshadow=global | |
| @opindex Wno-shadow=global | |
| @item -Wshadow=global | |
| Warn for any shadowing. | |
| Same as @option{-Wshadow}. | |
| @opindex Wshadow=local | |
| @opindex Wno-shadow=local | |
| @item -Wshadow=local | |
| Warn when a local variable shadows another local variable or parameter. | |
| @opindex Wshadow=compatible-local | |
| @opindex Wno-shadow=compatible-local | |
| @item -Wshadow=compatible-local | |
| Warn when a local variable shadows another local variable or parameter | |
| whose type is compatible with that of the shadowing variable. In C++, | |
| type compatibility here means the type of the shadowing variable can be | |
| converted to that of the shadowed variable. The creation of this flag | |
| (in addition to @option{-Wshadow=local}) is based on the idea that when | |
| a local variable shadows another one of incompatible type, it is most | |
| likely intentional, not a bug or typo, as shown in the following example: | |
| @smallexample | |
| @group | |
| for (SomeIterator i = SomeObj.begin(); i != SomeObj.end(); ++i) | |
| @{ | |
| for (int i = 0; i < N; ++i) | |
| @{ | |
| ... | |
| @} | |
| ... | |
| @} | |
| @end group | |
| @end smallexample | |
| Since the two variable @code{i} in the example above have incompatible types, | |
| enabling only @option{-Wshadow=compatible-local} does not emit a warning. | |
| Because their types are incompatible, if a programmer accidentally uses one | |
| in place of the other, type checking is expected to catch that and emit an | |
| error or warning. Use of this flag instead of @option{-Wshadow=local} can | |
| possibly reduce the number of warnings triggered by intentional shadowing. | |
| Note that this also means that shadowing @code{const char *i} by | |
| @code{char *i} does not emit a warning. | |
| This warning is also enabled by @option{-Wshadow=local}. | |
| @opindex Wlarger-than= | |
| @opindex Wlarger-than-@var{byte-size} | |
| @item -Wlarger-than=@var{byte-size} | |
| Warn whenever an object is defined whose size exceeds @var{byte-size}. | |
| @option{-Wlarger-than=}@samp{PTRDIFF_MAX} is enabled by default. | |
| Warnings controlled by the option can be disabled either by specifying | |
| @var{byte-size} of @samp{SIZE_MAX} or more or by @option{-Wno-larger-than}. | |
| Also warn for calls to bounded functions such as @code{memchr} or | |
| @code{strnlen} that specify a bound greater than the largest possible | |
| object, which is @samp{PTRDIFF_MAX} bytes by default. These warnings | |
| can only be disabled by @option{-Wno-larger-than}. | |
| @opindex Wno-larger-than | |
| @item -Wno-larger-than | |
| Disable @option{-Wlarger-than=} warnings. The option is equivalent | |
| to @option{-Wlarger-than=}@samp{SIZE_MAX} or larger. | |
| @opindex Wframe-larger-than= | |
| @opindex Wno-frame-larger-than | |
| @item -Wframe-larger-than=@var{byte-size} | |
| Warn if the size of a function frame exceeds @var{byte-size}. | |
| The computation done to determine the stack frame size is approximate | |
| and not conservative. | |
| The actual requirements may be somewhat greater than @var{byte-size} | |
| even if you do not get a warning. In addition, any space allocated | |
| via @code{alloca}, variable-length arrays, or related constructs | |
| is not included by the compiler when determining | |
| whether or not to issue a warning. | |
| @option{-Wframe-larger-than=}@samp{PTRDIFF_MAX} is enabled by default. | |
| Warnings controlled by the option can be disabled either by specifying | |
| @var{byte-size} of @samp{SIZE_MAX} or more or by | |
| @option{-Wno-frame-larger-than}. | |
| @opindex Wno-frame-larger-than | |
| @item -Wno-frame-larger-than | |
| Disable @option{-Wframe-larger-than=} warnings. The option is equivalent | |
| to @option{-Wframe-larger-than=}@samp{SIZE_MAX} or larger. | |
| @opindex Wfree-nonheap-object | |
| @opindex Wno-free-nonheap-object | |
| @item -Wfree-nonheap-object | |
| Warn when attempting to deallocate an object that was either not allocated | |
| on the heap, or by using a pointer that was not returned from a prior call | |
| to the corresponding allocation function. For example, because the call | |
| to @code{stpcpy} returns a pointer to the terminating nul character and | |
| not to the beginning of the object, the call to @code{free} below is | |
| diagnosed. | |
| @smallexample | |
| void f (char *p) | |
| @{ | |
| p = stpcpy (p, "abc"); | |
| // ... | |
| free (p); // warning | |
| @} | |
| @end smallexample | |
| @option{-Wfree-nonheap-object} is included in @option{-Wall}. | |
| @opindex Wstack-usage | |
| @opindex Wno-stack-usage | |
| @item -Wstack-usage=@var{byte-size} | |
| Warn if the stack usage of a function might exceed @var{byte-size}. | |
| The computation done to determine the stack usage is conservative. | |
| Any space allocated via @code{alloca}, variable-length arrays, or related | |
| constructs is included by the compiler when determining whether or not to | |
| issue a warning. | |
| The message is in keeping with the output of @option{-fstack-usage}. | |
| @itemize | |
| @item | |
| If the stack usage is fully static but exceeds the specified amount, it's: | |
| @smallexample | |
| warning: stack usage is 1120 bytes | |
| @end smallexample | |
| @item | |
| If the stack usage is (partly) dynamic but bounded, it's: | |
| @smallexample | |
| warning: stack usage might be 1648 bytes | |
| @end smallexample | |
| @item | |
| If the stack usage is (partly) dynamic and not bounded, it's: | |
| @smallexample | |
| warning: stack usage might be unbounded | |
| @end smallexample | |
| @end itemize | |
| @option{-Wstack-usage=}@samp{PTRDIFF_MAX} is enabled by default. | |
| Warnings controlled by the option can be disabled either by specifying | |
| @var{byte-size} of @samp{SIZE_MAX} or more or by | |
| @option{-Wno-stack-usage}. | |
| @opindex Wno-stack-usage | |
| @item -Wno-stack-usage | |
| Disable @option{-Wstack-usage=} warnings. The option is equivalent | |
| to @option{-Wstack-usage=}@samp{SIZE_MAX} or larger. | |
| @opindex Wunsafe-loop-optimizations | |
| @opindex Wno-unsafe-loop-optimizations | |
| @item -Wunsafe-loop-optimizations | |
| Warn if the loop cannot be optimized because the compiler cannot | |
| assume anything on the bounds of the loop indices. With | |
| @option{-funsafe-loop-optimizations} warn if the compiler makes | |
| such assumptions. | |
| @opindex Wno-pedantic-ms-format | |
| @opindex Wpedantic-ms-format | |
| @item -Wno-pedantic-ms-format @r{(MinGW targets only)} | |
| When used in combination with @option{-Wformat} | |
| and @option{-pedantic} without GNU extensions, this option | |
| disables the warnings about non-ISO @code{printf} / @code{scanf} format | |
| width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets, | |
| which depend on the MS runtime. | |
| @opindex Wpointer-arith | |
| @opindex Wno-pointer-arith | |
| @item -Wpointer-arith | |
| Warn about anything that depends on the ``size of'' a function type or | |
| of @code{void}. GNU C assigns these types a size of 1, for | |
| convenience in calculations with @code{void *} pointers and pointers | |
| to functions. In C++, warn also when an arithmetic operation involves | |
| @code{NULL}. This warning is also enabled by @option{-Wpedantic}. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wpointer-compare | |
| @opindex Wno-pointer-compare | |
| @item -Wno-pointer-compare | |
| Do not warn if a pointer is compared with a zero character constant. | |
| This usually | |
| means that the pointer was meant to be dereferenced. For example: | |
| @smallexample | |
| const char *p = foo (); | |
| if (p == '\0') | |
| return 42; | |
| @end smallexample | |
| Note that the code above is invalid in C++11. | |
| This warning is enabled by default. | |
| @opindex Wtsan | |
| @opindex Wno-tsan | |
| @item -Wno-tsan | |
| Disable warnings about unsupported features in ThreadSanitizer. | |
| ThreadSanitizer does not support @code{std::atomic_thread_fence} and | |
| can report false positives. | |
| @opindex Wtype-limits | |
| @opindex Wno-type-limits | |
| @item -Wtype-limits | |
| Warn if a comparison is always true or always false due to the limited | |
| range of the data type, but do not warn for constant expressions. For | |
| example, warn if an unsigned variable is compared against zero with | |
| @code{<} or @code{>=}. This warning is also enabled by | |
| @option{-Wextra}. | |
| @opindex Wabsolute-value | |
| @opindex Wno-absolute-value | |
| @item -Wabsolute-value @r{(C and Objective-C only)} | |
| Warn for calls to standard functions that compute the absolute value | |
| of an argument when a more appropriate standard function is available. | |
| For example, calling @code{abs(3.14)} triggers the warning because the | |
| appropriate function to call to compute the absolute value of a double | |
| argument is @code{fabs}. The option also triggers warnings when the | |
| argument in a call to such a function has an unsigned type. This | |
| warning can be suppressed with an explicit type cast and it is also | |
| enabled by @option{-Wextra}. | |
| @include cppwarnopts.texi | |
| @opindex Wbad-function-cast | |
| @opindex Wno-bad-function-cast | |
| @item -Wbad-function-cast @r{(C and Objective-C only)} | |
| Warn when a function call is cast to a non-matching type. | |
| For example, warn if a call to a function returning an integer type | |
| is cast to a pointer type. | |
| @opindex Wc90-c99-compat | |
| @opindex Wno-c90-c99-compat | |
| @item -Wc90-c99-compat @r{(C and Objective-C only)} | |
| Warn about features not present in ISO C90, but present in ISO C99. | |
| For instance, warn about use of variable length arrays, @code{long long} | |
| type, @code{bool} type, compound literals, designated initializers, and so | |
| on. This option is independent of the standards mode. Warnings are disabled | |
| in the expression that follows @code{__extension__}. | |
| @opindex Wc99-c11-compat | |
| @opindex Wno-c99-c11-compat | |
| @item -Wc99-c11-compat @r{(C and Objective-C only)} | |
| Warn about features not present in ISO C99, but present in ISO C11. | |
| For instance, warn about use of anonymous structures and unions, | |
| @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier, | |
| @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword, | |
| and so on. This option is independent of the standards mode. Warnings are | |
| disabled in the expression that follows @code{__extension__}. | |
| @opindex Wc11-c23-compat | |
| @opindex Wno-c11-c23-compat | |
| @opindex Wc11-c2x-compat | |
| @opindex Wno-c11-c2x-compat | |
| @item -Wc11-c23-compat @r{(C and Objective-C only)} | |
| @itemx -Wc11-c2x-compat @r{(C and Objective-C only)} | |
| Warn about features not present in ISO C11, but present in ISO C23. | |
| For instance, warn about omitting the string in @code{_Static_assert}, | |
| use of @samp{[[]]} syntax for attributes, use of decimal | |
| floating-point types, and so on. This option is independent of the | |
| standards mode. Warnings are disabled in the expression that follows | |
| @code{__extension__}. The name @option{-Wc11-c2x-compat} is | |
| deprecated. | |
| When not compiling in C23 mode, these warnings are upgraded to errors | |
| by @option{-pedantic-errors}. | |
| @opindex Wc23-c2y-compat | |
| @opindex Wno-c23-c2y-compat | |
| @item -Wc23-c2y-compat @r{(C and Objective-C only)} | |
| @itemx -Wc23-c2y-compat @r{(C and Objective-C only)} | |
| Warn about features not present in ISO C23, but present in ISO C2Y. | |
| For instance, warn about @code{_Generic} selecting with a type name | |
| instead of an expression. This option is independent of the standards | |
| mode. Warnings are disabled in the expression that follows | |
| @code{__extension__}. | |
| When not compiling in C2Y mode, these warnings are upgraded to errors | |
| by @option{-pedantic-errors}. | |
| @opindex Wc++-compat | |
| @opindex Wno-c++-compat | |
| @item -Wc++-compat @r{(C and Objective-C only)} | |
| Warn about ISO C constructs that are outside of the common subset of | |
| ISO C and ISO C++, e.g.@: request for implicit conversion from | |
| @code{void *} to a pointer to non-@code{void} type. | |
| @opindex Wc++11-compat | |
| @opindex Wno-c++11-compat | |
| @item -Wc++11-compat @r{(C++ and Objective-C++ only)} | |
| Warn about C++ constructs whose meaning differs between ISO C++ 1998 | |
| and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords | |
| in ISO C++ 2011. This warning turns on @option{-Wnarrowing} and is | |
| enabled by @option{-Wall}. | |
| @opindex Wc++14-compat | |
| @opindex Wno-c++14-compat | |
| @item -Wc++14-compat @r{(C++ and Objective-C++ only)} | |
| Warn about C++ constructs whose meaning differs between ISO C++ 2011 | |
| and ISO C++ 2014. This warning is enabled by @option{-Wall}. | |
| @opindex Wc++17-compat | |
| @opindex Wno-c++17-compat | |
| @item -Wc++17-compat @r{(C++ and Objective-C++ only)} | |
| Warn about C++ constructs whose meaning differs between ISO C++ 2014 | |
| and ISO C++ 2017. This warning is enabled by @option{-Wall}. | |
| @opindex Wc++20-compat | |
| @opindex Wno-c++20-compat | |
| @item -Wc++20-compat @r{(C++ and Objective-C++ only)} | |
| Warn about C++ constructs whose meaning differs between ISO C++ 2017 | |
| and ISO C++ 2020. This warning is enabled by @option{-Wall}. | |
| @opindex Wc++26-compat | |
| @opindex Wno-c++26-compat | |
| @item -Wc++26-compat @r{(C++ and Objective-C++ only)} | |
| Warn about C++ constructs whose meaning differs between ISO C++ 2023 | |
| and upcoming ISO C++ 2026. This warning is enabled by @option{-Wall}. | |
| @opindex Wc++11-extensions | |
| @opindex Wno-c++11-extensions | |
| @item -Wno-c++11-extensions @r{(C++ and Objective-C++ only)} | |
| Do not warn about C++11 constructs in code being compiled using | |
| an older C++ standard. Even without this option, some C++11 constructs | |
| will only be diagnosed if @option{-Wpedantic} is used. | |
| @opindex Wc++14-extensions | |
| @opindex Wno-c++14-extensions | |
| @item -Wno-c++14-extensions @r{(C++ and Objective-C++ only)} | |
| Do not warn about C++14 constructs in code being compiled using | |
| an older C++ standard. Even without this option, some C++14 constructs | |
| will only be diagnosed if @option{-Wpedantic} is used. | |
| @opindex Wc++17-extensions | |
| @opindex Wno-c++17-extensions | |
| @item -Wno-c++17-extensions @r{(C++ and Objective-C++ only)} | |
| Do not warn about C++17 constructs in code being compiled using | |
| an older C++ standard. Even without this option, some C++17 constructs | |
| will only be diagnosed if @option{-Wpedantic} is used. | |
| @opindex Wc++20-extensions | |
| @opindex Wno-c++20-extensions | |
| @item -Wno-c++20-extensions @r{(C++ and Objective-C++ only)} | |
| Do not warn about C++20 constructs in code being compiled using | |
| an older C++ standard. Even without this option, some C++20 constructs | |
| will only be diagnosed if @option{-Wpedantic} is used. | |
| @opindex Wc++23-extensions | |
| @opindex Wno-c++23-extensions | |
| @item -Wno-c++23-extensions @r{(C++ and Objective-C++ only)} | |
| Do not warn about C++23 constructs in code being compiled using | |
| an older C++ standard. Even without this option, some C++23 constructs | |
| will only be diagnosed if @option{-Wpedantic} is used. | |
| @opindex Wc++26-extensions | |
| @opindex Wno-c++26-extensions | |
| @item -Wno-c++26-extensions @r{(C++ and Objective-C++ only)} | |
| Do not warn about C++26 constructs in code being compiled using | |
| an older C++ standard. Even without this option, some C++26 constructs | |
| will only be diagnosed if @option{-Wpedantic} is used. | |
| @opindex Wc++29-extensions | |
| @opindex Wno-c++29-extensions | |
| @item -Wno-c++29-extensions @r{(C++ and Objective-C++ only)} | |
| Do not warn about C++29 constructs in code being compiled using | |
| an older C++ standard. Even without this option, some C++29 constructs | |
| will only be diagnosed if @option{-Wpedantic} is used. | |
| @opindex Wcast-qual | |
| @opindex Wno-cast-qual | |
| @item -Wcast-qual | |
| Warn whenever a pointer is cast so as to remove a type qualifier from | |
| the target type. For example, warn if a @code{const char *} is cast | |
| to an ordinary @code{char *}. | |
| Also warn when making a cast that introduces a type qualifier in an | |
| unsafe way. For example, casting @code{char **} to @code{const char **} | |
| is unsafe, as in this example: | |
| @smallexample | |
| /* p is char ** value. */ | |
| const char **q = (const char **) p; | |
| /* Assignment of readonly string to const char * is OK. */ | |
| *q = "string"; | |
| /* Now char** pointer points to read-only memory. */ | |
| **p = 'b'; | |
| @end smallexample | |
| @opindex Wcast-align | |
| @opindex Wno-cast-align | |
| @item -Wcast-align | |
| Warn whenever a pointer is cast such that the required alignment of the | |
| target is increased. For example, warn if a @code{char *} is cast to | |
| an @code{int *} on machines where integers can only be accessed at | |
| two- or four-byte boundaries. | |
| @opindex Wcast-align=strict | |
| @opindex Wno-cast-align=strict | |
| Warn whenever a pointer is cast such that the required alignment of the | |
| target is increased. For example, warn if a @code{char *} is cast to | |
| an @code{int *} regardless of the target machine. | |
| @opindex Wcast-function-type | |
| @opindex Wno-cast-function-type | |
| @item -Wcast-function-type | |
| Warn when a function pointer is cast to an incompatible function pointer. | |
| In a cast involving function types with a variable argument list only | |
| the types of initial arguments that are provided are considered. | |
| Any parameter of pointer-type matches any other pointer-type. Any benign | |
| differences in integral types are ignored, like @code{int} vs.@: @code{long} | |
| on ILP32 targets. Likewise type qualifiers are ignored. The function | |
| type @code{void (*) (void)} is special and matches everything, which can | |
| be used to suppress this warning. | |
| In a cast involving pointer to member types this warning warns whenever | |
| the type cast is changing the pointer to member type. | |
| This warning is enabled by @option{-Wextra}. | |
| @opindex Wcast-user-defined | |
| @opindex Wno-cast-user-defined | |
| @item -Wcast-user-defined | |
| Warn when a cast to reference type does not involve a user-defined | |
| conversion that the programmer might expect to be called. | |
| @smallexample | |
| struct A @{ operator const int&(); @} a; | |
| auto r = (int&)a; // warning | |
| @end smallexample | |
| This warning is enabled by default. | |
| @opindex Wwrite-strings | |
| @opindex Wno-write-strings | |
| @item -Wwrite-strings | |
| When compiling C, give string constants the type @code{const | |
| char[@var{length}]} so that copying the address of one into a | |
| non-@code{const} @code{char *} pointer produces a warning. These | |
| warnings help you find at compile time code that can try to write | |
| into a string constant, but only if you have been very careful about | |
| using @code{const} in declarations and prototypes. Otherwise, it is | |
| just a nuisance. This is why we did not make @option{-Wall} request | |
| these warnings. | |
| When compiling C++, warn about the deprecated conversion from string | |
| literals to @code{char *}. This warning is enabled by default for C++ | |
| programs. | |
| This warning is upgraded to an error by @option{-pedantic-errors} in | |
| C++11 mode or later. | |
| @opindex Wclobbered | |
| @opindex Wno-clobbered | |
| @item -Wclobbered | |
| Warn for variables that might be changed by @code{longjmp} or | |
| @code{vfork}. This warning is also enabled by @option{-Wextra}. | |
| @opindex Wcomplain-wrong-lang | |
| @opindex Wno-complain-wrong-lang | |
| @item -Wno-complain-wrong-lang | |
| By default, language front ends complain when a command-line option is | |
| valid, but not applicable to that front end. | |
| This may be disabled with @option{-Wno-complain-wrong-lang}, | |
| which is mostly useful when invoking a single compiler driver for | |
| multiple source files written in different languages, for example: | |
| @smallexample | |
| $ g++ -fno-rtti a.cc b.f90 | |
| @end smallexample | |
| The driver @file{g++} invokes the C++ front end to compile @file{a.cc} | |
| and the Fortran front end to compile @file{b.f90}. | |
| The latter front end diagnoses | |
| @samp{f951: Warning: command-line option '-fno-rtti' is valid for C++/D/ObjC++ but not for Fortran}, | |
| which may be disabled with @option{-Wno-complain-wrong-lang}. | |
| This option can also be used to disable warnings like | |
| @samp{cc1plus: note: CTF debug info requested, but not supported for 'GNU C++20' frontend} | |
| produced by @option{-gctf} or @option{-gsctf} for unsupported languages. | |
| @opindex Wcompare-distinct-pointer-types | |
| @opindex Wno-compare-distinct-pointer-types | |
| @item -Wcompare-distinct-pointer-types @r{(C and Objective-C only)} | |
| Warn if pointers of distinct types are compared without a cast. This | |
| warning is enabled by default. | |
| @opindex Wconversion | |
| @opindex Wno-conversion | |
| @item -Wconversion | |
| Warn for implicit conversions that may alter a value. This includes | |
| conversions between real and integer, like @code{abs (x)} when | |
| @code{x} is @code{double}; conversions between signed and unsigned, | |
| like @code{unsigned ui = -1}; and conversions to smaller types, like | |
| @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs | |
| ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not | |
| changed by the conversion like in @code{abs (2.0)}. Warnings about | |
| conversions between signed and unsigned integers can be disabled by | |
| using @option{-Wno-sign-conversion}. | |
| For C++, also warn for confusing overload resolution for user-defined | |
| conversions; and conversions that never use a type conversion | |
| operator: conversions to @code{void}, the same type, a base class or a | |
| reference to them. Warnings about conversions between signed and | |
| unsigned integers are disabled by default in C++ unless | |
| @option{-Wsign-conversion} is explicitly enabled. | |
| Warnings about conversion from arithmetic on a small type back to that | |
| type are only given with @option{-Warith-conversion}. | |
| @opindex Wdangling-else | |
| @opindex Wno-dangling-else | |
| @item -Wdangling-else | |
| Warn about constructions where there may be confusion to which | |
| @code{if} statement an @code{else} branch belongs. Here is an example of | |
| such a case: | |
| @smallexample | |
| @group | |
| @{ | |
| if (a) | |
| if (b) | |
| foo (); | |
| else | |
| bar (); | |
| @} | |
| @end group | |
| @end smallexample | |
| In C/C++, every @code{else} branch belongs to the innermost possible | |
| @code{if} statement, which in this example is @code{if (b)}. This is | |
| often not what the programmer expected, as illustrated in the above | |
| example by indentation the programmer chose. When there is the | |
| potential for this confusion, GCC issues a warning when this flag | |
| is specified. To eliminate the warning, add explicit braces around | |
| the innermost @code{if} statement so there is no way the @code{else} | |
| can belong to the enclosing @code{if}. The resulting code | |
| looks like this: | |
| @smallexample | |
| @group | |
| @{ | |
| if (a) | |
| @{ | |
| if (b) | |
| foo (); | |
| else | |
| bar (); | |
| @} | |
| @} | |
| @end group | |
| @end smallexample | |
| This warning is enabled by @option{-Wparentheses}. | |
| @opindex Wdangling-pointer | |
| @opindex Wno-dangling-pointer | |
| @item -Wdangling-pointer | |
| @itemx -Wdangling-pointer=@var{n} | |
| Warn about uses of pointers (or C++ references) to objects with automatic | |
| storage duration after their lifetime has ended. This includes local | |
| variables declared in nested blocks, compound literals and other unnamed | |
| temporary objects. In addition, warn about storing the address of such | |
| objects in escaped pointers. The warning is enabled at all optimization | |
| levels but may yield different results with optimization than without. | |
| @table @gcctabopt | |
| @item -Wdangling-pointer=1 | |
| At level 1, the warning diagnoses only unconditional uses of dangling pointers. | |
| @item -Wdangling-pointer=2 | |
| At level 2, in addition to unconditional uses the warning also diagnoses | |
| conditional uses of dangling pointers. | |
| @end table | |
| The short form @option{-Wdangling-pointer} is equivalent to | |
| @option{-Wdangling-pointer=2}, while @option{-Wno-dangling-pointer} and | |
| @option{-Wdangling-pointer=0} have the same effect of disabling the warnings. | |
| @option{-Wdangling-pointer=2} is included in @option{-Wall}. | |
| This example triggers the warning at level 1; the address of the unnamed | |
| temporary is unconditionally referenced outside of its scope. | |
| @smallexample | |
| char f (char c1, char c2, char c3) | |
| @{ | |
| char *p; | |
| @{ | |
| p = (char[]) @{ c1, c2, c3 @}; | |
| @} | |
| // warning: using dangling pointer 'p' to an unnamed temporary | |
| return *p; | |
| @} | |
| @end smallexample | |
| In the following function the store of the address of the local variable | |
| @code{x} in the escaped pointer @code{*p} triggers the warning at | |
| level 1. | |
| @smallexample | |
| void g (int **p) | |
| @{ | |
| int x = 7; | |
| // warning: storing the address of local variable 'x' in '*p' | |
| *p = &x; | |
| @} | |
| @end smallexample | |
| In this example, the array @var{a} is out of | |
| scope when the pointer @var{s} is used. Since the code that sets @code{s} | |
| is conditional, the warning triggers at level 2. | |
| @smallexample | |
| extern void frob (const char *); | |
| void h (char *s) | |
| @{ | |
| if (!s) | |
| @{ | |
| char a[12] = "tmpname"; | |
| s = a; | |
| @} | |
| // warning: dangling pointer 's' to 'a' may be used | |
| frob (s); | |
| @} | |
| @end smallexample | |
| @opindex Wdate-time | |
| @opindex Wno-date-time | |
| @item -Wdate-time | |
| Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__} | |
| are encountered as they might prevent bitwise-identical reproducible | |
| compilations. | |
| @opindex Wempty-body | |
| @opindex Wno-empty-body | |
| @item -Wempty-body | |
| Warn if an empty body occurs in an @code{if}, @code{else} or @code{do | |
| while} statement. This warning is also enabled by @option{-Wextra}. | |
| @opindex Wendif-labels | |
| @opindex Wno-endif-labels | |
| @item -Wno-endif-labels | |
| Do not warn about stray tokens after @code{#else} and @code{#endif}. | |
| @opindex Wenum-compare | |
| @opindex Wno-enum-compare | |
| @item -Wenum-compare | |
| Warn about a comparison between values of different enumerated types. | |
| In C++, enumerated type mismatches in conditional expressions are also | |
| diagnosed and the warning is enabled by default. In C, this warning is | |
| enabled by @option{-Wall}. | |
| @opindex Wenum-conversion | |
| @opindex Wno-enum-conversion | |
| @item -Wenum-conversion | |
| Warn when a value of enumerated type is implicitly converted to a | |
| different enumerated type. This warning is enabled by @option{-Wextra} | |
| in C@. | |
| @opindex Wenum-int-mismatch | |
| @opindex Wno-enum-int-mismatch | |
| @item -Wenum-int-mismatch @r{(C and Objective-C only)} | |
| Warn about mismatches between an enumerated type and an integer type in | |
| declarations. For example: | |
| @smallexample | |
| enum E @{ l = -1, z = 0, g = 1 @}; | |
| int foo(void); | |
| enum E foo(void); | |
| @end smallexample | |
| In C, an enumerated type is compatible with @code{char}, a signed | |
| integer type, or an unsigned integer type. However, since the choice | |
| of the underlying type of an enumerated type is implementation-defined, | |
| such mismatches may cause portability issues. In C++, such mismatches | |
| are an error. In C, this warning is enabled by @option{-Wall} and | |
| @option{-Wc++-compat}. | |
| @opindex Wjump-misses-init | |
| @opindex Wno-jump-misses-init | |
| @item -Wjump-misses-init @r{(C, Objective-C only)} | |
| Warn if a @code{goto} statement or a @code{switch} statement jumps | |
| forward across the initialization of a variable, or jumps backward to a | |
| label after the variable has been initialized. This only warns about | |
| variables that are initialized when they are declared. This warning is | |
| only supported for C and Objective-C; in C++ this sort of branch is an | |
| error in any case. | |
| @option{-Wjump-misses-init} is included in @option{-Wc++-compat}. It | |
| can be disabled with the @option{-Wno-jump-misses-init} option. | |
| @opindex Wsign-compare | |
| @opindex Wno-sign-compare | |
| @cindex warning for comparison of signed and unsigned values | |
| @cindex comparison of signed and unsigned values, warning | |
| @cindex signed and unsigned values, comparison warning | |
| @item -Wsign-compare | |
| Warn when a comparison between signed and unsigned values could produce | |
| an incorrect result when the signed value is converted to unsigned. | |
| In C++, this warning is also enabled by @option{-Wall}. In C, it is | |
| also enabled by @option{-Wextra}. | |
| @opindex Wsign-conversion | |
| @opindex Wno-sign-conversion | |
| @item -Wsign-conversion | |
| Warn for implicit conversions that may change the sign of an integer | |
| value, like assigning a signed integer expression to an unsigned | |
| integer variable. An explicit cast silences the warning. In C, this | |
| option is enabled also by @option{-Wconversion}. | |
| @opindex Wflex-array-member-not-at-end | |
| @opindex Wno-flex-array-member-not-at-end | |
| @item -Wflex-array-member-not-at-end @r{(C and C++ only)} | |
| Warn when a structure containing a C99 flexible array member as the last | |
| field is not at the end of another structure. | |
| This warning warns e.g. about | |
| @smallexample | |
| struct flex @{ int length; char data[]; @}; | |
| struct mid_flex @{ int m; struct flex flex_data; int n; @}; | |
| @end smallexample | |
| @opindex Wfloat-conversion | |
| @opindex Wno-float-conversion | |
| @item -Wfloat-conversion | |
| Warn for implicit conversions that reduce the precision of a real value. | |
| This includes conversions from real to integer, and from higher precision | |
| real to lower precision real values. This option is also enabled by | |
| @option{-Wconversion}. | |
| @opindex Wno-scalar-storage-order | |
| @opindex Wscalar-storage-order | |
| @item -Wno-scalar-storage-order | |
| Do not warn on suspicious constructs involving reverse scalar storage order. | |
| @opindex Wsizeof-array-div | |
| @opindex Wno-sizeof-array-div | |
| @item -Wsizeof-array-div | |
| Warn about divisions of two sizeof operators when the first one is applied | |
| to an array and the divisor does not equal the size of the array element. | |
| In such a case, the computation will not yield the number of elements in the | |
| array, which is likely what the user intended. This warning warns e.g. about | |
| @smallexample | |
| int fn () | |
| @{ | |
| int arr[10]; | |
| return sizeof (arr) / sizeof (short); | |
| @} | |
| @end smallexample | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wsizeof-pointer-div | |
| @opindex Wno-sizeof-pointer-div | |
| @item -Wsizeof-pointer-div | |
| Warn for suspicious divisions of two sizeof expressions that divide | |
| the pointer size by the element size, which is the usual way to compute | |
| the array size but won't work out correctly with pointers. This warning | |
| warns e.g.@: about @code{sizeof (ptr) / sizeof (ptr[0])} if @code{ptr} is | |
| not an array, but a pointer. This warning is enabled by @option{-Wall}. | |
| @opindex Wsizeof-pointer-memaccess | |
| @opindex Wno-sizeof-pointer-memaccess | |
| @item -Wsizeof-pointer-memaccess | |
| Warn for suspicious length parameters to certain string and memory built-in | |
| functions if the argument uses @code{sizeof}. This warning triggers for | |
| example for @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not | |
| an array, but a pointer, and suggests a possible fix, or about | |
| @code{memcpy (&foo, ptr, sizeof (&foo));}. @option{-Wsizeof-pointer-memaccess} | |
| also warns about calls to bounded string copy functions like @code{strncat} | |
| or @code{strncpy} that specify as the bound a @code{sizeof} expression of | |
| the source array. For example, in the following function the call to | |
| @code{strncat} specifies the size of the source string as the bound. That | |
| is almost certainly a mistake and so the call is diagnosed. | |
| @smallexample | |
| void make_file (const char *name) | |
| @{ | |
| char path[PATH_MAX]; | |
| strncpy (path, name, sizeof path - 1); | |
| strncat (path, ".text", sizeof ".text"); | |
| @dots{} | |
| @} | |
| @end smallexample | |
| The @option{-Wsizeof-pointer-memaccess} option is enabled by @option{-Wall}. | |
| @opindex Wsizeof-array-argument | |
| @opindex Wno-sizeof-array-argument | |
| @item -Wno-sizeof-array-argument | |
| Do not warn when the @code{sizeof} operator is applied to a parameter that is | |
| declared as an array in a function definition. This warning is enabled by | |
| default for C and C++ programs. | |
| @opindex Wmemset-elt-size | |
| @opindex Wno-memset-elt-size | |
| @item -Wmemset-elt-size | |
| Warn for suspicious calls to the @code{memset} built-in function, if the | |
| first argument references an array, and the third argument is a number | |
| equal to the number of elements, but not equal to the size of the array | |
| in memory. This indicates that the user has omitted a multiplication by | |
| the element size. This warning is enabled by @option{-Wall}. | |
| @opindex Wmemset-transposed-args | |
| @opindex Wno-memset-transposed-args | |
| @item -Wmemset-transposed-args | |
| Warn for suspicious calls to the @code{memset} built-in function where | |
| the second argument is not zero and the third argument is zero. For | |
| example, the call @code{memset (buf, sizeof buf, 0)} is diagnosed because | |
| @code{memset (buf, 0, sizeof buf)} was meant instead. The diagnostic | |
| is only emitted if the third argument is a literal zero. Otherwise, if | |
| it is an expression that is folded to zero, or a cast of zero to some | |
| type, it is far less likely that the arguments have been mistakenly | |
| transposed and no warning is emitted. This warning is enabled | |
| by @option{-Wall}. | |
| @opindex Waddress | |
| @opindex Wno-address | |
| @item -Waddress | |
| Warn about suspicious uses of address expressions. These include comparing | |
| the address of a function or a declared object to the null pointer constant | |
| such as in | |
| @smallexample | |
| void f (void); | |
| void g (void) | |
| @{ | |
| if (!f) // warning: expression evaluates to false | |
| abort (); | |
| @} | |
| @end smallexample | |
| comparisons of a pointer to a string literal, such as in | |
| @smallexample | |
| void f (const char *x) | |
| @{ | |
| if (x == "abc") // warning: expression evaluates to false | |
| puts ("equal"); | |
| @} | |
| @end smallexample | |
| and tests of the results of pointer addition or subtraction for equality | |
| to null, such as in | |
| @smallexample | |
| void f (const int *p, int i) | |
| @{ | |
| return p + i == NULL; | |
| @} | |
| @end smallexample | |
| Such uses typically indicate a programmer error: the address of most | |
| functions and objects necessarily evaluates to true (the exception are | |
| weak symbols), so their use in a conditional might indicate missing | |
| parentheses in a function call or a missing dereference in an array | |
| expression. The subset of the warning for object pointers can be | |
| suppressed by casting the pointer operand to an integer type such | |
| as @code{intptr_t} or @code{uintptr_t}. | |
| Comparisons against string literals result in unspecified behavior | |
| and are not portable, and suggest the intent was to call @code{strcmp}. | |
| The warning is suppressed if the suspicious expression is the result | |
| of macro expansion. | |
| @option{-Waddress} is enabled by @option{-Wall}. | |
| @opindex Waddress-of-packed-member | |
| @opindex Wno-address-of-packed-member | |
| @item -Wno-address-of-packed-member | |
| Do not warn when the address of packed member of struct or union is taken, | |
| which usually results in an unaligned pointer value. This is | |
| enabled by default. | |
| @opindex Wlogical-op | |
| @opindex Wno-logical-op | |
| @item -Wlogical-op | |
| Warn about suspicious uses of logical operators in expressions. | |
| This includes using logical operators in contexts where a | |
| bitwise operator is likely to be expected. Also warns when | |
| the operands of a logical operator are the same: | |
| @smallexample | |
| extern int a; | |
| if (a < 0 && a < 0) @{ @dots{} @} | |
| @end smallexample | |
| @opindex Wconstant-logical-operand | |
| @opindex Wno-constant-logical-operand | |
| @item -Wconstant-logical-operand | |
| Warn about another case of suspicious uses of logical operators in | |
| expressions, when neither operand of a logical operator is boolean | |
| and one of the operands is (or folds into) a constant other than 0 or 1, | |
| or enumerator with value 1 if the enumeral type contains enumerators with | |
| values other than 0 or 1. | |
| In such case the warning will suggest using corresponding bitwise operator. | |
| @smallexample | |
| extern int a; | |
| if (a && 64) @{ @dots{} @} | |
| @end smallexample | |
| If the warning is a false positive, one can clarify the code by using | |
| e.g. @code{a && (64 != 0)} instead. | |
| @opindex Wlogical-not-parentheses | |
| @opindex Wno-logical-not-parentheses | |
| @item -Wlogical-not-parentheses | |
| Warn about logical not used on the left hand side operand of a comparison. | |
| This option does not warn if the right operand is considered to be a boolean | |
| expression. Its purpose is to detect suspicious code like the following: | |
| @smallexample | |
| int a; | |
| @dots{} | |
| if (!a > 1) @{ @dots{} @} | |
| @end smallexample | |
| It is possible to suppress the warning by wrapping the LHS into | |
| parentheses: | |
| @smallexample | |
| if ((!a) > 1) @{ @dots{} @} | |
| @end smallexample | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Waggregate-return | |
| @opindex Wno-aggregate-return | |
| @item -Waggregate-return | |
| Warn if any functions that return structures or unions are defined or | |
| called. (In languages where you can return an array, this also elicits | |
| a warning.) | |
| @opindex Wno-aggressive-loop-optimizations | |
| @opindex Waggressive-loop-optimizations | |
| @item -Wno-aggressive-loop-optimizations | |
| Do not warn if the compiler detects undefined behavior in a loop with | |
| a constant number of iterations. @option{-Waggressive-loop-optimizations} | |
| is enabled by default. | |
| @opindex Wno-attributes | |
| @opindex Wattributes | |
| @item -Wno-attributes | |
| Do not warn if an unexpected @code{__attribute__} is used, such as | |
| unrecognized attributes, function attributes applied to variables, | |
| etc. This does not stop errors for incorrect use of supported | |
| attributes. | |
| Warnings about ill-formed uses of standard attributes are upgraded to | |
| errors by @option{-pedantic-errors}. | |
| Additionally, using @option{-Wno-attributes=}, it is possible to suppress | |
| warnings about unknown scoped attributes (in C++11 and C23). For example, | |
| @option{-Wno-attributes=vendor::attr} disables warning about the following | |
| declaration: | |
| @smallexample | |
| [[vendor::attr]] void f(); | |
| @end smallexample | |
| It is also possible to disable warning about all attributes in a namespace | |
| using @option{-Wno-attributes=vendor::} which prevents warning about both | |
| of these declarations: | |
| @smallexample | |
| [[vendor::safe]] void f(); | |
| [[vendor::unsafe]] void f2(); | |
| @end smallexample | |
| Note that @option{-Wno-attributes=} does not imply @option{-Wno-attributes}. | |
| @opindex Wno-builtin-declaration-mismatch | |
| @opindex Wbuiltin-declaration-mismatch | |
| @item -Wno-builtin-declaration-mismatch | |
| Warn if a built-in function is declared with an incompatible signature | |
| or as a non-function, or when a built-in function declared with a type | |
| that does not include a prototype is called with arguments whose promoted | |
| types do not match those expected by the function. When @option{-Wextra} | |
| is specified, also warn when a built-in function that takes arguments is | |
| declared without a prototype. The @option{-Wbuiltin-declaration-mismatch} | |
| warning is enabled by default. To avoid the warning include the appropriate | |
| header to bring the prototypes of built-in functions into scope. | |
| For example, the call to @code{memset} below is diagnosed by the warning | |
| because the function expects a value of type @code{size_t} as its argument | |
| but the type of @code{32} is @code{int}. With @option{-Wextra}, | |
| the declaration of the function is diagnosed as well. | |
| @smallexample | |
| extern void* memset (); | |
| void f (void *d) | |
| @{ | |
| memset (d, '\0', 32); | |
| @} | |
| @end smallexample | |
| @opindex Wno-builtin-macro-redefined | |
| @opindex Wbuiltin-macro-redefined | |
| @item -Wno-builtin-macro-redefined | |
| Do not warn if certain built-in macros are redefined. This suppresses | |
| warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__}, | |
| @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}. | |
| @opindex Wkeyword-macro | |
| @opindex Wno-keyword-macro | |
| @item -Wkeyword-macro | |
| Warn if a keyword is defined as a macro or undefined. | |
| For C++ identifiers with special meaning or standard attribute identifiers | |
| are diagnosed as well. This warning is enabled by default for C++26 | |
| if @code{-Wpedantic} and emits a pedwarn in that case. | |
| @opindex Wfree-labels | |
| @opindex Wno-free-labels | |
| @item -Wfree-labels @r{(C and Objective-C only)} | |
| Warn if a label is applied to a non-statement, or occurs at the end of a | |
| compound statement. Such labels are allowed by C23 and later dialects | |
| of C, and are available as a GCC extension in all other dialects. | |
| This warning is also enabled by @option{-Wc11-c23-compat}. It is turned | |
| into an error if building for a C version before C23 by | |
| @option{-pedantic-errors}. | |
| @opindex Wheader-guard | |
| @opindex Wno-header-guard | |
| @item -Wheader-guard | |
| Warn if a valid preprocessor header multiple inclusion guard has | |
| a @code{#define} directive right after @code{#ifndef} or @code{#if !defined} | |
| directive for the multiple inclusion guard, which defines a different macro | |
| from the guard macro with a similar name, the actual multiple inclusion guard | |
| macro isn't defined at the corresponding @code{#ifndef} directive at the end | |
| of the header, and the @code{#define} directive defines an object-like macro | |
| with empty definition. In such case, it often is just a misspelled guard | |
| name, either in the @code{#ifndef} or @code{#if !defined} directive or in the | |
| subsequent @code{#define} directive. This warning is enabled | |
| by @option{-Wall}. | |
| @opindex Wstrict-prototypes | |
| @opindex Wno-strict-prototypes | |
| @item -Wstrict-prototypes @r{(C and Objective-C only)} | |
| Warn if a function is declared or defined without specifying the | |
| argument types. (An old-style function definition is permitted without | |
| a warning if preceded by a declaration that specifies the argument | |
| types.) | |
| @opindex Wold-style-declaration | |
| @opindex Wno-old-style-declaration | |
| @item -Wold-style-declaration @r{(C and Objective-C only)} | |
| Warn for obsolescent usages, according to the C Standard, in a | |
| declaration. For example, warn if storage-class specifiers like | |
| @code{static} are not the first things in a declaration. This warning | |
| is also enabled by @option{-Wextra}. | |
| @opindex Wold-style-definition | |
| @opindex Wno-old-style-definition | |
| @item -Wold-style-definition @r{(C and Objective-C only)} | |
| Warn if an old-style function definition is used. A warning is given | |
| even if there is a previous prototype. A definition using @samp{()} | |
| is not considered an old-style definition in C23 mode, because it is | |
| equivalent to @samp{(void)} in that case, but is considered an | |
| old-style definition for older standards. | |
| @opindex Wmultiple-parameter-fwd-decl-lists | |
| @opindex Wno-multiple-parameter-fwd-decl-lists | |
| @item -Wmultiple-parameter-fwd-decl-lists @r{(C and Objective-C only)} | |
| Warn if more than one list of forward declarations of parameters | |
| appears in a function prototype. | |
| This warning is also enabled by @option{-Wextra}. | |
| @opindex Wdeprecated-non-prototype | |
| @opindex Wno-deprecated-non-prototype | |
| @item -Wdeprecated-non-prototype @r{(C and Objective-C only)} | |
| Warn if a function declared with an empty parameter list @samp{()} is | |
| called with one or more arguments, or if a function definition with one | |
| or more parameters is encountered after such a declaration. Both cases | |
| are errors in C23 and later dialects of C. | |
| This warning is also enabled by @option{-Wc11-c23-compat}. | |
| @opindex Wmissing-parameter-name | |
| @opindex Wno-missing-parameter-name | |
| @item -Wmissing-parameter-name @r{(C and Objective-C only)} | |
| Warn if a function definition omits a parameter name, specifying only | |
| its type. This can be used to document that a parameter is unused | |
| in the definition. It is part of C23 and later dialects of C, | |
| and available as a GCC extension in all other dialects. | |
| This warning is also enabled by @option{-Wc11-c23-compat}. It is turned | |
| into an error if building for a C version before C23 by | |
| @option{-pedantic-errors}. | |
| @opindex Wmissing-parameter-type | |
| @opindex Wno-missing-parameter-type | |
| @item -Wmissing-parameter-type @r{(C and Objective-C only)} | |
| A function parameter is declared without a type specifier in K&R-style | |
| functions: | |
| @smallexample | |
| void foo(bar) @{ @} | |
| @end smallexample | |
| This warning is also enabled by @option{-Wextra}. | |
| @opindex Wno-declaration-missing-parameter-type | |
| @opindex Wdeclaration-missing-parameter-type | |
| @item -Wno-declaration-missing-parameter-type @r{(C and Objective-C only)} | |
| Do not warn if a function declaration contains a parameter name without | |
| a type. Such function declarations do not provide a function prototype | |
| and prevent most type checking in function calls. | |
| This warning is enabled by default. In C99 and later dialects of C, it | |
| is treated as an error. The error can be downgraded to a warning using | |
| @option{-fpermissive} (along with certain other errors), or for this | |
| error alone, with @option{-Wno-error=declaration-missing-parameter-type}. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wmissing-prototypes | |
| @opindex Wno-missing-prototypes | |
| @item -Wmissing-prototypes @r{(C and Objective-C only)} | |
| Warn if a global function is defined without a previous prototype | |
| declaration. This warning is issued even if the definition itself | |
| provides a prototype. Use this option to detect global functions | |
| that do not have a matching prototype declaration in a header file. | |
| This option is not valid for C++ because all function declarations | |
| provide prototypes and a non-matching declaration declares an | |
| overload rather than conflict with an earlier declaration. | |
| Use @option{-Wmissing-declarations} to detect missing declarations in C++. | |
| @opindex Wmissing-variable-declarations | |
| @opindex Wno-missing-variable-declarations | |
| @item -Wmissing-variable-declarations @r{(C and Objective-C only)} | |
| Warn if a global variable is defined without a previous declaration. | |
| Use this option to detect global variables that do not have a matching | |
| extern declaration in a header file. | |
| @opindex Wmissing-declarations | |
| @opindex Wno-missing-declarations | |
| @item -Wmissing-declarations | |
| Warn if a global function is defined without a previous declaration. | |
| Do so even if the definition itself provides a prototype. | |
| Use this option to detect global functions that are not declared in | |
| header files. In C, no warnings are issued for functions with previous | |
| non-prototype declarations; use @option{-Wmissing-prototypes} to detect | |
| missing prototypes. In C++, no warnings are issued for function templates, | |
| or for inline functions, or for functions in anonymous namespaces. | |
| @opindex Wmissing-field-initializers | |
| @opindex Wno-missing-field-initializers | |
| @opindex W | |
| @opindex Wextra | |
| @opindex Wno-extra | |
| @item -Wmissing-field-initializers | |
| Warn if a structure's initializer has some fields missing. For | |
| example, the following code causes such a warning, because | |
| @code{x.h} is implicitly zero: | |
| @smallexample | |
| struct s @{ int f, g, h; @}; | |
| struct s x = @{ 3, 4 @}; | |
| @end smallexample | |
| @c It's unclear if this behavior is desirable. See PR39589 and PR96868. | |
| In C this option does not warn about designated initializers, so the | |
| following modification does not trigger a warning: | |
| @smallexample | |
| struct s @{ int f, g, h; @}; | |
| struct s x = @{ .f = 3, .g = 4 @}; | |
| @end smallexample | |
| In C this option does not warn about the universal zero initializer | |
| @samp{@{ 0 @}}: | |
| @smallexample | |
| struct s @{ int f, g, h; @}; | |
| struct s x = @{ 0 @}; | |
| @end smallexample | |
| Likewise, in C++ this option does not warn about the empty @{ @} | |
| initializer, for example: | |
| @smallexample | |
| struct s @{ int f, g, h; @}; | |
| s x = @{ @}; | |
| @end smallexample | |
| This warning is included in @option{-Wextra}. To get other @option{-Wextra} | |
| warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}. | |
| @opindex Wmissing-requires | |
| @opindex Wno-missing-requires | |
| @item -Wno-missing-requires | |
| By default, the compiler warns about a concept-id appearing as a C++20 simple-requirement: | |
| @smallexample | |
| bool satisfied = requires @{ C<T> @}; | |
| @end smallexample | |
| Here @samp{satisfied} will be true if @samp{C<T>} is a valid | |
| expression, which it is for all T. Presumably the user meant to write | |
| @smallexample | |
| bool satisfied = requires @{ requires C<T> @}; | |
| @end smallexample | |
| so @samp{satisfied} is only true if concept @samp{C} is satisfied for | |
| type @samp{T}. | |
| This warning can be disabled with @option{-Wno-missing-requires}. | |
| @opindex Wmissing-template-keyword | |
| @opindex Wno-missing-template-keyword | |
| @item -Wno-missing-template-keyword | |
| The member access tokens ., -> and :: must be followed by the @code{template} | |
| keyword if the parent object is dependent and the member being named is a | |
| template. | |
| @smallexample | |
| template <class X> | |
| void DoStuff (X x) | |
| @{ | |
| x.template DoSomeOtherStuff<X>(); // Good. | |
| x.DoMoreStuff<X>(); // Warning, x is dependent. | |
| @} | |
| @end smallexample | |
| In rare cases it is possible to get false positives. To silence this, wrap | |
| the expression in parentheses. For example, the following is treated as a | |
| template, even where m and N are integers: | |
| @smallexample | |
| void NotATemplate (my_class t) | |
| @{ | |
| int N = 5; | |
| bool test = t.m < N > (0); // Treated as a template. | |
| test = (t.m < N) > (0); // Same meaning, but not treated as a template. | |
| @} | |
| @end smallexample | |
| This warning can be disabled with @option{-Wno-missing-template-keyword}. | |
| @opindex Wno-multichar | |
| @opindex Wmultichar | |
| @item -Wno-multichar | |
| Do not warn if a multicharacter constant (@samp{'FOOF'}) is used. | |
| Usually they indicate a typo in the user's code, as they have | |
| implementation-defined values, and should not be used in portable code. | |
| @opindex Wnormalized= | |
| @opindex Wnormalized | |
| @opindex Wno-normalized | |
| @cindex NFC | |
| @cindex NFKC | |
| @cindex character set, input normalization | |
| @item -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} | |
| In ISO C and ISO C++, two identifiers are different if they are | |
| different sequences of characters. However, sometimes when characters | |
| outside the basic ASCII character set are used, you can have two | |
| different character sequences that look the same. To avoid confusion, | |
| the ISO 10646 standard sets out some @dfn{normalization rules} which | |
| when applied ensure that two sequences that look the same are turned into | |
| the same sequence. GCC can warn you if you are using identifiers that | |
| have not been normalized; this option controls that warning. | |
| There are four levels of warning supported by GCC@. The default is | |
| @option{-Wnormalized=nfc}, which warns about any identifier that is | |
| not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the | |
| recommended form for most uses. It is equivalent to | |
| @option{-Wnormalized}. | |
| Unfortunately, there are some characters allowed in identifiers by | |
| ISO C and ISO C++ that, when turned into NFC, are not allowed in | |
| identifiers. That is, there's no way to use these symbols in portable | |
| ISO C or C++ and have all your identifiers in NFC@. | |
| @option{-Wnormalized=id} suppresses the warning for these characters. | |
| It is hoped that future versions of the standards involved will correct | |
| this, which is why this option is not the default. | |
| You can switch the warning off for all characters by writing | |
| @option{-Wnormalized=none} or @option{-Wno-normalized}. You should | |
| only do this if you are using some other normalization scheme (like | |
| ``D''), because otherwise you can easily create bugs that are | |
| literally impossible to see. | |
| Some characters in ISO 10646 have distinct meanings but look identical | |
| in some fonts or display methodologies, especially once formatting has | |
| been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL | |
| LETTER N'', displays just like a regular @code{n} that has been | |
| placed in a superscript. ISO 10646 defines the @dfn{NFKC} | |
| normalization scheme to convert all these into a standard form as | |
| well, and GCC warns if your code is not in NFKC if you use | |
| @option{-Wnormalized=nfkc}. This warning is comparable to warning | |
| about every identifier that contains the letter O because it might be | |
| confused with the digit 0, and so is not the default, but may be | |
| useful as a local coding convention if the programming environment | |
| cannot be fixed to display these characters distinctly. | |
| @opindex Wno-attribute-warning | |
| @opindex Wattribute-warning | |
| @item -Wno-attribute-warning | |
| Do not warn about usage of functions | |
| declared with @code{warning} attribute (@pxref{Common Attributes}). | |
| By default, this warning is | |
| enabled. @option{-Wno-attribute-warning} can be used to disable the | |
| warning or @option{-Wno-error=attribute-warning} can be used to | |
| disable the error when compiled with @option{-Werror} flag. | |
| @opindex Wno-deprecated | |
| @opindex Wdeprecated | |
| @item -Wno-deprecated | |
| Do not warn about usage of deprecated features. @xref{Deprecated Features}. | |
| In C++, explicitly specifying @option{-Wdeprecated} also enables | |
| warnings about some features that are deprecated in later language | |
| standards, specifically @option{-Wcomma-subscript}, | |
| @option{-Wvolatile}, @option{-Wdeprecated-enum-float-conversion}, | |
| @option{-Wdeprecated-enum-enum-conversion}, | |
| @option{-Wdeprecated-literal-operator}, and | |
| @option{-Wdeprecated-variadic-comma-omission}. | |
| @opindex Wno-deprecated-declarations | |
| @opindex Wdeprecated-declarations | |
| @item -Wno-deprecated-declarations | |
| Do not warn about uses of functions, variables, or types | |
| marked as deprecated by using the @code{deprecated} | |
| attribute. @xref{Attributes}. | |
| @opindex Wno-deprecated-openmp | |
| @opindex Wdeprecated-openmp | |
| @item -Wno-deprecated-openmp | |
| Do not warn about deprecated OpenMP code. | |
| @opindex Wno-overflow | |
| @opindex Woverflow | |
| @item -Wno-overflow | |
| Do not warn about compile-time overflow in constant expressions. | |
| @opindex Wno-odr | |
| @opindex Wodr | |
| @item -Wno-odr | |
| Warn about One Definition Rule violations during link-time optimization. | |
| Enabled by default. | |
| @opindex Wopenacc-parallelism | |
| @opindex Wno-openacc-parallelism | |
| @cindex OpenACC accelerator programming | |
| @item -Wopenacc-parallelism | |
| Warn about potentially suboptimal choices related to OpenACC parallelism. | |
| @opindex Wopenmp | |
| @opindex Wno-openmp | |
| @item -Wno-openmp | |
| Warn about suspicious OpenMP code. | |
| @opindex Wopenmp-simd | |
| @opindex Wno-openmp-simd | |
| @item -Wopenmp-simd | |
| Warn if the vectorizer cost model overrides the OpenMP | |
| simd directive set by user. The @option{-fsimd-cost-model=unlimited} | |
| option can be used to relax the cost model. | |
| @opindex Woverride-init | |
| @opindex Wno-override-init | |
| @opindex W | |
| @opindex Wextra | |
| @opindex Wno-extra | |
| @item -Woverride-init @r{(C and Objective-C only)} | |
| Warn if an initialized field without side effects is overridden when | |
| using designated initializers (@pxref{Designated Inits, , Designated | |
| Initializers}). | |
| This warning is included in @option{-Wextra}. To get other | |
| @option{-Wextra} warnings without this one, use @option{-Wextra | |
| -Wno-override-init}. | |
| @opindex Woverride-init-side-effects | |
| @opindex Wno-override-init-side-effects | |
| @item -Wno-override-init-side-effects @r{(C and Objective-C only)} | |
| Do not warn if an initialized field with side effects is overridden when | |
| using designated initializers (@pxref{Designated Inits, , Designated | |
| Initializers}). This warning is enabled by default. | |
| @opindex Wpacked | |
| @opindex Wno-packed | |
| @item -Wpacked | |
| Warn if a structure is given the packed attribute, but the packed | |
| attribute has no effect on the layout or size of the structure. | |
| Such structures may be mis-aligned for little benefit. For | |
| instance, in this code, the variable @code{f.x} in @code{struct bar} | |
| is misaligned even though @code{struct bar} does not itself | |
| have the packed attribute: | |
| @smallexample | |
| @group | |
| struct foo @{ | |
| int x; | |
| char a, b, c, d; | |
| @} __attribute__((packed)); | |
| struct bar @{ | |
| char z; | |
| struct foo f; | |
| @}; | |
| @end group | |
| @end smallexample | |
| @opindex Wpacked-bitfield-compat | |
| @opindex Wno-packed-bitfield-compat | |
| @item -Wnopacked-bitfield-compat | |
| The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute | |
| on bit-fields of type @code{char}. This was fixed in GCC 4.4 but | |
| the change can lead to differences in the structure layout. GCC | |
| informs you when the offset of such a field has changed in GCC 4.4. | |
| For example there is no longer a 4-bit padding between field @code{a} | |
| and @code{b} in this structure: | |
| @smallexample | |
| struct foo | |
| @{ | |
| char a:4; | |
| char b:8; | |
| @} __attribute__ ((packed)); | |
| @end smallexample | |
| This warning is enabled by default. Use | |
| @option{-Wno-packed-bitfield-compat} to disable this warning. | |
| @opindex Wpacked-not-aligned | |
| @opindex Wno-packed-not-aligned | |
| @item -Wpacked-not-aligned @r{(C, C++, Objective-C and Objective-C++ only)} | |
| Warn if a structure field with explicitly specified alignment in a | |
| packed struct or union is misaligned. For example, a warning will | |
| be issued on @code{struct S}, like, @code{warning: alignment 1 of | |
| 'struct S' is less than 8}, in this code: | |
| @smallexample | |
| @group | |
| struct __attribute__ ((aligned (8))) S8 @{ char a[8]; @}; | |
| struct __attribute__ ((packed)) S @{ | |
| struct S8 s8; | |
| @}; | |
| @end group | |
| @end smallexample | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wpadded | |
| @opindex Wno-padded | |
| @item -Wpadded | |
| Warn if padding is included in a structure, either to align an element | |
| of the structure or to align the whole structure. Sometimes when this | |
| happens it is possible to rearrange the fields of the structure to | |
| reduce the padding and so make the structure smaller. | |
| @opindex Wredundant-decls | |
| @opindex Wno-redundant-decls | |
| @item -Wredundant-decls | |
| Warn if anything is declared more than once in the same scope, even in | |
| cases where multiple declaration is valid and changes nothing. | |
| @opindex Wrestrict | |
| @opindex Wno-restrict | |
| @item -Wrestrict | |
| Warn when an object referenced by a @code{restrict}-qualified parameter | |
| (or, in C++, a @code{__restrict}-qualified parameter) is aliased by another | |
| argument, or when copies between such objects overlap. For example, | |
| the call to the @code{strcpy} function below attempts to truncate the string | |
| by replacing its initial characters with the last four. However, because | |
| the call writes the terminating NUL into @code{a[4]}, the copies overlap and | |
| the call is diagnosed. | |
| @smallexample | |
| void foo (void) | |
| @{ | |
| char a[] = "abcd1234"; | |
| strcpy (a, a + 4); | |
| @dots{} | |
| @} | |
| @end smallexample | |
| The @option{-Wrestrict} option detects some instances of simple overlap | |
| even without optimization but works best at @option{-O2} and above. It | |
| is included in @option{-Wall}. | |
| @opindex Wnested-externs | |
| @opindex Wno-nested-externs | |
| @item -Wnested-externs @r{(C and Objective-C only)} | |
| Warn if an @code{extern} declaration is encountered within a function. | |
| @opindex Winline | |
| @opindex Wno-inline | |
| @item -Winline | |
| Warn if a function that is declared as inline cannot be inlined. | |
| Even with this option, the compiler does not warn about failures to | |
| inline functions declared in system headers. | |
| The compiler uses a variety of heuristics to determine whether or not | |
| to inline a function. For example, the compiler takes into account | |
| the size of the function being inlined and the amount of inlining | |
| that has already been done in the current function. Therefore, | |
| seemingly insignificant changes in the source program can cause the | |
| warnings produced by @option{-Winline} to appear or disappear. | |
| @opindex Winterference-size | |
| @opindex Wno-interference-size | |
| @item -Winterference-size | |
| @item -Wno-interference-size | |
| Warn about questionable uses of the C++17 @code{constexpr} variables | |
| @code{std::hardware_destructive_interference_size} and | |
| @code{std::hardware_constructive_interference_size}. | |
| These variables are intended to be used for controlling class layout, to | |
| avoid false sharing in concurrent code: | |
| @smallexample | |
| struct independent_fields @{ | |
| alignas(std::hardware_destructive_interference_size) | |
| std::atomic<int> one; | |
| alignas(std::hardware_destructive_interference_size) | |
| std::atomic<int> two; | |
| @}; | |
| @end smallexample | |
| Here @samp{one} and @samp{two} are intended to be far enough apart | |
| that stores to one won't require accesses to the other to reload the | |
| cache line. | |
| By default, these variables are given values based on the | |
| current @option{-mtune} option, typically to the L1 cache line size | |
| for the particular target CPU, sometimes to a range if tuning for a | |
| generic target. So all translation units that depend on ABI | |
| compatibility for the use of these variables must be compiled with | |
| the same @option{-mtune} (or @option{-mcpu}). | |
| If ABI stability is important, such as if the use is in a header for a | |
| library, you should probably not use the hardware interference size | |
| variables at all. | |
| These warnings are enabled by default. | |
| If you are confident that your use of these variables does not affect ABI | |
| outside a single build of your project, you can turn off the warning | |
| with @option{-Wno-interference-size}. | |
| @opindex Wint-in-bool-context | |
| @opindex Wno-int-in-bool-context | |
| @item -Wint-in-bool-context | |
| Warn for suspicious use of integer values where boolean values are expected, | |
| such as conditional expressions (?:) using non-boolean integer constants in | |
| boolean context, like @code{if (a <= b ? 2 : 3)}. Or left shifting of signed | |
| integers in boolean context, like @code{for (a = 0; 1 << a; a++);}. Likewise | |
| for all kinds of multiplications regardless of the data type. | |
| This warning is enabled by @option{-Wall}. | |
| @opindex Wno-int-to-pointer-cast | |
| @opindex Wint-to-pointer-cast | |
| @item -Wno-int-to-pointer-cast | |
| Suppress warnings from casts to pointer type of an integer of a | |
| different size. In C++, casting to a pointer type of smaller size is | |
| an error. @option{Wint-to-pointer-cast} is enabled by default. | |
| @opindex Wno-pointer-to-int-cast | |
| @opindex Wpointer-to-int-cast | |
| @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)} | |
| Suppress warnings from casts from a pointer to an integer type of a | |
| different size. | |
| @opindex Winvalid-pch | |
| @opindex Wno-invalid-pch | |
| @item -Winvalid-pch | |
| Warn if a precompiled header (@pxref{Precompiled Headers}) is found in | |
| the search path but cannot be used. | |
| @opindex Winvalid-utf8 | |
| @opindex Wno-invalid-utf8 | |
| @item -Winvalid-utf8 | |
| Warn if an invalid UTF-8 character is found. | |
| This warning is on by default for C++23 if @option{-finput-charset=UTF-8} | |
| is used and turned into error with @option{-pedantic-errors}. | |
| @opindex Wunicode | |
| @opindex Wno-unicode | |
| @item -Wno-unicode | |
| Don't diagnose invalid forms of delimited or named escape sequences which are | |
| treated as separate tokens. @option{Wunicode} is enabled by default. | |
| @opindex Wlong-long | |
| @opindex Wno-long-long | |
| @item -Wlong-long | |
| Warn if @code{long long} type is used. This is enabled by either | |
| @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98 | |
| modes. To inhibit the warning messages, use @option{-Wno-long-long}. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wvariadic-macros | |
| @opindex Wno-variadic-macros | |
| @item -Wvariadic-macros | |
| Warn if variadic macros are used in ISO C90 mode, or if the GNU | |
| alternate syntax is used in ISO C99 mode. This is enabled by either | |
| @option{-Wpedantic} or @option{-Wtraditional}. To inhibit the warning | |
| messages, use @option{-Wno-variadic-macros}. | |
| @opindex Wvarargs | |
| @opindex Wno-varargs | |
| @item -Wno-varargs | |
| Do not warn upon questionable usage of the macros used to handle variable | |
| arguments like @code{va_start}. These warnings are enabled by default. | |
| @opindex Wvector-operation-performance | |
| @opindex Wno-vector-operation-performance | |
| @item -Wvector-operation-performance | |
| Warn if vector operation is not implemented via SIMD capabilities of the | |
| architecture. Mainly useful for the performance tuning. | |
| Vector operation can be implemented @code{piecewise}, which means that the | |
| scalar operation is performed on every vector element; | |
| @code{in parallel}, which means that the vector operation is implemented | |
| using scalars of wider type, which normally is more performance efficient; | |
| and @code{as a single scalar}, which means that vector fits into a | |
| scalar type. | |
| @opindex Wvla | |
| @opindex Wno-vla | |
| @item -Wvla | |
| Warn if a variable-length array is used in the code. | |
| @option{-Wno-vla} prevents the @option{-Wpedantic} warning of | |
| the variable-length array. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wvla-larger-than= | |
| @opindex Wno-vla-larger-than | |
| @item -Wvla-larger-than=@var{byte-size} | |
| If this option is used, the compiler warns for declarations of | |
| variable-length arrays whose size is either unbounded, or bounded | |
| by an argument that allows the array size to exceed @var{byte-size} | |
| bytes. This is similar to how @option{-Walloca-larger-than=}@var{byte-size} | |
| works, but with variable-length arrays. | |
| Note that GCC may optimize small variable-length arrays of a known | |
| value into plain arrays, so this warning may not get triggered for | |
| such arrays. | |
| @option{-Wvla-larger-than=}@samp{PTRDIFF_MAX} is enabled by default but | |
| is typically only effective when @option{-ftree-vrp} is active (default | |
| for @option{-O2} and above). | |
| See also @option{-Walloca-larger-than=@var{byte-size}}. | |
| @opindex Wno-vla-larger-than | |
| @item -Wno-vla-larger-than | |
| Disable @option{-Wvla-larger-than=} warnings. The option is equivalent | |
| to @option{-Wvla-larger-than=}@samp{SIZE_MAX} or larger. | |
| @opindex Wvla-parameter | |
| @opindex Wno-vla-parameter | |
| @item -Wvla-parameter | |
| Warn about redeclarations of functions involving arguments of Variable | |
| Length Array types of inconsistent kinds or forms, and enable the detection | |
| of out-of-bounds accesses to such parameters by warnings such as | |
| @option{-Warray-bounds}. | |
| If the first function declaration uses the VLA form the bound specified | |
| in the array is assumed to be the minimum number of elements expected to | |
| be provided in calls to the function and the maximum number of elements | |
| accessed by it. Failing to provide arguments of sufficient size or | |
| accessing more than the maximum number of elements may be diagnosed. | |
| For example, the warning triggers for the following redeclarations because | |
| the first one allows an array of any size to be passed to @code{f} while | |
| the second one specifies that the array argument must have at least @code{n} | |
| elements. In addition, calling @code{f} with the associated VLA bound | |
| parameter in excess of the actual VLA bound triggers a warning as well. | |
| @smallexample | |
| void f (int n, int[n]); | |
| // warning: argument 2 previously declared as a VLA | |
| void f (int, int[]); | |
| void g (int n) | |
| @{ | |
| if (n > 4) | |
| return; | |
| int a[n]; | |
| // warning: access to a by f may be out of bounds | |
| f (sizeof a, a); | |
| @dots{} | |
| @} | |
| @end smallexample | |
| @option{-Wvla-parameter} is included in @option{-Wall}. The | |
| @option{-Warray-parameter} option triggers warnings for similar problems | |
| involving ordinary array arguments. | |
| @opindex Wvolatile-register-var | |
| @opindex Wno-volatile-register-var | |
| @item -Wvolatile-register-var | |
| Warn if a register variable is declared volatile. The volatile | |
| modifier does not inhibit all optimizations that may eliminate reads | |
| and/or writes to register variables. This warning is enabled by | |
| @option{-Wall}. | |
| @opindex Wxor-used-as-pow | |
| @opindex Wno-xor-used-as-pow | |
| @item -Wno-xor-used-as-pow @r{(C, C++, Objective-C and Objective-C++ only)} | |
| Disable warnings about uses of @code{^}, the exclusive or operator, | |
| where it appears the code meant exponentiation. | |
| Specifically, the warning occurs when the | |
| left-hand side is the decimal constant 2 or 10 and the right-hand side | |
| is also a decimal constant. | |
| In C and C++, @code{^} means exclusive or, whereas in some other languages | |
| (e.g. TeX and some versions of BASIC) it means exponentiation. | |
| This warning can be silenced by converting one of the operands to | |
| hexadecimal as well as by compiling with @option{-Wno-xor-used-as-pow}. | |
| @opindex Wdisabled-optimization | |
| @opindex Wno-disabled-optimization | |
| @item -Wdisabled-optimization | |
| Warn if a requested optimization pass is disabled. This warning does | |
| not generally indicate that there is anything wrong with your code; it | |
| merely indicates that GCC's optimizers are unable to handle the code | |
| effectively. Often, the problem is that your code is too big or too | |
| complex; GCC refuses to optimize programs when the optimization | |
| itself is likely to take inordinate amounts of time. | |
| @opindex Wpointer-sign | |
| @opindex Wno-pointer-sign | |
| @item -Wpointer-sign @r{(C and Objective-C only)} | |
| Warn for pointer argument passing or assignment with different signedness. | |
| This option is only supported for C and Objective-C@. It is implied by | |
| @option{-Wall} and by @option{-Wpedantic}, which can be disabled with | |
| @option{-Wno-pointer-sign}. | |
| This warning is upgraded to an error by @option{-pedantic-errors}. | |
| @opindex Wstack-protector | |
| @opindex Wno-stack-protector | |
| @item -Wstack-protector | |
| This option is only active when @option{-fstack-protector} is active. It | |
| warns about functions that are not protected against stack smashing. | |
| @opindex Woverlength-strings | |
| @opindex Wno-overlength-strings | |
| @item -Woverlength-strings | |
| Warn about string constants that are longer than the ``minimum | |
| maximum'' length specified in the C standard. Modern compilers | |
| generally allow string constants that are much longer than the | |
| standard's minimum limit, but very portable programs should avoid | |
| using longer strings. | |
| The limit applies @emph{after} string constant concatenation, and does | |
| not count the trailing NUL@. In C90, the limit was 509 characters; in | |
| C99, it was raised to 4095. C++98 does not specify a normative | |
| minimum maximum, so we do not diagnose overlength strings in C++@. | |
| This option is implied by @option{-Wpedantic}, and can be disabled with | |
| @option{-Wno-overlength-strings}. | |
| @opindex Wunsuffixed-float-constants | |
| @opindex Wno-unsuffixed-float-constants | |
| @item -Wunsuffixed-float-constants @r{(C and Objective-C only)} | |
| Issue a warning for any floating constant that does not have | |
| a suffix. When used together with @option{-Wsystem-headers} it | |
| warns about such constants in system header files. This can be useful | |
| when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma | |
| from the decimal floating-point extension to C99. | |
| @opindex Wlto-type-mismatch | |
| @opindex Wno-lto-type-mismatch | |
| @item -Wno-lto-type-mismatch | |
| During the link-time optimization, do not warn about type mismatches in | |
| global declarations from different compilation units. | |
| Requires @option{-flto} to be enabled. Enabled by default. | |
| @opindex Wdesignated-init | |
| @opindex Wno-designated-init | |
| @item -Wno-designated-init @r{(C and Objective-C only)} | |
| Suppress warnings when a positional initializer is used to initialize | |
| a structure that has been marked with the @code{designated_init} | |
| attribute. | |
| @opindex Wzero-init-padding-bits= | |
| @item -Wzero-init-padding-bits=@var{value} | |
| Warn about automatic variable initializers that might not zero | |
| initialize padding bits. | |
| Certain languages guarantee zero initialization of padding bits in | |
| certain cases. The @code{-fzero-init-padding-bits=unions} and | |
| @code{-fzero-init-padding-bits=all} options provide additional | |
| guarantees that padding bits will be zero initialized in other | |
| circumstances. | |
| This warning is mainly intended to find source code that might need to | |
| be modified or else recompiled with | |
| @code{-fzero-init-padding-bits=unions} or | |
| @code{-fzero-init-padding-bits=all} in order to retain the behavior | |
| that it had when compiled by versions of GCC older than 15.1. It can | |
| also be used to find code that might result in uninitialized struct | |
| padding unless GCC is invoked with @code{-fzero-init-padding-bits=all} | |
| (regardless of the fact that older versions of GCC would not have | |
| guaranteed initialization of struct padding either). | |
| It does not follow that all source code which causes warnings about | |
| uninitialized padding bits has undefined behavior: usually, the values | |
| of padding bits have no effect on execution of a program. | |
| The two options interact as follows: | |
| @multitable @columnfractions 0.25 0.25 0.25 0.25 | |
| @headitem @tab f:standard @tab f:unions @tab f:all | |
| @item W:standard @tab X @tab X @tab X | |
| @item W:unions @tab U @tab X @tab X | |
| @item W:all @tab A @tab S @tab X | |
| @end multitable | |
| @multitable @columnfractions .10 .90 | |
| @headitem Letter @tab Meaning | |
| @item X @tab No warnings about padding bits. | |
| @item U @tab Warnings about padding bits of unions. | |
| @item S @tab Warnings about padding bits of structs. | |
| @item A @tab Warnings about padding bits of structs and unions. | |
| @end multitable | |
| Examples of union initialization for ISO C23 with | |
| @code{-fzero-init-padding-bits=standard} and | |
| @code{-Wzero-init-padding-bits=unions}: | |
| @smallexample | |
| long long q; | |
| unsigned char r; | |
| union U @{ unsigned char a; long long b; @}; | |
| struct F @{ long long a; union U b; @}; | |
| // Padding bits are explicitly initialized | |
| union U h = @{@}; | |
| // Padding bits might not be initialized | |
| union U i = @{ r @}; | |
| // Padding bits might not be initialized | |
| union U j = @{ .a = r @}; | |
| // Union is expected to have no padding bits | |
| union U k = @{ .b = q @}; | |
| // Padding bits (of union) are explicitly initialized | |
| struct F l = @{ q, @{@}, .b.a = r @}; | |
| // Padding bits (of union) might not be initialized | |
| struct F m = @{ q, @{@}, .b = @{.a = r@} @}; | |
| @end smallexample | |
| In the declaration of @code{m}, an empty initializer that would otherwise | |
| guarantee zero initialization of the padding bits of the union (i.e., storage | |
| allocated for member @code{b} that is not part of member @code{a}) is | |
| overridden by a subsequently listed initializer. This is an anti-pattern. | |
| Whether or not a given initializer causes a warning to be produced can be | |
| predicted for simple cases but in general it is target-dependent because the | |
| layout of storage is target-dependent. The level of optimization, size, and | |
| initial value of the object being initialized also affect whether warnings are | |
| produced. | |
| @end table | |
| @node Static Analyzer Options | |
| @section Options That Control Static Analysis | |
| @table @gcctabopt | |
| @opindex analyzer | |
| @opindex fanalyzer | |
| @opindex fno-analyzer | |
| @item -fanalyzer | |
| This option enables an static analysis of program flow which looks | |
| for ``interesting'' interprocedural paths through the | |
| code, and issues warnings for problems found on them. | |
| This analysis is much more expensive than other GCC warnings. | |
| In technical terms, it performs coverage-guided symbolic execution of | |
| the code being compiled. It is neither sound nor complete: it can | |
| have false positives and false negatives. It is a bug-finding tool, | |
| rather than a tool for proving program correctness. | |
| The analyzer is only suitable for use on C code in this release. | |
| Enabling this option effectively enables the following warnings: | |
| @gccoptlist{ | |
| -Wanalyzer-allocation-size | |
| -Wanalyzer-deref-before-check | |
| -Wanalyzer-div-by-zero | |
| -Wanalyzer-double-fclose | |
| -Wanalyzer-double-free | |
| -Wanalyzer-exposure-through-output-file | |
| -Wanalyzer-exposure-through-uninit-copy | |
| -Wanalyzer-fd-access-mode-mismatch | |
| -Wanalyzer-fd-double-close | |
| -Wanalyzer-fd-leak | |
| -Wanalyzer-fd-phase-mismatch | |
| -Wanalyzer-fd-type-mismatch | |
| -Wanalyzer-fd-use-after-close | |
| -Wanalyzer-fd-use-without-check | |
| -Wanalyzer-file-leak | |
| -Wanalyzer-free-of-non-heap | |
| -Wanalyzer-imprecise-fp-arithmetic | |
| -Wanalyzer-infinite-loop | |
| -Wanalyzer-infinite-recursion | |
| -Wanalyzer-jump-through-null | |
| -Wanalyzer-malloc-leak | |
| -Wanalyzer-mismatching-deallocation | |
| -Wanalyzer-mkostemp-redundant-flags | |
| -Wanalyzer-mktemp-missing-placeholder | |
| -Wanalyzer-mktemp-of-string-literal | |
| -Wanalyzer-null-argument | |
| -Wanalyzer-null-dereference | |
| -Wanalyzer-out-of-bounds | |
| -Wanalyzer-overlapping-buffers | |
| -Wanalyzer-possible-null-argument | |
| -Wanalyzer-possible-null-dereference | |
| -Wanalyzer-putenv-of-auto-var | |
| -Wanalyzer-shift-count-negative | |
| -Wanalyzer-shift-count-overflow | |
| -Wanalyzer-stale-setjmp-buffer | |
| -Wanalyzer-tainted-allocation-size | |
| -Wanalyzer-tainted-array-index | |
| -Wanalyzer-tainted-assertion | |
| -Wanalyzer-tainted-divisor | |
| -Wanalyzer-tainted-offset | |
| -Wanalyzer-tainted-size | |
| -Wanalyzer-throw-of-unexpected-type | |
| -Wanalyzer-undefined-behavior-ptrdiff | |
| -Wanalyzer-undefined-behavior-strtok | |
| -Wanalyzer-unsafe-call-within-signal-handler | |
| -Wanalyzer-use-after-free | |
| -Wanalyzer-use-of-pointer-in-stale-stack-frame | |
| -Wanalyzer-use-of-uninitialized-value | |
| -Wanalyzer-va-arg-type-mismatch | |
| -Wanalyzer-va-list-exhausted | |
| -Wanalyzer-va-list-leak | |
| -Wanalyzer-va-list-use-after-va-end | |
| -Wanalyzer-write-to-const | |
| -Wanalyzer-write-to-string-literal | |
| } | |
| This option is only available if GCC was configured with analyzer | |
| support enabled. | |
| @opindex Wanalyzer-symbol-too-complex | |
| @opindex Wno-analyzer-symbol-too-complex | |
| @item -Wanalyzer-symbol-too-complex | |
| If @option{-fanalyzer} is enabled, the analyzer uses various heuristics | |
| to attempt to track the state of memory, but these can be defeated by | |
| sufficiently complicated code. | |
| By default, the analysis silently stops tracking values of expressions | |
| if they exceed an internal limit, and falls back | |
| to an imprecise representation for such expressions. | |
| The @option{-Wanalyzer-symbol-too-complex} option warns if this occurs. | |
| @opindex Wanalyzer-too-complex | |
| @opindex Wno-analyzer-too-complex | |
| @item -Wanalyzer-too-complex | |
| If @option{-fanalyzer} is enabled, the analyzer uses various heuristics | |
| to attempt to explore the control flow and data flow in the program, | |
| but these can be defeated by sufficiently complicated code. | |
| By default, the analysis silently stops if the code is too | |
| complicated for the analyzer to fully explore and it reaches an internal | |
| limit. The @option{-Wanalyzer-too-complex} option warns if this occurs. | |
| @opindex Wanalyzer-allocation-size | |
| @opindex Wno-analyzer-allocation-size | |
| @item -Wno-analyzer-allocation-size | |
| This warning requires @option{-fanalyzer}, which enables it; | |
| to disable it, use @option{-Wno-analyzer-allocation-size}. | |
| This diagnostic warns for paths through the code in which a pointer to | |
| a buffer is assigned to point at a buffer with a size that is not a | |
| multiple of @code{sizeof (*pointer)}. | |
| See @uref{https://cwe.mitre.org/data/definitions/131.html, CWE-131: Incorrect Calculation of Buffer Size}. | |
| @opindex Wanalyzer-div-by-zero | |
| @opindex Wno-analyzer-div-by-zero | |
| @item -Wno-analyzer-div-by-zero | |
| This warning requires @option{-fanalyzer}, which enables it; | |
| to disable it, use @option{-Wno-analyzer-div-by-zero}. | |
| This diagnostic warns for paths through the code which attempt | |
| integer division by zero. It is analogous to @option{-Wdiv-by-zero}, but | |
| implemented in a different way. | |
| See @uref{https://cwe.mitre.org/data/definitions/369.html, CWE-369: Divide By Zero}. | |
| @opindex Wanalyzer-deref-before-check | |
| @opindex Wno-analyzer-deref-before-check | |
| @item -Wno-analyzer-deref-before-check | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-deref-before-check} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which a pointer | |
| is checked for @code{NULL} *after* it has already been | |
| dereferenced, suggesting that the pointer could have been NULL. | |
| Such cases suggest that the check for NULL is either redundant, | |
| or that it needs to be moved to before the pointer is dereferenced. | |
| This diagnostic also considers values passed to a function argument | |
| marked with @code{__attribute__((nonnull))} as requiring a non-NULL | |
| value, and thus will complain if such values are checked for @code{NULL} | |
| after returning from such a function call. | |
| This diagnostic is unlikely to be reported when any level of optimization | |
| is enabled, as GCC's optimization logic will typically consider such | |
| checks for NULL as being redundant, and optimize them away before the | |
| analyzer "sees" them. Hence optimization should be disabled when | |
| attempting to trigger this diagnostic. | |
| @opindex Wanalyzer-double-fclose | |
| @opindex Wno-analyzer-double-fclose | |
| @item -Wno-analyzer-double-fclose | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-double-fclose} to disable it. | |
| This diagnostic warns for paths through the code in which a @code{FILE *} | |
| can have @code{fclose} called on it more than once. | |
| See @uref{https://cwe.mitre.org/data/definitions/1341.html, CWE-1341: Multiple Releases of Same Resource or Handle}. | |
| @opindex Wanalyzer-double-free | |
| @opindex Wno-analyzer-double-free | |
| @item -Wno-analyzer-double-free | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-double-free} to disable it. | |
| This diagnostic warns for paths through the code in which a pointer | |
| can have a deallocator called on it more than once, either @code{free}, | |
| or a deallocator referenced by attribute @code{malloc}. | |
| See @uref{https://cwe.mitre.org/data/definitions/415.html, CWE-415: Double Free}. | |
| @opindex Wanalyzer-exposure-through-output-file | |
| @opindex Wno-analyzer-exposure-through-output-file | |
| @item -Wno-analyzer-exposure-through-output-file | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-exposure-through-output-file} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| security-sensitive value is written to an output file | |
| (such as writing a password to a log file). | |
| See @uref{https://cwe.mitre.org/data/definitions/532.html, CWE-532: Information Exposure Through Log Files}. | |
| @opindex Wanalyzer-exposure-through-uninit-copy | |
| @opindex Wno-analyzer-exposure-through-uninit-copy | |
| @item -Wanalyzer-exposure-through-uninit-copy | |
| This warning requires both @option{-fanalyzer} and the use of a plugin | |
| to specify a function that copies across a ``trust boundary''. Use | |
| @option{-Wno-analyzer-exposure-through-uninit-copy} to disable it. | |
| This diagnostic warns for ``infoleaks'' - paths through the code in which | |
| uninitialized values are copied across a security boundary | |
| (such as code within an OS kernel that copies a partially-initialized | |
| struct on the stack to user space). | |
| See @uref{https://cwe.mitre.org/data/definitions/200.html, CWE-200: Exposure of Sensitive Information to an Unauthorized Actor}. | |
| @opindex Wanalyzer-fd-access-mode-mismatch | |
| @opindex Wno-analyzer-fd-access-mode-mismatch | |
| @item -Wno-analyzer-fd-access-mode-mismatch | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-fd-access-mode-mismatch} | |
| to disable it. | |
| This diagnostic warns for paths through code in which a | |
| @code{read} on a write-only file descriptor is attempted, or vice versa. | |
| This diagnostic also warns for code paths in a which a function with attribute | |
| @code{fd_arg_read (N)} is called with a file descriptor opened with | |
| @code{O_WRONLY} at referenced argument @code{N} or a function with attribute | |
| @code{fd_arg_write (N)} is called with a file descriptor opened with | |
| @code{O_RDONLY} at referenced argument @var{N}. | |
| @opindex Wanalyzer-fd-double-close | |
| @opindex Wno-analyzer-fd-double-close | |
| @item -Wno-analyzer-fd-double-close | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-fd-double-close} | |
| to disable it. | |
| This diagnostic warns for paths through code in which a | |
| file descriptor can be closed more than once. | |
| See @uref{https://cwe.mitre.org/data/definitions/1341.html, CWE-1341: Multiple Releases of Same Resource or Handle}. | |
| @opindex Wanalyzer-fd-leak | |
| @opindex Wno-analyzer-fd-leak | |
| @item -Wno-analyzer-fd-leak | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-fd-leak} | |
| to disable it. | |
| This diagnostic warns for paths through code in which an | |
| open file descriptor is leaked. | |
| See @uref{https://cwe.mitre.org/data/definitions/775.html, CWE-775: Missing Release of File Descriptor or Handle after Effective Lifetime}. | |
| @opindex Wanalyzer-fd-phase-mismatch | |
| @opindex Wno-analyzer-fd-phase-mismatch | |
| @item -Wno-analyzer-fd-phase-mismatch | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-fd-phase-mismatch} | |
| to disable it. | |
| This diagnostic warns for paths through code in which an operation is | |
| attempted in the wrong phase of a file descriptor's lifetime. | |
| For example, it will warn on attempts to call @code{accept} on a stream | |
| socket that has not yet had @code{listen} successfully called on it. | |
| See @uref{https://cwe.mitre.org/data/definitions/666.html, CWE-666: Operation on Resource in Wrong Phase of Lifetime}. | |
| @opindex Wanalyzer-fd-type-mismatch | |
| @opindex Wno-analyzer-fd-type-mismatch | |
| @item -Wno-analyzer-fd-type-mismatch | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-fd-type-mismatch} | |
| to disable it. | |
| This diagnostic warns for paths through code in which an | |
| operation is attempted on the wrong type of file descriptor. | |
| For example, it will warn on attempts to use socket operations | |
| on a file descriptor obtained via @code{open}, or when attempting | |
| to use a stream socket operation on a datagram socket. | |
| @opindex Wanalyzer-fd-use-after-close | |
| @opindex Wno-analyzer-fd-use-after-close | |
| @item -Wno-analyzer-fd-use-after-close | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-fd-use-after-close} | |
| to disable it. | |
| This diagnostic warns for paths through code in which a | |
| read or write is called on a closed file descriptor. | |
| This diagnostic also warns for paths through code in which | |
| a function with attribute @code{fd_arg (N)} or @code{fd_arg_read (N)} | |
| or @code{fd_arg_write (N)} is called with a closed file descriptor at | |
| referenced argument @code{N}. | |
| @opindex Wanalyzer-fd-use-without-check | |
| @opindex Wno-analyzer-fd-use-without-check | |
| @item -Wno-analyzer-fd-use-without-check | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-fd-use-without-check} | |
| to disable it. | |
| This diagnostic warns for paths through code in which a | |
| file descriptor is used without being checked for validity. | |
| This diagnostic also warns for paths through code in which | |
| a function with attribute @code{fd_arg (N)} or @code{fd_arg_read (N)} | |
| or @code{fd_arg_write (N)} is called with a file descriptor, at referenced | |
| argument @code{N}, without being checked for validity. | |
| @opindex Wanalyzer-file-leak | |
| @opindex Wno-analyzer-file-leak | |
| @item -Wno-analyzer-file-leak | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-file-leak} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| @code{<stdio.h>} @code{FILE *} stream object is leaked. | |
| See @uref{https://cwe.mitre.org/data/definitions/775.html, CWE-775: Missing Release of File Descriptor or Handle after Effective Lifetime}. | |
| @opindex Wanalyzer-free-of-non-heap | |
| @opindex Wno-analyzer-free-of-non-heap | |
| @item -Wno-analyzer-free-of-non-heap | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-free-of-non-heap} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which @code{free} | |
| is called on a non-heap pointer (e.g. an on-stack buffer, or a global). | |
| See @uref{https://cwe.mitre.org/data/definitions/590.html, CWE-590: Free of Memory not on the Heap}. | |
| @opindex Wanalyzer-imprecise-fp-arithmetic | |
| @opindex Wno-analyzer-imprecise-fp-arithmetic | |
| @item -Wno-analyzer-imprecise-fp-arithmetic | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-imprecise-fp-arithmetic} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which floating-point | |
| arithmetic is used in locations where precise computation is needed. This | |
| diagnostic only warns on use of floating-point operands inside the | |
| calculation of an allocation size at the moment. | |
| @opindex Wanalyzer-infinite-loop | |
| @opindex Wno-analyzer-infinite-loop | |
| @item -Wno-analyzer-infinite-loop | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-infinite-loop} to disable it. | |
| This diagnostics warns for paths through the code which appear to | |
| lead to an infinite loop. | |
| Specifically, the analyzer will issue this warning when it "sees" a loop | |
| in which: | |
| @itemize @bullet | |
| @item | |
| no externally-visible work could be being done within the loop | |
| @item | |
| there is no way to escape from the loop | |
| @item | |
| the analyzer is sufficiently confident about the program state | |
| throughout the loop to know that the above are true | |
| @end itemize | |
| One way for this warning to be emitted is when there is an execution | |
| path through a loop for which taking the path on one iteration implies | |
| that the same path will be taken on all subsequent iterations. | |
| For example, consider: | |
| @smallexample | |
| while (1) | |
| @{ | |
| char opcode = *cpu_state.pc; | |
| switch (opcode) | |
| @{ | |
| case OPCODE_FOO: | |
| handle_opcode_foo (&cpu_state); | |
| break; | |
| case OPCODE_BAR: | |
| handle_opcode_bar (&cpu_state); | |
| break; | |
| @} | |
| @} | |
| @end smallexample | |
| The analyzer will complain for the above case because if @code{opcode} | |
| ever matches none of the cases, the @code{switch} will follow the | |
| implicit @code{default} case, making the body of the loop be a ``no-op'' | |
| with @code{cpu_state.pc} unchanged, and thus using the same value of | |
| @code{opcode} on all subsequent iterations, leading to an infinite loop. | |
| See @uref{https://cwe.mitre.org/data/definitions/835.html, CWE-835: Loop with Unreachable Exit Condition ('Infinite Loop')}. | |
| @opindex Wanalyzer-infinite-recursion | |
| @opindex Wno-analyzer-infinite-recursion | |
| @item -Wno-analyzer-infinite-recursion | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-infinite-recursion} to disable it. | |
| This diagnostics warns for paths through the code which appear to | |
| lead to infinite recursion. | |
| Specifically, when the analyzer "sees" a recursive call, it will compare | |
| the state of memory at the entry to the new frame with that at the entry | |
| to the previous frame of that function on the stack. The warning is | |
| issued if nothing in memory appears to be changing; any changes observed | |
| to parameters or globals are assumed to lead to termination of the | |
| recursion and thus suppress the warning. | |
| This diagnostic is likely to miss cases of infinite recursion that | |
| are converted to iteration by the optimizer before the analyzer "sees" | |
| them. Hence optimization should be disabled when attempting to trigger | |
| this diagnostic. | |
| Compare with @option{-Winfinite-recursion}, which provides a similar | |
| diagnostic, but is implemented in a different way. | |
| See @uref{https://cwe.mitre.org/data/definitions/674.html, CWE-674: Uncontrolled Recursion}. | |
| @opindex Wanalyzer-jump-through-null | |
| @opindex Wno-analyzer-jump-through-null | |
| @item -Wno-analyzer-jump-through-null | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-jump-through-null} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which a @code{NULL} | |
| function pointer is called. | |
| @opindex Wanalyzer-malloc-leak | |
| @opindex Wno-analyzer-malloc-leak | |
| @item -Wno-analyzer-malloc-leak | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-malloc-leak} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| pointer allocated via an allocator is leaked: either @code{malloc}, | |
| or a function marked with attribute @code{malloc}. | |
| See @uref{https://cwe.mitre.org/data/definitions/401.html, CWE-401: Missing Release of Memory after Effective Lifetime}. | |
| @opindex Wanalyzer-mismatching-deallocation | |
| @opindex Wno-analyzer-mismatching-deallocation | |
| @item -Wno-analyzer-mismatching-deallocation | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-mismatching-deallocation} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which the | |
| wrong deallocation function is called on a pointer value, based on | |
| which function was used to allocate the pointer value. The diagnostic | |
| will warn about mismatches between @code{free}, scalar @code{delete} | |
| and vector @code{delete[]}, and those marked as allocator/deallocator | |
| pairs using attribute @code{malloc}. | |
| See @uref{https://cwe.mitre.org/data/definitions/762.html, CWE-762: Mismatched Memory Management Routines}. | |
| @opindex Wanalyzer-mkostemp-redundant-flags | |
| @opindex Wno-analyzer-mkostemp-redundant-flags | |
| @item -Wno-analyzer-mkostemp-redundant-flags | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-mkostemp-redundant-flags} to disable it. | |
| This diagnostic warns for paths through the code in which | |
| @code{mkostemp} or @code{mkostemps} is called with flags that include | |
| @code{O_RDWR}, @code{O_CREAT}, or @code{O_EXCL}. These flags are | |
| already implied by the function and specifying them is unnecessary, and | |
| produces errors on some systems. | |
| @opindex Wanalyzer-mktemp-missing-placeholder | |
| @opindex Wno-analyzer-mktemp-missing-placeholder | |
| @item -Wno-analyzer-mktemp-missing-placeholder | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-mktemp-missing-placeholder} to disable it. | |
| This diagnostic warns for paths through the code in which a function in | |
| the @code{mktemp} family (@code{mkstemp}, @code{mkostemp}, | |
| @code{mkstemps}, @code{mkostemps}, @code{mkdtemp}, @code{mktemp}) is | |
| called with a template string that does not contain the placeholder | |
| @samp{XXXXXX} at the expected position. | |
| @opindex Wanalyzer-mktemp-of-string-literal | |
| @opindex Wno-analyzer-mktemp-of-string-literal | |
| @item -Wno-analyzer-mktemp-of-string-literal | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-mktemp-of-string-literal} to disable it. | |
| This diagnostic warns for paths through the code in which a function in | |
| the @code{mktemp} family (@code{mkstemp}, @code{mkostemp}, | |
| @code{mkstemps}, @code{mkostemps}, @code{mkdtemp}, @code{mktemp}) is | |
| called on a string literal. Since these functions modify their argument | |
| in place, passing a string literal leads to undefined behavior. | |
| See @uref{https://wiki.sei.cmu.edu/confluence/x/VtYxBQ, STR30-C. Do not attempt to modify string literals}. | |
| @opindex Wanalyzer-out-of-bounds | |
| @opindex Wno-analyzer-out-of-bounds | |
| @item -Wno-analyzer-out-of-bounds | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-out-of-bounds} to disable it. | |
| This diagnostic warns for paths through the code in which a buffer is | |
| definitely read or written out-of-bounds. The diagnostic applies for | |
| cases where the analyzer is able to determine a constant offset and for | |
| accesses past the end of a buffer, also a constant capacity. Further, | |
| the diagnostic does limited checking for accesses past the end when the | |
| offset as well as the capacity is symbolic. | |
| See @uref{https://cwe.mitre.org/data/definitions/119.html, CWE-119: Improper Restriction of Operations within the Bounds of a Memory Buffer}. | |
| For cases where the analyzer is able, it will emit a text art diagram | |
| visualizing the spatial relationship between the memory region that the | |
| analyzer predicts would be accessed, versus the range of memory that is | |
| valid to access: whether they overlap, are touching, are close or far | |
| apart; which one is before or after in memory, the relative sizes | |
| involved, the direction of the access (read vs write), and, in some | |
| cases, the values of data involved. This diagram can be suppressed | |
| using @option{-fdiagnostics-text-art-charset=none}. | |
| @opindex Wanalyzer-overlapping-buffers | |
| @opindex Wno-analyzer-overlapping-buffers | |
| @item -Wno-analyzer-overlapping-buffers | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-overlapping-buffers} to disable it. | |
| This diagnostic warns for paths through the code in which overlapping | |
| buffers are passed to an API for which the behavior on such buffers | |
| is undefined. | |
| Specifically, the diagnostic occurs on calls to the following functions | |
| @itemize @bullet | |
| @item @code{memcpy} | |
| @item @code{strcat} | |
| @item @code{strcpy} | |
| @end itemize | |
| for cases where the buffers are known to overlap. | |
| @opindex Wanalyzer-possible-null-argument | |
| @opindex Wno-analyzer-possible-null-argument | |
| @item -Wno-analyzer-possible-null-argument | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-possible-null-argument} to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| possibly-NULL value is passed to a function argument marked | |
| with @code{__attribute__((nonnull))} as requiring a non-NULL | |
| value. | |
| See @uref{https://cwe.mitre.org/data/definitions/690.html, CWE-690: Unchecked Return Value to NULL Pointer Dereference}. | |
| @opindex Wanalyzer-possible-null-dereference | |
| @opindex Wno-analyzer-possible-null-dereference | |
| @item -Wno-analyzer-possible-null-dereference | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-possible-null-dereference} to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| possibly-NULL value is dereferenced. | |
| See @uref{https://cwe.mitre.org/data/definitions/690.html, CWE-690: Unchecked Return Value to NULL Pointer Dereference}. | |
| @opindex Wanalyzer-null-argument | |
| @opindex Wno-analyzer-null-argument | |
| @item -Wno-analyzer-null-argument | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-null-argument} to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| value known to be NULL is passed to a function argument marked | |
| with @code{__attribute__((nonnull))} as requiring a non-NULL | |
| value. | |
| See @uref{https://cwe.mitre.org/data/definitions/476.html, CWE-476: NULL Pointer Dereference}. | |
| @opindex Wanalyzer-null-dereference | |
| @opindex Wno-analyzer-null-dereference | |
| @item -Wno-analyzer-null-dereference | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-null-dereference} to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| value known to be NULL is dereferenced. | |
| See @uref{https://cwe.mitre.org/data/definitions/476.html, CWE-476: NULL Pointer Dereference}. | |
| @opindex Wanalyzer-putenv-of-auto-var | |
| @opindex Wno-analyzer-putenv-of-auto-var | |
| @item -Wno-analyzer-putenv-of-auto-var | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-putenv-of-auto-var} to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| call to @code{putenv} is passed a pointer to an automatic variable | |
| or an on-stack buffer. | |
| See @uref{https://wiki.sei.cmu.edu/confluence/x/6NYxBQ, POS34-C. Do not call putenv() with a pointer to an automatic variable as the argument}. | |
| @opindex Wanalyzer-shift-count-negative | |
| @opindex Wno-analyzer-shift-count-negative | |
| @item -Wno-analyzer-shift-count-negative | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-shift-count-negative} to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| shift is attempted with a negative count. It is analogous to | |
| the @option{-Wshift-count-negative} diagnostic implemented in | |
| the C/C++ front ends, but is implemented based on analyzing | |
| interprocedural paths, rather than merely parsing the syntax tree. | |
| However, the analyzer does not prioritize detection of such paths, so | |
| false negatives are more likely relative to other warnings. | |
| @opindex Wanalyzer-shift-count-overflow | |
| @opindex Wno-analyzer-shift-count-overflow | |
| @item -Wno-analyzer-shift-count-overflow | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-shift-count-overflow} to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| shift is attempted with a count greater than or equal to the | |
| precision of the operand's type. It is analogous to | |
| the @option{-Wshift-count-overflow} diagnostic implemented in | |
| the C/C++ front ends, but is implemented based on analyzing | |
| interprocedural paths, rather than merely parsing the syntax tree. | |
| However, the analyzer does not prioritize detection of such paths, so | |
| false negatives are more likely relative to other warnings. | |
| @opindex Wanalyzer-stale-setjmp-buffer | |
| @opindex Wno-analyzer-stale-setjmp-buffer | |
| @item -Wno-analyzer-stale-setjmp-buffer | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-stale-setjmp-buffer} to disable it. | |
| This diagnostic warns for paths through the code in which | |
| @code{longjmp} is called to rewind to a @code{jmp_buf} relating | |
| to a @code{setjmp} call in a function that has returned. | |
| When @code{setjmp} is called on a @code{jmp_buf} to record a rewind | |
| location, it records the stack frame. The stack frame becomes invalid | |
| when the function containing the @code{setjmp} call returns. Attempting | |
| to rewind to it via @code{longjmp} would reference a stack frame that | |
| no longer exists, and likely lead to a crash (or worse). | |
| @opindex Wanalyzer-tainted-allocation-size | |
| @opindex Wno-analyzer-tainted-allocation-size | |
| @item -Wno-analyzer-tainted-allocation-size | |
| This warning requires @option{-fanalyzer} which enables it; | |
| use @option{-Wno-analyzer-tainted-allocation-size} to disable it. | |
| This diagnostic warns for paths through the code in which a value | |
| that could be under an attacker's control is used as the size | |
| of an allocation without being sanitized, so that an attacker could | |
| inject an excessively large allocation and potentially cause a denial | |
| of service attack. | |
| See @uref{https://cwe.mitre.org/data/definitions/789.html, CWE-789: Memory Allocation with Excessive Size Value}. | |
| @opindex Wanalyzer-tainted-assertion | |
| @opindex Wno-analyzer-tainted-assertion | |
| @item -Wno-analyzer-tainted-assertion | |
| This warning requires @option{-fanalyzer} which enables it; | |
| use @option{-Wno-analyzer-tainted-assertion} to disable it. | |
| This diagnostic warns for paths through the code in which a value | |
| that could be under an attacker's control is used as part of a | |
| condition without being first sanitized, and that condition guards a | |
| call to a function marked with attribute @code{noreturn} | |
| (such as the function @code{__builtin_unreachable}). Such functions | |
| typically indicate abnormal termination of the program, such as for | |
| assertion failure handlers. For example: | |
| @smallexample | |
| assert (some_tainted_value < SOME_LIMIT); | |
| @end smallexample | |
| In such cases: | |
| @itemize | |
| @item | |
| when assertion-checking is enabled: an attacker could trigger | |
| a denial of service by injecting an assertion failure | |
| @item | |
| when assertion-checking is disabled, such as by defining @code{NDEBUG}, | |
| an attacker could inject data that subverts the process, since it | |
| presumably violates a precondition that is being assumed by the code. | |
| @end itemize | |
| Note that when assertion-checking is disabled, the assertions are | |
| typically removed by the preprocessor before the analyzer has a chance | |
| to "see" them, so this diagnostic can only generate warnings on builds | |
| in which assertion-checking is enabled. | |
| For the purpose of this warning, any function marked with attribute | |
| @code{noreturn} is considered as a possible assertion failure | |
| handler, including @code{__builtin_unreachable}. Note that these functions | |
| are sometimes removed by the optimizer before the analyzer "sees" them. | |
| Hence optimization should be disabled when attempting to trigger this | |
| diagnostic. | |
| See @uref{https://cwe.mitre.org/data/definitions/617.html, CWE-617: Reachable Assertion}. | |
| The warning can also report problematic constructions such as | |
| @smallexample | |
| switch (some_tainted_value) @{ | |
| case 0: | |
| /* [...etc; various valid cases omitted...] */ | |
| break; | |
| default: | |
| __builtin_unreachable (); /* BUG: attacker can trigger this */ | |
| @} | |
| @end smallexample | |
| despite the above not being an assertion failure, strictly speaking. | |
| @opindex Wanalyzer-tainted-array-index | |
| @opindex Wno-analyzer-tainted-array-index | |
| @item -Wno-analyzer-tainted-array-index | |
| This warning requires @option{-fanalyzer} which enables it; | |
| use @option{-Wno-analyzer-tainted-array-index} to disable it. | |
| This diagnostic warns for paths through the code in which a value | |
| that could be under an attacker's control is used as the index | |
| of an array access without being sanitized, so that an attacker | |
| could inject an out-of-bounds access. | |
| See @uref{https://cwe.mitre.org/data/definitions/129.html, CWE-129: Improper Validation of Array Index}. | |
| @opindex Wanalyzer-tainted-divisor | |
| @opindex Wno-analyzer-tainted-divisor | |
| @item -Wno-analyzer-tainted-divisor | |
| This warning requires @option{-fanalyzer} which enables it; | |
| use @option{-Wno-analyzer-tainted-divisor} to disable it. | |
| This diagnostic warns for paths through the code in which a value | |
| that could be under an attacker's control is used as the divisor | |
| in a division or modulus operation without being sanitized, so that | |
| an attacker could inject a division-by-zero. | |
| See @uref{https://cwe.mitre.org/data/definitions/369.html, CWE-369: Divide By Zero}. | |
| @opindex Wanalyzer-tainted-offset | |
| @opindex Wno-analyzer-tainted-offset | |
| @item -Wno-analyzer-tainted-offset | |
| This warning requires @option{-fanalyzer} which enables it; | |
| use @option{-Wno-analyzer-tainted-offset} to disable it. | |
| This diagnostic warns for paths through the code in which a value | |
| that could be under an attacker's control is used as a pointer offset | |
| without being sanitized, so that an attacker could inject an out-of-bounds | |
| access. | |
| See @uref{https://cwe.mitre.org/data/definitions/823.html, CWE-823: Use of Out-of-range Pointer Offset}. | |
| @opindex Wanalyzer-tainted-size | |
| @opindex Wno-analyzer-tainted-size | |
| @item -Wno-analyzer-tainted-size | |
| This warning requires @option{-fanalyzer} which enables it; | |
| use @option{-Wno-analyzer-tainted-size} to disable it. | |
| This diagnostic warns for paths through the code in which a value | |
| that could be under an attacker's control is used as the size of | |
| an operation such as @code{memset} without being sanitized, so that an | |
| attacker could inject an out-of-bounds access. | |
| See @uref{https://cwe.mitre.org/data/definitions/129.html, CWE-129: Improper Validation of Array Index}. | |
| @opindex Wanalyzer-throw-of-unexpected-type | |
| @opindex Wno-analyzer-throw-of-unexpected-type | |
| @item -Wno-analyzer-throw-of-unexpected-type | |
| This warning requires @option{-fanalyzer} which enables it; | |
| use @option{-Wno-analyzer-throw-of-unexpected-type} to disable it. | |
| Dynamic exception specifications are only available in C++14 and earlier. | |
| This diagnostic warns for paths through the code in which a an exception | |
| is thrown from a function with a dynamic exception specification where | |
| the exception does not comply with the specification. | |
| @opindex Wanalyzer-undefined-behavior-ptrdiff | |
| @opindex Wno-analyzer-undefined-behavior-ptrdiff | |
| @item -Wno-analyzer-undefined-behavior-ptrdiff | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-undefined-behavior-ptrdiff} to disable it. | |
| This diagnostic warns for paths through the code in which a pointer | |
| subtraction occurs where the pointers refer to different chunks of | |
| memory. Such code relies on undefined behavior, as pointer subtraction | |
| is only defined for cases where both pointers point to within (or just | |
| after) the same array. | |
| See @uref{https://cwe.mitre.org/data/definitions/469.html, CWE-469: Use of Pointer Subtraction to Determine Size}. | |
| @opindex Wanalyzer-undefined-behavior-strtok | |
| @opindex Wno-analyzer-undefined-behavior-strtok | |
| @item -Wno-analyzer-undefined-behavior-strtok | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-undefined-behavior-strtok} to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| call is made to @code{strtok} with undefined behavior. | |
| Specifically, passing NULL as the first parameter for the initial | |
| call to @code{strtok} within a process has undefined behavior. | |
| @opindex Wanalyzer-unsafe-call-within-signal-handler | |
| @opindex Wno-analyzer-unsafe-call-within-signal-handler | |
| @item -Wno-analyzer-unsafe-call-within-signal-handler | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-unsafe-call-within-signal-handler} to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| function known to be async-signal-unsafe (such as @code{fprintf}) is | |
| called from a signal handler. | |
| See @uref{https://cwe.mitre.org/data/definitions/479.html, CWE-479: Signal Handler Use of a Non-reentrant Function}. | |
| @opindex Wanalyzer-use-after-free | |
| @opindex Wno-analyzer-use-after-free | |
| @item -Wno-analyzer-use-after-free | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-use-after-free} to disable it. | |
| This diagnostic warns for paths through the code in which a | |
| pointer is used after a deallocator is called on it: either @code{free}, | |
| or a deallocator referenced by attribute @code{malloc}. | |
| See @uref{https://cwe.mitre.org/data/definitions/416.html, CWE-416: Use After Free}. | |
| @opindex Wanalyzer-use-of-pointer-in-stale-stack-frame | |
| @opindex Wno-analyzer-use-of-pointer-in-stale-stack-frame | |
| @item -Wno-analyzer-use-of-pointer-in-stale-stack-frame | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-use-of-pointer-in-stale-stack-frame} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which a pointer | |
| is dereferenced that points to a variable in a stale stack frame. | |
| @opindex Wanalyzer-va-arg-type-mismatch | |
| @opindex Wno-analyzer-va-arg-type-mismatch | |
| @item -Wno-analyzer-va-arg-type-mismatch | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-va-arg-type-mismatch} | |
| to disable it. | |
| This diagnostic warns for interprocedural paths through the code for which | |
| the analyzer detects an attempt to use @code{va_arg} to extract a value | |
| passed to a variadic call, but uses a type that does not match that of | |
| the expression passed to the call. | |
| See @uref{https://cwe.mitre.org/data/definitions/686.html, CWE-686: Function Call With Incorrect Argument Type}. | |
| @opindex Wanalyzer-va-list-exhausted | |
| @opindex Wno-analyzer-va-list-exhausted | |
| @item -Wno-analyzer-va-list-exhausted | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-va-list-exhausted} | |
| to disable it. | |
| This diagnostic warns for interprocedural paths through the code for which | |
| the analyzer detects an attempt to use @code{va_arg} to access the next | |
| value passed to a variadic call, but all of the values in the | |
| @code{va_list} have already been consumed. | |
| See @uref{https://cwe.mitre.org/data/definitions/685.html, CWE-685: Function Call With Incorrect Number of Arguments}. | |
| @opindex Wanalyzer-va-list-leak | |
| @opindex Wno-analyzer-va-list-leak | |
| @item -Wno-analyzer-va-list-leak | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-va-list-leak} | |
| to disable it. | |
| This diagnostic warns for interprocedural paths through the code for which | |
| the analyzer detects that @code{va_start} or @code{va_copy} has been called | |
| on a @code{va_list} without a corresponding call to @code{va_end}. | |
| @opindex Wanalyzer-va-list-use-after-va-end | |
| @opindex Wno-analyzer-va-list-use-after-va-end | |
| @item -Wno-analyzer-va-list-use-after-va-end | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-va-list-use-after-va-end} | |
| to disable it. | |
| This diagnostic warns for interprocedural paths through the code for which | |
| the analyzer detects an attempt to use a @code{va_list} after | |
| @code{va_end} has been called on it. | |
| @code{va_list}. | |
| @opindex Wanalyzer-write-to-const | |
| @opindex Wno-analyzer-write-to-const | |
| @item -Wno-analyzer-write-to-const | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-write-to-const} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which the analyzer | |
| detects an attempt to write through a pointer to a @code{const} object. | |
| However, the analyzer does not prioritize detection of such paths, so | |
| false negatives are more likely relative to other warnings. | |
| @opindex Wanalyzer-write-to-string-literal | |
| @opindex Wno-analyzer-write-to-string-literal | |
| @item -Wno-analyzer-write-to-string-literal | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-write-to-string-literal} | |
| to disable it. | |
| This diagnostic warns for paths through the code in which the analyzer | |
| detects an attempt to write through a pointer to a string literal. | |
| However, the analyzer does not prioritize detection of such paths, so | |
| false negatives are more likely relative to other warnings. | |
| @opindex Wanalyzer-use-of-uninitialized-value | |
| @opindex Wno-analyzer-use-of-uninitialized-value | |
| @item -Wno-analyzer-use-of-uninitialized-value | |
| This warning requires @option{-fanalyzer}, which enables it; use | |
| @option{-Wno-analyzer-use-of-uninitialized-value} to disable it. | |
| This diagnostic warns for paths through the code in which an uninitialized | |
| value is used. | |
| See @uref{https://cwe.mitre.org/data/definitions/457.html, CWE-457: Use of Uninitialized Variable}. | |
| @end table | |
| The analyzer has hardcoded knowledge about the behavior of the following | |
| memory-management functions: | |
| @itemize @bullet | |
| @item @code{alloca} | |
| @item The built-in functions @code{__builtin_alloc}, | |
| @code{__builtin_alloc_with_align}, @item @code{__builtin_calloc}, | |
| @code{__builtin_free}, @code{__builtin_malloc}, @code{__builtin_memcpy}, | |
| @code{__builtin_memcpy_chk}, @code{__builtin_memset}, | |
| @code{__builtin_memset_chk}, @code{__builtin_realloc}, | |
| @code{__builtin_stack_restore}, and @code{__builtin_stack_save} | |
| @item @code{calloc} | |
| @item @code{free} | |
| @item @code{malloc} | |
| @item @code{memset} | |
| @item @code{operator delete} | |
| @item @code{operator delete []} | |
| @item @code{operator new} | |
| @item @code{operator new []} | |
| @item @code{realloc} | |
| @item @code{strdup} | |
| @item @code{strndup} | |
| @end itemize | |
| @noindent | |
| of the following functions for working with file descriptors: | |
| @itemize @bullet | |
| @item @code{open} | |
| @item @code{close} | |
| @item @code{creat} | |
| @item @code{dup}, @code{dup2} and @code{dup3} | |
| @item @code{isatty} | |
| @item @code{pipe}, and @code{pipe2} | |
| @item @code{read} | |
| @item @code{write} | |
| @item @code{socket}, @code{bind}, @code{listen}, @code{accept}, and @code{connect} | |
| @end itemize | |
| @noindent | |
| of the following functions for working with @code{<stdio.h>} streams: | |
| @itemize @bullet | |
| @item The built-in functions @code{__builtin_fprintf}, | |
| @code{__builtin_fprintf_unlocked}, @code{__builtin_fputc}, | |
| @code{__builtin_fputc_unlocked}, @code{__builtin_fputs}, | |
| @code{__builtin_fputs_unlocked}, @code{__builtin_fwrite}, | |
| @code{__builtin_fwrite_unlocked}, @code{__builtin_printf}, | |
| @code{__builtin_printf_unlocked}, @code{__builtin_putc}, | |
| @code{__builtin_putchar}, @code{__builtin_putchar_unlocked}, | |
| @code{__builtin_putc_unlocked}, @code{__builtin_puts}, | |
| @code{__builtin_puts_unlocked}, @code{__builtin_vfprintf}, and | |
| @code{__builtin_vprintf} | |
| @item @code{fopen} | |
| @item @code{fclose} | |
| @item @code{ferror} | |
| @item @code{fgets} | |
| @item @code{fgets_unlocked} | |
| @item @code{fileno} | |
| @item @code{fread} | |
| @item @code{getc} | |
| @item @code{getchar} | |
| @item @code{fprintf} | |
| @item @code{printf} | |
| @item @code{fwrite} | |
| @end itemize | |
| @noindent | |
| and of the following functions: | |
| @itemize @bullet | |
| @item The built-in functions @code{__builtin_expect}, | |
| @code{__builtin_expect_with_probability}, @code{__builtin_strchr}, | |
| @code{__builtin_strcpy}, @code{__builtin_strcpy_chk}, | |
| @code{__builtin_strlen}, @code{__builtin_va_copy}, and | |
| @code{__builtin_va_start} | |
| @item The GNU extensions @code{error} and @code{error_at_line} | |
| @item @code{getpass} | |
| @item @code{longjmp} | |
| @item @code{putenv} | |
| @item @code{setjmp} | |
| @item @code{siglongjmp} | |
| @item @code{signal} | |
| @item @code{sigsetjmp} | |
| @item @code{strcat} | |
| @item @code{strchr} | |
| @item @code{strlen} | |
| @end itemize | |
| In addition, various functions with an @code{__analyzer_} prefix have | |
| special meaning to the analyzer, described in the GCC Internals manual. | |
| Various internal parameters, settable via @option{--param}, are used | |
| to control the exploration; these are also documented in the GCC Internals | |
| manual. | |
| The following options control the analyzer. | |
| @table @gcctabopt | |
| @opindex fanalyzer-assume-nothrow | |
| @opindex fno-analyzer-assume-nothrow | |
| @item -fanalyzer-assume-nothrow | |
| By default, if @option{-fexceptions} is enabled, the analyzer will assume | |
| that a call to any function without attribute @code{nothrow} could throw | |
| an exception. This can help detect execution paths that leak due to | |
| exceptions bypassing clean-up code, but could lead to false positives when | |
| using headers where the author has not added the @code{nothrow} attribute. | |
| If @option{-fanalyzer-assume-nothrow} is enabled, then the analyzer will | |
| assume that external functions do not throw exceptions. This may be useful | |
| for reducing ``noise'' from the analyzer when enabling | |
| @option{-fexceptions} on C code, but could hide true issues if an | |
| exception could be raised by something the C code calls. | |
| @opindex fanalyzer-call-summaries | |
| @opindex fno-analyzer-call-summaries | |
| @item -fanalyzer-call-summaries | |
| Simplify interprocedural analysis by computing the effect of certain calls, | |
| rather than exploring all paths through the function from callsite to each | |
| possible return. | |
| If enabled, call summaries are only used for functions with more than one | |
| call site, and that are sufficiently complicated. | |
| @opindex fanalyzer-checker | |
| @item -fanalyzer-checker=@var{name} | |
| Restrict the analyzer to run just the named checker, and enable it. | |
| @opindex fanalyzer-debug-text-art | |
| @opindex fno-analyzer-debug-text-art | |
| @item -fanalyzer-debug-text-art-headings | |
| This option is intended for analyzer developers. If enabled, | |
| the analyzer will add extra annotations to any diagrams it generates. | |
| @opindex fanalyzer-feasibility | |
| @opindex fno-analyzer-feasibility | |
| @item -fno-analyzer-feasibility | |
| This option is intended for analyzer developers. | |
| By default the analyzer verifies that there is a feasible control flow path | |
| for each diagnostic it emits: that the conditions that hold are not mutually | |
| exclusive. Diagnostics for which no feasible path can be found are rejected. | |
| This filtering can be suppressed with @option{-fno-analyzer-feasibility}, for | |
| debugging issues in this code. | |
| @opindex fanalyzer-fine-grained | |
| @opindex fno-analyzer-fine-grained | |
| @item -fanalyzer-fine-grained | |
| Does nothing. Preserved for backward compatibility. | |
| @opindex fanalyzer-show-duplicate-count | |
| @opindex fno-analyzer-show-duplicate-count | |
| @item -fanalyzer-show-duplicate-count | |
| This option is intended for analyzer developers: if multiple diagnostics | |
| have been detected as being duplicates of each other, it emits a note when | |
| reporting the best diagnostic, giving the number of additional diagnostics | |
| that were suppressed by the deduplication logic. | |
| @opindex fanalyzer-show-events-in-system-headers | |
| @opindex fno-analyzer-show-events-in-system-headers | |
| @item -fanalyzer-show-events-in-system-headers | |
| By default the analyzer emits simplified diagnostics paths by hiding | |
| events fully located within a system header. | |
| With @option{-fanalyzer-show-events-in-system-headers} such | |
| events are no longer suppressed. | |
| @opindex fanalyzer-simplify-supergraph | |
| @opindex fno-analyzer-simplify-supergraph | |
| @item -fno-analyzer-simplify-supergraph | |
| This option is intended for analyzer developers. | |
| By default, the analyzer performs various simplifications to the | |
| program supergraph before analyzing it. With | |
| @option{-fno-analyzer-simplify-supergraph} this simplification can be | |
| suppressed, for debugging issues with it. | |
| @opindex fanalyzer-state-merge | |
| @opindex fno-analyzer-state-merge | |
| @item -fno-analyzer-state-merge | |
| This option is intended for analyzer developers. | |
| By default the analyzer attempts to simplify analysis by merging | |
| sufficiently similar states at each program point as it builds its | |
| ``exploded graph''. With @option{-fno-analyzer-state-merge} this | |
| merging can be suppressed, for debugging state-handling issues. | |
| @opindex fanalyzer-state-purge | |
| @opindex fno-analyzer-state-purge | |
| @item -fno-analyzer-state-purge | |
| This option is intended for analyzer developers. | |
| By default the analyzer attempts to simplify analysis by purging | |
| aspects of state at a program point that appear to no longer be relevant | |
| e.g. the values of locals that aren't accessed later in the function | |
| and which aren't relevant to leak analysis. | |
| With @option{-fno-analyzer-state-purge} this purging of state can | |
| be suppressed, for debugging state-handling issues. | |
| @opindex fanalyzer-suppress-followups | |
| @opindex fno-analyzer-suppress-followups | |
| @item -fno-analyzer-suppress-followups | |
| This option is intended for analyzer developers. | |
| By default the analyzer will stop exploring an execution path after | |
| encountering certain diagnostics, in order to avoid potentially issuing a | |
| cascade of follow-up diagnostics. | |
| The diagnostics that terminate analysis along a path are: | |
| @itemize | |
| @item @option{-Wanalyzer-null-argument} | |
| @item @option{-Wanalyzer-null-dereference} | |
| @item @option{-Wanalyzer-use-after-free} | |
| @item @option{-Wanalyzer-use-of-pointer-in-stale-stack-frame} | |
| @item @option{-Wanalyzer-use-of-uninitialized-value} | |
| @end itemize | |
| With @option{-fno-analyzer-suppress-followups} the analyzer will | |
| continue to explore such paths even after such diagnostics, which may | |
| be helpful for debugging issues in the analyzer, or for microbenchmarks | |
| for detecting undefined behavior. | |
| @opindex fanalyzer-transitivity | |
| @opindex fno-analyzer-transitivity | |
| @item -fanalyzer-transitivity | |
| This option enables transitivity of constraints within the analyzer. | |
| @opindex fanalyzer-undo-inlining | |
| @opindex fno-analyzer-undo-inlining | |
| @item -fno-analyzer-undo-inlining | |
| This option is intended for analyzer developers. | |
| @option{-fanalyzer} runs relatively late compared to other code analysis | |
| tools, and some optimizations have already been applied to the code. In | |
| particular function inlining may have occurred, leading to the | |
| interprocedural execution paths emitted by the analyzer containing | |
| function frames that don't correspond to those in the original source | |
| code. | |
| By default the analyzer attempts to reconstruct the original function | |
| frames, and to emit events showing the inlined calls. | |
| With @option{-fno-analyzer-undo-inlining} this attempt to reconstruct | |
| the original frame information can be disabled, which may be of help | |
| when debugging issues in the analyzer. | |
| @opindex fanalyzer-verbose-edges | |
| @opindex fno-analyzer-verbose-edges | |
| @item -fanalyzer-verbose-edges | |
| This option is intended for analyzer developers. It enables more | |
| verbose, lower-level detail in the descriptions of control flow | |
| within diagnostic paths. | |
| @opindex fanalyzer-verbose-state-changes | |
| @opindex fno-analyzer-verbose-state-changes | |
| @item -fanalyzer-verbose-state-changes | |
| This option is intended for analyzer developers. It enables more | |
| verbose, lower-level detail in the descriptions of events relating | |
| to state machines within diagnostic paths. | |
| @opindex fanalyzer-verbosity | |
| @item -fanalyzer-verbosity=@var{level} | |
| This option controls the complexity of the control flow paths that are | |
| emitted for analyzer diagnostics. | |
| The @var{level} can be one of: | |
| @table @samp | |
| @item 0 | |
| At this level, interprocedural call and return events are displayed, | |
| along with the most pertinent state-change events relating to | |
| a diagnostic. For example, for a double-@code{free} diagnostic, | |
| both calls to @code{free} will be shown. | |
| @item 1 | |
| As per the previous level, but also show events for the entry | |
| to each function. | |
| @item 2 | |
| As per the previous level, but also show events relating to | |
| control flow that are significant to triggering the issue | |
| (e.g. ``true path taken'' at a conditional). | |
| This level is the default. | |
| @item 3 | |
| As per the previous level, but show all control flow events, not | |
| just significant ones. | |
| @item 4 | |
| This level is intended for analyzer developers; it adds various | |
| other events intended for debugging the analyzer. | |
| @end table | |
| @opindex fdump-analyzer | |
| @item -fdump-analyzer | |
| Dump internal details about what the analyzer is doing to | |
| @file{@var{file}.analyzer.txt}. | |
| @option{-fdump-analyzer-stderr} overrides this option. | |
| @opindex fdump-analyzer-stderr | |
| @item -fdump-analyzer-stderr | |
| Dump internal details about what the analyzer is doing to stderr. | |
| This option overrides @option{-fdump-analyzer}. | |
| @opindex fdump-analyzer-callgraph | |
| @item -fdump-analyzer-callgraph | |
| Dump a representation of the call graph suitable for viewing with | |
| GraphViz to @file{@var{file}.callgraph.dot}. | |
| @opindex fdump-analyzer-exploded-graph | |
| @item -fdump-analyzer-exploded-graph | |
| Dump a representation of the ``exploded graph'' suitable for viewing with | |
| GraphViz to @file{@var{file}.eg.dot}. | |
| Nodes are color-coded based on state-machine states to emphasize | |
| state changes. | |
| @opindex fdump-analyzer-exploded-nodes | |
| @item -fdump-analyzer-exploded-nodes | |
| Emit diagnostics showing where nodes in the ``exploded graph'' are | |
| in relation to the program source. | |
| @opindex fdump-analyzer-exploded-nodes-2 | |
| @item -fdump-analyzer-exploded-nodes-2 | |
| Dump a textual representation of the ``exploded graph'' to | |
| @file{@var{file}.eg.txt}. | |
| @opindex fdump-analyzer-exploded-nodes-3 | |
| @item -fdump-analyzer-exploded-nodes-3 | |
| Dump a textual representation of the ``exploded graph'' to | |
| one dump file per node, to @file{@var{file}.eg-@var{id}.txt}. | |
| This is typically a large number of dump files. | |
| @opindex fdump-analyzer-exploded-paths | |
| @item -fdump-analyzer-exploded-paths | |
| Dump a textual representation of the ``exploded path'' for each | |
| diagnostic to @file{@var{file}.@var{idx}.@var{kind}.epath.txt}. | |
| @opindex fdump-analyzer-feasibility | |
| @item -fdump-analyzer-feasibility | |
| Dump internal details about the analyzer's search for feasible paths. | |
| The details are written in a form suitable for viewing with GraphViz | |
| to filenames of the form @file{@var{file}.*.fg.dot}, | |
| @file{@var{file}.*.tg.dot}, and @file{@var{file}.*.fpath.txt}. | |
| @opindex fdump-analyzer-infinite-loop | |
| @item -fdump-analyzer-infinite-loop | |
| Dump internal details about the analyzer's search for infinite loops. | |
| The details are written in a form suitable for viewing with GraphViz | |
| to filenames of the form @file{@var{file}.*.infinite-loop.dot}. | |
| @opindex fdump-analyzer-json | |
| @item -fdump-analyzer-json | |
| Dump a compressed JSON representation of analyzer internals to | |
| @file{@var{file}.analyzer.json.gz}. The precise format is subject | |
| to change. | |
| @opindex fdump-analyzer-state-purge | |
| @item -fdump-analyzer-state-purge | |
| As per @option{-fdump-analyzer-supergraph}, dump a representation of the | |
| ``supergraph'' suitable for viewing with GraphViz, but annotate the | |
| graph with information on what state will be purged at each node. | |
| The graph is written to @file{@var{file}.state-purge.dot}. | |
| @opindex fdump-analyzer-supergraph | |
| @item -fdump-analyzer-supergraph | |
| Dump representations of the ``supergraph'' suitable for viewing with | |
| GraphViz to @file{@var{file}.supergraph.@var{index}.@var{kind}.dot}. | |
| These show all of the control flow graphs in the program, at various stages | |
| of the analysis. The precise set of dumps and what they show is subject | |
| to change. | |
| @opindex fdump-analyzer-untracked | |
| @item -fdump-analyzer-untracked | |
| Emit custom warnings with internal details intended for analyzer developers. | |
| @end table | |
| @node Debugging Options | |
| @section Options for Debugging Your Program | |
| @cindex options, debugging | |
| @cindex debugging information options | |
| To tell GCC to emit extra information for use by a debugger, in almost | |
| all cases you need only to add @option{-g} to your other options. Some debug | |
| formats can co-exist (like DWARF with CTF) when each of them is enabled | |
| explicitly by adding the respective command-line option to your other options. | |
| GCC allows you to use @option{-g} with | |
| @option{-O}. The shortcuts taken by optimized code may occasionally | |
| be surprising: some variables you declared may not exist | |
| at all; flow of control may briefly move where you did not expect it; | |
| some statements may not be executed because they compute constant | |
| results or their values are already at hand; some statements may | |
| execute in different places because they have been moved out of loops. | |
| Nevertheless it is possible to debug optimized output. This makes | |
| it reasonable to use the optimizer for programs that might have bugs. | |
| If you are not using some other optimization option, consider | |
| using @option{-Og} (@pxref{Optimize Options}) with @option{-g}. | |
| With no @option{-O} option at all, some compiler passes that collect | |
| information useful for debugging do not run at all, so that | |
| @option{-Og} may result in a better debugging experience. | |
| @table @gcctabopt | |
| @opindex g | |
| @opindex debug | |
| @item -g | |
| @itemx --debug | |
| Produce debugging information in the operating system's native format | |
| (stabs, COFF, XCOFF, or DWARF)@. GDB can work with this debugging | |
| information. | |
| On most systems that use stabs format, @option{-g} enables use of extra | |
| debugging information that only GDB can use; this extra information | |
| makes debugging work better in GDB but probably makes other debuggers | |
| crash or refuse to read the program. If you want to control for certain whether | |
| to generate the extra information, use @option{-gvms} (see below). | |
| @opindex ggdb | |
| @item -ggdb | |
| Produce debugging information for use by GDB@. This means to use the | |
| most expressive format available (DWARF, stabs, or the native format | |
| if neither of those are supported), including GDB extensions if at all | |
| possible. | |
| @opindex gdwarf | |
| @item -gdwarf | |
| @itemx -gdwarf-@var{version} | |
| Produce debugging information in DWARF format (if that is supported). | |
| The value of @var{version} may be either 2, 3, 4 or 5; the default | |
| version for most targets is 5 (with the exception of VxWorks, TPF and | |
| Darwin / macOS, which default to version 2, and AIX, which defaults | |
| to version 4). | |
| Note that with DWARF Version 2, some ports require and always | |
| use some non-conflicting DWARF 3 extensions in the unwind tables. | |
| Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments} | |
| for maximum benefit. Version 5 requires GDB 8.0 or higher. | |
| GCC no longer supports DWARF Version 1, which is substantially | |
| different than Version 2 and later. For historical reasons, some | |
| other DWARF-related options such as | |
| @option{-fno-dwarf2-cfi-asm}) retain a reference to DWARF Version 2 | |
| in their names, but apply to all currently-supported versions of DWARF. | |
| @opindex gbtf | |
| @item -gbtf | |
| Request BTF debug information. BTF is the default debugging format for the | |
| eBPF target. On other targets, like x86, BTF debug information can be | |
| generated along with DWARF debug information when both of the debug formats are | |
| enabled explicitly via their respective command-line options. | |
| @opindex gprune-btf | |
| @opindex gno-prune-btf | |
| @item -gprune-btf | |
| @itemx -gno-prune-btf | |
| Prune BTF information before emission. When pruning, only type | |
| information for types used by global variables and file-scope functions | |
| will be emitted. If compiling for the BPF target with BPF CO-RE | |
| enabled, type information will also be emitted for types used in BPF | |
| CO-RE relocations. In addition, struct and union types which are only | |
| referred to via pointers from members of other struct or union types | |
| shall be pruned and replaced with BTF_KIND_FWD, as though those types | |
| were only present in the input as forward declarations. | |
| This option substantially reduces the size of produced BTF information, | |
| but at significant loss in the amount of detailed type information. | |
| It is primarily useful when compiling for the BPF target, to minimize | |
| the size of the resulting object, and to eliminate BTF information | |
| which is not immediately relevant to the BPF program loading process. | |
| This option is enabled by default for the BPF target when generating | |
| BTF information. | |
| @opindex gctf | |
| @item -gctf | |
| @itemx -gctf@var{level} | |
| Request CTF debug information and use level to specify how much CTF debug | |
| information should be produced. If @option{-gctf} is specified | |
| without a value for level, the default level of CTF debug information is 2. | |
| CTF debug information can be generated along with DWARF debug information when | |
| both of the debug formats are enabled explicitly via their respective command | |
| line options. | |
| Level 0 produces no CTF debug information at all. Thus, @option{-gctf0} | |
| negates @option{-gctf}. | |
| Level 1 produces CTF information for tracebacks only. This includes callsite | |
| information, but does not include type information. | |
| Level 2 produces type information for entities (functions, data objects etc.) | |
| at file-scope or global-scope only. | |
| @opindex gvms | |
| @item -gvms | |
| Produce debugging information in Alpha/VMS debug format (if that is | |
| supported). This is the format used by DEBUG on Alpha/VMS systems. | |
| @opindex gcodeview | |
| @opindex gno-codeview | |
| @item -gcodeview | |
| Produce debugging information in CodeView debug format (if that is | |
| supported). This is the format used by Microsoft Visual C++ on | |
| Windows. | |
| @item -g@var{level} | |
| @itemx -ggdb@var{level} | |
| @itemx -gvms@var{level} | |
| Request debugging information and also use @var{level} to specify how | |
| much information. The default level is 2. | |
| Level 0 produces no debug information at all. Thus, @option{-g0} negates | |
| @option{-g}. | |
| Level 1 produces minimal information, enough for making backtraces in | |
| parts of the program that you don't plan to debug. This includes | |
| descriptions of functions and external variables, and line number | |
| tables, but no information about local variables. | |
| Level 2 is the normal setting to produce debuggable code. The debug output | |
| includes all the information from level 1, plus information about | |
| local variables and typedefs to allow stepping through code and examining | |
| its state. For C++ code, additional information is also emitted to assist | |
| in debugging namespace, class, and template functions. | |
| Level 3 includes extra information, such as all the macro definitions | |
| present in the program. Some debuggers support macro expansion when | |
| you use @option{-g3}. | |
| If you use multiple @option{-g} options, with or without level numbers, | |
| the last such option is the one that is effective. | |
| @option{-gdwarf} does not accept a concatenated debug level, to avoid | |
| confusion with @option{-gdwarf-@var{level}}. | |
| Instead use an additional @option{-g@var{level}} option to change the | |
| debug level for DWARF. | |
| @opindex feliminate-unused-debug-symbols | |
| @opindex fno-eliminate-unused-debug-symbols | |
| @item -fno-eliminate-unused-debug-symbols | |
| By default, no debug information is produced for symbols that are not actually | |
| used. Use this option if you want debug information for all symbols. | |
| @opindex femit-class-debug-always | |
| @opindex fno-emit-class-debug-always | |
| @item -femit-class-debug-always | |
| Instead of emitting debugging information for a C++ class in only one | |
| object file, emit it in all object files using the class. This option | |
| should be used only with debuggers that are unable to handle the way GCC | |
| normally emits debugging information for classes because using this | |
| option increases the size of debugging information by as much as a | |
| factor of two. | |
| @opindex fmerge-debug-strings | |
| @opindex fno-merge-debug-strings | |
| @item -fno-merge-debug-strings | |
| Direct the linker to not merge together strings in the debugging | |
| information that are identical in different object files. Merging is | |
| not supported by all assemblers or linkers. Merging decreases the size | |
| of the debug information in the output file at the cost of increasing | |
| link processing time. Merging is enabled by default. | |
| @opindex fdebug-prefix-map | |
| @item -fdebug-prefix-map=@var{old}=@var{new} | |
| When compiling files residing in directory @file{@var{old}}, record | |
| debugging information describing them as if the files resided in | |
| directory @file{@var{new}} instead. This can be used to replace a | |
| build-time path with an install-time path in the debug info. It can | |
| also be used to change an absolute path to a relative path by using | |
| @file{.} for @var{new}. This can give more reproducible builds, which | |
| are location independent, but may require an extra command to tell GDB | |
| where to find the source files. See also @option{-ffile-prefix-map} | |
| and @option{-fcanon-prefix-map}. | |
| @opindex fvar-tracking | |
| @opindex fno-var-tracking | |
| @item -fvar-tracking | |
| Run variable tracking pass. It computes where variables are stored at each | |
| position in code. Better debugging information is then generated | |
| (if the debugging information format supports this information). | |
| It is enabled by default when compiling with optimization (@option{-Os}, | |
| @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and | |
| the debug info format supports it. | |
| @opindex fvar-tracking-assignments | |
| @opindex fno-var-tracking-assignments | |
| @item -fvar-tracking-assignments | |
| Annotate assignments to user variables early in the compilation and | |
| attempt to carry the annotations over throughout the compilation all the | |
| way to the end, in an attempt to improve debug information while | |
| optimizing. Use of @option{-gdwarf-4} is recommended along with it. | |
| It can be enabled even if var-tracking is disabled, in which case | |
| annotations are created and maintained, but discarded at the end. | |
| By default, this flag is enabled together with @option{-fvar-tracking}, | |
| except when selective scheduling is enabled. | |
| @opindex fvar-tracking-uninit | |
| @opindex fno-var-tracking-uninit | |
| @item -fvar-tracking-uninit | |
| @itemx -fno-var-tracking-uninit | |
| Perform variable tracking and also mark uninitialized variables in the | |
| debug information. | |
| This flag is enabled by default by @option{-fvar-tracking}; it | |
| also implies @option{-fvar-tracking}. | |
| To do variable tracking without marking uninitialized variables, use | |
| @option{-fvar-tracking} @option{-fno-var-tracking-uninit}. | |
| @opindex gsplit-dwarf | |
| @opindex gno-split-dwarf | |
| @item -gsplit-dwarf | |
| If DWARF debugging information is enabled, separate as much debugging | |
| information as possible into a separate output file with the extension | |
| @file{.dwo}. This option allows the build system to avoid linking files with | |
| debug information. To be useful, this option requires a debugger capable of | |
| reading @file{.dwo} files. | |
| @opindex gdwarf32 | |
| @opindex gdwarf64 | |
| @item -gdwarf32 | |
| @itemx -gdwarf64 | |
| If DWARF debugging information is enabled, the @option{-gdwarf32} selects | |
| the 32-bit DWARF format and the @option{-gdwarf64} selects the 64-bit | |
| DWARF format. The default is target specific, on most targets it is | |
| @option{-gdwarf32} though. The 32-bit DWARF format is smaller, but | |
| can't support more than 2GiB of debug information in any of the DWARF | |
| debug information sections. The 64-bit DWARF format allows larger debug | |
| information and might not be well supported by all consumers yet. | |
| @opindex gdescribe-dies | |
| @opindex gno-describe-dies | |
| @item -gdescribe-dies | |
| Add description attributes to some DWARF DIEs that have no name attribute, | |
| such as artificial variables, external references and call site | |
| parameter DIEs. | |
| @opindex gpubnames | |
| @item -gpubnames | |
| Generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections. | |
| @opindex ggnu-pubnames | |
| @item -ggnu-pubnames | |
| Generate @code{.debug_pubnames} and @code{.debug_pubtypes} sections in a format | |
| suitable for conversion into a GDB@ index. This option is only useful | |
| with a linker that can produce GDB@ index version 7. | |
| @opindex gno-pubnames | |
| @item -gno-pubnames | |
| Don't generate DWARF @code{.debug_pubnames} and @code{.debug_pubtypes} sections. | |
| @opindex fdebug-types-section | |
| @opindex fno-debug-types-section | |
| @item -fdebug-types-section | |
| When using DWARF Version 4 or higher, type DIEs can be put into | |
| their own @code{.debug_types} section instead of making them part of the | |
| @code{.debug_info} section. It is more efficient to put them in a separate | |
| comdat section since the linker can then remove duplicates. | |
| But not all DWARF consumers support @code{.debug_types} sections yet | |
| and on some objects @code{.debug_types} produces larger instead of smaller | |
| debugging information. | |
| @opindex grecord-gcc-switches | |
| @opindex gno-record-gcc-switches | |
| @item -grecord-gcc-switches | |
| @itemx -gno-record-gcc-switches | |
| This switch causes the command-line options used to invoke the | |
| compiler that may affect code generation to be appended to the | |
| DW_AT_producer attribute in DWARF debugging information. The options | |
| are concatenated with spaces separating them from each other and from | |
| the compiler version. | |
| It is enabled by default. | |
| See also @option{-frecord-gcc-switches} for another | |
| way of storing compiler options into the object file. | |
| @opindex gstrict-dwarf | |
| @opindex gno-strict-dwarf | |
| @item -gstrict-dwarf | |
| Disallow using extensions of later DWARF standard version than selected | |
| with @option{-gdwarf-@var{version}}. On most targets using non-conflicting | |
| DWARF extensions from later standard versions is allowed. | |
| @opindex gno-strict-dwarf | |
| @item -gno-strict-dwarf | |
| Allow using extensions of later DWARF standard version than selected with | |
| @option{-gdwarf-@var{version}}. | |
| @opindex gas-loc-support | |
| @item -gas-loc-support | |
| Inform the compiler that the assembler supports @code{.loc} directives. | |
| It may then use them for the assembler to generate DWARF2+ line number | |
| tables. | |
| This is generally desirable, because assembler-generated line-number | |
| tables are a lot more compact than those the compiler can generate | |
| itself. | |
| This option is enabled by default if, at GCC configure time, the | |
| assembler is found to support such directives. | |
| @opindex gno-as-loc-support | |
| @item -gno-as-loc-support | |
| Force GCC to generate DWARF2+ line number tables internally, if DWARF2+ | |
| line number tables are to be generated. | |
| @opindex gas-locview-support | |
| @item -gas-locview-support | |
| Inform the compiler that the assembler supports @code{view} assignment | |
| and reset assertion checking in @code{.loc} directives. | |
| This option is enabled by default if, at GCC configure time, the | |
| assembler is found to support them. | |
| @opindex gno-as-locview-support | |
| @item -gno-as-locview-support | |
| Force GCC to assign view numbers internally, if | |
| @option{-gvariable-location-views} are explicitly requested. | |
| @opindex gcolumn-info | |
| @opindex gno-column-info | |
| @item -gcolumn-info | |
| @itemx -gno-column-info | |
| Emit location column information into DWARF debugging information, rather | |
| than just file and line. | |
| This option is enabled by default. | |
| @opindex gstatement-frontiers | |
| @opindex gno-statement-frontiers | |
| @item -gstatement-frontiers | |
| @itemx -gno-statement-frontiers | |
| This option causes GCC to create markers in the internal representation | |
| at the beginning of statements, and to keep them roughly in place | |
| throughout compilation, using them to guide the output of @code{is_stmt} | |
| markers in the line number table. This is enabled by default when | |
| compiling with optimization (@option{-Os}, @option{-O1}, @option{-O2}, | |
| @dots{}), and outputting DWARF 2 debug information at the normal level. | |
| @opindex gvariable-location-views | |
| @opindex gvariable-location-views=incompat5 | |
| @opindex gno-variable-location-views | |
| @item -gvariable-location-views | |
| @itemx -gvariable-location-views=incompat5 | |
| @itemx -gno-variable-location-views | |
| Augment variable location lists with progressive view numbers implied | |
| from the line number table. This enables debug information consumers to | |
| inspect state at certain points of the program, even if no instructions | |
| associated with the corresponding source locations are present at that | |
| point. If the assembler lacks support for view numbers in line number | |
| tables, this causes the compiler to emit the line number table, | |
| which generally makes them somewhat less compact. The augmented line | |
| number tables and location lists are fully backward-compatible, so they | |
| can be consumed by debug information consumers that are not aware of | |
| these augmentations, but they won't derive any benefit from them either. | |
| This is enabled by default when outputting DWARF 2 debug information at | |
| the normal level, as long as there is assembler support, | |
| @option{-fvar-tracking-assignments} is enabled and | |
| @option{-gstrict-dwarf} is not. When assembler support is not | |
| available, this may still be enabled, but it forces GCC to output | |
| internal line number tables, and if | |
| @option{-ginternal-reset-location-views} is not enabled, that most | |
| certainly leads to silently mismatching location views. | |
| There is a proposed representation for view numbers that is not backward | |
| compatible with the location list format introduced in DWARF 5, that can | |
| be enabled with @option{-gvariable-location-views=incompat5}. This | |
| option may be removed in the future, is only provided as a reference | |
| implementation of the proposed representation. Debug information | |
| consumers are not expected to support this extended format, and they | |
| would be rendered unable to decode location lists using it. | |
| @opindex ginternal-reset-location-views | |
| @opindex gno-internal-reset-location-views | |
| @item -ginternal-reset-location-views | |
| @itemx -gno-internal-reset-location-views | |
| Attempt to determine location views that can be omitted from location | |
| view lists. This requires the compiler to have very accurate instruction | |
| length estimates, which isn't always the case, and it may cause | |
| incorrect view lists to be generated silently when using an assembler | |
| that does not support location view lists. The GNU assembler flags | |
| any such error as a @code{view number mismatch}. This is only enabled | |
| on ports that define a reliable estimation function. | |
| @opindex ginline-points | |
| @opindex gno-inline-points | |
| @item -ginline-points | |
| @itemx -gno-inline-points | |
| Generate extended debug information for inlined functions. Location | |
| view tracking markers are inserted at inlined entry points, so that | |
| address and view numbers can be computed and output in debug | |
| information. This can be enabled independently of location views, in | |
| which case the view numbers won't be output, but it can only be enabled | |
| along with statement frontiers, and it is only enabled by default if | |
| location views are enabled. | |
| @opindex gz | |
| @opindex gno-z | |
| @item -gz@r{[}=@var{type}@r{]} | |
| Produce compressed debug sections in DWARF format, if that is supported. | |
| If @var{type} is not given, the default type depends on the capabilities | |
| of the assembler and linker used. @var{type} may be one of | |
| @samp{none} (don't compress debug sections), @samp{zlib} (use zlib | |
| compression in ELF gABI format), or @samp{zstd} (use zstd | |
| compression in ELF gABI format). If the linker doesn't support writing | |
| compressed debug sections, the option is rejected. Otherwise, if the | |
| assembler does not support them, @option{-gz} is silently ignored when | |
| producing object files. | |
| @opindex femit-struct-debug-baseonly | |
| @item -femit-struct-debug-baseonly | |
| Emit debug information for struct-like types | |
| only when the base name of the compilation source file | |
| matches the base name of file in which the struct is defined. | |
| This option substantially reduces the size of debugging information, | |
| but at significant potential loss in type information to the debugger. | |
| See @option{-femit-struct-debug-reduced} for a less aggressive option. | |
| See @option{-femit-struct-debug-detailed} for more detailed control. | |
| This option works only with DWARF debug output. | |
| @opindex femit-struct-debug-reduced | |
| @item -femit-struct-debug-reduced | |
| Emit debug information for struct-like types | |
| only when the base name of the compilation source file | |
| matches the base name of file in which the type is defined, | |
| unless the struct is a template or defined in a system header. | |
| This option significantly reduces the size of debugging information, | |
| with some potential loss in type information to the debugger. | |
| See @option{-femit-struct-debug-baseonly} for a more aggressive option. | |
| See @option{-femit-struct-debug-detailed} for more detailed control. | |
| This option works only with DWARF debug output. | |
| @opindex femit-struct-debug-detailed | |
| @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} | |
| Specify the struct-like types | |
| for which the compiler generates debug information. | |
| The intent is to reduce duplicate struct debug information | |
| between different object files within the same program. | |
| This option is a detailed version of | |
| @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly}, | |
| which serves for most needs. | |
| A specification has the syntax@* | |
| [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none}) | |
| The optional first word limits the specification to | |
| structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}). | |
| A struct type is used directly when it is the type of a variable, member. | |
| Indirect uses arise through pointers to structs. | |
| That is, when use of an incomplete struct is valid, the use is indirect. | |
| An example is | |
| @samp{struct one direct; struct two * indirect;}. | |
| The optional second word limits the specification to | |
| ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}). | |
| Generic structs are a bit complicated to explain. | |
| For C++, these are non-explicit specializations of template classes, | |
| or non-template classes within the above. | |
| Other programming languages have generics, | |
| but @option{-femit-struct-debug-detailed} does not yet implement them. | |
| The third word specifies the source files for those | |
| structs for which the compiler should emit debug information. | |
| The values @samp{none} and @samp{any} have the normal meaning. | |
| The value @samp{base} means that | |
| the base of name of the file in which the type declaration appears | |
| must match the base of the name of the main compilation file. | |
| In practice, this means that when compiling @file{foo.c}, debug information | |
| is generated for types declared in that file and @file{foo.h}, | |
| but not other header files. | |
| The value @samp{sys} means those types satisfying @samp{base} | |
| or declared in system or compiler headers. | |
| You may need to experiment to determine the best settings for your application. | |
| The default is @option{-femit-struct-debug-detailed=all}. | |
| This option works only with DWARF debug output. | |
| @opindex fdwarf2-cfi-asm | |
| @opindex fno-dwarf2-cfi-asm | |
| @item -fno-dwarf2-cfi-asm | |
| Emit DWARF unwind info as compiler generated @code{.eh_frame} section | |
| instead of using GAS @code{.cfi_*} directives. | |
| @opindex feliminate-unused-debug-types | |
| @opindex fno-eliminate-unused-debug-types | |
| @item -fno-eliminate-unused-debug-types | |
| Normally, when producing DWARF output, GCC avoids producing debug symbol | |
| output for types that are nowhere used in the source file being compiled. | |
| Sometimes it is useful to have GCC emit debugging | |
| information for all types declared in a compilation | |
| unit, regardless of whether or not they are actually used | |
| in that compilation unit, for example | |
| if, in the debugger, you want to cast a value to a type that is | |
| not actually used in your program (but is declared). More often, | |
| however, this results in a significant amount of wasted space. | |
| @end table | |
| @node Optimize Options | |
| @section Options That Control Optimization | |
| @cindex optimize options | |
| @cindex options, optimization | |
| These options control various sorts of optimizations. | |
| Without any optimization option, the compiler's goal is to reduce the | |
| cost of compilation and to make debugging produce the expected | |
| results. Statements are independent: if you stop the program with a | |
| breakpoint between statements, you can then assign a new value to any | |
| variable or change the program counter to any other statement in the | |
| function and get exactly the results you expect from the source | |
| code. | |
| Turning on optimization flags makes the compiler attempt to improve | |
| the performance and/or code size at the expense of compilation time | |
| and possibly the ability to debug the program. | |
| The compiler performs optimization based on the knowledge it has of the | |
| program. Compiling multiple files at once to a single output file mode allows | |
| the compiler to use information gained from all of the files when compiling | |
| each of them. | |
| Not all optimizations are controlled directly by a flag. Only | |
| optimizations that have a flag are listed in this section. | |
| Most optimizations are completely disabled at @option{-O0} or if an | |
| @option{-O} level is not set on the command line, even if individual | |
| optimization flags are specified. Similarly, @option{-Og} suppresses | |
| many optimization passes. | |
| Depending on the target and how GCC was configured, a slightly different | |
| set of optimizations may be enabled at each @option{-O} level than | |
| those listed here. You can invoke GCC with @option{-Q --help=optimizers} | |
| to find out the exact set of optimizations that are enabled at each level. | |
| @xref{Overall Options}, for examples. | |
| @table @gcctabopt | |
| @opindex O | |
| @opindex O1 | |
| @opindex optimize | |
| @item -O | |
| @itemx -O1 | |
| @itemx --optimize | |
| Optimize. Optimizing compilation takes somewhat more time, and a lot | |
| more memory for a large function. | |
| With @option{-O}, the compiler tries to reduce code size and execution | |
| time, without performing any optimizations that take a great deal of | |
| compilation time. | |
| @option{-O} is the recommended optimization level for large machine-generated | |
| code as a sensible balance between time taken to compile and memory use: | |
| higher optimization levels perform optimizations with greater algorithmic | |
| complexity than at @option{-O}. | |
| @c Note that in addition to the default_options_table list in opts.cc, | |
| @c several optimization flags default to true but control optimization | |
| @c passes that are explicitly disabled at -O0. | |
| @option{-O} turns on the following optimization flags: | |
| @c Please keep the following list alphabetized. | |
| @gccoptlist{-fauto-inc-dec | |
| -fbranch-count-reg | |
| -fcombine-stack-adjustments | |
| -fcompare-elim | |
| -fcprop-registers | |
| -fdce | |
| -fdefer-pop | |
| -fdelayed-branch | |
| -fdse | |
| -fforward-propagate | |
| -fguess-branch-probability | |
| -fif-conversion | |
| -fif-conversion2 | |
| -finline-functions-called-once | |
| -fipa-modref | |
| -fipa-profile | |
| -fipa-pure-const | |
| -fipa-reference | |
| -fipa-reference-addressable | |
| -fivopts | |
| -fmerge-constants | |
| -fmove-loop-invariants | |
| -fmove-loop-stores | |
| -fomit-frame-pointer | |
| -freorder-blocks | |
| -fshrink-wrap | |
| -fshrink-wrap-separate | |
| -fsplit-wide-types | |
| -fssa-backprop | |
| -fssa-phiopt | |
| -ftree-bit-ccp | |
| -ftree-ccp | |
| -ftree-ch | |
| -ftree-coalesce-vars | |
| -ftree-copy-prop | |
| -ftree-dce | |
| -ftree-dominator-opts | |
| -ftree-dse | |
| -ftree-forwprop | |
| -ftree-fre | |
| -ftree-phiprop | |
| -ftree-pta | |
| -ftree-scev-cprop | |
| -ftree-sink | |
| -ftree-slsr | |
| -ftree-sra | |
| -ftree-ter | |
| -funit-at-a-time} | |
| @opindex O2 | |
| @item -O2 | |
| Optimize even more. GCC performs nearly all supported optimizations | |
| that do not involve a space-speed tradeoff. | |
| As compared to @option{-O}, this option increases both compilation time | |
| and the performance of the generated code. | |
| @option{-O2} turns on all optimization flags specified by @option{-O1}. It | |
| also turns on the following optimization flags: | |
| @c Please keep the following list alphabetized! | |
| @gccoptlist{-falign-functions -falign-jumps | |
| -falign-labels -falign-loops | |
| -fcaller-saves | |
| -fcode-hoisting | |
| -fcrossjumping | |
| -fcse-follow-jumps -fcse-skip-blocks | |
| -fdelete-null-pointer-checks -fdep-fusion | |
| -fdevirtualize -fdevirtualize-speculatively | |
| -fduplicate-switch-dispatch | |
| -fexpensive-optimizations | |
| -ffinite-loops | |
| -fgcse -fgcse-lm | |
| -fhoist-adjacent-loads | |
| -finline-functions | |
| -finline-small-functions | |
| -findirect-inlining | |
| -fipa-bit-cp -fipa-cp -fipa-icf | |
| -fipa-ra -fipa-sra -fipa-vrp | |
| -fisolate-erroneous-paths-dereference | |
| -flra-remat | |
| -foptimize-crc | |
| -foptimize-sibling-calls | |
| -foptimize-strlen | |
| -fpartial-inlining | |
| -fpeephole2 | |
| -freorder-blocks-algorithm=stc | |
| -freorder-blocks-and-partition -freorder-functions | |
| -frerun-cse-after-loop | |
| -fschedule-insns -fschedule-insns2 | |
| -fsched-interblock -fsched-spec | |
| -fspeculatively-call-stored-functions | |
| -fstore-merging | |
| -fstrict-aliasing | |
| -fthread-jumps | |
| -ftree-builtin-call-dce | |
| -ftree-loop-vectorize | |
| -ftree-pre | |
| -ftree-slp-vectorize | |
| -ftree-switch-conversion -ftree-tail-merge | |
| -ftree-vrp | |
| -fvect-cost-model=very-cheap} | |
| Please note the warning under @option{-fgcse} about | |
| invoking @option{-O2} on programs that use computed gotos. | |
| @opindex O3 | |
| @item -O3 | |
| Optimize yet more. @option{-O3} turns on all optimizations specified | |
| by @option{-O2} and also turns on the following optimization flags: | |
| @c Please keep the following list alphabetized! | |
| @gccoptlist{-fgcse-after-reload | |
| -fipa-cp-clone | |
| -floop-interchange | |
| -floop-unroll-and-jam | |
| -fpeel-loops | |
| -fpredictive-commoning | |
| -fsplit-loops | |
| -ftree-loop-distribution | |
| -ftree-partial-pre | |
| -funswitch-loops | |
| -fvect-cost-model=dynamic | |
| -fversion-loops-for-strides} | |
| @opindex O0 | |
| @item -O0 | |
| Reduce compilation time and make debugging produce the expected | |
| results. This is the default. | |
| At @option{-O0}, GCC completely disables most optimization passes; | |
| they are not run even if you explicitly enable them on the command | |
| line, or are listed by @option{-Q --help=optimizers} as being enabled by | |
| default. Many optimizations performed by GCC depend on code analysis | |
| or canonicalization passes that are enabled by @option{-O}, and it would | |
| not be useful to run individual optimization passes in isolation. | |
| @opindex Os | |
| @item -Os | |
| Optimize for size. @option{-Os} enables all @option{-O2} optimizations | |
| except those that often increase code size: | |
| @gccoptlist{-falign-functions -falign-jumps | |
| -falign-labels -falign-loops -fduplicate-switch-dispatch | |
| -fprefetch-loop-arrays -freorder-blocks-algorithm=stc} | |
| It also enables @option{-finline-functions}, causes the compiler to tune for | |
| code size rather than execution speed, and performs further optimizations | |
| designed to reduce code size. | |
| @opindex Ofast | |
| @item -Ofast | |
| Disregard strict standards compliance. @option{-Ofast} enables all | |
| @option{-O3} optimizations. It also enables optimizations that are not | |
| valid for all standard-compliant programs. | |
| It turns on @option{-ffast-math}, @option{-fallow-store-data-races} | |
| and the Fortran-specific @option{-fstack-arrays}, unless | |
| @option{-fmax-stack-var-size} is specified, and @option{-fno-protect-parens}. | |
| It turns off @option{-fsemantic-interposition}. | |
| @opindex Og | |
| @item -Og | |
| Optimize while keeping in mind debugging experience. | |
| @option{-Og} should be the optimization | |
| level of choice for the standard edit-compile-debug cycle, offering | |
| a reasonable blend of optimization, fast compilation and debugging experience | |
| especially for code with a high abstraction penalty. In contrast to | |
| @option{-O0}, this enables @option{-fvar-tracking-assignments} and | |
| @option{-fvar-tracking} which handle debug information in the prologue | |
| and epilogue of functions better than @option{-O0}. | |
| Like @option{-O0}, @option{-Og} completely skips a number of | |
| optimization passes so that individual options controlling them have | |
| no effect. Otherwise @option{-Og} enables all @option{-O1} | |
| optimization flags except for those known to greatly interfere with debugging: | |
| @gccoptlist{-fbranch-count-reg -fdelayed-branch | |
| -fdse -fif-conversion -fif-conversion2 | |
| -finline-functions-called-once | |
| -fmove-loop-invariants -fmove-loop-stores -fssa-phiopt | |
| -ftree-bit-ccp -ftree-dse -ftree-pta -ftree-sra} | |
| @opindex Oz | |
| @item -Oz | |
| Optimize aggressively for size rather than speed. This may increase | |
| the number of instructions executed if those instructions require | |
| fewer bytes to encode. @option{-Oz} behaves similarly to @option{-Os} | |
| including enabling most @option{-O2} optimizations. | |
| @end table | |
| If you use multiple @option{-O} options, with or without level numbers, | |
| the last such option is the one that is effective. | |
| Options of the form @option{-f@var{flag}} specify machine-independent | |
| flags. Most flags have both positive and negative forms; the negative | |
| form of @option{-ffoo} is @option{-fno-foo}. In the table | |
| below, only one of the forms is listed---the one you typically | |
| use. You can figure out the other form by either removing @samp{no-} | |
| or adding it. | |
| The following options control specific optimizations. They are either | |
| activated by @option{-O} options or are related to ones that are. You | |
| can use the following flags in the rare cases when ``fine-tuning'' of | |
| optimizations to be performed is desired. | |
| @table @gcctabopt | |
| @opindex fno-defer-pop | |
| @opindex fdefer-pop | |
| @item -fno-defer-pop | |
| For machines that must pop arguments after a function call, always pop | |
| the arguments as soon as each function returns. | |
| At levels @option{-O1} and higher, @option{-fdefer-pop} is the default; | |
| this allows the compiler to let arguments accumulate on the stack for several | |
| function calls and pop them all at once. | |
| @opindex fforward-propagate | |
| @opindex fno-forward-propagate | |
| @item -fforward-propagate | |
| Perform a forward propagation pass on RTL@. The pass tries to combine two | |
| instructions and checks if the result can be simplified. If loop unrolling | |
| is active, two passes are performed and the second is scheduled after | |
| loop unrolling. | |
| This option is enabled by default at optimization levels @option{-O1}, | |
| @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex favoid-store-forwarding | |
| @opindex fno-avoid-store-forwarding | |
| @item -favoid-store-forwarding | |
| @itemx -fno-avoid-store-forwarding | |
| Many CPUs will stall for many cycles when a load partially depends on previous | |
| smaller stores. This pass tries to detect such cases and avoid the penalty by | |
| changing the order of the load and store and then fixing up the loaded value. | |
| Disabled by default. | |
| @opindex ffp-contract | |
| @item -ffp-contract=@var{style} | |
| @option{-ffp-contract=off} disables floating-point expression contraction. | |
| @option{-ffp-contract=fast} enables floating-point expression contraction | |
| such as forming of fused multiply-add operations if the target has | |
| native support for them. | |
| @option{-ffp-contract=on} enables floating-point expression contraction | |
| if allowed by the language standard. This is implemented for C and C++, | |
| where it enables contraction within one expression, but not across | |
| different statements. | |
| The default is @option{-ffp-contract=off} for C in a standards compliant mode | |
| (@option{-std=c11} or similar), @option{-ffp-contract=fast} otherwise. | |
| @opindex ffp-int-builtin-inexact | |
| @opindex fno-fp-int-builtin-inexact | |
| @item -ffp-int-builtin-inexact | |
| Allow the built-in functions @code{ceil}, @code{floor}, | |
| @code{round} and @code{trunc}, and their @code{float} and @code{long | |
| double} variants, to generate code that raises the ``inexact'' | |
| floating-point exception for noninteger arguments. ISO C99 and C11 | |
| allow these functions to raise the ``inexact'' exception, but ISO/IEC | |
| TS 18661-1:2014, the C bindings to IEEE 754-2008, as integrated into | |
| ISO C23, does not allow these functions to do so. | |
| The default is @option{-fno-fp-int-builtin-inexact}, disallowing the | |
| exception to be raised, unless C17 or an earlier C standard is selected. | |
| This option does nothing unless @option{-ftrapping-math} is in effect. | |
| Even if @option{-fno-fp-int-builtin-inexact} is used, if the functions | |
| generate a call to a library function then the ``inexact'' exception | |
| may be raised if the library implementation does not follow TS 18661. | |
| @opindex fomit-frame-pointer | |
| @opindex fno-omit-frame-pointer | |
| @item -fomit-frame-pointer | |
| Omit the frame pointer in functions that don't need one. This avoids the | |
| instructions to save, set up and restore the frame pointer; on many targets | |
| it also makes an extra register available. | |
| On some targets this flag has no effect because the standard calling sequence | |
| always uses a frame pointer, so it cannot be omitted. | |
| Note that @option{-fno-omit-frame-pointer} doesn't guarantee the frame pointer | |
| is used in all functions. Several targets always omit the frame pointer in | |
| leaf functions. | |
| Enabled by default at @option{-O1} and higher. | |
| @opindex foptimize-crc | |
| @opindex fno-optimize-crc | |
| @item -foptimize-crc | |
| Detect loops calculating CRC (performing polynomial long division) and | |
| replace them with a faster implementation. Detect 8, 16, 32, and 64 bit CRC, | |
| with a constant polynomial without the leading 1 bit, | |
| for both bit-forward and bit-reversed cases. | |
| If the target supports a CRC instruction and the polynomial used in the source | |
| code matches the polynomial used in the CRC instruction, generate that CRC | |
| instruction. Otherwise, if the target supports a carry-less-multiplication | |
| instruction, generate CRC using it; otherwise generate table-based CRC. | |
| Enabled by default at @option{-O2} and higher. | |
| @opindex foptimize-sibling-calls | |
| @opindex fno-optimize-sibling-calls | |
| @item -foptimize-sibling-calls | |
| Optimize sibling and tail recursive calls. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex foptimize-strlen | |
| @opindex fno-optimize-strlen | |
| @item -foptimize-strlen | |
| Optimize various standard C string functions (e.g.@: @code{strlen}, | |
| @code{strchr} or @code{strcpy}) and | |
| their @code{_FORTIFY_SOURCE} counterparts into faster alternatives. | |
| Enabled at levels @option{-O2}, @option{-O3}. | |
| @opindex finline-atomics | |
| @opindex fno-inline-atomics | |
| @item -finline-atomics | |
| @itemx -fno-inline-atomics | |
| Inline @samp{__atomic} operations when a lock-free instruction sequence | |
| is available. This optimization is enabled by default. | |
| @opindex finline-stringops | |
| @opindex fno-inline-stringops | |
| @item -finline-stringops@r{[}=@var{fn}@r{]} | |
| Expand memory and string operations (for now, only @code{memset}) | |
| inline, even when the length is variable or big enough as to require | |
| looping. This is most useful along with @option{-ffreestanding} and | |
| @option{-fno-builtin}. | |
| In some circumstances, it enables the compiler to generate code that | |
| takes advantage of known alignment and length multipliers, but even then | |
| it may be less efficient than optimized runtime implementations, and | |
| grow code size so much that even a less performant but shared | |
| implementation runs faster due to better use of code caches. This | |
| option is disabled by default. | |
| @opindex fno-inline | |
| @opindex finline | |
| @item -fno-inline | |
| Do not expand any functions inline apart from those marked with | |
| the @code{always_inline} attribute. This is the default when not | |
| optimizing. | |
| Single functions can be exempted from inlining by marking them | |
| with the @code{noinline} attribute. | |
| @opindex finline-small-functions | |
| @opindex fno-inline-small-functions | |
| @item -finline-small-functions | |
| Integrate functions into their callers when their body is smaller than expected | |
| function call code (so overall size of program gets smaller). The compiler | |
| heuristically decides which functions are simple enough to be worth integrating | |
| in this way. This inlining applies to all functions, even those not declared | |
| inline. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex findirect-inlining | |
| @opindex fno-indirect-inlining | |
| @item -findirect-inlining | |
| Inline also indirect calls that are discovered to be known at compile | |
| time thanks to previous inlining. This option has any effect only | |
| when inlining itself is turned on by the @option{-finline-functions} | |
| or @option{-finline-small-functions} options. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex finline-functions | |
| @opindex fno-inline-functions | |
| @item -finline-functions | |
| Consider all functions for inlining, even if they are not declared inline. | |
| The compiler heuristically decides which functions are worth integrating | |
| in this way. | |
| If all calls to a given function are integrated, and the function is | |
| declared @code{static}, then the function is normally not output as | |
| assembler code in its own right. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. Also enabled | |
| by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex finline-functions-called-once | |
| @opindex fno-inline-functions-called-once | |
| @item -finline-functions-called-once | |
| Consider all @code{static} functions called once for inlining into their | |
| caller even if they are not marked @code{inline}. If a call to a given | |
| function is integrated, then the function is not output as assembler code | |
| in its own right. | |
| Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}, | |
| but not @option{-Og}. | |
| @opindex fearly-inlining | |
| @opindex fno-early-inlining | |
| @item -fearly-inlining | |
| Inline functions marked by @code{always_inline} and functions whose body seems | |
| smaller than the function call overhead early before doing | |
| @option{-fprofile-generate} instrumentation and real inlining pass. Doing so | |
| makes profiling significantly cheaper and usually inlining faster on programs | |
| having large chains of nested wrapper functions. | |
| Enabled by default. | |
| @opindex fipa-sra | |
| @opindex fno-ipa-sra | |
| @item -fipa-sra | |
| Perform interprocedural scalar replacement of aggregates, removal of | |
| unused parameters and replacement of parameters passed by reference | |
| by parameters passed by value. | |
| Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}. | |
| @opindex finline-limit | |
| @item -finline-limit=@var{n} | |
| By default, GCC limits the size of functions that can be inlined. This flag | |
| allows coarse control of this limit. @var{n} is the size of functions that | |
| can be inlined in number of pseudo instructions. | |
| Inlining is actually controlled by a number of internal parameters, which | |
| are documented in the GCC Internals manual and should not normally be set | |
| directly. | |
| @emph{Note:} there may be no value to @option{-finline-limit} that results | |
| in default behavior. | |
| @emph{Note:} pseudo instruction represents, in this particular context, an | |
| abstract measurement of function's size. In no way does it represent a count | |
| of assembly instructions and as such its exact meaning might change from one | |
| release to an another. | |
| @opindex fno-keep-inline-dllexport | |
| @opindex fkeep-inline-dllexport | |
| @item -fno-keep-inline-dllexport | |
| This is a more fine-grained version of @option{-fkeep-inline-functions}, | |
| which applies only to functions that are declared using the @code{dllexport} | |
| attribute or declspec. @xref{Common Attributes}. | |
| @opindex fkeep-inline-functions | |
| @opindex fno-keep-inline-functions | |
| @item -fkeep-inline-functions | |
| In C, emit @code{static} functions that are declared @code{inline} | |
| into the object file, even if the function has been inlined into all | |
| of its callers. This switch does not affect functions using the | |
| @code{extern inline} extension in GNU C90@. In C++, emit any and all | |
| inline functions into the object file. | |
| @opindex fkeep-static-functions | |
| @opindex fno-keep-static-functions | |
| @item -fkeep-static-functions | |
| Emit @code{static} functions into the object file, even if the function | |
| is never used. | |
| @opindex fkeep-static-consts | |
| @opindex fno-keep-static-consts | |
| @item -fkeep-static-consts | |
| Emit variables declared @code{static const} when optimization isn't turned | |
| on, even if the variables aren't referenced. | |
| GCC enables this option by default. If you want to force the compiler to | |
| check if a variable is referenced, regardless of whether or not | |
| optimization is turned on, use the @option{-fno-keep-static-consts} option. | |
| @opindex fmerge-constants | |
| @opindex fno-merge-constants | |
| @item -fmerge-constants | |
| Attempt to merge identical constants (string constants and floating-point | |
| constants) across compilation units. | |
| This option is the default for optimized compilation if the assembler and | |
| linker support it. Use @option{-fno-merge-constants} to inhibit this | |
| behavior. | |
| Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fmerge-all-constants | |
| @opindex fno-merge-all-constants | |
| @item -fmerge-all-constants | |
| Attempt to merge identical constants and identical variables. | |
| This option implies @option{-fmerge-constants}. In addition to | |
| @option{-fmerge-constants} this considers e.g.@: even constant initialized | |
| arrays or initialized constant variables with integral or floating-point | |
| types. Languages like C or C++ require each variable, including multiple | |
| instances of the same variable in recursive calls, to have distinct locations, | |
| so using this option results in non-conforming | |
| behavior. | |
| @opindex fmodulo-sched | |
| @opindex fno-modulo-sched | |
| @item -fmodulo-sched | |
| Perform swing modulo scheduling immediately before the first scheduling | |
| pass. This pass looks at innermost loops and reorders their | |
| instructions by overlapping different iterations. | |
| @opindex fmodulo-sched-allow-regmoves | |
| @opindex fno-modulo-sched-allow-regmoves | |
| @item -fmodulo-sched-allow-regmoves | |
| Perform more aggressive SMS-based modulo scheduling with register moves | |
| allowed. By setting this flag certain anti-dependences edges are | |
| deleted, which triggers the generation of reg-moves based on the | |
| life-range analysis. This option is effective only with | |
| @option{-fmodulo-sched} enabled. | |
| @opindex fno-branch-count-reg | |
| @opindex fbranch-count-reg | |
| @item -fno-branch-count-reg | |
| Disable the optimization pass that scans for opportunities to use | |
| ``decrement and branch'' instructions on a count register instead of | |
| instruction sequences that decrement a register, compare it against zero, and | |
| then branch based upon the result. This option is only meaningful on | |
| architectures that support such instructions, which include x86, PowerPC, | |
| IA-64 and S/390. Note that the @option{-fno-branch-count-reg} option | |
| doesn't remove the decrement and branch instructions from the generated | |
| instruction stream introduced by other optimization passes. | |
| The default is @option{-fbranch-count-reg} at @option{-O1} and higher, | |
| except for @option{-Og}. | |
| @opindex fno-function-cse | |
| @opindex ffunction-cse | |
| @item -fno-function-cse | |
| Do not put function addresses in registers; make each instruction that | |
| calls a constant function contain the function's address explicitly. | |
| This option results in less efficient code, but some strange hacks | |
| that alter the assembler output may be confused by the optimizations | |
| performed when this option is not used. | |
| The default is @option{-ffunction-cse}. | |
| @opindex ffuse-ops-with-volatile-access | |
| @opindex fno-fuse-ops-with-volatile-access | |
| @item -ffuse-ops-with-volatile-access | |
| Allow limited optimization of operations with volatile memory access | |
| when doing so does not change the semantics outlined in | |
| @xref{Volatiles,,When is a Volatile Object Accessed?}. | |
| The default is @option{-ffuse-ops-with-volatile-access} | |
| @opindex fno-zero-initialized-in-bss | |
| @opindex fzero-initialized-in-bss | |
| @item -fno-zero-initialized-in-bss | |
| If the target supports a BSS section, GCC by default puts variables that | |
| are initialized to zero into BSS@. This can save space in the resulting | |
| code. | |
| This option turns off this behavior because some programs explicitly | |
| rely on variables going to the data section---e.g., so that the | |
| resulting executable can find the beginning of that section and/or make | |
| assumptions based on that. | |
| The default is @option{-fzero-initialized-in-bss} except in Ada. | |
| @opindex fthread-jumps | |
| @opindex fno-thread-jumps | |
| @item -fthread-jumps | |
| Perform optimizations that check to see if a jump branches to a | |
| location where another comparison subsumed by the first is found. If | |
| so, the first branch is redirected to either the destination of the | |
| second branch or a point immediately following it, depending on whether | |
| the condition is known to be true or false. | |
| Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fsplit-wide-types | |
| @opindex fno-split-wide-types | |
| @item -fsplit-wide-types | |
| When using a type that occupies multiple registers, such as @code{long | |
| long} on a 32-bit system, split the registers apart and allocate them | |
| independently. This normally generates better code for those types, | |
| but may make debugging more difficult. | |
| Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, | |
| @option{-Os}. | |
| @opindex fsplit-wide-types-early | |
| @opindex fno-split-wide-types-early | |
| @item -fsplit-wide-types-early | |
| Fully split wide types early, instead of very late. | |
| This option has no effect unless @option{-fsplit-wide-types} is turned on. | |
| This is the default on some targets. | |
| @opindex fcse-follow-jumps | |
| @opindex fno-cse-follow-jumps | |
| @item -fcse-follow-jumps | |
| In common subexpression elimination (CSE), scan through jump instructions | |
| when the target of the jump is not reached by any other path. For | |
| example, when CSE encounters an @code{if} statement with an | |
| @code{else} clause, CSE follows the jump when the condition | |
| tested is false. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fcse-skip-blocks | |
| @item -fcse-skip-blocks | |
| This is similar to @option{-fcse-follow-jumps}, but causes CSE to | |
| follow jumps that conditionally skip over blocks. When CSE | |
| encounters a simple @code{if} statement with no else clause, | |
| @option{-fcse-skip-blocks} causes CSE to follow the jump around the | |
| body of the @code{if}. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex frerun-cse-after-loop | |
| @opindex fno-rerun-cse-after-loop | |
| @item -frerun-cse-after-loop | |
| Re-run common subexpression elimination after loop optimizations are | |
| performed. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fgcse | |
| @opindex fno-gcse | |
| @item -fgcse | |
| Perform a global common subexpression elimination pass. | |
| This pass also performs global constant and copy propagation. | |
| @emph{Note:} When compiling a program using computed gotos, a GCC | |
| extension, you may get better run-time performance if you disable | |
| the global common subexpression elimination pass by adding | |
| @option{-fno-gcse} to the command line. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fgcse-lm | |
| @opindex fno-gcse-lm | |
| @item -fgcse-lm | |
| When @option{-fgcse-lm} is enabled, global common subexpression elimination | |
| attempts to move loads that are only killed by stores into themselves. This | |
| allows a loop containing a load/store sequence to be changed to a load outside | |
| the loop, and a copy/store within the loop. | |
| Enabled by default when @option{-fgcse} is enabled. | |
| @opindex fgcse-sm | |
| @opindex fno-gcse-sm | |
| @item -fgcse-sm | |
| When @option{-fgcse-sm} is enabled, a store motion pass is run after | |
| global common subexpression elimination. This pass attempts to move | |
| stores out of loops. When used in conjunction with @option{-fgcse-lm}, | |
| loops containing a load/store sequence can be changed to a load before | |
| the loop and a store after the loop. | |
| Not enabled at any optimization level. | |
| @opindex fgcse-las | |
| @opindex fno-gcse-las | |
| @item -fgcse-las | |
| When @option{-fgcse-las} is enabled, the global common subexpression | |
| elimination pass eliminates redundant loads that come after stores to the | |
| same memory location (both partial and full redundancies). | |
| Not enabled at any optimization level. | |
| @opindex fgcse-after-reload | |
| @opindex fno-gcse-after-reload | |
| @item -fgcse-after-reload | |
| When @option{-fgcse-after-reload} is enabled, a redundant load elimination | |
| pass is performed after reload. The purpose of this pass is to clean up | |
| redundant spilling. | |
| Enabled by @option{-O3}, @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex faggressive-loop-optimizations | |
| @opindex fno-aggressive-loop-optimizations | |
| @item -faggressive-loop-optimizations | |
| This option tells the loop optimizer to use language constraints to | |
| derive bounds for the number of iterations of a loop. This assumes that | |
| loop code does not invoke undefined behavior by for example causing signed | |
| integer overflows or out-of-bound array accesses. The bounds for the | |
| number of iterations of a loop are used to guide loop unrolling and peeling | |
| and loop exit test optimizations. | |
| This option is enabled by default. | |
| @opindex funconstrained-commons | |
| @opindex fno-unconstrained-commons | |
| @item -funconstrained-commons | |
| This option tells the compiler that variables declared in common blocks | |
| (e.g.@: Fortran) may later be overridden with longer trailing arrays. This | |
| prevents certain optimizations that depend on knowing the array bounds. | |
| @opindex fcrossjumping | |
| @opindex fno-crossjumping | |
| @item -fcrossjumping | |
| Perform cross-jumping transformation. | |
| This transformation unifies equivalent code and saves code size. The | |
| resulting code may or may not perform better than without cross-jumping. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fauto-inc-dec | |
| @opindex fno-auto-inc-dec | |
| @item -fauto-inc-dec | |
| Combine increments or decrements of addresses with memory accesses. | |
| This pass is always skipped on architectures that do not have | |
| instructions to support this. Enabled by default at @option{-O1} and | |
| higher on architectures that support this. | |
| @opindex fdce | |
| @opindex fno-dce | |
| @item -fdce | |
| Perform dead code elimination (DCE) on RTL@. | |
| Enabled by default at @option{-O1} and higher. | |
| @opindex fdse | |
| @opindex fno-dse | |
| @item -fdse | |
| Perform dead store elimination (DSE) on RTL@. | |
| Enabled by default at @option{-O1} and higher. | |
| @opindex fduplicate-switch-dispatch | |
| @opindex fno-duplicate-switch-dispatch | |
| @item -fduplicate-switch-dispatch | |
| If supported by the target machine, give eligible predecessors of a switch at | |
| a loop head their own copy of the jump-table branch. A bytecode interpreter | |
| written with such a @code{switch} otherwise sends every opcode transition | |
| through one indirect branch instruction. This can make indirect target | |
| prediction less effective. GCC already performs the same transformation for | |
| the computed gotos of an interpreter written with the labels-as-values | |
| extension. | |
| It trades size for speed, so the amount copied is bounded by | |
| @option{--param=max-goto-duplication-insns}. The transformation runs only | |
| with @option{-fexpensive-optimizations} and only in functions that are | |
| optimized for speed. | |
| Enabled at levels @option{-O2}, @option{-O3}. | |
| @opindex fif-conversion | |
| @opindex fno-if-conversion | |
| @item -fif-conversion | |
| Attempt to transform conditional jumps into branch-less equivalents. This | |
| includes use of conditional moves, min, max, set flags and abs instructions, and | |
| some tricks doable by standard arithmetics. The use of conditional execution | |
| on chips where it is available is controlled by @option{-fif-conversion2}. | |
| Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}, but | |
| not with @option{-Og}. | |
| @opindex fif-conversion2 | |
| @opindex fno-if-conversion2 | |
| @item -fif-conversion2 | |
| Use conditional execution (where available) to transform conditional jumps into | |
| branch-less equivalents. | |
| Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}, but | |
| not with @option{-Og}. | |
| @opindex fdeclone-ctor-dtor | |
| @opindex fno-declone-ctor-dtor | |
| @item -fdeclone-ctor-dtor | |
| The C++ ABI requires multiple entry points for constructors and | |
| destructors: one for a base subobject, one for a complete object, and | |
| one for a virtual destructor that calls operator delete afterwards. | |
| For a hierarchy with virtual bases, the base and complete variants are | |
| clones, which means two copies of the function. With this option, the | |
| base and complete variants are changed to be thunks that call a common | |
| implementation. | |
| Enabled by @option{-Os}. | |
| @opindex fdelete-null-pointer-checks | |
| @opindex fno-delete-null-pointer-checks | |
| @item -fdelete-null-pointer-checks | |
| Assume that programs cannot safely dereference null pointers, and that | |
| no code or data element resides at address zero. | |
| This option enables simple constant | |
| folding optimizations at all optimization levels. In addition, other | |
| optimization passes in GCC use this flag to control global dataflow | |
| analyses that eliminate useless checks for null pointers; these assume | |
| that a memory access to address zero always results in a trap, so | |
| that if a pointer is checked after it has already been dereferenced, | |
| it cannot be null. | |
| Note however that in some environments this assumption is not true. | |
| Use @option{-fno-delete-null-pointer-checks} to disable this optimization | |
| for programs that depend on that behavior. | |
| This option is enabled by default on most targets. | |
| On AVR and MSP430, this option is completely disabled. | |
| Passes that use the dataflow information | |
| are enabled independently at different optimization levels. | |
| @opindex fdevirtualize | |
| @opindex fno-devirtualize | |
| @item -fdevirtualize | |
| Attempt to convert calls to virtual functions to direct calls. This | |
| is done both within a procedure and interprocedurally as part of | |
| indirect inlining (@option{-findirect-inlining}) and interprocedural constant | |
| propagation (@option{-fipa-cp}). | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fdevirtualize-speculatively | |
| @opindex fno-devirtualize-speculatively | |
| @item -fdevirtualize-speculatively | |
| Attempt to convert calls to virtual functions to speculative direct calls. | |
| Based on the analysis of the type inheritance graph, determine for a given call | |
| the set of likely targets. If the set is small, preferably of size 1, change | |
| the call into a conditional deciding between direct and indirect calls. The | |
| speculative calls enable more optimizations, such as inlining. When they seem | |
| useless after further optimization, they are converted back into original form. | |
| @opindex fdevirtualize-at-ltrans | |
| @opindex fno-devirtualize-at-ltrans | |
| @item -fdevirtualize-at-ltrans | |
| Stream extra information needed for aggressive devirtualization when running | |
| the link-time optimizer in local transformation mode. | |
| This option enables more devirtualization but | |
| significantly increases the size of streamed data. For this reason it is | |
| disabled by default. | |
| @opindex fexpensive-optimizations | |
| @opindex fno-expensive-optimizations | |
| @item -fexpensive-optimizations | |
| Perform a number of minor optimizations that are relatively expensive. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fext-dce | |
| @opindex fno-ext-dce | |
| @item -fext-dce | |
| @itemx -fno-ext-dce | |
| Perform dead code elimination on zero and sign extensions, with special | |
| dataflow analysis. | |
| @opindex free | |
| @opindex fno-ree | |
| @item -free | |
| Attempt to remove redundant extension instructions. This is especially | |
| helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit | |
| registers after writing to their lower 32-bit half. | |
| Enabled for Alpha, AArch64, LoongArch, PowerPC, RISC-V, SPARC, h83000 and x86 at | |
| levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fno-lifetime-dse | |
| @opindex flifetime-dse | |
| @item -fno-lifetime-dse | |
| In C++ the value of an object is only affected by changes within its | |
| lifetime: when the constructor begins, the object has an indeterminate | |
| value, and any changes during the lifetime of the object are dead when | |
| the object is destroyed. Normally dead store elimination will take | |
| advantage of this; if your code relies on the value of the object | |
| storage persisting beyond the lifetime of the object, you can use this | |
| flag to disable this optimization. To preserve stores before the | |
| constructor starts (e.g.@: because your operator new clears the object | |
| storage) but still treat the object as dead after the destructor, you | |
| can use @option{-flifetime-dse=1}. The default behavior can be | |
| explicitly selected with @option{-flifetime-dse=2}. | |
| @option{-flifetime-dse=0} is equivalent to @option{-fno-lifetime-dse}. | |
| @opindex flive-range-shrinkage | |
| @opindex fno-live-range-shrinkage | |
| @item -flive-range-shrinkage | |
| Attempt to decrease register pressure through register live range | |
| shrinkage. This is helpful for fast processors with small or moderate | |
| size register sets. | |
| @opindex fira-algorithm | |
| @item -fira-algorithm=@var{algorithm} | |
| Use the specified coloring algorithm for the integrated register | |
| allocator. The @var{algorithm} argument can be @samp{priority}, which | |
| specifies Chow's priority coloring, or @samp{CB}, which specifies | |
| Chaitin-Briggs coloring. Chaitin-Briggs coloring is not implemented | |
| for all architectures, but for those targets that do support it, it is | |
| the default because it generates better code. | |
| @opindex fira-region | |
| @item -fira-region=@var{region} | |
| Use specified regions for the integrated register allocator. The | |
| @var{region} argument should be one of the following: | |
| @table @samp | |
| @item all | |
| Use all loops as register allocation regions. | |
| This can give the best results for machines with a small and/or | |
| irregular register set. | |
| @item mixed | |
| Use all loops except for loops with small register pressure | |
| as the regions. This value usually gives | |
| the best results in most cases and for most architectures, | |
| and is enabled by default when compiling with optimization for speed | |
| (@option{-O}, @option{-O2}, @dots{}). | |
| @item one | |
| Use all functions as a single region. | |
| This typically results in the smallest code size, and is enabled by default for | |
| @option{-Os} or @option{-O0}. | |
| @end table | |
| @opindex fira-hoist-pressure | |
| @opindex fno-ira-hoist-pressure | |
| @item -fira-hoist-pressure | |
| Use IRA to evaluate register pressure in the code hoisting pass for | |
| decisions to hoist expressions. This option usually results in smaller | |
| code, but it can slow the compiler down. | |
| This option is enabled at level @option{-Os} for all targets. | |
| @opindex fira-loop-pressure | |
| @opindex fno-ira-loop-pressure | |
| @item -fira-loop-pressure | |
| Use IRA to evaluate register pressure in loops for decisions to move | |
| loop invariants. This option usually results in generation | |
| of faster and smaller code on machines with large register files (>= 32 | |
| registers), but it can slow the compiler down. | |
| This option is enabled at level @option{-O3} for some targets. | |
| @opindex fno-ira-share-save-slots | |
| @opindex fira-share-save-slots | |
| @item -fno-ira-share-save-slots | |
| Disable sharing of stack slots used for saving call-used hard | |
| registers living through a call. Each hard register gets a | |
| separate stack slot, and as a result function stack frames are | |
| larger. | |
| @opindex fno-ira-share-spill-slots | |
| @opindex fira-share-spill-slots | |
| @item -fno-ira-share-spill-slots | |
| Disable sharing of stack slots allocated for pseudo-registers. Each | |
| pseudo-register that does not get a hard register gets a separate | |
| stack slot, and as a result function stack frames are larger. | |
| @opindex flra-remat | |
| @opindex fno-lra-remat | |
| @item -flra-remat | |
| Enable CFG-sensitive rematerialization in LRA. Instead of loading | |
| values of spilled pseudos, LRA tries to rematerialize (recalculate) | |
| values if it is profitable. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fdelayed-branch | |
| @opindex fno-delayed-branch | |
| @item -fdelayed-branch | |
| If supported for the target machine, attempt to reorder instructions | |
| to exploit instruction slots available after delayed branch | |
| instructions. | |
| Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}, | |
| but not at @option{-Og}. | |
| @opindex fschedule-insns | |
| @opindex fno-schedule-insns | |
| @item -fschedule-insns | |
| If supported for the target machine, attempt to reorder instructions to | |
| eliminate execution stalls due to required data being unavailable. This | |
| helps machines that have slow floating point or memory load instructions | |
| by allowing other instructions to be issued until the result of the load | |
| or floating-point instruction is required. | |
| Conventionally enabled at optimization levels @option{-O2} and @option{-O3}. | |
| However, many targets override this behavior. For example, on x86, it is | |
| disabled at all levels, while on AArch64, it is enabled only at @option{-O3}. | |
| @opindex fschedule-insns2 | |
| @opindex fno-schedule-insns2 | |
| @item -fschedule-insns2 | |
| Similar to @option{-fschedule-insns}, but requests an additional pass of | |
| instruction scheduling after register allocation has been done. This is | |
| especially useful on machines with a relatively small number of | |
| registers and where memory load instructions take more than one cycle. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fno-sched-interblock | |
| @opindex fsched-interblock | |
| @item -fno-sched-interblock | |
| Disable instruction scheduling across basic blocks, which | |
| is normally enabled when scheduling before register allocation, i.e.@: | |
| with @option{-fschedule-insns} or at @option{-O2} or higher. | |
| @opindex fno-sched-spec | |
| @opindex fsched-spec | |
| @item -fno-sched-spec | |
| Disable speculative motion of non-load instructions, which | |
| is normally enabled when scheduling before register allocation, i.e.@: | |
| with @option{-fschedule-insns} or at @option{-O2} or higher. | |
| @opindex fsched-pressure | |
| @opindex fno-sched-pressure | |
| @item -fsched-pressure | |
| Enable register pressure sensitive insn scheduling before register | |
| allocation. This only makes sense when scheduling before register | |
| allocation is enabled, i.e.@: with @option{-fschedule-insns} or at | |
| @option{-O2} or higher. Usage of this option can improve the | |
| generated code and decrease its size by preventing register pressure | |
| increase above the number of available hard registers and subsequent | |
| spills in register allocation. | |
| @opindex fsched-spec-load | |
| @opindex fno-sched-spec-load | |
| @item -fsched-spec-load | |
| Allow speculative motion of some load instructions. This only makes | |
| sense when scheduling before register allocation, i.e.@: with | |
| @option{-fschedule-insns} or at @option{-O2} or higher. | |
| @opindex fsched-spec-load-dangerous | |
| @opindex fno-sched-spec-load-dangerous | |
| @item -fsched-spec-load-dangerous | |
| Allow speculative motion of more load instructions. This only makes | |
| sense when scheduling before register allocation, i.e.@: with | |
| @option{-fschedule-insns} or at @option{-O2} or higher. | |
| @opindex fsched-stalled-insns | |
| @opindex fno-sched-stalled-insns | |
| @item -fsched-stalled-insns | |
| @itemx -fsched-stalled-insns=@var{n} | |
| Define how many insns (if any) can be moved prematurely from the queue | |
| of stalled insns into the ready list during the second scheduling pass. | |
| @option{-fno-sched-stalled-insns} means that no insns are moved | |
| prematurely, @option{-fsched-stalled-insns=0} means there is no limit | |
| on how many queued insns can be moved prematurely. | |
| @option{-fsched-stalled-insns} without a value is equivalent to | |
| @option{-fsched-stalled-insns=1}. | |
| @opindex fsched-stalled-insns-dep | |
| @opindex fno-sched-stalled-insns-dep | |
| @item -fsched-stalled-insns-dep | |
| @itemx -fsched-stalled-insns-dep=@var{n} | |
| Define how many insn groups (cycles) are examined for a dependency | |
| on a stalled insn that is a candidate for premature removal from the queue | |
| of stalled insns. This has an effect only during the second scheduling pass, | |
| and only if @option{-fsched-stalled-insns} is used. | |
| @option{-fno-sched-stalled-insns-dep} is equivalent to | |
| @option{-fsched-stalled-insns-dep=0}. | |
| @option{-fsched-stalled-insns-dep} without a value is equivalent to | |
| @option{-fsched-stalled-insns-dep=1}. | |
| @opindex fsched2-use-superblocks | |
| @opindex fno-sched2-use-superblocks | |
| @item -fsched2-use-superblocks | |
| When scheduling after register allocation, use superblock scheduling. | |
| This allows motion across basic block boundaries, | |
| resulting in faster schedules. This option is experimental, as not all machine | |
| descriptions used by GCC model the CPU closely enough to avoid unreliable | |
| results from the algorithm. | |
| This only makes sense when scheduling after register allocation, i.e.@: with | |
| @option{-fschedule-insns2} or at @option{-O2} or higher. | |
| @opindex fsched-group-heuristic | |
| @opindex fno-sched-group-heuristic | |
| @item -fsched-group-heuristic | |
| Enable the group heuristic in the scheduler. This heuristic favors | |
| the instruction that belongs to a schedule group. This is enabled | |
| by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} | |
| or @option{-fschedule-insns2} or at @option{-O2} or higher. | |
| @opindex fsched-critical-path-heuristic | |
| @opindex fno-sched-critical-path-heuristic | |
| @item -fsched-critical-path-heuristic | |
| Enable the critical-path heuristic in the scheduler. This heuristic favors | |
| instructions on the critical path. This is enabled by default when | |
| scheduling is enabled, i.e.@: with @option{-fschedule-insns} | |
| or @option{-fschedule-insns2} or at @option{-O2} or higher. | |
| @opindex fsched-spec-insn-heuristic | |
| @opindex fno-sched-spec-insn-heuristic | |
| @item -fsched-spec-insn-heuristic | |
| Enable the speculative instruction heuristic in the scheduler. This | |
| heuristic favors speculative instructions with greater dependency weakness. | |
| This is enabled by default when scheduling is enabled, i.e.@: | |
| with @option{-fschedule-insns} or @option{-fschedule-insns2} | |
| or at @option{-O2} or higher. | |
| @opindex fsched-rank-heuristic | |
| @opindex fno-sched-rank-heuristic | |
| @item -fsched-rank-heuristic | |
| Enable the rank heuristic in the scheduler. This heuristic favors | |
| the instruction belonging to a basic block with greater size or frequency. | |
| This is enabled by default when scheduling is enabled, i.e.@: | |
| with @option{-fschedule-insns} or @option{-fschedule-insns2} or | |
| at @option{-O2} or higher. | |
| @opindex fsched-last-insn-heuristic | |
| @opindex fno-sched-last-insn-heuristic | |
| @item -fsched-last-insn-heuristic | |
| Enable the last-instruction heuristic in the scheduler. This heuristic | |
| favors the instruction that is less dependent on the last instruction | |
| scheduled. This is enabled by default when scheduling is enabled, | |
| i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or | |
| at @option{-O2} or higher. | |
| @opindex fsched-dep-count-heuristic | |
| @opindex fno-sched-dep-count-heuristic | |
| @item -fsched-dep-count-heuristic | |
| Enable the dependent-count heuristic in the scheduler. This heuristic | |
| favors the instruction that has more instructions depending on it. | |
| This is enabled by default when scheduling is enabled, i.e.@: | |
| with @option{-fschedule-insns} or @option{-fschedule-insns2} or | |
| at @option{-O2} or higher. | |
| @opindex fspeculatively-call-stored-functions | |
| @opindex fno-speculatively-call-stored-functions | |
| @item -fspeculatively-call-stored-functions | |
| Attempt to convert indirect calls of function pointers to pointers | |
| loaded from a structure field if all visible stores to that field store | |
| just a single candidate. When doing so, turn the call into a | |
| conditional deciding between the direct call and the original indirect | |
| one. These speculative calls often enable more optimizations, such as | |
| inlining. When they seem useless after further optimization, they are | |
| converted back into original form. | |
| @opindex freschedule-modulo-scheduled-loops | |
| @opindex fno-reschedule-modulo-scheduled-loops | |
| @item -freschedule-modulo-scheduled-loops | |
| Modulo scheduling is performed before traditional scheduling. If a loop | |
| is modulo scheduled, later scheduling passes may change its schedule. | |
| Use this option to control that behavior. | |
| @opindex fselective-scheduling | |
| @opindex fno-selective-scheduling | |
| @item -fselective-scheduling | |
| Schedule instructions using selective scheduling algorithm. Selective | |
| scheduling runs instead of the first scheduler pass. | |
| @opindex fselective-scheduling2 | |
| @opindex fno-selective-scheduling2 | |
| @item -fselective-scheduling2 | |
| Schedule instructions using selective scheduling algorithm. Selective | |
| scheduling runs instead of the second scheduler pass. | |
| @opindex fsel-sched-pipelining | |
| @opindex fno-sel-sched-pipelining | |
| @item -fsel-sched-pipelining | |
| Enable software pipelining of innermost loops during selective scheduling. | |
| This option has no effect unless one of @option{-fselective-scheduling} or | |
| @option{-fselective-scheduling2} is turned on. | |
| @opindex fsel-sched-pipelining-outer-loops | |
| @opindex fno-sel-sched-pipelining-outer-loops | |
| @item -fsel-sched-pipelining-outer-loops | |
| When pipelining loops during selective scheduling, also pipeline outer loops. | |
| This option has no effect unless @option{-fsel-sched-pipelining} is turned on. | |
| @opindex fsemantic-interposition | |
| @opindex fno-semantic-interposition | |
| @item -fsemantic-interposition | |
| Some object formats, like ELF, allow interposing of symbols by the | |
| dynamic linker. | |
| This means that for symbols exported from the DSO, the compiler cannot perform | |
| interprocedural propagation, inlining and other optimizations in anticipation | |
| that the function or variable in question may change. While this feature is | |
| useful, for example, to rewrite memory allocation functions by a debugging | |
| implementation, it is expensive in the terms of code quality. | |
| With @option{-fno-semantic-interposition} the compiler assumes that | |
| if interposition happens for functions the overwriting function will have | |
| precisely the same semantics (and side effects). | |
| Similarly if interposition happens | |
| for variables, the constructor of the variable will be the same. The flag | |
| has no effect for functions explicitly declared inline | |
| (where it is never allowed for interposition to change semantics) | |
| and for symbols explicitly declared weak. | |
| @opindex fshrink-wrap | |
| @opindex fno-shrink-wrap | |
| @item -fshrink-wrap | |
| Emit function prologues only before parts of the function that need it, | |
| rather than at the top of the function. This flag is enabled by default at | |
| @option{-O} and higher. | |
| @opindex fshrink-wrap-separate | |
| @opindex fno-shrink-wrap-separate | |
| @item -fshrink-wrap-separate | |
| Shrink-wrap separate parts of the prologue and epilogue separately, so that | |
| those parts are only executed when needed. | |
| This option is on by default, but has no effect unless @option{-fshrink-wrap} | |
| is also turned on and the target supports this. | |
| @opindex fcaller-saves | |
| @opindex fno-caller-saves | |
| @item -fcaller-saves | |
| Enable allocation of values to registers that are clobbered by | |
| function calls, by emitting extra instructions to save and restore the | |
| registers around such calls. Such allocation is done only when it | |
| seems to result in better code. | |
| This option is always enabled by default on certain machines, usually | |
| those which have no call-preserved registers to use instead. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fcombine-stack-adjustments | |
| @opindex fno-combine-stack-adjustments | |
| @item -fcombine-stack-adjustments | |
| Tracks stack adjustments (pushes and pops) and stack memory references | |
| and then tries to find ways to combine them. | |
| Enabled by default at @option{-O1} and higher. | |
| @opindex fipa-ra | |
| @opindex fno-ipa-ra | |
| @item -fipa-ra | |
| Use caller save registers for allocation if those registers are not used by | |
| any called function. In that case it is not necessary to save and restore | |
| them around calls. This is only possible if called functions are part of | |
| same compilation unit as current function and they are compiled before it. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}, however the option | |
| is disabled if generated code will be instrumented for profiling | |
| (@option{-p}, or @option{-pg}) or if callee's register usage cannot be known | |
| exactly (this happens on targets that do not expose prologues | |
| and epilogues in RTL). | |
| @opindex fconserve-stack | |
| @opindex fno-conserve-stack | |
| @item -fconserve-stack | |
| Attempt to minimize stack usage. The compiler attempts to use less | |
| stack space, even if that makes the program slower. This option | |
| implies setting the @option{large-stack-frame} parameter to 100 | |
| and the @option{large-stack-frame-growth} parameter to 400. | |
| @opindex ftree-reassoc | |
| @opindex fno-tree-reassoc | |
| @item -ftree-reassoc | |
| Perform reassociation on trees. This flag is enabled by default | |
| at @option{-O1} and higher. | |
| @opindex fcode-hoisting | |
| @opindex fno-code-hoisting | |
| @item -fcode-hoisting | |
| Perform code hoisting. Code hoisting tries to move the | |
| evaluation of expressions executed on all paths to the function exit | |
| as early as possible. This is especially useful as a code size | |
| optimization, but it often helps for code speed as well. | |
| This flag is enabled by default at @option{-O2} and higher. | |
| @opindex ftree-pre | |
| @opindex fno-tree-pre | |
| @item -ftree-pre | |
| Perform partial redundancy elimination (PRE) on trees. This flag is | |
| enabled by default at @option{-O2} and @option{-O3}. | |
| @opindex ftree-partial-pre | |
| @opindex fno-tree-partial-pre | |
| @item -ftree-partial-pre | |
| Make partial redundancy elimination (PRE) more aggressive. This flag is | |
| enabled by default at @option{-O3}. | |
| @opindex ftree-forwprop | |
| @opindex fno-tree-forwprop | |
| @item -ftree-forwprop | |
| Perform forward propagation on trees. This flag is enabled by default | |
| at @option{-O1} and higher. | |
| @opindex ftree-fre | |
| @opindex fno-tree-fre | |
| @item -ftree-fre | |
| Perform full redundancy elimination (FRE) on trees. The difference | |
| between FRE and PRE is that FRE only considers expressions | |
| that are computed on all paths leading to the redundant computation. | |
| This analysis is faster than PRE, though it exposes fewer redundancies. | |
| This flag is enabled by default at @option{-O1} and higher. | |
| @opindex ftree-phiprop | |
| @opindex fno-tree-phiprop | |
| @item -ftree-phiprop | |
| Perform hoisting of loads from conditional pointers on trees. This | |
| pass is enabled by default at @option{-O1} and higher. | |
| @opindex fhoist-adjacent-loads | |
| @opindex fno-hoist-adjacent-loads | |
| @item -fhoist-adjacent-loads | |
| Speculatively hoist loads from both branches of an if-then-else if the | |
| loads are from adjacent locations in the same structure and the target | |
| architecture has a conditional move instruction. This flag is enabled | |
| by default at @option{-O2} and higher. | |
| @opindex ftree-copy-prop | |
| @opindex fno-tree-copy-prop | |
| @item -ftree-copy-prop | |
| Perform copy propagation on trees. This pass eliminates unnecessary | |
| copy operations. This flag is enabled by default at @option{-O1} and | |
| higher. | |
| @opindex fipa-pure-const | |
| @opindex fno-ipa-pure-const | |
| @item -fipa-pure-const | |
| Discover which functions are pure or constant. | |
| Enabled by default at @option{-O1} and higher. | |
| @opindex fipa-reference | |
| @opindex fno-ipa-reference | |
| @item -fipa-reference | |
| Discover which static variables do not escape the | |
| compilation unit. | |
| Enabled by default at @option{-O1} and higher. | |
| @opindex fipa-reference-addressable | |
| @opindex fno-ipa-reference-addressable | |
| @item -fipa-reference-addressable | |
| Discover read-only, write-only and non-addressable static variables. | |
| Enabled by default at @option{-O1} and higher. | |
| @opindex fipa-reorder-for-locality | |
| @opindex fno-ipa-reorder-for-locality | |
| @item -fipa-reorder-for-locality | |
| Group call chains close together in the binary layout to improve code | |
| locality and minimize jump distances between frequently called functions. | |
| Unlike @option{-freorder-functions} this pass considers the call | |
| chains between functions and groups them together, rather than grouping all | |
| hot/normal/cold/never-executed functions into separate sections. | |
| Unlike @option{-fprofile-reorder-functions} it aims to improve code locality | |
| throughout the runtime of the program rather than focusing on program startup. | |
| This option is incompatible with an explicit | |
| @option{-flto-partition=} option since it enforces a custom partitioning | |
| scheme. | |
| If using this option it is recommended to also use profile feedback, but this | |
| option is not enabled by default otherwise. | |
| @opindex fipa-stack-alignment | |
| @opindex fno-ipa-stack-alignment | |
| @item -fipa-stack-alignment | |
| Reduce stack alignment on call sites if possible. | |
| Enabled by default. | |
| @opindex fipa-pta | |
| @opindex fno-ipa-pta | |
| @item -fipa-pta | |
| Perform interprocedural pointer analysis and interprocedural modification | |
| and reference analysis. This option can cause excessive memory and | |
| compile-time usage on large compilation units. It is not enabled by | |
| default at any optimization level. | |
| @opindex fipa-profile | |
| @opindex fno-ipa-profile | |
| @item -fipa-profile | |
| Perform interprocedural profile propagation. The functions called only from | |
| cold functions are marked as cold. Also functions executed once (such as | |
| @code{cold}, @code{noreturn}, static constructors or destructors) are | |
| identified. Cold functions and loop less parts of functions executed once are | |
| then optimized for size. | |
| Enabled by default at @option{-O1} and higher. | |
| @opindex fipa-modref | |
| @opindex fno-ipa-modref | |
| @item -fipa-modref | |
| Perform interprocedural mod/ref analysis. This optimization analyzes the side | |
| effects of functions (memory locations that are modified or referenced) and | |
| enables better optimization across the function call boundary. This flag is | |
| enabled by default at @option{-O1} and higher. | |
| @opindex fipa-cp | |
| @opindex fno-ipa-cp | |
| @item -fipa-cp | |
| Perform interprocedural constant propagation. | |
| This optimization analyzes the program to determine when values passed | |
| to functions are constants and then optimizes accordingly. | |
| This optimization can substantially increase performance | |
| if the application has constants passed to functions. | |
| This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}. | |
| It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex fipa-cp-clone | |
| @opindex fno-ipa-cp-clone | |
| @item -fipa-cp-clone | |
| Perform function cloning to make interprocedural constant propagation stronger. | |
| When enabled, interprocedural constant propagation performs function cloning | |
| when externally visible function can be called with constant arguments. | |
| Because this optimization can create multiple copies of functions, | |
| it may significantly increase code size. | |
| This flag is enabled by default at @option{-O3}. | |
| It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex fipa-bit-cp | |
| @opindex fno-ipa-bit-cp | |
| @item -fipa-bit-cp | |
| When enabled, perform interprocedural bitwise constant | |
| propagation. This flag is enabled by default at @option{-O2} and | |
| by @option{-fprofile-use} and @option{-fauto-profile}. | |
| It requires that @option{-fipa-cp} is enabled. | |
| @opindex fipa-vrp | |
| @opindex fno-ipa-vrp | |
| @item -fipa-vrp | |
| When enabled, perform interprocedural propagation of value | |
| ranges. This flag is enabled by default at @option{-O2}. It requires | |
| that @option{-fipa-cp} is enabled. | |
| @opindex fipa-icf | |
| @opindex fipa-icf-functions | |
| @opindex fipa-icf-variables | |
| @opindex fno-ipa-icf | |
| @opindex fno-ipa-icf-functions | |
| @opindex fno-ipa-icf-variables | |
| @item -fipa-icf-functions | |
| @itemx -fipa-icf-variables | |
| @itemx -fipa-icf | |
| Perform Identical Code Folding for functions (@option{-fipa-icf-functions}), | |
| read-only variables (@option{-fipa-icf-variables}), or both | |
| (@option{-fipa-icf}). | |
| The optimization reduces code size and may disturb unwind stacks by replacing | |
| a function by an equivalent one with a different name. The optimization works | |
| more effectively with link-time optimization enabled. | |
| Although the behavior is similar to the Gold Linker's ICF optimization, GCC ICF | |
| works on different levels and thus the optimizations are not same - there are | |
| equivalences that are found only by GCC and equivalences found only by Gold. | |
| @option{-fipa-icf} is enabled by default at @option{-O2} and @option{-Os}. | |
| @opindex flate-combine-instructions | |
| @opindex fno-late-combine-instructions | |
| @item -flate-combine-instructions | |
| Enable two instruction combination passes that run relatively late in the | |
| compilation process. One of the passes runs before register allocation and | |
| the other after register allocation. The main aim of the passes is to | |
| substitute definitions into all uses. | |
| Most targets enable this flag by default at @option{-O2} and @option{-Os}. | |
| @opindex flive-patching | |
| @item -flive-patching=@var{level} | |
| Control GCC's optimizations to produce output suitable for live-patching. | |
| If the compiler's optimization uses a function's body or information extracted | |
| from its body to optimize/change another function, the latter is called an | |
| impacted function of the former. If a function is patched, its impacted | |
| functions should be patched too. | |
| The impacted functions are determined by the compiler's interprocedural | |
| optimizations. For example, a caller is impacted when inlining a function | |
| into its caller, | |
| cloning a function and changing its caller to call this new clone, | |
| or extracting a function's pureness/constness information to optimize | |
| its direct or indirect callers, etc. | |
| Usually, the more IPA optimizations enabled, the larger the number of | |
| impacted functions for each function. In order to control the number of | |
| impacted functions and more easily compute the list of impacted function, | |
| IPA optimizations can be partially enabled at two different levels. | |
| The @var{level} argument should be one of the following: | |
| @table @samp | |
| @item inline-clone | |
| Only enable inlining and cloning optimizations, which includes inlining, | |
| cloning, interprocedural scalar replacement of aggregates and partial inlining. | |
| As a result, when patching a function, all its callers and its clones' | |
| callers are impacted, therefore need to be patched as well. | |
| @option{-flive-patching=inline-clone} disables the following optimization flags: | |
| @gccoptlist{-fwhole-program -fipa-pta -fipa-reference -fipa-ra | |
| -fipa-icf -fipa-icf-functions -fipa-icf-variables | |
| -fipa-bit-cp -fipa-vrp -fipa-pure-const | |
| -fipa-reference-addressable | |
| -fipa-stack-alignment -fipa-modref} | |
| @item inline-only-static | |
| Only enable inlining of static functions. | |
| As a result, when patching a static function, all its callers are impacted | |
| and so need to be patched as well. | |
| In addition to all the flags that @option{-flive-patching=inline-clone} | |
| disables, | |
| @option{-flive-patching=inline-only-static} disables the following additional | |
| optimization flags: | |
| @gccoptlist{-fipa-cp-clone -fipa-sra -fpartial-inlining -fipa-cp} | |
| @end table | |
| When @option{-flive-patching} is specified without any value, the default value | |
| is @var{inline-clone}. | |
| This flag is disabled by default. | |
| Note that @option{-flive-patching} is not supported with link-time optimization | |
| (@option{-flto}). | |
| @opindex fisolate-erroneous-paths-dereference | |
| @opindex fno-isolate-erroneous-paths-dereference | |
| @item -fisolate-erroneous-paths-dereference | |
| Detect paths that trigger erroneous or undefined behavior due to | |
| dereferencing a null pointer (with @option{-fdelete-null-pointer-checks} | |
| enabled) or a division by zero. Isolate those paths from the main control | |
| flow and turn the statement with erroneous or undefined behavior into a | |
| trap. This flag is enabled by default at @option{-O2} and higher. | |
| @opindex fisolate-erroneous-paths-attribute | |
| @opindex fno-isolate-erroneous-paths-attribute | |
| @item -fisolate-erroneous-paths-attribute | |
| Detect paths that trigger erroneous or undefined behavior due to a null value | |
| being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull} | |
| attribute. Isolate those paths from the main control flow and turn the | |
| statement with erroneous or undefined behavior into a trap. This is not | |
| currently enabled, but may be enabled by @option{-O2} in the future. | |
| @opindex ftree-sink | |
| @opindex fno-tree-sink | |
| @item -ftree-sink | |
| Perform forward store motion on trees. This flag is | |
| enabled by default at @option{-O1} and higher. | |
| @opindex ftree-bit-ccp | |
| @opindex fno-tree-bit-ccp | |
| @item -ftree-bit-ccp | |
| Perform sparse conditional bit constant propagation on trees and propagate | |
| pointer alignment information. | |
| This pass only operates on local scalar variables and is enabled by default | |
| at @option{-O1} and higher, except for @option{-Og}. | |
| It requires that @option{-ftree-ccp} is enabled. | |
| @opindex ftree-ccp | |
| @opindex fno-tree-ccp | |
| @item -ftree-ccp | |
| Perform sparse conditional constant propagation (CCP) on trees. This | |
| pass only operates on local scalar variables and is enabled by default | |
| at @option{-O1} and higher. | |
| @opindex fssa-backprop | |
| @opindex fno-ssa-backprop | |
| @item -fssa-backprop | |
| Propagate information about uses of a value up the definition chain | |
| in order to simplify the definitions. For example, this pass strips | |
| sign operations if the sign of a value never matters. The flag is | |
| enabled by default at @option{-O1} and higher. | |
| @opindex fssa-phiopt | |
| @opindex fno-ssa-phiopt | |
| @item -fssa-phiopt | |
| Perform pattern matching on SSA PHI nodes to optimize conditional | |
| code. This pass is enabled by default at @option{-O1} and higher, | |
| except for @option{-Og}. | |
| @opindex ftree-switch-conversion | |
| @opindex fno-tree-switch-conversion | |
| @item -ftree-switch-conversion | |
| Perform conversion of simple initializations in a switch to | |
| initializations from a scalar array. This flag is enabled by default | |
| at @option{-O2} and higher. | |
| @opindex ftree-tail-merge | |
| @opindex fno-tree-tail-merge | |
| @item -ftree-tail-merge | |
| Look for identical code sequences. When found, replace one with a jump to the | |
| other. This optimization is known as tail merging or cross jumping. This flag | |
| is enabled by default at @option{-O2} and higher. The compilation time | |
| in this pass can | |
| be limited using @option{max-tail-merge-comparisons} parameter and | |
| @option{max-tail-merge-iterations} parameter. | |
| @opindex ftree-cselim | |
| @opindex fno-tree-cselim | |
| @item -ftree-cselim | |
| Perform conditional store elimination on trees. This flag is enabled by | |
| default at @option{-O1} and higher on targets that have conditional | |
| move instructions. | |
| @opindex ftree-dce | |
| @opindex fno-tree-dce | |
| @item -ftree-dce | |
| Perform dead code elimination (DCE) on trees. This flag is enabled by | |
| default at @option{-O1} and higher. | |
| @opindex ftree-builtin-call-dce | |
| @opindex fno-tree-builtin-call-dce | |
| @item -ftree-builtin-call-dce | |
| Perform conditional dead code elimination (DCE) for calls to built-in functions | |
| that may set @code{errno} but are otherwise free of side effects. This flag is | |
| enabled by default at @option{-O2} and higher if @option{-Os} is not also | |
| specified. | |
| @opindex ffinite-loops | |
| @opindex fno-finite-loops | |
| @item -ffinite-loops | |
| Assume that a loop with an exit will eventually take the exit and not loop | |
| indefinitely. This allows the compiler to remove loops that otherwise have | |
| no side-effects, not considering eventual endless looping as such. | |
| This option is enabled by default at @option{-O2} for C++ with -std=c++11 | |
| or higher. | |
| @opindex ftree-dominator-opts | |
| @opindex fno-tree-dominator-opts | |
| @item -ftree-dominator-opts | |
| Perform a variety of simple scalar cleanups (constant/copy | |
| propagation, redundancy elimination, range propagation and expression | |
| simplification) based on a dominator tree traversal. This also | |
| performs jump threading (to reduce jumps to jumps). This flag is | |
| enabled by default at @option{-O1} and higher. | |
| @opindex ftree-dse | |
| @opindex fno-tree-dse | |
| @item -ftree-dse | |
| Perform dead store elimination (DSE) on trees. A dead store is a store into | |
| a memory location that is later overwritten by another store without | |
| any intervening loads. In this case the earlier store can be deleted. This | |
| flag is enabled by default at @option{-O1} and higher. | |
| @opindex ftree-ch | |
| @opindex fno-tree-ch | |
| @item -ftree-ch | |
| Perform loop header copying on trees. This is beneficial since it increases | |
| effectiveness of code motion optimizations. It also saves one jump. This flag | |
| is enabled by default at @option{-O1} and higher. It is not enabled | |
| for @option{-Os}, since it usually increases code size. | |
| @opindex ftree-loop-optimize | |
| @opindex fno-tree-loop-optimize | |
| @item -ftree-loop-optimize | |
| Perform loop optimizations on trees. This flag is enabled by default | |
| at @option{-O1} and higher. | |
| @opindex ftree-loop-linear | |
| @opindex fno-tree-loop-linear | |
| @opindex floop-strip-mine | |
| @opindex fno-loop-strip-mine | |
| @opindex floop-block | |
| @opindex fno-loop-block | |
| @item -ftree-loop-linear | |
| @itemx -floop-strip-mine | |
| @itemx -floop-block | |
| Perform loop nest optimizations. Same as | |
| @option{-floop-nest-optimize}. To use this code transformation, GCC has | |
| to be configured with @option{--with-isl} to enable the Graphite loop | |
| transformation infrastructure. | |
| @opindex fgraphite-identity | |
| @opindex fno-graphite-identity | |
| @item -fgraphite-identity | |
| Enable the identity transformation for graphite. For every SCoP we generate | |
| the polyhedral representation and transform it back to gimple. Using | |
| @option{-fgraphite-identity} we can check the costs or benefits of the | |
| GIMPLE -> GRAPHITE -> GIMPLE transformation. Some minimal optimizations | |
| are also performed by the code generator isl, like index splitting and | |
| dead code elimination in loops. | |
| @opindex floop-nest-optimize | |
| @opindex fno-loop-nest-optimize | |
| @item -floop-nest-optimize | |
| Enable the isl based loop nest optimizer. This is a generic loop nest | |
| optimizer based on the Pluto optimization algorithms. It calculates a loop | |
| structure optimized for data-locality and parallelism. This option | |
| is experimental. | |
| @opindex floop-parallelize-all | |
| @opindex fno-loop-parallelize-all | |
| @item -floop-parallelize-all | |
| Use the Graphite data dependence analysis to identify loops that can | |
| be parallelized. Parallelize all the loops that can be analyzed to | |
| not contain loop carried dependences without checking that it is | |
| profitable to parallelize the loops. | |
| @opindex ftree-coalesce-vars | |
| @opindex fno-tree-coalesce-vars | |
| @item -ftree-coalesce-vars | |
| While transforming the program out of the SSA representation, attempt to | |
| reduce copying by coalescing versions of different user-defined | |
| variables, instead of just compiler temporaries. This may severely | |
| limit the ability to debug an optimized program compiled with | |
| @option{-fno-var-tracking-assignments}. In the negated form, this flag | |
| prevents SSA coalescing of user variables. This option is enabled by | |
| default if optimization is enabled, and it does very little otherwise. | |
| @opindex ftree-loop-distribution | |
| @opindex fno-tree-loop-distribution | |
| @item -ftree-loop-distribution | |
| Perform loop distribution. This flag can improve cache performance on | |
| big loop bodies and allow further loop optimizations, like | |
| parallelization or vectorization, to take place. For example, the loop | |
| @smallexample | |
| DO I = 1, N | |
| A(I) = B(I) + C | |
| D(I) = E(I) * F | |
| ENDDO | |
| @end smallexample | |
| is transformed to | |
| @smallexample | |
| DO I = 1, N | |
| A(I) = B(I) + C | |
| ENDDO | |
| DO I = 1, N | |
| D(I) = E(I) * F | |
| ENDDO | |
| @end smallexample | |
| This flag is enabled by default at @option{-O3}. | |
| It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex ftree-loop-distribute-patterns | |
| @opindex fno-tree-loop-distribute-patterns | |
| @item -ftree-loop-distribute-patterns | |
| Perform loop distribution of patterns that can be code generated with | |
| calls to a library. This flag is enabled by default at @option{-O2} and | |
| higher, and by @option{-fprofile-use} and @option{-fauto-profile}. | |
| This pass distributes the initialization loops and generates a call to | |
| memset zero. For example, the loop | |
| @smallexample | |
| DO I = 1, N | |
| A(I) = 0 | |
| B(I) = A(I) + I | |
| ENDDO | |
| @end smallexample | |
| is transformed to | |
| @smallexample | |
| DO I = 1, N | |
| A(I) = 0 | |
| ENDDO | |
| DO I = 1, N | |
| B(I) = A(I) + I | |
| ENDDO | |
| @end smallexample | |
| and the initialization loop is transformed into a call to memset zero. | |
| @opindex floop-interchange | |
| @opindex fno-loop-interchange | |
| @item -floop-interchange | |
| Perform loop interchange outside of graphite. This flag can improve cache | |
| performance on loop nest and allow further loop optimizations, like | |
| vectorization, to take place. For example, the loop | |
| @smallexample | |
| for (int i = 0; i < N; i++) | |
| for (int j = 0; j < N; j++) | |
| for (int k = 0; k < N; k++) | |
| c[i][j] = c[i][j] + a[i][k]*b[k][j]; | |
| @end smallexample | |
| is transformed to | |
| @smallexample | |
| for (int i = 0; i < N; i++) | |
| for (int k = 0; k < N; k++) | |
| for (int j = 0; j < N; j++) | |
| c[i][j] = c[i][j] + a[i][k]*b[k][j]; | |
| @end smallexample | |
| This flag is enabled by default at @option{-O3}. | |
| It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex floop-unroll-and-jam | |
| @opindex fno-loop-unroll-and-jam | |
| @item -floop-unroll-and-jam | |
| Apply unroll and jam transformations on feasible loops. In a loop | |
| nest this unrolls the outer loop by some factor and fuses the resulting | |
| multiple inner loops. This flag is enabled by default at @option{-O3}. | |
| It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex ftree-loop-im | |
| @opindex fno-tree-loop-im | |
| @item -ftree-loop-im | |
| Perform loop invariant motion on trees. This pass moves only invariants that | |
| are hard to handle at RTL level (function calls, operations that expand to | |
| nontrivial sequences of insns). With @option{-funswitch-loops} it also moves | |
| operands of conditions that are invariant out of the loop, so that we can use | |
| just trivial invariantness analysis in loop unswitching. The pass also includes | |
| store motion. | |
| @opindex ftree-loop-ivcanon | |
| @opindex fno-tree-loop-ivcanon | |
| @item -ftree-loop-ivcanon | |
| Create a canonical counter for number of iterations in loops for which | |
| determining number of iterations requires complicated analysis. Later | |
| optimizations then may determine the number easily. Useful especially | |
| in connection with unrolling. | |
| @opindex ftree-scev-cprop | |
| @opindex fno-tree-scev-cprop | |
| @item -ftree-scev-cprop | |
| Perform final value replacement. If a variable is modified in a loop | |
| in such a way that its value when exiting the loop can be determined using | |
| only its initial value and the number of loop iterations, replace uses of | |
| the final value by such a computation, provided it is sufficiently cheap. | |
| This reduces data dependencies and may allow further simplifications. | |
| Enabled by default at @option{-O1} and higher. | |
| @opindex fivopts | |
| @opindex fno-ivopts | |
| @item -fivopts | |
| Perform induction variable optimizations (strength reduction, induction | |
| variable merging and induction variable elimination) on trees. | |
| Enabled by default at @option{-O1} and higher. | |
| @opindex ftree-parallelize-loops | |
| @opindex fno-tree-parallelize-loops | |
| @item -ftree-parallelize-loops | |
| @itemx -ftree-parallelize-loops=@var{n} | |
| Parallelize loops, i.e., split their iteration space to run in multiple threads. | |
| This is only possible for loops whose iterations are independent | |
| and can be arbitrarily reordered. The optimization is only | |
| profitable on multiprocessor machines, for loops that are CPU-intensive, | |
| rather than constrained e.g.@: by memory bandwidth. This option | |
| implies @option{-pthread}, and thus is only supported on targets | |
| that have support for @option{-pthread}. | |
| When a positive value @var{n} is specified, the number of threads is fixed | |
| at compile time and cannot be changed after compilation. The compiler | |
| generates ``#pragma omp parallel num_threads(@var{n})''. | |
| When used without @code{=@var{n}} (i.e., @option{-ftree-parallelize-loops}), | |
| the number of threads is determined at program execution time via the | |
| @env{OMP_NUM_THREADS} environment variable. If @env{OMP_NUM_THREADS} is not | |
| set, the OpenMP runtime automatically detects the number of available | |
| processors and uses that value. This enables creating binaries that | |
| adapt to different hardware configurations without recompilation. | |
| @opindex ftree-pta | |
| @opindex fno-tree-pta | |
| @item -ftree-pta | |
| Perform function-local points-to analysis on trees. This flag is | |
| enabled by default at @option{-O1} and higher, except for @option{-Og}. | |
| @opindex ftree-sra | |
| @opindex fno-tree-sra | |
| @item -ftree-sra | |
| Perform scalar replacement of aggregates. This pass replaces structure | |
| references with scalars to prevent committing structures to memory too | |
| early. This flag is enabled by default at @option{-O1} and higher, | |
| except for @option{-Og}. | |
| @opindex fstore-merging | |
| @opindex fno-store-merging | |
| @item -fstore-merging | |
| Perform merging of narrow stores to consecutive memory addresses. This pass | |
| merges contiguous stores of immediate values narrower than a word into fewer | |
| wider stores to reduce the number of instructions. This is enabled by default | |
| at @option{-O2} and higher as well as @option{-Os}. | |
| @opindex ftree-ter | |
| @opindex fno-tree-ter | |
| @item -ftree-ter | |
| Perform temporary expression replacement during the SSA->normal phase. Single | |
| use/single def temporaries are replaced at their use location with their | |
| defining expression. This results in non-GIMPLE code, but gives the expanders | |
| much more complex trees to work on resulting in better RTL generation. This is | |
| enabled by default at @option{-O1} and higher. | |
| @opindex ftree-slsr | |
| @opindex fno-tree-slsr | |
| @item -ftree-slsr | |
| Perform straight-line strength reduction on trees. This recognizes related | |
| expressions involving multiplications and replaces them by less expensive | |
| calculations when possible. This is enabled by default at @option{-O1} and | |
| higher. | |
| @opindex ftree-vectorize | |
| @opindex fno-tree-vectorize | |
| @item -ftree-vectorize | |
| Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize} | |
| and @option{-ftree-slp-vectorize} if not explicitly specified. | |
| @opindex ftree-loop-vectorize | |
| @opindex fno-tree-loop-vectorize | |
| @item -ftree-loop-vectorize | |
| Perform loop vectorization on trees. This flag is enabled by default at | |
| @option{-O2} and by @option{-ftree-vectorize}, @option{-fprofile-use}, | |
| and @option{-fauto-profile}. | |
| @opindex ftree-slp-vectorize | |
| @opindex fno-tree-slp-vectorize | |
| @item -ftree-slp-vectorize | |
| Perform basic block vectorization on trees. This flag is enabled by default at | |
| @option{-O2} and by @option{-ftree-vectorize}, @option{-fprofile-use}, | |
| and @option{-fauto-profile}. | |
| @opindex ftrivial-auto-var-init | |
| @item -ftrivial-auto-var-init=@var{choice} | |
| Initialize automatic variables or temporary objects with either a pattern or with | |
| zeroes to increase the security and predictability of a program by preventing | |
| uninitialized memory disclosure and use. | |
| GCC still considers an automatic variable that doesn't have an explicit | |
| initializer as uninitialized, @option{-Wuninitialized} and | |
| @option{-Wanalyzer-use-of-uninitialized-value} will still report | |
| warning messages on such automatic variables or temporary objects and the | |
| compiler will perform optimization as if the variable were uninitialized. | |
| With this option, GCC will also initialize any padding of automatic variables | |
| or temporary objects that have structure or union types to zeroes. | |
| However, the current implementation cannot initialize automatic variables | |
| whose initialization is bypassed through @code{switch} or @code{goto} | |
| statement. Using @option{-Wtrivial-auto-var-init} to report all such cases. | |
| The three values of @var{choice} are: | |
| @itemize @bullet | |
| @item | |
| @samp{uninitialized} doesn't initialize any automatic variables. | |
| @item | |
| @samp{pattern} Initialize automatic variables with values which will likely | |
| transform logic bugs into crashes down the line, are easily recognized in a | |
| crash dump and without being values that programmers can rely on for useful | |
| program semantics. | |
| The current value is byte-repeatable pattern with byte "0xFE". | |
| The values used for pattern initialization might be changed in the future. | |
| @item | |
| @samp{zero} Initialize automatic variables with zeroes. | |
| @end itemize | |
| The default is @samp{uninitialized} except for C++26, in which case | |
| if @option{-ftrivial-auto-var-init=} is not specified at all automatic | |
| variables or temporary objects are zero initialized, but zero initialization | |
| of padding bits does not happen. | |
| Note that the initializer values, whether @samp{zero} or @samp{pattern}, | |
| refer to data representation (in memory or machine registers), rather | |
| than to their interpretation as numerical values. This distinction may | |
| be important in languages that support types with biases or implicit | |
| multipliers, and with such extensions as @samp{hardbool} (@pxref{Common | |
| Attributes}). For example, a variable that uses 8 bits to represent | |
| (biased) quantities in the @code{range 160..400} will be initialized | |
| with the bit patterns @code{0x00} or @code{0xFE}, depending on | |
| @var{choice}, whether or not these representations stand for values in | |
| that range, and even if they do, the interpretation of the value held by | |
| the variable will depend on the bias. A @samp{hardbool} variable that | |
| uses say @code{0x5A} and @code{0xA5} for @code{false} and @code{true}, | |
| respectively, will trap with either @samp{choice} of trivial | |
| initializer, i.e., @samp{zero} initialization will not convert to the | |
| representation for @code{false}, even if it would for a @code{static} | |
| variable of the same type. This means the initializer pattern doesn't | |
| generally depend on the type of the initialized variable. One notable | |
| exception is that (non-hardened) boolean variables that fit in registers | |
| are initialized with @code{false} (zero), even when @samp{pattern} is | |
| requested. | |
| You can control this behavior for a specific variable by using the variable | |
| attribute @code{uninitialized} standard attribute (@pxref{Common Attributes}) | |
| or the C++26 @code{[[indeterminate]]}. | |
| @opindex fvect-cost-model | |
| @opindex fno-vect-cost-model | |
| @item -fvect-cost-model=@var{model} | |
| Alter the cost model used for vectorization. The @var{model} argument | |
| should be one of @samp{unlimited}, @samp{dynamic}, @samp{cheap} or | |
| @samp{very-cheap}. | |
| With the @samp{unlimited} model the vectorized code-path is assumed | |
| to be profitable while with the @samp{dynamic} model a runtime check | |
| guards the vectorized code-path to enable it only for iteration | |
| counts that will likely execute faster than when executing the original | |
| scalar loop. The @samp{cheap} model disables vectorization of | |
| loops where doing so would be cost prohibitive for example due to | |
| required runtime checks for data dependence or alignment but otherwise | |
| is equal to the @samp{dynamic} model. The @samp{very-cheap} model disables | |
| vectorization of loops when any runtime check for data dependence or alignment | |
| is required, it also disables vectorization of epilogue loops but otherwise is | |
| equal to the @samp{cheap} model. | |
| The default cost model depends on other optimization flags and is | |
| either @samp{dynamic} or @samp{cheap}. | |
| @opindex fsimd-cost-model | |
| @item -fsimd-cost-model=@var{model} | |
| Alter the cost model used for vectorization of loops marked with the OpenMP | |
| simd directive. The @var{model} argument should be one of | |
| @samp{unlimited}, @samp{dynamic}, @samp{cheap}. All values of @var{model} | |
| have the same meaning as described in @option{-fvect-cost-model} and by | |
| default a cost model defined with @option{-fvect-cost-model} is used. | |
| @opindex ftree-vrp | |
| @opindex fno-tree-vrp | |
| @item -ftree-vrp | |
| Perform Value Range Propagation on trees. This is similar to the | |
| constant propagation pass, but instead of values, ranges of values are | |
| propagated. This allows the optimizers to remove unnecessary range | |
| checks like array bound checks and null pointer checks. This is | |
| enabled by default at @option{-O2} and higher. Null pointer check | |
| elimination is only done if @option{-fdelete-null-pointer-checks} is | |
| enabled. | |
| @opindex fsplit-paths | |
| @opindex fno-split-paths | |
| @item -fsplit-paths | |
| This option is deprecated and does nothing. It is accepted only for | |
| backward compatibility. | |
| @opindex fsplit-ivs-in-unroller | |
| @opindex fno-split-ivs-in-unroller | |
| @item -fsplit-ivs-in-unroller | |
| Enables expression of values of induction variables in later iterations | |
| of the unrolled loop using the value in the first iteration. This breaks | |
| long dependency chains, thus improving efficiency of the scheduling passes. | |
| A combination of @option{-fweb} and CSE is often sufficient to obtain the | |
| same effect. However, that is not reliable in cases where the loop body | |
| is more complicated than a single basic block. It also does not work at all | |
| on some architectures due to restrictions in the CSE pass. | |
| This optimization is enabled by default. | |
| @opindex fvariable-expansion-in-unroller | |
| @opindex fno-variable-expansion-in-unroller | |
| @item -fvariable-expansion-in-unroller | |
| With this option, the compiler creates multiple copies of some | |
| local variables when unrolling a loop, which can result in superior code. | |
| This optimization is enabled by default for PowerPC targets, but disabled | |
| by default otherwise. | |
| @opindex fpartial-inlining | |
| @opindex fno-partial-inlining | |
| @item -fpartial-inlining | |
| Inline parts of functions. This option has any effect only | |
| when inlining itself is turned on by the @option{-finline-functions} | |
| or @option{-finline-small-functions} options. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fpredictive-commoning | |
| @opindex fno-predictive-commoning | |
| @item -fpredictive-commoning | |
| Perform predictive commoning optimization, i.e., reusing computations | |
| (especially memory loads and stores) performed in previous | |
| iterations of loops. | |
| This option is enabled at level @option{-O3}. | |
| It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex fprefetch-loop-arrays | |
| @opindex fno-prefetch-loop-arrays | |
| @item -fprefetch-loop-arrays | |
| If supported by the target machine, generate instructions to prefetch | |
| memory to improve the performance of loops that access large arrays. | |
| This option may generate better or worse code; results are highly | |
| dependent on the structure of loops within the source code. | |
| Disabled at level @option{-Os}. | |
| @opindex fno-printf-return-value | |
| @opindex fprintf-return-value | |
| @item -fno-printf-return-value | |
| Do not substitute constants for known return value of formatted output | |
| functions such as @code{sprintf}, @code{snprintf}, @code{vsprintf}, and | |
| @code{vsnprintf} (but not @code{printf} of @code{fprintf}). This | |
| transformation allows GCC to optimize or even eliminate branches based | |
| on the known return value of these functions called with arguments that | |
| are either constant, or whose values are known to be in a range that | |
| makes determining the exact return value possible. For example, when | |
| @option{-fprintf-return-value} is in effect, both the branch and the | |
| body of the @code{if} statement (but not the call to @code{snprint}) | |
| can be optimized away when @code{i} is a 32-bit or smaller integer | |
| because the return value is guaranteed to be at most 8. | |
| @smallexample | |
| char buf[9]; | |
| if (snprintf (buf, "%08x", i) >= sizeof buf) | |
| @dots{} | |
| @end smallexample | |
| The @option{-fprintf-return-value} option relies on other optimizations | |
| and yields best results with @option{-O2} and above. It works in tandem | |
| with the @option{-Wformat-overflow} and @option{-Wformat-truncation} | |
| options. The @option{-fprintf-return-value} option is enabled by default. | |
| @opindex fno-peephole | |
| @opindex fpeephole | |
| @opindex fno-peephole2 | |
| @opindex fpeephole2 | |
| @item -fno-peephole | |
| @itemx -fno-peephole2 | |
| Disable any machine-specific peephole optimizations. The difference | |
| between @option{-fno-peephole} and @option{-fno-peephole2} is in how they | |
| are implemented in the compiler; some targets use one, some use the | |
| other, a few use both. | |
| @option{-fpeephole} is enabled by default. | |
| @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fno-guess-branch-probability | |
| @opindex fguess-branch-probability | |
| @item -fno-guess-branch-probability | |
| Do not guess branch probabilities using heuristics. | |
| GCC uses heuristics to guess branch probabilities if they are | |
| not provided by profiling feedback (@option{-fprofile-arcs}). These | |
| heuristics are based on the control flow graph. If some branch probabilities | |
| are specified by @code{__builtin_expect}, then the heuristics are | |
| used to guess branch probabilities for the rest of the control flow graph, | |
| taking the @code{__builtin_expect} info into account. The interactions | |
| between the heuristics and @code{__builtin_expect} can be complex, and in | |
| some cases, it may be useful to disable the heuristics so that the effects | |
| of @code{__builtin_expect} are easier to understand. | |
| It is also possible to specify expected probability of the expression | |
| with @code{__builtin_expect_with_probability} built-in function. | |
| The default is @option{-fguess-branch-probability} at levels | |
| @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex freorder-blocks | |
| @opindex fno-reorder-blocks | |
| @item -freorder-blocks | |
| Reorder basic blocks in the compiled function in order to reduce number of | |
| taken branches and improve code locality. | |
| Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex freorder-blocks-algorithm | |
| @opindex fno-reorder-blocks-algorithm | |
| @item -freorder-blocks-algorithm=@var{algorithm} | |
| Use the specified algorithm for basic block reordering. The | |
| @var{algorithm} argument can be @samp{simple}, which does not increase | |
| code size (except sometimes due to secondary effects like alignment), | |
| or @samp{stc}, the ``software trace cache'' algorithm, which tries to | |
| put all often executed code together, minimizing the number of branches | |
| executed by making extra copies of code. | |
| The default is @samp{simple} at levels @option{-O1}, @option{-Os}, and | |
| @samp{stc} at levels @option{-O2}, @option{-O3}. | |
| @opindex freorder-blocks-and-partition | |
| @opindex fno-reorder-blocks-and-partition | |
| @item -freorder-blocks-and-partition | |
| In addition to reordering basic blocks in the compiled function, in order | |
| to reduce number of taken branches, partitions hot and cold basic blocks | |
| into separate sections of the assembly and @file{.o} files, to improve | |
| paging and cache locality performance. | |
| This optimization is automatically turned off in the presence of | |
| exception handling or unwind tables (on targets using setjump/longjump or target specific scheme), for linkonce sections, for functions with a user-defined | |
| section attribute and on any architecture that does not support named | |
| sections. When @option{-fsplit-stack} is used this option is not | |
| enabled by default (to avoid linker errors), but may be enabled | |
| explicitly (if using a working linker). | |
| Enabled for x86 at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex freorder-functions | |
| @opindex fno-reorder-functions | |
| @item -freorder-functions | |
| Reorder functions in the object file in order to | |
| improve code locality. Unlike @option{-fipa-reorder-for-locality} this option | |
| prioritises grouping all functions within a category | |
| (hot/normal/cold/never-executed) together. | |
| This is implemented by using special subsections @code{.text.hot} for most | |
| frequently executed functions and @code{.text.unlikely} for unlikely executed | |
| functions. Reordering is done by the linker so object file format must support | |
| named sections and linker must place them in a reasonable way. | |
| This option isn't effective unless you either provide profile feedback | |
| (see @option{-fprofile-arcs} for details) or manually annotate functions with | |
| @code{hot} or @code{cold} attributes (@pxref{Common Attributes}). | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fstrict-aliasing | |
| @opindex fno-strict-aliasing | |
| @item -fstrict-aliasing | |
| Allow the compiler to assume the strictest aliasing rules applicable to | |
| the language being compiled. For C (and C++), this activates | |
| optimizations based on the type of expressions. In particular, accessing | |
| an object of one type via an expression of a different type is not allowed, | |
| unless the types are @dfn{compatible types}, differ only in signedness or | |
| qualifiers, or the expression has a character type. Accessing scalar | |
| objects via a corresponding vector type is also allowed. | |
| For example, an @code{unsigned int} can alias an @code{int}, but not a | |
| @code{void*} or a @code{double}. A character type may alias any other type. | |
| @anchor{Type-punning}Pay special attention to code like this: | |
| @smallexample | |
| union a_union @{ | |
| int i; | |
| double d; | |
| @}; | |
| int f() @{ | |
| union a_union t; | |
| t.d = 3.0; | |
| return t.i; | |
| @} | |
| @end smallexample | |
| The practice of reading from a different union member than the one most | |
| recently written to (called ``type-punning'') is common. Even with | |
| @option{-fstrict-aliasing}, type-punning is allowed in C, provided the memory | |
| is accessed through the union type. In ISO C++, type-punning through a union | |
| type is undefined behavior, but GCC supports it as an extension. So, the code | |
| above works as expected. @xref{Structures unions enumerations and | |
| bit-fields implementation}. However, this code might not: | |
| @smallexample | |
| int f() @{ | |
| union a_union t; | |
| int* ip; | |
| t.d = 3.0; | |
| ip = &t.i; | |
| return *ip; | |
| @} | |
| @end smallexample | |
| Similarly, access by taking the address, casting the resulting pointer | |
| and dereferencing the result has undefined behavior, even if the cast | |
| uses a union type, e.g.: | |
| @smallexample | |
| int f() @{ | |
| double d = 3.0; | |
| return ((union a_union *) &d)->i; | |
| @} | |
| @end smallexample | |
| The @option{-fstrict-aliasing} option is enabled at levels | |
| @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fipa-strict-aliasing | |
| @opindex fno-ipa-strict-aliasing | |
| @item -fipa-strict-aliasing | |
| Controls whether rules of @option{-fstrict-aliasing} are applied across | |
| function boundaries. Note that if multiple functions gets inlined into a | |
| single function the memory accesses are no longer considered to be crossing a | |
| function boundary. | |
| The @option{-fipa-strict-aliasing} option is enabled by default and is | |
| effective only in combination with @option{-fstrict-aliasing}. | |
| @opindex falign-functions | |
| @opindex fno-align-functions | |
| @item -falign-functions | |
| @itemx -falign-functions=@var{n} | |
| @itemx -falign-functions=@var{n}:@var{m} | |
| @itemx -falign-functions=@var{n}:@var{m}:@var{n2} | |
| @itemx -falign-functions=@var{n}:@var{m}:@var{n2}:@var{m2} | |
| Align the start of functions to the next power-of-two greater than or | |
| equal to @var{n}, skipping up to @var{m}-1 bytes. This ensures that at | |
| least the first @var{m} bytes of the function can be fetched by the CPU | |
| without crossing an @var{n}-byte alignment boundary. | |
| This is an optimization of code performance and alignment is ignored for | |
| functions considered cold. If alignment is required for all functions, | |
| use @option{-fmin-function-alignment}. | |
| If @var{m} is not specified, it defaults to @var{n}. | |
| Examples: @option{-falign-functions=32} aligns functions to the next | |
| 32-byte boundary, @option{-falign-functions=24} aligns to the next | |
| 32-byte boundary only if this can be done by skipping 23 bytes or less, | |
| @option{-falign-functions=32:7} aligns to the next | |
| 32-byte boundary only if this can be done by skipping 6 bytes or less. | |
| The second pair of @var{n2}:@var{m2} values allows you to specify | |
| a secondary alignment: @option{-falign-functions=64:7:32:3} aligns to | |
| the next 64-byte boundary if this can be done by skipping 6 bytes or less, | |
| otherwise aligns to the next 32-byte boundary if this can be done | |
| by skipping 2 bytes or less. | |
| If @var{m2} is not specified, it defaults to @var{n2}. | |
| Some assemblers only support this flag when @var{n} is a power of two; | |
| in that case, it is rounded up. | |
| @option{-fno-align-functions} and @option{-falign-functions=1} are | |
| equivalent and mean that functions are not aligned. | |
| If @var{n} is not specified or is zero, use a machine-dependent default. | |
| The maximum allowed @var{n} option value is 65536. | |
| Enabled at levels @option{-O2}, @option{-O3}. | |
| @opindex flimit-function-alignment | |
| @opindex fno-limit-function-alignment | |
| @item -flimit-function-alignment | |
| If this option is enabled, the compiler tries to avoid unnecessarily | |
| overaligning functions. It attempts to instruct the assembler to align | |
| by the amount specified by @option{-falign-functions}, but not to | |
| skip more bytes than the size of the function. | |
| @opindex falign-labels | |
| @opindex fno-align-labels | |
| @item -falign-labels | |
| @itemx -falign-labels=@var{n} | |
| @itemx -falign-labels=@var{n}:@var{m} | |
| @itemx -falign-labels=@var{n}:@var{m}:@var{n2} | |
| @itemx -falign-labels=@var{n}:@var{m}:@var{n2}:@var{m2} | |
| Align all branch targets to a power-of-two boundary. | |
| Parameters of this option are analogous to the @option{-falign-functions} option. | |
| @option{-fno-align-labels} and @option{-falign-labels=1} are | |
| equivalent and mean that labels are not aligned. | |
| If @option{-falign-loops} or @option{-falign-jumps} are applicable and | |
| are greater than this value, then their values are used instead. | |
| If @var{n} is not specified or is zero, use a machine-dependent default | |
| which is very likely to be @samp{1}, meaning no alignment. | |
| The maximum allowed @var{n} option value is 65536. | |
| Enabled at levels @option{-O2}, @option{-O3}. | |
| @opindex falign-loops | |
| @opindex fno-align-loops | |
| @item -falign-loops | |
| @itemx -falign-loops=@var{n} | |
| @itemx -falign-loops=@var{n}:@var{m} | |
| @itemx -falign-loops=@var{n}:@var{m}:@var{n2} | |
| @itemx -falign-loops=@var{n}:@var{m}:@var{n2}:@var{m2} | |
| Align loops to a power-of-two boundary. If the loops are executed | |
| many times, this makes up for any execution of the dummy padding | |
| instructions. | |
| This is an optimization of code performance and alignment is ignored for | |
| loops considered cold. | |
| If @option{-falign-labels} is greater than this value, then its value | |
| is used instead. | |
| Parameters of this option are analogous to the @option{-falign-functions} option. | |
| @option{-fno-align-loops} and @option{-falign-loops=1} are | |
| equivalent and mean that loops are not aligned. | |
| The maximum allowed @var{n} option value is 65536. | |
| If @var{n} is not specified or is zero, use a machine-dependent default. | |
| Enabled at levels @option{-O2}, @option{-O3}. | |
| @opindex falign-jumps | |
| @opindex fno-align-jumps | |
| @item -falign-jumps | |
| @itemx -falign-jumps=@var{n} | |
| @itemx -falign-jumps=@var{n}:@var{m} | |
| @itemx -falign-jumps=@var{n}:@var{m}:@var{n2} | |
| @itemx -falign-jumps=@var{n}:@var{m}:@var{n2}:@var{m2} | |
| Align branch targets to a power-of-two boundary, for branch targets | |
| where the targets can only be reached by jumping. In this case, | |
| no dummy operations need be executed. | |
| This is an optimization of code performance and alignment is ignored for | |
| jumps considered cold. | |
| If @option{-falign-labels} is greater than this value, then its value | |
| is used instead. | |
| Parameters of this option are analogous to the @option{-falign-functions} option. | |
| @option{-fno-align-jumps} and @option{-falign-jumps=1} are | |
| equivalent and mean that loops are not aligned. | |
| If @var{n} is not specified or is zero, use a machine-dependent default. | |
| The maximum allowed @var{n} option value is 65536. | |
| Enabled at levels @option{-O2}, @option{-O3}. | |
| @opindex fmin-function-alignment=@var{n} | |
| @item -fmin-function-alignment | |
| Specify minimal alignment of functions to the next power-of-two greater than or | |
| equal to @var{n}. Unlike @option{-falign-functions} this alignment is applied | |
| also to all functions (even those considered cold). The alignment is also not | |
| affected by @option{-flimit-function-alignment} | |
| @opindex fno-allocation-dce | |
| @opindex fallocation-dce | |
| @item -fno-allocation-dce | |
| Do not remove unused C++ allocations (using operator @code{new} and operator @code{delete}) | |
| in dead code elimination. | |
| See also @option{-fmalloc-dce}. | |
| @opindex fallow-store-data-races | |
| @opindex fno-allow-store-data-races | |
| @item -fallow-store-data-races | |
| Allow the compiler to perform optimizations that may introduce new data races | |
| on stores, without proving that the variable cannot be concurrently accessed | |
| by other threads. Does not affect optimization of local data. It is safe to | |
| use this option if it is known that global data will not be accessed by | |
| multiple threads. | |
| Examples of optimizations enabled by @option{-fallow-store-data-races} include | |
| hoisting or if-conversions that may cause a value that was already in memory | |
| to be re-written with that same value. Such re-writing is safe in a single | |
| threaded context but may be unsafe in a multi-threaded context. Note that on | |
| some processors, if-conversions may be required in order to enable | |
| vectorization. | |
| Enabled at level @option{-Ofast}. | |
| @opindex funit-at-a-time | |
| @opindex fno-unit-at-a-time | |
| @item -funit-at-a-time | |
| This option is left for compatibility reasons. @option{-funit-at-a-time} | |
| has no effect, while @option{-fno-unit-at-a-time} implies | |
| @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}. | |
| Enabled by default. | |
| @opindex fno-toplevel-reorder | |
| @opindex ftoplevel-reorder | |
| @item -fno-toplevel-reorder | |
| Do not reorder top-level functions, variables, and @code{asm} | |
| statements. Output them in the same order that they appear in the | |
| input file. When this option is used, unreferenced static variables | |
| are not removed. This option is intended to support existing code | |
| that relies on a particular ordering. For new code, it is better to | |
| use attributes when possible. | |
| @option{-ftoplevel-reorder} is the default at @option{-O1} and higher, and | |
| also at @option{-O0} if @option{-fsection-anchors} is explicitly requested. | |
| Additionally @option{-fno-toplevel-reorder} implies | |
| @option{-fno-section-anchors}. | |
| @opindex funreachable-traps | |
| @opindex fno-unreachable-traps | |
| @item -funreachable-traps | |
| With this option, the compiler turns calls to | |
| @code{__builtin_unreachable} into traps, instead of using them for | |
| optimization. This also affects any such calls implicitly generated | |
| by the compiler. | |
| This option has the same effect as @option{-fsanitize=unreachable | |
| -fsanitize-trap=unreachable}, but does not affect the values of those | |
| options. If @option{-fsanitize=unreachable} is enabled, that option | |
| takes priority over this one. | |
| This option is enabled by default at @option{-O0} and @option{-Og}. | |
| @opindex fweb | |
| @opindex fno-web | |
| @item -fweb | |
| Constructs webs as commonly used for register allocation purposes and assign | |
| each web individual pseudo register. This allows the register allocation pass | |
| to operate on pseudos directly, but also strengthens several other optimization | |
| passes, such as CSE, loop optimizer and trivial dead code remover. It can, | |
| however, make debugging impossible, since variables no longer stay in a | |
| ``home register''. | |
| Enabled by default with @option{-funroll-loops}. | |
| @opindex fwhole-program | |
| @opindex fno-whole-program | |
| @item -fwhole-program | |
| Assume that the current compilation unit represents the whole program being | |
| compiled. All public functions and variables with the exception of @code{main} | |
| and those merged by attribute @code{externally_visible} become static functions | |
| and in effect are optimized more aggressively by interprocedural optimizers. | |
| With @option{-flto} this option has a limited use. In most cases the | |
| precise list of symbols used or exported from the binary is known the | |
| resolution info passed to the link-time optimizer by the linker plugin. It is | |
| still useful if no linker plugin is used or during incremental link step when | |
| final code is produced (with @option{-flto} | |
| @option{-flinker-output=nolto-rel}). | |
| @opindex flto | |
| @opindex fno-lto | |
| @item -flto[=@var{n}] | |
| This option runs the standard link-time optimizer. When invoked | |
| with source code, it generates GIMPLE (one of GCC's internal | |
| representations) and writes it to special ELF sections in the object | |
| file. When the object files are linked together, all the function | |
| bodies are read from these ELF sections and instantiated as if they | |
| had been part of the same translation unit. | |
| To use the link-time optimizer, @option{-flto} and optimization | |
| options should be specified at compile time and during the final link. | |
| It is recommended that you compile all the files participating in the | |
| same link with the same options and also specify those options at | |
| link time. | |
| For example: | |
| @smallexample | |
| gcc -c -O2 -flto foo.c | |
| gcc -c -O2 -flto bar.c | |
| gcc -o myprog -flto -O2 foo.o bar.o | |
| @end smallexample | |
| The first two invocations to GCC save a bytecode representation | |
| of GIMPLE into special ELF sections inside @file{foo.o} and | |
| @file{bar.o}. The final invocation reads the GIMPLE bytecode from | |
| @file{foo.o} and @file{bar.o}, merges the two files into a single | |
| internal image, and compiles the result as usual. Since both | |
| @file{foo.o} and @file{bar.o} are merged into a single image, this | |
| causes all the interprocedural analyses and optimizations in GCC to | |
| work across the two files as if they were a single one. This means, | |
| for example, that the inliner is able to inline functions in | |
| @file{bar.o} into functions in @file{foo.o} and vice-versa. | |
| Another (simpler) way to enable link-time optimization is: | |
| @smallexample | |
| gcc -o myprog -flto -O2 foo.c bar.c | |
| @end smallexample | |
| The above generates bytecode for @file{foo.c} and @file{bar.c}, | |
| merges them together into a single GIMPLE representation and optimizes | |
| them as usual to produce @file{myprog}. | |
| The important thing to keep in mind is that to enable link-time | |
| optimizations you need to use the GCC driver to perform the link step. | |
| GCC automatically performs link-time optimization if any of the | |
| objects involved were compiled with the @option{-flto} command-line option. | |
| You can always override | |
| the automatic decision to do link-time optimization | |
| by passing @option{-fno-lto} to the link command. | |
| To make whole-program optimization effective, it is necessary to make | |
| certain assumptions. The compiler needs to know | |
| what functions and variables can be accessed by libraries and runtime | |
| outside of the link-time optimized unit. When supported by the linker, | |
| the linker plugin (see @option{-fuse-linker-plugin}) passes information | |
| to the compiler about used and externally visible symbols. When | |
| the linker plugin is not available, @option{-fwhole-program} should be | |
| used to allow the compiler to make these assumptions, which leads | |
| to more aggressive optimization decisions. | |
| When a file is compiled with @option{-flto} without | |
| @option{-fuse-linker-plugin}, the generated object file is larger than | |
| a regular object file because it contains GIMPLE bytecodes and the usual | |
| final code (see @option{-ffat-lto-objects}). This means that | |
| object files with LTO information can be linked as normal object | |
| files; if @option{-fno-lto} is passed to the linker, no | |
| interprocedural optimizations are applied. Note that when | |
| @option{-fno-fat-lto-objects} is enabled the compile stage is faster | |
| but you cannot perform a regular, non-LTO link on them. | |
| When producing the final binary, GCC only | |
| applies link-time optimizations to those files that contain bytecode. | |
| Therefore, you can mix and match object files and libraries with | |
| GIMPLE bytecodes and final object code. GCC automatically selects | |
| which files to optimize in LTO mode and which files to link without | |
| further processing. | |
| Generally, options specified at link time override those | |
| specified at compile time, although in some cases GCC attempts to infer | |
| link-time options from the settings used to compile the input files. | |
| If you do not specify an optimization level option @option{-O} at | |
| link time, then GCC uses the highest optimization level | |
| used when compiling the object files. Note that it is generally | |
| ineffective to specify an optimization level option only at link time and | |
| not at compile time, for two reasons. First, compiling without | |
| optimization suppresses compiler passes that gather information | |
| needed for effective optimization at link time. Second, some early | |
| optimization passes can be performed only at compile time and | |
| not at link time. | |
| There are some code generation flags preserved by GCC when | |
| generating bytecodes, as they need to be used during the final link. | |
| Currently, the following options and their settings are taken from | |
| the first object file that explicitly specifies them: | |
| @option{-fcommon}, @option{-fexceptions}, @option{-fnon-call-exceptions}, | |
| @option{-fgnu-tm} and all the @option{-m} target flags. | |
| The following options @option{-fPIC}, @option{-fpic}, @option{-fpie} and | |
| @option{-fPIE} are combined based on the following scheme: | |
| @smallexample | |
| @option{-fPIC} + @option{-fpic} = @option{-fpic} | |
| @option{-fPIC} + @option{-fno-pic} = @option{-fno-pic} | |
| @option{-fpic/-fPIC} + (no option) = (no option) | |
| @option{-fPIC} + @option{-fPIE} = @option{-fPIE} | |
| @option{-fpic} + @option{-fPIE} = @option{-fpie} | |
| @option{-fPIC/-fpic} + @option{-fpie} = @option{-fpie} | |
| @end smallexample | |
| Certain ABI-changing flags are required to match in all compilation units, | |
| and trying to override this at link time with a conflicting value | |
| is ignored. This includes options such as @option{-freg-struct-return} | |
| and @option{-fpcc-struct-return}. | |
| Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow}, | |
| @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing} | |
| are passed through to the link stage and merged conservatively for | |
| conflicting translation units. Specifically | |
| @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take | |
| precedence; and for example @option{-ffp-contract=off} takes precedence | |
| over @option{-ffp-contract=fast}. You can override them at link time. | |
| Diagnostic options such as @option{-Wstringop-overflow} are passed | |
| through to the link stage and their setting matches that of the | |
| compile-step at function granularity. Note that this matters only | |
| for diagnostics emitted during optimization. Note that code | |
| transforms such as inlining can lead to warnings being enabled | |
| or disabled for regions if code not consistent with the setting | |
| at compile time. | |
| When you need to pass options to the assembler via @option{-Wa} or | |
| @option{-Xassembler} make sure to either compile such translation | |
| units with @option{-fno-lto} or consistently use the same assembler | |
| options on all translation units. You can alternatively also | |
| specify assembler options at LTO link time. | |
| To enable debug info generation you need to supply @option{-g} at | |
| compile time. If any of the input files at link time were built | |
| with debug info generation enabled the link will enable debug info | |
| generation as well. Any elaborate debug info settings | |
| like the dwarf level @option{-gdwarf-5} need to be explicitly repeated | |
| at the linker command line and mixing different settings in different | |
| translation units is discouraged. | |
| If LTO encounters objects with C linkage declared with incompatible | |
| types in separate translation units to be linked together (undefined | |
| behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be | |
| issued. The behavior is still undefined at run time. Similar | |
| diagnostics may be raised for other languages. | |
| Another feature of LTO is that it is possible to apply interprocedural | |
| optimizations on files written in different languages: | |
| @smallexample | |
| gcc -c -flto foo.c | |
| g++ -c -flto bar.cc | |
| gfortran -c -flto baz.f90 | |
| g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran | |
| @end smallexample | |
| Notice that the final link is done with @command{g++} to get the C++ | |
| runtime libraries and @option{-lgfortran} is added to get the Fortran | |
| runtime libraries. In general, when mixing languages in LTO mode, you | |
| should use the same link command options as when mixing languages in a | |
| regular (non-LTO) compilation. | |
| If object files containing GIMPLE bytecode are stored in a library archive, say | |
| @file{libfoo.a}, it is possible to extract and use them in an LTO link if you | |
| are using a linker with plugin support. To create static libraries suitable | |
| for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar} | |
| and @command{ranlib}; | |
| to show the symbols of object files with GIMPLE bytecode, use | |
| @command{gcc-nm}. Those commands require that @command{ar}, @command{ranlib} | |
| and @command{nm} have been compiled with plugin support. At link time, use the | |
| flag @option{-fuse-linker-plugin} to ensure that the library participates in | |
| the LTO optimization process: | |
| @smallexample | |
| gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo | |
| @end smallexample | |
| With the linker plugin enabled, the linker extracts the needed | |
| GIMPLE files from @file{libfoo.a} and passes them on to the running GCC | |
| to make them part of the aggregated GIMPLE image to be optimized. | |
| If you are not using a linker with plugin support and/or do not | |
| enable the linker plugin, then the objects inside @file{libfoo.a} | |
| are extracted and linked as usual, but they do not participate | |
| in the LTO optimization process. In order to make a static library suitable | |
| for both LTO optimization and usual linkage, compile its object files with | |
| @option{-flto} @option{-ffat-lto-objects}. | |
| Link-time optimizations do not require the presence of the whole program to | |
| operate. If the program does not require any symbols to be exported, it is | |
| possible to combine @option{-flto} and @option{-fwhole-program} to allow | |
| the interprocedural optimizers to use more aggressive assumptions which may | |
| lead to improved optimization opportunities. | |
| Use of @option{-fwhole-program} is not needed when linker plugin is | |
| active (see @option{-fuse-linker-plugin}). | |
| The current implementation of LTO makes no | |
| attempt to generate bytecode that is portable between different | |
| types of hosts. The bytecode files are versioned and there is a | |
| strict version check, so bytecode files generated in one version of | |
| GCC do not work with an older or newer version of GCC. | |
| Link-time optimization does not work well with generation of debugging | |
| information on systems other than those using a combination of ELF and | |
| DWARF. | |
| If you specify the optional @var{n}, the optimization and code | |
| generation done at link time is executed in parallel using @var{n} | |
| parallel jobs by utilizing an installed @command{make} program. The | |
| environment variable @env{MAKE} may be used to override the program | |
| used. | |
| You can also specify @option{-flto=jobserver} to use GNU make's | |
| job server mode to determine the number of parallel jobs. This | |
| is useful when the Makefile calling GCC is already executing in parallel. | |
| You must prepend a @samp{+} to the command recipe in the parent Makefile | |
| for this to work. This option likely only works if @env{MAKE} is | |
| GNU make. Even without the option value, GCC tries to automatically | |
| detect a running GNU make's job server. | |
| Use @option{-flto=auto} to use GNU make's job server, if available, | |
| or otherwise fall back to autodetection of the number of CPU threads | |
| present in your system. | |
| @opindex flto-partition | |
| @opindex fno-lto-partition | |
| @item -flto-partition=@var{alg} | |
| Specify the partitioning algorithm used by the link-time optimizer. | |
| The value is either @samp{1to1} to specify a partitioning mirroring | |
| the original source files or @samp{balanced} to specify partitioning | |
| into equally sized chunks (whenever possible) or @samp{max} to create | |
| new partition for every symbol where possible or @samp{cache} to | |
| balance chunk sizes while keeping related symbols together for better | |
| caching in incremental LTO. Specifying @samp{none} as an algorithm | |
| disables partitioning and streaming completely. | |
| The default value is @samp{balanced}. While @samp{1to1} can be used | |
| as an workaround for various code ordering issues, the @samp{max} | |
| partitioning is intended for internal testing only. | |
| The value @samp{one} specifies that exactly one partition should be | |
| used while the value @samp{none} bypasses partitioning and executes | |
| the link-time optimization step directly from the WPA phase. | |
| @opindex flto-incremental | |
| @opindex fno-lto-incremental | |
| @item -flto-incremental=@var{path} | |
| Enable incremental LTO, with its cache in given existing directory. | |
| Can significantly shorten edit-compile cycles with LTO. | |
| When used with LTO (@option{-flto}), the output of translation units | |
| inside LTO is cached. Cached translation units are likely to be | |
| encountered again when recompiling with small code changes, leading to | |
| recompile time reduction. | |
| Multiple GCC instances can use the same cache in parallel. | |
| @opindex flto-incremental-cache-size | |
| @opindex fno-lto-incremental-cache-size | |
| @item -flto-incremental-cache-size=@var{n} | |
| Specifies number of cache entries in incremental LTO after which to prune | |
| old entries. This is a soft limit, temporarily there may be more entries. | |
| @opindex flto-compression-level | |
| @item -flto-compression-level=@var{n} | |
| This option specifies the level of compression used for intermediate | |
| language written to LTO object files, and is only meaningful in | |
| conjunction with LTO mode (@option{-flto}). GCC currently supports two | |
| LTO compression algorithms. For zstd, valid values are 0 (no compression) | |
| to 19 (maximum compression), while zlib supports values from 0 to 9. | |
| Values outside this range are clamped to either minimum or maximum | |
| of the supported values. If the option is not given, | |
| a default balanced compression setting is used. | |
| @opindex flto-toplevel-asm-heuristics | |
| @item -flto-toplevel-asm-heuristics | |
| Enables heuristics to find symbols used in top-level basic @code{asm}. | |
| This will restrict link-time optimizations that could cause renaming | |
| or deletion of such symbols which would result in missing symbol errors by | |
| linker. | |
| This flag is intended for projects that have not converted to using top-level | |
| extended @code{asm} (@pxref{Extended Asm}), which specify the usage directly | |
| without any false positives. | |
| The heuristics are simple and do not parse the assembly. | |
| The heuristics scan through top-level assembly for all possible identifiers; | |
| if an identifier is found among declared symbols, the symbol will be marked to | |
| restrict link-time optimizations. Static symbols disable more optimizations. | |
| Identifiers followed by ':' disable more optimizations as well, because they | |
| might be a locally defined symbol in assembly, even when the declaration | |
| is marked 'extern'. | |
| @opindex fuse-linker-plugin | |
| @item -fuse-linker-plugin | |
| Enables the use of a linker plugin during link-time optimization. This | |
| option relies on plugin support in the linker, which is available in gold | |
| or in GNU ld 2.21 or newer. | |
| This option enables the extraction of object files with GIMPLE bytecode out | |
| of library archives. This improves the quality of optimization by exposing | |
| more code to the link-time optimizer. This information specifies what | |
| symbols can be accessed externally (by non-LTO object or during dynamic | |
| linking). Resulting code quality improvements on binaries (and shared | |
| libraries that use hidden visibility) are similar to @option{-fwhole-program}. | |
| See @option{-flto} for a description of the effect of this flag and how to | |
| use it. | |
| This option is enabled by default when LTO support in GCC is enabled | |
| and GCC was configured for use with | |
| a linker supporting plugins (GNU ld 2.21 or newer or gold). | |
| @opindex ffat-lto-objects | |
| @opindex fno-fat-lto-objects | |
| @item -ffat-lto-objects | |
| Fat LTO objects are object files that contain both the intermediate language | |
| and the object code. This makes them usable for both LTO linking and normal | |
| linking. This option is effective only when compiling with @option{-flto} | |
| and is ignored at link time. | |
| @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but | |
| requires the complete toolchain to be aware of LTO. It requires a linker with | |
| linker plugin support for basic functionality. Additionally, | |
| @command{nm}, @command{ar} and @command{ranlib} | |
| need to support linker plugins to allow a full-featured build environment | |
| (capable of building static libraries etc). GCC provides the @command{gcc-ar}, | |
| @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options | |
| to these tools. With non fat LTO makefiles need to be modified to use them. | |
| Note that modern binutils provide plugin auto-load mechanism. | |
| Installing the linker plugin into @file{$libdir/bfd-plugins} has the same | |
| effect as usage of the command wrappers (@command{gcc-ar}, @command{gcc-nm} and | |
| @command{gcc-ranlib}). | |
| The default is @option{-fno-fat-lto-objects} on targets with linker plugin | |
| support. | |
| @opindex fcompare-elim | |
| @opindex fno-compare-elim | |
| @item -fcompare-elim | |
| After register allocation and post-register allocation instruction splitting, | |
| identify arithmetic instructions that compute processor flags similar to a | |
| comparison operation based on that arithmetic. If possible, eliminate the | |
| explicit comparison operation. | |
| This pass only applies to certain targets that cannot explicitly represent | |
| the comparison operation before register allocation is complete. | |
| Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex ffold-mem-offsets | |
| @opindex fno-fold-mem-offsets | |
| @item -ffold-mem-offsets | |
| @itemx -fno-fold-mem-offsets | |
| Try to eliminate add instructions by folding them in memory loads/stores. | |
| Enabled at levels @option{-O2}, @option{-O3}. | |
| @opindex fcprop-registers | |
| @opindex fno-cprop-registers | |
| @item -fcprop-registers | |
| After register allocation and post-register allocation instruction splitting, | |
| perform a copy-propagation pass to try to reduce scheduling dependencies | |
| and occasionally eliminate the copy. | |
| Enabled at levels @option{-O1}, @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fprofile-correction | |
| @opindex fno-profile-correction | |
| @item -fprofile-correction | |
| Profiles collected using an instrumented binary for multi-threaded programs may | |
| be inconsistent due to missed counter updates. When this option is specified, | |
| GCC uses heuristics to correct or smooth out such inconsistencies. By | |
| default, GCC emits an error message when an inconsistent profile is detected. | |
| This option is enabled by @option{-fauto-profile}. | |
| @opindex fprofile-partial-training | |
| @opindex fno-profile-partial-training | |
| @item -fprofile-partial-training | |
| With @code{-fprofile-use} all portions of programs not executed during | |
| training runs are optimized aggressively for size rather than speed. | |
| In some cases it is not practical to train all possible hot paths in | |
| the program. (For example, it may contain functions specific to a | |
| given hardware and training may not cover all hardware configurations | |
| the program later runs on.) With @code{-fprofile-partial-training} | |
| profile feedback is ignored for all functions not executed during the | |
| training runs, causing them to be optimized as if they were compiled | |
| without profile feedback. This leads to better performance when the | |
| training is not representative at the cost of significantly bigger code. | |
| @opindex fprofile-use | |
| @opindex fno-profile-use | |
| @item -fprofile-use | |
| @itemx -fprofile-use=@var{path} | |
| Enable profile feedback-directed optimizations, | |
| and the following optimizations, many of which | |
| are generally profitable only with profile feedback available: | |
| @gccoptlist{-fbranch-probabilities -fprofile-values | |
| -funroll-loops -fpeel-loops -ftracer -fvpt | |
| -finline-functions -fipa-cp -fipa-cp-clone -fipa-bit-cp | |
| -fpredictive-commoning -fsplit-loops -funswitch-loops | |
| -fgcse-after-reload -ftree-loop-vectorize -ftree-slp-vectorize | |
| -fvect-cost-model=dynamic -ftree-loop-distribute-patterns | |
| -fprofile-reorder-functions} | |
| Before you can use this option, you must first generate profiling information. | |
| @xref{Instrumentation Options}, for information about the | |
| @option{-fprofile-generate} option. | |
| By default, GCC emits an error message if the feedback profiles do not | |
| match the source code. This error can be turned into a warning by using | |
| @option{-Wno-error=coverage-mismatch}. Note this may result in poorly | |
| optimized code. Additionally, by default, GCC also emits a warning message if | |
| the feedback profiles do not exist (see @option{-Wmissing-profile}). | |
| If @var{path} is specified, GCC looks at the @var{path} to find | |
| the profile feedback data files. See @option{-fprofile-dir}. | |
| @opindex fauto-profile | |
| @opindex fno-auto-profile | |
| @item -fauto-profile | |
| @itemx -fauto-profile=@var{path} | |
| Enable sampling-based feedback-directed optimizations, | |
| and the following optimizations, | |
| many of which are generally profitable only with profile feedback available: | |
| @gccoptlist{-fbranch-probabilities -fprofile-values | |
| -funroll-loops -fpeel-loops -ftracer -fvpt | |
| -finline-functions -fipa-cp -fipa-cp-clone -fipa-bit-cp | |
| -fpredictive-commoning -fsplit-loops -funswitch-loops | |
| -fgcse-after-reload -ftree-loop-vectorize -ftree-slp-vectorize | |
| -fvect-cost-model=dynamic -ftree-loop-distribute-patterns | |
| -fprofile-correction} | |
| @var{path} is the name of a file containing AutoFDO profile information. | |
| If omitted, it defaults to @file{fbdata.afdo} in the current directory. | |
| Producing an AutoFDO profile data file requires running your program | |
| with the @command{perf} utility on a supported GNU/Linux target system. | |
| For more information, see @uref{https://perfwiki.github.io/main/}. | |
| E.g. | |
| @smallexample | |
| perf record -e br_inst_retired:near_taken -b -o perf.data \ | |
| -- your_program | |
| @end smallexample | |
| Then use the @command{create_gcov} tool to convert the raw profile data | |
| to a format that can be used by GCC.@ You must also supply the | |
| unstripped binary for your program to this tool. | |
| See @uref{https://github.com/google/autofdo}. | |
| E.g. | |
| @smallexample | |
| create_gcov --binary=your_program.unstripped --profile=perf.data \ | |
| --gcov=profile.afdo | |
| @end smallexample | |
| @opindex fauto-profile-inlining | |
| @opindex fno-auto-profile-inlining | |
| @item -fauto-profile-inlining | |
| When auto-profile is available inline all relevant functions which was | |
| inlined in the tran run before reading the profile feedback. This improves | |
| context sensitivity of the profile. Enabled by default. | |
| @end table | |
| The following options control compiler behavior regarding floating-point | |
| arithmetic. These options trade off between speed and | |
| correctness. All must be specifically enabled. | |
| @table @gcctabopt | |
| @opindex fexcess-precision | |
| @item -fexcess-precision=@var{style} | |
| This option allows control over excess precision on machines | |
| where floating-point operations occur in a format with more precision or | |
| range than the IEEE standard and interchange floating-point types. | |
| An example of such a target is x87 floating point on x86 processors, | |
| which uses an 80-bit representation internally instead of the 64-bit | |
| IEEE format. For most programs, the excess precision is harmless, | |
| but some programs may rely on the | |
| requirements of the C or C++ language standards for handling IEEE values. | |
| By default, @option{-fexcess-precision=fast} is in effect; this means that | |
| operations may be carried out in a wider precision than the types specified | |
| in the source if that would result in faster code, and it is unpredictable | |
| when rounding to the types specified in the source code takes place. | |
| When compiling C or C++, if @option{-fexcess-precision=standard} is specified | |
| then excess precision follows the rules specified in ISO C99 or C++; | |
| in particular, | |
| both casts and assignments cause values to be rounded to their | |
| semantic types (whereas @option{-ffloat-store} only affects | |
| assignments). This option is enabled by default for C or C++ if a strict | |
| conformance option such as @option{-std=c99} or @option{-std=c++17} is used. | |
| @option{-ffast-math} enables @option{-fexcess-precision=fast} by default | |
| regardless of whether a strict conformance option is used. | |
| If @option{-fexcess-precision=16} is specified, constants and the | |
| results of expressions with types @code{_Float16} and @code{__bf16} | |
| are computed without excess precision. | |
| @opindex mfpmath | |
| @option{-fexcess-precision=standard} is not implemented for languages | |
| other than C or C++. On the x86, it has no effect if @option{-mfpmath=sse} | |
| or @option{-mfpmath=sse+387} is specified; in the former case, IEEE | |
| semantics apply without excess precision, and in the latter, rounding | |
| is unpredictable. | |
| @opindex ffloat-store | |
| @opindex fno-float-store | |
| @item -ffloat-store | |
| Do not store floating-point variables in registers, and inhibit other | |
| options that might change whether a floating-point value is taken from a | |
| register or memory. This option has generally been subsumed by | |
| @option{-fexcess-precision=standard}, which is more general. If you do use | |
| @option{-ffloat-store}, you may need to modify your program to explicitly | |
| store intermediate computations in temporary variables since | |
| @option{-ffloat-store} handles rounding to IEEE format | |
| only on assignments and not casts as @option{-fexcess-precision=standard} | |
| does. | |
| @opindex ffast-math | |
| @opindex fno-fast-math | |
| @item -ffast-math | |
| Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, | |
| @option{-ffinite-math-only}, @option{-fno-rounding-math}, | |
| @option{-fno-signaling-nans}, @option{-fcx-limited-range} and | |
| @option{-fexcess-precision=fast}. | |
| This option causes the preprocessor macro @code{__FAST_MATH__} to be defined. | |
| This option is not turned on by any @option{-O} option besides | |
| @option{-Ofast} since it can result in incorrect output for programs | |
| that depend on an exact implementation of IEEE or ISO rules/specifications | |
| for math functions. It may, however, yield faster code for programs | |
| that do not require the guarantees of these specifications. | |
| @opindex fno-math-errno | |
| @opindex fmath-errno | |
| @item -fno-math-errno | |
| Do not set @code{errno} after calling math functions that are executed | |
| with a single instruction, e.g., @code{sqrt}. A program that relies on | |
| IEEE exceptions for math error handling may want to use this flag | |
| for speed while maintaining IEEE arithmetic compatibility. | |
| This option is not turned on by any @option{-O} option besides | |
| @option{-Ofast} since it can result in incorrect output for | |
| programs that depend on an exact implementation of IEEE or | |
| ISO rules/specifications for math functions. It may, however, | |
| yield faster code for programs that do not require the guarantees | |
| of these specifications. | |
| The default is @option{-fmath-errno}. | |
| On Darwin systems, the math library never sets @code{errno}. There is | |
| therefore no reason for the compiler to consider the possibility that | |
| it might, and @option{-fno-math-errno} is the default. | |
| @opindex funsafe-math-optimizations | |
| @opindex fno-unsafe-math-optimizations | |
| @item -funsafe-math-optimizations | |
| Allow optimizations for floating-point arithmetic that (a) assume | |
| that arguments and results are valid and (b) may violate IEEE or | |
| ANSI standards. When used at link time, it may include libraries | |
| or startup files that change the default FPU control word or other | |
| similar optimizations. | |
| This option is not turned on by any @option{-O} option besides | |
| @option{-Ofast} since it can result in incorrect output | |
| for programs that depend on an exact implementation of IEEE | |
| or ISO rules/specifications for math functions. It may, however, | |
| yield faster code for programs that do not require the guarantees | |
| of these specifications. | |
| Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math}, | |
| @option{-fassociative-math} and @option{-freciprocal-math}. | |
| The default is @option{-fno-unsafe-math-optimizations}. | |
| @opindex fassociative-math | |
| @opindex fno-associative-math | |
| @item -fassociative-math | |
| Allow re-association of operands in series of floating-point operations. | |
| This violates the ISO C and C++ language standard by possibly changing | |
| computation result. NOTE: re-ordering may change the sign of zero as | |
| well as ignore NaNs and inhibit or create underflow or overflow (and | |
| thus cannot be used on code that relies on rounding behavior like | |
| @code{(x + 2**52) - 2**52}. May also reorder floating-point comparisons | |
| and thus may not be used when ordered comparisons are required. | |
| This option requires that both @option{-fno-signed-zeros} and | |
| @option{-fno-trapping-math} be in effect. Moreover, it doesn't make | |
| much sense with @option{-frounding-math}. For Fortran the option | |
| is automatically enabled when both @option{-fno-signed-zeros} and | |
| @option{-fno-trapping-math} are in effect. | |
| The default is @option{-fno-associative-math}. | |
| @opindex freciprocal-math | |
| @opindex fno-reciprocal-math | |
| @item -freciprocal-math | |
| Allow the reciprocal of a value to be used instead of dividing by | |
| the value if this enables optimizations. For example @code{x / y} | |
| can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)} | |
| is subject to common subexpression elimination. Note that this loses | |
| precision and increases the number of flops operating on the value. | |
| The default is @option{-fno-reciprocal-math}. | |
| @opindex ffinite-math-only | |
| @opindex fno-finite-math-only | |
| @item -ffinite-math-only | |
| Allow optimizations for floating-point arithmetic that assume | |
| that arguments and results are not NaNs or +-Infs. | |
| This option is not turned on by any @option{-O} option besides | |
| @option{-Ofast} since it can result in incorrect output | |
| for programs that depend on an exact implementation of IEEE or | |
| ISO rules/specifications for math functions. It may, however, | |
| yield faster code for programs that do not require the guarantees | |
| of these specifications. | |
| The default is @option{-fno-finite-math-only}. | |
| @opindex fno-signed-zeros | |
| @opindex fsigned-zeros | |
| @item -fno-signed-zeros | |
| Allow optimizations for floating-point arithmetic that ignore the | |
| signedness of zero. IEEE arithmetic specifies the behavior of | |
| distinct +0.0 and @minus{}0.0 values, which then prohibits simplification | |
| of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}). | |
| This option implies that the sign of a zero result isn't significant. | |
| The default is @option{-fsigned-zeros}. | |
| @opindex fno-trapping-math | |
| @opindex ftrapping-math | |
| @item -fno-trapping-math | |
| Compile code assuming that floating-point operations cannot generate | |
| user-visible traps. These traps include division by zero, overflow, | |
| underflow, inexact result and invalid operation. This option requires | |
| that @option{-fno-signaling-nans} be in effect. Setting this option may | |
| allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example. | |
| This option is not turned on by any @option{-O} option besides | |
| @option{-Ofast} since it can result in incorrect output for programs | |
| that depend on an exact implementation of IEEE or ISO rules/specifications | |
| for math functions. | |
| The default is @option{-ftrapping-math}. | |
| Future versions of GCC may provide finer control of this setting | |
| using C99's @code{FENV_ACCESS} pragma. This command-line option | |
| will be used along with @option{-frounding-math} to specify the | |
| default state for @code{FENV_ACCESS}. | |
| @opindex frounding-math | |
| @opindex fno-rounding-math | |
| @item -frounding-math | |
| Disable transformations and optimizations that assume default floating-point | |
| rounding behavior (round-to-nearest). | |
| This option should be specified for programs that change | |
| the FP rounding mode dynamically, or that may be executed with a | |
| non-default rounding mode. This option disables constant folding of | |
| floating-point expressions at compile time (which may be affected by | |
| rounding mode) and arithmetic transformations that are unsafe in the | |
| presence of sign-dependent rounding modes. | |
| The default is @option{-fno-rounding-math}. | |
| This option is experimental and does not currently guarantee to | |
| disable all GCC optimizations that are affected by rounding mode. | |
| Future versions of GCC may provide finer control of this setting | |
| using C99's @code{FENV_ACCESS} pragma. This command-line option | |
| will be used along with @option{-ftrapping-math} to specify the | |
| default state for @code{FENV_ACCESS}. | |
| @opindex fsignaling-nans | |
| @opindex fno-signaling-nans | |
| @item -fsignaling-nans | |
| Compile code assuming that IEEE signaling NaNs may generate user-visible | |
| traps during floating-point operations. Setting this option disables | |
| optimizations that may change the number of exceptions visible with | |
| signaling NaNs. This option implies @option{-ftrapping-math}. | |
| This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to | |
| be defined. | |
| The default is @option{-fno-signaling-nans}. | |
| This option is experimental and does not currently guarantee to | |
| disable all GCC optimizations that affect signaling NaN behavior. | |
| @opindex fsingle-precision-constant | |
| @opindex fno-single-precision-constant | |
| @item -fsingle-precision-constant | |
| Treat floating-point constants as single precision instead of | |
| implicitly converting them to double-precision constants. | |
| @opindex fcx-limited-range | |
| @opindex fno-cx-limited-range | |
| @item -fcx-limited-range | |
| When enabled, this option states that a range reduction step is not | |
| needed when performing complex division. Also, there is no checking | |
| whether the result of a complex multiplication or division is @code{NaN | |
| + I*NaN}, with an attempt to rescue the situation in that case. The | |
| option is enabled by @option{-ffast-math}. | |
| This option controls the default setting of the ISO C99 | |
| @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to | |
| all languages. | |
| @opindex fcx-fortran-rules | |
| @opindex fno-cx-fortran-rules | |
| @item -fcx-fortran-rules | |
| Complex multiplication and division follow Fortran rules. Range | |
| reduction is done as part of complex division, but there is no checking | |
| whether the result of a complex multiplication or division is @code{NaN | |
| + I*NaN}, with an attempt to rescue the situation in that case. | |
| @opindex fcx-method | |
| @item -fcx-method=@var{method} | |
| Complex multiplication and division follow the stated @var{method}. The | |
| @var{method} argument should be one of @samp{limited-range}, @samp{fortran} | |
| or @samp{stdc}. | |
| The default is to honor language specific constraints which means | |
| @samp{fortran} for Fortran and @samp{stdc} otherwise. | |
| @end table | |
| The following options control optimizations that may improve | |
| performance, but are not enabled by any @option{-O} options. This | |
| section includes experimental options that may produce broken code. | |
| @table @gcctabopt | |
| @opindex fbranch-probabilities | |
| @opindex fno-branch-probabilities | |
| @item -fbranch-probabilities | |
| After running a program compiled with @option{-fprofile-arcs} | |
| (@pxref{Instrumentation Options}), | |
| you can compile it a second time using | |
| @option{-fbranch-probabilities}, to improve optimizations based on | |
| the number of times each branch was taken. When a program | |
| compiled with @option{-fprofile-arcs} exits, it saves arc execution | |
| counts to a file called @file{@var{sourcename}.gcda} for each source | |
| file. The information in this data file is very dependent on the | |
| structure of the generated code, so you must use the same source code | |
| and the same optimization options for both compilations. | |
| See details about the file naming in @option{-fprofile-arcs}. | |
| With @option{-fbranch-probabilities}, GCC puts a | |
| @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}. | |
| These can be used to improve optimization. Currently, they are only | |
| used in one place: in @file{reorg.cc}, instead of guessing which path a | |
| branch is most likely to take, the @samp{REG_BR_PROB} values are used to | |
| exactly determine which path is taken more often. | |
| Enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex fprofile-values | |
| @opindex fno-profile-values | |
| @item -fprofile-values | |
| If combined with @option{-fprofile-arcs}, it adds code so that some | |
| data about values of expressions in the program is gathered. | |
| With @option{-fbranch-probabilities}, it reads back the data gathered | |
| from profiling values of expressions for usage in optimizations. | |
| Enabled by @option{-fprofile-generate}, @option{-fprofile-use}, and | |
| @option{-fauto-profile}. | |
| @opindex fprofile-reorder-functions | |
| @opindex fno-profile-reorder-functions | |
| @item -fprofile-reorder-functions | |
| Function reordering based on profile instrumentation collects | |
| first time of execution of a function and orders these functions | |
| in ascending order, aiming to optimize program startup through more | |
| efficient loading of text segments. | |
| Enabled with @option{-fprofile-use}. | |
| @opindex fvpt | |
| @opindex fno-vpt | |
| @item -fvpt | |
| If combined with @option{-fprofile-arcs}, this option instructs the compiler | |
| to add code to gather information about values of expressions. | |
| With @option{-fbranch-probabilities}, it reads back the data gathered | |
| and actually performs the optimizations based on them. | |
| Currently the optimizations include specialization of division operations | |
| using the knowledge about the value of the denominator. | |
| Enabled with @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex frename-registers | |
| @opindex fno-rename-registers | |
| @item -frename-registers | |
| Attempt to avoid false dependencies in scheduled code by making use | |
| of registers left over after register allocation. This optimization | |
| most benefits processors with lots of registers. Depending on the | |
| debug information format adopted by the target, however, it can | |
| make debugging impossible, since variables no longer stay in | |
| a ``home register''. | |
| Enabled by default with @option{-funroll-loops}. | |
| @opindex fschedule-fusion | |
| @opindex fno-schedule-fusion | |
| @item -fschedule-fusion | |
| Performs a target dependent pass over the instruction stream to schedule | |
| instructions of same type together because target machine can execute them | |
| more efficiently if they are adjacent to each other in the instruction flow. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex fdep-fusion | |
| @opindex fno-dep-fusion | |
| @item -fdep-fusion | |
| Detect macro-op fusible pairs consisting of single-use instructions and their | |
| uses, and place such pairs together in the instruction stream to increase | |
| fusion opportunities in hardware. This pass is executed once before register | |
| allocation, and another time before register renaming. | |
| Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}. | |
| @opindex ftracer | |
| @opindex fno-tracer | |
| @item -ftracer | |
| Perform tail duplication to enlarge superblock size. This transformation | |
| simplifies the control flow of the function allowing other optimizations to do | |
| a better job. | |
| Enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex funroll-loops | |
| @opindex fno-unroll-loops | |
| @item -funroll-loops | |
| Unroll loops whose number of iterations can be determined at compile time or | |
| upon entry to the loop. @option{-funroll-loops} implies | |
| @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. | |
| It also turns on complete loop peeling (i.e.@: complete removal of loops with | |
| a small constant number of iterations). This option makes code larger, and may | |
| or may not make it run faster. | |
| Enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex funroll-all-loops | |
| @opindex fno-unroll-all-loops | |
| @item -funroll-all-loops | |
| Unroll all loops, even if their number of iterations is uncertain when | |
| the loop is entered. This usually makes programs run more slowly. | |
| @option{-funroll-all-loops} implies the same options as | |
| @option{-funroll-loops}. | |
| @opindex fpeel-loops | |
| @opindex fno-peel-loops | |
| @item -fpeel-loops | |
| Peels loops for which there is enough information that they do not | |
| roll much (from profile feedback or static analysis). It also turns on | |
| complete loop peeling (i.e.@: complete removal of loops with small constant | |
| number of iterations). | |
| Enabled by @option{-O3}, @option{-fprofile-use}, and @option{-fauto-profile}. | |
| @opindex fno-malloc-dce | |
| @opindex fmalloc-dce | |
| @item -fmalloc-dce | |
| Control whether @code{malloc} (and its variants such as @code{calloc} or | |
| @code{strdup}), can be optimized away provided its return value is only used | |
| as a parameter of @code{free} call or compared with @code{NULL}. If | |
| @option{-fmalloc-dce=1} is used, only calls to @code{free} are allowed while | |
| with @option{-fmalloc-dce=2} also comparisons with @code{NULL} pointer are | |
| considered safe to remove. | |
| The default is @option{-fmalloc-dce=2}. See also @option{-fallocation-dce}. | |
| @opindex fmove-loop-invariants | |
| @opindex fno-move-loop-invariants | |
| @item -fmove-loop-invariants | |
| Enables the loop invariant motion pass in the RTL loop optimizer. Enabled | |
| at level @option{-O1} and higher, except for @option{-Og}. | |
| @opindex fmove-loop-stores | |
| @opindex fno-move-loop-stores | |
| @item -fmove-loop-stores | |
| Enables the loop store motion pass in the GIMPLE loop optimizer. This | |
| moves invariant stores to after the end of the loop in exchange for | |
| carrying the stored value in a register across the iteration. | |
| Note for this option to have an effect @option{-ftree-loop-im} has to | |
| be enabled as well. Enabled at level @option{-O1} and higher, except | |
| for @option{-Og}. | |
| @opindex fsplit-loops | |
| @opindex fno-split-loops | |
| @item -fsplit-loops | |
| Split a loop into two if it contains a condition that's always true | |
| for one side of the iteration space and false for the other. | |
| Enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex funswitch-loops | |
| @opindex fno-unswitch-loops | |
| @item -funswitch-loops | |
| Move branches with loop invariant conditions out of the loop, with duplicates | |
| of the loop on both branches (modified according to result of the condition). | |
| Enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex fversion-loops-for-strides | |
| @opindex fno-version-loops-for-strides | |
| @item -fversion-loops-for-strides | |
| If a loop iterates over an array with a variable stride, create another | |
| version of the loop that assumes the stride is always one. For example: | |
| @smallexample | |
| for (int i = 0; i < n; ++i) | |
| x[i * stride] = @dots{}; | |
| @end smallexample | |
| becomes: | |
| @smallexample | |
| if (stride == 1) | |
| for (int i = 0; i < n; ++i) | |
| x[i] = @dots{}; | |
| else | |
| for (int i = 0; i < n; ++i) | |
| x[i * stride] = @dots{}; | |
| @end smallexample | |
| This is particularly useful for assumed-shape arrays in Fortran where | |
| (for example) it allows better vectorization assuming contiguous accesses. | |
| This flag is enabled by default at @option{-O3}. | |
| It is also enabled by @option{-fprofile-use} and @option{-fauto-profile}. | |
| @opindex ffunction-sections | |
| @opindex fno-function-sections | |
| @opindex fdata-sections | |
| @opindex fno-data-sections | |
| @item -ffunction-sections | |
| @itemx -fdata-sections | |
| Place each function or data item into its own section in the output | |
| file if the target supports arbitrary sections. The name of the | |
| function or the name of the data item determines the section's name | |
| in the output file. | |
| With link-time optimization, an implicitly generated function section name is | |
| derived from the final assembler name unless the compiler deliberately places | |
| related functions, such as a thunk and its target, in the same section. The | |
| final assembler name may include a compiler-generated suffix that distinguishes | |
| identically named internal-linkage items from different translation units. | |
| Use these options on systems where the linker can perform optimizations to | |
| improve locality of reference in the instruction space. Most systems using the | |
| ELF object format have linkers with such optimizations. On AIX, the linker | |
| rearranges sections (CSECTs) based on the call graph. The performance impact | |
| varies. | |
| Together with a linker garbage collection (linker @option{--gc-sections} | |
| option) these options may lead to smaller statically-linked executables (after | |
| stripping). | |
| On ELF/DWARF systems these options do not degenerate the quality of the debug | |
| information. There could be issues with other object files/debug info formats. | |
| Only use these options when there are significant benefits from doing so. When | |
| you specify these options, the assembler and linker create larger object and | |
| executable files and are also slower. These options affect code generation. | |
| They prevent optimizations by the compiler and assembler using relative | |
| locations inside a translation unit since the locations are unknown until | |
| link time. An example of such an optimization is relaxing calls to short call | |
| instructions. | |
| @opindex fstdarg-opt | |
| @opindex fno-stdarg-opt | |
| @item -fstdarg-opt | |
| Optimize the prologue of variadic argument functions with respect to usage of | |
| those arguments. | |
| @opindex fsection-anchors | |
| @opindex fno-section-anchors | |
| @item -fsection-anchors | |
| Try to reduce the number of symbolic address calculations by using | |
| shared ``anchor'' symbols to address nearby objects. This transformation | |
| can help to reduce the number of GOT entries and GOT accesses on some | |
| targets. | |
| For example, the implementation of the following function @code{foo}: | |
| @smallexample | |
| static int a, b, c; | |
| int foo (void) @{ return a + b + c; @} | |
| @end smallexample | |
| @noindent | |
| usually calculates the addresses of all three variables, but if you | |
| compile it with @option{-fsection-anchors}, it accesses the variables | |
| from a common anchor point instead. The effect is similar to the | |
| following pseudocode (which isn't valid C): | |
| @smallexample | |
| int foo (void) | |
| @{ | |
| register int *xr = &x; | |
| return xr[&a - &x] + xr[&b - &x] + xr[&c - &x]; | |
| @} | |
| @end smallexample | |
| Not all targets support this option. | |
| @opindex fzero-call-used-regs | |
| @item -fzero-call-used-regs=@var{choice} | |
| Zero call-used registers at function return to increase program | |
| security by either mitigating Return-Oriented Programming (ROP) | |
| attacks or preventing information leakage through registers. | |
| The possible values of @var{choice} are the same as for the | |
| @code{zero_call_used_regs} attribute (@pxref{Common Attributes}). | |
| The default is @samp{skip}. | |
| You can control this behavior for a specific function by using the function | |
| attribute @code{zero_call_used_regs} (@pxref{Common Attributes}). | |
| @end table | |
| @node Instrumentation Options | |
| @section Program Instrumentation Options | |
| @cindex instrumentation options | |
| @cindex program instrumentation options | |
| @cindex run-time error checking options | |
| @cindex profiling options | |
| @cindex options, program instrumentation | |
| @cindex options, run-time error checking | |
| @cindex options, profiling | |
| GCC supports a number of command-line options that control adding | |
| run-time instrumentation to the code it normally generates. | |
| For example, one purpose of instrumentation is collect profiling | |
| statistics for use in finding program hot spots, code coverage | |
| analysis, or profile-guided optimizations. | |
| Another class of program instrumentation is adding run-time checking | |
| to detect programming errors like invalid pointer | |
| dereferences or out-of-bounds array accesses, as well as deliberately | |
| hostile attacks such as stack smashing or C++ vtable hijacking. | |
| There is also a general hook which can be used to implement other | |
| forms of tracing or function-level instrumentation for debug or | |
| program analysis purposes. | |
| @table @gcctabopt | |
| @cindex @command{prof} | |
| @cindex @command{gprof} | |
| @opindex p | |
| @opindex profile | |
| @opindex fprofile | |
| @opindex fno-profile | |
| @opindex pg | |
| @item -p | |
| @itemx --profile | |
| @itemx -fprofile | |
| @itemx -pg | |
| Generate extra code to write profile information suitable for the | |
| analysis program @command{prof} (for @option{-p}, @option{--profile}, | |
| and @option{-fprofile}) | |
| or @command{gprof} | |
| (for @option{-pg}). You must use this option when compiling | |
| the source files you want data about, and you must also use it when | |
| linking. | |
| You can use the function attribute @code{no_instrument_function} to | |
| suppress profiling of individual functions when compiling with these options. | |
| @xref{Common Attributes}. | |
| @opindex fprofile-arcs | |
| @opindex fno-profile-arcs | |
| @item -fprofile-arcs | |
| Add code so that program flow @dfn{arcs} are instrumented. During | |
| execution the program records how many times each branch and call is | |
| executed and how many times it is taken or returns. On targets that support | |
| constructors with priority support, profiling properly handles constructors, | |
| destructors and C++ constructors (and destructors) of classes which are used | |
| as a type of a global variable. | |
| When the compiled | |
| program exits it saves this data to a file called | |
| @file{@var{auxname}.gcda} for each source file. The data may be used for | |
| profile-directed optimizations (@option{-fbranch-probabilities}), or for | |
| test coverage analysis (@option{-ftest-coverage}). Each object file's | |
| @var{auxname} is generated from the name of the output file, if | |
| explicitly specified and it is not the final executable, otherwise it is | |
| the basename of the source file. In both cases any suffix is removed | |
| (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or | |
| @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}). | |
| Note that if a command line directly links source files, the corresponding | |
| @var{.gcda} files will be prefixed with the unsuffixed name of the output file. | |
| E.g. @code{gcc a.c b.c -o binary} would generate @file{binary-a.gcda} and | |
| @file{binary-b.gcda} files. | |
| @item -fcondition-coverage | |
| @opindex fcondition-coverage | |
| @opindex fno-condition-coverage | |
| Add code so that program conditions are instrumented. During execution the | |
| program records what terms in a conditional contributes to a decision, which | |
| can be used to verify that all terms in a Boolean function are tested and have | |
| an independent effect on the outcome of a decision. The result can be read | |
| with @code{gcov --conditions}. | |
| @item -fpath-coverage | |
| @opindex fpath-coverage | |
| @opindex fno-path-coverage | |
| Add code so that the paths taken are tracked. During execution the | |
| program records the prime paths taken. The number of paths grows very | |
| fast with complexity, and to avoid exploding compile times GCC will give | |
| up instrumentation if the approximate number of paths exceeds the limit | |
| controlled by @option{-fpath-coverage-limit}. The result can be read | |
| with @code{gcov --prime-paths --prime-paths-lines --prime-paths-source}, | |
| @xref{gcov prime paths example}. | |
| @item -fpath-coverage-limit=@var{limit} | |
| @opindex fpath-coverage-limit | |
| The threshold at which point @option{-fpath-coverage} gives up on | |
| instrumenting a function. This limit is approximate and conservative, | |
| as GCC uses a pessimistic heuristic which slightly overcounts the | |
| running number of paths, and gives up if the threshold is reached before | |
| finding all the paths. This option is not for fine grained control over | |
| which functions to instrument - rather it is intended to limit the | |
| effect of path explosion and keep compile times reasonable. The default | |
| is @var{250000}. | |
| @xref{Cross-profiling}. | |
| @cindex @command{gcov} | |
| @opindex coverage | |
| @item --coverage | |
| @itemx -coverage | |
| This option is used to compile and link code instrumented for coverage | |
| analysis. The options @option{-coverage} and @option{--coverage} are | |
| equivalent; both are a synonym for @option{-fprofile-arcs} | |
| @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when | |
| linking). See the documentation for those options for more details. | |
| @itemize | |
| @item | |
| Compile the source files with @option{-fprofile-arcs} plus optimization | |
| and code generation options. For test coverage analysis, use the | |
| additional @option{-ftest-coverage} option. You do not need to profile | |
| every source file in a program. | |
| @item | |
| Compile the source files additionally with @option{-fprofile-abs-path} | |
| to create absolute path names in the @file{.gcno} files. This allows | |
| @command{gcov} to find the correct sources in projects where compilations | |
| occur with different working directories. | |
| @item | |
| Link your object files with @option{-lgcov} or @option{-fprofile-arcs} | |
| (the latter implies the former). | |
| @item | |
| Run the program on a representative workload to generate the arc profile | |
| information. This may be repeated any number of times. You can run | |
| concurrent instances of your program, and provided that the file system | |
| supports locking, the data files will be correctly updated. Unless | |
| a strict ISO C dialect option is in effect, @code{fork} calls are | |
| detected and correctly handled without double counting. | |
| Moreover, an object file can be recompiled multiple times | |
| and the corresponding @file{.gcda} file merges as long as | |
| the source file and the compiler options are unchanged. | |
| @item | |
| For profile-directed optimizations, compile the source files again with | |
| the same optimization and code generation options plus | |
| @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that | |
| Control Optimization}). | |
| @item | |
| For test coverage analysis, use @command{gcov} to produce human readable | |
| information from the @file{.gcno} and @file{.gcda} files. Refer to the | |
| @command{gcov} documentation for further information. | |
| @end itemize | |
| With @option{-fprofile-arcs}, for each function of your program GCC | |
| creates a program flow graph, then finds a spanning tree for the graph. | |
| Only arcs that are not on the spanning tree have to be instrumented: the | |
| compiler adds code to count the number of times that these arcs are | |
| executed. When an arc is the only exit or only entrance to a block, the | |
| instrumentation code can be added to the block; otherwise, a new basic | |
| block must be created to hold the instrumentation code. | |
| With @option{-fcondition-coverage}, for each conditional in your program GCC | |
| creates a bitset and records the exercised boolean values that have an | |
| independent effect on the outcome of that expression. | |
| With @option{-fpath-coverage}, GCC finds and enumerates and records the | |
| taken prime paths of each function, unless the number of paths would | |
| exceed the limit controlled by @option{-fpath-coverage-limit}. If the | |
| limit is exceeded the function is not instrumented as if | |
| @option{-fpath-coverage} was not used. A prime path is the longest | |
| sequence of unique blocks, except possibly the first and last, which is | |
| not a subpath of any other path. | |
| @need 2000 | |
| @opindex ftest-coverage | |
| @opindex fno-test-coverage | |
| @item -ftest-coverage | |
| Produce a notes file that the @command{gcov} code-coverage utility | |
| (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to | |
| show program coverage. Each source file's note file is called | |
| @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option | |
| above for a description of @var{auxname} and instructions on how to | |
| generate test coverage data. Coverage data matches the source files | |
| more closely if you do not optimize. | |
| @opindex fprofile-abs-path | |
| @opindex fno-profile-abs-path | |
| @item -fprofile-abs-path | |
| Automatically convert relative source file names to absolute path names | |
| in the @file{.gcno} files. This allows @command{gcov} to find the correct | |
| sources in projects where compilations occur with different working | |
| directories. | |
| @opindex fprofile-dir | |
| @item -fprofile-dir=@var{path} | |
| Set the directory to search for the profile data files in to @var{path}. | |
| This option affects only the profile data generated by | |
| @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs} | |
| and used by @option{-fprofile-use} and @option{-fbranch-probabilities} | |
| and its related options. Both absolute and relative paths can be used. | |
| By default, GCC uses the current directory as @var{path}, thus the | |
| profile data file appears in the same directory as the object file. | |
| In order to prevent the file name clashing, if the object file name is | |
| not an absolute path, we mangle the absolute path of the | |
| @file{@var{sourcename}.gcda} file and use it as the file name of a | |
| @file{.gcda} file. See details about the file naming in @option{-fprofile-arcs}. | |
| See similar option @option{-fprofile-note}. | |
| When an executable is run in a massive parallel environment, it is recommended | |
| to save profile to different folders. That can be done with variables | |
| in @var{path} that are exported during run-time: | |
| @table @gcctabopt | |
| @item %p | |
| process ID. | |
| @item %q@{VAR@} | |
| value of environment variable @var{VAR} | |
| @end table | |
| @opindex fprofile-generate | |
| @opindex fno-profile-generate | |
| @item -fprofile-generate | |
| @itemx -fprofile-generate=@var{path} | |
| Enable options usually used for instrumenting application to produce | |
| profile useful for later recompilation with profile feedback based | |
| optimization. You must use @option{-fprofile-generate} both when | |
| compiling and when linking your program. | |
| The following options are enabled: | |
| @option{-fprofile-arcs}, @option{-fprofile-values}, | |
| @option{-finline-functions}, and @option{-fipa-bit-cp}. | |
| If @var{path} is specified, GCC looks at the @var{path} to find | |
| the profile feedback data files. See @option{-fprofile-dir}. | |
| To optimize the program based on the collected profile information, use | |
| @option{-fprofile-use}. @xref{Optimize Options}, for more information. | |
| @opindex fprofile-info-section | |
| @item -fprofile-info-section | |
| @itemx -fprofile-info-section=@var{name} | |
| Register the profile information in the specified section instead of using a | |
| constructor/destructor. The section name is @var{name} if it is specified, | |
| otherwise the section name defaults to @code{.gcov_info}. A pointer to the | |
| profile information generated by @option{-fprofile-arcs} is placed in the | |
| specified section for each translation unit. This option disables the profile | |
| information registration through a constructor and it disables the profile | |
| information processing through a destructor. This option is not intended to be | |
| used in hosted environments such as GNU/Linux. It targets freestanding | |
| environments (for example embedded systems) with limited resources which do not | |
| support constructors/destructors or the C library file I/O. | |
| The linker could collect the input sections in a continuous memory block and | |
| define start and end symbols. A GNU linker script example which defines a | |
| linker output section follows: | |
| @smallexample | |
| .gcov_info : | |
| @{ | |
| PROVIDE (__gcov_info_start = .); | |
| KEEP (*(.gcov_info)) | |
| PROVIDE (__gcov_info_end = .); | |
| @} | |
| @end smallexample | |
| The program could dump the profiling information registered in this linker set | |
| for example like this: | |
| @smallexample | |
| #include <gcov.h> | |
| #include <stdio.h> | |
| #include <stdlib.h> | |
| extern const struct gcov_info *const __gcov_info_start[]; | |
| extern const struct gcov_info *const __gcov_info_end[]; | |
| static void | |
| dump (const void *d, unsigned n, void *arg) | |
| @{ | |
| const unsigned char *c = d; | |
| for (unsigned i = 0; i < n; ++i) | |
| printf ("%02x", c[i]); | |
| @} | |
| static void | |
| filename (const char *f, void *arg) | |
| @{ | |
| __gcov_filename_to_gcfn (f, dump, arg ); | |
| @} | |
| static void * | |
| allocate (unsigned length, void *arg) | |
| @{ | |
| return malloc (length); | |
| @} | |
| static void | |
| dump_gcov_info (void) | |
| @{ | |
| const struct gcov_info *const *info = __gcov_info_start; | |
| const struct gcov_info *const *end = __gcov_info_end; | |
| /* Obfuscate variable to prevent compiler optimizations. */ | |
| __asm__ ("" : "+r" (info)); | |
| while (info != end) | |
| @{ | |
| void *arg = NULL; | |
| __gcov_info_to_gcda (*info, filename, dump, allocate, arg); | |
| putchar ('\n'); | |
| ++info; | |
| @} | |
| @} | |
| int | |
| main (void) | |
| @{ | |
| dump_gcov_info (); | |
| return 0; | |
| @} | |
| @end smallexample | |
| The @command{merge-stream} subcommand of @command{gcov-tool} may be used to | |
| deserialize the data stream generated by the @code{__gcov_filename_to_gcfn} and | |
| @code{__gcov_info_to_gcda} functions and merge the profile information into | |
| @file{.gcda} files on the host filesystem. | |
| @opindex fprofile-note | |
| @item -fprofile-note=@var{path} | |
| If @var{path} is specified, GCC saves @file{.gcno} file into @var{path} | |
| location. If you combine the option with multiple source files, | |
| the @file{.gcno} file will be overwritten. | |
| @opindex fprofile-prefix-path | |
| @item -fprofile-prefix-path=@var{path} | |
| This option can be used in combination with | |
| @option{profile-generate=}@var{profile_dir} and | |
| @option{profile-use=}@var{profile_dir} to inform GCC where is the base | |
| directory of built source tree. By default @var{profile_dir} will contain | |
| files with mangled absolute paths of all object files in the built project. | |
| This is not desirable when directory used to build the instrumented binary | |
| differs from the directory used to build the binary optimized with profile | |
| feedback because the profile data will not be found during the optimized build. | |
| In such setups @option{-fprofile-prefix-path=}@var{path} with @var{path} | |
| pointing to the base directory of the build can be used to strip the irrelevant | |
| part of the path and keep all file names relative to the main build directory. | |
| @opindex fprofile-prefix-map | |
| @item -fprofile-prefix-map=@var{old}=@var{new} | |
| When compiling files residing in directory @file{@var{old}}, record | |
| profiling information (with @option{--coverage}) | |
| describing them as if the files resided in | |
| directory @file{@var{new}} instead. | |
| See also @option{-ffile-prefix-map} and @option{-fcanon-prefix-map}. | |
| @opindex fprofile-update | |
| @item -fprofile-update=@var{method} | |
| Alter the update method for an application instrumented for profile | |
| feedback based optimization. The @var{method} argument should be one of | |
| @samp{single}, @samp{atomic} or @samp{prefer-atomic}. | |
| The first one is useful for single-threaded applications, | |
| while the second one prevents profile corruption by emitting thread-safe code. | |
| @strong{Warning:} When an application does not properly join all threads | |
| (or creates an detached thread), a profile file can be still corrupted. | |
| Using @samp{prefer-atomic} would be transformed either to @samp{atomic}, | |
| when supported by a target, or to @samp{single} otherwise. The GCC driver | |
| automatically selects @samp{prefer-atomic} when @option{-pthread} | |
| is present in the command line, otherwise the default method is @samp{single}. | |
| If @samp{atomic} is selected, then the profile information is updated using | |
| atomic operations on a best-effort basis. Ideally, the profile information is | |
| updated through atomic operations in hardware. If the target platform does not | |
| support the required atomic operations in hardware, however, @file{libatomic} | |
| is available, then the profile information is updated through calls to | |
| @file{libatomic}. If the target platform neither supports the required atomic | |
| operations in hardware nor @file{libatomic}, then the profile information is | |
| not atomically updated and a warning is issued. In this case, the obtained | |
| profiling information may be corrupt for multi-threaded applications. | |
| For performance reasons, if 64-bit counters are used for the profiling | |
| information and the target platform only supports 32-bit atomic operations in | |
| hardware, then the performance critical profiling updates are done using two | |
| 32-bit atomic operations for each counter update. If a signal interrupts these | |
| two operations updating a counter, then the profiling information may be in an | |
| inconsistent state. | |
| @opindex fprofile-filter-files | |
| @item -fprofile-filter-files=@var{regex} | |
| Instrument only functions from files whose name matches | |
| any of the regular expressions (separated by semi-colons). | |
| For example, @option{-fprofile-filter-files=main\.c;module.*\.c} will instrument | |
| only @file{main.c} and all C files starting with 'module'. | |
| @opindex fprofile-exclude-files | |
| @item -fprofile-exclude-files=@var{regex} | |
| Instrument only functions from files whose name does not match | |
| any of the regular expressions (separated by semi-colons). | |
| For example, @option{-fprofile-exclude-files=/usr/.*} will prevent instrumentation | |
| of all files that are located in the @file{/usr/} folder. | |
| @opindex fprofile-reproducible | |
| @item -fprofile-reproducible=@r{[}multithreaded@r{|}parallel-runs@r{|}serial@r{]} | |
| Control level of reproducibility of profile gathered by | |
| @code{-fprofile-generate}. This makes it possible to rebuild program | |
| with same outcome which is useful, for example, for distribution | |
| packages. | |
| With @option{-fprofile-reproducible=serial} the profile gathered by | |
| @option{-fprofile-generate} is reproducible provided the trained program | |
| behaves the same at each invocation of the train run, it is not | |
| multi-threaded and profile data streaming is always done in the same | |
| order. Note that profile streaming happens at the end of program run but | |
| also before @code{fork} function is invoked. | |
| Note that it is quite common that execution counts of some part of | |
| programs depends, for example, on length of temporary file names or | |
| memory space randomization (that may affect hash-table collision rate). | |
| Such non-reproducible part of programs may be annotated by | |
| @code{no_instrument_function} function attribute. @command{gcov-dump} with | |
| @option{-l} can be used to dump gathered data and verify that they are | |
| indeed reproducible. | |
| With @option{-fprofile-reproducible=parallel-runs} collected profile | |
| stays reproducible regardless the order of streaming of the data into | |
| gcda files. This setting makes it possible to run multiple instances of | |
| instrumented program in parallel (such as with @code{make -j}). This | |
| reduces quality of gathered data, in particular of indirect call | |
| profiling. | |
| @opindex fsanitize=address | |
| @item -fsanitize=address | |
| Enable AddressSanitizer, a fast memory error detector. | |
| Memory access instructions are instrumented to detect | |
| out-of-bounds and use-after-free bugs. | |
| The option enables @option{-fsanitize-address-use-after-scope}. | |
| See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for | |
| more details. The run-time behavior can be influenced using the | |
| @env{ASAN_OPTIONS} environment variable. When set to @code{help=1}, | |
| the available options are shown at startup of the instrumented program. See | |
| @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags} | |
| for a list of supported options. | |
| The option cannot be combined with @option{-fsanitize=thread} or | |
| @option{-fsanitize=hwaddress}. Note that the only targets | |
| @option{-fsanitize=hwaddress} is currently supported on are x86-64 | |
| (only with @code{-mlam=u48} or @code{-mlam=u57} options) and AArch64, in both | |
| cases only in ABIs with 64-bit pointers. Similarly, | |
| @option{-fsanitize=memtag-stack} is currently only supported on AArch64 ABIs | |
| with 64-bit pointers. | |
| When compiling with @option{-fsanitize=address}, you should also | |
| use @option{-g} to produce more meaningful output. | |
| To get more accurate stack traces, it is possible to use options such as | |
| @option{-O0}, @option{-O1}, or @option{-Og} (which, for instance, prevent | |
| most function inlining), @option{-fno-optimize-sibling-calls} (which prevents | |
| optimizing sibling and tail recursive calls; this option is implicit for | |
| @option{-O0}, @option{-O1}, or @option{-Og}), or @option{-fno-ipa-icf} (which | |
| disables Identical Code Folding for functions). | |
| Using @option{-fno-omit-frame-pointer} also improves stack traces. | |
| Since multiple runs of the | |
| program may yield backtraces with different addresses due to ASLR (Address | |
| Space Layout Randomization), it may be desirable to turn ASLR off. On Linux, | |
| this can be achieved with @samp{setarch `uname -m` -R ./prog}. | |
| @opindex fsanitize=kernel-address | |
| @item -fsanitize=kernel-address | |
| Enable AddressSanitizer for Linux kernel. | |
| See @uref{https://github.com/google/kernel-sanitizers} for more details. | |
| @opindex fsanitize=hwaddress | |
| @item -fsanitize=hwaddress | |
| Enable Hardware-assisted AddressSanitizer, which uses a hardware ability to | |
| ignore the top byte of a pointer to allow the detection of memory errors with | |
| a low memory overhead. | |
| Memory access instructions are instrumented to detect out-of-bounds and | |
| use-after-free bugs. | |
| The option enables @option{-fsanitize-address-use-after-scope}. | |
| See | |
| @uref{https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html} | |
| for more details. The run-time behavior can be influenced using the | |
| @env{HWASAN_OPTIONS} environment variable. When set to @code{help=1}, | |
| the available options are shown at startup of the instrumented program. | |
| The option cannot be combined with @option{-fsanitize=thread} or | |
| @option{-fsanitize=address}, and is currently only available on AArch64. | |
| @opindex fsanitize=kernel-hwaddress | |
| @item -fsanitize=kernel-hwaddress | |
| Enable Hardware-assisted AddressSanitizer for compilation of the Linux kernel. | |
| Similar to @option{-fsanitize=kernel-address} but using an alternate | |
| instrumentation method, and similar to @option{-fsanitize=hwaddress} but with | |
| instrumentation differences necessary for compiling the Linux kernel. | |
| These differences are to avoid hwasan library initialization calls and to | |
| account for the stack pointer having a different value in its top byte. | |
| @emph{Note:} This option has different defaults than | |
| @option{-fsanitize=hwaddress}. | |
| Instrumenting the stack and alloca calls are not on by default. | |
| Using a random frame tag is not implemented for kernel instrumentation. | |
| @opindex fsanitize=memtag-stack | |
| @item -fsanitize=memtag-stack | |
| Use Memory Tagging Extension instructions instead of instrumentation | |
| to allow the detection of memory errors. Similar to HWASAN, it is | |
| also a probabilistic method. This option is available only on those | |
| AArch64 architectures that support Memory Tagging Extensions. | |
| @opindex fsanitize=pointer-compare | |
| @item -fsanitize=pointer-compare | |
| Instrument comparison operation (<, <=, >, >=) with pointer operands. | |
| The option must be combined with either @option{-fsanitize=kernel-address} or | |
| @option{-fsanitize=address} | |
| The option cannot be combined with @option{-fsanitize=thread}. | |
| Note: By default the check is disabled at run time. To enable it, | |
| add @code{detect_invalid_pointer_pairs=2} to the environment variable | |
| @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects | |
| invalid operation only when both pointers are non-null. | |
| @opindex fsanitize=pointer-subtract | |
| @item -fsanitize=pointer-subtract | |
| Instrument subtraction with pointer operands. | |
| The option must be combined with either @option{-fsanitize=kernel-address} or | |
| @option{-fsanitize=address} | |
| The option cannot be combined with @option{-fsanitize=thread}. | |
| Note: By default the check is disabled at run time. To enable it, | |
| add @code{detect_invalid_pointer_pairs=2} to the environment variable | |
| @env{ASAN_OPTIONS}. Using @code{detect_invalid_pointer_pairs=1} detects | |
| invalid operation only when both pointers are non-null. | |
| @opindex fsanitize=shadow-call-stack | |
| @item -fsanitize=shadow-call-stack | |
| Enable ShadowCallStack, a security enhancement mechanism used to protect | |
| programs against return address overwrites (e.g. stack buffer overflows.) | |
| It works by saving a function's return address to a separately allocated | |
| shadow call stack in the function prologue and restoring the return address | |
| from the shadow call stack in the function epilogue. Instrumentation only | |
| occurs in functions that need to save the return address to the stack. | |
| Currently it only supports the aarch64 platform. It is specifically | |
| designed for linux kernels that enable the CONFIG_SHADOW_CALL_STACK option. | |
| For the user space programs, runtime support is not currently provided | |
| in libc and libgcc. Users who want to use this feature in user space need | |
| to provide their own support for the runtime. It should be noted that | |
| this may cause the ABI rules to be broken. | |
| On aarch64, the instrumentation makes use of the platform register @code{x18}. | |
| This generally means that any code that may run on the same thread as code | |
| compiled with ShadowCallStack must be compiled with the flag | |
| @option{-ffixed-x18}, otherwise functions compiled without | |
| @option{-ffixed-x18} might clobber @code{x18} and so corrupt the shadow | |
| stack pointer. | |
| Also, because there is no userspace runtime support, code compiled with | |
| ShadowCallStack cannot use exception handling. Use @option{-fno-exceptions} | |
| to turn off exceptions. | |
| See @uref{https://clang.llvm.org/docs/ShadowCallStack.html} for more | |
| details. | |
| @opindex fsanitize=thread | |
| @item -fsanitize=thread | |
| Enable ThreadSanitizer, a fast data race detector. | |
| Memory access instructions are instrumented to detect | |
| data race bugs. See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more | |
| details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS} | |
| environment variable; see | |
| @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of | |
| supported options. | |
| The option cannot be combined with @option{-fsanitize=address}, | |
| @option{-fsanitize=leak}. | |
| When compiling with @option{-fsanitize=thread}, you should also use | |
| @option{-g} to produce more meaningful output. | |
| Note that sanitized atomic builtins cannot throw exceptions when | |
| operating on invalid memory addresses with non-call exceptions | |
| (@option{-fnon-call-exceptions}). | |
| @opindex fsanitize=leak | |
| @item -fsanitize=leak | |
| Enable LeakSanitizer, a memory leak detector. | |
| This option only matters for linking of executables. | |
| The executable is linked against a library that overrides @code{malloc} | |
| and other allocator functions. See | |
| @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more | |
| details. The run-time behavior can be influenced using the | |
| @env{LSAN_OPTIONS} environment variable. | |
| The option cannot be combined with @option{-fsanitize=thread}. | |
| @opindex fsanitize=undefined | |
| @item -fsanitize=undefined | |
| Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector. | |
| Various computations are instrumented to detect undefined behavior | |
| at runtime. See @uref{https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html} for more details. The run-time behavior can be influenced using the | |
| @env{UBSAN_OPTIONS} environment variable. Current suboptions are: | |
| @table @gcctabopt | |
| @opindex fsanitize=shift | |
| @item -fsanitize=shift | |
| This option enables checking that the result of a shift operation is | |
| not undefined. Note that what exactly is considered undefined differs | |
| slightly between C and C++, as well as between ISO C90 and C99, etc. | |
| This option has two suboptions, @option{-fsanitize=shift-base} and | |
| @option{-fsanitize=shift-exponent}. | |
| @opindex fsanitize=shift-exponent | |
| @item -fsanitize=shift-exponent | |
| This option enables checking that the second argument of a shift operation | |
| is not negative and is smaller than the precision of the promoted first | |
| argument. | |
| @opindex fsanitize=shift-base | |
| @item -fsanitize=shift-base | |
| If the second argument of a shift operation is within range, check that the | |
| result of a shift operation is not undefined. Note that what exactly is | |
| considered undefined differs slightly between C and C++, as well as between | |
| ISO C90 and C99, etc. | |
| @opindex fsanitize=integer-divide-by-zero | |
| @item -fsanitize=integer-divide-by-zero | |
| Detect integer division by zero. | |
| @opindex fsanitize=unreachable | |
| @item -fsanitize=unreachable | |
| With this option, the compiler turns the @code{__builtin_unreachable} | |
| call into a diagnostics message call instead. When reaching the | |
| @code{__builtin_unreachable} call, the behavior is undefined. | |
| @opindex fsanitize=vla-bound | |
| @item -fsanitize=vla-bound | |
| This option instructs the compiler to check that the size of a variable | |
| length array is positive. | |
| @opindex fsanitize=null | |
| @item -fsanitize=null | |
| This option enables pointer checking. Particularly, the application | |
| built with this option turned on will issue an error message when it | |
| tries to dereference a NULL pointer, or if a reference (possibly an | |
| rvalue reference) is bound to a NULL pointer, or if a method is invoked | |
| on an object pointed by a NULL pointer. | |
| @opindex fsanitize=return | |
| @item -fsanitize=return | |
| This option enables return statement checking. Programs | |
| built with this option turned on will issue an error message | |
| when the end of a non-void function is reached without actually | |
| returning a value. This option works in C++ only. | |
| @opindex fsanitize=signed-integer-overflow | |
| @item -fsanitize=signed-integer-overflow | |
| This option enables signed integer overflow checking. We check that | |
| the result of @code{+}, @code{*}, and both unary and binary @code{-} | |
| does not overflow in the signed arithmetics. This also detects | |
| @code{INT_MIN / -1} signed division. Note, integer promotion | |
| rules must be taken into account. That is, the following is not an | |
| overflow: | |
| @smallexample | |
| signed char a = SCHAR_MAX; | |
| a++; | |
| @end smallexample | |
| @opindex fsanitize=bounds | |
| @item -fsanitize=bounds | |
| This option enables instrumentation of array bounds. Various out of bounds | |
| accesses are detected. Flexible array members, flexible array member-like | |
| arrays, and initializers of variables with static storage are not | |
| instrumented, with the exception of flexible array member-like arrays | |
| for which @code{-fstrict-flex-arrays} or @code{-fstrict-flex-arrays=} | |
| options or @code{strict_flex_array} attributes say they shouldn't be treated | |
| like flexible array member-like arrays. | |
| @opindex fsanitize=bounds-strict | |
| @item -fsanitize=bounds-strict | |
| This option enables strict instrumentation of array bounds. Most out of bounds | |
| accesses are detected, including flexible array member-like arrays. | |
| Initializers of variables with static storage are not instrumented. | |
| @opindex fsanitize=alignment | |
| @item -fsanitize=alignment | |
| This option enables checking of alignment of pointers when they are | |
| dereferenced, or when a reference is bound to insufficiently aligned target, | |
| or when a method or constructor is invoked on insufficiently aligned object. | |
| @opindex fsanitize=object-size | |
| @item -fsanitize=object-size | |
| This option enables instrumentation of memory references using the | |
| @code{__builtin_dynamic_object_size} function. Various out of bounds | |
| pointer accesses are detected. | |
| @opindex fsanitize=float-divide-by-zero | |
| @item -fsanitize=float-divide-by-zero | |
| Detect floating-point division by zero. Unlike other similar options, | |
| @option{-fsanitize=float-divide-by-zero} is not enabled by | |
| @option{-fsanitize=undefined}, since floating-point division by zero can | |
| be a legitimate way of obtaining infinities and NaNs. | |
| @opindex fsanitize=float-cast-overflow | |
| @item -fsanitize=float-cast-overflow | |
| This option enables floating-point type to integer conversion checking. | |
| We check that the result of the conversion does not overflow. | |
| Unlike other similar options, @option{-fsanitize=float-cast-overflow} is | |
| not enabled by @option{-fsanitize=undefined}. | |
| This option does not work well with @code{FE_INVALID} exceptions enabled. | |
| @opindex fsanitize=nonnull-attribute | |
| @item -fsanitize=nonnull-attribute | |
| This option enables instrumentation of calls, checking whether null values | |
| are not passed to arguments marked as requiring a non-null value by the | |
| @code{nonnull} function attribute. | |
| @opindex fsanitize=returns-nonnull-attribute | |
| @item -fsanitize=returns-nonnull-attribute | |
| This option enables instrumentation of return statements in functions | |
| marked with @code{returns_nonnull} function attribute, to detect returning | |
| of null values from such functions. | |
| @opindex fsanitize=bool | |
| @item -fsanitize=bool | |
| This option enables instrumentation of loads from bool. If a value other | |
| than 0/1 is loaded, a run-time error is issued. | |
| @opindex fsanitize=enum | |
| @item -fsanitize=enum | |
| This option enables instrumentation of loads from an enum type. If | |
| a value outside the range of values for the enum type is loaded, | |
| a run-time error is issued. | |
| @opindex fsanitize=vptr | |
| @item -fsanitize=vptr | |
| This option enables instrumentation of C++ member function calls, member | |
| accesses and some conversions between pointers to base and derived classes, | |
| to verify the referenced object has the correct dynamic type. | |
| @opindex fsanitize=pointer-overflow | |
| @item -fsanitize=pointer-overflow | |
| This option enables instrumentation of pointer arithmetics. If the pointer | |
| arithmetics overflows, a run-time error is issued. | |
| @opindex fsanitize=builtin | |
| @item -fsanitize=builtin | |
| This option enables instrumentation of arguments to selected builtin | |
| functions. If an invalid value is passed to such arguments, a run-time | |
| error is issued. E.g.@ passing 0 as the argument to @code{__builtin_ctz} | |
| or @code{__builtin_clz} invokes undefined behavior and is diagnosed | |
| by this option. | |
| @end table | |
| Note that sanitizers tend to increase the rate of false positive | |
| warnings, most notably those around @option{-Wmaybe-uninitialized}. | |
| We recommend against combining @option{-Werror} and [the use of] | |
| sanitizers. | |
| While @option{-ftrapv} causes traps for signed overflows to be emitted, | |
| @option{-fsanitize=undefined} gives a diagnostic message. | |
| This currently works only for the C family of languages. | |
| @opindex fno-sanitize=all | |
| @item -fno-sanitize=all | |
| This option disables all previously enabled sanitizers. | |
| @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used | |
| together. | |
| @opindex fasan-shadow-offset | |
| @item -fasan-shadow-offset=@var{number} | |
| This option forces GCC to use custom shadow offset in AddressSanitizer checks. | |
| It is useful for experimenting with different shadow memory layouts in | |
| Kernel AddressSanitizer. | |
| @opindex fsanitize-sections | |
| @item -fsanitize-sections=@var{s1},@var{s2},... | |
| Sanitize global variables in selected user-defined sections. @var{si} may | |
| contain wildcards. | |
| @opindex fsanitize-recover | |
| @opindex fno-sanitize-recover | |
| @item -fsanitize-recover@r{[}=@var{opts}@r{]} | |
| @option{-fsanitize-recover=} controls error recovery mode for sanitizers | |
| mentioned in comma-separated list of @var{opts}. Enabling this option | |
| for a sanitizer component causes it to attempt to continue | |
| running the program as if no error happened. This means multiple | |
| runtime errors can be reported in a single program run, and the exit | |
| code of the program may indicate success even when errors | |
| have been reported. The @option{-fno-sanitize-recover=} option | |
| can be used to alter | |
| this behavior: only the first detected error is reported | |
| and program then exits with a non-zero exit code. | |
| Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions | |
| except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}), | |
| @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero}, | |
| @option{-fsanitize=bounds-strict}, | |
| @option{-fsanitize=kernel-address} and @option{-fsanitize=address}. | |
| For these sanitizers error recovery is turned on by default, | |
| except @option{-fsanitize=address}, for which this feature is experimental. | |
| @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also | |
| accepted, the former enables recovery for all sanitizers that support it, | |
| the latter disables recovery for all sanitizers that support it. | |
| Even if a recovery mode is turned on the compiler side, it needs to be also | |
| enabled on the runtime library side, otherwise the failures are still fatal. | |
| The runtime library defaults to @code{halt_on_error=0} for | |
| ThreadSanitizer and UndefinedBehaviorSanitizer, while default value for | |
| AddressSanitizer is @code{halt_on_error=1}. This can be overridden through | |
| setting the @code{halt_on_error} flag in the corresponding environment variable. | |
| Syntax without an explicit @var{opts} parameter is deprecated. It is | |
| equivalent to specifying an @var{opts} list of: | |
| @smallexample | |
| undefined,float-cast-overflow,float-divide-by-zero,bounds-strict | |
| @end smallexample | |
| @opindex fsanitize-address-use-after-scope | |
| @opindex fno-sanitize-address-use-after-scope | |
| @item -fsanitize-address-use-after-scope | |
| Enable sanitization of local variables to detect use-after-scope bugs. | |
| The option sets @option{-fstack-reuse} to @samp{none}. | |
| @opindex fsanitize-trap | |
| @opindex fno-sanitize-trap | |
| @item -fsanitize-trap@r{[}=@var{opts}@r{]} | |
| The @option{-fsanitize-trap=} option instructs the compiler to | |
| report for sanitizers mentioned in comma-separated list of @var{opts} | |
| undefined behavior using @code{__builtin_trap} rather than a @code{libubsan} | |
| library routine. If this option is enabled for certain sanitizer, | |
| it takes precedence over the @option{-fsanitizer-recover=} for that | |
| sanitizer, @code{__builtin_trap} will be emitted and be fatal regardless | |
| of whether recovery is enabled or disabled using @option{-fsanitize-recover=}. | |
| The advantage of this is that the @code{libubsan} library is not needed | |
| and is not linked in, so this is usable even in freestanding environments. | |
| Currently this feature works with @option{-fsanitize=undefined} (and its suboptions | |
| except for @option{-fsanitize=vptr}), @option{-fsanitize=float-cast-overflow}, | |
| @option{-fsanitize=float-divide-by-zero} and | |
| @option{-fsanitize=bounds-strict}. @code{-fsanitize-trap=all} can be also | |
| specified, which enables it for @code{undefined} suboptions, | |
| @option{-fsanitize=float-cast-overflow}, | |
| @option{-fsanitize=float-divide-by-zero} and | |
| @option{-fsanitize=bounds-strict}. | |
| If @code{-fsanitize-trap=undefined} or @code{-fsanitize-trap=all} is used | |
| and @code{-fsanitize=vptr} is enabled on the command line, the | |
| instrumentation is silently ignored as the instrumentation always needs | |
| @code{libubsan} support, @option{-fsanitize-trap=vptr} is not allowed. | |
| @opindex fsanitize-undefined-trap-on-error | |
| @opindex fno-sanitize-undefined-trap-on-error | |
| @item -fsanitize-undefined-trap-on-error | |
| The @option{-fsanitize-undefined-trap-on-error} option is deprecated | |
| equivalent of @option{-fsanitize-trap=all}. | |
| @opindex fsanitize-coverage=trace-pc | |
| @opindex fno-sanitize-coverage=trace-pc | |
| @item -fsanitize-coverage=trace-pc | |
| Enable coverage-guided fuzzing code instrumentation. | |
| Inserts a call to @code{__sanitizer_cov_trace_pc} into every basic block. | |
| @opindex fsanitize-coverage=trace-cmp | |
| @opindex fno-sanitize-coverage=trace-cmp | |
| @item -fsanitize-coverage=trace-cmp | |
| Enable dataflow guided fuzzing code instrumentation. | |
| Inserts a call to @code{__sanitizer_cov_trace_cmp1}, | |
| @code{__sanitizer_cov_trace_cmp2}, @code{__sanitizer_cov_trace_cmp4} or | |
| @code{__sanitizer_cov_trace_cmp8} for integral comparison with both operands | |
| variable or @code{__sanitizer_cov_trace_const_cmp1}, | |
| @code{__sanitizer_cov_trace_const_cmp2}, | |
| @code{__sanitizer_cov_trace_const_cmp4} or | |
| @code{__sanitizer_cov_trace_const_cmp8} for integral comparison with one | |
| operand constant, @code{__sanitizer_cov_trace_cmpf} or | |
| @code{__sanitizer_cov_trace_cmpd} for float or double comparisons and | |
| @code{__sanitizer_cov_trace_switch} for switch statements. | |
| @opindex fcf-protection | |
| @item -fcf-protection=@r{[}full@r{|}branch@r{|}return@r{|}none@r{|}check@r{]} | |
| @itemx -fcf-protection | |
| Enable code instrumentation to increase | |
| program security by checking that target addresses of control-flow | |
| transfer instructions (such as indirect function call, function return, | |
| indirect jump) are valid. This prevents diverting the flow of control | |
| to an unexpected target. This is intended to protect against such | |
| threats as Return-oriented Programming (ROP), and similarly | |
| call/jmp-oriented programming (COP/JOP). | |
| The @option{-fcf-protection=} keywords are interpreted as follows. | |
| The value @code{branch} tells the compiler to implement checking of | |
| validity of control-flow transfer at the point of indirect branch | |
| instructions, i.e.@: call/jmp instructions. | |
| The value @code{return} implements checking of validity at the point of | |
| returning from a function. | |
| The value @code{full} is an alias for specifying both | |
| @code{branch} and @code{return}. | |
| The value @code{check} is used for the final link with link-time | |
| optimization (LTO). An error is issued if LTO object files are | |
| compiled with different @option{-fcf-protection} values. The | |
| value @code{check} is ignored at the compile time. | |
| The value @code{none} turns off instrumentation. | |
| @option{-fcf-protection} is an alias for @option{-fcf-protection=full}. | |
| To override a previous @option{-fcf-protection} option on the command | |
| line, add @option{-fcf-protection=none} and then | |
| @option{-fcf-protection=@var{kind}}. | |
| The macro @code{__CET__} is defined when @option{-fcf-protection} is | |
| used. The first bit of @code{__CET__} is set to 1 for the value | |
| @code{branch} and the second bit of @code{__CET__} is set to 1 for | |
| the @code{return}. | |
| You can also use the @code{nocf_check} attribute to identify | |
| which functions and calls should be skipped from instrumentation | |
| (@pxref{Common Attributes}). | |
| Currently the x86 GNU/Linux target provides an implementation based | |
| on Intel Control-flow Enforcement Technology (CET) which works for | |
| i686 processor or newer. | |
| @opindex fharden-compares | |
| @opindex fno-harden-compares | |
| @item -fharden-compares | |
| For every logical test that survives gimple optimizations and is | |
| @emph{not} the condition in a conditional branch (for example, | |
| conditions tested for conditional moves, or to store in boolean | |
| variables), emit extra code to compute and verify the reversed | |
| condition, and to call @code{__builtin_trap} if the results do not | |
| match. Use with @samp{-fharden-conditional-branches} to cover all | |
| conditionals. | |
| @opindex fharden-conditional-branches | |
| @opindex fno-harden-conditional-branches | |
| @item -fharden-conditional-branches | |
| For every non-vectorized conditional branch that survives gimple | |
| optimizations, emit extra code to compute and verify the reversed | |
| condition, and to call @code{__builtin_trap} if the result is | |
| unexpected. Use with @samp{-fharden-compares} to cover all | |
| conditionals. | |
| @opindex fharden-control-flow-redundancy | |
| @opindex fno-harden-control-flow-redundancy | |
| @item -fharden-control-flow-redundancy | |
| Emit extra code to set booleans when entering basic blocks, and to | |
| verify and trap, at function exits, when the booleans do not form an | |
| execution path that is compatible with the control flow graph. | |
| Verification takes place before returns, before mandatory tail calls | |
| (see below) and, optionally, before escaping exceptions with | |
| @option{-fhardcfr-check-exceptions}, before returning calls with | |
| @option{-fhardcfr-check-returning-calls}, and before noreturn calls with | |
| @option{-fhardcfr-check-noreturn-calls}). | |
| Tail call optimization takes place too late to affect control flow | |
| redundancy, but calls annotated as mandatory tail calls by language | |
| front-ends, and any calls marked early enough as potential tail calls | |
| would also have verification issued before the call, but these | |
| possibilities are merely theoretical, as these conditions can only be | |
| met when using custom compiler plugins. | |
| @opindex fhardcfr-skip-leaf | |
| @opindex fno-hardcfr-skip-leaf | |
| @item -fhardcfr-skip-leaf | |
| Disable @option{-fharden-control-flow-redundancy} in leaf functions. | |
| @opindex fhardcfr-check-exceptions | |
| @opindex fno-hardcfr-check-exceptions | |
| @item -fhardcfr-check-exceptions | |
| When @option{-fharden-control-flow-redundancy} is active, check the | |
| recorded execution path against the control flow graph at exception | |
| escape points, as if the function body was wrapped with a cleanup | |
| handler that performed the check and reraised. This option is enabled | |
| by default; use @option{-fno-hardcfr-check-exceptions} to disable it. | |
| @opindex fhardcfr-check-returning-calls | |
| @opindex fno-hardcfr-check-returning-calls | |
| @item -fhardcfr-check-returning-calls | |
| When @option{-fharden-control-flow-redundancy} is active, check the | |
| recorded execution path against the control flow graph before any | |
| function call immediately followed by a return of its result, if any, so | |
| as to not prevent tail-call optimization, whether or not it is | |
| ultimately optimized to a tail call. | |
| This option is enabled by default whenever sibling call optimizations | |
| are enabled (see @option{-foptimize-sibling-calls}), but it can be | |
| enabled (or disabled, using its negated form) explicitly, regardless of | |
| the optimizations. | |
| @opindex fhardcfr-check-noreturn-calls | |
| @item -fhardcfr-check-noreturn-calls=@r{[}always@r{|}no-xthrow@r{|}nothrow@r{|}never@r{]} | |
| When @option{-fharden-control-flow-redundancy} is active, check the | |
| recorded execution path against the control flow graph before | |
| @code{noreturn} calls, either all of them (@option{always}), those that | |
| aren't expected to return control to the caller through an exception | |
| (@option{no-xthrow}, the default), those that may not return control to | |
| the caller through an exception either (@option{nothrow}), or none of | |
| them (@option{never}). | |
| Checking before a @code{noreturn} function that may return control to | |
| the caller through an exception may cause checking to be performed more | |
| than once, if the exception is caught in the caller, whether by a | |
| handler or a cleanup. When @option{-fhardcfr-check-exceptions} is also | |
| enabled, the compiler will avoid associating a @code{noreturn} call with | |
| the implicitly-added cleanup handler, since it would be redundant with | |
| the check performed before the call, but other handlers or cleanups in | |
| the function, if activated, will modify the recorded execution path and | |
| check it again when another checkpoint is hit. The checkpoint may even | |
| be another @code{noreturn} call, so checking may end up performed | |
| multiple times. | |
| Various optimizers may cause calls to be marked as @code{noreturn} | |
| and/or @code{nothrow}, even in the absence of the corresponding | |
| attributes, which may affect the placement of checks before calls, as | |
| well as the addition of implicit cleanup handlers for them. This | |
| unpredictability, and the fact that raising and reraising exceptions | |
| frequently amounts to implicitly calling @code{noreturn} functions, have | |
| made @option{no-xthrow} the default setting for this option: it excludes | |
| from the @code{noreturn} treatment only internal functions used to | |
| (re)raise exceptions, that are not affected by these optimizations. | |
| @opindex fhardened | |
| @opindex fno-hardened | |
| @item -fhardened | |
| Enable a set of flags for C and C++ that improve the security of the | |
| generated code without affecting its ABI. The precise flags enabled | |
| may change between major releases of GCC, but are currently: | |
| @c Keep this in sync with print_help_hardened! | |
| @gccoptlist{ | |
| -D_FORTIFY_SOURCE=3 | |
| -D_GLIBCXX_ASSERTIONS | |
| -ftrivial-auto-var-init=zero | |
| -fPIE -pie -Wl,-z,relro,-z,now | |
| -fstack-protector-strong | |
| -fstack-clash-protection | |
| -fcf-protection=full @r{(x86 GNU/Linux only)} | |
| } | |
| The list of options enabled by @option{-fhardened} can be generated using | |
| the @option{--help=hardened} option. | |
| When the system glibc is older than 2.35, @option{-D_FORTIFY_SOURCE=2} | |
| is used instead. | |
| This option is intended to be used in production builds, not merely | |
| in debug builds. | |
| Currently, @option{-fhardened} is only supported on GNU/Linux targets. | |
| @option{-fhardened} only enables a particular option if it wasn't | |
| already specified anywhere on the command line. For instance, | |
| @option{-fhardened} @option{-fstack-protector} will only enable | |
| @option{-fstack-protector}, but not @option{-fstack-protector-strong}. | |
| @opindex fstack-protector | |
| @opindex fno-stack-protector | |
| @item -fstack-protector | |
| Emit extra code to check for buffer overflows, such as stack smashing | |
| attacks. This is done by adding a guard variable to functions with | |
| vulnerable objects. This includes functions that call @code{alloca}, and | |
| functions with buffers larger than or equal to 8 bytes. The guards are | |
| initialized when a function is entered and then checked when the function | |
| exits. If a guard check fails, an error message is printed and the program | |
| exits. Only variables that are actually allocated on the stack are | |
| considered, optimized away variables or variables allocated in registers | |
| don't count. | |
| @opindex fstack-protector-all | |
| @item -fstack-protector-all | |
| Like @option{-fstack-protector} except that all functions are protected. | |
| @opindex fstack-protector-strong | |
| @item -fstack-protector-strong | |
| Like @option{-fstack-protector} but includes additional functions to | |
| be protected --- those that have local array definitions, or have | |
| references to local frame addresses. Only variables that are actually | |
| allocated on the stack are considered, optimized away variables or variables | |
| allocated in registers don't count. | |
| @opindex fstack-protector-explicit | |
| @item -fstack-protector-explicit | |
| Like @option{-fstack-protector} but only protects those functions which | |
| have the @code{stack_protect} attribute. | |
| @opindex fstack-check | |
| @opindex fno-stack-check | |
| @item -fstack-check | |
| Generate code to verify that you do not go beyond the boundary of the | |
| stack. You should specify this flag if you are running in an | |
| environment with multiple threads, but you only rarely need to specify it in | |
| a single-threaded environment since stack overflow is automatically | |
| detected on nearly all systems if there is only one stack. | |
| Note that this switch does not actually cause checking to be done; the | |
| operating system or the language runtime must do that. The switch causes | |
| generation of code to ensure that they see the stack being extended. | |
| You can additionally specify a string parameter: @samp{no} means no | |
| checking, @samp{generic} means force the use of old-style checking, | |
| @samp{specific} means use the best checking method and is equivalent | |
| to bare @option{-fstack-check}. | |
| Old-style checking is a generic mechanism that requires no specific | |
| target support in the compiler but comes with the following drawbacks: | |
| @enumerate | |
| @item | |
| Modified allocation strategy for large objects: they are always | |
| allocated dynamically if their size exceeds a fixed threshold. Note this | |
| may change the semantics of some code. | |
| @item | |
| Fixed limit on the size of the static frame of functions: when it is | |
| topped by a particular function, stack checking is not reliable and | |
| a warning is issued by the compiler. | |
| @item | |
| Inefficiency: because of both the modified allocation strategy and the | |
| generic implementation, code performance is hampered. | |
| @end enumerate | |
| Note that old-style stack checking is also the fallback method for | |
| @samp{specific} if no target support has been added in the compiler. | |
| @samp{-fstack-check=} is designed for Ada's needs to detect infinite recursion | |
| and stack overflows. @samp{specific} is an excellent choice when compiling | |
| Ada code. It is not generally sufficient to protect against stack-clash | |
| attacks. To protect against those you want @samp{-fstack-clash-protection}. | |
| @opindex fstack-clash-protection | |
| @opindex fno-stack-clash-protection | |
| @item -fstack-clash-protection | |
| Generate code to prevent stack clash style attacks. When this option is | |
| enabled, the compiler will only allocate one page of stack space at a time | |
| and each page is accessed immediately after allocation. Thus, it prevents | |
| allocations from jumping over any stack guard page provided by the | |
| operating system. | |
| Most targets do not fully support stack clash protection. However, on | |
| those targets @option{-fstack-clash-protection} will protect dynamic stack | |
| allocations. @option{-fstack-clash-protection} may also provide limited | |
| protection for static stack allocations if the target supports | |
| @option{-fstack-check=specific}. | |
| @opindex fstack-limit-register | |
| @opindex fstack-limit-symbol | |
| @opindex fno-stack-limit | |
| @item -fstack-limit-register=@var{reg} | |
| @itemx -fstack-limit-symbol=@var{sym} | |
| @itemx -fno-stack-limit | |
| Generate code to ensure that the stack does not grow beyond a certain value, | |
| either the value of a register or the address of a symbol. If a larger | |
| stack is required, a signal is raised at run time. For most targets, | |
| the signal is raised before the stack overruns the boundary, so | |
| it is possible to catch the signal without taking special precautions. | |
| For instance, if the stack starts at absolute address @samp{0x80000000} | |
| and grows downwards, you can use the flags | |
| @option{-fstack-limit-symbol=__stack_limit} and | |
| @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit | |
| of 128KB@. Note that this may only work with the GNU linker. | |
| You can locally override stack limit checking by using the | |
| @code{no_stack_limit} function attribute (@pxref{Common Attributes}). | |
| @opindex fsplit-stack | |
| @opindex fno-split-stack | |
| @item -fsplit-stack | |
| Generate code to automatically split the stack before it overflows. | |
| The resulting program has a discontiguous stack which can only | |
| overflow if the program is unable to allocate any more memory. This | |
| is most useful when running threaded programs, as it is no longer | |
| necessary to calculate a good stack size to use for each thread. This | |
| is currently only implemented for the x86 targets running | |
| GNU/Linux. | |
| When code compiled with @option{-fsplit-stack} calls code compiled | |
| without @option{-fsplit-stack}, there may not be much stack space | |
| available for the latter code to run. If compiling all code, | |
| including library code, with @option{-fsplit-stack} is not an option, | |
| then the linker can fix up these calls so that the code compiled | |
| without @option{-fsplit-stack} always has a large stack. Support for | |
| this is implemented in the gold linker in GNU Binutils release 2.21 | |
| and later. | |
| @opindex fstrub=disable | |
| @item -fstrub=disable | |
| Disable stack scrubbing entirely, ignoring any @code{strub} attributes. | |
| @xref{Common Attributes}. | |
| @opindex fstrub=strict | |
| @item -fstrub=strict | |
| Functions default to @code{strub} mode @code{disabled}, and apply | |
| @option{strict}ly the restriction that only functions associated with | |
| @code{strub}-@code{callable} modes (@code{at-calls}, @code{callable} and | |
| @code{always_inline} @code{internal}) are @code{callable} by functions | |
| with @code{strub}-enabled modes (@code{at-calls} and @code{internal}). | |
| @opindex fstrub=relaxed | |
| @item -fstrub=relaxed | |
| Restore the default stack scrub (@code{strub}) setting, namely, | |
| @code{strub} is only enabled as required by @code{strub} attributes | |
| associated with function and data types. @code{Relaxed} means that | |
| strub contexts are only prevented from calling functions explicitly | |
| associated with @code{strub} mode @code{disabled}. This option is only | |
| useful to override other @option{-fstrub=*} options that precede it in | |
| the command line. | |
| @opindex fstrub=at-calls | |
| @item -fstrub=at-calls | |
| Enable @code{at-calls} @code{strub} mode where viable. The primary use | |
| of this option is for testing. It exercises the @code{strub} machinery | |
| in scenarios strictly local to a translation unit. This @code{strub} | |
| mode modifies function interfaces, so any function that is visible to | |
| other translation units, or that has its address taken, will @emph{not} | |
| be affected by this option. Optimization options may also affect | |
| viability. See the @code{strub} attribute documentation for details on | |
| viability and eligibility requirements. | |
| @opindex fstrub=internal | |
| @item -fstrub=internal | |
| Enable @code{internal} @code{strub} mode where viable. The primary use | |
| of this option is for testing. This option is intended to exercise | |
| thoroughly parts of the @code{strub} machinery that implement the less | |
| efficient, but interface-preserving @code{strub} mode. Functions that | |
| would not be affected by this option are quite uncommon. | |
| @opindex fstrub=all | |
| @item -fstrub=all | |
| Enable some @code{strub} mode where viable. When both strub modes are | |
| viable, @code{at-calls} is preferred. @option{-fdump-ipa-strubm} adds | |
| function attributes that tell which mode was selected for each function. | |
| The primary use of this option is for testing, to exercise thoroughly | |
| the @code{strub} machinery. | |
| @opindex fvtable-verify | |
| @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} | |
| This option is only available when compiling C++ code. | |
| It turns on (or off, if using @option{-fvtable-verify=none}) the security | |
| feature that verifies at run time, for every virtual call, that | |
| the vtable pointer through which the call is made is valid for the type of | |
| the object, and has not been corrupted or overwritten. If an invalid vtable | |
| pointer is detected at run time, an error is reported and execution of the | |
| program is immediately halted. | |
| This option causes run-time data structures to be built at program startup, | |
| which are used for verifying the vtable pointers. | |
| The options @samp{std} and @samp{preinit} | |
| control the timing of when these data structures are built. In both cases the | |
| data structures are built before execution reaches @code{main}. Using | |
| @option{-fvtable-verify=std} causes the data structures to be built after | |
| shared libraries have been loaded and initialized. | |
| @option{-fvtable-verify=preinit} causes them to be built before shared | |
| libraries have been loaded and initialized. | |
| If this option appears multiple times in the command line with different | |
| values specified, @samp{none} takes highest priority over both @samp{std} and | |
| @samp{preinit}; @samp{preinit} takes priority over @samp{std}. | |
| @opindex fvtv-debug | |
| @opindex fno-vtv-debug | |
| @item -fvtv-debug | |
| When used in conjunction with @option{-fvtable-verify=std} or | |
| @option{-fvtable-verify=preinit}, causes debug versions of the | |
| runtime functions for the vtable verification feature to be called. | |
| This flag also causes the compiler to log information about which | |
| vtable pointers it finds for each class. | |
| This information is written to a file named @file{vtv_set_ptr_data.log} | |
| in the directory named by the environment variable @env{VTV_LOGS_DIR} | |
| if that is defined or the current working directory otherwise. | |
| Note: This feature @emph{appends} data to the log file. If you want a fresh log | |
| file, be sure to delete any existing one. | |
| @opindex fvtv-counts | |
| @opindex fno-vtv-counts | |
| @item -fvtv-counts | |
| This is a debugging flag. When used in conjunction with | |
| @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this | |
| causes the compiler to keep track of the total number of virtual calls | |
| it encounters and the number of verifications it inserts. It also | |
| counts the number of calls to certain run-time library functions | |
| that it inserts and logs this information for each compilation unit. | |
| The compiler writes this information to a file named | |
| @file{vtv_count_data.log} in the directory named by the environment | |
| variable @env{VTV_LOGS_DIR} if that is defined or the current working | |
| directory otherwise. It also counts the size of the vtable pointer sets | |
| for each class, and writes this information to @file{vtv_class_set_sizes.log} | |
| in the same directory. | |
| Note: This feature @emph{appends} data to the log files. To get fresh log | |
| files, be sure to delete any existing ones. | |
| @opindex finstrument-functions | |
| @opindex fno-instrument-functions | |
| @item -finstrument-functions | |
| Generate instrumentation calls for entry and exit to functions. Just | |
| after function entry and just before function exit, the following | |
| profiling functions are called with the address of the current | |
| function and its call site. (On some platforms, | |
| @code{__builtin_return_address} does not work beyond the current | |
| function, so the call site information may not be available to the | |
| profiling functions otherwise.) | |
| @smallexample | |
| void __cyg_profile_func_enter (void *this_fn, | |
| void *call_site); | |
| void __cyg_profile_func_exit (void *this_fn, | |
| void *call_site); | |
| @end smallexample | |
| The first argument is the address of the start of the current function, | |
| which may be looked up exactly in the symbol table. | |
| This instrumentation is also done for functions expanded inline in other | |
| functions. The profiling calls indicate where, conceptually, the | |
| inline function is entered and exited. This means that addressable | |
| versions of such functions must be available. If all your uses of a | |
| function are expanded inline, this may mean an additional expansion of | |
| code size. If you use @code{extern inline} in your C code, an | |
| addressable version of such functions must be provided. (This is | |
| normally the case anyway, but if you get lucky and the optimizer always | |
| expands the functions inline, you might have gotten away without | |
| providing static copies.) | |
| A function may be given the attribute @code{no_instrument_function}, in | |
| which case this instrumentation is not done. This can be used, for | |
| example, for the profiling functions listed above, high-priority | |
| interrupt routines, and any functions from which the profiling functions | |
| cannot safely be called (perhaps signal handlers, if the profiling | |
| routines generate output or allocate memory). | |
| @xref{Common Attributes}. | |
| @opindex finstrument-functions-once | |
| @opindex fno-instrument-functions-once | |
| @item -finstrument-functions-once | |
| This is similar to @option{-finstrument-functions}, but the profiling | |
| functions are called only once per instrumented function, i.e. the first | |
| profiling function is called after the first entry into the instrumented | |
| function and the second profiling function is called before the exit | |
| corresponding to this first entry. | |
| The definition of @code{once} for the purpose of this option is a little | |
| vague because the implementation is not protected against data races. | |
| As a result, the implementation only guarantees that the profiling | |
| functions are called at @emph{least} once per process and at @emph{most} | |
| once per thread, but the calls are always paired, that is to say, if a | |
| thread calls the first function, then it will call the second function, | |
| unless it never reaches the exit of the instrumented function. | |
| @opindex finstrument-functions-exclude-file-list | |
| @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} | |
| Set the list of functions that are excluded from instrumentation (see | |
| the description of @option{-finstrument-functions}). If the file that | |
| contains a function definition matches with one of @var{file}, then | |
| that function is not instrumented. The match is done on substrings: | |
| if the @var{file} parameter is a substring of the file name, it is | |
| considered to be a match. | |
| For example: | |
| @smallexample | |
| -finstrument-functions-exclude-file-list=/bits/stl,include/sys | |
| @end smallexample | |
| @noindent | |
| excludes any inline function defined in files whose pathnames | |
| contain @file{/bits/stl} or @file{include/sys}. | |
| If, for some reason, you want to include letter @samp{,} in one of | |
| @var{sym}, write @samp{\,}. For example, | |
| @option{-finstrument-functions-exclude-file-list='\,\,tmp'} | |
| (note the single quote surrounding the option). | |
| @opindex finstrument-functions-exclude-function-list | |
| @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} | |
| This is similar to @option{-finstrument-functions-exclude-file-list}, | |
| but this option sets the list of function names to be excluded from | |
| instrumentation. The function name to be matched is its user-visible | |
| name, such as @code{vector<int> blah(const vector<int> &)}, not the | |
| internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}). The | |
| match is done on substrings: if the @var{sym} parameter is a substring | |
| of the function name, it is considered to be a match. For C99 and C++ | |
| extended identifiers, the function name must be given in UTF-8, not | |
| using universal character names. | |
| @opindex fpatchable-function-entry | |
| @item -fpatchable-function-entry=@var{N}[,@var{M}] | |
| Generate @var{N} NOPs right at the beginning | |
| of each function, with the function entry point before the @var{M}th NOP. | |
| If @var{M} is omitted, it defaults to @code{0} so the | |
| function entry points to the address just at the first NOP. | |
| The NOP instructions reserve extra space which can be used to patch in | |
| any desired instrumentation at run time, provided that the code segment | |
| is writable. The amount of space is controllable indirectly via | |
| the number of NOPs; the NOP instruction used corresponds to the instruction | |
| emitted by the internal GCC back-end interface @code{gen_nop}. This behavior | |
| is target-specific and may also depend on the architecture variant and/or | |
| other compilation options. | |
| For run-time identification, the starting addresses of these areas, | |
| which correspond to their respective function entries minus @var{M}, | |
| are additionally collected in the @code{__patchable_function_entries} | |
| section of the resulting binary. | |
| Note that the value of @code{__attribute__ ((patchable_function_entry | |
| (N,M)))} takes precedence over command-line option | |
| @option{-fpatchable-function-entry=N,M}. This can be used to increase | |
| the area size or to remove it completely on a single function. | |
| If @code{N=0}, no pad location is recorded. | |
| The NOP instructions are inserted at---and maybe before, depending on | |
| @var{M}---the function entry address, even before the prologue. On | |
| PowerPC with the ELFv2 ABI, for a function with dual entry points, | |
| the local entry point is this function entry address by default. See | |
| the @option{-msplit-patch-nops} option to change this. | |
| The maximum value of @var{N} and @var{M} is 65535. On PowerPC with the | |
| ELFv2 ABI, for a function with dual entry points, the supported values | |
| for @var{M} are 0, 2, 6 and 14 when not using @option{-msplit-patch-nops}. | |
| @end table | |
| @node Preprocessor Options | |
| @section Options Controlling the Preprocessor | |
| @cindex preprocessor options | |
| @cindex options, preprocessor | |
| These options control the C preprocessor, which is run on each C source | |
| file before actual compilation. | |
| If you use the @option{-E} option, nothing is done except preprocessing. | |
| Some of these options make sense only together with @option{-E} because | |
| they cause the preprocessor output to be unsuitable for actual | |
| compilation. | |
| In addition to the options listed here, there are a number of options | |
| to control search paths for include files documented in | |
| @ref{Directory Options}. | |
| Options to control preprocessor diagnostics are listed in | |
| @ref{Warning Options}. | |
| @table @gcctabopt | |
| @include cppopts.texi | |
| @opindex Wp | |
| @item -Wp,@var{option} | |
| You can use @option{-Wp,@var{option}} to bypass the compiler driver | |
| and pass @var{option} directly through to the preprocessor. If | |
| @var{option} contains commas, it is split into multiple options at the | |
| commas. However, many options are modified, translated or interpreted | |
| by the compiler driver before being passed to the preprocessor, and | |
| @option{-Wp} forcibly bypasses this phase. The preprocessor's direct | |
| interface is undocumented and subject to change, so whenever possible | |
| you should avoid using @option{-Wp} and let the driver handle the | |
| options instead. | |
| @opindex Xpreprocessor | |
| @item -Xpreprocessor @var{option} | |
| Pass @var{option} as an option to the preprocessor. You can use this to | |
| supply system-specific preprocessor options that GCC does not | |
| recognize. | |
| If you want to pass an option that takes an argument, you must use | |
| @option{-Xpreprocessor} twice, once for the option and once for the argument. | |
| @opindex no-integrated-cpp | |
| @item -no-integrated-cpp | |
| @itemx --no-integrated-cpp | |
| Perform preprocessing as a separate pass before compilation. | |
| By default, GCC performs preprocessing as an integrated part of | |
| input tokenization and parsing. | |
| If this option is provided, the appropriate language front end | |
| (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++, | |
| and Objective-C, respectively) is instead invoked twice, | |
| once for preprocessing only and once for actual compilation | |
| of the preprocessed input. | |
| This option may be useful in conjunction with the @option{-B} or | |
| @option{-wrapper} options to specify an alternate preprocessor or | |
| perform additional processing of the program source between | |
| normal preprocessing and compilation. | |
| @end table | |
| @node Assembler Options | |
| @section Passing Options to the Assembler | |
| @c prevent bad page break with this line | |
| You can pass options to the assembler. | |
| @table @gcctabopt | |
| @opindex Wa | |
| @item -Wa,@var{option} | |
| Pass @var{option} as an option to the assembler. If @var{option} | |
| contains commas, it is split into multiple options at the commas. | |
| @opindex Xassembler | |
| @opindex for-assembler | |
| @item -Xassembler @var{option} | |
| @itemx --for-assembler=@var{option} | |
| @itemx --for-assembler @var{option} | |
| Pass @var{option} as an option to the assembler. You can use this to | |
| supply system-specific assembler options that GCC does not | |
| recognize. | |
| If you want to pass an option that takes an argument, you must use | |
| @option{-Xassembler} twice, once for the option and once for the argument. | |
| @end table | |
| @node Link Options | |
| @section Options for Linking | |
| @cindex link options | |
| @cindex options, linking | |
| These options come into play when the compiler links object files into | |
| an executable output file. They are meaningless if the compiler is | |
| not doing a link step. | |
| @table @gcctabopt | |
| @cindex file names | |
| @item @var{object-file-name} | |
| A file name that does not end in a special recognized suffix is | |
| considered to name an object file or library. (Object files are | |
| distinguished from libraries by the linker according to the file | |
| contents.) If linking is done, these object files are used as input | |
| to the linker. | |
| @opindex c | |
| @opindex S | |
| @opindex E | |
| @item -c | |
| @itemx -S | |
| @itemx -E | |
| If any of these options is used, then the linker is not run, and | |
| object file names should not be used as arguments. @xref{Overall | |
| Options}. | |
| @opindex flink-libatomic | |
| @opindex fno-link-libatomic | |
| @item -flink-libatomic | |
| Enable linking of libatomic if it's supported by target, and is enabled by | |
| default. The negative form @option{-fno-link-libatomic} can be used to | |
| explicitly disable linking of libatomic. | |
| @opindex flinker-output | |
| @item -flinker-output=@var{type} | |
| This option controls code generation of the link-time optimizer. By | |
| default the linker output is automatically determined by the linker | |
| plugin. For debugging the compiler and if incremental linking with a | |
| non-LTO object file is desired, it may be useful to control the type | |
| manually. | |
| If @var{type} is @samp{exec}, code generation produces a static | |
| binary. In this case @option{-fpic} and @option{-fpie} are both | |
| disabled. | |
| If @var{type} is @samp{dyn}, code generation produces a shared | |
| library. In this case @option{-fpic} or @option{-fPIC} is preserved, | |
| but not enabled automatically. This allows to build shared libraries | |
| without position-independent code on architectures where this is | |
| possible, i.e.@: on x86. | |
| If @var{type} is @samp{pie}, code generation produces an @option{-fpie} | |
| executable. This results in similar optimizations as @samp{exec} | |
| except that @option{-fpie} is not disabled if specified at compilation | |
| time. | |
| If @var{type} is @samp{rel}, the compiler assumes that incremental linking is | |
| done. The sections containing intermediate code for link-time optimization are | |
| merged, pre-optimized, and output to the resulting object file. In addition, if | |
| @option{-ffat-lto-objects} is specified, binary code is produced for future | |
| non-LTO linking. The object file produced by incremental linking is smaller | |
| than a static library produced from the same object files. At link time the | |
| result of incremental linking also loads faster than a static | |
| library assuming that the majority of objects in the library are used. | |
| Finally @samp{nolto-rel} configures the compiler for incremental linking where | |
| code generation is forced, a final binary is produced, and the intermediate | |
| code for later link-time optimization is stripped. When multiple object files | |
| are linked together the resulting code is better optimized than with | |
| link-time optimizations disabled (for example, cross-module inlining | |
| happens), but most of the benefits of whole-program optimizations are lost. | |
| During the incremental link (by @option{-r}) the linker plugin defaults to | |
| @option{rel}. GNU Binutils 2.44 or later is needed to incrementally link | |
| LTO objects and non-LTO objects into a single mixed object file. If any | |
| of the object files in an incremental link cannot be used for link-time | |
| optimization, the linker plugin issues a warning and uses @samp{nolto-rel}. | |
| To maintain whole-program optimization, link such objects into a static | |
| library instead. | |
| @opindex fuse-ld=bfd | |
| @opindex fno-use-ld=bfd | |
| @item -fuse-ld=bfd | |
| Use the @command{bfd} linker instead of the default linker. | |
| @opindex fuse-ld=gold | |
| @opindex fno-use-ld=gold | |
| @item -fuse-ld=gold | |
| Use the @command{gold} linker instead of the default linker. | |
| @opindex fuse-ld=lld | |
| @opindex fno-use-ld=lld | |
| @item -fuse-ld=lld | |
| Use the LLVM @command{lld} linker instead of the default linker. | |
| @opindex fuse-ld=mold | |
| @opindex fno-use-ld=mold | |
| @item -fuse-ld=mold | |
| Use the Modern Linker (@command{mold}) instead of the default linker. | |
| @opindex fuse-ld=wild | |
| @opindex fno-use-ld=wild | |
| @item -fuse-ld=wild | |
| Use the Wild linker (@command{wild}) instead of the default linker. | |
| @cindex Libraries | |
| @opindex l | |
| @item -l@var{library} | |
| @itemx -l @var{library} | |
| Search the library named @var{library} when linking. (The second | |
| alternative with the library as a separate argument is only for | |
| POSIX compliance and is not recommended.) | |
| The @option{-l} option is passed directly to the linker by GCC. Refer | |
| to your linker documentation for exact details. The general | |
| description below applies to the GNU linker. | |
| The linker searches a standard list of directories for the library. | |
| The directories searched include several standard system directories | |
| plus any that you specify with @option{-L}. | |
| Static libraries are archives of object files, and have file names | |
| like @file{lib@var{library}.a}. Some targets also support shared | |
| libraries, which typically have names like @file{lib@var{library}.so}. | |
| If both static and shared libraries are found, the linker gives | |
| preference to linking with the shared library unless the | |
| @option{-static} option is used. | |
| It makes a difference where in the command you write this option; the | |
| linker searches and processes libraries and object files in the order they | |
| are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z} | |
| after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers | |
| to functions in @samp{z}, those functions may not be loaded. | |
| @opindex lobjc | |
| @item -lobjc | |
| You need this special case of the @option{-l} option in order to | |
| link an Objective-C or Objective-C++ program. | |
| @opindex nostartfiles | |
| @item -nostartfiles | |
| Do not use the standard system startup files when linking. | |
| The standard system libraries are used normally, unless @option{-nostdlib}, | |
| @option{-nolibc}, or @option{-nodefaultlibs} is used. | |
| @opindex nodefaultlibs | |
| @item -nodefaultlibs | |
| Do not use the standard system libraries when linking. | |
| Only the libraries you specify are passed to the linker, and options | |
| specifying linkage of the system libraries, such as @option{-static-libgcc} | |
| or @option{-shared-libgcc}, are ignored. | |
| The standard startup files are used normally, unless @option{-nostartfiles} | |
| is used. | |
| The compiler may generate calls to @code{memcmp}, | |
| @code{memset}, @code{memcpy} and @code{memmove}. | |
| These entries are usually resolved by entries in | |
| libc. These entry points should be supplied through some other | |
| mechanism when this option is specified. | |
| @opindex nolibc | |
| @item -nolibc | |
| Do not use the C library or system libraries tightly coupled with it when | |
| linking. Still link with the startup files, @file{libgcc} or toolchain | |
| provided language support libraries such as @file{libgnat}, @file{libgfortran} | |
| or @file{libstdc++} unless options preventing their inclusion are used as | |
| well. This typically removes @option{-lc} from the link command line, as well | |
| as system libraries that normally go with it and become meaningless when | |
| absence of a C library is assumed, for example @option{-lpthread} or | |
| @option{-lm} in some configurations. This is intended for bare-board | |
| targets when there is indeed no C library available. | |
| @opindex nostdlib | |
| @opindex no-standard-libraries | |
| @item -nostdlib | |
| @itemx --no-standard-libraries | |
| Do not use the standard system startup files or libraries when linking. | |
| No startup files and only the libraries you specify are passed to | |
| the linker, and options specifying linkage of the system libraries, such as | |
| @option{-static-libgcc} or @option{-shared-libgcc}, are ignored. | |
| The compiler may generate calls to @code{memcmp}, @code{memset}, | |
| @code{memcpy} and @code{memmove}. | |
| These entries are usually resolved by entries in | |
| libc. These entry points should be supplied through some other | |
| mechanism when this option is specified. | |
| @cindex @option{-lgcc}, use with @option{-nostdlib} | |
| @cindex @option{-nostdlib} and unresolved references | |
| @cindex unresolved references and @option{-nostdlib} | |
| @cindex @option{-lgcc}, use with @option{-nodefaultlibs} | |
| @cindex @option{-nodefaultlibs} and unresolved references | |
| @cindex unresolved references and @option{-nodefaultlibs} | |
| One of the standard libraries bypassed by @option{-nostdlib} and | |
| @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines | |
| which GCC uses to overcome shortcomings of particular machines, or special | |
| needs for some languages. | |
| (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler | |
| Collection (GCC) Internals}, | |
| for more discussion of @file{libgcc.a}.) | |
| In most cases, you need @file{libgcc.a} even when you want to avoid | |
| other standard libraries. In other words, when you specify @option{-nostdlib} | |
| or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well. | |
| This ensures that you have no unresolved references to internal GCC | |
| library subroutines. | |
| (An example of such an internal subroutine is @code{__main}, used to ensure C++ | |
| constructors are called; @pxref{Collect2,,@code{collect2}, gccint, | |
| GNU Compiler Collection (GCC) Internals}.) | |
| @opindex nostdlib++ | |
| @item -nostdlib++ | |
| Do not implicitly link with standard C++ libraries. | |
| @opindex e | |
| @opindex entry | |
| @item -e @var{entry} | |
| @itemx --entry=@var{entry} | |
| @itemx --entry @var{entry} | |
| Specify that the program entry point is @var{entry}. The argument is | |
| interpreted by the linker; the GNU linker accepts either a symbol name | |
| or an address. | |
| @opindex pie | |
| @item -pie | |
| @itemx --pie | |
| Produce a dynamically linked position independent executable on targets | |
| that support it. For predictable results, you must also specify the same | |
| set of options used for compilation (@option{-fpie}, @option{-fPIE}, | |
| or model suboptions) when you specify this linker option. | |
| @opindex no-pie | |
| @item -no-pie | |
| Don't produce a dynamically linked position independent executable. | |
| @opindex static-pie | |
| @item -static-pie | |
| @itemx --static-pie | |
| Produce a static position independent executable on targets that support | |
| it. A static position independent executable is similar to a static | |
| executable, but can be loaded at any address without a dynamic linker. | |
| For predictable results, you must also specify the same set of options | |
| used for compilation (@option{-fpie}, @option{-fPIE}, or model | |
| suboptions) when you specify this linker option. | |
| @opindex pthread | |
| @item -pthread | |
| Link with the POSIX threads library. This option is supported on | |
| GNU/Linux targets, most other Unix derivatives, and also on | |
| x86 Cygwin and MinGW targets. On some targets this option also sets | |
| flags for the preprocessor, so it should be used consistently for both | |
| compilation and linking. | |
| @opindex r | |
| @item -r | |
| Produce a relocatable object as output. This is also known as partial | |
| linking. | |
| @opindex rdynamic | |
| @item -rdynamic | |
| Pass the flag @option{-export-dynamic} to the ELF linker, on targets | |
| that support it. This instructs the linker to add all symbols, not | |
| only used ones, to the dynamic symbol table. This option is needed | |
| for some uses of @code{dlopen} or to allow obtaining backtraces | |
| from within a program. | |
| @opindex s | |
| @item -s | |
| Remove all symbol table and relocation information from the executable. | |
| @opindex static | |
| @item -static | |
| @itemx --static | |
| On systems that support dynamic linking, this overrides @option{-pie} | |
| and prevents linking with the shared libraries. On other systems, this | |
| option has no effect. | |
| @opindex shared | |
| @item -shared | |
| @itemx --shared | |
| Produce a shared object which can then be linked with other objects to | |
| form an executable. Not all systems support this option. For predictable | |
| results, you must also specify the same set of options used for compilation | |
| (@option{-fpic}, @option{-fPIC}, or model suboptions) when | |
| you specify this linker option.@footnote{On some systems, @samp{gcc -shared} | |
| needs to build supplementary stub code for constructors to work. On | |
| multi-libbed systems, @samp{gcc -shared} must select the correct support | |
| libraries to link against. Failing to supply the correct flags may lead | |
| to subtle defects. Supplying them in cases where they are not necessary | |
| is innocuous. @option{-shared} suppresses the addition of startup code | |
| to alter the floating-point environment as done with @option{-ffast-math}, | |
| @option{-Ofast} or @option{-funsafe-math-optimizations} on some targets.} | |
| @opindex shared-libgcc | |
| @opindex static-libgcc | |
| @item -shared-libgcc | |
| @itemx -static-libgcc | |
| On systems that provide @file{libgcc} as a shared library, these options | |
| force the use of either the shared or static version, respectively. | |
| If no shared version of @file{libgcc} was built when the compiler was | |
| configured, these options have no effect. | |
| There are several situations in which an application should use the | |
| shared @file{libgcc} instead of the static version. The most common | |
| of these is when the application wishes to throw and catch exceptions | |
| across different shared libraries. In that case, each of the libraries | |
| as well as the application itself should use the shared @file{libgcc}. | |
| Therefore, the G++ driver automatically adds @option{-shared-libgcc} | |
| whenever you build a shared library or a main executable, because C++ | |
| programs typically use exceptions, so this is the right thing to do. | |
| If, instead, you use the GCC driver to create shared libraries, you may | |
| find that they are not always linked with the shared @file{libgcc}. | |
| If GCC finds, at its configuration time, that you have a non-GNU linker | |
| or a GNU linker that does not support option @option{--eh-frame-hdr}, | |
| it links the shared version of @file{libgcc} into shared libraries | |
| by default. Otherwise, it takes advantage of the linker and optimizes | |
| away the linking with the shared version of @file{libgcc}, linking with | |
| the static version of libgcc by default. This allows exceptions to | |
| propagate through such shared libraries, without incurring relocation | |
| costs at library load time. | |
| However, if a library or main executable is supposed to throw or catch | |
| exceptions, you must link it using the G++ driver, or using the option | |
| @option{-shared-libgcc}, such that it is linked with the shared | |
| @file{libgcc}. | |
| @opindex static-libasan | |
| @item -static-libasan | |
| When the @option{-fsanitize=address} option is used to link a program, | |
| the GCC driver automatically links against @option{libasan}. If | |
| @file{libasan} is available as a shared library, and the @option{-static} | |
| option is not used, then this links against the shared version of | |
| @file{libasan}. The @option{-static-libasan} option directs the GCC | |
| driver to link @file{libasan} statically, without necessarily linking | |
| other libraries statically. | |
| @opindex static-libhwasan | |
| @item -static-libhwasan | |
| When the @option{-fsanitize=hwaddress} option is used to link a program, | |
| the GCC driver automatically links against @option{libhwasan}. If | |
| @file{libhwasan} is available as a shared library, and the @option{-static} | |
| option is not used, then this links against the shared version of | |
| @file{libhwasan}. The @option{-static-libhwasan} option directs the GCC | |
| driver to link @file{libhwasan} statically, without necessarily linking | |
| other libraries statically. | |
| @opindex static-liblsan | |
| @item -static-liblsan | |
| When the @option{-fsanitize=leak} option is used to link a program, | |
| the GCC driver automatically links against @option{liblsan}. If | |
| @file{liblsan} is available as a shared library, and the @option{-static} | |
| option is not used, then this links against the shared version of | |
| @file{liblsan}. The @option{-static-liblsan} option directs the GCC | |
| driver to link @file{liblsan} statically, without necessarily linking | |
| other libraries statically. | |
| @opindex static-libtsan | |
| @item -static-libtsan | |
| When the @option{-fsanitize=thread} option is used to link a program, | |
| the GCC driver automatically links against @option{libtsan}. If | |
| @file{libtsan} is available as a shared library, and the @option{-static} | |
| option is not used, then this links against the shared version of | |
| @file{libtsan}. The @option{-static-libtsan} option directs the GCC | |
| driver to link @file{libtsan} statically, without necessarily linking | |
| other libraries statically. | |
| @opindex static-libubsan | |
| @item -static-libubsan | |
| When the @option{-fsanitize=undefined} option is used to link a program, | |
| the GCC driver automatically links against @option{libubsan}. If | |
| @file{libubsan} is available as a shared library, and the @option{-static} | |
| option is not used, then this links against the shared version of | |
| @file{libubsan}. The @option{-static-libubsan} option directs the GCC | |
| driver to link @file{libubsan} statically, without necessarily linking | |
| other libraries statically. | |
| @opindex static-libstdc++ | |
| @item -static-libstdc++ | |
| When the @command{g++} program is used to link a C++ program, it | |
| normally automatically links against @option{libstdc++}. If | |
| @file{libstdc++} is available as a shared library, and the | |
| @option{-static} option is not used, then this links against the | |
| shared version of @file{libstdc++}. That is normally fine. However, it | |
| is sometimes useful to freeze the version of @file{libstdc++} used by | |
| the program without going all the way to a fully static link. The | |
| @option{-static-libstdc++} option directs the @command{g++} driver to | |
| link @file{libstdc++} statically, without necessarily linking other | |
| libraries statically. | |
| @opindex symbolic | |
| @item -symbolic | |
| @itemx --symbolic | |
| Bind references to global symbols when building a shared object. Warn | |
| about any unresolved references (unless overridden by the link editor | |
| option @option{-Xlinker -z -Xlinker defs}). Only a few systems support | |
| this option. | |
| @opindex T | |
| @cindex linker script | |
| @item -T @var{script} | |
| Use @var{script} as the linker script. This option is supported by most | |
| systems using the GNU linker. On some targets, such as bare-board | |
| targets without an operating system, the @option{-T} option may be required | |
| when linking to avoid references to undefined symbols. | |
| @opindex Xlinker | |
| @item -Xlinker @var{option} | |
| Pass @var{option} as an option to the linker. You can use this to | |
| supply system-specific linker options that GCC does not recognize. | |
| If you want to pass an option that takes a separate argument, you must use | |
| @option{-Xlinker} twice, once for the option and once for the argument. | |
| For example, to pass @option{-assert definitions}, you must write | |
| @option{-Xlinker -assert -Xlinker definitions}. It does not work to write | |
| @option{-Xlinker "-assert definitions"}, because this passes the entire | |
| string as a single argument, which is not what the linker expects. | |
| When using the GNU linker, it is usually more convenient to pass | |
| arguments to linker options using the @option{@var{option}=@var{value}} | |
| syntax than as separate arguments. For example, you can specify | |
| @option{-Xlinker -Map=output.map} rather than | |
| @option{-Xlinker -Map -Xlinker output.map}. Other linkers may not support | |
| this syntax for command-line options. | |
| @opindex Wl | |
| @opindex for-linker | |
| @item -Wl,@var{option} | |
| @itemx --for-linker=@var{option} | |
| @itemx --for-linker @var{option} | |
| Pass @var{option} as an option to the linker. If @var{option} contains | |
| commas, it is split into multiple options at the commas. You can use this | |
| syntax to pass an argument to the option. | |
| For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the | |
| linker. When using the GNU linker, you can also get the same effect with | |
| @option{-Wl,-Map=output.map}. | |
| @opindex u | |
| @opindex force-link | |
| @item -u @var{symbol} | |
| @itemx --force-link=@var{symbol} | |
| @itemx --force-link @var{symbol} | |
| Pretend the symbol @var{symbol} is undefined, to force linking of | |
| library modules to define it. You can use @option{-u} multiple times with | |
| different symbols to force loading of additional library modules. | |
| @opindex Tbss | |
| @opindex Tdata | |
| @opindex Ttext | |
| @opindex N | |
| @opindex n | |
| @opindex t | |
| @opindex Z | |
| @opindex z | |
| @item -Tbss=@var{addr} | |
| @itemx -Tdata=@var{addr} | |
| @itemx -Ttext=@var{addr} | |
| @itemx -N | |
| @itemx -n | |
| @itemx -t | |
| @itemx -Z | |
| @itemx -z @var{keyword} | |
| These options are passed through to the linker without interpretation by GCC. | |
| Refer to your linker documentation for the meanings of these options. | |
| @end table | |
| @node Directory Options | |
| @section Options for Directory Search | |
| @cindex directory options | |
| @cindex options, directory search | |
| @cindex search path | |
| These options specify directories to search for header files, for | |
| libraries and for parts of the compiler: | |
| @table @gcctabopt | |
| @include cppdiropts.texi | |
| @opindex iplugindir= | |
| @item -iplugindir=@var{dir} | |
| Set the directory to search for plugins that are passed | |
| by @option{-fplugin=@var{name}} instead of | |
| @option{-fplugin=@var{path}/@var{name}.so}. This option is not meant | |
| to be used by the user, but only passed by the driver. | |
| @opindex L | |
| @opindex library-directory | |
| @item -L@var{dir} | |
| @itemx --library-directory=@var{dir} | |
| @itemx --library-directory @var{dir} | |
| Add directory @var{dir} to the list of directories to be searched | |
| for @option{-l}. | |
| @opindex B | |
| @opindex prefix | |
| @item -B@var{prefix} | |
| @itemx --prefix=@var{prefix} | |
| @itemx --prefix @var{prefix} | |
| This option specifies where to find the executables, libraries, | |
| include files, and data files of the compiler itself. | |
| The compiler driver program runs one or more of the subprograms | |
| @command{cpp}, @command{cc1}, @command{as} and @command{ld}. It tries | |
| @var{prefix} as a prefix for each program it tries to run, both with and | |
| without @samp{@var{machine}/@var{version}/} for the corresponding target | |
| machine and compiler version. | |
| For each subprogram to be run, the compiler driver first tries the | |
| @option{-B} prefix, if any. If that name is not found, or if @option{-B} | |
| is not specified, the driver tries two standard prefixes, | |
| @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of | |
| those results in a file name that is found, the unmodified program | |
| name is searched for using the directories specified in your | |
| @env{PATH} environment variable. | |
| The compiler checks to see if the path provided by @option{-B} | |
| refers to a directory, and if necessary it adds a directory | |
| separator character at the end of the path. | |
| @option{-B} prefixes that effectively specify directory names also apply | |
| to libraries in the linker, because the compiler translates these | |
| options into @option{-L} options for the linker. They also apply to | |
| include files in the preprocessor, because the compiler translates these | |
| options into @option{-isystem} options for the preprocessor. In this case, | |
| the compiler appends @samp{include} to the prefix. | |
| The runtime support file @file{libgcc.a} can also be searched for using | |
| the @option{-B} prefix, if needed. If it is not found there, the two | |
| standard prefixes above are tried, and that is all. The file is left | |
| out of the link if it is not found by those means. | |
| Another way to specify a prefix much like the @option{-B} prefix is to use | |
| the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment | |
| Variables}. | |
| As a special kludge, if the path provided by @option{-B} is | |
| @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to | |
| 9, then it is replaced by @file{[dir/]include}. This is to help | |
| with boot-strapping the compiler. | |
| @opindex no-canonical-prefixes | |
| @item -no-canonical-prefixes | |
| @itemx --no-canonical-prefixes | |
| Do not expand any symbolic links, resolve references to @samp{/../} | |
| or @samp{/./}, or make the path absolute when generating a relative | |
| prefix. | |
| @opindex sysroot | |
| @item --sysroot=@var{dir} | |
| @itemx --sysroot @var{dir} | |
| Use @var{dir} as the logical root directory for headers and libraries. | |
| For example, if the compiler normally searches for headers in | |
| @file{/usr/include} and libraries in @file{/usr/lib}, it instead | |
| searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}. | |
| If you use both this option and the @option{-isysroot} option, then | |
| the @option{--sysroot} option applies to libraries, but the | |
| @option{-isysroot} option applies to header files. | |
| The GNU linker (beginning with version 2.16) has the necessary support | |
| for this option. If your linker does not support this option, the | |
| header file aspect of @option{--sysroot} still works, but the | |
| library aspect does not. | |
| @opindex no-sysroot-suffix | |
| @item --no-sysroot-suffix | |
| For some targets, a suffix is added to the root directory specified | |
| with @option{--sysroot}, depending on the other options used, so that | |
| headers may for example be found in | |
| @file{@var{dir}/@var{suffix}/usr/include} instead of | |
| @file{@var{dir}/usr/include}. This option disables the addition of | |
| such a suffix. | |
| @end table | |
| @node Code Gen Options | |
| @section Options for Code Generation Conventions | |
| @cindex code generation conventions | |
| @cindex options, code generation | |
| @cindex run-time options | |
| These machine-independent options control the interface conventions | |
| used in code generation. | |
| Most of them have both positive and negative forms; the negative form | |
| of @option{-ffoo} is @option{-fno-foo}. In the table below, only | |
| one of the forms is listed---the one that is not the default. You | |
| can figure out the other form by either removing @samp{no-} or adding | |
| it. | |
| @table @gcctabopt | |
| @opindex fstack-reuse | |
| @item -fstack-reuse=@var{reuse-level} | |
| This option controls stack space reuse for user declared local/auto variables | |
| and compiler generated temporaries. @var{reuse_level} can be @samp{all}, | |
| @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all | |
| local variables and temporaries, @samp{named_vars} enables the reuse only for | |
| user defined local variables with names, and @samp{none} disables stack reuse | |
| completely. The default value is @samp{all}. The option is needed when the | |
| program extends the lifetime of a scoped local variable or a compiler generated | |
| temporary beyond the end point defined by the language. When a lifetime of | |
| a variable ends, and if the variable lives in memory, the optimizing compiler | |
| has the freedom to reuse its stack space with other temporaries or scoped | |
| local variables whose live range does not overlap with it. Legacy code extending | |
| local lifetime is likely to break with the stack reuse optimization. | |
| For example, | |
| @smallexample | |
| int *p; | |
| @{ | |
| int local1; | |
| p = &local1; | |
| local1 = 10; | |
| .... | |
| @} | |
| @{ | |
| int local2; | |
| local2 = 20; | |
| ... | |
| @} | |
| if (*p == 10) // out of scope use of local1 | |
| @{ | |
| @} | |
| @end smallexample | |
| Another example: | |
| @smallexample | |
| struct A | |
| @{ | |
| A(int k) : i(k), j(k) @{ @} | |
| int i; | |
| int j; | |
| @}; | |
| A *ap; | |
| void foo(const A& ar) | |
| @{ | |
| ap = &ar; | |
| @} | |
| void bar() | |
| @{ | |
| foo(A(10)); // temp object's lifetime ends when foo returns | |
| @{ | |
| A a(20); | |
| .... | |
| @} | |
| ap->i+= 10; // ap references out of scope temp whose space | |
| // is reused with a. What is the value of ap->i? | |
| @} | |
| @end smallexample | |
| The lifetime of a compiler generated temporary is well defined by the C++ | |
| standard. When a lifetime of a temporary ends, and if the temporary lives | |
| in memory, the optimizing compiler has the freedom to reuse its stack | |
| space with other temporaries or scoped local variables whose live range | |
| does not overlap with it. However some of the legacy code relies on | |
| the behavior of older compilers in which temporaries' stack space is | |
| not reused, the aggressive stack reuse can lead to runtime errors. This | |
| option is used to control the temporary stack reuse optimization. | |
| @opindex ftrapv | |
| @opindex fno-trapv | |
| @item -ftrapv | |
| This option generates traps for signed overflow on addition, subtraction, | |
| multiplication operations. | |
| The options @option{-ftrapv} and @option{-fwrapv} override each other, so using | |
| @option{-ftrapv} @option{-fwrapv} on the command-line results in | |
| @option{-fwrapv} being effective. Note that only active options override, so | |
| using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line | |
| results in @option{-ftrapv} being effective. | |
| @opindex fwrapv | |
| @opindex fno-wrapv | |
| @item -fwrapv | |
| This option instructs the compiler to assume that signed arithmetic | |
| overflow of addition, subtraction and multiplication wraps around | |
| using twos-complement representation. This flag enables some optimizations | |
| and disables others. | |
| The options @option{-ftrapv} and @option{-fwrapv} override each other, so using | |
| @option{-ftrapv} @option{-fwrapv} on the command-line results in | |
| @option{-fwrapv} being effective. Note that only active options override, so | |
| using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line | |
| results in @option{-ftrapv} being effective. | |
| @opindex fwrapv-pointer | |
| @opindex fno-wrapv-pointer | |
| @item -fwrapv-pointer | |
| This option instructs the compiler to assume that pointer arithmetic | |
| overflow on addition and subtraction wraps around using twos-complement | |
| representation. This flag disables some optimizations which assume | |
| pointer overflow is invalid. @strong{Warning:} this option exists because | |
| of the Linux Kernel's view of what C is. It does @strong{not} turn pointers | |
| into twos-complement numbers or eliminates all rules and guarantees the C | |
| standard has on pointers. @strong{Do not use} this option but rather write | |
| conforming C. | |
| @opindex fstrict-overflow | |
| @opindex fno-strict-overflow | |
| @item -fstrict-overflow | |
| This option implies @option{-fno-wrapv} @option{-fno-wrapv-pointer} and when | |
| negated implies @option{-fwrapv} @option{-fwrapv-pointer}. You should | |
| consider using @code{-fwrapv} instead of @code{-fstrict-overflow}, | |
| the (implicit) use of @code{-fwrapv-pointer} is discouraged. | |
| @opindex fexceptions | |
| @opindex fno-exceptions | |
| @item -fexceptions | |
| Enable exception handling. Generates extra code needed to propagate | |
| exceptions. For some targets, this implies GCC generates frame | |
| unwind information for all functions, which can produce significant data | |
| size overhead, although it does not affect execution. If you do not | |
| specify this option, GCC enables it by default for languages like | |
| C++ that normally require exception handling, and disables it for | |
| languages like C that do not normally require it. However, you may need | |
| to enable this option when compiling C code that needs to interoperate | |
| properly with exception handlers written in C++. You may also wish to | |
| disable this option if you are compiling older C++ programs that don't | |
| use exception handling. | |
| @opindex fnon-call-exceptions | |
| @opindex fno-non-call-exceptions | |
| @item -fnon-call-exceptions | |
| Generate code that allows trapping instructions to throw exceptions. | |
| Note that this requires platform-specific runtime support that does | |
| not exist everywhere. Moreover, it only allows @emph{trapping} | |
| instructions to throw exceptions, i.e.@: memory references or floating-point | |
| instructions. It does not allow exceptions to be thrown from | |
| arbitrary signal handlers such as @code{SIGALRM}. This enables | |
| @option{-fexceptions}. | |
| @opindex fdelete-dead-exceptions | |
| @opindex fno-delete-dead-exceptions | |
| @item -fdelete-dead-exceptions | |
| Consider that instructions that may throw exceptions but don't otherwise | |
| contribute to the execution of the program can be optimized away. | |
| This does not affect calls to functions except those with the | |
| @code{pure} or @code{const} attributes. | |
| This option is enabled by default for the Ada and C++ compilers, as permitted by | |
| the language specifications. | |
| Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels. | |
| @opindex funwind-tables | |
| @opindex fno-unwind-tables | |
| @item -funwind-tables | |
| Similar to @option{-fexceptions}, except that it just generates any needed | |
| static data, but does not affect the generated code in any other way. | |
| You normally do not need to enable this option; instead, a language processor | |
| that needs this handling enables it on your behalf. | |
| @opindex fasynchronous-unwind-tables | |
| @opindex fno-asynchronous-unwind-tables | |
| @item -fasynchronous-unwind-tables | |
| Generate unwind table in DWARF format, if supported by target machine. The | |
| table is exact at each instruction boundary, so it can be used for stack | |
| unwinding from asynchronous events (such as debugger or garbage collector). | |
| @opindex fno-gnu-unique | |
| @opindex fgnu-unique | |
| @item -fno-gnu-unique | |
| On systems with recent GNU assembler and C library, the C++ compiler | |
| uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions | |
| of template static data members and static local variables in inline | |
| functions are unique even in the presence of @code{RTLD_LOCAL}; this | |
| is necessary to avoid problems with a library used by two different | |
| @code{RTLD_LOCAL} plugins depending on a definition in one of them and | |
| therefore disagreeing with the other one about the binding of the | |
| symbol. But this causes @code{dlclose} to be ignored for affected | |
| DSOs; if your program relies on reinitialization of a DSO via | |
| @code{dlclose} and @code{dlopen}, you can use | |
| @option{-fno-gnu-unique}. | |
| @opindex fpcc-struct-return | |
| @opindex fno-pcc-struct-return | |
| @item -fpcc-struct-return | |
| Return ``short'' @code{struct} and @code{union} values in memory like | |
| longer ones, rather than in registers. This convention is less | |
| efficient, but it has the advantage of allowing intercallability between | |
| GCC-compiled files and files compiled with other compilers, particularly | |
| the Portable C Compiler (pcc). | |
| The precise convention for returning structures in memory depends | |
| on the target configuration macros. | |
| Short structures and unions are those whose size and alignment match | |
| that of some integer type. | |
| @strong{Warning:} code compiled with the @option{-fpcc-struct-return} | |
| switch is not binary compatible with code compiled with the | |
| @option{-freg-struct-return} switch. | |
| Use it to conform to a non-default application binary interface. | |
| @opindex freg-struct-return | |
| @opindex fno-reg-struct-return | |
| @item -freg-struct-return | |
| Return @code{struct} and @code{union} values in registers when possible. | |
| This is more efficient for small structures than | |
| @option{-fpcc-struct-return}. | |
| If you specify neither @option{-fpcc-struct-return} nor | |
| @option{-freg-struct-return}, GCC defaults to whichever convention is | |
| standard for the target. If there is no standard convention, GCC | |
| defaults to @option{-fpcc-struct-return}, except on targets where GCC is | |
| the principal compiler. In those cases, we can choose the standard, and | |
| we chose the more efficient register return alternative. | |
| @strong{Warning:} code compiled with the @option{-freg-struct-return} | |
| switch is not binary compatible with code compiled with the | |
| @option{-fpcc-struct-return} switch. | |
| Use it to conform to a non-default application binary interface. | |
| @opindex fshort-enums | |
| @opindex fno-short-enums | |
| @item -fshort-enums | |
| Allocate to an @code{enum} type only as many bytes as it needs for the | |
| declared range of possible values. Specifically, the @code{enum} type | |
| is equivalent to the smallest integer type that has enough room. | |
| This option has no effect for an enumeration type with a fixed underlying | |
| type. | |
| @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate | |
| code that is not binary compatible with code generated without that switch. | |
| Use it to conform to a non-default application binary interface. | |
| @opindex fshort-wchar | |
| @opindex fno-short-wchar | |
| @item -fshort-wchar | |
| Override the underlying type for @code{wchar_t} to be @code{short | |
| unsigned int} instead of the default for the target. This option is | |
| useful for building programs to run under WINE@. | |
| @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate | |
| code that is not binary compatible with code generated without that switch. | |
| Use it to conform to a non-default application binary interface. | |
| @opindex fcommon | |
| @opindex fno-common | |
| @cindex tentative definitions | |
| @item -fcommon | |
| In C code, this option controls the placement of global variables | |
| defined without an initializer, known as @dfn{tentative definitions} | |
| in the C standard. Tentative definitions are distinct from declarations | |
| of a variable with the @code{extern} keyword, which do not allocate storage. | |
| The default is @option{-fno-common}, which specifies that the compiler places | |
| uninitialized global variables in the BSS section of the object file. | |
| This inhibits the merging of tentative definitions by the linker so you get a | |
| multiple-definition error if the same variable is accidentally defined in more | |
| than one compilation unit. | |
| The @option{-fcommon} places uninitialized global variables in a common block. | |
| This allows the linker to resolve all tentative definitions of the same variable | |
| in different compilation units to the same object, or to a non-tentative | |
| definition. This behavior is inconsistent with C++, and on many targets implies | |
| a speed and code size penalty on global variable references. It is mainly | |
| useful to enable legacy code to link without errors. | |
| @opindex fno-ident | |
| @opindex fident | |
| @opindex Qy | |
| @opindex Qn | |
| @item -fno-ident | |
| @itemx -Qy | |
| @itemx -Qn | |
| @option{-fno-ident} suppresses emission of @code{.ident} assembler | |
| directives and causes the @code{#ident} preprocessor directive to be ignored. | |
| @option{-Qy} and @option{-Qn} are obsolete synonyms for @option{-fident} | |
| and @option{-fno-ident}, respectively. | |
| @opindex finhibit-size-directive | |
| @opindex fno-inhibit-size-directive | |
| @item -finhibit-size-directive | |
| Don't output a @code{.size} assembler directive, or anything else that | |
| would cause trouble if the function is split in the middle, and the | |
| two halves are placed at locations far apart in memory. This option is | |
| used when compiling @file{crtstuff.c}; you should not need to use it | |
| for anything else. | |
| @opindex fverbose-asm | |
| @opindex fno-verbose-asm | |
| @item -fverbose-asm | |
| Put extra commentary information in the generated assembly code to | |
| make it more readable. This option is generally only of use to those | |
| who actually need to read the generated assembly code (perhaps while | |
| debugging the compiler itself). | |
| @option{-fno-verbose-asm}, the default, causes the | |
| extra information to be omitted and is useful when comparing two assembler | |
| files. | |
| The added comments include: | |
| @itemize @bullet | |
| @item | |
| information on the compiler version and command-line options, | |
| @item | |
| the source code lines associated with the assembly instructions, | |
| in the form FILENAME:LINENUMBER:CONTENT OF LINE, | |
| @item | |
| hints on which high-level expressions correspond to | |
| the various assembly instruction operands. | |
| @end itemize | |
| For example, given this C source file: | |
| @smallexample | |
| int test (int n) | |
| @{ | |
| int i; | |
| int total = 0; | |
| for (i = 0; i < n; i++) | |
| total += i * i; | |
| return total; | |
| @} | |
| @end smallexample | |
| compiling to (x86_64) assembly via @option{-S} and emitting the result | |
| direct to stdout via @option{-o} @option{-} | |
| @smallexample | |
| gcc -S test.c -fverbose-asm -Os -o - | |
| @end smallexample | |
| gives output similar to this: | |
| @smallexample | |
| .file "test.c" | |
| # GNU C11 (GCC) version 7.0.0 20160809 (experimental) (x86_64-pc-linux-gnu) | |
| [...snip...] | |
| # options passed: | |
| [...snip...] | |
| .text | |
| .globl test | |
| .type test, @@function | |
| test: | |
| .LFB0: | |
| .cfi_startproc | |
| # test.c:4: int total = 0; | |
| xorl %eax, %eax # <retval> | |
| # test.c:6: for (i = 0; i < n; i++) | |
| xorl %edx, %edx # i | |
| .L2: | |
| # test.c:6: for (i = 0; i < n; i++) | |
| cmpl %edi, %edx # n, i | |
| jge .L5 #, | |
| # test.c:7: total += i * i; | |
| movl %edx, %ecx # i, tmp92 | |
| imull %edx, %ecx # i, tmp92 | |
| # test.c:6: for (i = 0; i < n; i++) | |
| incl %edx # i | |
| # test.c:7: total += i * i; | |
| addl %ecx, %eax # tmp92, <retval> | |
| jmp .L2 # | |
| .L5: | |
| # test.c:10: @} | |
| ret | |
| .cfi_endproc | |
| .LFE0: | |
| .size test, .-test | |
| .ident "GCC: (GNU) 7.0.0 20160809 (experimental)" | |
| .section .note.GNU-stack,"",@@progbits | |
| @end smallexample | |
| The comments are intended for humans rather than machines and hence the | |
| precise format of the comments is subject to change. | |
| @opindex frecord-gcc-switches | |
| @opindex fno-record-gcc-switches | |
| @item -frecord-gcc-switches | |
| This switch causes the command line used to invoke the | |
| compiler to be recorded into the object file that is being created. | |
| This switch is only implemented on some targets and the exact format | |
| of the recording is target and binary file format dependent, but it | |
| usually takes the form of a section containing ASCII text. This | |
| switch is related to the @option{-fverbose-asm} switch, but that | |
| switch only records information in the assembler output file as | |
| comments, so it never reaches the object file. | |
| See also @option{-grecord-gcc-switches} for another | |
| way of storing compiler options into the object file. | |
| @opindex fpic | |
| @opindex fno-pic | |
| @cindex global offset table | |
| @cindex PIC | |
| @item -fpic | |
| Generate position-independent code (PIC) suitable for use in a shared | |
| library, if supported for the target machine. Such code accesses all | |
| constant addresses through a global offset table (GOT)@. The dynamic | |
| loader resolves the GOT entries when the program starts (the dynamic | |
| loader is not part of GCC; it is part of the operating system). If | |
| the GOT size for the linked executable exceeds a machine-specific | |
| maximum size, you get an error message from the linker indicating that | |
| @option{-fpic} does not work; in that case, recompile with @option{-fPIC} | |
| instead. (These maximums are 8k on the SPARC, 28k on AArch64 and 32k | |
| on the m68k and RS/6000. The x86 has no such limit.) | |
| Position-independent code requires special support, and therefore works | |
| only on certain machines. For the x86, GCC supports PIC for System V | |
| but not for the Sun 386i. Code generated for the IBM RS/6000 is always | |
| position-independent. | |
| When this flag is set, the macros @code{__pic__} and @code{__PIC__} | |
| are defined to 1. | |
| @opindex fPIC | |
| @opindex fno-PIC | |
| @item -fPIC | |
| If supported for the target machine, emit position-independent code, | |
| suitable for dynamic linking and avoiding any limit on the size of the | |
| global offset table. This option makes a difference on AArch64, m68k, | |
| PowerPC and SPARC@. | |
| Position-independent code requires special support, and therefore works | |
| only on certain machines. | |
| When this flag is set, the macros @code{__pic__} and @code{__PIC__} | |
| are defined to 2. | |
| @opindex fpie | |
| @opindex fno-pie | |
| @opindex fPIE | |
| @opindex fno-PIE | |
| @item -fpie | |
| @itemx -fPIE | |
| These options are similar to @option{-fpic} and @option{-fPIC}, but the | |
| generated position-independent code can be only linked into executables. | |
| Usually these options are used to compile code that will be linked using | |
| the @option{-pie} GCC option. | |
| @option{-fpie} and @option{-fPIE} both define the macros | |
| @code{__pie__} and @code{__PIE__}. The macros have the value 1 | |
| for @option{-fpie} and 2 for @option{-fPIE}. | |
| @opindex fno-plt | |
| @opindex fplt | |
| @item -fno-plt | |
| Do not use the PLT for external function calls in position-independent code. | |
| Instead, load the callee address at call sites from the GOT and branch to it. | |
| This leads to more efficient code by eliminating PLT stubs and exposing | |
| GOT loads to optimizations. On architectures such as 32-bit x86 where | |
| PLT stubs expect the GOT pointer in a specific register, this gives more | |
| register allocation freedom to the compiler. | |
| Lazy binding requires use of the PLT; | |
| with @option{-fno-plt} all external symbols are resolved at load time. | |
| Alternatively, the function attribute @code{noplt} can be used to avoid calls | |
| through the PLT for specific external functions. | |
| In position-dependent code, a few targets also convert calls to | |
| functions that are marked to not use the PLT to use the GOT instead. | |
| @opindex fno-jump-tables | |
| @opindex fjump-tables | |
| @item -fno-jump-tables | |
| Do not use jump tables for switch statements even where it would be | |
| more efficient than other code generation strategies. This option is | |
| of use in conjunction with @option{-fpic} or @option{-fPIC} for | |
| building code that forms part of a dynamic linker and cannot | |
| reference the address of a jump table. On some targets, jump tables | |
| do not require a GOT and this option is not needed. | |
| @opindex fno-bit-tests | |
| @opindex fbit-tests | |
| @item -fno-bit-tests | |
| Do not use bit tests for switch statements even where it would be | |
| more efficient than other code generation strategies. | |
| @opindex ffixed | |
| @item -ffixed-@var{reg} | |
| Treat the register named @var{reg} as a fixed register; generated code | |
| should never refer to it (except perhaps as a stack pointer, frame | |
| pointer or in some other fixed role). | |
| @var{reg} must be the name of a register. The register names accepted | |
| are machine-specific and are defined in the @code{REGISTER_NAMES} | |
| macro in the machine description macro file. | |
| This flag does not have a negative form, because it specifies a | |
| three-way choice. | |
| @opindex fcall-used | |
| @item -fcall-used-@var{reg} | |
| Treat the register named @var{reg} as an allocable register that is | |
| clobbered by function calls. It may be allocated for temporaries or | |
| variables that do not live across a call. Functions compiled this way | |
| do not save and restore the register @var{reg}. | |
| It is an error to use this flag with the frame pointer or stack pointer. | |
| Use of this flag for other registers that have fixed pervasive roles in | |
| the machine's execution model produces disastrous results. | |
| This flag does not have a negative form, because it specifies a | |
| three-way choice. | |
| @opindex fcall-saved | |
| @item -fcall-saved-@var{reg} | |
| Treat the register named @var{reg} as an allocable register saved by | |
| functions. It may be allocated even for temporaries or variables that | |
| live across a call. Functions compiled this way save and restore | |
| the register @var{reg} if they use it. | |
| It is an error to use this flag with the frame pointer or stack pointer. | |
| Use of this flag for other registers that have fixed pervasive roles in | |
| the machine's execution model produces disastrous results. | |
| A different sort of disaster results from the use of this flag for | |
| a register in which function values may be returned. | |
| This flag does not have a negative form, because it specifies a | |
| three-way choice. | |
| @opindex fpack-struct | |
| @opindex fno-pack-struct | |
| @item -fpack-struct[=@var{n}] | |
| Without a value specified, pack all structure members together without | |
| holes. When a value is specified (which must be a small power of two), pack | |
| structure members according to this value, representing the maximum | |
| alignment (that is, objects with default alignment requirements larger than | |
| this are output potentially unaligned at the next fitting location. | |
| @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate | |
| code that is not binary compatible with code generated without that switch. | |
| Additionally, it makes the code suboptimal. | |
| Use it to conform to a non-default application binary interface. | |
| @opindex fleading-underscore | |
| @opindex fno-leading-underscore | |
| @item -fleading-underscore | |
| This option and its counterpart, @option{-fno-leading-underscore}, forcibly | |
| change the way C symbols are represented in the object file. One use | |
| is to help link with legacy assembly code. | |
| @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to | |
| generate code that is not binary compatible with code generated without that | |
| switch. Use it to conform to a non-default application binary interface. | |
| Not all targets provide complete support for this switch. | |
| @opindex ftls-model | |
| @item -ftls-model=@var{model} | |
| Alter the thread-local storage model to be used (@pxref{Thread-Local}). | |
| The @var{model} argument should be one of @samp{global-dynamic}, | |
| @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}. | |
| Note that the choice is subject to optimization: the compiler may use | |
| a more efficient model for symbols not visible outside of the translation | |
| unit, or if @option{-fpic} is not given on the command line. | |
| The default without @option{-fpic} is @samp{initial-exec}; with | |
| @option{-fpic} the default is @samp{global-dynamic}. | |
| @opindex ftrampolines | |
| @opindex fno-trampolines | |
| @item -ftrampolines | |
| For targets that normally need trampolines for nested functions, always | |
| generate them instead of using descriptors. Otherwise, for targets that | |
| do not need them, like for example HP-PA or IA-64, do nothing. | |
| A trampoline is a small piece of code that is created at run time on the | |
| stack when the address of a nested function is taken, and is used to call | |
| the nested function indirectly. Therefore, it requires the stack to be | |
| made executable in order for the program to work properly. | |
| @option{-fno-trampolines} is enabled by default on a language by language | |
| basis to let the compiler avoid generating them, if it computes that this | |
| is safe, and replace them with descriptors. Descriptors are made up of data | |
| only, but the generated code must be prepared to deal with them. As of this | |
| writing, @option{-fno-trampolines} is enabled by default only for Ada. | |
| Moreover, code compiled with @option{-ftrampolines} and code compiled with | |
| @option{-fno-trampolines} are not binary compatible if nested functions are | |
| present. This option must therefore be used on a program-wide basis and be | |
| manipulated with extreme care. | |
| For languages other than Ada, the @code{-ftrampolines} and | |
| @code{-fno-trampolines} options currently have no effect, and | |
| trampolines are always generated on platforms that need them | |
| for nested functions. | |
| @opindex ftrampoline-impl | |
| @item -ftrampoline-impl=@r{[}stack@r{|}heap@r{]} | |
| By default, trampolines are generated on stack. However, certain platforms | |
| (such as the Apple M1) do not permit an executable stack. Compiling with | |
| @option{-ftrampoline-impl=heap} generate calls to | |
| @code{__gcc_nested_func_ptr_created} and | |
| @code{__gcc_nested_func_ptr_deleted} in order to allocate and | |
| deallocate trampoline space on the executable heap. These functions are | |
| implemented in libgcc, and will only be provided on specific targets: | |
| x86_64 Darwin, x86_64 and aarch64 Linux. @emph{PLEASE NOTE}: Heap | |
| trampolines are @emph{not} guaranteed to be correctly deallocated if you | |
| @code{setjmp}, instantiate nested functions, and then @code{longjmp} back | |
| to a state prior to having allocated those nested functions. | |
| @opindex fvisibility | |
| @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} | |
| Set the default ELF image symbol visibility to the specified option---all | |
| symbols are marked with this unless overridden within the code. | |
| Using this feature can very substantially improve linking and | |
| load times of shared object libraries, produce more optimized | |
| code, provide near-perfect API export and prevent symbol clashes. | |
| It is @strong{strongly} recommended that you use this in any shared objects | |
| you distribute. | |
| Despite the nomenclature, @samp{default} always means public; i.e., | |
| available to be linked against from outside the shared object. | |
| @samp{protected} and @samp{internal} are pretty useless in real-world | |
| usage so the only other commonly used option is @samp{hidden}. | |
| The default if @option{-fvisibility} isn't specified is | |
| @samp{default}, i.e., make every symbol public. | |
| A good explanation of the benefits offered by ensuring ELF | |
| symbols have the correct visibility is given by ``How To Write | |
| Shared Libraries'' by Ulrich Drepper (which can be found at | |
| @w{@uref{https://www.akkadia.org/drepper/}})---however a superior | |
| solution made possible by this option to marking things hidden when | |
| the default is public is to make the default hidden and mark things | |
| public. This is the norm with DLLs on Windows and with @option{-fvisibility=hidden} | |
| and @code{__attribute__ ((visibility("default")))} instead of | |
| @code{__declspec(dllexport)} you get almost identical semantics with | |
| identical syntax. This is a great boon to those working with | |
| cross-platform projects. | |
| For those adding visibility support to existing code, you may find | |
| @code{#pragma GCC visibility} of use. This works by you enclosing | |
| the declarations you wish to set visibility for with (for example) | |
| @code{#pragma GCC visibility push(hidden)} and | |
| @code{#pragma GCC visibility pop}. | |
| Bear in mind that symbol visibility should be viewed @strong{as | |
| part of the API interface contract} and thus all new code should | |
| always specify visibility when it is not the default; i.e., declarations | |
| only for use within the local DSO should @strong{always} be marked explicitly | |
| as hidden as so to avoid PLT indirection overheads---making this | |
| abundantly clear also aids readability and self-documentation of the code. | |
| Note that due to ISO C++ specification requirements, @code{operator new} and | |
| @code{operator delete} must always be of default visibility. | |
| Be aware that headers from outside your project, in particular system | |
| headers and headers from any other library you use, may not be | |
| expecting to be compiled with visibility other than the default. You | |
| may need to explicitly say @code{#pragma GCC visibility push(default)} | |
| before including any such headers. | |
| @code{extern} declarations are not affected by @option{-fvisibility}, so | |
| a lot of code can be recompiled with @option{-fvisibility=hidden} with | |
| no modifications. However, this means that calls to @code{extern} | |
| functions with no explicit visibility use the PLT, so it is more | |
| effective to use @code{__attribute ((visibility))} and/or | |
| @code{#pragma GCC visibility} to tell the compiler which @code{extern} | |
| declarations should be treated as hidden. | |
| Note that @option{-fvisibility} does affect C++ vague linkage | |
| entities. This means that, for instance, an exception class that is | |
| be thrown between DSOs must be explicitly marked with default | |
| visibility so that the @samp{type_info} nodes are unified between | |
| the DSOs. | |
| An overview of these techniques, their benefits and how to use them | |
| is at @uref{https://gcc.gnu.org/@/wiki/@/Visibility}. | |
| @opindex fstrict-volatile-bitfields | |
| @opindex fno-strict-volatile-bitfields | |
| @item -fstrict-volatile-bitfields | |
| This option should be used if accesses to volatile bit-fields (or other | |
| structure fields, although the compiler usually honors those types | |
| anyway) should use a single access of the width of the | |
| field's type, aligned to a natural alignment if possible. For | |
| example, targets with memory-mapped peripheral registers might require | |
| all such accesses to be 16 bits wide; with this flag you can | |
| declare all peripheral bit-fields as @code{unsigned short} (assuming short | |
| is 16 bits on these targets) to force GCC to use 16-bit accesses | |
| instead of, perhaps, a more efficient 32-bit access. | |
| If this option is disabled, the compiler uses the most efficient | |
| instruction. In the previous example, that might be a 32-bit load | |
| instruction, even though that accesses bytes that do not contain | |
| any portion of the bit-field, or memory-mapped registers unrelated to | |
| the one being updated. | |
| In some cases, such as when the @code{packed} attribute is applied to a | |
| structure field, it may not be possible to access the field with a single | |
| read or write that is correctly aligned for the target machine. In this | |
| case GCC falls back to generating multiple accesses rather than code that | |
| will fault or truncate the result at run time. | |
| Note: Due to restrictions of the C/C++11 memory model, write accesses are | |
| not allowed to touch non bit-field members. It is therefore recommended | |
| to define all bits of the field's type as bit-field members. | |
| The default value of this option is determined by the application binary | |
| interface for the target processor. | |
| @opindex fsync-libcalls | |
| @opindex fno-sync-libcalls | |
| @item -fsync-libcalls | |
| This option controls whether any out-of-line instance of the @code{__sync} | |
| family of functions may be used to implement the C++11 @code{__atomic} | |
| family of functions. | |
| The default value of this option is enabled, thus the only useful form | |
| of the option is @option{-fno-sync-libcalls}. This option is used in | |
| the implementation of the @file{libatomic} runtime library. | |
| @opindex fzero-init-padding-bits=@var{value} | |
| @item -fzero-init-padding-bits=@var{value} | |
| Guarantee zero initialization of padding bits in automatic variable | |
| initializers. | |
| Certain languages guarantee zero initialization of padding bits in | |
| certain cases, e.g. C23 when using empty initializers (@code{@{@}}), | |
| or C++ when using zero-initialization or C guarantees that fields | |
| not specified in an initializer have their padding bits zero initialized. | |
| This option allows to change when padding bits in initializers are | |
| guaranteed to be zero initialized. | |
| The default is @code{-fzero-init-padding-bits=standard}, which makes | |
| no further guarantees than the corresponding standard. E.g.@: | |
| @smallexample | |
| struct A @{ char a; unsigned long long b; char c; @}; | |
| union B @{ char a; unsigned long long b; @}; | |
| struct A a = @{@}; // C23 guarantees padding bits are zero. | |
| struct A b = @{ 1, 2, 3 @}; // No guarantees. | |
| union B c = @{@}; // C23 guarantees padding bits are zero. | |
| union B d = @{ 1 @}; // No guarantees. | |
| @end smallexample | |
| @code{-fzero-init-padding-bits=unions} guarantees zero initialization | |
| of padding bits in unions on top of what the standards guarantee, | |
| if the initializer of an union is empty (then all bits of the union | |
| are zero initialized) or if the initialized member of the union is | |
| smaller than the size of the union (in that case guarantees padding | |
| bits outside of the initialized member to be zero initialized). | |
| This was the GCC behavior before GCC 15 and in the above example guarantees | |
| zero initialization of last @code{sizeof (unsigned long long) - 1} | |
| bytes in the union. | |
| @code{-fzero-init-padding-bits=all} guarantees additionally | |
| zero initialization of padding bits of other aggregates, so | |
| the padding in between @code{b.a} and @code{b.b} (if any) and | |
| tail padding in the structure (if any). | |
| @end table | |
| @node Developer Options | |
| @section GCC Developer Options | |
| @cindex developer options | |
| @cindex debugging GCC | |
| @cindex debug dump options | |
| @cindex dump options | |
| @cindex compilation statistics | |
| This section describes command-line options that are primarily of | |
| interest to GCC developers, including options to support compiler | |
| testing and investigation of compiler bugs and compile-time | |
| performance problems. This includes options that produce debug dumps | |
| at various points in the compilation; that print statistics such as | |
| memory use and execution time; and that print information about GCC's | |
| configuration, such as where it searches for libraries. You should | |
| rarely need to use any of these options for ordinary compilation and | |
| linking tasks. | |
| Many developer options that cause GCC to dump output to a file take an | |
| optional @samp{=@var{filename}} suffix. You can specify @samp{stdout} | |
| or @samp{-} to dump to standard output, and @samp{stderr} for standard | |
| error. | |
| If @samp{=@var{filename}} is omitted, a default dump file name is | |
| constructed by concatenating the base dump file name, a pass number, | |
| phase letter, and pass name. The base dump file name is the name of | |
| output file produced by the compiler if explicitly specified and not | |
| an executable; otherwise it is the source file name. | |
| The pass number is determined by the order passes are registered with | |
| the compiler's pass manager. | |
| This is generally the same as the order of execution, but passes | |
| registered by plugins, target-specific passes, or passes that are | |
| otherwise registered late are numbered higher than the pass named | |
| @samp{final}, even if they are executed earlier. The phase letter is | |
| one of @samp{i} (inter-procedural analysis), @samp{l} | |
| (language-specific), @samp{r} (RTL), or @samp{t} (tree). | |
| The files are created in the directory of the output file. | |
| @table @gcctabopt | |
| @opindex fcallgraph-info | |
| @item -fcallgraph-info | |
| @itemx -fcallgraph-info=@var{MARKERS} | |
| Makes the compiler output callgraph information for the program, on a | |
| per-object-file basis. The information is generated in the common VCG | |
| format. It can be decorated with additional, per-node and/or per-edge | |
| information, if a list of comma-separated markers is additionally | |
| specified. When the @code{su} marker is specified, the callgraph is | |
| decorated with stack usage information; it is equivalent to | |
| @option{-fstack-usage}. When the @code{da} marker is specified, the | |
| callgraph is decorated with information about dynamically allocated | |
| objects. | |
| When compiling with @option{-flto}, no callgraph information is output | |
| along with the object file. At LTO link time, @option{-fcallgraph-info} | |
| may generate multiple callgraph information files next to intermediate | |
| LTO output files. | |
| @opindex d | |
| @opindex dump | |
| @opindex fdump-rtl-@var{pass} | |
| @item -d@var{letters} | |
| @itemx --dump=@var{letters} | |
| @itemx --dump @var{letters} | |
| @itemx -fdump-rtl-@var{pass} | |
| @itemx -fdump-rtl-@var{pass}-@var{options} | |
| @itemx -fdump-rtl-@var{pass}-@var{options}=@var{filename} | |
| Says to make debugging dumps during compilation at times specified by | |
| @var{letters} when using @option{-d} or by @var{pass} when using | |
| @option{-fdump-rtl}. This is used for debugging the RTL-based passes of the | |
| compiler. | |
| Some @option{-d@var{letters}} switches have different meaning when | |
| @option{-E} is used for preprocessing. @xref{Preprocessor Options}, | |
| for information about preprocessor-specific dump options. | |
| The @samp{-@var{options}} form allows greater control over the details of the | |
| dump. See @option{-fdump-tree}. | |
| Here are actual instances of command-line options following these patterns and | |
| their meanings: | |
| @table @gcctabopt | |
| @opindex fdump-rtl-alignments | |
| @item -fdump-rtl-alignments | |
| Dump after branch alignments have been computed. | |
| @opindex fdump-rtl-asmcons | |
| @item -fdump-rtl-asmcons | |
| Dump after fixing rtl statements that have unsatisfied in/out constraints. | |
| @opindex fdump-rtl-auto_inc_dec | |
| @item -fdump-rtl-auto_inc_dec | |
| Dump after auto-inc-dec discovery. This pass is only run on | |
| architectures that have auto inc or auto dec instructions. | |
| @opindex fdump-rtl-barriers | |
| @item -fdump-rtl-barriers | |
| Dump after cleaning up the barrier instructions. | |
| @opindex fdump-rtl-bbpart | |
| @item -fdump-rtl-bbpart | |
| Dump after partitioning hot and cold basic blocks. | |
| @opindex fdump-rtl-bbro | |
| @item -fdump-rtl-bbro | |
| Dump after block reordering. | |
| @opindex fdump-rtl-btl2 | |
| @opindex fdump-rtl-btl2 | |
| @item -fdump-rtl-btl1 | |
| @itemx -fdump-rtl-btl2 | |
| @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping | |
| after the two branch | |
| target load optimization passes. | |
| @opindex fdump-rtl-bypass | |
| @item -fdump-rtl-bypass | |
| Dump after jump bypassing and control flow optimizations. | |
| @opindex fdump-rtl-combine | |
| @item -fdump-rtl-combine | |
| Dump after the RTL instruction combination pass. | |
| @opindex fdump-rtl-compgotos | |
| @item -fdump-rtl-compgotos | |
| Dump after duplicating the computed gotos. | |
| @opindex fdump-rtl-ce1 | |
| @opindex fdump-rtl-ce2 | |
| @opindex fdump-rtl-ce3 | |
| @item -fdump-rtl-ce1 | |
| @itemx -fdump-rtl-ce2 | |
| @itemx -fdump-rtl-ce3 | |
| @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and | |
| @option{-fdump-rtl-ce3} enable dumping after the three | |
| if conversion passes. | |
| @opindex fdump-rtl-cprop_hardreg | |
| @item -fdump-rtl-cprop_hardreg | |
| Dump after hard register copy propagation. | |
| @opindex fdump-rtl-csa | |
| @item -fdump-rtl-csa | |
| Dump after combining stack adjustments. | |
| @opindex fdump-rtl-cse1 | |
| @opindex fdump-rtl-cse2 | |
| @item -fdump-rtl-cse1 | |
| @itemx -fdump-rtl-cse2 | |
| @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after | |
| the two common subexpression elimination passes. | |
| @opindex fdump-rtl-dce | |
| @item -fdump-rtl-dce | |
| Dump after the standalone dead code elimination passes. | |
| @opindex fdump-rtl-dbr | |
| @item -fdump-rtl-dbr | |
| Dump after delayed branch scheduling. | |
| @opindex fdump-rtl-dce1 | |
| @opindex fdump-rtl-dce2 | |
| @item -fdump-rtl-dce1 | |
| @itemx -fdump-rtl-dce2 | |
| @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after | |
| the two dead store elimination passes. | |
| @opindex fdump-rtl-eh | |
| @item -fdump-rtl-eh | |
| Dump after finalization of EH handling code. | |
| @opindex fdump-rtl-eh_ranges | |
| @item -fdump-rtl-eh_ranges | |
| Dump after conversion of EH handling range regions. | |
| @opindex fdump-rtl-expand | |
| @item -fdump-rtl-expand | |
| Dump after RTL generation. | |
| @opindex fdump-rtl-fwprop1 | |
| @opindex fdump-rtl-fwprop2 | |
| @item -fdump-rtl-fwprop1 | |
| @itemx -fdump-rtl-fwprop2 | |
| @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable | |
| dumping after the two forward propagation passes. | |
| @opindex fdump-rtl-gcse1 | |
| @opindex fdump-rtl-gcse2 | |
| @item -fdump-rtl-gcse1 | |
| @itemx -fdump-rtl-gcse2 | |
| @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping | |
| after global common subexpression elimination. | |
| @opindex fdump-rtl-init-regs | |
| @item -fdump-rtl-init-regs | |
| Dump after the initialization of the registers. | |
| @opindex fdump-rtl-initvals | |
| @item -fdump-rtl-initvals | |
| Dump after the computation of the initial value sets. | |
| @opindex fdump-rtl-into_cfglayout | |
| @item -fdump-rtl-into_cfglayout | |
| Dump after converting to cfglayout mode. | |
| @opindex fdump-rtl-ira | |
| @item -fdump-rtl-ira | |
| Dump after iterated register allocation. | |
| @opindex fdump-rtl-jump | |
| @item -fdump-rtl-jump | |
| Dump after the second jump optimization. | |
| @opindex fdump-rtl-loop2 | |
| @item -fdump-rtl-loop2 | |
| @option{-fdump-rtl-loop2} enables dumping after the rtl | |
| loop optimization passes. | |
| @opindex fdump-rtl-mach | |
| @item -fdump-rtl-mach | |
| Dump after performing the machine dependent reorganization pass, if that | |
| pass exists. | |
| @opindex fdump-rtl-mode_sw | |
| @item -fdump-rtl-mode_sw | |
| Dump after removing redundant mode switches. | |
| @opindex fdump-rtl-rnreg | |
| @item -fdump-rtl-rnreg | |
| Dump after register renumbering. | |
| @opindex fdump-rtl-outof_cfglayout | |
| @item -fdump-rtl-outof_cfglayout | |
| Dump after converting from cfglayout mode. | |
| @opindex fdump-rtl-peephole2 | |
| @item -fdump-rtl-peephole2 | |
| Dump after the peephole pass. | |
| @opindex fdump-rtl-postreload | |
| @item -fdump-rtl-postreload | |
| Dump after post-reload optimizations. | |
| @opindex fdump-rtl-pro_and_epilogue | |
| @item -fdump-rtl-pro_and_epilogue | |
| Dump after generating the function prologues and epilogues. | |
| @opindex fdump-rtl-sched1 | |
| @opindex fdump-rtl-sched2 | |
| @item -fdump-rtl-sched1 | |
| @itemx -fdump-rtl-sched2 | |
| @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping | |
| after the basic block scheduling passes. | |
| @opindex fdump-rtl-ree | |
| @item -fdump-rtl-ree | |
| Dump after sign/zero extension elimination. | |
| @opindex fdump-rtl-seqabstr | |
| @item -fdump-rtl-seqabstr | |
| Dump after common sequence discovery. | |
| @opindex fdump-rtl-shorten | |
| @item -fdump-rtl-shorten | |
| Dump after shortening branches. | |
| @opindex fdump-rtl-split1 | |
| @opindex fdump-rtl-split2 | |
| @opindex fdump-rtl-split3 | |
| @opindex fdump-rtl-split4 | |
| @opindex fdump-rtl-split5 | |
| @item -fdump-rtl-split1 | |
| @itemx -fdump-rtl-split2 | |
| @itemx -fdump-rtl-split3 | |
| @itemx -fdump-rtl-split4 | |
| @itemx -fdump-rtl-split5 | |
| These options enable dumping after five rounds of | |
| instruction splitting. | |
| @opindex fdump-rtl-sms | |
| @item -fdump-rtl-sms | |
| Dump after modulo scheduling. This pass is only run on some | |
| architectures. | |
| @opindex fdump-rtl-stack | |
| @item -fdump-rtl-stack | |
| Dump after conversion from GCC's ``flat register file'' registers to the | |
| x87's stack-like registers. This pass is only run on x86 variants. | |
| @opindex fdump-rtl-subreg1 | |
| @opindex fdump-rtl-subreg2 | |
| @item -fdump-rtl-subreg1 | |
| @itemx -fdump-rtl-subreg2 | |
| @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after | |
| the two subreg expansion passes. | |
| @opindex fdump-rtl-vartrack | |
| @item -fdump-rtl-vartrack | |
| Dump after variable tracking. | |
| @opindex fdump-rtl-vregs | |
| @item -fdump-rtl-vregs | |
| Dump after converting virtual registers to hard registers. | |
| @opindex fdump-rtl-web | |
| @item -fdump-rtl-web | |
| Dump after live range splitting. | |
| @opindex fdump-rtl-regclass | |
| @opindex fdump-rtl-subregs_of_mode_init | |
| @opindex fdump-rtl-subregs_of_mode_finish | |
| @opindex fdump-rtl-dfinit | |
| @opindex fdump-rtl-dfinish | |
| @item -fdump-rtl-regclass | |
| @itemx -fdump-rtl-subregs_of_mode_init | |
| @itemx -fdump-rtl-subregs_of_mode_finish | |
| @itemx -fdump-rtl-dfinit | |
| @itemx -fdump-rtl-dfinish | |
| These dumps are defined but always produce empty files. | |
| @opindex da | |
| @opindex fdump-rtl-all | |
| @item -da | |
| @itemx --dump=a | |
| @itemx -fdump-rtl-all | |
| Produce all the dumps listed above. | |
| @opindex dA | |
| @item -dA | |
| @itemx --dump=A | |
| Annotate the assembler output with miscellaneous debugging information. | |
| @opindex dD | |
| @item -dD | |
| @itemx --dump=D | |
| Dump all macro definitions, at the end of preprocessing, in addition to | |
| normal output. | |
| @opindex dH | |
| @item -dH | |
| @itemx --dump=H | |
| Produce a core dump whenever an error occurs. | |
| @opindex dp | |
| @item -dp | |
| @itemx --dump=p | |
| Annotate the assembler output with a comment indicating which | |
| pattern and alternative is used. The length and cost of each instruction are | |
| also printed. | |
| @opindex dP | |
| @item -dP | |
| @itemx --dump=P | |
| Dump the RTL in the assembler output as a comment before each instruction. | |
| Also turns on @option{-dp} annotation. | |
| @opindex dx | |
| @item -dx | |
| @itemx --dump=x | |
| Just generate RTL for a function instead of compiling it. Usually used | |
| with @option{-fdump-rtl-expand}. | |
| @end table | |
| @opindex fdump-debug | |
| @item -fdump-debug | |
| Dump debugging information generated during the debug | |
| generation phase. | |
| @opindex fdump-earlydebug | |
| @item -fdump-earlydebug | |
| Dump debugging information generated during the early debug | |
| generation phase. | |
| @opindex fdump-noaddr | |
| @opindex fno-dump-noaddr | |
| @item -fdump-noaddr | |
| When doing debugging dumps, suppress address output. This makes it more | |
| feasible to use diff on debugging dumps for compiler invocations with | |
| different compiler binaries and/or different | |
| text / bss / data / heap / stack / dso start locations. | |
| @opindex freport-bug | |
| @opindex fno-report-bug | |
| @item -freport-bug | |
| Collect and dump debug information into a temporary file if an | |
| internal compiler error (ICE) occurs. | |
| @opindex fdump-unnumbered | |
| @opindex fno-dump-unnumbered | |
| @item -fdump-unnumbered | |
| When doing debugging dumps, suppress instruction numbers and address output. | |
| This makes it more feasible to use diff on debugging dumps for compiler | |
| invocations with different options, in particular with and without | |
| @option{-g}. | |
| @opindex fdump-unnumbered-links | |
| @opindex fno-dump-unnumbered-links | |
| @item -fdump-unnumbered-links | |
| When doing debugging dumps (see @option{-d} option above), suppress | |
| instruction numbers for the links to the previous and next instructions | |
| in a sequence. | |
| @opindex fdump-internal-locations | |
| @opindex fno-dump-internal-locations | |
| @item -fdump-internal-locations | |
| Dump detailed information about GCC's internal representation of source code | |
| locations. | |
| @opindex fdump-ipa | |
| @item -fdump-ipa-@var{switch} | |
| @itemx -fdump-ipa-@var{switch}-@var{options} | |
| Control the dumping at various stages of inter-procedural analysis | |
| language tree to a file. The file name is generated by appending a | |
| switch specific suffix to the source file name, and the file is created | |
| in the same directory as the output file. The following dumps are | |
| possible: | |
| @table @samp | |
| @item all | |
| Enables all inter-procedural analysis dumps. | |
| @item cgraph | |
| Dumps information about call-graph optimization, unused function removal, | |
| and inlining decisions. | |
| @item inline | |
| Dump after function inlining. | |
| @item strubm | |
| Dump after selecting @code{strub} modes, and recording the selections as | |
| function attributes. | |
| @item strub | |
| Dump @code{strub} transformations: interface changes, function wrapping, | |
| and insertion of builtin calls for stack scrubbing and watermarking. | |
| @end table | |
| Additionally, the options @option{-optimized}, @option{-missed}, | |
| @option{-note}, and @option{-all} can be provided, with the same meaning | |
| as for @option{-fopt-info}, defaulting to @option{-optimized}. | |
| For example, @option{-fdump-ipa-inline-optimized-missed} will emit | |
| information on callsites that were inlined, along with callsites | |
| that were not inlined. | |
| By default, the dump will contain messages about successful | |
| optimizations (equivalent to @option{-optimized}) together with | |
| low-level details about the analysis. | |
| @opindex fdump-ipa-clones | |
| @item -fdump-ipa-clones | |
| Create a dump file containing information about creation of call graph | |
| node clones and removals of call graph nodes during inter-procedural | |
| optimizations and transformations. Its main intended use is that tools | |
| that create live-patches can determine the set of functions that need to | |
| be live-patched to completely replace a particular function (see | |
| @option{-flive-patching}). The file name is generated by appending | |
| suffix @code{ipa-clones} to the source file name, and the file is | |
| created in the same directory as the output file. Each entry in the | |
| file is on a separate line containing semicolon separated fields. | |
| In the case of call graph clone creation, the individual fields are: | |
| @enumerate | |
| @item | |
| String @code{Callgraph clone}. | |
| @item | |
| Name of the function being cloned as it is presented to the assembler. | |
| @item | |
| A number that uniquely represents the function being cloned in the call | |
| graph. Note that the number is unique only within a compilation unit or | |
| within whole-program analysis but is likely to be different in the two | |
| phases. | |
| @item | |
| The file name of the source file where the function is defined. | |
| @item | |
| The line on which the function definition is located. | |
| @item | |
| The column where the function definition is located. | |
| @item | |
| Name of the new function clone as it is presented to the assembler. | |
| @item | |
| A number that uniquely represents the new function clone in the call | |
| graph. Note that the number is unique only within a compilation unit or | |
| within whole-program analysis but is likely to be different in the two | |
| phases. | |
| @item | |
| The file name of the source file where the source code location of the | |
| new clone points to. | |
| @item | |
| The line to which the source code location of the new clone points to. | |
| @item | |
| The column to which the source code location of the new clone points to. | |
| @item | |
| A string that determines the reason for cloning. | |
| @end enumerate | |
| In the case of call graph clone removal, the individual fields are: | |
| @enumerate | |
| @item | |
| String @code{Callgraph removal}. | |
| @item | |
| Name of the function being removed as it would be presented to the assembler. | |
| @item | |
| A number that uniquely represents the function being cloned in the call | |
| graph. Note that the number is unique only within a compilation unit or | |
| within whole-program analysis but is likely to be different in the two | |
| phases. | |
| @item | |
| The file name of the source file where the function is defined. | |
| @item | |
| The line on which the function definition is located. | |
| @item | |
| The column where the function definition is located. | |
| @end enumerate | |
| @opindex fdump-lang | |
| @item -fdump-lang | |
| Dump language-specific information. The file name is made by appending | |
| @file{.lang} to the source file name. | |
| @opindex fdump-lang-all | |
| @opindex fdump-lang | |
| @item -fdump-lang-all | |
| @itemx -fdump-lang-@var{switch} | |
| @itemx -fdump-lang-@var{switch}-@var{options} | |
| @itemx -fdump-lang-@var{switch}-@var{options}=@var{filename} | |
| Control the dumping of language-specific information. The @var{options} | |
| and @var{filename} portions behave as described in the | |
| @option{-fdump-tree} option. @option{-fdump-tree-all} enables all | |
| language-specific dumps; other options vary with the language. For | |
| instance, see @xref{C++ Dialect Options} for the @option{-fdump-lang} | |
| flags supported by the C++ front-end. | |
| @opindex fdump-passes | |
| @opindex fno-dump-passes | |
| @item -fdump-passes | |
| Print on @file{stderr} the list of optimization passes that are turned | |
| on and off by the current command-line options. | |
| @opindex fdump-statistics | |
| @item -fdump-statistics-@var{option} | |
| Enable and control dumping of pass statistics in a separate file. The | |
| file name is generated by appending a suffix ending in | |
| @samp{.statistics} to the source file name, and the file is created in | |
| the same directory as the output file. If the @samp{-@var{option}} | |
| form is used, @samp{-stats} causes counters to be summed over the | |
| whole compilation unit while @samp{-details} dumps every event as | |
| the passes generate them. The default with no option is to sum | |
| counters for each function compiled. | |
| @opindex fdump-tree-all | |
| @opindex fdump-tree | |
| @item -fdump-tree-all | |
| @itemx -fdump-tree-@var{switch} | |
| @itemx -fdump-tree-@var{switch}-@var{options} | |
| @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename} | |
| Control the dumping at various stages of processing the intermediate | |
| language tree to a file. If the @samp{-@var{options}} | |
| form is used, @var{options} is a list of @samp{-} separated options | |
| which control the details of the dump. Not all options are applicable | |
| to all dumps; those that are not meaningful are ignored. The | |
| following options are available | |
| @table @samp | |
| @item address | |
| Print the address of each node. Usually this is not meaningful as it | |
| changes according to the environment and source file. Its primary use | |
| is for tying up a dump file with a debug environment. | |
| @item asmname | |
| If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that | |
| in the dump instead of @code{DECL_NAME}. Its primary use is ease of | |
| use working backward from mangled names in the assembly file. | |
| @item slim | |
| When dumping front-end intermediate representations, inhibit dumping | |
| of members of a scope or body of a function merely because that scope | |
| has been reached. Only dump such items when they are directly reachable | |
| by some other path. | |
| When dumping pretty-printed trees, this option inhibits dumping the | |
| bodies of control structures. | |
| When dumping RTL, print the RTL in slim (condensed) form instead of | |
| the default LISP-like representation. | |
| @item raw | |
| Print a raw representation of the tree. By default, trees are | |
| pretty-printed into a C-like representation. | |
| @item details | |
| Enable more detailed dumps (not honored by every dump option). Also | |
| include information from the optimization passes. | |
| @item stats | |
| Enable dumping various statistics about the pass (not honored by every dump | |
| option). | |
| @item blocks | |
| Enable showing basic block boundaries (disabled in raw dumps). | |
| @item graph | |
| For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}), | |
| dump a representation of the control flow graph suitable for viewing with | |
| GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}. Each function in | |
| the file is pretty-printed as a subgraph, so that GraphViz can render them | |
| all in a single plot. | |
| RTL is always dumped in slim form. | |
| @item vops | |
| Enable showing virtual operands for every statement. | |
| @item lineno | |
| Enable showing line numbers for statements. | |
| @item uid | |
| Enable showing the unique ID (@code{DECL_UID}) for each variable. | |
| @item verbose | |
| Enable showing the tree dump for each statement. | |
| @item eh | |
| Enable showing the EH region number holding each statement. | |
| @item scev | |
| Enable showing scalar evolution analysis details. | |
| @item optimized | |
| Enable showing optimization information (only available in certain | |
| passes). | |
| @item missed | |
| Enable showing missed optimization information (only available in certain | |
| passes). | |
| @item note | |
| Enable other detailed optimization information (only available in | |
| certain passes). | |
| @item folding | |
| Enable dumping information about match-and-simplify (match.pd) patterns, | |
| when they are applied. | |
| @item all | |
| Turn on all options, except @option{raw}, @option{slim}, @option{verbose} | |
| and @option{lineno}. | |
| @item optall | |
| Turn on all optimization options, i.e., @option{optimized}, | |
| @option{missed}, and @option{note}. | |
| @end table | |
| To determine what tree dumps are available or find the dump for a pass | |
| of interest follow the steps below. | |
| @enumerate | |
| @item | |
| Invoke GCC with @option{-fdump-passes} and in the @file{stderr} output | |
| look for a code that corresponds to the pass you are interested in. | |
| For example, the codes @code{tree-evrp}, @code{tree-vrp1}, and | |
| @code{tree-vrp2} correspond to the three Value Range Propagation passes. | |
| The number at the end distinguishes distinct invocations of the same pass. | |
| @item | |
| To enable the creation of the dump file, append the pass code to | |
| the @option{-fdump-} option prefix and invoke GCC with it. For example, | |
| to enable the dump from the Early Value Range Propagation pass, invoke | |
| GCC with the @option{-fdump-tree-evrp} option. Optionally, you may | |
| specify the name of the dump file. If you don't specify one, GCC | |
| creates as described below. | |
| @item | |
| Find the pass dump in a file whose name is composed of three components | |
| separated by a period: the name of the source file GCC was invoked to | |
| compile, a numeric suffix indicating the pass number followed by the | |
| letter @samp{t} for tree passes (and the letter @samp{r} for RTL passes), | |
| and finally the pass code. For example, the Early VRP pass dump might | |
| be in a file named @file{myfile.c.038t.evrp} in the current working | |
| directory. Note that the numeric codes are not stable and may change | |
| from one version of GCC to another. | |
| @end enumerate | |
| @opindex fopt-info | |
| @opindex fno-opt-info | |
| @item -fopt-info | |
| @itemx -fopt-info-@var{options} | |
| @itemx -fopt-info-@var{options}=@var{filename} | |
| Controls optimization dumps from various optimization passes. If the | |
| @samp{-@var{options}} form is used, @var{options} is a list of | |
| @samp{-} separated option keywords to select the dump details and | |
| optimizations. | |
| The @var{options} can be divided into three groups: | |
| @enumerate | |
| @item | |
| options describing what kinds of messages should be emitted, | |
| @item | |
| options describing the verbosity of the dump, and | |
| @item | |
| options describing which optimizations should be included. | |
| @end enumerate | |
| The options from each group can be freely mixed as they are | |
| non-overlapping. However, in case of any conflicts, | |
| the later options override the earlier options on the command | |
| line. | |
| The following options control which kinds of messages should be emitted: | |
| @table @samp | |
| @item optimized | |
| Print information when an optimization is successfully applied. It is | |
| up to a pass to decide which information is relevant. For example, the | |
| vectorizer passes print the source location of loops which are | |
| successfully vectorized. | |
| @item missed | |
| Print information about missed optimizations. Individual passes | |
| control which information to include in the output. | |
| @item note | |
| Print verbose information about optimizations, such as certain | |
| transformations, more detailed messages about decisions etc. | |
| @item all | |
| Print detailed optimization information. This includes | |
| @samp{optimized}, @samp{missed}, and @samp{note}. | |
| @end table | |
| The following option controls the dump verbosity: | |
| @table @samp | |
| @item internals | |
| By default, only ``high-level'' messages are emitted. This option enables | |
| additional, more detailed, messages, which are likely to only be of interest | |
| to GCC developers. | |
| @end table | |
| One or more of the following option keywords can be used to describe a | |
| group of optimizations: | |
| @table @samp | |
| @item ipa | |
| Enable dumps from all interprocedural optimizations. | |
| @item loop | |
| Enable dumps from all loop optimizations. | |
| @item inline | |
| Enable dumps from all inlining optimizations. | |
| @item omp | |
| Enable dumps from all OMP (Offloading and Multi Processing) optimizations. | |
| @item vec | |
| Enable dumps from all vectorization optimizations. | |
| @item optall | |
| Enable dumps from all optimizations. This is a superset of | |
| the optimization groups listed above. | |
| @end table | |
| If @var{options} is | |
| omitted, it defaults to @samp{optimized-optall}, which means to dump messages | |
| about successful optimizations from all the passes, omitting messages | |
| that are treated as ``internals''. | |
| If the @var{filename} is provided, then the dumps from all the | |
| applicable optimizations are concatenated into the @var{filename}. | |
| Otherwise the dump is output onto @file{stderr}. Though multiple | |
| @option{-fopt-info} options are accepted, only one of them can include | |
| a @var{filename}. If other filenames are provided then all but the | |
| first such option are ignored. | |
| Note that the output @var{filename} is overwritten | |
| in case of multiple translation units. If a combined output from | |
| multiple translation units is desired, @file{stderr} should be used | |
| instead. | |
| In the following example, the optimization info is output to | |
| @file{stderr}: | |
| @smallexample | |
| gcc -O3 -fopt-info | |
| @end smallexample | |
| This example: | |
| @smallexample | |
| gcc -O3 -fopt-info-missed=missed.all | |
| @end smallexample | |
| @noindent | |
| outputs missed optimization report from all the passes into | |
| @file{missed.all}, and this one: | |
| @smallexample | |
| gcc -O2 -ftree-vectorize -fopt-info-vec-missed | |
| @end smallexample | |
| @noindent | |
| prints information about missed optimization opportunities from | |
| vectorization passes on @file{stderr}. | |
| Note that @option{-fopt-info-vec-missed} is equivalent to | |
| @option{-fopt-info-missed-vec}. The order of the optimization group | |
| names and message types listed after @option{-fopt-info} does not matter. | |
| As another example, | |
| @smallexample | |
| gcc -O3 -fopt-info-inline-optimized-missed=inline.txt | |
| @end smallexample | |
| @noindent | |
| outputs information about missed optimizations as well as | |
| optimized locations from all the inlining passes into | |
| @file{inline.txt}. | |
| Finally, consider: | |
| @smallexample | |
| gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt | |
| @end smallexample | |
| @noindent | |
| Here the two output filenames @file{vec.miss} and @file{loop.opt} are | |
| in conflict since only one output file is allowed. In this case, only | |
| the first option takes effect and the subsequent options are | |
| ignored. Thus only @file{vec.miss} is produced which contains | |
| dumps from the vectorizer about missed opportunities. | |
| @opindex fsave-optimization-record | |
| @opindex fno-save-optimization-record | |
| @item -fsave-optimization-record | |
| Write a SRCFILE.opt-record.json.gz file detailing what optimizations | |
| were performed, for those optimizations that support @option{-fopt-info}. | |
| This option is experimental and the format of the data within the | |
| compressed JSON file is subject to change. | |
| It is roughly equivalent to a machine-readable version of | |
| @option{-fopt-info-all}, as a collection of messages with source file, | |
| line number and column number, with the following additional data for | |
| each message: | |
| @itemize @bullet | |
| @item | |
| the execution count of the code being optimized, along with metadata about | |
| whether this was from actual profile data, or just an estimate, allowing | |
| consumers to prioritize messages by code hotness, | |
| @item | |
| the function name of the code being optimized, where applicable, | |
| @item | |
| the ``inlining chain'' for the code being optimized, so that when | |
| a function is inlined into several different places (which might | |
| themselves be inlined), the reader can distinguish between the copies, | |
| @item | |
| objects identifying those parts of the message that refer to expressions, | |
| statements or symbol-table nodes, which of these categories they are, and, | |
| when available, their source code location, | |
| @item | |
| the GCC pass that emitted the message, and | |
| @item | |
| the location in GCC's own code from which the message was emitted | |
| @end itemize | |
| Additionally, some messages are logically nested within other | |
| messages, reflecting implementation details of the optimization | |
| passes. | |
| @opindex fsched-verbose | |
| @item -fsched-verbose=@var{n} | |
| On targets that use instruction scheduling, this option controls the | |
| amount of debugging output the scheduler prints to the dump files. | |
| For @var{n} greater than zero, @option{-fsched-verbose} outputs the | |
| same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}. | |
| For @var{n} greater than one, it also output basic block probabilities, | |
| detailed ready list information and unit/insn info. For @var{n} greater | |
| than two, it includes RTL at abort point, control-flow and regions info. | |
| And for @var{n} over four, @option{-fsched-verbose} also includes | |
| dependence info. | |
| @opindex fdisable- | |
| @opindex fenable- | |
| @item -fenable-@var{kind}-@var{pass} | |
| @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list} | |
| This is a set of options that are used to explicitly disable/enable | |
| optimization passes. These options are intended for use for debugging GCC. | |
| Compiler users should use regular options for enabling/disabling | |
| passes instead. | |
| @table @gcctabopt | |
| @item -fdisable-ipa-@var{pass} | |
| Disable IPA pass @var{pass}. @var{pass} is the pass name. If the same pass is | |
| statically invoked in the compiler multiple times, the pass name should be | |
| appended with a sequential number starting from 1. | |
| @item -fdisable-rtl-@var{pass} | |
| @itemx -fdisable-rtl-@var{pass}=@var{range-list} | |
| Disable RTL pass @var{pass}. @var{pass} is the pass name. If the same pass is | |
| statically invoked in the compiler multiple times, the pass name should be | |
| appended with a sequential number starting from 1. @var{range-list} is a | |
| comma-separated list of function ranges or assembler names. Each range is a number | |
| pair separated by a colon. The range is inclusive in both ends. If the range | |
| is trivial, the number pair can be simplified as a single number. If the | |
| function's call graph node's @var{uid} falls within one of the specified ranges, | |
| the @var{pass} is disabled for that function. The @var{uid} is shown in the | |
| function header of a dump file, and the pass names can be dumped by using | |
| option @option{-fdump-passes}. | |
| @item -fdisable-tree-@var{pass} | |
| @itemx -fdisable-tree-@var{pass}=@var{range-list} | |
| Disable tree pass @var{pass}. See @option{-fdisable-rtl} for the description of | |
| option arguments. | |
| @item -fenable-ipa-@var{pass} | |
| Enable IPA pass @var{pass}. @var{pass} is the pass name. If the same pass is | |
| statically invoked in the compiler multiple times, the pass name should be | |
| appended with a sequential number starting from 1. | |
| @item -fenable-rtl-@var{pass} | |
| @itemx -fenable-rtl-@var{pass}=@var{range-list} | |
| Enable RTL pass @var{pass}. See @option{-fdisable-rtl} for option argument | |
| description and examples. | |
| @item -fenable-tree-@var{pass} | |
| @itemx -fenable-tree-@var{pass}=@var{range-list} | |
| Enable tree pass @var{pass}. See @option{-fdisable-rtl} for the description | |
| of option arguments. | |
| @end table | |
| Here are some examples showing uses of these options. | |
| @smallexample | |
| # disable ccp1 for all functions | |
| -fdisable-tree-ccp1 | |
| # disable complete unroll for function whose cgraph node uid is 1 | |
| -fenable-tree-cunroll=1 | |
| # disable gcse2 for functions at the following ranges [1,1], | |
| # [300,400], and [400,1000] | |
| # disable gcse2 for functions foo and foo2 | |
| -fdisable-rtl-gcse2=foo,foo2 | |
| # disable early inlining | |
| -fdisable-tree-einline | |
| # disable ipa inlining | |
| -fdisable-ipa-inline | |
| # enable tree full unroll | |
| -fenable-tree-unroll | |
| @end smallexample | |
| @opindex fchecking | |
| @opindex fno-checking | |
| @item -fchecking | |
| @itemx -fchecking=@var{n} | |
| Enable internal consistency checking. The default depends on | |
| the compiler configuration. @option{-fchecking=2} enables further | |
| internal consistency checking that might affect code generation. | |
| @opindex frandom-seed | |
| @opindex fno-random-seed | |
| @item -frandom-seed=@var{string} | |
| This option provides a seed that GCC uses in place of | |
| random numbers in generating certain symbol names | |
| that have to be different in every compiled file. It is also used to | |
| place unique stamps in coverage data files and the object files that | |
| produce them. You can use the @option{-frandom-seed} option to produce | |
| reproducibly identical object files. | |
| The @var{string} can either be a number (decimal, octal or hex) or an | |
| arbitrary string (in which case it's converted to a number by | |
| computing CRC32). | |
| The @var{string} should be different for every file you compile. | |
| @opindex save-temps | |
| @item -save-temps | |
| @itemx --save-temps | |
| Store the usual ``temporary'' intermediate files permanently; name them | |
| as auxiliary output files, as specified described under | |
| @option{-dumpbase} and @option{-dumpdir}. | |
| When used in combination with the @option{-x} command-line option, | |
| @option{-save-temps} is sensible enough to avoid overwriting an | |
| input source file with the same extension as an intermediate file. | |
| The corresponding intermediate file may be obtained by renaming the | |
| source file before using @option{-save-temps}. | |
| @opindex save-temps=cwd | |
| @item -save-temps=cwd | |
| Equivalent to @option{-save-temps -dumpdir ./}. | |
| @opindex save-temps=obj | |
| @item -save-temps=obj | |
| Equivalent to @option{-save-temps -dumpdir @file{outdir/}}, where | |
| @file{outdir/} is the directory of the output file specified after the | |
| @option{-o} option, including any directory separators. If the | |
| @option{-o} option is not used, the @option{-save-temps=obj} switch | |
| behaves like @option{-save-temps=cwd}. | |
| @opindex specs | |
| @item -specs=@var{file} | |
| @itemx --specs=@var{file} | |
| @itemx --specs @var{file} | |
| Process @var{file} after the compiler reads in the standard @file{specs} | |
| file, in order to override the defaults which the @command{gcc} driver | |
| program uses when determining what switches to pass to @command{cc1}, | |
| @command{cc1plus}, @command{as}, @command{ld}, etc. More than one | |
| @option{-specs=@var{file}} can be specified on the command line, and they | |
| are processed in order, from left to right. | |
| @xref{Spec Files,, Specifying Subprocesses and the Switches to Pass to Them, | |
| gccint, GNU Compiler Collection (GCC) Internals}, for | |
| information about the format of the @var{file}. | |
| @opindex time | |
| @item -time@r{[}=@var{file}@r{]} | |
| Report the CPU time taken by each subprocess in the compilation | |
| sequence. For C source files, this is the compiler proper and assembler | |
| (plus the linker if linking is done). | |
| Without the specification of an output file, the output looks like this: | |
| @smallexample | |
| # cc1 0.12 0.01 | |
| # as 0.00 0.01 | |
| @end smallexample | |
| The first number on each line is the ``user time'', that is time spent | |
| executing the program itself. The second number is ``system time'', | |
| time spent executing operating system routines on behalf of the program. | |
| Both numbers are in seconds. | |
| With the specification of an output file, the output is appended to the | |
| named file, and it looks like this: | |
| @smallexample | |
| 0.12 0.01 cc1 @var{options} | |
| 0.00 0.01 as @var{options} | |
| @end smallexample | |
| The ``user time'' and the ``system time'' are moved before the program | |
| name, and the options passed to the program are displayed, so that one | |
| can later tell what file was being compiled, and with which options. | |
| @opindex fdump-final-insns | |
| @item -fdump-final-insns@r{[}=@var{file}@r{]} | |
| Dump the final internal representation (RTL) to @var{file}. If the | |
| optional argument is omitted (or if @var{file} is @code{.}), the name | |
| of the dump file is determined by appending @code{.gkd} to the | |
| dump base name, see @option{-dumpbase}. | |
| @opindex fcompare-debug | |
| @opindex fno-compare-debug | |
| @item -fcompare-debug@r{[}=@var{opts}@r{]} | |
| If no error occurs during compilation, run the compiler a second time, | |
| adding @var{opts} and @option{-fcompare-debug-second} to the arguments | |
| passed to the second compilation. Dump the final internal | |
| representation in both compilations, and print an error if they differ. | |
| If the equal sign is omitted, the default @option{-gtoggle} is used. | |
| The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty | |
| and nonzero, implicitly enables @option{-fcompare-debug}. If | |
| @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash, | |
| then it is used for @var{opts}, otherwise the default @option{-gtoggle} | |
| is used. | |
| @option{-fcompare-debug=}, with the equal sign but without @var{opts}, | |
| is equivalent to @option{-fno-compare-debug}, which disables the dumping | |
| of the final representation and the second compilation, preventing even | |
| @env{GCC_COMPARE_DEBUG} from taking effect. | |
| To verify full coverage during @option{-fcompare-debug} testing, set | |
| @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden}, | |
| which GCC rejects as an invalid option in any actual compilation | |
| (rather than preprocessing, assembly or linking). To get just a | |
| warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug | |
| not overridden} will do. | |
| @opindex fcompare-debug-second | |
| @item -fcompare-debug-second | |
| This option is implicitly passed to the compiler for the second | |
| compilation requested by @option{-fcompare-debug}, along with options to | |
| silence warnings, and omitting other options that would cause the compiler | |
| to produce output to files or to standard output as a side effect. Dump | |
| files and preserved temporary files are renamed so as to contain the | |
| @code{.gk} additional extension during the second compilation, to avoid | |
| overwriting those generated by the first. | |
| When this option is passed to the compiler driver, it causes the | |
| @emph{first} compilation to be skipped, which makes it useful for little | |
| other than debugging the compiler proper. | |
| @opindex gtoggle | |
| @item -gtoggle | |
| Turn off generation of debug info, if leaving out this option | |
| generates it, or turn it on at level 2 otherwise. The position of this | |
| argument in the command line does not matter; it takes effect after all | |
| other options are processed, and it does so only once, no matter how | |
| many times it is given. This is mainly intended to be used with | |
| @option{-fcompare-debug}. | |
| @opindex fvar-tracking-assignments-toggle | |
| @opindex fno-var-tracking-assignments-toggle | |
| @item -fvar-tracking-assignments-toggle | |
| Toggle @option{-fvar-tracking-assignments}, in the same way that | |
| @option{-gtoggle} toggles @option{-g}. | |
| @opindex Q | |
| @item -Q | |
| When used on the command line prior to @option{--help=}, @option{-Q} | |
| acts as a modifier to the help output. @xref{Overall Options}, | |
| for details about @option{--help=}. | |
| Otherwise, this option makes the compiler print out each function name | |
| as it is compiled, and print some statistics about each pass when it | |
| finishes. | |
| @opindex ftime-report | |
| @opindex fno-time-report | |
| @item -ftime-report | |
| Makes the compiler print some statistics to stderr about the time consumed | |
| by each pass when it finishes. | |
| If SARIF output of diagnostics was requested via | |
| @option{-fdiagnostics-format=sarif-file} or | |
| @option{-fdiagnostics-format=sarif-stderr} then the @option{-ftime-report} | |
| information is instead emitted in JSON form as part of SARIF output. The | |
| precise format of this JSON data is subject to change, and the values may | |
| not exactly match those emitted to stderr due to being written out at a | |
| slightly different place within the compiler. | |
| @opindex ftime-report-details | |
| @opindex fno-time-report-details | |
| @item -ftime-report-details | |
| Record the time consumed by infrastructure parts separately for each pass. | |
| @opindex fira-verbose | |
| @item -fira-verbose=@var{n} | |
| Control the verbosity of the dump file for the integrated register allocator. | |
| The default value is 5. If the value @var{n} is greater or equal to 10, | |
| the dump output is sent to stderr using the same format as @var{n} minus 10. | |
| @opindex flto-report | |
| @opindex fno-lto-report | |
| @item -flto-report | |
| Prints a report with internal details on the workings of the link-time | |
| optimizer. The contents of this report vary from version to version. | |
| It is meant to be useful to GCC developers when processing object | |
| files in LTO mode (via @option{-flto}). | |
| Disabled by default. | |
| @opindex flto-report-wpa | |
| @opindex fno-lto-report-wpa | |
| @item -flto-report-wpa | |
| Like @option{-flto-report}, but only print for the WPA phase of link-time | |
| optimization. | |
| @opindex fmem-report | |
| @opindex fno-mem-report | |
| @item -fmem-report | |
| Makes the compiler print some statistics about permanent memory | |
| allocation when it finishes. | |
| @opindex fmem-report-wpa | |
| @opindex fno-mem-report-wpa | |
| @item -fmem-report-wpa | |
| Makes the compiler print some statistics about permanent memory | |
| allocation for the WPA phase only. | |
| @opindex fpre-ipa-mem-report | |
| @opindex fno-pre-ipa-mem-report | |
| @opindex fpost-ipa-mem-report | |
| @opindex fno-post-ipa-mem-report | |
| @item -fpre-ipa-mem-report | |
| @item -fpost-ipa-mem-report | |
| Makes the compiler print some statistics about permanent memory | |
| allocation before or after interprocedural optimization. | |
| @opindex fmultiflags | |
| @item -fmultiflags | |
| This option enables multilib-aware @code{TFLAGS} to be used to build | |
| target libraries with options different from those the compiler is | |
| configured to use by default, through the use of specs | |
| (@pxref{Spec Files,, Specifying Subprocesses and the Switches to Pass to Them, | |
| gccint, GNU Compiler Collection (GCC) Internals}) | |
| set up by compiler internals, by the target, or by builders at | |
| configure time. | |
| Like @code{TFLAGS}, this allows the target libraries to be built for | |
| portable baseline environments, while the compiler defaults to more | |
| demanding ones. That's useful because users can easily override the | |
| defaults the compiler is configured to use to build their own programs, | |
| if the defaults are not ideal for their target environment, whereas | |
| rebuilding the runtime libraries is usually not as easy or desirable. | |
| Unlike @code{TFLAGS}, the use of specs enables different flags to be | |
| selected for different multilibs. The way to accomplish that is to | |
| build with @samp{make TFLAGS=-fmultiflags}, after configuring | |
| @samp{--with-specs=%@{fmultiflags:...@}}. | |
| This option is discarded by the driver once it's done processing driver | |
| self spec. | |
| It is also useful to check that @code{TFLAGS} are being used to build | |
| all target libraries, by configuring a non-bootstrap compiler | |
| @samp{--with-specs='%@{!fmultiflags:%emissing TFLAGS@}'} and building | |
| the compiler and target libraries. | |
| @opindex fprofile-report | |
| @opindex fno-profile-report | |
| @item -fprofile-report | |
| Makes the compiler print some statistics about consistency of the | |
| (estimated) profile and effect of individual passes. | |
| @opindex fstack-usage | |
| @item -fstack-usage | |
| Makes the compiler output stack usage information for the program, on a | |
| per-function basis. The filename for the dump is made by appending | |
| @file{.su} to the @var{auxname}. @var{auxname} is generated from the name of | |
| the output file, if explicitly specified and it is not an executable, | |
| otherwise it is the basename of the source file. An entry is made up | |
| of four fields separated by tabulation characters: | |
| @itemize | |
| @item | |
| The name of the function preceded by its source location | |
| @item | |
| The mangled name of the function | |
| @item | |
| A number of bytes | |
| @item | |
| One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded} | |
| @end itemize | |
| The qualifier @code{static} means that the function manipulates the stack | |
| statically: a fixed number of bytes are allocated for the frame on function | |
| entry and released on function exit; no stack adjustments are otherwise made | |
| in the function. The second field is this fixed number of bytes. | |
| The qualifier @code{dynamic} means that the function manipulates the stack | |
| dynamically: in addition to the static allocation described above, stack | |
| adjustments are made in the body of the function, for example to push/pop | |
| arguments around function calls. If the qualifier @code{bounded} is also | |
| present, the amount of these adjustments is bounded at compile time and | |
| the second field is an upper bound of the total amount of stack used by | |
| the function. If it is not present, the amount of these adjustments is | |
| not bounded at compile time and the second field only represents the | |
| bounded part. | |
| @opindex fstats | |
| @opindex fno-stats | |
| @item -fstats | |
| Emit statistics about front-end processing at the end of the compilation. | |
| This option is supported only by the C++ front end, and | |
| the information is generally only useful to the G++ development team. | |
| @opindex fdbg-cnt-list | |
| @opindex fno-dbg-cnt-list | |
| @item -fdbg-cnt-list | |
| Print the name and the counter upper bound for all debug counters. | |
| @opindex fdbg-cnt | |
| @item -fdbg-cnt=@var{counter-value-list} | |
| Set the internal debug counter lower and upper bound. @var{counter-value-list} | |
| is a comma-separated list of @var{name}:@var{lower_bound1}-@var{upper_bound1} | |
| [:@var{lower_bound2}-@var{upper_bound2}...] tuples which sets | |
| the name of the counter and list of closed intervals. | |
| The @var{lower_bound} is optional and is zero | |
| initialized if not set. | |
| For example, with @option{-fdbg-cnt=dce:2-4:10-11,tail_call:10}, | |
| @code{dbg_cnt(dce)} returns true only for second, third, fourth, tenth and | |
| eleventh invocation. | |
| For @code{dbg_cnt(tail_call)} true is returned for first 10 invocations. | |
| @opindex print-autofdo-gcov-version | |
| @item -print-autofdo-gcov-version | |
| @itemx --print-autofdo-gcov-version | |
| Print the current version of GCOV being used by the AutoFDO infrastructure. | |
| @opindex print-file-name | |
| @item -print-file-name=@var{library} | |
| @itemx --print-file-name=@var{library} | |
| @itemx --print-file-name @var{library} | |
| Print the full absolute name of the library file @var{library} that | |
| would be used when linking---and don't do anything else. With this | |
| option, GCC does not compile or link anything; it just prints the | |
| file name. | |
| @opindex print-multi-directory | |
| @item -print-multi-directory | |
| @itemx --print-multi-directory | |
| Print the directory name corresponding to the multilib selected by any | |
| other switches present in the command line. This directory is supposed | |
| to exist in @env{GCC_EXEC_PREFIX}. | |
| @opindex print-multi-lib | |
| @item -print-multi-lib | |
| @itemx --print-multi-lib | |
| Print the mapping from multilib directory names to compiler switches | |
| that enable them. The directory name is separated from the switches by | |
| @samp{;}, and each switch starts with an @samp{@@} instead of the | |
| @samp{-}, without spaces between multiple switches. This is supposed to | |
| ease shell processing. | |
| @opindex print-multi-os-directory | |
| @item -print-multi-os-directory | |
| @itemx --print-multi-os-directory | |
| Print the path to OS libraries for the selected | |
| multilib, relative to some @file{lib} subdirectory. If OS libraries are | |
| present in the @file{lib} subdirectory and no multilibs are used, this is | |
| usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}} | |
| sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or | |
| @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}} | |
| subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}. | |
| @opindex print-multiarch | |
| @item -print-multiarch | |
| @itemx --print-multiarch | |
| Print the path to OS libraries for the selected multiarch, | |
| relative to some @file{lib} subdirectory. | |
| @opindex print-prog-name | |
| @item -print-prog-name=@var{program} | |
| @itemx --print-prog-name=@var{program} | |
| @itemx --print-prog-name @var{program} | |
| Like @option{-print-file-name}, but searches for a program such as @command{cpp}. | |
| @opindex print-libgcc-file-name | |
| @item -print-libgcc-file-name | |
| @itemx --print-libgcc-file-name | |
| Same as @option{-print-file-name=libgcc.a}. | |
| This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs} | |
| but you do want to link with @file{libgcc.a}. You can do: | |
| @smallexample | |
| gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name` | |
| @end smallexample | |
| @opindex print-search-dirs | |
| @item -print-search-dirs | |
| @itemx --print-search-dirs | |
| Print the name of the configured installation directory and a list of | |
| program and library directories @command{gcc} searches---and don't do anything else. | |
| This is useful when @command{gcc} prints the error message | |
| @samp{installation problem, cannot exec cpp0: No such file or directory}. | |
| To resolve this you either need to put @file{cpp0} and the other compiler | |
| components where @command{gcc} expects to find them, or you can set the environment | |
| variable @env{GCC_EXEC_PREFIX} to the directory where you installed them. | |
| Don't forget the trailing @samp{/}. | |
| @xref{Environment Variables}. | |
| @opindex print-sysroot | |
| @item -print-sysroot | |
| @itemx --print-sysroot | |
| Print the target sysroot directory that is used during | |
| compilation. This is the target sysroot specified either at configure | |
| time or using the @option{--sysroot} option, possibly with an extra | |
| suffix that depends on compilation options. If no target sysroot is | |
| specified, the option prints nothing. | |
| @opindex print-sysroot-headers-suffix | |
| @item -print-sysroot-headers-suffix | |
| @itemx --print-sysroot-headers-suffix | |
| Print the suffix added to the target sysroot when searching for | |
| headers, or give an error if the compiler is not configured with such | |
| a suffix---and don't do anything else. | |
| @opindex dumpmachine | |
| @item -dumpmachine | |
| Print the compiler's target machine (for example, | |
| @samp{i686-pc-linux-gnu})---and don't do anything else. | |
| @opindex dumpversion | |
| @item -dumpversion | |
| Print the compiler version (for example, @code{3.0}, @code{6.3.0} or @code{7})---and don't do | |
| anything else. This is the compiler version used in filesystem paths and | |
| specs. Depending on how the compiler has been configured it can be just | |
| a single number (major version), two numbers separated by a dot (major and | |
| minor version) or three numbers separated by dots (major, minor and patchlevel | |
| version). | |
| @opindex dumpfullversion | |
| @item -dumpfullversion | |
| Print the full compiler version---and don't do anything else. The output is | |
| always three numbers separated by dots, major, minor and patchlevel version. | |
| @opindex dumpspecs | |
| @item -dumpspecs | |
| Print the compiler's built-in specs---and don't do anything else. (This | |
| is used when GCC itself is being built.) | |
| @xref{Spec Files,, Specifying Subprocesses and the Switches to Pass to Them, | |
| gccint, GNU Compiler Collection (GCC) Internals}. | |
| @opindex param | |
| @item --param @var{name}=@var{value} | |
| @itemx --param=@var{name}=@var{value} | |
| GCC by convention uses parameters that can be specified on the command | |
| line instead of hard-wired constants to represent arbitrary compiler | |
| limits or heuristics. Many parameters are related to optimization; | |
| for example, GCC does not inline functions that contain more than a | |
| certain number of instructions. The static analyzer similarly uses | |
| parameters to limit complexity, link-time optimization uses parameters | |
| to control partitioning, and so on. Other parameters control aspects | |
| of GCC that are completely internal, such as its memory allocation and | |
| garbage collection strategy. Still others control target-specific | |
| behavior. | |
| The @option{--param} option provides a uniform interface for | |
| specifying values for these compiler parameters. However, the names | |
| of specific parameters, and the meaning of the values, are tied to the | |
| internals of the compiler, and are subject to change without notice in | |
| future releases. You should not depend on parameter settings for | |
| correct compilation of your program. They are exposed via the command | |
| line for the convenience of developers in debugging compilation | |
| problems or, in some cases, to provide workarounds for compiler bugs. | |
| @xref{Parameters,,Parameters,gccint,GNU Compiler Collection (GCC) Internals}, | |
| for documentation of these internal parameters. | |
| @end table | |
| @node Target-Specific Options | |
| @anchor{Submodel Options} | |
| @section Target-Specific Options | |
| @cindex submodel options | |
| @cindex hardware-specific options | |
| @cindex target-specific options | |
| @cindex machine-specific options | |
| @cindex architecture-specific options | |
| @cindex operating-system-specific options | |
| Each target machine supported by GCC can have its own options---for | |
| example, to allow you to compile for a particular processor variant or | |
| ABI, or to control optimizations specific to that machine. Similarly, | |
| GCC also has options that are specific to particular operating systems | |
| or runtime environments on the target. | |
| By convention, the names of machine-specific options start with | |
| @samp{-m}. Some configurations of the compiler also support | |
| additional target-specific options, usually for compatibility with | |
| other compilers on the same platform. | |
| @c This list is ordered alphanumerically by subsection name. | |
| @c It should be the same order and spelling as these options are listed | |
| @c in Target-Specific Options | |
| @menu | |
| * AArch64 Options:: | |
| * Adapteva Epiphany Options:: | |
| * AMD GCN Options:: | |
| * ARC Options:: | |
| * ARM Options:: | |
| * AVR Options:: | |
| * Blackfin Options:: | |
| * C6X Options:: | |
| * CRIS Options:: | |
| * C-SKY Options:: | |
| * Cygwin and MinGW Options:: | |
| * Darwin Options:: | |
| * DEC Alpha Options:: | |
| * eBPF Options:: | |
| * FR30 Options:: | |
| * FRV Options:: | |
| * FT32 Options:: | |
| * GNU/Linux Options:: | |
| * H8/300 Options:: | |
| * HPPA Options:: | |
| * IA-64 Options:: | |
| * LM32 Options:: | |
| * LoongArch Options:: | |
| * LynxOS Options:: | |
| * M32R/D Options:: | |
| * M680x0 Options:: | |
| * MCore Options:: | |
| * MicroBlaze Options:: | |
| * MIPS Options:: | |
| * MMIX Options:: | |
| * MN10300 Options:: | |
| * Moxie Options:: | |
| * MSP430 Options:: | |
| * NDS32 Options:: | |
| * Nvidia PTX Options:: | |
| * OpenRISC Options:: | |
| * PDP-11 Options:: | |
| * Picolibc Options:: | |
| * PowerPC Options:: | |
| * PRU Options:: | |
| * RISC-V Options:: | |
| * RL78 Options:: | |
| * RS/6000 and PowerPC Options:: | |
| * RX Options:: | |
| * S/390 and zSeries Options:: | |
| * SH Options:: | |
| * Solaris 2 Options:: | |
| * SPARC Options:: | |
| * System V Options:: | |
| * V850 Options:: | |
| * VAX Options:: | |
| * Visium Options:: | |
| * VMS Options:: | |
| * VxWorks Options:: | |
| * x86 Options:: | |
| * x86 Windows Options:: | |
| * Xstormy16 Options:: | |
| * Xtensa Options:: | |
| * zSeries Options:: | |
| @end menu | |
| @node AArch64 Options | |
| @subsection AArch64 Options | |
| @cindex AArch64 Options | |
| These options are defined for AArch64 implementations: | |
| @table @gcctabopt | |
| @opindex mabi | |
| @item -mabi=@var{name} | |
| Generate code for the specified data model. Permissible values | |
| are @samp{ilp32} for SysV-like data model where int, long int and pointers | |
| are 32 bits, and @samp{lp64} for SysV-like data model where int is 32 bits, | |
| but long int and pointers are 64 bits. | |
| The default depends on the specific target configuration. Note that | |
| the LP64 and ILP32 ABIs are not link-compatible; you must compile your | |
| entire program with the same ABI, and link with a compatible set of libraries. | |
| The @samp{ilp32} model is deprecated. | |
| @opindex mbig-endian | |
| @item -mbig-endian | |
| Generate big-endian code. This is the default when GCC is configured for an | |
| @samp{aarch64_be-*-*} target. | |
| @opindex mlittle-endian | |
| @item -mlittle-endian | |
| Generate little-endian code. This is the default when GCC is configured for an | |
| @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target. | |
| @opindex menable-sysreg-checking | |
| @item -menable-sysreg-checking | |
| Generates an error message if an attempt is made to access a system register | |
| which is not available on the target architecture. | |
| @opindex mgeneral-regs-only | |
| @item -mgeneral-regs-only | |
| Generate code that uses only the general-purpose registers. This prevents | |
| the compiler from using floating-point and Advanced SIMD registers but does not | |
| impose any restrictions on the assembler. | |
| @opindex mcmodel= | |
| @opindex mcmodel=tiny | |
| @item -mcmodel=tiny | |
| Generate code for the tiny code model. The program and its statically defined | |
| symbols must be within 1MB of each other. Programs can be statically or | |
| dynamically linked. | |
| @opindex mcmodel=small | |
| @item -mcmodel=small | |
| Generate code for the small code model. The program and its statically defined | |
| symbols must be within 4GB of each other. Programs can be statically or | |
| dynamically linked. This is the default code model. | |
| @opindex mcmodel=large | |
| @item -mcmodel=large | |
| Generate code for the large code model. This allows large @code{.bss} | |
| and @code{.data} sections, whereas @code{.text} and @code{.rodata} | |
| must still be < 2GiB in total. | |
| The @option{-moutline-atomics} is turned off by default. Static linking | |
| with small/tiny model object files is not supported. | |
| @item -mtp=@var{name} | |
| @opindex mtp | |
| Specify the system register to use as a thread pointer. The valid values | |
| are @samp{tpidr_el0}, @samp{tpidrro_el0}, @samp{tpidr_el1}, @samp{tpidr_el2}, | |
| @samp{tpidr_el3}. For backwards compatibility the aliases @samp{el0}, | |
| @samp{el1}, @samp{el2}, @samp{el3} are also accepted. | |
| The default setting is @samp{tpidr_el0}. It is recommended to compile all | |
| code intended to interoperate with the same value of this option to avoid | |
| accessing a different thread pointer from the wrong exception level. | |
| @opindex mstrict-align | |
| @opindex mno-strict-align | |
| @item -mstrict-align | |
| @itemx -mno-strict-align | |
| Avoid or allow generating memory accesses that may not be aligned on a natural | |
| object boundary as described in the architecture specification. | |
| @opindex momit-leaf-frame-pointer | |
| @opindex mno-omit-leaf-frame-pointer | |
| @item -momit-leaf-frame-pointer | |
| @itemx -mno-omit-leaf-frame-pointer | |
| Omit or keep the frame pointer in leaf functions. The former behavior is the | |
| default. | |
| @opindex mstack-protector-guard | |
| @opindex mstack-protector-guard-reg | |
| @opindex mstack-protector-guard-offset | |
| @item -mstack-protector-guard=@var{guard} | |
| @itemx -mstack-protector-guard-reg=@var{reg} | |
| @itemx -mstack-protector-guard-offset=@var{offset} | |
| Generate stack protection code using canary at @var{guard}. Supported | |
| locations are @samp{global} for a global canary or @samp{sysreg} for a | |
| canary in an appropriate system register. | |
| With the latter choice the options | |
| @option{-mstack-protector-guard-reg=@var{reg}} and | |
| @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify | |
| which system register to use as base register for reading the canary, | |
| and from what offset from that base register. There is no default | |
| register or offset as this is entirely for use within the Linux | |
| kernel. | |
| @opindex mtls-dialect=desc | |
| @item -mtls-dialect=desc | |
| Use TLS descriptors as the thread-local storage mechanism for dynamic accesses | |
| of TLS variables. This is the default. | |
| @opindex mtls-dialect=traditional | |
| @item -mtls-dialect=traditional | |
| Use traditional TLS as the thread-local storage mechanism for dynamic accesses | |
| of TLS variables. | |
| @opindex mtls-size | |
| @item -mtls-size=@var{size} | |
| Specify bit size of immediate TLS offsets. Valid values are 12, 24, 32, 48. | |
| This option requires binutils 2.26 or newer. | |
| @opindex mfix-cortex-a53-835769 | |
| @opindex mno-fix-cortex-a53-835769 | |
| @item -mfix-cortex-a53-835769 | |
| @itemx -mno-fix-cortex-a53-835769 | |
| Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769. | |
| This involves inserting a NOP instruction between memory instructions and | |
| 64-bit integer multiply-accumulate instructions. This flag will be ignored if | |
| an architecture or CPU is specified on the command line which does not need the | |
| workaround. | |
| @opindex mfix-cortex-a53-843419 | |
| @opindex mno-fix-cortex-a53-843419 | |
| @item -mfix-cortex-a53-843419 | |
| @itemx -mno-fix-cortex-a53-843419 | |
| Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419. | |
| This erratum workaround is made at link time and this will only pass the | |
| corresponding flag to the linker. This flag will be ignored if | |
| an architecture or CPU is specified on the command line which does not need the | |
| workaround. | |
| @opindex mlow-precision-recip-sqrt | |
| @opindex mno-low-precision-recip-sqrt | |
| @item -mlow-precision-recip-sqrt | |
| @itemx -mno-low-precision-recip-sqrt | |
| Enable or disable the reciprocal square root approximation. | |
| This option only has an effect if @option{-ffast-math} or | |
| @option{-funsafe-math-optimizations} is used as well. Enabling this reduces | |
| precision of reciprocal square root results to about 16 bits for | |
| single precision and to 32 bits for double precision. | |
| @opindex mlow-precision-sqrt | |
| @opindex mno-low-precision-sqrt | |
| @item -mlow-precision-sqrt | |
| @itemx -mno-low-precision-sqrt | |
| Enable or disable the square root approximation. | |
| This option only has an effect if @option{-ffast-math} or | |
| @option{-funsafe-math-optimizations} is used as well. Enabling this reduces | |
| precision of square root results to about 16 bits for | |
| single precision and to 32 bits for double precision. | |
| If enabled, it implies @option{-mlow-precision-recip-sqrt}. | |
| @opindex mlow-precision-div | |
| @opindex mno-low-precision-div | |
| @item -mlow-precision-div | |
| @itemx -mno-low-precision-div | |
| Enable or disable the division approximation. | |
| This option only has an effect if @option{-ffast-math} or | |
| @option{-funsafe-math-optimizations} is used as well. Enabling this reduces | |
| precision of division results to about 16 bits for | |
| single precision and to 32 bits for double precision. | |
| @opindex mtrack-speculation | |
| @opindex mno-track-speculation | |
| @item -mtrack-speculation | |
| @itemx -mno-track-speculation | |
| Enable or disable generation of additional code to track speculative | |
| execution through conditional branches. The tracking state can then | |
| be used by the compiler when expanding calls to | |
| @code{__builtin_speculation_safe_value} to permit a more efficient code | |
| sequence to be generated. | |
| @opindex moutline-atomics | |
| @opindex mno-outline-atomics | |
| @item -moutline-atomics | |
| @itemx -mno-outline-atomics | |
| Enable or disable calls to out-of-line helpers to implement atomic operations. | |
| These helpers will, at runtime, determine if the LSE instructions from | |
| ARMv8.1-A can be used; if not, they will use the load/store-exclusive | |
| instructions that are present in the base ARMv8.0 ISA. | |
| This option is only applicable when compiling for the base ARMv8.0 | |
| instruction set. If using a later revision, e.g. @option{-march=armv8.1-a} | |
| or @option{-march=armv8-a+lse}, the ARMv8.1-Atomics instructions will be | |
| used directly. The same applies when using @option{-mcpu=} when the | |
| selected CPU supports the @samp{lse} feature. | |
| This option is on by default. | |
| @opindex mmax-vectorization | |
| @opindex mno-max-vectorization | |
| @item -mmax-vectorization | |
| @itemx -mno-max-vectorization | |
| Enable or disable an override to vectorizer cost model making vectorization | |
| always appear profitable. This option can be combined with | |
| @option{-mautovec-preference} allowing precise control over which ISA will be | |
| used for auto-vectorization. Unlike @option{-fno-vect-cost-model} or | |
| @option{-fvect-cost-model=unlimited} this option does not turn off cost | |
| comparison between different vector modes. | |
| @opindex mautovec-preference | |
| @item -mautovec-preference=@var{name} | |
| Force an ISA selection strategy for auto-vectorization. The possible | |
| values of @var{name} are: | |
| @table @samp | |
| @item default | |
| Use the default heuristics. | |
| @item asimd-only | |
| Use only Advanced SIMD for auto-vectorization. | |
| @item sve-only | |
| Use only SVE for auto-vectorization. | |
| @item prefer-asimd | |
| Use both Advanced SIMD and SVE. Prefer Advanced SIMD when the costs are | |
| deemed equal. | |
| @item prefer-sve | |
| Use both Advanced SIMD and SVE. Prefer SVE when the costs are deemed equal. | |
| @end table | |
| For best performance it is highly recommended to use @option{-mcpu} or | |
| @option{-mtune} instead. This parameter should only be used for code | |
| exploration. | |
| @opindex march | |
| @item -march=@var{name} | |
| Specify the name of the target architecture and, optionally, one or | |
| more feature modifiers. This option has the form | |
| @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}. | |
| The table below summarizes the permissible values for @var{arch} | |
| and the features that they enable by default: | |
| @multitable @columnfractions 0.20 0.20 0.60 | |
| @headitem @var{arch} value @tab Architecture @tab Includes by default | |
| @item @samp{armv8-a} @tab Armv8-A @tab @samp{+fp}, @samp{+simd} | |
| @item @samp{armv8.1-a} @tab Armv8.1-A @tab @samp{armv8-a}, @samp{+crc}, @samp{+lse}, @samp{+rdma} | |
| @item @samp{armv8.2-a} @tab Armv8.2-A @tab @samp{armv8.1-a} | |
| @item @samp{armv8.3-a} @tab Armv8.3-A @tab @samp{armv8.2-a}, @samp{+pauth}, @samp{+fcma}, @samp{+jscvt} | |
| @item @samp{armv8.4-a} @tab Armv8.4-A @tab @samp{armv8.3-a}, @samp{+flagm}, @samp{+fp16fml}, @samp{+dotprod}, @samp{+rcpc2} | |
| @item @samp{armv8.5-a} @tab Armv8.5-A @tab @samp{armv8.4-a}, @samp{+sb}, @samp{+ssbs}, @samp{+predres}, @samp{+frintts}, @samp{+flagm2} | |
| @item @samp{armv8.6-a} @tab Armv8.6-A @tab @samp{armv8.5-a}, @samp{+bf16}, @samp{+i8mm} | |
| @item @samp{armv8.7-a} @tab Armv8.7-A @tab @samp{armv8.6-a}, @samp{+wfxt}, @samp{+xs} | |
| @item @samp{armv8.8-a} @tab Armv8.8-a @tab @samp{armv8.7-a}, @samp{+mops} | |
| @item @samp{armv8.9-a} @tab Armv8.9-a @tab @samp{armv8.8-a} | |
| @item @samp{armv9-a} @tab Armv9-A @tab @samp{armv8.5-a}, @samp{+sve}, @samp{+sve2} | |
| @item @samp{armv9.1-a} @tab Armv9.1-A @tab @samp{armv9-a}, @samp{+bf16}, @samp{+i8mm} | |
| @item @samp{armv9.2-a} @tab Armv9.2-A @tab @samp{armv9.1-a}, @samp{+wfxt}, @samp{+xs} | |
| @item @samp{armv9.3-a} @tab Armv9.3-A @tab @samp{armv9.2-a}, @samp{+mops} | |
| @item @samp{armv9.4-a} @tab Armv9.4-A @tab @samp{armv9.3-a}, @samp{+sve2p1} | |
| @item @samp{armv9.5-a} @tab Armv9.5-A @tab @samp{armv9.4-a}, @samp{cpa}, @samp{+faminmax}, @samp{+lut} | |
| @item @samp{armv8-r} @tab Armv8-R @tab @samp{armv8-r} | |
| @end multitable | |
| The value @samp{native} is available on native AArch64 GNU/Linux and | |
| causes the compiler to pick the architecture of the host system. This | |
| option has no effect if the compiler is unable to recognize the | |
| architecture of the host system. When @option{-march=native} is given and | |
| no other @option{-mcpu} or @option{-mtune} is given then GCC will pick | |
| the host CPU as the CPU to tune for as well as select the architecture features | |
| from. That is, @option{-march=native} is treated as @option{-mcpu=native}. | |
| The permissible values for @var{feature} are listed in the sub-section | |
| on @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu} | |
| Feature Modifiers}. Where conflicting feature modifiers are | |
| specified, the right-most feature is used. | |
| GCC uses @var{name} to determine what kind of instructions it can emit | |
| when generating assembly code. If @option{-march} is specified | |
| without either of @option{-mtune} or @option{-mcpu} also being | |
| specified, the code is tuned to perform well across a range of target | |
| processors implementing the target architecture. | |
| @opindex mtune | |
| @item -mtune=@var{name} | |
| Specify the name of the target processor for which GCC should tune the | |
| performance of the code. Permissible values for this option are: | |
| @samp{generic}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, | |
| @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, | |
| @samp{cortex-a76}, @samp{cortex-a76ae}, @samp{cortex-a77}, | |
| @samp{cortex-a65}, @samp{cortex-a65ae}, @samp{cortex-a34}, | |
| @samp{cortex-a78}, @samp{cortex-a78ae}, @samp{cortex-a78c}, | |
| @samp{ares}, @samp{exynos-m1}, @samp{emag}, @samp{falkor}, | |
| @samp{oryon-1}, | |
| @samp{neoverse-512tvb}, @samp{neoverse-e1}, @samp{neoverse-n1}, | |
| @samp{neoverse-n2}, @samp{neoverse-v1}, @samp{neoverse-v2}, @samp{grace}, | |
| @samp{neoverse-v3}, @samp{neoverse-v3ae}, @samp{armagicpu}, @samp{neoverse-n3}, | |
| @samp{olympus}, @samp{rigel}, @samp{cortex-a725}, @samp{cortex-x925}, | |
| @samp{qdf24xx}, @samp{saphira}, @samp{phecda}, @samp{xgene1}, @samp{vulcan}, | |
| @samp{octeontx}, @samp{octeontx81}, @samp{octeontx83}, | |
| @samp{octeontx2}, @samp{octeontx2t98}, @samp{octeontx2t96} | |
| @samp{octeontx2t93}, @samp{octeontx2f95}, @samp{octeontx2f95n}, | |
| @samp{octeontx2f95mm}, | |
| @samp{a64fx}, @samp{fujitsu-monaka}, | |
| @samp{thunderx}, @samp{thunderxt88}, | |
| @samp{thunderxt88p1}, @samp{thunderxt81}, @samp{tsv110}, @samp{hip12}, | |
| @samp{thunderxt83}, @samp{thunderx2t99}, @samp{thunderx3t110}, @samp{zeus}, | |
| @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}, | |
| @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53}, | |
| @samp{cortex-a75.cortex-a55}, @samp{cortex-a76.cortex-a55}, | |
| @samp{cortex-r82}, @samp{cortex-r82ae}, @samp{cortex-x1}, @samp{cortex-x1c}, | |
| @samp{cortex-x2}, @samp{cortex-x3}, @samp{cortex-x4}, @samp{cortex-a510}, | |
| @samp{cortex-a520}, @samp{cortex-a520ae}, @samp{cortex-a710}, @samp{cortex-a715}, | |
| @samp{cortex-a720}, @samp{cortex-a720ae}, @samp{ampere1}, @samp{ampere1a}, | |
| @samp{ampere1b}, @samp{ampere1c}, @samp{cobalt-100}, @samp{apple-m1}, | |
| @samp{apple-m2}, @samp{apple-m3}, @samp{apple-m4}, @samp{apple-m5}, @samp{c1-nano}, | |
| @samp{c1-pro}, @samp{c1-premium} @samp{c1-ultra} and @samp{native}. | |
| The values @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}, | |
| @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53}, | |
| @samp{cortex-a75.cortex-a55}, @samp{cortex-a76.cortex-a55}, | |
| @samp{apple-m1}, @samp{apple-m2}, @samp{apple-m3}, @samp{gb10} specify that GCC | |
| should tune for a big.LITTLE system. | |
| The value @samp{neoverse-512tvb} specifies that GCC should tune | |
| for Neoverse cores that (a) implement SVE and (b) have a total vector | |
| bandwidth of 512 bits per cycle. In other words, the option tells GCC to | |
| tune for Neoverse cores that can execute 4 128-bit Advanced SIMD arithmetic | |
| instructions a cycle and that can execute an equivalent number of SVE | |
| arithmetic instructions per cycle (2 for 256-bit SVE, 4 for 128-bit SVE). | |
| This is more general than tuning for a specific core like Neoverse V1 | |
| but is more specific than the default tuning described below. | |
| Additionally on native AArch64 GNU/Linux systems the value | |
| @samp{native} tunes performance to the host system. This option has no effect | |
| if the compiler is unable to recognize the processor of the host system. | |
| Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=} | |
| are specified, the code is tuned to perform well across a range | |
| of target processors. | |
| This option cannot be suffixed by feature modifiers. | |
| @opindex mcpu | |
| @item -mcpu=@var{name} | |
| Specify the name of the target processor, optionally suffixed by one | |
| or more feature modifiers. This option has the form | |
| @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where | |
| the permissible values for @var{cpu} are the same as those available | |
| for @option{-mtune}. The permissible values for @var{feature} are | |
| documented in the sub-section on | |
| @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu} | |
| Feature Modifiers}. Where conflicting feature modifiers are | |
| specified, the right-most feature is used. | |
| GCC uses @var{name} to determine what kind of instructions it can emit when | |
| generating assembly code (as if by @option{-march}) and to determine | |
| the target processor for which to tune for performance (as if | |
| by @option{-mtune}). Where this option is used in conjunction | |
| with @option{-march} or @option{-mtune}, those options take precedence | |
| over the appropriate part of this option. | |
| @option{-mcpu=neoverse-512tvb} is special in that it does not refer | |
| to a specific core, but instead refers to all Neoverse cores that | |
| (a) implement SVE and (b) have a total vector bandwidth of 512 bits | |
| a cycle. Unless overridden by @option{-march}, | |
| @option{-mcpu=neoverse-512tvb} generates code that can run on a | |
| Neoverse V1 core, since Neoverse V1 is the first Neoverse core with | |
| these properties. Unless overridden by @option{-mtune}, | |
| @option{-mcpu=neoverse-512tvb} tunes code in the same way as for | |
| @option{-mtune=neoverse-512tvb}. | |
| @opindex moverride | |
| @item -moverride=@var{string} | |
| Override tuning decisions made by the back-end in response to a | |
| @option{-mtune=} switch. The syntax, semantics, and accepted values | |
| for @var{string} in this option are not guaranteed to be consistent | |
| across releases. | |
| This option is only intended to be useful when developing GCC. | |
| @opindex mpc-relative-literal-loads | |
| @opindex mno-pc-relative-literal-loads | |
| @item -mpc-relative-literal-loads | |
| @itemx -mno-pc-relative-literal-loads | |
| Enable or disable PC-relative literal loads. With this option literal pools are | |
| accessed using a single instruction and emitted after each function. This | |
| limits the maximum size of functions to 1MB. This is enabled by default for | |
| @option{-mcmodel=tiny}. | |
| The @option{-mpc-relative-literal-loads} is deprecated. | |
| @opindex msign-return-address | |
| @item -msign-return-address=@var{scope} | |
| Select the function scope on which return address signing will be applied. | |
| Permissible values are @samp{none}, which disables return address signing, | |
| @samp{non-leaf}, which enables pointer signing for functions which are not leaf | |
| functions, and @samp{all}, which enables pointer signing for all functions. The | |
| default value is @samp{none}. This option has been deprecated by | |
| @option{-mbranch-protection}. | |
| @opindex mbranch-protection | |
| @item -mbranch-protection=@var{features} | |
| Select the branch protection features to use. | |
| @var{features} can have one of the following forms: | |
| @samp{none} is the default and turns off all types of branch protection. | |
| @samp{standard} turns on all types of branch protection features. If a feature | |
| has additional tuning options, then @samp{standard} sets it to its standard | |
| level. | |
| @samp{pac-ret} turns on return address signing to its standard | |
| level: signing functions that save the return address to memory (non-leaf | |
| functions practically always do this) using the A-key. | |
| @samp{pac-ret+leaf} extends the @samp{pac-ret} signing to include leaf | |
| functions. | |
| @samp{pac-ret+b-key} or @samp{pac-ret+leaf+b-key} can be used to | |
| sign the functions with the B-key instead of the A-key. | |
| @samp{bti} turns on branch target identification mechanism. | |
| @samp{gcs} turns on guarded control stack compatible code generation. | |
| @opindex mharden-sls | |
| @item -mharden-sls=@var{opts} | |
| Enable compiler hardening against straight line speculation (SLS). | |
| @var{opts} is a comma-separated list of the following options: | |
| @table @samp | |
| @item retbr | |
| @item blr | |
| @end table | |
| In addition, @samp{-mharden-sls=all} enables all SLS hardening while | |
| @samp{-mharden-sls=none} disables all SLS hardening. | |
| @opindex mearly-ra | |
| @item -mearly-ra=@var{scope} | |
| Determine when to enable an early register allocation pass. This pass runs | |
| before instruction scheduling and tries to find a spill-free allocation of | |
| floating-point and vector code. It also tries to make use of strided | |
| multi-register instructions, such as SME2's strided LD1 and ST1. | |
| The possible values of @var{scope} are: @var{all}, which runs the pass on | |
| all functions; @var{strided}, which runs the pass on functions that have | |
| access to strided multi-register instructions; and @var{none}, which | |
| disables the pass. | |
| @option{-mearly-ra=all} is the default for @option{-O2} and above, and for | |
| @option{-Os}. @option{-mearly-ra=none} is the default otherwise. | |
| @opindex mearly-ldp-fusion | |
| @opindex mno-early-ldp-fusion | |
| @item -mearly-ldp-fusion | |
| @itemx -mno-early-ldp-fusion | |
| Enable the copy of the AArch64 load/store pair fusion pass that runs before | |
| register allocation. Enabled by default at @samp{-O} and above. | |
| @opindex mlate-ldp-fusion | |
| @opindex mno-late-ldp-fusion | |
| @item -mlate-ldp-fusion | |
| @itemx -mno-late-ldp-fusion | |
| Enable the copy of the AArch64 load/store pair fusion pass that runs after | |
| register allocation. Enabled by default at @samp{-O} and above. | |
| @opindex mnarrow-gp-writes | |
| @item -mnarrow-gp-writes | |
| Enable conversion of 64-bit general purpose register writes to equivalent 32-bit | |
| operations when the upper 32 bits are known to be zero. This pass can be | |
| controlled with -mnarrow-gp-writes and is active at -O2 and above, but not | |
| enabled by default, except for @option{-mcpu=olympus}. | |
| @opindex msve-vector-bits | |
| @item -msve-vector-bits=@var{bits} | |
| Specify the number of bits in an SVE vector register. This option only has | |
| an effect when SVE is enabled. | |
| GCC supports two forms of SVE code generation: ``vector-length | |
| agnostic'' output that works with any size of vector register and | |
| ``vector-length specific'' output that allows GCC to make assumptions | |
| about the vector length when it is useful for optimization reasons. | |
| The possible values of @samp{bits} are: @samp{scalable}, @samp{128}, | |
| @samp{256}, @samp{512}, @samp{1024} and @samp{2048}. | |
| Specifying @samp{scalable} selects vector-length agnostic | |
| output. At present @samp{-msve-vector-bits=128} also generates vector-length | |
| agnostic output for big-endian targets. All other values generate | |
| vector-length specific code. The behavior of these values may change | |
| in future releases and no value except @samp{scalable} should be | |
| relied on for producing code that is portable across different | |
| hardware SVE vector lengths. | |
| The default is @samp{-msve-vector-bits=scalable}, which produces | |
| vector-length agnostic code. | |
| @end table | |
| @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers | |
| @anchor{aarch64-feature-modifiers} | |
| @cindex @option{-march} feature modifiers | |
| @cindex @option{-mcpu} feature modifiers | |
| Feature modifiers used with @option{-march} and @option{-mcpu} can be any of | |
| the following and their inverses @option{no@var{feature}}: | |
| @table @samp | |
| @item crc | |
| Enable CRC extension. This is on by default for | |
| @option{-march=armv8.1-a}. | |
| @item crypto | |
| Enable Crypto extension. This also enables Advanced SIMD and floating-point | |
| instructions. | |
| @item fp | |
| Enable floating-point instructions. This is on by default for all possible | |
| values for options @option{-march} and @option{-mcpu}. | |
| @item simd | |
| Enable Advanced SIMD instructions. This also enables floating-point | |
| instructions. This is on by default for all possible values for options | |
| @option{-march} and @option{-mcpu}. | |
| @item sve | |
| Enable Scalable Vector Extension instructions. This also enables Advanced | |
| SIMD and floating-point instructions. | |
| @item lse | |
| Enable Large System Extension instructions. This is on by default for | |
| @option{-march=armv8.1-a}. | |
| @item rdma | |
| Enable Round Double Multiply Accumulate instructions. This is on by default | |
| for @option{-march=armv8.1-a}. | |
| @item fp16 | |
| Enable FP16 extension. This also enables floating-point instructions. | |
| @item fp16fml | |
| Enable FP16 fmla extension. This also enables FP16 extensions and | |
| floating-point instructions. This option is enabled by default for @option{-march=armv8.4-a}. Use of this option with architectures prior to Armv8.2-A is not supported. | |
| @item rcpc | |
| Enable the RCpc extension. This enables the use of the LDAPR instructions for | |
| load-acquire atomic semantics, and passes it on to the assembler, enabling | |
| inline asm statements to use instructions from the RCpc extension. | |
| @item dotprod | |
| Enable the Dot Product extension. This also enables Advanced SIMD instructions. | |
| @item aes | |
| Enable the Armv8-a aes and pmull crypto extension. This also enables Advanced | |
| SIMD instructions. | |
| @item sha2 | |
| Enable the Armv8-a sha2 crypto extension. This also enables Advanced SIMD instructions. | |
| @item sha3 | |
| Enable the sha512 and sha3 crypto extension. This also enables Advanced SIMD | |
| instructions. Use of this option with architectures prior to Armv8.2-A is not supported. | |
| @item sm4 | |
| Enable the sm3 and sm4 crypto extension. This also enables Advanced SIMD instructions. | |
| Use of this option with architectures prior to Armv8.2-A is not supported. | |
| @item profile | |
| Enable the Statistical Profiling extension. This option is only to enable the | |
| extension at the assembler level and does not affect code generation. | |
| @item rng | |
| Enable the Armv8.5-a Random Number instructions. This option is only to | |
| enable the extension at the assembler level and does not affect code | |
| generation. | |
| @item memtag | |
| Enable the Armv8.5-a Memory Tagging Extensions. | |
| Use of this option with architectures prior to Armv8.5-A is not supported. | |
| @item sb | |
| Enable the Armv8-a Speculation Barrier instruction. This option is only to | |
| enable the extension at the assembler level and does not affect code | |
| generation. This option is enabled by default for @option{-march=armv8.5-a}. | |
| @item ssbs | |
| Enable the Armv8-a Speculative Store Bypass Safe instruction. This option | |
| is only to enable the extension at the assembler level and does not affect code | |
| generation. This option is enabled by default for @option{-march=armv8.5-a}. | |
| @item predres | |
| Enable the Armv8-a Execution and Data Prediction Restriction instructions. | |
| This option is only to enable the extension at the assembler level and does | |
| not affect code generation. This option is enabled by default for | |
| @option{-march=armv8.5-a}. | |
| @item sve2 | |
| Enable the Armv8-a Scalable Vector Extension 2. This also enables SVE | |
| instructions. | |
| @item sve2-bitperm | |
| Enable SVE2 bitperm instructions. This also enables SVE2 instructions. | |
| @item sve2-sm4 | |
| Enable SVE2 sm4 instructions. This also enables SVE2 instructions. | |
| @item sve2-aes | |
| Enable SVE2 aes instructions. This also enables SVE2 instructions. | |
| @item sve2-sha3 | |
| Enable SVE2 sha3 instructions. This also enables SVE2 instructions. | |
| @item sve2p1 | |
| Enable SVE2.1 instructions. This also enables SVE2 instructions. | |
| @item sve2p2 | |
| Enable SVE2.2 instructions. This also enables SVE2 and SVE2.1 instructions. | |
| @item sve2p3 | |
| Enable SVE2.3 instructions. This also enables SVE2 and SVE2.1 and | |
| SVE2.2 instructions. | |
| @item i8mm | |
| Enable 8-bit Integer Matrix Multiply instructions. This also enables | |
| Advanced SIMD and floating-point instructions. This option is enabled by | |
| default for @option{-march=armv8.6-a}. Use of this option with architectures | |
| prior to Armv8.2-A is not supported. | |
| @item f32mm | |
| Enable 32-bit Floating point Matrix Multiply instructions. This also enables | |
| SVE instructions. Use of this option with architectures prior to Armv8.2-A is | |
| not supported. | |
| @item f64mm | |
| Enable 64-bit Floating point Matrix Multiply instructions. This also enables | |
| SVE instructions. Use of this option with architectures prior to Armv8.2-A is | |
| not supported. | |
| @item bf16 | |
| Enable brain half-precision floating-point instructions. This also enables | |
| Advanced SIMD and floating-point instructions. This option is enabled by | |
| default for @option{-march=armv8.6-a}. Use of this option with architectures | |
| prior to Armv8.2-A is not supported. | |
| @item ls64 | |
| Enable the 64-byte atomic load and store instructions for accelerators. | |
| @item mops | |
| Enable the instructions to accelerate memory operations like @code{memcpy}, | |
| @code{memmove}, @code{memset}. This option is enabled by default for | |
| @option{-march=armv8.8-a} | |
| @item flagm | |
| Enable the Flag Manipulation instructions Extension. | |
| @item flagm2 | |
| Enable the FlagM2 flag conversion instructions. | |
| @item pauth | |
| Enable the Pointer Authentication Extension. | |
| @item cssc | |
| Enable the Common Short Sequence Compression instructions. | |
| @item cmpbr | |
| Enable the shorter compare and branch instructions, @code{cbb}, @code{cbh} and | |
| @code{cb}. | |
| @item sme | |
| Enable the Scalable Matrix Extension. | |
| @item sme-i16i64 | |
| Enable the FEAT_SME_I16I64 extension to SME. This also enables SME | |
| instructions. | |
| @item sme-f64f64 | |
| Enable the FEAT_SME_F64F64 extension to SME. This also enables SME | |
| instructions. | |
| @item sme2 | |
| Enable the Scalable Matrix Extension 2. This also enables SME instructions. | |
| @item sme-f8f16 | |
| Enable the FEAT_SME_F8F16 extension to SME. This also enables SME2 and FP8 | |
| instructions. | |
| @item sme-f8f32 | |
| Enable the FEAT_SME_F8F32 extension to SME. This also enables SME2 and FP8 | |
| instructions. | |
| @item sme-b16b16 | |
| Enable the FEAT_SME_B16B16 extension to SME. This also enables SME2 | |
| and SVE_B16B16 instructions. | |
| @item sme-f16f16 | |
| Enable the FEAT_SME_F16F16 extension to SME. This also enables SME2 | |
| instructions. | |
| @item sme-mop4 | |
| Enable the FEAT_SME_MOP4 extension to SME. This also enables SME2 | |
| instructions. | |
| @item sme2p1 | |
| Enable the Scalable Matrix Extension version 2.1. This also enables SME2 | |
| instructions. | |
| @item sme2p2 | |
| Enable the Scalable Matrix Extension version 2.2. This also enables SME2 | |
| and SME2.1 instructions. | |
| @item sme2p3 | |
| Enable the Scalable Matrix Extension version 2.3. This also enables SME2, | |
| SME2.1 and SME2.2 instructions. | |
| @item fcma | |
| Enable the complex number SIMD extensions. | |
| @item jscvt | |
| Enable the @code{fjcvtzs} JavaScript conversion instruction. | |
| @item frintts | |
| Enable floating-point round to integral value instructions. | |
| @item wfxt | |
| Enable @code{wfet} and @code{wfit} instructions. | |
| @item xs | |
| Enable the XS memory attribute extension. | |
| @item lse128 | |
| Enable the LSE128 128-bit atomic instructions extension. This also | |
| enables LSE instructions. | |
| @item d128 | |
| Enable support for 128-bit system register read/write instructions. | |
| This also enables the LSE128 extension. | |
| @item gcs | |
| Enable support for Armv9.4-a Guarded Control Stack extension. | |
| @item the | |
| Enable support for Armv8.9-a/9.4-a translation hardening extension. | |
| @item rcpc2 | |
| Enable the RCpc2 extension. | |
| @item rcpc3 | |
| Enable the RCpc3 (Release Consistency) extension. | |
| @item fp8 | |
| Enable the fp8 (8-bit floating point) extension. | |
| @item fp8fma | |
| Enable the fp8 (8-bit floating point) multiply accumulate extension. | |
| @item ssve-fp8fma | |
| Enable the fp8 (8-bit floating point) multiply accumulate extension in streaming | |
| mode. | |
| @item fp8dot4 | |
| Enable the fp8 (8-bit floating point) to single-precision 4-way dot product | |
| extension. | |
| @item ssve-fp8dot4 | |
| Enable the fp8 (8-bit floating point) to single-precision 4-way dot product | |
| extension in streaming mode. | |
| @item fp8dot2 | |
| Enable the fp8 (8-bit floating point) to half-precision 2-way dot product | |
| extension. | |
| @item ssve-fp8dot2 | |
| Enable the fp8 (8-bit floating point) to half-precision 2-way dot product | |
| extension in streaming mode. | |
| @item f16f32dot | |
| Enable the Half-precision to single-precision dot product extension. | |
| @item faminmax | |
| Enable the Floating Point Absolute Maximum/Minimum extension. | |
| @item lut | |
| Enable the Lookup Table extension. | |
| @item sme-lutv2 | |
| Enable the SME Lookup Table v2 (LUTv2) extension. | |
| @item cpa | |
| Enable the Checked Pointer Arithmetic instructions. | |
| @item sve-b16b16 | |
| Enable the SVE non-widening brain floating-point (@code{bf16}) extension. | |
| This only has an effect when @code{sve2} or @code{sme2} are also enabled. | |
| @item sve-bfscale | |
| Enable the SVE_BFSCALE extension. | |
| @item poe2 | |
| Enable the Permission Overlays Extension 2. | |
| @item tev | |
| Enable the TIndex Exception-like Vector Extension. | |
| @item tlbid | |
| Enable the TLBI Domains Extension. | |
| @item gcie | |
| Enable the GICv5 (Generic Interrupt Controller) CPU Interface Extension. | |
| @item lscp | |
| Enable the load acquire and store release pair extension. | |
| @item mops-go | |
| Enable tag only variants of MOPS instructions. This also enables the | |
| instructions to accelerate memory operations and Armv8.5-a Memory | |
| Tagging Extensions. | |
| @item sve2p3 | |
| Enable SVE2.3. This also enables SVE2.2 instructions. | |
| @item sme2p3 | |
| Enable SME2.3. This also enables SME2.2 instructions. | |
| @item f16f32dot | |
| Enable Armv9.7-a f16f32dot instructions. This also enables Advanced SIMD, | |
| floating-point instructions and Armv8.2-a FP16 instructions. | |
| @item sve-b16mm | |
| Enable the SVE B16MM Extension. This also enables SVE instructions, Advanced | |
| SIMD and floating-point instructions. | |
| @item mtetc | |
| Enable Data cache tag block operations. This also enables Armv8.5-a Memory | |
| Tagging Extensions. | |
| @item f16f32mm | |
| Enable Armv9.7-a f16f32mm instructions. This also enables Advanced SIMD, | |
| floating-point instructions and Armv8.2-a FP16 instructions. | |
| @item f16mm | |
| Enable f16mm instructions. This also enables Advanced SIMD, | |
| floating-point instructions and Armv8.2-a FP16 instructions. | |
| @end table | |
| Feature @option{crypto} implies @option{aes}, @option{sha2}, and @option{simd}, | |
| which implies @option{fp}. | |
| Conversely, @option{nofp} implies @option{nosimd}, which implies | |
| @option{nocrypto}, @option{noaes} and @option{nosha2}. | |
| @node Adapteva Epiphany Options | |
| @subsection Adapteva Epiphany Options | |
| These @samp{-m} options are defined for Adapteva Epiphany: | |
| @table @gcctabopt | |
| @opindex mhalf-reg-file | |
| @opindex mno-half-reg-file | |
| @item -mhalf-reg-file | |
| @itemx -mno-half-reg-file | |
| Don't allocate any register in the range @code{r32}@dots{}@code{r63}. | |
| That allows code to run on hardware variants that lack these registers. | |
| @opindex mprefer-short-insn-regs | |
| @opindex mno-prefer-short-insn-regs | |
| @item -mprefer-short-insn-regs | |
| @itemx -mno-prefer-short-insn-regs | |
| Preferentially allocate registers that allow short instruction generation. | |
| This can result in increased instruction count, so this may either reduce or | |
| increase overall code size. | |
| @opindex mbranch-cost | |
| @item -mbranch-cost=@var{num} | |
| Set the cost of branches to roughly @var{num} ``simple'' instructions. | |
| This cost is only a heuristic and is not guaranteed to produce | |
| consistent results across releases. | |
| @opindex mcmove | |
| @opindex mno-cmove | |
| @item -mcmove | |
| @itemx -mno-cmove | |
| Enable the generation of conditional moves. | |
| @opindex mnops | |
| @item -mnops=@var{num} | |
| Emit @var{num} NOPs before every other generated instruction. | |
| @opindex mno-soft-cmpsf | |
| @opindex msoft-cmpsf | |
| @item -mno-soft-cmpsf | |
| @itemx -msoft-cmpsf | |
| For single-precision floating-point comparisons, emit an @code{fsub} instruction | |
| and test the flags. This is faster than a software comparison, but can | |
| get incorrect results in the presence of NaNs, or when two different small | |
| numbers are compared such that their difference is calculated as zero. | |
| The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant, | |
| software comparisons. | |
| @opindex mstack-offset | |
| @item -mstack-offset=@var{num} | |
| Set the offset between the top of the stack and the stack pointer. | |
| E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7} | |
| can be used by leaf functions without stack allocation. | |
| Values other than @samp{8} or @samp{16} are untested and unlikely to work. | |
| Note also that this option changes the ABI; compiling a program with a | |
| different stack offset than the libraries have been compiled with | |
| generally does not work. | |
| This option can be useful if you want to evaluate if a different stack | |
| offset would give you better code, but to actually use a different stack | |
| offset to build working programs, it is recommended to configure the | |
| toolchain with the appropriate @option{--with-stack-offset=@var{num}} option. | |
| @opindex mno-round-nearest | |
| @opindex mround-nearest | |
| @item -mno-round-nearest | |
| @itemx -mround-nearest | |
| @option{-mno-round-nearest} | |
| makes the scheduler assume that the rounding mode has been set to | |
| truncating. The default is @option{-mround-nearest}. | |
| @opindex mlong-calls | |
| @opindex mno-long-calls | |
| @item -mlong-calls | |
| If not otherwise specified by an attribute, assume all calls might be beyond | |
| the offset range of the @code{b} / @code{bl} instructions, and therefore load the | |
| function address into a register before performing a (otherwise direct) call. | |
| This is the default. | |
| @opindex mshort-calls | |
| @opindex mno-short-calls | |
| @item -mshort-calls | |
| If not otherwise specified by an attribute, assume all direct calls are | |
| in the range of the @code{b} / @code{bl} instructions, so use these instructions | |
| for direct calls. | |
| The default is @option{-mlong-calls}. Note that @option{-mlong-calls} | |
| is equivalent to @option{-mno-short-calls}, and similarly | |
| @option{-mno-long-calls} is equivalent to @option{-mshort-calls}. | |
| @opindex msmall16 | |
| @opindex mno-small16 | |
| @item -msmall16 | |
| @itemx -mno-small16 | |
| Assume addresses can be loaded as 16-bit unsigned values. This does not | |
| apply to function addresses for which @option{-mlong-calls} semantics | |
| are in effect. | |
| @opindex mfp-mode | |
| @item -mfp-mode=@var{mode} | |
| Set the prevailing mode of the floating-point unit. | |
| This determines the floating-point mode that is provided and expected | |
| at function call and return time. Making this mode match the mode you | |
| predominantly need at function start can make your programs smaller and | |
| faster by avoiding unnecessary mode switches. | |
| @var{mode} can be set to one the following values: | |
| @table @samp | |
| @item caller | |
| Any mode at function entry is valid, and retained or restored when | |
| the function returns, and when it calls other functions. | |
| This mode is useful for compiling libraries or other compilation units | |
| you might want to incorporate into different programs with different | |
| prevailing FPU modes, and the convenience of being able to use a single | |
| object file outweighs the size and speed overhead for any extra | |
| mode switching that might be needed, compared with what would be needed | |
| with a more specific choice of prevailing FPU mode. | |
| @item truncate | |
| This is the mode used for floating-point calculations with | |
| truncating (i.e.@: round towards zero) rounding mode. That includes | |
| conversion from floating point to integer. | |
| @item round-nearest | |
| This is the mode used for floating-point calculations with | |
| round-to-nearest-or-even rounding mode. | |
| @item int | |
| This is the mode used to perform integer calculations in the FPU, e.g.@: | |
| integer multiply, or integer multiply-and-accumulate. | |
| @end table | |
| The default is @option{-mfp-mode=caller} | |
| @opindex mmay-round-for-trunc | |
| @opindex mno-may-round-for-trunc | |
| @item -mmay-round-for-trunc | |
| @itemx -mno-may-round-for-trunc | |
| This option allows floating point to integer truncation to be replaced | |
| with rounding to save mode switching. It's disabled by default. | |
| @opindex mfp-iarith | |
| @opindex mno-fp-iarith | |
| @item -mfp-iarith | |
| @itemx -mno-fp-iarith | |
| This option enables use of the floating-point unit for integer add and | |
| subtract. It's disabled by default. | |
| @opindex mno-split-lohi | |
| @opindex msplit-lohi | |
| @opindex mno-post-inc | |
| @opindex mpost-inc | |
| @opindex mno-postmodify | |
| @opindex mpost-modify | |
| @item -msplit-lohi | |
| @itemx -mno-split-lohi | |
| @itemx -mpost-inc | |
| @itemx -mno-post-inc | |
| @itemx -mpost-modify | |
| @itemx -mno-post-modify | |
| Code generation tweaks that control, respectively, splitting of 32-bit | |
| loads, generation of post-increment addresses, and generation of | |
| post-modify addresses. The defaults are @option{msplit-lohi}, | |
| @option{-mpost-inc}, and @option{-mpost-modify}. | |
| @opindex mno-vect-double | |
| @opindex mvect-double | |
| @item -mno-vect-double | |
| Change the preferred SIMD mode to SImode. The default is | |
| @option{-mvect-double}, which uses DImode as preferred SIMD mode. | |
| @opindex max-vect-align | |
| @item -max-vect-align=@var{num} | |
| The maximum alignment for SIMD vector mode types. | |
| @var{num} may be 4 or 8. The default is 8. | |
| Note that this is an ABI change, even though many library function | |
| interfaces are unaffected if they don't use SIMD vector modes | |
| in places that affect size and/or alignment of relevant types. | |
| @opindex msplit-vecmove-early | |
| @opindex mno-split-vecmove-early | |
| @item -msplit-vecmove-early | |
| @itemx -mno-split-vecmove-early | |
| Split vector moves into single word moves before reload. In theory this | |
| can give better register allocation, but so far the reverse seems to be | |
| generally the case. | |
| @opindex m1reg- | |
| @item -m1reg-@var{reg} | |
| Specify a register to hold the constant @minus{}1, which makes loading small negative | |
| constants and certain bitmasks faster. | |
| Allowable values for @var{reg} are @samp{r43} and @samp{r63}, | |
| which specify use of that register as a fixed register, | |
| and @samp{none}, which means that no register is used for this | |
| purpose. The default is @option{-m1reg-none}. | |
| @end table | |
| @node AMD GCN Options | |
| @subsection AMD GCN Options | |
| @cindex AMD GCN Options | |
| These options are defined specifically for the AMD GCN port. | |
| @table @gcctabopt | |
| @opindex march | |
| @opindex mtune | |
| @item -march=@var{gpu} | |
| @itemx -mtune=@var{gpu} | |
| Set architecture type or tuning for @var{gpu}. Supported values for @var{gpu} | |
| are | |
| @table @samp | |
| @item gfx900 | |
| Compile for GCN5 Vega 10 devices (gfx900). | |
| @item gfx902 | |
| Compile for GCN5 Vega gfx902 devices. (Experimental) | |
| @item gfx904 | |
| Compile for GCN5 Vega gfx904 devices. (Experimental) | |
| @item gfx906 | |
| Compile for GCN5 Vega 20 devices (gfx906). | |
| @item gfx908 | |
| Compile for CDNA1 Instinct MI100 series devices (gfx908). | |
| @item gfx909 | |
| Compile for GCN5 Vega gfx909 devices. (Experimental) | |
| @item gfx90a | |
| Compile for CDNA2 Instinct MI200 series devices (gfx90a). | |
| @item gfx90c | |
| Compile for GCN5 Vega 7 devices (gfx90c). | |
| @item gfx942 | |
| Compile for CDNA3 Instinct MI300 series devices (gfx942). (Experimental) | |
| @item gfx950 | |
| Compile for the CDNA3 gfx950 devices. (Experimental) | |
| @item gfx9-generic | |
| Compile generic code for Vega devices, executable on the following subset of | |
| GFX9 devices: gfx900, gfx902, gfx904, gfx906, gfx909 and gfx90c. | |
| @item gfx9-4-generic | |
| Compile generic code for CDNA3 devices, executable on the following subset of | |
| GFX9 devices: gfx942 and gfx950. (Experimental) | |
| @item gfx1030 | |
| Compile for RDNA2 gfx1030 devices (GFX10 series). | |
| @item gfx1031 | |
| Compile for RDNA2 gfx1031 devices (GFX10 series). (Experimental) | |
| @item gfx1032 | |
| Compile for RDNA2 gfx1032 devices (GFX10 series). (Experimental) | |
| @item gfx1033 | |
| Compile for RDNA2 gfx1033 devices (GFX10 series). (Experimental) | |
| @item gfx1034 | |
| Compile for RDNA2 gfx1034 devices (GFX10 series). (Experimental) | |
| @item gfx1035 | |
| Compile for RDNA2 gfx1035 devices (GFX10 series). (Experimental) | |
| @item gfx1036 | |
| Compile for RDNA2 gfx1036 devices (GFX10 series). | |
| @item gfx10-3-generic | |
| Compile generic code for GFX10-3 devices, executable on gfx1030, | |
| gfx1031, gfx1032, gfx1033, gfx1034, gfx1035, and gfx1036. | |
| @item gfx1100 | |
| Compile for RDNA3 gfx1100 devices (GFX11 series). | |
| @item gfx1101 | |
| Compile for RDNA3 gfx1101 devices (GFX11 series). (Experimental) | |
| @item gfx1102 | |
| Compile for RDNA3 gfx1102 devices (GFX11 series). (Experimental) | |
| @item gfx1103 | |
| Compile for RDNA3 gfx1103 devices (GFX11 series). | |
| @item gfx1150 | |
| Compile for RDNA3 gfx1150 devices (GFX11 series). (Experimental) | |
| @item gfx1151 | |
| Compile for RDNA3 gfx1151 devices (GFX11 series). (Experimental) | |
| @item gfx1152 | |
| Compile for RDNA3 gfx1152 devices (GFX11 series). (Experimental) | |
| @item gfx1153 | |
| Compile for RDNA3 gfx1153 devices (GFX11 series). (Experimental) | |
| @item gfx1154 | |
| Compile for RDNA3 gfx1154 devices (GFX11 series). (Experimental) | |
| @item gfx11-generic | |
| Compile generic code for GFX11 devices, executable on gfx1100, gfx1101, | |
| gfx1102, gfx1103, gfx1150, gfx1151, gfx1152, gfx1153, gfx1154. | |
| @end table | |
| @opindex mgang-private-size | |
| @item -mgang-private-size=@var{bytes} | |
| Set the amount of local data-share (LDS) memory to reserve for | |
| gang-private variables. The default is 512. | |
| @opindex msram-ecc | |
| @item -msram-ecc=on | |
| @itemx -msram-ecc=off | |
| @itemx -msram-ecc=any | |
| Compile binaries suitable for devices with the SRAM-ECC feature enabled, | |
| disabled, or either mode. This feature can be enabled per-process on some | |
| devices. The compiled code must match the device mode. The default is | |
| @samp{any}, for devices that support it. | |
| @opindex mxnack | |
| @item -mxnack=on | |
| @itemx -mxnack=off | |
| @itemx -mxnack=any | |
| Compile binaries suitable for devices with the XNACK feature enabled, disabled, | |
| or either mode. Some devices always require XNACK and some allow the user to | |
| configure XNACK. The compiled code must match the device mode. | |
| The default is @samp{-mxnack=any} on devices that support Unified Shared | |
| Memory, and @samp{-mxnack=no} otherwise. | |
| @opindex Wopenacc-dims | |
| @opindex Wno-openacc-dims | |
| @item -Wopenacc-dims | |
| @itemx -Wno-openacc-dims | |
| Control warnings about invalid OpenACC dimensions. | |
| @end table | |
| @node ARC Options | |
| @subsection ARC Options | |
| @cindex ARC options | |
| The following options control the architecture variant for which code | |
| is being compiled: | |
| @c architecture variants | |
| @table @gcctabopt | |
| @opindex mbarrel-shifter | |
| @opindex mno-barrel-shifter | |
| @item -mbarrel-shifter | |
| Generate instructions supported by barrel shifter. This is the default | |
| unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect. | |
| @opindex mjli-always | |
| @opindex mno-mjli-always | |
| @item -mjli-always | |
| Force to call a function using jli_s instruction. This option is | |
| valid only for ARCv2 architecture. | |
| @opindex mcpu | |
| @item -mcpu=@var{cpu} | |
| Set architecture type, register usage, and instruction scheduling | |
| parameters for @var{cpu}. There are also shortcut alias options | |
| available for backward compatibility and convenience. Supported | |
| values for @var{cpu} are | |
| @table @samp | |
| @opindex mA6 | |
| @opindex mARC600 | |
| @item arc600 | |
| Compile for ARC600. Aliases: @option{-mA6}, @option{-mARC600}. | |
| @opindex mARC601 | |
| @item arc601 | |
| Compile for ARC601. Alias: @option{-mARC601}. | |
| @opindex mA7 | |
| @opindex mARC700 | |
| @item arc700 | |
| Compile for ARC700. Aliases: @option{-mA7}, @option{-mARC700}. | |
| This is the default when configured with @option{--with-cpu=arc700}@. | |
| @item arcem | |
| Compile for ARC EM. | |
| @item archs | |
| Compile for ARC HS. | |
| @item em | |
| Compile for ARC EM CPU with no hardware extensions. | |
| @item em4 | |
| Compile for ARC EM4 CPU. | |
| @item em4_dmips | |
| Compile for ARC EM4 DMIPS CPU. | |
| @item em4_fpus | |
| Compile for ARC EM4 DMIPS CPU with the single-precision floating-point | |
| extension. | |
| @item em4_fpuda | |
| Compile for ARC EM4 DMIPS CPU with single-precision floating-point and | |
| double assist instructions. | |
| @item hs | |
| Compile for ARC HS CPU with no hardware extensions except the atomic | |
| instructions. | |
| @item hs34 | |
| Compile for ARC HS34 CPU. | |
| @item hs38 | |
| Compile for ARC HS38 CPU. | |
| @item hs38_linux | |
| Compile for ARC HS38 CPU with all hardware extensions on. | |
| @item hs4x | |
| Compile for ARC HS4x CPU. | |
| @item hs4xd | |
| Compile for ARC HS4xD CPU. | |
| @item hs4x_rel31 | |
| Compile for ARC HS4x CPU release 3.10a. | |
| @item arc600_norm | |
| Compile for ARC 600 CPU with @code{norm} instructions enabled. | |
| @item arc600_mul32x16 | |
| Compile for ARC 600 CPU with @code{norm} and 32x16-bit multiply | |
| instructions enabled. | |
| @item arc600_mul64 | |
| Compile for ARC 600 CPU with @code{norm} and @code{mul64}-family | |
| instructions enabled. | |
| @item arc601_norm | |
| Compile for ARC 601 CPU with @code{norm} instructions enabled. | |
| @item arc601_mul32x16 | |
| Compile for ARC 601 CPU with @code{norm} and 32x16-bit multiply | |
| instructions enabled. | |
| @item arc601_mul64 | |
| Compile for ARC 601 CPU with @code{norm} and @code{mul64}-family | |
| instructions enabled. | |
| @item nps400 | |
| Compile for ARC 700 on NPS400 chip. | |
| @item em_mini | |
| Compile for ARC EM minimalist configuration featuring reduced register | |
| set. | |
| @end table | |
| @opindex mdpfp | |
| @opindex mno-dpfp | |
| @opindex mdpfp-compact | |
| @opindex mno-dpfp-compact | |
| @item -mdpfp | |
| @itemx -mdpfp-compact | |
| Generate double-precision FPX instructions, tuned for the compact | |
| implementation. | |
| @opindex mdpfp-fast | |
| @opindex mno-dpfp-fast | |
| @item -mdpfp-fast | |
| Generate double-precision FPX instructions, tuned for the fast | |
| implementation. | |
| @opindex mno-dpfp-lrsr | |
| @opindex mdpfp-lrsr | |
| @item -mno-dpfp-lrsr | |
| @itemx -mdpfp-lrsr | |
| Control whether @code{lr} and @code{sr} instructions use FPX extension | |
| aux registers. This is enabled by default. | |
| @opindex mea | |
| @opindex mno-ea | |
| @item -mea | |
| Generate extended arithmetic instructions. Currently only | |
| @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are | |
| supported. Only valid for @option{-mcpu=ARC700}. | |
| @opindex mmul32x16 | |
| @opindex mno-mul32x16 | |
| @item -mmul32x16 | |
| Generate 32x16-bit multiply and multiply-accumulate instructions. | |
| @opindex mmul64 | |
| @opindex mno-mul64 | |
| @item -mmul64 | |
| Generate @code{mul64} and @code{mulu64} instructions. | |
| Only valid for @option{-mcpu=ARC600}. | |
| @opindex mnorm | |
| @opindex mno-norm | |
| @item -mnorm | |
| Generate @code{norm} instructions. This is the default if @option{-mcpu=ARC700} | |
| is in effect. | |
| @opindex mspfp | |
| @opindex mno-spfp | |
| @opindex mspfp-compact | |
| @opindex mno-spfp-compact | |
| @item -mspfp | |
| @itemx -mspfp-compact | |
| Generate single-precision FPX instructions, tuned for the compact | |
| implementation. | |
| @opindex mspfp-fast | |
| @opindex mno-spfp-fast | |
| @item -mspfp-fast | |
| Generate single-precision FPX instructions, tuned for the fast | |
| implementation. | |
| @opindex msimd | |
| @opindex mno-simd | |
| @item -msimd | |
| Enable generation of ARC SIMD instructions via target-specific | |
| builtins. Only valid for @option{-mcpu=ARC700}. | |
| @opindex msoft-float | |
| @item -msoft-float | |
| This option ignored; it is provided for compatibility purposes only. | |
| Software floating-point code is emitted by default, and this default | |
| can overridden by FPX options; @option{-mspfp}, @option{-mspfp-compact}, or | |
| @option{-mspfp-fast} for single precision, and @option{-mdpfp}, | |
| @option{-mdpfp-compact}, or @option{-mdpfp-fast} for double precision. | |
| @opindex mswap | |
| @opindex mno-swap | |
| @item -mswap | |
| Generate @code{swap} instructions. | |
| @opindex matomic | |
| @opindex mno-atomic | |
| @item -matomic | |
| This enables use of the locked load/store conditional extension to implement | |
| atomic memory built-in functions. Not available for ARC 6xx or ARC | |
| EM cores. | |
| @opindex mdiv-rem | |
| @opindex mno-div-rem | |
| @item -mdiv-rem | |
| Enable @code{div} and @code{rem} instructions for ARCv2 cores. | |
| @opindex mcode-density | |
| @opindex mno-code-density | |
| @item -mcode-density | |
| @itemx -mno-code-density | |
| Enable code density instructions for ARC EM. | |
| This option is on by default for ARC HS. | |
| @opindex mll64 | |
| @opindex mno-ll64 | |
| @item -mll64 | |
| Enable double load/store operations for ARC HS cores. | |
| @opindex mtp-regno | |
| @item -mtp-regno=@var{regno} | |
| Specify thread pointer register number. | |
| @opindex mbitops | |
| @opindex mno-bitops | |
| @item -mbitops | |
| Enable use of NPS400 bit operations. | |
| @opindex mcmem | |
| @opindex mno-cmem | |
| @item -mcmem | |
| Enable use of NPS400 xld/xst extension. | |
| @opindex mmpy-option | |
| @item -mmpy-option=@var{multo} | |
| Compile ARCv2 code with a multiplier design option. You can specify | |
| the option using either a string or numeric value for @var{multo}. | |
| @samp{wlh1} is the default value. The recognized values are: | |
| @table @samp | |
| @item 0 | |
| @itemx none | |
| No multiplier available. | |
| @item 1 | |
| @itemx w | |
| 16x16 multiplier, fully pipelined. | |
| The following instructions are enabled: @code{mpyw} and @code{mpyuw}. | |
| @item 2 | |
| @itemx wlh1 | |
| 32x32 multiplier, fully | |
| pipelined (1 stage). The following instructions are additionally | |
| enabled: @code{mpy}, @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}. | |
| @item 3 | |
| @itemx wlh2 | |
| 32x32 multiplier, fully pipelined | |
| (2 stages). The following instructions are additionally enabled: @code{mpy}, | |
| @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}. | |
| @item 4 | |
| @itemx wlh3 | |
| Two 16x16 multipliers, blocking, | |
| sequential. The following instructions are additionally enabled: @code{mpy}, | |
| @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}. | |
| @item 5 | |
| @itemx wlh4 | |
| One 16x16 multiplier, blocking, | |
| sequential. The following instructions are additionally enabled: @code{mpy}, | |
| @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}. | |
| @item 6 | |
| @itemx wlh5 | |
| One 32x4 multiplier, blocking, | |
| sequential. The following instructions are additionally enabled: @code{mpy}, | |
| @code{mpyu}, @code{mpym}, @code{mpymu}, and @code{mpy_s}. | |
| @item 7 | |
| @itemx plus_dmpy | |
| ARC HS SIMD support. | |
| @item 8 | |
| @itemx plus_macd | |
| ARC HS SIMD support. | |
| @item 9 | |
| @itemx plus_qmacw | |
| ARC HS SIMD support. | |
| @end table | |
| This option is only available for ARCv2 cores@. | |
| @opindex mfpu | |
| @item -mfpu=@var{fpu} | |
| Enables support for specific floating-point hardware extensions for ARCv2 | |
| cores. Supported values for @var{fpu} are: | |
| @table @samp | |
| @item fpus | |
| Enables support for single-precision floating-point hardware | |
| extensions@. | |
| @item fpud | |
| Enables support for double-precision floating-point hardware | |
| extensions. The single-precision floating-point extension is also | |
| enabled. Not available for ARC EM@. | |
| @item fpuda | |
| Enables support for double-precision floating-point hardware | |
| extensions using double-precision assist instructions. The single-precision | |
| floating-point extension is also enabled. This option is | |
| only available for ARC EM@. | |
| @item fpuda_div | |
| Enables support for double-precision floating-point hardware | |
| extensions using double-precision assist instructions. | |
| The single-precision floating-point, square-root, and divide | |
| extensions are also enabled. This option is | |
| only available for ARC EM@. | |
| @item fpuda_fma | |
| Enables support for double-precision floating-point hardware | |
| extensions using double-precision assist instructions. | |
| The single-precision floating-point and fused multiply and add | |
| hardware extensions are also enabled. This option is | |
| only available for ARC EM@. | |
| @item fpuda_all | |
| Enables support for double-precision floating-point hardware | |
| extensions using double-precision assist instructions. | |
| All single-precision floating-point hardware extensions are also | |
| enabled. This option is only available for ARC EM@. | |
| @item fpus_div | |
| Enables support for single-precision floating-point, square-root and divide | |
| hardware extensions@. | |
| @item fpud_div | |
| Enables support for double-precision floating-point, square-root and divide | |
| hardware extensions. This option | |
| includes option @samp{fpus_div}. Not available for ARC EM@. | |
| @item fpus_fma | |
| Enables support for single-precision floating-point and | |
| fused multiply and add hardware extensions@. | |
| @item fpud_fma | |
| Enables support for double-precision floating-point and | |
| fused multiply and add hardware extensions. This option | |
| includes option @samp{fpus_fma}. Not available for ARC EM@. | |
| @item fpus_all | |
| Enables support for all single-precision floating-point hardware | |
| extensions@. | |
| @item fpud_all | |
| Enables support for all single- and double-precision floating-point | |
| hardware extensions. Not available for ARC EM@. | |
| @end table | |
| @opindex mirq-ctrl-saved | |
| @item -mirq-ctrl-saved=@var{register-range}, @var{blink}, @var{lp_count} | |
| Specifies general-purposes registers that the processor automatically | |
| saves/restores on interrupt entry and exit. @var{register-range} is | |
| specified as two registers separated by a dash. The register range | |
| always starts with @code{r0}, the upper limit is @code{fp} register. | |
| @var{blink} and @var{lp_count} are optional. This option is only | |
| valid for ARC EM and ARC HS cores. | |
| @opindex mrgf-banked-regs | |
| @item -mrgf-banked-regs=@var{number} | |
| Specifies the number of registers replicated in second register bank | |
| on entry to fast interrupt. Fast interrupts are interrupts with the | |
| highest priority level P0. These interrupts save only PC and STATUS32 | |
| registers to avoid memory transactions during interrupt entry and exit | |
| sequences. Use this option when you are using fast interrupts in an | |
| ARC V2 family processor. Permitted values are 4, 8, 16, and 32. | |
| @opindex mlpc-width | |
| @item -mlpc-width=@var{width} | |
| Specify the width of the @code{lp_count} register. Valid values for | |
| @var{width} are 8, 16, 20, 24, 28 and 32 bits. The default width is | |
| fixed to 32 bits. If the width is less than 32, the compiler does not | |
| attempt to transform loops in your program to use the zero-delay loop | |
| mechanism unless it is known that the @code{lp_count} register can | |
| hold the required loop-counter value. Depending on the width | |
| specified, the compiler and run-time library might continue to use the | |
| loop mechanism for various needs. This option defines macro | |
| @code{__ARC_LPC_WIDTH__} with the value of @var{width}. | |
| @opindex mrf16 | |
| @opindex mno-rf16 | |
| @item -mrf16 | |
| This option instructs the compiler to generate code for a 16-entry | |
| register file. This option defines the @code{__ARC_RF16__} | |
| preprocessor macro. | |
| @opindex mbranch-index | |
| @opindex mno-branch-index | |
| @item -mbranch-index | |
| Enable use of @code{bi} or @code{bih} instructions to implement jump | |
| tables. | |
| @end table | |
| The following options are passed through to the assembler, and also | |
| define preprocessor macro symbols. | |
| @c Flags used by the assembler, but for which we define preprocessor | |
| @c macro symbols as well. | |
| @table @gcctabopt | |
| @c ARC700 4.10 extension instruction | |
| @opindex mlock | |
| @opindex mno-lock | |
| @item -mlock | |
| Passed down to the assembler to enable the locked load/store | |
| conditional extension. Also sets the preprocessor symbol | |
| @code{__Xlock}. | |
| @c ARC700 4.10 extension instruction | |
| @opindex mswape | |
| @opindex mno-swape | |
| @item -mswape | |
| Passed down to the assembler to enable the swap byte ordering | |
| extension instruction. Also sets the preprocessor symbol | |
| @code{__Xswape}. | |
| @opindex mxy | |
| @opindex mno-xy | |
| @item -mxy | |
| Passed down to the assembler to enable the XY memory extension. Also | |
| sets the preprocessor symbol @code{__Xxy}. | |
| @end table | |
| The following options control how the assembly code is annotated: | |
| @c Assembly annotation options | |
| @table @gcctabopt | |
| @opindex misize | |
| @opindex mno-isize | |
| @item -misize | |
| Annotate assembler instructions with estimated addresses. | |
| @end table | |
| The following options are passed through to the linker: | |
| @c options passed through to the linker | |
| @table @gcctabopt | |
| @opindex marclinux | |
| @opindex mno-arclinux | |
| @item -marclinux | |
| @itemx -mno-arclinux | |
| Passed through to the linker, to specify use of the @code{arclinux} emulation. | |
| This option is enabled by default in tool chains built for | |
| @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets | |
| when profiling is not requested. | |
| @opindex marclinux_prof | |
| @opindex mno-arclinux_prof | |
| @item -marclinux_prof | |
| @itemx -mno-arclinux_prof | |
| Passed through to the linker, to specify use of the | |
| @code{arclinux_prof} emulation. This option is enabled by default in | |
| tool chains built for @w{@code{arc-linux-uclibc}} and | |
| @w{@code{arceb-linux-uclibc}} targets when profiling is requested. | |
| @end table | |
| The following options control the semantics of generated code: | |
| @c semantically relevant code generation options | |
| @table @gcctabopt | |
| @opindex mlong-calls | |
| @opindex mno-long-calls | |
| @item -mlong-calls | |
| Generate calls as register indirect calls, thus providing access | |
| to the full 32-bit address range. | |
| @opindex mmedium-calls | |
| @opindex mno-medium-calls | |
| @item -mmedium-calls | |
| @itemx -mno-medium-calls | |
| Don't use less than 25-bit addressing range for calls, which is the | |
| offset available for an unconditional branch-and-link | |
| instruction. Conditional execution of function calls is suppressed, to | |
| allow use of the 25-bit range, rather than the 21-bit range with | |
| conditional branch-and-link. This is the default for tool chains built | |
| for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets. | |
| @opindex G | |
| @item -G @var{num} | |
| Put definitions of externally-visible data in a small data section if | |
| that data is no bigger than @var{num} bytes. The default value of | |
| @var{num} is 4 for any ARC configuration, or 8 when we have double | |
| load/store operations. | |
| @opindex mno-sdata | |
| @opindex msdata | |
| @item -mno-sdata | |
| Do not generate sdata references. This is the default for tool chains | |
| built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} | |
| targets. | |
| @opindex mvolatile-cache | |
| @opindex mno-volatile-cache | |
| @item -mvolatile-cache | |
| @itemx -mno-volatile-cache | |
| Control how volatile references are accessed. | |
| The default is @option{-mvolatile-cache}, which uses ordinary | |
| cached memory accesses for volatile references. | |
| Use @option{-mno-volatile-cache} to | |
| enable cache bypass for volatile references. | |
| @end table | |
| The following options fine tune code generation: | |
| @c code generation tuning options | |
| @table @gcctabopt | |
| @opindex mauto-modify-reg | |
| @opindex mno-auto-modify-reg | |
| @item -mauto-modify-reg | |
| Enable the use of pre/post modify with register displacement. | |
| @opindex mno-brcc | |
| @opindex mbrcc | |
| @item -mno-brcc | |
| @itemx -mbrcc | |
| This option controls a target-specific pass in @file{arc_reorg} to | |
| generate compare-and-branch (@code{br@var{cc}}) instructions, which | |
| is enabled by default. | |
| It has no effect on | |
| generation of these instructions driven by the combiner pass. | |
| @opindex mcase-vector-pcrel | |
| @opindex mno-case-vector-pcrel | |
| @item -mcase-vector-pcrel | |
| Use PC-relative switch case tables to enable case table shortening. | |
| This is the default for @option{-Os}. | |
| @opindex mno-cond-exec | |
| @item -mno-cond-exec | |
| Disable the ARCompact-specific pass to generate conditional | |
| execution instructions. | |
| Due to delay slot scheduling and interactions between operand numbers, | |
| literal sizes, instruction lengths, and the support for conditional execution, | |
| the target-independent pass to generate conditional execution is often lacking, | |
| so the ARC port has kept a special pass around that tries to find more | |
| conditional execution generation opportunities after register allocation, | |
| branch shortening, and delay slot scheduling have been done. This pass | |
| generally, but not always, improves performance and code size, at the cost of | |
| extra compilation time, which is why there is an option to switch it off. | |
| If you have a problem with call instructions exceeding their allowable | |
| offset range because they are conditionalized, you should consider using | |
| @option{-mmedium-calls} instead. | |
| @opindex mearly-cbranchsi | |
| @opindex mno-early-cbranchsi | |
| @item -mearly-cbranchsi | |
| Enable pre-reload use of the @code{cbranchsi} pattern. | |
| @opindex mindexed-loads | |
| @opindex mno-indexed-loads | |
| @item -mindexed-loads | |
| Enable the use of indexed loads. This can be problematic because some | |
| optimizers then assume that indexed stores exist, which is not | |
| the case. | |
| @opindex mlra-priority-none | |
| @item -mlra-priority-none | |
| Don't indicate any priority for target registers. | |
| @opindex mlra-priority-compact | |
| @item -mlra-priority-compact | |
| Indicate target register priority for r0..r3 / r12..r15. | |
| @opindex mlra-priority-noncompact | |
| @item -mlra-priority-noncompact | |
| Reduce target register priority for r0..r3 / r12..r15. | |
| @opindex mmillicode | |
| @opindex mno-millicode | |
| @item -mmillicode | |
| When optimizing for size (using @option{-Os}), prologues and epilogues | |
| that have to save or restore a large number of registers are often | |
| shortened by using call to a special function in libgcc; this is | |
| referred to as a @emph{millicode} call. As these calls can pose | |
| performance issues, and/or cause linking issues when linking in a | |
| nonstandard way, this option is provided to turn on or off millicode | |
| call generation. | |
| @opindex mcode-density-frame | |
| @opindex mno-code-density-frame | |
| @item -mcode-density-frame | |
| This option enable the compiler to emit @code{enter} and @code{leave} | |
| instructions. These instructions are only valid for CPUs with | |
| code-density feature. | |
| @opindex msize-level | |
| @item -msize-level=@var{level} | |
| Fine-tune size optimization with regards to instruction lengths and alignment. | |
| The recognized values for @var{level} are: | |
| @table @samp | |
| @item 0 | |
| No size optimization. This level is deprecated and treated like @samp{1}. | |
| @item 1 | |
| Short instructions are used opportunistically. | |
| @item 2 | |
| In addition, alignment of loops and of code after barriers are dropped. | |
| @item 3 | |
| In addition, optional data alignment is dropped, and the option @option{Os} is enabled. | |
| @end table | |
| This defaults to @samp{3} when @option{-Os} is in effect. Otherwise, | |
| the behavior when this is not set is equivalent to level @samp{1}. | |
| @opindex mtune | |
| @item -mtune=@var{cpu} | |
| Set instruction scheduling parameters for @var{cpu}, overriding any implied | |
| by @option{-mcpu=}. | |
| Supported values for @var{cpu} are | |
| @table @samp | |
| @item ARC600 | |
| Tune for ARC600 CPU. | |
| @item ARC601 | |
| Tune for ARC601 CPU. | |
| @item ARC700 | |
| Tune for ARC700 CPU with standard multiplier block. | |
| @item ARC700-xmac | |
| Tune for ARC700 CPU with XMAC block. | |
| @item ARC725D | |
| Tune for ARC725D CPU. | |
| @item ARC750D | |
| Tune for ARC750D CPU. | |
| @item core3 | |
| Tune for ARCv2 core3 type CPU. This option enable usage of | |
| @code{dbnz} instruction. | |
| @item release31a | |
| Tune for ARC4x release 3.10a. | |
| @end table | |
| @opindex mmultcost | |
| @item -mmultcost=@var{num} | |
| Cost to assume for a multiply instruction, with @samp{4} being equal to a | |
| normal instruction. | |
| @end table | |
| @node ARM Options | |
| @subsection ARM Options | |
| @cindex ARM options | |
| These @samp{-m} options are defined for the ARM port: | |
| @table @gcctabopt | |
| @opindex mabi | |
| @item -mabi=@var{name} | |
| Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu}, | |
| @samp{atpcs}, @samp{aapcs} and @samp{aapcs-linux}. | |
| @opindex mapcs-frame | |
| @opindex mno-apcs-frame | |
| @item -mapcs-frame | |
| Generate a stack frame that is compliant with the ARM Procedure Call | |
| Standard for all functions, even if this is not strictly necessary for | |
| correct execution of the code. Specifying @option{-fomit-frame-pointer} | |
| with this option causes the stack frames not to be generated for | |
| leaf functions. The default is @option{-mno-apcs-frame}. | |
| This option is deprecated. | |
| @opindex mapcs | |
| @item -mapcs | |
| This is a synonym for @option{-mapcs-frame} and is deprecated. | |
| @opindex mthumb-interwork | |
| @opindex mno-thumb-interwork | |
| @item -mthumb-interwork | |
| Generate code that supports calling between the ARM and Thumb | |
| instruction sets. Without this option, on pre-v5 architectures, the | |
| two instruction sets cannot be reliably used inside one program. The | |
| default is @option{-mno-thumb-interwork}, since slightly larger code | |
| is generated when @option{-mthumb-interwork} is specified. In AAPCS | |
| configurations this option is meaningless. | |
| @opindex msched-prolog | |
| @opindex mno-sched-prolog | |
| @item -msched-prolog | |
| @itemx -mno-sched-prolog | |
| Allow or prevent the reordering of instructions in the function prologue, or the | |
| merging of those instruction with the instructions in the function's | |
| body. With @option{-mno-sched-prolog}, | |
| this means that all functions start with a recognizable set | |
| of instructions (or in fact one of a choice from a small set of | |
| different function prologues), and this information can be used to | |
| locate the start of functions inside an executable piece of code. The | |
| default is @option{-msched-prolog}. | |
| @opindex mfloat-abi | |
| @item -mfloat-abi=@var{name} | |
| Specifies which floating-point ABI to use. Permissible values | |
| are: @samp{soft}, @samp{softfp} and @samp{hard}. | |
| Specifying @samp{soft} causes GCC to generate output containing | |
| library calls for floating-point operations. | |
| @samp{softfp} allows the generation of code using hardware floating-point | |
| instructions, but still uses the soft-float calling conventions. | |
| @samp{hard} allows generation of floating-point instructions | |
| and uses FPU-specific calling conventions. | |
| The default depends on the specific target configuration. Note that | |
| the hard-float and soft-float ABIs are not link-compatible; you must | |
| compile your entire program with the same ABI, and link with a | |
| compatible set of libraries. | |
| @opindex mgeneral-regs-only | |
| @item -mgeneral-regs-only | |
| Generate code which uses only the general-purpose registers. This will prevent | |
| the compiler from using floating-point and Advanced SIMD registers but will not | |
| impose any restrictions on the assembler. | |
| @opindex mlittle-endian | |
| @item -mlittle-endian | |
| Generate code for a processor running in little-endian mode. This is | |
| the default for all standard configurations. | |
| @opindex mbig-endian | |
| @item -mbig-endian | |
| Generate code for a processor running in big-endian mode; the default is | |
| to compile code for a little-endian processor. | |
| @opindex mbe8 | |
| @opindex mbe32 | |
| @item -mbe8 | |
| @itemx -mbe32 | |
| When linking a big-endian image select between BE8 and BE32 formats. | |
| The option has no effect for little-endian images and is ignored. The | |
| default is dependent on the selected target architecture. For ARMv6 | |
| and later architectures the default is BE8, for older architectures | |
| the default is BE32. BE32 format has been deprecated by ARM. | |
| @opindex march | |
| @item -march=@var{name}@r{[}+extension@dots{}@r{]} | |
| This specifies the name of the target ARM architecture. GCC uses this | |
| name to determine what kind of instructions it can emit when generating | |
| assembly code. This option can be used in conjunction with or instead | |
| of the @option{-mcpu=} option. | |
| Permissible names are: | |
| @samp{armv4t}, | |
| @samp{armv5t}, @samp{armv5te}, | |
| @samp{armv6}, @samp{armv6j}, @samp{armv6k}, @samp{armv6kz}, @samp{armv6t2}, | |
| @samp{armv6z}, @samp{armv6zk}, | |
| @samp{armv7}, @samp{armv7-a}, @samp{armv7ve}, | |
| @samp{armv8-a}, @samp{armv8.1-a}, @samp{armv8.2-a}, @samp{armv8.3-a}, | |
| @samp{armv8.4-a}, | |
| @samp{armv8.5-a}, | |
| @samp{armv8.6-a}, | |
| @samp{armv9-a}, | |
| @samp{armv7-r}, | |
| @samp{armv8-r}, | |
| @samp{armv6-m}, @samp{armv6s-m}, | |
| @samp{armv7-m}, @samp{armv7e-m}, | |
| @samp{armv8-m.base}, @samp{armv8-m.main}, | |
| @samp{armv8.1-m.main}, | |
| @samp{iwmmxt} and @samp{iwmmxt2}. | |
| Additionally, the following architectures, which lack support for the | |
| Thumb execution state, are recognized but support is deprecated: @samp{armv4}. | |
| Many of the architectures support extensions. These can be added by | |
| appending @samp{+@var{extension}} to the architecture name. Extension | |
| options are processed in order and capabilities accumulate. An extension | |
| will also enable any necessary base extensions | |
| upon which it depends. For example, the @samp{+crypto} extension | |
| will always enable the @samp{+simd} extension. The exception to the | |
| additive construction is for extensions that are prefixed with | |
| @samp{+no@dots{}}: these extensions disable the specified option and | |
| any other extensions that may depend on the presence of that | |
| extension. | |
| For example, @samp{-march=armv7-a+simd+nofp+vfpv4} is equivalent to | |
| writing @samp{-march=armv7-a+vfpv4} since the @samp{+simd} option is | |
| entirely disabled by the @samp{+nofp} option that follows it. | |
| Most extension names are generically named, but have an effect that is | |
| dependent upon the architecture to which it is applied. For example, | |
| the @samp{+simd} option can be applied to both @samp{armv7-a} and | |
| @samp{armv8-a} architectures, but will enable the original ARMv7-A | |
| Advanced SIMD (Neon) extensions for @samp{armv7-a} and the ARMv8-A | |
| variant for @samp{armv8-a}. | |
| The table below lists the supported extensions for each architecture. | |
| Architectures not mentioned do not support any extensions. | |
| @table @samp | |
| @item armv5te | |
| @itemx armv6 | |
| @itemx armv6j | |
| @itemx armv6k | |
| @itemx armv6kz | |
| @itemx armv6t2 | |
| @itemx armv6z | |
| @itemx armv6zk | |
| @table @samp | |
| @item +fp | |
| The VFPv2 floating-point instructions. The extension @samp{+vfpv2} can be | |
| used as an alias for this extension. | |
| @item +nofp | |
| Disable the floating-point instructions. | |
| @end table | |
| @item armv7 | |
| The common subset of the ARMv7-A, ARMv7-R and ARMv7-M architectures. | |
| @table @samp | |
| @item +fp | |
| The VFPv3 floating-point instructions, with 16 double-precision | |
| registers. The extension @samp{+vfpv3-d16} can be used as an alias | |
| for this extension. Note that floating-point is not supported by the | |
| base ARMv7-M architecture, but is compatible with both the ARMv7-A and | |
| ARMv7-R architectures. | |
| @item +nofp | |
| Disable the floating-point instructions. | |
| @end table | |
| @item armv7-a | |
| @table @samp | |
| @item +mp | |
| The multiprocessing extension. | |
| @item +sec | |
| The security extension. | |
| @item +fp | |
| The VFPv3 floating-point instructions, with 16 double-precision | |
| registers. The extension @samp{+vfpv3-d16} can be used as an alias | |
| for this extension. | |
| @item +simd | |
| The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions. | |
| The extensions @samp{+neon} and @samp{+neon-vfpv3} can be used as aliases | |
| for this extension. | |
| @item +vfpv3 | |
| The VFPv3 floating-point instructions, with 32 double-precision | |
| registers. | |
| @item +vfpv3-d16-fp16 | |
| The VFPv3 floating-point instructions, with 16 double-precision | |
| registers and the half-precision floating-point conversion operations. | |
| @item +vfpv3-fp16 | |
| The VFPv3 floating-point instructions, with 32 double-precision | |
| registers and the half-precision floating-point conversion operations. | |
| @item +vfpv4-d16 | |
| The VFPv4 floating-point instructions, with 16 double-precision | |
| registers. | |
| @item +vfpv4 | |
| The VFPv4 floating-point instructions, with 32 double-precision | |
| registers. | |
| @item +neon-fp16 | |
| The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with | |
| the half-precision floating-point conversion operations. | |
| @item +neon-vfpv4 | |
| The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions. | |
| @item +nosimd | |
| Disable the Advanced SIMD instructions (does not disable floating point). | |
| @item +nofp | |
| Disable the floating-point and Advanced SIMD instructions. | |
| @end table | |
| @item armv7ve | |
| The extended version of the ARMv7-A architecture with support for | |
| virtualization. | |
| @table @samp | |
| @item +fp | |
| The VFPv4 floating-point instructions, with 16 double-precision registers. | |
| The extension @samp{+vfpv4-d16} can be used as an alias for this extension. | |
| @item +simd | |
| The Advanced SIMD (Neon) v2 and the VFPv4 floating-point instructions. The | |
| extension @samp{+neon-vfpv4} can be used as an alias for this extension. | |
| @item +vfpv3-d16 | |
| The VFPv3 floating-point instructions, with 16 double-precision | |
| registers. | |
| @item +vfpv3 | |
| The VFPv3 floating-point instructions, with 32 double-precision | |
| registers. | |
| @item +vfpv3-d16-fp16 | |
| The VFPv3 floating-point instructions, with 16 double-precision | |
| registers and the half-precision floating-point conversion operations. | |
| @item +vfpv3-fp16 | |
| The VFPv3 floating-point instructions, with 32 double-precision | |
| registers and the half-precision floating-point conversion operations. | |
| @item +vfpv4-d16 | |
| The VFPv4 floating-point instructions, with 16 double-precision | |
| registers. | |
| @item +vfpv4 | |
| The VFPv4 floating-point instructions, with 32 double-precision | |
| registers. | |
| @item +neon | |
| The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions. | |
| The extension @samp{+neon-vfpv3} can be used as an alias for this extension. | |
| @item +neon-fp16 | |
| The Advanced SIMD (Neon) v1 and the VFPv3 floating-point instructions, with | |
| the half-precision floating-point conversion operations. | |
| @item +nosimd | |
| Disable the Advanced SIMD instructions (does not disable floating point). | |
| @item +nofp | |
| Disable the floating-point and Advanced SIMD instructions. | |
| @end table | |
| @item armv8-a | |
| @table @samp | |
| @item +crc | |
| The Cyclic Redundancy Check (CRC) instructions. | |
| @item +simd | |
| The ARMv8-A Advanced SIMD and floating-point instructions. | |
| @item +crypto | |
| The cryptographic instructions. | |
| @item +nocrypto | |
| Disable the cryptographic instructions. | |
| @item +nofp | |
| Disable the floating-point, Advanced SIMD and cryptographic instructions. | |
| @item +sb | |
| Speculation Barrier Instruction. | |
| @item +predres | |
| Execution and Data Prediction Restriction Instructions. | |
| @end table | |
| @item armv8.1-a | |
| @table @samp | |
| @item +simd | |
| The ARMv8.1-A Advanced SIMD and floating-point instructions. | |
| @item +crypto | |
| The cryptographic instructions. This also enables the Advanced SIMD and | |
| floating-point instructions. | |
| @item +nocrypto | |
| Disable the cryptographic instructions. | |
| @item +nofp | |
| Disable the floating-point, Advanced SIMD and cryptographic instructions. | |
| @item +sb | |
| Speculation Barrier Instruction. | |
| @item +predres | |
| Execution and Data Prediction Restriction Instructions. | |
| @end table | |
| @item armv8.2-a | |
| @itemx armv8.3-a | |
| @table @samp | |
| @item +fp16 | |
| The half-precision floating-point data processing instructions. | |
| This also enables the Advanced SIMD and floating-point instructions. | |
| @item +fp16fml | |
| The half-precision floating-point fmla extension. This also enables | |
| the half-precision floating-point extension and Advanced SIMD and | |
| floating-point instructions. | |
| @item +simd | |
| The ARMv8.1-A Advanced SIMD and floating-point instructions. | |
| @item +crypto | |
| The cryptographic instructions. This also enables the Advanced SIMD and | |
| floating-point instructions. | |
| @item +dotprod | |
| Enable the Dot Product extension. This also enables Advanced SIMD instructions. | |
| @item +nocrypto | |
| Disable the cryptographic extension. | |
| @item +nofp | |
| Disable the floating-point, Advanced SIMD and cryptographic instructions. | |
| @item +sb | |
| Speculation Barrier Instruction. | |
| @item +predres | |
| Execution and Data Prediction Restriction Instructions. | |
| @item +i8mm | |
| 8-bit Integer Matrix Multiply instructions. | |
| This also enables Advanced SIMD and floating-point instructions. | |
| @item +bf16 | |
| Brain half-precision floating-point instructions. | |
| This also enables Advanced SIMD and floating-point instructions. | |
| @end table | |
| @item armv8.4-a | |
| @table @samp | |
| @item +fp16 | |
| The half-precision floating-point data processing instructions. | |
| This also enables the Advanced SIMD and floating-point instructions as well | |
| as the Dot Product extension and the half-precision floating-point fmla | |
| extension. | |
| @item +simd | |
| The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the | |
| Dot Product extension. | |
| @item +crypto | |
| The cryptographic instructions. This also enables the Advanced SIMD and | |
| floating-point instructions as well as the Dot Product extension. | |
| @item +nocrypto | |
| Disable the cryptographic extension. | |
| @item +nofp | |
| Disable the floating-point, Advanced SIMD and cryptographic instructions. | |
| @item +sb | |
| Speculation Barrier Instruction. | |
| @item +predres | |
| Execution and Data Prediction Restriction Instructions. | |
| @item +i8mm | |
| 8-bit Integer Matrix Multiply instructions. | |
| This also enables Advanced SIMD and floating-point instructions. | |
| @item +bf16 | |
| Brain half-precision floating-point instructions. | |
| This also enables Advanced SIMD and floating-point instructions. | |
| @end table | |
| @item armv8.5-a | |
| @table @samp | |
| @item +fp16 | |
| The half-precision floating-point data processing instructions. | |
| This also enables the Advanced SIMD and floating-point instructions as well | |
| as the Dot Product extension and the half-precision floating-point fmla | |
| extension. | |
| @item +simd | |
| The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the | |
| Dot Product extension. | |
| @item +crypto | |
| The cryptographic instructions. This also enables the Advanced SIMD and | |
| floating-point instructions as well as the Dot Product extension. | |
| @item +nocrypto | |
| Disable the cryptographic extension. | |
| @item +nofp | |
| Disable the floating-point, Advanced SIMD and cryptographic instructions. | |
| @item +i8mm | |
| 8-bit Integer Matrix Multiply instructions. | |
| This also enables Advanced SIMD and floating-point instructions. | |
| @item +bf16 | |
| Brain half-precision floating-point instructions. | |
| This also enables Advanced SIMD and floating-point instructions. | |
| @end table | |
| @item armv8.6-a | |
| @table @samp | |
| @item +fp16 | |
| The half-precision floating-point data processing instructions. | |
| This also enables the Advanced SIMD and floating-point instructions as well | |
| as the Dot Product extension and the half-precision floating-point fmla | |
| extension. | |
| @item +simd | |
| The ARMv8.3-A Advanced SIMD and floating-point instructions as well as the | |
| Dot Product extension. | |
| @item +crypto | |
| The cryptographic instructions. This also enables the Advanced SIMD and | |
| floating-point instructions as well as the Dot Product extension. | |
| @item +nocrypto | |
| Disable the cryptographic extension. | |
| @item +nofp | |
| Disable the floating-point, Advanced SIMD and cryptographic instructions. | |
| @item +i8mm | |
| 8-bit Integer Matrix Multiply instructions. | |
| This also enables Advanced SIMD and floating-point instructions. | |
| @item +bf16 | |
| Brain half-precision floating-point instructions. | |
| This also enables Advanced SIMD and floating-point instructions. | |
| @end table | |
| @item armv7-r | |
| @table @samp | |
| @item +fp.sp | |
| The single-precision VFPv3 floating-point instructions. The extension | |
| @samp{+vfpv3xd} can be used as an alias for this extension. | |
| @item +fp | |
| The VFPv3 floating-point instructions with 16 double-precision registers. | |
| The extension +vfpv3-d16 can be used as an alias for this extension. | |
| @item +vfpv3xd-d16-fp16 | |
| The single-precision VFPv3 floating-point instructions with 16 double-precision | |
| registers and the half-precision floating-point conversion operations. | |
| @item +vfpv3-d16-fp16 | |
| The VFPv3 floating-point instructions with 16 double-precision | |
| registers and the half-precision floating-point conversion operations. | |
| @item +nofp | |
| Disable the floating-point extension. | |
| @item +idiv | |
| The ARM-state integer division instructions. | |
| @item +noidiv | |
| Disable the ARM-state integer division extension. | |
| @end table | |
| @item armv7e-m | |
| @table @samp | |
| @item +fp | |
| The single-precision VFPv4 floating-point instructions. | |
| @item +fpv5 | |
| The single-precision FPv5 floating-point instructions. | |
| @item +fp.dp | |
| The single- and double-precision FPv5 floating-point instructions. | |
| @item +nofp | |
| Disable the floating-point extensions. | |
| @end table | |
| @item armv8.1-m.main | |
| @table @samp | |
| @item +dsp | |
| The DSP instructions. | |
| @item +mve | |
| The M-Profile Vector Extension (MVE) integer instructions. | |
| @item +mve.fp | |
| The M-Profile Vector Extension (MVE) integer and single precision | |
| floating-point instructions. | |
| @item +fp | |
| The single-precision floating-point instructions. | |
| @item +fp.dp | |
| The single- and double-precision floating-point instructions. | |
| @item +nofp | |
| Disable the floating-point extension. | |
| @item +cdecp0, +cdecp1, ... , +cdecp7 | |
| Enable the Custom Datapath Extension (CDE) on selected coprocessors according | |
| to the numbers given in the options in the range 0 to 7. | |
| @item +pacbti | |
| Enable the Pointer Authentication and Branch Target Identification Extension. | |
| @end table | |
| @item armv8-m.main | |
| @table @samp | |
| @item +dsp | |
| The DSP instructions. | |
| @item +nodsp | |
| Disable the DSP extension. | |
| @item +fp | |
| The single-precision floating-point instructions. | |
| @item +fp.dp | |
| The single- and double-precision floating-point instructions. | |
| @item +nofp | |
| Disable the floating-point extension. | |
| @item +cdecp0, +cdecp1, ... , +cdecp7 | |
| Enable the Custom Datapath Extension (CDE) on selected coprocessors according | |
| to the numbers given in the options in the range 0 to 7. | |
| @end table | |
| @item armv8-r | |
| @table @samp | |
| @item +crc | |
| The Cyclic Redundancy Check (CRC) instructions. | |
| @item +fp.sp | |
| The single-precision FPv5 floating-point instructions. | |
| @item +simd | |
| The ARMv8-A Advanced SIMD and floating-point instructions. | |
| @item +crypto | |
| The cryptographic instructions. | |
| @item +nocrypto | |
| Disable the cryptographic instructions. | |
| @item +nofp | |
| Disable the floating-point, Advanced SIMD and cryptographic instructions. | |
| @end table | |
| @end table | |
| @option{-march=native} causes the compiler to auto-detect the architecture | |
| of the build computer. At present, this feature is only supported on | |
| GNU/Linux, and not all architectures are recognized. If the auto-detect | |
| is unsuccessful the option has no effect. | |
| @option{-march=unset} causes the compiler to ignore any | |
| @option{-march=@dots{}} options that appear earlier on the command line | |
| and behave as if the option was never passed. This is useful to avoid | |
| warnings about conflicting CPU and architecture options when the two | |
| produce different architecture specifications. | |
| @opindex mtune | |
| @item -mtune=@var{name} | |
| This option specifies the name of the target ARM processor for | |
| which GCC should tune the performance of the code. | |
| For some ARM implementations better performance can be obtained by using | |
| this option. | |
| Permissible names are: @samp{arm7tdmi}, @samp{arm7tdmi-s}, @samp{arm710t}, | |
| @samp{arm720t}, @samp{arm740t}, @samp{strongarm}, @samp{strongarm110}, | |
| @samp{strongarm1100}, @samp{strongarm1110}, @samp{arm8}, @samp{arm810}, | |
| @samp{arm9}, @samp{arm9e}, @samp{arm920}, @samp{arm920t}, @samp{arm922t}, | |
| @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm926ej-s}, | |
| @samp{arm940t}, @samp{arm9tdmi}, @samp{arm10tdmi}, @samp{arm1020t}, | |
| @samp{arm1026ej-s}, @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e}, | |
| @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp}, | |
| @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s}, | |
| @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, | |
| @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17}, | |
| @samp{cortex-a32}, @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, | |
| @samp{cortex-a57}, @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, | |
| @samp{cortex-a76}, @samp{cortex-a76ae}, @samp{cortex-a77}, | |
| @samp{cortex-a78}, @samp{cortex-a78ae}, @samp{cortex-a78c}, @samp{cortex-a710}, | |
| @samp{ares}, @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-r5}, | |
| @samp{cortex-r7}, @samp{cortex-r8}, @samp{cortex-r52}, @samp{cortex-r52plus}, | |
| @samp{cortex-m0}, @samp{cortex-m0plus}, @samp{cortex-m1}, @samp{cortex-m3}, | |
| @samp{cortex-m4}, @samp{cortex-m7}, @samp{cortex-m23}, @samp{cortex-m33}, | |
| @samp{cortex-m35p}, @samp{cortex-m52}, @samp{cortex-m55}, @samp{cortex-m85}, @samp{cortex-x1}, | |
| @samp{cortex-x1c}, @samp{cortex-m1.small-multiply}, @samp{cortex-m0.small-multiply}, | |
| @samp{cortex-m0plus.small-multiply}, @samp{exynos-m1}, @samp{marvell-pj4}, | |
| @samp{neoverse-n1}, @samp{neoverse-n2}, @samp{neoverse-v1}, @samp{xscale}, | |
| @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}, @samp{fa526}, @samp{fa626}, | |
| @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}, @samp{star-mc1}, | |
| @samp{star-mc3}, @samp{xgene1}. | |
| Additionally, this option can specify that GCC should tune the performance | |
| of the code for a big.LITTLE system. Permissible names are: | |
| @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7}, | |
| @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}, | |
| @samp{cortex-a72.cortex-a35}, @samp{cortex-a73.cortex-a53}, | |
| @samp{cortex-a75.cortex-a55}, @samp{cortex-a76.cortex-a55}. | |
| @option{-mtune=generic-@var{arch}} specifies that GCC should tune the | |
| performance for a blend of processors within architecture @var{arch}. | |
| The aim is to generate code that run well on the current most popular | |
| processors, balancing between optimizations that benefit some CPUs in the | |
| range, and avoiding performance pitfalls of other CPUs. The effects of | |
| this option may change in future GCC versions as CPU models come and go. | |
| @option{-mtune} permits the same extension options as @option{-mcpu}, but | |
| the extension options do not affect the tuning of the generated code. | |
| @option{-mtune=native} causes the compiler to auto-detect the CPU | |
| of the build computer. At present, this feature is only supported on | |
| GNU/Linux, and not all architectures are recognized. If the auto-detect is | |
| unsuccessful the option has no effect. | |
| @opindex mcpu | |
| @item -mcpu=@var{name}@r{[}+extension@dots{}@r{]} | |
| This specifies the name of the target ARM processor. GCC uses this name | |
| to derive the name of the target ARM architecture (as if specified | |
| by @option{-march}) and the ARM processor type for which to tune for | |
| performance (as if specified by @option{-mtune}). Where this option | |
| is used in conjunction with @option{-march} or @option{-mtune}, | |
| those options take precedence over the appropriate part of this option. | |
| Many of the supported CPUs implement optional architectural | |
| extensions. Where this is so the architectural extensions are | |
| normally enabled by default. If implementations that lack the | |
| extension exist, then the extension syntax can be used to disable | |
| those extensions that have been omitted. For floating-point and | |
| Advanced SIMD (Neon) instructions, the settings of the options | |
| @option{-mfloat-abi} and @option{-mfpu} must also be considered: | |
| floating-point and Advanced SIMD instructions will only be used if | |
| @option{-mfloat-abi} is not set to @samp{soft}; and any setting of | |
| @option{-mfpu} other than @samp{auto} will override the available | |
| floating-point and SIMD extension instructions. | |
| For example, @samp{cortex-a9} can be found in three major | |
| configurations: integer only, with just a floating-point unit or with | |
| floating-point and Advanced SIMD. The default is to enable all the | |
| instructions, but the extensions @samp{+nosimd} and @samp{+nofp} can | |
| be used to disable just the SIMD or both the SIMD and floating-point | |
| instructions respectively. | |
| Permissible names for this option are the same as those for | |
| @option{-mtune}. | |
| The following extension options are common to the listed CPUs: | |
| @table @samp | |
| @item +nodsp | |
| Disable the DSP instructions on @samp{cortex-m33}, @samp{cortex-m35p}, | |
| @samp{cortex-m52}, @samp{cortex-m55}, @samp{cortex-m85} and @samp{star-mc3}. | |
| Also disable the M-Profile Vector Extension (MVE) integer and | |
| single precision floating-point instructions on | |
| @samp{cortex-m52}, @samp{cortex-m55}, @samp{cortex-m85} and @samp{star-mc3}. | |
| @item +nopacbti | |
| Disable the Pointer Authentication and Branch Target Identification Extension | |
| on @samp{cortex-m52}, @samp{cortex-m85} and @samp{star-mc3}. | |
| @item +nomve | |
| Disable the M-Profile Vector Extension (MVE) integer and single precision | |
| floating-point instructions on @samp{cortex-m52}, @samp{cortex-m55}, | |
| @samp{cortex-m85} and @samp{star-mc3}. | |
| @item +nomve.fp | |
| Disable the M-Profile Vector Extension (MVE) single precision floating-point | |
| instructions on @samp{cortex-m52}, @samp{cortex-m55}, @samp{cortex-m85} and | |
| @samp{star-mc3}. | |
| @item +cdecp0, +cdecp1, ... , +cdecp7 | |
| Enable the Custom Datapath Extension (CDE) on selected coprocessors according | |
| to the numbers given in the options in the range 0 to 7 on @samp{cortex-m52}, | |
| @samp{cortex-m55}, @samp{cortex-m85}, @samp{star-mc1} and @samp{star-mc3}. | |
| @item +nofp | |
| Disables the floating-point instructions on @samp{arm9e}, | |
| @samp{arm946e-s}, @samp{arm966e-s}, @samp{arm968e-s}, @samp{arm10e}, | |
| @samp{arm1020e}, @samp{arm1022e}, @samp{arm926ej-s}, | |
| @samp{arm1026ej-s}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8}, | |
| @samp{cortex-m4}, @samp{cortex-m7}, @samp{cortex-m33}, @samp{cortex-m35p}, | |
| @samp{cortex-m52}, @samp{cortex-m55}, @samp{cortex-m85} and @samp{star-mc3}. | |
| Disables the floating-point and SIMD instructions on | |
| @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, | |
| @samp{cortex-a8}, @samp{cortex-a9}, @samp{cortex-a12}, | |
| @samp{cortex-a15}, @samp{cortex-a17}, @samp{cortex-a15.cortex-a7}, | |
| @samp{cortex-a17.cortex-a7}, @samp{cortex-a32}, @samp{cortex-a35}, | |
| @samp{cortex-a53} and @samp{cortex-a55}. | |
| @item +nofp.dp | |
| Disables the double-precision component of the floating-point instructions | |
| on @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-r8}, @samp{cortex-r52}, | |
| @samp{cortex-r52plus} and @samp{cortex-m7}. | |
| @item +nosimd | |
| Disables the SIMD (but not floating-point) instructions on | |
| @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7} | |
| and @samp{cortex-a9}. | |
| @item +crypto | |
| Enables the cryptographic instructions on @samp{cortex-a32}, | |
| @samp{cortex-a35}, @samp{cortex-a53}, @samp{cortex-a55}, @samp{cortex-a57}, | |
| @samp{cortex-a72}, @samp{cortex-a73}, @samp{cortex-a75}, @samp{exynos-m1}, | |
| @samp{xgene1}, @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}, | |
| @samp{cortex-a73.cortex-a35}, @samp{cortex-a73.cortex-a53} and | |
| @samp{cortex-a75.cortex-a55}. | |
| @end table | |
| Additionally the @samp{generic-armv7-a} pseudo target defaults to | |
| VFPv3 with 16 double-precision registers. It supports the following | |
| extension options: @samp{mp}, @samp{sec}, @samp{vfpv3-d16}, | |
| @samp{vfpv3}, @samp{vfpv3-d16-fp16}, @samp{vfpv3-fp16}, | |
| @samp{vfpv4-d16}, @samp{vfpv4}, @samp{neon}, @samp{neon-vfpv3}, | |
| @samp{neon-fp16}, @samp{neon-vfpv4}. The meanings are the same as for | |
| the extensions to @option{-march=armv7-a}. | |
| @option{-mcpu=generic-@var{arch}} is also permissible, and is | |
| equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}. | |
| See @option{-mtune} for more information. | |
| @option{-mcpu=native} causes the compiler to auto-detect the CPU | |
| of the build computer. At present, this feature is only supported on | |
| GNU/Linux, and not all architectures are recognized. If the auto-detect | |
| is unsuccessful the option has no effect. | |
| @option{-mcpu=unset} causes the compiler to ignore any | |
| @option{-mcpu=@dots{}} options that appear earlier on the command line | |
| and behave as if the option was never passed. This is useful to avoid | |
| warnings about conflicting CPU and architecture options when the two | |
| produce different architecture specifications. | |
| @opindex mfpu | |
| @item -mfpu=@var{name} | |
| This specifies what floating-point hardware (or hardware emulation) is | |
| available on the target. Permissible names are: @samp{auto}, @samp{vfpv2}, | |
| @samp{vfpv3}, | |
| @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, | |
| @samp{vfpv3xd-fp16}, @samp{neon-vfpv3}, @samp{neon-fp16}, @samp{vfpv4}, | |
| @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4}, | |
| @samp{fpv5-d16}, @samp{fpv5-sp-d16}, | |
| @samp{fp-armv8}, @samp{neon-fp-armv8} and @samp{crypto-neon-fp-armv8}. | |
| Note that @samp{neon} is an alias for @samp{neon-vfpv3} and @samp{vfp} | |
| is an alias for @samp{vfpv2}. | |
| The setting @samp{auto} is the default and is special. It causes the | |
| compiler to select the floating-point and Advanced SIMD instructions | |
| based on the settings of @option{-mcpu} and @option{-march}. | |
| If the selected floating-point hardware includes the NEON extension | |
| (e.g.@: @option{-mfpu=neon}), note that floating-point | |
| operations are not generated by GCC's auto-vectorization pass unless | |
| @option{-funsafe-math-optimizations} is also specified. This is | |
| because NEON hardware does not fully implement the IEEE 754 standard for | |
| floating-point arithmetic (in particular denormal values are treated as | |
| zero), so the use of NEON instructions may lead to a loss of precision. | |
| You can also set the fpu name at function level by using the @code{target("fpu=")} function attributes (@pxref{ARM Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}). | |
| @opindex mfp16-format | |
| @item -mfp16-format=@var{name} | |
| Specify the format of the @code{__fp16} half-precision floating-point type. | |
| Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative}; | |
| the default is @samp{none}, in which case the @code{__fp16} type is not | |
| defined. @xref{Half-Precision}, for more information. | |
| @opindex mstructure-size-boundary | |
| @item -mstructure-size-boundary=@var{n} | |
| The sizes of all structures and unions are rounded up to a multiple | |
| of the number of bits set by this option. Permissible values are 8, 32 | |
| and 64. The default value varies for different toolchains. For the COFF | |
| targeted toolchain the default value is 8. A value of 64 is only allowed | |
| if the underlying ABI supports it. | |
| Specifying a larger number can produce faster, more efficient code, but | |
| can also increase the size of the program. Different values are potentially | |
| incompatible. Code compiled with one value cannot necessarily expect to | |
| work with code or libraries compiled with another value, if they exchange | |
| information using structures or unions. | |
| This option is deprecated. | |
| @opindex mabort-on-noreturn | |
| @opindex mno-abort-on-noreturn | |
| @item -mabort-on-noreturn | |
| Generate a call to the function @code{abort} at the end of a | |
| @code{noreturn} function. It is executed if the function tries to | |
| return. | |
| @opindex mlong-calls | |
| @opindex mno-long-calls | |
| @item -mlong-calls | |
| @itemx -mno-long-calls | |
| Tells the compiler to perform function calls by first loading the | |
| address of the function into a register and then performing a subroutine | |
| call on this register. This switch is needed if the target function | |
| lies outside of the 64-megabyte addressing range of the offset-based | |
| version of subroutine call instruction. | |
| Even if this switch is enabled, not all function calls are turned | |
| into long calls. The heuristic is that static functions, functions | |
| that have the @code{short_call} attribute, functions that are inside | |
| the scope of a @code{#pragma no_long_calls} directive, and functions whose | |
| definitions have already been compiled within the current compilation | |
| unit are not turned into long calls. The exceptions to this rule are | |
| that weak function definitions, functions with the @code{long_call} | |
| attribute or the @code{section} attribute, and functions that are within | |
| the scope of a @code{#pragma long_calls} directive are always | |
| turned into long calls. | |
| This feature is not enabled by default. Specifying | |
| @option{-mno-long-calls} restores the default behavior, as does | |
| placing the function calls within the scope of a @code{#pragma | |
| long_calls_off} directive. Note these switches have no effect on how | |
| the compiler generates code to handle function calls via function | |
| pointers. | |
| @opindex msingle-pic-base | |
| @opindex mno-single-pic-base | |
| @item -msingle-pic-base | |
| Treat the register used for PIC addressing as read-only, rather than | |
| loading it in the prologue for each function. The runtime system is | |
| responsible for initializing this register with an appropriate value | |
| before execution begins. | |
| @opindex mpic-register | |
| @item -mpic-register=@var{reg} | |
| Specify the register to be used for PIC addressing. | |
| For standard PIC base case, the default is any suitable register | |
| determined by compiler. For single PIC base case, the default is | |
| @samp{R9} if target is EABI based or stack-checking is enabled, | |
| otherwise the default is @samp{R10}. | |
| @opindex mpic-data-is-text-relative | |
| @opindex mno-pic-data-is-text-relative | |
| @item -mpic-data-is-text-relative | |
| Assume that the displacement between the text and data segments is fixed | |
| at static link time. This permits using PC-relative addressing | |
| operations to access data known to be in the data segment. For | |
| non-VxWorks RTP targets, this option is enabled by default. When | |
| disabled on such targets, it will enable @option{-msingle-pic-base} by | |
| default. | |
| @opindex mpoke-function-name | |
| @opindex mno-poke-function-name | |
| @item -mpoke-function-name | |
| Write the name of each function into the text section, directly | |
| preceding the function prologue. The generated code is similar to this: | |
| @smallexample | |
| t0 | |
| .ascii "arm_poke_function_name", 0 | |
| .align | |
| t1 | |
| .word 0xff000000 + (t1 - t0) | |
| arm_poke_function_name | |
| mov ip, sp | |
| stmfd sp!, @{fp, ip, lr, pc@} | |
| sub fp, ip, #4 | |
| @end smallexample | |
| When performing a stack backtrace, code can inspect the value of | |
| @code{pc} stored at @code{fp + 0}. If the trace function then looks at | |
| location @code{pc - 12} and the top 8 bits are set, then we know that | |
| there is a function name embedded immediately preceding this location | |
| and has length @code{((pc[-3]) & 0xff000000)}. | |
| @opindex marm | |
| @opindex mthumb | |
| @item -mthumb | |
| @itemx -marm | |
| Select between generating code that executes in ARM and Thumb | |
| states. The default for most configurations is to generate code | |
| that executes in ARM state, but the default can be changed by | |
| configuring GCC with the @option{--with-mode=}@var{state} | |
| configure option. | |
| You can also override the ARM and Thumb mode for each function | |
| by using the @code{target("thumb")} and @code{target("arm")} function attributes | |
| (@pxref{ARM Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}). | |
| @opindex mtpcs-frame | |
| @opindex mno-tpcs-frame | |
| @item -mtpcs-frame | |
| Generate a stack frame that is compliant with the Thumb Procedure Call | |
| Standard for all non-leaf functions. (A leaf function is one that does | |
| not call any other functions.) The default is @option{-mno-tpcs-frame}. | |
| @opindex mtpcs-leaf-frame | |
| @opindex mno-tpcs-leaf-frame | |
| @item -mtpcs-leaf-frame | |
| Generate a stack frame that is compliant with the Thumb Procedure Call | |
| Standard for all leaf functions. (A leaf function is one that does | |
| not call any other functions.) The default is @option{-mno-apcs-leaf-frame}. | |
| @opindex mcallee-super-interworking | |
| @opindex mno-callee-super-interworking | |
| @item -mcallee-super-interworking | |
| Gives all externally visible functions in the file being compiled an ARM | |
| instruction set header which switches to Thumb mode before executing the | |
| rest of the function. This allows these functions to be called from | |
| non-interworking code. This option is not valid in AAPCS configurations | |
| because interworking is enabled by default. | |
| @opindex mcaller-super-interworking | |
| @opindex mno-caller-super-interworking | |
| @item -mcaller-super-interworking | |
| Allows calls via function pointers (including virtual functions) to | |
| execute correctly regardless of whether the target code has been | |
| compiled for interworking or not. There is a small overhead in the cost | |
| of executing a function pointer if this option is enabled. This option | |
| is not valid in AAPCS configurations because interworking is enabled | |
| by default. | |
| @opindex mtp | |
| @item -mtp=@var{name} | |
| Specify the access model for the thread local storage pointer. The model | |
| @samp{soft} generates calls to @code{__aeabi_read_tp}. Other accepted | |
| models are @samp{tpidrurw}, @samp{tpidruro} and @samp{tpidrprw} which fetch | |
| the thread pointer from the corresponding system register directly | |
| (supported from the arm6k architecture and later). These system registers | |
| are accessed through the CP15 co-processor interface and the argument | |
| @samp{cp15} is also accepted as a convenience alias of @samp{tpidruro}. | |
| The argument @samp{auto} uses the best available method for the selected | |
| processor. The default setting is @samp{auto}. | |
| @opindex mtls-dialect | |
| @item -mtls-dialect=@var{dialect} | |
| Specify the dialect to use for accessing thread local storage. Two | |
| @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}. The | |
| @samp{gnu} dialect selects the original GNU scheme for supporting | |
| local and global dynamic TLS models. The @samp{gnu2} dialect | |
| selects the GNU descriptor scheme, which provides better performance | |
| for shared libraries. The GNU descriptor scheme is compatible with | |
| the original scheme, but does require new assembler, linker and | |
| library support. Initial and local exec TLS models are unaffected by | |
| this option and always use the original scheme. | |
| @opindex mword-relocations | |
| @opindex mno-word-relocations | |
| @item -mword-relocations | |
| Only generate absolute relocations on word-sized values (i.e.@: R_ARM_ABS32). | |
| This is enabled by default on targets (uClinux, SymbianOS) where the runtime | |
| loader imposes this restriction, and when @option{-fpic} or @option{-fPIC} | |
| is specified. This option conflicts with @option{-mslow-flash-data}. | |
| @opindex mfix-cortex-m3-ldrd | |
| @opindex mno-fix-cortex-m3-ldrd | |
| @item -mfix-cortex-m3-ldrd | |
| Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions | |
| with overlapping destination and base registers are used. This option avoids | |
| generating these instructions. This option is enabled by default when | |
| @option{-mcpu=cortex-m3} is specified. | |
| @opindex mfix-cortex-a57-aes-1742098 | |
| @opindex mno-fix-cortex-a57-aes-1742098 | |
| @opindex mfix-cortex-a72-aes-1655431 | |
| @opindex mno-fix-cortex-a72-aes-1655431 | |
| @item -mfix-cortex-a57-aes-1742098 | |
| @itemx -mno-fix-cortex-a57-aes-1742098 | |
| @itemx -mfix-cortex-a72-aes-1655431 | |
| @itemx -mno-fix-cortex-a72-aes-1655431 | |
| Enable (disable) mitigation for an erratum on Cortex-A57 and | |
| Cortex-A72 that affects the AES cryptographic instructions. This | |
| option is enabled by default when either @option{-mcpu=cortex-a57} or | |
| @option{-mcpu=cortex-a72} is specified. | |
| @opindex munaligned-access | |
| @opindex mno-unaligned-access | |
| @item -munaligned-access | |
| @itemx -mno-unaligned-access | |
| Enables (or disables) reading and writing of 16- and 32- bit values | |
| from addresses that are not 16- or 32- bit aligned. By default | |
| unaligned access is disabled for all pre-ARMv6, all ARMv6-M and for | |
| ARMv8-M Baseline architectures, and enabled for all other | |
| architectures. If unaligned access is not enabled then words in packed | |
| data structures are accessed a byte at a time. | |
| The ARM attribute @code{Tag_CPU_unaligned_access} is set in the | |
| generated object file to either true or false, depending upon the | |
| setting of this option. If unaligned access is enabled then the | |
| preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also | |
| defined. | |
| @opindex mslow-flash-data | |
| @opindex mno-slow-flash-data | |
| @item -mslow-flash-data | |
| Assume loading data from flash is slower than fetching instruction. | |
| Therefore literal load is minimized for better performance. | |
| This option is only supported when compiling for ARMv7 M-profile and | |
| off by default. It conflicts with @option{-mword-relocations}. | |
| @opindex masm-syntax-unified | |
| @opindex mno-asm-syntax-unified | |
| @item -masm-syntax-unified | |
| Assume inline assembler is using unified asm syntax. The default is | |
| currently off which implies divided syntax. This option has no impact | |
| on Thumb2. However, this may change in future releases of GCC. | |
| Divided syntax should be considered deprecated. | |
| @opindex mrestrict-it | |
| @opindex mno-restrict-it | |
| @item -mrestrict-it | |
| Restricts generation of IT blocks to conform to the rules of ARMv8-A. | |
| IT blocks can only contain a single 16-bit instruction from a select | |
| set of instructions. This option is on by default for ARMv8-A Thumb mode. | |
| @opindex mpure-code | |
| @opindex mno-pure-code | |
| @item -mpure-code | |
| Do not allow constant data to be placed in code sections. | |
| Additionally, when compiling for ELF object format give all text sections the | |
| ELF processor-specific section attribute @code{SHF_ARM_PURECODE}. This option | |
| is only available when generating non-pic code for M-profile targets. | |
| @opindex mcmse | |
| @item -mcmse | |
| Generate secure code as per the "ARMv8-M Security Extensions: Requirements on | |
| Development Tools Engineering Specification", which can be found on | |
| @url{https://support.arm.com/documentation/ecm0359818/latest/}. | |
| @opindex mfix-cmse-cve-2021-35465 | |
| @opindex mno-fix-cmse-cve-2021-35465 | |
| @item -mfix-cmse-cve-2021-35465 | |
| Mitigate against a potential security issue with the @code{VLLDM} instruction | |
| in some M-profile devices when using CMSE (CVE-2021-35465). This option is | |
| enabled by default when the option @option{-mcpu=} is used with | |
| @code{cortex-m33}, @code{cortex-m35p}, @code{cortex-m55}, | |
| @code{cortex-m85} or @code{star-mc1}. The option @option{-mno-fix-cmse-cve-2021-35465} | |
| can be used to disable the mitigation. | |
| @opindex mstack-protector-guard | |
| @opindex mstack-protector-guard-offset | |
| @item -mstack-protector-guard=@var{guard} | |
| @itemx -mstack-protector-guard-offset=@var{offset} | |
| Generate stack protection code using canary at @var{guard}. Supported | |
| locations are @samp{global} for a global canary or @samp{tls} for a | |
| canary accessible via the TLS register. The option | |
| @option{-mstack-protector-guard-offset=} is for use with | |
| @option{-fstack-protector-guard=tls} and not for use in user-land code. | |
| @opindex mfdpic | |
| @opindex mno-fdpic | |
| @item -mfdpic | |
| @itemx -mno-fdpic | |
| Select the FDPIC ABI, which uses 64-bit function descriptors to | |
| represent pointers to functions. When the compiler is configured for | |
| @code{arm-*-uclinuxfdpiceabi} targets, this option is on by default | |
| and implies @option{-fPIE} if none of the PIC/PIE-related options is | |
| provided. On other targets, it only enables the FDPIC-specific code | |
| generation features, and the user should explicitly provide the | |
| PIC/PIE-related options as needed. | |
| Note that static linking is not supported because it would still | |
| involve the dynamic linker when the program self-relocates. If such | |
| behavior is acceptable, use -static and -Wl,-dynamic-linker options. | |
| The opposite @option{-mno-fdpic} option is useful (and required) to | |
| build the Linux kernel using the same (@code{arm-*-uclinuxfdpiceabi}) | |
| toolchain as the one used to build the userland programs. | |
| @opindex mbranch-protection | |
| @item -mbranch-protection=@var{features} | |
| Enable branch protection features (armv8.1-m.main only). | |
| @var{features} can have one of the following forms: | |
| @samp{none} generates code without branch protection or return address | |
| signing. | |
| @samp{standard} generates code with all branch protection | |
| features enabled at their standard level. | |
| @samp{pac-ret} generates code with return address signing | |
| set to its standard level, which is to sign all functions that save | |
| the return address to memory. | |
| @samp{pac-ret+leaf} extends the @samp{pac-ret} signing to include leaf | |
| functions even if they do not write the return address to memory. | |
| @samp{bti} adds landing-pad instructions at the permitted targets of | |
| indirect branch instructions. | |
| If support for the @samp{+pacbti} architecture extension is not enabled | |
| (e.g. via @option{-march=}), then all | |
| branch protection and return address signing operations are | |
| constrained to use only the instructions defined in the | |
| architectural-NOP space. The generated code remains | |
| backwards-compatible with earlier versions of the architecture, but | |
| the additional security can be enabled at run time on processors that | |
| support the @samp{PACBTI} extension. | |
| Branch target enforcement using BTI can only be enabled at runtime if | |
| all code in the application has been compiled with at least | |
| @samp{-mbranch-protection=bti}. | |
| Any setting other than @samp{none} is supported only on armv8-m.main | |
| or later. | |
| The default is to generate code without branch protection or return | |
| address signing. | |
| @opindex mvectorize-with-neon-quad | |
| @opindex mvectorize-with-neon-double | |
| @item -mvectorize-with-neon-quad | |
| @itemx -mvectorize-with-neon-double | |
| Control whether vectorization uses NEON quad-word or double-word registers. | |
| The default is @option{-mvectorize-with-neon-quad}. | |
| @end table | |
| @node AVR Options | |
| @subsection AVR Options | |
| @cindex AVR Options | |
| These options are defined for AVR implementations: | |
| @table @gcctabopt | |
| @opindex mmcu | |
| @item -mmcu=@var{mcu} | |
| Specify the AVR instruction set architecture (ISA) or device type. | |
| The default for this option is@tie{}@code{avr2}. | |
| The following AVR devices and ISAs are supported. | |
| @emph{Note:} A complete device support consists of | |
| startup code @code{crt@var{mcu}.o}, a device header @code{avr/io*.h}, | |
| a device library @code{lib@var{mcu}.a} and a | |
| @uref{https://gcc.gnu.org/wiki/avr-gcc#spec-files,,device-specs} file | |
| @code{specs-@var{mcu}}. Only the latter is provided by the compiler | |
| according to the supported @code{@var{mcu}}s below. The rest is supported | |
| by @w{@uref{https://github.com/avrdudes/avr-libc/,,AVR-LibC}}, or by means of | |
| @uref{https://gcc.gnu.org/wiki/avr-gcc#atpack,,@code{atpack}} files | |
| from the hardware manufacturer. | |
| @c Auto-generated. Re-build when new devices are added to avr-mcus.def | |
| @c by running "make avr-mcus" in $builddir/gcc. | |
| @include avr-mmcu.texi | |
| @opindex mabsdata | |
| @item -mabsdata | |
| Assume that all data in static storage can be accessed by LDS / STS | |
| instructions. This option has only an effect on reduced Tiny devices like | |
| ATtiny40. See also the @code{absdata} | |
| @ref{AVR Attributes,variable attribute}. | |
| @anchor{avr_masm_len_notes} | |
| @opindex masm-len-notes | |
| @item -masm-len-notes | |
| @itemx -mno-asm-len-notes | |
| Recognize resp.@: ignore @code{[[len=@var{spec}]]} notes that are placed in | |
| (comments in) inline assembly code templates. They allow to specify | |
| the exact @ref{Size of an asm,,size of @code{asm} constructs}. | |
| This option is on per default. | |
| @opindex mcvt | |
| @item -mcvt | |
| Use a @emph{compact vector table}. Some devices support a CVT | |
| with only four entries: 0=Reset, 1=NMI, 2=Prio1 IRQ, 3=Prio0 IRQs. | |
| This option will link startup code from @code{crt@var{mcu}-cvt.o} | |
| instead of the usual @code{crt@var{mcu}.o}. | |
| Apart from providing a compact vector table, the startup code will set bit | |
| @code{CPUINT_CTRLA.CPUINT_CVT} which enables the CVT on the device. | |
| When you do not want the startup code to set @code{CPUINT_CTRLA.CPUINT_CVT}, | |
| then you can satisfy symbol @code{__init_cvt} so that the respective | |
| code is no more pulled in from @code{lib@var{mcu}.a}. | |
| For example, you can link with @code{-Wl,--defsym,__init_cvt=0}. | |
| The CVT startup code is available since | |
| @w{@uref{https://github.com/avrdudes/avr-libc/issues/1010,,AVR-LibC v2.3}}. | |
| @opindex mdouble | |
| @opindex mlong-double | |
| @item -mdouble=@var{bits} | |
| @itemx -mlong-double=@var{bits} | |
| Set the size (in bits) of the @code{double} or @code{long double} type, | |
| respectively. Possible values for @var{bits} are 32 and 64. | |
| Whether or not a specific value for @var{bits} is allowed depends on | |
| the @code{--with-double=} and @code{--with-long-double=} | |
| @w{@uref{https://gcc.gnu.org/install/configure.html#avr,,configure options}}, | |
| and the same applies for the default values of the options. | |
| @opindex mfract-convert-truncate | |
| @item -mfract-convert-truncate | |
| Allow to use truncation instead of rounding towards zero for fractional fixed-point types. | |
| @opindex mgas-isr-prologues | |
| @item -mgas-isr-prologues | |
| Interrupt service routines (ISRs) may use the @code{__gcc_isr} pseudo | |
| instruction supported by GNU Binutils. | |
| If this option is on, the feature can still be disabled for individual | |
| ISRs by means of the @ref{AVR Attributes,,@code{no_gccisr}} | |
| function attribute. This feature is activated per default | |
| if optimization is on (but not with @option{-Og}, @pxref{Optimize Options}), | |
| and if GNU Binutils support @w{@uref{https://sourceware.org/PR21683,,PR21683}}. | |
| @opindex mint8 | |
| @item -mint8 | |
| Assume @code{int} to be 8-bit integer. This affects the sizes of all types: a | |
| @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes, | |
| and @code{long long} is 4 bytes. Please note that this option does not | |
| conform to the C standards, but it results in smaller code | |
| size. | |
| @opindex mmain-is-OS_task | |
| @item -mmain-is-OS_task | |
| Do not save registers in @code{main}. The effect is the same like | |
| attaching attribute @ref{AVR Attributes,,@code{OS_task}} | |
| to @code{main}. It is activated per default if optimization is on. | |
| @opindex mno-call-main | |
| @opindex mcall-main | |
| @item -mno-call-main | |
| Don't run @code{main} by means of | |
| @example | |
| XCALL main | |
| XJMP exit | |
| @end example | |
| Instead, put @code{main} in section | |
| @w{@uref{https://avrdudes.github.io/avr-libc/avr-libc-user-manual/mem_sections.html#sec_dot_init,,@code{.init9}}} | |
| so that no call is required. | |
| By setting this option the user asserts that @code{main} will not return. | |
| This option can be used for devices with very limited resources in order | |
| to save a few bytes of code and stack space. It will work as expected since | |
| @w{@uref{https://github.com/avrdudes/avr-libc/issues/1012,,AVR-LibC v2.3}}. | |
| With older versions, there will be no performance gain. | |
| @opindex mno-interrupts | |
| @item -mno-interrupts | |
| Generated code is not compatible with hardware interrupts. | |
| Code size is smaller. | |
| @opindex mpmem-wrap-around | |
| @opindex mno-pmem-wrap-around | |
| @item -mpmem-wrap-around | |
| Enable program counter wrap-around in linker relaxation. | |
| @opindex mrodata-in-ram | |
| @item -mrodata-in-ram | |
| @itemx -mno-rodata-in-ram | |
| Locate the @code{.rodata} sections for read-only data in RAM resp.@: | |
| in program memory. | |
| For most devices, there is no choice and this option acts rather | |
| like an assertion. | |
| Since v14 and for the AVR64* and AVR128* devices, @code{.rodata} | |
| is located in flash memory per default, provided the required GNU Binutils | |
| support (@w{@uref{https://sourceware.org/PR31124,,PR31124}}) is available. | |
| In that case, @option{-mrodata-in-ram} can be used to return to the old | |
| layout with @code{.rodata} in RAM. | |
| @opindex mrelax | |
| @item -mrelax | |
| Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter | |
| @code{RCALL} resp.@: @code{RJMP} instruction if applicable. | |
| Setting @option{-mrelax} just adds the @option{--mlink-relax} option to | |
| the assembler's command line and the @option{--relax} option to the | |
| linker's command line. | |
| Jump relaxing is performed by the linker because jump offsets are not | |
| known before code is located. Therefore, the assembly code generated by the | |
| compiler is the same, but the instructions in the executable may | |
| differ from instructions in the assembly code. | |
| Relaxing can be used to remove unused linker stubs, see the | |
| section on @code{EIND} and linker stubs below. | |
| @opindex mprune-vectab | |
| @item -mprune-vectab | |
| Remove unused entries in the AVR-LibC interrupt vector table during relaxing. | |
| An entry is unused when it targets @code{__bad_interrupt} and all following | |
| entries are also unused. | |
| Setting @option{-mprune-vectab} just adds the @option{--prune-vectab} option | |
| to the linker's command line, provided the required GNU Binutils | |
| support (@w{@uref{https://sourceware.org/PR34679,,PR34679}}) is available. | |
| Otherwise, or when relaxing is not enabled, the option has no effect. | |
| This option makes it harder to find rogue IRQs that lack an interrupt service | |
| routine (ISR) and whose IRQ vector is located beyond the last used one. | |
| What is not supported are jumps like | |
| @example | |
| JMP 0x18 | |
| @end example | |
| that target a vector table entry that is not the reset vector. Use code like | |
| @example | |
| JMP __vectors + 0x18 | |
| @end example | |
| instead. | |
| @opindex mstrict-addr-space-subsets | |
| @item -mstrict-addr-space-subsets | |
| Impose strict named address space subset relations. Without this option, | |
| every address space is considered to be a subset of all the other spaces, | |
| which allows to write code like | |
| @example | |
| char read_char (const char *addr, bool in_flash) | |
| @{ | |
| return in_flash | |
| ? *(const __flash char*) addr // Read from program memory. | |
| : *addr; // Read from RAM. | |
| @} | |
| @end example | |
| When the option is on, such code is rejected since address space | |
| @code{__flash} is not a subset of the generic space, and hence the | |
| cast in the above code is prohibited. | |
| @opindex mtiny-stack | |
| @item -mtiny-stack | |
| Only change the lower 8@tie{}bits of the stack pointer. | |
| @opindex nodevicelib | |
| @item -nodevicelib | |
| Don't link against AVR-LibC's device specific library @code{lib@var{mcu}.a}. | |
| Notice that since AVR-LibC v2.3, that library contains code that is | |
| essential for the correct functioning of a program. In particular, | |
| it contains parts of the startup code like: | |
| @w{@uref{https://github.com/avrdudes/avr-libc/issues/1011,,@code{__init_sp}}} | |
| to initialize the stack pointer with symbol @code{__stack}, | |
| @w{@uref{https://github.com/avrdudes/avr-libc/issues/1010,,@code{__init_cvt}}} | |
| to set up the hardware to use a compact vector table with @option{-mcvt}, | |
| @w{@uref{https://github.com/avrdudes/avr-libc/issues/1012,,@code{__call_main}}} | |
| to call @code{main} and @code{exit}, and | |
| @w{@uref{https://github.com/avrdudes/avr-libc/issues/931,,@code{__do_flmap_init}}} | |
| to set up FLMAP according to symbol @code{__flmap}. | |
| @opindex nodevicespecs | |
| @item -nodevicespecs | |
| Don't add @option{-specs=device-specs/specs-@var{mcu}} to the compiler driver's | |
| command line. The user takes responsibility for supplying the sub-processes | |
| like compiler proper, assembler and linker with appropriate command-line | |
| options. This means that the user has to supply her private device specs | |
| file by means of @option{-specs=@var{path-to-specs-file}}. There is no | |
| more need for option @option{-mmcu=@var{mcu}}. | |
| This option can also serve as a replacement for the older way of | |
| specifying custom device-specs files that needed @option{-B @var{some-path}} to point to a directory | |
| which contains a folder named @code{device-specs} which contains a specs file named | |
| @code{specs-@var{mcu}}, where @var{mcu} was specified by @option{-mmcu=@var{mcu}}. | |
| @opindex Waddr-space-convert | |
| @opindex Wno-addr-space-convert | |
| @item -Waddr-space-convert | |
| Warn about conversions between address spaces in the case where the | |
| resulting address space is not contained in the incoming address space. | |
| @anchor{avr_Wasm_len_notes} | |
| @opindex Wasm-len-notes | |
| @item -Wasm-len-notes | |
| Warn about unrecognized @code{[[len=@var{spec}]]} | |
| @ref{Size of an asm,,length} annotations in inline assembly code templates. | |
| This @ref{Warning Options,,warning} is on per default. | |
| Notice that in LTO mode, the code must be compiled with option | |
| @option{-ffat-lto-objects} in order for these diagnoses to appear. | |
| @opindex Wmisspelled-isr | |
| @opindex Wno-misspelled-isr | |
| @item -Wmisspelled-isr | |
| Warn if the ISR is misspelled, i.e.@: without __vector prefix. | |
| Enabled by default. | |
| @end table | |
| @subsubsection AVR Optimization Options | |
| The following options are pure optimization options. | |
| Options @option{-mgas-isr-prologues}, @option{-mmain-is-OS_task}, | |
| @option{-mno-call-main}, @option{-mrelax} and @option{-mprune-vectab} | |
| from above are only | |
| @emph{almost} optimization options, since there are rare occasions | |
| where their different code generation matters. | |
| @table @gcctabopt | |
| @opindex maccumulate-args | |
| @item -maccumulate-args | |
| Accumulate outgoing function arguments and acquire/release the needed | |
| stack space for outgoing function arguments once in function | |
| prologue/epilogue. Without this option, outgoing arguments are pushed | |
| before calling a function and popped afterwards. | |
| See also the @option{-fdefer-pop} | |
| @ref{Optimize Options,,optimization option}. | |
| Popping the arguments after the function call can be expensive on | |
| AVR so that accumulating the stack space might lead to smaller | |
| executables because arguments need not be removed from the | |
| stack after such a function call. | |
| This option can lead to reduced code size for functions that perform | |
| several calls to functions that get their arguments on the stack like | |
| calls to printf-like functions. | |
| @opindex mbranch-cost | |
| @item -mbranch-cost=@var{cost} | |
| Set the branch costs for conditional branch instructions to | |
| @var{cost}. Reasonable values for @var{cost} are small, non-negative | |
| integers. The default branch cost is 0. | |
| @opindex mcall-prologues | |
| @item -mcall-prologues | |
| Functions prologues/epilogues are expanded as calls to appropriate | |
| subroutines. Code size is smaller. | |
| @opindex mdemote-switch | |
| @item -mdemote-switch | |
| Without this option, the compiler will treat @code{switch} variables | |
| as 32-bit values at least. When this option is on, an AVR-specific | |
| pass will try to demote such @code{switch} variables to the widths | |
| as actually used in the program. This option is on per default when | |
| optimization is on. | |
| @opindex mfuse-add | |
| @item -mfuse-add | |
| @itemx -mno-fuse-add | |
| @itemx -mfuse-add=@var{level} | |
| Optimize indirect memory accesses on reduced Tiny devices. | |
| The default uses @code{@var{level}=1} for optimizations @option{-Og} | |
| and @option{-O1}, and @code{@var{level}=2} for higher optimizations. | |
| Valid values for @var{level} are @code{0}, @code{1} and @code{2}. | |
| @opindex mfuse-ifelse | |
| @item -mfuse-ifelse | |
| Optimize compare-branch-compare-branch sequences to compare-branch-branch, | |
| which typically occurs in if-else trees generated from dense switch statements. | |
| This option is enabled per default if optimization is on. | |
| @opindex mfuse-move | |
| @item -mfuse-move | |
| @itemx -mno-fuse-move | |
| @itemx -mfuse-move=@var{level} | |
| Run a post reload optimization pass that tries to fuse move instructions | |
| and to split multi-byte instructions into 8-bit operations. | |
| The default uses @code{@var{level}=3} for optimization @option{-O1}, | |
| and @code{@var{level}=23} for higher optimizations. | |
| Valid values for @var{level} are in the range @code{0} @dots{} @code{23} | |
| which is a 3:2:2:2 mixed radix value. Each digit controls some | |
| aspect of the optimization. | |
| @opindex mfuse-move2 | |
| @item -mfuse-move2 | |
| Run a post combine optimization pass that tries to fuse move instructions. | |
| @opindex moptimize | |
| @item -mno-optimize | |
| @itemx -moptimize | |
| Disable / enable AVR-specific optimization passes, all documented in this | |
| paragraph: @option{-mdemote-switch}, @option{-mfuse-add}, | |
| @option{-mfuse-ifelse}, @option{-mfuse-move}, @option{-mfuse-move2}, | |
| @option{-msplit-ldst}, @option{-msplit-bit-shift}, @option{-muse-nonzero-bits}. | |
| Usually, you don't need to specify this option because the respective passes | |
| are activated by default when optimization is on. | |
| @opindex mstrict-X | |
| @item -mstrict-X | |
| Use address register @code{X} in a way proposed by the hardware. This means | |
| that @code{X} is only used in indirect, post-increment or | |
| pre-decrement addressing. | |
| Without this option, the @code{X} register may be used in the same way | |
| as @code{Y} or @code{Z} which then is emulated by additional | |
| instructions. | |
| For example, loading a value with @code{X+const} addressing with a | |
| small non-negative @code{const < 64} to a register @var{Rn} is | |
| performed as | |
| @example | |
| adiw r26, const ; X += const | |
| ld @var{Rn}, X ; @var{Rn} = *X | |
| sbiw r26, const ; X -= const | |
| @end example | |
| @opindex msplit-bit-shift | |
| @item -msplit-bit-shift | |
| Split multi-byte shifts with a constant offset into a shift with | |
| a byte offset and a residual shift with a non-byte offset. | |
| This optimization is turned on per default for @option{-O2} and higher, | |
| including @option{-Os} but excluding @option{-Oz}. | |
| Splitting of shifts with a constant offset that is | |
| a multiple of 8 is controlled by @option{-mfuse-move}. | |
| @opindex msplit-ldst | |
| @item -msplit-ldst | |
| Split multi-byte loads and stores into several byte loads and stores. | |
| This optimization is turned on per default for @option{-O2} and higher. | |
| @opindex muse-nonzero-bits | |
| @item -muse-nonzero-bits | |
| Enable optimizations that are only possible when some bits in a | |
| register are always zero. | |
| This optimization is turned on per default for @option{-O2} and higher. | |
| @end table | |
| @anchor{eind} | |
| @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash | |
| @cindex @code{EIND} | |
| Pointers in the implementation are 16@tie{}bits wide. | |
| The address of a function or label is represented as word address so | |
| that indirect jumps and calls can target any code address in the | |
| range of 64@tie{}Ki words. | |
| In order to facilitate indirect jump on devices with more than 128@tie{}Ki | |
| bytes of program memory space, there is a special function register called | |
| @code{EIND} that serves as most significant part of the target address | |
| when @code{EICALL} or @code{EIJMP} instructions are used. | |
| Indirect jumps and calls on these devices are handled as follows by | |
| the compiler and are subject to some limitations: | |
| @itemize @bullet | |
| @item | |
| The compiler never sets @code{EIND}. | |
| @item | |
| The compiler uses @code{EIND} implicitly in @code{EICALL}/@code{EIJMP} | |
| instructions or might read @code{EIND} directly in order to emulate an | |
| indirect call/jump by means of a @code{RET} instruction. | |
| @item | |
| The compiler assumes that @code{EIND} never changes during the startup | |
| code or during the application. In particular, @code{EIND} is not | |
| saved/restored in function or interrupt service routine | |
| prologue/epilogue. | |
| @item | |
| For indirect calls to functions and computed goto, the linker | |
| generates @emph{stubs}. Stubs are jump pads sometimes also called | |
| @emph{trampolines}. The indirect @code{EICALL}/@code{EIJMP} jumps to such a | |
| stub, which contains a direct @code{JMP} to the desired address. | |
| @item | |
| The @code{.trampolines} section contains unused stubs that target | |
| locations in the same 128 KiB block like the trampolines. | |
| Linker relaxation can be turned on to remove such unused stubs, see | |
| the compiler option @option{-mrelax} and the linker option @option{--relax}. | |
| @item | |
| The default linker script is arranged for code with @code{EIND = 0}. | |
| If code is supposed to work for a setup with @code{EIND != 0}, a custom | |
| linker script has to be used in order to place the sections whose | |
| name start with @code{.trampolines} into the segment where @code{EIND} | |
| points to. | |
| @item | |
| The startup code from libgcc never sets @code{EIND}. | |
| Notice that startup code is a blend of code from libgcc and AVR-LibC. | |
| For the impact of AVR-LibC on @code{EIND}, see the | |
| @w{@uref{https://avrdudes.github.io/avr-libc/avr-libc-user-manual/,,AVR-LibC user manual}}. | |
| @item | |
| It is legitimate for user-specific startup code to set up @code{EIND} | |
| early, for example by means of initialization code located in | |
| section @code{.init3}. Such code runs prior to general startup code | |
| that initializes RAM and calls constructors, but after the bit | |
| of startup code from AVR-LibC that sets @code{EIND} to the segment | |
| where the vector table is located. | |
| @example | |
| #include <avr/io.h> | |
| static void | |
| __attribute__((section(".init3"),naked,used,no_instrument_function)) | |
| init3_set_eind (void) | |
| @{ | |
| __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t" | |
| "out %i0,r24" :: "n" (&EIND) : "r24","memory"); | |
| @} | |
| @end example | |
| @noindent | |
| The @code{__trampolines_start} symbol is defined in the linker script. | |
| @item | |
| Stubs are generated automatically by the linker when | |
| the following three conditions are met: | |
| @itemize @minus | |
| @item The address of a label is taken by means of the @code{gs} modifier | |
| (short for @emph{generate stubs}) like so: | |
| @example | |
| LDI r24, lo8(gs(@var{func})) | |
| LDI r25, hi8(gs(@var{func})) | |
| @end example | |
| @item The AVR device has more than 128 KiB of program memory. On devices | |
| with at most 128 KiB of program memory, the @code{gs} modifier behaves | |
| like @code{pm}, i.e.@: it evaluates to the word address of the symbol | |
| without generating a stub. | |
| @item Linker relaxation if off, or the symbol has a value outside | |
| the 128 KiB block containing the trampolines. | |
| @end itemize | |
| @item | |
| The compiler emits such @code{gs} modifiers for code labels in the | |
| following situations: | |
| @itemize @minus | |
| @item Taking the address of a function or code label. | |
| @item Computed goto. | |
| @item If the prologue-save function is used, see the @option{-mcall-prologues} | |
| command-line option. | |
| @item Switch/case dispatch tables. If you do not want such dispatch | |
| tables you can specify the @option{-fno-jump-tables} command-line option. | |
| @item C and C++ constructors/destructors called during startup/shutdown. | |
| @item If the tools hit a @code{gs()} modifier explained above. | |
| @end itemize | |
| @item | |
| Jumping to non-symbolic addresses like so is @emph{not} supported: | |
| @example | |
| int main (void) | |
| @{ | |
| /* Call function at word address 0x2 */ | |
| return ((int(*)(void)) 0x2)(); | |
| @} | |
| @end example | |
| Instead, a stub has to be set up, i.e.@: the function has to be called | |
| through a symbol (@code{func_4} in the example): | |
| @example | |
| int main (void) | |
| @{ | |
| extern int func_4 (void); | |
| /* Call function at byte address 0x4 */ | |
| return func_4(); | |
| @} | |
| @end example | |
| and the application be linked with @option{-Wl,--defsym,func_4=0x4}. | |
| Alternatively, @code{func_4} can be defined in the linker script. | |
| @end itemize | |
| @anchor{ramp} | |
| @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers | |
| @cindex @code{RAMPD} | |
| @cindex @code{RAMPX} | |
| @cindex @code{RAMPY} | |
| @cindex @code{RAMPZ} | |
| Some AVR devices support memories larger than the 64@tie{}KiB range | |
| that can be accessed with 16-bit pointers. To access memory locations | |
| outside this 64@tie{}KiB range, the content of a @code{RAMP} | |
| register is used as high part of the address: | |
| The @code{X}, @code{Y}, @code{Z} address register is concatenated | |
| with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function | |
| register, respectively, to get a wide address. Similarly, | |
| @code{RAMPD} is used together with direct addressing. | |
| @itemize | |
| @item | |
| The startup code initializes the @code{RAMP} special function | |
| registers with zero. | |
| @item | |
| If a @ref{AVR Named Address Spaces,,named address space} other than | |
| generic or @code{__flash} is used, then @code{RAMPZ} is set | |
| as needed before the operation. | |
| @item | |
| If the device supports RAM larger than 64@tie{}KiB and the compiler | |
| needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ} | |
| is reset to zero after the operation. | |
| @item | |
| If the device comes with a specific @code{RAMP} register, the ISR | |
| prologue/epilogue saves/restores that SFR and initializes it with | |
| zero in case the ISR code might (implicitly) use it. | |
| @item | |
| RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets. | |
| If you use inline assembly to read from locations outside the | |
| 16-bit address range and change one of the @code{RAMP} registers, | |
| you must reset it to zero after the access. | |
| @end itemize | |
| @anchor{avr-macros} | |
| @subsubsection AVR Built-in Macros | |
| GCC defines several built-in macros so that the user code can test | |
| for the presence or absence of features. Almost any of the following | |
| built-in macros are deduced from device capabilities and thus | |
| triggered by the @option{-mmcu=} command-line option. | |
| For even more AVR-specific built-in macros see | |
| @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}. | |
| @table @code | |
| @item __AVR_ARCH__ | |
| Build-in macro that resolves to a decimal number that identifies the | |
| architecture and depends on the @option{-mmcu=@var{mcu}} option. | |
| Possible values are: | |
| @code{2}, @code{25}, @code{3}, @code{31}, @code{35}, | |
| @code{4}, @code{5}, @code{51}, @code{6} | |
| for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31}, | |
| @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6}, | |
| respectively and | |
| @code{100}, | |
| @code{102}, @code{103}, @code{104}, | |
| @code{105}, @code{106}, @code{107} | |
| for @var{mcu}=@code{avrtiny}, | |
| @code{avrxmega2}, @code{avrxmega3}, @code{avrxmega4}, | |
| @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively. | |
| If @var{mcu} specifies a device, this built-in macro is set | |
| accordingly. For example, with @option{-mmcu=atmega8} the macro is | |
| defined to @code{4}. | |
| @item __AVR_@var{Device}__ | |
| Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects | |
| the device's name. For example, @option{-mmcu=atmega8} defines the | |
| built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines | |
| @code{__AVR_ATtiny261A__}, etc. | |
| The built-in macros' names follow | |
| the scheme @code{__AVR_@var{Device}__} where @var{Device} is | |
| the device name as from the AVR user manual. The difference between | |
| @var{Device} in the built-in macro and @var{device} in | |
| @option{-mmcu=@var{device}} is that the latter is always lowercase. | |
| If @var{device} is not a device but only a core architecture like | |
| @samp{avr51}, this macro is not defined. | |
| @item __AVR_DEVICE_NAME__ | |
| Setting @option{-mmcu=@var{device}} defines this built-in macro to | |
| the device's name. For example, with @option{-mmcu=atmega8} the macro | |
| is defined to @code{atmega8}. | |
| If @var{device} is not a device but only a core architecture like | |
| @samp{avr51}, this macro is not defined. | |
| @item __AVR_CVT__ | |
| The code is being compiled with option @code{-mcvt} to use a | |
| @emph{compact vector table}. | |
| @item __AVR_XMEGA__ | |
| The device / architecture belongs to the XMEGA family of devices. | |
| @item __AVR_HAVE_ADIW__ | |
| The device has the @code{ADIW} and @code{SBIW} instructions. | |
| @item __AVR_HAVE_ELPM__ | |
| The device has the @code{ELPM} instruction. | |
| @item __AVR_HAVE_ELPMX__ | |
| The device has the @code{ELPM R@var{n},Z} and @code{ELPM | |
| R@var{n},Z+} instructions. | |
| @item __AVR_HAVE_LPMX__ | |
| The device has the @code{LPM R@var{n},Z} and | |
| @code{LPM R@var{n},Z+} instructions. | |
| @item __AVR_HAVE_MOVW__ | |
| The device has the @code{MOVW} instruction to perform 16-bit | |
| register-register moves. | |
| @item __AVR_HAVE_MUL__ | |
| The device has a hardware multiplier. | |
| @item __AVR_HAVE_JMP_CALL__ | |
| The device has the @code{JMP} and @code{CALL} instructions. | |
| This is the case for devices with more than 8@tie{}KiB of program | |
| memory. | |
| @item __AVR_HAVE_EIJMP_EICALL__ | |
| @itemx __AVR_3_BYTE_PC__ | |
| The device has the @code{EIJMP} and @code{EICALL} instructions. | |
| This is the case for devices with more than 128@tie{}KiB of program memory. | |
| This also means that the program counter | |
| (PC) is 3@tie{}bytes wide. | |
| @item __AVR_2_BYTE_PC__ | |
| The program counter (PC) is 2@tie{}bytes wide. This is the case for devices | |
| with up to 128@tie{}KiB of program memory. | |
| @item __AVR_HAVE_8BIT_SP__ | |
| @itemx __AVR_HAVE_16BIT_SP__ | |
| The stack pointer (SP) register is treated as 8-bit respectively | |
| 16-bit register by the compiler. | |
| The definition of these macros is affected by @option{-mtiny-stack}. | |
| @item __AVR_HAVE_SPH__ | |
| @itemx __AVR_SP8__ | |
| The device has the SPH (high part of stack pointer) special function | |
| register or has an 8-bit stack pointer, respectively. | |
| The definition of these macros is affected by @option{-mmcu=} and | |
| in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also | |
| by @option{-msp8}. | |
| @item __AVR_HAVE_RAMPD__ | |
| @itemx __AVR_HAVE_RAMPX__ | |
| @itemx __AVR_HAVE_RAMPY__ | |
| @itemx __AVR_HAVE_RAMPZ__ | |
| The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY}, | |
| @code{RAMPZ} special function register, respectively. | |
| @item __NO_INTERRUPTS__ | |
| This macro reflects the @option{-mno-interrupts} command-line option. | |
| @item __AVR_ERRATA_SKIP__ | |
| @itemx __AVR_ERRATA_SKIP_JMP_CALL__ | |
| Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit | |
| instructions because of a hardware erratum. Skip instructions are | |
| @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}. | |
| The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also | |
| set. | |
| @item __AVR_ISA_RMW__ | |
| The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT). | |
| @item __AVR_SFR_OFFSET__=@var{offset} | |
| Instructions that can address I/O special function registers directly | |
| like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different | |
| address as if addressed by an instruction to access RAM like @code{LD} | |
| or @code{STS}. This offset depends on the device architecture and has | |
| to be subtracted from the RAM address in order to get the | |
| respective I/O@tie{}address. | |
| @item __AVR_SHORT_CALLS__ | |
| The @option{-mshort-calls} command-line option is set. | |
| @item __AVR_PM_BASE_ADDRESS__=@var{addr} | |
| Some devices support reading from flash memory by means of @code{LD*} | |
| instructions. The flash memory is seen in the data address space | |
| at an offset of @code{__AVR_PM_BASE_ADDRESS__}. If this macro | |
| is not defined, this feature is not available. If defined, | |
| the address space is linear and there is no need to put | |
| @code{.rodata} into RAM. This is handled by the default linker | |
| description file, and is currently available for | |
| @code{avrtiny} and @code{avrxmega3}. Even more convenient, | |
| there is no need to use address spaces like @code{__flash} or | |
| features like attribute @code{progmem} and @code{pgm_read_*}. | |
| @item __AVR_HAVE_FLMAP__ | |
| This macro is defined provided the following conditions are met: | |
| @itemize @bullet | |
| @item The device has the @code{NVMCTRL_CTRLB.FLMAP} bitfield. | |
| This applies to the AVR64* and AVR128* devices. | |
| @item It's not known at assemble-time which emulation will be used. | |
| @end itemize | |
| This implies the compiler was configured with GNU Binutils that implement | |
| @w{@uref{https://sourceware.org/PR31124,,PR31124}}. | |
| @item __AVR_RODATA_IN_RAM__ | |
| This macro is undefined when the code is compiled for a core architecture. | |
| When the code is compiled for a device, the macro is defined to@tie{}1 | |
| when the @code{.rodata} sections for read-only data is located in RAM; | |
| and defined to@tie{}0, otherwise. | |
| @item __WITH_AVRLIBC__ | |
| The compiler is configured to be used together with AVR-LibC. | |
| See the @option{--with-avrlibc} configure option. | |
| @item __HAVE_SIGNAL_N__ | |
| The compiler supports the @code{signal(@var{num})} and | |
| @code{interrupt(@var{num})} | |
| @ref{AVR Attributes,,function attributes} | |
| with an argument @var{num} that specifies the number of the | |
| interrupt service routine. | |
| @item __HAVE_DOUBLE_MULTILIB__ | |
| Defined if @option{-mdouble=} acts as a multilib option. | |
| @item __HAVE_DOUBLE32__ | |
| @itemx __HAVE_DOUBLE64__ | |
| Defined if the compiler supports 32-bit double resp. 64-bit double. | |
| The actual layout is specified by option @option{-mdouble=}. | |
| @item __DEFAULT_DOUBLE__ | |
| The size in bits of @code{double} if @option{-mdouble=} is not set. | |
| To test the layout of @code{double} in a program, use the built-in | |
| macro @code{__SIZEOF_DOUBLE__}. | |
| @item __HAVE_LONG_DOUBLE32__ | |
| @itemx __HAVE_LONG_DOUBLE64__ | |
| @itemx __HAVE_LONG_DOUBLE_MULTILIB__ | |
| @itemx __DEFAULT_LONG_DOUBLE__ | |
| Same as above, but for @code{long double} instead of @code{double}. | |
| @item __WITH_DOUBLE_COMPARISON__ | |
| Reflects the @code{--with-double-comparison=@{tristate|bool|libf7@}} | |
| @w{@uref{https://gcc.gnu.org/install/configure.html#avr,,configure option}} | |
| and is defined to @code{2} or @code{3}. | |
| @item __WITH_LIBF7_LIBGCC__ | |
| @itemx __WITH_LIBF7_MATH__ | |
| @itemx __WITH_LIBF7_MATH_SYMBOLS__ | |
| Reflects the @code{--with-libf7=@{libgcc|math|math-symbols@}} | |
| @w{@uref{https://gcc.gnu.org/install/configure.html#avr,,configure option}}. | |
| @end table | |
| @subsubsection AVR Internal Options | |
| The following options are used internally by the compiler and to communicate | |
| between device specs files and the compiler proper. You don't need to set these | |
| options by hand, in particular they are not optimization options. | |
| Using these options in the wrong way may lead to sub-optimal or wrong code. | |
| They are documented for completeness, and in order to get a better | |
| understanding of | |
| @w{@uref{https://gcc.gnu.org/wiki/avr-gcc#spec-files,,device specs}} | |
| files. | |
| @table @gcctabopt | |
| @opindex mn-flash | |
| @item -mn-flash=@var{num} | |
| Assume that the flash memory has a size of @var{num} times 64@tie{}KiB. | |
| This determines which @code{__flash@var{N}} address spaces are available. | |
| @opindex mflmap | |
| @item -mflmap | |
| The device has the @code{FLMAP} bit field located in special function | |
| register @code{NVMCTRL_CTRLB}. | |
| @opindex mrmw | |
| @item -mrmw | |
| Assume that the device supports the Read-Modify-Write | |
| instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}. | |
| @opindex mshort-calls | |
| @item -mshort-calls | |
| Assume that @code{RJMP} and @code{RCALL} can target the whole | |
| program memory. This option is used for multilib generation and selection | |
| for the devices from architecture @code{avrxmega3}. | |
| @opindex mskip-bug | |
| @item -mskip-bug | |
| Generate code without skips (@code{CPSE}, @code{SBRS}, | |
| @code{SBRC}, @code{SBIS}, @code{SBIC}) over 32-bit instructions. | |
| @opindex msp8 | |
| @item -msp8 | |
| Treat the stack pointer register as an 8-bit register, | |
| i.e.@: assume the high byte of the stack pointer is zero. | |
| This option is used by the compiler to select and | |
| build multilibs for architectures @code{avr2} and @code{avr25}. | |
| These architectures mix devices with and without @code{SPH}. | |
| @end table | |
| @node Blackfin Options | |
| @subsection Blackfin Options | |
| @cindex Blackfin Options | |
| @table @gcctabopt | |
| @opindex mcpu= | |
| @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} | |
| Specifies the name of the target Blackfin processor. Currently, @var{cpu} | |
| can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518}, | |
| @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526}, | |
| @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533}, | |
| @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539}, | |
| @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549}, | |
| @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m}, | |
| @samp{bf561}, @samp{bf592}. | |
| The optional @var{sirevision} specifies the silicon revision of the target | |
| Blackfin processor. Any workarounds available for the targeted silicon revision | |
| are enabled. If @var{sirevision} is @samp{none}, no workarounds are enabled. | |
| If @var{sirevision} is @samp{any}, all workarounds for the targeted processor | |
| are enabled. The @code{__SILICON_REVISION__} macro is defined to two | |
| hexadecimal digits representing the major and minor numbers in the silicon | |
| revision. If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__} | |
| is not defined. If @var{sirevision} is @samp{any}, the | |
| @code{__SILICON_REVISION__} is defined to be @code{0xffff}. | |
| If this optional @var{sirevision} is not used, GCC assumes the latest known | |
| silicon revision of the targeted Blackfin processor. | |
| GCC defines a preprocessor macro for the specified @var{cpu}. | |
| For the @samp{bfin-elf} toolchain, this option causes the hardware BSP | |
| provided by libgloss to be linked in if @option{-msim} is not given. | |
| Without this option, @samp{bf532} is used as the processor by default. | |
| Note that support for @samp{bf561} is incomplete. For @samp{bf561}, | |
| only the preprocessor macro is defined. | |
| @opindex msim | |
| @item -msim | |
| Specifies that the program will be run on the simulator. This causes | |
| the simulator BSP provided by libgloss to be linked in. This option | |
| has effect only for @samp{bfin-elf} toolchain. | |
| Certain other options, such as @option{-mid-shared-library} and | |
| @option{-mfdpic}, imply @option{-msim}. | |
| @opindex momit-leaf-frame-pointer | |
| @opindex mno-omit-leaf-frame-pointer | |
| @item -momit-leaf-frame-pointer | |
| Don't keep the frame pointer in a register for leaf functions. This | |
| avoids the instructions to save, set up and restore frame pointers and | |
| makes an extra register available in leaf functions. | |
| @opindex mspecld-anomaly | |
| @opindex mno-specld-anomaly | |
| @item -mspecld-anomaly | |
| @itemx -mno-specld-anomaly | |
| When enabled, the compiler ensures that the generated code does not | |
| contain speculative loads after jump instructions. If this option is used, | |
| @code{__WORKAROUND_SPECULATIVE_LOADS} is defined. | |
| @opindex mcsync-anomaly | |
| @opindex mno-csync-anomaly | |
| @item -mcsync-anomaly | |
| @itemx -mno-csync-anomaly | |
| When enabled, the compiler ensures that the generated code does not | |
| contain CSYNC or SSYNC instructions too soon after conditional branches. | |
| If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined. | |
| @opindex mlow64k | |
| @opindex mno-low64k | |
| @item -mlow64k | |
| @itemx -mno-low64k | |
| When enabled, the compiler is free to take advantage of the knowledge that | |
| the entire program fits into the low 64k of memory. The default behavior | |
| is to assume that the program is arbitrarily large (@option{-mno-low64k}). | |
| @opindex mstack-check-l1 | |
| @opindex mno-stack-check-l1 | |
| @item -mstack-check-l1 | |
| Do stack checking using information placed into L1 scratchpad memory by the | |
| uClinux kernel. | |
| @opindex mid-shared-library | |
| @opindex mno-id-shared-library | |
| @item -mid-shared-library | |
| @itemx -mno-id-shared-library | |
| Generate code that supports shared libraries via the library ID method. | |
| This allows for execute in place and shared libraries in an environment | |
| without virtual memory management. This option implies @option{-fPIC}. | |
| With a @samp{bfin-elf} target, this option implies @option{-msim}. | |
| The default is @option{-mno-id-shared-library}, to generate | |
| code that doesn't assume ID-based shared libraries are being used. | |
| @opindex mleaf-id-shared-library | |
| @opindex mno-leaf-id-shared-library | |
| @item -mleaf-id-shared-library | |
| @itemx -mno-leaf-id-shared-library | |
| Generate code that supports shared libraries via the library ID method, | |
| but assumes that this library or executable won't link against any other | |
| ID shared libraries. That allows the compiler to use faster code for jumps | |
| and calls. | |
| The default is @option{-mno-leaf-id-shared-library}, in which the | |
| no assumption is made that the code being compiled won't link | |
| against any ID shared libraries. Slower code is generated for jump | |
| and call insns. | |
| @opindex mshared-library-id | |
| @item -mshared-library-id=n | |
| Specifies the identification number of the ID-based shared library being | |
| compiled. Specifying a value of 0 generates more compact code; specifying | |
| other values forces the allocation of that number to the current | |
| library but is no more space- or time-efficient than omitting this option. | |
| @opindex msep-data | |
| @opindex mno-sep-data | |
| @item -msep-data | |
| @itemx -mno-sep-data | |
| Generate code that allows the data segment to be located in a different | |
| area of memory from the text segment. This allows for execute in place in | |
| an environment without virtual memory management by eliminating relocations | |
| against the text section. The default is @option{-mno-sep-data}, which | |
| tells GCC to generate code that assumes that the data segment follows | |
| the text segment. | |
| @opindex mlong-calls | |
| @opindex mno-long-calls | |
| @item -mlong-calls | |
| @itemx -mno-long-calls | |
| Tells the compiler to perform function calls by first loading the | |
| address of the function into a register and then performing a subroutine | |
| call on this register. This switch is needed if the target function | |
| lies outside of the 24-bit addressing range of the offset-based | |
| version of subroutine call instruction. | |
| This feature is not enabled by default. Specifying | |
| @option{-mno-long-calls} restores the default behavior. Note these | |
| switches have no effect on how the compiler generates code to handle | |
| function calls via function pointers. | |
| @opindex mfast-fp | |
| @opindex mno-fast-fp | |
| @item -mfast-fp | |
| Link with the fast floating-point library. This library relaxes some of | |
| the IEEE floating-point standard's rules for checking inputs against | |
| Not-a-Number (NAN), in the interest of performance. | |
| @opindex minline-plt | |
| @opindex mno-inline-plt | |
| @item -minline-plt | |
| Enable inlining of PLT entries in function calls to functions that are | |
| not known to bind locally. It has no effect without @option{-mfdpic}. | |
| @opindex mmulticore | |
| @opindex mno-multicore | |
| @item -mmulticore | |
| Build a standalone application for multicore Blackfin processors. | |
| This option causes proper start files and link scripts supporting | |
| multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. | |
| It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. | |
| This option can be used with @option{-mcorea} or @option{-mcoreb}, which | |
| selects the one-application-per-core programming model. Without | |
| @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core | |
| programming model is used. In this model, the main function of Core B | |
| should be named as @code{coreb_main}. | |
| If this option is not used, the single-core application programming | |
| model is used. | |
| @opindex mcorea | |
| @opindex mno-corea | |
| @item -mcorea | |
| Build a standalone application for Core A of BF561 when using | |
| the one-application-per-core programming model. Proper start files | |
| and link scripts are used to support Core A, and the macro | |
| @code{__BFIN_COREA} is defined. | |
| This option can only be used in conjunction with @option{-mmulticore}. | |
| @opindex mcoreb | |
| @opindex mno-coreb | |
| @item -mcoreb | |
| Build a standalone application for Core B of BF561 when using | |
| the one-application-per-core programming model. Proper start files | |
| and link scripts are used to support Core B, and the macro | |
| @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main} | |
| should be used instead of @code{main}. | |
| This option can only be used in conjunction with @option{-mmulticore}. | |
| @opindex msdram | |
| @opindex mno-sdram | |
| @item -msdram | |
| Build a standalone application for SDRAM. Proper start files and | |
| link scripts are used to put the application into SDRAM, and the macro | |
| @code{__BFIN_SDRAM} is defined. | |
| The loader should initialize SDRAM before loading the application. | |
| @opindex micplb | |
| @opindex mno-icplb | |
| @item -micplb | |
| Assume that ICPLBs are enabled at run time. This has an effect on certain | |
| anomaly workarounds. For Linux targets, the default is to assume ICPLBs | |
| are enabled; for standalone applications the default is off. | |
| @end table | |
| @node C6X Options | |
| @subsection C6X Options | |
| @cindex C6X Options | |
| @table @gcctabopt | |
| @opindex march | |
| @item -march=@var{name} | |
| This specifies the name of the target architecture. GCC uses this | |
| name to determine what kind of instructions it can emit when generating | |
| assembly code. Permissible names are: @samp{c62x}, | |
| @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}. | |
| @opindex mbig-endian | |
| @item -mbig-endian | |
| Generate code for a big-endian target. | |
| @opindex mlittle-endian | |
| @item -mlittle-endian | |
| Generate code for a little-endian target. This is the default. | |
| @opindex msim | |
| @item -msim | |
| Choose startup files and linker script suitable for the simulator. | |
| @opindex msdata=default | |
| @item -msdata=default | |
| Put small global and static data in the @code{.neardata} section, | |
| which is pointed to by register @code{B14}. Put small uninitialized | |
| global and static data in the @code{.bss} section, which is adjacent | |
| to the @code{.neardata} section. Put small read-only data into the | |
| @code{.rodata} section. The corresponding sections used for large | |
| pieces of data are @code{.fardata}, @code{.far} and @code{.const}. | |
| @opindex msdata=all | |
| @item -msdata=all | |
| Put all data, not just small objects, into the sections reserved for | |
| small data, and use addressing relative to the @code{B14} register to | |
| access them. | |
| @opindex msdata=none | |
| @item -msdata=none | |
| Make no use of the sections reserved for small data, and use absolute | |
| addresses to access all data. Put all initialized global and static | |
| data in the @code{.fardata} section, and all uninitialized data in the | |
| @code{.far} section. Put all constant data into the @code{.const} | |
| section. | |
| @opindex mdsbt | |
| @opindex mno-dsbt | |
| @item -mdsbt | |
| Compile for the DSBT shared library ABI. This option is required to | |
| compile with @option{-fpic} or @option{-fPIC}, and implies @option{-fpic}. | |
| @opindex mlong-calls | |
| @opindex mno-long-calls | |
| @item -mlong-calls | |
| Avoid generating PC-relative calls; use indirection instead. | |
| @end table | |
| @node CRIS Options | |
| @subsection CRIS Options | |
| @cindex CRIS Options | |
| These options are defined specifically for the CRIS ports. | |
| @table @gcctabopt | |
| @opindex march | |
| @opindex mcpu | |
| @item -march=@var{architecture-type} | |
| @itemx -mcpu=@var{architecture-type} | |
| Generate code for the specified architecture. The choices for | |
| @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for | |
| respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@. | |
| Default is @samp{v0}. | |
| @opindex mtune | |
| @item -mtune=@var{architecture-type} | |
| Tune to @var{architecture-type} everything applicable about the generated | |
| code, except for the ABI and the set of available instructions. The | |
| choices for @var{architecture-type} are the same as for | |
| @option{-march=@var{architecture-type}}. | |
| @opindex mmax-stackframe | |
| @item -mmax-stackframe=@var{n} | |
| Warn when the stack frame of a function exceeds @var{n} bytes. | |
| @opindex metrax4 | |
| @opindex metrax100 | |
| @opindex mno-etrax4 | |
| @opindex mno-etrax100 | |
| @item -metrax4 | |
| @itemx -metrax100 | |
| The options @option{-metrax4} and @option{-metrax100} are synonyms for | |
| @option{-march=v3} and @option{-march=v8} respectively. | |
| @opindex mmul-bug-workaround | |
| @opindex mno-mul-bug-workaround | |
| @item -mmul-bug-workaround | |
| @itemx -mno-mul-bug-workaround | |
| Work around a bug in the @code{muls} and @code{mulu} instructions for CPU | |
| models where it applies. This option is disabled by default. | |
| @opindex mpdebug | |
| @opindex mno-pddebug | |
| @item -mpdebug | |
| Enable CRIS-specific verbose debug-related information in the assembly | |
| code. This option also has the effect of turning off the @samp{#NO_APP} | |
| formatted-code indicator to the assembler at the beginning of the | |
| assembly file. | |
| @opindex mcc-init | |
| @opindex mno-cc-init | |
| @item -mcc-init | |
| Do not use condition-code results from previous instruction; always emit | |
| compare and test instructions before use of condition codes. | |
| @opindex mno-side-effects | |
| @opindex mside-effects | |
| @item -mno-side-effects | |
| Do not emit instructions with side effects in addressing modes other than | |
| post-increment. | |
| @opindex mstack-align | |
| @opindex mno-stack-align | |
| @opindex mdata-align | |
| @opindex mno-data-align | |
| @opindex mconst-align | |
| @opindex mno-const-align | |
| @item -mstack-align | |
| @itemx -mno-stack-align | |
| @itemx -mdata-align | |
| @itemx -mno-data-align | |
| @itemx -mconst-align | |
| @itemx -mno-const-align | |
| These options (@samp{no-} options) arrange (eliminate arrangements) for the | |
| stack frame, individual data and constants to be aligned for the maximum | |
| single data access size for the chosen CPU model. The default is to | |
| arrange for 32-bit alignment. ABI details such as structure layout are | |
| not affected by these options. | |
| @opindex m32-bit | |
| @opindex m16-bit | |
| @opindex m8-bit | |
| @item -m32-bit | |
| @itemx -m16-bit | |
| @itemx -m8-bit | |
| Similar to the stack- data- and const-align options above, these options | |
| arrange for stack frame, writable data and constants to all be 32-bit, | |
| 16-bit or 8-bit aligned. The default is 32-bit alignment. | |
| @opindex mno-prologue-epilogue | |
| @opindex mprologue-epilogue | |
| @item -mno-prologue-epilogue | |
| @itemx -mprologue-epilogue | |
| With @option{-mno-prologue-epilogue}, the normal function prologue and | |
| epilogue which set up the stack frame are omitted and no return | |
| instructions or return sequences are generated in the code. Use this | |
| option only together with visual inspection of the compiled code: no | |
| warnings or errors are generated when call-saved registers must be saved, | |
| or storage for local variables needs to be allocated. | |
| @opindex mbest-lib-options | |
| @opindex moverride-best-lib-options | |
| @item -mbest-lib-options | |
| @itemx -moverride-best-lib-options | |
| @option{-mbest-lib-options} selects the most feature-enabling options | |
| allowed by other options. This option has no @samp{no-} form, but | |
| @option{-moverride-best-lib-options} disables it regardless of the relative | |
| order of the two options on the command line. | |
| @opindex mtrap-using-break8 | |
| @opindex mno-trap-using-break8 | |
| @item -mtrap-using-break8 | |
| Emit traps as @samp{break 8}. This is the default for CRIS v3 and up. If | |
| disabled, calls to @code{abort} are used instead. | |
| @opindex mtrap-unaligned-atomic | |
| @opindex mno-trap-unaligned-atomic | |
| @item -mtrap-unaligned-atomic | |
| Emit checks causing @samp{break 8} instructions to execute when | |
| applying atomic builtins on misaligned memory. | |
| @opindex munaligned-atomic-may-use-library | |
| @opindex mno-unaligned-atomic-may-use-library | |
| @item -munaligned-atomic-may-use-library | |
| Handle atomic builtins that may be applied to unaligned data by calling | |
| library functions. This option overrides @option{-mtrap-unaligned-atomic}. | |
| @opindex sim | |
| @item -sim | |
| This option arranges | |
| to link with input-output functions from a simulator library. Code, | |
| initialized data and zero-initialized data are allocated consecutively. | |
| @opindex sim2 | |
| @item -sim2 | |
| Like @option{-sim}, but pass linker options to locate initialized data at | |
| 0x40000000 and zero-initialized data at 0x80000000. | |
| @end table | |
| @node C-SKY Options | |
| @subsection C-SKY Options | |
| @cindex C-SKY Options | |
| GCC supports these options when compiling for C-SKY V2 processors. | |
| @table @gcctabopt | |
| @opindex march= | |
| @item -march=@var{arch} | |
| Specify the C-SKY target architecture. Valid values for @var{arch} are: | |
| @samp{ck801}, @samp{ck802}, @samp{ck803}, @samp{ck807}, and @samp{ck810}. | |
| The default is @samp{ck810}. | |
| @opindex mcpu= | |
| @item -mcpu=@var{cpu} | |
| Specify the C-SKY target processor. Valid values for @var{cpu} are: | |
| @samp{ck801}, @samp{ck801t}, | |
| @samp{ck802}, @samp{ck802t}, @samp{ck802j}, | |
| @samp{ck803}, @samp{ck803h}, @samp{ck803t}, @samp{ck803ht}, | |
| @samp{ck803f}, @samp{ck803fh}, @samp{ck803e}, @samp{ck803eh}, | |
| @samp{ck803et}, @samp{ck803eht}, @samp{ck803ef}, @samp{ck803efh}, | |
| @samp{ck803ft}, @samp{ck803eft}, @samp{ck803efht}, @samp{ck803r1}, | |
| @samp{ck803hr1}, @samp{ck803tr1}, @samp{ck803htr1}, @samp{ck803fr1}, | |
| @samp{ck803fhr1}, @samp{ck803er1}, @samp{ck803ehr1}, @samp{ck803etr1}, | |
| @samp{ck803ehtr1}, @samp{ck803efr1}, @samp{ck803efhr1}, @samp{ck803ftr1}, | |
| @samp{ck803eftr1}, @samp{ck803efhtr1}, | |
| @samp{ck803s}, @samp{ck803st}, @samp{ck803se}, @samp{ck803sf}, | |
| @samp{ck803sef}, @samp{ck803seft}, | |
| @samp{ck807e}, @samp{ck807ef}, @samp{ck807}, @samp{ck807f}, | |
| @samp{ck810e}, @samp{ck810et}, @samp{ck810ef}, @samp{ck810eft}, | |
| @samp{ck810}, @samp{ck810v}, @samp{ck810f}, @samp{ck810t}, @samp{ck810fv}, | |
| @samp{ck810tv}, @samp{ck810ft}, and @samp{ck810ftv}. | |
| @opindex mbig-endian | |
| @opindex mlittle-endian | |
| @item -mbig-endian | |
| @itemx -mlittle-endian | |
| Select big- or little-endian code. The default is little-endian. | |
| @opindex mfloat-abi | |
| @item -mfloat-abi=@var{name} | |
| Specifies which floating-point ABI to use. Permissible values | |
| are: @samp{soft}, @samp{softfp} and @samp{hard}. | |
| Specifying @samp{soft} causes GCC to generate output containing | |
| library calls for floating-point operations. | |
| @samp{softfp} allows the generation of code using hardware floating-point | |
| instructions, but still uses the soft-float calling conventions. | |
| @samp{hard} allows generation of floating-point instructions | |
| and uses FPU-specific calling conventions. | |
| The default depends on the specific target configuration. Note that | |
| the hard-float and soft-float ABIs are not link-compatible; you must | |
| compile your entire program with the same ABI, and link with a | |
| compatible set of libraries. | |
| @opindex mdouble-float | |
| @opindex mno-double-float | |
| @item -mdouble-float | |
| @itemx -mno-double-float | |
| When @option{-mhard-float} is in effect, enable generation of | |
| double-precision float instructions. This is the default except | |
| when compiling for CK803. | |
| @opindex mfdivdu | |
| @opindex mno-fdivdu | |
| @item -mfdivdu | |
| @itemx -mno-fdivdu | |
| When @option{-mhard-float} is in effect, enable generation of | |
| @code{frecipd}, @code{fsqrtd}, and @code{fdivd} instructions. | |
| This is the default except when compiling for CK803. | |
| @opindex mfpu= | |
| @item -mfpu=@var{fpu} | |
| Select the floating-point processor. This option can only be used with | |
| @option{-mhard-float}. | |
| Values for @var{fpu} are | |
| @samp{fpv2_sf} (equivalent to @samp{-mno-double-float -mno-fdivdu}), | |
| @samp{fpv2} (@samp{-mdouble-float -mno-divdu}), and | |
| @samp{fpv2_divd} (@samp{-mdouble-float -mdivdu}). | |
| @opindex melrw | |
| @opindex mno-elrw | |
| @item -melrw | |
| @itemx -mno-elrw | |
| Enable the extended @code{lrw} instruction. This option defaults to on | |
| for CK801 and off otherwise. | |
| @opindex mistack | |
| @opindex mno-istack | |
| @item -mistack | |
| @itemx -mno-istack | |
| Enable interrupt stack instructions; the default is off. | |
| The @option{-mistack} option is required to handle the | |
| @code{interrupt} and @code{isr} function attributes | |
| (@pxref{C-SKY Attributes}). | |
| @opindex mmp | |
| @opindex mno-mp | |
| @item -mmp | |
| @itemx -mno-mp | |
| Enable multiprocessor instructions; the default is off. | |
| @opindex mcp | |
| @opindex mno-cp | |
| @item -mcp | |
| @itemx -mno-cp | |
| Enable coprocessor instructions; the default is off. | |
| @opindex mcache | |
| @opindex mno-cache | |
| @item -mcache | |
| @itemx -mno-cache | |
| Enable coprocessor instructions; the default is off. | |
| @opindex msecurity | |
| @opindex mno-security | |
| @item -msecurity | |
| @itemx -mno-security | |
| Enable C-SKY security instructions; the default is off. | |
| @opindex mtrust | |
| @opindex mno-trust | |
| @item -mtrust | |
| @itemx -mno-trust | |
| Enable C-SKY trust instructions; the default is off. | |
| @opindex mdsp | |
| @opindex mno-dsp | |
| @opindex medsp | |
| @opindex mno-edsp | |
| @opindex mvdsp | |
| @opindex mno-vdsp | |
| @item -mdsp | |
| @itemx -mno-dsp | |
| @itemx -medsp | |
| @itemx -mno-edsp | |
| @itemx -mvdsp | |
| @itemx -mno-vdsp | |
| Enable C-SKY DSP, Enhanced DSP, or Vector DSP instructions, respectively. | |
| All of these options default to off. | |
| @opindex mdiv | |
| @opindex mno-div | |
| @item -mdiv | |
| @itemx -mno-div | |
| Generate divide instructions. Default is off. | |
| @opindex msmart | |
| @opindex mno-smart | |
| @item -msmart | |
| @itemx -mno-smart | |
| Generate code for Smart Mode, using only registers numbered 0-7 to allow | |
| use of 16-bit instructions. This option is ignored for CK801 where this | |
| is the required behavior, and it defaults to on for CK802. | |
| For other targets, the default is off. | |
| @opindex mhigh-registers | |
| @opindex mno-high-registers | |
| @item -mhigh-registers | |
| @itemx -mno-high-registers | |
| Generate code using the high registers numbered 16-31. This option | |
| is not supported on CK801, CK802, or CK803, and is enabled by default | |
| for other processors. | |
| @opindex manchor | |
| @opindex mno-anchor | |
| @item -manchor | |
| @itemx -mno-anchor | |
| Generate code using global anchor symbol addresses. | |
| @opindex mpushpop | |
| @opindex mno-pushpop | |
| @item -mpushpop | |
| @itemx -mno-pushpop | |
| Generate code using @code{push} and @code{pop} instructions. This option | |
| defaults to on. | |
| @opindex mmultiple-stld | |
| @opindex mno-multiple-stld | |
| @item -mmultiple-stld | |
| @itemx -mno-multiple-stld | |
| Generate code using @code{stm} and @code{ldm} instructions. This option | |
| isn't supported on CK801 but is enabled by default on other processors. | |
| @opindex mconstpool | |
| @opindex mno-constpool | |
| @item -mconstpool | |
| @itemx -mno-constpool | |
| Create constant pools in the compiler instead of deferring it to the | |
| assembler. This option is the default and required for correct code | |
| generation on CK801 and CK802, and is optional on other processors. | |
| @opindex mstack-size | |
| @opindex mno-stack-size | |
| @item -mstack-size | |
| @itemx -mno-stack-size | |
| Emit @code{.stack_size} directives for each function in the assembly | |
| output. This option defaults to off. | |
| @opindex mccrt | |
| @opindex mno-ccrt | |
| @item -mccrt | |
| @itemx -mno-ccrt | |
| Generate code for the C-SKY compiler runtime instead of libgcc. This | |
| option defaults to off. | |
| @opindex mbranch-cost= | |
| @item -mbranch-cost=@var{n} | |
| Set the branch costs to roughly @code{n} instructions. The default is 1. | |
| @opindex msched-prolog | |
| @item -msched-prolog | |
| @itemx -mno-sched-prolog | |
| Permit scheduling of function prologue and epilogue sequences. Using | |
| this option can result in code that is not compliant with the C-SKY V2 ABI | |
| prologue requirements and that cannot be debugged or backtraced. | |
| It is disabled by default. | |
| @opindex msim | |
| @opindex mno-sim | |
| @item -msim | |
| @itemx -mno-sim | |
| Links the library libsemi.a which is in compatible with simulator. Applicable | |
| to ELF compiler only. | |
| @end table | |
| @node Cygwin and MinGW Options | |
| @subsection Cygwin and MinGW Options | |
| @cindex Cygwin and MinGW Options | |
| @cindex Options for Cygwin and MinGW | |
| These additional options are available for Microsoft Windows targets: | |
| @table @gcctabopt | |
| @opindex mconsole | |
| @item -mconsole | |
| This option | |
| specifies that a console application is to be generated, by | |
| instructing the linker to set the PE header subsystem type | |
| required for console applications. | |
| This option is available for Cygwin and MinGW targets and is | |
| enabled by default on those targets. | |
| @opindex mcrtdll | |
| @item -mcrtdll=@var{library} | |
| Preprocess, compile or link with specified C RunTime DLL @var{library}. | |
| This option adjust predefined macros @code{__CRTDLL__}, @code{__MSVCRT__}, | |
| @code{_UCRT} and @code{__MSVCRT_VERSION__} for specified CRT @var{library}, | |
| choose start file for CRT @var{library} and link with CRT @var{library}. | |
| Recognized CRT library names for proprocessor are: | |
| @code{crtdll*}, @code{msvcrt10*}, @code{msvcrt20*}, @code{msvcrt40*}, | |
| @code{msvcr40*}, @code{msvcrtd*}, @code{msvcrt-os*}, | |
| @code{msvcr70*}, @code{msvcr71*}, @code{msvcr80*}, @code{msvcr90*}, | |
| @code{msvcr100*}, @code{msvcr110*}, @code{msvcr120*} and @code{ucrt*}. | |
| If this options is not specified then the default MinGW import library | |
| @code{msvcrt} is used for linking and no other adjustment for | |
| preprocessor is done. MinGW import library @code{msvcrt} is just a | |
| symlink to (or a copy of) another MinGW CRT import library | |
| chosen during MinGW compilation. MinGW import library @code{msvcrt-os} | |
| is for Windows system CRT DLL library @code{msvcrt.dll} and | |
| in most cases is the default MinGW import library. | |
| Generally speaking, changing the CRT DLL requires recompiling | |
| the entire MinGW CRT. This option is for experimental and testing | |
| purposes only. | |
| This option is available for MinGW targets. | |
| @opindex mdll | |
| @item -mdll | |
| This option is available for Cygwin and MinGW targets. It | |
| specifies that a DLL---a dynamic link library---is to be | |
| generated, enabling the selection of the required runtime | |
| startup object and entry point. | |
| @opindex mnop-fun-dllimport | |
| @opindex mno-nop-fun-dllimport | |
| @item -mnop-fun-dllimport | |
| This option is available for Cygwin and MinGW targets. It | |
| specifies that the @code{dllimport} attribute should be ignored. | |
| @opindex mthreads | |
| @item -mthreads | |
| Support thread-safe exception handling on MinGW. Programs that rely | |
| on thread-safe exception handling must compile and link all code with the | |
| @option{-mthreads} option. When compiling, @option{-mthreads} defines | |
| @option{-D_MT}; when linking, it links in a special thread helper library | |
| @option{-lmingwthrd} which cleans up per-thread exception-handling data. | |
| @opindex municode | |
| @opindex mno-unicode | |
| @item -municode | |
| This option is available for MinGW-w64 targets. It causes | |
| the @code{UNICODE} preprocessor macro to be predefined, and | |
| chooses Unicode-capable runtime startup code. | |
| @opindex mwin32 | |
| @opindex mno-win32 | |
| @item -mwin32 | |
| This option is available for Cygwin and MinGW targets. It | |
| specifies that the typical Microsoft Windows predefined macros are to | |
| be set in the pre-processor, but does not influence the choice | |
| of runtime library/startup code. | |
| @opindex mwindows | |
| @opindex mno-windows | |
| @item -mwindows | |
| This option is available for Cygwin and MinGW targets. It | |
| specifies that a GUI application is to be generated by | |
| instructing the linker to set the PE header subsystem type | |
| appropriately. | |
| @opindex fno-set-stack-executable | |
| @opindex fset-stack-executable | |
| @item -fno-set-stack-executable | |
| This option is available for MinGW targets. It specifies that | |
| the executable flag for the stack used by nested functions isn't | |
| set. This is necessary for binaries running in kernel mode of | |
| Microsoft Windows, as there the User32 API, which is used to set executable | |
| privileges, isn't available. | |
| @opindex fno-writable-relocated-rdata | |
| @opindex fwritable-relocated-rdata | |
| @item -fwritable-relocated-rdata | |
| This option is available for MinGW and Cygwin targets. It specifies | |
| that relocated-data in read-only section is put into the @code{.data} | |
| section. This is a necessary for older runtimes not supporting | |
| modification of @code{.rdata} sections for pseudo-relocation. | |
| @opindex mpe-aligned-commons | |
| @item -mpe-aligned-commons | |
| This option is available for Cygwin and MinGW targets. It | |
| specifies that the GNU extension to the PE file format that | |
| permits the correct alignment of COMMON variables should be | |
| used when generating code. It is enabled by default if | |
| GCC detects that the target assembler found during configuration | |
| supports the feature. | |
| @opindex muse-libstdc-wrappers | |
| @item -muse-libstdc-wrappers | |
| Use Cygwin DLL wrappers to support C++ operators @code{new} and @code{delete}. | |
| @end table | |
| See also under @ref{x86 Options} for standard options. | |
| @node Darwin Options | |
| @subsection Darwin Options | |
| @cindex Darwin options | |
| These options are defined for all architectures running the Darwin operating | |
| system. | |
| FSF GCC on Darwin does not create ``fat'' object files; it creates | |
| an object file for the single architecture that GCC was built to | |
| target. Apple's GCC on Darwin does create ``fat'' files if multiple | |
| @option{-arch} options are used; it does so by running the compiler or | |
| linker multiple times and joining the results together with | |
| @file{lipo}. | |
| The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or | |
| @samp{i686}) is determined by the flags that specify the ISA | |
| that GCC is targeting, like @option{-mcpu} or @option{-march}. The | |
| @option{-force_cpusubtype_ALL} option can be used to override this. | |
| The Darwin tools vary in their behavior when presented with an ISA | |
| mismatch. The assembler, @file{as}, only permits instructions to | |
| be used that are valid for the subtype of the file it is generating, | |
| so you cannot put 64-bit instructions in a @samp{ppc750} object file. | |
| The linker for shared libraries, @file{/usr/bin/libtool}, fails | |
| and prints an error if asked to create a shared library with a less | |
| restrictive subtype than its input files (for instance, trying to put | |
| a @samp{ppc970} object file in a @samp{ppc7400} library). The linker | |
| for executables, @command{ld}, quietly gives the executable the most | |
| restrictive subtype of any of its input files. | |
| @table @gcctabopt | |
| @opindex F | |
| @item -F@var{dir} | |
| Add the framework directory @var{dir} to the head of the list of | |
| directories to be searched for header files. These directories are | |
| interleaved with those specified by @option{-I} options and are | |
| scanned in a left-to-right order. | |
| A framework directory is a directory with frameworks in it. A | |
| framework is a directory with a @file{Headers} and/or | |
| @file{PrivateHeaders} directory contained directly in it that ends | |
| in @file{.framework}. The name of a framework is the name of this | |
| directory excluding the @file{.framework}. Headers associated with | |
| the framework are found in one of those two directories, with | |
| @file{Headers} being searched first. A subframework is a framework | |
| directory that is in a framework's @file{Frameworks} directory. | |
| Includes of subframework headers can only appear in a header of a | |
| framework that contains the subframework, or in a sibling subframework | |
| header. Two subframeworks are siblings if they occur in the same | |
| framework. A subframework should not have the same name as a | |
| framework; a warning is issued if this is violated. Currently a | |
| subframework cannot have subframeworks; in the future, the mechanism | |
| may be extended to support this. The standard frameworks can be found | |
| in @file{/System/Library/Frameworks} and | |
| @file{/Library/Frameworks}. An example include looks like | |
| @code{#include <Framework/header.h>}, where @file{Framework} denotes | |
| the name of the framework and @file{header.h} is found in the | |
| @file{PrivateHeaders} or @file{Headers} directory. | |
| @opindex iframework | |
| @item -iframework@var{dir} | |
| Like @option{-F} except the directory is a treated as a system | |
| directory. The main difference between this @option{-iframework} and | |
| @option{-F} is that with @option{-iframework} the compiler does not | |
| warn about constructs contained within header files found via | |
| @var{dir}. This option is valid only for the C family of languages. | |
| @opindex arch | |
| @item -arch @var{name} | |
| Generate output for architecture @var{name}. As described above, GCC | |
| generates output for the architecture it was configured for, using its | |
| usual options to select subarchitecture variants. The @option{-arch} | |
| option is accepted for compatibility, but an error is diagnosed if | |
| @var{name} is inconsistent with GCC's own idea of the target architecture. | |
| @opindex dependency-file | |
| @item -dependency-file @var{filename} | |
| Alias for the preprocessor option @option{-MF @var{filename}}. | |
| @xref{Preprocessor Options}. | |
| @opindex fapple-kext | |
| @opindex fno-apple-kext | |
| @item -fapple-kext | |
| Generate code for Darwin loadable kernel extensions. | |
| @opindex gused | |
| @item -gused | |
| Emit debugging information for symbols that are used. For stabs | |
| debugging format, this enables @option{-feliminate-unused-debug-symbols}. | |
| This is by default ON@. | |
| @opindex gfull | |
| @item -gfull | |
| Emit debugging information for all symbols and types. | |
| @opindex matt-stubs | |
| @opindex mno-att-stubs | |
| @item -matt-stubs | |
| @itemx -mno-att-stubs | |
| Enable AT&T-style PIC stubs. This is the default when supported by | |
| the target architecture (currently x86 only). | |
| @opindex mconstant-cfstrings | |
| @opindex mno-constant-cfstrings | |
| @opindex fconstant-cfstrings | |
| @opindex fno-constant-cfstrings | |
| @item -mconstant-cfstrings | |
| @itemx -fconstant-cfstrings | |
| When the NeXT runtime is being used (the default on these systems), override | |
| any @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} | |
| literals to be laid out as constant CoreFoundation strings. | |
| @option{-fconstant-cfstrings} is an alias for @option{-mconstant-cfstrings}. | |
| @opindex mdynamic-no-pic | |
| @opindex mno-dynamic-no-pic | |
| @item -mdynamic-no-pic | |
| Generate code suitable for executables (not shared libraries). This | |
| option is incompatible with @option{-fpic}, @option{-fPIC}, @option{-fpie}, | |
| or @option{-fPIE}. | |
| @opindex mfix-and-continue | |
| @opindex mno-fix-and-continue | |
| @opindex ffix-and-continue | |
| @opindex findirect-data | |
| @item -mfix-and-continue | |
| @itemx -ffix-and-continue | |
| @itemx -findirect-data | |
| Generate code suitable for fast turnaround development, such as to | |
| allow GDB to dynamically load @file{.o} files into already-running | |
| programs. @option{-findirect-data} and @option{-ffix-and-continue} | |
| are provided for backwards compatibility. | |
| @opindex mkernel | |
| @opindex mno-kernel | |
| @item -mkernel | |
| Enable kernel development mode. The @option{-mkernel} option sets | |
| @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit}, | |
| @option{-fno-exceptions}, @option{-fno-non-call-exceptions}, | |
| @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where | |
| applicable. This mode also sets @option{-mno-altivec}, | |
| @option{-msoft-float}, @option{-fno-builtin} and | |
| @option{-mlong-branch} for PowerPC targets. | |
| @opindex mmacosx-version-min | |
| @opindex asm_macosx_version_min | |
| @item -mmacosx-version-min=@var{version} | |
| @itemx -asm_macosx_version_min=@var{version} | |
| The @option{-mmacosx-version-min} option specifies | |
| the earliest version of MacOS X that this executable will run on is | |
| @var{version}. Typical values supported for @var{version} include @code{12}, | |
| @code{10.12}, and @code{10.5.8}. | |
| If the compiler was built to use the system's headers by default, | |
| then the default for this option is the system version on which the | |
| compiler is running, otherwise the default is to make choices that | |
| are compatible with as many systems and code bases as possible. | |
| @option{-asm_macosx_version_min=@var{version}} is similar, but the GCC | |
| driver passes its @var{version} information only to the assembler. | |
| @opindex mone-byte-bool | |
| @item -mone-byte-bool | |
| Override the defaults for @code{bool} so that @code{sizeof(bool)==1}. | |
| By default @code{sizeof(bool)} is @code{4} when compiling for | |
| Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this | |
| option has no effect on x86. | |
| @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC | |
| to generate code that is not binary compatible with code generated | |
| without that switch. Using this switch may require recompiling all | |
| other modules in a program, including system libraries. Use this | |
| switch to conform to a non-default data model. | |
| @opindex msymbol-stubs | |
| @opindex mno-symbol-stubs | |
| @item -msymbol-stubs | |
| @itemx -mno-symbol-stubs | |
| Force generation of external symbol indirection stubs for PIC references. | |
| By default, this option is enabled automatically if the target linker | |
| version (@option{-mtarget-linker}) is old enough to require them. | |
| @opindex mtarget-linker | |
| @item -mtarget-linker=@var{version} | |
| @item -mtarget-linker @var{version} | |
| Specify the target @command{ld64} version, overriding any version specified | |
| in the GCC configuration. Newer linker versions support improved code | |
| generation in some cases, for example for PIC code. | |
| @opindex ObjC | |
| @item -ObjC | |
| Equivalent to @samp{-x objective-c}; specifies that the input is | |
| is Objective-C source code. | |
| @opindex ObjC++ | |
| @item -ObjC++ | |
| Equivalent to @samp{-x objective-c++}; specifies that the input is | |
| is Objective-C++ source code. | |
| @opindex Wnonportable-cfstrings | |
| @opindex Wno-nonportable-cfstrings | |
| @item -Wnonportable-cfstrings | |
| @itemx -Wno-nonportable-cfstrings | |
| Warn if constant CoreFoundation string objects contain non-portable | |
| characters. This warning is enabled by default. | |
| @opindex all_load | |
| @item -all_load | |
| Loads all members of static archive libraries. | |
| See man ld(1) for more information. | |
| @opindex arch_errors_fatal | |
| @item -arch_errors_fatal | |
| Cause the errors having to do with files that have the wrong architecture | |
| to be fatal. | |
| @opindex bind_at_load | |
| @item -bind_at_load | |
| Causes the output file to be marked such that the dynamic linker will | |
| bind all undefined references when the file is loaded or launched. | |
| @opindex bundle | |
| @item -bundle | |
| Produce a Mach-o bundle format file. | |
| See man ld(1) for more information. | |
| @opindex bundle_loader | |
| @item -bundle_loader @var{executable} | |
| This option specifies the @var{executable} that will load the build | |
| output file being linked. See man ld(1) for more information. | |
| @opindex dynamiclib | |
| @item -dynamiclib | |
| When passed this option, GCC produces a dynamic library instead of | |
| an executable when linking, using the Darwin @file{libtool} command. | |
| @opindex force_cpusubtype_ALL | |
| @item -force_cpusubtype_ALL | |
| This causes GCC's output file to have the @samp{ALL} subtype, instead of | |
| one controlled by the @option{-mcpu} or @option{-march} option. | |
| @opindex nodefaultrpaths | |
| @item -nodefaultrpaths | |
| Do not add default run paths for the compiler library directories to | |
| executables, modules or dynamic libraries. On macOS 10.5 and later, | |
| the embedded runpath is added by default unless the user adds | |
| @option{-nodefaultrpaths} to the link line. Run paths are needed | |
| (and therefore enforced) to build on macOS version 10.11 or later. | |
| @opindex nodefaultexport | |
| @item -nodefaultexport | |
| Do not add default symbol exports to modules or dynamic libraries. | |
| @opindex allowable_client | |
| @opindex client_name | |
| @opindex compatibility_version | |
| @opindex current_version | |
| @opindex dead_strip | |
| @opindex dylib_file | |
| @opindex dylinker | |
| @opindex dylinker_install_name | |
| @opindex dynamic | |
| @opindex exported_symbols_list | |
| @opindex filelist | |
| @opindex flat_namespace | |
| @opindex force_flat_namespace | |
| @opindex framework | |
| @opindex headerpad_max_install_names | |
| @opindex image_base | |
| @opindex init | |
| @opindex install_name | |
| @opindex keep_private_externs | |
| @opindex pagezero_size | |
| @opindex read_only_relocs | |
| @opindex sectalign | |
| @opindex sectcreate | |
| @opindex seg_addr_table | |
| @opindex seg1addr | |
| @opindex segaddr | |
| @opindex segprot | |
| @opindex segs_read_only_addr | |
| @opindex segs_read_write_addr | |
| @opindex sub_library | |
| @opindex sub_umbrella | |
| @opindex twolevel_namespace | |
| @opindex twolevel_namespace_hints | |
| @opindex umbrella | |
| @opindex undefined | |
| @opindex unexported_symbols_list | |
| @opindex weak_framework | |
| @opindex weak_reference_mismatches | |
| @opindex whatsloaded | |
| @opindex whyload | |
| @item -allowable_client @var{client_name} | |
| @itemx -client_name | |
| @itemx -compatibility_version | |
| @itemx -current_version | |
| @itemx -dead_strip | |
| @itemx -dylib_file | |
| @itemx -dylinker | |
| @itemx -dylinker_install_name | |
| @itemx -dynamic | |
| @itemx -exported_symbols_list | |
| @itemx -filelist | |
| @need 800 | |
| @itemx -flat_namespace | |
| @itemx -force_flat_namespace | |
| @itemx -framework | |
| @itemx -headerpad_max_install_names | |
| @itemx -image_base | |
| @itemx -init @var{symbol-name} | |
| @itemx -install_name | |
| @itemx -keep_private_externs | |
| @need 800 | |
| @itemx -pagezero_size | |
| @itemx -preload | |
| @need 800 | |
| @itemx -read_only_relocs | |
| @itemx -sectalign | |
| @itemx -sectcreate | |
| @itemx -seg_addr_table | |
| @itemx -seg1addr | |
| @itemx -segaddr | |
| @need 800 | |
| @itemx -segprot | |
| @itemx -segs_read_only_addr | |
| @itemx -segs_read_write_addr | |
| @itemx -sub_library | |
| @need 800 | |
| @itemx -sub_umbrella | |
| @itemx -twolevel_namespace | |
| @itemx -twolevel_namespace_hints | |
| @itemx -umbrella | |
| @itemx -undefined | |
| @itemx -unexported_symbols_list | |
| @itemx -weak_framework | |
| @itemx -weak_reference_mismatches | |
| @itemx -whatsloaded | |
| @itemx -whyload | |
| These options are passed to the Darwin linker. The Darwin linker man page | |
| describes them in detail. | |
| @end table | |
| @node DEC Alpha Options | |
| @subsection DEC Alpha Options | |
| These @samp{-m} options are defined for the DEC Alpha implementations: | |
| @table @gcctabopt | |
| @opindex mno-soft-float | |
| @opindex msoft-float | |
| @item -mno-soft-float | |
| @itemx -msoft-float | |
| Use (do not use) the hardware floating-point instructions for | |
| floating-point operations. When @option{-msoft-float} is specified, | |
| functions in @file{libgcc.a} are used to perform floating-point | |
| operations. Unless they are replaced by routines that emulate the | |
| floating-point operations, or compiled in such a way as to call such | |
| emulations routines, these routines issue floating-point | |
| operations. If you are compiling for an Alpha without floating-point | |
| operations, you must ensure that the library is built so as not to call | |
| them. | |
| Note that Alpha implementations without floating-point operations are | |
| required to have floating-point registers. | |
| @opindex mfp-regs | |
| @opindex mno-fp-regs | |
| @item -mfp-regs | |
| @itemx -mno-fp-regs | |
| Generate code that uses (does not use) the floating-point register set. | |
| @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point | |
| register set is not used, floating-point operands are passed in integer | |
| registers as if they were integers and floating-point results are passed | |
| in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence, | |
| so any function with a floating-point argument or return value called by code | |
| compiled with @option{-mno-fp-regs} must also be compiled with that | |
| option. | |
| A typical use of this option is building a kernel that does not use, | |
| and hence need not save and restore, any floating-point registers. | |
| @opindex mieee | |
| @item -mieee | |
| The Alpha architecture implements floating-point hardware optimized for | |
| maximum performance. It is mostly compliant with the IEEE floating-point | |
| standard. However, for full compliance, software assistance is | |
| required. This option generates code fully IEEE-compliant code | |
| @emph{except} that the @var{inexact-flag} is not maintained (see below). | |
| If this option is turned on, the preprocessor macro @code{_IEEE_FP} is | |
| defined during compilation. The resulting code is less efficient but is | |
| able to correctly support denormalized numbers and exceptional IEEE | |
| values such as not-a-number and plus/minus infinity. Other Alpha | |
| compilers call this option @option{-ieee_with_no_inexact}. | |
| @opindex mieee-with-inexact | |
| @item -mieee-with-inexact | |
| This is like @option{-mieee} except the generated code also maintains | |
| the IEEE @var{inexact-flag}. Turning on this option causes the | |
| generated code to implement fully-compliant IEEE math. In addition to | |
| @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor | |
| macro. On some Alpha implementations the resulting code may execute | |
| significantly slower than the code generated by default. Since there is | |
| very little code that depends on the @var{inexact-flag}, you should | |
| normally not specify this option. Other Alpha compilers call this | |
| option @option{-ieee_with_inexact}. | |
| @opindex mfp-trap-mode | |
| @item -mfp-trap-mode=@var{trap-mode} | |
| This option controls what floating-point related traps are enabled. | |
| Other Alpha compilers call this option @option{-fptm @var{trap-mode}}. | |
| The trap mode can be set to one of four values: | |
| @table @samp | |
| @item n | |
| This is the default (normal) setting. The only traps that are enabled | |
| are the ones that cannot be disabled in software (e.g., division by zero | |
| trap). | |
| @item u | |
| In addition to the traps enabled by @samp{n}, underflow traps are enabled | |
| as well. | |
| @item su | |
| Like @samp{u}, but the instructions are marked to be safe for software | |
| completion (see Alpha architecture manual for details). | |
| @item sui | |
| Like @samp{su}, but inexact traps are enabled as well. | |
| @end table | |
| @opindex mfp-rounding-mode | |
| @item -mfp-rounding-mode=@var{rounding-mode} | |
| Selects the IEEE rounding mode. Other Alpha compilers call this option | |
| @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one | |
| of: | |
| @table @samp | |
| @item n | |
| Normal IEEE rounding mode. Floating-point numbers are rounded towards | |
| the nearest machine number or towards the even machine number in case | |
| of a tie. | |
| @item m | |
| Round towards minus infinity. | |
| @item c | |
| Chopped rounding mode. Floating-point numbers are rounded towards zero. | |
| @item d | |
| Dynamic rounding mode. A field in the floating-point control register | |
| (@var{fpcr}, see Alpha architecture reference manual) controls the | |
| rounding mode in effect. The C library initializes this register, so | |
| unless your program modifies the @var{fpcr}, for example through | |
| @code{fesetround}, @samp{d} corresponds to the rounding mode the C | |
| library selected. | |
| @end table | |
| The default is @samp{n}, except that @samp{d} is the default when | |
| @option{-frounding-math} is in effect, since only dynamic rounding can | |
| honor a rounding mode chosen at run time. This does not apply to | |
| @option{-mfloat-vax}, whose instructions have no dynamic rounding | |
| qualifier. | |
| @opindex mtrap-precision | |
| @item -mtrap-precision=@var{trap-precision} | |
| In the Alpha architecture, floating-point traps are imprecise. This | |
| means without software assistance it is impossible to recover from a | |
| floating trap and program execution normally needs to be terminated. | |
| GCC can generate code that can assist operating system trap handlers | |
| in determining the exact location that caused a floating-point trap. | |
| Depending on the requirements of an application, different levels of | |
| precisions can be selected: | |
| @table @samp | |
| @item p | |
| Program precision. This option is the default and means a trap handler | |
| can only identify which program caused a floating-point exception. | |
| @item f | |
| Function precision. The trap handler can determine the function that | |
| caused a floating-point exception. | |
| @item i | |
| Instruction precision. The trap handler can determine the exact | |
| instruction that caused a floating-point exception. | |
| @end table | |
| Other Alpha compilers provide the equivalent options called | |
| @option{-scope_safe} and @option{-resumption_safe}. | |
| @opindex mieee-conformant | |
| @item -mieee-conformant | |
| This option marks the generated code as IEEE conformant. You must not | |
| use this option unless you also specify @option{-mtrap-precision=i} and either | |
| @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect | |
| is to emit the line @samp{.eflag 48} in the function prologue of the | |
| generated assembly file. | |
| @opindex mbuild-constants | |
| @item -mbuild-constants | |
| Normally GCC examines a 32- or 64-bit integer constant to | |
| see if it can construct it from smaller constants in two or three | |
| instructions. If it cannot, it outputs the constant as a literal and | |
| generates code to load it from the data segment at run time. | |
| Use this option to require GCC to construct @emph{all} integer constants | |
| using code, even if it takes more instructions (the maximum is six). | |
| You typically use this option to build a shared library dynamic | |
| loader. Itself a shared library, it must relocate itself in memory | |
| before it can find the variables and constants in its own data segment. | |
| @opindex mbwx | |
| @opindex mno-bwx | |
| @opindex mcix | |
| @opindex mno-cix | |
| @opindex mfix | |
| @opindex mno-fix | |
| @opindex mmax | |
| @opindex mno-max | |
| @item -mbwx | |
| @itemx -mno-bwx | |
| @itemx -mcix | |
| @itemx -mno-cix | |
| @itemx -mfix | |
| @itemx -mno-fix | |
| @itemx -mmax | |
| @itemx -mno-max | |
| Indicate whether GCC should generate code to use the optional BWX, | |
| CIX, FIX and MAX instruction sets. The default is to use the instruction | |
| sets supported by the CPU type specified via @option{-mcpu=} option or that | |
| of the CPU on which GCC was built if none is specified. | |
| @opindex msafe-bwa | |
| @opindex mno-safe-bwa | |
| @item -msafe-bwa | |
| @itemx -mno-safe-bwa | |
| Indicate whether in the absence of the optional BWX instruction set | |
| GCC should generate multi-thread and async-signal safe code for byte | |
| and aligned word memory accesses. | |
| @opindex msafe-partial | |
| @opindex mno-safe-partial | |
| @item -msafe-partial | |
| @itemx -mno-safe-partial | |
| Indicate whether GCC should generate multi-thread and async-signal | |
| safe code for partial memory accesses, including piecemeal accesses | |
| to unaligned data as well as block accesses to leading and trailing | |
| parts of aggregate types or other objects in memory that do not | |
| respectively start and end on an aligned 64-bit data boundary. | |
| @opindex mfloat-vax | |
| @opindex mfloat-ieee | |
| @item -mfloat-vax | |
| @itemx -mfloat-ieee | |
| Generate code that uses (does not use) VAX F and G floating-point | |
| arithmetic instead of IEEE single and double precision. | |
| @opindex mexplicit-relocs | |
| @opindex mno-explicit-relocs | |
| @item -mexplicit-relocs | |
| @itemx -mno-explicit-relocs | |
| Older Alpha assemblers provided no way to generate symbol relocations | |
| except via assembler macros. Use of these macros does not allow | |
| optimal instruction scheduling. GNU Binutils as of version 2.12 | |
| supports a new syntax that allows the compiler to explicitly mark | |
| which relocations should apply to which instructions. This option | |
| is mostly useful for debugging, as GCC detects the capabilities of | |
| the assembler when it is built and sets the default accordingly. | |
| @opindex msmall-data | |
| @opindex mlarge-data | |
| @item -msmall-data | |
| @itemx -mlarge-data | |
| When @option{-mexplicit-relocs} is in effect, static data is | |
| accessed via @dfn{gp-relative} relocations. When @option{-msmall-data} | |
| is used, objects 8 bytes long or smaller are placed in a @dfn{small data area} | |
| (the @code{.sdata} and @code{.sbss} sections) and are accessed via | |
| 16-bit relocations off of the @code{$gp} register. This limits the | |
| size of the small data area to 64KB, but allows the variables to be | |
| directly accessed via a single instruction. | |
| The default is @option{-mlarge-data}. With this option the data area | |
| is limited to just below 2GB@. Programs that require more than 2GB of | |
| data must use @code{malloc} or @code{mmap} to allocate the data in the | |
| heap instead of in the program's data segment. | |
| When generating code for shared libraries, @option{-fpic} implies | |
| @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}. | |
| @opindex msmall-text | |
| @opindex mlarge-text | |
| @item -msmall-text | |
| @itemx -mlarge-text | |
| When @option{-msmall-text} is used, the compiler assumes that the | |
| code of the entire program (or shared library) fits in 4MB, and is | |
| thus reachable with a branch instruction. When @option{-msmall-data} | |
| is used, the compiler can assume that all local symbols share the | |
| same @code{$gp} value, and thus reduce the number of instructions | |
| required for a function call from 4 to 1. | |
| The default is @option{-mlarge-text}. | |
| @opindex mcpu | |
| @item -mcpu=@var{cpu_type} | |
| Set the instruction set and instruction scheduling parameters for | |
| machine type @var{cpu_type}. You can specify either the @samp{EV} | |
| style name or the corresponding chip number. GCC supports scheduling | |
| parameters for the EV4, EV5 and EV6 family of processors and | |
| chooses the default values for the instruction set from the processor | |
| you specify. If you do not specify a processor type, GCC defaults | |
| to the processor on which the compiler was built. | |
| Supported values for @var{cpu_type} are | |
| @table @samp | |
| @item ev4 | |
| @itemx ev45 | |
| @itemx 21064 | |
| Schedules as an EV4 and has no instruction set extensions. | |
| @item ev5 | |
| @itemx 21164 | |
| Schedules as an EV5 and has no instruction set extensions. | |
| @item ev56 | |
| @itemx 21164a | |
| Schedules as an EV5 and supports the BWX extension. | |
| @item pca56 | |
| @itemx 21164pc | |
| @itemx 21164PC | |
| Schedules as an EV5 and supports the BWX and MAX extensions. | |
| @item ev6 | |
| @itemx 21264 | |
| Schedules as an EV6 and supports the BWX, FIX, and MAX extensions. | |
| @item ev67 | |
| @itemx 21264a | |
| Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions. | |
| @end table | |
| Native toolchains also support the value @samp{native}, | |
| which selects the best architecture option for the host processor. | |
| @option{-mcpu=native} has no effect if GCC does not recognize | |
| the processor. | |
| @opindex mtune | |
| @item -mtune=@var{cpu_type} | |
| Set only the instruction scheduling parameters for machine type | |
| @var{cpu_type}. The instruction set is not changed. | |
| Native toolchains also support the value @samp{native}, | |
| which selects the best architecture option for the host processor. | |
| @option{-mtune=native} has no effect if GCC does not recognize | |
| the processor. | |
| @opindex mmemory-latency | |
| @item -mmemory-latency=@var{time} | |
| Sets the latency the scheduler should assume for typical memory | |
| references as seen by the application. This number is highly | |
| dependent on the memory access patterns used by the application | |
| and the size of the external cache on the machine. | |
| Valid options for @var{time} are | |
| @table @samp | |
| @item @var{number} | |
| A decimal number representing clock cycles. | |
| @item L1 | |
| @itemx L2 | |
| @itemx L3 | |
| @itemx main | |
| The compiler contains estimates of the number of clock cycles for | |
| ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches | |
| (also called Dcache, Scache, and Bcache), as well as to main memory. | |
| Note that L3 is only valid for EV5. | |
| @end table | |
| @opindex mtls-kernel | |
| @opindex mno-tls-kernel | |
| @item -mtls-kernel | |
| Emit @code{rdval} instead of @code{rduniq} for thread pointer. | |
| @opindex mtls-size | |
| @item -mtls-size=@var{bitsize} | |
| Specify bit size of immediate TLS offsets. Valid values for @var{bitsize} | |
| are 16, 32, and 64; it defaults to 32. | |
| @opindex mlong-double-128 | |
| @opindex mlong-double-64 | |
| @item -mlong-double-128 | |
| @itemx -mlong-double-64 | |
| Specify the size of the @code{long double} type. Note that | |
| @option{-mlong-double-128} is incompatible with VAX floating point. | |
| @end table | |
| @node eBPF Options | |
| @subsection eBPF Options | |
| @cindex eBPF Options | |
| @table @gcctabopt | |
| @opindex mframe-limit | |
| @item -mframe-limit=@var{bytes} | |
| This specifies the hard limit for frame sizes, in bytes. Currently, | |
| the value that can be specified should be less than or equal to | |
| @samp{32767}. Defaults to whatever limit is imposed by the version of | |
| the Linux kernel targeted. | |
| @opindex mbig-endian | |
| @item -mbig-endian | |
| Generate code for a big-endian target. | |
| @opindex mlittle-endian | |
| @item -mlittle-endian | |
| Generate code for a little-endian target. This is the default. | |
| @opindex mjmpext | |
| @opindex mno-jmpext | |
| @item -mjmpext | |
| @itemx -mno-jmpext | |
| Enable or disable generation of extra conditional-branch instructions. | |
| Enabled for CPU v2 and above. | |
| @opindex mjmp32 | |
| @opindex mno-jmp32 | |
| @item -mjmp32 | |
| @itemx -mno-jmp32 | |
| Enable or disable generation of 32-bit jump instructions. | |
| Enabled for CPU v3 and above. | |
| @opindex malu32 | |
| @opindex mno-alu32 | |
| @item -malu32 | |
| @itemx -mno-alu32 | |
| Enable or disable generation of 32-bit ALU instructions. | |
| Enabled for CPU v3 and above. | |
| @opindex mv3-atomics | |
| @opindex mno-v3-atomics | |
| @item -mv3-atomics | |
| @itemx -mno-v3-atomics | |
| Enable or disable instructions for general atomic operations introduced | |
| in CPU v3. Enabled for CPU v3 and above. | |
| @opindex mbswap | |
| @opindex mno-bswap | |
| @item -mbswap | |
| @itemx -mno-bswap | |
| Enable or disable byte swap instructions. Enabled for CPU v4 and above. | |
| @opindex msdiv | |
| @opindex mno-sdiv | |
| @item -msdiv | |
| @itemx -mno-sdiv | |
| Enable or disable signed division and modulus instructions. Enabled for | |
| CPU v4 and above. | |
| @opindex msmov | |
| @opindex mno-smov | |
| @item -msmov | |
| @itemx -mno-smov | |
| Enable or disable sign-extending move and memory load instructions. | |
| Enabled for CPU v4 and above. | |
| @opindex mcallx | |
| @opindex mno-callx | |
| @item -mcallx | |
| @itemx -mno-callx | |
| Enable or disable indirect call instructions, i.e.@: calls through a | |
| function pointer, which are emitted as @code{call %r@var{N}} in the | |
| @samp{normal} assembly dialect and as @code{callx r@var{N}} in the | |
| @samp{pseudoc} one. With @option{-mno-callx} an indirect call is | |
| diagnosed as an error. Enabled for CPU v1 and above. | |
| @opindex mcpu | |
| @item -mcpu=@var{version} | |
| This specifies which version of the eBPF ISA to target. Newer versions | |
| may not be supported by all kernels. The default is @samp{v4}. | |
| Supported values for @var{version} are: | |
| @table @samp | |
| @item v1 | |
| The first stable eBPF ISA. Supports indirect calls, as in | |
| @option{-mcallx}. | |
| @item v2 | |
| Supports the jump extensions, as in @option{-mjmpext}. | |
| @item v3 | |
| All features of v2, plus: | |
| @itemize @minus | |
| @item 32-bit jump operations, as in @option{-mjmp32} | |
| @item 32-bit ALU operations, as in @option{-malu32} | |
| @item general atomic operations, as in @option{-mv3-atomics} | |
| @end itemize | |
| @item v4 | |
| All features of v3, plus: | |
| @itemize @minus | |
| @item Byte swap instructions, as in @option{-mbswap} | |
| @item Signed division and modulus instructions, as in @option{-msdiv} | |
| @item Sign-extending move and memory load instructions, as in @option{-msmov} | |
| @end itemize | |
| @end table | |
| @opindex mco-re | |
| @opindex mno-co-re | |
| @item -mco-re | |
| @itemx -mno-co-re | |
| Enable or disable BPF Compile Once - Run Everywhere (CO-RE) support. | |
| BPF CO-RE support is enabled by default when generating BTF debug | |
| information for the BPF target (@option{-gbtf}). | |
| @opindex mxbpf | |
| @opindex mno-xbpf | |
| @item -mxbpf | |
| Target xBPF, an expanded version of BPF which relaxes some of the | |
| restrictions imposed by the BPF architecture. This option does not | |
| currently affect code generation: it is passed on to the assembler, | |
| where it selects the @samp{xbpf} ISA spec and thus enables the assembly | |
| of xBPF-only instructions. Note that code using such instructions is | |
| not accepted by the kernel BPF verifier. | |
| @opindex masm=@var{dialect} | |
| @item -masm=@var{dialect} | |
| Outputs assembly instructions using eBPF selected @var{dialect}. The default | |
| is @samp{pseudoc}. | |
| Supported values for @var{dialect} are: | |
| @table @samp | |
| @item normal | |
| Outputs normal assembly dialect. | |
| @item pseudoc | |
| Outputs pseudo-c assembly dialect. | |
| @end table | |
| @opindex minline-memops-threshold | |
| @item -minline-memops-threshold=@var{bytes} | |
| Specifies a size threshold in bytes at or below which memmove, memcpy | |
| and memset shall always be expanded inline. Operations dealing with | |
| sizes larger than this threshold would have to be implemented using | |
| a library call instead of being expanded inline, but since BPF doesn't | |
| allow libcalls, exceeding this threshold results in a compile-time | |
| error. The default is @samp{1024} bytes. | |
| @opindex Wco-re | |
| @item -Wco-re | |
| Enable warnings for scenarios where -mco-re is enabled, but it may not be | |
| possible to generate CO-RE compatible code. | |
| @end table | |
| @node FR30 Options | |
| @subsection FR30 Options | |
| @cindex FR30 Options | |
| These options are defined specifically for the FR30 port. | |
| @table @gcctabopt | |
| @opindex msmall-model | |
| @opindex mno-small-model | |
| @item -msmall-model | |
| Use the small address space model. This can produce smaller code, but | |
| it does assume that all symbolic values and addresses fit into a | |
| 20-bit range. | |
| @opindex mno-lsim | |
| @item -mno-lsim | |
| Assume that runtime support has been provided and so there is no need | |
| to include the simulator library (@file{libsim.a}) on the linker | |
| command line. | |
| @end table | |
| @node FRV Options | |
| @subsection FRV Options | |
| @cindex FRV Options | |
| @table @gcctabopt | |
| @opindex mgpr-32 | |
| @item -mgpr-32 | |
| Only use the first 32 general-purpose registers. | |
| @opindex mgpr-64 | |
| @item -mgpr-64 | |
| Use all 64 general-purpose registers. | |
| @opindex mfpr-32 | |
| @item -mfpr-32 | |
| Use only the first 32 floating-point registers. | |
| @opindex mfpr-64 | |
| @item -mfpr-64 | |
| Use all 64 floating-point registers. | |
| @opindex mhard-float | |
| @item -mhard-float | |
| Use hardware instructions for floating-point operations. | |
| @opindex msoft-float | |
| @item -msoft-float | |
| Use library routines for floating-point operations. | |
| @opindex malloc-cc | |
| @item -malloc-cc | |
| Dynamically allocate condition code registers. | |
| @opindex mfixed-cc | |
| @item -mfixed-cc | |
| Do not try to dynamically allocate condition code registers, only | |
| use @code{icc0} and @code{fcc0}. | |
| @opindex mdword | |
| @opindex mno-dword | |
| @item -mdword | |
| @itemx -mno-dword | |
| Control whether the ABI uses double-word instructions. | |
| @opindex mdouble | |
| @opindex mno-double | |
| @item -mdouble | |
| @itemx -mno-double | |
| Enable or disable use of floating-point double instructions. | |
| @opindex mmedia | |
| @opindex mno-media | |
| @item -mmedia | |
| @itemx -mno-media | |
| Enable or disable use of media instructions. | |
| @opindex mmuladd | |
| @opindex mno-muladd | |
| @item -mmuladd | |
| @itemx -mno-muladd | |
| Enable or disable use of multiply and add/subtract instructions. | |
| @opindex mfdpic | |
| @opindex mno-fdpic | |
| @item -mfdpic | |
| Select the FDPIC ABI, which uses function descriptors to represent | |
| pointers to functions. Without any PIC/PIE-related options, it | |
| implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it | |
| assumes GOT entries and small data are within a 12-bit range from the | |
| GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets | |
| are computed with 32 bits. | |
| With a @samp{bfin-elf} target, this option implies @option{-msim}. | |
| @opindex minline-plt | |
| @opindex mno-inline-plt | |
| @item -minline-plt | |
| Enable inlining of PLT entries in function calls to functions that are | |
| not known to bind locally. It has no effect without @option{-mfdpic}. | |
| It's enabled by default if optimizing for speed and compiling for | |
| shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an | |
| optimization option such as @option{-O3} or above is present in the | |
| command line. | |
| @opindex mTLS | |
| @item -mTLS | |
| Assume a large TLS segment when generating thread-local code. | |
| @opindex mtls | |
| @item -mtls | |
| Do not assume a large TLS segment when generating thread-local code. | |
| @opindex mgprel-ro | |
| @opindex mno-gprel-ro | |
| @item -mgprel-ro | |
| Enable the use of @code{GPREL} relocations in the FDPIC ABI for data | |
| that is known to be in read-only sections. It's enabled by default, | |
| except for @option{-fpic} or @option{-fpie}: even though it may help | |
| make the global offset table smaller, it trades 1 instruction for 4. | |
| With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4, | |
| one of which may be shared by multiple symbols, and it avoids the need | |
| for a GOT entry for the referenced symbol, so it's more likely to be a | |
| win. If it is not, @option{-mno-gprel-ro} can be used to disable it. | |
| @opindex multilib-library-pic | |
| @item -multilib-library-pic | |
| Link with the (library, not FD) pic libraries. It's implied by | |
| @option{-mlibrary-pic}, as well as by @option{-fPIC} and | |
| @option{-fpic} without @option{-mfdpic}. You should never have to use | |
| it explicitly. | |
| @opindex mlinked-fp | |
| @opindex mno-linked-fp | |
| @item -mlinked-fp | |
| Follow the EABI requirement of always creating a frame pointer whenever | |
| a stack frame is allocated. This option is enabled by default and can | |
| be disabled with @option{-mno-linked-fp}. | |
| @opindex mlong-calls | |
| @opindex mno-long-calls | |
| @item -mlong-calls | |
| Use indirect addressing to call functions outside the current | |
| compilation unit. This allows the functions to be placed anywhere | |
| within the 32-bit address space. | |
| @opindex malign-labels | |
| @opindex mno-align-labels | |
| @item -malign-labels | |
| Try to align labels to an 8-byte boundary by inserting NOPs into the | |
| previous packet. This option only has an effect when VLIW packing | |
| is enabled. It doesn't create new packets; it merely adds NOPs to | |
| existing ones. | |
| @opindex mlibrary-pic | |
| @opindex mno-library-pic | |
| @item -mlibrary-pic | |
| Generate position-independent EABI code. | |
| @opindex macc-4 | |
| @item -macc-4 | |
| Use only the first four media accumulator registers. | |
| @opindex macc-8 | |
| @item -macc-8 | |
| Use all eight media accumulator registers. | |
| @opindex mpack | |
| @opindex mno-pack | |
| @item -mpack | |
| @item -mno-pack | |
| Enable or disable packing VLIW instructions. | |
| @opindex mno-eflags | |
| @item -mno-eflags | |
| Do not mark ABI switches in e_flags. | |
| @opindex mcond-move | |
| @opindex mno-cond-move | |
| @item -mcond-move | |
| @itemx -mno-cond-move | |
| Enable or disable the use of conditional-move instructions; it is enabled | |
| by default. | |
| This switch is mainly for debugging the compiler and will likely be removed | |
| in a future version. | |
| @opindex mscc | |
| @opindex mno-scc | |
| @item -mscc | |
| @itemx -mno-scc | |
| Enable or disable the use of conditional set instructions; it is enabled | |
| by default. | |
| This switch is mainly for debugging the compiler and will likely be removed | |
| in a future version. | |
| @opindex mcond-exec | |
| @opindex mno-cond-exec | |
| @item -mcond-exec | |
| @itemx -mno-cond-exec | |
| Enable or disable the use of conditional execution; it is enabled by default. | |
| This switch is mainly for debugging the compiler and will likely be removed | |
| in a future version. | |
| @opindex mvliw-branch | |
| @opindex mno-vliw-branch | |
| @item -mvliw-branch | |
| @itemx -mno-vliw-branch | |
| Enable or disable an optimization pass to pack branches into VLIW instructions; | |
| it is enabled by default. | |
| This switch is mainly for debugging the compiler and will likely be removed | |
| in a future version. | |
| @opindex mmulti-cond-exec | |
| @opindex mno-multi-cond-exec | |
| @item -mmulti-cond-exec | |
| @itemx -mno-multi-cond-exec | |
| Enable or disable optimization of @code{&&} and @code{||} in conditional | |
| execution; it is enabled by default. | |
| This switch is mainly for debugging the compiler and will likely be removed | |
| in a future version. | |
| @opindex mnested-cond-exec | |
| @opindex mno-nested-cond-exec | |
| @item -mnested-cond-exec | |
| @itemx -mno-nested-cond-exec | |
| Enable or disable nested conditional execution optimizations; it is enabled | |
| by default. | |
| This switch is mainly for debugging the compiler and will likely be removed | |
| in a future version. | |
| @opindex moptimize-membar | |
| @opindex mno-optimize-membar | |
| @item -moptimize-membar | |
| @itemx -mno-optimize-membar | |
| This switch removes redundant @code{membar} instructions from the | |
| compiler-generated code. It is enabled by default. | |
| @opindex mtomcat-stats | |
| @opindex mno-tomcat-stats | |
| @item -mtomcat-stats | |
| Cause gas to print out tomcat statistics. | |
| @opindex mcpu | |
| @item -mcpu=@var{cpu} | |
| Select the processor type for which to generate code. Possible values are | |
| @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450}, | |
| @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}. | |
| @end table | |
| @node FT32 Options | |
| @subsection FT32 Options | |
| @cindex FT32 Options | |
| These options are defined specifically for the FT32 port. | |
| @table @gcctabopt | |
| @opindex msim | |
| @opindex mno-sim | |
| @item -msim | |
| Specifies that the program will be run on the simulator. This causes | |
| an alternate runtime startup and library to be linked. | |
| You must not use this option when generating programs that will run on | |
| real hardware; you must provide your own runtime library for whatever | |
| I/O functions are needed. | |
| @opindex mnodiv | |
| @opindex mno-nodiv | |
| @item -mnodiv | |
| Do not use div and mod instructions. | |
| @opindex mft32b | |
| @opindex mno-ft32b | |
| @item -mft32b | |
| Enable use of the extended instructions of the FT32B processor. | |
| @opindex mcompress | |
| @opindex mno-compress | |
| @item -mcompress | |
| Compress all code using the Ft32B code compression scheme. | |
| @opindex mnopm | |
| @opindex mno-nopm | |
| @item -mnopm | |
| Do not generate code that reads program memory. | |
| @end table | |
| @node GNU/Linux Options | |
| @subsection GNU/Linux Options | |
| These @samp{-m} options are defined for GNU/Linux targets: | |
| @table @gcctabopt | |
| @opindex mglibc | |
| @item -mglibc | |
| Use the GNU C library. This is the default except | |
| on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and | |
| @samp{*-*-linux-*android*} targets. | |
| @opindex muclibc | |
| @item -muclibc | |
| Use uClibc C library. This is the default on | |
| @samp{*-*-linux-*uclibc*} targets. | |
| @opindex mmusl | |
| @item -mmusl | |
| Use the musl C library. This is the default on | |
| @samp{*-*-linux-*musl*} targets. | |
| @opindex mbionic | |
| @item -mbionic | |
| Use Bionic C library. This is the default on | |
| @samp{*-*-linux-*android*} targets. | |
| @opindex mandroid | |
| @opindex mno-android | |
| @item -mandroid | |
| @itemx -mno-android | |
| Compile code compatible with Android platform. This is the default on | |
| @samp{*-*-linux-*android*} targets. | |
| When compiling, this option enables @option{-mbionic}, @option{-fPIC}, | |
| @option{-fno-exceptions} and @option{-fno-rtti} by default. When linking, | |
| this option makes the GCC driver pass Android-specific options to the linker. | |
| Finally, this option causes the preprocessor macro @code{__ANDROID__} | |
| to be defined. | |
| This option can be disabled completely with @option{-mno-android}. | |
| @opindex tno-android-cc | |
| @item -tno-android-cc | |
| Disable compilation effects of @option{-mandroid}, i.e., do not enable | |
| @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and | |
| @option{-fno-rtti} by default. | |
| @opindex tno-android-ld | |
| @item -tno-android-ld | |
| Disable linking effects of @option{-mandroid}, i.e., pass standard Linux | |
| linking options to the linker. | |
| @end table | |
| @node H8/300 Options | |
| @subsection H8/300 Options | |
| These @samp{-m} options are defined for the H8/300 implementations: | |
| @table @gcctabopt | |
| @opindex mrelax | |
| @item -mrelax | |
| Shorten some address references at link time, when possible; uses the | |
| linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300, | |
| ld, Using ld}, for a fuller description. | |
| @opindex mh | |
| @opindex mno-h | |
| @item -mh | |
| Generate code for the H8/300H@. | |
| @opindex ms | |
| @opindex mno-s | |
| @item -ms | |
| Generate code for the H8S@. | |
| @opindex mn | |
| @opindex mno-n | |
| @item -mn | |
| Generate code for the H8S and H8/300H in the normal mode. This switch | |
| must be used with either @option{-mh} or @option{-ms}. | |
| @opindex msx | |
| @opindex mno-sx | |
| @item -msx | |
| Generate H8SX code. | |
| @opindex ms2600 | |
| @opindex mno-s2600 | |
| @item -ms2600 | |
| Generate code for the H8S/2600. This switch must be used with @option{-ms}. | |
| @opindex mquickcall | |
| @opindex mno-quickcall | |
| @item -mquickcall | |
| Use registers for argument passing. | |
| @opindex mslowbyte | |
| @item -mslowbyte | |
| Consider access to byte-sized memory slow. | |
| @opindex mexr | |
| @opindex mno-exr | |
| @item -mexr | |
| @itemx -mno-exr | |
| Store extended registers on the stack before execution of functions | |
| with the @code{monitor} attribute (@pxref{H8/300 Attributes}). | |
| The default is @option{-mexr}. This option is valid only for H8S targets. | |
| @opindex mint32 | |
| @item -mint32 | |
| Make @code{int} data 32 bits by default. | |
| @opindex malign-300 | |
| @item -malign-300 | |
| On the H8/300H and H8S, use the same alignment rules as for the H8/300. | |
| The default for the H8/300H and H8S is to align longs and floats on | |
| 4-byte boundaries. | |
| @option{-malign-300} causes them to be aligned on 2-byte boundaries. | |
| This option has no effect on the H8/300. | |
| @end table | |
| @node HPPA Options | |
| @subsection HPPA Options | |
| @cindex HPPA Options | |
| These @samp{-m} options are defined for the HPPA family of computers: | |
| @table @gcctabopt | |
| @opindex march | |
| @item -march=@var{architecture-type} | |
| Generate code for the specified architecture. The choices for | |
| @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA | |
| 1.1, and @samp{2.0} for PA 2.0 processors. Refer to | |
| @file{/usr/lib/sched.models} on an HP-UX system to determine the proper | |
| architecture option for your machine. Code compiled for lower numbered | |
| architectures runs on higher numbered architectures, but not the | |
| other way around. | |
| @opindex mpa-risc-1-0 | |
| @opindex mpa-risc-1-1 | |
| @opindex mpa-risc-2-0 | |
| @item -mpa-risc-1-0 | |
| @itemx -mpa-risc-1-1 | |
| @itemx -mpa-risc-2-0 | |
| Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0}, | |
| respectively. | |
| @opindex matomic-libcalls | |
| @opindex mno-atomic-libcalls | |
| @item -matomic-libcalls | |
| @itemx -mno-atomic-libcalls | |
| Generate libcalls for atomic loads and stores when sync libcalls are disabled. | |
| This option is enabled by default. It only affects the generation of | |
| atomic libcalls by the HPPA backend. | |
| Both the sync and @file{libatomic} libcall implementations use locking. | |
| As a result, processor stores are not atomic with respect to other | |
| atomic operations. Processor loads up to DImode are atomic with | |
| respect to other atomic operations provided they are implemented as | |
| a single access. | |
| The PA-RISC architecture does not support any atomic operations in | |
| hardware except for the @code{ldcw} instruction. Thus, all atomic | |
| support is implemented using sync and atomic libcalls. Sync libcall | |
| support is in @file{libgcc.a}. Atomic libcall support is in | |
| @file{libatomic}. | |
| This option generates @code{__atomic_exchange} calls for atomic stores. | |
| It also provides special handling for atomic DImode accesses on 32-bit | |
| targets. | |
| @opindex mcaller-copies | |
| @opindex mno-caller-copies | |
| @item -mcaller-copies | |
| The caller copies function arguments passed by hidden reference. This | |
| option should be used with care as it is not compatible with the default | |
| 32-bit runtime. However, only aggregates larger than eight bytes are | |
| passed by hidden reference and the option provides better compatibility | |
| with OpenMP. | |
| @opindex mcoherent-ldcw | |
| @opindex mno-coherent-ldcw | |
| @item -mcoherent-ldcw | |
| Use ldcw/ldcd coherent cache-control hint. | |
| @opindex mdisable-fpregs | |
| @opindex mno-disable-fpregs | |
| @item -mdisable-fpregs | |
| Disable floating-point registers. Equivalent to @option{-msoft-float}. | |
| @opindex mdisable-indexing | |
| @opindex mno-disable-indexing | |
| @item -mdisable-indexing | |
| Prevent the compiler from using indexing address modes. This avoids some | |
| rather obscure problems when compiling MIG generated code under MACH@. | |
| @opindex mfast-indirect-calls | |
| @opindex mno-fast-indirect-calls | |
| @item -mfast-indirect-calls | |
| Generate code that assumes calls never cross space boundaries. This | |
| allows GCC to emit code that performs faster indirect calls. | |
| This option does not work in the presence of shared libraries or nested | |
| functions. | |
| @opindex mfixed-range | |
| @item -mfixed-range=@var{register-range} | |
| Generate code treating the given register range as fixed registers. | |
| A fixed register is one that the register allocator cannot use. This is | |
| useful when compiling kernel code. A register range is specified as | |
| two registers separated by a dash. Multiple register ranges can be | |
| specified separated by a comma. | |
| @opindex mgas | |
| @opindex mno-gas | |
| @item -mgas | |
| Enable the use of assembler directives only GAS understands. | |
| @opindex mgnu-ld | |
| @item -mgnu-ld | |
| Use options specific to GNU @command{ld}. | |
| This passes @option{-shared} to @command{ld} when | |
| building a shared library. It is the default when GCC is configured, | |
| explicitly or implicitly, with the GNU linker. This option does not | |
| affect which @command{ld} is called; it only changes what parameters | |
| are passed to that @command{ld}. | |
| The @command{ld} that is called is determined by the | |
| @option{--with-ld} configure option, GCC's program search path, and | |
| finally by the user's @env{PATH}. The linker used by GCC can be printed | |
| using @samp{which `gcc -print-prog-name=ld`}. This option is only available | |
| on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}. | |
| @opindex mhp-ld | |
| @item -mhp-ld | |
| Use options specific to HP @command{ld}. | |
| This passes @option{-b} to @command{ld} when building | |
| a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all | |
| links. It is the default when GCC is configured, explicitly or | |
| implicitly, with the HP linker. This option does not affect | |
| which @command{ld} is called; it only changes what parameters are passed to that | |
| @command{ld}. | |
| The @command{ld} that is called is determined by the @option{--with-ld} | |
| configure option, GCC's program search path, and finally by the user's | |
| @env{PATH}. The linker used by GCC can be printed using @samp{which | |
| `gcc -print-prog-name=ld`}. This option is only available on the 64-bit | |
| HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}. | |
| @opindex mlinker-opt | |
| @item -mlinker-opt | |
| Enable the optimization pass in the HP-UX linker. Note this makes symbolic | |
| debugging impossible. | |
| @opindex mno-long-calls | |
| @opindex mlong-calls | |
| @item -mlong-calls | |
| Generate code that uses long call sequences. This ensures that a call | |
| is always able to reach linker generated stubs. The default is to generate | |
| long calls only when the distance from the call site to the beginning | |
| of the function or translation unit, as the case may be, exceeds a | |
| predefined limit set by the branch type being used. The limits for | |
| normal calls are 7,600,000 and 240,000 bytes, respectively for the | |
| PA 2.0 and PA 1.X architectures. Sibling calls are always limited at | |
| 240,000 bytes. | |
| Distances are measured from the beginning of functions when using the | |
| @option{-ffunction-sections} option, or when using the @option{-mgas} | |
| and @option{-mno-portable-runtime} options together under HP-UX with | |
| the SOM linker. | |
| It is normally not desirable to use this option as it degrades | |
| performance. However, it may be useful in large applications, | |
| particularly when partial linking is used to build the application. | |
| The types of long calls used depends on the capabilities of the | |
| assembler and linker, and the type of code being generated. The | |
| impact on systems that support long absolute calls, and long PIC | |
| symbol-difference or PC-relative calls should be relatively small. | |
| However, an indirect call is used on 32-bit ELF systems in PIC code | |
| and it is quite long. | |
| @opindex mlong-load-store | |
| @opindex mno-long-load-store | |
| @item -mlong-load-store | |
| Generate 3-instruction load and store sequences as sometimes required by | |
| the HP-UX 10 linker. This is equivalent to the @samp{+k} option to | |
| the HP compilers. | |
| @opindex mno-space-regs | |
| @opindex mspace-regs | |
| @item -mno-space-regs | |
| Generate code that assumes the target has no space registers. This allows | |
| GCC to generate faster indirect calls and use unscaled index address modes. | |
| Such code is suitable for level 0 PA systems and kernels. | |
| @opindex mordered | |
| @opindex mno-ordered | |
| @item -mordered | |
| Assume memory references are ordered and barriers are not needed. | |
| @opindex mportable-runtime | |
| @opindex mno-portable-runtime | |
| @item -mportable-runtime | |
| Use the portable calling conventions proposed by HP for ELF systems. | |
| @opindex mschedule | |
| @item -mschedule=@var{cpu-type} | |
| Schedule code according to the constraints for the machine type | |
| @var{cpu-type}. The choices for @var{cpu-type} are @samp{700} | |
| @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer | |
| to @file{/usr/lib/sched.models} on an HP-UX system to determine the | |
| proper scheduling option for your machine. The default scheduling is | |
| @samp{8000}. | |
| @opindex msio | |
| @opindex mwsio | |
| @item -msio | |
| @itemx -mwsio | |
| The @option{-msio} generates the predefine, @code{_SIO}, for server IO@. | |
| The default is | |
| @option{-mwsio}. This generates the predefines, @code{__hp9000s700}, | |
| @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These | |
| options are available under HP-UX and HI-UX@. | |
| @opindex msoft-float | |
| @opindex mno-soft-float | |
| @item -msoft-float | |
| Generate output containing library calls for floating point. | |
| @strong{Warning:} the requisite libraries are not available for all HPPA | |
| targets. Normally the facilities of the machine's usual C compiler are | |
| used, but this cannot be done directly in cross-compilation. You must make | |
| your own arrangements to provide suitable library functions for | |
| cross-compilation. | |
| @option{-msoft-float} changes the calling convention in the output file; | |
| therefore, it is only useful if you compile @emph{all} of a program with | |
| this option. In particular, you need to compile @file{libgcc.a}, the | |
| library that comes with GCC, with @option{-msoft-float} in order for | |
| this to work. | |
| @opindex msoft-mult | |
| @opindex mno-soft-mult | |
| @item -msoft-mult | |
| Use software integer multiplication. | |
| This disables the use of the @code{xmpyu} instruction. | |
| @opindex march | |
| @item -munix=@var{unix-std} | |
| Generate compiler predefines and select a startfile for the specified | |
| UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95} | |
| and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95} | |
| is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX | |
| 11.11 and later. The default values are @samp{93} for HP-UX 10.00, | |
| @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11 | |
| and later. | |
| @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4. | |
| @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX} | |
| and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}. | |
| @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX}, | |
| @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and | |
| @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}. | |
| It is @emph{important} to note that this option changes the interfaces | |
| for various library routines. It also affects the operational behavior | |
| of the C library. Thus, @emph{extreme} care is needed in using this | |
| option. | |
| Library code that is intended to operate with more than one UNIX | |
| standard must test, set and restore the variable @code{__xpg4_extended_mask} | |
| as appropriate. Most GNU software doesn't provide this capability. | |
| @opindex nolibdld | |
| @item -nolibdld | |
| Suppress the generation of link options to search @file{libdld.sl} when the | |
| @option{-static} option is specified on HP-UX 10 and later. | |
| @opindex static | |
| @item -static | |
| The HP-UX C library implementation of @code{setlocale} has a dependency on | |
| @file{libdld.sl}. There isn't an archive version of @file{libdld.sl}. Thus, | |
| when the @option{-static} option is specified, special link options | |
| are needed to resolve this dependency. | |
| On HP-UX 10 and later, the GCC driver adds the necessary options to | |
| link with @file{libdld.sl} when the @option{-static} option is specified. | |
| This causes the resulting binary to be dynamic. On the 64-bit port, | |
| the linkers generate dynamic binaries by default in any case. The | |
| @option{-nolibdld} option can be used to prevent the GCC driver from | |
| adding these link options. | |
| @opindex threads | |
| @item -threads | |
| Add support for multithreading with the @dfn{dce thread} library | |
| under HP-UX@. This option sets flags for both the preprocessor and | |
| linker. | |
| @end table | |
| @node IA-64 Options | |
| @subsection IA-64 Options | |
| @cindex IA-64 Options | |
| These are the @samp{-m} options defined for the Intel IA-64 architecture. | |
| @table @gcctabopt | |
| @opindex mbig-endian | |
| @item -mbig-endian | |
| Generate code for a big-endian target. This is the default for HP-UX@. | |
| @opindex mlittle-endian | |
| @item -mlittle-endian | |
| Generate code for a little-endian target. This is the default for AIX5 | |
| and GNU/Linux. | |
| @opindex mgnu-as | |
| @opindex mno-gnu-as | |
| @item -mgnu-as | |
| @itemx -mno-gnu-as | |
| Generate (or don't) code for the GNU assembler. This is the default. | |
| @opindex mgnu-ld | |
| @opindex mno-gnu-ld | |
| @item -mgnu-ld | |
| @itemx -mno-gnu-ld | |
| Generate (or don't) code for the GNU linker. This is the default. | |
| @opindex mno-pic | |
| @item -mno-pic | |
| Generate code that does not use a global pointer register. The result | |
| is not position independent code, and violates the IA-64 ABI@. | |
| @opindex mvolatile-asm-stop | |
| @opindex mno-volatile-asm-stop | |
| @item -mvolatile-asm-stop | |
| @itemx -mno-volatile-asm-stop | |
| Generate (or don't) a stop bit immediately before and after volatile asm | |
| statements. | |
| @opindex mregister-names | |
| @opindex mno-register-names | |
| @item -mregister-names | |
| @itemx -mno-register-names | |
| Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for | |
| the stacked registers. This may make assembler output more readable. | |
| @opindex mno-sdata | |
| @opindex msdata | |
| @item -mno-sdata | |
| @itemx -msdata | |
| Disable (or enable) optimizations that use the small data section. This may | |
| be useful for working around optimizer bugs. | |
| @opindex mconstant-gp | |
| @item -mconstant-gp | |
| Generate code that uses a single constant global pointer value. This is | |
| useful when compiling kernel code. | |
| @opindex mauto-pic | |
| @item -mauto-pic | |
| Generate code that is self-relocatable. This implies @option{-mconstant-gp}. | |
| This is useful when compiling firmware code. | |
| @opindex minline-float-divide-min-latency | |
| @item -minline-float-divide-min-latency | |
| Generate code for inline divides of floating-point values | |
| using the minimum latency algorithm. | |
| @opindex minline-float-divide-max-throughput | |
| @item -minline-float-divide-max-throughput | |
| Generate code for inline divides of floating-point values | |
| using the maximum throughput algorithm. | |
| @opindex mno-inline-float-divide | |
| @item -mno-inline-float-divide | |
| Do not generate inline code for divides of floating-point values. | |
| @opindex minline-int-divide-min-latency | |
| @item -minline-int-divide-min-latency | |
| Generate code for inline divides of integer values | |
| using the minimum latency algorithm. | |
| @opindex minline-int-divide-max-throughput | |
| @item -minline-int-divide-max-throughput | |
| Generate code for inline divides of integer values | |
| using the maximum throughput algorithm. | |
| @opindex mno-inline-int-divide | |
| @opindex minline-int-divide | |
| @item -mno-inline-int-divide | |
| Do not generate inline code for divides of integer values. | |
| @opindex minline-sqrt-min-latency | |
| @item -minline-sqrt-min-latency | |
| Generate code for inline square roots | |
| using the minimum latency algorithm. | |
| @opindex minline-sqrt-max-throughput | |
| @item -minline-sqrt-max-throughput | |
| Generate code for inline square roots | |
| using the maximum throughput algorithm. | |
| @opindex mno-inline-sqrt | |
| @item -mno-inline-sqrt | |
| Do not generate inline code for @code{sqrt}. | |
| @opindex mno-dwarf2-asm | |
| @opindex mdwarf2-asm | |
| @item -mno-dwarf2-asm | |
| @itemx -mdwarf2-asm | |
| Don't (or do) generate assembler code for the DWARF line number debugging | |
| info. This may be useful when not using the GNU assembler. | |
| @opindex mearly-stop-bits | |
| @opindex mno-early-stop-bits | |
| @item -mearly-stop-bits | |
| @itemx -mno-early-stop-bits | |
| Allow stop bits to be placed earlier than immediately preceding the | |
| instruction that triggered the stop bit. This can improve instruction | |
| scheduling, but does not always do so. | |
| @opindex mfixed-range | |
| @item -mfixed-range=@var{register-range} | |
| Generate code treating the given register range as fixed registers. | |
| A fixed register is one that the register allocator cannot use. This is | |
| useful when compiling kernel code. A register range is specified as | |
| two registers separated by a dash. Multiple register ranges can be | |
| specified separated by a comma. | |
| @opindex mtls-size | |
| @item -mtls-size=@var{tls-size} | |
| Specify bit size of immediate TLS offsets. Valid values are 14, 22, and | |
| 64. | |
| @opindex mtune | |
| @item -mtune=@var{cpu-type} | |
| Tune the instruction scheduling for a particular CPU, Valid values are | |
| @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2}, | |
| and @samp{mckinley}. | |
| @opindex milp32 | |
| @opindex mlp64 | |
| @item -milp32 | |
| @itemx -mlp64 | |
| Generate code for a 32-bit or 64-bit environment. | |
| The 32-bit environment sets int, long and pointer to 32 bits. | |
| The 64-bit environment sets int to 32 bits and long and pointer | |
| to 64 bits. These are HP-UX specific flags. | |
| @opindex mno-sched-br-data-spec | |
| @opindex msched-br-data-spec | |
| @item -mno-sched-br-data-spec | |
| @itemx -msched-br-data-spec | |
| (Dis/En)able data speculative scheduling before reload. | |
| This results in generation of @code{ld.a} instructions and | |
| the corresponding check instructions (@code{ld.c} / @code{chk.a}). | |
| The default setting is disabled. | |
| @opindex msched-ar-data-spec | |
| @opindex mno-sched-ar-data-spec | |
| @item -msched-ar-data-spec | |
| @itemx -mno-sched-ar-data-spec | |
| (En/Dis)able data speculative scheduling after reload. | |
| This results in generation of @code{ld.a} instructions and | |
| the corresponding check instructions (@code{ld.c} / @code{chk.a}). | |
| The default setting is enabled. | |
| @opindex mno-sched-control-spec | |
| @opindex msched-control-spec | |
| @item -mno-sched-control-spec | |
| @itemx -msched-control-spec | |
| (Dis/En)able control speculative scheduling. This feature is | |
| available only during region scheduling (i.e.@: before reload). | |
| This results in generation of the @code{ld.s} instructions and | |
| the corresponding check instructions @code{chk.s}. | |
| The default setting is disabled. | |
| @opindex msched-br-in-data-spec | |
| @opindex mno-sched-br-in-data-spec | |
| @item -msched-br-in-data-spec | |
| @itemx -mno-sched-br-in-data-spec | |
| (En/Dis)able speculative scheduling of the instructions that | |
| are dependent on the data speculative loads before reload. | |
| This is effective only with @option{-msched-br-data-spec} enabled. | |
| The default setting is enabled. | |
| @opindex msched-ar-in-data-spec | |
| @opindex mno-sched-ar-in-data-spec | |
| @item -msched-ar-in-data-spec | |
| @itemx -mno-sched-ar-in-data-spec | |
| (En/Dis)able speculative scheduling of the instructions that | |
| are dependent on the data speculative loads after reload. | |
| This is effective only with @option{-msched-ar-data-spec} enabled. | |
| The default setting is enabled. | |
| @opindex msched-in-control-spec | |
| @opindex mno-sched-in-control-spec | |
| @item -msched-in-control-spec | |
| @itemx -mno-sched-in-control-spec | |
| (En/Dis)able speculative scheduling of the instructions that | |
| are dependent on the control speculative loads. | |
| This is effective only with @option{-msched-control-spec} enabled. | |
| The default setting is enabled. | |
| @opindex mno-sched-count-spec-in-critical-path | |
| @opindex msched-count-spec-in-critical-path | |
| @item -mno-sched-count-spec-in-critical-path | |
| @itemx -msched-count-spec-in-critical-path | |
| If enabled, speculative dependencies are considered during | |
| computation of the instructions priorities. This makes the use of the | |
| speculation a bit more conservative. | |
| The default setting is disabled. | |
| @opindex msched-spec-ldc | |
| @opindex mno-sched-spec-ldc | |
| @item -msched-spec-ldc | |
| @itemx -mno-sched-spec-ldc | |
| Use a simple data speculation check. This option is on by default. | |
| @opindex msched-spec-control-ldc | |
| @opindex mno-sched-spec-control-ldc | |
| @item -msched-control-spec-ldc | |
| @itemx -mno-sched-control-spec-ldc | |
| Use a simple check for control speculation. This option is on by default. | |
| @opindex msched-stop-bits-after-every-cycle | |
| @opindex mno-sched-stop-bits-after-every-cycle | |
| @item -msched-stop-bits-after-every-cycle | |
| @itemx -mno-sched-stop-bits-after-every-cycle | |
| Place a stop bit after every cycle when scheduling. This option is on | |
| by default. | |
| @opindex msched-fp-mem-deps-zero-cost | |
| @opindex mno-sched-fp-mem-deps-zero-cost | |
| @item -msched-fp-mem-deps-zero-cost | |
| @itemx -mno-sched-fp-mem-deps-zero-cost | |
| Assume that floating-point stores and loads are not likely to cause a conflict | |
| when placed into the same instruction group. This option is disabled by | |
| default. | |
| @opindex msel-sched-dont-check-control-spec | |
| @opindex mno-sel-sched-dont-check-control-spec | |
| @item -msel-sched-dont-check-control-spec | |
| @itemx -mno-sel-sched-dont-check-control-spec | |
| Generate checks for control speculation in selective scheduling. | |
| This flag is disabled by default. | |
| @opindex msched-max-memory-insns | |
| @item -msched-max-memory-insns=@var{max-insns} | |
| Limit on the number of memory insns per instruction group, giving lower | |
| priority to subsequent memory insns attempting to schedule in the same | |
| instruction group. Frequently useful to prevent cache bank conflicts. | |
| The default value is 1. | |
| @opindex msched-max-memory-insns-hard-limit | |
| @opindex mno-sched-max-memory-insns-hard-limit | |
| @item -msched-max-memory-insns-hard-limit | |
| @itemx -mno-sched-max-memory-insns-hard-limit | |
| Makes the limit specified by @option{msched-max-memory-insns} a hard limit, | |
| disallowing more than that number in an instruction group. | |
| Otherwise, the limit is ``soft'', meaning that non-memory operations | |
| are preferred when the limit is reached, but memory operations may still | |
| be scheduled. | |
| @end table | |
| @node LM32 Options | |
| @subsection LM32 Options | |
| @cindex LM32 options | |
| These @option{-m} options are defined for the LatticeMico32 architecture: | |
| @table @gcctabopt | |
| @opindex mbarrel-shift-enabled | |
| @opindex mno-barrel-shift-enabled | |
| @item -mbarrel-shift-enabled | |
| Enable barrel-shift instructions. | |
| @opindex mdivide-enabled | |
| @opindex mno-divide-enabled | |
| @item -mdivide-enabled | |
| Enable divide and modulus instructions. | |
| @opindex mmultiply-enabled | |
| @opindex mno-multiply-enabled | |
| @item -mmultiply-enabled | |
| Enable multiply instructions. | |
| @opindex msign-extend-enabled | |
| @opindex mno-sign-extend-enabled | |
| @item -msign-extend-enabled | |
| Enable sign extend instructions. | |
| @opindex muser-enabled | |
| @opindex mno-user-enabled | |
| @item -muser-enabled | |
| Enable user-defined instructions. | |
| @end table | |
| @node LoongArch Options | |
| @subsection LoongArch Options | |
| @cindex LoongArch Options | |
| These command-line options are defined for LoongArch targets: | |
| @table @gcctabopt | |
| @opindex march | |
| @item -march=@var{arch-type} | |
| Generate instructions for the machine type @var{arch-type}. | |
| @option{-march=@var{arch-type}} allows GCC to generate code that | |
| may not run at all on processors other than the one indicated. | |
| The choices for @var{arch-type} are: | |
| @table @samp | |
| @item native | |
| Local processor type detected by the native compiler. | |
| @item loongarch64 | |
| Generic LoongArch 64-bit processor. | |
| @item la464 | |
| LoongArch LA464-based processor with LSX, LASX. | |
| @item la664 | |
| LoongArch LA664-based processor with LSX, LASX | |
| and all LoongArch v1.1 instructions. | |
| @item la64v1.0 | |
| LoongArch64 ISA version 1.0. | |
| @item la64v1.1 | |
| LoongArch64 ISA version 1.1. | |
| @item la32v1.0 | |
| LoongArch32 ISA version 1.0. | |
| @item la32rv1.0 | |
| LoongArch32 Reduced ISA version 1.0. | |
| @end table | |
| More information about LoongArch ISA versions can be found at | |
| @uref{https://github.com/loongson/la-toolchain-conventions}. | |
| @opindex mtune | |
| @item -mtune=@var{tune-type} | |
| Optimize the generated code for the given processor target. | |
| The choices for @var{tune-type} are: | |
| @table @samp | |
| @item native | |
| Local processor type detected by the native compiler. | |
| @item generic | |
| Generic LoongArch processor. | |
| @item loongarch64 | |
| Generic LoongArch 64-bit processor. | |
| @item la464 | |
| LoongArch LA464 core. | |
| @item la664 | |
| LoongArch LA664 core. | |
| @item loongarch32 | |
| Generic LoongArch 32-bit processor. | |
| @end table | |
| @opindex mabi | |
| @item -mabi=@var{base-abi-type} | |
| Generate code for the specified calling convention. | |
| @var{base-abi-type} can be one of: | |
| @table @samp | |
| @item lp64d | |
| Uses 64-bit general purpose registers and 32/64-bit floating-point | |
| registers for parameter passing. Data model is LP64, where @samp{int} | |
| is 32 bits, while @samp{long int} and pointers are 64 bits. | |
| @item lp64f | |
| Uses 64-bit general purpose registers and 32-bit floating-point | |
| registers for parameter passing. Data model is LP64, where @samp{int} | |
| is 32 bits, while @samp{long int} and pointers are 64 bits. | |
| @item lp64s | |
| Uses 64-bit general purpose registers and no floating-point | |
| registers for parameter passing. Data model is LP64, where @samp{int} | |
| is 32 bits, while @samp{long int} and pointers are 64 bits. | |
| @end table | |
| @opindex mfpu | |
| @item -mfpu=@var{fpu-type} | |
| Generate code for the specified FPU type, which can be one of: | |
| @table @samp | |
| @item 64 | |
| Allow the use of hardware floating-point instructions for 32-bit | |
| and 64-bit operations. | |
| @item 32 | |
| Allow the use of hardware floating-point instructions for 32-bit | |
| operations. | |
| @item none | |
| @item 0 | |
| Prevent the use of hardware floating-point instructions. | |
| @end table | |
| @opindex msimd | |
| @item -msimd=@var{simd-type} | |
| Enable generation of LoongArch SIMD instructions for vectorization | |
| and via builtin functions. The value can be one of: | |
| @table @samp | |
| @item lasx | |
| Enable generating instructions from the 256-bit LoongArch Advanced | |
| SIMD Extension (LASX) and the 128-bit LoongArch SIMD Extension (LSX). | |
| @item lsx | |
| Enable generating instructions from the 128-bit LoongArch SIMD | |
| Extension (LSX). | |
| @item none | |
| No LoongArch SIMD instruction may be generated. | |
| @end table | |
| @opindex msoft-float | |
| @item -msoft-float | |
| Force @option{-mfpu=none} and prevent the use of floating-point | |
| registers for parameter passing. This option may change the target | |
| ABI. | |
| @opindex msingle-float | |
| @item -msingle-float | |
| Force @option{-mfpu=32} and allow the use of 32-bit floating-point | |
| registers for parameter passing. This option may change the target | |
| ABI. | |
| @opindex mdouble-float | |
| @item -mdouble-float | |
| Force @option{-mfpu=64} and allow the use of 32/64-bit floating-point | |
| registers for parameter passing. This option may change the target | |
| ABI. | |
| @opindex mlasx | |
| @opindex mno-lasx | |
| @opindex mlsx | |
| @opindex mno-lsx | |
| @item -mlasx | |
| @itemx -mno-lasx | |
| @item -mlsx | |
| @itemx -mno-lsx | |
| Incrementally adjust the scope of the SIMD extensions (none / LSX / LASX) | |
| that can be used by the compiler for code generation. Enabling LASX with | |
| @option{-mlasx} automatically enables LSX, | |
| and disabling LSX with @option{-mno-lsx} | |
| automatically disables LASX. These driver-only options act upon the final | |
| @option{-msimd} configuration state and make incremental changes in the order | |
| they appear on the GCC driver's command line, deriving the final / canonicalized | |
| @option{-msimd} option that is passed to the compiler proper. | |
| @opindex mbranch-cost | |
| @item -mbranch-cost=@var{n} | |
| Set the cost of branches to roughly @var{n} instructions. | |
| @opindex maddr-reg-reg-cost | |
| @item -maddr-reg-reg-cost=@var{n} | |
| Set the cost of ADDRESS_REG_REG to the value calculated by @var{n}. | |
| @opindex mcheck-zero-division | |
| @opindex mno-check-zero-division | |
| @item -mcheck-zero-division | |
| @itemx -mno-check-zero-division | |
| Trap (do not trap) on integer division by zero. The default is | |
| @option{-mcheck-zero-division} for @option{-O0} or @option{-Og}, and | |
| @option{-mno-check-zero-division} for other optimization levels. | |
| @opindex mbreak-code | |
| @item -mbreak-code=@var{code} | |
| Emit a @code{break} @var{code} instruction for irrecoverable traps | |
| from @code{__builtin_trap} or inserted by the compiler (for example | |
| an erroneous path isolated with | |
| @option{-fisolate-erroneous-paths-dereference}), or an | |
| @code{amswap.w $r0, $r1, $r0} instruction which will cause the hardware | |
| to trigger an Instruction Not-defined Exception if @var{code} is negative | |
| or greater than 32767. The default is -1, meaning to use the | |
| @code{amswap.w} instruction. | |
| @opindex mcond-move-int | |
| @opindex mno-cond-move-int | |
| @item -mcond-move-int | |
| @itemx -mno-cond-move-int | |
| Conditional moves for integral data in general-purpose registers | |
| are enabled (disabled). The default is @option{-mcond-move-int}. | |
| @opindex mcond-move-float | |
| @opindex mno-cond-move-float | |
| @item -mcond-move-float | |
| @itemx -mno-cond-move-float | |
| Conditional moves for floating-point registers are enabled (disabled). | |
| The default is @option{-mcond-move-float}. | |
| @opindex mmemcpy | |
| @opindex mno-memcpy | |
| @item -mmemcpy | |
| @itemx -mno-memcpy | |
| Force (do not force) the use of @code{memcpy} for non-trivial block moves. | |
| The default is @option{-mno-memcpy}, which allows GCC to inline most | |
| constant-sized copies. Setting optimization level to @option{-Os} also | |
| forces the use of @code{memcpy}, but @option{-mno-memcpy} may override this | |
| behavior if explicitly specified, regardless of the order these options on | |
| the command line. | |
| @opindex mstrict-align | |
| @opindex mno-strict-align | |
| @item -mstrict-align | |
| @itemx -mno-strict-align | |
| Avoid or allow generating memory accesses that may not be aligned on a natural | |
| object boundary as described in the architecture specification. The default is | |
| @option{-mno-strict-align}. | |
| @opindex G | |
| @item -G @var{num} | |
| Put global and static data smaller than @var{num} bytes into a small data | |
| section. The default value is 0. | |
| @opindex mmax-inline-memcpy-size | |
| @item -mmax-inline-memcpy-size=@var{n} | |
| Inline all block moves (such as calls to @code{memcpy} or structure copies) | |
| less than or equal to @var{n} bytes. The default value of @var{n} is 1024. | |
| @opindex mcmodel= | |
| @item -mcmodel=@var{code-model} | |
| Set the code model to one of: | |
| @table @samp | |
| @item tiny-static (Not implemented yet) | |
| @item tiny (Not implemented yet) | |
| @item normal | |
| The text segment must be within 128MB addressing space. The data segment must | |
| be within 2GB addressing space. | |
| @item medium | |
| The text segment and data segment must be within 2GB addressing space. | |
| This is the default code model unless GCC has been configured with | |
| @option{--with-cmodel=} specifying a different default code model. | |
| @item large (Not implemented yet) | |
| @item extreme | |
| This mode does not limit the size of the code segment and data segment. | |
| The @option{-mcmodel=extreme} option is incompatible with @option{-fplt} | |
| and/or @option{-mexplicit-relocs=none}. | |
| @end table | |
| @opindex mexplicit-relocs | |
| @opindex mno-explicit-relocs | |
| @item -mexplicit-relocs=@var{style} | |
| @itemx -mexplicit-relocs | |
| @itemx -mno-explicit-relocs | |
| Set when to use assembler relocation operators when dealing with symbolic | |
| addresses. The alternative is to use assembler macros instead, which may | |
| limit instruction scheduling but allow linker relaxation. | |
| With @option{-mexplicit-relocs=none}, the assembler macros are always used; | |
| with @option{-mexplicit-relocs=always}, the assembler relocation operators | |
| are always used; and with @option{-mexplicit-relocs=auto} the compiler uses | |
| the relocation operators where linker relaxation is impossible to | |
| improve the code quality, and macros elsewhere. | |
| The default | |
| value for the option is determined with the assembler capability detected | |
| during GCC build-time and the setting of @option{-mrelax}: | |
| @option{-mexplicit-relocs=none} if the assembler does not support | |
| relocation operators at all, | |
| @option{-mexplicit-relocs=always} if the assembler supports relocation | |
| operators but @option{-mrelax} is not enabled, | |
| @option{-mexplicit-relocs=auto} if the assembler supports relocation | |
| operators and @option{-mrelax} is enabled. | |
| For backward compatibility, @option{-mexplicit-relocs} is equivalent to | |
| @option{-mexplicit-relocs=always}, while @option{-mno-explicit-relocs} is | |
| equivalent to @option{-mexplicit-relocs=none}. | |
| @opindex mdirect-extern-access | |
| @item -mdirect-extern-access | |
| @itemx -mno-direct-extern-access | |
| Control use of the GOT to access external symbols. The default is | |
| @option{-mno-direct-extern-access}: the GOT is used for external symbols with | |
| default visibility, but not used for other external symbols. | |
| With @option{-mdirect-extern-access}, the GOT is not used and all external | |
| symbols are PC-relatively addressed. It is @strong{only} suitable for | |
| environments where no dynamic link is performed, like firmwares, OS | |
| kernels, executables linked with @option{-static} or @option{-static-pie}. | |
| @option{-mdirect-extern-access} is not compatible with @option{-fPIC} or | |
| @option{-fpic}. | |
| @opindex mrelax | |
| @opindex mno-relax | |
| @item -mrelax | |
| @itemx -mno-relax | |
| Take (do not take) advantage of linker relaxations. If | |
| @option{-mpass-mrelax-to-as} is enabled, this option is also passed to | |
| the assembler. The default is determined during GCC build-time by | |
| detecting corresponding assembler support: | |
| @option{-mrelax} if the assembler supports both the @option{-mrelax} | |
| option and the conditional branch relaxation (it's required or the | |
| @code{.align} directives and conditional branch instructions in the | |
| assembly code outputted by GCC may be rejected by the assembler because | |
| of a relocation overflow), @option{-mno-relax} otherwise. | |
| @opindex mpass-mrelax-to-as | |
| @opindex mno-pass-mrelax-to-as | |
| @item -mpass-mrelax-to-as | |
| @itemx -mno-pass-mrelax-to-as | |
| Pass (do not pass) the @option{-mrelax} or @option{-mno-relax} option | |
| to the assembler. The default is determined during GCC build-time by | |
| detecting corresponding assembler support: | |
| @option{-mpass-mrelax-to-as} if the assembler supports the | |
| @option{-mrelax} option, @option{-mno-pass-mrelax-to-as} otherwise. | |
| This option is mostly useful for debugging, or interoperation with | |
| assemblers different from the build-time one. | |
| @opindex mrecip | |
| @item -mrecip | |
| This option enables use of the reciprocal estimate and reciprocal square | |
| root estimate instructions with additional Newton-Raphson steps to increase | |
| precision instead of doing a divide or square root and divide for | |
| floating-point arguments. | |
| These instructions are generated only when @option{-funsafe-math-optimizations} | |
| is enabled together with @option{-ffinite-math-only} and | |
| @option{-fno-trapping-math}. | |
| This option is off by default. Before you can use this option, you must sure the | |
| target CPU supports the @code{frecipe} and @code{frsqrte} instructions. | |
| Note that while the throughput of the sequence is higher than the throughput of | |
| the non-reciprocal instruction, the precision of the sequence can be decreased | |
| by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994). | |
| @opindex mrecip=opt | |
| @item -mrecip=@var{opt} | |
| This option controls which reciprocal estimate instructions | |
| may be used. @var{opt} is a comma-separated list of options, which may | |
| be preceded by a @samp{!} to invert the option: | |
| @table @samp | |
| @item all | |
| Enable all estimate instructions. | |
| @item default | |
| Enable the default instructions, equivalent to @option{-mrecip}. | |
| @item none | |
| Disable all estimate instructions, equivalent to @option{-mno-recip}. | |
| @item div | |
| Enable the approximation for scalar division. | |
| @item vec-div | |
| Enable the approximation for vectorized division. | |
| @item sqrt | |
| Enable the approximation for scalar square root. | |
| @item vec-sqrt | |
| Enable the approximation for vectorized square root. | |
| @item rsqrt | |
| Enable the approximation for scalar reciprocal square root. | |
| @item vec-rsqrt | |
| Enable the approximation for vectorized reciprocal square root. | |
| @end table | |
| So, for example, @option{-mrecip=all,!sqrt} enables | |
| all of the reciprocal approximations, except for scalar square root. | |
| @opindex mfrecipe | |
| @opindex mno-frecipe | |
| @item -mfrecipe | |
| @itemx -mno-frecipe | |
| Use (do not use) @code{frecipe.@{s/d@}} and @code{frsqrte.@{s/d@}} | |
| instructions. When compiling with @option{-march=la664}, | |
| it is enabled by default. Otherwise the default is @option{-mno-frecipe}. | |
| @opindex mdiv32 | |
| @opindex mno-div32 | |
| @item -mdiv32 | |
| @itemx -mno-div32 | |
| Use (do not use) @code{div.w[u]} and @code{mod.w[u]} instructions with input | |
| not sign-extended. When compiling with @option{-march=la664}, it is enabled by | |
| default. Otherwise the default is @option{-mno-div32}. | |
| @opindex mlam-bh | |
| @opindex mno-lam-bh | |
| @item -mlam-bh | |
| @itemx -mno-lam-bh | |
| Use (do not use) @code{am@{swap/add@}[_db].@{b/h@}} instructions. | |
| When compiling | |
| with @option{-march=la664}, it is enabled by default. Otherwise | |
| the default is @option{-mno-lam-bh}. | |
| @opindex mlamcas | |
| @opindex mno-lamcas | |
| @item -mlamcas | |
| @itemx -mno-lamcas | |
| Use (do not use) @code{amcas[_db].@{b/h/w/d@}} instructions. | |
| When compiling with | |
| @option{-march=la664}, it is enabled by default. Otherwise the default is | |
| @option{-mno-lamcas}. | |
| @opindex mld-seq-sa | |
| @opindex mno-ld-seq-sa | |
| @item -mld-seq-sa | |
| @itemx -mno-ld-seq-sa | |
| Whether a same-address load-load barrier (@code{dbar 0x700}) is needed. When | |
| compiling with @option{-march=la664}, it is enabled by default. | |
| Otherwise the default is | |
| @option{-mno-ld-seq-sa}, the load-load barrier is needed. | |
| @opindex mscq | |
| @opindex mno-scq | |
| @item -mscq | |
| @item -mno-scq | |
| Use (do not use) the 16-byte conditional store instruction @code{sc.q}. | |
| The default is @option{-mscq} if the machine type specified with | |
| @option{-march=} supports this instruction, @option{-mno-scq} otherwise. | |
| @opindex mtls-dialect | |
| @item -mtls-dialect=@var{opt} | |
| This option controls which TLS dialect may be used for general dynamic and | |
| local dynamic TLS models. The @var{opt} argument can be one of: | |
| @table @samp | |
| @item trad | |
| Use traditional TLS. This is the default. | |
| @item desc | |
| Use TLS descriptors. | |
| @end table | |
| @opindex mannotate-tablejump | |
| @opindex mno-annotate-tablejump | |
| @item -mannotate-tablejump | |
| @itemx -mno-annotate-tablejump | |
| Create an annotation section @code{.discard.tablejump_annotate} to | |
| correlate the @code{jirl} instruction and the jump table when a jump | |
| table is used to optimize the @code{switch} statement. Some external | |
| tools, for example @file{objtool} of the Linux kernel building system, | |
| need the annotation to analyze the control flow. The default is | |
| @option{-mno-annotate-tablejump}. | |
| @end table | |
| @node LynxOS Options | |
| @subsection LynxOS Options | |
| @cindex LynxOS Options | |
| These options are available for LynxOS targets. | |
| @table @gcctabopt | |
| @opindex mshared | |
| @item -mshared | |
| Use shared libraries. The default is to link with static libraries. | |
| @opindex mthreads | |
| @item -mthreads | |
| Support multi-threading. | |
| @opindex mlegacy-threads | |
| @item -mlegacy-threads | |
| Support legacy multi-threading. | |
| This option is incompatible with @option{-mthreads}. | |
| @end table | |
| @node M32R/D Options | |
| @subsection M32R/D Options | |
| @cindex M32R/D options | |
| These @option{-m} options are defined for Renesas M32R/D architectures: | |
| @table @gcctabopt | |
| @opindex m32r2 | |
| @item -m32r2 | |
| Generate code for the M32R/2@. | |
| @opindex m32rx | |
| @item -m32rx | |
| Generate code for the M32R/X@. | |
| @opindex m32r | |
| @item -m32r | |
| Generate code for the M32R@. This is the default. | |
| @opindex mmodel | |
| @opindex mmodel=small | |
| @item -mmodel=small | |
| Assume all objects live in the lower 16MB of memory (so that their addresses | |
| can be loaded with the @code{ld24} instruction), and assume all subroutines | |
| are reachable with the @code{bl} instruction. | |
| This is the default. | |
| The addressability of a particular object can be set with the | |
| @code{model} attribute. | |
| @opindex mmodel=medium | |
| @item -mmodel=medium | |
| Assume objects may be anywhere in the 32-bit address space (the compiler | |
| generates @code{seth/add3} instructions to load their addresses), and | |
| assume all subroutines are reachable with the @code{bl} instruction. | |
| @opindex mmodel=large | |
| @item -mmodel=large | |
| Assume objects may be anywhere in the 32-bit address space (the compiler | |
| generates @code{seth/add3} instructions to load their addresses), and | |
| assume subroutines may not be reachable with the @code{bl} instruction | |
| (the compiler generates the much slower @code{seth/add3/jl} | |
| instruction sequence). | |
| @opindex msdata | |
| @opindex msdata=none | |
| @item -msdata=none | |
| Disable use of the small data area. Variables are put into | |
| one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the | |
| @code{section} attribute has been specified). | |
| This is the default. | |
| The small data area consists of sections @code{.sdata} and @code{.sbss}. | |
| Objects may be explicitly put in the small data area with the | |
| @code{section} attribute using one of these sections. | |
| @opindex msdata=sdata | |
| @item -msdata=sdata | |
| Put small global and static data in the small data area, but do not | |
| generate special code to reference them. | |
| @opindex msdata=use | |
| @item -msdata=use | |
| Put small global and static data in the small data area, and generate | |
| special instructions to reference them. | |
| @opindex G | |
| @cindex smaller data references | |
| @item -G @var{num} | |
| Put global and static objects less than or equal to @var{num} bytes | |
| into the small data or BSS sections instead of the normal data or BSS | |
| sections. The default value of @var{num} is 8. | |
| The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use} | |
| for this option to have any effect. | |
| All modules should be compiled with the same @option{-G @var{num}} value. | |
| Compiling with different values of @var{num} may or may not work; if it | |
| doesn't the linker gives an error message---incorrect code is not | |
| generated. | |
| @opindex mdebug | |
| @item -mdebug | |
| Makes the M32R-specific code in the compiler display some statistics | |
| that might help in debugging programs. | |
| @opindex malign-loops | |
| @opindex mno-align-loops | |
| @item -malign-loops | |
| @itemx -mno-align-loops | |
| Align all loops to a 32-byte boundary. This option is disabled by default. | |
| @opindex missue-rate | |
| @item -missue-rate=@var{number} | |
| Issue @var{number} instructions per cycle. @var{number} can only be 1 | |
| or 2. | |
| @opindex mbranch-cost | |
| @item -mbranch-cost=@var{number} | |
| @var{number} can only be 1 or 2. If it is 1 then branches are | |
| preferred over conditional code, if it is 2, then the opposite applies. | |
| @opindex mflush-trap | |
| @item -mflush-trap=@var{number} | |
| Specifies the trap number to use to flush the cache. The default is | |
| 12. Valid numbers are between 0 and 15 inclusive. | |
| @opindex mno-flush-trap | |
| @item -mno-flush-trap | |
| Specifies that the cache cannot be flushed by using a trap. | |
| @opindex mflush-func | |
| @item -mflush-func=@var{name} | |
| Specifies the name of the operating system function to call to flush | |
| the cache. The default is @samp{_flush_cache}, but a function call | |
| is only used if a trap is not available. | |
| @opindex mno-flush-func | |
| @item -mno-flush-func | |
| Indicates that there is no OS function for flushing the cache. | |
| @end table | |
| @node M680x0 Options | |
| @subsection M680x0 Options | |
| @cindex M680x0 options | |
| These are the @samp{-m} options defined for M680x0 and ColdFire processors. | |
| The default settings depend on which architecture was selected when | |
| the compiler was configured; the defaults for the most common choices | |
| are given below. | |
| @table @gcctabopt | |
| @opindex march | |
| @item -march=@var{arch} | |
| Generate code for a specific M680x0 or ColdFire instruction set | |
| architecture. Permissible values of @var{arch} for M680x0 | |
| architectures are: @samp{68000}, @samp{68010}, @samp{68020}, | |
| @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}. ColdFire | |
| architectures are selected according to Freescale's ISA classification | |
| and the permissible values are: @samp{isaa}, @samp{isaaplus}, | |
| @samp{isab} and @samp{isac}. | |
| GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating | |
| code for a ColdFire target. The @var{arch} in this macro is one of the | |
| @option{-march} arguments given above. | |
| When used together, @option{-march} and @option{-mtune} select code | |
| that runs on a family of similar processors but that is optimized | |
| for a particular microarchitecture. | |
| @opindex mcpu | |
| @item -mcpu=@var{cpu} | |
| Generate code for a specific M680x0 or ColdFire processor. | |
| The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020}, | |
| @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332} | |
| and @samp{cpu32}. The ColdFire @var{cpu}s are given by the table | |
| below, which also classifies the CPUs into families: | |
| @multitable @columnfractions 0.20 0.80 | |
| @headitem @strong{Family} @tab @strong{@samp{-mcpu} arguments} | |
| @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51ag} @samp{51cn} @samp{51em} @samp{51je} @samp{51jf} @samp{51jg} @samp{51jm} @samp{51mm} @samp{51qe} @samp{51qm} | |
| @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206} | |
| @item @samp{5206e} @tab @samp{5206e} | |
| @item @samp{5208} @tab @samp{5207} @samp{5208} | |
| @item @samp{5211a} @tab @samp{5210a} @samp{5211a} | |
| @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213} | |
| @item @samp{5216} @tab @samp{5214} @samp{5216} | |
| @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235} | |
| @item @samp{5225} @tab @samp{5224} @samp{5225} | |
| @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259} | |
| @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x} | |
| @item @samp{5249} @tab @samp{5249} | |
| @item @samp{5250} @tab @samp{5250} | |
| @item @samp{5271} @tab @samp{5270} @samp{5271} | |
| @item @samp{5272} @tab @samp{5272} | |
| @item @samp{5275} @tab @samp{5274} @samp{5275} | |
| @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x} | |
| @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017} | |
| @item @samp{5307} @tab @samp{5307} | |
| @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x} | |
| @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x} | |
| @item @samp{5407} @tab @samp{5407} | |
| @item @samp{5475} @tab @samp{5470} @samp{5471} @samp{5472} @samp{5473} @samp{5474} @samp{5475} @samp{547x} @samp{5480} @samp{5481} @samp{5482} @samp{5483} @samp{5484} @samp{5485} | |
| @end multitable | |
| @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if | |
| @var{arch} is compatible with @var{cpu}. Other combinations of | |
| @option{-mcpu} and @option{-march} are rejected. | |
| GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target | |
| @var{cpu} is selected. It also defines @code{__mcf_family_@var{family}}, | |
| where the value of @var{family} is given by the table above. | |
| @opindex mtune | |
| @item -mtune=@var{tune} | |
| Tune the code for a particular microarchitecture within the | |
| constraints set by @option{-march} and @option{-mcpu}. | |
| The M680x0 microarchitectures are: @samp{68000}, @samp{68010}, | |
| @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060} | |
| and @samp{cpu32}. The ColdFire microarchitectures | |
| are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}. | |
| You can also use @option{-mtune=68020-40} for code that needs | |
| to run relatively well on 68020, 68030 and 68040 targets. | |
| @option{-mtune=68020-60} is similar but includes 68060 targets | |
| as well. These two options select the same tuning decisions as | |
| @option{-m68020-40} and @option{-m68020-60} respectively. | |
| GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__} | |
| when tuning for 680x0 architecture @var{arch}. It also defines | |
| @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std} | |
| option is used. If GCC is tuning for a range of architectures, | |
| as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60}, | |
| it defines the macros for every architecture in the range. | |
| GCC also defines the macro @code{__m@var{uarch}__} when tuning for | |
| ColdFire microarchitecture @var{uarch}, where @var{uarch} is one | |
| of the arguments given above. | |
| @opindex m68000 | |
| @opindex mc68000 | |
| @item -m68000 | |
| @itemx -mc68000 | |
| Generate output for a 68000. This is the default | |
| when the compiler is configured for 68000-based systems. | |
| It is equivalent to @option{-march=68000}. | |
| Use this option for microcontrollers with a 68000 or EC000 core, | |
| including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356. | |
| @opindex m68010 | |
| @item -m68010 | |
| Generate output for a 68010. This is the default | |
| when the compiler is configured for 68010-based systems. | |
| It is equivalent to @option{-march=68010}. | |
| @opindex m68020 | |
| @opindex mc68020 | |
| @item -m68020 | |
| @itemx -mc68020 | |
| Generate output for a 68020. This is the default | |
| when the compiler is configured for 68020-based systems. | |
| It is equivalent to @option{-march=68020}. | |
| @opindex m68030 | |
| @item -m68030 | |
| Generate output for a 68030. This is the default when the compiler is | |
| configured for 68030-based systems. It is equivalent to | |
| @option{-march=68030}. | |
| @opindex m68040 | |
| @item -m68040 | |
| Generate output for a 68040. This is the default when the compiler is | |
| configured for 68040-based systems. It is equivalent to | |
| @option{-march=68040}. | |
| This option inhibits the use of 68881/68882 instructions that have to be | |
| emulated by software on the 68040. Use this option if your 68040 does not | |
| have code to emulate those instructions. | |
| @opindex m68060 | |
| @item -m68060 | |
| Generate output for a 68060. This is the default when the compiler is | |
| configured for 68060-based systems. It is equivalent to | |
| @option{-march=68060}. | |
| This option inhibits the use of 68020 and 68881/68882 instructions that | |
| have to be emulated by software on the 68060. Use this option if your 68060 | |
| does not have code to emulate those instructions. | |
| @opindex m68302 | |
| @item -m68302 | |
| Generate code for a 68302. | |
| @opindex m68332 | |
| @item -m68332 | |
| Generate code for a 68332. | |
| @opindex m68851 | |
| @item -m68851 | |
| The 68851 was an external MMU for the 68020 processor. | |
| GCC accepts this option, but does not use it. | |
| @opindex mcpu32 | |
| @item -mcpu32 | |
| Generate output for a CPU32. This is the default | |
| when the compiler is configured for CPU32-based systems. | |
| It is equivalent to @option{-march=cpu32}. | |
| Use this option for microcontrollers with a | |
| CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334, | |
| 68336, 68340, 68341, 68349 and 68360. | |
| @opindex mfidoa | |
| @item -mfidoa | |
| Generate code for a Fido A. | |
| @opindex m5200 | |
| @item -m5200 | |
| Generate output for a 520X ColdFire CPU@. This is the default | |
| when the compiler is configured for 520X-based systems. | |
| It is equivalent to @option{-mcpu=5206}, and is now deprecated | |
| in favor of that option. | |
| Use this option for microcontroller with a 5200 core, including | |
| the MCF5202, MCF5203, MCF5204 and MCF5206. | |
| @opindex m5206e | |
| @item -m5206e | |
| Generate output for a 5206e ColdFire CPU@. The option is now | |
| deprecated in favor of the equivalent @option{-mcpu=5206e}. | |
| @opindex m528x | |
| @item -m528x | |
| Generate output for a member of the ColdFire 528X family. | |
| The option is now deprecated in favor of the equivalent | |
| @option{-mcpu=528x}. | |
| @opindex m5307 | |
| @item -m5307 | |
| Generate output for a ColdFire 5307 CPU@. The option is now deprecated | |
| in favor of the equivalent @option{-mcpu=5307}. | |
| @opindex m5407 | |
| @item -m5407 | |
| Generate output for a ColdFire 5407 CPU@. The option is now deprecated | |
| in favor of the equivalent @option{-mcpu=5407}. | |
| @opindex mcfv4e | |
| @item -mcfv4e | |
| Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x). | |
| This includes use of hardware floating-point instructions. | |
| The option is equivalent to @option{-mcpu=547x}, and is now | |
| deprecated in favor of that option. | |
| @opindex m68020-40 | |
| @item -m68020-40 | |
| Generate output for a 68040, without using any of the new instructions. | |
| This results in code that can run relatively efficiently on either a | |
| 68020/68881 or a 68030 or a 68040. The generated code does use the | |
| 68881 instructions that are emulated on the 68040. | |
| The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}. | |
| @opindex m68020-60 | |
| @item -m68020-60 | |
| Generate output for a 68060, without using any of the new instructions. | |
| This results in code that can run relatively efficiently on either a | |
| 68020/68881 or a 68030 or a 68040. The generated code does use the | |
| 68881 instructions that are emulated on the 68060. | |
| The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}. | |
| @opindex mhard-float | |
| @opindex m68881 | |
| @item -mhard-float | |
| @itemx -m68881 | |
| Generate floating-point instructions. This is the default for 68020 | |
| and above, and for ColdFire devices that have an FPU@. It defines the | |
| macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__} | |
| on ColdFire targets. | |
| @opindex msoft-float | |
| @item -msoft-float | |
| Do not generate floating-point instructions; use library calls instead. | |
| This is the default for 68000, 68010, and 68832 targets. It is also | |
| the default for ColdFire devices that have no FPU. | |
| @opindex mdiv | |
| @opindex mno-div | |
| @item -mdiv | |
| @itemx -mno-div | |
| Generate (do not generate) ColdFire hardware divide and remainder | |
| instructions. If @option{-march} is used without @option{-mcpu}, | |
| the default is ``on'' for ColdFire architectures and ``off'' for M680x0 | |
| architectures. Otherwise, the default is taken from the target CPU | |
| (either the default CPU, or the one specified by @option{-mcpu}). For | |
| example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for | |
| @option{-mcpu=5206e}. | |
| GCC defines the macro @code{__mcfhwdiv__} when this option is enabled. | |
| @opindex mshort | |
| @opindex mno-short | |
| @opindex mnoshort | |
| @item -mshort | |
| @itemx -mno-short | |
| @itemx -mnoshort | |
| Consider type @code{int} to be 16 bits wide, like @code{short int}. | |
| Additionally, parameters passed on the stack are also aligned to a | |
| 16-bit boundary even on targets whose API mandates promotion to 32-bit. | |
| This option is disabled by default. | |
| @opindex mbitfield | |
| @opindex mno-bitfield | |
| @opindex mnobitfield | |
| @item -mbitfield | |
| @itemx -mno-bitfield | |
| @itemx -mnobitfield | |
| Control use of the bit-field instructions. | |
| The @option{-m68000}, @option{-mcpu32} | |
| and @option{-m5200} options imply @w{@option{-mnobitfield}}; | |
| the @option{-m68020} option implies @option{-mbitfield}. | |
| @opindex mrtd | |
| @opindex mno-rtd | |
| @opindex mnortd | |
| @item -mrtd | |
| @itemx -mno-rtd | |
| @itemx -mnortd | |
| Control use of a different function-calling convention, in which functions | |
| that take a fixed number of arguments return with the @code{rtd} | |
| instruction, which pops their arguments while returning. This | |
| saves one instruction in the caller since there is no need to pop | |
| the arguments there. | |
| This calling convention is incompatible with the one normally | |
| used on Unix, so you cannot use it if you need to call libraries | |
| compiled with the Unix compiler. | |
| Also, you must provide function prototypes for all functions that | |
| take variable numbers of arguments (including @code{printf}); | |
| otherwise incorrect code is generated for calls to those | |
| functions. | |
| In addition, seriously incorrect code results if you call a | |
| function with too many arguments. (Normally, extra arguments are | |
| harmlessly ignored.) | |
| The @code{rtd} instruction is supported by the 68010, 68020, 68030, | |
| 68040, 68060 and CPU32 processors, but not by the 68000 or 5200. | |
| The default is @option{-mno-rtd}. | |
| @opindex malign-int | |
| @opindex mno-align-int | |
| @item -malign-int | |
| @itemx -mno-align-int | |
| Control whether GCC aligns @code{int}, @code{long}, @code{long long}, | |
| @code{float}, @code{double}, and @code{long double} variables on a 32-bit | |
| boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}). | |
| Aligning variables on 32-bit boundaries produces code that runs somewhat | |
| faster on processors with 32-bit busses at the expense of more memory. | |
| @strong{Warning:} if you use the @option{-malign-int} switch, GCC | |
| aligns structures containing the above types differently than | |
| most published application binary interface specifications for the m68k. | |
| @opindex mpcrel | |
| Use the pc-relative addressing mode of the 68000 directly, instead of | |
| using a global offset table. At present, this option implies @option{-fpic}, | |
| allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is | |
| not presently supported with @option{-mpcrel}, though this could be supported for | |
| 68020 and higher processors. | |
| @opindex mno-strict-align | |
| @opindex mstrict-align | |
| @item -mno-strict-align | |
| @itemx -mstrict-align | |
| Do not (do) assume that unaligned memory references are handled by | |
| the system. | |
| @opindex msep-data | |
| @opindex mno-sep-data | |
| @item -msep-data | |
| @itemx -mno-sep-data | |
| With @option{-msep-data}, | |
| generate code that allows the data segment to be located in a different | |
| area of memory from the text segment. This allows for execute-in-place in | |
| an environment without virtual memory management. This option implies | |
| @option{-fPIC}. | |
| This option is disabled by default; GCC | |
| generates code that assumes that the data segment follows the text segment. | |
| @opindex mid-shared-library | |
| @opindex mno-id-shared-library | |
| @item -mid-shared-library | |
| @itemx -mno-id-shared-library | |
| If enabled, generate code that supports shared libraries via the | |
| library ID method. | |
| This allows for execute-in-place and shared libraries in an environment | |
| without virtual memory management. This option implies @option{-fPIC}. | |
| This option is disabled by default. | |
| @opindex mshared-library-id | |
| @item -mshared-library-id=@var{n} | |
| Specifies the identification number of the ID-based shared library being | |
| compiled. Specifying a value of 0 generates more compact code; specifying | |
| other values forces the allocation of that number to the current | |
| library, but is no more space- or time-efficient than omitting this option. | |
| @opindex mxgot | |
| @opindex mno-xgot | |
| @item -mxgot | |
| @itemx -mno-xgot | |
| When generating position-independent code for ColdFire, generate code | |
| that works if the GOT has more than 8192 entries. This code is | |
| larger and slower than code generated without this option. On M680x0 | |
| processors, this option is not needed; @option{-fPIC} suffices. | |
| GCC normally uses a single instruction to load values from the GOT@. | |
| While this is relatively efficient, it only works if the GOT | |
| is smaller than about 64k. Anything larger causes the linker | |
| to report an error such as: | |
| @cindex relocation truncated to fit (ColdFire) | |
| @smallexample | |
| relocation truncated to fit: R_68K_GOT16O foobar | |
| @end smallexample | |
| If this happens, you should recompile your code with @option{-mxgot}. | |
| It should then work with very large GOTs. However, code generated with | |
| @option{-mxgot} is less efficient, since it takes 4 instructions to fetch | |
| the value of a global symbol. | |
| Note that some linkers, including newer versions of the GNU linker, | |
| can create multiple GOTs and sort GOT entries. If you have such a linker, | |
| you should only need to use @option{-mxgot} when compiling a single | |
| object file that accesses more than 8192 GOT entries. Very few do. | |
| These options have no effect unless GCC is generating | |
| position-independent code. | |
| @opindex mxtls | |
| @opindex mno-xtls | |
| @item -mxtls | |
| Support TLS segment larger than 64K. The considerations for using | |
| this option are similar to those for @option{-mxgot} above; the | |
| default 16-bit offset addressing for TLS is more efficient, but this | |
| may be inadequate for some programs. | |
| @opindex mlong-jump-table-offsets | |
| @item -mlong-jump-table-offsets | |
| Use 32-bit offsets in @code{switch} tables. The default is to use | |
| 16-bit offsets. | |
| @end table | |
| @node MCore Options | |
| @subsection MCore Options | |
| @cindex MCore options | |
| These are the @samp{-m} options defined for the Motorola M*Core | |
| processors. | |
| @table @gcctabopt | |
| @opindex mhardlit | |
| @opindex mno-hardlit | |
| @item -mhardlit | |
| @itemx -mno-hardlit | |
| Inline constants into the code stream if it can be done in two | |
| instructions or less. | |
| @opindex mdiv | |
| @opindex mno-div | |
| @item -mdiv | |
| @itemx -mno-div | |
| Use the divide instruction. (Enabled by default). | |
| @opindex mrelax-immediates | |
| @opindex mno-relax-immediates | |
| @item -mrelax-immediates | |
| @itemx -mno-relax-immediates | |
| Allow arbitrary-sized immediates in bit operations. | |
| @opindex mwide-bitfields | |
| @opindex mno-wide-bitfields | |
| @item -mwide-bitfields | |
| @itemx -mno-wide-bitfields | |
| Always treat bit-fields as @code{int}-sized. | |
| @opindex m4byte-functions | |
| @opindex mno-4byte-functions | |
| @item -m4byte-functions | |
| @itemx -mno-4byte-functions | |
| Force all functions to be aligned to a 4-byte boundary. | |
| @opindex mcallgraph-data | |
| @opindex mno-callgraph-data | |
| @item -mcallgraph-data | |
| @itemx -mno-callgraph-data | |
| Emit callgraph information. | |
| @opindex mslow-bytes | |
| @opindex mno-slow-bytes | |
| @item -mslow-bytes | |
| @itemx -mno-slow-bytes | |
| Prefer word access when reading byte quantities. | |
| @opindex mlittle-endian | |
| @opindex mbig-endian | |
| @item -mlittle-endian | |
| @itemx -mbig-endian | |
| Generate code for a little- or big-endian target, respectively. The | |
| default is big-endian. Little-endian code is supported only | |
| with @option{-m340}. | |
| @opindex m210 | |
| @item -m210 | |
| Generate code for the 210 processor. | |
| @opindex m340 | |
| @item -m340 | |
| Generate code for the 340 processor. | |
| @opindex mno-lsim | |
| @item -mno-lsim | |
| Assume that runtime support has been provided and so omit the | |
| simulator library (@file{libsim.a)} from the linker command line. | |
| @opindex mstack-increment | |
| @item -mstack-increment=@var{size} | |
| Set the maximum amount for a single stack increment operation. Large | |
| values can increase the speed of programs that contain functions | |
| that need a large amount of stack space, but they can also trigger a | |
| segmentation fault if the stack is extended too much. The default | |
| value is 0x1000. | |
| @end table | |
| @node MicroBlaze Options | |
| @subsection MicroBlaze Options | |
| @cindex MicroBlaze Options | |
| @table @gcctabopt | |
| @opindex msoft-float | |
| @item -msoft-float | |
| Use software emulation for floating point (default). | |
| @opindex mhard-float | |
| @item -mhard-float | |
| Use hardware floating-point instructions. | |
| @opindex mmemcpy | |
| @opindex mno-memcpy | |
| @item -mmemcpy | |
| Do not optimize block moves, use @code{memcpy}. | |
| @opindex mcpu= | |
| @item -mcpu=@var{cpu-type} | |
| Use features of, and schedule code for, the given CPU. | |
| Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}}, | |
| where @var{X} is a major version, @var{YY} is the minor version, and | |
| @var{Z} is compatibility code. Example values are @samp{v3.00.a}, | |
| @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v6.00.a}. | |
| @opindex mxl-soft-mul | |
| @opindex mno-xl-soft-mul | |
| @item -mxl-soft-mul | |
| @itemx -mno-xl-soft-mul | |
| Use software multiply emulation. This is enabled by default. | |
| @opindex mxl-soft-div | |
| @opindex mno-xl-soft-div | |
| @item -mxl-soft-div | |
| @itemx -mno-xl-soft-div | |
| Use software emulation for divides. This is enabled by default. | |
| @opindex mxl-barrel-shift | |
| @opindex mno-xl-barrel-shift | |
| @item -mxl-barrel-shift | |
| Use the hardware barrel shifter. | |
| @opindex mxl-pattern-compare | |
| @opindex mno-xl-pattern-compare | |
| @item -mxl-pattern-compare | |
| Use pattern compare instructions. | |
| @opindex msmall-divides | |
| @opindex mno-small-divides | |
| @item -msmall-divides | |
| Use table lookup optimization for small signed integer divisions. | |
| @opindex mxl-gp-opt | |
| @opindex mno-xl-gp-opt | |
| @item -mxl-gp-opt | |
| Use GP-relative @code{.sdata}/@code{.sbss} sections. | |
| @opindex mxl-multiply-high | |
| @opindex mno-xl-multiply-high | |
| @item -mxl-multiply-high | |
| Use multiply high instructions for high part of 32x32 multiply. | |
| @opindex mxl-float-convert | |
| @opindex mno-xl-float-convert | |
| @item -mxl-float-convert | |
| Use hardware floating-point conversion instructions. | |
| @opindex mxl-float-sqrt | |
| @opindex mno-xl-float-sqrt | |
| @item -mxl-float-sqrt | |
| Use hardware floating-point square root instruction. | |
| @opindex mbig-endian | |
| @item -mbig-endian | |
| Generate code for a big-endian target. | |
| @opindex mlittle-endian | |
| @item -mlittle-endian | |
| Generate code for a little-endian target. | |
| @opindex mxl-reorder | |
| @item -mxl-reorder | |
| Use reorder instructions (swap and byte reversed load/store). | |
| @opindex mxl-mode-executable | |
| @opindex mno-xl-mode-executable | |
| @opindex mxl-mode-xmdstub | |
| @opindex mno-xl-mode-xmdstub | |
| @opindex mxl-mode-bootstrap | |
| @opindex mno-xl-mode-bootstrap | |
| @opindex mxl-mode-novectors | |
| @opindex mno-xl-mode-novectors | |
| @item -mxl-mode-@var{app-model} | |
| Select application model @var{app-model}. Valid models are | |
| @table @samp | |
| @item executable | |
| normal executable (default), uses startup code @file{crt0.o}. | |
| @item xmdstub | |
| for use with Xilinx Microprocessor Debugger (XMD) based | |
| software intrusive debug agent called xmdstub. This uses startup file | |
| @file{crt1.o} and sets the start address of the program to 0x800. | |
| @item bootstrap | |
| for applications that are loaded using a bootloader. | |
| This model uses startup file @file{crt2.o} which does not contain a processor | |
| reset vector handler. This is suitable for transferring control on a | |
| processor reset to the bootloader rather than the application. | |
| @item novectors | |
| for applications that do not require any of the | |
| MicroBlaze vectors. This option may be useful for applications running | |
| within a monitoring application. This model uses @file{crt3.o} as a startup file. | |
| @end table | |
| @opindex mxl-prefetch | |
| @opindex mno-xl-prefetch | |
| @item -mxl-prefetch | |
| Enable insertion of prefetch (@code{wic}) instructions at call sites. | |
| @opindex mpic-data-is-text-relative | |
| @opindex mno-pic-data-is-text-relative | |
| @item -mpic-data-is-text-relative | |
| Assume that the displacement between the text and data segments is fixed | |
| at static link time. This allows data to be referenced by offset from start of | |
| text address instead of GOT since PC-relative addressing is not supported. | |
| @end table | |
| @node MIPS Options | |
| @subsection MIPS Options | |
| @cindex MIPS options | |
| @table @gcctabopt | |
| @opindex EB | |
| @opindex meb | |
| @opindex mno-el | |
| @item -EB | |
| @itemx -meb | |
| Generate big-endian code. | |
| @opindex EL | |
| @opindex mel | |
| @item -EL | |
| @itemx -mel | |
| Generate little-endian code. This is the default for @samp{mips*el-*-*} | |
| configurations. | |
| @opindex march | |
| @item -march=@var{arch} | |
| Generate code that runs on @var{arch}, which can be the name of a | |
| generic MIPS ISA, or the name of a particular processor. | |
| The ISA names are: | |
| @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4}, | |
| @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5}, | |
| @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3}, | |
| @samp{mips64r5} and @samp{mips64r6}. | |
| The processor names are: | |
| @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc}, | |
| @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd}, | |
| @samp{5kc}, @samp{5kf}, | |
| @samp{20kc}, | |
| @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1}, | |
| @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1}, | |
| @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn}, | |
| @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2}, | |
| @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1}, | |
| @samp{i6400}, @samp{i6500}, | |
| @samp{interaptiv}, | |
| @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a}, @samp{gs464}, | |
| @samp{gs464e}, @samp{gs264e}, | |
| @samp{m4k}, | |
| @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec}, | |
| @samp{m5100}, @samp{m5101}, | |
| @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3}, | |
| @samp{orion}, | |
| @samp{p5600}, @samp{p6600}, | |
| @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400}, | |
| @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r5900}, | |
| @samp{r6000}, @samp{r8000}, | |
| @samp{rm7000}, @samp{rm9000}, | |
| @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000}, | |
| @samp{sb1}, | |
| @samp{sr71000}, | |
| @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300}, | |
| @samp{vr5000}, @samp{vr5400}, @samp{vr5500}, | |
| @samp{xlr} and @samp{xlp}. | |
| @samp{allegrex}, | |
| The special value @samp{from-abi} selects the | |
| most compatible architecture for the selected ABI (that is, | |
| @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@. | |
| The native Linux/GNU toolchain also supports the value @samp{native}, | |
| which selects the best architecture option for the host processor. | |
| @option{-march=native} has no effect if GCC does not recognize | |
| the processor. | |
| In processor names, a final @samp{000} can be abbreviated as @samp{k} | |
| (for example, @option{-march=r2k}). Prefixes are optional, and | |
| @samp{vr} may be written @samp{r}. | |
| Names of the form @samp{@var{n}f2_1} refer to processors with | |
| FPUs clocked at half the rate of the core, names of the form | |
| @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same | |
| rate as the core, and names of the form @samp{@var{n}f3_2} refer to | |
| processors with FPUs clocked a ratio of 3:2 with respect to the core. | |
| For compatibility reasons, @samp{@var{n}f} is accepted as a synonym | |
| for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are | |
| accepted as synonyms for @samp{@var{n}f1_1}. | |
| GCC defines two macros based on the value of this option. The first | |
| is @code{_MIPS_ARCH}, which gives the name of target architecture, as | |
| a string. The second has the form @code{_MIPS_ARCH_@var{foo}}, | |
| where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@. | |
| For example, @option{-march=r2000} sets @code{_MIPS_ARCH} | |
| to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}. | |
| Note that the @code{_MIPS_ARCH} macro uses the processor names given | |
| above. In other words, it has the full prefix and does not | |
| abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi}, | |
| the macro names the resolved architecture (either @code{"mips1"} or | |
| @code{"mips3"}). It names the default architecture when no | |
| @option{-march} option is given. | |
| @opindex mtune | |
| @item -mtune=@var{arch} | |
| Optimize for @var{arch}. Among other things, this option controls | |
| the way instructions are scheduled, and the perceived cost of arithmetic | |
| operations. The list of @var{arch} values is the same as for | |
| @option{-march}. | |
| When this option is not used, GCC optimizes for the processor | |
| specified by @option{-march}. By using @option{-march} and | |
| @option{-mtune} together, it is possible to generate code that | |
| runs on a family of processors, but optimize the code for one | |
| particular member of that family. | |
| @option{-mtune} defines the macros @code{_MIPS_TUNE} and | |
| @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the | |
| @option{-march} ones described above. | |
| @opindex mips1 | |
| @item -mips1 | |
| Equivalent to @option{-march=mips1}. | |
| @opindex mips2 | |
| @item -mips2 | |
| Equivalent to @option{-march=mips2}. | |
| @opindex mips3 | |
| @item -mips3 | |
| Equivalent to @option{-march=mips3}. | |
| @opindex mips4 | |
| @item -mips4 | |
| Equivalent to @option{-march=mips4}. | |
| @opindex mips32 | |
| @item -mips32 | |
| Equivalent to @option{-march=mips32}. | |
| @opindex mips32r3 | |
| @item -mips32r3 | |
| Equivalent to @option{-march=mips32r3}. | |
| @opindex mips32r5 | |
| @item -mips32r5 | |
| Equivalent to @option{-march=mips32r5}. | |
| @opindex mips32r6 | |
| @item -mips32r6 | |
| Equivalent to @option{-march=mips32r6}. | |
| @opindex mips64 | |
| @item -mips64 | |
| Equivalent to @option{-march=mips64}. | |
| @opindex mips64r2 | |
| @item -mips64r2 | |
| Equivalent to @option{-march=mips64r2}. | |
| @opindex mips64r3 | |
| @item -mips64r3 | |
| Equivalent to @option{-march=mips64r3}. | |
| @opindex mips64r5 | |
| @item -mips64r5 | |
| Equivalent to @option{-march=mips64r5}. | |
| @opindex mips64r6 | |
| @item -mips64r6 | |
| Equivalent to @option{-march=mips64r6}. | |
| @opindex mips16 | |
| @opindex mno-mips16 | |
| @item -mips16 | |
| @itemx -mno-mips16 | |
| Generate (do not generate) MIPS16 code. If GCC is targeting a | |
| MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@. | |
| MIPS16 code generation can also be controlled on a per-function basis | |
| by means of @code{mips16} and @code{nomips16} attributes. | |
| @xref{MIPS Attributes}, for more information. | |
| @opindex mmips16e2 | |
| @opindex mno-mips16e2 | |
| @item -mmips16e2 | |
| @itemx -mno-mips16e2 | |
| Use (do not use) the MIPS16e2 ASE. This option modifies the behavior | |
| of the @option{-mips16} option such that it targets the MIPS16e2 ASE@. | |
| @opindex mflip-mips16 | |
| @opindex mno-flip-mips16 | |
| @item -mflip-mips16 | |
| @itemx -mflip-mips16 | |
| Generate MIPS16 code on alternating functions. This option is provided | |
| for regression testing of mixed MIPS16/non-MIPS16 code generation, and is | |
| not intended for ordinary use in compiling user code. | |
| @opindex minterlink-compressed | |
| @opindex mno-interlink-compressed | |
| @item -minterlink-compressed | |
| @itemx -mno-interlink-compressed | |
| Require (do not require) that code using the standard (uncompressed) MIPS ISA | |
| be link-compatible with MIPS16 and microMIPS code, and vice versa. | |
| For example, code using the standard ISA encoding cannot jump directly | |
| to MIPS16 or microMIPS code; it must either use a call or an indirect jump. | |
| @option{-minterlink-compressed} therefore disables direct jumps unless GCC | |
| knows that the target of the jump is not compressed. | |
| @opindex minterlink-mips16 | |
| @opindex mno-interlink-mips16 | |
| @item -minterlink-mips16 | |
| @itemx -mno-interlink-mips16 | |
| Aliases of @option{-minterlink-compressed} and | |
| @option{-mno-interlink-compressed}. These options predate the microMIPS ASE | |
| and are retained for backwards compatibility. | |
| @opindex mabi | |
| @item -mabi=32 | |
| @itemx -mabi=o64 | |
| @itemx -mabi=n32 | |
| @itemx -mabi=64 | |
| @itemx -mabi=eabi | |
| Generate code for the given ABI@. | |
| Note that the EABI has a 32-bit and a 64-bit variant. GCC normally | |
| generates 64-bit code when you select a 64-bit architecture, but you | |
| can use @option{-mgp32} to get 32-bit code instead. | |
| For information about the O64 ABI, see | |
| @uref{https://gcc.gnu.org/@/projects/@/mipso64-abi.html}. | |
| GCC supports a variant of the o32 ABI in which floating-point registers | |
| are 64 rather than 32 bits wide. You can select this combination with | |
| @option{-mabi=32} @option{-mfp64}. This ABI relies on the @code{mthc1} | |
| and @code{mfhc1} instructions and is therefore only supported for | |
| MIPS32R2, MIPS32R3 and MIPS32R5 processors. | |
| The register assignments for arguments and return values remain the | |
| same, but each scalar value is passed in a single 64-bit register | |
| rather than a pair of 32-bit registers. For example, scalar | |
| floating-point values are returned in @samp{$f0} only, not a | |
| @samp{$f0}/@samp{$f1} pair. The set of call-saved registers also | |
| remains the same in that the even-numbered double-precision registers | |
| are saved. | |
| Two additional variants of the o32 ABI are supported to enable | |
| a transition from 32-bit to 64-bit registers. These are FPXX | |
| (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}). | |
| The FPXX extension mandates that all code must execute correctly | |
| when run using 32-bit or 64-bit registers. The code can be interlinked | |
| with either FP32 or FP64, but not both. | |
| The FP64A extension is similar to the FP64 extension but forbids the | |
| use of odd-numbered single-precision registers. This can be used | |
| in conjunction with the @code{FRE} mode of FPUs in MIPS32R5 | |
| processors and allows both FP32 and FP64A code to interlink and | |
| run in the same process without changing FPU modes. | |
| @opindex mabicalls | |
| @opindex mno-abicalls | |
| @item -mabicalls | |
| @itemx -mno-abicalls | |
| Generate (do not generate) code that is suitable for SVR4-style | |
| dynamic objects. @option{-mabicalls} is the default for SVR4-based | |
| systems. | |
| @opindex mshared | |
| @opindex mno-shared | |
| @item -mshared | |
| @itemx -mno-shared | |
| Generate (do not generate) code that is fully position-independent, | |
| and that can therefore be linked into shared libraries. This option | |
| only affects @option{-mabicalls}. | |
| All @option{-mabicalls} code has traditionally been position-independent, | |
| regardless of options like @option{-fPIC} and @option{-fpic}. However, | |
| as an extension, the GNU toolchain allows executables to use absolute | |
| accesses for locally-binding symbols. It can also use shorter GP | |
| initialization sequences and generate direct calls to locally-defined | |
| functions. This mode is selected by @option{-mno-shared}. | |
| @option{-mno-shared} depends on binutils 2.16 or higher and generates | |
| objects that can only be linked by the GNU linker. However, the option | |
| does not affect the ABI of the final executable; it only affects the ABI | |
| of relocatable objects. Using @option{-mno-shared} generally makes | |
| executables both smaller and quicker. | |
| @option{-mshared} is the default. | |
| @opindex mplt | |
| @opindex mno-plt | |
| @item -mplt | |
| @itemx -mno-plt | |
| Assume (do not assume) that the static and dynamic linkers | |
| support PLTs and copy relocations. This option only affects | |
| @option{-mno-shared -mabicalls}. For the n64 ABI, this option | |
| has no effect without @option{-msym32}. | |
| You can make @option{-mplt} the default by configuring | |
| GCC with @option{--with-mips-plt}. The default is | |
| @option{-mno-plt} otherwise. | |
| @opindex mxgot | |
| @opindex mno-xgot | |
| @item -mxgot | |
| @itemx -mno-xgot | |
| Lift (do not lift) the usual restrictions on the size of the global | |
| offset table. | |
| GCC normally uses a single instruction to load values from the GOT@. | |
| While this is relatively efficient, it only works if the GOT | |
| is smaller than about 64k. Anything larger causes the linker | |
| to report an error such as: | |
| @cindex relocation truncated to fit (MIPS) | |
| @smallexample | |
| relocation truncated to fit: R_MIPS_GOT16 foobar | |
| @end smallexample | |
| If this happens, you should recompile your code with @option{-mxgot}. | |
| This works with very large GOTs, although the code is also | |
| less efficient, since it takes three instructions to fetch the | |
| value of a global symbol. | |
| Note that some linkers can create multiple GOTs. If you have such a | |
| linker, you should only need to use @option{-mxgot} when a single object | |
| file accesses more than 64k's worth of GOT entries. Very few do. | |
| These options have no effect unless GCC is generating position | |
| independent code. | |
| @opindex mgp32 | |
| @item -mgp32 | |
| Assume that general-purpose registers are 32 bits wide. | |
| @opindex mgp64 | |
| @item -mgp64 | |
| Assume that general-purpose registers are 64 bits wide. | |
| @opindex mfp32 | |
| @item -mfp32 | |
| Assume that floating-point registers are 32 bits wide. | |
| @opindex mfp64 | |
| @item -mfp64 | |
| Assume that floating-point registers are 64 bits wide. | |
| @opindex mfpxx | |
| @item -mfpxx | |
| Do not assume the width of floating-point registers. | |
| @opindex mhard-float | |
| @item -mhard-float | |
| Use floating-point coprocessor instructions. | |
| @opindex msoft-float | |
| @item -msoft-float | |
| Do not use floating-point coprocessor instructions. Implement | |
| floating-point calculations using library calls instead. | |
| @opindex mno-float | |
| @item -mno-float | |
| Equivalent to @option{-msoft-float}, but additionally asserts that the | |
| program being compiled does not perform any floating-point operations. | |
| This option is presently supported only by some bare-metal MIPS | |
| configurations, where it may select a special set of libraries | |
| that lack all floating-point support (including, for example, the | |
| floating-point @code{printf} formats). | |
| If code compiled with @option{-mno-float} accidentally contains | |
| floating-point operations, it is likely to suffer a link-time | |
| or run-time failure. | |
| @opindex msingle-float | |
| @item -msingle-float | |
| Assume that the floating-point coprocessor only supports single-precision | |
| operations. | |
| @opindex mdouble-float | |
| @item -mdouble-float | |
| Assume that the floating-point coprocessor supports double-precision | |
| operations. This is the default. | |
| @opindex modd-spreg | |
| @opindex mno-odd-spreg | |
| @item -modd-spreg | |
| @itemx -mno-odd-spreg | |
| Enable the use of odd-numbered single-precision floating-point registers | |
| for the o32 ABI. This is the default for processors that are known to | |
| support these registers. When using the o32 FPXX ABI, @option{-mno-odd-spreg} | |
| is set by default. | |
| @opindex mabs=2008 | |
| @opindex mabs=legacy | |
| @item -mabs=2008 | |
| @itemx -mabs=legacy | |
| These options control the treatment of the special not-a-number (NaN) | |
| IEEE 754 floating-point data with the @code{abs.@i{fmt}} and | |
| @code{neg.@i{fmt}} machine instructions. | |
| By default or when @option{-mabs=legacy} is used the legacy | |
| treatment is selected. In this case these instructions are considered | |
| arithmetic and avoided where correct operation is required and the | |
| input operand might be a NaN. A longer sequence of instructions that | |
| manipulate the sign bit of floating-point datum manually is used | |
| instead unless the @option{-ffinite-math-only} option has also been | |
| specified. | |
| The @option{-mabs=2008} option selects the IEEE 754-2008 treatment. In | |
| this case these instructions are considered non-arithmetic and therefore | |
| operating correctly in all cases, including in particular where the | |
| input operand is a NaN. These instructions are therefore always used | |
| for the respective operations. | |
| @opindex mnan=2008 | |
| @opindex mnan=legacy | |
| @item -mnan=2008 | |
| @itemx -mnan=legacy | |
| These options control the encoding of the special not-a-number (NaN) | |
| IEEE 754 floating-point data. | |
| The @option{-mnan=legacy} option selects the legacy encoding. In this | |
| case quiet NaNs (qNaNs) are denoted by the first bit of their trailing | |
| significand field being 0, whereas signaling NaNs (sNaNs) are denoted | |
| by the first bit of their trailing significand field being 1. | |
| The @option{-mnan=2008} option selects the IEEE 754-2008 encoding. In | |
| this case qNaNs are denoted by the first bit of their trailing | |
| significand field being 1, whereas sNaNs are denoted by the first bit of | |
| their trailing significand field being 0. | |
| The default is @option{-mnan=legacy} unless GCC has been configured with | |
| @option{--with-nan=2008}. | |
| @opindex mllsc | |
| @opindex mno-llsc | |
| @item -mllsc | |
| @itemx -mno-llsc | |
| Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to | |
| implement atomic memory built-in functions. When neither option is | |
| specified, GCC uses the instructions if the target architecture | |
| supports them. | |
| @option{-mllsc} is useful if the runtime environment can emulate the | |
| instructions and @option{-mno-llsc} can be useful when compiling for | |
| nonstandard ISAs. You can make either option the default by | |
| configuring GCC with @option{--with-llsc} and @option{--without-llsc} | |
| respectively. @option{--with-llsc} is the default for some | |
| configurations; see the installation documentation for details. | |
| @opindex mdsp | |
| @opindex mno-dsp | |
| @item -mdsp | |
| @itemx -mno-dsp | |
| Use (do not use) revision 1 of the MIPS DSP ASE@. | |
| @xref{MIPS DSP Built-in Functions}. This option defines the | |
| preprocessor macro @code{__mips_dsp}. It also defines | |
| @code{__mips_dsp_rev} to 1. | |
| @opindex mdspr2 | |
| @opindex mno-dspr2 | |
| @item -mdspr2 | |
| @itemx -mno-dspr2 | |
| Use (do not use) revision 2 of the MIPS DSP ASE@. | |
| @xref{MIPS DSP Built-in Functions}. This option defines the | |
| preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}. | |
| It also defines @code{__mips_dsp_rev} to 2. | |
| @opindex msmartmips | |
| @opindex mno-smartmips | |
| @item -msmartmips | |
| @itemx -mno-smartmips | |
| Use (do not use) the MIPS SmartMIPS ASE. | |
| @opindex mpaired-single | |
| @opindex mno-paired-single | |
| @item -mpaired-single | |
| @itemx -mno-paired-single | |
| Use (do not use) paired-single floating-point instructions. | |
| @xref{MIPS Paired-Single Support}. This option requires | |
| hardware floating-point support to be enabled. | |
| @opindex mdmx | |
| @opindex mno-mdmx | |
| @item -mdmx | |
| @itemx -mno-mdmx | |
| Use (do not use) MIPS Digital Media Extension instructions. | |
| This option can only be used when generating 64-bit code and requires | |
| hardware floating-point support to be enabled. | |
| @opindex mips3d | |
| @opindex mno-mips3d | |
| @item -mips3d | |
| @itemx -mno-mips3d | |
| Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}. | |
| The option @option{-mips3d} implies @option{-mpaired-single}. | |
| @opindex mmicromips | |
| @opindex mno-mmicromips | |
| @item -mmicromips | |
| @itemx -mno-micromips | |
| Generate (do not generate) microMIPS code. | |
| MicroMIPS code generation can also be controlled on a per-function basis | |
| by means of @code{micromips} and @code{nomicromips} attributes. | |
| @xref{MIPS Attributes}, for more information. | |
| @opindex mmt | |
| @opindex mno-mt | |
| @item -mmt | |
| @itemx -mno-mt | |
| Use (do not use) MT Multithreading instructions. | |
| @opindex mmcu | |
| @opindex mno-mcu | |
| @item -mmcu | |
| @itemx -mno-mcu | |
| Use (do not use) the MIPS MCU ASE instructions. | |
| @opindex meva | |
| @opindex mno-eva | |
| @item -meva | |
| @itemx -mno-eva | |
| Use (do not use) the MIPS Enhanced Virtual Addressing instructions. | |
| @opindex mvirt | |
| @opindex mno-virt | |
| @item -mvirt | |
| @itemx -mno-virt | |
| Use (do not use) the MIPS Virtualization (VZ) instructions. | |
| @opindex mxpa | |
| @opindex mno-xpa | |
| @item -mxpa | |
| @itemx -mno-xpa | |
| Use (do not use) the MIPS eXtended Physical Address (XPA) instructions. | |
| @opindex mcrc | |
| @opindex mno-crc | |
| @item -mcrc | |
| @itemx -mno-crc | |
| Use (do not use) the MIPS Cyclic Redundancy Check (CRC) instructions. | |
| @opindex mginv | |
| @opindex mno-ginv | |
| @item -mginv | |
| @itemx -mno-ginv | |
| Use (do not use) the MIPS Global INValidate (GINV) instructions. | |
| @opindex mmsa | |
| @opindex mno-msa | |
| @item -mmsa | |
| @itemx -mno-msa | |
| Use (do not use) the MIPS MSA extension instructions. | |
| @opindex mloongson-mmi | |
| @opindex mno-loongson-mmi | |
| @item -mloongson-mmi | |
| @itemx -mno-loongson-mmi | |
| Use (do not use) the MIPS Loongson MultiMedia extensions Instructions (MMI). | |
| @opindex mloongson-ext | |
| @opindex mno-loongson-ext | |
| @item -mloongson-ext | |
| @itemx -mno-loongson-ext | |
| Use (do not use) the MIPS Loongson EXTensions (EXT) instructions. | |
| @opindex mloongson-ext2 | |
| @opindex mno-loongson-ext2 | |
| @item -mloongson-ext2 | |
| @itemx -mno-loongson-ext2 | |
| Use (do not use) the MIPS Loongson EXTensions r2 (EXT2) instructions. | |
| @opindex mlong64 | |
| @item -mlong64 | |
| Force @code{long} types to be 64 bits wide. See @option{-mlong32} for | |
| an explanation of the default and the way that the pointer size is | |
| determined. | |
| @opindex mlong32 | |
| @item -mlong32 | |
| Force @code{long}, @code{int}, and pointer types to be 32 bits wide. | |
| The default size of @code{int}s, @code{long}s and pointers depends on | |
| the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI | |
| uses 64-bit @code{long}s, as does the 64-bit EABI; the others use | |
| 32-bit @code{long}s. Pointers are the same size as @code{long}s, | |
| or the same size as integer registers, whichever is smaller. | |
| @opindex msym32 | |
| @opindex mno-sym32 | |
| @item -msym32 | |
| @itemx -mno-sym32 | |
| Assume (do not assume) that all symbols have 32-bit values, regardless | |
| of the selected ABI@. This option is useful in combination with | |
| @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC | |
| to generate shorter and faster references to symbolic addresses. | |
| @opindex G | |
| @item -G @var{num} | |
| Put definitions of externally-visible data in a small data section | |
| if that data is no bigger than @var{num} bytes. GCC can then generate | |
| more efficient accesses to the data; see @option{-mgpopt} for details. | |
| The default @option{-G} option depends on the configuration. | |
| @opindex mlocal-sdata | |
| @opindex mno-local-sdata | |
| @item -mlocal-sdata | |
| @itemx -mno-local-sdata | |
| Extend (do not extend) the @option{-G} behavior to local data too, | |
| such as to static variables in C@. @option{-mlocal-sdata} is the | |
| default for all configurations. | |
| If the linker complains that an application is using too much small data, | |
| you might want to try rebuilding the less performance-critical parts with | |
| @option{-mno-local-sdata}. You might also want to build large | |
| libraries with @option{-mno-local-sdata}, so that the libraries leave | |
| more room for the main program. | |
| @opindex mextern-sdata | |
| @opindex mno-extern-sdata | |
| @item -mextern-sdata | |
| @itemx -mno-extern-sdata | |
| Assume (do not assume) that externally-defined data is in | |
| a small data section if the size of that data is within the @option{-G} limit. | |
| @option{-mextern-sdata} is the default for all configurations. | |
| If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G | |
| @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var} | |
| that is no bigger than @var{num} bytes, you must make sure that @var{Var} | |
| is placed in a small data section. If @var{Var} is defined by another | |
| module, you must either compile that module with a high-enough | |
| @option{-G} setting or attach a @code{section} attribute to @var{Var}'s | |
| definition. If @var{Var} is common, you must link the application | |
| with a high-enough @option{-G} setting. | |
| The easiest way of satisfying these restrictions is to compile | |
| and link every module with the same @option{-G} option. However, | |
| you may wish to build a library that supports several different | |
| small data limits. You can do this by compiling the library with | |
| the highest supported @option{-G} setting and additionally using | |
| @option{-mno-extern-sdata} to stop the library from making assumptions | |
| about externally-defined data. | |
| @opindex mgpopt | |
| @opindex mno-gpopt | |
| @item -mgpopt | |
| @itemx -mno-gpopt | |
| Use (do not use) GP-relative accesses for symbols that are known to be | |
| in a small data section; see @option{-G}, @option{-mlocal-sdata} and | |
| @option{-mextern-sdata}. @option{-mgpopt} is the default for all | |
| configurations. | |
| @option{-mno-gpopt} is useful for cases where the @code{$gp} register | |
| might not hold the value of @code{_gp}. For example, if the code is | |
| part of a library that might be used in a boot monitor, programs that | |
| call boot monitor routines pass an unknown value in @code{$gp}. | |
| (In such situations, the boot monitor itself is usually compiled | |
| with @option{-G0}.) | |
| @option{-mno-gpopt} implies @option{-mno-local-sdata} and | |
| @option{-mno-extern-sdata}. | |
| @opindex membedded-data | |
| @opindex mno-embedded-data | |
| @item -membedded-data | |
| @itemx -mno-embedded-data | |
| Allocate variables to the read-only data section first if possible, then | |
| next in the small data section if possible, otherwise in data. This gives | |
| slightly slower code than the default, but reduces the amount of RAM required | |
| when executing, and thus may be preferred for some embedded systems. | |
| @opindex muninit-const-in-rodata | |
| @opindex mno-uninit-const-in-rodata | |
| @item -muninit-const-in-rodata | |
| @itemx -mno-uninit-const-in-rodata | |
| Put uninitialized @code{const} variables in the read-only data section. | |
| This option is only meaningful in conjunction with @option{-membedded-data}. | |
| @opindex mcode-readable | |
| @opindex mno-data-in-code | |
| @opindex mcode-xonly | |
| @item -mcode-readable=@var{setting} | |
| Specify whether GCC may generate code that reads from executable sections. | |
| There are three possible settings: | |
| @table @gcctabopt | |
| @item -mcode-readable=yes | |
| Instructions may freely access executable sections. This is the | |
| default setting. | |
| @item -mcode-readable=pcrel | |
| MIPS16 PC-relative load instructions can access executable sections, | |
| but other instructions must not do so. This option is useful on 4KSc | |
| and 4KSd processors when the code TLBs have the Read Inhibit bit set. | |
| It is also useful on processors that can be configured to have a dual | |
| instruction/data SRAM interface and that, like the M4K, automatically | |
| redirect PC-relative loads to the instruction RAM. | |
| @item -mcode-readable=no | |
| Instructions must not access executable sections. This option can be | |
| useful on targets that are configured to have a dual instruction/data | |
| SRAM interface but that (unlike the M4K) do not automatically redirect | |
| PC-relative loads to the instruction RAM. | |
| @end table | |
| On SDE targets, @option{-mcode-data-in-code} is available as a | |
| traditional alias for @option{-mcode-readable=no}, and @option{-mcode-xonly} | |
| for @option{-mcode-readable=pcrel}. | |
| @opindex msplit-addresses | |
| @opindex mno-split-addresses | |
| @item -msplit-addresses | |
| @itemx -mno-split-addresses | |
| Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler | |
| relocation operators. This option has been superseded by | |
| @option{-mexplicit-relocs} but is retained for backwards compatibility. | |
| @opindex mexplicit-relocs | |
| @opindex mno-explicit-relocs | |
| @item -mexplicit-relocs=none | |
| @itemx -mexplicit-relocs=base | |
| @itemx -mexplicit-relocs=pcrel | |
| @itemx -mexplicit-relocs | |
| @itemx -mno-explicit-relocs | |
| These options control whether explicit relocs (such as @code{%gp_rel}) are used. | |
| The default value depends on the version of GAS when GCC itself was built. | |
| The @code{base} explicit-relocs support was introduced into GAS in 2001. | |
| The @code{pcrel} explicit-relocs support was introduced into GAS in 2014, | |
| which supports @code{%pcrel_hi} and @code{%pcrel_lo}. | |
| @opindex mcheck-zero-division | |
| @opindex mno-check-zero-division | |
| @item -mcheck-zero-division | |
| @itemx -mno-check-zero-division | |
| Trap (do not trap) on integer division by zero. | |
| The default is @option{-mcheck-zero-division}. | |
| @opindex mdivide-traps | |
| @opindex mdivide-breaks | |
| @item -mdivide-traps | |
| @itemx -mdivide-breaks | |
| MIPS systems check for division by zero by generating either a | |
| conditional trap or a break instruction. Using traps results in | |
| smaller code, but is only supported on MIPS II and later. Also, some | |
| versions of the Linux kernel have a bug that prevents trap from | |
| generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to | |
| allow conditional traps on architectures that support them and | |
| @option{-mdivide-breaks} to force the use of breaks. | |
| The default is usually @option{-mdivide-traps}, but this can be | |
| overridden at configure time using @option{--with-divide=breaks}. | |
| Divide-by-zero checks can be completely disabled using | |
| @option{-mno-check-zero-division}. | |
| @opindex mload-store-pairs | |
| @opindex mno-load-store-pairs | |
| @item -mload-store-pairs | |
| @itemx -mno-load-store-pairs | |
| Enable (disable) an optimization that pairs consecutive load or store | |
| instructions to enable load/store bonding. This option is enabled by | |
| default but only takes effect when the selected architecture is known | |
| to support bonding. | |
| @opindex mstrict-align | |
| @opindex mno-strict-align | |
| @opindex munaligned-access | |
| @opindex mno-unaligned-access | |
| @item -mstrict-align | |
| @itemx -mno-strict-align | |
| @itemx -munaligned-access | |
| @itemx -mno-unaligned-access | |
| Disable (enable) direct unaligned access for MIPS Release 6. | |
| MIPSr6 requires load/store unaligned-access support, either by hardware or | |
| by trapping and emulation. In the latter case @option{-mstrict-align} | |
| may be needed by the operating system kernel. The | |
| options @option{-munaligned-access} and @option{-mno-unaligned-access} | |
| are obsolete, and only provided for backward compatibility. | |
| @opindex mmemcpy | |
| @opindex mno-memcpy | |
| @item -mmemcpy | |
| @itemx -mno-memcpy | |
| Force (do not force) the use of @code{memcpy} for non-trivial block | |
| moves. The default is @option{-mno-memcpy}, which allows GCC to inline | |
| most constant-sized copies. | |
| @opindex mlong-calls | |
| @opindex mno-long-calls | |
| @item -mlong-calls | |
| @itemx -mno-long-calls | |
| Disable (do not disable) use of the @code{jal} instruction. Calling | |
| functions using @code{jal} is more efficient but requires the caller | |
| and callee to be in the same 256 megabyte segment. | |
| This option has no effect on abicalls code. The default is | |
| @option{-mno-long-calls}. | |
| @opindex mmad | |
| @opindex mno-mad | |
| @item -mmad | |
| @itemx -mno-mad | |
| Enable (disable) use of the @code{mad}, @code{madu} and @code{mul} | |
| instructions, as provided by the R4650 ISA@. | |
| @opindex mimadd | |
| @opindex mno-imadd | |
| @item -mimadd | |
| @itemx -mno-imadd | |
| Enable (disable) use of the @code{madd} and @code{msub} integer | |
| instructions. The default is @option{-mimadd} on architectures | |
| that support @code{madd} and @code{msub} except for the 74k | |
| architecture where it was found to generate slower code. | |
| @opindex mfused-madd | |
| @opindex mno-fused-madd | |
| @item -mfused-madd | |
| @itemx -mno-fused-madd | |
| Enable (disable) use of the floating-point multiply-accumulate | |
| instructions, when they are available. The default is | |
| @option{-mfused-madd}. | |
| On the R8000 CPU when multiply-accumulate instructions are used, | |
| the intermediate product is calculated to infinite precision | |
| and is not subject to the FCSR Flush to Zero bit. This may be | |
| undesirable in some circumstances. On other processors the result | |
| is numerically identical to the equivalent computation using | |
| separate multiply, add, subtract and negate instructions. | |
| @opindex nocpp | |
| @item -nocpp | |
| Tell the MIPS assembler to not run its preprocessor over user | |
| assembler files (with a @samp{.s} suffix) when assembling them. | |
| @opindex mfix-24k | |
| @opindex mno-fix-24k | |
| @item -mfix-24k | |
| @itemx -mno-fix-24k | |
| Work around the 24K E48 (lost data on stores during refill) errata. | |
| The workarounds are implemented by the assembler rather than by GCC@. | |
| @opindex mfix-r4000 | |
| @opindex mno-fix-r4000 | |
| @item -mfix-r4000 | |
| @itemx -mno-fix-r4000 | |
| Work around certain R4000 CPU errata: | |
| @itemize @minus | |
| @item | |
| A double-word or a variable shift may give an incorrect result if executed | |
| immediately after starting an integer division. | |
| @item | |
| A double-word or a variable shift may give an incorrect result if executed | |
| while an integer multiplication is in progress. | |
| @item | |
| An integer division may give an incorrect result if started in a delay slot | |
| of a taken branch or a jump. | |
| @end itemize | |
| @opindex mfix-r4400 | |
| @opindex mno-fix-r4400 | |
| @item -mfix-r4400 | |
| @itemx -mno-fix-r4400 | |
| Work around certain R4400 CPU errata: | |
| @itemize @minus | |
| @item | |
| A double-word or a variable shift may give an incorrect result if executed | |
| immediately after starting an integer division. | |
| @end itemize | |
| @opindex mfix-r10000 | |
| @opindex mno-fix-r10000 | |
| @item -mfix-r10000 | |
| @itemx -mno-fix-r10000 | |
| Work around certain R10000 errata: | |
| @itemize @minus | |
| @item | |
| @code{ll}/@code{sc} sequences may not behave atomically on revisions | |
| prior to 3.0. They may deadlock on revisions 2.6 and earlier. | |
| @end itemize | |
| This option can only be used if the target architecture supports | |
| branch-likely instructions. @option{-mfix-r10000} is the default when | |
| @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default | |
| otherwise. | |
| @opindex mfix-r5900 | |
| @opindex mno-fix-r5900 | |
| @item -mfix-r5900 | |
| @itemx -mno-fix-r5900 | |
| Do not attempt to schedule the preceding instruction into the delay slot | |
| of a branch instruction placed at the end of a short loop of six | |
| instructions or fewer and always schedule a @code{nop} instruction there | |
| instead. The short loop bug under certain conditions causes loops to | |
| execute only once or twice, due to a hardware bug in the R5900 chip. The | |
| workaround is implemented by the assembler rather than by GCC@. | |
| @opindex mfix-rm7000 | |
| @opindex mno-fix-rm7000 | |
| @item -mfix-rm7000 | |
| @itemx -mno-fix-rm7000 | |
| Work around the RM7000 @code{dmult}/@code{dmultu} errata. The | |
| workarounds are implemented by the assembler rather than by GCC@. | |
| @opindex mfix-vr4120 | |
| @opindex mno-fix-vr4120 | |
| @item -mfix-vr4120 | |
| @itemx -mno-fix-vr4120 | |
| Work around certain VR4120 errata: | |
| @itemize @minus | |
| @item | |
| @code{dmultu} does not always produce the correct result. | |
| @item | |
| @code{div} and @code{ddiv} do not always produce the correct result if one | |
| of the operands is negative. | |
| @end itemize | |
| The workarounds for the division errata rely on special functions in | |
| @file{libgcc.a}. At present, these functions are only provided by | |
| the @code{mips64vr*-elf} configurations. | |
| Other VR4120 errata require a NOP to be inserted between certain pairs of | |
| instructions. These errata are handled by the assembler, not by GCC itself. | |
| @opindex mfix-vr4130 | |
| @opindex mno-fix-vr4130 | |
| @item -mfix-vr4130 | |
| @itemx -mno-fix-vr4130 | |
| Work around the VR4130 @code{mflo}/@code{mfhi} errata. The | |
| workarounds are implemented by the assembler rather than by GCC, | |
| although GCC avoids using @code{mflo} and @code{mfhi} if the | |
| VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi} | |
| instructions are available instead. | |
| @opindex mfix-sb1 | |
| @opindex mno-fix-sb1 | |
| @item -mfix-sb1 | |
| @itemx -mno-fix-sb1 | |
| Work around certain SB-1 CPU core errata. | |
| (This flag currently works around the SB-1 revision 2 | |
| ``F1'' and ``F2'' floating-point errata.) | |
| @opindex mfix4300 | |
| @opindex mno-fix4300 | |
| @item -mfix4300 | |
| @itemx -mno-fix4300 | |
| Work around a bug in early VR4300 silicon that causes multiplies with | |
| certain operands to corrupt immediately following multiplies. | |
| @opindex mr10k-cache-barrier | |
| @item -mr10k-cache-barrier=@var{setting} | |
| Specify whether GCC should insert cache barriers to avoid the | |
| side effects of speculation on R10K processors. | |
| In common with many processors, the R10K tries to predict the outcome | |
| of a conditional branch and speculatively executes instructions from | |
| the ``taken'' branch. It later aborts these instructions if the | |
| predicted outcome is wrong. However, on the R10K, even aborted | |
| instructions can have side effects. | |
| This problem only affects kernel stores and, depending on the system, | |
| kernel loads. As an example, a speculatively-executed store may load | |
| the target memory into cache and mark the cache line as dirty, even if | |
| the store itself is later aborted. If a DMA operation writes to the | |
| same area of memory before the ``dirty'' line is flushed, the cached | |
| data overwrites the DMA-ed data. See the R10K processor manual | |
| for a full description, including other potential problems. | |
| One workaround is to insert cache barrier instructions before every memory | |
| access that might be speculatively executed and that might have side | |
| effects even if aborted. @option{-mr10k-cache-barrier=@var{setting}} | |
| controls GCC's implementation of this workaround. It assumes that | |
| aborted accesses to any byte in the following regions does not have | |
| side effects: | |
| @enumerate | |
| @item | |
| the memory occupied by the current function's stack frame; | |
| @item | |
| the memory occupied by an incoming stack argument; | |
| @item | |
| the memory occupied by an object with a link-time-constant address. | |
| @end enumerate | |
| It is the kernel's responsibility to ensure that speculative | |
| accesses to these regions are indeed safe. | |
| If the input program contains a function declaration such as: | |
| @smallexample | |
| void foo (void); | |
| @end smallexample | |
| then the implementation of @code{foo} must allow @code{j foo} and | |
| @code{jal foo} to be executed speculatively. GCC honors this | |
| restriction for functions it compiles itself. It expects non-GCC | |
| functions (such as hand-written assembly code) to do the same. | |
| The option has three forms: | |
| @table @gcctabopt | |
| @item -mr10k-cache-barrier=load-store | |
| Insert a cache barrier before a load or store that might be | |
| speculatively executed and that might have side effects even | |
| if aborted. | |
| @item -mr10k-cache-barrier=store | |
| Insert a cache barrier before a store that might be speculatively | |
| executed and that might have side effects even if aborted. | |
| @item -mr10k-cache-barrier=none | |
| Disable the insertion of cache barriers. This is the default setting. | |
| @end table | |
| @opindex mflush-func | |
| @opindex mno-flush-func | |
| @item -mflush-func=@var{func} | |
| @itemx -mno-flush-func | |
| Specifies the function to call to flush the I and D caches, or to not | |
| call any such function. If called, the function must take the same | |
| arguments as the common @code{_flush_func}, that is, the address of the | |
| memory range for which the cache is being flushed, the size of the | |
| memory range, and the number 3 (to flush both caches). The default | |
| depends on the target GCC was configured for, but commonly is either | |
| @code{_flush_func} or @code{__cpu_flush}. | |
| @opindex mbranch-cost | |
| @item -mbranch-cost=@var{num} | |
| Set the cost of branches to roughly @var{num} ``simple'' instructions. | |
| This cost is only a heuristic and is not guaranteed to produce | |
| consistent results across releases. A zero cost redundantly selects | |
| the default, which is based on the @option{-mtune} setting. | |
| @opindex mbranch-likely | |
| @opindex mno-branch-likely | |
| @item -mbranch-likely | |
| @itemx -mno-branch-likely | |
| Enable or disable use of Branch Likely instructions, regardless of the | |
| default for the selected architecture. By default, Branch Likely | |
| instructions may be generated if they are supported by the selected | |
| architecture. An exception is for the MIPS32 and MIPS64 architectures | |
| and processors that implement those architectures; for those, Branch | |
| Likely instructions are not be generated by default because the MIPS32 | |
| and MIPS64 architectures specifically deprecate their use. | |
| @opindex mcompact-branches=never | |
| @opindex mcompact-branches=optimal | |
| @opindex mcompact-branches=always | |
| @item -mcompact-branches=never | |
| @itemx -mcompact-branches=optimal | |
| @itemx -mcompact-branches=always | |
| These options control which form of branches are generated. The | |
| default is @option{-mcompact-branches=optimal}. | |
| The @option{-mcompact-branches=never} option ensures that compact branch | |
| instructions are never generated. | |
| The @option{-mcompact-branches=always} option ensures that a compact | |
| branch instruction is generated if available for MIPS Release 6 onwards. | |
| If a compact branch instruction is not available (or pre-R6), | |
| a delay slot form of the branch is used instead. | |
| If it is used for MIPS16/microMIPS targets, it is just ignored now. | |
| The behavior for MIPS16/microMIPS may change in future, | |
| since they do have some compact branch instructions. | |
| The @option{-mcompact-branches=optimal} option causes a delay slot | |
| branch to be used if one is available in the current ISA and the delay | |
| slot is successfully filled. If the delay slot is not filled, a compact | |
| branch is chosen if one is available. | |
| @opindex mfp-exceptions | |
| @opindex mno-fp-exceptions | |
| @item -mfp-exceptions | |
| @itemx -mno-fp-exceptions | |
| Specifies whether FP exceptions are enabled. This affects how | |
| FP instructions are scheduled for some processors. | |
| The default is that FP exceptions are | |
| enabled. | |
| For instance, on the SB-1, if FP exceptions are disabled, and we are emitting | |
| 64-bit code, then we can use both FP pipes. Otherwise, we can only use one | |
| FP pipe. | |
| @opindex mvr4130-align | |
| @item -mvr4130-align | |
| @itemx -mno-vr4130-align | |
| The VR4130 pipeline is two-way superscalar, but can only issue two | |
| instructions together if the first one is 8-byte aligned. When this | |
| option is enabled, GCC aligns pairs of instructions that it | |
| thinks should execute in parallel. | |
| This option only has an effect when optimizing for the VR4130. | |
| It normally makes code faster, but at the expense of making it bigger. | |
| It is enabled by default at optimization level @option{-O3}. | |
| @opindex msynci | |
| @opindex mno-synci | |
| @item -msynci | |
| @itemx -mno-synci | |
| Enable (disable) generation of @code{synci} instructions on | |
| architectures that support it. The @code{synci} instructions (if | |
| enabled) are generated when @code{__builtin___clear_cache} is | |
| compiled. | |
| This option defaults to @option{-mno-synci}, but the default can be | |
| overridden by configuring GCC with @option{--with-synci}. | |
| When compiling code for single processor systems, it is generally safe | |
| to use @code{synci}. However, on many multi-core (SMP) systems, it | |
| does not invalidate the instruction caches on all cores and may lead | |
| to undefined behavior. | |
| @opindex mrelax-pic-calls | |
| @opindex mno-relax-pic-calls | |
| @item -mrelax-pic-calls | |
| @itemx -mno-relax-pic-calls | |
| Try to turn PIC calls that are normally dispatched via register | |
| @code{$25} into direct calls. This is only possible if the linker can | |
| resolve the destination at link time and if the destination is within | |
| range for a direct call. | |
| @option{-mrelax-pic-calls} is the default if GCC was configured to use | |
| an assembler and a linker that support the @code{.reloc} assembly | |
| directive and @option{-mexplicit-relocs} is in effect. With | |
| @option{-mno-explicit-relocs}, this optimization can be performed by the | |
| assembler and the linker alone without help from the compiler. | |
| @opindex mmcount-ra-address | |
| @opindex mno-mcount-ra-address | |
| @item -mmcount-ra-address | |
| @itemx -mno-mcount-ra-address | |
| Emit (do not emit) code that allows @code{_mcount} to modify the | |
| calling function's return address. When enabled, this option extends | |
| the usual @code{_mcount} interface with a new @var{ra-address} | |
| parameter, which has type @code{intptr_t *} and is passed in register | |
| @code{$12}. @code{_mcount} can then modify the return address by | |
| doing both of the following: | |
| @itemize | |
| @item | |
| Returning the new address in register @code{$31}. | |
| @item | |
| Storing the new address in @code{*@var{ra-address}}, | |
| if @var{ra-address} is nonnull. | |
| @end itemize | |
| The default is @option{-mno-mcount-ra-address}. | |
| @opindex mframe-header-opt | |
| @opindex mno-frame-header-opt | |
| @item -mframe-header-opt | |
| @itemx -mno-frame-header-opt | |
| Enable (disable) frame header optimization in the o32 ABI. When using the | |
| o32 ABI, calling functions allocates 16 bytes on the stack for the called | |
| function to write out register arguments. When enabled, this optimization | |
| suppresses the allocation of the frame header if it can be determined that | |
| it is unused. | |
| This optimization is off by default at all optimization levels. | |
| @opindex mlxc1-sxc1 | |
| @opindex mno-lxc1-sxc1 | |
| @item -mlxc1-sxc1 | |
| @itemx -mno-lxc1-sxc1 | |
| When applicable, enable (disable) the generation of @code{lwxc1}, | |
| @code{swxc1}, @code{ldxc1}, @code{sdxc1} instructions. Enabled by default. | |
| @opindex mmadd4 | |
| @opindex mno-madd4 | |
| @item -mmadd4 | |
| @itemx -mno-madd4 | |
| When applicable, enable (disable) the generation of 4-operand @code{madd.s}, | |
| @code{madd.d} and related instructions. Enabled by default. | |
| @end table | |
| @node MMIX Options | |
| @subsection MMIX Options | |
| @cindex MMIX Options | |
| These options are defined for the MMIX: | |
| @table @gcctabopt | |
| @opindex mlibfuncs | |
| @opindex mno-libfuncs | |
| @item -mlibfuncs | |
| @itemx -mno-libfuncs | |
| Specify that intrinsic library functions are being compiled, passing all | |
| values in registers, no matter the size. | |
| @opindex mepsilon | |
| @opindex mno-epsilon | |
| @item -mepsilon | |
| @itemx -mno-epsilon | |
| Generate floating-point comparison instructions that compare with respect | |
| to the @code{rE} epsilon register. | |
| @opindex mabi=mmixware | |
| @opindex mabi=gnu | |
| @item -mabi=mmixware | |
| @itemx -mabi=gnu | |
| Generate code that passes function parameters and return values that (in | |
| the called function) are seen as registers @code{$0} and up, as opposed to | |
| the GNU ABI which uses global registers @code{$231} and up. | |
| @opindex mzero-extend | |
| @opindex mno-zero-extend | |
| @item -mzero-extend | |
| @itemx -mno-zero-extend | |
| When reading data from memory in sizes shorter than 64 bits, use (do not | |
| use) zero-extending load instructions by default, rather than | |
| sign-extending ones. | |
| @opindex mknuthdiv | |
| @opindex mno-knuthdiv | |
| @item -mknuthdiv | |
| @itemx -mno-knuthdiv | |
| Make the result of a division yielding a remainder have the same sign as | |
| the divisor. With the default, @option{-mno-knuthdiv}, the sign of the | |
| remainder follows the sign of the dividend. Both methods are | |
| arithmetically valid, the latter being almost exclusively used. | |
| @opindex mtoplevel-symbols | |
| @opindex mno-toplevel-symbols | |
| @item -mtoplevel-symbols | |
| @itemx -mno-toplevel-symbols | |
| Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly | |
| code can be used with the @code{PREFIX} assembly directive. | |
| @opindex melf | |
| @item -melf | |
| Generate an executable in the ELF format, rather than the default | |
| @samp{mmo} format used by the @command{mmix} simulator. | |
| @opindex mbranch-predict | |
| @opindex mno-branch-predict | |
| @item -mbranch-predict | |
| @itemx -mno-branch-predict | |
| Use (do not use) the probable-branch instructions, when static branch | |
| prediction indicates a probable branch. | |
| @opindex mbase-addresses | |
| @opindex mno-base-addresses | |
| @item -mbase-addresses | |
| @itemx -mno-base-addresses | |
| Generate (do not generate) code that uses @emph{base addresses}. Using a | |
| base address automatically generates a request (handled by the assembler | |
| and the linker) for a constant to be set up in a global register. The | |
| register is used for one or more base address requests within the range 0 | |
| to 255 from the value held in the register. The generally leads to short | |
| and fast code, but the number of different data items that can be | |
| addressed is limited. This means that a program that uses lots of static | |
| data may require @option{-mno-base-addresses}. | |
| @opindex msingle-exit | |
| @opindex mno-single-exit | |
| @item -msingle-exit | |
| @itemx -mno-single-exit | |
| Force (do not force) generated code to have a single exit point in each | |
| function. | |
| @opindex mset-data-start | |
| @item -mset-data-start=@var{address} | |
| When linking, set the start of the data section to @var{address}. | |
| @opindex mset-program-start | |
| @opindex mno-set-program-start | |
| @item -mset-program-start=@var{address} | |
| @itemx -mno-set-program-start | |
| When linking, set the program start address to @var{address}. It | |
| defaults to 0x100 unless @var{-mno-set-program-start} is used to suppress | |
| this option entirely. | |
| @end table | |
| @node MN10300 Options | |
| @subsection MN10300 Options | |
| @cindex MN10300 options | |
| These @option{-m} options are defined for Matsushita MN10300 architectures: | |
| @table @gcctabopt | |
| @opindex mmult-bug | |
| @opindex mno-mult-bug | |
| @item -mmult-bug | |
| @itemx -mno-mult-bug | |
| When enabled, generate code to avoid bugs in the multiply instructions | |
| for the MN10300 processors. This is the default. | |
| @opindex mam33 | |
| @opindex mno-am33 | |
| @item -mam33 | |
| @itemx -mno-am33 | |
| Generate code using features specific to the AM33 processor. | |
| The default is @option{-mno-am33}. | |
| @opindex mam33-2 | |
| @opindex mno-am33-2 | |
| @item -mam33-2 | |
| @itemx -mno-am33-2 | |
| Generate code using features specific to the AM33/2.0 processor. | |
| The default is @option{-mno-am33-2}. | |
| @opindex mam34 | |
| @opindex mno-am34 | |
| @item -mam34 | |
| @itemx -mno-am34 | |
| Generate code using features specific to the AM34 processor. | |
| The default is @option{-mno-am34}. | |
| @opindex mtune | |
| @item -mtune=@var{cpu-type} | |
| Use the timing characteristics of the indicated CPU type when | |
| scheduling instructions. This does not change the targeted processor | |
| type. The CPU type must be one of @samp{mn10300}, @samp{am33}, | |
| @samp{am33-2} or @samp{am34}. | |
| @opindex mreturn-pointer-on-d0 | |
| @opindex mno-return-pointer-on-d0 | |
| @item -mreturn-pointer-on-d0 | |
| @itemx -mno-return-pointer-on-d0 | |
| When generating a function that returns a pointer, return the pointer | |
| in both @code{a0} and @code{d0}. Otherwise, the pointer is returned | |
| only in @code{a0}, and attempts to call such functions without a prototype | |
| result in errors. Note that this option is on by default; use | |
| @option{-mno-return-pointer-on-d0} to disable it. | |
| @opindex mno-crt0 | |
| @item -mno-crt0 | |
| Do not link in the C run-time initialization object file. | |
| @opindex mrelax | |
| @item -mrelax | |
| Indicate to the linker that it should perform a relaxation optimization pass | |
| to shorten branches, calls and absolute memory addresses. This option only | |
| has an effect when used on the command line for the final link step. | |
| This option makes symbolic debugging impossible. | |
| @opindex mliw | |
| @opindex mno-liw | |
| @item -mliw | |
| @itemx -mno-liw | |
| Allow the compiler to generate @emph{Long Instruction Word} | |
| instructions if the target is the @samp{AM33} or later. This option is | |
| enabled by default. | |
| @option{-mliw} defines the preprocessor macro @code{__LIW__}; | |
| @option{-mno-liw} defines the preprocessor macro @code{__NO_LIW__}. | |
| @opindex msetlb | |
| @opindex mno-setlb | |
| @item -msetlb | |
| @itemx -mno-setlb | |
| Allow the compiler to generate the @emph{SETLB} and @emph{Lcc} | |
| instructions if the target is the @samp{AM33} or later. This option is | |
| enabled by default. | |
| @option{-msetlb} defines the preprocessor macro @code{__SETLB__}; | |
| @option{-mno-setlb} defines the preprocessor macro @code{__NO_SETLB__}. | |
| @end table | |
| @node Moxie Options | |
| @subsection Moxie Options | |
| @cindex Moxie Options | |
| @table @gcctabopt | |
| @opindex meb | |
| @item -meb | |
| Generate big-endian code. This is the default for @samp{moxie-*-*} | |
| configurations. | |
| @opindex mel | |
| @item -mel | |
| Generate little-endian code. | |
| @opindex mmul.x | |
| @opindex mno-mul.x | |
| @item -mmul.x | |
| @itemx -mno-mul.x | |
| Generate mul.x and umul.x instructions. This option is enabled by default for | |
| @samp{moxiebox-*-*} configurations. | |
| @opindex mno-crt0 | |
| @item -mno-crt0 | |
| Do not link in the C run-time initialization object file. | |
| @end table | |
| @node MSP430 Options | |
| @subsection MSP430 Options | |
| @cindex MSP430 Options | |
| These options are defined for the MSP430: | |
| @table @gcctabopt | |
| @opindex masm-hex | |
| @opindex mno-asm-hex | |
| @item -masm-hex | |
| Force assembly output to always use hex constants. Normally such | |
| constants are signed decimals, but this option is available for | |
| testsuite and/or aesthetic purposes. | |
| @opindex mmcu= | |
| @item -mmcu=@var{name} | |
| Select the MCU to target. This is used to create a C preprocessor | |
| symbol based upon the MCU name, converted to upper case and pre- and | |
| post-fixed with @samp{__}. This in turn is used by the | |
| @file{msp430.h} header file to select an MCU-specific supplementary | |
| header file. | |
| The option also sets the ISA to use. If the MCU name is one that is | |
| known to only support the 430 ISA then that is selected, otherwise the | |
| 430X ISA is selected. A generic MCU name of @samp{msp430} can also be | |
| used to select the 430 ISA. Similarly the generic @samp{msp430x} MCU | |
| name selects the 430X ISA. | |
| In addition an MCU-specific linker script is added to the linker | |
| command line. The script's name is the name of the MCU with | |
| @file{.ld} appended. Thus specifying @option{-mmcu=xxx} on the @command{gcc} | |
| command line defines the C preprocessor symbol @code{__XXX__} and | |
| cause the linker to search for a script called @file{xxx.ld}. | |
| The ISA and hardware multiply supported for the different MCUs is hard-coded | |
| into GCC. However, an external @file{devices.csv} file can be used to | |
| extend device support beyond those that have been hard-coded. | |
| GCC searches for the @file{devices.csv} file using the following methods in the | |
| given precedence order, where the first method takes precedence over the | |
| second which takes precedence over the third. | |
| @table @asis | |
| @item Include path specified with @option{-I} and @option{-L} | |
| @file{devices.csv} is searched for in each of the directories specified by | |
| include paths and linker library search paths. | |
| @item Path specified by the environment variable @env{MSP430_GCC_INCLUDE_DIR} | |
| Define the value of the global environment variable | |
| @env{MSP430_GCC_INCLUDE_DIR} | |
| to the full path to the directory containing @file{devices.csv}, | |
| and GCC will search | |
| this directory for @file{devices.csv}. | |
| If @file{devices.csv} is found, this directory is | |
| also registered as an include path and linker library path. Header files | |
| and linker scripts in this directory can therefore be used without manually | |
| specifying @option{-I} and @option{-L} on the command line. | |
| @item The @file{msp430-elf@{,bare@}/include/devices} directory | |
| Finally, GCC examines @file{msp430-elf@{,bare@}/include/devices} from the | |
| toolchain root directory. This directory does not exist in a default | |
| installation, but if you have created it and copied @file{devices.csv} | |
| there, then the MCU data is read. As above, this directory is | |
| also registered as an include path and linker library path. | |
| @end table | |
| If none of the above search methods find @file{devices.csv}, then the | |
| hard-coded MCU data is used. | |
| @opindex mwarn-mcu | |
| @opindex mno-warn-mcu | |
| @item -mwarn-mcu | |
| @itemx -mno-warn-mcu | |
| This option enables or disables warnings about conflicts between the | |
| MCU name specified by the @option{-mmcu} option and the ISA set by the | |
| @option{-mcpu} option and/or the hardware multiply support set by the | |
| @option{-mhwmult} option. It also toggles warnings about unrecognized | |
| MCU names. This option is on by default. | |
| @opindex msim | |
| @opindex mno-sim | |
| @item -msim | |
| Link to the simulator runtime libraries and linker script. Overrides | |
| any scripts that would be selected by the @option{-mmcu=} option. | |
| @opindex mlarge | |
| @item -mlarge | |
| Use large-model addressing (20-bit pointers, 20-bit @code{size_t}). | |
| @opindex msmall | |
| @item -msmall | |
| Use small-model addressing (16-bit pointers, 16-bit @code{size_t}). | |
| @opindex mrelax | |
| @opindex mno-relax | |
| @item -mrelax | |
| This option is passed to the assembler and linker, and allows the | |
| linker to perform certain optimizations that cannot be done until | |
| the final link. | |
| @opindex mhwmult | |
| @item mhwmult=@var{type} | |
| Describes the type of hardware multiply supported by the target. | |
| Accepted values for @var{type} are @samp{none} for no hardware multiply, | |
| @samp{16bit} | |
| for the original 16-bit-only multiply supported by early MCUs. | |
| @samp{32bit} for the 16/32-bit multiply supported by later MCUs and | |
| @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs. | |
| A value of @samp{auto} can also be given. This tells GCC to deduce | |
| the hardware multiply support based upon the MCU name provided by the | |
| @option{-mmcu} option. If no @option{-mmcu} option is specified or if | |
| the MCU name is not recognized, then no hardware multiply support is | |
| assumed. @code{auto} is the default setting. | |
| Hardware multiplies are normally performed by calling a library | |
| routine. This saves space in the generated code. When compiling at | |
| @option{-O3} or higher however the hardware multiplier is invoked | |
| inline. This makes for bigger, but faster code. | |
| The hardware multiply routines disable interrupts whilst running and | |
| restore the previous interrupt state when they finish. This makes | |
| them safe to use inside interrupt handlers as well as in normal code. | |
| @opindex minrt | |
| @item -minrt | |
| Enable the use of a minimum runtime environment without support for static | |
| initializers or constructors. This is intended for memory-constrained | |
| devices. The compiler includes special symbols in some objects | |
| that tell the linker and runtime which code fragments are required. | |
| @opindex mtiny-printf | |
| @opindex mno-tiny-printf | |
| @item -mtiny-printf | |
| Enable reduced code size @code{printf} and @code{puts} library functions. | |
| The @samp{tiny} implementations of these functions are not reentrant, so | |
| must be used with caution in multi-threaded applications. | |
| Support for streams has been removed and the string to be printed are | |
| always sent to stdout via the @code{write} syscall. The string is not | |
| buffered before it is sent to write. | |
| This option requires Newlib Nano IO, so GCC must be configured with | |
| @samp{--enable-newlib-nano-formatted-io}. | |
| @opindex mmax-inline-shift= | |
| @item -mmax-inline-shift=@var{n} | |
| This option takes an integer @var{n} between 0 and 64 inclusive, and sets | |
| the maximum number of inline shift instructions which should be emitted to | |
| perform a shift operation by a constant amount. When this value needs to be | |
| exceeded, an mspabi helper function is used instead. The default value is 4. | |
| This only affects cases where a shift by multiple positions cannot be | |
| completed with a single instruction (e.g. all shifts >1 on the 430 ISA). | |
| Shifts of a 32-bit value are at least twice as costly, so the value passed for | |
| this option is divided by 2 and the resulting value used instead. | |
| @opindex mcode-region | |
| @opindex mdata-region | |
| @item -mcode-region=@var{where} | |
| @itemx -mdata-region=@var{where} | |
| These options tell the compiler where to place functions and data that | |
| do not have one of the @code{lower}, @code{upper}, @code{either} or | |
| @code{section} attributes. Possible values for @var{where} are @samp{lower}, | |
| @samp{upper}, @samp{either} or @samp{any}. The first three behave | |
| like the corresponding attribute. The fourth possible value, | |
| @samp{any}, is the default. It leaves placement entirely up to the | |
| linker script and how it assigns the standard sections | |
| (@code{.text}, @code{.data}, etc) to the memory regions. | |
| @opindex muse-lower-region-prefix | |
| @opindex mno-use-lower-region-prefix | |
| @item -muse-lower-region-prefix | |
| Add the @samp{.lower} prefix to section names when compiling with | |
| @option{-mcode-region=lower} or @option{-mdata-region=lower}. Disabled | |
| by default. | |
| @opindex msilicon-errata | |
| @item -msilicon-errata=@var{name}@r{[},@var{name}@dots{}@r{]} | |
| This option passes on a request to assembler to enable the fixes for | |
| the named silicon errata. Refer to the assembler documentation for details. | |
| @opindex msilicon-errata-warn | |
| @item -msilicon-errata-warn=@var{name}@r{[},@var{name}@dots{}@r{]} | |
| This option passes on a request to the assembler to enable warning | |
| messages when a named silicon errata might need to be applied. Refer to the | |
| assembler documentation for details. | |
| @opindex mwarn-devices-csv | |
| @opindex mno-warn-devices-csv | |
| @item -mwarn-devices-csv | |
| @itemx -mno-warn-devices-csv | |
| Warn if @file{devices.csv} is not found or there are problems parsing it | |
| (default: on). | |
| @end table | |
| @node NDS32 Options | |
| @subsection NDS32 Options | |
| @cindex NDS32 Options | |
| These options are defined for NDS32 implementations: | |
| @table @gcctabopt | |
| @opindex mbig-endian | |
| @opindex EB | |
| @item -mbig-endian | |
| @itemx -EB | |
| Generate code in big-endian mode. | |
| @opindex mlittle-endian | |
| @opindex EL | |
| @item -mlittle-endian | |
| @itemx -EL | |
| Generate code in little-endian mode. | |
| @opindex mabi | |
| @opindex mfloat-abi | |
| @item -mabi=2 | |
| @itemx -mfloat-abi=soft | |
| Use the soft floating-point ABI. | |
| @item -mabi=2fp+ | |
| @itemx -mfloat-abi=hard | |
| Use the hard floating-point ABI. | |
| @opindex mreduced-regs | |
| @item -mreduced-regs | |
| Use reduced-set registers for register allocation. | |
| @opindex mfull-regs | |
| @item -mfull-regs | |
| Use full-set registers for register allocation. | |
| @opindex malways-align | |
| @opindex mno-always-align | |
| @item -malways-align | |
| Always align function entry, jump targets, and return address. | |
| @opindex malign-functions | |
| @opindex mno-align-functions | |
| @item -malign-functions | |
| Align function entry to 4 bytes. | |
| @opindex mfp-as-gp | |
| @opindex mno-fp-as-gp | |
| @item -mfp-as-gp | |
| @itemx -mno-fp-as-gp | |
| Enable/disable fp-as-gp optimization. | |
| @opindex mcmov | |
| @opindex mno-cmov | |
| @item -mcmov | |
| @itemx -mno-cmov | |
| Enable/disable generation of conditional move instructions. | |
| @opindex mhw-abs | |
| @opindex mno-hw-abs | |
| @item -mhw-abs | |
| @itemx -mno-hw-abs | |
| Enable/disable generation of hardware abs instructions. | |
| @opindex mext-perf | |
| @opindex mno-ext-perf | |
| @item -mext-perf | |
| @itemx -mno-ext-perf | |
| Enable/disable generation of performance extension instructions. | |
| @opindex mext-perf2 | |
| @opindex mno-ext-perf2 | |
| @item -mext-perf2 | |
| @itemx -mno-ext-perf2 | |
| Enable/disable generation of performance extension 2 instructions. | |
| @opindex mext-string | |
| @opindex mno-ext-string | |
| @item -mext-string | |
| @itemx -mno-ext-string | |
| Enable/disable generation of string extension instructions. | |
| @opindex mext-dsp | |
| @opindex mno-ext-dsp | |
| @item -mext-dsp | |
| @itemx -mno-ext-dsp | |
| Enable/disable generation of DSP extension instructions. | |
| @opindex mext-fpu-fma | |
| @opindex mno-ext-fpu-fma | |
| @item -mext-fpu-fma | |
| @itemx -mno-ext-fpu-fma | |
| Enable/disable generation of floating-point multiply-accumulation instructions. | |
| @opindex mext-fpu-sp | |
| @opindex mno-ext-fpu-sp | |
| @item -mext-fpu-sp | |
| @itemx -mno-ext-fpu-sp | |
| Enable/disable generation of single-precision floating-point instructions. | |
| @opindex mext-fpu-dp | |
| @opindex mno-ext-fpu-dp | |
| @item -mext-fpu-dp | |
| @itemx -mno-ext-fpu-dp | |
| Enable/disable generation of double-precision floating-point instructions. | |
| @opindex mv3push | |
| @opindex mno-v3push | |
| @item -mv3push | |
| @itemx -mno-v3push | |
| Enable/disable generation of v3 push25/pop25 instructions. | |
| @opindex m16-bit | |
| @opindex mno-16-bit | |
| @item -m16-bit | |
| @itemx -mno-16-bit | |
| Enable/disable generation of 16-bit instructions. | |
| @opindex mvh | |
| @opindex mno-vh | |
| @item -mvh | |
| @itemx -mno-vh | |
| Enable/disable Virtual Hosting support. | |
| @opindex misr-vector-size | |
| @item -misr-vector-size=@var{num} | |
| Specify the size of each interrupt vector, which must be 4 or 16. | |
| @opindex misr-secure | |
| @item -misr-secure=@var{num} | |
| Specify the security level of c-isr for the whole file. | |
| @opindex mcache-block-size | |
| @item -mcache-block-size=@var{num} | |
| Specify the size of each cache block, | |
| which must be a power of 2 between 4 and 512. | |
| @opindex march= | |
| @item -march=@var{arch} | |
| Specify the target architecture. @var{arch} may be one of | |
| @samp{v2}, @samp{v3}, @samp{v3j}, @samp{v3m}, @samp{v3f}, or @samp{v3s}. | |
| @opindex mcpu= | |
| @item -mcpu=@var{cpu} | |
| Specify the CPU to compile for. @var{cpu} may be one of | |
| @samp{n6}, @samp{n650}, @samp{n7}, @samp{n705}, @samp{n8}, @samp{n801}, | |
| @samp{sn8}, @samp{sn801}, @samp{s8}, @samp{s801}, @samp{e8}, @samp{e801}, | |
| @samp{n820}, @samp{s830}, @samp{e830}, @samp{n9}, @samp{n903}, @samp{n903a}, | |
| @samp{n968}, @samp{n968a}, @samp{n10}, @samp{n1033}, @samp{n1033a}, | |
| @samp{n1033-fpu}, @samp{n1033-spu}, @samp{n1068}, @samp{n1068a}, | |
| @samp{n1068-fpu}, @samp{n1068a-fpu}, @samp{d10}, @samp{d1088}, | |
| @samp{d1088-fpu}, @samp{d1088-spu}, @samp{n15}, @samp{d15}, @samp{n15s}, | |
| @samp{d15s}, @samp{n15f}, @samp{d15f}, @samp{n12}, @samp{n1213}, | |
| @samp{n1233}, @samp{n1233-fpu}, @samp{n1233-spu}, @samp{n13}, @samp{n1337}, | |
| @samp{n1337-fpu}, @samp{n1337-spu}, or @samp{simple}. | |
| @opindex mconfig-fpu= | |
| @item -mconfig-fpu=@var{num} | |
| Specify a FPU configuration value from 0 to 7; 0--3 is as FPU spec says, | |
| and 4--7 correspond to 0--3. | |
| @opindex mconfig-mul= | |
| @item -mconfig-mul=@var{type} | |
| Specify configuration for multiply instruction. @var{type} can be one of | |
| @samp{fast}, @samp{fast1} (equivalent to @samp{fast}), @samp{fast2}, or | |
| @samp{slow}. The default is @samp{fast1}. | |
| @opindex mconfig-register-ports= | |
| @item -mconfig-register-ports=@var{kind} | |
| Specify the numbers of read/write ports for n9/n10 cores. The value should | |
| be @samp{3r2w} or @samp{2r1w}. | |
| @opindex mcmodel= | |
| @item -mcmodel=@var{code-model} | |
| Set the code model to one of: | |
| @table @asis | |
| @item @samp{small} | |
| All the data and read-only data segments must be within 512KB addressing space. | |
| The text segment must be within 16MB addressing space. | |
| @item @samp{medium} | |
| The data segment must be within 512KB while the read-only data segment can be | |
| within 4GB addressing space. The text segment should be still within 16MB | |
| addressing space. | |
| @item @samp{large} | |
| All the text and data segments can be within 4GB addressing space. | |
| @end table | |
| The default is @samp{large} on GNU/Linux targets and @samp{medium} on other | |
| ELF targets. | |
| @opindex mctor-dtor | |
| @opindex mno-ctor-dtor | |
| @item -mctor-dtor | |
| @itemx -mno-ctor-dtor | |
| Enable/disable constructor/destructor feature. | |
| @opindex mrelax | |
| @opindex mno-relax | |
| @item -mrelax | |
| @itemx -mno-relax | |
| Enable/disable linker option to relax instructions. | |
| @opindex mrelax-hint | |
| @opindex mno-relax-hint | |
| @item -mrelax-hint | |
| @itemx -mno-relax-hint | |
| Enable/disable insertion of hints for linker to do relaxation. | |
| @opindex msched-prolog-epilog | |
| @opindex mno-sched-prolog-epilog | |
| @item -msched-prolog-epilog | |
| @itemx -mno-sched-prolog-epilog | |
| Enable/disable scheduling of a function's prologue and epilogue sequence. | |
| @opindex mret-in-naked-func | |
| @opindex mno-ret-in-naked-func | |
| @item -mret-in-naked-func | |
| @itemx -mno-ret-in-naked-func | |
| Enable/disable generation of return instructions in naked functions. This | |
| option is enabled by default. | |
| @opindex malways-save-lp | |
| @opindex mno-always-save-lp | |
| @item -malways-save-lp | |
| @itemx -mno-always-save-lp | |
| Enable/disable always saving @code{$lp} on the stack. | |
| @opindex munaligned-access | |
| @opindex mno-unaligned-access | |
| @item -munaligned-access | |
| @itemx -mno-unaligned-access | |
| Enable/disable unaligned word and halfword accesses to packed data. | |
| @opindex minline-asm-r15 | |
| @opindex mno-inline-asm-r15 | |
| @item -minline-asm-r15 | |
| @itemx -mno-inline-asm-r15 | |
| Allow/disallow use of r15 for inline asm. | |
| @end table | |
| @node Nvidia PTX Options | |
| @subsection Nvidia PTX Options | |
| @cindex Nvidia PTX options | |
| @cindex nvptx options | |
| These options are defined for Nvidia PTX: | |
| @table @gcctabopt | |
| @opindex m64 | |
| @item -m64 | |
| Ignored, but preserved for backward compatibility. Only 64-bit ABI is | |
| supported. | |
| @opindex march | |
| @item -march=@var{architecture-string} | |
| Generate code for the specified PTX ISA target architecture. | |
| Valid architecture strings are | |
| @samp{sm_30}, @samp{sm_35}, @samp{sm_37}, | |
| @samp{sm_50}, @samp{sm_52}, @samp{sm_53}, | |
| @samp{sm_61}, | |
| @samp{sm_70}, @samp{sm_75}, | |
| @samp{sm_80}, and @samp{sm_89}. | |
| The default depends on how the compiler has been configured, see | |
| @option{--with-arch}. | |
| This option sets the value of the preprocessor macro | |
| @code{__PTX_SM__}; for instance, for @samp{sm_35}, it has the value | |
| @samp{350}. | |
| @opindex misa | |
| @item -misa=@var{architecture-string} | |
| Alias of @option{-march=}. | |
| @opindex march-map | |
| @item -march-map=@var{architecture-string} | |
| Select the closest available @option{-march=} value that is not more | |
| capable. For instance, for @option{-march-map=sm_50} select | |
| @option{-march=sm_37}, and for @option{-march-map=sm_53} select | |
| @option{-march=sm_53}. | |
| @opindex mptx | |
| @item -mptx=@var{version-string} | |
| Generate code for the specified PTX ISA version. | |
| Valid version strings are | |
| @samp{3.1}, | |
| @samp{4.0}, @samp{4.1}, @samp{4.2}, | |
| @samp{5.0}, | |
| @samp{6.0}, @samp{6.3}, | |
| @samp{7.0}, @samp{7.3}, and @samp{7.8}. | |
| The default PTX ISA version is the one that added support for the | |
| selected PTX ISA target architecture, see @option{-march=}, but at | |
| least @samp{6.3}, or @samp{7.3} for @option{-march=sm_52} and higher. | |
| This option sets the values of the preprocessor macros | |
| @code{__PTX_ISA_VERSION_MAJOR__} and @code{__PTX_ISA_VERSION_MINOR__}; | |
| for instance, for @samp{3.1} the macros have the values @samp{3} and | |
| @samp{1}, respectively. | |
| @opindex mmainkernel | |
| @item -mmainkernel | |
| Link in code for a __main kernel. This is for stand-alone instead of | |
| offloading execution. | |
| @opindex moptimize | |
| @opindex mno-optimize | |
| @item -moptimize | |
| @itemx -mno-optimize | |
| Enable/disable partitioned execution optimizations. This option is enabled by | |
| default when any level of optimization is selected. | |
| @opindex msoft-stack | |
| @opindex mno-soft-stack | |
| @item -msoft-stack | |
| @itemx -mno-soft-stack | |
| For @option{-mno-soft-stack} (the default, unless @option{-mgomp} has | |
| been specified), use PTX ``native'' stacks, that is, | |
| generate code that uses @code{.local} memory or PTX @code{alloca} | |
| directly for stack storage. | |
| Unless @option{-mptx=7.3} or higher and @option{-march=sm_52} or | |
| higher are active, variable-length arrays and dynamically allocating | |
| memory on the stack with @code{alloca} are not supported. | |
| For @option{-msoft-stack} (implied by @option{-mgomp}), | |
| generate code that does not use @code{.local} memory or PTX @code{alloca} | |
| directly for stack storage. Instead, a per-warp stack pointer is | |
| maintained explicitly. This enables variable-length stack allocation (with | |
| variable-length arrays or @code{alloca}), and when global memory is used for | |
| underlying storage, makes it possible to access automatic variables from other | |
| threads, or with atomic instructions. This code generation variant is used | |
| for OpenMP offloading, but the option is exposed on its own for the purpose | |
| of testing the compiler; to generate code suitable for linking into programs | |
| using OpenMP offloading, use option @option{-mgomp}. | |
| @opindex msoft-stack-reserve-local | |
| @item -msoft-stack-reserve-local=@var{size} | |
| Specify the size of @code{.local} memory used for the stack when the | |
| exact amount is not known. It defaults to 128. | |
| @opindex muniform-simt | |
| @opindex mno-uniform-simt | |
| @item -muniform-simt | |
| @itemx -mno-uniform-simt | |
| Enable/disable code generation variant that allows execution of | |
| all threads in each | |
| warp, while maintaining memory state and side effects as if only one thread | |
| in each warp was active outside of OpenMP SIMD regions. All atomic operations | |
| and calls to runtime (@code{malloc}, @code{free}, @code{vprintf}) | |
| are conditionally executed (iff | |
| current lane index equals the master lane index), and the register being | |
| assigned is copied via a shuffle instruction from the master lane. Outside of | |
| SIMD regions lane 0 is the master; inside, each thread sees itself as the | |
| master. Shared memory array @code{int __nvptx_uni[]} stores all-zeros or | |
| all-ones bitmasks for each warp, indicating current mode (0 outside of SIMD | |
| regions). Each thread can bitwise-and the bitmask at position @code{tid.y} | |
| with current lane index to compute the master lane index. | |
| @opindex mgomp | |
| @opindex mno-gomp | |
| @item -mgomp | |
| @itemx -mno-gomp | |
| Enable/disable generation of code for use in OpenMP offloading. | |
| @option{-mgomp} enables @option{-msoft-stack} and | |
| @option{-muniform-simt} options, and selects a corresponding multilib variant. | |
| @end table | |
| @node OpenRISC Options | |
| @subsection OpenRISC Options | |
| @cindex OpenRISC Options | |
| These options are defined for OpenRISC: | |
| @table @gcctabopt | |
| @opindex mboard | |
| @item -mboard=@var{name} | |
| Configure a board specific runtime. This is passed to the linker for | |
| newlib board library linking. The default is @code{or1ksim}. | |
| @opindex msoft-div | |
| @opindex mhard-div | |
| @item -msoft-div | |
| @itemx -mhard-div | |
| Select software or hardware divide (@code{l.div}, @code{l.divu}) instructions. | |
| This default is hardware divide. | |
| @opindex msoft-mul | |
| @opindex mhard-mul | |
| @item -msoft-mul | |
| @itemx -mhard-mul | |
| Select software or hardware multiply (@code{l.mul}, @code{l.muli}) instructions. | |
| This default is hardware multiply. | |
| @opindex msoft-float | |
| @opindex mhard-float | |
| @item -msoft-float | |
| @itemx -mhard-float | |
| Select software or hardware for floating point operations. | |
| The default is software. | |
| @opindex mdouble-float | |
| @opindex mno-double-float | |
| @item -mdouble-float | |
| When @option{-mhard-float} is selected, enables generation of double-precision | |
| floating point instructions. By default functions from @file{libgcc} are used | |
| to perform double-precision floating point operations. | |
| @opindex munordered-float | |
| @item -munordered-float | |
| When @option{-mhard-float} is selected, enables generation of unordered | |
| floating point compare and set flag (@code{lf.sfun*}) instructions. By default | |
| functions from @file{libgcc} are used to perform unordered floating point | |
| compare and set flag operations. | |
| @opindex mcmov | |
| @item -mcmov | |
| Enable generation of conditional move (@code{l.cmov}) instructions. By | |
| default the equivalents are generated using set and branch. | |
| @opindex mror | |
| @item -mror | |
| Enable generation of rotate right (@code{l.ror}) instructions. By default | |
| functions from @file{libgcc} are used to perform rotate right operations. | |
| @opindex mrori | |
| @item -mrori | |
| Enable generation of rotate right with immediate (@code{l.rori}) instructions. | |
| By default functions from @file{libgcc} are used to perform rotate right with | |
| immediate operations. | |
| @opindex msext | |
| @item -msext | |
| Enable generation of sign extension (@code{l.ext*}) instructions. By default | |
| memory loads are used to perform sign extension. | |
| @opindex msfimm | |
| @item -msfimm | |
| Enable generation of compare and set flag with immediate (@code{l.sf*i}) | |
| instructions. By default extra instructions are generated to store the | |
| immediate to a register first. | |
| @opindex mshftimm | |
| @item -mshftimm | |
| Enable generation of shift with immediate (@code{l.srai}, @code{l.srli}, | |
| @code{l.slli}) instructions. By default extra instructions are generated | |
| to store the immediate to a register first. | |
| @opindex mcmodel= | |
| @opindex mcmodel=small | |
| @item -mcmodel=small | |
| Generate OpenRISC code for the small model: The GOT is limited to 64k and | |
| function call jumps are limited to 64M offsets. This is the default model. | |
| @opindex mcmodel=large | |
| @item -mcmodel=large | |
| Generate OpenRISC code for the large model: The GOT may grow up to 4G in size | |
| and function call jumps can target the full 4G address space. | |
| @end table | |
| @node PDP-11 Options | |
| @subsection PDP-11 Options | |
| @cindex PDP-11 Options | |
| These options are defined for the PDP-11: | |
| @table @gcctabopt | |
| @opindex mfpu | |
| @item -mfpu | |
| Use hardware FPP floating point. This is the default. (FIS floating | |
| point on the PDP-11/40 is not supported.) Implies @option{-m45}. | |
| @opindex msoft-float | |
| @item -msoft-float | |
| Do not use hardware floating point. | |
| @opindex mac0 | |
| @opindex mno-ac0 | |
| @item -mac0 | |
| @itemx -mno-ac0 | |
| With @option{-mac0}, return floating-point results in ac0 | |
| (fr0 in Unix assembler syntax). The default, @option{-mno-ac0}, is | |
| to return floating-point results in memory. | |
| @opindex m40 | |
| @item -m40 | |
| Generate code for a PDP-11/40. | |
| Implies @option{-msoft-float} @option{-mno-split}. | |
| @opindex m45 | |
| @item -m45 | |
| Generate code for a PDP-11/45. This is the default. | |
| @opindex m10 | |
| @item -m10 | |
| Generate code for a PDP-11/10. | |
| Implies @option{-msoft-float} @option{-mno-split}. | |
| @opindex mint16 | |
| @opindex mno-int32 | |
| @item -mint16 | |
| @itemx -mno-int32 | |
| Use 16-bit @code{int}. This is the default. | |
| @opindex mint32 | |
| @opindex mno-int16 | |
| @item -mint32 | |
| @itemx -mno-int16 | |
| Use 32-bit @code{int}. | |
| @opindex msplit | |
| @opindex mno-split | |
| @item -msplit | |
| Target has split instruction and data space. Implies @option{-m45}. | |
| @opindex munix-asm | |
| @item -munix-asm | |
| Use Unix assembler syntax. | |
| @opindex mdec-asm | |
| @item -mdec-asm | |
| Use DEC assembler syntax. | |
| @opindex mgnu-asm | |
| @item -mgnu-asm | |
| Use GNU assembler syntax. This is the default. | |
| @opindex mlra | |
| @opindex mno-lra | |
| @item -mlra | |
| Use the new LRA register allocator. By default, the old ``reload'' | |
| allocator is used. | |
| @end table | |
| @node Picolibc Options | |
| @subsection Picolibc Options | |
| @cindex Picolibc options | |
| @cindex options, Picolibc | |
| These options control compilation and linking when using Picolibc: | |
| @table @gcctabopt | |
| @opindex oslib | |
| @item --oslib=@var{library} | |
| Search the library named @var{library} after the C library, permitting | |
| symbols undefined by the C library to be defined by this library. The | |
| C library, libgcc and this library are placed between | |
| @option{--start-group} and @option{--end-group} flags so that each can | |
| refer to symbols in the others. For many targets, Picolibc provides a | |
| @samp{semihost} variant (specified with @option{--oslib=semihost}) | |
| which provides enough basic OS functionality to support console and | |
| file I/O when run in an emulator or when using an in-circuit debugger. | |
| @opindex crt0 | |
| @item --crt0=@r{[}none@r{|}minimal@r{|}hosted@r{|}semihost@r{]} | |
| Replace the default @file{crt0.o} name with | |
| @file{crt0-@var{variant}.o}. The @samp{none} variant provides no | |
| startup code at all, allowing you to supply your | |
| own. @samp{minimal} performs basic memory setup but does not invoke | |
| any constructors. When no @option{-crt0} option is provided, the | |
| default initialization code adds calls to all | |
| constructors. @samp{hosted} adds a call to @code{exit} when | |
| @code{main} returns. @samp{semihost} accesses a command-line parameter | |
| supplied via the semihosting interface and splits that into arguments | |
| at whitespace boundaries, passing the resulting array of strings to | |
| @code{main} in @code{argc} and @code{argv}. On some targets, including | |
| AArch64, ARC, ARM, LoongArch, M680x0, RISC-V, SH, and x86, | |
| @samp{semihost} also traps hardware exceptions and prints information | |
| to the console. Note that @option{--crt0=semihost} depends upon APIs | |
| provided by @option{--oslib=semihost}. | |
| @opindex printf | |
| @item --printf=@r{[}d@r{|}f@r{|}l@r{|}i@r{|}m@r{]} | |
| Select the @code{printf} variant. | |
| Picolibc provides five different @code{printf} | |
| variants which offer decreasing levels of functionality along with | |
| decreasing code size. @samp{d} is the default level, offering full C17 | |
| and POSIX.1-2024 conformance. @samp{f} provides the same feature set, | |
| but supports @code{float} values instead of @code{double} which are | |
| passed using the @code{printf_float} macro. @samp{l} elides all | |
| floating-point and POSIX positional parameter support. @samp{i} limits | |
| integers to those no larger than @code{long}. @samp{m} removes support | |
| for most formatting options including width and precision. The formats | |
| and arguments are still parsed correctly, but output does not respect | |
| those parameters. | |
| @opindex scanf | |
| @item --scanf=@r{[}d@r{|}f@r{|}l@r{|}i@r{|}m@r{]} | |
| Select the @code{scanf} variant. | |
| Picolibc provides five different @code{scanf} | |
| variants which offer decreasing levels of functionality along with | |
| decreasing code size. @samp{d} is the default level, offering full C17 | |
| and POSIX.1-2024 conformance. @samp{f} removes support for | |
| @code{double} values. @samp{l} elides all floating point | |
| support. @samp{i} limits integers to those no larger than | |
| @code{long}. @samp{m} removes support for @samp{%[} conversion specifiers. | |
| @end table | |
| @node PowerPC Options | |
| @subsection PowerPC Options | |
| @cindex PowerPC options | |
| These are listed under @xref{RS/6000 and PowerPC Options}. | |
| @node PRU Options | |
| @subsection PRU Options | |
| @cindex PRU Options | |
| These command-line options are defined for PRU target: | |
| @table @gcctabopt | |
| @opindex minrt | |
| @item -minrt | |
| Link with a minimum runtime environment. This can significantly reduce | |
| the size of the final ELF binary, but some standard C runtime features | |
| are removed. | |
| This option disables support for static initializers and constructors. | |
| Beware that the compiler could still generate code with static initializers | |
| and constructors. It is up to the programmer to ensure that the source | |
| program does not use those features. | |
| The minimal startup code does not pass @code{argc} and @code{argv} arguments | |
| to @code{main}, so the latter must be declared as @code{int main (void)}. | |
| This is already the norm for most firmware projects. | |
| @opindex mmcu | |
| @item -mmcu=@var{mcu} | |
| Specify the PRU hardware variant to use. A correspondingly-named | |
| spec file is loaded, passing the memory region sizes to | |
| the linker and defining hardware-specific C macros. | |
| Newlib provides only the @code{sim} spec, intended for running | |
| regression tests using a simulator. Specs for real hardware can be | |
| obtained by installing the | |
| @w{@uref{https://github.com/dinuxbg/gnuprumcu/,GnuPruMcu}} package. | |
| @opindex mno-relax | |
| @item -mno-relax | |
| Make GCC pass the @option{--no-relax} command-line option to the linker | |
| instead of the @option{--relax} option. | |
| @opindex mloop | |
| @opindex mno-loop | |
| @item -mloop | |
| @itemx -mno-loop | |
| Allow (or do not allow) GCC to use the LOOP instruction. | |
| @opindex mmul | |
| @opindex mno-mul | |
| @item -mmul | |
| @itemx -mno-mul | |
| Allow (or do not allow) GCC to use the PRU multiplier unit. | |
| @opindex mfillzero | |
| @opindex mno-fillzero | |
| @item -mfillzero | |
| @itemx -mno-fillzero | |
| Allow (or do not allow) GCC to use the FILL and ZERO instructions. | |
| @opindex mabi | |
| @item -mabi=@var{variant} | |
| Specify the ABI variant to output code for. @option{-mabi=ti} selects the | |
| unmodified TI ABI, while @option{-mabi=gnu} selects a GNU variant that copes | |
| more naturally with certain GCC assumptions. These are the differences: | |
| @table @samp | |
| @item Function Pointer Size | |
| TI ABI specifies that function (code) pointers are 16-bit, whereas GNU | |
| supports only 32-bit data and code pointers. | |
| @item Optional Return Value Pointer | |
| Function return values larger than 64 bits are passed by using a hidden | |
| pointer as the first argument of the function. TI ABI, though, mandates that | |
| the pointer can be NULL in case the caller is not using the returned value. | |
| GNU always passes and expects a valid return value pointer. | |
| @item Size Of Struct Containing Bit-fields | |
| TI ABI mandates that struct size is determined by the bit-field type, if it | |
| contains any. On the other hand, | |
| GNU allocates the smallest amount of bytes which would | |
| fit the bit-field. | |
| For example, TI ABI reserves 4 bytes for this struct, whereas GNU reserves | |
| a single byte: | |
| @smallexample | |
| struct S @{ int i:1; @}; | |
| @end smallexample | |
| @item Access Size For Volatile Bit-fields | |
| TI ABI mandates that volatile bit-fields are accessed using their type. | |
| In contrast, GNU ABI uses the smallest integer type fitting the bit-field. | |
| For example, TI ABI requires a single load of 4 bytes for the | |
| following bit-field. GNU generates a load of 1 byte: | |
| @smallexample | |
| struct S @{ volatile int i:1; @}; | |
| @end smallexample | |
| @end table | |
| The current @option{-mabi=ti} implementation simply raises a compile error | |
| when any of the above code constructs is detected. As a consequence | |
| the standard C library cannot be built and it is omitted when linking with | |
| @option{-mabi=ti}. | |
| Relaxation is a GNU feature and for safety reasons is disabled when using | |
| @option{-mabi=ti}. The TI toolchain does not emit relocations for QBBx | |
| instructions, so the GNU linker cannot adjust them when shortening adjacent | |
| LDI32 pseudo instructions. | |
| @end table | |
| @node RISC-V Options | |
| @subsection RISC-V Options | |
| @cindex RISC-V Options | |
| These command-line options are defined for RISC-V targets: | |
| @table @gcctabopt | |
| @opindex mbranch-cost | |
| @item -mbranch-cost=@var{n} | |
| Set the cost of branches to roughly @var{n} instructions. | |
| @opindex mabi | |
| @item -mabi=@var{ABI-string} | |
| Specify integer and floating-point calling convention. @var{ABI-string} | |
| contains two parts: the size of integer types and the registers used for | |
| floating-point types. For example @samp{-march=rv64ifd -mabi=lp64d} means that | |
| @samp{long} and pointers are 64-bit (implicitly defining @samp{int} to be | |
| 32-bit), and that floating-point values up to 64 bits wide are passed in F | |
| registers. Contrast this with @samp{-march=rv64ifd -mabi=lp64f}, which still | |
| allows the compiler to generate code that uses the F and D extensions but only | |
| allows floating-point values up to 32 bits long to be passed in registers; or | |
| @samp{-march=rv64ifd -mabi=lp64}, in which no floating-point arguments are | |
| passed in registers. | |
| The default for this argument is system dependent; if you want a specific | |
| calling convention you should specify one explicitly. The valid calling | |
| conventions are: @samp{ilp32}, @samp{ilp32f}, @samp{ilp32d}, @samp{lp64}, | |
| @samp{lp64f}, and @samp{lp64d}. Some calling conventions are impossible to | |
| implement on some ISAs: for example, @samp{-march=rv32if -mabi=ilp32d} is | |
| invalid because the ABI requires 64-bit values be passed in F registers, but F | |
| registers are only 32 bits wide. There are also the @samp{ilp32e} ABI that can | |
| only be used with the @samp{rv32e} architecture and the @samp{lp64e} ABI that | |
| can only be used with the @samp{rv64e}. Those ABIs are not well-specified at | |
| present, and are subject to change. | |
| @opindex mfdiv | |
| @opindex mno-fdiv | |
| @item -mfdiv | |
| @itemx -mno-fdiv | |
| Do or don't use hardware floating-point divide and square root instructions. | |
| This requires the F or D extensions for floating-point registers. The default | |
| is to use them if the specified architecture has these instructions. | |
| @opindex mfence-tso | |
| @opindex mno-fence-tso | |
| @item -mfence-tso | |
| @itemx -mno-fence-tso | |
| Do or don't use the @samp{fence.tso} instruction, which is unimplemented on | |
| some processors (including those from T-Head). If the @samp{fence.tso} | |
| instruction is not available then a stronger fence is used instead. | |
| @opindex mdiv | |
| @opindex mno-div | |
| @item -mdiv | |
| @itemx -mno-div | |
| Do or don't use hardware instructions for integer division. This requires the | |
| M extension. The default is to use them if the specified architecture has | |
| these instructions. | |
| @opindex misa-spec | |
| @item -misa-spec=@var{ISA-spec-string} | |
| Specify the version of the RISC-V Unprivileged (formerly User-Level) | |
| ISA specification generated code should conform to. The possibilities | |
| for @var{ISA-spec-string} are: | |
| @table @code | |
| @item 2.2 | |
| Produce code conforming to version 2.2. | |
| @item 20190608 | |
| Produce code conforming to version 20190608. | |
| @item 20191213 | |
| Produce code conforming to version 20191213. | |
| @end table | |
| The default is @option{-misa-spec=20191213} unless GCC has been configured | |
| with @option{--with-isa-spec=} specifying a different default version. | |
| @opindex march | |
| @item -march=@r{[}@var{ISA}@r{|}@var{Profile}@r{|}@var{Profile_ISA}@r{|}@var{processor-string}@r{]} | |
| Generate code for given RISC-V ISA or profile or a combination of them | |
| (e.g.@: @samp{rv64im} @samp{rvi20u64} @samp{rvi20u64_zbb}). The names of | |
| ISAs and profiles must be lower case. | |
| Examples include @samp{rv64i}, @samp{rv32g}, | |
| @samp{rv32e}, @samp{rv32imaf}, @samp{rva22u64} and @samp{rva23u64}. | |
| To combine a named profile with optional RISC-V ISA extensions, | |
| give the profile first and then append the extension name(s) using | |
| an underscore as a delimiter (e.g.@: | |
| @samp{rvi20u64_zca_zcb} @samp{rva23u64_zacas}). Additionally, a special value | |
| @samp{help} (@option{-march=help}) is accepted to list all supported | |
| extensions. | |
| @option{-march=unset} causes the compiler to ignore any | |
| @option{-march=@dots{}} options | |
| that appear earlier on the command line, behaving as if the option was never | |
| passed. This is useful for ensuring that the architecture is taken from the | |
| @option{-mcpu} option, and an error results if no @option{-mcpu} option | |
| is given when @option{-march=unset} is used. | |
| @option{-march=native} causes the compiler to work out the ISA of the | |
| machine it is running on. It is only available on a native GNU/Linux | |
| compiler; anywhere else the value is rejected like any other unknown ISA | |
| string. On a system whose cores are not all alike, such as one pairing | |
| fast and efficient cores, which of them the detected ISA describes is | |
| unspecified; write the ISA string out in full if it matters. If the | |
| running machine cannot be identified the option is ignored, and the | |
| architecture is taken from @option{-mcpu} or from the configured default | |
| as usual. | |
| The syntax of the ISA string is defined as follows: | |
| @itemize @bullet{} | |
| @item | |
| The string must start with @samp{rv32} or @samp{rv64}, followed by | |
| @samp{i}, @samp{e}, or @samp{g}, referred to as the base ISA. | |
| @item | |
| The subsequent part of the string is a list of extension names. Extension | |
| names can be categorized as multi-letter (e.g.@: @samp{zba}) and single-letter | |
| (e.g.@: @samp{v}). Single-letter extensions can appear consecutively, | |
| but multi-letter extensions must be separated by underscores. | |
| @item | |
| An underscore can appear anywhere after the base ISA. It has no specific | |
| effect but is used to improve readability and can act as a separator. | |
| @item | |
| Extension names may include an optional version number, following the | |
| syntax @samp{<major>p<minor>} or @samp{<major>}, (e.g.@: @samp{m2p1} or | |
| @samp{m2}). | |
| @end itemize | |
| Supported extensions are listed below: | |
| @include riscv-ext.texi | |
| When @option{-march=} is not specified, GCC uses the setting from | |
| @option{-mcpu}. | |
| If both @option{-march} and @option{-mcpu=} are not specified, the default for | |
| this argument is system dependent; if you want a specific architecture | |
| extension, you should specify one explicitly. | |
| When the RISC-V specifications define an extension as depending on other | |
| extensions, GCC implicitly adds the dependent extensions to the enabled | |
| extension set if they weren't added explicitly. | |
| @include riscv-mcpu.texi | |
| Note that @option{-mcpu} does not override @option{-march} or @option{-mtune}. | |
| @include riscv-mtune.texi | |
| When @option{-mtune=} is not specified, GCC uses the setting from | |
| @option{-mcpu}. The default is @samp{generic} if neither is specified. | |
| @option{-mtune=native} and @option{-mcpu=native} identify the core the | |
| compiler is running on, subject to the same restrictions and the same | |
| caveat about unlike cores as @option{-march=native} above. | |
| @option{-mcpu=native} additionally selects the detected architecture. A | |
| core the compiler has no hardware identification for leaves the tuning at | |
| its default rather than causing an error. | |
| The @samp{size} choice is not intended for use by end-users. This is used | |
| when @option{-Os} is specified. It overrides the instruction cost info | |
| provided by @option{-mtune=}, but does not override the pipeline info. This | |
| helps reduce code size while still giving good performance. | |
| @opindex mpreferred-stack-boundary | |
| @item -mpreferred-stack-boundary=@var{num} | |
| Attempt to keep the stack boundary aligned to a 2 raised to @var{num} | |
| byte boundary. If @option{-mpreferred-stack-boundary} is not specified, | |
| the default is 4 (16 bytes or 128-bits). | |
| @strong{Warning:} If you use this switch, then you must build all modules with | |
| the same value, including any libraries. This includes the system libraries | |
| and startup modules. | |
| @opindex msmall-data-limit | |
| @item -msmall-data-limit=@var{n} | |
| Put global and static data smaller than @var{n} bytes into a special section | |
| (on some targets). | |
| @opindex msave-restore | |
| @opindex mno-save-restore | |
| @item -msave-restore | |
| @itemx -mno-save-restore | |
| Do or don't use smaller but slower prologue and epilogue code that uses | |
| library function calls. The default is to use fast inline prologues and | |
| epilogues. | |
| @opindex mmovcc | |
| @opindex mno-movcc | |
| @item -mmovcc | |
| @itemx -mno-movcc | |
| Do or don't produce branchless conditional-move code sequences even with | |
| targets that do not have specific instructions for conditional operations. | |
| If enabled, sequences of ALU operations are produced using base integer | |
| ISA instructions where profitable. | |
| @opindex minline-atomics | |
| @opindex mno-inline-atomics | |
| @item -minline-atomics | |
| @itemx -mno-inline-atomics | |
| Do or don't use smaller but slower subword atomic emulation code that uses | |
| libatomic function calls. The default is to use fast inline subword atomics | |
| that do not require libatomic. | |
| @opindex minline-strlen | |
| @opindex mno-inline-strlen | |
| @item -minline-strlen | |
| @itemx -mno-inline-strlen | |
| Do or do not attempt to inline @code{strlen} calls if possible. | |
| Inlining can only be done if the string is properly aligned | |
| and instructions for accelerated processing are available. | |
| The default is to inline @code{strlen} calls. | |
| @opindex minline-strcmp | |
| @opindex mno-inline-strcmp | |
| @item -minline-strcmp | |
| @itemx -mno-inline-strcmp | |
| Do or do not attempt to inline @code{strcmp} calls if possible. | |
| Inlining can only be done if the strings are properly aligned | |
| and instructions for accelerated processing are available. | |
| The default is to inline @code{strcmp} calls. | |
| @opindex minline-strncmp | |
| @opindex mno-inline-strncmp | |
| @item -minline-strncmp | |
| @itemx -mno-inline-strncmp | |
| Do or do not attempt to inline @code{strncmp} calls if possible. | |
| Inlining can only be done if the strings are properly aligned | |
| and instructions for accelerated processing are available. | |
| The default is to inline @code{strncmp} calls. | |
| @opindex mstringop-strategy | |
| @item -mstringop-strategy=@var{strategy} | |
| Specify a particular strategy for inlining string and memory operations. | |
| @var{strategy} may be one of @samp{auto}, @samp{libcall}, @samp{scalar}, | |
| or @samp{vector}. | |
| @opindex mshorten-memrefs | |
| @opindex mno-shorten-memrefs | |
| @item -mshorten-memrefs | |
| @itemx -mno-shorten-memrefs | |
| Do or do not attempt to make more use of compressed load/store instructions by | |
| replacing a load/store of 'base register + large offset' with a new load/store | |
| of 'new base + small offset'. If the new base gets stored in a compressed | |
| register, then the new load/store can be compressed. Currently targets 32-bit | |
| integer load/stores only. | |
| @opindex mstrict-align | |
| @opindex mno-strict-align | |
| @item -mstrict-align | |
| @itemx -mno-strict-align | |
| Do not or do generate unaligned memory accesses. The default is set depending | |
| on whether the processor we are optimizing for supports fast unaligned access | |
| or not. | |
| @opindex mscalar-strict-align | |
| @opindex mno-scalar-strict-align | |
| @item -mscalar-strict-align | |
| @itemx -mno-scalar-strict-align | |
| Do not or do generate unaligned memory accesses. The default is set depending | |
| on whether the processor we are optimizing for supports fast unaligned access | |
| or not. This is an alias for @option{-mstrict-align}. | |
| @opindex mvector-strict-align | |
| @opindex mno-vector-strict-align | |
| @item -mvector-strict-align | |
| @itemx -mno-vector-strict-align | |
| Do not or do generate unaligned vector memory accesses. The default is set | |
| to off unless the processor we are optimizing for explicitly supports | |
| element-misaligned vector memory access. | |
| @opindex mzilsd-word-align | |
| @item -mzilsd-word-align | |
| Allow Zilsd/Zclsd memory accesses to be generated when they are known to be | |
| 4-byte aligned. | |
| @opindex mzilsd-strict-align | |
| @item -mzilsd-strict-align | |
| Require Zilsd/Zclsd memory accesses to be naturally 8-byte aligned. | |
| The precedence among @option{-mzilsd-word-align}, | |
| @option{-mzilsd-strict-align}, @option{-mstrict-align}, | |
| @option{-mno-strict-align}, @option{-mscalar-strict-align}, and | |
| @option{-mno-scalar-strict-align} is determined by the last one specified. | |
| @opindex mmax-vectorization | |
| @opindex mno-max-vectorization | |
| @item -mmax-vectorization | |
| @itemx -mno-max-vectorization | |
| Enable or disable an override to vectorizer cost model making vectorization | |
| always appear profitable. Unlike @option{-fno-vect-cost-model} or | |
| @option{-fvect-cost-model=unlimited} this option does not turn off cost | |
| comparison between different vector modes. | |
| @opindex mcmodel= | |
| @opindex mcmodel=medlow | |
| @item -mcmodel=medlow | |
| Generate code for the medium-low code model. The program and its statically | |
| defined symbols must lie within a single 2 GiB address range and must lie | |
| between absolute addresses @minus{}2 GiB and +2 GiB. Programs can be statically | |
| or dynamically linked. This is the default code model unless GCC has been | |
| configured with @option{--with-cmodel=} specifying a different default code | |
| model. | |
| @opindex mcmodel=medany | |
| @item -mcmodel=medany | |
| Generate code for the medium-any code model. The program and its statically | |
| defined symbols must be within any single 2 GiB address range. Programs can be | |
| statically or dynamically linked. | |
| The code generated by the medium-any code model is position-independent, but is | |
| not guaranteed to function correctly when linked into position-independent | |
| executables or libraries. | |
| @opindex mcmodel=large | |
| @item -mcmodel=large | |
| Generate code for a large code model, which has no restrictions on size or | |
| placement of symbols. | |
| @opindex mexplicit-relocs | |
| @opindex mno-explicit-relocs | |
| @item -mexplicit-relocs | |
| @itemx -mno-explicit-relocs | |
| Use or do not use assembler relocation operators when dealing with symbolic | |
| addresses. The alternative is to use assembler macros instead, which may | |
| limit optimization. | |
| @opindex mrelax | |
| @opindex mno-relax | |
| @item -mrelax | |
| @itemx -mno-relax | |
| Take advantage of linker relaxations to reduce the number of instructions | |
| required to materialize symbol addresses. The default is to take advantage of | |
| linker relaxations. | |
| @opindex mriscv-attribute | |
| @opindex mno-riscv-attribute | |
| @item -mriscv-attribute | |
| @itemx -mno-riscv-attribute | |
| Emit (do not emit) RISC-V attribute to record extra information into ELF | |
| objects. This feature requires at least binutils 2.32. | |
| @opindex mcsr-check | |
| @opindex mno-csr-check | |
| @item -mcsr-check | |
| @itemx -mno-csr-check | |
| Enables or disables the CSR checking. | |
| @opindex momit-leaf-frame-pointer | |
| @opindex mno-omit-leaf-frame-pointer | |
| @item -momit-leaf-frame-pointer | |
| Don't keep the frame pointer in a register for leaf functions. This | |
| avoids the instructions to save, set up and restore frame pointers and | |
| makes an extra register available in leaf functions. | |
| @opindex malign-data | |
| @item -malign-data=@var{type} | |
| Control how GCC aligns variables and constants of array, structure, or union | |
| types. Supported values for @var{type} are @samp{xlen} which uses x register | |
| width as the alignment value, and @samp{natural} which uses natural alignment. | |
| @samp{xlen} is the default. | |
| @opindex mbig-endian | |
| @item -mbig-endian | |
| Generate big-endian code. This is the default when GCC is configured for a | |
| @samp{riscv64be-*-*} or @samp{riscv32be-*-*} target. | |
| Support for RISC-V big-endian is experimental. The ABI is not yet stable | |
| and could change in incompatible ways in future releases. | |
| @opindex mlittle-endian | |
| @item -mlittle-endian | |
| Generate little-endian code. This is the default when GCC is configured for a | |
| @samp{riscv64-*-*} or @samp{riscv32-*-*} but not a @samp{riscv64be-*-*} or | |
| @samp{riscv32be-*-*} target. | |
| @opindex mstack-protector-guard | |
| @opindex mstack-protector-guard-reg | |
| @opindex mstack-protector-guard-offset | |
| @item -mstack-protector-guard=@var{guard} | |
| @itemx -mstack-protector-guard-reg=@var{reg} | |
| @itemx -mstack-protector-guard-offset=@var{offset} | |
| Generate stack protection code using canary at @var{guard}. Supported | |
| locations are @samp{global} for a global canary or @samp{tls} for per-thread | |
| canary in the TLS block. | |
| With the latter choice the options | |
| @option{-mstack-protector-guard-reg=@var{reg}} and | |
| @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify | |
| which register to use as base register for reading the canary, | |
| and from what offset from that base register. There is no default | |
| register or offset as this is entirely for use within the Linux | |
| kernel. | |
| @opindex mtls-dialect=desc | |
| @item -mtls-dialect=desc | |
| Use TLS descriptors as the thread-local storage mechanism for dynamic accesses | |
| of TLS variables. | |
| @opindex mtls-dialect=trad | |
| @item -mtls-dialect=trad | |
| Use traditional TLS as the thread-local storage mechanism for dynamic accesses | |
| of TLS variables. This is the default. | |
| @opindex munroll-only-small-loops | |
| @opindex mno-unroll-only-small-loops | |
| @item -munroll-only-small-loops | |
| @itemx -mno-unroll-only-small-loops | |
| Controls conservative small loop unrolling. It is enabled by default at | |
| @option{-O2} and above. When enabled, only loops whose RTL instruction | |
| count does not exceed a tune-specific threshold are unrolled, and the | |
| unroll factor is capped by a tune-specific parameter. This gives better | |
| utilization of the instruction decoding pipeline without enlarging bigger | |
| loops. You can disable it with @option{-mno-unroll-only-small-loops}; it | |
| is also turned off when @option{-funroll-loops} or | |
| @option{-funroll-all-loops} is explicitly enabled, so that an explicit | |
| unrolling request applies to loops of any size. | |
| @opindex mrvv-vector-bits | |
| @item -mrvv-vector-bits=@var{value} | |
| Specify how the number of bits for an RVV vector register, as taken from | |
| the @option{-march=} option, is interpreted. | |
| The @var{value} parameter is specified as a string keyword and may be one of | |
| @samp{scalable} or @samp{zvl}. The default is @samp{scalable}, which tells | |
| GCC to interpret the number as a minimum, while @samp{zvl} tells GCC to use | |
| exactly the number of bits specified. | |
| @opindex mrvv-max-lmul | |
| @item -mrvv-max-lmul=@var{value} | |
| This option allows explicit control over the maximum length multiplier (LMUL) | |
| used when generating code for the RISC-V Vector Extensions (RVV). | |
| The @var{value} parameter is specified as a string keyword and may be | |
| one of @samp{m1}, @samp{m2}, @samp{m4}, @samp{m8}, or @samp{dynamic}. The | |
| default is @samp{m1} for compatibility with existing hardware that does not | |
| support the other options. | |
| @opindex madjust-lmul-cost | |
| @opindex mno-adjust-lmul-cost | |
| @item -madjust-lmul-cost | |
| @itemx -mno-adjust-lmul-cost | |
| This option adjusts the cost model used to schedule vector instructions to | |
| multiply the latency of instructions by the RVV length multiplier, LMUL. | |
| It is disabled by default. | |
| @opindex mautovec-segment | |
| @opindex mno-autovec-segment | |
| @item -mautovec-segment | |
| @itemx -mno-autovec-segment | |
| Enable or disable generation of vector segment load/store instructions. | |
| This option is enabled by default. | |
| @end table | |
| @node RL78 Options | |
| @subsection RL78 Options | |
| @cindex RL78 Options | |
| @table @gcctabopt | |
| @opindex msim | |
| @opindex mno-sim | |
| @item -msim | |
| Links in additional target libraries to support operation within a | |
| simulator. | |
| @opindex mmul | |
| @item -mmul=none | |
| @itemx -mmul=g10 | |
| @itemx -mmul=g13 | |
| @itemx -mmul=g14 | |
| @itemx -mmul=rl78 | |
| Specifies the type of hardware multiplication and division support to | |
| be used. The simplest is @code{none}, which uses software for both | |
| multiplication and division. This is the default. The @code{g13} | |
| value is for the hardware multiply/divide peripheral found on the | |
| RL78/G13 (S2 core) targets. The @code{g14} value selects the use of | |
| the multiplication and division instructions supported by the RL78/G14 | |
| (S3 core) parts. The value @code{rl78} is an alias for @code{g14} and | |
| the value @code{mg10} is an alias for @code{none}. | |
| In addition a C preprocessor macro is defined, based upon the setting | |
| of this option. Possible values are: @code{__RL78_MUL_NONE__}, | |
| @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}. | |
| @opindex mcpu | |
| @item -mcpu=g10 | |
| @itemx -mcpu=g13 | |
| @itemx -mcpu=g14 | |
| @itemx -mcpu=rl78 | |
| Specifies the RL78 core to target. The default is the G14 core, also | |
| known as an S3 core or just RL78. The G13 or S2 core does not have | |
| multiply or divide instructions, instead it uses a hardware peripheral | |
| for these operations. The G10 or S1 core does not have register | |
| banks, so it uses a different calling convention. | |
| If this option is set it also selects the type of hardware multiply | |
| support to use, unless this is overridden by an explicit | |
| @option{-mmul=none} option on the command line. Thus specifying | |
| @option{-mcpu=g13} enables the use of the G13 hardware multiply | |
| peripheral and specifying @option{-mcpu=g10} disables the use of | |
| hardware multiplications altogether. | |
| Note, although the RL78/G14 core is the default target, specifying | |
| @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does | |
| change the behavior of the toolchain since it also enables G14 | |
| hardware multiply support. If these options are not specified on the | |
| command line, then software multiplication routines are used even | |
| though the code targets the RL78 core. This is for backward | |
| compatibility with older toolchains which did not have hardware | |
| multiply and divide support. | |
| In addition a C preprocessor macro is defined, based upon the setting | |
| of this option. Possible values are: @code{__RL78_G10__}, | |
| @code{__RL78_G13__} or @code{__RL78_G14__}. | |
| @opindex mg10 | |
| @opindex mg13 | |
| @opindex mg14 | |
| @opindex mrl78 | |
| @item -mg10 | |
| @itemx -mg13 | |
| @itemx -mg14 | |
| @itemx -mrl78 | |
| These are aliases for the corresponding @option{-mcpu=} option. They | |
| are provided for backwards compatibility. | |
| @opindex mallregs | |
| @opindex mno-allregs | |
| @item -mallregs | |
| Allow the compiler to use all of the available registers. By default | |
| registers @code{r24..r31} are reserved for use in interrupt handlers. | |
| With this option enabled these registers can be used in ordinary | |
| functions as well. | |
| @opindex mrelax | |
| @opindex mno-relax | |
| @item -mrelax | |
| @itemx -mno-relax | |
| Enable/disable assembler and linker relaxation. This is enabled by | |
| default at @option{-Os}. | |
| @opindex mes0 | |
| @opindex mno-es0 | |
| @item -mes0 | |
| Assume @code{ES} is zero throughout program execution, and use it | |
| to address read-only data. | |
| @opindex msave-mduc-in-interrupts | |
| @opindex mno-save-mduc-in-interrupts | |
| @item -msave-mduc-in-interrupts | |
| @itemx -mno-save-mduc-in-interrupts | |
| Specifies that interrupt handler functions should preserve the | |
| MDUC registers. This is only necessary if normal code might use | |
| the MDUC registers, for example because it performs multiplication | |
| and division operations. The default is to ignore the MDUC registers | |
| as this makes the interrupt handlers faster. The target option @option{-mg13} | |
| needs to be passed for this to work as this feature is only available | |
| on the G13 target (S2 core). The MDUC registers are only saved | |
| if the interrupt handler performs a multiplication or division | |
| operation or it calls another function. | |
| @end table | |
| @node RS/6000 and PowerPC Options | |
| @subsection IBM RS/6000 and PowerPC Options | |
| @cindex RS/6000 and PowerPC Options | |
| @cindex IBM RS/6000 and PowerPC Options | |
| These @samp{-m} options are defined for the IBM RS/6000 and PowerPC: | |
| @table @gcctabopt | |
| @opindex mcpu | |
| @item -mcpu=@var{cpu_type} | |
| Set architecture type, register usage, and | |
| instruction scheduling parameters for machine type @var{cpu_type}. | |
| Supported values for @var{cpu_type} are @samp{401}, @samp{403}, | |
| @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp}, | |
| @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603}, | |
| @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740}, | |
| @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823}, | |
| @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2}, | |
| @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500}, | |
| @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5}, | |
| @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+}, | |
| @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, | |
| @samp{power9}, @samp{power10}, @samp{power11}, @samp{future}, @samp{powerpc}, | |
| @samp{powerpc64}, @samp{powerpc64le}, @samp{rs64}, and @samp{native}. | |
| @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and | |
| @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either | |
| endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC | |
| architecture machine types, with an appropriate, generic processor | |
| model assumed for scheduling purposes. | |
| Specifying @samp{native} as CPU type detects and selects the | |
| architecture option that corresponds to the host processor of the | |
| system performing the compilation. | |
| @option{-mcpu=native} has no effect if GCC does not recognize the | |
| processor. | |
| The other options specify a specific processor. Code generated under | |
| those options runs best on that processor, and may not run at all on | |
| others. | |
| The @option{-mcpu} options automatically enable or disable the | |
| following options: | |
| @gccoptlist{-maltivec -mfprnd -mhard-float -mmfcrf -mmultiple | |
| -mpopcntb -mpopcntd -mpowerpc64 | |
| -mpowerpc-gpopt -mpowerpc-gfxopt | |
| -mmulhw -mdlmzb -mmfpgpr -mvsx | |
| -mcrypto -mhtm -mpower8-fusion | |
| -mquad-memory -mquad-memory-atomic -mfloat128 | |
| -mfloat128-hardware -mprefixed -mpcrel -mmma | |
| -mdense-math -mrop-protect} | |
| The particular options set for any particular CPU varies between | |
| compiler versions, depending on what setting seems to produce optimal | |
| code for that CPU; it doesn't necessarily reflect the actual hardware's | |
| capabilities. If you wish to set an individual option to a particular | |
| value, you may specify it after the @option{-mcpu} option, like | |
| @option{-mcpu=970 -mno-altivec}. | |
| On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are | |
| not enabled or disabled by the @option{-mcpu} option at present because | |
| AIX does not have full support for these options. You may still | |
| enable or disable them individually if you're sure it'll work in your | |
| environment. | |
| In other cases, we recommend you use the @option{-mcpu=@var{cpu_type}} option | |
| rather than the options that control generation of specific instructions. | |
| @opindex mtune | |
| @item -mtune=@var{cpu_type} | |
| Set the instruction scheduling parameters for machine type | |
| @var{cpu_type}, but do not set the architecture type or register usage, | |
| as @option{-mcpu=@var{cpu_type}} does. The same | |
| values for @var{cpu_type} are used for @option{-mtune} as for | |
| @option{-mcpu}. If both are specified, the code generated uses the | |
| architecture and registers set by @option{-mcpu}, but the | |
| scheduling parameters set by @option{-mtune}. | |
| @opindex mpowerpc64 | |
| @opindex mno-powerpc64 | |
| @item -mpowerpc64 | |
| @itemx -mno-powerpc64 | |
| The @option{-mpowerpc64} option allows GCC to generate the additional | |
| 64-bit instructions that are found in the full PowerPC64 architecture | |
| and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to | |
| @option{-mno-powerpc64}. | |
| @opindex mcmodel= | |
| @opindex mcmodel=small | |
| @item -mcmodel=small | |
| Generate PowerPC64 code for the small model: The TOC is limited to | |
| 64k. | |
| @opindex mcmodel=medium | |
| @item -mcmodel=medium | |
| Generate PowerPC64 code for the medium model: The TOC and other static | |
| data may be up to a total of 4G in size. This is the default for 64-bit | |
| Linux. | |
| @opindex mcmodel=large | |
| @item -mcmodel=large | |
| Generate PowerPC64 code for the large model: The TOC may be up to 4G | |
| in size. Other data and code is only limited by the 64-bit address | |
| space. | |
| @opindex mprofile-kernel | |
| @opindex mno-profile-kernel | |
| @item -mprofile-kernel | |
| This option is available on PowerPC64 GNU/Linux targets. When used with | |
| @option{-pg}, it causes calls to @code{mcount} to be inserted before the | |
| function prologue instead of after it. | |
| @opindex maltivec | |
| @opindex mno-altivec | |
| @item -maltivec | |
| @itemx -mno-altivec | |
| Generate code that uses (does not use) AltiVec instructions, and also | |
| enable the use of built-in functions that allow more direct access to | |
| the AltiVec instruction set. You may also need to set | |
| @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI | |
| enhancements. | |
| When @option{-maltivec} is used, the element order for AltiVec intrinsics | |
| such as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} | |
| match array element order corresponding to the endianness of the | |
| target. That is, element zero identifies the leftmost element in a | |
| vector register when targeting a big-endian platform, and identifies | |
| the rightmost element in a vector register when targeting a | |
| little-endian platform. | |
| @opindex mpowerpc-gpopt | |
| @opindex mno-powerpc-gpopt | |
| @item -mpowerpc-gpopt | |
| @itemx -mno-powerpc-gpopt | |
| Specifying @option{-mpowerpc-gpopt} allows | |
| GCC to use the optional PowerPC architecture instructions in the | |
| General Purpose group, including floating-point square root. Specifying | |
| @opindex mpowerpc-gfxopt | |
| @opindex mno-powerpc-gfxopt | |
| @item -mpowerpc-gfxopt | |
| @itemx -mno-powerpc-gfxopt | |
| @option{-mpowerpc-gfxopt} allows GCC to | |
| use the optional PowerPC architecture instructions in the Graphics | |
| group, including floating-point select. | |
| @opindex mmfcrf | |
| @opindex mno-mfcrf | |
| @item -mmfcrf | |
| @itemx -mno-mfcrf | |
| The @option{-mmfcrf} option allows GCC to generate the move from | |
| condition register field instruction implemented on the POWER4 | |
| processor and other processors that support the PowerPC V2.01 | |
| architecture. | |
| @opindex mpopcntb | |
| @opindex mno-popcntb | |
| @item -mpopcntb | |
| @itemx -mno-popcntb | |
| The @option{-mpopcntb} option allows GCC to generate the popcount and | |
| double-precision FP reciprocal estimate instruction implemented on the | |
| POWER5 processor and other processors that support the PowerPC V2.02 | |
| architecture. | |
| @opindex mpopcntd | |
| @opindex mno-popcntd | |
| @item -mpopcntd | |
| @itemx -mno-popcntd | |
| The @option{-mpopcntd} option allows GCC to generate the popcount | |
| instruction implemented on the POWER7 processor and other processors | |
| that support the PowerPC V2.06 architecture. | |
| @opindex mfprnd | |
| @opindex mno-fprnd | |
| @item -mfprnd | |
| @itemx -mno-fprnd | |
| The @option{-mfprnd} option allows GCC to generate the FP round to | |
| integer instructions implemented on the POWER5+ processor and other | |
| processors that support the PowerPC V2.03 architecture. | |
| @opindex mcmpb | |
| @opindex mno-cmpb | |
| @item -mcmpb | |
| @itemx -mno-cmpb | |
| The @option{-mcmpb} option allows GCC to generate the compare bytes | |
| instruction implemented on the POWER6 processor and other processors | |
| that support the PowerPC V2.05 architecture. | |
| @opindex mhard-dfp | |
| @opindex mno-hard-dfp | |
| @item -mhard-dfp | |
| @itemx -mno-hard-dfp | |
| The @option{-mhard-dfp} option allows GCC to generate the decimal | |
| floating-point instructions implemented on some POWER processors. | |
| @opindex mvrsave | |
| @opindex mno-vrsave | |
| @item -mvrsave | |
| @itemx -mno-vrsave | |
| Generate VRSAVE instructions when generating AltiVec code. | |
| @opindex msecure-plt | |
| @item -msecure-plt | |
| Generate code that allows @command{ld} and @command{ld.so} | |
| to build executables and shared | |
| libraries with non-executable @code{.plt} and @code{.got} sections. | |
| This is a PowerPC | |
| 32-bit SYSV ABI option. | |
| @opindex mbss-plt | |
| @item -mbss-plt | |
| Generate code that uses a BSS @code{.plt} section that @command{ld.so} | |
| fills in, and | |
| requires @code{.plt} and @code{.got} | |
| sections that are both writable and executable. | |
| This is a PowerPC 32-bit SYSV ABI option. | |
| @opindex msplit-patch-nops | |
| @opindex mno-split-patch-nops | |
| @item -msplit-patch-nops | |
| When adding NOPs for a patchable area via the | |
| @option{-fpatchable-function-entry} option emit the ``before'' NOPs in front | |
| of the global entry point and the ``after'' NOPs after the local entry point. | |
| This makes the sequence of NOPs not consecutive when a global entry point | |
| is generated. Without this option the NOPs are emitted directly before and | |
| after the local entry point, making them consecutive but moving global and | |
| local entry point further apart. If only a single entry point is generated | |
| this option has no effect. | |
| @opindex misel | |
| @opindex mno-isel | |
| @item -misel | |
| @itemx -mno-isel | |
| This switch enables or disables the generation of ISEL instructions. | |
| @opindex mvsx | |
| @opindex mno-vsx | |
| @item -mvsx | |
| @itemx -mno-vsx | |
| Generate code that uses (does not use) vector/scalar (VSX) | |
| instructions, and also enable the use of built-in functions that allow | |
| more direct access to the VSX instruction set. | |
| @opindex mcrypto | |
| @opindex mno-crypto | |
| @item -mcrypto | |
| @itemx -mno-crypto | |
| Enable the use (disable) of the built-in functions that allow direct | |
| access to the cryptographic instructions that were added in version | |
| 2.07 of the PowerPC ISA. | |
| @opindex mhtm | |
| @opindex mno-htm | |
| @item -mhtm | |
| @itemx -mno-htm | |
| Enable (disable) the use of the built-in functions that allow direct | |
| access to the Hardware Transactional Memory (HTM) instructions that | |
| were added in version 2.07 of the PowerPC ISA. | |
| @opindex mpower8-fusion | |
| @opindex mno-power8-fusion | |
| @item -mpower8-fusion | |
| @itemx -mno-power8-fusion | |
| Generate code that keeps (does not keeps) some integer operations | |
| adjacent so that the instructions can be fused together on power8 and | |
| later processors. | |
| @opindex mquad-memory | |
| @opindex mno-quad-memory | |
| @item -mquad-memory | |
| @itemx -mno-quad-memory | |
| Generate code that uses (does not use) the non-atomic quad word memory | |
| instructions. The @option{-mquad-memory} option requires use of | |
| 64-bit mode. | |
| @opindex mquad-memory-atomic | |
| @opindex mno-quad-memory-atomic | |
| @item -mquad-memory-atomic | |
| @itemx -mno-quad-memory-atomic | |
| Generate code that uses (does not use) the atomic quad word memory | |
| instructions. The @option{-mquad-memory-atomic} option requires use of | |
| 64-bit mode. | |
| @opindex mfloat128 | |
| @opindex mno-float128 | |
| @item -mfloat128 | |
| @itemx -mno-float128 | |
| Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point | |
| and use either software emulation for IEEE 128-bit floating point or | |
| hardware instructions. | |
| The VSX instruction set (@option{-mvsx}) must be enabled to use the IEEE | |
| 128-bit floating point support. The IEEE 128-bit floating point is only | |
| supported on Linux. | |
| The default for @option{-mfloat128} is enabled on PowerPC Linux | |
| systems using the VSX instruction set, and disabled on other systems. | |
| If you use the ISA 3.0 instruction set (@option{-mcpu=power9}) on a | |
| 64-bit system, the IEEE 128-bit floating point support also enables | |
| the generation of ISA 3.0 IEEE 128-bit floating point instructions. | |
| Otherwise, if you do not specify generation of ISA 3.0 instructions or you | |
| are targeting a 32-bit big-endian system, IEEE 128-bit floating point | |
| is handled with software emulation. | |
| @opindex mfloat128-hardware | |
| @opindex mno-float128-hardware | |
| @item -mfloat128-hardware | |
| @itemx -mno-float128-hardware | |
| Enable/disable using ISA 3.0 hardware instructions to support the | |
| @var{__float128} data type. | |
| The default for @option{-mfloat128-hardware} is enabled on PowerPC | |
| Linux systems using the ISA 3.0 instruction set, and disabled on other | |
| systems. | |
| @opindex m32 | |
| @opindex m64 | |
| @item -m32 | |
| @itemx -m64 | |
| Generate code for 32-bit or 64-bit environments of Darwin and SVR4 | |
| targets (including GNU/Linux). The 32-bit environment sets int, long | |
| and pointer to 32 bits and generates code that runs on any PowerPC | |
| variant. The 64-bit environment sets int to 32 bits and long and | |
| pointer to 64 bits, and generates code for PowerPC64, as for | |
| @option{-mpowerpc64}. | |
| @opindex mfull-toc | |
| @opindex mno-full-toc | |
| @opindex mfp-in-toc | |
| @opindex mno-fp-in-toc | |
| @opindex msum-in-toc | |
| @opindex mno-sum-in-toc | |
| @opindex mminimal-toc | |
| @opindex mno-minimal-toc | |
| @item -mfull-toc | |
| @itemx -mno-fp-in-toc | |
| @itemx -mno-sum-in-toc | |
| @itemx -mminimal-toc | |
| Modify generation of the TOC (Table Of Contents), which is created for | |
| every executable file. The @option{-mfull-toc} option is selected by | |
| default. In that case, GCC allocates at least one TOC entry for | |
| each unique non-automatic variable reference in your program. GCC | |
| also places floating-point constants in the TOC@. However, only | |
| 16,384 entries are available in the TOC@. | |
| If you receive a linker error message that saying you have overflowed | |
| the available TOC space, you can reduce the amount of TOC space used | |
| with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options. | |
| @option{-mno-fp-in-toc} prevents GCC from putting floating-point | |
| constants in the TOC and @option{-mno-sum-in-toc} forces GCC to | |
| generate code to calculate the sum of an address and a constant at | |
| run time instead of putting that sum into the TOC@. You may specify one | |
| or both of these options. Each causes GCC to produce very slightly | |
| slower and larger code at the expense of conserving TOC space. | |
| If you still run out of space in the TOC even when you specify both of | |
| these options, specify @option{-mminimal-toc} instead. This option causes | |
| GCC to make only one TOC entry for every file. When you specify this | |
| option, GCC produces code that is slower and larger but which | |
| uses extremely little TOC space. You may wish to use this option | |
| only on files that contain less frequently-executed code. | |
| @opindex maix64 | |
| @opindex maix32 | |
| @item -maix64 | |
| @itemx -maix32 | |
| Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit | |
| @code{long} type, and the infrastructure needed to support them. | |
| Specifying @option{-maix64} implies @option{-mpowerpc64}, | |
| while @option{-maix32} disables the 64-bit ABI and | |
| implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}. | |
| @opindex mxl-compat | |
| @opindex mno-xl-compat | |
| @item -mxl-compat | |
| @itemx -mno-xl-compat | |
| Produce code that conforms more closely to IBM XL compiler semantics | |
| when using AIX-compatible ABI@. Pass floating-point arguments to | |
| prototyped functions beyond the register save area (RSA) on the stack | |
| in addition to argument FPRs. Do not assume that most significant | |
| double in 128-bit long double value is properly rounded when comparing | |
| values and converting to double. Use XL symbol names for long double | |
| support routines. | |
| The AIX calling convention was extended but not initially documented to | |
| handle an obscure K&R C case of calling a function that takes the | |
| address of its arguments with fewer arguments than declared. IBM XL | |
| compilers access floating-point arguments that do not fit in the | |
| RSA from the stack when a subroutine is compiled without | |
| optimization. Because always storing floating-point arguments on the | |
| stack is inefficient and rarely needed, this option is not enabled by | |
| default and only is necessary when calling subroutines compiled by IBM | |
| XL compilers without optimization. | |
| @opindex mpe | |
| @item -mpe | |
| Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an | |
| application written to use message passing with special startup code to | |
| enable the application to run. The system must have PE installed in the | |
| standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file | |
| must be overridden with the @option{-specs=} option to specify the | |
| appropriate directory location. The Parallel Environment does not | |
| support threads, so the @option{-mpe} option and the @option{-pthread} | |
| option are incompatible. | |
| @opindex malign-natural | |
| @opindex malign-power | |
| @item -malign-natural | |
| @itemx -malign-power | |
| On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option | |
| @option{-malign-natural} overrides the ABI-defined alignment of larger | |
| types, such as floating-point doubles, on their natural size-based boundary. | |
| The option @option{-malign-power} instructs GCC to follow the ABI-specified | |
| alignment rules. GCC defaults to the standard alignment defined in the ABI@. | |
| On 64-bit Darwin, natural alignment is the default, and @option{-malign-power} | |
| is not supported. | |
| @opindex msoft-float | |
| @opindex mhard-float | |
| @item -msoft-float | |
| @itemx -mhard-float | |
| Generate code that does not use (uses) the floating-point register set. | |
| Software floating-point emulation is provided if you use the | |
| @option{-msoft-float} option, and pass the option to GCC when linking. | |
| @opindex mmultiple | |
| @opindex mno-multiple | |
| @item -mmultiple | |
| @itemx -mno-multiple | |
| Generate code that uses (does not use) the load multiple word | |
| instructions and the store multiple word instructions. These | |
| instructions are generated by default on POWER systems, and not | |
| generated on PowerPC systems. Do not use @option{-mmultiple} on little-endian | |
| PowerPC systems, since those instructions do not work when the | |
| processor is in little-endian mode. The exceptions are PPC740 and | |
| PPC750 which permit these instructions in little-endian mode. | |
| @opindex mupdate | |
| @opindex mno-update | |
| @item -mupdate | |
| @itemx -mno-update | |
| Generate code that uses (does not use) the load or store instructions | |
| that update the base register to the address of the calculated memory | |
| location. These instructions are generated by default. If you use | |
| @option{-mno-update}, there is a small window between the time that the | |
| stack pointer is updated and the address of the previous frame is | |
| stored, which means code that walks the stack frame across interrupts or | |
| signals may get corrupted data. | |
| @opindex mavoid-indexed-addresses | |
| @opindex mno-avoid-indexed-addresses | |
| @item -mavoid-indexed-addresses | |
| @itemx -mno-avoid-indexed-addresses | |
| Generate code that tries to avoid (not avoid) the use of indexed load | |
| or store instructions. These instructions can incur a performance | |
| penalty on Power6 processors in certain situations, such as when | |
| stepping through large arrays that cross a 16M boundary. This option | |
| is enabled by default when targeting Power6 and disabled otherwise. | |
| @opindex mfused-madd | |
| @opindex mno-fused-madd | |
| @item -mfused-madd | |
| @itemx -mno-fused-madd | |
| Generate code that uses (does not use) the floating-point multiply and | |
| accumulate instructions. These instructions are generated by default | |
| if hardware floating point is used. The machine-dependent | |
| @option{-mfused-madd} option is now mapped to the machine-independent | |
| @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is | |
| mapped to @option{-ffp-contract=off}. | |
| @opindex mmulhw | |
| @opindex mno-mulhw | |
| @item -mmulhw | |
| @itemx -mno-mulhw | |
| Generate code that uses (does not use) the half-word multiply and | |
| multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors. | |
| These instructions are generated by default when targeting those | |
| processors. | |
| @opindex mdlmzb | |
| @opindex mno-dlmzb | |
| @item -mdlmzb | |
| @itemx -mno-dlmzb | |
| Generate code that uses (does not use) the string-search @samp{dlmzb} | |
| instruction on the IBM 405, 440, 464 and 476 processors. This instruction is | |
| generated by default when targeting those processors. | |
| @opindex mno-bit-align | |
| @opindex mbit-align | |
| @item -mno-bit-align | |
| @itemx -mbit-align | |
| On System V.4 and embedded PowerPC systems do not (do) force structures | |
| and unions that contain bit-fields to be aligned to the base type of the | |
| bit-field. | |
| For example, by default a structure containing nothing but 8 | |
| @code{unsigned} bit-fields of length 1 is aligned to a 4-byte | |
| boundary and has a size of 4 bytes. By using @option{-mno-bit-align}, | |
| the structure is aligned to a 1-byte boundary and is 1 byte in | |
| size. | |
| @opindex mbit-word | |
| @opindex mno-bit-word | |
| @item -mbit-word | |
| @itemx -mno-bit-word | |
| Allow bit-fields to cross word boundaries. | |
| @opindex mno-strict-align | |
| @opindex mstrict-align | |
| @item -mno-strict-align | |
| @itemx -mstrict-align | |
| On System V.4 and embedded PowerPC systems do not (do) assume that | |
| unaligned memory references are handled by the system. | |
| @opindex mrelocatable | |
| @opindex mno-relocatable | |
| @item -mrelocatable | |
| @itemx -mno-relocatable | |
| Generate code that allows (does not allow) a static executable to be | |
| relocated to a different address at run time. A simple embedded | |
| PowerPC system loader should relocate the entire contents of | |
| @code{.got2} and 4-byte locations listed in the @code{.fixup} section, | |
| a table of 32-bit addresses generated by this option. For this to | |
| work, all objects linked together must be compiled with | |
| @option{-mrelocatable} or @option{-mrelocatable-lib}. | |
| @option{-mrelocatable} code aligns the stack to an 8-byte boundary. | |
| @opindex mrelocatable-lib | |
| @opindex mno-relocatable-lib | |
| @item -mrelocatable-lib | |
| @itemx -mno-relocatable-lib | |
| Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a | |
| @code{.fixup} section to allow static executables to be relocated at | |
| run time, but @option{-mrelocatable-lib} does not use the smaller stack | |
| alignment of @option{-mrelocatable}. Objects compiled with | |
| @option{-mrelocatable-lib} may be linked with objects compiled with | |
| any combination of the @option{-mrelocatable} options. | |
| @opindex mlittle | |
| @opindex mlittle-endian | |
| @item -mlittle | |
| @itemx -mlittle-endian | |
| On System V.4 and embedded PowerPC systems compile code for the | |
| processor in little-endian mode. The @option{-mlittle-endian} option is | |
| the same as @option{-mlittle}. | |
| @opindex mbig | |
| @opindex mbig-endian | |
| @item -mbig | |
| @itemx -mbig-endian | |
| On System V.4 and embedded PowerPC systems compile code for the | |
| processor in big-endian mode. The @option{-mbig-endian} option is | |
| the same as @option{-mbig}. | |
| @opindex mdynamic-no-pic | |
| @item -mdynamic-no-pic | |
| On Darwin / macOS systems, compile code so that it is not | |
| relocatable, but that its external references are relocatable. The | |
| resulting code is suitable for applications, but not shared | |
| libraries. | |
| @opindex msingle-pic-base | |
| @item -msingle-pic-base | |
| Treat the register used for PIC addressing as read-only, rather than | |
| loading it in the prologue for each function. The runtime system is | |
| responsible for initializing this register with an appropriate value | |
| before execution begins. | |
| @opindex mprioritize-restricted-insns | |
| @item -mprioritize-restricted-insns=@var{priority} | |
| This option controls the priority that is assigned to | |
| dispatch-slot restricted instructions during the second scheduling | |
| pass. The argument @var{priority} takes the value @samp{0}, @samp{1}, | |
| or @samp{2} to assign no, highest, or second-highest (respectively) | |
| priority to dispatch-slot restricted | |
| instructions. | |
| @opindex msched-costly-dep | |
| @item -msched-costly-dep=@var{dependence_type} | |
| This option controls which dependences are considered costly | |
| by the target during instruction scheduling. The argument | |
| @var{dependence_type} takes one of the following values: | |
| @table @asis | |
| @item @samp{no} | |
| No dependence is costly. | |
| @item @samp{all} | |
| All dependences are costly. | |
| @item @samp{true_store_to_load} | |
| A true dependence from store to load is costly. | |
| @item @samp{store_to_load} | |
| Any dependence from store to load is costly. | |
| @item @var{number} | |
| Any dependence for which the latency is greater than or equal to | |
| @var{number} is costly. | |
| @end table | |
| @opindex minsert-sched-nops | |
| @item -minsert-sched-nops=@var{scheme} | |
| This option controls which NOP insertion scheme is used during | |
| the second scheduling pass. The argument @var{scheme} takes one of the | |
| following values: | |
| @table @asis | |
| @item @samp{no} | |
| Don't insert NOPs. | |
| @item @samp{pad} | |
| Pad with NOPs any dispatch group that has vacant issue slots, | |
| according to the scheduler's grouping. | |
| @item @samp{regroup_exact} | |
| Insert NOPs to force costly dependent insns into | |
| separate groups. Insert exactly as many NOPs as needed to force an insn | |
| to a new group, according to the estimated processor grouping. | |
| @item @var{number} | |
| Insert NOPs to force costly dependent insns into | |
| separate groups. Insert @var{number} NOPs to force an insn to a new group. | |
| @end table | |
| @opindex mcall-sysv | |
| @item -mcall-sysv | |
| On System V.4 and embedded PowerPC systems compile code using calling | |
| conventions that adhere to the March 1995 draft of the System V | |
| Application Binary Interface, PowerPC processor supplement. This is the | |
| default unless you configured GCC using @samp{powerpc-*-eabiaix}. | |
| @opindex mcall-sysv-eabi | |
| @opindex mcall-eabi | |
| @item -mcall-sysv-eabi | |
| @itemx -mcall-eabi | |
| Specify both @option{-mcall-sysv} and @option{-meabi} options. | |
| @opindex mcall-sysv-noeabi | |
| @item -mcall-sysv-noeabi | |
| Specify both @option{-mcall-sysv} and @option{-mno-eabi} options. | |
| @opindex mcall-aixdesc | |
| @item -mcall-aixdesc | |
| On System V.4 and embedded PowerPC systems compile code for the AIX | |
| operating system. | |
| @opindex mcall-linux | |
| @item -mcall-linux | |
| On System V.4 and embedded PowerPC systems compile code for the | |
| Linux-based GNU system. | |
| @opindex mcall-freebsd | |
| @item -mcall-freebsd | |
| On System V.4 and embedded PowerPC systems compile code for the | |
| FreeBSD operating system. | |
| @opindex mcall-netbsd | |
| @item -mcall-netbsd | |
| On System V.4 and embedded PowerPC systems compile code for the | |
| NetBSD operating system. | |
| @opindex mcall-openbsd | |
| @item -mcall-openbsd | |
| On System V.4 and embedded PowerPC systems compile code for the | |
| OpenBSD operating system. | |
| @opindex mtraceback | |
| @item -mtraceback=@var{traceback_type} | |
| Select the type of traceback table. Valid values for @var{traceback_type} | |
| are @samp{full}, @samp{part}, and @samp{no}. | |
| @opindex maix-struct-return | |
| @item -maix-struct-return | |
| Return all structures in memory (as specified by the AIX ABI)@. | |
| @opindex msvr4-struct-return | |
| @item -msvr4-struct-return | |
| Return structures smaller than 8 bytes in registers (as specified by the | |
| SVR4 ABI)@. | |
| @opindex mabi | |
| @item -mabi=@var{abi-type} | |
| Extend the current ABI with a particular extension, or remove such extension. | |
| Valid values are: @samp{altivec}, @samp{no-altivec}, | |
| @samp{ibmlongdouble}, @samp{ieeelongdouble}, | |
| @samp{elfv1}, @samp{elfv2}, | |
| and for AIX: @samp{vec-extabi}, @samp{vec-default}@. | |
| @opindex mabi=ibmlongdouble | |
| @item -mabi=ibmlongdouble | |
| Change the current ABI to use IBM extended-precision long double. | |
| This is not likely to work if your system defaults to using IEEE | |
| extended-precision long double. If you change the long double type | |
| from IEEE extended-precision, the compiler issues a warning unless | |
| you use the @option{-Wno-psabi} option (@pxref{Warning Options}). | |
| Requires @option{-mlong-double-128} to be enabled. | |
| @opindex mabi=ieeelongdouble | |
| @item -mabi=ieeelongdouble | |
| Change the current ABI to use IEEE extended-precision long double. | |
| This is not likely to work if your system defaults to using IBM | |
| extended-precision long double. If you change the long double type | |
| from IBM extended-precision, the compiler issues a warning unless | |
| you use the @option{-Wno-psabi} option (@pxref{Warning Options}). | |
| Requires @option{-mlong-double-128} to be enabled. | |
| @opindex mabi=elfv1 | |
| @item -mabi=elfv1 | |
| Change the current ABI to use the ELFv1 ABI. | |
| This is the default ABI for big-endian PowerPC 64-bit Linux. | |
| Overriding the default ABI requires special system support and is | |
| likely to fail in spectacular ways. | |
| @opindex mabi=elfv2 | |
| @item -mabi=elfv2 | |
| Change the current ABI to use the ELFv2 ABI. | |
| This is the default ABI for little-endian PowerPC 64-bit Linux. | |
| Overriding the default ABI requires special system support and is | |
| likely to fail in spectacular ways. | |
| @opindex mgnu-attribute | |
| @opindex mno-gnu-attribute | |
| @item -mgnu-attribute | |
| @itemx -mno-gnu-attribute | |
| Emit .gnu_attribute assembly directives to set tag/value pairs in a | |
| .gnu.attributes section that specify ABI variations in function | |
| parameters or return values. | |
| @opindex mprototype | |
| @opindex mno-prototype | |
| @item -mprototype | |
| @itemx -mno-prototype | |
| On System V.4 and embedded PowerPC systems assume that all calls to | |
| variable argument functions are properly prototyped. Otherwise, the | |
| compiler must insert an instruction before every non-prototyped call to | |
| set or clear bit 6 of the condition code register (@code{CR}) to | |
| indicate whether floating-point values are passed in the floating-point | |
| registers in case the function takes variable arguments. With | |
| @option{-mprototype}, only calls to prototyped variable argument functions | |
| set or clear the bit. | |
| @opindex msim | |
| @item -msim | |
| On embedded PowerPC systems, assume that the startup module is called | |
| @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and | |
| @file{libc.a}. This is the default for @samp{powerpc-*-eabisim} | |
| configurations. | |
| @opindex mmvme | |
| @item -mmvme | |
| On embedded PowerPC systems, assume that the startup module is called | |
| @file{crt0.o} and the standard C libraries are @file{libmvme.a} and | |
| @file{libc.a}. | |
| @opindex mads | |
| @item -mads | |
| On embedded PowerPC systems, assume that the startup module is called | |
| @file{crt0.o} and the standard C libraries are @file{libads.a} and | |
| @file{libc.a}. | |
| @opindex myellowknife | |
| @item -myellowknife | |
| On embedded PowerPC systems, assume that the startup module is called | |
| @file{crt0.o} and the standard C libraries are @file{libyk.a} and | |
| @file{libc.a}. | |
| @opindex mvxworks | |
| @item -mvxworks | |
| On System V.4 and embedded PowerPC systems, specify that you are | |
| compiling for a VxWorks system. | |
| @opindex memb | |
| @item -memb | |
| On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags | |
| header to indicate that @samp{eabi} extended relocations are used. | |
| @opindex meabi | |
| @opindex mno-eabi | |
| @item -meabi | |
| @itemx -mno-eabi | |
| On System V.4 and embedded PowerPC systems do (do not) adhere to the | |
| Embedded Applications Binary Interface (EABI), which is a set of | |
| modifications to the System V.4 specifications. Selecting @option{-meabi} | |
| means that the stack is aligned to an 8-byte boundary, a function | |
| @code{__eabi} is called from @code{main} to set up the EABI | |
| environment, and the @option{-msdata} option can use both @code{r2} and | |
| @code{r13} to point to two separate small data areas. Selecting | |
| @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary, | |
| no EABI initialization function is called from @code{main}, and the | |
| @option{-msdata} option only uses @code{r13} to point to a single | |
| small data area. The @option{-meabi} option is on by default if you | |
| configured GCC using one of the @samp{powerpc*-*-eabi*} options. | |
| @opindex msdata=eabi | |
| @item -msdata=eabi | |
| On System V.4 and embedded PowerPC systems, put small initialized | |
| @code{const} global and static data in the @code{.sdata2} section, which | |
| is pointed to by register @code{r2}. Put small initialized | |
| non-@code{const} global and static data in the @code{.sdata} section, | |
| which is pointed to by register @code{r13}. Put small uninitialized | |
| global and static data in the @code{.sbss} section, which is adjacent to | |
| the @code{.sdata} section. The @option{-msdata=eabi} option is | |
| incompatible with the @option{-mrelocatable} option. The | |
| @option{-msdata=eabi} option also sets the @option{-memb} option. | |
| @opindex msdata=sysv | |
| @item -msdata=sysv | |
| On System V.4 and embedded PowerPC systems, put small global and static | |
| data in the @code{.sdata} section, which is pointed to by register | |
| @code{r13}. Put small uninitialized global and static data in the | |
| @code{.sbss} section, which is adjacent to the @code{.sdata} section. | |
| The @option{-msdata=sysv} option is incompatible with the | |
| @option{-mrelocatable} option. | |
| @opindex msdata=default | |
| @opindex msdata | |
| @item -msdata=default | |
| @itemx -msdata | |
| On System V.4 and embedded PowerPC systems, if @option{-meabi} is used, | |
| compile code the same as @option{-msdata=eabi}, otherwise compile code the | |
| same as @option{-msdata=sysv}. | |
| @opindex msdata=data | |
| @item -msdata=data | |
| On System V.4 and embedded PowerPC systems, put small global | |
| data in the @code{.sdata} section. Put small uninitialized global | |
| data in the @code{.sbss} section. Do not use register @code{r13} | |
| to address small data however. This is the default behavior unless | |
| other @option{-msdata} options are used. | |
| @opindex msdata=none | |
| @opindex mno-sdata | |
| @item -msdata=none | |
| @itemx -mno-sdata | |
| On embedded PowerPC systems, put all initialized global and static data | |
| in the @code{.data} section, and all uninitialized data in the | |
| @code{.bss} section. | |
| @opindex mreadonly-in-sdata | |
| @opindex mno-readonly-in-sdata | |
| @item -mreadonly-in-sdata | |
| Put read-only objects in the @code{.sdata} section as well. This is the | |
| default. | |
| @opindex mblock-move-inline-limit | |
| @item -mblock-move-inline-limit=@var{num} | |
| Inline all block moves (such as calls to @code{memcpy} or structure | |
| copies) less than or equal to @var{num} bytes. The minimum value for | |
| @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit | |
| targets. The default value is target-specific. | |
| @opindex mblock-compare-inline-limit | |
| @item -mblock-compare-inline-limit=@var{num} | |
| Generate non-looping inline code for all block compares (such as calls | |
| to @code{memcmp} or structure compares) less than or equal to @var{num} | |
| bytes. If @var{num} is 0, all inline expansion (non-loop and loop) of | |
| block compare is disabled. The default value is target-specific. | |
| @opindex mblock-compare-inline-loop-limit | |
| @item -mblock-compare-inline-loop-limit=@var{num} | |
| Generate an inline expansion using loop code for all block compares that | |
| are less than or equal to @var{num} bytes, but greater than the limit | |
| for non-loop inline block compare expansion. If the block length is not | |
| constant, at most @var{num} bytes are compared before @code{memcmp} | |
| is called to compare the remainder of the block. The default value is | |
| target-specific. | |
| @opindex mstring-compare-inline-limit | |
| @item -mstring-compare-inline-limit=@var{num} | |
| Compare at most @var{num} string bytes with inline code. | |
| If the difference or end of string is not found at the | |
| end of the inline compare, a call to @code{strcmp} or @code{strncmp} | |
| takes care of the rest of the comparison. The default is 64 bytes. | |
| @opindex G | |
| @cindex smaller data references (PowerPC) | |
| @cindex .sdata/.sdata2 references (PowerPC) | |
| @item -G @var{num} | |
| On embedded PowerPC systems, put global and static items less than or | |
| equal to @var{num} bytes into the small data or BSS sections instead of | |
| the normal data or BSS section. By default, @var{num} is 8. The | |
| @option{-G @var{num}} switch is also passed to the linker. | |
| All modules should be compiled with the same @option{-G @var{num}} value. | |
| @opindex mregnames | |
| @opindex mno-regnames | |
| @item -mregnames | |
| @itemx -mno-regnames | |
| On System V.4 and embedded PowerPC systems do (do not) emit register | |
| names in the assembly language output using symbolic forms. | |
| @opindex mlongcall | |
| @opindex mno-longcall | |
| @item -mlongcall | |
| @itemx -mno-longcall | |
| By default assume that all calls are far away so that a longer and more | |
| expensive calling sequence is required. This is required for calls | |
| farther than 32 megabytes (33,554,432 bytes) from the current location. | |
| A short call is generated if the compiler knows | |
| the call cannot be that far away. This setting can be overridden by | |
| the @code{shortcall} function attribute, or by @code{#pragma | |
| longcall(0)}. | |
| Some linkers are capable of detecting out-of-range calls and generating | |
| glue code on the fly. On these systems, long calls are unnecessary and | |
| generate slower code. As of this writing, the AIX linker can do this, | |
| as can the GNU linker for PowerPC/64. It is planned to add this feature | |
| to the GNU linker for 32-bit PowerPC systems as well. | |
| On PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU linkers, | |
| GCC can generate long calls using an inline PLT call sequence (see | |
| @option{-mpltseq}). PowerPC with @option{-mbss-plt} and PowerPC64 | |
| ELFv1 (big-endian) do not support inline PLT calls. | |
| On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr | |
| callee, L42}, plus a @dfn{branch island} (glue code). The two target | |
| addresses represent the callee and the branch island. The | |
| Darwin/PPC linker prefers the first address and generates a @code{bl | |
| callee} if the PPC @code{bl} instruction reaches the callee directly; | |
| otherwise, the linker generates @code{bl L42} to call the branch | |
| island. The branch island is appended to the body of the | |
| calling function; it computes the full 32-bit address of the callee | |
| and jumps to it. | |
| On Mach-O (Darwin) systems, this option directs the compiler emit to | |
| the glue for every direct call, and the Darwin linker decides whether | |
| to use or discard it. | |
| In the future, GCC may ignore all longcall specifications | |
| when the linker is known to generate glue. | |
| @opindex mpltseq | |
| @opindex mno-pltseq | |
| @item -mpltseq | |
| @itemx -mno-pltseq | |
| Implement (do not implement) -fno-plt and long calls using an inline | |
| PLT call sequence that supports lazy linking and long calls to | |
| functions in dlopen'd shared libraries. Inline PLT calls are only | |
| supported on PowerPC64 ELFv2 and 32-bit PowerPC systems with newer GNU | |
| linkers, and are enabled by default if the support is detected when | |
| configuring GCC, and, in the case of 32-bit PowerPC, if GCC is | |
| configured with @option{--enable-secureplt}. @option{-mpltseq} code | |
| and @option{-mbss-plt} 32-bit PowerPC relocatable objects may not be | |
| linked together. | |
| @opindex mtls-markers | |
| @opindex mno-tls-markers | |
| @item -mtls-markers | |
| @itemx -mno-tls-markers | |
| Mark (do not mark) calls to @code{__tls_get_addr} with a relocation | |
| specifying the function argument. The relocation allows the linker to | |
| reliably associate function call with argument setup instructions for | |
| TLS optimization, which in turn allows GCC to better schedule the | |
| sequence. | |
| @opindex mrecip | |
| @opindex mno-recip | |
| @item -mrecip | |
| @itemx -mno-recip | |
| This option enables use of the reciprocal estimate and | |
| reciprocal square root estimate instructions with additional | |
| Newton-Raphson steps to increase precision instead of doing a divide or | |
| square root and divide for floating-point arguments. You should use | |
| the @option{-ffast-math} option when using @option{-mrecip} (or at | |
| least @option{-funsafe-math-optimizations}, | |
| @option{-ffinite-math-only}, @option{-freciprocal-math} and | |
| @option{-fno-trapping-math}). Note that while the throughput of the | |
| sequence is generally higher than the throughput of the non-reciprocal | |
| instruction, the precision of the sequence can be decreased by up to 2 | |
| ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square | |
| roots. | |
| @opindex mrecip=opt | |
| @item -mrecip=@var{opt} | |
| This option controls which reciprocal estimate instructions | |
| may be used. @var{opt} is a comma-separated list of options, which may | |
| be preceded by a @code{!} to invert the option: | |
| @table @samp | |
| @item all | |
| Enable all estimate instructions. | |
| @item default | |
| Enable the default instructions, equivalent to @option{-mrecip}. | |
| @item none | |
| Disable all estimate instructions, equivalent to @option{-mno-recip}. | |
| @item div | |
| Enable the reciprocal approximation instructions for both | |
| single and double precision. | |
| @item divf | |
| Enable the single-precision reciprocal approximation instructions. | |
| @item divd | |
| Enable the double-precision reciprocal approximation instructions. | |
| @item rsqrt | |
| Enable the reciprocal square root approximation instructions for both | |
| single and double precision. | |
| @item rsqrtf | |
| Enable the single-precision reciprocal square root approximation instructions. | |
| @item rsqrtd | |
| Enable the double-precision reciprocal square root approximation instructions. | |
| @end table | |
| So, for example, @option{-mrecip=all,!rsqrtd} enables | |
| all of the reciprocal estimate instructions, except for the | |
| @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions | |
| which handle the double-precision reciprocal square root calculations. | |
| @opindex mrecip-precision | |
| @opindex mno-recip-precision | |
| @item -mrecip-precision | |
| @itemx -mno-recip-precision | |
| Assume (do not assume) that the reciprocal estimate instructions | |
| provide higher-precision estimates than is mandated by the PowerPC | |
| ABI. Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or | |
| @option{-mcpu=power8} automatically selects @option{-mrecip-precision}. | |
| The double-precision square root estimate instructions are not generated by | |
| default on low-precision machines, since they do not provide an | |
| estimate that converges after three steps. | |
| @opindex mveclibabi | |
| @item -mveclibabi=@var{type} | |
| Specifies the ABI type to use for vectorizing intrinsics using an | |
| external library. The only type supported at present is @samp{mass}, | |
| which specifies to use IBM's Mathematical Acceleration Subsystem | |
| (MASS) libraries for vectorizing intrinsics using external libraries. | |
| GCC currently emits calls to @code{acosd2}, @code{acosf4}, | |
| @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4}, | |
| @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4}, | |
| @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4}, | |
| @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4}, | |
| @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4}, | |
| @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4}, | |
| @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4}, | |
| @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4}, | |
| @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4}, | |
| @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4}, | |
| @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2}, | |
| @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2}, | |
| @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code | |
| for power7. Both @option{-ftree-vectorize} and | |
| @option{-funsafe-math-optimizations} must also be enabled. The MASS | |
| libraries must be specified at link time. | |
| @opindex mfriz | |
| @opindex mno-friz | |
| @item -mfriz | |
| @itemx -mno-friz | |
| Generate (do not generate) the @code{friz} instruction when the | |
| @option{-funsafe-math-optimizations} option is used to optimize | |
| rounding of floating-point values to 64-bit integer and back to floating | |
| point. The @code{friz} instruction does not return the same value if | |
| the floating-point number is too large to fit in an integer. | |
| @opindex mpointers-to-nested-functions | |
| @opindex mno-pointers-to-nested-functions | |
| @item -mpointers-to-nested-functions | |
| @itemx -mno-pointers-to-nested-functions | |
| Generate (do not generate) code to load up the static chain register | |
| (@code{r11}) when calling through a pointer on AIX and 64-bit Linux | |
| systems where a function pointer points to a 3-word descriptor giving | |
| the function address, TOC value to be loaded in register @code{r2}, and | |
| static chain value to be loaded in register @code{r11}. The | |
| @option{-mpointers-to-nested-functions} is on by default. You cannot | |
| call through pointers to nested functions or pointers | |
| to functions compiled in other languages that use the static chain if | |
| you use @option{-mno-pointers-to-nested-functions}. | |
| @opindex msave-toc-indirect | |
| @opindex mno-save-toc-indirect | |
| @item -msave-toc-indirect | |
| @itemx -mno-save-toc-indirect | |
| Generate (do not generate) code to save the TOC value in the reserved | |
| stack location in the function prologue if the function calls through | |
| a pointer on AIX and 64-bit Linux systems. If the TOC value is not | |
| saved in the prologue, it is saved just before the call through the | |
| pointer. The @option{-mno-save-toc-indirect} option is the default. | |
| @opindex mcompat-align-parm | |
| @opindex mno-compat-align-parm | |
| @item -mcompat-align-parm | |
| @itemx -mno-compat-align-parm | |
| Generate (do not generate) code to pass structure parameters with a | |
| maximum alignment of 64 bits, for compatibility with older versions | |
| of GCC. | |
| Older versions of GCC (prior to 4.9.0) incorrectly did not align a | |
| structure parameter on a 128-bit boundary when that structure contained | |
| a member requiring 128-bit alignment. This is corrected in more | |
| recent versions of GCC. This option may be used to generate code | |
| that is compatible with functions compiled with older versions of | |
| GCC. | |
| The @option{-mno-compat-align-parm} option is the default. | |
| @opindex mstack-protector-guard | |
| @opindex mstack-protector-guard-reg | |
| @opindex mstack-protector-guard-offset | |
| @item -mstack-protector-guard=@var{guard} | |
| @itemx -mstack-protector-guard-reg=@var{reg} | |
| @itemx -mstack-protector-guard-offset=@var{offset} | |
| Generate stack protection code using canary at @var{guard}. Supported | |
| locations are @samp{global} for global canary or @samp{tls} for per-thread | |
| canary in the TLS block (the default with GNU libc version 2.4 or later). | |
| With the latter choice the options | |
| @option{-mstack-protector-guard-reg=@var{reg}} and | |
| @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify | |
| which register to use as base register for reading the canary, and from what | |
| offset from that base register. The default for those is as specified in the | |
| relevant ABI. | |
| @opindex mpcrel | |
| @opindex mno-pcrel | |
| @item -mpcrel | |
| @itemx -mno-pcrel | |
| Generate (do not generate) pc-relative addressing. The @option{-mpcrel} | |
| option requires that the medium code model (@option{-mcmodel=medium}) | |
| and prefixed addressing (@option{-mprefixed}) options are enabled. | |
| @opindex mprefixed | |
| @opindex mno-prefixed | |
| @item -mprefixed | |
| @itemx -mno-prefixed | |
| Generate (do not generate) addressing modes using prefixed load and | |
| store instructions. The @option{-mprefixed} option requires that | |
| the option @option{-mcpu=power10} (or later) is enabled. | |
| @opindex mmma | |
| @opindex mno-mma | |
| @item -mmma | |
| @itemx -mno-mma | |
| Generate (do not generate) the MMA instructions. The @option{-mma} | |
| option requires that the option @option{-mcpu=power10} (or later) | |
| is enabled. | |
| @opindex mdense-math | |
| @opindex mno-dense-math | |
| @item -mdense-math | |
| @itemx -mno-dense-math | |
| Generate (do not generate) Dense Math Facility (DMF) instructions. | |
| The @option{-mdense-math} option requires that the option | |
| @option{-mcpu=future} (or later) is enabled. | |
| @opindex mrop-protect | |
| @opindex mno-rop-protect | |
| @item -mrop-protect | |
| @itemx -mno-rop-protect | |
| Generate (do not generate) ROP protection instructions when the target | |
| processor supports them. Currently this option disables the shrink-wrap | |
| optimization (@option{-fshrink-wrap}). | |
| @opindex mprivileged | |
| @opindex mno-privileged | |
| @item -mprivileged | |
| @itemx -mno-privileged | |
| Generate (do not generate) code that runs in privileged state. | |
| @opindex mblock-ops-unaligned-vsx | |
| @opindex mno-block-ops-unaligned-vsx | |
| @item -mblock-ops-unaligned-vsx | |
| @itemx -mno-block-ops-unaligned-vsx | |
| Generate (do not generate) unaligned vsx loads and stores for | |
| inline expansion of @code{memcpy} and @code{memmove}. | |
| @opindex msplat-word-constant | |
| @opindex mno-splat-word-constant | |
| @item -msplat-word-constant | |
| @itemx -mno-splat-word-constant | |
| Generate (do not generate) code that uses the @code{XXSPLTIW} instruction. | |
| This option is enabled by default. | |
| @opindex msplat-float-constant | |
| @opindex mno-splat-float-constant | |
| @item -msplat-float-constant | |
| @itemx -mno-splat-float-constant | |
| Generate (do not generate) code that uses the @code{XXSPLTIDP} instruction. | |
| This option is enabled by default. | |
| @opindex mieee128-constant | |
| @opindex mno-ieee128-constant | |
| @item -mieee128-constant | |
| @itemx -mno-ieee128-constant | |
| Generate (do not generate) code that uses the @code{LXVKQ} instruction. | |
| This option is enabled by default. | |
| @opindex mwarn-altivec-long | |
| @opindex mno-warn-altivec-long | |
| @item -mwarn-altivec-long | |
| @itemx -mno-warn-altivec-long | |
| Enable or disable warnings about deprecated @samp{vector long ...} Altivec | |
| type usage. This option is enabled by default. | |
| @end table | |
| @node RX Options | |
| @subsection RX Options | |
| @cindex RX Options | |
| These command-line options are defined for RX targets: | |
| @table @gcctabopt | |
| @opindex m64bit-doubles | |
| @opindex m32bit-doubles | |
| @item -m64bit-doubles | |
| @itemx -m32bit-doubles | |
| Make the @code{double} data type be 64 bits (@option{-m64bit-doubles}) | |
| or 32 bits (@option{-m32bit-doubles}) in size. The default is | |
| @option{-m32bit-doubles}. @emph{Note} RX floating-point hardware only | |
| works on 32-bit values, which is why the default is | |
| @option{-m32bit-doubles}. | |
| @opindex fpu | |
| @opindex nofpu | |
| @item -fpu | |
| @itemx -nofpu | |
| Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX | |
| floating-point hardware. The default is enabled for the RX600 | |
| series and disabled for the RX200 series. | |
| Floating-point instructions are only generated for 32-bit floating-point | |
| values, however, so the FPU hardware is not used for doubles if the | |
| @option{-m64bit-doubles} option is used. | |
| @emph{Note} If the @option{-fpu} option is enabled then | |
| @option{-funsafe-math-optimizations} is also enabled automatically. | |
| This is because the RX FPU instructions are themselves unsafe. | |
| @opindex mcpu | |
| @item -mcpu=@var{name} | |
| Selects the type of RX CPU to be targeted. Currently three types are | |
| supported, the generic @samp{RX600} and @samp{RX200} series hardware and | |
| the specific @samp{RX610} CPU. The default is @samp{RX600}. | |
| The only difference between @samp{RX600} and @samp{RX610} is that the | |
| @samp{RX610} does not support the @code{MVTIPL} instruction. | |
| The @samp{RX200} series does not have a hardware floating-point unit | |
| and so @option{-nofpu} is enabled by default when this type is | |
| selected. | |
| @opindex mbig-endian-data | |
| @opindex mlittle-endian-data | |
| @item -mbig-endian-data | |
| @itemx -mlittle-endian-data | |
| Store data (but not code) in the big-endian format. The default is | |
| @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian | |
| format. | |
| @opindex msmall-data-limit | |
| @item -msmall-data-limit=@var{N} | |
| Specifies the maximum size in bytes of global and static variables | |
| that can be placed into the small data area. Using the small data | |
| area can lead to smaller and faster code, but the size of area is | |
| limited and it is up to the programmer to ensure that the area does | |
| not overflow. Also when the small data area is used one of the RX's | |
| registers (usually @code{r13}) is reserved for use pointing to this | |
| area, so it is no longer available for use by the compiler. This | |
| could result in slower and/or larger code if variables are pushed onto | |
| the stack instead of being held in this register. | |
| Note, common variables (variables that have not been initialized) and | |
| constants are not placed into the small data area as they are assigned | |
| to other sections in the output executable. | |
| The default value is zero, which disables this feature. Note, this | |
| feature is not enabled by default with higher optimization levels | |
| (@option{-O2} etc) because of the potentially detrimental effects of | |
| reserving a register. It is up to the programmer to experiment and | |
| discover whether this feature is of benefit to their program. See the | |
| description of the @option{-mpid} option for a description of how the | |
| actual register to hold the small data area pointer is chosen. | |
| @opindex msim | |
| @opindex mno-sim | |
| @item -msim | |
| @itemx -mno-sim | |
| Use the simulator runtime. The default is to use the libgloss | |
| board-specific runtime. | |
| @opindex mas100-syntax | |
| @opindex mno-as100-syntax | |
| @item -mas100-syntax | |
| @itemx -mno-as100-syntax | |
| When generating assembler output use a syntax that is compatible with | |
| Renesas's AS100 assembler. This syntax can also be handled by the GAS | |
| assembler, but it has some restrictions so it is not generated by default. | |
| @opindex mmax-constant-size | |
| @item -mmax-constant-size=@var{N} | |
| Specifies the maximum size, in bytes, of a constant that can be used as | |
| an operand in a RX instruction. Although the RX instruction set does | |
| allow constants of up to 4 bytes in length to be used in instructions, | |
| a longer value equates to a longer instruction. Thus in some | |
| circumstances it can be beneficial to restrict the size of constants | |
| that are used in instructions. Constants that are too big are instead | |
| placed into a constant pool and referenced via register indirection. | |
| The value @var{N} can be between 0 and 4. A value of 0 (the default) | |
| or 4 means that constants of any size are allowed. | |
| @opindex mrelax | |
| @item -mrelax | |
| Enable linker relaxation. Linker relaxation is a process whereby the | |
| linker attempts to reduce the size of a program by finding shorter | |
| versions of various instructions. Disabled by default. | |
| @opindex mint-register | |
| @item -mint-register=@var{N} | |
| Specify the number of registers to reserve for fast interrupt handler | |
| functions. The value @var{N} can be between 0 and 4. A value of 1 | |
| means that register @code{r13} is reserved for the exclusive use | |
| of fast interrupt handlers. A value of 2 reserves @code{r13} and | |
| @code{r12}. A value of 3 reserves @code{r13}, @code{r12} and | |
| @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}. | |
| A value of 0, the default, does not reserve any registers. | |
| @opindex msave-acc-in-interrupts | |
| @item -msave-acc-in-interrupts | |
| Specifies that interrupt handler functions should preserve the | |
| accumulator register. This is only necessary if normal code might use | |
| the accumulator register, for example because it performs 64-bit | |
| multiplications. The default is to ignore the accumulator as this | |
| makes the interrupt handlers faster. | |
| @opindex mpid | |
| @opindex mno-pid | |
| @item -mpid | |
| @itemx -mno-pid | |
| Enables the generation of position-independent data. When enabled, any | |
| access to constant data is done via an offset from a base address | |
| held in a register. This allows the location of constant data to be | |
| determined at run time without requiring the executable to be | |
| relocated, which is a benefit to embedded applications with tight | |
| memory constraints. Data that can be modified is not affected by this | |
| option. | |
| Note, using this feature reserves a register, usually @code{r13}, for | |
| the constant data base address. This can result in slower and/or | |
| larger code, especially in complicated functions. | |
| The actual register chosen to hold the constant data base address | |
| depends upon whether the @option{-msmall-data-limit} and/or the | |
| @option{-mint-register} command-line options are enabled. Starting | |
| with register @code{r13} and proceeding downwards, registers are | |
| allocated first to satisfy the requirements of @option{-mint-register}, | |
| then @option{-mpid} and finally @option{-msmall-data-limit}. Thus it | |
| is possible for the small data area register to be @code{r8} if both | |
| @option{-mint-register=4} and @option{-mpid} are specified on the | |
| command line. | |
| By default this feature is not enabled. The default can be restored | |
| via the @option{-mno-pid} command-line option. | |
| @opindex mno-warn-multiple-fast-interrupts | |
| @opindex mwarn-multiple-fast-interrupts | |
| @item -mno-warn-multiple-fast-interrupts | |
| @itemx -mwarn-multiple-fast-interrupts | |
| Prevents GCC from issuing a warning message if it finds more than one | |
| fast interrupt handler when it is compiling a file. The default is to | |
| issue a warning for each extra fast interrupt handler found, as the RX | |
| only supports one such interrupt. | |
| @opindex mallow-string-insns | |
| @opindex mno-allow-string-insns | |
| @item -mallow-string-insns | |
| @itemx -mno-allow-string-insns | |
| Enables or disables the use of the string manipulation instructions | |
| @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL} | |
| @code{SWHILE} and also the @code{RMPA} instruction. These | |
| instructions may prefetch data, which is not safe to do if accessing | |
| an I/O register. (See section 12.2.7 of the RX62N Group User's Manual | |
| for more information). | |
| The default is to allow these instructions, but it is not possible for | |
| GCC to reliably detect all circumstances where a string instruction | |
| might be used to access an I/O register, so their use cannot be | |
| disabled automatically. Instead it is reliant upon the programmer to | |
| use the @option{-mno-allow-string-insns} option if their program | |
| accesses I/O space. | |
| When the instructions are enabled GCC defines the C preprocessor | |
| symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the | |
| symbol @code{__RX_DISALLOW_STRING_INSNS__}. | |
| @opindex mjsr | |
| @opindex mno-jsr | |
| @item -mjsr | |
| @itemx -mno-jsr | |
| Use only (or not only) @code{JSR} instructions to access functions. | |
| This option can be used when code size exceeds the range of @code{BSR} | |
| instructions. Note that @option{-mno-jsr} does not mean to not use | |
| @code{JSR} but instead means that any type of branch may be used. | |
| @opindex mlra | |
| @opindex mno-lra | |
| @item -mlra | |
| Use the new LRA register allocator. By default, the old ``reload'' | |
| allocator is used. | |
| @end table | |
| @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}} | |
| has special significance to the RX port when used with the | |
| @code{interrupt} function attribute. This attribute indicates a | |
| function intended to process fast interrupts. GCC ensures | |
| that it only uses the registers @code{r10}, @code{r11}, @code{r12} | |
| and/or @code{r13} and only provided that the normal use of the | |
| corresponding registers have been restricted via the | |
| @option{-ffixed-@var{reg}} or @option{-mint-register} command-line | |
| options. | |
| @node S/390 and zSeries Options | |
| @subsection S/390 and zSeries Options | |
| @cindex S/390 and zSeries Options | |
| These are the @samp{-m} options defined for the S/390 and zSeries architecture. | |
| @table @gcctabopt | |
| @opindex mhard-float | |
| @opindex msoft-float | |
| @item -mhard-float | |
| @itemx -msoft-float | |
| Use (do not use) the hardware floating-point instructions and registers | |
| for floating-point operations. When @option{-msoft-float} is specified, | |
| functions in @file{libgcc.a} are used to perform floating-point | |
| operations. When @option{-mhard-float} is specified, the compiler | |
| generates IEEE floating-point instructions. This is the default. | |
| @opindex mhard-dfp | |
| @opindex mno-hard-dfp | |
| @item -mhard-dfp | |
| @itemx -mno-hard-dfp | |
| Use (do not use) the hardware decimal-floating-point instructions for | |
| decimal-floating-point operations. When @option{-mno-hard-dfp} is | |
| specified, functions in @file{libgcc.a} are used to perform | |
| decimal-floating-point operations. When @option{-mhard-dfp} is | |
| specified, the compiler generates decimal-floating-point hardware | |
| instructions. This is the default for @option{-march=z9-ec} or higher. | |
| @opindex mlong-double-64 | |
| @opindex mlong-double-128 | |
| @item -mlong-double-64 | |
| @itemx -mlong-double-128 | |
| These switches control the size of @code{long double} type. A size | |
| of 64 bits makes the @code{long double} type equivalent to the @code{double} | |
| type. This is the default. | |
| @opindex mbackchain | |
| @opindex mno-backchain | |
| @item -mbackchain | |
| @itemx -mno-backchain | |
| Store (do not store) the address of the caller's frame as backchain pointer | |
| into the callee's stack frame. | |
| A backchain may be needed to allow debugging using tools that do not understand | |
| DWARF call frame information. | |
| When @option{-mno-packed-stack} is in effect, the backchain pointer is stored | |
| at the bottom of the stack frame; when @option{-mpacked-stack} is in effect, | |
| the backchain is placed into the topmost word of the 96/160 byte register | |
| save area. | |
| In general, code compiled with @option{-mbackchain} is call-compatible with | |
| code compiled with @option{-mno-backchain}; however, use of the backchain | |
| for debugging purposes usually requires that the whole binary is built with | |
| @option{-mbackchain}. Note that the combination of @option{-mbackchain}, | |
| @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order | |
| to build a linux kernel use @option{-msoft-float}. | |
| The default is to not maintain the backchain. | |
| @opindex mpacked-stack | |
| @opindex mno-packed-stack | |
| @item -mpacked-stack | |
| @itemx -mno-packed-stack | |
| Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is | |
| specified, the compiler uses the all fields of the 96/160 byte register save | |
| area only for their default purpose; unused fields still take up stack space. | |
| When @option{-mpacked-stack} is specified, register save slots are densely | |
| packed at the top of the register save area; unused space is reused for other | |
| purposes, allowing for more efficient use of the available stack space. | |
| However, when @option{-mbackchain} is also in effect, the topmost word of | |
| the save area is always used to store the backchain, and the return address | |
| register is always saved two words below the backchain. | |
| As long as the stack frame backchain is not used, code generated with | |
| @option{-mpacked-stack} is call-compatible with code generated with | |
| @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for | |
| S/390 or zSeries generated code that uses the stack frame backchain at run | |
| time, not just for debugging purposes. Such code is not call-compatible | |
| with code compiled with @option{-mpacked-stack}. Also, note that the | |
| combination of @option{-mbackchain}, | |
| @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order | |
| to build a linux kernel use @option{-msoft-float}. | |
| The default is to not use the packed stack layout. | |
| @opindex msmall-exec | |
| @opindex mno-small-exec | |
| @item -msmall-exec | |
| @itemx -mno-small-exec | |
| Generate (or do not generate) code using the @code{bras} instruction | |
| to do subroutine calls. | |
| This only works reliably if the total executable size does not | |
| exceed 64k. The default is to use the @code{basr} instruction instead, | |
| which does not have this limitation. | |
| @opindex m64 | |
| @item -m64 | |
| After the removal of @option{-m31}, option @option{-m64} has no counterpart | |
| anymore. For the sake of backwards compatibility, the option is still accepted | |
| but doesn't have any effect anymore. Therefore, generated code comprises | |
| 64-bit instructions and follows the GNU/Linux for zSeries ABI by default. | |
| @opindex mzarch | |
| @item -mzarch | |
| After the removal of @option{-mesa}, option @option{-mzarch} has no counterpart | |
| anymore. For the sake of backwards compatibility, the option is still accepted | |
| but doesn't have any effect anymore. Therefore, generated code comprises | |
| instructions available on z/Architecture by default. | |
| @opindex mhtm | |
| @opindex mno-htm | |
| @item -mhtm | |
| @itemx -mno-htm | |
| The @option{-mhtm} option enables a set of builtins making use of | |
| instructions available with the transactional execution facility | |
| introduced with the IBM zEnterprise EC12 machine generation | |
| @ref{S/390 System z Built-in Functions}. | |
| @option{-mhtm} is enabled by default when using @option{-march=zEC12}. | |
| @opindex mvx | |
| @opindex mno-vx | |
| @item -mvx | |
| @itemx -mno-vx | |
| When @option{-mvx} is specified, generate code using the instructions | |
| available with the vector extension facility introduced with the IBM | |
| z13 machine generation. | |
| This option changes the ABI for some vector type values with regard to | |
| alignment and calling conventions. In case vector type values are | |
| being used in an ABI-relevant context, a GAS @samp{.gnu_attribute} | |
| command is added to mark the resulting binary with the ABI used. | |
| @option{-mvx} is enabled by default when using @option{-march=z13}. | |
| @opindex mzvector | |
| @opindex mno-zvector | |
| @item -mzvector | |
| @itemx -mno-zvector | |
| The @option{-mzvector} option enables vector language extensions and | |
| builtins using instructions available with the vector extension | |
| facility introduced with the IBM z13 machine generation. | |
| This option adds support for @samp{vector} to be used as a keyword to | |
| define vector type variables and arguments. @samp{vector} is only | |
| available when GNU extensions are enabled. It is not expanded | |
| when requesting strict standard compliance e.g.@: with @option{-std=c99}. | |
| In addition to the GCC low-level builtins, @option{-mzvector} enables | |
| a set of builtins added for compatibility with AltiVec-style | |
| implementations like Power and Cell. In order to make use of these | |
| builtins, you must include the header file @file{vecintrin.h}. | |
| @option{-mzvector} is disabled by default. | |
| @opindex mmvcle | |
| @opindex mno-mvcle | |
| @item -mmvcle | |
| @itemx -mno-mvcle | |
| Generate (or do not generate) code using the @code{mvcle} instruction | |
| to perform block moves. When @option{-mno-mvcle} is specified, | |
| use a @code{mvc} loop instead. This is the default unless optimizing for | |
| size. | |
| @opindex mdebug | |
| @opindex mno-debug | |
| @item -mdebug | |
| @itemx -mno-debug | |
| Print (or do not print) additional debug information when compiling. | |
| The default is to not print debug information. | |
| @opindex march | |
| @item -march=@var{cpu-type} | |
| Generate code that runs on @var{cpu-type}, which is the name of a | |
| system representing a certain processor type. Possible values for | |
| @var{cpu-type} are @samp{z900}/@samp{arch5}, @samp{z990}/@samp{arch6}, | |
| @samp{z9-109}, @samp{z9-ec}/@samp{arch7}, @samp{z10}/@samp{arch8}, | |
| @samp{z196}/@samp{arch9}, @samp{zEC12}, @samp{z13}/@samp{arch11}, | |
| @samp{z14}/@samp{arch12}, @samp{z15}/@samp{arch13}, | |
| @samp{z16}/@samp{arch14}, @samp{z17}/@samp{arch15}, and @samp{native}. | |
| The default is @option{-march=z900}. | |
| Specifying @samp{native} as CPU type can be used to select the best | |
| architecture option for the host processor. | |
| @option{-march=native} has no effect if GCC does not recognize the | |
| processor. | |
| @opindex mtune | |
| @item -mtune=@var{cpu-type} | |
| Tune to @var{cpu-type} everything applicable about the generated code, | |
| except for the ABI and the set of available instructions. | |
| The list of @var{cpu-type} values is the same as for @option{-march}. | |
| The default is the value used for @option{-march}. | |
| @opindex mtpf-trace | |
| @opindex mno-tpf-trace | |
| @item -mtpf-trace | |
| @itemx -mno-tpf-trace | |
| Generate code that adds (does not add) in TPF OS specific branches to trace | |
| routines in the operating system. This option is off by default, even | |
| when compiling for the TPF OS@. | |
| @opindex mtpf-trace-skip | |
| @opindex mno-tpf-trace-skip | |
| @item -mtpf-trace-skip | |
| @itemx -mno-tpf-trace-skip | |
| Generate code that changes (does not change) the default branch | |
| targets enabled by @option{-mtpf-trace} to point to specialized trace | |
| routines providing the ability of selectively skipping function trace | |
| entries for the TPF OS. This option is off by default, even when | |
| compiling for the TPF OS and specifying @option{-mtpf-trace}. | |
| @opindex mmain | |
| @opindex mno-main | |
| @item -mmain | |
| For TPF OS target, use this option when linking to add the startup code | |
| and other linker options to produce a main object. | |
| @opindex mfused-madd | |
| @opindex mno-fused-madd | |
| @item -mfused-madd | |
| @itemx -mno-fused-madd | |
| Generate code that uses (does not use) the floating-point multiply and | |
| accumulate instructions. These instructions are generated by default if | |
| hardware floating point is used. | |
| @opindex mwarn-framesize | |
| @item -mwarn-framesize=@var{framesize} | |
| Emit a warning if the current function exceeds the given frame size. | |
| Because this is a compile-time check it doesn't need to be a real | |
| problem when the program runs. It is intended to identify functions | |
| hat most probably cause a stack overflow. It is useful for | |
| environments with limited stack size e.g.@: the Linux kernel. | |
| A value of zero disables this warning; that is the default. | |
| @opindex mwarn-dynamicstack | |
| @opindex mno-warn-dynamicstack | |
| @item -mwarn-dynamicstack | |
| @itemx -mno-warn-dynamicstack | |
| Emit a warning if the function calls @code{alloca} or uses dynamically-sized | |
| arrays. This is generally a bad idea with a limited stack size. | |
| @opindex mstack-guard | |
| @opindex mstack-size | |
| @opindex mno-stack-guard | |
| @opindex mno-stack-size | |
| @item -mstack-guard=@var{stack-guard} | |
| @itemx -mstack-size=@var{stack-size} | |
| @itemx -mno-stack-guard | |
| @itemx -mno-stack-size | |
| If these options are enabled, the S/390 back end emits additional | |
| instructions in the function prologue that trigger a trap if the stack | |
| size is @var{stack-guard} bytes above the @var{stack-size} (remember that | |
| the stack on S/390 grows downward). | |
| If the @var{stack-guard} option is omitted the smallest power of 2 larger than | |
| the frame size of the compiled function is chosen. | |
| These options are intended to be used to help debugging stack overflow | |
| problems. The additionally emitted code causes only little overhead and | |
| hence can also be used in production-like systems without greater | |
| performance degradation. | |
| The given values have to be exact powers of 2 | |
| and @var{stack-size} has to be greater than @var{stack-guard} without | |
| exceeding 64k. | |
| In order to be efficient the extra code makes the assumption that the | |
| stack starts at an address aligned to the value given by @var{stack-size}. | |
| The @option{-mstack-guard=} option can only be used in conjunction with | |
| @option{-mstack-size=}. You can override these options on the command line | |
| with @option{-mno-stack-guard} and @option{-mno-stack-size}, respectively. | |
| @opindex mhotpatch | |
| @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords} | |
| If the hotpatch option is enabled, a ``hot-patching'' function | |
| prologue is generated for all functions in the compilation unit. | |
| The function label is prepended with the given number of two-byte | |
| NOP instructions (@var{pre-halfwords}, maximum 1000000). After | |
| the label, 2 * @var{post-halfwords} bytes are appended, using the | |
| largest NOP-like instructions the architecture allows (maximum | |
| 1000000). | |
| If both arguments are zero, hotpatching is disabled. | |
| This option can be overridden for individual functions with the | |
| @code{hotpatch} attribute. | |
| @opindex mpic-data-is-text-relative | |
| @opindex mno-pic-data-is-text-relative | |
| @item -mpic-data-is-text-relative | |
| @itemx -mno-pic-data-is-text-relative | |
| When compiling for S/390 with @option{-fpic} or @option{-fPIC}, normally | |
| GCC emits code using relative addressing between code and data. However, | |
| for hotpatching it might be required to introduce new @code{.text} parts | |
| while using the existing @code{.data} and @code{.bss} sections. | |
| In this case, use @option{-mno-pic-data-is-text-relative} to force | |
| addressing through the GOT instead. | |
| @opindex mstack-protector-guard | |
| @opindex mstack-protector-guard-record | |
| @opindex mno-stack-protector-guard-record | |
| @item -mstack-protector-guard=@var{guard} | |
| @itemx -mstack-protector-guard-record | |
| Generate stack protection code using canary at @var{guard}. Supported | |
| locations are @samp{global} for a global canary or @samp{tls} for a per-thread | |
| canary in the TLS block (the default). | |
| Option @option{-mstack-protector-guard-record} results in the generation of | |
| section @code{__stack_protector_loc} containing pointers to all instructions | |
| which load the address of the global guard. Thus, this option has only an | |
| effect in conjunction with @option{-mstack-protector-guard=global}. The | |
| intended use is for the Linux kernel. | |
| @opindex mindirect-branch | |
| @opindex mindirect-branch-jump | |
| @opindex mindirect-branch-call | |
| @opindex mfunction-return | |
| @opindex mfunction-return-mem | |
| @opindex mfunction-return-reg | |
| @item -mindirect-branch=@var{choice} | |
| @itemx -mindirect-branch-jump=@var{choice} | |
| @itemx -mindirect-branch-call=@var{choice} | |
| @itemx -mfunction-return=@var{choice} | |
| @itemx -mfunction-return-mem=@var{choice} | |
| @itemx -mfunction-return-reg=@var{choice} | |
| This group of options addresses security vulnerabilities related to | |
| speculative execution and indirect branch prediction by enabling replacement | |
| of indirect branches and function returns with direct branches to a thunk. | |
| Specifying a @var{choice} of @samp{keep} causes generation of the | |
| default code. @samp{thunk} triggers generation of out-of-line thunks | |
| and replaces the formerly indirect branch with a direct branch to the | |
| thunk. @samp{thunk-extern} does the branch replacement like @samp{thunk} | |
| but does not emit the thunks. @samp{thunk-inline} is only available with | |
| @option{-mindirect-branch-jump}; it should be used in preference | |
| to @samp{thunk} in user-space applications to support correct stack | |
| unwinding and exception handling. | |
| @option{-mindirect-branch} sets the value of @option{-mindirect-branch-jump} | |
| and @option{-mindirect-branch-call}. | |
| @option{-mfunction-return} sets the value of @option{-mfunction-return-reg} | |
| and @option{-mfunction-return-mem.} | |
| All of these options can also be set on a per-function basis using | |
| function attributes. | |
| @opindex mindirect-branch-table | |
| @opindex mno-indirect-branch-table | |
| @item -mindirect-branch-table | |
| @itemx -mno-indirect-branch-table | |
| This option is useful in conjunction with the | |
| @option{-mindirect-branch} and @option{-mfunction-return} options. | |
| When enabled, it causes generation of tables pointing to the branch | |
| locations which have been patched by those options. The tables are | |
| emitted in sections named @code{.s390_indirect_jump}, | |
| @code{.s390_indirect_call}, @code{.s390_return_reg}, and | |
| @code{.s390_return_mem}. Each section consists of an array of 32-bit | |
| elements; each entry holds the offset from the entry to the patched | |
| location. | |
| @opindex mfentry | |
| @opindex mno-fentry | |
| @item -mfentry | |
| @itemx -mno-fentry | |
| When used in conjunction with the @option{-pg} option, emit profiling code | |
| using the @code{__fentry__} hook provided by GLIBC 2.29 or later. | |
| This is only available for 64-bit code. If this option is not enabled, | |
| profiling uses the less efficient @code{_mcount} hook instead. | |
| @opindex mrecord-mcount | |
| @opindex mno-record-mcount | |
| @item -mrecord-mcount | |
| @itemx -mno-record-mcount | |
| When enabled, generate a @code{__mcount_loc} section with the locations | |
| of all generated profiling calls to @code{_mcount} or @code{__fentry__}. | |
| @opindex mnop-mcount | |
| @opindex mno-nop-mcount | |
| @item mnop-mcount | |
| @itemx mno-nop-mcount | |
| Instead of generating calls to @code{_mcount} or @code{__fentry__} | |
| with @option{-pg}, insert a sequence no-op instructions of the same length | |
| at the locations where the calls would have been inserted. This can be used | |
| in conjunction with the @option{-mrecord-mcount} option to patch the call | |
| sequences into the object file without recompiling it. | |
| @opindex mpreserve-args | |
| @opindex mno-preserve-args | |
| @item -mpreserve-args | |
| @itemx -mno-preserve-args | |
| When enabled, save all argument registers to the stack, and generate | |
| corresponding CFI information. This is useful for applications that | |
| want to implement their own stack unwinding and need access to function | |
| arguments. | |
| @opindex munaligned-symbols | |
| @opindex mno-unaligned-symbols | |
| @item -munaligned-symbols | |
| @itemx -mno-unaligned-symbols | |
| Assume that external symbols with a natural alignment of 1 are potentially | |
| unaligned. By default, all symbols without explicit alignment are assumed | |
| to be aligned on a 2-byte boundary as mandated by the IBM Z ABI. | |
| @end table | |
| @node SH Options | |
| @subsection SH Options | |
| These @samp{-m} options are defined for the SH implementations: | |
| @table @gcctabopt | |
| @opindex m1 | |
| @item -m1 | |
| Generate code for the SH1. | |
| @opindex m2 | |
| @item -m2 | |
| Generate code for the SH2. | |
| @opindex m2e | |
| @item -m2e | |
| Generate code for the SH2e. | |
| @opindex m2a-nofpu | |
| @item -m2a-nofpu | |
| Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way | |
| that the floating-point unit is not used. | |
| @opindex m2a-single-only | |
| @item -m2a-single-only | |
| Generate code for the SH2a-FPU, in such a way that no double-precision | |
| floating-point operations are used. | |
| @opindex m2a-single | |
| @item -m2a-single | |
| Generate code for the SH2a-FPU assuming the floating-point unit is in | |
| single-precision mode by default. | |
| @opindex m2a | |
| @item -m2a | |
| Generate code for the SH2a-FPU assuming the floating-point unit is in | |
| double-precision mode by default. | |
| @opindex m3 | |
| @item -m3 | |
| Generate code for the SH3. | |
| @opindex m3e | |
| @item -m3e | |
| Generate code for the SH3e. | |
| @opindex m4-nofpu | |
| @item -m4-nofpu | |
| Generate code for the SH4 without a floating-point unit. | |
| @opindex m4-single-only | |
| @item -m4-single-only | |
| Generate code for the SH4 with a floating-point unit that only | |
| supports single-precision arithmetic. | |
| @opindex m4-single | |
| @item -m4-single | |
| Generate code for the SH4 assuming the floating-point unit is in | |
| single-precision mode by default. | |
| @opindex m4 | |
| @item -m4 | |
| Generate code for the SH4. | |
| @opindex m4-100 | |
| @item -m4-100 | |
| Generate code for SH4-100. | |
| @opindex m4-100-nofpu | |
| @item -m4-100-nofpu | |
| Generate code for SH4-100 in such a way that the | |
| floating-point unit is not used. | |
| @opindex m4-100-single | |
| @item -m4-100-single | |
| Generate code for SH4-100 assuming the floating-point unit is in | |
| single-precision mode by default. | |
| @opindex m4-100-single-only | |
| @item -m4-100-single-only | |
| Generate code for SH4-100 in such a way that no double-precision | |
| floating-point operations are used. | |
| @opindex m4-200 | |
| @item -m4-200 | |
| Generate code for SH4-200. | |
| @opindex m4-200-nofpu | |
| @item -m4-200-nofpu | |
| Generate code for SH4-200 without in such a way that the | |
| floating-point unit is not used. | |
| @opindex m4-200-single | |
| @item -m4-200-single | |
| Generate code for SH4-200 assuming the floating-point unit is in | |
| single-precision mode by default. | |
| @opindex m4-200-single-only | |
| @item -m4-200-single-only | |
| Generate code for SH4-200 in such a way that no double-precision | |
| floating-point operations are used. | |
| @opindex m4-300 | |
| @item -m4-300 | |
| Generate code for SH4-300. | |
| @opindex m4-300-nofpu | |
| @item -m4-300-nofpu | |
| Generate code for SH4-300 without in such a way that the | |
| floating-point unit is not used. | |
| @opindex m4-300-single | |
| @item -m4-300-single | |
| Generate code for SH4-300 in such a way that no double-precision | |
| floating-point operations are used. | |
| @opindex m4-300-single-only | |
| @item -m4-300-single-only | |
| Generate code for SH4-300 in such a way that no double-precision | |
| floating-point operations are used. | |
| @opindex m4-340 | |
| @item -m4-340 | |
| Generate code for SH4-340 (no MMU, no FPU). | |
| @opindex m4-400 | |
| @item -m4-400 | |
| Generate code for SH4-400 (no MMU, no FPU). | |
| @opindex m4-500 | |
| @item -m4-500 | |
| Generate code for SH4-500 (no FPU). Passes @option{-isa=sh4-nofpu} to the | |
| assembler. | |
| @opindex m4a-nofpu | |
| @item -m4a-nofpu | |
| Generate code for the SH4al-dsp, or for a SH4a in such a way that the | |
| floating-point unit is not used. | |
| @opindex m4a-single-only | |
| @item -m4a-single-only | |
| Generate code for the SH4a, in such a way that no double-precision | |
| floating-point operations are used. | |
| @opindex m4a-single | |
| @item -m4a-single | |
| Generate code for the SH4a assuming the floating-point unit is in | |
| single-precision mode by default. | |
| @opindex m4a | |
| @item -m4a | |
| Generate code for the SH4a. | |
| @opindex m4al | |
| @item -m4al | |
| Same as @option{-m4a-nofpu}, except that it implicitly passes | |
| @option{-dsp} to the assembler. GCC doesn't generate any DSP | |
| instructions at the moment. | |
| @opindex mb | |
| @item -mb | |
| Compile code for the processor in big-endian mode. | |
| @opindex ml | |
| @item -ml | |
| Compile code for the processor in little-endian mode. | |
| @opindex mdalign | |
| @item -mdalign | |
| Align doubles at 64-bit boundaries. Note that this changes the calling | |
| conventions, and thus some functions from the standard C library do | |
| not work unless you recompile it first with @option{-mdalign}. | |
| @opindex mrelax | |
| @item -mrelax | |
| Shorten some address references at link time, when possible; uses the | |
| linker option @option{-relax}. | |
| @opindex mbigtable | |
| @item -mbigtable | |
| Use 32-bit offsets in @code{switch} tables. The default is to use | |
| 16-bit offsets. | |
| @opindex mbitops | |
| @item -mbitops | |
| Enable the use of bit manipulation instructions on SH2A. | |
| @opindex mfmovd | |
| @item -mfmovd | |
| Enable the use of the instruction @code{fmovd}. Check @option{-mdalign} for | |
| alignment constraints. | |
| @opindex mrenesas | |
| @opindex mno-renesas | |
| @item -mrenesas | |
| @itemx -mno-renesas | |
| Comply with the calling conventions defined by Renesas. The default for all | |
| targets of the SH toolchain is @option{-mno-renesas}, which uses the | |
| calling conventions defined for GCC before the Renesas conventions were | |
| available. | |
| @opindex mnomacsave | |
| @item -mnomacsave | |
| Mark the @code{MAC} register as call-clobbered, even if | |
| @option{-mrenesas} is given. | |
| @opindex mieee | |
| @opindex mno-ieee | |
| @item -mieee | |
| @itemx -mno-ieee | |
| Control the IEEE compliance of floating-point comparisons, which affects the | |
| handling of cases where the result of a comparison is unordered. By default | |
| @option{-mieee} is implicitly enabled. If @option{-ffinite-math-only} is | |
| enabled @option{-mno-ieee} is implicitly set, which results in faster | |
| floating-point greater-equal and less-equal comparisons. The implicit settings | |
| can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}. | |
| @opindex minline-ic_invalidate | |
| @opindex mno-inline-ic_invalidate | |
| @item -minline-ic_invalidate | |
| @itemx -mno-inline-ic_invalidate | |
| Inline code to invalidate instruction cache entries after setting up | |
| nested function trampolines. | |
| This option has no effect if @option{-musermode} is in effect and the | |
| selected code generation option (e.g.@: @option{-m4}) does not allow | |
| the use of the @code{icbi} instruction. | |
| If the selected code generation option does not allow the use of the | |
| @code{icbi} | |
| instruction, and @option{-musermode} is not in effect, the inlined code | |
| manipulates the instruction cache address array directly with an associative | |
| write. This not only requires privileged mode at run time, but it also | |
| fails if the cache line had been mapped via the TLB and has become unmapped. | |
| @opindex misize | |
| @item -misize | |
| Dump instruction size and location in the assembly code. | |
| @opindex matomic-model=@var{model} | |
| @item -matomic-model=@var{model} | |
| Sets the model of atomic operations and additional parameters as a | |
| comma-separated list. For details on the atomic built-in functions see | |
| @ref{__atomic Builtins}. The following models and parameters are supported: | |
| @table @samp | |
| @item none | |
| Disable compiler generated atomic sequences and emit library calls for atomic | |
| operations. This is the default if the target is not @code{sh*-*-linux*}. | |
| @item soft-gusa | |
| Generate GNU/Linux-compatible gUSA software atomic sequences for the atomic | |
| built-in functions. The generated atomic sequences require additional support | |
| from the interrupt/exception handling code of the system and are only suitable | |
| for SH3* and SH4* single-core systems. This option is enabled by default when | |
| the target is @code{sh*-*-linux*} and SH3* or SH4*. When the target is SH4A, | |
| this option also partially utilizes the hardware atomic instructions | |
| @code{movli.l} and @code{movco.l} to create more efficient code, unless | |
| @samp{strict} is specified. | |
| @item soft-tcb | |
| Generate software atomic sequences that use a variable in the thread control | |
| block. This is a variation of the gUSA sequences which can also be used on | |
| SH1* and SH2* targets. The generated atomic sequences require additional | |
| support from the interrupt/exception handling code of the system and are only | |
| suitable for single-core systems. When using this model, | |
| the @samp{gbr-offset=} parameter has to be specified as well. | |
| @item soft-imask | |
| Generate software atomic sequences that temporarily disable interrupts by | |
| setting @code{SR.IMASK = 1111}. This model works only when the program runs | |
| in privileged mode and is only suitable for single-core systems. Additional | |
| support from the interrupt/exception handling code of the system is not | |
| required. This model is enabled by default when the target is | |
| @code{sh*-*-linux*} and SH1* or SH2*. | |
| @item hard-llcs | |
| Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l} | |
| instructions only. This is only available on SH4A and is suitable for | |
| multi-core systems. | |
| Since the hardware instructions support only 32-bit atomic | |
| variables, access to 8- or 16-bit variables is emulated with 32-bit accesses. | |
| Code compiled with this option is also compatible with other software | |
| atomic model interrupt/exception handling systems if executed on an SH4A | |
| system. Additional support from the interrupt/exception handling code of the | |
| system is not required for this model. | |
| @item gbr-offset= | |
| This parameter specifies the offset in bytes of the variable in the thread | |
| control block structure that should be used by the generated atomic sequences | |
| when the @samp{soft-tcb} model has been selected. For other models this | |
| parameter is ignored. The specified value must be an integer multiple of four | |
| and in the range 0-1020. | |
| @item strict | |
| This parameter prevents mixed usage of multiple atomic models, even if they | |
| are compatible, and makes the compiler generate atomic sequences of the | |
| specified model only. | |
| @end table | |
| @opindex mtas | |
| @item -mtas | |
| Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}. | |
| Notice that depending on the particular hardware and software configuration | |
| this can degrade overall performance due to the operand cache line flushes | |
| that are implied by the @code{tas.b} instruction. On multi-core SH4A | |
| processors the @code{tas.b} instruction must be used with caution since it | |
| can result in data corruption for certain cache configurations. | |
| @opindex mprefergot | |
| @item -mprefergot | |
| When generating position-independent code, emit function calls using | |
| the Global Offset Table instead of the Procedure Linkage Table. | |
| @opindex musermode | |
| @opindex mno-usermode | |
| @item -musermode | |
| @itemx -mno-usermode | |
| Don't allow (allow) the compiler to generate privileged mode code. Specifying | |
| @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the | |
| inlined code would not work in user mode. @option{-musermode} is the default | |
| when the target is @code{sh*-*-linux*}. If the target is SH1* or SH2* | |
| @option{-musermode} has no effect, since there is no user mode. | |
| @opindex multcost=@var{number} | |
| @item -multcost=@var{number} | |
| Set the cost to assume for a multiply instruction. | |
| @opindex mdiv=@var{strategy} | |
| @item -mdiv=@var{strategy} | |
| Set the division strategy to be used for integer division operations. | |
| @var{strategy} can be one of: | |
| @table @samp | |
| @item call-div1 | |
| Calls a library function that uses the single-step division instruction | |
| @code{div1} to perform the operation. Division by zero calculates an | |
| unspecified result and does not trap. This is the default except for SH4, | |
| SH2A and SHcompact. | |
| @item call-fp | |
| Calls a library function that performs the operation in double precision | |
| floating point. Division by zero causes a floating-point exception. This is | |
| the default for SHcompact with FPU. Specifying this for targets that do not | |
| have a double-precision FPU defaults to @code{call-div1}. | |
| @item call-table | |
| Calls a library function that uses a lookup table for small divisors and | |
| the @code{div1} instruction with case distinction for larger divisors. | |
| Division by zero calculates an unspecified result and does not trap. | |
| This is the default | |
| for SH4. Specifying this for targets that do not have dynamic shift | |
| instructions defaults to @code{call-div1}. | |
| @end table | |
| When a division strategy has not been specified, the default strategy is | |
| selected based on the current target. For SH2A the default strategy is to | |
| use the @code{divs} and @code{divu} instructions instead of library function | |
| calls. | |
| @opindex maccumulate-outgoing-args | |
| @opindex mno-accumulate-outgoing-args | |
| @item -maccumulate-outgoing-args | |
| @item -mno-accumulate-outgoing-args | |
| Reserve space once for outgoing arguments in the function prologue rather | |
| than around each call. This is generally beneficial for performance and | |
| size, and also needed for unwinding to avoid changing the stack frame | |
| around conditional code. @option{-maccumulate-outgoing-args} is | |
| enabled the default. | |
| @opindex mdivsi3_libfunc=@var{name} | |
| @item -mdivsi3_libfunc=@var{name} | |
| Set the name of the library function used for 32-bit signed division to | |
| @var{name}. | |
| This only affects the name used in the @samp{call} division strategies, | |
| and the compiler still expects the same sets of input/output/clobbered | |
| registers as if this option were not present. | |
| @opindex mfixed-range | |
| @item -mfixed-range=@var{register-range} | |
| Generate code treating the given register range as fixed registers. | |
| A fixed register is one that the register allocator cannot use. This is | |
| useful when compiling kernel code. A register range is specified as | |
| two registers separated by a dash. Multiple register ranges can be | |
| specified separated by a comma. | |
| @opindex mbranch-cost=@var{num} | |
| @item -mbranch-cost=@var{num} | |
| Assume @var{num} to be the cost for a branch instruction. Higher numbers | |
| make the compiler try to generate more branch-free code if possible. | |
| If not specified the value is selected depending on the processor type that | |
| is being compiled for. | |
| @opindex mzdcbranch | |
| @opindex mno-zdcbranch | |
| @item -mzdcbranch | |
| @itemx -mno-zdcbranch | |
| Assume (do not assume) that zero displacement conditional branch instructions | |
| @code{bt} and @code{bf} are fast. If @option{-mzdcbranch} is specified, the | |
| compiler prefers zero displacement branch code sequences. This is | |
| enabled by default when generating code for SH4 and SH4A. | |
| It can be explicitly disabled by specifying @option{-mno-zdcbranch}. | |
| @opindex mcbranch-force-delay-slot | |
| @item -mcbranch-force-delay-slot | |
| Force the usage of delay slots for conditional branches, which stuffs the | |
| delay slot with a @code{nop} if a suitable instruction cannot be found. | |
| By default | |
| this option is disabled. It can be enabled to work around hardware bugs as | |
| found in the original SH7055. | |
| @opindex mfsca | |
| @opindex mno-fsca | |
| @item -mfsca | |
| @itemx -mno-fsca | |
| Allow or disallow the compiler to emit the @code{fsca} instruction for sine | |
| and cosine approximations. The option @option{-mfsca} must be used in | |
| combination with @option{-funsafe-math-optimizations}. | |
| It is enabled by default when generating code for SH4A. | |
| Using @option{-mno-fsca} disables sine and cosine | |
| approximations even if @option{-funsafe-math-optimizations} is in effect. | |
| @opindex mfsrra | |
| @opindex mno-fsrra | |
| @item -mfsrra | |
| @itemx -mno-fsrra | |
| Allow or disallow the compiler to emit the @code{fsrra} instruction for | |
| reciprocal square root approximations. The option @option{-mfsrra} | |
| must be used in combination with @option{-funsafe-math-optimizations} and | |
| @option{-ffinite-math-only}. | |
| It is enabled by default when generating code for SH4A. | |
| Using @option{-mno-fsrra} disables reciprocal square root approximations | |
| even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} | |
| are in effect. | |
| @opindex mpretend-cmove | |
| @opindex mno-pretend-cmove | |
| @item -mpretend-cmove | |
| @itemx -mno-pretend-cmove | |
| Prefer or don't prefer zero-displacement conditional branches for | |
| conditional move instruction patterns. | |
| This can result in faster code on the SH4 processor. | |
| @opindex mfdpic | |
| @opindex mnofdpic | |
| @item -mfdpic | |
| @itemx -mno-fdpic | |
| Generate code using the FDPIC ABI. | |
| @end table | |
| @node Solaris 2 Options | |
| @subsection Solaris 2 Options | |
| @cindex Solaris 2 options | |
| These options are supported on Solaris 2: | |
| @table @gcctabopt | |
| @opindex mclear-hwcap | |
| @opindex mno-clear-hwcap | |
| @item -mclear-hwcap | |
| @itemx -mno-clear-hwcap | |
| @option{-mclear-hwcap} tells the compiler to remove the hardware | |
| capabilities generated by the Solaris assembler. This is only necessary | |
| when object files use ISA extensions not supported by the current | |
| machine, but check at runtime whether or not to use them. | |
| @opindex mimpure-text | |
| @opindex mno-impure-text | |
| @item -mimpure-text | |
| @itemx -mno-impure-text | |
| @option{-mimpure-text}, used in addition to @option{-shared}, tells | |
| the compiler to not pass @option{-z text} to the linker when linking a | |
| shared object. Using this option, you can link position-dependent | |
| code into a shared object. | |
| @option{-mimpure-text} suppresses the ``relocations remain against | |
| allocatable but non-writable sections'' linker error message. | |
| However, the necessary relocations trigger copy-on-write, and the | |
| shared object is not actually shared across processes. Instead of | |
| using @option{-mimpure-text}, you should compile all source code with | |
| @option{-fpic} or @option{-fPIC}. | |
| @opindex gsctf | |
| @item -gsctf | |
| Generate Solaris CTF. Needs to be used both for compilation and | |
| linking. See @command{ctf(7)} for more information. This is only | |
| supported since Solaris 11.4 SRU 84 where the necessary toolchain | |
| support was added. | |
| @end table | |
| @node SPARC Options | |
| @subsection SPARC Options | |
| @cindex SPARC options | |
| These @samp{-m} options are supported on the SPARC: | |
| @table @gcctabopt | |
| @opindex mno-app-regs | |
| @opindex mapp-regs | |
| @item -mno-app-regs | |
| @itemx -mapp-regs | |
| Specify @option{-mapp-regs} to generate output using the global registers | |
| 2 through 4, which the SPARC SVR4 ABI reserves for applications. Like the | |
| global register 1, each global register 2 through 4 is then treated as an | |
| allocable register that is clobbered by function calls. This is the default. | |
| To be fully SVR4 ABI-compliant at the cost of some performance loss, | |
| specify @option{-mno-app-regs}. You should compile libraries and system | |
| software with this option. | |
| @opindex mflat | |
| @opindex mno-flat | |
| @item -mflat | |
| @itemx -mno-flat | |
| With @option{-mflat}, the compiler does not generate save/restore instructions | |
| and uses a ``flat'' or single register window model. This model is compatible | |
| with the regular register window model. The local registers and the input | |
| registers (0--5) are still treated as ``call-saved'' registers and are | |
| saved on the stack as needed. | |
| With @option{-mno-flat} (the default), the compiler generates save/restore | |
| instructions (except for leaf functions). This is the normal operating mode. | |
| @opindex mfpu | |
| @opindex mhard-float | |
| @item -mfpu | |
| @itemx -mhard-float | |
| Generate output containing floating-point instructions. This is the | |
| default. | |
| @opindex mno-fpu | |
| @opindex msoft-float | |
| @item -mno-fpu | |
| @itemx -msoft-float | |
| Generate output containing library calls for floating point. | |
| @strong{Warning:} the requisite libraries are not available for all SPARC | |
| targets. Normally the facilities of the machine's usual C compiler are | |
| used, but this cannot be done directly in cross-compilation. You must make | |
| your own arrangements to provide suitable library functions for | |
| cross-compilation. The embedded targets @samp{sparc-*-aout} and | |
| @samp{sparclite-*-*} do provide software floating-point support. | |
| @option{-msoft-float} changes the calling convention in the output file; | |
| therefore, it is only useful if you compile @emph{all} of a program with | |
| this option. In particular, you need to compile @file{libgcc.a}, the | |
| library that comes with GCC, with @option{-msoft-float} in order for | |
| this to work. | |
| @opindex mhard-quad-float | |
| @item -mhard-quad-float | |
| Generate output containing quad-word (long double) floating-point | |
| instructions. | |
| @opindex msoft-quad-float | |
| @item -msoft-quad-float | |
| Generate output containing library calls for quad-word (long double) | |
| floating-point instructions. The functions called are those specified | |
| in the SPARC ABI@. This is the default. | |
| As of this writing, there are no SPARC implementations that have hardware | |
| support for the quad-word floating-point instructions. They all invoke | |
| a trap handler for one of these instructions, and then the trap handler | |
| emulates the effect of the instruction. Because of the trap handler overhead, | |
| this is much slower than calling the ABI library routines. Thus the | |
| @option{-msoft-quad-float} option is the default. | |
| @opindex mno-unaligned-doubles | |
| @opindex munaligned-doubles | |
| @item -mno-unaligned-doubles | |
| @itemx -munaligned-doubles | |
| Assume that doubles have 8-byte alignment. This is the default. | |
| With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte | |
| alignment only if they are contained in another type, or if they have an | |
| absolute address. Otherwise, it assumes they have 4-byte alignment. | |
| Specifying this option avoids some rare compatibility problems with code | |
| generated by other compilers. It is not the default because it results | |
| in a performance loss, especially for floating-point code. | |
| @opindex muser-mode | |
| @opindex mno-user-mode | |
| @item -muser-mode | |
| @itemx -mno-user-mode | |
| Do not generate code that can only run in supervisor mode. This is relevant | |
| only for the @code{casa} instruction emitted for the LEON3 processor. This | |
| is the default. | |
| @opindex mfaster-structs | |
| @opindex mno-faster-structs | |
| @item -mfaster-structs | |
| @itemx -mno-faster-structs | |
| With @option{-mfaster-structs}, the compiler assumes that structures | |
| should have 8-byte alignment. This enables the use of pairs of | |
| @code{ldd} and @code{std} instructions for copies in structure | |
| assignment, in place of twice as many @code{ld} and @code{st} pairs. | |
| However, the use of this changed alignment directly violates the SPARC | |
| ABI@. Thus, it's intended only for use on targets where the developer | |
| acknowledges that their resulting code is not directly in line with | |
| the rules of the ABI@. | |
| @opindex mstd-struct-return | |
| @opindex mno-std-struct-return | |
| @item -mstd-struct-return | |
| @itemx -mno-std-struct-return | |
| With @option{-mstd-struct-return}, the compiler generates checking code | |
| in functions returning structures or unions to detect size mismatches | |
| between the two sides of function calls, as per the 32-bit ABI@. | |
| The default is @option{-mno-std-struct-return}. This option has no effect | |
| in 64-bit mode. | |
| @opindex mcpu | |
| @item -mcpu=@var{cpu_type} | |
| Set the instruction set, register set, and instruction scheduling parameters | |
| for machine type @var{cpu_type}. Supported values for @var{cpu_type} are | |
| @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc}, | |
| @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{leon5}, @samp{sparclite}, | |
| @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, | |
| @samp{v9}, @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, | |
| @samp{niagara2}, @samp{niagara3}, @samp{niagara4}, @samp{niagara7} and | |
| @samp{m8}. | |
| Native Solaris and GNU/Linux toolchains also support the value @samp{native}, | |
| which selects the best architecture option for the host processor. | |
| @option{-mcpu=native} has no effect if GCC does not recognize | |
| the processor. | |
| Default instruction scheduling parameters are used for values that select | |
| an architecture and not an implementation. These are @samp{v7}, @samp{v8}, | |
| @samp{sparclite}, @samp{sparclet}, @samp{v9}. | |
| Here is a list of each supported architecture and their supported | |
| implementations. | |
| @table @asis | |
| @item v7 | |
| cypress, leon3v7 | |
| @item v8 | |
| supersparc, hypersparc, leon, leon3, leon5 | |
| @item sparclite | |
| f930, f934, sparclite86x | |
| @item sparclet | |
| tsc701 | |
| @item v9 | |
| ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4, | |
| niagara7, m8 | |
| @end table | |
| By default (unless configured otherwise), GCC generates code for the V7 | |
| variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler | |
| additionally optimizes it for the Cypress CY7C602 chip, as used in the | |
| SPARCStation/SPARCServer 3xx series. This is also appropriate for the older | |
| SPARCStation 1, 2, IPX etc. | |
| With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC | |
| architecture. The only difference from V7 code is that the compiler emits | |
| the integer multiply and integer divide instructions which exist in SPARC-V8 | |
| but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally | |
| optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and | |
| 2000 series. | |
| With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of | |
| the SPARC architecture. This adds the integer multiply, integer divide step | |
| and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7. | |
| With @option{-mcpu=f930}, the compiler additionally optimizes it for the | |
| Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With | |
| @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu | |
| MB86934 chip, which is the more recent SPARClite with FPU@. | |
| With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of | |
| the SPARC architecture. This adds the integer multiply, multiply/accumulate, | |
| integer divide step and scan (@code{ffs}) instructions which exist in SPARClet | |
| but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally | |
| optimizes it for the TEMIC SPARClet chip. | |
| With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC | |
| architecture. This adds 64-bit integer and floating-point move instructions, | |
| 3 additional floating-point condition code registers and conditional move | |
| instructions. With @option{-mcpu=ultrasparc}, the compiler additionally | |
| optimizes it for the Sun UltraSPARC I/II/IIi chips. With | |
| @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the | |
| Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips. With | |
| @option{-mcpu=niagara}, the compiler additionally optimizes it for | |
| Sun UltraSPARC T1 chips. With @option{-mcpu=niagara2}, the compiler | |
| additionally optimizes it for Sun UltraSPARC T2 chips. With | |
| @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun | |
| UltraSPARC T3 chips. With @option{-mcpu=niagara4}, the compiler | |
| additionally optimizes it for Sun UltraSPARC T4 chips. With | |
| @option{-mcpu=niagara7}, the compiler additionally optimizes it for | |
| Oracle SPARC M7 chips. With @option{-mcpu=m8}, the compiler | |
| additionally optimizes it for Oracle M8 chips. | |
| @opindex mtune | |
| @item -mtune=@var{cpu_type} | |
| Set the instruction scheduling parameters for machine type | |
| @var{cpu_type}, but do not set the instruction set or register set that the | |
| option @option{-mcpu=@var{cpu_type}} does. | |
| The same values for @option{-mcpu=@var{cpu_type}} can be used for | |
| @option{-mtune=@var{cpu_type}}, but the only useful values are those | |
| that select a particular CPU implementation. Those are | |
| @samp{cypress}, @samp{supersparc}, @samp{hypersparc}, @samp{leon}, | |
| @samp{leon3}, @samp{leon3v7}, @samp{leon5}, @samp{f930}, @samp{f934}, | |
| @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, | |
| @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3}, | |
| @samp{niagara4}, @samp{niagara7} and @samp{m8}. With native Solaris | |
| and GNU/Linux toolchains, @samp{native} can also be used. | |
| @opindex mv8plus | |
| @opindex mno-v8plus | |
| @item -mv8plus | |
| @itemx -mno-v8plus | |
| With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The | |
| difference from the V8 ABI is that the global and out registers are | |
| considered 64 bits wide. This is enabled by default on Solaris in 32-bit | |
| mode for all SPARC-V9 processors. | |
| @opindex mvis | |
| @opindex mno-vis | |
| @item -mvis | |
| @itemx -mno-vis | |
| With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC | |
| Visual Instruction Set extensions. The default is @option{-mno-vis}. | |
| @opindex mvis2 | |
| @opindex mno-vis2 | |
| @item -mvis2 | |
| @itemx -mno-vis2 | |
| With @option{-mvis2}, GCC generates code that takes advantage of | |
| version 2.0 of the UltraSPARC Visual Instruction Set extensions. The | |
| default is @option{-mvis2} when targeting a CPU that supports such | |
| instructions, such as UltraSPARC-III and later. Setting @option{-mvis2} | |
| also sets @option{-mvis}. | |
| @opindex mvis3 | |
| @opindex mno-vis3 | |
| @item -mvis3 | |
| @itemx -mno-vis3 | |
| With @option{-mvis3}, GCC generates code that takes advantage of | |
| version 3.0 of the UltraSPARC Visual Instruction Set extensions. The | |
| default is @option{-mvis3} when targeting a CPU that supports such | |
| instructions, such as niagara-3 and later. Setting @option{-mvis3} | |
| also sets @option{-mvis2} and @option{-mvis}. | |
| @opindex mvis3b | |
| @opindex mno-vis3b | |
| @item -mvis3b | |
| @itemx -mno-vis3b | |
| With @option{-mvis3b}, GCC generates code that takes advantage of | |
| version 3.0 of the UltraSPARC Visual Instruction Set extensions, plus | |
| the additional VIS instructions introduced in the Oracle SPARC | |
| Architecture 2011. The default is @option{-mvis3b} when targeting | |
| a CPU that supports such instructions, such as niagara-7 and later. | |
| Setting @option{-mvis3b} also sets @option{-mvis3}, @option{-mvis2} | |
| and @option{-mvis}. | |
| @opindex mvis4 | |
| @opindex mno-vis4 | |
| @item -mvis4 | |
| @itemx -mno-vis4 | |
| With @option{-mvis4}, GCC generates code that takes advantage of | |
| version 4.0 of the UltraSPARC Visual Instruction Set extensions. The | |
| default is @option{-mvis4} when targeting a CPU that supports such | |
| instructions, such as niagara-7 and later. Setting @option{-mvis4} | |
| also sets @option{-mvis3b}, @option{-mvis3}, @option{-mvis2} and | |
| @option{-mvis}. | |
| @opindex mvis4b | |
| @opindex mno-vis4b | |
| @item -mvis4b | |
| @itemx -mno-vis4b | |
| With @option{-mvis4b}, GCC generates code that takes advantage of | |
| version 4.0 of the UltraSPARC Visual Instruction Set extensions, plus | |
| the additional VIS instructions introduced in the Oracle SPARC | |
| Architecture 2017. The default is @option{-mvis4b} when targeting a | |
| CPU that supports such instructions, such as m8 and later. Setting | |
| @option{-mvis4b} also sets @option{-mvis4}, @option{-mvis3b}, | |
| @option{-mvis3}, @option{-mvis2} and @option{-mvis}. | |
| @opindex mcbcond | |
| @opindex mno-cbcond | |
| @item -mcbcond | |
| @itemx -mno-cbcond | |
| With @option{-mcbcond}, GCC generates code that takes advantage of the UltraSPARC | |
| Compare-and-Branch-on-Condition instructions. The default is @option{-mcbcond} | |
| when targeting a CPU that supports such instructions, such as Niagara-4 and | |
| later. | |
| @opindex mfmaf | |
| @opindex mno-fmaf | |
| @item -mfmaf | |
| @itemx -mno-fmaf | |
| With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC | |
| Fused Multiply-Add Floating-point instructions. The default is @option{-mfmaf} | |
| when targeting a CPU that supports such instructions, such as Niagara-3 and | |
| later. | |
| @opindex mfsmuld | |
| @opindex mno-fsmuld | |
| @item -mfsmuld | |
| @itemx -mno-fsmuld | |
| With @option{-mfsmuld}, GCC generates code that takes advantage of the | |
| Floating-point Multiply Single to Double (FsMULd) instruction. The default is | |
| @option{-mfsmuld} when targeting a CPU supporting the architecture versions V8 | |
| or V9 with FPU except @option{-mcpu=leon}. | |
| @opindex mpopc | |
| @opindex mno-popc | |
| @item -mpopc | |
| @itemx -mno-popc | |
| With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC | |
| Population Count instruction. The default is @option{-mpopc} | |
| when targeting a CPU that supports such an instruction, such as Niagara-2 and | |
| later. | |
| @opindex msubxc | |
| @opindex mno-subxc | |
| @item -msubxc | |
| @itemx -mno-subxc | |
| With @option{-msubxc}, GCC generates code that takes advantage of the UltraSPARC | |
| Subtract-Extended-with-Carry instruction. The default is @option{-msubxc} | |
| when targeting a CPU that supports such an instruction, such as Niagara-7 and | |
| later. | |
| @opindex mfix-at697f | |
| @item -mfix-at697f | |
| Enable the documented workaround for the single erratum of the Atmel AT697F | |
| processor (which corresponds to erratum #13 of the AT697E processor). | |
| @opindex mfix-ut699 | |
| @item -mfix-ut699 | |
| Enable the documented workarounds for the floating-point errata and the data | |
| cache nullify errata of the UT699 processor. | |
| @opindex mfix-ut700 | |
| @item -mfix-ut700 | |
| Enable the documented workaround for the back-to-back store errata of | |
| the UT699E/UT700 processor. | |
| @opindex mfix-gr712rc | |
| @item -mfix-gr712rc | |
| Enable the documented workaround for the back-to-back store errata of | |
| the GR712RC processor. | |
| @end table | |
| These @samp{-m} options are supported in addition to the above | |
| on SPARC-V9 processors in 64-bit environments: | |
| @table @gcctabopt | |
| @opindex m32 | |
| @opindex m64 | |
| @item -m32 | |
| @itemx -m64 | |
| Generate code for a 32-bit or 64-bit environment. | |
| The 32-bit environment sets int, long and pointer to 32 bits. | |
| The 64-bit environment sets int to 32 bits and long and pointer | |
| to 64 bits. | |
| @opindex mptr32 | |
| @opindex mptr64 | |
| @item -mptr32 | |
| @itemx -mptr64 | |
| Use 32- or 64-bit pointers, respectively. Unlike the @option{-m32} and | |
| @option{-m64} options, this affects only the pointer size and not the ABI. | |
| @opindex mcmodel= | |
| @item -mcmodel=@var{which} | |
| Set the code model to one of | |
| @table @samp | |
| @item medlow | |
| The Medium/Low code model: 64-bit addresses, programs | |
| must be linked in the low 32 bits of memory. Programs can be statically | |
| or dynamically linked. | |
| @item medmid | |
| The Medium/Middle code model: 64-bit addresses, programs | |
| must be linked in the low 44 bits of memory, the text and data segments must | |
| be less than 2GB in size and the data segment must be located within 2GB of | |
| the text segment. | |
| @item medany | |
| The Medium/Anywhere code model: 64-bit addresses, programs | |
| may be linked anywhere in memory, the text and data segments must be less | |
| than 2GB in size and the data segment must be located within 2GB of the | |
| text segment. | |
| @item embmedany | |
| The Medium/Anywhere code model for embedded systems: | |
| 64-bit addresses, the text and data segments must be less than 2GB in | |
| size, both starting anywhere in memory (determined at link time). The | |
| global register %g4 points to the base of the data segment. Programs | |
| are statically linked and PIC is not supported. | |
| @end table | |
| @opindex mmemory-model | |
| @item -mmemory-model=@var{mem-model} | |
| Set the memory model in force on the processor to one of | |
| @table @samp | |
| @item default | |
| The default memory model for the processor and operating system. | |
| @item rmo | |
| Relaxed Memory Order | |
| @item pso | |
| Partial Store Order | |
| @item tso | |
| Total Store Order | |
| @item sc | |
| Sequential Consistency | |
| @end table | |
| These memory models are formally defined in Appendix D of the SPARC-V9 | |
| architecture manual, as set in the processor's @code{PSTATE.MM} field. | |
| @opindex mstack-bias | |
| @opindex mno-stack-bias | |
| @item -mstack-bias | |
| @itemx -mno-stack-bias | |
| With @option{-mstack-bias}, GCC assumes that the stack pointer, and | |
| frame pointer if present, are offset by @minus{}2047 which must be added back | |
| when making stack frame references. This is the default in 64-bit mode. | |
| Otherwise, assume no such offset is present. | |
| @end table | |
| @node System V Options | |
| @subsection Options for System V | |
| These additional options are available on System V Release 4 for | |
| compatibility with other compilers on those systems: | |
| @table @gcctabopt | |
| @opindex G | |
| @item -G | |
| Create a shared object. | |
| It is recommended that @option{-symbolic} or @option{-shared} be used instead. | |
| @opindex YP | |
| @item -YP,@var{dirs} | |
| Search the directories @var{dirs}, and no others, for libraries | |
| specified with @option{-l}. | |
| @opindex Ym | |
| @item -Ym,@var{dir} | |
| Look in the directory @var{dir} to find the M4 preprocessor. | |
| The assembler uses this option. | |
| @c This is supposed to go with a -Yd for predefined M4 macro files, but | |
| @c the generic assembler that comes with Solaris takes just -Ym. | |
| @end table | |
| @node V850 Options | |
| @subsection V850 Options | |
| @cindex V850 Options | |
| These @samp{-m} options are defined for V850 implementations: | |
| @table @gcctabopt | |
| @opindex mlong-calls | |
| @opindex mno-long-calls | |
| @item -mlong-calls | |
| @itemx -mno-long-calls | |
| Treat all calls as being far away (near). If calls are assumed to be | |
| far away, the compiler always loads the function's address into a | |
| register, and calls indirect through the pointer. | |
| @opindex mno-ep | |
| @opindex mep | |
| @item -mno-ep | |
| @itemx -mep | |
| Do not optimize (do optimize) basic blocks that use the same index | |
| pointer 4 or more times to copy pointer into the @code{ep} register, and | |
| use the shorter @code{sld} and @code{sst} instructions. The @option{-mep} | |
| option is on by default if you optimize. | |
| @opindex mno-prolog-function | |
| @opindex mprolog-function | |
| @item -mno-prolog-function | |
| @itemx -mprolog-function | |
| Do not use (do use) external functions to save and restore registers | |
| at the prologue and epilogue of a function. The external functions | |
| are slower, but use less code space if more than one function saves | |
| the same number of registers. The @option{-mprolog-function} option | |
| is on by default if you optimize. | |
| @opindex mspace | |
| @item -mspace | |
| Try to make the code as small as possible. At present, this just turns | |
| on the @option{-mep} and @option{-mprolog-function} options. | |
| @opindex mtda | |
| @item -mtda=@var{n} | |
| Put static or global variables whose size is @var{n} bytes or less into | |
| the tiny data area that register @code{ep} points to. The tiny data | |
| area can hold up to 256 bytes in total (128 bytes for byte references). | |
| @opindex msda | |
| @item -msda=@var{n} | |
| Put static or global variables whose size is @var{n} bytes or less into | |
| the small data area that register @code{gp} points to. The small data | |
| area can hold up to 64 kilobytes. | |
| @opindex mzda | |
| @item -mzda=@var{n} | |
| Put static or global variables whose size is @var{n} bytes or less into | |
| the first 32 kilobytes of memory. | |
| @opindex mv850 | |
| @item -mv850 | |
| Specify that the target processor is the V850. | |
| @opindex mv850e3v5 | |
| @item -mv850e3v5 | |
| Specify that the target processor is the V850E3V5. The preprocessor | |
| constant @code{__v850e3v5__} is defined if this option is used. | |
| @opindex mv850e2v4 | |
| @item -mv850e2v4 | |
| Specify that the target processor is the V850E3V5. This is an alias for | |
| the @option{-mv850e3v5} option. | |
| @opindex mv850e2v3 | |
| @item -mv850e2v3 | |
| Specify that the target processor is the V850E2V3. The preprocessor | |
| constant @code{__v850e2v3__} is defined if this option is used. | |
| @opindex mv850e2 | |
| @item -mv850e2 | |
| Specify that the target processor is the V850E2. The preprocessor | |
| constant @code{__v850e2__} is defined if this option is used. | |
| @opindex mv850e1 | |
| @item -mv850e1 | |
| Specify that the target processor is the V850E1. The preprocessor | |
| constants @code{__v850e1__} and @code{__v850e__} are defined if | |
| this option is used. | |
| @opindex mv850es | |
| @item -mv850es | |
| Specify that the target processor is the V850ES. This is an alias for | |
| the @option{-mv850e1} option. | |
| @opindex mv850e | |
| @item -mv850e | |
| Specify that the target processor is the V850E@. The preprocessor | |
| constant @code{__v850e__} is defined if this option is used. | |
| If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1} | |
| nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5} | |
| are defined then a default target processor is chosen and the | |
| relevant @samp{__v850*__} preprocessor constant is defined. | |
| The preprocessor constants @code{__v850} and @code{__v851__} are always | |
| defined, regardless of which processor variant is the target. | |
| @opindex mdisable-callt | |
| @opindex mno-disable-callt | |
| @item -mdisable-callt | |
| @itemx -mno-disable-callt | |
| This option suppresses generation of the @code{CALLT} instruction for the | |
| v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850 | |
| architecture. | |
| This option is enabled by default when the RH850 ABI is | |
| in use (see @option{-mrh850-abi}), and disabled by default when the | |
| GCC ABI is in use. If @code{CALLT} instructions are being generated | |
| then the C preprocessor symbol @code{__V850_CALLT__} is defined. | |
| @opindex mrelax | |
| @opindex mno-relax | |
| @item -mrelax | |
| @itemx -mno-relax | |
| Pass on (or do not pass on) the @option{-mrelax} command-line option | |
| to the assembler. | |
| @opindex mlong-jumps | |
| @opindex mno-long-jumps | |
| @item -mlong-jumps | |
| @itemx -mno-long-jumps | |
| Disable (or re-enable) the generation of PC-relative jump instructions. | |
| @opindex msoft-float | |
| @opindex mhard-float | |
| @item -msoft-float | |
| @itemx -mhard-float | |
| Disable (or re-enable) the generation of hardware floating point | |
| instructions. This option is only significant when the target | |
| architecture is @samp{V850E2V3} or higher. If hardware floating point | |
| instructions are being generated then the C preprocessor symbol | |
| @code{__FPU_OK__} is defined, otherwise the symbol | |
| @code{__NO_FPU__} is defined. | |
| @opindex mloop | |
| @item -mloop | |
| Enables the use of the e3v5 LOOP instruction. The use of this | |
| instruction is not enabled by default when the e3v5 architecture is | |
| selected because its use is still experimental. | |
| @opindex mrh850-abi | |
| @opindex mghs | |
| @item -mrh850-abi | |
| @itemx -mghs | |
| Enables support for the RH850 version of the V850 ABI. This is the | |
| default. With this version of the ABI the following rules apply: | |
| @itemize | |
| @item | |
| Integer sized structures and unions are returned via a memory pointer | |
| rather than a register. | |
| @item | |
| Large structures and unions (more than 8 bytes in size) are passed by | |
| value. | |
| @item | |
| Functions are aligned to 16-bit boundaries. | |
| @item | |
| The @option{-m8byte-align} command-line option is supported. | |
| @item | |
| The @option{-mdisable-callt} command-line option is enabled by | |
| default. The @option{-mno-disable-callt} command-line option is not | |
| supported. | |
| @end itemize | |
| When this version of the ABI is enabled the C preprocessor symbol | |
| @code{__V850_RH850_ABI__} is defined. | |
| @opindex mgcc-abi | |
| @item -mgcc-abi | |
| Enables support for the old GCC version of the V850 ABI. With this | |
| version of the ABI the following rules apply: | |
| @itemize | |
| @item | |
| Integer sized structures and unions are returned in register @code{r10}. | |
| @item | |
| Large structures and unions (more than 8 bytes in size) are passed by | |
| reference. | |
| @item | |
| Functions are aligned to 32-bit boundaries, unless optimizing for | |
| size. | |
| @item | |
| The @option{-m8byte-align} command-line option is not supported. | |
| @item | |
| The @option{-mdisable-callt} command-line option is supported but not | |
| enabled by default. | |
| @end itemize | |
| When this version of the ABI is enabled the C preprocessor symbol | |
| @code{__V850_GCC_ABI__} is defined. | |
| @opindex m8byte-align | |
| @opindex mno-8byte-align | |
| @item -m8byte-align | |
| @itemx -mno-8byte-align | |
| Enables support for @code{double} and @code{long long} types to be | |
| aligned on 8-byte boundaries. The default is to restrict the | |
| alignment of all objects to at most 4-bytes. When | |
| @option{-m8byte-align} is in effect the C preprocessor symbol | |
| @code{__V850_8BYTE_ALIGN__} is defined. | |
| @opindex mbig-switch | |
| @opindex mno-big-switch | |
| @item -mbig-switch | |
| @itemx -mno-big-switch | |
| Generate code suitable for big switch tables. Use this option only if | |
| the assembler/linker complain about out of range branches within a switch | |
| table. | |
| @opindex mapp-regs | |
| @opindex mno-app-regs | |
| @item -mapp-regs | |
| @itemx -mno-app-regs | |
| @option{-mapp-regs} causes r2 and r5 to be used in the code generated by | |
| the compiler. This setting is the default. @option{-mno-app-regs} | |
| causes r2 and r5 to be treated as fixed registers. | |
| @opindex msmall-sld | |
| @opindex mno-small-sld | |
| @item -msmall-sld | |
| @itemx -mno-small-sld | |
| Enable or disable the use of the short load instructions. | |
| @opindex mno-strict-align | |
| @item -mno-strict-align | |
| Do not enforce strict data alignment. | |
| @opindex mjump-tables-in-data-section | |
| @opindex mno-jump-tables-in-data-section | |
| @item -mjump-tables-in-data-section | |
| @itemx -mno-jump-tables-in-data-section | |
| Enable or disable placement of jump tables for switch statements in | |
| the @code{.data} section rather than the @code{.code} section. The | |
| default is @option{-mno-jump-tables-in-data-section}. | |
| @end table | |
| @node VAX Options | |
| @subsection VAX Options | |
| @cindex VAX options | |
| These @samp{-m} options are defined for the VAX: | |
| @table @gcctabopt | |
| @opindex munix | |
| @item -munix | |
| Do not output certain jump instructions (@code{aobleq} and so on) | |
| that the Unix assembler for the VAX cannot handle across long | |
| ranges. | |
| @opindex mgnu | |
| @item -mgnu | |
| Do output those jump instructions, on the assumption that the | |
| GNU assembler is being used. | |
| @opindex md | |
| @opindex md-float | |
| @item -md | |
| @itemx -md-float | |
| Use the D_floating data format for double-precision floating-point numbers | |
| instead of G_floating. | |
| @opindex mg | |
| @opindex mg-float | |
| @item -mg | |
| @itemx -mg-float | |
| Use the G_floating data format for double-precision floating-point numbers | |
| instead of D_floating. | |
| @opindex mlra | |
| @opindex mno-lra | |
| @item -mlra | |
| @itemx -mno-lra | |
| Enable Local Register Allocation. This is still experimental for the VAX, | |
| so by default the compiler uses standard reload. | |
| @opindex mvaxc-alignment | |
| @item -mvaxc-alignment | |
| Use VAXC conventions for alignment of structure members. | |
| @opindex mqmath | |
| @opindex mno-qmath | |
| @item -mqmath | |
| @itemx -mno-qmath | |
| Enable or disable new instruction patterns for 64-bit integer addition | |
| and subtraction. | |
| @end table | |
| @node Visium Options | |
| @subsection Visium Options | |
| @cindex Visium options | |
| @table @gcctabopt | |
| @opindex mdebug | |
| @item -mdebug | |
| Use this option when linking programs that perform file I/O and are | |
| destined to run on an MCM target. It causes the libraries | |
| @file{libc.a} and @file{libdebug.a} to be linked. You should run program | |
| on the target under the control of the GDB remote debugging stub. | |
| @opindex msim | |
| @item -msim | |
| Use this option when linking programs that perform file I/O and are | |
| destined to run on the simulator. It causes the libraries | |
| @file{libc.a} and @file{libsim.a} to be linked. | |
| @opindex mfpu | |
| @opindex mhard-float | |
| @item -mfpu | |
| @itemx -mhard-float | |
| Generate code containing floating-point instructions. This is the | |
| default. | |
| @opindex mno-fpu | |
| @opindex msoft-float | |
| @item -mno-fpu | |
| @itemx -msoft-float | |
| Generate code containing library calls for floating-point. | |
| @option{-msoft-float} changes the calling convention in the output file; | |
| therefore, it is only useful if you compile @emph{all} of a program with | |
| this option. In particular, you need to compile @file{libgcc.a}, the | |
| library that comes with GCC, with @option{-msoft-float} in order for | |
| this to work. | |
| @opindex mcpu | |
| @item -mcpu=@var{cpu_type} | |
| Set the instruction set, register set, and instruction scheduling parameters | |
| for machine type @var{cpu_type}. Supported values for @var{cpu_type} are | |
| @samp{mcm}, @samp{gr5} and @samp{gr6}. | |
| @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility. | |
| By default (unless configured otherwise), GCC generates code for the GR5 | |
| variant of the Visium architecture. | |
| With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium | |
| architecture. The only difference from GR5 code is that the compiler will | |
| generate block move instructions. | |
| @opindex mtune | |
| @item -mtune=@var{cpu_type} | |
| Set the instruction scheduling parameters for machine type @var{cpu_type}, | |
| but do not set the instruction set or register set that the option | |
| @option{-mcpu=@var{cpu_type}} would. | |
| @opindex msv-mode | |
| @item -msv-mode | |
| Generate code for the supervisor mode, where there are no restrictions on | |
| the access to general registers. This is the default. | |
| @opindex muser-mode | |
| @item -muser-mode | |
| Generate code for the user mode, where the access to some general registers | |
| is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this | |
| mode; on the GR6, only registers r29 to r31 are affected. | |
| @end table | |
| @node VMS Options | |
| @subsection VMS Options | |
| These @samp{-m} options are defined for the VMS implementations: | |
| @table @gcctabopt | |
| @opindex mvms-return-codes | |
| @item -mvms-return-codes | |
| Return VMS condition codes from @code{main}. The default is to return POSIX-style | |
| condition (e.g.@: error) codes. | |
| @opindex mdebug-main=@var{prefix} | |
| @item -mdebug-main=@var{prefix} | |
| Flag the first routine whose name starts with @var{prefix} as the main | |
| routine for the debugger. | |
| @opindex mmalloc64 | |
| @item -mmalloc64 | |
| Default to 64-bit memory allocation routines. | |
| @opindex mpointer-size=@var{size} | |
| @item -mpointer-size=@var{size} | |
| Set the default size of pointers. Possible options for @var{size} are | |
| @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long} | |
| for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers. | |
| The later option disables @code{pragma pointer_size}. | |
| @end table | |
| @node VxWorks Options | |
| @subsection VxWorks Options | |
| @cindex VxWorks Options | |
| The options in this section are defined for all VxWorks targets. | |
| Options specific to the target hardware are listed with the other | |
| options for that target. | |
| @table @gcctabopt | |
| @opindex mrtp | |
| @item -mrtp | |
| GCC can generate code for both VxWorks kernels and real time processes | |
| (RTPs). This option switches from the former to the latter. It also | |
| defines the preprocessor macro @code{__RTP__}. | |
| @opindex msmp | |
| @item -msmp | |
| Select SMP runtimes for linking. Not available on architectures other | |
| than PowerPC, nor on VxWorks version 7 or later, in which the selection | |
| is part of the VxWorks build configuration and the library paths are the | |
| same for either choice. | |
| @opindex mvthreads | |
| @item -mvthreads | |
| Link against the VxWorks AE vThread runtime environment. | |
| @opindex non-static | |
| @item -non-static | |
| Link an RTP executable against shared libraries rather than static | |
| libraries. The options @option{-static} and @option{-shared} can | |
| also be used for RTPs (@pxref{Link Options}); @option{-static} | |
| is the default. | |
| @opindex Bstatic | |
| @opindex Bdynamic | |
| @item -Bstatic | |
| @itemx -Bdynamic | |
| These options are passed down to the linker. They are defined for | |
| compatibility with Diab. | |
| @opindex Xbind-lazy | |
| @item -Xbind-lazy | |
| Enable lazy binding of function calls. This option is equivalent to | |
| @option{-Wl,-z,now} and is defined for compatibility with Diab. | |
| @opindex Xbind-now | |
| @item -Xbind-now | |
| Disable lazy binding of function calls. This option is the default and | |
| is defined for compatibility with Diab. | |
| @end table | |
| @node x86 Options | |
| @subsection x86 Options | |
| @cindex x86 Options | |
| This section documents @option{-m} options available for the x86 family | |
| of computers. | |
| The following group of options allows compilation to target a specific | |
| processor. | |
| @table @gcctabopt | |
| @opindex march | |
| @item -march=@var{cpu-type} | |
| Generate instructions for the machine type @var{cpu-type}. In contrast to | |
| @option{-mtune=@var{cpu-type}}, which merely tunes the generated code | |
| for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC | |
| to generate code that may not run at all on processors other than the one | |
| indicated. Specifying @option{-march=@var{cpu-type}} implies | |
| @option{-mtune=@var{cpu-type}}, except where noted otherwise. | |
| The choices for @var{cpu-type} are: | |
| @table @samp | |
| @item native | |
| This selects the CPU to generate code for at compilation time by determining | |
| the processor type of the compiling machine. Using @option{-march=native} | |
| enables all instruction subsets supported by the local machine (hence | |
| the result might not run on different machines). Using @option{-mtune=native} | |
| produces code optimized for the local machine under the constraints | |
| of the selected instruction set. | |
| @item x86-64 | |
| A generic CPU with 64-bit extensions, MMX, SSE, SSE2, and FXSR instruction set | |
| support. | |
| @item x86-64-v2 | |
| @itemx x86-64-v3 | |
| @itemx x86-64-v4 | |
| These choices for @var{cpu-type} select the corresponding | |
| micro-architecture level from the x86-64 psABI. On ABIs other than | |
| the x86-64 psABI they select the same CPU features as the x86-64 psABI | |
| documents for the particular micro-architecture level. | |
| Since these @var{cpu-type} values do not have a corresponding | |
| @option{-mtune} setting, using @option{-march} with these values enables | |
| generic tuning. Specific tuning can be enabled using the | |
| @option{-mtune=@var{other-cpu-type}} option with an appropriate | |
| @var{other-cpu-type} value. | |
| @item i386 | |
| Original Intel i386 CPU@. | |
| @item i486 | |
| Intel i486 CPU@. (No scheduling is implemented for this chip.) | |
| @item i586 | |
| @itemx pentium | |
| Intel Pentium CPU with no MMX support. | |
| @item lakemont | |
| Intel Lakemont MCU, based on Intel Pentium CPU. | |
| @item pentium-mmx | |
| Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support. | |
| @item pentiumpro | |
| Intel Pentium Pro CPU with no MMX support. | |
| @item i686 | |
| When used with @option{-march}, the Pentium Pro | |
| instruction set is used, so the code runs on all i686 family chips. | |
| When used with @option{-mtune}, it has the same meaning as @samp{generic}. | |
| @item pentium2 | |
| Intel Pentium II CPU, based on Pentium Pro core with MMX and FXSR instruction | |
| set support. | |
| @item pentium3 | |
| @itemx pentium3m | |
| Intel Pentium III CPU, based on Pentium Pro core with MMX, FXSR and SSE | |
| instruction set support. | |
| @item pentium-m | |
| Intel Pentium M; low-power version of Intel Pentium III CPU | |
| with MMX, SSE, SSE2 and FXSR instruction set support. Used by Centrino | |
| notebooks. | |
| @item pentium4 | |
| @itemx pentium4m | |
| Intel Pentium 4 CPU with MMX, SSE, SSE2 and FXSR instruction set support. | |
| @item prescott | |
| Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2, SSE3 and FXSR | |
| instruction set support. | |
| @item nocona | |
| Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE, | |
| SSE2, SSE3, CX16 and FXSR instruction set support. | |
| @item core2 | |
| Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, CX16, | |
| SAHF and FXSR instruction set support. | |
| @item nehalem | |
| @itemx corei7 | |
| Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF and FXSR instruction set support. | |
| @item westmere | |
| Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR and PCLMUL instruction set support. | |
| @item sandybridge | |
| @itemx corei7-avx | |
| Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE and PCLMUL instruction set | |
| support. | |
| @item ivybridge | |
| @itemx core-avx-i | |
| Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND | |
| and F16C instruction set support. | |
| @item haswell | |
| @itemx core-avx2 | |
| Intel Haswell CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, | |
| F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE and HLE instruction set support. | |
| @item broadwell | |
| Intel Broadwell CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, | |
| F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX and PREFETCHW | |
| instruction set support. | |
| @item skylake | |
| Intel Skylake CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, | |
| F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, | |
| CLFLUSHOPT, XSAVEC, XSAVES and SGX instruction set support. | |
| @item skylake-avx512 | |
| Intel Skylake Server CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, | |
| RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, | |
| AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, CLWB, AVX512VL, AVX512BW, | |
| AVX512DQ and AVX512CD instruction set support. | |
| @item cascadelake | |
| Intel Cascade Lake CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, | |
| F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, | |
| CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, CLWB, AVX512VL, AVX512BW, AVX512DQ, | |
| AVX512CD and AVX512VNNI instruction set support. | |
| @item cannonlake | |
| Intel Cannon Lake Server CPU with 64-bit extensions, MMX, SSE, SSE2, | |
| SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, | |
| FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, | |
| PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, | |
| AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA and SHA instruction set | |
| support. | |
| @item cooperlake | |
| Intel Cooper Lake CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, | |
| F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, | |
| CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, CLWB, AVX512VL, AVX512BW, AVX512DQ, | |
| AVX512CD, AVX512VNNI and AVX512BF16 instruction set support. | |
| @item icelake-client | |
| Intel Ice Lake Client CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, | |
| RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, | |
| AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, | |
| AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2 | |
| , VPCLMULQDQ, AVX512BITALG, RDPID and AVX512VPOPCNTDQ instruction set support. | |
| @item icelake-server | |
| Intel Ice Lake Server CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, | |
| RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, | |
| AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, | |
| AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2 | |
| , VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD and CLWB | |
| instruction set support. | |
| @item tigerlake | |
| Intel Tiger Lake CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, | |
| F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, | |
| CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD | |
| PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, | |
| VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, MOVDIRI, MOVDIR64B, CLWB, | |
| AVX512VP2INTERSECT and KEYLOCKER instruction set support. | |
| @item rocketlake | |
| Intel Rocket Lake CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, RDRND, | |
| F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, AES, | |
| CLFLUSHOPT, XSAVEC, XSAVES, AVX512F, AVX512VL, AVX512BW, AVX512DQ, AVX512CD | |
| PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, | |
| VPCLMULQDQ, AVX512BITALG, RDPID and AVX512VPOPCNTDQ instruction set support. | |
| @item alderlake | |
| @itemx raptorlake | |
| @itemx meteorlake | |
| @itemx gracemont | |
| Intel Alder Lake/Raptor Lake/Meteor Lake/Gracemont CPU with 64-bit extensions, | |
| MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, | |
| AES, PREFETCHW, | |
| PCLMUL, RDRND, XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, | |
| GFNI-SSE, CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, | |
| FMA, LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL and | |
| AVX-VNNI instruction set support. | |
| @item arrowlake | |
| Intel Arrow Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, | |
| AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, | |
| XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, | |
| MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, | |
| VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, UINTR, AVXIFMA, | |
| AVXVNNIINT8, AVXNECONVERT and CMPCCXADD instruction set support. | |
| @item arrowlake-s | |
| @itemx lunarlake | |
| Intel Arrow Lake S/Lunar Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, | |
| SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, | |
| XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, | |
| MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, | |
| PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, UINTR, | |
| AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3 and | |
| SM4 instruction set support. | |
| @item pantherlake | |
| @itemx wildcatlake | |
| Intel Panther Lake/Wildcat Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, | |
| SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, AES, PREFETCHW, PCLMUL, RDRND, | |
| XSAVE, XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, | |
| CLWB, MOVDIRI, MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, | |
| LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, AVX-VNNI, UINTR, | |
| AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3 and | |
| SM4 instruction set support. | |
| @item novalake | |
| Intel Nova Lake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, | |
| AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, | |
| XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, | |
| MOVDIR64B, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, PCONFIG, PKU, | |
| VAES, VPCLMULQDQ, SERIALIZE, HRESET, AVX-VNNI, UINTR, AVXIFMA, AVXVNNIINT8, | |
| AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, SM3, SM4, PREFETCHI, APX_F, | |
| AVX10.1, AVX10.2 and MOVRS instruction set support. | |
| @item sapphirerapids | |
| @itemx emeraldrapids | |
| Intel Sapphire Rapids/Emerald Rapids CPU with 64-bit extensions, MMX, SSE, | |
| SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, | |
| FSGSBASE, RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, | |
| PREFETCHW, AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, | |
| AVX512DQ, AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, | |
| AVX512VBMI2, VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, | |
| WBNOINVD, CLWB, MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, | |
| SERIALIZE, TSXLDTRK, UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512-FP16 | |
| and AVX512BF16 instruction set support. | |
| @item graniterapids | |
| Intel Granite Rapids CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, | |
| RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, | |
| AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, | |
| AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, | |
| VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, | |
| MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, | |
| UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512-FP16, AVX512BF16, AMX-FP16 | |
| and PREFETCHI instruction set support. | |
| @item graniterapids-d | |
| Intel Granite Rapids D CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, | |
| RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, | |
| AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, | |
| AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, | |
| VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, | |
| MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, | |
| UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512FP16, AVX512BF16, AMX-FP16, | |
| PREFETCHI and AMX-COMPLEX instruction set support. | |
| @item diamondrapids | |
| Intel Diamond Rapids CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, AVX, XSAVE, PCLMUL, FSGSBASE, | |
| RDRND, F16C, AVX2, BMI, BMI2, LZCNT, FMA, MOVBE, HLE, RDSEED, ADCX, PREFETCHW, | |
| AES, CLFLUSHOPT, XSAVEC, XSAVES, SGX, AVX512F, AVX512VL, AVX512BW, AVX512DQ, | |
| AVX512CD, PKU, AVX512VBMI, AVX512IFMA, SHA, AVX512VNNI, GFNI, VAES, AVX512VBMI2, | |
| VPCLMULQDQ, AVX512BITALG, RDPID, AVX512VPOPCNTDQ, PCONFIG, WBNOINVD, CLWB, | |
| MOVDIRI, MOVDIR64B, ENQCMD, CLDEMOTE, PTWRITE, WAITPKG, SERIALIZE, TSXLDTRK, | |
| UINTR, AMX-BF16, AMX-TILE, AMX-INT8, AVX-VNNI, AVX512FP16, AVX512BF16, AMX-FP16, | |
| PREFETCHI, AMX-COMPLEX, AVX10.1-512, AVX-IFMA, AVX-NE-CONVERT, AVX-VNNI-INT16, | |
| AVX-VNNI-INT8, CMPccXADD, SHA512, SM3, SM4, AVX10.2-512, APX_F, AMX-AVX512, | |
| AMX-FP8, MOVRS and AMX-MOVRS instruction set support. | |
| @item bonnell | |
| @itemx atom | |
| Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3 | |
| and CX16 instruction set support. | |
| @item silvermont | |
| @itemx slm | |
| Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW and RDRND | |
| instruction set support. | |
| @item goldmont | |
| Intel Goldmont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW, RDRND, AES, SHA, | |
| RDSEED, XSAVE, XSAVEC, XSAVES, XSAVEOPT, CLFLUSHOPT and FSGSBASE instruction | |
| set support. | |
| @item goldmont-plus | |
| Intel Goldmont Plus CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW, RDRND, AES, | |
| SHA, RDSEED, XSAVE, XSAVEC, XSAVES, XSAVEOPT, CLFLUSHOPT, FSGSBASE, PTWRITE, | |
| RDPID and SGX instruction set support. | |
| @item tremont | |
| Intel Tremont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, | |
| SSE4.1, SSE4.2, POPCNT, CX16, SAHF, FXSR, PCLMUL, PREFETCHW, RDRND, AES, SHA, | |
| RDSEED, XSAVE, XSAVEC, XSAVES, XSAVEOPT, CLFLUSHOPT, FSGSBASE, PTWRITE, RDPID, | |
| SGX, CLWB, GFNI-SSE, MOVDIRI, MOVDIR64B, CLDEMOTE and WAITPKG instruction set | |
| support. | |
| @item sierraforest | |
| Intel Sierra Forest CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, | |
| AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, | |
| XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, | |
| MOVDIR64B, CLDEMOTE, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, | |
| PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, | |
| AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, ENQCMD and UINTR instruction set | |
| support. | |
| @item grandridge | |
| Intel Grand Ridge CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, | |
| SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, | |
| AES, PREFETCHW, PCLMUL, RDRND, XSAVE, XSAVEC, | |
| XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, MOVDIRI, | |
| MOVDIR64B, CLDEMOTE, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, LZCNT, | |
| PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, KL, WIDEKL, AVX-VNNI, | |
| AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, ENQCMD and UINTR instruction set | |
| support. | |
| @item clearwaterforest | |
| Intel Clearwater Forest CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, | |
| SSE3, SSSE3, SSE4.1, SSE4.2, POPCNT, CX16, | |
| AES, PREFETCHW, PCLMUL, RDRND, XSAVE, | |
| XSAVEC, XSAVES, XSAVEOPT, FSGSBASE, PTWRITE, RDPID, SGX, GFNI-SSE, CLWB, | |
| MOVDIRI, MOVDIR64B, CLDEMOTE, WAITPKG, ADCX, AVX, AVX2, BMI, BMI2, F16C, FMA, | |
| LZCNT, PCONFIG, PKU, VAES, VPCLMULQDQ, SERIALIZE, HRESET, AVX-VNNI, ENQCMD, | |
| UINTR, AVXIFMA, AVXVNNIINT8, AVXNECONVERT, CMPCCXADD, AVXVNNIINT16, SHA512, | |
| SM3, SM4, USER_MSR and PREFETCHI instruction set support. | |
| @item k6 | |
| AMD K6 CPU with MMX instruction set support. | |
| @item k6-2 | |
| @itemx k6-3 | |
| Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support. | |
| @item athlon | |
| @itemx athlon-tbird | |
| AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions | |
| support. | |
| @item athlon-4 | |
| @itemx athlon-xp | |
| @itemx athlon-mp | |
| Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE | |
| instruction set support. | |
| @item k8 | |
| @itemx opteron | |
| @itemx athlon64 | |
| @itemx athlon-fx | |
| Processors based on the AMD K8 core with x86-64 instruction set support, | |
| including the AMD Opteron, Athlon 64, and Athlon 64 FX processors. | |
| (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit | |
| instruction set extensions.) | |
| @item k8-sse3 | |
| @itemx opteron-sse3 | |
| @itemx athlon64-sse3 | |
| Improved versions of AMD K8 cores with SSE3 instruction set support. | |
| @item amdfam10 | |
| @itemx barcelona | |
| CPUs based on AMD Family 10h cores with x86-64 instruction set support. (This | |
| supersets CX16, MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit | |
| instruction set extensions.) | |
| @item bdver1 | |
| CPUs based on AMD Family 15h cores with x86-64 instruction set support. (This | |
| supersets FMA4, AVX, XOP, LWP, AES, PCLMUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, | |
| SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.) | |
| @item bdver2 | |
| AMD Family 15h core based CPUs with x86-64 instruction set support. (This | |
| supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCLMUL, CX16, MMX, | |
| SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set | |
| extensions.) | |
| @item bdver3 | |
| AMD Family 15h core based CPUs with x86-64 instruction set support. (This | |
| supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, | |
| PCLMUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and | |
| 64-bit instruction set extensions.) | |
| @item bdver4 | |
| AMD Family 15h core based CPUs with x86-64 instruction set support. (This | |
| supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, | |
| AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, | |
| SSE4.2, ABM and 64-bit instruction set extensions.) | |
| @item znver1 | |
| AMD Family 17h core based CPUs with x86-64 instruction set support. (This | |
| supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX, | |
| SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, | |
| SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit | |
| instruction set extensions.) | |
| @item znver2 | |
| AMD Family 17h core based CPUs with x86-64 instruction set support. (This | |
| supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, | |
| MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, | |
| SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, | |
| WBNOINVD, and 64-bit instruction set extensions.) | |
| @item znver3 | |
| AMD Family 19h core based CPUs with x86-64 instruction set support. (This | |
| supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, | |
| MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, | |
| SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, | |
| WBNOINVD, PKU, VPCLMULQDQ, VAES, and 64-bit instruction set extensions.) | |
| @item znver4 | |
| AMD Family 19h core based CPUs with x86-64 instruction set support. (This | |
| supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, | |
| MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, | |
| SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, | |
| WBNOINVD, PKU, VPCLMULQDQ, VAES, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, | |
| AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, AVX512VNNI, | |
| AVX512BITALG, AVX512VPOPCNTDQ, GFNI and 64-bit instruction set extensions.) | |
| @item znver5 | |
| AMD Family 1ah core based CPUs with x86-64 instruction set support. (This | |
| supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, | |
| MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, | |
| SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, | |
| WBNOINVD, PKU, VPCLMULQDQ, VAES, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, | |
| AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, AVX512VNNI, | |
| AVX512BITALG, AVX512VPOPCNTDQ, GFNI, AVXVNNI, MOVDIRI, MOVDIR64B, | |
| AVX512VP2INTERSECT, PREFETCHI and 64-bit instruction set extensions.) | |
| @item znver6 | |
| AMD Family 1ah core based CPUs with x86-64 instruction set support. (This | |
| supersets BMI, BMI2, CLWB, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, | |
| MWAITX, SHA, CLZERO, AES, PCLMUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, | |
| SSSE3, SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, RDPID, | |
| WBNOINVD, PKU, VPCLMULQDQ, VAES, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, | |
| AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, AVX512VNNI, | |
| AVX512BITALG, AVX512VPOPCNTDQ, GFNI, AVXVNNI, MOVDIRI, MOVDIR64B, | |
| AVX512VP2INTERSECT, PREFETCHI, AVXVNNIINT8, AVXIFMA, AVX512FP16, AVXNECONVERT, | |
| AVX512BMM and 64-bit instruction set extensions.) | |
| @item btver1 | |
| CPUs based on AMD Family 14h cores with x86-64 instruction set support. (This | |
| supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit | |
| instruction set extensions.) | |
| @item btver2 | |
| CPUs based on AMD Family 16h cores with x86-64 instruction set support. This | |
| includes MOVBE, F16C, BMI, AVX, PCLMUL, AES, SSE4.2, SSE4.1, CX16, ABM, | |
| SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions. | |
| @item winchip-c6 | |
| IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction | |
| set support. | |
| @item winchip2 | |
| IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@: | |
| instruction set support. | |
| @item c3 | |
| VIA C3 CPU with MMX and 3DNow!@: instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item c3-2 | |
| VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item c7 | |
| VIA C7 (Esther) CPU with MMX, SSE, SSE2 and SSE3 instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item samuel-2 | |
| VIA Eden Samuel 2 CPU with MMX and 3DNow!@: instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item nehemiah | |
| VIA Eden Nehemiah CPU with MMX and SSE instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item esther | |
| VIA Eden Esther CPU with MMX, SSE, SSE2 and SSE3 instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item eden-x2 | |
| VIA Eden X2 CPU with x86-64, MMX, SSE, SSE2 and SSE3 instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item eden-x4 | |
| VIA Eden X4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, | |
| AVX and AVX2 instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item nano | |
| Generic VIA Nano CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3 | |
| instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item nano-1000 | |
| VIA Nano 1xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3 | |
| instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item nano-2000 | |
| VIA Nano 2xxx CPU with x86-64, MMX, SSE, SSE2, SSE3 and SSSE3 | |
| instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item nano-3000 | |
| VIA Nano 3xxx CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 | |
| instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item nano-x2 | |
| VIA Nano Dual Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 | |
| instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item nano-x4 | |
| VIA Nano Quad Core CPU with x86-64, MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 | |
| instruction set support. | |
| (No scheduling is implemented for this chip.) | |
| @item lujiazui | |
| ZHAOXIN lujiazui CPU with x86-64, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, | |
| SSE4.2, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE, CX16, | |
| ABM, BMI, BMI2, FXSR, RDSEED instruction set support. While the CPUs | |
| do support AVX and F16C, these aren't enabled by @code{-march=lujiazui} | |
| for performance reasons. | |
| @item yongfeng | |
| ZHAOXIN yongfeng CPU with x86-64, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, | |
| SSE4.2, AVX, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE, CX16, | |
| ABM, BMI, BMI2, F16C, FXSR, RDSEED, AVX2, FMA, SHA, LZCNT | |
| instruction set support. | |
| @item shijidadao | |
| ZHAOXIN shijidadao CPU with x86-64, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, | |
| SSE4.2, AVX, POPCNT, AES, PCLMUL, RDRND, XSAVE, XSAVEOPT, FSGSBASE, CX16, | |
| ABM, BMI, BMI2, F16C, FXSR, RDSEED, AVX2, FMA, SHA, LZCNT | |
| instruction set support. | |
| @item geode | |
| AMD Geode embedded processor with MMX and 3DNow!@: instruction set support. | |
| @item c86-4g-m4 | |
| HYGON c86-4g-m4 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, | |
| SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, | |
| XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, | |
| CLFLUSHOPT, XSAVES, LZCNT, POPCNT instruction set support. | |
| @item c86-4g-m6 | |
| HYGON c86-4g-m6 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, | |
| SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, | |
| XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, | |
| CLFLUSHOPT, XSAVES, LZCNT, POPCNT instruction set support. | |
| @item c86-4g-m7 | |
| HYGON c86-4g-m7 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, | |
| SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, | |
| XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, | |
| CLFLUSHOPT, XSAVES, LZCNT, POPCNT, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, | |
| AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, GFNI, AVX512VNNI, VAES, | |
| AVX512BITALG, AVX512VPOPCNTDQ, AVX512VP2INTERSECT, AVXVNNI, VPCLMULQDQ, | |
| WBNOINVD instruction set support. | |
| @item c86-4g-m8 | |
| HYGON c86-4g-m8 CPU with x86-64, MMX, SSE, SSE2, SSE3, SSE4A, CX16, ABM, SSSE3, | |
| SSE4.1, SSE4.2, AES, PCLMUL, AVX, AVX2, BMI, BMI2, F16C, FMA, PRFCHW, FXSR, SHA, | |
| XSAVE, XSAVEOPT, XSAVEC, FSGSBASE, RDRND, MOVBE, MWAITX, ADX, RDSEED, CLZERO, | |
| CLFLUSHOPT, XSAVES, LZCNT, POPCNT, AVX512F, AVX512DQ, AVX512IFMA, AVX512CD, | |
| AVX512BW, AVX512VL, AVX512BF16, AVX512VBMI, AVX512VBMI2, GFNI, AVX512VNNI, VAES, | |
| AVX512BITALG, AVX512VPOPCNTDQ, AVX512VP2INTERSECT, AVXVNNI, VPCLMULQDQ, | |
| WBNOINVD instruction set support. | |
| @end table | |
| @opindex mtune | |
| @item -mtune=@var{cpu-type} | |
| Tune to @var{cpu-type} everything applicable about the generated code, except | |
| for the ABI and the set of available instructions. | |
| While picking a specific @var{cpu-type} schedules things appropriately | |
| for that particular chip, the compiler does not generate any code that | |
| cannot run on the default machine type unless you use a | |
| @option{-march=@var{cpu-type}} option. | |
| For example, if GCC is configured for i686-pc-linux-gnu | |
| then @option{-mtune=pentium4} generates code that is tuned for Pentium 4 | |
| but still runs on i686 machines. | |
| The choices for @var{cpu-type} are the same as for @option{-march}. | |
| In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}: | |
| @table @samp | |
| @item generic | |
| Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors. | |
| If you know the CPU on which your code will run, then you should use | |
| the corresponding @option{-mtune} or @option{-march} option instead of | |
| @option{-mtune=generic}. But, if you do not know exactly what CPU users | |
| of your application will have, then you should use this option. | |
| As new processors are deployed in the marketplace, the behavior of this | |
| option will change. Therefore, if you upgrade to a newer version of | |
| GCC, code generation controlled by this option will change to reflect | |
| the processors | |
| that are most common at the time that version of GCC is released. | |
| There is no @option{-march=generic} option because @option{-march} | |
| indicates the instruction set the compiler can use, and there is no | |
| generic instruction set applicable to all processors. In contrast, | |
| @option{-mtune} indicates the processor (or, in this case, collection of | |
| processors) for which the code is optimized. | |
| @item intel | |
| Produce code optimized for the most current Intel processors, which are | |
| Haswell and Silvermont for this version of GCC. If you know the CPU | |
| on which your code will run, then you should use the corresponding | |
| @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}. | |
| But, if you want your application performs better on both Diamond Rapids | |
| and Clearwater Forest, then you should use this option. | |
| As new Intel processors are deployed in the marketplace, the behavior of | |
| this option will change. Therefore, if you upgrade to a newer version of | |
| GCC, code generation controlled by this option will change to reflect | |
| the most current Intel processors at the time that version of GCC is | |
| released. | |
| There is no @option{-march=intel} option because @option{-march} indicates | |
| the instruction set the compiler can use, and there is no common | |
| instruction set applicable to all processors. In contrast, | |
| @option{-mtune} indicates the processor (or, in this case, collection of | |
| processors) for which the code is optimized. | |
| @end table | |
| @end table | |
| The following options allow more detailed control over which instruction | |
| set extensions are targeted by GCC. | |
| Each has a corresponding @option{-mno-} option to disable use of these | |
| instructions. | |
| These extensions are also available as built-in functions: see | |
| @ref{x86 Built-in Functions}, for details of the functions enabled and | |
| disabled by these switches. | |
| These options enable GCC to use these extended instructions in | |
| generated code. Applications that | |
| perform run-time CPU detection must compile separate files for each | |
| supported architecture, using the appropriate flags. In particular, | |
| the file containing the CPU detection code should be compiled without | |
| these options. | |
| To control whether 387 or SSE/AVX instructions are generated | |
| automatically for floating-point arithmetic, see @option{-mfpmath=}, below. | |
| @table @gcctabopt | |
| @opindex mmmx | |
| @opindex mno-mmx | |
| @item -mmmx | |
| Support MMX built-in functions. | |
| @opindex msse | |
| @opindex mno-sse | |
| @item -msse | |
| Support MMX and SSE built-in functions and code generation. | |
| @opindex msse2 | |
| @opindex mno-sse2 | |
| @item -msse2 | |
| Support MMX, SSE and SSE2 built-in functions and code generation. | |
| @opindex msse3 | |
| @opindex mno-sse3 | |
| @item -msse3 | |
| Support MMX, SSE, SSE2 and SSE3 built-in functions and code generation. | |
| @opindex mssse3 | |
| @opindex mno-ssse3 | |
| @item -mssse3 | |
| Support MMX, SSE, SSE2, SSE3 and SSSE3 built-in functions and code generation. | |
| @opindex msse4.1 | |
| @opindex mno-sse4.1 | |
| @item -msse4.1 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3 and SSE4.1 built-in functions and | |
| code generation. | |
| @opindex msse4.2 | |
| @opindex mno-sse4.2 | |
| @item -msse4.2 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1 and SSE4.2 built-in functions | |
| and code generation. | |
| @opindex msse4 | |
| @opindex mno-sse4 | |
| @item -msse4 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1 and SSE4.2 built-in functions | |
| and code generation. | |
| Note that @option{-msse4} enables both SSE4.1 and SSE4.2 support, | |
| while @option{-mno-sse4} turns off those features; neither form of the | |
| option affects SSE4A support, controlled separately by | |
| @option{-msse4a}. | |
| @opindex msse4a | |
| @opindex mno-sse4a | |
| @item -msse4a | |
| Support MMX, SSE, SSE2, SSE3 and SSE4A built-in functions and code generation. | |
| @opindex mavx | |
| @opindex mno-avx | |
| @item -mavx | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2 and AVX built-in | |
| functions and code generation. | |
| @opindex mavx2 | |
| @opindex mno-avx2 | |
| @item -mavx2 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and AVX2 | |
| built-in functions and code generation. | |
| @opindex mavx512f | |
| @opindex mno-avx512f | |
| @item -mavx512f | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2 and | |
| AVX512F built-in functions and code generation. | |
| @opindex mavx512cd | |
| @opindex mno-avx512cd | |
| @item -mavx512cd | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX512F and AVX512CD built-in functions and code generation. | |
| @opindex mavx512vl | |
| @opindex mno-avx512vl | |
| @item -mavx512vl | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX512F and AVX512VL built-in functions and code generation. | |
| @opindex mavx512bw | |
| @opindex mno-avx512bw | |
| @item -mavx512bw | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX512F and AVX512BW built-in functions and code generation. | |
| @opindex mavx512dq | |
| @opindex mno-avx512dq | |
| @item -mavx512dq | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX512F and AVX512DQ built-in functions and code generation. | |
| @opindex mavx512ifma | |
| @opindex mno-avx512ifma | |
| @item -mavx512ifma | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX512F and AVX512IFMA built-in functions and code generation. | |
| @opindex mavx512vbmi | |
| @opindex mno-avx512vbmi | |
| @item -mavx512vbmi | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX512F and AVX512VBMI built-in functions and code generation. | |
| @opindex mavx512vpopcntdq | |
| @opindex mno-avx512vpopcntdq | |
| @item -mavx512vpopcntdq | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX512F and AVX512VPOPCNTDQ built-in functions and code generation. | |
| @opindex mavx512vp2intersect | |
| @opindex mno-avx512vp2intersect | |
| @item -mavx512vp2intersect | |
| Support AVX512VP2INTERSECT built-in functions and code generation. | |
| @opindex mavx512vnni | |
| @opindex mno-avx512vnni | |
| @item -mavx512vnni | |
| Support AVX512VNNI built-in functions and code generation. | |
| @opindex mavx512vbmi2 | |
| @opindex mno-avx512vbmi2 | |
| @item -mavx512vbmi2 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F | |
| and AVX512VBMI2 built-in functions and code generation. | |
| @opindex mavx512bf16 | |
| @opindex mno-avx512bf16 | |
| @item -mavx512bf16 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and | |
| AVX512BF16 built-in functions and code generation. | |
| @opindex mavx512fp16 | |
| @opindex mno-avx512fp16 | |
| @item -mavx512fp16 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and | |
| AVX512-FP16 built-in functions and code generation. | |
| @opindex mavx512bitalg | |
| @opindex mno-avx512bitalg | |
| @item -mavx512bitalg | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, AVX512F and | |
| AVX512BITALG built-in functions and code generation. | |
| @opindex mavx512bmm | |
| @opindex mno-avx512bmm | |
| @item -mavx512bmm | |
| Support AVX512BMM built-in functions and code generation. | |
| @opindex mavxvnni | |
| @opindex mno-avxvnni | |
| @item -mavxvnni | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and | |
| AVXVNNI built-in functions and code generation. | |
| @opindex mavxifma | |
| @opindex mno-avxifma | |
| @item -mavxifma | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and | |
| AVXIFMA built-in functions and code generation. | |
| @opindex mavxvnniint8 | |
| @opindex mno-avxvnniint8 | |
| @item -mavxvnniint8 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2 and | |
| AVXVNNIINT8 built-in functions and code generation. | |
| @opindex mavxneconvert | |
| @opindex mno-avxneconvert | |
| @item -mavxneconvert | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and | |
| AVXNECONVERT build-in functions and code generation. | |
| @opindex mavxvnniint16 | |
| @opindex mno-avxvnniint16 | |
| @item -mavxvnniint16 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2 and | |
| AVXVNNIINT16 built-in functions and code generation. | |
| @opindex mavx10.1 | |
| @opindex mno-avx10.1 | |
| @item -mavx10.1 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| and AVX10.1 built-in functions and code generation. | |
| @opindex mavx10.2 | |
| @opindex mno-avx10.2 | |
| @item -mavx10.2 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX10.1 and AVX10.2 built-in functions and code generation. | |
| @opindex msha | |
| @opindex mno-sha | |
| @item -msha | |
| Support SHA1 and SHA256 built-in functions and code generation. | |
| @opindex maes | |
| @opindex mno-aes | |
| @item -maes | |
| Support AES built-in functions and code generation. | |
| @opindex mpclmul | |
| @opindex mno-pclmul | |
| @item -mpclmul | |
| Support PCLMUL built-in functions and code generation. | |
| @opindex mclflushopt | |
| @opindex mno-clflushopt | |
| @item -mclflushopt | |
| Support CLFLUSHOPT instructions. | |
| @opindex mclwb | |
| @opindex mno-clwb | |
| @item -mclwb | |
| Support CLWB instruction. | |
| @opindex mfsgsbase | |
| @opindex mno-fsgsbase | |
| @item -mfsgsbase | |
| Support FSGSBASE built-in functions and code generation. | |
| @opindex mptwrite | |
| @opindex mno-ptwrite | |
| @item -mptwrite | |
| Support PTWRITE built-in functions and code generation. | |
| @opindex mrdrnd | |
| @opindex mno-rdrnd | |
| @item -mrdrnd | |
| Support RDRND built-in functions and code generation. | |
| @opindex mf16c | |
| @opindex mno-f16c | |
| @item -mf16c | |
| Support F16C built-in functions and code generation. | |
| @opindex mfma | |
| @opindex mno-fma | |
| @item -mfma | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and FMA | |
| built-in functions and code generation. | |
| @opindex mfma4 | |
| @opindex mno-fma4 | |
| @item -mfma4 | |
| Support FMA4 built-in functions and code generation. | |
| @opindex mpconfig | |
| @opindex mno-pconfig | |
| @item -mpconfig | |
| Support PCONFIG built-in functions and code generation. | |
| @opindex mwbnoinvd | |
| @opindex mno-wbnoinvd | |
| @item -mwbnoinvd | |
| Support WBNOINVD built-in functions and code generation. | |
| @opindex mprfchw | |
| @opindex mno-prfchw | |
| @item -mprfchw | |
| Support PREFETCHW instruction. | |
| @opindex mrdpid | |
| @opindex mno-rdpid | |
| @item -mrdpid | |
| Support RDPID built-in functions and code generation. | |
| @opindex mrdseed | |
| @opindex mno-rdseed | |
| @item -mrdseed | |
| Support RDSEED instruction. | |
| @opindex msgx | |
| @opindex mno-sgx | |
| @item -msgx | |
| Support SGX built-in functions and code generation. | |
| @opindex mxop | |
| @opindex mno-xop | |
| @item -mxop | |
| Support XOP built-in functions and code generation. | |
| @opindex mlwp | |
| @opindex mno-lwp | |
| @item -mlwp | |
| Support LWP built-in functions and code generation. | |
| @opindex m3dnow | |
| @opindex mno-3dnow | |
| @item -m3dnow | |
| Support 3DNow! built-in functions. | |
| @opindex m3dnowa | |
| @opindex mno-3dnowa | |
| @item -m3dnowa | |
| Support Athlon 3Dnow! built-in functions. | |
| @opindex mpopcnt | |
| @opindex mno-popcnt | |
| @item -mpopcnt | |
| Support code generation of popcnt instruction. | |
| @opindex mabm | |
| @opindex mno-abm | |
| @item -mabm | |
| Support code generation of Advanced Bit Manipulation (ABM) instructions. | |
| @opindex madx | |
| @opindex mno-adx | |
| @item -madx | |
| Support flag-preserving add-carry instructions. | |
| @opindex mbmi | |
| @opindex mno-bmi | |
| @item -mbmi | |
| Support BMI built-in functions and code generation. | |
| @opindex mbmi2 | |
| @opindex mno-bmi2 | |
| @item -mbmi2 | |
| Support BMI2 built-in functions and code generation. | |
| @opindex mlzcnt | |
| @opindex mno-lzcnt | |
| @item -mlzcnt | |
| Support LZCNT built-in function and code generation. | |
| @opindex mfxsr | |
| @opindex mno-fxsr | |
| @item -mfxsr | |
| Support FXSAVE and FXRSTOR instructions. | |
| @opindex mxsave | |
| @opindex mno-xsave | |
| @item -mxsave | |
| Support XSAVE and XRSTOR instructions. | |
| @opindex mxsaveopt | |
| @opindex mno-xsaveopt | |
| @item -mxsaveopt | |
| Support XSAVEOPT instruction. | |
| @opindex mxsavec | |
| @opindex mno-xsavec | |
| @item -mxsavec | |
| Support XSAVEC instructions. | |
| @opindex mxsaves | |
| @opindex mno-xsaves | |
| @item -mxsaves | |
| Support XSAVES and XRSTORS instructions. | |
| @opindex mrtm | |
| @opindex mno-rtm | |
| @item -mrtm | |
| Support RTM built-in functions and code generation. | |
| @opindex mhle | |
| @opindex mno-hle | |
| @item -mhle | |
| Support Hardware Lock Elision prefixes. | |
| @opindex mtbm | |
| @opindex mno-tbm | |
| @item -mtbm | |
| Support TBM built-in functions and code generation. | |
| @opindex mmwaitx | |
| @opindex mno-mwaitx | |
| @item -mmwaitx | |
| Support MWAITX and MONITORX built-in functions and code generation. | |
| @opindex mclzero | |
| @opindex mno-clzero | |
| @item -mclzero | |
| Support CLZERO built-in functions and code generation. | |
| @opindex mpku | |
| @opindex mno-pku | |
| @item -mpku | |
| Support PKU built-in functions and code generation. | |
| @opindex mgfni | |
| @opindex mno-gfni | |
| @item -mgfni | |
| Support GFNI built-in functions and code generation. | |
| @opindex mvaes | |
| @opindex mno-vaes | |
| @item -mvaes | |
| Support VAES built-in functions and code generation. | |
| @opindex mwaitpkg | |
| @opindex mno-waitpkg | |
| @item -mwaitpkg | |
| Support WAITPKG built-in functions and code generation. | |
| @opindex mvpclmulqdq | |
| @opindex mno-vpclmulqdq | |
| @item -mvpclmulqdq | |
| Support VPCLMULQDQ built-in functions and code generation. | |
| @opindex mmovdiri | |
| @opindex mno-movdiri | |
| @item -mmovdiri | |
| Support MOVDIRI built-in functions and code generation. | |
| @opindex mmovdir64b | |
| @opindex mno-movdir64b | |
| @item -mmovdir64b | |
| Support MOVDIR64B built-in functions and code generation. | |
| @opindex menqcmd | |
| @opindex mno-enqcmd | |
| @item -menqcmd | |
| Support ENQCMD built-in functions and code generation. | |
| @opindex muintr | |
| @opindex mno-uintr | |
| @item -muintr | |
| Support UINTR built-in functions and code generation. | |
| @opindex mtsxldtrk | |
| @opindex mno-tsxldtrk | |
| @item -mtsxldtrk | |
| Support TSXLDTRK built-in functions and code generation. | |
| @opindex mcldemote | |
| @opindex mno-cldemote | |
| @item -mcldemote | |
| Support CLDEMOTE built-in functions and code generation. | |
| @opindex mserialize | |
| @opindex mno-serialize | |
| @item -mserialize | |
| Support SERIALIZE built-in functions and code generation. | |
| @opindex mamx-tile | |
| @opindex mno-amx-tile | |
| @item -mamx-tile | |
| Support AMX-TILE built-in functions and code generation. | |
| @opindex mamx-int8 | |
| @opindex mno-amx-int8 | |
| @item -mamx-int8 | |
| Support AMX-INT8 built-in functions and code generation. | |
| @opindex mamx-bf16 | |
| @opindex mno-amx-bf16 | |
| @item -mamx-bf16 | |
| Support AMX-BF16 built-in functions and code generation. | |
| @opindex mhreset | |
| @opindex mno-hreset | |
| @item -mhreset | |
| Support HRESET built-in functions and code generation. | |
| @opindex mkl | |
| @opindex mno-kl | |
| @item -mkl | |
| Support KL built-in functions and code generation. | |
| @opindex mwidekl | |
| @opindex mno-widekl | |
| @item -mwidekl | |
| Support WIDEKL built-in functions and code generation. | |
| @opindex mcmpccxadd | |
| @opindex mno-cmpccxadd | |
| @item -mcmpccxadd | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, and | |
| CMPCCXADD build-in functions and code generation. | |
| @opindex mamx-fp16 | |
| @opindex mno-amx-fp16 | |
| @item -mamx-fp16 | |
| Support AMX-FP16 built-in functions and code generation. | |
| @opindex mprefetchi | |
| @opindex mno-prefetchi | |
| @item -mprefetchi | |
| Support PREFETCHI built-in functions and code generation. | |
| @opindex mraoint | |
| @opindex mno-raoint | |
| @item -mraoint | |
| Support RAOINT built-in functions and code generation. | |
| @opindex mamx-complex | |
| @opindex mno-amx-complex | |
| @item -mamx-complex | |
| Support AMX-COMPLEX built-in functions and code generation. | |
| @opindex msm3 | |
| @opindex mno-sm3 | |
| @item -msm3 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and | |
| SM3 built-in functions and code generation. | |
| @opindex msm4 | |
| @opindex mno-sm4 | |
| @item -msm4 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and | |
| SM4 built-in functions and code generation. | |
| @opindex msha512 | |
| @opindex mno-sha512 | |
| @item -msha512 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX and | |
| SHA512 built-in functions and code generation. | |
| @opindex mapxf | |
| @opindex mno-apxf | |
| @item -mapxf | |
| Support code generation for APX features, including EGPR, PUSH2POP2, | |
| NDD, PPX, NF, CCMP and ZU. | |
| @opindex musermsr | |
| @opindex mno-usermsr | |
| @item -musermsr | |
| Support USER_MSR built-in functions and code generation. | |
| @opindex mamx-avx512 | |
| @opindex mno-amx-avx512 | |
| @item -mamx-avx512 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX512F and AMX-AVX512 built-in functions and code generation. | |
| @opindex mamx-fp8 | |
| @opindex mno-amx-fp8 | |
| @item -mamx-fp8 | |
| Support AMX-FP8 built-in functions and code generation. | |
| @opindex mmovrs | |
| @opindex mno-movrs | |
| @item -mmovrs | |
| Support MOVRS built-in functions and code generation. | |
| @opindex mamx-movrs | |
| @opindex mno-amx-movrs | |
| @item -mamx-movrs | |
| Support AMX-MOVRS built-in functions and code generation. | |
| @opindex mavx10v2aux | |
| @opindex mno-avx10v2aux | |
| @item -mavx10v2aux | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX10.1 and AVX10V2AUX built-in functions and code generation. | |
| @opindex macev1 | |
| @opindex mno-acev1 | |
| @item -macev1 | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX10.1 and ACEV1 built-in functions and code generation. | |
| @opindex mavx10v1aux | |
| @opindex mno-avx10v1aux | |
| @item -mavx10v1aux | |
| Support MMX, SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2, AVX, AVX2, | |
| AVX10.1 and AVX10V1AUX built-in functions and code generation. | |
| @end table | |
| These additional options are available for the x86 processor family. | |
| @table @gcctabopt | |
| @opindex mfpmath | |
| @item -mfpmath=@var{unit} | |
| Generate floating-point arithmetic for selected unit @var{unit}. The choices | |
| for @var{unit} are: | |
| @table @samp | |
| @item 387 | |
| Use the standard 387 floating-point coprocessor present on the majority | |
| of chips and emulated otherwise. | |
| Code compiled with this option runs almost everywhere. | |
| The temporary results are computed in 80-bit precision instead of the precision | |
| specified by the type, resulting in slightly different results compared to most | |
| of other chips. See @option{-ffloat-store} for more detailed description. | |
| This is the default choice for non-Darwin x86-32 targets. | |
| @item sse | |
| Use scalar floating-point instructions present in the SSE instruction set. | |
| This instruction set is supported by Pentium III and newer chips, | |
| and in the AMD line by Athlon-4, Athlon XP and Athlon MP chips. | |
| The earlier version of the SSE | |
| instruction set supports only single-precision arithmetic, thus the double and | |
| extended-precision arithmetic are still done using 387. | |
| A later version, present only in Pentium 4 and AMD x86-64 chips, | |
| supports double-precision arithmetic too. | |
| For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, | |
| @option{-msse} | |
| or @option{-msse2} switches to enable SSE extensions and make this option | |
| effective. For the x86-64 compiler, these extensions are enabled by default. | |
| The resulting code should be considerably faster in the majority of cases | |
| and avoid | |
| the numerical instability problems of 387 code, but may break some existing | |
| code that expects temporaries to be 80 bits. | |
| This is the default choice for the x86-64 compiler, Darwin x86-32 targets, | |
| and the default choice for x86-32 targets with the SSE2 instruction set | |
| when @option{-ffast-math} is enabled. | |
| GCC depresses SSE instructions when @option{-mavx} (or another option | |
| enabling AVX extensions) is used. Instead, it | |
| generates new AVX instructions or AVX equivalents for all SSE instructions | |
| when needed. | |
| @item sse,387 | |
| @itemx sse+387 | |
| @itemx both | |
| Attempt to utilize both instruction sets at once. This effectively doubles the | |
| amount of available registers, and on chips with separate execution units for | |
| 387 and SSE the execution resources too. Use this option with care, as it is | |
| still experimental, because the GCC register allocator does not model separate | |
| functional units well, resulting in unstable performance. | |
| @end table | |
| @opindex mieee-fp | |
| @opindex mno-ieee-fp | |
| @item -mieee-fp | |
| @itemx -mno-ieee-fp | |
| Control whether or not the compiler uses IEEE floating-point | |
| comparisons. These correctly handle the case where the result of a | |
| comparison is unordered. | |
| @opindex m80387 | |
| @opindex mhard-float | |
| @item -m80387 | |
| @itemx -mhard-float | |
| Generate output containing 80387 instructions for floating point. | |
| @opindex mno-80387 | |
| @opindex msoft-float | |
| @item -mno-80387 | |
| @itemx -msoft-float | |
| Generate output containing library calls for floating point. | |
| @strong{Warning:} the requisite libraries are not part of GCC@. | |
| Normally the facilities of the machine's usual C compiler are used, but | |
| this cannot be done directly in cross-compilation. You must make your | |
| own arrangements to provide suitable library functions for | |
| cross-compilation. | |
| On machines where a function returns floating-point results in the 80387 | |
| register stack, some floating-point opcodes may be emitted even if | |
| @option{-msoft-float} is used. | |
| @opindex mno-fp-ret-in-387 | |
| @opindex mfp-ret-in-387 | |
| @item -mno-fp-ret-in-387 | |
| Do not use the FPU registers for return values of functions. | |
| The usual calling convention has functions return values of types | |
| @code{float} and @code{double} in an FPU register, even if there | |
| is no FPU@. The idea is that the operating system should emulate | |
| an FPU@. | |
| The option @option{-mno-fp-ret-in-387} causes such values to be returned | |
| in ordinary CPU registers instead. | |
| @opindex mno-fancy-math-387 | |
| @opindex mfancy-math-387 | |
| @item -mno-fancy-math-387 | |
| Some 387 emulators do not support the @code{sin}, @code{cos} and | |
| @code{sqrt} instructions for the 387. Specify this option to avoid | |
| generating those instructions. | |
| This option is overridden when @option{-march} | |
| indicates that the target CPU always has an FPU and so the | |
| instruction does not need emulation. These | |
| instructions are not generated unless you also use the | |
| @option{-funsafe-math-optimizations} switch. | |
| @opindex malign-double | |
| @opindex mno-align-double | |
| @item -malign-double | |
| @itemx -mno-align-double | |
| Control whether GCC aligns @code{double}, @code{long double}, and | |
| @code{long long} variables on a two-word boundary or a one-word | |
| boundary. Aligning @code{double} variables on a two-word boundary | |
| produces code that runs somewhat faster on a Pentium at the | |
| expense of more memory. | |
| On x86-64, @option{-malign-double} is enabled by default. | |
| @strong{Warning:} if you use the @option{-malign-double} switch, | |
| structures containing the above types are aligned differently than | |
| the published application binary interface specifications for the x86-32 | |
| and are not binary compatible with structures in code compiled | |
| without that switch. | |
| @opindex m96bit-long-double | |
| @opindex m128bit-long-double | |
| @item -m96bit-long-double | |
| @itemx -m128bit-long-double | |
| These switches control the size of @code{long double} type. The x86-32 | |
| application binary interface specifies the size to be 96 bits, | |
| so @option{-m96bit-long-double} is the default in 32-bit mode. | |
| Modern architectures (Pentium and newer) prefer @code{long double} | |
| to be aligned to an 8- or 16-byte boundary. In arrays or structures | |
| conforming to the ABI, this is not possible. So specifying | |
| @option{-m128bit-long-double} aligns @code{long double} | |
| to a 16-byte boundary by padding the @code{long double} with an additional | |
| 32-bit zero. | |
| In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as | |
| its ABI specifies that @code{long double} is aligned on 16-byte boundary. | |
| Notice that neither of these options enable any extra precision over the x87 | |
| standard of 80 bits for a @code{long double}. | |
| @strong{Warning:} if you override the default value for your target ABI, this | |
| changes the size of | |
| structures and arrays containing @code{long double} variables, | |
| as well as modifying the function calling convention for functions taking | |
| @code{long double}. Hence they are not binary-compatible | |
| with code compiled without that switch. | |
| @opindex mlong-double-64 | |
| @opindex mlong-double-80 | |
| @opindex mlong-double-128 | |
| @item -mlong-double-64 | |
| @itemx -mlong-double-80 | |
| @itemx -mlong-double-128 | |
| These switches control the size of @code{long double} type. A size | |
| of 64 bits makes the @code{long double} type equivalent to the @code{double} | |
| type. This is the default for 32-bit Bionic C library. A size | |
| of 128 bits makes the @code{long double} type equivalent to the | |
| @code{__float128} type. This is the default for 64-bit Bionic C library. | |
| @strong{Warning:} if you override the default value for your target ABI, this | |
| changes the size of | |
| structures and arrays containing @code{long double} variables, | |
| as well as modifying the function calling convention for functions taking | |
| @code{long double}. Hence they are not binary-compatible | |
| with code compiled without that switch. | |
| @opindex malign-data | |
| @item -malign-data=@var{type} | |
| Control how GCC aligns variables. Supported values for @var{type} are | |
| @samp{compat} uses increased alignment value compatible uses GCC 4.8 | |
| and earlier, @samp{abi} uses alignment value as specified by the | |
| psABI, and @samp{cacheline} uses increased alignment value to match | |
| the cache line size. @samp{compat} is the default. | |
| @opindex mlarge-data-threshold | |
| @item -mlarge-data-threshold=@var{threshold} | |
| When @option{-mcmodel=medium} or @option{-mcmodel=large} is specified, data | |
| objects larger than @var{threshold} are placed in large data sections. The | |
| default is 65535. | |
| @opindex mrtd | |
| @opindex mno-rtd | |
| @item -mrtd | |
| Use a different function-calling convention, in which functions that | |
| take a fixed number of arguments return with the @code{ret @var{num}} | |
| instruction, which pops their arguments while returning. This saves one | |
| instruction in the caller since there is no need to pop the arguments | |
| there. | |
| You can specify that an individual function is called with this calling | |
| sequence with the function attribute @code{stdcall}. You can also | |
| override the @option{-mrtd} option by using the function attribute | |
| @code{cdecl}. @xref{x86 Attributes}. | |
| @strong{Warning:} this calling convention is incompatible with the one | |
| normally used on Unix, so you cannot use it if you need to call | |
| libraries compiled with the Unix compiler. | |
| Also, you must provide function prototypes for all functions that | |
| take variable numbers of arguments (including @code{printf}); | |
| otherwise incorrect code is generated for calls to those | |
| functions. | |
| In addition, seriously incorrect code results if you call a | |
| function with too many arguments. (Normally, extra arguments are | |
| harmlessly ignored.) | |
| @opindex mregparm | |
| @item -mregparm=@var{num} | |
| Control how many registers are used to pass integer arguments. By | |
| default, no registers are used to pass arguments, and at most 3 | |
| registers can be used. You can control this behavior for a specific | |
| function by using the function attribute @code{regparm}. | |
| @xref{x86 Attributes}. | |
| @strong{Warning:} if you use this switch, and | |
| @var{num} is nonzero, then you must build all modules with the same | |
| value, including any libraries. This includes the system libraries and | |
| startup modules. | |
| @opindex msseregparm | |
| @item -msseregparm | |
| Use SSE register passing conventions for float and double arguments | |
| and return values. You can control this behavior for a specific | |
| function by using the function attribute @code{sseregparm}. | |
| @xref{x86 Attributes}. | |
| @strong{Warning:} if you use this switch then you must build all | |
| modules with the same value, including any libraries. This includes | |
| the system libraries and startup modules. | |
| @opindex mvect8-ret-in-mem | |
| @opindex mno-vect8-ret-in-mem | |
| @item -mvect8-ret-in-mem | |
| Return 8-byte vectors in memory instead of MMX registers. This is the | |
| default on VxWorks to match the ABI of the Sun Studio compilers until | |
| version 12. @emph{Only} use this option if you need to remain | |
| compatible with existing code produced by those previous compiler | |
| versions or older versions of GCC@. | |
| @opindex mpc32 | |
| @opindex mpc64 | |
| @opindex mpc80 | |
| @item -mpc32 | |
| @itemx -mpc64 | |
| @itemx -mpc80 | |
| Set 80387 floating-point precision to 32, 64 or 80 bits. When @option{-mpc32} | |
| is specified, the significands of results of floating-point operations are | |
| rounded to 24 bits (single precision); @option{-mpc64} rounds the | |
| significands of results of floating-point operations to 53 bits (double | |
| precision) and @option{-mpc80} rounds the significands of results of | |
| floating-point operations to 64 bits (extended double precision), which is | |
| the default. When this option is used, floating-point operations in higher | |
| precisions are not available to the programmer without setting the FPU | |
| control word explicitly. | |
| Setting the rounding of floating-point operations to less than the default | |
| 80 bits can speed some programs by 2% or more. Note that some mathematical | |
| libraries assume that extended-precision (80-bit) floating-point operations | |
| are enabled by default; routines in such libraries could suffer significant | |
| loss of accuracy, typically through so-called ``catastrophic cancellation'', | |
| when this option is used to set the precision to less than extended precision. | |
| On MinGW targets, the precision is set when the program starts and is | |
| restored by @code{fesetenv (FE_DFL_ENV)}. Threads created with | |
| @code{pthread_create} inherit it from the creating thread, but threads | |
| created with @code{CreateThread} or @code{_beginthreadex} start with the | |
| Windows default of 53-bit precision. Loading a DLL built with these | |
| options does not change the precision. | |
| @opindex mdaz-ftz | |
| @opindex mno-daz-ftz | |
| @item -mdaz-ftz | |
| @itemx -mno-daz-ftz | |
| The flush-to-zero (FTZ) and denormals-are-zero (DAZ) flags in the | |
| MXCSR register are used to control floating-point calculations. The | |
| @option{-Ofast}, @option{-ffast-math}, or | |
| @option{-funsafe-math-optimizations} options normally link in startup code | |
| that sets these flags except when building a shared library | |
| (@option{-shared}). You can use the @option{-mdaz-ftz} and | |
| @option{-mno-daz-ftz} options to explicitly enable or disable setting | |
| these flags, regardless of other options passed to GCC. | |
| @opindex mstackrealign | |
| @opindex mno-stackrealign | |
| @item -mstackrealign | |
| Realign the stack at entry. On the x86, the @option{-mstackrealign} | |
| option generates an alternate prologue and epilogue that realigns the | |
| run-time stack if necessary. This supports mixing legacy codes that keep | |
| 4-byte stack alignment with modern codes that keep 16-byte stack alignment for | |
| SSE compatibility. See also the attribute @code{force_align_arg_pointer}, | |
| applicable to individual functions. | |
| @opindex mstack-arg-probe | |
| @opindex mno-stack-arg-probe | |
| @item -mstack-arg-probe | |
| Emit stack probing code in the function prologue. | |
| @opindex mpreferred-stack-boundary | |
| @item -mpreferred-stack-boundary=@var{num} | |
| Attempt to keep the stack boundary aligned to a 2 raised to @var{num} | |
| byte boundary. If @option{-mpreferred-stack-boundary} is not specified, | |
| the default is 4 (16 bytes or 128 bits). | |
| @strong{Warning:} When generating code for the x86-64 architecture with | |
| SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be | |
| used to keep the stack boundary aligned to 8 byte boundary. Since | |
| x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and | |
| intended to be used in controlled environment where stack space is | |
| important limitation. This option leads to wrong code when functions | |
| compiled with 16 byte stack alignment (such as functions from a standard | |
| library) are called with misaligned stack. In this case, SSE | |
| instructions may lead to misaligned memory access traps. In addition, | |
| variable arguments are handled incorrectly for 16 byte aligned | |
| objects (including x87 long double and __int128), leading to wrong | |
| results. You must build all modules with | |
| @option{-mpreferred-stack-boundary=3}, including any libraries. This | |
| includes the system libraries and startup modules. | |
| @opindex mincoming-stack-boundary | |
| @item -mincoming-stack-boundary=@var{num} | |
| Assume the incoming stack is aligned to a 2 raised to @var{num} byte | |
| boundary. If @option{-mincoming-stack-boundary} is not specified, | |
| the one specified by @option{-mpreferred-stack-boundary} is used. | |
| On Pentium and Pentium Pro, @code{double} and @code{long double} values | |
| should be aligned to an 8-byte boundary (see @option{-malign-double}) or | |
| suffer significant run time performance penalties. On Pentium III, the | |
| Streaming SIMD Extension (SSE) data type @code{__m128} may not work | |
| properly if it is not 16-byte aligned. | |
| To ensure proper alignment of this values on the stack, the stack boundary | |
| must be as aligned as that required by any value stored on the stack. | |
| Further, every function must be generated such that it keeps the stack | |
| aligned. Thus calling a function compiled with a higher preferred | |
| stack boundary from a function compiled with a lower preferred stack | |
| boundary most likely misaligns the stack. It is recommended that | |
| libraries that use callbacks always use the default setting. | |
| This extra alignment does consume extra stack space, and generally | |
| increases code size. Code that is sensitive to stack space usage, such | |
| as embedded systems and operating system kernels, may want to reduce the | |
| preferred alignment to @option{-mpreferred-stack-boundary=2}. | |
| @opindex mdump-tune-features | |
| @item -mdump-tune-features | |
| This option instructs GCC to dump the names of the x86 performance | |
| tuning features and default settings. The names can be used in | |
| @option{-mtune-ctrl=@var{feature-list}}. | |
| @opindex mtune-ctrl=@var{feature-list} | |
| @item -mtune-ctrl=@var{feature-list} | |
| This option is used to do fine-grain control of x86 code generation features. | |
| @var{feature-list} is a comma-separated list of @var{feature} names. See also | |
| @option{-mdump-tune-features}. When specified, the @var{feature} is turned | |
| on if it is not preceded with @samp{^}; otherwise, it is turned off. | |
| @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC | |
| developers. Using it may lead to code paths not covered by testing and can | |
| potentially result in compiler ICEs or runtime errors. | |
| @opindex mno-default | |
| @item -mno-default | |
| This option instructs GCC to turn off all tunable features. See also | |
| @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}. | |
| @opindex mcld | |
| @opindex mno-cld | |
| @item -mcld | |
| This option instructs GCC to emit a @code{cld} instruction in the prologue | |
| of functions that use string instructions. String instructions depend on | |
| the DF flag to select between autoincrement or autodecrement mode. While the | |
| ABI specifies the DF flag to be cleared on function entry, some operating | |
| systems violate this specification by not clearing the DF flag in their | |
| exception dispatchers. The exception handler can be invoked with the DF flag | |
| set, which leads to wrong direction mode when string instructions are used. | |
| This option can be enabled by default on 32-bit x86 targets by configuring | |
| GCC with the @option{--enable-cld} configure option. Generation of @code{cld} | |
| instructions can be suppressed with the @option{-mno-cld} compiler option | |
| in this case. | |
| @opindex mvzeroupper | |
| @opindex mno-vzeroupper | |
| @item -mvzeroupper | |
| This option instructs GCC to emit a @code{vzeroupper} instruction | |
| before a transfer of control flow out of the function to minimize | |
| the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper} | |
| intrinsics. | |
| @opindex mstv | |
| @opindex mno-stv | |
| @item -mstv | |
| @itemx -mno-stv | |
| Enable/disable Scalar to Vectorization pass transforming 64-bit | |
| integer computation into vector ones. This optimization is restricted | |
| to @option{-O2} and higher. | |
| @opindex mprefer-avx128 | |
| @opindex mno-prefer-avx128 | |
| @item -mprefer-avx128 | |
| This option instructs GCC to use 128-bit AVX instructions instead of | |
| 256-bit AVX instructions in the auto-vectorizer. | |
| @opindex mprefer-vector-width | |
| @item -mprefer-vector-width=@var{opt} | |
| This option instructs GCC to use @var{opt}-bit vector width in instructions | |
| instead of default on the selected platform. | |
| @opindex mpartial-vector-fp-math | |
| @opindex mno-partial-vector-fp-math | |
| @item -mpartial-vector-fp-math | |
| @itemx -mno-partial-vector-fp-math | |
| This option enables GCC to generate floating-point operations that might | |
| affect the set of floating-point status flags on partial vectors, where | |
| vector elements reside in the low part of the 128-bit SSE register. Unless | |
| @option{-fno-trapping-math} is specified, the compiler guarantees correct | |
| behavior by sanitizing all input operands to have zeroes in the unused | |
| upper part of the vector register. Note that by using built-in functions | |
| or inline assembly with partial vector arguments, NaNs, denormal or invalid | |
| values can leak into the upper part of the vector, causing possible | |
| performance issues when @option{-fno-trapping-math} is in effect. These | |
| issues can be mitigated by manually sanitizing the upper part of the partial | |
| vector argument register or by using @option{-mdaz-ftz} to set | |
| denormals-are-zero (DAZ) flag in the MXCSR register. | |
| This option is enabled by default. | |
| @opindex mmove-max | |
| @item -mmove-max=@var{bits} | |
| This option instructs GCC to set the maximum number of bits can be | |
| moved from memory to memory efficiently to @var{bits}. The valid | |
| @var{bits} are 128, 256 and 512. | |
| @opindex mstore-max | |
| @item -mstore-max=@var{bits} | |
| This option instructs GCC to set the maximum number of bits can be | |
| stored to memory efficiently to @var{bits}. The valid @var{bits} are | |
| 128, 256 and 512. | |
| @table @samp | |
| @item none | |
| No extra limitations applied to GCC other than defined by the selected platform. | |
| @item 128 | |
| Prefer 128-bit vector width for instructions. | |
| @item 256 | |
| Prefer 256-bit vector width for instructions. | |
| @item 512 | |
| Prefer 512-bit vector width for instructions. | |
| @end table | |
| @opindex mnoreturn-no-callee-saved-registers | |
| @opindex mno-noreturn-no-callee-saved-registers | |
| @item -mnoreturn-no-callee-saved-registers | |
| This option optimizes functions with @code{noreturn} attribute or | |
| @code{_Noreturn} specifier by not saving in the function prologue callee-saved | |
| registers which are used in the function (except for the @code{BP} | |
| register). This option can interfere with debugging of the caller of the | |
| @code{noreturn} function or any function further up in the call stack, so it | |
| is not enabled by default. | |
| @opindex mcx16 | |
| @opindex mno-cx16 | |
| @item -mcx16 | |
| This option enables GCC to generate @code{CMPXCHG16B} instructions in 64-bit | |
| code to implement compare-and-exchange operations on 16-byte aligned 128-bit | |
| objects. This is useful for atomic updates of data structures exceeding one | |
| machine word in size. The compiler uses this instruction to implement | |
| @ref{__sync Builtins}. | |
| @opindex msahf | |
| @opindex mno-sahf | |
| @item -msahf | |
| This option enables generation of @code{SAHF} instructions in 64-bit code. | |
| Early Intel Pentium 4 CPUs with Intel 64 support, | |
| prior to the introduction of Pentium 4 G1 step in December 2005, | |
| lacked the @code{LAHF} and @code{SAHF} instructions | |
| which are supported by AMD64. | |
| These are load and store instructions, respectively, for certain status flags. | |
| In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod}, | |
| @code{drem}, and @code{remainder} built-in functions; | |
| see @ref{Other Builtins} for details. | |
| @opindex mmovbe | |
| @opindex mno-movbe | |
| @item -mmovbe | |
| This option enables use of the @code{movbe} instruction to optimize | |
| byte swapping of four and eight byte entities. | |
| @opindex mshstk | |
| @opindex mno-shstk | |
| @item -mshstk | |
| The @option{-mshstk} option enables shadow stack built-in functions | |
| from x86 Control-flow Enforcement Technology (CET). | |
| @opindex mcrc32 | |
| @opindex mno-crc32 | |
| @item -mcrc32 | |
| This option enables built-in functions @code{__builtin_ia32_crc32qi}, | |
| @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and | |
| @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction. | |
| @opindex mmwait | |
| @opindex mno-mwait | |
| @item -mmwait | |
| This option enables built-in functions @code{__builtin_ia32_monitor}, | |
| and @code{__builtin_ia32_mwait} to generate the @code{monitor} and | |
| @code{mwait} machine instructions. | |
| @opindex mrecip | |
| @opindex mno-recip | |
| @item -mrecip | |
| This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions | |
| (and their vectorized variants @code{RCPPS} and @code{RSQRTPS}) | |
| with an additional Newton-Raphson step | |
| to increase precision instead of @code{DIVSS} and @code{SQRTSS} | |
| (and their vectorized | |
| variants) for single-precision floating-point arguments. These instructions | |
| are generated only when @option{-funsafe-math-optimizations} is enabled | |
| together with @option{-ffinite-math-only} and @option{-fno-trapping-math}. | |
| Note that while the throughput of the sequence is higher than the throughput | |
| of the non-reciprocal instruction, the precision of the sequence can be | |
| decreased by up to 2 ulp (i.e.@: the inverse of 1.0 equals 0.99999994). | |
| Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS} | |
| (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option | |
| combination), and doesn't need @option{-mrecip}. | |
| Also note that GCC emits the above sequence with additional Newton-Raphson step | |
| for vectorized single-float division and vectorized @code{sqrtf(@var{x})} | |
| already with @option{-ffast-math} (or the above option combination), and | |
| doesn't need @option{-mrecip}. | |
| @opindex mrecip= | |
| @item -mrecip=@var{opt} | |
| This option controls which reciprocal estimate instructions | |
| may be used. @var{opt} is a comma-separated list of options, which may | |
| be preceded by a @samp{!} to invert the option: | |
| @table @samp | |
| @item all | |
| Enable all estimate instructions. | |
| @item default | |
| Enable the default instructions, equivalent to @option{-mrecip}. | |
| @item none | |
| Disable all estimate instructions, equivalent to @option{-mno-recip}. | |
| @item div | |
| Enable the approximation for scalar division. | |
| @item vec-div | |
| Enable the approximation for vectorized division. | |
| @item sqrt | |
| Enable the approximation for scalar square root. | |
| @item vec-sqrt | |
| Enable the approximation for vectorized square root. | |
| @end table | |
| So, for example, @option{-mrecip=all,!sqrt} enables | |
| all of the reciprocal approximations, except for square root. | |
| @opindex mveclibabi | |
| @item -mveclibabi=@var{type} | |
| Specifies the ABI type to use for vectorizing intrinsics using an external | |
| library. Supported values for @var{type} are @samp{svml} for the Intel short | |
| vector math library, @samp{aocl} for the math library (LibM) from AMD | |
| Optimizing CPU Libraries (AOCL), @samp{acml} for the end-of-life AMD core | |
| math library (to which AOCL-LibM is the successor), and @samp{hvml} for the | |
| HYGON vector math library (HVML). | |
| To use this option, both @option{-ftree-vectorize} and | |
| @option{-funsafe-math-optimizations} have to be enabled, and an SVML, ACML, | |
| AOCL, or HVML ABI-compatible library must be specified at link time. | |
| ACML, AOCL, and HVML are supported only on 64-bit targets. | |
| GCC currently emits calls to @code{vmldExp2}, @code{vmldLn2}, | |
| @code{vmldLog102}, @code{vmldPow2}, @code{vmldTanh2}, @code{vmldTan2}, | |
| @code{vmldAtan2}, @code{vmldAtanh2}, @code{vmldCbrt2}, @code{vmldSinh2}, | |
| @code{vmldSin2}, @code{vmldAsinh2}, @code{vmldAsin2}, @code{vmldCosh2}, | |
| @code{vmldCos2}, @code{vmldAcosh2}, @code{vmldAcos2}, @code{vmlsExp4}, | |
| @code{vmlsLn4}, @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, | |
| @code{vmlsTan4}, @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, | |
| @code{vmlsSinh4}, @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, | |
| @code{vmlsCosh4}, @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for | |
| corresponding function type when @option{-mveclibabi=svml} is used, | |
| @code{amd_vrd2_acos}, @code{amd_vrd2_asin}, @code{amd_vrd2_atan}, | |
| @code{amd_vrd2_atan2}, @code{amd_vrd2_cbrt}, @code{amd_vrd2_cos}, | |
| @code{amd_vrd2_cosh}, @code{amd_vrd2_erf}, @code{amd_vrd2_erfc}, | |
| @code{amd_vrd2_exp}, @code{amd_vrd2_exp10}, @code{amd_vrd2_exp2}, | |
| @code{amd_vrd2_log}, @code{amd_vrd2_log10}, @code{amd_vrd2_log1p}, | |
| @code{amd_vrd2_log2}, @code{amd_vrd2_pow}, @code{amd_vrd2_sin}, | |
| @code{amd_vrd2_tan}, @code{amd_vrd2_tanh}, @code{amd_vrd4_acos}, | |
| @code{amd_vrd4_asin}, @code{amd_vrd4_atan}, @code{amd_vrd4_atan2}, | |
| @code{amd_vrd4_cos}, @code{amd_vrd4_cosh}, @code{amd_vrd4_erf}, | |
| @code{amd_vrd4_erfc}, @code{amd_vrd4_exp}, @code{amd_vrd4_exp10}, | |
| @code{amd_vrd4_exp2}, @code{amd_vrd4_log}, @code{amd_vrd4_log2}, | |
| @code{amd_vrd4_pow}, @code{amd_vrd4_sin}, @code{amd_vrd4_tan}, | |
| @code{amd_vrd4_tanh}, @code{amd_vrd8_acos}, @code{amd_vrd8_asin}, | |
| @code{amd_vrd8_atan}, @code{amd_vrd8_atan2}, @code{amd_vrd8_cos}, | |
| @code{amd_vrd8_cosh}, @code{amd_vrd8_erf}, @code{amd_vrd8_erfc}, | |
| @code{amd_vrd8_exp}, @code{amd_vrd8_exp10}, @code{amd_vrd8_exp2}, | |
| @code{amd_vrd8_log}, @code{amd_vrd8_log2}, @code{amd_vrd8_pow}, | |
| @code{amd_vrd8_sin}, @code{amd_vrd8_tan}, @code{amd_vrd8_tanh}, | |
| @code{amd_vrs16_acosf}, @code{amd_vrs16_asinf}, @code{amd_vrs16_atanf}, | |
| @code{amd_vrs16_cosf}, @code{amd_vrs16_coshf}, @code{amd_vrs16_erfcf}, | |
| @code{amd_vrs16_erff}, @code{amd_vrs16_exp10f}, @code{amd_vrs16_exp2f}, | |
| @code{amd_vrs16_expf}, @code{amd_vrs16_log10f}, @code{amd_vrs16_log2f}, | |
| @code{amd_vrs16_logf}, @code{amd_vrs16_powf}, @code{amd_vrs16_sinf}, | |
| @code{amd_vrs16_tanf}, @code{amd_vrs16_tanhf}, @code{amd_vrs4_acosf}, | |
| @code{amd_vrs4_asinf}, @code{amd_vrs4_atanf}, @code{amd_vrs4_cbrtf}, | |
| @code{amd_vrs4_cosf}, @code{amd_vrs4_coshf}, @code{amd_vrs4_erfcf}, | |
| @code{amd_vrs4_erff}, @code{amd_vrs4_exp10f}, @code{amd_vrs4_exp2f}, | |
| @code{amd_vrs4_expf}, @code{amd_vrs4_expm1f}, @code{amd_vrs4_log10f}, | |
| @code{amd_vrs4_log1pf}, @code{amd_vrs4_log2f}, @code{amd_vrs4_logf}, | |
| @code{amd_vrs4_powf}, @code{amd_vrs4_sinf}, @code{amd_vrs4_tanf}, | |
| @code{amd_vrs4_tanhf}, @code{amd_vrs8_acosf}, @code{amd_vrs8_asinf}, | |
| @code{amd_vrs8_atanf}, @code{amd_vrs8_cbrtf}, @code{amd_vrs8_cosf}, | |
| @code{amd_vrs8_coshf}, @code{amd_vrs8_erfcf}, @code{amd_vrs8_erff}, | |
| @code{amd_vrs8_exp10f}, @code{amd_vrs8_exp2f}, @code{amd_vrs8_expf}, | |
| @code{amd_vrs8_log10f}, @code{amd_vrs8_log2f}, @code{amd_vrs8_logf}, | |
| @code{amd_vrs8_powf}, @code{amd_vrs8_sinf}, @code{amd_vrs8_tanf}, | |
| and @code{amd_vrs8_tanhf} for the corresponding function | |
| type when @option{-mveclibabi=aocl} is used, and @code{__vrd2_sin}, | |
| @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2}, | |
| @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf}, | |
| @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f}, | |
| @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type | |
| when @option{-mveclibabi=acml} is used, and @code{hvml_vs4_acos}, | |
| @code{hvml_vs8_acos}, @code{hvml_vd2_acos}, @code{hvml_vd4_acos}, | |
| @code{hvml_vd8_acos}, @code{hvml_vs4_acosh}, @code{hvml_vs8_acosh}, | |
| @code{hvml_vd2_acosh}, @code{hvml_vd4_acosh}, @code{hvml_vs4_acospi}, | |
| @code{hvml_vs8_acospi}, @code{hvml_vd2_acospi}, @code{hvml_vd4_acospi}, | |
| @code{hvml_vs4_asin}, @code{hvml_vs8_asin}, @code{hvml_vs16_asin}, | |
| @code{hvml_vd2_asin}, @code{hvml_vd4_asin}, @code{hvml_vd8_asin}, | |
| @code{hvml_vs4_asinh}, @code{hvml_vs8_asinh}, @code{hvml_vd2_asinh}, | |
| @code{hvml_vd4_asinh}, @code{hvml_vs4_asinpi}, @code{hvml_vs8_asinpi}, | |
| @code{hvml_vd2_asinpi}, @code{hvml_vd4_asinpi}, @code{hvml_vs4_atan}, | |
| @code{hvml_vs8_atan}, @code{hvml_vs16_atan}, @code{hvml_vd2_atan}, | |
| @code{hvml_vd4_atan}, @code{hvml_vd8_atan}, @code{hvml_vs4_atan2}, | |
| @code{hvml_vs8_atan2}, @code{hvml_vs16_atan2}, @code{hvml_vd2_atan2}, | |
| @code{hvml_vd4_atan2}, @code{hvml_vd8_atan2}, @code{hvml_vs4_atan2pi}, | |
| @code{hvml_vs8_atan2pi}, @code{hvml_vd2_atan2pi}, @code{hvml_vd4_atan2pi}, | |
| @code{hvml_vs4_atanh}, @code{hvml_vs8_atanh}, @code{hvml_vs16_atanh}, | |
| @code{hvml_vd2_atanh}, @code{hvml_vd4_atanh}, @code{hvml_vd8_atanh}, | |
| @code{hvml_vs4_atanpi}, @code{hvml_vs8_atanpi}, @code{hvml_vd2_atanpi}, | |
| @code{hvml_vd4_atanpi}, @code{hvml_vs4_cbrt}, @code{hvml_vs8_cbrt}, | |
| @code{hvml_vs16_cbrt}, @code{hvml_vd2_cbrt}, @code{hvml_vd4_cbrt}, | |
| @code{hvml_vd8_cbrt}, @code{hvml_vs4_cos}, @code{hvml_vs8_cos}, | |
| @code{hvml_vs16_cos}, @code{hvml_vd2_cos}, @code{hvml_vd4_cos}, | |
| @code{hvml_vd8_cos}, @code{hvml_vs4_cosh}, @code{hvml_vs8_cosh}, | |
| @code{hvml_vs16_cosh}, @code{hvml_vd2_cosh}, @code{hvml_vd4_cosh}, | |
| @code{hvml_vd8_cosh}, @code{hvml_vs4_cospi}, @code{hvml_vs8_cospi}, | |
| @code{hvml_vd2_cospi}, @code{hvml_vd4_cospi}, @code{hvml_vs4_erf}, | |
| @code{hvml_vs16_erf}, @code{hvml_vd2_erf}, @code{hvml_vd4_erf}, | |
| @code{hvml_vs4_erfc}, @code{hvml_vs8_erfc}, @code{hvml_vd2_erfc}, | |
| @code{hvml_vd4_erfc}, @code{hvml_vs4_exp}, @code{hvml_vs8_exp}, | |
| @code{hvml_vs16_exp}, @code{hvml_vd2_exp}, @code{hvml_vd4_exp}, | |
| @code{hvml_vd8_exp}, @code{hvml_vs4_exp2}, @code{hvml_vs8_exp2}, | |
| @code{hvml_vd2_exp2}, @code{hvml_vd4_exp2}, @code{hvml_vd8_exp2}, | |
| @code{hvml_vs4_exp10}, @code{hvml_vs8_exp10}, @code{hvml_vd2_exp10}, | |
| @code{hvml_vd4_exp10}, @code{hvml_vs4_expm1}, @code{hvml_vs8_expm1}, | |
| @code{hvml_vs16_expm1}, @code{hvml_vd2_expm1}, @code{hvml_vd4_expm1}, | |
| @code{hvml_vd8_expm1}, @code{hvml_vs4_fdim}, @code{hvml_vs8_fdim}, | |
| @code{hvml_vd2_fdim}, @code{hvml_vd4_fdim}, @code{hvml_vs4_fmod}, | |
| @code{hvml_vs8_fmod}, @code{hvml_vd2_fmod}, @code{hvml_vd4_fmod}, | |
| @code{hvml_vd8_fmod}, @code{hvml_vs4_hypot}, @code{hvml_vs8_hypot}, | |
| @code{hvml_vd2_hypot}, @code{hvml_vd4_hypot}, @code{hvml_vs4_ln}, | |
| @code{hvml_vs8_ln}, @code{hvml_vs16_ln}, @code{hvml_vd2_ln}, | |
| @code{hvml_vd4_ln}, @code{hvml_vd8_ln}, @code{hvml_vs4_log1p}, | |
| @code{hvml_vs8_log1p}, @code{hvml_vs16_log1p}, @code{hvml_vd2_log1p}, | |
| @code{hvml_vd4_log1p}, @code{hvml_vd8_log1p}, @code{hvml_vs4_log2}, | |
| @code{hvml_vs8_log2}, @code{hvml_vd2_log2}, @code{hvml_vd4_log2}, | |
| @code{hvml_vd8_log2}, @code{hvml_vs4_log10}, @code{hvml_vs8_log10}, | |
| @code{hvml_vs16_log10}, @code{hvml_vd2_log10}, @code{hvml_vd4_log10}, | |
| @code{hvml_vd8_log10}, @code{hvml_vs4_logb}, @code{hvml_vs8_logb}, | |
| @code{hvml_vd2_logb}, @code{hvml_vd4_logb}, @code{hvml_vs4_nextafter}, | |
| @code{hvml_vs8_nextafter}, @code{hvml_vd2_nextafter}, @code{hvml_vd4_nextafter}, | |
| @code{hvml_vs4_pow}, @code{hvml_vs8_pow}, @code{hvml_vs16_pow}, | |
| @code{hvml_vd2_pow}, @code{hvml_vd4_pow}, @code{hvml_vd8_pow}, | |
| @code{hvml_vs4_remainder}, @code{hvml_vs8_remainder}, @code{hvml_vd2_remainder}, | |
| @code{hvml_vd4_remainder}, @code{hvml_vs4_sin}, @code{hvml_vs8_sin}, | |
| @code{hvml_vs16_sin}, @code{hvml_vd2_sin}, @code{hvml_vd4_sin}, | |
| @code{hvml_vd8_sin}, @code{hvml_vs4_sinh}, @code{hvml_vs8_sinh}, | |
| @code{hvml_vs16_sinh}, @code{hvml_vd2_sinh}, @code{hvml_vd4_sinh}, | |
| @code{hvml_vd8_sinh}, @code{hvml_vs4_sinpi}, @code{hvml_vs8_sinpi}, | |
| @code{hvml_vd2_sinpi}, @code{hvml_vd4_sinpi}, @code{hvml_vs4_tan}, | |
| @code{hvml_vs8_tan}, @code{hvml_vs16_tan}, @code{hvml_vd2_tan}, | |
| @code{hvml_vd4_tan}, @code{hvml_vd8_tan}, @code{hvml_vs4_tanh}, | |
| @code{hvml_vs8_tanh}, @code{hvml_vs16_tanh}, @code{hvml_vd2_tanh}, | |
| @code{hvml_vd4_tanh}, @code{hvml_vd8_tanh}, @code{hvml_vs4_tanpi}, | |
| @code{hvml_vs8_tanpi}, @code{hvml_vd2_tanpi}, @code{hvml_vd4_tanpi}, | |
| @code{hvml_vs4_tgamma}, @code{hvml_vs8_tgamma}, @code{hvml_vd2_tgamma} and | |
| @code{hvml_vd4_tgamma} for the corresponding function type when | |
| @option{-mveclibabi=hvml} is used. | |
| @opindex mabi | |
| @item -mabi=@var{name} | |
| Generate code for the specified calling convention. Permissible values | |
| are @samp{sysv} for the ABI used on GNU/Linux and other systems, and | |
| @samp{ms} for the Microsoft ABI. The default is to use the Microsoft | |
| ABI when targeting Microsoft Windows and the SysV ABI on all other systems. | |
| You can control this behavior for specific functions by | |
| using the function attributes @code{ms_abi} and @code{sysv_abi}. | |
| @xref{x86 Attributes}. | |
| @opindex masm=@var{dialect} | |
| @item -masm=@var{dialect} | |
| Output assembly instructions using selected @var{dialect}. Also affects | |
| which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and | |
| extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect | |
| order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does | |
| not support @samp{intel}. | |
| @opindex mforce-indirect-call | |
| @opindex mno-force-indirect-call | |
| @item -mforce-indirect-call | |
| Force all calls to functions to be indirect. This is useful | |
| when using Intel Processor Trace where it generates more precise timing | |
| information for function calls. | |
| @opindex mmanual-endbr | |
| @opindex mno-manual-endbr | |
| @item -mmanual-endbr | |
| Insert ENDBR instruction at function entry only via the @code{cf_check} | |
| function attribute. This is useful when used with the option | |
| @option{-fcf-protection=branch} to control ENDBR insertion at the | |
| function entry. | |
| @opindex mcet-switch | |
| @opindex mno-cet-switch | |
| @item -mcet-switch | |
| By default, CET instrumentation is turned off on switch statements that | |
| use a jump table and indirect branch track is disabled. Since jump | |
| tables are stored in read-only memory, this does not result in a direct | |
| loss of hardening. But if the jump table index is attacker-controlled, | |
| the indirect jump may not be constrained by CET. This option turns on | |
| CET instrumentation to enable indirect branch track for switch statements | |
| with jump tables which leads to the jump targets reachable via any indirect | |
| jumps. | |
| @opindex mcall-ms2sysv-xlogues | |
| @opindex mno-call-ms2sysv-xlogues | |
| @item -mcall-ms2sysv-xlogues | |
| Due to differences in 64-bit ABIs, any Microsoft ABI function that calls a | |
| System V ABI function must consider RSI, RDI and XMM6-15 as clobbered. By | |
| default, the code for saving and restoring these registers is emitted inline, | |
| resulting in fairly lengthy prologues and epilogues. Using | |
| @option{-mcall-ms2sysv-xlogues} emits prologues and epilogues that | |
| use stubs in the static portion of libgcc to perform these saves and restores, | |
| thus reducing function size at the cost of a few extra instructions. | |
| @opindex mtls-dialect | |
| @item -mtls-dialect=@var{type} | |
| Generate code to access thread-local storage using the @samp{gnu} or | |
| @samp{gnu2} conventions. @samp{gnu} is the conservative default; | |
| @samp{gnu2} is more efficient, but it may add compile- and run-time | |
| requirements that cannot be satisfied on all systems. | |
| @opindex mpush-args | |
| @opindex mno-push-args | |
| @item -mpush-args | |
| @itemx -mno-push-args | |
| Use PUSH operations to store outgoing parameters. This method is shorter | |
| and usually equally fast as method using SUB/MOV operations and is enabled | |
| by default. In some cases disabling it may improve performance because of | |
| improved scheduling and reduced dependencies. | |
| @opindex maccumulate-outgoing-args | |
| @opindex mno-accumulate-outgoing-args | |
| @item -maccumulate-outgoing-args | |
| If enabled, the maximum amount of space required for outgoing arguments is | |
| computed in the function prologue. This is faster on most modern CPUs | |
| because of reduced dependencies, improved scheduling and reduced stack usage | |
| when the preferred stack boundary is not equal to 2. The drawback is a notable | |
| increase in code size. This switch implies @option{-mno-push-args}. | |
| @opindex mms-bitfields | |
| @opindex mno-ms-bitfields | |
| @item -mms-bitfields | |
| @itemx -mno-ms-bitfields | |
| Enable/disable bit-field layout compatible with the native Microsoft | |
| Windows compiler. | |
| If @code{packed} is used on a structure, or if bit-fields are used, | |
| it may be that the Microsoft ABI lays out the structure differently | |
| than the way GCC normally does. Particularly when moving packed | |
| data between functions compiled with GCC and the native Microsoft compiler | |
| (either via function call or as data in a file), it may be necessary to access | |
| either format. | |
| This option is enabled by default for Microsoft Windows | |
| targets. This behavior can also be controlled locally by use of variable | |
| or type attributes. For more information, see @ref{x86 Attributes}. | |
| The Microsoft structure layout algorithm is fairly simple with the exception | |
| of the bit-field packing. | |
| The padding and alignment of members of structures and whether a bit-field | |
| can straddle a storage-unit boundary are determine by these rules: | |
| @enumerate | |
| @item Structure members are stored sequentially in the order in which they are | |
| declared: the first member has the lowest memory address and the last member | |
| the highest. | |
| @item Every data object has an alignment requirement. The alignment requirement | |
| for all data except structures, unions, and arrays is either the size of the | |
| object or the current packing size (specified with either the | |
| @code{aligned} attribute or the @code{pack} pragma), | |
| whichever is less. For structures, unions, and arrays, | |
| the alignment requirement is the largest alignment requirement of its members. | |
| Every object is allocated an offset so that: | |
| @smallexample | |
| offset % alignment_requirement == 0 | |
| @end smallexample | |
| @item Adjacent bit-fields are packed into the same 1-, 2-, or 4-byte allocation | |
| unit if the integral types are the same size and if the next bit-field fits | |
| into the current allocation unit without crossing the boundary imposed by the | |
| common alignment requirements of the bit-fields. | |
| @end enumerate | |
| MSVC interprets zero-length bit-fields in the following ways: | |
| @enumerate | |
| @item If a zero-length bit-field is inserted between two bit-fields that | |
| are normally coalesced, the bit-fields are not coalesced. | |
| For example: | |
| @smallexample | |
| struct | |
| @{ | |
| unsigned long bf_1 : 12; | |
| unsigned long : 0; | |
| unsigned long bf_2 : 12; | |
| @} t1; | |
| @end smallexample | |
| @noindent | |
| The size of @code{t1} is 8 bytes with the zero-length bit-field. If the | |
| zero-length bit-field were removed, @code{t1}'s size would be 4 bytes. | |
| @item If a zero-length bit-field is inserted after a bit-field, @code{foo}, and the | |
| alignment of the zero-length bit-field is greater than the member that follows it, | |
| @code{bar}, @code{bar} is aligned as the type of the zero-length bit-field. | |
| For example: | |
| @smallexample | |
| struct | |
| @{ | |
| char foo : 4; | |
| short : 0; | |
| char bar; | |
| @} t2; | |
| struct | |
| @{ | |
| char foo : 4; | |
| short : 0; | |
| double bar; | |
| @} t3; | |
| @end smallexample | |
| @noindent | |
| For @code{t2}, @code{bar} is placed at offset 2, rather than offset 1. | |
| Accordingly, the size of @code{t2} is 4. For @code{t3}, the zero-length | |
| bit-field does not affect the alignment of @code{bar} or, as a result, the size | |
| of the structure. | |
| Taking this into account, it is important to note the following: | |
| @enumerate | |
| @item If a zero-length bit-field follows a normal bit-field, the type of the | |
| zero-length bit-field may affect the alignment of the structure as whole. For | |
| example, @code{t2} has a size of 4 bytes, since the zero-length bit-field | |
| follows a normal bit-field, and is of type short. | |
| @item Even if a zero-length bit-field is not followed by a normal bit-field, | |
| it may still affect the alignment of the structure: | |
| @smallexample | |
| struct | |
| @{ | |
| char foo : 6; | |
| long : 0; | |
| @} t4; | |
| @end smallexample | |
| @noindent | |
| Here, @code{t4} takes up 4 bytes. | |
| @end enumerate | |
| @item Zero-length bit-fields following non-bit-field members are ignored: | |
| @smallexample | |
| struct | |
| @{ | |
| char foo; | |
| long : 0; | |
| char bar; | |
| @} t5; | |
| @end smallexample | |
| @noindent | |
| Here, @code{t5} takes up 2 bytes. | |
| @end enumerate | |
| @opindex mno-align-stringops | |
| @opindex malign-stringops | |
| @item -mno-align-stringops | |
| Do not align the destination of inlined string operations. This switch reduces | |
| code size and improves performance in case the destination is already aligned, | |
| but GCC doesn't know about it. | |
| @opindex minline-all-stringops | |
| @opindex mno-inline-all-stringops | |
| @item -minline-all-stringops | |
| By default GCC inlines string operations only when the destination is | |
| known to be aligned to least a 4-byte boundary. | |
| This enables more inlining and increases code | |
| size, but may improve performance of code that depends on fast | |
| @code{memcpy} and @code{memset} for short lengths. | |
| The option enables inline expansion of @code{strlen} for all | |
| pointer alignments. | |
| @opindex minline-stringops-dynamically | |
| @opindex mno-inline-stringops-dynamically | |
| @item -minline-stringops-dynamically | |
| For string operations of unknown size, use run-time checks with | |
| inline code for small blocks and a library call for large blocks. | |
| @opindex mstringop-strategy=@var{alg} | |
| @item -mstringop-strategy=@var{alg} | |
| Override the internal decision heuristic for the particular algorithm to use | |
| for inlining string operations. The allowed values for @var{alg} are: | |
| @table @samp | |
| @item rep_byte | |
| @itemx rep_4byte | |
| @itemx rep_8byte | |
| Expand using i386 @code{rep} prefix of the specified size. | |
| @item byte_loop | |
| @itemx loop | |
| @itemx unrolled_loop | |
| Expand into an inline loop. | |
| @item libcall | |
| Always use a library call. | |
| @end table | |
| @opindex mmemcpy-strategy=@var{strategy} | |
| @item -mmemcpy-strategy=@var{strategy} | |
| Override the internal decision heuristic to decide if | |
| @code{__builtin_memcpy} should be inlined and what inline algorithm to | |
| use when the expected size of the copy operation is known. | |
| @var{strategy} is a comma-separated list of | |
| @var{alg}:@var{max_size}:@var{dest_align} triplets. @var{alg} is | |
| specified in @option{-mstringop-strategy}, @var{max_size} specifies | |
| the max byte size with which inline algorithm @var{alg} is allowed. | |
| For the last triplet, the @var{max_size} must be @code{-1}. | |
| The @var{max_size} of the triplets in the list must be specified in | |
| increasing order. The minimal byte size for @var{alg} is @code{0} for | |
| the first triplet and @code{@var{max_size} + 1} of the preceding range. | |
| @opindex mmemset-strategy=@var{strategy} | |
| @item -mmemset-strategy=@var{strategy} | |
| This option is similar to @option{-mmemcpy-strategy=} except that it | |
| controls the @code{__builtin_memset} expansion. | |
| @opindex momit-leaf-frame-pointer | |
| @opindex mno-omit-leaf-frame-pointer | |
| @item -momit-leaf-frame-pointer | |
| Don't keep the frame pointer in a register for leaf functions. This | |
| avoids the instructions to save, set up, and restore frame pointers and | |
| makes an extra register available in leaf functions. The option | |
| @option{-momit-leaf-frame-pointer} removes the frame pointer for leaf | |
| functions, which might make debugging harder. | |
| @opindex mtls-direct-seg-refs | |
| @opindex mno-tls-direct-seg-refs | |
| @item -mtls-direct-seg-refs | |
| @itemx -mno-tls-direct-seg-refs | |
| Controls whether TLS variables may be accessed with offsets from the | |
| TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit), | |
| or whether the thread base pointer must be added. Whether or not this | |
| is valid depends on the operating system, and whether it maps the | |
| segment to cover the entire TLS area. | |
| For systems that use the GNU C Library, the default is on. | |
| @opindex msse2avx | |
| @opindex mno-sse2avx | |
| @item -msse2avx | |
| @itemx -mno-sse2avx | |
| Specify that the assembler should encode SSE instructions with VEX | |
| prefix. The option @option{-mavx} turns this on by default. | |
| @opindex mfentry | |
| @opindex mno-fentry | |
| @item -mfentry | |
| @itemx -mno-fentry | |
| If profiling is active (@option{-pg}), put the profiling | |
| counter call before the prologue. | |
| Note: On x86 architectures the attribute @code{ms_hook_prologue} | |
| isn't possible at the moment for @option{-mfentry} and @option{-pg}. | |
| @opindex mrecord-mcount | |
| @opindex mno-record-mcount | |
| @item -mrecord-mcount | |
| @itemx -mno-record-mcount | |
| If profiling is active (@option{-pg}), generate a section that contains | |
| pointers to each profiling call; this is useful for automatically patching | |
| the calls. You can use the @option{mfentry-section=} option to set the | |
| name of the section; it defaults to @samp{__mcount_loc}. | |
| @opindex mnop-mcount | |
| @opindex mno-nop-mcount | |
| @item -mnop-mcount | |
| @itemx -mno-nop-mcount | |
| If profiling is active (@option{-pg}), generate the calls to | |
| the profiling functions as NOPs. This is useful when they | |
| should be patched in later dynamically. This is likely only | |
| useful together with @option{-mrecord-mcount}. | |
| @opindex minstrument-return | |
| @item -minstrument-return=@var{type} | |
| With @option{-pg -mfentry}, instrument function exits according to | |
| @var{type}, which may be one of @samp{none} to not instrument, | |
| @samp{call} to generate a call to @code{__return__}, or @samp{nop5} to | |
| generate a 5-byte nop sequence. This option only instruments true | |
| returns ending with a @code{ret}, not sibling calls via a jump. | |
| @opindex mrecord-return | |
| @opindex mno-record-return | |
| @item -mrecord-return | |
| @itemx -mno-record-return | |
| Generate a @code{__return_loc} section pointing to all return instrumentation | |
| code. | |
| @opindex mfentry-name | |
| @item -mfentry-name=@var{name} | |
| Set name of @code{__fentry__} symbol called at function entry for | |
| @option{-pg -mfentry} functions. | |
| @opindex mfentry-section | |
| @item -mfentry-section=@var{name} | |
| Set name of section to record @option{-mrecord-mcount} calls. The | |
| default is @samp{__mcount_loc}. | |
| @opindex mskip-rax-setup | |
| @opindex mno-skip-rax-setup | |
| @item -mskip-rax-setup | |
| @itemx -mno-skip-rax-setup | |
| When generating code for the x86-64 architecture with SSE extensions | |
| disabled, @option{-mskip-rax-setup} can be used to skip setting up RAX | |
| register when there are no variable arguments passed in vector registers. | |
| @opindex m8bit-idiv | |
| @opindex mno-8bit-idiv | |
| @item -m8bit-idiv | |
| @itemx -mno-8bit-idiv | |
| On some processors, like Intel Atom, 8-bit unsigned integer divide is | |
| much faster than 32-bit/64-bit integer divide. This option generates a | |
| run-time check. If both dividend and divisor are within range of 0 | |
| to 255, 8-bit unsigned integer divide is used instead of | |
| 32-bit/64-bit integer divide. | |
| @opindex mavx256-split-unaligned-load | |
| @opindex mno-avx256-split-unaligned-load | |
| @opindex mavx256-split-unaligned-store | |
| @opindex mno-avx256-split-unaligned-store | |
| @item -mavx256-split-unaligned-load | |
| @itemx -mavx256-split-unaligned-store | |
| Split 32-byte AVX unaligned load and store. | |
| @opindex mstack-protector-guard | |
| @opindex mstack-protector-guard-reg | |
| @opindex mstack-protector-guard-offset | |
| @opindex mstack-protector-guard-symbol | |
| @item -mstack-protector-guard=@var{guard} | |
| @itemx -mstack-protector-guard-reg=@var{reg} | |
| @itemx -mstack-protector-guard-offset=@var{offset} | |
| @itemx -mstack-protector-guard-symbol=@var{symbol} | |
| Generate stack protection code using canary at @var{guard}. Supported | |
| locations are @samp{global} for global canary or @samp{tls} for per-thread | |
| canary in the TLS block (the default). This option has effect only when | |
| @option{-fstack-protector} or @option{-fstack-protector-all} is specified. | |
| With the latter choice the options | |
| @option{-mstack-protector-guard-reg=@var{reg}} and | |
| @option{-mstack-protector-guard-offset=@var{offset}} furthermore specify | |
| which segment register (@code{%fs} or @code{%gs}) to use as base register | |
| for reading the canary, and from what offset from that base register. | |
| The default for those is as specified in the relevant ABI. | |
| @option{-mstack-protector-guard-symbol=@var{symbol}} overrides | |
| the offset with a symbol reference to a canary in the TLS block. | |
| @opindex mgeneral-regs-only | |
| @item -mgeneral-regs-only | |
| Generate code that uses only the general-purpose registers. This | |
| prevents the compiler from using floating-point, vector, mask and bound | |
| registers. | |
| @opindex m128bit-atomic | |
| @opindex mno-128bit-atomic | |
| @item -m128bit-atomic | |
| Generate cmpxchg16b, 128-bit atomic vector load and store instructions | |
| for the x86-64 architecture. This is safe to use only on x86-64-v3 | |
| capable processors as well as AVX capable processors from Intel, AMD, | |
| Hygon and Zhaoxin, which guarantee that 128-bit aligned vector loads | |
| and stores are atomic. This option requires SSE2 and CMPXCHG16B. It | |
| implies @option{-mcx16} which enables CMPXCHG16B. This option is | |
| enabled in 64-bit mode by default if supported by the targeting | |
| processor. For @ref{__atomic Builtins} operating on 128-bit integers, | |
| this option generates atomic instructions directly, instead of calling | |
| a library function in the @file{libatomic} runtime library. | |
| Note that when SSE2 is disabled, i.e., by @option{-mgeneral-regs-only}, | |
| 128-bit atomic operations are unsupported and @file{libatomic} shouldn't | |
| be used since it may use SSE2 or AVX instructions to implement 128-bit | |
| atomic operations. | |
| @opindex mrelax-cmpxchg-loop | |
| @opindex mno-relax-cmpxchg-loop | |
| @item -mrelax-cmpxchg-loop | |
| When emitting a compare-and-swap loop for @ref{__sync Builtins} | |
| and @ref{__atomic Builtins} lacking a native instruction, optimize | |
| for the highly contended case by issuing an atomic load before the | |
| @code{CMPXCHG} instruction, and using the @code{PAUSE} instruction | |
| to save CPU power when restarting the loop. | |
| @opindex mindirect-branch | |
| @item -mindirect-branch=@var{choice} | |
| Convert indirect call and jump with @var{choice}. The default is | |
| @samp{keep}, which keeps indirect call and jump unmodified. | |
| @samp{thunk} converts indirect call and jump to call and return thunk. | |
| @samp{thunk-inline} converts indirect call and jump to inlined call | |
| and return thunk. @samp{thunk-extern} converts indirect call and jump | |
| to external call and return thunk provided in a separate object file. | |
| You can control this behavior for a specific function by using the | |
| function attribute @code{indirect_branch}. @xref{x86 Attributes}. | |
| Note that @option{-mcmodel=large} is incompatible with | |
| @option{-mindirect-branch=thunk} and | |
| @option{-mindirect-branch=thunk-extern} since the thunk function may | |
| not be reachable in the large code model. | |
| Note that @option{-mindirect-branch=thunk-extern} is compatible with | |
| @option{-fcf-protection=branch} since the external thunk can be made | |
| to enable control-flow check. | |
| @opindex mfunction-return | |
| @item -mfunction-return=@var{choice} | |
| Convert function return with @var{choice}. The default is @samp{keep}, | |
| which keeps function return unmodified. @samp{thunk} converts function | |
| return to call and return thunk. @samp{thunk-inline} converts function | |
| return to inlined call and return thunk. @samp{thunk-extern} converts | |
| function return to external call and return thunk provided in a separate | |
| object file. You can control this behavior for a specific function by | |
| using the function attribute @code{function_return}. | |
| @xref{x86 Attributes}. | |
| Note that @option{-mindirect-return=thunk-extern} is compatible with | |
| @option{-fcf-protection=branch} since the external thunk can be made | |
| to enable control-flow check. | |
| Note that @option{-mcmodel=large} is incompatible with | |
| @option{-mfunction-return=thunk} and | |
| @option{-mfunction-return=thunk-extern} since the thunk function may | |
| not be reachable in the large code model. | |
| @opindex mindirect-branch-register | |
| @opindex mno-indirect-branch-register | |
| @item -mindirect-branch-register | |
| Force indirect call and jump via register. | |
| @opindex mharden-sls | |
| @item -mharden-sls=@var{choice} | |
| Generate code to mitigate against straight line speculation (SLS) with | |
| @var{choice}. The default is @samp{none} which disables all SLS | |
| hardening. @samp{return} enables SLS hardening for function returns. | |
| @samp{indirect-jmp} enables SLS hardening for indirect jumps. | |
| @samp{all} enables all SLS hardening. | |
| @opindex mindirect-branch-cs-prefix | |
| @opindex mno-indirect-branch-cs-prefix | |
| @item -mindirect-branch-cs-prefix | |
| Add CS prefix to call and jmp to indirect thunk with branch target in | |
| r8-r15 registers, so that the call and jmp instruction length is 6 bytes. | |
| This allows them to potentially be replaced with @samp{lfence; call *%r8-r15} | |
| or @samp{lfence; jmp *%r8-r15} at run time. | |
| @opindex mapx-inline-asm-use-gpr32 | |
| @opindex mno-apx-inline-asm-use-gpr32 | |
| @item -mapx-inline-asm-use-gpr32 | |
| By default, EGPR usage is disabled in inline asm constraints as GCC cannot | |
| be aware of whether the asm instructions support GP32 or not. | |
| If your inline asm can handle EGPR, use @option{-mapx-inline-asm-use-gpr32}. | |
| @opindex mgather | |
| @opindex mno-gather | |
| @opindex mscatter | |
| @opindex mno-scatter | |
| @item -mgather | |
| @itemx -mscatter | |
| Enable vectorization for gather and scatter instructions, respectively. | |
| @end table | |
| These @samp{-m} switches are supported in addition to the above | |
| on x86-64 processors in 64-bit environments. | |
| @table @gcctabopt | |
| @opindex m32 | |
| @opindex m64 | |
| @opindex mx32 | |
| @opindex m16 | |
| @item -m32 | |
| @itemx -m64 | |
| @itemx -mx32 | |
| @itemx -m16 | |
| Generate code for a 16-bit, 32-bit or 64-bit environment. | |
| The @option{-m32} option sets @code{int}, @code{long}, and pointer types | |
| to 32 bits, and | |
| generates code that runs in 32-bit mode. | |
| The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer | |
| types to 64 bits, and generates code for the x86-64 architecture. | |
| For Darwin only the @option{-m64} option also turns off the @option{-fno-pic} | |
| and @option{-mdynamic-no-pic} options. | |
| The @option{-mx32} option sets @code{int}, @code{long}, and pointer types | |
| to 32 bits, and | |
| generates code for the x86-64 architecture. | |
| The @option{-m16} option is the same as @option{-m32}, except for that | |
| it outputs the @code{.code16gcc} assembly directive at the beginning of | |
| the assembly output so that the binary can run in 16-bit mode. | |
| @opindex miamcu | |
| @opindex mno-iamcu | |
| @item -miamcu | |
| The @option{-miamcu} option generates code that conforms to Intel MCU | |
| psABI. It requires the @option{-m32} option to be turned on. | |
| @opindex mno-red-zone | |
| @opindex mred-zone | |
| @item -mno-red-zone | |
| Do not use a so-called ``red zone'' for x86-64 code. The red zone is mandated | |
| by the x86-64 ABI; it is a 128-byte area beyond the location of the | |
| stack pointer that is not modified by signal or interrupt handlers | |
| and therefore can be used for temporary data without adjusting the stack | |
| pointer. The flag @option{-mno-red-zone} disables this red zone. | |
| @opindex mcmodel= | |
| @opindex mcmodel=small | |
| @item -mcmodel=small | |
| Generate code for the small code model: the program and its symbols must | |
| be linked in the lower 2 GB of the address space. Pointers are 64 bits. | |
| Programs can be statically or dynamically linked. This is the default | |
| code model. | |
| @opindex mcmodel=kernel | |
| @item -mcmodel=kernel | |
| Generate code for the kernel code model. The kernel runs in the | |
| negative 2 GB of the address space. | |
| This model has to be used for Linux kernel code. | |
| @opindex mcmodel=medium | |
| @item -mcmodel=medium | |
| Generate code for the medium model: the program is linked in the lower 2 | |
| GB of the address space. Small symbols are also placed there. Symbols | |
| with sizes larger than @option{-mlarge-data-threshold} are put into | |
| large data or BSS sections and can be located above 2GB. Programs can | |
| be statically or dynamically linked. | |
| @opindex mcmodel=large | |
| @item -mcmodel=large | |
| Generate code for the large model. This model makes no assumptions | |
| about addresses and sizes of sections. | |
| @opindex maddress-mode=long | |
| @item -maddress-mode=long | |
| Generate code for long address mode. This is only supported for 64-bit | |
| and x32 environments. It is the default address mode for 64-bit | |
| environments. | |
| @opindex maddress-mode=short | |
| @item -maddress-mode=short | |
| Generate code for short address mode. This is only supported for 32-bit | |
| and x32 environments. It is the default address mode for 32-bit and | |
| x32 environments. | |
| @opindex mneeded | |
| @opindex mno-needed | |
| @item -mneeded | |
| @itemx -mno-needed | |
| Emit GNU_PROPERTY_X86_ISA_1_NEEDED GNU property for Linux target to | |
| indicate the micro-architecture ISA level required to execute the binary. | |
| @opindex mno-direct-extern-access | |
| @opindex mdirect-extern-access | |
| @item -mno-direct-extern-access | |
| Without @option{-fpic} or @option{-fPIC}, always use the GOT pointer | |
| to access external symbols. With @option{-fpic} or @option{-fPIC}, | |
| treat access to protected symbols as local symbols. The default is | |
| @option{-mdirect-extern-access}. | |
| @strong{Warning:} shared libraries compiled with | |
| @option{-mno-direct-extern-access} and executable compiled with | |
| @option{-mdirect-extern-access} may not be binary compatible if | |
| protected symbols are used in shared libraries and executable. | |
| @opindex munroll-only-small-loops | |
| @opindex mno-unroll-only-small-loops | |
| @item -munroll-only-small-loops | |
| @itemx -mno-unroll-only-small-loops | |
| Controls conservative small loop unrolling. It is enabled by default with | |
| @option{-O2}, and unrolls loops with less than 4 instructions by 1 time. | |
| This gives better utilization of the instruction decoding pipeline on modern | |
| processors. You can disable this with @option{-mno-unroll-only-small-loops}, | |
| and it is also disabled if the more general options @option{-funroll-loops} | |
| or @option{-funroll-all-loops} are either enabled or explicitly disabled. | |
| @opindex mdispatch-scheduler | |
| @item -mdispatch-scheduler | |
| Enable instruction scheduling. This is only supported on @samp{bdver1}, | |
| @samp{bdver2}, @samp{bdver3}, @samp{bdver4}, and @samp{znver1} processors and | |
| additionally requires @option{-fschedule-insns -fsched-pressure}. | |
| @opindex mlam | |
| @item -mlam=@var{choice} | |
| LAM(linear-address masking) allows special bits in the pointer to be used | |
| for metadata. The default is @samp{none}. With @samp{u48}, pointer bits in | |
| positions 62:48 can be used for metadata; With @samp{u57}, pointer bits in | |
| positions 62:57 can be used for metadata. | |
| @end table | |
| @node x86 Windows Options | |
| @subsection x86 Windows Options | |
| @cindex x86 Windows Options | |
| @cindex Windows Options for x86 | |
| @xref{Cygwin and MinGW Options}. | |
| @node Xstormy16 Options | |
| @subsection Xstormy16 Options | |
| @cindex Xstormy16 Options | |
| These options are defined for Xstormy16: | |
| @table @gcctabopt | |
| @opindex msim | |
| @item -msim | |
| Choose startup files and linker script suitable for the simulator. | |
| @end table | |
| @node Xtensa Options | |
| @subsection Xtensa Options | |
| @cindex Xtensa Options | |
| These options are supported for Xtensa targets: | |
| @table @gcctabopt | |
| @opindex mconst16 | |
| @opindex mno-const16 | |
| @item -mconst16 | |
| @itemx -mno-const16 | |
| Enable or disable use of @code{CONST16} instructions for loading | |
| constant values. When enabled, @code{CONST16} instructions are always | |
| used in place of the standard @code{L32R} instructions. The use of | |
| @code{CONST16} is enabled by default only if the @code{L32R} instruction | |
| is not available. | |
| @opindex mserialize-volatile | |
| @opindex mno-serialize-volatile | |
| @item -mserialize-volatile | |
| @itemx -mno-serialize-volatile | |
| When this option is enabled, GCC inserts @code{MEMW} instructions before | |
| @code{volatile} memory references to guarantee sequential consistency. | |
| The default is @option{-mserialize-volatile}. Use | |
| @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions. | |
| @opindex mforce-no-pic | |
| @opindex mno-force-no-pic | |
| @item -mforce-no-pic | |
| @itemx -mno-force-no-pic | |
| For targets like GNU/Linux, where all user-mode Xtensa code must be | |
| position-independent code (PIC), this option disables PIC for compiling | |
| kernel code. | |
| @opindex mtext-section-literals | |
| @opindex mno-text-section-literals | |
| @item -mtext-section-literals | |
| @itemx -mno-text-section-literals | |
| These options control the treatment of literal pools. The default is | |
| @option{-mno-text-section-literals}, which places literals in a separate | |
| section in the output file. This allows the literal pool to be placed | |
| in a data RAM/ROM, and it also allows the linker to combine literal | |
| pools from separate object files to remove redundant literals and | |
| improve code size. With @option{-mtext-section-literals}, the literals | |
| are interspersed in the text section in order to keep them as close as | |
| possible to their references. This may be necessary for large assembly | |
| files. Literals for each function are placed right before that function. | |
| @opindex mauto-litpools | |
| @opindex mno-auto-litpools | |
| @item -mauto-litpools | |
| @itemx -mno-auto-litpools | |
| These options control the treatment of literal pools. The default is | |
| @option{-mno-auto-litpools}, which places literals in a separate | |
| section in the output file unless @option{-mtext-section-literals} is | |
| used. With @option{-mauto-litpools} the literals are interspersed in | |
| the text section by the assembler. Compiler does not produce explicit | |
| @code{.literal} directives and loads literals into registers with | |
| @code{MOVI} instructions instead of @code{L32R} to let the assembler | |
| do relaxation and place literals as necessary. This option allows | |
| assembler to create several literal pools per function and assemble | |
| very big functions, which may not be possible with | |
| @option{-mtext-section-literals}. | |
| @opindex mtarget-align | |
| @opindex mno-target-align | |
| @item -mtarget-align | |
| @itemx -mno-target-align | |
| When this option is enabled, GCC instructs the assembler to | |
| automatically align instructions to reduce branch penalties at the | |
| expense of some code density. The assembler attempts to widen density | |
| instructions to align branch targets and the instructions following call | |
| instructions. If there are not enough preceding safe density | |
| instructions to align a target, no widening is performed. The | |
| default is @option{-mtarget-align}. These options do not affect the | |
| treatment of auto-aligned instructions like @code{LOOP}, which the | |
| assembler always aligns, either by widening density instructions or | |
| by inserting NOP instructions. | |
| @opindex mlongcalls | |
| @opindex mno-longcalls | |
| @item -mlongcalls | |
| @itemx -mno-longcalls | |
| When this option is enabled, GCC instructs the assembler to translate | |
| direct calls to indirect calls unless it can determine that the target | |
| of a direct call is in the range allowed by the call instruction. This | |
| translation typically occurs for calls to functions in other source | |
| files. Specifically, the assembler translates a direct @code{CALL} | |
| instruction into an @code{L32R} followed by a @code{CALLX} instruction. | |
| The default is @option{-mno-longcalls}. This option should be used in | |
| programs where the call target can potentially be out of range. This | |
| option is implemented in the assembler, not the compiler, so the | |
| assembly code generated by GCC still shows direct call | |
| instructions---look at the disassembled object code to see the actual | |
| instructions. Note that the assembler uses an indirect call for | |
| every cross-file call, not just those that really are out of range. | |
| @opindex mabi | |
| @item -mabi=@var{name} | |
| Generate code for the specified ABI@. Permissible values are: @samp{call0}, | |
| @samp{windowed}. Default ABI is chosen by the Xtensa core configuration. | |
| @opindex mabi=call0 | |
| @item -mabi=call0 | |
| When this option is enabled function parameters are passed in registers | |
| @code{a2} through @code{a7}, registers @code{a12} through @code{a15} are | |
| caller-saved, and register @code{a15} may be used as a frame pointer. | |
| When this version of the ABI is enabled the C preprocessor symbol | |
| @code{__XTENSA_CALL0_ABI__} is defined. | |
| @opindex mabi=windowed | |
| @item -mabi=windowed | |
| When this option is enabled function parameters are passed in registers | |
| @code{a10} through @code{a15}, and called function rotates register window | |
| by 8 registers on entry so that its arguments are found in registers | |
| @code{a2} through @code{a7}. Register @code{a7} may be used as a frame | |
| pointer. Register window is rotated 8 registers back upon return. | |
| When this version of the ABI is enabled the C preprocessor symbol | |
| @code{__XTENSA_WINDOWED_ABI__} is defined. | |
| @opindex mextra-l32r-costs | |
| @item -mextra-l32r-costs=@var{n} | |
| Specify an extra cost of instruction RAM/ROM access for @code{L32R} | |
| instructions, in clock cycles. This affects, when optimizing for speed, | |
| whether loading a constant from literal pool using @code{L32R} or | |
| synthesizing the constant from a small one with a couple of arithmetic | |
| instructions. The default value is 0. | |
| @opindex mstrict-align | |
| @opindex mno-strict-align | |
| @item -mstrict-align | |
| @itemx -mno-strict-align | |
| Avoid or allow generating memory accesses that may not be aligned on a natural | |
| object boundary as described in the architecture specification. | |
| The default is @option{-mno-strict-align} for cores that support both | |
| unaligned loads and stores in hardware and @option{-mstrict-align} for all | |
| other cores. | |
| @opindex mforce-l32 | |
| @opindex mno-force-l32 | |
| @item -mforce-l32 | |
| @itemx -mno-force-l32 | |
| When this option is enabled, GCC performs 1- or 2-byte loads in the generic | |
| address space (ie., default memory references) by bit-extracting the desired | |
| portion from the result of an aligned 4-byte load, instead of the instructions | |
| originally provided for those purposes. This option does not affect memory | |
| stores of such byte width, or the placement of those memory sections (see | |
| also @code{__force_l32} address spaces described in | |
| @ref{Xtensa Named Address Spaces}, and @code{force_l32} attribute described | |
| in @ref{Xtensa Attributes}). The default is @option{-mno-force-l32}. | |
| @end table | |
| @node zSeries Options | |
| @subsection zSeries Options | |
| @cindex zSeries options | |
| These are listed under @xref{S/390 and zSeries Options}. | |
| @c man end | |
| @node Environment Variables | |
| @section Environment Variables Affecting GCC | |
| @cindex environment variables | |
| @c man begin ENVIRONMENT | |
| This section describes several environment variables that affect how GCC | |
| operates. Some of them work by specifying directories or prefixes to use | |
| when searching for various kinds of files. Some are used to specify other | |
| aspects of the compilation environment. | |
| Note that you can also specify places to search using options such as | |
| @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These | |
| take precedence over places specified using environment variables, which | |
| in turn take precedence over those specified by the configuration of GCC@. | |
| @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint, | |
| GNU Compiler Collection (GCC) Internals}. | |
| @table @env | |
| @vindex LANG | |
| @vindex LC_CTYPE | |
| @c @vindex LC_COLLATE | |
| @vindex LC_MESSAGES | |
| @c @vindex LC_MONETARY | |
| @c @vindex LC_NUMERIC | |
| @c @vindex LC_TIME | |
| @vindex LC_ALL | |
| @cindex locale | |
| @item LANG | |
| @itemx LC_CTYPE | |
| @c @itemx LC_COLLATE | |
| @itemx LC_MESSAGES | |
| @c @itemx LC_MONETARY | |
| @c @itemx LC_NUMERIC | |
| @c @itemx LC_TIME | |
| @itemx LC_ALL | |
| These environment variables control the way that GCC uses | |
| localization information that allows GCC to work with different | |
| national conventions for diagnostic and informational output. | |
| GCC inspects the locale categories | |
| @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do | |
| so. These locale categories can be set to any value supported by your | |
| installation. A typical value is @samp{en_GB.UTF-8} for English in the United | |
| Kingdom encoded in UTF-8. | |
| If the @env{LC_ALL} environment variable is set, it overrides the value | |
| of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE} | |
| and @env{LC_MESSAGES} default to the value of the @env{LANG} | |
| environment variable. If none of these variables are set, GCC | |
| defaults to traditional C English behavior. | |
| These environment variables do not affect the encodings of input files | |
| and strings in output files produced by GCC, which are controlled by the | |
| @option{-finput-charset} and @option{-fexec-charset} options, respectively. | |
| @xref{Preprocessor Options}. | |
| @vindex TMPDIR | |
| @item TMPDIR | |
| If @env{TMPDIR} is set, it specifies the directory to use for temporary | |
| files. GCC uses temporary files to hold the output of one stage of | |
| compilation which is to be used as input to the next stage: for example, | |
| the output of the preprocessor, which is the input to the compiler | |
| proper. | |
| @vindex GCC_DIAGNOSTICS_LOG | |
| @item GCC_DIAGNOSTICS_LOG | |
| If @env{GCC_DIAGNOSTICS_LOG} is set, then additional information | |
| about the diagnostics subsystem will be emitted. If it is set to an empty | |
| value, then the information will be written to stderr; otherwise, GCC will | |
| attempt to open that file and write the information there. | |
| The precise content and format of the information is subject to change; | |
| it is intended for use by GCC developers, rather than end-users. | |
| @vindex GCC_COMPARE_DEBUG | |
| @item GCC_COMPARE_DEBUG | |
| Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing | |
| @option{-fcompare-debug} to the compiler driver. See the documentation | |
| of this option for more details. | |
| @vindex GCC_EXEC_PREFIX | |
| @item GCC_EXEC_PREFIX | |
| If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the | |
| names of the subprograms executed by the compiler. No slash is added | |
| when this prefix is combined with the name of a subprogram, but you can | |
| specify a prefix that ends with a slash if you wish. | |
| If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out | |
| an appropriate prefix to use based on the pathname it is invoked with. | |
| If GCC cannot find the subprogram using the specified prefix, it | |
| tries looking in the usual places for the subprogram. | |
| The default value of @env{GCC_EXEC_PREFIX} is | |
| @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to | |
| the installed compiler. In many cases @var{prefix} is the value | |
| of @code{prefix} when you ran the @file{configure} script. | |
| Other prefixes specified with @option{-B} take precedence over this prefix. | |
| This prefix is also used for finding files such as @file{crt0.o} that are | |
| used for linking. | |
| In addition, the prefix is used in an unusual way in finding the | |
| directories to search for header files. For each of the standard | |
| directories whose name normally begins with @samp{/usr/local/lib/gcc} | |
| (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries | |
| replacing that beginning with the specified prefix to produce an | |
| alternate directory name. Thus, with @option{-Bfoo/}, GCC searches | |
| @file{foo/bar} just before it searches the standard directory | |
| @file{/usr/local/lib/bar}. | |
| If a standard directory begins with the configured | |
| @var{prefix} then the value of @var{prefix} is replaced by | |
| @env{GCC_EXEC_PREFIX} when looking for header files. | |
| @vindex COMPILER_PATH | |
| @item COMPILER_PATH | |
| The value of @env{COMPILER_PATH} is a colon-separated list of | |
| directories, much like @env{PATH}. GCC tries the directories thus | |
| specified when searching for subprograms, if it cannot find the | |
| subprograms using @env{GCC_EXEC_PREFIX}. | |
| @vindex LIBRARY_PATH | |
| @item LIBRARY_PATH | |
| The value of @env{LIBRARY_PATH} is a colon-separated list of | |
| directories, much like @env{PATH}. When configured as a native compiler, | |
| GCC tries the directories thus specified when searching for special | |
| linker files, if it cannot find them using @env{GCC_EXEC_PREFIX}. Linking | |
| using GCC also uses these directories when searching for ordinary | |
| libraries for the @option{-l} option (but directories specified with | |
| @option{-L} come first). | |
| @vindex GCC_EXTRA_DIAGNOSTIC_OUTPUT | |
| @item GCC_EXTRA_DIAGNOSTIC_OUTPUT | |
| If @env{GCC_EXTRA_DIAGNOSTIC_OUTPUT} is set to one of the following values, | |
| then additional text will be emitted to stderr when fix-it hints are | |
| emitted. @option{-fdiagnostics-parseable-fixits} and | |
| @option{-fno-diagnostics-parseable-fixits} take precedence over this | |
| environment variable. | |
| @table @samp | |
| @item fixits-v1 | |
| Emit parseable fix-it hints, equivalent to | |
| @option{-fdiagnostics-parseable-fixits}. In particular, columns are | |
| expressed as a count of bytes, starting at byte 1 for the initial column. | |
| @item fixits-v2 | |
| As @code{fixits-v1}, but columns are expressed as display columns, | |
| as per @option{-fdiagnostics-column-unit=display}. | |
| @end table | |
| @vindex EXPERIMENTAL_SARIF_SOCKET | |
| @item EXPERIMENTAL_SARIF_SOCKET | |
| If @env{EXPERIMENTAL_SARIF_SOCKET} is set in the environment, then the | |
| compiler will attempt to connect to a UNIX domain stream socket with | |
| that name, and send an @code{OnSarifResult} JSON-RPC 2.0 notification to | |
| it for each diagnostic that occurs, where the value of the notification | |
| is a SARIF @code{result} object. | |
| The compiler will fail immediately if @env{EXPERIMENTAL_SARIF_SOCKET} is | |
| set and it cannot connect to it. | |
| This feature is experimental and subject to change or removal without | |
| notice. | |
| @vindex COLLECT_GCC_OPTIONS | |
| @item COLLECT_GCC_OPTIONS | |
| Set by the driver and read by @command{collect2}, @command{lto-wrapper}, | |
| and the LTO linker plugin to pass the driver's option list. If | |
| the list is too long (over 1 KiB by default), the driver writes it to a | |
| temporary file and sets this variable to @samp{@@@var{path}} instead. | |
| @end table | |
| @noindent | |
| Some additional environment variables affect the behavior of the | |
| preprocessor. | |
| @include cppenv.texi | |
| @c man end | |
| @node Precompiled Headers | |
| @section Using Precompiled Headers | |
| @cindex precompiled headers | |
| @cindex speed of compilation | |
| Often large projects have many header files that are included in every | |
| source file. The time the compiler takes to process these header files | |
| over and over again can account for nearly all of the time required to | |
| build the project. To make builds faster, GCC allows you to | |
| @dfn{precompile} a header file. | |
| To create a precompiled header file, simply compile it as you would any | |
| other file, if necessary using the @option{-x} option to make the driver | |
| treat it as a C or C++ header file. You may want to use a | |
| tool like @command{make} to keep the precompiled header up-to-date when | |
| the headers it contains change. | |
| A precompiled header file is searched for when @code{#include} is | |
| seen in the compilation. As it searches for the included file | |
| (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the | |
| compiler looks for a precompiled header in each directory just before it | |
| looks for the include file in that directory. The name searched for is | |
| the name specified in the @code{#include} with @samp{.gch} appended. If | |
| the precompiled header file cannot be used, it is ignored. | |
| For instance, if you have @code{#include "all.h"}, and you have | |
| @file{all.h.gch} in the same directory as @file{all.h}, then the | |
| precompiled header file is used if possible, and the original | |
| header is used otherwise. | |
| Alternatively, you might decide to put the precompiled header file in a | |
| directory and use @option{-I} to ensure that directory is searched | |
| before (or instead of) the directory containing the original header. | |
| Then, if you want to check that the precompiled header file is always | |
| used, you can put a file of the same name as the original header in this | |
| directory containing an @code{#error} command. | |
| This also works with @option{-include}. So yet another way to use | |
| precompiled headers, good for projects not designed with precompiled | |
| header files in mind, is to simply take most of the header files used by | |
| a project, include them from another header file, precompile that header | |
| file, and @option{-include} the precompiled header. If the header files | |
| have guards against multiple inclusion, they are skipped because | |
| they've already been included (in the precompiled header). | |
| If you need to precompile the same header file for different | |
| languages, targets, or compiler options, you can instead make a | |
| @emph{directory} named like @file{all.h.gch}, and put each precompiled | |
| header in the directory, perhaps using @option{-o}. It doesn't matter | |
| what you call the files in the directory; every precompiled header in | |
| the directory is considered. The first precompiled header | |
| encountered in the directory that is valid for this compilation is | |
| used; they're searched in no particular order. | |
| There are many other possibilities, limited only by your imagination, | |
| good sense, and the constraints of your build system. | |
| A precompiled header file can be used only when these conditions apply: | |
| @itemize | |
| @item | |
| Only one precompiled header can be used in a particular compilation. | |
| @item | |
| A precompiled header cannot be used once the first C token is seen. You | |
| can have preprocessor directives before a precompiled header; you cannot | |
| include a precompiled header from inside another header. | |
| @item | |
| The precompiled header file must be produced for the same language as | |
| the current compilation. You cannot use a C precompiled header for a C++ | |
| compilation. | |
| @item | |
| The precompiled header file must have been produced by the same compiler | |
| binary as the current compilation is using. | |
| @item | |
| Any macros defined before the precompiled header is included must | |
| either be defined in the same way as when the precompiled header was | |
| generated, or must not affect the precompiled header, which usually | |
| means that they don't appear in the precompiled header at all. | |
| The @option{-D} option is one way to define a macro before a | |
| precompiled header is included; using a @code{#define} can also do it. | |
| There are also some options that define macros implicitly, like | |
| @option{-O} and @option{-Wdeprecated}; the same rule applies to macros | |
| defined this way. | |
| @item If debugging information is output when using the precompiled | |
| header, using @option{-g} or similar, the same kind of debugging information | |
| must have been output when building the precompiled header. However, | |
| a precompiled header built using @option{-g} can be used in a compilation | |
| when no debugging information is being output. | |
| @item The same @option{-m} options must generally be used when building | |
| and using the precompiled header. @xref{Target-Specific Options}, | |
| for any cases where this rule is relaxed. | |
| @item Each of the following options must be the same when building and using | |
| the precompiled header: | |
| @gccoptlist{-fexceptions} | |
| @item | |
| Some other command-line options starting with @option{-f}, | |
| @option{-p}, or @option{-O} must be defined in the same way as when | |
| the precompiled header was generated. At present, it's not clear | |
| which options are safe to change and which are not; the safest choice | |
| is to use exactly the same options when generating and using the | |
| precompiled header. The following are known to be safe: | |
| @gccoptlist{-fmessage-length= -fpreprocessed -fsched-interblock | |
| -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous | |
| -fsched-verbose=@var{number} -fschedule-insns -fvisibility= | |
| -pedantic-errors} | |
| @item Address space layout randomization (ASLR) can lead to not binary identical | |
| PCH files. If you rely on stable PCH file contents disable ASLR when generating | |
| PCH files. | |
| @end itemize | |
| For all of these except the last, the compiler automatically | |
| ignores the precompiled header if the conditions aren't met. If you | |
| find an option combination that doesn't work and doesn't cause the | |
| precompiled header to be ignored, please consider filing a bug report, | |
| see @ref{Bugs}. | |
| If you do use differing options when generating and using the | |
| precompiled header, the actual behavior is a mixture of the | |
| behavior for the options. For instance, if you use @option{-g} to | |
| generate the precompiled header but not when using it, you may or may | |
| not get debugging information for routines in the precompiled header. | |
| @node C++ Modules | |
| @section C++ Modules | |
| @cindex speed of compilation | |
| Modules are a C++20 language feature. As the name suggests, they | |
| provide a modular compilation system, intending to provide both | |
| faster builds and better library isolation. The ``Merging Modules'' | |
| paper @uref{https://wg21.link/p1103}, provides the easiest to read set | |
| of changes to the standard, although it does not capture later | |
| changes. | |
| @emph{G++'s modules support is not complete.} Other than bugs, the | |
| known missing pieces are: | |
| @table @emph | |
| @item Private Module Fragment | |
| The Private Module Fragment is recognized, but an error is emitted. | |
| @item Partition definition visibility rules | |
| Entities may be defined in implementation partitions, and those | |
| definitions are not available outside of the module. This is not | |
| implemented, and the definitions are available to extra-module use. | |
| @end table | |
| Modular compilation is @emph{not} enabled with just the | |
| @option{-std=c++20} option. You must explicitly enable it with the | |
| @option{-fmodules} option. It is independent of the language | |
| version selected, although in pre-C++20 versions, it is of course an | |
| extension. | |
| No new source file suffixes are required. A few suffixes preferred | |
| for module interface units by other compilers (e.g. @samp{.ixx}, | |
| @samp{.cppm}) are supported, but files with these suffixes are treated | |
| the same as any other C++ source file. | |
| Compiling a module interface unit produces an additional output (to | |
| the assembly or object file), called a Compiled Module Interface | |
| (CMI). This encodes the exported declarations of the module. | |
| Importing a module reads in the CMI. The import graph is a Directed | |
| Acyclic Graph (DAG). You must build imports before the importer. | |
| Header files may themselves be compiled to header units, which are a | |
| transitional ability aiming at faster compilation. The | |
| @option{-fmodule-header} option is used to enable this, and implies | |
| the @option{-fmodules} option. These CMIs are named by the fully | |
| resolved underlying header file, and thus may be a complete pathname | |
| containing subdirectories. If the header file is found at an absolute | |
| pathname, the CMI location is still relative to a CMI root directory. | |
| As header files often have no suffix, you commonly have to specify a | |
| @option{-x} option to tell the compiler the source is a header file. | |
| You may use @option{-x c++-header}, @option{-x c++-user-header} or | |
| @option{-x c++-system-header}. When used in conjunction with | |
| @option{-fmodules}, these all imply an appropriate | |
| @option{-fmodule-header} option. The latter two variants use the | |
| user or system include path to search for the file specified. This | |
| allows you to, for instance, compile standard library header files as | |
| header units, without needing to know exactly where they are | |
| installed. Specifying the language as one of these variants also | |
| inhibits output of the object file, as header files have no associated | |
| object file. | |
| Alternately, or for a module interface unit in an installed location, | |
| you can use @option{-fsearch-include-path} to specify that the main | |
| source file should be found on the include path rather than the | |
| current directory. | |
| Header units can be used in much the same way as precompiled headers | |
| (@pxref{Precompiled Headers}), but with fewer restrictions: an | |
| #include that is translated to a header unit import can appear at any | |
| point in the source file, and multiple header units can be used | |
| together. In particular, the @option{-include} strategy works: with | |
| the bits/stdc++.h header used for libstdc++ precompiled headers you | |
| can | |
| @smallexample | |
| g++ -fmodules -x c++-system-header -c bits/stdc++.h | |
| g++ -fmodules -include bits/stdc++.h mycode.C | |
| @end smallexample | |
| and any standard library #includes in mycode.C will be skipped, | |
| because the import brought in the whole library. This can be a simple | |
| way to use modules to speed up compilation without any code changes. | |
| But for the standard library in particular this is unnecessary: if a | |
| header unit has been built for the libstdc++ @samp{bits/stdc++.h} | |
| header, the compiler will translate an @samp{#include} of any | |
| importable standard library header into an import of that header unit, | |
| speeding up compilation without needing to specify @samp{-include}. | |
| Note that the @samp{bits/stdc++.h} header unit is also built by the | |
| @option{--compile-std-module} option. | |
| The @option{-fmodule-only} option disables generation of the | |
| associated object file for compiling a module interface. Only the CMI | |
| is generated. This option is implied when using the | |
| @option{-fmodule-header} option. | |
| The @option{-flang-info-include-translate} and | |
| @option{-flang-info-include-translate-not} options notes whether | |
| include translation occurs or not. With no argument, the first will | |
| note all include translation. The second will note all | |
| non-translations of include files not known to intentionally be | |
| textual. With an argument, queries about include translation of a | |
| header files with that particular trailing pathname are noted. You | |
| may repeat this form to cover several different header files. This | |
| option may be helpful in determining whether include translation is | |
| happening---if it is working correctly, it behaves as if it isn't | |
| there at all. | |
| The @option{-flang-info-module-cmi} option can be used to determine | |
| where the compiler is reading a CMI from. Without the option, the | |
| compiler is silent when such a read is successful. This option has an | |
| optional argument, which will restrict the notification to just the | |
| set of named modules or header units specified. | |
| The @option{-Winvalid-imported-macros} option causes all imported macros | |
| to be resolved at the end of compilation. Without this, imported | |
| macros are only resolved when expanded or (re)defined. This option | |
| detects conflicting import definitions for all macros. | |
| For details of the @option{-fmodule-mapper} family of options, | |
| @pxref{C++ Module Mapper}. | |
| @menu | |
| * C++ Module Mapper:: Module Mapper | |
| * C++ Module Preprocessing:: Module Preprocessing | |
| * C++ Compiled Module Interface:: Compiled Module Interface | |
| @end menu | |
| @node C++ Module Mapper | |
| @subsection Module Mapper | |
| @cindex C++ Module Mapper | |
| A module mapper provides a server or file that the compiler queries to | |
| determine the mapping between module names and CMI files. It is also | |
| used to build CMIs on demand. @emph{Mapper functionality is in its | |
| infancy and is intended for experimentation with build system | |
| interactions.} | |
| You can specify a mapper with the @option{-fmodule-mapper=@var{val}} | |
| option or @env{CXX_MODULE_MAPPER} environment variable. The value may | |
| have one of the following forms: | |
| @table @gcctabopt | |
| @item @r{[}@var{hostname}@r{]}:@var{port}@r{[}?@var{ident}@r{]} | |
| An optional hostname and a numeric port number to connect to. If the | |
| hostname is omitted, the loopback address is used. If the hostname | |
| corresponds to multiple IPV6 addresses, these are tried in turn, until | |
| one is successful. If your host lacks IPv6, this form is | |
| non-functional. If you must use IPv4 use | |
| @option{-fmodule-mapper='|ncat @var{ipv4host} @var{port}'}. | |
| @item =@var{socket}@r{[}?@var{ident}@r{]} | |
| A local domain socket. If your host lacks local domain sockets, this | |
| form is non-functional. | |
| @item |@var{program}@r{[}?@var{ident}@r{]} @r{[}@var{args...}@r{]} | |
| A program to spawn, and communicate with on its stdin/stdout streams. | |
| Your @var{PATH} environment variable is searched for the program. | |
| Arguments are separated by space characters, (it is not possible for | |
| one of the arguments delivered to the program to contain a space). An | |
| exception is if @var{program} begins with @@. In that case | |
| @var{program} (sans @@) is looked for in the compiler's internal | |
| binary directory. Thus the sample mapper-server can be specified | |
| with @code{@@g++-mapper-server}. | |
| @item <>@r{[}?@var{ident}@r{]} | |
| @item <>@var{inout}@r{[}?@var{ident}@r{]} | |
| @item <@var{in}>@var{out}@r{[}?@var{ident}@r{]} | |
| Named pipes or file descriptors to communicate over. The first form, | |
| @option{<>}, communicates over stdin and stdout. The other forms | |
| allow you to specify a file descriptor or name a pipe. A numeric value | |
| is interpreted as a file descriptor, otherwise named pipe is opened. | |
| The second form specifies a bidirectional pipe and the last form | |
| allows specifying two independent pipes. Using file descriptors | |
| directly in this manner is fragile in general, as it can require the | |
| cooperation of intermediate processes. In particular using stdin & | |
| stdout is fraught with danger as other compiler options might also | |
| cause the compiler to read stdin or write stdout, and it can have | |
| unfortunate interactions with signal delivery from the terminal. | |
| @item @var{file}@r{[}?@var{ident}@r{]} | |
| A mapping file consisting of space-separated module-name, filename | |
| pairs, one per line. Only the mappings for the direct imports and any | |
| module export name need be provided. If other mappings are provided, | |
| they override those stored in any imported CMI files. A repository | |
| root may be specified in the mapping file by using @samp{$root} as the | |
| module name in the first active line. Use of this option will disable | |
| any default module->CMI name mapping. | |
| @end table | |
| As shown, an optional @var{ident} may suffix the first word of the | |
| option, indicated by a @samp{?} prefix. The value is used in the | |
| initial handshake with the module server, or to specify a prefix on | |
| mapping file lines. In the server case, the main source file name is | |
| used if no @var{ident} is specified. In the file case, all non-blank | |
| lines are significant, unless a value is specified, in which case only | |
| lines beginning with @var{ident} are significant. The @var{ident} | |
| must be separated by whitespace from the module name. Be aware that | |
| @samp{<}, @samp{>}, @samp{?}, and @samp{|} characters are often | |
| significant to the shell, and therefore may need quoting. | |
| The mapper is connected to or loaded lazily, when the first module | |
| mapping is required. The networking protocols are only supported on | |
| hosts that provide networking. If no mapper is specified a default is | |
| provided. | |
| A project-specific mapper is expected to be provided by the build | |
| system that invokes the compiler. It is not expected that a | |
| general-purpose server is provided for all compilations. As such, the | |
| server will know the build configuration, the compiler it invoked, and | |
| the environment (such as working directory) in which that is | |
| operating. As it may parallelize builds, several compilations may | |
| connect to the same socket. | |
| The default mapper generates CMI files in a @samp{gcm.cache} | |
| directory. CMI files have a @samp{.gcm} suffix. The module unit name | |
| is used directly to provide the basename. Header units construct a | |
| relative path using the underlying header file name. If the path is | |
| already relative, a @samp{,} directory is prepended. Internal | |
| @samp{..} components are translated to @samp{,,}. No attempt is made | |
| to canonicalize these filenames beyond that done by the preprocessor's | |
| include search algorithm, as in general it is ambiguous when symbolic | |
| links are present. | |
| The mapper protocol was published as ``A Module Mapper'' | |
| @uref{https://wg21.link/p1184}. The implementation is provided by | |
| @command{libcody}, @uref{https://github.com/urnathan/libcody}, | |
| which specifies the canonical protocol definition. A proof of concept | |
| server implementation embedded in @command{make} was described in | |
| ''Make Me A Module'', @uref{https://wg21.link/p1602}. | |
| @node C++ Module Preprocessing | |
| @subsection Module Preprocessing | |
| @cindex C++ Module Preprocessing | |
| Modules affect preprocessing because of header units and include | |
| translation. Some uses of the preprocessor as a separate step either | |
| do not produce a correct output, or require CMIs to be available. | |
| Header units import macros. These macros can affect later conditional | |
| inclusion, which therefore can cascade to differing import sets. When | |
| preprocessing, it is necessary to load the CMI. If a header unit is | |
| unavailable, the preprocessor issues a warning and continue (when | |
| not just preprocessing, an error is emitted). Detecting such imports | |
| requires preprocessor tokenization of the input stream to phase 4 | |
| (macro expansion). | |
| Include translation converts @code{#include}, @code{#include_next} and | |
| @code{#import} directives to internal @code{import} declarations. | |
| Whether a particular directive is translated is controlled by the | |
| module mapper. Header unit names are canonicalized during | |
| preprocessing. | |
| Dependency information can be emitted for module import, extending the | |
| functionality of the various @option{-M} options. Detection of import | |
| declarations requires phase 4 handling of preprocessor directives, but | |
| does not require macro expansion, so it is not necessary to use | |
| @option{-MD}. See also @option{-fdeps-*} for an alternate format for | |
| module dependency information. | |
| The @option{-save-temps} option uses @option{-fdirectives-only} for | |
| preprocessing, and preserve the macro definitions in the preprocessed | |
| output. Usually you also want to use this option when explicitly | |
| preprocessing a header-unit, or consuming such preprocessed output: | |
| @smallexample | |
| g++ -fmodules -E -fdirectives-only my-header.hh -o my-header.ii | |
| g++ -x c++-header -fmodules -fpreprocessed -fdirectives-only my-header.ii | |
| @end smallexample | |
| @node C++ Compiled Module Interface | |
| @subsection Compiled Module Interface | |
| @cindex C++ Compiled Module Interface | |
| CMIs are an additional artifact when compiling named module | |
| interfaces, partitions or header units. These are read when | |
| importing. CMI contents are implementation-specific, and in GCC's | |
| case tied to the compiler version. Consider them a rebuildable cache | |
| artifact, not a distributable object. | |
| When creating an output CMI, any missing directory components are | |
| created in a manner that is safe for concurrent builds creating | |
| multiple, different, CMIs within a common subdirectory tree. | |
| CMI contents are written to a temporary file, which is then atomically | |
| renamed. Observers either see old contents (if there is an | |
| existing file), or complete new contents. They do not observe the | |
| CMI during its creation. This is unlike object file writing, which | |
| may be observed by an external process. | |
| CMIs are read in lazily, if the host OS provides @code{mmap} | |
| functionality. Generally blocks are read when name lookup or template | |
| instantiation occurs. To inhibit this, the @option{-fno-module-lazy} | |
| option may be used. | |
| GCC has an internal parameter that controls the limit | |
| on the number of concurrently open module files during lazy loading. | |
| Should more modules be imported, an LRU algorithm is used to determine | |
| which files to close---until that file is needed again. This limit | |
| may be exceeded with deep module dependency hierarchies. With large | |
| code bases there may be more imports than the process limit of file | |
| descriptors. By default, the limit is a few less than the per-process | |
| file descriptor hard limit, if that is determinable.@footnote{Where | |
| applicable the soft limit is incremented as needed towards the hard limit.} | |
| GCC CMIs use ELF32 as an architecture-neutral encapsulation mechanism. | |
| You may use @command{readelf} to inspect them, although section | |
| contents are largely undecipherable. There is a section named | |
| @code{.gnu.c++.README}, which contains human-readable text. Other | |
| than the first line, each line consists of @code{@var{tag}: @code{value}} | |
| tuples. | |
| @smallexample | |
| > @command{readelf -p.gnu.c++.README gcm.cache/foo.gcm} | |
| String dump of section '.gnu.c++.README': | |
| [ 0] GNU C++ primary module interface | |
| [ 21] compiler: 11.0.0 20201116 (experimental) [c++-modules revision 20201116-0454] | |
| [ 6f] version: 2020/11/16-04:54 | |
| [ 89] module: foo | |
| [ 95] source: c_b.ii | |
| [ a4] dialect: C++20/coroutines | |
| [ be] cwd: /data/users/nathans/modules/obj/x86_64/gcc | |
| [ ee] repository: gcm.cache | |
| [ 104] buildtime: 2020/11/16 15:03:21 UTC | |
| [ 127] localtime: 2020/11/16 07:03:21 PST | |
| [ 14a] export: foo:part1 foo-part1.gcm | |
| @end smallexample | |
| Amongst other things, this lists the source that was built, C++ | |
| dialect used and imports of the module.@footnote{The precise contents | |
| of this output may change.} The timestamp is the same value as that | |
| provided by the @code{__DATE__} & @code{__TIME__} macros, and may be | |
| explicitly specified with the environment variable | |
| @code{SOURCE_DATE_EPOCH}. For further details | |
| @pxref{Environment Variables}. | |
| A set of related CMIs may be copied, provided the relative pathnames | |
| are preserved. | |
| The @code{.gnu.c++.README} contents do not affect CMI integrity, and | |
| it may be removed or altered. The section numbering of the sections | |
| whose names do not begin with @code{.gnu.c++.}, or are not the string | |
| section is significant and must not be altered. |